@webex/contact-center 3.12.0-next.13 → 3.12.0-next.130

package/test/unit/spec/logger-proxy.ts

@@ -0,0 +1,70 @@
+import LoggerProxy from '../../../src/logger-proxy';
+
+describe('LoggerProxy', () => {
+  beforeEach(() => {
+    // Reset between tests
+    (LoggerProxy as any).logger = undefined;
+  });
+
+  it('no-ops when logger is not initialized', () => {
+    expect(() => {
+      LoggerProxy.log('msg');
+      LoggerProxy.info('msg');
+      LoggerProxy.warn('msg');
+      LoggerProxy.trace('msg');
+      LoggerProxy.error('msg');
+    }).not.toThrow();
+  });
+
+  it('routes calls to the injected logger with formatted context', () => {
+    const logger = {
+      log: jest.fn(),
+      info: jest.fn(),
+      warn: jest.fn(),
+      trace: jest.fn(),
+      error: jest.fn(),
+    };
+
+    LoggerProxy.initialize(logger as any);
+
+    LoggerProxy.log('hello', {module: 'm', method: 'fn', interactionId: 'i', trackingId: 't'});
+    expect(logger.log).toHaveBeenCalled();
+    expect(String(logger.log.mock.calls[0][0])).toContain('module:m - method:fn');
+    expect(String(logger.log.mock.calls[0][0])).toContain('interactionId:i');
+    expect(String(logger.log.mock.calls[0][0])).toContain('trackingId:t');
+
+    LoggerProxy.info('hello', {module: 'm', method: 'fn'});
+    LoggerProxy.warn('hello', {module: 'm', method: 'fn'});
+    LoggerProxy.trace('hello', {module: 'm', method: 'fn'});
+    LoggerProxy.error('hello', {module: 'm', method: 'fn'});
+    expect(logger.info).toHaveBeenCalled();
+    expect(logger.warn).toHaveBeenCalled();
+    expect(logger.trace).toHaveBeenCalled();
+    expect(logger.error).toHaveBeenCalled();
+  });
+
+  it('handles unserializable data and different error shapes', () => {
+    const logger = {
+      log: jest.fn(),
+      info: jest.fn(),
+      warn: jest.fn(),
+      trace: jest.fn(),
+      error: jest.fn(),
+    };
+    LoggerProxy.initialize(logger as any);
+
+    const circular: any = {};
+    circular.self = circular;
+
+    LoggerProxy.info('msg', {module: 'm', method: 'fn', data: circular, error: 'oops'});
+    expect(String(logger.info.mock.calls[0][0])).toContain('data:[object]');
+    expect(String(logger.info.mock.calls[0][0])).toContain('error:oops');
+
+    const err = new Error('boom');
+    LoggerProxy.error('msg', {module: 'm', method: 'fn', error: err});
+    const errorLine = String(logger.error.mock.calls[0][0]);
+    expect(errorLine).toContain('error:Error:boom');
+    expect(errorLine).toContain('stack:');
+  });
+});
+

package/test/unit/spec/metrics/MetricsManager.ts

@@ -252,6 +252,31 @@ describe('MetricsManagerImplementation', () => {
     });
   });
 
