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

Fix metadata url cases should not append with trailing slash #63050

Merged
merged 3 commits into from
Mar 8, 2024

Conversation

huozhi
Copy link
Member

@huozhi huozhi commented Mar 8, 2024

What

Exclude the cases like external urls and relative urls with query from appending trailing slash when it's needed.

The process is:

  • If it's a uncertain string path (relative url, could start with './' or /), convert to relative that starts with /;
  • then we covert the url (string or URL) to string url
  • We do the check if we need to append the trailing slash

Why

In #62109 we added functionality that can only append trailing slash when we appended trailing slash to some metadata url like canonical url and open graph url when the config is enabled.
For urls with queries, the trailing slash can also be omitted.
For the external urls (different origin comparing to metadataBase) we don't need to append trailing slash as they're not the same web app.

x-ref: slack thread

Closes NEXT-2762
Closes NEXT-2753

@ijjk
Copy link
Member

ijjk commented Mar 8, 2024

Tests Passed

@ijjk
Copy link
Member

ijjk commented Mar 8, 2024

Stats from current PR

Default Build (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary vercel/next.js fix/metadata-trailing-slash-canonical Change
buildDuration 13.8s 13.8s N/A
buildDurationCached 7.3s 6s N/A
nodeModulesSize 198 MB 198 MB ⚠️ +20.1 kB
nextStartRea..uration (ms) 435ms 435ms
Client Bundles (main, webpack)
vercel/next.js canary vercel/next.js fix/metadata-trailing-slash-canonical Change
2453-HASH.js gzip 30.5 kB 30.5 kB N/A
3304.HASH.js gzip 181 B 181 B
3f784ff6-HASH.js gzip 53.7 kB 53.7 kB N/A
8299-HASH.js gzip 5.04 kB 5.04 kB N/A
framework-HASH.js gzip 45.2 kB 45.2 kB
main-app-HASH.js gzip 242 B 242 B
main-HASH.js gzip 32.2 kB 32.2 kB N/A
webpack-HASH.js gzip 1.68 kB 1.68 kB N/A
Overall change 45.6 kB 45.6 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary vercel/next.js fix/metadata-trailing-slash-canonical Change
polyfills-HASH.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary vercel/next.js fix/metadata-trailing-slash-canonical Change
_app-HASH.js gzip 196 B 197 B N/A
_error-HASH.js gzip 184 B 184 B
amp-HASH.js gzip 505 B 505 B
css-HASH.js gzip 324 B 325 B N/A
dynamic-HASH.js gzip 2.5 kB 2.5 kB N/A
edge-ssr-HASH.js gzip 258 B 258 B
head-HASH.js gzip 352 B 352 B
hooks-HASH.js gzip 370 B 371 B N/A
image-HASH.js gzip 4.21 kB 4.21 kB
index-HASH.js gzip 259 B 259 B
link-HASH.js gzip 2.67 kB 2.67 kB N/A
routerDirect..HASH.js gzip 314 B 312 B N/A
script-HASH.js gzip 386 B 386 B
withRouter-HASH.js gzip 309 B 309 B
1afbb74e6ecf..834.css gzip 106 B 106 B
Overall change 6.57 kB 6.57 kB
Client Build Manifests
vercel/next.js canary vercel/next.js fix/metadata-trailing-slash-canonical Change
_buildManifest.js gzip 481 B 484 B N/A
Overall change 0 B 0 B
Rendered Page Sizes
vercel/next.js canary vercel/next.js fix/metadata-trailing-slash-canonical Change
index.html gzip 528 B 528 B
link.html gzip 541 B 541 B
withRouter.html gzip 524 B 523 B N/A
Overall change 1.07 kB 1.07 kB
Edge SSR bundle Size
vercel/next.js canary vercel/next.js fix/metadata-trailing-slash-canonical Change
edge-ssr.js gzip 95.1 kB 95.1 kB N/A
page.js gzip 3.06 kB 3.07 kB N/A
Overall change 0 B 0 B
Middleware size
vercel/next.js canary vercel/next.js fix/metadata-trailing-slash-canonical Change
middleware-b..fest.js gzip 626 B 623 B N/A
middleware-r..fest.js gzip 151 B 151 B
middleware.js gzip 25.5 kB 25.5 kB N/A
edge-runtime..pack.js gzip 839 B 839 B
Overall change 990 B 990 B
Next Runtimes
vercel/next.js canary vercel/next.js fix/metadata-trailing-slash-canonical Change
app-page-exp...dev.js gzip 171 kB 171 kB N/A
app-page-exp..prod.js gzip 96.5 kB 96.5 kB N/A
app-page-tur..prod.js gzip 98.2 kB 98.3 kB N/A
app-page-tur..prod.js gzip 92.7 kB 92.7 kB N/A
app-page.run...dev.js gzip 149 kB 149 kB N/A
app-page.run..prod.js gzip 91.2 kB 91.2 kB N/A
app-route-ex...dev.js gzip 21.3 kB 21.3 kB
app-route-ex..prod.js gzip 15 kB 15 kB
app-route-tu..prod.js gzip 15 kB 15 kB
app-route-tu..prod.js gzip 14.8 kB 14.8 kB
app-route.ru...dev.js gzip 21 kB 21 kB
app-route.ru..prod.js gzip 14.8 kB 14.8 kB
pages-api-tu..prod.js gzip 9.52 kB 9.52 kB
pages-api.ru...dev.js gzip 9.8 kB 9.8 kB
pages-api.ru..prod.js gzip 9.52 kB 9.52 kB
pages-turbo...prod.js gzip 22.3 kB 22.3 kB
pages.runtim...dev.js gzip 22.9 kB 22.9 kB
pages.runtim..prod.js gzip 22.3 kB 22.3 kB
server.runti..prod.js gzip 50.5 kB 50.5 kB
Overall change 249 kB 249 kB
build cache Overall increase ⚠️
vercel/next.js canary vercel/next.js fix/metadata-trailing-slash-canonical Change
0.pack gzip 1.56 MB 1.55 MB N/A
index.pack gzip 105 kB 106 kB ⚠️ +644 B
Overall change 105 kB 106 kB ⚠️ +644 B
Diff details
Diff for middleware.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: eb52089

@huozhi huozhi force-pushed the fix/metadata-trailing-slash-canonical branch from 7c4ef75 to c16083a Compare March 8, 2024 16:04
@huozhi huozhi marked this pull request as ready for review March 8, 2024 16:31
@huozhi huozhi requested a review from ztanner March 8, 2024 19:50
@huozhi huozhi merged commit 664073e into canary Mar 8, 2024
68 checks passed
@huozhi huozhi deleted the fix/metadata-trailing-slash-canonical branch March 8, 2024 20:16
huozhi added a commit that referenced this pull request Mar 18, 2024
### What

Exclude the cases like external urls and relative urls with query from
appending trailing slash when it's needed.

The process is:
- If it's a uncertain string path (relative url, could start with `'./'`
or `/`), convert to relative that starts with `/`;
- then we covert the url (string or URL) to string url
- We do the check if we need to append the trailing slash

### Why

In #62109 we added functionality that can only append trailing slash
when we appended trailing slash to some metadata url like `canonical`
url and open graph url when the config is enabled.
For urls with queries, the trailing slash can also be omitted.
For the external urls (different origin comparing to `metadataBase`) we
don't need to append trailing slash as they're not the same web app.

x-ref: [slack
thread](https://vercel.slack.com/archives/C0676QZBWKS/p1709845946033929)

Closes NEXT-2762
Closes NEXT-2753
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants