riverqueue 0.12.0 → 0.13.0

data/sig/client.rbs

@@ -1,5 +1,6 @@
 module River
   MAX_ATTEMPTS_DEFAULT: Integer
+  MAX_ATTEMPTS_LIMIT: Integer
   PRIORITY_DEFAULT: Integer
   QUEUE_DEFAULT: String
 
@@ -20,7 +21,7 @@ module River
     def id: () -> String
     def insert: (jobArgs, ?insert_opts: InsertOpts?, ?max_attempts: Integer?,
       ?metadata: Hash[String | Symbol, untyped]?, ?priority: Integer?, ?queue: (String | Symbol)?,
-      ?scheduled_at: Time?, ?state: jobStateInput?, ?tags: Array[String]?, ?unique_opts: UniqueOpts?) -> JobInsertResult
+      ?scheduled_at: Time?, ?state: jobStateInitialInput?, ?tags: Array[String]?, ?unique_opts: UniqueOpts?) -> JobInsertResult
     def insert_many: (Array[jobArgs | InsertManyParams]) -> Array[JobInsertResult]
     def job_cancel: (Integer) -> JobRow
     def job_delete: (Integer) -> JobRow
@@ -54,6 +55,7 @@ module River
 
     DEFAULT_UNIQUE_STATES: Array[jobStateAll]
     EMPTY_INSERT_OPTS: InsertOpts
+    INITIAL_STATES: Array[jobStateInitial]
     REQUIRED_UNIQUE_STATES: Array[jobStateAll]
     TAG_RE: Regexp
 
@@ -63,6 +65,7 @@ module River
     private def run_insert_plugins: (Array[Driver::JobInsertParams]) { () -> Array[JobInsertResult] } -> Array[JobInsertResult]
     private def truncate_time: (Time, Integer | Rational) -> Time
     private def uint64_to_int64: (Integer) -> Integer
+    private def validate_insert_state: (String | Symbol) -> jobStateInitial
     private def validate_tags: (Array[String]) -> Array[String]
     private def validate_unique_states: (Array[jobStateInput]) -> Array[jobStateAll]
   end
@@ -76,7 +79,7 @@ module River
 
     def initialize: (jobArgs job, ?insert_opts: InsertOpts?, ?max_attempts: Integer?,
       ?metadata: Hash[String | Symbol, untyped]?, ?priority: Integer?, ?queue: (String | Symbol)?,
-      ?scheduled_at: Time?, ?state: jobStateInput?, ?tags: Array[String]?, ?unique_opts: UniqueOpts?) -> void
+      ?scheduled_at: Time?, ?state: jobStateInitialInput?, ?tags: Array[String]?, ?unique_opts: UniqueOpts?) -> void
     def is_a?: (Class) -> bool
   end
 

data/sig/driver.rbs

@@ -8,7 +8,7 @@ module River
     def job_cancel: (Integer, ?now: Time) -> JobRow?
     def job_delete: (Integer) -> JobRow?
     def job_delete_finalized: (**untyped) -> Integer
-    def job_delete_if_running: (Integer) -> bool
+    def job_delete_if_running: (Integer) -> (bool | :cancelled)
     def job_delete_many: (JobListParams) -> Array[JobRow]
     def job_get_available: (queue: String, max: Integer, attempted_by: String, ?kinds: Array[String]?, ?now: Time) -> Array[JobRow]
     def job_claim: (id: Integer, attempted_by: String, ?allow_scheduled: bool, ?now: Time) -> JobRow?
@@ -29,8 +29,8 @@ module River
     def notification_delete_before: (horizon: Time, ?max: Integer) -> Integer
     def queue_get: (String) -> Queue?
     def queue_list: (?max: Integer) -> Array[Queue]
-    def queue_pause: (String, ?now: Time) -> untyped
-    def queue_resume: (String, ?now: Time) -> untyped
+    def queue_pause: (String, ?now: Time) -> Array[Queue]
+    def queue_resume: (String, ?now: Time) -> Array[Queue]
     def queue_update: (String, metadata: Hash[untyped, untyped], ?now: Time) -> Queue?
     def queue_upsert: (String, ?metadata: Hash[untyped, untyped], ?now: Time) -> Queue?
     def transaction: [T] () { () -> T } -> T
@@ -117,7 +117,7 @@ module River
       private def runtime_claim_jobs: (untyped, untyped, untyped, untyped) -> untyped
       def job_list: (?untyped) -> untyped
       def job_metadata_merge: (untyped, untyped) -> untyped
-      def job_rescue_stuck: (horizon: untyped, retry_policy: untyped, ?now: untyped, ?max: untyped) -> untyped
+      def job_rescue_stuck: (horizon: untyped, retry_policy: untyped, ?now: untyped, ?max: untyped, ?logger: untyped, ?rescue_if: untyped) -> untyped
       def job_retry: (untyped, ?now: untyped) -> untyped
       def job_schedule: (?now: untyped, ?max: untyped) -> untyped
       def job_set_state_if_running: (id: untyped, state: untyped, ?now: untyped, ?attempt: untyped, ?error: untyped, ?finalized_at: untyped, ?metadata: untyped, ?scheduled_at: untyped) -> untyped
@@ -143,6 +143,7 @@ module River
       def runtime_execute: (String) -> untyped
       def runtime_in_clause: (untyped, untyped) -> untyped
       def runtime_job_list_without_params: () -> untyped
+      def runtime_job_list: (JobListParams, ?for_delete: bool) -> Array[JobRow]
       def runtime_job_rows: (String) -> untyped
       def runtime_json: (untyped) -> untyped
       def runtime_merge_metadata: (untyped) -> untyped
@@ -157,6 +158,7 @@ module River
       def runtime_queue_columns: () -> untyped
       def runtime_queue_from_row: (untyped) -> untyped
       def runtime_quote: (untyped) -> String
+      def runtime_rescue_retry: (untyped, untyped, untyped, untyped, untyped) -> Time
       def runtime_returning_ids: (untyped) -> untyped
       def runtime_state: (untyped) -> untyped
       def runtime_tag_contains: (untyped) -> untyped

data/sig/insert_opts.rbs

@@ -5,11 +5,11 @@ module River
     attr_accessor priority: Integer?
     attr_accessor queue: (String | Symbol)?
     attr_accessor scheduled_at: Time?
-    attr_accessor state: jobStateInput?
+    attr_accessor state: jobStateInitialInput?
     attr_accessor tags: Array[String]?
     attr_accessor unique_opts: UniqueOpts?
 
-    def initialize: (?max_attempts: Integer?, ?metadata: Hash[String | Symbol, untyped]?, ?priority: Integer?, ?queue: (String | Symbol)?, ?scheduled_at: Time?, ?state: jobStateInput?, ?tags: Array[String]?, ?unique_opts: UniqueOpts?) -> void
+    def initialize: (?max_attempts: Integer?, ?metadata: Hash[String | Symbol, untyped]?, ?priority: Integer?, ?queue: (String | Symbol)?, ?scheduled_at: Time?, ?state: jobStateInitialInput?, ?tags: Array[String]?, ?unique_opts: UniqueOpts?) -> void
   end
 
   class UniqueOpts

data/sig/job.rbs

@@ -9,6 +9,8 @@ module River
   JOB_STATE_SCHEDULED: "scheduled"
 
   type jobStateAll = "available" | "cancelled" | "completed" | "discarded" | "pending" | "retryable" | "running" | "scheduled"
+  type jobStateInitial = "available" | "pending" | "scheduled"
+  type jobStateInitialInput = jobStateInitial | :available | :pending | :scheduled
   type jobStateInput = jobStateAll | :available | :cancelled | :completed | :discarded | :pending | :retryable | :running | :scheduled
 
   interface _JobArgs

data/sig/runtime.rbs

@@ -288,8 +288,11 @@ module River
 
   class PeriodicCron
     @cron: untyped
+    @interval: Integer?
     def initialize: (String, ?timezone: String) -> void
     def next: (Time) -> Time
+    private
+    def parse_interval: (String) -> Integer
   end
 
   class PeriodicInterval
@@ -299,15 +302,17 @@ module River
   end
 
   class PeriodicJobBundle
+    @enabled: bool
     @jobs: Hash[Integer, untyped]
     @mutex: Mutex
     @next_handle: Integer
     @wake: untyped
