From 266455cf25aba942b8717ceb0269d66f719b5696 Mon Sep 17 00:00:00 2001
From: Yuki Nishijima <mail@yukinishijima.net>
Date: Tue, 3 Nov 2015 06:54:34 -0800
Subject: Deprecate exception#original_exception in favor of exception#cause

---
 activejob/lib/active_job/arguments.rb | 25 ++++++++++++++++---------
 activejob/test/jobs/rescue_job.rb     |  2 +-
 2 files changed, 17 insertions(+), 10 deletions(-)

(limited to 'activejob')

diff --git a/activejob/lib/active_job/arguments.rb b/activejob/lib/active_job/arguments.rb
index 8e462bfe5d..e56bc79328 100644
--- a/activejob/lib/active_job/arguments.rb
+++ b/activejob/lib/active_job/arguments.rb
@@ -3,16 +3,23 @@ require 'active_support/core_ext/hash'
 module ActiveJob
   # Raised when an exception is raised during job arguments deserialization.
   #
-  # Wraps the original exception raised as +original_exception+.
+  # Wraps the original exception raised as +cause+.
   class DeserializationError < StandardError
+    def initialize(e = nil) #:nodoc:
+      if e
+        ActiveSupport::Deprecation.warn("Passing #original_exception is deprecated and has no effect. " \
+                                        "Exceptions will automatically capture the original exception.", caller)
+      end
+
+      super("Error while trying to deserialize arguments: #{$!.message}")
+      set_backtrace $!.backtrace
+    end
+
     # The original exception that was raised during deserialization of job
     # arguments.
-    attr_reader :original_exception
-
-    def initialize(e) #:nodoc:
-      super("Error while trying to deserialize arguments: #{e.message}")
-      @original_exception = e
-      set_backtrace e.backtrace
+    def original_exception
+      ActiveSupport::Deprecation.warn("#original_exception is deprecated. Use #cause instead.", caller)
+      cause
     end
   end
 
@@ -41,8 +48,8 @@ module ActiveJob
     # All other types are deserialized using GlobalID.
     def deserialize(arguments)
       arguments.map { |argument| deserialize_argument(argument) }
-    rescue => e
-      raise DeserializationError.new(e)
+    rescue
+      raise DeserializationError
     end
 
     private
diff --git a/activejob/test/jobs/rescue_job.rb b/activejob/test/jobs/rescue_job.rb
index f1b9c9349e..4f6376c850 100644
--- a/activejob/test/jobs/rescue_job.rb
+++ b/activejob/test/jobs/rescue_job.rb
@@ -11,7 +11,7 @@ class RescueJob < ActiveJob::Base
 
   rescue_from(ActiveJob::DeserializationError) do |e|
     JobBuffer.add('rescued from DeserializationError')
-    JobBuffer.add("DeserializationError original exception was #{e.original_exception.class.name}")
+    JobBuffer.add("DeserializationError original exception was #{e.cause.class.name}")
   end
 
   def perform(person = "david")
-- 
cgit v1.2.3