@qwik.dev/router 2.0.0-beta.39 → 2.0.0-beta.40

package/lib/ssg/index.mjs

@@ -1,297 +1,257 @@
-import { bold, green, dim, red, magenta } from 'kleur/colors';
-import { relative } from 'node:path';
-import { m as msToString } from '../chunks/format.mjs';
-import { e as ensureSlash, g as getPathnameForDynamicRoute } from '../chunks/pathname.mjs';
-import { c as createRouteTester } from '../chunks/routes.mjs';
-
+import { n as getPathnameForDynamicRoute, t as ensureSlash } from "../chunks/pathname.mjs";
+import { r as msToString } from "../chunks/format.mjs";
+import { t as createRouteTester } from "../chunks/routes.mjs";
+import { relative } from "node:path";
+import { bold, dim, green, magenta, red } from "kleur/colors";
 function validateOptions(opts) {
-  if (!opts.qwikRouterConfig) {
-    throw new Error(`Missing "qwikRouterConfig" option`);
-  }
-  let siteOrigin = opts.origin;
-  if (typeof siteOrigin !== "string" || siteOrigin.trim().length === 0) {
-    throw new Error(`Missing "origin" option`);
-  }
-  siteOrigin = siteOrigin.trim();
-  if (!/:\/\//.test(siteOrigin) || siteOrigin.startsWith("://")) {
-    throw new Error(`"origin" must start with a valid protocol, such as "https://" or "http://", received "${siteOrigin}"`);
-  }
-  try {
-    new URL(siteOrigin);
-  } catch (e) {
-    throw new Error(`Invalid "origin"`, {
-      cause: e
-    });
-  }
+	if (!opts.qwikRouterConfig) throw new Error(`Missing "qwikRouterConfig" option`);
+	let siteOrigin = opts.origin;
+	if (typeof siteOrigin !== "string" || siteOrigin.trim().length === 0) throw new Error(`Missing "origin" option`);
+	siteOrigin = siteOrigin.trim();
+	if (!/:\/\//.test(siteOrigin) || siteOrigin.startsWith("://")) throw new Error(`"origin" must start with a valid protocol, such as "https://" or "http://", received "${siteOrigin}"`);
+	try {
+		new URL(siteOrigin);
+	} catch (e) {
+		throw new Error(`Invalid "origin"`, { cause: e });
+	}
 }
 async function mainThread(sys) {
-  const opts = sys.getOptions();
-  validateOptions(opts);
-  const main = await sys.createMainProcess();
-  const log = await sys.createLogger();
-  log.info("\n" + bold(green("Starting Qwik Router SSG...")));
-  const qwikRouterConfig = opts.qwikRouterConfig;
-  const renderTimeout = 3e4;
-  const queue = [];
-  const active = /* @__PURE__ */ new Set();
-  const routes = qwikRouterConfig.routes;
-  const trailingSlash = !!qwikRouterConfig.trailingSlash;
-  const includeRoute = createRouteTester(opts.basePathname || "/", opts.include, opts.exclude);
-  return new Promise((resolve, reject) => {
-    try {
-      const timer = sys.createTimer();
-      const generatorResult = {
-        duration: 0,
-        rendered: 0,
-        errors: 0,
-        staticPaths: []
-      };
-      let isCompleted = false;
-      let isRoutesLoaded = false;
-      const completed = async () => {
-        const closePromise = main.close();
-        generatorResult.duration = timer();
-        if (generatorResult.errors === 0) {
-          log.info(`
-${green("SSG results")}`);
-          if (generatorResult.rendered > 0) {
-            log.info(`- Generated: ${dim(`${generatorResult.rendered} page${generatorResult.rendered === 1 ? "" : "s"}`)}`);
-          }
-          log.info(`- Duration: ${dim(msToString(generatorResult.duration))}`);
-          const total = generatorResult.rendered + generatorResult.errors;
-          if (total > 0) {
-            log.info(`- Average: ${dim(msToString(generatorResult.duration / total) + " per page")}`);
-          }
-          log.info(``);
-        }
-        closePromise.then(() => {
-          setTimeout(() => resolve(generatorResult));
-        }).catch(reject);
-      };
-      const next = () => {
-        while (!isCompleted && main.hasAvailableWorker() && queue.length > 0) {
-          const staticRoute = queue.shift();
-          if (staticRoute) {
-            render(staticRoute).catch((e) => {
-              console.error(`render failed for ${staticRoute.pathname}`, e);
-            });
-          }
-        }
-        if (!isCompleted && isRoutesLoaded && queue.length === 0 && active.size === 0) {
-          isCompleted = true;
-          completed().catch((e) => {
-            console.error("SSG completion failed", e);
-          });
-        }
-      };
-      let isPendingDrain = false;
-      const flushQueue = () => {
-        if (!isPendingDrain) {
-          isPendingDrain = true;
-          setTimeout(() => {
-            isPendingDrain = false;
-            next();
-          });
-        }
-      };
-      const render = async (staticRoute) => {
-        try {
-          active.add(staticRoute.pathname);
-          log.debug(`render start: ${staticRoute.pathname}`);
-          const result = await Promise.race([
-            main.render({
-              type: "render",
-              ...staticRoute
-            }),
-            new Promise((_, reject2) => setTimeout(() => reject2(new Error(`SSG render timed out after ${renderTimeout}ms`)), renderTimeout))
-          ]);
-          active.delete(staticRoute.pathname);
-          log.debug(`render done: ${staticRoute.pathname}`);
-          if (result.error) {
-            const err = new Error(result.error.message);
-            err.stack = result.error.stack;
-            log.error(`
-${bold(red(`!!! ${result.pathname}: Error during SSG`))}`);
-            log.error(red(err.message));
-            log.error(`  Pathname: ${magenta(staticRoute.pathname)}`);
-            if (err.stack) {
-              log.error(dim(err.stack));
-            }
-            generatorResult.errors++;
-          }
-          if (result.filePath != null) {
-            generatorResult.rendered++;
-            generatorResult.staticPaths.push(result.pathname);
-            const base = opts.rootDir ?? opts.outDir;
-            const path = relative(base, result.filePath);
-            const lastSlash = path.lastIndexOf("/");
-            log.info(`${dim(path.slice(0, lastSlash + 1))}${path.slice(lastSlash + 1)}`);
-          }
-          flushQueue();
-        } catch (e) {
-          console.error(`render failed for ${staticRoute.pathname}`, e);
-          isCompleted = true;
-          reject(e);
-        }
-      };
-      const addToQueue = (pathname, params) => {
-        if (pathname) {
-          pathname = new URL(pathname, `https://qwik.dev`).pathname;
-          if (pathname !== opts.basePathname) {
-            if (trailingSlash) {
-              if (!pathname.endsWith("/")) {
-                const segments = pathname.split("/");
-                const lastSegment = segments[segments.length - 1];
-                if (!lastSegment.includes(".")) {
-                  pathname = ensureSlash(pathname);
-                }
-              }
-            } else {
-              if (pathname.endsWith("/")) {
-                pathname = pathname.slice(0, pathname.length - 1);
-              }
-            }
-          }
-          if (includeRoute(pathname) && !queue.some((s) => s.pathname === pathname)) {
-            queue.push({
-              pathname,
-              params
-            });
-            flushQueue();
-          }
-        }
-      };
-      const traverseRouteTree = async (node, pathParts, basePathname, ancestorLoaders) => {
-        const currentLoaders = node._L ? [
-          ...ancestorLoaders,
-          node._L
-        ] : ancestorLoaders;
-        const index = node._I;
-        if (index) {
-          const pageLoaders = Array.isArray(index) ? index : [
-            ...currentLoaders,
-            index
-          ];
-          const joinedParts = pathParts.join("/");
-          const originalPathname = basePathname + (joinedParts ? ensureSlash(joinedParts) : "");
-          const paramNames = pathParts.filter((p) => p.startsWith("[") && p.endsWith("]")).map((p) => p.startsWith("[...") ? p.slice(4, -1) : p.slice(1, -1));
-          if (paramNames.length === 0) {
-            addToQueue(originalPathname, void 0);
-          } else {
-            const pageLoader = pageLoaders[pageLoaders.length - 1];
-            if (typeof pageLoader === "function") {
-              const pageModule = await pageLoader();
-              if (typeof pageModule.onStaticGenerate === "function") {
-                const staticGenerate = await pageModule.onStaticGenerate({
-                  env: {
-                    get(key) {
-                      return sys.getEnv(key);
-                    }
-                  }
-                });
-                if (Array.isArray(staticGenerate.params)) {
-                  for (const params of staticGenerate.params) {
-                    const pathname = getPathnameForDynamicRoute(originalPathname, paramNames, params);
-                    addToQueue(pathname, params);
-                  }
-                }
-              }
-            }
-          }
-        }
-        if (node._4 || node._E) {
-          const isStaticDir = !pathParts.some((p) => p.startsWith("["));
-          if (isStaticDir) {
-            const joinedParts = pathParts.join("/");
-            const dirPathname = basePathname + (joinedParts ? ensureSlash(joinedParts) : "");
-            addToQueue(dirPathname + "404.html", void 0);
-          }
-        }
-        if (node._M) {
-          for (const group of node._M) {
-            await traverseRouteTree(group, pathParts, basePathname, currentLoaders);
-          }
-        }
-        if (node._W && typeof node._W === "object") {
-          const childNode = node._W;
-          const paramName = childNode._P;
-          const pathPart = paramName ? `[${paramName}]` : "[param]";
-          await traverseRouteTree(childNode, [
-            ...pathParts,
-            pathPart
-          ], basePathname, currentLoaders);
-        }
-        if (node._A && typeof node._A === "object") {
-          const childNode = node._A;
-          const paramName = childNode._P;
-          const pathPart = paramName ? `[...${paramName}]` : "[...rest]";
-          await traverseRouteTree(childNode, [
-            ...pathParts,
-            pathPart
-          ], basePathname, currentLoaders);
-        }
-        for (const [key, child] of Object.entries(node)) {
-          if (key.charCodeAt(0) === 95) {
-            continue;
-          }
-          const childNode = child;
-          await traverseRouteTree(childNode, [
-            ...pathParts,
-            key
-          ], basePathname, currentLoaders);
-        }
-      };
-      const loadStaticRoutes = async () => {
-        log.debug("traversing route tree...");
-        await traverseRouteTree(routes, [], "/", []);
-        log.debug(`route tree traversed, ${queue.length} routes queued, ${active.size} active`);
-        isRoutesLoaded = true;
-        flushQueue();
-      };
-      loadStaticRoutes().catch((e) => {
-        console.error("SSG route loading failed", e);
-        reject(e);
-      });
-    } catch (e) {
-      console.error("SSG main thread failed", e);
-      reject(e);
-    }
-  });
+	const opts = sys.getOptions();
+	validateOptions(opts);
+	const main = await sys.createMainProcess();
+	const log = await sys.createLogger();
+	log.info("\n" + bold(green("Starting Qwik Router SSG...")));
+	const qwikRouterConfig = opts.qwikRouterConfig;
+	const renderTimeout = 3e4;
+	const queue = [];
+	const active = /* @__PURE__ */ new Set();
+	const routes = qwikRouterConfig.routes;
+	const trailingSlash = !!qwikRouterConfig.trailingSlash;
+	const includeRoute = createRouteTester(opts.basePathname || "/", opts.include, opts.exclude);
+	return new Promise((resolve, reject) => {
+		try {
+			const timer = sys.createTimer();
+			const generatorResult = {
+				duration: 0,
+				rendered: 0,
+				errors: 0,
+				staticPaths: []
+			};
+			let isCompleted = false;
+			let isRoutesLoaded = false;
+			const completed = async () => {
+				const closePromise = main.close();
+				generatorResult.duration = timer();
+				if (generatorResult.errors === 0) {
+					log.info(`\n${green("SSG results")}`);
+					if (generatorResult.rendered > 0) log.info(`- Generated: ${dim(`${generatorResult.rendered} page${generatorResult.rendered === 1 ? "" : "s"}`)}`);
+					log.info(`- Duration: ${dim(msToString(generatorResult.duration))}`);
+					const total = generatorResult.rendered + generatorResult.errors;
+					if (total > 0) log.info(`- Average: ${dim(msToString(generatorResult.duration / total) + " per page")}`);
+					log.info(``);
+				}
+				closePromise.then(() => {
+					setTimeout(() => resolve(generatorResult));
+				}).catch(reject);
+			};
+			const next = () => {
+				while (!isCompleted && main.hasAvailableWorker() && queue.length > 0) {
+					const staticRoute = queue.shift();
+					if (staticRoute) render(staticRoute).catch((e) => {
+						console.error(`render failed for ${staticRoute.pathname}`, e);
+					});
+				}
+				if (!isCompleted && isRoutesLoaded && queue.length === 0 && active.size === 0) {
+					isCompleted = true;
+					completed().catch((e) => {
+						console.error("SSG completion failed", e);
+					});
+				}
+			};
+			let isPendingDrain = false;
+			const flushQueue = () => {
+				if (!isPendingDrain) {
+					isPendingDrain = true;
+					setTimeout(() => {
+						isPendingDrain = false;
+						next();
+					});
+				}
+			};
+			const render = async (staticRoute) => {
+				try {
+					active.add(staticRoute.pathname);
+					log.debug(`render start: ${staticRoute.pathname}`);
+					const result = await Promise.race([main.render({
+						type: "render",
+						...staticRoute
+					}), new Promise((_, reject) => setTimeout(() => reject(/* @__PURE__ */ new Error(`SSG render timed out after ${renderTimeout}ms`)), renderTimeout))]);
+					active.delete(staticRoute.pathname);
+					log.debug(`render done: ${staticRoute.pathname}`);
+					if (result.error) {
+						const err = new Error(result.error.message);
+						err.stack = result.error.stack;
+						log.error(`\n${bold(red(`!!! ${result.pathname}: Error during SSG`))}`);
+						log.error(red(err.message));
+						log.error(`  Pathname: ${magenta(staticRoute.pathname)}`);
+						if (err.stack) log.error(dim(err.stack));
+						generatorResult.errors++;
+					}
+					if (result.filePath != null) {
+						generatorResult.rendered++;
+						generatorResult.staticPaths.push(result.pathname);
+						const base = opts.rootDir ?? opts.outDir;
+						const path = relative(base, result.filePath);
+						const lastSlash = path.lastIndexOf("/");
+						log.info(`${dim(path.slice(0, lastSlash + 1))}${path.slice(lastSlash + 1)}`);
+					}
+					flushQueue();
+				} catch (e) {
+					console.error(`render failed for ${staticRoute.pathname}`, e);
+					isCompleted = true;
+					reject(e);
+				}
+			};
+			const addToQueue = (pathname, params) => {
+				if (pathname) {
+					pathname = new URL(pathname, `https://qwik.dev`).pathname;
+					if (pathname !== opts.basePathname) {
+						if (trailingSlash) {
+							if (!pathname.endsWith("/")) {
+								const segments = pathname.split("/");
+								if (!segments[segments.length - 1].includes(".")) pathname = ensureSlash(pathname);
+							}
+						} else if (pathname.endsWith("/")) pathname = pathname.slice(0, pathname.length - 1);
+					}
+					if (includeRoute(pathname) && !queue.some((s) => s.pathname === pathname)) {
+						queue.push({
+							pathname,
+							params
+						});
+						flushQueue();
+					}
+				}
+			};
+			/**
+			* Traverse the route tree and call the callback for each route that has module loaders.
+			* Reconstructs the original pathname and param names from the tree path. Accumulates _L
+			* layout loaders from ancestors during traversal.
+			*/ const traverseRouteTree = async (node, pathParts, basePathname, ancestorLoaders) => {
+				const currentLoaders = node._L ? [...ancestorLoaders, node._L] : ancestorLoaders;
+				const index = node._I;
+				if (index) {
+					const pageLoaders = Array.isArray(index) ? index : [...currentLoaders, index];
+					const joinedParts = pathParts.join("/");
+					const originalPathname = basePathname + (joinedParts ? ensureSlash(joinedParts) : "");
+					const paramNames = pathParts.filter((p) => p.startsWith("[") && p.endsWith("]")).map((p) => p.startsWith("[...") ? p.slice(4, -1) : p.slice(1, -1));
+					if (paramNames.length === 0) addToQueue(originalPathname, void 0);
+					else {
+						const pageLoader = pageLoaders[pageLoaders.length - 1];
+						if (typeof pageLoader === "function") {
+							const pageModule = await pageLoader();
+							if (typeof pageModule.onStaticGenerate === "function") {
+								const staticGenerate = await pageModule.onStaticGenerate({ env: { get(key) {
+									return sys.getEnv(key);
+								} } });
+								if (Array.isArray(staticGenerate.params)) for (const params of staticGenerate.params) {
+									const pathname = getPathnameForDynamicRoute(originalPathname, paramNames, params);
+									addToQueue(pathname, params);
+								}
+							}
+						}
+					}
+				}
+				if (node._4 || node._E) {
+					if (!pathParts.some((p) => p.startsWith("["))) {
+						const joinedParts = pathParts.join("/");
+						const dirPathname = basePathname + (joinedParts ? ensureSlash(joinedParts) : "");
+						addToQueue(dirPathname + "404.html", void 0);
+					}
+				}
+				if (node._M) for (const group of node._M) await traverseRouteTree(group, pathParts, basePathname, currentLoaders);
+				if (node._W && typeof node._W === "object") {
+					const childNode = node._W;
+					const paramName = childNode._P;
+					const pathPart = paramName ? `[${paramName}]` : "[param]";
+					await traverseRouteTree(childNode, [...pathParts, pathPart], basePathname, currentLoaders);
+				}
+				if (node._A && typeof node._A === "object") {
+					const childNode = node._A;
+					const paramName = childNode._P;
+					const pathPart = paramName ? `[...${paramName}]` : "[...rest]";
+					await traverseRouteTree(childNode, [...pathParts, pathPart], basePathname, currentLoaders);
+				}
+				for (const [key, child] of Object.entries(node)) {
+					if (key.charCodeAt(0) === 95) continue;
+					await traverseRouteTree(child, [...pathParts, key], basePathname, currentLoaders);
+				}
+			};
+			const loadStaticRoutes = async () => {
+				log.debug("traversing route tree...");
+				await traverseRouteTree(routes, [], "/", []);
+				log.debug(`route tree traversed, ${queue.length} routes queued, ${active.size} active`);
+				isRoutesLoaded = true;
+				flushQueue();
+			};
+			loadStaticRoutes().catch((e) => {
+				console.error("SSG route loading failed", e);
+				reject(e);
+			});
+		} catch (e) {
+			console.error("SSG main thread failed", e);
+			reject(e);
+		}
+	});
 }
-
-async function generate(opts) {
-  const { createSystem } = await import('../chunks/system.mjs');
-  const sys = await createSystem(opts);
-  return mainThread(sys);
+/**
+* Use this function when SSG should be generated from another module, such as a Vite plugin. This
+* function's should be passed the paths of the entry module and Qwik Router Plan.
+*
+* @public
+*/ async function generate(opts) {
+	const { createSystem } = await import("../chunks/system.mjs");
+	return mainThread(await createSystem(opts));
 }
-async function runSsg(opts) {
-  try {
-    const result = await generate(opts);
-    const fs = await import('node:fs');
-    const { join } = await import('node:path');
-    const staticPathsFile = join(opts.outDir, "_static-paths.json");
-    await fs.promises.writeFile(staticPathsFile, JSON.stringify(result.staticPaths));
-    if (result.errors > 0) {
-      console.error(`SSG completed with ${result.errors} error(s)`);
-      process.exit(1);
-    }
-    process.exit(0);
-  } catch (e) {
-    console.error("SSG failed:", e);
-    process.exit(1);
-  }
+/**
+* Run SSG as a standalone process. Writes `_static-paths.json` to `outDir` and exits with code 0 on
+* success, 1 on error.
+*
+* Intended to be called from a generated `run-ssg.js` wrapper that provides render/config.
+*
+* @public
+*/ async function runSsg(opts) {
+	try {
+		const result = await generate(opts);
+		const fs = await import("node:fs");
+		const { join } = await import("node:path");
+		const staticPathsFile = join(opts.outDir, "_static-paths.json");
+		await fs.promises.writeFile(staticPathsFile, JSON.stringify(result.staticPaths));
+		if (result.errors > 0) {
+			console.error(`SSG completed with ${result.errors} error(s)`);
+			process.exit(1);
+		}
+		process.exit(0);
+	} catch (e) {
+		console.error("SSG failed:", e);
+		process.exit(1);
+	}
 }
-async function startWorker(opts) {
-  const { workerData } = await import('node:worker_threads');
-  const mergedOpts = {
-    ...workerData,
-    render: opts.render,
-    qwikRouterConfig: opts.qwikRouterConfig
-  };
-  const { createSystem } = await import('../chunks/system.mjs');
-  const { workerThread } = await import('../chunks/worker-thread.mjs');
-  const sys = await createSystem(mergedOpts, workerData?.threadId);
-  await workerThread(sys);
+/**
+* Bootstrap a worker thread for SSG rendering. Called from the generated `run-ssg.js` when it
+* detects it's running as a worker thread.
+*
+* @param opts - Must include `render` and `qwikRouterConfig` (imported by the worker entry). The
+*   remaining serializable options come from `workerData`.
+* @public
+*/ async function startWorker(opts) {
+	const { workerData } = await import("node:worker_threads");
+	const mergedOpts = {
+		...workerData,
+		render: opts.render,
+		qwikRouterConfig: opts.qwikRouterConfig
+	};
+	const { createSystem } = await import("../chunks/system.mjs");
+	const { workerThread } = await import("../chunks/worker-thread.mjs");
+	await workerThread(await createSystem(mergedOpts, workerData?.threadId));
 }
-
 export { generate, runSsg, startWorker };