Class PerflogMetric

packages/benchpress/src/metric/perflog_metric.ts:19–420

 */
@Injectable()
export class PerflogMetric extends Metric {
  static SET_TIMEOUT = new InjectionToken('PerflogMetric.setTimeout');
  static IGNORE_NAVIGATION = new InjectionToken('PerflogMetric.ignoreNavigation');
  static PROVIDERS = [
    {
      provide: PerflogMetric,
      deps: [
        WebDriverExtension,
        PerflogMetric.SET_TIMEOUT,
        Options.MICRO_METRICS,
        Options.FORCE_GC,
        Options.CAPTURE_FRAMES,
        Options.RECEIVED_DATA,
        Options.REQUEST_COUNT,
        PerflogMetric.IGNORE_NAVIGATION,
      ],
    },
    {
      provide: PerflogMetric.SET_TIMEOUT,
      useValue: (fn: Function, millis: number) => <any>setTimeout(fn, millis),
    },
    {provide: PerflogMetric.IGNORE_NAVIGATION, useValue: false},
  ];

  private _remainingEvents: PerfLogEvent[];
  private _measureCount: number;
  private _perfLogFeatures: PerfLogFeatures;

  /**
   * @param driverExtension
   * @param setTimeout
   * @param microMetrics Name and description of metrics provided via console.time / console.timeEnd
   * @param ignoreNavigation If true, don't measure from navigationStart events. These events are
   *   usually triggered by a page load, but can also be triggered when adding iframes to the DOM.
   **/
  constructor(
    private _driverExtension: WebDriverExtension,
    @Inject(PerflogMetric.SET_TIMEOUT) private _setTimeout: Function,
    @Inject(Options.MICRO_METRICS) private _microMetrics: {[key: string]: string},
    @Inject(Options.FORCE_GC) private _forceGc: boolean,
    @Inject(Options.CAPTURE_FRAMES) private _captureFrames: boolean,
    @Inject(Options.RECEIVED_DATA) private _receivedData: boolean,
    @Inject(Options.REQUEST_COUNT) private _requestCount: boolean,
    @Inject(PerflogMetric.IGNORE_NAVIGATION) private _ignoreNavigation: boolean,
  ) {
    super();

    this._remainingEvents = [];
    this._measureCount = 0;
    this._perfLogFeatures = _driverExtension.perfLogFeatures();
    if (!this._perfLogFeatures.userTiming) {
      // User timing is needed for navigationStart.
      this._receivedData = false;
      this._requestCount = false;
    }
  }

  override describe(): {[key: string]: string} {