A platform for community discussion. Free, open, simple.
Go to file
Alan Guo Xiang Tan 8ee71d439b
FIX: Add migration to reindex invalid indexes (#19858)
In Discourse, there are many migration files where we CREATE INDEX CONCURRENTLY which requires us to set disable_ddl_transaction!. Setting disable_ddl_transaction! in a migration file runs the SQL statements outside of a transaction. The implication of this is that there is no ROLLBACK should any of the SQL statements fail.

We have seen lock timeouts occuring when running CREATE INDEX CONCURRENTLY. When that happens, the index would still have been created but marked as invalid by Postgres.

Per the postgres documentation:

> If a problem arises while scanning the table, such as a deadlock or a uniqueness violation in a unique index, the CREATE INDEX command will fail but leave behind an “invalid” index. This index will be ignored for querying purposes because it might be incomplete; however it will still consume update overhead.
> The recommended recovery method in such cases is to drop the index and try again to perform CREATE INDEX CONCURRENTLY . (Another possibility is to rebuild the index with REINDEX INDEX CONCURRENTLY ).

When such scenarios happen, we are supposed to either drop and create the index again or run a REINDEX operation. However, I noticed today that we have not been doing so in Discourse. Instead, we’ve been incorrectly working around the problem by checking for the index existence before creating the index in order to make the migration idempotent. What this potentially mean is that we might have invalid indexes which are lying around in the database which PG will ignore for querying purposes.

This commits adds a migration which queries for all the
invalid indexes in the `public` namespace and reindexes them.
2023-01-13 11:04:26 +08:00
.devcontainer DEV: Replace postCreateCommand with postStartCommand (#16665) 2022-05-05 23:52:35 +02:00
.github DEV: Introduce syntax_tree code formatter (#19775) 2023-01-07 11:11:08 +00:00
.vscode-sample DEV: Move vscode config files to `.vscode-sample` directory (#11943) 2021-02-03 14:14:39 +00:00
app FEATURE: Extend topic update API scope to allow status updates (#19654) 2023-01-13 01:21:04 +00:00
bin DEV: Minimal first pass of rails system test setup (#16311) 2022-09-28 11:48:16 +10:00
config FEATURE: Extend topic update API scope to allow status updates (#19654) 2023-01-13 01:21:04 +00:00
db FIX: Add migration to reindex invalid indexes (#19858) 2023-01-13 11:04:26 +08:00
docs DEV: Update README to reflect that at least Ruby 3.1 is required (#19855) 2023-01-13 07:03:48 +08:00
images Replace README logo with PNG (#14044) 2021-08-13 14:23:49 -04:00
lib FEATURE: Extend topic update API scope to allow status updates (#19654) 2023-01-13 01:21:04 +00:00
log Initial release of Discourse 2013-02-05 14:16:51 -05:00
plugins FIX: Ensure poll extraction is not attempted if post body is absent (#19718) 2023-01-13 01:47:44 +00:00
public Update translations (#19340) 2022-12-06 16:22:23 +01:00
script DEV: Apply syntax_tree formatting to `script/*` 2023-01-09 11:13:22 +00:00
spec FEATURE: Extend topic update API scope to allow status updates (#19654) 2023-01-13 01:21:04 +00:00
test DEV: Extensively use `includes()` (#17541) 2022-07-17 20:48:36 +02:00
vendor DEV: Update moment-timezone (#19052) 2022-11-16 16:57:40 +01:00
.editorconfig DEV: Update .editorconfig to match new hbs rules (#19816) 2023-01-10 16:21:16 +01:00
.eslintignore DEV: Upgrade "lefthook" and skip hooks during merge/rebase (#18910) 2022-11-07 17:13:21 +01:00
.eslintrc DEV: Await for all async MessageBus callbacks (#17966) 2022-08-17 12:44:48 +02:00
.git-blame-ignore-revs DEV: Add recent formatting commits to `.git-blame-ignore-revs` (#19799) 2023-01-09 14:51:48 +00:00
.gitattributes Use proper encoding for email fixtures. 2018-02-21 17:06:35 +08:00
.gitignore DEV: add .ruby-version to .gitignore (#19661) 2022-12-30 12:11:55 +01:00
.licensed.yml DEV: Label and ignore all default gems (#19617) 2022-12-24 11:59:08 +01:00
.licensee.json DEV: Add CI job that audits dependency licenses (#16568) 2022-04-26 14:09:42 -04:00
.npmrc DEV: Prevent npm usage (#13945) 2021-08-04 22:04:58 +02:00
.prettierignore DEV: Configure prettier for hbs templates 2022-12-28 13:11:12 +00:00
.prettierrc DEV: upgrades dev config (#10588) 2020-09-04 13:33:03 +02:00
.rspec Add RSpec 4 compatibility (#17652) 2022-07-28 10:27:38 +08:00
.rspec_parallel DEV: Introduce parallel rspec testing 2019-04-01 11:06:47 -04:00
.rubocop.yml DEV: Introduce syntax_tree code formatter (#19775) 2023-01-07 11:11:08 +00:00
.ruby-gemset.sample rvm has offically depreicated .rvmrc and recommends using .ruby-version and .ruby-gemset instead. 2013-05-23 09:16:11 -07:00
.ruby-version.sample DEV: Update minimum and recommended ruby versions (#19615) 2022-12-28 10:09:15 +00:00
.streerc DEV: Apply syntax_tree formatting to `app/*` 2023-01-09 14:14:59 +00:00
.template-lintrc.js DEV: Configure prettier for hbs templates 2022-12-28 13:11:12 +00:00
Brewfile DEV: enable frozen string literal on all files 2019-05-13 09:31:32 +08:00
CONTRIBUTING.md Proper long form for CLA 2015-09-10 20:49:03 +02:00
COPYRIGHT.md DEV: Absorb onebox gem into core (#12979) 2021-05-26 15:11:35 +05:30
Gemfile DEV: Move back to web-push gem (#19849) 2023-01-12 12:12:19 -03:00
Gemfile.lock Build(deps): Bump nokogiri from 1.13.10 to 1.14.0 (#19856) 2023-01-12 23:25:14 -03:00
LICENSE.txt DEV: Absorb onebox gem into core (#12979) 2021-05-26 15:11:35 +05:30
README.md DEV: Update README to reflect that at least Ruby 3.1 is required (#19855) 2023-01-13 07:03:48 +08:00
Rakefile FIX: Do not dump schema during production database migrations (#12785) 2021-04-21 16:26:20 +01:00
config.ru DEV: enable frozen string literal on all files 2019-05-13 09:31:32 +08:00
d add wrappers for mailcatcher and sidekiq 2016-12-13 09:05:45 +11:00
discourse.sublime-project DEV: Exclude i18n .yml files from Sublime Text project. (#6473) 2018-10-10 20:21:24 +08:00
jsconfig.base.json DEV: Add more excludes to jsconfig (#17975) 2022-08-17 21:51:40 +02:00
lefthook.yml DEV: Upgrade "lefthook" and skip hooks during merge/rebase (#18910) 2022-11-07 17:13:21 +01:00
package.json DEV: Move `eslint-config-discourse` to `devDependencies` (#19641) 2022-12-28 16:50:31 +00:00
translator.yml DEV: Add labels for plugin locale files (#19664) 2022-12-31 00:37:15 +01:00
yarn.lock DEV: Update json5, remove an unused lockfile (#19732) 2023-01-04 23:15:49 +01: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 3.1+, PostgreSQL 13+, Redis 6.2+. 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.

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

Additionally, we aim to support Safari on iOS 12.5+ until January 2023 (Discourse 3.0).

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 /main/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 - 2023 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.

Accessibility

To guide our ongoing effort to build accessible software we follow the W3Cs Web Content Accessibility Guidelines (WCAG). If you'd like to report an accessibility issue that makes it difficult for you to use Discourse, email accessibility@discourse.org. For more information visit discourse.org/accessibility.

Dedication

Discourse is built with love, Internet style.