Skip to content

fix(cache): instrument the cache cleanup #39655

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jamietanna wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(cache): instrument the cache cleanup #39655

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 41 additions & 35 deletions lib/util/cache/package/file.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import cacache from 'cacache';
import { DateTime } from 'luxon';
import upath from 'upath';
import { instrument } from '../../../instrumentation';
import { logger } from '../../../logger';
import { compressToBase64, decompressFromBase64 } from '../../compress';
import type { PackageCacheNamespace } from './types';
Expand Down Expand Up @@ -75,42 +76,47 @@ export function init(cacheDir: string): string {
}

export async function cleanup(): Promise<void> {
logger.debug('Checking file package cache for expired items');
let totalCount = 0;
let deletedCount = 0;
const startTime = Date.now();
let errorCount = 0;
for await (const item of cacache.ls.stream(cacheFileName)) {
try {
totalCount += 1;
const cachedItem = item as unknown as cacache.CacheObject;
const res = await cacache.get(cacheFileName, cachedItem.key);
let cachedValue: any;
try {
cachedValue = JSON.parse(res.data.toString());
} catch {
logger.debug('Error parsing cached value - deleting');
await instrument(
'Checking file package cache for expired items',
async () => {
logger.debug('Checking file package cache for expired items');
let totalCount = 0;
let deletedCount = 0;
const startTime = Date.now();
let errorCount = 0;
for await (const item of cacache.ls.stream(cacheFileName)) {
const cachedItem = item as unknown as cacache.CacheObject;
try {
totalCount += 1;
const res = await cacache.get(cacheFileName, cachedItem.key);
let cachedValue: any;
try {
cachedValue = JSON.parse(res.data.toString());
} catch {
logger.debug('Error parsing cached value - deleting');
}
if (
!cachedValue ||
(cachedValue?.expiry &&
DateTime.local() > DateTime.fromISO(cachedValue.expiry))
) {
await cacache.rm.entry(cacheFileName, cachedItem.key);
await cacache.rm.content(cacheFileName, cachedItem.integrity);
deletedCount += 1;
}
} catch (err) /* istanbul ignore next */ {
logger.trace({ err }, 'Error cleaning up cache entry');
errorCount += 1;
}
}
if (
!cachedValue ||
(cachedValue?.expiry &&
DateTime.local() > DateTime.fromISO(cachedValue.expiry))
) {
await cacache.rm.entry(cacheFileName, cachedItem.key);
await cacache.rm.content(cacheFileName, cachedItem.integrity);
deletedCount += 1;
// istanbul ignore if: cannot reproduce error
if (errorCount > 0) {
logger.debug(`Error count cleaning up cache: ${errorCount}`);
}
} catch (err) /* istanbul ignore next */ {
logger.trace({ err }, 'Error cleaning up cache entry');
errorCount += 1;
}
}
// istanbul ignore if: cannot reproduce error
if (errorCount > 0) {
logger.debug(`Error count cleaning up cache: ${errorCount}`);
}
const durationMs = Math.round(Date.now() - startTime);
logger.debug(
`Deleted ${deletedCount} of ${totalCount} file cached entries in ${durationMs}ms`,
const durationMs = Math.round(Date.now() - startTime);
logger.debug(
`Deleted ${deletedCount} of ${totalCount} file cached entries in ${durationMs}ms`,
);
},
);
}