Commit 34dc9058 authored by Jiachi Liu's avatar Jiachi Liu

Use vercel deployment url for metadataBase fallbacks (#65089)

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
parent c8b6c668
import { resolveUrl, resolveAbsoluteUrlWithPathname } from './resolve-url' import {
resolveUrl,
resolveAbsoluteUrlWithPathname,
getSocialImageFallbackMetadataBase,
} from './resolve-url'
// required to be resolved as URL with resolveUrl() // required to be resolved as URL with resolveUrl()
describe('metadata: resolveUrl', () => { describe('metadata: resolveUrl', () => {
...@@ -106,3 +110,73 @@ describe('resolveAbsoluteUrlWithPathname', () => { ...@@ -106,3 +110,73 @@ describe('resolveAbsoluteUrlWithPathname', () => {
}) })
}) })
}) })
describe('getSocialImageFallbackMetadataBase', () => {
describe('fallbackMetadataBase when metadataBase is not present', () => {
let originalEnv: NodeJS.ProcessEnv
function getSocialImageFallbackMetadataBaseHelper(): string {
return getSocialImageFallbackMetadataBase(null).fallbackMetadataBase.href
}
beforeEach(() => {
originalEnv = process.env
})
afterEach(() => {
delete process.env.VERCEL_URL
delete process.env.VERCEL_ENV
delete process.env.VERCEL_BRANCH_URL
delete process.env.VERCEL_PROJECT_PRODUCTION_URL
process.env = originalEnv
})
it('should return localhost url in local dev mode', () => {
// @ts-expect-error override process env
process.env.NODE_ENV = 'development'
expect(getSocialImageFallbackMetadataBaseHelper()).toBe(
'http://localhost:3000/'
)
})
it('should return local url in local build mode', () => {
// @ts-expect-error override process env
process.env.NODE_ENV = 'production'
expect(getSocialImageFallbackMetadataBaseHelper()).toBe(
'http://localhost:3000/'
)
})
it('should prefer branch url in preview deployment if presents', () => {
// @ts-expect-error override process env
process.env.NODE_ENV = 'production'
process.env.VERCEL_ENV = 'preview'
process.env.VERCEL_BRANCH_URL = 'branch-url'
process.env.VERCEL_URL = 'vercel-url'
expect(getSocialImageFallbackMetadataBaseHelper()).toBe(
'https://branch-url/'
)
})
it('should return vercel url in preview deployment if only it presents', () => {
// @ts-expect-error override process env
process.env.NODE_ENV = 'production'
process.env.VERCEL_ENV = 'preview'
process.env.VERCEL_URL = 'vercel-url'
expect(getSocialImageFallbackMetadataBaseHelper()).toBe(
'https://vercel-url/'
)
})
it('should return project production url in production deployment', () => {
// @ts-expect-error override process env
process.env.NODE_ENV = 'production'
process.env.VERCEL_ENV = 'production'
process.env.VERCEL_URL = 'vercel-url'
process.env.VERCEL_PROJECT_PRODUCTION_URL = 'production-url'
expect(getSocialImageFallbackMetadataBaseHelper()).toBe(
'https://production-url/'
)
})
})
})
...@@ -9,6 +9,16 @@ function createLocalMetadataBase() { ...@@ -9,6 +9,16 @@ function createLocalMetadataBase() {
return new URL(`http://localhost:${process.env.PORT || 3000}`) return new URL(`http://localhost:${process.env.PORT || 3000}`)
} }
function getPreviewDeploymentUrl(): URL | undefined {
const origin = process.env.VERCEL_BRANCH_URL || process.env.VERCEL_URL
return origin ? new URL(`https://${origin}`) : undefined
}
function getProductionDeploymentUrl(): URL | undefined {
const origin = process.env.VERCEL_PROJECT_PRODUCTION_URL
return origin ? new URL(`https://${origin}`) : undefined
}
// For deployment url for metadata routes, prefer to use the deployment url if possible // For deployment url for metadata routes, prefer to use the deployment url if possible
// as these routes are unique to the deployments url. // as these routes are unique to the deployments url.
export function getSocialImageFallbackMetadataBase(metadataBase: URL | null): { export function getSocialImageFallbackMetadataBase(metadataBase: URL | null): {
...@@ -17,8 +27,8 @@ export function getSocialImageFallbackMetadataBase(metadataBase: URL | null): { ...@@ -17,8 +27,8 @@ export function getSocialImageFallbackMetadataBase(metadataBase: URL | null): {
} { } {
const isMetadataBaseMissing = !metadataBase const isMetadataBaseMissing = !metadataBase
const defaultMetadataBase = createLocalMetadataBase() const defaultMetadataBase = createLocalMetadataBase()
const deploymentUrl = const previewDeploymentUrl = getPreviewDeploymentUrl()
process.env.VERCEL_URL && new URL(`https://${process.env.VERCEL_URL}`) const productionDeploymentUrl = getProductionDeploymentUrl()
let fallbackMetadataBase let fallbackMetadataBase
if (process.env.NODE_ENV === 'development') { if (process.env.NODE_ENV === 'development') {
...@@ -26,10 +36,10 @@ export function getSocialImageFallbackMetadataBase(metadataBase: URL | null): { ...@@ -26,10 +36,10 @@ export function getSocialImageFallbackMetadataBase(metadataBase: URL | null): {
} else { } else {
fallbackMetadataBase = fallbackMetadataBase =
process.env.NODE_ENV === 'production' && process.env.NODE_ENV === 'production' &&
deploymentUrl && previewDeploymentUrl &&
process.env.VERCEL_ENV === 'preview' process.env.VERCEL_ENV === 'preview'
? deploymentUrl ? previewDeploymentUrl
: metadataBase || deploymentUrl || defaultMetadataBase : metadataBase || productionDeploymentUrl || defaultMetadataBase
} }
return { return {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment