[Perf Framework] Print dependencies on perf test start (#18366)

timovv · web-flow · commit f8a3be788a87 · 2021-10-27T23:41:18.000Z
Resolves #13825.
diff --git a/sdk/test-utils/perf/CHANGELOG.md b/sdk/test-utils/perf/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 ## 1.0.0 (Unreleased)
 
+### 2021-10-27
+
+- Log dependencies (`@azure` packages only) on perf test start. Extended output of transitive dependencies can be enabled using the new `--list-transitive-dependencies` flag.
+  [#18366](https://github.com/Azure/azure-sdk-for-js/pull/18366)
+
 ### 2021-10-20
 
 - Clean up some naming: `PerfStress` to `Perf` everywhere; also rename the `runAsync` method to `run`.
diff --git a/sdk/test-utils/perf/src/options.ts b/sdk/test-utils/perf/src/options.ts
@@ -68,6 +68,7 @@ export interface DefaultPerfOptions {
   "milliseconds-to-log": number;
   "test-proxies": string;
   insecure: boolean;
+  "list-transitive-dependencies": boolean;
 }
 
 /**
@@ -115,6 +116,11 @@ export const defaultPerfOptions: PerfOptionDictionary<DefaultPerfOptions> = {
     description: "Log frequency in milliseconds",
     shortName: "mtl",
     defaultValue: 1000
+  },
+  "list-transitive-dependencies": {
+    description: "List all dependencies, instead of only direct ones, before test run",
+    shortName: "ltd",
+    defaultValue: false
   }
 };
 
diff --git a/sdk/test-utils/perf/src/program.ts b/sdk/test-utils/perf/src/program.ts
@@ -11,6 +11,7 @@ import {
 } from "./options";
 import { PerfParallel } from "./parallel";
 import { TestProxyHttpClientV1, TestProxyHttpClient } from "./testProxyHttpClient";
+import { exec } from "child_process";
 
 export type TestType = "";
 
@@ -239,6 +240,18 @@ export class PerfProgram {
     this.logResults(parallels);
   }
 
+  private async logPackageVersions(listTransitiveDeps: boolean): Promise<void> {
+    return new Promise((resolve) => {
+      console.log("=== Versions ===");
+      exec(`npm list --prod ${listTransitiveDeps ? "" : "--depth=0"}`, (_error, stdout) => {
+        for (const dependency of stdout.split("\n").filter((line) => line.includes("@azure"))) {
+          console.log(dependency);
+        }
+        resolve();
+      });
+    });
+  }
+
   /**
    * The run() public method lets developers specify when to begin running the selected test
    * under the conditions provided by the command line options.
@@ -267,6 +280,10 @@ export class PerfProgram {
       return;
     }
 
+    await this.logPackageVersions(
+      this.parsedDefaultOptions["list-transitive-dependencies"].value ?? false
+    );
+
     const options = this.tests[0].parsedOptions;
     console.log("=== Parsed options ===");
     console.table(options);
