Unverified Commit 34c2a05d authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Warn metadataBase missing in standalone mode or non vercel deployment (#66296)

### What

Change the metadataBase missing warning for all cases to only warn in
standalone mode or the non-vercel deployment.

### Why

In vercel deployments, previous concern was that you might not discover
you missed that metadataBase when you deploy. But now we have sth
fallback on production deployments. So we only need to warn in
non-vercel deployment.

Standalone is usually for self-hoist, we always warn users to set the
`metadataBase` to make sure the domain can be properly resolved.


[x-ref](https://vercel.slack.com/archives/C03S8ED1DKM/p1716926825853389?thread_ts=1716923373.484329&cid=C03S8ED1DKM)
parent 355a4acc
import type { ParsedUrlQuery } from 'querystring' import type { ParsedUrlQuery } from 'querystring'
import type { GetDynamicParamFromSegment } from '../../server/app-render/app-render' import type {
AppRenderContext,
GetDynamicParamFromSegment,
} from '../../server/app-render/app-render'
import type { LoaderTree } from '../../server/lib/app-dir-module' import type { LoaderTree } from '../../server/lib/app-dir-module'
import React from 'react' import React from 'react'
...@@ -29,6 +32,18 @@ import { ...@@ -29,6 +32,18 @@ import {
createDefaultViewport, createDefaultViewport,
} from './default-metadata' } from './default-metadata'
import { isNotFoundError } from '../../client/components/not-found' import { isNotFoundError } from '../../client/components/not-found'
import type { MetadataContext } from './types/resolvers'
export function createMetadataContext(
urlPathname: string,
renderOpts: AppRenderContext['renderOpts']
): MetadataContext {
return {
pathname: urlPathname.split('?')[0],
trailingSlash: renderOpts.trailingSlash,
isStandaloneMode: renderOpts.nextConfigOutput === 'standalone',
}
}
// Use a promise to share the status of the metadata resolving, // Use a promise to share the status of the metadata resolving,
// returning two components `MetadataTree` and `MetadataOutlet` // returning two components `MetadataTree` and `MetadataOutlet`
...@@ -38,18 +53,16 @@ import { isNotFoundError } from '../../client/components/not-found' ...@@ -38,18 +53,16 @@ import { isNotFoundError } from '../../client/components/not-found'
// and the error will be caught by the error boundary and trigger fallbacks. // and the error will be caught by the error boundary and trigger fallbacks.
export function createMetadataComponents({ export function createMetadataComponents({
tree, tree,
pathname,
trailingSlash,
query, query,
metadataContext,
getDynamicParamFromSegment, getDynamicParamFromSegment,
appUsingSizeAdjustment, appUsingSizeAdjustment,
errorType, errorType,
createDynamicallyTrackedSearchParams, createDynamicallyTrackedSearchParams,
}: { }: {
tree: LoaderTree tree: LoaderTree
pathname: string
trailingSlash: boolean
query: ParsedUrlQuery query: ParsedUrlQuery
metadataContext: MetadataContext
getDynamicParamFromSegment: GetDynamicParamFromSegment getDynamicParamFromSegment: GetDynamicParamFromSegment
appUsingSizeAdjustment: boolean appUsingSizeAdjustment: boolean
errorType?: 'not-found' | 'redirect' errorType?: 'not-found' | 'redirect'
...@@ -57,12 +70,6 @@ export function createMetadataComponents({ ...@@ -57,12 +70,6 @@ export function createMetadataComponents({
searchParams: ParsedUrlQuery searchParams: ParsedUrlQuery
) => ParsedUrlQuery ) => ParsedUrlQuery
}): [React.ComponentType, React.ComponentType] { }): [React.ComponentType, React.ComponentType] {
const metadataContext = {
// Make sure the pathname without query string
pathname: pathname.split('?')[0],
trailingSlash,
}
let resolve: (value: Error | undefined) => void | undefined let resolve: (value: Error | undefined) => void | undefined
// Only use promise.resolve here to avoid unhandled rejections // Only use promise.resolve here to avoid unhandled rejections
const metadataErrorResolving = new Promise<Error | undefined>((res) => { const metadataErrorResolving = new Promise<Error | undefined>((res) => {
......
...@@ -17,6 +17,7 @@ function accumulateMetadata(metadataItems: MetadataItems) { ...@@ -17,6 +17,7 @@ function accumulateMetadata(metadataItems: MetadataItems) {
return originAccumulateMetadata(fullMetadataItems, { return originAccumulateMetadata(fullMetadataItems, {
pathname: '/test', pathname: '/test',
trailingSlash: false, trailingSlash: false,
isStandaloneMode: false,
}) })
} }
......
...@@ -120,6 +120,7 @@ function mergeStaticMetadata( ...@@ -120,6 +120,7 @@ function mergeStaticMetadata(
const resolvedTwitter = resolveTwitter( const resolvedTwitter = resolveTwitter(
{ ...target.twitter, images: twitter } as Twitter, { ...target.twitter, images: twitter } as Twitter,
target.metadataBase, target.metadataBase,
metadataContext,
titleTemplates.twitter titleTemplates.twitter
) )
target.twitter = resolvedTwitter target.twitter = resolvedTwitter
...@@ -192,6 +193,7 @@ function mergeMetadata({ ...@@ -192,6 +193,7 @@ function mergeMetadata({
target.twitter = resolveTwitter( target.twitter = resolveTwitter(
source.twitter, source.twitter,
metadataBase, metadataBase,
metadataContext,
titleTemplates.twitter titleTemplates.twitter
) )
break break
...@@ -566,7 +568,8 @@ function inheritFromMetadata( ...@@ -566,7 +568,8 @@ function inheritFromMetadata(
const commonOgKeys = ['title', 'description', 'images'] as const const commonOgKeys = ['title', 'description', 'images'] as const
function postProcessMetadata( function postProcessMetadata(
metadata: ResolvedMetadata, metadata: ResolvedMetadata,
titleTemplates: TitleTemplates titleTemplates: TitleTemplates,
metadataContext: MetadataContext
): ResolvedMetadata { ): ResolvedMetadata {
const { openGraph, twitter } = metadata const { openGraph, twitter } = metadata
...@@ -599,6 +602,7 @@ function postProcessMetadata( ...@@ -599,6 +602,7 @@ function postProcessMetadata(
const partialTwitter = resolveTwitter( const partialTwitter = resolveTwitter(
autoFillProps, autoFillProps,
metadata.metadataBase, metadata.metadataBase,
metadataContext,
titleTemplates.twitter titleTemplates.twitter
) )
if (metadata.twitter) { if (metadata.twitter) {
...@@ -778,7 +782,7 @@ export async function accumulateMetadata( ...@@ -778,7 +782,7 @@ export async function accumulateMetadata(
} }
} }
return postProcessMetadata(resolvedMetadata, titleTemplates) return postProcessMetadata(resolvedMetadata, titleTemplates, metadataContext)
} }
export async function accumulateViewport( export async function accumulateViewport(
......
...@@ -7,7 +7,7 @@ describe('resolveImages', () => { ...@@ -7,7 +7,7 @@ describe('resolveImages', () => {
it(`should resolve images`, () => { it(`should resolve images`, () => {
const images = [image1, { url: image2, alt: 'Image2' }] const images = [image1, { url: image2, alt: 'Image2' }]
expect(resolveImages(images, null)).toEqual([ expect(resolveImages(images, null, false)).toEqual([
{ url: new URL(image1) }, { url: new URL(image1) },
{ url: new URL(image2), alt: 'Image2' }, { url: new URL(image2), alt: 'Image2' },
]) ])
...@@ -16,7 +16,7 @@ describe('resolveImages', () => { ...@@ -16,7 +16,7 @@ describe('resolveImages', () => {
it('should not mutate passed images', () => { it('should not mutate passed images', () => {
const images = [image1, { url: image2, alt: 'Image2' }] const images = [image1, { url: image2, alt: 'Image2' }]
resolveImages(images, null) resolveImages(images, null, false)
expect(images).toEqual([image1, { url: image2, alt: 'Image2' }]) expect(images).toEqual([image1, { url: image2, alt: 'Image2' }])
}) })
......
...@@ -42,14 +42,20 @@ const OgTypeFields = { ...@@ -42,14 +42,20 @@ const OgTypeFields = {
function resolveAndValidateImage( function resolveAndValidateImage(
item: FlattenArray<OpenGraph['images'] | Twitter['images']>, item: FlattenArray<OpenGraph['images'] | Twitter['images']>,
metadataBase: NonNullable<ResolvedMetadataBase>, metadataBase: NonNullable<ResolvedMetadataBase>,
isMetadataBaseMissing: boolean isMetadataBaseMissing: boolean,
isStandaloneMode: boolean
) { ) {
if (!item) return undefined if (!item) return undefined
const isItemUrl = isStringOrURL(item) const isItemUrl = isStringOrURL(item)
const inputUrl = isItemUrl ? item : item.url const inputUrl = isItemUrl ? item : item.url
if (!inputUrl) return undefined if (!inputUrl) return undefined
validateResolvedImageUrl(inputUrl, metadataBase, isMetadataBaseMissing) const isNonVercelDeployment =
!process.env.VERCEL && process.env.NODE_ENV === 'production'
// Validate url in self-host standalone mode or non-Vercel deployment
if (isStandaloneMode || isNonVercelDeployment) {
validateResolvedImageUrl(inputUrl, metadataBase, isMetadataBaseMissing)
}
return isItemUrl return isItemUrl
? { ? {
...@@ -64,15 +70,18 @@ function resolveAndValidateImage( ...@@ -64,15 +70,18 @@ function resolveAndValidateImage(
export function resolveImages( export function resolveImages(
images: Twitter['images'], images: Twitter['images'],
metadataBase: ResolvedMetadataBase metadataBase: ResolvedMetadataBase,
isStandaloneMode: boolean
): NonNullable<ResolvedMetadata['twitter']>['images'] ): NonNullable<ResolvedMetadata['twitter']>['images']
export function resolveImages( export function resolveImages(
images: OpenGraph['images'], images: OpenGraph['images'],
metadataBase: ResolvedMetadataBase metadataBase: ResolvedMetadataBase,
isStandaloneMode: boolean
): NonNullable<ResolvedMetadata['openGraph']>['images'] ): NonNullable<ResolvedMetadata['openGraph']>['images']
export function resolveImages( export function resolveImages(
images: OpenGraph['images'] | Twitter['images'], images: OpenGraph['images'] | Twitter['images'],
metadataBase: ResolvedMetadataBase metadataBase: ResolvedMetadataBase,
isStandaloneMode: boolean
): ):
| NonNullable<ResolvedMetadata['twitter']>['images'] | NonNullable<ResolvedMetadata['twitter']>['images']
| NonNullable<ResolvedMetadata['openGraph']>['images'] { | NonNullable<ResolvedMetadata['openGraph']>['images'] {
...@@ -86,7 +95,8 @@ export function resolveImages( ...@@ -86,7 +95,8 @@ export function resolveImages(
const resolvedItem = resolveAndValidateImage( const resolvedItem = resolveAndValidateImage(
item, item,
fallbackMetadataBase, fallbackMetadataBase,
isMetadataBaseMissing isMetadataBaseMissing,
isStandaloneMode
) )
if (!resolvedItem) continue if (!resolvedItem) continue
...@@ -149,7 +159,11 @@ export const resolveOpenGraph: FieldResolverExtraArgs< ...@@ -149,7 +159,11 @@ export const resolveOpenGraph: FieldResolverExtraArgs<
} }
} }
} }
target.images = resolveImages(og.images, metadataBase) target.images = resolveImages(
og.images,
metadataBase,
metadataContext.isStandaloneMode
)
} }
const resolved = { const resolved = {
...@@ -179,8 +193,8 @@ const TwitterBasicInfoKeys = [ ...@@ -179,8 +193,8 @@ const TwitterBasicInfoKeys = [
export const resolveTwitter: FieldResolverExtraArgs< export const resolveTwitter: FieldResolverExtraArgs<
'twitter', 'twitter',
[ResolvedMetadataBase, string | null] [ResolvedMetadataBase, MetadataContext, string | null]
> = (twitter, metadataBase, titleTemplate) => { > = (twitter, metadataBase, metadataContext, titleTemplate) => {
if (!twitter) return null if (!twitter) return null
let card = 'card' in twitter ? twitter.card : undefined let card = 'card' in twitter ? twitter.card : undefined
const resolved = { const resolved = {
...@@ -191,7 +205,11 @@ export const resolveTwitter: FieldResolverExtraArgs< ...@@ -191,7 +205,11 @@ export const resolveTwitter: FieldResolverExtraArgs<
resolved[infoKey] = twitter[infoKey] || null resolved[infoKey] = twitter[infoKey] || null
} }
resolved.images = resolveImages(twitter.images, metadataBase) resolved.images = resolveImages(
twitter.images,
metadataBase,
metadataContext.isStandaloneMode
)
card = card || (resolved.images?.length ? 'summary_large_image' : 'summary') card = card || (resolved.images?.length ? 'summary_large_image' : 'summary')
resolved.card = card resolved.card = card
......
...@@ -53,6 +53,7 @@ describe('resolveAbsoluteUrlWithPathname', () => { ...@@ -53,6 +53,7 @@ describe('resolveAbsoluteUrlWithPathname', () => {
const opts = { const opts = {
trailingSlash: false, trailingSlash: false,
pathname: '/', pathname: '/',
isStandaloneMode: false,
} }
const resolver = (url: string | URL) => const resolver = (url: string | URL) =>
resolveAbsoluteUrlWithPathname(url, metadataBase, opts) resolveAbsoluteUrlWithPathname(url, metadataBase, opts)
...@@ -68,6 +69,7 @@ describe('resolveAbsoluteUrlWithPathname', () => { ...@@ -68,6 +69,7 @@ describe('resolveAbsoluteUrlWithPathname', () => {
const opts = { const opts = {
trailingSlash: true, trailingSlash: true,
pathname: '/', pathname: '/',
isStandaloneMode: false,
} }
const resolver = (url: string | URL) => const resolver = (url: string | URL) =>
resolveAbsoluteUrlWithPathname(url, metadataBase, opts) resolveAbsoluteUrlWithPathname(url, metadataBase, opts)
......
...@@ -16,4 +16,5 @@ export type FieldResolverExtraArgs< ...@@ -16,4 +16,5 @@ export type FieldResolverExtraArgs<
export type MetadataContext = { export type MetadataContext = {
pathname: string pathname: string
trailingSlash: boolean trailingSlash: boolean
isStandaloneMode: boolean
} }
...@@ -42,7 +42,10 @@ import { ...@@ -42,7 +42,10 @@ import {
NEXT_URL, NEXT_URL,
RSC_HEADER, RSC_HEADER,
} from '../../client/components/app-router-headers' } from '../../client/components/app-router-headers'
import { createMetadataComponents } from '../../lib/metadata/metadata' import {
createMetadataComponents,
createMetadataContext,
} from '../../lib/metadata/metadata'
import { RequestAsyncStorageWrapper } from '../async-storage/request-async-storage-wrapper' import { RequestAsyncStorageWrapper } from '../async-storage/request-async-storage-wrapper'
import { StaticGenerationAsyncStorageWrapper } from '../async-storage/static-generation-async-storage-wrapper' import { StaticGenerationAsyncStorageWrapper } from '../async-storage/static-generation-async-storage-wrapper'
import { isNotFoundError } from '../../client/components/not-found' import { isNotFoundError } from '../../client/components/not-found'
...@@ -325,9 +328,8 @@ async function generateFlight( ...@@ -325,9 +328,8 @@ async function generateFlight(
if (!options?.skipFlight) { if (!options?.skipFlight) {
const [MetadataTree, MetadataOutlet] = createMetadataComponents({ const [MetadataTree, MetadataOutlet] = createMetadataComponents({
tree: loaderTree, tree: loaderTree,
pathname: urlPathname,
trailingSlash: ctx.renderOpts.trailingSlash,
query, query,
metadataContext: createMetadataContext(urlPathname, ctx.renderOpts),
getDynamicParamFromSegment, getDynamicParamFromSegment,
appUsingSizeAdjustment, appUsingSizeAdjustment,
createDynamicallyTrackedSearchParams, createDynamicallyTrackedSearchParams,
...@@ -450,9 +452,8 @@ async function ReactServerApp({ tree, ctx, asNotFound }: ReactServerAppProps) { ...@@ -450,9 +452,8 @@ async function ReactServerApp({ tree, ctx, asNotFound }: ReactServerAppProps) {
const [MetadataTree, MetadataOutlet] = createMetadataComponents({ const [MetadataTree, MetadataOutlet] = createMetadataComponents({
tree, tree,
errorType: asNotFound ? 'not-found' : undefined, errorType: asNotFound ? 'not-found' : undefined,
pathname: urlPathname,
trailingSlash: ctx.renderOpts.trailingSlash,
query, query,
metadataContext: createMetadataContext(urlPathname, ctx.renderOpts),
getDynamicParamFromSegment: getDynamicParamFromSegment, getDynamicParamFromSegment: getDynamicParamFromSegment,
appUsingSizeAdjustment: appUsingSizeAdjustment, appUsingSizeAdjustment: appUsingSizeAdjustment,
createDynamicallyTrackedSearchParams, createDynamicallyTrackedSearchParams,
...@@ -538,8 +539,7 @@ async function ReactServerError({ ...@@ -538,8 +539,7 @@ async function ReactServerError({
const [MetadataTree] = createMetadataComponents({ const [MetadataTree] = createMetadataComponents({
tree, tree,
pathname: urlPathname, metadataContext: createMetadataContext(urlPathname, ctx.renderOpts),
trailingSlash: ctx.renderOpts.trailingSlash,
errorType, errorType,
query, query,
getDynamicParamFromSegment, getDynamicParamFromSegment,
......
...@@ -4,7 +4,7 @@ const METADATA_BASE_WARN_STRING = ...@@ -4,7 +4,7 @@ const METADATA_BASE_WARN_STRING =
'metadataBase property in metadata export is not set for resolving social open graph or twitter images,' 'metadataBase property in metadata export is not set for resolving social open graph or twitter images,'
describe('app dir - metadata missing metadataBase', () => { describe('app dir - metadata missing metadataBase', () => {
const { next, isNextDev, skipped } = nextTestSetup({ const { next, isNextDev, isNextDeploy, skipped } = nextTestSetup({
files: __dirname, files: __dirname,
skipDeployment: true, skipDeployment: true,
}) })
...@@ -13,6 +13,21 @@ describe('app dir - metadata missing metadataBase', () => { ...@@ -13,6 +13,21 @@ describe('app dir - metadata missing metadataBase', () => {
return return
} }
if (process.env.TEST_STANDALONE === '1') {
beforeAll(async () => {
await next.stop()
await next.patchFile(
'next.config.js',
`
module.exports = {
output: 'standalone',
}
`
)
await next.start()
})
}
// If it's start mode, we get the whole logs since they're from build process. // If it's start mode, we get the whole logs since they're from build process.
// If it's development mode, we get the logs after request // If it's development mode, we get the logs after request
function getCliOutput(logStartPosition: number) { function getCliOutput(logStartPosition: number) {
...@@ -28,16 +43,33 @@ describe('app dir - metadata missing metadataBase', () => { ...@@ -28,16 +43,33 @@ describe('app dir - metadata missing metadataBase', () => {
}) })
} }
it('should fallback to localhost if metadataBase is missing for absolute urls resolving', async () => { if (process.env.TEST_STANDALONE === '1') {
const logStartPosition = next.cliOutput.length // Standalone mode should always show the warning
await next.fetch('/og-image-convention') it('should fallback to localhost if metadataBase is missing for absolute urls resolving', async () => {
const output = getCliOutput(logStartPosition) const logStartPosition = next.cliOutput.length
expect(output).toInclude(METADATA_BASE_WARN_STRING) await next.fetch('/og-image-convention')
expect(output).toMatch(/using "http:\/\/localhost:\d+/) const output = getCliOutput(logStartPosition)
expect(output).toInclude(
'. See https://nextjs.org/docs/app/api-reference/functions/generate-metadata#metadatabase' expect(output).toInclude(METADATA_BASE_WARN_STRING)
) expect(output).toMatch(/using "http:\/\/localhost:\d+/)
}) expect(output).toInclude(
'. See https://nextjs.org/docs/app/api-reference/functions/generate-metadata#metadatabase'
)
})
} else {
// Default output mode
it('should show warning in vercel deployment output in default build output mode', async () => {
const logStartPosition = next.cliOutput.length
await next.fetch('/og-image-convention')
const output = getCliOutput(logStartPosition)
if (isNextDeploy || isNextDev) {
expect(output).not.toInclude(METADATA_BASE_WARN_STRING)
} else {
expect(output).toInclude(METADATA_BASE_WARN_STRING)
}
})
}
it('should warn for unsupported metadata properties', async () => { it('should warn for unsupported metadata properties', async () => {
const logStartPosition = next.cliOutput.length const logStartPosition = next.cliOutput.length
......
process.env.TEST_STANDALONE = '1'
require('./index.test')
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