From fd8122a87859ef191ca849dc6a1141beef0b4cee Mon Sep 17 00:00:00 2001
From: Faraz Yashar <faraz.yashar@gmail.com>
Date: Sun, 28 Jun 2015 14:58:01 -0400
Subject: Improve error message when serializing unsaved records for jobs

---
 activejob/lib/active_job/arguments.rb               | 21 ++++++++++++++-------
 activejob/test/cases/argument_serialization_test.rb |  7 +++++++
 2 files changed, 21 insertions(+), 7 deletions(-)

(limited to 'activejob')

diff --git a/activejob/lib/active_job/arguments.rb b/activejob/lib/active_job/arguments.rb
index cdb37879b6..8e462bfe5d 100644
--- a/activejob/lib/active_job/arguments.rb
+++ b/activejob/lib/active_job/arguments.rb
@@ -16,13 +16,13 @@ module ActiveJob
     end
   end
 
-  # Raised when an unsupported argument type is being set as job argument. We
+  # Raised when an unsupported argument type is set as a 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
+  # Bignum and objects that can be represented as GlobalIDs (ex: Active Record).
+  # Raised if you set the key for a Hash something else than a string or
+  # a symbol. Also raised when trying to serialize an object which can't be
+  # identified with a Global ID - such as an unpersisted Active Record model.
+  class SerializationError < ArgumentError; end
 
   module Arguments
     extend self
@@ -59,7 +59,7 @@ module ActiveJob
         when *TYPE_WHITELIST
           argument
         when GlobalID::Identification
-          { GLOBALID_KEY => argument.to_global_id.to_s }
+          convert_to_global_id_hash(argument)
         when Array
           argument.map { |arg| serialize_argument(arg) }
         when ActiveSupport::HashWithIndifferentAccess
@@ -147,5 +147,12 @@ module ActiveJob
           end
         end
       end
+
+      def convert_to_global_id_hash(argument)
+        { GLOBALID_KEY => argument.to_global_id.to_s }
+      rescue URI::GID::MissingModelIdError
+        raise SerializationError, "Unable to serialize #{argument.class} " \
+          "without an id. (Maybe you forgot to call save?)"
+      end
   end
 end
diff --git a/activejob/test/cases/argument_serialization_test.rb b/activejob/test/cases/argument_serialization_test.rb
index 8b9b62190f..933972a52b 100644
--- a/activejob/test/cases/argument_serialization_test.rb
+++ b/activejob/test/cases/argument_serialization_test.rb
@@ -88,6 +88,13 @@ class ArgumentSerializationTest < ActiveSupport::TestCase
     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
-- 
cgit v1.2.3