gradle/gradle-build-action
1
0
Fork 0
mirror of https://github.com/gradle/gradle-build-action.git synced 2024-11-22 17:12:51 +00:00
Code Issues Projects Releases Packages Wiki Activity

Improve non-restore behavior for config-cache

Browse source 
- Avoid logging "not restoring" message when no entries exist to restore
- Clear the entries from metadata when they are not restored. This ensures that
  the non-restored entries are correctly purged.
This commit is contained in:
daz 2023-12-22 13:54:10 -07:00
parent 38785d7d62
commit 57f3f23714
No known key found for this signature in database
1 changed files with 18 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
src/cache-extract-entries.ts
View file

@ -257,7 +257,7 @@ abstract class AbstractEntryExtractor {
} }
const filedata = fs.readFileSync(cacheMetadataFile, 'utf-8') const filedata = fs.readFileSync(cacheMetadataFile, 'utf-8')
cacheDebug(`Loaded cache metadata: ${filedata}`) cacheDebug(`Loaded cache metadata for ${this.extractorName}: ${filedata}`)
const extractedCacheEntryMetadata = JSON.parse(filedata) as ExtractedCacheEntryMetadata const extractedCacheEntryMetadata = JSON.parse(filedata) as ExtractedCacheEntryMetadata
return extractedCacheEntryMetadata.entries return extractedCacheEntryMetadata.entries
} }
@ -265,12 +265,12 @@ abstract class AbstractEntryExtractor {
/** /**
* Saves information about the extracted cache entries into the 'cache-metadata.json' file. * Saves information about the extracted cache entries into the 'cache-metadata.json' file.
*/ */
private saveMetadataForCacheResults(results: ExtractedCacheEntry[]): void { protected saveMetadataForCacheResults(results: ExtractedCacheEntry[]): void {
const extractedCacheEntryMetadata = new ExtractedCacheEntryMetadata() const extractedCacheEntryMetadata = new ExtractedCacheEntryMetadata()
extractedCacheEntryMetadata.entries = results.filter(x => x.cacheKey !== undefined) extractedCacheEntryMetadata.entries = results.filter(x => x.cacheKey !== undefined)
const filedata = JSON.stringify(extractedCacheEntryMetadata) const filedata = JSON.stringify(extractedCacheEntryMetadata)
cacheDebug(`Saving cache metadata: ${filedata}`) cacheDebug(`Saving cache metadata for ${this.extractorName}: ${filedata}`)
fs.writeFileSync(this.getCacheMetadataFile(), filedata, 'utf-8') fs.writeFileSync(this.getCacheMetadataFile(), filedata, 'utf-8')
} }
@ -353,18 +353,12 @@ export class ConfigurationCacheEntryExtractor extends AbstractEntryExtractor {
*/ */
async restore(listener: CacheListener): Promise<void> { async restore(listener: CacheListener): Promise<void> {
if (!listener.fullyRestored) { if (!listener.fullyRestored) {
core.info('Not restoring configuration-cache state, as Gradle User Home was not fully restored') this.markNotRestored(listener, 'Gradle User Home was not fully restored')
for (const cacheEntry of this.loadExtractedCacheEntries()) {
listener.entry(cacheEntry.pattern).markNotRestored('Gradle User Home not fully restored')
}
return return
} }
if (!params.getCacheEncryptionKey()) { if (!params.getCacheEncryptionKey()) {
core.info('Not restoring configuration-cache state, as no encryption key was provided') this.markNotRestored(listener, 'Encryption Key was not provided')
for (const cacheEntry of this.loadExtractedCacheEntries()) {
listener.entry(cacheEntry.pattern).markNotRestored('No encryption key provided')
}
return return
} }
@ -373,6 +367,19 @@ export class ConfigurationCacheEntryExtractor extends AbstractEntryExtractor {
return await super.restore(listener) return await super.restore(listener)
} }
private markNotRestored(listener: CacheListener, reason: string): void {
const cacheEntries = this.loadExtractedCacheEntries()
if (cacheEntries.length > 0) {
core.info(`Not restoring configuration-cache state, as ${reason}`)
for (const cacheEntry of cacheEntries) {
listener.entry(cacheEntry.pattern).markNotRestored(reason).markNotSaved(reason)
}
// Update the results file based on no entries restored
this.saveMetadataForCacheResults([])
}
}
async extract(listener: CacheListener): Promise<void> { async extract(listener: CacheListener): Promise<void> {
if (!params.getCacheEncryptionKey()) { if (!params.getCacheEncryptionKey()) {
core.info('Not saving configuration-cache state, as no encryption key was provided') core.info('Not saving configuration-cache state, as no encryption key was provided')