Fix --test-suite-id precedence

Author: ramosbugs

packages/cypress-plugin/src/main.ts

@@ -263,7 +263,7 @@ const main = async (): Promise<void> => {
       ? path.resolve(process.cwd(), runOptions.project)
       : process.cwd();
 
-  const unflakableConfig = await loadConfig(projectRoot);
+  const unflakableConfig = await loadConfig(projectRoot, args["test-suite-id"]);
   debug(`Unflakable plugin is ${unflakableConfig.enabled ? "en" : "dis"}abled`);
 
   if (unflakableConfig.enabled) {
@@ -285,9 +285,6 @@ const main = async (): Promise<void> => {
         "quarantine-mode"
       ] as QuarantineMode;
     }
-    if (args["test-suite-id"] !== undefined) {
-      unflakableConfig.testSuiteId = args["test-suite-id"];
-    }
     if (args["upload-results"] !== undefined) {
       unflakableConfig.uploadResults = args["upload-results"];
     }

packages/cypress-plugin/test/integration/src/config.test.ts

@@ -37,6 +37,20 @@ integrationTestSuite(() => {
     ));
 
   it("set test suite ID via CLI", (done) =>
+    integrationTest(
+      {
+        params: {
+          cliArgs: ["--test-suite-id", "MOCK_SUITE_ID_CLI"],
+          envVars: {
+            UNFLAKABLE_SUITE_ID: undefined,
+          },
+          expectedSuiteId: "MOCK_SUITE_ID_CLI",
+        },
+      },
+      done
+    ));
+
+  it("set test suite ID via CLI override", (done) =>
     integrationTest(
       {
         params: {

packages/plugins-common/src/config.ts

@@ -141,7 +141,10 @@ const apiBaseUrlOverride = new EnvVar("UNFLAKABLE_API_BASE_URL");
 const apiKey = new EnvVar("UNFLAKABLE_API_KEY");
 const enabledOverride = new EnvVar("UNFLAKABLE_ENABLED");
 
-const mergeConfigWithEnv = (config: UnflakableConfigFile): UnflakableConfig => {
+const mergeConfigWithEnv = (
+  config: UnflakableConfigFile,
+  cliTestSuiteId?: string
+): UnflakableConfig => {
   if (enabledOverride.value !== undefined) {
     const enabled = !["false", "0"].includes(enabledOverride.value);
     debug(
@@ -177,7 +180,13 @@ const mergeConfigWithEnv = (config: UnflakableConfigFile): UnflakableConfig => {
     config.uploadResults = uploadResults;
   }
 
-  if (suiteIdOverride.value !== undefined && suiteIdOverride.value.length > 0) {
+  if (cliTestSuiteId !== undefined) {
+    debug(`Using suite ID \`${cliTestSuiteId}\` from CLI`);
+    return { ...config, testSuiteId: cliTestSuiteId };
+  } else if (
+    suiteIdOverride.value !== undefined &&
+    suiteIdOverride.value.length > 0
+  ) {
     debug(
       `Using suite ID \`${suiteIdOverride.value}\` from environment variable ${suiteIdOverride.name}`
     );
@@ -236,8 +245,13 @@ const loadConfigFile = async (
   }
 };
 
-export const loadConfig = (searchFrom: string): Promise<UnflakableConfig> =>
-  loadConfigFile(searchFrom).then(mergeConfigWithEnv);
+export const loadConfig = (
+  searchFrom: string,
+  testSuiteId?: string
+): Promise<UnflakableConfig> =>
+  loadConfigFile(searchFrom).then((config) =>
+    mergeConfigWithEnv(config, testSuiteId)
+  );
 
 const loadConfigFileSync = (searchFrom: string): UnflakableConfigFile => {
   const configExplorer = cosmiconfigSync("unflakable", {