mirror of
https://github.com/actions/setup-java.git
synced 2024-12-25 08:22:16 -05:00
08e4e813b8
* implement a core logic to cache dependnecies * integrate the cache logic to entry points * add a user doc about the dependency cache feature * reflect changes to the dist dir * add a prefix to the cache key https://github.com/actions/setup-java/pull/193/files#r669521434 * test: extract build.gradle to a file in __tests__ dir * run the restore e2e test on the specified OS * add an e2e test for maven * fix the dependency among workflows * stabilize the cache on the Windows in e2e test * add .gitignore files to __tests__/cache directories * try to run restore after the authentication * use the key in state to save caches in the post process * suggest users to run without daemon if fail to save Gradle cache on Windows * add missing description in the README.md * run clean-up tasks in serial * Add validation for post step (#3) * work on fixing cache post step * fix tests * Update src/cleanup-java.ts Co-authored-by: Konrad Pabjan <konradpabjan@github.com> * Update src/cache.ts Co-authored-by: Konrad Pabjan <konradpabjan@github.com> * style: put the name of input to the constants.ts * format: run `npm run build` to reflect changes to the dist dir * chore: update licensed files by `licensed cache` it still has three errors as follows: >* setup-java.npm.sax > filename: /Users/kengo/GitHub/setup-java/.licenses/npm/sax.dep.yml > - license needs review: other > >* setup-java.npm.tslib-1.14.1 > filename: /Users/kengo/GitHub/setup-java/.licenses/npm/tslib-1.14.1.dep.yml > - license needs review: 0bsd > >* setup-java.npm.tslib-2.3.0 > filename: /Users/kengo/GitHub/setup-java/.licenses/npm/tslib-2.3.0.dep.yml > - license needs review: 0bsd * fix: rerun ncc on macOS with node v12 * build: follow the suggestion at PR page https://github.com/actions/setup-java/pull/193#issuecomment-901839546 * fix: throw error in case of no package manager file found Co-authored-by: Dmitry Shibanov <dmitry-shibanov@github.com> Co-authored-by: Konrad Pabjan <konradpabjan@github.com>
134 lines
4.8 KiB
TypeScript
134 lines
4.8 KiB
TypeScript
/**
|
|
* @fileoverview this file provides methods handling dependency cache
|
|
*/
|
|
|
|
import { join } from 'path';
|
|
import os from 'os';
|
|
import * as cache from '@actions/cache';
|
|
import * as core from '@actions/core';
|
|
import * as glob from '@actions/glob';
|
|
|
|
const STATE_CACHE_PRIMARY_KEY = 'cache-primary-key';
|
|
const CACHE_MATCHED_KEY = 'cache-matched-key';
|
|
const CACHE_KEY_PREFIX = 'setup-java';
|
|
|
|
interface PackageManager {
|
|
id: 'maven' | 'gradle';
|
|
/**
|
|
* Paths of the file that specify the files to cache.
|
|
*/
|
|
path: string[];
|
|
pattern: string[];
|
|
}
|
|
const supportedPackageManager: PackageManager[] = [
|
|
{
|
|
id: 'maven',
|
|
path: [join(os.homedir(), '.m2', 'repository')],
|
|
// https://github.com/actions/cache/blob/0638051e9af2c23d10bb70fa9beffcad6cff9ce3/examples.md#java---maven
|
|
pattern: ['**/pom.xml']
|
|
},
|
|
{
|
|
id: 'gradle',
|
|
path: [join(os.homedir(), '.gradle', 'caches'), join(os.homedir(), '.gradle', 'wrapper')],
|
|
// https://github.com/actions/cache/blob/0638051e9af2c23d10bb70fa9beffcad6cff9ce3/examples.md#java---gradle
|
|
pattern: ['**/*.gradle*', '**/gradle-wrapper.properties']
|
|
}
|
|
];
|
|
|
|
function findPackageManager(id: string): PackageManager {
|
|
const packageManager = supportedPackageManager.find(packageManager => packageManager.id === id);
|
|
if (packageManager === undefined) {
|
|
throw new Error(`unknown package manager specified: ${id}`);
|
|
}
|
|
return packageManager;
|
|
}
|
|
|
|
/**
|
|
* A function that generates a cache key to use.
|
|
* Format of the generated key will be "${{ platform }}-${{ id }}-${{ fileHash }}"".
|
|
* If there is no file matched to {@link PackageManager.path}, the generated key ends with a dash (-).
|
|
* @see {@link https://docs.github.com/en/actions/guides/caching-dependencies-to-speed-up-workflows#matching-a-cache-key|spec of cache key}
|
|
*/
|
|
async function computeCacheKey(packageManager: PackageManager) {
|
|
const hash = await glob.hashFiles(packageManager.pattern.join('\n'));
|
|
return `${CACHE_KEY_PREFIX}-${process.env['RUNNER_OS']}-${packageManager.id}-${hash}`;
|
|
}
|
|
|
|
/**
|
|
* Restore the dependency cache
|
|
* @param id ID of the package manager, should be "maven" or "gradle"
|
|
*/
|
|
export async function restore(id: string) {
|
|
const packageManager = findPackageManager(id);
|
|
const primaryKey = await computeCacheKey(packageManager);
|
|
|
|
core.debug(`primary key is ${primaryKey}`);
|
|
core.saveState(STATE_CACHE_PRIMARY_KEY, primaryKey);
|
|
if (primaryKey.endsWith('-')) {
|
|
throw new Error(
|
|
`No file in ${process.cwd()} matched to [${
|
|
packageManager.pattern
|
|
}], make sure you have checked out the target repository`
|
|
);
|
|
}
|
|
|
|
const matchedKey = await cache.restoreCache(packageManager.path, primaryKey, [
|
|
`${CACHE_KEY_PREFIX}-${process.env['RUNNER_OS']}-${id}`
|
|
]);
|
|
if (matchedKey) {
|
|
core.saveState(CACHE_MATCHED_KEY, matchedKey);
|
|
core.info(`Cache restored from key: ${matchedKey}`);
|
|
} else {
|
|
core.info(`${packageManager.id} cache is not found`);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Save the dependency cache
|
|
* @param id ID of the package manager, should be "maven" or "gradle"
|
|
*/
|
|
export async function save(id: string) {
|
|
const packageManager = findPackageManager(id);
|
|
const matchedKey = core.getState(CACHE_MATCHED_KEY);
|
|
|
|
// Inputs are re-evaluted before the post action, so we want the original key used for restore
|
|
const primaryKey = core.getState(STATE_CACHE_PRIMARY_KEY);
|
|
|
|
if (!primaryKey) {
|
|
core.warning('Error retrieving key from state.');
|
|
return;
|
|
} else if (matchedKey === primaryKey) {
|
|
// no change in target directories
|
|
core.info(`Cache hit occurred on the primary key ${primaryKey}, not saving cache.`);
|
|
return;
|
|
}
|
|
try {
|
|
await cache.saveCache(packageManager.path, primaryKey);
|
|
core.info(`Cache saved with the key: ${primaryKey}`);
|
|
} catch (error) {
|
|
if (error.name === cache.ReserveCacheError.name) {
|
|
core.info(error.message);
|
|
} else {
|
|
if (isProbablyGradleDaemonProblem(packageManager, error)) {
|
|
core.warning(
|
|
'Failed to save Gradle cache on Windows. If tar.exe reported "Permission denied", try to run Gradle with `--no-daemon` option. Refer to https://github.com/actions/cache/issues/454 for details.'
|
|
);
|
|
}
|
|
throw error;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param packageManager the specified package manager by user
|
|
* @param error the error thrown by the saveCache
|
|
* @returns true if the given error seems related to the {@link https://github.com/actions/cache/issues/454|running Gradle Daemon issue}.
|
|
* @see {@link https://github.com/actions/cache/issues/454#issuecomment-840493935|why --no-daemon is necessary}
|
|
*/
|
|
function isProbablyGradleDaemonProblem(packageManager: PackageManager, error: Error) {
|
|
if (packageManager.id !== 'gradle' || process.env['RUNNER_OS'] !== 'Windows') {
|
|
return false;
|
|
}
|
|
const message = error.message || '';
|
|
return message.startsWith('Tar failed with error: ');
|
|
}
|