switchman-inst-jobs 1.5.0 → 3.0.0

data/lib/switchman_inst_jobs.rb

@@ -25,8 +25,8 @@ module SwitchmanInstJobs
     ::Object.include Delayed::MessageSending
   end
 
-  def self.initialize_shackles
-    ::Shackles.singleton_class.prepend Shackles::ClassMethods
+  def self.initialize_guard_rail
+    ::GuardRail.singleton_class.prepend GuardRail::ClassMethods
   end
 
   def self.initialize_switchman
@@ -44,9 +44,9 @@ require 'switchman_inst_jobs/delayed/pool'
 require 'switchman_inst_jobs/delayed/worker'
 require 'switchman_inst_jobs/delayed/worker/health_check'
 require 'switchman_inst_jobs/engine'
+require 'switchman_inst_jobs/guard_rail'
 require 'switchman_inst_jobs/jobs_migrator'
 require 'switchman_inst_jobs/new_relic'
-require 'switchman_inst_jobs/shackles'
 require 'switchman_inst_jobs/switchman/database_server'
 require 'switchman_inst_jobs/switchman/default_shard'
 require 'switchman_inst_jobs/switchman/shard'

data/lib/switchman_inst_jobs/active_record/migration.rb

@@ -17,6 +17,16 @@ module SwitchmanInstJobs
       ensure
         ::ActiveRecord::Migration.open_migrations -= 1
       end
+
+      def copy(destination, sources, options = {})
+        if sources.delete('delayed_engine')
+          # rubocop:disable Rails/Output
+          puts 'NOTE: Not installing delayed_engine migrations in an application using switchman-inst-jobs'
+          puts '(use rake switchman_inst_jobs:install:migrations instead)'
+          # rubocop:enable Rails/Output
+        end
+        super
+      end
     end
   end
 end

data/lib/switchman_inst_jobs/delayed/backend/base.rb

@@ -12,13 +12,13 @@ module SwitchmanInstJobs
     module Backend
       module Base
         module ClassMethods
-          def enqueue(object, options = {})
+          def enqueue(object, **options)
             ::Switchman::Shard.periodic_clear_shard_cache
             current_shard = ::Switchman::Shard.current
             enqueue_options = options.merge(
               current_shard: current_shard
             )
-            enqueue_job = -> { ::Shackles.activate(:master) { super(object, enqueue_options) } }
+            enqueue_job = -> { ::GuardRail.activate(:master) { super(object, **enqueue_options) } }
 
             # Another dj shard must be currently manually activated, so just use that
             # In general this will only happen in unusual circumstances like tests
@@ -29,15 +29,15 @@ module SwitchmanInstJobs
             else
               ::Switchman::Shard.default.activate do
                 current_shard = ::Switchman::Shard.lookup(current_shard.id)
-                current_job_shard = current_shard.delayed_jobs_shard
+              end
+              current_job_shard = current_shard.delayed_jobs_shard
 
-                if (options[:singleton] || options[:strand]) && current_shard.block_stranded
-                  enqueue_options[:next_in_strand] = false
-                end
+              if (options[:singleton] || options[:strand]) && current_shard.block_stranded
+                enqueue_options[:next_in_strand] = false
+              end
 
-                current_job_shard.activate(:delayed_jobs) do
-                  enqueue_job.call
-                end
+              current_job_shard.activate(:delayed_jobs) do
+                enqueue_job.call
               end
             end
           end

data/lib/switchman_inst_jobs/delayed/message_sending.rb

@@ -1,8 +1,8 @@
 module SwitchmanInstJobs
   module Delayed
     module MessageSending
-      def send_later_enqueue_args(method, _enqueue_args = {}, *args)
-        return send(method, *args) if ::Switchman::DatabaseServer.creating_new_shard
+      def delay(**enqueue_args)
+        return self if ::Switchman::DatabaseServer.creating_new_shard
 
         super
       end

data/lib/switchman_inst_jobs/delayed/worker/health_check.rb

@@ -32,9 +32,7 @@ module SwitchmanInstJobs
               singleton = <<~SINGLETON
                 periodic: Delayed::Worker::HealthCheck.reschedule_abandoned_jobs:#{shard.id}
               SINGLETON
