-
Notifications
You must be signed in to change notification settings - Fork 30.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
inspector: add undici http tracking support
Add basic undici http tracking support via inspector protocol. This allows tracking `fetch` calls with an inspector. PR-URL: #56488 Refs: #53946 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Ethan Arrowood <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
- Loading branch information
1 parent
7b472fd
commit 4f45ace
Showing
6 changed files
with
367 additions
and
8 deletions.
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
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 |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| 'use strict'; | ||
|
|
||
| const { | ||
| DateNow, | ||
| } = primordials; | ||
|
|
||
| const { | ||
| kInspectorRequestId, | ||
| kResourceType, | ||
| getMonotonicTime, | ||
| getNextRequestId, | ||
| } = require('internal/inspector/network'); | ||
| const dc = require('diagnostics_channel'); | ||
| const { Network } = require('inspector'); | ||
|
|
||
| // Convert an undici request headers array to a plain object (Map<string, string>) | ||
| function requestHeadersArrayToDictionary(headers) { | ||
| const dict = {}; | ||
| for (let idx = 0; idx < headers.length; idx += 2) { | ||
| const key = `${headers[idx]}`; | ||
| const value = `${headers[idx + 1]}`; | ||
| dict[key] = value; | ||
| } | ||
| return dict; | ||
| }; | ||
|
|
||
| // Convert an undici response headers array to a plain object (Map<string, string>) | ||
| function responseHeadersArrayToDictionary(headers) { | ||
| const dict = {}; | ||
| for (let idx = 0; idx < headers.length; idx += 2) { | ||
| const key = `${headers[idx]}`; | ||
| const value = `${headers[idx + 1]}`; | ||
| const prevValue = dict[key]; | ||
|
|
||
| if (typeof prevValue === 'string') { | ||
| // ChromeDevTools frontend treats 'set-cookie' as a special case | ||
| // https://github.com/ChromeDevTools/devtools-frontend/blob/4275917f84266ef40613db3c1784a25f902ea74e/front_end/core/sdk/NetworkRequest.ts#L1368 | ||
| if (key.toLowerCase() === 'set-cookie') dict[key] = `${prevValue}\n${value}`; | ||
| else dict[key] = `${prevValue}, ${value}`; | ||
| } else { | ||
| dict[key] = value; | ||
| } | ||
| } | ||
| return dict; | ||
| }; | ||
|
|
||
| /** | ||
| * When a client request starts, emit Network.requestWillBeSent event. | ||
| * https://chromedevtools.github.io/devtools-protocol/1-3/Network/#event-requestWillBeSent | ||
| * @param {{ request: undici.Request }} event | ||
| */ | ||
| function onClientRequestStart({ request }) { | ||
| const url = `${request.origin}${request.path}`; | ||
| request[kInspectorRequestId] = getNextRequestId(); | ||
| Network.requestWillBeSent({ | ||
| requestId: request[kInspectorRequestId], | ||
| timestamp: getMonotonicTime(), | ||
| wallTime: DateNow(), | ||
| request: { | ||
| url, | ||
| method: request.method, | ||
| headers: requestHeadersArrayToDictionary(request.headers), | ||
| }, | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * When a client request errors, emit Network.loadingFailed event. | ||
| * https://chromedevtools.github.io/devtools-protocol/1-3/Network/#event-loadingFailed | ||
| * @param {{ request: undici.Request, error: any }} event | ||
| */ | ||
| function onClientRequestError({ request, error }) { | ||
| if (typeof request[kInspectorRequestId] !== 'string') { | ||
| return; | ||
| } | ||
| Network.loadingFailed({ | ||
| requestId: request[kInspectorRequestId], | ||
| timestamp: getMonotonicTime(), | ||
| // TODO(legendecas): distinguish between `undici.request` and `undici.fetch`. | ||
| type: kResourceType.Fetch, | ||
| errorText: error.message, | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * When response headers are received, emit Network.responseReceived event. | ||
| * https://chromedevtools.github.io/devtools-protocol/1-3/Network/#event-responseReceived | ||
| * @param {{ request: undici.Request, response: undici.Response }} event | ||
| */ | ||
| function onClientResponseHeaders({ request, response }) { | ||
| if (typeof request[kInspectorRequestId] !== 'string') { | ||
| return; | ||
| } | ||
| const url = `${request.origin}${request.path}`; | ||
| Network.responseReceived({ | ||
| requestId: request[kInspectorRequestId], | ||
| timestamp: getMonotonicTime(), | ||
| // TODO(legendecas): distinguish between `undici.request` and `undici.fetch`. | ||
| type: kResourceType.Fetch, | ||
| response: { | ||
| url, | ||
| status: response.statusCode, | ||
| statusText: response.statusText, | ||
| headers: responseHeadersArrayToDictionary(response.headers), | ||
| }, | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * When a response is completed, emit Network.loadingFinished event. | ||
| * https://chromedevtools.github.io/devtools-protocol/1-3/Network/#event-loadingFinished | ||
| * @param {{ request: undici.Request, response: undici.Response }} event | ||
| */ | ||
| function onClientResponseFinish({ request }) { | ||
| if (typeof request[kInspectorRequestId] !== 'string') { | ||
| return; | ||
| } | ||
| Network.loadingFinished({ | ||
| requestId: request[kInspectorRequestId], | ||
| timestamp: getMonotonicTime(), | ||
| }); | ||
| } | ||
|
|
||
| function enable() { | ||
| dc.subscribe('undici:request:create', onClientRequestStart); | ||
| dc.subscribe('undici:request:error', onClientRequestError); | ||
| dc.subscribe('undici:request:headers', onClientResponseHeaders); | ||
| dc.subscribe('undici:request:trailers', onClientResponseFinish); | ||
| } | ||
|
|
||
| function disable() { | ||
| dc.subscribe('undici:request:create', onClientRequestStart); | ||
| dc.subscribe('undici:request:error', onClientRequestError); | ||
| dc.subscribe('undici:request:headers', onClientResponseHeaders); | ||
| dc.subscribe('undici:request:trailers', onClientResponseFinish); | ||
| } | ||
|
|
||
| module.exports = { | ||
| enable, | ||
| disable, | ||
| }; |
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
Oops, something went wrong.