Ensure PromiseLikeOfReactNode is not included in .d.ts files#63185
Merged
timneutkens merged 1 commit intocanaryfrom Mar 12, 2024
Merged
Conversation
Member
Author
|
This stack of pull requests is managed by Graphite. Learn more about stacking. Join @timneutkens and the rest of your teammates on |
huozhi
approved these changes
Mar 12, 2024
Member
Stats from current PRDefault BuildGeneral Overall increase
|
| vercel/next.js canary | vercel/next.js 03-12-Ensure_PromiseLikeOfReactNode_is_not_included_in_.d.ts_files | Change | |
|---|---|---|---|
| buildDuration | 14s | 14s | N/A |
| buildDurationCached | 7.5s | 6.4s | N/A |
| nodeModulesSize | 198 MB | 198 MB | |
| nextStartRea..uration (ms) | 414ms | 436ms | N/A |
Client Bundles (main, webpack)
| vercel/next.js canary | vercel/next.js 03-12-Ensure_PromiseLikeOfReactNode_is_not_included_in_.d.ts_files | 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 | 241 B | 241 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-12-Ensure_PromiseLikeOfReactNode_is_not_included_in_.d.ts_files | 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-12-Ensure_PromiseLikeOfReactNode_is_not_included_in_.d.ts_files | 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-12-Ensure_PromiseLikeOfReactNode_is_not_included_in_.d.ts_files | 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-12-Ensure_PromiseLikeOfReactNode_is_not_included_in_.d.ts_files | Change | |
|---|---|---|---|
| index.html gzip | 529 B | 527 B | N/A |
| link.html gzip | 541 B | 541 B | ✓ |
| withRouter.html gzip | 524 B | 523 B | N/A |
| Overall change | 541 B | 541 B | ✓ |
Edge SSR bundle Size
| vercel/next.js canary | vercel/next.js 03-12-Ensure_PromiseLikeOfReactNode_is_not_included_in_.d.ts_files | 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-12-Ensure_PromiseLikeOfReactNode_is_not_included_in_.d.ts_files | Change | |
|---|---|---|---|
| middleware-b..fest.js gzip | 626 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 | vercel/next.js 03-12-Ensure_PromiseLikeOfReactNode_is_not_included_in_.d.ts_files | 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
| vercel/next.js canary | vercel/next.js 03-12-Ensure_PromiseLikeOfReactNode_is_not_included_in_.d.ts_files | Change | |
|---|---|---|---|
| 0.pack gzip | 1.56 MB | 1.56 MB | N/A |
| index.pack gzip | 105 kB | 105 kB | N/A |
| Overall change | 0 B | 0 B | ✓ |
Diff details
Diff for middleware.js
Diff too large to display
Diff for 2453-HASH.js
Diff too large to display
Member
|
I filed microsoft/TypeScript#57764 and will also re-introduce |
styfle
pushed a commit
that referenced
this pull request
Mar 18, 2024
Fixes the compile error on all test runs currently: https://github.com/vercel/next.js/actions/runs/8243077904/job/22543375810?pr=63167#step:27:345 The root cause is that `.d.ts` files automatically include inferred return types automatically, in this case `tsc` included React class component `render()` return types in the `.d.ts` for e.g. error-boundary.tsx / redirect-boundary.tsx. This is a problem because yesterday that return type was changed: https://github.com/DefinitelyTyped/DefinitelyTyped/commit/bf659aefa780a8b61b1636bd0296e0723c96d780#diff-1d64e275d9755825ba[…]520436dbd8e1f1fd9fc66a9 and that change also removes one of the previous types that the `.d.ts` in Next.js automatically included. This PR changes the `render()` return type to be explicit instead of inferred, this makes sure that the `.d.ts` file includes only `: React.ReactNode` instead of the many types of return values allowed. The reason I went with the explicit type instead of e.g. upgrading `@types/react` is that upgrading the types would cause existing applications that use older versions of `@types/react` would break. The current change ensures it works in both cases. <!-- 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-2787
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.

Fixes the compile error on all test runs currently: https://github.com/vercel/next.js/actions/runs/8243077904/job/22543375810?pr=63167#step:27:345
The root cause is that
.d.tsfiles automatically include inferred return types automatically, in this casetscincluded React class componentrender()return types in the.d.tsfor e.g. error-boundary.tsx / redirect-boundary.tsx. This is a problem because yesterday that return type was changed: DefinitelyTyped/DefinitelyTyped@bf659ae#diff-1d64e275d9755825ba%5B%E2%80%A6%5D520436dbd8e1f1fd9fc66a9 and that change also removes one of the previous types that the.d.tsin Next.js automatically included.This PR changes the
render()return type to be explicit instead of inferred, this makes sure that the.d.tsfile includes only: React.ReactNodeinstead of the many types of return values allowed.The reason I went with the explicit type instead of e.g. upgrading
@types/reactis that upgrading the types would cause existing applications that use older versions of@types/reactwould break. The current change ensures it works in both cases.Closes NEXT-2787