Add dependencyCachingEnabled to Config

lib/config-utils.js

@@ -213,7 +213,7 @@ async function getRawLanguages(languagesInput, repository, logger) {
 /**
  * Get the default config for when the user has not supplied one.
  */
-async function getDefaultConfig({ languagesInput, queriesInput, packsInput, buildModeInput, dbLocation, trapCachingEnabled, debugMode, debugArtifactName, debugDatabaseName, repository, tempDir, codeql, githubVersion, features, logger, }) {
+async function getDefaultConfig({ languagesInput, queriesInput, packsInput, buildModeInput, dbLocation, trapCachingEnabled, dependencyCachingEnabled, debugMode, debugArtifactName, debugDatabaseName, repository, tempDir, codeql, githubVersion, features, logger, }) {
     const languages = await getLanguages(codeql, languagesInput, repository, logger);
     const buildMode = await parseBuildModeInput(buildModeInput, languages, features, logger);
     const augmentationProperties = calculateAugmentation(packsInput, queriesInput, languages);
@@ -232,6 +232,7 @@ async function getDefaultConfig({ languagesInput, queriesInput, packsInput, buil
         augmentationProperties,
         trapCaches,
         trapCacheDownloadTime,
+        dependencyCachingEnabled,
     };
 }
 async function downloadCacheWithTime(trapCachingEnabled, codeQL, languages, logger) {
@@ -247,7 +248,7 @@ async function downloadCacheWithTime(trapCachingEnabled, codeQL, languages, logg
 /**
  * Load the config from the given file.
  */
-async function loadConfig({ languagesInput, queriesInput, packsInput, buildModeInput, configFile, dbLocation, trapCachingEnabled, debugMode, debugArtifactName, debugDatabaseName, repository, tempDir, codeql, workspacePath, githubVersion, apiDetails, features, logger, }) {
+async function loadConfig({ languagesInput, queriesInput, packsInput, buildModeInput, configFile, dbLocation, trapCachingEnabled, dependencyCachingEnabled, debugMode, debugArtifactName, debugDatabaseName, repository, tempDir, codeql, workspacePath, githubVersion, apiDetails, features, logger, }) {
     let parsedYAML;
     if (isLocal(configFile)) {
         if (configFile !== userConfigFromActionPath(tempDir)) {
@@ -281,6 +282,7 @@ async function loadConfig({ languagesInput, queriesInput, packsInput, buildModeI
         augmentationProperties,
         trapCaches,
         trapCacheDownloadTime,
+        dependencyCachingEnabled,
     };
 }
 /**

lib/config-utils.test.js

@@ -53,6 +53,7 @@ function createTestInitConfigInputs(overrides) {
         configInput: undefined,
         buildModeInput: undefined,
         trapCachingEnabled: false,
+        dependencyCachingEnabled: false,
         debugMode: false,
         debugArtifactName: "",
         debugDatabaseName: "",
@@ -286,6 +287,7 @@ function mockListLanguages(languages) {
             augmentationProperties: configUtils.defaultAugmentationProperties,
             trapCaches: {},
             trapCacheDownloadTime: 0,
+            dependencyCachingEnabled: false,
         };
         const languagesInput = "javascript";
         const configFilePath = createConfigFile(inputFileContents, tempDir);

lib/init-action.js

@@ -181,6 +181,7 @@ async function run() {
             dbLocation: (0, actions_util_1.getOptionalInput)("db-location"),
             configInput: (0, actions_util_1.getOptionalInput)("config"),
             trapCachingEnabled: getTrapCachingEnabled(),
+            dependencyCachingEnabled: getDependencyCachingEnabled(),
             // Debug mode is enabled if:
             // - The `init` Action is passed `debug: true`.
             // - Actions step debugging is enabled (e.g. by [enabling debug logging for a rerun](https://docs.github.com/en/actions/managing-workflow-runs/re-running-workflows-and-jobs#re-running-all-the-jobs-in-a-workflow),
@@ -411,6 +412,27 @@ async function recordZstdAvailability(config, zstdAvailability) {
         },
     }));
 }
+/** Determines whether we are running in default setup. */
+function isDefaultSetup() {
+    // This is set to something in default setup runs.
+    // TODO: replace with something better, if there's something.
+    return process.env["CODE_SCANNING_WORKFLOW_FILE"] !== undefined;
+}
+/** Determines whether dependency caching is enabled. */
+function getDependencyCachingEnabled() {
+    // If the workflow specified something always respect that
+    const dependencyCaching = (0, actions_util_1.getOptionalInput)("dependency-caching");
+    if (dependencyCaching !== undefined)
+        return dependencyCaching === "true";
+    // On self-hosted runners which may have dependencies installed centrally, disable caching by default
+    if (!(0, util_1.isHostedRunner)())
+        return false;
+    // Disable in advanced workflows by default.
+    if (!isDefaultSetup())
+        return false;
+    // On hosted runners, enable dependency caching by default
+    return true;
+}
 async function runWrapper() {
     try {
         await run();

lib/testing-utils.js

@@ -271,6 +271,7 @@ function createTestConfig(overrides) {
         },
         trapCaches: {},
         trapCacheDownloadTime: 0,
+        dependencyCachingEnabled: false,
     }, overrides);
 }
 //# sourceMappingURL=testing-utils.js.map

src/config-utils.test.ts

@@ -52,6 +52,7 @@ function createTestInitConfigInputs(
       configInput: undefined,
       buildModeInput: undefined,
       trapCachingEnabled: false,
+      dependencyCachingEnabled: false,
       debugMode: false,
       debugArtifactName: "",
       debugDatabaseName: "",
@@ -347,6 +348,7 @@ test("load non-empty input", async (t) => {
       augmentationProperties: configUtils.defaultAugmentationProperties,
       trapCaches: {},
       trapCacheDownloadTime: 0,
+      dependencyCachingEnabled: false,
     };
 
     const languagesInput = "javascript";

src/config-utils.ts

@@ -136,6 +136,9 @@ export interface Config {
    * Time taken to download TRAP caches. Used for status reporting.
    */
   trapCacheDownloadTime: number;
+
+  /** A value indicating whether dependency caching is enabled. */
+  dependencyCachingEnabled: boolean;
 }
 
 /**
@@ -393,6 +396,7 @@ export interface InitConfigInputs {
   configInput: string | undefined;
   buildModeInput: string | undefined;
   trapCachingEnabled: boolean;
+  dependencyCachingEnabled: boolean;
   debugMode: boolean;
   debugArtifactName: string;
   debugDatabaseName: string;
@@ -425,6 +429,7 @@ export async function getDefaultConfig({
   buildModeInput,
   dbLocation,
   trapCachingEnabled,
+  dependencyCachingEnabled,
   debugMode,
   debugArtifactName,
   debugDatabaseName,
@@ -476,6 +481,7 @@ export async function getDefaultConfig({
     augmentationProperties,
     trapCaches,
     trapCacheDownloadTime,
+    dependencyCachingEnabled,
   };
 }
 
@@ -509,6 +515,7 @@ async function loadConfig({
   configFile,
   dbLocation,
   trapCachingEnabled,
+  dependencyCachingEnabled,
   debugMode,
   debugArtifactName,
   debugDatabaseName,
@@ -580,6 +587,7 @@ async function loadConfig({
     augmentationProperties,
     trapCaches,
     trapCacheDownloadTime,
+    dependencyCachingEnabled,
   };
 }
 

src/init-action.ts

@@ -339,6 +339,7 @@ async function run() {
         dbLocation: getOptionalInput("db-location"),
         configInput: getOptionalInput("config"),
         trapCachingEnabled: getTrapCachingEnabled(),
+        dependencyCachingEnabled: getDependencyCachingEnabled(),
         // Debug mode is enabled if:
         // - The `init` Action is passed `debug: true`.
         // - Actions step debugging is enabled (e.g. by [enabling debug logging for a rerun](https://docs.github.com/en/actions/managing-workflow-runs/re-running-workflows-and-jobs#re-running-all-the-jobs-in-a-workflow),
@@ -716,6 +717,29 @@ async function recordZstdAvailability(
   );
 }
 
+/** Determines whether we are running in default setup. */
+function isDefaultSetup(): boolean {
+  // This is set to something in default setup runs.
+  // TODO: replace with something better, if there's something.
+  return process.env["CODE_SCANNING_WORKFLOW_FILE"] !== undefined;
+}
+
+/** Determines whether dependency caching is enabled. */
+function getDependencyCachingEnabled(): boolean {
+  // If the workflow specified something always respect that
+  const dependencyCaching = getOptionalInput("dependency-caching");
+  if (dependencyCaching !== undefined) return dependencyCaching === "true";
+
+  // On self-hosted runners which may have dependencies installed centrally, disable caching by default
+  if (!isHostedRunner()) return false;
+
+  // Disable in advanced workflows by default.
+  if (!isDefaultSetup()) return false;
+
+  // On hosted runners, enable dependency caching by default
+  return true;
+}
+
 async function runWrapper() {
   try {
     await run();

src/testing-utils.ts

@@ -331,6 +331,7 @@ export function createTestConfig(overrides: Partial<Config>): Config {
       },
       trapCaches: {},
       trapCacheDownloadTime: 0,
+      dependencyCachingEnabled: false,
     },
     overrides,
   );