nock 13.1.1 → 13.2.0

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:
@@ -1402,6 +1414,14 @@ return nockBack('promisedFixture.json').then(({ nockDone, context }) => {
 })
 ```
 
+Or, with async/await:
+
+```js
+const { nockDone, context } = await nockBack('promisedFixture.json')
+//  your test code
+nockDone()
+```
+
 #### Options
 
 As an optional second parameter you can pass the following options
@@ -1451,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
@@ -1565,10 +1587,30 @@ By participating in this project you agree to abide by its terms.
 Thanks goes to these wonderful people ([emoji key](https://github.com/all-contributors/all-contributors#emoji-key)):
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore -->
-| [<img src="https://avatars1.githubusercontent.com/u/47910?v=4" width="100px;" alt="Pedro Teixeira"/><br /><sub><b>Pedro Teixeira</b></sub>](http://pgte.me)<br />[💻](https://github.com/nock/nock/commits?author=pgte "Code") [🚧](#maintenance-pgte "Maintenance") | [<img src="https://avatars3.githubusercontent.com/u/10771967?v=4" width="100px;" alt="n30n0v"/><br /><sub><b>n30n0v</b></sub>](https://github.com/n30n0v)<br />[💻](https://github.com/nock/nock/commits?author=n30n0v "Code") | [<img src="https://avatars3.githubusercontent.com/u/910753?v=4" width="100px;" alt="Richard Littauer"/><br /><sub><b>Richard Littauer</b></sub>](https://burntfen.com)<br />[🚧](#maintenance-RichardLitt "Maintenance") [💻](https://github.com/nock/nock/commits?author=RichardLitt "Code") [📝](#blog-RichardLitt "Blogposts") | [<img src="https://avatars1.githubusercontent.com/u/3731165?v=4" width="100px;" alt="Ian Walker-Sperber"/><br /><sub><b>Ian Walker-Sperber</b></sub>](http://ianwsperber.com)<br />[💻](https://github.com/nock/nock/commits?author=ianwsperber "Code") | [<img src="https://avatars2.githubusercontent.com/u/1505203?v=4" width="100px;" alt="Ivan Erceg"/><br /><sub><b>Ivan Erceg</b></sub>](http://ilovacha.com)<br />[💻](https://github.com/nock/nock/commits?author=ierceg "Code") [🚧](#maintenance-ierceg "Maintenance") | [<img src="https://avatars2.githubusercontent.com/u/1487036?v=4" width="100px;" alt="Paul Melnikow"/><br /><sub><b>Paul Melnikow</b></sub>](https://twitter.com/paulmelnikow)<br />[💻](https://github.com/nock/nock/commits?author=paulmelnikow "Code") [🚧](#maintenance-paulmelnikow "Maintenance") | [<img src="https://avatars3.githubusercontent.com/u/39992?v=4" width="100px;" alt="Gregor Martynus"/><br /><sub><b>Gregor Martynus</b></sub>](https://twitter.com/gr2m)<br />[💻](https://github.com/nock/nock/commits?author=gr2m "Code") [🚧](#maintenance-gr2m "Maintenance") [💼](#business-gr2m "Business development") [💵](#financial-gr2m "Financial") [📝](#blog-gr2m "Blogposts") |
-| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
-| [<img src="https://avatars1.githubusercontent.com/u/6701030?v=4" width="100px;" alt="Hutson Betts"/><br /><sub><b>Hutson Betts</b></sub>](https://gitlab.com/hutson)<br />[💵](#financial-hutson "Financial") | [<img src="https://avatars2.githubusercontent.com/u/6105119?v=4" width="100px;" alt="Jonas Lilja"/><br /><sub><b>Jonas Lilja</b></sub>](http://lilja.io)<br />[💵](#financial-jlilja "Financial") [💻](https://github.com/nock/nock/commits?author=jlilja "Code") | [<img src="https://avatars0.githubusercontent.com/u/4446950?v=4" width="100px;" alt="Benjamin Ki"/><br /><sub><b>Benjamin Ki</b></sub>](https://github.com/benrki)<br />[💵](#financial-benrki "Financial") | [<img src="https://avatars2.githubusercontent.com/u/3250463?v=4" width="100px;" alt="Chad Fawcett"/><br /><sub><b>Chad Fawcett</b></sub>](http://chadf.ca)<br />[💵](#financial-chadfawcett "Financial") |
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="http://pgte.me"><img src="https://avatars1.githubusercontent.com/u/47910?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Pedro Teixeira</b></sub></a><br /><a href="https://github.com/nock/nock/commits?author=pgte" title="Code">💻</a> <a href="#maintenance-pgte" title="Maintenance">🚧</a></td>
+    <td align="center"><a href="https://github.com/n30n0v"><img src="https://avatars3.githubusercontent.com/u/10771967?v=4?s=100" width="100px;" alt=""/><br /><sub><b>n30n0v</b></sub></a><br /><a href="https://github.com/nock/nock/commits?author=n30n0v" title="Code">💻</a></td>
+    <td align="center"><a href="https://burntfen.com"><img src="https://avatars3.githubusercontent.com/u/910753?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Richard Littauer</b></sub></a><br /><a href="#maintenance-RichardLitt" title="Maintenance">🚧</a> <a href="https://github.com/nock/nock/commits?author=RichardLitt" title="Code">💻</a> <a href="#blog-RichardLitt" title="Blogposts">📝</a></td>
+    <td align="center"><a href="http://ianwsperber.com"><img src="https://avatars1.githubusercontent.com/u/3731165?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ian Walker-Sperber</b></sub></a><br /><a href="https://github.com/nock/nock/commits?author=ianwsperber" title="Code">💻</a></td>
+    <td align="center"><a href="http://ilovacha.com"><img src="https://avatars2.githubusercontent.com/u/1505203?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ivan Erceg</b></sub></a><br /><a href="https://github.com/nock/nock/commits?author=ierceg" title="Code">💻</a> <a href="#maintenance-ierceg" title="Maintenance">🚧</a></td>
+    <td align="center"><a href="https://twitter.com/paulmelnikow"><img src="https://avatars2.githubusercontent.com/u/1487036?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Paul Melnikow</b></sub></a><br /><a href="https://github.com/nock/nock/commits?author=paulmelnikow" title="Code">💻</a> <a href="#maintenance-paulmelnikow" title="Maintenance">🚧</a></td>
+    <td align="center"><a href="https://twitter.com/gr2m"><img src="https://avatars3.githubusercontent.com/u/39992?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Gregor Martynus</b></sub></a><br /><a href="https://github.com/nock/nock/commits?author=gr2m" title="Code">💻</a> <a href="#maintenance-gr2m" title="Maintenance">🚧</a> <a href="#business-gr2m" title="Business development">💼</a> <a href="#financial-gr2m" title="Financial">💵</a> <a href="#blog-gr2m" title="Blogposts">📝</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://gitlab.com/hutson"><img src="https://avatars1.githubusercontent.com/u/6701030?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Hutson Betts</b></sub></a><br /><a href="#financial-hutson" title="Financial">💵</a></td>
+    <td align="center"><a href="http://lilja.io"><img src="https://avatars2.githubusercontent.com/u/6105119?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jonas Lilja</b></sub></a><br /><a href="#financial-jlilja" title="Financial">💵</a> <a href="https://github.com/nock/nock/commits?author=jlilja" title="Code">💻</a></td>
+    <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>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 

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,19 @@ function load(fixture, options) {
   return context
 }
 
+function removeFixture(fixture, options) {
+  const context = {
+    scopes: [],
+    assertScopesFinished: function () {},
+  }
+
+  if (fixture && fixtureExists(fixture)) {
+    fs.rmSync ? fs.rmSync(fixture) : fs.unlinkSync(fixture)
+  }
+  context.isLoaded = false
+  return context
+}
+
 function applyHook(scopes, fn) {
   if (!fn) {
     return
@@ -258,6 +312,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

@@ -651,11 +651,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

@@ -153,7 +153,7 @@ class InterceptedRequestRouter {
       return false
     }
 
-    if (!buffer || buffer.length === 0) {
+    if (!buffer) {
       return true
     }
 
@@ -279,9 +279,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

@@ -442,13 +442,17 @@ module.exports = class Interceptor {
   markConsumed() {
     this.interceptionCounter++
 
-    remove(this)
-
-    if ((this.scope.shouldPersist() || this.counter > 0) && this.filePath) {
+    if (
+      (this.scope.shouldPersist() || this.counter > 0) &&
+      this.interceptionCounter > 1 &&
+      this.filePath
+    ) {
       this.body = fs.createReadStream(this.filePath)
       this.body.pause()
     }
 
+    remove(this)
+
     if (!this.scope.shouldPersist() && this.counter < 1) {
       this.scope.remove(this._key, this)
     }

package/package.json

@@ -7,7 +7,7 @@
     "testing",
     "isolation"
   ],
-  "version": "13.1.1",
+  "version": "13.2.0",
   "author": "Pedro Teixeira <pedro.teixeira@gmail.com>",
   "repository": {
     "type": "git",
@@ -28,7 +28,7 @@
     "propagate": "^2.0.0"
   },
   "devDependencies": {
-    "@sinonjs/fake-timers": "^7.0.2",
+    "@sinonjs/fake-timers": "^8.1.0",
     "assert-rejects": "^1.0.0",
     "chai": "^4.1.2",
     "dirty-chai": "^2.0.1",
@@ -37,7 +37,7 @@
     "eslint-config-prettier": "^8.1.0",
     "eslint-config-standard": "^16.0.2",
     "eslint-plugin-import": "^2.16.0",
-    "eslint-plugin-mocha": "^8.0.0",
+    "eslint-plugin-mocha": "^9.0.0",
     "eslint-plugin-node": "^11.0.0",
     "eslint-plugin-promise": "^4.1.1",
     "eslint-plugin-standard": "^5.0.0",
@@ -46,12 +46,12 @@
     "mocha": "^8.0.1",
     "npm-run-all": "^4.1.5",
     "nyc": "^15.0.0",
-    "prettier": "2.2.1",
+    "prettier": "2.4.1",
     "proxyquire": "^2.1.0",
     "rimraf": "^3.0.0",
     "semantic-release": "^17.0.2",
-    "sinon": "^10.0.0",
-    "sinon-chai": "^3.3.0",
+    "sinon": "^12.0.1",
+    "sinon-chai": "^3.7.0",
     "typescript": "^4.2.2"
   },
   "scripts": {
@@ -61,7 +61,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

@@ -198,7 +198,7 @@ declare namespace nock {
     once(): this
     twice(): this
     thrice(): this
-    optionally(): this
+    optionally(flag?: boolean): this
 
     delay(opts: number | { head?: number; body?: number }): this
     delayBody(timeMs: number): this