@hocuspocus/extension-redis 2.5.0-rc.0 → 2.6.0

package/dist/hocuspocus-redis.cjs

@@ -28,28 +28,29 @@ class Redis {
             lockTimeout: 1000,
             disconnectDelay: 1000,
         };
+        this.redisTransactionOrigin = '__hocuspocus__redis__origin__';
         this.locks = new Map();
         /**
-         * Handle incoming messages published on all subscribed document channels.
+         * Handle incoming messages published on subscribed document channels.
          * Note that this will also include messages from ourselves as it is not possible
          * in Redis to filter these.
         */
-        this.handleIncomingMessage = async (channel, pattern, data) => {
-            const message = new server.IncomingMessage(data);
-            // we don't need the documentName from the message, we are just taking it from the redis channelName.
-            // we have to immediately write it back to the encoder though, to make sure the structure of the message is correct
-            message.writeVarString(message.readVarString());
-            const channelName = pattern.toString();
-            const [_, documentName, identifier] = channelName.split(':');
-            const document = this.instance.documents.get(documentName);
+        this.handleIncomingMessage = async (channel, data) => {
+            const [identifier, messageBuffer] = this.decodeMessage(data);
             if (identifier === this.configuration.identifier) {
                 return;
             }
+            const message = new server.IncomingMessage(messageBuffer);
+            const documentName = message.readVarString();
+            message.writeVarString(documentName);
+            const document = this.instance.documents.get(documentName);
             if (!document) {
+                // What does this mean? Why are we subscribed to this document?
+                this.logger.log(`Received message for unknown document ${documentName}`);
                 return;
             }
-            new server.MessageReceiver(message, this.logger).apply(document, undefined, reply => {
-                return this.pub.publishBuffer(this.pubKey(document.name), Buffer.from(reply));
+            new server.MessageReceiver(message, this.logger, this.redisTransactionOrigin).apply(document, undefined, reply => {
+                return this.pub.publishBuffer(this.pubKey(document.name), this.encodeMessage(reply));
             });
         };
         /**
@@ -64,7 +65,7 @@ class Redis {
                     return;
                 }
                 // Time to end the subscription on the document channel.
-                this.sub.punsubscribe(this.subKey(documentName), (error) => {
+                this.sub.unsubscribe(this.subKey(documentName), (error) => {
                     if (error) {
                         console.error(error);
                     }
@@ -97,8 +98,10 @@ class Redis {
             this.pub = new RedisClient__default["default"](port, host, options);
             this.sub = new RedisClient__default["default"](port, host, options);
         }
-        this.sub.on('pmessageBuffer', this.handleIncomingMessage);
+        this.sub.on('messageBuffer', this.handleIncomingMessage);
         this.redlock = new Redlock__default["default"]([this.pub]);
+        const identifierBuffer = Buffer.from(this.configuration.identifier, 'utf-8');
+        this.messagePrefix = Buffer.concat([Buffer.from([identifierBuffer.length]), identifierBuffer]);
     }
     async onConfigure({ instance }) {
         this.logger = instance.debugger;
@@ -108,14 +111,22 @@ class Redis {
         return `${this.configuration.prefix}:${documentName}`;
     }
     pubKey(documentName) {
-        return `${this.getKey(documentName)}:${this.configuration.identifier.replace(/:/g, '')}`;
+        return this.getKey(documentName);
     }
     subKey(documentName) {
-        return `${this.getKey(documentName)}:*`;
+        return this.getKey(documentName);
     }
     lockKey(documentName) {
         return `${this.getKey(documentName)}:lock`;
     }
+    encodeMessage(message) {
+        return Buffer.concat([this.messagePrefix, Buffer.from(message)]);
+    }
+    decodeMessage(buffer) {
+        const identifierLength = buffer[0];
+        const identifier = buffer.toString('utf-8', 1, identifierLength + 1);
+        return [identifier, buffer.slice(identifierLength + 1)];
+    }
     /**
      * Once a document is loaded, subscribe to the channel in Redis.
      */
@@ -123,7 +134,7 @@ class Redis {
         return new Promise((resolve, reject) => {
             // On document creation the node will connect to pub and sub channels
             // for the document.
-            this.sub.psubscribe(this.subKey(documentName), async (error) => {
+            this.sub.subscribe(this.subKey(documentName), async (error) => {
                 if (error) {
                     reject(error);
                     return;
@@ -141,7 +152,7 @@ class Redis {
         const syncMessage = new server.OutgoingMessage(documentName)
             .createSyncMessage()
             .writeFirstSyncStepFor(document);
-        return this.pub.publishBuffer(this.pubKey(documentName), Buffer.from(syncMessage.toUint8Array()));
+        return this.pub.publishBuffer(this.pubKey(documentName), this.encodeMessage(syncMessage.toUint8Array()));
     }
     /**
      * Let’s ask Redis who is connected already.
@@ -149,7 +160,7 @@ class Redis {
     async requestAwarenessFromOtherInstances(documentName) {
         const awarenessMessage = new server.OutgoingMessage(documentName)
             .writeQueryAwareness();
-        return this.pub.publishBuffer(this.pubKey(documentName), Buffer.from(awarenessMessage.toUint8Array()));
+        return this.pub.publishBuffer(this.pubKey(documentName), this.encodeMessage(awarenessMessage.toUint8Array()));
     }
     /**
      * Before the document is stored, make sure to set a lock in Redis.
@@ -190,18 +201,20 @@ class Redis {
         const changedClients = added.concat(updated, removed);
         const message = new server.OutgoingMessage(documentName)
             .createAwarenessUpdateMessage(awareness, changedClients);
-        return this.pub.publishBuffer(this.pubKey(documentName), Buffer.from(message.toUint8Array()));
+        return this.pub.publishBuffer(this.pubKey(documentName), this.encodeMessage(message.toUint8Array()));
     }
     /**
      * if the ydoc changed, we'll need to inform other Hocuspocus servers about it.
      */
     async onChange(data) {
-        return this.publishFirstSyncStep(data.documentName, data.document);
+        if (data.transactionOrigin !== this.redisTransactionOrigin) {
+            return this.publishFirstSyncStep(data.documentName, data.document);
+        }
     }
     async beforeBroadcastStateless(data) {
         const message = new server.OutgoingMessage(data.documentName)
             .writeBroadcastStateless(data.payload);
-        return this.pub.publishBuffer(this.pubKey(data.documentName), Buffer.from(message.toUint8Array()));
+        return this.pub.publishBuffer(this.pubKey(data.documentName), this.encodeMessage(message.toUint8Array()));
     }
     /**
      * Kill the Redlock connection immediately.

package/dist/hocuspocus-redis.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"hocuspocus-redis.cjs","sources":["../src/Redis.ts"],"sourcesContent":["import RedisClient, { ClusterNode, ClusterOptions, RedisOptions } from 'ioredis'\nimport Redlock from 'redlock'\nimport { v4 as uuid } from 'uuid'\nimport {\n  IncomingMessage,\n  OutgoingMessage,\n  Document,\n  Extension,\n  afterLoadDocumentPayload,\n  afterStoreDocumentPayload,\n  onDisconnectPayload,\n  onStoreDocumentPayload,\n  onAwarenessUpdatePayload,\n  onChangePayload,\n  MessageReceiver,\n  Debugger,\n  onConfigurePayload,\n  beforeBroadcastStatelessPayload, Hocuspocus,\n} from '@hocuspocus/server'\n\nexport type RedisInstance = RedisClient.Cluster | RedisClient.Redis\n\nexport interface Configuration {\n  /**\n   * Redis port\n   */\n  port: number,\n  /**\n   * Redis host\n   */\n  host: string,\n  /**\n   * Redis Cluster\n   */\n  nodes?: ClusterNode[],\n  /**\n   * Duplicate from an existed Redis instance\n   */\n  redis?: RedisInstance,\n  /**\n   * Redis instance creator\n   */\n  createClient?: () => RedisInstance,\n  /**\n   * Options passed directly to Redis constructor\n   *\n   * https://github.com/luin/ioredis/blob/master/API.md#new-redisport-host-options\n   */\n  options?: ClusterOptions | RedisOptions,\n  /**\n   * An unique instance name, required to filter messages in Redis.\n   * If none is provided an unique id is generated.\n   */\n  identifier: string,\n  /**\n   * Namespace for Redis keys, if none is provided 'hocuspocus' is used\n   */\n  prefix: string,\n  /**\n   * The maximum time for the Redis lock in ms (in case it can’t be released).\n   */\n  lockTimeout: number,\n  /**\n   * A delay before onDisconnect is executed. This allows last minute updates'\n   * sync messages to be received by the subscription before it's closed.\n   */\n  disconnectDelay: number,\n}\n\nexport class Redis implements Extension {\n  /**\n   * Make sure to give that extension a higher priority, so\n   * the `onStoreDocument` hook is able to intercept the chain,\n   * before documents are stored to the database.\n   */\n  priority = 1000\n\n  configuration: Configuration = {\n    port: 6379,\n    host: '127.0.0.1',\n    prefix: 'hocuspocus',\n    identifier: `host-${uuid()}`,\n    lockTimeout: 1000,\n    disconnectDelay: 1000,\n  }\n\n  pub: RedisInstance\n\n  sub: RedisInstance\n\n  instance!: Hocuspocus\n\n  redlock: Redlock\n\n  locks = new Map<string, Redlock.Lock>()\n\n  logger: Debugger\n\n  public constructor(configuration: Partial<Configuration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n\n    // We’ll replace that in the onConfigure hook with the global instance.\n    this.logger = new Debugger()\n\n    // Create Redis instance\n    const {\n      port,\n      host,\n      options,\n      nodes,\n      redis,\n      createClient,\n    } = this.configuration\n\n    if (typeof createClient === 'function') {\n      this.pub = createClient()\n      this.sub = createClient()\n    } else if (redis) {\n      this.pub = redis.duplicate()\n      this.sub = redis.duplicate()\n    } else if (nodes && nodes.length > 0) {\n      this.pub = new RedisClient.Cluster(nodes, options)\n      this.sub = new RedisClient.Cluster(nodes, options)\n    } else {\n      this.pub = new RedisClient(port, host, options)\n      this.sub = new RedisClient(port, host, options)\n    }\n    this.sub.on('pmessageBuffer', this.handleIncomingMessage)\n\n    this.redlock = new Redlock([this.pub])\n  }\n\n  async onConfigure({ instance }: onConfigurePayload) {\n    this.logger = instance.debugger\n    this.instance = instance\n  }\n\n  private getKey(documentName: string) {\n    return `${this.configuration.prefix}:${documentName}`\n  }\n\n  private pubKey(documentName: string) {\n    return `${this.getKey(documentName)}:${this.configuration.identifier.replace(/:/g, '')}`\n  }\n\n  private subKey(documentName: string) {\n    return `${this.getKey(documentName)}:*`\n  }\n\n  private lockKey(documentName: string) {\n    return `${this.getKey(documentName)}:lock`\n  }\n\n  /**\n   * Once a document is loaded, subscribe to the channel in Redis.\n   */\n  public async afterLoadDocument({ documentName, document }: afterLoadDocumentPayload) {\n    return new Promise((resolve, reject) => {\n      // On document creation the node will connect to pub and sub channels\n      // for the document.\n      this.sub.psubscribe(this.subKey(documentName), async error => {\n        if (error) {\n          reject(error)\n          return\n        }\n\n        this.publishFirstSyncStep(documentName, document)\n        this.requestAwarenessFromOtherInstances(documentName)\n\n        resolve(undefined)\n      })\n    })\n  }\n\n  /**\n   * Publish the first sync step through Redis.\n   */\n  private async publishFirstSyncStep(documentName: string, document: Document) {\n    const syncMessage = new OutgoingMessage(documentName)\n      .createSyncMessage()\n      .writeFirstSyncStepFor(document)\n\n    return this.pub.publishBuffer(this.pubKey(documentName), Buffer.from(syncMessage.toUint8Array()))\n  }\n\n  /**\n   * Let’s ask Redis who is connected already.\n   */\n  private async requestAwarenessFromOtherInstances(documentName: string) {\n    const awarenessMessage = new OutgoingMessage(documentName)\n      .writeQueryAwareness()\n\n    return this.pub.publishBuffer(\n      this.pubKey(documentName),\n      Buffer.from(awarenessMessage.toUint8Array()),\n    )\n  }\n\n  /**\n   * Before the document is stored, make sure to set a lock in Redis.\n   * That’s meant to avoid conflicts with other instances trying to store the document.\n   */\n  async onStoreDocument({ documentName }: onStoreDocumentPayload) {\n    // Attempt to acquire a lock and read lastReceivedTimestamp from Redis,\n    // to avoid conflict with other instances storing the same document.\n    return new Promise((resolve, reject) => {\n      this.redlock.lock(this.lockKey(documentName), this.configuration.lockTimeout, async (error, lock) => {\n        if (error || !lock) {\n          // Expected behavior: Could not acquire lock, another instance locked it already.\n          // No further `onStoreDocument` hooks will be executed.\n          reject()\n          return\n        }\n\n        this.locks.set(this.lockKey(documentName), lock)\n\n        resolve(undefined)\n      })\n    })\n  }\n\n  /**\n   * Release the Redis lock, so other instances can store documents.\n   */\n  async afterStoreDocument({ documentName }: afterStoreDocumentPayload) {\n    this.locks.get(this.lockKey(documentName))?.unlock()\n      .catch(() => {\n        // Not able to unlock Redis. The lock will expire after ${lockTimeout} ms.\n        // console.error(`Not able to unlock Redis. The lock will expire after ${this.configuration.lockTimeout}ms.`)\n      })\n      .finally(() => {\n        this.locks.delete(this.lockKey(documentName))\n      })\n  }\n\n  /**\n   * Handle awareness update messages received directly by this Hocuspocus instance.\n   */\n  async onAwarenessUpdate({\n    documentName, awareness, added, updated, removed,\n  }: onAwarenessUpdatePayload) {\n    const changedClients = added.concat(updated, removed)\n    const message = new OutgoingMessage(documentName)\n      .createAwarenessUpdateMessage(awareness, changedClients)\n\n    return this.pub.publishBuffer(\n      this.pubKey(documentName),\n      Buffer.from(message.toUint8Array()),\n    )\n  }\n\n  /**\n   * Handle incoming messages published on all subscribed document channels.\n   * Note that this will also include messages from ourselves as it is not possible\n   * in Redis to filter these.\n  */\n  private handleIncomingMessage = async (channel: Buffer, pattern: Buffer, data: Buffer) => {\n    const message = new IncomingMessage(data)\n    // we don't need the documentName from the message, we are just taking it from the redis channelName.\n    // we have to immediately write it back to the encoder though, to make sure the structure of the message is correct\n    message.writeVarString(message.readVarString())\n\n    const channelName = pattern.toString()\n    const [_, documentName, identifier] = channelName.split(':')\n    const document = this.instance.documents.get(documentName)\n\n    if (identifier === this.configuration.identifier) {\n      return\n    }\n\n    if (!document) {\n      return\n    }\n\n    new MessageReceiver(\n      message,\n      this.logger,\n    ).apply(document, undefined, reply => {\n      return this.pub.publishBuffer(\n        this.pubKey(document.name),\n        Buffer.from(reply),\n      )\n    })\n  }\n\n  /**\n   * if the ydoc changed, we'll need to inform other Hocuspocus servers about it.\n   */\n  public async onChange(data: onChangePayload): Promise<any> {\n    return this.publishFirstSyncStep(data.documentName, data.document)\n  }\n\n  /**\n   * Make sure to *not* listen for further changes, when there’s\n   * noone connected anymore.\n   */\n  public onDisconnect = async ({ documentName }: onDisconnectPayload) => {\n    const disconnect = () => {\n      const document = this.instance.documents.get(documentName)\n\n      // Do nothing, when other users are still connected to the document.\n      if (document && document.getConnectionsCount() > 0) {\n        return\n      }\n\n      // Time to end the subscription on the document channel.\n      this.sub.punsubscribe(this.subKey(documentName), (error: any) => {\n        if (error) {\n          console.error(error)\n        }\n      })\n    }\n    // Delay the disconnect procedure to allow last minute syncs to happen\n    setTimeout(disconnect, this.configuration.disconnectDelay)\n  }\n\n  async beforeBroadcastStateless(data: beforeBroadcastStatelessPayload) {\n    const message = new OutgoingMessage(data.documentName)\n      .writeBroadcastStateless(data.payload)\n\n    return this.pub.publishBuffer(\n      this.pubKey(data.documentName),\n      Buffer.from(message.toUint8Array()),\n    )\n  }\n\n  /**\n   * Kill the Redlock connection immediately.\n   */\n  async onDestroy() {\n    await this.redlock.quit()\n    this.pub.disconnect(false)\n    this.sub.disconnect(false)\n  }\n}\n"],"names":["uuid","IncomingMessage","MessageReceiver","Debugger","RedisClient","Redlock","OutgoingMessage"],"mappings":";;;;;;;;;;;;;;MAqEa,KAAK,CAAA;AA6BhB,IAAA,WAAA,CAAmB,aAAqC,EAAA;AA5BxD;;;;AAIG;QACH,IAAQ,CAAA,QAAA,GAAG,IAAI,CAAA;AAEf,QAAA,IAAA,CAAA,aAAa,GAAkB;AAC7B,YAAA,IAAI,EAAE,IAAI;AACV,YAAA,IAAI,EAAE,WAAW;AACjB,YAAA,MAAM,EAAE,YAAY;AACpB,YAAA,UAAU,EAAE,CAAA,KAAA,EAAQA,OAAI,EAAE,CAAE,CAAA;AAC5B,YAAA,WAAW,EAAE,IAAI;AACjB,YAAA,eAAe,EAAE,IAAI;SACtB,CAAA;AAUD,QAAA,IAAA,CAAA,KAAK,GAAG,IAAI,GAAG,EAAwB,CAAA;AAgKvC;;;;AAIE;QACM,IAAqB,CAAA,qBAAA,GAAG,OAAO,OAAe,EAAE,OAAe,EAAE,IAAY,KAAI;AACvF,YAAA,MAAM,OAAO,GAAG,IAAIC,sBAAe,CAAC,IAAI,CAAC,CAAA;;;YAGzC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,CAAA;AAE/C,YAAA,MAAM,WAAW,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAA;AACtC,YAAA,MAAM,CAAC,CAAC,EAAE,YAAY,EAAE,UAAU,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;AAC5D,YAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;AAE1D,YAAA,IAAI,UAAU,KAAK,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE;gBAChD,OAAM;AACP,aAAA;YAED,IAAI,CAAC,QAAQ,EAAE;gBACb,OAAM;AACP,aAAA;AAED,YAAA,IAAIC,sBAAe,CACjB,OAAO,EACP,IAAI,CAAC,MAAM,CACZ,CAAC,KAAK,CAAC,QAAQ,EAAE,SAAS,EAAE,KAAK,IAAG;gBACnC,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAC3B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAC1B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CACnB,CAAA;AACH,aAAC,CAAC,CAAA;AACJ,SAAC,CAAA;AASD;;;AAGG;AACI,QAAA,IAAA,CAAA,YAAY,GAAG,OAAO,EAAE,YAAY,EAAuB,KAAI;YACpE,MAAM,UAAU,GAAG,MAAK;AACtB,gBAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;;gBAG1D,IAAI,QAAQ,IAAI,QAAQ,CAAC,mBAAmB,EAAE,GAAG,CAAC,EAAE;oBAClD,OAAM;AACP,iBAAA;;AAGD,gBAAA,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,KAAU,KAAI;AAC9D,oBAAA,IAAI,KAAK,EAAE;AACT,wBAAA,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;AACrB,qBAAA;AACH,iBAAC,CAAC,CAAA;AACJ,aAAC,CAAA;;YAED,UAAU,CAAC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,CAAA;AAC5D,SAAC,CAAA;QA1NC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SACjB,CAAA;;AAGD,QAAA,IAAI,CAAC,MAAM,GAAG,IAAIC,eAAQ,EAAE,CAAA;;AAG5B,QAAA,MAAM,EACJ,IAAI,EACJ,IAAI,EACJ,OAAO,EACP,KAAK,EACL,KAAK,EACL,YAAY,GACb,GAAG,IAAI,CAAC,aAAa,CAAA;AAEtB,QAAA,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE;AACtC,YAAA,IAAI,CAAC,GAAG,GAAG,YAAY,EAAE,CAAA;AACzB,YAAA,IAAI,CAAC,GAAG,GAAG,YAAY,EAAE,CAAA;AAC1B,SAAA;AAAM,aAAA,IAAI,KAAK,EAAE;AAChB,YAAA,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,SAAS,EAAE,CAAA;AAC5B,YAAA,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,SAAS,EAAE,CAAA;AAC7B,SAAA;AAAM,aAAA,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;AACpC,YAAA,IAAI,CAAC,GAAG,GAAG,IAAIC,+BAAW,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;AAClD,YAAA,IAAI,CAAC,GAAG,GAAG,IAAIA,+BAAW,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;AACnD,SAAA;AAAM,aAAA;AACL,YAAA,IAAI,CAAC,GAAG,GAAG,IAAIA,+BAAW,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AAC/C,YAAA,IAAI,CAAC,GAAG,GAAG,IAAIA,+BAAW,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AAChD,SAAA;QACD,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,gBAAgB,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAA;AAEzD,QAAA,IAAI,CAAC,OAAO,GAAG,IAAIC,2BAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;KACvC;AAED,IAAA,MAAM,WAAW,CAAC,EAAE,QAAQ,EAAsB,EAAA;AAChD,QAAA,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAA;AAC/B,QAAA,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;KACzB;AAEO,IAAA,MAAM,CAAC,YAAoB,EAAA;QACjC,OAAO,CAAA,EAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAA,CAAA,EAAI,YAAY,CAAA,CAAE,CAAA;KACtD;AAEO,IAAA,MAAM,CAAC,YAAoB,EAAA;QACjC,OAAO,CAAA,EAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA,CAAE,CAAA;KACzF;AAEO,IAAA,MAAM,CAAC,YAAoB,EAAA;QACjC,OAAO,CAAA,EAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAA;KACxC;AAEO,IAAA,OAAO,CAAC,YAAoB,EAAA;QAClC,OAAO,CAAA,EAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAA;KAC3C;AAED;;AAEG;AACI,IAAA,MAAM,iBAAiB,CAAC,EAAE,YAAY,EAAE,QAAQ,EAA4B,EAAA;QACjF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,KAAI;;;AAGrC,YAAA,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,OAAM,KAAK,KAAG;AAC3D,gBAAA,IAAI,KAAK,EAAE;oBACT,MAAM,CAAC,KAAK,CAAC,CAAA;oBACb,OAAM;AACP,iBAAA;AAED,gBAAA,IAAI,CAAC,oBAAoB,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAA;AACjD,gBAAA,IAAI,CAAC,kCAAkC,CAAC,YAAY,CAAC,CAAA;gBAErD,OAAO,CAAC,SAAS,CAAC,CAAA;AACpB,aAAC,CAAC,CAAA;AACJ,SAAC,CAAC,CAAA;KACH;AAED;;AAEG;AACK,IAAA,MAAM,oBAAoB,CAAC,YAAoB,EAAE,QAAkB,EAAA;AACzE,QAAA,MAAM,WAAW,GAAG,IAAIC,sBAAe,CAAC,YAAY,CAAC;AAClD,aAAA,iBAAiB,EAAE;aACnB,qBAAqB,CAAC,QAAQ,CAAC,CAAA;QAElC,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,CAAA;KAClG;AAED;;AAEG;IACK,MAAM,kCAAkC,CAAC,YAAoB,EAAA;AACnE,QAAA,MAAM,gBAAgB,GAAG,IAAIA,sBAAe,CAAC,YAAY,CAAC;AACvD,aAAA,mBAAmB,EAAE,CAAA;QAExB,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAC3B,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EACzB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC,CAC7C,CAAA;KACF;AAED;;;AAGG;AACH,IAAA,MAAM,eAAe,CAAC,EAAE,YAAY,EAA0B,EAAA;;;QAG5D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,KAAI;YACrC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,OAAO,KAAK,EAAE,IAAI,KAAI;AAClG,gBAAA,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE;;;AAGlB,oBAAA,MAAM,EAAE,CAAA;oBACR,OAAM;AACP,iBAAA;AAED,gBAAA,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,CAAA;gBAEhD,OAAO,CAAC,SAAS,CAAC,CAAA;AACpB,aAAC,CAAC,CAAA;AACJ,SAAC,CAAC,CAAA;KACH;AAED;;AAEG;AACH,IAAA,MAAM,kBAAkB,CAAC,EAAE,YAAY,EAA6B,EAAA;;AAClE,QAAA,CAAA,EAAA,GAAA,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,MAAE,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,MAAM,GAC/C,KAAK,CAAC,MAAK;;;AAGZ,SAAC,CACA,CAAA,OAAO,CAAC,MAAK;AACZ,YAAA,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;AAC/C,SAAC,CAAC,CAAA;KACL;AAED;;AAEG;AACH,IAAA,MAAM,iBAAiB,CAAC,EACtB,YAAY,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,GACvB,EAAA;QACzB,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;AACrD,QAAA,MAAM,OAAO,GAAG,IAAIA,sBAAe,CAAC,YAAY,CAAC;AAC9C,aAAA,4BAA4B,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;QAE1D,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAC3B,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EACzB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CACpC,CAAA;KACF;AAoCD;;AAEG;IACI,MAAM,QAAQ,CAAC,IAAqB,EAAA;AACzC,QAAA,OAAO,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;KACnE;IA0BD,MAAM,wBAAwB,CAAC,IAAqC,EAAA;QAClE,MAAM,OAAO,GAAG,IAAIA,sBAAe,CAAC,IAAI,CAAC,YAAY,CAAC;AACnD,aAAA,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAExC,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAC3B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EAC9B,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CACpC,CAAA;KACF;AAED;;AAEG;AACH,IAAA,MAAM,SAAS,GAAA;AACb,QAAA,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;AACzB,QAAA,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;AAC1B,QAAA,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;KAC3B;AACF;;;;"}
+{"version":3,"file":"hocuspocus-redis.cjs","sources":["../src/Redis.ts"],"sourcesContent":["import RedisClient, { ClusterNode, ClusterOptions, RedisOptions } from 'ioredis'\nimport Redlock from 'redlock'\nimport { v4 as uuid } from 'uuid'\nimport {\n  IncomingMessage,\n  OutgoingMessage,\n  Document,\n  Extension,\n  afterLoadDocumentPayload,\n  afterStoreDocumentPayload,\n  onDisconnectPayload,\n  onStoreDocumentPayload,\n  onAwarenessUpdatePayload,\n  onChangePayload,\n  MessageReceiver,\n  Debugger,\n  onConfigurePayload,\n  beforeBroadcastStatelessPayload, Hocuspocus,\n} from '@hocuspocus/server'\n\nexport type RedisInstance = RedisClient.Cluster | RedisClient.Redis\n\nexport interface Configuration {\n  /**\n   * Redis port\n   */\n  port: number,\n  /**\n   * Redis host\n   */\n  host: string,\n  /**\n   * Redis Cluster\n   */\n  nodes?: ClusterNode[],\n  /**\n   * Duplicate from an existed Redis instance\n   */\n  redis?: RedisInstance,\n  /**\n   * Redis instance creator\n   */\n  createClient?: () => RedisInstance,\n  /**\n   * Options passed directly to Redis constructor\n   *\n   * https://github.com/luin/ioredis/blob/master/API.md#new-redisport-host-options\n   */\n  options?: ClusterOptions | RedisOptions,\n  /**\n   * An unique instance name, required to filter messages in Redis.\n   * If none is provided an unique id is generated.\n   */\n  identifier: string,\n  /**\n   * Namespace for Redis keys, if none is provided 'hocuspocus' is used\n   */\n  prefix: string,\n  /**\n   * The maximum time for the Redis lock in ms (in case it can’t be released).\n   */\n  lockTimeout: number,\n  /**\n   * A delay before onDisconnect is executed. This allows last minute updates'\n   * sync messages to be received by the subscription before it's closed.\n   */\n  disconnectDelay: number,\n}\n\nexport class Redis implements Extension {\n  /**\n   * Make sure to give that extension a higher priority, so\n   * the `onStoreDocument` hook is able to intercept the chain,\n   * before documents are stored to the database.\n   */\n  priority = 1000\n\n  configuration: Configuration = {\n    port: 6379,\n    host: '127.0.0.1',\n    prefix: 'hocuspocus',\n    identifier: `host-${uuid()}`,\n    lockTimeout: 1000,\n    disconnectDelay: 1000,\n  }\n\n  redisTransactionOrigin = '__hocuspocus__redis__origin__'\n\n  pub: RedisInstance\n\n  sub: RedisInstance\n\n  instance!: Hocuspocus\n\n  redlock: Redlock\n\n  locks = new Map<string, Redlock.Lock>()\n\n  logger: Debugger\n\n  messagePrefix: Buffer\n\n  public constructor(configuration: Partial<Configuration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n\n    // We’ll replace that in the onConfigure hook with the global instance.\n    this.logger = new Debugger()\n\n    // Create Redis instance\n    const {\n      port,\n      host,\n      options,\n      nodes,\n      redis,\n      createClient,\n    } = this.configuration\n\n    if (typeof createClient === 'function') {\n      this.pub = createClient()\n      this.sub = createClient()\n    } else if (redis) {\n      this.pub = redis.duplicate()\n      this.sub = redis.duplicate()\n    } else if (nodes && nodes.length > 0) {\n      this.pub = new RedisClient.Cluster(nodes, options)\n      this.sub = new RedisClient.Cluster(nodes, options)\n    } else {\n      this.pub = new RedisClient(port, host, options)\n      this.sub = new RedisClient(port, host, options)\n    }\n    this.sub.on('messageBuffer', this.handleIncomingMessage)\n\n    this.redlock = new Redlock([this.pub])\n\n    const identifierBuffer = Buffer.from(this.configuration.identifier, 'utf-8')\n    this.messagePrefix = Buffer.concat([Buffer.from([identifierBuffer.length]), identifierBuffer])\n  }\n\n  async onConfigure({ instance }: onConfigurePayload) {\n    this.logger = instance.debugger\n    this.instance = instance\n  }\n\n  private getKey(documentName: string) {\n    return `${this.configuration.prefix}:${documentName}`\n  }\n\n  private pubKey(documentName: string) {\n    return this.getKey(documentName)\n  }\n\n  private subKey(documentName: string) {\n    return this.getKey(documentName)\n  }\n\n  private lockKey(documentName: string) {\n    return `${this.getKey(documentName)}:lock`\n  }\n\n  private encodeMessage(message: Uint8Array) {\n    return Buffer.concat([this.messagePrefix, Buffer.from(message)])\n  }\n\n  private decodeMessage(buffer: Buffer) {\n    const identifierLength = buffer[0]\n    const identifier = buffer.toString('utf-8', 1, identifierLength + 1)\n\n    return [identifier, buffer.slice(identifierLength + 1)]\n  }\n\n  /**\n   * Once a document is loaded, subscribe to the channel in Redis.\n   */\n  public async afterLoadDocument({ documentName, document }: afterLoadDocumentPayload) {\n    return new Promise((resolve, reject) => {\n      // On document creation the node will connect to pub and sub channels\n      // for the document.\n      this.sub.subscribe(this.subKey(documentName), async error => {\n        if (error) {\n          reject(error)\n          return\n        }\n\n        this.publishFirstSyncStep(documentName, document)\n        this.requestAwarenessFromOtherInstances(documentName)\n\n        resolve(undefined)\n      })\n    })\n  }\n\n  /**\n   * Publish the first sync step through Redis.\n   */\n  private async publishFirstSyncStep(documentName: string, document: Document) {\n    const syncMessage = new OutgoingMessage(documentName)\n      .createSyncMessage()\n      .writeFirstSyncStepFor(document)\n\n    return this.pub.publishBuffer(this.pubKey(documentName), this.encodeMessage(syncMessage.toUint8Array()))\n  }\n\n  /**\n   * Let’s ask Redis who is connected already.\n   */\n  private async requestAwarenessFromOtherInstances(documentName: string) {\n    const awarenessMessage = new OutgoingMessage(documentName)\n      .writeQueryAwareness()\n\n    return this.pub.publishBuffer(\n      this.pubKey(documentName),\n      this.encodeMessage(awarenessMessage.toUint8Array()),\n    )\n  }\n\n  /**\n   * Before the document is stored, make sure to set a lock in Redis.\n   * That’s meant to avoid conflicts with other instances trying to store the document.\n   */\n  async onStoreDocument({ documentName }: onStoreDocumentPayload) {\n    // Attempt to acquire a lock and read lastReceivedTimestamp from Redis,\n    // to avoid conflict with other instances storing the same document.\n    return new Promise((resolve, reject) => {\n      this.redlock.lock(this.lockKey(documentName), this.configuration.lockTimeout, async (error, lock) => {\n        if (error || !lock) {\n          // Expected behavior: Could not acquire lock, another instance locked it already.\n          // No further `onStoreDocument` hooks will be executed.\n          reject()\n          return\n        }\n\n        this.locks.set(this.lockKey(documentName), lock)\n\n        resolve(undefined)\n      })\n    })\n  }\n\n  /**\n   * Release the Redis lock, so other instances can store documents.\n   */\n  async afterStoreDocument({ documentName }: afterStoreDocumentPayload) {\n    this.locks.get(this.lockKey(documentName))?.unlock()\n      .catch(() => {\n        // Not able to unlock Redis. The lock will expire after ${lockTimeout} ms.\n        // console.error(`Not able to unlock Redis. The lock will expire after ${this.configuration.lockTimeout}ms.`)\n      })\n      .finally(() => {\n        this.locks.delete(this.lockKey(documentName))\n      })\n  }\n\n  /**\n   * Handle awareness update messages received directly by this Hocuspocus instance.\n   */\n  async onAwarenessUpdate({\n    documentName, awareness, added, updated, removed,\n  }: onAwarenessUpdatePayload) {\n    const changedClients = added.concat(updated, removed)\n    const message = new OutgoingMessage(documentName)\n      .createAwarenessUpdateMessage(awareness, changedClients)\n\n    return this.pub.publishBuffer(\n      this.pubKey(documentName),\n      this.encodeMessage(message.toUint8Array()),\n    )\n  }\n\n  /**\n   * Handle incoming messages published on subscribed document channels.\n   * Note that this will also include messages from ourselves as it is not possible\n   * in Redis to filter these.\n  */\n  private handleIncomingMessage = async (channel: Buffer, data: Buffer) => {\n    const [identifier, messageBuffer] = this.decodeMessage(data)\n\n    if (identifier === this.configuration.identifier) {\n      return\n    }\n\n    const message = new IncomingMessage(messageBuffer)\n    const documentName = message.readVarString()\n    message.writeVarString(documentName)\n\n    const document = this.instance.documents.get(documentName)\n\n    if (!document) {\n      // What does this mean? Why are we subscribed to this document?\n      this.logger.log(`Received message for unknown document ${documentName}`)\n      return\n    }\n\n    new MessageReceiver(\n      message,\n      this.logger,\n      this.redisTransactionOrigin,\n    ).apply(document, undefined, reply => {\n      return this.pub.publishBuffer(\n        this.pubKey(document.name),\n        this.encodeMessage(reply),\n      )\n    })\n  }\n\n  /**\n   * if the ydoc changed, we'll need to inform other Hocuspocus servers about it.\n   */\n  public async onChange(data: onChangePayload): Promise<any> {\n    if (data.transactionOrigin !== this.redisTransactionOrigin) {\n      return this.publishFirstSyncStep(data.documentName, data.document)\n    }\n  }\n\n  /**\n   * Make sure to *not* listen for further changes, when there’s\n   * noone connected anymore.\n   */\n  public onDisconnect = async ({ documentName }: onDisconnectPayload) => {\n    const disconnect = () => {\n      const document = this.instance.documents.get(documentName)\n\n      // Do nothing, when other users are still connected to the document.\n      if (document && document.getConnectionsCount() > 0) {\n        return\n      }\n\n      // Time to end the subscription on the document channel.\n      this.sub.unsubscribe(this.subKey(documentName), (error: any) => {\n        if (error) {\n          console.error(error)\n        }\n      })\n    }\n    // Delay the disconnect procedure to allow last minute syncs to happen\n    setTimeout(disconnect, this.configuration.disconnectDelay)\n  }\n\n  async beforeBroadcastStateless(data: beforeBroadcastStatelessPayload) {\n    const message = new OutgoingMessage(data.documentName)\n      .writeBroadcastStateless(data.payload)\n\n    return this.pub.publishBuffer(\n      this.pubKey(data.documentName),\n      this.encodeMessage(message.toUint8Array()),\n    )\n  }\n\n  /**\n   * Kill the Redlock connection immediately.\n   */\n  async onDestroy() {\n    await this.redlock.quit()\n    this.pub.disconnect(false)\n    this.sub.disconnect(false)\n  }\n}\n"],"names":["uuid","IncomingMessage","MessageReceiver","Debugger","RedisClient","Redlock","OutgoingMessage"],"mappings":";;;;;;;;;;;;;;MAqEa,KAAK,CAAA;AAiChB,IAAA,WAAA,CAAmB,aAAqC,EAAA;AAhCxD;;;;AAIG;QACH,IAAQ,CAAA,QAAA,GAAG,IAAI,CAAA;AAEf,QAAA,IAAA,CAAA,aAAa,GAAkB;AAC7B,YAAA,IAAI,EAAE,IAAI;AACV,YAAA,IAAI,EAAE,WAAW;AACjB,YAAA,MAAM,EAAE,YAAY;AACpB,YAAA,UAAU,EAAE,CAAA,KAAA,EAAQA,OAAI,EAAE,CAAE,CAAA;AAC5B,YAAA,WAAW,EAAE,IAAI;AACjB,YAAA,eAAe,EAAE,IAAI;SACtB,CAAA;QAED,IAAsB,CAAA,sBAAA,GAAG,+BAA+B,CAAA;AAUxD,QAAA,IAAA,CAAA,KAAK,GAAG,IAAI,GAAG,EAAwB,CAAA;AAgLvC;;;;AAIE;AACM,QAAA,IAAA,CAAA,qBAAqB,GAAG,OAAO,OAAe,EAAE,IAAY,KAAI;AACtE,YAAA,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;AAE5D,YAAA,IAAI,UAAU,KAAK,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE;gBAChD,OAAM;AACP,aAAA;AAED,YAAA,MAAM,OAAO,GAAG,IAAIC,sBAAe,CAAC,aAAa,CAAC,CAAA;AAClD,YAAA,MAAM,YAAY,GAAG,OAAO,CAAC,aAAa,EAAE,CAAA;AAC5C,YAAA,OAAO,CAAC,cAAc,CAAC,YAAY,CAAC,CAAA;AAEpC,YAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;YAE1D,IAAI,CAAC,QAAQ,EAAE;;gBAEb,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAyC,sCAAA,EAAA,YAAY,CAAE,CAAA,CAAC,CAAA;gBACxE,OAAM;AACP,aAAA;YAED,IAAIC,sBAAe,CACjB,OAAO,EACP,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,sBAAsB,CAC5B,CAAC,KAAK,CAAC,QAAQ,EAAE,SAAS,EAAE,KAAK,IAAG;gBACnC,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAC3B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAC1B,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAC1B,CAAA;AACH,aAAC,CAAC,CAAA;AACJ,SAAC,CAAA;AAWD;;;AAGG;AACI,QAAA,IAAA,CAAA,YAAY,GAAG,OAAO,EAAE,YAAY,EAAuB,KAAI;YACpE,MAAM,UAAU,GAAG,MAAK;AACtB,gBAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;;gBAG1D,IAAI,QAAQ,IAAI,QAAQ,CAAC,mBAAmB,EAAE,GAAG,CAAC,EAAE;oBAClD,OAAM;AACP,iBAAA;;AAGD,gBAAA,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,KAAU,KAAI;AAC7D,oBAAA,IAAI,KAAK,EAAE;AACT,wBAAA,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;AACrB,qBAAA;AACH,iBAAC,CAAC,CAAA;AACJ,aAAC,CAAA;;YAED,UAAU,CAAC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,CAAA;AAC5D,SAAC,CAAA;QA5OC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SACjB,CAAA;;AAGD,QAAA,IAAI,CAAC,MAAM,GAAG,IAAIC,eAAQ,EAAE,CAAA;;AAG5B,QAAA,MAAM,EACJ,IAAI,EACJ,IAAI,EACJ,OAAO,EACP,KAAK,EACL,KAAK,EACL,YAAY,GACb,GAAG,IAAI,CAAC,aAAa,CAAA;AAEtB,QAAA,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE;AACtC,YAAA,IAAI,CAAC,GAAG,GAAG,YAAY,EAAE,CAAA;AACzB,YAAA,IAAI,CAAC,GAAG,GAAG,YAAY,EAAE,CAAA;AAC1B,SAAA;AAAM,aAAA,IAAI,KAAK,EAAE;AAChB,YAAA,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,SAAS,EAAE,CAAA;AAC5B,YAAA,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,SAAS,EAAE,CAAA;AAC7B,SAAA;AAAM,aAAA,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;AACpC,YAAA,IAAI,CAAC,GAAG,GAAG,IAAIC,+BAAW,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;AAClD,YAAA,IAAI,CAAC,GAAG,GAAG,IAAIA,+BAAW,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;AACnD,SAAA;AAAM,aAAA;AACL,YAAA,IAAI,CAAC,GAAG,GAAG,IAAIA,+BAAW,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AAC/C,YAAA,IAAI,CAAC,GAAG,GAAG,IAAIA,+BAAW,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AAChD,SAAA;QACD,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,eAAe,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAA;AAExD,QAAA,IAAI,CAAC,OAAO,GAAG,IAAIC,2BAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;AAEtC,QAAA,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;QAC5E,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAA;KAC/F;AAED,IAAA,MAAM,WAAW,CAAC,EAAE,QAAQ,EAAsB,EAAA;AAChD,QAAA,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAA;AAC/B,QAAA,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;KACzB;AAEO,IAAA,MAAM,CAAC,YAAoB,EAAA;QACjC,OAAO,CAAA,EAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAA,CAAA,EAAI,YAAY,CAAA,CAAE,CAAA;KACtD;AAEO,IAAA,MAAM,CAAC,YAAoB,EAAA;AACjC,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;KACjC;AAEO,IAAA,MAAM,CAAC,YAAoB,EAAA;AACjC,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;KACjC;AAEO,IAAA,OAAO,CAAC,YAAoB,EAAA;QAClC,OAAO,CAAA,EAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAA;KAC3C;AAEO,IAAA,aAAa,CAAC,OAAmB,EAAA;AACvC,QAAA,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;KACjE;AAEO,IAAA,aAAa,CAAC,MAAc,EAAA;AAClC,QAAA,MAAM,gBAAgB,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;AAClC,QAAA,MAAM,UAAU,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,EAAE,gBAAgB,GAAG,CAAC,CAAC,CAAA;AAEpE,QAAA,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,gBAAgB,GAAG,CAAC,CAAC,CAAC,CAAA;KACxD;AAED;;AAEG;AACI,IAAA,MAAM,iBAAiB,CAAC,EAAE,YAAY,EAAE,QAAQ,EAA4B,EAAA;QACjF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,KAAI;;;AAGrC,YAAA,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,OAAM,KAAK,KAAG;AAC1D,gBAAA,IAAI,KAAK,EAAE;oBACT,MAAM,CAAC,KAAK,CAAC,CAAA;oBACb,OAAM;AACP,iBAAA;AAED,gBAAA,IAAI,CAAC,oBAAoB,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAA;AACjD,gBAAA,IAAI,CAAC,kCAAkC,CAAC,YAAY,CAAC,CAAA;gBAErD,OAAO,CAAC,SAAS,CAAC,CAAA;AACpB,aAAC,CAAC,CAAA;AACJ,SAAC,CAAC,CAAA;KACH;AAED;;AAEG;AACK,IAAA,MAAM,oBAAoB,CAAC,YAAoB,EAAE,QAAkB,EAAA;AACzE,QAAA,MAAM,WAAW,GAAG,IAAIC,sBAAe,CAAC,YAAY,CAAC;AAClD,aAAA,iBAAiB,EAAE;aACnB,qBAAqB,CAAC,QAAQ,CAAC,CAAA;QAElC,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,CAAA;KACzG;AAED;;AAEG;IACK,MAAM,kCAAkC,CAAC,YAAoB,EAAA;AACnE,QAAA,MAAM,gBAAgB,GAAG,IAAIA,sBAAe,CAAC,YAAY,CAAC;AACvD,aAAA,mBAAmB,EAAE,CAAA;QAExB,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAC3B,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EACzB,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC,CACpD,CAAA;KACF;AAED;;;AAGG;AACH,IAAA,MAAM,eAAe,CAAC,EAAE,YAAY,EAA0B,EAAA;;;QAG5D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,KAAI;YACrC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,OAAO,KAAK,EAAE,IAAI,KAAI;AAClG,gBAAA,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE;;;AAGlB,oBAAA,MAAM,EAAE,CAAA;oBACR,OAAM;AACP,iBAAA;AAED,gBAAA,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,CAAA;gBAEhD,OAAO,CAAC,SAAS,CAAC,CAAA;AACpB,aAAC,CAAC,CAAA;AACJ,SAAC,CAAC,CAAA;KACH;AAED;;AAEG;AACH,IAAA,MAAM,kBAAkB,CAAC,EAAE,YAAY,EAA6B,EAAA;;AAClE,QAAA,CAAA,EAAA,GAAA,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,MAAE,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,MAAM,GAC/C,KAAK,CAAC,MAAK;;;AAGZ,SAAC,CACA,CAAA,OAAO,CAAC,MAAK;AACZ,YAAA,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;AAC/C,SAAC,CAAC,CAAA;KACL;AAED;;AAEG;AACH,IAAA,MAAM,iBAAiB,CAAC,EACtB,YAAY,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,GACvB,EAAA;QACzB,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;AACrD,QAAA,MAAM,OAAO,GAAG,IAAIA,sBAAe,CAAC,YAAY,CAAC;AAC9C,aAAA,4BAA4B,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;QAE1D,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAC3B,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EACzB,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAC3C,CAAA;KACF;AAsCD;;AAEG;IACI,MAAM,QAAQ,CAAC,IAAqB,EAAA;AACzC,QAAA,IAAI,IAAI,CAAC,iBAAiB,KAAK,IAAI,CAAC,sBAAsB,EAAE;AAC1D,YAAA,OAAO,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;AACnE,SAAA;KACF;IA0BD,MAAM,wBAAwB,CAAC,IAAqC,EAAA;QAClE,MAAM,OAAO,GAAG,IAAIA,sBAAe,CAAC,IAAI,CAAC,YAAY,CAAC;AACnD,aAAA,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAExC,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAC3B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EAC9B,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAC3C,CAAA;KACF;AAED;;AAEG;AACH,IAAA,MAAM,SAAS,GAAA;AACb,QAAA,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;AACzB,QAAA,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;AAC1B,QAAA,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;KAC3B;AACF;;;;"}

package/dist/hocuspocus-redis.esm.js

@@ -19,28 +19,29 @@ class Redis {
             lockTimeout: 1000,
             disconnectDelay: 1000,
         };
+        this.redisTransactionOrigin = '__hocuspocus__redis__origin__';
         this.locks = new Map();
         /**
-         * Handle incoming messages published on all subscribed document channels.
+         * Handle incoming messages published on subscribed document channels.
          * Note that this will also include messages from ourselves as it is not possible
          * in Redis to filter these.
         */
-        this.handleIncomingMessage = async (channel, pattern, data) => {
-            const message = new IncomingMessage(data);
-            // we don't need the documentName from the message, we are just taking it from the redis channelName.
-            // we have to immediately write it back to the encoder though, to make sure the structure of the message is correct
-            message.writeVarString(message.readVarString());
-            const channelName = pattern.toString();
-            const [_, documentName, identifier] = channelName.split(':');
-            const document = this.instance.documents.get(documentName);
+        this.handleIncomingMessage = async (channel, data) => {
+            const [identifier, messageBuffer] = this.decodeMessage(data);
             if (identifier === this.configuration.identifier) {
                 return;
             }
+            const message = new IncomingMessage(messageBuffer);
+            const documentName = message.readVarString();
+            message.writeVarString(documentName);
+            const document = this.instance.documents.get(documentName);
             if (!document) {
+                // What does this mean? Why are we subscribed to this document?
+                this.logger.log(`Received message for unknown document ${documentName}`);
                 return;
             }
-            new MessageReceiver(message, this.logger).apply(document, undefined, reply => {
-                return this.pub.publishBuffer(this.pubKey(document.name), Buffer.from(reply));
+            new MessageReceiver(message, this.logger, this.redisTransactionOrigin).apply(document, undefined, reply => {
+                return this.pub.publishBuffer(this.pubKey(document.name), this.encodeMessage(reply));
             });
         };
         /**
@@ -55,7 +56,7 @@ class Redis {
                     return;
                 }
                 // Time to end the subscription on the document channel.
-                this.sub.punsubscribe(this.subKey(documentName), (error) => {
+                this.sub.unsubscribe(this.subKey(documentName), (error) => {
                     if (error) {
                         console.error(error);
                     }
@@ -88,8 +89,10 @@ class Redis {
             this.pub = new RedisClient(port, host, options);
             this.sub = new RedisClient(port, host, options);
         }
-        this.sub.on('pmessageBuffer', this.handleIncomingMessage);
+        this.sub.on('messageBuffer', this.handleIncomingMessage);
         this.redlock = new Redlock([this.pub]);
+        const identifierBuffer = Buffer.from(this.configuration.identifier, 'utf-8');
+        this.messagePrefix = Buffer.concat([Buffer.from([identifierBuffer.length]), identifierBuffer]);
     }
     async onConfigure({ instance }) {
         this.logger = instance.debugger;
@@ -99,14 +102,22 @@ class Redis {
         return `${this.configuration.prefix}:${documentName}`;
     }
     pubKey(documentName) {
-        return `${this.getKey(documentName)}:${this.configuration.identifier.replace(/:/g, '')}`;
+        return this.getKey(documentName);
     }
     subKey(documentName) {
-        return `${this.getKey(documentName)}:*`;
+        return this.getKey(documentName);
     }
     lockKey(documentName) {
         return `${this.getKey(documentName)}:lock`;
     }
+    encodeMessage(message) {
+        return Buffer.concat([this.messagePrefix, Buffer.from(message)]);
+    }
+    decodeMessage(buffer) {
+        const identifierLength = buffer[0];
+        const identifier = buffer.toString('utf-8', 1, identifierLength + 1);
+        return [identifier, buffer.slice(identifierLength + 1)];
+    }
     /**
      * Once a document is loaded, subscribe to the channel in Redis.
      */
@@ -114,7 +125,7 @@ class Redis {
         return new Promise((resolve, reject) => {
             // On document creation the node will connect to pub and sub channels
             // for the document.
-            this.sub.psubscribe(this.subKey(documentName), async (error) => {
+            this.sub.subscribe(this.subKey(documentName), async (error) => {
                 if (error) {
                     reject(error);
                     return;
@@ -132,7 +143,7 @@ class Redis {
         const syncMessage = new OutgoingMessage(documentName)
             .createSyncMessage()
             .writeFirstSyncStepFor(document);
-        return this.pub.publishBuffer(this.pubKey(documentName), Buffer.from(syncMessage.toUint8Array()));
+        return this.pub.publishBuffer(this.pubKey(documentName), this.encodeMessage(syncMessage.toUint8Array()));
     }
     /**
      * Let’s ask Redis who is connected already.
@@ -140,7 +151,7 @@ class Redis {
     async requestAwarenessFromOtherInstances(documentName) {
         const awarenessMessage = new OutgoingMessage(documentName)
             .writeQueryAwareness();
-        return this.pub.publishBuffer(this.pubKey(documentName), Buffer.from(awarenessMessage.toUint8Array()));
+        return this.pub.publishBuffer(this.pubKey(documentName), this.encodeMessage(awarenessMessage.toUint8Array()));
     }
     /**
      * Before the document is stored, make sure to set a lock in Redis.
@@ -181,18 +192,20 @@ class Redis {
         const changedClients = added.concat(updated, removed);
         const message = new OutgoingMessage(documentName)
             .createAwarenessUpdateMessage(awareness, changedClients);
-        return this.pub.publishBuffer(this.pubKey(documentName), Buffer.from(message.toUint8Array()));
+        return this.pub.publishBuffer(this.pubKey(documentName), this.encodeMessage(message.toUint8Array()));
     }
     /**
      * if the ydoc changed, we'll need to inform other Hocuspocus servers about it.
      */
     async onChange(data) {
-        return this.publishFirstSyncStep(data.documentName, data.document);
+        if (data.transactionOrigin !== this.redisTransactionOrigin) {
+            return this.publishFirstSyncStep(data.documentName, data.document);
+        }
     }
     async beforeBroadcastStateless(data) {
         const message = new OutgoingMessage(data.documentName)
             .writeBroadcastStateless(data.payload);
-        return this.pub.publishBuffer(this.pubKey(data.documentName), Buffer.from(message.toUint8Array()));
+        return this.pub.publishBuffer(this.pubKey(data.documentName), this.encodeMessage(message.toUint8Array()));
     }
     /**
      * Kill the Redlock connection immediately.

package/dist/hocuspocus-redis.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"hocuspocus-redis.esm.js","sources":["../src/Redis.ts"],"sourcesContent":["import RedisClient, { ClusterNode, ClusterOptions, RedisOptions } from 'ioredis'\nimport Redlock from 'redlock'\nimport { v4 as uuid } from 'uuid'\nimport {\n  IncomingMessage,\n  OutgoingMessage,\n  Document,\n  Extension,\n  afterLoadDocumentPayload,\n  afterStoreDocumentPayload,\n  onDisconnectPayload,\n  onStoreDocumentPayload,\n  onAwarenessUpdatePayload,\n  onChangePayload,\n  MessageReceiver,\n  Debugger,\n  onConfigurePayload,\n  beforeBroadcastStatelessPayload, Hocuspocus,\n} from '@hocuspocus/server'\n\nexport type RedisInstance = RedisClient.Cluster | RedisClient.Redis\n\nexport interface Configuration {\n  /**\n   * Redis port\n   */\n  port: number,\n  /**\n   * Redis host\n   */\n  host: string,\n  /**\n   * Redis Cluster\n   */\n  nodes?: ClusterNode[],\n  /**\n   * Duplicate from an existed Redis instance\n   */\n  redis?: RedisInstance,\n  /**\n   * Redis instance creator\n   */\n  createClient?: () => RedisInstance,\n  /**\n   * Options passed directly to Redis constructor\n   *\n   * https://github.com/luin/ioredis/blob/master/API.md#new-redisport-host-options\n   */\n  options?: ClusterOptions | RedisOptions,\n  /**\n   * An unique instance name, required to filter messages in Redis.\n   * If none is provided an unique id is generated.\n   */\n  identifier: string,\n  /**\n   * Namespace for Redis keys, if none is provided 'hocuspocus' is used\n   */\n  prefix: string,\n  /**\n   * The maximum time for the Redis lock in ms (in case it can’t be released).\n   */\n  lockTimeout: number,\n  /**\n   * A delay before onDisconnect is executed. This allows last minute updates'\n   * sync messages to be received by the subscription before it's closed.\n   */\n  disconnectDelay: number,\n}\n\nexport class Redis implements Extension {\n  /**\n   * Make sure to give that extension a higher priority, so\n   * the `onStoreDocument` hook is able to intercept the chain,\n   * before documents are stored to the database.\n   */\n  priority = 1000\n\n  configuration: Configuration = {\n    port: 6379,\n    host: '127.0.0.1',\n    prefix: 'hocuspocus',\n    identifier: `host-${uuid()}`,\n    lockTimeout: 1000,\n    disconnectDelay: 1000,\n  }\n\n  pub: RedisInstance\n\n  sub: RedisInstance\n\n  instance!: Hocuspocus\n\n  redlock: Redlock\n\n  locks = new Map<string, Redlock.Lock>()\n\n  logger: Debugger\n\n  public constructor(configuration: Partial<Configuration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n\n    // We’ll replace that in the onConfigure hook with the global instance.\n    this.logger = new Debugger()\n\n    // Create Redis instance\n    const {\n      port,\n      host,\n      options,\n      nodes,\n      redis,\n      createClient,\n    } = this.configuration\n\n    if (typeof createClient === 'function') {\n      this.pub = createClient()\n      this.sub = createClient()\n    } else if (redis) {\n      this.pub = redis.duplicate()\n      this.sub = redis.duplicate()\n    } else if (nodes && nodes.length > 0) {\n      this.pub = new RedisClient.Cluster(nodes, options)\n      this.sub = new RedisClient.Cluster(nodes, options)\n    } else {\n      this.pub = new RedisClient(port, host, options)\n      this.sub = new RedisClient(port, host, options)\n    }\n    this.sub.on('pmessageBuffer', this.handleIncomingMessage)\n\n    this.redlock = new Redlock([this.pub])\n  }\n\n  async onConfigure({ instance }: onConfigurePayload) {\n    this.logger = instance.debugger\n    this.instance = instance\n  }\n\n  private getKey(documentName: string) {\n    return `${this.configuration.prefix}:${documentName}`\n  }\n\n  private pubKey(documentName: string) {\n    return `${this.getKey(documentName)}:${this.configuration.identifier.replace(/:/g, '')}`\n  }\n\n  private subKey(documentName: string) {\n    return `${this.getKey(documentName)}:*`\n  }\n\n  private lockKey(documentName: string) {\n    return `${this.getKey(documentName)}:lock`\n  }\n\n  /**\n   * Once a document is loaded, subscribe to the channel in Redis.\n   */\n  public async afterLoadDocument({ documentName, document }: afterLoadDocumentPayload) {\n    return new Promise((resolve, reject) => {\n      // On document creation the node will connect to pub and sub channels\n      // for the document.\n      this.sub.psubscribe(this.subKey(documentName), async error => {\n        if (error) {\n          reject(error)\n          return\n        }\n\n        this.publishFirstSyncStep(documentName, document)\n        this.requestAwarenessFromOtherInstances(documentName)\n\n        resolve(undefined)\n      })\n    })\n  }\n\n  /**\n   * Publish the first sync step through Redis.\n   */\n  private async publishFirstSyncStep(documentName: string, document: Document) {\n    const syncMessage = new OutgoingMessage(documentName)\n      .createSyncMessage()\n      .writeFirstSyncStepFor(document)\n\n    return this.pub.publishBuffer(this.pubKey(documentName), Buffer.from(syncMessage.toUint8Array()))\n  }\n\n  /**\n   * Let’s ask Redis who is connected already.\n   */\n  private async requestAwarenessFromOtherInstances(documentName: string) {\n    const awarenessMessage = new OutgoingMessage(documentName)\n      .writeQueryAwareness()\n\n    return this.pub.publishBuffer(\n      this.pubKey(documentName),\n      Buffer.from(awarenessMessage.toUint8Array()),\n    )\n  }\n\n  /**\n   * Before the document is stored, make sure to set a lock in Redis.\n   * That’s meant to avoid conflicts with other instances trying to store the document.\n   */\n  async onStoreDocument({ documentName }: onStoreDocumentPayload) {\n    // Attempt to acquire a lock and read lastReceivedTimestamp from Redis,\n    // to avoid conflict with other instances storing the same document.\n    return new Promise((resolve, reject) => {\n      this.redlock.lock(this.lockKey(documentName), this.configuration.lockTimeout, async (error, lock) => {\n        if (error || !lock) {\n          // Expected behavior: Could not acquire lock, another instance locked it already.\n          // No further `onStoreDocument` hooks will be executed.\n          reject()\n          return\n        }\n\n        this.locks.set(this.lockKey(documentName), lock)\n\n        resolve(undefined)\n      })\n    })\n  }\n\n  /**\n   * Release the Redis lock, so other instances can store documents.\n   */\n  async afterStoreDocument({ documentName }: afterStoreDocumentPayload) {\n    this.locks.get(this.lockKey(documentName))?.unlock()\n      .catch(() => {\n        // Not able to unlock Redis. The lock will expire after ${lockTimeout} ms.\n        // console.error(`Not able to unlock Redis. The lock will expire after ${this.configuration.lockTimeout}ms.`)\n      })\n      .finally(() => {\n        this.locks.delete(this.lockKey(documentName))\n      })\n  }\n\n  /**\n   * Handle awareness update messages received directly by this Hocuspocus instance.\n   */\n  async onAwarenessUpdate({\n    documentName, awareness, added, updated, removed,\n  }: onAwarenessUpdatePayload) {\n    const changedClients = added.concat(updated, removed)\n    const message = new OutgoingMessage(documentName)\n      .createAwarenessUpdateMessage(awareness, changedClients)\n\n    return this.pub.publishBuffer(\n      this.pubKey(documentName),\n      Buffer.from(message.toUint8Array()),\n    )\n  }\n\n  /**\n   * Handle incoming messages published on all subscribed document channels.\n   * Note that this will also include messages from ourselves as it is not possible\n   * in Redis to filter these.\n  */\n  private handleIncomingMessage = async (channel: Buffer, pattern: Buffer, data: Buffer) => {\n    const message = new IncomingMessage(data)\n    // we don't need the documentName from the message, we are just taking it from the redis channelName.\n    // we have to immediately write it back to the encoder though, to make sure the structure of the message is correct\n    message.writeVarString(message.readVarString())\n\n    const channelName = pattern.toString()\n    const [_, documentName, identifier] = channelName.split(':')\n    const document = this.instance.documents.get(documentName)\n\n    if (identifier === this.configuration.identifier) {\n      return\n    }\n\n    if (!document) {\n      return\n    }\n\n    new MessageReceiver(\n      message,\n      this.logger,\n    ).apply(document, undefined, reply => {\n      return this.pub.publishBuffer(\n        this.pubKey(document.name),\n        Buffer.from(reply),\n      )\n    })\n  }\n\n  /**\n   * if the ydoc changed, we'll need to inform other Hocuspocus servers about it.\n   */\n  public async onChange(data: onChangePayload): Promise<any> {\n    return this.publishFirstSyncStep(data.documentName, data.document)\n  }\n\n  /**\n   * Make sure to *not* listen for further changes, when there’s\n   * noone connected anymore.\n   */\n  public onDisconnect = async ({ documentName }: onDisconnectPayload) => {\n    const disconnect = () => {\n      const document = this.instance.documents.get(documentName)\n\n      // Do nothing, when other users are still connected to the document.\n      if (document && document.getConnectionsCount() > 0) {\n        return\n      }\n\n      // Time to end the subscription on the document channel.\n      this.sub.punsubscribe(this.subKey(documentName), (error: any) => {\n        if (error) {\n          console.error(error)\n        }\n      })\n    }\n    // Delay the disconnect procedure to allow last minute syncs to happen\n    setTimeout(disconnect, this.configuration.disconnectDelay)\n  }\n\n  async beforeBroadcastStateless(data: beforeBroadcastStatelessPayload) {\n    const message = new OutgoingMessage(data.documentName)\n      .writeBroadcastStateless(data.payload)\n\n    return this.pub.publishBuffer(\n      this.pubKey(data.documentName),\n      Buffer.from(message.toUint8Array()),\n    )\n  }\n\n  /**\n   * Kill the Redlock connection immediately.\n   */\n  async onDestroy() {\n    await this.redlock.quit()\n    this.pub.disconnect(false)\n    this.sub.disconnect(false)\n  }\n}\n"],"names":["uuid"],"mappings":";;;;;MAqEa,KAAK,CAAA;AA6BhB,IAAA,WAAA,CAAmB,aAAqC,EAAA;AA5BxD;;;;AAIG;QACH,IAAQ,CAAA,QAAA,GAAG,IAAI,CAAA;AAEf,QAAA,IAAA,CAAA,aAAa,GAAkB;AAC7B,YAAA,IAAI,EAAE,IAAI;AACV,YAAA,IAAI,EAAE,WAAW;AACjB,YAAA,MAAM,EAAE,YAAY;AACpB,YAAA,UAAU,EAAE,CAAA,KAAA,EAAQA,EAAI,EAAE,CAAE,CAAA;AAC5B,YAAA,WAAW,EAAE,IAAI;AACjB,YAAA,eAAe,EAAE,IAAI;SACtB,CAAA;AAUD,QAAA,IAAA,CAAA,KAAK,GAAG,IAAI,GAAG,EAAwB,CAAA;AAgKvC;;;;AAIE;QACM,IAAqB,CAAA,qBAAA,GAAG,OAAO,OAAe,EAAE,OAAe,EAAE,IAAY,KAAI;AACvF,YAAA,MAAM,OAAO,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAA;;;YAGzC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,CAAA;AAE/C,YAAA,MAAM,WAAW,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAA;AACtC,YAAA,MAAM,CAAC,CAAC,EAAE,YAAY,EAAE,UAAU,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;AAC5D,YAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;AAE1D,YAAA,IAAI,UAAU,KAAK,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE;gBAChD,OAAM;AACP,aAAA;YAED,IAAI,CAAC,QAAQ,EAAE;gBACb,OAAM;AACP,aAAA;AAED,YAAA,IAAI,eAAe,CACjB,OAAO,EACP,IAAI,CAAC,MAAM,CACZ,CAAC,KAAK,CAAC,QAAQ,EAAE,SAAS,EAAE,KAAK,IAAG;gBACnC,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAC3B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAC1B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CACnB,CAAA;AACH,aAAC,CAAC,CAAA;AACJ,SAAC,CAAA;AASD;;;AAGG;AACI,QAAA,IAAA,CAAA,YAAY,GAAG,OAAO,EAAE,YAAY,EAAuB,KAAI;YACpE,MAAM,UAAU,GAAG,MAAK;AACtB,gBAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;;gBAG1D,IAAI,QAAQ,IAAI,QAAQ,CAAC,mBAAmB,EAAE,GAAG,CAAC,EAAE;oBAClD,OAAM;AACP,iBAAA;;AAGD,gBAAA,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,KAAU,KAAI;AAC9D,oBAAA,IAAI,KAAK,EAAE;AACT,wBAAA,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;AACrB,qBAAA;AACH,iBAAC,CAAC,CAAA;AACJ,aAAC,CAAA;;YAED,UAAU,CAAC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,CAAA;AAC5D,SAAC,CAAA;QA1NC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SACjB,CAAA;;AAGD,QAAA,IAAI,CAAC,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAA;;AAG5B,QAAA,MAAM,EACJ,IAAI,EACJ,IAAI,EACJ,OAAO,EACP,KAAK,EACL,KAAK,EACL,YAAY,GACb,GAAG,IAAI,CAAC,aAAa,CAAA;AAEtB,QAAA,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE;AACtC,YAAA,IAAI,CAAC,GAAG,GAAG,YAAY,EAAE,CAAA;AACzB,YAAA,IAAI,CAAC,GAAG,GAAG,YAAY,EAAE,CAAA;AAC1B,SAAA;AAAM,aAAA,IAAI,KAAK,EAAE;AAChB,YAAA,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,SAAS,EAAE,CAAA;AAC5B,YAAA,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,SAAS,EAAE,CAAA;AAC7B,SAAA;AAAM,aAAA,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;AACpC,YAAA,IAAI,CAAC,GAAG,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;AAClD,YAAA,IAAI,CAAC,GAAG,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;AACnD,SAAA;AAAM,aAAA;AACL,YAAA,IAAI,CAAC,GAAG,GAAG,IAAI,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AAC/C,YAAA,IAAI,CAAC,GAAG,GAAG,IAAI,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AAChD,SAAA;QACD,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,gBAAgB,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAA;AAEzD,QAAA,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;KACvC;AAED,IAAA,MAAM,WAAW,CAAC,EAAE,QAAQ,EAAsB,EAAA;AAChD,QAAA,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAA;AAC/B,QAAA,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;KACzB;AAEO,IAAA,MAAM,CAAC,YAAoB,EAAA;QACjC,OAAO,CAAA,EAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAA,CAAA,EAAI,YAAY,CAAA,CAAE,CAAA;KACtD;AAEO,IAAA,MAAM,CAAC,YAAoB,EAAA;QACjC,OAAO,CAAA,EAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA,CAAE,CAAA;KACzF;AAEO,IAAA,MAAM,CAAC,YAAoB,EAAA;QACjC,OAAO,CAAA,EAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAA;KACxC;AAEO,IAAA,OAAO,CAAC,YAAoB,EAAA;QAClC,OAAO,CAAA,EAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAA;KAC3C;AAED;;AAEG;AACI,IAAA,MAAM,iBAAiB,CAAC,EAAE,YAAY,EAAE,QAAQ,EAA4B,EAAA;QACjF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,KAAI;;;AAGrC,YAAA,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,OAAM,KAAK,KAAG;AAC3D,gBAAA,IAAI,KAAK,EAAE;oBACT,MAAM,CAAC,KAAK,CAAC,CAAA;oBACb,OAAM;AACP,iBAAA;AAED,gBAAA,IAAI,CAAC,oBAAoB,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAA;AACjD,gBAAA,IAAI,CAAC,kCAAkC,CAAC,YAAY,CAAC,CAAA;gBAErD,OAAO,CAAC,SAAS,CAAC,CAAA;AACpB,aAAC,CAAC,CAAA;AACJ,SAAC,CAAC,CAAA;KACH;AAED;;AAEG;AACK,IAAA,MAAM,oBAAoB,CAAC,YAAoB,EAAE,QAAkB,EAAA;AACzE,QAAA,MAAM,WAAW,GAAG,IAAI,eAAe,CAAC,YAAY,CAAC;AAClD,aAAA,iBAAiB,EAAE;aACnB,qBAAqB,CAAC,QAAQ,CAAC,CAAA;QAElC,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,CAAA;KAClG;AAED;;AAEG;IACK,MAAM,kCAAkC,CAAC,YAAoB,EAAA;AACnE,QAAA,MAAM,gBAAgB,GAAG,IAAI,eAAe,CAAC,YAAY,CAAC;AACvD,aAAA,mBAAmB,EAAE,CAAA;QAExB,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAC3B,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EACzB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC,CAC7C,CAAA;KACF;AAED;;;AAGG;AACH,IAAA,MAAM,eAAe,CAAC,EAAE,YAAY,EAA0B,EAAA;;;QAG5D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,KAAI;YACrC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,OAAO,KAAK,EAAE,IAAI,KAAI;AAClG,gBAAA,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE;;;AAGlB,oBAAA,MAAM,EAAE,CAAA;oBACR,OAAM;AACP,iBAAA;AAED,gBAAA,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,CAAA;gBAEhD,OAAO,CAAC,SAAS,CAAC,CAAA;AACpB,aAAC,CAAC,CAAA;AACJ,SAAC,CAAC,CAAA;KACH;AAED;;AAEG;AACH,IAAA,MAAM,kBAAkB,CAAC,EAAE,YAAY,EAA6B,EAAA;;AAClE,QAAA,CAAA,EAAA,GAAA,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,MAAE,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,MAAM,GAC/C,KAAK,CAAC,MAAK;;;AAGZ,SAAC,CACA,CAAA,OAAO,CAAC,MAAK;AACZ,YAAA,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;AAC/C,SAAC,CAAC,CAAA;KACL;AAED;;AAEG;AACH,IAAA,MAAM,iBAAiB,CAAC,EACtB,YAAY,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,GACvB,EAAA;QACzB,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;AACrD,QAAA,MAAM,OAAO,GAAG,IAAI,eAAe,CAAC,YAAY,CAAC;AAC9C,aAAA,4BAA4B,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;QAE1D,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAC3B,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EACzB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CACpC,CAAA;KACF;AAoCD;;AAEG;IACI,MAAM,QAAQ,CAAC,IAAqB,EAAA;AACzC,QAAA,OAAO,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;KACnE;IA0BD,MAAM,wBAAwB,CAAC,IAAqC,EAAA;QAClE,MAAM,OAAO,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC;AACnD,aAAA,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAExC,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAC3B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EAC9B,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CACpC,CAAA;KACF;AAED;;AAEG;AACH,IAAA,MAAM,SAAS,GAAA;AACb,QAAA,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;AACzB,QAAA,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;AAC1B,QAAA,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;KAC3B;AACF;;;;"}
+{"version":3,"file":"hocuspocus-redis.esm.js","sources":["../src/Redis.ts"],"sourcesContent":["import RedisClient, { ClusterNode, ClusterOptions, RedisOptions } from 'ioredis'\nimport Redlock from 'redlock'\nimport { v4 as uuid } from 'uuid'\nimport {\n  IncomingMessage,\n  OutgoingMessage,\n  Document,\n  Extension,\n  afterLoadDocumentPayload,\n  afterStoreDocumentPayload,\n  onDisconnectPayload,\n  onStoreDocumentPayload,\n  onAwarenessUpdatePayload,\n  onChangePayload,\n  MessageReceiver,\n  Debugger,\n  onConfigurePayload,\n  beforeBroadcastStatelessPayload, Hocuspocus,\n} from '@hocuspocus/server'\n\nexport type RedisInstance = RedisClient.Cluster | RedisClient.Redis\n\nexport interface Configuration {\n  /**\n   * Redis port\n   */\n  port: number,\n  /**\n   * Redis host\n   */\n  host: string,\n  /**\n   * Redis Cluster\n   */\n  nodes?: ClusterNode[],\n  /**\n   * Duplicate from an existed Redis instance\n   */\n  redis?: RedisInstance,\n  /**\n   * Redis instance creator\n   */\n  createClient?: () => RedisInstance,\n  /**\n   * Options passed directly to Redis constructor\n   *\n   * https://github.com/luin/ioredis/blob/master/API.md#new-redisport-host-options\n   */\n  options?: ClusterOptions | RedisOptions,\n  /**\n   * An unique instance name, required to filter messages in Redis.\n   * If none is provided an unique id is generated.\n   */\n  identifier: string,\n  /**\n   * Namespace for Redis keys, if none is provided 'hocuspocus' is used\n   */\n  prefix: string,\n  /**\n   * The maximum time for the Redis lock in ms (in case it can’t be released).\n   */\n  lockTimeout: number,\n  /**\n   * A delay before onDisconnect is executed. This allows last minute updates'\n   * sync messages to be received by the subscription before it's closed.\n   */\n  disconnectDelay: number,\n}\n\nexport class Redis implements Extension {\n  /**\n   * Make sure to give that extension a higher priority, so\n   * the `onStoreDocument` hook is able to intercept the chain,\n   * before documents are stored to the database.\n   */\n  priority = 1000\n\n  configuration: Configuration = {\n    port: 6379,\n    host: '127.0.0.1',\n    prefix: 'hocuspocus',\n    identifier: `host-${uuid()}`,\n    lockTimeout: 1000,\n    disconnectDelay: 1000,\n  }\n\n  redisTransactionOrigin = '__hocuspocus__redis__origin__'\n\n  pub: RedisInstance\n\n  sub: RedisInstance\n\n  instance!: Hocuspocus\n\n  redlock: Redlock\n\n  locks = new Map<string, Redlock.Lock>()\n\n  logger: Debugger\n\n  messagePrefix: Buffer\n\n  public constructor(configuration: Partial<Configuration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n\n    // We’ll replace that in the onConfigure hook with the global instance.\n    this.logger = new Debugger()\n\n    // Create Redis instance\n    const {\n      port,\n      host,\n      options,\n      nodes,\n      redis,\n      createClient,\n    } = this.configuration\n\n    if (typeof createClient === 'function') {\n      this.pub = createClient()\n      this.sub = createClient()\n    } else if (redis) {\n      this.pub = redis.duplicate()\n      this.sub = redis.duplicate()\n    } else if (nodes && nodes.length > 0) {\n      this.pub = new RedisClient.Cluster(nodes, options)\n      this.sub = new RedisClient.Cluster(nodes, options)\n    } else {\n      this.pub = new RedisClient(port, host, options)\n      this.sub = new RedisClient(port, host, options)\n    }\n    this.sub.on('messageBuffer', this.handleIncomingMessage)\n\n    this.redlock = new Redlock([this.pub])\n\n    const identifierBuffer = Buffer.from(this.configuration.identifier, 'utf-8')\n    this.messagePrefix = Buffer.concat([Buffer.from([identifierBuffer.length]), identifierBuffer])\n  }\n\n  async onConfigure({ instance }: onConfigurePayload) {\n    this.logger = instance.debugger\n    this.instance = instance\n  }\n\n  private getKey(documentName: string) {\n    return `${this.configuration.prefix}:${documentName}`\n  }\n\n  private pubKey(documentName: string) {\n    return this.getKey(documentName)\n  }\n\n  private subKey(documentName: string) {\n    return this.getKey(documentName)\n  }\n\n  private lockKey(documentName: string) {\n    return `${this.getKey(documentName)}:lock`\n  }\n\n  private encodeMessage(message: Uint8Array) {\n    return Buffer.concat([this.messagePrefix, Buffer.from(message)])\n  }\n\n  private decodeMessage(buffer: Buffer) {\n    const identifierLength = buffer[0]\n    const identifier = buffer.toString('utf-8', 1, identifierLength + 1)\n\n    return [identifier, buffer.slice(identifierLength + 1)]\n  }\n\n  /**\n   * Once a document is loaded, subscribe to the channel in Redis.\n   */\n  public async afterLoadDocument({ documentName, document }: afterLoadDocumentPayload) {\n    return new Promise((resolve, reject) => {\n      // On document creation the node will connect to pub and sub channels\n      // for the document.\n      this.sub.subscribe(this.subKey(documentName), async error => {\n        if (error) {\n          reject(error)\n          return\n        }\n\n        this.publishFirstSyncStep(documentName, document)\n        this.requestAwarenessFromOtherInstances(documentName)\n\n        resolve(undefined)\n      })\n    })\n  }\n\n  /**\n   * Publish the first sync step through Redis.\n   */\n  private async publishFirstSyncStep(documentName: string, document: Document) {\n    const syncMessage = new OutgoingMessage(documentName)\n      .createSyncMessage()\n      .writeFirstSyncStepFor(document)\n\n    return this.pub.publishBuffer(this.pubKey(documentName), this.encodeMessage(syncMessage.toUint8Array()))\n  }\n\n  /**\n   * Let’s ask Redis who is connected already.\n   */\n  private async requestAwarenessFromOtherInstances(documentName: string) {\n    const awarenessMessage = new OutgoingMessage(documentName)\n      .writeQueryAwareness()\n\n    return this.pub.publishBuffer(\n      this.pubKey(documentName),\n      this.encodeMessage(awarenessMessage.toUint8Array()),\n    )\n  }\n\n  /**\n   * Before the document is stored, make sure to set a lock in Redis.\n   * That’s meant to avoid conflicts with other instances trying to store the document.\n   */\n  async onStoreDocument({ documentName }: onStoreDocumentPayload) {\n    // Attempt to acquire a lock and read lastReceivedTimestamp from Redis,\n    // to avoid conflict with other instances storing the same document.\n    return new Promise((resolve, reject) => {\n      this.redlock.lock(this.lockKey(documentName), this.configuration.lockTimeout, async (error, lock) => {\n        if (error || !lock) {\n          // Expected behavior: Could not acquire lock, another instance locked it already.\n          // No further `onStoreDocument` hooks will be executed.\n          reject()\n          return\n        }\n\n        this.locks.set(this.lockKey(documentName), lock)\n\n        resolve(undefined)\n      })\n    })\n  }\n\n  /**\n   * Release the Redis lock, so other instances can store documents.\n   */\n  async afterStoreDocument({ documentName }: afterStoreDocumentPayload) {\n    this.locks.get(this.lockKey(documentName))?.unlock()\n      .catch(() => {\n        // Not able to unlock Redis. The lock will expire after ${lockTimeout} ms.\n        // console.error(`Not able to unlock Redis. The lock will expire after ${this.configuration.lockTimeout}ms.`)\n      })\n      .finally(() => {\n        this.locks.delete(this.lockKey(documentName))\n      })\n  }\n\n  /**\n   * Handle awareness update messages received directly by this Hocuspocus instance.\n   */\n  async onAwarenessUpdate({\n    documentName, awareness, added, updated, removed,\n  }: onAwarenessUpdatePayload) {\n    const changedClients = added.concat(updated, removed)\n    const message = new OutgoingMessage(documentName)\n      .createAwarenessUpdateMessage(awareness, changedClients)\n\n    return this.pub.publishBuffer(\n      this.pubKey(documentName),\n      this.encodeMessage(message.toUint8Array()),\n    )\n  }\n\n  /**\n   * Handle incoming messages published on subscribed document channels.\n   * Note that this will also include messages from ourselves as it is not possible\n   * in Redis to filter these.\n  */\n  private handleIncomingMessage = async (channel: Buffer, data: Buffer) => {\n    const [identifier, messageBuffer] = this.decodeMessage(data)\n\n    if (identifier === this.configuration.identifier) {\n      return\n    }\n\n    const message = new IncomingMessage(messageBuffer)\n    const documentName = message.readVarString()\n    message.writeVarString(documentName)\n\n    const document = this.instance.documents.get(documentName)\n\n    if (!document) {\n      // What does this mean? Why are we subscribed to this document?\n      this.logger.log(`Received message for unknown document ${documentName}`)\n      return\n    }\n\n    new MessageReceiver(\n      message,\n      this.logger,\n      this.redisTransactionOrigin,\n    ).apply(document, undefined, reply => {\n      return this.pub.publishBuffer(\n        this.pubKey(document.name),\n        this.encodeMessage(reply),\n      )\n    })\n  }\n\n  /**\n   * if the ydoc changed, we'll need to inform other Hocuspocus servers about it.\n   */\n  public async onChange(data: onChangePayload): Promise<any> {\n    if (data.transactionOrigin !== this.redisTransactionOrigin) {\n      return this.publishFirstSyncStep(data.documentName, data.document)\n    }\n  }\n\n  /**\n   * Make sure to *not* listen for further changes, when there’s\n   * noone connected anymore.\n   */\n  public onDisconnect = async ({ documentName }: onDisconnectPayload) => {\n    const disconnect = () => {\n      const document = this.instance.documents.get(documentName)\n\n      // Do nothing, when other users are still connected to the document.\n      if (document && document.getConnectionsCount() > 0) {\n        return\n      }\n\n      // Time to end the subscription on the document channel.\n      this.sub.unsubscribe(this.subKey(documentName), (error: any) => {\n        if (error) {\n          console.error(error)\n        }\n      })\n    }\n    // Delay the disconnect procedure to allow last minute syncs to happen\n    setTimeout(disconnect, this.configuration.disconnectDelay)\n  }\n\n  async beforeBroadcastStateless(data: beforeBroadcastStatelessPayload) {\n    const message = new OutgoingMessage(data.documentName)\n      .writeBroadcastStateless(data.payload)\n\n    return this.pub.publishBuffer(\n      this.pubKey(data.documentName),\n      this.encodeMessage(message.toUint8Array()),\n    )\n  }\n\n  /**\n   * Kill the Redlock connection immediately.\n   */\n  async onDestroy() {\n    await this.redlock.quit()\n    this.pub.disconnect(false)\n    this.sub.disconnect(false)\n  }\n}\n"],"names":["uuid"],"mappings":";;;;;MAqEa,KAAK,CAAA;AAiChB,IAAA,WAAA,CAAmB,aAAqC,EAAA;AAhCxD;;;;AAIG;QACH,IAAQ,CAAA,QAAA,GAAG,IAAI,CAAA;AAEf,QAAA,IAAA,CAAA,aAAa,GAAkB;AAC7B,YAAA,IAAI,EAAE,IAAI;AACV,YAAA,IAAI,EAAE,WAAW;AACjB,YAAA,MAAM,EAAE,YAAY;AACpB,YAAA,UAAU,EAAE,CAAA,KAAA,EAAQA,EAAI,EAAE,CAAE,CAAA;AAC5B,YAAA,WAAW,EAAE,IAAI;AACjB,YAAA,eAAe,EAAE,IAAI;SACtB,CAAA;QAED,IAAsB,CAAA,sBAAA,GAAG,+BAA+B,CAAA;AAUxD,QAAA,IAAA,CAAA,KAAK,GAAG,IAAI,GAAG,EAAwB,CAAA;AAgLvC;;;;AAIE;AACM,QAAA,IAAA,CAAA,qBAAqB,GAAG,OAAO,OAAe,EAAE,IAAY,KAAI;AACtE,YAAA,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;AAE5D,YAAA,IAAI,UAAU,KAAK,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE;gBAChD,OAAM;AACP,aAAA;AAED,YAAA,MAAM,OAAO,GAAG,IAAI,eAAe,CAAC,aAAa,CAAC,CAAA;AAClD,YAAA,MAAM,YAAY,GAAG,OAAO,CAAC,aAAa,EAAE,CAAA;AAC5C,YAAA,OAAO,CAAC,cAAc,CAAC,YAAY,CAAC,CAAA;AAEpC,YAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;YAE1D,IAAI,CAAC,QAAQ,EAAE;;gBAEb,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAyC,sCAAA,EAAA,YAAY,CAAE,CAAA,CAAC,CAAA;gBACxE,OAAM;AACP,aAAA;YAED,IAAI,eAAe,CACjB,OAAO,EACP,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,sBAAsB,CAC5B,CAAC,KAAK,CAAC,QAAQ,EAAE,SAAS,EAAE,KAAK,IAAG;gBACnC,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAC3B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAC1B,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAC1B,CAAA;AACH,aAAC,CAAC,CAAA;AACJ,SAAC,CAAA;AAWD;;;AAGG;AACI,QAAA,IAAA,CAAA,YAAY,GAAG,OAAO,EAAE,YAAY,EAAuB,KAAI;YACpE,MAAM,UAAU,GAAG,MAAK;AACtB,gBAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;;gBAG1D,IAAI,QAAQ,IAAI,QAAQ,CAAC,mBAAmB,EAAE,GAAG,CAAC,EAAE;oBAClD,OAAM;AACP,iBAAA;;AAGD,gBAAA,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,KAAU,KAAI;AAC7D,oBAAA,IAAI,KAAK,EAAE;AACT,wBAAA,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;AACrB,qBAAA;AACH,iBAAC,CAAC,CAAA;AACJ,aAAC,CAAA;;YAED,UAAU,CAAC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,CAAA;AAC5D,SAAC,CAAA;QA5OC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SACjB,CAAA;;AAGD,QAAA,IAAI,CAAC,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAA;;AAG5B,QAAA,MAAM,EACJ,IAAI,EACJ,IAAI,EACJ,OAAO,EACP,KAAK,EACL,KAAK,EACL,YAAY,GACb,GAAG,IAAI,CAAC,aAAa,CAAA;AAEtB,QAAA,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE;AACtC,YAAA,IAAI,CAAC,GAAG,GAAG,YAAY,EAAE,CAAA;AACzB,YAAA,IAAI,CAAC,GAAG,GAAG,YAAY,EAAE,CAAA;AAC1B,SAAA;AAAM,aAAA,IAAI,KAAK,EAAE;AAChB,YAAA,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,SAAS,EAAE,CAAA;AAC5B,YAAA,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,SAAS,EAAE,CAAA;AAC7B,SAAA;AAAM,aAAA,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;AACpC,YAAA,IAAI,CAAC,GAAG,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;AAClD,YAAA,IAAI,CAAC,GAAG,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;AACnD,SAAA;AAAM,aAAA;AACL,YAAA,IAAI,CAAC,GAAG,GAAG,IAAI,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AAC/C,YAAA,IAAI,CAAC,GAAG,GAAG,IAAI,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AAChD,SAAA;QACD,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,eAAe,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAA;AAExD,QAAA,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;AAEtC,QAAA,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;QAC5E,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAA;KAC/F;AAED,IAAA,MAAM,WAAW,CAAC,EAAE,QAAQ,EAAsB,EAAA;AAChD,QAAA,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAA;AAC/B,QAAA,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;KACzB;AAEO,IAAA,MAAM,CAAC,YAAoB,EAAA;QACjC,OAAO,CAAA,EAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAA,CAAA,EAAI,YAAY,CAAA,CAAE,CAAA;KACtD;AAEO,IAAA,MAAM,CAAC,YAAoB,EAAA;AACjC,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;KACjC;AAEO,IAAA,MAAM,CAAC,YAAoB,EAAA;AACjC,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;KACjC;AAEO,IAAA,OAAO,CAAC,YAAoB,EAAA;QAClC,OAAO,CAAA,EAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAA;KAC3C;AAEO,IAAA,aAAa,CAAC,OAAmB,EAAA;AACvC,QAAA,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;KACjE;AAEO,IAAA,aAAa,CAAC,MAAc,EAAA;AAClC,QAAA,MAAM,gBAAgB,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;AAClC,QAAA,MAAM,UAAU,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,EAAE,gBAAgB,GAAG,CAAC,CAAC,CAAA;AAEpE,QAAA,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,gBAAgB,GAAG,CAAC,CAAC,CAAC,CAAA;KACxD;AAED;;AAEG;AACI,IAAA,MAAM,iBAAiB,CAAC,EAAE,YAAY,EAAE,QAAQ,EAA4B,EAAA;QACjF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,KAAI;;;AAGrC,YAAA,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,OAAM,KAAK,KAAG;AAC1D,gBAAA,IAAI,KAAK,EAAE;oBACT,MAAM,CAAC,KAAK,CAAC,CAAA;oBACb,OAAM;AACP,iBAAA;AAED,gBAAA,IAAI,CAAC,oBAAoB,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAA;AACjD,gBAAA,IAAI,CAAC,kCAAkC,CAAC,YAAY,CAAC,CAAA;gBAErD,OAAO,CAAC,SAAS,CAAC,CAAA;AACpB,aAAC,CAAC,CAAA;AACJ,SAAC,CAAC,CAAA;KACH;AAED;;AAEG;AACK,IAAA,MAAM,oBAAoB,CAAC,YAAoB,EAAE,QAAkB,EAAA;AACzE,QAAA,MAAM,WAAW,GAAG,IAAI,eAAe,CAAC,YAAY,CAAC;AAClD,aAAA,iBAAiB,EAAE;aACnB,qBAAqB,CAAC,QAAQ,CAAC,CAAA;QAElC,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,CAAA;KACzG;AAED;;AAEG;IACK,MAAM,kCAAkC,CAAC,YAAoB,EAAA;AACnE,QAAA,MAAM,gBAAgB,GAAG,IAAI,eAAe,CAAC,YAAY,CAAC;AACvD,aAAA,mBAAmB,EAAE,CAAA;QAExB,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAC3B,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EACzB,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC,CACpD,CAAA;KACF;AAED;;;AAGG;AACH,IAAA,MAAM,eAAe,CAAC,EAAE,YAAY,EAA0B,EAAA;;;QAG5D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,KAAI;YACrC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,OAAO,KAAK,EAAE,IAAI,KAAI;AAClG,gBAAA,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE;;;AAGlB,oBAAA,MAAM,EAAE,CAAA;oBACR,OAAM;AACP,iBAAA;AAED,gBAAA,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,CAAA;gBAEhD,OAAO,CAAC,SAAS,CAAC,CAAA;AACpB,aAAC,CAAC,CAAA;AACJ,SAAC,CAAC,CAAA;KACH;AAED;;AAEG;AACH,IAAA,MAAM,kBAAkB,CAAC,EAAE,YAAY,EAA6B,EAAA;;AAClE,QAAA,CAAA,EAAA,GAAA,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,MAAE,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,MAAM,GAC/C,KAAK,CAAC,MAAK;;;AAGZ,SAAC,CACA,CAAA,OAAO,CAAC,MAAK;AACZ,YAAA,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;AAC/C,SAAC,CAAC,CAAA;KACL;AAED;;AAEG;AACH,IAAA,MAAM,iBAAiB,CAAC,EACtB,YAAY,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,GACvB,EAAA;QACzB,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;AACrD,QAAA,MAAM,OAAO,GAAG,IAAI,eAAe,CAAC,YAAY,CAAC;AAC9C,aAAA,4BAA4B,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;QAE1D,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAC3B,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EACzB,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAC3C,CAAA;KACF;AAsCD;;AAEG;IACI,MAAM,QAAQ,CAAC,IAAqB,EAAA;AACzC,QAAA,IAAI,IAAI,CAAC,iBAAiB,KAAK,IAAI,CAAC,sBAAsB,EAAE;AAC1D,YAAA,OAAO,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;AACnE,SAAA;KACF;IA0BD,MAAM,wBAAwB,CAAC,IAAqC,EAAA;QAClE,MAAM,OAAO,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC;AACnD,aAAA,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAExC,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAC3B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EAC9B,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAC3C,CAAA;KACF;AAED;;AAEG;AACH,IAAA,MAAM,SAAS,GAAA;AACb,QAAA,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;AACzB,QAAA,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;AAC1B,QAAA,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;KAC3B;AACF;;;;"}

package/dist/packages/extension-redis/src/Redis.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import RedisClient, { ClusterNode, ClusterOptions, RedisOptions } from 'ioredis';
 import Redlock from 'redlock';
 import { Extension, afterLoadDocumentPayload, afterStoreDocumentPayload, onDisconnectPayload, onStoreDocumentPayload, onAwarenessUpdatePayload, onChangePayload, Debugger, onConfigurePayload, beforeBroadcastStatelessPayload, Hocuspocus } from '@hocuspocus/server';
@@ -56,18 +57,22 @@ export declare class Redis implements Extension {
      */
     priority: number;
     configuration: Configuration;
+    redisTransactionOrigin: string;
     pub: RedisInstance;
     sub: RedisInstance;
     instance: Hocuspocus;
     redlock: Redlock;
     locks: Map<string, Redlock.Lock>;
     logger: Debugger;
+    messagePrefix: Buffer;
     constructor(configuration: Partial<Configuration>);
     onConfigure({ instance }: onConfigurePayload): Promise<void>;
     private getKey;
     private pubKey;
     private subKey;
     private lockKey;
+    private encodeMessage;
+    private decodeMessage;
     /**
      * Once a document is loaded, subscribe to the channel in Redis.
      */
@@ -94,7 +99,7 @@ export declare class Redis implements Extension {
      */
     onAwarenessUpdate({ documentName, awareness, added, updated, removed, }: onAwarenessUpdatePayload): Promise<number>;
     /**
-     * Handle incoming messages published on all subscribed document channels.
+     * Handle incoming messages published on subscribed document channels.
      * Note that this will also include messages from ourselves as it is not possible
      * in Redis to filter these.
     */

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

@@ -4,6 +4,9 @@ import { Event } from 'ws';
 import EventEmitter from './EventEmitter.js';
 import { HocuspocusProvider } from './HocuspocusProvider.js';
 import { WebSocketStatus, onAwarenessChangeParameters, onAwarenessUpdateParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatusParameters } from './types.js';
+export type HocusPocusWebSocket = WebSocket & {
+    identifier: string;
+};
 export type HocuspocusProviderWebsocketConfiguration = Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, 'url'>> & Partial<CompleteHocuspocusProviderWebsocketConfiguration>;
 export interface CompleteHocuspocusProviderWebsocketConfiguration {
     /**
@@ -79,10 +82,14 @@ export declare class HocuspocusProviderWebsocket extends EventEmitter {
     private messageQueue;
     configuration: CompleteHocuspocusProviderWebsocketConfiguration;
     subscribedToBroadcastChannel: boolean;
-    webSocket: WebSocket | null;
+    webSocket: HocusPocusWebSocket | null;
+    webSocketHandlers: {
+        [key: string]: any;
+    };
     shouldConnect: boolean;
     status: WebSocketStatus;
     lastMessageReceived: number;
+    identifier: number;
     mux: mutex.mutex;
     intervals: any;
     connectionAttempt: {
@@ -100,6 +107,8 @@ export declare class HocuspocusProviderWebsocket extends EventEmitter {
     boundConnect: () => Promise<unknown>;
     cancelWebsocketRetry?: () => void;
     connect(): Promise<unknown>;
+    attachWebSocketListeners(ws: HocusPocusWebSocket, reject: Function): void;
+    cleanupWebSocket(): void;
     createWebSocketConnection(): Promise<unknown>;
     onMessage(event: MessageEvent): void;
     resolveConnectionAttempt(): void;
@@ -107,7 +116,6 @@ export declare class HocuspocusProviderWebsocket extends EventEmitter {
     rejectConnectionAttempt(): void;
     closeTries: number;
     checkConnection(): void;
-    registerEventListeners(): void;
     get serverUrl(): string;
     get url(): string;
     disconnect(): void;

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

@@ -1,6 +1,7 @@
 import type { AbstractType, YArrayEvent } from 'yjs';
 import { HocuspocusProvider, HocuspocusProviderConfiguration } from './HocuspocusProvider.js';
 import { TiptapCollabProviderWebsocket } from './TiptapCollabProviderWebsocket.js';
+import type { THistoryVersion } from './types';
 export type TiptapCollabProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & (Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'websocketProvider'>> | Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'appId'>>);
 export interface AdditionalTiptapCollabProviderConfiguration {
     /**
@@ -9,19 +10,29 @@ export interface AdditionalTiptapCollabProviderConfiguration {
     appId?: string;
     websocketProvider?: TiptapCollabProviderWebsocket;
 }
-export type AuditHistoryVersion = {
-    name?: string;
-    version: number;
-    date: number;
-};
 export declare class TiptapCollabProvider extends HocuspocusProvider {
     tiptapCollabConfigurationPrefix: string;
     constructor(configuration: TiptapCollabProviderConfiguration);
+    /**
+     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
+     */
     createVersion(name?: string): void;
+    /**
+     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
+     */
     revertToVersion(targetVersion: number): void;
-    getVersions(): AuditHistoryVersion[];
-    watchVersions(callback: Parameters<AbstractType<YArrayEvent<AuditHistoryVersion>>['observe']>[0]): void;
-    unwatchVersions(callback: Parameters<AbstractType<YArrayEvent<AuditHistoryVersion>>['unobserve']>[0]): void;
+    /**
+     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
+     *
+     * The server will reply with a stateless message (THistoryVersionPreviewEvent)
+     */
+    previewVersion(targetVersion: number): void;
+    /**
+     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
+     */
+    getVersions(): THistoryVersion[];
+    watchVersions(callback: Parameters<AbstractType<YArrayEvent<THistoryVersion>>['observe']>[0]): void;
+    unwatchVersions(callback: Parameters<AbstractType<YArrayEvent<THistoryVersion>>['unobserve']>[0]): void;
     isAutoVersioning(): boolean;
     enableAutoVersioning(): 1;
     disableAutoVersioning(): 0;

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

@@ -84,3 +84,48 @@ export type StatesArray = {
     clientId: number;
     [key: string | number]: any;
 }[];
+export type THistoryVersion = {
+    name?: string;
+    version: number;
+    date: number;
+};
+export type THistoryConfiguration = {
+    autoVersioning: boolean;
+    currentVersion: number;
+    stateCaptured: number;
+};
+export type THistoryAction = THistoryDocumentRevertAction | THistoryVersionCreateAction | THistoryVersionPreviewAction;
+export type THistoryDocumentRevertAction = {
+    action: 'document.revert';
+    /**
+     * if changes havent been persisted to a version yet, we'll create one with the specified name,
+     * expect when `false` is passed.
+     */
+    currentVersionName?: string | false;
+    /**
+     * Name of the version that is created after the revert. Pass `false` to avoid generating a new version.
+     */
+    newVersionName?: string | false;
+};
+export type THistoryVersionCreateAction = {
+    action: 'version.create';
+    name?: string;
+};
+export type THistoryVersionPreviewAction = {
+    action: 'version.preview';
+    version: number;
+};
+export type THistoryEvent = THistoryVersionPreviewEvent | THistoryVersionCreatedEvent | THistoryDocumentRevertedEvent;
+export type THistoryVersionCreatedEvent = {
+    event: 'version.created';
+    version: number;
+};
+export type THistoryVersionPreviewEvent = {
+    event: 'version.preview';
+    version: number;
+    ydoc: string;
+};
+export type THistoryDocumentRevertedEvent = {
+    event: 'document.reverted';
+    version: number;
+};

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

@@ -1,5 +1,4 @@
 /// <reference types="node" />
-/// <reference types="node" />
 import { IncomingMessage } from 'http';
 import WebSocket, { AddressInfo } from 'ws';
 import { Server as HocuspocusServer } from './Server';
@@ -29,6 +28,7 @@ export declare class Hocuspocus {
     documents: Map<string, Document>;
     server?: HocuspocusServer;
     debugger: Debugger;
+    debounce: (id: string, func: Function, debounce: number, maxDebounce: number) => void;
     constructor(configuration?: Partial<Configuration>);
     /**
      * Configure the server
@@ -78,14 +78,6 @@ export declare class Hocuspocus {
      * the update is incoming from the provider, but can be anything if the updates is originated from an extension.
      */
     private handleDocumentUpdate;
-    timers: Map<string, {
-        timeout: NodeJS.Timeout;
-        start: number;
-    }>;
-    /**
-     * debounce the given function, using the given identifier
-     */
-    debounce(id: string, func: Function, immediately?: boolean): void;
     /**
      * Create a new document by the given request
      */

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

@@ -5,7 +5,8 @@ import { IncomingMessage } from './IncomingMessage.js';
 export declare class MessageReceiver {
     message: IncomingMessage;
     logger: Debugger;
-    constructor(message: IncomingMessage, logger: Debugger);
+    defaultTransactionOrigin?: string;
+    constructor(message: IncomingMessage, logger: Debugger, defaultTransactionOrigin?: string);
     apply(document: Document, connection?: Connection, reply?: (message: Uint8Array) => void): void;
     readSyncMessage(message: IncomingMessage, document: Document, connection?: Connection, reply?: (message: Uint8Array) => void, requestFirstSync?: boolean): 0 | 2 | 1;
     applyQueryAwarenessMessage(document: Document, reply?: (message: Uint8Array) => void): void;

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

@@ -6,3 +6,4 @@ export * from './IncomingMessage.js';
 export * from './MessageReceiver.js';
 export * from './OutgoingMessage.js';
 export * from './types.js';
+export * from './util/debounce.js';

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

@@ -39,7 +39,7 @@ export interface Extension {
     connected?(data: connectedPayload): Promise<any>;
     onAuthenticate?(data: onAuthenticatePayload): Promise<any>;
     onLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
-    afterLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
+    afterLoadDocument?(data: afterLoadDocumentPayload): Promise<any>;
     beforeHandleMessage?(data: beforeHandleMessagePayload): Promise<any>;
     beforeBroadcastStateless?(data: beforeBroadcastStatelessPayload): Promise<any>;
     onStateless?(payload: onStatelessPayload): Promise<any>;
@@ -49,7 +49,7 @@ export interface Extension {
     onAwarenessUpdate?(data: onAwarenessUpdatePayload): Promise<any>;
     onRequest?(data: onRequestPayload): Promise<any>;
     onDisconnect?(data: onDisconnectPayload): Promise<any>;
-    afterUnloadDocument?(data: onLoadDocumentPayload): Promise<any>;
+    afterUnloadDocument?(data: afterUnloadDocumentPayload): Promise<any>;
     onDestroy?(data: onDestroyPayload): Promise<any>;
 }
 export type HookName = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 'onLoadDocument' | 'afterLoadDocument' | 'beforeHandleMessage' | 'beforeBroadcastStateless' | 'onStateless' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'afterUnloadDocument' | 'onDestroy';
@@ -61,7 +61,7 @@ export type HookPayloadByName = {
     connected: connectedPayload;
     onAuthenticate: onAuthenticatePayload;
     onLoadDocument: onLoadDocumentPayload;
-    afterLoadDocument: onLoadDocumentPayload;
+    afterLoadDocument: afterLoadDocumentPayload;
     beforeHandleMessage: beforeHandleMessagePayload;
     beforeBroadcastStateless: beforeBroadcastStatelessPayload;
     onStateless: onStatelessPayload;
@@ -123,15 +123,6 @@ export interface Configuration extends Extension {
         gc: boolean;
         gcFilter: () => boolean;
     };
-    /**
-     * Function which returns the (customized) document name based on the request
-     */
-    getDocumentName?(data: getDocumentNamePayload): string | Promise<string>;
-}
-export interface getDocumentNamePayload {
-    documentName: string;
-    request: IncomingMessage;
-    requestParameters: URLSearchParams;
 }
 export interface onStatelessPayload {
     connection: Connection;
@@ -149,6 +140,7 @@ export interface onAuthenticatePayload {
     connection: ConnectionConfiguration;
 }
 export interface onConnectPayload {
+    context: any;
     documentName: string;
     instance: Hocuspocus;
     request: IncomingMessage;

package/dist/packages/server/src/util/debounce.d.ts

@@ -0,0 +1 @@
+export declare const useDebounce: () => (id: string, func: Function, debounce: number, maxDebounce: number) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/extension-redis",
-  "version": "2.5.0-rc.0",
+  "version": "2.6.0",
   "description": "Scale Hocuspocus horizontally with Redis",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -33,7 +33,7 @@
     "@types/redlock": "^4.0.3"
   },
   "dependencies": {
-    "@hocuspocus/server": "^2.5.0-rc.0",
+    "@hocuspocus/server": "^2.6.0",
     "ioredis": "^4.28.2",
     "kleur": "^4.1.4",
     "lodash.debounce": "^4.0.8",

package/src/Redis.ts

@@ -84,6 +84,8 @@ export class Redis implements Extension {
     disconnectDelay: 1000,
   }
 
+  redisTransactionOrigin = '__hocuspocus__redis__origin__'
+
   pub: RedisInstance
 
   sub: RedisInstance
@@ -96,6 +98,8 @@ export class Redis implements Extension {
 
   logger: Debugger
 
+  messagePrefix: Buffer
+
   public constructor(configuration: Partial<Configuration>) {
     this.configuration = {
       ...this.configuration,
@@ -128,9 +132,12 @@ export class Redis implements Extension {
       this.pub = new RedisClient(port, host, options)
       this.sub = new RedisClient(port, host, options)
     }
-    this.sub.on('pmessageBuffer', this.handleIncomingMessage)
+    this.sub.on('messageBuffer', this.handleIncomingMessage)
 
     this.redlock = new Redlock([this.pub])
+
+    const identifierBuffer = Buffer.from(this.configuration.identifier, 'utf-8')
+    this.messagePrefix = Buffer.concat([Buffer.from([identifierBuffer.length]), identifierBuffer])
   }
 
   async onConfigure({ instance }: onConfigurePayload) {
@@ -143,17 +150,28 @@ export class Redis implements Extension {
   }
 
   private pubKey(documentName: string) {
-    return `${this.getKey(documentName)}:${this.configuration.identifier.replace(/:/g, '')}`
+    return this.getKey(documentName)
   }
 
   private subKey(documentName: string) {
-    return `${this.getKey(documentName)}:*`
+    return this.getKey(documentName)
   }
 
   private lockKey(documentName: string) {
     return `${this.getKey(documentName)}:lock`
   }
 
+  private encodeMessage(message: Uint8Array) {
+    return Buffer.concat([this.messagePrefix, Buffer.from(message)])
+  }
+
+  private decodeMessage(buffer: Buffer) {
+    const identifierLength = buffer[0]
+    const identifier = buffer.toString('utf-8', 1, identifierLength + 1)
+
+    return [identifier, buffer.slice(identifierLength + 1)]
+  }
+
   /**
    * Once a document is loaded, subscribe to the channel in Redis.
    */
@@ -161,7 +179,7 @@ export class Redis implements Extension {
     return new Promise((resolve, reject) => {
       // On document creation the node will connect to pub and sub channels
       // for the document.
-      this.sub.psubscribe(this.subKey(documentName), async error => {
+      this.sub.subscribe(this.subKey(documentName), async error => {
         if (error) {
           reject(error)
           return
@@ -183,7 +201,7 @@ export class Redis implements Extension {
       .createSyncMessage()
       .writeFirstSyncStepFor(document)
 
-    return this.pub.publishBuffer(this.pubKey(documentName), Buffer.from(syncMessage.toUint8Array()))
+    return this.pub.publishBuffer(this.pubKey(documentName), this.encodeMessage(syncMessage.toUint8Array()))
   }
 
   /**
@@ -195,7 +213,7 @@ export class Redis implements Extension {
 
     return this.pub.publishBuffer(
       this.pubKey(documentName),
-      Buffer.from(awarenessMessage.toUint8Array()),
+      this.encodeMessage(awarenessMessage.toUint8Array()),
     )
   }
 
@@ -248,40 +266,42 @@ export class Redis implements Extension {
 
     return this.pub.publishBuffer(
       this.pubKey(documentName),
-      Buffer.from(message.toUint8Array()),
+      this.encodeMessage(message.toUint8Array()),
     )
   }
 
   /**
-   * Handle incoming messages published on all subscribed document channels.
+   * Handle incoming messages published on subscribed document channels.
    * Note that this will also include messages from ourselves as it is not possible
    * in Redis to filter these.
   */
-  private handleIncomingMessage = async (channel: Buffer, pattern: Buffer, data: Buffer) => {
-    const message = new IncomingMessage(data)
-    // we don't need the documentName from the message, we are just taking it from the redis channelName.
-    // we have to immediately write it back to the encoder though, to make sure the structure of the message is correct
-    message.writeVarString(message.readVarString())
-
-    const channelName = pattern.toString()
-    const [_, documentName, identifier] = channelName.split(':')
-    const document = this.instance.documents.get(documentName)
+  private handleIncomingMessage = async (channel: Buffer, data: Buffer) => {
+    const [identifier, messageBuffer] = this.decodeMessage(data)
 
     if (identifier === this.configuration.identifier) {
       return
     }
 
+    const message = new IncomingMessage(messageBuffer)
+    const documentName = message.readVarString()
+    message.writeVarString(documentName)
+
+    const document = this.instance.documents.get(documentName)
+
     if (!document) {
+      // What does this mean? Why are we subscribed to this document?
+      this.logger.log(`Received message for unknown document ${documentName}`)
       return
     }
 
     new MessageReceiver(
       message,
       this.logger,
+      this.redisTransactionOrigin,
     ).apply(document, undefined, reply => {
       return this.pub.publishBuffer(
         this.pubKey(document.name),
-        Buffer.from(reply),
+        this.encodeMessage(reply),
       )
     })
   }
@@ -290,7 +310,9 @@ export class Redis implements Extension {
    * if the ydoc changed, we'll need to inform other Hocuspocus servers about it.
    */
   public async onChange(data: onChangePayload): Promise<any> {
-    return this.publishFirstSyncStep(data.documentName, data.document)
+    if (data.transactionOrigin !== this.redisTransactionOrigin) {
+      return this.publishFirstSyncStep(data.documentName, data.document)
+    }
   }
 
   /**
@@ -307,7 +329,7 @@ export class Redis implements Extension {
       }
 
       // Time to end the subscription on the document channel.
-      this.sub.punsubscribe(this.subKey(documentName), (error: any) => {
+      this.sub.unsubscribe(this.subKey(documentName), (error: any) => {
         if (error) {
           console.error(error)
         }
@@ -323,7 +345,7 @@ export class Redis implements Extension {
 
     return this.pub.publishBuffer(
       this.pubKey(data.documentName),
-      Buffer.from(message.toUint8Array()),
+      this.encodeMessage(message.toUint8Array()),
     )
   }
 

package/dist/tests/extension-redis/closeConnections.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/extension-redis/getConnectionCount.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/extension-redis/getDocumentsCount.d.ts

@@ -1 +0,0 @@
-export {};