Merge branch 'main' into cypress-automation-sdk

CHANGELOG.md

@@ -1,3 +1,5 @@
+## [0.101.4](https://github.com/juspay/hyperswitch-web/compare/v0.101.3...v0.101.4) (2024-11-07)
+
 ## [0.101.3](https://github.com/juspay/hyperswitch-web/compare/v0.101.2...v0.101.3) (2024-11-07)
 
 ## [0.101.2](https://github.com/juspay/hyperswitch-web/compare/v0.101.1...v0.101.2) (2024-11-07)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "orca-payment-page",
-  "version": "0.101.3",
+  "version": "0.101.4",
   "main": "index.js",
   "private": true,
   "dependencies": {

src/Hooks/UtilityHooks.res

@@ -61,3 +61,17 @@ let useSendEventsToParent = eventsToSendToParent => {
     Some(() => {Window.removeEventListener("message", handle)})
   })
 }
+
+let useUpdateShouldUseTopRedirection = () => {
+  let setShouldUseTopRedirection = Recoil.useSetRecoilState(RecoilAtoms.shouldUseTopRedirectionAtom)
+  let updateTopRedirectionAtom = paymentOptions => {
+    paymentOptions
+    ->Dict.get("shouldUseTopRedirection")
+    ->Option.flatMap(JSON.Decode.bool)
+    ->Option.map(useTop => {
+      setShouldUseTopRedirection(_ => useTop)
+    })
+    ->ignore
+  }
+  updateTopRedirectionAtom
+}

src/LoaderController.res

@@ -146,6 +146,8 @@ let make = (~children, ~paymentMode, ~setIntegrateErrorError, ~logger, ~initTime
     }
   }
 
+  let updateShouldUseTopRedirection = UtilityHooks.useUpdateShouldUseTopRedirection()
+
   React.useEffect0(() => {
     messageParentWindow([("iframeMounted", true->JSON.Encode.bool)])
     messageParentWindow([
@@ -275,6 +277,9 @@ let make = (~children, ~paymentMode, ~setIntegrateErrorError, ~logger, ~initTime
                 })
                 logger.setClientSecret(clientSecret)
 
+                // Update top redirection atom
+                updateShouldUseTopRedirection(paymentOptions)
+
                 switch getThemePromise(paymentOptions) {
                 | Some(promise) =>
                   promise->then(res => {
@@ -322,6 +327,9 @@ let make = (~children, ~paymentMode, ~setIntegrateErrorError, ~logger, ~initTime
             })
             logger.setClientSecret(clientSecret)
 
+            // Update top redirection atom
+            updateShouldUseTopRedirection(paymentOptions)
+
             switch getThemePromise(paymentOptions) {
             | Some(promise) =>
               promise->then(res => {

src/Utilities/PaymentHelpers.res

@@ -295,6 +295,7 @@ let rec intentCall = (
   ~isPaymentSession=false,
   ~isCallbackUsedVal=?,
   ~componentName="payment",
+  ~shouldUseTopRedirection,
 ) => {
   open Promise
   let isConfirm = uri->String.includes("/confirm")
@@ -322,7 +323,7 @@ let rec intentCall = (
   )
   let handleOpenUrl = url => {
     if isPaymentSession {
-      Window.replaceRootHref(url)
+      Window.replaceRootHref(url, shouldUseTopRedirection)
     } else {
       openUrl(url)
     }
@@ -448,6 +449,7 @@ let rec intentCall = (
                 ~sdkHandleOneClickConfirmPayment,
                 ~counter=counter + 1,
                 ~componentName,
+                ~shouldUseTopRedirection,
               )
               ->then(
                 res => {
@@ -875,6 +877,7 @@ let rec intentCall = (
             ~counter=counter + 1,
             ~isPaymentSession,
             ~componentName,
+            ~shouldUseTopRedirection,
           )
           ->then(
             res => {
@@ -905,6 +908,7 @@ let usePaymentSync = (optLogger: option<HyperLogger.loggerMake>, paymentType: pa
   let keys = Recoil.useRecoilValueFromAtom(keys)
   let isCallbackUsedVal = Recoil.useRecoilValueFromAtom(RecoilAtoms.isCompleteCallbackUsed)
   let customPodUri = Recoil.useRecoilValueFromAtom(customPodUri)
+  let shouldUseTopRedirection = Recoil.useRecoilValueFromAtom(shouldUseTopRedirectionAtom)
   let setIsManualRetryEnabled = Recoil.useSetRecoilState(isManualRetryEnabled)
   (~handleUserError=false, ~confirmParam: ConfirmType.confirmParams, ~iframeId="") => {
     switch keys.clientSecret {
@@ -932,6 +936,7 @@ let usePaymentSync = (optLogger: option<HyperLogger.loggerMake>, paymentType: pa
           ~sdkHandleOneClickConfirmPayment=keys.sdkHandleOneClickConfirmPayment,
           ~counter=0,
           ~isCallbackUsedVal,
+          ~shouldUseTopRedirection,
         )->ignore
       }
       switch paymentMethodList {
@@ -979,6 +984,7 @@ let usePaymentIntent = (optLogger, paymentType) => {
   let paymentMethodList = Recoil.useRecoilValueFromAtom(paymentMethodList)
   let keys = Recoil.useRecoilValueFromAtom(keys)
   let isCallbackUsedVal = Recoil.useRecoilValueFromAtom(RecoilAtoms.isCompleteCallbackUsed)
+  let shouldUseTopRedirection = Recoil.useRecoilValueFromAtom(shouldUseTopRedirectionAtom)
 
   let setIsManualRetryEnabled = Recoil.useSetRecoilState(isManualRetryEnabled)
   (
@@ -1074,6 +1080,7 @@ let usePaymentIntent = (optLogger, paymentType) => {
             ~counter=0,
             ~isCallbackUsedVal,
             ~componentName,
+            ~shouldUseTopRedirection,
           )
           ->then(val => {
             intentCallback(val)
@@ -1159,6 +1166,7 @@ let useCompleteAuthorize = (optLogger: option<HyperLogger.loggerMake>, paymentTy
   let setIsManualRetryEnabled = Recoil.useSetRecoilState(isManualRetryEnabled)
   let url = RescriptReactRouter.useUrl()
   let isCallbackUsedVal = Recoil.useRecoilValueFromAtom(RecoilAtoms.isCompleteCallbackUsed)
+  let shouldUseTopRedirection = Recoil.useRecoilValueFromAtom(shouldUseTopRedirectionAtom)
   let paymentTypeFromUrl =
     CardUtils.getQueryParamsDictforKey(url.search, "componentName")->CardThemeType.getPaymentMode
   (
@@ -1203,6 +1211,7 @@ let useCompleteAuthorize = (optLogger: option<HyperLogger.loggerMake>, paymentTy
           ~sdkHandleOneClickConfirmPayment=keys.sdkHandleOneClickConfirmPayment,
           ~counter=0,
           ~isCallbackUsedVal,
+          ~shouldUseTopRedirection,
         )->ignore
       }
       switch paymentMethodList {
@@ -1595,6 +1604,7 @@ let paymentIntentForPaymentSession = (
   ~clientSecret,
   ~logger,
   ~customPodUri,
+  ~shouldUseTopRedirection,
 ) => {
   let confirmParams =
     payload
@@ -1651,6 +1661,7 @@ let paymentIntentForPaymentSession = (
     ~sdkHandleOneClickConfirmPayment=false,
     ~counter=0,
     ~isPaymentSession=true,
+    ~shouldUseTopRedirection,
   )
 }
 
@@ -2087,6 +2098,7 @@ let usePostSessionTokens = (
   let customPodUri = Recoil.useRecoilValueFromAtom(customPodUri)
   let paymentMethodList = Recoil.useRecoilValueFromAtom(paymentMethodList)
   let keys = Recoil.useRecoilValueFromAtom(keys)
+  let shouldUseTopRedirection = Recoil.useRecoilValueFromAtom(RecoilAtoms.shouldUseTopRedirectionAtom)
 
   let setIsManualRetryEnabled = Recoil.useSetRecoilState(isManualRetryEnabled)
   (
@@ -2178,6 +2190,7 @@ let usePostSessionTokens = (
           ~customPodUri,
           ~sdkHandleOneClickConfirmPayment=keys.sdkHandleOneClickConfirmPayment,
           ~counter=0,
+          ~shouldUseTopRedirection,
         )
         ->then(val => {
           intentCallback(val)

src/Utilities/RecoilAtoms.res

@@ -12,6 +12,7 @@ let sessionId = Recoil.atom("sessionId", "")
 let isConfirmBlocked = Recoil.atom("isConfirmBlocked", false)
 let customPodUri = Recoil.atom("customPodUri", "")
 let selectedOptionAtom = Recoil.atom("selectedOption", "")
+let shouldUseTopRedirectionAtom = Recoil.atom("shouldUseTopRedirection", false)
 let paymentTokenAtom = Recoil.atom(
   "paymentToken",
   {

src/Window.res

@@ -205,4 +205,21 @@ let getRootHostName = () =>
   }
 
 /* Redirect Handling */
-let replaceRootHref = (href: string) => Location.replace(href)
+let replaceRootHref = (href: string, shouldUseTopRedirection: bool) => {
+  switch shouldUseTopRedirection {
+  | true =>
+    try {
+      Top.Location.replace(href)
+    } catch {
+    | e => {
+        Js.Console.error3(
+          "Failed to redirect root document",
+          e,
+          `Using [window.location.replace] for redirection`,
+        )
+        Location.replace(href)
+      }
+    }
+  | false => Location.replace(href)
+  }
+}

src/hyper-loader/Elements.res

@@ -20,6 +20,7 @@ let make = (
   ~logger: option<HyperLogger.loggerMake>,
   ~analyticsMetadata,
   ~customBackendUrl,
+  ~shouldUseTopRedirection,
 ) => {
   try {
     let iframeRef = []
@@ -310,6 +311,7 @@ let make = (
             ("locale", locale),
             ("loader", loader),
             ("fonts", fonts),
+            ("shouldUseTopRedirection", shouldUseTopRedirection->JSON.Encode.bool),
           ]->getJsonFromArrayOfJson
         let message = [
           (
@@ -667,7 +669,7 @@ let make = (
             let returnUrl = dict->getString("return_url", "")
             let redirectUrl = `${returnUrl}?payment_intent_client_secret=${clientSecret}&status=${status}`
             if redirect.contents === "always" {
-              Window.replaceRootHref(redirectUrl)
+              Window.replaceRootHref(redirectUrl, shouldUseTopRedirection)
               resolve(JSON.Encode.null)
             } else {
               messageCurrentWindow([
@@ -695,7 +697,7 @@ let make = (
 
               let handleErrorResponse = err => {
                 if redirect.contents === "always" {
-                  Window.replaceRootHref(url)
+                  Window.replaceRootHref(url, shouldUseTopRedirection)
                 }
                 messageCurrentWindow([
                   ("submitSuccessful", false->JSON.Encode.bool),
@@ -756,7 +758,10 @@ let make = (
             ->then(json => json->handleRetrievePaymentResponse)
             ->catch(err => {
               if redirect.contents === "always" {
-                Window.replaceRootHref(redirectUrl->JSON.Decode.string->Option.getOr(""))
+                Window.replaceRootHref(
+                  redirectUrl->JSON.Decode.string->Option.getOr(""),
+                  shouldUseTopRedirection,
+                )
                 resolve(JSON.Encode.null)
               } else {
                 messageCurrentWindow([
@@ -1157,6 +1162,7 @@ let make = (
         setElementIframeRef,
         iframeRef,
         mountPostMessage,
+        ~shouldUseTopRedirection,
       )
       savedPaymentElement->Dict.set(componentType, paymentElement)
       paymentElement

src/hyper-loader/Hyper.res

@@ -141,6 +141,11 @@ let make = (publishableKey, options: option<JSON.t>, analyticsInfo: option<JSON.
       ->Option.getOr(JSON.Encode.null)
       ->Utils.getDictFromJson
       ->Utils.getBool("isPreloadEnabled", true)
+    let shouldUseTopRedirection =
+      options
+      ->Option.getOr(JSON.Encode.null)
+      ->Utils.getDictFromJson
+      ->Utils.getBool("shouldUseTopRedirection", false)
     let analyticsMetadata =
       options
       ->Option.getOr(JSON.Encode.null)
@@ -393,9 +398,9 @@ let make = (publishableKey, options: option<JSON.t>, analyticsInfo: option<JSON.
                 let submitSuccessfulValue = val->JSON.Decode.bool->Option.getOr(false)
 
                 if isSdkButton && submitSuccessfulValue {
-                  Window.replaceRootHref(returnUrl)
+                  Window.replaceRootHref(returnUrl, shouldUseTopRedirection)
                 } else if submitSuccessfulValue && redirect === "always" {
-                  Window.replaceRootHref(returnUrl)
+                  Window.replaceRootHref(returnUrl, shouldUseTopRedirection)
                 } else if !submitSuccessfulValue {
                   resolve1(json)
                 } else {
@@ -487,6 +492,7 @@ let make = (publishableKey, options: option<JSON.t>, analyticsInfo: option<JSON.
           ->Option.getOr(JSON.Encode.null)
           ->getDictFromJson
           ->getString("customBackendUrl", ""),
+          ~shouldUseTopRedirection,
         )
       }
 
@@ -572,7 +578,7 @@ let make = (publishableKey, options: option<JSON.t>, analyticsInfo: option<JSON.
                 )
                 let url = decodedData->getString("return_url", "/")
                 if val->JSON.Decode.bool->Option.getOr(false) && url !== "/" {
-                  Window.replaceRootHref(url)
+                  Window.replaceRootHref(url, shouldUseTopRedirection)
                 } else {
                   resolve(json)
                 }
@@ -669,6 +675,7 @@ let make = (publishableKey, options: option<JSON.t>, analyticsInfo: option<JSON.
           ~publishableKey,
           ~logger=Some(logger),
           ~ephemeralKey=ephemeralKey.contents,
+          ~shouldUseTopRedirection,
         )
       }
 

src/hyper-loader/LoaderPaymentElement.res

@@ -15,6 +15,7 @@ let make = (
   iframeRef,
   mountPostMessage,
   ~isPaymentManagementElement=false,
+  ~shouldUseTopRedirection,
 ) => {
   try {
     let mountId = ref("")
@@ -243,7 +244,7 @@ let make = (
         switch eventDataObject->getOptionalJsonFromJson("openurl") {
         | Some(val) => {
             let url = val->getStringFromJson("")
-            Window.replaceRootHref(url)
+            Window.replaceRootHref(url, shouldUseTopRedirection)
           }
         | None => ()
         }

src/hyper-loader/PaymentMethodsManagementElements.res

@@ -222,6 +222,7 @@ let make = (
         iframeRef,
         mountPostMessage,
         ~isPaymentManagementElement=true,
+        ~shouldUseTopRedirection=false,
       )
       savedPaymentElement->Dict.set(componentType, paymentElement)
       paymentElement

src/hyper-loader/PaymentSession.res

@@ -6,6 +6,7 @@ let make = (
   ~publishableKey,
   ~logger: option<HyperLogger.loggerMake>,
   ~ephemeralKey,
+  ~shouldUseTopRedirection,
 ) => {
   let logger = logger->Option.getOr(HyperLogger.defaultLoggerConfig)
   let customPodUri =
@@ -24,6 +25,7 @@ let make = (
         ~endpoint,
         ~logger,
         ~customPodUri,
+        ~shouldUseTopRedirection,
       ),
     getPaymentManagementMethods: _ =>
       PaymentSessionMethods.getPaymentManagementMethods(