Switch batch_id to active_job_batch_id

* This is a placeholder for a later rails-based abstraction

* Use bigint references like everything else and directly relate to the record

Author: jpcamara

app/models/solid_queue/batch.rb

@@ -4,16 +4,15 @@ module SolidQueue
   class Batch < Record
     include Trackable
 
-    has_many :jobs, foreign_key: :batch_id, primary_key: :batch_id
-    has_many :batch_executions, foreign_key: :batch_id, primary_key: :batch_id, class_name: "SolidQueue::BatchExecution",
-      dependent: :destroy
+    has_many :jobs
+    has_many :batch_executions, class_name: "SolidQueue::BatchExecution", dependent: :destroy
 
     serialize :on_finish, coder: JSON
     serialize :on_success, coder: JSON
     serialize :on_failure, coder: JSON
     serialize :metadata, coder: JSON
 
-    after_initialize :set_batch_id
+    after_initialize :set_active_job_batch_id
     after_commit :start_batch, on: :create, unless: -> { ActiveRecord.respond_to?(:after_all_transactions_commit) }
 
     mattr_accessor :maintenance_queue_name
@@ -25,7 +24,7 @@ def enqueue(&block)
       transaction do
         save! if new_record?
 
-        Batch.wrap_in_batch_context(batch_id) do
+        Batch.wrap_in_batch_context(id) do
           block&.call(self)
         end
 
@@ -54,7 +53,7 @@ def check_completion!
       return if batch_executions.limit(1).exists?
 
       rows = Batch
-        .by_batch_id(batch_id)
+        .where(id: id)
         .unfinished
         .empty_executions
         .update_all(finished_at: Time.current)
@@ -77,8 +76,8 @@ def check_completion!
 
     private
 
-      def set_batch_id
-        self.batch_id ||= SecureRandom.uuid
+      def set_active_job_batch_id
+        self.active_job_batch_id ||= SecureRandom.uuid
       end
 
       def as_active_job(active_job_klass)
@@ -114,7 +113,7 @@ def execute_callbacks
       end
 
       def enqueue_empty_job
-        Batch.wrap_in_batch_context(batch_id) do
+        Batch.wrap_in_batch_context(id) do
           EmptyJob.set(queue: self.class.maintenance_queue_name || "default").perform_later
         end
       end

app/models/solid_queue/batch/trackable.rb

@@ -10,12 +10,11 @@ module Trackable
         scope :succeeded, -> { finished.where(failed_at: nil) }
         scope :unfinished, -> { where(finished_at: nil) }
         scope :failed, -> { where.not(failed_at: nil) }
-        scope :by_batch_id, ->(batch_id) { where(batch_id:) }
         scope :empty_executions, -> {
           where(<<~SQL)
             NOT EXISTS (
               SELECT 1 FROM solid_queue_batch_executions
-              WHERE solid_queue_batch_executions.batch_id = solid_queue_batches.batch_id
+              WHERE solid_queue_batch_executions.batch_id = solid_queue_batches.id
               LIMIT 1
             )
           SQL

app/models/solid_queue/batch_execution.rb

@@ -3,13 +3,13 @@
 module SolidQueue
   class BatchExecution < Record
     belongs_to :job, optional: true
-    belongs_to :batch, foreign_key: :batch_id, primary_key: :batch_id
+    belongs_to :batch
 
     after_commit :check_completion, on: :destroy
 
     private
       def check_completion
-        batch = Batch.find_by(batch_id: batch_id)
+        batch = Batch.find_by(id: batch_id)
         batch.check_completion! if batch.present?
       end
 
@@ -24,7 +24,7 @@ def create_all_from_jobs(jobs)
           })
 
           total = jobs.size
-          SolidQueue::Batch.where(batch_id:).update_all([ "total_jobs = total_jobs + ?", total ])
+          SolidQueue::Batch.where(id: batch_id).update_all([ "total_jobs = total_jobs + ?", total ])
         end
       end
     end

app/models/solid_queue/job/batchable.rb

@@ -6,7 +6,7 @@ module Batchable
       extend ActiveSupport::Concern
 
       included do
-        belongs_to :batch, foreign_key: :batch_id, primary_key: :batch_id, class_name: "SolidQueue::Batch", optional: true
+        belongs_to :batch, optional: true
         has_one :batch_execution, foreign_key: :job_id, dependent: :destroy
 
         after_create :create_batch_execution, if: :batch_id?

lib/active_job/batch_id.rb

@@ -25,7 +25,7 @@ def deserialize(job_data)
     end
 
     def batch
-      @batch ||= SolidQueue::Batch.find_by(batch_id: batch_id)
+      @batch ||= SolidQueue::Batch.find_by(id: batch_id)
     end
 
     private

lib/generators/solid_queue/install/templates/db/queue_schema.rb

@@ -37,7 +37,7 @@
     t.string "concurrency_key"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
-    t.string "batch_id"
+    t.bigint "batch_id"
     t.index [ "active_job_id" ], name: "index_solid_queue_jobs_on_active_job_id"
     t.index [ "batch_id" ], name: "index_solid_queue_jobs_on_batch_id"
     t.index [ "class_name" ], name: "index_solid_queue_jobs_on_class_name"
@@ -123,7 +123,7 @@
   end
 
   create_table "solid_queue_batches", force: :cascade do |t|
-    t.string "batch_id"
+    t.string "active_job_batch_id"
     t.text "on_finish"
     t.text "on_success"
     t.text "on_failure"
