Unverified Commit 2f42cf55 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Filter invalid image descriptor from metadata images (#51992)

Filter out the invalid images in metadata og/twitter `images` filter to avoid crash when falsy image slides in.
Add filtering for now as the erroring doesn't show the proper trace pointing to where it's original introduced, might introduce other validation in the future.
parent efdc026a
...@@ -20,4 +20,19 @@ describe('resolveImages', () => { ...@@ -20,4 +20,19 @@ describe('resolveImages', () => {
expect(images).toEqual([image1, { url: image2, alt: 'Image2' }]) expect(images).toEqual([image1, { url: image2, alt: 'Image2' }])
}) })
it('should filter out invalid images', () => {
const images = [
image1,
{ url: image2, alt: 'Image2' },
{ alt: 'Image3' },
undefined,
]
// @ts-expect-error
expect(resolveImages(images, null)).toEqual([
{ url: new URL(image1) },
{ url: new URL(image2), alt: 'Image2' },
])
})
}) })
...@@ -47,19 +47,29 @@ export function resolveImages( ...@@ -47,19 +47,29 @@ export function resolveImages(
): ):
| NonNullable<ResolvedMetadata['twitter']>['images'] | NonNullable<ResolvedMetadata['twitter']>['images']
| NonNullable<ResolvedMetadata['openGraph']>['images'] { | NonNullable<ResolvedMetadata['openGraph']>['images'] {
return resolveAsArrayOrUndefined(images)?.map((item) => { const resolvedImages = resolveAsArrayOrUndefined(images)
if (isStringOrURL(item)) { if (!resolvedImages) return resolvedImages
return {
url: resolveUrl(item, metadataBase)!, const nonNullableImages = []
} for (const item of resolvedImages) {
} else { const isItemUrl = isStringOrURL(item)
return { const inputUrl = isItemUrl ? item : item.url
...item, if (!inputUrl) continue
// Update image descriptor url
url: resolveUrl(item.url, metadataBase)!, nonNullableImages.push(
} isItemUrl
} ? {
}) url: resolveUrl(item, metadataBase),
}
: {
...item,
// Update image descriptor url
url: resolveUrl(item.url, metadataBase),
}
)
}
return nonNullableImages
} }
function getFieldsByOgType(ogType: OpenGraphType | undefined) { function getFieldsByOgType(ogType: OpenGraphType | undefined) {
......
export default function Page() {
return 'opengraph-article'
}
export const metadata = {
openGraph: {
images: [{ url: undefined }],
},
}
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