Visitar URL original
Move download telemetry into the status-report directory · github/codeql-action@79fe3a1 · GitHub
Skip to content

Commit 79fe3a1

Browse files
henrymercerCopilot
henrymercer
and
Copilot
committed
Move download telemetry into the status-report directory
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent ead1f7d commit 79fe3a1

6 files changed

Lines changed: 88 additions & 85 deletions

File tree

‎lib/entry-points.js‎

Lines changed: 24 additions & 22 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/init-action.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,11 @@ import {
6565
InitStatusReport,
6666
InitWithConfigStatusReport,
6767
createInitWithConfigStatusReport,
68-
createInitToolsDownloadFields,
6968
createStatusReportBase,
7069
getActionsStatus,
7170
sendStatusReport,
7271
} from "./status-report";
72+
import { createInitToolsDownloadFields } from "./status-report/tools-download";
7373
import { ToolsDownloadStatusReport } from "./tools-download";
7474
import { ToolsFeature } from "./tools-features";
7575
import { getCombinedTracerConfig } from "./tracer-config";

‎src/setup-codeql-action.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ import { ToolsSource } from "./setup-codeql";
2222
import {
2323
ActionName,
2424
InitStatusReport,
25-
createInitToolsDownloadFields,
2625
createStatusReportBase,
2726
getActionsStatus,
2827
sendStatusReport,
2928
} from "./status-report";
29+
import { createInitToolsDownloadFields } from "./status-report/tools-download";
3030
import { ToolsDownloadStatusReport } from "./tools-download";
3131
import {
3232
checkDiskUsage,

‎src/status-report.ts‎

Lines changed: 0 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ import type { OverlayBaseDatabaseDownloadStats } from "./overlay/caching";
3131
import { getRepositoryNwo } from "./repository";
3232
import type { ToolsSource } from "./setup-codeql";
3333
import { registryBaseSchema } from "./start-proxy/types";
34-
import type { ToolsDownloadStatusReport } from "./tools-download";
3534
import {
3635
ConfigurationError,
3736
getRequiredEnvParam,
@@ -625,64 +624,6 @@ export interface InitWithConfigStatusReport extends InitStatusReport {
625624
config_file: string;
626625
}
627626

628-
/** Fields of the init status report populated when the tools source is `download`. */
629-
export interface InitToolsDownloadFields {
630-
/**
631-
* Time taken to download the bundle, in milliseconds. Not populated when the bundle is downloaded
632-
* and extracted concurrently.
633-
*/
634-
tools_download_duration_ms?: ToolsDownloadStatusReport["downloadDurationMs"];
635-
/**
636-
* Time taken to extract the bundle, in milliseconds. Not populated when the bundle is downloaded
637-
* and extracted concurrently.
638-
*/
639-
tools_extraction_duration_ms?: ToolsDownloadStatusReport["extractionDurationMs"];
640-
/**
641-
* Total time taken to make the bundle available on disk, including failed download attempts
642-
* before a fallback, in milliseconds.
643-
*/
644-
tools_total_duration_ms?: ToolsDownloadStatusReport["totalDurationMs"];
645-
/**
646-
* Whether the relevant tools dotcom feature flags have been misconfigured.
647-
* Only populated if we attempt to determine the default version based on the dotcom feature flags. */
648-
tools_feature_flags_valid?: boolean;
649-
/** The language of the single-language bundle that was downloaded, if any. */
650-
tools_bundle_language?: ToolsDownloadStatusReport["bundleLanguage"];
651-
/**
652-
* Whether we tried to download a single-language bundle, but it did not exist and we fell back to
653-
* the combined bundle.
654-
*/
655-
tools_per_language_bundle_fallback?: ToolsDownloadStatusReport["perLanguageBundleFallback"];
656-
}
657-
658-
/** Converts download results to telemetry fields shared by the init and setup-codeql Actions. */
659-
export function createInitToolsDownloadFields(
660-
report: ToolsDownloadStatusReport | undefined,
661-
toolsFeatureFlagsValid: boolean | undefined,
662-
): InitToolsDownloadFields {
663-
const fields: InitToolsDownloadFields = {};
664-
if (report?.downloadDurationMs !== undefined) {
665-
fields.tools_download_duration_ms = report.downloadDurationMs;
666-
}
667-
if (report?.extractionDurationMs !== undefined) {
668-
fields.tools_extraction_duration_ms = report.extractionDurationMs;
669-
}
670-
if (report?.totalDurationMs !== undefined) {
671-
fields.tools_total_duration_ms = report.totalDurationMs;
672-
}
673-
if (report?.bundleLanguage !== undefined) {
674-
fields.tools_bundle_language = report.bundleLanguage;
675-
}
676-
if (report?.perLanguageBundleFallback !== undefined) {
677-
fields.tools_per_language_bundle_fallback =
678-
report.perLanguageBundleFallback;
679-
}
680-
if (toolsFeatureFlagsValid !== undefined) {
681-
fields.tools_feature_flags_valid = toolsFeatureFlagsValid;
682-
}
683-
return fields;
684-
}
685-
686627
/**
687628
* Composes a `InitWithConfigStatusReport` from the given values.
688629
*

src/tools-download-status-report.test.ts renamed to src/status-report/tools-download.test.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
import test from "ava";
22

3-
import { BuiltInLanguage } from "./languages";
4-
import { createInitToolsDownloadFields } from "./status-report";
3+
import { BuiltInLanguage } from "../languages";
4+
5+
import { createInitToolsDownloadFields } from "./tools-download";
56

67
test("createInitToolsDownloadFields omits absent download data", (t) => {
78
t.deepEqual(createInitToolsDownloadFields(undefined, undefined), {});

‎src/status-report/tools-download.ts‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
import type { ToolsDownloadStatusReport } from "../tools-download";
2+
3+
/** Fields of the init status report populated when the tools source is `download`. */
4+
export interface InitToolsDownloadFields {
5+
/**
6+
* Time taken to download the bundle, in milliseconds. Not populated when the bundle is downloaded
7+
* and extracted concurrently.
8+
*/
9+
tools_download_duration_ms?: ToolsDownloadStatusReport["downloadDurationMs"];
10+
/**
11+
* Time taken to extract the bundle, in milliseconds. Not populated when the bundle is downloaded
12+
* and extracted concurrently.
13+
*/
14+
tools_extraction_duration_ms?: ToolsDownloadStatusReport["extractionDurationMs"];
15+
/**
16+
* Total time taken to make the bundle available on disk, including failed download attempts
17+
* before a fallback, in milliseconds.
18+
*/
19+
tools_total_duration_ms?: ToolsDownloadStatusReport["totalDurationMs"];
20+
/**
21+
* Whether the relevant tools dotcom feature flags have been misconfigured.
22+
* Only populated if we attempt to determine the default version based on the dotcom feature flags. */
23+
tools_feature_flags_valid?: boolean;
24+
/** The language of the single-language bundle that was downloaded, if any. */
25+
tools_bundle_language?: ToolsDownloadStatusReport["bundleLanguage"];
26+
/**
27+
* Whether we tried to download a single-language bundle, but it did not exist and we fell back to
28+
* the combined bundle.
29+
*/
30+
tools_per_language_bundle_fallback?: ToolsDownloadStatusReport["perLanguageBundleFallback"];
31+
}
32+
33+
/** Converts download results to telemetry fields shared by the init and setup-codeql Actions. */
34+
export function createInitToolsDownloadFields(
35+
report: ToolsDownloadStatusReport | undefined,
36+
toolsFeatureFlagsValid: boolean | undefined,
37+
): InitToolsDownloadFields {
38+
const fields: InitToolsDownloadFields = {};
39+
if (report?.downloadDurationMs !== undefined) {
40+
fields.tools_download_duration_ms = report.downloadDurationMs;
41+
}
42+
if (report?.extractionDurationMs !== undefined) {
43+
fields.tools_extraction_duration_ms = report.extractionDurationMs;
44+
}
45+
if (report?.totalDurationMs !== undefined) {
46+
fields.tools_total_duration_ms = report.totalDurationMs;
47+
}
48+
if (report?.bundleLanguage !== undefined) {
49+
fields.tools_bundle_language = report.bundleLanguage;
50+
}
51+
if (report?.perLanguageBundleFallback !== undefined) {
52+
fields.tools_per_language_bundle_fallback =
53+
report.perLanguageBundleFallback;
54+
}
55+
if (toolsFeatureFlagsValid !== undefined) {
56+
fields.tools_feature_flags_valid = toolsFeatureFlagsValid;
57+
}
58+
return fields;
59+
}

0 commit comments

Comments
 (0)