mattiashz/vice-mcp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix packet header: request ID is 4 bytes, not 1 byte

Browse source 
Command header: STX(1) + API(1) + Length(4) + ReqID(4) + Cmd(1) = 11 bytes
Response header: STX(1) + API(1) + Length(4) + Type(1) + Err(1) + ReqID(4) = 12 bytes

Async events use ReqID=0xffffffff (not 0xff).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Simen Svale 2025-12-30 03:35:36 +01:00
parent aacdf7bbb2
commit 18b976adb8
1 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
src/protocol/client.ts
View file

@ -169,9 +169,9 @@ export class ViceClient {
debugLog("Received data", data); debugLog("Received data", data);
// Process complete packets // Process complete packets
// Response header: STX(1) + API(1) + bodyLength(4) + responseType(1) + errorCode(1) + requestId(1) = 9 bytes // Response header: STX(1) + API(1) + bodyLength(4) + responseType(1) + errorCode(1) + requestId(4) = 12 bytes
// Then body of `bodyLength` bytes follows // Then body of `bodyLength` bytes follows
while (this.responseBuffer.length >= 9) { while (this.responseBuffer.length >= 12) {
const stx = this.responseBuffer[0]; const stx = this.responseBuffer[0];
if (stx !== STX) { if (stx !== STX) {
// Protocol error, skip byte // Protocol error, skip byte
@ -181,7 +181,7 @@ export class ViceClient {
} }
const bodyLength = this.responseBuffer.readUInt32LE(2); const bodyLength = this.responseBuffer.readUInt32LE(2);
const totalLength = 9 + bodyLength; // Header (9) + body const totalLength = 12 + bodyLength; // Header (12) + body
debugLog(`Packet: bodyLength=${bodyLength}, totalLength=${totalLength}, bufferLen=${this.responseBuffer.length}`); debugLog(`Packet: bodyLength=${bodyLength}, totalLength=${totalLength}, bufferLen=${this.responseBuffer.length}`);
@ -191,11 +191,11 @@ export class ViceClient {
} }
// Parse complete packet // Parse complete packet
// Response format: STX(1) + API(1) + bodyLen(4) + type(1) + error(1) + reqId(1) + body // Response format: STX(1) + API(1) + bodyLen(4) + type(1) + error(1) + reqId(4) + body
const responseType = this.responseBuffer[6] as ResponseType; const responseType = this.responseBuffer[6] as ResponseType;
const errorCode = this.responseBuffer[7] as ErrorCode; const errorCode = this.responseBuffer[7] as ErrorCode;
const requestId = this.responseBuffer[8]; const requestId = this.responseBuffer.readUInt32LE(8);
const body = this.responseBuffer.subarray(9, totalLength); const body = this.responseBuffer.subarray(12, totalLength);
debugLog(`Parsed response: type=0x${responseType.toString(16)}, error=0x${errorCode.toString(16)}, reqId=${requestId}`); debugLog(`Parsed response: type=0x${responseType.toString(16)}, error=0x${errorCode.toString(16)}, reqId=${requestId}`);
debugLog("Response body", body); debugLog("Response body", body);
@ -232,9 +232,9 @@ export class ViceClient {
// Don't return - continue to check for pending requests // Don't return - continue to check for pending requests
} }
// VICE API v1 sends some responses as async events (ReqID=0xff) // VICE sends async events with ReqID=0xffffffff
// For these, we match by response type to the oldest pending request expecting that type // For these, we match by response type to the oldest pending request expecting that type
if (response.requestId === 0xff) { if (response.requestId === 0xffffffff) {
// Find a pending request that expects this response type // Find a pending request that expects this response type
for (const [reqId, pending] of this.pendingRequests) { for (const [reqId, pending] of this.pendingRequests) {
if (pending.expectedResponseType === response.responseType) { if (pending.expectedResponseType === response.responseType) {
@ -306,14 +306,14 @@ export class ViceClient {
const requestId = this.nextRequestId(); const requestId = this.nextRequestId();
// Build packet: STX(1) + API(1) + Length(4) + RequestID(1) + Command(1) + Body // Build packet: STX(1) + API(1) + Length(4) + RequestID(4) + Command(1) + Body = 11 byte header
// Length field is ONLY the command body, NOT including ReqID or Command // Length field is ONLY the command body, NOT including header fields
const header = Buffer.alloc(8); const header = Buffer.alloc(11);
header[0] = STX; header[0] = STX;
header[1] = API_VERSION; header[1] = API_VERSION;
header.writeUInt32LE(body.length, 2); // Just the command body length header.writeUInt32LE(body.length, 2); // Just the command body length
header[6] = requestId; header.writeUInt32LE(requestId, 6); // Request ID is 4 bytes!
header[7] = command; header[10] = command;
const packet = Buffer.concat([header, body]); const packet = Buffer.concat([header, body]);
debugLog(`Sending command 0x${command.toString(16)}, reqId=${requestId}, expectType=${expectedResponseType?.toString(16) ?? 'any'}`, packet); debugLog(`Sending command 0x${command.toString(16)}, reqId=${requestId}, expectType=${expectedResponseType?.toString(16) ?? 'any'}`, packet);