[core-rest-pipeline] Switch browser transport to fetch (Azure#20201)

Thanks to Azure#19530 we have a new HttpClient that uses Fetch. Currently, we can't make it the default because of recorded tests. However, we'd like folks to be able to try it out, which this PR makes possible.

The solution here is for tests that are dependent on XHR to pass in a custom HttpClient to allow the previous recordings to be used until we can migrate those packages to the new recorder.

Author: xirzec

common/config/rush/pnpm-lock.yaml

@@ -281,6 +281,12 @@
     {
       "name": "mixed-reality-remote-rendering",
       "path": "sdk/remoterendering/mixed-reality-remote-rendering"
+    },
+    {
+      "path": "sdk/test-utils/test-utils"
+    },
+    {
+      "path": "sdk/purview/purview-administration-rest"
     }
   ],
   "settings": {

dataplane.code-workspace

@@ -83,7 +83,7 @@
   "autoPublish": false,
   "dependencies": {
     "@azure/core-auth": "^1.3.0",
-    "@azure-rest/core-client": "1.0.0-beta.8",
+    "@azure-rest/core-client": "1.0.0-beta.9",
     "@azure/core-rest-pipeline": "^1.1.0",
     "@azure/logger": "^1.0.0",
     "tslib": "^2.2.0"
@@ -92,6 +92,7 @@
     "@azure/dev-tool": "^1.0.0",
     "@azure/eslint-plugin-azure-sdk": "^3.0.0",
     "@azure/identity": "^2.0.1",
+    "@azure/test-utils": "^1.0.0",
     "@azure-tools/test-recorder": "^1.0.0",
     "@microsoft/api-extractor": "^7.18.11",
     "@types/chai": "^4.1.6",

sdk/confidentialledger/confidential-ledger-rest/package.json

@@ -5,9 +5,16 @@
 
 import { Context } from "mocha";
 
-import { env, Recorder, record, RecorderEnvironmentSetup } from "@azure-tools/test-recorder";
+import {
+  env,
+  Recorder,
+  record,
+  RecorderEnvironmentSetup,
+  isLiveMode,
+} from "@azure-tools/test-recorder";
 import ConfidentialLedger, { ConfidentialLedgerRestClient } from "../../../src";
 import { ClientSecretCredential } from "@azure/identity";
+import { isNode, createXhrHttpClient } from "@azure/test-utils";
 
 import "./env";
 
@@ -38,12 +45,14 @@ export const environmentSetup: RecorderEnvironmentSetup = {
 };
 
 export function createClient(): ConfidentialLedgerRestClient {
+  const httpClient = isNode || isLiveMode() ? undefined : createXhrHttpClient();
   const credential = new ClientSecretCredential(
     env["AZURE_TENANT_ID"],
     env["AZURE_CLIENT_ID"],
-    env["AZURE_CLIENT_SECRET"]
+    env["AZURE_CLIENT_SECRET"],
+    { httpClient }
   );
-  return ConfidentialLedger(env.ENDPOINT, env.LEDGER_IDENTITY, credential);
+  return ConfidentialLedger(env.ENDPOINT, env.LEDGER_IDENTITY, credential, { httpClient });
 }
 
 /**

sdk/confidentialledger/confidential-ledger-rest/test/public/utils/recordedClient.ts

@@ -6,8 +6,11 @@ import {
   env,
   RecorderEnvironmentSetup,
   pluginForClientSecretCredentialTests,
+  isLiveMode,
 } from "@azure-tools/test-recorder";
 import { ContainerRegistryClient, KnownContainerRegistryAudience } from "../../src";
+import { isNode } from "./isNode";
+import { createXhrHttpClient } from "@azure/test-utils";
 
 // When the recorder observes the values of these environment variables in any
 // recorded HTTP request or response, it will replace them with the values they
@@ -92,9 +95,11 @@ export function createRegistryClient(
   const authorityHost = getAuthority(endpoint);
   const audience = getAudience(authorityHost);
   const tokenCredentialOptions = authorityHost ? { authorityHost } : undefined;
+  const httpClient = isNode || isLiveMode() ? undefined : createXhrHttpClient();
   const clientOptions = {
     audience,
     serviceVersion: serviceVersion as ContainerRegistryServiceVersions,
+    httpClient,
   };
 
   if (options.anonymous) {
@@ -110,7 +115,7 @@ export function createRegistryClient(
     env.CONTAINERREGISTRY_TENANT_ID,
     env.CONTAINERREGISTRY_CLIENT_ID,
     env.CONTAINERREGISTRY_CLIENT_SECRET,
-    tokenCredentialOptions
+    { ...tokenCredentialOptions, httpClient }
   );
 
   return new ContainerRegistryClient(endpoint, credential, clientOptions);

sdk/containerregistry/container-registry/test/utils/utils.ts

@@ -4,6 +4,7 @@
 
 ```ts
 
+import { HttpClient } from '@azure/core-rest-pipeline';
 import { KeyCredential } from '@azure/core-auth';
 import { Pipeline } from '@azure/core-rest-pipeline';
 import { PipelineOptions } from '@azure/core-rest-pipeline';
@@ -43,6 +44,7 @@ export type ClientOptions = PipelineOptions & {
     apiVersion?: string;
     allowInsecureConnection?: boolean;
     additionalPolicies?: AdditionalPolicyConfig[];
+    httpClient?: HttpClient;
 };
 
 // @public

sdk/core/core-client-rest/review/core-client.api.md

@@ -2,6 +2,7 @@
 // Licensed under the MIT license.
 
 import {
+  HttpClient,
   Pipeline,
   PipelineOptions,
   PipelinePolicy,
@@ -181,6 +182,10 @@ export type ClientOptions = PipelineOptions & {
    * Additional policies to include in the HTTP pipeline.
    */
   additionalPolicies?: AdditionalPolicyConfig[];
+  /**
+   * Specify a custom HttpClient when making requests.
+   */
+  httpClient?: HttpClient;
 };
 
 /**

sdk/core/core-client-rest/src/common.ts

@@ -3,7 +3,7 @@
 
 import { isTokenCredential, KeyCredential, TokenCredential } from "@azure/core-auth";
 import { isCertificateCredential } from "./certificateCredential";
-import { HttpMethods, Pipeline, PipelineOptions } from "@azure/core-rest-pipeline";
+import { HttpClient, HttpMethods, Pipeline, PipelineOptions } from "@azure/core-rest-pipeline";
 import { createDefaultPipeline } from "./clientHelpers";
 import { Client, ClientOptions, HttpResponse, RequestParameters } from "./common";
 import { sendRequest } from "./sendRequest";
@@ -52,7 +52,7 @@ export function getClient(
     }
   }
 
-  const { allowInsecureConnection } = clientOptions;
+  const { allowInsecureConnection, httpClient } = clientOptions;
   const client = (path: string, ...args: Array<any>) => {
     return {
       get: (options: RequestParameters = {}): Promise<HttpResponse> => {
@@ -62,7 +62,8 @@ export function getClient(
           path,
           pipeline,
           { allowInsecureConnection, ...options },
-          args
+          args,
+          httpClient
         );
       },
       post: (options: RequestParameters = {}): Promise<HttpResponse> => {
@@ -72,7 +73,8 @@ export function getClient(
           path,
           pipeline,
           { allowInsecureConnection, ...options },
-          args
+          args,
+          httpClient
         );
       },
       put: (options: RequestParameters = {}): Promise<HttpResponse> => {
@@ -82,7 +84,8 @@ export function getClient(
           path,
           pipeline,
           { allowInsecureConnection, ...options },
-          args
+          args,
+          httpClient
         );
       },
       patch: (options: RequestParameters = {}): Promise<HttpResponse> => {
@@ -92,7 +95,8 @@ export function getClient(
           path,
           pipeline,
           { allowInsecureConnection, ...options },
-          args
+          args,
+          httpClient
         );
       },
       delete: (options: RequestParameters = {}): Promise<HttpResponse> => {
@@ -102,7 +106,8 @@ export function getClient(
           path,
           pipeline,
           { allowInsecureConnection, ...options },
-          args
+          args,
+          httpClient
         );
       },
       head: (options: RequestParameters = {}): Promise<HttpResponse> => {
@@ -112,7 +117,8 @@ export function getClient(
           path,
           pipeline,
           { allowInsecureConnection, ...options },
-          args
+          args,
+          httpClient
         );
       },
       options: (options: RequestParameters = {}): Promise<HttpResponse> => {
@@ -122,7 +128,8 @@ export function getClient(
           path,
           pipeline,
           { allowInsecureConnection, ...options },
-          args
+          args,
+          httpClient
         );
       },
       trace: (options: RequestParameters = {}): Promise<HttpResponse> => {
@@ -132,7 +139,8 @@ export function getClient(
           path,
           pipeline,
           { allowInsecureConnection, ...options },
-          args
+          args,
+          httpClient
         );
       },
     };
@@ -151,11 +159,12 @@ function buildSendRequest(
   path: string,
   pipeline: Pipeline,
   requestOptions: RequestParameters = {},
-  args: string[] = []
+  args: string[] = [],
+  httpClient?: HttpClient
 ): Promise<HttpResponse> {
   // If the client has an api-version and the request doesn't specify one, inject the one in the client options
   const url = buildRequestUrl(baseUrl, path, args, requestOptions);
-  return sendRequest(method, url, pipeline, requestOptions);
+  return sendRequest(method, url, pipeline, requestOptions, httpClient);
 }
 
 function isCredential(

sdk/core/core-client-rest/src/getClient.ts

@@ -5,6 +5,7 @@ import {
   createHttpHeaders,
   createPipelineRequest,
   FormDataMap,
+  HttpClient,
   HttpMethods,
   Pipeline,
   PipelineRequest,
@@ -23,15 +24,17 @@ import { binaryArrayToString, stringToBinaryArray } from "./helpers/getBinaryBod
  * @param url - url to send the request to
  * @param pipeline - pipeline with the policies to run when sending the request
  * @param options - request options
+ * @param customHttpClient - a custom HttpClient to use when making the request
  * @returns returns and HttpResponse
  */
 export async function sendRequest(
   method: HttpMethods,
   url: string,
   pipeline: Pipeline,
-  options: RequestParameters = {}
+  options: RequestParameters = {},
+  customHttpClient?: HttpClient
 ): Promise<HttpResponse> {
-  const httpClient = getCachedDefaultHttpsClient();
+  const httpClient = customHttpClient ?? getCachedDefaultHttpsClient();
   const request = buildPipelineRequest(method, url, options);
   const response = await pipeline.sendRequest(httpClient, request);
   const rawHeaders: RawHttpHeaders = response.headers.toJSON();

sdk/core/core-client-rest/src/sendRequest.ts

@@ -2,11 +2,11 @@
 // Licensed under the MIT license.
 
 import { HttpClient } from "./interfaces";
-import { createXhrHttpClient } from "./xhrHttpClient";
+import { createFetchHttpClient } from "./fetchHttpClient";
 
 /**
  * Create the correct HttpClient for the current environment.
  */
 export function createDefaultHttpClient(): HttpClient {
-  return createXhrHttpClient();
+  return createFetchHttpClient();
 }