Add kind, pid and hostname as first-class attributes to Process

Author: rosa

app/models/solid_queue/blocked_execution.rb

@@ -1,5 +1,5 @@
 module SolidQueue
-  class BlockedExecution < SolidQueue::Execution
+  class BlockedExecution < Execution
     assume_attributes_from_job :concurrency_key
     before_create :set_expires_at
 

app/models/solid_queue/execution.rb

@@ -1,5 +1,5 @@
 module SolidQueue
-  class Execution < SolidQueue::Record
+  class Execution < Record
     include JobAttributes
 
     self.abstract_class = true

app/models/solid_queue/process.rb

@@ -5,7 +5,7 @@ class SolidQueue::Process < SolidQueue::Record
   has_many :forks, class_name: "SolidQueue::Process", inverse_of: :supervisor, foreign_key: :supervisor_id, dependent: :destroy
   has_many :claimed_executions
 
-  store :metadata, accessors: [ :kind, :pid ], coder: JSON
+  store :metadata, coder: JSON
 
   after_destroy -> { claimed_executions.release_all }
 

app/models/solid_queue/scheduled_execution.rb

@@ -1,5 +1,5 @@
 module SolidQueue
-  class ScheduledExecution < SolidQueue::Execution
+  class ScheduledExecution < Execution
     scope :due, -> { where(scheduled_at: ..Time.current) }
     scope :ordered, -> { order(scheduled_at: :asc, priority: :asc) }
     scope :next_batch, ->(batch_size) { due.ordered.limit(batch_size) }

db/migrate/20231211200639_add_new_attributes_to_processes.rb

@@ -0,0 +1,9 @@
+class AddNewAttributesToProcesses < ActiveRecord::Migration[7.1]
+  def change
+    change_table :solid_queue_processes do |t|
+      t.string :kind, null: false
+      t.string :hostname
+      t.integer :pid, null: false
+    end
+  end
+end

lib/solid_queue/process_registration.rb

@@ -32,7 +32,12 @@ def supervised_by(process)
       attr_accessor :process
 
       def register
-        @process = SolidQueue::Process.register(supervisor: supervisor, metadata: metadata)
+        @process = SolidQueue::Process.register \
+          kind: self.class.name.demodulize,
+          pid: process_pid,
+          supervisor: supervisor,
+          hostname: hostname,
+          metadata: metadata
       end
 
       def deregister
@@ -65,7 +70,7 @@ def process_pid
       end
 
       def metadata
-        { kind: self.class.name.demodulize, hostname: hostname, pid: process_pid, supervisor_pid: supervisor&.pid }
+        {}
       end
   end
 end

test/dummy/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.1].define(version: 2023_12_08_215544) do
+ActiveRecord::Schema[7.1].define(version: 2023_12_11_200639) do
   create_table "job_results", charset: "utf8mb4", collation: "utf8mb4_0900_ai_ci", force: :cascade do |t|
     t.string "queue_name"
     t.string "status"
@@ -73,6 +73,9 @@
     t.datetime "created_at", null: false
     t.datetime "last_heartbeat_at", null: false
     t.bigint "supervisor_id"
+    t.string "kind", null: false
+    t.string "hostname"
+    t.integer "pid", null: false
     t.index ["last_heartbeat_at"], name: "index_solid_queue_processes_on_last_heartbeat_at"
     t.index ["supervisor_id"], name: "index_solid_queue_processes_on_supervisor_id"
   end

test/integration/processes_lifecycle_test.rb

@@ -194,13 +194,13 @@ def assert_registered_workers_for(*queues)
       workers = find_processes_registered_as("Worker")
       registered_queues = workers.map { |process| process.metadata["queues"] }.compact
       assert_equal queues.map(&:to_s).sort, registered_queues.sort
-      assert_equal [ @pid ], workers.map { |process| process.metadata["supervisor_pid"] }.uniq
+      assert_equal [ @pid ], workers.map { |process| process.supervisor.pid }.uniq
     end
 
     def assert_registered_supervisor
       processes = find_processes_registered_as("Supervisor")
       assert_equal 1, processes.count
-      assert_equal @pid, processes.first.metadata["pid"]
+      assert_equal @pid, processes.first.pid
     end
 
     def assert_no_registered_workers

test/models/solid_queue/claimed_execution_test.rb

@@ -2,7 +2,7 @@
 
 class SolidQueue::ClaimedExecutionTest < ActiveSupport::TestCase
   setup do
-    @process = SolidQueue::Process.register(metadata: { queue: "background" })
+    @process = SolidQueue::Process.register(kind: "Worker", pid: 42, metadata: { queue: "background" })
   end
 
   test "perform job successfully" do

test/models/solid_queue/process_test.rb

@@ -2,12 +2,12 @@
 
 class SolidQueue::ProcessTest < ActiveSupport::TestCase
   test "prune processes with expired heartbeats" do
-    SolidQueue::Process.register(metadata: { pid: 42 })
-    SolidQueue::Process.register(metadata: { pid: 24 })
+    SolidQueue::Process.register(kind: "Worker", pid: 42)
+    SolidQueue::Process.register(kind: "Worker", pid: 43)
 
     travel_to 10.minutes.from_now
 
-    SolidQueue::Process.register(metadata: { pid: 16 })
+    SolidQueue::Process.register(kind: "Worker", pid: 44)
 
     assert_difference -> { SolidQueue::Process.count }, -2 do
       SolidQueue::Process.prune