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

Add support for passing ref to next/link with new behavior enabled #36537

Merged
merged 1 commit into from Apr 28, 2022
Merged

Add support for passing ref to next/link with new behavior enabled #36537

merged 1 commit into from Apr 28, 2022

Conversation

timneutkens
Copy link
Member

Found this case on the vercel.com app after running the codemod. A TypeScript error surfaced for ref on next/link as unsupported.

Current code:

const ref = useRef()

<Link href="/">
  <a ref={ref}>
    Home
  </a>
</Link>

Code after codemod:

const ref = useRef()

<Link href="/" ref={ref}> // Results in a TS error, also does not work as expected.
  Home
</Link>

This PR makes the code after running the codemod work.

Bug

  • Related issues linked using fixes #number
  • Integration tests added
  • Errors have helpful link attached, see contributing.md

Feature

  • Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
  • Related issues linked using fixes #number
  • Integration tests added
  • Documentation added
  • Telemetry added. In case of a feature if it's used or not.
  • Errors have helpful link attached, see contributing.md

Documentation / Examples

  • Make sure the linting passes by running yarn lint

@ijjk ijjk added created-by: Next.js team PRs by the Next.js team type: next labels Apr 28, 2022
@ijjk
Copy link
Member

ijjk commented Apr 28, 2022

Stats from current PR

Default Build (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary timneutkens/next.js add/ref-passing-new-link Change
buildDuration 15.8s 14.8s -1s
buildDurationCached 5.9s 6.1s ⚠️ +149ms
nodeModulesSize 463 MB 463 MB ⚠️ +177 B
Page Load Tests Overall increase ✓
vercel/next.js canary timneutkens/next.js add/ref-passing-new-link Change
/ failed reqs 0 0 ✓
/ total time (seconds) 3.24 3.145 -0.1
/ avg req/sec 771.58 794.84 +23.26
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.327 1.33 0
/error-in-render avg req/sec 1883.57 1880.15 ⚠️ -3.42
Client Bundles (main, webpack)
vercel/next.js canary timneutkens/next.js add/ref-passing-new-link Change
925.HASH.js gzip 179 B 179 B ✓
framework-HASH.js gzip 42 kB 42 kB ✓
main-HASH.js gzip 28.6 kB 28.6 kB ✓
webpack-HASH.js gzip 1.44 kB 1.44 kB ✓
Overall change 72.3 kB 72.3 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary timneutkens/next.js add/ref-passing-new-link Change
polyfills-HASH.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages Overall increase ⚠️
vercel/next.js canary timneutkens/next.js add/ref-passing-new-link Change
_app-HASH.js gzip 1.36 kB 1.36 kB ✓
_error-HASH.js gzip 193 B 193 B ✓
amp-HASH.js gzip 308 B 308 B ✓
css-HASH.js gzip 327 B 327 B ✓
dynamic-HASH.js gzip 3.08 kB 3.08 kB ✓
head-HASH.js gzip 359 B 359 B ✓
hooks-HASH.js gzip 920 B 920 B ✓
image-HASH.js gzip 5.71 kB 5.71 kB ✓
index-HASH.js gzip 263 B 263 B ✓
link-HASH.js gzip 2.63 kB 2.64 kB ⚠️ +15 B
routerDirect..HASH.js gzip 320 B 320 B ✓
script-HASH.js gzip 391 B 391 B ✓
withRouter-HASH.js gzip 318 B 318 B ✓
85e02e95b279..7e3.css gzip 107 B 107 B ✓
Overall change 16.3 kB 16.3 kB ⚠️ +15 B
Client Build Manifests
vercel/next.js canary timneutkens/next.js add/ref-passing-new-link Change
_buildManifest.js gzip 459 B 459 B ✓
Overall change 459 B 459 B ✓
Rendered Page Sizes Overall decrease ✓
vercel/next.js canary timneutkens/next.js add/ref-passing-new-link Change
index.html gzip 531 B 531 B ✓
link.html gzip 545 B 544 B -1 B
withRouter.html gzip 526 B 526 B ✓
Overall change 1.6 kB 1.6 kB -1 B

Diffs

Diff for _buildManifest.js 
@@ -13,7 +13,7 @@ self.__BUILD_MANIFEST = {
   "/head": ["static\u002Fchunks\u002Fpages\u002Fhead-544bb68363445a0e.js"],
   "/hooks": ["static\u002Fchunks\u002Fpages\u002Fhooks-c1372eeb4916d32c.js"],
   "/image": ["static\u002Fchunks\u002Fpages\u002Fimage-75136b1767faacf3.js"],
-  "/link": ["static\u002Fchunks\u002Fpages\u002Flink-b2c86b9b6041c9a3.js"],
+  "/link": ["static\u002Fchunks\u002Fpages\u002Flink-ca5e63d57db66cd2.js"],
   "/routerDirect": [
     "static\u002Fchunks\u002Fpages\u002FrouterDirect-113a7082ae16fbcb.js"
   ],
Diff for link-HASH.js 
@@ -191,7 +191,10 @@
           scroll: scroll
         });
       }