@@ -136,12 +136,12 @@
     t.datetime "failed_at"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
-    t.index ["batch_id"], name: "index_solid_queue_batches_on_batch_id", unique: true
+    t.index ["active_job_batch_id"], name: "index_solid_queue_batches_on_active_job_batch_id", unique: true
   end
 
   create_table "solid_queue_batch_executions", force: :cascade do |t|
     t.bigint "job_id", null: false
-    t.string "batch_id", null: false
+    t.bigint "batch_id", null: false
     t.datetime "created_at", null: false
     t.index [ "job_id" ], name: "index_solid_queue_batch_executions_on_job_id", unique: true
     t.index ["batch_id"], name: "index_solid_queue_batch_executions_on_batch_id"

test/dummy/db/queue_schema.rb

@@ -49,7 +49,7 @@
     t.string "concurrency_key"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
-    t.string "batch_id"
+    t.bigint "batch_id"
     t.index ["active_job_id"], name: "index_solid_queue_jobs_on_active_job_id"
     t.index ["batch_id"], name: "index_solid_queue_jobs_on_batch_id"
     t.index ["class_name"], name: "index_solid_queue_jobs_on_class_name"
@@ -135,7 +135,7 @@
   end
 
   create_table "solid_queue_batches", charset: "utf8mb4", collation: "utf8mb4_0900_ai_ci", force: :cascade do |t|
-    t.string "batch_id"
+    t.string "active_job_batch_id"
     t.text "on_finish"
     t.text "on_success"
     t.text "on_failure"
@@ -148,12 +148,12 @@
     t.datetime "failed_at"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
-    t.index ["batch_id"], name: "index_solid_queue_batches_on_batch_id", unique: true
+    t.index ["active_job_batch_id"], name: "index_solid_queue_batches_on_active_job_batch_id", unique: true
   end
 
   create_table "solid_queue_batch_executions", charset: "utf8mb4", collation: "utf8mb4_0900_ai_ci", force: :cascade do |t|
     t.bigint "job_id", null: false
-    t.string "batch_id", null: false
+    t.bigint "batch_id", null: false
     t.datetime "created_at", null: false
     t.index ["job_id"], name: "index_solid_queue_batch_executions_on_job_id", unique: true
     t.index ["batch_id"], name: "index_solid_queue_batch_executions_on_batch_id"

test/integration/batch_lifecycle_test.rb

@@ -173,8 +173,8 @@ def perform
     wait_for_batches_to_finish_for(3.seconds)
     wait_for_jobs_to_finish_for(1.second)
 
-    job_batch1 = SolidQueue::Batch.find_by(batch_id: batch1.batch_id)
-    job_batch2 = SolidQueue::Batch.find_by(batch_id: batch2.batch_id)
+    job_batch1 = SolidQueue::Batch.find_by(id: batch1.id)
+    job_batch2 = SolidQueue::Batch.find_by(id: batch2.id)
 
     assert_equal 2, SolidQueue::Batch.count
     assert_equal 2, SolidQueue::Batch.finished.count
@@ -232,8 +232,8 @@ def perform
     wait_for_batches_to_finish_for(3.seconds)
     wait_for_jobs_to_finish_for(1.second)
 
-    job_batch1 = SolidQueue::Batch.find_by(batch_id: batch1.batch_id)
-    job_batch2 = SolidQueue::Batch.find_by(batch_id: batch2.batch_id)
+    job_batch1 = SolidQueue::Batch.find_by(id: batch1.id)
+    job_batch2 = SolidQueue::Batch.find_by(id: batch2.id)
 
     assert_equal 2, SolidQueue::Batch.count
     assert_equal 2, SolidQueue::Batch.finished.count
@@ -288,7 +288,7 @@ def perform
     wait_for_batches_to_finish_for(2.seconds)
     wait_for_jobs_to_finish_for(1.second)
 
-    assert_equal [ "Hi finish #{batch.batch_id}!", "Hi success #{batch.batch_id}!", "hey" ].sort, JobBuffer.values.sort
+    assert_equal [ "Hi finish #{batch.id}!", "Hi success #{batch.id}!", "hey" ].sort, JobBuffer.values.sort
     assert_equal 1, batch.reload.completed_jobs
     assert_equal 0, batch.failed_jobs
     assert_equal 0, batch.pending_jobs
@@ -299,23 +299,23 @@ class OnFinishJob < ApplicationJob
     queue_as :background
 
     def perform(batch)
-      JobBuffer.add "Hi finish #{batch.batch_id}!"
+      JobBuffer.add "Hi finish #{batch.id}!"
     end
   end
 
   class OnSuccessJob < ApplicationJob
     queue_as :background
 
     def perform(batch)
-      JobBuffer.add "Hi success #{batch.batch_id}!"
+      JobBuffer.add "Hi success #{batch.id}!"
     end
   end
 
   class OnFailureJob < ApplicationJob
     queue_as :background
 
     def perform(batch)
-      JobBuffer.add "Hi failure #{batch.batch_id}!"
+      JobBuffer.add "Hi failure #{batch.id}!"
     end
   end
 
@@ -330,6 +330,6 @@ def job!(active_job)
   end
 
   def batch_jobs(*batches)
-    SolidQueue::Job.where(batch_id: batches.map(&:batch_id))
+    SolidQueue::Job.where(id: batches.map(&:id))
   end
 end