feat(core): Add plugin options as tags (#113)

Add a subset of our plugin options as tags to Sentry events. Obviously, we cannot send all options but we have to be careful to only send insensitive data, such as if an optional step (e.g. `deploy`) was selected or not. 

Going forward, we can use this data to evaluate which options are used and for debugging issues. 

Also add some tests

Author: Lms24

packages/bundler-plugin-core/src/index.ts

@@ -10,7 +10,12 @@ import {
   uploadSourceMaps,
 } from "./sentry/releasePipeline";
 import "@sentry/tracing";
-import { addSpanToTransaction, captureMinimalError, makeSentryClient } from "./sentry/telemetry";
+import {
+  addPluginOptionTags,
+  addSpanToTransaction,
+  captureMinimalError,
+  makeSentryClient,
+} from "./sentry/telemetry";
 import { Span, Transaction } from "@sentry/types";
 import { createLogger, Logger } from "./sentry/logger";
 import { InternalOptions, normalizeUserOptions, validateOptions } from "./options-mapping";
@@ -90,6 +95,7 @@ const unplugin = createUnplugin<Options>((options, unpluginMetaContext) => {
     "https://[email protected]/6690737",
     internalOptions.telemetry
   );
+  addPluginOptionTags(internalOptions, sentryHub);
 
   const logger = createLogger({
     hub: sentryHub,

packages/bundler-plugin-core/src/sentry/telemetry.ts

@@ -7,6 +7,7 @@ import {
   NodeClient,
 } from "@sentry/node";
 import { Span } from "@sentry/tracing";
+import { InternalOptions } from "../options-mapping";
 import { BuildContext } from "../types";
 
 export function makeSentryClient(
@@ -76,3 +77,43 @@ export function captureMinimalError(error: unknown | Error, hub: Hub) {
 
   hub.captureException(sentryError);
 }
+
+export function addPluginOptionTags(options: InternalOptions, hub: Hub) {
+  const {
+    cleanArtifacts,
+    finalize,
+    setCommits,
+    injectReleasesMap,
+    dryRun,
+    errorHandler,
+    deploy,
+    include,
+  } = options;
+
+  hub.setTag("include", include.length > 1 ? "multiple-entries" : "single-entry");
+
+  // Optional release pipeline steps
+  if (cleanArtifacts) {
+    hub.setTag("clean-artifacts", true);
+  }
+  if (setCommits) {
+    hub.setTag("set-commits", setCommits.auto === true ? "auto" : "manual");
+  }
+  if (finalize) {
+    hub.setTag("finalize-release", true);
+  }
+  if (deploy) {
+    hub.setTag("add-deploy", true);
+  }
+
+  // Miscelaneous options
+  if (dryRun) {
+    hub.setTag("dry-run", true);
+  }
+  if (injectReleasesMap) {
+    hub.setTag("inject-releases-map", true);
+  }
+  if (errorHandler) {
+    hub.setTag("error-handler", "custom");
+  }
+}

packages/bundler-plugin-core/test/sentry/telemetry.test.ts

@@ -1,5 +1,6 @@
 import { Hub } from "@sentry/node";
-import { captureMinimalError } from "../../src/sentry/telemetry";
+import { InternalOptions } from "../../src/options-mapping";
+import { addPluginOptionTags, captureMinimalError } from "../../src/sentry/telemetry";
 
 describe("captureMinimalError", () => {
   const mockedHub = {
@@ -57,3 +58,84 @@ describe("captureMinimalError", () => {
     });
   });
 });
+
+describe("addPluginOptionTags", () => {
+  const mockedHub = {
+    setTag: jest.fn(),
+  };
+
+  const defaultOptions: Partial<InternalOptions> = {
+    include: [],
+  };
+
+  beforeEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it("should set include tag according to number of entries (single entry)", () => {
+    addPluginOptionTags(defaultOptions as unknown as InternalOptions, mockedHub as unknown as Hub);
+    expect(mockedHub.setTag).toHaveBeenCalledWith("include", "single-entry");
+  });
+  it("should set include tag according to number of entries (multiple entries)", () => {
+    addPluginOptionTags(
+      { include: [{}, {}, {}] } as unknown as InternalOptions,
+      mockedHub as unknown as Hub
+    );
+    expect(mockedHub.setTag).toHaveBeenCalledWith("include", "multiple-entries");
+  });
+
+  it("should set deploy tag to true if the deploy option is specified", () => {
+    addPluginOptionTags(
+      { ...defaultOptions, deploy: { env: "production" } } as unknown as InternalOptions,
+      mockedHub as unknown as Hub
+    );
+    expect(mockedHub.setTag).toHaveBeenCalledWith("add-deploy", true);
+  });
+
+  it("should set errorHandler tag to `custom` if the errorHandler option is specified", () => {
+    addPluginOptionTags(
+      // eslint-disable-next-line @typescript-eslint/no-empty-function
+      { ...defaultOptions, errorHandler: () => {} } as unknown as InternalOptions,
+      mockedHub as unknown as Hub
+    );
+    expect(mockedHub.setTag).toHaveBeenCalledWith("error-handler", "custom");
+  });
+
+  it.each([
+    ["auto", { auto: true }],
+    ["manual", { repo: "", commit: "" }],
+  ])(
+    `should set setCommits tag to %s if the setCommits option is %s`,
+    (expectedValue, commitOptions) => {
+      addPluginOptionTags(
+        { ...defaultOptions, setCommits: commitOptions } as unknown as InternalOptions,
+        mockedHub as unknown as Hub
+      );
+      expect(mockedHub.setTag).toHaveBeenCalledWith("set-commits", expectedValue);
+    }
+  );
+
+  it("sets all simple tags correctly", () => {
+    addPluginOptionTags(
+      {
+        ...defaultOptions,
+        cleanArtifacts: true,
+        finalize: true,
+        injectReleasesMap: true,
+        dryRun: true,
+      } as unknown as InternalOptions,
+      mockedHub as unknown as Hub
+    );
+
+    expect(mockedHub.setTag).toHaveBeenCalledWith("clean-artifacts", true);
+    expect(mockedHub.setTag).toHaveBeenCalledWith("finalize-release", true);
+    expect(mockedHub.setTag).toHaveBeenCalledWith("inject-releases-map", true);
+    expect(mockedHub.setTag).toHaveBeenCalledWith("dry-run", true);
+  });
+
+  it("shouldn't set any tags other than include if no opional options are specified", () => {
+    addPluginOptionTags(defaultOptions as unknown as InternalOptions, mockedHub as unknown as Hub);
+    expect(mockedHub.setTag).toHaveBeenCalledTimes(1);
+    expect(mockedHub.setTag).toHaveBeenCalledWith("include", "single-entry");
+  });
+});