Merge pull request #7724 from QwikDev/fix-qc-dev-ServerError

fix(qwik-city): duplicate ServerError class during dev

Author: wmertens

.changeset/tired-spies-call.md

@@ -0,0 +1,5 @@
+---
+'@builder.io/qwik-city': patch
+---
+
+FIX: Duplicate ServerError class during dev mode

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

@@ -443,7 +443,7 @@
       ],
       "kind": "Class",
       "content": "```typescript\nexport declare class ServerError<T = any> extends Error \n```\n**Extends:** Error\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)(status, data)](#)\n\n\n</td><td>\n\n\n</td><td>\n\nConstructs a new instance of the `ServerError` 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[data](#servererror-data)\n\n\n</td><td>\n\n\n</td><td>\n\nT\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[status](#servererror-status)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\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/error-handler.ts",
+      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/request-handler/server-error.ts",
       "mdFile": "qwik-city.servererror.md"
     },
     {

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

@@ -1659,7 +1659,7 @@ number
 </td></tr>
 </tbody></table>
 
-[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/request-handler/error-handler.ts)
+[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/request-handler/server-error.ts)
 
 ## ServerRenderOptions
 

packages/docs/src/routes/docs/(qwikcity)/error-handling/index.mdx

@@ -66,20 +66,20 @@ Intercepting errors with middleware has a few usecases: you might want to hide e
 ```tsx
 // src/routes/[email protected]
 import { type RequestHandler } from '@builder.io/qwik-city'
-import { RedirectMessage } from '@builder.io/qwik-city/middleware/request-handler'
+import { RedirectMessage, ServerError } from '@builder.io/qwik-city/middleware/request-handler'
 import { isDev } from '@builder.io/qwik/build'
 
 export const onRequest: RequestHandler = async ({ next }) => {
   try {
     return await next();
   } catch (err) {
     // Pass through 3xx redirects
-    if (isRedirectMessage(err)) {
+    if (err instanceof RedirectMessage) {
       throw err
     }
 
     // Pass through ServerErrors
-    if (isServerError(err)) {
+    if (err instanceof ServerError) {
       throw err
     }
 
@@ -94,19 +94,6 @@ export const onRequest: RequestHandler = async ({ next }) => {
   }
 };
 
-function isServerError(err: unknown): err is ServerError {
-  return (
-    err instanceof ServerError ||
-    // This is required for dev environments due to an issue with vite: https://github.com/vitejs/vite/issues/3910
-    (isDev && err instanceof Error && err.constructor.name === "ServerError")
-  );
-}
-
-function isRedirectMessage(err: unknown): err is RedirectMessage {
-  return (
-    err instanceof RedirectMessage ||
-    // This is required for dev environments due to an issue with vite: https://github.com/vitejs/vite/issues/3910
-    (isDev && err instanceof Error && err.constructor.name === "RedirectMessage")
-  );
-}
+
+
 ```

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

@@ -1,23 +1,3 @@
-/** @public */
-export class ServerError<T = any> extends Error {
-  constructor(
-    public status: number,
-    public data: T
-  ) {
-    super(typeof data === 'string' ? data : undefined);
-  }
-}
-
-/** @deprecated */
-export class ErrorResponse extends ServerError {
-  constructor(
-    public status: number,
-    message?: string
-  ) {
-    super(status, message);
-  }
-}
-
 /** @public */
 export function getErrorHtml(status: number, e: any) {
   let message = 'Server Error';

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

@@ -1,5 +1,6 @@
-export { getErrorHtml, ServerError } from './error-handler';
+export { getErrorHtml } from './error-handler';
 export { mergeHeadersCookies } from './cookie';
+export { ServerError } from './server-error';
 export { AbortMessage, RedirectMessage } from './redirect-handler';
 export { RewriteMessage } from './rewrite-handler';
 export { requestHandler } from './request-handler';

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

@@ -10,9 +10,13 @@ import type {
 import { isPromise } from './../../runtime/src/utils';
 import { createCacheControl } from './cache-control';
 import { Cookie } from './cookie';
-import { ServerError } from './error-handler';
-import { AbortMessage, RedirectMessage } from './redirect-handler';
-import { RewriteMessage } from './rewrite-handler';
+// Import separately to avoid duplicate imports in the vite dev server
+import {
+  AbortMessage,
+  RedirectMessage,
+  ServerError,
+  RewriteMessage,
+} from '@builder.io/qwik-city/middleware/request-handler';
 import { encoder } from './resolve-request-handlers';
 import type {
   CacheControl,

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

@@ -13,7 +13,6 @@ import type {
   ValidatorReturn,
 } from '../../runtime/src/types';
 import { HttpStatus } from './http-status-codes';
-import { RedirectMessage } from './redirect-handler';
 import {
   RequestEvQwikSerializer,
   RequestEvIsRewrite,
@@ -33,7 +32,8 @@ import type {
   RequestHandler,
 } from './types';
 import { IsQData, QDATA_JSON } from './user-response';
-import { ServerError } from './error-handler';
+// Import separately to avoid duplicate imports in the vite dev server
+import { RedirectMessage, ServerError } from '@builder.io/qwik-city/middleware/request-handler';
 
 export const resolveRequestHandlers = (
   serverPlugins: RouteModule[] | undefined,

packages/qwik-city/src/middleware/request-handler/server-error.ts

@@ -0,0 +1,19 @@
+/** @public */
+export class ServerError<T = any> extends Error {
+  constructor(
+    public status: number,
+    public data: T
+  ) {
+    super(typeof data === 'string' ? data : undefined);
+  }
+}
+/** @deprecated */
+
+export class ErrorResponse extends ServerError {
+  constructor(
+    public status: number,
+    message?: string
+  ) {
+    super(status, message);
+  }
+}

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

@@ -1,7 +1,7 @@
 import type { _deserializeData, _serializeData, _verifySerializable } from '@builder.io/qwik';
 import type { Action, FailReturn, Loader, QwikCityPlan } from '@builder.io/qwik-city';
 import type { Render, RenderOptions } from '@builder.io/qwik/server';
-import type { ServerError } from './error-handler';
+import type { ServerError } from './server-error';
 import type { AbortMessage, RedirectMessage } from './redirect-handler';
 import type { RequestEventInternal } from './request-event';
 import type { RewriteMessage } from './rewrite-handler';