Skip to content

Extract directly to the toolcache #2631

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
henrymercer merged 14 commits into from
Dec 4, 2024
Merged

Extract directly to the toolcache #2631

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
be26fe6
Enable specifying extraction destination
henrymercer Nov 6, 2024
6695503
Add feature flag for extracting directly to toolcache
henrymercer Nov 6, 2024
198fb4b
Extract directly to toolcache when feature enabled
henrymercer Dec 2, 2024
028cece
Add PR check
henrymercer Dec 2, 2024
0b20485
Write toolcache marker file
henrymercer Dec 2, 2024
8c0517f
PR check: Ensure bundle added to toolcache
henrymercer Dec 3, 2024
f8ccf38
PR check: Check toolcache empty at start
henrymercer Dec 3, 2024
d57328a
Run PR check on Windows too
henrymercer Dec 3, 2024
d5bcf48
Add more error handling to zstd extraction
henrymercer Dec 3, 2024
b2a4442
Ensure destination directory exists when streaming extraction
henrymercer Dec 3, 2024
93f3303
Tweak log wording
henrymercer Dec 3, 2024
7bcf845
Record telemetry for cache operation duration
henrymercer Dec 3, 2024
4a7b2d6
Merge branch 'main' into henrymercer/extract-direct-to-toolcache
henrymercer Dec 4, 2024
5d7e628
Add changelog note
henrymercer Dec 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Record telemetry for cache operation duration
  • Loading branch information
@henrymercer
henrymercer committed Dec 3, 2024
commit 7bcf845de9909d8a0ff1e1021a933551089e84d1
9 changes: 7 additions & 2 deletions lib/setup-codeql.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion lib/setup-codeql.js.map
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion lib/tools-download.js.map
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 7 additions & 2 deletions src/setup-codeql.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -550,7 +550,7 @@ export const downloadCodeQL = async function (
? toolcacheInfo.path
: getTempExtractionDir(tempDir);

const statusReport = await downloadAndExtract(
let statusReport = await downloadAndExtract(
codeqlURL,
extractedBundlePath,
authorization,
Expand Down Expand Up @@ -585,11 +585,16 @@ export const downloadCodeQL = async function (
toolcacheInfo.version,
);

const cacheDurationMs = performance.now() - toolcacheStart;
logger.info(
`Added CodeQL bundle to the tool cache (${formatDuration(
performance.now() - toolcacheStart,
cacheDurationMs,
)}).`,
);
statusReport = {
...statusReport,
cacheDurationMs,
};

// Defensive check: we expect `cacheDir` to copy the bundle to a new location.
if (codeqlFolder !== extractedBundlePath) {
Expand Down
1 change: 1 addition & 0 deletions src/tools-download.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ type ToolsDownloadDurations =
| StreamedToolsDownloadDurations;

export type ToolsDownloadStatusReport = {
cacheDurationMs?: number;
compressionMethod: tar.CompressionMethod;
toolsUrl: string;
zstdFailureReason?: string;
Expand Down