Support message testing function in throws & throwsAsync assertions

[il3ven]

Fixes #2978

As per the issue #2978, I have added support for function in throws/throwsAsync assertion. I have also updated the docs regarding the same. I couldn't find any tests to be updated so I have left them.

How to use?

await t.throwsAsync(async () => {
	throw new TypeError('🦄');
}, {
	message: message => ['🦄', '🐴'].includes(message)
});

Note: This is my first PR in ava so I may have missed something. Please let me know. I will fix it. For example, I am not sure about the assertion message to show in case of failure.

[sindresorhus]

You also need to update the TypeScript types.

Addressed

[novemberborn]

@il3ven the code looks great, but it seems some tests are not passing.

[il3ven]

@novemberborn I have fixed the test in test-tap/assert.js. The pipeline also passes now. However there is one test that fails in my local system. I could not debug the issue with that test. The same test also fails in the main branch. Does this also happen on your system? If no, then we can forget about the issue and move on.

Steps to reproduce

• Run npx tap test-tap/api.js
• Observe the assert at line#154 fail in case of opts.workerThread == true

Error output in my system

$ npx tap test-tap/api.js 

​ FAIL ​ test-tap/api.js
 ✖ should be equal

  --- expected    
  +++ actual      
  @@ -1,1 +1,1 @@ 
  -1              
  +2              

  test: "test-tap/api.js fail-fast mode - workerThreads: true - multiple files &
    interrupt"
  at:
    line: 154
    column: 5
    file: file:///Users/vaibhav/repos/il3ven/temp-ava/test-tap/api.js
    type: Test
  stack: |
    Test.<anonymous> (file://test-tap/api.js:154:5)

​ FAIL ​ test-tap/api.js 1 failed of 128 1m
 ✖ should be equal

​

                         
  🌈 SUMMARY RESULTS 🌈  
                         
​ FAIL ​ test-tap/api.js 1 failed of 128 1m
 ✖ should be equal

​
Suites:   ​1 failed​, ​1 of 1 completed​
Asserts:  ​​​1 failed​, ​127 passed​, ​of 128​
​Time:​   ​1m​

My Machine
OS: MacOS 12.3.1
Node: v14.18.2

[novemberborn]

However there is one test that fails in my local system. I could not debug the issue with that test.

Yea I think that test is flaky, no worries.

[novemberborn]

@il3ven sorry I was AFK for nearly two weeks :) Test pass now, but it strikes me there's no test for the new behavior?

[il3ven]

@il3ven sorry I was AFK for nearly two weeks :)

No problem.

Test pass now, but it strikes me there's no test for the new behavior?

I will add them. Can you provide the files where these tests should be added? Or maybe point me to existing tests for the throwsAsync function.

[novemberborn]

IIRC it's all in https://github.com/il3ven/ava/blob/throws/test-tap/assert.js#L915=.

[il3ven]

@novemberborn I have added test cases to cover the code that I added. I have also added a few more cases to cover similar code which was uncovered before.

I haven't added a test case for throwsAsync because the same code is being used both in throws and throwsAsync. Let me know if I need to add it separately.

[novemberborn]

@il3ven this is great!

The additional test cases would be nice to communicate intent, but then again it's a massive test file that we haven't ported to be self-hosted, so I'm not too concerned about that.