feat(@angular-devkit/benchmark): add capabilities to benchmark watch processes

Author: alan-agius4

etc/api/angular_devkit/benchmark/src/index.d.ts

@@ -19,7 +19,7 @@ export declare const aggregateMetrics: (m1: Metric | AggregatedMetric, m2: Metri
 
 export declare type BenchmarkReporter = (command: Command, groups: MetricGroup[]) => void;
 
-export declare type Capture = (process: MonitoredProcess) => Observable<MetricGroup>;
+export declare type Capture = (stats: Observable<AggregatedProcessStats>) => Observable<MetricGroup>;
 
 export declare class Command {
     args: string[];
@@ -40,7 +40,8 @@ export declare class LocalMonitoredProcess implements MonitoredProcess {
     stats$: Observable<AggregatedProcessStats>;
     stderr$: Observable<Buffer>;
     stdout$: Observable<Buffer>;
-    constructor(command: Command);
+    constructor(command: Command, useProcessTime?: boolean);
+    resetElapsedTimer(): void;
     run(): Observable<number>;
 }
 
@@ -89,3 +90,11 @@ export interface RunBenchmarkOptions {
     reporters: BenchmarkReporter[];
     retries?: number;
 }
+
+export declare function runBenchmarkWatch({ command, captures, reporters, iterations, retries, logger, watchMatcher, watchTimeout, watchCommand, }: RunBenchmarkWatchOptions): Observable<MetricGroup[]>;
+
+export interface RunBenchmarkWatchOptions extends RunBenchmarkOptions {
+    watchCommand: Command;
+    watchMatcher: string;
+    watchTimeout?: number;
+}

packages/angular_devkit/benchmark/BUILD

@@ -45,6 +45,9 @@ ts_library(
         "src/test/exit-code-one.js",
         "src/test/fibonacci.js",
         "src/test/test-script.js",
+        "src/test/watch-test-cmd.js",
+        "src/test/watch-test-file.txt",
+        "src/test/watch-test-script.js",
     ],
     # @external_begin
     tsconfig = "//:tsconfig-test.json",

packages/angular_devkit/benchmark/README.md

@@ -72,6 +72,21 @@ $ benchmark -- node fibonacci.js 40
 [benchmark]   Peak Memory usage: 22.34 MB (22.32, 22.34, 22.34, 22.35, 22.35)
 ```
 
+## Example in watch mode
+
+```
+benchmark --verbose --watch-timeout=10000 --watch-matcher="Compiled successfully" --watch-script  watch-script.js -- ng serve
+[benchmark] Benchmarking process over 5 iterations, with up to 5 retries.
+[benchmark]   ng serve (at D:\sandbox\latest-project)
+[benchmark] Process Stats
+[benchmark]   Elapsed Time: 470.40 ms (820.00, 557.00, 231.00, 509.00, 235.00)
+[benchmark]   Average Process usage: 2.00 process(es) (2.00, 2.00, 2.00, 2.00, 2.00)
+[benchmark]   Peak Process usage: 2.00 process(es) (2.00, 2.00, 2.00, 2.00, 2.00)
+[benchmark]   Average CPU usage: 33.77 % (31.27, 0.00, 101.70, 35.90, 0.00)
+[benchmark]   Peak CPU usage: 59.72 % (125.10, 0.00, 101.70, 71.80, 0.00)
+[benchmark]   Average Memory usage: 665.49 MB (619.84, 657.17, 669.47, 685.19, 695.76)
+[benchmark]   Peak Memory usage: 672.44 MB (639.87, 661.04, 669.47, 689.66, 702.14)
+```
 
 ## API Usage
 

packages/angular_devkit/benchmark/src/default-stats-capture.ts

@@ -13,7 +13,7 @@ import { cumulativeMovingAverage, max } from './utils';
 
 
 export const defaultStatsCapture: Capture = (
-  process: MonitoredProcess,
+  stats: Observable<AggregatedProcessStats>,
 ): Observable<MetricGroup> => {
   type Accumulator = {
     elapsed: number,
@@ -34,7 +34,7 @@ export const defaultStatsCapture: Capture = (
     peakMemory: 0,
   };
 
-  return process.stats$.pipe(
+  return stats.pipe(
     reduce<AggregatedProcessStats, Accumulator>((acc, val, idx) => ({
       elapsed: val.elapsed,
       avgProcesses: cumulativeMovingAverage(acc.avgProcesses, val.processes, idx),

packages/angular_devkit/benchmark/src/default-stats-capture_spec.ts

@@ -8,7 +8,7 @@
 import { Observable } from 'rxjs';
 import { toArray } from 'rxjs/operators';
 import { defaultStatsCapture } from './default-stats-capture';
-import { AggregatedProcessStats, MonitoredProcess } from './interfaces';
+import { AggregatedProcessStats } from './interfaces';
 
 
 describe('defaultStatsCapture', () => {
@@ -29,9 +29,8 @@ describe('defaultStatsCapture', () => {
       });
       obs.complete();
     });
-    const process = { stats$ } as {} as MonitoredProcess;
 
-    const res = await defaultStatsCapture(process).pipe(toArray()).toPromise();
+    const res = await defaultStatsCapture(stats$).pipe(toArray()).toPromise();
     expect(res).toEqual([{
       name: 'Process Stats',
       metrics: [

packages/angular_devkit/benchmark/src/index.ts

@@ -12,5 +12,6 @@ export * from './default-reporter';
 export * from './default-stats-capture';
 export * from './monitored-process';
 export * from './run-benchmark';
+export * from './run-benchmark-watch';
 export * from './utils';
 export * from './main';

packages/angular_devkit/benchmark/src/interfaces.ts

@@ -51,7 +51,8 @@ export interface MetricGroup {
   metrics: (Metric | AggregatedMetric)[];
 }
 
-export type Capture = (process: MonitoredProcess) => Observable<MetricGroup>;
+export type Capture = (stats: Observable<AggregatedProcessStats>) => Observable<MetricGroup>;
+
 
 // TODO: might need to allow reporters to say they are finished.
 export type BenchmarkReporter = (command: Command, groups: MetricGroup[]) => void;

packages/angular_devkit/benchmark/src/main.ts

@@ -16,6 +16,7 @@ import { Command } from '../src/command';
 import { defaultReporter } from '../src/default-reporter';
 import { defaultStatsCapture } from '../src/default-stats-capture';
 import { runBenchmark } from '../src/run-benchmark';
+import { runBenchmarkWatch } from './run-benchmark-watch';
 
 
 export interface MainOptions {
@@ -47,6 +48,9 @@ export async function main({
         --output-file             File to output benchmark log to.
         --overwrite-output-file   If the output file should be overwritten rather than appended to.
         --prefix                  Logging prefix.
+        --watch-matcher           Text to match in stdout to mark an iteration complete.
+        --watch-timeout           The maximum time in 'ms' to wait for the text specified in the matcher to be matched. Default is 10000.
+        --watch-script            Script to run before each watch iteration.
 
     Example:
         benchmark --iterations=3 -- node my-script.js
@@ -63,19 +67,27 @@ export async function main({
     'output-file': string | null;
     cwd: string;
     prefix: string;
+    'watch-timeout': number;
+    'watch-matcher'?: string;
+    'watch-script'?: string;
     '--': string[] | null;
   }
 
   // Parse the command line.
   const argv = minimist(args, {
     boolean: ['help', 'verbose', 'overwrite-output-file'],
+    string: [
+      'watch-matcher',
+      'watch-script',
+    ],
     default: {
       'exit-code': 0,
       'iterations': 5,
       'retries': 5,
       'output-file': null,
       'cwd': process.cwd(),
       'prefix': '[benchmark]',
+      'watch-timeout': 10000,
     },
     '--': true,
   }) as {} as BenchmarkCliArgv;
@@ -127,6 +139,29 @@ export async function main({
 
   const commandArgv = argv['--'];
 
+  const {
+    'watch-timeout': watchTimeout,
+    'watch-matcher': watchMatcher,
+    'watch-script': watchScript,
+    'exit-code': exitCode,
+    'output-file': outFile,
+    iterations,
+    retries,
+   } = argv;
+
+  // Exit early if we can't find the command to benchmark.
+  if (watchMatcher && !watchScript) {
+    logger.fatal(`Cannot use --watch-matcher without specifying --watch-script.`);
+
+    return 1;
+  }
+
+  if (!watchMatcher && watchScript) {
+    logger.fatal(`Cannot use --watch-script without specifying --watch-matcher.`);
+
+    return 1;
+  }
+
   // Exit early if we can't find the command to benchmark.
   if (!commandArgv || !Array.isArray(argv['--']) || (argv['--'] as Array<string>).length < 1) {
     logger.fatal(`Missing command, see benchmark --help for help.`);
@@ -135,32 +170,42 @@ export async function main({
   }
 
   // Setup file logging.
-  if (argv['output-file'] !== null) {
+  if (outFile !== null) {
     if (argv['overwrite-output-file']) {
-      writeFileSync(argv['output-file'] as string, '');
+      writeFileSync(outFile, '');
     }
     logger.pipe(filter(entry => (entry.level != 'debug' || argv['verbose'])))
-      .subscribe(entry => appendFileSync(argv['output-file'] as string, `${entry.message}\n`));
+      .subscribe(entry => appendFileSync(outFile, `${entry.message}\n`));
   }
 
   // Run benchmark on given command, capturing stats and reporting them.
-  const exitCode = argv['exit-code'];
   const cmd = commandArgv[0];
   const cmdArgs = commandArgv.slice(1);
   const command = new Command(cmd, cmdArgs, argv['cwd'], exitCode);
   const captures = [defaultStatsCapture];
   const reporters = [defaultReporter(logger)];
-  const iterations = argv['iterations'];
-  const retries = argv['retries'];
 
   logger.info(`Benchmarking process over ${iterations} iterations, with up to ${retries} retries.`);
   logger.info(`  ${command.toString()}`);
 
-  let res;
   try {
-    res = await runBenchmark(
-      { command, captures, reporters, iterations, retries, logger },
-    ).pipe(toArray()).toPromise();
+    let res$;
+    if (watchMatcher && watchScript) {
+      res$ = runBenchmarkWatch({
+        command, captures, reporters, iterations, retries, logger,
+        watchCommand: new Command('node', [watchScript]), watchMatcher, watchTimeout,
+      });
+    } else {
+      res$ = runBenchmark(
+        { command, captures, reporters, iterations, retries, logger },
+      );
+    }
+
+    const res = await res$.pipe(toArray()).toPromise();
+    if (res.length === 0) {
+      return 1;
+    }
+
   } catch (error) {
     if (error.message) {
       logger.fatal(error.message);
@@ -171,10 +216,6 @@ export async function main({
     return 1;
   }
 
-  if (res.length === 0) {
-    return 1;
-  }
-
   return 0;
 }
 

packages/angular_devkit/benchmark/src/main_spec.ts

@@ -8,6 +8,7 @@
 import { existsSync, readFileSync, unlinkSync, writeFileSync } from 'fs';
 import { basename, dirname, join } from 'path';
 import { main } from './main';
+
 // tslint:disable-next-line:no-implicit-dependencies
 const temp = require('temp');
 
@@ -23,9 +24,11 @@ class MockWriteStream {
   }
 }
 
-describe('benchmark binary', () => {
+fdescribe('benchmark binary', () => {
   const benchmarkScript = require.resolve(join(__dirname, './test/fibonacci.js'));
   const exitCodeOneScript = require.resolve(join(__dirname, './test/exit-code-one.js'));
+  const benchmarkWatchScript = require.resolve(join(__dirname, './test/watch-test-cmd.js'));
+  const watchTriggerScript = require.resolve(join(__dirname, './test/watch-test-script.js'));
   const outputFileRoot = temp.mkdirSync('benchmark-binary-spec-');
   const outputFile = join(outputFileRoot, 'output.log');
   let stdout: MockWriteStream, stderr: MockWriteStream;
@@ -142,4 +145,51 @@ describe('benchmark binary', () => {
     stdout.lines.forEach(line => expect(line).toMatch(/^\[abc\]/));
     expect(res).toEqual(0);
   });
+
+  it('uses watch-script and watch-matcher', async () => {
+    const args = [
+      '--watch-matcher',
+      'Complete',
+      '--watch-script',
+      watchTriggerScript,
+      '--',
+      'node',
+      benchmarkWatchScript,
+    ];
+    const res = await main({ args, stdout, stderr });
+    expect(stdout.lines).toContain('[benchmark] Process Stats\n');
+    expect(res).toEqual(0);
+  }, 30000);
+
+  it('should not fail with exit code', async () => {
+    const args = [
+      '--watch-matcher',
+      'Complete',
+      '--watch-script',
+      watchTriggerScript,
+      '--',
+      'node',
+      exitCodeOneScript,
+    ];
+    const res = await main({ args, stdout, stderr });
+    expect(stderr.lines).toContain('[benchmark] Maximum number of retries (5) for command was exceeded.\n');
+    expect(res).toEqual(1);
+  });
+
+  it('should error when watch-timeout is exceeded', async () => {
+    const args = [
+      '--watch-timeout',
+      '20',
+      '--watch-matcher',
+      'Wrong Match',
+      '--watch-script',
+      watchTriggerScript,
+      '--',
+      'node',
+      benchmarkWatchScript,
+    ];
+    const res = await main({ args, stdout, stderr });
+    expect(stderr.lines).toContain('[benchmark] Timeout has occurred\n');
+    expect(res).toEqual(1);
+  });
 });

packages/angular_devkit/benchmark/src/monitored-process.ts

@@ -31,14 +31,21 @@ export class LocalMonitoredProcess implements MonitoredProcess {
   stats$: Observable<AggregatedProcessStats> = this.stats.asObservable();
   stdout$: Observable<Buffer> = this.stdout.asObservable();
   stderr$: Observable<Buffer> = this.stderr.asObservable();
+  private elapsedTimer: number;
 
-  constructor(private command: Command) { }
+  constructor(
+    private command: Command,
+    private useProcessTime = true,
+  ) { }
 
   run(): Observable<number> {
     return new Observable(obs => {
       const { cmd, cwd, args } = this.command;
-      const spawnOptions: SpawnOptions = { cwd };
+      const spawnOptions: SpawnOptions = { cwd, shell: true };
 
+      if (!this.useProcessTime) {
+        this.resetElapsedTimer();
+      }
       // Spawn the process.
       const childProcess = spawn(cmd, args, spawnOptions);
 
@@ -63,7 +70,14 @@ export class LocalMonitoredProcess implements MonitoredProcess {
           }
 
           return {
-            processes, cpu, memory, pid, ppid, ctime, elapsed, timestamp,
+            processes,
+            cpu,
+            memory,
+            pid,
+            ppid,
+            ctime,
+            elapsed: this.useProcessTime ? elapsed : (Date.now() - this.elapsedTimer),
+            timestamp,
           } as AggregatedProcessStats;
         }),
         tap(stats => this.stats.next(stats)),
@@ -100,7 +114,15 @@ export class LocalMonitoredProcess implements MonitoredProcess {
       processExitCb = killChildProcess;
 
       // Cleanup on unsubscription.
-      return () => childProcess.kill();
+      return killChildProcess;
     });
   }
+
+  resetElapsedTimer() {
+    if (this.useProcessTime) {
+      throw new Error(`Cannot reset elapsed timer when using process time. Set 'useProcessTime' to false.`);
+    }
+
+    this.elapsedTimer = Date.now();
+  }
 }