Put TRAP cache cleanup behind a feature flag

lib/analyze-action.js

@@ -199,7 +199,7 @@ async function run() {
         didUploadTrapCaches = await (0, trap_caching_1.uploadTrapCaches)(codeql, config, logger);
         trapCacheUploadTime = perf_hooks_1.performance.now() - trapCacheUploadStartTime;
         // Clean up TRAP caches
-        trapCacheCleanupTelemetry = await (0, trap_caching_1.cleanupTrapCaches)(config, logger);
+        trapCacheCleanupTelemetry = await (0, trap_caching_1.cleanupTrapCaches)(config, features, logger);
         // We don't upload results in test mode, so don't wait for processing
         if (util.isInTestMode()) {
             logger.debug("In test mode. Waiting for processing is disabled.");

lib/feature-flags.js

@@ -50,6 +50,7 @@ exports.CODEQL_VERSION_FINE_GRAINED_PARALLELISM = "2.15.1";
 var Feature;
 (function (Feature) {
     Feature["AutobuildDirectTracing"] = "autobuild_direct_tracing";
+    Feature["CleanupTrapCaches"] = "cleanup_trap_caches";
     Feature["CppDependencyInstallation"] = "cpp_dependency_installation_enabled";
     Feature["CppTrapCachingEnabled"] = "cpp_trap_caching_enabled";
     Feature["DisableJavaBuildlessEnabled"] = "disable_java_buildless_enabled";
@@ -64,6 +65,11 @@ exports.featureConfig = {
         minimumVersion: undefined,
         toolsFeature: tools_features_1.ToolsFeature.TraceCommandUseBuildMode,
     },
+    [Feature.CleanupTrapCaches]: {
+        defaultValue: false,
+        envVar: "CODEQL_ACTION_CLEANUP_TRAP_CACHES",
+        minimumVersion: undefined,
+    },
     [Feature.CppDependencyInstallation]: {
         defaultValue: false,
         envVar: "CODEQL_EXTRACTOR_CPP_AUTOINSTALL_DEPENDENCIES",

lib/trap-caching.js

@@ -29,6 +29,7 @@ const path = __importStar(require("path"));
 const actionsCache = __importStar(require("@actions/cache"));
 const actionsUtil = __importStar(require("./actions-util"));
 const apiClient = __importStar(require("./api-client"));
+const feature_flags_1 = require("./feature-flags");
 const util_1 = require("./util");
 // This constant should be bumped if we make a breaking change
 // to how the CodeQL Action stores or retrieves the TRAP cache,
@@ -132,7 +133,12 @@ async function uploadTrapCaches(codeql, config, logger) {
     return true;
 }
 exports.uploadTrapCaches = uploadTrapCaches;
-async function cleanupTrapCaches(config, logger) {
+async function cleanupTrapCaches(config, features, logger) {
+    if (!(await features.getValue(feature_flags_1.Feature.CleanupTrapCaches))) {
+        return {
+            trap_cache_cleanup_skipped_because: "feature disabled",
+        };
+    }
     if (!(await actionsUtil.isAnalyzingDefaultBranch())) {
         return {
             trap_cache_cleanup_skipped_because: "not analyzing default branch",

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()) {

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",

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",