Add bare-bones dependency caching functions

2024-07-22 15:29:56 +01:00 · 2024-07-22 15:29:56 +01:00 · 2b7af49a3d
commit 2b7af49a3d
parent 51d90f48a6
3 changed files with 271 additions and 0 deletions
--- a/lib/dependency-caching.js
+++ b/lib/dependency-caching.js
@ -0,0 +1,125 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.downloadDependencyCaches = downloadDependencyCaches;
+exports.uploadDependencyCaches = uploadDependencyCaches;
+const os = __importStar(require("os"));
+const path_1 = require("path");
+const actionsCache = __importStar(require("@actions/cache"));
+const glob = __importStar(require("@actions/glob"));
+const caching_utils_1 = require("./caching-utils");
+const util_1 = require("./util");
+const CODEQL_DEPENDENCY_CACHE_PREFIX = "codeql-dependencies";
+const CODEQL_DEPENDENCY_CACHE_VERSION = 1;
+const CODEQL_DEFAULT_CACHE_CONFIG = {
+    java: {
+        paths: [
+            // Maven
+            (0, path_1.join)(os.homedir(), ".m2", "repository"),
+            // Gradle
+            (0, path_1.join)(os.homedir(), ".gradle", "caches"),
+        ],
+        hash: [
+            // Maven
+            "**/pom.xml",
+            // Gradle
+            "**/*.gradle*",
+            "**/gradle-wrapper.properties",
+            "buildSrc/**/Versions.kt",
+            "buildSrc/**/Dependencies.kt",
+            "gradle/*.versions.toml",
+            "**/versions.properties",
+        ],
+    },
+};
+/**
+ * Attempts to restore dependency caches for the languages being analyzed.
+ *
+ * @param languages The languages being analyzed.
+ * @param logger A logger to record some informational messages to.
+ * @returns A list of languages for which dependency caches were restored.
+ */
+async function downloadDependencyCaches(languages, logger) {
+    const restoredCaches = [];
+    for (const language of languages) {
+        const cacheConfig = CODEQL_DEFAULT_CACHE_CONFIG[language];
+        if (cacheConfig === undefined) {
+            logger.info(`Skipping download of dependency cache for ${language} as we have no caching configuration for it.`);
+            continue;
+        }
+        const primaryKey = await cacheKey(language, cacheConfig);
+        const restoreKeys = [await cachePrefix(language)];
+        logger.info(`Downloading cache for ${language} with key ${primaryKey} and restore keys ${restoreKeys.join(", ")}`);
+        const hitKey = await actionsCache.restoreCache(cacheConfig.paths, primaryKey, restoreKeys);
+        if (hitKey !== undefined) {
+            logger.info(`Cache hit on key ${hitKey} for ${language}.`);
+            restoredCaches.push(language);
+        }
+    }
+    return restoredCaches;
+}
+/**
+ * Attempts to store caches for the languages that were analyzed.
+ *
+ * @param config The configuration for this workflow.
+ * @param logger A logger to record some informational messages to.
+ */
+async function uploadDependencyCaches(config, logger) {
+    for (const language of config.languages) {
+        const cacheConfig = CODEQL_DEFAULT_CACHE_CONFIG[language];
+        if (cacheConfig === undefined) {
+            logger.info(`Skipping upload of dependency cache for ${language} as we have no caching configuration for it.`);
+            continue;
+        }
+        const globber = await glob.create(cacheConfig.hash.join("\n"));
+        const size = await (0, caching_utils_1.getTotalCacheSize)(await globber.glob(), logger);
+        const key = await cacheKey(language, cacheConfig);
+        logger.info(`Uploading cache of size ${size} for ${language} with key ${key}`);
+        await actionsCache.saveCache(cacheConfig.paths, key);
+    }
+}
+/**
+ * Computes a cache key for the specified language.
+ *
+ * @param language The language being analyzed.
+ * @param cacheConfig The cache configuration for the language.
+ * @returns A cache key capturing information about the project(s) being analyzed in the specified language.
+ */
+async function cacheKey(language, cacheConfig) {
+    const hash = await glob.hashFiles(cacheConfig.hash.join("\n"));
+    return `${await cachePrefix(language)}${hash}`;
+}
+/**
+ * Constructs a prefix for the cache key, comprised of a CodeQL-specific prefix, a version number that
+ * can be changed to invalidate old caches, the runner's operating system, and the specified language name.
+ *
+ * @param language The language being analyzed.
+ * @returns The prefix that identifies what a cache is for.
+ */
+async function cachePrefix(language) {
+    const runnerOs = (0, util_1.getRequiredEnvParam)("RUNNER_OS");
+    return `${CODEQL_DEPENDENCY_CACHE_PREFIX}-${CODEQL_DEPENDENCY_CACHE_VERSION}-${runnerOs}-${language}-`;
+}
+//# sourceMappingURL=dependency-caching.js.map