-      function Link(props) {
+      var Link = /*#__PURE__*/ _react.default.forwardRef(function(
+        props,
+        forwardedRef
+      ) {
         var _legacyBehavior = props.legacyBehavior,
           legacyBehavior =
             _legacyBehavior === void 0
@@ -269,8 +272,9 @@
             child = _react.default.Children.only(children);
           }
         }
-        var childRef =
-          legacyBehavior && child && typeof child === "object" && child.ref;
+        var childRef = legacyBehavior
+          ? child && typeof child === "object" && child.ref
+          : forwardedRef;
         var ref1 = _slicedToArray(
             (0, _useIntersection).useIntersection({
               rootMargin: "200px"
@@ -289,14 +293,14 @@
               previousHref.current = href;
             }
             setIntersectionRef(el);
-            if (legacyBehavior && childRef) {
+            if (childRef) {
               if (typeof childRef === "function") childRef(el);
               else if (typeof childRef === "object") {
                 childRef.current = el;
               }
             }
           },
-          [as, childRef, href, resetVisible, setIntersectionRef, legacyBehavior]
+          [as, childRef, href, resetVisible, setIntersectionRef]
         );
         _react.default.useEffect(
           function() {
@@ -397,7 +401,7 @@
               Object.assign({}, restProps, childProps),
               children
             );
-      }
+      });
       var _default = Link;
       exports["default"] = _default;
       if (
Diff for link.html 
@@ -27,7 +27,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/pages/link-b2c86b9b6041c9a3.js"
+      src="/_next/static/chunks/pages/link-ca5e63d57db66cd2.js"
       defer=""
     ></script>
     <script src="/_next/static/BUILD_ID/_buildManifest.js" defer=""></script>
Default Build with SWC (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary timneutkens/next.js add/ref-passing-new-link Change
buildDuration 17.2s 16.8s -397ms
buildDurationCached 6.2s 6s -199ms
nodeModulesSize 463 MB 463 MB ⚠️ +177 B
Page Load Tests Overall decrease ⚠️
vercel/next.js canary timneutkens/next.js add/ref-passing-new-link Change
/ failed reqs 0 0 ✓
/ total time (seconds) 3.236 3.302 ⚠️ +0.07
/ avg req/sec 772.44 757.12 ⚠️ -15.32
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.374 1.373 0
/error-in-render avg req/sec 1819.87 1820.42 +0.55
Client Bundles (main, webpack)
vercel/next.js canary timneutkens/next.js add/ref-passing-new-link Change
925.HASH.js gzip 178 B 178 B ✓
framework-HASH.js gzip 42.2 kB 42.2 kB ✓
main-HASH.js gzip 29.1 kB 29.1 kB ✓
webpack-HASH.js gzip 1.45 kB 1.45 kB ✓
Overall change 72.9 kB 72.9 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary timneutkens/next.js add/ref-passing-new-link Change
polyfills-HASH.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages Overall increase ⚠️
vercel/next.js canary timneutkens/next.js add/ref-passing-new-link Change
_app-HASH.js gzip 1.35 kB 1.35 kB ✓
_error-HASH.js gzip 179 B 179 B ✓
amp-HASH.js gzip 312 B 312 B ✓
css-HASH.js gzip 324 B 324 B ✓
dynamic-HASH.js gzip 3.08 kB 3.08 kB ✓
head-HASH.js gzip 357 B 357 B ✓
hooks-HASH.js gzip 921 B 921 B ✓
image-HASH.js gzip 5.76 kB 5.76 kB ✓
index-HASH.js gzip 261 B 261 B ✓
link-HASH.js gzip 2.74 kB 2.76 kB ⚠️ +23 B
routerDirect..HASH.js gzip 322 B 322 B ✓
script-HASH.js gzip 392 B 392 B ✓
withRouter-HASH.js gzip 317 B 317 B ✓
85e02e95b279..7e3.css gzip 107 B 107 B ✓
Overall change 16.4 kB 16.5 kB ⚠️ +23 B
Client Build Manifests Overall increase ⚠️
vercel/next.js canary timneutkens/next.js add/ref-passing-new-link Change
_buildManifest.js gzip 457 B 458 B ⚠️ +1 B
Overall change 457 B 458 B ⚠️ +1 B
Rendered Page Sizes
vercel/next.js canary timneutkens/next.js add/ref-passing-new-link Change
index.html gzip 527 B 527 B ✓
link.html gzip 541 B 541 B ✓
withRouter.html gzip 525 B 525 B ✓
Overall change 1.59 kB 1.59 kB ✓

Diffs

Diff for _buildManifest.js 
@@ -13,7 +13,7 @@ self.__BUILD_MANIFEST = {
   "/head": ["static\u002Fchunks\u002Fpages\u002Fhead-544bb68363445a0e.js"],
   "/hooks": ["static\u002Fchunks\u002Fpages\u002Fhooks-c1372eeb4916d32c.js"],
   "/image": ["static\u002Fchunks\u002Fpages\u002Fimage-75136b1767faacf3.js"],
-  "/link": ["static\u002Fchunks\u002Fpages\u002Flink-b2c86b9b6041c9a3.js"],
+  "/link": ["static\u002Fchunks\u002Fpages\u002Flink-ca5e63d57db66cd2.js"],
   "/routerDirect": [
     "static\u002Fchunks\u002Fpages\u002FrouterDirect-113a7082ae16fbcb.js"
   ],
Diff for link-HASH.js 
@@ -191,7 +191,10 @@
           scroll: scroll
         });
       }
