Skip to content
New issue

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

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

Already on GitHub? # to your account

Rename variables in LayoutRouter for clarity #73826

Merged
merged 2 commits into from
Dec 12, 2024

Conversation

acdlite
Copy link
Contributor

@acdlite acdlite commented Dec 12, 2024

LayoutRouter has changed significantly since it was originally written and the structure has become harder to follow. One thing I always find confusing whenever I'm reading this code is that some of the values correspond the the parent segment, while others correspond to the current segment. So this moves the code around a bit and updates the names so it's clearer which parts belong to which segments.

While working on this, I noticed a funny thing about how loading boundaries work that was made more obvious by the revised naming. I've left a TODO comment to follow up on whether this was intentional.

@ijjk ijjk added created-by: Next.js team PRs by the Next.js team. type: next labels Dec 12, 2024
@acdlite acdlite force-pushed the refactor-layout-router branch from 3afe1c2 to 50521a0 Compare December 12, 2024 03:50
@ijjk
Copy link
Member

ijjk commented Dec 12, 2024

Tests Passed

@ijjk
Copy link
Member

ijjk commented Dec 12, 2024

Stats from current PR

Default Build (Increase detected ⚠️)
General
vercel/next.js canary acdlite/next.js refactor-layout-router Change
buildDuration 23.6s 22s N/A
buildDurationCached 20.7s 18.2s N/A
nodeModulesSize 409 MB 409 MB N/A
nextStartRea..uration (ms) 578ms 584ms N/A
Client Bundles (main, webpack)
vercel/next.js canary acdlite/next.js refactor-layout-router Change
1187-HASH.js gzip 50.7 kB 50.7 kB N/A
8276.HASH.js gzip 169 B 168 B N/A
8377-HASH.js gzip 5.36 kB 5.36 kB N/A
bccd1874-HASH.js gzip 53 kB 53 kB N/A
framework-HASH.js gzip 57.5 kB 57.5 kB N/A
main-app-HASH.js gzip 232 B 235 B N/A
main-HASH.js gzip 34 kB 34 kB N/A
webpack-HASH.js gzip 1.71 kB 1.71 kB N/A
Overall change 0 B 0 B
Legacy Client Bundles (polyfills)
vercel/next.js canary acdlite/next.js refactor-layout-router Change
polyfills-HASH.js gzip 39.4 kB 39.4 kB
Overall change 39.4 kB 39.4 kB
Client Pages
vercel/next.js canary acdlite/next.js refactor-layout-router Change
_app-HASH.js gzip 193 B 193 B
_error-HASH.js gzip 193 B 193 B
amp-HASH.js gzip 512 B 510 B N/A
css-HASH.js gzip 343 B 342 B N/A
dynamic-HASH.js gzip 1.84 kB 1.84 kB
edge-ssr-HASH.js gzip 265 B 265 B
head-HASH.js gzip 363 B 362 B N/A
hooks-HASH.js gzip 393 B 392 B N/A
image-HASH.js gzip 4.49 kB 4.49 kB N/A
index-HASH.js gzip 268 B 268 B
link-HASH.js gzip 2.35 kB 2.34 kB N/A
routerDirect..HASH.js gzip 328 B 328 B
script-HASH.js gzip 397 B 397 B
withRouter-HASH.js gzip 323 B 326 B N/A
1afbb74e6ecf..834.css gzip 106 B 106 B
Overall change 3.59 kB 3.59 kB
Client Build Manifests
vercel/next.js canary acdlite/next.js refactor-layout-router Change
_buildManifest.js gzip 747 B 746 B N/A
Overall change 0 B 0 B
Rendered Page Sizes
vercel/next.js canary acdlite/next.js refactor-layout-router Change
index.html gzip 524 B 522 B N/A
link.html gzip 539 B 537 B N/A
withRouter.html gzip 520 B 519 B N/A
Overall change 0 B 0 B
Edge SSR bundle Size
vercel/next.js canary acdlite/next.js refactor-layout-router Change
edge-ssr.js gzip 128 kB 128 kB N/A
page.js gzip 203 kB 203 kB N/A
Overall change 0 B 0 B
Middleware size
vercel/next.js canary acdlite/next.js refactor-layout-router Change
middleware-b..fest.js gzip 671 B 667 B N/A
middleware-r..fest.js gzip 155 B 156 B N/A
middleware.js gzip 31.2 kB 31.2 kB N/A
edge-runtime..pack.js gzip 844 B 844 B
Overall change 844 B 844 B
Next Runtimes
vercel/next.js canary acdlite/next.js refactor-layout-router Change
523-experime...dev.js gzip 322 B 322 B
523.runtime.dev.js gzip 314 B 314 B
app-page-exp...dev.js gzip 323 kB 323 kB N/A
app-page-exp..prod.js gzip 127 kB 127 kB N/A
app-page-tur..prod.js gzip 140 kB 140 kB N/A
app-page-tur..prod.js gzip 135 kB 135 kB N/A
app-page.run...dev.js gzip 313 kB 313 kB N/A
app-page.run..prod.js gzip 123 kB 123 kB N/A
app-route-ex...dev.js gzip 37.3 kB 37.3 kB
app-route-ex..prod.js gzip 25.4 kB 25.4 kB
app-route-tu..prod.js gzip 25.4 kB 25.4 kB
app-route-tu..prod.js gzip 25.2 kB 25.2 kB
app-route.ru...dev.js gzip 38.9 kB 38.9 kB
app-route.ru..prod.js gzip 25.2 kB 25.2 kB
pages-api-tu..prod.js gzip 9.67 kB 9.67 kB
pages-api.ru...dev.js gzip 11.6 kB 11.6 kB
pages-api.ru..prod.js gzip 9.66 kB 9.66 kB
pages-turbo...prod.js gzip 21.7 kB 21.7 kB
pages.runtim...dev.js gzip 27.4 kB 27.4 kB
pages.runtim..prod.js gzip 21.7 kB 21.7 kB
server.runti..prod.js gzip 916 kB 916 kB
Overall change 1.2 MB 1.2 MB
build cache Overall increase ⚠️
vercel/next.js canary acdlite/next.js refactor-layout-router Change
0.pack gzip 2.05 MB 2.05 MB ⚠️ +3.24 kB
index.pack gzip 72.1 kB 72.6 kB ⚠️ +535 B
Overall change 2.12 MB 2.13 MB ⚠️ +3.77 kB
Diff details
Diff for 1187-HASH.js

