1.4.0

fixes #50

.github/workflows/selftest.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  selftest:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    name: Test Action on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          profile: minimal
+          override: true
+
+      - uses: ./
+        with:
+          cache-on-failure: true
+
+      - run: |
+          cargo install cargo-deny --locked
+          cargo check
+          cargo test

.gitignore

@@ -1 +1,2 @@
 node_modules
+/target

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 1.4.0
+
+- Clean both `debug` and `release` target directories.
+
+## 1.3.0
+
+- Use Rust toolchain file as additional cache key.
+- Allow for a configurable target-dir.
+
+## 1.2.0
+
+- Cache `~/.cargo/bin`.
+- Support for custom `$CARGO_HOME`.
+- Add a `cache-hit` output.
+- Add a new `sharedKey` option that overrides the automatic job-name based key.
+
 ## 1.1.0
 
 - Add a new `working-directory` input.

Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+publish = false
+name = "rust-cache"
+version = "0.1.0"
+authors = ["Arpad Borsos <arpad.borsos@googlemail.com>"]
+edition = "2018"
+
+[dev-dependencies]
+reqwest = "0.11.0"
+actix-web = { git = "https://github.com/actix/actix-web.git", rev = "bd26083f333ecf63e3eb444748250364ce124f5e" }

LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

README.md

@@ -6,6 +6,8 @@ sensible defaults.
 ## Example usage
 
 ```yaml
+- uses: actions/checkout@v2
+
 # selecting a toolchain either by action or manual `rustup` calls should happen
 # before the plugin, as it uses the current rustc version as its cache key
 - uses: actions-rs/toolchain@v1
@@ -21,32 +23,78 @@ sensible defaults.
 : `key`
 An optional key that is added to the automatic cache key.
 
+: `sharedKey`
+An additional key that is stable over multiple jobs.
+
 : `working-directory`
 The working directory the action operates in, is case the cargo project is not
 located in the repo root.
 
+: `target-dir`
+The target directory that should be cleaned and persisted, defaults to `./target`.
+
+: `cache-on-failure`
+Cache even if the build fails, defaults to false
+
+## Outputs
+
+: `cache-hit`
+
+This is a boolean flag that will be set to `true` when there was an exact cache hit.
+
+## Cache Effectiveness
+
+This action only caches the _dependencies_ of a crate, so is more effective if
+the dependency / own code ratio is higher.
+
+It is also most effective for repositories with a `Cargo.lock` file. Library
+repositories with only a `Cargo.toml` file have limited benefits, as cargo will
+_always_ use the most up-to-date dependency versions, which may not be cached.
+
+Usage with Stable Rust is most effective, as a cache is tied to the Rust version.
+Using it with Nightly Rust is less effective as it will throw away the cache every day.
+
+## Versioning
+
+I use the `v1` branch similar to `master` development, so if you want to have
+a more stable experience, please use a fixed revision or tag.
+
 ## Cache Details
 
-The cache currently caches the following directories:
+This action currently caches the following files/directories:
 
+- `~/.cargo/bin`
 - `~/.cargo/registry/index`
 - `~/.cargo/registry/cache`
 - `~/.cargo/git`
+- `~/.cargo/.crates.toml`
+- `~/.cargo/.crates2.json`
 - `./target`
 
 This cache is automatically keyed by:
 
-- the github `job`,
+- the github [`job_id`](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_id),
 - the rustc release / host / hash, and
-- a hash of the `Cargo.lock` / `Cargo.toml` files.
+- a hash of all `Cargo.lock` / `Cargo.toml` files found anywhere in the repository (if present).
+- a hash of all `rust-toolchain` / `rust-toolchain.toml` files in the root of the repository (if present).
 
 An additional input `key` can be provided if the builtin keys are not sufficient.
 
-Before persisting, the cache is cleaned of intermediate artifacts and
+Before being persisted, the cache is cleaned of:
-anything that is not a workspace dependency.
+- Any files in `~/.cargo/bin` that were present before the action ran (for example `rustc`).
-In particular, no caching of workspace crates will be done. For
+- Dependencies that are no longer used.
-this reason, this action will automatically set `CARGO_INCREMENTAL=0` to
+- Anything that is not a dependency.
-disable incremental compilation.
+- Incremental build artifacts.
+- Any build artifacts with an `mtime` older than one week.
+
+In particular, the workspace crates themselves are not cached since doing so is
+[generally not effective](https://github.com/Swatinem/rust-cache/issues/37#issuecomment-944697938).
+For this reason, this action automatically sets `CARGO_INCREMENTAL=0` to disable
+incremental compilation, so that the Rust compiler doesn't waste time creating
+the additional artifacts required for incremental builds.
+
+The `~/.cargo/registry/src` directory is not cached since it is quicker for Cargo
+to recreate it from the compressed crate archives in `~/.cargo/registry/cache`.
 
 The action will try to restore from a previous `Cargo.lock` version as well, so
 lockfile updates should only re-build changed dependencies.
@@ -55,3 +103,9 @@ Additionally, the action automatically works around
 [cargo#8603](https://github.com/rust-lang/cargo/issues/8603) /
 [actions/cache#403](https://github.com/actions/cache/issues/403) which would
 otherwise corrupt the cache on macOS builds.
+
+## Known issues
+
+- The cache cleaning process currently only runs against the build artifacts under
+  `./target/debug/`, so projects using release or cross-compiled builds will experience
+  larger cache sizes.

action.yml

@@ -5,14 +5,26 @@ inputs:
   key:
     description: "An additional key for the cache"
     required: false
+  sharedKey:
+    description: "An additional cache key that is stable over multiple jobs"
+    required: false
   working-directory:
     description: "The working directory this action should operate in"
     required: false
+  target-dir:
+    description: "The target dir that should be cleaned and persisted, defaults to `./target`"
+    required: false
+  cache-on-failure:
+    description: "Cache even if the build fails. Defaults to false"
+    required: false
+outputs:
+  cache-hit:
+    description: "A boolean value that indicates an exact match was found"
 runs:
   using: "node12"
   main: "dist/restore/index.js"
   post: "dist/save/index.js"
-  post-if: "success()"
+  post-if: "success() || env.CACHE_ON_FAILURE == 'true'"
 branding:
   icon: "archive"
   color: "gray-dark"

package.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "rust-cache",
-  "version": "1.1.0",
+  "version": "1.4.0",
   "description": "A GitHub Action that implements smart caching for rust/cargo projects with sensible defaults.",
   "keywords": [
     "actions",
@@ -22,15 +22,15 @@
   },
   "homepage": "https://github.com/Swatinem/rust-cache#readme",
   "dependencies": {
-    "@actions/cache": "^1.0.4",
+    "@actions/cache": "^2.0.2",
-    "@actions/core": "^1.2.6",
+    "@actions/core": "^1.6.0",
-    "@actions/exec": "^1.0.4",
+    "@actions/exec": "^1.1.1",
-    "@actions/glob": "^0.1.1",
+    "@actions/glob": "^0.2.1",
-    "@actions/io": "^1.0.2"
+    "@actions/io": "^1.1.2"
   },
   "devDependencies": {
-    "@vercel/ncc": "^0.25.1",
+    "@vercel/ncc": "^0.33.3",
-    "typescript": "^4.1.2"
+    "typescript": "4.6.3"
   },
   "scripts": {
     "prepare": "ncc build --target es2020 -o dist/restore src/restore.ts && ncc build --target es2020 -o dist/save src/save.ts"

src/common.ts

@@ -9,22 +9,30 @@ import path from "path";
 
 process.on("uncaughtException", (e) => {
   core.info(`[warning] ${e.message}`);
+  if (e.stack) {
+    core.info(e.stack);
+  }
 });
 
 const cwd = core.getInput("working-directory");
+// TODO: this could be read from .cargo config file directly
+const targetDir = core.getInput("target-dir") || "./target";
 if (cwd) {
   process.chdir(cwd);
 }
 
+export const stateBins = "RUST_CACHE_BINS";
 export const stateKey = "RUST_CACHE_KEY";
 const stateHash = "RUST_CACHE_HASH";
 
 const home = os.homedir();
+const cargoHome = process.env.CARGO_HOME || path.join(home, ".cargo");
 export const paths = {
-  index: path.join(home, ".cargo/registry/index"),
+  cargoHome,
-  cache: path.join(home, ".cargo/registry/cache"),
+  index: path.join(cargoHome, "registry/index"),
-  git: path.join(home, ".cargo/git"),
+  cache: path.join(cargoHome, "registry/cache"),
-  target: "target",
+  git: path.join(cargoHome, "git"),
+  target: targetDir,
 };
 
 interface CacheConfig {
@@ -48,25 +56,55 @@ export async function getCacheConfig(): Promise<CacheConfig> {
 
   let key = `v0-rust-`;
 
-  let inputKey = core.getInput("key");
+  const sharedKey = core.getInput("sharedKey");
-  if (inputKey) {
+  if (sharedKey) {
-    key += `${inputKey}-`;
+    key += `${sharedKey}-`;
-  }
+  } else {
+    const inputKey = core.getInput("key");
+    if (inputKey) {
+      key += `${inputKey}-`;
+    }
 
-  const job = process.env.GITHUB_JOB;
+    const job = process.env.GITHUB_JOB;
-  if (job) {
+    if (job) {
-    key += `${job}-`;
+      key += `${job}-`;
+    }
   }
 
   key += await getRustKey();
 
   return {
-    paths: [paths.index, paths.cache, paths.git, paths.target],
+    paths: [
+      path.join(cargoHome, "bin"),
+      path.join(cargoHome, ".crates2.json"),
+      path.join(cargoHome, ".crates.toml"),
+      paths.git,
+      paths.cache,
+      paths.index,
+      paths.target,
+    ],
     key: `${key}-${lockHash}`,
     restoreKeys: [key],
   };
 }
 
+export async function getCargoBins(): Promise<Set<string>> {
+  try {
+    const { installs }: { installs: { [key: string]: { bins: Array<string> } } } = JSON.parse(
+      await fs.promises.readFile(path.join(paths.cargoHome, ".crates2.json"), "utf8"),
+    );
+    const bins = new Set<string>();
+    for (const pkg of Object.values(installs)) {
+      for (const bin of pkg.bins) {
+        bins.add(bin);
+      }
+    }
+    return bins;
+  } catch {
+    return new Set<string>();
+  }
+}
+
 async function getRustKey(): Promise<string> {
   const rustc = await getRustVersion();
   return `${rustc.release}-${rustc.host}-${rustc["commit-hash"].slice(0, 12)}`;
@@ -107,7 +145,9 @@ export async function getCmdOutput(
 }
 
 async function getLockfileHash(): Promise<string> {
-  const globber = await glob.create("**/Cargo.toml\n**/Cargo.lock", { followSymbolicLinks: false });
+  const globber = await glob.create("**/Cargo.toml\n**/Cargo.lock\nrust-toolchain\nrust-toolchain.toml", {
+    followSymbolicLinks: false,
+  });
   const files = await globber.glob();
   files.sort((a, b) => a.localeCompare(b));
 
@@ -151,13 +191,25 @@ export async function getPackages(): Promise<Packages> {
 }
 
 export async function cleanTarget(packages: Packages) {
-  await fs.promises.unlink("./target/.rustc_info.json");
+  await fs.promises.unlink(path.join(targetDir, "./.rustc_info.json"));
-  await io.rmRF("./target/debug/examples");
+
-  await io.rmRF("./target/debug/incremental");
+  await cleanProfileTarget(packages, "debug");
+  await cleanProfileTarget(packages, "release");
+}
+
+async function cleanProfileTarget(packages: Packages, profile: string) {
+  try {
+    await fs.promises.access(path.join(targetDir, profile));
+  } catch {
+    return;
+  }
+
+  await io.rmRF(path.join(targetDir, profile, "./examples"));
+  await io.rmRF(path.join(targetDir, profile, "./incremental"));
 
   let dir: fs.Dir;
-  // remove all *files* from debug
+  // remove all *files* from the profile directory
-  dir = await fs.promises.opendir("./target/debug");
+  dir = await fs.promises.opendir(path.join(targetDir, profile));
   for await (const dirent of dir) {
     if (dirent.isFile()) {
       await rm(dir.path, dirent);
@@ -165,8 +217,8 @@ export async function cleanTarget(packages: Packages) {
   }
 
   const keepPkg = new Set(packages.map((p) => p.name));
-  await rmExcept("./target/debug/build", keepPkg);
+  await rmExcept(path.join(targetDir, profile, "./build"), keepPkg);
-  await rmExcept("./target/debug/.fingerprint", keepPkg);
+  await rmExcept(path.join(targetDir, profile, "./.fingerprint"), keepPkg);
 
   const keepDeps = new Set(
     packages.flatMap((p) => {
@@ -178,7 +230,7 @@ export async function cleanTarget(packages: Packages) {
       return names;
     }),
   );
-  await rmExcept("./target/debug/deps", keepDeps);
+  await rmExcept(path.join(targetDir, profile, "./deps"), keepDeps);
 }
 
 const oneWeek = 7 * 24 * 3600 * 1000;

src/main.rs

@@ -0,0 +1,3 @@
+fn main() {
+    println!("Hello, world!");
+}

src/restore.ts

@@ -1,14 +1,28 @@
 import * as cache from "@actions/cache";
 import * as core from "@actions/core";
-import { cleanTarget, getCacheConfig, getPackages, stateKey } from "./common";
+import { cleanTarget, getCacheConfig, getCargoBins, getPackages, stateBins, stateKey } from "./common";
 
 async function run() {
+  if (!cache.isFeatureAvailable()) {
+    setCacheHitOutput(false);
+    return;
+  }
+
   try {
+    var cacheOnFailure = core.getInput("cache-on-failure").toLowerCase();
+    if (cacheOnFailure !== "true") {
+      cacheOnFailure = "false";
+    }
+    core.exportVariable("CACHE_ON_FAILURE", cacheOnFailure);
     core.exportVariable("CARGO_INCREMENTAL", 0);
 
     const { paths, key, restoreKeys } = await getCacheConfig();
 
+    const bins = await getCargoBins();
+    core.saveState(stateBins, JSON.stringify([...bins]));
+
     core.info(`Restoring paths:\n    ${paths.join("\n    ")}`);
+    core.info(`In directory:\n    ${process.cwd()}`);
     core.info(`Using keys:\n    ${[key, ...restoreKeys].join("\n    ")}`);
     const restoreKey = await cache.restoreCache(paths, key, restoreKeys);
     if (restoreKey) {
@@ -21,12 +35,22 @@ async function run() {
 
         await cleanTarget(packages);
       }
+
+      setCacheHitOutput(restoreKey === key);
     } else {
       core.info("No cache found.");
+
+      setCacheHitOutput(false);
     }
   } catch (e) {
-    core.info(`[warning] ${e.message}`);
+    setCacheHitOutput(false);
+
+    core.info(`[warning] ${(e as any).message}`);
   }
 }
 
+function setCacheHitOutput(cacheHit: boolean): void {
+  core.setOutput("cache-hit", cacheHit.toString());
+}
+
 run();

src/save.ts

@@ -5,9 +5,23 @@ import * as glob from "@actions/glob";
 import * as io from "@actions/io";
 import fs from "fs";
 import path from "path";
-import { cleanTarget, getCacheConfig, getPackages, Packages, paths, rm, stateKey } from "./common";
+import {
+  cleanTarget,
+  getCacheConfig,
+  getCargoBins,
+  getPackages,
+  Packages,
+  paths,
+  rm,
+  stateBins,
+  stateKey,
+} from "./common";
 
 async function run() {
+  if (!cache.isFeatureAvailable()) {
+    return;
+  }
+
   try {
     const { paths: savePaths, key } = await getCacheConfig();
 
@@ -26,6 +40,10 @@ async function run() {
       await cleanRegistry(registryName, packages);
     } catch {}
 
+    try {
+      await cleanBin();
+    } catch {}
+
     try {
       await cleanGit(packages);
     } catch {}
@@ -35,10 +53,11 @@ async function run() {
     } catch {}
 
     core.info(`Saving paths:\n    ${savePaths.join("\n    ")}`);
-    core.info(`Using key "${key}".`);
+    core.info(`In directory:\n    ${process.cwd()}`);
+    core.info(`Using key:\n    ${key}`);
     await cache.saveCache(savePaths, key);
   } catch (e) {
-    core.info(`[warning] ${e.message}`);
+    core.info(`[warning] ${(e as any).message}`);
   }
 }
 
@@ -55,6 +74,22 @@ async function getRegistryName(): Promise<string> {
   return path.basename(path.dirname(first));
 }
 
+async function cleanBin() {
+  const bins = await getCargoBins();
+  const oldBins = JSON.parse(core.getState(stateBins));
+
+  for (const bin of oldBins) {
+    bins.delete(bin);
+  }
+
+  const dir = await fs.promises.opendir(path.join(paths.cargoHome, "bin"));
+  for await (const dirent of dir) {
+    if (dirent.isFile() && !bins.has(dirent.name)) {
+      await rm(dir.path, dirent);
+    }
+  }
+}
+
 async function cleanRegistry(registryName: string, packages: Packages) {
   await io.rmRF(path.join(paths.index, registryName, ".cache"));