Function runBenchmark

modules/utilities/perf_util.ts:30–69

({
  id,
  url = '',
  params = [],
  ignoreBrowserSynchronization = true,
  microMetrics,
  work,
  prepare,
  setup,
}: {
  id: string;
  url?: string;
  params?: {name: string; value: any}[];
  ignoreBrowserSynchronization?: boolean;
  microMetrics?: {[key: string]: string};
  work?: (() => void) | (() => Promise<unknown>);
  prepare?: (() => void) | (() => Promise<unknown>);
  setup?: (() => void) | (() => Promise<unknown>);
})

let _cachedBenchpressSetup: Promise<BenchpressSetup> | null = null;

export async function runBenchmark({
  id,
  url = '',
  params = [],
  ignoreBrowserSynchronization = true,
  microMetrics,
  work,
  prepare,
  setup,
}: {
  id: string;
  url?: string;
  params?: {name: string; value: any}[];
  ignoreBrowserSynchronization?: boolean;
  microMetrics?: {[key: string]: string};
  work?: (() => void) | (() => Promise<unknown>);
  prepare?: (() => void) | (() => Promise<unknown>);
  setup?: (() => void) | (() => Promise<unknown>);
}): Promise<any> {
  if (_cachedBenchpressSetup === null) {
    _cachedBenchpressSetup = _prepareBenchpressSetup();
  }

  // Wait for the benchpress setup to complete initialization.
  // The benchpress setup is loaded asynchronously due to it relying on ESM.
  // TODO: This can be removed when benchmark tests/e2e tests can run with ESM.
  const {module, runner} = await _cachedBenchpressSetup;

  openBrowser({url, params, ignoreBrowserSynchronization});
  if (setup) {
    await setup();
  }
  return runner.sample({
    id,
    execute: work,
    prepare,
    microMetrics,
    providers: [{provide: module.Options.SAMPLE_DESCRIPTION, useValue: {}}],
  });
}

async function _prepareBenchpressSetup(): Promise<BenchpressSetup> {
  const module = await loadBenchpressModule();