sidekiq_workflows 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4c14e767d390b989168bde7f4f5ecc2aa1ec385262a61ce658cf31a847468303
+  data.tar.gz: 2f961ee3f477b3b3c1301aaa73abfb62e6209f452416b8ce6a78e0af642e09f0
+SHA512:
+  metadata.gz: 8888cb766690ac12aa05b37fdfd3eac761619334f8b65e73e6ea8f966c9b660218defd3467d4498f5b10115717c36f031016a6087d554f515d6762b8073e795d
+  data.tar.gz: 7dfd4071261df7b8cea4416592a5791bea584e787dd22c6d4b2d03df24652fc45a0fd3b486afa0be3f2c7df27dad864185e71ba3d264bc27077f94e7a01e4a63

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake/testtask'
+require 'rubygems/package_task'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.test_files = FileList.new('test/**/*_test.rb')
+end
+
+s = Gem::Specification.load("sidekiq_workflows.gemspec")
+
+Gem::PackageTask.new s do end
+
+task default: %w[test]

data/lib/sidekiq_workflows.rb

@@ -0,0 +1,34 @@
+require 'json'
+require 'sidekiq-pro'
+
+module SidekiqWorkflows
+  class << self
+    attr_accessor :worker_queue
+    attr_accessor :callback_queue
+  end
+
+  require 'sidekiq_workflows/node'
+  require 'sidekiq_workflows/root_node'
+  require 'sidekiq_workflows/worker_node'
+  require 'sidekiq_workflows/builder'
+  require 'sidekiq_workflows/worker'
+
+  def self.deserialize(string)
+    from_h(JSON.parse(string, symbolize_names: true))
+  end
+
+  def self.from_h(hash, parent = nil)
+    parent ||= hash.key?(:workers) ? WorkerNode.new(workflow_uuid: hash[:workflow_uuid], on_partial_complete: hash[:on_partial_complete], workers: hash[:workers]) : RootNode.new(workflow_uuid: hash[:workflow_uuid], on_partial_complete: hash[:on_partial_complete])
+    hash[:children].each do |h|
+      child = parent.add_group(h[:workers])
+      from_h(h, child)
+    end
+    parent
+  end
+
+  def self.build(workflow_uuid: nil, on_partial_complete: nil, except: [], &block)
+    root = RootNode.new(workflow_uuid: workflow_uuid, on_partial_complete: on_partial_complete)
+    Builder.new(root, except).then(&block)
+    root
+  end
+end

data/lib/sidekiq_workflows/builder.rb

@@ -0,0 +1,26 @@
+require 'sidekiq_workflows/node'
+
+module SidekiqWorkflows
+  class Builder
+    attr_reader :node, :skip_workers
+
+    def initialize(node, skip_workers = [])
+      @node = node
+      @skip_workers = skip_workers
+    end
+
+    def perform(workers, *args, delay: nil)
+      workers = [worker: workers, payload: args, delay: delay] unless workers.is_a?(Array)
+      workers.reject! { |w| skip_workers.include?(w[:worker]) }
+      return self if workers.empty?
+
+      child = @node.add_group(workers)
+      Builder.new(child, skip_workers)
+    end
+
+    def then(&block)
+      instance_eval(&block)
+    end
+  end
+
+end

data/lib/sidekiq_workflows/node.rb

@@ -0,0 +1,16 @@
+module SidekiqWorkflows
+  module Node
+    def add_group(workers)
+      @children << (child = WorkerNode.new(workers: workers, workflow_uuid: workflow_uuid, on_partial_complete: on_partial_complete, parent: self))
+      child
+    end
+
+    def serialize
+      to_h.to_json
+    end
+
+    def all_nodes
+      [self] + children.flat_map(&:all_nodes)
+    end
+  end
+end

data/lib/sidekiq_workflows/root_node.rb

@@ -0,0 +1,24 @@
+require 'sidekiq_workflows/node'
+
+module SidekiqWorkflows
+  class RootNode
+    include Node
+
+    attr_accessor :workflow_uuid, :on_partial_complete
+    attr_reader :children
+
+    def initialize(workflow_uuid: nil, on_partial_complete: nil)
+      @workflow_uuid = workflow_uuid
+      @on_partial_complete = on_partial_complete
+      @children = []
+    end
+
+    def to_h
+      {
+        workflow_uuid: workflow_uuid,
+        on_partial_complete: on_partial_complete,
+        children: @children.map(&:to_h)
+      }
+    end
+  end
+end

data/lib/sidekiq_workflows/worker.rb

