2014-05-22 13:35:45 -04:00
|
|
|
module ActiveJob
|
2014-08-23 07:19:44 -04:00
|
|
|
# Raised when an exception is raised during job arguments deserialization.
|
|
|
|
#
|
|
|
|
# Wraps the original exception raised as +original_exception+.
|
2014-08-17 16:48:44 -04:00
|
|
|
class DeserializationError < StandardError
|
|
|
|
attr_reader :original_exception
|
|
|
|
|
2014-09-03 03:38:02 -04:00
|
|
|
def initialize(e) #:nodoc:
|
2014-09-04 10:35:37 -04:00
|
|
|
super("Error while trying to deserialize arguments: #{e.message}")
|
2014-08-17 16:48:44 -04:00
|
|
|
@original_exception = e
|
|
|
|
set_backtrace e.backtrace
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2014-08-24 12:33:59 -04:00
|
|
|
# Raised when an unsupported argument type is being set as job argument. We
|
2014-08-23 07:19:44 -04:00
|
|
|
# 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
|
|
|
|
|
2014-08-15 06:04:06 -04:00
|
|
|
module Arguments
|
|
|
|
extend self
|
2014-05-31 10:31:20 -04:00
|
|
|
TYPE_WHITELIST = [ NilClass, Fixnum, Float, String, TrueClass, FalseClass, Bignum ]
|
2014-05-22 13:35:45 -04:00
|
|
|
|
2014-09-26 13:10:06 -04:00
|
|
|
# Serializes a set of arguments. Whitelisted types are returned
|
|
|
|
# as-is. Arrays/Hashes are serialized element by element.
|
|
|
|
# All other types are serialized using GlobalID.
|
2014-08-15 06:04:06 -04:00
|
|
|
def serialize(arguments)
|
2014-06-05 16:10:41 -04:00
|
|
|
arguments.map { |argument| serialize_argument(argument) }
|
|
|
|
end
|
|
|
|
|
2014-09-26 13:10:06 -04:00
|
|
|
# Deserializes a set of arguments. Whitelisted types are returned
|
|
|
|
# as-is. Arrays/Hashes are deserialized element by element.
|
|
|
|
# All other types are deserialized using GlobalID.
|
2014-08-15 06:04:06 -04:00
|
|
|
def deserialize(arguments)
|
2014-06-05 16:10:41 -04:00
|
|
|
arguments.map { |argument| deserialize_argument(argument) }
|
2014-09-03 03:38:02 -04:00
|
|
|
rescue => e
|
|
|
|
raise DeserializationError.new(e)
|
2014-06-05 16:10:41 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
private
|
2014-09-14 22:34:17 -04:00
|
|
|
GLOBALID_KEY = '_aj_globalid'.freeze
|
|
|
|
private_constant :GLOBALID_KEY
|
|
|
|
|
2014-08-15 06:04:06 -04:00
|
|
|
def serialize_argument(argument)
|
2014-05-31 10:31:20 -04:00
|
|
|
case argument
|
|
|
|
when *TYPE_WHITELIST
|
2014-05-22 13:35:45 -04:00
|
|
|
argument
|
2014-09-14 03:58:45 -04:00
|
|
|
when GlobalID::Identification
|
2014-09-14 22:34:17 -04:00
|
|
|
{ GLOBALID_KEY => argument.to_global_id.to_s }
|
2014-05-31 10:31:20 -04:00
|
|
|
when Array
|
2014-09-03 03:38:02 -04:00
|
|
|
argument.map { |arg| serialize_argument(arg) }
|
2014-06-05 16:10:41 -04:00
|
|
|
when Hash
|
2014-09-14 03:58:45 -04:00
|
|
|
argument.each_with_object({}) do |(key, value), hash|
|
|
|
|
hash[serialize_hash_key(key)] = serialize_argument(value)
|
|
|
|
end
|
2014-05-22 13:35:45 -04:00
|
|
|
else
|
2014-08-23 07:19:44 -04:00
|
|
|
raise SerializationError.new("Unsupported argument type: #{argument.class.name}")
|
2014-05-22 13:35:45 -04:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2014-08-15 06:04:06 -04:00
|
|
|
def deserialize_argument(argument)
|
2014-05-31 10:31:20 -04:00
|
|
|
case argument
|
2014-09-14 03:58:45 -04:00
|
|
|
when String
|
|
|
|
GlobalID::Locator.locate(argument) || argument
|
|
|
|
when *TYPE_WHITELIST
|
|
|
|
argument
|
2014-05-31 10:31:20 -04:00
|
|
|
when Array
|
2014-09-03 03:38:02 -04:00
|
|
|
argument.map { |arg| deserialize_argument(arg) }
|
2014-05-31 10:31:20 -04:00
|
|
|
when Hash
|
2014-09-14 22:34:17 -04:00
|
|
|
if serialized_global_id?(argument)
|
|
|
|
deserialize_global_id argument
|
|
|
|
else
|
|
|
|
deserialize_hash argument
|
2014-09-14 03:58:45 -04:00
|
|
|
end
|
2014-09-03 08:06:10 -04:00
|
|
|
else
|
2014-09-14 03:58:45 -04:00
|
|
|
raise ArgumentError, "Can only deserialize primitive arguments: #{argument.inspect}"
|
2014-05-31 10:31:20 -04:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2014-09-14 22:34:17 -04:00
|
|
|
def serialized_global_id?(hash)
|
|
|
|
hash.size == 1 and hash.include?(GLOBALID_KEY)
|
|
|
|
end
|
|
|
|
|
|
|
|
def deserialize_global_id(hash)
|
|
|
|
GlobalID::Locator.locate hash[GLOBALID_KEY]
|
|
|
|
end
|
|
|
|
|
|
|
|
def deserialize_hash(serialized_hash)
|
|
|
|
serialized_hash.each_with_object({}.with_indifferent_access) do |(key, value), hash|
|
|
|
|
hash[key] = deserialize_argument(value)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
RESERVED_KEYS = [GLOBALID_KEY, GLOBALID_KEY.to_sym]
|
|
|
|
private_constant :RESERVED_KEYS
|
|
|
|
|
2014-08-15 06:04:06 -04:00
|
|
|
def serialize_hash_key(key)
|
2014-05-31 10:31:20 -04:00
|
|
|
case key
|
2014-09-14 22:34:17 -04:00
|
|
|
when *RESERVED_KEYS
|
|
|
|
raise SerializationError.new("Can't serialize a Hash with reserved key #{key.inspect}")
|
2014-05-31 10:31:20 -04:00
|
|
|
when String, Symbol
|
|
|
|
key.to_s
|
|
|
|
else
|
2014-09-14 03:58:45 -04:00
|
|
|
raise SerializationError.new("Only string and symbol hash keys may be serialized as job arguments, but #{key.inspect} is a #{key.class}")
|
2014-05-31 10:31:20 -04:00
|
|
|
end
|
|
|
|
end
|
2014-05-22 13:35:45 -04:00
|
|
|
end
|
|
|
|
end
|