bug fixes and path params changes

Arlen22 · Arlen22 · commit de32893eed4e · 2025-11-08T11:58:31.000-05:00
- prismaField error
- OPTIONS route not found for index
- catch handler bug
- keyReplacer for key paths
- named capture groups for path params
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/mws/src/managers/admin-utils.ts b/packages/mws/src/managers/admin-utils.ts
@@ -11,6 +11,7 @@ export function admin<T extends zod.ZodTypeAny, R extends JsonValue>(
   return zodRoute({
     method: ["POST"],
     path: "/admin/$key",
+    keyReplacer: "$key",
     zodPathParams: z => ({}),
     zodQueryParams: z => ({}),
     bodyFormat: "json",
@@ -37,4 +38,4 @@ export function admin<T extends zod.ZodTypeAny, R extends JsonValue>(
       return state.$transaction(async (prisma) => await inner(state, prisma));
     }
   });
-}
+}
diff --git a/packages/mws/src/managers/wiki-index.ts b/packages/mws/src/managers/wiki-index.ts
@@ -70,11 +70,12 @@ serverEvents.on("mws.routes", (root, config) => {
 
   // the wiki index route
   root.defineRoute({
-    method: ["GET", "HEAD"],
-    path: /^\/wiki\/(.*)$/,
-    pathParams: ["recipe_name"],
+    method: ["GET", "HEAD", "OPTIONS"],
+    path: /^\/wiki\/(?<recipe_name>.*)$/,
     bodyFormat: "ignore",
   }, async (state) => {
+    if (state.method === "OPTIONS") throw state.sendEmpty(405, {});
+
     const timekey = `handler ${state.bodyFormat} ${state.method} ${state.urlInfo.pathname} ${Date.now()}`;
 
     checkPath(state, z => ({
@@ -102,7 +103,11 @@ serverEvents.on("mws.routes", (root, config) => {
     throw STREAM_ENDED;
   }, async (state, e) => {
     if (e instanceof SendError) {
-      await state.sendAdmin(e.status, { sendError: e });
+      if (state.headersSent) {
+        console.log(e + "\n" + new Error("").stack?.split("\n").slice(2).join("\n"));
+      } else {
+        await state.sendAdmin(e.status, { sendError: e });
+      }
     } else {
       console.log("Unexpected error in wiki index route", e);
       const error = new SendError("INTERNAL_SERVER_ERROR", 500, {
diff --git a/packages/mws/src/managers/wiki-recipe.ts b/packages/mws/src/managers/wiki-recipe.ts
@@ -45,6 +45,7 @@ export class WikiRecipeRoutes {
   rpcLoadRecipeTiddlerList = zodRoute({
     method: ["PUT"],
     path: RECIPE_PREFIX + "/:recipe_name/rpc/$key",
+    keyReplacer: "$key",
     bodyFormat: "json",
     zodPathParams: z => ({
       recipe_name: z.prismaField("Recipes", "recipe_name", "string"),
@@ -152,6 +153,7 @@ export class WikiRecipeRoutes {
   rpcSaveRecipeTiddlerList = zodRoute({
     method: ["PUT"],
     path: RECIPE_PREFIX + "/:recipe_name/rpc/$key",
+    keyReplacer: "$key",
     bodyFormat: "json",
     zodPathParams: z => ({
       recipe_name: z.prismaField("Recipes", "recipe_name", "string"),
@@ -237,6 +239,7 @@ export class WikiRecipeRoutes {
   rpcDeleteRecipeTiddlerList = zodRoute({
     method: ["PUT"],
     path: RECIPE_PREFIX + "/:recipe_name/rpc/$key",
+    keyReplacer: "$key",
     bodyFormat: "json",
     zodPathParams: z => ({
       recipe_name: z.prismaField("Recipes", "recipe_name", "string"),
diff --git a/packages/mws/src/registerRequest.ts b/packages/mws/src/registerRequest.ts
@@ -42,9 +42,10 @@ declare module "@tiddlywiki/server" {
   }
 }
 
+Router.allowedRequestedWithHeaders.TiddlyWiki = true;
 
 serverEvents.on("listen.router.init", async (listen, router) => {
-  router.allowedRequestedWithHeaders.push("TiddlyWiki");
+  
   router.config = listen.config;
   router.sendAdmin = await setupDevServer(listen.config);
   router.createServerRequest = <B extends BodyFormat>(
diff --git a/packages/mws/src/services/cache.ts b/packages/mws/src/services/cache.ts
@@ -50,9 +50,8 @@ export async function startupCache($tw: TW, cachePath: string) {
 serverEvents.on("mws.routes", (root, config) => {
   root.defineRoute({
     method: ["GET", "HEAD"],
-    path: /^\/\$cache\/(.*)\/plugin\.js$/,
+    path: /^\/\$cache\/(?<plugin>.*)\/plugin\.js$/,
     bodyFormat: "ignore",
-    pathParams: ["plugin"]
   }, async (state: ServerRequest<BodyFormat, string, unknown>) => {
 
     checkPath(state, z => ({ plugin: z.string() }), new Error());
diff --git a/packages/mws/src/services/sessions.ts b/packages/mws/src/services/sessions.ts
@@ -46,7 +46,8 @@ export function zodSession<P extends string, T extends zod.ZodTypeAny, R extends
 ): ZodSessionRoute<P, T, R> {
   return {
     ...zodRoute({
-      method: ["POST"], path,
+      method: ["POST"], 
+      path,
       bodyFormat: "json",
       zodPathParams: z => ({}),
       zodQueryParams: z => ({}),
diff --git a/packages/mws/src/services/tw-routes.ts b/packages/mws/src/services/tw-routes.ts
@@ -14,7 +14,6 @@ serverEvents.on("mws.routes", (rootRoute, config) => {
       method: ["OPTIONS", "GET", "HEAD", "POST", "PUT", "DELETE"],
       bodyFormat: "stream",
       path: new RegExp("^" + mountPath + "(/|$)"),
-      pathParams: []
     }, TW5Route({
       mountPath,
       singleFile: true,
diff --git a/packages/mws/src/zodAssert.ts b/packages/mws/src/zodAssert.ts
@@ -42,7 +42,7 @@ declare module "@tiddlywiki/server" {
 
 
 
-export function prismaField(table: any, field: any, fieldtype: ExtraFieldType, nullable?: boolean): any {
+Z2.prismaField = function prismaField(table: any, field: any, fieldtype: ExtraFieldType, nullable?: boolean): any {
   const z = zod;
   const check = (() => {
     switch (fieldtype) {
@@ -67,6 +67,3 @@ export function prismaField(table: any, field: any, fieldtype: ExtraFieldType, n
 
 }
 
-serverEvents.on("zod.make", (zod: Z2<any>) => {
-  zod.prismaField = prismaField;
-});
diff --git a/packages/server/src/router.ts b/packages/server/src/router.ts
@@ -18,10 +18,10 @@ export interface AllowedRequestedWithHeaderKeys {
 }
 
 export class Router {
-  static allowedRequestedWithHeaders: AllowedRequestedWithHeaderKeys = {
+  static allowedRequestedWithHeaders: Partial<AllowedRequestedWithHeaderKeys> = {
     fetch: true,
     XMLHttpRequest: true,
-  }
+  };
   constructor(
     public rootRoute: ServerRoute
   ) {
@@ -185,6 +185,7 @@ export class Router {
       await Promise.resolve().then(() => {
         return match.route.handler(result);
       }).catch(e => {
+        if (e === STREAM_ENDED) throw e;
         if (match.route.catchHandler) {
           return match.route.catchHandler(result, e);
         } else {
diff --git a/packages/server/src/streamer.ts b/packages/server/src/streamer.ts
@@ -560,11 +560,13 @@ export class Streamer {
     if (Debug.enabled("send"))
       console.error("writeHead", status, headers);
 
+    this.checkHeadersSentBy(true);
+
     Object.entries(headers).forEach(([k, v]) => {
       if (v != null) this.setHeader(k, `${v}`);
     });
 
-    this.checkHeadersSentBy(true);
+
     this.compressor.beforeWriteHead();
     this.res.writeHead(status);
   }
diff --git a/packages/server/src/zodRegister.ts b/packages/server/src/zodRegister.ts
@@ -10,9 +10,9 @@ const debugCORS = Debug("mws:cors");
 
 
 
-export const registerZodRoutes = (parent: ServerRoute, router: any, keys: string[], keyReplacer: string = "$key") => {
+export const registerZodRoutes = (parent: ServerRoute, router: any, keys: string[]) => {
   return keys.map((key) => {
-    defineZodRoute(parent, key, keyReplacer, router[key]);
+    defineZodRoute(parent, key, router[key]);
   });
 }
 
@@ -21,29 +21,28 @@ function buildPathRegex(path: string, key: string, keyReplacer: string) {
   if (key.startsWith(":")) throw new Error(`Key ${key} must not start with a colon`)
   if (path !== path.trim()) throw new Error(`Path ${path} must not have leading and trailing white space or line terminator characters`);
   const parts = path.split("/");
-  const final = path.endsWith("/");
+
   return "^" + parts.map((e, i) => {
 
     const last = i === parts.length - 1;
-    if (e.length === 0) {
+    if (e === "") {
       if (!last && i !== 0) throw new Error(`Path ${path} has an empty part at index ${i}`);
       return "";
     }
     const name = e.startsWith(":") && e.slice(1);
     if (e === keyReplacer) return key;
     if (!name) return e;
-    return (last && final) ? `(?<${name}>.+)` : `(?<${name}>[^/]+)`;
-  }).join("\\/") + (final ? "$" : "(?=\/)");
+    return (last && !path.endsWith("/")) ? `(?<${name}>.+)` : `(?<${name}>[^/]+)`;
+  }).join("/") + (path.endsWith("/") ? "(?=/)" : "$");
 }
 
 export function defineZodRoute(
   parent: ServerRoute,
   key: string,
-  keyReplacer: string,
   route: ZodRoute<any, any, any, any, any, any>
 ) {
   const {
-    method, path, bodyFormat, registerError,
+    method, path, bodyFormat, registerError, keyReplacer,
     zodPathParams,
     zodQueryParams = (z => ({}) as any),
     zodRequestBody = ["string", "json", "www-form-urlencoded"].includes(bodyFormat)
@@ -55,7 +54,7 @@ export function defineZodRoute(
   if (method.includes("OPTIONS"))
     throw new Error(key + " includes OPTIONS. Use corsRequest instead.");
 
-  const pathregex = typeof path === "string" ? buildPathRegex(path, key, keyReplacer) : path;
+  const pathregex = typeof path === "string" ? buildPathRegex(path, key, keyReplacer ?? "") : path;
 
   return parent.defineRoute({
     method,
diff --git a/packages/server/src/zodRoute.ts b/packages/server/src/zodRoute.ts
@@ -108,6 +108,14 @@ export interface ZodRoute<
    * 
    */
   path: string | RegExp;
+  /** 
+   * @internal - Mostly used internally. 
+   * 
+   * If specifed, it will be replaced with the provided key. 
+   * 
+   * 
+   */
+  keyReplacer?: string
   bodyFormat: B;
   registerError: Error;
   inner: (state: { [K in M]: ZodState<K, B, P, Q, T> }[M]) => Promise<R>;
diff --git a/public/react-admin/stats/server.json b/public/react-admin/stats/server.json

Original file line number	Diff line number	Diff line change
`@@ -42,9 +42,10 @@ declare module "@tiddlywiki/server" {`
`42`	`42`	`}`
`43`	`43`	`}`
`44`	`44`
	`45`	`+Router.allowedRequestedWithHeaders.TiddlyWiki = true;`
`45`	`46`
`46`	`47`	`serverEvents.on("listen.router.init", async (listen, router) => {`
`47`		`- router.allowedRequestedWithHeaders.push("TiddlyWiki");`
	`48`	`+`
`48`	`49`	`router.config = listen.config;`
`49`	`50`	`router.sendAdmin = await setupDevServer(listen.config);`
`50`	`51`	`router.createServerRequest = <B extends BodyFormat>(`