dwf 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e545ff4c6f4b56071875f642f1262fee7762fabb63d86c816a0c943cb8e34657
-  data.tar.gz: dfe832f98724b81b8ff1198320cb66013869cca6ba2b2f89d47c4caf0b2108f9
+  metadata.gz: 4d6ec140cc691fd53ceb5d495add6e3a76ce6a7b6daf2bfbde982e6e40a19987
+  data.tar.gz: 66911fc7ec1a54e38aaaca160ee455b2463f1888ecbbf981c64a17e9d790c1a2
 SHA512:
-  metadata.gz: 7e77ca9abe614aa1da026818f1a49028bcc3878bd9bd5838e8cdfdf245ab09d124ab4300bd077eed1c3e8b07e46b321c1dd59d18face658fda3f6c636e28954f
-  data.tar.gz: 6a6ff8756a13fcec73966c41ded7b808cae24a73e1cec2bd301dacfdbfde6022812c7f27c6dacc12a5bb469aae241e59316eb544b2ca7ac1f0530e1c5f5ffa2c
+  metadata.gz: 240a6603023b3edc79b69d1793e8805e86ec298f2927df7bd3a1342ad241fb3a0b619a6aa50266348003c20f751fdd58dc91a68dead319916ca351a09bee5f0f
+  data.tar.gz: 4af1937daa29fab5f2fd818f22a64bea90d35074a0ca70109e4a36cbaa754fae199799167385f78579a854152563c1e8074c6ff91ad931e544b20c67bf7de054

data/.github/workflows/build_gem.yaml

@@ -1,13 +1,9 @@
 name: Ruby Gem
 
 on:
-  # Manually publish
   workflow_dispatch:
-  # Alternatively, publish whenever changes are merged to the `main` branch.
   push:
     branches: [ master ]
-    paths:
-      - 'dwf.gemspec'
 
 jobs:
   build:

data/README.md

@@ -1,10 +1,10 @@
-# DSL playground
-[Gush](https://github.com/chaps-io/gush) cloned without [ActiveJob](https://guides.rubyonrails.org/active_job_basics.html) but requried [Sidekiq](https://github.com/mperham/sidekiq). This project is for researching DSL purpose
+# DWF
+Distributed workflow runner following [Gush](https://github.com/chaps-io/gush) interface using [Sidekiq](https://github.com/mperham/sidekiq) and [Redis](https://redis.io/). This project is for researching DSL purpose
 
 # Installation
 ## 1. Add `dwf` to Gemfile
 ```ruby
-gem 'dwf', '~> 0.1.10'
+gem 'dwf', '~> 0.1.12'
 ```
 ## 2. Execute flow example
 ### Declare jobs
@@ -138,15 +138,11 @@ end
   }
 ]
 ```
-## Subworkflow - Only support sidekiq pro
+## Sub workflow
 There might be a case when you want to reuse a workflow in another workflow
 
 As an example, let's write a workflow which contain another workflow, expected that the SubWorkflow workflow execute after `SecondItem` and the `ThirdItem` execute after `SubWorkflow`
 
-```ruby
-gem 'dwf', '~> 0.1.11'
-```
-
 ### Setup
 ```ruby
 class FirstItem < Dwf::Item
@@ -211,7 +207,7 @@ Main flow: ThirtItem finish
 - [x] Redis configurable
 - [x] Pipelining
 - [X] Test
