delayed 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f8eca1f909db97f82a2fb9ed83dee300ea519195049ab4e9f8794f9130fb5e4
-  data.tar.gz: 474984bd47db31e8078cac58bdcb60562d0585f8ecf7bb90817ef07e563a57c8
+  metadata.gz: 02d090c8d335114c2ca9d46a6aee12025dba8e78e13351619e7712ee49a6df98
+  data.tar.gz: 9e9cc9e3e41209de66c2dac1adfe62a6b4fb7ed243220d16fd39beb1da11a6a8
 SHA512:
-  metadata.gz: fee0bfeeeae138673d1f461a0f47a17a47f3cadff27330c206b5a18275649a40ffc5cb16254984e1bbb45b89958d090e36e68a2ad6cfd408bab52977c7d1c872
-  data.tar.gz: 3f3274f7248448f399892582b059b21f590b9cc5c8bf01babee2f6b0558f7451f375e92ad04811b01d15db61bbb5d0ee0748a22e5dcefcc1eff81eaff75a8e8c
+  metadata.gz: 9515b3eea5aa30a6745458f50bc843e4857b77e7ec73576e2acca8562a21fd14e80293f4b4278aa566a837b2b33166e92239a6904df6d60c2d42a77416362aad
+  data.tar.gz: e32e446db1d012a252d93dce7ca31318c1877c700085892a0071a88a54418fa78ad44b764c757ded8d9a157a09b7b7249679e6d5728fcf5deeec45370f881361

data/README.md

@@ -76,10 +76,15 @@ Before you can enqueue and run jobs, you will need a jobs table. You can create
 running the following command:
 
 ```bash
-rails generate delayed:migration
+rake delayed:install:migrations
 rails db:migrate
 ```
 
+This will produce a series of migrations ready to be run in sequence.
+(Re-running the command should be safe and will **not** duplicate previous
+migrations, but if you have an existing `delayed_jobs` table, you may need to
+adjust the generated migrations to avoid conflicts.)
+
 Then, to use this background job processor with ActiveJob, add the following to your application config:
 
 ```ruby
@@ -535,7 +540,7 @@ class OrderPurchaseJob < ApplicationJob
 end
 ```
 
-#### Migrating from DelayedJob
+## Migrating from DelayedJob
 
 If you choose to use `delayed` in an app that was originally written against `delayed_job`, several
 non-ActiveJob APIs are still available. These include "plugins", lifecycle hooks, and the `.delay`
@@ -558,6 +563,21 @@ Delayed::Worker.destroy_failed_jobs = true # WARNING: This will irreversably del
 Note that some configurations, like `queue_attributes`, `exit_on_complete`, `backend`, and
 `raise_signal_exceptions` have been removed entirely.
 
+Furthermore, there are optional schema migrations that you may wish to apply, to take advantage of
+new behaviors that are unique to `delayed`:
+
+```bash
+rake delayed:install:migrations
+rails db:migrate
+```
+
+As of writing, this will add the following:
+- `delayed_jobs.name`: a string representation of the job's performable class name, populated on
+  enqueue.
+
+Note: Schema changes may become non-optional in future `delayed` releases, and will be documented in
+the README and release notes.
+
 ## How to Contribute
 
 We would love for you to contribute! Anything that benefits the majority of users—from a

data/app/models/delayed/job.rb

@@ -15,7 +15,7 @@ module Delayed
     scope :workable, ->(timestamp) { not_locked.not_failed.where("run_at <= ?", timestamp) }
     scope :working, -> { locked.not_failed }
 
-    before_save :set_default_run_at
+    before_save :set_default_run_at, :set_name
 
     REENQUEUE_BUFFER = 30.seconds
 
@@ -252,5 +252,12 @@ module Delayed
     def attempts_alert?
       alert_attempts&.<= attempts
     end
+
+    private
+
+    def set_name
+      # [feat:NameColumn] remove 'if' statement once the 'name' column is required.
+      self.name ||= display_name if respond_to?(:name=)
+    end
   end
 end

data/{lib/generators/delayed/templates/migration.rb → db/migrate/1_create_delayed_jobs.rb}

