-
-
Notifications
You must be signed in to change notification settings - Fork 899
feat: apply server entry middleware and plugins on all presets #4632
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
pi0x
wants to merge
6
commits into
main
Choose a base branch
from
feat/generic-server-opts
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
bdacae0
feat(presets): apply server entry middleware and plugins on all presets
pi0 de3b1c2
refactor: compose server entry middleware without srvx/generic
pi0 7cee1c7
refactor: apply server entry options in useNitroApp().fetch
pi0 f5c0b96
fix: use srvx server middleware for useNitroApp().fetch on server pre…
pi0 fc9be05
refactor: register app fetch plugin in resolveServeOptions
pi0 d117bdb
refactor: move appFetchPlugin to serve runtime
pi0 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| import type { Server, ServerHandler, ServerRequest } from "srvx"; | ||
| import { serverEntryOptions } from "#nitro/virtual/server-entry"; | ||
|
|
||
| /** | ||
| * Apply server entry `middleware`, `plugins` and `error` options to the Nitro app fetch handler. | ||
| * | ||
| * Plugins are called with a minimal server object (`runtime` and `options`) on first request. | ||
| * Presets starting a srvx server replace it (see `appFetchPlugin`). | ||
| */ | ||
| export function withServerEntryOptions< | ||
| T extends (req: ServerRequest) => Response | Promise<Response>, | ||
| >(fetch: T): T { | ||
| const { middleware, plugins, error } = serverEntryOptions; | ||
| if (!middleware?.length && !plugins?.length && !error) { | ||
| return fetch; | ||
| } | ||
| let handler: ServerHandler | undefined; | ||
| return ((req: ServerRequest) => (handler ??= createGenericFetch(fetch))(req)) as T; | ||
| } | ||
|
|
||
| function createGenericFetch(fetch: ServerHandler): ServerHandler { | ||
| const server = { | ||
| runtime: "generic", | ||
| options: { | ||
| ...serverEntryOptions, | ||
| fetch, | ||
| middleware: [...(serverEntryOptions.middleware || [])], | ||
| }, | ||
| } as unknown as Server; | ||
| try { | ||
| for (const plugin of serverEntryOptions.plugins || []) { | ||
| plugin(server); | ||
| } | ||
| } catch (error) { | ||
| return () => Promise.reject(error); | ||
| } | ||
| return composeFetch(server, true); | ||
| } | ||
|
|
||
| export function composeFetch(server: Server, withError: boolean): ServerHandler { | ||
| const { middleware, error } = server.options; | ||
| let handler = server.options.fetch; | ||
| for (let i = middleware.length - 1; i >= 0; i--) { | ||
| const mw = middleware[i]!; | ||
| const next = handler; | ||
| handler = (req) => mw(req, () => next(req)); | ||
| } | ||
| if (withError && error) { | ||
| const next = handler; | ||
| handler = async (req) => { | ||
| try { | ||
| return await next(req); | ||
| } catch (error_) { | ||
| return error(error_); | ||
| } | ||
| }; | ||
| } | ||
| return handler; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| import { defineHandler } from "nitro"; | ||
| import { useNitroApp } from "nitro/app"; | ||
| import { srvxPluginRuns } from "../../utils/srvx-plugin.ts"; | ||
|
|
||
| export default defineHandler(async () => { | ||
| const res = await useNitroApp().fetch(new Request("http://localhost/srvx-middleware")); | ||
| return { | ||
| body: await res.text(), | ||
| plugin: res.headers.get("x-srvx-plugin"), | ||
| pluginRuns: srvxPluginRuns.count, | ||
| }; | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export const srvxPluginRuns = { count: 0 }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Correct the plugin lifecycle description.
This sentence states that
pluginsrun for every request. Line 173 states that plugins run once on the first request for non-server presets. State that middleware runs per request and plugins initialize the server or app handler once.Based on PR objectives: “plugins on the first request.”
🧰 Tools
🪛 LanguageTool
[grammar] ~140-~140: Use a hyphen to join words.
Context: ...trustProxy
,gracefulShutdown, runtime specific settings (node,bun,deno`...(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents