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

fix: call instrumentationHook earlier for prod server #63536

Conversation

styfle
Copy link
Member

@styfle styfle commented Mar 20, 2024

This ensures that the instrumentation hook for Node.js will run immediately during next start instead of waiting for the first request like does it next dev.

However, if there is a separate instrumentation hook for Edge, that will still be lazy evaluated and wait until the first request.

Fixes #59999
Fixes NEXT-2738

@ijjk ijjk added created-by: Next.js team PRs by the Next.js team type: next labels Mar 20, 2024
@styfle styfle changed the title fix: call implementationHook earlier for prod server fix: call instrumentationHook earlier for prod server Mar 20, 2024
@ijjk
Copy link
Member

ijjk commented Mar 20, 2024

Failing test suites

Commit: 0c4a84a

pnpm test-dev test/e2e/app-dir/params-hooks-compat/index.test.ts (PPR)

  • app-dir - params hooks compat > should only access search params with useSearchParams
Expand output

● app-dir - params hooks compat › should only access search params with useSearchParams

expect(received).toEqual(expected) // deep equality

- Expected  - 3
+ Received  + 1

- Object {
-   "q": "pages",
- }
+ Object {}

  18 |
  19 |       expect(appSearchparamsJSON).toEqual({ q: 'app' })
> 20 |       expect(pagesSearchparamsJSON).toEqual({ q: 'pages' })
     |                                     ^
  21 |     })
  22 |
  23 |     it('should only access path params with useParams', async () => {

  at Object.toEqual (e2e/app-dir/params-hooks-compat/index.test.ts:20:37)

Read more about building and testing Next.js in contributing.md.

@samcx samcx self-requested a review March 20, 2024 21:34
Copy link
Member

@samcx samcx left a comment

Choose a reason for hiding this comment

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

:lfgtm:

@ijjk
Copy link
Member

ijjk commented Mar 20, 2024

Stats from current PR

Default Build
General Overall increase ⚠️
vercel/next.js canary vercel/next.js styfle/next-2738-the-instrumentation-hook-is-only-called-after-visiting-a Change
buildDuration 14.4s 14.6s ⚠️ +128ms
buildDurationCached 7.9s 6.8s N/A
nodeModulesSize 198 MB 198 MB ⚠️ +4.02 kB
nextStartRea..uration (ms) 446ms 440ms N/A
Client Bundles (main, webpack)
vercel/next.js canary vercel/next.js styfle/next-2738-the-instrumentation-hook-is-only-called-after-visiting-a Change
2453-HASH.js gzip 30.8 kB 30.8 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 styfle/next-2738-the-instrumentation-hook-is-only-called-after-visiting-a Change
polyfills-HASH.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary vercel/next.js styfle/next-2738-the-instrumentation-hook-is-only-called-after-visiting-a 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 styfle/next-2738-the-instrumentation-hook-is-only-called-after-visiting-a 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 styfle/next-2738-the-instrumentation-hook-is-only-called-after-visiting-a Change
index.html gzip 529 B 528 B N/A
link.html gzip 541 B 540 B N/A
withRouter.html gzip 524 B 522 B N/A
Overall change 0 B 0 B
Edge SSR bundle Size
vercel/next.js canary vercel/next.js styfle/next-2738-the-instrumentation-hook-is-only-called-after-visiting-a Change
edge-ssr.js gzip 95.3 kB 95.3 kB N/A
page.js gzip 3.04 kB 3.04 kB N/A
Overall change 0 B 0 B
Middleware size
vercel/next.js canary vercel/next.js styfle/next-2738-the-instrumentation-hook-is-only-called-after-visiting-a Change
middleware-b..fest.js gzip 625 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 styfle/next-2738-the-instrumentation-hook-is-only-called-after-visiting-a Change
app-page-exp...dev.js gzip 170 kB 170 kB
app-page-exp..prod.js gzip 96.9 kB 96.9 kB
app-page-tur..prod.js gzip 98.6 kB 98.6 kB
app-page-tur..prod.js gzip 93.1 kB 93.1 kB
app-page.run...dev.js gzip 144 kB 144 kB
app-page.run..prod.js gzip 91.5 kB 91.5 kB
app-route-ex...dev.js gzip 21.4 kB 21.4 kB
app-route-ex..prod.js gzip 15.1 kB 15.1 kB
app-route-tu..prod.js gzip 15.1 kB 15.1 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.54 kB 9.54 kB
pages-api.ru...dev.js gzip 9.81 kB 9.81 kB
pages-api.ru..prod.js gzip 9.54 kB 9.54 kB
pages-turbo...prod.js gzip 22.4 kB 22.4 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 50.9 kB 50.9 kB N/A
Overall change 894 kB 894 kB
build cache
vercel/next.js canary vercel/next.js styfle/next-2738-the-instrumentation-hook-is-only-called-after-visiting-a Change
0.pack gzip 1.57 MB 1.57 MB N/A
index.pack gzip 106 kB 106 kB N/A
Overall change 0 B 0 B
Diff details
Diff for middleware.js

Diff too large to display

Diff for server.runtime.prod.js

Diff too large to display

Commit: d7979b5

@styfle styfle enabled auto-merge (squash) March 20, 2024 21:52
@styfle styfle merged commit abe74a5 into canary Mar 21, 2024
79 checks passed
@styfle styfle deleted the styfle/next-2738-the-instrumentation-hook-is-only-called-after-visiting-a branch March 21, 2024 13:11
@github-actions github-actions bot added the locked label Apr 5, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 5, 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.

The instrumentation hook is only called after visiting a route
3 participants