good_job 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c20439024a46084c22e46bb42e38589687c2ab2cea47d90705abc4fa042ad449
-  data.tar.gz: e5ea8e7fa607a10fd936c62623a39d32b891ef629636e0b04fb3d36aa7ab1f3f
+  metadata.gz: 4f7dda29494df3fc05a199d6bf0efbc825a47653c3af507a0d1ceb92456d4307
+  data.tar.gz: 881ad046bab6b17c5d532d035fddef54420639288a0a4bd8f4f07b980c1fa239
 SHA512:
-  metadata.gz: 4af34ce400c409a61892c9d35693f69e023b5dbd3d54cacfd6d9b044aaf481c616e3fdb9da53470f79919830a916a08f67550ce807eda1c59a43fa1da4092f07
-  data.tar.gz: 81304be6bc9e6925b16fa030d2031377bd90bac894b4c8792cfe5e02ff81677bf04d476b1a3435e951a804e6d284e4d8aa7452c6090969f841dbd6e59a9c301c
+  metadata.gz: c0cfc3c4d61666844a6bd7c532670e0b1be40fd6f805eff63919d3600d06933b8029f0febbc81efbf52b1f3d459317caeb522affe20dde9d3f4d7672622fd708
+  data.tar.gz: c4c9a9fddb2108769e3672baeaeaca2f7c966ee708f95867ed57970e688debcf1ce41a3eacd65d88c0192700f1b293cd4a9ad63fee9e4af93d44934b0876120f

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [v0.7.0](https://github.com/bensheldon/good_job/tree/v0.7.0) (2020-07-15)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v0.6.0...v0.7.0)
+
+**Closed issues:**
+
+- Always store a default priority \(0\) and scheduled\_at\(Time.current\) [\#30](https://github.com/bensheldon/good_job/issues/30)
+
+**Merged pull requests:**
+
+- Add more examples to Readme [\#39](https://github.com/bensheldon/good_job/pull/39) ([bensheldon](https://github.com/bensheldon))
+- Add additional Rubocops and lint [\#38](https://github.com/bensheldon/good_job/pull/38) ([bensheldon](https://github.com/bensheldon))
+- Always store a default queue\_name, priority and scheduled\_at; index by queue\_name and scheduled\_at [\#37](https://github.com/bensheldon/good_job/pull/37) ([bensheldon](https://github.com/bensheldon))
+
 ## [v0.6.0](https://github.com/bensheldon/good_job/tree/v0.6.0) (2020-07-15)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v0.5.0...v0.6.0)

data/README.md

@@ -7,7 +7,15 @@ Inspired by [Delayed::Job](https://github.com/collectiveidea/delayed_job) and [Q
 - Stand on the shoulders of ActiveJob. For example, [exception](https://edgeguides.rubyonrails.org/active_job_basics.html#exceptions) and [retry](https://edgeguides.rubyonrails.org/active_job_basics.html#retrying-or-discarding-failed-jobs) behavior. 
 - Stand on the shoulders of Ruby on Rails. For example, ActiveRecord ORM, connection pools, and [multithreaded support](https://guides.rubyonrails.org/threading_and_code_execution.html) with [Concurrent-Ruby](https://github.com/ruby-concurrency/concurrent-ruby).
 - Stand on the shoulders of Postgres. For example, Advisory Locks.
-- Convention over simplicity over performance. 
+- Convention over simplicity over performance.
+
+GoodJob supports all ActiveJob functionality:
+- Async. GoodJob has the ability to run the job in a non-blocking manner.
+- Queues. Jobs may set which queue they are run in with queue_as or by using the set method.
+- Delayed. GoodJob will run the job in the future through perform_later.
+- Priorities. The order in which jobs are processed can be configured differently.
+- Timeouts. GoodJob defers to ActiveJob where it can be implemented as an `around` hook. See [Taking advantage of ActiveJob](#taking-advantage-of-activejob).
+- Retries. GoodJob will automatically retry uncompleted jobs immediately. See [Taking advantage of ActiveJob](#taking-advantage-of-activejob).
 
 ## Installation
 
@@ -43,6 +51,9 @@ $ bundle install
           t.integer :priority
           t.jsonb :serialized_params
           t.timestamp :scheduled_at
+   
+          t.index :scheduled_at
+          t.index [:queue_name, :scheduled_at]
         end
       end
     end
@@ -73,6 +84,11 @@ $ bundle install
     config.active_job.queue_adapter = GoodJob::Adapter.new
     ```
 
+1. Queue your job 🎉: 
+    ```ruby
+    YourJob.set(queue: :some_queue, wait: 5.minutes, priority: 10).perform_later
+    ```
+
 1. In production, the scheduler is designed to run in its own process:
     ```bash
     $ bundle exec good_job
@@ -90,6 +106,25 @@ $ bundle install
    #   [--queues=queue1,queue2]  # Queues to work from. Separate multiple queues with commas (default: *)
    #   [--poll-interval=N]       # Interval between polls for available jobs in seconds (default: 1)
    ```
+
+### Taking advantage of ActiveJob
+
+ActiveJob has a rich set of built-in functionality for timeouts, error handling, and retrying. For example:
+
+```ruby
+class ApplicationJob < ActiveJob::Base  
+  # Retry errors an infinite number of times with exponential back-off
+  retry_on StandardError, wait: :exponentially_longer, attempts: Float::INFINITY
+
+  # Timeout jobs after 10 minutes
+  JobTimeoutError = Class.new(StandardError)
+  around_perform do |_job, block|
+    Timeout.timeout(10.minutes, JobTimeoutError) do
+      block.call
+    end
+  end
+end
+```
    
 ### Configuring Job Execution Threads
     

data/lib/good_job/adapter.rb

@@ -11,7 +11,7 @@ module GoodJob
     def enqueue_at(active_job, timestamp)
       good_job = GoodJob::Job.enqueue(
         active_job,
-        scheduled_at: timestamp ? Time.at(timestamp) : nil,
+        scheduled_at: timestamp ? Time.zone.at(timestamp) : nil,
         create_with_advisory_lock: inline?
       )
 

data/lib/good_job/job.rb

@@ -2,9 +2,12 @@ module GoodJob
   class Job < ActiveRecord::Base
     include Lockable
 
-    self.table_name = 'good_jobs'
+    DEFAULT_QUEUE_NAME = 'default'.freeze
+    DEFAULT_PRIORITY = 0
 
-    scope :only_scheduled, -> { where("scheduled_at < ?", Time.current).or(where(scheduled_at: nil)) }
+    self.table_name = 'good_jobs'.freeze
+
+    scope :only_scheduled, -> { where(arel_table['scheduled_at'].lteq(Time.current)).or(where(scheduled_at: nil)) }
     scope :priority_ordered, -> { order(priority: :desc) }
     scope :to_performer, -> { Performer.new(self) }
 
@@ -31,10 +34,10 @@ module GoodJob
       good_job = nil
       ActiveSupport::Notifications.instrument("enqueue_job.good_job", { active_job: active_job, scheduled_at: scheduled_at, create_with_advisory_lock: create_with_advisory_lock }) do |instrument_payload|
         good_job = GoodJob::Job.new(
-          queue_name: active_job.queue_name,
-          priority: active_job.priority,
+          queue_name: active_job.queue_name.presence || DEFAULT_QUEUE_NAME,
+          priority: active_job.priority || DEFAULT_PRIORITY,
           serialized_params: active_job.serialize,
-          scheduled_at: scheduled_at,
+          scheduled_at: scheduled_at || Time.current,
           create_with_advisory_lock: create_with_advisory_lock
         )
 

data/lib/good_job/lockable.rb

@@ -37,14 +37,17 @@ module GoodJob
       scope :owns_advisory_locked, -> { joins_advisory_locks.where('"pg_locks"."pid" = pg_backend_pid()') }
 
       attr_accessor :create_with_advisory_lock
+
       after_create -> { advisory_lock }, if: :create_with_advisory_lock
     end
 
     class_methods do
-      def with_advisory_lock(&block)
+      def with_advisory_lock
+        raise ArgumentError, "Must provide a block" unless block_given?
+
         records = advisory_lock.to_a
         begin
-          block.call(records)
+          yield(records)
         ensure
           records.each(&:advisory_unlock)
         end
@@ -73,6 +76,8 @@ module GoodJob
     end
 
     def with_advisory_lock
+      raise ArgumentError, "Must provide a block" unless block_given?
+
       advisory_lock!
       yield
     ensure

data/lib/good_job/version.rb

@@ -1,3 +1,3 @@
 module GoodJob
-  VERSION = '0.6.0'.freeze
+  VERSION = '0.7.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2020-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -178,6 +178,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement