sidekiq-delay_extensions 6.4.1 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: beb5bfc9e96d466f3243e2a46d1826f67463b973fc9d6ce72687abe085cb61ab
-  data.tar.gz: 17d9241ad6cde74793d0e5c860b962044a8c9b592a8059566c4391a55f068b49
+  metadata.gz: 95dda38ae3c61ad156898807a993f2e4ed94a1e9fa84e0acefc55e9eda8c563f
+  data.tar.gz: c01d2df0317cb993a90ea42edf54c8cd8555a47abc6e9fc5aeca30cd3c609970
 SHA512:
-  metadata.gz: f8ac369b7701a8c979c729a512287d0956b1f952c87f48660d2f1262c14ab992cea51970626fc01eb737263e7c67b9dc1ad220542695964a74ad591ec2970fd8
-  data.tar.gz: a1cd9feaaae12197787b9b707689c61b6631e559f61cec18b0d35eac56165046100dba4822f5d0dd0c8ceae56e648113e3ee4bdd97a602a2b0df1af2072fcc01
+  metadata.gz: c8ff4ae1215e5f1feb5b69c776711e9bdbd788d485d67f539e6b04aa47712149eff81f3a8148ad18fde812254107d1954754e67559847821cfd22cb414d64321
+  data.tar.gz: 1c829791c9f5c30a59fd236864f07d9e3ae635bd928bc4df8d25bce692b1323f0a8f851692d49cafac4da446b8c87b4f84d8d33fcfe8e8151201f5de7ade08a4

data/Changes.md

@@ -1,8 +1,23 @@
 # Sidekiq Delay Extensions Changes
 
-[Sidekiq Changes](https://github.com/gemhome/sidekiq-delay_extensions/blob/main/Changes.md)
+[See Sidekiq for its changes](https://github.com/mperham/sidekiq/blob/main/Changes.md)
+
+7.0.0
+---------
+
+- Require Sidekiq >= 7.0
+
+6.5.12
+---------
+
+- Extracted from https://github.com/mperham/sidekiq/tree/v6.5.12
 
 6.4.1
 ---------
 
 - Extracted from https://github.com/mperham/sidekiq/tree/v6.4.1
+
+6.4.0
+---------
+
+- Extracted from https://github.com/mperham/sidekiq/tree/v6.4.0

data/Gemfile

@@ -2,20 +2,26 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "sidekiq", ">= 6.4.1"
+gem "sidekiq", "~> 7.0"
 gem "rake"
-gem "redis-namespace"
-gem "rails", ">= 6.0.2"
+RAILS_VERSION = "~> 7.0.4"
+gem "actionmailer", RAILS_VERSION
+gem "actionpack", RAILS_VERSION
+gem "activejob", RAILS_VERSION
+gem "activerecord", RAILS_VERSION
+gem "railties", RAILS_VERSION
+gem "redis-client"
+# gem "bumbler"
+# gem "debug"
+
 gem "sqlite3", platforms: :ruby
 gem "activerecord-jdbcsqlite3-adapter", platforms: :jruby
-
-# mail dependencies
-gem "net-smtp", platforms: :mri, require: false
+gem "after_commit_everywhere", require: false
+gem "yard"
 
 group :test do
-  gem "minitest"
+  gem "maxitest"
   gem "simplecov"
-  gem "codecov", require: false
 end
 
 group :development, :test do
@@ -23,6 +29,6 @@ group :development, :test do
 end
 
 group :load_test do
-  gem "hiredis"
   gem "toxiproxy"
+  gem "ruby-prof"
 end

data/README.md

@@ -2,33 +2,40 @@ Sidekiq Delay Extensions
 ==============
 
 [![Gem Version](https://badge.fury.io/rb/sidekiq-delay_extensions.svg)](https://rubygems.org/gems/sidekiq-delay_extensions)
-![Build](https://github.com/gehome/sidekiq-delay_extensions/workflows/CI/badge.svg)
+![Build](https://github.com/gemhome/sidekiq-delay_extensions/workflows/CI/badge.svg)
 
-The [Sidekiq delay extensions are deprecated in 6.x and will be removed from 7.x](https://github.com/mperham/sidekiq/issues/5076).
+The [Sidekiq delay extensions were deprecated in 6.x and were removed from 7.x](https://github.com/mperham/sidekiq/issues/5076).
 
-This gem extracts the delay extensions from the latest 6.x release and will match
-Sidekiq 6.x version numbers.  
+This gem extracts the delay extensions from the latest 6.x release, 6.5.12.
+Version 7.x of this gem will maintain compatibility with Sidekiq 7.x.
 
-When Sidekiq reaches 7.0, this gem will begin being maintained on its own. Maintainers wanted.
+This gem is maintained independent of Sidekiq. Maintainers wanted.
 
 Requirements
 -----------------
 
-- See https://github.com/mperham/sidekiq/tree/v6.4.1
-  - Redis: 4.0+
-  - Ruby: MRI 2.5+ or JRuby 9.2+.
-  - Sidekiq 6.0 supports Rails 5.0+ but does not require it.
+- See https://github.com/sidekiq/sidekiq/blob/main/Changes.md#700
+  - Redis: 6.2+
+  - Ruby: MRI 2.7+ or JRuby 9.3+.
+  - Sidekiq 7.0 supports Rails 6.0+ but does not require it.
 
 Installation
 -----------------
 
-    gem install sidekiq
-    gem install sidekiq-delay_extensions
+    bundle add sidekiq
+    bundle add sidekiq-delay_extensions
 
 In your initializers, include the line:
 
     Sidekiq::DelayExtensions.enable_delay!
 
+Upgrading (IMPORTANT): Also add
+
+    # To handle any existing delayed jobs at time of upgrade.
+    Sidekiq::Extensions::DelayedClass = Sidekiq::DelayExtensions::DelayedClass
+    Sidekiq::Extensions::DelayedModel = Sidekiq::DelayExtensions::DelayedModel
+    Sidekiq::Extensions::DelayedMailer = Sidekiq::DelayExtensions::DelayedMailer
+
 Testing
 -----------------
 

data/lib/sidekiq/delay_extensions/action_mailer.rb

@@ -13,7 +13,7 @@ module Sidekiq
     #    UserMailer.delay_for(5.days).send_welcome_email(new_user)
     #    UserMailer.delay_until(5.days.from_now).send_welcome_email(new_user)
     class DelayedMailer
-      include Sidekiq::Worker
+      include Sidekiq::Job
 
       def perform(yml)
         (target, method_name, args) = YAML.load(yml)

data/lib/sidekiq/delay_extensions/active_record.rb

@@ -15,7 +15,7 @@ module Sidekiq
     # object to Redis.  Your Sidekiq jobs should pass IDs, not entire instances.
     # This is here for backwards compatibility with Delayed::Job only.
     class DelayedModel
-      include Sidekiq::Worker
+      include Sidekiq::Job
 
       def perform(yml)
         (target, method_name, args) = YAML.load(yml)

data/lib/sidekiq/delay_extensions/api.rb

@@ -9,7 +9,7 @@ module Sidekiq
         # Unwrap known wrappers so they show up in a human-friendly manner in the Web UI
         @klass ||= self["display_class"] || begin
           case klass
-          when /\ASidekiq::DelayExtensions::Delayed/
+          when /\ASidekiq::DelayExtensions::Delayed/, /\ASidekiq::Extensions::Delayed/
             safe_load(args[0], klass) do |target, method, _|
               "#{target}.#{method}"
             end
@@ -22,18 +22,33 @@ module Sidekiq
       def display_args
         # Unwrap known wrappers so they show up in a human-friendly manner in the Web UI
         @display_args ||= case klass
-                  when /\ASidekiq::DelayExtensions::Delayed/
-                    safe_load(args[0], args) do |_, _, arg, kwarg|
-                      if !kwarg || kwarg.empty?
-                        arg
-                      else
-                        [arg, kwarg]
-                      end
-                    end
-                  else
-                    super
+        when /\ASidekiq::DelayExtensions::Delayed/, /\ASidekiq::Extensions::Delayed/
+          safe_load(args[0], args) do |_, _, arg, kwarg|
+            if !kwarg || kwarg.empty?
+              arg
+            else
+              [arg, kwarg]
+            end
+          end
+        else
+          super
         end
       end
+
+      private
+
+      # per https://github.com/mperham/sidekiq/blob/v6.5.8/lib/sidekiq/api.rb#L492-L502
+      # vs.
+      # https://github.com/mperham/sidekiq/blob/v7.0.1/lib/sidekiq/api.rb#L374-L411
+      def safe_load(content, default)
+        yield(*YAML.load(content))
+      rescue => ex
+        # #1761 in dev mode, it's possible to have jobs enqueued which haven't been loaded into
+        # memory yet so the YAML can't be loaded.
+        # TODO is this still necessary? Zeitwerk reloader should handle?
+        Sidekiq.logger.warn "Unable to load YAML: #{ex.message}" unless Sidekiq.options[:environment] == "development"
+        default
+      end
     end
   end
 end

data/lib/sidekiq/delay_extensions/class_methods.rb

@@ -13,7 +13,7 @@ module Sidekiq
     #   Wikipedia.delay.download_changes_for(Date.today)
     #
     class DelayedClass
-      include Sidekiq::Worker
+      include Sidekiq::Job
 
       def perform(yml)
         (target, method_name, args) = YAML.load(yml)

data/lib/sidekiq/delay_extensions/generic_proxy.rb

@@ -10,7 +10,7 @@ module Sidekiq
       def initialize(performable, target, options = {})
         @performable = performable
         @target = target
-        @opts = options
+        @opts = options.transform_keys(&:to_s)
       end
 
       def method_missing(name, *args)

data/lib/sidekiq/delay_extensions/testing.rb

@@ -3,6 +3,21 @@
 require "sidekiq/testing"
 
 module Sidekiq
-  Sidekiq::DelayExtensions::DelayedMailer.extend(TestingExtensions) if defined?(Sidekiq::DelayExtensions::DelayedMailer)
-  Sidekiq::DelayExtensions::DelayedModel.extend(TestingExtensions) if defined?(Sidekiq::DelayExtensions::DelayedModel)
+  module DelayedTestingExtensions
+    include TestingExtensions
+
+    # NOTE(BF): Extend Sidekiq::TestingExtensions
+    # to optionally handle unsafely loading YAML
+    # for delayed extensions in Sidekiq 7.x.
+    def jobs_for(klass, unsafe_load: false)
+      return super(klass) unless unsafe_load
+      jobs.select do |job|
+        marshalled = job["args"][0]
+        next unless marshalled.index(klass.to_s)
+        YAML.load(marshalled)
+      end
+    end
+  end
+  Sidekiq::DelayExtensions::DelayedMailer.extend(DelayedTestingExtensions) if defined?(Sidekiq::DelayExtensions::DelayedMailer)
+  Sidekiq::DelayExtensions::DelayedModel.extend(DelayedTestingExtensions) if defined?(Sidekiq::DelayExtensions::DelayedModel)
 end

data/lib/sidekiq/delay_extensions/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module DelayExtensions
-    VERSION = "6.4.1"
+    VERSION = "7.0.0"
   end
 end

data/sidekiq-delay_extensions.gemspec

@@ -6,10 +6,10 @@ Gem::Specification.new do |spec|
   spec.name = "sidekiq-delay_extensions"
   spec.version = Sidekiq::DelayExtensions::VERSION
   spec.authors = ["Mike Perham", "Benjamin Fleischer"]
-  spec.email = ["mperham@gmail.com", "github@benjaminfleischer.com"]
+  spec.email = ["info@contribsys.com", "github@benjaminfleischer.com"]
 
   spec.summary = "Sidekiq Delay Extensions"
-  spec.description = "Extracted from Sidekiq 6.0"
+  spec.description = "Extracted from Sidekiq 6.0, compatible with Sidekiq 7.0"
   spec.homepage = "https://github.com/gemhome/sidekiq-delay_extensions/wiki/Delayed-extensions"
   spec.license = "LGPL-3.0"
 
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.bindir = "exe"
   spec.executables = []
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 2.5.0"
+  spec.required_ruby_version = ">= 2.7.0"
 
   spec.metadata = {
     "homepage_uri" => "https://github.com/gemhome/sidekiq-delay_extensions/wiki/Delayed-extensions",
@@ -28,5 +28,5 @@ Gem::Specification.new do |spec|
     "source_code_uri" => "https://github.com/gemhome/sidekiq-delay_extensions"
   }
 
-  spec.add_dependency "sidekiq", ">= 6.4.1"
+  spec.add_dependency "sidekiq", ">= 7.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-delay_extensions
 version: !ruby/object:Gem::Version
-  version: 6.4.1
+  version: 7.0.0
 platform: ruby
 authors:
 - Mike Perham
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-08 00:00:00.000000000 Z
+date: 2024-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -17,17 +17,17 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.4.1
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.4.1
-description: Extracted from Sidekiq 6.0
+        version: '7.0'
+description: Extracted from Sidekiq 6.0, compatible with Sidekiq 7.0
 email:
-- mperham@gmail.com
+- info@contribsys.com
 - github@benjaminfleischer.com
 executables: []
 extensions: []
@@ -63,14 +63,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Sidekiq Delay Extensions