[Perf framework] Remove run method - cleaning up (#16391)

sdk/test-utils/perfstress/CHANGELOG.md

@@ -2,4 +2,10 @@
 
 ## 1.0.0 (Unreleased)
 
+### 2021-07-14
+
+- Removed the run method in the `PerfStressTest` class as we only deal with the async methods when it comes to performance.
+
+### 2020-04-22
+
 - Merged the first working implementation of perfstress.

sdk/test-utils/perfstress/src/options.ts

@@ -65,7 +65,6 @@ export interface DefaultPerfStressOptions {
   iterations: number;
   "no-cleanup": boolean;
   "milliseconds-to-log": number;
-  sync: boolean;
 }
 
 /**
@@ -96,10 +95,6 @@ export const defaultPerfStressOptions: PerfStressOptionDictionary<DefaultPerfStr
     shortName: "i",
     defaultValue: 1
   },
-  sync: {
-    description: "Only runs the 'run' method instead of the 'runAsync' method",
-    defaultValue: false
-  },
   "no-cleanup": {
     description: "Disables test cleanup"
   },

sdk/test-utils/perfstress/src/program.ts

@@ -111,47 +111,6 @@ export class PerfStressProgram {
     );
   }
 
-  /**
-   * Runs the test in scope repeatedly, without waiting for any promises to finish,
-   * as many times as possible until durationMilliseconds is reached.
-   * For each test run, it will report one more completedOperations on the PerfStressParallel given,
-   * as well as the lastMillisecondsElapsed that reports the last test execution's elapsed time in comparison
-   * to the beginning of the execution of runLoop.
-   *
-   * @param parallel Object where to log the results from each execution.
-   * @param durationMilliseconds When to abort any execution.
-   * @param abortController Allows us to send through a signal determining when to abort any execution.
-   */
-  private runLoopSync(
-    test: PerfStressTest,
-    parallel: PerfStressParallel,
-    durationMilliseconds: number,
-    abortController: AbortController
-  ): void {
-    if (!test.run) {
-      throw new Error(`The "run" method is missing in the test ${this.testName}`);
-    }
-    const start = process.hrtime();
-    while (!abortController.signal.aborted) {
-      test.run(abortController.signal);
-
-      const elapsed = process.hrtime(start);
-      const elapsedMilliseconds = elapsed[0] * 1000 + elapsed[1] / 1000000;
-
-      parallel.completedOperations += 1;
-      parallel.lastMillisecondsElapsed = elapsedMilliseconds;
-
-      // In runTest we create a setTimeout that is intended to abort the abortSignal
-      // once the durationMilliseconds have elapsed. That setTimeout might not get queued
-      // on time through the event loop, depending on the number of operations we might be executing.
-      // For this reason, we're also manually checking the elapsed time here.
-      if (abortController.signal.aborted || elapsedMilliseconds > durationMilliseconds) {
-        abortController.abort();
-        break;
-      }
-    }
-  }
-
   /**
    * Runs the test in scope repeatedly, without waiting for any promises to finish,
    * as many times as possible until durationMilliseconds is reached.
@@ -201,7 +160,7 @@ export class PerfStressProgram {
     title: string
   ): Promise<void> {
     const parallels: PerfStressParallel[] = new Array<PerfStressParallel>(this.parallelNumber);
-    const parallelTestResults: Promise<void>[] | void[] = new Array<void>(this.parallelNumber);
+    const parallelTestResults: Array<Promise<void>> = new Array<Promise<void>>(this.parallelNumber);
 
     const abortController = new AbortController();
     const durationMilliseconds = durationSeconds * 1000;
@@ -231,8 +190,7 @@ export class PerfStressProgram {
       console.log(`${currentCompleted}\t\t${totalCompleted}\t\t${averageCompleted.toFixed(2)}`);
     }, millisecondsToLog);
 
-    const isAsync = !this.parsedDefaultOptions.sync.value;
-    const runLoop = isAsync ? this.runLoopAsync : this.runLoopSync;
+    const runLoop = this.runLoopAsync;
 
     // Unhandled exceptions should stop the whole PerfStress process.
     process.on("unhandledRejection", (error) => {
@@ -260,10 +218,8 @@ export class PerfStressProgram {
       );
     }
 
-    if (isAsync) {
-      for (const promise of parallelTestResults) {
-        await promise;
-      }
+    for (const promise of parallelTestResults) {
+      await promise;
     }
 
     // Once we finish, we clear the log interval.

sdk/test-utils/perfstress/src/tests.ts

@@ -47,7 +47,6 @@ export abstract class PerfStressTest<TOptions = {}> {
   public setup?(): void | Promise<void>;
   public cleanup?(): void | Promise<void>;
 
-  public run?(abortSignal?: AbortSignalLike): void;
   public async runAsync?(abortSignal?: AbortSignalLike): Promise<void>;
 }
 

sdk/test-utils/perfstress/test/exception.spec.ts

@@ -11,14 +11,6 @@ import { PerfStressTest } from "../src";
 export class Exception extends PerfStressTest {
   public options = {};
 
-  run(): void {
-    try {
-      throw new Error();
-    } catch (e) {
-      // Nothing to do here
-    }
-  }
-
   async runAsync(): Promise<void> {
     try {
       throw new Error();

sdk/test-utils/perfstress/test/noop.spec.ts

@@ -9,7 +9,5 @@ import { PerfStressTest } from "../src";
 export class NoOp extends PerfStressTest {
   public options = {};
 
-  run(): void {}
-
   async runAsync(): Promise<void> {}
 }

sdk/test-utils/perfstress/test/options.spec.ts

@@ -71,7 +71,7 @@ export class OptionsTest extends PerfStressTest<OptionsTestOptions> {
     }
   }
 
-  run(): void {
+  async runAsync() {
     for (const key in this.options) {
       this.compare(key as keyof OptionsTestOptions);
     }

sdk/test-utils/perfstress/test/setupCleanup.spec.ts

@@ -47,5 +47,5 @@ export class SetupCleanupTest extends PerfStressTest {
     }
   }
 
-  run(): void {}
+  async runAsync() {}
 }