@@ -1,4 +1,4 @@
-class CreateDelayedJobs < ActiveRecord::Migration<%= migration_version %>
+class CreateDelayedJobs < ActiveRecord::Migration[6.0]
   def self.up
     create_table :delayed_jobs do |table|
       table.integer :priority, default: 0, null: false # Allows some jobs to jump to the front of the queue

data/db/migrate/2_add_name_to_delayed_jobs.rb

@@ -0,0 +1,5 @@
+class AddNameToDelayedJobs < ActiveRecord::Migration[6.0]
+  def change
+    add_column :delayed_jobs, :name, :string, null: true
+  end
+end

data/db/migrate/3_add_index_to_delayed_jobs_name.rb

@@ -0,0 +1,11 @@
+class AddIndexToDelayedJobsName < ActiveRecord::Migration[6.0]
+  disable_ddl_transaction!
+
+  def change
+    if connection.adapter_name == 'PostgreSQL'
+      add_index :delayed_jobs, :name, algorithm: :concurrently
+    else
+      add_index :delayed_jobs, :name
+    end
+  end
+end

data/lib/delayed/backend/base.rb

@@ -57,12 +57,12 @@ module Delayed
 
       ParseObjectFromYaml = %r{!ruby/\w+:([^\s]+)} # rubocop:disable Naming/ConstantName
 
-      def name # rubocop:disable Metrics/AbcSize
-        @name ||= payload_object.job_data['job_class'] if payload_object.respond_to?(:job_data)
-        @name ||= payload_object.display_name if payload_object.respond_to?(:display_name)
-        @name ||= payload_object.class.name
-      rescue DeserializationError
-        ParseObjectFromYaml.match(handler)[1]
+      def name
+        if self.class.column_names.include?('name')
+          super || display_name
+        else
+          display_name # [feat:NameColumn] remove fallback once the "name" column is required.
+        end
       end
 
       def priority
@@ -151,6 +151,18 @@ module Delayed
         save!
       end
 
+      private
+
+      def display_name # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
+        @display_name ||= payload_object.job_data['job_class'] if payload_object.respond_to?(:job_data)
+        @display_name ||= payload_object.display_name if payload_object.respond_to?(:display_name)
+        @display_name ||= payload_object.class.name
+      rescue DeserializationError # [feat:NameColumn] remove this `rescue` once the "name" column is required.
+        raise if !persisted? && self.class.column_names.include?('name')
+
+        ParseObjectFromYaml.match(handler)[1]
+      end
+
       protected
 
       def set_default_run_at

data/lib/delayed/engine.rb

@@ -1,5 +1,7 @@
 module Delayed
   class Engine < Rails::Engine
+    engine_name 'delayed'
+
     rake_tasks do
       load 'delayed/tasks.rb'
     end

data/lib/delayed/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Delayed
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/spec/delayed/job_spec.rb

@@ -253,29 +253,114 @@ describe Delayed::Job do
   end
 
   describe '#name' do
-    it 'is the class name of the job that was enqueued' do
-      expect(described_class.create(payload_object: ErrorJob.new).name).to eq('ErrorJob')
-    end
+    context 'when name column is populated' do
+      it 'is the class name of the job that was enqueued' do
+        job = described_class.new(payload_object: ErrorJob.new)
+        expect(job.name).to eq('ErrorJob')
+        job.save!
+        expect(job.reload.name).to eq('ErrorJob')
+      end
 
-    it 'is the class name of the performable job if it is an ActiveJob' do
-      job_wrapper = ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper.new(ActiveJobJob.new.serialize)
-      expect(described_class.create(payload_object: job_wrapper).name).to eq('ActiveJobJob')
-    end
+      it 'is the class name of the performable job if it is an ActiveJob' do
+        job_wrapper = ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper.new(ActiveJobJob.new.serialize)
+        job = described_class.new(payload_object: job_wrapper)
+        expect(job.name).to eq('ActiveJobJob')
+        job.save!
+        expect(job.reload.name).to eq('ActiveJobJob')
+      end
+
+      it 'is the returned display_name if display_name is defined on the job object' do
+        job = described_class.new(payload_object: NamedJob.new)
+        expect(job.name).to eq('named_job')
+        job.save!
+        expect(job.reload.name).to eq('named_job')
+      end
+
+      it 'is the instance method that will be called if its a performable method object' do
+        job = Story.create(text: '...').delay.save
+        expect(job.name).to eq('Story#save')
+      end
 
-    it 'is the method that will be called if its a performable method object' do
-      job = described_class.new(payload_object: NamedJob.new)
-      expect(job.name).to eq('named_job')
+      it 'is the custom name value when set explicitly' do
+        job = described_class.new(payload_object: ErrorJob.new)
+        job.name = 'Custom Name'
+        job.save!
+        expect(job.reload.name).to eq('Custom Name')
+      end
     end
 
-    it 'is the instance method that will be called if its a performable method object' do
-      job = Story.create(text: '...').delay.save
-      expect(job.name).to eq('Story#save')
+    context 'when name column is NULL' do
+      it 'is the class name of the job that was enqueued' do
+        job = described_class.create(payload_object: ErrorJob.new)
+        job.update_column(:name, nil) # rubocop:disable Rails/SkipsModelValidations
+        expect(job.reload.name).to eq('ErrorJob')
+      end
+
+      it 'is the class name of the performable job if it is an ActiveJob' do
+        job_wrapper = ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper.new(ActiveJobJob.new.serialize)
+        job = described_class.create(payload_object: job_wrapper)
+        job.update_column(:name, nil) # rubocop:disable Rails/SkipsModelValidations
+        expect(job.reload.name).to eq('ActiveJobJob')
+      end
+
+      it 'parses from handler on deserialization error' do
+        job = Story.create(text: '...').delay.text
+        job.payload_object.object.destroy
+        job.save!
+        job.update_column(:name, nil) # rubocop:disable Rails/SkipsModelValidations
+        expect(job.reload.name).to eq('Delayed::PerformableMethod')
+      end
     end
 
-    it 'parses from handler on deserialization error' do
-      job = Story.create(text: '...').delay.text
-      job.payload_object.object.destroy
-      expect(job.reload.name).to eq('Delayed::PerformableMethod')
+    context 'when name column does not exist' do
+      before do
+        ActiveRecord::Schema.define do
+          AddIndexToDelayedJobsName.migrate(:down)
+          AddNameToDelayedJobs.migrate(:down)
+        end
+        described_class.reset_column_information
+      end
+
+      after do
+        ActiveRecord::Schema.define do
+          AddNameToDelayedJobs.migrate(:up)
+          AddIndexToDelayedJobsName.migrate(:up)
+        end
+        described_class.reset_column_information
+      end
+
+      it 'is the class name of the job that was enqueued' do
+        job = described_class.new(payload_object: ErrorJob.new)
+        expect(job.name).to eq('ErrorJob')
+        job.save!
+        expect(job.reload.name).to eq('ErrorJob')
+      end
+
+      it 'is the class name of the performable job if it is an ActiveJob' do
+        job_wrapper = ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper.new(ActiveJobJob.new.serialize)
+        job = described_class.new(payload_object: job_wrapper)
+        expect(job.name).to eq('ActiveJobJob')
+        job.save!
+        expect(job.reload.name).to eq('ActiveJobJob')
+      end
+
+      it 'is the returned display_name if display_name is defined on the job object' do
+        job = described_class.new(payload_object: NamedJob.new)
+        expect(job.name).to eq('named_job')
+        job.save!
+        expect(job.reload.name).to eq('named_job')
+      end
+
+      it 'is the instance method that will be called if its a performable method object' do
+        job = Story.create(text: '...').delay.save
+        expect(job.name).to eq('Story#save')
+      end
+
+      it 'parses from handler on deserialization error' do
+        job = Story.create(text: '...').delay.text
+        job.payload_object.object.destroy
+        expect(job.reload.name).to eq('Delayed::PerformableMethod')
+      end
     end
   end
 
@@ -542,7 +627,8 @@ describe Delayed::Job do
 
       context 'when the job raises a deserialization error' do
         it 'marks the job as failed' do
-          job = described_class.create! handler: '--- !ruby/object:JobThatDoesNotExist {}'
+          job = described_class.create! payload_object: LongRunningJob.new
+          job.update_columns(handler: '--- !ruby/object:JobThatDoesNotExist {}') # rubocop:disable Rails/SkipsModelValidations
           expect_any_instance_of(described_class).to receive(:destroy_failed_jobs?).and_return(false)
           worker.work_off
           job.reload

data/spec/helper.rb

@@ -59,32 +59,14 @@ if db_adapter == "mysql2"
   types[:primary_key] = types[:primary_key].sub(" DEFAULT NULL", "")
 end
 
-migration_template = File.open("lib/generators/delayed/templates/migration.rb")
-
-# need to eval the template with the migration_version intact
-migration_context =
-  Class.new do
-    def my_binding
-      binding
-    end
-
-    private
-
-    def migration_version
-      "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]" if ActiveRecord::VERSION::MAJOR >= 5
-    end
-  end
-
-migration_ruby = ERB.new(migration_template.read).result(migration_context.new.my_binding)
-eval(migration_ruby) # rubocop:disable Security/Eval
+Dir['db/migrate/*.rb'].each { |f| require_relative("../#{f}") }
 
 ActiveRecord::Schema.define do
-  if table_exists?(:delayed_jobs)
-    # `if_exists: true` was only added in Rails 5
-    drop_table :delayed_jobs
-  end
+  drop_table :delayed_jobs, if_exists: true
 
-  CreateDelayedJobs.up
+  CreateDelayedJobs.migrate(:up)
+  AddNameToDelayedJobs.migrate(:up)
+  AddIndexToDelayedJobsName.migrate(:up)
 
   create_table :stories, primary_key: :story_id, force: true do |table|
     table.string :text
@@ -92,6 +74,8 @@ ActiveRecord::Schema.define do
   end
 end
 
+Delayed::Job.reset_column_information
+
 class Story < ActiveRecord::Base
   self.primary_key = :story_id
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: delayed
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Nathan Griffith
@@ -65,6 +65,9 @@ files:
 - README.md
 - Rakefile
 - app/models/delayed/job.rb
+- db/migrate/1_create_delayed_jobs.rb
+- db/migrate/2_add_name_to_delayed_jobs.rb
+- db/migrate/3_add_index_to_delayed_jobs_name.rb
 - lib/delayed.rb
 - lib/delayed/active_job_adapter.rb
 - lib/delayed/backend/base.rb
@@ -91,10 +94,6 @@ files:
 - lib/delayed/yaml_ext.rb
 - lib/delayed_job.rb
 - lib/delayed_job_active_record.rb
-- lib/generators/delayed/generator.rb
-- lib/generators/delayed/migration_generator.rb
-- lib/generators/delayed/next_migration_version.rb
-- lib/generators/delayed/templates/migration.rb
 - spec/autoloaded/clazz.rb
 - spec/autoloaded/instance_clazz.rb
 - spec/autoloaded/instance_struct.rb

data/lib/generators/delayed/generator.rb

@@ -1,7 +0,0 @@
-require 'rails/generators/base'
-
-module Delayed
-  class Generator < Rails::Generators::Base
-    source_paths << File.join(File.dirname(__FILE__), 'templates')
-  end
-end

data/lib/generators/delayed/migration_generator.rb

@@ -1,28 +0,0 @@
-require "generators/delayed/generator"
-require "generators/delayed/next_migration_version"
-require "rails/generators/migration"
-require "rails/generators/active_record"
-
-# Extend the DelayedJobGenerator so that it creates an AR migration
-module Delayed
-  class MigrationGenerator < Generator
-    include Rails::Generators::Migration
-    extend NextMigrationVersion
-
-    source_paths << File.join(File.dirname(__FILE__), "templates")
-
-    def create_migration_file
-      migration_template "migration.rb", "db/migrate/create_delayed_jobs.rb", migration_version: migration_version
-    end
-
-    def self.next_migration_number(dirname)
-      ActiveRecord::Generators::Base.next_migration_number dirname
-    end
-
-    private
-
-    def migration_version
-      "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]" if ActiveRecord::VERSION::MAJOR >= 5
-    end
-  end
-end

data/lib/generators/delayed/next_migration_version.rb

@@ -1,14 +0,0 @@
-module Delayed
-  module NextMigrationVersion
-    # while methods have moved around this has been the implementation
-    # since ActiveRecord 3.0
-    def next_migration_number(dirname)
-      next_migration_number = current_migration_number(dirname) + 1
-      if ActiveRecord::Base.timestamped_migrations
-        [Time.now.utc.strftime("%Y%m%d%H%M%S"), format("%.14d", next_migration_number)].max
-      else
-        format("%.3d", next_migration_number)
-      end
-    end
-  end
-end