Skip to content

armgit / 67.js

Public Imported from GitHub
0

3D engine that AI agents drive

Keep the netcode relay alive on oversize frames and socket errors (#778)

Nguyen Xuan Anc7b26d934dae
diff --git a/changes/778-relay-error-handling.md b/changes/778-relay-error-handling.md
new file mode 100644
index 00000000..6f8cf78e
--- /dev/null
+++ b/changes/778-relay-error-handling.md
@@ -0,0 +1 @@
+- Make the reference netcode relay survive an oversize frame or a socket error instead of crashing, so one bad client cannot drop every player (#778)
diff --git a/docs/netcode.md b/docs/netcode.md
index a094c558..4fa1e735 100644
--- a/docs/netcode.md
+++ b/docs/netcode.md
@@ -86,4 +86,4 @@ A transport is a plain object `{ id, peers(), send(peerId, message), receive(cal
## Not yet
-WebRTC and WebTransport transports, peer-to-peer authority and a physics-prop sample come in later slices of #778. Use the same `fixedRate` on the authority and every client.
+WebRTC and WebTransport transports, peer-to-peer authority and a physics-prop sample come in later work on #778. Use the same `fixedRate` on the authority and every client.
diff --git a/scripts/netcode-relay.mjs b/scripts/netcode-relay.mjs
index 1c3aa304..5d3aa98a 100644
--- a/scripts/netcode-relay.mjs
+++ b/scripts/netcode-relay.mjs
@@ -36,7 +36,10 @@ export async function startNetcodeRelay(options = {}) {
else setTimeout(send, latencyMilliseconds);
}
+ server.on('error', () => {});
+
server.on('connection', (socket, request) => {
+ socket.on('error', () => socket.terminate());
const peerId = new URL(request.url ?? '/', 'http://relay').searchParams.get('id');
const validId = typeof peerId === 'string' && peerId !== '' && peerId.length <= MAXIMUM_NAME_LENGTH;
if (!validId || clients.has(peerId) || clients.size >= MAXIMUM_PEERS) {
diff --git a/tests/netcode-two-browsers.test.js b/tests/netcode-two-browsers.test.js
index f28823be..28ddb6ba 100644
--- a/tests/netcode-two-browsers.test.js
+++ b/tests/netcode-two-browsers.test.js
@@ -156,3 +156,31 @@ test('the relay forwards to the named player, announces a leaver and refuses a r
await assert.rejects(startNetcodeRelay({ port: 70000 }), /port must be an integer/);
await assert.rejects(startNetcodeRelay({ latencyMilliseconds: -1 }), /latencyMilliseconds/);
});
+
+test('the relay survives an oversize frame and keeps forwarding for other players', async () => {
+ const relay = await startNetcodeRelay({ port: 0 });
+ const open = id => new Promise((resolve, reject) => {
+ const socket = new WebSocket(`ws://127.0.0.1:${relay.port}/?id=${id}`);
+ socket.once('open', () => resolve(socket));
+ socket.once('error', reject);
+ });
+ const nextMessage = socket => new Promise(resolve => socket.once('message', data => resolve(JSON.parse(data.toString()))));
+ try {
+ const sender = await open('sender');
+ const receiver = await open('receiver');
+ const offender = await open('offender');
+ offender.on('error', () => {});
+ const offenderClosed = new Promise(resolve => offender.once('close', () => resolve()));
+ offender.send('x'.repeat(70000));
+ await offenderClosed;
+
+ const arrival = nextMessage(receiver);
+ sender.send(JSON.stringify({ to: 'receiver', data: { still: 'alive' } }));
+ assert.deepEqual(await arrival, { from: 'sender', data: { still: 'alive' } });
+ assert.deepEqual(relay.peerIds.sort(), ['receiver', 'sender']);
+ sender.close();
+ receiver.close();
+ } finally {
+ await relay.close();
+ }
+});