# frozen_string_literal: true require "helper" require "active_job/arguments" require "models/person" require "active_support/core_ext/hash/indifferent_access" require "jobs/kwargs_job" class ArgumentSerializationTest < ActiveSupport::TestCase setup do @person = Person.find("5") end [ nil, 1, 1.0, 1_000_000_000_000_000_000_000, "a", true, false, BigDecimal(5), :a, 1.day, Date.new(2001, 2, 3), Time.new(2002, 10, 31, 2, 2, 2, "+02:00"), DateTime.new(2001, 2, 3, 4, 5, 6, "+03:00"), ActiveSupport::TimeWithZone.new(Time.utc(1999, 12, 31, 23, 59, 59), ActiveSupport::TimeZone["UTC"]), [ 1, "a" ], { "a" => 1 } ].each do |arg| test "serializes #{arg.class} - #{arg} verbatim" do assert_arguments_unchanged arg end end [ Object.new, self, Person.find("5").to_gid ].each do |arg| test "does not serialize #{arg.class}" do assert_raises ActiveJob::SerializationError do ActiveJob::Arguments.serialize [ arg ] end assert_raises ActiveJob::DeserializationError do ActiveJob::Arguments.deserialize [ arg ] end end end test "should convert records to Global IDs" do assert_arguments_roundtrip [@person] end test "should dive deep into arrays and hashes" do assert_arguments_roundtrip [3, [@person]] assert_arguments_roundtrip [{ "a" => @person }] end test "should maintain string and symbol keys" do assert_arguments_roundtrip([a: 1, "b" => 2]) end test "serialize a hash" do symbol_key = { a: 1 } string_key = { "a" => 1 } indifferent_access = { a: 1 }.with_indifferent_access assert_equal( { "a" => 1, "_aj_symbol_keys" => ["a"] }, ActiveJob::Arguments.serialize([symbol_key]).first ) assert_equal( { "a" => 1, "_aj_symbol_keys" => [] }, ActiveJob::Arguments.serialize([string_key]).first ) assert_equal( { "a" => 1, "_aj_hash_with_indifferent_access" => true }, ActiveJob::Arguments.serialize([indifferent_access]).first ) end test "deserialize a hash" do symbol_key = { "a" => 1, "_aj_symbol_keys" => ["a"] } string_key = { "a" => 1, "_aj_symbol_keys" => [] } another_string_key = { "a" => 1 } indifferent_access = { "a" => 1, "_aj_hash_with_indifferent_access" => true } assert_equal( { a: 1 }, ActiveJob::Arguments.deserialize([symbol_key]).first ) assert_equal( { "a" => 1 }, ActiveJob::Arguments.deserialize([string_key]).first ) assert_equal( { "a" => 1 }, ActiveJob::Arguments.deserialize([another_string_key]).first ) assert_equal( { "a" => 1 }, ActiveJob::Arguments.deserialize([indifferent_access]).first ) end test "should maintain hash with indifferent access" do symbol_key = { a: 1 } string_key = { "a" => 1 } indifferent_access = { a: 1 }.with_indifferent_access assert_not_instance_of ActiveSupport::HashWithIndifferentAccess, perform_round_trip([symbol_key]).first assert_not_instance_of ActiveSupport::HashWithIndifferentAccess, perform_round_trip([string_key]).first assert_instance_of ActiveSupport::HashWithIndifferentAccess, perform_round_trip([indifferent_access]).first end test "should maintain time with zone" do Time.use_zone "Alaska" do time_with_zone = Time.new(2002, 10, 31, 2, 2, 2).in_time_zone assert_instance_of ActiveSupport::TimeWithZone, perform_round_trip([time_with_zone]).first assert_arguments_unchanged time_with_zone end end test "should disallow non-string/symbol hash keys" do assert_raises ActiveJob::SerializationError do ActiveJob::Arguments.serialize [ { 1 => 2 } ] end assert_raises ActiveJob::SerializationError do ActiveJob::Arguments.serialize [ { a: [{ 2 => 3 }] } ] end end test "should not allow reserved hash keys" do ["_aj_globalid", :_aj_globalid, "_aj_symbol_keys", :_aj_symbol_keys, "_aj_hash_with_indifferent_access", :_aj_hash_with_indifferent_access, "_aj_serialized", :_aj_serialized].each do |key| assert_raises ActiveJob::SerializationError do ActiveJob::Arguments.serialize [key => 1] end end end test "should not allow non-primitive objects" do assert_raises ActiveJob::SerializationError do ActiveJob::Arguments.serialize [Object.new] end assert_raises ActiveJob::SerializationError do ActiveJob::Arguments.serialize [1, [Object.new]] end end test "allows for keyword arguments" do KwargsJob.perform_later(argument: 2) assert_equal "Job with argument: 2", JobBuffer.last_value end test "raises a friendly SerializationError for records without ids" do err = assert_raises ActiveJob::SerializationError do ActiveJob::Arguments.serialize [Person.new(nil)] end assert_match "Unable to serialize Person without an id.", err.message end private def assert_arguments_unchanged(*args) assert_arguments_roundtrip args end def assert_arguments_roundtrip(args) assert_equal args, perform_round_trip(args) end def perform_round_trip(args) ActiveJob::Arguments.deserialize(ActiveJob::Arguments.serialize(args)) end end