fix(action): copy pesde home into temp dir on windows before cache

Author: CompeyDev

README.md

@@ -34,12 +34,8 @@ A usage example as well as the default values for the accepted inputs is provide
     # undefined, defaults to either `$PESDE_HOME` or `~/.pesde`, where the tilde corresponds
     # to the home directory.
     #
-    # ****IMPORTANT****
-    # There is a caveat though: the path must be relative to `${{ github.workspace }}`,
-    # especially for Windows, due to an internal actions limitation. This applies to
-    # `$PESDE_HOME` as well. The tilde (`~`) and references to `$HOME` are automatically
-    # expanded to their respective values relative to the workspace for each of the above
-    # in order to simplify this.
+    # The tilde (`~`) and references to `$HOME` are automatically expanded to the home
+    # directory.
     home: "~/.pesde"
 
     # The base directory containing the pesde project. This is utilized to figure out the

dist/index.js

@@ -1,8 +1,8 @@
 import path, { join, basename as basename$1, dirname } from 'node:path';
-import process$1, { chdir, exit } from 'node:process';
+import process$1, { env, chdir, exit } from 'node:process';
 import require$$1$6, { stripVTControlCharacters, promisify, isDeepStrictEqual } from 'node:util';
 import { mkdir as mkdir$1, mkdtemp, rm, readFile as readFile$1, access } from 'node:fs/promises';
-import require$$1$8, { tmpdir } from 'node:os';
+import require$$1$8, { tmpdir, homedir } from 'node:os';
 import fs$1, { existsSync, appendFileSync } from 'node:fs';
 import require$$0$4 from 'util';
 import require$$0$5 from 'stream';
@@ -114628,22 +114628,23 @@ function requireCache () {
 
 var cacheExports = requireCache();
 
+var ioExports = requireIo();
+
 const tools = {
   pesde: { owner: "pesde-pkg", repo: "pesde" },
   lune: { owner: "lune-org", repo: "lune" }
 };
 const parentLogger = logging.child({ scope: "actions" });
 parentLogger.exitOnError = true;
-const PESDE_HOME = expandRelativeToWorkspace(coreExports.getInput("home") || process.env.PESDE_HOME || "~/.pesde");
-await ensureExists(PESDE_HOME);
+const PESDE_HOME = expandRelativeToWorkspace(coreExports.getInput("home") || env.PESDE_HOME || "~/.pesde");
 coreExports.exportVariable("PESDE_HOME", PESDE_HOME);
 parentLogger.info(`Discovered pesde home directory: ${PESDE_HOME}`);
 function expandRelativeToWorkspace(path) {
-  const workspaceRoot = dirname(process.env.GITHUB_WORKSPACE);
+  const homeDir = homedir();
   if (path === "~" || path.startsWith("~/")) {
-    path = path.replace(/^~(?=$|\/|\\)/, workspaceRoot);
+    path = path.replace(/^~(?=$|\/|\\)/, homeDir);
   }
-  path = path.replace(/\$HOME/g, path).replace(/\$\{HOME\}/g, path);
+  path = path.replace(/\$HOME/g, homeDir).replace(/\$\{HOME\}/g, homeDir);
   return path;
 }
 chdir(coreExports.getInput("cwd"));
@@ -114662,18 +114663,21 @@ async function setupTool(repo, version) {
   coreExports.addPath(toolPath);
 }
 const cacheLogger = parentLogger.child({ scope: "actions.cache" });
+const pesdeHome = process.platform === "win32" ? join(dirname(env.GITHUB_WORKSPACE), ".pesde-tmp") : PESDE_HOME;
+const cacheDirs = [...PESDE_PACKAGE_DIRS, pesdeHome];
 if (coreExports.getState("post") === "true") {
   if (coreExports.getState("needsCache") === "true") {
-    const toCache = [...PESDE_PACKAGE_DIRS, PESDE_HOME];
+    await ioExports.mv(PESDE_HOME, pesdeHome);
     const cacheableDirs = await Promise.all(
       // filter out dirs which do not exist and cannot be cached
-      toCache.map(async (p) => {
+      cacheDirs.map(async (p) => {
         return await access(p).then(() => p).catch(() => null);
       })
     ).then((results) => results.filter((p) => p != null));
     if (cacheableDirs.length != 0) {
       const cacheId = await cacheExports.saveCache(cacheableDirs, await cacheKey());
       coreExports.saveState("needsCache", false);
+      if (process.platform === "win32") await ioExports.rmRF(pesdeHome);
       cacheLogger.info(`Successfully cached to ${cacheId}, exiting`);
     }
   } else {
@@ -114687,12 +114691,13 @@ if (luneVersion !== "") await setupTool(tools.lune, luneVersion);
 await setupTool(tools.pesde, coreExports.getInput("version") || "latest");
 coreExports.saveState("post", true);
 if (coreExports.getBooleanInput("cache")) {
-  await cacheExports.restoreCache(PESDE_PACKAGE_DIRS, await cacheKey()).then((hit) => {
+  await cacheExports.restoreCache(cacheDirs, await cacheKey()).then(async (hit) => {
     if (!hit) {
       cacheLogger.warn("Cache miss, dispatching future post-run to save cache");
       coreExports.saveState("needsCache", true);
       return;
     }
+    await ioExports.mv(pesdeHome, PESDE_HOME);
     cacheLogger.info(`Restored cache key ${hit} successfully`);
   });
 }

src/index.ts

@@ -1,7 +1,8 @@
-import { dirname } from "node:path";
-import { chdir, exit } from "node:process";
+import { dirname, join } from "node:path";
+import { chdir, env, exit } from "node:process";
 import { isDeepStrictEqual } from "node:util";
 import { access } from "node:fs/promises";
+import { homedir } from "node:os";
 
 import { DownloadProvider } from "@/index.js";
 import logging from "@/logging/index.js";
@@ -11,7 +12,7 @@ import { cacheKey, PESDE_PACKAGE_DIRS } from "./cache.js";
 import { cacheDir, find } from "@actions/tool-cache";
 import * as core from "@actions/core";
 import * as cache from "@actions/cache";
-import { ensureExists } from "@/util.js";
+import { mv, rmRF } from "@actions/io";
 
 export type Tool = "pesde" | "lune";
 export type Repo = { owner: string; repo: string };
@@ -23,23 +24,21 @@ const tools: Record<Tool, Repo> = {
 const parentLogger = logging.child({ scope: "actions" });
 parentLogger.exitOnError = true;
 
-const PESDE_HOME = expandRelativeToWorkspace(core.getInput("home") || process.env.PESDE_HOME || "~/.pesde");
-
-await ensureExists(PESDE_HOME);
+const PESDE_HOME = expandRelativeToWorkspace(core.getInput("home") || env.PESDE_HOME || "~/.pesde");
 core.exportVariable("PESDE_HOME", PESDE_HOME);
 
 parentLogger.info(`Discovered pesde home directory: ${PESDE_HOME}`);
 
 function expandRelativeToWorkspace(path: string) {
-	const workspaceRoot = dirname(process.env.GITHUB_WORKSPACE!);
+	const homeDir = homedir();
 
 	// Expand tilde
 	if (path === "~" || path.startsWith("~/")) {
-		path = path.replace(/^~(?=$|\/|\\)/, workspaceRoot);
+		path = path.replace(/^~(?=$|\/|\\)/, homeDir);
 	}
 
 	// Expand $HOME and ${HOME}
-	path = path.replace(/\$HOME/g, path).replace(/\$\{HOME\}/g, path);
+	path = path.replace(/\$HOME/g, homeDir).replace(/\$\{HOME\}/g, homeDir);
 
 	return path;
 }
@@ -79,14 +78,22 @@ async function setupTool(repo: Repo, version: string) {
 
 const cacheLogger = parentLogger.child({ scope: "actions.cache" });
 
+// on windows, it is impossible for `saveCache` to cache unless the pesde home dir can
+// be represented relatively to the github workspace. so, we create a tempdir which can
+// be cached, and transform it during restore. on all other platforms, we just use the
+// regular pesde home
+const pesdeHome = process.platform === "win32" ? join(dirname(env.GITHUB_WORKSPACE!), ".pesde-tmp") : PESDE_HOME;
+const cacheDirs = [...PESDE_PACKAGE_DIRS, pesdeHome];
+
 if (core.getState("post") === "true") {
 	// post-run invocation, just cache or exit
 
 	if (core.getState("needsCache") === "true") {
-		const toCache = [...PESDE_PACKAGE_DIRS, PESDE_HOME];
+		await mv(PESDE_HOME, pesdeHome); // both paths are same everywhere except on windows
+
 		const cacheableDirs = await Promise.all(
 			// filter out dirs which do not exist and cannot be cached
-			toCache.map(async (p) => {
+			cacheDirs.map(async (p) => {
 				return await access(p)
 					.then(() => p)
 					.catch(() => null);
@@ -97,6 +104,9 @@ if (core.getState("post") === "true") {
 			const cacheId = await cache.saveCache(cacheableDirs, await cacheKey());
 			core.saveState("needsCache", false); // notify future runs caching isn't required
 
+			// remove only for windows, where it is a temp dir
+			if (process.platform === "win32") await rmRF(pesdeHome);
+
 			cacheLogger.info(`Successfully cached to ${cacheId}, exiting`);
 		}
 	} else {
@@ -117,13 +127,16 @@ await setupTool(tools.pesde, core.getInput("version") || "latest");
 core.saveState("post", true);
 
 if (core.getBooleanInput("cache")) {
-	await cache.restoreCache(PESDE_PACKAGE_DIRS, await cacheKey()).then((hit) => {
+	await cache.restoreCache(cacheDirs, await cacheKey()).then(async (hit) => {
 		if (!hit) {
 			cacheLogger.warn("Cache miss, dispatching future post-run to save cache");
 			core.saveState("needsCache", true); // notify future runs that they need to cache
 			return;
 		}
 
+		// move the temporary pesde home onto the expected path (windows only)
+		await mv(pesdeHome, PESDE_HOME);
+
 		cacheLogger.info(`Restored cache key ${hit} successfully`);
 	});
 }