[Unified Recorder] recorder.configureClient() design similar to the perf framework

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

@@ -2,6 +2,12 @@
 
 ## 1.0.0 (Unreleased)
 
+## 2021-12-14
+
+- Add `configureClient` method to the `TestProxytHttpClient` to allow instrumenting the client with the recorder policy which helps in enabling the recorder to redirect the requests of your tests to the proxy tool.
+  - Also un-exports `recorderHttpPolicy` function.
+    [#19362](https://github.com/Azure/azure-sdk-for-js/pull/19362)
+
 ## 2021-12-13
 
 - Add support for `setMatcher`, which can be used to instruct the proxy tool to ignore headers (using `HeaderlessMatcher`) or the request body (using `BodilessMatcher`) when matching requests to recordings.

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

@@ -7,12 +7,13 @@ import {
   createPipelineRequest,
   HttpClient,
   HttpMethods,
+  Pipeline,
   PipelinePolicy,
   PipelineRequest,
   PipelineResponse,
   SendRequest
 } from "@azure/core-rest-pipeline";
-import { isPlaybackMode, isRecordMode } from "@azure-tools/test-recorder";
+import { isLiveMode, isPlaybackMode, isRecordMode } from "@azure-tools/test-recorder";
 import {
   ensureExistence,
   getTestMode,
@@ -255,6 +256,16 @@ export class TestProxyHttpClient {
     }
     return req;
   }
+
+  /**
+   * For core-v2 - libraries depending on core-rest-pipeline.
+   * This method adds the recording policy to the input client's pipeline.
+   */
+  public configureClient(client: { pipeline: Pipeline }): void {
+    if (!isLiveMode()) {
+      client.pipeline.addPolicy(recorderHttpPolicy(this));
+    }
+  }
 }
 
 /**

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

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-export { recorderHttpPolicy, TestProxyHttpClient } from "./core-v2-recorder";
+export { TestProxyHttpClient } from "./core-v2-recorder";
 export { TestProxyHttpClientCoreV1 } from "./core-v1-recorder";
 export { relativeRecordingsPath } from "./utils/relativePathCalculator";
 export { SanitizerOptions, RecorderStartOptions } from "./utils/utils";

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

@@ -8,7 +8,7 @@ import {
   PipelineRequestOptions
 } from "@azure/core-rest-pipeline";
 import { ServiceClient } from "@azure/core-client";
-import { recorderHttpPolicy, TestProxyHttpClient } from "../src";
+import { TestProxyHttpClient } from "../src";
 import { expect } from "chai";
 
 type TestMode = "record" | "playback" | "live" | undefined;
@@ -56,7 +56,7 @@ function getTestServerUrl() {
     beforeEach(async function() {
       recorder = new TestProxyHttpClient(this.currentTest);
       client = new ServiceClient({ baseUri: getTestServerUrl() });
-      client.pipeline.addPolicy(recorderHttpPolicy(recorder));
+      recorder.configureClient(client);
     });
 
     afterEach(async () => {

sdk/test-utils/testing-recorder-new/test/core-v2-test.spec.ts

@@ -3,11 +3,7 @@
 
 import { env, isPlaybackMode } from "@azure-tools/test-recorder";
 import { TableEntity, TableClient } from "@azure/data-tables";
-import {
-  TestProxyHttpClient,
-  recorderHttpPolicy,
-  RecorderStartOptions
-} from "@azure-tools/test-recorder-new";
+import { TestProxyHttpClient, RecorderStartOptions } from "@azure-tools/test-recorder-new";
 import { createSimpleEntity } from "./utils/utils";
 import { SanitizerOptions } from "@azure-tools/test-recorder-new";
 
@@ -51,7 +47,7 @@ describe("Core V2 tests", () => {
       env.TABLES_SAS_CONNECTION_STRING,
       recorder.variables["table-name"]
     );
-    client.pipeline.addPolicy(recorderHttpPolicy(recorder));
+    recorder.configureClient(client);
     await client.createTable();
     const simpleEntity: TableEntity = createSimpleEntity();
     await client.createEntity(simpleEntity);

sdk/test-utils/testing-recorder-new/test/noOpCredentialTest.spec.ts

@@ -4,7 +4,6 @@
 import {
   RecorderStartOptions,
   NoOpCredential,
-  recorderHttpPolicy,
   TestProxyHttpClient
 } from "@azure-tools/test-recorder-new";
 import { env, isPlaybackMode } from "@azure-tools/test-recorder";
@@ -55,7 +54,7 @@ describe(`NoOp credential with Tables`, () => {
     }
     const tableName = recorder.variables["table-name"];
     const client = new TableServiceClient(env.TABLES_URL, credential);
-    client.pipeline.addPolicy(recorderHttpPolicy(recorder));
+    recorder.configureClient(client);
     await client.createTable(tableName);
     await client.deleteTable(tableName);
   });