@abraca/dabra 0.1.7 → 0.2.0

package/dist/index.d.ts

@@ -768,6 +768,7 @@ interface CompleteHocuspocusProviderConfiguration {
   forceSyncInterval: false | number;
   onAuthenticated: (data: onAuthenticatedParameters) => void;
   onAuthenticationFailed: (data: onAuthenticationFailedParameters) => void;
+  onRateLimited: () => void;
   onOpen: (data: onOpenParameters) => void;
   onConnect: () => void;
   onStatus: (data: onStatusParameters) => void;
@@ -809,6 +810,7 @@ declare class HocuspocusProvider extends EventEmitter {
   forwardClose: (e: onCloseParameters) => this;
   forwardDisconnect: (e: onDisconnectParameters) => this;
   forwardDestroy: () => this;
+  forwardRateLimited: () => this;
   setConfiguration(configuration?: Partial<HocuspocusProviderConfiguration>): void;
   get document(): Y.Doc;
   get isAttached(): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abraca/dabra",
-  "version": "0.1.7",
+  "version": "0.2.0",
   "description": "abracadabra provider",
   "keywords": [
     "abracadabra",

package/src/HocuspocusProvider.ts

@@ -78,6 +78,7 @@ export interface CompleteHocuspocusProviderConfiguration {
 
   onAuthenticated: (data: onAuthenticatedParameters) => void;
   onAuthenticationFailed: (data: onAuthenticationFailedParameters) => void;
+  onRateLimited: () => void;
   onOpen: (data: onOpenParameters) => void;
   onConnect: () => void;
   onStatus: (data: onStatusParameters) => void;
@@ -108,6 +109,7 @@ export class HocuspocusProvider extends EventEmitter {
     forceSyncInterval: false,
     onAuthenticated: () => null,
     onAuthenticationFailed: () => null,
+    onRateLimited: () => null,
     onOpen: () => null,
     onConnect: () => null,
     onMessage: () => null,
@@ -162,6 +164,7 @@ export class HocuspocusProvider extends EventEmitter {
 
     this.on("authenticated", this.configuration.onAuthenticated);
     this.on("authenticationFailed", this.configuration.onAuthenticationFailed);
+    this.on("rateLimited", this.configuration.onRateLimited);
 
     this.awareness?.on("update", () => {
       this.emit("awarenessUpdate", {
@@ -215,6 +218,8 @@ export class HocuspocusProvider extends EventEmitter {
 
   forwardDestroy = () => this.emit("destroy");
 
+  forwardRateLimited = () => this.emit("rateLimited");
+
   public setConfiguration(configuration: Partial<HocuspocusProviderConfiguration> = {}): void {
     if (!configuration.websocketProvider) {
       this.manageSocket = true;
@@ -492,6 +497,8 @@ export class HocuspocusProvider extends EventEmitter {
     this.configuration.websocketProvider.off("destroy", this.configuration.onDestroy);
     this.configuration.websocketProvider.off("destroy", this.forwardDestroy);
 
+    this.configuration.websocketProvider.off("rateLimited", this.forwardRateLimited);
+
     this.configuration.websocketProvider.detach(this);
 
     this._isAttached = false;
@@ -518,6 +525,8 @@ export class HocuspocusProvider extends EventEmitter {
     this.configuration.websocketProvider.on("destroy", this.configuration.onDestroy);
     this.configuration.websocketProvider.on("destroy", this.forwardDestroy);
 
+    this.configuration.websocketProvider.on("rateLimited", this.forwardRateLimited);
+
     this.configuration.websocketProvider.attach(this);
 
     this._isAttached = true;

package/src/HocuspocusProviderWebsocket.ts

@@ -500,13 +500,21 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
     // Let’s update the connection status.
     this.status = WebSocketStatus.Disconnected;
     this.emit("status", { status: WebSocketStatus.Disconnected });
+
+    // Detect server-side rate-limit close (code 4429).
+    const isRateLimited = (event as any)?.code === 4429;
     this.emit("disconnect", { event });
+    if (isRateLimited) {
+      this.emit("rateLimited");
+    }
 
     // trigger connect if no retry is running and we want to have a connection
     if (!this.cancelWebsocketRetry && this.shouldConnect) {
+      // Apply a much longer delay for rate-limited closes to let the server window reset.
+      const delay = isRateLimited ? 60_000 : this.configuration.delay;
       setTimeout(() => {
         this.connect();
-      }, this.configuration.delay);
+      }, delay);
     }
   }