Unconditionally report unwritten diagnostics at the end of the init…

… Action
github · Apr 12, 2024 · 1ac88f3 · 1ac88f3
1 parent 3901d12
commit 1ac88f3
Show file tree

Hide file tree

Showing 6 changed files with 41 additions and 4 deletions.
diff --git a/lib/diagnostics.js b/lib/diagnostics.js
diff --git a/lib/diagnostics.js.map b/lib/diagnostics.js.map
diff --git a/lib/init-action.js b/lib/init-action.js
diff --git a/lib/init-action.js.map b/lib/init-action.js.map
diff --git a/src/diagnostics.ts b/src/diagnostics.ts
@@ -149,6 +149,21 @@ function writeDiagnostic(
   }
 }
 
+/** Report if there are unwritten diagnostics and write them to the log. */
+export function logUnwrittenDiagnostics() {
+  const logger = getActionsLogger();
+  const num = unwrittenDiagnostics.length;
+  if (num > 0) {
+    logger.warning(
+      `${num} diagnostic(s) could not be written to the database and will not appear on the Tool Status Page.`,
+    );
+
+    for (const unwritten of unwrittenDiagnostics) {
+      logger.debug(JSON.stringify(unwritten.diagnostic));
+    }
+  }
+}
+
 /** Writes all unwritten diagnostics to disk. */
 export function flushDiagnostics(config: Config) {
   const logger = getActionsLogger();

diff --git a/src/init-action.ts b/src/init-action.ts
@@ -16,7 +16,12 @@ import {
 import { getGitHubVersion } from "./api-client";
 import { CodeQL } from "./codeql";
 import * as configUtils from "./config-utils";
-import { addDiagnostic, flushDiagnostics, makeDiagnostic } from "./diagnostics";
+import {
+  addDiagnostic,
+  flushDiagnostics,
+  logUnwrittenDiagnostics,
+  makeDiagnostic,
+} from "./diagnostics";
 import { EnvVar } from "./environment";
 import { Feature, Features } from "./feature-flags";
 import { checkInstallPython311, initCodeQL, initConfig, runInit } from "./init";
@@ -541,6 +546,8 @@ async function run() {
       error,
     );
     return;
+  } finally {
+    logUnwrittenDiagnostics();
   }
   await sendCompletedStatusReport(
     startedAt,