feat: Add conditionally() (#1488)

parisholley · paulmelnikow · commit 24e5b47425b6 · 2019-04-15T17:26:17.000-04:00
I am building a test framework which depends on nock and to support concurrency, I need to be able shutoff certain scopes (to prevent cross-pollination) when running tests concurrently.
diff --git a/README.md b/README.md
@@ -757,6 +757,18 @@ const scope = nock('https://api.dropbox.com', {
   .reply(200)
 ```
 
+### Conditional scope filtering
+
+You can also choose to filter out a scope based on your system environment (or any external factor). The filtering function is accepted at the `conditionally` field of the `options` argument.
+
+This can be useful if you only want certain scopes to apply depending on how your tests are executed.
+
+```js
+const scope = nock('https://api.myservice.com', {
+  conditionally: () => true,
+})
+```
+
 ### Path filtering
 
 You can also filter the URLs based on a function.
diff --git a/lib/interceptor.js b/lib/interceptor.js
@@ -254,6 +254,14 @@ Interceptor.prototype.match = function match(options, body, hostNameOnly) {
     return false
   }
 
+  if (
+    this.scope.scopeOptions &&
+    this.scope.scopeOptions.conditionally &&
+    !this.scope.scopeOptions.conditionally()
+  ) {
+    return false
+  }
+
   function reqheaderContains(header) {
     return _.has(options.headers, header)
   }
diff --git a/tests/test_intercept.js b/tests/test_intercept.js
@@ -8,6 +8,7 @@ const mikealRequest = require('request')
 const superagent = require('superagent')
 const needle = require('needle')
 const restify = require('restify-clients')
+const assertRejects = require('assert-rejects')
 const hyperquest = require('hyperquest')
 const got = require('got')
 const nock = require('..')
@@ -1228,6 +1229,36 @@ test('test request timeout option', t => {
   })
 })
 
+test('do not match when conditionally = false but should match after trying again when = true', async t => {
+  t.plan(2)
+  let enabled = false
+
+  const scope = nock('http://example.test', {
+    conditionally: function() {
+      return enabled
+    },
+  })
+    .get('/')
+    .reply(200)
+
+  // now the scope has been used, should fail on second try
+  await assertRejects(
+    got('http://example.test/'),
+    Error,
+    'Nock: No match for request'
+  )
+  t.throws(() => scope.done(), {
+    message: 'Mocks not yet satisfied',
+  })
+
+  enabled = true
+
+  const { statusCode } = await got('http://example.test/')
+
+  t.equal(statusCode, 200)
+  scope.done()
+})
+
 test('get correct filtering with scope and request headers filtering', t => {
   const responseText = 'OK!'
   const responseHeaders = { 'Content-Type': 'text/plain' }

Original file line number	Diff line number	Diff line change
`@@ -254,6 +254,14 @@ Interceptor.prototype.match = function match(options, body, hostNameOnly) {`
`254`	`254`	`return false`
`255`	`255`	`}`
`256`	`256`
	`257`	`+ if (`
	`258`	`+ this.scope.scopeOptions &&`
	`259`	`+ this.scope.scopeOptions.conditionally &&`
	`260`	`+ !this.scope.scopeOptions.conditionally()`
	`261`	`+ ) {`
	`262`	`+ return false`
	`263`	`+ }`
	`264`	`+`
`257`	`265`	`function reqheaderContains(header) {`
`258`	`266`	`return _.has(options.headers, header)`
`259`	`267`	`}`