toHaveBeenCalledOnce expects a spy to be called multiple times

Describe the bug

When I was cutting over jest tests in vueuse to vitest, the assertions on spies for the useSwipe composable had issues with the number of calls.

In particular,

expect(onSwipe).toHaveBeenCalledOnce()

was expecting the onSwipe spy to have been called twice.

Reproduction

I wasn’t able to create a minimum reproducible issue – the issue has something to do with how the spies are invoked. When the spies are immediately invoked, there is no bug, however within the useSwipe example in vueuse, this issue shows up.

When I simply invoke the spies directly within the useSwipe (subject under test) method, the calls counter works correctly. Given that, I’m betting the issues have something to do with how addEventListener is invoking the spy.

Here’s the PR/branch with a reproduction.

1. Check out this repo
2. Run pnpm install
3. Run pnpm vitest --config vitest.config.ts useSwipe

System Info

System:
    OS: macOS 11.4
    CPU: (16) x64 Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz
    Memory: 184.71 MB / 32.00 GB
    Shell: 5.8 - /bin/zsh
  Binaries:
    Node: 14.17.0 - ~/.nvm/versions/node/v14.17.0/bin/node
    Yarn: 1.22.10 - /usr/local/bin/yarn
    npm: 6.14.13 - ~/.nvm/versions/node/v14.17.0/bin/npm
  Browsers:
    Chrome Canary: 99.0.4779.0
    Firefox: 95.0
    Safari: 14.1.1
  npmPackages:
    vite: ^2.7.3 => 2.6.7 
    vitest: ^0.0.105 => 0.0.105

Used Package Manager

pnpm

Logs

No response

Validations

• Follow our Code of Conduct
• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn’t already an issue that reports the same bug to avoid creating a duplicate.
• Check that this is a concrete bug. For Q&A open a GitHub Discussion or join our Discord Chat Server.
• The provided reproduction is a minimal reproducible example of the bug.

[Smrtnyk]

Oh, I see, you reset them manually. Maybe there is a bug with that

It s not a bug in clearing them, they were cleared properly in beforeEach. The issue was that the test 2 really called event listener twice, and number of calls was correctly 2 instead of expected 1. Have a look what test 1 and test 2 actually do, they add same event listener onto the same target, and event listener gets called twice in the end in second test.

[Smrtnyk]

nah it’s just me not used to monorepos and pnpm, My daily work took a toll at me not being in sync with all new stuff 😄 I am sure the issue is real, that is why I wanted to debug it using old good debugger and walking the callstack.