actions/gradle-build-action
1
0
Fork 0
mirror of https://github.com/gradle/gradle-build-action.git synced 2024-11-22 08:11:07 -05:00
Code Issues Projects Releases Packages Wiki Activity

Consolidate error handling for cache restore/save

Browse source
This commit is contained in:
Daz DeBoer 2021-09-14 13:30:23 -06:00
parent bd08e7b7cd
commit decca791c5
No known key found for this signature in database
GPG key ID: DD6B9F0B06683D5D
2 changed files with 52 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
src/cache-gradle-user-home.ts
View file

@ -3,7 +3,6 @@ import fs from 'fs'
import os from 'os'
import * as core from '@actions/core'
import * as glob from '@actions/glob'
import * as cache from '@actions/cache'
import * as exec from '@actions/exec'
import {AbstractCache} from './cache-utils'
@ -72,22 +71,13 @@ export class GradleUserHomeCache extends AbstractCache {
const key = path.relative(this.getGradleUserHome(), artifactFile)
const cacheKey = `gradle-artifact-${key}`
try {
const restoreKey = await cache.restoreCache(
[artifactFile],
cacheKey
const restoreKey = await this.restoreCache([artifactFile], cacheKey)
if (restoreKey) {
this.debug(`Restored ${cacheKey} from cache to ${artifactFile}`)
} else {
this.debug(
`Failed to restore from ${cacheKey} to ${artifactFile}`
)
if (restoreKey) {
this.debug(
`Restored ${cacheKey} from cache to ${artifactFile}`
)
} else {
core.warning(
`Failed to restore from ${cacheKey} to ${artifactFile}`
)
}
} catch (error) {
core.warning(`Error restoring ${cacheKey}: ${error}`)
}
} else {
this.debug(
@ -164,21 +154,7 @@ export class GradleUserHomeCache extends AbstractCache {
const cacheKey = `gradle-artifact-${filePath}`
this.debug(`Caching ${artifactFile} with cache key: ${cacheKey}`)
try {
await cache.saveCache([artifactFile], cacheKey)
} catch (error) {
// Fail on validation errors or non-errors (the latter to keep Typescript happy)
if (error instanceof cache.ValidationError) {
throw error
} else if (error instanceof cache.ReserveCacheError) {
// These are expected if the artifact is already cached
this.debug(error.message)
} else if (error instanceof Error) {
core.warning(error.message)
} else {
core.warning(`${error}`)
}
}
await this.saveCache([artifactFile], cacheKey)
// Write the marker file that will stand in place of the original
fs.writeFileSync(markerFile, 'cached')

58
src/cache-utils.ts
View file

@ -91,7 +91,7 @@ export abstract class AbstractCache {
core.saveState(this.cacheKeyStateKey, cacheKey.key)
const cacheResult = await cache.restoreCache(
const cacheResult = await this.restoreCache(
this.getCachePath(),
cacheKey.key,
cacheKey.restoreKeys
@ -112,6 +112,28 @@ export abstract class AbstractCache {
return
}
protected async restoreCache(
cachePath: string[],
cacheKey: string,
cacheRestoreKeys: string[] = []
): Promise<string | undefined> {
try {
return await cache.restoreCache(
cachePath,
cacheKey,
cacheRestoreKeys
)
} catch (error) {
if (error instanceof cache.ValidationError) {
// Validation errors should fail the build action
throw error
}
// Warn about any other error and continue
core.warning(`Failed to restore ${cacheKey}: ${error}`)
return undefined
}
}
async save(): Promise<void> {
if (!this.cacheOutputExists()) {
this.debug(`No ${this.cacheDescription} to cache.`)
@ -138,22 +160,32 @@ export abstract class AbstractCache {
core.info(
`Caching ${this.cacheDescription} with cache key: ${cacheKey}`
)
try {
await cache.saveCache(this.getCachePath(), cacheKey)
} catch (error) {
// Fail on validation errors or non-errors (the latter to keep Typescript happy)
if (
error instanceof cache.ValidationError ||
!(error instanceof Error)
) {
throw error
}
core.warning(error.message)
}
const cachePath = this.getCachePath()
await this.saveCache(cachePath, cacheKey)
return
}
protected async saveCache(
cachePath: string[],
cacheKey: string
): Promise<void> {
try {
await cache.saveCache(cachePath, cacheKey)
} catch (error) {
if (error instanceof cache.ValidationError) {
// Validation errors should fail the build action
throw error
} else if (error instanceof cache.ReserveCacheError) {
// Reserve cache errors are expected if the artifact has been previously cached
this.debug(error.message)
} else {
// Warn about any other error and continue
core.warning(String(error))
}
}
}
protected debug(message: string): void {
if (this.cacheDebuggingEnabled) {
core.info(message)