Unverified Commit 3c4ec650 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Should not warn metadataBase missing if only absolute urls are present (#61898)

### What

* Narrow down the metadata base warnings only when there's any relative
urls need to be resolved, if there's only absolute urls present, no need
to resolve and we don't warn.
* Polish the error message, updated from "metadata.metadataBase is not
set ..." to "metadataBase property in metadata export is not set ..."

### Why

It will be confusing if we're still show metadataBase warning when
there's no need to set one, since the social image cards only have
absolute urls

Closes NEXT-2426
parent 994fdd71
...@@ -17,6 +17,11 @@ import { ...@@ -17,6 +17,11 @@ import {
resolveAbsoluteUrlWithPathname, resolveAbsoluteUrlWithPathname,
} from './resolve-url' } from './resolve-url'
import { resolveTitle } from './resolve-title' import { resolveTitle } from './resolve-title'
import { isFullStringUrl } from '../../url'
import { warnOnce } from '../../../build/output/log'
type FlattenArray<T> = T extends (infer U)[] ? U : T
type ResolvedMetadataBase = ResolvedMetadata['metadataBase']
const OgTypeFields = { const OgTypeFields = {
article: ['authors', 'tags'], article: ['authors', 'tags'],
...@@ -34,41 +39,58 @@ const OgTypeFields = { ...@@ -34,41 +39,58 @@ const OgTypeFields = {
], ],
} as const } as const
function resolveAndValidateImage(
item: FlattenArray<OpenGraph['images'] | Twitter['images']>,
metadataBase: NonNullable<ResolvedMetadataBase>,
isMetadataBaseMissing: boolean
) {
if (!item) return undefined
const isItemUrl = isStringOrURL(item)
const inputUrl = isItemUrl ? item : item.url
if (!inputUrl) return undefined
validateResolvedImageUrl(inputUrl, metadataBase, isMetadataBaseMissing)
return isItemUrl
? {
url: resolveUrl(inputUrl, metadataBase),
}
: {
...item,
// Update image descriptor url
url: resolveUrl(inputUrl, metadataBase),
}
}
export function resolveImages( export function resolveImages(
images: Twitter['images'], images: Twitter['images'],
metadataBase: ResolvedMetadata['metadataBase'] metadataBase: ResolvedMetadataBase
): NonNullable<ResolvedMetadata['twitter']>['images'] ): NonNullable<ResolvedMetadata['twitter']>['images']
export function resolveImages( export function resolveImages(
images: OpenGraph['images'], images: OpenGraph['images'],
metadataBase: ResolvedMetadata['metadataBase'] metadataBase: ResolvedMetadataBase
): 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: ResolvedMetadata['metadataBase'] metadataBase: ResolvedMetadataBase
): ):
| NonNullable<ResolvedMetadata['twitter']>['images'] | NonNullable<ResolvedMetadata['twitter']>['images']
| NonNullable<ResolvedMetadata['openGraph']>['images'] { | NonNullable<ResolvedMetadata['openGraph']>['images'] {
const resolvedImages = resolveAsArrayOrUndefined(images) const resolvedImages = resolveAsArrayOrUndefined(images)
if (!resolvedImages) return resolvedImages if (!resolvedImages) return resolvedImages
const { isMetadataBaseMissing, fallbackMetadataBase } =
getSocialImageFallbackMetadataBase(metadataBase)
const nonNullableImages = [] const nonNullableImages = []
for (const item of resolvedImages) { for (const item of resolvedImages) {
if (!item) continue const resolvedItem = resolveAndValidateImage(
const isItemUrl = isStringOrURL(item) item,
const inputUrl = isItemUrl ? item : item.url fallbackMetadataBase,
if (!inputUrl) continue isMetadataBaseMissing
nonNullableImages.push(
isItemUrl
? {
url: resolveUrl(item, metadataBase),
}
: {
...item,
// Update image descriptor url
url: resolveUrl(item.url, metadataBase),
}
) )
if (!resolvedItem) continue
nonNullableImages.push(resolvedItem)
} }
return nonNullableImages return nonNullableImages
...@@ -94,9 +116,26 @@ function getFieldsByOgType(ogType: OpenGraphType | undefined) { ...@@ -94,9 +116,26 @@ function getFieldsByOgType(ogType: OpenGraphType | undefined) {
} }
} }
function validateResolvedImageUrl(
inputUrl: string | URL,
fallbackMetadataBase: NonNullable<ResolvedMetadataBase>,
isMetadataBaseMissing: boolean
): void {
// Only warn on the image url that needs to be resolved with metadataBase
if (
typeof inputUrl === 'string' &&
!isFullStringUrl(inputUrl) &&
isMetadataBaseMissing
) {
warnOnce(
`metadataBase property in metadata export is not set for resolving social open graph or twitter images, using "${fallbackMetadataBase.origin}". See https://nextjs.org/docs/app/api-reference/functions/generate-metadata#metadatabase`
)
}
}
export const resolveOpenGraph: FieldResolverExtraArgs< export const resolveOpenGraph: FieldResolverExtraArgs<
'openGraph', 'openGraph',
[ResolvedMetadata['metadataBase'], MetadataContext, string | null] [ResolvedMetadataBase, MetadataContext, string | null]
> = (openGraph, metadataBase, metadataContext, titleTemplate) => { > = (openGraph, metadataBase, metadataContext, titleTemplate) => {
if (!openGraph) return null if (!openGraph) return null
...@@ -114,9 +153,7 @@ export const resolveOpenGraph: FieldResolverExtraArgs< ...@@ -114,9 +153,7 @@ export const resolveOpenGraph: FieldResolverExtraArgs<
} }
} }
} }
target.images = resolveImages(og.images, metadataBase)
const imageMetadataBase = getSocialImageFallbackMetadataBase(metadataBase)
target.images = resolveImages(og.images, imageMetadataBase)
} }
const resolved = { const resolved = {
...@@ -146,7 +183,7 @@ const TwitterBasicInfoKeys = [ ...@@ -146,7 +183,7 @@ const TwitterBasicInfoKeys = [
export const resolveTwitter: FieldResolverExtraArgs< export const resolveTwitter: FieldResolverExtraArgs<
'twitter', 'twitter',
[ResolvedMetadata['metadataBase'], string | null] [ResolvedMetadataBase, string | null]
> = (twitter, metadataBase, titleTemplate) => { > = (twitter, metadataBase, 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
...@@ -157,8 +194,8 @@ export const resolveTwitter: FieldResolverExtraArgs< ...@@ -157,8 +194,8 @@ export const resolveTwitter: FieldResolverExtraArgs<
for (const infoKey of TwitterBasicInfoKeys) { for (const infoKey of TwitterBasicInfoKeys) {
resolved[infoKey] = twitter[infoKey] || null resolved[infoKey] = twitter[infoKey] || null
} }
const imageMetadataBase = getSocialImageFallbackMetadataBase(metadataBase)
resolved.images = resolveImages(twitter.images, imageMetadataBase) resolved.images = resolveImages(twitter.images, metadataBase)
card = card || (resolved.images?.length ? 'summary_large_image' : 'summary') card = card || (resolved.images?.length ? 'summary_large_image' : 'summary')
resolved.card = card resolved.card = card
......
import path from '../../../shared/lib/isomorphic/path' import path from '../../../shared/lib/isomorphic/path'
import * as Log from '../../../build/output/log'
import type { MetadataContext } from '../types/resolvers' import type { MetadataContext } from '../types/resolvers'
function isStringOrURL(icon: any): icon is string | URL { function isStringOrURL(icon: any): icon is string | URL {
...@@ -12,19 +11,20 @@ function createLocalMetadataBase() { ...@@ -12,19 +11,20 @@ function createLocalMetadataBase() {
// 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( export function getSocialImageFallbackMetadataBase(metadataBase: URL | null): {
metadataBase: URL | null fallbackMetadataBase: URL
): URL | null { isMetadataBaseMissing: boolean
} {
const isMetadataBaseMissing = !metadataBase const isMetadataBaseMissing = !metadataBase
const defaultMetadataBase = createLocalMetadataBase() const defaultMetadataBase = createLocalMetadataBase()
const deploymentUrl = const deploymentUrl =
process.env.VERCEL_URL && new URL(`https://${process.env.VERCEL_URL}`) process.env.VERCEL_URL && new URL(`https://${process.env.VERCEL_URL}`)
let fallbackMetadata let fallbackMetadataBase
if (process.env.NODE_ENV === 'development') { if (process.env.NODE_ENV === 'development') {
fallbackMetadata = defaultMetadataBase fallbackMetadataBase = defaultMetadataBase
} else { } else {
fallbackMetadata = fallbackMetadataBase =
process.env.NODE_ENV === 'production' && process.env.NODE_ENV === 'production' &&
deploymentUrl && deploymentUrl &&
process.env.VERCEL_ENV === 'preview' process.env.VERCEL_ENV === 'preview'
...@@ -32,14 +32,10 @@ export function getSocialImageFallbackMetadataBase( ...@@ -32,14 +32,10 @@ export function getSocialImageFallbackMetadataBase(
: metadataBase || deploymentUrl || defaultMetadataBase : metadataBase || deploymentUrl || defaultMetadataBase
} }
if (isMetadataBaseMissing) { return {
Log.warnOnce('') fallbackMetadataBase,
Log.warnOnce( isMetadataBaseMissing,
`metadata.metadataBase is not set for resolving social open graph or twitter images, using "${fallbackMetadata.origin}". See https://nextjs.org/docs/app/api-reference/functions/generate-metadata#metadatabase`
)
} }
return fallbackMetadata
} }
function resolveUrl(url: null | undefined, metadataBase: URL | null): null function resolveUrl(url: null | undefined, metadataBase: URL | null): null
......
const DUMMY_ORIGIN = 'http://n'
function getUrlWithoutHost(url: string) { function getUrlWithoutHost(url: string) {
return new URL(url, 'http://n') return new URL(url, DUMMY_ORIGIN)
} }
export function getPathname(url: string) { export function getPathname(url: string) {
return getUrlWithoutHost(url).pathname return getUrlWithoutHost(url).pathname
} }
export function isFullStringUrl(url: string) {
return /https?:\/\//.test(url)
}
import React from 'react'
export default function Page() { export default function Page() {
return <>hello index</> return 'absolute url og page'
} }
export const metadata = { export const metadata = {
title: 'index page', openGraph: {
images: 'https://repository-images.githubusercontent.com/123',
},
} }
export default function Layout({ children }) { export default function Layout({ children }) {
return ( return (
<html> <html>
<head></head>
<body>{children}</body> <body>{children}</body>
</html> </html>
) )
......
export default function Page() {
return 'page'
}
import { createNextDescribe } from 'e2e-utils' import { createNextDescribe } from 'e2e-utils'
import { fetchViaHTTP } from 'next-test-utils' import { fetchViaHTTP } from 'next-test-utils'
const METADATA_BASE_WARN_STRING =
'metadataBase property in metadata export is not set for resolving social open graph or twitter images,'
createNextDescribe( createNextDescribe(
'app dir - metadata missing metadataBase', 'app dir - metadata missing metadataBase',
{ {
files: __dirname, files: __dirname,
skipDeployment: true, skipDeployment: true,
}, },
({ next, isNextStart }) => { ({ next, isNextDev }) => {
// 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 dev mode, we get the logs after request // If it's dev mode, we get the logs after request
function getCliOutput(logStartPosition: number) { function getCliOutput(logStartPosition: number) {
return isNextStart return isNextDev ? next.cliOutput.slice(logStartPosition) : next.cliOutput
? next.cliOutput }
: next.cliOutput.slice(logStartPosition)
if (isNextDev) {
it('should not warn metadataBase is missing if there is only absolute url', async () => {
const logStartPosition = next.cliOutput.length
await fetchViaHTTP(next.url, '/absolute-url-og')
const output = getCliOutput(logStartPosition)
expect(output).not.toInclude(METADATA_BASE_WARN_STRING)
})
} }
it('should fallback to localhost if metadataBase is missing for absolute urls resolving', async () => { it('should fallback to localhost if metadataBase is missing for absolute urls resolving', async () => {
const logStartPosition = next.cliOutput.length const logStartPosition = next.cliOutput.length
await fetchViaHTTP(next.url, '/') await fetchViaHTTP(next.url, '/og-image-convention')
//
const output = getCliOutput(logStartPosition) const output = getCliOutput(logStartPosition)
expect(output).toInclude( expect(output).toInclude(METADATA_BASE_WARN_STRING)
'metadata.metadataBase is not set for resolving social open graph or twitter images,'
)
expect(output).toMatch(/using "http:\/\/localhost:\d+/) expect(output).toMatch(/using "http:\/\/localhost:\d+/)
expect(output).toInclude( expect(output).toInclude(
'. See https://nextjs.org/docs/app/api-reference/functions/generate-metadata#metadatabase' '. See https://nextjs.org/docs/app/api-reference/functions/generate-metadata#metadatabase'
......
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