feat(calling): auto-fetch RTMS domain from service catalog (#4923)

Author: Kesari3008

packages/calling/src/CallingClient/CallingClient.test.ts

@@ -17,7 +17,7 @@ import {
 /* eslint-disable dot-notation */
 import {CALLING_CLIENT_EVENT_KEYS, CallSessionEvent, MOBIUS_EVENT_KEYS} from '../Events/types';
 import log from '../Logger';
-import {createClient} from './CallingClient';
+import {CallingClient, createClient} from './CallingClient';
 import {ICallingClient} from './types';
 import * as utils from '../common/Utils';
 import {getCallManager} from './calling/callManager';
@@ -212,43 +212,48 @@ describe('CallingClient Tests', () => {
       }).not.toThrow(Error);
     });
 
-    /**
-     * Input sdk config to callingClient with serviceData carrying valid value for indicator
-     * 'contactcenter', but an empty string for domain field in it.
-     *
-     * It should throw error and abort execution as domain value is invalid.
-     *
-     * DOMAIN field for service type 'contactcenter' must carry a non-empty valid domain type string.
-     */
-    it('ContactCenter: verify empty invalid service domain', async () => {
-      const serviceDataObj = {indicator: ServiceIndicator.CONTACT_CENTER, domain: ''};
+    it('ContactCenter: uses config domain and does not fetch RTMS domain from catalog', async () => {
+      const serviceDataObj = {
+        indicator: ServiceIndicator.CONTACT_CENTER,
+        domain: 'test.example.com',
+      };
 
-      try {
-        callingClient = await createClient(webex, {serviceData: serviceDataObj});
-      } catch (e) {
-        expect(e.message).toEqual('Invalid service domain.');
-      }
-      expect.assertions(1);
+      webex.internal.services.get = jest.fn();
+      callingClient = await createClient(webex, {serviceData: serviceDataObj});
+      expect(callingClient).toBeTruthy();
+      expect(webex.internal.services.get).not.toHaveBeenCalled();
     });
 
     /**
      * Input sdk config to callingClient with serviceData carrying valid value for indicator
      * 'contactcenter' , and a valid domain type string for domain field in it.
-     *
-     * Execution should proceed properly and createRegistration should be called with same serviceData.
-     *
-     * DOMAIN field for service type 'contactcenter' must carry a non-empty valid domain type string.
      */
-    it('ContactCenter: verify valid service domain', async () => {
-      const serviceDataObj = {
-        indicator: ServiceIndicator.CONTACT_CENTER,
-        domain: 'test.example.com',
-      };
+    it('ContactCenter: fetches RTMS domain from catalog when config domain is empty', async () => {
+      const serviceDataObj = {indicator: ServiceIndicator.CONTACT_CENTER, domain: ''};
 
-      expect(async () => {
-        callingClient = await createClient(webex, {serviceData: serviceDataObj});
-        expect(callingClient).toBeTruthy();
-      }).not.toThrow(Error);
+      webex.internal.services.get = jest
+        .fn()
+        .mockReturnValue('https://cc-rtms.example.com/calling/web/rtms');
+
+      callingClient = await createClient(webex, {serviceData: serviceDataObj});
+      expect(callingClient).toBeTruthy();
+      expect(webex.internal.services.get).toHaveBeenCalledWith('wcc-calling-rtms-domain');
+    });
+
+    it('ContactCenter: init fails when config domain is empty and catalog fetch fails', async () => {
+      const serviceDataObj = {indicator: ServiceIndicator.CONTACT_CENTER, domain: ''};
+      const createLineSpy = jest.spyOn(CallingClient.prototype as any, 'createLine');
+
+      webex.internal.services.get = jest.fn(() => {
+        throw new Error('catalog unavailable');
+      });
+
+      await expect(createClient(webex, {serviceData: serviceDataObj})).rejects.toThrow(
+        'Invalid service domain.'
+      );
+      expect(createLineSpy).not.toHaveBeenCalled();
+
+      createLineSpy.mockRestore();
     });
 
     it('Get current log level', async () => {

packages/calling/src/CallingClient/CallingClient.ts

@@ -7,6 +7,7 @@ import {METHOD_START_MESSAGE} from '../common/constants';
 import {
   filterMobiusUris,
   handleCallingClientErrors,
+  isValidServiceDomain,
   uploadLogs,
   validateServiceData,
 } from '../common/Utils';
@@ -27,6 +28,7 @@ import {
   ALLOWED_SERVICES,
   HTTP_METHODS,
   MobiusServers,
+  ServiceData,
   WebexRequestPayload,
   RegistrationStatus,
   UploadLogsResponse,
@@ -50,6 +52,7 @@ import {
   METHODS,
   NETWORK_FLAP_TIMEOUT,
   DEVICES_ENDPOINT_RESOURCE,
+  WCC_CALLING_RTMS_DOMAIN,
 } from './constants';
 import Line from './line';
 import {ILine} from './line/types';
@@ -88,6 +91,8 @@ export class CallingClient extends Eventing<CallingClientEventTypes> implements
 
   private sdkConfig?: CallingClientConfig;
 
+  private serviceData: ServiceData;
+
   private primaryMobiusUris: string[];
 
   private backupMobiusUris: string[];
@@ -128,16 +133,16 @@ export class CallingClient extends Eventing<CallingClientEventTypes> implements
     this.webex = this.sdkConnector.getWebex();
 
     this.sdkConfig = config;
-    const serviceData = this.sdkConfig?.serviceData?.indicator
+    this.serviceData = this.sdkConfig?.serviceData?.indicator
       ? this.sdkConfig.serviceData
       : {indicator: ServiceIndicator.CALLING, domain: ''};
 
     const logLevel = this.sdkConfig?.logger?.level ? this.sdkConfig.logger.level : LOGGER.ERROR;
     log.setLogger(logLevel, CALLING_CLIENT_FILE);
-    validateServiceData(serviceData);
+    validateServiceData(this.serviceData);
 
-    this.callManager = getCallManager(this.webex, serviceData.indicator);
-    this.metricManager = getMetricManager(this.webex, serviceData.indicator);
+    this.callManager = getCallManager(this.webex, this.serviceData.indicator);
+    this.metricManager = getMetricManager(this.webex, this.serviceData.indicator);
 
     this.mediaEngine = Media;
 
@@ -202,11 +207,60 @@ export class CallingClient extends Eventing<CallingClientEventTypes> implements
     }
 
     await this.getMobiusServers();
+
+    // Auto-fetch RTMS domain from service catalog for contact-center flows
+    if (
+      this.serviceData.indicator === ServiceIndicator.CONTACT_CENTER &&
+      !this.serviceData.domain
+    ) {
+      const rtmsDomain = this.getRTMSDomain();
+
+      this.serviceData.domain = rtmsDomain;
+      if (this.sdkConfig?.serviceData) {
+        this.sdkConfig.serviceData.domain = this.serviceData.domain;
+      }
+    }
+
+    if (!isValidServiceDomain(this.serviceData)) {
+      throw new Error('Invalid service domain.');
+    }
+
     await this.createLine();
 
     this.setupNetworkEventListeners();
   }
 
+  /**
+   * Retrieves the RTMS domain from the service catalog for contact-center flows.
+   *
+   * @returns The RTMS domain from catalog when available.
+   */
+  private getRTMSDomain(): string {
+    log.info('Fetching RTMS domain from service catalog', {
+      file: CALLING_CLIENT_FILE,
+      method: METHODS.GET_RTMS_DOMAIN,
+    });
+
+    try {
+      const rtmsURL = this.webex.internal.services.get(WCC_CALLING_RTMS_DOMAIN);
+      const url = new URL(rtmsURL);
+
+      log.info(`RTMS domain resolved from catalog: ${url.hostname}`, {
+        file: CALLING_CLIENT_FILE,
+        method: METHODS.GET_RTMS_DOMAIN,
+      });
+
+      return url.hostname;
+    } catch (error) {
+      log.warn(`Failed to fetch RTMS domain from service catalog: ${error}`, {
+        file: CALLING_CLIENT_FILE,
+        method: METHODS.GET_RTMS_DOMAIN,
+      });
+
+      return '';
+    }
+  }
+
   /**
    * Ping a reliable external endpoint with a short timeout to infer connectivity.
    */
@@ -706,7 +760,7 @@ export class CallingClient extends Eventing<CallingClientEventTypes> implements
       this.primaryMobiusUris,
       this.backupMobiusUris,
       this.getLoggingLevel(),
-      this.sdkConfig?.serviceData,
+      this.serviceData,
       this.sdkConfig?.jwe
     );
 

packages/calling/src/CallingClient/constants.ts

@@ -127,6 +127,8 @@ export const MOBIUS_EU_INT = 'mobius-eu-central-1.int.infra.webex.com';
 export const FAILOVER_CACHE_PREFIX = 'wxc-failover-state';
 export const ACTIVE_MOBIUS_STORAGE_KEY = 'wxc-active-mobius';
 export const ICE_CANDIDATES_TIMEOUT = 3000;
+export const WCC_CALLING_RTMS_DOMAIN = 'wcc-calling-rtms-domain';
+
 // Define constants for method names
 export const METHODS = {
   CONSTRUCTOR: 'constructor',
@@ -231,4 +233,5 @@ export const METHODS = {
   UPLOAD_LOGS: 'uploadLogs',
   GET_SDK_CONNECTOR: 'getSDKConnector',
   GET_CONNECTED_CALL: 'getConnectedCall',
+  GET_RTMS_DOMAIN: 'getRTMSDomain',
 };

packages/calling/src/common/Utils.ts

@@ -1579,7 +1579,7 @@ function isValidServiceIndicator(indicator: ServiceIndicator): boolean {
  * @param serviceData - .
  * @returns True if validation is successful else false.
  */
-function isValidServiceDomain(serviceData: ServiceData): boolean {
+export function isValidServiceDomain(serviceData: ServiceData): boolean {
   const regexp = /^[a-z0-9]+([-.]{1}[a-z0-9]+)*\.[a-z]{2,6}$/i;
   const {domain} = serviceData;
 
@@ -1594,7 +1594,7 @@ function isValidServiceDomain(serviceData: ServiceData): boolean {
 }
 
 /**
- * Validates service data object(indicator & domain) and throws
+ * Validates service data object(indicator) and throws
  * exception with a message indicating the reason for validation
  * failure.
  *
@@ -1607,10 +1607,6 @@ export function validateServiceData(serviceData: ServiceData) {
   if (!isValidServiceIndicator(serviceData.indicator)) {
     throw new Error(`Invalid service indicator, Allowed values are: ${formattedValues}`);
   }
-
-  if (!isValidServiceDomain(serviceData)) {
-    throw new Error('Invalid service domain.');
-  }
 }
 
 /**