Migrate from sidekiq to good_job

Gemfile

@@ -27,8 +27,7 @@ gem 'bcrypt', '~> 3.1.19'
 # Use Capistrano for deployment
 # gem 'capistrano-rails', group: :development
 
-gem 'sidekiq'
-gem 'sidekiq-cron'
+gem 'good_job'
 
 gem 'draper'
 gem 'ip_anonymizer'

Gemfile.lock

@@ -180,6 +180,13 @@ GEM
       rails (>= 4.0.0)
     globalid (1.2.1)
       activesupport (>= 6.1)
+    good_job (3.19.4)
+      activejob (>= 6.0.0)
+      activerecord (>= 6.0.0)
+      concurrent-ruby (>= 1.0.2)
+      fugit (>= 1.1)
+      railties (>= 6.0.0)
+      thor (>= 0.14.1)
     guard (2.18.1)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -469,15 +476,6 @@ GEM
     shellany (0.0.1)
     shoulda-matchers (5.3.0)
       activesupport (>= 5.2.0)
-    sidekiq (7.1.6)
-      concurrent-ruby (< 2)
-      connection_pool (>= 2.3.0)
-      rack (>= 2.2.4)
-      redis-client (>= 0.14.0)
-    sidekiq-cron (1.10.1)
-      fugit (~> 1.8)
-      globalid (>= 1.0.1)
-      sidekiq (>= 6)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -564,6 +562,7 @@ DEPENDENCIES
   draper
   factory_bot_rails
   gaffe
+  good_job
   guard-rspec
   i18n-tasks
   interactor
@@ -600,8 +599,6 @@ DEPENDENCIES
   sentry-rails
   sentry-ruby
   shoulda-matchers
-  sidekiq
-  sidekiq-cron
   simplecov
   simplecov-console
   sitemap_generator

config/application.rb

@@ -36,7 +36,7 @@ class Application < Rails::Application
     config.middleware.insert_after ActionDispatch::RemoteIp, IpAnonymizer::HashIp,
       key: Rails.application.credentials.ip_anonymizer_key
 
-    config.active_job.queue_adapter = :sidekiq
+    config.active_job.queue_adapter = :good_job
     config.active_job.queue_name_prefix = "admin_api_entreprise_#{Rails.env}"
 
     config.action_mailer.deliver_later_queue_name = :default

config/credentials/production.yml.enc

