gush 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc70498c39ad506749bed1f55c139d29691e540b849dd39e2ba132b54b511d66
-  data.tar.gz: 700d093574e0ff4772c7d36bfeb7792cda44550dd162a48afe17bec5551250cd
+  metadata.gz: e588202fe13ded7c99f192bda5bc33d3d6e8994deb3fb17f5a823d4882c4552f
+  data.tar.gz: 759593f344caf579cce496b1da9c64c9431d6f2cbb92cbcced181d49421fdefb
 SHA512:
-  metadata.gz: ac4c1647f57a87600466445a8d24660e3d95016f17adf9e2fe8f99260ba82a2b3e22a339b9456f653834c89c6e4b9ed6bcb50ebc337b804e07355f9a513ce8ca
-  data.tar.gz: 1ae01511acfc2e23bb0a671328a7b3e9b650b8589b9620461c2b9667ff9d80a47f03b8a156f249746b4f69e613863db0833be8d6221acdabd211d7eba2daee15
+  metadata.gz: 5d6068f23d178beb5dbfaa9cf317ae086542dedf33aeab82f82c8cab5a6ea569d932b2dc0a787978629e892a39f25270827c55fa4a6b0a6bb349f9ab87fca1db
+  data.tar.gz: 69ddc27452586d4b188969ece9ab73aefd90377fd93503f3e83c9fd074722d808a09cc620f98953756d7c684bab808db14550c15bada3e93111815613e52b78c

data/.github/workflows/ruby.yml

@@ -26,35 +26,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rails_version: ['4.2.7', '5.1.0', '5.2.0', '6.0.0', '6.1.0', '7.0']
-        ruby-version: ['2.6', '2.7', '3.0', '3.1']
-        exclude:
-          - ruby-version: '3.0'
-            rails_version: '4.2.7'
-          - ruby-version: '3.1'
-            rails_version: '4.2.7'
-          - ruby-version: '3.0'
-            rails_version: '5.0'
-          - ruby-version: '3.1'
-            rails_version: '5.0'
-          - ruby-version: '3.0'
-            rails_version: '5.1'
-          - ruby-version: '3.1'
-            rails_version: '5.1'
-          - ruby-version: '3.0'
-            rails_version: '5.2'
-          - ruby-version: '3.1'
-            rails_version: '5.2'
-          - ruby-version: '3.0'
-            rails_version: '6.0'
-          - ruby-version: '3.1'
-            rails_version: '6.0'
-          - ruby-version: '3.1'
-            rails_version: '6.1'
-          - ruby-version: '2.6'
-            rails_version: '7.0'
+        rails_version: ['6.1.0', '7.0', '7.1.0']
+        ruby-version: ['3.0', '3.1', '3.2', '3.3']
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/README.md

@@ -1,5 +1,9 @@
 # Gush
 
+![Gem Version](https://img.shields.io/gem/v/gush)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/chaps-io/gush/ruby.yml)
+
+
 Gush is a parallel workflow runner using only Redis as storage and [ActiveJob](http://guides.rubyonrails.org/v4.2/active_job_basics.html#introduction) for scheduling and executing jobs.
 
 ## Theory
@@ -15,7 +19,7 @@ This README is about the latest `master` code, which might differ from what is r
 ### 1. Add `gush` to Gemfile
 
 ```ruby
-gem 'gush', '~> 2.0'
+gem 'gush', '~> 3.0'
 ```
 
 ### 2. Create `Gushfile`
@@ -74,7 +78,17 @@ end
 
 and this is how the graph will look like:
 
-![SampleWorkflow](https://i.imgur.com/DFh6j51.png)
+```mermaid
+graph TD
+    A{Start} --> B[FetchJob1]
+    A --> C[FetchJob2]
+    B --> D[PersistJob1]
+    C --> E[PersistJob2]
+    D --> F[NormalizeJob]
+    E --> F
+    F --> G[IndexJob]
+    G --> H{Finish}
+```    
 
 
 ## Defining workflows
@@ -211,7 +225,7 @@ For example, in case of Sidekiq this would be:
 bundle exec sidekiq -q gush
 ```
 
-**[Click here to see backends section in official ActiveJob documentation about configuring backends](http://guides.rubyonrails.org/v4.2/active_job_basics.html#backends)**
+**[Click here to see backends section in official ActiveJob documentation about configuring backends](http://guides.rubyonrails.org/active_job_basics.html#backends)**
 
 **Hint**: gush uses `gush` queue name by default. Keep that in mind, because some backends (like Sidekiq) will only run jobs from explicitly stated queues.
 
@@ -319,7 +333,21 @@ flow = NotifyWorkflow.create([54, 21, 24, 154, 65]) # 5 user ids as an argument
 
 it will generate a workflow with 5 `NotificationJob`s and one `AdminNotificationJob` which will depend on all of them:
 
-![DynamicWorkflow](https://i.imgur.com/HOI3fjc.png)
+
+```mermaid
+graph TD
+    A{Start} --> B[NotificationJob]
+    A --> C[NotificationJob]
+    A --> D[NotificationJob]
+    A --> E[NotificationJob]
+    A --> F[NotificationJob]
+    B --> G[AdminNotificationJob]
+    C --> G
+    D --> G
+    E --> G
+    F --> G
+    G --> H{Finish}
+```
 
 ### Dynamic queue for jobs
 
@@ -338,6 +366,23 @@ class NotifyWorkflow < Gush::Workflow
 end
 ```
 
+### Dynamic waitable time for jobs
+
+There might be a case you want to configure a job to be executed after a time. Based on above example, we want to configure `AdminNotificationJob` to be executed after 5 seconds.
+
+```ruby
+
+class NotifyWorkflow < Gush::Workflow
+  def configure(user_ids)
+    notification_jobs = user_ids.map do |user_id|
+      run NotificationJob, params: {user_id: user_id}, queue: 'user'
+    end
+
+    run AdminNotificationJob, after: notification_jobs, queue: 'admin', wait: 5.seconds
+  end
+end
+```
+
 ## Command line interface (CLI)
 
 ### Checking status

data/gush.gemspec

@@ -2,11 +2,13 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
+require_relative 'lib/gush/version'
+
 Gem::Specification.new do |spec|
   spec.name          = "gush"
-  spec.version       = "2.1.0"
-  spec.authors       = ["Piotrek Okoński"]
-  spec.email         = ["piotrek@okonski.org"]
+  spec.version       = Gush::VERSION
+  spec.authors       = ["Piotrek Okoński", "Michał Krzyżanowski"]
+  spec.email         = ["piotrek@okonski.org", "michal.krzyzanowski+github@gmail.com"]
   spec.summary       = "Fast and distributed workflow runner based on ActiveJob and Redis"
   spec.description   = "Gush is a parallel workflow runner using Redis as storage and ActiveJob for executing jobs."
   spec.homepage      = "https://github.com/chaps-io/gush"
@@ -16,11 +18,12 @@ Gem::Specification.new do |spec|
   spec.executables   = "gush"
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 3.0.0'
 
-  spec.add_dependency "activejob", ">= 4.2.7", "< 7.1"
+  spec.add_dependency "activejob", ">= 6.1.0", "< 7.2"
   spec.add_dependency "concurrent-ruby", "~> 1.0"
   spec.add_dependency "multi_json", "~> 1.11"
-  spec.add_dependency "redis", ">= 3.2", "< 5"
+  spec.add_dependency "redis", ">= 3.2", "< 6"
   spec.add_dependency "redis-mutex", "~> 4.0.1"
   spec.add_dependency "hiredis", "~> 0.6"
   spec.add_dependency "graphviz", "~> 1.2"
@@ -29,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "thor", ">= 0.19", "< 1.3"
   spec.add_dependency "launchy", "~> 2.4"
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake", "~> 10.4"
+  spec.add_development_dependency "rake", "~> 12"
   spec.add_development_dependency "rspec", '~> 3.0'
   spec.add_development_dependency "pry", '~> 0.10'
 end

data/lib/gush/client.rb

@@ -156,8 +156,13 @@ module Gush
       job.enqueue!
       persist_job(workflow_id, job)
       queue = job.queue || configuration.namespace
-
-      Gush::Worker.set(queue: queue).perform_later(*[workflow_id, job.name])
+      wait = job.wait
+      
+      if wait.present?
+        Gush::Worker.set(queue: queue, wait: wait).perform_later(*[workflow_id, job.name])
+      else
+        Gush::Worker.set(queue: queue).perform_later(*[workflow_id, job.name])
+      end
     end
 
     private

data/lib/gush/job.rb

@@ -1,7 +1,8 @@
 module Gush
   class Job
     attr_accessor :workflow_id, :incoming, :outgoing, :params,
-      :finished_at, :failed_at, :started_at, :enqueued_at, :payloads, :klass, :queue
+      :finished_at, :failed_at, :started_at, :enqueued_at, :payloads, 
+      :klass, :queue, :wait 
     attr_reader :id, :klass, :output_payload, :params
 
     def initialize(opts = {})
@@ -126,6 +127,7 @@ module Gush
       @output_payload = opts[:output_payload]
       @workflow_id    = opts[:workflow_id]
       @queue          = opts[:queue]
+      @wait           = opts[:wait]
     end
   end
 end

data/lib/gush/version.rb

@@ -0,0 +1,3 @@
+module Gush
+  VERSION = '3.0.0'
+end

data/lib/gush/workflow.rb

@@ -112,7 +112,8 @@ module Gush
         workflow_id: id,
         id: client.next_free_job_id(id, klass.to_s),
         params: opts.fetch(:params, {}),
-        queue: opts[:queue]
+        queue: opts[:queue],
+        wait: opts[:wait]
       })
 
       jobs << node

data/spec/features/integration_spec.rb

@@ -5,9 +5,10 @@ describe "Workflows" do
   context "when all jobs finish successfuly" do
     it "marks workflow as completed" do
       flow = TestWorkflow.create
-      perform_enqueued_jobs do
-        flow.start!
-      end
+
+      ActiveJob::Base.queue_adapter.perform_enqueued_jobs = true
+      flow.start!
+      ActiveJob::Base.queue_adapter.perform_enqueued_jobs = false
 
       flow = flow.reload
       expect(flow).to be_finished

data/spec/gush/client_spec.rb

@@ -37,6 +37,18 @@ describe Gush::Client do
   end
 
   describe "#start_workflow" do
+    context "when there is wait parameter configured" do
+      let(:freeze_time) { Time.utc(2023, 01, 21, 14, 36, 0) }
+
+      it "schedules job execution" do
+        travel_to freeze_time do
+          workflow = WaitableTestWorkflow.create
+          client.start_workflow(workflow)
+          expect(Gush::Worker).to have_a_job_enqueued_at(workflow.id, job_with_id("Prepare"), 5.minutes)
+        end
+      end
+    end
+
     it "enqueues next jobs from the workflow" do
       workflow = TestWorkflow.create
       expect {
@@ -113,7 +125,7 @@ describe Gush::Client do
   describe "#persist_job" do
     it "persists JSON dump of the job in Redis" do
 
-      job = BobJob.new(name: 'bob')
+      job = BobJob.new(name: 'bob', id: 'abcd123')
 
       client.persist_job('deadbeef', job)
       expect(redis.keys("gush.jobs.deadbeef.*").length).to eq(1)

data/spec/gush/workflow_spec.rb

@@ -121,6 +121,13 @@ describe Gush::Workflow do
       expect(flow.jobs.first.params).to eq ({ something: 1 })
     end
 
+    it "allows passing wait param to the job" do
+      flow = Gush::Workflow.new
+      flow.run(Gush::Job, wait: 5.seconds)
+      flow.save
+      expect(flow.jobs.first.wait).to eq (5.seconds)
+    end
+
     context "when graph is empty" do
       it "adds new job with the given class as a node" do
         flow = Gush::Workflow.new

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+require 'active_support'
+require 'active_support/testing/time_helpers'
 require 'gush'
 require 'json'
 require 'pry'
@@ -34,6 +36,11 @@ class ParameterTestWorkflow < Gush::Workflow
   end
 end
 
+class WaitableTestWorkflow < Gush::Workflow
+  def configure
+    run Prepare, wait: 5.minutes
+  end
+end
 
 REDIS_URL = ENV["REDIS_URL"] || "redis://localhost:6379/12"
 
@@ -86,7 +93,22 @@ RSpec::Matchers.define :have_no_jobs do |flow, jobs|
   end
 end
 
+RSpec::Matchers.define :have_a_job_enqueued_at do |flow, job, at|
+  expected_execution_timestamp = (Time.current.utc + at).to_i
+
+  match do |actual|
+    expected = hash_including(args: include(flow, job), at: expected_execution_timestamp)
+
+    expect(ActiveJob::Base.queue_adapter.enqueued_jobs).to match_array(expected)
+  end
+
+  failure_message do |actual|
+    "expected to have enqueued job #{job} to be executed at #{Time.current.utc + at}, but instead has: #{Time.at(enqueued_jobs.first[:at]).to_datetime.utc}"
+  end
+end
+
 RSpec.configure do |config|
+  config.include ActiveSupport::Testing::TimeHelpers
   config.include ActiveJob::TestHelper
   config.include GushHelpers
 

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: gush
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Piotrek Okoński
+- Michał Krzyżanowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-19 00:00:00.000000000 Z
+date: 2024-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -16,20 +17,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.7
+        version: 6.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.7
+        version: 6.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +68,7 @@ dependencies:
         version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -77,7 +78,7 @@ dependencies:
         version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: redis-mutex
   requirement: !ruby/object:Gem::Requirement
@@ -208,14 +209,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -248,6 +249,7 @@ description: Gush is a parallel workflow runner using Redis as storage and Activ
   for executing jobs.
 email:
 - piotrek@okonski.org
+- michal.krzyzanowski+github@gmail.com
 executables:
 - gush
 extensions: []
@@ -272,6 +274,7 @@ files:
 - lib/gush/graph.rb
 - lib/gush/job.rb
 - lib/gush/json.rb
+- lib/gush/version.rb
 - lib/gush/worker.rb
 - lib/gush/workflow.rb
 - spec/Gushfile
@@ -298,14 +301,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Fast and distributed workflow runner based on ActiveJob and Redis