FIX: Theme site settings not reloading across processes #34242
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
efa26a3 to
3db0a7e
Compare
This commit fixes an issue in multi-process setups where the following would happen: 1. Admin changes a theme site setting. The new value is stored in memory in the process that made the change. For this example, changing `enable_welcome_banner` from `true` to `false` 2. Another user visits the site and hits another process, which has the old value of `enable_welcome_banner` still set to `true` in memory 3. The other user's value for `enable_welcome_banner` is cached in the cache for theme site settings, which is shared across all processes The issue is fixed by doing the same thing as site settings: when the new value is saved, we send a MessageBus message to all processes via `SiteSettingExtension` which calls `refresh!` and reloads the in-memory cache of theme site settings from the DB.
3db0a7e to
1d55156
Compare
martin-brennan
commented
Aug 12, 2025
| @@ -599,6 +600,7 @@ def change_themeable_site_setting(theme_id, name, val) | |||
| theme_site_settings[theme_id][name] = val | |||
|
|
|||
| notify_clients!(name, theme_id: theme_id) if client_settings.include?(name) | |||
| notify_changed! | |||
There was a problem hiding this comment.
This line is the actual fix in this PR
martin-brennan
commented
Aug 12, 2025
| @@ -104,6 +109,30 @@ | |||
| expect(settings2.hello).to eq(99) | |||
| end | |||
|
|
|||
| it "publishes changes across processes" do | |||
There was a problem hiding this comment.
Introducing a test to make sure the actual site settings refresh across process behaviour works as expected
martin-brennan
commented
Aug 12, 2025
| expect(result.success?).to eq(true) | ||
|
|
||
| # Get through the MessageBus queue | ||
| try_until_success(frequency: 0.5) do |
There was a problem hiding this comment.
Not sure of a better way to handle this, there isn't a way to make MessageBus process all messages. Without this delay, the spec fails
nattsw
approved these changes
Aug 12, 2025
tgxworld
reviewed
Aug 12, 2025
ae6bf1c to
aa94137
Compare
aa94137 to
7d18484
Compare
|
This pull request has been mentioned on Discourse Meta. There might be relevant details there: https://meta.discourse.org/t/difficulty-understanding-the-enable-welcome-banner-setting/377321/27 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit fixes an issue in multi-process setups where the following
would happen:
in the process that made the change. For this example, changing
enable_welcome_bannerfromtruetofalseold value of
enable_welcome_bannerstill set totruein memoryenable_welcome_banneris cached inthe cache for theme site settings, which is shared across all
processes
The issue is fixed by doing the same thing as site settings: when the
new value is saved, we send a MessageBus message to all processes via
SiteSettingExtensionwhich callsrefresh!and reloads the in-memorycache of theme site settings from the DB.
c.f. https://meta.discourse.org/t/difficulty-understanding-the-enable-welcome-banner-setting/377321