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.

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

Refactor define-env-plugin to have stricter types #63128

Merged

Conversation

timneutkens
Copy link
Member

@timneutkens timneutkens commented Mar 11, 2024

What?

Working on some refactors to fix a bug with undefined handling for Turbopack. This is the first step by making define-env-plugin.ts have stricter types so that we can easily find which values are set to undefined.

Closes NEXT-2768

@ijjk ijjk added created-by: Next.js team PRs by the Next.js team. type: next labels Mar 11, 2024
Copy link
Member Author

timneutkens commented Mar 11, 2024

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @timneutkens and the rest of your teammates on Graphite Graphite

@ijjk
Copy link
Member

ijjk commented Mar 11, 2024

Tests Passed

@timneutkens timneutkens requested a review from wyattjoh as a code owner March 11, 2024 10:53
@@ -14,16 +18,16 @@ function errorIfEnvConflicted(config: NextConfigComplete, key: string) {
}
}

type BloomFilter = ReturnType<
import('../../../shared/lib/bloom-filter').BloomFilter['export']
Copy link
Member

Choose a reason for hiding this comment

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

Why not import at the top?

Copy link
Member Author

Choose a reason for hiding this comment

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

export is a method of BloomFilter, theoretically we could import BloomFilter at the top but didn't want to make too many changes, kept it as-is from this line: https://github.com/vercel/next.js/pull/63128/files#diff-28c0329619b90836564a7769c43ff473dbd28e8e31b75e650624da4d06911763L22 just sharing the type more.

@@ -20,9 +20,11 @@ export type NextConfigComplete = Required<NextConfig> & {
configFileName: string
}

export type I18NDomains = DomainLocale[]
Copy link
Member

Choose a reason for hiding this comment

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

Probably no need for this type. You can just re-export DomainLocale and wherever I18NDomains is needed, you do DomainLocale[] instead.

Copy link
Member Author

Choose a reason for hiding this comment

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

I prefer having this explicit type instead of re-exporting DomainLocale as then you end up with scattered DomainLocale[] which specifically refers to nextConfig.i18n.domains. Could have also used NextConfigComplete['i18n']['domains]' with Omit<> but personally prefer adding additional types over trying to coerce the type into only what you need.

Copy link
Member

Choose a reason for hiding this comment

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

Sure, but this makes the type a bit less reusable. The name probably could have been kept as DomainLocales instead. I18NDomains is made up specifically for the object below. Which I think was the intention, so maybe it's fine. 👍

@ijjk
Copy link
Member

ijjk commented Mar 11, 2024

Stats from current PR

Default Build (Increase detected ⚠️)
General
vercel/next.js canary vercel/next.js 03-11-Refactor_define-env-plugin_to_have_stricter_types Change
buildDuration 15s 15.2s ⚠️ +158ms
buildDurationCached 8.3s 6.9s N/A
nodeModulesSize 198 MB 198 MB N/A
nextStartRea..uration (ms) 447ms 435ms N/A
Client Bundles (main, webpack)
vercel/next.js canary vercel/next.js 03-11-Refactor_define-env-plugin_to_have_stricter_types 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 242 B 242 B
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.6 kB 45.6 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary vercel/next.js 03-11-Refactor_define-env-plugin_to_have_stricter_types Change
polyfills-HASH.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary vercel/next.js 03-11-Refactor_define-env-plugin_to_have_stricter_types 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 vercel/next.js 03-11-Refactor_define-env-plugin_to_have_stricter_types Change
_buildManifest.js gzip 481 B 484 B N/A
Overall change 0 B 0 B
Rendered Page Sizes
vercel/next.js canary vercel/next.js 03-11-Refactor_define-env-plugin_to_have_stricter_types Change
index.html gzip 528 B 529 B N/A
link.html gzip 539 B 541 B N/A
withRouter.html gzip 523 B 523 B
Overall change 523 B 523 B
Edge SSR bundle Size
vercel/next.js canary vercel/next.js 03-11-Refactor_define-env-plugin_to_have_stricter_types Change
edge-ssr.js gzip 95.1 kB 95.1 kB N/A
page.js gzip 3.06 kB 3.07 kB N/A
Overall change 0 B 0 B
Middleware size
vercel/next.js canary vercel/next.js 03-11-Refactor_define-env-plugin_to_have_stricter_types Change
middleware-b..fest.js gzip 627 B 625 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 vercel/next.js 03-11-Refactor_define-env-plugin_to_have_stricter_types Change
app-page-exp...dev.js gzip 171 kB 171 kB
app-page-exp..prod.js gzip 96.5 kB 96.5 kB
app-page-tur..prod.js gzip 98.3 kB 98.3 kB
app-page-tur..prod.js gzip 92.7 kB 92.7 kB
app-page.run...dev.js gzip 149 kB 149 kB
app-page.run..prod.js gzip 91.2 kB 91.2 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.5 kB 50.5 kB
Overall change 948 kB 948 kB
build cache Overall increase ⚠️
vercel/next.js canary vercel/next.js 03-11-Refactor_define-env-plugin_to_have_stricter_types Change
0.pack gzip 1.56 MB 1.56 MB ⚠️ +267 B
index.pack gzip 105 kB 106 kB ⚠️ +716 B
Overall change 1.66 MB 1.66 MB ⚠️ +983 B
Diff details
Diff for middleware.js

Diff too large to display

Commit: c1684af

const defineEnvStringified: SerializedDefineEnv = {}
for (const key in defineEnv) {
const value = defineEnv[key]
defineEnvStringified[key] = JSON.stringify(value)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
defineEnvStringified[key] = JSON.stringify(value)
defineEnvStringified[key] = value === undefined ? 'undefined' : JSON.stringify(value)

@timneutkens timneutkens merged commit 76c9496 into canary Mar 11, 2024
68 checks passed
@timneutkens timneutkens deleted the 03-11-Refactor_define-env-plugin_to_have_stricter_types branch March 11, 2024 13:34
timneutkens added a commit that referenced this pull request Mar 12, 2024
## What?

Follow-up to #63128

`JSON.stringify(undefined)` ends up with the value `undefined`. However
for Webpack/Turbopack to correctly inject `undefined` into the code it
has to be the string `'undefined'`. This change ensures the
serialization takes into account that case.

<!-- 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?

### Why?

### How?

Closes NEXT-
Fixes #

-->


Closes NEXT-2773
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants