From 3d0bc88ec6c0615bf85b18951bcee3c35a649bb9 Mon Sep 17 00:00:00 2001 From: pieh Date: Wed, 16 Oct 2024 13:58:26 +0200 Subject: [PATCH] chore: don't use extra fallback manifest and instead store html and boolean wether that is fallback html in single blob --- src/build/content/prerendered.ts | 53 +++++--------------------------- src/build/content/static.ts | 11 ++++++- src/build/plugin-context.ts | 36 ++++++++++++++++++++++ src/run/constants.ts | 1 - src/run/next.cts | 38 +++++++---------------- 5 files changed, 65 insertions(+), 74 deletions(-) diff --git a/src/build/content/prerendered.ts b/src/build/content/prerendered.ts index be58e50b2..144c6332e 100644 --- a/src/build/content/prerendered.ts +++ b/src/build/content/prerendered.ts @@ -9,8 +9,6 @@ import { glob } from 'fast-glob' import pLimit from 'p-limit' import { satisfies } from 'semver' -import { FS_BLOBS_MANIFEST } from '../../run/constants.js' -import { type FSBlobsManifest } from '../../run/next.cjs' import { encodeBlobKey } from '../../shared/blobkey.js' import type { CachedFetchValueForMultipleVersions, @@ -160,11 +158,6 @@ export const copyPrerenderedContent = async (ctx: PluginContext): Promise }) : false - const fsBlobsManifest: FSBlobsManifest = { - fallbackPaths: [], - outputRoot: ctx.distDir, - } - await Promise.all([ ...Object.entries(manifest.routes).map( ([route, meta]): Promise => @@ -214,41 +207,15 @@ export const copyPrerenderedContent = async (ctx: PluginContext): Promise await writeCacheEntry(key, value, lastModified, ctx) }), ), - ...Object.entries(manifest.dynamicRoutes).map(async ([route, meta]) => { - // fallback can be `string | false | null` - // - `string` - when user use pages router with `fallback: true`, and then it's html file path - // - `null` - when user use pages router with `fallback: 'block'` or app router with `export const dynamicParams = true` - // - `false` - when user use pages router with `fallback: false` or app router with `export const dynamicParams = false` - if (typeof meta.fallback === 'string') { - // https://github.com/vercel/next.js/pull/68603 started using route cache to serve fallbacks - // so we have to seed blobs with fallback entries - - // create cache entry for pages router with `fallback: true` case - await limitConcurrentPrerenderContentHandling(async () => { - // dynamic routes don't have entries for each locale so we have to generate them - // ourselves. If i18n is not used we use empty string as "locale" to be able to use - // same handling wether i18n is used or not - const locales = ctx.buildConfig.i18n?.locales ?? [''] + ...ctx.getFallbacks(manifest).map(async (route) => { + const key = routeToFilePath(route) + const value = await buildPagesCacheValue( + join(ctx.publishDir, 'server/pages', key), + shouldUseEnumKind, + true, // there is no corresponding json file for fallback, so we are skipping it for this entry + ) - const lastModified = Date.now() - for (const locale of locales) { - const key = routeToFilePath(posixJoin(locale, route)) - const value = await buildPagesCacheValue( - join(ctx.publishDir, 'server/pages', key), - shouldUseEnumKind, - true, // there is no corresponding json file for fallback, so we are skipping it for this entry - ) - // Netlify Forms are not support and require a workaround - if (value.kind === 'PAGE' || value.kind === 'PAGES' || value.kind === 'APP_PAGE') { - verifyNetlifyForms(ctx, value.html) - } - - await writeCacheEntry(key, value, lastModified, ctx) - - fsBlobsManifest.fallbackPaths.push(`${key}.html`) - } - }) - } + await writeCacheEntry(key, value, Date.now(), ctx) }), ]) @@ -263,10 +230,6 @@ export const copyPrerenderedContent = async (ctx: PluginContext): Promise ) await writeCacheEntry(key, value, lastModified, ctx) } - await writeFile( - join(ctx.serverHandlerDir, FS_BLOBS_MANIFEST), - JSON.stringify(fsBlobsManifest), - ) } catch (error) { ctx.failBuild('Failed assembling prerendered content for upload', error) } diff --git a/src/build/content/static.ts b/src/build/content/static.ts index 4079695bd..dd147cd4d 100644 --- a/src/build/content/static.ts +++ b/src/build/content/static.ts @@ -6,6 +6,7 @@ import { trace } from '@opentelemetry/api' import { wrapTracer } from '@opentelemetry/api/experimental' import glob from 'fast-glob' +import type { HtmlBlob } from '../../run/next.cjs' import { encodeBlobKey } from '../../shared/blobkey.js' import { PluginContext } from '../plugin-context.js' import { verifyNetlifyForms } from '../verification.js' @@ -25,6 +26,8 @@ export const copyStaticContent = async (ctx: PluginContext): Promise => { extglob: true, }) + const fallbacks = ctx.getFallbacks(await ctx.getPrerenderManifest()) + try { await mkdir(destDir, { recursive: true }) await Promise.all( @@ -33,7 +36,13 @@ export const copyStaticContent = async (ctx: PluginContext): Promise => { .map(async (path): Promise => { const html = await readFile(join(srcDir, path), 'utf-8') verifyNetlifyForms(ctx, html) - await writeFile(join(destDir, await encodeBlobKey(path)), html, 'utf-8') + + const isFallback = fallbacks.includes(path) + await writeFile( + join(destDir, await encodeBlobKey(path)), + JSON.stringify({ html, isFallback } satisfies HtmlBlob), + 'utf-8', + ) }), ) } catch (error) { diff --git a/src/build/plugin-context.ts b/src/build/plugin-context.ts index e678cd936..74c0ffc32 100644 --- a/src/build/plugin-context.ts +++ b/src/build/plugin-context.ts @@ -334,6 +334,42 @@ export class PluginContext { return this.#nextVersion } + #fallbacks: string[] | null = null + /** + * Get an array of localized fallback routes + * + * Example return value for non-i18n site: `['blog/[slug]']` + * + * Example return value for i18n site: `['en/blog/[slug]', 'fr/blog/[slug]']` + */ + getFallbacks(prerenderManifest: PrerenderManifest): string[] { + if (!this.#fallbacks) { + // dynamic routes don't have entries for each locale so we have to generate them + // ourselves. If i18n is not used we use empty string as "locale" to be able to use + // same handling wether i18n is used or not + const locales = this.buildConfig.i18n?.locales ?? [''] + + this.#fallbacks = Object.entries(prerenderManifest.dynamicRoutes).reduce( + (fallbacks, [route, meta]) => { + // fallback can be `string | false | null` + // - `string` - when user use pages router with `fallback: true`, and then it's html file path + // - `null` - when user use pages router with `fallback: 'block'` or app router with `export const dynamicParams = true` + // - `false` - when user use pages router with `fallback: false` or app router with `export const dynamicParams = false` + if (typeof meta.fallback === 'string') { + for (const locale of locales) { + const localizedRoute = posixJoin(locale, route.replace(/^\/+/g, '')) + fallbacks.push(localizedRoute) + } + } + return fallbacks + }, + [] as string[], + ) + } + + return this.#fallbacks + } + /** Fails a build with a message and an optional error */ failBuild(message: string, error?: unknown): never { return this.utils.build.failBuild(message, error instanceof Error ? { error } : undefined) diff --git a/src/run/constants.ts b/src/run/constants.ts index c27f338b3..ebf5daaa3 100644 --- a/src/run/constants.ts +++ b/src/run/constants.ts @@ -5,4 +5,3 @@ export const MODULE_DIR = fileURLToPath(new URL('.', import.meta.url)) export const PLUGIN_DIR = resolve(`${MODULE_DIR}../../..`) // a file where we store the required-server-files config object in to access during runtime export const RUN_CONFIG = 'run-config.json' -export const FS_BLOBS_MANIFEST = 'fs-blobs-manifest.json' diff --git a/src/run/next.cts b/src/run/next.cts index d90c34618..84f378ddb 100644 --- a/src/run/next.cts +++ b/src/run/next.cts @@ -1,5 +1,5 @@ -import fs, { readFile } from 'fs/promises' -import { join, relative, resolve } from 'path' +import fs from 'fs/promises' +import { relative, resolve } from 'path' // @ts-expect-error no types installed import { patchFs } from 'fs-monkey' @@ -80,25 +80,9 @@ console.timeEnd('import next server') type FS = typeof import('fs') -export type FSBlobsManifest = { - fallbackPaths: string[] - outputRoot: string -} - -function normalizeStaticAssetPath(path: string) { - return path.startsWith('/') ? path : `/${path}` -} - -let fsBlobsManifestPromise: Promise | undefined -const getFSBlobsManifest = (): Promise => { - if (!fsBlobsManifestPromise) { - fsBlobsManifestPromise = (async () => { - const { FS_BLOBS_MANIFEST, PLUGIN_DIR } = await import('./constants.js') - return JSON.parse(await readFile(resolve(PLUGIN_DIR, FS_BLOBS_MANIFEST), 'utf-8')) - })() - } - - return fsBlobsManifestPromise +export type HtmlBlob = { + html: string + isFallback: boolean } export async function getMockedRequestHandlers(...args: Parameters) { @@ -117,20 +101,20 @@ export async function getMockedRequestHandlers(...args: Parameters