Bump verbosity of database finalize in debug mode

lib/analyze.js

@@ -138,7 +138,7 @@ async function finalizeDatabaseCreation(config, threadsFlag, memoryFlag, logger,
         }
         else {
             logger.startGroup(`Finalizing ${language}`);
-            await codeql.finalizeDatabase(util.getCodeQLDatabasePath(config, language), threadsFlag, memoryFlag);
+            await codeql.finalizeDatabase(util.getCodeQLDatabasePath(config, language), threadsFlag, memoryFlag, config.debugMode);
             logger.endGroup();
         }
     }

lib/codeql.js

@@ -383,13 +383,16 @@ async function getCodeQLForCmd(cmd, checkVersion) {
                 util.getCodeQLDatabasePath(config, language),
             ]);
         },
-        async finalizeDatabase(databasePath, threadsFlag, memoryFlag) {
+        async finalizeDatabase(databasePath, threadsFlag, memoryFlag, enableDebugLogging) {
             const args = [
                 "database",
                 "finalize",
                 "--finalize-dataset",
                 threadsFlag,
                 memoryFlag,
+                ...(enableDebugLogging
+                    ? [`--verbosity=${EXTRACTION_DEBUG_MODE_VERBOSITY}`]
+                    : []),
                 ...getExtraOptionsFromEnv(["database", "finalize"]),
                 databasePath,
             ];

lib/codeql.test.js

@@ -553,7 +553,7 @@ for (const { codeqlVersion, flagPassed, githubVersion, negativeFlagPassed, } of
     sinon.stub(codeqlObject, "getVersion").resolves((0, testing_utils_1.makeVersionInfo)("2.11.6"));
     // safeWhich throws because of the test CodeQL object.
     sinon.stub(safeWhich, "safeWhich").resolves("");
-    await t.throwsAsync(async () => await codeqlObject.finalizeDatabase("", "", ""), {
+    await t.throwsAsync(async () => await codeqlObject.finalizeDatabase("", "", "", false), {
         instanceOf: util.ConfigurationError,
         message: new RegExp("No code found during the build\\. Please see: " +
             "https://gh\\.io/troubleshooting-code-scanning/no-source-code-seen-during-build\\."),
@@ -565,7 +565,7 @@ for (const { codeqlVersion, flagPassed, githubVersion, negativeFlagPassed, } of
     sinon.stub(codeqlObject, "getVersion").resolves((0, testing_utils_1.makeVersionInfo)("2.11.6"));
     // safeWhich throws because of the test CodeQL object.
     sinon.stub(safeWhich, "safeWhich").resolves("");
-    await t.throwsAsync(async () => await codeqlObject.finalizeDatabase("", "", ""), {
+    await t.throwsAsync(async () => await codeqlObject.finalizeDatabase("", "", "", false), {
         instanceOf: util.ConfigurationError,
         message: new RegExp("No code found during the build\\. Please see: " +
             "https://gh\\.io/troubleshooting-code-scanning/no-source-code-seen-during-build\\."),
@@ -579,7 +579,7 @@ for (const { codeqlVersion, flagPassed, githubVersion, negativeFlagPassed, } of
     sinon.stub(codeqlObject, "getVersion").resolves((0, testing_utils_1.makeVersionInfo)("2.12.4"));
     // safeWhich throws because of the test CodeQL object.
     sinon.stub(safeWhich, "safeWhich").resolves("");
-    await t.throwsAsync(async () => await codeqlObject.finalizeDatabase("db", "--threads=2", "--ram=2048"), {
+    await t.throwsAsync(async () => await codeqlObject.finalizeDatabase("db", "--threads=2", "--ram=2048", false), {
         message: 'Encountered a fatal error while running "codeql-for-testing database finalize --finalize-dataset --threads=2 --ram=2048 db". ' +
             `Exit code was 32 and last log line was: ${cliMessage} See the logs for more details.`,
     });
@@ -594,7 +594,7 @@ for (const { codeqlVersion, flagPassed, githubVersion, negativeFlagPassed, } of
     sinon.stub(codeqlObject, "getVersion").resolves((0, testing_utils_1.makeVersionInfo)("2.12.4"));
     // safeWhich throws because of the test CodeQL object.
     sinon.stub(safeWhich, "safeWhich").resolves("");
-    await t.throwsAsync(async () => await codeqlObject.finalizeDatabase("db", "--threads=2", "--ram=2048"), {
+    await t.throwsAsync(async () => await codeqlObject.finalizeDatabase("db", "--threads=2", "--ram=2048", false), {
         instanceOf: util.ConfigurationError,
         message: new RegExp('Encountered a fatal error while running \\"codeql-for-testing database finalize --finalize-dataset --threads=2 --ram=2048 db\\"\\. ' +
             `Exit code was 32 and error was: ${datasetImportError.replaceAll(".", "\\.")}\\. Context: ${heapError.replaceAll(".", "\\.")}\\. See the logs for more details\\.`),
@@ -607,7 +607,7 @@ for (const { codeqlVersion, flagPassed, githubVersion, negativeFlagPassed, } of
     sinon.stub(codeqlObject, "getVersion").resolves((0, testing_utils_1.makeVersionInfo)("2.12.4"));
     // safeWhich throws because of the test CodeQL object.
     sinon.stub(safeWhich, "safeWhich").resolves("");
-    await t.throwsAsync(async () => await codeqlObject.finalizeDatabase("db", "--threads=2", "--ram=2048"), {
+    await t.throwsAsync(async () => await codeqlObject.finalizeDatabase("db", "--threads=2", "--ram=2048", false), {
         instanceOf: util.ConfigurationError,
         message: new RegExp('Encountered a fatal error while running \\"codeql-for-testing database finalize --finalize-dataset --threads=2 --ram=2048 db\\"\\. ' +
             "Exit code was 32 and last log line was: line5\\. See the logs for more details\\."),

src/analyze.ts

@@ -263,6 +263,7 @@ async function finalizeDatabaseCreation(
         util.getCodeQLDatabasePath(config, language),
         threadsFlag,
         memoryFlag,
+        config.debugMode,
       );
       logger.endGroup();
     }

src/codeql.test.ts

@@ -873,7 +873,7 @@ test("database finalize recognises JavaScript no code found error on CodeQL 2.11
   sinon.stub(safeWhich, "safeWhich").resolves("");
 
   await t.throwsAsync(
-    async () => await codeqlObject.finalizeDatabase("", "", ""),
+    async () => await codeqlObject.finalizeDatabase("", "", "", false),
     {
       instanceOf: util.ConfigurationError,
       message: new RegExp(
@@ -892,7 +892,7 @@ test("database finalize overrides no code found error on CodeQL 2.11.6", async (
   sinon.stub(safeWhich, "safeWhich").resolves("");
 
   await t.throwsAsync(
-    async () => await codeqlObject.finalizeDatabase("", "", ""),
+    async () => await codeqlObject.finalizeDatabase("", "", "", false),
     {
       instanceOf: util.ConfigurationError,
       message: new RegExp(
@@ -915,7 +915,12 @@ test("database finalize does not override no code found error on CodeQL 2.12.4",
 
   await t.throwsAsync(
     async () =>
-      await codeqlObject.finalizeDatabase("db", "--threads=2", "--ram=2048"),
+      await codeqlObject.finalizeDatabase(
+        "db",
+        "--threads=2",
+        "--ram=2048",
+        false,
+      ),
     {
       message:
         'Encountered a fatal error while running "codeql-for-testing database finalize --finalize-dataset --threads=2 --ram=2048 db". ' +
@@ -940,7 +945,12 @@ test("runTool summarizes several fatal errors", async (t) => {
 
   await t.throwsAsync(
     async () =>
-      await codeqlObject.finalizeDatabase("db", "--threads=2", "--ram=2048"),
+      await codeqlObject.finalizeDatabase(
+        "db",
+        "--threads=2",
+        "--ram=2048",
+        false,
+      ),
     {
       instanceOf: util.ConfigurationError,
       message: new RegExp(
@@ -967,7 +977,12 @@ test("runTool outputs last line of stderr if fatal error could not be found", as
 
   await t.throwsAsync(
     async () =>
-      await codeqlObject.finalizeDatabase("db", "--threads=2", "--ram=2048"),
+      await codeqlObject.finalizeDatabase(
+        "db",
+        "--threads=2",
+        "--ram=2048",
+        false,
+      ),
     {
       instanceOf: util.ConfigurationError,
       message: new RegExp(

src/codeql.ts

@@ -100,6 +100,7 @@ export interface CodeQL {
     databasePath: string,
     threadsFlag: string,
     memoryFlag: string,
+    enableDebugLogging: boolean,
   ): Promise<void>;
   /**
    * Run 'codeql resolve languages'.
@@ -715,6 +716,7 @@ export async function getCodeQLForCmd(
       databasePath: string,
       threadsFlag: string,
       memoryFlag: string,
+      enableDebugLogging: boolean,
     ) {
       const args = [
         "database",
@@ -722,6 +724,9 @@ export async function getCodeQLForCmd(
         "--finalize-dataset",
         threadsFlag,
         memoryFlag,
+        ...(enableDebugLogging
+          ? [`--verbosity=${EXTRACTION_DEBUG_MODE_VERBOSITY}`]
+          : []),
         ...getExtraOptionsFromEnv(["database", "finalize"]),
         databasePath,
       ];