Introduce addNoLanguageDiagnostic

Author: henrymercer

lib/init-action.js

@@ -26,7 +26,10 @@ import {
   parseUserConfig,
   UserConfig,
 } from "./config/db-config";
-import { addDiagnostic, makeTelemetryDiagnostic } from "./diagnostics";
+import {
+  addNoLanguageDiagnostic,
+  makeTelemetryDiagnostic,
+} from "./diagnostics";
 import { shouldPerformDiffInformedAnalysis } from "./diff-informed-analysis-utils";
 import { EnvVar } from "./environment";
 import * as errorMessages from "./error-messages";
@@ -1408,11 +1411,8 @@ async function logGitVersionTelemetry(
   gitVersion: GitVersionInfo,
 ): Promise<void> {
   if (config.languages.length > 0) {
-    addDiagnostic(
+    addNoLanguageDiagnostic(
       config,
-      // Arbitrarily choose the first language. We could also choose all languages, but that
-      // increases the risk of misinterpreting the data.
-      config.languages[0],
       makeTelemetryDiagnostic(
         "codeql-action/git-version-telemetry",
         "Git version telemetry",
@@ -1438,11 +1438,8 @@ async function logGeneratedFilesTelemetry(
     return;
   }
 
-  addDiagnostic(
+  addNoLanguageDiagnostic(
     config,
-    // Arbitrarily choose the first language. We could also choose all languages, but that
-    // increases the risk of misinterpreting the data.
-    config.languages[0],
     makeTelemetryDiagnostic(
       "codeql-action/generated-files-telemetry",
       "Generated files telemetry",

src/config-utils.ts

@@ -117,6 +117,20 @@ export function addDiagnostic(
   }
 }
 
+/** Adds a diagnostic that is not specific to any language. */
+export function addNoLanguageDiagnostic(
+  config: Config,
+  diagnostic: DiagnosticMessage,
+) {
+  addDiagnostic(
+    config,
+    // Arbitrarily choose the first language. We could also choose all languages, but that
+    // increases the risk of misinterpreting the data.
+    config.languages[0],
+    diagnostic,
+  );
+}
+
 /**
  * Writes the given diagnostic to the database.
  *

src/diagnostics.ts

@@ -31,6 +31,7 @@ import {
 } from "./dependency-caching";
 import {
   addDiagnostic,
+  addNoLanguageDiagnostic,
   flushDiagnostics,
   logUnwrittenDiagnostics,
   makeDiagnostic,
@@ -374,11 +375,8 @@ async function run(startedAt: Date) {
     });
 
     if (repositoryPropertiesResult.isFailure()) {
-      addDiagnostic(
+      addNoLanguageDiagnostic(
         config,
-        // Arbitrarily choose the first language. We could also choose all languages, but that
-        // increases the risk of misinterpreting the data.
-        config.languages[0],
         makeTelemetryDiagnostic(
           "codeql-action/repository-properties-load-failure",
           "Failed to load repository properties",
@@ -451,11 +449,8 @@ async function run(startedAt: Date) {
 
     // Log CodeQL download telemetry, if appropriate
     if (toolsDownloadStatusReport) {
-      addDiagnostic(
+      addNoLanguageDiagnostic(
         config,
-        // Arbitrarily choose the first language. We could also choose all languages, but that
-        // increases the risk of misinterpreting the data.
-        config.languages[0],
         makeTelemetryDiagnostic(
           "codeql-action/bundle-download-telemetry",
           "CodeQL bundle download telemetry",
@@ -853,11 +848,8 @@ async function recordZstdAvailability(
   config: configUtils.Config,
   zstdAvailability: ZstdAvailability,
 ) {
-  addDiagnostic(
+  addNoLanguageDiagnostic(
     config,
-    // Arbitrarily choose the first language. We could also choose all languages, but that
-    // increases the risk of misinterpreting the data.
-    config.languages[0],
     makeTelemetryDiagnostic(
       "codeql-action/zstd-availability",
       "Zstandard availability",