@webex/contact-center 3.11.0 → 3.12.0-auth-prejoin-fetch.1

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

@@ -0,0 +1,401 @@
+import {expect} from '@jest/globals';
+import UserPreference from '../../../../src/services/UserPreference';
+import {HTTP_METHODS, WebexSDK, IHttpResponse} from '../../../../src/types';
+import {METRIC_EVENT_NAMES} from '../../../../src/metrics/constants';
+import WebexRequest from '../../../../src/services/core/WebexRequest';
+import MetricsManager from '../../../../src/metrics/MetricsManager';
+import LoggerProxy from '../../../../src/logger-proxy';
+
+jest.mock('../../../../src/metrics/MetricsManager');
+jest.mock('../../../../src/logger-proxy');
+
+describe('UserPreference', () => {
+  let userPreferenceAPI: UserPreference;
+  let mockWebex: WebexSDK;
+  let mockMetricsManager: jest.Mocked<MetricsManager>;
+
+  const mockGetUserId = jest.fn().mockReturnValue('test-user-id');
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    (WebexRequest as any).instance = undefined;
+
+    mockWebex = {
+      credentials: {
+        getOrgId: jest.fn().mockReturnValue('test-org-id'),
+      },
+      request: jest.fn(),
+      internal: {
+        newMetrics: {
+          submitBehavioralEvent: jest.fn(),
+          submitOperationalEvent: jest.fn(),
+          submitBusinessEvent: jest.fn(),
+        },
+      },
+      ready: true,
+      once: jest.fn(),
+    } as unknown as WebexSDK;
+
+    mockMetricsManager = {
+      trackEvent: jest.fn(),
+      timeEvent: jest.fn(),
+    } as unknown as jest.Mocked<MetricsManager>;
+    (MetricsManager.getInstance as jest.Mock).mockReturnValue(mockMetricsManager);
+
+    userPreferenceAPI = new UserPreference(mockWebex, mockGetUserId);
+  });
+
+  describe('constructor', () => {
+    it('should initialize with all required dependencies', () => {
+      expect(WebexRequest.getInstance({webex: mockWebex})).toBeDefined();
+      expect(MetricsManager.getInstance).toHaveBeenCalledWith({webex: mockWebex});
+    });
+  });
+
+  describe('getUserPreference', () => {
+    const mockPreference = {
+      id: 'pref-123',
+      organizationId: 'test-org-id',
+      userId: 'test-user-id',
+      preferences: {e911Reminder: true},
+      createdTime: 1234567890,
+      lastUpdatedTime: 1234567890,
+    };
+
+    const mockResponse: IHttpResponse = {
+      statusCode: 200,
+      method: 'GET',
+      url: '/organization/test-org-id/user-preference/test-user-id',
+      headers: {} as any,
+      body: mockPreference,
+    };
+
+    beforeEach(() => {
+      jest.spyOn(Date, 'now').mockReturnValue(1000);
+    });
+
+    afterEach(() => {
+      jest.restoreAllMocks();
+    });
+
+    it('should fetch user preferences successfully with default userId', async () => {
+      (mockWebex.request as jest.Mock).mockResolvedValue(mockResponse);
+
+      const result = await userPreferenceAPI.getUserPreference();
+
+      expect(mockWebex.request).toHaveBeenCalledWith({
+        service: 'wcc-api-gateway',
+        resource: 'organization/test-org-id/user-preference/test-user-id',
+        method: HTTP_METHODS.GET,
+        body: undefined,
+      });
+      expect(result).toEqual(mockPreference);
+      expect(mockMetricsManager.timeEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_GET_SUCCESS
+      );
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_GET_SUCCESS,
+        expect.objectContaining({
+          orgId: 'test-org-id',
+          userId: 'test-user-id',
+          statusCode: 200,
+        }),
+        ['behavioral', 'operational']
+      );
+    });
+
+    it('should fetch user preferences for a specific userId', async () => {
+      (mockWebex.request as jest.Mock).mockResolvedValue(mockResponse);
+
+      const result = await userPreferenceAPI.getUserPreference({userId: 'specific-user-id'});
+
+      expect(mockWebex.request).toHaveBeenCalledWith({
+        service: 'wcc-api-gateway',
+        resource: 'organization/test-org-id/user-preference/specific-user-id',
+        method: HTTP_METHODS.GET,
+        body: undefined,
+      });
+      expect(result).toEqual(mockPreference);
+    });
+
+    it('should fetch user preferences with pagination parameters', async () => {
+      (mockWebex.request as jest.Mock).mockResolvedValue(mockResponse);
+
+      const result = await userPreferenceAPI.getUserPreference({page: 1, pageSize: 50});
+
+      expect(mockWebex.request).toHaveBeenCalledWith({
+        service: 'wcc-api-gateway',
+        resource: 'organization/test-org-id/user-preference/test-user-id?page=1&pageSize=50',
+        method: HTTP_METHODS.GET,
+        body: undefined,
+      });
+      expect(result).toEqual(mockPreference);
+    });
+
+    it('should throw error when userId is not available', async () => {
+      mockGetUserId.mockReturnValueOnce('');
+
+      await expect(userPreferenceAPI.getUserPreference()).rejects.toThrow(
+        'UserPreference: userId is not available.'
+      );
+
+      expect(mockMetricsManager.trackEvent).not.toHaveBeenCalled();
+    });
+
+    it('should handle API errors', async () => {
+      const mockError = new Error('API call failed');
+      (mockWebex.request as jest.Mock).mockRejectedValue(mockError);
+
+      await expect(userPreferenceAPI.getUserPreference()).rejects.toThrow('API call failed');
+
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_GET_FAILED,
+        expect.objectContaining({
+          error: 'API call failed',
+        }),
+        ['behavioral', 'operational']
+      );
+    });
+  });
+
+  describe('createUserPreference', () => {
+    const mockCreateRequest = {
+      userId: 'test-user-id',
+      desktopPreference: '{}',
+    };
+
+    const mockCreatedPreference = {
+      id: 'pref-123',
+      organizationId: 'test-org-id',
+      userId: 'test-user-id',
+      preferences: {e911Reminder: true},
+      createdTime: 1234567890,
+      lastUpdatedTime: 1234567890,
+    };
+
+    const mockResponse: IHttpResponse = {
+      statusCode: 201,
+      method: 'POST',
+      url: '/organization/test-org-id/user-preference',
+      headers: {} as any,
+      body: mockCreatedPreference,
+    };
+
+    beforeEach(() => {
+      jest.spyOn(Date, 'now').mockReturnValue(1000);
+    });
+
+    afterEach(() => {
+      jest.restoreAllMocks();
+    });
+
+    it('should create user preferences successfully', async () => {
+      (mockWebex.request as jest.Mock).mockResolvedValue(mockResponse);
+
+      const result = await userPreferenceAPI.createUserPreference(mockCreateRequest);
+
+      expect(mockWebex.request).toHaveBeenCalledWith({
+        service: 'wcc-api-gateway',
+        resource: 'organization/test-org-id/user-preference',
+        method: HTTP_METHODS.POST,
+        body: mockCreateRequest,
+      });
+      expect(result).toEqual(mockCreatedPreference);
+      expect(mockMetricsManager.timeEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_CREATE_SUCCESS
+      );
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_CREATE_SUCCESS,
+        expect.objectContaining({
+          orgId: 'test-org-id',
+          userId: 'test-user-id',
+          statusCode: 201,
+        }),
+        ['behavioral', 'operational']
+      );
+    });
+
+    it('should throw error when userId is missing in request', async () => {
+      const invalidRequest = {
+        userId: '',
+        desktopPreference: '{}',
+      };
+
+      await expect(userPreferenceAPI.createUserPreference(invalidRequest)).rejects.toThrow(
+        'UserPreference: userId is required to create user preferences.'
+      );
+
+      expect(mockMetricsManager.trackEvent).not.toHaveBeenCalled();
+    });
+
+    it('should handle API errors', async () => {
+      const mockError = new Error('API call failed');
+      (mockWebex.request as jest.Mock).mockRejectedValue(mockError);
+
+      await expect(userPreferenceAPI.createUserPreference(mockCreateRequest)).rejects.toThrow(
+        'API call failed'
+      );
+
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_CREATE_FAILED,
+        expect.objectContaining({
+          error: 'API call failed',
+        }),
+        ['behavioral', 'operational']
+      );
+    });
+  });
+
+  describe('updateUserPreference', () => {
+    const mockUpdateRequest = {
+      desktopPreference: '{}',
+    };
+
+    const mockUpdatedPreference = {
+      id: 'pref-123',
+      organizationId: 'test-org-id',
+      userId: 'test-user-id',
+      preferences: {e911Reminder: false},
+      createdTime: 1234567890,
+      lastUpdatedTime: 1234567899,
+    };
+
+    const mockResponse: IHttpResponse = {
+      statusCode: 200,
+      method: 'PUT',
+      url: '/organization/test-org-id/user-preference/test-user-id',
+      headers: {} as any,
+      body: mockUpdatedPreference,
+    };
+
+    beforeEach(() => {
+      jest.spyOn(Date, 'now').mockReturnValue(1000);
+    });
+
+    afterEach(() => {
+      jest.restoreAllMocks();
+    });
+
+    it('should update user preferences successfully', async () => {
+      (mockWebex.request as jest.Mock).mockResolvedValue(mockResponse);
+
+      const result = await userPreferenceAPI.updateUserPreference(
+        'test-user-id',
+        mockUpdateRequest
+      );
+
+      expect(mockWebex.request).toHaveBeenCalledWith({
+        service: 'wcc-api-gateway',
+        resource: 'organization/test-org-id/user-preference/test-user-id',
+        method: HTTP_METHODS.PUT,
+        body: mockUpdateRequest,
+      });
+      expect(result).toEqual(mockUpdatedPreference);
+      expect(mockMetricsManager.timeEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_UPDATE_SUCCESS
+      );
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_UPDATE_SUCCESS,
+        expect.objectContaining({
+          orgId: 'test-org-id',
+          userId: 'test-user-id',
+          statusCode: 200,
+        }),
+        ['behavioral', 'operational']
+      );
+    });
+
+    it('should throw error when userId is missing', async () => {
+      await expect(userPreferenceAPI.updateUserPreference('', mockUpdateRequest)).rejects.toThrow(
+        'UserPreference: userId is required to update user preferences.'
+      );
+
+      expect(mockMetricsManager.trackEvent).not.toHaveBeenCalled();
+    });
+
+    it('should handle API errors', async () => {
+      const mockError = new Error('API call failed');
+      (mockWebex.request as jest.Mock).mockRejectedValue(mockError);
+
+      await expect(
+        userPreferenceAPI.updateUserPreference('test-user-id', mockUpdateRequest)
+      ).rejects.toThrow('API call failed');
+
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_UPDATE_FAILED,
+        expect.objectContaining({
+          error: 'API call failed',
+        }),
+        ['behavioral', 'operational']
+      );
+    });
+  });
+
+  describe('deleteUserPreference', () => {
+    const mockResponse: IHttpResponse = {
+      statusCode: 204,
+      method: 'DELETE',
+      url: '/organization/test-org-id/user-preference/test-user-id',
+      headers: {} as any,
+      body: null,
+    };
+
+    beforeEach(() => {
+      jest.spyOn(Date, 'now').mockReturnValue(1000);
+    });
+
+    afterEach(() => {
+      jest.restoreAllMocks();
+    });
+
+    it('should delete user preferences successfully', async () => {
+      (mockWebex.request as jest.Mock).mockResolvedValue(mockResponse);
+
+      await userPreferenceAPI.deleteUserPreference('test-user-id');
+
+      expect(mockWebex.request).toHaveBeenCalledWith({
+        service: 'wcc-api-gateway',
+        resource: 'organization/test-org-id/user-preference/test-user-id',
+        method: HTTP_METHODS.DELETE,
+        body: undefined,
+      });
+      expect(mockMetricsManager.timeEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_DELETE_SUCCESS
+      );
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_DELETE_SUCCESS,
+        expect.objectContaining({
+          orgId: 'test-org-id',
+          userId: 'test-user-id',
+          statusCode: 204,
+        }),
+        ['behavioral', 'operational']
+      );
+    });
+
+    it('should throw error when userId is missing', async () => {
+      await expect(userPreferenceAPI.deleteUserPreference('')).rejects.toThrow(
+        'UserPreference: userId is required to delete user preferences.'
+      );
+
+      expect(mockMetricsManager.trackEvent).not.toHaveBeenCalled();
+    });
+
+    it('should handle API errors', async () => {
+      const mockError = new Error('API call failed');
+      (mockWebex.request as jest.Mock).mockRejectedValue(mockError);
+
+      await expect(userPreferenceAPI.deleteUserPreference('test-user-id')).rejects.toThrow(
+        'API call failed'
+      );
+
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_DELETE_FAILED,
+        expect.objectContaining({
+          error: 'API call failed',
+        }),
+        ['behavioral', 'operational']
+      );
+    });
+  });
+});

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

