dwf 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb0f6f6f30b7ed1ba19120a4a1f77e450940e45433153de51f47df9f108d0fae
-  data.tar.gz: e0e86fdd169b7cbcdc811cf62f87b3043fbbd708bdf0f41fb006b392e4ab784b
+  metadata.gz: 395f410168239441a56db548cccc50d729433bedcc9fd0d4c3ae15fea09c1019
+  data.tar.gz: 5a944cc497760afe6b92f38772d594d56f15837ab51495609dba24f7578af309
 SHA512:
-  metadata.gz: 4a3770d4d7f63b7ede02d59e1ce43cb2634b39cbd9e037c920e4f816acb7b393de0f9030fda735e8ea0873f3679da120ff405f725e87c60c1b9eb6a7fbf355e3
-  data.tar.gz: 469e25cdf11441c59c80ff47197dcabcf40e0b086ab06babb6b39a0597483517c479ee9ea65767819b69afebf83db6dcdb5926a9839a2e40d02c03cf39a6eb57
+  metadata.gz: 0123f65c0242c905c93e0998365a43b4193432c6e5b74af4a33422e7b489424294a70c68cf4e42feb627ecc038429e0dba6dc54af80acd1dc7628c2b56ff532c
+  data.tar.gz: 674a7144dc944d878cfddb549254985dc0a136fd84069df184a44c8a375f6ccc47e9be3d6b445f6bfcc83af8f52ed6b23fa9687f23714e49b30e24a6bbdea1de

data/CHANGELOG.md

@@ -1,5 +1,47 @@
 # Changelog
 All notable changes to this project will be documented in this file.
+## 0.1.8
+### Added
+- add pinlining feature
+
+```ruby
+class SendOutput < Dwf::Item
+  def perform
+    output('it works')
+  end
+end
+
+```
+
+`output` method used to output data from the job to add outgoing jobs
+
+```ruby
+class ReceiveOutput < Dwf::Item
+  def perform
+    message = payloads.first[:output] # it works
+  end
+end
+```
+
+`payloads` is an array that containing outputs from incoming jobs
+
+```
+[
+  {
+    id: "SendOutput|1849a3f9-5fce-401e-a73a-91fc1048356",
+    class: "SendOutput",
+    output: 'it works'
+  }
+]
+```
+
+```ruby
+Dwf.config do |config|
+  config.opts = { url 'redis://127.0.0.1:6379' }
+  config.namespace = 'dwf'
+end
+```
+
 ## 0.1.7
 ### Added
 - Allow to config redis and queue

data/README.md

@@ -83,6 +83,39 @@ Dwf.config do |config|
 end
 ```
 
+# Pinelining
+You can pass jobs result to next nodes
+
+```ruby
+class SendOutput < Dwf::Item
+  def perform
+    output('it works')
+  end
+end
+
+```
+
+`output` method used to output data from the job to add outgoing jobs
+
+```ruby
+class ReceiveOutput < Dwf::Item
+  def perform
+    message = payloads.first[:output] # it works
+  end
+end
+```
+
+`payloads` is an array that containing outputs from incoming jobs
+
+```ruby
+[
+  {
+    id: "SendOutput|1849a3f9-5fce-401e-a73a-91fc1048356",
+    class: "SendOutput",
+    output: 'it works'
+  }
+]
+```
 
 # Todo
 - [x] Make it work

data/dwf.gemspec

@@ -3,11 +3,10 @@
 
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require_relative 'lib/dwf/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "dwf"
-  spec.version       = Dwf::VERSION
+  spec.version       = '0.1.8'
   spec.authors       = ["dthtien"]
   spec.email         = ["tiendt2311@gmail.com"]
 

data/lib/dwf/item.rb

@@ -5,22 +5,11 @@ require_relative 'client'
 module Dwf
   class Item
     attr_reader :workflow_id, :id, :params, :queue, :klass, :started_at,
-      :enqueued_at, :finished_at, :failed_at, :callback_type
+      :enqueued_at, :finished_at, :failed_at, :callback_type, :output_payload
     attr_accessor :incoming, :outgoing
 
     def initialize(options = {})
-      @workflow_id = options[:workflow_id]
-      @id = options[:id]
-      @params = options[:params]
-      @queue = options[:queue]
-      @incoming = options[:incoming] || []
-      @outgoing = options[:outgoing] || []
-      @klass = options[:klass] || self.class
-      @failed_at = options[:failed_at]
-      @finished_at = options[:finished_at]
-      @enqueued_at = options[:enqueued_at]
-      @started_at = options[:started_at]
-      @callback_type = options[:callback_type]
+      assign_attributes(options)
     end
 
     def self.from_hash(hash)
@@ -39,6 +28,11 @@ module Dwf
       callback_type == Dwf::Workflow::BUILD_IN
     end
 
+    def reload
+      item = client.find_job(workflow_id, name)
+      assign_attributes(item.to_hash)
+    end
+
     def perform_async
       Dwf::Worker.set(queue: queue || client.config.namespace)
                  .perform_async(workflow_id, name)
@@ -48,6 +42,10 @@ module Dwf
       @name ||= "#{klass}|#{id}"
     end
 
+    def output(data)
+      @output_payload = data
+    end
+
     def no_dependencies?
       incoming.empty?
     end
@@ -58,6 +56,17 @@ module Dwf
       end
     end
 
+    def payloads
+      incoming.map do |job_name|
+        job = client.find_job(workflow_id, job_name)
+        {
+          id: job.name,
+          class: job.klass.to_s,
+          output: job.output_payload
+        }
+      end
+    end
+
     def enqueue!
       @enqueued_at = current_timestamp
       @started_at = nil
@@ -142,7 +151,8 @@ module Dwf
         failed_at: failed_at,
         params: params,
         workflow_id: workflow_id,
-        callback_type: callback_type
+        callback_type: callback_type,
+        output_payload: output_payload
       }
     end
 
@@ -159,5 +169,21 @@ module Dwf
     def client
       @client ||= Dwf::Client.new
     end
+
+    def assign_attributes(options)
+      @workflow_id = options[:workflow_id]
+      @id = options[:id]
+      @params = options[:params]
+      @queue = options[:queue]
+      @incoming = options[:incoming] || []
+      @outgoing = options[:outgoing] || []
+      @klass = options[:klass] || self.class
+      @failed_at = options[:failed_at]
+      @finished_at = options[:finished_at]
+      @enqueued_at = options[:enqueued_at]
+      @started_at = options[:started_at]
+      @callback_type = options[:callback_type]
+      @output_payload = options[:output_payload]
+    end
   end
 end

data/lib/dwf/version.rb

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

data/lib/dwf/worker.rb

@@ -9,7 +9,7 @@ module Dwf
 
     def perform(workflow_id, job_name)
       job = client.find_job(workflow_id, job_name)
-      return job.enqueue_outgoing_jobs if job. succeeded?
+      return job.enqueue_outgoing_jobs if job.succeeded?
 
       job.mark_as_started
       job.perform

data/spec/dwf/item_spec.rb

@@ -181,4 +181,40 @@ describe Dwf::Item, item: true do
       it { expect(a_item).not_to have_received(:persist_and_perform_async!) }
     end
   end
+
+  describe '#output' do
+    before { item.output(1) }
+
+    it { expect(item.output_payload).to eq 1 }
+  end
+
+  describe '#payloads' do
+    let(:incoming) { ["A|#{SecureRandom.uuid}"] }
+    let(:client_double) { double(find_job: nil) }
+    let!(:a_item) do
+      described_class.new(
+        workflow_id: SecureRandom.uuid,
+        id: SecureRandom.uuid,
+        finished_at: finished_at,
+        output_payload: 1
+      )
+    end
+
+    before do
+      allow(Dwf::Client).to receive(:new).and_return client_double
+      allow(client_double)
+        .to receive(:find_job).and_return a_item
+    end
+
+    it do
+      expected_payload = [
+        {
+          class: a_item.class.name,
+          id: a_item.name,
+          output: 1
+        }
+      ]
+      expect(item.payloads).to eq expected_payload
+    end
+  end
 end

data/spec/dwf/worker_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'mock_redis'
+require 'sidekiq/testing'
+
+describe Dwf::Worker, client: true do
+  let(:workflow_id) { SecureRandom.uuid }
+  let(:id) { SecureRandom.uuid }
+  let(:redis) { Redis.new }
+  let(:worker) { described_class.perform_async(workflow_id, job.name) }
+  before do
+    redis_instance = MockRedis.new
+    allow(Redis).to receive(:new).and_return redis_instance
+  end
+
+  describe '#find_job' do
+    let!(:job) do
+      j = Dwf::Item.new(workflow_id: workflow_id, id: id)
+      j.persist!
+      j
+    end
+
+    before do
+      worker
+      Sidekiq::Worker.drain_all
+      job.reload
+    end
+
+    it { expect(job.finished?).to be_truthy }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dwf
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - dthtien
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-08 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -110,6 +110,7 @@ files:
 - spec/dwf/configuration_spec.rb
 - spec/dwf/item_spec.rb
 - spec/dwf/utils_spec.rb
+- spec/dwf/worker_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/dthtien/wf
 licenses:
@@ -140,4 +141,5 @@ test_files:
 - spec/dwf/configuration_spec.rb
 - spec/dwf/item_spec.rb
 - spec/dwf/utils_spec.rb
+- spec/dwf/worker_spec.rb
 - spec/spec_helper.rb