Use @mswjs/interceptors for mocking - WIP #2517
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,6 +10,9 @@ | |
| const http = require('http') | ||
| const debug = require('debug')('nock.intercept') | ||
| const globalEmitter = require('./global_emitter') | ||
| const { BatchInterceptor } = require('@mswjs/interceptors') | ||
| const { FetchInterceptor } = require('@mswjs/interceptors/fetch') | ||
| const { default: nodeInterceptors } = require('@mswjs/interceptors/presets/node') | ||
|
|
||
| /** | ||
| * @name NetConnectNotAllowedError | ||
|
|
@@ -365,75 +368,105 @@ | |
| return [].concat(...interceptorScopes().map(scope => scope.activeMocks())) | ||
| } | ||
|
|
||
| function getRequestOptionsFromFetchRequest(fetchRequest) { | ||
| const requestOptions = { | ||
| method: fetchRequest.method, | ||
| headers: {}, | ||
| }; | ||
|
|
||
| fetchRequest.headers.forEach((value, key) => { | ||
| requestOptions.headers[key] = value; | ||
| }); | ||
|
|
||
| const url = new URL(fetchRequest.url); | ||
|
|
||
| const options = { | ||
| ...requestOptions, | ||
| hostname: url.hostname, | ||
| port: url.port, | ||
| path: url.pathname + url.search, | ||
| proto: url.protocol === 'https:' ? 'https' : 'http', | ||
| }; | ||
|
|
||
| return options; | ||
| } | ||
|
|
||
| function convertFetchRequestToClientRequest(fetchRequest) { | ||
| const url = new URL(fetchRequest.url); | ||
| const options = { | ||
| method: fetchRequest.method, | ||
| host: url.hostname, | ||
| port: url.port || (url.protocol === 'https:' ? 443 : 80), | ||
| path: url.pathname + url.search, | ||
| headers: fetchRequest.headers, | ||
| proto: url.protocol.slice(0, -1), | ||
| headers: Object.fromEntries(fetchRequest.headers.entries()) | ||
| }; | ||
|
|
||
| const clientRequest = new http.ClientRequest(options); | ||
| // Note: You won't have access to the request body data from the Fetch Request | ||
|
|
||
| return clientRequest; | ||
| } | ||
|
|
||
| function activate() { | ||
| if (originalClientRequest) { | ||
| throw new Error('Nock already active') | ||
| } | ||
|
|
||
| overrideClientRequest() | ||
| const interceptor = new BatchInterceptor({ | ||
| name: 'my-interceptor', | ||
|
There was a problem hiding this comment. Giving this a meaningful name may improve the logging output, afaik. Maybe |
||
| interceptors: [...nodeInterceptors, new FetchInterceptor()], | ||
mikicho marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }) | ||
| interceptor.apply(); | ||
| interceptor.on('request', function ({ request, requestId }) { | ||
| return new Promise((resolve) => { | ||
| const { options, callback } = common.normalizeClientRequestArgs(request.url) | ||
| options.proto = options.protocol.slice(0, -1) | ||
| const interceptors = interceptorsFor(options) | ||
| if (isOn() && interceptors) { | ||
| const matches = interceptors.some(interceptor => | ||
| interceptor.matchOrigin(options) | ||
| ) | ||
| const allowUnmocked = interceptors.some( | ||
| interceptor => interceptor.options.allowUnmocked | ||
| ) | ||
|
|
||
| if (!matches && allowUnmocked) { | ||
| // TODO: implement unmocked | ||
| // let req | ||
| // if (proto === 'https') { | ||
| // const { ClientRequest } = http | ||
| // http.ClientRequest = originalClientRequest | ||
| // req = overriddenRequest(options, callback) | ||
| // http.ClientRequest = ClientRequest | ||
| // } else { | ||
| // req = overriddenRequest(options, callback) | ||
| // } | ||
| // globalEmitter.emit('no match', req) | ||
| // return req | ||
| throw new Error('TODO') | ||
| } | ||
|
|
||
| const req = convertFetchRequestToClientRequest(request); | ||
| req.on('response', response => { | ||
| request.respondWith(new Response('test', { status: 200 })) | ||
|
There was a problem hiding this comment. Nitpick: we'd want to read the response stream to the As I mentioned in the issue, let me know if exporting this existing utility from Interceptors would help here. I think it would. There was a problem hiding this comment. Do you have an idea how we can wait for the nockResponse
Thanks!! For now, I copied the file. We can update this later. There was a problem hiding this comment. In this case, we can rely on the internal const stream = new Readable()
const fetchResponse = new Response(stream, {
status: response.statusCode,
statusText: response.statusMessage,
headers: response.headers // pseudo-code
})
response.on('data', (chunk) => stream.write(chunk))
response.on('end', () => {
stream.finish()
request.respndWith(fetchResponse)
})This is a gist. If you want the actual implementation example, take a look at this function. |
||
| resolve() | ||
| }) | ||
|
|
||
| req.end() | ||
| } else { | ||
| globalEmitter.emit('no match', options) | ||
| if (isOff() || isEnabledForNetConnect(options)) { | ||
| // TODO: implement unmocked | ||
| return overriddenRequest(options, callback) | ||
| } else { | ||
| const error = new NetConnectNotAllowedError(options.host, options.path) | ||
| return new ErroringClientRequest(error) | ||
| } | ||
| } | ||
| }) | ||
| }) | ||
| } | ||
|
|
||
|
|
||
GitHub Actions 
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think Node expects
OutgoingHeadershere, which is not compatible with theHeadersinstance. You should be fine doing this:There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
great catch! 🙏
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just be cautious about the compilation target here. I'm not sure what's the support range is for Nock, but
.fromEntries()and.entries()methods may not exist on super old versions of ECMAScript and Node.