@hocuspocus/provider 3.0.0-rc.0 → 3.0.6-rc.0

package/src/HocuspocusProvider.ts

@@ -1,23 +1,21 @@
 import { awarenessStatesToArray } from '@hocuspocus/common'
-import * as mutex from 'lib0/mutex'
-import type { CloseEvent, Event, MessageEvent } from 'ws'
+import type { Event, MessageEvent } from 'ws'
 import { Awareness, removeAwarenessStates } from 'y-protocols/awareness'
 import * as Y from 'yjs'
-import EventEmitter from './EventEmitter.js'
+import EventEmitter from './EventEmitter.ts'
 import type {
-  CompleteHocuspocusProviderWebsocketConfiguration} from './HocuspocusProviderWebsocket.js'
+  CompleteHocuspocusProviderWebsocketConfiguration} from './HocuspocusProviderWebsocket.ts'
 import {
   HocuspocusProviderWebsocket,
-} from './HocuspocusProviderWebsocket.js'
-import { IncomingMessage } from './IncomingMessage.js'
-import { MessageReceiver } from './MessageReceiver.js'
-import { MessageSender } from './MessageSender.js'
-import { AuthenticationMessage } from './OutgoingMessages/AuthenticationMessage.js'
-import { AwarenessMessage } from './OutgoingMessages/AwarenessMessage.js'
-import { CloseMessage } from './OutgoingMessages/CloseMessage.js'
-import { StatelessMessage } from './OutgoingMessages/StatelessMessage.js'
-import { SyncStepOneMessage } from './OutgoingMessages/SyncStepOneMessage.js'
-import { UpdateMessage } from './OutgoingMessages/UpdateMessage.js'
+} from './HocuspocusProviderWebsocket.ts'
+import { IncomingMessage } from './IncomingMessage.ts'
+import { MessageReceiver } from './MessageReceiver.ts'
+import { MessageSender } from './MessageSender.ts'
+import { AuthenticationMessage } from './OutgoingMessages/AuthenticationMessage.ts'
+import { AwarenessMessage } from './OutgoingMessages/AwarenessMessage.ts'
+import { StatelessMessage } from './OutgoingMessages/StatelessMessage.ts'
+import { SyncStepOneMessage } from './OutgoingMessages/SyncStepOneMessage.ts'
+import { UpdateMessage } from './OutgoingMessages/UpdateMessage.ts'
 import type {
   ConstructableOutgoingMessage,
   onAuthenticationFailedParameters,
@@ -28,9 +26,8 @@ import type {
   onMessageParameters,
   onOpenParameters,
   onOutgoingMessageParameters, onStatelessParameters,
-  onStatusParameters,
   onSyncedParameters,
-} from './types.js'
+} from './types.ts'
 
 export type HocuspocusProviderConfiguration =
   Required<Pick<CompleteHocuspocusProviderConfiguration, 'name'>>
