[ACS][CallAutomation] Fixing Custom endpoint pointing for sub-clients (#27989)

Fixing bug where sub-clients (CallConnection, CallMedia, CallRecording)
unable to authenticate properly

---------

Co-authored-by: Min Woo Lee 🧊 <[email protected]>

Author: minwoolee-msft

sdk/communication/communication-call-automation/src/callAutomationClient.ts

@@ -6,7 +6,6 @@ import { InternalPipelineOptions } from "@azure/core-rest-pipeline";
 import {
   parseClientArguments,
   isKeyCredential,
-  createCommunicationAuthPolicy,
   CommunicationIdentifier,
   CommunicationUserIdentifier,
 } from "@azure/communication-common";
@@ -39,7 +38,7 @@ import {
   PhoneNumberIdentifierModelConverter,
 } from "./utli/converters";
 import { v4 as uuidv4 } from "uuid";
-import { createCallAutomationAuthPolicy } from "./credential/callAutomationAuthPolicy";
+import { createCustomCallAutomationApiClient } from "./credential/callAutomationAuthPolicy";
 import { CallAutomationEventProcessor } from "./eventprocessor/callAutomationEventProcessor";
 import { AnswerCallEventResult, CreateCallEventResult } from "./eventprocessor/eventResponses";
 /**
@@ -69,6 +68,7 @@ export class CallAutomationClient {
   private readonly credential: TokenCredential | KeyCredential;
   private readonly internalPipelineOptions: InternalPipelineOptions;
   private readonly callAutomationEventProcessor: CallAutomationEventProcessor;
+  private readonly endpoint: string;
   /**
    * Initializes a new instance of the CallAutomationClient class.
    * @param connectionString - Connection string to connect to an Azure Communication Service resource.
@@ -112,29 +112,19 @@ export class CallAutomationClient {
     };
 
     const { url, credential } = parseClientArguments(connectionStringOrUrl, credentialOrOptions);
+    this.endpoint = url;
 
     this.credential = credential;
 
     // create event processor
     this.callAutomationEventProcessor = new CallAutomationEventProcessor();
 
-    // read environment variable for callAutomation auth
-    const customEnabled = process.env.COMMUNICATION_CUSTOM_ENDPOINT_ENABLED;
-    const customUrl = process.env.COMMUNICATION_CUSTOM_URL;
-
-    if (customEnabled?.toLowerCase() === "true" && customUrl) {
-      // add custom header for Call Automation auth when flag is true
-      this.callAutomationApiClient = new CallAutomationApiClient(
-        customUrl,
-        this.internalPipelineOptions
-      );
-      const callAutomationAuthPolicy = createCallAutomationAuthPolicy(credential, url);
-      this.callAutomationApiClient.pipeline.addPolicy(callAutomationAuthPolicy);
-    } else {
-      this.callAutomationApiClient = new CallAutomationApiClient(url, this.internalPipelineOptions);
-      const authPolicy = createCommunicationAuthPolicy(credential);
-      this.callAutomationApiClient.pipeline.addPolicy(authPolicy);
-    }
+    // create api client (using custom api endpoint if available)
+    this.callAutomationApiClient = createCustomCallAutomationApiClient(
+      credential,
+      this.internalPipelineOptions,
+      this.endpoint
+    );
 
     this.sourceIdentity = communicationUserIdentifierModelConverter(options.sourceIdentity);
   }
@@ -146,7 +136,7 @@ export class CallAutomationClient {
   public getCallConnection(callConnectionId: string): CallConnection {
     return new CallConnection(
       callConnectionId,
-      this.callAutomationApiClient.endpoint,
+      this.endpoint,
       this.credential,
       this.callAutomationEventProcessor,
       this.internalPipelineOptions
@@ -157,11 +147,7 @@ export class CallAutomationClient {
    * Initializes a new instance of CallRecording.
    */
   public getCallRecording(): CallRecording {
-    return new CallRecording(
-      this.callAutomationApiClient.endpoint,
-      this.credential,
-      this.internalPipelineOptions
-    );
+    return new CallRecording(this.endpoint, this.credential, this.internalPipelineOptions);
   }
 
   /**
@@ -205,7 +191,7 @@ export class CallAutomationClient {
       };
       const callConnection = new CallConnection(
         callConnectionId,
-        this.callAutomationApiClient.endpoint,
+        this.endpoint,
         this.credential,
         this.callAutomationEventProcessor,
         this.internalPipelineOptions
@@ -339,7 +325,7 @@ export class CallAutomationClient {
       };
       const callConnection = new CallConnection(
         callConnectionId,
-        this.callAutomationApiClient.endpoint,
+        this.endpoint,
         this.credential,
         this.callAutomationEventProcessor,
         this.internalPipelineOptions

sdk/communication/communication-call-automation/src/callConnection.ts

@@ -1,10 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import {
-  CommunicationIdentifier,
-  createCommunicationAuthPolicy,
-} from "@azure/communication-common";
+import { CommunicationIdentifier } from "@azure/communication-common";
 import { CallMedia } from "./callMedia";
 import {
   AddParticipantRequest,
@@ -57,6 +54,7 @@ import {
   RemoveParticipantEventResult,
   TransferCallToParticipantEventResult,
 } from "./eventprocessor/eventResponses";
+import { createCustomCallAutomationApiClient } from "./credential/callAutomationAuthPolicy";
 
 /**
  * CallConnection class represents call connection based APIs.
@@ -76,9 +74,11 @@ export class CallConnection {
     eventProcessor: CallAutomationEventProcessor,
     options?: CallAutomationApiClientOptionalParams
   ) {
-    this.callAutomationApiClient = new CallAutomationApiClient(endpoint, options);
-    const authPolicy = createCommunicationAuthPolicy(credential);
-    this.callAutomationApiClient.pipeline.addPolicy(authPolicy);
+    this.callAutomationApiClient = createCustomCallAutomationApiClient(
+      credential,
+      options,
+      endpoint
+    );
     this.callConnectionId = callConnectionId;
     this.callConnection = new CallConnectionImpl(this.callAutomationApiClient);
     this.endpoint = endpoint;

sdk/communication/communication-call-automation/src/callMedia.ts

@@ -26,7 +26,6 @@ import { CallMediaImpl } from "./generated/src/operations";
 
 import {
   CommunicationIdentifier,
-  createCommunicationAuthPolicy,
   serializeCommunicationIdentifier,
 } from "@azure/communication-common";
 
@@ -55,6 +54,7 @@ import {
 } from "./eventprocessor/eventResponses";
 import { CallAutomationEventProcessor } from "./eventprocessor/callAutomationEventProcessor";
 import { v4 as uuidv4 } from "uuid";
+import { createCustomCallAutomationApiClient } from "./credential/callAutomationAuthPolicy";
 
 /**
  * CallMedia class represents call media related APIs.
@@ -71,9 +71,11 @@ export class CallMedia {
     eventProcessor: CallAutomationEventProcessor,
     options?: CallAutomationApiClientOptionalParams
   ) {
-    this.callAutomationApiClient = new CallAutomationApiClient(endpoint, options);
-    const authPolicy = createCommunicationAuthPolicy(credential);
-    this.callAutomationApiClient.pipeline.addPolicy(authPolicy);
+    this.callAutomationApiClient = createCustomCallAutomationApiClient(
+      credential,
+      options,
+      endpoint
+    );
     this.callConnectionId = callConnectionId;
     this.callAutomationEventProcessor = eventProcessor;
     this.callMedia = new CallMediaImpl(this.callAutomationApiClient);

sdk/communication/communication-call-automation/src/callRecording.ts

@@ -21,7 +21,7 @@ import * as fs from "fs";
 import { v4 as uuidv4 } from "uuid";
 import { KeyCredential, TokenCredential } from "@azure/core-auth";
 import { CallAutomationApiClient } from "./generated/src";
-import { createCommunicationAuthPolicy } from "@azure/communication-common";
+import { createCustomCallAutomationApiClient } from "./credential/callAutomationAuthPolicy";
 
 /**
  * CallRecording class represents call recording related APIs.
@@ -36,9 +36,11 @@ export class CallRecording {
     credential: KeyCredential | TokenCredential,
     options?: CallAutomationApiClientOptionalParams
   ) {
-    this.callAutomationApiClient = new CallAutomationApiClient(endpoint, options);
-    const authPolicy = createCommunicationAuthPolicy(credential);
-    this.callAutomationApiClient.pipeline.addPolicy(authPolicy);
+    this.callAutomationApiClient = createCustomCallAutomationApiClient(
+      credential,
+      options,
+      endpoint
+    );
 
     this.callRecordingImpl = new CallRecordingImpl(this.callAutomationApiClient);
     this.contentDownloader = new ContentDownloaderImpl(this.callAutomationApiClient);

sdk/communication/communication-call-automation/src/credential/callAutomationAuthPolicy.ts

@@ -8,6 +8,8 @@ import {
 } from "@azure/core-rest-pipeline";
 import { KeyCredential, TokenCredential, isTokenCredential } from "@azure/core-auth";
 import { createCallAutomationAccessKeyCredentialPolicy } from "./callAutomationAccessKeyCredentialPolicy";
+import { CallAutomationApiClient, CallAutomationApiClientOptionalParams } from "./../generated/src";
+import { createCommunicationAuthPolicy } from "@azure/communication-common";
 /**
  * Creates a pipeline policy to authenticate request based
  * on the credential passed in.
@@ -29,3 +31,34 @@ export function createCallAutomationAuthPolicy(
     return createCallAutomationAccessKeyCredentialPolicy(credential, acsUrl);
   }
 }
+
+/**
+ * Creates CallAutomationApiClient for custom endpoint
+ * @hidden
+ *
+ * @param credential - The KeyCredential or TokenCredential.
+ * @param internalPipelineOptions - CallAutomationApiClientOptionalParams if provided.
+ * @param url - ACS url.
+ */
+export function createCustomCallAutomationApiClient(
+  credential: KeyCredential | TokenCredential,
+  internalPipelineOptions: CallAutomationApiClientOptionalParams | undefined,
+  url: string
+): CallAutomationApiClient {
+  // read environment variable for callAutomation auth
+  const customEnabled = process.env.COMMUNICATION_CUSTOM_ENDPOINT_ENABLED;
+  const customUrl = process.env.COMMUNICATION_CUSTOM_URL;
+  let callAutomationApiClient: CallAutomationApiClient;
+
+  if (customEnabled?.toLowerCase() === "true" && customUrl) {
+    // add custom header for Call Automation auth when flag is true
+    callAutomationApiClient = new CallAutomationApiClient(customUrl, internalPipelineOptions);
+    const callAutomationAuthPolicy = createCallAutomationAuthPolicy(credential, url);
+    callAutomationApiClient.pipeline.addPolicy(callAutomationAuthPolicy);
+  } else {
+    callAutomationApiClient = new CallAutomationApiClient(url, internalPipelineOptions);
+    const authPolicy = createCommunicationAuthPolicy(credential);
+    callAutomationApiClient.pipeline.addPolicy(authPolicy);
+  }
+  return callAutomationApiClient;
+}