Implement built-in cache support

README.md

@@ -1,6 +1,6 @@
 # Install Scarb
 
-Sets up [Scarb] in your GitHub Actions workflow.
+Sets up [Scarb] in your GitHub Actions workflow supporting caching out of the box.
 
 ## Example workflow
 

action.yml

@@ -15,4 +15,6 @@ outputs:
     description: The version of the installed Scarb
 runs:
   using: "node16"
-  main: "dist/index.js"
+  main: "dist/setup/index.js"
+  post: "dist/cache-save/index.js"
+  post-if: success()

lib/cache-restore.js

@@ -0,0 +1,25 @@
+import * as core from "@actions/core";
+import * as cache from "@actions/cache";
+
+import fs from "fs/promises";
+
+import { getCacheDirectory, getCacheKey, State } from "./cache-utils";
+
+export async function restoreCache() {
+  const cacheDir = getCacheDirectory();
+  await fs.mkdir(cacheDir, { recursive: true });
+
+  core.info(`Restoring Scarb cache into ${cacheDir}`);
+
+  const primaryKey = await getCacheKey();
+  core.info(`Cache primary key is ${primaryKey}`);
+  core.saveState(State.CachePrimaryKey, primaryKey);
+
+  const matchedKey = await cache.restoreCache([cacheDir], primaryKey);
+  if (!matchedKey) {
+    core.info(`Cache entry not found`);
+    return;
+  }
+
+  core.saveState(State.CacheMatchedKey, matchedKey);
+}

lib/cache-save.js

@@ -0,0 +1,21 @@
+import * as core from "@actions/core";
+import * as cache from "@actions/cache";
+
+import { getCacheDirectory, State } from "./cache-utils";
+
+async function saveCache() {
+  try {
+    const primaryKey = core.getState(State.CachePrimaryKey);
+    const matchedKey = core.getState(State.CacheMatchedKey);
+
+    if (primaryKey !== matchedKey) {
+      await cache.saveCache([getCacheDirectory()], primaryKey);
+    } else {
+      core.info(`Cache hit occurred, not saving cache`);
+    }
+  } catch (e) {
+    core.error(e);
+  }
+}
+
+saveCache();

lib/cache-utils.js

@@ -0,0 +1,49 @@
+import * as exec from "@actions/exec";
+import * as glob from "@actions/glob";
+
+import os from "os";
+import path from "path";
+
+export const State = {
+  CachePrimaryKey: "primary_key",
+  CacheMatchedKey: "matched_key",
+};
+
+export function getCacheDirectory() {
+  const platform = os.platform();
+  const home = process.env.HOME;
+
+  switch (platform) {
+    case "linux":
+      return path.join(home, ".cache/scarb");
+    case "darwin":
+      return path.join(home, `Library/Caches/com.swmansion.Scarb`);
+    case "win32":
+      return path.join(process.env.APPDATA, "swmansion/Scarb/config");
+    default:
+      throw new Error(`Caching not available for ${platform} platform`);
+  }
+}
+
+export async function getCacheKey() {
+  const platform = process.env.RUNNER_OS;
+  const fileHash = await glob.hashFiles(await getScarbManifestPath());
+
+  if (!fileHash) {
+    throw new Error(
+      "Unable to hash Scarb.toml file, cannot cache dependencies.",
+    );
+  }
+
+  return `scarb-cache-${platform}-${fileHash}`.toLowerCase();
+}
+
+async function getScarbManifestPath() {
+  const { stdout, exitCode } = await exec.getExecOutput("scarb manifest-path");
+
+  if (exitCode > 0) {
+    throw new Error("Unable to resolve Scarb.toml path");
+  }
+
+  return stdout.trim();
+}

lib/main.js

@@ -4,6 +4,7 @@ import * as tc from "@actions/tool-cache";
 import { determineVersion } from "./versions";
 import { downloadScarb } from "./download";
 import { getOsTriplet } from "./platform";
+import { restoreCache } from "./cache-restore";
 
 const REPO = "software-mansion/scarb";
 
@@ -30,6 +31,14 @@ export default async function main() {
       core.setOutput("scarb-version", scarbVersion);
       core.addPath(path.join(scarbPrefix, "bin"));
     });
+
+    await restoreCache().catch((e) => {
+      core.error(
+        `There was an error when restoring cache: ${
+          e instanceof Error ? e.message : e
+        }`,
+      );
+    });
   } catch (e) {
     core.setFailed(e);
   }