Fixed issue with Configuration Default Data not getting data exclusions applied.

Author: niemyjski

example/express/app.js

@@ -23,7 +23,7 @@ await Exceptionless.startup((c) => {
     customValue: "Password",
     value: {
       Password: "123456",
-    },
+    }
   };
 });
 

packages/core/src/Utils.ts

@@ -175,7 +175,8 @@ export function isEmpty(input: Record<string, unknown> | null | undefined | unkn
   }
 
   if (typeof input === "string") {
-    return input.trim().length === 0 || input === "{}" || input === "[]";
+    const trimmedInput = input.trim();
+    return trimmedInput.length === 0 || trimmedInput === "{}" || trimmedInput === "[]";
   }
 
   return false;

packages/core/src/plugins/default/ConfigurationDefaultsPlugin.ts

@@ -1,4 +1,4 @@
-import { isEmpty } from "../../Utils.js";
+import { isEmpty, stringify } from "../../Utils.js";
 import { EventPluginContext } from "../EventPluginContext.js";
 import { IEventPlugin } from "../IEventPlugin.js";
 
@@ -7,22 +7,26 @@ export class ConfigurationDefaultsPlugin implements IEventPlugin {
   public name = "ConfigurationDefaultsPlugin";
 
   public run(context: EventPluginContext): Promise<void> {
-    const config = context.client.config;
+    const { dataExclusions, defaultData, defaultTags } = context.client.config;
     const ev = context.event;
 
-    if (config.defaultTags) {
-      ev.tags = [...ev.tags || [], ...config.defaultTags];
+    if (defaultTags) {
+      ev.tags = [...ev.tags || [], ...defaultTags];
     }
 
-    const defaultData: Record<string, unknown> = config.defaultData || {};
     if (defaultData) {
       if (!ev.data) {
         ev.data = {};
       }
 
-      for (const key in config.defaultData || {}) {
-        if (ev.data[key] === undefined && !isEmpty(defaultData[key])) {
-          ev.data[key] = defaultData[key];
+      for (const key in defaultData) {
+        if (ev.data[key] !== undefined || isEmpty(defaultData[key])) {
+          continue;
+        }
+
+        const data = stringify(defaultData[key], dataExclusions);
+        if (!isEmpty(data)) {
+          ev.data[key] = JSON.parse(data);
         }
       }
     }

packages/core/test/Utils.test.ts

@@ -593,6 +593,10 @@ describe("Utils", () => {
         JSON.stringify(expect(stringify(user, ["*password*"])).toBe(JSON.stringify({ "id": 1, "name": "Blake", "customValue": "Password", "value": {} })));
       });
 
+      test("*Password*", () => {
+        JSON.stringify(expect(stringify(user, ["*Password*"])).toBe(JSON.stringify({ "id": 1, "name": "Blake", "customValue": "Password", "value": {} })));
+      });
+
       test("*Address", () => {
         const event = { type: "usage", source: "about" };
         expect(stringify(event, ["*Address"])).toBe(JSON.stringify(event));

packages/core/test/plugins/default/ConfigurationDefaultsPlugin.test.ts

@@ -0,0 +1,65 @@
+import { describe, test } from "@jest/globals";
+import { expect } from "expect";
+
+import { ExceptionlessClient } from "../../../src/ExceptionlessClient.js";
+import { Event } from "../../../src/models/Event.js";
+import { ConfigurationDefaultsPlugin } from "../../../src/plugins/default/ConfigurationDefaultsPlugin.js";
+import { EventPluginContext } from "../../../src/plugins/EventPluginContext.js";
+import { EventContext } from "../../../src/models/EventContext.js";
+
+describe("ConfigurationDefaultsPlugin", () => {
+  describe("should add default", () => {
+    const userDataKey: string = "user";
+    const user = {
+      id: 1,
+      name: "Blake",
+      password: "123456",
+      passwordResetToken: "a reset token",
+      myPassword: "123456",
+      myPasswordValue: "123456",
+      customValue: "Password",
+      value: {
+        Password: "123456"
+      }
+    };
+
+    const defaultTags: string[] = ["tag1", "tag2"];
+
+    const run = async (dataExclusions?: string[] | undefined): Promise<Event> => {
+      const client = new ExceptionlessClient();
+      client.config.defaultTags.push(...defaultTags);
+      client.config.defaultData[userDataKey] = user;
+
+      if (dataExclusions) {
+        client.config.addDataExclusions(...dataExclusions);
+      }
+
+      const ev: Event = <Event>{ type: "log", source: "test", data: {} };
+
+      const context = new EventPluginContext(client, ev, new EventContext());
+      const plugin = new ConfigurationDefaultsPlugin();
+      await plugin.run(context);
+
+      return context.event;
+    }
+
+    test("tags", async () => {
+      const ev = await run();
+      expect(ev.tags).toStrictEqual(defaultTags)
+    });
+
+    test("user", async () => {
+      const ev = await run();
+      expect(ev.data).toBeDefined();
+      expect(ev.data && ev.data[userDataKey]).toStrictEqual(user);
+    });
+
+    test("pruned user", async () => {
+      const ev = await run(["*password*"]);
+      expect(ev.data).toBeDefined();
+
+      const expected = { "id": 1, "name": "Blake", "customValue": "Password", "value": {} };
+      expect(ev.data && ev.data[userDataKey]).toStrictEqual(expected);
+    });
+  });
+});