unify preview server config #11289
unify preview server config #11289
Conversation
🦋 Changeset detectedLatest commit: 3feb8cd The changes in this PR will be included in the next version bump. 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: astro
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -0,0 +1,5 @@ | |||
| --- | |||
| 'astro': major | |||
There was a problem hiding this comment.
I don't know, after running pnpm exec changeset, major is the only option left
| 'astro': major | ||
| --- | ||
|
|
||
| unify preview server config |
There was a problem hiding this comment.
Can you leave a better explanation? Developers will read the changelog, and I doubt they will understand what "unify" means
There was a problem hiding this comment.
A more accurate description would be to keep Astro Preview behaving the same way as Vite Preview, supporting Vite Preview settings.
According to the Astro code, static previews are supported by default, but third-party adapter previews require additional support.
Developers are usually in charge of updating the docs. Could you send a PR to update the docs? Or at least, which docs should be updated? |
| const previewConfig = Object.assign({}, | ||
| settings.config.vite.server, | ||
| settings.config.vite.preview, | ||
| settings.config.server, | ||
| ) |
There was a problem hiding this comment.
I don't think this is correct. If you want to configure the Astro preview server, you should use the config.server config. Not every Vite options should take effect when a framework builds on top of it.
Also, settings.config.vite.server is for the dev server, and settings.config.vite.preview is for the preview server. We can't merge it like this.
There was a problem hiding this comment.
According to the official Vite documentation, vite preview uses the Vite Server configuration by default. Astro is built on Vite, but doesn't use Vite's Server configuration, which is very strange. (The proxy configuration in Dev and Preview is very useful for this purpose.
Anyway, the above code just keeps Astro Preview behavior consistent with Vite Preview, and is technically a bug fix.
There was a problem hiding this comment.
Astro preview does use the Vite preview server internally, but we don't document that the Vite server/preview options will strictly work when configured. Editing this part of the code is also sensitive because you're passing all the Vite-specific server/preview options to previewModule.default directly.
We're currently intentionally limiting the options here because it would be expected for all adapters to support the same set of features, but not all adapters use the Vite preview server. That way, the adapters need to only concern of supporting features from config.server.
If this is about the proxy config, it leans towards a feature request, not a bug fix. I could see perhaps passing that only to previewModule.default and update the types to be optional, and adapters could decide to support it. But I'd like to hear what others think of this.
There was a problem hiding this comment.
Got it. What I need is proxy, it can be approached by configuring vite.server on astro dev, but doesn't work on astro preview.
The Server Options may need update according to Vite Preview Options |
Changes
Merge preview server config by:
Make the preview server can access all server config from
vite.server/vite.preview/server.Especially, this make preview server access
proxysettings from these objects which allow preview proxy api request just like dev server!Testing
astro.config.tsastro previewand check networkDocs
This PR adds new feature to
astro preview, docs should be updated