lighthouse 10.4.0 → 11.0.0

package/core/legacy/gather/connections/connection.d.ts

@@ -1,77 +0,0 @@
-export type ProtocolEventRecord = {
-    'protocolevent': [LH.Protocol.RawEventMessage];
-};
-export type CrdpEventMessageEmitter = LH.Protocol.StrictEventEmitter<ProtocolEventRecord>;
-export type CommandInfo = LH.CrdpCommands[keyof LH.CrdpCommands];
-export type CommandCallback = {
-    resolve: (arg0: Promise<CommandInfo['returnType']>) => void;
-    method: keyof LH.CrdpCommands;
-};
-/**
- * @typedef {{'protocolevent': [LH.Protocol.RawEventMessage]}} ProtocolEventRecord
- * @typedef {LH.Protocol.StrictEventEmitter<ProtocolEventRecord>} CrdpEventMessageEmitter
- * @typedef {LH.CrdpCommands[keyof LH.CrdpCommands]} CommandInfo
- * @typedef {{resolve: function(Promise<CommandInfo['returnType']>): void, method: keyof LH.CrdpCommands}} CommandCallback
- */
-export class Connection {
-    _lastCommandId: number;
-    /** @type {Map<number, CommandCallback>} */
-    _callbacks: Map<number, CommandCallback>;
-    /** @type {Map<string, LH.Protocol.TargetType>} */
-    _sessionIdToTargetType: Map<string, LH.Protocol.TargetType>;
-    _eventEmitter: CrdpEventMessageEmitter | null;
-    /**
-     * @return {Promise<void>}
-     */
-    connect(): Promise<void>;
-    /**
-     * @return {Promise<void>}
-     */
-    disconnect(): Promise<void>;
-    /**
-     * @return {Promise<string>}
-     */
-    wsEndpoint(): Promise<string>;
-    /**
-     * Call protocol methods
-     * @template {keyof LH.CrdpCommands} C
-     * @param {C} method
-     * @param {string|undefined} sessionId
-     * @param {LH.CrdpCommands[C]['paramsType']} paramArgs,
-     * @return {Promise<LH.CrdpCommands[C]['returnType']>}
-     */
-    sendCommand<C extends keyof LH.CrdpCommands>(method: C, sessionId: string | undefined, ...paramArgs: LH.CrdpCommands[C]["paramsType"]): Promise<LH.CrdpCommands[C]["returnType"]>;
-    /**
-     * Bind listeners for connection events.
-     * @param {'protocolevent'} eventName
-     * @param {function(LH.Protocol.RawEventMessage): void} cb
-     */
-    on(eventName: 'protocolevent', cb: (arg0: LH.Protocol.RawEventMessage) => void): void;
-    /**
-     * Unbind listeners for connection events.
-     * @param {'protocolevent'} eventName
-     * @param {function(LH.Protocol.RawEventMessage): void} cb
-     */
-    off(eventName: 'protocolevent', cb: (arg0: LH.Protocol.RawEventMessage) => void): void;
-    /**
-     * @param {string} message
-     * @protected
-     */
-    protected sendRawMessage(message: string): void;
-    /**
-     * @param {string} message
-     * @return {void}
-     * @protected
-     */
-    protected handleRawMessage(message: string): void;
-    /**
-     * @param {LH.Protocol.RawEventMessage} eventMessage
-     */
-    emitProtocolEvent(eventMessage: LH.Protocol.RawEventMessage): void;
-    /**
-     * @protected
-     */
-    protected dispose(): void;
-}
-import * as LH from '../../../../types/lh.js';
-//# sourceMappingURL=connection.d.ts.map

package/core/legacy/gather/connections/connection.js

