nock 13.1.4 → 13.2.3

package/README.md

@@ -1323,6 +1323,18 @@ const interceptor = nock('http://example.org').get('somePath')
 nock.removeInterceptor(interceptor)
 ```
 
+**Note** `.reply(...)` method returns Scope, not Interceptor, and so it is not a valid argument for `nock.removeInterceptor`. So if your method chain ends with `.reply` to be used with `nock.removeInterceptor` the chain need to be break in between:
+
+```js
+// this will NOT work
+const interceptor = nock('http://example.org').get('somePath').reply(200, 'OK')
+nock.removeInterceptor(interceptor)
+// this is how it should be
+const interceptor = nock('http://example.org').get('somePath')
+interceptor.reply(200, 'OK')
+nock.removeInterceptor(interceptor)
+```
+
 ## Events
 
 A scope emits the following events:
@@ -1459,6 +1471,8 @@ To set the mode call `nockBack.setMode(mode)` or run the tests with the `NOCK_BA
 
 - record: use recorded nocks, record new nocks
 
+- update: remove recorded nocks, record nocks
+
 - lockdown: use recorded nocks, disables all http calls even when not nocked, doesn't record
 
 ## Common issues
@@ -1591,6 +1605,7 @@ Thanks goes to these wonderful people ([emoji key](https://github.com/all-contri
     <td align="center"><a href="https://github.com/benrki"><img src="https://avatars0.githubusercontent.com/u/4446950?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Benjamin Ki</b></sub></a><br /><a href="#financial-benrki" title="Financial">💵</a></td>
     <td align="center"><a href="http://chadf.ca"><img src="https://avatars2.githubusercontent.com/u/3250463?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Chad Fawcett</b></sub></a><br /><a href="#financial-chadfawcett" title="Financial">💵</a></td>
     <td align="center"><a href="http://www.laurencemyers.com.au"><img src="https://avatars.githubusercontent.com/u/6336048?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Laurence Dougal Myers</b></sub></a><br /><a href="https://github.com/nock/nock/commits?author=laurence-myers" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/Beretta1979"><img src="https://avatars.githubusercontent.com/u/10073962?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sébastien Van Bruaene</b></sub></a><br /><a href="https://github.com/nock/nock/commits?author=Beretta1979" title="Code">💻</a> <a href="https://github.com/nock/nock/commits?author=Beretta1979" title="Tests">⚠️</a></td>
   </tr>
 </table>
 

package/lib/back.js

@@ -175,6 +175,47 @@ const record = {
   },
 }
 
+const update = {
+  setup: function () {
+    recorder.restore()
+    recorder.clear()
+    cleanAll()
+    activate()
+    disableNetConnect()
+  },
+
+  start: function (fixture, options) {
+    if (!fs) {
+      throw new Error('no fs')
+    }
+    const context = removeFixture(fixture)
+    recorder.record({
+      dont_print: true,
+      output_objects: true,
+      ...options.recorder,
+    })
+
+    context.isRecording = true
+
+    return context
+  },
+
+  finish: function (fixture, options, context) {
+    let outputs = recorder.outputs()
+
+    if (typeof options.afterRecord === 'function') {
+      outputs = options.afterRecord(outputs)
+    }
+
+    outputs =
+      typeof outputs === 'string' ? outputs : JSON.stringify(outputs, null, 4)
+    debug('recorder outputs:', outputs)
+
+    fs.mkdirSync(path.dirname(fixture), { recursive: true })
+    fs.writeFileSync(fixture, outputs)
+  },
+}
+
 const lockdown = {
   setup: function () {
     recorder.restore()
@@ -215,6 +256,20 @@ function load(fixture, options) {
   return context
 }
 
+function removeFixture(fixture, options) {
+  const context = {
+    scopes: [],
+    assertScopesFinished: function () {},
+  }
+
+  if (fixture && fixtureExists(fixture)) {
+    /* istanbul ignore next - fs.unlinkSync is for node 10 support */
+    fs.rmSync ? fs.rmSync(fixture) : fs.unlinkSync(fixture)
+  }
+  context.isLoaded = false
+  return context
+}
+
 function applyHook(scopes, fn) {
   if (!fn) {
     return
@@ -258,6 +313,8 @@ const Modes = {
 
   record, // use recorded nocks, record new nocks
 
+  update, // allow http calls, record all nocks, don't use recorded nocks
+
   lockdown, // use recorded nocks, disables all http calls even when not nocked, doesnt record
 }
 

package/lib/common.js

@@ -194,7 +194,7 @@ function isJSONContent(headers) {
  *
  * Duplicates throw an error.
  */
-function headersFieldNamesToLowerCase(headers) {
+function headersFieldNamesToLowerCase(headers, throwOnDuplicate) {
   if (!isPlainObject(headers)) {
     throw Error('Headers must be provided as an object')
   }
@@ -203,9 +203,15 @@ function headersFieldNamesToLowerCase(headers) {
   Object.entries(headers).forEach(([fieldName, fieldValue]) => {
     const key = fieldName.toLowerCase()
     if (lowerCaseHeaders[key] !== undefined) {
-      throw Error(
-        `Failed to convert header keys to lower case due to field name conflict: ${key}`
-      )
+      if (throwOnDuplicate) {
+        throw Error(
+          `Failed to convert header keys to lower case due to field name conflict: ${key}`
+        )
+      } else {
+        debug(
+          `Duplicate header provided in request: ${key}. Only the last value can be matched.`
+        )
+      }
     }
     lowerCaseHeaders[key] = fieldValue
   })
@@ -547,7 +553,7 @@ function urlToOptions(url) {
  * Used for comparing decoded search parameters, request body JSON objects,
  * and URL decoded request form bodies.
  *
- * Performs a general recursive strict comparision with two caveats:
+ * Performs a general recursive strict comparison with two caveats:
  *  - The expected data can use regexp to compare values
  *  - JSON path notation and nested objects are considered equal
  */
@@ -651,11 +657,13 @@ const timeouts = []
 const intervals = []
 const immediates = []
 
-const wrapTimer = (timer, ids) => (...args) => {
-  const id = timer(...args)
-  ids.push(id)
-  return id
-}
+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)

package/lib/intercepted_request_router.js

@@ -40,7 +40,10 @@ class InterceptedRequestRouter {
       // affecting the user so we use a clone of the object.
       ...options,
       // We use lower-case header field names throughout Nock.
-      headers: common.headersFieldNamesToLowerCase(options.headers || {}),
+      headers: common.headersFieldNamesToLowerCase(
+        options.headers || {},
+        false
+      ),
     }
     this.interceptors = interceptors
 
@@ -48,8 +51,12 @@ class InterceptedRequestRouter {
 
     // support setting `timeout` using request `options`
     // https://nodejs.org/docs/latest-v12.x/api/http.html#http_http_request_url_options_callback
-    if (options.timeout) {
-      this.socket.setTimeout(options.timeout)
+    // any timeout in the request options override any timeout in the agent options.
+    // per https://github.com/nodejs/node/pull/21204
+    const timeout =
+      options.timeout || (options.agent && options.agent.options.timeout)
+    if (timeout) {
+      this.socket.setTimeout(timeout)
     }
 
     this.response = new IncomingMessage(this.socket)
@@ -279,9 +286,8 @@ class InterceptedRequestRouter {
     const requestBodyBuffer = Buffer.concat(this.requestBodyBuffers)
     // When request body is a binary buffer we internally use in its hexadecimal
     // representation.
-    const requestBodyIsUtf8Representable = common.isUtf8Representable(
-      requestBodyBuffer
-    )
+    const requestBodyIsUtf8Representable =
+      common.isUtf8Representable(requestBodyBuffer)
     const requestBodyString = requestBodyBuffer.toString(
       requestBodyIsUtf8Representable ? 'utf8' : 'hex'
     )

package/lib/interceptor.js

@@ -66,7 +66,8 @@ module.exports = class Interceptor {
 
     //  We use lower-case header field names throughout Nock.
     this.reqheaders = common.headersFieldNamesToLowerCase(
-      scope.scopeOptions.reqheaders || {}
+      scope.scopeOptions.reqheaders || {},
+      true
     )
     this.badheaders = common.headersFieldsArrayToLowerCase(
       scope.scopeOptions.badheaders || []
@@ -155,7 +156,7 @@ module.exports = class Interceptor {
     )
 
     //  If the content is not encoded we may need to transform the response body.
-    //  Otherwise we leave it as it is.
+    //  Otherwise, we leave it as it is.
     if (
       body &&
       typeof body !== 'string' &&
@@ -173,10 +174,14 @@ module.exports = class Interceptor {
         // https://tools.ietf.org/html/rfc7231#section-3.1.1.5
         this.rawHeaders.push('Content-Type', 'application/json')
       }
+    }
 
-      if (this.scope.contentLen) {
-        // https://tools.ietf.org/html/rfc7230#section-3.3.2
+    if (this.scope.contentLen) {
+      // https://tools.ietf.org/html/rfc7230#section-3.3.2
+      if (typeof body === 'string') {
         this.rawHeaders.push('Content-Length', body.length)
+      } else if (Buffer.isBuffer(body)) {
+        this.rawHeaders.push('Content-Length', body.byteLength)
       }
     }
 
@@ -412,6 +417,12 @@ module.exports = class Interceptor {
   }
 
   matchHostName(options) {
+    const { basePath } = this.scope
+
+    if (basePath instanceof RegExp) {
+      return basePath.test(options.hostname)
+    }
+
     return options.hostname === this.scope.urlParts.hostname
   }
 

package/lib/playback_interceptor.js

@@ -79,7 +79,7 @@ class ReadableBuffers extends stream.Readable {
     this.buffers = buffers
   }
 
-  _read(size) {
+  _read(_size) {
     while (this.buffers.length) {
       if (!this.push(this.buffers.shift())) {
         return
@@ -315,7 +315,7 @@ function playbackInterceptor({
 
   // Calling `start` immediately could take the request all the way to the connection delay
   // during a single microtask execution. This setImmediate stalls the playback to ensure the
-  // correct events are emitted first ('socket', 'finish') and any aborts in the in the queue or
+  // correct events are emitted first ('socket', 'finish') and any aborts in the queue or
   // called during a 'finish' listener can be called.
   common.setImmediate(() => {
     if (!common.isRequestDestroyed(req)) {

package/lib/recorder.js

@@ -168,7 +168,7 @@ let currentRecordingId = 0
 const defaultRecordOptions = {
   dont_print: false,
   enable_reqheaders_recording: false,
-  logging: console.log,
+  logging: console.log, // eslint-disable-line no-console
   output_objects: false,
   use_separator: true,
 }

package/package.json

@@ -7,14 +7,14 @@
     "testing",
     "isolation"
   ],
-  "version": "13.1.4",
+  "version": "13.2.3",
   "author": "Pedro Teixeira <pedro.teixeira@gmail.com>",
   "repository": {
     "type": "git",
     "url": "https://github.com/nock/nock.git"
   },
   "bugs": {
-    "url": "http://github.com/nock/nock/issues"
+    "url": "https://github.com/nock/nock/issues"
   },
   "engines": {
     "node": ">= 10.13"
@@ -28,30 +28,29 @@
     "propagate": "^2.0.0"
   },
   "devDependencies": {
-    "@sinonjs/fake-timers": "^7.0.2",
+    "@definitelytyped/dtslint": "^0.0.103",
+    "@sinonjs/fake-timers": "^9.0.0",
     "assert-rejects": "^1.0.0",
     "chai": "^4.1.2",
     "dirty-chai": "^2.0.1",
-    "dtslint": "^4.0.4",
-    "eslint": "^7.3.1",
+    "eslint": "^8.8.0",
     "eslint-config-prettier": "^8.1.0",
-    "eslint-config-standard": "^16.0.2",
+    "eslint-config-standard": "^17.0.0-0",
     "eslint-plugin-import": "^2.16.0",
-    "eslint-plugin-mocha": "^8.0.0",
+    "eslint-plugin-mocha": "^10.0.3",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-promise": "^4.1.1",
-    "eslint-plugin-standard": "^5.0.0",
+    "eslint-plugin-promise": "^6.0.0",
     "form-data": "^4.0.0",
     "got": "^11.3.0",
-    "mocha": "^8.0.1",
+    "mocha": "^9.1.3",
     "npm-run-all": "^4.1.5",
     "nyc": "^15.0.0",
-    "prettier": "2.2.1",
+    "prettier": "2.5.1",
     "proxyquire": "^2.1.0",
     "rimraf": "^3.0.0",
-    "semantic-release": "^17.0.2",
-    "sinon": "^10.0.0",
-    "sinon-chai": "^3.3.0",
+    "semantic-release": "^18.0.1",
+    "sinon": "^13.0.1",
+    "sinon-chai": "^3.7.0",
     "typescript": "^4.2.2"
   },
   "scripts": {
@@ -61,7 +60,7 @@
     "lint:js": "eslint --cache --cache-location './.cache/eslint' '**/*.js'",
     "lint:js:fix": "eslint --cache --cache-location './.cache/eslint' --fix '**/*.js'",
     "lint:ts": "dtslint types",
-    "test": "nyc mocha tests",
+    "test": "nyc --reporter=lcov --reporter=text mocha tests",
     "test:coverage": "open coverage/lcov-report/index.html"
   },
   "license": "MIT",

package/types/index.d.ts

@@ -240,7 +240,7 @@ declare namespace nock {
     options?: Options
   }
 
-  type BackMode = 'wild' | 'dryrun' | 'record' | 'lockdown'
+  type BackMode = 'wild' | 'dryrun' | 'record' | 'update' | 'lockdown'
 
   interface Back {
     currentMode: BackMode

package/CHANGELOG.md

@@ -1,6 +0,0 @@
-# Changelog
-
-Nock’s changelog can be found directly in the [GitHub release notes](https://github.com/nock/nock/releases).  
-These are automatically created by [semantic-release](https://github.com/semantic-release/semantic-release) based on their [commit message conventions](https://semantic-release.gitbook.io/semantic-release#commit-message-format).
-
-Migration guides are available for major versions in the [migration guides directory](https://github.com/nock/nock/tree/main/migration_guides).