Node.js standalone mode + support for astro preview#5056
Merged
Conversation
🦋 Changeset detectedLatest commit: e7a9bd9 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}
matthewp
commented
Oct 11, 2022
Contributor
Author
|
!preview |
Contributor
|
Invalid comment format. Expected: "!preview " |
Contributor
Author
|
!preview node-standalone |
Contributor
|
Contributor
Author
|
Released a snapshot for this which can be installed with: npm install astro@next--node-standalone @astrojs/node@next--node-standalone |
FredKSchott
approved these changes
Oct 11, 2022
Member
FredKSchott
left a comment
FredKSchott
left a comment
There was a problem hiding this comment.
LGTM! Flagging @withastro/maintainers-docs for a review of the types additions.
|
|
||
| export default defineConfig({ | ||
| output: 'server', | ||
| build: { |
Member
There was a problem hiding this comment.
nice! This makes a lot of sense!
|
|
||
| See the @astrojs/node documentation to learn all of the options available in standalone mode. | ||
|
|
||
| ## Breaking change |
Member
There was a problem hiding this comment.
thinking more about this, if you default to middleware and make this option required, do you still need the major version?
Contributor
Author
There was a problem hiding this comment.
It wouldn't be required if it had a default, no?
We could default to middleware. My thought was that these two modes are pretty significantly different and it didn't feel right to "prefer" one over the other. Kind of like Vercel serverless vs edge, just completely different things.
As far as semver, given that this is an integration I didn't think it mattered as much to do a semver major change.
But I don't feel too strongly on either of these things.
Member
There was a problem hiding this comment.
yea, agreed that because its an integration this doesn't matter as much / I'm okay with the plan for a major. And I agree it makes more sense as required, or as defaulting to standalone. Defaulting to middleware is probably the least natural of the 3...
Contributor
Author
There was a problem hiding this comment.
Ok, I think we should do a major in that case and require the option. We can track usage in the future and if standalone is overwhelming (and once it becomes more stable) we can make it the default if we want to.
sarah11918
reviewed
Oct 12, 2022
Member
sarah11918
left a comment
sarah11918
left a comment
There was a problem hiding this comment.
Just left a few text suggestions to consider, and one other thing you might want to consider is a link or note to these new server configs around line 400ish from outputDir, to make it known that they exist in SSR mode.
| * This entrypoint is usually dependent on which host you are deploying to and | ||
| * will be set by your adapter for you. | ||
| * | ||
| * Note that it is recommended that this file ends with `.mjs` so that the runtime |
Member
There was a problem hiding this comment.
Suggested change
| * Note that it is recommended that this file ends with `.mjs` so that the runtime | |
| * Note that it is recommended that this file ends with `.mjs` so that the runtime |
Just checking this is intentional, because I think I've only ever heard "runtime" as an adjective "runtime environment, runtime system, runtime library". If this is a noun, then it's fine!
Contributor
Author
There was a problem hiding this comment.
I've definitely heard it used as a noun. In fact, nodejs.org's <meta description> tag uses it as one! view-source:https://nodejs.org/en/
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
tony-sull
reviewed
Oct 12, 2022
Contributor
tony-sull
left a comment
tony-sull
left a comment
There was a problem hiding this comment.
Nice! I've been missing astro preview support for Netlify's CLI, great to see this new API will open that door 👍
Change looks good to me, just added one note in the image integration to make sure this won't break WASM support
Comment on lines
+103
to
+105
| if(needsBuildConfig) { | ||
| _buildConfig = buildConfig; | ||
| } |
Contributor
There was a problem hiding this comment.
_buildConfig.server is used in the astro:build:ssr step below, does it need to be updated to make sure wasm files are copied to the preview output directory?
Contributor
Author
There was a problem hiding this comment.
So, this line exists for backwards compatibility. If you are using Astro < 1.5.0 then this line will get _buildConfig from the 'astro:build:start' hook. If you are using Astro >= 1.5.0 then it will get it from the 'astro:config:done' hook here: https://github.com/withastro/astro/pull/5056/files#diff-0000f87084d8080bf428d6b3b7dc84cda4f01465d9a3e95c75bbc38b8129e1e5R99
In the future when we do a new major (or minor in the case of astro/image) we can get rid of this code and only support users of Astro >= 1.5.0
Merged
|
Hello @matthewp, Node.js standalone mode, css resources unable to load.
|
Member
romanzy313
added a commit
to romanzy313/astro-fastify
that referenced
this pull request
Jan 28, 2023
Build did not work on latest version of "create astro".
```
"dependencies": {
"astro": "^2.0.2"
},
"devDependencies": {
"@matthewp/astro-fastify": "^2.0.3"
}
```
Issue origin: withastro/astro#5056
ematipico
pushed a commit
that referenced
this pull request
Feb 5, 2025
* wip * Deprecate buildConfig and move to config.build * Implement the standalone server * Stay backwards compat * Add changesets * correctly merge URLs * Get config earlier * update node tests * Return the preview server * update remaining tests * swap usage and config ordering * Update packages/astro/src/@types/astro.ts Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/metal-pumas-walk.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/metal-pumas-walk.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/stupid-points-refuse.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/stupid-points-refuse.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Link to build.server config Co-authored-by: Fred K. Schott <fkschott@gmail.com> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
ematipico
pushed a commit
that referenced
this pull request
Feb 5, 2025
* wip * Deprecate buildConfig and move to config.build * Implement the standalone server * Stay backwards compat * Add changesets * correctly merge URLs * Get config earlier * update node tests * Return the preview server * update remaining tests * swap usage and config ordering * Update packages/astro/src/@types/astro.ts Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/metal-pumas-walk.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/metal-pumas-walk.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/stupid-points-refuse.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/stupid-points-refuse.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Link to build.server config Co-authored-by: Fred K. Schott <fkschott@gmail.com> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
ematipico
pushed a commit
that referenced
this pull request
Feb 6, 2025
* wip * Deprecate buildConfig and move to config.build * Implement the standalone server * Stay backwards compat * Add changesets * correctly merge URLs * Get config earlier * update node tests * Return the preview server * update remaining tests * swap usage and config ordering * Update packages/astro/src/@types/astro.ts Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/metal-pumas-walk.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/metal-pumas-walk.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/stupid-points-refuse.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/stupid-points-refuse.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Link to build.server config Co-authored-by: Fred K. Schott <fkschott@gmail.com> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
ematipico
pushed a commit
that referenced
this pull request
Feb 6, 2025
* wip * Deprecate buildConfig and move to config.build * Implement the standalone server * Stay backwards compat * Add changesets * correctly merge URLs * Get config earlier * update node tests * Return the preview server * update remaining tests * swap usage and config ordering * Update packages/astro/src/@types/astro.ts Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/metal-pumas-walk.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/metal-pumas-walk.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/stupid-points-refuse.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/stupid-points-refuse.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Link to build.server config Co-authored-by: Fred K. Schott <fkschott@gmail.com> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
ematipico
pushed a commit
that referenced
this pull request
Feb 7, 2025
* wip * Deprecate buildConfig and move to config.build * Implement the standalone server * Stay backwards compat * Add changesets * correctly merge URLs * Get config earlier * update node tests * Return the preview server * update remaining tests * swap usage and config ordering * Update packages/astro/src/@types/astro.ts Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/metal-pumas-walk.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/metal-pumas-walk.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/stupid-points-refuse.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/stupid-points-refuse.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Link to build.server config Co-authored-by: Fred K. Schott <fkschott@gmail.com> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
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
6 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.
Changes
previewEntrypointAPI that adapters can support to enableastro preview.{ mode: 'standalone' }option for the @astrojs/node adapter.buildConfigoption inastro:build:startin favor of moving those same options toconfig.build.Testing
examples/ssrexample.Docs