[Test Utils] [Recorder] Migrate to esm

sdk/test-utils/recorder/package.json

@@ -64,13 +64,13 @@
   "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/test-utils/recorder/",
   "sideEffects": false,
   "dependencies": {
+    "@azure/core-client": "^1.0.0",
     "@azure/core-rest-pipeline": "^1.13.0",
     "@azure/core-auth": "^1.3.2",
     "@azure/core-util": "^1.6.1",
     "@azure/logger": "^1.0.0"
   },
   "devDependencies": {
-    "@azure/core-client": "^1.0.0",
     "@azure/dev-tool": "^1.0.0",
     "@azure/eslint-plugin-azure-sdk": "^3.0.0",
     "@types/express": "^4.16.0",

sdk/test-utils/recorder/src/index.ts

@@ -16,3 +16,4 @@ export {
 export { env } from "./utils/env.js";
 export { delay } from "./utils/delay.js";
 export { CustomMatcherOptions } from "./matcher.js";
+export { TestInfo, MochaTest, VitestTestContext } from "./testInfo.js";

sdk/test-utils/recorder/src/recorder.ts

@@ -20,8 +20,7 @@ import {
   RecorderStartOptions,
   RecordingStateManager,
 } from "./utils/utils.js";
-import { Test } from "mocha";
-import { assetsJsonPath, sessionFilePath } from "./utils/sessionFilePath.js";
+import { assetsJsonPath, sessionFilePath, TestContext } from "./utils/sessionFilePath.js";
 import { SanitizerOptions } from "./utils/utils.js";
 import { paths } from "./utils/paths.js";
 import { addSanitizers, transformsInfo } from "./sanitizer.js";
@@ -35,6 +34,45 @@ import { isBrowser, isNode } from "@azure/core-util";
 import { env } from "./utils/env.js";
 import { decodeBase64 } from "./utils/encoding.js";
 import { AdditionalPolicyConfig } from "@azure/core-client";
+import { isMochaTest, isVitestTestContext, TestInfo, VitestSuite } from "./testInfo.js";
+
+/**
+ * Caculates session file path and JSON assets path from test context
+ *
+ * @internal
+ */
+export function calculatePaths(testContext: TestInfo): TestContext {
+  if (isMochaTest(testContext)) {
+    if (!testContext.parent) {
+      throw new RecorderError(
+        `The parent of test '${testContext.title}' is undefined, so a file path for its recording could not be generated. Please place the test inside a describe block.`,
+      );
+    }
+    return {
+      suiteTitle: testContext.parent.fullTitle(),
+      testTitle: testContext.title,
+    };
+  } else if (isVitestTestContext(testContext)) {
+    if (!testContext.task.name || !testContext.task.suite.name) {
+      throw new RecorderError(
+        `Unable to determine the recording file path. Unexpected empty Vitest context`,
+      );
+    }
+    const suites: string[] = [];
+    let p: VitestSuite | undefined = testContext.task.suite;
+    while (p?.name) {
+      suites.push(p.name);
+      p = p.suite;
+    }
+
+    return {
+      suiteTitle: suites.reverse().join("_"),
+      testTitle: testContext.task.name,
+    };
+  } else {
+    throw new RecorderError(`Unrecognized test info: ${testContext}`);
+  }
+}
 
 /**
  * This client manages the recorder life cycle and interacts with the proxy-tool to do the recording,
@@ -54,19 +92,23 @@ export class Recorder {
   private variables: Record<string, string>;
   private matcherSet = false;
 
-  constructor(private testContext?: Test | undefined) {
+  constructor(private testContext?: TestInfo) {
+    if (!this.testContext) {
+      throw new Error(
+        "Unable to determine the recording file path, testContext provided is not defined.",
+      );
+    }
+
     logger.info(`[Recorder#constructor] Creating a recorder instance in ${getTestMode()} mode`);
     if (isRecordMode() || isPlaybackMode()) {
-      if (this.testContext) {
-        this.sessionFile = sessionFilePath(this.testContext);
-        this.assetsJson = assetsJsonPath();
+      const context = calculatePaths(this.testContext);
+
+      this.sessionFile = sessionFilePath(context);
+      this.assetsJson = assetsJsonPath();
 
+      if (this.testContext) {
         logger.info(`[Recorder#constructor] Using a session file located at ${this.sessionFile}`);
         this.httpClient = createDefaultHttpClient();
-      } else {
-        throw new Error(
-          "Unable to determine the recording file path, testContext provided is not defined.",
-        );
       }
     }
     this.variables = {};
@@ -431,7 +473,7 @@ export class Recorder {
     }
 
     if (ensureExistence(this.httpClient, "this.httpClient")) {
-      return await transformsInfo(this.httpClient, Recorder.url, this.recordingId!);
+      return transformsInfo(this.httpClient, Recorder.url, this.recordingId!);
     }
 
     throw new RecorderError("Expected httpClient to be defined");
@@ -463,7 +505,7 @@ export class Recorder {
     return options;
   }
 
-  private handleTestProxyErrors(response: PipelineResponse) {
+  private handleTestProxyErrors(response: PipelineResponse): void {
     if (response.headers.get("x-request-mismatch") === "true") {
       const errorMessage = decodeBase64(response.headers.get("x-request-mismatch-error") ?? "");
       logger.error(

sdk/test-utils/recorder/src/testInfo.ts

@@ -0,0 +1,91 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+/**
+ * Represents a Test.
+ */
+export type TestInfo = MochaTest | VitestTestContext;
+
+/**
+ * Represents a Mocha Test.
+ */
+export interface MochaTest {
+  /**
+   * The title of the test.
+   */
+  title: string;
+  /**
+   * The parent of the Mocha Test Suite.
+   */
+  parent?: MochaTestSuite;
+}
+
+/**
+ * Represents a Mocha Test Suite.
+ */
+export interface MochaTestSuite {
+  fullTitle(): string;
+}
+
+/**
+ * Represents a Vitest Test Context
+ */
+export interface VitestTestContext {
+  /**
+   * The Vitest Context Task.
+   */
+  task: VitestTask;
+}
+
+export interface VitestTaskBase {
+  name: string;
+  suite?: VitestSuite;
+}
+
+/**
+ * Represents a Vitest Test Context Task
+ */
+export interface VitestTask extends VitestTaskBase {
+  /**
+   * The Vitest Context Task Name.
+   */
+  name: string;
+  /**
+   * The Vitest Context Task Suite.
+   */
+  suite: VitestSuite;
+}
+
+/**
+ * Represents a Vitest Test Suite.
+ */
+export interface VitestSuite extends VitestTaskBase {
+  /**
+   * The Vitest Context Task Suite Name.
+   */
+  name: string;
+}
+
+/**
+ * Determines whether the given test is a Mocha Test.
+ * @param test - The test to check.
+ * @returns true if the given test is a Mocha Test.
+ */
+export function isMochaTest(test: unknown): test is MochaTest {
+  return typeof test === "object" && test != null && "title" in test;
+}
+
+/**
+ * Determines whether the given test is a Vitest Test.
+ * @param test - The test to check.
+ * @returns true if the given test is a Vitest Test.
+ */
+export function isVitestTestContext(test: unknown): test is VitestTestContext {
+  return (
+    typeof test == "function" &&
+    "task" in test &&
+    typeof test.task === "object" &&
+    test.task != null &&
+    "name" in test.task
+  );
+}

sdk/test-utils/recorder/src/utils/sessionFilePath.ts

@@ -4,9 +4,13 @@
 import { isNode } from "@azure/core-util";
 import { generateTestRecordingFilePath } from "./filePathGenerator.js";
 import { relativeRecordingsPath } from "./relativePathCalculator.js";
-import { RecorderError } from "./utils.js";
 
-export function sessionFilePath(testContext: Mocha.Test): string {
+export interface TestContext {
+  suiteTitle: string; // describe(suiteTitle, () => {})
+  testTitle: string; // it(testTitle, () => {})
+}
+
+export function sessionFilePath(testContext: TestContext): string {
   // sdk/service/project/recordings/{node|browsers}/<describe-block-title>/recording_<test-title>.json
   return `${relativeRecordingsPath()}/${recordingFilePath(testContext)}`;
 }
@@ -16,17 +20,11 @@ export function sessionFilePath(testContext: Mocha.Test): string {
  *
  *  `{node|browsers}/<describe-block-title>/recording_<test-title>.json`
  */
-export function recordingFilePath(testContext: Mocha.Test): string {
-  if (!testContext.parent) {
-    throw new RecorderError(
-      `Test ${testContext.title} is not inside a describe block, so a file path for its recording could not be generated. Please place the test inside a describe block.`,
-    );
-  }
-
+export function recordingFilePath(testContext: TestContext): string {
   return generateTestRecordingFilePath(
     isNode ? "node" : "browsers",
-    testContext.parent.fullTitle(),
-    testContext.title,
+    testContext.suiteTitle,
+    testContext.testTitle,
   );
 }
 

sdk/test-utils/recorder/test/errors.spec.ts

@@ -6,7 +6,7 @@ import { expect } from "chai";
 import { Recorder } from "../src/recorder.js";
 import { createHttpHeaders, createPipelineRequest } from "@azure/core-rest-pipeline";
 import { encodeBase64 } from "../src/utils/encoding.js";
-import { describe, it, beforeEach } from "vitest";
+import { describe, it, beforeEach, TaskContext } from "vitest";
 
 describe("State Manager", function () {
   it("throws error if started twice", function () {
@@ -39,8 +39,8 @@ describe("State Manager", function () {
 
 describe("handleTestProxyErrors", function () {
   let recorder: Recorder;
-  beforeEach(function (this: Mocha.Context) {
-    recorder = new Recorder(this.currentTest);
+  beforeEach(function (this: TaskContext) {
+    recorder = new Recorder(this.task.context);
   });
 
   it("x-request-mismatch header", function () {

sdk/test-utils/recorder/test/recorder.spec.ts

@@ -0,0 +1,62 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { expect } from "chai";
+
+import { calculatePaths } from "../src/recorder.js";
+
+describe("Recorder file paths", () => {
+  it("calculates paths for a Mocha test", () => {
+    const mochaTest = {
+      title: "mocha test title",
+      parent: {
+        fullTitle: () => "mocha suite title",
+      },
+    };
+    const context = calculatePaths(mochaTest);
+
+    expect(context).to.eql({
+      suiteTitle: "mocha suite title",
+      testTitle: "mocha test title",
+    });
+  });
+
+  it("calculates paths for a vitest test", () => {
+    const vitestTest = () => {
+      /* no-op */
+    };
+    (vitestTest as any).task = {
+      name: "vitest test title",
+      suite: {
+        name: "vitest suite title",
+      },
+    };
+
+    const context = calculatePaths(vitestTest as any);
+    expect(context).to.eql({
+      suiteTitle: "vitest suite title",
+      testTitle: "vitest test title",
+    });
+  });
+
+  it("calculates paths for a vitest test with nested suites", () => {
+    const vitestTest = () => {
+      /* no-op */
+    };
+    (vitestTest as any).task = {
+      name: "vitest test title",
+      suite: {
+        name: "vitest suite title",
+        suite: {
+          name: "toplevel suite",
+        },
+      },
+    };
+
+    const context = calculatePaths(vitestTest as any);
+    expect(context).to.eql({
+      suiteTitle: "toplevel suite_vitest suite title",
+      testTitle: "vitest test title",
+    });
+  });
+});

sdk/test-utils/recorder/test/sanitizers.spec.ts

@@ -6,7 +6,7 @@ import { env, isPlaybackMode, Recorder } from "../src/index.js";
 import { TestMode } from "../src/utils/utils.js";
 import { TEST_SERVER_URL, makeRequestAndVerifyResponse, setTestMode } from "./utils/utils.js";
 import { randomUUID } from "@azure/core-util";
-import { describe, it, beforeEach, afterEach, beforeAll, Vitest, TaskContext } from "vitest";
+import { describe, it, beforeEach, afterEach, beforeAll, TaskContext } from "vitest";
 
 // These tests require the following to be running in parallel
 // - utils/server.ts (to serve requests to act as a service)

sdk/test-utils/recorder/test/testProxyClient.spec.ts

@@ -12,7 +12,7 @@ import { env, Recorder } from "../src/index.js";
 import { createRecordingRequest } from "../src/utils/createRecordingRequest.js";
 import { paths } from "../src/utils/paths.js";
 import { getTestMode, isLiveMode, isRecordMode, RecorderError } from "../src/utils/utils.js";
-import { describe, it, beforeEach, afterEach, } from "vitest";
+import { describe, it, beforeEach, afterEach, TaskContext, } from "vitest";
 
 const testRedirectedRequest = (
   client: Recorder,
@@ -27,11 +27,11 @@ const testRedirectedRequest = (
 describe("TestProxyClient functions", () => {
   let client: Recorder;
   let clientHttpClient: HttpClient;
-  let testContext: Mocha.Test | undefined;
-  beforeEach(function (this: Mocha.Context) {
-    client = new Recorder(this.currentTest);
+  let testContext: TaskContext | undefined;
+  beforeEach(async function (this: TaskContext) {
+    testContext = this.task.context;
+    client = new Recorder(testContext);
     clientHttpClient = client["httpClient"] as HttpClient;
-    testContext = this.currentTest;
   });
 
   afterEach(() => {

sdk/test-utils/recorder/test/testProxyTests.spec.ts

@@ -8,7 +8,7 @@ import { expect } from "chai";
 import { CustomMatcherOptions, isPlaybackMode, Recorder } from "../src/index.js";
 import { isLiveMode, TestMode } from "../src/utils/utils.js";
 import { TEST_SERVER_URL, makeRequestAndVerifyResponse } from "./utils/utils.js";
-import { describe, it, beforeEach } from "vitest";
+import { describe, it, beforeEach, TaskContext } from "vitest";
 
 // These tests require the following to be running in parallel
 // - utils/server.ts (to serve requests to act as a service)
@@ -18,8 +18,8 @@ import { describe, it, beforeEach } from "vitest";
     let recorder: Recorder;
     let client: ServiceClient;
 
-    beforeEach(async function (this: Mocha.Context) {
-      recorder = new Recorder(this.currentTest);
+    beforeEach(async function (this: TaskContext) {
+      recorder = new Recorder(this.task.context);
       client = new ServiceClient(recorder.configureClientOptions({ baseUri: TEST_SERVER_URL }));
     });