@@ -1,196 +0,0 @@
-/**
- * @license Copyright 2016 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-
-import {EventEmitter} from 'events';
-
-import log from 'lighthouse-logger';
-
-import * as LH from '../../../../types/lh.js';
-import {LighthouseError} from '../../../lib/lh-error.js';
-
-// TODO(bckenny): CommandCallback properties should be tied by command type after
-// https://github.com/Microsoft/TypeScript/pull/22348. See driver.js TODO.
-/**
- * @typedef {{'protocolevent': [LH.Protocol.RawEventMessage]}} ProtocolEventRecord
- * @typedef {LH.Protocol.StrictEventEmitter<ProtocolEventRecord>} CrdpEventMessageEmitter
- * @typedef {LH.CrdpCommands[keyof LH.CrdpCommands]} CommandInfo
- * @typedef {{resolve: function(Promise<CommandInfo['returnType']>): void, method: keyof LH.CrdpCommands}} CommandCallback
- */
-
-class Connection {
-  constructor() {
-    this._lastCommandId = 0;
-    /** @type {Map<number, CommandCallback>} */
-    this._callbacks = new Map();
-    /** @type {Map<string, LH.Protocol.TargetType>} */
-    this._sessionIdToTargetType = new Map();
-
-    this._eventEmitter = /** @type {?CrdpEventMessageEmitter} */ (new EventEmitter());
-  }
-
-  /**
-   * @return {Promise<void>}
-   */
-  connect() {
-    return Promise.reject(new Error('Not implemented'));
-  }
-
-  /**
-   * @return {Promise<void>}
-   */
-  disconnect() {
-    return Promise.reject(new Error('Not implemented'));
-  }
-
-  /**
-   * @return {Promise<string>}
-   */
-  wsEndpoint() {
-    return Promise.reject(new Error('Not implemented'));
-  }
-
-  /**
-   * Call protocol methods
-   * @template {keyof LH.CrdpCommands} C
-   * @param {C} method
-   * @param {string|undefined} sessionId
-   * @param {LH.CrdpCommands[C]['paramsType']} paramArgs,
-   * @return {Promise<LH.CrdpCommands[C]['returnType']>}
-   */
-  sendCommand(method, sessionId, ...paramArgs) {
-    // Reify params since we need it as a property so can't just spread again.
-    const params = paramArgs.length ? paramArgs[0] : undefined;
-
-    log.formatProtocol('method => browser', {method, params}, 'verbose');
-    const id = ++this._lastCommandId;
-    const message = JSON.stringify({id, sessionId, method, params});
-    this.sendRawMessage(message);
-
-    return new Promise(resolve => {
-      this._callbacks.set(id, {method, resolve});
-    });
-  }
-
-  /**
-   * Bind listeners for connection events.
-   * @param {'protocolevent'} eventName
-   * @param {function(LH.Protocol.RawEventMessage): void} cb
-   */
-  on(eventName, cb) {
-    if (eventName !== 'protocolevent') {
-      throw new Error('Only supports "protocolevent" events');
-    }
-
-    if (!this._eventEmitter) {
-      throw new Error('Attempted to add event listener after connection disposed.');
-    }
-    this._eventEmitter.on(eventName, cb);
-  }
-
-  /**
-   * Unbind listeners for connection events.
-   * @param {'protocolevent'} eventName
-   * @param {function(LH.Protocol.RawEventMessage): void} cb
-   */
-  off(eventName, cb) {
-    if (eventName !== 'protocolevent') {
-      throw new Error('Only supports "protocolevent" events');
-    }
-
-    if (!this._eventEmitter) {
-      throw new Error('Attempted to remove event listener after connection disposed.');
-    }
-    this._eventEmitter.removeListener(eventName, cb);
-  }
-
-  /* eslint-disable no-unused-vars */
-
-  /**
-   * @param {string} message
-   * @protected
-   */
-  sendRawMessage(message) {
-    throw new Error('Not implemented');
-  }
-
-  /* eslint-enable no-unused-vars */
-
-  /**
-   * @param {string} message
-   * @return {void}
-   * @protected
-   */
-  handleRawMessage(message) {
-    /** @type {LH.Protocol.RawMessage} */
-    const object = JSON.parse(message);
-
-    // Responses to commands carry "id" property, while events do not.
-    if (!('id' in object)) {
-      log.formatProtocol('<= event',
-          {method: object.method, params: object.params}, 'verbose');
-      if (object.method === 'Target.attachedToTarget') {
-        const type = object.params.targetInfo.type;
-        if (type === 'page' || type === 'iframe') {
-          this._sessionIdToTargetType.set(object.params.sessionId, type);
-        }
-      }
-      if (object.sessionId) {
-        const type = this._sessionIdToTargetType.get(object.sessionId);
-        if (type) {
-          object.targetType = type;
-        }
-      }
-      this.emitProtocolEvent(object);
-      return;
-    }
-
-    const callback = this._callbacks.get(object.id);
-    if (callback) {
-      this._callbacks.delete(object.id);
-
-      callback.resolve(Promise.resolve().then(_ => {
-        if (object.error) {
-          log.formatProtocol('method <= browser ERR', {method: callback.method}, 'error');
-          throw LighthouseError.fromProtocolMessage(callback.method, object.error);
-        }
-
-        log.formatProtocol('method <= browser OK',
-          {method: callback.method, params: object.result}, 'verbose');
-        return object.result;
-      }));
-    } else {
-      // In DevTools we receive responses to commands we did not send which we cannot act on, so we
-      // just log these occurrences.
-      const error = object.error?.message;
-      log.formatProtocol(`disowned method <= browser ${error ? 'ERR' : 'OK'}`,
-          {method: 'UNKNOWN', params: error || object.result}, 'verbose');
-    }
-  }
-
-  /**
-   * @param {LH.Protocol.RawEventMessage} eventMessage
-   */
-  emitProtocolEvent(eventMessage) {
-    if (!this._eventEmitter) {
-      throw new Error('Attempted to emit event after connection disposed.');
-    }
-
-    this._eventEmitter.emit('protocolevent', eventMessage);
-  }
-
-  /**
-   * @protected
-   */
-  dispose() {
-    if (this._eventEmitter) {
-      this._eventEmitter.removeAllListeners();
-      this._eventEmitter = null;
-    }
-    this._sessionIdToTargetType.clear();
-  }
-}
-
-export {Connection};

