postburner 1.0.0.pre.11 → 1.0.0.pre.12

data/lib/postburner.rb

@@ -7,8 +7,7 @@ require "postburner/tracked"
 require "postburner/active_job/payload"
 require "postburner/active_job/execution"
 require "postburner/active_job/adapter"
-require "postburner/workers/base"
-require "postburner/workers/worker"
+require "postburner/worker"
 require "postburner/runner"
 require "postburner/engine"
 require "postburner/strategies/queue"
@@ -17,7 +16,7 @@ require "postburner/strategies/test_queue"
 require "postburner/strategies/immediate_test_queue"
 require "postburner/strategies/null_queue"
 
-# Postburner - PostgreSQL-backed job queue system built on Backburner and Beanstalkd.
+# Postburner - PostgreSQL-backed job queue system built on Beanstalkd.
 #
 # Postburner is a Ruby on Rails Engine that provides a database-backed job queue with
 # full audit trails, inspection capabilities, and multiple execution strategies. Every
@@ -28,7 +27,7 @@ require "postburner/strategies/null_queue"
 #
 # - **Jobs:** Subclass {Postburner::Job} and implement `perform` method
 # - **Queue Strategies:** Control how jobs are executed (async, inline, test modes)
-# - **Beanstalkd Integration:** Production queuing via Backburner
+# - **Beanstalkd Integration:** Production queuing via Beanstalkd
 # - **Database Persistence:** Full audit trail with timestamps, logs, and errors
 # - **Callbacks:** ActiveJob-style lifecycle hooks (enqueue, attempt, processing, processed)
 #
@@ -385,7 +384,7 @@ module Postburner
   # configuration. This prevents accidentally clearing tubes from other
   # applications or environments sharing the same Beanstalkd server.
   #
-  # @param tube_names [Array<String>, nil] Array of tube names to clear, or nil to only show stats
+  # @param tube_names [Array<String>, String, nil] Tube name(s) to clear, or nil to only show stats
   # @param silent [Boolean] If true, suppress output to stdout (default: false)
   #
   # @return [Hash] Statistics and results (see Connection#clear_tubes!)
@@ -400,6 +399,10 @@ module Postburner
   #   Postburner.clear_jobs!(Postburner.watched_tube_names)
   #   # Only clears tubes defined in your config
   #
+  # @example Clear scheduler tube (single string)
+  #   Postburner.clear_jobs!(Postburner.scheduler_tube_name)
+  #   # Clears the scheduler watchdog tube
+  #
   # @example Trying to clear unconfigured tube - RAISES ERROR
   #   Postburner.clear_jobs!(['some-other-app-tube'])
   #   # => ArgumentError: Cannot clear tubes not in configuration
@@ -413,6 +416,7 @@ module Postburner
   def self.clear_jobs!(tube_names = nil, silent: false)
     require 'json'
 
+    tube_names = Array(tube_names) if tube_names
     result = connection.clear_tubes!(tube_names)
 
     unless silent
@@ -449,6 +453,21 @@ module Postburner
     @__watched_tubes ||= watched_tube_names.map { |tube_name| connection.tubes[tube_name] }
   end
 
+  # Returns the scheduler tube name with environment prefix.
+  #
+  # @return [String] Expanded scheduler tube name
+  #
+  # @example
+  #   Postburner.scheduler_tube_name
+  #   # => 'postburner.production.scheduler'
+  #
+  # @example Clear scheduler tube
+  #   Postburner.clear_jobs!(Postburner.scheduler_tube_name)
+  #
+  def self.scheduler_tube_name
+    configuration.scheduler_tube_name
+  end
+
   # Returns the Beanstalkd tube name prefix for the given environment.
   #
   # Delegates to {Configuration#tube_prefix}. Postburner automatically
@@ -519,14 +538,14 @@ module Postburner
 
           tube_data = {
             name: tube.name,
-            ready: stats_hash['current-jobs-ready'] || 0,
-            delayed: stats_hash['current-jobs-delayed'] || 0,
-            buried: stats_hash['current-jobs-buried'] || 0,
-            reserved: stats_hash['current-jobs-reserved'] || 0,
-            total: (stats_hash['current-jobs-ready'] || 0) +
-                   (stats_hash['current-jobs-delayed'] || 0) +
-                   (stats_hash['current-jobs-buried'] || 0) +
-                   (stats_hash['current-jobs-reserved'] || 0)
+            ready: stats_hash['current_jobs_ready'] || 0,
+            delayed: stats_hash['current_jobs_delayed'] || 0,
+            buried: stats_hash['current_jobs_buried'] || 0,
+            reserved: stats_hash['current_jobs_reserved'] || 0,
+            total: (stats_hash['current_jobs_ready'] || 0) +
+                   (stats_hash['current_jobs_delayed'] || 0) +
+                   (stats_hash['current_jobs_buried'] || 0) +
+                   (stats_hash['current_jobs_reserved'] || 0)
           }
         rescue Beaneater::NotFoundError
           # Tube doesn't exist yet, skip it

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postburner
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.11
+  version: 1.0.0.pre.12
 platform: ruby
 authors:
 - Matt Smith
@@ -124,6 +124,8 @@ files:
 - app/models/postburner/application_record.rb
 - app/models/postburner/job.rb
 - app/models/postburner/mailer.rb
+- app/models/postburner/schedule.rb
+- app/models/postburner/schedule_execution.rb
 - app/models/postburner/tracked_job.rb
 - app/views/layouts/postburner/application.html.haml
 - app/views/postburner/jobs/index.html.haml
@@ -138,15 +140,18 @@ files:
 - lib/generators/postburner/install/install_generator.rb
 - lib/generators/postburner/install/templates/config/postburner.yml
 - lib/generators/postburner/install/templates/migrations/create_postburner_jobs.rb.erb
+- lib/generators/postburner/install/templates/migrations/create_postburner_schedules.rb.erb
 - lib/postburner.rb
 - lib/postburner/active_job/adapter.rb
 - lib/postburner/active_job/execution.rb
 - lib/postburner/active_job/payload.rb
+- lib/postburner/advisory_lock.rb
 - lib/postburner/beanstalkd.rb
 - lib/postburner/configuration.rb
 - lib/postburner/connection.rb
 - lib/postburner/engine.rb
 - lib/postburner/runner.rb
+- lib/postburner/scheduler.rb
 - lib/postburner/strategies/immediate_test_queue.rb
 - lib/postburner/strategies/nice_queue.rb
 - lib/postburner/strategies/null_queue.rb
@@ -156,8 +161,7 @@ files:
 - lib/postburner/tracked.rb
 - lib/postburner/tube.rb
 - lib/postburner/version.rb
-- lib/postburner/workers/base.rb
-- lib/postburner/workers/worker.rb
+- lib/postburner/worker.rb
 - lib/tasks/postburner.rake
 - lib/tasks/postburner_tasks.rake
 homepage: https://gitlab.nearapogee.com/opensource/postburner

data/lib/postburner/workers/base.rb

@@ -1,205 +0,0 @@
-# frozen_string_literal: true
-
-module Postburner
-  module Workers
-    # Base worker class with shared functionality for all worker types.
-    #
-    # Provides common methods for signal handling, job execution, error handling,
-    # and retry logic. Subclasses implement the specific execution strategy
-    # (simple, forking, threads_on_fork).
-    #
-    class Base
-      attr_reader :config, :logger
-
-      # @param config [Postburner::Configuration] Worker configuration
-      #
-      def initialize(config)
-        @config = config
-        @logger = config.logger
-        @shutdown = false
-        setup_signal_handlers
-      end
-
-      # Starts the worker loop.
-      #
-      # Subclasses must implement this method to define their execution strategy.
-      #
-      # @return [void]
-      #
-      # @raise [NotImplementedError] if not implemented by subclass
-      #
-      def start
-        raise NotImplementedError, "Subclasses must implement #start"
-      end
-
-      # Initiates graceful shutdown.
-      #
-      # Sets shutdown flag to stop processing new jobs. Current jobs
-      # are allowed to finish.
-      #
-      # @return [void]
-      #
-      def shutdown
-        @shutdown = true
-      end
-
-      # Checks if shutdown has been requested.
-      #
-      # @return [Boolean] true if shutdown requested, false otherwise
-      #
-      def shutdown?
-        @shutdown
-      end
-
-      protected
-
-      # Sets up signal handlers for graceful shutdown.
-      #
-      # TERM and INT signals trigger graceful shutdown.
-      #
-      # @return [void]
-      #
-      def setup_signal_handlers
-        Signal.trap('TERM') { shutdown }
-        Signal.trap('INT') { shutdown }
-      end
-
-      # Expands queue name to full tube name with environment prefix.
-      #
-      # Delegates to Postburner::Configuration#expand_tube_name.
-      #
-      # @param queue_name [String] Base queue name
-      #
-      # @return [String] Full tube name (e.g., 'postburner.production.critical')
-      #
-      def expand_tube_name(queue_name)
-        config.expand_tube_name(queue_name)
-      end
-
-      # Executes a job from Beanstalkd.
-      #
-      # Delegates to Postburner::ActiveJob::Execution to handle default,
-      # tracked, and legacy job formats.
-      #
-      # @param beanstalk_job [Beaneater::Job] Job from Beanstalkd
-      #
-      # @return [void]
-      #
-      def execute_job(beanstalk_job)
-        logger.info "[Postburner] Executing #{beanstalk_job.class.name} #{beanstalk_job.id}"
-        Postburner::ActiveJob::Execution.execute(beanstalk_job.body)
-        logger.info "[Postburner] Deleting #{beanstalk_job.class.name} #{beanstalk_job.id} (success)"
-        beanstalk_job.delete
-      rescue => e
-        handle_error(beanstalk_job, e)
-      end
-
-      # Handles job execution errors with retry logic.
-      #
-      # Implements retry strategy:
-      # - Parses payload to determine job type
-      # - For default jobs: manages retry count, re-queues with backoff
-      # - For tracked jobs: buries job (Postburner::Job handles retries)
-      # - For legacy jobs: buries job
-      #
-      # @param beanstalk_job [Beaneater::Job] Job from Beanstalkd
-      # @param error [Exception] The exception that was raised
-      #
-      # @return [void]
-      #
-      def handle_error(beanstalk_job, error)
-        logger.error "[Postburner] Job failed: #{error.class} - #{error.message}"
-        logger.error error.backtrace.join("\n")
-
-        begin
-          payload = JSON.parse(beanstalk_job.body)
-
-          if payload['tracked'] || Postburner::ActiveJob::Payload.legacy_format?(payload)
-            # Tracked and legacy jobs: bury for inspection
-            # (Postburner::Job has its own retry logic)
-            logger.info "[Postburner] Burying tracked/legacy job for inspection"
-            beanstalk_job.bury
-          else
-            # Default job: handle retry logic
-            handle_default_retry(beanstalk_job, payload, error)
-          end
-        rescue => retry_error
-          logger.error "[Postburner] Error handling failure: #{retry_error.message}"
-          beanstalk_job.bury rescue nil
-        end
-      end
-
-      # Handles retry logic for default jobs.
-      #
-      # Checks ActiveJob's retry_on configuration, increments retry count,
-      # and re-queues with exponential backoff if retries remaining.
-      #
-      # @param beanstalk_job [Beaneater::Job] Job from Beanstalkd
-      # @param payload [Hash] Parsed job payload
-      # @param error [Exception] The exception that was raised
-      #
-      # @return [void]
-      #
-      def handle_default_retry(beanstalk_job, payload, error)
-        retry_count = payload['retry_count'] || 0
-        job_class = payload['job_class'].constantize
-
-        # Check if job class wants to retry this error
-        # (This is simplified - full implementation would check retry_on config)
-        max_retries = 5  # Default max retries
-
-        if retry_count < max_retries
-          # Increment retry count
-          payload['retry_count'] = retry_count + 1
-          payload['executions'] = (payload['executions'] || 0) + 1
-
-          # Calculate backoff delay (exponential: 1s, 2s, 4s, 8s, 16s...)
-          delay = calculate_backoff(retry_count)
-
-          # Delete old job and insert new one with updated payload
-          beanstalk_job.delete
-
-          Postburner.connected do |conn|
-            tube_name = expand_tube_name(payload['queue_name'])
-            conn.tubes[tube_name].put(
-              JSON.generate(payload),
-              pri: payload['priority'] || 0,
-              delay: delay,
-              ttr: 120
-            )
-          end
-
-          logger.info "[Postburner] Retrying default job #{payload['job_id']}, attempt #{retry_count + 1} in #{delay}s"
-        else
-          # Max retries exceeded
-          logger.error "[Postburner] Discarding default job #{payload['job_id']} after #{retry_count} retries"
-          beanstalk_job.delete
-          # TODO: Call after_discard callback if configured
-        end
-      end
-
-      # Calculates exponential backoff delay for retries.
-      #
-      # @param retry_count [Integer] Number of retries so far
-      #
-      # @return [Integer] Delay in seconds (capped at 1 hour)
-      #
-      def calculate_backoff(retry_count)
-        # Exponential backoff: 2^retry_count, capped at 3600 seconds (1 hour)
-        [2 ** retry_count, 3600].min
-      end
-
-      # Watches all configured queues in Beanstalkd.
-      #
-      # @param connection [Postburner::Connection] Beanstalkd connection
-      #
-      # @return [void]
-      #
-      def watch_queues(connection, queue_names=nil)
-        tube_names = queue_names.map { |q| config.expand_tube_name(q) }
-        tube_names = config.expanded_tube_names if tube_names.empty?
-        connection.beanstalk.tubes.watch!(*tube_names)
-      end
-    end
-  end
-end