Azure · HarshaNalluru · Aug 26, 2021 · Jun 3, 2021 · Jun 3, 2021 · Jun 3, 2021
@@ -24,6 +24,9 @@ omitted_paths:
   - sdk/storage/storage-internal-avro/*
   - sdk/test-utils/perfstress/README.md
   - sdk/test-utils/multi-version/README.md
+  - /sdk/test-utils/testing-recorder-new/README.md
+  - /sdk/test-utils/recorder-new/README.md
+
 language: js
 root_check_enabled: True
 required_readme_sections:

@@ -686,6 +686,11 @@
       "projectFolder": "sdk/template/template",
       "versionPolicyName": "client"
     },
+    {
+      "packageName": "@azure/testing-recorder-new",
+      "projectFolder": "sdk/test-utils/testing-recorder-new",
+      "versionPolicyName": "test"
+    },
     {
       "packageName": "@azure/eslint-plugin-azure-sdk",
       "projectFolder": "common/tools/eslint-plugin-azure-sdk",
@@ -696,6 +701,11 @@
       "projectFolder": "sdk/test-utils/recorder",
       "versionPolicyName": "utility"
     },
+    {
+      "packageName": "@azure/test-utils-recorder-new",
+      "projectFolder": "sdk/test-utils/recorder-new",
+      "versionPolicyName": "utility"
+    },
     {
       "packageName": "@azure/test-utils-perfstress",
       "projectFolder": "sdk/test-utils/perfstress",

@@ -62,7 +62,7 @@
   "dependencies": {
     "@azure/abort-controller": "^1.0.0",
     "@azure/event-hubs": "^5.6.0",
-    "@azure/data-tables": "^12.1.1",
+    "@azure/data-tables": "^12.1.2",
     "@azure/logger": "^1.0.0",
     "tslib": "^2.2.0"
   },

@@ -8,7 +8,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@azure/data-tables": "^12.1.1",
+    "@azure/data-tables": "^12.1.2",
     "@azure/test-utils-perfstress": "^1.0.0",
     "dotenv": "^8.2.0",
     "uuid": "^8.3.0"

@@ -0,0 +1,34 @@
+## Azure test-utils-recorder-new library for JavaScript
+
+This is an experimental tool to record and playback the tests in the JS repo by leveraging the unified out-of-proc test proxy server. This library is still under construction.
+Feature work is being tracked at [#15829](https://github.com/Azure/azure-sdk-for-js/issues/15829)
+
+## Resources
+
+- [Azure SDK Tools Test Proxy](https://github.com/Azure/azure-sdk-tools/tree/main/tools/test-proxy/Azure.Sdk.Tools.TestProxy)
+- [Using Test Proxy with docker container](https://github.com/Azure/azure-sdk-tools/tree/main/tools/test-proxy/docker#build-and-run)
+
+## Running the proxy server
+
+Run this command
+
+> `docker run -v temp-location:/etc/testproxy -p 5001:5001 -p 5000:5000 azsdkengsys.azurecr.io/engsys/testproxy-lin:latest`
+
+(Eventually, recorder will trigger this for you!)
+
+[Note: Update `temp-location` in the command to your desired location.]
+
+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)
+
+## Running the test at test-utils\testing-recorder-new
+
+- Navigate to the test-utils\testing-recorder-new folder
+- Run `rush update && rush build -t .`
+- Run `rushx test:node`
+- Run `rushx test:browser`
+
+## Copying the recordings saved in the container
+
+- `docker cp <container_id>:/etc/testproxy/ temp-location`
@@ -0,0 +1,112 @@
+{
+  "name": "@azure/test-utils-recorder-new",
+  "version": "1.0.0",
+  "sdk-type": "utility",
+  "description": "This library provides interfaces and helper methods to provide recording and playback capabilities for the tests in Azure JS/TS SDKs",
+  "main": "dist/index.js",
+  "module": "dist-esm/src/index.js",
+  "types": "./types/src/index.d.ts",
+  "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",
+    "build:node": "tsc -p . && cross-env ONLY_NODE=true rollup -c 2>&1",
+    "build:samples": "echo Skipped.",
+    "build:test": "tsc -p .",
+    "build": "tsc -p . && rollup -c 2>&1",
+    "check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
+    "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": "echo skipped",
+    "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": "npm run integration-test:node && npm run integration-test:browser",
+    "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",
+    "prebuild": "npm run clean",
+    "unit-test:browser": "echo skipped",
+    "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": "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",
+    "test": "npm run clean && npm run build:test && npm run unit-test",
+    "docs": "echo Skipped."
+  },
+  "files": [
+    "dist/",
+    "dist-esm/src/",
+    "types/src",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": "github:Azure/azure-sdk-for-js",
+  "keywords": [
+    "azure",
+    "recording",
+    "cloud",
+    "playback"
+  ],
+  "author": "Microsoft Corporation",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Azure/azure-sdk-for-js/issues"
+  },
+  "engines": {
+    "node": ">=8.0.0"
+  },
+  "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/test-utils/recorder-new/",
+  "sideEffects": false,
+  "private": true,
+  "dependencies": {
+    "@azure/test-utils-recorder": "^1.0.0",
+    "@azure/core-http": "^2.0.0",
+    "@azure/core-rest-pipeline": "^1.1.0"
+  },
+  "devDependencies": {
+    "@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/fs-extra": "^8.0.0",
+    "@types/chai": "^4.1.6",
+    "@types/md5": "^2.2.0",
+    "@types/mocha": "^7.0.2",
+    "@types/nise": "^1.4.0",
+    "@types/node": "^12.0.0",
+    "@types/mock-require": "~2.0.0",
+    "@types/mock-fs": "~4.10.0",
+    "chai": "^4.2.0",
+    "dotenv": "^8.2.0",
+    "eslint": "^7.15.0",
+    "karma": "^6.2.0",
+    "karma-chrome-launcher": "^3.0.0",
+    "karma-coverage": "^2.0.0",
+    "karma-edge-launcher": "^0.4.2",
+    "karma-env-preprocessor": "^0.1.1",
+    "karma-firefox-launcher": "^1.1.0",
+    "karma-ie-launcher": "^1.0.0",
+    "karma-json-preprocessor": "^0.3.3",
+    "karma-json-to-file-reporter": "^1.0.1",
+    "karma-junit-reporter": "^2.0.1",
+    "karma-mocha": "^2.0.1",
+    "karma-mocha-reporter": "^2.2.5",
+    "karma-sourcemap-loader": "^0.3.8",
+    "mocha": "^7.1.1",
+    "mocha-junit-reporter": "^1.18.0",
+    "mock-fs": "^4.10.4",
+    "mock-require": "^3.0.3",
+    "npm-run-all": "^4.1.5",
+    "nyc": "^14.0.0",
+    "prettier": "^1.16.4",
+    "rimraf": "^3.0.0",
+    "rollup": "^1.16.3",
+    "rollup-plugin-shim": "^1.0.0",
+    "rollup-plugin-sourcemaps": "^0.4.2",
+    "rollup-plugin-terser": "^5.1.1",
+    "rollup-plugin-visualizer": "^4.0.4",
+    "typescript": "~4.2.0",
+    "xhr-mock": "^2.4.1"
+  }
+}
@@ -0,0 +1,3 @@
+import { makeConfig } from "@azure/dev-tool/shared-config/rollup";
+
+export default makeConfig(require("./package.json"));
@@ -0,0 +1,21 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { HttpClient, HttpOperationResponse } from "@azure/core-http";
+import { DefaultHttpClient, WebResourceLike } from "@azure/core-http";
+import { TestProxyHttpClient } from "./core-v2-recorder";
+
+export class TestProxyHttpClientCoreV1 extends TestProxyHttpClient {
+  public httpClientCoreV1: HttpClient;
+  constructor(sessionFile: string, playback: boolean) {
+    super(sessionFile, playback);
+    this.httpClientCoreV1 = new DefaultHttpClient();
+  }
+
+  async sendRequest(request: WebResourceLike): Promise<HttpOperationResponse> {
+    if (this.recordingId && (this.mode === "record" || this.mode === "playback")) {
+      request = this.redirectRequest(request);
+    }
+    return await this.httpClientCoreV1.sendRequest(request);
+  }
+}
@@ -0,0 +1,171 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { WebResourceLike } from "@azure/core-http";
+import {
+  createDefaultHttpClient,
+  createPipelineRequest,
+  HttpClient,
+  PipelinePolicy,
+  PipelineRequest,
+  PipelineResponse,
+  SendRequest
+} from "@azure/core-rest-pipeline";
+
+const paths = {
+  playback: "/playback",
+  record: "/record",
+  start: "/start",
+  stop: "/stop"
+};
+
+/**
+ * Helper class to manage the recording state to make sure the proxy-tool is not flooded with unintended requests.
+ *
+ * => then start
+ * => run the runAsync
+ * => stop record
+ * => start playback
+ * => stop playback
+ */
+export class RecordingStateManager {
+  public state: "started" | "stopped" | undefined;
+
+  /**
+   * validateState
+   */
+  public validateState(currentFlow: "starting" | "stopping") {
+    if (currentFlow === "starting") {
+      if (this.state === "started") {
+        throw new Error("Recorder Error: Already started, should not have called start again.");
+      }
+    }
+    if (currentFlow === "stopping") {
+      if (this.state === "stopped") {
+        throw new Error("Recorder Error: Already stopped, should not have called stop again.");
+      }
+      if (this.state !== "started") {
+        throw new Error("Recorder Error: Please start before calling stop.");
+      }
+    }
+    if (currentFlow === "starting") {
+      if (this.state !== "stopped" && this.state !== undefined) {
+        throw new Error("Recorder Error: Please stop before calling start.");
+      }
+    }
+    if (currentFlow === "stopping") {
+      if (this.state !== "started") {
+        throw new Error("Recorder Error: Please start before calling stop.");
+      }
+    }
+  }
+
+  /**
+   * setState
+   */
+  public setState(state: "started" | "stopped") {
+    this.state = state;
+  }
+}
+
+export class TestProxyHttpClient {
+  private url: string;
+  public recordingId?: string;
+  public mode: string;
+  public httpClient: HttpClient;
+  private sessionFile: string;
+  private playback: boolean;
+  private stateManager = new RecordingStateManager();
+
+  constructor(sessionFile: string, playback: boolean) {
+    this.sessionFile = sessionFile;
+    this.playback = playback;
+    this.url = "http://localhost:5000";
+    this.mode = playback ? "playback" : "record";
+    this.httpClient = createDefaultHttpClient();
+  }
+  // For core-v1
+  redirectRequest(request: WebResourceLike): WebResourceLike;
+  // For core-v2
+  redirectRequest(request: PipelineRequest): PipelineRequest;
+  redirectRequest(request: WebResourceLike | PipelineRequest) {
+    if (!request.headers.get("x-recording-id")) {
+      request.headers.set("x-recording-id", this.recordingId!);
+      request.headers.set("x-recording-mode", this.mode);
+
+      const upstreamUrl = new URL(request.url);
+      const redirectedUrl = new URL(request.url);
+      const providedUrl = new URL(this.url);
+
+      redirectedUrl.host = providedUrl.host;
+      redirectedUrl.port = providedUrl.port;
+      redirectedUrl.protocol = providedUrl.protocol;
+      request.headers.set("x-recording-upstream-base-uri", upstreamUrl.toString());
+      request.url = redirectedUrl.toString();
+    }
+    return request;
+  }
+
+  async modifyRequest(request: PipelineRequest): Promise<PipelineRequest> {
+    if (this.recordingId && (this.mode === "record" || this.mode === "playback")) {
+      request = this.redirectRequest(request);
+      request.allowInsecureConnection = true;
+    }
+
+    return request;
+  }
+
+  async start(): Promise<void> {
+    this.stateManager.validateState("starting");
+    if (this.recordingId === undefined) {
+      const startUri = `${this.url}${this.playback ? paths.playback : paths.record}${paths.start}`;
+      const req = this._createRecordingRequest(startUri);
+      const rsp = await this.httpClient.sendRequest({
+        ...req,
+        allowInsecureConnection: true
+      });
+      if (rsp.status !== 200) {
+        throw new Error("Start request failed.");
+      }
+      const id = rsp.headers.get("x-recording-id");
+      if (!id) {
+        throw new Error("No recording ID returned.");
+      }
+      this.recordingId = id;
+    }
+    this.stateManager.setState("started");
+  }
+
+  async stop(): Promise<void> {
+    this.stateManager.validateState("stopping");
+    if (this.recordingId !== undefined) {
+      const stopUri = `${this.url}${this.playback ? paths.playback : paths.record}${paths.stop}`;
+      const req = this._createRecordingRequest(stopUri);
+      req.headers.set("x-recording-save", "true");
+
+      await this.httpClient.sendRequest({ ...req, allowInsecureConnection: true });
+    } else {
+      throw new Error("Recorder Error: Bad state, recordingId is not defined when called stop.");
+    }
+    this.stateManager.setState("stopped");
+  }
+
+  private _createRecordingRequest(url: string) {
+    const req = createPipelineRequest({ url: url, method: "POST" });
+    req.headers.set("x-recording-file", this.sessionFile);
+    if (this.recordingId !== undefined) {
+      req.headers.set("x-recording-id", this.recordingId);
+    }
+    return req;
+  }
+}
+
+export function recorderHttpPolicy(testProxyHttpClient: TestProxyHttpClient): PipelinePolicy {
+  return {
+    name: "recording policy",
+    async sendRequest(request: PipelineRequest, next: SendRequest): Promise<PipelineResponse> {
+      const modifiedRequest = await testProxyHttpClient.modifyRequest(request);
+      return next(modifiedRequest);
+    }
+  };
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		import { makeConfig } from "@azure/dev-tool/shared-config/rollup";

		export default makeConfig(require("./package.json"));