Merge pull request #92 from gradle/dd/cache-debug-logging

Improve cache logging and behaviour
This commit is contained in:
Daz DeBoer 2021-10-15 20:17:35 +02:00 committed by GitHub
commit 4bc52c85c3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 67 additions and 42 deletions

2
dist/main/index.js vendored

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

2
dist/post/index.js vendored

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -26,9 +26,9 @@ export class GradleUserHomeCache extends AbstractCache {
}
async afterRestore(): Promise<void> {
await this.reportCacheEntrySize('as restored from cache')
await this.reportGradleUserHomeSize('as restored from cache')
await this.restoreCommonArtifacts()
await this.reportCacheEntrySize('after restoring common artifacts')
await this.reportGradleUserHomeSize('after restoring common artifacts')
}
private async restoreCommonArtifacts(): Promise<void> {
@ -59,7 +59,7 @@ export class GradleUserHomeCache extends AbstractCache {
)
} else {
this.debug(
`Failed to restore ${bundle} with key ${cacheKey} to ${artifactPath}`
`Did not restore ${bundle} with key ${cacheKey} to ${artifactPath}`
)
}
} else {
@ -77,41 +77,10 @@ export class GradleUserHomeCache extends AbstractCache {
)
}
private async reportCacheEntrySize(label: string): Promise<void> {
if (!this.cacheDebuggingEnabled) {
return
}
if (!fs.existsSync(this.gradleUserHome)) {
return
}
const result = await exec.getExecOutput(
'du',
['-h', '-c', '-t', '5M'],
{
cwd: this.gradleUserHome,
silent: true,
ignoreReturnCode: true
}
)
core.info(`Gradle User Home cache entry (directories >5M): ${label}`)
core.info(
result.stdout
.trimEnd()
.replace(/\t/g, ' ')
.split('\n')
.map(it => {
return ` ${it}`
})
.join('\n')
)
core.info('-----------------------')
}
async beforeSave(): Promise<void> {
await this.reportGradleUserHomeSize('before saving common artifacts')
await this.saveCommonArtifacts()
await this.reportGradleUserHomeSize('after saving common artifacts')
}
private async saveCommonArtifacts(): Promise<void> {
@ -175,6 +144,10 @@ export class GradleUserHomeCache extends AbstractCache {
)
const key = hashFileNames(relativeFiles)
this.debug(
`Generating cache key for ${bundle} from files: ${relativeFiles}`
)
return `${cacheKeyPrefix}${bundle}-${key}`
}
@ -205,4 +178,37 @@ export class GradleUserHomeCache extends AbstractCache {
])
)
}
private async reportGradleUserHomeSize(label: string): Promise<void> {
if (!this.cacheDebuggingEnabled) {
return
}
if (!fs.existsSync(this.gradleUserHome)) {
return
}
const result = await exec.getExecOutput(
'du',
['-h', '-c', '-t', '5M'],
{
cwd: this.gradleUserHome,
silent: true,
ignoreReturnCode: true
}
)
core.info(`Gradle User Home cache entry (directories >5M): ${label}`)
core.info(
result.stdout
.trimEnd()
.replace(/\t/g, ' ')
.split('\n')
.map(it => {
return ` ${it}`
})
.join('\n')
)
core.info('-----------------------')
}
}

View File

@ -122,6 +122,12 @@ export abstract class AbstractCache {
core.saveState(this.cacheKeyStateKey, cacheKey.key)
this.debug(
`Requesting ${this.cacheDescription} with
key:${cacheKey.key}
restoreKeys:[${cacheKey.restoreKeys}]`
)
const cacheResult = await this.restoreCache(
this.getCachePath(),
cacheKey.key,
@ -141,7 +147,13 @@ export abstract class AbstractCache {
`Restored ${this.cacheDescription} from cache key: ${cacheResult}`
)
await this.afterRestore()
try {
await this.afterRestore()
} catch (error) {
core.warning(
`Restore ${this.cacheDescription} failed in 'afterRestore': ${error}`
)
}
return
}
@ -193,7 +205,14 @@ export abstract class AbstractCache {
return
}
await this.beforeSave()
try {
await this.beforeSave()
} catch (error) {
core.warning(
`Save ${this.cacheDescription} failed in 'beforeSave': ${error}`
)
return
}
core.info(
`Caching ${this.cacheDescription} with cache key: ${cacheKey}`