-- [ ] WIP - subworkflow
+- [x] Sub workflow
 - [ ] Support [Resque](https://github.com/resque/resque)
 - [ ] Key value store plugable
   - [ ] research https://github.com/moneta-rb/moneta

data/dwf.gemspec

@@ -6,12 +6,12 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require_relative 'lib/dwf/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "dwf"
+  spec.name          = 'dwf'
   spec.version       = Dwf::VERSION
-  spec.authors       = ["dthtien"]
-  spec.email         = ["tiendt2311@gmail.com"]
+  spec.authors       = ['dthtien']
+  spec.email         = ['tiendt2311@gmail.com']
 
-  spec.summary       = 'Gush cloned without ActiveJob but requried Sidekiq. This project is for researching DSL purpose'
+  spec.summary       = 'Distributed workflow runner following Gush interface using Sidekiq and Redis'
   spec.description   = 'Workflow'
   spec.homepage      = 'https://github.com/dthtien/wf'
   spec.license       = "MIT"

data/lib/dwf/errors.rb

@@ -1,5 +1,3 @@
 module Dwf
   class WorkflowNotFound < StandardError; end
-
-  class UnsupportCallback < StandardError; end
 end

data/lib/dwf/item.rb

@@ -40,6 +40,10 @@ module Dwf
       callback_type == Dwf::Workflow::BUILD_IN
     end
 
+    def workflow
+      @workflow ||= client.find_workflow(workflow_id)
+    end
+
     def reload
       item = client.find_job(workflow_id, name)
       assign_attributes(item.to_hash)
@@ -117,9 +121,11 @@ module Dwf
     end
 
     def enqueue_outgoing_jobs
+      return workflow.enqueue_outgoing_jobs if leaf?
+
       outgoing.each do |job_name|
         client.check_or_lock(workflow_id, job_name)
-        out = client.find_job(workflow_id, job_name)
+        out = client.find_node(job_name, workflow_id)
         out.persist_and_perform_async! if out.ready_to_start?
         client.release_lock(workflow_id, job_name)
       end

data/lib/dwf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dwf
-  VERSION = '0.1.11'
+  VERSION = '0.1.12'
 end

data/lib/dwf/workflow.rb

@@ -3,7 +3,6 @@
 require_relative 'client'
 require_relative 'worker'
 require_relative 'concerns/checkable'
-require_relative 'callback'
 
 module Dwf
   class Workflow
@@ -68,8 +67,6 @@ module Dwf
     alias save persist!
 
     def start!
-      raise UnsupportCallback, 'Sub workflow only works with Sidekiq batch callback' if invalid_callback?
-
       mark_as_started
       persist!
       initial_jobs.each do |job|
@@ -177,6 +174,17 @@ module Dwf
       :running
     end
 
+    def enqueue_outgoing_jobs
+      return unless sub_workflow?
+
+      outgoing.each do |job_name|
+        client.check_or_lock(parent_id, job_name)
+        node = client.find_node(job_name, parent_id)
+        node.persist_and_perform_async! if node.ready_to_start?
+        client.release_lock(parent_id, job_name)
+      end
+    end
+
     def mark_as_persisted
       @persisted = true
     end
@@ -204,7 +212,7 @@ module Dwf
       if klass < Dwf::Workflow
         node = options[:params].nil? ? klass.new : klass.new(options[:params])
         node.parent_id = id
-        node.callback_type = SK_BATCH
+        node.callback_type = callback_type
         node.save
         node
       else

data/spec/dwf/item_spec.rb

@@ -149,37 +149,55 @@ describe Dwf::Item, item: true do
   end
 
   describe '#enqueue_outgoing_jobs' do
-    let(:outgoing) { ["A|#{SecureRandom.uuid}"] }
     let(:client_double) do
       double(
-        find_job: nil,
+        find_node: nil,
         check_or_lock: nil,
-        release_lock: nil
+        release_lock: nil,
+        build_workflow_id: SecureRandom.uuid
       )
     end
-    let(:a_item) do
-      described_class.new(
-        workflow_id: SecureRandom.uuid,
-        id: SecureRandom.uuid,
-        started_at: started_at
-      )
-    end
-    before do
-      allow(Dwf::Client).to receive(:new).and_return client_double
-      allow(a_item).to receive(:persist_and_perform_async!)
-      allow(client_double)
-        .to receive(:find_job).and_return a_item
-      item.enqueue_outgoing_jobs
-    end
 
-    context 'outgoing jobs ready to start' do
-      let(:started_at) { nil }
-      it { expect(a_item).to have_received(:persist_and_perform_async!) }
+    context 'when item is not a leaf' do
+      let(:outgoing) { ["A|#{SecureRandom.uuid}"] }
+      let(:a_item) do
+        described_class.new(
+          workflow_id: SecureRandom.uuid,
+          id: SecureRandom.uuid,
+          started_at: started_at
+        )
+      end
+      before do
+        allow(Dwf::Client).to receive(:new).and_return client_double
+        allow(a_item).to receive(:persist_and_perform_async!)
+        allow(client_double)
+          .to receive(:find_node).and_return a_item
+        item.enqueue_outgoing_jobs
+      end
+
+      context 'outgoing jobs ready to start' do
+        let(:started_at) { nil }
+        it { expect(a_item).to have_received(:persist_and_perform_async!) }
+      end
+
+      context 'outgoing jobs havent ready to start' do
+        let(:started_at) { Time.now.to_i }
+        it { expect(a_item).not_to have_received(:persist_and_perform_async!) }
+      end
     end
 
-    context 'outgoing jobs havent ready to start' do
-      let(:started_at) { Time.now.to_i }
-      it { expect(a_item).not_to have_received(:persist_and_perform_async!) }
+    context 'when item is a leaf' do
+      let(:leaf) { true }
+      let(:workflow) { Dwf::Workflow.new }
+      before do
+        allow(Dwf::Client).to receive(:new).and_return client_double
+        allow(client_double).to receive(:find_workflow).and_return workflow
+        allow(workflow).to receive(:enqueue_outgoing_jobs)
+        item.enqueue_outgoing_jobs
+      end
+
+      let(:started_at) { nil }
+      it { expect(workflow).to have_received(:enqueue_outgoing_jobs) }
     end
   end
 

data/spec/dwf/workflow_spec.rb

@@ -18,7 +18,9 @@ describe Dwf::Workflow, workflow: true do
       build_workflow_id: workflow_id,
       build_job_id: item_id,
       find_workflow: nil,
-      find_node: item
+      find_node: item,
+      check_or_lock: nil,
+      release_lock: nil
     )
   end
   before do
