Skip to content

Commit

Permalink
Ensure metadata test is not affected by other tests (#51973)
Browse files Browse the repository at this point in the history
Turn out the `should error when id is missing in generateSitemaps` test
was passing because of this test passing: `should error when id is
missing in generateImageMetadata`

<!-- 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

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating 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 #

-->

---------

Co-authored-by: Jiachi Liu <inbox@huozhi.im>
  • Loading branch information
timneutkens and huozhi committed Jun 29, 2023
1 parent c897933 commit 3773c5b
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 16 deletions.
Expand Up @@ -115,7 +115,7 @@ export async function GET(_, ctx) {
id = imageMetadata.find((item) => {
if (process.env.NODE_ENV !== 'production') {
if (item?.id == null) {
throw new Error('id is required for every item returned from generateImageMetadata')
throw new Error('id property is required for every item returned from generateImageMetadata')
}
}
return item.id.toString() === targetId
Expand Down
50 changes: 35 additions & 15 deletions test/e2e/app-dir/metadata-dynamic-routes/index.test.ts
Expand Up @@ -380,16 +380,26 @@ createNextDescribe(
return new ImageResponse(<div>icon</div>)
}
`

const outputBeforeFetch = next.cliOutput + ''

await next.patchFile(iconFilePath, contentMissingIdProperty)
await next.fetch('/metadata-base/unset/icon/100')
await next.deleteFile(iconFilePath) // revert

await check(async () => {
expect(next.cliOutput).toContain(
`id is required for every item returned from generateImageMetadata`
)
return 'success'
}, /success/)
const outputAfterFetch = next.cliOutput + ''
const output = outputAfterFetch.replace(outputBeforeFetch, '')

try {
await check(async () => {
expect(output).toContain(
`id property is required for every item returned from generateImageMetadata`
)
return 'success'
}, /success/)
} finally {
await next.deleteFile(iconFilePath)
await next.fetch('/metadata-base/unset/icon/100')
}
})

it('should error when id is missing in generateSitemaps', async () => {
Expand All @@ -399,7 +409,7 @@ createNextDescribe(
export async function generateSitemaps() {
return [
{ id: 0 },
{ },
]
}
Expand All @@ -411,16 +421,26 @@ createNextDescribe(
},
]
}`

const outputBeforeFetch = next.cliOutput + ''

await next.patchFile(sitemapFilePath, contentMissingIdProperty)
await next.fetch('/metadata-base/unset/sitemap.xml/0')
await next.deleteFile(sitemapFilePath) // revert

await check(async () => {
expect(next.cliOutput).toContain(
`id is required for every item returned from generateImageMetadata`
)
return 'success'
}, /success/)
const outputAfterFetch = next.cliOutput + ''
const output = outputAfterFetch.replace(outputBeforeFetch, '')

try {
await check(async () => {
expect(output).toContain(
`id property is required for every item returned from generateSitemaps`
)
return 'success'
}, /success/)
} finally {
await next.deleteFile(sitemapFilePath)
await next.fetch('/metadata-base/unset/sitemap.xml/0')
}
})
}

Expand Down

0 comments on commit 3773c5b

Please sign in to comment.