FIX: Set Jobs::BackfillSidebarSiteSettings cluster concurrency to 1 (#22316)

What is the problem?

When an admin changes the default_sidebar_categories or default_sidebar_tags site settings and opts to backfill the setting,
we currently enqueue a sidekiq job to run the backfilling operation. When an admin changes those settings multiple times
within a short time frame, multiple sidekiq jobs with different backfilling parameters will be enqueued.
This is problematic if multiple jobs are executed concurrently as it may lead to situations where a job
with “outdated” site setting values is completed after a job with the “latest” site setting values.

What is the fix?

By setting `cluster_concurrency` to `1`, we ensure that only one of such
backfilling job will execute across all the sidekiq processes that are
deployed at any point in time. Since Sidekiq pops off job in the order
in which they are pushed, limiting the cluster concurrency here will
allow us to execute the enqueued `Jobs::BackfillSidebarSiteSettings`
jobs serially.
This commit is contained in:
Alan Guo Xiang Tan 2023-06-28 13:07:46 +08:00 committed by GitHub
parent 1526d1f97d
commit 0d1d707213
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 0 deletions

View File

@ -1,6 +1,10 @@
# frozen_string_literal: true # frozen_string_literal: true
class Jobs::BackfillSidebarSiteSettings < Jobs::Base class Jobs::BackfillSidebarSiteSettings < Jobs::Base
# There should only be one of these jobs running at a time and it will be ordered based on the order in which the job
# was enqueued.
cluster_concurrency 1
def execute(args) def execute(args)
SidebarSiteSettingsBackfiller.new( SidebarSiteSettingsBackfiller.new(
args[:setting_name], args[:setting_name],

View File

@ -0,0 +1,7 @@
# frozen_string_literal: true
RSpec.describe Jobs::BackfillSidebarSiteSettings do
it "should have a cluster concurrency of 1" do
expect(Jobs::BackfillSidebarSiteSettings.get_cluster_concurrency).to eq(1)
end
end