A platform for community discussion. Free, open, simple.
Go to file
Martin Brennan 002c676344
DEV: Topic tracking state improvements (#12958)
Original PR which had to be reverted **https://github.com/discourse/discourse/pull/12555**. See the description there for what this PR is achieving, plus below.

The issue with the original PR is addressed in 92ef54f402

If you went to the `x unread` link for a tag Chrome would freeze up and possibly crash, or eventually unfreeze after nearly 10 mins. Other routes for unread/new were similarly slow. From profiling the issue was the `sync` function of `topic-tracking-state.js`, which calls down to `isNew` which in turn calls `moment`, a change I had made in the PR above. The time it takes locally with ~1400 topics in the tracking state is 2.3 seconds.

To solve this issue, I have moved these calculations for "created in new period" and "unread not too old" into the tracking state serializer.

When I was looking at the profiler I also noticed this issue which was just compounding the problem. Every time we modify topic tracking state we recalculate the sidebar tracking/everything/tag counts. However this calls `forEachTracked` and `countTags` which can be quite expensive as they go through the whole tracking state (and were also calling the removed moment functions).

I added some logs and this was being called 30 times when navigating to a new /unread route because  `sync` is being called from `build-topic-route` (one for each topic loaded due to pagination). So I just added a debounce here and it makes things even faster.

Finally, I changed topic tracking state to use a Map so our counts of the state keys is faster (Maps have .size whereas objects you have to do Object.keys(obj) which is O(n).)
2021-05-31 09:22:28 +10:00
.devcontainer FEATURE: Support for GitHub Codespaces development (#11440) 2020-12-08 21:35:15 -03:00
.github DEV: Correct typos and spelling mistakes (#12812) 2021-05-21 11:43:47 +10:00
.vscode-sample DEV: Move vscode config files to `.vscode-sample` directory (#11943) 2021-02-03 14:14:39 +00:00
app DEV: Topic tracking state improvements (#12958) 2021-05-31 09:22:28 +10:00
bin DEV: Add non-x86_64 warning to `d/boot_dev` 2021-05-21 16:51:10 +01:00
config FEATURE: Automatically timed delete stub topics after entire topic is merged into another topic (#13187) 2021-05-28 17:33:10 +04:00
db FIX: Do not mark badge image uploads as secure (#13193) 2021-05-28 12:35:52 +10:00
docs DEV: Correct typos and spelling mistakes (#12812) 2021-05-21 11:43:47 +10:00
images
lib DEV: Topic tracking state improvements (#12958) 2021-05-31 09:22:28 +10:00
log
plugins FIX: no error when double save post with poll (#13111) 2021-05-27 08:39:51 +10:00
public Update translations (#13088) 2021-05-18 15:11:41 +02:00
script FEATURE: Flarum import script (#13139) 2021-05-27 02:30:50 +02:00
spec FIX: Giphy oneboxing when the response is an image (#13199) 2021-05-28 15:10:32 -04:00
test DEV: Correct typos and spelling mistakes (#12812) 2021-05-21 11:43:47 +10:00
vendor DEV: Update lodash from 4.17.15 to 4.17.21 (#13045) 2021-05-12 18:07:23 +02:00
.editorconfig
.eslintignore FIX: browser-update should work with old browsers (#12436) 2021-03-18 19:09:01 +02:00
.eslintrc enable eol-last for eslint and ember-template-lint (#12678) 2021-04-12 17:22:00 -07:00
.git-blame-ignore-revs DEV: the referenced commit bc97… was rebased into 445d… (#11626) 2021-01-07 08:14:54 +11:00
.gitattributes Use proper encoding for email fixtures. 2018-02-21 17:06:35 +08:00
.gitignore DEV: Clean up .gitignore (#12981) 2021-05-10 13:43:13 +02:00
.licensed.yml DEV: Add a basic licensed config (#10128) 2020-06-25 18:01:36 -03:00
.prettierignore FIX: browser-update should work with old browsers (#12436) 2021-03-18 19:09:01 +02:00
.prettierrc DEV: upgrades dev config (#10588) 2020-09-04 13:33:03 +02:00
.rspec DEV: Use `--profile` and `--fail-fast` in CI only 2019-03-11 22:04:47 -04:00
.rspec_parallel DEV: Introduce parallel rspec testing 2019-04-01 11:06:47 -04:00
.rubocop.yml Revert "Bump rubocop-discourse to 2.3.0." 2020-07-24 13:18:49 +08:00
.ruby-gemset.sample
.ruby-version.sample Make version the same as install docs (#8713) 2020-01-14 12:33:37 +11:00
.template-lintrc.js enable eol-last for eslint and ember-template-lint (#12678) 2021-04-12 17:22:00 -07:00
Brewfile DEV: enable frozen string literal on all files 2019-05-13 09:31:32 +08:00
CONTRIBUTING.md
COPYRIGHT.md DEV: Absorb onebox gem into core (#12979) 2021-05-26 15:11:35 +05:30
Gemfile DEV: Absorb onebox gem into core (#12979) 2021-05-26 15:11:35 +05:30
Gemfile.lock Build(deps): Bump rubocop-ast from 1.6.0 to 1.7.0 (#13205) 2021-05-31 00:33:09 +02:00
LICENSE.txt DEV: Absorb onebox gem into core (#12979) 2021-05-26 15:11:35 +05:30
README.md DOC: adds a link to teams.discourse.com (#12928) 2021-05-04 12:52:15 +10:00
Rakefile FIX: Do not dump schema during production database migrations (#12785) 2021-04-21 16:26:20 +01:00
adminjs
config.ru DEV: enable frozen string literal on all files 2019-05-13 09:31:32 +08:00
d
discourse.sublime-project DEV: Exclude i18n .yml files from Sublime Text project. (#6473) 2018-10-10 20:21:24 +08:00
jsapp
lefthook.yml DEV: experiments parallel prettier (#11854) 2021-01-27 17:25:48 +01:00
package.json DEV: Update lodash from 4.17.15 to 4.17.21 (#13045) 2021-05-12 18:07:23 +02:00
translator.yml DEV: Add styleguide locale files to Crowdin (#10876) 2020-10-09 13:23:32 +11:00
yarn.lock DEV: Update lodash from 4.17.15 to 4.17.21 (#13045) 2021-05-12 18:07:23 +02:00

README.md

Discourse is the 100% open source discussion platform built for the next decade of the Internet. Use it as a:

  • mailing list
  • discussion forum
  • long-form chat room

To learn more about the philosophy and goals of the project, visit discourse.org.

Screenshots

Boing Boing

Mobile

Browse lots more notable Discourse instances.

Development

To get your environment setup, follow the community setup guide for your operating system.

  1. If you're on macOS, try the macOS development guide.
  2. If you're on Ubuntu, try the Ubuntu development guide.
  3. If you're on Windows, try the Windows 10 development guide.

If you're familiar with how Rails works and are comfortable setting up your own environment, you can also try out the Discourse Advanced Developer Guide, which is aimed primarily at Ubuntu and macOS environments.

Before you get started, ensure you have the following minimum versions: Ruby 2.7+, PostgreSQL 13+, Redis 6.0+. If you're having trouble, please see our TROUBLESHOOTING GUIDE first!

Setting up Discourse

If you want to set up a Discourse forum for production use, see our Discourse Install Guide.

If you're looking for business class hosting, see discourse.org/buy.

If you're looking for our remote work solution, see teams.discourse.com.

Requirements

Discourse is built for the next 10 years of the Internet, so our requirements are high.

Discourse supports the latest, stable releases of all major browsers and platforms:

Browsers Tablets Phones
Apple Safari iPadOS iOS
Google Chrome Android Android
Microsoft Edge
Mozilla Firefox

Built With

  • Ruby on Rails — Our back end API is a Rails app. It responds to requests RESTfully in JSON.
  • Ember.js — Our front end is an Ember.js app that communicates with the Rails API.
  • PostgreSQL — Our main data store is in Postgres.
  • Redis — We use Redis as a cache and for transient data.
  • BrowserStack — We use BrowserStack to test on real devices and browsers.

Plus lots of Ruby Gems, a complete list of which is at /master/Gemfile.

Contributing

Build Status

Discourse is 100% free and open source. We encourage and support an active, healthy community that accepts contributions from the public including you!

Before contributing to Discourse:

  1. Please read the complete mission statements on discourse.org. Yes we actually believe this stuff; you should too.
  2. Read and sign the Electronic Discourse Forums Contribution License Agreement.
  3. Dig into CONTRIBUTING.MD, which covers submitting bugs, requesting new features, preparing your code for a pull request, etc.
  4. Always strive to collaborate with mutual respect.
  5. Not sure what to work on? We've got some ideas.

We look forward to seeing your pull requests!

Security

We take security very seriously at Discourse; all our code is 100% open source and peer reviewed. Please read our security guide for an overview of security measures in Discourse, or if you wish to report a security issue.

The Discourse Team

The original Discourse code contributors can be found in AUTHORS.MD. For a complete list of the many individuals that contributed to the design and implementation of Discourse, please refer to the official Discourse blog and GitHub's list of contributors.

Copyright 2014 - 2021 Civilized Discourse Construction Kit, Inc.

Licensed under the GNU General Public License Version 2.0 (or later); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Discourse logo and “Discourse Forum” ®, Civilized Discourse Construction Kit, Inc.

Dedication

Discourse is built with love, Internet style.