Modernize `require` config #3184

sculpt0r · 2023-03-09T22:15:19Z

Handled complex options.require in api path resolver and also in actual loader inside worker/base.

Could you also give some feedback if that is the right direction?

Closes: #1666

IssueHunt Summary

Referenced issues

This pull request has been submitted to:

#1666: Support arguments in "require" configuration

novemberborn

@sculpt0r looks great!

novemberborn · 2023-03-12T14:09:15Z

lib/worker/base.js

+				const mod = await load(path);
+				mod.apply(null, ...options);


Need to check how this works with a mix of CJs and ESM. You may need to check if mod is callable, and if not, access a callable default.

Thanks @novemberborn - I'll correct that :)

sculpt0r · 2023-03-13T17:25:16Z

@novemberborn I've made requested changes :) Could you take a look at this PR again?

For a while I have an idea, that in those options should be some parameter that tells you which part of loaded module I should invoke 🤔 Like setting:

"ava": {
  "require": [
    ["@babel/register", {
      "use": "exportedPartNameThatShouldBeCalled",
      "params": {
        "ignore": ["test/*"]
      }
    }]
  ]
}

Not sure if such complication in config is needed? But if you want to load some third party module, that you can't control - you might want to call some specific part of it - without extracting it manually or making proxy file just for sake of re-export some part of it?

novemberborn · 2023-03-14T19:21:19Z

lib/worker/base.js

