@hocuspocus/provider 1.0.0-alpha.32 → 1.0.0-alpha.33

package/dist/packages/common/src/index.d.ts

@@ -1,3 +1,4 @@
 export * from './auth';
 export * from './CloseEvents';
 export * from './awarenessStatesToArray';
+export * from './types';

package/dist/packages/common/src/types.d.ts

@@ -0,0 +1,10 @@
+/**
+ * State of the WebSocket connection.
+ * https://developer.mozilla.org/de/docs/Web/API/WebSocket/readyState
+ */
+export declare enum WsReadyStates {
+    Connecting = 0,
+    Open = 1,
+    Closing = 2,
+    Closed = 3
+}

package/dist/packages/extension-monitor/src/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
+import { Extension, onChangePayload, onConfigurePayload, onLoadDocumentPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload, connectedPayload } from '@hocuspocus/server';
 import { IncomingMessage, ServerResponse } from 'http';
 import WebSocket from 'ws';
 import { Storage } from './Storage';
@@ -30,7 +30,7 @@ export declare class Monitor implements Extension {
     handleConnection(websocket: WebSocket, request: IncomingMessage): void | undefined;
     onRequest({ request, response }: onRequestPayload): Promise<void>;
     onUpgrade({ request, socket, head }: onUpgradePayload): Promise<void>;
-    onConnect(data: onConnectPayload): Promise<void>;
+    connected(data: connectedPayload): Promise<void>;
     onDisconnect(data: onDisconnectPayload): Promise<void>;
     onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
     onChange(data: onChangePayload): Promise<void>;

package/dist/packages/provider/src/HocuspocusProvider.d.ts

@@ -133,6 +133,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     connect(): Promise<void>;
     createWebSocketConnection(): Promise<unknown>;
     resolveConnectionAttempt(): void;
+    stopConnectionAttempt(): void;
     rejectConnectionAttempt(): void;
     get document(): Y.Doc;
     get awareness(): Awareness;
@@ -149,9 +150,8 @@ export declare class HocuspocusProvider extends EventEmitter {
     set synced(state: boolean);
     get isAuthenticationRequired(): boolean;
     disconnect(): void;
-    onOpen(event: Event): void;
+    onOpen(event: Event): Promise<void>;
     getToken(): Promise<string | null>;
-    webSocketConnectionEstablished(): Promise<void>;
     startSync(): void;
     send(Message: ConstructableOutgoingMessage, args: any, broadcast?: boolean): void;
     onMessage(event: MessageEvent): void;

package/dist/packages/server/src/types.d.ts

@@ -12,16 +12,6 @@ export declare enum MessageType {
     Auth = 2,
     QueryAwareness = 3
 }
-/**
- * State of the WebSocket connection.
- * https://developer.mozilla.org/de/docs/Web/API/WebSocket/readyState
- */
-export declare enum WsReadyStates {
-    Connecting = 0,
-    Open = 1,
-    Closing = 2,
-    Closed = 3
-}
 export interface AwarenessUpdate {
     added: Array<any>;
     updated: Array<any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/provider",
-  "version": "1.0.0-alpha.32",
+  "version": "1.0.0-alpha.33",
   "description": "hocuspocus provider",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -28,11 +28,11 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/common": "^1.0.0-alpha.7",
+    "@hocuspocus/common": "^1.0.0-alpha.8",
     "@lifeomic/attempt": "^3.0.2",
     "lib0": "^0.2.43",
     "y-protocols": "^1.0.5",
     "yjs": "^13.5.24"
   },
-  "gitHead": "41c2ca3452f17e7dab914c633cde04ae68f45929"
+  "gitHead": "771a8cbad1016dd12080ff4b35fabb9680ec69a7"
 }

package/src/HocuspocusProvider.ts

@@ -6,7 +6,9 @@ import * as mutex from 'lib0/mutex'
 import * as url from 'lib0/url'
 import type { Event, CloseEvent, MessageEvent } from 'ws'
 import { retry } from '@lifeomic/attempt'
-import { awarenessStatesToArray, Forbidden, Unauthorized } from '@hocuspocus/common'
+import {
+  awarenessStatesToArray, Forbidden, Unauthorized, WsReadyStates,
+} from '@hocuspocus/common'
 import EventEmitter from './EventEmitter'
 import { IncomingMessage } from './IncomingMessage'
 import { MessageReceiver } from './MessageReceiver'
@@ -324,6 +326,14 @@ export class HocuspocusProvider extends EventEmitter {
   resolveConnectionAttempt() {
     this.connectionAttempt?.resolve()
     this.connectionAttempt = null
+
+    this.status = WebSocketStatus.Connected
+    this.emit('status', { status: 'connected' })
+    this.emit('connect')
+  }
+
+  stopConnectionAttempt() {
+    this.connectionAttempt = null
   }
 
   rejectConnectionAttempt() {
@@ -457,12 +467,17 @@ export class HocuspocusProvider extends EventEmitter {
     }
   }
 
-  onOpen(event: Event) {
+  async onOpen(event: Event) {
     this.emit('open', { event })
 
-    if (this.status !== WebSocketStatus.Connected) {
-      this.webSocketConnectionEstablished()
+    if (this.isAuthenticationRequired) {
+      this.send(AuthenticationMessage, {
+        token: await this.getToken(),
+      })
+      return
     }
+
+    this.startSync()
   }
 
   async getToken() {
@@ -474,21 +489,6 @@ export class HocuspocusProvider extends EventEmitter {
     return this.configuration.token
   }
 
-  async webSocketConnectionEstablished() {
-    this.status = WebSocketStatus.Connected
-    this.emit('status', { status: 'connected' })
-    this.emit('connect')
-
-    if (this.isAuthenticationRequired) {
-      this.send(AuthenticationMessage, {
-        token: await this.getToken(),
-      })
-      return
-    }
-
-    this.startSync()
-  }
-
   startSync() {
     this.send(SyncStepOneMessage, { document: this.document })
 
@@ -505,7 +505,7 @@ export class HocuspocusProvider extends EventEmitter {
       this.mux(() => { this.broadcast(Message, args) })
     }
 
-    if (this.status === WebSocketStatus.Connected) {
+    if (this.webSocket?.readyState === WsReadyStates.Open) {
       const messageSender = new MessageSender(Message, args)
 
       this.emit('outgoingMessage', { message: messageSender.message })
@@ -594,10 +594,10 @@ export class HocuspocusProvider extends EventEmitter {
 
     removeAwarenessStates(this.awareness, [this.document.clientID], 'provider destroy')
 
-    // If there is still a connection attempt outstanding then we should resolve
+    // If there is still a connection attempt outstanding then we should stop
     // it before calling disconnect, otherwise it will be rejected in the onClose
     // handler and trigger a retry
-    this.resolveConnectionAttempt()
+    this.stopConnectionAttempt()
 
     this.disconnect()