Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update dependency ava to v6 #642

Closed
wants to merge 1 commit into from
Closed

Update dependency ava to v6 #642

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Dec 5, 2023 •
edited
Loading

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
ava (source) 2.4.0 -> 6.1.3 age adoption passing confidence

Release Notes

avajs/ava (ava)

v6.1.3

Compare Source

What's Changed

New Contributors

Full Changelog: avajs/ava@v6.1.2...v6.1.3

v6.1.2

Compare Source

What's Changed

Full Changelog: avajs/ava@v6.1.1...v6.1.2

v6.1.1

Compare Source

What's Changed

Full Changelog: avajs/ava@v6.1.0...v6.1.1

v6.1.0

Compare Source

What's Changed

Full Changelog: avajs/ava@v6.0.1...v6.1.0

v6.0.1

Compare Source

What's Changed

Full Changelog: avajs/ava@v6.0.0...v6.0.1

v6.0.0

Compare Source

Breaking Changes

  • AVA now requires Node.js versions 18.18, 20.8 or 21. Versions 14 and 16 are no longer supported. #​3251 #​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

  • Changes to watch mode #​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() 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 to keep in mind.

  • Failed assertions now throw, meaning that any subsequent code is not executed. This also impacts the type definitions. #​3246

  • Only native errors are now considered errors by the t.throws() and t.throwsAsync() assertions. Object.create(Error.prototype) is not a native error. #​3229

  • Changes to modules loaded through the require configuration #​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() in recursive mode.

@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 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 and #​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.

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:

t.throws(() => { throw 'error' }, {any: true})

See #​3245 by @​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)).

See #​3184 by @​sculpt0r.

Other changes worth noting
  • Internal events can now be observed (experimentally). See #​3247 by @​codetheweb. It’s experimental and undocumented.
  • You can now use t.timeout.clear() to restore a previous t.timeout(). #​3221
  • Code coverage is flushed to disk at opportune moments. #​3220
New Contributors

Full Changelog: avajs/ava@v5.3.1...v6.0.0

v5.3.1

Compare Source

What's Changed

Full Changelog: avajs/ava@v5.3.0...v5.3.1

v5.3.0

Compare Source

What's Changed

New Contributors

Full Changelog: avajs/ava@v5.2.0...v5.3.0

v5.2.0

Compare Source

What's Changed

New Contributors

Full Changelog: avajs/ava@v5.1.1...v5.2.0

v5.1.1

Compare Source

What's Changed

Full Changelog: avajs/ava@v5.1.0...v5.1.1

v5.1.0

Compare Source

What's Changed
New Contributors

Full Changelog: avajs/ava@v5.0.1...v5.1.0

v5.0.1

Compare Source

Despite the major version bump this is a relatively minor release. Node.js 12 is no longer supported. The type definitions are now distributed to be compatible with TypeScript 4.7 or newer.

npm install --save-dev ava

Breaking Changes

Improvements

New Contributors

Full Changelog: avajs/ava@v4.3.3...v5.0.1

v5.0.0

Compare Source

Despite the major version bump this is a relatively minor release. Node.js 12 is no longer supported. The type definitions are now distributed to be compatible with TypeScript 4.7 or newer.

It's available as a pre-release under the next tag for the next few weeks:

npm install --save-dev ava@next

Breaking Changes

Improvements

New Contributors

Full Changelog: avajs/ava@v4.3.3...v5.0.0

v4.3.3

Compare Source

Add compatibility with Node.js 18.8, thanks @​Brooooooklyn #​3091.

Full Changelog: avajs/ava@v4.3.1...v4.3.3

v4.3.2

Compare Source

v4.3.1

Compare Source

What's Changed

New Contributors

Full Changelog: avajs/ava@v4.3.0...v4.3.1

v4.3.0

Compare Source

What's Changed

Full Changelog: avajs/ava@v4.2.0...v4.3.0

v4.2.0

Compare Source

What's Changed

New Contributors

Full Changelog: avajs/ava@v4.1.0...v4.2.0

v4.1.0

Compare Source

New features

Fixes

New Contributors

Full Changelog: avajs/ava@v4.0.1...v4.1.0

v4.0.1

Compare Source

What's Changed

Full Changelog: avajs/ava@v4.0.0...v4.0.1

v4.0.0: AVA 4

Compare Source

We're celebrating the new year with the official AVA 4 release! 🎊

