Very Popular
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431import { FetchError } from "../framework/core/error.ts";import type { RouteConfig, RouteModule } from "../framework/core/route.ts";import { matchRoutes } from "../framework/core/route.ts";import util from "../lib/util.ts";import type { DependencyGraph, Module } from "./graph.ts";import { builtinModuleExts, getDeploymentId, getUnoGenerator } from "./helpers.ts";import type { Element, HTMLRewriterHandlers } from "./html.ts";import { HTMLRewriter } from "./html.ts";import { importRouteModule } from "./routing.ts";
export type SSRContext = { readonly url: URL; readonly routeModules: RouteModule[]; readonly headCollection: string[]; readonly dataDefer: boolean; readonly signal: AbortSignal; readonly bootstrapScripts?: string[]; readonly onError?: (error: unknown) => void;};
export type SSRFn = { (ssr: SSRContext): Promise<ReadableStream | string> | ReadableStream | string;};
// Options for the content-security-policy// https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policyexport type CSP = { nonce?: boolean; getPolicy: (url: URL, nonce?: string) => string | null;};
export type SSR = { cacheControl?: "private" | "public"; CSP?: CSP; dataDefer: true; render: (ssr: SSRContext) => Promise<ReadableStream> | ReadableStream;} | { cacheControl?: "private" | "public"; CSP?: CSP; dataDefer?: false; render: SSRFn;} | SSRFn;
export type SSRResult = { context: SSRContext; body: ReadableStream | string; deferedData: Record<string, unknown>; nonce?: string; is404?: boolean;};
export type RenderOptions = { indexHtml: Uint8Array; routeConfig: RouteConfig | null; customHTMLRewriter: [selector: string, handlers: HTMLRewriterHandlers][]; isDev?: boolean; ssr?: SSR;};
/** The virtual `bootstrapScript` to mark the ssr streaming initial UI is ready */const bootstrapScript = `data:text/javascript;charset=utf-8;base64,${btoa("/* stage ready */")}`;
export default { async fetch(req: Request, ctx: Record<string, unknown>, options: RenderOptions): Promise<Response> { const { indexHtml, routeConfig, customHTMLRewriter, isDev, ssr } = options; const headers = new Headers(ctx.headers as Headers); let ssrRes: SSRResult | null = null; if (typeof ssr === "function" || typeof ssr?.render === "function") { const isFn = typeof ssr === "function"; const dataDefer = isFn ? false : !!ssr.dataDefer; const cc = !isFn ? ssr.cacheControl : "public"; const CSP = isFn ? undefined : ssr.CSP; const render = isFn ? ssr : ssr.render; const [url, routeModules, deferedData] = await initSSR(req, ctx, routeConfig, dataDefer); const headCollection: string[] = []; const ssrContext: SSRContext = { url, routeModules, headCollection, dataDefer, signal: req.signal, bootstrapScripts: [bootstrapScript], onError: (_error: unknown) => { // todo: handle suspense ssr error }, }; const body = await render(ssrContext); const serverDependencyGraph: DependencyGraph | undefined = Reflect.get(globalThis, "__ALEPH_SERVER_DEP_GRAPH"); if (serverDependencyGraph) { const unocssTokens: ReadonlyArray<string>[] = []; const lookupModuleStyle = (mod: Module) => { const { specifier, atomicCSS, inlineCSS } = mod; if (atomicCSS) { unocssTokens.push(atomicCSS.tokens); } if (inlineCSS) { headCollection.push(`<style data-module-id="${specifier}">${inlineCSS}</style>`); } }; for (const { filename } of routeModules) { serverDependencyGraph.shallowWalk(filename, lookupModuleStyle); } for (const serverEntry of builtinModuleExts.map((ext) => `./server.${ext}`)) { if (serverDependencyGraph.get(serverEntry)) { serverDependencyGraph.shallowWalk(serverEntry, lookupModuleStyle); break; } } if (unocssTokens.length > 0) { const unoGenerator = getUnoGenerator(); if (unoGenerator) { const start = performance.now(); const { css } = await unoGenerator.generate(new Set(unocssTokens.flat()), { minify: !isDev, }); if (css) { const buildTime = performance.now() - start; headCollection.push( `<style data-unocss="${unoGenerator.version}" data-build-time="${buildTime}ms">${css}</style>`, ); } } } } if (routeModules.every(({ dataCacheTtl: ttl }) => typeof ttl === "number" && !Number.isNaN(ttl) && ttl > 0)) { const ttls = routeModules.map(({ dataCacheTtl }) => Number(dataCacheTtl)); headers.append("Cache-Control", `${cc}, max-age=${Math.min(...ttls)}`); } else { headers.append("Cache-Control", `${cc}, max-age=0, must-revalidate`); } ssrRes = { context: ssrContext, body, deferedData, is404: routeConfig !== null && (routeModules.length === 0 || routeModules.at(-1)?.url.pathname === "/_404"), }; if (!isDev && CSP) { const nonce = CSP.nonce ? Date.now().toString(36) : undefined; const policy = CSP.getPolicy(url, nonce!); if (policy) { headers.append("Content-Security-Policy", policy); if (policy.includes("nonce-" + nonce)) { ssrRes.nonce = nonce; } } } } else { const deployId = getDeploymentId(); let etag: string | null = null; if (deployId) { etag = `W/${btoa("./index.html").replace(/[^a-z0-9]/g, "")}-${deployId}`; } else { try { const { mtime, size } = await Deno.lstat("./index.html"); if (mtime) { etag = `W/${mtime.getTime().toString(16)}-${size.toString(16)}`; headers.append("Last-Modified", new Date(mtime).toUTCString()); } } catch (err) { if (!(err instanceof Deno.errors.NotFound)) { throw err; } } } if (etag) { if (req.headers.get("If-None-Match") === etag) { return new Response(null, { status: 304 }); } headers.append("ETag", etag); } headers.append("Cache-Control", "public, max-age=0, must-revalidate"); }
const stream = new ReadableStream({ start: (controller) => { let ssrStreaming = false; const suspenseChunks: Uint8Array[] = []; const rewriter = new HTMLRewriter("utf8", (chunk: Uint8Array) => { if (ssrStreaming) { suspenseChunks.push(chunk); } else { controller.enqueue(chunk); } });
// apply custom html rewrite handlers defined by middlewares customHTMLRewriter.forEach(([selector, handlers]) => rewriter.on(selector, handlers));
// inject the roures manifest rewriter.on("head", { element(el: Element) { if (routeConfig && routeConfig.routes.length > 0) { const json = JSON.stringify({ routes: routeConfig.routes.map(([_, meta]) => meta) }); el.append(`<script id="routes-manifest" type="application/json">${json}</script>`, { html: true, }); } }, });
if (ssrRes) { const { context: { routeModules, headCollection }, body, deferedData, nonce, } = ssrRes; rewriter.on("head", { element(el: Element) { headCollection.forEach((h) => util.isFilledString(h) && el.append(h, { html: true })); if (routeModules.length > 0) { const ssrModules = routeModules.map(({ url, params, filename, withData, data, dataCacheTtl }) => { const defered = typeof data === "function" ? true : undefined; return { url: url.pathname + url.search, params, filename, withData, error: data instanceof Error ? { message: data.message, stack: data.stack } : undefined, data: defered ? undefined : data instanceof Error ? undefined : data, dataCacheTtl, dataDefered: defered, }; });
// replace "/" to "\/" to prevent xss const modulesJSON = JSON.stringify(ssrModules).replaceAll("/", "\\/"); el.append( `<script id="ssr-modules" type="application/json">${modulesJSON}</script>`, { html: true }, );
const deployId = getDeploymentId(); const importStmts = routeModules.map(({ filename }, idx) => `import $${idx} from ${JSON.stringify(filename.slice(1) + (deployId ? `?v=${deployId}` : ""))} ;` ).join(""); const kvs = routeModules.map(({ filename, data }, idx) => `${JSON.stringify(filename)}:{defaultExport:$${idx}${data !== undefined ? ",withData:true" : ""}}` ).join(","); const nonceAttr = nonce ? ` nonce="${nonce}"` : ""; el.append( `<script type="module"${nonceAttr}>${importStmts}window.__ROUTE_MODULES={${kvs}};</script>`, { html: true }, ); } }, }); rewriter.on("ssr-body", { element(el: Element) { if (typeof body === "string") { el.replace(body, { html: true }); } else if (body instanceof ReadableStream) { el.remove(); ssrStreaming = true;
const rw = new HTMLRewriter("utf8", (chunk: Uint8Array) => { controller.enqueue(chunk); }); rw.on("script", { element(el: Element) { if (el.getAttribute("src") === bootstrapScript) { suspenseChunks.splice(0, suspenseChunks.length).forEach((chunk) => controller.enqueue(chunk)); el.remove(); } }, }); const send = async () => { try { const reader = body.getReader(); while (true) { const { done, value } = await reader.read(); if (done) { break; } rw.write(value); } rw.end(); if (suspenseChunks.length > 0) { suspenseChunks.forEach((chunk) => controller.enqueue(chunk)); } if (Object.keys(deferedData).length > 0) { controller.enqueue( util.utf8TextEncoder.encode( `<script type="application/json" id="defered-data">${JSON.stringify(deferedData)}</script>`, ), ); } } finally { controller.close(); rw.free(); } }; send(); } }, }); if (nonce) { rewriter.on("script", { element(el: Element) { const typeAttr = el.getAttribute("type"); if ((!typeAttr || typeAttr === "module") && !el.getAttribute("src")) { el.setAttribute("nonce", nonce); } }, }); } }
try { rewriter.write(indexHtml); rewriter.end(); } finally { if (!ssrRes || typeof ssrRes.body === "string") { controller.close(); } rewriter.free(); } }, });
headers.set("Content-Type", "text/html; charset=utf-8"); return new Response(stream, { headers, status: ssrRes?.is404 ? 404 : 200 }); },};
/** import route modules and fetch data for SSR */async function initSSR( req: Request, ctx: Record<string, unknown>, routeConfig: RouteConfig | null, dataDefer: boolean,): Promise<[ url: URL, routeModules: RouteModule[], deferedData: Record<string, unknown>,]> { const url = new URL(req.url); if (!routeConfig) { return [url, [], {}]; }
const matches = matchRoutes(url, routeConfig); const deferedData: Record<string, unknown> = {};
// import module and fetch data for each matched route const modules = await Promise.all(matches.map(async ([ret, { filename }]) => { const mod = await importRouteModule(filename); const dataConfig = util.isPlainObject(mod.data) ? mod.data : mod; const rmod: RouteModule = { url: new URL(ret.pathname.input + url.search, url.href), params: ret.pathname.groups, filename: filename, defaultExport: mod.default, dataCacheTtl: dataConfig?.cacheTtl as (number | undefined), };
// assign route params to context Object.assign(ctx.params as Record<string, string>, ret.pathname.groups);
// check the `get` method of data, if `suspense` is enabled then return a promise instead const fetcher = dataConfig.get ?? dataConfig.GET; if (typeof fetcher === "function") { const fetchData = async () => { let res: unknown; // check the `any` method of data, throw the response object if it returns one const anyFetcher = dataConfig.any ?? dataConfig.ANY; if (typeof anyFetcher === "function") { const res = await anyFetcher(req, ctx); if (res instanceof Response) { throw res; } } res = fetcher(req, ctx); if (res instanceof Promise) { res = await res; } if (res instanceof Response) { if (res.status >= 400) { throw await FetchError.fromResponse(res); } if (res.status >= 300) { if (res.headers.has("Location")) { throw res; } throw new FetchError(500, "Missing the `Location` header"); } try { const data = await res.json(); if (dataDefer) { deferedData[rmod.url.pathname + rmod.url.search] = data; } return data; } catch (_e) { throw new FetchError(500, "Data must be valid JSON"); } } else if (res === null || util.isPlainObject(res) || Array.isArray(res)) { if (dataDefer) { deferedData[rmod.url.pathname + rmod.url.search] = res; } return res; } else { throw new FetchError(500, "Data must be valid JSON"); } }; rmod.withData = true; if (dataDefer) { rmod.data = fetchData; } else { try { rmod.data = await fetchData(); } catch (error) { if (error instanceof Error) { rmod.data = error; } else { throw error; } } } }
return rmod; }));
return [ url, modules.filter(({ defaultExport }) => defaultExport !== undefined), deferedData, ];}