Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add JSM (ESM) support for next/lib/find-config #63109

Merged
merged 7 commits into from
Mar 16, 2024
Merged

Add JSM (ESM) support for next/lib/find-config #63109

merged 7 commits into from
Mar 16, 2024

Conversation

phanect
Copy link
Contributor

@phanect phanect commented Mar 10, 2024

Fixes #34448

Before this PR, next/lib/find-config fails to load *.config.mjs files and *.config.js files when "type": "module" is set in package.json. It expects CommonJS files although the *.config.{js|mjs} files are written in JS modules format (i.e. using import and export).
This PR fixes it so that it can load configs written in JS modules format.

@phanect phanect marked this pull request as ready for review March 10, 2024 15:37
@phanect phanect mentioned this pull request Mar 10, 2024
Closed
1 task
@huozhi huozhi added the CI approved Approve running CI for fork label Mar 15, 2024
@ijjk
Copy link
Member

ijjk commented Mar 15, 2024 •
edited by huozhi

Allow CI Workflow Run

  • approve CI run for commit: 4398a00

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

@ijjk
Copy link
Member

ijjk commented Mar 15, 2024 •
edited

Tests Passed

@phanect
Copy link
Contributor Author

phanect commented Mar 15, 2024

Sorry, I look into the CI errors.
I change this PR to draft until I fix them.

@phanect phanect marked this pull request as draft March 15, 2024 13:56
@ijjk
Copy link
Member

ijjk commented Mar 15, 2024 •
edited

Stats from current PR

