Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix unexpected object mutation while resolving Open Graph #49514

Merged
merged 5 commits into from
May 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import { resolveImages } from './resolve-opengraph'

describe('resolveImages', () => {
const image1 = 'https://www.example.com/image1.jpg'
const image2 = 'https://www.example.com/image2.jpg'

it(`should resolve images`, () => {
const images = [image1, { url: image2, alt: 'Image2' }]

expect(resolveImages(images, null)).toEqual([
{ url: new URL(image1) },
{ url: new URL(image2), alt: 'Image2' },
])
})

it('should not mutate passed images', () => {
const images = [image1, { url: image2, alt: 'Image2' }]

resolveImages(images, null)

expect(images).toEqual([image1, { url: image2, alt: 'Image2' }])
})
})
19 changes: 10 additions & 9 deletions packages/next/src/lib/metadata/resolvers/resolve-opengraph.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,32 +29,33 @@ const OgTypeFields = {
],
} as const

function resolveImages(
export function resolveImages(
images: Twitter['images'],
metadataBase: ResolvedMetadata['metadataBase']
): NonNullable<ResolvedMetadata['twitter']>['images']
function resolveImages(
export function resolveImages(
images: OpenGraph['images'],
metadataBase: ResolvedMetadata['metadataBase']
): NonNullable<ResolvedMetadata['openGraph']>['images']
function resolveImages(
export function resolveImages(
images: OpenGraph['images'] | Twitter['images'],
metadataBase: ResolvedMetadata['metadataBase']
):
| NonNullable<ResolvedMetadata['twitter']>['images']
| NonNullable<ResolvedMetadata['openGraph']>['images'] {
const resolvedImages = resolveAsArrayOrUndefined(images)
resolvedImages?.forEach((item, index, array) => {
return resolveAsArrayOrUndefined(images)?.map((item) => {
if (isStringOrURL(item)) {
array[index] = {
return {
url: resolveUrl(item, metadataBase)!,
}
} else {
// Update image descriptor url
item.url = resolveUrl(item.url, metadataBase)!
return {
...item,
// Update image descriptor url
url: resolveUrl(item.url, metadataBase)!,
}
}
})
return resolvedImages
}

function getFieldsByOgType(ogType: OpenGraphType | undefined) {
Expand Down