@tencentcloud/web-push 1.0.2 → 1.0.3

package/src/__tests__/integration.test.ts

@@ -0,0 +1,285 @@
+/**
+ * 集成测试 - 测试完整的工作流程
+ */
+import { WebPushSDK } from '../core/web-push-sdk';
+import { EVENT, RegisterPushOptions } from '../types';
+
+describe('WebPushSDK 集成测试', () => {
+  let webPushSDK: WebPushSDK;
+
+  beforeEach(() => {
+    // 重置单例
+    (WebPushSDK as unknown as { instance: undefined }).instance = undefined;
+    webPushSDK = WebPushSDK.getInstance();
+
+    jest.clearAllMocks();
+  });
+
+  describe('完整注册流程测试', () => {
+    const validOptions: RegisterPushOptions = {
+      SDKAppID: 123456,
+      appKey: 'test-app-key',
+      userID: 'test-user-id',
+    };
+
+    it('应该完成完整的注册流程', async () => {
+      const registrationID = await webPushSDK.registerPush(validOptions);
+
+      expect(registrationID).toBe(validOptions.userID);
+
+      // 验证注册成功
+      expect(registrationID).toBe(validOptions.userID);
+    });
+  });
+
+  describe('完整反注册流程测试', () => {
+    beforeEach(async () => {
+      // 先注册
+      await webPushSDK.registerPush({
+        SDKAppID: 123456,
+        appKey: 'test-app-key',
+        userID: 'test-user-id',
+      });
+      jest.clearAllMocks();
+    });
+
+    it('应该完成完整的反注册流程', async () => {
+      const result = await webPushSDK.unRegisterPush();
+
+      expect(result).toBe(true);
+    });
+  });
+
+  describe('事件监听器完整流程测试', () => {
+    it('应该正确处理消息接收事件', async () => {
+      const messageListener = jest.fn();
+
+      // 添加监听器
+      const listenerId = webPushSDK.addPushListener(
+        EVENT.MESSAGE_RECEIVED,
+        messageListener
+      );
+      expect(listenerId).toBeTruthy();
+
+      // 模拟消息接收（通过内部事件发射器）
+      const mockMessage = {
+        messageID: 'msg-123',
+        title: 'Test Message',
+        body: 'Test Body',
+        timestamp: Date.now(),
+      };
+
+      // 直接触发内部事件（模拟 Service Worker 消息）
+      (
+        webPushSDK as unknown as {
+          eventEmitter: { emit: (event: string, data: unknown) => void };
+        }
+      ).eventEmitter.emit(EVENT.MESSAGE_RECEIVED, mockMessage);
+
+      expect(messageListener).toHaveBeenCalledWith(mockMessage);
+
+      // 移除监听器
+      const removed = webPushSDK.removePushListener(
+        EVENT.MESSAGE_RECEIVED,
+        messageListener
+      );
+      expect(removed).toBe(true);
+
+      // 再次触发事件，监听器不应该被调用
+      (
+        webPushSDK as unknown as {
+          eventEmitter: { emit: (event: string, data: unknown) => void };
+        }
+      ).eventEmitter.emit(EVENT.MESSAGE_RECEIVED, mockMessage);
+      expect(messageListener).toHaveBeenCalledTimes(1);
+    });
+
+    it('应该正确处理通知点击事件', async () => {
+      const clickListener = jest.fn();
+
+      webPushSDK.addPushListener(EVENT.NOTIFICATION_CLICKED, clickListener);
+
+      const mockClickData = {
+        notification: {
+          messageID: 'msg-123',
+          title: 'Test Message',
+          body: 'Test Body',
+          timestamp: Date.now(),
+        },
+        action: 'default',
+      };
+
+      (
+        webPushSDK as unknown as {
+          eventEmitter: { emit: (event: string, data: unknown) => void };
+        }
+      ).eventEmitter.emit(EVENT.NOTIFICATION_CLICKED, mockClickData);
+
+      expect(clickListener).toHaveBeenCalledWith(mockClickData);
+    });
+
+    it('应该正确处理消息撤回事件', async () => {
+      const revokeListener = jest.fn();
+
+      webPushSDK.addPushListener(EVENT.MESSAGE_REVOKED, revokeListener);
+
+      const mockRevokeData = {
+        messageID: 'msg-123',
+      };
+
+      (
+        webPushSDK as unknown as {
+          eventEmitter: { emit: (event: string, data: unknown) => void };
+        }
+      ).eventEmitter.emit(EVENT.MESSAGE_REVOKED, mockRevokeData);
+
+      expect(revokeListener).toHaveBeenCalledWith(mockRevokeData);
+    });
+  });
+
+  describe('统计数据记录测试', () => {
+    let mockChatInstance: any;
+
+    beforeEach(async () => {
+      // 创建 mock chat 实例
+      mockChatInstance = {
+        callExperimentalAPI: jest.fn().mockResolvedValue({ code: 0 }),
+        destroy: jest.fn(),
+      };
+
+      // 先注册以设置必要的状态，传入 chat 实例
+      await webPushSDK.registerPush({
+        SDKAppID: 123456,
+        appKey: 'test-app-key',
+        userID: 'test-user-id',
+        chat: mockChatInstance, // 传入 mock chat 实例
+      });
+      jest.clearAllMocks();
+    });
+
+    it('应该在消息接收时记录统计数据', async () => {
+      const mockMessage = {
+        messageID: 'msg-123',
+        title: 'Test Message',
+        body: 'Test Body',
+        timestamp: Date.now(),
+      };
+
+      // Mock logger 模块
+      const { logger } = require('../utils/logger');
+      const logSpy = jest.spyOn(logger, 'log').mockImplementation();
+
+      // 触发消息接收事件
+      (
+        webPushSDK as unknown as {
+          eventEmitter: { emit: (event: string, data: unknown) => void };
+        }
+      ).eventEmitter.emit(EVENT.MESSAGE_RECEIVED, mockMessage);
+
+      // 等待异步操作完成
+      await new Promise((resolve) => setTimeout(resolve, 0));
+
+      // 验证统计数据被记录到日志中
+      expect(logSpy).toHaveBeenCalledWith(
+        'Message reach statistics recorded',
+        expect.objectContaining({
+          messageID: 'msg-123',
+          type: 'reach',
+          timestamp: expect.any(Number),
+          SDKAppID: 123456,
+          registrationID: 'test-user-id',
+        })
+      );
+
+      logSpy.mockRestore();
+    });
+
+    it('应该在通知点击时记录统计数据', async () => {
+      const mockClickData = {
+        notification: {
+          messageID: 'msg-123',
+          title: 'Test Message',
+          body: 'Test Body',
+          timestamp: Date.now(),
+        },
+      };
+
+      // Mock logger 模块
+      const { logger } = require('../utils/logger');
+      const logSpy = jest.spyOn(logger, 'log').mockImplementation();
+
+      // 触发通知点击事件
+      (
+        webPushSDK as unknown as {
+          eventEmitter: { emit: (event: string, data: unknown) => void };
+        }
+      ).eventEmitter.emit(EVENT.NOTIFICATION_CLICKED, mockClickData);
+
+      // 等待异步操作完成
+      await new Promise((resolve) => setTimeout(resolve, 0));
+
+      // 验证统计数据被记录到日志中
+      expect(logSpy).toHaveBeenCalledWith(
+        'Message click statistics recorded',
+        expect.objectContaining({
+          messageID: 'msg-123',
+          type: 'click',
+          timestamp: expect.any(Number),
+          SDKAppID: 123456,
+          registrationID: 'test-user-id',
+        })
+      );
+
+      logSpy.mockRestore();
+    });
+  });
+
+  describe('状态持久化测试', () => {
+    it('应该在注册后保存状态', async () => {
+      await webPushSDK.registerPush({
+        SDKAppID: 123456,
+        appKey: 'test-app-key',
+        userID: 'test-user-id',
+      });
+
+      const { Storage } = require('../utils/storage');
+      expect(Storage.set).toHaveBeenCalledWith('sdk_state', {
+        isRegistered: true,
+        registrationID: 'test-user-id',
+        SDKAppID: 123456,
+        appKey: 'test-app-key',
+        vapidPublicKey: 'test-app-key',
+      });
+    });
+
+    it('应该在初始化时恢复状态', () => {
+      const { Storage } = require('../utils/storage');
+      Storage.get.mockReturnValue({
+        isRegistered: true,
+        registrationID: 'restored-user',
+        SDKAppID: 654321,
+        appKey: 'restored-key',
+        vapidPublicKey: 'restored-vapid',
+      });
+
+      // 创建新实例
+      (WebPushSDK as unknown as { instance: undefined }).instance = undefined;
+      WebPushSDK.getInstance();
+
+      expect(Storage.get).toHaveBeenCalledWith('sdk_state');
+    });
+
+    it('应该在反注册后清理状态', async () => {
+      await webPushSDK.registerPush({
+        SDKAppID: 123456,
+        appKey: 'test-app-key',
+        userID: 'test-user-id',
+      });
+
+      await webPushSDK.unRegisterPush();
+
+      const { Storage } = require('../utils/storage');
+      expect(Storage.remove).toHaveBeenCalledWith('sdk_state');
+    });
+  });
+});

package/src/__tests__/setup.ts

@@ -0,0 +1,210 @@
+/**
+ * Jest test environment setup file
+ * Executed before each test file runs
+ */
+
+// Setup global test environment
+Object.defineProperty(window, 'matchMedia', {
+  writable: true,
+  value: jest.fn().mockImplementation((query) => ({
+    matches: false,
+    media: query,
+    onchange: null,
+    addListener: jest.fn(), // deprecated
+    removeListener: jest.fn(), // deprecated
+    addEventListener: jest.fn(),
+    removeEventListener: jest.fn(),
+    dispatchEvent: jest.fn(),
+  })),
+});
+
+// Mock Service Worker API
+Object.defineProperty(window, 'navigator', {
+  writable: true,
+  value: {
+    ...window.navigator,
+    userAgent:
+      'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
+    platform: 'MacIntel',
+    language: 'en-US',
+    languages: ['en-US', 'en'],
+    serviceWorker: {
+      register: jest.fn().mockResolvedValue({
+        installing: null,
+        waiting: null,
+        active: null,
+        addEventListener: jest.fn(),
+        removeEventListener: jest.fn(),
+        update: jest.fn(),
+        unregister: jest.fn(),
+      }),
+      ready: Promise.resolve({
+        installing: null,
+        waiting: null,
+        active: null,
+        addEventListener: jest.fn(),
+        removeEventListener: jest.fn(),
+        update: jest.fn(),
+        unregister: jest.fn(),
+      }),
+      controller: null,
+      addEventListener: jest.fn(),
+      removeEventListener: jest.fn(),
+    },
+  },
+});
+
+// Mock ServiceWorkerManager globally
+jest.mock('../core/service-worker-manager', () => {
+  const mockServiceWorkerManager = {
+    register: jest.fn().mockResolvedValue(undefined),
+    getPushSubscription: jest.fn().mockResolvedValue({
+      subscription: {
+        endpoint: 'https://example.com/push',
+        keys: { auth: 'mock-auth', p256dh: 'mock-p256dh' },
+      },
+      token: 'mock-token',
+      auth: 'mock-auth',
+      p256dh: 'mock-p256dh',
+    }),
+    unsubscribe: jest.fn().mockResolvedValue(true),
+    unregister: jest.fn().mockResolvedValue(true),
+  };
+
+  return {
+    ServiceWorkerManager: {
+      getInstance: jest.fn().mockReturnValue(mockServiceWorkerManager),
+    },
+  };
+});
+
+// Mock browser support
+jest.mock('../utils/browser-support', () => ({
+  browserSupport: {
+    detectWebPushCapability: jest.fn().mockReturnValue({
+      supported: true,
+      browserName: 'Chrome',
+      browserVersion: '120.0.0',
+    }),
+    isWebPushSupported: jest.fn().mockReturnValue(true),
+    getUnsupportedReason: jest.fn().mockReturnValue(undefined),
+    checkNotificationPermission: jest.fn().mockResolvedValue('granted'),
+    requestNotificationPermission: jest.fn().mockResolvedValue('granted'),
+    requiresUserGesture: jest.fn().mockReturnValue(false),
+    handleBrowserSpecificError: jest
+      .fn()
+      .mockImplementation((error: Error) => error),
+    checkBrowserSupport: jest.fn().mockReturnValue(true),
+    getBrowserInfo: jest.fn().mockReturnValue({
+      name: 'Chrome',
+      version: '120.0.0',
+      majorVersion: 120,
+      platform: 'macOS',
+      userAgent: 'Chrome/120.0.0',
+    }),
+    getFeatureSupport: jest.fn().mockReturnValue({
+      serviceWorker: true,
+      pushManager: true,
+      notification: true,
+      webPush: true,
+    }),
+  },
+  // 导出便捷函数
+  getBrowserInfo: jest.fn().mockReturnValue({
+    name: 'Chrome',
+    version: '120.0.0',
+    majorVersion: 120,
+    platform: 'macOS',
+    userAgent: 'Chrome/120.0.0',
+  }),
+  getFeatureSupport: jest.fn().mockReturnValue({
+    serviceWorker: true,
+    pushManager: true,
+    notification: true,
+    webPush: true,
+  }),
+  detectWebPushCapability: jest.fn().mockReturnValue({
+    supported: true,
+    browserName: 'Chrome',
+    browserVersion: '120.0.0',
+  }),
+  isWebPushSupported: jest.fn().mockReturnValue(true),
+  getUnsupportedReason: jest.fn().mockReturnValue(undefined),
+}));
+
+jest.mock('../utils/storage', () => ({
+  Storage: {
+    set: jest.fn(),
+    get: jest.fn().mockReturnValue(null),
+    remove: jest.fn(),
+  },
+}));
+
+jest.mock('../utils/logger', () => ({
+  logger: {
+    log: jest.fn(),
+    warn: jest.fn(),
+    error: jest.fn(),
+    info: jest.fn(),
+  },
+}));
+
+// Mock TencentCloud Chat SDK
+const mockChatInstance = {
+  login: jest.fn().mockResolvedValue({ code: 0 }),
+  logout: jest.fn().mockResolvedValue({ code: 0 }),
+  on: jest.fn(),
+  off: jest.fn(),
+  destroy: jest.fn().mockResolvedValue({ code: 0 }),
+  callExperimentalAPI: jest.fn().mockResolvedValue({ code: 0 }),
+};
+
+const mockChatSDK = {
+  create: jest.fn().mockReturnValue(mockChatInstance),
+};
+
+jest.mock('@tencentcloud/lite-chat/basic', () => ({
+  __esModule: true,
+  default: mockChatSDK,
+}));
+
+// Mock genTestUserSig function
+jest.mock('../debug/lib-generate-test-usersig-es.min.js', () => ({
+  __esModule: true,
+  default: jest.fn().mockImplementation(() => ({
+    genTestUserSig: jest.fn().mockReturnValue('mock-user-sig'),
+  })),
+}));
+
+// Mock Notification API
+Object.defineProperty(window, 'Notification', {
+  writable: true,
+  value: class MockNotification {
+    static permission = 'default';
+    static requestPermission = jest.fn().mockResolvedValue('granted');
+
+    constructor(_title: string, _options?: NotificationOptions) {
+      // Mock notification instance
+    }
+
+    close = jest.fn();
+    addEventListener = jest.fn();
+    removeEventListener = jest.fn();
+  },
+});
+
+// Mock PushManager API
+Object.defineProperty(window, 'PushManager', {
+  writable: true,
+  value: {
+    supportedContentEncodings: ['aes128gcm'],
+  },
+});
+
+// Set test timeout
+jest.setTimeout(10000);
+
+// Cleanup after each test
+afterEach(() => {
+  jest.clearAllMocks();
+});