new: Add .cargo/target caching. (#2)

src/cargo.ts

@@ -0,0 +1,120 @@
+/* eslint-disable node/no-unsupported-features/node-builtins */
+
+import crypto from 'crypto';
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+import * as cache from '@actions/cache';
+import * as core from '@actions/core';
+import * as exec from '@actions/exec';
+import * as glob from '@actions/glob';
+
+// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
+export const CARGO_HOME = process.env.CARGO_HOME || path.join(os.homedir(), '.cargo');
+
+export const CACHE_ENABLED = core.getBooleanInput('cache') || cache.isFeatureAvailable();
+
+let CACHE_KEY = '';
+
+export async function getPrimaryCacheKey() {
+	if (CACHE_KEY) {
+		return CACHE_KEY;
+	}
+
+	core.info('Generating cache key');
+
+	const rustVersion = core.getState('rust-version');
+
+	core.debug(`Hashing Rust version = ${rustVersion}`);
+
+	const rustHash = core.getState('rust-hash');
+
+	core.debug(`Hashing Rust commit hash = ${rustHash}`);
+
+	const lockHash = await glob.hashFiles('Cargo.lock');
+
+	core.debug(`Hashing Cargo.lock = ${lockHash}`);
+
+	const hasher = crypto.createHash('sha1');
+	hasher.update(rustVersion);
+	hasher.update(rustHash);
+	hasher.update(lockHash);
+
+	// eslint-disable-next-line require-atomic-updates
+	CACHE_KEY = `setup-rustcargo-${process.platform}-${hasher.digest('hex')}`;
+
+	return CACHE_KEY;
+}
+
+export function getPathsToCache(): string[] {
+	return [
+		// ~/.cargo/registry
+		path.join(CARGO_HOME, 'registry'),
+		// /workspace/target/debug
+		path.join(process.cwd(), 'target/debug'),
+	];
+}
+
+export async function cleanCargoRegistry() {
+	core.info('Cleaning cache before saving');
+
+	const registryDir = path.join(CARGO_HOME, 'registry');
+
+	// .cargo/registry/src - Delete entirely
+	await exec.exec('cargo', ['cache', '--autoclean']);
+
+	// .cargo/registry/index - Delete .cache directories
+	const globber = await glob.create(path.join(registryDir, 'index/**/.cache'));
+
+	for await (const file of globber.globGenerator()) {
+		core.debug(`Deleting ${file}`);
+		await fs.promises.unlink(file);
+	}
+
+	// .cargo/registry/cache - Do nothing?
+}
+
+export async function saveCache() {
+	if (!CACHE_ENABLED) {
+		return;
+	}
+
+	const primaryKey = await getPrimaryCacheKey();
+	const cacheHitKey = core.getState('cache-hit-key');
+
+	if (cacheHitKey === primaryKey) {
+		core.info(`Cache hit occured on the key ${cacheHitKey}, not saving cache`);
+		return;
+	}
+
+	await cleanCargoRegistry();
+
+	core.info(`Saving cache with key ${primaryKey}`);
+
+	await cache.saveCache(getPathsToCache(), primaryKey);
+}
+
+export async function restoreCache() {
+	if (!CACHE_ENABLED) {
+		return;
+	}
+
+	core.info('Attempting to restore cache');
+
+	const primaryKey = await getPrimaryCacheKey();
+
+	const cacheKey = await cache.restoreCache(getPathsToCache(), primaryKey, [
+		`setup-rustcargo-${process.platform}`,
+		'setup-rustcargo',
+	]);
+
+	if (cacheKey) {
+		core.saveState('cache-hit-key', cacheKey);
+		core.info(`Cache restored using key ${primaryKey}`);
+	} else {
+		core.warning(`Cache does not exist using key ${primaryKey}`);
+	}
+
+	core.setOutput('cache-key', cacheKey ?? primaryKey);
+	core.setOutput('cache-hit', !!cacheKey);
+}

src/rust.ts

@@ -0,0 +1,31 @@
+import * as core from '@actions/core';
+import * as exec from '@actions/exec';
+
+export async function extractRustVersion(toolchain: string) {
+	let out = '';
+
+	await exec.exec('rustc', [`+${toolchain}`, '--version', '--verbose'], {
+		listeners: {
+			stdout(data: Buffer) {
+				out += data.toString();
+			},
+		},
+	});
+
+	out.split('\n').forEach((line) => {
+		let key = '';
+
+		if (line.startsWith('commit-hash')) {
+			key = 'rust-hash';
+		} else if (line.startsWith('release')) {
+			key = 'rust-version';
+		} else {
+			return;
+		}
+
+		const value = line.split(':')[1].trim();
+
+		core.saveState(key, value);
+		core.setOutput(key, value);
+	});
+}