sidekiq-delay_extensions 6.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 716a9aa8fc7cb10a70fa3677b0f23c782cf07bb31fe9ad5423da4c1b065a8477
+  data.tar.gz: a2652e237b7de3ca5a8a4cbb72655f805fb535b4e52b8aacf8d3c0b9a479515c
+SHA512:
+  metadata.gz: e9a1f926727cb57afc4221a2b23ea5c025f0ab566e9c2b000b46a51258376cede7bddb3795128456e2792a92a1352cc6a3e7c9b6793a4e8ff91dd1cf9993e7ae
+  data.tar.gz: 800db7a111af06c8854f348ce117d535bb4b88f9e54f2435f80bbcbf3db5a48b10f67ec1ba7655030d4b8dbc7fbbc2c13aa53e7bbc53eda0e84c597380401adc

data/Changes.md

@@ -0,0 +1,13 @@
+# Sidekiq Delay Extensions Changes
+
+[Sidekiq Changes](https://github.com/gemhome/sidekiq-delay_extensions/blob/main/Changes.md)
+
+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

@@ -0,0 +1,28 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "sidekiq", ">= 6.4.0"
+gem "rake"
+gem "redis-namespace"
+gem "rails", ">= 6.0.2"
+gem "sqlite3", platforms: :ruby
+gem "activerecord-jdbcsqlite3-adapter", platforms: :jruby
+
+# mail dependencies
+gem "net-smtp", platforms: :mri, require: false
+
+group :test do
+  gem "minitest"
+  gem "simplecov"
+  gem "codecov", require: false
+end
+
+group :development, :test do
+  gem "standard", require: false
+end
+
+group :load_test do
+  gem "hiredis"
+  gem "toxiproxy"
+end

data/LICENSE

@@ -0,0 +1,9 @@
+Copyright (c) Contributed Systems LLC
+
+Sidekiq is an Open Source project licensed under the terms of
+the LGPLv3 license.  Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
+for license text.
+
+Sidekiq Pro and Sidekiq Enterprise have a commercial-friendly license.
+You can find the commercial license in COMM-LICENSE.txt.
+Please see https://sidekiq.org for purchasing options.

data/README.md

@@ -0,0 +1,54 @@
+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)
+
+The [Sidekiq delay extensions are deprecated in 6.x and will be 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.  
+
+When Sidekiq reaches 7.0, this gem will begin being maintained on its own. Maintainers wanted.
+
+Requirements
+-----------------
+
+- See https://github.com/mperham/sidekiq/tree/v6.4.0
+  - Redis: 4.0+
+  - Ruby: MRI 2.5+ or JRuby 9.2+.
+  - Sidekiq 6.0 supports Rails 5.0+ but does not require it.
+
+Installation
+-----------------
+
+    gem install sidekiq
+    gem install sidekiq-delay_extensions
+
+In your initializers, include the line:
+
+    Sidekiq::DelayExtensions.enable_delay!
+
+Testing
+-----------------
+
+In your test environment, include the line:
+
+    require "sidekiq/delay_extensions/testing"
+
+Contributing
+-----------------
+
+Please see [the contributing guidelines](https://github.com/gemhome/sidekiq-delay_extensions/blob/main/.github/contributing.md).
+
+
+License
+-----------------
+
+Please see [LICENSE](https://github.com/gemhome/sidekiq-delay_extensions/blob/main/LICENSE) for licensing details.
+
+
+Original Author
+-----------------
+
+Mike Perham, [@getajobmike](https://twitter.com/getajobmike) / [@sidekiq](https://twitter.com/sidekiq), [https://www.mikeperham.com](https://www.mikeperham.com) / [https://www.contribsys.com](https://www.contribsys.com)

data/lib/sidekiq/delay_extensions/action_mailer.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "sidekiq/delay_extensions/generic_proxy"
+
+module Sidekiq
+  module DelayExtensions
+    ##
+    # Adds +delay+, +delay_for+ and +delay_until+ methods to ActionMailer to offload arbitrary email
+    # delivery to Sidekiq.
+    #
+    # @example
+    #    UserMailer.delay.send_welcome_email(new_user)
+    #    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
+
+      def perform(yml)
+        (target, method_name, args, kwargs) = YAML.load(yml)
+        msg = kwargs.empty? ? target.public_send(method_name, *args) : target.public_send(method_name, *args, **kwargs)
+        # The email method can return nil, which causes ActionMailer to return
+        # an undeliverable empty message.
+        if msg
+          msg.deliver_now
+        else
+          raise "#{target.name}##{method_name} returned an undeliverable mail object"
+        end
+      end
+    end
+
+    module ActionMailer
+      def sidekiq_delay(options = {})
+        Proxy.new(DelayedMailer, self, options)
+      end
+
+      def sidekiq_delay_for(interval, options = {})
+        Proxy.new(DelayedMailer, self, options.merge("at" => Time.now.to_f + interval.to_f))
+      end
+
+      def sidekiq_delay_until(timestamp, options = {})
+        Proxy.new(DelayedMailer, self, options.merge("at" => timestamp.to_f))
+      end
+      alias_method :delay, :sidekiq_delay
+      alias_method :delay_for, :sidekiq_delay_for
+      alias_method :delay_until, :sidekiq_delay_until
+    end
+  end
+end

data/lib/sidekiq/delay_extensions/active_record.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "sidekiq/delay_extensions/generic_proxy"
+
+module Sidekiq
+  module DelayExtensions
+    ##
+    # Adds +delay+, +delay_for+ and +delay_until+ methods to ActiveRecord to offload instance method
+    # execution to Sidekiq.
+    #
+    # @example
+    #   User.recent_signups.each { |user| user.delay.mark_as_awesome }
+    #
+    # Please note, this is not recommended as this will serialize the entire
+    # 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
+
+      def perform(yml)
+        (target, method_name, args, kwargs) = YAML.load(yml)
+        kwargs.empty? ? target.__send__(method_name, *args) : target.__send__(method_name, *args, **kwargs)
+      end
+    end
+
+    module ActiveRecord
+      def sidekiq_delay(options = {})
+        Proxy.new(DelayedModel, self, options)
+      end
+
+      def sidekiq_delay_for(interval, options = {})
+        Proxy.new(DelayedModel, self, options.merge("at" => Time.now.to_f + interval.to_f))
+      end
+
+      def sidekiq_delay_until(timestamp, options = {})
+        Proxy.new(DelayedModel, self, options.merge("at" => timestamp.to_f))
+      end
+      alias_method :delay, :sidekiq_delay
+      alias_method :delay_for, :sidekiq_delay_for
+      alias_method :delay_until, :sidekiq_delay_until
+    end
+  end
+end

data/lib/sidekiq/delay_extensions/api.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "sidekiq/api"
+
+module Sidekiq
+  module DelayExtensions
+    module JobRecord
+      def display_class
+        # 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/
+            safe_load(args[0], klass) do |target, method, _|
+              "#{target}.#{method}"
+            end
+          else
+            super
+          end
+        end
+      end
+
+      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|
+                      arg
+                    end
+
+                  else
+                    super
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/delay_extensions/class_methods.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "sidekiq/delay_extensions/generic_proxy"
+
+module Sidekiq
+  module DelayExtensions
+    ##
+    # Adds `delay`, `delay_for` and `delay_until` methods to all Classes to offload class method
+    # execution to Sidekiq.
+    #
+    # @example
+    #   User.delay.delete_inactive
+    #   Wikipedia.delay.download_changes_for(Date.today)
+    #
+    class DelayedClass
+      include Sidekiq::Worker
+
+      def perform(yml)
+        (target, method_name, args, kwargs) = YAML.load(yml)
+        kwargs.empty? ? target.__send__(method_name, *args) : target.__send__(method_name, *args, **kwargs)
+      end
+    end
+
+    module Klass
+      def sidekiq_delay(options = {})
+        Proxy.new(DelayedClass, self, options)
+      end
+
+      def sidekiq_delay_for(interval, options = {})
+        Proxy.new(DelayedClass, self, options.merge("at" => Time.now.to_f + interval.to_f))
+      end
+
+      def sidekiq_delay_until(timestamp, options = {})
+        Proxy.new(DelayedClass, self, options.merge("at" => timestamp.to_f))
+      end
+      alias_method :delay, :sidekiq_delay
+      alias_method :delay_for, :sidekiq_delay_for
+      alias_method :delay_until, :sidekiq_delay_until
+    end
+  end
+end
+
+Module.__send__(:include, Sidekiq::DelayExtensions::Klass) unless defined?(::Rails)

data/lib/sidekiq/delay_extensions/generic_proxy.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module Sidekiq
+  module DelayExtensions
+    SIZE_LIMIT = 8_192
+
+    class Proxy < BasicObject
+      def initialize(performable, target, options = {})
+        @performable = performable
+        @target = target
+        @opts = options
+      end
+
+      def method_missing(name, *args, **kwargs)
+        # Sidekiq has a limitation in that its message must be JSON.
+        # JSON can't round trip real Ruby objects so we use YAML to
+        # serialize the objects to a String.  The YAML will be converted
+        # to JSON and then deserialized on the other side back into a
+        # Ruby object.
+        obj = [@target, name, args, kwargs]
+        marshalled = ::YAML.dump(obj)
+        if marshalled.size > SIZE_LIMIT
+          ::Sidekiq.logger.warn { "#{@target}.#{name} job argument is #{marshalled.bytesize} bytes, you should refactor it to reduce the size" }
+        end
+        @performable.client_push({"class" => @performable,
+                                  "args" => [marshalled],
+                                  "display_class" => "#{@target}.#{name}"}.merge(@opts))
+      end
+    end
+  end
+end

data/lib/sidekiq/delay_extensions/testing.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+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)
+end

data/lib/sidekiq/delay_extensions/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module DelayExtensions
+    VERSION = "6.4.0"
+  end
+end

data/lib/sidekiq/delay_extensions.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "sidekiq"
+
+module Sidekiq
+  module DelayExtensions
+    def self.enable_delay!
+      if defined?(::ActiveSupport)
+        require "sidekiq/delay_extensions/active_record"
+        require "sidekiq/delay_extensions/action_mailer"
+
+        # Need to patch Psych so it can autoload classes whose names are serialized
+        # in the delayed YAML.
+        Psych::Visitors::ToRuby.prepend(Sidekiq::DelayExtensions::PsychAutoload)
+
+        ActiveSupport.on_load(:active_record) do
+          include Sidekiq::DelayExtensions::ActiveRecord
+        end
+        ActiveSupport.on_load(:action_mailer) do
+          extend Sidekiq::DelayExtensions::ActionMailer
+        end
+      end
+
+      require "sidekiq/delay_extensions/class_methods"
+      Module.__send__(:include, Sidekiq::DelayExtensions::Klass)
+
+      require "sidekiq/delay_extensions/api"
+      Sidekiq::JobRecord.prepend(Sidekiq::DelayExtensions::JobRecord)
+    end
+
+    module PsychAutoload
+      def resolve_class(klass_name)
+        return nil if !klass_name || klass_name.empty?
+        # constantize
+        names = klass_name.split("::")
+        names.shift if names.empty? || names.first.empty?
+
+        names.inject(Object) do |constant, name|
+          constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+        end
+      rescue NameError
+        super
+      end
+    end
+  end
+end

data/sidekiq-delay_extensions.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/sidekiq/delay_extensions/version"
+
+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.summary = "Sidekiq Delay Extensions"
+  spec.description = "Extracted from Sidekiq 6.0"
+  spec.homepage = "https://github.com/gemhome/sidekiq-delay_extensions/wiki/Delayed-extensions"
+  spec.license = "LGPL-3.0"
+
+  spec.files = Dir.glob("{bin,lib,config}/**/*") + %w[Gemfile sidekiq-delay_extensions.gemspec README.md Changes.md LICENSE]
+
+  spec.bindir = "exe"
+  spec.executables = []
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.metadata = {
+    "homepage_uri" => "https://github.com/gemhome/sidekiq-delay_extensions/wiki/Delayed-extensions",
+    "bug_tracker_uri" => "https://github.com/gemhome/sidekiq-delay_extensions/issues",
+    "documentation_uri" => "https://github.com/gemhome/sidekiq-delay_extensions/wiki",
+    "changelog_uri" => "https://github.com/gemhome/sidekiq-delay_extensions/blob/main/Changes.md",
+    "source_code_uri" => "https://github.com/gemhome/sidekiq-delay_extensions"
+  }
+
+  spec.add_dependency "sidekiq", ">= 6.4.0"
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-delay_extensions
+version: !ruby/object:Gem::Version
+  version: 6.4.0
+platform: ruby
+authors:
+- Mike Perham
+- Benjamin Fleischer
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.4.0
+description: Extracted from Sidekiq 6.0
+email:
+- mperham@gmail.com
+- github@benjaminfleischer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Changes.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/sidekiq/delay_extensions.rb
+- lib/sidekiq/delay_extensions/action_mailer.rb
+- lib/sidekiq/delay_extensions/active_record.rb
+- lib/sidekiq/delay_extensions/api.rb
+- lib/sidekiq/delay_extensions/class_methods.rb
+- lib/sidekiq/delay_extensions/generic_proxy.rb
+- lib/sidekiq/delay_extensions/testing.rb
+- lib/sidekiq/delay_extensions/version.rb
+- sidekiq-delay_extensions.gemspec
+homepage: https://github.com/gemhome/sidekiq-delay_extensions/wiki/Delayed-extensions
+licenses:
+- LGPL-3.0
+metadata:
+  homepage_uri: https://github.com/gemhome/sidekiq-delay_extensions/wiki/Delayed-extensions
+  bug_tracker_uri: https://github.com/gemhome/sidekiq-delay_extensions/issues
+  documentation_uri: https://github.com/gemhome/sidekiq-delay_extensions/wiki
+  changelog_uri: https://github.com/gemhome/sidekiq-delay_extensions/blob/main/Changes.md
+  source_code_uri: https://github.com/gemhome/sidekiq-delay_extensions
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Sidekiq Delay Extensions
+test_files: []