@qwik.dev/router 2.0.0-beta.3 → 2.0.0-beta.31

package/lib/adapters/shared/vite/index.mjs

@@ -1,16 +1,102 @@
-// packages/qwik-router/src/adapters/shared/vite/index.ts
-import fs2 from "node:fs";
-import { basename, dirname, join as join2, resolve } from "node:path";
+import { join, resolve, dirname, basename } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import fs from 'node:fs';
+import { g as getErrorHtml } from '../../../chunks/error-handler.mjs';
 
-// packages/qwik-router/src/adapters/shared/vite/post-build.ts
-import { getErrorHtml } from "../../../middleware/request-handler/index.mjs";
-import fs from "node:fs";
-import { join } from "node:path";
-async function postBuild(clientOutDir, pathName, userStaticPaths, format, cleanStatic) {
+const SSG_WORKER_IMPORT_PREFIX = "@qwik-router-ssg-worker/";
+function ssgWorkerImportPlugin() {
+  return {
+    name: "qwik-router-ssg-worker-imports",
+    enforce: "pre",
+    async resolveId(id, importer) {
+      if (!id.startsWith(SSG_WORKER_IMPORT_PREFIX)) {
+        return null;
+      }
+      const subpath = id.slice(SSG_WORKER_IMPORT_PREFIX.length);
+      const sourceId = fileURLToPath(new URL(`../../${subpath}`, import.meta.url));
+      const resolved = await this.resolve(sourceId, importer, {
+        skipSelf: true
+      });
+      return `${(resolved ?? {
+        id: sourceId
+      }).id}?ssg-worker`;
+    }
+  };
+}
+
+function normalizeTrailingSlash(pathname) {
+  if (!pathname.endsWith("/")) {
+    return pathname + "/";
+  }
+  return pathname;
+}
+function createNotFoundPathsCode(basePathname, notFounds) {
+  notFounds.sort((a, b) => {
+    if (a[0].length > b[0].length) {
+      return -1;
+    }
+    if (a[0].length < b[0].length) {
+      return 1;
+    }
+    if (a[0] < b[0]) {
+      return -1;
+    }
+    if (a[0] > b[0]) {
+      return 1;
+    }
+    return 0;
+  });
+  if (!notFounds.some((r) => r[0] === basePathname)) {
+    const html = getErrorHtml(404, "Resource Not Found");
+    notFounds.push([
+      basePathname,
+      html
+    ]);
+  }
+  return JSON.stringify(notFounds, null, 2).slice(1, -1);
+}
+function createStaticPathsCode(staticPaths) {
+  return JSON.stringify(Array.from(new Set(staticPaths)).sort()).slice(1, -1);
+}
+const injectStatics = async (staticPathsCode, notFoundPathsCode, outDir) => {
+  const promises = /* @__PURE__ */ new Set();
+  const doReplace = async (path) => {
+    const code = await fs.promises.readFile(path, "utf-8");
+    let replaced = false;
+    const newCode = code.replace(/(['"])__QWIK_ROUTER_(STATIC_PATHS|NOT_FOUND)_ARRAY__\1/g, (_, _quote, type) => {
+      replaced = true;
+      return type === "STATIC_PATHS" ? staticPathsCode : notFoundPathsCode;
+    });
+    if (replaced) {
+      await fs.promises.writeFile(path, newCode);
+    }
+  };
+  const walk = async (dir) => {
+    const entries = await fs.promises.readdir(dir, {
+      withFileTypes: true
+    });
+    for (const entry of entries) {
+      if (entry.isDirectory()) {
+        await walk(join(dir, entry.name));
+      } else if (entry.name.endsWith("js")) {
+        const p = doReplace(join(dir, entry.name)).finally(() => {
+          promises.delete(p);
+        });
+        promises.add(p);
+      }
+    }
+  };
+  await walk(outDir);
+  await Promise.all(promises);
+};
+async function postBuild(clientOutDir, serverOutDir, pathName, userStaticPaths, cleanStatic) {
   if (pathName && !pathName.endsWith("/")) {
     pathName += "/";
   }
-  const ignorePathnames = /* @__PURE__ */ new Set([pathName + "build/", pathName + "assets/"]);
+  const ignorePathnames = /* @__PURE__ */ new Set([
+    pathName + "/" + (globalThis.__QWIK_BUILD_DIR__ || "build") + "/",
+    pathName + "/" + (globalThis.__QWIK_ASSETS_DIR__ || "assets") + "/"
+  ]);
   const staticPaths = new Set(userStaticPaths.map(normalizeTrailingSlash));
   const notFounds = [];
   const loadItem = async (fsDir, fsName, pathname) => {
@@ -27,7 +113,10 @@ async function postBuild(clientOutDir, pathName, userStaticPaths, format, cleanS
     }
     if (fsName === "404.html") {
       const notFoundHtml = await fs.promises.readFile(fsPath, "utf-8");
-      notFounds.push([pathname, notFoundHtml]);
+      notFounds.push([
+        pathname,
+        notFoundHtml
+      ]);
       return;
     }
     const stat = await fs.promises.stat(fsPath);
@@ -44,110 +133,21 @@ async function postBuild(clientOutDir, pathName, userStaticPaths, format, cleanS
   if (fs.existsSync(clientOutDir)) {
     await loadDir(clientOutDir, pathName);
   }
-  const notFoundPathsCode = createNotFoundPathsModule(pathName, notFounds, format);
-  const staticPathsCode = createStaticPathsModule(pathName, staticPaths, format);
-  return {
-    notFoundPathsCode,
-    staticPathsCode
-  };
-}
-function normalizeTrailingSlash(pathname) {
-  if (!pathname.endsWith("/")) {
-    return pathname + "/";
-  }
-  return pathname;
-}
-function createNotFoundPathsModule(basePathname, notFounds, format) {
-  notFounds.sort((a, b) => {
-    if (a[0].length > b[0].length) {
-      return -1;
-    }
-    if (a[0].length < b[0].length) {
-      return 1;
-    }
-    if (a[0] < b[0]) {
-      return -1;
-    }
-    if (a[0] > b[0]) {
-      return 1;
-    }
-    return 0;
-  });
-  if (!notFounds.some((r) => r[0] === basePathname)) {
-    const html = getErrorHtml(404, "Resource Not Found");
-    notFounds.push([basePathname, html]);
-  }
-  const c = [];
-  c.push(`const notFounds = ${JSON.stringify(notFounds, null, 2)};`);
-  c.push(`function getNotFound(p) {`);
-  c.push(`  for (const r of notFounds) {`);
-  c.push(`    if (p.startsWith(r[0])) {`);
-  c.push(`      return r[1];`);
-  c.push(`    }`);
-  c.push(`  }`);
-  c.push(`  return "Resource Not Found";`);
-  c.push(`}`);
-  if (format === "cjs") {
-    c.push("exports.getNotFound = getNotFound;");
-  } else {
-    c.push("export { getNotFound };");
-  }
-  return c.join("\n");
-}
-function createStaticPathsModule(basePathname, staticPaths, format) {
-  const assetsPath = basePathname + "assets/";
-  const baseBuildPath = basePathname + "build/";
-  const c = [];
-  c.push(
-    `const staticPaths = new Set(${JSON.stringify(
-      Array.from(new Set(staticPaths)).sort()
-    )});`
-  );
-  c.push(`function isStaticPath(method, url) {`);
-  c.push(`  if (method.toUpperCase() !== 'GET') {`);
-  c.push(`    return false;`);
-  c.push(`  }`);
-  c.push(`  const p = url.pathname;`);
-  c.push(`  if (p.startsWith(${JSON.stringify(baseBuildPath)})) {`);
-  c.push(`    return true;`);
-  c.push(`  }`);
-  c.push(`  if (p.startsWith(${JSON.stringify(assetsPath)})) {`);
-  c.push(`    return true;`);
-  c.push(`  }`);
-  c.push(`  if (staticPaths.has(p)) {`);
-  c.push(`    return true;`);
-  c.push(`  }`);
-  c.push(`  if (p.endsWith('/q-data.json')) {`);
-  c.push(`    const pWithoutQdata = p.replace(/\\/q-data.json$/, '');`);
-  c.push(`    if (staticPaths.has(pWithoutQdata + '/')) {`);
-  c.push(`      return true;`);
-  c.push(`    }`);
-  c.push(`    if (staticPaths.has(pWithoutQdata)) {`);
-  c.push(`      return true;`);
-  c.push(`    }`);
-  c.push(`  }`);
-  c.push(`  return false;`);
-  c.push(`}`);
-  if (format === "cjs") {
-    c.push("exports.isStaticPath = isStaticPath;");
-  } else {
-    c.push("export { isStaticPath };");
-  }
-  return c.join("\n");
+  const notFoundPathsCode = createNotFoundPathsCode(pathName, notFounds);
+  const staticPathsCode = createStaticPathsCode(staticPaths);
+  await injectStatics(staticPathsCode, notFoundPathsCode, serverOutDir);
 }
 
-// packages/qwik-router/src/adapters/shared/vite/index.ts
+const QWIK_SSG_ENTRY_ID = "@qwik-ssg-entry";
+const QWIK_SSG_ENTRY_RESOLVED = "\0@qwik-ssg-entry";
 function viteAdapter(opts) {
   let qwikRouterPlugin = null;
   let qwikVitePlugin = null;
   let serverOutDir = null;
-  let renderModulePath = null;
-  let qwikRouterConfigModulePath = null;
-  let isSsrBuild = false;
-  let format = "esm";
+  let viteCommand;
   const outputEntries = [];
   const plugin = {
-    name: `vite-plugin-qwik-router-${opts.name}`,
+    name: `vite-plugin-qwik-router-ssg-${opts.name}`,
     enforce: "post",
     apply: "build",
     config(config) {
@@ -161,154 +161,175 @@ function viteAdapter(opts) {
       return config;
     },
     configResolved(config) {
-      var _a, _b, _c, _d;
-      isSsrBuild = !!config.build.ssr;
-      if (isSsrBuild) {
-        qwikRouterPlugin = config.plugins.find(
-          (p) => p.name === "vite-plugin-qwik-router"
-        );
-        if (!qwikRouterPlugin) {
-          throw new Error("Missing vite-plugin-qwik-router");
-        }
-        qwikVitePlugin = config.plugins.find(
-          (p) => p.name === "vite-plugin-qwik"
-        );
-        if (!qwikVitePlugin) {
-          throw new Error("Missing vite-plugin-qwik");
-        }
-        serverOutDir = config.build.outDir;
-        if (((_a = config.build) == null ? void 0 : _a.ssr) !== true) {
-          throw new Error(
-            `"build.ssr" must be set to "true" in order to use the "${opts.name}" adapter.`
-          );
-        }
-        if (!((_c = (_b = config.build) == null ? void 0 : _b.rollupOptions) == null ? void 0 : _c.input)) {
-          throw new Error(
-            `"build.rollupOptions.input" must be set in order to use the "${opts.name}" adapter.`
-          );
-        }
-        if (((_d = config.ssr) == null ? void 0 : _d.format) === "cjs") {
-          format = "cjs";
+      viteCommand = config.command;
+      qwikRouterPlugin = config.plugins.find((p) => p.name === "vite-plugin-qwik-router");
+      if (!qwikRouterPlugin) {
+        throw new Error("Missing vite-plugin-qwik-router");
+      }
+      qwikVitePlugin = config.plugins.find((p) => p.name === "vite-plugin-qwik");
+      if (!qwikVitePlugin) {
+        throw new Error("Missing vite-plugin-qwik");
+      }
+      serverOutDir = config.build.outDir;
+    },
+    resolveId(id) {
+      if (id === QWIK_SSG_ENTRY_ID) {
+        return QWIK_SSG_ENTRY_RESOLVED;
+      }
+    },
+    load(id) {
+      if (id !== QWIK_SSG_ENTRY_RESOLVED) {
+        return;
+      }
+      const { srcDir } = qwikVitePlugin.api.getOptions();
+      const clientPublicOutDir = qwikVitePlugin.api.getClientPublicOutDir();
+      const basePathname = qwikRouterPlugin.api.getBasePathname();
+      const rootDir = qwikVitePlugin.api.getRootDir() ?? void 0;
+      let ssgOrigin = opts.ssg?.origin ?? opts.origin;
+      if (!ssgOrigin) {
+        ssgOrigin = `https://yoursite.qwik.dev`;
+      }
+      if (ssgOrigin.length > 0 && !/:\/\//.test(ssgOrigin)) {
+        ssgOrigin = `https://${ssgOrigin}`;
+      }
+      if (ssgOrigin.startsWith("//")) {
+        ssgOrigin = `https:${ssgOrigin}`;
+      }
+      try {
+        ssgOrigin = new URL(ssgOrigin).origin;
+      } catch {
+        this.warn(`Invalid "origin" option: "${ssgOrigin}". Using default origin: "https://yoursite.qwik.dev"`);
+        ssgOrigin = `https://yoursite.qwik.dev`;
+      }
+      const ssgOpts = {
+        origin: ssgOrigin,
+        outDir: clientPublicOutDir,
+        basePathname,
+        rootDir,
+        ...opts.ssg,
+        maxWorkers: opts.maxWorkers
+      };
+      for (const key of Object.keys(ssgOpts)) {
+        if (ssgOpts[key] === void 0) {
+          delete ssgOpts[key];
         }
       }
+      return [
+        `import { isMainThread } from 'node:worker_threads';`,
+        `import render from '${srcDir}/entry.ssr';`,
+        `import qwikRouterConfig from '@qwik-router-config';`,
+        `import { runSsg, startWorker } from '@qwik.dev/router/ssg';`,
+        ``,
+        `const ssgOpts = ${JSON.stringify(ssgOpts)};`,
+        ``,
+        `// Parse --quiet / --debug CLI flags`,
+        `const args = isMainThread ? process.argv.slice(2) : [];`,
+        `if (args.includes('--quiet')) ssgOpts.log = 'quiet';`,
+        `if (args.includes('--debug')) ssgOpts.log = 'debug';`,
+        ``,
+        `if (isMainThread) {`,
+        `  await runSsg({`,
+        `    render,`,
+        `    qwikRouterConfig,`,
+        `    workerFilePath: new URL(import.meta.url).href,`,
+        `    ...ssgOpts,`,
+        `  });`,
+        `} else {`,
+        `  await startWorker({ render, qwikRouterConfig });`,
+        `}`
+      ].join("\n");
+    },
+    buildStart() {
+      if (this.environment.config.consumer === "server" && opts.ssg !== null && viteCommand === "build" && serverOutDir) {
+        this.emitFile({
+          id: QWIK_SSG_ENTRY_ID,
+          type: "chunk",
+          fileName: "run-ssg.js"
+        });
+      }
     },
     generateBundle(_, bundles) {
-      if (isSsrBuild) {
+      if (this.environment.config.consumer === "server") {
         outputEntries.length = 0;
         for (const fileName in bundles) {
           const chunk = bundles[fileName];
           if (chunk.type === "chunk" && chunk.isEntry) {
             outputEntries.push(fileName);
-            if (chunk.name === "entry.ssr") {
-              renderModulePath = join2(serverOutDir, fileName);
-            } else if (chunk.name === "@qwik-router-config") {
-              qwikRouterConfigModulePath = join2(serverOutDir, fileName);
-            }
           }
         }
-        if (!renderModulePath) {
-          throw new Error(
-            'Unable to find "entry.ssr" entry point. Did you forget to add it to "build.rollupOptions.input"?'
-          );
-        }
-        if (!qwikRouterConfigModulePath) {
-          throw new Error(
-            'Unable to find "@qwik-router-config" entry point. Did you forget to add it to "build.rollupOptions.input"?'
-          );
-        }
       }
     },
     closeBundle: {
       sequential: true,
       async handler() {
-        var _a;
-        if (isSsrBuild && opts.ssg !== null && serverOutDir && (qwikRouterPlugin == null ? void 0 : qwikRouterPlugin.api) && (qwikVitePlugin == null ? void 0 : qwikVitePlugin.api)) {
+        if (this.environment.config.consumer === "server" && serverOutDir && qwikRouterPlugin?.api && qwikVitePlugin?.api) {
           const staticPaths = opts.staticPaths || [];
           const routes = qwikRouterPlugin.api.getRoutes();
           const basePathname = qwikRouterPlugin.api.getBasePathname();
           const clientOutDir = qwikVitePlugin.api.getClientOutDir();
           const clientPublicOutDir = qwikVitePlugin.api.getClientPublicOutDir();
           const assetsDir = qwikVitePlugin.api.getAssetsDir();
-          const rootDir = qwikVitePlugin.api.getRootDir() ?? void 0;
-          if (renderModulePath && qwikRouterConfigModulePath && clientOutDir && clientPublicOutDir) {
-            let ssgOrigin = ((_a = opts.ssg) == null ? void 0 : _a.origin) ?? opts.origin;
-            if (!ssgOrigin) {
-              ssgOrigin = `https://yoursite.qwik.dev`;
-            }
-            if (ssgOrigin.length > 0 && !/:\/\//.test(ssgOrigin)) {
-              ssgOrigin = `https://${ssgOrigin}`;
-            }
-            if (ssgOrigin.startsWith("//")) {
-              ssgOrigin = `https:${ssgOrigin}`;
-            }
-            try {
-              ssgOrigin = new URL(ssgOrigin).origin;
-            } catch (e) {
-              this.warn(
-                `Invalid "origin" option: "${ssgOrigin}". Using default origin: "https://yoursite.qwik.dev"`
-              );
-              ssgOrigin = `https://yoursite.qwik.dev`;
-            }
-            const staticGenerate = await import("../../../static/index.mjs");
-            const generateOpts = {
-              maxWorkers: opts.maxWorkers,
-              basePathname,
-              outDir: clientPublicOutDir,
-              rootDir,
-              ...opts.ssg,
-              origin: ssgOrigin,
-              renderModulePath,
-              qwikRouterConfigModulePath
-            };
-            const staticGenerateResult = await staticGenerate.generate(generateOpts);
-            if (staticGenerateResult.errors > 0) {
-              const err = new Error(
-                `Error while running SSG from "${opts.name}" adapter. At least one path failed to render.`
-              );
+          if (opts.ssg !== null && clientOutDir && clientPublicOutDir) {
+            const runSsgPath = join(serverOutDir, "run-ssg.js");
+            const { spawn } = await import('node:child_process');
+            const ssgExitCode = await new Promise((resolve2, reject) => {
+              const child = spawn(process.execPath, [
+                runSsgPath
+              ], {
+                stdio: [
+                  "ignore",
+                  "inherit",
+                  "inherit"
+                ],
+                env: {
+                  ...process.env,
+                  NODE_ENV: process.env.NODE_ENV || "production"
+                }
+              });
+              child.on("close", resolve2);
+              child.on("error", reject);
+            });
+            if (ssgExitCode !== 0) {
+              const err = new Error(`Error while running SSG from "${opts.name}" adapter. At least one path failed to render.`);
               err.stack = void 0;
               this.error(err);
             }
-            staticPaths.push(...staticGenerateResult.staticPaths);
-            const { staticPathsCode, notFoundPathsCode } = await postBuild(
-              clientPublicOutDir,
-              assetsDir ? join2(basePathname, assetsDir) : basePathname,
-              staticPaths,
-              format,
-              !!opts.cleanStaticGenerated
-            );
-            await Promise.all([
-              fs2.promises.writeFile(join2(serverOutDir, RESOLVED_STATIC_PATHS_ID), staticPathsCode),
-              fs2.promises.writeFile(
-                join2(serverOutDir, RESOLVED_NOT_FOUND_PATHS_ID),
-                notFoundPathsCode
-              )
-            ]);
-            if (typeof opts.generate === "function") {
-              await opts.generate({
-                outputEntries,
-                serverOutDir,
-                clientOutDir,
-                clientPublicOutDir,
-                basePathname,
-                routes,
-                assetsDir,
-                warn: (message) => this.warn(message),
-                error: (message) => this.error(message)
-              });
+            const fs = await import('node:fs');
+            const staticPathsFile = join(clientPublicOutDir, "_static-paths.json");
+            try {
+              const content = await fs.promises.readFile(staticPathsFile, "utf-8");
+              staticPaths.push(...JSON.parse(content));
+              await fs.promises.unlink(staticPathsFile);
+            } catch {
             }
-            this.warn(
-              `
+          }
+          await postBuild(clientPublicOutDir, serverOutDir, assetsDir ? join(basePathname, assetsDir) : basePathname, staticPaths, !!opts.cleanStaticGenerated);
+          if (typeof opts.generate === "function") {
+            await opts.generate({
+              outputEntries,
+              serverOutDir,
+              clientOutDir,
+              clientPublicOutDir,
+              basePathname,
+              routes,
+              assetsDir,
+              warn: (message) => this.warn(message),
+              error: (message) => this.error(message)
+            });
+          }
+          this.warn(`
 ==============================================
 Note: Make sure that you are serving the built files with proper cache headers.
 See https://qwik.dev/docs/deployments/#cache-headers for more information.
-==============================================`
-            );
-          }
+==============================================`);
         }
       }
     }
   };
-  return plugin;
+  return [
+    ssgWorkerImportPlugin(),
+    plugin
+  ];
 }
 function getParentDir(startDir, dirName) {
   const root = resolve("/");
@@ -324,15 +345,5 @@ function getParentDir(startDir, dirName) {
   }
   throw new Error(`Unable to find "${dirName}" directory from "${startDir}"`);
 }
-var STATIC_PATHS_ID = "@qwik-router-static-paths";
-var RESOLVED_STATIC_PATHS_ID = `${STATIC_PATHS_ID}.js`;
-var NOT_FOUND_PATHS_ID = "@qwik-router-not-found-paths";
-var RESOLVED_NOT_FOUND_PATHS_ID = `${NOT_FOUND_PATHS_ID}.js`;
-export {
-  NOT_FOUND_PATHS_ID,
-  RESOLVED_NOT_FOUND_PATHS_ID,
-  RESOLVED_STATIC_PATHS_ID,
-  STATIC_PATHS_ID,
-  getParentDir,
-  viteAdapter
-};
+
+export { getParentDir, viteAdapter };

package/lib/adapters/ssg/vite/index.d.ts

@@ -0,0 +1,13 @@
+import type { SsgRenderOptions } from '../../../ssg';
+
+/** @public */
+export declare function ssgAdapter(opts: SsgAdapterOptions): any;
+
+/** @public */
+export declare interface SsgAdapterOptions extends Omit<SsgRenderOptions, 'outDir'> {
+}
+
+/** @public @deprecated Use `ssgAdapter` instead. */
+export declare const staticAdapter: typeof ssgAdapter;
+
+export { }

package/lib/adapters/ssg/vite/index.mjs

@@ -0,0 +1,17 @@
+import { viteAdapter } from '../../shared/vite/index.mjs';
+
+function ssgAdapter(opts) {
+  return viteAdapter({
+    name: "static-site-generation",
+    origin: opts.origin,
+    ssg: {
+      include: [
+        "/*"
+      ],
+      ...opts
+    }
+  });
+}
+const staticAdapter = ssgAdapter;
+
+export { ssgAdapter, staticAdapter };

package/lib/adapters/vercel-edge/vite/index.d.ts

@@ -1,7 +1,7 @@
 import { ServerAdapterOptions } from '../../shared/vite';
-import type { StaticGenerateRenderOptions } from '@qwik.dev/router/static';
+import type { SsgRenderOptions } from 'packages/qwik-router/src/ssg';
 
-export { StaticGenerateRenderOptions }
+export { SsgRenderOptions }
 
 /** @public */
 export declare function vercelEdgeAdapter(opts?: VercelEdgeAdapterOptions): any;
@@ -35,7 +35,7 @@ export declare interface VercelEdgeAdapterOptions extends ServerAdapterOptions {
      */
     staticPaths?: string[];
     /**
-     * Define the `target` property in the `ssr` object in the `vite.config.mts` file.
+     * Define the `target` property in the `ssr` object in the `vite.config.ts` file.
      *
      * Defaults to `webworker`.
      */