fix: inline optional dependencies when bundling the server #325
Conversation
🦋 Changeset detectedLatest commit: ca4c87c The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
commit: |
| "@opennextjs/cloudflare": patch | ||
| --- | ||
|
|
||
| fix: inline optional dependencies when bundling the server |
There was a problem hiding this comment.
I think this changeset could use some extra info
There was a problem hiding this comment.
The changelog is mostly for users - I don't think we should describe too much about the implementation details.
But I can add more details to the PR description if you feel like something is missing?
There was a problem hiding this comment.
Resolving the convo to merge, but feel free to send your feedback and I'll update the description.
Thanks!
There was a problem hiding this comment.
Nono the PR description has everything
What I meant is that if I were a user and I saw: fix: inline optional dependencies when bundling the server I don't think I would understand what that means/fixes, and I would have questions such as:
- why optional dependencies need to be inlined?
- what does inlining mean?
- what wasn't working before and is now?
Not a huge deal anyways (and you merged as I was writing this comment)
There was a problem hiding this comment.
I think most users do not care about the changelog and how this adapter works. They just want their app to work.
Adding too many info to the changelog might make it more difficult for users to find what they are interested in: the changes they need to do to their app after they update.
IMO
why optional dependencies need to be inlined?
what does inlining mean?
what wasn't working before and is now?
is only of interest for power users - they would know how to find the PR (from the changelog) and check the description and/or the comments in the code.
That being said, one thing I should have mentioned is how this issue manifest (i.e. the generated error).
That's my 2 cents but feel free to add an item to the weekly agenda if you think we should discuss more about that.
There was a problem hiding this comment.
I think most users do not care about the changelog and how this adapter works. They just want their app to work.
Adding too many info to the changelog might make it more difficult for users to find what they are interested in: the changes they need to do to their app after they update.
IMO
why optional dependencies need to be inlined?
what does inlining mean?
what wasn't working before and is now?
is only of interest for power users - they would know how to find the PR (from the changelog) and check the description and/or the comments in the code.
That being said, one thing I should have mentioned is how this issue manifest (i.e. the generated error).
That's my 2 cents but feel free to add an item to the weekly agenda if you think we should discuss more about that.
packages/cloudflare/src/cli/build/patches/plugins/optional-deps.ts
Outdated
Show resolved
Hide resolved
…s.ts Co-authored-by: James Anderson <[email protected]>
Fixes
examples/e2e/pages-routerThe regression was introduced in #297
Before that PR,
react-dom/server.edgewas patch before the bundling that happens inbundle-server.ts.#297 marks
react-dom/server.edgeas external - then it is no more bundled inbundle-server.tsbut it is bundled later bywrangler dev/deploy.The issue here is that
wrangler dev/deployuses the["workerd", "worker", "browser"]build conditions and then whatever is imported forreact-dom/server.edgedoes not match what's expected.The fix in this PR inline dependencies during the bundling in
bundle-server.ts. We rely on the ESBuild dependency resolution. If an optional dependencies is not found, we require a throwing module. When an optional dependency is actually installed, it will be inlined during the build.Meaning that
react-dom/server.edgewill be inline with the expected build condition (node)/cc @dario-piotrowicz