Report on read-only / write-only cache

This commit is contained in:
Daz DeBoer 2022-06-02 22:44:08 -06:00
parent 143774290e
commit 7b79b2a752
No known key found for this signature in database
GPG Key ID: DD6B9F0B06683D5D
3 changed files with 27 additions and 10 deletions

View File

@ -212,7 +212,7 @@ abstract class AbstractEntryExtractor {
if (previouslyRestoredKey === cacheKey) { if (previouslyRestoredKey === cacheKey) {
cacheDebug(`No change to previously restored ${artifactType}. Not saving.`) cacheDebug(`No change to previously restored ${artifactType}. Not saving.`)
entryListener.markUnchanged('entry contents unchanged') entryListener.markUnchanged('contents unchanged')
} else { } else {
core.info(`Caching ${artifactType} with path '${pattern}' and cache key: ${cacheKey}`) core.info(`Caching ${artifactType} with path '${pattern}' and cache key: ${cacheKey}`)
await saveCache([pattern], cacheKey, entryListener) await saveCache([pattern], cacheKey, entryListener)

View File

@ -6,6 +6,8 @@ import * as core from '@actions/core'
*/ */
export class CacheListener { export class CacheListener {
cacheEntries: CacheEntryListener[] = [] cacheEntries: CacheEntryListener[] = []
isCacheReadOnly = false
isCacheWriteOnly = false
get fullyRestored(): boolean { get fullyRestored(): boolean {
return this.cacheEntries.every(x => !x.wasRequestedButNotRestored()) return this.cacheEntries.every(x => !x.wasRequestedButNotRestored())
@ -108,10 +110,10 @@ export function logCachingReport(listener: CacheListener): void {
Requested Key : ${entry.requestedKey ?? ''} Requested Key : ${entry.requestedKey ?? ''}
Restored Key : ${entry.restoredKey ?? ''} Restored Key : ${entry.restoredKey ?? ''}
Size: ${formatSize(entry.restoredSize)} Size: ${formatSize(entry.restoredSize)}
${getRestoredMessage(entry)} ${getRestoredMessage(entry, listener.isCacheWriteOnly)}
Saved Key : ${entry.savedKey ?? ''} Saved Key : ${entry.savedKey ?? ''}
Size: ${formatSize(entry.savedSize)} Size: ${formatSize(entry.savedSize)}
${getSavedMessage(entry)} ${getSavedMessage(entry, listener.isCacheReadOnly)}
---` ---`
) )
.join('\n') .join('\n')
@ -133,6 +135,13 @@ export function logCachingReport(listener: CacheListener): void {
` `
) )
if (listener.isCacheReadOnly) {
core.summary.addRaw('- **Cache is read-only**\n')
}
if (listener.isCacheWriteOnly) {
core.summary.addRaw('- **Cache is write-only**\n')
}
core.summary.addDetails( core.summary.addDetails(
'Cache Entry Details', 'Cache Entry Details',
` `
@ -144,25 +153,31 @@ ${entries}
) )
} }
function getRestoredMessage(entry: CacheEntryListener): string { function getRestoredMessage(entry: CacheEntryListener, isCacheWriteOnly: boolean): string {
if (isCacheWriteOnly) {
return '(Entry not restored: cache is write-only)'
}
if (entry.restoredKey === undefined) { if (entry.restoredKey === undefined) {
return '(No match found)' return '(Entry not restored: no match found)'
} }
if (entry.restoredKey === entry.requestedKey) { if (entry.restoredKey === entry.requestedKey) {
return '(Exact match found)' return '(Entry restored: exact match found)'
} }
return '(Fuzzy match found)' return '(Entry restored: partial match found)'
} }
function getSavedMessage(entry: CacheEntryListener): string { function getSavedMessage(entry: CacheEntryListener, isCacheReadOnly: boolean): string {
if (entry.unchanged) { if (entry.unchanged) {
return `(Entry not saved: ${entry.unchanged})` return `(Entry not saved: ${entry.unchanged})`
} }
if (entry.savedKey === undefined) { if (entry.savedKey === undefined) {
return '(Entry not saved: ???' if (isCacheReadOnly) {
return '(Entry not saved: cache is read-only)'
}
return '(Entry not saved: reason unknown)'
} }
if (entry.savedSize === 0) { if (entry.savedSize === 0) {
return '(Could not save: entry exists)' return '(Entry not saved: entry with key already exists)'
} }
return '(Entry saved)' return '(Entry saved)'
} }

View File

@ -35,6 +35,7 @@ export async function restore(gradleUserHome: string, cacheListener: CacheListen
if (isCacheWriteOnly()) { if (isCacheWriteOnly()) {
core.info('Cache is write-only: will not restore from cache.') core.info('Cache is write-only: will not restore from cache.')
cacheListener.isCacheWriteOnly = true
return return
} }
@ -50,6 +51,7 @@ export async function save(gradleUserHome: string, cacheListener: CacheListener)
if (isCacheReadOnly()) { if (isCacheReadOnly()) {
core.info('Cache is read-only: will not save state for use in subsequent builds.') core.info('Cache is read-only: will not save state for use in subsequent builds.')
cacheListener.isCacheReadOnly = true
return return
} }