parallel_workforce 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2faae1c8d652df656ef1a625fb048207f340ef86
-  data.tar.gz: 197ca9d26aca9c1db4ced4d7266974a870978a9f
+SHA256:
+  metadata.gz: 9ef8716bb08d920fb76459016cdb615f50d89e5604066ff01ad723d2b4fb03b4
+  data.tar.gz: 6263caa320d791299cfe76e399f26c23d49414ca8536cef25358fc10dfc5f8a3
 SHA512:
-  metadata.gz: 86399e51585659405aae9774eac587c493f1f4acd5779077235f89c9eaf41f71a3cd1f7894d3addb97a8afb9f9b9ccc9aeafda0f15f73d6f2e345fda26042ad6
-  data.tar.gz: 10e835470259ae517cf383e19b517e318249ec542bdf1e7e701e197f8706b329069f243877542e7e39cf54559bc2f31ecb38bfa8bd0464f5400f20c21cb6ee83
+  metadata.gz: 9bb0c64bd4fa27720d5db3d174cee1d2954ffba8cbdcc7153c1f644eada79440a8340a49f703f3a32cabb12f6bfbd71f7b9a7a64d7667b9c69a75b54be035b6e
+  data.tar.gz: 2529e7806726359ecd5ca4c5c994863b57eb029576bd1e94577f2dbe658df0cccdccd3a45909384fd6551c2b0b59fb4fb11f1e5a8f3ebf619226a1a2fe2c9e12

data/.gitignore

@@ -6,4 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+/parallel_workforce*.gem
 **/tags

data/.rubocop_parallel_workforce.yml

@@ -135,7 +135,13 @@ Style/GuardClause:
 Style/IfUnlessModifier:
   Enabled: false
 
-Layout/IndentArray:
+Layout/IndentFirstArgument:
+  Enabled: false
+
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+
+Layout/IndentFirstArrayElement:
   EnforcedStyle: consistent
 
 Layout/MultilineOperationIndentation:

data/.ruby-version

@@ -1 +1 @@
-ruby-2.3.5
+ruby-2.6.6

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 2.0.0
+
+* Ruby version tested is 2.6.6.
+* Include result_values as part of TimeoutError to allow access to partial results that did not timeout.
+* Default to using JsonMarshal serialization that serializes as a JSON string for Sidekiq compataibility.
+
+## 1.0.0
+
+* RubyGems version 1.
+
 ## 0.2.0
 
 * Add optional execution block to `ParallelWorkforce.perform_all` that is evaluated in calling thread after jobs enqueued,

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    parallel_workforce (0.2.0)
+    parallel_workforce (2.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,7 +2,7 @@
 
 Easily parallelize functionality by partitioning work in either a Sidekiq (preferred) or ActiveJob worker pool.
 
-See more info at the EnjoyTech blog.
+See more info on [why Enjoy created this Gem](https://medium.com/enjoy-engineering/ruby-and-rails-can-be-as-fast-as-you-need-if-you-execute-in-parallel-632f2dff5429) at the [EnjoyTech blog](https://medium.com/enjoy-engineering).
 
 ## Installation
 
@@ -92,7 +92,7 @@ end
 * `logger` - Defaults to `Rails.logger` if `Rails` is loaded.
 * `revision_builder` - Used to determine if the calling thread and worker have a different revision of code. Defaults to a class that builds a hash from the contents of all `.rb` files contained within the current working directory.
 * `serial_mode_checker` - An object with an `execute_serially?` method that allows forcing Actors to execute in calling thread instead of in workers. This can be used to turn off parallel execution globally. Default is `nil`.
-* `serializer` - An object with a `serialize(object)` method that returns a `String` and `deserialize(string)` method that returns an `Object`. Default imlementation uses `Marshal.dump` and `Marshal.load`.
+* `serializer` - An object with a `serialize(object)` method that returns a `String` and `deserialize(string)` method that returns an `Object`. Default imlementation uses `Marshal.dump` and `Marshal.load` and serializes as a JSON string for Sidekiq compatibility.
 * `redis_connector` - An object with a `with` method that yields a Redis connection. Defaults to `ParallelWorkforce::RedisConnector::RedisPool`. If using Sidekiq, it's best to use `ParallelWorkforce::RedisConnector::SidekiqRedisPool`.
 * `job_timeout` - Time allowed to execte a job before timing out. Default is `10` seconds.
 * `job_key_expiration` - Time allowed for result key in Redis to remain before it expires. This should be larger than `job_timeout`. Default is `20` seconds.

data/lib/parallel_workforce.rb

@@ -4,7 +4,15 @@ module ParallelWorkforce
   Error = Class.new(StandardError)
   ActorPerformError = Class.new(Error)
   ActorNotFoundError = Class.new(Error)
-  TimeoutError = Class.new(Error)
+  TimeoutError = Class.new(Error) do
+    attr_reader :result_values
+
+    def initialize(message, result_values=nil)
+      @result_values = result_values
+
+      super(message)
+    end
+  end
   SerializerError = Class.new(Error)
 
   class << self

data/lib/parallel_workforce/configuration.rb

@@ -18,7 +18,7 @@ module ParallelWorkforce
       @logger = defined?(Rails) && Rails.logger
       @revision_builder = ParallelWorkforce::RevisionBuilder::FilesHash.new
       @serial_mode_checker = nil
-      @serializer = ParallelWorkforce::Serializer::Marshal.new
+      @serializer = ParallelWorkforce::Serializer::JsonMarshal.new
       @redis_connector = ParallelWorkforce::RedisConnector::RedisPool.new
       @job_timeout = 10
       @job_key_expiration = 20

data/lib/parallel_workforce/executor.rb

@@ -180,7 +180,7 @@ module ParallelWorkforce
           Timeout.timeout(configuration.job_timeout) do
             until result_count == num_results
               _key, response = redis.blpop(result_key, configuration.job_timeout)
-              raise ParallelWorkforce::TimeoutError.new("Timeout waiting for Redis#blpop") if response.nil?
+              raise ParallelWorkforce::TimeoutError.new("Timeout waiting for Redis#blpop", result_values) if response.nil?
 
               result_count += 1
 
@@ -190,7 +190,7 @@ module ParallelWorkforce
             end
           end
         rescue Timeout::Error
-          raise ParallelWorkforce::TimeoutError.new("Timeout from ParallelWorkforce job")
+          raise ParallelWorkforce::TimeoutError.new("Timeout from ParallelWorkforce job", result_values)
         end
       end
 

data/lib/parallel_workforce/requires.rb

@@ -5,6 +5,7 @@ require_relative "job/util/performer"
 require_relative "redis_connector/redis_pool"
 require_relative "revision_builder/files_hash"
 require_relative "serializer/marshal"
+require_relative "serializer/json_marshal"
 
 # rubocop:disable Lint/HandleExceptions
 begin

data/lib/parallel_workforce/serializer/json_marshal.rb

@@ -0,0 +1,17 @@
+module ParallelWorkforce
+  module Serializer
+    class JsonMarshal < Marshal
+      def serialize(object)
+        JSON.dump(value: super(object)) # super always returns a String
+      end
+
+      def deserialize(string)
+        super(JSON.parse(string)['value'])
+      rescue JSON::ParserError => e
+        ParallelWorkforce.log(:warn, "#{self.class}: Unable to deserialize string: #{e}", e, *e.backtrace)
+
+        raise ParallelWorkforce::SerializerError.new("Unable to deserialize string: #{e}")
+      end
+    end
+  end
+end

data/lib/parallel_workforce/version.rb

@@ -1,3 +1,3 @@
 module ParallelWorkforce
-  VERSION = "1.0.0".freeze
+  VERSION = "2.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parallel_workforce
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Michael Pearce
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-05-21 00:00:00.000000000 Z
+date: 2020-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -168,6 +168,7 @@ files:
 - lib/parallel_workforce/redis_connector/sidekiq_redis_pool.rb
 - lib/parallel_workforce/requires.rb
 - lib/parallel_workforce/revision_builder/files_hash.rb
+- lib/parallel_workforce/serializer/json_marshal.rb
 - lib/parallel_workforce/serializer/marshal.rb
 - lib/parallel_workforce/version.rb
 - parallel_workforce.gemspec
@@ -178,7 +179,7 @@ metadata:
   homepage_uri: https://github.com/EnjoyTech/parallel_workforce
   source_code_uri: https://github.com/EnjoyTech/parallel_workforce
   changelog_uri: https://github.com/EnjoyTech/parallel_workforce/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -193,9 +194,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Simplify parallel code execution into workers
 test_files: []