Skip to content

Commit

Permalink
Ensure Turbopack passing test list is sorted (#55948)
Browse files Browse the repository at this point in the history
I noticed that running the script to pull in the results wasn't
deterministic between test runs, this ensures the list, passing,
pending, and errors are all sorted, which makes the diff only include
what actually changed between runs.

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

-->
  • Loading branch information
timneutkens authored Sep 25, 2023
1 parent a63b89b commit cae7833
Show file tree
Hide file tree
Showing 2 changed files with 10,413 additions and 10,441 deletions.
34 changes: 28 additions & 6 deletions test/build-turbopack-tests-manifest.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
const fetch = require('node-fetch')
const fs = require('fs')
const prettier = require('prettier')

async function format(text) {
const options = await prettier.resolveConfig(__filename)
return prettier.format(text, { ...options, parser: 'json' })
}

const override = process.argv.includes('--override')

Expand Down Expand Up @@ -66,11 +72,11 @@ async function updatePassingTests() {
}

for (const info of Object.values(passing)) {
info.failed = [...new Set(info.failed)]
info.pending = [...new Set(info.pending)]
info.failed = [...new Set(info.failed)].sort()
info.pending = [...new Set(info.pending)].sort()
info.passed = [
...new Set(info.passed.filter((name) => !info.failed.includes(name))),
]
].sort()
}

if (!override) {
Expand All @@ -97,13 +103,29 @@ async function updatePassingTests() {
)
}
// Merge the old passing tests with the new ones
newData.passed = [...new Set([...oldData.passed, ...newData.passed])]
newData.passed = [
...new Set([...oldData.passed, ...newData.passed]),
].sort()
// but remove them also from the failed list
newData.failed = newData.failed.filter((name) => !shouldPass.has(name))
newData.failed = newData.failed
.filter((name) => !shouldPass.has(name))
.sort()
}
}

fs.writeFileSync(PASSING_JSON_PATH, JSON.stringify(passing, null, 2))
// JS keys are ordered, this ensures the tests are written in a consistent order
// https://stackoverflow.com/questions/5467129/sort-javascript-object-by-key
const ordered = Object.keys(passing)
.sort()
.reduce((obj, key) => {
obj[key] = passing[key]
return obj
}, {})

fs.writeFileSync(
PASSING_JSON_PATH,
await format(JSON.stringify(ordered, null, 2))
)
}

function stripWorkingPath(path) {
Expand Down
Loading

0 comments on commit cae7833

Please sign in to comment.