inst-jobs 2.3.1 → 2.4.8

data/spec/spec_helper.rb

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
-require 'delayed_job'
-require 'delayed/testing'
+require "delayed_job"
+require "delayed/testing"
 
-require 'database_cleaner'
-require 'rack/test'
-require 'timecop'
-require 'webmock/rspec'
+require "database_cleaner"
+require "fileutils"
+require "rack/test"
+require "timecop"
+require "webmock/rspec"
 
-require 'pry'
-require 'byebug'
+require "pry"
+require "byebug"
 
 RSpec.configure do |config|
-
   config.expect_with(:rspec) do |c|
-    c.syntax = [:should, :expect]
+    c.syntax = %i[should expect]
   end
 
   config.before(:suite) do
@@ -23,47 +23,42 @@ RSpec.configure do |config|
     WebMock.disable_net_connect!
   end
 
-  config.before(:each) do |example|
-    if Delayed::Backend::Redis::Job.redis
-      Delayed::Backend::Redis::Job.redis.flushdb
-    end
-    DatabaseCleaner.strategy = (example.metadata[:sinatra] || example.metadata[:non_transactional]) ?
-        :truncation : :transaction
+  config.before do |example|
+    DatabaseCleaner.strategy = if example.metadata[:sinatra] || example.metadata[:non_transactional]
+                                 :truncation
+                               else
+                                 :transaction
+                               end
     DatabaseCleaner.start
   end
 
-  config.after(:each) do
+  config.after do
     DatabaseCleaner.clean
   end
 end
 
 module NoYamlDump
-  def encode_with(coder)
-  end
+  def encode_with(coder); end
 end
 # example groups are often the sender, and if we try to serialize them,
 # the resultant object is then encoded in the sender, and then we serialize
 # again, and it just keeps getting bigger and bigger and bigger...
 RSpec::Core::ExampleGroup.include(NoYamlDump)
 
-ENV['TEST_ENV_NUMBER'] ||= '1'
-ENV['TEST_DB_HOST'] ||= 'localhost'
-ENV['TEST_DB_DATABASE'] ||= "inst-jobs-test-#{ENV['TEST_ENV_NUMBER']}"
-ENV['TEST_REDIS_CONNECTION'] ||= 'redis://localhost:6379/'
-
-Delayed::Backend::Redis::Job.redis = Redis.new(url: ENV['TEST_REDIS_CONNECTION'])
-Delayed::Backend::Redis::Job.redis.select ENV['TEST_ENV_NUMBER']
+ENV["TEST_ENV_NUMBER"] ||= "1"
+ENV["TEST_DB_HOST"] ||= "localhost"
+ENV["TEST_DB_DATABASE"] ||= "inst-jobs-test-#{ENV['TEST_ENV_NUMBER']}"
 
 connection_config = {
   adapter: :postgresql,
-  host: ENV['TEST_DB_HOST'].presence,
-  encoding: 'utf8',
-  username: ENV['TEST_DB_USERNAME'],
-  database: ENV['TEST_DB_DATABASE'],
+  host: ENV["TEST_DB_HOST"].presence,
+  encoding: "utf8",
+  username: ENV["TEST_DB_USERNAME"],
+  database: ENV["TEST_DB_DATABASE"]
 }
 
 def migrate(file)
-  if ::Rails.version >= '6'
+  if ::Rails.version >= "6"
     ActiveRecord::MigrationContext.new(file, ActiveRecord::SchemaMigration).migrate
   else
     ActiveRecord::MigrationContext.new(file).migrate
@@ -71,27 +66,37 @@ def migrate(file)
 end
 
 # create the test db if it does not exist, to help out wwtd
-ActiveRecord::Base.establish_connection(connection_config.merge(database: 'postgres'))
+ActiveRecord::Base.establish_connection(connection_config.merge(database: "postgres"))
 begin
   ActiveRecord::Base.connection.create_database(connection_config[:database])
 rescue ActiveRecord::StatementInvalid
