fix(#33081): handle relative path correctly #36823

SukkaW · 2022-05-11T03:41:00Z

Bug

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

Fixes #36823
Closes #33084
Fixes: #33081

The issue is caused by the isLocalURL function only checks if a URL starts with /, # or ?. So a URL that starts with . will not be considered a "local URL". The PR fixes that by introducing a new util function isAbsoluteUrl that is fully compliant with RFC3986.

ijjk · 2022-05-11T04:06:45Z

Stats from current PR

Default Build (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	SukkaW/next.js fix-link-relative-path	Change
buildDuration	18.3s	20s	⚠️ +1.8s
buildDurationCached	7.8s	6.8s	-1s
nodeModulesSize	479 MB	479 MB	⚠️ +738 B

Page Load Tests Overall increase ✓

	vercel/next.js canary	SukkaW/next.js fix-link-relative-path	Change
/ failed reqs	0	0	✓
/ total time (seconds)	5.13	4.929	-0.2
/ avg req/sec	487.28	507.19	+19.91
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.931	1.947	⚠️ +0.02
/error-in-render avg req/sec	1294.83	1283.99	⚠️ -10.84

Client Bundles (main, webpack) Overall increase ⚠️

	vercel/next.js canary	SukkaW/next.js fix-link-relative-path	Change
925.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42 kB	42 kB	✓
main-HASH.js gzip	29 kB	29.1 kB	⚠️ +56 B
webpack-HASH.js gzip	1.54 kB	1.54 kB	✓
Overall change	72.8 kB	72.8 kB	⚠️ +56 B

Legacy Client Bundles (polyfills)

	vercel/next.js canary	SukkaW/next.js fix-link-relative-path	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	SukkaW/next.js fix-link-relative-path	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	2.71 kB	2.71 kB	✓
head-HASH.js gzip	359 B	359 B	✓
hooks-HASH.js gzip	920 B	920 B	✓
image-HASH.js gzip	5.73 kB	5.73 kB	✓
index-HASH.js gzip	263 B	263 B	✓
link-HASH.js gzip	2.65 kB	2.65 kB	✓
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 kB	16 kB	✓

Client Build Manifests

	vercel/next.js canary	SukkaW/next.js fix-link-relative-path	Change
_buildManifest.js gzip	458 B	458 B	✓
Overall change	458 B	458 B	✓

Rendered Page Sizes

	vercel/next.js canary	SukkaW/next.js fix-link-relative-path	Change
index.html gzip	532 B	532 B	✓
link.html gzip	546 B	546 B	✓
withRouter.html gzip	527 B	527 B	✓
Overall change	1.6 kB	1.6 kB	✓

Diffs

Diff for main-HASH.js

@@ -4649,8 +4649,7 @@
       }
       function isLocalURL(url) {
         // prevent a hydration mismatch on href for url with anchor refs
-        if (url.startsWith("/") || url.startsWith("#") || url.startsWith("?"))
-          return true;
+        if (!(0, _utils).isAbsoluteUrl(url)) return true;
         try {
           // absolute urls can be local if they are on the same origin
           var locationOrigin = (0, _utils).getLocationOrigin();
@@ -7111,7 +7110,11 @@
       var _querystring = __webpack_require__(4919);
       function parseRelativeUrl(url, base) {
         var globalBase = new URL(false ? 0 : (0, _utils).getLocationOrigin());
-        var resolvedBase = base ? new URL(base, globalBase) : globalBase;
+        var resolvedBase = base
+          ? new URL(base, globalBase)
+          : url.startsWith(".")
+          ? new URL(false ? 0 : window.location.href)
+          : globalBase;
         var ref = new URL(url, resolvedBase),
           pathname = ref.pathname,
           searchParams = ref.searchParams,
@@ -8437,7 +8440,7 @@
       exports.isResSent = isResSent;
       exports.normalizeRepeatedSlashes = normalizeRepeatedSlashes;
       exports.loadGetInitialProps = loadGetInitialProps;
-      exports.ST = exports.SP = exports.warnOnce = void 0;
+      exports.ST = exports.SP = exports.warnOnce = exports.isAbsoluteUrl = void 0;
       function execOnce(fn) {
         var used = false;
         var result;
@@ -8456,6 +8459,13 @@
           return result;
         };
       }
+      // Scheme: https://tools.ietf.org/html/rfc3986#section-3.1
+      // Absolute URL: https://tools.ietf.org/html/rfc3986#section-4.3
+      var ABSOLUTE_URL_REGEX = /^[a-zA-Z][a-zA-Z\d+\-.]*?:/;
+      var isAbsoluteUrl = function(url) {
+        return ABSOLUTE_URL_REGEX.test(url);
+      };
+      exports.isAbsoluteUrl = isAbsoluteUrl;
       function getLocationOrigin() {
         var _location = window.location,
           protocol = _location.protocol,

Diff for index.html

@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-7c48d7922fb4ac24.js"
+      src="/_next/static/chunks/main-a8cf4a5d1e521c01.js"
       defer=""
     ></script>
     <script

Diff for link.html

@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-7c48d7922fb4ac24.js"
+      src="/_next/static/chunks/main-a8cf4a5d1e521c01.js"
       defer=""
     ></script>
     <script

Diff for withRouter.html

@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-7c48d7922fb4ac24.js"
+      src="/_next/static/chunks/main-a8cf4a5d1e521c01.js"
       defer=""
     ></script>
     <script

Default Build with SWC (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	SukkaW/next.js fix-link-relative-path	Change
buildDuration	21.9s	21.2s	-706ms
buildDurationCached	7.7s	7.3s	-428ms
nodeModulesSize	479 MB	479 MB	⚠️ +738 B

Page Load Tests Overall increase ✓

	vercel/next.js canary	SukkaW/next.js fix-link-relative-path	Change
/ failed reqs	0	0	✓
/ total time (seconds)	5.117	4.94	-0.18
/ avg req/sec	488.57	506.11	+17.54
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	2.155	2.01	-0.15
/error-in-render avg req/sec	1160.27	1243.89	+83.62

Client Bundles (main, webpack) Overall increase ⚠️

	vercel/next.js canary	SukkaW/next.js fix-link-relative-path	Change
925.HASH.js gzip	178 B	178 B	✓
framework-HASH.js gzip	42.7 kB	42.7 kB	✓
main-HASH.js gzip	29.5 kB	29.6 kB	⚠️ +65 B
webpack-HASH.js gzip	1.54 kB	1.54 kB	✓
Overall change	73.9 kB	74 kB	⚠️ +65 B

Legacy Client Bundles (polyfills)

	vercel/next.js canary	SukkaW/next.js fix-link-relative-path	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	SukkaW/next.js fix-link-relative-path	Change
_app-HASH.js gzip	1.35 kB	1.35 kB	✓
_error-HASH.js gzip	179 B	179 B	✓
amp-HASH.js gzip	311 B	311 B	✓
css-HASH.js gzip	324 B	324 B	✓
dynamic-HASH.js gzip	2.89 kB	2.89 kB	✓
head-HASH.js gzip	357 B	357 B	✓
hooks-HASH.js gzip	920 B	920 B	✓
image-HASH.js gzip	5.82 kB	5.82 kB	✓
index-HASH.js gzip	261 B	261 B	✓
link-HASH.js gzip	2.78 kB	2.78 kB	✓
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.3 kB	16.3 kB	✓

Client Build Manifests

	vercel/next.js canary	SukkaW/next.js fix-link-relative-path	Change
_buildManifest.js gzip	457 B	457 B	✓
Overall change	457 B	457 B	✓

Rendered Page Sizes Overall decrease ✓

	vercel/next.js canary	SukkaW/next.js fix-link-relative-path	Change
index.html gzip	533 B	533 B	✓
link.html gzip	547 B	547 B	✓
withRouter.html gzip	529 B	528 B	-1 B
Overall change	1.61 kB	1.61 kB	-1 B

Diffs

Diff for main-HASH.js

@@ -4649,8 +4649,7 @@
       }
       function isLocalURL(url) {
         // prevent a hydration mismatch on href for url with anchor refs
-        if (url.startsWith("/") || url.startsWith("#") || url.startsWith("?"))
-          return true;
+        if (!(0, _utils).isAbsoluteUrl(url)) return true;
         try {
           // absolute urls can be local if they are on the same origin
           var locationOrigin = (0, _utils).getLocationOrigin();
@@ -7111,7 +7110,11 @@
       var _querystring = __webpack_require__(4919);
       function parseRelativeUrl(url, base) {
         var globalBase = new URL(false ? 0 : (0, _utils).getLocationOrigin());
-        var resolvedBase = base ? new URL(base, globalBase) : globalBase;
+        var resolvedBase = base
+          ? new URL(base, globalBase)
+          : url.startsWith(".")
+          ? new URL(false ? 0 : window.location.href)
+          : globalBase;
         var ref = new URL(url, resolvedBase),
           pathname = ref.pathname,
           searchParams = ref.searchParams,
@@ -8437,7 +8440,7 @@
       exports.isResSent = isResSent;
       exports.normalizeRepeatedSlashes = normalizeRepeatedSlashes;
       exports.loadGetInitialProps = loadGetInitialProps;
-      exports.ST = exports.SP = exports.warnOnce = void 0;
+      exports.ST = exports.SP = exports.warnOnce = exports.isAbsoluteUrl = void 0;
       function execOnce(fn) {
         var used = false;
         var result;
@@ -8456,6 +8459,13 @@
           return result;
         };
       }
+      // Scheme: https://tools.ietf.org/html/rfc3986#section-3.1
+      // Absolute URL: https://tools.ietf.org/html/rfc3986#section-4.3
+      var ABSOLUTE_URL_REGEX = /^[a-zA-Z][a-zA-Z\d+\-.]*?:/;
+      var isAbsoluteUrl = function(url) {
+        return ABSOLUTE_URL_REGEX.test(url);
+      };
+      exports.isAbsoluteUrl = isAbsoluteUrl;
       function getLocationOrigin() {
         var _location = window.location,
           protocol = _location.protocol,

Diff for index.html

@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-7c48d7922fb4ac24.js"
+      src="/_next/static/chunks/main-a8cf4a5d1e521c01.js"
       defer=""
     ></script>
     <script

Diff for link.html

@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-7c48d7922fb4ac24.js"
+      src="/_next/static/chunks/main-a8cf4a5d1e521c01.js"
       defer=""
     ></script>
     <script

Diff for withRouter.html

@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-7c48d7922fb4ac24.js"
+      src="/_next/static/chunks/main-a8cf4a5d1e521c01.js"
       defer=""
     ></script>
     <script

Commit: 6edbe8c

ijjk

Change and added tests look good, thanks!

SukkaW added 4 commits May 11, 2022 09:36

fix(parseRelativeUrl): parse relative path correctly

a33f425

test: add relative path test case

8cb319a

fix(router): avoid relative path causes hydration mismatch

0ff5279

test: fix relative path page location

e1c6f85

SukkaW requested review from timneutkens, ijjk, shuding and huozhi as code owners May 11, 2022 03:41

ijjk added the type: next label May 11, 2022

SukkaW mentioned this pull request May 11, 2022

fix(router): allow relative navigation from index pages #33084

Closed

10 tasks

SukkaW force-pushed the fix-link-relative-path branch from 617aaa7 to e1c6f85 Compare May 11, 2022 23:48

SukkaW added 2 commits May 12, 2022 08:46

Merge branch 'canary' into fix-link-relative-path

d9bc8d7

Merge branch 'canary' into fix-link-relative-path

29b7189

SukkaW requested a review from padmaia as a code owner May 18, 2022 14:39

SukkaW force-pushed the fix-link-relative-path branch from b553818 to 29b7189 Compare May 18, 2022 14:40

SukkaW added 2 commits May 18, 2022 22:40

Merge branch 'canary' into fix-link-relative-path

d0c65ac

perf(router): simplify parseRelativeUrl base computing

a386986

ijjk approved these changes May 22, 2022

View reviewed changes

Merge branch 'canary' into fix-link-relative-path

6edbe8c

kodiakhq bot merged commit 87826ee into vercel:canary May 22, 2022

github-actions bot locked as resolved and limited conversation to collaborators Jun 22, 2022

SukkaW deleted the fix-link-relative-path branch October 24, 2023 08:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(#33081): handle relative path correctly #36823

fix(#33081): handle relative path correctly #36823

SukkaW commented May 11, 2022 •

edited by ijjk

Loading

ijjk commented May 11, 2022 •

edited

Loading

Diffs

Diffs

ijjk left a comment

fix(#33081): handle relative path correctly #36823

fix(#33081): handle relative path correctly #36823

Conversation

SukkaW commented May 11, 2022 • edited by ijjk Loading

Bug

ijjk commented May 11, 2022 • edited Loading

Stats from current PR

Diffs

Diffs

ijjk left a comment

Choose a reason for hiding this comment

SukkaW commented May 11, 2022 •

edited by ijjk

Loading

ijjk commented May 11, 2022 •

edited

Loading