Skip to content

Commit

Permalink
docs: add section about mocking methods inside the same file (#4611)
Browse files Browse the repository at this point in the history
Co-authored-by: Anjorin Damilare <damilareanjorin1@gmail.com>
  • Loading branch information
sheremet-va and dammy001 committed Nov 29, 2023
1 parent 64c3ec7 commit 2ff3533
Showing 1 changed file with 56 additions and 0 deletions.
56 changes: 56 additions & 0 deletions docs/guide/mocking.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,62 @@ The following principles apply
* All objects will be deeply cloned
* All instances of classes and their prototypes will be deeply cloned

### Mocking Pitfalls

Beware that it is not possible to mock calls to methods that are called inside other methods of the same file. For example, in this code:

```ts
export function foo() {
return 'foo'
}

export function foobar() {
return `${foo()}bar`
}
```

It is not possible to mock the `foo` method from the outside because it is referenced directly. So this code will have no effect on the `foo` call inside `foobar` (but it will affect the `foo` call in other modules):

```ts
import { vi } from 'vitest'
import * as mod from './foobar.js'

// this will only affect "foo" outside of the original module
vi.spyOn(mod, 'foo')
vi.mock('./foobar.js', async (importOriginal) => {
return {
...await importOriginal(),
// this will only affect "foo" outside of the original module
foo: () => 'mocked'
}
})
```

You can confirm this behaviour by providing the implementation to the `foobar` method directly:

```ts
// foobar.test.js
import * as mod from './foobar.js'

vi.spyOn(mod, 'foo')

// exported foo references mocked method
mod.foobar(mod.foo)
```

```ts
// foobar.js
export function foo() {
return 'foo'
}

export function foobar(injectedFoo) {
return injectedFoo !== foo // false
}
```

This is the intended behaviour. It is usually a sign of bad code when mocking is involved in such a manner. Consider refactoring your code into multiple files or improving your application architecture by using techniques such as [dependency injection](https://en.wikipedia.org/wiki/Dependency_injection).

### Example

```js
Expand Down

0 comments on commit 2ff3533

Please sign in to comment.