@@ -49,10 +46,6 @@ export interface CompleteHocuspocusProviderConfiguration {
    */
   document: Y.Doc,
 
-  /**
-   * Pass false to disable broadcasting between browser tabs.
-   */
-  broadcast: boolean,
   /**
    * An Awareness instance to keep the presence state of all clients.
    *
@@ -62,18 +55,17 @@ export interface CompleteHocuspocusProviderConfiguration {
    * socket connection, or ensure that the Provider receives messages before running into `HocuspocusProviderWebsocket.messageReconnectTimeout`.
    */
   awareness: Awareness | null,
+
   /**
    * A token that’s sent to the backend for authentication purposes.
    */
   token: string | (() => string) | (() => Promise<string>) | null,
-  /**
-   * URL parameters that should be added.
-   */
-  parameters: { [key: string]: any },
+
   /**
    * Hocuspocus websocket provider
    */
   websocketProvider: HocuspocusProviderWebsocket,
+
   /**
    * Force syncing the document in the defined interval.
    */
@@ -85,7 +77,6 @@ export interface CompleteHocuspocusProviderConfiguration {
   onConnect: () => void,
   onMessage: (data: onMessageParameters) => void,
   onOutgoingMessage: (data: onOutgoingMessageParameters) => void,
-  onStatus: (data: onStatusParameters) => void,
   onSynced: (data: onSyncedParameters) => void,
   onDisconnect: (data: onDisconnectParameters) => void,
   onClose: (data: onCloseParameters) => void,
@@ -93,21 +84,6 @@ export interface CompleteHocuspocusProviderConfiguration {
   onAwarenessUpdate: (data: onAwarenessUpdateParameters) => void,
   onAwarenessChange: (data: onAwarenessChangeParameters) => void,
   onStateless: (data: onStatelessParameters) => void
-
-  /**
-   * Don’t output any warnings.
-   */
-  quiet: boolean,
-
-  /**
-   * Pass `false` to start the connection manually.
-   */
-  connect: boolean,
-
-  /**
-   * Pass `false` to close the connection manually.
-   */
-  preserveConnection: boolean,
 }
 
 export class AwarenessError extends Error {
@@ -122,8 +98,6 @@ export class HocuspocusProvider extends EventEmitter {
     // @ts-ignore
     awareness: undefined,
     token: null,
-    parameters: {},
-    broadcast: true,
     forceSyncInterval: false,
     onAuthenticated: () => null,
     onAuthenticationFailed: () => null,
@@ -131,7 +105,6 @@ export class HocuspocusProvider extends EventEmitter {
     onConnect: () => null,
     onMessage: () => null,
     onOutgoingMessage: () => null,
-    onStatus: () => null,
     onSynced: () => null,
     onDisconnect: () => null,
     onClose: () => null,
@@ -139,31 +112,25 @@ export class HocuspocusProvider extends EventEmitter {
     onAwarenessUpdate: () => null,
     onAwarenessChange: () => null,
     onStateless: () => null,
-    quiet: false,
-    connect: true,
-    preserveConnection: true,
   }
 
-  subscribedToBroadcastChannel = false
-
   isSynced = false
 
   unsyncedChanges = 0
 
-  // status = WebSocketStatus.Disconnected
-
   isAuthenticated = false
 
   authorizedScope: string | undefined = undefined
 
-  mux = mutex.createMutex()
+  // @internal
+  manageSocket = false
+
+  private isAttached = false
 
   intervals: any = {
     forceSync: null,
   }
 
-  // isConnected = true
-
   constructor(configuration: HocuspocusProviderConfiguration) {
     super()
     this.setConfiguration(configuration)
@@ -183,24 +150,6 @@ export class HocuspocusProvider extends EventEmitter {
     this.on('authenticated', this.configuration.onAuthenticated)
     this.on('authenticationFailed', this.configuration.onAuthenticationFailed)
 
-    this.configuration.websocketProvider.on('connect', this.configuration.onConnect)
-    this.configuration.websocketProvider.on('connect', this.forwardConnect)
-
-    this.configuration.websocketProvider.on('open', this.boundOnOpen)
-    this.configuration.websocketProvider.on('open', this.forwardOpen)
-
-    this.configuration.websocketProvider.on('close', this.boundOnClose)
-    this.configuration.websocketProvider.on('close', this.configuration.onClose)
-    this.configuration.websocketProvider.on('close', this.forwardClose)
-
-    // this.configuration.websocketProvider.on('status', this.boundOnStatus)
-
-    this.configuration.websocketProvider.on('disconnect', this.configuration.onDisconnect)
-    this.configuration.websocketProvider.on('disconnect', this.forwardDisconnect)
-
-    this.configuration.websocketProvider.on('destroy', this.configuration.onDestroy)
-    this.configuration.websocketProvider.on('destroy', this.forwardDestroy)
-
     this.awareness?.on('update', () => {
       this.emit('awarenessUpdate', { states: awarenessStatesToArray(this.awareness!.getStates()) })
     })
@@ -209,8 +158,9 @@ export class HocuspocusProvider extends EventEmitter {
       this.emit('awarenessChange', { states: awarenessStatesToArray(this.awareness!.getStates()) })
     })
 
-    this.document.on('update', this.documentUpdateHandler.bind(this))
-    this.awareness?.on('update', this.awarenessUpdateHandler.bind(this))
+    this.document.on('update', this.boundDocumentUpdateHandler)
+    this.awareness?.on('update', this.boundAwarenessUpdateHandler)
+
     this.registerEventListeners()
 
     if (
@@ -223,10 +173,14 @@ export class HocuspocusProvider extends EventEmitter {
       )
     }
 
-    this.configuration.websocketProvider.attach(this)
+    if( this.manageSocket ) {
+      this.attach()
+    }
   }
 
-  // boundBroadcastChannelSubscriber = this.broadcastChannelSubscriber.bind(this)
+  boundDocumentUpdateHandler = this.documentUpdateHandler.bind(this)
+
+  boundAwarenessUpdateHandler = this.awarenessUpdateHandler.bind(this)
 
   boundPageHide = this.pageHide.bind(this)
 
@@ -234,11 +188,9 @@ export class HocuspocusProvider extends EventEmitter {
 
   boundOnClose = this.onClose.bind(this)
 
-  // boundOnStatus = this.onStatus.bind(this)
-
   forwardConnect = (e: any) => this.emit('connect', e)
 
-  forwardOpen = (e: any) => this.emit('open', e)
+  // forwardOpen = (e: any) => this.emit('open', e)
 
   forwardClose = (e: any) => this.emit('close', e)
 
@@ -246,21 +198,12 @@ export class HocuspocusProvider extends EventEmitter {
 
   forwardDestroy = (e: any) => this.emit('destroy', e)
 
-  // public onStatus({ status } : onStatusParameters) {
-  //    this.status = status
-  //
-  //   this.configuration.onStatus({ status })
-  //   this.emit('status', { status })
-  // }
-
   public setConfiguration(configuration: Partial<HocuspocusProviderConfiguration> = {}): void {
-    if (!configuration.websocketProvider && (configuration as CompleteHocuspocusProviderWebsocketConfiguration).url) {
+    if (!configuration.websocketProvider) {
       const websocketProviderConfig = configuration as CompleteHocuspocusProviderWebsocketConfiguration
-
+      this.manageSocket = true
       this.configuration.websocketProvider = new HocuspocusProviderWebsocket({
         url: websocketProviderConfig.url,
-        connect: websocketProviderConfig.connect,
-        parameters: websocketProviderConfig.parameters,
       })
     }
 
@@ -290,10 +233,14 @@ export class HocuspocusProvider extends EventEmitter {
   }
 
   decrementUnsyncedChanges() {
-    this.unsyncedChanges -= 1
+    if( this.unsyncedChanges > 0 ) {
+      this.unsyncedChanges -= 1
+    }
+
     if (this.unsyncedChanges === 0) {
       this.synced = true
     }
+
     this.emit('unsyncedChanges', this.unsyncedChanges)
   }
 
@@ -327,7 +274,7 @@ export class HocuspocusProvider extends EventEmitter {
     }
 
     this.incrementUnsyncedChanges()
-    this.send(UpdateMessage, { update, documentName: this.configuration.name }, true)
+    this.send(UpdateMessage, { update, documentName: this.configuration.name })
   }
 
   awarenessUpdateHandler({ added, updated, removed }: any, origin: any) {
@@ -337,7 +284,7 @@ export class HocuspocusProvider extends EventEmitter {
       awareness: this.awareness,
       clients: changedClients,
       documentName: this.configuration.name,
-    }, true)
+    })
   }
 
   /**
@@ -356,45 +303,27 @@ export class HocuspocusProvider extends EventEmitter {
     }
 
     this.isSynced = state
-    this.emit('synced', { state })
-    this.emit('sync', { state })
+
+    if( state ) {
+      this.emit('synced', { state })
+    }
   }
 
   receiveStateless(payload: string) {
     this.emit('stateless', { payload })
   }
 
-  get isAuthenticationRequired(): boolean {
-    return !!this.configuration.token && !this.isAuthenticated
-  }
-
   // not needed, but provides backward compatibility with e.g. lexical/yjs
   async connect() {
     console.warn('HocuspocusProvider::connect() is deprecated and does not do anything. Please connect/disconnect on the websocketProvider, or attach/deattach providers.')
-
-    // if (this.configuration.broadcast) {
-    //   this.subscribeToBroadcastChannel()
-    // }
-    //
-    // return this.configuration.websocketProvider.connect()
   }
 
   disconnect() {
     console.warn('HocuspocusProvider::disconnect() is deprecated and does not do anything. Please connect/disconnect on the websocketProvider, or attach/deattach providers.')
-
-    // this.disconnectBroadcastChannel()
-    // this.configuration.websocketProvider.detach(this)
-    // this.isConnected = false
-    //
-    // if (!this.configuration.preserveConnection) {
-    //   this.configuration.websocketProvider.disconnect()
-    // }
-    //
   }
 
   async onOpen(event: Event) {
     this.isAuthenticated = false
-    // this.isConnected = true
 
     this.emit('open', { event })
 
@@ -406,12 +335,10 @@ export class HocuspocusProvider extends EventEmitter {
       return
     }
 
-    if (this.isAuthenticationRequired) {
-      this.send(AuthenticationMessage, {
-        token,
-        documentName: this.configuration.name,
-      })
-    }
+    this.send(AuthenticationMessage, {
+      token: token ?? '',
+      documentName: this.configuration.name,
+    })
 
     this.startSync()
   }
@@ -439,15 +366,7 @@ export class HocuspocusProvider extends EventEmitter {
     }
   }
 
-  send(message: ConstructableOutgoingMessage, args: any, broadcast = false) {
-    // if (!this.isConnected) {
-    //   return
-    // }
-
-    // if (broadcast) {
-    //   this.mux(() => { this.broadcast(message, args) })
-    // }
-
+  send(message: ConstructableOutgoingMessage, args: any) {
     const messageSender = new MessageSender(message, args)
 
     this.emit('outgoingMessage', { message: messageSender.message })
@@ -466,7 +385,7 @@ export class HocuspocusProvider extends EventEmitter {
     new MessageReceiver(message).apply(this, true)
   }
 
-  onClose(event: CloseEvent) {
+  onClose() {
     this.isAuthenticated = false
     this.synced = false
 
@@ -489,43 +408,70 @@ export class HocuspocusProvider extends EventEmitter {
 
     if (this.awareness) {
       removeAwarenessStates(this.awareness, [this.document.clientID], 'provider destroy')
-      this.awareness.off('update', this.awarenessUpdateHandler)
+      this.awareness.off('update', this.boundAwarenessUpdateHandler)
       this.awareness.destroy()
     }
 
-    this.document.off('update', this.documentUpdateHandler)
+    this.document.off('update', this.boundDocumentUpdateHandler)
 
     this.removeAllListeners()
 
+    this.detach()
+
+    if( this.manageSocket ) {
+      this.configuration.websocketProvider.destroy()
+    }
+
+    if (typeof window === 'undefined' || !('removeEventListener' in window)) {
+      return
+    }
+
+    window.removeEventListener('pagehide', this.boundPageHide)
+  }
+
+  detach() {
     this.configuration.websocketProvider.off('connect', this.configuration.onConnect)
     this.configuration.websocketProvider.off('connect', this.forwardConnect)
     this.configuration.websocketProvider.off('open', this.boundOnOpen)
-    this.configuration.websocketProvider.off('open', this.forwardOpen)
     this.configuration.websocketProvider.off('close', this.boundOnClose)
     this.configuration.websocketProvider.off('close', this.configuration.onClose)
     this.configuration.websocketProvider.off('close', this.forwardClose)
-    // this.configuration.websocketProvider.off('status', this.boundOnStatus)
     this.configuration.websocketProvider.off('disconnect', this.configuration.onDisconnect)
     this.configuration.websocketProvider.off('disconnect', this.forwardDisconnect)
     this.configuration.websocketProvider.off('destroy', this.configuration.onDestroy)
     this.configuration.websocketProvider.off('destroy', this.forwardDestroy)
 
-    this.send(CloseMessage, { documentName: this.configuration.name })
     this.configuration.websocketProvider.detach(this)
-    this.disconnect()
 
-    if (typeof window === 'undefined' || !('removeEventListener' in window)) {
-      return
-    }
+    this.isAttached = false
+  }
 
-    window.removeEventListener('pagehide', this.boundPageHide)
+  attach() {
+    if( this.isAttached ) return
+
+    this.configuration.websocketProvider.on('connect', this.configuration.onConnect)
+    this.configuration.websocketProvider.on('connect', this.forwardConnect)
+
+    this.configuration.websocketProvider.on('open', this.boundOnOpen)
+
+    this.configuration.websocketProvider.on('close', this.boundOnClose)
+    this.configuration.websocketProvider.on('close', this.configuration.onClose)
+    this.configuration.websocketProvider.on('close', this.forwardClose)
+
+    this.configuration.websocketProvider.on('disconnect', this.configuration.onDisconnect)
+    this.configuration.websocketProvider.on('disconnect', this.forwardDisconnect)
+
+    this.configuration.websocketProvider.on('destroy', this.configuration.onDestroy)
+    this.configuration.websocketProvider.on('destroy', this.forwardDestroy)
+
+    this.configuration.websocketProvider.attach(this)
+
+    this.isAttached = true
   }
 
   permissionDeniedHandler(reason: string) {
     this.emit('authenticationFailed', { reason })
     this.isAuthenticated = false
-    // this.disconnect()
-    // this.status = WebSocketStatus.Disconnected
   }
 
   authenticatedHandler(scope: string) {
@@ -535,74 +481,6 @@ export class HocuspocusProvider extends EventEmitter {
     this.emit('authenticated')
   }
 
-  // get broadcastChannel() {
-  //   return `${this.configuration.name}`
-  // }
-  //
-  // broadcastChannelSubscriber(data: ArrayBuffer) {
-  //   this.mux(() => {
-  //     const message = new IncomingMessage(data)
-  //
-  //     const documentName = message.readVarString()
-  //
-  //     message.writeVarString(documentName)
-  //
-  //     new MessageReceiver(message)
-  //       .setBroadcasted(true)
-  //       .apply(this, false)
-  //   })
-  // }
-
-  // subscribeToBroadcastChannel() {
-  //   if (!this.subscribedToBroadcastChannel) {
-  //     bc.subscribe(this.broadcastChannel, this.boundBroadcastChannelSubscriber)
-  //     this.subscribedToBroadcastChannel = true
-  //   }
-  //
-  //   this.mux(() => {
-  //     this.broadcast(SyncStepOneMessage, { document: this.document, documentName: this.configuration.name })
-  //     this.broadcast(SyncStepTwoMessage, { document: this.document, documentName: this.configuration.name })
-  //     this.broadcast(QueryAwarenessMessage, { document: this.document, documentName: this.configuration.name })
-  //     if (this.awareness) {
-  //       this.broadcast(AwarenessMessage, {
-  //         awareness: this.awareness,
-  //         clients: [this.document.clientID],
-  //         document: this.document,
-  //         documentName: this.configuration.name,
-  //       })
-  //     }
-  //   })
-  // }
-  //
-  // disconnectBroadcastChannel() {
-  //   // broadcast message with local awareness state set to null (indicating disconnect)
-  //   if (this.awareness) {
-  //     this.send(AwarenessMessage, {
-  //       awareness: this.awareness,
-  //       clients: [this.document.clientID],
-  //       states: new Map(),
-  //       documentName: this.configuration.name,
-  //     }, true)
-  //   }
-  //
-  //   if (this.subscribedToBroadcastChannel) {
-  //     bc.unsubscribe(this.broadcastChannel, this.boundBroadcastChannelSubscriber)
-  //     this.subscribedToBroadcastChannel = false
-  //   }
-  // }
-
-  // broadcast(Message: ConstructableOutgoingMessage, args?: any) {
-  //   if (!this.configuration.broadcast) {
-  //     return
-  //   }
-  //
-  //   if (!this.subscribedToBroadcastChannel) {
-  //     return
-  //   }
-  //
-  //   new MessageSender(Message, args).broadcast(this.broadcastChannel)
-  // }
-
   setAwarenessField(key: string, value: any) {
     if (!this.awareness) {
       throw new AwarenessError(`Cannot set awareness field "${key}" to ${JSON.stringify(value)}. You have disabled Awareness for this provider by explicitly passing awareness: null in the provider configuration.`)