package/core/legacy/gather/connections/cri.d.ts

@@ -1,27 +0,0 @@
-export class CriConnection extends Connection {
-    /**
-     * @param {number=} port Optional port number. Defaults to 9222;
-     * @param {string=} hostname Optional hostname. Defaults to localhost.
-     * @constructor
-     */
-    constructor(port?: number | undefined, hostname?: string | undefined);
-    port: number;
-    hostname: string;
-    _ws: WebSocket | null;
-    _pageId: string | null;
-    /**
-     * @param {LH.DevToolsJsonTarget} response
-     * @return {Promise<void>}
-     * @private
-     */
-    private _connectToSocket;
-    /**
-     * @param {string} command
-     * @return {Promise<LH.DevToolsJsonTarget | Array<LH.DevToolsJsonTarget> | {message: string}>}
-     * @private
-     */
-    private _runJsonCommand;
-}
-import { Connection } from './connection.js';
-import WebSocket from 'ws';
-//# sourceMappingURL=cri.d.ts.map

package/core/legacy/gather/connections/cri.js

@@ -1,162 +0,0 @@
-/**
- * @license Copyright 2016 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-
-import http from 'http';
-
-import WebSocket from 'ws';
-import log from 'lighthouse-logger';
-
-import {Connection} from './connection.js';
-import {LighthouseError} from '../../../lib/lh-error.js';
-
-const DEFAULT_HOSTNAME = '127.0.0.1';
-const CONNECT_TIMEOUT = 10000;
-const DEFAULT_PORT = 9222;
-
-class CriConnection extends Connection {
-  /**
-   * @param {number=} port Optional port number. Defaults to 9222;
-   * @param {string=} hostname Optional hostname. Defaults to localhost.
-   * @constructor
-   */
-  constructor(port = DEFAULT_PORT, hostname = DEFAULT_HOSTNAME) {
-    super();
-    this.port = port;
-    this.hostname = hostname;
-    this._ws = null;
-    this._pageId = null;
-  }
-
-  /**
-   * @override
-   * @return {Promise<void>}
-   */
-  async connect() {
-    const response = await this._runJsonCommand('new');
-    return this._connectToSocket(/** @type {LH.DevToolsJsonTarget} */(response));
-  }
-
-  /**
-   * @param {LH.DevToolsJsonTarget} response
-   * @return {Promise<void>}
-   * @private
-   */
-  _connectToSocket(response) {
-    const url = response.webSocketDebuggerUrl;
-    this._pageId = response.id;
-
-    return new Promise((resolve, reject) => {
-      const ws = new WebSocket(url, {
-        perMessageDeflate: false,
-      });
-      ws.on('open', () => {
-        this._ws = ws;
-        resolve();
-      });
-      ws.on('message', data => this.handleRawMessage(/** @type {string} */ (data)));
-      ws.on('close', this.dispose.bind(this));
-      ws.on('error', reject);
-    });
-  }
-
-  /**
-   * @param {string} command
-   * @return {Promise<LH.DevToolsJsonTarget | Array<LH.DevToolsJsonTarget> | {message: string}>}
-   * @private
-   */
-  _runJsonCommand(command) {
-    return new Promise((resolve, reject) => {
-      const request = http.request({
-        method: 'PUT', // GET and POST are deprecated: https://crrev.com/c/3595822
-        hostname: this.hostname,
-        port: this.port,
-        path: '/json/' + command,
-      }, response => {
-        let data = '';
-        response.setEncoding('utf8');
-        response.on('data', chunk => {
-          data += chunk;
-        });
-        response.on('end', () => {
-          if (response.statusCode === 200) {
-            try {
-              resolve(JSON.parse(data));
-              return;
-            } catch (e) {
-              // In the case of 'close' & 'activate' Chromium returns a string rather than JSON: goo.gl/7v27xD
-              if (data === 'Target is closing' || data === 'Target activated') {
-                return resolve({message: data});
-              }
-              return reject(e);
-            }
-          }
-          reject(new Error(`Protocol JSON API error (${command}), status: ${response.statusCode}`));
-        });
-      });
-
-      request.end();
-
-      // This error handler is critical to ensuring Lighthouse exits cleanly even when Chrome crashes.
-      // See https://github.com/GoogleChrome/lighthouse/pull/8583.
-      request.on('error', reject);
-
-      request.setTimeout(CONNECT_TIMEOUT, () => {
-        // Reject on error with code specifically indicating timeout in connection setup.
-        const err = new LighthouseError(LighthouseError.errors.CRI_TIMEOUT);
-        log.error('CriConnection', err.friendlyMessage);
-        reject(err);
-
-        request.abort();
-      });
-    });
-  }
-
-  /**
-   * @override
-   * @return {Promise<void>}
-   */
-  disconnect() {
-    if (!this._ws) {
-      log.warn('CriConnection', 'disconnect() was called without an established connection.');
-      return Promise.resolve();
-    }
-
-    return this._runJsonCommand(`close/${this._pageId}`).then(_ => {
-      if (this._ws) {
-        this._ws.removeAllListeners();
-        this._ws.close();
-        this._ws = null;
-      }
-      this._pageId = null;
-    });
-  }
-
-  /**
-   * @override
-   * @return {Promise<string>}
-   */
-  wsEndpoint() {
-    return this._runJsonCommand('version').then(response => {
-      return /** @type {LH.DevToolsJsonTarget} */ (response).webSocketDebuggerUrl;
-    });
-  }
-
-
-  /**
-   * @override
-   * @param {string} message
-   * @protected
-   */
-  sendRawMessage(message) {
-    if (!this._ws) {
-      log.error('CriConnection', 'sendRawMessage() was called without an established connection.');
-      throw new Error('sendRawMessage() was called without an established connection.');
-    }
-    this._ws.send(message);
-  }
-}
-
-export {CriConnection};

package/core/legacy/gather/connections/raw.d.ts

@@ -1,20 +0,0 @@
-export type Port = {
-    on: (eventName: 'message' | 'close', cb: ((arg: string) => void) | (() => void)) => void;
-    send: (message: string) => void;
-    close: () => void;
-};
-/**
- * @typedef {object} Port
- * @property {(eventName: 'message'|'close', cb: ((arg: string) => void) | (() => void)) => void} on
- * @property {(message: string) => void} send
- * @property {() => void} close
- */
-export class RawConnection extends Connection {
-    /**
-     * @param {Port} port
-     */
-    constructor(port: Port);
-    _port: Port;
-}
-import { Connection } from './connection.js';
-//# sourceMappingURL=raw.d.ts.map

package/core/legacy/gather/connections/raw.js

@@ -1,57 +0,0 @@
-/**
- * @license Copyright 2016 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-
-import {Connection} from './connection.js';
-
-/* eslint-disable no-unused-vars */
-
-/**
- * @typedef {object} Port
- * @property {(eventName: 'message'|'close', cb: ((arg: string) => void) | (() => void)) => void} on
- * @property {(message: string) => void} send
- * @property {() => void} close
- */
-
-/* eslint-enable no-unused-vars */
-
-class RawConnection extends Connection {
-  /**
-   * @param {Port} port
-   */
-  constructor(port) {
-    super();
-    this._port = port;
-    this._port.on('message', this.handleRawMessage.bind(this));
-    this._port.on('close', this.dispose.bind(this));
-  }
-
-  /**
-   * @override
-   * @return {Promise<void>}
-   */
-  connect() {
-    return Promise.resolve();
-  }
-
-  /**
-   * @return {Promise<void>}
-   */
-  disconnect() {
-    this._port.close();
-    return Promise.resolve();
-  }
-
-  /**
-   * @override
-   * @param {string} message
-   * @protected
-   */
-  sendRawMessage(message) {
-    this._port.send(message);
-  }
-}
-
-export {RawConnection};