Skip to content

build: Don't use cache for files depending on Release Registry #15124

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

Merged
merged 6 commits into from
Oct 3, 2025
Merged

build: Don't use cache for files depending on Release Registry #15124

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c4252d3
build: Don't cache files with content from release registry
lcian Oct 3, 2025
707d88d
lint
lcian Oct 3, 2025
f6b51a9
eslint
lcian Oct 3, 2025
6cce771
add comment
lcian Oct 3, 2025
e6db302
improve
lcian Oct 3, 2025
23b5764
PlatformSDKPackageName
lcian Oct 3, 2025
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
53 changes: 34 additions & 19 deletions src/mdx.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -531,26 +531,41 @@ export async function getFileBySlug(slug: string): Promise<SlugFile> {
const outdir = path.join(root, 'public', 'mdx-images');
await mkdir(outdir, {recursive: true});

// If the file contains content that depends on the Release Registry (such as an SDK's latest version), avoid using the cache for that file, i.e. always rebuild it.
// This is because the content from the registry might have changed since the last time the file was cached.
// If a new component that injects content from the registry is introduced, it should be added to the patterns below.
const skipCache =
source.includes('@inject') ||
source.includes('<PlatformSDKPackageName') ||
source.includes('<LambdaLayerDetail');

if (process.env.CI) {
cacheKey = md5(source);
cacheFile = path.join(CACHE_DIR, `${cacheKey}.br`);
assetsCacheDir = path.join(CACHE_DIR, cacheKey);
if (skipCache) {
// eslint-disable-next-line no-console
console.info(
`Not using cached version of ${sourcePath}, as its content depends on the Release Registry`
);
} else {
cacheKey = md5(source);
cacheFile = path.join(CACHE_DIR, `${cacheKey}.br`);
assetsCacheDir = path.join(CACHE_DIR, cacheKey);

try {
const [cached, _] = await Promise.all([
readCacheFile<SlugFile>(cacheFile),
cp(assetsCacheDir, outdir, {recursive: true}),
]);
return cached;
} catch (err) {
if (
err.code !== 'ENOENT' &&
err.code !== 'ABORT_ERR' &&
err.code !== 'Z_BUF_ERROR'
) {
// If cache is corrupted, ignore and proceed
// eslint-disable-next-line no-console
console.warn(`Failed to read MDX cache: ${cacheFile}`, err);
try {
const [cached, _] = await Promise.all([
readCacheFile<SlugFile>(cacheFile),
cp(assetsCacheDir, outdir, {recursive: true}),
]);
return cached;
} catch (err) {
if (
err.code !== 'ENOENT' &&
err.code !== 'ABORT_ERR' &&
err.code !== 'Z_BUF_ERROR'
) {
// If cache is corrupted, ignore and proceed
// eslint-disable-next-line no-console
console.warn(`Failed to read MDX cache: ${cacheFile}`, err);
}
}
}
}
Expand Down Expand Up @@ -685,7 +700,7 @@ export async function getFileBySlug(slug: string): Promise<SlugFile> {
},
};

if (assetsCacheDir && cacheFile) {
if (assetsCacheDir && cacheFile && !skipCache) {
await cp(assetsCacheDir, outdir, {recursive: true});
writeCacheFile(cacheFile, JSON.stringify(resultObj)).catch(e => {
// eslint-disable-next-line no-console
Expand Down
Loading