CredScan Reports - clearing noise related to "scope" in request bodies

sdk/test-utils/recorder/CHANGELOG.md

@@ -2,10 +2,18 @@
 
 ## 1.0.0 (Unreleased)
 
+## 2021-04-20
+
+- Extended the `requestBodyTransformations` from [#14897](https://github.com/Azure/azure-sdk-for-js/pull/14897) to handle browser tests as well.
+  - Adds a default transformation to strip out the scope in the request body with the string "https://sanitized/"
+  - Removed `requestBodyTransformations` property from `RecorderEnvironmentSetup` since Nock doesn't support multiple `.filteringRequestBody` patches in the recordings.
+
 ## 2021-04-19
 
 - Helper method added for the transformations to be applied on the requestBody in record mode to be able to filter the requests in playback.
   Extends the `RecorderEnvironmentSetup` with `requestBodyTransformations` property which takes the transformation callbacks to be applied on the request body.
+  [#14897](https://github.com/Azure/azure-sdk-for-js/pull/14897)
+  - Adds a default transformation to strip out the client-request-id in the request body with the string "client-request-body"
 
 ## 2021-04-07
 

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

@@ -9,8 +9,25 @@ import {
   filterSecretsRecursivelyFromJSON,
   generateTestRecordingFilePath
 } from "./utils";
-import { defaultRequestBodyTransforms } from "./utils/requestBodyTransform";
+import {
+  defaultRequestBodyTransforms,
+  RequestBodyTransformsType
+} from "./utils/requestBodyTransform";
 
+type InternalRecorderEnvironmentSetup = RecorderEnvironmentSetup & {
+  /**
+   * Used in record and playback modes
+   *
+   *  Array of callback functions provided to customize the request body
+   *  - Record mode: These callbacks will be applied on the request body before the recording is saved
+   *  - Playback mode: These callbacks will be applied on the request body of the new requests
+   *
+   * // Nock doesn't support multiple `.filteringRequestBody` patches in the recordings,
+   * // ..hence not exporting `requestBodyTransformations` to the users until we find an alternative
+   * // TODO: Best alternative would be to migrate to JSON recordings for node tests
+   */
+  requestBodyTransformations: Required<RequestBodyTransformsType>;
+};
 /**
  * Loads the environment variables in both node and browser modes corresponding to the key-value pairs provided.
  *
@@ -32,7 +49,7 @@ export abstract class BaseRecorder {
   // Example - node/some_random_test_suite/recording_first_test.js
   protected readonly relativeTestRecordingFilePath: string;
   public uniqueTestInfo: TestInfo = { uniqueName: {}, newDate: {} };
-  public environmentSetup: RecorderEnvironmentSetup = {
+  public environmentSetup: InternalRecorderEnvironmentSetup = {
     replaceableVariables: {},
     customizationsOnRecordings: [],
     queryParametersToSkip: [],
@@ -103,14 +120,9 @@ export abstract class BaseRecorder {
         ...environmentSetup.queryParametersToSkip
       ],
       requestBodyTransformations: {
-        stringTransforms:
-          this.environmentSetup.requestBodyTransformations?.stringTransforms?.concat(
-            environmentSetup.requestBodyTransformations?.stringTransforms ?? []
-          ) ?? [],
-        jsonTransforms:
-          this.environmentSetup.requestBodyTransformations?.jsonTransforms?.concat(
-            environmentSetup.requestBodyTransformations?.jsonTransforms ?? []
-          ) ?? []
+        // TODO: Concat with the requestBodyTransformations once exposed
+        stringTransforms: this.environmentSetup.requestBodyTransformations?.stringTransforms,
+        jsonTransforms: this.environmentSetup.requestBodyTransformations?.jsonTransforms
       }
     };
   }

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

@@ -13,6 +13,10 @@ import {
   isPlaybackMode
 } from "./utils";
 import { customConsoleLog } from "./customConsoleLog";
+import {
+  applyRequestBodyTransformations,
+  applyRequestBodyTransformationsOnFixture
+} from "./utils/requestBodyTransform";
 
 // To better understand how this class works, it's necessary to comprehend how HTTP async requests are made:
 // A new request object is created
@@ -29,7 +33,7 @@ import { customConsoleLog } from "./customConsoleLog";
 // Nise module does not have a native implementation of record/playback like Nock does
 // This class overrides requests' 'open', 'send' and 'onreadystatechange' functions, adding our own code to them to deal with requests
 export class NiseRecorder extends BaseRecorder {
-  private recordings: any[] = [];
+  private recordings: { [key: string]: unknown }[] = [];
   private recordingInFlight: Promise<void>[] = [];
   private xhr: nise.FakeXMLHttpRequestStatic | undefined;
 
@@ -92,7 +96,21 @@ export class NiseRecorder extends BaseRecorder {
     return (
       recording.method === request.method &&
       recording.url === request.url &&
-      recording.requestBody === request.requestBody
+      // For backward compatibility, calling `applyRequestBodyTransformations` on
+      // - the request-body in the recording
+      //   and
+      // - the request-body of the new request
+      //
+      // Once all the browser recordings are regenerated, L.H.S can be updated to `recording.requestBody`
+      // since the `applyRequestBodyTransformations` would have been applied before saving the recording
+      applyRequestBodyTransformations(
+        recording.requestBody,
+        this.environmentSetup.requestBodyTransformations
+      ) ===
+        applyRequestBodyTransformations(
+          request.requestBody,
+          this.environmentSetup.requestBodyTransformations
+        )
     );
   }
 
@@ -225,6 +243,14 @@ export class NiseRecorder extends BaseRecorder {
       // recordings at this point are in the JSON format.
       this.recordings = this.filterSecrets(this.recordings);
 
+      this.recordings = this.recordings.map((singleRecording) =>
+        applyRequestBodyTransformationsOnFixture(
+          "browser",
+          singleRecording,
+          this.environmentSetup.requestBodyTransformations
+        )
+      );
+
       // We're sending the recordings to the 'karma-json-to-file-reporter' via console.log
       console.log(
         JSON.stringify({

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

@@ -7,7 +7,7 @@ import { nodeRequireRecordingIfExists } from "./utils/recordings";
 
 import { config as readEnvFile } from "dotenv";
 import fs from "fs-extra";
-import { applyRequestBodyTransformations } from "./utils/requestBodyTransform";
+import { applyRequestBodyTransformationsOnFixture } from "./utils/requestBodyTransform";
 
 let nock: typeof import("nock");
 
@@ -85,7 +85,7 @@ export class NockRecorder extends BaseRecorder {
       for (const fixture of fixtures) {
         let updatedFixture = fixture;
         // Applying any requestBody transformations that are provided
-        updatedFixture = applyRequestBodyTransformations(
+        updatedFixture = applyRequestBodyTransformationsOnFixture(
           "node",
           fixture,
           this.environmentSetup.requestBodyTransformations

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

@@ -2,7 +2,6 @@
 // Licensed under the MIT license.
 
 import { URLBuilder } from "@azure/core-http";
-import { RequestBodyTransformsType } from "./requestBodyTransform";
 
 export { testHasChanged } from "./recordings";
 
@@ -46,14 +45,6 @@ export interface RecorderEnvironmentSetup {
    * @memberof RecorderEnvironmentSetup
    */
   customizationsOnRecordings: Array<(content: string) => string>;
-  /**
-   * Used in record and playback modes
-   *
-   *  Array of callback functions provided to customize the request body
-   *  - Record mode: These callbacks will be applied on the request body before the recording is saved
-   *  - Playback mode: These callbacks will be applied on the request body of the new requests
-   */
-  requestBodyTransformations?: RequestBodyTransformsType;
   /**
    * Used in record and playback modes
    *