everything works well.

Author: omerman

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

@@ -327,7 +327,7 @@
         }
       ],
       "kind": "Interface",
-      "content": "```typescript\nexport interface RequestEventCommon<PLATFORM = QwikCityPlatform> extends RequestEventBase<PLATFORM> \n```\n**Extends:** [RequestEventBase](#requesteventbase)<!-- -->&lt;PLATFORM&gt;\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[error](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n&lt;T = any&gt;(statusCode: ErrorCodes, message: T) =&gt; [ServerError](#servererror)<!-- -->&lt;T&gt;\n\n\n</td><td>\n\nWhen called, the response will immediately end with the given status code. This could be useful to end a response with `404`<!-- -->, and use the 404 handler in the routes directory. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status for which status code should be used.\n\n\n</td></tr>\n<tr><td>\n\n[exit](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n() =&gt; [AbortMessage](#abortmessage)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[html](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(statusCode: StatusCodes, html: string) =&gt; [AbortMessage](#abortmessage)\n\n\n</td><td>\n\nConvenience method to send an HTML body response. The response will be automatically set the `Content-Type` header to`text/html; charset=utf-8`<!-- -->. An `html()` response can only be called once.\n\n\n</td></tr>\n<tr><td>\n\n[json](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(statusCode: StatusCodes, data: any) =&gt; [AbortMessage](#abortmessage)\n\n\n</td><td>\n\nConvenience method to JSON stringify the data and send it in the response. The response will be automatically set the `Content-Type` header to `application/json; charset=utf-8`<!-- -->. A `json()` response can only be called once.\n\n\n</td></tr>\n<tr><td>\n\n[locale](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(local?: string) =&gt; string\n\n\n</td><td>\n\nWhich locale the content is in.\n\nThe locale value can be retrieved from selected methods using `getLocale()`<!-- -->:\n\n\n</td></tr>\n<tr><td>\n\n[redirect](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(statusCode: RedirectCode, url: string) =&gt; [RedirectMessage](#redirectmessage)\n\n\n</td><td>\n\nURL to redirect to. When called, the response will immediately end with the correct redirect status and headers.\n\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Redirections\n\n\n</td></tr>\n<tr><td>\n\n[rewrite](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(url: string \\| URL, keepCurrentSearchParams?: boolean) =&gt; [RewriteMessage](#rewritemessage)\n\n\n</td><td>\n\nURL to rewrite to. When called, the flow will reset to display the given url route.\n\nURL will remain unchanged in the browser history.\n\n\n</td></tr>\n<tr><td>\n\n[send](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nSendMethod\n\n\n</td><td>\n\nSend a body response. The `Content-Type` response header is not automatically set when using `send()` and must be set manually. A `send()` response can only be called once.\n\n\n</td></tr>\n<tr><td>\n\n[status](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(statusCode?: StatusCodes) =&gt; number\n\n\n</td><td>\n\nHTTP response status code. Sets the status code when called with an argument. Always returns the status code, so calling `status()` without an argument will can be used to return the current status code.\n\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Status\n\n\n</td></tr>\n<tr><td>\n\n[text](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(statusCode: StatusCodes, text: string) =&gt; [AbortMessage](#abortmessage)\n\n\n</td><td>\n\nConvenience method to send an text body response. The response will be automatically set the `Content-Type` header to`text/plain; charset=utf-8`<!-- -->. An `text()` response can only be called once.\n\n\n</td></tr>\n</tbody></table>",
+      "content": "```typescript\nexport interface RequestEventCommon<PLATFORM = QwikCityPlatform> extends RequestEventBase<PLATFORM> \n```\n**Extends:** [RequestEventBase](#requesteventbase)<!-- -->&lt;PLATFORM&gt;\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[error](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n&lt;T = any&gt;(statusCode: ErrorCodes, message: T) =&gt; [ServerError](#servererror)<!-- -->&lt;T&gt;\n\n\n</td><td>\n\nWhen called, the response will immediately end with the given status code. This could be useful to end a response with `404`<!-- -->, and use the 404 handler in the routes directory. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status for which status code should be used.\n\n\n</td></tr>\n<tr><td>\n\n[exit](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n() =&gt; [AbortMessage](#abortmessage)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[html](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(statusCode: StatusCodes, html: string) =&gt; [AbortMessage](#abortmessage)\n\n\n</td><td>\n\nConvenience method to send an HTML body response. The response will be automatically set the `Content-Type` header to`text/html; charset=utf-8`<!-- -->. An `html()` response can only be called once.\n\n\n</td></tr>\n<tr><td>\n\n[json](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(statusCode: StatusCodes, data: any) =&gt; [AbortMessage](#abortmessage)\n\n\n</td><td>\n\nConvenience method to JSON stringify the data and send it in the response. The response will be automatically set the `Content-Type` header to `application/json; charset=utf-8`<!-- -->. A `json()` response can only be called once.\n\n\n</td></tr>\n<tr><td>\n\n[locale](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(local?: string) =&gt; string\n\n\n</td><td>\n\nWhich locale the content is in.\n\nThe locale value can be retrieved from selected methods using `getLocale()`<!-- -->:\n\n\n</td></tr>\n<tr><td>\n\n[redirect](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(statusCode: RedirectCode, url: string) =&gt; [RedirectMessage](#redirectmessage)\n\n\n</td><td>\n\nURL to redirect to. When called, the response will immediately end with the correct redirect status and headers.\n\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Redirections\n\n\n</td></tr>\n<tr><td>\n\n[rewrite](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(url: string \\| URL) =&gt; [RewriteMessage](#rewritemessage)\n\n\n</td><td>\n\nURL to rewrite to. When called, the flow will reset to display the given url route.\n\nURL will remain unchanged in the browser history.\n\nNote that if the url is a string without a protocol, the rewritten url will inherit the search params from the canonical url.\n\n\n</td></tr>\n<tr><td>\n\n[send](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nSendMethod\n\n\n</td><td>\n\nSend a body response. The `Content-Type` response header is not automatically set when using `send()` and must be set manually. A `send()` response can only be called once.\n\n\n</td></tr>\n<tr><td>\n\n[status](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(statusCode?: StatusCodes) =&gt; number\n\n\n</td><td>\n\nHTTP response status code. Sets the status code when called with an argument. Always returns the status code, so calling `status()` without an argument will can be used to return the current status code.\n\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Status\n\n\n</td></tr>\n<tr><td>\n\n[text](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(statusCode: StatusCodes, text: string) =&gt; [AbortMessage](#abortmessage)\n\n\n</td><td>\n\nConvenience method to send an text body response. The response will be automatically set the `Content-Type` header to`text/plain; charset=utf-8`<!-- -->. An `text()` response can only be called once.\n\n\n</td></tr>\n</tbody></table>",
       "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/request-handler/types.ts",
       "mdFile": "qwik-city.requesteventcommon.md"
     },

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

