Perform self-serialization once metadata is involved.

Adds support for metadata even when using ActiveSupport::MessageEncryptor::NullSerializer.

2 files changed, 50 insertions, 30 deletions

diff --git a/activesupport/test/message_verifier_test.rb b/activesupport/test/message_verifier_test.rb
index f626ab745f..fbeafca203 100644
--- a/activesupport/test/message_verifier_test.rb
+++ b/activesupport/test/message_verifier_test.rb
@@ -101,12 +101,12 @@ class MessageVerifierMetadataTest < ActiveSupport::TestCase
 
   def test_verify_raises_when_purpose_differs
     assert_raise(ActiveSupport::MessageVerifier::InvalidSignature) do
-      @verifier.verify(@verifier.generate(@message, purpose: "payment"), purpose: "shipping")
+      @verifier.verify(generate(data, purpose: "payment"), purpose: "shipping")
     end
   end
 
   def test_verify_raises_when_expired
-    signed_message = @verifier.generate(@message, expires_in: 1.month)
+    signed_message = generate(data, expires_in: 1.month)
 
     travel 2.months
     assert_raise(ActiveSupport::MessageVerifier::InvalidSignature) do
@@ -141,3 +141,18 @@ class MessageVerifierMetadataJSONTest < MessageVerifierMetadataTest
       { serializer: MessageVerifierTest::JSONSerializer.new }
     end
 end
+
+class MessageEncryptorMetadataNullSerializerTest < MessageVerifierMetadataTest
+  private
+    def data
+      "string message"
+    end
+
+    def null_serializing?
+      true
+    end
+
+    def verifier_options
+      { serializer: ActiveSupport::MessageEncryptor::NullSerializer }
+    end
+end
diff --git a/activesupport/test/metadata/shared_metadata_tests.rb b/activesupport/test/metadata/shared_metadata_tests.rb
index 7d88e255c7..08bb0c648e 100644
--- a/activesupport/test/metadata/shared_metadata_tests.rb
+++ b/activesupport/test/metadata/shared_metadata_tests.rb
@@ -1,57 +1,57 @@
 # frozen_string_literal: true
 
 module SharedMessageMetadataTests
-  def setup
-    @message = { "credit_card_no" => "5012-6784-9087-5678", "card_holder" => { "name" => "Donald" } }
-
-    super
-  end
-
   def teardown
     travel_back
-
     super
   end
 
+  def null_serializing?
+    false
+  end
+
   def test_encryption_and_decryption_with_same_purpose
-    assert_equal @message, parse(generate(@message, purpose: "checkout"), purpose: "checkout")
-    assert_equal @message, parse(generate(@message))
+    assert_equal data, parse(generate(data, purpose: "checkout"), purpose: "checkout")
+    assert_equal data, parse(generate(data))
 
     string_message = "address: #23, main street"
     assert_equal string_message, parse(generate(string_message, purpose: "shipping"), purpose: "shipping")
+  end
 
-    array_message = ["credit_card_no: 5012-6748-9087-5678", { "card_holder" => "Donald", "issued_on" => Time.local(2017) }, 12345]
-    assert_equal array_message, parse(generate(array_message, purpose: "registration"), purpose: "registration")
+  def test_verifies_array_when_purpose_matches
+    unless null_serializing?
+      data = [ "credit_card_no: 5012-6748-9087-5678", { "card_holder" => "Donald", "issued_on" => Time.local(2017) }, 12345 ]
+      assert_equal data, parse(generate(data, purpose: :registration), purpose: :registration)
+    end
   end
 
   def test_encryption_and_decryption_with_different_purposes_returns_nil
-    assert_nil parse(generate(@message, purpose: "payment"), purpose: "sign up")
-    assert_nil parse(generate(@message, purpose: "payment"))
-    assert_nil parse(generate(@message), purpose: "sign up")
-    assert_nil parse(generate(@message), purpose: "")
+    assert_nil parse(generate(data, purpose: "payment"), purpose: "sign up")
+    assert_nil parse(generate(data, purpose: "payment"))
+    assert_nil parse(generate(data), purpose: "sign up")
   end
 
   def test_purpose_using_symbols
-    assert_equal @message, parse(generate(@message, purpose: :checkout), purpose: :checkout)
-    assert_equal @message, parse(generate(@message, purpose: :checkout), purpose: "checkout")
-    assert_equal @message, parse(generate(@message, purpose: "checkout"), purpose: :checkout)
+    assert_equal data, parse(generate(data, purpose: :checkout), purpose: :checkout)
+    assert_equal data, parse(generate(data, purpose: :checkout), purpose: "checkout")
+    assert_equal data, parse(generate(data, purpose: "checkout"), purpose: :checkout)
   end
 
   def test_passing_expires_at_sets_expiration_date
-    encrypted_message = generate(@message, expires_at: 1.hour.from_now)
+    encrypted_message = generate(data, expires_at: 1.hour.from_now)
 
     travel 59.minutes
-    assert_equal @message, parse(encrypted_message)
+    assert_equal data, parse(encrypted_message)
 
     travel 2.minutes
     assert_nil parse(encrypted_message)
   end
 
   def test_set_relative_expiration_date_by_passing_expires_in
-    encrypted_message = generate(@message, expires_in: 2.hours)
+    encrypted_message = generate(data, expires_in: 2.hours)
 
     travel 1.hour
-    assert_equal @message, parse(encrypted_message)
+    assert_equal data, parse(encrypted_message)
 
     travel 1.hour + 1.second
     assert_nil parse(encrypted_message)
@@ -59,10 +59,10 @@ module SharedMessageMetadataTests
 
   def test_passing_expires_in_less_than_a_second_is_not_expired
     freeze_time do
-      encrypted_message = generate(@message, expires_in: 1.second)
+      encrypted_message = generate(data, expires_in: 1.second)
 
       travel 0.5.seconds
-      assert_equal @message, parse(encrypted_message)
+      assert_equal data, parse(encrypted_message)
 
       travel 1.second
       assert_nil parse(encrypted_message)
@@ -70,19 +70,24 @@ module SharedMessageMetadataTests
   end
 
   def test_favor_expires_at_over_expires_in
-    payment_related_message = generate(@message, purpose: "payment", expires_at: 2.year.from_now, expires_in: 1.second)
+    payment_related_message = generate(data, purpose: "payment", expires_at: 2.year.from_now, expires_in: 1.second)
 
     travel 1.year
-    assert_equal @message, parse(payment_related_message, purpose: :payment)
+    assert_equal data, parse(payment_related_message, purpose: :payment)
 
     travel 1.year + 1.day
     assert_nil parse(payment_related_message, purpose: "payment")
   end
 
   def test_skip_expires_at_and_expires_in_to_disable_expiration_check
-    payment_related_message = generate(@message, purpose: "payment")
+    payment_related_message = generate(data, purpose: "payment")
 
     travel 100.years
-    assert_equal @message, parse(payment_related_message, purpose: "payment")
+    assert_equal data, parse(payment_related_message, purpose: "payment")
   end
+
+  private
+    def data
+      { "credit_card_no" => "5012-6784-9087-5678", "card_holder" => { "name" => "Donald" } }
+    end
 end