Sporadic test failures when running hardhat test due to incorrect usage of chai matchers when hardhat >= 2.21.0

[gzliudan]

Version of Hardhat

=2.21.0

What happened?

• pass all tests when hardhat < 2.21.0
• fail some tests when hardhat >= 2.21.0

Minimal reproduction steps

git clone https://github.com/gzliudan/MatrixProtocol.git
cd MatrixProtocol
# setup hardhat's version in package.json 
yarn
yarn make

The test will cost about 10 minutes.

Search terms

No response

[Wodann]

This is not a bug in Hardhat but a result of incorrect usage of mocha + chai. Multiple promises were running in the background, resulting in parallel execution of test assertions. This results in the sporadic failures displayed when I tested your repository.

I fixed the problem by making changes to your tests. After these changes, I could no longer reproduce the sporadic failures.

For anyone else experiencing sporadic failures when upgrading to Hardhat >= 2.21.0; please make sure that you're:

• not passing an async function or async callback to the describe function. It's only intended to be used synchronously, even though it silently accepts async callbacks (also see this issue)
• ensure you await all async calls

[gzliudan]

I test in 3 VMs with your PR, but still has some tests failed each time. My test environment:

• Ubuntu: 22.04.04
• node: v18.20.0 and v18.19.1

[gzliudan]

I fixed this problem according to your suggestions. Thanks for your kindly help again.