Default Build
General Overall increase ⚠️
vercel/next.js canary phanect/next.js fix-find-config-esm Change
buildDuration 13.5s 13.6s ⚠️ +137ms
buildDurationCached 7.1s 6.2s N/A
nodeModulesSize 198 MB 198 MB ⚠️ +4.68 kB
nextStartRea..uration (ms) 431ms 443ms N/A
Client Bundles (main, webpack)
vercel/next.js canary phanect/next.js fix-find-config-esm Change
2453-HASH.js gzip 30.5 kB 30.5 kB N/A
3304.HASH.js gzip 181 B 181 B ✓
3f784ff6-HASH.js gzip 53.7 kB 53.7 kB N/A
8299-HASH.js gzip 5.04 kB 5.04 kB N/A
framework-HASH.js gzip 45.2 kB 45.2 kB ✓
main-app-HASH.js gzip 243 B 242 B N/A
main-HASH.js gzip 32.2 kB 32.2 kB N/A
webpack-HASH.js gzip 1.68 kB 1.68 kB N/A
Overall change 45.4 kB 45.4 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary phanect/next.js fix-find-config-esm Change
polyfills-HASH.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary phanect/next.js fix-find-config-esm Change
_app-HASH.js gzip 196 B 197 B N/A
_error-HASH.js gzip 184 B 184 B ✓
amp-HASH.js gzip 505 B 505 B ✓
css-HASH.js gzip 324 B 325 B N/A
dynamic-HASH.js gzip 2.5 kB 2.5 kB N/A
edge-ssr-HASH.js gzip 258 B 258 B ✓
head-HASH.js gzip 352 B 352 B ✓
hooks-HASH.js gzip 370 B 371 B N/A
image-HASH.js gzip 4.21 kB 4.21 kB ✓
index-HASH.js gzip 259 B 259 B ✓
link-HASH.js gzip 2.67 kB 2.67 kB N/A
routerDirect..HASH.js gzip 314 B 312 B N/A
script-HASH.js gzip 386 B 386 B ✓
withRouter-HASH.js gzip 309 B 309 B ✓
1afbb74e6ecf..834.css gzip 106 B 106 B ✓
Overall change 6.57 kB 6.57 kB ✓
Client Build Manifests
vercel/next.js canary phanect/next.js fix-find-config-esm Change
_buildManifest.js gzip 481 B 484 B N/A
Overall change 0 B 0 B ✓
Rendered Page Sizes
vercel/next.js canary phanect/next.js fix-find-config-esm Change
index.html gzip 529 B 529 B ✓
link.html gzip 542 B 542 B ✓
withRouter.html gzip 525 B 523 B N/A
Overall change 1.07 kB 1.07 kB ✓
Edge SSR bundle Size
vercel/next.js canary phanect/next.js fix-find-config-esm Change
edge-ssr.js gzip 95.1 kB 95.1 kB N/A
page.js gzip 3.05 kB 3.05 kB N/A
Overall change 0 B 0 B ✓
Middleware size
vercel/next.js canary phanect/next.js fix-find-config-esm Change
middleware-b..fest.js gzip 627 B 624 B N/A
middleware-r..fest.js gzip 151 B 151 B ✓
middleware.js gzip 25.5 kB 25.5 kB N/A
edge-runtime..pack.js gzip 839 B 839 B ✓
Overall change 990 B 990 B ✓
Next Runtimes
vercel/next.js canary phanect/next.js fix-find-config-esm Change
app-page-exp...dev.js gzip 171 kB 171 kB ✓
app-page-exp..prod.js gzip 96.6 kB 96.6 kB ✓
app-page-tur..prod.js gzip 98.3 kB 98.3 kB ✓
app-page-tur..prod.js gzip 92.8 kB 92.8 kB ✓
app-page.run...dev.js gzip 149 kB 149 kB ✓
app-page.run..prod.js gzip 91.3 kB 91.3 kB ✓
app-route-ex...dev.js gzip 21.3 kB 21.3 kB ✓
app-route-ex..prod.js gzip 15 kB 15 kB ✓
app-route-tu..prod.js gzip 15 kB 15 kB ✓
app-route-tu..prod.js gzip 14.8 kB 14.8 kB ✓
app-route.ru...dev.js gzip 21 kB 21 kB ✓
app-route.ru..prod.js gzip 14.8 kB 14.8 kB ✓
pages-api-tu..prod.js gzip 9.52 kB 9.52 kB ✓
pages-api.ru...dev.js gzip 9.8 kB 9.8 kB ✓
pages-api.ru..prod.js gzip 9.52 kB 9.52 kB ✓
pages-turbo...prod.js gzip 22.3 kB 22.3 kB ✓
pages.runtim...dev.js gzip 22.9 kB 22.9 kB ✓
pages.runtim..prod.js gzip 22.3 kB 22.3 kB ✓
server.runti..prod.js gzip 50.6 kB 50.6 kB ✓
Overall change 948 kB 948 kB ✓
build cache
vercel/next.js canary phanect/next.js fix-find-config-esm Change
0.pack gzip 1.56 MB 1.56 MB N/A
index.pack gzip 106 kB 105 kB N/A
Overall change 0 B 0 B ✓
Diff details
Diff for middleware.js

Diff too large to display

Commit: a3ff036

@phanect phanect marked this pull request as ready for review March 15, 2024 14:53
huozhi
huozhi reviewed Mar 15, 2024
View reviewed changes
packages/next/src/lib/find-config.ts Outdated Show resolved Hide resolved
packages/next/src/lib/find-config.ts Outdated Show resolved Hide resolved
packages/next/src/lib/find-config.ts Outdated Show resolved Hide resolved
packages/next/src/lib/find-config.ts Outdated Show resolved Hide resolved
packages/next/src/lib/find-config.test.ts Outdated Show resolved Hide resolved
@phanect phanect marked this pull request as draft March 16, 2024 00:59
@phanect
Copy link
Contributor Author

phanect commented Mar 16, 2024

@huozhi Thanks for the review! I will update the code.

@phanect phanect marked this pull request as ready for review March 16, 2024 01:14
@phanect
Copy link
Contributor Author

phanect commented Mar 16, 2024 •
edited

@huozhi I've applied your suggestions.
I have rebased this branch by canary branch, but I didn't touch the commits before 8ebd35a (test: support to load config when "type": "module" is set.)

huozhi
huozhi approved these changes Mar 16, 2024
View reviewed changes
Copy link
Member

@huozhi huozhi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! Thank you!

@phanect
Copy link
Contributor Author

phanect commented Mar 16, 2024

@huozhi I noticed GHA job failed: https://github.com/vercel/next.js/actions/runs/8305434996/job/22735976306?pr=63109
The CI seems to fail on downloading https://cdn.ampproject.org/v0/validator_wasm.js and it might be just a network error.

I rebased this branch and force-pushed to re-run the CI, but I forgot that it requires your approval to run GHA. Can you approve it?

@huozhi
Copy link
Member

huozhi commented Mar 16, 2024 •
edited

Some might be flaky, no need to re-push again since we need to re-approve and re-run the CI. I'll monitor the CI and land this once it's passed 🙏

@huozhi huozhi enabled auto-merge (squash) March 16, 2024 15:51
@huozhi huozhi merged commit dc2be64 into vercel:canary Mar 16, 2024
61 checks passed
@MrOxMasTer MrOxMasTer mentioned this pull request Mar 16, 2024
Closed
@phanect phanect deleted the fix-find-config-esm branch March 17, 2024 00:15
@phanect
Copy link
Contributor Author

phanect commented Mar 17, 2024

@huozhi Thanks for merging!

no need to re-push again since we need to re-approve and re-run the CI.

Sorry for that 🙏
I will refrain from pushing again when not necessary from next time.

@ykzts ykzts mentioned this pull request Mar 17, 2024
Closed
@karlhorky
Copy link
Contributor

Thanks for the PR for ESM support @phanect and for the review and merge @huozhi 🙌

I can confirm that next@14.2.0-canary.25 does have support for the following ESM configurations 🎉

  1. CommonJS project + postcss.config.mjs in ESM format
  2. ESM project + postcss.config.js in ESM format

More details here:

This was referenced Mar 17, 2024
Merged
Merged
huozhi pushed a commit that referenced this pull request Mar 18, 2024
@karlhorky @samcx
Switch to postcss.config.mjs, add type (#63380)
51b878f 
<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

-->

### What?

Now that @phanect added support for ESM PostCSS config files in PR
#63109 (original issue #34448), PostCSS can use ESM config by default.

It needs to use an `.mjs` extension by default because `create-next-app`
scaffolds CommonJS apps by default.

This will also work with ESM projects which have added `"type":
"module"` in their `package.json`

### Why?

1. To convert one more file to ESM
2. To use the modern format
3. To follow other similar migrations that have taken place in the
Next.js codebase (eg. `next.config.mjs`)

### How?

- Change file extensions from `.cjs` to `.mjs` (change similar to PR
#58380)
- Change module format from CommonJS to ESM
- Add type for the config, for users who enable `checkJs: true` in
`tsconfig.json`

Co-authored-by: Sam Ko <sam@vercel.com>
@github-actions github-actions bot added the locked label Apr 1, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@huozhi huozhi huozhi approved these changes

@timneutkens timneutkens Awaiting requested review from timneutkens timneutkens is a code owner

@ijjk ijjk Awaiting requested review from ijjk ijjk is a code owner

@shuding shuding Awaiting requested review from shuding shuding is a code owner

@feedthejim feedthejim Awaiting requested review from feedthejim feedthejim is a code owner

@ztanner ztanner Awaiting requested review from ztanner ztanner is a code owner

@wyattjoh wyattjoh Awaiting requested review from wyattjoh wyattjoh is a code owner

Assignees
No one assigned
Labels
CI approved Approve running CI for fork locked type: next
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

next/lib/find-config does not support ESM config files
4 participants
@phanect @ijjk @huozhi @karlhorky