-              send_later_enqueue_args(
-                :reschedule_abandoned_jobs, { singleton: singleton }, call_super: shard
-              )
+              delay(singleton: singleton).reschedule_abandoned_jobs(call_super: shard)
             end
           end
         end

data/lib/switchman_inst_jobs/engine.rb

@@ -34,8 +34,8 @@ module SwitchmanInstJobs
       end
     end
 
-    initializer 'sharding.shackles', after: 'switchman.extend_shackles' do
-      SwitchmanInstJobs.initialize_shackles
+    initializer 'sharding.guard_rail', after: 'switchman.extend_guard_rail' do
+      SwitchmanInstJobs.initialize_guard_rail
     end
 
     initializer 'sharding.switchman' do

data/lib/switchman_inst_jobs/{shackles.rb → guard_rail.rb}

@@ -1,5 +1,5 @@
 module SwitchmanInstJobs
-  module Shackles
+  module GuardRail
     module ClassMethods
       def activate(env, &block)
         if ::ActiveRecord::Migration.open_migrations.positive?

data/lib/switchman_inst_jobs/jobs_migrator.rb

@@ -95,7 +95,7 @@ module SwitchmanInstJobs
                 first = this_strand_scope.where('locked_by IS NOT NULL').next_in_strand_order.lock.first
                 if first
                   first_job = ::Delayed::Job.create!(strand: strand, next_in_strand: false)
-                  first_job.payload_object = ::Delayed::PerformableMethod.new(Kernel, :sleep, [0])
+                  first_job.payload_object = ::Delayed::PerformableMethod.new(Kernel, :sleep, args: [0])
                   first_job.queue = first.queue
                   first_job.tag = 'Kernel.sleep'
                   first_job.source = 'JobsMigrator::StrandBlocker'
@@ -183,12 +183,14 @@ module SwitchmanInstJobs
           # Adapted from get_and_lock_next_available in delayed/backend/active_record.rb
           target_jobs = scope.limit(1000).lock('FOR UPDATE SKIP LOCKED')
 
-          query = "WITH limited_jobs AS (#{target_jobs.to_sql}) " \
-                  "UPDATE #{::Delayed::Job.quoted_table_name} " \
-                  "SET locked_by = #{::Delayed::Job.connection.quote(::Delayed::Backend::Base::ON_HOLD_LOCKED_BY)}, " \
-                  "locked_at = #{::Delayed::Job.connection.quote(::Delayed::Job.db_time_now)} "\
-                  "FROM limited_jobs WHERE limited_jobs.id=#{::Delayed::Job.quoted_table_name}.id " \
-                  "RETURNING #{::Delayed::Job.quoted_table_name}.*"
+          query = source_shard.activate(:delayed_jobs) do
+            "WITH limited_jobs AS (#{target_jobs.to_sql}) " \
+            "UPDATE #{::Delayed::Job.quoted_table_name} " \
+            "SET locked_by = #{::Delayed::Job.connection.quote(::Delayed::Backend::Base::ON_HOLD_LOCKED_BY)}, " \
+            "locked_at = #{::Delayed::Job.connection.quote(::Delayed::Job.db_time_now)} "\
+            "FROM limited_jobs WHERE limited_jobs.id=#{::Delayed::Job.quoted_table_name}.id " \
+            "RETURNING #{::Delayed::Job.quoted_table_name}.*"
+          end
 
           jobs = source_shard.activate(:delayed_jobs) { ::Delayed::Job.find_by_sql(query) }
           new_jobs = jobs.map do |job|

data/lib/switchman_inst_jobs/switchman/default_shard.rb

@@ -8,6 +8,10 @@ module SwitchmanInstJobs
       def jobs_held
         false
       end
+
+      def block_stranded
+        false
+      end
     end
   end
 end

data/lib/switchman_inst_jobs/version.rb

@@ -1,3 +1,3 @@
 module SwitchmanInstJobs
-  VERSION = '1.5.0'.freeze
+  VERSION = '3.0.0'.freeze
 end

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: switchman-inst-jobs
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Bryan Petty
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inst-jobs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.16'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.16'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -68,22 +62,16 @@ dependencies:
   name: switchman
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.14'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.14'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -174,14 +162,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -266,17 +254,42 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-description: 
+description:
 email:
 - bpetty@instructure.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- db/migrate/20101216224513_create_delayed_jobs.rb
+- db/migrate/20110208031356_add_delayed_jobs_tag.rb
+- db/migrate/20110426161613_add_delayed_jobs_max_attempts.rb
+- db/migrate/20110516225834_add_delayed_jobs_strand.rb
+- db/migrate/20110531144916_cleanup_delayed_jobs_indexes.rb
+- db/migrate/20110610213249_optimize_delayed_jobs.rb
+- db/migrate/20110831210257_add_delayed_jobs_next_in_strand.rb
+- db/migrate/20120510004759_delayed_jobs_delete_trigger_lock_for_update.rb
+- db/migrate/20120531150712_drop_psql_jobs_pop_fn.rb
+- db/migrate/20120607164022_delayed_jobs_use_advisory_locks.rb
+- db/migrate/20120607181141_index_jobs_on_locked_by.rb
+- db/migrate/20120608191051_add_jobs_run_at_index.rb
+- db/migrate/20120927184213_change_delayed_jobs_handler_to_text.rb
+- db/migrate/20140505215131_add_failed_jobs_original_job_id.rb
+- db/migrate/20140505215510_copy_failed_jobs_original_id.rb
+- db/migrate/20140505223637_drop_failed_jobs_original_id.rb
+- db/migrate/20140512213941_add_source_to_jobs.rb
+- db/migrate/20150807133223_add_max_concurrent_to_jobs.rb
+- db/migrate/20151123210429_add_expires_at_to_jobs.rb
+- db/migrate/20151210162949_improve_max_concurrent.rb
+- db/migrate/20161206323555_add_back_default_string_limits_jobs.rb
 - db/migrate/20170308045400_add_shard_id_to_delayed_jobs.rb
-- db/migrate/20180628153808_set_search_paths_on_functions.rb
+- db/migrate/20181217155351_speed_up_max_concurrent_triggers.rb
+- db/migrate/20190726154743_make_critical_columns_not_null.rb
+- db/migrate/20200330230722_add_id_to_get_delayed_jobs_index.rb
 - db/migrate/20200818130101_add_on_hold_to_switchman_shards.rb
 - db/migrate/20200822014259_add_block_stranded_to_switchman_shards.rb
+- db/migrate/20200824222232_speed_up_max_concurrent_delete_trigger.rb
+- db/migrate/20200825011002_add_strand_order_override.rb
 - lib/switchman-inst-jobs.rb
 - lib/switchman_inst_jobs.rb
 - lib/switchman_inst_jobs/active_record/connection_adapters/postgresql_adapter.rb
@@ -287,9 +300,9 @@ files:
 - lib/switchman_inst_jobs/delayed/worker.rb
 - lib/switchman_inst_jobs/delayed/worker/health_check.rb
 - lib/switchman_inst_jobs/engine.rb
+- lib/switchman_inst_jobs/guard_rail.rb
 - lib/switchman_inst_jobs/jobs_migrator.rb
 - lib/switchman_inst_jobs/new_relic.rb
-- lib/switchman_inst_jobs/shackles.rb
 - lib/switchman_inst_jobs/switchman/database_server.rb
 - lib/switchman_inst_jobs/switchman/default_shard.rb
 - lib/switchman_inst_jobs/switchman/shard.rb
@@ -300,7 +313,7 @@ homepage: https://github.com/instructure/switchman-inst-jobs
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -308,15 +321,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Switchman and Instructure Jobs compatibility gem.
 test_files: []

data/db/migrate/20180628153808_set_search_paths_on_functions.rb

@@ -1,15 +0,0 @@
-class SetSearchPathsOnFunctions < ActiveRecord::Migration[4.2]
-  disable_ddl_transaction!
-
-  def up
-    set_search_path('delayed_jobs_after_delete_row_tr_fn', '()')
-    set_search_path('delayed_jobs_before_insert_row_tr_fn', '()')
-    set_search_path('half_md5_as_bigint', '(varchar)')
-  end
-
-  def down
-    set_search_path('delayed_jobs_after_delete_row_tr_fn', '()', 'DEFAULT')
-    set_search_path('delayed_jobs_before_insert_row_tr_fn', '()', 'DEFAULT')
-    set_search_path('half_md5_as_bigint', '(varchar)', 'DEFAULT')
-  end
-end