rails--rails/activejob/lib/active_job/arguments.rb

74 lines
2.2 KiB
Ruby
Raw Normal View History

module ActiveJob
# Raised when an exception is raised during job arguments deserialization.
#
# Wraps the original exception raised as +original_exception+.
class DeserializationError < StandardError
attr_reader :original_exception
def initialize(e)
super ("Error while trying to deserialize arguments: #{e.message}")
@original_exception = e
set_backtrace e.backtrace
end
end
# Raised when an unsupporter argument type is being set as job argument. We
# currently support NilClass, Fixnum, Float, String, TrueClass, FalseClass,
# Bignum and object that can be represented as GlobalIDs (ex: Active Record).
# Also raised if you set the key for a Hash something else than a string or
# a symbol.
class SerializationError < ArgumentError
end
module Arguments
extend self
2014-05-31 14:31:20 +00:00
TYPE_WHITELIST = [ NilClass, Fixnum, Float, String, TrueClass, FalseClass, Bignum ]
def serialize(arguments)
2014-06-05 20:10:41 +00:00
arguments.map { |argument| serialize_argument(argument) }
end
def deserialize(arguments)
2014-06-05 20:10:41 +00:00
arguments.map { |argument| deserialize_argument(argument) }
end
private
def serialize_argument(argument)
2014-05-31 14:31:20 +00:00
case argument
2014-08-17 01:06:30 +00:00
when GlobalID::Identification
argument.global_id.to_s
2014-05-31 14:31:20 +00:00
when *TYPE_WHITELIST
argument
2014-05-31 14:31:20 +00:00
when Array
serialize(argument)
2014-06-05 20:10:41 +00:00
when Hash
Hash[ argument.map { |key, value| [ serialize_hash_key(key), serialize_argument(value) ] } ]
else
raise SerializationError.new("Unsupported argument type: #{argument.class.name}")
end
end
def deserialize_argument(argument)
2014-05-31 14:31:20 +00:00
case argument
when Array
deserialize(argument)
when Hash
2014-06-05 20:10:41 +00:00
Hash[ argument.map { |key, value| [ key, deserialize_argument(value) ] } ].with_indifferent_access
2014-05-31 14:31:20 +00:00
else
2014-08-17 01:06:30 +00:00
GlobalID::Locator.locate(argument) || argument
2014-05-31 14:31:20 +00:00
end
rescue => e
raise DeserializationError.new(e)
2014-05-31 14:31:20 +00:00
end
def serialize_hash_key(key)
2014-05-31 14:31:20 +00:00
case key
when String, Symbol
key.to_s
else
raise SerializationError.new("Unsupported hash key type: #{key.class.name}")
2014-05-31 14:31:20 +00:00
end
end
end
end