+  describe('cancelTimedEvent', () => {
+    it('should clear a running timer without attaching duration to a later unrelated event', () => {
+      jest.spyOn(MetricsManager.prototype as any, 'isMetricsDisabled').mockReturnValue(false);
+      metricsManager.timeEvent(['timedSuccess', 'timedFailed']);
+      metricsManager.cancelTimedEvent(['timedSuccess', 'timedFailed']);
+
+      const result = metricsManager['addDurationIfTimed']('timedFailed');
+
+      expect(result).toEqual({});
+      expect(metricsManager['runningEvents']['timedSuccess']).toBeUndefined();
+    });
+
+    it('should not clear timers when metrics are disabled', () => {
+      jest.spyOn(MetricsManager.prototype as any, 'isMetricsDisabled').mockReturnValue(true);
+      metricsManager['runningEvents']['event1'] = {
+        startTime: 100,
+        keys: new Set(['event1']),
+      };
+
+      metricsManager.cancelTimedEvent('event1');
+
+      expect(metricsManager['runningEvents']['event1']).toBeDefined();
+    });
+  });
+
   describe('addDurationIfTimed', () => {
     it('should return options when event name is not in runningEvents', () => {
       const options: EventPayload = {key: 'value'};

package/test/unit/spec/metrics/behavioral-events.ts

@@ -152,6 +152,24 @@ describe('metrics/behavioral-events', () => {
         verb: 'fail',
       });
 
+      expect(
+        getEventTaxonomy(METRIC_EVENT_NAMES.TASK_CONFERENCE_PARTICIPANT_DROP_SUCCESS)
+      ).toEqual({
+        product,
+        agent: 'user',
+        target: 'task_conference_participant_drop',
+        verb: 'complete',
+      });
+
+      expect(
+        getEventTaxonomy(METRIC_EVENT_NAMES.TASK_CONFERENCE_PARTICIPANT_DROP_FAILED)
+      ).toEqual({
+        product,
+        agent: 'user',
+        target: 'task_conference_participant_drop',
+        verb: 'fail',
+      });
+
       expect(getEventTaxonomy(METRIC_EVENT_NAMES.TASK_AUTO_ANSWER_SUCCESS)).toEqual({
         product,
         agent: 'user',
@@ -166,6 +184,48 @@ describe('metrics/behavioral-events', () => {
         verb: 'fail',
       });
 
+      expect(getEventTaxonomy(METRIC_EVENT_NAMES.WXAPP_TASK_ACCEPT_SUCCESS)).toEqual({
+        product,
+        agent: 'user',
+        target: 'task_accept_webex_together',
+        verb: 'complete',
+      });
+
+      expect(getEventTaxonomy(METRIC_EVENT_NAMES.WXAPP_SESSION_SKIPPED)).toEqual({
+        product,
+        agent: 'user',
+        target: 'webex_together_session_init',
+        verb: 'ignore',
+      });
+
+      expect(getEventTaxonomy(METRIC_EVENT_NAMES.WXAPP_USERSUB_PUBLISH_SUCCESS)).toEqual({
+        product,
+        agent: 'user',
+        target: 'webex_together_usersub_publish',
+        verb: 'complete',
+      });
+
+      expect(getEventTaxonomy(METRIC_EVENT_NAMES.WXAPP_MERCURY_SUBSCRIBE_FAILED)).toEqual({
+        product,
+        agent: 'user',
+        target: 'webex_together_mercury_subscribe',
+        verb: 'fail',
+      });
+
+      expect(getEventTaxonomy(METRIC_EVENT_NAMES.WXAPP_TASK_MUTE_SUCCESS)).toEqual({
+        product,
+        agent: 'user',
+        target: 'task_mute_webex_together',
+        verb: 'complete',
+      });
+
+      expect(getEventTaxonomy(METRIC_EVENT_NAMES.WXAPP_TASK_DTMF_FAILED)).toEqual({
+        product,
+        agent: 'user',
+        target: 'task_dtmf_webex_together',
+        verb: 'fail',
+      });
+
       expect(getEventTaxonomy('' as METRIC_EVENT_NAMES)).toEqual(undefined);
     });
   });

package/test/unit/spec/services/AddressBook.ts

@@ -99,7 +99,8 @@ describe('AddressBook', () => {
 
       expect(mockWebex.request).toHaveBeenCalledWith({
         service: 'wcc-api-gateway',
-        resource: '/organization/test-org-id/v2/address-book/test-address-book-id/entry?page=0&pageSize=100',
+        resource:
+          '/organization/test-org-id/v2/address-book/test-address-book-id/entry?page=0&pageSize=100&sort=name%2CASC',
         method: HTTP_METHODS.GET,
       });
 
@@ -133,7 +134,8 @@ describe('AddressBook', () => {
         module: 'AddressBook',
         method: 'getEntries',
         data: {
-          resource: '/organization/test-org-id/v2/address-book/test-address-book-id/entry?page=0&pageSize=100',
+          resource:
+            '/organization/test-org-id/v2/address-book/test-address-book-id/entry?page=0&pageSize=100&sort=name%2CASC',
           service: 'wcc-api-gateway',
         },
       });
@@ -155,7 +157,8 @@ describe('AddressBook', () => {
 
       expect(mockWebex.request).toHaveBeenCalledWith({
         service: 'wcc-api-gateway',
-        resource: '/organization/test-org-id/v2/address-book/custom-book-id/entry?page=1&pageSize=25&filter=name%3D%3D%22John+Doe%22&attributes=id%2Cname%2Cnumber&search=john',
+        resource:
+          '/organization/test-org-id/v2/address-book/custom-book-id/entry?page=1&pageSize=25&filter=name%3D%3D%22John+Doe%22&attributes=id%2Cname%2Cnumber&search=john&sort=name%2CASC',
         method: HTTP_METHODS.GET,
       });
 
@@ -175,6 +178,31 @@ describe('AddressBook', () => {
       );
     });
 
+    it('should allow callers to override the default backend sorting and bypass the default page cache', async () => {
+      (mockWebex.request as jest.Mock).mockResolvedValue(mockResponse);
+
+      await addressBookAPI.getEntries({
+        page: 0,
+        pageSize: 25,
+        sortBy: 'name',
+        sortOrder: 'desc',
+      });
+      await addressBookAPI.getEntries({
+        page: 0,
+        pageSize: 25,
+        sortBy: 'name',
+        sortOrder: 'desc',
+      });
+
+      expect(mockWebex.request).toHaveBeenCalledTimes(2);
+      expect(mockWebex.request).toHaveBeenLastCalledWith({
+        service: 'wcc-api-gateway',
+        resource:
+          '/organization/test-org-id/v2/address-book/test-address-book-id/entry?page=0&pageSize=25&sort=name%2CDESC',
+        method: HTTP_METHODS.GET,
+      });
+    });
+
     it('should handle API errors and track metrics', async () => {
       (mockWebex.request as jest.Mock).mockRejectedValue(new Error('Internal Server Error'));
 
@@ -182,7 +210,8 @@ describe('AddressBook', () => {
 
       expect(mockWebex.request).toHaveBeenCalledWith({
         service: 'wcc-api-gateway',
-        resource: '/organization/test-org-id/v2/address-book/test-address-book-id/entry?page=0&pageSize=100',
+        resource:
+          '/organization/test-org-id/v2/address-book/test-address-book-id/entry?page=0&pageSize=100&sort=name%2CASC',
         method: HTTP_METHODS.GET,
       });
 
@@ -316,14 +345,16 @@ describe('AddressBook', () => {
       expect(result.meta.page).toBe(1);
       expect(mockWebex.request).toHaveBeenCalledWith({
         service: 'wcc-api-gateway',
-        resource: '/organization/test-org-id/v2/address-book/test-address-book-id/entry?page=1&pageSize=100',
+        resource:
+          '/organization/test-org-id/v2/address-book/test-address-book-id/entry?page=1&pageSize=100&sort=name%2CASC',
         method: HTTP_METHODS.GET,
       });
       expect(LoggerProxy.info).toHaveBeenCalledWith('Making API request to fetch address book entries', {
         module: 'AddressBook',
         method: 'getEntries',
         data: {
-          resource: '/organization/test-org-id/v2/address-book/test-address-book-id/entry?page=1&pageSize=100',
+          resource:
+            '/organization/test-org-id/v2/address-book/test-address-book-id/entry?page=1&pageSize=100&sort=name%2CASC',
           service: 'wcc-api-gateway',
         },
       });

package/test/unit/spec/services/AnswerCallOnWebexService.ts

@@ -0,0 +1,264 @@
+import {expect} from '@jest/globals';
+import AnswerCallOnWebexService from '../../../../src/services/AnswerCallOnWebexService';
+import {WebexSDK} from '../../../../src/types';
+import LoggerProxy from '../../../../src/logger-proxy';
+
+jest.mock('../../../../src/logger-proxy');
+jest.mock('../../../../src/services/core/WebexRequest', () => ({
+  __esModule: true,
+  default: {
+    getInstance: () => ({uploadLogs: jest.fn()}),
+  },
+}));
+
+const TELEPHONY_BASE = 'https://api.ciscospark.com';
+const CALLS_URL = `${TELEPHONY_BASE}/telephony/calls`;
+
+function makeMockWebex(overrides: Partial<{_serviceUrls: Record<string, string>}> = {}): WebexSDK {
+  return {
+    request: jest.fn().mockResolvedValue({statusCode: 200, body: {}}),
+    internal: {
+      services: {
+        _serviceUrls: {hydra: TELEPHONY_BASE, ...overrides._serviceUrls},
+        get: jest.fn(),
+      },
+    },
+  } as unknown as WebexSDK;
+}
+
+describe('AnswerCallOnWebexService', () => {
+  let webex: WebexSDK;
+  let service: AnswerCallOnWebexService;
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    webex = makeMockWebex();
+    service = new AnswerCallOnWebexService(webex);
+  });
+
+  describe('getTelephonyBaseUrl resolution', () => {
+    it('uses hydra URL from _serviceUrls when available', async () => {
+      await service.answerCall({callId: 'c1', endpointId: 'e1'});
+
+      expect(webex.request).toHaveBeenCalledWith(
+        expect.objectContaining({uri: `${CALLS_URL}/answer`})
+      );
+    });
+
+    it('falls back to services.get("hydra") when _serviceUrls.hydra is missing', async () => {
+      const hydraBase = 'https://api.ciscospark.com/v1';
+      const get = jest.fn().mockReturnValue(hydraBase);
+      webex = {
+        request: jest.fn().mockResolvedValue({statusCode: 200, body: {}}),
+        internal: {
+          services: {
+            _serviceUrls: {},
+            get,
+          },
+        },
+      } as unknown as WebexSDK;
+      service = new AnswerCallOnWebexService(webex);
+
+      await service.answerCall({callId: 'c1', endpointId: 'e1'});
+
+      expect(get).toHaveBeenCalledWith('hydra');
+      expect(webex.request).toHaveBeenCalledWith(
+        expect.objectContaining({uri: `${hydraBase}/telephony/calls/answer`})
+      );
+    });
+
+    it('throws when hydra URL is unavailable', async () => {
+      webex = {
+        request: jest.fn(),
+        internal: {
+          services: {
+            _serviceUrls: {},
+            get: jest.fn().mockReturnValue(''),
+          },
+        },
+      } as unknown as WebexSDK;
+      service = new AnswerCallOnWebexService(webex);
+
+      await expect(service.answerCall({callId: 'c1', endpointId: 'e1'})).rejects.toBeDefined();
+    });
+  });
+
+  describe('answerCall', () => {
+    it('POST /answer with callId and endpointId', async () => {
+      await service.answerCall({callId: 'call-123', endpointId: 'ep-456'});
+
+      expect(webex.request).toHaveBeenCalledWith({
+        uri: `${CALLS_URL}/answer`,
+        method: 'POST',
+        body: {callId: 'call-123', endpointId: 'ep-456'},
+        addAuthHeader: true,
+      });
+    });
+
+    it('includes lineOwnerId when provided', async () => {
+      await service.answerCall({callId: 'c1', endpointId: 'e1', lineOwnerId: 'lo-1'});
+
+      expect(webex.request).toHaveBeenCalledWith(
+        expect.objectContaining({body: {callId: 'c1', endpointId: 'e1', lineOwnerId: 'lo-1'}})
+      );
+    });
+
+    it('omits lineOwnerId when not provided', async () => {
+      await service.answerCall({callId: 'c1', endpointId: 'e1'});
+
+      const call = (webex.request as jest.Mock).mock.calls[0][0];
+      expect(call.body).not.toHaveProperty('lineOwnerId');
+    });
+
+    it('rejects and logs on request failure', async () => {
+      const err = {
+        statusCode: 400,
+        details: {
+          trackingId: 'track-wxapp-1',
+          data: {reason: 'TELEPHONY_ERROR'},
+        },
+      };
+      (webex.request as jest.Mock).mockRejectedValue(err);
+
+      await expect(service.answerCall({callId: 'c1', endpointId: 'e1'})).rejects.toMatchObject({
+        isWxAppTelephonyError: true,
+        message: 'TELEPHONY_ERROR',
+        trackingId: 'track-wxapp-1',
+        status: 400,
+      });
+      expect(LoggerProxy.error).toHaveBeenCalled();
+    });
+
+    it('preserves top-level trackingId on request failure', async () => {
+      const err = {
+        statusCode: 503,
+        trackingId: 'track-top-level-1',
+        message: 'Service unavailable',
+      };
+      (webex.request as jest.Mock).mockRejectedValue(err);
+
+      await expect(service.answerCall({callId: 'c1', endpointId: 'e1'})).rejects.toMatchObject({
+        isWxAppTelephonyError: true,
+        trackingId: 'track-top-level-1',
+        status: 503,
+      });
+      expect(LoggerProxy.error).toHaveBeenCalledWith(
+        expect.stringContaining('failed'),
+        expect.objectContaining({
+          data: expect.objectContaining({trackingId: 'track-top-level-1'}),
+        })
+      );
+    });
+  });
+
+  describe('rejectCall', () => {
+    it('POST /reject with callId', async () => {
+      await service.rejectCall({callId: 'call-123'});
+
+      expect(webex.request).toHaveBeenCalledWith({
+        uri: `${CALLS_URL}/reject`,
+        method: 'POST',
+        body: {callId: 'call-123'},
+        addAuthHeader: true,
+      });
+    });
+  });
+
+  describe('muteCall', () => {
+    it('POST /mute with callId', async () => {
+      await service.muteCall({callId: 'call-123'});
+
+      expect(webex.request).toHaveBeenCalledWith(
+        expect.objectContaining({uri: `${CALLS_URL}/mute`, body: {callId: 'call-123'}})
+      );
+    });
+  });
+
+  describe('unmuteCall', () => {
+    it('POST /unmute with callId', async () => {
+      await service.unmuteCall({callId: 'call-123'});
+
+      expect(webex.request).toHaveBeenCalledWith(
+        expect.objectContaining({uri: `${CALLS_URL}/unmute`, body: {callId: 'call-123'}})
+      );
+    });
+  });
+
+  describe('transmitDtmf', () => {
+    it('POST /transmitDtmf with callId and dtmf', async () => {
+      await service.transmitDtmf({callId: 'call-123', dtmf: '5'});
+
+      expect(webex.request).toHaveBeenCalledWith({
+        uri: `${CALLS_URL}/transmitDtmf`,
+        method: 'POST',
+        body: {callId: 'call-123', dtmf: '5'},
+        addAuthHeader: true,
+      });
+    });
+
+    it('includes lineOwnerId in DTMF request when provided', async () => {
+      await service.transmitDtmf({callId: 'c1', dtmf: '9', lineOwnerId: 'lo-1'});
+
+      expect(webex.request).toHaveBeenCalledWith(
+        expect.objectContaining({body: {callId: 'c1', dtmf: '9', lineOwnerId: 'lo-1'}})
+      );
+    });
+  });
+
+  describe('getCallDetails', () => {
+    it('GET /telephony/calls/{callId}', async () => {
+      (webex.request as jest.Mock).mockResolvedValue({body: {muted: true}});
+
+      const result = await service.getCallDetails({callId: 'call-123'});
+
+      expect(webex.request).toHaveBeenCalledWith({
+        uri: `${CALLS_URL}/call-123`,
+        method: 'GET',
+        addAuthHeader: true,
+      });
+      expect(result).toEqual({muted: true});
+    });
+
+    it('includes lineOwnerId query param when provided', async () => {
+      await service.getCallDetails({callId: 'call-123', lineOwnerId: 'lo-1'});
+
+      expect(webex.request).toHaveBeenCalledWith(
+        expect.objectContaining({uri: `${CALLS_URL}/call-123?lineOwnerId=lo-1`})
+      );
+    });
+
+    it('rejects and logs on request failure', async () => {
+      (webex.request as jest.Mock).mockRejectedValue(new Error('network fail'));
+
+      await expect(service.getCallDetails({callId: 'c1'})).rejects.toBeDefined();
+      expect(LoggerProxy.error).toHaveBeenCalled();
+    });
+
+    it('logs HTTP status on non-404 getCallDetails failure', async () => {
+      const err = {
+        statusCode: 503,
+        trackingId: 'track-top-level-1',
+        message: 'Service unavailable',
+      };
+      (webex.request as jest.Mock).mockRejectedValue(err);
+
+      await expect(service.getCallDetails({callId: 'c1'})).rejects.toBeDefined();
+      expect(LoggerProxy.error).toHaveBeenCalledWith(
+        expect.stringContaining('getCallDetails failed'),
+        expect.objectContaining({
+          data: expect.objectContaining({
+            trackingId: 'track-top-level-1',
+            status: 503,
+          }),
+        })
+      );
+    });
+
+    it('rejects without error log for expected call-not-found during mute backfill race', async () => {
+      (webex.request as jest.Mock).mockRejectedValue({status: 400, message: 'Call not found'});
+
+      await expect(service.getCallDetails({callId: 'c1'})).rejects.toBeDefined();
+      expect(LoggerProxy.error).not.toHaveBeenCalled();
+    });
+  });
+});