Implement registerCompletionHandler() #3283
Merged
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
This was referenced Dec 30, 2023
novemberborn
force-pushed
the
completion
branch
from
d26efe3
to
142322c
Compare
…test worker It prints the error, so it should fail as such.
Register a function to be called when AVA has completed a test run without uncaught exceptions or unhandled rejections. Fixes #3279. * * Completion handlers are invoked in order of registration. Results are not awaited.
novemberborn
force-pushed
the
completion
branch
from
142322c
to
f5eed14
Compare
|
This is fantastic for users who have been using AVA before 6.0.0. I'm looking forward to the new version. Thanks! |
kodiakhq bot
referenced
this pull request
in cloudquery/plugin-sdk-javascript
Feb 1, 2024
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [ava](https://avajs.dev) ([source](https://github.com/avajs/ava)) | devDependencies | minor | [`6.0.1` -> `6.1.1`](https://renovatebot.com/diffs/npm/ava/6.0.1/6.1.1) | --- ### Release Notes <details> <summary>avajs/ava (ava)</summary> ### [`v6.1.1`](https://github.com/avajs/ava/releases/tag/v6.1.1) [Compare Source](https://github.com/avajs/ava/compare/v6.1.0...v6.1.1) #### What's Changed - Fix 'previous failures' in watch mode always incrementing by [@​novemberborn](https://github.com/novemberborn) in [https://github.com/avajs/ava/pull/3297](https://github.com/avajs/ava/pull/3297) **Full Changelog**: avajs/ava@v6.1.0...v6.1.1 ### [`v6.1.0`](https://github.com/avajs/ava/releases/tag/v6.1.0) [Compare Source](https://github.com/avajs/ava/compare/v6.0.1...v6.1.0) #### What's Changed - Implement `registerCompletionHandler()` by [@​novemberborn](https://github.com/novemberborn) in [https://github.com/avajs/ava/pull/3283](https://github.com/avajs/ava/pull/3283) AVA 6 expects test code to clean up gracefully when the tests are complete, allowing the test environment (worker thread or child process) to exit. If this does not happen, AVA will report a timeout. You can use `registerCompletionHandler()` to perform any other clean up (or indeed exit the process) after AVA has completed the test execution. See [the description here](https://github.com/avajs/ava/blob/main/docs/08-common-pitfalls.md#timeouts-because-a-file-failed-to-exit). - Fix potential bug with watch mode when no failed test files are written by [@​novemberborn](https://github.com/novemberborn) in [https://github.com/avajs/ava/pull/3287](https://github.com/avajs/ava/pull/3287) - Fix `ava/internal` ESM type module by [@​codetheweb](https://github.com/codetheweb) in [https://github.com/avajs/ava/pull/3292](https://github.com/avajs/ava/pull/3292) **Full Changelog**: avajs/ava@v6.0.1...v6.1.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 4am on the first day of the month" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xNjMuMiIsInVwZGF0ZWRJblZlciI6IjM3LjE2My4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->
This was referenced Jun 20, 2024
aepfli
referenced
this pull request
in aepfli/markdownlint-rule-max-one-sentence-per-line
Jul 8, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ava](https://avajs.dev) ([source](https://github.com/avajs/ava)) | [`5.3.1` -> `6.1.3`](https://renovatebot.com/diffs/npm/ava/5.3.1/6.1.3) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>avajs/ava (ava)</summary> ### [`v6.1.3`](https://github.com/avajs/ava/releases/tag/v6.1.3) [Compare Source](https://github.com/avajs/ava/compare/v6.1.2...v6.1.3) #### What's Changed - Include Node.js 22 in supported engines and test matrix by [@​lenovouser](https://github.com/lenovouser) in [https://github.com/avajs/ava/pull/3328](https://github.com/avajs/ava/pull/3328) - Add VS Code debugging instructions for Yarn PnP projects by [@​bitjson](https://github.com/bitjson) in [https://github.com/avajs/ava/pull/3317](https://github.com/avajs/ava/pull/3317) - Document `serial` configuration option by [@​turadg](https://github.com/turadg) in [https://github.com/avajs/ava/pull/3321](https://github.com/avajs/ava/pull/3321) #### New Contributors - [@​bitjson](https://github.com/bitjson) made their first contribution in [https://github.com/avajs/ava/pull/3317](https://github.com/avajs/ava/pull/3317) - [@​turadg](https://github.com/turadg) made their first contribution in [https://github.com/avajs/ava/pull/3321](https://github.com/avajs/ava/pull/3321) - [@​lenovouser](https://github.com/lenovouser) made their first contribution in [https://github.com/avajs/ava/pull/3328](https://github.com/avajs/ava/pull/3328) **Full Changelog**: avajs/ava@v6.1.2...v6.1.3 ### [`v6.1.2`](https://github.com/avajs/ava/releases/tag/v6.1.2) [Compare Source](https://github.com/avajs/ava/compare/v6.1.1...v6.1.2) #### What's Changed - Fix throws assertions rejecting falsy values when `any: true` by [@​gibson042](https://github.com/gibson042) in [https://github.com/avajs/ava/pull/3313](https://github.com/avajs/ava/pull/3313) **Full Changelog**: avajs/ava@v6.1.1...v6.1.2 ### [`v6.1.1`](https://github.com/avajs/ava/releases/tag/v6.1.1) [Compare Source](https://github.com/avajs/ava/compare/v6.1.0...v6.1.1) #### What's Changed - Fix 'previous failures' in watch mode always incrementing by [@​novemberborn](https://github.com/novemberborn) in [https://github.com/avajs/ava/pull/3297](https://github.com/avajs/ava/pull/3297) **Full Changelog**: avajs/ava@v6.1.0...v6.1.1 ### [`v6.1.0`](https://github.com/avajs/ava/releases/tag/v6.1.0) [Compare Source](https://github.com/avajs/ava/compare/v6.0.1...v6.1.0) ##### What's Changed - Implement `registerCompletionHandler()` by [@​novemberborn](https://github.com/novemberborn) in [https://github.com/avajs/ava/pull/3283](https://github.com/avajs/ava/pull/3283) AVA 6 expects test code to clean up gracefully when the tests are complete, allowing the test environment (worker thread or child process) to exit. If this does not happen, AVA will report a timeout. You can use `registerCompletionHandler()` to perform any other clean up (or indeed exit the process) after AVA has completed the test execution. See [the description here](https://github.com/avajs/ava/blob/main/docs/08-common-pitfalls.md#timeouts-because-a-file-failed-to-exit). - Fix potential bug with watch mode when no failed test files are written by [@​novemberborn](https://github.com/novemberborn) in [https://github.com/avajs/ava/pull/3287](https://github.com/avajs/ava/pull/3287) - Fix `ava/internal` ESM type module by [@​codetheweb](https://github.com/codetheweb) in [https://github.com/avajs/ava/pull/3292](https://github.com/avajs/ava/pull/3292) **Full Changelog**: avajs/ava@v6.0.1...v6.1.0 ### [`v6.0.1`](https://github.com/avajs/ava/releases/tag/v6.0.1) [Compare Source](https://github.com/avajs/ava/compare/v6.0.0...v6.0.1) #### What's Changed - Ensure watch mode works outside of its integration tests by [@​novemberborn](https://github.com/novemberborn) in [https://github.com/avajs/ava/pull/3273](https://github.com/avajs/ava/pull/3273) **Full Changelog**: avajs/ava@v6.0.0...v6.0.1 ### [`v6.0.0`](https://github.com/avajs/ava/releases/tag/v6.0.0) [Compare Source](https://github.com/avajs/ava/compare/v5.3.1...v6.0.0) ##### Breaking Changes - AVA now requires Node.js versions 18.18, 20.8 or 21. Versions 14 and 16 are no longer supported. [#​3251](https://github.com/avajs/ava/issues/3251) [#​3216](https://github.com/avajs/ava/issues/3216) - When tests finish, worker threads or child processes are no longer exited through `proces.exit()`. If your test file does not exit on its own, the test run will time out. [#​3260](https://github.com/avajs/ava/issues/3260) - Changes to watch mode [#​3218](https://github.com/avajs/ava/issues/3218): - Watch mode can no longer be started via the `ava.config.*` or `package.json` configuration. - The `ignoredByWatcher` configuration has moved to the `watchMode` object, under the `ignoreChanges` key. - Watch mode now uses the built-in [`fs.watch()`](https://nodejs.org/api/fs.html#fswatchfilename-options-listener) in recursive mode. This is supported on Linux in Node.js 20 or newer, and MacOS and Windows in Node.js 18 as well. There are [caveats](https://nodejs.org/api/fs.html#caveats) to keep in mind. - Failed assertions now throw, meaning that any subsequent code is not executed. This also impacts the type definitions. [#​3246](https://github.com/avajs/ava/issues/3246) - [Only native errors](https://nodejs.org/api/util.html#utiltypesisnativeerrorvalue) are now considered errors by the `t.throws()` and `t.throwsAsync()` assertions. [`Object.create(Error.prototype)` is **not** a native error](Object.create\(Error.prototype\)). [#​3229](https://github.com/avajs/ava/issues/3229) - Changes to modules loaded through the `require` configuration [#​3184](https://github.com/avajs/ava/issues/3184): - If such modules export a default function, this function is now invoked. - Local files are loaded through `@ava/typescript` if necessary. ##### Improvements ##### Rewritten watcher The watcher has been rewritten. It’s now built on [`fs.watch()`](https://nodejs.org/api/fs.html#fswatchfilename-options-listener) in recursive mode. [`@vercel/nft`](https://github.com/vercel/nft) is used to perform static dependency analysis, supporting ESM and CJS imports for JavaScript & TypeScript source files. This is a huge improvement over the previous runtime tracking of CJS imports, which did not support ESM. Integration with [`@ava/typescript`](https://github.com/avajs/typescript) has been improved. The watcher can now detect a change to a TypeScript source file, then wait for the corresponding build output to change before re-running tests. The ignoredByWatcher configuration has moved to the watchMode object, under the ignoreChanges key. See [#​3218](https://github.com/avajs/ava/issues/3218) and [#​3257](https://github.com/avajs/ava/issues/3257). ##### Failed assertions now throw Assertions now throw a `TestFailure` error when they fail. This error is not exported or documented and should not be used or thrown manually. You cannot catch this error in order to recover from a failure, use `t.try()` instead. All assertions except for `t.throws()` and `t.throwsAsync()` now return `true` when they pass. This is useful for some of the assertions in TypeScript where they can be used as a type guard. Committing a failed `t.try()` result now also throws. See [#​3246](https://github.com/avajs/ava/issues/3246). ##### `t.throws()` and `t.throwsAsync()` can now expect any error By default, the thrown error (or rejection reason) must be a native error. You can change the assertion to expect any kind of error by setting `any: true` in the expectation object: ```js t.throws(() => { throw 'error' }, {any: true}) ``` See [#​3245](https://github.com/avajs/ava/issues/3245) by [@​adiSuper94](https://github.com/adiSuper94). ##### The `require` configuration is now more powerful It now loads ES modules. Local files are loaded through `@ava/typescript` if necessary, so you can also write these in TypeScript. If there is a default export function, it is invoked after loading. The function is awaited so it can do asynchronous setup before further modules are loaded. Arguments from the configuration can be passed to the function (as a \[[structured clone](https://developer.mozilla.org/en-US/docs/Web/API/structuredClone)]\(https://developer.mozilla.org/en-US/docs/Web/API/structuredClone)). See [#​3184](https://github.com/avajs/ava/issues/3184) by [@​sculpt0r](https://github.com/sculpt0r). ##### Other changes worth noting - Internal events can now be observed (experimentally). See [#​3247](https://github.com/avajs/ava/issues/3247) by [@​codetheweb](https://github.com/codetheweb). It’s experimental and undocumented. - You can now use `t.timeout.clear()` to restore a previous `t.timeout()`. [#​3221](https://github.com/avajs/ava/issues/3221) - Code coverage is flushed to disk at opportune moments. [#​3220](https://github.com/avajs/ava/issues/3220) ##### New Contributors - [@​sculpt0r](https://github.com/sculpt0r) made their first contribution in [https://github.com/avajs/ava/pull/3184](https://github.com/avajs/ava/pull/3184) - [@​ZachHaber](https://github.com/ZachHaber) made their first contribution in [https://github.com/avajs/ava/pull/3233](https://github.com/avajs/ava/pull/3233) - [@​adiSuper94](https://github.com/adiSuper94) made their first contribution in [https://github.com/avajs/ava/pull/3245](https://github.com/avajs/ava/pull/3245) - [@​bricker](https://github.com/bricker) made their first contribution in [https://github.com/avajs/ava/pull/3250](https://github.com/avajs/ava/pull/3250) **Full Changelog**: avajs/ava@v5.3.1...v6.0.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/aepfli/markdownlint-rule-max-one-sentence-per-line). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy44MS4zIiwidXBkYXRlZEluVmVyIjoiMzcuMzQwLjEwIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
This was referenced Sep 12, 2024
](https://renovatebot.com){kind=link}
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.
Register a function to be called when AVA has completed a test run without uncaught exceptions or unhandled rejections.
Fixes #3279.