Merge pull request #1099 from Adyen/DR-1093-Added-key-version-function-renames

Kwok-he-Chu · web-flow · commit b46c1de24021 · 2025-01-03T16:41:54.000+01:00
SaleToPOIMessageConverter fix: Added key-version and function renames for consistency
diff --git a/Adyen.Test/SerializerTest.cs b/Adyen.Test/SerializerTest.cs
@@ -93,15 +93,15 @@ public void CheckoutSessionResponseCheckForIdTest()
         [TestMethod]
         public void SaleToPoiMessageSerializationTest()
         {
-            var saleToPoiMessage = PosPaymentRequest;
-            var serialized = SerializeSaleToPoiMessage(saleToPoiMessage);
+            SaleToPOIRequest saleToPoiMessage = CreatePosPaymentRequest();
+            string serialized = SerializeSaleToPoiMessage(saleToPoiMessage);
             Assert.AreEqual(serialized, ExpectedSaleToPoiMessageJson);
         }
 
         [TestMethod]
         public void SaleToPoiMessageWithUpdatedJsonConvertDefaultSettingsSerializationTest()
         {
-            var saleToPoiMessage = PosPaymentRequest;
+            SaleToPOIRequest saleToPoiMessage = CreatePosPaymentRequest();
 
             JsonConvert.DefaultSettings = () => new JsonSerializerSettings
             {
@@ -111,10 +111,9 @@ public void SaleToPoiMessageWithUpdatedJsonConvertDefaultSettingsSerializationTe
                 }
             };
 
+            string serialized = SerializeSaleToPoiMessage(saleToPoiMessage);
             try
             {
-                var serialized = SerializeSaleToPoiMessage(saleToPoiMessage);
-
                 Assert.AreEqual(serialized, ExpectedSaleToPoiMessageJson);
             }
             finally
@@ -126,15 +125,15 @@ public void SaleToPoiMessageWithUpdatedJsonConvertDefaultSettingsSerializationTe
         [TestMethod]
         public void SaleToPoiMessageSecuredSerializationTest()
         {
-            var saleToPoiMessage = PosPaymentRequest;
-            var serialized = SerializeSaleToPoiMessageSecured(saleToPoiMessage);
+            SaleToPOIRequest saleToPoiMessage = CreatePosPaymentRequest();
+            string serialized = SerializeSaleToPoiMessageSecured(saleToPoiMessage);
             Assert.AreEqual(serialized, ExpectedSaleToPoiMessageSecuredJson);
         }
 
         [TestMethod]
         public void SaleToPoiMessageSecuredWithUpdatedJsonConvertDefaultSettingsSerializationTest()
         {
-            var saleToPoiMessage = PosPaymentRequest;
+            SaleToPOIRequest saleToPoiMessage = CreatePosPaymentRequest();
 
             JsonConvert.DefaultSettings = () => new JsonSerializerSettings
             {
@@ -146,7 +145,7 @@ public void SaleToPoiMessageSecuredWithUpdatedJsonConvertDefaultSettingsSerializ
 
             try
             {
-                var serialized = SerializeSaleToPoiMessageSecured(saleToPoiMessage);
+                string serialized = SerializeSaleToPoiMessageSecured(saleToPoiMessage);
 
                 Assert.AreEqual(serialized, ExpectedSaleToPoiMessageSecuredJson);
             }
@@ -167,7 +166,6 @@ private static string SerializeSaleToPoiMessage(SaleToPOIMessage saleToPoiMessag
             return saleToPoiMessageSerializer.Serialize(saleToPoiMessage);
         }
 
-
         private static string SerializeSaleToPoiMessageSecured(SaleToPOIMessage saleToPoiMessage)
         {
             var saleToPoiMessageSerializer = new SaleToPoiMessageSerializer();
@@ -176,6 +174,7 @@ private static string SerializeSaleToPoiMessageSecured(SaleToPOIMessage saleToPo
             var encryptionCredentialDetails = new EncryptionCredentialDetails
             {
                 AdyenCryptoVersion = 1,
+                KeyVersion = 1,
                 KeyIdentifier = "CryptoKeyIdentifier12345",
                 Password = "p@ssw0rd123456"
             };
@@ -192,8 +191,9 @@ private static string SerializeSaleToPoiMessageSecured(SaleToPOIMessage saleToPo
             return saleToPoiMessageSerializer.Serialize(saleToPoiMessageSecured);
         }
 
-        private static SaleToPOIRequest PosPaymentRequest =>
-            new SaleToPOIRequest
+        private static SaleToPOIRequest CreatePosPaymentRequest()
+        {
+            return new SaleToPOIRequest
             {
                 MessageHeader = new MessageHeader
                 {
@@ -229,11 +229,10 @@ private static string SerializeSaleToPoiMessageSecured(SaleToPOIMessage saleToPo
                     }
                 }
             };
+        }
 
-        private static string ExpectedSaleToPoiMessageJson =>
-            "{\"SaleToPOIRequest\":{\"MessageHeader\":{\"MessageClass\":\"Service\",\"MessageCategory\":\"Payment\",\"MessageType\":\"Request\",\"ServiceID\":\"12345678\",\"SaleID\":\"POSSystemID12345\",\"POIID\":\"MX915-284251016\",\"ProtocolVersion\":\"3.0\"},\"PaymentRequest\":{\"SaleData\":{\"SaleTransactionID\":{\"TransactionID\":\"PosAuth\",\"TimeStamp\":\"2025-01-01T00:00:00\"},\"SaleToAcquirerData\":\"eyJhcHBsaWNhdGlvbkluZm8iOnsiYWR5ZW5MaWJyYXJ5Ijp7Im5hbWUiOiJhZHllbi1kb3RuZXQtYXBpLWxpYnJhcnkiLCJ2ZXJzaW9uIjoiMjYuMC4wIn19fQ==\",\"TokenRequestedType\":\"Customer\"},\"PaymentTransaction\":{\"AmountsReq\":{\"Currency\":\"EUR\",\"RequestedAmount\":10100.0}},\"PaymentData\":{\"PaymentType\":\"Normal\"}}}}";
+        private static string ExpectedSaleToPoiMessageJson => @"{""SaleToPOIRequest"":{""MessageHeader"":{""MessageClass"":""Service"",""MessageCategory"":""Payment"",""MessageType"":""Request"",""ServiceID"":""12345678"",""SaleID"":""POSSystemID12345"",""POIID"":""MX915-284251016"",""ProtocolVersion"":""3.0""},""PaymentRequest"":{""SaleData"":{""SaleTransactionID"":{""TransactionID"":""PosAuth"",""TimeStamp"":""2025-01-01T00:00:00""},""SaleToAcquirerData"":""eyJhcHBsaWNhdGlvbkluZm8iOnsiYWR5ZW5MaWJyYXJ5Ijp7Im5hbWUiOiJhZHllbi1kb3RuZXQtYXBpLWxpYnJhcnkiLCJ2ZXJzaW9uIjoiMjYuMS4wIn19fQ=="",""TokenRequestedType"":""Customer""},""PaymentTransaction"":{""AmountsReq"":{""Currency"":""EUR"",""RequestedAmount"":10100.0}},""PaymentData"":{""PaymentType"":""Normal""}}}}";
 
-        private static string ExpectedSaleToPoiMessageSecuredJson =>
-            "{\"SaleToPOIRequest\":{\"MessageHeader\":{\"MessageClass\":\"Service\",\"MessageCategory\":\"Payment\",\"MessageType\":\"Request\",\"ServiceID\":\"12345678\",\"SaleID\":\"POSSystemID12345\",\"POIID\":\"MX915-284251016\",\"ProtocolVersion\":\"3.0\"},\"NexoBlob\":null,\"SecurityTrailer\":{\"AdyenCryptoVersion\":1,\"KeyIdentifier\":\"CryptoKeyIdentifier12345\",\"KeyVersion\":0,\"Hmac\":\"0lPogF5Mg97Nty9ZUuAnb3v8pvZTZvwouxdMp0HV+yQ=\"}}}";
+        private static string ExpectedSaleToPoiMessageSecuredJson => @"{""SaleToPOIRequest"":{""MessageHeader"":{""MessageClass"":""Service"",""MessageCategory"":""Payment"",""MessageType"":""Request"",""ServiceID"":""12345678"",""SaleID"":""POSSystemID12345"",""POIID"":""MX915-284251016"",""ProtocolVersion"":""3.0""},""NexoBlob"":null,""SecurityTrailer"":{""AdyenCryptoVersion"":1,""KeyIdentifier"":""CryptoKeyIdentifier12345"",""KeyVersion"":1,""Hmac"":""mBUD3BeMrloo5aPlwUCFIa87YW8hY9/i3AcrOa2qbhk=""}}}";
     }
 }
diff --git a/Adyen/ApiSerialization/Converter/JsonConvertSerializerWrapper.cs b/Adyen/ApiSerialization/Converter/JsonConvertSerializerWrapper.cs
@@ -11,26 +11,42 @@ internal class JsonConvertSerializerWrapper
     {
         private const string DateTimeFormat = "yyyy-MM-ddTHH\\:mm\\:ss";
 
-        private static readonly JsonSerializerSettings SaleToPoiMessageSerializerSettings = CreateSerializerSettings(new SaleToPoiMessageConverter());
-        private static readonly JsonSerializerSettings SaleToPoiMessageSecuredSerializerSettings = CreateSerializerSettings(new SaleToPoiMessageSecuredConverter());
+        private static readonly JsonSerializerSettings SaleToPoiMessageSerializerSettings = CreateMessageSerializerSettings();
+        private static readonly JsonSerializerSettings SaleToPoiMessageSecuredSerializerSettings = CreateSecuredMessageSerializerSettings();
 
         internal static string Serialize(SaleToPOIMessage saleToPoiMessage)
         {
             return JsonConvert.SerializeObject(saleToPoiMessage, SaleToPoiMessageSerializerSettings);
         }
-
+        
+        private static JsonSerializerSettings CreateMessageSerializerSettings()
+        {
+            return new JsonSerializerSettings
+            {
+                Converters = new List<JsonConverter>
+                {
+                    new SaleToPoiMessageConverter(),
+                    new StringEnumConverter(),
+                    new IsoDateTimeConverter { DateTimeFormat = DateTimeFormat }
+                },
+                NullValueHandling = NullValueHandling.Ignore,
+                MissingMemberHandling = MissingMemberHandling.Ignore,
+                ContractResolver = new DefaultContractResolver()
+            };
+        }
+        
         internal static string Serialize(SaleToPoiMessageSecured saleToPoiMessageSecured)
         {
             return JsonConvert.SerializeObject(saleToPoiMessageSecured, SaleToPoiMessageSecuredSerializerSettings);
         }
 
-        private static JsonSerializerSettings CreateSerializerSettings(JsonConverter messageConverter)
+        private static JsonSerializerSettings CreateSecuredMessageSerializerSettings()
         {
             return new JsonSerializerSettings
             {
                 Converters = new List<JsonConverter>
                 {
-                    messageConverter,
+                    new SaleToPoiMessageSecuredConverter(),
                     new StringEnumConverter(),
                     new IsoDateTimeConverter { DateTimeFormat = DateTimeFormat }
                 },

Original file line number	Diff line number	Diff line change
`@@ -93,15 +93,15 @@ public void CheckoutSessionResponseCheckForIdTest()`
`93`	`93`	`[TestMethod]`
`94`	`94`	`public void SaleToPoiMessageSerializationTest()`
`95`	`95`	`{`
`96`		`- var saleToPoiMessage = PosPaymentRequest;`
`97`		`- var serialized = SerializeSaleToPoiMessage(saleToPoiMessage);`
	`96`	`+ SaleToPOIRequest saleToPoiMessage = CreatePosPaymentRequest();`
	`97`	`+ string serialized = SerializeSaleToPoiMessage(saleToPoiMessage);`
`98`	`98`	`Assert.AreEqual(serialized, ExpectedSaleToPoiMessageJson);`
`99`	`99`	`}`
`100`	`100`
`101`	`101`	`[TestMethod]`
`102`	`102`	`public void SaleToPoiMessageWithUpdatedJsonConvertDefaultSettingsSerializationTest()`
`103`	`103`	`{`
`104`		`- var saleToPoiMessage = PosPaymentRequest;`
	`104`	`+ SaleToPOIRequest saleToPoiMessage = CreatePosPaymentRequest();`
`105`	`105`
`106`	`106`	`JsonConvert.DefaultSettings = () => new JsonSerializerSettings`
`107`	`107`	`{`
`@@ -111,10 +111,9 @@ public void SaleToPoiMessageWithUpdatedJsonConvertDefaultSettingsSerializationTe`
`111`	`111`	`}`
`112`	`112`	`};`
`113`	`113`
	`114`	`+ string serialized = SerializeSaleToPoiMessage(saleToPoiMessage);`
`114`	`115`	`try`
`115`	`116`	`{`
`116`		`- var serialized = SerializeSaleToPoiMessage(saleToPoiMessage);`
`117`		`-`
`118`	`117`	`Assert.AreEqual(serialized, ExpectedSaleToPoiMessageJson);`
`119`	`118`	`}`
`120`	`119`	`finally`
`@@ -126,15 +125,15 @@ public void SaleToPoiMessageWithUpdatedJsonConvertDefaultSettingsSerializationTe`
`126`	`125`	`[TestMethod]`
`127`	`126`	`public void SaleToPoiMessageSecuredSerializationTest()`
`128`	`127`	`{`
`129`		`- var saleToPoiMessage = PosPaymentRequest;`
`130`		`- var serialized = SerializeSaleToPoiMessageSecured(saleToPoiMessage);`
	`128`	`+ SaleToPOIRequest saleToPoiMessage = CreatePosPaymentRequest();`
	`129`	`+ string serialized = SerializeSaleToPoiMessageSecured(saleToPoiMessage);`
`131`	`130`	`Assert.AreEqual(serialized, ExpectedSaleToPoiMessageSecuredJson);`
`132`	`131`	`}`
`133`	`132`
`134`	`133`	`[TestMethod]`
`135`	`134`	`public void SaleToPoiMessageSecuredWithUpdatedJsonConvertDefaultSettingsSerializationTest()`
`136`	`135`	`{`
`137`		`- var saleToPoiMessage = PosPaymentRequest;`
	`136`	`+ SaleToPOIRequest saleToPoiMessage = CreatePosPaymentRequest();`
`138`	`137`
`139`	`138`	`JsonConvert.DefaultSettings = () => new JsonSerializerSettings`
`140`	`139`	`{`
`@@ -146,7 +145,7 @@ public void SaleToPoiMessageSecuredWithUpdatedJsonConvertDefaultSettingsSerializ`
`146`	`145`
`147`	`146`	`try`
`148`	`147`	`{`
`149`		`- var serialized = SerializeSaleToPoiMessageSecured(saleToPoiMessage);`
	`148`	`+ string serialized = SerializeSaleToPoiMessageSecured(saleToPoiMessage);`
`150`	`149`
`151`	`150`	`Assert.AreEqual(serialized, ExpectedSaleToPoiMessageSecuredJson);`
`152`	`151`	`}`
`@@ -167,7 +166,6 @@ private static string SerializeSaleToPoiMessage(SaleToPOIMessage saleToPoiMessag`
`167`	`166`	`return saleToPoiMessageSerializer.Serialize(saleToPoiMessage);`
`168`	`167`	`}`
`169`	`168`
`170`		`-`
`171`	`169`	`private static string SerializeSaleToPoiMessageSecured(SaleToPOIMessage saleToPoiMessage)`
`172`	`170`	`{`
`173`	`171`	`var saleToPoiMessageSerializer = new SaleToPoiMessageSerializer();`
`@@ -176,6 +174,7 @@ private static string SerializeSaleToPoiMessageSecured(SaleToPOIMessage saleToPo`
`176`	`174`	`var encryptionCredentialDetails = new EncryptionCredentialDetails`
`177`	`175`	`{`
`178`	`176`	`AdyenCryptoVersion = 1,`
	`177`	`+ KeyVersion = 1,`
`179`	`178`	`KeyIdentifier = "CryptoKeyIdentifier12345",`
`180`	`179`	`Password = "p@ssw0rd123456"`
`181`	`180`	`};`
`@@ -192,8 +191,9 @@ private static string SerializeSaleToPoiMessageSecured(SaleToPOIMessage saleToPo`
`192`	`191`	`return saleToPoiMessageSerializer.Serialize(saleToPoiMessageSecured);`
`193`	`192`	`}`
`194`	`193`
`195`		`- private static SaleToPOIRequest PosPaymentRequest =>`
`196`		`- new SaleToPOIRequest`
	`194`	`+ private static SaleToPOIRequest CreatePosPaymentRequest()`
	`195`	`+ {`
	`196`	`+ return new SaleToPOIRequest`
`197`	`197`	`{`
`198`	`198`	`MessageHeader = new MessageHeader`
`199`	`199`	`{`
`@@ -229,11 +229,10 @@ private static string SerializeSaleToPoiMessageSecured(SaleToPOIMessage saleToPo`
`229`	`229`	`}`
`230`	`230`	`}`
`231`	`231`	`};`
	`232`	`+ }`
`232`	`233`
`233`		`- private static string ExpectedSaleToPoiMessageJson =>`
`234`		- "{\"SaleToPOIRequest\":{\"MessageHeader\":{\"MessageClass\":\"Service\",\"MessageCategory\":\"Payment\",\"MessageType\":\"Request\",\"ServiceID\":\"12345678\",\"SaleID\":\"POSSystemID12345\",\"POIID\":\"MX915-284251016\",\"ProtocolVersion\":\"3.0\"},\"PaymentRequest\":{\"SaleData\":{\"SaleTransactionID\":{\"TransactionID\":\"PosAuth\",\"TimeStamp\":\"2025-01-01T00:00:00\"},\"SaleToAcquirerData\":\"eyJhcHBsaWNhdGlvbkluZm8iOnsiYWR5ZW5MaWJyYXJ5Ijp7Im5hbWUiOiJhZHllbi1kb3RuZXQtYXBpLWxpYnJhcnkiLCJ2ZXJzaW9uIjoiMjYuMC4wIn19fQ==\",\"TokenRequestedType\":\"Customer\"},\"PaymentTransaction\":{\"AmountsReq\":{\"Currency\":\"EUR\",\"RequestedAmount\":10100.0}},\"PaymentData\":{\"PaymentType\":\"Normal\"}}}}";
	`234`	+ private static string ExpectedSaleToPoiMessageJson => @"{""SaleToPOIRequest"":{""MessageHeader"":{""MessageClass"":""Service"",""MessageCategory"":""Payment"",""MessageType"":""Request"",""ServiceID"":""12345678"",""SaleID"":""POSSystemID12345"",""POIID"":""MX915-284251016"",""ProtocolVersion"":""3.0""},""PaymentRequest"":{""SaleData"":{""SaleTransactionID"":{""TransactionID"":""PosAuth"",""TimeStamp"":""2025-01-01T00:00:00""},""SaleToAcquirerData"":""eyJhcHBsaWNhdGlvbkluZm8iOnsiYWR5ZW5MaWJyYXJ5Ijp7Im5hbWUiOiJhZHllbi1kb3RuZXQtYXBpLWxpYnJhcnkiLCJ2ZXJzaW9uIjoiMjYuMS4wIn19fQ=="",""TokenRequestedType"":""Customer""},""PaymentTransaction"":{""AmountsReq"":{""Currency"":""EUR"",""RequestedAmount"":10100.0}},""PaymentData"":{""PaymentType"":""Normal""}}}}";
`235`	`235`
`236`		`- private static string ExpectedSaleToPoiMessageSecuredJson =>`
`237`		`- "{\"SaleToPOIRequest\":{\"MessageHeader\":{\"MessageClass\":\"Service\",\"MessageCategory\":\"Payment\",\"MessageType\":\"Request\",\"ServiceID\":\"12345678\",\"SaleID\":\"POSSystemID12345\",\"POIID\":\"MX915-284251016\",\"ProtocolVersion\":\"3.0\"},\"NexoBlob\":null,\"SecurityTrailer\":{\"AdyenCryptoVersion\":1,\"KeyIdentifier\":\"CryptoKeyIdentifier12345\",\"KeyVersion\":0,\"Hmac\":\"0lPogF5Mg97Nty9ZUuAnb3v8pvZTZvwouxdMp0HV+yQ=\"}}}";`
	`236`	+ private static string ExpectedSaleToPoiMessageSecuredJson => @"{""SaleToPOIRequest"":{""MessageHeader"":{""MessageClass"":""Service"",""MessageCategory"":""Payment"",""MessageType"":""Request"",""ServiceID"":""12345678"",""SaleID"":""POSSystemID12345"",""POIID"":""MX915-284251016"",""ProtocolVersion"":""3.0""},""NexoBlob"":null,""SecurityTrailer"":{""AdyenCryptoVersion"":1,""KeyIdentifier"":""CryptoKeyIdentifier12345"",""KeyVersion"":1,""Hmac"":""mBUD3BeMrloo5aPlwUCFIa87YW8hY9/i3AcrOa2qbhk=""}}}";
`238`	`237`	`}`
`239`	`238`	`}`