@@ -1343,14 +1343,16 @@ https://developer.mozilla.org/en-US/docs/Web/HTTP/Redirections
 
 </td><td>
 
-(url: string \| URL, keepCurrentSearchParams?: boolean) =&gt; [RewriteMessage](#rewritemessage)
+(url: string \| URL) =&gt; [RewriteMessage](#rewritemessage)
 
 </td><td>
 
 URL to rewrite to. When called, the flow will reset to display the given url route.
 
 URL will remain unchanged in the browser history.
 
+Note that if the url is a string without a protocol, the rewritten url will inherit the search params from the canonical url.
+
 </td></tr>
 <tr><td>
 

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

@@ -136,7 +136,7 @@ export interface RequestEventCommon<PLATFORM = QwikCityPlatform> extends Request
     readonly locale: (local?: string) => string;
     // Warning: (ae-forgotten-export) The symbol "RedirectCode" needs to be exported by the entry point index.d.ts
     readonly redirect: (statusCode: RedirectCode, url: string) => RedirectMessage;
-    readonly rewrite: (url: string | URL, keepCurrentSearchParams?: boolean) => RewriteMessage;
+    readonly rewrite: (url: string | URL) => RewriteMessage;
     // Warning: (ae-forgotten-export) The symbol "SendMethod" needs to be exported by the entry point index.d.ts
     readonly send: SendMethod;
     // Warning: (ae-forgotten-export) The symbol "StatusCodes" needs to be exported by the entry point index.d.ts

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

@@ -234,7 +234,7 @@ export function createRequestEvent(
       return new RedirectMessage();
     },
 
-    rewrite: (_rewriteUrl: string | URL, keepCurrentSearchParams = true) => {
+    rewrite: (_rewriteUrl: string | URL) => {
       check();
       let rewriteUrl: URL;
       if (typeof _rewriteUrl === 'string') {
@@ -250,6 +250,9 @@ export function createRequestEvent(
         rewriteUrl.pathname = fixedPathname;
       }
 
+      // Assume that if Devs passed a string without a protocol, they want to keep the current search
+      const keepCurrentSearchParams =
+        typeof _rewriteUrl === 'string' && !_rewriteUrl.startsWith('http');
       if (keepCurrentSearchParams) {
         url.searchParams.forEach((value, key) => {
           // rewriteUrl values should take precedence over current url values

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

@@ -208,10 +208,12 @@ export interface RequestEventCommon<PLATFORM = QwikCityPlatform>
    *
    * URL will remain unchanged in the browser history.
    *
+   * Note that if the url is a string without a protocol, the rewritten url will inherit the search
+   * params from the canonical url.
+   *
    * @param url - The url to rewrite to.
-   * @param keepCurrentSearchParams - Whether to keep the current search params.
    */
-  readonly rewrite: (url: string | URL, keepCurrentSearchParams?: boolean) => RewriteMessage;
+  readonly rewrite: (url: string | URL) => RewriteMessage;
 
   /**
    * When called, the response will immediately end with the given status code. This could be useful

starters/apps/qwikcity-test/src/routes/(common)/products/[id]/index.tsx

@@ -84,6 +84,15 @@ export default component$(() => {
             T-Shirt (Rewrite to /products/tshirt)
           </Link>
         </li>
+        <li>
+          <Link
+            href="/qwikcity-test/products/shirt-rewrite-plain_string"
+            data-test-link="products-shirt-rewrite-plain_string_no_trailing_slash"
+          >
+            T-Shirt (Rewrite to /products/tshirt) Also trailing slash should be
+            added.
+          </Link>
+        </li>
         <li>
           <Link
             href="/qwikcity-test/products/hoodie/"
@@ -155,12 +164,11 @@ export const useProductLoader = routeLoader$(
     }
 
     if (id === "shirt-rewrite-plain_string") {
-      // Rewrite, which should have the same effect as redirect but with keep the url
       throw rewrite("/qwikcity-test/products/tshirt/");
     }
 
     if (id === "shirt-rewrite-url_object") {
-      // Rewrite, which should have the same effect as redirect but with keep the url
+      // Rewrite with a URL object.
       throw rewrite(new URL("/qwikcity-test/products/tshirt/", url.origin));
     }
 

starters/e2e/qwikcity/page.spec.ts

@@ -134,6 +134,19 @@ function tests() {
         h1: "Product: tshirt",
         activeHeaderLink: "Products",
       });
+
+      /***********  Products: shirt (rewrite to /products/tshirt)  ***********/
+      await linkNavigate(
+        ctx,
+        '[data-test-link="products-shirt-rewrite-plain_string_no_trailing_slash"]',
+      );
+      await assertPage(ctx, {
+        pathname: "/qwikcity-test/products/shirt-rewrite-plain_string/",
+        title: "Product tshirt - Qwik",
+        layoutHierarchy: ["root"],
+        h1: "Product: tshirt",
+        activeHeaderLink: "Products",
+      });
     }
 
     /***********  Products: hoodie (404)  ***********/

starters/e2e/qwikcity/util.ts

@@ -23,6 +23,16 @@ export async function assertPage(ctx: TestContext, test: AssertPage) {
     expect(canonicalUrl.pathname).toBe(test.pathname);
   }
 
+  if (test.searchParams) {
+    if (test.searchParams === "empty") {
+      expect(pageUrl.searchParams.size).toBe(0);
+    } else {
+      for (const [key, value] of Object.entries(test.searchParams)) {
+        expect(pageUrl.searchParams.get(key)).toBe(value);
+      }
+    }
+  }
+
   if (test.title) {
     const title = head.locator("title");
     expect(await title.innerText()).toBe(test.title);
@@ -76,6 +86,7 @@ export async function assertPage(ctx: TestContext, test: AssertPage) {
 
 interface AssertPage {
   pathname?: string;
+  searchParams?: Record<string, string> | "empty";
   title?: string;
   h1?: string;
   layoutHierarchy?: string[];