Add overlayDatabaseMode to AugmentationProperties

This commit adds overlayDatabaseMode to AugmentationProperties and
creates a placeholder getOverlayDatabaseMode() function, with the
necessary inputs, to populate it.

Author: cklin

src/config-utils.test.ts

@@ -61,6 +61,7 @@ function createTestInitConfigInputs(
       tempDir: "",
       codeql: {} as CodeQL,
       workspacePath: "",
+      sourceRoot: "",
       githubVersion,
       apiDetails: {
         auth: "token",
@@ -816,6 +817,8 @@ const calculateAugmentationMacro = test.macro({
         rawPacksInput,
         rawQueriesInput,
         languages,
+        "", // sourceRoot
+        undefined, // buildMode
         mockLogger,
       );
     t.deepEqual(actualAugmentationProperties, expectedAugmentationProperties);
@@ -901,6 +904,8 @@ const calculateAugmentationErrorMacro = test.macro({
           rawPacksInput,
           rawQueriesInput,
           languages,
+          "", // sourceRoot
+          undefined, // buildMode
           mockLogger,
         ),
       { message: expectedError },

src/config-utils.ts

@@ -12,6 +12,7 @@ import { shouldPerformDiffInformedAnalysis } from "./diff-informed-analysis-util
 import { Feature, FeatureEnablement } from "./feature-flags";
 import { Language, parseLanguage } from "./languages";
 import { Logger } from "./logging";
+import { OverlayDatabaseMode } from "./overlay-database-utils";
 import { RepositoryNwo } from "./repository";
 import { downloadTrapCaches } from "./trap-caching";
 import {
@@ -184,6 +185,11 @@ export interface AugmentationProperties {
    * Default query filters to apply to the queries in the config.
    */
   defaultQueryFilters?: QueryFilter[];
+
+  /**
+   * The overlay database mode to use.
+   */
+  overlayDatabaseMode: OverlayDatabaseMode;
 }
 
 /**
@@ -196,6 +202,7 @@ export const defaultAugmentationProperties: AugmentationProperties = {
   packsInput: undefined,
   queriesInput: undefined,
   defaultQueryFilters: [],
+  overlayDatabaseMode: OverlayDatabaseMode.None,
 };
 export type Packs = Partial<Record<Language, string[]>>;
 
@@ -419,6 +426,7 @@ export interface InitConfigInputs {
   tempDir: string;
   codeql: CodeQL;
   workspacePath: string;
+  sourceRoot: string;
   githubVersion: GitHubVersion;
   apiDetails: api.GitHubApiCombinedDetails;
   features: FeatureEnablement;
@@ -451,6 +459,7 @@ export async function getDefaultConfig({
   repository,
   tempDir,
   codeql,
+  sourceRoot,
   githubVersion,
   features,
   logger,
@@ -475,6 +484,8 @@ export async function getDefaultConfig({
     packsInput,
     queriesInput,
     languages,
+    sourceRoot,
+    buildMode,
     logger,
   );
 
@@ -541,6 +552,7 @@ async function loadConfig({
   tempDir,
   codeql,
   workspacePath,
+  sourceRoot,
   githubVersion,
   apiDetails,
   features,
@@ -584,6 +596,8 @@ async function loadConfig({
     packsInput,
     queriesInput,
     languages,
+    sourceRoot,
+    buildMode,
     logger,
   );
 
@@ -626,6 +640,8 @@ async function loadConfig({
  * @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.
@@ -640,6 +656,8 @@ export async function calculateAugmentation(
   rawPacksInput: string | undefined,
   rawQueriesInput: string | undefined,
   languages: Language[],
+  sourceRoot: string,
+  buildMode: BuildMode | undefined,
   logger: Logger,
 ): Promise<AugmentationProperties> {
   const packsInputCombines = shouldCombine(rawPacksInput);
@@ -653,6 +671,13 @@ export async function calculateAugmentation(
     rawQueriesInput,
     queriesInputCombines,
   );
+  const overlayDatabaseMode = await getOverlayDatabaseMode(
+    codeql,
+    features,
+    sourceRoot,
+    buildMode,
+    logger,
+  );
 
   const defaultQueryFilters: QueryFilter[] = [];
   if (await shouldPerformDiffInformedAnalysis(codeql, features, logger)) {
@@ -665,6 +690,7 @@ export async function calculateAugmentation(
     queriesInput,
     queriesInputCombines,
     defaultQueryFilters,
+    overlayDatabaseMode,
   };
 }
 
@@ -691,6 +717,16 @@ function parseQueriesFromInput(
   return trimmedInput.split(",").map((query) => ({ uses: query.trim() }));
 }
 
+async function getOverlayDatabaseMode(
+  codeql: CodeQL,
+  features: FeatureEnablement,
+  sourceRoot: string,
+  buildMode: BuildMode | undefined,
+  logger: Logger,
+): Promise<OverlayDatabaseMode> {
+  return OverlayDatabaseMode.None;
+}
+
 /**
  * Pack names must be in the form of `scope/name`, with only alpha-numeric characters,
  * and `-` allowed as long as not the first or last char.

src/init-action.ts

@@ -298,6 +298,11 @@ async function run() {
 
   const configFile = getOptionalInput("config-file");
 
+  const sourceRoot = path.resolve(
+    getRequiredEnvParam("GITHUB_WORKSPACE"),
+    getOptionalInput("source-root") || "",
+  );
+
   try {
     const statusReportBase = await createStatusReportBase(
       ActionName.Init,
@@ -366,6 +371,7 @@ async function run() {
         tempDir: getTemporaryDirectory(),
         codeql,
         workspacePath: getRequiredEnvParam("GITHUB_WORKSPACE"),
+        sourceRoot,
         githubVersion: gitHubVersion,
         apiDetails,
         features,
@@ -395,11 +401,6 @@ async function run() {
   }
 
   try {
-    const sourceRoot = path.resolve(
-      getRequiredEnvParam("GITHUB_WORKSPACE"),
-      getOptionalInput("source-root") || "",
-    );
-
     const overlayDatabaseMode = await getOverlayDatabaseMode(
       (await codeql.getVersion()).version,
       config,