Don't exit with missing suite ID when plugin is disabled

ramosbugs · ramosbugs · commit 7083586da133 · 2023-07-11T22:51:55.000-07:00
diff --git a/packages/cypress-plugin/src/plugin.ts b/packages/cypress-plugin/src/plugin.ts
@@ -19,6 +19,7 @@ import {
   normalizeTestName,
   toPosix,
   UnflakableConfig,
+  UnflakableConfigEnabled,
 } from "@unflakable/plugins-common";
 import { printWarning, require, userAgent } from "./utils";
 import { configureMochaReporter } from "./reporter-config";
@@ -505,7 +506,8 @@ ${
         end_time: new Date(results.endedTestsAt).toISOString(),
         test_runs: testRuns,
       },
-      testSuiteId: this.unflakableConfig.testSuiteId,
+      testSuiteId: (this.unflakableConfig as UnflakableConfigEnabled)
+        .testSuiteId,
       apiKey: this.apiKey,
       baseUrl: this.unflakableConfig.apiBaseUrl,
       clientDescription: userAgentStr,
diff --git a/packages/jest-plugin/src/reporter.ts b/packages/jest-plugin/src/reporter.ts
@@ -44,6 +44,7 @@ import {
   loadGitRepo,
   toPosix,
   UnflakableConfig,
+  UnflakableConfigEnabled,
 } from "@unflakable/plugins-common";
 
 const debug = _debug("unflakable:reporter");
@@ -414,7 +415,8 @@ export default class UnflakableReporter extends BaseReporter {
     aggregatedResults: AggregatedResult,
     unflakableConfig: UnflakableConfig
   ): Promise<void> {
-    const testSuiteId = unflakableConfig.testSuiteId;
+    const testSuiteId = (unflakableConfig as UnflakableConfigEnabled)
+      .testSuiteId;
 
     const git = unflakableConfig.gitAutoDetect ? await loadGitRepo() : null;
     const repoRoot = git !== null ? await getRepoRoot(git) : this.rootDir;
diff --git a/packages/plugins-common/src/config.ts b/packages/plugins-common/src/config.ts
@@ -9,19 +9,30 @@ const debug = _debug("unflakable:plugins-common:config");
 
 export type QuarantineMode = "no_quarantine" | "skip_tests" | "ignore_failures";
 
-export type UnflakableConfig = {
+type UnflakableConfigInner = {
   apiBaseUrl: string | undefined;
-  enabled: boolean;
   failureRetries: number;
   gitAutoDetect: boolean;
   quarantineMode: QuarantineMode;
-  testSuiteId: string;
   uploadResults: boolean;
 };
 
-type UnflakableConfigFile = Omit<UnflakableConfig, "testSuiteId"> & {
+export type UnflakableConfigEnabled = {
+  enabled: true;
+  testSuiteId: string;
+} & UnflakableConfigInner;
+
+export type UnflakableConfig =
+  | UnflakableConfigEnabled
+  | ({
+      enabled: false;
+      testSuiteId: string | undefined;
+    } & UnflakableConfigInner);
+
+type UnflakableConfigFile = {
+  enabled: boolean;
   testSuiteId: string | undefined;
-};
+} & UnflakableConfigInner;
 
 const defaultConfig: UnflakableConfigFile = {
   apiBaseUrl: undefined,
@@ -196,12 +207,17 @@ const mergeConfigWithEnv = (
     config.testSuiteId.length > 0
   ) {
     debug(`Using suite ID \`${config.testSuiteId}\` from config file`);
-    return config as UnflakableConfig;
-  } else {
+    return config.enabled
+      ? // TypeScript has trouble inferring that these types are correct otherwise.
+        { ...config, enabled: true, testSuiteId: config.testSuiteId }
+      : { ...config, enabled: false };
+  } else if (config.enabled) {
     throw new Error(
       `Unflakable test suite ID not found in config file or ${suiteIdOverride.name} environment ` +
         "variable"
     );
+  } else {
+    return { ...config, enabled: false };
   }
 };
 
diff --git a/packages/plugins-common/src/index.ts b/packages/plugins-common/src/index.ts
@@ -5,6 +5,7 @@ import path from "path";
 export {
   QuarantineMode,
   UnflakableConfig,
+  UnflakableConfigEnabled,
   loadApiKey,
   loadConfig,
   loadConfigSync,
diff --git a/packages/test-common/src/config.ts b/packages/test-common/src/config.ts
@@ -9,7 +9,7 @@ import {
 import type { cosmiconfig, cosmiconfigSync, Options } from "cosmiconfig";
 import { default as expect } from "expect";
 
-const debug = _debug("unflakable:integration-common:config");
+const debug = _debug("unflakable:test-common:config");
 
 const throwUnimplemented = (): never => {
   throw new Error("unimplemented");
diff --git a/packages/test-common/src/git.ts b/packages/test-common/src/git.ts
@@ -5,7 +5,7 @@ import { setSimpleGitFactory } from "@unflakable/plugins-common";
 import { SimpleGit, TaskOptions, Response as GitResponse } from "simple-git";
 import deepEqual from "deep-equal";
 
-const debug = _debug("unflakable:integration-common:git");
+const debug = _debug("unflakable:test-common:git");
 
 export type SimpleGitMockRef = {
   sha: string;
