nock 13.0.1 → 13.0.5

package/README.md

@@ -86,7 +86,7 @@ For instance, if a module performs HTTP requests to a CouchDB server or makes HT
   - [Usage](#usage-1)
     - [Options](#options-1)
       - [Example](#example)
-    - [Modes](#modes)
+  - [Modes](#modes)
 - [Common issues](#common-issues)
   - [Axios](#axios)
   - [Memory issues with Jest](#memory-issues-with-jest)
@@ -376,7 +376,7 @@ const scope = nock('http://www.google.com')
 In Nock 11.x it was possible to invoke `.reply()` with a status code and a
 function that returns an array containing a status code and body. (The status
 code from the array would take precedence over the one passed directly to
-reply.) This is no longer allowed. In 12.x, either call `.reply()` with a
+reply.) This is no longer allowed. In Nock 12 and later, either call `.reply()` with a
 status code and a function that returns the body, or call it with a single
 argument: a function that returns an array containing both the status code and
 body.
@@ -574,7 +574,7 @@ const scope = nock('http://www.headdy.com')
 
 #### Including Content-Length Header Automatically
 
-When using `scope.reply()` to set a response body manually, you can have the
+When using `interceptor.reply()` to set a response body manually, you can have the
 `Content-Length` header calculated automatically.
 
 ```js
@@ -634,7 +634,6 @@ You are able to specify a non-standard port like this:
 
 ```js
 const scope = nock('http://my.server.com:8081')
-  ...
 ```
 
 ### Repeat response n times
@@ -1064,7 +1063,7 @@ You can bypass Nock completely by setting the `NOCK_OFF` environment variable to
 
 This way you can have your tests hit the real servers just by switching on this environment variable.
 
-```js
+```shell script
 $ NOCK_OFF=true node my_test.js
 ```
 
@@ -1304,10 +1303,10 @@ nock.removeInterceptor({
 
 ```js
 nock.removeInterceptor({
-  hostname : 'localhost',
-  path : '/login'
-  method: 'POST'
-  proto : 'https'
+  hostname: 'localhost',
+  path: '/login',
+  method: 'POST',
+  proto: 'https',
 })
 ```
 
@@ -1389,11 +1388,9 @@ nockBack('zomboFixture.json', nockDone => {
 If your tests are using promises then use `nockBack` like this:
 
 ```js
-return nockBack('promisedFixture.json')
-  .then(({ nockDone, context }) => {
-    //  do your tests returning a promise and chain it with
-    //  `.then(nockDone)`
-  })
+return nockBack('promisedFixture.json').then(({ nockDone, context }) => {
+  //  do your tests returning a promise and chain it with
+  //  `.then(nockDone)`
 })
 ```
 
@@ -1411,7 +1408,7 @@ As an optional second parameter you can pass the following options
 ```js
 function prepareScope(scope) {
   scope.filteringRequestBody = (body, aRecordedBody) => {
-    if (typeof(body) !== 'string' || typeof(aRecordedBody) !== 'string') {
+    if (typeof body !== 'string' || typeof aRecordedBody !== 'string') {
       return body
     }
 
@@ -1428,15 +1425,15 @@ function prepareScope(scope) {
   }
 }
 
-nockBack('zomboFixture.json', { before: prepareScope }, nockDone => {
-  request.get('http://zombo.com', function(err, res, body) {
+nockBack('exampleFixture.json', { before: prepareScope }, nockDone => {
+  request.get('http://example.com', function (err, res, body) {
     // do your tests
     nockDone()
-  }
-}
+  })
+})
 ```
 
-#### Modes
+### Modes
 
 To set the mode call `nockBack.setMode(mode)` or run the tests with the `NOCK_BACK_MODE` environment variable set before loading nock. If the mode needs to be changed programmatically, the following is valid: `nockBack.setMode(nockBack.currentMode)`
 

package/lib/common.js

@@ -548,8 +548,15 @@ function urlToOptions(url) {
  *  - The expected data can use regexp to compare values
  *  - JSON path notation and nested objects are considered equal
  */
-const dataEqual = (expected, actual) =>
-  deepEqual(expand(expected), expand(actual))
+const dataEqual = (expected, actual) => {
+  if (isPlainObject(expected)) {
+    expected = expand(expected)
+  }
+  if (isPlainObject(actual)) {
+    actual = expand(actual)
+  }
+  return deepEqual(expected, actual)
+}
 
 /**
  * Converts flat objects whose keys use JSON path notation to nested objects.
@@ -573,17 +580,20 @@ function deepEqual(expected, actual) {
     return expected.test(actual)
   }
 
-  if (Array.isArray(expected) || isPlainObject(expected)) {
-    if (actual === undefined) {
+  if (Array.isArray(expected) && Array.isArray(actual)) {
+    if (expected.length !== actual.length) {
       return false
     }
 
-    const expKeys = Object.keys(expected)
-    if (expKeys.length !== Object.keys(actual).length) {
-      return false
-    }
+    return expected.every((expVal, idx) => deepEqual(expVal, actual[idx]))
+  }
+
+  if (isPlainObject(expected) && isPlainObject(actual)) {
+    const allKeys = Array.from(
+      new Set(Object.keys(expected).concat(Object.keys(actual)))
+    )
 
-    return expKeys.every(key => deepEqual(expected[key], actual[key]))
+    return allKeys.every(key => deepEqual(expected[key], actual[key]))
   }
 
   return expected === actual

package/lib/intercepted_request_router.js

@@ -195,7 +195,9 @@ class InterceptedRequestRouter {
       req.once('finish', callback)
     }
 
-    req.write(chunk, encoding)
+    if (chunk) {
+      req.write(chunk, encoding)
+    }
     req.finished = true
     this.maybeStartPlayback()
 
@@ -295,6 +297,8 @@ class InterceptedRequestRouter {
         'interceptor identified, starting mocking'
       )
 
+      matchedInterceptor.markConsumed()
+
       // wait to emit the finish event until we know for sure an Interceptor is going to playback.
       // otherwise an unmocked request might emit finish twice.
       req.emit('finish')

package/lib/playback_interceptor.js

@@ -124,8 +124,6 @@ function playbackInterceptor({
   const { logger } = interceptor.scope
 
   function start() {
-    interceptor.markConsumed()
-    interceptor.req = req
     req.headers = req.getHeaders()
 
     interceptor.scope.emit('request', req, interceptor, requestBodyString)
@@ -151,6 +149,13 @@ function playbackInterceptor({
     response.rawHeaders = [...interceptor.rawHeaders]
     logger('response.rawHeaders:', response.rawHeaders)
 
+    // TODO: MAJOR: Don't tack the request onto the interceptor.
+    // The only reason we do this is so that it's available inside reply functions.
+    // It would be better to pass the request as an argument to the functions instead.
+    // Not adding the req as a third arg now because it should first be decided if (path, body, req)
+    // is the signature we want to go with going forward.
+    interceptor.req = req
+
     if (interceptor.replyFunction) {
       const parsedRequestBody = parseJSONRequestBody(req, requestBodyString)
 

package/lib/scope.js

@@ -331,7 +331,7 @@ function define(nockDefs) {
     let response
     if (!nockDef.response) {
       response = ''
-      // TODO: Rename `responseIsBinary` to `reponseIsUtf8Representable`.
+      // TODO: Rename `responseIsBinary` to `responseIsUtf8Representable`.
     } else if (nockDef.responseIsBinary) {
       response = Buffer.from(nockDef.response, 'hex')
     } else {

package/package.json

@@ -7,7 +7,7 @@
     "testing",
     "isolation"
   ],
-  "version": "13.0.1",
+  "version": "13.0.5",
   "author": "Pedro Teixeira <pedro.teixeira@gmail.com>",
   "repository": {
     "type": "git",
@@ -32,15 +32,16 @@
     "assert-rejects": "^1.0.0",
     "chai": "^4.1.2",
     "dirty-chai": "^2.0.1",
-    "dtslint": "^3.0.0",
+    "dtslint": "^4.0.4",
     "eslint": "^7.3.1",
     "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-mocha": "^8.0.0",
     "eslint-plugin-node": "^11.0.0",
     "eslint-plugin-promise": "^4.1.1",
     "eslint-plugin-standard": "^4.0.0",
+    "form-data": "^3.0.0",
     "got": "^11.3.0",
     "mocha": "^8.0.1",
     "npm-run-all": "^4.1.5",
@@ -52,7 +53,7 @@
     "semantic-release": "^17.0.2",
     "sinon": "^9.0.0",
     "sinon-chai": "^3.3.0",
-    "superagent": "^5.0.2",
+    "superagent": "^6.1.0",
     "tap": "14.6.1"
   },
   "scripts": {