wirejs-deploy-amplify-basic 0.0.117-realtime → 0.0.119-realtime

package/amplify-hosting-assets/compute/default/package.json

@@ -3,6 +3,6 @@
 	"dependencies": {
 		"jsdom": "^25.0.1",
 		"wirejs-dom": "^1.0.41",
-		"wirejs-resources": "^0.1.85-realtime"
+		"wirejs-resources": "^0.1.87-realtime"
 	}
 }

package/dist/client/realtime.d.ts

@@ -1,5 +1,5 @@
 import type { MessageStreamSubscriber } from "wirejs-resources";
-export type ChannelEvent<T = any> = {
+export type ChannelEvent = {
     type: "subscribe_success" | "data" | "broadcast_error" | "ka";
     id: string;
     event: any;

package/dist/client/realtime.js

@@ -7,18 +7,23 @@
  */
 const connections = new Map();
 /**
+ * Channel subscription ID look-up table.
+ *
  * `${URL}#${channel}` -> subscription ID
  */
-const channelSubs = new Map();
+const channelSubIdLUT = new Map();
 /**
  * subscription ID -> subscriber
  */
-const subscribers = new Map();
+const subIdSubscribers = new Map();
 /**
  * subcription ID -> connection state
  *
- * For when new subscribers are added, we'll want to broadcast the current
+ * For when new subIdSubscribers are added, we'll want to broadcast the current
  * state of the connection.
+ *
+ * "closed"-typed states are not represented here, as they are removed from the map
+ * when the WebSocket connection is closed.
  */
 const subscriptionState = new Map();
 /**
@@ -74,7 +79,7 @@ export function subscribe(url, channel, token, authHost, subscriber) {
             const sid = subscriptionIdString(data.id);
             if (data.type === 'data') {
                 const eventData = JSON.parse(data.event);
-                for (const subscriber of subscribers.get(sid) || []) {
+                for (const subscriber of subIdSubscribers.get(sid) || []) {
                     try {
                         subscriber.onmessage(eventData);
                     }
@@ -85,7 +90,7 @@ export function subscribe(url, channel, token, authHost, subscriber) {
             }
             else if (data.type === 'subscribe_success') {
                 subscriptionState.set(sid, 'open');
-                for (const subscriber of subscribers.get(sid) || []) {
+                for (const subscriber of subIdSubscribers.get(sid) || []) {
                     try {
                         subscriber.onopen?.();
                     }
@@ -95,35 +100,53 @@ export function subscribe(url, channel, token, authHost, subscriber) {
                 }
             }
         };
-        const notifyClosed = () => {
-            const subscriptionIds = Array.from(channelSubs.entries())
+        const cleanup = (reason) => {
+            // remove the top-level connection entry *first* so that subsequent
+            // subscribers don't try to access a closed WebSocket. they will instead
+            // see no connection and a new one will be created.
+            connections.delete(urlKey);
+            // next. we need to identify all subscriptions to notify -- but wait to notify
+            // until after we have removed them from the look-up table so that the callbacks
+            // don't interfere with the bookkeeping.
+            const subscriptionIds = Array.from(channelSubIdLUT.entries())
                 .filter(([urlChannel, _subId]) => urlChannel.startsWith(`${url}#`))
                 .map(([_urlChannel, subId]) => subscriptionIdString(subId));
+            const subs = [];
             for (const subscriptionId of subscriptionIds) {
-                subscriptionState.set(subscriptionId, 'closed');
-                const subs = subscribers.get(subscriptionId);
-                if (subs) {
-                    for (const subscriber of subs) {
-                        if (subscriber.onclose) {
-                            try {
-                                subscriber.onclose();
-                            }
-                            catch (error) {
-                                console.error('Error in subscriber onclose:', error);
-                            }
-                        }
-                    }
-                    subscribers.delete(subscriptionId);
+                subs.concat(subIdSubscribers.get(subscriptionId));
+            }
+            // same story with channel names.
+            const fullChannelNames = Array.from(channelSubIdLUT.keys())
+                .filter(k => k.startsWith(`${url}#`));
+            // now that we've *identified* everything that requires bookkeeping and
+            // notification, we do the bookkeeping ONLY.
+            for (const subscriptionId of subscriptionIds) {
+                subIdSubscribers.delete(subscriptionId);
+                subscriptionState.delete(subscriptionId);
+            }
+            for (const fullChannelName of fullChannelNames) {
+                channelSubIdLUT.delete(fullChannelName);
+            }
+            // all bookkeeping is done, now we can notify subscribers.
+            // they can no longer interfere with the bookkeeping.
+            for (const subscriber of subs || []) {
+                try {
+                    subscriber.onclose?.(reason);
+                }
+                catch (error) {
+                    console.error('Error in subscriber onclose:', error);
                 }
             }
-            console.log('closed', event);
+            console.debug('closed', ws);
         };
-        ws.onclose = () => notifyClosed();
-        ws.onerror = () => notifyClosed();
+        ws.onclose = () => cleanup('closed');
+        ws.onerror = () => cleanup('error');
     }
-    if (!channelSubs.has(fullChannelName)) {
+    if (!channelSubIdLUT.has(fullChannelName)) {
         const subscriptionId = subscriptionIdString(crypto.randomUUID());
         subscriptionState.set(subscriptionId, 'connecting');
+        channelSubIdLUT.set(fullChannelName, subscriptionId);
+        subIdSubscribers.set(subscriptionId, [subscriber]);
         const ws = connections.get(urlKey);
         const subscribe = () => {
             ws.send(JSON.stringify({
@@ -132,8 +155,6 @@ export function subscribe(url, channel, token, authHost, subscriber) {
                 channel,
                 authorization
             }));
-            channelSubs.set(fullChannelName, subscriptionId);
-            subscribers.set(subscriptionId, [subscriber]);
         };
         if (ws.readyState === WebSocket.OPEN) {
             subscribe();
@@ -143,13 +164,22 @@ export function subscribe(url, channel, token, authHost, subscriber) {
         }
     }
     else {
-        const subscriptionId = channelSubs.get(fullChannelName);
-        subscribers.get(subscriptionId).push(subscriber);
-        if (subscriptionState.get(subscriptionId) === 'open') {
-            subscriber.onopen?.();
+        const subscriptionId = channelSubIdLUT.get(fullChannelName);
+        if (!subscriptionId) {
+            throw new Error(`No subscription ID found for channel: ${fullChannelName}`);
+        }
+        const subs = subIdSubscribers.get(subscriptionId);
+        if (!subs) {
+            throw new Error(`No subscriber list found for subscription ID: ${subscriptionId}`);
         }
-        else if (subscriptionState.get(subscriptionId) === 'closed') {
-            subscriber.onclose?.();
+        subs?.push(subscriber);
+        if (subscriptionState.get(subscriptionId) === 'open') {
+            try {
+                subscriber.onopen?.();
+            }
+            catch (error) {
+                console.error('Error in subscriber onopen:', error);
+            }
         }
     }
 }
@@ -157,29 +187,52 @@ export function unsubscribe(url, channel, subscriber) {
     const urlKey = urlString(url);
     const ws = connections.get(urlKey);
     const fullChannelName = fullChannelNameString(urlKey, channel);
-    const subId = channelSubs.get(fullChannelName);
-    const subs = subId && subscribers.get(subId);
+    const subId = channelSubIdLUT.get(fullChannelName);
+    const subs = subId && subIdSubscribers.get(subId);
     const sub = subs ? subs.find(s => s === subscriber) : undefined;
     if (sub && subs) {
-        subs.splice(subs.indexOf(sub), 1);
-        subscribers.set(subId, subs);
-        sub.onclose?.();
+        try {
+            sub.onclose?.('unsubscribed');
+        }
+        catch (error) {
+            console.error('Error in subscriber onclose:', error);
+        }
+        const i = subs.indexOf(sub);
+        if (i > -1)
+            subs.splice(i, 1);
     }
     if (subs && subs.length === 0) {
-        // No subscribers left for this channel. We can unsubscribe from channel.
+        // No subIdSubscribers left for this channel. We can unsubscribe from channel.
+        subscriptionState.delete(subId);
+        subIdSubscribers.delete(subId);
+        channelSubIdLUT.delete(fullChannelName);
         ws?.send(JSON.stringify({
             id: subId,
             type: 'unsubscribe',
         }));
-        subscriptionState.delete(subId);
-        subscribers.delete(subId);
-        channelSubs.delete(fullChannelName);
     }
-    const socketSubs = Array.from(channelSubs.keys())
-        .filter(k => k.startsWith(urlKey));
-    if (socketSubs.length === 0) {
-        // No channels left for this URL. We can close the WebSocket connection.
-        ws?.close();
-        connections.delete(urlKey);
+    // debounce closing the WebSocket connection for use-cases where a client
+    // might just be changing channels. ws should only be closed if there are
+    // no more subscriptions running over the socket.
+    setTimeout(() => {
+        const socketSubs = Array.from(channelSubIdLUT.keys())
+            .filter(k => k.startsWith(`${url}#`));
+        if (socketSubs.length === 0) {
+            // No channels left for this URL. We can close the WebSocket connection.
+            connections.delete(urlKey);
+            ws?.close();
+            console.debug('closed', ws);
+        }
+    }, 5000);
+    // tell the subscriber that they have been unsubscribed as the last step so
+    // they can clean up any resources they have allocated without interfering
+    // with the preceding bookkeeping.
+    if (sub) {
+        try {
+            sub.onclose?.('unsubscribed');
+        }
+        catch (error) {
+            console.error('Error in subscriber onclose:', error);
+        }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wirejs-deploy-amplify-basic",
-	"version": "0.0.117-realtime",
+	"version": "0.0.119-realtime",
 	"type": "module",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",
@@ -41,7 +41,7 @@
 		"recursive-copy": "^2.0.14",
 		"rimraf": "^6.0.1",
 		"wirejs-dom": "^1.0.41",
-		"wirejs-resources": "^0.1.85-realtime"
+		"wirejs-resources": "^0.1.87-realtime"
 	},
 	"devDependencies": {
 		"@aws-amplify/backend": "^1.14.0",