postburner 1.0.0.rc.3 → 1.0.0.rc.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9aa20d7fa2c867942efc6c70f7ad56548e651192068c9505a2854310cbb95043
-  data.tar.gz: 74606e227872a914c3a806227d74206d4b66a33b7160753cbbb48a15d48a7d9c
+  metadata.gz: fc5a8c616b4bf393b03fdc5d2bef57eb03e1a9b9dc06fe592f89b3d1238c2606
+  data.tar.gz: 40fe3028ce331e7ecbc6facb5829b845272ce66c14578cdd12b79a4495de85ce
 SHA512:
-  metadata.gz: cf4238e6bc83f1447de5c846032aad268d904fb5f74c1462424c69ffed8e40ffe316c51c2d248b2a6b46b7fb96df9b572f028368cc9e8e65e4baf8bffa7175b5
-  data.tar.gz: c93242ccd8501c5b337417f60633474104550360276c607a48308ed6bfcbcd5bd77aeafa9df7e6f0e6cb0f15094ffe4ada75ef13f2704e98c2fd31bc674fe791
+  metadata.gz: 2e3095d5efd3761db840b44461f42f127269608a6070ead2e9b5751054e3875e11098d34ac9232237baa27350ec46fbf8413a80adde99feae0115bedd9b08e68
+  data.tar.gz: 3a38ad87ba8692bae49462dbf6ac8e0013cb64209200c44201a25e5cb5d2c73ea14719753f279da4ce7da016d1af581a446bec7ad97af035f4884d645c12fefe

data/CHANGELOG.md

@@ -1,5 +1,73 @@
 # Changelog
 
+## v1.0.0.rc.4 - 2026-06-10
+
+### Added
+- `Postburner::OrphanedJob` — inert STI placeholder loaded when a row's `type` column references a deleted or renamed class. Prevents `ActiveRecord::SubclassNotFound` from crashing callers (e.g. the admin queued-jobs index). `perform` and `queue!`/`requeue!` raise `Postburner::Job::OrphanedJobError`. `readonly?` returns `true` to prevent Rails' `ensure_proper_type` from overwriting the original `type` string. `remove!` (soft-delete) and `destroy` still work. No migration required.
+- `Postburner::Job::OrphanedJobError` — raised by `OrphanedJob#perform` and `#queue!`/`#requeue!`.
+- `Postburner::Job#orphaned?` — predicate; always `false` on the base class, `true` on `OrphanedJob`.
+- `Postburner::Job.find_sti_class` override — rescues `ActiveRecord::SubclassNotFound` and returns `Postburner::OrphanedJob` instead.
+- Partial indexes on `postburner_jobs` (`idx_pbjobs_active_run_at`, `idx_pbjobs_processed`, `idx_pbjobs_unqueued`) tuned to the admin UI's default queries, keeping the jobs list fast on large tables.
+- `JobsController#index` now accepts a `scope` param (`active`, `processed`, `unqueued`, `all`) and defaults to `active`, so the default page load matches the `idx_pbjobs_active_run_at` predicate.
+
+### Changed
+- `postburner_jobs.lag` is now `bigint` instead of `integer`, to avoid overflow on jobs that sit in the queue long enough to exceed the 32-bit range.
+
+### Upgrade notes
+- This is a **template mutation**, not an additive migration. Existing rc.x installs will need to either re-run `rails generate postburner:install` (and merge the migration by hand) or manually add an equivalent migration that creates the three partial indexes. Failing to do either is **non-catastrophic** — the admin UI will simply remain slow on large `postburner_jobs` tables until the indexes are in place.
+- The `lag` column type change (`integer` → `bigint`) is also a template mutation. Existing installs should add a migration along the lines of `change_column :postburner_jobs, :lag, :bigint` to avoid overflow once lag values exceed the 32-bit range.
+
+Example migration covering both the `lag` widening and the three partial indexes:
+
+```ruby
+class UpgradePostburnerJobsForRc4 < ActiveRecord::Migration[7.2]
+  disable_ddl_transaction!
+
+  def up
+    # Widen lag to bigint to avoid 32-bit overflow on long-queued jobs.
+    # ~24.9 days -> ~292.5 million years
+    change_column :postburner_jobs, :lag, :bigint
+
+    # Partial indexes tuned to the admin UI's default queries.
+    add_index :postburner_jobs, :run_at,
+      name: 'idx_pbjobs_active_run_at',
+      where: '(processed_at IS NULL AND removed_at IS NULL AND queued_at IS NOT NULL)',
+      algorithm: :concurrently
+
+    add_index :postburner_jobs, :processed_at,
+      name: 'idx_pbjobs_processed',
+      order: { processed_at: :desc },
+      where: '(processed_at IS NOT NULL)',
+      algorithm: :concurrently
+
+    add_index :postburner_jobs, [:removed_at, :created_at],
+      name: 'idx_pbjobs_unqueued',
+      order: { created_at: :desc },
+      where: '(queued_at IS NULL AND removed_at IS NULL)',
+      algorithm: :concurrently
+  end
+
+  def down
+    remove_index :postburner_jobs, name: 'idx_pbjobs_unqueued', algorithm: :concurrently
+    remove_index :postburner_jobs, name: 'idx_pbjobs_processed', algorithm: :concurrently
+    remove_index :postburner_jobs, name: 'idx_pbjobs_active_run_at', algorithm: :concurrently
+
+    change_column :postburner_jobs, :lag, :integer
+  end
+end
+```
+
+Notes:
+- `disable_ddl_transaction!` + `algorithm: :concurrently` is recommended for production tables of any size — it builds the indexes without holding a long write lock. Drop both if you're on a small dev table and want a single transactional migration.
+- `change_column ... :bigint` on PostgreSQL is an in-place type widening for `integer → bigint` and is fast (no full table rewrite), but it does take a brief `ACCESS EXCLUSIVE` lock — schedule accordingly on hot tables.
+- Adjust `ActiveRecord::Migration[7.2]` to match your app's Rails version.
+
+## v1.0.0.rc.3
+
+## v1.0.0.rc.2
+
+## v1.0.0.rc.1
+
 ## v0.7.0 - 2022-10-24
 
 ### Added

