Function measureWorkflow

ng-dev/perf/workflow/workflow.ts:5–43

({name, workflow, prepare, cleanup}: Workflow)

import {Workflow} from './loader.js';

export async function measureWorkflow({name, workflow, prepare, cleanup}: Workflow) {
  const spinner = new Spinner();
  try {
    if (prepare) {
      spinner.update('Preparing environment for workflow execution');
      // Run the `prepare` commands to establish the environment, caching, etc prior to running the
      // workflow.
      await runCommands(prepare);
      spinner.update('Environment preperation completed');
    }

    spinner.update(`Executing workflow (${name})`);
    // Mark the start time of the workflow, execute all of the commands provided in the workflow and
    // then mark the ending time.
    performance.mark('start');
    await runCommands(workflow);
    performance.mark('end');

    spinner.update('Workflow completed');

    if (cleanup) {
      spinner.update('Cleaning up environment after workflow');
      // Run the clean up commands to reset the environment and undo changes made during the workflow.
      await runCommands(cleanup);
      spinner.update('Environment cleanup complete');
    }

    const results = performance.measure(name, 'start', 'end');

    spinner.success(`${name}: ${results.duration.toFixed(2)}ms`);

    return {
      name,
      value: results.duration,
    };
  } finally {
    spinner.complete();
  }
}

/**
 * Run a set of commands provided as a multiline text block. Commands are assumed to always be