Is it really necessary to use isDone()/done()?

[mcometa]

I use nock a lot in my React testing and one thing I noticed is that there's no real convention in mock or best practices as to how you properly nock mock an API request. So, I need some help regarding this simple question - is using scope.done() or nock.isDone() or .done() really necessary? Is there a real benefit as to using it while in test aside from making sure that your mock requests get resolved mocked (and finished/"done") by nock? What am I not seeing that nock is doing behind the scenes?

Thanks~

[paulmelnikow]

Is there a real benefit as to using it while in test aside from making sure that your mock requests get resolved mocked (and finished/"done") by nock?

That's it exactly!

By the way, there's some discussion on improving the "lifecycle methods" in #1753. I'd like to add a function that checks that all the mocks have been fulfilled.

[mastermatt]

In test suites that have zero live-outbound traffic, I personally don't find myself using the isDone/done in isolated tests. Instead I use a global afterEach hook that calls pendingMocks and fails the test with verbiage if any mocks are returned.
It's the same effect, ensuring all declared mocks are used, but reduces boilerplate in the individual tests.

[mcometa]

Thank you guys for the responses. Both are helpful!

[nestor-lobo-work]

ou guys for the responses. Both

Is there a real benefit as to using it while in test aside from making sure that your mock requests get resolved mocked (and finished/"done") by nock?

That's it exactly!

By the way, there's some discussion on improving the "lifecycle methods" in #1753. I'd like to add a function that checks that all the mocks have been fulfilled.
Kinda of late, but trying to shed some light...

As per docs, done method will throw an exception if it has an interceptor for that scope was not called, basically if any pending mock not used, so it validates that expected interceptions were called.
I call done as a good practice on the tear down of each test, to be sure that ALL interceptors defined as expectation were called and throw an exception, avoiding hidden issues because something was not called and it was expected

On the other hand, isDone property will just return true or false depending if all interceptors defined were used (always in the context of each scope nock),
If there is a postcondition in the test case, I add a isDone assertion check before the tear down test case stage

Hope this helps others