data/app/controllers/postburner/jobs_controller.rb

@@ -2,12 +2,41 @@ require_dependency "postburner/application_controller"
 
 module Postburner
   class JobsController < ApplicationController
+    # Scopes align with the partial indexes defined in the install
+    # migration. Keeping the controller's default query matched to an
+    # index predicate keeps the admin UI fast on large tables.
+    SCOPES = %w[ active processed unqueued all ].freeze
+    DEFAULT_SCOPE = 'active'.freeze
+
     def index
-      @jobs = Job.order(queued_at: :desc, created_at: :desc)
+      @scope = SCOPES.include?(params[:scope]) ? params[:scope] : DEFAULT_SCOPE
+      @jobs = scoped_jobs(@scope)
     end
 
     def show
       @job = Job.find(params[:id])
     end
+
+    private
+
+    def scoped_jobs(scope)
+      case scope
+      when 'active'
+        # Uses idx_pbjobs_active_run_at
+        Job.where(processed_at: nil, removed_at: nil)
+           .where.not(queued_at: nil)
+           .order(run_at: :asc)
+      when 'processed'
+        # Uses idx_pbjobs_processed
+        Job.where.not(processed_at: nil)
+           .order(processed_at: :desc)
+      when 'unqueued'
+        # Uses idx_pbjobs_unqueued
+        Job.where(queued_at: nil, removed_at: nil)
+           .order(created_at: :desc)
+      else
+        Job.order(queued_at: :desc, created_at: :desc)
+      end
+    end
   end
 end

data/app/models/postburner/job.rb

@@ -88,6 +88,30 @@ module Postburner
 
     validates :sid, presence: {strict: true}
 
