MONGOID-5611 ActiveJob serializer for ObjectId (#5676)

Author: comandeo-mongo

docs/release-notes/mongoid-9.0.txt

@@ -358,3 +358,6 @@ This section will be for smaller bug fixes and improvements:
   a non-numeric, non-string value that implements ``:to_d`` will return a string
   rather than a ``BigDecimal``
   `MONGOID-5507 <https://jira.mongodb.org/browse/MONGOID-5507>`_.
+- Added support for serializing and deserializing BSON::ObjectId values
+  when passed as ActiveJob arguments
+  `MONGOID-5611 <https://jira.mongodb.org/browse/MONGOID-5611>`_.

gemfiles/standard.rb

@@ -36,6 +36,7 @@ def standard_dependencies
   end
 
   group :test do
+    gem 'activejob'
     gem 'timecop'
     gem 'rspec-retry'
     gem 'benchmark-ips'

lib/mongoid/railtie.rb

@@ -118,6 +118,17 @@ def handle_configuration_error(e)
             ::Mongoid::Railties::ControllerRuntime::Collector.new
       end
 
+      # Add custom serializers for BSON::ObjectId
+      initializer 'mongoid.active_job.custom_serializers' do
+        require 'mongoid/railties/bson_object_id_serializer'
+
+        config.after_initialize do
+          ActiveJob::Serializers.add_serializers(
+            [::Mongoid::Railties::ActiveJobSerializers::BsonObjectIdSerializer]
+          )
+        end
+      end
+
     end
   end
 end

lib/mongoid/railties/bson_object_id_serializer.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Railties
+    module ActiveJobSerializers
+      # This class provides serialization and deserialization of BSON::ObjectId
+      # for ActiveJob.
+      #
+      # It is important that this class is loaded only when Rails is available
+      # since it depends on Rails' ActiveJob::Serializers::ObjectSerializer.
+      class BsonObjectIdSerializer < ActiveJob::Serializers::ObjectSerializer
+        #  Returns whether the argument can be serialized by this serializer.
+        #
+        #  @param [ Object ] argument The argument to check.
+        #
+        #  @return [ true | false ] Whether the argument can be serialized.
+        def serialize?(argument)
+          argument.is_a?(BSON::ObjectId)
+        end
+
+        # Serializes the argument to be passed to the job.
+        #
+        # @param [ BSON::ObjectId ] object The object to serialize.
+        def serialize(object)
+          object.to_s
+        end
+
+        # Deserializes the argument back into a BSON::ObjectId.
+        #
+        # @param [ String ] string The string to deserialize.
+        #
+        # @return [ BSON::ObjectId ] The deserialized object.
+        def deserialize(string)
+          BSON::ObjectId.from_string(string)
+        end
+      end
+    end
+  end
+end

spec/integration/active_job_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+require 'spec_helper'
+require 'active_job'
+require 'mongoid/railties/bson_object_id_serializer'
+
+describe 'ActiveJob Serialization' do
+  skip unless defined?(ActiveJob)
+
+  class TestBsonObjectIdSerializerJob < ActiveJob::Base
+    def perform(*args)
+      args
+    end
+  end
+
+  let(:band) do
+    Band.create!
+  end
+
+  before do
+    ActiveJob::Serializers.add_serializers(
+      [::Mongoid::Railties::ActiveJobSerializers::BsonObjectIdSerializer]
+    )
+  end
+
+  it 'serializes and deserializes BSON::ObjectId' do
+    expect do
+      TestBsonObjectIdSerializerJob.perform_later(band.id)
+    end.not_to raise_error
+  end
+end

spec/mongoid/railties/bson_object_id_serializer_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+require 'spec_helper'
+require 'active_job'
+require 'mongoid/railties/bson_object_id_serializer'
+
+describe Mongoid::Railties::ActiveJobSerializers::BsonObjectIdSerializer do
+  let(:serializer) { described_class.instance }
+  let(:object_id) { BSON::ObjectId.new }
+
+  describe '#serialize' do
+    it 'serializes BSON::ObjectId' do
+      expect(serializer.serialize(object_id)).to be_a(String)
+    end
+  end
+
+  describe '#deserialize' do
+    it 'deserializes BSON::ObjectId' do
+      expect(serializer.deserialize(serializer.serialize(object_id))).to eq(object_id)
+    end
+  end
+end