Merge pull request #30941 from toptal/introduce-custom-serializers-to-activejob-arguments

Introduce custom serializers to ActiveJob arguments

1 files changed, 98 insertions, 0 deletions

diff --git a/activejob/test/cases/serializers_test.rb b/activejob/test/cases/serializers_test.rb
new file mode 100644
index 0000000000..a86f168d03
--- /dev/null
+++ b/activejob/test/cases/serializers_test.rb
@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "helper"
+require "active_job/serializers"
+
+class SerializersTest < ActiveSupport::TestCase
+  class DummyValueObject
+    attr_accessor :value
+
+    def initialize(value)
+      @value = value
+    end
+
+    def ==(other)
+      self.value == other.value
+    end
+  end
+
+  class DummySerializer < ActiveJob::Serializers::ObjectSerializer
+    def serialize(object)
+      super({ "value" => object.value })
+    end
+
+    def deserialize(hash)
+      DummyValueObject.new(hash["value"])
+    end
+
+    private
+
+      def klass
+        DummyValueObject
+      end
+  end
+
+  setup do
+    @value_object = DummyValueObject.new 123
+    @original_serializers = ActiveJob::Serializers.serializers
+  end
+
+  teardown do
+    ActiveJob::Serializers._additional_serializers = @original_serializers
+  end
+
+  test "can't serialize unknown object" do
+    assert_raises ActiveJob::SerializationError do
+      ActiveJob::Serializers.serialize @value_object
+    end
+  end
+
+  test "will serialize objects with serializers registered" do
+    ActiveJob::Serializers.add_serializers DummySerializer
+
+    assert_equal(
+      { "_aj_serialized" => "SerializersTest::DummySerializer", "value" => 123 },
+      ActiveJob::Serializers.serialize(@value_object)
+    )
+  end
+
+  test "won't deserialize unknown hash" do
+    hash = { "_dummy_serializer" => 123, "_aj_symbol_keys" => [] }
+    error = assert_raises(ArgumentError) do
+      ActiveJob::Serializers.deserialize(hash)
+    end
+    assert_equal(
+      'Serializer name is not present in the argument: {"_dummy_serializer"=>123, "_aj_symbol_keys"=>[]}',
+      error.message
+    )
+  end
+
+  test "won't deserialize unknown serializer" do
+    hash = { "_aj_serialized" => "DoNotExist", "value" => 123 }
+    error = assert_raises(ArgumentError) do
+      ActiveJob::Serializers.deserialize(hash)
+    end
+    assert_equal(
+      "Serializer DoNotExist is not know",
+      error.message
+    )
+  end
+
+  test "will deserialize know serialized objects" do
+    ActiveJob::Serializers.add_serializers DummySerializer
+    hash = { "_aj_serialized" => "SerializersTest::DummySerializer", "value" => 123 }
+    assert_equal DummyValueObject.new(123), ActiveJob::Serializers.deserialize(hash)
+  end
+
+  test "adds new serializer" do
+    ActiveJob::Serializers.add_serializers DummySerializer
+    assert ActiveJob::Serializers.serializers.include?(DummySerializer)
+  end
+
+  test "can't add serializer with the same key twice" do
+    ActiveJob::Serializers.add_serializers DummySerializer
+    assert_no_difference(-> { ActiveJob::Serializers.serializers.size }) do
+      ActiveJob::Serializers.add_serializers DummySerializer
+    end
+  end
+end