codebuff 1.0.99

package/dist/common/websockets/websocket-client.js

@@ -0,0 +1,187 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIRealtimeClient = void 0;
+exports.formatState = formatState;
+const ws_1 = require("ws");
+const picocolors_1 = require("picocolors");
+// mqp: useful for debugging
+const VERBOSE_LOGGING = false;
+const TIMEOUT_MS = 30_000;
+const RECONNECT_WAIT_MS = 5_000;
+function formatState(state) {
+    switch (state) {
+        case ws_1.WebSocket.CONNECTING:
+            return 'connecting';
+        case ws_1.WebSocket.OPEN:
+            return 'open';
+        case ws_1.WebSocket.CLOSING:
+            return 'closing';
+        case ws_1.WebSocket.CLOSED:
+            return 'closed';
+        default:
+            throw new Error('Invalid websocket state.');
+    }
+}
+/** Client for the API websocket realtime server. Automatically manages reconnection
+ * and resubscription on disconnect, and allows subscribers to get a callback
+ * when something is broadcasted. */
+class APIRealtimeClient {
+    ws;
+    url;
+    // Callbacks subscribed to individual actions.
+    subscribers;
+    txid;
+    // all txns that are in flight, with no ack/error/timeout
+    txns;
+    connectTimeout;
+    heartbeat;
+    hadError = false;
+    onError;
+    constructor(url, onError) {
+        this.url = url;
+        this.txid = 0;
+        this.txns = new Map();
+        this.subscribers = new Map();
+        this.onError = onError;
+    }
+    get state() {
+        return this.ws.readyState;
+    }
+    close() {
+        this.ws.close(1000, 'Closed manually.');
+        clearTimeout(this.connectTimeout);
+    }
+    connect() {
+        // you may wish to refer to https://websockets.spec.whatwg.org/
+        // in order to check the semantics of events etc.
+        this.ws = new ws_1.WebSocket(this.url);
+        this.ws.onmessage = (ev) => {
+            if (this.hadError) {
+                this.hadError = false;
+                console.log((0, picocolors_1.green)('Reconnected!'));
+            }
+            this.receiveMessage(JSON.parse(ev.data));
+        };
+        this.ws.onerror = (ev) => {
+            if (!this.hadError) {
+                this.onError();
+                this.hadError = true;
+            }
+            // this can fire without an onclose if this is the first time we ever try
+            // to connect, so we need to turn on our reconnect in that case
+            this.waitAndReconnect();
+        };
+        this.ws.onclose = (ev) => {
+            // note that if the connection closes due to an error, onerror fires and then this
+            if (VERBOSE_LOGGING) {
+                console.info(`API websocket closed with code=${ev.code}: ${ev.reason}`);
+            }
+            clearInterval(this.heartbeat);
+            // mqp: we might need to change how the txn stuff works if we ever want to
+            // implement "wait until i am subscribed, and then do something" in a component.
+            // right now it cannot be reliably used to detect that in the presence of reconnects
+            for (const txn of Array.from(this.txns.values())) {
+                clearTimeout(txn.timeout);
+                txn.reject(new Error('Websocket was closed.'));
+            }
+            this.txns.clear();
+            // 1000 is RFC code for normal on-purpose closure
+            if (ev.code !== 1000) {
+                this.waitAndReconnect();
+            }
+        };
+        return new Promise((resolve) => {
+            this.ws.onopen = (_ev) => {
+                if (VERBOSE_LOGGING) {
+                    console.info('API websocket opened.');
+                }
+                this.heartbeat = setInterval(async () => this.sendMessage('ping', {}).catch(() => { }), 30000);
+                resolve();
+            };
+        });
+    }
+    waitAndReconnect() {
+        if (this.connectTimeout == null) {
+            this.connectTimeout = setTimeout(() => {
+                this.connectTimeout = undefined;
+                this.connect();
+            }, RECONNECT_WAIT_MS);
+        }
+    }
+    receiveMessage(msg) {
+        if (VERBOSE_LOGGING) {
+            console.info('< Incoming API websocket message: ', msg);
+        }
+        switch (msg.type) {
+            case 'action': {
+                const action = msg.data;
+                const subscribers = this.subscribers.get(action.type) ?? [];
+                for (const callback of subscribers) {
+                    callback(action);
+                }
+                return;
+            }
+            case 'ack': {
+                if (msg.txid != null) {
+                    const txn = this.txns.get(msg.txid);
+                    if (txn == null) {
+                        // mqp: only reason this should happen is getting an ack after timeout
+                        console.warn(`Websocket message with old txid=${msg.txid}.`);
+                    }
+                    else {
+                        clearTimeout(txn.timeout);
+                        if (msg.error != null) {
+                            txn.reject(new Error(msg.error));
+                        }
+                        else {
+                            txn.resolve();
+                        }
+                        this.txns.delete(msg.txid);
+                    }
+                }
+                return;
+            }
+            default:
+                console.warn(`Unknown API websocket message type received: ${msg}`);
+        }
+    }
+    async sendMessage(type, data) {
+        if (VERBOSE_LOGGING) {
+            console.info(`> Outgoing API websocket ${type} message: `, data);
+        }
+        if (this.state === ws_1.WebSocket.OPEN) {
+            return new Promise((resolve, reject) => {
+                const txid = this.txid++;
+                const timeout = setTimeout(() => {
+                    this.txns.delete(txid);
+                    reject(new Error(`Websocket message with txid ${txid} timed out.`));
+                }, TIMEOUT_MS);
+                this.txns.set(txid, { resolve, reject, timeout });
+                this.ws.send(JSON.stringify({ type, txid, ...data }));
+            });
+        }
+        else {
+            // expected if components in the code try to subscribe or unsubscribe
+            // while the socket is closed -- in this case we expect to get the state
+            // fixed up in the websocket onopen handler when we reconnect
+        }
+    }
+    sendAction(action) {
+        return this.sendMessage('action', {
+            data: action,
+        });
+    }
+    subscribe(action, callback) {
+        const currSubscribers = this.subscribers.get(action) ?? [];
+        this.subscribers.set(action, [
+            ...currSubscribers,
+            callback,
+        ]);
+        return () => {
+            const newSubscribers = currSubscribers.filter((cb) => cb !== callback);
+            this.subscribers.set(action, newSubscribers);
+        };
+    }
+}
+exports.APIRealtimeClient = APIRealtimeClient;
+//# sourceMappingURL=websocket-client.js.map

