nock 14.0.6 → 14.0.7

package/README.md

@@ -91,6 +91,7 @@ For instance, if a module performs HTTP requests to a CouchDB server or makes HT
   - [Requests made by ES Modules are not intercepted](#requests-made-by-es-modules-are-not-intercepted)
   - [Axios](#axios)
   - [Memory issues with Jest](#memory-issues-with-jest)
+  - [Fake timers](#fake-timers)
 - [Debugging](#debugging)
 - [Contributing](#contributing)
 - [Contributors](#contributors)
@@ -1613,6 +1614,86 @@ One of the core principles of [Jest](https://jestjs.io/) is that it runs tests i
 It does this by manipulating the modules cache of Node in a way that conflicts with how Nock monkey patches the builtin `http` and `https` modules.
 [Related issue with more details](https://github.com/nock/nock/issues/1817).
 
+### Fake timers
+
+### Jest
+
+To use `nock` in conjunction with `jest` fake timers, make sure you're using the "async" functions when advancing the
+timers, such as `jest.advanceTimersByTimeAsync()` or `jest.runAllTimersAsync()`. Otherwise, the timers will not be
+advanced correctly and you'll experience a timeout in your tests.
+
+```js
+test('should mock a request with fake timers', async () => {
+  jest.useFakeTimers()
+
+  const scope = nock('https://example.com')
+    .get('/path')
+    .delay(1000)
+    .reply(200, 'response')
+
+  // Simulate a request
+  const request = got('https://example.com/path')
+
+  // Fast-forward time
+  await jest.advanceTimersByTimeAsync(1000)
+
+  // Or advance all timers
+  await jest.runAllTimersAsync()
+
+  // Wait for the request to complete
+  const response = await request
+
+  expect(response.body).toBe('response')
+  jest.useRealTimers() // Restore real timers after the test
+  scope.done()
+})
+```
+
+In case you don't need testing delays, you can instruct `jest` to advance the timers automatically using the
+`advanceTimers` option
+
+```js
+jest.useFakeTimers({ advanceTimers: true })
+```
+
+### Sinon
+
+In a similar way to `jest`, if you are using `sinon` fake timers, you should use the `clock.tickAsync()` or
+`clock.runAllAsync()` methods to advance the timers correctly.
+
+```js
+it('should us sinon timers', async () => {
+  clock = sinon.useFakeTimers()
+  const scope = nock('https://example.com')
+    .get('/path')
+    .delay(1000)
+    .reply(200, 'response')
+
+  // Simulate a request
+  const request = got('https://example.com/path')
+
+  // Fast-forward time
+  await clock.tickAsync(1000)
+
+  // Or run all timers
+  await clock.runAllAsync()
+
+  // Wait for the request to complete
+  const response = await request
+
+  expect(response.body).toBe('response')
+  clock.restore()
+  scope.done()
+})
+```
+
+Same applies for `sinon`, if you don't need testing delays, you can instruct `sinon` to advance the timers automatically
+using the `shouldAdvanceTime` option
+
+```js
+clock = sinon.useFakeTimers({ shouldAdvanceTime: true })
+```
+
 ## Debugging
 
 Nock uses node internals [`debuglog`](https://nodejs.org/api/util.html#utildebuglogsection-callbackg), so just run with environmental variable `NODE_DEBUG` set to `nock:*`.

package/lib/common.js

@@ -1,7 +1,6 @@
 'use strict'
 
 const { common: debug } = require('./debug')
-const timers = require('timers')
 const url = require('url')
 const util = require('util')
 const http = require('http')
@@ -521,24 +520,36 @@ function deepEqual(expected, actual) {
 const timeouts = new Set()
 const immediates = new Set()
 
-const wrapTimer =
-  (timer, ids) =>
-  (callback, ...timerArgs) => {
-    const cb = (...callbackArgs) => {
-      try {
-        // eslint-disable-next-line n/no-callback-literal
-        callback(...callbackArgs)
-      } finally {
-        ids.delete(id)
-      }
+const _setImmediate = (callback, ...timerArgs) => {
+  const cb = (...callbackArgs) => {
+    try {
+      // eslint-disable-next-line n/no-callback-literal
+      callback(...callbackArgs)
+    } finally {
+      immediates.delete(id)
+    }
+  }
+
+  const id = setImmediate(cb, 0, ...timerArgs)
+
+  immediates.add(id)
+  return id
+}
+
+const _setTimeout = (callback, ...timerArgs) => {
+  const cb = (...callbackArgs) => {
+    try {
+      // eslint-disable-next-line n/no-callback-literal
+      callback(...callbackArgs)
+    } finally {
+      timeouts.delete(id)
     }
-    const id = timer(cb, ...timerArgs)
-    ids.add(id)
-    return id
   }
 
-const setTimeout = wrapTimer(timers.setTimeout, timeouts)
-const setImmediate = wrapTimer(timers.setImmediate, immediates)
+  const id = setTimeout(cb, ...timerArgs)
+  timeouts.add(id)
+  return id
+}
 
 function clearTimer(clear, ids) {
   ids.forEach(clear)
@@ -714,8 +725,8 @@ module.exports = {
   percentDecode,
   percentEncode,
   removeAllTimers,
-  setImmediate,
-  setTimeout,
+  setImmediate: _setImmediate,
+  setTimeout: _setTimeout,
   stringifyRequest,
   convertFetchRequestToClientRequest,
 }

package/package.json

@@ -7,7 +7,7 @@
     "testing",
     "isolation"
   ],
-  "version": "14.0.6",
+  "version": "14.0.7",
   "author": "Pedro Teixeira <pedro.teixeira@gmail.com>",
   "repository": {
     "type": "git",