fix(client): address PR #5 review — race condition, buffer corruption, input error
Critical fixes from Hoshe review: 1. Race condition: defer TCP connect to _process() with retry logic (MAX_CONNECT_RETRIES=20, 100ms interval) so server has time to bind. 2. Buffer corruption: disconnect on oversized message instead of clearing valid buffered data (_corrupt flag, fail-safe). 3. Silent input drop: send_input() returns Error so callers can detect encode/validation failures. Warnings addressed: - ServerProcess validates server_path exists before spawning - SIGKILL and health check TODOs documented for future work - Diagonal keybindings documented as intentional deferral - send_message uses single put_data() call (no partial write risk) - Static frame helpers documented as D-030 Layer 2 test-only New tests (36 total, up from 33): - Partial read scenario (chunked TCP delivery) - Multi-message sequential decode (exercises buffer corruption fix) - send_input error return on invalid action Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -9,6 +9,7 @@ const MAX_MESSAGE_SIZE: int = 16 * 1024 * 1024 # 16 MB, matching server
|
||||
var _stream: StreamPeerTCP
|
||||
var _read_buffer: PackedByteArray = PackedByteArray()
|
||||
var _pending_length: int = -1 # -1 = awaiting header, >= 0 = awaiting payload
|
||||
var _corrupt: bool = false # Set on unrecoverable framing error
|
||||
|
||||
|
||||
func _init() -> void:
|
||||
@@ -27,15 +28,18 @@ func poll() -> void:
|
||||
|
||||
## Current TCP connection status.
|
||||
func get_status() -> StreamPeerTCP.Status:
|
||||
if _corrupt:
|
||||
return StreamPeerTCP.STATUS_ERROR
|
||||
return _stream.get_status()
|
||||
|
||||
|
||||
## Whether the TCP stream is in the connected state.
|
||||
func is_connected_to_server() -> bool:
|
||||
return _stream.get_status() == StreamPeerTCP.STATUS_CONNECTED
|
||||
return not _corrupt and _stream.get_status() == StreamPeerTCP.STATUS_CONNECTED
|
||||
|
||||
|
||||
## Send a framed message: [4-byte BE length][payload].
|
||||
## Concatenates header and payload into a single put_data() call to avoid partial writes.
|
||||
func send_message(payload: PackedByteArray) -> Error:
|
||||
if not is_connected_to_server():
|
||||
return ERR_CONNECTION_ERROR
|
||||
@@ -45,18 +49,17 @@ func send_message(payload: PackedByteArray) -> Error:
|
||||
push_error("LocalBridge: message too large: %d bytes (max %d)" % [len, MAX_MESSAGE_SIZE])
|
||||
return ERR_PARAMETER_RANGE_ERROR
|
||||
|
||||
# 4-byte big-endian length header
|
||||
var header := PackedByteArray()
|
||||
header.resize(4)
|
||||
header[0] = (len >> 24) & 0xFF
|
||||
header[1] = (len >> 16) & 0xFF
|
||||
header[2] = (len >> 8) & 0xFF
|
||||
header[3] = len & 0xFF
|
||||
# Build complete frame: [4-byte BE length][payload]
|
||||
var frame := PackedByteArray()
|
||||
frame.resize(4 + len)
|
||||
frame[0] = (len >> 24) & 0xFF
|
||||
frame[1] = (len >> 16) & 0xFF
|
||||
frame[2] = (len >> 8) & 0xFF
|
||||
frame[3] = len & 0xFF
|
||||
for i in range(len):
|
||||
frame[4 + i] = payload[i]
|
||||
|
||||
var err := _stream.put_data(header)
|
||||
if err != OK:
|
||||
return err
|
||||
return _stream.put_data(payload)
|
||||
return _stream.put_data(frame)
|
||||
|
||||
|
||||
## Non-blocking poll for a complete framed message.
|
||||
@@ -88,9 +91,13 @@ func _try_extract_message() -> PackedByteArray:
|
||||
_read_buffer = _read_buffer.slice(4)
|
||||
|
||||
if _pending_length > MAX_MESSAGE_SIZE:
|
||||
push_error("LocalBridge: incoming message too large: %d bytes (max %d)" % [_pending_length, MAX_MESSAGE_SIZE])
|
||||
# Stream is corrupt — we can't find the next valid frame boundary.
|
||||
# Disconnect rather than silently discarding valid buffered data.
|
||||
push_error("LocalBridge: incoming message too large: %d bytes (max %d) — disconnecting" % [_pending_length, MAX_MESSAGE_SIZE])
|
||||
_corrupt = true
|
||||
_pending_length = -1
|
||||
_read_buffer.clear()
|
||||
disconnect_from_server()
|
||||
return PackedByteArray()
|
||||
|
||||
# Phase 2: read payload
|
||||
@@ -110,7 +117,16 @@ func disconnect_from_server() -> void:
|
||||
_pending_length = -1
|
||||
|
||||
|
||||
# -- Static helpers for framing (used in tests without a live TCP connection) --
|
||||
## Reset corrupt state (for reconnection after disconnect).
|
||||
func reset() -> void:
|
||||
_corrupt = false
|
||||
_read_buffer.clear()
|
||||
_pending_length = -1
|
||||
|
||||
|
||||
# -- Static helpers for D-030 Layer 2 testing ----------------------------------
|
||||
# These exist for unit tests that verify framing logic without a live TCP
|
||||
# connection. Not used in production code paths.
|
||||
|
||||
## Encode a payload into a framed byte array: [4-byte BE length][payload].
|
||||
static func frame_encode(payload: PackedByteArray) -> PackedByteArray:
|
||||
|
||||
@@ -5,10 +5,14 @@ var _pid: int = -1
|
||||
|
||||
|
||||
## Start the server process. Returns the PID, or -1 on failure.
|
||||
## Validates that server_path exists and is accessible before spawning.
|
||||
func start(server_path: String, args: Array = []) -> int:
|
||||
if _pid > 0 and is_alive():
|
||||
push_warning("ServerProcess: server already running (pid %d)" % _pid)
|
||||
return _pid
|
||||
if not FileAccess.file_exists(server_path):
|
||||
push_error("ServerProcess: server binary not found at %s" % server_path)
|
||||
return -1
|
||||
_pid = OS.create_process(server_path, args)
|
||||
if _pid <= 0:
|
||||
push_error("ServerProcess: failed to start server at %s" % server_path)
|
||||
@@ -16,6 +20,8 @@ func start(server_path: String, args: Array = []) -> int:
|
||||
|
||||
|
||||
## Check if the server process is still running.
|
||||
## NOTE: OS.is_process_running() doesn't distinguish starting/healthy/zombie.
|
||||
## TODO: Add health check (e.g. TCP readiness probe) when server supports it.
|
||||
func is_alive() -> bool:
|
||||
if _pid <= 0:
|
||||
return false
|
||||
@@ -23,6 +29,7 @@ func is_alive() -> bool:
|
||||
|
||||
|
||||
## Stop the server process.
|
||||
## TODO: Send graceful shutdown signal before SIGKILL when server supports it.
|
||||
func stop() -> void:
|
||||
if _pid > 0 and is_alive():
|
||||
OS.kill(_pid)
|
||||
|
||||
Reference in New Issue
Block a user