Recognize typical assertion errors and use their formatting #3187

Irvenae · 2023-03-30T20:45:05Z

Based on #2230 which was mentioned in (incorrectly) resolved #1277.

lib/test.js

Irvenae · 2023-03-30T20:54:05Z

I don't know what the expected way is to add the expect dependency in the test.
So all tests fail with Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'expect' imported from /home/runner/work/ava/ava/test/external-assertions/fixtures/expect-failure.js␊

novemberborn · 2023-04-10T15:40:26Z

Nice one @Irvenae!

Fixture packages are not installed, those package.json files are mostly there so that the AVA-under-test does not walk up to the repository root.

It should be fine if you install expect as a dev dependency.

Could you share some screenshots of how these errors are then reported? And could you address the linter errors?

Irvenae · 2023-04-12T10:54:09Z

You could see the result from the snapshot.
Before:

After:

Irvenae · 2023-04-12T10:57:36Z

lib/assert.js

@@ -27,7 +27,7 @@ function formatWithLabel(label, value) {
 	return formatDescriptorWithLabel(label, concordance.describe(value, concordanceOptions));
 }

-const hasOwnProperty = (object, prop) => Object.prototype.hasOwnProperty.call(object, prop);
+export const hasOwnProperty = (object, prop) => Object.prototype.hasOwnProperty.call(object, prop);


not sure we want to expose that here or place this in a more appropriate file (or duplicate worst case)

It's available as Object.hasOwn() in Node.js 16 which will be the minimal required version soon enough. Repeating it is fine for now, I'm sure https://github.com/sindresorhus/eslint-plugin-unicorn will flag it soon enough 😉

Irvenae · 2023-04-12T17:41:32Z

Not sure how I should fix the windows tests. I could remove the snaps, but these give what we want to verify IMHO.

novemberborn · 2023-04-16T17:53:31Z

In that screenshot, is the syntax highlighting coming from Jest itself?

novemberborn · 2023-04-16T17:49:49Z

lib/assert.js

@@ -27,7 +27,7 @@ function formatWithLabel(label, value) {
 	return formatDescriptorWithLabel(label, concordance.describe(value, concordanceOptions));
 }

-const hasOwnProperty = (object, prop) => Object.prototype.hasOwnProperty.call(object, prop);
+export const hasOwnProperty = (object, prop) => Object.prototype.hasOwnProperty.call(object, prop);


It's available as Object.hasOwn() in Node.js 16 which will be the minimal required version soon enough. Repeating it is fine for now, I'm sure https://github.com/sindresorhus/eslint-plugin-unicorn will flag it soon enough 😉

test/external-assertions/test.js

Irvenae · 2023-04-17T06:50:49Z

In that screenshot, is the syntax highlighting coming from Jest itself?

yes, we pass the error message as a formatted field in values of AssertionError

Irvenae · 2023-04-25T08:16:16Z