-    def initialize: (Array[PeriodicJob], wake: untyped) -> void
+    def initialize: (Array[PeriodicJob], wake: untyped, ?enabled: bool) -> void
     def add: (PeriodicJob) -> Integer
     def add_many: (Array[PeriodicJob]) -> Array[Integer]
     def clear: () -> self
     def due: (Time) ?{ (PeriodicJob, StandardError) -> void } -> Array[PeriodicJob]
+    def empty?: () -> bool
     def remove: (Integer) -> PeriodicJob?
     def remove_by_id: (untyped) -> bool
   end
@@ -316,6 +321,15 @@ module River
     class Interrupted < StandardError
     end
 
+    class JobTiming
+      attr_accessor finished_monotonic: Float
+      attr_reader queue_wait_duration: Float
+      attr_reader started_at: Time
+      attr_reader started_monotonic: Float
+
+      def initialize: (Time, Float, Time) -> void
+    end
+
     @client: Client
     @condition: ConditionVariable
     @config: Config
@@ -356,8 +370,9 @@ module River
     def check_remote_cancellations: (String) -> untyped
     def error_handler_cancel?: (Exception, Job) -> bool
     def execute: (JobRow) -> untyped
-    def finish_failed: (JobRow, Job, Exception, Time, ?cancelled: bool, ?worker: untyped) -> untyped
-    def finish_snoozed: (JobRow, Job, JobSnoozeError, Time) -> untyped
+    def finish_failed: (JobRow, Job, Exception, JobTiming, ?cancelled: bool, ?worker: untyped) -> untyped
+    def finish_interrupted: (JobRow, Job, JobTiming) -> untyped
+    def finish_snoozed: (JobRow, Job, JobSnoozeError, JobTiming) -> untyped
     def finish_work: (Integer) -> untyped
     def invoke_plugins: (Symbol, *untyped) -> Array[untyped]
     def invoke_worker: (untyped, Job) -> untyped
@@ -365,12 +380,15 @@ module River
     def maintenance_loop: () -> untyped
     def monotonic_now: () -> Float
     def next_retry: (JobRow, Exception, Time, ?worker: untyped) -> Time
+    def next_snooze_count: (untyped) -> Integer
     def retry_allowed?: (untyped, Job, Exception) -> untyped
     def perform_work: (untyped, Job) -> untyped
+    def periodic_jobs_changed: () -> untyped
     def producer_loop: (String, QueueConfig) -> untyped
-    def publish: (Symbol, JobRow, Time) -> untyped
+    def publish: (Symbol, JobRow, JobTiming) -> untyped
     def queue_stopping?: (String) -> bool
     def remove_subscription: (Subscription) -> Subscription?
+    def rescue_job?: (JobRow, Time) -> bool
     def resolve_worker: (String) -> untyped
     def run_periodic: (Time) -> untyped
     def running_count: (String) -> Integer
@@ -378,5 +396,7 @@ module River
     def start_producer: (String, QueueConfig) -> untyped
     def stopping?: () -> bool
     def wait: (Float | Integer) -> untyped
+    def wait_for_running_jobs: (String, Float | Integer) -> untyped
+    def worker_timeout: (untyped, Job) -> Float?
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riverqueue
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Blake Gentry
@@ -100,7 +100,9 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE
+- README.md
 - docs/README.md
+- docs/conformance.md
 - docs/migrations.md
 - docs/testing.md
 - docs/workers.md
@@ -183,10 +185,10 @@ homepage: https://riverqueue.com
 licenses:
 - MPL-2.0
 metadata:
-  bug_tracker_uri: https://github.com/riverqueue/riverqueue-ruby/issues
-  changelog_uri: https://github.com/riverqueue/riverqueue-ruby/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/riverqueue/river/issues
+  changelog_uri: https://github.com/riverqueue/river/blob/master/ruby/CHANGELOG.md
   rubygems_mfa_required: 'true'
-  source_code_uri: https://github.com/riverqueue/riverqueue-ruby
+  source_code_uri: https://github.com/riverqueue/river/tree/master/ruby
 rdoc_options: []
 require_paths:
 - lib