Use vercel deployment url for metadataBase fallbacks #65089

huozhi · 2024-04-26T15:38:34Z

Leveraging the system env vars for fallback logic

x-ref: https://vercel.com/docs/projects/environment-variables/system-environment-variables

For preview deployment: prefer using VERCEL_BRANCH_URL, fallback to VERCEL_URL
For production deployment: prefer using VERCEL_PROJECT_PRODUCTION_URL

Closes NEXT-3237

ijjk · 2024-04-26T15:45:45Z

Stats from current PR

Default Build (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	vercel/next.js metadata/use-vercel-env	Change
buildDuration	18.4s	15.5s	N/A
buildDurationCached	9.2s	8.2s	N/A
nodeModulesSize	360 MB	360 MB	⚠️ +15.4 kB
nextStartRea..uration (ms)	425ms	432ms	N/A

Client Bundles (main, webpack)

	vercel/next.js canary	vercel/next.js metadata/use-vercel-env	Change
1103-HASH.js gzip	31.9 kB	31.9 kB	N/A
1a9f679d-HASH.js gzip	53.5 kB	53.5 kB	N/A
335-HASH.js gzip	5.09 kB	5.09 kB	N/A
7953.HASH.js gzip	169 B	169 B	✓
framework-HASH.js gzip	45.2 kB	45.2 kB	✓
main-app-HASH.js gzip	230 B	229 B	N/A
main-HASH.js gzip	31.5 kB	31.5 kB	N/A
webpack-HASH.js gzip	1.65 kB	1.65 kB	N/A
Overall change	45.4 kB	45.4 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	vercel/next.js metadata/use-vercel-env	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	vercel/next.js metadata/use-vercel-env	Change
_app-HASH.js gzip	192 B	193 B	N/A
_error-HASH.js gzip	192 B	193 B	N/A
amp-HASH.js gzip	507 B	511 B	N/A
css-HASH.js gzip	341 B	343 B	N/A
dynamic-HASH.js gzip	2.52 kB	2.52 kB	✓
edge-ssr-HASH.js gzip	266 B	265 B	N/A
head-HASH.js gzip	362 B	365 B	N/A
hooks-HASH.js gzip	392 B	392 B	✓
image-HASH.js gzip	4.32 kB	4.32 kB	N/A
index-HASH.js gzip	268 B	268 B	✓
link-HASH.js gzip	2.69 kB	2.7 kB	N/A
routerDirect..HASH.js gzip	329 B	328 B	N/A
script-HASH.js gzip	397 B	397 B	✓
withRouter-HASH.js gzip	324 B	324 B	✓
1afbb74e6ecf..834.css gzip	106 B	106 B	✓
Overall change	4 kB	4 kB	✓

Client Build Manifests

	vercel/next.js canary	vercel/next.js metadata/use-vercel-env	Change
_buildManifest.js gzip	483 B	484 B	N/A
Overall change	0 B	0 B	✓

Rendered Page Sizes

	vercel/next.js canary	vercel/next.js metadata/use-vercel-env	Change
index.html gzip	528 B	526 B	N/A
link.html gzip	541 B	539 B	N/A
withRouter.html gzip	524 B	521 B	N/A
Overall change	0 B	0 B	✓

Edge SSR bundle Size

	vercel/next.js canary	vercel/next.js metadata/use-vercel-env	Change
edge-ssr.js gzip	94.7 kB	94.7 kB	N/A
page.js gzip	181 kB	181 kB	N/A
Overall change	0 B	0 B	✓

Middleware size

	vercel/next.js canary	vercel/next.js metadata/use-vercel-env	Change
middleware-b..fest.js gzip	622 B	623 B	N/A
middleware-r..fest.js gzip	156 B	156 B	✓
middleware.js gzip	25.7 kB	25.7 kB	N/A
edge-runtime..pack.js gzip	839 B	839 B	✓
Overall change	995 B	995 B	✓

Next Runtimes

	vercel/next.js canary	vercel/next.js metadata/use-vercel-env	Change
app-page-exp...dev.js gzip	171 kB	171 kB	N/A
app-page-exp..prod.js gzip	98.5 kB	98.5 kB	N/A
app-page-tur..prod.js gzip	100 kB	100 kB	N/A
app-page-tur..prod.js gzip	94.3 kB	94.3 kB	N/A
app-page.run...dev.js gzip	157 kB	157 kB	N/A
app-page.run..prod.js gzip	93 kB	93.1 kB	N/A
app-route-ex...dev.js gzip	21.5 kB	21.5 kB	✓
app-route-ex..prod.js gzip	15.2 kB	15.2 kB	✓
app-route-tu..prod.js gzip	15.2 kB	15.2 kB	✓
app-route-tu..prod.js gzip	15 kB	15 kB	✓
app-route.ru...dev.js gzip	21.3 kB	21.3 kB	✓
app-route.ru..prod.js gzip	15 kB	15 kB	✓
pages-api-tu..prod.js gzip	9.55 kB	9.55 kB	✓
pages-api.ru...dev.js gzip	9.82 kB	9.82 kB	✓
pages-api.ru..prod.js gzip	9.55 kB	9.55 kB	✓
pages-turbo...prod.js gzip	21.5 kB	21.5 kB	✓
pages.runtim...dev.js gzip	22.1 kB	22.1 kB	✓
pages.runtim..prod.js gzip	21.5 kB	21.5 kB	✓
server.runti..prod.js gzip	51.6 kB	51.6 kB	✓
Overall change	249 kB	249 kB	✓

build cache Overall increase ⚠️

	vercel/next.js canary	vercel/next.js metadata/use-vercel-env	Change
0.pack gzip	1.62 MB	1.62 MB	⚠️ +2.37 kB
index.pack gzip	112 kB	112 kB	N/A
Overall change	1.62 MB	1.62 MB	⚠️ +2.37 kB

Diff details

Diff for edge-ssr.js

Diff too large to display

Diff for app-page-exp..ntime.dev.js

failed to diff

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: cf3fcc9

packages/next/src/lib/metadata/resolvers/resolve-url.ts

styfle

Can you add tests to make sure this behaves as expected?

packages/next/src/lib/metadata/resolvers/resolve-url.test.ts

ijjk · 2024-04-29T21:01:33Z

Failing test suites

Commit: e549ebf

pnpm test-dev packages/next/src/lib/metadata/resolvers/resolve-url.test.ts

getSocialImageFallbackMetadataBase > fallbackMetadataBase when metadataBase is not present > should return project production url in production deployment

Expand output

● getSocialImageFallbackMetadataBase › fallbackMetadataBase when metadataBase is not present › should return project production url in production deployment

expect(received).toBe(expected) // Object.is equality

Expected: "https://production-url/"
Received: "https://vercel-url/"

  175 |       process.env.VERCEL_URL = 'vercel-url'
  176 |       process.env.VERCEL_PROJECT_PRODUCTION_URL = 'production-url'
> 177 |       expect(getSocialImageFallbackMetadataBaseHelper()).toBe(
      |                                                          ^
  178 |         'https://production-url/'
  179 |       )
  180 |     })

  at Object.toBe (../packages/next/src/lib/metadata/resolvers/resolve-url.test.ts:177:58)