+  nil
 end
 ActiveRecord::Base.establish_connection(connection_config)
-# TODO reset db and migrate again, to test migrations
+# TODO: reset db and migrate again, to test migrations
 
 migrate("db/migrate")
 migrate("spec/migrate")
 Delayed::Backend::ActiveRecord::Job.reset_column_information
 Delayed::Backend::ActiveRecord::Job::Failed.reset_column_information
 
-Time.zone = 'UTC'
-Rails.logger = Logger.new(nil)
+Time.zone = "UTC" # rubocop:disable Rails/TimeZoneAssignment
+FileUtils.mkdir_p("tmp")
+ActiveRecord::Base.logger = Rails.logger = Logger.new("tmp/test.log")
 
 # Purely useful for test cases...
 class Story < ActiveRecord::Base
-  def tell; text; end
-  def whatever(n, _); tell*n; end
-  def whatever_else(n, _); tell*n; end
+  def tell
+    text
+  end
+
+  def whatever(times, _)
+    tell * times
+  end
+
+  def whatever_else(times, _)
+    tell * times
+  end
 
   handle_asynchronously :whatever
   handle_asynchronously :whatever_else, queue: "testqueue"
@@ -114,7 +119,7 @@ module MyReverser
 end
 
 def change_setting(klass, setting_name, value)
-  old_val = klass.class_variable_get(:"@@#{setting_name}")
+  old_val = klass.send(setting_name)
   klass.send("#{setting_name}=", value)
   yield
 ensure
@@ -125,5 +130,5 @@ def run_job(job)
   Delayed::Testing.run_job(job)
 end
 
-require File.expand_path('../sample_jobs', __FILE__)
-require File.expand_path('../shared_jobs_specs', __FILE__)
+require_relative "sample_jobs"
+require_relative "shared_jobs_specs"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inst-jobs
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.8
 platform: ruby
 authors:
 - Tobias Luetke
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-24 00:00:00.000000000 Z
+date: 2021-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -60,75 +60,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: railties
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
-- !ruby/object:Gem::Dependency
-  name: redis
+  name: debug_inspector
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: redis-scripting
+  name: fugit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: fugit
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: debug_inspector
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
+        version: '2.4'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: bump
   requirement: !ruby/object:Gem::Requirement
@@ -283,6 +269,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -387,20 +429,12 @@ files:
 - db/migrate/20200330230722_add_id_to_get_delayed_jobs_index.rb
 - db/migrate/20200824222232_speed_up_max_concurrent_delete_trigger.rb
 - db/migrate/20200825011002_add_strand_order_override.rb
+- db/migrate/20210809145804_add_n_strand_index.rb
+- db/migrate/20210812210128_add_singleton_column.rb
+- db/migrate/20210917232626_add_delete_conflicting_singletons_before_unlock_trigger.rb
 - exe/inst_jobs
 - lib/delayed/backend/active_record.rb
 - lib/delayed/backend/base.rb
-- lib/delayed/backend/redis/bulk_update.lua
-- lib/delayed/backend/redis/destroy_job.lua
-- lib/delayed/backend/redis/enqueue.lua
-- lib/delayed/backend/redis/fail_job.lua
-- lib/delayed/backend/redis/find_available.lua
-- lib/delayed/backend/redis/functions.rb
-- lib/delayed/backend/redis/get_and_lock_next_available.lua
-- lib/delayed/backend/redis/includes/jobs_common.lua
-- lib/delayed/backend/redis/job.rb
-- lib/delayed/backend/redis/set_running.lua
-- lib/delayed/backend/redis/tickle_strand.lua
 - lib/delayed/batch.rb
 - lib/delayed/cli.rb
 - lib/delayed/core_ext/kernel.rb
@@ -450,11 +484,7 @@ files:
 - spec/delayed/worker/consul_health_check_spec.rb
 - spec/delayed/worker/health_check_spec.rb
 - spec/delayed/worker_spec.rb
-- spec/gemfiles/52.gemfile
-- spec/gemfiles/60.gemfile
-- spec/gemfiles/61.gemfile
 - spec/migrate/20140924140513_add_story_table.rb
-- spec/redis_job_spec.rb
 - spec/sample_jobs.rb
 - spec/shared/delayed_batch.rb
 - spec/shared/delayed_method.rb
@@ -482,17 +512,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.24
 signing_key:
 specification_version: 4
 summary: Instructure-maintained fork of delayed_job
 test_files:
 - spec/sample_jobs.rb
 - spec/spec_helper.rb
-- spec/redis_job_spec.rb
-- spec/gemfiles/61.gemfile
-- spec/gemfiles/60.gemfile
-- spec/gemfiles/52.gemfile
 - spec/shared_jobs_specs.rb
 - spec/shared/performable_method.rb
 - spec/shared/testing.rb

data/lib/delayed/backend/redis/bulk_update.lua

@@ -1,50 +0,0 @@
-local action, id_string, flavor, query, now = unpack(ARGV)
-
-local ids = {}
-
-if string.len(flavor) > 0 then
-  if flavor == 'current' then
-    ids = redis.call('ZRANGE', Keys.queue(query), 0, -1)
-  elseif flavor == 'future' then
-    ids = redis.call('ZRANGE', Keys.future_queue(query), 0, -1)
-  elseif flavor == 'strand' then
-    ids = redis.call('LRANGE', Keys.strand(query), 0, -1)
-  elseif flavor == 'tag' then
-    ids = redis.call('SMEMBERS', Keys.tag(query))
-  end
-else
-  -- can't pass an array to redis/lua, so we split the string here
-  for id in string.gmatch(id_string, "([%w-]+)") do
-    if job_exists(id) then
-      table.insert(ids, id)
-    end
-  end
-end
-
-local count = 0
-for idx, job_id in ipairs(ids) do
-  if action == 'hold' then
-    local queue, strand, locked_by = unpack(redis.call('HMGET', Keys.job(job_id), 'queue', 'strand', 'locked_by'))
-    if not locked_by then
-      count = count + 1
-      remove_from_queues(job_id, queue, strand)
-      redis.call('HMSET', Keys.job(job_id), 'locked_at', now, 'locked_by', 'on hold', 'attempts', 50)
-    end
-  elseif action == 'unhold' then
-    local queue, locked_by = unpack(redis.call('HMGET', Keys.job(job_id), 'queue', 'locked_by'))
-    if locked_by == 'on hold' then
-      count = count + 1
-      add_to_queues(job_id, queue, now)
-      redis.call('HDEL', Keys.job(job_id), 'locked_at', 'locked_by')
-      redis.call('HMSET', Keys.job(job_id), 'attempts', 0)
-    end
-  elseif action == 'destroy' then
-    local locked_by = redis.call('HGET', Keys.job(job_id), 'locked_by')
-    if not locked_by or locked_by == 'on hold' then
-      count = count + 1
-      destroy_job(job_id, now)
-    end
-  end
-end
-
-return count

data/lib/delayed/backend/redis/destroy_job.lua

@@ -1,2 +0,0 @@
-local job_id, now = unpack(ARGV)
-destroy_job(job_id, now)

data/lib/delayed/backend/redis/enqueue.lua

@@ -1,29 +0,0 @@
-local job_id, queue, strand, now, for_singleton = unpack(ARGV)
-local strand_key = Keys.strand(strand)
-
--- if this is a singleton job, only queue it up if another doesn't exist on the strand
--- otherwise, delete it and return the other job id
-if for_singleton then
-  local job_ids = redis.call('LRANGE', strand_key, 0, 1)
-  local job_to_check = 1
-  if job_exists(job_ids[1]) and redis.call('HGET', Keys.job(job_ids[1]), 'locked_at') then
-    job_to_check = 2
-  end
-
-  local job_to_check_id = job_ids[job_to_check]
-  if job_exists(job_to_check_id) then
-    -- delete the new job, we found a match
-    redis.call('DEL', Keys.job(job_id))
-    return job_to_check_id
-  end
-end
-
--- if this job is in a strand, add it to the strand queue first
--- if it's not at the front of the strand, we won't enqueue it below
-if strand_key then
-  add_to_strand(job_id, strand)
-end
-
-add_to_queues(job_id, queue, now)
-
-return job_id

data/lib/delayed/backend/redis/fail_job.lua

@@ -1,5 +0,0 @@
-local job_id = unpack(ARGV)
-local failed_at, queue, strand = unpack(redis.call('HMGET', Keys.job(job_id), 'failed_at', 'queue', 'strand'))
-
-remove_from_queues(job_id, queue, strand)
-redis.call('ZADD', Keys.failed_jobs(), failed_at, job_id)

data/lib/delayed/backend/redis/find_available.lua

@@ -1,3 +0,0 @@
-local queue, limit, offset, min_priority, max_priority, now = unpack(ARGV)
-
-return find_available(queue, limit, offset, min_priority, max_priority, now)

data/lib/delayed/backend/redis/functions.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-require 'redis/scripting'
-
-# This module handles loading the Lua functions into Redis and running them
-module Delayed::Backend::Redis
-class Functions < ::Redis::Scripting::Module
-  def initialize(redis)
-    super(redis, File.dirname(__FILE__))
-  end
-
-  def run_script(script, keys, argv)
-    result = nil
-    ms = Benchmark.ms { result = super }
-    line = 'Redis Jobs Timing: %s (%.1fms)' % [script.name, ms]
-    ActiveRecord::Base.logger.debug(line)
-    result
-  end
-
-  def find_available(queue, limit, offset, min_priority, max_priority, now)
-    run(:find_available, [], [queue, limit, offset, min_priority, max_priority, now.utc.to_f])
-  end
-
-  def get_and_lock_next_available(worker_name, queue, min_priority, max_priority, now)
-    attrs = run(:get_and_lock_next_available, [], [queue, min_priority, max_priority, worker_name, now.utc.to_f])
-    Hash[*attrs]
-  end
-
-  def enqueue(job_id, queue, strand, now)
-    run(:enqueue, [], [job_id, queue, strand, now.utc.to_f])
-  end
-
-  def create_singleton(job_id, queue, strand, now)
-    run(:enqueue, [], [job_id, queue, strand, now.utc.to_f, true])
-  end
-
-  def destroy_job(job_id, now)
-    run(:destroy_job, [], [job_id, now.utc.to_f])
-  end
-
-  def tickle_strand(job_id, strand, now)
-    run(:tickle_strand, [], [job_id, strand, now.utc.to_f])
-  end
-
-  def fail_job(job_id)
-    run(:fail_job, [], [job_id])
-  end
-
-  def set_running(job_id)
-    run(:set_running, [], [job_id])
-  end
-
-  def bulk_update(action, ids, flavor, query, now)
-    ids = (ids || []).join(",")
-    run(:bulk_update, [], [action, ids, flavor, query, now.utc.to_f])
-  end
-
-end
-end

data/lib/delayed/backend/redis/get_and_lock_next_available.lua

@@ -1,17 +0,0 @@
-local queue, min_priority, max_priority, worker_name, now = unpack(ARGV)
-local job_id = find_available(queue, 1, 0, min_priority, max_priority, now)[1]
-
-if job_exists(job_id) then
-  -- update the job with locked_by and locked_at
-  redis.call('HMSET', Keys.job(job_id), 'locked_by', worker_name, 'locked_at', now)
-
-  -- add the job to the running_jobs set
-  redis.call('ZADD', Keys.running_jobs(), now, job_id)
-  -- remove the job from the pending jobs queue
-  redis.call('ZREM', Keys.queue(queue), job_id)
-
-  -- return the list of job attributes
-  return redis.call('HGETALL', Keys.job(job_id))
-else
-  return {}
-end