NetworkAgent.js 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300
  1. /**
  2. * Copyright (c) Facebook, Inc. and its affiliates.
  3. *
  4. * This source code is licensed under the MIT license found in the
  5. * LICENSE file in the root directory of this source tree.
  6. *
  7. * @format
  8. * @flow
  9. */
  10. 'use strict';
  11. const InspectorAgent = require('./InspectorAgent');
  12. const JSInspector = require('./JSInspector');
  13. const XMLHttpRequest = require('../Network/XMLHttpRequest');
  14. import type EventSender from './InspectorAgent';
  15. type RequestId = string;
  16. type LoaderId = string;
  17. type FrameId = string;
  18. type Timestamp = number;
  19. type Headers = Object;
  20. // We don't currently care about this
  21. type ResourceTiming = null;
  22. type ResourceType =
  23. | 'Document'
  24. | 'Stylesheet'
  25. | 'Image'
  26. | 'Media'
  27. | 'Font'
  28. | 'Script'
  29. | 'TextTrack'
  30. | 'XHR'
  31. | 'Fetch'
  32. | 'EventSource'
  33. | 'WebSocket'
  34. | 'Manifest'
  35. | 'Other';
  36. type SecurityState =
  37. | 'unknown'
  38. | 'neutral'
  39. | 'insecure'
  40. | 'warning'
  41. | 'secure'
  42. | 'info';
  43. type BlockedReason =
  44. | 'csp'
  45. | 'mixed-content'
  46. | 'origin'
  47. | 'inspector'
  48. | 'subresource-filter'
  49. | 'other';
  50. type StackTrace = null;
  51. type Initiator = {
  52. type: 'script' | 'other',
  53. stackTrace?: StackTrace,
  54. url?: string,
  55. lineNumber?: number,
  56. ...
  57. };
  58. type ResourcePriority = 'VeryLow' | 'Low' | 'Medium' | 'High' | 'VeryHigh';
  59. type Request = {
  60. url: string,
  61. method: string,
  62. headers: Headers,
  63. postData?: string,
  64. mixedContentType?: 'blockable' | 'optionally-blockable' | 'none',
  65. initialPriority: ResourcePriority,
  66. ...
  67. };
  68. type Response = {
  69. url: string,
  70. status: number,
  71. statusText: string,
  72. headers: Headers,
  73. headersText?: string,
  74. mimeType: string,
  75. requestHeaders?: Headers,
  76. requestHeadersText?: string,
  77. connectionReused: boolean,
  78. connectionId: number,
  79. fromDiskCache?: boolean,
  80. encodedDataLength: number,
  81. timing?: ResourceTiming,
  82. securityState: SecurityState,
  83. ...
  84. };
  85. type RequestWillBeSentEvent = {
  86. requestId: RequestId,
  87. frameId: FrameId,
  88. loaderId: LoaderId,
  89. documentURL: string,
  90. request: Request,
  91. timestamp: Timestamp,
  92. initiator: Initiator,
  93. redirectResponse?: Response,
  94. // This is supposed to be optional but the inspector crashes without it,
  95. // see https://bugs.chromium.org/p/chromium/issues/detail?id=653138
  96. type: ResourceType,
  97. ...
  98. };
  99. type ResponseReceivedEvent = {
  100. requestId: RequestId,
  101. frameId: FrameId,
  102. loaderId: LoaderId,
  103. timestamp: Timestamp,
  104. type: ResourceType,
  105. response: Response,
  106. ...
  107. };
  108. type DataReceived = {
  109. requestId: RequestId,
  110. timestamp: Timestamp,
  111. dataLength: number,
  112. encodedDataLength: number,
  113. ...
  114. };
  115. type LoadingFinishedEvent = {
  116. requestId: RequestId,
  117. timestamp: Timestamp,
  118. encodedDataLength: number,
  119. ...
  120. };
  121. type LoadingFailedEvent = {
  122. requestId: RequestId,
  123. timestamp: Timestamp,
  124. type: ResourceType,
  125. errorText: string,
  126. canceled?: boolean,
  127. blockedReason?: BlockedReason,
  128. ...
  129. };
  130. class Interceptor {
  131. _agent: NetworkAgent;
  132. _requests: Map<string, string>;
  133. constructor(agent: NetworkAgent) {
  134. this._agent = agent;
  135. this._requests = new Map();
  136. }
  137. getData(requestId: string): ?string {
  138. return this._requests.get(requestId);
  139. }
  140. requestSent(id: number, url: string, method: string, headers: Object) {
  141. const requestId = String(id);
  142. this._requests.set(requestId, '');
  143. const request: Request = {
  144. url,
  145. method,
  146. headers,
  147. initialPriority: 'Medium',
  148. };
  149. const event: RequestWillBeSentEvent = {
  150. requestId,
  151. documentURL: '',
  152. frameId: '1',
  153. loaderId: '1',
  154. request,
  155. timestamp: JSInspector.getTimestamp(),
  156. initiator: {
  157. // TODO(blom): Get stack trace
  158. // If type is 'script' the inspector will try to execute
  159. // `stack.callFrames[0]`
  160. type: 'other',
  161. },
  162. type: 'Other',
  163. };
  164. this._agent.sendEvent('requestWillBeSent', event);
  165. }
  166. responseReceived(id: number, url: string, status: number, headers: Object) {
  167. const requestId = String(id);
  168. const response: Response = {
  169. url,
  170. status,
  171. statusText: String(status),
  172. headers,
  173. // TODO(blom) refined headers, can we get this?
  174. requestHeaders: {},
  175. mimeType: this._getMimeType(headers),
  176. connectionReused: false,
  177. connectionId: -1,
  178. encodedDataLength: 0,
  179. securityState: 'unknown',
  180. };
  181. const event: ResponseReceivedEvent = {
  182. requestId,
  183. frameId: '1',
  184. loaderId: '1',
  185. timestamp: JSInspector.getTimestamp(),
  186. type: 'Other',
  187. response,
  188. };
  189. this._agent.sendEvent('responseReceived', event);
  190. }
  191. dataReceived(id: number, data: string) {
  192. const requestId = String(id);
  193. const existingData = this._requests.get(requestId) || '';
  194. this._requests.set(requestId, existingData.concat(data));
  195. const event: DataReceived = {
  196. requestId,
  197. timestamp: JSInspector.getTimestamp(),
  198. dataLength: data.length,
  199. encodedDataLength: data.length,
  200. };
  201. this._agent.sendEvent('dataReceived', event);
  202. }
  203. loadingFinished(id: number, encodedDataLength: number) {
  204. const event: LoadingFinishedEvent = {
  205. requestId: String(id),
  206. timestamp: JSInspector.getTimestamp(),
  207. encodedDataLength: encodedDataLength,
  208. };
  209. this._agent.sendEvent('loadingFinished', event);
  210. }
  211. loadingFailed(id: number, error: string) {
  212. const event: LoadingFailedEvent = {
  213. requestId: String(id),
  214. timestamp: JSInspector.getTimestamp(),
  215. type: 'Other',
  216. errorText: error,
  217. };
  218. this._agent.sendEvent('loadingFailed', event);
  219. }
  220. _getMimeType(headers: Object): string {
  221. const contentType = headers['Content-Type'] || '';
  222. return contentType.split(';')[0];
  223. }
  224. }
  225. type EnableArgs = {
  226. maxResourceBufferSize?: number,
  227. maxTotalBufferSize?: number,
  228. ...
  229. };
  230. class NetworkAgent extends InspectorAgent {
  231. static DOMAIN: $TEMPORARY$string<'Network'> = 'Network';
  232. _sendEvent: EventSender;
  233. _interceptor: ?Interceptor;
  234. enable({maxResourceBufferSize, maxTotalBufferSize}: EnableArgs) {
  235. this._interceptor = new Interceptor(this);
  236. XMLHttpRequest.setInterceptor(this._interceptor);
  237. }
  238. disable() {
  239. XMLHttpRequest.setInterceptor(null);
  240. this._interceptor = null;
  241. }
  242. getResponseBody({
  243. requestId,
  244. }: {
  245. requestId: RequestId,
  246. ...
  247. }): {
  248. body: ?string,
  249. base64Encoded: boolean,
  250. ...
  251. } {
  252. return {body: this.interceptor().getData(requestId), base64Encoded: false};
  253. }
  254. interceptor(): Interceptor {
  255. if (this._interceptor) {
  256. return this._interceptor;
  257. } else {
  258. throw Error('_interceptor can not be null');
  259. }
  260. }
  261. }
  262. module.exports = NetworkAgent;