nock 11.6.0 → 11.7.0

package/README.md

@@ -58,6 +58,7 @@ For instance, if a module performs HTTP requests to a CouchDB server or makes HT
 - [Expectations](#expectations)
   - [.isDone()](#isdone)
   - [.cleanAll()](#cleanall)
+  - [.abortPendingRequests()](#abortpendingrequests)
   - [.persist()](#persist)
   - [.pendingMocks()](#pendingmocks)
   - [.activeMocks()](#activemocks)

package/lib/common.js

@@ -38,23 +38,16 @@ function normalizeRequestOptions(options) {
 }
 
 /**
- * Returns false if the data contained in buffer can be reconstructed
+ * Returns true if the data contained in buffer can be reconstructed
  * from its utf8 representation.
  *
- * TODO: Reverse the semantics of this method and refactor calling code
- * accordingly. We've inadvertently gotten it flipped.
- *
  * @param  {Object} buffer - a Buffer object
  * @returns {boolean}
  */
 function isUtf8Representable(buffer) {
-  if (!Buffer.isBuffer(buffer)) {
-    return false
-  }
-
   const utfEncodedBuffer = buffer.toString('utf8')
   const reconstructedBuffer = Buffer.from(utfEncodedBuffer, 'utf8')
-  return !reconstructedBuffer.equals(buffer)
+  return reconstructedBuffer.equals(buffer)
 }
 
 //  Array where all information about all the overridden requests are held.

package/lib/intercepted_request_router.js

@@ -30,7 +30,7 @@ class InterceptedRequestRouter {
     }
     this.interceptors = interceptors
 
-    this.socket = new Socket({ proto: options.proto })
+    this.socket = new Socket(options)
     this.response = new IncomingMessage(this.socket)
     this.playbackStarted = false
     this.requestBodyBuffers = []
@@ -231,8 +231,9 @@ class InterceptedRequestRouter {
       // Re-update `options` with the current value of `req.path` because badly
       // behaving agents like superagent like to change `req.path` mid-flight.
       path: req.path,
-      // similarly, node-http-proxy will modify headers in flight, so we have
+      // Similarly, node-http-proxy will modify headers in flight, so we have
       // to put the headers back into options.
+      // https://github.com/nock/nock/pull/1484
       headers: req.getHeaders(),
       // Fixes https://github.com/nock/nock/issues/976
       protocol: `${options.proto}:`,
@@ -245,11 +246,11 @@ class InterceptedRequestRouter {
     const requestBodyBuffer = Buffer.concat(this.requestBodyBuffers)
     // When request body is a binary buffer we internally use in its hexadecimal
     // representation.
-    const isBinaryRequestBodyBuffer = common.isUtf8Representable(
+    const requestBodyIsUtf8Representable = common.isUtf8Representable(
       requestBodyBuffer
     )
     const requestBodyString = requestBodyBuffer.toString(
-      isBinaryRequestBodyBuffer ? 'hex' : 'utf8'
+      requestBodyIsUtf8Representable ? 'utf8' : 'hex'
     )
 
     const matchedInterceptor = interceptors.find(i =>
@@ -264,7 +265,7 @@ class InterceptedRequestRouter {
         socket,
         options,
         requestBodyString,
-        isBinaryRequestBodyBuffer,
+        requestBodyIsUtf8Representable,
         response,
         interceptor: matchedInterceptor,
       })

package/lib/match_body.js

@@ -11,11 +11,8 @@ module.exports = function matchBody(options, spec, body) {
   }
 
   if (Buffer.isBuffer(spec)) {
-    if (common.isUtf8Representable(spec)) {
-      spec = spec.toString('hex')
-    } else {
-      spec = spec.toString('utf8')
-    }
+    const encoding = common.isUtf8Representable(spec) ? 'utf8' : 'hex'
+    spec = spec.toString(encoding)
   }
 
   const contentType = (

package/lib/playback_interceptor.js

@@ -80,7 +80,7 @@ function playbackInterceptor({
   socket,
   options,
   requestBodyString,
-  isBinaryRequestBodyBuffer,
+  requestBodyIsUtf8Representable,
   response,
   interceptor,
 }) {
@@ -178,10 +178,10 @@ function playbackInterceptor({
     // will eventually be JSON stringified.
     let responseBody = interceptor.body
 
-    // If the request was binary then we assume that the response will be binary
-    // as well. In that case we send the response as a Buffer object as that's
-    // what the client will expect.
-    if (isBinaryRequestBodyBuffer && typeof responseBody === 'string') {
+    // If the request was not UTF8-representable then we assume that the
+    // response won't be either. In that case we send the response as a Buffer
+    // object as that's what the client will expect.
+    if (!requestBodyIsUtf8Representable && typeof responseBody === 'string') {
       // Try to create the buffer from the interceptor's body response as hex.
       responseBody = Buffer.from(responseBody, 'hex')
 

package/lib/recorder.js

@@ -21,9 +21,9 @@ function getMethod(options) {
 }
 
 function getBodyFromChunks(chunks, headers) {
-  //  If we have headers and there is content-encoding it means that
-  //  the body shouldn't be merged but instead persisted as an array
-  //  of hex strings so that the responses can be mocked one by one.
+  // If we have headers and there is content-encoding it means that the body
+  // shouldn't be merged but instead persisted as an array of hex strings so
+  // that the response chunks can be mocked one by one.
   if (headers && common.isContentEncoded(headers)) {
     return {
       body: chunks.map(chunk => chunk.toString('hex')),
@@ -32,30 +32,29 @@ function getBodyFromChunks(chunks, headers) {
 
   const mergedBuffer = Buffer.concat(chunks)
 
-  //  The merged buffer can be one of three things:
-  //    1.  A binary buffer which then has to be recorded as a hex string.
-  //    2.  A string buffer which represents a JSON object.
-  //    3.  A string buffer which doesn't represent a JSON object.
-
-  const isBinary = common.isUtf8Representable(mergedBuffer)
-  if (isBinary) {
-    return {
-      body: mergedBuffer.toString('hex'),
-      isBinary: true,
-    }
-  } else {
+  // The merged buffer can be one of three things:
+  // 1. A UTF-8-representable string buffer which represents a JSON object.
+  // 2. A UTF-8-representable buffer which doesn't represent a JSON object.
+  // 3. A non-UTF-8-representable buffer which then has to be recorded as a hex string.
+  const isUtf8Representable = common.isUtf8Representable(mergedBuffer)
+  if (isUtf8Representable) {
     const maybeStringifiedJson = mergedBuffer.toString('utf8')
     try {
       return {
+        isUtf8Representable,
         body: JSON.parse(maybeStringifiedJson),
-        isBinary: false,
       }
     } catch (err) {
       return {
+        isUtf8Representable,
         body: maybeStringifiedJson,
-        isBinary: false,
       }
     }
+  } else {
+    return {
+      isUtf8Representable,
+      body: mergedBuffer.toString('hex'),
+    }
   }
 }
 
@@ -67,28 +66,26 @@ function generateRequestAndResponseObject({
   dataChunks,
   reqheaders,
 }) {
-  const response = getBodyFromChunks(dataChunks, res.headers)
+  const { body, isUtf8Representable } = getBodyFromChunks(
+    dataChunks,
+    res.headers
+  )
   options.path = req.path
 
-  const nockDef = {
+  return {
     scope: getScope(options),
     method: getMethod(options),
     path: options.path,
+    // Is it deliberate that `getBodyFromChunks()` is called a second time?
     body: getBodyFromChunks(bodyChunks).body,
     status: res.statusCode,
-    response: response.body,
+    response: body,
     rawHeaders: res.rawHeaders,
+    reqheaders: reqheaders || undefined,
+    // When content-encoding is enabled, isUtf8Representable is `undefined`,
+    // so we explicitly check for `false`.
+    responseIsBinary: isUtf8Representable === false,
   }
-
-  if (reqheaders) {
-    nockDef.reqheaders = reqheaders
-  }
-
-  if (response.isBinary) {
-    nockDef.responseIsBinary = true
-  }
-
-  return nockDef
 }
 
 function generateRequestAndResponse({

package/lib/scope.js

@@ -347,11 +347,12 @@ function define(nockDefs) {
       body = undefined
     }
 
-    //  Response is not always JSON as it could be a string or binary data or
-    //  even an array of binary buffers (e.g. when content is encoded)
+    // Response is not always JSON as it could be a string or binary data or
+    // even an array of binary buffers (e.g. when content is encoded).
     let response
     if (!nockDef.response) {
       response = ''
+      // TODO: Rename `responseIsBinary` to `reponseIsUtf8Representable`.
     } else if (nockDef.responseIsBinary) {
       response = Buffer.from(nockDef.response, 'hex')
     } else {

package/lib/socket.js

@@ -12,8 +12,10 @@ module.exports = class Socket extends EventEmitter {
       this.authorized = true
     }
 
+    this.bufferSize = 0
     this.writable = true
     this.readable = true
+    this.pending = false
     this.destroyed = false
     this.connecting = false
 
@@ -23,13 +25,27 @@ module.exports = class Socket extends EventEmitter {
     this.totalDelayMs = 0
     // Maximum allowed delay. Null means unlimited.
     this.timeoutMs = null
+
+    const ipv6 = options.family === 6
+    this.remoteFamily = ipv6 ? 'IPv6' : 'IPv4'
+    this.localAddress = this.remoteAddress = ipv6 ? '::1' : '127.0.0.1'
+    this.localPort = this.remotePort = parseInt(options.port)
   }
 
   setNoDelay() {}
   setKeepAlive() {}
   resume() {}
+  ref() {}
   unref() {}
 
+  address() {
+    return {
+      port: this.remotePort,
+      family: this.remoteFamily,
+      address: this.remoteAddress,
+    }
+  }
+
   setTimeout(timeoutMs, fn) {
     this.timeoutMs = timeoutMs
     if (fn) {

package/package.json

@@ -7,7 +7,7 @@
     "testing",
     "isolation"
   ],
-  "version": "11.6.0",
+  "version": "11.7.0",
   "author": "Pedro Teixeira <pedro.teixeira@gmail.com>",
   "repository": {
     "type": "git",
@@ -31,28 +31,30 @@
   },
   "devDependencies": {
     "assert-rejects": "^1.0.0",
+    "dirty-chai": "^2.0.1",
     "dtslint": "^0.9.1",
     "eslint": "^6.0.0",
     "eslint-config-prettier": "^6.0.0",
     "eslint-config-standard": "^14.0.0",
     "eslint-plugin-import": "^2.16.0",
+    "eslint-plugin-mocha": "^6.2.0",
     "eslint-plugin-node": "^10.0.0",
     "eslint-plugin-promise": "^4.1.1",
     "eslint-plugin-standard": "^4.0.0",
     "got": "^9.6.0",
-    "hyperquest": "^2.1.3",
     "isomorphic-fetch": "^2.2.0",
     "lolex": "^5.0.0",
+    "mocha": "^6.2.2",
     "needle": "^2.3.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^14.0.0",
     "prettier": "1.18.2",
     "proxyquire": "^2.1.0",
     "request": "^2.83.0",
-    "restify-clients": "^2.2.0",
     "rimraf": "^3.0.0",
     "semantic-release": "^16.0.0-beta.22",
-    "sinon": "^7.3.1",
+    "sinon": "^7.5.0",
+    "sinon-chai": "^3.3.0",
     "superagent": "^5.0.2",
     "tap": "^14.0.0"
   },
@@ -62,6 +64,7 @@
     "test": "npm run -s unit",
     "posttest": "npm run -s prettier:check",
     "coverage": "tap --coverage-report=html && open coverage/lcov-report/index.html",
+    "mocha": "nyc mocha $(grep -lr '^\\s*it(' tests)",
     "lint": "eslint \"**/*.js\"",
     "prettier": "prettier --write \"**/*.@(js|json|md|ts|yml)\"",
     "prettier:check": "prettier --check \"**/*.@(js|json|md|ts|yml)\"",

package/types/index.d.ts

@@ -244,6 +244,7 @@ declare namespace nock {
   type BackMode = 'wild' | 'dryrun' | 'record' | 'lockdown'
 
   interface Back {
+    currentMode: BackMode
     fixtures: string
     setMode(mode: BackMode): void