fixup types

GoogleChrome · May 5, 2017 · 75d8f4d · 75d8f4d
1 parent 11a1db3
commit 75d8f4d
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 12 deletions.
diff --git a/lighthouse-core/closure/typedefs/Artifacts.js b/lighthouse-core/closure/typedefs/Artifacts.js
@@ -20,6 +20,9 @@
  * @externs
  */
 
+/** @typedef {!Array<{method: string, params: (!Object<string, *>|undefined)}>} */
+let DevtoolsLog;
+
 /**
  * @constructor
  * @struct
@@ -84,3 +87,6 @@ Artifacts.prototype.CacheContents;
 
 /** @type {boolean|number} */
 Artifacts.prototype.GeolocationOnStart;
+
+/** @type {!Object<string, !DevtoolsLog>} */
+Artifacts.prototype.devtoolsLogs;
diff --git a/lighthouse-core/closure/typedefs/ComputedArtifacts.js b/lighthouse-core/closure/typedefs/ComputedArtifacts.js
@@ -30,9 +30,6 @@
   }} */
 let TraceOfTabArtifact;
 
-// @typedef <Array<!WebInspector.NetworkRequest>
-let NetworkRequests;
-
 /**
  * @constructor
  * @struct
@@ -43,7 +40,7 @@ function ComputedArtifacts() {}
 /** @type {function(!Array): !Promise<!Object>} */
 ComputedArtifacts.prototype.requestCriticalRequestChains;
 
-/** @type {function(!Array): !Promise<!NetworkRequests>} */
+/** @type {function(!DevtoolsLog): !Promise<!Array<!WebInspector.NetworkRequest>>} */
 ComputedArtifacts.prototype.requestNetworkRecords;
 
 /** @type {function(ManifestNode<(!Manifest|undefined)>): !Promise<{isParseFailure: boolean, parseFailureReason: string, allChecks: !Array<{passing: boolean, failureText: string}>}>} */

diff --git a/lighthouse-core/gather/computed/network-records.js b/lighthouse-core/gather/computed/network-records.js
@@ -15,8 +15,8 @@ class NetworkRecords extends ComputedArtifact {
   }
 
   /**
-   * @param {method: string, params: !Object<string, *>} devtoolsLog
-   * @return {!NetworkRequests} networkRecords
+   * @param {!DevtoolsLog} devtoolsLog
+   * @return {!Array<!WebInspector.NetworkRequest>} networkRecords
    */
   compute_(devtoolsLog) {
     return NetworkRecorder.recordsFromLogs(devtoolsLog);

diff --git a/lighthouse-core/gather/driver.js b/lighthouse-core/gather/driver.js
@@ -684,7 +684,7 @@ class Driver {
 
   /**
    * @param {!string} method
-   * @param {?Object} params
+   * @param {!Object<string, *>=} params
    */
   recordNetworkEvent(method, params) {
     if (!this._networkRecorder) return;

diff --git a/lighthouse-core/lib/network-recorder.js b/lighthouse-core/lib/network-recorder.js
@@ -24,7 +24,7 @@ class NetworkRecorder extends EventEmitter {
   /**
    * Creates an instance of NetworkRecorder.
    * @param {!Array} recordArray
-   * @param {?Driver} driver
+   * @param {!Driver=} driver
    */
   constructor(recordArray, driver) {
     super();
@@ -152,7 +152,7 @@ class NetworkRecorder extends EventEmitter {
   /**
    * Routes network events to their handlers, so we can construct networkRecords
    * @param {!string} method
-   * @param {?Object} params
+   * @param {!Object<string, *>=} params
    */
   dispatch(method, params) {
     switch (method) {
@@ -167,11 +167,16 @@ class NetworkRecorder extends EventEmitter {
     }
   }
 
-  static recordsFromLogs(logs) {
+  /**
+   * Construct network records from a log of devtools protocol messages.
+   * @param {!DevtoolsLog} log
+   * @return {!Array<!WebInspector.NetworkRequest>}
+   */
+  static recordsFromLogs(log) {
     const records = [];
     const nr = new NetworkRecorder(records);
-    logs.forEach(networkEvent => {
-      nr.dispatch(networkEvent.method, networkEvent.params);
+    log.forEach(event => {
+      nr.dispatch(event.method, event.params);
     });
     return records;
   }