Merge pull request #652 from afuno/feature/add_date_in_enumerators

Serialize :date column type in cursor to ISO8601 string format

Author: Mangara

CHANGELOG.md

@@ -14,7 +14,7 @@ nil
 
 ### Bug fixes
 
-nil
+- [652](https://github.com/Shopify/job-iteration/pull/652) Fix ISO8601 serialization for `Date` columns in ActiveRecord enumerators.
 
 ## v1.11.0 (Jul 14, 2025)
 

lib/job-iteration/active_record_batch_enumerator.rb

@@ -120,10 +120,15 @@ def serialize_column_values!(column_values)
     end
 
     def column_value(value)
-      return value unless value.is_a?(Time)
-
-      value = value.in_time_zone(@timezone) unless @timezone.nil?
-      value.strftime(SQL_DATETIME_WITH_NSEC)
+      case value
+      when Time
+        value = value.in_time_zone(@timezone) unless @timezone.nil?
+        value.strftime(SQL_DATETIME_WITH_NSEC)
+      when Date
+        value.iso8601
+      else
+        value
+      end
     end
   end
 end

lib/job-iteration/active_record_enumerator.rb

@@ -70,6 +70,8 @@ def column_value(record, attribute)
       when :datetime
         value = value.in_time_zone(@timezone) unless @timezone.nil?
         value.strftime(SQL_DATETIME_WITH_NSEC)
+      when :date
+        value.iso8601
       else
         value
       end

test/test_helper.rb

@@ -35,6 +35,9 @@ class Order < ActiveRecord::Base
   self.primary_key = [:shop_id, :id]
 end
 
+class Event < ActiveRecord::Base
+end
+
 mysql_host = ENV.fetch("MYSQL_HOST") { "localhost" }
 mysql_port = ENV.fetch("MYSQL_PORT") { 3306 }
 
@@ -84,6 +87,11 @@ class Order < ActiveRecord::Base
       t.integer(:shop_id)
       t.string(:name)
     end
+
+    create_table(:events, force: true) do |t|
+      t.string(:name)
+      t.date(:occurred_on)
+    end
   end
 end
 
@@ -157,6 +165,7 @@ def truncate_fixtures
     ActiveRecord::Base.connection.truncate(Product.table_name)
     ActiveRecord::Base.connection.truncate(Comment.table_name)
     ActiveRecord::Base.connection.truncate(Order.table_name)
+    ActiveRecord::Base.connection.truncate(Event.table_name)
   end
 
   def with_global_default_retry_backoff(backoff)

test/unit/active_record_batch_enumerator_test.rb

@@ -118,6 +118,28 @@ class ActiveRecordBatchEnumeratorTest < IterationUnitTest
       assert_equal([shops, cursor], enum.first)
     end
 
+    test "columns with date type are serialized to ISO8601 format" do
+      Event.create!(name: "Conference", occurred_on: Date.new(2025, 10, 15))
+      Event.create!(name: "Workshop", occurred_on: Date.new(2025, 10, 20))
+
+      enum = build_enumerator(relation: Event.all, columns: [:occurred_on])
+      events = Event.order(:occurred_on).take(2)
+
+      assert_equal([events, "2025-10-20"], enum.first)
+    end
+
+    test "cursor can be used to resume on date column" do
+      Event.create!(name: "Event 1", occurred_on: Date.new(2025, 1, 10))
+      Event.create!(name: "Event 2", occurred_on: Date.new(2025, 1, 20))
+      Event.create!(name: "Event 3", occurred_on: Date.new(2025, 1, 30))
+
+      enum = build_enumerator(relation: Event.all, columns: [:occurred_on, :id], cursor: ["2025-01-10", Event.first.id])
+      events = Event.order(:occurred_on, :id).offset(1).take(2)
+
+      cursor = [events.last.occurred_on.iso8601, events.last.id]
+      assert_equal([events, cursor], enum.first)
+    end
+
     test "cursor can be used to resume on multiple columns" do
       enum = build_enumerator(columns: [:created_at, :id])
       products = Product.order(:created_at, :id).take(2)

test/unit/active_record_enumerator_test.rb

@@ -134,6 +134,28 @@ def next_batch(*)
       assert_equal([shops, cursor], enum.first)
     end
 
+    test "columns with date type are serialized to ISO8601 format" do
+      Event.create!(name: "Conference", occurred_on: Date.new(2025, 10, 15))
+      Event.create!(name: "Workshop", occurred_on: Date.new(2025, 10, 20))
+
+      enum = build_enumerator(relation: Event.all, columns: [:occurred_on]).batches
+      events = Event.order(:occurred_on).take(2)
+
+      assert_equal([events, "2025-10-20"], enum.first)
+    end
+
+    test "cursor can be used to resume on date column" do
+      Event.create!(name: "Event 1", occurred_on: Date.new(2025, 1, 10))
+      Event.create!(name: "Event 2", occurred_on: Date.new(2025, 1, 20))
+      Event.create!(name: "Event 3", occurred_on: Date.new(2025, 1, 30))
+
+      enum = build_enumerator(relation: Event.all, columns: [:occurred_on, :id], cursor: ["2025-01-10", Event.first.id]).batches
+      events = Event.order(:occurred_on, :id).offset(1).take(2)
+
+      cursor = [events.last.occurred_on.iso8601, events.last.id]
+      assert_equal([events, cursor], enum.first)
+    end
+
     test "#size returns the number of items in the relation" do
       enum = build_enumerator(relation: Product.all)