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
7 changes: 7 additions & 0 deletions .changeset/expose-h3-request-event-decorators.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"@solidjs/start": minor
---

Expose experimental `decorateHandler` and `decorateMiddleware` helpers from
`@solidjs/start/server` for providing Solid's request context to custom h3 handlers and
middleware.
40 changes: 39 additions & 1 deletion packages/start/src/server/fetchEvent.spec.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
import * as h3 from "h3";
import { getRequestEvent } from "solid-js/web";
import { beforeEach, describe, expect, it, vi } from "vitest";

import { createFetchEvent, getFetchEvent, mergeResponseHeaders } from "./fetchEvent.ts";
import {
createFetchEvent,
decorateHandler,
decorateMiddleware,
getFetchEvent,
mergeResponseHeaders,
} from "./fetchEvent.ts";

vi.mock(import("h3"), async mod => {
return {
Expand Down Expand Up @@ -82,4 +89,35 @@ describe("fetchEvent", () => {
expect(headers.get("x-custom")).toBe("value");
});
});

describe("decorateHandler", () => {
it("provides the FetchEvent while the handler runs", async () => {
const handler = decorateHandler(async event => {
await Promise.resolve();
expect(getRequestEvent()).toBe(getFetchEvent(event));
return "handled";
});

expect(await handler(mockH3Event)).toBe("handled");
});
});

describe("decorateMiddleware", () => {
it("provides the FetchEvent while the middleware runs", async () => {
const next = vi.fn(async () => {
await Promise.resolve();
expect(getRequestEvent()).toBe(getFetchEvent(mockH3Event));
return "next";
});
const middleware = decorateMiddleware(async (event, middlewareNext) => {
expect(getRequestEvent()).toBe(getFetchEvent(event));
const result = await middlewareNext();
expect(getRequestEvent()).toBe(getFetchEvent(event));
return result;
});

expect(await middleware(mockH3Event, next)).toBe("next");
expect(next).toHaveBeenCalledOnce();
});
});
});
10 changes: 10 additions & 0 deletions packages/start/src/server/fetchEvent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,18 @@ export function mergeResponseHeaders(h3Event: H3Event, headers: Headers) {
}
}

/**
* Wrap an h3 event handler so Solid's request context is available while it runs.
*
* @experimental
*/
export const decorateHandler = <T extends EventHandler>(fn: T) =>
(event => provideRequestEvent(getFetchEvent(event), () => fn(event))) as T;

/**
* Wrap h3 middleware so Solid's request context is available while it runs.
*
* @experimental
*/
export const decorateMiddleware = <T extends Middleware>(fn: T) =>
((event, next) => provideRequestEvent(getFetchEvent(event), () => fn(event, next))) as T;
1 change: 1 addition & 0 deletions packages/start/src/server/index.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
export { default as lazy } from "../shared/lazy.ts";
export { getServerFunctionMeta } from "../shared/serverFunction.ts";
export { StartServer } from "./StartServer.tsx";
export { decorateHandler, decorateMiddleware } from "./fetchEvent.ts";
export { createHandler } from "./handler.ts";

export type {
Expand Down
Loading