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

feat: migrate React.dev to the App Router #7437

Merged
merged 39 commits into from
Feb 1, 2025

Conversation

feedthejim
Copy link
Contributor

@feedthejim feedthejim commented Jan 19, 2025

What

This PR converts all of the react.dev codebase to use the App Router.

Why

I wanted to prepare it for dogfooding future features of React and Next.js.

In this PR

  • implemented/fixed HMR when editing mdx files
  • rewrote the post-processing we did to be actual remark plugins
  • rewrote the RSS script to use static route handlers
  • rewrote the page rendering code to use server components, streamlining some of the logic
  • leveraged Next.js's metadata methods
  • enabled the new Next.js Error Overlay
  • added myself as a site contributor
  • added a few minor polishes for perf, namely some font optimisations

Not in this PR

  • leveraging parallel routes for the sidebars
  • moving more content to be server components
  • a deeper refactor of the code to actually use pathname normally
  • a rewrite of the TOC, whose code is kinda weird today

Todo

  • convert main page
  • re-do MDX generation
  • convert error page
  • convert not found
  • convert errors/[error]
  • add back languages
  • optional: split sidebars with parallel routes
  • fix metadata gen
  • add /errors back
  • see if I can hack some router events alternative
  • fix TOC generation
  • re-do RSS generation
  • double check analytics logic
  • fix font flashing
  • make sure the path logic transformation is actually valid
  • check that the router methods have been replaced correctly

Copy link

vercel bot commented Jan 19, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
19-react-dev ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 1, 2025 4:35pm
react-dev ✅ Ready (Inspect) Visit Preview Feb 1, 2025 4:35pm

Copy link

github-actions bot commented Jan 19, 2025

Size changes

📦 Next.js Bundle Analysis for react-dev

This analysis was generated by the Next.js Bundle Analysis action. 🤖

🎉 Global Bundle Size Decreased

Page Size (compressed)
global 91.93 KB (🟢 -18.5 KB)
Details

The global bundle is the javascript bundle that loads alongside every page. It is in its own category because its impact is much higher - an increase to its size means that every page on your website loads slower, and a decrease means every page loads faster.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

If you want further insight into what is behind the changes, give @next/bundle-analyzer a try!

One Page Changed Size

The following page changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load
/_error 192 B (🟡 +2 B) 92.12 KB
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

Next to the size is how much the size has increased or decreased compared with the base branch of this PR. If this percentage has increased by 10% or more, there will be a red status indicator applied, indicating that special attention should be given to this.

@feedthejim feedthejim changed the title wip: upgrade to app router misc: migrate React.dev to the App Router Jan 31, 2025
@feedthejim feedthejim changed the title misc: migrate React.dev to the App Router feat: migrate React.dev to the App Router Jan 31, 2025
@feedthejim feedthejim marked this pull request as ready for review January 31, 2025 17:52
@@ -1,18 +1,24 @@
'use client';
Copy link
Member

Choose a reason for hiding this comment

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

Not a server component?

Copy link
Member

Choose a reason for hiding this comment

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

src/content/learn/index.md Outdated Show resolved Hide resolved
Copy link
Member

@rickhanlonii rickhanlonii left a comment

Choose a reason for hiding this comment

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

sick thanks!

@rickhanlonii rickhanlonii merged commit 0eb0f88 into reactjs:main Feb 1, 2025
8 checks passed
@gaearon
Copy link
Member

gaearon commented Feb 1, 2025

Noticed a significant UX regression.

Previously the sidebar would animate and preserve scroll position on click:

Screen.Recording.2025-02-01.at.18.57.07.mov

Now it doesn't:

Screen.Recording.2025-02-01.at.18.57.37.mov

The lack of animation is maybe tolerable but the jumping is not tolerable — it immediately makes the site feel unpolished. We specifically took care for it not to jump in the previous implementation.

IMO this has to either be a fast-follow fix or a revert until App Router can handle this (if App Router doesn't let us preserve scroll position easily there). I assume this has to be fixable? Is this what the parallel route refactor will do?

@gaearon
Copy link
Member

gaearon commented Feb 1, 2025

TOC slightly regressed. Before:

Screenshot 2025-02-01 at 19 08 02

After:

Screenshot 2025-02-01 at 19 08 09

(Note the lonely set.)

@gaearon
Copy link
Member

gaearon commented Feb 1, 2025

Links to specific example tabs are broken.

For example: https://react-gu30t1oio-fbopensource.vercel.app/reference/react/useState#passing-the-initial-state-directly

This works on the old site.

On the new site, https://react.dev/reference/react/useState#passing-the-next-state-directly still displays the first tab.

gaearon added a commit that referenced this pull request Feb 1, 2025
@gaearon
Copy link
Member

gaearon commented Feb 1, 2025

After navigating to a fragment link and then to another page, the Back button gets completely borked:

back.mov

@gaearon
Copy link
Member

gaearon commented Feb 1, 2025

I suggest reverting at least until the navigation bugs are fixed since they interfere with people using the site.

#7466

gaearon added a commit that referenced this pull request Feb 1, 2025
@gaearon
Copy link
Member

gaearon commented Feb 1, 2025

Also, have we done a webpagetest comparison for the index page and for a few docs pages? Is this neutral or an improvement? Seems like it would be bad to land without verifying that it hasn't regressed on perf.

@gaearon
Copy link
Member

gaearon commented Feb 1, 2025

(Sorry to be annoying btw! Really appreciate your work there. I think this is close but just needs a bit of polish so that it doesn’t regress the functionality.)

@feedthejim
Copy link
Contributor Author

No problem at all, there was some transformed code that I was not sure where they exactly applied.

@rickhanlonii lets revert it and I can dig deeper.

@gaearon if you have some other specific scenarios I can verify, please let me know 🙏

@gaearon
Copy link
Member

gaearon commented Feb 1, 2025

I was mostly just stress-testing navigation (all kinds — via sidebar, via footer links, normal links, fragment and example and TOC links) and jumping back and forth using Back/Forward.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants