rocketjob 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6715f9b19c04ee07962197db8e635e9e5e74b1e1dbd9e3add5239d235c5dd218
-  data.tar.gz: 5c501260e0e328691f668325ff48e88ea5da86f49f6a739343b5bf24569aee75
+  metadata.gz: fe39da29017eca601c104ca9d7c4fa90f903c32cbf3822e064cbd4a7f0780272
+  data.tar.gz: ce81cfb0d3a0ac4dbfe4ebe7c549077e56ca52d19ca41a2fda150561ecfeedd7
 SHA512:
-  metadata.gz: db9890e678c9e2cb97c6f8faf25e8115f5946017ed3dc0fc3f208a62c2765fabb2c5f7673c9850b6202c61bd312c0e535944609e21e3dbbfd514eff2a50ffa0a
-  data.tar.gz: ede6fbe558cb428c3291bba1584d32dffcc65c6889ab90753e1a79ce33713410b071e2db44bf5007119ba0a83867e2d42485f1b16bfa4070b0a36e7ca89bbf13
+  metadata.gz: fa49046d738a5064da99363e0d854253d17c375ab1e75b095c118139d9081781b9e4177bc03cf70abd4edb906b43cdc033b96234bd5864b5f9959e81f1421074
+  data.tar.gz: 5e67742618a4ec874a1c43649d8619cec007380f8db84a3a81f584ec6f9896be0e14e062e69955158732b32e419a8ac7bfab9eef394c983a9f484a9c5c04c934

data/README.md

@@ -3,9 +3,9 @@
 
 Ruby's missing batch system
 
-Checkout http://rocketjob.io/
+Checkout https://rocketjob.io/
 
-![Rocket Job](http://rocketjob.io/images/rocket/rocket-icon-512x512.png)
+![Rocket Job](https://rocketjob.io/images/rocket/rocket-icon-512x512.png)
 
 ## Documentation
 

data/lib/rocket_job/batch.rb

@@ -24,6 +24,7 @@ module RocketJob
     autoload :LowerPriority, "rocket_job/batch/lower_priority"
     autoload :Performance, "rocket_job/batch/performance"
     autoload :Statistics, "rocket_job/batch/statistics"
+    autoload :ThrottleWindows, "rocket_job/batch/throttle_windows"
     autoload :Result, "rocket_job/batch/result"
     autoload :Results, "rocket_job/batch/results"
     autoload :Tabular, "rocket_job/batch/tabular"

data/lib/rocket_job/batch/io.rb

@@ -18,7 +18,7 @@ module RocketJob
           raise "Category #{category.inspect}, must be registered in input_categories: #{input_categories.inspect}"
         end
 
-        (@inputs ||= {})[category] ||= RocketJob::Sliced::Input.new(rocket_job_io_slice_arguments("inputs", category))
+        (@inputs ||= {})[category] ||= RocketJob::Sliced::Input.new(**rocket_job_io_slice_arguments("inputs", category))
       end
 
       # Returns [RocketJob::Sliced::Output] output collection for holding output slices
@@ -34,7 +34,7 @@ module RocketJob
           raise "Category #{category.inspect}, must be registered in output_categories: #{output_categories.inspect}"
         end
 
-        (@outputs ||= {})[category] ||= RocketJob::Sliced::Output.new(rocket_job_io_slice_arguments("outputs", category))
+        (@outputs ||= {})[category] ||= RocketJob::Sliced::Output.new(**rocket_job_io_slice_arguments("outputs", category))
       end
 
       # Upload the supplied file, io, IOStreams::Path, or IOStreams::Stream.

data/lib/rocket_job/batch/throttle.rb

@@ -6,7 +6,7 @@ module RocketJob
     #
     # Example:
     #   # Do not run any slices for this job when the MySQL slave delay exceeds 5 minutes.
-    #   class MyJob < RocketJob
+    #   class MyJob < RocketJob::Job
     #     include RocketJob::Batch
     #
     #     # Define a custom mysql throttle

data/lib/rocket_job/batch/throttle_running_workers.rb

@@ -5,7 +5,7 @@ module RocketJob
     # Throttle the number of slices of a specific batch job that are processed at the same time.
     #
     # Example:
-    #   class MyJob < RocketJob
+    #   class MyJob < RocketJob::Job
     #     include RocketJob::Batch
     #
     #     # Maximum number of slices to process at the same time for each running instance.

data/lib/rocket_job/batch/throttle_windows.rb

@@ -0,0 +1,67 @@
+require "active_support/concern"
+
+module RocketJob
+  module Batch
+    # For a batch job that can run over a long period of time it can be useful
+    # to prevent its slices from being processed outside a predefined processing window.
+    #
+    # This plugin supports up to 2 different processing windows.
+    #
+    # For example, do not run this job during business hours.
+    # Allow it to run from 5pm until 8am the following day Mon through Fri.
+    #
+    #   class AfterHoursJob < RocketJob::Job
+    #     include RocketJob::Batch
+    #     include RocketJob::Batch::ThrottleWindows
+    #
+    #     # Monday through Thursday the job can start processing at 5pm Eastern.
+    #     self.primary_schedule = "0 17 * * 1-4 America/New_York"
+    #     # Slices are allowed to run until 8am the following day, which is 15 hours long:
+    #     self.primary_duration = 15.hours
+    #
+    #     # The slices for this job can run all weekend long, starting Friday at 5pm Eastern.
+    #     self.secondary_schedule = "0 17 * * 5 America/New_York"
+    #     # Slices are allowed to run until 8am on Monday morning, which is 63 hours long:
+    #     self.secondary_duration = 63.hours
+    #   end
+    #
+    # Notes:
+    # * These schedules do not affect when the job is started, completed, or when `before_batch` or
+    #   `after_batch` processing is performed. It only limits when individual slices are processed.
+    module ThrottleWindows
+      extend ActiveSupport::Concern
+
+      included do
+        # Beginning of the primary schedule. In cron format, see Scheduled Jobs `cron_schedule` for examples.
+        field :primary_schedule, type: String, class_attribute: true, user_editable: true, copy_on_restart: true
+        # Duration in seconds of the primary window.
+        field :primary_duration, type: Integer, class_attribute: true, user_editable: true, copy_on_restart: true
+
+        # Beginning of the secondary schedule. In cron format, see Scheduled Jobs `cron_schedule` for examples.
+        field :secondary_schedule, type: String, class_attribute: true, user_editable: true, copy_on_restart: true
+        # Duration in seconds of the secondary window.
+        field :secondary_duration, type: Integer, class_attribute: true, user_editable: true, copy_on_restart: true
+
+        define_batch_throttle :throttle_windows_exceeded?, filter: :throttle_filter_id
+      end
+
+      private
+
+      def throttle_windows_exceeded?
+        exceeded = primary_schedule && primary_duration && throttle_outside_window?(primary_schedule, primary_duration)
+        if exceeded && secondary_schedule && secondary_duration
+          exceeded = throttle_outside_window?(secondary_schedule, secondary_duration)
+        end
+        exceeded
+      end
+
+      def throttle_outside_window?(schedule, duration)
+        cron = Plugins::Rufus::CronLine.new(schedule)
+        time = Time.now + 1
+        # Add 1 second since right now could be the very beginning of the processing window.
+        previous_time = cron.previous_time(time).to_time
+        previous_time + duration < time
+      end
+    end
+  end
+end

data/lib/rocket_job/batch/worker.rb

@@ -28,10 +28,6 @@ module RocketJob
       #
       # If an exception was thrown the entire slice of records is marked as failed.
       #
-      # If the mongo_ha gem has been loaded, then the connection to mongo is
-      # automatically re-established and the job will resume anytime a
-      # Mongo connection failure occurs.
-      #
       # Thread-safe, can be called by multiple threads at the same time
       def rocket_job_work(worker, re_raise_exceptions = false)
         raise "Job must be started before calling #rocket_job_work" unless running?

data/lib/rocket_job/plugins/job/throttle.rb

@@ -7,7 +7,7 @@ module RocketJob
       #
       # Example:
       #   # Do not run this job when the MySQL slave delay exceeds 5 minutes.
-      #   class MyJob < RocketJob
+      #   class MyJob < RocketJob::Job
       #     # Define a custom mysql throttle
       #     # Prevents all jobs of this class from running on the current server.
       #     define_throttle :mysql_throttle_exceeded?

data/lib/rocket_job/plugins/job/throttle_running_jobs.rb

@@ -6,7 +6,7 @@ module RocketJob
       # Throttle the number of jobs of a specific class that are processed at the same time.
       #
       # Example:
-      #   class MyJob < RocketJob
+      #   class MyJob < RocketJob::Job
       #     # Maximum number of jobs of this class to process at the same time.
       #     self.throttle_running_jobs = 25
       #

data/lib/rocket_job/version.rb

@@ -1,3 +1,3 @@
 module RocketJob
-  VERSION = "5.2.0".freeze
+  VERSION = "5.3.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rocketjob
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-30 00:00:00.000000000 Z
+date: 2020-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aasm
@@ -124,6 +124,7 @@ files:
 - lib/rocket_job/batch/tabular/output.rb
 - lib/rocket_job/batch/throttle.rb
 - lib/rocket_job/batch/throttle_running_workers.rb
+- lib/rocket_job/batch/throttle_windows.rb
 - lib/rocket_job/batch/worker.rb
 - lib/rocket_job/cli.rb
 - lib/rocket_job/config.rb
@@ -211,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby's missing batch processing system.