[Unified Recorder] TestProxyClient takes test context to generate recordings at desired location

sdk/test-utils/recorder-new/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Release History
+
+## 1.0.0 (Unreleased)
+
+## 2021-09-27
+
+- TestProxyClient takes test context to generate recordings at desired location. [#17388](https://github.com/Azure/azure-sdk-for-js/pull/17388)
+- Adds a server for the tests, to play the role of an actual service to be able to test the proxy-tool end-to-end.
+  [#17388](https://github.com/Azure/azure-sdk-for-js/pull/17388)
+
+## 2021-07-17
+
+- Building the unified recorder prototype leveraging the proxy-tool, works for both core-v1 and core-v2 SDKs. Shows data-tables and storage-queue as examples for core-v2 and core-v1 respectively.
+  [#15826](https://github.com/Azure/azure-sdk-for-js/pull/15826)

sdk/test-utils/recorder-new/README.md

@@ -12,12 +12,16 @@ Feature work is being tracked at [#15829](https://github.com/Azure/azure-sdk-for
 
 Run this command
 
-> `docker run -v temp-location:/etc/testproxy -p 5001:5001 -p 5000:5000 azsdkengsys.azurecr.io/engsys/testproxy-lin:latest`
+> `docker run -v /workspaces/azure-sdk-for-js/:/etc/testproxy -p 5001:5001 -p 5000:5000 azsdkengsys.azurecr.io/engsys/testproxy-lin:latest`
+
+[Provide the root of the repo for the volume mapping for the accurate location while generating recordings.]
 
 (Eventually, recorder will trigger this for you!)
 
 [Note: Update `temp-location` in the command to your desired location.]
 
+Add `--net=host` to let the Docker container access the localhost on host network.
+
 If the above command doesn't work directly, try [Troubleshooting Access to Public Container Registry](https://github.com/Azure/azure-sdk-tools/tree/main/tools/test-proxy/docker#troubleshooting-access-to-public-container-registry).
 
 Reference: [Using Test Proxy with docker container](https://github.com/Azure/azure-sdk-tools/tree/main/tools/test-proxy/docker#build-and-run)

sdk/test-utils/recorder-new/package.json

@@ -6,6 +6,10 @@
   "main": "dist/index.js",
   "module": "dist-esm/src/index.js",
   "types": "./types/src/index.d.ts",
+  "browser": {
+    "./dist-esm/src/utils/relativePathCalculator.js": "./dist-esm/src/utils/relativePathCalculator.browser.js",
+    "./dist-esm/test/utils/server.js": "./dist-esm/test/utils/server.browser.js"
+  },
   "scripts": {
     "audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",
     "build:browser": "echo skipped",
@@ -17,14 +21,17 @@
     "clean": "rimraf dist dist-esm test-dist typings *.tgz *.log",
     "extract-api": "echo skipped",
     "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
-    "integration-test:browser": "karma start --single-run",
-    "integration-test:node": "nyc mocha -r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 5000000 --full-trace dist-esm/test/*.spec.js dist-esm/test/node/*.spec.js",
+    "integration-test:browser": "echo skipped",
+    "integration-test:node": "echo skipped",
     "integration-test": "npm run integration-test:node && npm run integration-test:browser",
+    "tests:server": "TS_NODE_COMPILER_OPTIONS=\"{\\\"module\\\": \\\"commonjs\\\"}\" ts-node test/utils/server.ts",
+    "temp-integration-test:browser": "concurrently \"npm run tests:server\" \"karma start --single-run\" --kill-others --success first",
+    "temp-integration-test:node": "concurrently \"npm run tests:server\" \"nyc mocha -r esm --require ts-node/register --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 5000000 --full-trace 'test/*.spec.ts'\" --kill-others --success first",
     "lint:fix": "eslint package.json src test --ext .ts --fix --fix-type [problem,suggestion]",
     "lint": "eslint package.json src test --ext .ts -f html -o recorder-lintReport.html || exit 0",
     "pack": "npm pack 2>&1",
-    "unit-test:browser": "karma start --single-run",
-    "unit-test:node": "mocha -r esm --require ts-node/register --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 1200000 --full-trace \"test/*.spec.ts\"",
+    "unit-test:browser": "echo skipped",
+    "unit-test:node": "echo skipped",
     "unit-test": "npm run unit-test:node && npm run unit-test:browser",
     "test:browser": "npm run clean && npm run build:test && npm run unit-test:browser",
     "test:node": "npm run clean && npm run build:test && npm run unit-test:node",
@@ -59,15 +66,18 @@
   "dependencies": {
     "@azure-tools/test-recorder": "^1.0.0",
     "@azure/core-http": "^2.0.0",
-    "@azure/core-rest-pipeline": "^1.1.0"
+    "@azure/core-rest-pipeline": "^1.1.0",
+    "@azure/test-utils": "^1.0.0"
   },
   "devDependencies": {
+    "@azure/core-client": "^1.0.0",
     "@azure/dev-tool": "^1.0.0",
     "@azure/eslint-plugin-azure-sdk": "^3.0.0",
     "@rollup/plugin-commonjs": "11.0.2",
     "@rollup/plugin-multi-entry": "^3.0.0",
     "@rollup/plugin-node-resolve": "^8.0.0",
     "@rollup/plugin-replace": "^2.2.0",
+    "@types/express": "^4.16.0",
     "@types/fs-extra": "^8.0.0",
     "@types/chai": "^4.1.6",
     "@types/md5": "^2.2.0",
@@ -77,8 +87,10 @@
     "@types/mock-require": "~2.0.0",
     "@types/mock-fs": "~4.10.0",
     "chai": "^4.2.0",
+    "concurrently": "^6.2.1",
     "dotenv": "^8.2.0",
     "eslint": "^7.15.0",
+    "express": "^4.16.3",
     "karma": "^6.2.0",
     "karma-chrome-launcher": "^3.0.0",
     "karma-coverage": "^2.0.0",
@@ -106,6 +118,7 @@
     "rollup-plugin-terser": "^5.1.1",
     "rollup-plugin-visualizer": "^4.0.4",
     "tslib": "^2.2.0",
+    "ts-node": "^9.0.0",
     "typescript": "~4.2.0",
     "xhr-mock": "^2.4.1"
   }

sdk/test-utils/recorder-new/src/core-v1-recorder.ts

@@ -5,6 +5,7 @@ import { HttpClient, HttpOperationResponse } from "@azure/core-http";
 import { DefaultHttpClient, WebResourceLike } from "@azure/core-http";
 import { isPlaybackMode, isRecordMode } from "@azure-tools/test-recorder";
 import { TestProxyHttpClient } from "./core-v2-recorder";
+import { Test } from "mocha";
 
 /**
  * This client manages the recorder life cycle and interacts with the proxy-tool to do the recording,
@@ -15,8 +16,8 @@ import { TestProxyHttpClient } from "./core-v2-recorder";
  */
 export class TestProxyHttpClientCoreV1 extends TestProxyHttpClient {
   public httpClientCoreV1: HttpClient;
-  constructor(sessionFile: string) {
-    super(sessionFile);
+  constructor(testContext?: Test) {
+    super(testContext);
     this.httpClientCoreV1 = new DefaultHttpClient();
   }
 

sdk/test-utils/recorder-new/src/core-v2-recorder.ts

@@ -12,7 +12,9 @@ import {
   SendRequest
 } from "@azure/core-rest-pipeline";
 import { env, isPlaybackMode, isRecordMode } from "@azure-tools/test-recorder";
-import { RecorderError, RecordingStateManager } from "./utils";
+import { RecorderError, RecordingStateManager } from "./utils/utils";
+import { Test } from "mocha";
+import { sessionFilePath } from "./utils/sessionFilePath";
 
 const paths = {
   playback: "/playback",
@@ -31,16 +33,25 @@ const paths = {
 export class TestProxyHttpClient {
   private url = "http://localhost:5000";
   public recordingId?: string;
-  public mode: string;
-  public httpClient: HttpClient;
+  public mode!: string;
+  public httpClient!: HttpClient;
   private stateManager = new RecordingStateManager();
-  private playback: boolean;
+  private playback!: boolean;
+  private sessionFile!: string;
 
-  constructor(private sessionFile: string) {
-    this.sessionFile = sessionFile;
-    this.mode = env.TEST_MODE;
-    this.playback = isPlaybackMode();
-    this.httpClient = createDefaultHttpClient();
+  constructor(private testContext?: Test | undefined) {
+    if (isRecordMode() || isPlaybackMode()) {
+      if (!this.testContext) {
+        throw new Error(
+          "Unable to determine the recording file path, testContext provided is not defined."
+        );
+      } else {
+        this.sessionFile = sessionFilePath(this.testContext);
+        this.mode = env.TEST_MODE;
+        this.playback = isPlaybackMode();
+        this.httpClient = createDefaultHttpClient();
+      }
+    }
   }
 
   /**

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

@@ -3,3 +3,4 @@
 
 export { recorderHttpPolicy, TestProxyHttpClient } from "./core-v2-recorder";
 export { TestProxyHttpClientCoreV1 } from "./core-v1-recorder";
+export { relativeRecordingsPathForBrowser } from "./utils/relativePathCalculator";

sdk/test-utils/recorder-new/src/utils/relativePathCalculator.browser.ts

@@ -0,0 +1,13 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+export function relativeRecordingsPathForNode() {
+  throw new Error("Attempted to use the function meant for node in a browser.");
+}
+
+export function relativeRecordingsPathForBrowser() {
+  // If you get this error, it's because you tried to use this config in a browser.
+  // It is meant to be imported in the karma configuration file and used to configure
+  // the browser launch specifications, not to be used within the browser itself.
+  throw new Error("Attempted to use the base karma configuration in a browser.");
+}

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

@@ -0,0 +1,96 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import path from "path";
+import fs from "fs";
+import { RecorderError } from "./utils";
+
+export function relativeRecordingsPathForNode(testContext: Mocha.Test) {
+  const testAbsolutePath = testContext.file;
+  if (!testAbsolutePath) {
+    throw new RecorderError("Unable to grab the file path from the test run");
+  }
+
+  const recordingsPath = findRecordingsFolderPath(testAbsolutePath);
+  const recordingsFolder = path.basename(recordingsPath);
+  const projectFolder = path.basename(path.resolve(recordingsPath, ".."));
+  const serviceFolder = path.basename(path.resolve(recordingsPath, "..", ".."));
+  const sdk = path.basename(path.resolve(recordingsPath, "..", "..", ".."));
+  if (sdk !== "sdk") {
+    throw new Error("Unexpected location for recordings, please fix the location.");
+  }
+  return path
+    .join(sdk, serviceFolder, projectFolder, recordingsFolder)
+    .split(path.sep)
+    .join(path.posix.sep);
+}
+
+export function relativeRecordingsPathForBrowser() {
+  const pathFormatted = process.cwd();
+  const projectFolder = path.basename(pathFormatted);
+  const serviceFolder = path.basename(path.resolve(pathFormatted, ".."));
+  const sdk = path.basename(path.resolve(pathFormatted, "..", ".."));
+  if (sdk !== "sdk") {
+    throw new Error("Unexpected location for recordings, please fix the location.");
+  }
+  return path
+    .join(sdk, serviceFolder, projectFolder, "recordings")
+    .split(path.sep)
+    .join(path.posix.sep);
+}
+
+/**
+ * ONLY WORKS IN THE NODE.JS ENVIRONMENT
+ *
+ * 1. Takes the test filePath as argument.
+ * 2. Looks for the potential `recordings` folder in its hierarchical path.
+ * 3. Returns the full path of the `recordings` folder
+ *
+ * While running the tests, `filePath` can vary depending on location of the test files, examples below
+ *
+ * 1. If roll-up generated bundle files are being leveraged to run the tests
+ *    filePath = `<base path>\azure-sdk-for-js\sdk\storage\storage-blob\dist-test\index.node.js`
+ * 2. If ts complied dist-esm files are being used to run the tests
+ *    filePath = `<base path>\azure-sdk-for-js\sdk\storage\storage-blob\dist-esm\test\utils.spec.js`
+ *    filePath = `<base path>\azure-sdk-for-js\sdk\storage\storage-blob\dist-esm\test\node\utils.spec.js`
+ * 3. If `.spec.ts` test files are being used directly
+ *    filePath = `<base path>\azure-sdk-for-js\sdk\storage\storage-blob\test\utils.spec.ts`
+ *    filePath = `<base path>\azure-sdk-for-js\sdk\storage\storage-blob\test\node\utils.spec.ts`
+ * In the above examples, no matter where the test files are,
+ *    the recordings are located at `<base path>\azure-sdk-for-js\sdk\storage\storage-blob\recordings\`.
+ * In order to playback the tests, exact location of the recordings is to be found,
+ *    this is done by checking the parent(s) folders until the `recordings` folder is found.
+ *
+ * @export
+ * @param {string} filePath
+ * @returns {string} location of the `recordings` folder
+ */
+function findRecordingsFolderPath(filePath: string): string {
+  // Stripping away the file name
+  let currentPath = path.resolve(filePath, "..");
+  // File/folder path of a closest child of `currentPath` in the folder hierarchy of `filePath`
+  let lastPath = filePath;
+  try {
+    // While loop to find the entry point of the SDK
+    while (
+      !(
+        fs.existsSync(path.resolve(currentPath, "package.json")) &&
+        fs.existsSync(path.resolve(currentPath, "..", "..", "..", "sdk/")) &&
+        fs.existsSync(path.resolve(currentPath, "..", "..", "..", "rush.json"))
+      )
+    ) {
+      lastPath = currentPath;
+      currentPath = path.resolve(currentPath, "..");
+      if (lastPath === currentPath) {
+        throw new Error(
+          `'package.json' is not found at ${currentPath} (reached the root directory)`
+        );
+      }
+    }
+    return path.resolve(currentPath, "recordings/");
+  } catch (error) {
+    throw new Error(
+      `Unable to locate the 'recordings' folder anywhere in the hierarchy of the file path ${filePath}\n ${error}`
+    );
+  }
+}

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

@@ -0,0 +1,28 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { env, generateTestRecordingFilePath } from "@azure-tools/test-recorder";
+import { isNode } from "@azure/test-utils";
+import { relativeRecordingsPathForNode } from "./relativePathCalculator";
+
+export function sessionFilePath(testContext: Mocha.Test) {
+  if (!isNode) {
+    return `${env.RECORDINGS_RELATIVE_PATH}/${recordingFilePath(testContext)}`;
+  } else {
+    return `${relativeRecordingsPathForNode(testContext)}/${recordingFilePath(testContext)}`;
+  }
+}
+
+/**
+ * Generates a file path with the following structure:
+ *
+ *  `{node|browsers}/<describe-block-title>/recording_<test-title>.json`
+ */
+export function recordingFilePath(testContext: Mocha.Test) {
+  return `${generateTestRecordingFilePath(
+    isNode ? "node" : "browsers",
+    testContext.parent!.fullTitle(),
+    testContext.title!,
+    "json"
+  )}`;
+}