Introduce separate constants for API version and Web Components between SG and SFRA

jest/sfccCartridgeMocks.js

@@ -221,6 +221,7 @@ jest.mock('*/cartridge/scripts/util/adyenHelper', () => ({
     isAdyenGivingAvailable: jest.fn(() => true),
     isApplePay: jest.fn(() => true),
     getAdyenGivingConfig: jest.fn(() => true),
+    getApplicationInfo: jest.fn(() => ({externalPlatform: {version: 'SFRA'}})),
     isOpenInvoiceMethod: jest.fn(() => false),
     getDonationAmounts: jest.fn(() => [10, 20, 30]),
     getCardToken: jest.fn(() => 'mocked_token'),

metadata/site_import/services.xml

@@ -5,41 +5,81 @@
         <user-id></user-id>
         <password/>
     </service-credential>
+    <service-credential service-credential-id="AdyenPaymentSG">
+        <url>https://checkout-test.adyen.com/checkout/v69/payments</url>
+        <user-id></user-id>
+        <password/>
+    </service-credential>
     <service-credential service-credential-id="AdyenPaymentLive">
         <url>https://[YOUR_LIVE_PREFIX]-checkout-live.adyenpayments.com/checkout/v69/payments</url>
         <user-id></user-id>
         <password/>
     </service-credential>
+    <service-credential service-credential-id="AdyenPaymentLiveSG">
+        <url>https://[YOUR_LIVE_PREFIX]-checkout-live.adyenpayments.com/checkout/v69/payments</url>
+        <user-id></user-id>
+        <password/>
+    </service-credential>
     <service-credential service-credential-id="AdyenPaymentDetails">
         <url>https://checkout-test.adyen.com/checkout/v69/payments/details</url>
         <user-id></user-id>
         <password/>
     </service-credential>
+    <service-credential service-credential-id="AdyenPaymentDetailsSG">
+        <url>https://checkout-test.adyen.com/checkout/v69/payments/details</url>
+        <user-id></user-id>
+        <password/>
+    </service-credential>
     <service-credential service-credential-id="AdyenSessions">
         <url>https://checkout-test.adyen.com/checkout/v69/sessions</url>
         <user-id></user-id>
         <password/>
     </service-credential>
+    <service-credential service-credential-id="AdyenSessionsSG">
+        <url>https://checkout-test.adyen.com/checkout/v69/sessions</url>
+        <user-id></user-id>
+        <password/>
+    </service-credential>
     <service-credential service-credential-id="AdyenSessionsLive">
         <url>https://[YOUR_LIVE_PREFIX]-checkout-live.adyenpayments.com/checkout/v69/sessions</url>
         <user-id></user-id>
         <password/>
     </service-credential>
+    <service-credential service-credential-id="AdyenSessionsLiveSG">
+        <url>https://[YOUR_LIVE_PREFIX]-checkout-live.adyenpayments.com/checkout/v69/sessions</url>
+        <user-id></user-id>
+        <password/>
+    </service-credential>
     <service-credential service-credential-id="AdyenPaymentDetailsLive">
         <url>https://[YOUR_LIVE_PREFIX]-checkout-live.adyenpayments.com/checkout/v69/payments/details</url>
         <user-id></user-id>
         <password/>
     </service-credential>
+    <service-credential service-credential-id="AdyenPaymentDetailsLiveSG">
+        <url>https://[YOUR_LIVE_PREFIX]-checkout-live.adyenpayments.com/checkout/v69/payments/details</url>
+        <user-id></user-id>
+        <password/>
+    </service-credential>
     <service-credential service-credential-id="AdyenCheckoutPaymentMethods">
         <url>https://checkout-test.adyen.com/v69/paymentMethods</url>
         <user-id></user-id>
         <password/>
     </service-credential>
+    <service-credential service-credential-id="AdyenCheckoutPaymentMethodsSG">
+        <url>https://checkout-test.adyen.com/v69/paymentMethods</url>
+        <user-id></user-id>
+        <password/>
+    </service-credential>
     <service-credential service-credential-id="AdyenCheckoutPaymentMethodsLive">
         <url>https://[YOUR_LIVE_PREFIX]-checkout-live.adyenpayments.com/checkout/v69/paymentMethods</url>
         <user-id></user-id>
         <password/>
     </service-credential>
+    <service-credential service-credential-id="AdyenCheckoutPaymentMethodsLiveSG">
+        <url>https://[YOUR_LIVE_PREFIX]-checkout-live.adyenpayments.com/checkout/v69/paymentMethods</url>
+        <user-id></user-id>
+        <password/>
+    </service-credential>
     <service-credential service-credential-id="AdyenRecurringDisable">
         <url>https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable</url>
         <user-id></user-id>
@@ -80,6 +120,16 @@
         <user-id></user-id>
         <password/>
     </service-credential>
+    <service-credential service-credential-id="AdyenGivingSG">
+        <url>https://checkout-test.adyen.com/v69/donations</url>
+        <user-id></user-id>
+        <password/>
+    </service-credential>
+    <service-credential service-credential-id="AdyenGivingLiveSG">
+        <url>https://[YOUR_LIVE_PREFIX]-checkout-live.adyenpayments.com/checkout/v69/donations</url>
+        <user-id></user-id>
+        <password/>
+    </service-credential>
     <service-credential service-credential-id="AdyenPartialPaymentsOrder">
         <url>https://checkout-test.adyen.com/v69/orders</url>
         <user-id></user-id>
@@ -114,6 +164,15 @@
         <profile-id>Adyen</profile-id>
         <credential-id>AdyenPayment</credential-id>
     </service>
+    <service service-id="AdyenPaymentSG">
+        <service-type>HTTP</service-type>
+        <enabled>true</enabled>
+        <log-prefix>adyen</log-prefix>
+        <comm-log-enabled>true</comm-log-enabled>
+        <mock-mode-enabled>false</mock-mode-enabled>
+        <profile-id>Adyen</profile-id>
+        <credential-id>AdyenPaymentSG</credential-id>
+    </service>
     <service service-id="AdyenPaymentDetails">
         <service-type>HTTP</service-type>
         <enabled>true</enabled>
@@ -123,6 +182,15 @@
         <profile-id>Adyen</profile-id>
         <credential-id>AdyenPaymentDetails</credential-id>
     </service>
+    <service service-id="AdyenPaymentDetailsSG">
+        <service-type>HTTP</service-type>
+        <enabled>true</enabled>
+        <log-prefix>adyen</log-prefix>
+        <comm-log-enabled>true</comm-log-enabled>
+        <mock-mode-enabled>false</mock-mode-enabled>
+        <profile-id>Adyen</profile-id>
+        <credential-id>AdyenPaymentDetailsSG</credential-id>
+    </service>
     <service service-id="AdyenRecurring">
         <service-type>HTTP</service-type>
         <enabled>true</enabled>
@@ -141,6 +209,15 @@
         <profile-id>Adyen</profile-id>
         <credential-id>AdyenCheckoutPaymentMethods</credential-id>
     </service>
+    <service service-id="AdyenCheckoutPaymentMethodsSG">
+        <service-type>HTTP</service-type>
+        <enabled>true</enabled>
+        <log-prefix>adyen</log-prefix>
+        <comm-log-enabled>true</comm-log-enabled>
+        <mock-mode-enabled>false</mock-mode-enabled>
+        <profile-id>Adyen</profile-id>
+        <credential-id>AdyenCheckoutPaymentMethodsSG</credential-id>
+    </service>
     <service service-id="AdyenSessions">
         <service-type>HTTP</service-type>
         <enabled>true</enabled>
@@ -150,6 +227,15 @@
         <profile-id>Adyen</profile-id>
         <credential-id>AdyenSessions</credential-id>
     </service>
+    <service service-id="AdyenSessionsSG">
+        <service-type>HTTP</service-type>
+        <enabled>true</enabled>
+        <log-prefix>adyen</log-prefix>
+        <comm-log-enabled>true</comm-log-enabled>
+        <mock-mode-enabled>false</mock-mode-enabled>
+        <profile-id>Adyen</profile-id>
+        <credential-id>AdyenSessionsSG</credential-id>
+    </service>
     <service service-id="AdyenRecurringDisable">
         <service-type>HTTP</service-type>
         <enabled>true</enabled>
@@ -186,6 +272,15 @@
         <profile-id>Adyen</profile-id>
         <credential-id>AdyenGiving</credential-id>
     </service>
+    <service service-id="AdyenGivingSG">
+        <service-type>HTTP</service-type>
+        <enabled>true</enabled>
+        <log-prefix>adyen</log-prefix>
+        <comm-log-enabled>true</comm-log-enabled>
+        <mock-mode-enabled>false</mock-mode-enabled>
+        <profile-id>Adyen</profile-id>
+        <credential-id>AdyenGivingSG</credential-id>
+    </service>
     <service service-id="AdyenPartialPaymentsOrder">
         <service-type>HTTP</service-type>
         <enabled>true</enabled>

src/cartridges/int_adyen_SFRA/cartridge/scripts/adyenService.js

@@ -65,6 +65,12 @@ function submit(order) {
   }
 }
 
+const EXTERNAL_PLATFORM_VERSION = 'SFRA';
+function getExternalPlatformVersion() {
+  return EXTERNAL_PLATFORM_VERSION;
+}
+
 module.exports = {
   submit,
+  getExternalPlatformVersion,
 };

src/cartridges/int_adyen_controllers/cartridge/scripts/adyenService.js

@@ -6,6 +6,12 @@ function submit(order) {
   return OrderModel.submit(order);
 }
 
+const EXTERNAL_PLATFORM_VERSION = 'SG';
+function getExternalPlatformVersion() {
+  return EXTERNAL_PLATFORM_VERSION;
+}
+
 module.exports = {
   submit,
+  getExternalPlatformVersion
 };

src/cartridges/int_adyen_overlay/cartridge/adyenConstants/constants.js

@@ -34,6 +34,11 @@ module.exports = {
     AMAZONPAY: 'amazonpay',
   },
 
+  PLATFORMS: {
+    SFRA: 'SFRA',
+    SG: 'SG'
+  },
+
   SERVICE: {
     PAYMENT: 'AdyenPayment',
     PAYMENTDETAILS: 'AdyenPaymentDetails',
@@ -80,6 +85,9 @@ module.exports = {
   CHECKOUT_ENVIRONMENT_LIVE_AU: 'live-au',
   CHECKOUT_ENVIRONMENT_LIVE_IN: 'live-in',
 
-  CHECKOUT_COMPONENT_VERSION: '5.28.0',
+  CHECKOUT_COMPONENT_VERSION: {
+    SFRA: '5.28.0',
+    SG: '5.28.0'
+  },
   VERSION: '23.1.1',
 };

src/cartridges/int_adyen_overlay/cartridge/scripts/adyenCheckout.js

@@ -177,8 +177,10 @@ function doPaymentsCall(order, paymentInstrument, paymentRequest) {
   const paymentResponse = {};
   let errorMessage = '';
   try {
+    const platformVersion = AdyenHelper.getApplicationInfo().externalPlatform.version;
+    const service = platformVersion === constants.PLATFORMS.SG ? `${constants.SERVICE.PAYMENT}${constants.PLATFORMS.SG}` : constants.SERVICE.PAYMENT;
     const responseObject = AdyenHelper.executeCall(
-      constants.SERVICE.PAYMENT,
+      service,
       paymentRequest,
     );
     // There is no order for zero auth transactions.
@@ -277,8 +279,10 @@ function doPaymentsCall(order, paymentInstrument, paymentRequest) {
 
 function doPaymentsDetailsCall(paymentDetailsRequest) {
   try {
+      const platformVersion = AdyenHelper.getApplicationInfo().externalPlatform.version;
+      const service = platformVersion === constants.PLATFORMS.SG ? `${constants.SERVICE.PAYMENTDETAILS}${constants.PLATFORMS.SG}` : constants.SERVICE.PAYMENTDETAILS;
     return AdyenHelper.executeCall(
-      constants.SERVICE.PAYMENTDETAILS,
+      service,
       paymentDetailsRequest,
     );
   } catch (ex) {

src/cartridges/int_adyen_overlay/cartridge/scripts/adyenGetPaymentMethods.js

@@ -75,7 +75,9 @@ function getMethods(basket, customer, countryCode) {
 
     paymentMethodsRequest.blockedPaymentMethods = AdyenHelper.BLOCKED_PAYMENT_METHODS;
 
-    return AdyenHelper.executeCall(constants.SERVICE.CHECKOUTPAYMENTMETHODS, paymentMethodsRequest);
+    const platformVersion = AdyenHelper.getApplicationInfo().externalPlatform.version;
+    const service = platformVersion === constants.PLATFORMS.SG ? `${constants.SERVICE.CHECKOUTPAYMENTMETHODS}${constants.PLATFORMS.SG}` : constants.SERVICE.CHECKOUTPAYMENTMETHODS;
+    return AdyenHelper.executeCall(service, paymentMethodsRequest);
   } catch (e) {
     AdyenLogs.fatal_log(
       `Adyen: ${e.toString()} in ${e.fileName}:${e.lineNumber}`,

src/cartridges/int_adyen_overlay/cartridge/scripts/adyenGiving.js

@@ -54,8 +54,14 @@ function donate(donationReference, donationAmount, originalReference) {
       shopperInteraction: constants.SHOPPER_INTERACTIONS.CONT_AUTH,
     };
 
-    const response = AdyenHelper.executeCall(constants.SERVICE.ADYENGIVING, requestObject);
-
+    const platformVersion = AdyenHelper.getApplicationInfo().externalPlatform.version;
+    const service = platformVersion === constants.PLATFORMS.SG ? `${constants.SERVICE.ADYENGIVING}${constants.PLATFORMS.SG}` : constants.SERVICE.ADYENGIVING;
+    const response = AdyenHelper.executeCall(service, requestObject);
+
+    Transaction.wrap(() => {
+      const order = OrderMgr.getOrder(donationReference);
+      order.custom.Adyen_donationAmount = JSON.stringify(donationAmount);
+    });
     return response;
   } catch (e) {
     AdyenLogs.error_log(

src/cartridges/int_adyen_overlay/cartridge/scripts/adyenSessions.js

@@ -104,8 +104,9 @@ function createSession(basket, customer, countryCode) {
     }
 
     sessionsRequest.blockedPaymentMethods = blockedPayments.blockedPaymentMethods;
-
-    return AdyenHelper.executeCall(constants.SERVICE.SESSIONS, sessionsRequest); 
+        const platformVersion = AdyenHelper.getApplicationInfo().externalPlatform.version;
+        const service = platformVersion === constants.PLATFORMS.SG ? `${constants.SERVICE.SESSIONS}${constants.PLATFORMS.SG}` : constants.SERVICE.SESSIONS;
+    return AdyenHelper.executeCall(service, sessionsRequest);
   } catch (e) {
     AdyenLogs.fatal_log(
         `Adyen: ${e.toString()} in ${e.fileName}:${e.lineNumber}`,

src/cartridges/int_adyen_overlay/cartridge/scripts/util/adyenHelper.js

@@ -198,13 +198,19 @@ var adyenHelperObj = {
   // get the URL for the checkout component based on the current Adyen component version
   getCheckoutUrl() {
     const checkoutUrl = this.getLoadingContext();
-    return `${checkoutUrl}sdk/${constants.CHECKOUT_COMPONENT_VERSION}/adyen.js`;
+    const adyenService = require('*/cartridge/scripts/adyenService');
+    const externalPlatformVersion = adyenService.getExternalPlatformVersion();
+    const checkoutVersionForPlatform = constants.CHECKOUT_COMPONENT_VERSION[externalPlatformVersion];
+    return `${checkoutUrl}sdk/${checkoutVersionForPlatform}/adyen.js`;
   },
 
   // get the URL for the checkout component css based on the current Adyen component version
   getCheckoutCSS() {
     const checkoutCSS = this.getLoadingContext();
-    return `${checkoutCSS}sdk/${constants.CHECKOUT_COMPONENT_VERSION}/adyen.css`;
+    const adyenService = require('*/cartridge/scripts/adyenService');
+    const externalPlatformVersion = adyenService.getExternalPlatformVersion();
+    const checkoutVersionForPlatform = constants.CHECKOUT_COMPONENT_VERSION[externalPlatformVersion];
+    return `${checkoutCSS}sdk/${checkoutVersionForPlatform}/adyen.css`;
   },
 
   // get the current region-based checkout environment