can this be merged?

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ava](https://avajs.dev) ([source](https://togithub.com/avajs/ava)) | [`5.2.0` -> `5.3.1`](https://renovatebot.com/diffs/npm/ava/5.2.0/5.3.1) | [![age](https://developer.mend.io/api/mc/badges/age/npm/ava/5.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/ava/5.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/ava/5.2.0/5.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/ava/5.2.0/5.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>avajs/ava (ava)</summary> ### [`v5.3.1`](https://togithub.com/avajs/ava/releases/tag/v5.3.1) [Compare Source](https://togithub.com/avajs/ava/compare/v5.3.0...v5.3.1) #### What's Changed - Update `t.like()` to support Symbol keys and ignore non-enumerable properties by [@gibson042](https://togithub.com/gibson042) in [avajs/ava#3209 - Fix circular selector detection in `t.like()` by [@novemberborn](https://togithub.com/novemberborn) in [avajs/ava#3212 **Full Changelog**: avajs/ava@v5.3.0...v5.3.1 ### [`v5.3.0`](https://togithub.com/avajs/ava/releases/tag/v5.3.0) [Compare Source](https://togithub.com/avajs/ava/compare/v5.2.0...v5.3.0) #### What's Changed - Support arrays in `t.like()` assertions by [@tommy-mitchell](https://togithub.com/tommy-mitchell) in [avajs/ava#3185 - Recognize typical assertion errors (`expect` and `assert`) and use their formatting by [@Irvenae](https://togithub.com/Irvenae) in [avajs/ava#3187 #### New Contributors - [@MartynasZilinskas](https://togithub.com/MartynasZilinskas) made their first contribution in [avajs/ava#3172 - [@flovogt](https://togithub.com/flovogt) made their first contribution in [avajs/ava#3194 - [@ondreian](https://togithub.com/ondreian) made their first contribution in [avajs/ava#3192 - [@tommy-mitchell](https://togithub.com/tommy-mitchell) made their first contribution in [avajs/ava#3185 - [@craigahobbs](https://togithub.com/craigahobbs) made their first contribution in [avajs/ava#3198 - [@Irvenae](https://togithub.com/Irvenae) made their first contribution in [avajs/ava#3187 **Full Changelog**: avajs/ava@v5.2.0...v5.3.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. --- - [ ] 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).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ava](https://avajs.dev) ([source](https://togithub.com/avajs/ava)) | [`^5.0.0` -> `^6.0.0`](https://renovatebot.com/diffs/npm/ava/5.0.1/6.0.0) | [![age](https://developer.mend.io/api/mc/badges/age/npm/ava/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/ava/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/ava/5.0.1/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/ava/5.0.1/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>avajs/ava (ava)</summary> ### [`v6.0.0`](https://togithub.com/avajs/ava/releases/tag/v6.0.0) [Compare Source](https://togithub.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://togithub.com/avajs/ava/issues/3251) [#3216](https://togithub.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://togithub.com/avajs/ava/issues/3260) - Changes to watch mode [#3218](https://togithub.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://togithub.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://togithub.com/avajs/ava/issues/3229) - Changes to modules loaded through the `require` configuration [#3184](https://togithub.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://togithub.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://togithub.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://togithub.com/avajs/ava/issues/3218) and [#3257](https://togithub.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://togithub.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://togithub.com/avajs/ava/issues/3245) by [@adiSuper94](https://togithub.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://togithub.com/avajs/ava/issues/3184) by [@sculpt0r](https://togithub.com/sculpt0r). ##### Other changes worth noting - Internal events can now be observed (experimentally). See [#3247](https://togithub.com/avajs/ava/issues/3247) by [@codetheweb](https://togithub.com/codetheweb). It’s experimental and undocumented. - You can now use `t.timeout.clear()` to restore a previous `t.timeout()`. [#3221](https://togithub.com/avajs/ava/issues/3221) - Code coverage is flushed to disk at opportune moments. [#3220](https://togithub.com/avajs/ava/issues/3220) #### New Contributors - [@sculpt0r](https://togithub.com/sculpt0r) made their first contribution in [avajs/ava#3184 - [@ZachHaber](https://togithub.com/ZachHaber) made their first contribution in [avajs/ava#3233 - [@adiSuper94](https://togithub.com/adiSuper94) made their first contribution in [avajs/ava#3245 - [@bricker](https://togithub.com/bricker) made their first contribution in [avajs/ava#3250 **Full Changelog**: avajs/ava@v5.3.1...v6.0.0 ### [`v5.3.1`](https://togithub.com/avajs/ava/releases/tag/v5.3.1) [Compare Source](https://togithub.com/avajs/ava/compare/v5.3.0...v5.3.1) #### What's Changed - Update `t.like()` to support Symbol keys and ignore non-enumerable properties by [@gibson042](https://togithub.com/gibson042) in [avajs/ava#3209 - Fix circular selector detection in `t.like()` by [@novemberborn](https://togithub.com/novemberborn) in [avajs/ava#3212 **Full Changelog**: avajs/ava@v5.3.0...v5.3.1 ### [`v5.3.0`](https://togithub.com/avajs/ava/releases/tag/v5.3.0) [Compare Source](https://togithub.com/avajs/ava/compare/v5.2.0...v5.3.0) #### What's Changed - Support arrays in `t.like()` assertions by [@tommy-mitchell](https://togithub.com/tommy-mitchell) in [avajs/ava#3185 - Recognize typical assertion errors (`expect` and `assert`) and use their formatting by [@Irvenae](https://togithub.com/Irvenae) in [avajs/ava#3187 #### New Contributors - [@MartynasZilinskas](https://togithub.com/MartynasZilinskas) made their first contribution in [avajs/ava#3172 - [@flovogt](https://togithub.com/flovogt) made their first contribution in [avajs/ava#3194 - [@ondreian](https://togithub.com/ondreian) made their first contribution in [avajs/ava#3192 - [@tommy-mitchell](https://togithub.com/tommy-mitchell) made their first contribution in [avajs/ava#3185 - [@craigahobbs](https://togithub.com/craigahobbs) made their first contribution in [avajs/ava#3198 - [@Irvenae](https://togithub.com/Irvenae) made their first contribution in [avajs/ava#3187 **Full Changelog**: avajs/ava@v5.2.0...v5.3.0 ### [`v5.2.0`](https://togithub.com/avajs/ava/releases/tag/v5.2.0) [Compare Source](https://togithub.com/avajs/ava/compare/v5.1.1...v5.2.0) #### What's Changed - Infer thrown error from expectations by [@tao-cumplido](https://togithub.com/tao-cumplido) in [avajs/ava#3156 #### New Contributors - [@tao-cumplido](https://togithub.com/tao-cumplido) made their first contribution in [avajs/ava#3156 **Full Changelog**: avajs/ava@v5.1.1...v5.2.0 ### [`v5.1.1`](https://togithub.com/avajs/ava/releases/tag/v5.1.1) [Compare Source](https://togithub.com/avajs/ava/compare/v5.1.0...v5.1.1) #### What's Changed - Fix de-registration of shared workers to ensure AVA exits correctly, by [@codetheweb](https://togithub.com/codetheweb) in [avajs/ava#3149 & [avajs/ava#3151 **Full Changelog**: avajs/ava@v5.1.0...v5.1.1 ### [`v5.1.0`](https://togithub.com/avajs/ava/releases/tag/v5.1.0) [Compare Source](https://togithub.com/avajs/ava/compare/v5.0.1...v5.1.0) ##### What's Changed - Output logs for tests that remain pending when AVA exits by [@kevo1ution](https://togithub.com/kevo1ution) in [avajs/ava#3125 - Check for --config file extensions after they fail to load, allowing custom loaders by [@panva](https://togithub.com/panva) in [avajs/ava#3135 ##### New Contributors - [@kevo1ution](https://togithub.com/kevo1ution) made their first contribution in [avajs/ava#3125 - [@panva](https://togithub.com/panva) made their first contribution in [avajs/ava#3135 **Full Changelog**: avajs/ava@v5.0.1...v5.1.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. --- - [ ] 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/gr2m/github-project).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

✨ Improve formatting external assert libs

af320f9

Irvenae commented Mar 30, 2023

View reviewed changes

lib/test.js Outdated Show resolved Hide resolved

➕ add expect dep

8225c6b

🎀 lint

e14aa0a

Irvenae force-pushed the feat/ext-assert branch from ff7fc68 to e14aa0a Compare April 12, 2023 10:56

Irvenae commented Apr 12, 2023

View reviewed changes

Irvenae added 4 commits April 12, 2023 13:18

✅ update tests

6e121ef

✅ update tap reporters

78c62f9

⛅ improve error check

8a5b07c

✅ update tap reporters

82062a4

Irvenae force-pushed the feat/ext-assert branch from 4bec27f to 82062a4 Compare April 12, 2023 17:03

🎀 lint

1c45b23

novemberborn reviewed Apr 16, 2023

View reviewed changes

Irvenae added 3 commits April 17, 2023 08:51

✅ fix test

581c789

duplicate hasOwnProperty

40e6eee

✅ fix windows test

5e52c46

Irvenae force-pushed the feat/ext-assert branch from 098e358 to 5e52c46 Compare April 17, 2023 07:31

Test async codepath

b6769f1

novemberborn approved these changes May 21, 2023

View reviewed changes

novemberborn changed the title ~~Improve formatting external assert libs~~ Recognize typical assertion errors and use their formatting May 21, 2023

Respect linting

3e1d01b

novemberborn merged commit 5558367 into avajs:main May 24, 2023
16 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Recognize typical assertion errors and use their formatting #3187

Recognize typical assertion errors and use their formatting #3187

Irvenae commented Mar 30, 2023

Irvenae commented Mar 30, 2023 •

edited

novemberborn commented Apr 10, 2023

Irvenae commented Apr 12, 2023

Irvenae Apr 12, 2023

novemberborn Apr 16, 2023

Irvenae commented Apr 12, 2023

novemberborn commented Apr 16, 2023

novemberborn Apr 16, 2023

Irvenae commented Apr 17, 2023

Irvenae commented Apr 25, 2023

Recognize typical assertion errors and use their formatting #3187

Recognize typical assertion errors and use their formatting #3187

Conversation

Irvenae commented Mar 30, 2023

Irvenae commented Mar 30, 2023 • edited

novemberborn commented Apr 10, 2023

Irvenae commented Apr 12, 2023

Irvenae Apr 12, 2023

Choose a reason for hiding this comment

novemberborn Apr 16, 2023

Choose a reason for hiding this comment

Irvenae commented Apr 12, 2023

novemberborn commented Apr 16, 2023

novemberborn Apr 16, 2023

Choose a reason for hiding this comment

Irvenae commented Apr 17, 2023

Irvenae commented Apr 25, 2023

Irvenae commented Mar 30, 2023 •

edited