+				const loadedModule = await load(path);
+
+				if (typeof loadedModule === 'function') {
+					loadedModule.apply(null, ...options);


Let's await this too, so it can do some async setup before we load the next module.

And below for default.apply.

Do we care about the this argument? Could loadedModule(...options) instead.

novemberborn · 2023-03-14T19:21:48Z

Not sure if such complication in config is needed? But if you want to load some third party module, that you can't control - you might want to call some specific part of it - without extracting it manually or making proxy file just for sake of re-export some part of it?

I think a proxy file would be most appropriate.

sculpt0r · 2023-03-15T12:50:22Z

Hi @novemberborn, PR is ready for another verification:

both invocations are now await'ed
removed null as this argument in favour of using destructed options. Previously I thought that maybe we shouldn't mess with this at all at config level. But this solutions allows users to pass null if they don't want that.

novemberborn

Would you be up to writing some tests? Best would be to create a folder in https://github.com/avajs/ava/tree/main/test and doing an integration style test.

novemberborn · 2023-03-21T09:11:52Z

lib/worker/base.js

+				const loadedModule = await load(path);
+
+				if (typeof loadedModule === 'function') {
+					await loadedModule.apply(...options);


This uses the first option as the this argument, so you'd always have to pass null which seems odd. I think it's better like:

Suggested change

await loadedModule.apply(...options);

await loadedModule(...options);

novemberborn · 2023-03-21T09:29:20Z

lib/worker/base.js

+				if (typeof loadedModule === 'function') {
+					await loadedModule.apply(...options);
+				} else if (typeof loadedModule.default === 'function') {
+					await loadedModule.default.apply(...options);


Suggested change

await loadedModule.default.apply(...options);

const {default: fn} = loadedModule;

await fn(...options);

sculpt0r · 2023-04-14T03:15:35Z

@novemberborn - could you explain me, why there are two different imports from ava in tests?

There is import test from '@ava/test'; and import test from 'ava'; which one should I use?

novemberborn · 2023-04-14T09:12:29Z

@ava/test is a little wrapper around an npm-hosted stable version of AVA. You use it for the tests that test the code in the repo. E.g. https://github.com/avajs/ava/blob/main/test/assertions/test.js.

Most if not all of those are integration style tests, which run the repo code in a child process. They have lower level access to the test results which can then be asserted against. The repo code executes test fixtures which import from ava itself, e.g. https://github.com/avajs/ava/blob/main/test/assertions/fixtures/happy-path.js.

The ava import is symlinked here https://github.com/avajs/ava/tree/main/test/node_modules.

sculpt0r · 2023-05-05T04:10:10Z

Sorry for the long delay... I have some life-topics that needs to be handle.

I think I'll finish tests soon.

sculpt0r · 2023-05-15T06:52:33Z

☝️ Rebased on the newest main branch.

sculpt0r · 2023-05-16T21:32:20Z

test/config-require/fixtures/required-default/req.js

@novemberborn Could you lead me a little bit more?
Is this test construction valid in any way? My idea was to invoke this default exported function and at least see sth in the logs - but it seems to not working the way I thought...

The issue was that the test files were in a subdirectory, which means you have to specify the cwd option.

novemberborn · 2023-05-21T16:26:28Z

Thanks @sculpt0r. I've done some more work on this, will push the commits soon.

This code has been a little overlooked in the past few years. For example it only works with CJS modules! I think the answer is to only support local files, and then resolve their paths from the project directories. But that's a breaking change. So we'll have to leave this pending a little while longer until we're ready to cut for AVA 6.

novemberborn · 2023-05-21T16:34:06Z

Tracking as a draft until we're ready for AVA 6.

@sculpt0r what do you think of the changes?

sculpt0r · 2023-05-22T10:43:00Z

lib/worker/base.js

-					const {default: fn} = loadedModule;
-					await fn(...options);
-				} else {
-					channel.send({type: 'non-invokable-require-option'});


I'm not sure how important it could be to inform users that the thing they want to import wont be called at all. For example if they try to use some local file and forgot to export sth that should be called?

It could be better to see an error instead of silent run when something is not working 🤔

I don't think it's necessarily the case that you want to execute a function, so making that required behavior isn't great either.

sculpt0r · 2023-05-22T10:50:17Z

test/config-require/fixtures/with-arguments/test.js

+	t.deepEqual(cjs.receivedArgs, ['goodbye']);
+});
+
+test('ok to load for side-effects', async t => {


It took me some time to understand that this test case take adventage of requesting the side-effect file before (during test loads config).

Maybe test case could be renamed? Sth like side-effects are execute at first with test loading or sth similar?

Yea I'm fine with renaming them, I didn't think too hard about it just wanted to get the tests done in the little time I had.

sculpt0r · 2023-05-22T10:55:07Z

Thanks @novemberborn for explanation and commits. That are the tests I tried to implement earlier - but I wasn't able...

I think the answer is to only support local files, and then resolve their paths from the project directories. But that's a breaking change. So we'll have to leave this pending a little while longer until we're ready to cut for AVA 6.

We talked before about such resolution - so definitely - if that is a breaking change - let's wait for next major release.

I left two extra comments to the latest changes. Not sure how important they are - so I didn't touch the code.

novemberborn · 2023-05-24T10:11:42Z

We'll also want to test and document that you can pass, say, maps and uint8arrays. And verify how that works with child processes.

sculpt0r · 2023-05-25T11:27:47Z

We'll also want to test and document that you can pass, say, maps and uint8arrays. And verify how that works with child processes.

Alright, then I add those tests since I think I know how :) Thanks for the tip :)

novemberborn · 2023-05-25T12:01:00Z

We'll also want to test and document that you can pass, say, maps and uint8arrays. And verify how that works with child processes.

Alright, then I add those tests since I think I know how :) Thanks for the tip :)

Nice!

We may find that we always JSON serialize the options, in which case Map won't survive the round trip. That's fine, but it'd be nicer to v8 serialize/deserialize. With worker threads that may be the default behavior, but for child processes that may require a change. In short I'm not really sure what we do at the moment. I think all other options are JSON compatible so it hasn't come up before.

With ava.config.* files you should be able to create maps for the require option.

All that said, just documenting the current behavior may suffice for now.

- call directly - fallback to `default`

* Resolve from the project directory by joining paths, this means you can only provide relative files and not dependencies, which is a breaking change * Remove Babel recipe since it's now incompatible * Fix tests and add additional cases * Some refactoring

sculpt0r · 2023-06-16T10:44:28Z

Rebased on the newest main.

sculpt0r · 2023-06-17T04:33:46Z

All that said, just documenting the current behavior may suffice for now.