@@ -0,0 +1,78 @@
+require 'sidekiq_workflows/node'
+
+module SidekiqWorkflows
+  class Worker
+    include Sidekiq::Worker
+
+    sidekiq_options retry: false
+
+    def perform(workflow)
+      workflow = ensure_deserialized(workflow)
+
+      case workflow.class.name
+      when 'SidekiqWorkflows::RootNode'
+        perform_children(batch, workflow)
+      when 'SidekiqWorkflows::WorkerNode'
+        batch.jobs do
+          child_batch = Sidekiq::Batch.new
+          child_batch.callback_queue = SidekiqWorkflows.callback_queue unless SidekiqWorkflows.callback_queue.nil?
+          child_batch.description = "Workflow #{workflow.workflow_uuid || '-'}"
+          child_batch.on(:complete, 'SidekiqWorkflows::Worker#on_complete', workflow: workflow.serialize, workflow_uuid: workflow.workflow_uuid)
+          child_batch.jobs do
+            workflow.workers.each do |entry|
+              if entry[:delay]
+                entry[:worker].perform_in(entry[:delay], *entry[:payload])
+              else
+                entry[:worker].perform_async(*entry[:payload])
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def on_complete(status, options)
+      workflow = ensure_deserialized(options['workflow'])
+
+      if workflow.on_partial_complete
+        klass, method = workflow.on_partial_complete.split('#')
+        ActiveSupport::Inflector.constantize(klass).new.send(method, status, options)
+      end
+
+      perform_children(status.parent_batch, workflow) unless status.failures > 0
+    end
+
+    def self.perform_async(workflow, *args)
+      set(queue: worker_queue).send(:perform_async, workflow.serialize, *args)
+    end
+
+    def self.perform_workflow(workflow, on_complete: nil, on_complete_options: {})
+      batch = Sidekiq::Batch.new
+      batch.callback_queue = SidekiqWorkflows.callback_queue unless SidekiqWorkflows.callback_queue.nil?
+      batch.description = "Workflow #{workflow.workflow_uuid || '-'} root batch"
+      batch.on(:complete, on_complete, on_complete_options.merge(workflow_uuid: workflow.workflow_uuid)) if on_complete
+      batch.jobs do
+        perform_async(workflow)
+      end
+      batch.bid
+    end
+
+    private
+
+    def self.worker_queue
+      SidekiqWorkflows.worker_queue || Sidekiq.default_worker_options['queue']
+    end
+
+    def perform_children(batch, workflow)
+      batch.jobs do
+        workflow.children.each do |child|
+          self.class.perform_async(child)
+        end
+      end
+    end
+
+    def ensure_deserialized(workflow)
+      workflow.is_a?(String) ? SidekiqWorkflows.deserialize(workflow) : workflow
+    end
+  end
+end

data/lib/sidekiq_workflows/worker_node.rb

@@ -0,0 +1,38 @@
+require 'sidekiq_workflows/node'
+require 'active_support/inflector'
+
+module SidekiqWorkflows
+  class WorkerNode
+    include Node
+
+    attr_accessor :workers, :workflow_uuid, :on_partial_complete
+    attr_reader :children
+    attr_reader :parent
+
+    def initialize(workers:, workflow_uuid: nil, on_partial_complete: nil, parent: nil)
+      @workers = workers.each do |entry|
+        entry[:worker] = ActiveSupport::Inflector.constantize(entry[:worker]) if entry[:worker].is_a?(String)
+        entry[:delay] = entry[:delay].to_i if entry[:delay]
+      end
+      @workflow_uuid = workflow_uuid
+      @on_partial_complete = on_partial_complete
+      @parent = parent
+      @children = []
+    end
+
+    def to_h
+      {
+        workers: workers.map do |entry|
+          {
+            worker: entry[:worker].name,
+            payload: entry[:payload],
+            delay: entry[:delay]
+          }
+        end,
+        workflow_uuid: workflow_uuid,
+        on_partial_complete: on_partial_complete,
+        children: @children.map(&:to_h)
+      }
+    end
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_workflows
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Marian Theisen
+- Christian Semmler
+- Patrick Detlefsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq-pro
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+description: Sidekiq extension providing a workflow API on top of Sidekiq Pro's batches
+email:
+- mt@zeit.io
+- mail@csemmler.com
+- pd@zeit.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/sidekiq_workflows.rb
+- lib/sidekiq_workflows/builder.rb
+- lib/sidekiq_workflows/node.rb
+- lib/sidekiq_workflows/root_node.rb
+- lib/sidekiq_workflows/worker.rb
+- lib/sidekiq_workflows/worker_node.rb
+homepage: https://github.com/easymarketing/sidekiq_workflows
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Sidekiq extension providing a workflow API on top of Sidekiq Pro's batches
+test_files: []