fix: address timeout issue with mocked timers (Revert #2880) (#2902)

This reverts commit fb112f3.

Author: leon19

.eslintrc.yml

@@ -22,10 +22,6 @@ overrides:
       mocha: true
     rules:
       mocha/no-exclusive-tests: 'error'
-  - files:
-      - 'tests_jest/**/*.js'
-    globals:
-      jest: true
 
 rules:
   # TODO These are included in standard and should be cleaned up and turned on.

README.md

@@ -91,7 +91,6 @@ 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)
@@ -1614,86 +1613,6 @@ 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:*`.

lib/common.js

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

tests/got/test_fake_timer.js

@@ -9,11 +9,7 @@ it('should still return successfully when fake timer is enabled', async () => {
   const clock = fakeTimers.install()
   const scope = nock('http://example.test').get('/').reply()
 
-  const promise = got('http://example.test')
-
-  await clock.runAllAsync() // Run all fake timers to ensure all scheduled tasks are executed
-
-  await promise
+  await got('http://example.test')
 
   clock.uninstall()
   scope.done()

tests/got/test_reply_headers.js

@@ -427,7 +427,7 @@ describe('`replyDate()`', () => {
       const scope = nock('http://example.test').replyDate().get('/').reply()
 
       const req = got('http://example.test/')
-      await clock.runAllAsync()
+      clock.tick()
       const { headers } = await req
       const date = new Date()
       expect(headers).to.include({ date: date.toUTCString() })