Allow enabled: true to be set in config overrides, allow empty objects to overwrite (#1433)

jonsnyder · web-flow · commit 0c0f50516e5c · 2026-02-05T14:05:05.000-07:00
diff --git a/.changeset/small-tables-push.md b/.changeset/small-tables-push.md
@@ -0,0 +1,5 @@
+---
+"@adobe/alloy": patch
+---
+
+Allow enabled: true to be set in config overrides, allow empty objects to overwrite.
diff --git a/packages/core/src/utils/filterObject.js b/packages/core/src/utils/filterObject.js
@@ -40,7 +40,7 @@ const filterObject = (obj, predicate) => {
       return { ...result, [key]: filteredValue };
     }
     // value is not an object, test predicate
-    if (predicate(value)) {
+    if (predicate(value, key)) {
       return { ...result, [key]: value };
     }
     return result;
diff --git a/packages/core/src/utils/prepareConfigOverridesForEdge.js b/packages/core/src/utils/prepareConfigOverridesForEdge.js
@@ -25,11 +25,13 @@ export default (configuration) => {
     return null;
   }
   // remove entries that are empty strings or arrays
-  const configOverrides = filterObject(configuration, (value) => {
+  const configOverrides = filterObject(configuration, (value, key) => {
     if (isNil(value)) {
       return false;
     }
-    if (isBoolean(value)) {
+    // We want to remove all the { enabled: true } values, but leave any other boolean values.
+    // Experience Edge will not accept { enabled: true } values as true is the default for "enabled".
+    if (isBoolean(value) && (key !== "enabled" || value === false)) {
       return true;
     }
     if (isNumber(value)) {
diff --git a/packages/core/src/utils/request/createRequestParams.js b/packages/core/src/utils/request/createRequestParams.js
@@ -39,5 +39,8 @@ export default ({ localConfigOverrides, globalConfigOverrides, payload }) => {
   ) {
     payload.mergeConfigOverride(localConfigOverridesWithoutDatastreamId);
   }
+
+  payload.finalizeConfigOverrides();
+
   return requestParams;
 };
diff --git a/packages/core/src/utils/request/createRequestPayload.js b/packages/core/src/utils/request/createRequestPayload.js
@@ -88,8 +88,14 @@ export default (options) => {
     mergeMeta: createMerger(content, "meta"),
     mergeState: createMerger(content, "meta.state"),
     mergeQuery: createMerger(content, "query"),
-    mergeConfigOverride: (updates) =>
-      mergeConfigOverrides(prepareConfigOverridesForEdge(updates)),
+    mergeConfigOverride: (updates) => mergeConfigOverrides(updates),
+    finalizeConfigOverrides: () => {
+      if (content.meta?.configOverrides) {
+        content.meta.configOverrides = prepareConfigOverridesForEdge(
+          content.meta.configOverrides,
+        );
+      }
+    },
     addIdentity,
     hasIdentity,
     toJSON() {
diff --git a/packages/core/test/integration/specs/Command Logic/configOverrides.spec.js b/packages/core/test/integration/specs/Command Logic/configOverrides.spec.js
@@ -46,4 +46,67 @@ describe("Config overrides", () => {
       },
     });
   });
+
+  test("should allow you to disable a service in the base config, but enable it in a send event call", async ({
+    alloy,
+    worker,
+    networkRecorder,
+  }) => {
+    worker.use(...[sendEventHandler]);
+
+    const config = structuredClone(alloyConfig);
+    await alloy("configure", {
+      ...config,
+      edgeConfigOverrides: {
+        com_adobe_analytics: {
+          enabled: false,
+        },
+      },
+    });
+
+    await alloy("sendEvent", {
+      edgeConfigOverrides: {
+        com_adobe_analytics: {
+          enabled: true,
+        },
+      },
+    });
+
+    const call = await networkRecorder.findCall(/edge\.adobedc\.net/);
+    expect(call.request?.body?.meta?.configOverrides).toBeNull();
+  });
+
+  test("should allow you to disable a service in the base config, but enable it in a send event call with extra parameters", async ({
+    alloy,
+    worker,
+    networkRecorder,
+  }) => {
+    worker.use(...[sendEventHandler]);
+
+    const config = structuredClone(alloyConfig);
+    await alloy("configure", {
+      ...config,
+      edgeConfigOverrides: {
+        com_adobe_analytics: {
+          enabled: false,
+        },
+      },
+    });
+
+    await alloy("sendEvent", {
+      edgeConfigOverrides: {
+        com_adobe_analytics: {
+          enabled: true,
+          reportSuites: ["reportSuite1"],
+        },
+      },
+    });
+
+    const call = await networkRecorder.findCall(/edge\.adobedc\.net/);
+    expect(call.request?.body?.meta?.configOverrides).toEqual({
+      com_adobe_analytics: {
+        reportSuites: ["reportSuite1"],
+      },
+    });
+  });
 });
diff --git a/packages/core/test/unit/specs/components/Consent/injectSendSetConsentRequest.spec.js b/packages/core/test/unit/specs/components/Consent/injectSendSetConsentRequest.spec.js
@@ -26,6 +26,7 @@ describe("Consent:injectSendSetConsentRequest", () => {
       setConsent: vi.fn(),
       addIdentity: vi.fn(),
       mergeConfigOverride: vi.fn(),
+      finalizeConfigOverrides: vi.fn(),
     };
     createConsentRequestPayload = vi.fn().mockReturnValue(requestPayload);
     request = {
diff --git a/packages/core/test/unit/specs/components/Identity/getIdentity/createGetIdentity.spec.js b/packages/core/test/unit/specs/components/Identity/getIdentity/createGetIdentity.spec.js
@@ -22,6 +22,7 @@ describe("Identity::createGetIdentity", () => {
     sendEdgeNetworkRequest = vi.fn();
     requestPayload = {
       mergeConfigOverride: vi.fn(),
+      finalizeConfigOverrides: vi.fn(),
       type: vi.fn().mockReturnValue("payload"),
     };
     createIdentityRequestPayload = vi.fn().mockReturnValue(requestPayload);
@@ -46,10 +47,12 @@ describe("Identity::createGetIdentity", () => {
   it("each getIdentity call should create new payloads and requests", () => {
     const payload1 = {
       mergeConfigOverride: vi.fn(),
+      finalizeConfigOverrides: vi.fn(),
       type: vi.fn().mockReturnValue("payload1"),
     };
     const payload2 = {
       mergeConfigOverride: vi.fn(),
+      finalizeConfigOverrides: vi.fn(),
       type: vi.fn().mockReturnValue("payload2"),
     };
     const request1 = {
diff --git a/packages/core/test/unit/specs/core/createEventManager.spec.js b/packages/core/test/unit/specs/core/createEventManager.spec.js
@@ -64,6 +64,7 @@ describe("createEventManager", () => {
     requestPayload = {
       addEvent: vi.fn(),
       mergeConfigOverride: vi.fn(),
+      finalizeConfigOverrides: vi.fn(),
     };
     const createDataCollectionRequestPayload = () => {
       return requestPayload;
diff --git a/packages/core/test/unit/specs/utils/filterObject.spec.js b/packages/core/test/unit/specs/utils/filterObject.spec.js
@@ -60,4 +60,14 @@ describe("utils:filterObject", () => {
       },
     });
   });
+  it("should pass the key to the predicate", () => {
+    const obj = {
+      a: 5,
+      b: 6,
+    };
+    const predicate = (_value, key) => key === "b";
+    expect(filterObject(obj, predicate)).toEqual({
+      b: 6,
+    });
+  });
 });
diff --git a/packages/core/test/unit/specs/utils/prepareConfigOverridesForEdge.spec.js b/packages/core/test/unit/specs/utils/prepareConfigOverridesForEdge.spec.js
@@ -78,4 +78,28 @@ describe("utils:prepareConfigOverridesForEdge", () => {
       }),
     ).toBeNull();
   });
+
+  it("should remove enabled: true, but leave other true values", () => {
+    expect(
+      prepareConfigOverridesForEdge({
+        com_adobe_experience_platform: {
+          enabled: true,
+        },
+        com_adobe_analytics: {
+          enabled: true,
+          reportSuites: ["rs1"],
+        },
+        other_key: {
+          other_value: true,
+        }
+      }),
+    ).toEqual({
+      com_adobe_analytics: {
+        reportSuites: ["rs1"],
+      },
+      other_key: {
+        other_value: true,
+      },
+    });
+  });
 });
diff --git a/packages/core/test/unit/specs/utils/request/createRequestParams.spec.js b/packages/core/test/unit/specs/utils/request/createRequestParams.spec.js
@@ -19,6 +19,7 @@ describe("createRequestParams", () => {
   beforeEach(() => {
     payload = {
       mergeConfigOverride: vi.fn(),
+      finalizeConfigOverrides: vi.fn(),
     };
   });
   it("returns the payload and datastreamIdOverride", () => {
@@ -62,4 +63,11 @@ describe("createRequestParams", () => {
       a: "e",
     });
   });
+  it("finalizes the config overrides", () => {
+    payload.finalizeConfigOverrides = vi.fn();
+    createRequestParams({
+      payload,
+    });
+    expect(payload.finalizeConfigOverrides).toHaveBeenCalled();
+  });
 });
diff --git a/packages/core/test/unit/specs/utils/request/createRequestPayload.spec.js b/packages/core/test/unit/specs/utils/request/createRequestPayload.spec.js
@@ -0,0 +1,127 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+import { vi, beforeEach, describe, it, expect } from "vitest";
+import createRequestPayload from "../../../../../src/utils/request/createRequestPayload.js";
+
+describe("createRequestPayload", () => {
+  let content;
+  let addIdentity;
+  let hasIdentity;
+  let payload;
+
+  beforeEach(() => {
+    content = {};
+    addIdentity = vi.fn();
+    hasIdentity = vi.fn();
+    payload = createRequestPayload({
+      content,
+      addIdentity,
+      hasIdentity,
+    });
+  });
+
+  it("returns addIdentity and hasIdentity from options", () => {
+    expect(payload.addIdentity).toBe(addIdentity);
+    expect(payload.hasIdentity).toBe(hasIdentity);
+  });
+
+  it("toJSON returns the content object", () => {
+    expect(payload.toJSON()).toBe(content);
+    content.foo = "bar";
+    expect(payload.toJSON()).toEqual({ foo: "bar" });
+  });
+
+  describe("mergeMeta", () => {
+    it("deep merges updates into content.meta", () => {
+      payload.mergeMeta({ a: 1, b: { c: 2 } });
+      expect(content.meta).toEqual({ a: 1, b: { c: 2 } });
+
+      payload.mergeMeta({ b: { d: 3 } });
+      expect(content.meta).toEqual({ a: 1, b: { c: 2, d: 3 } });
+    });
+  });
+
+  describe("mergeState", () => {
+    it("deep merges updates into content.meta.state", () => {
+      payload.mergeState({ key: "value" });
+      expect(content.meta.state).toEqual({ key: "value" });
+
+      payload.mergeState({ other: "data" });
+      expect(content.meta.state).toEqual({ key: "value", other: "data" });
+    });
+  });
+
+  describe("mergeQuery", () => {
+    it("deep merges updates into content.query", () => {
+      payload.mergeQuery({ schema: ["a", "b"] });
+      expect(content.query).toEqual({ schema: ["a", "b"] });
+
+      payload.mergeQuery({ other: { nested: true } });
+      expect(content.query).toEqual({
+        schema: ["a", "b"],
+        other: { nested: true },
+      });
+    });
+  });
+
+  describe("mergeConfigOverride", () => {
+    it("shallow merges updates into content.meta.configOverrides", () => {
+      payload.mergeConfigOverride({
+        com_adobe_analytics: { reportSuites: ["rs1"] },
+      });
+      expect(content.meta.configOverrides).toEqual({
+        com_adobe_analytics: { reportSuites: ["rs1"] },
+      });
+
+      // Second merge overwrites same key (shallow merge)
+      payload.mergeConfigOverride({
+        com_adobe_analytics: { enabled: false },
+      });
+      expect(content.meta.configOverrides).toEqual({
+        com_adobe_analytics: { enabled: false },
+      });
+    });
+
+    it("creates meta and configOverrides if they do not exist", () => {
+      expect(content.meta).toBeUndefined();
+
+      payload.mergeConfigOverride({ someKey: "value" });
+
+      expect(content.meta).toBeDefined();
+      expect(content.meta.configOverrides).toEqual({ someKey: "value" });
+    });
+  });
+
+  describe("finalizeConfigOverrides", () => {
+    it("calls prepareConfigOverridesForEdge and replaces content.meta.configOverrides when present", () => {
+      content.meta = { configOverrides: { a: { enabled: true }, b: {}, c: { rs: "foo" } } };
+
+      payload.finalizeConfigOverrides();
+
+      expect(content.meta.configOverrides).toEqual({ c: { rs: "foo" } });
+    });
+
+    it("does nothing when content.meta.configOverrides is absent", () => {
+      content.meta = { other: "data" };
+
+      payload.finalizeConfigOverrides();
+
+      expect(content.meta.configOverrides).toBeUndefined();
+    });
+
+    it("does nothing when content.meta is absent", () => {
+      payload.finalizeConfigOverrides();
+
+      expect(content.meta).toBeUndefined();
+    });
+  });
+});

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@adobe/alloy": patch
 +---
++
 +Allow enabled: true to be set in config overrides, allow empty objects to overwrite.
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ const filterObject = (obj, predicate) => {`
`40`	`40`	`return { ...result, [key]: filteredValue };`
`41`	`41`	`}`
`42`	`42`	`// value is not an object, test predicate`
`43`		`- if (predicate(value)) {`
	`43`	`+ if (predicate(value, key)) {`
`44`	`44`	`return { ...result, [key]: value };`
`45`	`45`	`}`
`46`	`46`	`return result;`
Original file line number	Diff line number	Diff line change
`@@ -25,11 +25,13 @@ export default (configuration) => {`
`25`	`25`	`return null;`
`26`	`26`	`}`
`27`	`27`	`// remove entries that are empty strings or arrays`
`28`		`- const configOverrides = filterObject(configuration, (value) => {`
	`28`	`+ const configOverrides = filterObject(configuration, (value, key) => {`
`29`	`29`	`if (isNil(value)) {`
`30`	`30`	`return false;`
`31`	`31`	`}`
`32`		`- if (isBoolean(value)) {`
	`32`	`+ // We want to remove all the { enabled: true } values, but leave any other boolean values.`
	`33`	`+ // Experience Edge will not accept { enabled: true } values as true is the default for "enabled".`
	`34`	`+ if (isBoolean(value) && (key !== "enabled" \|\| value === false)) {`
`33`	`35`	`return true;`
`34`	`36`	`}`
`35`	`37`	`if (isNumber(value)) {`
Original file line number	Diff line number	Diff line change
`@@ -39,5 +39,8 @@ export default ({ localConfigOverrides, globalConfigOverrides, payload }) => {`
`39`	`39`	`) {`
`40`	`40`	`payload.mergeConfigOverride(localConfigOverridesWithoutDatastreamId);`
`41`	`41`	`}`
	`42`	`+`
	`43`	`+ payload.finalizeConfigOverrides();`
	`44`	`+`
`42`	`45`	`return requestParams;`
`43`	`46`	`};`