@@ -1 +1 @@
-sUaIU6RcjkR11ZzOoIvOIH6aeDUZBRMHK5Hqtnt3fzbn1CIwe6YpNHbRqyiK/LYzQdJOJfVvl8JWbnInjp/m86YqLqphp6RSNxqFyZ+LBxCLmFU5cjIkOOgNo9Dhdd4R4RqsRPWKJzRaoH2cIvYCExn3sxa/cvLJbCUQ/VdcPlHexXrJn+9kxeONzCoDuXMKrGZitLI39gau3lMEDXMiFkD70YUow1E8N8i9u4Uu/UsxhF8+zJMy/VGGGL3kyeg5iR6MsOnBB3KV02M9DIs6dlHdwJ1gKHSuRbuEQo1eS61ugAi6Gy5eVsjgmI+EUMnR1LwVXqRAGVrhoRCwHFuePKdrjbvuJ0AlBetA/ZTte5PHcBb31UUDoZco6lgtVdIrhZ71KxLWYqVjXXKayRjR7l27UyzyOSXVhHC4LKO8G+J/6uHEhUOJAknfpS+VASImQTF0tqNZr3nzR5s0+MH9FG1YrL4h6oBRkMOmWOejC65hs34ksWG83XBdidilAeIwZLFlg1JZL+fVI21o3qxbIA2NXrgdVI3UY1ecU4817S3yvUQqDxdaUDShHeuHv9PXzLGIogunTMZgV9euiZFUaFzb1wLNjIHzKwlVBRs6rbP2x/8El/EB3Ee0UNG2yxhDkx9OgGOisrubRC3Xiz583Wcg+H/n6Hj2g4yQwss5apmuU7zO8DgsXfw2EigRLuecvQqike7BNcDNV9kXqst72RmpfgnPfUl3s1OEItCcasAcFSxN//P4ZRuudHFKAnd/+c0sxuv5J62WlP8U2Nj0tms8xE337jmF31DAd7djaj3TUHIRWccMc5mCO4oxgGyDbpL5hufmfTsGGYievmZHUoOeBC7CkrlKAZzMcdWZJqMu6Zskxm/oUzaxm1oCBeveZvr6xlfO0uiPqJfZWGNqSSgs0g68x4vRk68FDTl2uEepaUzablrAMDa3xviG0n34c8c0RVXRjcwaCccJkCNEPXppdP96Plgz65V2ckvzm3+p10V/hhshv4l07v0JDa4bB0jiWzhJoA9ZXs1U+K2UT3t6WC7MNsQF1Elj596IglLiCdLo0nI7V/NV5psflMEFGUNlihmSN2j3F74dlE33k2xmh9JKSAng9lwc5/pdjSgxick9lzxnsT8luVmq0VfogaKuq/GCN6UIRZh2GZyf0z6jo/Lbm+UZJTezNm3ecLA6vNPMjdg1CCxPNK7cKln5Hp2ldQCKD6qySesrSjeX7LIuYRY40VnOv2WSUn3W+DoEgSOgJllEqOA+V0DYP4qg7nva2oMks3h7H6YQ06gRK1erERiVRhlC4F6TA5b1CezJALe12QhCEAffKsUIYZg7v8OzNp2RCcbZ5Hy1ayWlVYDzGOzggvzFYnSlIAVbatHJyZQeMosUOtDF9jkk8jnzEi6YY/wysbf8vJvxzCvhU4OC2/qU7FnxEmGj47DBhXuxFNWaGT+iADFdBCrQguVb6ooJHb21ATcWb5IAM4wlKoIBlOFhd0W3LRonuZ65d3i1O3YF8cM2Ji3GvchUAv1bG5auSlNyV9NAxeQfmGP1ic3IDf9qliWGEnFgQDgpBk4wmBnjN4mx7vnGtUEMBpXWSsZKeYsnMcubwBPVfsQuesOfiV15hhIQe8CtbuekMBQ+a+K5na/U1XkfExSYQwyOAy1HS7aPo+UoLJjdwe4YncsNsl6mCpNSpZRlVtf/W8fb26xMPB/AHcyHcU0hB2kv50Zy9d7OtLDXEDNpBvAsz7JZ1gKxNX+27r6RNfe4U2z9aOYAEQUw05AbcIAuYnu7cHM+rToG3tcqzbuN1SL8LlCC32KSfOULI1Ayn4CWUgkcLXq7/W7JY5r3OiS1yQmchUOs6Fa/CRK1vub/JgiW6EEkbNwvSJWIpPc7Aoo0u4ZcRKWhy6d1+7Wy2fwVct3c6LaDHI3BppDg7jdL+/0bDz68afUyzBdqfQsKXYrNQNELhcmdPBbuvCihbjRq0X9ke2i7CKjsIpS4uQ3OYa+4rpJnbOyVvVDiCjykWHdRUBf2G9AibYafgAZ5JQExvFq5ouGt+gS4e97w6N4XDcaArFMqbfI=--BtdSzE8X7iFc/AVk--L1nR8DOXSwl2yv9o5O41iA==
+dy8BxuOrPThGhedORHxRsbvmq1IG/LSMdVavldY+k0nJICK6No3oz3EQa5KUe2e79p0FoTYOrtTLauCE/bkoTa8mHI27A1Gy5k5rO44neso9onWEKggndWooA/peyr+0Av744BZAerRkze4RFUwxTWsqlJdhgc+ioBh4V6lLJqJwm/TIwwMkkrv13suRZ0qr6CyCKFZganIbMSe5xheG3sBghdUGaH7U8JhMuYq8scBPCFgPjkQR8Z17bpMyeRsWpsSLLuafIJt33mbxrk0jcLIoyLl3Gzwuwp/IxUKgXvxeod68vzKn98G7L1QbsrZRrKsv3pJChjjbCbJOumdxAH6rHOcjDMibV1GbN1j7Q4z/yWM+fZH3Qcs28tOcm1B+8+DP8CdVEaTcUUQNWFTqyVJANaSJlXuoDGe/4PVXAFGK+myoH5gS7cZYF/YA+/KnOsGnYUwTnK37QRZG1azquysyVUKzpkgnadDnHL5PG4POqudKOVDHqQHaYOFBjfD8AySN8+2u3esGSvqNI/pPjyLJnuEi5+H0Uxou2ix5B3eOlBWmY8IW1HXEZL89zrDuB4s77LMuMpE9ZcADfVeWJyIJofPttEu/GUJrLA9NAZgfXtxTF/w7awTv0fhpgWyaBh+o0Lu0QO6194to0nVEoV3FuzbL1d2DycG9rIq7bqzsNowKqe6xe0fPRhW/em85OWCHRlJQpcMk5MZe+bGUiDxhOVeR5RdvAq1dRKdG5TeRo0Bu1D+Cmd9eawXXHJUruo252jLGbVs3f4jOz/ZjB/eECLWLJTWosBqTJXbIASS00EO4WBf01KxzNa2YnfhkjrzLfrEMXqDXnNrxxS/i/Qf+lirj7HIr0d4eL7cNaXZY3VbKhOw92t4A07pkRKw7tBn6LyNmSGjY23WvhnJzboVj0xHowSaKnHHtx/V5YX9BLqG4g8eTj9cKtgf7ROFicDE++Sa60v0hbQIHZxZaNw7z2vFirzq+erboknwQY2q1G05Dlp1ntYEOg/xZwxhUd3b/PyxDDcJrCBgRW5FQ2rgSSV8TvJU/ma/EamtX1+0UMrao7R9klbh1shXQm8fHHYhPICumL5QS06VLYBuIUkRCQQJJKP3i8LwWp0HLpCmtVGXazeFOtT4CSUqBE643bE6BuUyW4RYZc1UDUl81D05BoBzPMKX7kOY1OOikuz3W2n0cONkE2Rro6jpgtXbF4+Q8F4WxmRbQqhlNsryrPsbdqdDdcIdgt/R6bTCgi+L5Lq9u+fhSuEFvIdiFWYND37wr1j5Hmm/zdgaKeTNQ5P2DXTRlpr4OM9+B8PLPCfGJ9TodFxiPesAb+iP8e41oqot0EwXt6xRS90ZmtwFIh5+lyRoTaY69Xf2iIaNaFwt0ioqm8nBqLB726GYe1BuwQ9LGw7ph8lOQc0NsRph921aVk76UbJ8GbJO+/7NM6cFyIDd87vGMl8+u2wkjgrRsUnEOliVJ5lJX0lygPcK85Fk58nwIGy/p2X2ajuOolLuJzXE+AUVrjYUW25gpl/cggKqi5+shT7Nr9K22s7PZyZAK7k54oJtTgLdu/xYjs2YHA56ZJsHVJggHYYZxyBSw8Hj3lazzoV70Z9LyCvplkavCFBLoSO9Ccf0wLftnXDnuiuh+yCAY2sdpq29EKs63CCr1MPab3UsTgAVpNtYcuuuWRLnbNf1tGZUV3UfinR5qHWDcymmtDIK8VxLoGZZjO3v9rdmFD/jMsIHtk5AIh4FU8PmMKtfKnbc6an0pknO52PzvR+m8pLN0FFOBGInilvyd/7eZEfRp9gYTwE4GgyROAcwfX2z60cDbqyZY8C3wI0lHp2kkm3O62kNO4KnZjiUBikHxLj1rCCyYNn7Q+3Y7+zmKiH8w98Yp9gHdkHUojUhlZaoENvZXEPyw+2544tCcPieArcnZ83HGVwC6kdTdgzlJYUJ4xzi3SKHuJ7Kwjh4OoL3xJ6+wsZf+7VsXvfFdKsLEmadxgKYZ793RQQOwBLaNqxAd6T5Z2PUayhTXfpti83BpkT0qmH5ddDmMSW8sVgiY0lz1fiMVRkrsMVasGd4=--vVO53cgf2j5u6ctd--jxW9FDy+n0r4EXc4nlWOgQ==

config/credentials/test.yml.enc

@@ -1 +1 @@
-9ytiJpAK0kCF8NSBuhnCLM4go6PLgkdJdrd5fW0L+OgoplHKXiSRvGFHuyuJITPvQsYiXO/eVtHWVAgQvA9S4B/BjPabYatx8H+/BZRZiHQ93Yenk6RllFNdA8z6nGKs/elg7Zopbs17kde0hseX6QyicZ/SzOi0cfD+kzQU9gOU8dlWJZu/qc+kVSJUc+k249B3E4kYrxHNTjNXHZVgJWb/xNhXaI01CS/L9BSAIvGnX6UVHfUaIuvMz3i+5VdvnIpAnqirbtSbfFfjgTTYPVTCMi6l6qeakOzgIotTwg/6500Qj443dqSvh0SBld6dbmHGbRhpCfPTF8+77CA6Ai33f7soUQG3ihv3poVJPykUZSjIWrK8fMYNvKfGFyI8LBZa1ypl9rYV4+H0ivy2LMzWSzvWawNvwQLF1eSOyglbFAowcpvkcAdz4KOM3aGXWtGLtRWjDN5BizRMSuKYzxISe9ggIthiIyGx2bDcL6/1K+NFLp1JeuofHf2S08rukBchVXQXhQtKg/BvQUFudKZDztLPKOaAutOyUnFhzaflbECHC6j7Rsq4DvWCBYJdDWP/EmtT1UttgWIMV5aXHNxFhGPeYKC1j72khCeuevujs+GcV5JWqRsHvVh0wQcVoutBtQfK5uyPfWXtehM64DtKnG3Bp2faD3QTi5IJz/VEsJr70HKJO6/8JhpBzVwbvuAA6sxsF/Dp3QRbBSwfirAPd7S94HLK/HPr6Dc8FS8Uv0keBOm3eUsCAX4+vUSMBCfH1Vrd5pYS7tQzH5nCJEHXMu9Zwh/Ih145OM+voWz6jivt66JYT7tLaWYoSJQpGSfwfM3iHPhqO5X53S/ZQO3BBNzi/bjRWYmXh4cE1DdZiw4giYK8LBTvfcuqtj37GrVUuBB1atjZlkv9v861frkCV4YA9WCKuN7/gIFsmhC9c2BAo3z0T/Ui9cO1mDF6HHyZMtuxeNiT/r4o9DZYuqZoT/npJa/Bkl2RgSfH3yTozmGhLJVW+7ldmqfwedi5t/mE9DGff53Mj/4bTbStyEbWYy/DL8I0WC2i00X9b4dBLwp/+Umgt7SURr6tAkRMclOuo2AfNRB3QBYMgSetwfyFlGNM8XeWQzwN+SyN6dcigYOJCHgqnCgIGwmI9yEgdNTQn8sx7p0Da9x/WtHZAczseerS2497zNmB8t0AsAYJgZv0Uwh9MY1PI8YPp1Hls4LeCakN+Ad3Fjh96AqD11z99AvYadfUMlUZC+KrxaZpATrQvlr2--symvvrUliA6pmy+u--uBIQufCvsVlP8lG5dXsX+A==
+RXxxHdsrbaeqrJ44wMdjO7nSE9PqOTtmjmWy2B1vJva8DM6fZBKwKsx4HNxO0p5PWThOqAQOpfA7WUa7ZSWzQ8THKcRX0s0XwmrJMuKZ8Jsvdpu+jjqMDsLeCmlzxUfjlK+ThB0NnQ4kVkLTvHgtezcAB/0daSoIfN2wJ+xhiYxVPjkbHMQt0cqJQ0oxGg21XlVodH26BJcrPCYv7KHykU8UqzHZ7OQfy/w6uy+XElcnl+BXtcYk3r47KpVN8tfl8j0xfxdbg64v9u2Zl/jvsLs3gMJspN9H5lSmqxrYamaiwp3lTx48qYhprAaY2p+K1u1Y6zP+u0mDtvquO/zWGpZwzH/nl/+2SqfriASL3BLK0y/dHg7tKap4Ssvby7Kw8bxpS5lAuj4o+iyR0j9ftBH2pmct0PTn2C2cnwPmYM0iHAfI3AyddVBQDHuk5E8cjQwQhqMR45hXF8lL94lJf97isojwQpJrRwurMVybmSbWL8ziuMp2hNROFkeugiFpNqs3UB6IXqioFfsDIvi9957KkoUZhS2pSrLmGOuQM2TH5dsPsuM0vDOIUStTj5yk5EfLRpEZymfFZ7A5Q127vJvFLnTqx0OVxWX1NsSs4xiOK1cVBjFr3pteqyi2ocMF2A1b1GuGVQBAbBC3/2zHI3M+2eKOPxKmg7r8C20vzrwd+0CA56+KO5JNRZpni9Ku9trgal1NQQnhHHQTLx5vtD+MOz3bFMB4sD3hiAvR7Y1h2ZX/QFTT+2ceqbcEXvFNT6uTDqYzi7EWxZ2kBUPOvKaZEFODexsve+AoSNSEEu4/YpCNeFWCpaR7r9sT87j1RppcR3ouHMz/WW1+y8o41T0HjrLnyzDDM1/2wFi9GhQHd7oCNAsH9jfKttHLS3eJmAk6f0Ks1+6pltC3D22yrk4Tkj5UwqXJwaUEbDqcz/trxMvA0Rvdpyja4CPa6wqsiaWAob7lg4UFA60v3qlPEzEUm8Fntj8QEt4y5RBHQiSTl6WVujHxfr1EtH3VSMJJzJpDfNRt8bBLpREifDyF9GwqemX0lobCsTcH9gqlJe8ICFqokXVdW+GYDUyzQY4BhpdoXfmnyuMYzeSEYEl+kyOElESoGJKg+B7zo7AXzKawOXD9v+IMlIuDQykgfPMBJc6YUtThC+AMOMcRhSdmFNXD1/hCD7oRFmsSc0UQOj43fdJADGI9SPQcuIASqEOvS1EaWV59mERGZMjLuthdv8O9vxiw2Gut3/GxA2v3DWWYU6k8PDPW--97xj7tCrmDd4BQLw--LC2NEtbYim6pQWNSdjyfZw==

config/initializers/good_job.rb

@@ -0,0 +1,4 @@
+Rails.application.configure do
+  config.good_job.enable_cron = true
+  config.good_job.cron = Rails.application.config_for(:schedule)
+end

config/routes.rb

@@ -1,12 +1,9 @@
 Rails.application.routes.draw do
-  require 'sidekiq/web'
-  require 'sidekiq/cron/web'
-
-  Sidekiq::Web.use Rack::Auth::Basic do |username, password|
-    ActiveSupport::SecurityUtils.secure_compare(::Digest::SHA256.hexdigest(username), ::Digest::SHA256.hexdigest(Rails.application.credentials.sidekiq_ui_username)) &
-        ActiveSupport::SecurityUtils.secure_compare(::Digest::SHA256.hexdigest(password), ::Digest::SHA256.hexdigest(Rails.application.credentials.sidekiq_ui_password))
+  GoodJob::Engine.middleware.use(Rack::Auth::Basic) do |username, password|
+    ActiveSupport::SecurityUtils.secure_compare(::Digest::SHA256.hexdigest(username), ::Digest::SHA256.hexdigest(Rails.application.credentials.workers_ui_username)) &
+      ActiveSupport::SecurityUtils.secure_compare(::Digest::SHA256.hexdigest(password), ::Digest::SHA256.hexdigest(Rails.application.credentials.workers_ui_password))
   end
-  mount Sidekiq::Web => '/sidekiq'
+  mount GoodJob::Engine => '/workers'
 
   draw(:api_entreprise)
   draw(:api_particulier)

config/schedule.yml

@@ -2,13 +2,11 @@ development:
   token_expiration_notice:
     cron: '0 1 * * *'
     class: 'TokenExpirationNoticeJob'
-    queue: default
 
 production: &deployed
   token_expiration_notice:
     cron: '0 */4 * * *'
     class: 'TokenExpirationNoticeJob'
-    queue: default
 
 staging: *deployed
 sandbox: *deployed

db/migrate/20231020161819_create_good_jobs.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+class CreateGoodJobs < ActiveRecord::Migration[7.1]
+  def change
+    # Uncomment for Postgres v12 or earlier to enable gen_random_uuid() support
+    # enable_extension 'pgcrypto'
+
+    create_table :good_jobs, id: :uuid do |t|
+      t.text :queue_name
+      t.integer :priority
+      t.jsonb :serialized_params
+      t.datetime :scheduled_at
+      t.datetime :performed_at
+      t.datetime :finished_at
+      t.text :error
+
+      t.timestamps
+
+      t.uuid :active_job_id
+      t.text :concurrency_key
+      t.text :cron_key
+      t.uuid :retried_good_job_id
+      t.datetime :cron_at
+
+      t.uuid :batch_id
+      t.uuid :batch_callback_id
+
+      t.boolean :is_discrete
+      t.integer :executions_count
+      t.text :job_class
+      t.integer :error_event, limit: 2
+    end
+
+    create_table :good_job_batches, id: :uuid do |t|
+      t.timestamps
+      t.text :description
+      t.jsonb :serialized_properties
+      t.text :on_finish
+      t.text :on_success
+      t.text :on_discard
+      t.text :callback_queue_name
+      t.integer :callback_priority
+      t.datetime :enqueued_at
+      t.datetime :discarded_at
+      t.datetime :finished_at
+    end
+
+    create_table :good_job_executions, id: :uuid do |t|
+      t.timestamps
+
+      t.uuid :active_job_id, null: false
+      t.text :job_class
+      t.text :queue_name
+      t.jsonb :serialized_params
+      t.datetime :scheduled_at
+      t.datetime :finished_at
+      t.text :error
+      t.integer :error_event, limit: 2
+    end
+
+    create_table :good_job_processes, id: :uuid do |t|
+      t.timestamps
+      t.jsonb :state
+    end
+
+    create_table :good_job_settings, id: :uuid do |t|
+      t.timestamps
+      t.text :key
+      t.jsonb :value
+      t.index :key, unique: true
+    end
+
+    add_index :good_jobs, :scheduled_at, where: "(finished_at IS NULL)", name: "index_good_jobs_on_scheduled_at"
+    add_index :good_jobs, [:queue_name, :scheduled_at], where: "(finished_at IS NULL)", name: :index_good_jobs_on_queue_name_and_scheduled_at
+    add_index :good_jobs, [:active_job_id, :created_at], name: :index_good_jobs_on_active_job_id_and_created_at
+    add_index :good_jobs, :concurrency_key, where: "(finished_at IS NULL)", name: :index_good_jobs_on_concurrency_key_when_unfinished
+    add_index :good_jobs, [:cron_key, :created_at], name: :index_good_jobs_on_cron_key_and_created_at
+    add_index :good_jobs, [:cron_key, :cron_at], name: :index_good_jobs_on_cron_key_and_cron_at, unique: true
+    add_index :good_jobs, [:active_job_id], name: :index_good_jobs_on_active_job_id
+    add_index :good_jobs, [:finished_at], where: "retried_good_job_id IS NULL AND finished_at IS NOT NULL", name: :index_good_jobs_jobs_on_finished_at
+    add_index :good_jobs, [:priority, :created_at], order: { priority: "DESC NULLS LAST", created_at: :asc },
+      where: "finished_at IS NULL", name: :index_good_jobs_jobs_on_priority_created_at_when_unfinished
+    add_index :good_jobs, [:batch_id], where: "batch_id IS NOT NULL"
+    add_index :good_jobs, [:batch_callback_id], where: "batch_callback_id IS NOT NULL"
+
+    add_index :good_job_executions, [:active_job_id, :created_at], name: :index_good_job_executions_on_active_job_id_and_created_at
+  end
+end

docker-compose.yml

@@ -29,9 +29,9 @@ services:
     links:
       - db
       - redis
-  sidekiq:
+  workers:
     build: .
-    command: bundle exec sidekiq
+    command: bundle exec good_job start
     volumes:
       - .:/app
     depends_on:
@@ -42,6 +42,5 @@ services:
       - redis
     environment:
       - RAILS_ENV=development
-      - REDIS_URL=redis://redis:6379/0
       - POSTGRES_HOST=db
       - REDIS_HOST=redis