sidekiq-group 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dd109b06a1d0e8b3dfc74edf53aaf8fb57e72046c9eac0352abc79c83560fb04
+  data.tar.gz: 309916f9bddab5075cec3690de80b33a305986074157b3f86a0ee0a906dd72c8
+SHA512:
+  metadata.gz: d64c64fbbb3c950ad847a49ce94dea78084443de6260e513cb4575466084a0b0225cdf048aa1f9c881b9b0539feda2a43fd94c29fc161ab23b8c216c75d0c695
+  data.tar.gz: 2a491e6947ac7b9b27b82c3ce098b013b948a4c913606e228a1c5f8924d921fb1960093e634a68992d07c72c4b3096da7055aa3fac2766b150f786d12029eacc

data/lib/sidekiq/group.rb

@@ -0,0 +1,34 @@
+require 'sidekiq/logging'
+require 'sidekiq/group/version'
+require 'sidekiq/group/collection'
+require 'sidekiq/group/middleware'
+
+module Sidekiq
+  module Group
+    class NoBlockGivenError < StandardError; end
+
+    def sidekiq_group(options = {})
+      raise NoBlockGivenError unless block_given?
+
+      group = Sidekiq::Group::Collection.new
+      group.callback_class = self.class.name
+      group.callback_options = options
+
+      Thread.current[:group_collection] = group
+
+      yield(group)
+
+      group.spawned_jobs!
+
+      Thread.current[:group_collection] = nil
+    end
+
+    def on_complete(_options = {})
+      sidekiq_logger.warn 'on_complete function is not defined'
+    end
+
+    def sidekiq_logger
+      Sidekiq::Logging.logger
+    end
+  end
+end

data/lib/sidekiq/group/collection.rb

@@ -0,0 +1,102 @@
+require 'securerandom'
+require 'sidekiq/group/worker'
+
+module Sidekiq
+  module Group
+    class Collection
+      CID_EXPIRE_TTL = 3600 * 24 * 30
+      LOCK_TTL = 3600
+
+      attr_reader :cid, :callback_class, :callback_options
+
+      def initialize(cid = nil)
+        @cid = cid || SecureRandom.urlsafe_base64(16)
+      end
+
+      def callback_class=(value)
+        @callback_class = value
+        persist('callback_class', value)
+      end
+
+      def callback_options=(value)
+        @callback_options = value
+        persist('callback_options', value.to_json)
+      end
+
+      def add(jid)
+        Sidekiq.redis do |r|
+          r.multi do
+            r.sadd("#{@cid}-jids", jid)
+            r.expire("#{@cid}-jids", CID_EXPIRE_TTL)
+          end
+        end
+      end
+
+      def spawned_jobs!
+        persist('spawned_jobs', cid)
+      end
+
+      def success(jid)
+        remove_processed(jid)
+
+        return unless processed_all_jobs?
+        return if locked?
+
+        callback_class, callback_options = callback_data
+        options = JSON(callback_options)
+        Sidekiq::Group::Worker.perform_async(callback_class, options)
+
+        cleanup_redis
+      end
+
+      private
+
+      def remove_processed(jid)
+        Sidekiq.redis { |r| r.srem("#{@cid}-jids", jid) }
+      end
+
+      def pending
+        Sidekiq.redis { |r| r.scard("#{@cid}-jids") }
+      end
+
+      def processed_all_jobs?
+        spawned_all_jobs? && pending.zero?
+      end
+
+      def spawned_all_jobs?
+        Sidekiq.redis { |r| r.hget(@cid, 'spawned_jobs') }.present?
+      end
+
+      def callback_data
+        Sidekiq.redis do |r|
+          r.multi do
+            r.hget(@cid, 'callback_class')
+            r.hget(@cid, 'callback_options')
+          end
+        end
+      end
+
+      def persist(attribute, value)
+        Sidekiq.redis do |r|
+          r.multi do
+            r.hset(@cid, attribute, value)
+            r.expire(@cid, CID_EXPIRE_TTL)
+          end
+        end
+      end
+
+      def cleanup_redis
+        Sidekiq.redis { |r| r.del(@cid, "#{@cid}-jids") }
+      end
+
+      def locked?
+        Sidekiq.redis do |r|
+          r.multi do
+            r.getset("#{@cid}-finished", 1)
+            r.expire("#{@cid}-finished", LOCK_TTL)
+          end.first
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/group/middleware.rb

@@ -0,0 +1,37 @@
+module Sidekiq
+  module Group
+    module Middleware
+      class ClientMiddleware
+        def call(_worker, msg, _queue, _redis_pool = nil)
+          if (group = Thread.current[:group_collection])
+            msg['cid'] = group.cid
+          end
+
+          yield
+        end
+      end
+
+      class ServerMiddleware
+        def call(_worker, msg, _queue)
+          yield
+
+          return unless msg['cid']
+
+          Sidekiq::Group::Collection.new(msg['cid']).success(msg['jid'])
+        end
+      end
+
+      def self.configure
+        Sidekiq.configure_client do |config|
+          config.client_middleware { |c| c.add Sidekiq::Group::Middleware::ClientMiddleware }
+        end
+        Sidekiq.configure_server do |config|
+          config.client_middleware { |c| c.add Sidekiq::Group::Middleware::ClientMiddleware }
+          config.server_middleware { |c| c.add Sidekiq::Group::Middleware::ServerMiddleware }
+        end
+      end
+    end
+  end
+end
+
+Sidekiq::Group::Middleware.configure

data/lib/sidekiq/group/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Group
+    VERSION = '0.1.3'.freeze
+  end
+end

data/lib/sidekiq/group/worker.rb

@@ -0,0 +1,12 @@
+module Sidekiq
+  module Group
+    class Worker
+      include Sidekiq::Worker
+
+      def perform(callback_class, callback_options)
+        callback = callback_class.constantize.new
+        callback.on_complete(callback_options)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-group
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Matic developers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Allows to group jobs into a set and follow their progress
+email:
+- yuriy.l@matic.com
+- oleh.m@matic.com
+- viktoriia.b@matic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sidekiq/group.rb
+- lib/sidekiq/group/collection.rb
+- lib/sidekiq/group/middleware.rb
+- lib/sidekiq/group/version.rb
+- lib/sidekiq/group/worker.rb
+homepage: https://github.com/matic-insurance/sidekiq-group
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Addon for Sidekiq that provides similar functionality to Pro version Batches
+  feature
+test_files: []