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

Ensure static generation storage is accessed correctly #64088

Merged
merged 1 commit into from
Apr 5, 2024
Merged

Ensure static generation storage is accessed correctly #64088

merged 1 commit into from
Apr 5, 2024

Conversation

wyattjoh
Copy link
Member

@wyattjoh wyattjoh commented Apr 4, 2024 •
edited
Loading

What?

Primarily, this is fixing the code highlighted here:

next.js/packages/next/src/server/lib/patch-fetch.ts

Lines 228 to 230 in 073cd74

const staticGenerationStore: StaticGenerationStore =
staticGenerationAsyncStorage.getStore() ||
(fetch as any).__nextGetStaticStore?.()

As (fetch as any).__nextGetStaticStore?.() returns StaticGenerationAsyncStorage | undefined, and not StaticGenerationStore. A call to .getStore() as the previous line does corrects this issue.

Secondarily, this improves the as any type access being done on the patched fetch object to make it more type safe and easier to work with. Since this was added, some features like the .external files were added that allowed files to import the correct async local storage object in client and server environments correctly to allow for direct access. Code across Next.js no-longer uses this mechanism to access the storage, and instead relies on this special treated import.

Types were improved within the patch-fetch.ts file to allow for safer property access by adding consistent types and guards.

Why?

Without this change, checks like:

next.js/packages/next/src/server/lib/patch-fetch.ts

Line 246 in 073cd74

!staticGenerationStore ||

Always fail, because when (fetch as any).__nextGetStaticStore?.() returns StaticGenerationAsyncStorage, it isn't the actual store, so the type is wrong.

Closes NEXT-3008

@ijjk ijjk added created-by: Next.js team PRs by the Next.js team. type: next labels Apr 4, 2024
@wyattjoh Graphite App
Copy link
Member Author

wyattjoh commented Apr 4, 2024 •
edited
Loading

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

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

@ijjk
Copy link
Member

ijjk commented Apr 4, 2024 •
edited
Loading

Tests Passed

@ijjk
Copy link
Member

ijjk commented Apr 4, 2024 •
edited
Loading

Stats from current PR

Default Build
General Overall increase ⚠️
vercel/next.js canary vercel/next.js wyattjoh/static-storage-patch-fix Change
buildDuration 13.9s 14.2s ⚠️ +250ms
buildDurationCached 7.5s 6.5s N/A
nodeModulesSize 199 MB 199 MB ⚠️ +11.1 kB
nextStartRea..uration (ms) 402ms 398ms N/A
Client Bundles (main, webpack)
vercel/next.js canary vercel/next.js wyattjoh/static-storage-patch-fix Change
2453-HASH.js gzip 31.4 kB 31.4 kB N/A
3304.HASH.js gzip 181 B 181 B ✓
3f784ff6-HASH.js gzip 53.7 kB 53.7 kB ✓
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 99.3 kB 99.3 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary vercel/next.js wyattjoh/static-storage-patch-fix Change
polyfills-HASH.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary vercel/next.js wyattjoh/static-storage-patch-fix 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 wyattjoh/static-storage-patch-fix 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 wyattjoh/static-storage-patch-fix Change
index.html gzip 529 B 529 B ✓
link.html gzip 541 B 541 B ✓
withRouter.html gzip 524 B 524 B ✓
Overall change 1.59 kB 1.59 kB ✓
Edge SSR bundle Size
vercel/next.js canary vercel/next.js wyattjoh/static-storage-patch-fix Change
edge-ssr.js gzip 95.4 kB 95.4 kB N/A
page.js gzip 3.06 kB 3.06 kB N/A
Overall change 0 B 0 B ✓
Middleware size
vercel/next.js canary vercel/next.js wyattjoh/static-storage-patch-fix Change
middleware-b..fest.js gzip 626 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 wyattjoh/static-storage-patch-fix Change
app-page-exp...dev.js gzip 170 kB 170 kB N/A
app-page-exp..prod.js gzip 97 kB 97 kB N/A
app-page-tur..prod.js gzip 98.8 kB 98.8 kB N/A
app-page-tur..prod.js gzip 93 kB 93 kB N/A
app-page.run...dev.js gzip 144 kB 144 kB N/A
app-page.run..prod.js gzip 91.5 kB 91.5 kB N/A
app-route-ex...dev.js gzip 21.4 kB 21.4 kB N/A
app-route-ex..prod.js gzip 15.2 kB 15.1 kB N/A
app-route-tu..prod.js gzip 15.2 kB 15.1 kB N/A
app-route-tu..prod.js gzip 14.9 kB 14.9 kB N/A
app-route.ru...dev.js gzip 21.1 kB 21.1 kB N/A
app-route.ru..prod.js gzip 14.9 kB 14.9 kB N/A
pages-api-tu..prod.js gzip 9.55 kB 9.55 kB ✓
pages-api.ru...dev.js gzip 9.82 kB 9.82 kB ✓
pages-api.ru..prod.js gzip 9.55 kB 9.55 kB ✓
pages-turbo...prod.js gzip 22.5 kB 22.5 kB ✓
pages.runtim...dev.js gzip 23.1 kB 23.1 kB ✓
pages.runtim..prod.js gzip 22.4 kB 22.4 kB ✓
server.runti..prod.js gzip 51.1 kB 51.1 kB N/A
Overall change 96.9 kB 96.9 kB ✓
build cache
vercel/next.js canary vercel/next.js wyattjoh/static-storage-patch-fix Change
0.pack gzip 1.58 MB 1.58 MB N/A
index.pack gzip 107 kB 107 kB N/A
Overall change 0 B 0 B ✓
Diff details
Diff for middleware.js

Diff too large to display

Diff for edge-ssr.js

Diff too large to display

Diff for 2453-HASH.js

Diff too large to display

Diff for app-page-exp..ntime.dev.js 
failed to diff
Diff for app-page-exp..time.prod.js

Diff too large to display

Diff for app-page-tur..time.prod.js

Diff too large to display

Diff for app-page-tur..time.prod.js

Diff too large to display

Diff for app-page.runtime.dev.js 
failed to diff
Diff for app-page.runtime.prod.js

Diff too large to display

Diff for app-route-ex..ntime.dev.js

Diff too large to display

Diff for app-route-ex..time.prod.js

Diff too large to display

Diff for app-route-tu..time.prod.js

Diff too large to display

Diff for app-route-tu..time.prod.js

Diff too large to display

Diff for app-route.runtime.dev.js

Diff too large to display

Diff for app-route.ru..time.prod.js

Diff too large to display

Diff for server.runtime.prod.js

Diff too large to display

Commit: 84b0f58

@wyattjoh wyattjoh force-pushed the wyattjoh/static-storage-patch-fix branch from 2fb4531 to 859af7b Compare April 4, 2024 22:59
@wyattjoh wyattjoh force-pushed the wyattjoh/static-storage-patch-fix branch from 859af7b to 84b0f58 Compare April 5, 2024 04:37
@wyattjoh wyattjoh marked this pull request as ready for review April 5, 2024 04:37
@wyattjoh wyattjoh mentioned this pull request Apr 5, 2024
Merged
@ztanner ztanner merged commit bb74ece into canary Apr 5, 2024
79 checks passed
@ztanner ztanner deleted the wyattjoh/static-storage-patch-fix branch April 5, 2024 14:14
epiloguess pushed a commit to epiloguess/next.js that referenced this pull request Apr 5, 2024
@wyattjoh @epiloguess
Ensure static generation storage is accessed correctly (vercel#64088)
11d81bf 
<!-- 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 #

-->

### What?

Primarily, this is fixing the code highlighted here:


https://github.com/vercel/next.js/blob/073cd74433146d6d3849110e7dada92351ebb7d4/packages/next/src/server/lib/patch-fetch.ts#L228-L230

As `(fetch as any).__nextGetStaticStore?.()` returns
`StaticGenerationAsyncStorage | undefined`, and not
`StaticGenerationStore`. A call to `.getStore()` as the previous line
does corrects this issue.

Secondarily, this improves the `as any` type access being done on the
patched fetch object to make it more type safe and easier to work with.
Since this was added, some features like the `.external` files were
added that allowed files to import the correct async local storage
object in client and server environments correctly to allow for direct
access. Code across Next.js no-longer uses this mechanism to access the
storage, and instead relies on this special treated import.

Types were improved within the `patch-fetch.ts` file to allow for safer
property access by adding consistent types and guards.

### Why?

Without this change, checks like:


https://github.com/vercel/next.js/blob/073cd74433146d6d3849110e7dada92351ebb7d4/packages/next/src/server/lib/patch-fetch.ts#L246

Always fail, because when `(fetch as any).__nextGetStaticStore?.()`
returns `StaticGenerationAsyncStorage`, it isn't the actual store, so
the type is wrong.

Closes NEXT-3008
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@ztanner ztanner ztanner approved these changes

@balazsorban44 balazsorban44 balazsorban44 approved these changes

@timneutkens timneutkens Awaiting requested review from timneutkens

@ijjk ijjk Awaiting requested review from ijjk

@shuding shuding Awaiting requested review from shuding

@huozhi huozhi Awaiting requested review from huozhi

@feedthejim feedthejim Awaiting requested review from feedthejim

Assignees
No one assigned
Labels
created-by: Next.js team PRs by the Next.js team. locked type: next
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@wyattjoh @ijjk @ztanner @balazsorban44