Merge pull request #271 from purecloudlabs/feature/COMUI-1386

fix: refactoring hash logic to fix possible issue with query param on host route (i.e. timemachine override)

Author: jordanstith15

apps/ifc-example-client/ifc-cli.config.js

@@ -28,7 +28,10 @@ module.exports = function (frameRouter) {
     },
     envData: {
       locale: "en-US",
-      hostRootUrl: window.location.origin + "/#/",
+      hostRootUrl:
+        window.location.origin +
+        window.location.pathname +
+        window.location.search,
       registeredKeys: [
         { key: "a", ctrlKey: true },
         { key: "b", altKey: true },

package-lock.json

@@ -15,7 +15,10 @@ module.exports = function (frameRouter) {
     },
     envData: {
       locale: "en-US",
-      hostRootUrl: window.location.origin,
+      hostRootUrl:
+        window.location.origin +
+        window.location.pathname +
+        window.location.search,
       registeredKeys: [
         { key: "a", ctrlKey: true },
         { key: "b", altKey: true },

packages/iframe-coordinator-cli/src/example-ifc.config.js

@@ -269,10 +269,13 @@ export default class FrameRouterElement extends HTMLElement {
 
   private _processHostUrl(hostUrl: string) {
     const hostUrlObject = new URL(hostUrl);
-    if (hostUrlObject.hash) {
-      return hostUrlObject.href;
+    if (!hostUrlObject.hash) {
+      hostUrlObject.pathname = stripTrailingSlash(hostUrlObject.pathname);
+      if (window.location.hash) {
+        hostUrlObject.pathname += "/";
+        hostUrlObject.hash = "#";
+      }
     }
-    const trimmedUrl = stripTrailingSlash(hostUrl);
-    return window.location.hash ? `${trimmedUrl}/#` : trimmedUrl;
+    return hostUrlObject.href;
   }
 }

packages/iframe-coordinator/src/elements/frame-router.ts

@@ -10,6 +10,16 @@ const ENV_DATA_WITH_HASH = {
   hostRootUrl: "https://example.com/root/#/",
 };
 
+const ENV_DATA_WITH_QUERY = {
+  ...ENV_DATA,
+  hostRootUrl: "https://example.com/root/?foo=bar",
+};
+
+const ENV_DATA_WITH_QUERY_AND_HASH = {
+  ...ENV_DATA,
+  hostRootUrl: "https://example.com/root/?foo=bar#/",
+};
+
 describe("The frame router element", () => {
   beforeAll(() => {
     window.customElements.define("frame-router", FrameRouterElement);
@@ -25,7 +35,7 @@ describe("The frame router element", () => {
    * behavior.
    */
   describe("Host URL management", () => {
-    it("Removes a trailing slash on the host URL if present", () => {
+    it("Removes a trailing slash on the host URL if present with no hash", () => {
       const router = new FrameRouterElement();
       router.clientConfig = {
         clients: {},
@@ -65,6 +75,43 @@ describe("The frame router element", () => {
       });
     });
 
-    // TODO: Test expected query behavior here
+    it("Removes trailing slash from pathname when the provided host URL with query params; urlObject and location have no hash", () => {
+      const router = new FrameRouterElement();
+      router.clientConfig = {
+        clients: {},
+        envData: ENV_DATA_WITH_QUERY,
+      };
+      //@ts-ignore
+      expect(router._envData).toEqual({
+        ...ENV_DATA_WITH_QUERY,
+        hostRootUrl: "https://example.com/root?foo=bar",
+      });
+    });
+
+    it("Does not add slash between hash and query params if location has hash; urlObject has no hash", () => {
+      window.location.hash = "foo";
+      const router = new FrameRouterElement();
+      router.clientConfig = {
+        clients: {},
+        envData: ENV_DATA_WITH_QUERY,
+      };
+      //@ts-ignore
+      expect(router._envData).toEqual({
+        ...ENV_DATA_WITH_QUERY,
+        hostRootUrl: "https://example.com/root/?foo=bar#",
+      });
+    });
+
+    it("Does not modify provided host URL with query params if urlObject has hash; location hash N/A", () => {
+      const router = new FrameRouterElement();
+      router.clientConfig = {
+        clients: {},
+        envData: ENV_DATA_WITH_QUERY_AND_HASH,
+      };
+      //@ts-ignore
+      expect(router._envData).toEqual({
+        ...ENV_DATA_WITH_QUERY_AND_HASH,
+      });
+    });
   });
 });