test: compare cache-control directives as a set in deploy tests (#99892)
Imported https://github.com/vercel/next.js/pull/99872 by @pieh as a
local branch to be able to run CI
Closes https://github.com/vercel/next.js/pull/99872
---
<!-- 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
We encourage you to use AI to assist you in researching, creating, and
reviewing changes. However, you must review and deeply understand the
contributions you are making. For this reason, **pull request
descriptions from external contributors must be written by a human**.
### 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
### 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
### Signed commits
- This repository requires verified commit signatures on protected
branches.
- If this pull request is blocked for unsigned commits, re-sign the
commits and force-push the branch.
- A `Signed-off-by` line in the commit message is not enough.
## 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 #
-->
### What?
Adjust existing `cache-control` assertions in e2e tests running in
deploy mode to compare directives in a way that whitespace changes don't
fail a test, but still assert that exact set of expected directives is
received.
To minimize the change I avoided changing tests that do not run in
deploy mode.
### Why?
Tests asserting on exact string are failing like this when testing
Netlify deployments:
```
Error: expect(received).toBe(expected) // Object.is equality
Expected: "public, max-age=0, must-revalidate"
Received: "public,max-age=0,must-revalidate"
at Object.toBe (/home/runner/work/opennextjs-netlify/opennextjs-netlify/nextjs/test/e2e/app-dir/metadata-dynamic-routes/index.test.ts:26:48)
at processTicksAndRejections (node:internal/process/task_queues:95:5)
```
which still has same overall behavior, just not the same exact
formatting
### How?
Extract pre-existing local `expectDirectives` helper from one of the the
[tests](https://github.com/vercel/next.js/blob/ea119d2702ba9252233c678ca74b4a310b5eedd0/test/e2e/app-dir/ppr-full/ppr-full.test.ts#L70-L83)
to shared utils, generalize it to allow regex rules and adjust deploy
tests to use it instead of strict string comparisons.
Co-authored-by: pieh <misiek.piechowiak@gmail.com>