Normalize environments assigned by later plugins

A plugin that runs after the defaults plugin could set an untrimmed,
oversized, or control-character environment that reached the queue.
Normalize again before submitting and before resubmitting merged
duplicates.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Author: ejsmith

packages/core/src/ExceptionlessClient.ts

@@ -7,7 +7,7 @@ import { EventContext } from "./models/EventContext.js";
 import { EventPluginContext } from "./plugins/EventPluginContext.js";
 import { EventPluginManager } from "./plugins/EventPluginManager.js";
 import { PluginContext } from "./plugins/PluginContext.js";
-import { allowProcessToExitWithoutWaitingForTimerOrInterval } from "./Utils.js";
+import { allowProcessToExitWithoutWaitingForTimerOrInterval, setNormalizedEnvironment } from "./Utils.js";
 
 export class ExceptionlessClient {
   private _intervalId: ReturnType<typeof setInterval> | undefined;
@@ -248,6 +248,9 @@ export class ExceptionlessClient {
       ev.date = new Date();
     }
 
+    // Plugins that run after the defaults can assign any value.
+    setNormalizedEnvironment(ev, ev.environment);
+
     await this.config.services.queue.enqueue(ev);
 
     if (ev.reference_id && ev.reference_id.length > 0) {

packages/core/src/Utils.ts

@@ -1,3 +1,5 @@
+import type { Event } from "./models/Event.js";
+
 export function getHashCode(source: string): number {
   if (!source || source.length === 0) {
     return 0;
@@ -567,3 +569,15 @@ export function normalizeEnvironment(value: string | null | undefined): string |
   // eslint-disable-next-line no-control-regex -- Deployment names cannot contain control characters.
   return name && name.length <= 64 && !/[\u0000-\u001f\u007f-\u009f]/u.test(name) ? name : undefined;
 }
+
+/**
+ * Sets the event's environment to the normalized value, or removes it when the value is not a valid name.
+ */
+export function setNormalizedEnvironment(event: Event, value: string | null | undefined): void {
+  const environment = normalizeEnvironment(value);
+  if (environment) {
+    event.environment = environment;
+  } else {
+    delete event.environment;
+  }
+}

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

@@ -1,4 +1,4 @@
-import { isEmpty, normalizeEnvironment, stringify } from "../../Utils.js";
+import { isEmpty, setNormalizedEnvironment, stringify } from "../../Utils.js";
 import { EventPluginContext } from "../../plugins/EventPluginContext.js";
 import { IEventPlugin } from "../../plugins/IEventPlugin.js";
 
@@ -9,12 +9,7 @@ export class ConfigurationDefaultsPlugin implements IEventPlugin {
   public run(context: EventPluginContext): Promise<void> {
     const { dataExclusions, defaultData, defaultTags } = context.client.config;
     const ev = context.event;
-    const environment = normalizeEnvironment(ev.environment ?? context.client.config.environment);
-    if (environment) {
-      ev.environment = environment;
-    } else {
-      delete ev.environment;
-    }
+    setNormalizedEnvironment(ev, ev.environment ?? context.client.config.environment);
 
     if (defaultTags) {
       ev.tags = [...(ev.tags || []), ...defaultTags];

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

@@ -1,6 +1,6 @@
 import { InnerErrorInfo } from "../../models/data/ErrorInfo.js";
 import { KnownEventDataKeys } from "../../models/Event.js";
-import { allowProcessToExitWithoutWaitingForTimerOrInterval, getHashCode } from "../../Utils.js";
+import { allowProcessToExitWithoutWaitingForTimerOrInterval, getHashCode, setNormalizedEnvironment } from "../../Utils.js";
 import { EventPluginContext } from "../../plugins/EventPluginContext.js";
 import { IEventPlugin } from "../../plugins/IEventPlugin.js";
 
@@ -123,6 +123,8 @@ class MergedEvent {
 
   public async resubmit(): Promise<void> {
     this._context.event.count = this._count;
+    // Plugins between the defaults and this one can assign any value.
+    setNormalizedEnvironment(this._context.event, this._context.event.environment);
     await this._context.client.config.services.queue.enqueue(this._context.event);
   }
 

packages/core/test/ExceptionlessClient.test.ts

@@ -37,6 +37,25 @@ describe("ExceptionlessClient", () => {
     expect(context.event.reference_id).toBe(lastReferenceIdManager.getLast());
   });
 
+  test.each([
+    [" QA\t", "QA"],
+    ["x".repeat(65), undefined]
+  ])("should normalize environment %j assigned by a later plugin", async (environment, expected) => {
+    const client = new ExceptionlessClient();
+    client.config.apiKey = "UNIT_TEST_API_KEY";
+    client.config.environment = "production";
+    client.config.addPlugin("late-environment", 90, (context) => {
+      context.event.environment = environment;
+      return Promise.resolve();
+    });
+    const enqueue = vi.spyOn(client.config.services.queue, "enqueue").mockResolvedValue();
+
+    await client.submitLog("test");
+
+    expect(enqueue).toHaveBeenCalledOnce();
+    expect(enqueue.mock.calls[0]?.[0].environment).toBe(expected);
+  });
+
   test("should accept undefined source", () => {
     const client = new ExceptionlessClient();
     client.config.apiKey = "UNIT_TEST_API_KEY";

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

@@ -100,6 +100,14 @@ describe("DuplicateCheckerPlugin", () => {
     expect(enqueue.mock.calls.map(([event]) => event.environment).sort()).toEqual(["Production", "production", "staging", undefined]);
   });
 
+  test("should normalize the environment of a resubmitted duplicate", async () => {
+    const enqueue = vi.spyOn(client.config.services.queue, "enqueue").mockResolvedValue();
+    await run(Exception1StackTrace, " staging\n");
+    expect((await run(Exception1StackTrace, " staging\n")).cancelled).toBe(true);
+    await plugin.suspend();
+    expect(enqueue.mock.calls.map(([event]) => event.environment)).toEqual(["staging"]);
+  });
+
   test("should ignore error without stack", async () => {
     await run();
     const contextOfSecondRun = await run();