Merge pull request #646 from ocaml/fix-windows-cache

Author: smorimoto

CHANGELOG.md

@@ -8,11 +8,15 @@ and this project adheres to
 
 ## [unreleased]
 
+### Fixed
+
+- Speed up caching and get rid of bugs and hacks on Windows.
+
 ## [2.0.9]
 
 ### Fixed
 
-- Take the sandbox option value into account when computing the cache key
+- Take the sandbox option value into account when computing the cache key.
 
 ## [2.0.8]
 

dist/index.js

@@ -14,7 +14,7 @@
     "build": "npm-run-all -p 'build:**'"
   },
   "dependencies": {
-    "@actions/cache": "3.0.6",
+    "@actions/cache": "3.1.4",
     "@actions/core": "1.10.0",
     "@actions/exec": "1.1.1",
     "@actions/github": "5.1.1",
@@ -23,17 +23,17 @@
     "@actions/io": "1.1.2",
     "@actions/tool-cache": "2.0.1",
     "cheerio": "1.0.0-rc.12",
-    "core-js": "3.27.2",
+    "core-js": "3.28.0",
     "date-fns": "2.29.3",
     "semver": "7.3.8",
     "yaml": "2.2.1"
   },
   "devDependencies": {
     "@tsconfig/strictest": "1.0.2",
-    "@types/node": "18.13.0",
+    "@types/node": "18.14.0",
     "@types/semver": "7.3.13",
-    "@typescript-eslint/eslint-plugin": "5.51.0",
-    "@typescript-eslint/parser": "5.51.0",
+    "@typescript-eslint/eslint-plugin": "5.53.0",
+    "@typescript-eslint/parser": "5.53.0",
     "@vercel/ncc": "0.36.1",
     "eslint": "8.34.0",
     "eslint-config-prettier": "8.6.0",

dist/post/index.js

@@ -70,26 +70,9 @@ export async function installer(): Promise<void> {
     core.exportVariable("MSYS", "winsymlinks:native");
   }
   if (platform === Platform.Win32) {
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    const originalPath = process.env["PATH"]!.split(path.delimiter);
-    const msys64Path = path.join("C:", "msys64", "usr", "bin");
-    const patchedPath = [msys64Path, ...originalPath];
-    process.env["PATH"] = patchedPath.join(path.delimiter);
     await restoreCygwinCache();
-    process.env["PATH"] = originalPath.join(path.delimiter);
-  }
-  let opamCacheHit;
-  if (platform === Platform.Win32) {
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    const originalPath = process.env["PATH"]!.split(path.delimiter);
-    const msys64Path = path.join("C:", "msys64", "usr", "bin");
-    const patchedPath = [msys64Path, ...originalPath];
-    process.env["PATH"] = patchedPath.join(path.delimiter);
-    opamCacheHit = await restoreOpamCache();
-    process.env["PATH"] = originalPath.join(path.delimiter);
-  } else {
-    opamCacheHit = await restoreOpamCache();
   }
+  const opamCacheHit = await restoreOpamCache();
   await setupOpam();
   await repositoryRemoveAll();
   await repositoryAddAll(OPAM_REPOSITORIES);
@@ -100,44 +83,14 @@ export async function installer(): Promise<void> {
         : `ocaml-base-compiler.${await resolveVersion(OCAML_COMPILER)}`
       : OCAML_COMPILER;
     await installOcaml(ocamlCompiler);
-    if (platform === Platform.Win32) {
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-      const originalPath = process.env["PATH"]!.split(path.delimiter);
-      const msys64Path = path.join("C:", "msys64", "usr", "bin");
-      const patchedPath = [msys64Path, ...originalPath];
-      process.env["PATH"] = patchedPath.join(path.delimiter);
-      await saveOpamCache();
-      process.env["PATH"] = originalPath.join(path.delimiter);
-    } else {
-      await saveOpamCache();
-    }
-  }
-  if (platform === Platform.Win32) {
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    const originalPath = process.env["PATH"]!.split(path.delimiter);
-    const msys64Path = path.join("C:", "msys64", "usr", "bin");
-    const patchedPath = [msys64Path, ...originalPath];
-    process.env["PATH"] = patchedPath.join(path.delimiter);
-    await restoreOpamDownloadCache();
-    process.env["PATH"] = originalPath.join(path.delimiter);
-  } else {
-    await restoreOpamDownloadCache();
+    await saveOpamCache();
   }
+  await restoreOpamDownloadCache();
   if (OPAM_DEPEXT) {
     await installDepext(platform);
   }
   if (DUNE_CACHE) {
-    if (platform === Platform.Win32) {
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-      const originalPath = process.env["PATH"]!.split(path.delimiter);
-      const msys64Path = path.join("C:", "msys64", "usr", "bin");
-      const patchedPath = [msys64Path, ...originalPath];
-      process.env["PATH"] = patchedPath.join(path.delimiter);
-      await restoreDuneCache();
-      process.env["PATH"] = originalPath.join(path.delimiter);
-    } else {
-      await restoreDuneCache();
-    }
+    await restoreDuneCache();
     await installDune();
     core.exportVariable("DUNE_CACHE", "enabled");
     core.exportVariable("DUNE_CACHE_TRANSPORT", "direct");

lint-fmt/index.js

@@ -212,11 +212,9 @@ async function acquireOpamWindows() {
   const cachedPath = tc.find("opam", opamVersion);
   if (cachedPath === "") {
     const downloadedPath = await tc.downloadTool(
-      `https://github.com/fdopen/opam-repository-mingw/releases/download/${opamVersion}/opam64.tar.xz`
+      `https://github.com/fdopen/opam-repository-mingw/releases/download/${opamVersion}/opam64.zip`
     );
-    const extractedPath = await tc.extractTar(downloadedPath, undefined, [
-      "xv",
-    ]);
+    const extractedPath = await tc.extractZip(downloadedPath);
     const cachedPath = await tc.cacheDir(extractedPath, "opam", opamVersion);
     const installSh = path.join(cachedPath, "opam64", "install.sh");
     await fs.chmod(installSh, 0o755);
@@ -257,11 +255,11 @@ async function setupOpamWindows() {
   core.addPath(CYGWIN_ROOT_WRAPPERBIN);
   await setupCygwin();
   core.endGroup();
+  await saveCygwinCache();
   // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
   const originalPath = process.env["PATH"]!.split(path.delimiter);
   const patchedPath = [CYGWIN_ROOT_BIN, ...originalPath];
   process.env["PATH"] = patchedPath.join(path.delimiter);
-  await saveCygwinCache();
   core.startGroup("Install opam");
   await acquireOpamWindows();
   core.endGroup();

package.json

@@ -1,30 +1,16 @@
-import * as path from "node:path";
-
 import * as core from "@actions/core";
 
 import { saveDuneCache, saveOpamDownloadCache } from "./cache";
-import { DUNE_CACHE, Platform } from "./constants";
+import { DUNE_CACHE } from "./constants";
 import { trimDuneCache } from "./dune";
-import { getPlatform } from "./system";
 
 async function run() {
   try {
-    const platform = getPlatform();
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    const originalPath = process.env["PATH"]!.split(path.delimiter);
-    if (platform === Platform.Win32) {
-      const msys64Path = path.join("C:", "msys64", "usr", "bin");
-      const patchedPath = [msys64Path, ...originalPath];
-      process.env["PATH"] = patchedPath.join(path.delimiter);
-    }
     if (DUNE_CACHE) {
       await trimDuneCache();
       await saveDuneCache();
     }
     await saveOpamDownloadCache();
-    if (platform === Platform.Win32) {
-      process.env["PATH"] = originalPath.join(path.delimiter);
-    }
   } catch (error) {
     if (error instanceof Error) {
       core.error(error.message);