CR fixes -2-

Author: omerman

packages/docs/src/routes/api/qwik-city-middleware-request-handler/api.json

@@ -261,6 +261,23 @@
       "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/request-handler/cookie.ts",
       "mdFile": "qwik-city.mergeheaderscookies.md"
     },
+    {
+      "name": "pathname",
+      "id": "rewritemessage-pathname",
+      "hierarchy": [
+        {
+          "name": "RewriteMessage",
+          "id": "rewritemessage-pathname"
+        },
+        {
+          "name": "pathname",
+          "id": "rewritemessage-pathname"
+        }
+      ],
+      "kind": "Property",
+      "content": "```typescript\nreadonly pathname: string;\n```",
+      "mdFile": "qwik-city.rewritemessage.pathname.md"
+    },
     {
       "name": "RedirectMessage",
       "id": "redirectmessage",
@@ -411,7 +428,7 @@
         }
       ],
       "kind": "Class",
-      "content": "```typescript\nexport declare class RewriteMessage extends AbortMessage \n```\n**Extends:** [AbortMessage](#abortmessage)",
+      "content": "```typescript\nexport declare class RewriteMessage extends AbortMessage \n```\n**Extends:** [AbortMessage](#abortmessage)\n\n\n<table><thead><tr><th>\n\nConstructor\n\n\n</th><th>\n\nModifiers\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[(constructor)(pathname)](#)\n\n\n</td><td>\n\n\n</td><td>\n\nConstructs a new instance of the `RewriteMessage` class\n\n\n</td></tr>\n</tbody></table>\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[pathname](#rewritemessage-pathname)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
       "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/request-handler/rewrite-handler.ts",
       "mdFile": "qwik-city.rewritemessage.md"
     },

packages/docs/src/routes/api/qwik-city-middleware-request-handler/index.mdx

@@ -717,6 +717,12 @@ Headers
 
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/request-handler/cookie.ts)
 
