feat(cli): add test for non-duplicate error reporting

Author: FedeZara

packages/cli/cli/src/__test__/errorReporting.test.ts

@@ -0,0 +1,49 @@
+import { CliError, TaskAbortSignal } from "@fern-api/task-context";
+import { describe, expect, it, vi } from "vitest";
+
+import { reportError } from "../telemetry/reportError.js";
+import { createMockCliContext } from "./mockCliContext.js";
+
+vi.mock("../telemetry/reportError.js", async (importOriginal) => {
+    const original = await importOriginal<typeof import("../telemetry/reportError.js")>();
+    return {
+        ...original,
+        reportError: vi.fn(original.reportError)
+    };
+});
+
+const reportErrorSpy = vi.mocked(reportError);
+
+describe("error reporting", () => {
+    it("task failure via failAndThrow reports exactly once through the full chain", async () => {
+        reportErrorSpy.mockClear();
+        const cliContext = await createMockCliContext();
+
+        try {
+            await cliContext.runTask(async (context) => {
+                context.failAndThrow("bad", undefined, { code: CliError.Code.ConfigError });
+            });
+        } catch (error) {
+            expect(error).toBeInstanceOf(TaskAbortSignal);
+            cliContext.failWithoutThrowing(undefined, error);
+        }
+
+        expect(reportErrorSpy).toHaveBeenCalledOnce();
+    });
+
+    it("uncaught task error reports exactly once through the full chain", async () => {
+        reportErrorSpy.mockClear();
+        const cliContext = await createMockCliContext();
+
+        try {
+            await cliContext.runTask(async () => {
+                throw new CliError({ message: "something broke", code: CliError.Code.InternalError });
+            });
+        } catch (error) {
+            expect(error).toBeInstanceOf(TaskAbortSignal);
+            cliContext.failWithoutThrowing(undefined, error);
+        }
+
+        expect(reportErrorSpy).toHaveBeenCalledOnce();
+    });
+});

packages/cli/cli/src/cli-context/CliContext.ts

@@ -7,9 +7,7 @@ import {
     CliError,
     Finishable,
     PosthogEvent,
-    resolveErrorCode,
     Startable,
-    shouldReportToSentry,
     TaskAbortSignal,
     TaskContext,
     TaskResult
@@ -19,6 +17,7 @@ import { Workspace } from "@fern-api/workspace-loader";
 import { input, select } from "@inquirer/prompts";
 import chalk from "chalk";
 import { maxBy } from "lodash-es";
+import { reportError } from "../telemetry/reportError.js";
 import { SentryClient } from "../telemetry/SentryClient.js";
 import { CliEnvironment } from "./CliEnvironment.js";
 import { StdoutRedirector } from "./StdoutRedirector.js";
@@ -127,27 +126,10 @@ export class CliContext {
     public failWithoutThrowing(message?: string, error?: unknown, options?: { code?: CliError.Code }): void {
         this.didSucceed = false;
         if (error instanceof TaskAbortSignal) {
-            // We already tracked the true error, so we can just return.
             return;
         }
-
         logErrorMessage({ message, error, logger: this.logger });
-
-        const code = resolveErrorCode(error, options?.code);
-
-        this.instrumentPostHogEvent({
-            command: process.argv.join(" "),
-            properties: {
-                failed: true,
-                source: "cli",
-                error,
-                errorCode: code
-            }
-        });
-
-        if (shouldReportToSentry(code)) {
-            this.sentryClient.captureException(error ?? new CliError({ message: message ?? "", code }), code);
-        }
+        reportError(this, error, { ...options, message });
     }
 
     /**
@@ -285,8 +267,8 @@ export class CliContext {
         }
     }
 
-    public async captureException(error: unknown, code?: CliError.Code): Promise<void> {
-        await this.sentryClient.captureException(error, code);
+    public captureException(error: unknown, code?: CliError.Code): void {
+        this.sentryClient.captureException(error, code);
     }
 
     public readonly logger = createLogger((level, ...args) => this.log(level, ...args));

packages/cli/cli/src/cli-context/TaskContextImpl.ts

@@ -7,16 +7,15 @@ import {
     Finishable,
     InteractiveTaskContext,
     PosthogEvent,
-    resolveErrorCode,
     Startable,
-    shouldReportToSentry,
     TaskAbortSignal,
     TaskContext,
     TaskResult
 } from "@fern-api/task-context";
-
 import chalk from "chalk";
 
+import { reportError } from "../telemetry/reportError.js";
+
 export declare namespace TaskContextImpl {
     export interface Init {
         logImmediately: (logs: Log[]) => void;
@@ -90,29 +89,11 @@ export class TaskContextImpl implements Startable<TaskContext>, Finishable, Task
 
     public failWithoutThrowing(message?: string, error?: unknown, options?: { code?: CliError.Code }): void {
         this.result = TaskResult.Failure;
-
         if (error instanceof TaskAbortSignal) {
-            // We already tracked the true error, so we can just return.
             return;
         }
-
         logErrorMessage({ message, error, logger: this.logger });
-
-        const code = resolveErrorCode(error, options?.code);
-
-        this.instrumentPostHogEventImpl({
-            command: process.argv.join(" "),
-            properties: {
-                failed: true,
-                source: "task",
-                error,
-                errorCode: code
-            }
-        });
-
-        if (shouldReportToSentry(code)) {
-            this.captureException(error ?? new CliError({ message: message ?? "", code }), code);
-        }
+        reportError(this, error, { ...options, message });
     }
 
     public captureException(error: unknown, code?: CliError.Code): void {

packages/cli/cli/src/telemetry/reportError.ts

@@ -0,0 +1,28 @@
+import type { PosthogEvent } from "@fern-api/task-context";
+import { CliError, resolveErrorCode, shouldReportToSentry, TaskAbortSignal } from "@fern-api/task-context";
+
+export interface ErrorReporter {
+    instrumentPostHogEvent: (event: PosthogEvent) => void;
+    captureException: (error: unknown, code?: CliError.Code) => void;
+}
+
+export function reportError(
+    reporter: ErrorReporter,
+    error: unknown,
+    options?: { message?: string; code?: CliError.Code }
+): void {
+    if (error instanceof TaskAbortSignal) {
+        return;
+    }
+    const code = resolveErrorCode(error, options?.code);
+    reporter.instrumentPostHogEvent({
+        command: process.argv.join(" "),
+        properties: {
+            failed: true,
+            errorCode: code
+        }
+    });
+    if (shouldReportToSentry(code)) {
+        reporter.captureException(error ?? new CliError({ message: options?.message ?? "", code }), code);
+    }
+}