package/dist/common/websockets/websocket-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-client.js","sourceRoot":"","sources":["../../src/websockets/websocket-client.ts"],"names":[],"mappings":";;;AA4BA,kCAaC;AAzCD,2BAA8B;AAC9B,2CAAkC;AASlC,4BAA4B;AAC5B,MAAM,eAAe,GAAG,KAAK,CAAA;AAE7B,MAAM,UAAU,GAAG,MAAM,CAAA;AAEzB,MAAM,iBAAiB,GAAG,KAAK,CAAA;AAa/B,SAAgB,WAAW,CAAC,KAAiB;IAC3C,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,cAAS,CAAC,UAAU;YACvB,OAAO,YAAY,CAAA;QACrB,KAAK,cAAS,CAAC,IAAI;YACjB,OAAO,MAAM,CAAA;QACf,KAAK,cAAS,CAAC,OAAO;YACpB,OAAO,SAAS,CAAA;QAClB,KAAK,cAAS,CAAC,MAAM;YACnB,OAAO,QAAQ,CAAA;QACjB;YACE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;IAC/C,CAAC;AACH,CAAC;AAQD;;oCAEoC;AACpC,MAAa,iBAAiB;IAC5B,EAAE,CAAY;IACd,GAAG,CAAQ;IACX,8CAA8C;IAC9C,WAAW,CAA+D;IAC1E,IAAI,CAAQ;IACZ,yDAAyD;IACzD,IAAI,CAA6B;IACjC,cAAc,CAAM;IACpB,SAAS,CAAM;IACf,QAAQ,GAAG,KAAK,CAAA;IAChB,OAAO,CAAY;IAEnB,YAAY,GAAW,EAAE,OAAmB;QAC1C,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,CAAC,CAAA;QACb,IAAI,CAAC,IAAI,GAAG,IAAI,GAAG,EAAE,CAAA;QACrB,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAE,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,EAAE,CAAC,UAAwB,CAAA;IACzC,CAAC;IAED,KAAK;QACH,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAA;QACvC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IACnC,CAAC;IAED,OAAO;QACL,+DAA+D;QAC/D,iDAAiD;QACjD,IAAI,CAAC,EAAE,GAAG,IAAI,cAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QACjC,IAAI,CAAC,EAAE,CAAC,SAAS,GAAG,CAAC,EAAE,EAAE,EAAE;YACzB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAClB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAA;gBACrB,OAAO,CAAC,GAAG,CAAC,IAAA,kBAAK,EAAC,cAAc,CAAC,CAAC,CAAA;YACpC,CAAC;YACD,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,IAAW,CAAC,CAAC,CAAA;QACjD,CAAC,CAAA;QACD,IAAI,CAAC,EAAE,CAAC,OAAO,GAAG,CAAC,EAAE,EAAE,EAAE;YACvB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACnB,IAAI,CAAC,OAAO,EAAE,CAAA;gBACd,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;YACtB,CAAC;YACD,yEAAyE;YACzE,+DAA+D;YAC/D,IAAI,CAAC,gBAAgB,EAAE,CAAA;QACzB,CAAC,CAAA;QACD,IAAI,CAAC,EAAE,CAAC,OAAO,GAAG,CAAC,EAAE,EAAE,EAAE;YACvB,kFAAkF;YAClF,IAAI,eAAe,EAAE,CAAC;gBACpB,OAAO,CAAC,IAAI,CAAC,kCAAkC,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,MAAM,EAAE,CAAC,CAAA;YACzE,CAAC;YACD,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YAE7B,0EAA0E;YAC1E,gFAAgF;YAChF,oFAAoF;YACpF,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC;gBACjD,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;gBACzB,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAA;YAChD,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAA;YAEjB,iDAAiD;YACjD,IAAI,EAAE,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;gBACrB,IAAI,CAAC,gBAAgB,EAAE,CAAA;YACzB,CAAC;QACH,CAAC,CAAA;QACD,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACnC,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,CAAC,GAAG,EAAE,EAAE;gBACvB,IAAI,eAAe,EAAE,CAAC;oBACpB,OAAO,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAA;gBACvC,CAAC;gBACD,IAAI,CAAC,SAAS,GAAG,WAAW,CAC1B,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,EACxD,KAAK,CACN,CAAA;gBAED,OAAO,EAAE,CAAA;YACX,CAAC,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,gBAAgB;QACd,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,EAAE,CAAC;YAChC,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC,GAAG,EAAE;gBACpC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAA;gBAC/B,IAAI,CAAC,OAAO,EAAE,CAAA;YAChB,CAAC,EAAE,iBAAiB,CAAC,CAAA;QACvB,CAAC;IACH,CAAC;IAED,cAAc,CAAC,GAAkB;QAC/B,IAAI,eAAe,EAAE,CAAC;YACpB,OAAO,CAAC,IAAI,CAAC,oCAAoC,EAAE,GAAG,CAAC,CAAA;QACzD,CAAC;QACD,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;YACjB,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAA;gBACvB,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAA;gBAC3D,KAAK,MAAM,QAAQ,IAAI,WAAW,EAAE,CAAC;oBACnC,QAAQ,CAAC,MAAM,CAAC,CAAA;gBAClB,CAAC;gBACD,OAAM;YACR,CAAC;YACD,KAAK,KAAK,CAAC,CAAC,CAAC;gBACX,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;oBACrB,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;oBACnC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;wBAChB,sEAAsE;wBACtE,OAAO,CAAC,IAAI,CAAC,mCAAmC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAA;oBAC9D,CAAC;yBAAM,CAAC;wBACN,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;wBACzB,IAAI,GAAG,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;4BACtB,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAA;wBAClC,CAAC;6BAAM,CAAC;4BACN,GAAG,CAAC,OAAO,EAAE,CAAA;wBACf,CAAC;wBACD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;oBAC5B,CAAC;gBACH,CAAC;gBACD,OAAM;YACR,CAAC;YACD;gBACE,OAAO,CAAC,IAAI,CAAC,gDAAgD,GAAG,EAAE,CAAC,CAAA;QACvE,CAAC;IACH,CAAC;IAED,KAAK,CAAC,WAAW,CACf,IAAO,EACP,IAA6C;QAE7C,IAAI,eAAe,EAAE,CAAC;YACpB,OAAO,CAAC,IAAI,CAAC,4BAA4B,IAAI,YAAY,EAAE,IAAI,CAAC,CAAA;QAClE,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,KAAK,cAAS,CAAC,IAAI,EAAE,CAAC;YAClC,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC3C,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAA;gBACxB,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;oBAC9B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;oBACtB,MAAM,CAAC,IAAI,KAAK,CAAC,+BAA+B,IAAI,aAAa,CAAC,CAAC,CAAA;gBACrE,CAAC,EAAE,UAAU,CAAC,CAAA;gBACd,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAA;gBACjD,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,CAAA;YACvD,CAAC,CAAC,CAAA;QACJ,CAAC;aAAM,CAAC;YACN,qEAAqE;YACrE,wEAAwE;YACxE,6DAA6D;QAC/D,CAAC;IACH,CAAC;IAED,UAAU,CAAC,MAAoB;QAC7B,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE;YAChC,IAAI,EAAE,MAAM;SACb,CAAC,CAAA;IACJ,CAAC;IAED,SAAS,CACP,MAAS,EACT,QAA8D;QAE9D,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;QAC1D,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE;YAC3B,GAAG,eAAe;YAClB,QAA0C;SAC3C,CAAC,CAAA;QAEF,OAAO,GAAG,EAAE;YACV,MAAM,cAAc,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAA;YACtE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;QAC9C,CAAC,CAAA;IACH,CAAC;CACF;AAhLD,8CAgLC"}