feat: Add lifecycle function to clear pending timeouts (#1748)

TLPcoder · paulmelnikow · commit 187db85af7a8 · 2019-10-24T10:01:27.000+01:00
Closes #1118
diff --git a/README.md b/README.md
@@ -995,6 +995,14 @@ You can cleanup all the prepared mocks (could be useful to cleanup some state af
 nock.cleanAll()
 ```
 
+### .abortPendingRequests()
+
+You can abort all current pending request like this:
+
+```js
+nock.abortPendingRequests()
+```
+
 ### .persist()
 
 You can make all the interceptors for a scope persist by calling `.persist()` on it:
diff --git a/index.js b/index.js
@@ -12,6 +12,7 @@ const {
   disableNetConnect,
   enableNetConnect,
   removeAll,
+  abortPendingRequests,
 } = require('./lib/intercept')
 const recorder = require('./lib/recorder')
 const { Scope, load, loadDefs, define } = require('./lib/scope')
@@ -35,6 +36,7 @@ Object.assign(module.exports, {
     removeAll()
     return module.exports
   },
+  abortPendingRequests,
   load,
   loadDefs,
   define,
diff --git a/lib/common.js b/lib/common.js
@@ -3,6 +3,7 @@
 const _ = require('lodash')
 const debug = require('debug')('nock.common')
 const url = require('url')
+const timers = require('timers')
 
 /**
  * Normalizes the request options so that it always has `host` property.
@@ -593,6 +594,32 @@ function deepEqual(expected, actual) {
   return expected === actual
 }
 
+const timeouts = []
+const intervals = []
+const immediates = []
+
+const wrapTimer = (timer, ids) => (...args) => {
+  const id = timer(...args)
+  ids.push(id)
+  return id
+}
+
+const setTimeout = wrapTimer(timers.setTimeout, timeouts)
+const setInterval = wrapTimer(timers.setInterval, intervals)
+const setImmediate = wrapTimer(timers.setImmediate, immediates)
+
+function clearTimer(clear, ids) {
+  while (ids.length) {
+    clear(ids.shift())
+  }
+}
+
+function removeAllTimers() {
+  clearTimer(clearTimeout, timeouts)
+  clearTimer(clearInterval, intervals)
+  clearTimer(clearImmediate, immediates)
+}
+
 exports.normalizeClientRequestArgs = normalizeClientRequestArgs
 exports.normalizeRequestOptions = normalizeRequestOptions
 exports.normalizeOrigin = normalizeOrigin
@@ -615,3 +642,7 @@ exports.matchStringOrRegexp = matchStringOrRegexp
 exports.formatQueryValue = formatQueryValue
 exports.isStream = isStream
 exports.dataEqual = dataEqual
+exports.setTimeout = setTimeout
+exports.setInterval = setInterval
+exports.setImmediate = setImmediate
+exports.removeAllTimers = removeAllTimers
diff --git a/lib/delayed_body.js b/lib/delayed_body.js
@@ -34,7 +34,7 @@ module.exports = class DelayedBody extends Transform {
 
     // TODO: This would be more readable if the stream case were moved into
     // the `if` statement above.
-    setTimeout(function() {
+    common.setTimeout(function() {
       if (common.isStream(body) && !ended) {
         body.once('end', function() {
           self.end(data)
diff --git a/lib/intercept.js b/lib/intercept.js
@@ -11,7 +11,6 @@ const http = require('http')
 const _ = require('lodash')
 const debug = require('debug')('nock.intercept')
 const globalEmitter = require('./global_emitter')
-const timers = require('timers')
 
 /**
  * @name NetConnectNotAllowedError
@@ -293,7 +292,7 @@ function overrideClientRequest() {
       if (isOff() || isEnabledForNetConnect(options)) {
         originalClientRequest.apply(this, arguments)
       } else {
-        timers.setImmediate(
+        common.setImmediate(
           function() {
             const error = new NetConnectNotAllowedError(
               options.host,
@@ -444,4 +443,5 @@ module.exports = {
   disableNetConnect,
   overrideClientRequest,
   restoreOverriddenClientRequest,
+  abortPendingRequests: common.removeAllTimers,
 }
diff --git a/lib/intercepted_request_router.js b/lib/intercepted_request_router.js
@@ -8,7 +8,6 @@ const {
 } = require('http')
 const { request: originalHttpsRequest } = require('https')
 const propagate = require('propagate')
-const timers = require('timers')
 const common = require('./common')
 const globalEmitter = require('./global_emitter')
 const Socket = require('./socket')
@@ -74,7 +73,7 @@ class InterceptedRequestRouter {
 
     // https://github.com/nock/nock/issues/256
     if (options.headers.expect === '100-continue') {
-      timers.setImmediate(() => {
+      common.setImmediate(() => {
         debug('continue')
         req.emit('continue')
       })
@@ -121,7 +120,7 @@ class InterceptedRequestRouter {
       this.emitError(new Error('Request aborted'))
     }
 
-    timers.setImmediate(function() {
+    common.setImmediate(function() {
       req.emit('drain')
     })
 
diff --git a/lib/playback_interceptor.js b/lib/playback_interceptor.js
@@ -1,7 +1,6 @@
 'use strict'
 
 const util = require('util')
-const timers = require('timers')
 const zlib = require('zlib')
 const debug = require('debug')('nock.playback_interceptor')
 const _ = require('lodash')
@@ -106,7 +105,7 @@ function playbackInterceptor({
       } else {
         error = new Error(interceptor.errorMessage)
       }
-      timers.setTimeout(() => emitError(error), interceptor.getTotalDelay())
+      common.setTimeout(() => emitError(error), interceptor.getTotalDelay())
       return
     }
 
@@ -311,13 +310,13 @@ function playbackInterceptor({
         }
 
         // Stream the response chunks one at a time.
-        timers.setImmediate(function emitChunk() {
+        common.setImmediate(function emitChunk() {
           const chunk = responseBuffers.shift()
 
           if (chunk) {
             debug('emitting response chunk')
             response.push(chunk)
-            timers.setImmediate(emitChunk)
+            common.setImmediate(emitChunk)
           } else {
             debug('ending response stream')
             response.push(null)
@@ -338,7 +337,7 @@ function playbackInterceptor({
       interceptor.delayConnectionInMs > 0
     ) {
       socket.applyDelay(interceptor.delayConnectionInMs)
-      setTimeout(respond, interceptor.delayConnectionInMs)
+      common.setTimeout(respond, interceptor.delayConnectionInMs)
     } else {
       respond()
     }
diff --git a/tests/test_common.js b/tests/test_common.js
@@ -4,6 +4,7 @@ const http = require('http')
 const { test } = require('tap')
 const common = require('../lib/common')
 const matchBody = require('../lib/match_body')
+const sinon = require('sinon')
 const nock = require('..')
 
 require('./cleanup_after_each')()
@@ -486,3 +487,21 @@ test('normalizeClientRequestArgs with a single callback', async t => {
   t.deepEqual(options, {})
   t.is(callback, cb)
 })
+
+test('testing timers are deleted correctly', t => {
+  const timeoutSpy = sinon.spy()
+  const intervalSpy = sinon.spy()
+  const immediateSpy = sinon.spy()
+
+  common.setTimeout(timeoutSpy, 0)
+  common.setInterval(intervalSpy, 0)
+  common.setImmediate(immediateSpy)
+  common.removeAllTimers()
+
+  setImmediate(() => {
+    t.equal(timeoutSpy.called, false)
+    t.equal(intervalSpy.called, false)
+    t.equal(immediateSpy.called, false)
+    t.end()
+  })
+})
diff --git a/tests/test_nock_lifecycle.js b/tests/test_nock_lifecycle.js
@@ -3,6 +3,7 @@
 const http = require('http')
 const { test } = require('tap')
 const nock = require('..')
+const sinon = require('sinon')
 const got = require('./got_client')
 
 require('./cleanup_after_each')()
@@ -182,3 +183,20 @@ test('resetting nock catastrophically while a request is in progress is handled
   t.equal(body, 'hi')
   scope.done()
 })
+
+test('abort pending request when abortPendingRequests is called', t => {
+  const reqSpy = sinon.spy()
+
+  nock('http://example.test')
+    .get('/')
+    .delayConnection(100)
+    .reply(200, 'OK')
+
+  http.get('http://example.test', reqSpy)
+
+  setTimeout(() => {
+    t.equal(reqSpy.called, false)
+    t.end()
+  }, 200)
+  process.nextTick(nock.abortPendingRequests)
+})
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -26,6 +26,7 @@ declare namespace nock {
   function loadDefs(path: string): Definition[]
   function define(defs: Definition[]): Scope[]
   function restore(): void
+  function abortPendingRequests(): void
 
   let back: Back
   let emitter: NodeJS.EventEmitter