TBH - I can't find any place that serialize config in any way? Since the config is loaded - it's passed almost unchanged to the API (besides arrify usage). And then the modules are loaded. So right now, I'm not sure if I should further investigate that for documenting purposes? In other words: do You think this PR requires more work? Or just until the 6.0 is ready - just make sure it didn't break anything?

This means options are (de)serialized the same way as with worker threads, enabling us to use maps etc for require arguments.

Write a file into node_modules to give us a relative import.

novemberborn · 2023-06-21T15:33:26Z

I can't find any place that serialize config in any way?

You're right, it was not explicit. With worker threads we already relied on "advanced" serialization and I've pushed a commit to enable that for child processes as well. Plus tests.

I also figured out a way to load regular dependencies, by writing a file into node_modules from which we can then do the import().

I think this is now mostly compatible with AVA 5, except for the invocation of the default export which is new and could still have surprising side-effects.

novemberborn · 2023-06-21T16:03:31Z

@sculpt0r let me know what you think of my changes! main has now dropped Node.js 14 so this can be merged.

sculpt0r · 2023-06-26T09:35:55Z

@novemberborn - sorry for being late... As I can see - the PR is already 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://github.com/avajs/ava)) | [`^5.3.1` -> `^6.0.0`](https://renovatebot.com/diffs/npm/ava/5.3.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.3.1/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/ava/5.3.1/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>avajs/ava (ava)</summary> ### [`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. --- - [ ] 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/toeverything/AFFiNE).

