8000 Automatically clean up old TRAP caches by henrymercer · Pull Request #2306 · github/codeql-action · GitHub
[go: up one dir, main page]
Skip to content

Automatically clean up old TRAP caches #2306

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
merged 14 commits into from
May 24, 2024
Merged

Automatically clean up old TRAP caches #2306

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
cc96c82
List matching Actions caches
henrymercer May 21, 2024
087f0b0
Restrict TRAP cache cleanup to analyzed language
henrymercer May 21, 2024
4fd6c0d
Look at ref rather than default branch
henrymercer May 21, 2024
0b42149
Invoke cleanup in `analyze` Action
henrymercer May 21, 2024
1bea17f
Log key and ref for which we're retrieving caches
henrymercer May 21, 2024
898dead
Use automatic pagination mapping function
henrymercer May 21, 2024
610e722
Clean up old TRAP caches
henrymercer May 21, 2024
59af9fc
Add specific error for lacking `actions:write` permission
henrymercer May 22, 2024
4f2b182
Add telemetry for TRAP cache cleanup
henrymercer May 22, 2024
6ccd563
Put TRAP cache cleanup behind a feature flag
henrymercer May 22, 2024
f7f7192
Add unit test for cleanup
henrymercer May 23, 2024
fdba1f9
Improve log message when there's nothing to clean up
henrymercer May 23, 2024
9983853
Add changelog note
henrymercer May 23, 2024
f629cb3
Add some comments to explain test case
henrymercer May 24, 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
Put TRAP cache cleanup behind a feature flag
  • Loading branch information
@henrymercer
henrymercer committed May 23, 2024
commit 6ccd5631d811c84fd41304a746443149a9ce67ad
2 changes: 1 addition & 1 deletion lib/analyze-action.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/analyze-action.js.map
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions lib/feature-flags.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/feature-flags.js.map
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 7 additions & 1 deletion lib/trap-caching.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/trap-caching.js.map
View file
Open in desktop

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

6 changes: 5 additions & 1 deletion src/analyze-action.ts
View file
Open in desktop
< 8000 td class="blob-code blob-code-context js-file-line"> // We don't upload results in test mode, so don't wait for processing
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,11 @@ async function run() {
trapCacheUploadTime = performance.now() - trapCacheUploadStartTime;

// Clean up TRAP caches
trapCacheCleanupTelemetry = await cleanupTrapCaches(config, logger);
trapCacheCleanupTelemetry = await cleanupTrapCaches(
config,
features,
logger,
);

if (util.isInTestMode()) {
Expand Down
6 changes: 6 additions & 0 deletions src/feature-flags.ts
View file
Open in desktop
8000
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ export interface FeatureEnablement {
*/
export enum Feature {
AutobuildDirectTracing = "autobuild_direct_tracing",
CleanupTrapCaches = "cleanup_trap_caches",
CppDependencyInstallation = "cpp_dependency_installation_enabled",
CppTrapCachingEnabled = "cpp_trap_caching_enabled",
DisableJavaBuildlessEnabled = "disable_java_buildless_enabled",
Expand Down Expand Up @@ -91,6 +92,11 @@ export const featureConfig: Record<
minimumVersion: undefined,
toolsFeature: ToolsFeature.TraceCommandUseBuildMode,
},
[Feature.CleanupTrapCaches]: {
defaultValue: false,
envVar: "CODEQL_ACTION_CLEANUP_TRAP_CACHES",
minimumVersion: undefined,
},
[Feature.CppDependencyInstallation]: {
defaultValue: false,
envVar: "CODEQL_EXTRACTOR_CPP_AUTOINSTALL_DEPENDENCIES",
Expand Down
7 changes: 7 additions & 0 deletions src/trap-caching.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import * as actionsUtil from "./actions-util";
import * as apiClient from "./api-client";
import { CodeQL } from "./codeql";
import type { Config } from "./config-utils";
import { Feature, FeatureEnablement } from "./feature-flags";
import { Language } from "./languages";
import { Logger } from "./logging";
import { isHTTPError, tryGetFolderBytes, withTimeout, wrapError } from "./util";
Expand Down Expand Up @@ -169,8 +170,14 @@ export interface TrapCacheCleanupStatusReport {

export async function cleanupTrapCaches(
config: Config,
features: FeatureEnablement,
logger: Logger,
): Promise<TrapCacheCleanupStatusReport> {
if (!(await features.getValue(Feature.CleanupTrapCaches))) {
4F0A return {
trap_cache_cleanup_skipped_because: "feature disabled",
};
}
if (!(await actionsUtil.isAnalyzingDefaultBranch())) {
return {
trap_cache_cleanup_skipped_because: "not analyzing default branch",
Expand Down
0