npm install -D ava

The cool new stuff 🆒

Worker threads 🧑‍💼

By default, test files are now run in worker threads! Huge thanks to @​dnlup for landing this.

Test files should run a little quicker, since it's easier to spin up a worker thread than a child process. You can use --no-worker-threads on the command line, or workerThreads: false in your AVA configuration, to fall back to using child processes.

Shared workers are no longer experimental 🎊

Shared workers are no longer experimental. This is a powerful feature that loads a program in a worker thread in AVA's main process and then communicate with code running in the test workers. This enables your tests to better utilize shared resources during a test run, as well as providing opportunities to set up these resources before tests start (or clean them up after).

When you use watch mode, shared workers remain loaded across runs.

Improved test selection 🤳

AVA selects test files based on your package.json or ava.config.* configuration files. When used on the CLI you can then provide patterns to select a subset of these files.

You can now pass a folder and AVA will select the test files contained therein. Or you can provide a specific JavaScript file and AVA will run it even if it wasn’t selected by your configuration.

If AVA finds files based on the configuration, but none of those were selected to the CLI arguments, it now prints a warning.

Better monorepo support 🚝

AVA now looks for ava.config.* files in parent directories, until it finds a directory with a .git directory (or file). This lets you specify AVA configuration at the top of your monorepo and still run AVA from within each package.

New snapshot format 📸

@​ninevra has worked tirelessly on landing a new snapshot format. It contains all information necessary to regenerate the report file. This allows for snapshots to be updated even if tests or assertions are skipped.

Previously failing test files run first 🏃

AVA now records which test files failed in the previous run. It then prioritizes testing these files when you run AVA again. Thanks @​bunysae!

ESM support 🤾

AVA 4 comes with full ES module support. Both ESM and CJS entrypoints are provided so that you can use it no matter how you manage your project.

The ava.config.js file is now treated as CJS or ESM depending on module type configured in the package.json file. ava.config.mjs is now supported.

If you use JavaScript files with non-standard extensions you can configure AVA to import them.

Note that dependency tracking in watch mode does not yet work with ES modules.

Dedicated macro factory with type inference 🏭

test.macro() returns an object that can be used with test() and hooks. The t.context type is inherited from test. When used with TypeScript this gives much better type inference.

Like with AVA 3, regular functions that also have a title property that is a string-returning function are supported. However the type checking won’t be as good.

Source maps 🗺

AVA now uses the source map support that’s built in to Node.js itself. This should give better stack traces. However we’re not sure yet what happens if you load a program that automatically modifies stack traces.

Line number selection (where npx ava test.js:5 runs the test at line 5) now uses source maps and so should work better with TypeScript files.

Assertions as type guards 💂

Most assertions now return a boolean indicating whether they passed. If you use AVA with TypeScript, you can use this as a type guard. Thanks @​jmarkham828!

(This is not supported for t.snapshot() and the "throws" assertions.)

Breaking changes 💥

AVA 4 requires at least Node.js 12.22, 14.17, 16.4 or 17. Node.js 10 is no longer supported.