Read more about building and testing Next.js in contributing.md.

pnpm test-dev test/development/basic/next-rs-api.test.ts

next.rs api > should have working HMR on client-side change on a app page 0
next.rs api > should have working HMR on client-side change on a app page 1
next.rs api > should have working HMR on client-side change on a app page 2
next.rs api > should have working HMR on server-side change on a app page 0
next.rs api > should have working HMR on server-side change on a app page 1
next.rs api > should have working HMR on server-side change on a app page 2

Expand output

● next.rs api › should have working HMR on client-side change on a app page 0

expect(received).toBe(expected) // Object.is equality

Expected: false
Received: true

  579 |             ).toEqual([expect.stringContaining(expectedUpdate)])
  580 |           }
> 581 |           expect(foundServerSideChange).toBe(expectedServerSideChange)
      |                                         ^
  582 |           ok = true
  583 |         } finally {
  584 |           try {

  at Object.toBe (development/basic/next-rs-api.test.ts:581:41)

● next.rs api › should have working HMR on client-side change on a app page 1

could not find asset for path [virtual file system]/_next/static/chunks/app_app_83255d._.js.map

  Debug info:
  - Execution of hmr_update failed
  - Execution of Project::hmr_version_state failed
  - Execution of VersionedContent::version failed
  - Execution of Asset::versioned_content failed
  - Execution of VersionedContentMap::get_asset failed
  - could not find asset for path [virtual file system]/_next/static/chunks/app_app_83255d._.js.map

● next.rs api › should have working HMR on client-side change on a app page 2

could not find asset for path [virtual file system]/_next/static/chunks/app_app_83255d._.js.map

  Debug info:
  - Execution of hmr_update failed
  - Execution of Project::hmr_version_state failed
  - Execution of VersionedContent::version failed
  - Execution of Asset::versioned_content failed
  - Execution of VersionedContentMap::get_asset failed
  - could not find asset for path [virtual file system]/_next/static/chunks/app_app_83255d._.js.map

● next.rs api › should have working HMR on server-side change on a app page 0

could not find asset for path [virtual file system]/_next/static/chunks/app_app_83255d._.js

  Debug info:
  - Execution of hmr_update failed
  - Execution of Project::hmr_version_state failed
  - Execution of VersionedContent::version failed
  - Execution of Asset::versioned_content failed
  - Execution of VersionedContentMap::get_asset failed
  - could not find asset for path [virtual file system]/_next/static/chunks/app_app_83255d._.js

● next.rs api › should have working HMR on server-side change on a app page 1

could not find asset for path [virtual file system]/_next/static/chunks/app_app_83255d._.js

  Debug info:
  - Execution of hmr_update failed
  - Execution of Project::hmr_version_state failed
  - Execution of VersionedContent::version failed
  - Execution of Asset::versioned_content failed
  - Execution of VersionedContentMap::get_asset failed
  - could not find asset for path [virtual file system]/_next/static/chunks/app_app_83255d._.js

● next.rs api › should have working HMR on server-side change on a app page 2

could not find asset for path [virtual file system]/_next/static/chunks/app_app_83255d._.js

  Debug info:
  - Execution of hmr_update failed
  - Execution of Project::hmr_version_state failed
  - Execution of VersionedContent::version failed
  - Execution of Asset::versioned_content failed
  - Execution of VersionedContentMap::get_asset failed
  - could not find asset for path [virtual file system]/_next/static/chunks/app_app_83255d._.js

Read more about building and testing Next.js in contributing.md.

pnpm test test/integration/edge-runtime-module-errors/test/module-imports.test.js

Edge runtime code with imports > Edge API statically importing node.js module > throws unsupported module error in dev at runtime and highlights the faulty line

Expand output

● Edge runtime code with imports › Edge API statically importing node.js module › throws unsupported module error in dev at runtime and highlights the faulty line

expect(received).toBe(expected) // Object.is equality

Expected: 500
Received: 404

  86 |       context.app = await launchApp(context.appDir, context.appPort, appOption)
  87 |       const res = await fetchViaHTTP(context.appPort, url)
> 88 |       expect(res.status).toBe(500)
     |                          ^
  89 |
  90 |       const text = await res.text()
  91 |       await check(async () => {

  at Object.toBe (integration/edge-runtime-module-errors/test/module-imports.test.js:88:26)

Read more about building and testing Next.js in contributing.md.

In #65089, `metadataBase` was changed to use `VERCEL_PROJECT_PRODUCTION_URL` by default. This pull request updates documentation to reflect that. --------- Co-authored-by: Sam Ko <sam@vercel.com>

#65583) Explain more details about default `metadataBase` (where `metadataBase` is not defined) when it's on Vercel deployment x-ref: #65089 --------- Co-authored-by: Delba de Oliveira <32464864+delbaoliveira@users.noreply.github.com>

ijjk added created-by: Next.js team PRs by the Next.js team. type: next labels Apr 26, 2024

huozhi marked this pull request as ready for review April 26, 2024 15:56

huozhi requested review from timneutkens, ijjk, shuding, feedthejim, ztanner and wyattjoh as code owners April 26, 2024 15:56

lucleray approved these changes Apr 26, 2024

View reviewed changes

styfle reviewed Apr 26, 2024

View reviewed changes

packages/next/src/lib/metadata/resolvers/resolve-url.ts Outdated Show resolved Hide resolved

styfle reviewed Apr 26, 2024

View reviewed changes

packages/next/src/lib/metadata/resolvers/resolve-url.ts Outdated Show resolved Hide resolved

styfle reviewed Apr 26, 2024

View reviewed changes

huozhi added 2 commits April 29, 2024 21:34

Use vercel deployment url for metadataBase fallbacks

acfe917

refactor and add unit test

83ddc33

huozhi force-pushed the metadata/use-vercel-env branch from 6ecbd23 to 83ddc33 Compare April 29, 2024 19:45

add case

20c7d30

huozhi requested a review from styfle April 29, 2024 19:48

styfle reviewed Apr 29, 2024

View reviewed changes

packages/next/src/lib/metadata/resolvers/resolve-url.test.ts Show resolved Hide resolved

styfle reviewed Apr 29, 2024

View reviewed changes

packages/next/src/lib/metadata/resolvers/resolve-url.test.ts Show resolved Hide resolved

styfle approved these changes Apr 29, 2024

View reviewed changes

add and update test

e549ebf

huozhi enabled auto-merge (squash) April 29, 2024 21:00

styfle approved these changes Apr 29, 2024

View reviewed changes

fix test

cf3fcc9

huozhi merged commit 1df2f3e into canary Apr 29, 2024
75 of 80 checks passed

huozhi deleted the metadata/use-vercel-env branch April 29, 2024 21:35

n1ckoates mentioned this pull request May 7, 2024

Update docs on default metadataBase value #65428

Merged

huozhi mentioned this pull request May 9, 2024

docs: explain about the conditional default metadataBase on vercel de… #65583

Merged

github-actions bot added the locked label May 14, 2024

github-actions bot locked as resolved and limited conversation to collaborators May 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use vercel deployment url for metadataBase fallbacks #65089

Use vercel deployment url for metadataBase fallbacks #65089

huozhi commented Apr 26, 2024 •

edited

Loading

ijjk commented Apr 26, 2024 •

edited

Loading

styfle left a comment

ijjk commented Apr 29, 2024 •

edited

Loading

Use vercel deployment url for metadataBase fallbacks #65089

Use vercel deployment url for metadataBase fallbacks #65089

Conversation

huozhi commented Apr 26, 2024 • edited Loading

ijjk commented Apr 26, 2024 • edited Loading

Stats from current PR

styfle left a comment

Choose a reason for hiding this comment

ijjk commented Apr 29, 2024 • edited Loading

Failing test suites

huozhi commented Apr 26, 2024 •

edited

Loading

ijjk commented Apr 26, 2024 •

edited

Loading

ijjk commented Apr 29, 2024 •

edited

Loading