Diff too large to display

Diff for main-HASH.js

Diff too large to display

Diff for app-page-exp..ntime.dev.js

Diff too large to display

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

Diff too large to display

Diff for app-page.runtime.prod.js

Diff too large to display

Commit: 9d7ab76

We probably will experiment with Activity soon but since it's not
currently being used, this removes the unused code from LayoutRouter.
@acdlite acdlite force-pushed the refactor-layout-router branch from 77d72f3 to 497ac71 Compare December 12, 2024 04:33
LayoutRouter has changed significantly since it was originally written
and the structure has become harder to follow. One thing I always find
confusing whenever I'm reading this code is that some of the values
correspond the the *parent* segment, while others correspond to the
*current* segment. So this moves the code around a bit and updates the
names so it's clearer which parts belong to which segments.

While working on this, I noticed a funny thing about how loading
boundaries work that was made more obvious by the revised naming. I've
left a TODO comment to follow up on whether this was intentional.
@acdlite acdlite force-pushed the refactor-layout-router branch from 497ac71 to 9d7ab76 Compare December 12, 2024 04:36
@acdlite acdlite marked this pull request as ready for review December 12, 2024 05:56
@acdlite acdlite requested a review from ztanner December 12, 2024 05:56
@acdlite acdlite merged commit 0b1eaf1 into vercel:canary Dec 12, 2024
86 checks passed
acdlite added a commit that referenced this pull request Dec 12, 2024
Based on:

- #73826 

---

This removes the `segmentPath` prop from the LayoutRouter payload. This
can be derived on the client from the FlightRouterState instead.
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 27, 2024
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants