From 393c0749651f9ef1cde5357d3a087e1544009bfe Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 16 Dec 2025 17:24:57 +0000 Subject: [PATCH] Refactor existing telemetry diagnostics to use makeTelemetryDiagnostic Refactored bundle-download-telemetry and zstd-availability diagnostics in init-action.ts to use the new makeTelemetryDiagnostic helper function. Also added guard for empty languages array in logGitVersionTelemetry. Co-authored-by: henrymercer <14129055+henrymercer@users.noreply.github.com> --- lib/init-action.js | 26 +++++++------------------- src/git-utils.ts | 4 +++- src/init-action.ts | 23 +++++------------------ 3 files changed, 15 insertions(+), 38 deletions(-) diff --git a/lib/init-action.js b/lib/init-action.js index b814dd154..5645c4d6d 100644 --- a/lib/init-action.js +++ b/lib/init-action.js @@ -85790,9 +85790,11 @@ async function getGitVersion(logger) { } async function logGitVersionTelemetry(config, logger) { const version = await getGitVersion(logger); - if (version !== void 0) { + if (version !== void 0 && config.languages.length > 0) { 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], makeTelemetryDiagnostic( "codeql-action/git-version-telemetry", @@ -90192,17 +90194,10 @@ async function run() { // Arbitrarily choose the first language. We could also choose all languages, but that // increases the risk of misinterpreting the data. config.languages[0], - makeDiagnostic( + makeTelemetryDiagnostic( "codeql-action/bundle-download-telemetry", "CodeQL bundle download telemetry", - { - attributes: toolsDownloadStatusReport, - visibility: { - cliSummaryTable: false, - statusPage: false, - telemetry: true - } - } + toolsDownloadStatusReport ) ); } @@ -90449,17 +90444,10 @@ async function recordZstdAvailability(config, zstdAvailability) { // Arbitrarily choose the first language. We could also choose all languages, but that // increases the risk of misinterpreting the data. config.languages[0], - makeDiagnostic( + makeTelemetryDiagnostic( "codeql-action/zstd-availability", "Zstandard availability", - { - attributes: zstdAvailability, - visibility: { - cliSummaryTable: false, - statusPage: false, - telemetry: true - } - } + zstdAvailability ) ); } diff --git a/src/git-utils.ts b/src/git-utils.ts index 6bae2f40e..9eb1a0596 100644 --- a/src/git-utils.ts +++ b/src/git-utils.ts @@ -88,9 +88,11 @@ export async function logGitVersionTelemetry( logger: Logger, ): Promise { const version = await getGitVersion(logger); - if (version !== undefined) { + if (version !== undefined && config.languages.length > 0) { 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], makeTelemetryDiagnostic( "codeql-action/git-version-telemetry", diff --git a/src/init-action.ts b/src/init-action.ts index dbbae2ad6..ec1f234dd 100644 --- a/src/init-action.ts +++ b/src/init-action.ts @@ -33,6 +33,7 @@ import { flushDiagnostics, logUnwrittenDiagnostics, makeDiagnostic, + makeTelemetryDiagnostic, } from "./diagnostics"; import { EnvVar } from "./environment"; import { Feature, Features } from "./feature-flags"; @@ -419,17 +420,10 @@ async function run() { // Arbitrarily choose the first language. We could also choose all languages, but that // increases the risk of misinterpreting the data. config.languages[0], - makeDiagnostic( + makeTelemetryDiagnostic( "codeql-action/bundle-download-telemetry", "CodeQL bundle download telemetry", - { - attributes: toolsDownloadStatusReport, - visibility: { - cliSummaryTable: false, - statusPage: false, - telemetry: true, - }, - }, + toolsDownloadStatusReport, ), ); } @@ -789,17 +783,10 @@ async function recordZstdAvailability( // Arbitrarily choose the first language. We could also choose all languages, but that // increases the risk of misinterpreting the data. config.languages[0], - makeDiagnostic( + makeTelemetryDiagnostic( "codeql-action/zstd-availability", "Zstandard availability", - { - attributes: zstdAvailability, - visibility: { - cliSummaryTable: false, - statusPage: false, - telemetry: true, - }, - }, + zstdAvailability, ), ); }