Update dependency nock to v13 #46

Scope.log has been removed. Use the debug library when debugging failed matches.
socketDelay has been removed. Use delayConnection instead.
delay, delayConnection, and delayBody are now setters instead of additive.
When recording, skipping body matching using * is no longer supported by nock.define.
Set the definition body to undefined instead.
ClientRequest.abort() has been updated to align with Node's native behavior.
This could be considered a feature, however, it created some subtle differences that are not backwards compatible. Refer to the migration guide for details.
Playback of a mocked responses will now never happen until the 'socket' event is emitted.

`v12.0.3`

Compare Source

Bug Fixes

router: stall finish event to avoid dup (#1954) (d81c260), closes #1832

`v12.0.2`

Compare Source

Bug Fixes

types: remove inaccurate Scope.restore method (#1940) (fa3c237)

`v12.0.1`

Compare Source

Bug Fixes

Replace a few more uses of lodash (#1916) (1f47f1a), closes #1285

`v12.0.0`

Compare Source

BREAKING CHANGES

Require Node 10+ (#1895) (123832e), closes #1895
Do not return the nock global from cleanAll() (#1872) (0a4a944), closes #1872
Drop support for String constructor (#1873) (e33b3e8), closes #1873

When checking types of strings, Nock will no longer recognize the String constructor, only string primitives.

Features

Allow passing a function to enableNetConnect() (#1889) (7f9e26c)

`v11.9.1`

Compare Source

Bug Fixes

revert breaking changes from v11.9.0 (062c10e)

`v11.9.0`

Compare Source

Features

allow passing a function to enableNetConnect() (#1889) (566461b)

`v11.8.2`

Compare Source

Bug Fixes

allowMocked when using a callback for the path (#1877) (9fdeeca), closes #1867

`v11.8.1`

Compare Source

Bug Fixes

only activate once, when on (#1824) (a56a209)

`v11.8.0`

Compare Source

Bug Fixes

types: Scope accepts legacy Url not WHATWG (#1879) (e22233b)
Correct behavior when other libraries override http.get and http.request (#1868) (22e2fca), closes #1836

Features

socketDelay: support options.timeout (#1848) (061e922)

`v11.7.2`

Compare Source

Bug Fixes

Fix a regression due to Jest having different globals (#1850) (c7363e5)

`v11.7.1`

Compare Source

Bug Fixes

make interceptors work in any order even when filteringScope (#1819) (bd39dff), closes #1818

`v11.7.0`

Compare Source

Features

types: add type for Nock Back currentMode (#1794) (ba60fd2), closes /github.com/nock/nock/blob/master/lib/back.js#L282

`v11.6.0`

Compare Source

Features

Add lifecycle function to clear pending timeouts (#1748) (187db85), closes #1118

`v11.5.0`

Compare Source

Features

Throw errors for URL paths without leading slashes, which will never match (#1744) (b7f9f13), closes #1730

`v11.4.0`

Compare Source

Features

improve error output by showing which URL caused the error (#1735) (#1740) (f4a208b)

`v11.3.6`

Compare Source

Bug Fixes

Fix error message (#1736) (3f18d70)

`v11.3.5`

Compare Source

Bug Fixes

types: data matcher for body and query. (#1725) (59b345c), closes #1724 #1723 /github.com/Microsoft/TypeScript/issues/1897#issuecomment-338650717 #1723 #1724

`v11.3.4`

Compare Source

Bug Fixes

Fix crash when matching certain objects (#1714) (fa0a08a), closes #1713

`v11.3.3`

Compare Source

Bug Fixes

types: DataMatcher to allow valid JSON scalars. (#1703) (a700fa2), closes #1702

`v11.3.2`: v11

Compare Source

Upgrading from Nock 10 to Nock 11

Bug fixes and internal improvements

Nock 11 includes many under-the-hood improvements, including a fully offline
test suite and 100% test coverage. The codebase was also converted to ES6
syntax and formatted with Prettier. Leaning on the test coverage, some
substantial refactors have begun.

Many bug fixes are included. See the detailed changelog below or the
compare view for details.

Fabulous new features for developers

The library ships with TypeScript definitions. (Added in v11.3)
Add support for the http.request signatures added in Node 10.9
Scopes can be filtered using the system environment or any external factor
using e.g. .conditionally(() => true)
In-flight modifications to headers are preserved in mock requests.
Recorded mocks can be stringified using custom code in the afterRecord()
post-processing hook. When afterRecord() returns a string, the
recorder will no longer attempt to re-stringify it. (Added in v11.3)
Reply functions passed to .reply() can now be async/promise-returning.
Specifying reply headers, either via .reply() or .defaultReplyHeaders(),
can now be done consistently using an object, Map, or flat array.

Breaking changes

For many developers no code changes will be needed. However, there are several
minor changes to the API, and it's possible that you will need to update your
code for Nock to keep working properly. It's unlikely that your tests will
falsely pass; what's more probable is that your tests will fail until the
necessary changes are made.

Nock 11 requires Node 8 or later. Nock supports and tests all the "current"
and "maintenance" versions of Node. As of now, that's Node 8, 10, and 12.

In Nock 10, when reply() was invoked with a function, the return values were
handled ambiguously depending on their types.

Consider the following example:

const scope = nock('http://example.com')
  .get('/')
  .reply(200, () => [500, 'hello world'])

In Nock 10, the 200 was ignored, the 500 was interpreted as the status
code, and the body would contain 'hello world'. This caused problems
when the goal was to return a numeric array, so in Nock 11, the 200 is
properly interpreted as the status code, and [500, 'hello world'] as the
body.

These are the correct calls for Nock 11:

const scope = nock('http://example.com')
  .get('/')
  .reply(500, 'hello world')

const scope = nock('http://example.com')
  .get('/')
  .reply(500, () => 'hello world')

The .reply() method can be called with explicit arguments:

.reply() // `statusCode` defaults to `200`.
.reply(statusCode) // `responseBody` defaults to `''`.
.reply(statusCode, responseBody) // `headers` defaults to `{}`.
.reply(statusCode, responseBody, headers)

It can be called with a status code and a function that returns an array:

.reply(statusCode, (path, requestBody) => responseBody)
.reply(statusCode, (path, requestBody) => responseBody, headers)

Alternatively the status code can be included in the array:

.reply((path, requestBody) => [statusCode])
.reply((path, requestBody) => [statusCode, responseBody])
.reply((path, requestBody) => [statusCode, responseBody, headers])
.reply((path, requestBody) => [statusCode, responseBody], headers)

.reply() can also be called with an async or promise-returning function. The
signatures are identical, e.g.

.reply(async (path, requestBody) => [statusCode, responseBody])
.reply(statusCode, async (path, requestBody) => responseBody)

Finally, an error-first callback can be used, e.g.:

.reply((path, requestBody, cb) => cb(undefined, [statusCode, responseBody]))
.reply(statusCode, (path, requestBody, cb) => cb(undefined, responseBody))

In Nock 10, errors in user-provided reply functions were caught by Nock, and
generated HTTP responses with status codes of 500. In Nock 11 these errors
are not caught, and instead are re-emitted through the request, like any
other error that occurs during request processing.

Consider the following example:

const scope = nock('http://example.com')
  .post('/echo')
  .reply(201, (uri, requestBody, cb) => {
    fs.readFile('cat-poems.txt', cb) // Error-first callback
  })

When fs.readFile() errors in Nock 10, a 500 error was emitted. To get the
same effect in Nock 11, the example would need to be rewritten to:

const scope = nock('http://example.com')
  .post('/echo')
  .reply((uri, requestBody, cb) => {
    fs.readFile('cat-poems.txt', (err, contents) => {
      if (err) {
        cb([500, err.stack])
      } else {
        cb([201, contents])
      }
    })
  })

When .reply() is invoked with something other than a whole number status
code or a function, Nock 11 raises a new error Invalid ... value for status code.
Callback functions provided to the .query method now receive the result of querystring.parse instead of qs.parse.

In particular, querystring.parse does not interpret keys with JSON
path notation:
```
querystring.parse('foo[bar]=baz') // { "foo[bar]": 'baz' }
qs.parse('foo[bar]=baz') // { foo: { bar: 'baz' } }
```
In Nock 10, duplicate field names provided to the .query() method were
silently ignored. We decided this was probably hiding unintentionally bugs
and causing frustration with users. In Nock 11, attempts to provide query
params more than once will throw a new error
Query parameters have aleady been defined. This could happen by calling
.query() twice, or by calling .query() after specifying a literal query
string via the path.
```
nock('http://example.com')
  .get('/path')
  .query({ foo: 'bar' })
  .query({ baz: 'qux' }) // <-- will throw
  .reply()

nock('http://example.com')
  .get('/path?foo=bar')
  .query({ baz: 'qux' }) // <-- will throw
  .reply()
```
Paths in Nock have always required a leading slash. e.g.
```
const scope = nock('http://example.com')
  .get('/path')
  .reply()
```
In Nock 10, if the leading slash was missing the mock would never match. In
Nock 11, this raises an error.
The reqheaders parameter should be provided as a plain object, e.g.
nock('http://example.com', { reqheaders: { X-Foo: 'bar' }}). When the
headers are specified incorrectly as e.g. { reqheaders: 1 }, Nock 10 would
behave in unpredictable ways. In Nock 11, a new error
Headers must be provided as an object is thrown.
```
nock('http://example.com', { reqheaders: 1 })
  .get('/')
  .reply()
```
In Nock 10, the ClientRequest instance wrapped the native on method
and aliased once to it. In Nock 11, this been removed and request.once
will correctly call registered listeners...once.
In Nock 10, when the method was not specified in a call to nock.define(),
the method would default to GET. In Nock 11, this raises an error.
In very old versions of nock, recordings may include a response status
code encoded as a string in the reply field. In Nock 10 these strings could
be non-numeric. In Nock 11 this raises an error.

Updates to the mock surface

For parity with a real response, a mock request correctly supports all
the overrides to request.end(), including request.end(cb) in Node 12.
For parity with a real response, errors from the .destroy() method
are propagated correctly. (Added in v11.3)
For parity with a real response, the .complete property is set when
ending the response.
For parity with a real Socket, the mock Socket has an unref() function
(which does nothing).

If you discover bugs in this release, please open a bug report on the Nock repo. 🐛

Detailed changelog

BREAKING CHANGES

uncaught errors thrown inside of user provided reply functions, whether async or not, will no longer be caught, and will no longer generate a successful response with a status code of 500. Instead, the error will be emitted by the request just like any other unhandled error during the request processing.
The only argument passed to the Interceptor.query callback now receives the output from querystring.parse instead of qs.parse. This means that instead of nested objects the argument will be a flat object.
interceptor: Attempting to call Interceptor.query twice throws an error.
interceptor: Providing a duplicate search parameter to the query
method throws an error instead of ignoring subsequent values.
Drop support for Node 6

Features

interceptor: duplicate query calls throw (#1630) (2a54482), closes #1626
interceptor: duplicate query keys throw (a2208d1), closes #1623
Throw error if request headers are not an object (#1574) (8ba0fc7)
overrider: added support for header modifications before end() (4a4b8ec)
Add conditionally() (#1488) (24e5b47)
reply: Response headers to more closely match Node's functionality. (#1564) (b687592), closes #1553 /github.com/nodejs/node/blob/908292cf1f551c614a733d858528ffb13fb3a524/lib/_http_incoming.js#L245
request_overrider: Set IncomingMessage.client for parity with real requests (dc71a3b), closes /github.com/nodejs/node/blob/2e613a9c301165d121b19b86e382860323abc22f/lib/_http_incoming.js#L67
requestoverrider: Add method property to mocked requests (#1561) (4857ae5)
added noop method unref to Socket (#1612) (a75f49f)
Support http.request signatures added in Node 10.9+ (#1588) (e3e6a65), closes #1227
Throw an error on invalid truthy reply status codes (#1571) (de525a1)
Async Reply functions (always emit errors) (#1596) (26fc08f), closes #1596
Drop support for Node 6 (15b3cf0), closes #1297
types: Add Typescript definitions. (#1676) (2e56fb0), closes #1670
socket: propagate errors from destroy method (#1675) (de9c40b), closes #1669

Bug Fixes

req.end(cb) compatibility with Node 12 (#1551) (31623fb)
alias connection to socket. (#1590) (659bf01), closes /github.com/nodejs/node/blob/master/lib/_http_client.js#L640-L641 /github.com/nodejs/node/blob/master/lib/_http_incoming.js#L44-L45
allow unmocked when providing literal search params. (#1614) (f8d6cbb), closes #1421
Fix .matchHeader() with allowUnmocked (#1480) (d6667f0)
Fix req.end(cb); prevent TypeError in Node 12 (#1547) (9a494da), closes #1509
Mock responses should fire when timers are mocked (#1336) (a213169), closes #1335 #1334
define: Throw error when legacy reply is in wrong format (5d2fb9f)
package.engines is supposed to be an object (6dc0208)
request.end accepted arguments (#1591) (ad34222), closes /github.com/nodejs/node/commit/a10bdb51b18dfaad874f3702a1daea51ec2d4514#diff-286202fdbdd74ede6f5f5334b6176b5cL779 #1549
response.complete must be true after res.end (#1601) (2c4edba)
Restore behavior of Interceptor.filteringPath (#1543) (560a5d8)
throw error when leading slash is not present in path (#1391) (28b2d43), closes /github.com/nock/nock/pull/1391#discussion_r250725610
socket: When Socket#setTimeout gets a callback, should still emit (a07b0ba), closes #1404
trigger release (#1645) (88e85ac)
Update and clarify how .reply() can be invoked with functions (#1520) (2e779f0), closes /github.com/nock/nock/pull/1517/files#r280139478 #1222
define: Throw when method is missing (69ba3c3)
intercept: Better error message when options is falsy (#1440) (7e44769)
intercept: Improve error message when new ClientMessage() is invoked with no options (#1386) (6d2a312)
package: update propagate to version 2.0.0 (b729466)
recorder: allow recording req headers when not outputting objects (#1617) (a952d9b), closes /nodejs.org/api/deprecations.html#deprecations_dep0066

Code Refactoring

overhaul body and query matching (#1632) (35221ce), closes #507 #1552

`v11.3.1`

Compare Source

`v11.3.0`

Compare Source

`v11.2.0`

Compare Source

`v11.1.0`

Compare Source

`v11.0.0`

Compare Source

`v10.0.6`

Compare Source

Bug Fixes

Mock responses should fire when timers are mocked (#1335) (cb56669), closes #1334

`v10.0.5`

Compare Source

Bug Fixes

package.engines shows incorrect versions and is supposed to be an object (0c4edd6)

`v10.0.4`

Compare Source

Bug Fixes

#1266: throw useful error if "method" parameter is not set for .intercept() – thanks @labsvisual (a90f543), closes #1266

`v10.0.3`

Compare Source

Bug Fixes

filtering by regex (#1089) (88fbdc2)

`v10.0.2`

Compare Source

Bug Fixes

#1041: apply filteringPath from nockBack before option (6d5bca2), closes #1041

`v10.0.1`

Compare Source

Bug Fixes

package: update debug to version 4.1.0 (0c807c9), closes #1214

`v10.0.0`

Compare Source

BREAKING CHANGES

drop official support for Node < 6

There is no intentional change that breaks usage in Node 4, but as we
stop testing in this no longer supported Node version we recommend to
no update nock if you still rely on Node 4.

The reason why we decided to go ahead and make a breaking version
release is that it became increasingly harder to update dependencies
to the latest versions as they also drop support for Node 4.

Bug Fixes

#1203: handle statusCode without payload (21c255f), closes #1203

Code Refactoring

update Buffer constructors to from and alloc (c94b89d)

Continuous Integration

travis: stop testing in Node 4 (139b632)

`v9.6.1`

Compare Source

Bug Fixes

set socket connecting state to always be false (ca1eea0)

`v9.6.0`

Compare Source

Features

Allow optionally() to be called with a value, specifying if the mock should be optional (d8a2606)

`v9.5.0`

Compare Source

Features

encode an expected buffer the same way when matching as the client (c584f7a)

`v9.4.4`

Compare Source

Bug Fixes

#1076: allowUnmocked: true + host regex (#1179) (907be86), closes #1076

`v9.4.3`

Compare Source

Bug Fixes

#1171: When matching the path by function, also check the HTTP method. (9373382), closes #1171

`v9.4.2`

Compare Source

Bug Fixes

Replaced util._extend with Object.assign due to deprecated since node v6. (7fd2329)

`v9.4.1`

Compare Source

Bug Fixes

request overrider checks req.headers to parse body as JSON (#1157) (f81fb6d)

`v9.4.0`

Compare Source

Features

emit 'request' event with body as third parameter (#1062) (e15820a)

`v9.3.3`

Compare Source

Bug Fixes

match basePath as regex and path as function (#1147) (933880a)

`v9.3.2`

Compare Source

Bug Fixes

restore compatibility with Node <4.5 (#1144) (b5b40c1)

`v9.3.1`

Compare Source

Bug Fixes

use aborted property on http request (#1134) (aaa9a56)

`v9.3.0`

Compare Source

Features

support URL objects (de0cb79)

`v9.2.6`

Compare Source

Bug Fixes

match HTTP headers with case insensitivity (#1122) (2676fed)

`v9.2.5`

Compare Source

Bug Fixes

remove arrow functions to restore Node<4 compatibility (#1114) (11f1a25)

`v9.2.4`

Compare Source

Bug Fixes

url encoded body matches non-string values (#1110) (5852296)

`v9.2.3`

Compare Source

Bug Fixes

PhantomJS 2 usage (#1075) (055593a)

`v9.2.2`

Compare Source

Bug Fixes

Allow allowUnmocked = true and regexp paths to work (#1034) ([6817e76](https://redirect.github.com/node-nock/nock/co

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

renovate bot force-pushed the renovate/nock-13.x branch from e5e2ba2 to 86d8b18 Compare August 27, 2020 12:57

renovate bot force-pushed the renovate/nock-13.x branch from 86d8b18 to 5119663 Compare November 27, 2020 09:54

renovate bot force-pushed the renovate/nock-13.x branch from 5119663 to c6dc506 Compare January 24, 2021 11:48

renovate bot force-pushed the renovate/nock-13.x branch from c6dc506 to 064c2fa Compare February 1, 2021 23:00

renovate bot force-pushed the renovate/nock-13.x branch from 064c2fa to 9e510e5 Compare April 26, 2021 16:37

renovate bot force-pushed the renovate/nock-13.x branch from 9e510e5 to 874c1c7 Compare June 6, 2021 20:24

renovate bot force-pushed the renovate/nock-13.x branch from 874c1c7 to ceb099d Compare October 19, 2021 00:33

renovate bot force-pushed the renovate/nock-13.x branch from ceb099d to 9db8d01 Compare March 7, 2022 16:31

renovate bot force-pushed the renovate/nock-13.x branch from 9db8d01 to dfaba5d Compare June 18, 2022 16:52

renovate bot force-pushed the renovate/nock-13.x branch from dfaba5d to 66fdeb4 Compare September 25, 2022 23:02

renovate bot force-pushed the renovate/nock-13.x branch from 66fdeb4 to ccddf56 Compare November 20, 2022 12:01

renovate bot force-pushed the renovate/nock-13.x branch from ccddf56 to d1bb7d8 Compare March 18, 2023 12:08

renovate bot force-pushed the renovate/nock-13.x branch from d1bb7d8 to 484f552 Compare May 28, 2023 11:21

renovate bot force-pushed the renovate/nock-13.x branch from 484f552 to 1318201 Compare July 13, 2023 22:48

renovate bot force-pushed the renovate/nock-13.x branch from 1318201 to 472a699 Compare August 16, 2023 22:23

renovate bot force-pushed the renovate/nock-13.x branch from 472a699 to 14c8be0 Compare October 11, 2023 00:20

renovate bot force-pushed the renovate/nock-13.x branch from 14c8be0 to ccfa405 Compare October 19, 2023 20:56

renovate bot force-pushed the renovate/nock-13.x branch 2 times, most recently from 7c48c59 to 36c5943 Compare November 3, 2023 07:48

renovate bot force-pushed the renovate/nock-13.x branch from 36c5943 to 0e74ee4 Compare November 27, 2023 23:05

renovate bot force-pushed the renovate/nock-13.x branch from 0e74ee4 to 3f57f57 Compare January 14, 2024 19:23

renovate bot force-pushed the renovate/nock-13.x branch from 3f57f57 to 1ecd789 Compare January 28, 2024 19:37

renovate bot force-pushed the renovate/nock-13.x branch from 1ecd789 to 849de13 Compare February 17, 2024 19:31

renovate bot force-pushed the renovate/nock-13.x branch from 849de13 to 948ef64 Compare February 27, 2024 00:11

renovate bot force-pushed the renovate/nock-13.x branch from 948ef64 to a7504fc Compare August 20, 2024 08:19

Update dependency nock to v13

ae66fc7

renovate bot force-pushed the renovate/nock-13.x branch from a7504fc to ae66fc7 Compare November 9, 2024 19:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update dependency nock to v13 #46

Update dependency nock to v13 #46

renovate bot commented Jul 4, 2020 •

edited

Loading

Update dependency nock to v13 #46

Are you sure you want to change the base?

Update dependency nock to v13 #46

Conversation

renovate bot commented Jul 4, 2020 • edited Loading

Release Notes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Features

Features

Bug Fixes

Reverts

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Features

Bug Fixes

Bug Fixes

Bug Fixes

Reverts

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Features

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Features

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Breaking changes

Bug Fixes

Bug Fixes

Bug Fixes

BREAKING CHANGES

Features

Bug Fixes

Features

Bug Fixes

Bug Fixes

Bug Fixes

Features

Bug Fixes

Bug Fixes

Features

Features

Features

Features

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

v11.3.2: v11

Upgrading from Nock 10 to Nock 11

Bug fixes and internal improvements

Fabulous new features for developers

Breaking changes

Updates to the mock surface

Detailed changelog

BREAKING CHANGES

Features

Bug Fixes

renovate bot commented Jul 4, 2020 •

edited

Loading

`v11.3.2`: v11