fix: apply type: module only to runtime modules #2549
Merged
Conversation
This file contains 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
📊 Package size report 0%↑
Unchanged files
🤖 This report was automatically generated by pkg-size-action |
pieh
commented
Jul 18, 2024
src/build/functions/server.ts
Outdated
Comment on lines
89
to
92
| await writeFile( | ||
| join(ctx.serverHandlerRootDir, 'package.json'), | ||
| join(ctx.serverHandlerRootDir, '.netlify', 'package.json'), | ||
| JSON.stringify({ type: 'module' }), | ||
| ) |
There was a problem hiding this comment.
I'm not quite sure if this is a correct fix (or rather if this is full fix) - we definitely shouldn't be setting type: 'module' for entire handler directory in every case (which is what cause the problem right now).
We definitely should either set it for our runtime modules we copy to handler (which is what this PR does right now) OR make runtime emit .mjs files and not .js ones to dist.
But part that I'm not sure about is wether type: 'module' should be set in root of handler in case user use this mode? I'll run some experiments here, but in case someone is familiar - I'm happy for any heads up on that.
There was a problem hiding this comment.
So I did update it since this comment - Next.js does output their own package.json in root of standalone which we were ignoring when copying from it. With my changes we copy it over (this is really just copy of site's package.json so it inherit site's type essentially) + create package.json just for runtime modules (possibly this could be avoided if we emitted .mjs files for runtime modules, but my initial attempt at that resulted in problems so I didn't pursue this too much)
pieh
commented
Jul 18, 2024
|
|
||
| export async function GET() { | ||
| return NextResponse.json({ | ||
| notBundledCJSModule: __non_webpack_require__(resolve('./cjs-file-with-js-extension.js')), |
There was a problem hiding this comment.
__non_webpack_require__ turns into regular require in compiled output (instead of inlining modules by webpack) which is needed to reproduce the ERR_REQUIRE_ESM problem (without usage of 3rd party packages)
pieh
force-pushed
the
michalpiechowiak/frp-762-err_require_esm
branch
2 times, most recently
from
5936c4c
to
e58d640
Compare
pieh
force-pushed
the
michalpiechowiak/frp-762-err_require_esm
branch
from
e58d640
to
e3308f1
Compare
pieh
commented
Jul 19, 2024
| // this will include the node_modules folder as well | ||
| if (entry === 'package.json' || entry === ctx.nextDistDir) { | ||
| if (entry === ctx.nextDistDir) { |
There was a problem hiding this comment.
we are no longer writing top level package.json (we write it just for runtime modules, so it no longer is top-level), hence this copies top-level package.json provided by Next.js (which is really just site's package.json) so it will "inherit" type from user's site
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
We are setting entire request handler function dir as
type: 'module'right now, which result inERR_REQUIRE_ESMkind of errors when.jsfile which is actually CJS is being required.Documentation
Tests
Integration and e2e test added using same fixture - both fail. Integration test output https://github.com/netlify/next-runtime/actions/runs/9992611474/job/27618021931?pr=2549#step:12:151 showing
ERR_REQUIRE_ESMerror (e2e only see 500 status, as error is hidden in function logs).Second commit makes them pass.
Relevant links (GitHub issues, etc.) or a picture of cute animal