import * as core from '@actions/core' import * as cache from '@actions/cache' import * as exec from '@actions/exec' import * as crypto from 'crypto' import * as path from 'path' import * as fs from 'fs' import {CacheEntryListener} from './cache-reporting' const SEGMENT_DOWNLOAD_TIMEOUT_VAR = 'SEGMENT_DOWNLOAD_TIMEOUT_MINS' const SEGMENT_DOWNLOAD_TIMEOUT_DEFAULT = 10 * 60 * 1000 // 10 minutes export function isCacheDebuggingEnabled(): boolean { if (core.isDebug()) { return true } return process.env['GRADLE_BUILD_ACTION_CACHE_DEBUG_ENABLED'] ? true : false } export function hashFileNames(fileNames: string[]): string { return hashStrings(fileNames.map(x => x.replace(new RegExp(`\\${path.sep}`, 'g'), '/'))) } export function hashStrings(values: string[]): string { const hash = crypto.createHash('md5') for (const value of values) { hash.update(value) } return hash.digest('hex') } export async function restoreCache( cachePath: string[], cacheKey: string, cacheRestoreKeys: string[], listener: CacheEntryListener ): Promise { listener.markRequested(cacheKey, cacheRestoreKeys) try { // Only override the read timeout if the SEGMENT_DOWNLOAD_TIMEOUT_MINS env var has NOT been set const cacheRestoreOptions = process.env[SEGMENT_DOWNLOAD_TIMEOUT_VAR] ? {} : {segmentTimeoutInMs: SEGMENT_DOWNLOAD_TIMEOUT_DEFAULT} const restoredEntry = await cache.restoreCache(cachePath, cacheKey, cacheRestoreKeys, cacheRestoreOptions) if (restoredEntry !== undefined) { listener.markRestored(restoredEntry.key, restoredEntry.size) } return restoredEntry } catch (error) { listener.markNotRestored((error as Error).message) handleCacheFailure(error, `Failed to restore ${cacheKey}`) return undefined } } export async function saveCache(cachePath: string[], cacheKey: string, listener: CacheEntryListener): Promise { try { const savedEntry = await cache.saveCache(cachePath, cacheKey) listener.markSaved(savedEntry.key, savedEntry.size) } catch (error) { if (error instanceof cache.ReserveCacheError) { listener.markAlreadyExists(cacheKey) } else { listener.markNotSaved((error as Error).message) } handleCacheFailure(error, `Failed to save cache entry with path '${cachePath}' and key: ${cacheKey}`) } } export function cacheDebug(message: string): void { if (isCacheDebuggingEnabled()) { core.info(message) } else { core.debug(message) } } export function handleCacheFailure(error: unknown, message: string): void { if (error instanceof cache.ValidationError) { // Fail on cache validation errors throw error } if (error instanceof cache.ReserveCacheError) { // Reserve cache errors are expected if the artifact has been previously cached core.info(`${message}: ${error}`) } else { // Warn on all other errors core.warning(`${message}: ${error}`) if (error instanceof Error && error.stack) { cacheDebug(error.stack) } } } /** * Attempt to delete a file or directory, waiting to allow locks to be released */ export async function tryDelete(file: string): Promise { const maxAttempts = 5 for (let attempt = 1; attempt <= maxAttempts; attempt++) { if (!fs.existsSync(file)) { return } try { const stat = fs.lstatSync(file) if (stat.isDirectory()) { fs.rmSync(file, {recursive: true}) } else { fs.unlinkSync(file) } return } catch (error) { if (attempt === maxAttempts) { core.warning(`Failed to delete ${file}, which will impact caching. It is likely locked by another process. Output of 'jps -ml': ${await getJavaProcesses()}`) throw error } else { cacheDebug(`Attempt to delete ${file} failed. Will try again.`) await delay(1000) } } } } async function delay(ms: number): Promise { return new Promise(resolve => setTimeout(resolve, ms)) } async function getJavaProcesses(): Promise { const jpsOutput = await exec.getExecOutput('jps', ['-lm']) return jpsOutput.stdout }