Unverified Commit a6946b69 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Backport metadata fixes (#62663)

Backport metadata fixes 
#61898
#62109
#62615

Closes NEXT-2641
parent 4002f4b3
...@@ -124,8 +124,9 @@ async function createAppRouteCode({ ...@@ -124,8 +124,9 @@ async function createAppRouteCode({
resolvedPagePath = `next-metadata-route-loader?${stringify({ resolvedPagePath = `next-metadata-route-loader?${stringify({
page, page,
filePath: resolvedPagePath,
isDynamic: isDynamic ? '1' : '0', isDynamic: isDynamic ? '1' : '0',
})}!${resolvedPagePath}${`?${WEBPACK_RESOURCE_QUERIES.metadataRoute}`}` })}!?${WEBPACK_RESOURCE_QUERIES.metadataRoute}`
} }
const pathname = new AppPathnameNormalizer().normalize(page) const pathname = new AppPathnameNormalizer().normalize(page)
......
...@@ -22,6 +22,7 @@ const cacheHeader = { ...@@ -22,6 +22,7 @@ const cacheHeader = {
type MetadataRouteLoaderOptions = { type MetadataRouteLoaderOptions = {
page: string page: string
filePath: string
isDynamic: '1' | '0' isDynamic: '1' | '0'
} }
...@@ -46,7 +47,6 @@ function getContentType(resourcePath: string) { ...@@ -46,7 +47,6 @@ function getContentType(resourcePath: string) {
return 'text/plain' return 'text/plain'
} }
// Strip metadata resource query string from `import.meta.url` to make sure the fs.readFileSync get the right path.
async function getStaticAssetRouteCode( async function getStaticAssetRouteCode(
resourcePath: string, resourcePath: string,
fileBaseName: string fileBaseName: string
...@@ -58,6 +58,7 @@ async function getStaticAssetRouteCode( ...@@ -58,6 +58,7 @@ async function getStaticAssetRouteCode(
? cacheHeader.none ? cacheHeader.none
: cacheHeader.longCache : cacheHeader.longCache
const code = `\ const code = `\
/* static asset route */
import { NextResponse } from 'next/server' import { NextResponse } from 'next/server'
const contentType = ${JSON.stringify(getContentType(resourcePath))} const contentType = ${JSON.stringify(getContentType(resourcePath))}
...@@ -82,6 +83,7 @@ export const dynamic = 'force-static' ...@@ -82,6 +83,7 @@ export const dynamic = 'force-static'
function getDynamicTextRouteCode(resourcePath: string) { function getDynamicTextRouteCode(resourcePath: string) {
return `\ return `\
/* dynamic asset route */
import { NextResponse } from 'next/server' import { NextResponse } from 'next/server'
import handler from ${JSON.stringify(resourcePath)} import handler from ${JSON.stringify(resourcePath)}
import { resolveRouteData } from 'next/dist/build/webpack/loaders/metadata/resolve-route-data' import { resolveRouteData } from 'next/dist/build/webpack/loaders/metadata/resolve-route-data'
...@@ -108,6 +110,7 @@ export async function GET() { ...@@ -108,6 +110,7 @@ export async function GET() {
// <metadata-image>/[id]/route.js // <metadata-image>/[id]/route.js
function getDynamicImageRouteCode(resourcePath: string) { function getDynamicImageRouteCode(resourcePath: string) {
return `\ return `\
/* dynamic image route */
import { NextResponse } from 'next/server' import { NextResponse } from 'next/server'
import * as userland from ${JSON.stringify(resourcePath)} import * as userland from ${JSON.stringify(resourcePath)}
...@@ -159,6 +162,7 @@ async function getDynamicSiteMapRouteCode( ...@@ -159,6 +162,7 @@ async function getDynamicSiteMapRouteCode(
page.includes('[__metadata_id__]') page.includes('[__metadata_id__]')
) { ) {
staticGenerationCode = `\ staticGenerationCode = `\
/* dynamic sitemap route */
export async function generateStaticParams() { export async function generateStaticParams() {
const sitemaps = generateSitemaps ? await generateSitemaps() : [] const sitemaps = generateSitemaps ? await generateSitemaps() : []
const params = [] const params = []
...@@ -224,26 +228,25 @@ ${staticGenerationCode} ...@@ -224,26 +228,25 @@ ${staticGenerationCode}
` `
return code return code
} }
// `import.meta.url` is the resource name of the current module.
// When it's static route, it could be favicon.ico, sitemap.xml, robots.txt etc. // When it's static route, it could be favicon.ico, sitemap.xml, robots.txt etc.
// TODO-METADATA: improve the cache control strategy // TODO-METADATA: improve the cache control strategy
const nextMetadataRouterLoader: webpack.LoaderDefinitionFunction<MetadataRouteLoaderOptions> = const nextMetadataRouterLoader: webpack.LoaderDefinitionFunction<MetadataRouteLoaderOptions> =
async function () { async function () {
const { resourcePath } = this const { page, isDynamic, filePath } = this.getOptions()
const { page, isDynamic } = this.getOptions() const { name: fileBaseName } = getFilenameAndExtension(filePath)
const { name: fileBaseName } = getFilenameAndExtension(resourcePath)
let code = '' let code = ''
if (isDynamic === '1') { if (isDynamic === '1') {
if (fileBaseName === 'robots' || fileBaseName === 'manifest') { if (fileBaseName === 'robots' || fileBaseName === 'manifest') {
code = getDynamicTextRouteCode(resourcePath) code = getDynamicTextRouteCode(filePath)
} else if (fileBaseName === 'sitemap') { } else if (fileBaseName === 'sitemap') {
code = await getDynamicSiteMapRouteCode(resourcePath, page, this) code = await getDynamicSiteMapRouteCode(filePath, page, this)
} else { } else {
code = getDynamicImageRouteCode(resourcePath) code = getDynamicImageRouteCode(filePath)
} }
} else { } else {
code = await getStaticAssetRouteCode(resourcePath, fileBaseName) code = await getStaticAssetRouteCode(filePath, fileBaseName)
} }
return code return code
......
...@@ -474,6 +474,7 @@ export async function exportAppImpl( ...@@ -474,6 +474,7 @@ export async function exportAppImpl(
distDir, distDir,
dev: false, dev: false,
basePath: nextConfig.basePath, basePath: nextConfig.basePath,
trailingSlash: nextConfig.trailingSlash,
canonicalBase: nextConfig.amp?.canonicalBase || '', canonicalBase: nextConfig.amp?.canonicalBase || '',
ampSkipValidation: nextConfig.experimental.amp?.skipValidation || false, ampSkipValidation: nextConfig.experimental.amp?.skipValidation || false,
ampOptimizerConfig: nextConfig.experimental.amp?.optimizer || undefined, ampOptimizerConfig: nextConfig.experimental.amp?.optimizer || undefined,
......
...@@ -39,6 +39,7 @@ export function createMetadataComponents({ ...@@ -39,6 +39,7 @@ export function createMetadataComponents({
tree, tree,
pathname, pathname,
searchParams, searchParams,
trailingSlash,
getDynamicParamFromSegment, getDynamicParamFromSegment,
appUsingSizeAdjustment, appUsingSizeAdjustment,
errorType, errorType,
...@@ -46,12 +47,14 @@ export function createMetadataComponents({ ...@@ -46,12 +47,14 @@ export function createMetadataComponents({
tree: LoaderTree tree: LoaderTree
pathname: string pathname: string
searchParams: { [key: string]: any } searchParams: { [key: string]: any }
trailingSlash: boolean
getDynamicParamFromSegment: GetDynamicParamFromSegment getDynamicParamFromSegment: GetDynamicParamFromSegment
appUsingSizeAdjustment: boolean appUsingSizeAdjustment: boolean
errorType?: 'not-found' | 'redirect' errorType?: 'not-found' | 'redirect'
}): [React.ComponentType, React.ComponentType] { }): [React.ComponentType, React.ComponentType] {
const metadataContext = { const metadataContext = {
pathname, pathname,
trailingSlash,
} }
let resolve: (value: Error | undefined) => void | undefined let resolve: (value: Error | undefined) => void | undefined
......
...@@ -16,6 +16,7 @@ function accumulateMetadata(metadataItems: MetadataItems) { ...@@ -16,6 +16,7 @@ function accumulateMetadata(metadataItems: MetadataItems) {
]) ])
return originAccumulateMetadata(fullMetadataItems, { return originAccumulateMetadata(fullMetadataItems, {
pathname: '/test', pathname: '/test',
trailingSlash: false,
}) })
} }
......
...@@ -2,7 +2,11 @@ import type { ...@@ -2,7 +2,11 @@ import type {
AlternateLinkDescriptor, AlternateLinkDescriptor,
ResolvedAlternateURLs, ResolvedAlternateURLs,
} from '../types/alternative-urls-types' } from '../types/alternative-urls-types'
import type { Metadata, ResolvedMetadata } from '../types/metadata-interface' import type {
Metadata,
ResolvedMetadata,
Viewport,
} from '../types/metadata-interface'
import type { ResolvedVerification } from '../types/metadata-types' import type { ResolvedVerification } from '../types/metadata-types'
import type { import type {
FieldResolver, FieldResolver,
...@@ -15,19 +19,21 @@ import { resolveAbsoluteUrlWithPathname } from './resolve-url' ...@@ -15,19 +19,21 @@ import { resolveAbsoluteUrlWithPathname } from './resolve-url'
function resolveAlternateUrl( function resolveAlternateUrl(
url: string | URL, url: string | URL,
metadataBase: URL | null, metadataBase: URL | null,
pathname: string metadataContext: MetadataContext
) { ) {
// If alter native url is an URL instance, // If alter native url is an URL instance,
// we treat it as a URL base and resolve with current pathname // we treat it as a URL base and resolve with current pathname
if (url instanceof URL) { if (url instanceof URL) {
url = new URL(pathname, url) url = new URL(metadataContext.pathname, url)
} }
return resolveAbsoluteUrlWithPathname(url, metadataBase, pathname) return resolveAbsoluteUrlWithPathname(url, metadataBase, metadataContext)
} }
export const resolveThemeColor: FieldResolver<'themeColor'> = (themeColor) => { export const resolveThemeColor: FieldResolver<'themeColor', Viewport> = (
themeColor
) => {
if (!themeColor) return null if (!themeColor) return null
const themeColorDescriptors: ResolvedMetadata['themeColor'] = [] const themeColorDescriptors: Viewport['themeColor'] = []
resolveAsArrayOrUndefined(themeColor)?.forEach((descriptor) => { resolveAsArrayOrUndefined(themeColor)?.forEach((descriptor) => {
if (typeof descriptor === 'string') if (typeof descriptor === 'string')
...@@ -51,7 +57,7 @@ function resolveUrlValuesOfObject( ...@@ -51,7 +57,7 @@ function resolveUrlValuesOfObject(
| null | null
| undefined, | undefined,
metadataBase: ResolvedMetadata['metadataBase'], metadataBase: ResolvedMetadata['metadataBase'],
pathname: string metadataContext: MetadataContext
): null | Record<string, AlternateLinkDescriptor[]> { ): null | Record<string, AlternateLinkDescriptor[]> {
if (!obj) return null if (!obj) return null
...@@ -60,13 +66,13 @@ function resolveUrlValuesOfObject( ...@@ -60,13 +66,13 @@ function resolveUrlValuesOfObject(
if (typeof value === 'string' || value instanceof URL) { if (typeof value === 'string' || value instanceof URL) {
result[key] = [ result[key] = [
{ {
url: resolveAlternateUrl(value, metadataBase, pathname), url: resolveAlternateUrl(value, metadataBase, metadataContext),
}, },
] ]
} else { } else {
result[key] = [] result[key] = []
value?.forEach((item, index) => { value?.forEach((item, index) => {
const url = resolveAlternateUrl(item.url, metadataBase, pathname) const url = resolveAlternateUrl(item.url, metadataBase, metadataContext)
result[key][index] = { result[key][index] = {
url, url,
title: item.title, title: item.title,
...@@ -80,7 +86,7 @@ function resolveUrlValuesOfObject( ...@@ -80,7 +86,7 @@ function resolveUrlValuesOfObject(
function resolveCanonicalUrl( function resolveCanonicalUrl(
urlOrDescriptor: string | URL | null | AlternateLinkDescriptor | undefined, urlOrDescriptor: string | URL | null | AlternateLinkDescriptor | undefined,
metadataBase: URL | null, metadataBase: URL | null,
pathname: string metadataContext: MetadataContext
): null | AlternateLinkDescriptor { ): null | AlternateLinkDescriptor {
if (!urlOrDescriptor) return null if (!urlOrDescriptor) return null
...@@ -91,35 +97,35 @@ function resolveCanonicalUrl( ...@@ -91,35 +97,35 @@ function resolveCanonicalUrl(
// Return string url because structureClone can't handle URL instance // Return string url because structureClone can't handle URL instance
return { return {
url: resolveAlternateUrl(url, metadataBase, pathname), url: resolveAlternateUrl(url, metadataBase, metadataContext),
} }
} }
export const resolveAlternates: FieldResolverExtraArgs< export const resolveAlternates: FieldResolverExtraArgs<
'alternates', 'alternates',
[ResolvedMetadata['metadataBase'], MetadataContext] [ResolvedMetadata['metadataBase'], MetadataContext]
> = (alternates, metadataBase, { pathname }) => { > = (alternates, metadataBase, context) => {
if (!alternates) return null if (!alternates) return null
const canonical = resolveCanonicalUrl( const canonical = resolveCanonicalUrl(
alternates.canonical, alternates.canonical,
metadataBase, metadataBase,
pathname context
) )
const languages = resolveUrlValuesOfObject( const languages = resolveUrlValuesOfObject(
alternates.languages, alternates.languages,
metadataBase, metadataBase,
pathname context
) )
const media = resolveUrlValuesOfObject( const media = resolveUrlValuesOfObject(
alternates.media, alternates.media,
metadataBase, metadataBase,
pathname context
) )
const types = resolveUrlValuesOfObject( const types = resolveUrlValuesOfObject(
alternates.types, alternates.types,
metadataBase, metadataBase,
pathname context
) )
const result: ResolvedAlternateURLs = { const result: ResolvedAlternateURLs = {
...@@ -236,12 +242,12 @@ export const resolveAppLinks: FieldResolver<'appLinks'> = (appLinks) => { ...@@ -236,12 +242,12 @@ export const resolveAppLinks: FieldResolver<'appLinks'> = (appLinks) => {
export const resolveItunes: FieldResolverExtraArgs< export const resolveItunes: FieldResolverExtraArgs<
'itunes', 'itunes',
[ResolvedMetadata['metadataBase'], MetadataContext] [ResolvedMetadata['metadataBase'], MetadataContext]
> = (itunes, metadataBase, { pathname }) => { > = (itunes, metadataBase, context) => {
if (!itunes) return null if (!itunes) return null
return { return {
appId: itunes.appId, appId: itunes.appId,
appArgument: itunes.appArgument appArgument: itunes.appArgument
? resolveAlternateUrl(itunes.appArgument, metadataBase, pathname) ? resolveAlternateUrl(itunes.appArgument, metadataBase, context)
: undefined, : undefined,
} }
} }
...@@ -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,10 +116,27 @@ function getFieldsByOgType(ogType: OpenGraphType | undefined) { ...@@ -94,10 +116,27 @@ 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] [ResolvedMetadata['metadataBase'], MetadataContext, string | null]
> = (openGraph, metadataBase, { pathname }, titleTemplate) => { > = (openGraph, metadataBase, metadataContext, titleTemplate) => {
if (!openGraph) return null if (!openGraph) return null
function resolveProps(target: ResolvedOpenGraph, og: OpenGraph) { function resolveProps(target: ResolvedOpenGraph, og: OpenGraph) {
...@@ -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 = {
...@@ -126,7 +163,11 @@ export const resolveOpenGraph: FieldResolverExtraArgs< ...@@ -126,7 +163,11 @@ export const resolveOpenGraph: FieldResolverExtraArgs<
resolveProps(resolved, openGraph) resolveProps(resolved, openGraph)
resolved.url = openGraph.url resolved.url = openGraph.url
? resolveAbsoluteUrlWithPathname(openGraph.url, metadataBase, pathname) ? resolveAbsoluteUrlWithPathname(
openGraph.url,
metadataBase,
metadataContext
)
: null : null
return resolved return resolved
...@@ -142,7 +183,7 @@ const TwitterBasicInfoKeys = [ ...@@ -142,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
...@@ -153,8 +194,8 @@ export const resolveTwitter: FieldResolverExtraArgs< ...@@ -153,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'
function isStringOrURL(icon: any): icon is string | URL { function isStringOrURL(icon: any): icon is string | URL {
return typeof icon === 'string' || icon instanceof URL return typeof icon === 'string' || icon instanceof URL
...@@ -11,19 +11,20 @@ function createLocalMetadataBase() { ...@@ -11,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'
...@@ -31,14 +32,10 @@ export function getSocialImageFallbackMetadataBase( ...@@ -31,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
...@@ -83,12 +80,23 @@ function resolveRelativeUrl(url: string | URL, pathname: string): string | URL { ...@@ -83,12 +80,23 @@ function resolveRelativeUrl(url: string | URL, pathname: string): string | URL {
function resolveAbsoluteUrlWithPathname( function resolveAbsoluteUrlWithPathname(
url: string | URL, url: string | URL,
metadataBase: URL | null, metadataBase: URL | null,
pathname: string { trailingSlash, pathname }: MetadataContext
) { ): string {
url = resolveRelativeUrl(url, pathname) url = resolveRelativeUrl(url, pathname)
// Get canonicalUrl without trailing slash
let canonicalUrl = ''
const result = metadataBase ? resolveUrl(url, metadataBase) : url const result = metadataBase ? resolveUrl(url, metadataBase) : url
return result.toString() if (typeof result === 'string') {
canonicalUrl = result
} else {
canonicalUrl = result.pathname === '/' ? result.origin : result.href
}
// Add trailing slash if it's enabled
return trailingSlash && !canonicalUrl.endsWith('/')
? `${canonicalUrl}/`
: canonicalUrl
} }
export { export {
......
...@@ -15,4 +15,5 @@ export type FieldResolverExtraArgs< ...@@ -15,4 +15,5 @@ export type FieldResolverExtraArgs<
export type MetadataContext = { export type MetadataContext = {
pathname: string pathname: string
trailingSlash: boolean
} }
const DUMMY_ORIGIN = 'http://n'
function getUrlWithoutHost(url: string) {
return new URL(url, DUMMY_ORIGIN)
}
export function getPathname(url: string) {
return getUrlWithoutHost(url).pathname
}
export function isFullStringUrl(url: string) {
return /https?:\/\//.test(url)
}
...@@ -265,6 +265,7 @@ async function generateFlight( ...@@ -265,6 +265,7 @@ async function generateFlight(
tree: loaderTree, tree: loaderTree,
pathname: urlPathname, pathname: urlPathname,
searchParams: providedSearchParams, searchParams: providedSearchParams,
trailingSlash: ctx.renderOpts.trailingSlash,
getDynamicParamFromSegment, getDynamicParamFromSegment,
appUsingSizeAdjustment, appUsingSizeAdjustment,
}) })
...@@ -391,6 +392,7 @@ async function ReactServerApp({ ...@@ -391,6 +392,7 @@ async function ReactServerApp({
errorType: asNotFound ? 'not-found' : undefined, errorType: asNotFound ? 'not-found' : undefined,
pathname: urlPathname, pathname: urlPathname,
searchParams: providedSearchParams, searchParams: providedSearchParams,
trailingSlash: ctx.renderOpts.trailingSlash,
getDynamicParamFromSegment: getDynamicParamFromSegment, getDynamicParamFromSegment: getDynamicParamFromSegment,
appUsingSizeAdjustment: appUsingSizeAdjustment, appUsingSizeAdjustment: appUsingSizeAdjustment,
}) })
...@@ -467,6 +469,7 @@ async function ReactServerError({ ...@@ -467,6 +469,7 @@ async function ReactServerError({
const [MetadataTree] = createMetadataComponents({ const [MetadataTree] = createMetadataComponents({
tree, tree,
pathname: urlPathname, pathname: urlPathname,
trailingSlash: ctx.renderOpts.trailingSlash,
errorType, errorType,
searchParams: providedSearchParams, searchParams: providedSearchParams,
getDynamicParamFromSegment, getDynamicParamFromSegment,
......
...@@ -111,6 +111,7 @@ export interface RenderOptsPartial { ...@@ -111,6 +111,7 @@ export interface RenderOptsPartial {
dev?: boolean dev?: boolean
buildId: string buildId: string
basePath: string basePath: string
trailingSlash: boolean
clientReferenceManifest?: ClientReferenceManifest clientReferenceManifest?: ClientReferenceManifest
supportsDynamicHTML: boolean supportsDynamicHTML: boolean
runtime?: ServerRuntime runtime?: ServerRuntime
......
...@@ -219,6 +219,7 @@ type BaseRenderOpts = { ...@@ -219,6 +219,7 @@ type BaseRenderOpts = {
poweredByHeader: boolean poweredByHeader: boolean
buildId: string buildId: string
generateEtags: boolean generateEtags: boolean
trailingSlash: boolean
runtimeConfig?: { [key: string]: any } runtimeConfig?: { [key: string]: any }
assetPrefix?: string assetPrefix?: string
canonicalBase: string canonicalBase: string
...@@ -506,6 +507,7 @@ export default abstract class Server<ServerOptions extends Options = Options> { ...@@ -506,6 +507,7 @@ export default abstract class Server<ServerOptions extends Options = Options> {
} }
this.renderOpts = { this.renderOpts = {
trailingSlash: this.nextConfig.trailingSlash,
deploymentId: this.nextConfig.experimental.deploymentId, deploymentId: this.nextConfig.experimental.deploymentId,
strictNextHead: !!this.nextConfig.experimental.strictNextHead, strictNextHead: !!this.nextConfig.experimental.strictNextHead,
poweredByHeader: this.nextConfig.poweredByHeader, poweredByHeader: this.nextConfig.poweredByHeader,
......
...@@ -323,7 +323,7 @@ createNextDescribe( ...@@ -323,7 +323,7 @@ createNextDescribe(
it('should pick configured metadataBase instead of deployment url for canonical url', async () => { it('should pick configured metadataBase instead of deployment url for canonical url', async () => {
const $ = await next.render$('/') const $ = await next.render$('/')
const canonicalUrl = $('link[rel="canonical"]').attr('href') const canonicalUrl = $('link[rel="canonical"]').attr('href')
expect(canonicalUrl).toBe('https://mydomain.com/') expect(canonicalUrl).toBe('https://mydomain.com')
}) })
it('should inject dynamic metadata properly to head', async () => { it('should inject dynamic metadata properly to head', async () => {
......
/** @type {import('next').NextConfig} */
module.exports = {} module.exports = {}
// For development: analyze the bundled chunks for stats app // For development: analyze the bundled chunks for stats app
......
export const metadata = {
title: 'Next.js',
description: 'Generated by Next.js',
}
export default function RootLayout({ children }) {
return (
<html lang="en">
<body>{children}</body>
</html>
)
}
{
"name": "My Next.js Application",
"short_name": "Next.js App",
"description": "An application built with Next.js",
"start_url": "/"
}
export default function page() {
return 'page.js'
}
import { createNextDescribe } from 'e2e-utils'
createNextDescribe(
'app-dir metadata-json-manifest',
{
files: __dirname,
skipDeployment: true,
},
({ next }) => {
it('should support metadata.json manifest', async () => {
const response = await next.fetch('/manifest.json')
expect(response.status).toBe(200)
const json = await response.json()
expect(json).toEqual({
name: 'My Next.js Application',
short_name: 'Next.js App',
description: 'An application built with Next.js',
start_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'
......
...@@ -434,7 +434,7 @@ createNextDescribe( ...@@ -434,7 +434,7 @@ createNextDescribe(
await matchMultiDom('meta', 'property', 'content', { await matchMultiDom('meta', 'property', 'content', {
'og:title': 'My custom title', 'og:title': 'My custom title',
'og:description': 'My custom description', 'og:description': 'My custom description',
'og:url': 'https://example.com/', 'og:url': 'https://example.com',
'og:site_name': 'My custom site name', 'og:site_name': 'My custom site name',
'og:locale': 'en-US', 'og:locale': 'en-US',
'og:type': 'website', 'og:type': 'website',
......
...@@ -8,3 +8,10 @@ export default function Root({ children }) { ...@@ -8,3 +8,10 @@ export default function Root({ children }) {
</html> </html>
) )
} }
export const metadata = {
metadataBase: new URL('http://trailingslash.com'),
alternates: {
canonical: './',
},
}
...@@ -19,9 +19,22 @@ createNextDescribe( ...@@ -19,9 +19,22 @@ createNextDescribe(
it('should render link with trailing slash', async () => { it('should render link with trailing slash', async () => {
const $ = await next.render$('/') const $ = await next.render$('/')
expect($('#to-a-trailing-slash').attr('href')).toBe('/a/') expect($('#to-a-trailing-slash').attr('href')).toBe('/a/')
}) })
it('should contain trailing slash to canonical url', async () => {
const $ = await next.render$('/')
expect($(`link[rel="canonical"]`).attr('href')).toBe(
'http://trailingslash.com/'
)
const $a = await next.render$('/a')
expect($a(`link[rel="canonical"]`).attr('href')).toBe(
'http://trailingslash.com/a/'
)
})
it('should redirect route when requesting it directly by browser', async () => { it('should redirect route when requesting it directly by browser', async () => {
const browser = await next.browser('/a') const browser = await next.browser('/a')
expect(await browser.waitForElementByCss('#a-page').text()).toBe('A page') expect(await browser.waitForElementByCss('#a-page').text()).toBe('A page')
......
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