Simplify the internal API, removing JobWrapper and InlineScheduler (#21)

.github/workflows/test.yml

@@ -16,7 +16,7 @@ jobs:
       # Dependencies
       - name: Install missing libs (This is slated to be added to the base image soon!)
         run: sudo apt-get -yqq install libpq-dev
-      - name: Setup Ruby
+      - name: Set up Ruby
         uses: ruby/setup-ruby@v1
       - name: Ruby gem cache
         uses: actions/cache@v1
@@ -64,7 +64,7 @@ jobs:
       # Dependencies
       - name: Install missing libs (This is slated to be added to the base image soon!)
         run: sudo apt-get -yqq install libpq-dev
-      - name: Setup Ruby
+      - name: Set up Ruby
         uses: ruby/setup-ruby@v1
       - name: Ruby gem cache
         uses: actions/cache@v1
@@ -81,7 +81,7 @@ jobs:
         run: bundle exec appraisal install --path $BUNDLE_PATH
       # /Dependencies
 
-      - name: Setup test database
+      - name: Set up test database
         run: |
           cd spec/dummy
           bin/rails db:test:prepare

.rspec

@@ -1,2 +1,3 @@
 --color
+--order random
 --require spec_helper

Gemfile.lock

@@ -78,6 +78,7 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
     builder (3.2.4)
+    coderay (1.1.2)
     concurrent-ruby (1.1.6)
     crass (1.0.6)
     database_cleaner (1.8.3)
@@ -125,6 +126,9 @@ GEM
     parser (2.7.0.4)
       ast (~> 2.4.0)
     pg (1.2.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     public_suffix (4.0.3)
     rack (2.2.2)
     rack-test (1.1.0)
@@ -216,6 +220,7 @@ DEPENDENCIES
   gem-release
   github_changelog_generator
   good_job!
+  pry
   rspec-rails
   rubocop
   rubocop-rspec

gemfiles/rails_5.1.gemfile.lock

@@ -10,7 +10,7 @@ GIT
 PATH
   remote: ..
   specs:
-    good_job (0.2.1)
+    good_job (0.2.2)
       concurrent-ruby (>= 1.0.2)
       pg (>= 1.0.0)
       rails (>= 5.1.0)
@@ -61,6 +61,7 @@ GEM
     arel (8.0.0)
     ast (2.4.0)
     builder (3.2.4)
+    coderay (1.1.2)
     concurrent-ruby (1.1.6)
     crass (1.0.6)
     database_cleaner (1.8.3)
@@ -104,7 +105,10 @@ GEM
     parallel (1.19.1)
     parser (2.7.0.4)
       ast (~> 2.4.0)
-    pg (1.2.2)
+    pg (1.2.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     public_suffix (4.0.3)
     rack (2.2.2)
     rack-test (1.1.0)
@@ -192,6 +196,7 @@ DEPENDENCIES
   gem-release
   github_changelog_generator
   good_job!
+  pry
   rails (~> 5.1.0)
   rspec-rails
   rubocop

gemfiles/rails_5.2.gemfile.lock

@@ -10,7 +10,7 @@ GIT
 PATH
   remote: ..
   specs:
-    good_job (0.2.1)
+    good_job (0.2.2)
       concurrent-ruby (>= 1.0.2)
       pg (>= 1.0.0)
       rails (>= 5.1.0)
@@ -65,6 +65,7 @@ GEM
     arel (9.0.0)
     ast (2.4.0)
     builder (3.2.4)
+    coderay (1.1.2)
     concurrent-ruby (1.1.6)
     crass (1.0.6)
     database_cleaner (1.8.3)
@@ -111,7 +112,10 @@ GEM
     parallel (1.19.1)
     parser (2.7.0.4)
       ast (~> 2.4.0)
-    pg (1.2.2)
+    pg (1.2.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     public_suffix (4.0.3)
     rack (2.2.2)
     rack-test (1.1.0)
@@ -200,6 +204,7 @@ DEPENDENCIES
   gem-release
   github_changelog_generator
   good_job!
+  pry
   rails (~> 5.2.0)
   rspec-rails
   rubocop

gemfiles/rails_6.0.gemfile.lock

@@ -10,7 +10,7 @@ GIT
 PATH
   remote: ..
   specs:
-    good_job (0.2.1)
+    good_job (0.2.2)
       concurrent-ruby (>= 1.0.2)
       pg (>= 1.0.0)
       rails (>= 5.1.0)
@@ -78,6 +78,7 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
     builder (3.2.4)
+    coderay (1.1.2)
     concurrent-ruby (1.1.6)
     crass (1.0.6)
     database_cleaner (1.8.3)
@@ -124,7 +125,10 @@ GEM
     parallel (1.19.1)
     parser (2.7.0.4)
       ast (~> 2.4.0)
-    pg (1.2.2)
+    pg (1.2.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     public_suffix (4.0.3)
     rack (2.2.2)
     rack-test (1.1.0)
@@ -216,6 +220,7 @@ DEPENDENCIES
   gem-release
   github_changelog_generator
   good_job!
+  pry
   rails (~> 6.0.0)
   rspec-rails
   rubocop

good_job.gemspec

@@ -46,6 +46,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "database_cleaner"
   spec.add_development_dependency "gem-release"
   spec.add_development_dependency "github_changelog_generator"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "rspec-rails"
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "rubocop-rspec"

lib/good_job.rb

@@ -4,10 +4,9 @@
 require 'good_job/logging'
 require 'good_job/lockable'
 require 'good_job/job'
-require 'good_job/inline_scheduler'
 require "good_job/scheduler"
-require "good_job/job_wrapper"
 require 'good_job/adapter'
+require 'good_job/pg_locks'
 
 module GoodJob
   include Logging

lib/good_job/adapter.rb

@@ -1,41 +1,36 @@
 module GoodJob
   class Adapter
-    def initialize(options = {})
-      @options = options
-      @scheduler = InlineScheduler.new if inline?
+    def initialize(inline: false)
+      @inline = inline
     end
 
-    def enqueue(job)
-      enqueue_at(job, nil)
+    def enqueue(active_job)
+      enqueue_at(active_job, nil)
     end
 
-    def enqueue_at(job, timestamp)
-      params = {
-        queue_name: job.queue_name,
-        priority: job.priority,
-        serialized_params: job.serialize,
-      }
-      params[:scheduled_at] = Time.at(timestamp) if timestamp
+    def enqueue_at(active_job, timestamp)
+      good_job = GoodJob::Job.enqueue(
+        active_job,
+        scheduled_at: timestamp ? Time.at(timestamp) : nil,
+        create_with_advisory_lock: inline?
+      )
 
-      good_job = GoodJob::Job.create(params)
-      job.provider_job_id = good_job.id
-
-      GoodJob.tag_logger do
-        ActiveSupport::Notifications.instrument("create.good_job", { good_job: good_job, job: job })
-        @scheduler.enqueue(good_job) if inline?
+      if inline?
+        good_job.perform
+        good_job.advisory_unlock
       end
 
       good_job
     end
 
-    def shutdown(wait: true)
-      @scheduler&.shutdown(wait: wait)
+    def shutdown(wait: true) # rubocop:disable Lint/UnusedMethodArgument
+      nil
     end
 
     private
 
     def inline?
-      @options.fetch(:inline, false)
+      @inline
     end
   end
 end

lib/good_job/job.rb

@@ -1,6 +1,39 @@
 module GoodJob
   class Job < ActiveRecord::Base
     include Lockable
+
     self.table_name = 'good_jobs'
+
+    def self.enqueue(active_job, scheduled_at: nil, create_with_advisory_lock: false)
+      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,
+          serialized_params: active_job.serialize,
+          scheduled_at: scheduled_at,
+          create_with_advisory_lock: create_with_advisory_lock
+        )
+
+        instrument_payload[:good_job] = good_job
+
+        good_job.save!
+        active_job.provider_job_id = good_job.id
+      end
+
+      good_job
+    end
+
+    def perform
+      ActiveSupport::Notifications.instrument("before_perform_job.good_job", { good_job: self })
+      ActiveSupport::Notifications.instrument("perform_job.good_job", { good_job: self }) do
+        params = serialized_params.merge(
+          "provider_job_id" => id
+        )
+        ActiveJob::Base.execute(params)
+
+        destroy!
+      end
+    end
   end
 end