+    # Resolves an STI type name to a class, falling back to OrphanedJob when the
+    # original class no longer exists. This tolerates rows whose `type` column
+    # references a deleted or renamed job class, preventing
+    # ActiveRecord::SubclassNotFound from crashing callers (e.g. the admin
+    # queued-jobs page).
+    #
+    # @param type_name [String] The value stored in the `type` column
+    # @return [Class] The resolved class, or {Postburner::OrphanedJob} if missing
+    #
+    def self.find_sti_class(type_name)
+      super
+    rescue ActiveRecord::SubclassNotFound
+      Postburner::OrphanedJob
+    end
+
+    # Returns whether this job instance is an orphaned placeholder.
+    #
+    # Always false on the base class. Overridden to return true in
+    # {Postburner::OrphanedJob}.
+    #
+    # @return [Boolean]
+    #
+    def orphaned? = false
+
     # Abstract method to be implemented by subclasses.
     #
     # This method contains the actual work logic for the job. It is called
@@ -220,6 +244,15 @@ module Postburner
     #
     class AlreadyProcessed < StandardError; end
 
+    # Exception raised when attempting to perform or enqueue an orphaned job whose
+    # original class no longer exists in the application.
+    #
+    # @example
+    #   job = Postburner::Job.find(id)  # loads as OrphanedJob if class is gone
+    #   job.perform  # => raises OrphanedJobError
+    #
+    class OrphanedJobError < StandardError; end
+
     # Exception raised when a job is executed before its scheduled run_at time.
     #
     # In production (Queue/NiceQueue), this is handled by re-inserting with delay.

data/app/models/postburner/orphaned_job.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Postburner
+  # Inert STI placeholder loaded when a Postburner::Job row's `type` column
+  # references a class that no longer exists in the application.
+  #
+  # ## Why readonly?
+  #
+  # Rails' `ensure_proper_type` (called via `save`/`update`) would overwrite the
+  # original `type` value with `'Postburner::OrphanedJob'`, permanently destroying
+  # the record of which class was missing. `readonly?` returning true prevents all
+  # `save`/`update` paths and therefore blocks `ensure_proper_type` from running.
+  #
+  # Rails' `instantiate` reads the `type` column verbatim when loading records from
+  # the database and does NOT call `ensure_proper_type`, so the original class name
+  # is preserved on load. This class is only ever instantiated via the
+  # `find_sti_class` fallback in {Postburner::Job}, never created directly.
+  #
+  # ## Why remove! is overridden here
+  #
+  # In Rails 8.1+, `update_column` respects `readonly?` and raises
+  # `ActiveRecord::ReadOnlyRecord`. The base `Commands#remove!` calls
+  # `update_column(:removed_at, ...)` — so it would be blocked too. This subclass
+  # overrides `remove!` to use `self.class.where(id: self.id).update_all(...)` which
+  # operates at the relation level (bypasses both `readonly?` and all instance
+  # callbacks) while still soft-deleting the row. Admins can therefore safely
+  # soft-remove orphaned rows without restoring the missing class.
+  #
+  # ## Usage
+  #
+  # This class is loaded automatically by {Postburner::Job.find_sti_class} when a
+  # row's type is unresolvable. You should never instantiate it directly in
+  # application code.
+  #
+  # @example Typical lifecycle
+  #   # A DB row exists with type: 'Flex::TriggerNoShowDeliveriesJob' (class deleted)
+  #   job = Postburner::Job.find(42)
+  #   job.class         # => Postburner::OrphanedJob
+  #   job.type          # => 'Flex::TriggerNoShowDeliveriesJob'
+  #   job.orphaned?     # => true
+  #   job.missing_class_name  # => 'Flex::TriggerNoShowDeliveriesJob'
+  #   job.perform             # => raises Postburner::Job::OrphanedJobError
+  #   job.remove!             # soft-deletes fine despite readonly?
+  #
+  class OrphanedJob < Job
+    # Returns the original class name stored in the `type` column — the deleted
+    # or renamed class that this placeholder stands in for.
+    #
+    # @return [String]
+    #
+    def missing_class_name
+      self.type.to_s
+    end
+
+    # Always true; identifies this instance as an orphaned placeholder.
+    #
+    # @return [Boolean]
+    #
+    def orphaned? = true
+
+    # Raises {Postburner::Job::OrphanedJobError} because the original job class
+    # no longer exists and there is no implementation to run.
+    #
+    # @raise [Postburner::Job::OrphanedJobError] always
+    #
+    def perform(*)
+      raise Postburner::Job::OrphanedJobError,
+        "Cannot perform orphaned job ##{self.id}: class '#{self.missing_class_name}' no longer exists"
+    end
+
+    # Raises {Postburner::Job::OrphanedJobError} because re-enqueuing a job whose
+    # class is gone would only produce another unperformable entry.
+    #
+    # @raise [Postburner::Job::OrphanedJobError] always
+    #
+    def queue!(*)
+      raise Postburner::Job::OrphanedJobError,
+        "Cannot enqueue orphaned job ##{self.id}: class '#{self.missing_class_name}' no longer exists"
+    end
+    alias_method :requeue!, :queue!
+
+    # Soft-deletes this orphaned row by setting `removed_at`, bypassing the
+    # `readonly?` guard via a relation-level `update_all` call (which does not go
+    # through instance save/update and therefore does not trigger
+    # `ensure_proper_type` either).
+    #
+    # Idempotent: does nothing if already removed.
+    #
+    # @return [void]
+    #
+    def remove!
+      return if self.removed_at
+
+      self.delete!
+      now = Time.current
+      self.class.where(id: self.id).update_all(removed_at: now)
+      self.removed_at = now
+    end
+
+    # Prevents saves that would allow Rails' ensure_proper_type to overwrite the
+    # original `type` value with 'Postburner::OrphanedJob'.
+    #
+    # @return [Boolean] always true
+    #
+    def readonly? = true
+  end
+end

data/app/models/postburner/schedule.rb

@@ -366,6 +366,11 @@ module Postburner
 
       execution.save!
 
+      # Reload so instrumented timestamps reflect persisted (microsecond)
+      # precision rather than the in-memory nanosecond values, matching what
+      # consumers see after a DB roundtrip (see #enqueue! reload below).
+      execution.reload
+
       # Instrument execution creation
       ActiveSupport::Notifications.instrument('create.schedule_execution.postburner', {
         schedule: Postburner::Instrumentation.schedule_payload(self),

data/lib/generators/postburner/install/templates/migrations/create_postburner_jobs.rb.erb

@@ -13,7 +13,7 @@ class CreatePostburnerJobs < ActiveRecord::Migration<%= migration_version %>
       t.datetime :processing_at
       t.datetime :processed_at
       t.datetime :removed_at
-      t.integer :lag
+      t.bigint :lag
       t.integer :duration
       t.integer :attempt_count
       t.integer :error_count
@@ -37,6 +37,22 @@ class CreatePostburnerJobs < ActiveRecord::Migration<%= migration_version %>
       t.index [ :error_count ]
       t.index [ :log_count ]
 
+      # Partial indexes tuned to the admin UI's default queries. Kept
+      # alongside the single-column indexes above: the single-column
+      # indexes still serve ad-hoc queries, while these partials keep
+      # the hot-path listing queries fast on large tables.
+      t.index :run_at,
+        name: 'idx_pbjobs_active_run_at',
+        where: 'processed_at IS NULL AND removed_at IS NULL AND queued_at IS NOT NULL'
+      t.index :processed_at,
+        name: 'idx_pbjobs_processed',
+        order: { processed_at: :desc },
+        where: 'processed_at IS NOT NULL'
+      t.index [ :removed_at, :created_at ],
+        name: 'idx_pbjobs_unqueued',
+        order: { created_at: :desc },
+        where: 'queued_at IS NULL AND removed_at IS NULL'
+
       # Add these or more depending on what you want to search for.
       #t.index [ :attempts ], using: :gin
       #t.index [ :errata ], using: :gin

data/lib/postburner/version.rb

@@ -1,3 +1,3 @@
 module Postburner
-  VERSION = '1.0.0.rc.3'
+  VERSION = '1.0.0.rc.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postburner
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc.3
+  version: 1.0.0.rc.4
 platform: ruby
 authors:
 - Matt Smith
@@ -138,6 +138,7 @@ files:
 - app/models/postburner/application_record.rb
 - app/models/postburner/job.rb
 - app/models/postburner/mailer.rb
+- app/models/postburner/orphaned_job.rb
 - app/models/postburner/schedule.rb
 - app/models/postburner/schedule_execution.rb
 - app/models/postburner/tracked_job.rb