@atproto/ws-client 0.0.2 → 0.0.4

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atproto/ws-client
 
+## 0.0.4
+
+### Patch Changes
+
+- [#4290](https://github.com/bluesky-social/atproto/pull/4290) [`b4a76ba`](https://github.com/bluesky-social/atproto/commit/b4a76bae7bef1189302488d43ce49a03fd61f957) Thanks [@dholms](https://github.com/dholms)! - Support sending data on websocket as well as an onReconnect callback
+
+## 0.0.3
+
+### Patch Changes
+
+- Updated dependencies [[`261968fd6`](https://github.com/bluesky-social/atproto/commit/261968fd65014ded613e2bf085d61a7864b8fba7), [`261968fd6`](https://github.com/bluesky-social/atproto/commit/261968fd65014ded613e2bf085d61a7864b8fba7), [`261968fd6`](https://github.com/bluesky-social/atproto/commit/261968fd65014ded613e2bf085d61a7864b8fba7)]:
+  - @atproto/common@0.5.0
+
 ## 0.0.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export declare class WebSocketKeepAlive {
         maxReconnectSeconds?: number;
         signal?: AbortSignal;
         heartbeatIntervalMs?: number;
+        onReconnect?: () => void;
         onReconnectError?: (error: unknown, n: number, initialSetup: boolean) => void;
     };
     ws: WebSocket | null;
@@ -15,9 +16,12 @@ export declare class WebSocketKeepAlive {
         maxReconnectSeconds?: number;
         signal?: AbortSignal;
         heartbeatIntervalMs?: number;
+        onReconnect?: () => void;
         onReconnectError?: (error: unknown, n: number, initialSetup: boolean) => void;
     });
     [Symbol.asyncIterator](): AsyncGenerator<Uint8Array>;
+    send(data: string | Buffer): Promise<void>;
+    isConnected(): boolean;
     startHeartbeat(ws: WebSocket): void;
 }
 export default WebSocketKeepAlive;

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,SAAS,EAAyB,MAAM,IAAI,CAAA;AAGpE,qBAAa,kBAAkB;IAMpB,IAAI,EAAE,aAAa,GAAG;QAC3B,MAAM,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;QAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAA;QAC5B,MAAM,CAAC,EAAE,WAAW,CAAA;QACpB,mBAAmB,CAAC,EAAE,MAAM,CAAA;QAC5B,gBAAgB,CAAC,EAAE,CACjB,KAAK,EAAE,OAAO,EACd,CAAC,EAAE,MAAM,EACT,YAAY,EAAE,OAAO,KAClB,IAAI,CAAA;KACV;IAfI,EAAE,EAAE,SAAS,GAAG,IAAI,CAAO;IAC3B,YAAY,UAAO;IACnB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAO;gBAG9B,IAAI,EAAE,aAAa,GAAG;QAC3B,MAAM,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;QAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAA;QAC5B,MAAM,CAAC,EAAE,WAAW,CAAA;QACpB,mBAAmB,CAAC,EAAE,MAAM,CAAA;QAC5B,gBAAgB,CAAC,EAAE,CACjB,KAAK,EAAE,OAAO,EACd,CAAC,EAAE,MAAM,EACT,YAAY,EAAE,OAAO,KAClB,IAAI,CAAA;KACV;IAGI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,cAAc,CAAC,UAAU,CAAC;IA8D3D,cAAc,CAAC,EAAE,EAAE,SAAS;CA4B7B;AAED,eAAe,kBAAkB,CAAA;AAMjC,qBAAa,eAAgB,SAAQ,KAAK;IAE/B,MAAM,EAAE,SAAS;IACjB,QAAQ,CAAC,EAAE,MAAM;gBADjB,MAAM,GAAE,SAA4B,EACpC,QAAQ,CAAC,EAAE,MAAM,YAAA;CAI3B;AAGD,oBAAY,SAAS;IACnB,MAAM,OAAO;IACb,QAAQ,OAAO;IACf,MAAM,OAAO;CACd"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,SAAS,EAAyB,MAAM,IAAI,CAAA;AAGpE,qBAAa,kBAAkB;IAMpB,IAAI,EAAE,aAAa,GAAG;QAC3B,MAAM,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;QAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAA;QAC5B,MAAM,CAAC,EAAE,WAAW,CAAA;QACpB,mBAAmB,CAAC,EAAE,MAAM,CAAA;QAC5B,WAAW,CAAC,EAAE,MAAM,IAAI,CAAA;QACxB,gBAAgB,CAAC,EAAE,CACjB,KAAK,EAAE,OAAO,EACd,CAAC,EAAE,MAAM,EACT,YAAY,EAAE,OAAO,KAClB,IAAI,CAAA;KACV;IAhBI,EAAE,EAAE,SAAS,GAAG,IAAI,CAAO;IAC3B,YAAY,UAAO;IACnB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAO;gBAG9B,IAAI,EAAE,aAAa,GAAG;QAC3B,MAAM,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;QAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAA;QAC5B,MAAM,CAAC,EAAE,WAAW,CAAA;QACpB,mBAAmB,CAAC,EAAE,MAAM,CAAA;QAC5B,WAAW,CAAC,EAAE,MAAM,IAAI,CAAA;QACxB,gBAAgB,CAAC,EAAE,CACjB,KAAK,EAAE,OAAO,EACd,CAAC,EAAE,MAAM,EACT,YAAY,EAAE,OAAO,KAClB,IAAI,CAAA;KACV;IAGI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,cAAc,CAAC,UAAU,CAAC;IAiE3D,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB1C,WAAW,IAAI,OAAO;IAItB,cAAc,CAAC,EAAE,EAAE,SAAS;CA4B7B;AAED,eAAe,kBAAkB,CAAA;AAMjC,qBAAa,eAAgB,SAAQ,KAAK;IAE/B,MAAM,EAAE,SAAS;IACjB,QAAQ,CAAC,EAAE,MAAM;gBADjB,MAAM,GAAE,SAA4B,EACpC,QAAQ,CAAC,EAAE,MAAM,YAAA;CAI3B;AAGD,oBAAY,SAAS;IACnB,MAAM,OAAO;IACb,QAAQ,OAAO;IACf,MAAM,OAAO;CACd"}

