@koolbase/core 12.11.0 → 12.11.1

package/dist/cjs/realtime.d.ts

@@ -9,6 +9,11 @@ export declare class KoolbaseRealtime {
     private reconnectAttempts;
     private reconnectTimer;
     private connecting;
+    private idleTimer;
+    /** How long an unused connection stays open, in ms: a screen that comes
+     *  straight back (navigating back, React's development double start)
+     *  reuses it instead of opening another. */
+    static idleGraceMs: number;
     /**
      * Identifies whose cache a seen record belongs in.
      *
@@ -39,6 +44,13 @@ export declare class KoolbaseRealtime {
      * does not accumulate delay.
      */
     private scheduleReconnect;
+    /**
+     * Closes the connection once nobody is subscribed -- after a moment, not at
+     * once: a screen that unmounts and mounts again keeps the connection it had.
+     * A subscribe within the moment cancels the close. Nothing reconnects after
+     * it: reconnecting needs a subscriber.
+     */
+    private scheduleIdleClose;
     disconnect(): void;
 }
 export {};

package/dist/cjs/realtime.js

@@ -41,6 +41,9 @@ class KoolbaseRealtime {
         this.reconnectAttempts = 0;
         this.reconnectTimer = null;
         this.connecting = false;
+        // Pending close of an unused connection (scheduleIdleClose); null while
+        // anyone is subscribed.
+        this.idleTimer = null;
         this.config = config;
         this.getToken = getToken;
         this.getUserId = getUserId;
@@ -61,6 +64,10 @@ class KoolbaseRealtime {
         await (0, cache_store_js_1.removeCachedRecord)(userId, recordId);
     }
     subscribe(collection, callback) {
+        if (this.idleTimer) {
+            clearTimeout(this.idleTimer);
+            this.idleTimer = null;
+        }
         if (!this.listeners.has(collection))
             this.listeners.set(collection, []);
         this.listeners.get(collection).push(callback);
@@ -71,13 +78,16 @@ class KoolbaseRealtime {
             void this.connect();
         }
         return () => {
-            const callbacks = this.listeners.get(collection) ?? [];
-            const i = callbacks.indexOf(callback);
-            if (i > -1)
-                callbacks.splice(i, 1);
+            const callbacks = this.listeners.get(collection);
+            const i = callbacks ? callbacks.indexOf(callback) : -1;
+            if (!callbacks || i === -1)
+                return; // already unsubscribed: a second call does nothing
+            callbacks.splice(i, 1);
             if (callbacks.length === 0) {
                 this.listeners.delete(collection);
                 this.sendUnsubscribe(collection);
+                if (this.listeners.size === 0)
+                    this.scheduleIdleClose();
             }
         };
     }
@@ -86,15 +96,39 @@ class KoolbaseRealtime {
             return;
         if (this.ws && (this.ws.readyState === WebSocket.OPEN || this.ws.readyState === WebSocket.CONNECTING))
             return;
-        const token = await this.getToken();
+        // Claimed BEFORE the token is awaited. Claimed after it, every subscribe
+        // arriving meanwhile -- two live lists on one screen, React's development
+        // double start -- found nobody connecting and opened its own socket; only
+        // the last was remembered, and the others stayed open for good.
+        this.connecting = true;
+        let token;
+        try {
+            token = await this.getToken();
+        }
+        catch {
+            token = null;
+        }
+        if (this.listeners.size === 0) {
+            // Everyone left while the token was on its way: nothing to connect for.
+            this.connecting = false;
+            return;
+        }
         if (!token) {
+            this.connecting = false;
             this.scheduleReconnect(); // sign-in may be in flight
             return;
         }
         this.projectId = projectIdFromToken(token);
-        this.connecting = true;
         const wsUrl = this.config.baseUrl.replace('https://', 'wss://').replace('http://', 'ws://');
-        const ws = new WebSocket(`${wsUrl}/v1/realtime/ws?token=${encodeURIComponent(token)}`);
+        let ws;
+        try {
+            ws = new WebSocket(`${wsUrl}/v1/realtime/ws?token=${encodeURIComponent(token)}`);
+        }
+        catch {
+            this.connecting = false;
+            this.scheduleReconnect();
+            return;
+        }
         this.ws = ws;
         ws.onopen = () => {
             this.connecting = false;
@@ -187,11 +221,47 @@ class KoolbaseRealtime {
         }, delay);
         this.reconnectTimer.unref?.();
     }
+    /**
+     * Closes the connection once nobody is subscribed -- after a moment, not at
+     * once: a screen that unmounts and mounts again keeps the connection it had.
+     * A subscribe within the moment cancels the close. Nothing reconnects after
+     * it: reconnecting needs a subscriber.
+     */
+    scheduleIdleClose() {
+        if (this.idleTimer)
+            clearTimeout(this.idleTimer);
+        this.idleTimer = setTimeout(() => {
+            this.idleTimer = null;
+            if (this.listeners.size > 0)
+                return;
+            if (this.reconnectTimer) {
+                clearTimeout(this.reconnectTimer);
+                this.reconnectTimer = null;
+            }
+            const ws = this.ws;
+            this.ws = null;
+            this.connecting = false;
+            if (ws) {
+                // Detached first: this close is ours, not a dropped connection.
+                ws.onopen = null;
+                ws.onmessage = null;
+                ws.onclose = null;
+                ws.onerror = null;
+                ws.close();
+            }
+        }, KoolbaseRealtime.idleGraceMs);
+        this.idleTimer.unref?.();
+    }
     disconnect() {
+        if (this.idleTimer) {
+            clearTimeout(this.idleTimer);
+            this.idleTimer = null;
+        }
         if (this.reconnectTimer) {
             clearTimeout(this.reconnectTimer);
             this.reconnectTimer = null;
         }
+        this.connecting = false;
         this.ws?.close();
         this.ws = null;
         this.projectId = null;
@@ -199,3 +269,7 @@ class KoolbaseRealtime {
     }
 }
 exports.KoolbaseRealtime = KoolbaseRealtime;
+/** How long an unused connection stays open, in ms: a screen that comes
+ *  straight back (navigating back, React's development double start)
+ *  reuses it instead of opening another. */
+KoolbaseRealtime.idleGraceMs = 1000;

package/dist/esm/realtime.d.ts

@@ -9,6 +9,11 @@ export declare class KoolbaseRealtime {
     private reconnectAttempts;
     private reconnectTimer;
     private connecting;
+    private idleTimer;
+    /** How long an unused connection stays open, in ms: a screen that comes
+     *  straight back (navigating back, React's development double start)
+     *  reuses it instead of opening another. */
+    static idleGraceMs: number;
     /**
      * Identifies whose cache a seen record belongs in.
      *
@@ -39,6 +44,13 @@ export declare class KoolbaseRealtime {
      * does not accumulate delay.
      */
     private scheduleReconnect;
+    /**
+     * Closes the connection once nobody is subscribed -- after a moment, not at
+     * once: a screen that unmounts and mounts again keeps the connection it had.
+     * A subscribe within the moment cancels the close. Nothing reconnects after
+     * it: reconnecting needs a subscriber.
+     */
+    private scheduleIdleClose;
     disconnect(): void;
 }
 export {};

package/dist/esm/realtime.js

@@ -38,6 +38,9 @@ export class KoolbaseRealtime {
         this.reconnectAttempts = 0;
         this.reconnectTimer = null;
         this.connecting = false;
+        // Pending close of an unused connection (scheduleIdleClose); null while
+        // anyone is subscribed.
+        this.idleTimer = null;
         this.config = config;
         this.getToken = getToken;
         this.getUserId = getUserId;
@@ -58,6 +61,10 @@ export class KoolbaseRealtime {
         await removeCachedRecord(userId, recordId);
     }
     subscribe(collection, callback) {
+        if (this.idleTimer) {
+            clearTimeout(this.idleTimer);
+            this.idleTimer = null;
+        }
         if (!this.listeners.has(collection))
             this.listeners.set(collection, []);
         this.listeners.get(collection).push(callback);
@@ -68,13 +75,16 @@ export class KoolbaseRealtime {
             void this.connect();
         }
         return () => {
-            const callbacks = this.listeners.get(collection) ?? [];
-            const i = callbacks.indexOf(callback);
-            if (i > -1)
-                callbacks.splice(i, 1);
+            const callbacks = this.listeners.get(collection);
+            const i = callbacks ? callbacks.indexOf(callback) : -1;
+            if (!callbacks || i === -1)
+                return; // already unsubscribed: a second call does nothing
+            callbacks.splice(i, 1);
             if (callbacks.length === 0) {
                 this.listeners.delete(collection);
                 this.sendUnsubscribe(collection);
+                if (this.listeners.size === 0)
+                    this.scheduleIdleClose();
             }
         };
     }
@@ -83,15 +93,39 @@ export class KoolbaseRealtime {
             return;
         if (this.ws && (this.ws.readyState === WebSocket.OPEN || this.ws.readyState === WebSocket.CONNECTING))
             return;
-        const token = await this.getToken();
+        // Claimed BEFORE the token is awaited. Claimed after it, every subscribe
+        // arriving meanwhile -- two live lists on one screen, React's development
+        // double start -- found nobody connecting and opened its own socket; only
+        // the last was remembered, and the others stayed open for good.
+        this.connecting = true;
+        let token;
+        try {
+            token = await this.getToken();
+        }
+        catch {
+            token = null;
+        }
+        if (this.listeners.size === 0) {
+            // Everyone left while the token was on its way: nothing to connect for.
+            this.connecting = false;
+            return;
+        }
         if (!token) {
+            this.connecting = false;
             this.scheduleReconnect(); // sign-in may be in flight
             return;
         }
         this.projectId = projectIdFromToken(token);
-        this.connecting = true;
         const wsUrl = this.config.baseUrl.replace('https://', 'wss://').replace('http://', 'ws://');
-        const ws = new WebSocket(`${wsUrl}/v1/realtime/ws?token=${encodeURIComponent(token)}`);
+        let ws;
+        try {
+            ws = new WebSocket(`${wsUrl}/v1/realtime/ws?token=${encodeURIComponent(token)}`);
+        }
+        catch {
+            this.connecting = false;
+            this.scheduleReconnect();
+            return;
+        }
         this.ws = ws;
         ws.onopen = () => {
             this.connecting = false;
@@ -184,14 +218,54 @@ export class KoolbaseRealtime {
         }, delay);
         this.reconnectTimer.unref?.();
     }
+    /**
+     * Closes the connection once nobody is subscribed -- after a moment, not at
+     * once: a screen that unmounts and mounts again keeps the connection it had.
+     * A subscribe within the moment cancels the close. Nothing reconnects after
+     * it: reconnecting needs a subscriber.
+     */
+    scheduleIdleClose() {
+        if (this.idleTimer)
+            clearTimeout(this.idleTimer);
+        this.idleTimer = setTimeout(() => {
+            this.idleTimer = null;
+            if (this.listeners.size > 0)
+                return;
+            if (this.reconnectTimer) {
+                clearTimeout(this.reconnectTimer);
+                this.reconnectTimer = null;
+            }
+            const ws = this.ws;
+            this.ws = null;
+            this.connecting = false;
+            if (ws) {
+                // Detached first: this close is ours, not a dropped connection.
+                ws.onopen = null;
+                ws.onmessage = null;
+                ws.onclose = null;
+                ws.onerror = null;
+                ws.close();
+            }
+        }, KoolbaseRealtime.idleGraceMs);
+        this.idleTimer.unref?.();
+    }
     disconnect() {
+        if (this.idleTimer) {
+            clearTimeout(this.idleTimer);
+            this.idleTimer = null;
+        }
         if (this.reconnectTimer) {
             clearTimeout(this.reconnectTimer);
             this.reconnectTimer = null;
         }
+        this.connecting = false;
         this.ws?.close();
         this.ws = null;
         this.projectId = null;
         this.listeners.clear();
     }
 }
+/** How long an unused connection stays open, in ms: a screen that comes
+ *  straight back (navigating back, React's development double start)
+ *  reuses it instead of opening another. */
+KoolbaseRealtime.idleGraceMs = 1000;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@koolbase/core",
-  "version": "12.11.0",
+  "version": "12.11.1",
   "description": "Koolbase SDK core \u2014 shared behaviour behind @koolbase/react-native and @koolbase/js. Install one of those, not this.",
   "main": "./dist/cjs/index.js",
   "types": "./dist/esm/index.d.ts",