@shipload/sdk 1.0.0-next.0 → 1.0.0-next.2

package/lib/shipload.d.ts

@@ -2417,6 +2417,9 @@ type SubscriptionEntityType = 'ship' | 'warehouse' | 'container';
 type EntityInstance = Ship | Warehouse | Container;
 interface SubscriptionsOptions {
     url: string;
+    minReconnectDelay?: number;
+    pingIntervalMs?: number;
+    pongTimeoutMs?: number;
 }
 interface BoundsSubscriptionHandle {
     readonly subId: string;
@@ -2436,6 +2439,7 @@ declare class SubscriptionsManager {
     private readonly entitySubs;
     private readonly boundsSubs;
     private subCounter;
+    private hasConnected;
     constructor(opts: SubscriptionsOptions);
     close(): void;
     private generateSubID;
@@ -2451,6 +2455,7 @@ declare class SubscriptionsManager {
     }): BoundsSubscriptionHandle;
     private unsubscribeBounds;
     private updateBounds;
+    private onStateChange;
     private onMessage;
     private parseEntity;
     private handleSnapshot;
@@ -3098,6 +3103,9 @@ interface WebSocketConnectionOptions {
     url: string;
     onMessage: (message: ServerMessage) => void;
     onStateChange?: (state: ConnectionState) => void;
+    minReconnectDelay?: number;
+    pingIntervalMs?: number;
+    pongTimeoutMs?: number;
 }
 declare class WebSocketConnection {
     private ws;
@@ -3109,15 +3117,25 @@ declare class WebSocketConnection {
     private _state;
     private shouldReconnect;
     private sendQueue;
-    private static readonly MIN_RECONNECT_DELAY;
+    private minReconnectDelay;
+    private pingIntervalMs;
+    private pongTimeoutMs;
+    private pingTimer;
+    private staleTimer;
+    private static readonly DEFAULT_MIN_RECONNECT_DELAY;
     private static readonly MAX_RECONNECT_DELAY;
     private static readonly RECONNECT_MULTIPLIER;
+    private static readonly DEFAULT_PING_INTERVAL_MS;
+    private static readonly DEFAULT_PONG_TIMEOUT_MS;
     constructor(options: WebSocketConnectionOptions);
     get state(): ConnectionState;
     private setState;
     connect(): void;
     private scheduleReconnect;
     disconnect(): void;
+    private startHeartbeat;
+    private stopHeartbeat;
+    private resetStaleTimer;
     close(): void;
     send(message: ClientMessage): void;
     get isConnected(): boolean;

package/lib/shipload.js

@@ -9103,9 +9103,15 @@ class WebSocketConnection {
         this._state = 'disconnected';
         this.shouldReconnect = true;
         this.sendQueue = [];
+        this.pingTimer = null;
+        this.staleTimer = null;
         this.url = options.url;
         this.onMessage = options.onMessage;
         this.onStateChange = options.onStateChange;
+        this.minReconnectDelay =
+            options.minReconnectDelay ?? WebSocketConnection.DEFAULT_MIN_RECONNECT_DELAY;
+        this.pingIntervalMs = options.pingIntervalMs ?? WebSocketConnection.DEFAULT_PING_INTERVAL_MS;
+        this.pongTimeoutMs = options.pongTimeoutMs ?? WebSocketConnection.DEFAULT_PONG_TIMEOUT_MS;
     }
     get state() {
         return this._state;
@@ -9134,8 +9140,10 @@ class WebSocketConnection {
                     this.ws.readyState === WebSocket.OPEN) {
                     this.ws.send(this.sendQueue.shift());
                 }
+                this.startHeartbeat();
             };
             this.ws.onmessage = (event) => {
+                this.resetStaleTimer();
                 try {
                     const message = JSON.parse(event.data);
                     this.onMessage(message);
@@ -9145,6 +9153,7 @@ class WebSocketConnection {
                 }
             };
             this.ws.onclose = () => {
+                this.stopHeartbeat();
                 this.ws = null;
                 this.sendQueue.length = 0;
                 if (this.shouldReconnect) {
@@ -9169,7 +9178,7 @@ class WebSocketConnection {
         if (this.reconnectTimeout) {
             return;
         }
-        const delay = Math.min(WebSocketConnection.MIN_RECONNECT_DELAY *
+        const delay = Math.min(this.minReconnectDelay *
             WebSocketConnection.RECONNECT_MULTIPLIER ** this.reconnectAttempts, WebSocketConnection.MAX_RECONNECT_DELAY);
         debug(`Reconnecting in ${delay}ms (attempt ${this.reconnectAttempts + 1})`);
         this.reconnectTimeout = setTimeout(() => {
@@ -9184,6 +9193,7 @@ class WebSocketConnection {
             clearTimeout(this.reconnectTimeout);
             this.reconnectTimeout = null;
         }
+        this.stopHeartbeat();
         if (this.ws) {
             this.ws.close();
             this.ws = null;
@@ -9191,6 +9201,34 @@ class WebSocketConnection {
         this.sendQueue.length = 0;
         this.setState('disconnected');
     }
+    startHeartbeat() {
+        this.stopHeartbeat();
+        this.resetStaleTimer();
+        this.pingTimer = setInterval(() => {
+            if (this.ws && this.ws.readyState === WebSocket.OPEN) {
+                this.ws.send(JSON.stringify({ type: 'ping' }));
+            }
+        }, this.pingIntervalMs);
+    }
+    stopHeartbeat() {
+        if (this.pingTimer) {
+            clearInterval(this.pingTimer);
+            this.pingTimer = null;
+        }
+        if (this.staleTimer) {
+            clearTimeout(this.staleTimer);
+            this.staleTimer = null;
+        }
+    }
+    resetStaleTimer() {
+        if (this.staleTimer)
+            clearTimeout(this.staleTimer);
+        this.staleTimer = setTimeout(() => {
+            debug('No frames within ping interval + pong timeout — forcing reconnect');
+            if (this.ws)
+                this.ws.close();
+        }, this.pingIntervalMs + this.pongTimeoutMs);
+    }
     close() {
         this.disconnect();
     }
@@ -9206,9 +9244,11 @@ class WebSocketConnection {
         return this._state === 'connected';
     }
 }
-WebSocketConnection.MIN_RECONNECT_DELAY = 1000;
+WebSocketConnection.DEFAULT_MIN_RECONNECT_DELAY = 1000;
 WebSocketConnection.MAX_RECONNECT_DELAY = 30000;
 WebSocketConnection.RECONNECT_MULTIPLIER = 2;
+WebSocketConnection.DEFAULT_PING_INTERVAL_MS = 25000;
+WebSocketConnection.DEFAULT_PONG_TIMEOUT_MS = 10000;
 
 function mapEntity(ei) {
     if (ei.type.equals('ship'))
@@ -9237,9 +9277,14 @@ class SubscriptionsManager {
         this.entitySubs = new Map();
         this.boundsSubs = new Map();
         this.subCounter = 0;
+        this.hasConnected = false;
         this.conn = new WebSocketConnection({
             url: opts.url,
             onMessage: (m) => this.onMessage(m),
+            onStateChange: (s) => this.onStateChange(s),
+            minReconnectDelay: opts.minReconnectDelay,
+            pingIntervalMs: opts.pingIntervalMs,
+            pongTimeoutMs: opts.pongTimeoutMs,
         });
         this.conn.connect();
     }
@@ -9296,6 +9341,9 @@ class SubscriptionsManager {
             current: new Map(),
         };
         this.boundsSubs.set(subId, {
+            bounds,
+            owner: handlers.owner,
+            prioritizeOwner: handlers.prioritizeOwner,
             onSnapshot: handlers.onSnapshot,
             onUpdate: handlers.onUpdate,
             onBoundsDelta: handlers.onBoundsDelta,
@@ -9309,9 +9357,39 @@ class SubscriptionsManager {
         this.sendMessage({ type: 'unsubscribe', sub_id: subId });
     }
     updateBounds(subId, bounds) {
+        const entry = this.boundsSubs.get(subId);
+        if (entry)
+            entry.bounds = bounds;
         const msg = { type: 'update_bounds', sub_id: subId, bounds };
         this.sendMessage(msg);
     }
+    onStateChange(state) {
+        if (state !== 'connected')
+            return;
+        if (!this.hasConnected) {
+            this.hasConnected = true;
+            return;
+        }
+        for (const [subId, entry] of this.entitySubs) {
+            const msg = {
+                type: 'subscribe_entity',
+                sub_id: subId,
+                entity_type: entry.type,
+                entity_id: entry.id,
+            };
+            this.sendMessage(msg);
+        }
+        for (const [subId, entry] of this.boundsSubs) {
+            const msg = {
+                type: 'subscribe',
+                sub_id: subId,
+                bounds: entry.bounds,
+                owner: entry.owner,
+                prioritize_owner: entry.prioritizeOwner,
+            };
+            this.sendMessage(msg);
+        }
+    }
     onMessage(msg) {
         switch (msg.type) {
             case 'snapshot':