package/dist/index.js

@@ -46,6 +46,9 @@ class WebSocketKeepAlive {
                 forwardSignal(this.opts.signal, ac);
             }
             this.ws.once('open', () => {
+                if (!this.initialSetup && this.opts.onReconnect) {
+                    this.opts.onReconnect();
+                }
                 this.initialSetup = false;
                 this.reconnects = 0;
                 if (this.ws) {
@@ -89,6 +92,25 @@ class WebSocketKeepAlive {
             break; // Other side cleanly ended stream and disconnected
         }
     }
+    send(data) {
+        return new Promise((resolve, reject) => {
+            if (!this.ws || this.ws.readyState !== 1 /* OPEN */) {
+                reject(new Error('WebSocket is not connected'));
+                return;
+            }
+            this.ws.send(data, (err) => {
+                if (err) {
+                    reject(err);
+                }
+                else {
+                    resolve();
+                }
+            });
+        });
+    }
+    isConnected() {
+        return this.ws !== null && this.ws.readyState === 1;
+    }
     startHeartbeat(ws) {
         let isAlive = true;
         let heartbeatInterval = null;

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,2BAAoE;AACpE,4CAAgE;AAEhE,MAAa,kBAAkB;IAK7B,YACS,IAUN;QAVD;;;;mBAAO,IAAI;WAUV;QAfI;;;;mBAAuB,IAAI;WAAA;QAC3B;;;;mBAAe,IAAI;WAAA;QACnB;;;;mBAA4B,IAAI;WAAA;IAcpC,CAAC;IAEJ,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;QAC3B,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,IAAI,EAAE,CAAC,CAAA;QACnE,OAAO,IAAI,EAAE,CAAC;YACZ,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;gBAC7B,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY;oBAChC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,cAAc,CAAC;oBAChC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,cAAc,CAAC,CAAA;gBAChD,MAAM,IAAA,aAAI,EAAC,QAAQ,CAAC,CAAA;YACtB,CAAC;YACD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAA;YACpC,IAAI,CAAC,EAAE,GAAG,IAAI,cAAS,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;YACvC,MAAM,EAAE,GAAG,IAAI,eAAe,EAAE,CAAA;YAChC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACrB,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;YACrC,CAAC;YACD,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE;gBACxB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAA;gBACzB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAA;gBACnB,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;oBACZ,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;gBAC9B,CAAC;YACH,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;gBACrC,IAAI,IAAI,KAAK,SAAS,CAAC,QAAQ,EAAE,CAAC;oBAChC,0DAA0D;oBAC1D,EAAE,CAAC,KAAK,CACN,IAAI,kBAAkB,CAAC,sBAAsB,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAClE,CAAA;gBACH,CAAC;YACH,CAAC,CAAC,CAAA;YAEF,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,IAAA,0BAAqB,EAAC,IAAI,CAAC,EAAE,EAAE;oBAC9C,MAAM,EAAE,EAAE,CAAC,MAAM;oBACjB,kBAAkB,EAAE,IAAI,EAAE,2DAA2D;iBACtF,CAAC,CAAA;gBACF,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;oBACnC,MAAM,KAAK,CAAA;gBACb,CAAC;YACH,CAAC;YAAC,OAAO,IAAI,EAAE,CAAC;gBACd,MAAM,GAAG,GACP,IAAA,yBAAgB,EAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW;oBACjD,CAAC,CAAC,IAAI,CAAC,KAAK;oBACZ,CAAC,CAAC,IAAI,CAAA;gBACV,IAAI,GAAG,YAAY,eAAe,EAAE,CAAC;oBACnC,gCAAgC;oBAChC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;oBAC1B,MAAK;gBACP,CAAC;gBACD,IAAI,CAAC,EAAE,EAAE,KAAK,EAAE,CAAA,CAAC,sCAAsC;gBACvD,IAAI,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC;oBACzB,IAAI,CAAC,UAAU,KAAf,IAAI,CAAC,UAAU,GAAK,CAAC,EAAA,CAAC,8BAA8B;oBACpD,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC,CAAA;oBACrE,SAAQ;gBACV,CAAC;qBAAM,CAAC;oBACN,MAAM,GAAG,CAAA;gBACX,CAAC;YACH,CAAC;YACD,MAAK,CAAC,mDAAmD;QAC3D,CAAC;IACH,CAAC;IAED,cAAc,CAAC,EAAa;QAC1B,IAAI,OAAO,GAAG,IAAI,CAAA;QAClB,IAAI,iBAAiB,GAA0B,IAAI,CAAA;QAEnD,MAAM,UAAU,GAAG,GAAG,EAAE;YACtB,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,OAAO,EAAE,CAAC,SAAS,EAAE,CAAA;YACvB,CAAC;YACD,OAAO,GAAG,KAAK,CAAA,CAAC,wFAAwF;YACxG,EAAE,CAAC,IAAI,EAAE,CAAA;QACX,CAAC,CAAA;QAED,UAAU,EAAE,CAAA;QACZ,iBAAiB,GAAG,WAAW,CAC7B,UAAU,EACV,IAAI,CAAC,IAAI,CAAC,mBAAmB,IAAI,EAAE,GAAG,eAAM,CAC7C,CAAA;QAED,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE;YACjB,OAAO,GAAG,IAAI,CAAA;QAChB,CAAC,CAAC,CAAA;QACF,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;YACpB,IAAI,iBAAiB,EAAE,CAAC;gBACtB,aAAa,CAAC,iBAAiB,CAAC,CAAA;gBAChC,iBAAiB,GAAG,IAAI,CAAA;YAC1B,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;CACF;AA7GD,gDA6GC;AAED,kBAAe,kBAAkB,CAAA;AAEjC,MAAM,kBAAmB,SAAQ,KAAK;IAAtC;;QACE;;;;mBAAO,kBAAkB;WAAA;IAC3B,CAAC;CAAA;AAED,MAAa,eAAgB,SAAQ,KAAK;IACxC,YACS,SAAoB,SAAS,CAAC,MAAM,EACpC,QAAiB;QAExB,KAAK,EAAE,CAAA;QAHP;;;;mBAAO,MAAM;WAA8B;QAC3C;;;;mBAAO,QAAQ;WAAS;IAG1B,CAAC;CACF;AAPD,0CAOC;AAED,uDAAuD;AACvD,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,gDAAa,CAAA;IACb,oDAAe,CAAA;IACf,gDAAa,CAAA;AACf,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB;AAED,SAAS,eAAe,CAAC,GAAY;IACnC,oCAAoC;IACpC,8EAA8E;IAC9E,qFAAqF;IACrF,yFAAyF;IACzF,IAAI,IAAA,yBAAgB,EAAC,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC1D,OAAO,iBAAiB,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAC7C,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED,MAAM,iBAAiB,GAAG;IACxB,kBAAkB;IAClB,YAAY;IACZ,cAAc;IACd,cAAc;IACd,OAAO;IACP,WAAW;IACX,WAAW;CACZ,CAAA;AAED,SAAS,SAAS,CAAC,CAAS,EAAE,KAAa;IACzC,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA,CAAC,eAAe;IAC9C,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAA,CAAC,2CAA2C;IAC/E,MAAM,EAAE,GAAG,IAAI,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC,CAAA;IACrC,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;AAC5B,CAAC;AAED,SAAS,aAAa,CAAC,MAAmB,EAAE,EAAmB;IAC7D,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,OAAO,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAChC,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;YAC9D,2EAA2E;YAC3E,MAAM,EAAE,EAAE,CAAC,MAAM;SAClB,CAAC,CAAA;IACJ,CAAC;AACH,CAAC","sourcesContent":["import { ClientOptions, WebSocket, createWebSocketStream } from 'ws'\nimport { SECOND, isErrnoException, wait } from '@atproto/common'\n\nexport class WebSocketKeepAlive {\n  public ws: WebSocket | null = null\n  public initialSetup = true\n  public reconnects: number | null = null\n\n  constructor(\n    public opts: ClientOptions & {\n      getUrl: () => Promise<string>\n      maxReconnectSeconds?: number\n      signal?: AbortSignal\n      heartbeatIntervalMs?: number\n      onReconnectError?: (\n        error: unknown,\n        n: number,\n        initialSetup: boolean,\n      ) => void\n    },\n  ) {}\n\n  async *[Symbol.asyncIterator](): AsyncGenerator<Uint8Array> {\n    const maxReconnectMs = 1000 * (this.opts.maxReconnectSeconds ?? 64)\n    while (true) {\n      if (this.reconnects !== null) {\n        const duration = this.initialSetup\n          ? Math.min(1000, maxReconnectMs)\n          : backoffMs(this.reconnects++, maxReconnectMs)\n        await wait(duration)\n      }\n      const url = await this.opts.getUrl()\n      this.ws = new WebSocket(url, this.opts)\n      const ac = new AbortController()\n      if (this.opts.signal) {\n        forwardSignal(this.opts.signal, ac)\n      }\n      this.ws.once('open', () => {\n        this.initialSetup = false\n        this.reconnects = 0\n        if (this.ws) {\n          this.startHeartbeat(this.ws)\n        }\n      })\n      this.ws.once('close', (code, reason) => {\n        if (code === CloseCode.Abnormal) {\n          // Forward into an error to distinguish from a clean close\n          ac.abort(\n            new AbnormalCloseError(`Abnormal ws close: ${reason.toString()}`),\n          )\n        }\n      })\n\n      try {\n        const wsStream = createWebSocketStream(this.ws, {\n          signal: ac.signal,\n          readableObjectMode: true, // Ensures frame bytes don't get buffered/combined together\n        })\n        for await (const chunk of wsStream) {\n          yield chunk\n        }\n      } catch (_err) {\n        const err =\n          isErrnoException(_err) && _err.code === 'ABORT_ERR'\n            ? _err.cause\n            : _err\n        if (err instanceof DisconnectError) {\n          // We cleanly end the connection\n          this.ws?.close(err.wsCode)\n          break\n        }\n        this.ws?.close() // No-ops if already closed or closing\n        if (isReconnectable(err)) {\n          this.reconnects ??= 0 // Never reconnect with a null\n          this.opts.onReconnectError?.(err, this.reconnects, this.initialSetup)\n          continue\n        } else {\n          throw err\n        }\n      }\n      break // Other side cleanly ended stream and disconnected\n    }\n  }\n\n  startHeartbeat(ws: WebSocket) {\n    let isAlive = true\n    let heartbeatInterval: NodeJS.Timeout | null = null\n\n    const checkAlive = () => {\n      if (!isAlive) {\n        return ws.terminate()\n      }\n      isAlive = false // expect websocket to no longer be alive unless we receive a \"pong\" within the interval\n      ws.ping()\n    }\n\n    checkAlive()\n    heartbeatInterval = setInterval(\n      checkAlive,\n      this.opts.heartbeatIntervalMs ?? 10 * SECOND,\n    )\n\n    ws.on('pong', () => {\n      isAlive = true\n    })\n    ws.once('close', () => {\n      if (heartbeatInterval) {\n        clearInterval(heartbeatInterval)\n        heartbeatInterval = null\n      }\n    })\n  }\n}\n\nexport default WebSocketKeepAlive\n\nclass AbnormalCloseError extends Error {\n  code = 'EWSABNORMALCLOSE'\n}\n\nexport class DisconnectError extends Error {\n  constructor(\n    public wsCode: CloseCode = CloseCode.Policy,\n    public xrpcCode?: string,\n  ) {\n    super()\n  }\n}\n\n// https://www.rfc-editor.org/rfc/rfc6455#section-7.4.1\nexport enum CloseCode {\n  Normal = 1000,\n  Abnormal = 1006,\n  Policy = 1008,\n}\n\nfunction isReconnectable(err: unknown): boolean {\n  // Network errors are reconnectable.\n  // AuthenticationRequired and InvalidRequest XRPCErrors are not reconnectable.\n  // @TODO method-specific XRPCErrors may be reconnectable, need to consider. Receiving\n  // an invalid message is not current reconnectable, but the user can decide to skip them.\n  if (isErrnoException(err) && typeof err.code === 'string') {\n    return networkErrorCodes.includes(err.code)\n  }\n  return false\n}\n\nconst networkErrorCodes = [\n  'EWSABNORMALCLOSE',\n  'ECONNRESET',\n  'ECONNREFUSED',\n  'ECONNABORTED',\n  'EPIPE',\n  'ETIMEDOUT',\n  'ECANCELED',\n]\n\nfunction backoffMs(n: number, maxMs: number) {\n  const baseSec = Math.pow(2, n) // 1, 2, 4, ...\n  const randSec = Math.random() - 0.5 // Random jitter between -.5 and .5 seconds\n  const ms = 1000 * (baseSec + randSec)\n  return Math.min(ms, maxMs)\n}\n\nfunction forwardSignal(signal: AbortSignal, ac: AbortController) {\n  if (signal.aborted) {\n    return ac.abort(signal.reason)\n  } else {\n    signal.addEventListener('abort', () => ac.abort(signal.reason), {\n      // @ts-ignore https://github.com/DefinitelyTyped/DefinitelyTyped/pull/68625\n      signal: ac.signal,\n    })\n  }\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,2BAAoE;AACpE,4CAAgE;AAEhE,MAAa,kBAAkB;IAK7B,YACS,IAWN;QAXD;;;;mBAAO,IAAI;WAWV;QAhBI;;;;mBAAuB,IAAI;WAAA;QAC3B;;;;mBAAe,IAAI;WAAA;QACnB;;;;mBAA4B,IAAI;WAAA;IAepC,CAAC;IAEJ,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;QAC3B,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,IAAI,EAAE,CAAC,CAAA;QACnE,OAAO,IAAI,EAAE,CAAC;YACZ,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;gBAC7B,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY;oBAChC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,cAAc,CAAC;oBAChC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,cAAc,CAAC,CAAA;gBAChD,MAAM,IAAA,aAAI,EAAC,QAAQ,CAAC,CAAA;YACtB,CAAC;YACD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAA;YACpC,IAAI,CAAC,EAAE,GAAG,IAAI,cAAS,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;YACvC,MAAM,EAAE,GAAG,IAAI,eAAe,EAAE,CAAA;YAChC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACrB,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;YACrC,CAAC;YACD,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE;gBACxB,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;oBAChD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAA;gBACzB,CAAC;gBACD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAA;gBACzB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAA;gBACnB,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;oBACZ,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;gBAC9B,CAAC;YACH,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;gBACrC,IAAI,IAAI,KAAK,SAAS,CAAC,QAAQ,EAAE,CAAC;oBAChC,0DAA0D;oBAC1D,EAAE,CAAC,KAAK,CACN,IAAI,kBAAkB,CAAC,sBAAsB,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAClE,CAAA;gBACH,CAAC;YACH,CAAC,CAAC,CAAA;YAEF,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,IAAA,0BAAqB,EAAC,IAAI,CAAC,EAAE,EAAE;oBAC9C,MAAM,EAAE,EAAE,CAAC,MAAM;oBACjB,kBAAkB,EAAE,IAAI,EAAE,2DAA2D;iBACtF,CAAC,CAAA;gBACF,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;oBACnC,MAAM,KAAK,CAAA;gBACb,CAAC;YACH,CAAC;YAAC,OAAO,IAAI,EAAE,CAAC;gBACd,MAAM,GAAG,GACP,IAAA,yBAAgB,EAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW;oBACjD,CAAC,CAAC,IAAI,CAAC,KAAK;oBACZ,CAAC,CAAC,IAAI,CAAA;gBACV,IAAI,GAAG,YAAY,eAAe,EAAE,CAAC;oBACnC,gCAAgC;oBAChC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;oBAC1B,MAAK;gBACP,CAAC;gBACD,IAAI,CAAC,EAAE,EAAE,KAAK,EAAE,CAAA,CAAC,sCAAsC;gBACvD,IAAI,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC;oBACzB,IAAI,CAAC,UAAU,KAAf,IAAI,CAAC,UAAU,GAAK,CAAC,EAAA,CAAC,8BAA8B;oBACpD,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC,CAAA;oBACrE,SAAQ;gBACV,CAAC;qBAAM,CAAC;oBACN,MAAM,GAAG,CAAA;gBACX,CAAC;YACH,CAAC;YACD,MAAK,CAAC,mDAAmD;QAC3D,CAAC;IACH,CAAC;IAED,IAAI,CAAC,IAAqB;QACxB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,EAAE,CAAC,UAAU,KAAK,CAAC,CAAC,UAAU,EAAE,CAAC;gBACpD,MAAM,CAAC,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC,CAAA;gBAC/C,OAAM;YACR,CAAC;YACD,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE;gBACzB,IAAI,GAAG,EAAE,CAAC;oBACR,MAAM,CAAC,GAAG,CAAC,CAAA;gBACb,CAAC;qBAAM,CAAC;oBACN,OAAO,EAAE,CAAA;gBACX,CAAC;YACH,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,EAAE,KAAK,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC,UAAU,KAAK,CAAC,CAAA;IACrD,CAAC;IAED,cAAc,CAAC,EAAa;QAC1B,IAAI,OAAO,GAAG,IAAI,CAAA;QAClB,IAAI,iBAAiB,GAA0B,IAAI,CAAA;QAEnD,MAAM,UAAU,GAAG,GAAG,EAAE;YACtB,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,OAAO,EAAE,CAAC,SAAS,EAAE,CAAA;YACvB,CAAC;YACD,OAAO,GAAG,KAAK,CAAA,CAAC,wFAAwF;YACxG,EAAE,CAAC,IAAI,EAAE,CAAA;QACX,CAAC,CAAA;QAED,UAAU,EAAE,CAAA;QACZ,iBAAiB,GAAG,WAAW,CAC7B,UAAU,EACV,IAAI,CAAC,IAAI,CAAC,mBAAmB,IAAI,EAAE,GAAG,eAAM,CAC7C,CAAA;QAED,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE;YACjB,OAAO,GAAG,IAAI,CAAA;QAChB,CAAC,CAAC,CAAA;QACF,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;YACpB,IAAI,iBAAiB,EAAE,CAAC;gBACtB,aAAa,CAAC,iBAAiB,CAAC,CAAA;gBAChC,iBAAiB,GAAG,IAAI,CAAA;YAC1B,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;CACF;AArID,gDAqIC;AAED,kBAAe,kBAAkB,CAAA;AAEjC,MAAM,kBAAmB,SAAQ,KAAK;IAAtC;;QACE;;;;mBAAO,kBAAkB;WAAA;IAC3B,CAAC;CAAA;AAED,MAAa,eAAgB,SAAQ,KAAK;IACxC,YACS,SAAoB,SAAS,CAAC,MAAM,EACpC,QAAiB;QAExB,KAAK,EAAE,CAAA;QAHP;;;;mBAAO,MAAM;WAA8B;QAC3C;;;;mBAAO,QAAQ;WAAS;IAG1B,CAAC;CACF;AAPD,0CAOC;AAED,uDAAuD;AACvD,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,gDAAa,CAAA;IACb,oDAAe,CAAA;IACf,gDAAa,CAAA;AACf,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB;AAED,SAAS,eAAe,CAAC,GAAY;IACnC,oCAAoC;IACpC,8EAA8E;IAC9E,qFAAqF;IACrF,yFAAyF;IACzF,IAAI,IAAA,yBAAgB,EAAC,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC1D,OAAO,iBAAiB,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAC7C,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED,MAAM,iBAAiB,GAAG;IACxB,kBAAkB;IAClB,YAAY;IACZ,cAAc;IACd,cAAc;IACd,OAAO;IACP,WAAW;IACX,WAAW;CACZ,CAAA;AAED,SAAS,SAAS,CAAC,CAAS,EAAE,KAAa;IACzC,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA,CAAC,eAAe;IAC9C,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAA,CAAC,2CAA2C;IAC/E,MAAM,EAAE,GAAG,IAAI,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC,CAAA;IACrC,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;AAC5B,CAAC;AAED,SAAS,aAAa,CAAC,MAAmB,EAAE,EAAmB;IAC7D,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,OAAO,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAChC,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;YAC9D,2EAA2E;YAC3E,MAAM,EAAE,EAAE,CAAC,MAAM;SAClB,CAAC,CAAA;IACJ,CAAC;AACH,CAAC","sourcesContent":["import { ClientOptions, WebSocket, createWebSocketStream } from 'ws'\nimport { SECOND, isErrnoException, wait } from '@atproto/common'\n\nexport class WebSocketKeepAlive {\n  public ws: WebSocket | null = null\n  public initialSetup = true\n  public reconnects: number | null = null\n\n  constructor(\n    public opts: ClientOptions & {\n      getUrl: () => Promise<string>\n      maxReconnectSeconds?: number\n      signal?: AbortSignal\n      heartbeatIntervalMs?: number\n      onReconnect?: () => void\n      onReconnectError?: (\n        error: unknown,\n        n: number,\n        initialSetup: boolean,\n      ) => void\n    },\n  ) {}\n\n  async *[Symbol.asyncIterator](): AsyncGenerator<Uint8Array> {\n    const maxReconnectMs = 1000 * (this.opts.maxReconnectSeconds ?? 64)\n    while (true) {\n      if (this.reconnects !== null) {\n        const duration = this.initialSetup\n          ? Math.min(1000, maxReconnectMs)\n          : backoffMs(this.reconnects++, maxReconnectMs)\n        await wait(duration)\n      }\n      const url = await this.opts.getUrl()\n      this.ws = new WebSocket(url, this.opts)\n      const ac = new AbortController()\n      if (this.opts.signal) {\n        forwardSignal(this.opts.signal, ac)\n      }\n      this.ws.once('open', () => {\n        if (!this.initialSetup && this.opts.onReconnect) {\n          this.opts.onReconnect()\n        }\n        this.initialSetup = false\n        this.reconnects = 0\n        if (this.ws) {\n          this.startHeartbeat(this.ws)\n        }\n      })\n      this.ws.once('close', (code, reason) => {\n        if (code === CloseCode.Abnormal) {\n          // Forward into an error to distinguish from a clean close\n          ac.abort(\n            new AbnormalCloseError(`Abnormal ws close: ${reason.toString()}`),\n          )\n        }\n      })\n\n      try {\n        const wsStream = createWebSocketStream(this.ws, {\n          signal: ac.signal,\n          readableObjectMode: true, // Ensures frame bytes don't get buffered/combined together\n        })\n        for await (const chunk of wsStream) {\n          yield chunk\n        }\n      } catch (_err) {\n        const err =\n          isErrnoException(_err) && _err.code === 'ABORT_ERR'\n            ? _err.cause\n            : _err\n        if (err instanceof DisconnectError) {\n          // We cleanly end the connection\n          this.ws?.close(err.wsCode)\n          break\n        }\n        this.ws?.close() // No-ops if already closed or closing\n        if (isReconnectable(err)) {\n          this.reconnects ??= 0 // Never reconnect with a null\n          this.opts.onReconnectError?.(err, this.reconnects, this.initialSetup)\n          continue\n        } else {\n          throw err\n        }\n      }\n      break // Other side cleanly ended stream and disconnected\n    }\n  }\n\n  send(data: string | Buffer): Promise<void> {\n    return new Promise((resolve, reject) => {\n      if (!this.ws || this.ws.readyState !== 1 /* OPEN */) {\n        reject(new Error('WebSocket is not connected'))\n        return\n      }\n      this.ws.send(data, (err) => {\n        if (err) {\n          reject(err)\n        } else {\n          resolve()\n        }\n      })\n    })\n  }\n\n  isConnected(): boolean {\n    return this.ws !== null && this.ws.readyState === 1\n  }\n\n  startHeartbeat(ws: WebSocket) {\n    let isAlive = true\n    let heartbeatInterval: NodeJS.Timeout | null = null\n\n    const checkAlive = () => {\n      if (!isAlive) {\n        return ws.terminate()\n      }\n      isAlive = false // expect websocket to no longer be alive unless we receive a \"pong\" within the interval\n      ws.ping()\n    }\n\n    checkAlive()\n    heartbeatInterval = setInterval(\n      checkAlive,\n      this.opts.heartbeatIntervalMs ?? 10 * SECOND,\n    )\n\n    ws.on('pong', () => {\n      isAlive = true\n    })\n    ws.once('close', () => {\n      if (heartbeatInterval) {\n        clearInterval(heartbeatInterval)\n        heartbeatInterval = null\n      }\n    })\n  }\n}\n\nexport default WebSocketKeepAlive\n\nclass AbnormalCloseError extends Error {\n  code = 'EWSABNORMALCLOSE'\n}\n\nexport class DisconnectError extends Error {\n  constructor(\n    public wsCode: CloseCode = CloseCode.Policy,\n    public xrpcCode?: string,\n  ) {\n    super()\n  }\n}\n\n// https://www.rfc-editor.org/rfc/rfc6455#section-7.4.1\nexport enum CloseCode {\n  Normal = 1000,\n  Abnormal = 1006,\n  Policy = 1008,\n}\n\nfunction isReconnectable(err: unknown): boolean {\n  // Network errors are reconnectable.\n  // AuthenticationRequired and InvalidRequest XRPCErrors are not reconnectable.\n  // @TODO method-specific XRPCErrors may be reconnectable, need to consider. Receiving\n  // an invalid message is not current reconnectable, but the user can decide to skip them.\n  if (isErrnoException(err) && typeof err.code === 'string') {\n    return networkErrorCodes.includes(err.code)\n  }\n  return false\n}\n\nconst networkErrorCodes = [\n  'EWSABNORMALCLOSE',\n  'ECONNRESET',\n  'ECONNREFUSED',\n  'ECONNABORTED',\n  'EPIPE',\n  'ETIMEDOUT',\n  'ECANCELED',\n]\n\nfunction backoffMs(n: number, maxMs: number) {\n  const baseSec = Math.pow(2, n) // 1, 2, 4, ...\n  const randSec = Math.random() - 0.5 // Random jitter between -.5 and .5 seconds\n  const ms = 1000 * (baseSec + randSec)\n  return Math.min(ms, maxMs)\n}\n\nfunction forwardSignal(signal: AbortSignal, ac: AbortController) {\n  if (signal.aborted) {\n    return ac.abort(signal.reason)\n  } else {\n    signal.addEventListener('abort', () => ac.abort(signal.reason), {\n      // @ts-ignore https://github.com/DefinitelyTyped/DefinitelyTyped/pull/68625\n      signal: ac.signal,\n    })\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/ws-client",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "license": "MIT",
   "description": "Websocket client library",
   "keywords": [
@@ -20,7 +20,7 @@
   "types": "dist/index.d.ts",
   "dependencies": {
     "ws": "^8.12.0",
-    "@atproto/common": "^0.4.12"
+    "@atproto/common": "^0.5.3"
   },
   "devDependencies": {
     "@types/ws": "^8.5.4",

package/src/index.ts

@@ -12,6 +12,7 @@ export class WebSocketKeepAlive {
       maxReconnectSeconds?: number
       signal?: AbortSignal
       heartbeatIntervalMs?: number
+      onReconnect?: () => void
       onReconnectError?: (
         error: unknown,
         n: number,
@@ -36,6 +37,9 @@ export class WebSocketKeepAlive {
         forwardSignal(this.opts.signal, ac)
       }
       this.ws.once('open', () => {
+        if (!this.initialSetup && this.opts.onReconnect) {
+          this.opts.onReconnect()
+        }
         this.initialSetup = false
         this.reconnects = 0
         if (this.ws) {
@@ -82,6 +86,26 @@ export class WebSocketKeepAlive {
     }
   }
 
+  send(data: string | Buffer): Promise<void> {
+    return new Promise((resolve, reject) => {
+      if (!this.ws || this.ws.readyState !== 1 /* OPEN */) {
+        reject(new Error('WebSocket is not connected'))
+        return
+      }
+      this.ws.send(data, (err) => {
+        if (err) {
+          reject(err)
+        } else {
+          resolve()
+        }
+      })
+    })
+  }
+
+  isConnected(): boolean {
+    return this.ws !== null && this.ws.readyState === 1
+  }
+
   startHeartbeat(ws: WebSocket) {
     let isAlive = true
     let heartbeatInterval: NodeJS.Timeout | null = null