test: use Node's test runner for significant speedup #617
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tl;dr: `node --test` instead of `brittle` to speed up tests. Only affects the runner; `brittle` is still imported in tests. --- We use [Brittle] for tests, which has two distinct pieces: 1. The runner (the `brittle` command) 2. The module (the `brittle` import) These pieces can be used independently. For example, `node /path/to/my-brittle-test.js` runs an individual file without using the `brittle` command; it only uses the `brittle` module. You can also run `brittle /path/to/file.js`, which might not import the `brittle` module. We eventually want to drop Brittle entirely. We can start with the easier part: dropping the test runner. `node --test` is typically used with the `node:test` module, but it doesn't have to be. From [Node's docs]: > Test files must be executable by Node.js, but are not required to use > the `node:test` module internally. This replaces `npm run test:unit` and `npm run test:e2e` with `node --test`. In addition to being a step towards our eventual goal, it is also much faster (presumably because it runs concurrently). On my machine, `test:unit` goes from about 51 seconds to about 12.5, and `test:e2e` went from ~2.3 minutes to about ~1.9. [Brittle]: https://www.npmjs.com/package/brittle [Node's docs]: https://nodejs.org/docs/latest-v18.x/api/test.html#test-runner-execution-model
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
tl;dr:
node --testinstead ofbrittleto speed up tests. Only affects the runner;brittleis still imported in tests.We use Brittle for tests, which has two distinct pieces:
brittlecommand)brittleimport)These pieces can be used independently. For example,
node /path/to/my-brittle-test.jsruns an individual file without using thebrittlecommand; it only uses thebrittlemodule. You can also runbrittle /path/to/file.js, which might not import thebrittlemodule.We eventually want to drop Brittle entirely. We can start with the easier part: dropping the test runner.
node --testis typically used with thenode:testmodule, but it doesn't have to be. From Node's docs:This replaces
npm run test:unitandnpm run test:e2ewithnode --test. In addition to being a step towards our eventual goal, it is also much faster (presumably because it runs concurrently). On my machine,test:unitgoes from about 51 seconds to about 12.5, andtest:e2ewent from ~2.3 minutes to about ~1.9. On CI,npm teststarted at 2m24s and is now 1m48s.