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

Ensure external middleware rewrite is handled correctly #33962

Merged
merged 2 commits into from Feb 4, 2022

Conversation

ijjk
Copy link
Member

@ijjk ijjk commented Feb 3, 2022

This ensures we do a hard navigation correctly when a middleware does an external rewrite so that it can be proxied correctly.

Bug

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

Fixes: #33942

@ijjk ijjk added created-by: Next.js team type: next labels Feb 3, 2022
@ijjk

This comment has been minimized.

@ijjk ijjk marked this pull request as ready for review Feb 3, 2022
@ijjk ijjk requested review from huozhi, shuding and timneutkens as code owners Feb 3, 2022
@ijjk ijjk requested a review from javivelasco Feb 3, 2022
Copy link
Contributor

@j-mendez j-mendez left a comment

nice test! lg2m.

@ijjk
Copy link
Member Author

ijjk commented Feb 4, 2022

Stats from current PR

Default Build (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary ijjk/next.js fix/external-rewrite-middleware Change
buildDuration 14.2s 14.1s -119ms
buildDurationCached 5.7s 5.4s -249ms
nodeModulesSize 359 MB 359 MB ⚠️ +303 B
Page Load Tests Overall increase ✓
vercel/next.js canary ijjk/next.js fix/external-rewrite-middleware Change
/ failed reqs 0 0
/ total time (seconds) 2.606 2.553 -0.05
/ avg req/sec 959.25 979.19 +19.94
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.326 1.281 -0.05
/error-in-render avg req/sec 1885.44 1951.71 +66.27
Client Bundles (main, webpack, commons) Overall increase ⚠️
vercel/next.js canary ijjk/next.js fix/external-rewrite-middleware Change
450.HASH.js gzip 179 B 179 B
framework-HASH.js gzip 42.2 kB 42.2 kB
main-HASH.js gzip 27.3 kB 27.3 kB ⚠️ +6 B
webpack-HASH.js gzip 1.44 kB 1.44 kB
Overall change 71.2 kB 71.2 kB ⚠️ +6 B
Legacy Client Bundles (polyfills)
vercel/next.js canary ijjk/next.js fix/external-rewrite-middleware Change
polyfills-HASH.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary ijjk/next.js fix/external-rewrite-middleware Change
_app-HASH.js gzip 1.37 kB 1.37 kB
_error-HASH.js gzip 194 B 194 B
amp-HASH.js gzip 312 B 312 B
css-HASH.js gzip 326 B 326 B
dynamic-HASH.js gzip 2.37 kB 2.37 kB
head-HASH.js gzip 350 B 350 B
hooks-HASH.js gzip 919 B 919 B
image-HASH.js gzip 4.94 kB 4.94 kB
index-HASH.js gzip 263 B 263 B
link-HASH.js gzip 2.19 kB 2.19 kB
routerDirect..HASH.js gzip 321 B 321 B
script-HASH.js gzip 383 B 383 B
withRouter-HASH.js gzip 318 B 318 B
85e02e95b279..7e3.css gzip 107 B 107 B
Overall change 14.3 kB 14.3 kB
Client Build Manifests
vercel/next.js canary ijjk/next.js fix/external-rewrite-middleware Change
_buildManifest.js gzip 459 B 459 B
Overall change 459 B 459 B
Rendered Page Sizes Overall increase ⚠️
vercel/next.js canary ijjk/next.js fix/external-rewrite-middleware Change
index.html gzip 528 B 530 B ⚠️ +2 B
link.html gzip 543 B 545 B ⚠️ +2 B
withRouter.html gzip 524 B 526 B ⚠️ +2 B
Overall change 1.59 kB 1.6 kB ⚠️ +6 B

Diffs

Diff for main-HASH.js
@@ -6201,8 +6201,7 @@
               var _this = this;
               return _asyncToGenerator(
                 _runtimeJs.default.mark(function _callee() {
-                  var ref,
-                    cleanedAs,
+                  var cleanedAs,
                     fns,
                     requiresPreflight,
                     preflight,
@@ -6211,7 +6210,7 @@
                     matchedPage,
                     resolvedHref,
                     cleanRedirect,
-                    ref5,
+                    ref,
                     newUrl,
                     newAs;
                   return _runtimeJs.default.wrap(function _callee$(_ctx) {
@@ -6224,9 +6223,9 @@
                               : options.as,
                             _this.locale
                           );
-                          _ctx.next = 4;
+                          _ctx.next = 3;
                           return _this.pageLoader.getMiddlewareList();
-                        case 4:
+                        case 3:
                           fns = _ctx.sent;
                           requiresPreflight = fns.some(function(param) {
                             var _param = _slicedToArray(param, 2),
@@ -6240,29 +6239,33 @@
                             )(cleanedAs);
                           });
                           if (requiresPreflight) {
-                            _ctx.next = 8;
+                            _ctx.next = 7;
                             break;
                           }
                           return _ctx.abrupt("return", {
                             type: "next"
                           });
-                        case 8:
-                          _ctx.next = 10;
+                        case 7:
+                          _ctx.next = 9;
                           return _this._getPreflightData({
                             preflightHref: options.as,
                             shouldCache: options.cache
                           });
-                        case 10:
+                        case 9:
                           preflight = _ctx.sent;
-                          if (
-                            !((ref = preflight.rewrite) === null ||
-                            ref === void 0
-                              ? void 0
-                              : ref.startsWith("/"))
-                          ) {
-                            _ctx.next = 18;
+                          if (!preflight.rewrite) {
+                            _ctx.next = 19;
                             break;
                           }
+                          if (preflight.rewrite.startsWith("/")) {
+                            _ctx.next = 13;
+                            break;
+                          }
+                          return _ctx.abrupt("return", {
+                            type: "redirect",
+                            destination: options.as
+                          });
+                        case 13:
                           parsed = (0, _parseRelativeUrl).parseRelativeUrl(
                             (0, _normalizeLocalePath).normalizeLocalePath(
                               hasBasePath(preflight.rewrite)
@@ -6297,13 +6300,13 @@
                             matchedPage: matchedPage,
                             resolvedHref: resolvedHref
                           });
-                        case 18:
+                        case 19:
                           if (!preflight.redirect) {
-                            _ctx.next = 24;
+                            _ctx.next = 25;
                             break;
                           }
                           if (!preflight.redirect.startsWith("/")) {
-                            _ctx.next = 23;
+                            _ctx.next = 24;
                             break;
                           }
                           cleanRedirect = (0,
@@ -6315,36 +6318,36 @@
                               _this.locales
                             ).pathname
                           );
-                          (ref5 = prepareUrlAs(
+                          (ref = prepareUrlAs(
                             _this,
                             cleanRedirect,
                             cleanRedirect
                           )),
-                            (newUrl = ref5.url),
-                            (newAs = ref5.as);
+                            (newUrl = ref.url),
+                            (newAs = ref.as);
                           return _ctx.abrupt("return", {
                             type: "redirect",
                             newUrl: newUrl,
                             newAs: newAs
                           });
-                        case 23:
+                        case 24:
                           return _ctx.abrupt("return", {
                             type: "redirect",
                             destination: preflight.redirect
                           });
-                        case 24:
+                        case 25:
                           if (!(preflight.refresh && !preflight.ssr)) {
-                            _ctx.next = 26;
+                            _ctx.next = 27;
                             break;
                           }
                           return _ctx.abrupt("return", {
                             type: "refresh"
                           });
-                        case 26:
+                        case 27:
                           return _ctx.abrupt("return", {
                             type: "next"
                           });
-                        case 27:
+                        case 28:
                         case "end":
                           return _ctx.stop();
                       }
Diff for index.html
@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-2487a9a50a9f7dd4.js"
+      src="/_next/static/chunks/main-1fa20499f1cb366a.js"
       defer=""
     ></script>
     <script
Diff for link.html
@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-2487a9a50a9f7dd4.js"
+      src="/_next/static/chunks/main-1fa20499f1cb366a.js"
       defer=""
     ></script>
     <script
Diff for withRouter.html
@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-2487a9a50a9f7dd4.js"
+      src="/_next/static/chunks/main-1fa20499f1cb366a.js"
       defer=""
     ></script>
     <script

Default Build with SWC (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary ijjk/next.js fix/external-rewrite-middleware Change
buildDuration 17s 17.4s ⚠️ +423ms
buildDurationCached 5.5s 5.5s ⚠️ +38ms
nodeModulesSize 359 MB 359 MB ⚠️ +303 B
Page Load Tests Overall increase ✓
vercel/next.js canary ijjk/next.js fix/external-rewrite-middleware Change
/ failed reqs 0 0
/ total time (seconds) 2.457 2.509 ⚠️ +0.05
/ avg req/sec 1017.37 996.4 ⚠️ -20.97
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.261 1.233 -0.03
/error-in-render avg req/sec 1983.02 2027.04 +44.02
Client Bundles (main, webpack, commons) Overall increase ⚠️
vercel/next.js canary ijjk/next.js fix/external-rewrite-middleware Change
450.HASH.js gzip 179 B 179 B
framework-HASH.js gzip 42.3 kB 42.3 kB
main-HASH.js gzip 27.4 kB 27.4 kB ⚠️ +8 B
webpack-HASH.js gzip 1.44 kB 1.44 kB
Overall change 71.3 kB 71.3 kB ⚠️ +8 B
Legacy Client Bundles (polyfills)
vercel/next.js canary ijjk/next.js fix/external-rewrite-middleware Change
polyfills-HASH.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary ijjk/next.js fix/external-rewrite-middleware Change
_app-HASH.js gzip 1.35 kB 1.35 kB
_error-HASH.js gzip 180 B 180 B
amp-HASH.js gzip 305 B 305 B
css-HASH.js gzip 321 B 321 B
dynamic-HASH.js gzip 2.36 kB 2.36 kB
head-HASH.js gzip 342 B 342 B
hooks-HASH.js gzip 911 B 911 B
image-HASH.js gzip 4.97 kB 4.97 kB
index-HASH.js gzip 256 B 256 B
link-HASH.js gzip 2.21 kB 2.21 kB
routerDirect..HASH.js gzip 314 B 314 B
script-HASH.js gzip 375 B 375 B
withRouter-HASH.js gzip 309 B 309 B
85e02e95b279..7e3.css gzip 107 B 107 B
Overall change 14.3 kB 14.3 kB
Client Build Manifests
vercel/next.js canary ijjk/next.js fix/external-rewrite-middleware Change
_buildManifest.js gzip 459 B 459 B
Overall change 459 B 459 B
Rendered Page Sizes Overall increase ⚠️
vercel/next.js canary ijjk/next.js fix/external-rewrite-middleware Change
index.html gzip 532 B 532 B
link.html gzip 545 B 546 B ⚠️ +1 B
withRouter.html gzip 526 B 527 B ⚠️ +1 B
Overall change 1.6 kB 1.6 kB ⚠️ +2 B

Diffs

Diff for main-HASH.js
@@ -6201,8 +6201,7 @@
               var _this = this;
               return _asyncToGenerator(
                 _runtimeJs.default.mark(function _callee() {
-                  var ref,
-                    cleanedAs,
+                  var cleanedAs,
                     fns,
                     requiresPreflight,
                     preflight,
@@ -6211,7 +6210,7 @@
                     matchedPage,
                     resolvedHref,
                     cleanRedirect,
-                    ref5,
+                    ref,
                     newUrl,
                     newAs;
                   return _runtimeJs.default.wrap(function _callee$(_ctx) {
@@ -6224,9 +6223,9 @@
                               : options.as,
                             _this.locale
                           );
-                          _ctx.next = 4;
+                          _ctx.next = 3;
                           return _this.pageLoader.getMiddlewareList();
-                        case 4:
+                        case 3:
                           fns = _ctx.sent;
                           requiresPreflight = fns.some(function(param) {
                             var _param = _slicedToArray(param, 2),
@@ -6240,29 +6239,33 @@
                             )(cleanedAs);
                           });
                           if (requiresPreflight) {
-                            _ctx.next = 8;
+                            _ctx.next = 7;
                             break;
                           }
                           return _ctx.abrupt("return", {
                             type: "next"
                           });
-                        case 8:
-                          _ctx.next = 10;
+                        case 7:
+                          _ctx.next = 9;
                           return _this._getPreflightData({
                             preflightHref: options.as,
                             shouldCache: options.cache
                           });
-                        case 10:
+                        case 9:
                           preflight = _ctx.sent;
-                          if (
-                            !((ref = preflight.rewrite) === null ||
-                            ref === void 0
-                              ? void 0
-                              : ref.startsWith("/"))
-                          ) {
-                            _ctx.next = 18;
+                          if (!preflight.rewrite) {
+                            _ctx.next = 19;
                             break;
                           }
+                          if (preflight.rewrite.startsWith("/")) {
+                            _ctx.next = 13;
+                            break;
+                          }
+                          return _ctx.abrupt("return", {
+                            type: "redirect",
+                            destination: options.as
+                          });
+                        case 13:
                           parsed = (0, _parseRelativeUrl).parseRelativeUrl(
                             (0, _normalizeLocalePath).normalizeLocalePath(
                               hasBasePath(preflight.rewrite)
@@ -6297,13 +6300,13 @@
                             matchedPage: matchedPage,
                             resolvedHref: resolvedHref
                           });
-                        case 18:
+                        case 19:
                           if (!preflight.redirect) {
-                            _ctx.next = 24;
+                            _ctx.next = 25;
                             break;
                           }
                           if (!preflight.redirect.startsWith("/")) {
-                            _ctx.next = 23;
+                            _ctx.next = 24;
                             break;
                           }
                           cleanRedirect = (0,
@@ -6315,36 +6318,36 @@
                               _this.locales
                             ).pathname
                           );
-                          (ref5 = prepareUrlAs(
+                          (ref = prepareUrlAs(
                             _this,
                             cleanRedirect,
                             cleanRedirect
                           )),
-                            (newUrl = ref5.url),
-                            (newAs = ref5.as);
+                            (newUrl = ref.url),
+                            (newAs = ref.as);
                           return _ctx.abrupt("return", {
                             type: "redirect",
                             newUrl: newUrl,
                             newAs: newAs
                           });
-                        case 23:
+                        case 24:
                           return _ctx.abrupt("return", {
                             type: "redirect",
                             destination: preflight.redirect
                           });
-                        case 24:
+                        case 25:
                           if (!(preflight.refresh && !preflight.ssr)) {
-                            _ctx.next = 26;
+                            _ctx.next = 27;
                             break;
                           }
                           return _ctx.abrupt("return", {
                             type: "refresh"
                           });
-                        case 26:
+                        case 27:
                           return _ctx.abrupt("return", {
                             type: "next"
                           });
-                        case 27:
+                        case 28:
                         case "end":
                           return _ctx.stop();
                       }
Diff for index.html
@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-2487a9a50a9f7dd4.js"
+      src="/_next/static/chunks/main-1fa20499f1cb366a.js"
       defer=""
     ></script>
     <script
Diff for link.html
@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-2487a9a50a9f7dd4.js"
+      src="/_next/static/chunks/main-1fa20499f1cb366a.js"
       defer=""
     ></script>
     <script
Diff for withRouter.html
@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-2487a9a50a9f7dd4.js"
+      src="/_next/static/chunks/main-1fa20499f1cb366a.js"
       defer=""
     ></script>
     <script
Commit: 94e5f6f

@ijjk ijjk merged commit 103d3ab into vercel:canary Feb 4, 2022
40 of 42 checks passed
@ijjk ijjk deleted the fix/external-rewrite-middleware branch Feb 4, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 7, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants