Unverified Commit a7fd95e3 authored by runjuu's avatar runjuu Committed by GitHub

Fix unexpected object mutation while resolving Open Graph (#49514)

Modifying an object passed from external sources can unintentionally
lead to unpredictable behavior.

By changing the implementation from in-place object modification to
returning a new object, we can make the method more predictable.

fixes #49501

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation or adding/fixing Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

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



## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->

link NEXT-1121

---------
Co-authored-by: 's avatarJiachi Liu <inbox@huozhi.im>
Co-authored-by: 's avatarTobias Koppers <tobias.koppers@googlemail.com>
parent 428342db
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' }])
})
})
...@@ -29,32 +29,33 @@ const OgTypeFields = { ...@@ -29,32 +29,33 @@ const OgTypeFields = {
], ],
} as const } as const
function resolveImages( export function resolveImages(
images: Twitter['images'], images: Twitter['images'],
metadataBase: ResolvedMetadata['metadataBase'] metadataBase: ResolvedMetadata['metadataBase']
): NonNullable<ResolvedMetadata['twitter']>['images'] ): NonNullable<ResolvedMetadata['twitter']>['images']
function resolveImages( export function resolveImages(
images: OpenGraph['images'], images: OpenGraph['images'],
metadataBase: ResolvedMetadata['metadataBase'] metadataBase: ResolvedMetadata['metadataBase']
): NonNullable<ResolvedMetadata['openGraph']>['images'] ): NonNullable<ResolvedMetadata['openGraph']>['images']
function resolveImages( export function resolveImages(
images: OpenGraph['images'] | Twitter['images'], images: OpenGraph['images'] | Twitter['images'],
metadataBase: ResolvedMetadata['metadataBase'] metadataBase: ResolvedMetadata['metadataBase']
): ):
| NonNullable<ResolvedMetadata['twitter']>['images'] | NonNullable<ResolvedMetadata['twitter']>['images']
| NonNullable<ResolvedMetadata['openGraph']>['images'] { | NonNullable<ResolvedMetadata['openGraph']>['images'] {
const resolvedImages = resolveAsArrayOrUndefined(images) return resolveAsArrayOrUndefined(images)?.map((item) => {
resolvedImages?.forEach((item, index, array) => {
if (isStringOrURL(item)) { if (isStringOrURL(item)) {
array[index] = { return {
url: resolveUrl(item, metadataBase)!, url: resolveUrl(item, metadataBase)!,
} }
} else { } else {
return {
...item,
// Update image descriptor url // Update image descriptor url
item.url = resolveUrl(item.url, metadataBase)! url: resolveUrl(item.url, metadataBase)!,
}
} }
}) })
return resolvedImages
} }
function getFieldsByOgType(ogType: OpenGraphType | undefined) { function getFieldsByOgType(ogType: OpenGraphType | 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