chore(specs): add solid queue to e2e specs

Author: solnic

.devcontainer/.env.example

@@ -12,7 +12,7 @@ SENTRY_E2E_SVELTE_APP_PORT=4001
 SENTRY_E2E_RAILS_APP_URL="http://localhost:4000"
 SENTRY_E2E_SVELTE_APP_URL="http://localhost:4001"
 
-# ActiveJob queue adapter under test: async | inline | sidekiq | resque | delayed_job
+# ActiveJob queue adapter under test: async | inline | sidekiq | resque | delayed_job | solid_queue
 SENTRY_E2E_ACTIVE_JOB_ADAPTER="async"
 
 # Redis for the sidekiq/resque adapters (the Compose service is named "redis")

.github/workflows/e2e_tests.yml

@@ -35,6 +35,7 @@ jobs:
           - sidekiq
           - resque
           - delayed_job
+          - solid_queue
 
     steps:
       - name: Checkout code

.mise.toml

@@ -33,7 +33,7 @@ description = "Start the svelte-mini e2e app"
 run = "cd spec/apps/svelte-mini && npm run dev"
 
 [tasks."e2e:worker"]
-description = "Start the rails-mini ActiveJob worker (sidekiq/resque/delayed_job; idles for async/inline)"
+description = "Start the rails-mini ActiveJob worker (sidekiq/resque/delayed_job/solid_queue; idles for async/inline)"
 run = "cd spec/apps/rails-mini && bundle exec ruby worker.rb"
 
 [tasks."e2e:serve"]

spec/apps/rails-mini/Gemfile

@@ -16,3 +16,4 @@ gem 'sentry-rails', path: Pathname(__dir__).join("../../..").realpath
 gem 'sidekiq'
 gem 'resque'
 gem 'delayed_job_active_record'
+gem 'solid_queue'

spec/apps/rails-mini/app.rb

@@ -5,7 +5,7 @@
 Bundler.require
 
 ENV["RAILS_ENV"] = "development"
-ENV["DATABASE_URL"] = "sqlite3:tmp/rails_mini_development.sqlite3"
+ENV["DATABASE_URL"] = "sqlite3:tmp/rails_mini_development.sqlite3?timeout=5000"
 
 require "action_controller/railtie"
 require "active_record/railtie"
@@ -39,7 +39,8 @@ class RailsMiniApp < Rails::Application
     "inline" => :inline,
     "sidekiq" => :sidekiq,
     "resque" => :resque,
-    "delayed_job" => :delayed_job
+    "delayed_job" => :delayed_job,
+    "solid_queue" => :solid_queue
   }.freeze
 
   adapter_name = ENV.fetch("SENTRY_E2E_ACTIVE_JOB_ADAPTER", "async").to_s.downcase
@@ -313,6 +314,13 @@ def set_cors_headers
 # avoiding a concurrent `force: true` drop/create race on the shared SQLite
 # file; it waits for these tables to appear before processing jobs.
 unless ENV["SENTRY_E2E_SKIP_DB_SETUP"] == "true"
+  # Backing store for the :solid_queue adapter. Loaded first (before :posts)
+  # unconditionally, for the same reason as :delayed_jobs below: the schema
+  # stays adapter-agnostic, and since the worker waits for :posts as its
+  # readiness signal, creating these tables first guarantees they exist by
+  # the time the worker starts polling.
+  load Pathname(__dir__).join("db/queue_schema.rb")
+
   ActiveRecord::Schema.define do
     create_table :posts, force: true do |t|
       t.string :title, null: false

spec/apps/rails-mini/db/queue_schema.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+# Backing store for the :solid_queue adapter. Loaded from app.rb's schema
+# setup so the same SQLite file works regardless of which adapter the
+# worker uses. Mirrors sentry-rails' dummy app queue schema.
+ActiveRecord::Schema[7.1].define(version: 1) do
+  create_table "solid_queue_blocked_executions", force: :cascade do |t|
+    t.bigint "job_id", null: false
+    t.string "queue_name", null: false
+    t.integer "priority", default: 0, null: false
+    t.string "concurrency_key", null: false
+    t.datetime "expires_at", null: false
+    t.datetime "created_at", null: false
+    t.index [ "concurrency_key", "priority", "job_id" ], name: "index_solid_queue_blocked_executions_for_release"
+    t.index [ "expires_at", "concurrency_key" ], name: "index_solid_queue_blocked_executions_for_maintenance"
+    t.index [ "job_id" ], name: "index_solid_queue_blocked_executions_on_job_id", unique: true
+  end
+
+  create_table "solid_queue_claimed_executions", force: :cascade do |t|
+    t.bigint "job_id", null: false
+    t.bigint "process_id"
+    t.datetime "created_at", null: false
+    t.index [ "job_id" ], name: "index_solid_queue_claimed_executions_on_job_id", unique: true
+    t.index [ "process_id", "job_id" ], name: "index_solid_queue_claimed_executions_on_process_id_and_job_id"
+  end
+
+  create_table "solid_queue_failed_executions", force: :cascade do |t|
+    t.bigint "job_id", null: false
+    t.text "error"
+    t.datetime "created_at", null: false
+    t.index [ "job_id" ], name: "index_solid_queue_failed_executions_on_job_id", unique: true
+  end
+
+  create_table "solid_queue_jobs", force: :cascade do |t|
+    t.string "queue_name", null: false
+    t.string "class_name", null: false
+    t.text "arguments"
+    t.integer "priority", default: 0, null: false
+    t.string "active_job_id"
+    t.datetime "scheduled_at"
+    t.datetime "finished_at"
+    t.string "concurrency_key"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index [ "active_job_id" ], name: "index_solid_queue_jobs_on_active_job_id"
+    t.index [ "class_name" ], name: "index_solid_queue_jobs_on_class_name"
+    t.index [ "finished_at" ], name: "index_solid_queue_jobs_on_finished_at"
+    t.index [ "queue_name", "finished_at" ], name: "index_solid_queue_jobs_for_filtering"
+    t.index [ "scheduled_at", "finished_at" ], name: "index_solid_queue_jobs_for_alerting"
+  end
+
+  create_table "solid_queue_pauses", force: :cascade do |t|
+    t.string "queue_name", null: false
+    t.datetime "created_at", null: false
+    t.index [ "queue_name" ], name: "index_solid_queue_pauses_on_queue_name", unique: true
+  end
+
+  create_table "solid_queue_processes", force: :cascade do |t|
+    t.string "kind", null: false
+    t.datetime "last_heartbeat_at", null: false
+    t.bigint "supervisor_id"
+    t.integer "pid", null: false
+    t.string "hostname"
+    t.text "metadata"
+    t.datetime "created_at", null: false
+    t.string "name", null: false
+    t.index [ "last_heartbeat_at" ], name: "index_solid_queue_processes_on_last_heartbeat_at"
+    t.index [ "name", "supervisor_id" ], name: "index_solid_queue_processes_on_name_and_supervisor_id", unique: true
+    t.index [ "supervisor_id" ], name: "index_solid_queue_processes_on_supervisor_id"
+  end
+
+  create_table "solid_queue_ready_executions", force: :cascade do |t|
+    t.bigint "job_id", null: false
+    t.string "queue_name", null: false
+    t.integer "priority", default: 0, null: false
+    t.datetime "created_at", null: false
+    t.index [ "job_id" ], name: "index_solid_queue_ready_executions_on_job_id", unique: true
+    t.index [ "priority", "job_id" ], name: "index_solid_queue_poll_all"
+    t.index [ "queue_name", "priority", "job_id" ], name: "index_solid_queue_poll_by_queue"
+  end
+
+  create_table "solid_queue_recurring_executions", force: :cascade do |t|
+    t.bigint "job_id", null: false
+    t.string "task_key", null: false
+    t.datetime "run_at", null: false
+    t.datetime "created_at", null: false
+    t.index [ "job_id" ], name: "index_solid_queue_recurring_executions_on_job_id", unique: true
+    t.index [ "task_key", "run_at" ], name: "index_solid_queue_recurring_executions_on_task_key_and_run_at", unique: true
+  end
+
+  create_table "solid_queue_recurring_tasks", force: :cascade do |t|
+    t.string "key", null: false
+    t.string "schedule", null: false
+    t.string "command", limit: 2048
+    t.string "class_name"
+    t.text "arguments"
+    t.string "queue_name"
+    t.integer "priority", default: 0
+    t.boolean "static", default: true, null: false
+    t.text "description"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index [ "key" ], name: "index_solid_queue_recurring_tasks_on_key", unique: true
+    t.index [ "static" ], name: "index_solid_queue_recurring_tasks_on_static"
+  end
+
+  create_table "solid_queue_scheduled_executions", force: :cascade do |t|
+    t.bigint "job_id", null: false
+    t.string "queue_name", null: false
+    t.integer "priority", default: 0, null: false
+    t.datetime "scheduled_at", null: false
+    t.datetime "created_at", null: false
+    t.index [ "job_id" ], name: "index_solid_queue_scheduled_executions_on_job_id", unique: true
+    t.index [ "scheduled_at", "priority", "job_id" ], name: "index_solid_queue_dispatch_all"
+  end
+
+  create_table "solid_queue_semaphores", force: :cascade do |t|
+    t.string "key", null: false
+    t.integer "value", default: 1, null: false
+    t.datetime "expires_at", null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index [ "expires_at" ], name: "index_solid_queue_semaphores_on_expires_at"
+    t.index [ "key", "value" ], name: "index_solid_queue_semaphores_on_key_and_value"
+    t.index [ "key" ], name: "index_solid_queue_semaphores_on_key", unique: true
+  end
+
+  add_foreign_key "solid_queue_blocked_executions", "solid_queue_jobs", column: "job_id", on_delete: :cascade
+  add_foreign_key "solid_queue_claimed_executions", "solid_queue_jobs", column: "job_id", on_delete: :cascade
+  add_foreign_key "solid_queue_failed_executions", "solid_queue_jobs", column: "job_id", on_delete: :cascade
+  add_foreign_key "solid_queue_ready_executions", "solid_queue_jobs", column: "job_id", on_delete: :cascade
+  add_foreign_key "solid_queue_recurring_executions", "solid_queue_jobs", column: "job_id", on_delete: :cascade
+  add_foreign_key "solid_queue_scheduled_executions", "solid_queue_jobs", column: "job_id", on_delete: :cascade
+end

spec/apps/rails-mini/worker.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Background worker entrypoint for the worker-based ActiveJob adapters
-# (:sidekiq, :resque, :delayed_job). These adapters enqueue onto an
-# external broker (Redis / the DB) and rely on a separate process to
-# execute the job. The worker boots the same Rails + Sentry app as the
+# (:sidekiq, :resque, :delayed_job, :solid_queue). These adapters enqueue
+# onto an external broker (Redis / the DB) and rely on a separate process
+# to execute the job. The worker boots the same Rails + Sentry app as the
 # web process, so the job's consumer transaction is emitted into the
 # shared debug-transport log the e2e suite reads.
 #
@@ -42,6 +42,15 @@
   worker.work(ENV.fetch("RESQUE_INTERVAL", "0.5").to_f)
 when "delayed_job"
   Delayed::Worker.new(sleep_delay: 0.5, quiet: false).start
+when "solid_queue"
+  # Boot Solid Queue's supervisor, which forks a dispatcher (promotes
+  # scheduled -> ready executions) and a worker (claims ready executions
+  # and runs the jobs). No config/queue.yml exists, so it falls back to
+  # the built-in single-worker + single-dispatcher defaults over the "*"
+  # queues. The forked children inherit the Sentry SDK initialized when
+  # this process booted the app above, so their consumer transactions land
+  # in the shared debug-transport log.
+  SolidQueue::Supervisor.start
 else
   # :async and :inline run jobs inside the web process. Stay alive as an
   # idle no-op so this stays a uniform, long-running service under process