[![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://github.com/avajs/ava)) | [`^5.3.1` -> `^6.0.0`](https://renovatebot.com/diffs/npm/ava/5.3.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.3.1/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/ava/5.3.1/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>avajs/ava (ava)</summary> ### [`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. --- - [ ] 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/toeverything/AFFiNE).

[![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://github.com/avajs/ava)) | [`5.3.1` -> `6.1.3`](https://renovatebot.com/diffs/npm/ava/5.3.1/6.1.3) | [![age](https://developer.mend.io/api/mc/badges/age/npm/ava/6.1.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/ava/6.1.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/ava/5.3.1/6.1.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/ava/5.3.1/6.1.3?slim=true)](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. --- - [ ] 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>

sculpt0r force-pushed the t/1666 branch from 51f8c95 to 95f2f52 Compare March 9, 2023 22:27

novemberborn reviewed Mar 12, 2023

View reviewed changes

sculpt0r force-pushed the t/1666 branch from c83d156 to 7000e15 Compare March 13, 2023 17:05

novemberborn reviewed Mar 14, 2023

View reviewed changes

sculpt0r requested a review from novemberborn March 17, 2023 19:11

novemberborn reviewed Mar 21, 2023

View reviewed changes

sculpt0r force-pushed the t/1666 branch from 7223a74 to aace491 Compare March 27, 2023 06:41

sculpt0r force-pushed the t/1666 branch from aace491 to bbc59d7 Compare May 15, 2023 06:43

sculpt0r commented May 16, 2023

View reviewed changes

novemberborn changed the title ~~feat: handle complex options.require config property~~ Modernize require config May 21, 2023

novemberborn added the breaking requires a SemVer major release label May 21, 2023

novemberborn marked this pull request as draft May 21, 2023 16:33

novemberborn mentioned this pull request May 21, 2023

Support arguments in "require" configuration #1666

Closed

sculpt0r commented May 22, 2023

View reviewed changes

sculpt0r added 2 commits June 16, 2023 12:42

feat: handle complex options.require config property

246b8b5

feat: handle call function from loaded option.require

b6f93cd

- call directly - fallback to `default`

novemberborn and others added 3 commits June 16, 2023 12:42

Collect multiple options

5592ebc

Modernize & fix tests

0b4317b

* Resolve from the project directory by joining paths, this means you can only provide relative files and not dependencies, which is a breaking change * Remove Babel recipe since it's now incompatible * Fix tests and add additional cases * Some refactoring

test(refactor): renamed test case

29e401b

sculpt0r force-pushed the t/1666 branch from 648758a to 29e401b Compare June 16, 2023 10:44

novemberborn added 6 commits June 19, 2023 17:22

Add test for argument serialization

b88c6df

Use advanced serialization for child processes

db50d30

This means options are (de)serialized the same way as with worker threads, enabling us to use maps etc for require arguments.

Merge remote-tracking branch 'origin/main' into t/1666

1c28e20

Document that local files are loaded through providers

36bb935

Document use of structured clone

345bc31

Regain ability to require dependencies

0ff6c93

Write a file into node_modules to give us a relative import.

novemberborn added 3 commits June 21, 2023 17:36

Fix linting issues

2c5635e

Hopefully make it work on Windows

6b5ce30

Merge branch 'main' into t/1666

808121c

novemberborn marked this pull request as ready for review June 21, 2023 16:03

novemberborn merged commit 4dc385b into avajs:main Jun 25, 2023

sculpt0r deleted the t/1666 branch June 26, 2023 09:35

This was referenced Jul 3, 2023

Resolve "require" modules relative to project directory #2985

Closed

Use serialization option for child process communication #2298

Closed

This was referenced Jun 20, 2024

[Snyk] Upgrade ava from 3.15.0 to 6.1.3 YoutacRandS-VA/fetch-charset-detection#5

Open

[Snyk] Upgrade ava from 5.3.1 to 6.1.3 YoutacRandS-VA/btoa-lite#1

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Modernize `require` config #3184

Modernize `require` config #3184

sculpt0r commented Mar 9, 2023 •

edited

Loading

novemberborn left a comment

novemberborn Mar 12, 2023

sculpt0r Mar 12, 2023

sculpt0r commented Mar 13, 2023 •

edited

Loading

novemberborn Mar 14, 2023

novemberborn commented Mar 14, 2023

sculpt0r commented Mar 15, 2023

novemberborn left a comment

novemberborn Mar 21, 2023

novemberborn Mar 21, 2023

sculpt0r commented Apr 14, 2023

novemberborn commented Apr 14, 2023

sculpt0r commented May 5, 2023

sculpt0r commented May 15, 2023

sculpt0r May 16, 2023

novemberborn May 21, 2023

novemberborn commented May 21, 2023

novemberborn commented May 21, 2023

sculpt0r May 22, 2023

novemberborn May 22, 2023

sculpt0r May 22, 2023

novemberborn May 25, 2023

sculpt0r commented May 22, 2023

novemberborn commented May 24, 2023

sculpt0r commented May 25, 2023

novemberborn commented May 25, 2023

sculpt0r commented Jun 16, 2023

sculpt0r commented Jun 17, 2023

novemberborn commented Jun 21, 2023

novemberborn commented Jun 21, 2023

sculpt0r commented Jun 26, 2023

	await loadedModule.apply(...options);
	await loadedModule(...options);

	await loadedModule.default.apply(...options);
	const {default: fn} = loadedModule;
	await fn(...options);

Modernize require config #3184

Modernize require config #3184

Conversation

sculpt0r commented Mar 9, 2023 • edited Loading

Referenced issues

novemberborn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sculpt0r commented Mar 13, 2023 • edited Loading

Choose a reason for hiding this comment

novemberborn commented Mar 14, 2023

sculpt0r commented Mar 15, 2023

novemberborn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sculpt0r commented Apr 14, 2023

novemberborn commented Apr 14, 2023

sculpt0r commented May 5, 2023

sculpt0r commented May 15, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

novemberborn commented May 21, 2023

novemberborn commented May 21, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sculpt0r commented May 22, 2023

novemberborn commented May 24, 2023

sculpt0r commented May 25, 2023

novemberborn commented May 25, 2023

sculpt0r commented Jun 16, 2023

sculpt0r commented Jun 17, 2023

novemberborn commented Jun 21, 2023

novemberborn commented Jun 21, 2023

sculpt0r commented Jun 26, 2023

Modernize `require` config #3184

Modernize `require` config #3184

sculpt0r commented Mar 9, 2023 •

edited

Loading

sculpt0r commented Mar 13, 2023 •

edited

Loading