Put TRAP cache cleanup behind a feature flag

github · May 23, 2024 · 6ccd563 · 6ccd563
1 parent 4f2b182
commit 6ccd563
Show file tree

Hide file tree

Showing 9 changed files with 35 additions and 6 deletions.
diff --git a/lib/analyze-action.js b/lib/analyze-action.js
diff --git a/lib/analyze-action.js.map b/lib/analyze-action.js.map
diff --git a/lib/feature-flags.js b/lib/feature-flags.js
diff --git a/lib/feature-flags.js.map b/lib/feature-flags.js.map
diff --git a/lib/trap-caching.js b/lib/trap-caching.js
diff --git a/lib/trap-caching.js.map b/lib/trap-caching.js.map
diff --git a/src/analyze-action.ts b/src/analyze-action.ts
@@ -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,
+    );
 
     // We don't upload results in test mode, so don't wait for processing
     if (util.isInTestMode()) {

diff --git a/src/feature-flags.ts b/src/feature-flags.ts
@@ -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",
@@ -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",

diff --git a/src/trap-caching.ts b/src/trap-caching.ts
@@ -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";
@@ -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))) {
+    return {
+      trap_cache_cleanup_skipped_because: "feature disabled",
+    };
+  }
   if (!(await actionsUtil.isAnalyzingDefaultBranch())) {
     return {
       trap_cache_cleanup_skipped_because: "not analyzing default branch",