Skip to content

Commit

Permalink
Fix unexpected object mutation while resolving Open Graph (#49514)
Browse files Browse the repository at this point in the history
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: Jiachi Liu <inbox@huozhi.im>
Co-authored-by: Tobias Koppers <tobias.koppers@googlemail.com>
  • Loading branch information
3 people committed May 10, 2023
1 parent 428342d commit a7fd95e
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 9 deletions.
23 changes: 23 additions & 0 deletions packages/next/src/lib/metadata/resolvers/resolve-opengraph.test.ts
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

0 comments on commit a7fd95e

Please sign in to comment.