feat: create new middleware mode "on-request"#15686
Open
leekeh wants to merge 41 commits into
Open
Conversation
🦋 Changeset detectedLatest commit: 505f298 The changes in this PR will be included in the next version bump. This PR includes changesets to release 396 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
Bot
added
pkg: integration
Merging this PR will degrade performance by 23.7%
Warning Please fix the performance issues or acknowledge them on CodSpeed. Performance Changes
Tip Investigate this regression by commenting Comparing 
|
Contributor
Author
|
This is for sure not done yet, but the changes in the core and node lib seem to be functional in the example project. Therefore I wanted to check in what you think of the direction I'm taking, before I start streamlining/cleaning things up, writing docs, etc. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Member
|
Hello! We require new features to be accepted through our RFC process in https://github.com/withastro/roadmap/ first, so I’m closing this until the discussions there are concluded. |
Member
|
For this it's not necessary, and I already spoke with @leekeh about this feature and it was ok to land it. It's an enhancement of something we already have, so an RFC isn't needed |
Member
|
Sorry about that, I didn't have that context. Thanks for reopening @ematipico and thanks for the work @leekeh! |
Contributor
Author
Thanks and no worries! I will try to put some more effort into this one soon also 🙏 Initial feedback is already welcome :) |
# Conflicts: # packages/astro/src/core/pages/handler.ts
- Make ResolvedRenderOptions.getStaticAsset optional and drop the now-redundant getStaticAsset: undefined from test literals - Remove vestigial process.env.PRERENDER from node prerender tests (never read) - Clarify #renderStaticAsset status logic (200 treated as unset)
leekeh
marked this pull request as ready for review
June 22, 2026 15:03
leekeh
changed the title
"always" and "on-request""on-request"
ematipico
reviewed
Jul 6, 2026
Comment on lines
+12
to
+26
| fixture = await loadFixture({ | ||
| root: './fixtures/middleware-static/', | ||
| output: 'server', | ||
| outDir: './dist/middleware-static', | ||
| adapter: testAdapter({ | ||
| extendAdapter: { | ||
| adapterFeatures: { | ||
| buildOutput: 'server', | ||
| middlewareMode: 'on-request', | ||
| }, | ||
| }, | ||
| }), | ||
| }); | ||
| await fixture.build(); | ||
| app = await fixture.loadTestAdapterApp(); |
Member
There was a problem hiding this comment.
I don't think we need a fixture. We have middleware-app.test.ts, which simulates a full-fledge app. Since middleware is purely routing, and we don't need any build artefact, we can unit test things
| * @param {string} pathname - The current request pathname (base-stripped). | ||
| * @returns {Promise<Response | undefined>} A prerendered response, or undefined if not found. | ||
| */ | ||
| getStaticAsset?: (route: RouteData, pathname: string) => Promise<Response | undefined>; |
Member
There was a problem hiding this comment.
This is a new feature, so it needs a changeset. Also, why would the function return undefined? Worth mentioning it in the docs. I would also expand the type and return | undefined
Comment on lines
+83
to
+90
| /** | ||
| * Whether this pipeline runs during `astro build` static generation | ||
| * (i.e. real prerendering). `false` for dev and request-time pipelines. | ||
| * Overridden to `true` by `BuildPipeline`. Used to decide whether | ||
| * `on-request` middleware should be skipped (skipped at build, run at | ||
| * request time). | ||
| */ | ||
| readonly isBuildTime: boolean = false; |
Member
There was a problem hiding this comment.
We already have a isDev function. We should mimic that instead.
| body, | ||
| logger: self.logger, | ||
| isPrerendered: matchedRoute.routeData.prerender, | ||
| isPrerendered: matchedRoute.routeData.prerender && !middlewareHandlesPrerendered, |
Member
There was a problem hiding this comment.
Isn't there another way to add this check? We're polluting isPrerendered with a value that doesn't belong to it
Comment on lines
+76
to
+82
| const response = await readPageFromDisk( | ||
| client, | ||
| getStaticAssetPath('/500', { | ||
| base: app.manifest.base, | ||
| buildFormat: app.manifest.buildFormat, | ||
| }), | ||
| ); |
Member
There was a problem hiding this comment.
This code seems to have lost functionality. Before, we were checking two files
const filePaths = [`${status}.html`, `${status}/index.html`];Now this functionality seems to be lost or ... I don't know, somewhere I can't see?
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Implement the work needed to make middleware run properly on request of static pages. Prerendered pages are stored and read from the disk, but the middleware will run first, if the user has turned on one of these new middleware modes.
Changes
on-requestmiddleware modeContext
Currently, middleware runs on static pages during build, and on dynamic pages after build. There is the need to customize this behavior, specifically to run middleware on static pages, for example to add an authentication check.
A first step was to refactor the code a bit to create the
middlewareModeadapter feature in #15495This PR implements the
on-requestandalwaysmiddleware modes."classic"(default)"always""on-request""edge"edgeMiddlewareconfig option.Related discussions:
Testing
Test cases were added on the core lib, expanding the app middleware tests and adding a static middleware test.
Tests were added for node, adding onto the prerendering fixture.
Docs
Docs added/updated :) For now in draft, want to see what you guys think of the implementation first.
withastro/docs#14117
/cc @withastro/maintainers-docs for feedback!