feat(socket): propagate errors from destroy method (#1675)

Filippo Conti · mastermatt · commit de9c40be64da · 2019-08-19T19:38:32.000-06:00
Calling `destroy` on the the response, with an error, not correctly propagates through the socket and then the request object. This aligns with Node's native functionality. Fixes: #1669
diff --git a/lib/request_overrider.js b/lib/request_overrider.js
@@ -124,7 +124,7 @@ class InterceptedRequestHandler {
     this.response.socket = this.response.client = this.response.connection =
       req.socket
 
-    propagate(['timeout'], req.socket, req)
+    propagate(['error', 'timeout'], req.socket, req)
 
     req.write = (...args) => this.handleWrite(...args)
     req.end = (...args) => this.handleEnd(...args)
diff --git a/lib/socket.js b/lib/socket.js
@@ -54,8 +54,12 @@ module.exports = class Socket extends EventEmitter {
     ).toString('base64')
   }
 
-  destroy() {
+  destroy(err) {
     this.destroyed = true
     this.readable = this.writable = false
+    if (err) {
+      this.emit('error', err)
+    }
+    return this
   }
 }
diff --git a/tests/test_destroy.js b/tests/test_destroy.js
@@ -0,0 +1,43 @@
+'use strict'
+
+const nock = require('..')
+const http = require('http')
+const { test } = require('tap')
+
+require('./cleanup_after_each')()
+
+test('req.destroy should emit error event if called with error', t => {
+  nock('http://example.test')
+    .get('/')
+    .reply(404)
+
+  http
+    .get('http://example.test/', res => {
+      if (res.statusCode !== 200) {
+        res.destroy(new Error('Response error'))
+      }
+    })
+    .once('error', err => {
+      t.type(err, Error)
+      t.equal(err.message, 'Response error')
+      t.end()
+    })
+})
+
+test('req.destroy should not emit error event if called without error', t => {
+  nock('http://example.test')
+    .get('/')
+    .reply(403)
+
+  http
+    .get('http://example.test/', res => {
+      if (res.statusCode === 403) {
+        res.destroy()
+      }
+
+      t.end()
+    })
+    .once('error', () => {
+      t.fail('should not emit error')
+    })
+})

Original file line number	Diff line number	Diff line change
`@@ -54,8 +54,12 @@ module.exports = class Socket extends EventEmitter {`
`54`	`54`	`).toString('base64')`
`55`	`55`	`}`
`56`	`56`
`57`		`- destroy() {`
	`57`	`+ destroy(err) {`
`58`	`58`	`this.destroyed = true`
`59`	`59`	`this.readable = this.writable = false`
	`60`	`+ if (err) {`
	`61`	`+ this.emit('error', err)`
	`62`	`+ }`
	`63`	`+ return this`
`60`	`64`	`}`
`61`	`65`	`}`