Unverified Commit 628bc4c0 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Allow setting metadataBase for metadata (#45719)

## Feature

For property that needs to be resolved as URL, compose with
`metadataBase` if it's provided

Closes NEXT-398

### Detail updates

* fix issue that path having extra `/` in the middle for pages path
under app dir
* don't render Meta if value is empty string, e.g. `og:title` can be
`''` from value of `title.absolute`
* did some refactor to separate resolvers into different files
* add some unit tests for resolve urls

- [x] Implements an existing feature request or RFC. Make sure the
feature request has been accepted for implementation before opening a
PR.
- [x] Related issues linked using `fixes #number`
- [x]
[e2e](https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have a helpful link attached, see
[`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md)

---------
Co-authored-by: 's avatarShu Ding <g@shud.in>
parent d726fe30
...@@ -20,7 +20,9 @@ export const createDefaultMetadata = (): ResolvedMetadata => { ...@@ -20,7 +20,9 @@ export const createDefaultMetadata = (): ResolvedMetadata => {
robots: null, robots: null,
alternates: { alternates: {
canonical: null, canonical: null,
languages: {}, languages: null,
media: null,
types: null,
}, },
icons: null, icons: null,
openGraph: null, openGraph: null,
......
...@@ -9,7 +9,7 @@ export function Meta({ ...@@ -9,7 +9,7 @@ export function Meta({
property?: string property?: string
content: string | number | URL | null | undefined content: string | number | URL | null | undefined
}): React.ReactElement | null { }): React.ReactElement | null {
if (typeof content !== 'undefined' && content !== null) { if (typeof content !== 'undefined' && content !== null && content !== '') {
return ( return (
<meta <meta
{...(name ? { name } : { property })} {...(name ? { name } : { property })}
......
import React from 'react'
const MetadataContext = (React as any).createServerContext(null)
if (process.env.NODE_ENV !== 'production') {
MetadataContext.displayName = 'MetadataContext'
}
export function useMetadataBase() {
return React.useContext(MetadataContext)
}
export default MetadataContext
...@@ -3,18 +3,10 @@ import type { ...@@ -3,18 +3,10 @@ import type {
ResolvedMetadata, ResolvedMetadata,
ResolvingMetadata, ResolvingMetadata,
} from './types/metadata-interface' } from './types/metadata-interface'
import type { Viewport } from './types/extra-types' import type { AbsoluteTemplateString } from './types/metadata-types'
import type { ResolvedTwitterMetadata } from './types/twitter-types'
import type {
AbsoluteTemplateString,
Icon,
IconDescriptor,
Icons,
ResolvedVerification,
} from './types/metadata-types'
import { createDefaultMetadata } from './default-metadata' import { createDefaultMetadata } from './default-metadata'
import { resolveOpenGraph } from './resolve-opengraph' import { resolveOpenGraph, resolveTwitter } from './resolvers/resolve-opengraph'
import { mergeTitle } from './resolve-title' import { mergeTitle } from './resolvers/resolve-title'
import { resolveAsArrayOrUndefined } from './generate/utils' import { resolveAsArrayOrUndefined } from './generate/utils'
import { isClientReference } from '../../build/is-client-reference' import { isClientReference } from '../../build/is-client-reference'
import { import {
...@@ -23,214 +15,15 @@ import { ...@@ -23,214 +15,15 @@ import {
} from '../../server/lib/app-dir-module' } from '../../server/lib/app-dir-module'
import { ComponentsType } from '../../build/webpack/loaders/next-app-loader' import { ComponentsType } from '../../build/webpack/loaders/next-app-loader'
import { interopDefault } from '../interop-default' import { interopDefault } from '../interop-default'
import {
type FieldResolver<Key extends keyof Metadata> = ( resolveAlternates,
T: Metadata[Key] resolveAppleWebApp,
) => ResolvedMetadata[Key] resolveAppLinks,
resolveRobots,
const viewPortKeys = { resolveVerification,
width: 'width', resolveViewport,
height: 'height', } from './resolvers/resolve-basics'
initialScale: 'initial-scale', import { resolveIcons } from './resolvers/resolve-icons'
minimumScale: 'minimum-scale',
maximumScale: 'maximum-scale',
viewportFit: 'viewport-fit',
} as const
const resolveViewport: FieldResolver<'viewport'> = (viewport) => {
let resolved: ResolvedMetadata['viewport'] = null
if (typeof viewport === 'string') {
resolved = viewport
} else if (viewport) {
resolved = ''
for (const viewportKey_ in viewPortKeys) {
const viewportKey = viewportKey_ as keyof Viewport
if (viewport[viewportKey]) {
if (resolved) resolved += ', '
resolved += `${viewPortKeys[viewportKey]}=${viewport[viewportKey]}`
}
}
}
return resolved
}
const VerificationKeys = ['google', 'yahoo', 'yandex', 'me', 'other'] as const
const resolveVerification: FieldResolver<'verification'> = (verification) => {
if (!verification) return null
const res = {} as ResolvedVerification
for (const key of VerificationKeys) {
const value = verification[key]
if (value) {
if (key === 'other') {
res.other = {}
for (const otherKey in verification.other) {
const otherValue = resolveAsArrayOrUndefined(
verification.other[otherKey]
)
if (otherValue) res.other[otherKey] = otherValue
}
} else res[key] = resolveAsArrayOrUndefined(value) as (string | number)[]
}
}
return res
}
function isStringOrURL(icon: any): icon is string | URL {
return typeof icon === 'string' || icon instanceof URL
}
function resolveIcon(icon: Icon): IconDescriptor {
if (isStringOrURL(icon)) return { url: icon }
else if (Array.isArray(icon)) return icon
return icon
}
const IconKeys = ['icon', 'shortcut', 'apple', 'other'] as (keyof Icons)[]
const TwitterBasicInfoKeys = [
'site',
'siteId',
'creator',
'creatorId',
'description',
] as const
const resolveIcons: FieldResolver<'icons'> = (icons) => {
if (!icons) {
return null
}
const resolved: ResolvedMetadata['icons'] = {}
if (Array.isArray(icons)) {
resolved.icon = icons.map(resolveIcon).filter(Boolean)
} else if (isStringOrURL(icons)) {
resolved.icon = [resolveIcon(icons)]
} else {
for (const key of IconKeys) {
const values = resolveAsArrayOrUndefined(icons[key])
if (values) resolved[key] = values.map(resolveIcon)
}
}
return resolved
}
const resolveAppleWebApp: FieldResolver<'appleWebApp'> = (appWebApp) => {
if (!appWebApp) return null
if (appWebApp === true) {
return {
capable: true,
}
}
const startupImages = resolveAsArrayOrUndefined(appWebApp.startupImage)?.map(
(item) => (typeof item === 'string' ? { url: item } : item)
)
return {
capable: 'capable' in appWebApp ? !!appWebApp.capable : true,
title: appWebApp.title || null,
startupImage: startupImages || null,
statusBarStyle: appWebApp.statusBarStyle || 'default',
}
}
const resolveTwitter: FieldResolver<'twitter'> = (twitter) => {
if (!twitter) return null
const resolved = {
title: twitter.title,
} as ResolvedTwitterMetadata
for (const infoKey of TwitterBasicInfoKeys) {
resolved[infoKey] = twitter[infoKey] || null
}
resolved.images = resolveAsArrayOrUndefined(twitter.images)?.map((item) => {
if (isStringOrURL(item))
return {
url: item.toString(),
}
else {
return {
url: item.url.toString(),
alt: item.alt,
}
}
})
if ('card' in twitter) {
resolved.card = twitter.card
switch (twitter.card) {
case 'player': {
// @ts-ignore
resolved.players = resolveAsArrayOrUndefined(twitter.players) || []
break
}
case 'app': {
// @ts-ignore
resolved.app = twitter.app || {}
break
}
default:
break
}
} else {
resolved.card = 'summary'
}
return resolved
}
const resolveAppLinks: FieldResolver<'appLinks'> = (appLinks) => {
if (!appLinks) return null
for (const key in appLinks) {
// @ts-ignore // TODO: type infer
appLinks[key] = resolveAsArrayOrUndefined(appLinks[key])
}
return appLinks as ResolvedMetadata['appLinks']
}
const robotsKeys = [
'noarchive',
'nosnippet',
'noimageindex',
'nocache',
'notranslate',
'indexifembedded',
'nositelinkssearchbox',
'unavailable_after',
'max-video-preview',
'max-image-preview',
'max-snippet',
] as const
const resolveRobotsValue: (robots: Metadata['robots']) => string | null = (
robots
) => {
if (!robots) return null
if (typeof robots === 'string') return robots
const values: string[] = []
if (robots.index) values.push('index')
else if (typeof robots.index === 'boolean') values.push('noindex')
if (robots.follow) values.push('follow')
else if (typeof robots.follow === 'boolean') values.push('nofollow')
for (const key of robotsKeys) {
const value = robots[key]
if (typeof value !== 'undefined' && value !== false) {
values.push(typeof value === 'boolean' ? key : `${key}:${value}`)
}
}
return values.join(', ')
}
const resolveRobots: FieldResolver<'robots'> = (robots) => {
if (!robots) return null
return {
basic: resolveRobotsValue(robots),
googleBot:
typeof robots !== 'string' ? resolveRobotsValue(robots.googleBot) : null,
}
}
// Merge the source metadata into the resolved target metadata. // Merge the source metadata into the resolved target metadata.
function merge( function merge(
...@@ -242,6 +35,7 @@ function merge( ...@@ -242,6 +35,7 @@ function merge(
twitter: string | null twitter: string | null
} }
) { ) {
const metadataBase = source.metadataBase || null
for (const key_ in source) { for (const key_ in source) {
const key = key_ as keyof Metadata const key = key_ as keyof Metadata
...@@ -253,19 +47,19 @@ function merge( ...@@ -253,19 +47,19 @@ function merge(
} }
break break
} }
case 'alternates': {
target.alternates = resolveAlternates(source.alternates, metadataBase)
break
}
case 'openGraph': { case 'openGraph': {
if (typeof source.openGraph !== 'undefined') { target.openGraph = resolveOpenGraph(source.openGraph, metadataBase)
target.openGraph = resolveOpenGraph(source.openGraph) if (target.openGraph) {
if (source.openGraph) { mergeTitle(target.openGraph, templateStrings.openGraph)
mergeTitle(target.openGraph, templateStrings.openGraph)
}
} else {
target.openGraph = null
} }
break break
} }
case 'twitter': { case 'twitter': {
target.twitter = resolveTwitter(source.twitter) target.twitter = resolveTwitter(source.twitter, metadataBase)
if (target.twitter) { if (target.twitter) {
mergeTitle(target.twitter, templateStrings.twitter) mergeTitle(target.twitter, templateStrings.twitter)
} }
...@@ -314,7 +108,6 @@ function merge( ...@@ -314,7 +108,6 @@ function merge(
case 'referrer': case 'referrer':
case 'colorScheme': case 'colorScheme':
case 'itunes': case 'itunes':
case 'alternates':
case 'formatDetection': case 'formatDetection':
// @ts-ignore TODO: support inferring // @ts-ignore TODO: support inferring
target[key] = source[key] || null target[key] = source[key] || null
...@@ -322,6 +115,9 @@ function merge( ...@@ -322,6 +115,9 @@ function merge(
case 'other': case 'other':
target.other = Object.assign({}, target.other, source.other) target.other = Object.assign({}, target.other, source.other)
break break
case 'metadataBase':
target.metadataBase = metadataBase
break
default: default:
break break
} }
......
import type { ResolvedAlternateURLs } from '../types/alternative-urls-types'
import type { Metadata, ResolvedMetadata } from '../types/metadata-interface'
import type { ResolvedVerification } from '../types/metadata-types'
import type {
FieldResolver,
FieldResolverWithMetadataBase,
} from '../types/resolvers'
import type { Viewport } from '../types/extra-types'
import { resolveAsArrayOrUndefined } from '../generate/utils'
import { resolveUrl, resolveUrlValuesOfObject } from './resolve-url'
const viewPortKeys = {
width: 'width',
height: 'height',
initialScale: 'initial-scale',
minimumScale: 'minimum-scale',
maximumScale: 'maximum-scale',
viewportFit: 'viewport-fit',
} as const
export const resolveViewport: FieldResolver<'viewport'> = (viewport) => {
let resolved: ResolvedMetadata['viewport'] = null
if (typeof viewport === 'string') {
resolved = viewport
} else if (viewport) {
resolved = ''
for (const viewportKey_ in viewPortKeys) {
const viewportKey = viewportKey_ as keyof Viewport
if (viewport[viewportKey]) {
if (resolved) resolved += ', '
resolved += `${viewPortKeys[viewportKey]}=${viewport[viewportKey]}`
}
}
}
return resolved
}
export const resolveAlternates: FieldResolverWithMetadataBase<'alternates'> = (
alternates,
metadataBase
) => {
if (!alternates) return null
const result: ResolvedAlternateURLs = {
canonical: resolveUrl(alternates.canonical, metadataBase),
languages: null,
media: null,
types: null,
}
const { languages, media, types } = alternates
result.languages = resolveUrlValuesOfObject(languages, metadataBase)
result.media = resolveUrlValuesOfObject(media, metadataBase)
result.types = resolveUrlValuesOfObject(types, metadataBase)
return result
}
const robotsKeys = [
'noarchive',
'nosnippet',
'noimageindex',
'nocache',
'notranslate',
'indexifembedded',
'nositelinkssearchbox',
'unavailable_after',
'max-video-preview',
'max-image-preview',
'max-snippet',
] as const
const resolveRobotsValue: (robots: Metadata['robots']) => string | null = (
robots
) => {
if (!robots) return null
if (typeof robots === 'string') return robots
const values: string[] = []
if (robots.index) values.push('index')
else if (typeof robots.index === 'boolean') values.push('noindex')
if (robots.follow) values.push('follow')
else if (typeof robots.follow === 'boolean') values.push('nofollow')
for (const key of robotsKeys) {
const value = robots[key]
if (typeof value !== 'undefined' && value !== false) {
values.push(typeof value === 'boolean' ? key : `${key}:${value}`)
}
}
return values.join(', ')
}
export const resolveRobots: FieldResolver<'robots'> = (robots) => {
if (!robots) return null
return {
basic: resolveRobotsValue(robots),
googleBot:
typeof robots !== 'string' ? resolveRobotsValue(robots.googleBot) : null,
}
}
const VerificationKeys = ['google', 'yahoo', 'yandex', 'me', 'other'] as const
export const resolveVerification: FieldResolver<'verification'> = (
verification
) => {
if (!verification) return null
const res: ResolvedVerification = {}
for (const key of VerificationKeys) {
const value = verification[key]
if (value) {
if (key === 'other') {
res.other = {}
for (const otherKey in verification.other) {
const otherValue = resolveAsArrayOrUndefined(
verification.other[otherKey]
)
if (otherValue) res.other[otherKey] = otherValue
}
} else res[key] = resolveAsArrayOrUndefined(value) as (string | number)[]
}
}
return res
}
export const resolveAppleWebApp: FieldResolver<'appleWebApp'> = (appWebApp) => {
if (!appWebApp) return null
if (appWebApp === true) {
return {
capable: true,
}
}
const startupImages = resolveAsArrayOrUndefined(appWebApp.startupImage)?.map(
(item) => (typeof item === 'string' ? { url: item } : item)
)
return {
capable: 'capable' in appWebApp ? !!appWebApp.capable : true,
title: appWebApp.title || null,
startupImage: startupImages || null,
statusBarStyle: appWebApp.statusBarStyle || 'default',
}
}
export const resolveAppLinks: FieldResolver<'appLinks'> = (appLinks) => {
if (!appLinks) return null
for (const key in appLinks) {
// @ts-ignore // TODO: type infer
appLinks[key] = resolveAsArrayOrUndefined(appLinks[key])
}
return appLinks as ResolvedMetadata['appLinks']
}
import type { ResolvedMetadata } from '../types/metadata-interface'
import type { Icon, IconDescriptor, Icons } from '../types/metadata-types'
import type { FieldResolver } from '../types/resolvers'
import { resolveAsArrayOrUndefined } from '../generate/utils'
import { isStringOrURL } from './resolve-url'
export function resolveIcon(icon: Icon): IconDescriptor {
if (isStringOrURL(icon)) return { url: icon }
else if (Array.isArray(icon)) return icon
return icon
}
const IconKeys = ['icon', 'shortcut', 'apple', 'other'] as (keyof Icons)[]
export const resolveIcons: FieldResolver<'icons'> = (icons) => {
if (!icons) {
return null
}
const resolved: ResolvedMetadata['icons'] = {}
if (Array.isArray(icons)) {
resolved.icon = icons.map(resolveIcon).filter(Boolean)
} else if (isStringOrURL(icons)) {
resolved.icon = [resolveIcon(icons)]
} else {
for (const key of IconKeys) {
const values = resolveAsArrayOrUndefined(icons[key])
if (values) resolved[key] = values.map(resolveIcon)
}
}
return resolved
}
import type { Metadata } from './types/metadata-interface' import type { Metadata, ResolvedMetadata } from '../types/metadata-interface'
import type { import type {
OpenGraphType, OpenGraphType,
OpenGraph, OpenGraph,
ResolvedOpenGraph, ResolvedOpenGraph,
} from './types/opengraph-types' } from '../types/opengraph-types'
import { resolveAsArrayOrUndefined } from './generate/utils' import type { FieldResolverWithMetadataBase } from '../types/resolvers'
import type { ResolvedTwitterMetadata } from '../types/twitter-types'
import { resolveAsArrayOrUndefined } from '../generate/utils'
import { isStringOrURL, resolveUrl } from './resolve-url'
const OgTypFields = { const OgTypFields = {
article: ['authors', 'tags'], article: ['authors', 'tags'],
...@@ -44,40 +47,87 @@ function getFieldsByOgType(ogType: OpenGraphType | undefined) { ...@@ -44,40 +47,87 @@ function getFieldsByOgType(ogType: OpenGraphType | undefined) {
} }
export function resolveOpenGraph( export function resolveOpenGraph(
openGraph: Metadata['openGraph'] openGraph: Metadata['openGraph'],
): ResolvedOpenGraph { metadataBase: ResolvedMetadata['metadataBase']
const url = openGraph ): ResolvedMetadata['openGraph'] {
? typeof openGraph.url === 'string' if (!openGraph) return null
? new URL(openGraph.url)
: openGraph.url
: undefined
// TODO: improve typing const url = resolveUrl(openGraph.url, metadataBase)
const resolved: { [x: string]: any } = openGraph || {} const resolved = { ...openGraph } as ResolvedOpenGraph
function assignProps(og: OpenGraph) { function assignProps(og: OpenGraph) {
const ogType = og && 'type' in og ? og.type : undefined const ogType = og && 'type' in og ? og.type : undefined
const keys = getFieldsByOgType(ogType) const keys = getFieldsByOgType(ogType)
for (const k of keys) { for (const k of keys) {
const key = k as keyof OpenGraph const key = k as keyof ResolvedOpenGraph
if (key in og) { if (key in og && key !== 'url') {
// TODO: fix typing inferring const value = og[key]
// @ts-ignore if (value) {
const value = resolveAsArrayOrUndefined(og[key]) const arrayValue = resolveAsArrayOrUndefined(value)
if (value != null) { /// TODO: improve typing inferring
;(resolved as any)[key] = value ;(resolved as any)[key] = arrayValue
} }
} }
} }
} }
if (openGraph) { assignProps(openGraph)
assignProps(openGraph)
} resolved.url = url
return resolved
}
const TwitterBasicInfoKeys = [
'site',
'siteId',
'creator',
'creatorId',
'description',
] as const
if (url) { export const resolveTwitter: FieldResolverWithMetadataBase<'twitter'> = (
resolved.url = url twitter,
metadataBase
) => {
if (!twitter) return null
const resolved = {
title: twitter.title,
} as ResolvedTwitterMetadata
for (const infoKey of TwitterBasicInfoKeys) {
resolved[infoKey] = twitter[infoKey] || null
}
resolved.images = resolveAsArrayOrUndefined(twitter.images)?.map((item) => {
if (isStringOrURL(item))
return {
url: resolveUrl(item, metadataBase),
}
else {
return {
url: resolveUrl(item.url, metadataBase),
alt: item.alt,
}
}
})
if ('card' in twitter) {
resolved.card = twitter.card
switch (twitter.card) {
case 'player': {
// @ts-ignore
resolved.players = resolveAsArrayOrUndefined(twitter.players) || []
break
}
case 'app': {
// @ts-ignore
resolved.app = twitter.app || {}
break
}
default:
break
}
} else {
resolved.card = 'summary'
} }
return resolved as ResolvedOpenGraph return resolved
} }
import type { Metadata } from './types/metadata-interface' import type { Metadata } from '../types/metadata-interface'
import type { AbsoluteTemplateString } from './types/metadata-types' import type { AbsoluteTemplateString } from '../types/metadata-types'
function resolveTitleTemplate(template: string | null, title: string) { function resolveTitleTemplate(template: string | null, title: string) {
return template ? template.replace(/%s/g, title) : title return template ? template.replace(/%s/g, title) : title
...@@ -31,11 +31,11 @@ export function mergeTitle<T extends { title?: Metadata['title'] }>( ...@@ -31,11 +31,11 @@ export function mergeTitle<T extends { title?: Metadata['title'] }>(
} }
const target = source const target = source
if (source.title && typeof source.title !== 'string') { if (title && typeof title !== 'string') {
const targetTitle = source.title as AbsoluteTemplateString const targetTitle = title as AbsoluteTemplateString
targetTitle.template = template targetTitle.template = template
targetTitle.absolute = resolved || '' targetTitle.absolute = resolved || ''
} else { } else {
target.title = { absolute: resolved || source.title || '', template } target.title = { absolute: resolved || title || '', template }
} }
} }
import { resolveUrl } from './resolve-url'
// required to be resolved as URL with resolveUrl()
describe('metadata: resolveUrl', () => {
it('should return null when url is falsy', () => {
expect(resolveUrl('', null)).toBe(null)
expect(resolveUrl(null, null)).toBe(null)
expect(resolveUrl(undefined, null)).toBe(null)
})
it('should error when metadataBase is not provided but url is not valid URL', () => {
expect(() => resolveUrl('/abc', null)).toThrow('missing metadataBase')
})
it('should return url itself when metadataBase is null or url is valid URL', () => {
expect(resolveUrl('https://example.com/abc', null)).toEqual(
new URL('https://example.com/abc')
)
expect(resolveUrl(new URL('https://example.com/def'), null)).toEqual(
new URL('https://example.com/def')
)
})
it('should compose with metadataBase when url is relative or absolute', () => {
const metadataBase = new URL('https://example.com/abc')
expect(resolveUrl('/def', metadataBase)).toEqual(
new URL('https://example.com/abc/def')
)
expect(resolveUrl('../def', metadataBase)).toEqual(
new URL('https://example.com/def')
)
expect(resolveUrl('foo', metadataBase)).toEqual(
new URL('https://example.com/abc/foo')
)
})
it('should ignore metadataBase when url is valid URL', () => {
const metadataBase = new URL('https://example.com/abc')
expect(resolveUrl('https://example.com/def', metadataBase)).toEqual(
new URL('https://example.com/def')
)
expect(resolveUrl(new URL('https://bar.com/ghi'), metadataBase)).toEqual(
new URL('https://bar.com/ghi')
)
})
})
import path from '../../../shared/lib/isomorphic/path'
import type { ResolvedMetadata } from '../types/metadata-interface'
function isStringOrURL(icon: any): icon is string | URL {
return typeof icon === 'string' || icon instanceof URL
}
function resolveUrl(
url: string | URL | null | undefined,
metadataBase: URL | null
): URL | null {
if (!url) return null
if (url instanceof URL) return url
try {
// If we can construct a URL instance from url, ignore metadataBase
const parsedUrl = new URL(url)
return parsedUrl
} catch (_) {}
if (!metadataBase) throw new Error('missing metadataBase')
// Handle relative or absolute paths
const basePath = metadataBase.pathname || '/'
const joinedPath = path.join(basePath, url)
return new URL(joinedPath, metadataBase)
}
function resolveUrlValuesOfObject(
obj: Record<string, string | URL | null> | null | undefined,
metadataBase: ResolvedMetadata['metadataBase']
): null | Record<string, URL | null> {
if (!obj) return null
const result: Record<string, URL | null> = {}
for (const [key, value] of Object.entries(obj)) {
result[key as keyof typeof obj] = resolveUrl(value, metadataBase)
}
return result
}
export { isStringOrURL, resolveUrl, resolveUrlValuesOfObject }
...@@ -251,11 +251,11 @@ export type AlternateURLs = { ...@@ -251,11 +251,11 @@ export type AlternateURLs = {
export type ResolvedAlternateURLs = { export type ResolvedAlternateURLs = {
canonical: null | URL canonical: null | URL
languages: Languages<null | URL> languages: null | Languages<null | URL>
media?: { media: null | {
[media: string]: null | URL [media: string]: null | URL
} }
types?: { types: null | {
[types: string]: null | URL [types: string]: null | URL
} }
} }
...@@ -174,7 +174,7 @@ type ResolvedOpenGraphMetadata = { ...@@ -174,7 +174,7 @@ type ResolvedOpenGraphMetadata = {
images?: Array<OGImage> images?: Array<OGImage>
audio?: Array<OGAudio> audio?: Array<OGAudio>
videos?: Array<OGVideo> videos?: Array<OGVideo>
url?: URL url: null | URL
countryName?: string countryName?: string
ttl?: number ttl?: number
} }
......
import { Metadata, ResolvedMetadata } from './metadata-interface'
export type FieldResolver<Key extends keyof Metadata> = (
T: Metadata[Key]
) => ResolvedMetadata[Key]
export type FieldResolverWithMetadataBase<Key extends keyof Metadata> = (
T: Metadata[Key],
metadataBase: ResolvedMetadata['metadataBase']
) => ResolvedMetadata[Key]
...@@ -64,7 +64,7 @@ type TwitterPlayerDescriptor = { ...@@ -64,7 +64,7 @@ type TwitterPlayerDescriptor = {
} }
type ResolvedTwitterImage = { type ResolvedTwitterImage = {
url: string url: null | URL
alt?: string alt?: string
} }
type ResolvedTwitterSummary = { type ResolvedTwitterSummary = {
......
export default function layout({ children }) {
return children
}
export const metadata = {
metadataBase: new URL('https://example.com/base'),
}
export default function page() {
return 'url'
}
export const metadata = {
metadataBase: new URL('https://example.com/foo'),
openGraph: {
url: new URL('http://https://outerspace.com/huozhi.png'),
},
}
export default function page() {
return 'url'
}
export const metadata = {
metadataBase: new URL('https://bar.example/url'),
alternates: {
canonical: 'subpath',
},
}
...@@ -190,7 +190,7 @@ createNextDescribe( ...@@ -190,7 +190,7 @@ createNextDescribe(
it('should support alternate tags', async () => { it('should support alternate tags', async () => {
const browser = await next.browser('/alternate') const browser = await next.browser('/alternate')
await checkLink(browser, 'canonical', 'https://example.com') await checkLink(browser, 'canonical', 'https://example.com/')
await checkMeta( await checkMeta(
browser, browser,
'en-US', 'en-US',
...@@ -321,6 +321,22 @@ createNextDescribe( ...@@ -321,6 +321,22 @@ createNextDescribe(
const browser = await next.browser('/basic/sync-generate-metadata') const browser = await next.browser('/basic/sync-generate-metadata')
expect(await getTitle(browser)).toBe('synchronous generateMetadata') expect(await getTitle(browser)).toBe('synchronous generateMetadata')
}) })
it('should handle metadataBase for urls resolved as only URL type', async () => {
// including few urls in opengraph and alternates
const url$ = await next.render$('/metadata-base/url')
// compose with metadataBase
expect(url$('link[rel="canonical"]').attr('href')).toBe(
'https://bar.example/url/subpath'
)
// override metadataBase
const urlInstance$ = await next.render$('/metadata-base/url-instance')
expect(urlInstance$('meta[property="og:url"]').attr('content')).toBe(
'http://https//outerspace.com/huozhi.png'
)
})
}) })
describe('opengraph', () => { describe('opengraph', () => {
......
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