job-iteration 1.1.10 → 1.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7868f8da1aee096abee4d4a1848c2242d0a7ac9bb1b456ad8385cfe6421a902e
-  data.tar.gz: fd82a4cdfcbff16220363e1c53aa064b0cd5e599e17290aa968fdb01d8fe4002
+  metadata.gz: 18324439fe7b98c7f1bca543c078ddbfdff18af5a7e97a87b21b48890e919769
+  data.tar.gz: 3d912ea06a5a66ee841fbd605e8dfc414bd1760c61d9edf74445e79ae16a6466
 SHA512:
-  metadata.gz: 42a601bb25a38571c97d108a8847317892a5289e2d3f8d818b68c99a49fc6d142dffcdd9191350261a89db65bf24aa3b0691057238f2416e2a0140bf16c47485
-  data.tar.gz: 364868992c7fe4602f31d453891f4597d73d0b7b76482510d7ae9d3d3de7baf951465c5df7fcf9923592abb05b3584a9206f104bd610ab52dbbf3625c03be3f6
+  metadata.gz: 622368d1208ea23014188c028f832f51f899b6bdfbca8938c6396dcca48f913679ee7f41a035c5cbe0376346ea40a583c4615bd665251cf7dc36a30aeb37904a
+  data.tar.gz: 51931d565cffb4600141e1e96dc9a1a6b8a522589c8b0b38dc4cd1846e8d59a9f150d0d0bfcde4aaee587478af57418093a9e313b2f17c9f2c54ffb6cf18382a

data/.github/workflows/{ruby.yml → ci.yml}

@@ -1,11 +1,11 @@
-name: Ruby
+name: CI
 
 on: [push]
 
 jobs:
   build:
     runs-on: ubuntu-latest
-    name: Ruby ${{ matrix.ruby }}
+    name: Ruby ${{ matrix.ruby }} | Gemfile ${{ matrix.gemfile }}
     services:
       redis:
         image: redis

data/CHANGELOG.md

@@ -4,13 +4,20 @@
 
 #### Bug fix
 
+
+## v1.1.11 (April 19, 2021)
+
+#### Bug fix
+
+- [73](https://github.com/Shopify/job-iteration/pull/73) - Enforce cursor be serializable
+
 ## v1.1.10 (March 30, 2021)
 
-- [69](https://github.com/Shopify/job-iteration/pull/69) Fix memory leak in ActiveRecordCursor
+- [69](https://github.com/Shopify/job-iteration/pull/69) - Fix memory leak in ActiveRecordCursor
 
 ## v1.1.9 (January 6, 2021)
 
-- [61](https://github.com/Shopify/job-iteration/pull/61) Call `super` in `method_added`
+- [61](https://github.com/Shopify/job-iteration/pull/61) - Call `super` in `method_added`
 
 ## v1.1.8 (June 8, 2020)
 

data/lib/job-iteration/iteration.rb

@@ -6,6 +6,28 @@ module JobIteration
   module Iteration
     extend ActiveSupport::Concern
 
+    class CursorError < ArgumentError
+      attr_reader :cursor
+
+      def initialize(message, cursor:)
+        super(message)
+        @cursor = cursor
+      end
+
+      def message
+        "#{super} (#{inspected_cursor})"
+      end
+
+      private
+
+      def inspected_cursor
+        cursor.inspect
+      rescue NoMethodError
+        # For those brave enough to try to use BasicObject as cursor. Nice try.
+        Object.instance_method(:inspect).bind(cursor).call
+      end
+    end
+
     included do |_base|
       attr_accessor(
         :cursor_position,
@@ -120,6 +142,8 @@ module JobIteration
       arguments = arguments.dup.freeze
       found_record = false
       enumerator.each do |object_from_enumerator, index|
+        assert_valid_cursor!(index)
+
         record_unit_of_work do
           found_record = true
           each_iteration(object_from_enumerator, *arguments)
@@ -176,6 +200,18 @@ module JobIteration
       EOS
     end
 
+    # The adapter must be able to serialize and deserialize the cursor back into an equivalent object.
+    # https://github.com/mperham/sidekiq/wiki/Best-Practices#1-make-your-job-parameters-small-and-simple
+    def assert_valid_cursor!(cursor)
+      return if serializable?(cursor)
+
+      raise CursorError.new(
+        "Cursor must be composed of objects capable of built-in (de)serialization: " \
+        "Strings, Integers, Floats, Arrays, Hashes, true, false, or nil.",
+        cursor: cursor,
+      )
+    end
+
     def assert_implements_methods!
       unless respond_to?(:each_iteration, true)
         raise(
@@ -251,5 +287,21 @@ module JobIteration
       end
       false
     end
+
+    SIMPLE_SERIALIZABLE_CLASSES = [String, Integer, Float, NilClass, TrueClass, FalseClass].freeze
+    private_constant :SIMPLE_SERIALIZABLE_CLASSES
+    def serializable?(object)
+      # Subclasses must be excluded, hence not using is_a? or ===.
+      if object.instance_of?(Array)
+        object.all? { |element| serializable?(element) }
+      elsif object.instance_of?(Hash)
+        object.all? { |key, value| serializable?(key) && serializable?(value) }
+      else
+        SIMPLE_SERIALIZABLE_CLASSES.any? { |klass| object.instance_of?(klass) }
+      end
+    rescue NoMethodError
+      # BasicObject doesn't respond to instance_of, but we can't serialize it anyway
+      false
+    end
   end
 end

data/lib/job-iteration/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JobIteration
-  VERSION = "1.1.10"
+  VERSION = "1.1.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: job-iteration
 version: !ruby/object:Gem::Version
-  version: 1.1.10
+  version: 1.1.11
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2021-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -45,7 +45,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ruby.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".yardopts"