@@ -200,11 +200,17 @@ describe('WebCallingService', () => {
 
     it('should reject if registration times out', async () => {
       line = callingClient.getLines().line1 as ILine;
+      jest.spyOn(global, 'setTimeout').mockImplementation(((handler: TimerHandler) => {
+        if (typeof handler === 'function') {
+          handler();
+        }
+        return 0 as unknown as NodeJS.Timeout;
+      }) as typeof setTimeout);
 
       const promise = webRTCCalling.registerWebCallingLine();
 
       await expect(promise).rejects.toThrow('WebCallingService Registration timed out');
-    }, 20003); // Increased timeout to 20 seconds
+    });
 
     it('should handle incoming calls', async () => {
       line = callingClient.getLines().line1 as ILine;

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

@@ -0,0 +1,261 @@
+import WebexCrossClientService from '../../../../src/services/WebexCrossClientService';
+
+describe('WebexCrossClientService', () => {
+  const userId = 'user-123';
+  const deviceUrl = 'https://wdm.example.com/devices/device-abc';
+
+  let webex: {request: jest.Mock; internal: {device: {userId: string; url: string}}};
+  let service: WebexCrossClientService;
+
+  beforeEach(() => {
+    webex = {
+      request: jest.fn().mockResolvedValue({body: {}}),
+      internal: {
+        device: {userId, url: deviceUrl},
+      },
+    };
+    service = new WebexCrossClientService(webex as never);
+  });
+
+  afterEach(() => {
+    service.teardown();
+  });
+
+  it('publishes usersub with appName wxcc (Agent Desktop parity)', async () => {
+    await service.setManageWebexCallingInWxcc(true);
+
+    expect(webex.request).toHaveBeenCalledWith(
+      expect.objectContaining({
+        method: 'POST',
+        service: 'usersub',
+        resource: 'publish',
+        body: expect.objectContaining({
+          users: [userId],
+          compositions: [
+            expect.objectContaining({
+              type: 'cross-client-state',
+              ttl: 900,
+              composition: {
+                devices: [
+                  {
+                    deviceId: 'device-abc',
+                    appName: 'wxcc',
+                    state: {'answer-calls-on-wxcc': true},
+                  },
+                ],
+              },
+            }),
+          ],
+        }),
+      })
+    );
+  });
+
+  it('publishes false when suppression is disabled', async () => {
+    await service.setManageWebexCallingInWxcc(false);
+
+    expect(webex.request).toHaveBeenCalledWith(
+      expect.objectContaining({
+        body: expect.objectContaining({
+          compositions: [
+            expect.objectContaining({
+              composition: {
+                devices: [
+                  {
+                    deviceId: 'device-abc',
+                    appName: 'wxcc',
+                    state: {'answer-calls-on-wxcc': false},
+                  },
+                ],
+              },
+            }),
+          ],
+        }),
+      })
+    );
+  });
+
+  it('throws when user ID is unavailable', async () => {
+    webex.internal.device.userId = undefined as unknown as string;
+
+    await expect(service.setManageWebexCallingInWxcc(true)).rejects.toThrow(
+      'User ID is unavailable for cross-client publish'
+    );
+    expect(webex.request).not.toHaveBeenCalled();
+  });
+
+  it('throws when device URL is unavailable', async () => {
+    webex.internal.device.url = undefined as unknown as string;
+
+    await expect(service.setManageWebexCallingInWxcc(true)).rejects.toThrow(
+      'Device URL is unavailable for cross-client publish'
+    );
+    expect(webex.request).not.toHaveBeenCalled();
+  });
+
+  it('rejects when usersub publish fails', async () => {
+    const err = new Error('usersub failed');
+    webex.request = jest.fn().mockRejectedValue(err);
+
+    await expect(service.setManageWebexCallingInWxcc(true)).rejects.toThrow('usersub failed');
+  });
+
+  it('uses custom ttl from options', async () => {
+    await service.setManageWebexCallingInWxcc(true, {ttl: 1200});
+
+    expect(webex.request).toHaveBeenCalledWith(
+      expect.objectContaining({
+        body: expect.objectContaining({
+          compositions: [expect.objectContaining({ttl: 1200})],
+        }),
+      })
+    );
+  });
+
+  it('refreshes publish before ttl expiry while enabled', async () => {
+    jest.useFakeTimers();
+    try {
+      await service.setManageWebexCallingInWxcc(true, {ttl: 900});
+      expect(webex.request).toHaveBeenCalledTimes(1);
+
+      jest.advanceTimersByTime(840_000);
+
+      await Promise.resolve();
+
+      expect(webex.request).toHaveBeenCalledTimes(2);
+      expect(webex.request).toHaveBeenLastCalledWith(
+        expect.objectContaining({
+          body: expect.objectContaining({
+            compositions: [
+              expect.objectContaining({
+                composition: {
+                  devices: [
+                    {
+                      deviceId: 'device-abc',
+                      appName: 'wxcc',
+                      state: {'answer-calls-on-wxcc': true},
+                    },
+                  ],
+                },
+              }),
+            ],
+          }),
+        })
+      );
+    } finally {
+      jest.useRealTimers();
+    }
+  });
+
+  it('retries failed refresh publish before ttl expiry', async () => {
+    jest.useFakeTimers();
+    try {
+      const setManageSpy = jest.spyOn(service, 'setManageWebexCallingInWxcc');
+      webex.request = jest
+        .fn()
+        .mockResolvedValueOnce({body: {}})
+        .mockRejectedValueOnce(new Error('refresh failed'))
+        .mockResolvedValueOnce({body: {}});
+
+      await service.setManageWebexCallingInWxcc(true, {ttl: 900});
+      expect(webex.request).toHaveBeenCalledTimes(1);
+
+      jest.advanceTimersByTime(840_000);
+      await expect(setManageSpy.mock.results[1].value).rejects.toThrow('refresh failed');
+      expect(webex.request).toHaveBeenCalledTimes(2);
+
+      jest.advanceTimersByTime(30_000);
+      await setManageSpy.mock.results[2].value;
+
+      expect(webex.request).toHaveBeenCalledTimes(3);
+    } finally {
+      jest.useRealTimers();
+    }
+  });
+
+  it('schedules bounded retry when scheduled refresh publish fails', async () => {
+    jest.useFakeTimers();
+    try {
+      const setManageSpy = jest.spyOn(service, 'setManageWebexCallingInWxcc');
+      webex.request = jest
+        .fn()
+        .mockResolvedValueOnce({body: {}})
+        .mockRejectedValueOnce(new Error('refresh failed'));
+
+      await service.setManageWebexCallingInWxcc(true, {ttl: 900});
+      const scheduleRefreshRetrySpy = jest.spyOn(service as any, 'scheduleRefreshRetry');
+
+      jest.advanceTimersByTime(840_000);
+      await expect(setManageSpy.mock.results[1].value).rejects.toThrow('refresh failed');
+      expect(scheduleRefreshRetrySpy).toHaveBeenCalledWith(userId, 900, 0, 0);
+    } finally {
+      jest.useRealTimers();
+    }
+  });
+
+  it('does not retry refresh after teardown bumps generation', async () => {
+    jest.useFakeTimers();
+    try {
+      const setManageSpy = jest.spyOn(service, 'setManageWebexCallingInWxcc');
+      webex.request = jest
+        .fn()
+        .mockResolvedValueOnce({body: {}})
+        .mockRejectedValueOnce(new Error('refresh failed'));
+
+      await service.setManageWebexCallingInWxcc(true, {ttl: 900});
+
+      jest.advanceTimersByTime(840_000);
+      await expect(setManageSpy.mock.results[1].value).rejects.toThrow('refresh failed');
+
+      service.teardown();
+
+      jest.advanceTimersByTime(30_000);
+      await Promise.resolve();
+
+      expect(webex.request).toHaveBeenCalledTimes(2);
+    } finally {
+      jest.useRealTimers();
+    }
+  });
+
+  it('teardown clears refresh timer so publish is not repeated', async () => {
+    jest.useFakeTimers();
+    try {
+      await service.setManageWebexCallingInWxcc(true, {ttl: 900});
+      service.teardown();
+
+      jest.advanceTimersByTime(840_000);
+      await Promise.resolve();
+
+      expect(webex.request).toHaveBeenCalledTimes(1);
+    } finally {
+      jest.useRealTimers();
+    }
+  });
+
+  it('does not schedule refresh when disabled', async () => {
+    jest.useFakeTimers();
+    try {
+      await service.setManageWebexCallingInWxcc(false);
+
+      jest.advanceTimersByTime(840_000);
+      await Promise.resolve();
+
+      expect(webex.request).toHaveBeenCalledTimes(1);
+    } finally {
+      jest.useRealTimers();
+    }
+  });
+
+  it('reports whether answer-calls-on-wxcc true was published', async () => {
+    expect(service.isAnswerCallsStateActive()).toBe(false);
+
+    await service.setManageWebexCallingInWxcc(true);
+
+    expect(service.isAnswerCallsStateActive()).toBe(true);
+
+    await service.setManageWebexCallingInWxcc(false);
+
+    expect(service.isAnswerCallsStateActive()).toBe(false);
+  });
+});