Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/tired-spies-call.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@builder.io/qwik-city': patch
---

FIX: Duplicate ServerError class during dev mode
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
}

Expand All @@ -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")
);
}


```
Original file line number Diff line number Diff line change
@@ -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';
Expand Down
Original file line number Diff line number Diff line change
@@ -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';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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,
Expand Down
Original file line number Diff line number Diff line change
@@ -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);
}
}
Original file line number Diff line number Diff line change
@@ -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';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import type { RequestEvent, RequestHandler } from '@builder.io/qwik-city';
import type { RebuildRouteInfoInternal, LoadedRoute } from '../../runtime/src/types';
import { ServerError, getErrorHtml, minimalHtmlResponse } from './error-handler';
import { AbortMessage, RedirectMessage } from './redirect-handler';
import type { LoadedRoute, RebuildRouteInfoInternal } from '../../runtime/src/types';
import { getErrorHtml } from './error-handler';
import {
RequestEvQwikSerializer,
createRequestEvent,
Expand All @@ -10,7 +9,13 @@ import {
} from './request-event';
import { encoder } from './resolve-request-handlers';
import type { QwikSerializer, ServerRequestEvent, StatusCodes } from './types';
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';

export interface QwikCityRun<T> {
response: Promise<T | null>;
Expand Down Expand Up @@ -112,7 +117,7 @@ async function runNext(
const stream = requestEv.getWritableStream();
if (!stream.locked) {
const writer = stream.getWriter();
await writer.write(encoder.encode(minimalHtmlResponse(500, 'Internal Server Error')));
await writer.write(encoder.encode(getErrorHtml(500, 'Internal Server Error')));
await writer.close();
}
} catch {
Expand Down
1 change: 1 addition & 0 deletions scripts/qwik-city.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ async function buildVite(config: BuildConfig) {
'typescript',
'vite-imagetools',
'svgo',
'@builder.io/qwik-city/middleware/request-handler',
];

const swRegisterPath = join(config.srcQwikCityDir, 'runtime', 'src', 'sw-register.ts');
Expand Down
12 changes: 2 additions & 10 deletions starters/apps/qwikcity-test/src/routes/[email protected]
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
import { type RequestHandler } from "@builder.io/qwik-city";
import { ServerError } from "@builder.io/qwik-city/middleware/request-handler";
import { isDev } from "@builder.io/qwik/build";
import { isErrorReason } from "./(common)/server-func/server-error";

export const onRequest: RequestHandler = async ({ next, error }) => {
export const onRequest: RequestHandler = async ({ next }) => {
try {
return await next();
} catch (err) {
// Intercept and update ServerErrors to test middleware
if (isServerError(err)) {
if (err instanceof ServerError) {
// Update for (common)/server-func/server-error
if (isErrorReason(err.data)) {
err.data.middleware = "server-error-caught";
Expand All @@ -23,10 +22,3 @@ export const onRequest: RequestHandler = async ({ next, error }) => {
throw err;
}
};

function isServerError(err: unknown): err is ServerError {
return (
err instanceof ServerError ||
(isDev && err instanceof Error && err.constructor.name === "ServerError")
);
}
Loading