If installed globally, AVA will no longer use any locally installed version. Install locally and run with npx ava instead. When running test files from another project that also has AVA installed, those test files will now fail to run (because they'll try and use that other AVA version).

Ecosystem 🏞
  • Support for @ava/babel has been removed. We haven’t seen enough contributions to that package to recommend it for AVA 4. We’d be open to reinstating it in the future (just as we’d be open to support any other compilation provider).
  • As a consequence, “enhanced assertions” are no longer available.
  • AVA 4 requires avajs/[email protected] or newer.
  • Support for the esm package has been removed.
Configuration 🗒
  • ava.config.js now follows the module type configured in package.json.
  • ava.config.* files may be found that are outside your project directory.
Tests and assertions 🥼
  • By default test files execute in worker threads, not child processes.
  • test.meta.file and test.meta.snapshotDirectory are now file URL strings.
  • Whitespace in test titles is now normalized. This could result in two tests being treated as having the same title, even though they are different in code. Thanks @​KillyMXI!
  • test() and t.try() no longer take an array of test implementations. Use a loop instead.
  • The t.throws() and t.throwAsync() assertions can no longer be called with a null value for the expectations argument.
  • test.cb() and t.end() have been removed. Use async functions and util.promisify() instead.
  • t.teardown() now executes in last-in-first-out order.
Snapshots 📸
  • Snapshots recorded using earlier AVA versions are no longer recognized. Run npx ava -u to rebuild your snapshots after upgrading.
  • Snapshots no longer recognize React elements, instead we want to provide this functionality through a plugin interface
  • t.snapshot() no longer works in hooks.
  • t.snapshot() no longer takes an options argument allowing you to customize the snapshot ID.
TypeScript 🪛
  • The instanceOf expectation of t.throws() and t.throwsAsync() assertions must now be an Error constructor.
  • You’re expected to use test.macro() when declaring macros.
  • Implementation arguments now default to unknown.
  • Types have been renamed. Meta replaces MetaInterface, other types with Interface suffixes now use the Fn suffix. There may be some other changes too. 4b4b2f6
  • t.throws() and t.throwsAsync() return undefined when the assertion fails. The type definition now matches this behavior.
  • Our TypeScript definitions are now tested against TypeScript 4.4

Other changes 🤓

  • We’ve removed the non-verbose reporter because it proved too hard to maintain two subtly different reporter outputs. We’d really like to rewrite the reporter.
  • AVA's configuration files may now export promises or asynchronous factory methods.
  • The --config argument may now point to a file that is not alongside the package.json file.
  • When you use t.timeout(), AVA itself won’t time out until your test does. Thanks @​OhYash!
  • Multi-line snapshot labels now render correctly in Markdown. Thanks @​KillyMXI!
  • The reporters now clean up .test and .spec extensions from file names, as well as test- prefixes.
  • Watch mode is better at detecting changes to snapshots and not rerunning tests.

New Contributors

Full changelog since RC 1: avajs/ava@v4.0.0-rc.1...v4.0.0
Full changelog since AVA 3: avajs/ava@v3.15.0...v4.0.0

v3.15.0: 3.15.0

Compare Source

Automatic snapshot file removal

When you stop using snapshots in a test file, the next time you run ava --update-snapshots we'll remove the left-over snapshot files. Thanks @​ninevra! 4f093ab

TAP improvements

@​tymfear has been on a roll improving our TAP reporter. t.log() output is now compliant with the spec 99ab93a. Tests that did not run due to timeouts are now reported 98595da.

Next-generation configuration

AVA 4 will add full support for ESM configuration files as well as allowing you to have asynchronous factory functions a2f2614. If you're using Node.js 12 or later you can opt-in to these features in AVA 3 by enabling the nextGenConfig experiment. Say in an ava.config.mjs file:

export default {
	nonSemVerExperiments: {
		nextGenConfig: true
	},
	files: ['unit-tests/**/*]
};

This also allows you to pass an .mjs file using the --config argument.

With this experiment enabled, AVA will no longer have special treatment for ava.config.js files. Instead AVA follows Node.js' behavior, so if you've set "type": "module" you must use ESM, and otherwise you must use CommonJS.

You mustn't have an ava.config.mjs file next to an ava.config.js or ava.config.cjs file.

See avajs/ava@v3.14.0...v3.15.0 for all changes.

v3.14.0: 3.14.0

Compare Source

Snapshot ordering

With this release, snapshot files are now ordered based on test declaration, not completion. This makes it easier to compare the human-readable reports to your test file, and also stops the .snap from changing when the reports themselves don't. You'll want to rebuild snapshots after upgrading to this release to isolate any changes. Thanks @​ninevra! e66b54c

Shared workers

We’ve been working on making AVA more extensible. One major step on this path is our new shared worker support: run code in the main process, communicate with test workers and influence execution. Find out more in our shared workers recipe.

See avajs/ava@v3.13.0...v3.14.0 for all changes.

v3.13.0: 3.13.0

Compare Source

  • t.passed can now be used in tests and teardown functions. Thanks @​tymfear! 900dc6d
  • In AVA 4, you'll no longer be able to pass null as the expectation for t.throws() & t.throwsAsync(). You can opt in to this early by enabling the disableNullExpectations experiment. Thanks @​JSimoni42! f328a69
  • The Enzyme recipe has been updated. Thanks @​jonathansamines! db5d2c3
  • The TypeScript recipe has been updated. Thanks @​SephReed! a3379fa

See avajs/ava@v3.12.1...v3.13.0 for all changes.

v3.12.1: 3.12.1

Compare Source

Configure how AVA loads test files

Normally, AVA loads all files as CommonJS, except for mjs files and if you've configured "type": "module" in your package.json.

As an experiment, you can now configure how AVA loads other file extensions. This is useful if you want to use Node.js' experimental loaders feature. Read more in our documentation. Thank you @​macarie for working on this! 5c9dbb9

Comparison bugfix

There was a bug in our comparison library which meant that negative-index properties on lists were not compared. This was fixed in a patch release, which will definitely be installed when you install AVA 3.12. Your tests may have been passing, even though they should have been failing. They'll fail now. Snapshots may also be different, causing tests to fail.

All changes

See avajs/ava@v3.11.1...v3.12.1 for all changes.

Thank you @​AnthumChris for making sure our ESM example used ESM syntax (20bc781).

v3.12.0

Compare Source

v3.11.1: 3.11.1

Compare Source

This release fixes corrupted output of the default reporter when test or program code writes to standard out. 5ddc9fd

Also, thanks to @​jonathansamines we've taken another step to using AVA to test AVA. 1150991

See avajs/ava@v3.11.0...v3.11.1 for all changes.

v3.11.0: 3.11.0

Compare Source

New t.like() assertion

Thanks to @​futpib we now have a t.like() assertion 19c4f35:

In the following example, the map property of value must be deeply equal to that of selector. However nested.qux is ignored, because it's not in selector.

t.like({
	map: new Map([['foo', 'bar']]),
	nested: {
		baz: 'thud',
		qux: 'quux'
	}
}, {
	map: new Map([['foo', 'bar']]),
	nested: {
		baz: 'thud',
	}
})

Read more in the t.like() assertion documentation.

This assertion was previously introduced as an experiment.

VSCode 1.47 debugging improvements

You can now debug tests using the new JavaScript Debug Terminal in VSCode 1.47. We've updated our debugging recipe accordingly. Thank you @​connor4312 for the documentation updates and your work on VSCode! bc39bcc

All changes

See avajs/ava@v3.10.1...v3.11.0 for all changes.

v3.10.1: 3.10.1

Compare Source

It's time for another AVA release 🎉

Restricting when you can update snapshots

When executing a subset of tests, through --match or or .only() or .skip(), you can no longer also update snapshots. This prevents you from accidentally deleting snapshots. Thank you @​bunysae for putting this together. f72fab4

If you are skipping a test that you can't immediately fix, but you still need to update snapshots, use .failing() instead.

Support for message strings in t.timeout() calls

Thanks to @​jonathansamines you can now provide a message string when using t.timeout(). This can be useful if your test depends on some other setup that may not have been completed: ca8ea45

test('foo', t => {
	t.timeout(100, 'make sure database has started');
	// Write your assertions here
});

t.try() does not work in hooks

t.try() has never worked in hooks, but thanks to @​okyantoro it now fails properly instead of crashing. d01db61

t.snapshot() does not really work in hooks either

t.snapshot() sort of works in hooks, but we'll be removing this in AVA 4. You can opt in to this behavior by enabling the disableSnapshotsInHooks experiment. Again thank you @​okyantoro d01db61.

Fixed TypeScript definition for t.like()

The experimental t.like() assertion should now work better with TypeScript.

All changes

See avajs/ava@v3.9.0...v3.10.1 for all changes.

v3.10.0

Compare Source

v3.9.0: 3.9.0

Compare Source

New experiments!

Thanks to @​futpib we now have an experimental t.like() assertion 19c4f35:

In the following example, the map property of value must be deeply equal to that of selector. However nested.qux is ignored, because it's not in selector.

t.like({
	map: new Map([['foo', 'bar']]),
	nested: {
		baz: 'thud',
		qux: 'quux'
	}
}, {
	map: new Map([['foo', 'bar']]),
	nested: {
		baz: 'thud',
	}
})

Read more in the t.like() assertion documentation and let us know what you think.

@​yjpa7145 has contributed an experiment to reverse the order in which t.teardown() functions are run, so that the last registered function is called first 952a017. This will be the behavior in AVA 4.

To enable both these experiments update your AVA configuration:

package.json:

{
	"ava": {
		"nonSemVerExperiments": {
			"likeAssertion": true,
			"reverseTeardowns": true
		}
	}
}

ava.config.js:

export default {
	nonSemVerExperiments: {
		likeAssertion: true,
		reverseTeardowns: true
	}
}

Reporter changes

@​Michael55555 has helped us combine our reporter code into a single file b3866b6. We've also made some other tweaks and improvements baaf99a. Let us know if anything seems amiss.

Improved diffs

@​bunysae made it so that missing or extraneous objects in diffs are printed with extra depth https://github.com/concordancejs/concordance/pull/62.

Farewell Node.js 13

Node.js 13 has reached end-of-life. Per our support statement we have removed it from our test matrix and supported version list.

All changes

See avajs/ava@v3.8.2...v3.9.0 for all changes. Thank you @​paulrobertlloyd and @​Autre31415 for contributing documentation improvements.

v3.8.2: 3.8.2

Compare Source

v3.8.1: 3.8.1

Compare Source

Node.js 14 support

Great news, this is a feature heavy release!

First off, though, AVA now officially supports Node.js 14. Thank you @​zackschuster! 2e7c76b

Run tests at specific line numbers

AVA can now run tests at specific line numbers! 🎉

Given the following test file:

test.js

1: test('unicorn', t => {
2:   t.pass();
3: });
4:
5: test('rainbow', t => {
6:  t.fail();
7: });

Running npx ava test.js:2 for would run the unicorn test. In fact you could use any line number between 1 and 3.

This feature is only available from the command line. It won't work if you use tools like ts-node/register or @babel/register, and it does not currently work with @ava/babel and @ava/typescript. See https://github.com/avajs/ava/issues/2473.

Thank you @​ulken for your hard work and patience to get this shipped. 1222ce9

Test-specific teardown functions

Sometimes tests have side-effects you want to clean up. @​ulken has implemented t.teardown() which lets you register teardown functions within your test. They'll run once your test has finished, even if it failed: 75cbc3b

test('read file', t => {
	fs.writeFileSync('file.txt', '👋');
	t.teardown(() => fs.unlinkSync('file.txt');

	// Run assertions
});

Node.js internal in stack traces

Thanks to @​bunysae, stack traces now include Node.js internals. Previously we removed them because we wanted you to focus on your own code, but quite often they do provide context. Now they're displayed, but somewhat dimmed. 9a9351d

Watch mode with the default reporter

Watch mode with the default reporter once again accepts key input. Thanks @​pcdevil! 59c227d

ICYMI

  • afterEach() and afterEach.always() hooks can now determine whether the test passed. Thank you @​bunysae for contributing this! 8f312c0

    test('passes', t => t.pass());

test.afterEach(t => {
	if (t.passed) {
		// Do something because the test passed
	} else {
		// Do something because the test failed
	}
});

  • If you've ever wanted to save some files along with AVA's snapshots, you can now determine the directory path by accessing test.meta.snapshotDirectory. Thank you @​ulken! cb5f9f7

All changes

See avajs/ava@v3.7.1...v3.8.1 for all changes.

v3.8.0

Compare Source

v3.7.1: 3.7.1

Compare Source

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 was generated by Mend Renovate. View the repository job log.

@renovate renovate bot force-pushed the renovate/ava-6.x branch from ec82fdf to 28b396e Compare December 6, 2023 22:15
@renovate renovate bot force-pushed the renovate/ava-6.x branch from 28b396e to 9e817e1 Compare January 21, 2024 21:27
@renovate renovate bot force-pushed the renovate/ava-6.x branch from 9e817e1 to bfbe760 Compare January 29, 2024 22:24
@renovate renovate bot force-pushed the renovate/ava-6.x branch from bfbe760 to 0f5931d Compare February 28, 2024 22:48
@renovate renovate bot force-pushed the renovate/ava-6.x branch from 0f5931d to 8175a11 Compare May 5, 2024 22:12
@renovate renovate bot force-pushed the renovate/ava-6.x branch from 8175a11 to fd49b9d Compare September 27, 2024 15:55
@renovate renovate bot force-pushed the renovate/ava-6.x branch from fd49b9d to 3507ecb Compare September 27, 2024 15:59
@renovate renovate bot changed the base branch from development to master September 27, 2024 15:59
@Apollon77 Apollon77 closed this Sep 27, 2024
@renovate Renovate
Copy link
Contributor Author

renovate bot commented Sep 27, 2024

Renovate Ignore Notification

Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for any future 6.x releases. But if you manually upgrade to 6.x then Renovate will re-enable minor and patch updates automatically.

If you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR.

@renovate renovate bot deleted the renovate/ava-6.x branch September 27, 2024 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@Apollon77