Fix support for nested options.customOptionsPath

clients/fides-js/__tests__/lib/consent-utils.test.ts

@@ -135,6 +135,12 @@ describe("getWindowObjFromPath", () => {
       window: windowMock1,
       expected: undefined,
     },
+    {
+      label: "nested path does not exist",
+      path: ["window", "nonexistent-path", "nested"],
+      window: windowMock1,
+      expected: undefined,
+    },
     {
       label: "path is one level deep",
       path: ["window", "fides_overrides"],

clients/fides-js/src/lib/consent-utils.ts

@@ -257,16 +257,42 @@ export const shouldResurfaceConsent = (
 };
 
 /**
- * Get fides override options from a custom path
+ * Descend down the provided path on the "window" object and return the nested
+ * override options object located at the given path.
+ *
+ * If any part of the path is invalid, return `undefined`.
+ *
+ *
+ * For example, given a window object like this:
+ * ```
+ * window.custom_overrides = { nested_obj: { fides_string: "foo" } } };
+ * ```
+ *
+ * Then expect the following:
+ * ```
+ * const overrides = getWindowObjFromPath(["window", "custom_overrides", "nested_obj"])
+ * console.assert(overrides.fides_string === "foo");
+ * ```
  */
 export const getWindowObjFromPath = (
   path: string[]
 ): OverrideOptions | undefined => {
+  // Implicitly start from the global "window" object
   if (path[0] === "window") {
     path.shift();
   }
-  // @ts-ignore
-  return path.reduce((record, item) => record[item], window);
+  // Descend down the provided path (starting from `window`)
+  let record: any = window;
+  while (path.length > 0) {
+    const key = path.shift();
+    // If we ever encounter an invalid key or a non-object value, return undefined
+    if (typeof key === "undefined" || typeof record[key] !== "object") {
+      return undefined;
+    }
+    // Keep descending!
+    record = record[key];
+  }
+  return record;
 };
 
 export const getGpcStatusFromNotice = ({

clients/privacy-center/cypress/e2e/consent-banner-tcf.cy.ts

@@ -2635,6 +2635,80 @@ describe("Fides-js TCF", () => {
           expect(tcData.vendor.legitimateInterests).to.eql({});
         });
     });
+
+    it("does not error when window obj at custom config path doesn't exist", () => {
+      cy.fixture("consent/experience_tcf.json").then((experience) => {
+        stubConfig(
+          {
+            options: {
+              isOverlayEnabled: true,
+              tcfEnabled: true,
+              customOptionsPath: "window.nonexistent_object",
+            },
+            experience: experience.items[0],
+          },
+          null,
+          null,
+          null,
+          { fides_string: "foo" }
+        );
+      });
+      cy.window().then((win) => {
+        win.__tcfapi("addEventListener", 2, cy.stub().as("TCFEvent"));
+        // stubConfig will set window.config.overrides = { fides_string: "foo" }
+        expect(win).to.have.nested.property("config.overrides"); // defined by TEST_OVERRIDE_WINDOW_PATH
+        // However, customOptionsPath will *try* to read window.nonexistent_object, which will be undefined
+        expect(win).not.to.have.property("nonexistent_object");
+      });
+      // Open the modal
+      cy.get("#fides-modal-link").click();
+
+      // verify CMP API
+      cy.get("@TCFEvent")
+        .its("lastCall.args")
+        .then(([tcData, success]) => {
+          expect(success).to.eql(true);
+          expect(tcData.tcString).to.eql("");
+          expect(tcData.eventStatus).to.eql("cmpuishown");
+        });
+    });
+
+    it("does not error when window obj at nested custom config path doesn't exist", () => {
+      cy.fixture("consent/experience_tcf.json").then((experience) => {
+        stubConfig(
+          {
+            options: {
+              isOverlayEnabled: true,
+              tcfEnabled: true,
+              customOptionsPath: "window.nonexistent_object.nested.path",
+            },
+            experience: experience.items[0],
+          },
+          null,
+          null,
+          null,
+          { fides_string: "foo" }
+        );
+      });
+      cy.window().then((win) => {
+        win.__tcfapi("addEventListener", 2, cy.stub().as("TCFEvent"));
+        // stubConfig will set window.config.overrides = { fides_string: "foo" }
+        expect(win).to.have.nested.property("config.overrides"); // defined by TEST_OVERRIDE_WINDOW_PATH
+        // However, customOptionsPath will *try* to read window.nonexistent_object, which will be undefined
+        expect(win).not.to.have.property("nonexistent_object");
+      });
+      // Open the modal
+      cy.get("#fides-modal-link").click();
+
+      // verify CMP API
+      cy.get("@TCFEvent")
+        .its("lastCall.args")
+        .then(([tcData, success]) => {
+          expect(success).to.eql(true);
+          expect(tcData.tcString).to.eql("");
+          expect(tcData.eventStatus).to.eql("cmpuishown");
+        });
+    });
   });
 
   describe("ac string", () => {