@@ -346,4 +348,35 @@ describe Dwf::Workflow, workflow: true do
       expect(job_callback_types).to eq [described_class::SK_BATCH]
     end
   end
+
+  describe '#enqueue_outgoing_jobs' do
+    let(:outgoing) { ["A|#{SecureRandom.uuid}"] }
+    let!(:workflow) do
+      flow = described_class.new
+      flow.parent_id = SecureRandom.uuid
+      flow.outgoing = outgoing
+      flow
+    end
+    let(:item) do
+      Dwf::Item.new(
+        workflow_id: SecureRandom.uuid,
+        id: SecureRandom.uuid,
+        started_at: started_at
+      )
+    end
+    before do
+      allow(item).to receive(:persist_and_perform_async!)
+      workflow.enqueue_outgoing_jobs
+    end
+
+    context 'outgoing jobs ready to start' do
+      let(:started_at) { nil }
+      it { expect(item).to have_received(:persist_and_perform_async!) }
+    end
+
+    context 'outgoing jobs havent ready to start' do
+      let(:started_at) { Time.now.to_i }
+      it { expect(item).not_to have_received(:persist_and_perform_async!) }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dwf
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - dthtien
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-08 00:00:00.000000000 Z
+date: 2021-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -151,8 +151,7 @@ requirements: []
 rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
-summary: Gush cloned without ActiveJob but requried Sidekiq. This project is for researching
-  DSL purpose
+summary: Distributed workflow runner following Gush interface using Sidekiq and Redis
 test_files:
 - spec/dwf/client_spec.rb
 - spec/dwf/configuration_spec.rb