Stop saving config in initConfig()

Author: cklin

lib/init-action.js

@@ -229,51 +229,6 @@ test("load code quality config", async (t) => {
   });
 });
 
-test("loading config saves config", async (t) => {
-  return await withTmpDir(async (tempDir) => {
-    const logger = getRunnerLogger(true);
-
-    const codeql = createStubCodeQL({
-      async betterResolveLanguages() {
-        return {
-          extractors: {
-            javascript: [{ extractor_root: "" }],
-            python: [{ extractor_root: "" }],
-          },
-        };
-      },
-    });
-
-    // Sanity check the saved config file does not already exist
-    t.false(fs.existsSync(configUtils.getPathToParsedConfigFile(tempDir)));
-
-    // Sanity check that getConfig returns undefined before we have called initConfig
-    t.deepEqual(await configUtils.getConfig(tempDir, logger), undefined);
-
-    const config1 = await configUtils.initConfig(
-      createTestInitConfigInputs({
-        languagesInput: "javascript,python",
-        tempDir,
-        codeql,
-        workspacePath: tempDir,
-        logger,
-      }),
-    );
-
-    // The saved config file should now exist
-    t.true(fs.existsSync(configUtils.getPathToParsedConfigFile(tempDir)));
-
-    // And that same newly-initialised config should now be returned by getConfig
-    const config2 = await configUtils.getConfig(tempDir, logger);
-    t.not(config2, undefined);
-    if (config2 !== undefined) {
-      // removes properties assigned to undefined.
-      const expectedConfig = JSON.parse(JSON.stringify(config1));
-      t.deepEqual(expectedConfig, config2);
-    }
-  });
-});
-
 test("loading config with version mismatch throws", async (t) => {
   return await withTmpDir(async (tempDir) => {
     const logger = getRunnerLogger(true);
@@ -300,7 +255,7 @@ test("loading config with version mismatch throws", async (t) => {
       .stub(actionsUtil, "getActionVersion")
       .returns("does-not-exist");
 
-    await configUtils.initConfig(
+    const config = await configUtils.initConfig(
       createTestInitConfigInputs({
         languagesInput: "javascript,python",
         tempDir,
@@ -309,6 +264,8 @@ test("loading config with version mismatch throws", async (t) => {
         logger,
       }),
     );
+    // initConfig does not save the config, so we do it here.
+    await configUtils.saveConfig(config, logger);
 
     // Restore `getActionVersion`.
     getActionVersionStub.restore();

src/config-utils.test.ts

@@ -1189,9 +1189,6 @@ export async function initConfig(inputs: InitConfigInputs): Promise<Config> {
       exclude: { tags: "exclude-from-incremental" },
     });
   }
-
-  // Save the config so we can easily access it again in the future
-  await saveConfig(config, logger);
   return config;
 }
 

src/config-utils.ts

@@ -681,10 +681,10 @@ async function run() {
     logUnwrittenDiagnostics();
   }
 
-  // We may have updated the config returned from `initConfig`, e.g. to revert
-  // to `OverlayDatabaseMode.None` if we failed to download an overlay-base
-  // database. So we save the config again, to ensure that the `analyze` step
-  // reads the correct config.
+  // We save the config here instead of at the end of `initConfig` because we
+  // may have updated the config returned from `initConfig`, e.g. to revert to
+  // `OverlayDatabaseMode.None` if we failed to download an overlay-base
+  // database.
   await configUtils.saveConfig(config, logger);
   await sendCompletedStatusReport(
     startedAt,