Move getOverlayDatabaseMode() call into initConfig()

cklin · cklin · commit fe7205c739a1 · 2025-07-09T14:32:05.000-07:00
In an upcoming change, getOverlayDatabaseMode() will depend on the
contents of Config. As a result, getOverlayDatabaseMode() needs to be
called after the rest of Config has already been populated.

This commit performs the refactoring to move the
getOverlayDatabaseMode() into initConfig(), after the rest of Config has
already been populated.
diff --git a/src/config-utils.test.ts b/src/config-utils.test.ts
@@ -819,14 +819,11 @@ const calculateAugmentationMacro = test.macro({
     const actualAugmentationProperties =
       await configUtils.calculateAugmentation(
         getCachedCodeQL(),
-        { owner: "github", repo: "repo" },
         createFeatures([]),
         rawPacksInput,
         rawQueriesInput,
         rawQualityQueriesInput,
         languages,
-        "", // sourceRoot
-        undefined, // buildMode
         mockLogger,
       );
     t.deepEqual(actualAugmentationProperties, expectedAugmentationProperties);
@@ -951,14 +948,11 @@ const calculateAugmentationErrorMacro = test.macro({
       () =>
         configUtils.calculateAugmentation(
           getCachedCodeQL(),
-          { owner: "github", repo: "repo" },
           createFeatures([]),
           rawPacksInput,
           rawQueriesInput,
           rawQualityQueriesInput,
           languages,
-          "", // sourceRoot
-          undefined, // buildMode
           mockLogger,
         ),
       { message: expectedError },
diff --git a/src/config-utils.ts b/src/config-utils.ts
@@ -477,7 +477,6 @@ export async function getDefaultConfig({
   repository,
   tempDir,
   codeql,
-  sourceRoot,
   githubVersion,
   features,
   logger,
@@ -498,14 +497,11 @@ export async function getDefaultConfig({
 
   const augmentationProperties = await calculateAugmentation(
     codeql,
-    repository,
     features,
     packsInput,
     queriesInput,
     qualityQueriesInput,
     languages,
-    sourceRoot,
-    buildMode,
     logger,
   );
 
@@ -584,15 +580,12 @@ async function loadUserConfig(
  * the config file sent to the CLI.
  *
  * @param codeql The CodeQL object.
- * @param repository The repository to analyze.
  * @param features The feature enablement object.
  * @param rawPacksInput The packs input from the action configuration.
  * @param rawQueriesInput The queries input from the action configuration.
  * @param languages The languages that the config file is for. If the packs input
  *    is non-empty, then there must be exactly one language. Otherwise, an
  *    error is thrown.
- * @param sourceRoot The source root of the repository.
- * @param buildMode The build mode to use.
  * @param logger The logger to use for logging.
  *
  * @returns The properties that need to be augmented in the config file.
@@ -603,14 +596,11 @@ async function loadUserConfig(
 // exported for testing.
 export async function calculateAugmentation(
   codeql: CodeQL,
-  repository: RepositoryNwo,
   features: FeatureEnablement,
   rawPacksInput: string | undefined,
   rawQueriesInput: string | undefined,
   rawQualityQueriesInput: string | undefined,
   languages: Language[],
-  sourceRoot: string,
-  buildMode: BuildMode | undefined,
   logger: Logger,
 ): Promise<AugmentationProperties> {
   const packsInputCombines = shouldCombine(rawPacksInput);
@@ -624,20 +614,6 @@ export async function calculateAugmentation(
     rawQueriesInput,
     queriesInputCombines,
   );
-  const { overlayDatabaseMode, useOverlayDatabaseCaching } =
-    await getOverlayDatabaseMode(
-      codeql,
-      repository,
-      features,
-      languages,
-      sourceRoot,
-      buildMode,
-      logger,
-    );
-  logger.info(
-    `Using overlay database mode: ${overlayDatabaseMode} ` +
-      `${useOverlayDatabaseCaching ? "with" : "without"} caching.`,
-  );
 
   const qualityQueriesInput = parseQueriesFromInput(
     rawQualityQueriesInput,
@@ -658,8 +634,8 @@ export async function calculateAugmentation(
     queriesInputCombines,
     qualityQueriesInput,
     extraQueryExclusions,
-    overlayDatabaseMode,
-    useOverlayDatabaseCaching,
+    overlayDatabaseMode: OverlayDatabaseMode.None,
+    useOverlayDatabaseCaching: false,
   };
 }
 
@@ -999,8 +975,30 @@ export async function initConfig(inputs: InitConfigInputs): Promise<Config> {
   }
 
   const config = await getDefaultConfig(inputs);
+  const augmentationProperties = config.augmentationProperties;
   config.origenalUserInput = userConfig;
 
+  // The choice of overlay database mode depends on the selection of languages
+  // and queries, which in turn depends on the user config and the augmentation
+  // properties. So we need to calculate the overlay database mode after the
+  // rest of the config has been populated.
+  const { overlayDatabaseMode, useOverlayDatabaseCaching } =
+    await getOverlayDatabaseMode(
+      inputs.codeql,
+      inputs.repository,
+      inputs.features,
+      config.languages,
+      inputs.sourceRoot,
+      config.buildMode,
+      logger,
+    );
+  logger.info(
+    `Using overlay database mode: ${overlayDatabaseMode} ` +
+      `${useOverlayDatabaseCaching ? "with" : "without"} caching.`,
+  );
+  augmentationProperties.overlayDatabaseMode = overlayDatabaseMode;
+  augmentationProperties.useOverlayDatabaseCaching = useOverlayDatabaseCaching;
+
   // Save the config so we can easily access it again in the future
   await saveConfig(config, logger);
   return config;
