diff --git a/lib/init-action.js b/lib/init-action.js index 5d07ede40..7f00feeec 100644 --- a/lib/init-action.js +++ b/lib/init-action.js @@ -88122,6 +88122,15 @@ function addDiagnostic(config, language, diagnostic) { unwrittenDiagnostics.push({ diagnostic, language }); } } +function addNoLanguageDiagnostic(config, diagnostic) { + 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 + ); +} function writeDiagnostic(config, language, diagnostic) { const logger = getActionsLogger(); const databasePath = language ? getCodeQLDatabasePath(config, language) : config.dbLocation; @@ -89910,11 +89919,8 @@ function isCodeQualityEnabled(config) { } async function logGitVersionTelemetry(config, gitVersion) { 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", @@ -89930,11 +89936,8 @@ async function logGeneratedFilesTelemetry(config, duration, generatedFilesCount) if (config.languages.length < 1) { 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", @@ -92692,11 +92695,8 @@ async function run(startedAt) { logger }); 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", @@ -92748,11 +92748,8 @@ async function run(startedAt) { await recordZstdAvailability(config, zstdAvailability); } 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", @@ -93022,11 +93019,8 @@ function getTrapCachingEnabled() { return true; } async function recordZstdAvailability(config, 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", diff --git a/src/config-utils.ts b/src/config-utils.ts index 772c187b8..8bd21b4e2 100644 --- a/src/config-utils.ts +++ b/src/config-utils.ts @@ -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 { 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", diff --git a/src/diagnostics.ts b/src/diagnostics.ts index 493479e64..bf6a4a72d 100644 --- a/src/diagnostics.ts +++ b/src/diagnostics.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. * diff --git a/src/init-action.ts b/src/init-action.ts index f8a40cbd4..239606e1c 100644 --- a/src/init-action.ts +++ b/src/init-action.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",