@thejrsoft/subway-protocol 1.4.14 → 1.6.0

package/src/__tests__/protocol.test.ts

@@ -1,297 +0,0 @@
-/**
- * 协议规范测试套件
- * 验证实现是否符合 PROTOCOL_SPECIFICATION.md
- */
-
-import {
-  MessageFactory,
-  MessageValidator,
-  MessageType,
-  ClientType,
-  Priority,
-  OperationType,
-  CommandType,
-  GatewayUtils,
-  GATEWAY_SITE_ID,
-  isRegisterMessage,
-  isCommandMessage
-} from '../index';
-
-describe('JRSoft Subway Protocol v1.0', () => {
-  describe('基础消息格式', () => {
-    test('所有消息必须包含 type 字段', () => {
-      const message = { type: 'register', clientId: 'test' };
-      expect(MessageValidator.validateMessage(message)).toBe(true);
-      
-      const invalidMessage = { clientId: 'test' };
-      expect(MessageValidator.validateMessage(invalidMessage)).toBe(false);
-    });
-
-    test('timestamp 和 version 字段是可选的', () => {
-      const minimalMessage = { type: 'register', clientId: 'test' };
-      expect(MessageValidator.validateRegisterMessage(minimalMessage)).toBe(true);
-      
-      const fullMessage = {
-        type: 'register',
-        clientId: 'test',
-        timestamp: new Date().toISOString(),
-        version: '1.0'
-      };
-      expect(MessageValidator.validateRegisterMessage(fullMessage)).toBe(true);
-    });
-  });
-
-  describe('注册消息兼容性', () => {
-    test('支持简单注册格式（v1.0）', () => {
-      const simpleRegister = {
-        type: 'register',
-        clientId: 'device001'
-      };
-      
-      expect(isRegisterMessage(simpleRegister)).toBe(true);
-      expect(MessageValidator.validateRegisterMessage(simpleRegister)).toBe(true);
-    });
-
-    test('支持完整注册格式（v1.0）', () => {
-      const fullRegister = MessageFactory.createRegisterMessage(
-        'backend-server',
-        ClientType.BACKEND,
-        {
-          version: '1.0.0',
-          platform: 'nodejs',
-          capabilities: ['command', 'program']
-        }
-      );
-      
-      expect(isRegisterMessage(fullRegister)).toBe(true);
-      expect(MessageValidator.validateRegisterMessage(fullRegister)).toBe(true);
-      expect(fullRegister.clientType).toBe(ClientType.BACKEND);
-      expect(fullRegister.clientInfo?.capabilities).toContain('command');
-    });
-  });
-
-  describe('命令消息格式', () => {
-    test('标准命令消息', () => {
-      const command = MessageFactory.createCommandMessage(
-        'req-123',
-        'device001',
-        {
-          commandType: CommandType.SIMPLE,
-          commandCode: 'READ_STATUS',
-          deviceType: 'controller',
-          operationType: OperationType.READ,
-          parameters: {}
-        },
-        'http://callback.example.com/response'
-      );
-      
-      expect(isCommandMessage(command)).toBe(true);
-      expect(MessageValidator.validateCommandMessage(command)).toBe(true);
-      expect(command.priority).toBe(Priority.NORMAL);
-      expect(command.timeout).toBe(10000);
-    });
-
-    test('高优先级命令', () => {
-      const command = MessageFactory.createCommandMessage(
-        'req-urgent',
-        'device001',
-        {
-          commandType: CommandType.SIMPLE,
-          commandCode: 'EMERGENCY_STOP',
-          deviceType: 'controller',
-          operationType: OperationType.WRITE,
-          parameters: {}
-        },
-        'http://callback.example.com/response',
-        {
-          priority: Priority.CRITICAL,
-          timeout: 5000
-        }
-      );
-      
-      expect(command.priority).toBe(Priority.CRITICAL);
-      expect(command.timeout).toBe(5000);
-    });
-  });
-
-  describe('Gateway 特殊命令', () => {
-    test('查询设备状态命令', () => {
-      const query = GatewayUtils.createDeviceStatusQuery('device001', 'query-001');
-      
-      expect(query.targetClientId).toBe(GATEWAY_SITE_ID);
-      expect(query.command.commandCode).toBe('GET_DEVICE_STATUS');
-      expect(query.command.operationType).toBe('read');
-      expect(query.command.parameters.targetClientId).toBe('device001');
-      expect(GatewayUtils.isGatewayCommand(query)).toBe(true);
-    });
-
-    test('列出设备命令', () => {
-      const listCmd = GatewayUtils.createListDevicesCommand({
-        status: 'online',
-        clientType: 'device'
-      });
-      
-      expect(listCmd.clientId).toBe(GATEWAY_SITE_ID);
-      expect(listCmd.command.commandCode).toBe('LIST_DEVICES');
-      expect(listCmd.command.parameters.filter).toEqual({
-        status: 'online',
-        clientType: 'device'
-      });
-    });
-
-
-    test('命令链', () => {
-      const chainCmd = GatewayUtils.createCommandChain(
-        'device001',
-        [
-          { commandCode: 'STOP', parameters: {} },
-          { commandCode: 'RESET', parameters: {}, delay: 1000 },
-          { commandCode: 'START', parameters: {} }
-        ]
-      );
-      
-      expect(chainCmd.commandChain).toHaveLength(3);
-      expect(chainCmd.commandChain![1].delay).toBe(1000);
-      expect(chainCmd.timeout).toBeGreaterThan(30000); // 默认超时应考虑延迟
-    });
-  });
-
-  describe('消息签名', () => {
-    test('签名消息', () => {
-      const message = { type: 'command', requestRef: 'test', clientId: 'test' };
-      const signedMessage = GatewayUtils.signMessage(message, 'secret-key');
-      
-      expect(signedMessage.signature).toBeDefined();
-      expect(signedMessage.signatureMethod).toBe('sha256');
-    });
-
-    test('验证签名', () => {
-      const message = { type: 'command', requestRef: 'test', clientId: 'test' };
-      const signedMessage = GatewayUtils.signMessage(message, 'secret-key');
-      
-      const isValid = GatewayUtils.verifyMessageSignature(signedMessage, 'secret-key');
-      expect(isValid).toBe(true);
-    });
-  });
-
-  describe('心跳消息', () => {
-    test('创建心跳消息', () => {
-      const heartbeat = MessageFactory.createHeartbeatMessage('device001', 12345);
-      
-      expect(heartbeat.type).toBe(MessageType.HEARTBEAT);
-      expect(heartbeat.clientId).toBe('device001');
-      expect(heartbeat.sequence).toBe(12345);
-      expect(heartbeat.timestamp).toBeDefined();
-    });
-  });
-
-  describe('错误处理', () => {
-    test('创建错误消息', () => {
-      const error = MessageFactory.createErrorMessage(
-        'DEVICE_OFFLINE',
-        'Target device is not connected',
-        'medium',
-        'device',
-        {
-          context: {
-            clientId: 'device001',
-            requestRef: 'req-123'
-          },
-          retryable: true
-        }
-      );
-      
-      expect(error.type).toBe(MessageType.ERROR);
-      expect(error.code).toBe('DEVICE_OFFLINE');
-      expect(error.retryable).toBe(true);
-      expect(error.context?.clientId).toBe('device001');
-    });
-  });
-
-  describe('程序上传', () => {
-    test('创建程序上传消息', () => {
-      const program = MessageFactory.createProgramMessage(
-        'prog-123',
-        'device001',
-        {
-          device_id: 'device001',
-          programId: 'prog-v1.0.1',
-          downloadUrl: 'https://example.com/program.zip',
-          checksum: 'sha256:abcd1234',
-          hashAlgorithm: 'sha256'
-        }
-      );
-      
-      expect(program.type).toBe(MessageType.PROGRAM);
-      expect(program.command.commandCode).toBe('UPLOAD_PROGRAM');
-      expect(program.command.operationType).toBe('write');
-      expect(program.timeout).toBe(1800000); // 30分钟
-    });
-  });
-
-  describe('协议版本兼容性', () => {
-    test('消息类型支持字符串和枚举', () => {
-      const stringType = { type: 'register', clientId: 'test' };
-      const enumType = { type: MessageType.REGISTER, clientId: 'test' };
-      
-      expect(isRegisterMessage(stringType)).toBe(true);
-      expect(isRegisterMessage(enumType)).toBe(true);
-    });
-
-    test('字段名兼容性（device_id vs deviceId）', () => {
-      const oldFormat = {
-        device_id: 'device001',
-        programId: 'test'
-      };
-      
-      const newFormat = {
-        deviceId: 'device001',
-        programId: 'test'
-      };
-      
-      // 两种格式都应该被接受
-      expect(oldFormat.device_id || oldFormat.deviceId).toBe('device001');
-      expect(newFormat.deviceId || newFormat.device_id).toBe('device001');
-    });
-  });
-});
-
-describe('协议设计原则验证', () => {
-  test('简单性优先 - 最小注册消息只需2个字段', () => {
-    const minimalRegister = {
-      type: 'register',
-      clientId: 'device001'
-    };
-    
-    const keys = Object.keys(minimalRegister);
-    expect(keys).toHaveLength(2);
-    expect(MessageValidator.validateRegisterMessage(minimalRegister)).toBe(true);
-  });
-
-  test('渐进增强 - 可选字段不影响基础功能', () => {
-    const basic = { type: 'register', clientId: 'test' };
-    const enhanced = {
-      ...basic,
-      clientType: 'device',
-      clientInfo: { version: '1.0' },
-      timestamp: new Date().toISOString(),
-      version: '2.0'
-    };
-    
-    // 两种格式都有效
-    expect(MessageValidator.validateRegisterMessage(basic)).toBe(true);
-    expect(MessageValidator.validateRegisterMessage(enhanced)).toBe(true);
-  });
-
-  test('明确语义 - 每个消息类型有唯一用途', () => {
-    const messageTypes = Object.values(MessageType);
-    const uniqueTypes = new Set(messageTypes);
-    
-    // 没有重复的消息类型
-    expect(uniqueTypes.size).toBe(messageTypes.length);
-    
-    // 每个类型都有明确的用途
-    expect(MessageType.REGISTER).not.toBe(MessageType.COMMAND);
-    expect(MessageType.HEARTBEAT).not.toBe(MessageType.PROGRAM);
-  });
-});