Report overall cache usage for CodeQL dependency caches

Author: mbg

lib/init-action-post.js

@@ -214,7 +214,7 @@ export interface ActionsCacheItem {
 /** List all Actions cache entries matching the provided key and ref. */
 export async function listActionsCaches(
   key: string,
-  ref: string,
+  ref?: string,
 ): Promise<ActionsCacheItem[]> {
   const repositoryNwo = getRepositoryNwo();
 

src/api-client.ts

@@ -5,12 +5,13 @@ import * as actionsCache from "@actions/cache";
 import * as glob from "@actions/glob";
 
 import { getTemporaryDirectory } from "./actions-util";
+import { listActionsCaches } from "./api-client";
 import { getTotalCacheSize } from "./caching-utils";
 import { Config } from "./config-utils";
 import { EnvVar } from "./environment";
 import { KnownLanguage, Language } from "./languages";
 import { Logger } from "./logging";
-import { getRequiredEnvParam } from "./util";
+import { getErrorMessage, getRequiredEnvParam } from "./util";
 
 /**
  * Caching configuration for a particular language.
@@ -344,3 +345,34 @@ async function cachePrefix(
 
   return `${prefix}-${CODEQL_DEPENDENCY_CACHE_VERSION}-${runnerOs}-${language}-`;
 }
+
+/** Represents information about our overall cache usage for CodeQL dependency caches. */
+export interface DependencyCachingUsageReport {
+  count: number;
+  size_bytes: number;
+}
+
+/**
+ * Tries to determine the overall cache usage for CodeQL dependencies caches.
+ *
+ * @param logger The logger to log errors to.
+ * @returns Returns the overall cache usage for CodeQL dependencies caches, or `undefined` if we couldn't determine it.
+ */
+export async function getDependencyCacheUsage(
+  logger: Logger,
+): Promise<DependencyCachingUsageReport | undefined> {
+  try {
+    const caches = await listActionsCaches(CODEQL_DEPENDENCY_CACHE_PREFIX);
+    const totalSize = caches.reduce(
+      (acc, cache) => acc + (cache.size_in_bytes ?? 0),
+      0,
+    );
+    return { count: caches.length, size_bytes: totalSize };
+  } catch (err) {
+    logger.warning(
+      `Unable to retrieve information about dependency cache usage: ${getErrorMessage(err)}`,
+    );
+  }
+
+  return undefined;
+}

src/dependency-caching.ts

@@ -45,6 +45,10 @@ export interface JobStatusReport {
   job_status: JobStatus;
 }
 
+export interface DependencyCachingUsageReport {
+  dependency_caching_usage?: string;
+}
+
 function createFailedUploadFailedSarifResult(
   error: unknown,
 ): UploadFailedSarifResult {

src/init-action-post-helper.ts

@@ -12,10 +12,16 @@ import {
   printDebugLogs,
 } from "./actions-util";
 import { getGitHubVersion } from "./api-client";
+import { CachingKind } from "./caching-utils";
 import { getCodeQL } from "./codeql";
 import { Config, getConfig } from "./config-utils";
 import * as debugArtifacts from "./debug-artifacts";
+import {
+  DependencyCachingUsageReport,
+  getDependencyCacheUsage,
+} from "./dependency-caching";
 import { Features } from "./feature-flags";
+import * as gitUtils from "./git-utils";
 import * as initActionPostHelper from "./init-action-post-helper";
 import { getActionsLogger } from "./logging";
 import { getRepositoryNwo } from "./repository";
@@ -32,7 +38,8 @@ import { checkDiskUsage, checkGitHubVersionInRange, wrapError } from "./util";
 interface InitPostStatusReport
   extends StatusReportBase,
     initActionPostHelper.UploadFailedSarifResult,
-    initActionPostHelper.JobStatusReport {}
+    initActionPostHelper.JobStatusReport,
+    initActionPostHelper.DependencyCachingUsageReport {}
 
 async function runWrapper() {
   const logger = getActionsLogger();
@@ -41,6 +48,7 @@ async function runWrapper() {
   let uploadFailedSarifResult:
     | initActionPostHelper.UploadFailedSarifResult
     | undefined;
+  let dependencyCachingUsage: DependencyCachingUsageReport | undefined;
   try {
     // Restore inputs from `init` Action.
     restoreInputs();
@@ -73,6 +81,17 @@ async function runWrapper() {
         features,
         logger,
       );
+
+      // If we are analysing the default branch and some kind of caching is enabled,
+      // then try to determine our overall cache usage for dependency caches. We only
+      // do this under these circumstances to avoid slowing down analyses for PRs
+      // and where caching may not be enabled.
+      if (
+        (await gitUtils.isAnalyzingDefaultBranch()) &&
+        config.dependencyCachingEnabled !== CachingKind.None
+      ) {
+        dependencyCachingUsage = await getDependencyCacheUsage(logger);
+      }
     }
   } catch (unwrappedError) {
     const error = wrapError(unwrappedError);
@@ -109,6 +128,7 @@ async function runWrapper() {
       ...statusReportBase,
       ...uploadFailedSarifResult,
       job_status: initActionPostHelper.getFinalJobStatus(),
+      dependency_caching_usage: JSON.stringify(dependencyCachingUsage ?? {}),
     };
     logger.info("Sending status report for init-post step.");
     await sendStatusReport(statusReport);