-      function Link(props) {
+      var Link = /*#__PURE__*/ _react.default.forwardRef(function(
+        props,
+        forwardedRef
+      ) {
         var _legacyBehavior = props.legacyBehavior,
           legacyBehavior =
             _legacyBehavior === void 0
@@ -269,8 +272,9 @@
             child = _react.default.Children.only(children);
           }
         }
-        var childRef =
-          legacyBehavior && child && typeof child === "object" && child.ref;
+        var childRef = legacyBehavior
+          ? child && typeof child === "object" && child.ref
+          : forwardedRef;
         var ref1 = _slicedToArray(
             (0, _useIntersection).useIntersection({
               rootMargin: "200px"
@@ -289,14 +293,14 @@
               previousHref.current = href;
             }
             setIntersectionRef(el);
-            if (legacyBehavior && childRef) {
+            if (childRef) {
               if (typeof childRef === "function") childRef(el);
               else if (typeof childRef === "object") {
                 childRef.current = el;
               }
             }
           },
-          [as, childRef, href, resetVisible, setIntersectionRef, legacyBehavior]
+          [as, childRef, href, resetVisible, setIntersectionRef]
         );
         _react.default.useEffect(
           function() {
@@ -397,7 +401,7 @@
               Object.assign({}, restProps, childProps),
               children
             );
-      }
+      });
       var _default = Link;
       exports["default"] = _default;
       if (
Diff for link.html 
@@ -27,7 +27,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/pages/link-b2c86b9b6041c9a3.js"
+      src="/_next/static/chunks/pages/link-ca5e63d57db66cd2.js"
       defer=""
     ></script>
     <script src="/_next/static/BUILD_ID/_buildManifest.js" defer=""></script>
Commit: 867292b

@timneutkens timneutkens merged commit 2451f52 into vercel:canary Apr 28, 2022
@timneutkens timneutkens deleted the add/ref-passing-new-link branch April 28, 2022 09:32
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@Brooooooklyn Brooooooklyn Brooooooklyn approved these changes

@ijjk ijjk Awaiting requested review from ijjk ijjk is a code owner

@shuding shuding Awaiting requested review from shuding shuding is a code owner

@huozhi huozhi Awaiting requested review from huozhi huozhi is a code owner

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

Successfully merging this pull request may close these issues.

None yet
3 participants
@timneutkens @ijjk @Brooooooklyn