Add support for round-tripping the user through Unified Ecommerce on …

…login (#2515)

.secrets.baseline

@@ -166,7 +166,7 @@
         "filename": "frontend/public/src/lib/auth.js",
         "hashed_secret": "e3c328a97de7239b3f60eecda765a69535205744",
         "is_verified": false,
-        "line_number": 23
+        "line_number": 25
       }
     ],
     "frontend/public/src/lib/test_constants.js": [
@@ -240,5 +240,5 @@
       }
     ]
   },
-  "generated_at": "2024-11-05T12:32:12Z"
+  "generated_at": "2025-01-22T20:35:24Z"
 }

app.json

@@ -612,6 +612,10 @@
       "description": "Token to access the status API.",
       "required": false
     },
+    "UNIFIED_ECOMMERCE_URL": {
+      "description": "The base URL for Unified Ecommerce.",
+      "required": false
+    },
     "USE_X_FORWARDED_HOST": {
       "description": "Set HOST header to original domain accessed by user",
       "required": false

frontend/public/src/flow/declarations.js

@@ -21,7 +21,8 @@ declare type Settings = {
   digital_credentials: boolean,
   digital_credentials_supported_runs: Array<string>,
   posthog_api_token: ?string,
-  posthog_api_host: ?string
+  posthog_api_host: ?string,
+  unified_ecommerce_url: ?string,
 }
 declare var SETTINGS: Settings
 

frontend/public/src/lib/auth.js

@@ -1,8 +1,10 @@
 // @flow
+/* global SETTINGS: false */
 import qs from "query-string"
 import { isEmpty, includes, has } from "ramda"
 
 import { routes } from "../lib/urls"
+import { checkFeatureFlag } from "../lib/util"
 
 import type { RouterHistory } from "react-router"
 import type { AuthResponse, AuthStates } from "../flow/authTypes"
@@ -77,14 +79,31 @@ export const handleAuthResponse = (
 ) => {
   /* eslint-disable camelcase */
   const { state, redirect_url, partial_token, errors, field_errors } = response
+  // This is pre-login so we won't be able to flag this out for individual users.
+  // The use of "anonymousUser" is historical - see usage in PR #2064 for instance
+  const sendThruEcommerce = checkFeatureFlag(
+    "enable_unified_ecommerce",
+    "anonymousUser"
+  )
 
   // If a specific handler function was passed in for this response state, invoke it
   if (has(state, handlers)) {
     handlers[state](response)
   }
 
   if (state === STATE_SUCCESS) {
-    window.location = redirect_url || routes.dashboard
+    const end_location = redirect_url || routes.dashboard
+    if (SETTINGS.unified_ecommerce_url && sendThruEcommerce) {
+      const ecommerce = new URL(`${SETTINGS.unified_ecommerce_url}`)
+
+      ecommerce.pathname = "establish_session/"
+      ecommerce.searchParams.set("next", end_location)
+      ecommerce.searchParams.set("system", "mitxonline")
+
+      window.location = ecommerce.href
+    } else {
+      window.location = end_location
+    }
   } else if (state === STATE_LOGIN_PASSWORD) {
     history.push(routes.login.password)
   } else if (state === STATE_REGISTER_DETAILS) {

frontend/public/src/lib/auth_test.js

@@ -11,6 +11,8 @@ import {
 import { routes } from "../lib/urls"
 import { makeRegisterAuthResponse } from "../factories/auth"
 
+const util = require("../lib/util")
+
 describe("auth lib function", () => {
   it("generateLoginRedirectUrl should generate a url to redirect to after login", () => {
     window.location = "/protected/route?var=abc"
@@ -47,5 +49,30 @@ describe("auth lib function", () => {
         sinon.assert.calledWith(handler, response)
       })
     })
+    ;[true, false].forEach(flagState => {
+      it(`redirects through Unified Ecommerce properly if the feature flag is ${
+        flagState ? "enabled" : "disabled"
+      }`, () => {
+        const response = makeRegisterAuthResponse({
+          state:        "success",
+          redirect_url: "/"
+        })
+        const handlers = {}
+        global.SETTINGS = {
+          unified_ecommerce_url: "http://ecommerce"
+        }
+
+        sandbox.stub(util, "checkFeatureFlag").returns(flagState)
+
+        assert.equal(
+          util.checkFeatureFlag("enable_unified_ecommerce", "anonymousUser"),
+          flagState
+        )
+
+        handleAuthResponse(history, response, handlers)
+
+        assert.equal(window.location.hostname, flagState ? "ecommerce" : "fake")
+      })
+    })
   })
 })

main/settings.py

@@ -1199,3 +1199,11 @@
     default="",
     description="Hubspot Portal ID",
 )
+
+# Unified Ecommerce integration
+
+UNIFIED_ECOMMERCE_URL = get_string(
+    name="UNIFIED_ECOMMERCE_URL",
+    default="http://ue.odl.local:9080/",
+    description="The base URL for Unified Ecommerce.",
+)

main/utils.py

@@ -52,6 +52,7 @@ def get_js_settings(request: HttpRequest):  # noqa: ARG001
         "features": {},
         "posthog_api_token": settings.POSTHOG_PROJECT_API_KEY,
         "posthog_api_host": settings.POSTHOG_API_HOST,
+        "unified_ecommerce_url": settings.UNIFIED_ECOMMERCE_URL,
     }
 
 

main/utils_test.py

@@ -51,6 +51,7 @@ def test_get_js_settings(settings, rf):
         "features": {},
         "posthog_api_token": settings.POSTHOG_PROJECT_API_KEY,
         "posthog_api_host": settings.POSTHOG_API_HOST,
+        "unified_ecommerce_url": settings.UNIFIED_ECOMMERCE_URL,
     }