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

Support relative url for openGraph.url and itunes.appArgument (#51877)

To enable the ability of leveraging current `pathname` and configured `metadataBase` for other canonical like urls, we support those urls with auto resolving with `pathename` and `metadataBase` like canonical url, then you could just configure relative paths like below

```js
openGraph: {
    url: './abc', // will be resolved based on pathname and metadata base
},
itunes: {
   appId: 'my-app-id'
   appArgument: './native-app'
}
```


Fixes #51829
Closes NEXT-1302
parent a54d08bd
...@@ -59,6 +59,27 @@ describe('accumulateMetadata', () => { ...@@ -59,6 +59,27 @@ describe('accumulateMetadata', () => {
}) })
}) })
describe('itunes', () => {
it('should resolve relative url starting with ./ with pathname for itunes.appArgument', async () => {
const metadataItems: MetadataItems = [
[
{
metadataBase: new URL('http://test.com/base'),
itunes: { appId: 'id', appArgument: './native/app' },
},
null,
],
]
const metadata = await accumulateMetadata(metadataItems)
expect(metadata).toMatchObject({
metadataBase: new URL('http://test.com/base'),
itunes: {
appArgument: new URL('http://test.com/base/test/native/app'),
},
})
})
})
describe('openGraph', () => { describe('openGraph', () => {
it('should convert string or URL images field to array, not only for basic og type', async () => { it('should convert string or URL images field to array, not only for basic og type', async () => {
const items: [Metadata[], Metadata][] = [ const items: [Metadata[], Metadata][] = [
...@@ -155,6 +176,27 @@ describe('accumulateMetadata', () => { ...@@ -155,6 +176,27 @@ describe('accumulateMetadata', () => {
}, },
}) })
}) })
it('should resolve relative url starting with ./ with pathname for openGraph.url', async () => {
const metadataItems: MetadataItems = [
[
{
metadataBase: new URL('http://test.com/base'),
openGraph: {
url: './abc',
},
},
null,
],
]
const metadata = await accumulateMetadata(metadataItems)
expect(metadata).toMatchObject({
metadataBase: new URL('http://test.com/base'),
openGraph: {
url: new URL('http://test.com/base/test/abc'),
},
})
})
}) })
describe('themeColor', () => { describe('themeColor', () => {
......
...@@ -5,6 +5,10 @@ import type { ...@@ -5,6 +5,10 @@ import type {
} from './types/metadata-interface' } from './types/metadata-interface'
import type { MetadataImageModule } from '../../build/webpack/loaders/metadata/types' import type { MetadataImageModule } from '../../build/webpack/loaders/metadata/types'
import type { GetDynamicParamFromSegment } from '../../server/app-render/app-render' import type { GetDynamicParamFromSegment } from '../../server/app-render/app-render'
import type { Twitter } from './types/twitter-types'
import type { OpenGraph } from './types/opengraph-types'
import type { ComponentsType } from '../../build/webpack/loaders/next-app-loader'
import type { MetadataAccumulationOptions } from './types/resolvers'
import { createDefaultMetadata } from './default-metadata' import { createDefaultMetadata } from './default-metadata'
import { resolveOpenGraph, resolveTwitter } from './resolvers/resolve-opengraph' import { resolveOpenGraph, resolveTwitter } from './resolvers/resolve-opengraph'
import { resolveTitle } from './resolvers/resolve-title' import { resolveTitle } from './resolvers/resolve-title'
...@@ -14,7 +18,6 @@ import { ...@@ -14,7 +18,6 @@ import {
getLayoutOrPageModule, getLayoutOrPageModule,
LoaderTree, LoaderTree,
} from '../../server/lib/app-dir-module' } from '../../server/lib/app-dir-module'
import { ComponentsType } from '../../build/webpack/loaders/next-app-loader'
import { interopDefault } from '../interop-default' import { interopDefault } from '../interop-default'
import { import {
resolveAlternates, resolveAlternates,
...@@ -24,12 +27,11 @@ import { ...@@ -24,12 +27,11 @@ import {
resolveThemeColor, resolveThemeColor,
resolveVerification, resolveVerification,
resolveViewport, resolveViewport,
resolveItunes,
} from './resolvers/resolve-basics' } from './resolvers/resolve-basics'
import { resolveIcons } from './resolvers/resolve-icons' import { resolveIcons } from './resolvers/resolve-icons'
import { getTracer } from '../../server/lib/trace/tracer' import { getTracer } from '../../server/lib/trace/tracer'
import { ResolveMetadataSpan } from '../../server/lib/trace/constants' import { ResolveMetadataSpan } from '../../server/lib/trace/constants'
import { Twitter } from './types/twitter-types'
import { OpenGraph } from './types/opengraph-types'
import { PAGE_SEGMENT_KEY } from '../../shared/lib/constants' import { PAGE_SEGMENT_KEY } from '../../shared/lib/constants'
type StaticMetadata = Awaited<ReturnType<typeof resolveStaticMetadata>> type StaticMetadata = Awaited<ReturnType<typeof resolveStaticMetadata>>
...@@ -42,13 +44,10 @@ export type MetadataItems = [ ...@@ -42,13 +44,10 @@ export type MetadataItems = [
StaticMetadata StaticMetadata
][] ][]
type MetadataAccumulationOptions = {
pathname: string
}
function mergeStaticMetadata( function mergeStaticMetadata(
metadata: ResolvedMetadata, metadata: ResolvedMetadata,
staticFilesMetadata: StaticMetadata staticFilesMetadata: StaticMetadata,
{ pathname }: MetadataAccumulationOptions
) { ) {
if (!staticFilesMetadata) return if (!staticFilesMetadata) return
const { icon, apple, openGraph, twitter, manifest } = staticFilesMetadata const { icon, apple, openGraph, twitter, manifest } = staticFilesMetadata
...@@ -69,7 +68,8 @@ function mergeStaticMetadata( ...@@ -69,7 +68,8 @@ function mergeStaticMetadata(
if (openGraph) { if (openGraph) {
const resolvedOpenGraph = resolveOpenGraph( const resolvedOpenGraph = resolveOpenGraph(
{ ...metadata.openGraph, images: openGraph } as OpenGraph, { ...metadata.openGraph, images: openGraph } as OpenGraph,
metadata.metadataBase metadata.metadataBase,
{ pathname }
) )
metadata.openGraph = resolvedOpenGraph metadata.openGraph = resolvedOpenGraph
} }
...@@ -112,13 +112,19 @@ function merge({ ...@@ -112,13 +112,19 @@ function merge({
break break
} }
case 'alternates': { case 'alternates': {
target.alternates = resolveAlternates(source.alternates, metadataBase, { target.alternates = resolveAlternates(
pathname: options.pathname, source.alternates,
}) metadataBase,
options
)
break break
} }
case 'openGraph': { case 'openGraph': {
target.openGraph = resolveOpenGraph(source.openGraph, metadataBase) target.openGraph = resolveOpenGraph(
source.openGraph,
metadataBase,
options
)
if (target.openGraph) { if (target.openGraph) {
target.openGraph.title = resolveTitle( target.openGraph.title = resolveTitle(
target.openGraph.title, target.openGraph.title,
...@@ -173,6 +179,10 @@ function merge({ ...@@ -173,6 +179,10 @@ function merge({
target[key] = resolveAsArrayOrUndefined(source.authors) target[key] = resolveAsArrayOrUndefined(source.authors)
break break
} }
case 'itunes': {
target[key] = resolveItunes(source.itunes, metadataBase, options)
break
}
// directly assign fields that fallback to null // directly assign fields that fallback to null
case 'applicationName': case 'applicationName':
case 'description': case 'description':
...@@ -183,7 +193,6 @@ function merge({ ...@@ -183,7 +193,6 @@ function merge({
case 'classification': case 'classification':
case 'referrer': case 'referrer':
case 'colorScheme': case 'colorScheme':
case 'itunes':
case 'formatDetection': case 'formatDetection':
case 'manifest': case 'manifest':
// @ts-ignore TODO: support inferring // @ts-ignore TODO: support inferring
...@@ -199,7 +208,7 @@ function merge({ ...@@ -199,7 +208,7 @@ function merge({
break break
} }
} }
mergeStaticMetadata(target, staticFilesMetadata) mergeStaticMetadata(target, staticFilesMetadata, options)
} }
async function getDefinedMetadata( async function getDefinedMetadata(
......
...@@ -7,28 +7,24 @@ import type { ResolvedVerification } from '../types/metadata-types' ...@@ -7,28 +7,24 @@ import type { ResolvedVerification } from '../types/metadata-types'
import type { import type {
FieldResolver, FieldResolver,
FieldResolverWithMetadataBase, FieldResolverWithMetadataBase,
MetadataAccumulationOptions,
} from '../types/resolvers' } from '../types/resolvers'
import type { Viewport } from '../types/extra-types' import type { Viewport } from '../types/extra-types'
import path from '../../../shared/lib/isomorphic/path'
import { resolveAsArrayOrUndefined } from '../generate/utils' import { resolveAsArrayOrUndefined } from '../generate/utils'
import { resolveUrl } from './resolve-url' import { resolveAbsoluteUrlWithPathname } from './resolve-url'
import { ViewPortKeys } from '../constants' import { ViewPortKeys } from '../constants'
// Resolve with `metadataBase` if it's present, otherwise resolve with `pathname`.
// Resolve with `pathname` if `url` is a relative path.
function resolveAlternateUrl( function resolveAlternateUrl(
url: string | URL, url: string | URL,
metadataBase: URL | null, metadataBase: URL | null,
pathname: string pathname: string
) { ) {
if (typeof url === 'string' && url.startsWith('./')) { // If alter native url is an URL instance,
url = path.resolve(pathname, url) // we treat it as a URL base and resolve with current pathname
} else if (url instanceof URL) { if (url instanceof URL) {
url = new URL(pathname, url) url = new URL(pathname, url)
} }
return resolveAbsoluteUrlWithPathname(url, metadataBase, pathname)
const result = metadataBase ? resolveUrl(url, metadataBase) : url
return result.toString()
} }
export const resolveThemeColor: FieldResolver<'themeColor'> = (themeColor) => { export const resolveThemeColor: FieldResolver<'themeColor'> = (themeColor) => {
...@@ -120,7 +116,7 @@ function resolveCanonicalUrl( ...@@ -120,7 +116,7 @@ function resolveCanonicalUrl(
export const resolveAlternates: FieldResolverWithMetadataBase< export const resolveAlternates: FieldResolverWithMetadataBase<
'alternates', 'alternates',
{ pathname: string } MetadataAccumulationOptions
> = (alternates, metadataBase, { pathname }) => { > = (alternates, metadataBase, { pathname }) => {
if (!alternates) return null if (!alternates) return null
...@@ -255,3 +251,16 @@ export const resolveAppLinks: FieldResolver<'appLinks'> = (appLinks) => { ...@@ -255,3 +251,16 @@ export const resolveAppLinks: FieldResolver<'appLinks'> = (appLinks) => {
} }
return appLinks as ResolvedMetadata['appLinks'] return appLinks as ResolvedMetadata['appLinks']
} }
export const resolveItunes: FieldResolverWithMetadataBase<
'itunes',
MetadataAccumulationOptions
> = (itunes, metadataBase, { pathname }) => {
if (!itunes) return null
return {
appId: itunes.appId,
appArgument: itunes.appArgument
? resolveAlternateUrl(itunes.appArgument, metadataBase, pathname)
: undefined,
}
}
...@@ -4,13 +4,17 @@ import type { ...@@ -4,13 +4,17 @@ import type {
OpenGraph, OpenGraph,
ResolvedOpenGraph, ResolvedOpenGraph,
} from '../types/opengraph-types' } from '../types/opengraph-types'
import type { FieldResolverWithMetadataBase } from '../types/resolvers' import type {
FieldResolverWithMetadataBase,
MetadataAccumulationOptions,
} from '../types/resolvers'
import type { ResolvedTwitterMetadata, Twitter } from '../types/twitter-types' import type { ResolvedTwitterMetadata, Twitter } from '../types/twitter-types'
import { resolveAsArrayOrUndefined } from '../generate/utils' import { resolveAsArrayOrUndefined } from '../generate/utils'
import { import {
getSocialImageFallbackMetadataBase, getSocialImageFallbackMetadataBase,
isStringOrURL, isStringOrURL,
resolveUrl, resolveUrl,
resolveAbsoluteUrlWithPathname,
} from './resolve-url' } from './resolve-url'
const OgTypeFields = { const OgTypeFields = {
...@@ -78,13 +82,16 @@ function getFieldsByOgType(ogType: OpenGraphType | undefined) { ...@@ -78,13 +82,16 @@ function getFieldsByOgType(ogType: OpenGraphType | undefined) {
} }
} }
export const resolveOpenGraph: FieldResolverWithMetadataBase<'openGraph'> = ( export const resolveOpenGraph: FieldResolverWithMetadataBase<
'openGraph',
MetadataAccumulationOptions
> = (
openGraph: Metadata['openGraph'], openGraph: Metadata['openGraph'],
metadataBase: ResolvedMetadata['metadataBase'] metadataBase: ResolvedMetadata['metadataBase'],
{ pathname }
) => { ) => {
if (!openGraph) return null if (!openGraph) return null
const url = resolveUrl(openGraph.url, metadataBase)
const resolved = { ...openGraph } as ResolvedOpenGraph const resolved = { ...openGraph } as ResolvedOpenGraph
function assignProps(og: OpenGraph) { function assignProps(og: OpenGraph) {
...@@ -108,7 +115,9 @@ export const resolveOpenGraph: FieldResolverWithMetadataBase<'openGraph'> = ( ...@@ -108,7 +115,9 @@ export const resolveOpenGraph: FieldResolverWithMetadataBase<'openGraph'> = (
assignProps(openGraph) assignProps(openGraph)
resolved.url = url resolved.url = openGraph.url
? resolveAbsoluteUrlWithPathname(openGraph.url, metadataBase, pathname)
: null
return resolved return resolved
} }
......
...@@ -70,4 +70,29 @@ function resolveUrl( ...@@ -70,4 +70,29 @@ function resolveUrl(
return new URL(joinedPath, metadataBase) return new URL(joinedPath, metadataBase)
} }
export { isStringOrURL, resolveUrl } // Resolve with `pathname` if `url` is a relative path.
function resolveRelativeUrl(url: string | URL, pathname: string): string | URL {
if (typeof url === 'string' && url.startsWith('./')) {
return path.resolve(pathname, url)
}
return url
}
// Resolve `pathname` if `url` is a relative path the compose with `metadataBase`.
function resolveAbsoluteUrlWithPathname(
url: string | URL,
metadataBase: URL | null,
pathname: string
) {
url = resolveRelativeUrl(url, pathname)
const result = metadataBase ? resolveUrl(url, metadataBase) : url
return result.toString()
}
export {
isStringOrURL,
resolveUrl,
resolveRelativeUrl,
resolveAbsoluteUrlWithPathname,
}
...@@ -16,3 +16,7 @@ export type FieldResolverWithMetadataBase< ...@@ -16,3 +16,7 @@ export type FieldResolverWithMetadataBase<
metadataBase: ResolvedMetadata['metadataBase'], metadataBase: ResolvedMetadata['metadataBase'],
options: Options options: Options
) => ResolvedMetadata[Key] ) => ResolvedMetadata[Key]
export type MetadataAccumulationOptions = {
pathname: string
}
...@@ -5,6 +5,6 @@ export default function page() { ...@@ -5,6 +5,6 @@ export default function page() {
export const metadata = { export const metadata = {
metadataBase: new URL('https://example.com/foo'), metadataBase: new URL('https://example.com/foo'),
openGraph: { openGraph: {
url: new URL('http://https://outerspace.com/huozhi.png'), url: new URL('https://outerspace.com/huozhi.png'),
}, },
} }
...@@ -476,7 +476,7 @@ createNextDescribe( ...@@ -476,7 +476,7 @@ createNextDescribe(
// override metadataBase // override metadataBase
const urlInstance$ = await next.render$('/metadata-base/url-instance') const urlInstance$ = await next.render$('/metadata-base/url-instance')
expect(urlInstance$('meta[property="og:url"]').attr('content')).toBe( expect(urlInstance$('meta[property="og:url"]').attr('content')).toBe(
'http://https//outerspace.com/huozhi.png' 'https://outerspace.com/huozhi.png'
) )
}) })
}) })
......
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