+## pathname
+
+```typescript
+readonly pathname: string;
+```
+
 ## RedirectMessage
 
 ```typescript
@@ -1512,6 +1518,66 @@ export declare class RewriteMessage extends AbortMessage
 
 **Extends:** [AbortMessage](#abortmessage)
 
+<table><thead><tr><th>
+
+Constructor
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(pathname)](#)
+
+</td><td>
+
+</td><td>
+
+Constructs a new instance of the `RewriteMessage` class
+
+</td></tr>
+</tbody></table>
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[pathname](#rewritemessage-pathname)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+</td></tr>
+</tbody></table>
+
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/request-handler/rewrite-handler.ts)
 
 ## ServerError

packages/qwik-city/src/middleware/request-handler/middleware.request-handler.api.md

@@ -178,6 +178,9 @@ export interface ResolveValue {
 
 // @public (undocumented)
 export class RewriteMessage extends AbortMessage {
+    constructor(pathname: string);
+    // (undocumented)
+    readonly pathname: string;
 }
 
 // @public (undocumented)

packages/qwik-city/src/middleware/request-handler/request-event.ts

@@ -37,6 +37,7 @@ export const RequestRouteName = '@routeName';
 export const RequestEvSharedActionId = '@actionId';
 export const RequestEvSharedActionFormData = '@actionFormData';
 export const RequestEvSharedNonce = '@nonce';
+export const RequestEvIsRewrite = '@rewrite';
 
 export function createRequestEvent(
   serverRequestEv: ServerRequestEvent,
@@ -249,19 +250,8 @@ export function createRequestEvent(
       if (pathname.startsWith('http')) {
         throw new Error('Rewrite does not support absolute urls');
       }
-
-      const rewriteUrl = new URL(url);
-      rewriteUrl.pathname = pathname;
-
-      // Fix consecutive slashes - e.g //path//to//page -> /path/to/page
-      const fixedPathname = rewriteUrl.pathname.replace(/(^|[^:])\/{2,}/g, '$1/');
-      if (rewriteUrl.pathname !== fixedPathname) {
-        console.warn(`Rewrite URL ${rewriteUrl.pathname} is invalid, fixing to ${fixedPathname}`);
-        rewriteUrl.pathname = fixedPathname;
-      }
-
-      headers.set('Rewrite-Location', rewriteUrl.toString());
-      return new RewriteMessage();
+      sharedMap.set(RequestEvIsRewrite, true);
+      return new RewriteMessage(pathname.replace(/\/+/g, '/'));
     },
 
     defer: (returnData) => {

packages/qwik-city/src/middleware/request-handler/resolve-request-handlers.ts

@@ -14,9 +14,9 @@ import type {
 } from '../../runtime/src/types';
 import { HttpStatus } from './http-status-codes';
 import { RedirectMessage } from './redirect-handler';
-import { RewriteMessage } from './rewrite-handler';
 import {
   RequestEvQwikSerializer,
+  RequestEvIsRewrite,
   RequestEvSharedActionId,
   RequestRouteName,
   getRequestLoaders,
@@ -79,7 +79,6 @@ export const resolveRequestHandlers = (
     }
     const routeModules = route[2];
     requestHandlers.push(handleRedirect);
-    requestHandlers.push(handleRewrite);
     _resolveRequestHandlers(
       routeLoaders,
       routeActions,
@@ -536,39 +535,6 @@ export async function handleRedirect(requestEv: RequestEvent) {
   }
 }
 
-export async function handleRewrite(requestEv: RequestEvent) {
-  const isPageDataReq = requestEv.sharedMap.has(IsQData);
-  if (!isPageDataReq) {
-    return;
-  }
-  try {
-    await requestEv.next();
-  } catch (err) {
-    if (!(err instanceof RewriteMessage)) {
-      throw err;
-    }
-  }
-
-  if (requestEv.headersSent) {
-    return;
-  }
-
-  const status = requestEv.status();
-  const location = requestEv.headers.get('Rewrite-Location');
-  const isRewrite = status === 200 && location;
-
-  if (isRewrite) {
-    const adaptedLocation = makeQDataPath(location);
-
-    if (adaptedLocation) {
-      requestEv.headers.set('Rewrite-Location', adaptedLocation);
-      return;
-    } else {
-      requestEv.status(200);
-    }
-  }
-}
-
 export async function renderQData(requestEv: RequestEvent) {
   const isPageDataReq = requestEv.sharedMap.has(IsQData);
   if (!isPageDataReq) {
@@ -582,7 +548,6 @@ export async function renderQData(requestEv: RequestEvent) {
 
   const status = requestEv.status();
   const redirectLocation = requestEv.headers.get('Location');
-  const rewriteLocation = requestEv.headers.get('Rewrite-Location');
   const trailingSlash = getRequestTrailingSlash(requestEv);
 
   const requestHeaders: Record<string, string> = {};
@@ -595,7 +560,7 @@ export async function renderQData(requestEv: RequestEvent) {
     status: status !== 200 ? status : 200,
     href: getPathname(requestEv.url, trailingSlash),
     redirect: redirectLocation ?? undefined,
-    rewrite: rewriteLocation ?? undefined,
+    isRewrite: requestEv.sharedMap.get(RequestEvIsRewrite),
   };
   const writer = requestEv.getWritableStream().getWriter();
   const qwikSerializer = (requestEv as RequestEventInternal)[RequestEvQwikSerializer];

packages/qwik-city/src/middleware/request-handler/rewrite-handler.ts

@@ -1,4 +1,8 @@
 import { AbortMessage } from './redirect-handler';
 
 /** @public */
-export class RewriteMessage extends AbortMessage {}
+export class RewriteMessage extends AbortMessage {
+  constructor(readonly pathname: string) {
+    super();
+  }
+}

packages/qwik-city/src/middleware/request-handler/user-response.ts

@@ -68,11 +68,8 @@ async function runNext(
   resolve: (value: any) => void
 ) {
   let rewriteAttempt = 1;
-  let didRewrite = false;
 
   async function _runNext() {
-    didRewrite = false;
-
     try {
       // Run all middlewares
       await requestEv.next();
@@ -85,7 +82,12 @@ async function runNext(
           throw new Error(`Rewrite failed - Max rewrite attempts reached: ${rewriteAttempt - 1}`);
         }
 
-        didRewrite = true;
+        rewriteAttempt += 1;
+        const url = new URL(requestEv.url);
+        url.pathname = e.pathname;
+        const { loadedRoute, requestHandlers } = await rebuildRouteInfo(url);
+        requestEv.resetRoute(loadedRoute, requestHandlers, url);
+        return await _runNext();
       } else if (e instanceof ServerError) {
         if (!requestEv.headersSent) {
           const status = e.status as StatusCodes;
@@ -117,6 +119,7 @@ async function runNext(
             console.error('Unable to render error page');
           }
         }
+
         return e;
       }
     }
@@ -125,16 +128,7 @@ async function runNext(
   }
 
   try {
-    let runResult = await _runNext();
-    if (didRewrite) {
-      rewriteAttempt += 1;
-      const url = new URL(requestEv.headers.get('Rewrite-Location')!);
-      const { loadedRoute, requestHandlers } = await rebuildRouteInfo(url);
-      requestEv.resetRoute(loadedRoute, requestHandlers, url);
-      runResult = await _runNext();
-    }
-
-    return runResult;
+    return await _runNext();
   } finally {
     if (!requestEv.isDirty()) {
       resolve(null);

packages/qwik-city/src/runtime/src/qwik-city-component.tsx

@@ -346,15 +346,15 @@ export const QwikCityProvider = component$<QwikCityProps>((props) => {
         const newURL = new URL(newHref, trackUrl);
         if (!isSamePath(newURL, trackUrl)) {
           // Change our path to the canonical path in the response unless rewrite.
-          if (!pageData.rewrite) {
+          if (!pageData.isRewrite) {
             trackUrl = newURL;
           }
 
           loadRoutePromise = loadRoute(
             qwikCity.routes,
             qwikCity.menus,
             qwikCity.cacheModules,
-            newURL.pathname // Load the canonical path.
+            newURL.pathname // Load the actual required path.
           );
         }
 

packages/qwik-city/src/runtime/src/types.ts

@@ -311,7 +311,7 @@ export interface ClientPageData extends Omit<EndpointResponse, 'status'> {
   status: number;
   href: string;
   redirect?: string;
-  rewrite?: string;
+  isRewrite?: boolean;
 }
 
 /** @public */