Add conditional JDK caching (#1201)

* Add JDK caching Cache resolved JDK tool-cache entries by exact platform and release identity, with a default-on cache-jdk input and explicit opt-out. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Apply batched suggestions from code review Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * Fix JDK cache CI validation Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Update brace-expansion security fix Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Refresh brace-expansion license metadata Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Refine JDK cache semantics Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Refine JDK cache documentation Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Simplify JDK cache identity Use one normalized runner OS dimension, reset the internal cache key schema for the unreleased feature, and align documentation, tests, and bundles. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Align JDK cache OS identity Use the established RUNNER_OS value directly and retain process.platform only as a non-Actions fallback. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Harden JDK cache saves and document tool-cache reuse Bind each JDK cache key to the installation identity it was computed for, keep post-job saves best-effort per entry, and state the real reuse and verification guarantee in the documentation. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * docs: restructure README caching section Rename '## Caching dependencies' to '## Caching' and add a what-gets-cached overview table covering the dependency, wrapper, and JDK caches. Lead with the common 'cache: maven' example and the dependency-cache material, and demote JDK caching into its own subsection. Also corrects the IMPORTANT callout, which implied JDK caching required an explicit opt-in; it is enabled implicitly whenever 'cache' is set. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * docs: fix caching documentation defects - Remove pull-request framing that compared behavior to `main`; state the tool-cache and `jdkfile` behavior directly and unconditionally. - Clarify that the JDK cache is a separate cache *entry* from the dependency and wrapper caches, while its *enablement* is coupled to `cache`, so the opening paragraph agrees with the enablement matrix. - Cite the actions/setup-java-benchmarks repository instead of an open PR and a self-referential PR comment, keeping the measured figures and caveats. - Keep the `cache`/`cache-jdk` matrix only in docs/advanced-usage.md and summarize the rules in prose in README.md to avoid divergence. - Describe the guarantee that a cache key is only saved with the installation it was computed for, instead of documenting inode/size/timestamp internals. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * docs: add V6 what's new entry for JDK caching Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: e2755464-4e83-47b6-ba71-731bb481b418 --------- Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Copilot-Session: e2755464-4e83-47b6-ba71-731bb481b418
2026-09-07 03:15:20 +02:00 · 2026-08-04 21:54:10 -04:00
parent 7a9a8b1dcc
commit 955f34f16f
26 changed files with 2756 additions and 827 deletions
@@ -12,6 +12,9 @@ import {
 } from '../base-models.js';
 import {extractJdkFile} from '../../util.js';
 import {MACOS_JAVA_CONTENT_POSTFIX} from '../../constants.js';
+import {createReadStream} from 'fs';
+import {createHash} from 'crypto';
+import type {JdkCache} from '../../jdk-cache.js';

 export class LocalDistribution extends JavaBase {
  constructor(
@@ -27,6 +30,11 @@ export class LocalDistribution extends JavaBase {
        "The 'latest' version alias is not supported for the 'jdkfile' distribution. Please specify a concrete version."
      );
    }
+    if (this.verifySignature) {
+      throw new Error(
+        `Input 'verify-signature' is not supported for distribution '${this.distribution}'.`
+      );
+    }

    let foundJava = this.forceDownload ? null : this.findInToolcache();

@@ -46,24 +54,60 @@ export class LocalDistribution extends JavaBase {
        throw new Error(`JDK file was not found in path '${jdkFilePath}'`);
      }

-      core.info(`Extracting Java from '${jdkFilePath}'`);
+      let jdkCache: JdkCache | undefined;
+      if (this.cacheJdk) {
+        const [{getJdkVerificationIdentity}, source] = await Promise.all([
+          import('../../jdk-cache.js'),
+          hashFile(jdkFilePath)
+        ]);
+        jdkCache = {
+          distribution: this.distribution,
+          packageType: this.packageType,
+          architecture: this.architecture,
+          version: this.version,
+          source,
+          verification: getJdkVerificationIdentity(false),
+          path: this.getJdkCachePath(this.version)
+        };
+      }
+      if (!this.forceDownload && jdkCache) {
+        const {restoreJdk} = await import('../../jdk-cache.js');
+        const restored = await restoreJdk(jdkCache);
+        const restoredPath = restored
+          ? this.getRestoredJdkPath(this.version)
+          : undefined;
+        if (restoredPath) {
+          foundJava = {
+            version: this.version,
+            path: restoredPath
+          };
+        }
+      }

-      const extractedJavaPath = await extractJdkFile(jdkFilePath);
-      const archiveName = fs.readdirSync(extractedJavaPath)[0];
-      const archivePath = path.join(extractedJavaPath, archiveName);
-      const javaVersion = this.version;
+      if (!foundJava) {
+        core.info(`Extracting Java from '${jdkFilePath}'`);

-      const javaPath = await tc.cacheDir(
-        archivePath,
-        this.toolcacheFolderName,
-        this.getToolcacheVersionName(javaVersion),
-        this.architecture
-      );
+        const extractedJavaPath = await extractJdkFile(jdkFilePath);
+        const archiveName = fs.readdirSync(extractedJavaPath)[0];
+        const archivePath = path.join(extractedJavaPath, archiveName);
+        const javaVersion = this.version;

-      foundJava = {
-        version: javaVersion,
-        path: javaPath
-      };
+        const javaPath = await tc.cacheDir(
+          archivePath,
+          this.toolcacheFolderName,
+          this.getToolcacheVersionName(javaVersion),
+          this.architecture
+        );
+
+        foundJava = {
+          version: javaVersion,
+          path: javaPath
+        };
+        if (jdkCache) {
+          const {registerJdk} = await import('../../jdk-cache.js');
+          registerJdk(jdkCache);
+        }
+      }
    }

    // JDK folder may contain postfix "Contents/Home" on macOS
@@ -103,3 +147,11 @@ export class LocalDistribution extends JavaBase {
    );
  }
 }
+
+async function hashFile(file: string): Promise<string> {
+  const hash = createHash('sha256');
+  for await (const chunk of createReadStream(file)) {
+    hash.update(chunk);
+  }
+  return hash.digest('hex');
+}