@hocuspocus/extension-redis 2.0.6 → 2.1.0-alpha.0

package/dist/hocuspocus-redis.cjs

@@ -3,16 +3,12 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var RedisClient = require('ioredis');
-var Redlock = require('redlock');
 var uuid = require('uuid');
 var server = require('@hocuspocus/server');
-var kleur = require('kleur');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
 var RedisClient__default = /*#__PURE__*/_interopDefaultLegacy(RedisClient);
-var Redlock__default = /*#__PURE__*/_interopDefaultLegacy(Redlock);
-var kleur__default = /*#__PURE__*/_interopDefaultLegacy(kleur);
 
 class Redis {
     constructor(configuration) {
@@ -27,10 +23,8 @@ class Redis {
             host: '127.0.0.1',
             prefix: 'hocuspocus',
             identifier: `host-${uuid.v4()}`,
-            lockTimeout: 1000,
             disconnectDelay: 1000,
         };
-        this.locks = new Map();
         /**
          * Handle incoming messages published on all subscribed document channels.
          * Note that this will also include messages from ourselves as it is not possible
@@ -51,7 +45,7 @@ class Redis {
                 return;
             }
             new server.MessageReceiver(message, this.logger).apply(document, undefined, reply => {
-                return this.pub.publishBuffer(this.pubKey(document.name), Buffer.from(reply));
+                return this.pub.publish(this.pubKey(document.name), Buffer.from(reply));
             });
         };
         /**
@@ -79,8 +73,6 @@ class Redis {
             ...this.configuration,
             ...configuration,
         };
-        // We’ll replace that in the onConfigure hook with the global instance.
-        this.logger = new server.Debugger();
         // Create Redis instance
         const { port, host, options, nodes, redis, createClient, } = this.configuration;
         if (typeof createClient === 'function') {
@@ -100,19 +92,13 @@ class Redis {
             this.sub = new RedisClient__default["default"](port, host, options);
         }
         this.sub.on('pmessageBuffer', this.handleIncomingMessage);
-        this.redlock = new Redlock__default["default"]([this.pub]);
+        // We’ll replace that in the onConfigure hook with the global instance.
+        this.logger = new server.Debugger();
     }
     async onConfigure({ instance }) {
         this.logger = instance.debugger;
         this.instance = instance;
     }
-    async onListen({ configuration }) {
-        if (configuration.quiet) {
-            return;
-        }
-        console.warn(`  ${kleur__default["default"].yellow('[BREAKING CHANGE] Wait, the Redis extension got an overhaul. The new Redis extension doesn’t persist data, it only syncs data between instances. Use @hocuspocus/extension-database to store your documents. It works well with the Redis extension.')}`);
-        console.log();
-    }
     getKey(documentName) {
         return `${this.configuration.prefix}:${documentName}`;
     }
@@ -122,9 +108,6 @@ class Redis {
     subKey(documentName) {
         return `${this.getKey(documentName)}:*`;
     }
-    lockKey(documentName) {
-        return `${this.getKey(documentName)}:lock`;
-    }
     /**
      * Once a document is laoded, subscribe to the channel in Redis.
      */
@@ -150,7 +133,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.publish(this.pubKey(documentName), Buffer.from(syncMessage.toUint8Array()));
     }
     /**
      * Let’s ask Redis who is connected already.
@@ -158,39 +141,7 @@ class Redis {
     async requestAwarenessFromOtherInstances(documentName) {
         const awarenessMessage = new server.OutgoingMessage(documentName)
             .writeQueryAwareness();
-        return this.pub.publishBuffer(this.pubKey(documentName), Buffer.from(awarenessMessage.toUint8Array()));
-    }
-    /**
-     * Before the document is stored, make sure to set a lock in Redis.
-     * That’s meant to avoid conflicts with other instances trying to store the document.
-     */
-    async onStoreDocument({ documentName }) {
-        // Attempt to acquire a lock and read lastReceivedTimestamp from Redis,
-        // to avoid conflict with other instances storing the same document.
-        return new Promise((resolve, reject) => {
-            this.redlock.lock(this.lockKey(documentName), this.configuration.lockTimeout, async (error, lock) => {
-                if (error || !lock) {
-                    // Expected behavior: Could not acquire lock, another instance locked it already.
-                    // No further `onStoreDocument` hooks will be executed.
-                    reject();
-                    return;
-                }
-                this.locks.set(this.lockKey(documentName), lock);
-                resolve(undefined);
-            });
-        });
-    }
-    /**
-     * Release the Redis lock, so other instances can store documents.
-     */
-    async afterStoreDocument({ documentName }) {
-        var _a;
-        (_a = this.locks.get(this.lockKey(documentName))) === null || _a === void 0 ? void 0 : _a.unlock().catch(() => {
-            // Not able to unlock Redis. The lock will expire after ${lockTimeout} ms.
-            // console.error(`Not able to unlock Redis. The lock will expire after ${this.configuration.lockTimeout}ms.`)
-        }).finally(() => {
-            this.locks.delete(this.lockKey(documentName));
-        });
+        return this.pub.publish(this.pubKey(documentName), Buffer.from(awarenessMessage.toUint8Array()));
     }
     /**
      * Handle awareness update messages received directly by this Hocuspocus instance.
@@ -199,7 +150,7 @@ 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.publish(this.pubKey(documentName), Buffer.from(message.toUint8Array()));
     }
     /**
      * if the ydoc changed, we'll need to inform other Hocuspocus servers about it.
@@ -210,13 +161,7 @@ class Redis {
     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()));
-    }
-    /**
-     * Kill the Redlock connection immediately.
-     */
-    async onDestroy() {
-        this.redlock.quit();
+        return this.pub.publish(this.pubKey(data.documentName), Buffer.from(message.toUint8Array()));
     }
 }
 

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  onListenPayload,\n  beforeBroadcastStatelessPayload, Hocuspocus,\n} from '@hocuspocus/server'\nimport kleur from 'kleur'\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  async onListen({ configuration }: onListenPayload) {\n    if (configuration.quiet) {\n      return\n    }\n\n    console.warn(`  ${kleur.yellow('[BREAKING CHANGE] Wait, the Redis extension got an overhaul. The new Redis extension doesn’t persist data, it only syncs data between instances. Use @hocuspocus/extension-database to store your documents. It works well with the Redis extension.')}`)\n    console.log()\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 laoded, 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    this.redlock.quit()\n  }\n}\n"],"names":["uuid","IncomingMessage","MessageReceiver","Debugger","RedisClient","Redlock","kleur","OutgoingMessage"],"mappings":";;;;;;;;;;;;;;;;MAuEa,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;AAyKvC;;;;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;QAnOC,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;AAED,IAAA,MAAM,QAAQ,CAAC,EAAE,aAAa,EAAmB,EAAA;QAC/C,IAAI,aAAa,CAAC,KAAK,EAAE;YACvB,OAAM;AACP,SAAA;AAED,QAAA,OAAO,CAAC,IAAI,CAAC,CAAA,EAAA,EAAKC,yBAAK,CAAC,MAAM,CAAC,sPAAsP,CAAC,CAAE,CAAA,CAAC,CAAA;QACzR,OAAO,CAAC,GAAG,EAAE,CAAA;KACd;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,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;KACpB;AACF;;;;"}
+{"version":3,"file":"hocuspocus-redis.cjs","sources":["../src/Redis.ts"],"sourcesContent":["import RedisClient, {\n  ClusterNode, ClusterOptions, RedisOptions, Cluster as RedisClusterClient,\n} from 'ioredis'\nimport { v4 as uuid } from 'uuid'\nimport {\n  IncomingMessage,\n  OutgoingMessage,\n  Document,\n  Extension,\n  afterLoadDocumentPayload,\n  onDisconnectPayload,\n  onAwarenessUpdatePayload,\n  onChangePayload,\n  MessageReceiver,\n  Debugger,\n  onConfigurePayload,\n  beforeBroadcastStatelessPayload, Hocuspocus,\n} from '@hocuspocus/server'\n\nexport type RedisInstance = RedisClient | RedisClusterClient\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   * 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    disconnectDelay: 1000,\n  }\n\n  pub: RedisInstance\n\n  sub: RedisInstance\n\n  instance!: Hocuspocus\n\n  logger: Debugger\n\n  public constructor(configuration: Partial<Configuration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\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 as RedisOptions)\n      this.sub = new RedisClient(port, host, options as RedisOptions)\n    }\n    this.sub.on('pmessageBuffer', this.handleIncomingMessage)\n\n    // We’ll replace that in the onConfigure hook with the global instance.\n    this.logger = new Debugger()\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  /**\n   * Once a document is laoded, 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.publish(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.publish(\n      this.pubKey(documentName),\n      Buffer.from(awarenessMessage.toUint8Array()),\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.publish(\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.publish(\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.publish(\n      this.pubKey(data.documentName),\n      Buffer.from(message.toUint8Array()),\n    )\n  }\n\n}\n"],"names":["uuid","IncomingMessage","MessageReceiver","RedisClient","Debugger","OutgoingMessage"],"mappings":";;;;;;;;;;;;MAgEa,KAAK,CAAA;AAwBhB,IAAA,WAAA,CAAmB,aAAqC,EAAA;AAvBxD;;;;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,eAAe,EAAE,IAAI;SACtB,CAAA;AA2HD;;;;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,OAAO,CACrB,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;QA/KC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SACjB,CAAA;;AAGD,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,OAAuB,CAAC,CAAA;AAC/D,YAAA,IAAI,CAAC,GAAG,GAAG,IAAIA,+BAAW,CAAC,IAAI,EAAE,IAAI,EAAE,OAAuB,CAAC,CAAA;AAChE,SAAA;QACD,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,gBAAgB,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAA;;AAGzD,QAAA,IAAI,CAAC,MAAM,GAAG,IAAIC,eAAQ,EAAE,CAAA;KAC7B;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;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,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,CAAA;KAC5F;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,OAAO,CACrB,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EACzB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC,CAC7C,CAAA;KACF;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,OAAO,CACrB,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,OAAO,CACrB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EAC9B,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CACpC,CAAA;KACF;AAEF;;;;"}

package/dist/hocuspocus-redis.esm.js

@@ -1,8 +1,6 @@
 import RedisClient from 'ioredis';
-import Redlock from 'redlock';
 import { v4 } from 'uuid';
 import { IncomingMessage, MessageReceiver, Debugger, OutgoingMessage } from '@hocuspocus/server';
-import kleur from 'kleur';
 
 class Redis {
     constructor(configuration) {
@@ -17,10 +15,8 @@ class Redis {
             host: '127.0.0.1',
             prefix: 'hocuspocus',
             identifier: `host-${v4()}`,
-            lockTimeout: 1000,
             disconnectDelay: 1000,
         };
-        this.locks = new Map();
         /**
          * Handle incoming messages published on all subscribed document channels.
          * Note that this will also include messages from ourselves as it is not possible
@@ -41,7 +37,7 @@ class Redis {
                 return;
             }
             new MessageReceiver(message, this.logger).apply(document, undefined, reply => {
-                return this.pub.publishBuffer(this.pubKey(document.name), Buffer.from(reply));
+                return this.pub.publish(this.pubKey(document.name), Buffer.from(reply));
             });
         };
         /**
@@ -69,8 +65,6 @@ class Redis {
             ...this.configuration,
             ...configuration,
         };
-        // We’ll replace that in the onConfigure hook with the global instance.
-        this.logger = new Debugger();
         // Create Redis instance
         const { port, host, options, nodes, redis, createClient, } = this.configuration;
         if (typeof createClient === 'function') {
@@ -90,19 +84,13 @@ class Redis {
             this.sub = new RedisClient(port, host, options);
         }
         this.sub.on('pmessageBuffer', this.handleIncomingMessage);
-        this.redlock = new Redlock([this.pub]);
+        // We’ll replace that in the onConfigure hook with the global instance.
+        this.logger = new Debugger();
     }
     async onConfigure({ instance }) {
         this.logger = instance.debugger;
         this.instance = instance;
     }
-    async onListen({ configuration }) {
-        if (configuration.quiet) {
-            return;
-        }
-        console.warn(`  ${kleur.yellow('[BREAKING CHANGE] Wait, the Redis extension got an overhaul. The new Redis extension doesn’t persist data, it only syncs data between instances. Use @hocuspocus/extension-database to store your documents. It works well with the Redis extension.')}`);
-        console.log();
-    }
     getKey(documentName) {
         return `${this.configuration.prefix}:${documentName}`;
     }
@@ -112,9 +100,6 @@ class Redis {
     subKey(documentName) {
         return `${this.getKey(documentName)}:*`;
     }
-    lockKey(documentName) {
-        return `${this.getKey(documentName)}:lock`;
-    }
     /**
      * Once a document is laoded, subscribe to the channel in Redis.
      */
@@ -140,7 +125,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.publish(this.pubKey(documentName), Buffer.from(syncMessage.toUint8Array()));
     }
     /**
      * Let’s ask Redis who is connected already.
@@ -148,39 +133,7 @@ class Redis {
     async requestAwarenessFromOtherInstances(documentName) {
         const awarenessMessage = new OutgoingMessage(documentName)
             .writeQueryAwareness();
-        return this.pub.publishBuffer(this.pubKey(documentName), Buffer.from(awarenessMessage.toUint8Array()));
-    }
-    /**
-     * Before the document is stored, make sure to set a lock in Redis.
-     * That’s meant to avoid conflicts with other instances trying to store the document.
-     */
-    async onStoreDocument({ documentName }) {
-        // Attempt to acquire a lock and read lastReceivedTimestamp from Redis,
-        // to avoid conflict with other instances storing the same document.
-        return new Promise((resolve, reject) => {
-            this.redlock.lock(this.lockKey(documentName), this.configuration.lockTimeout, async (error, lock) => {
-                if (error || !lock) {
-                    // Expected behavior: Could not acquire lock, another instance locked it already.
-                    // No further `onStoreDocument` hooks will be executed.
-                    reject();
-                    return;
-                }
-                this.locks.set(this.lockKey(documentName), lock);
-                resolve(undefined);
-            });
-        });
-    }
-    /**
-     * Release the Redis lock, so other instances can store documents.
-     */
-    async afterStoreDocument({ documentName }) {
-        var _a;
-        (_a = this.locks.get(this.lockKey(documentName))) === null || _a === void 0 ? void 0 : _a.unlock().catch(() => {
-            // Not able to unlock Redis. The lock will expire after ${lockTimeout} ms.
-            // console.error(`Not able to unlock Redis. The lock will expire after ${this.configuration.lockTimeout}ms.`)
-        }).finally(() => {
-            this.locks.delete(this.lockKey(documentName));
-        });
+        return this.pub.publish(this.pubKey(documentName), Buffer.from(awarenessMessage.toUint8Array()));
     }
     /**
      * Handle awareness update messages received directly by this Hocuspocus instance.
@@ -189,7 +142,7 @@ 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.publish(this.pubKey(documentName), Buffer.from(message.toUint8Array()));
     }
     /**
      * if the ydoc changed, we'll need to inform other Hocuspocus servers about it.
@@ -200,13 +153,7 @@ class Redis {
     async beforeBroadcastStateless(data) {
         const message = new OutgoingMessage(data.documentName)
             .writeBroadcastStateless(data.payload);
-        return this.pub.publishBuffer(this.pubKey(data.documentName), Buffer.from(message.toUint8Array()));
-    }
-    /**
-     * Kill the Redlock connection immediately.
-     */
-    async onDestroy() {
-        this.redlock.quit();
+        return this.pub.publish(this.pubKey(data.documentName), Buffer.from(message.toUint8Array()));
     }
 }
 

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  onListenPayload,\n  beforeBroadcastStatelessPayload, Hocuspocus,\n} from '@hocuspocus/server'\nimport kleur from 'kleur'\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  async onListen({ configuration }: onListenPayload) {\n    if (configuration.quiet) {\n      return\n    }\n\n    console.warn(`  ${kleur.yellow('[BREAKING CHANGE] Wait, the Redis extension got an overhaul. The new Redis extension doesn’t persist data, it only syncs data between instances. Use @hocuspocus/extension-database to store your documents. It works well with the Redis extension.')}`)\n    console.log()\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 laoded, 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    this.redlock.quit()\n  }\n}\n"],"names":["uuid"],"mappings":";;;;;;MAuEa,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;AAyKvC;;;;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;QAnOC,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;AAED,IAAA,MAAM,QAAQ,CAAC,EAAE,aAAa,EAAmB,EAAA;QAC/C,IAAI,aAAa,CAAC,KAAK,EAAE;YACvB,OAAM;AACP,SAAA;AAED,QAAA,OAAO,CAAC,IAAI,CAAC,CAAA,EAAA,EAAK,KAAK,CAAC,MAAM,CAAC,sPAAsP,CAAC,CAAE,CAAA,CAAC,CAAA;QACzR,OAAO,CAAC,GAAG,EAAE,CAAA;KACd;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,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;KACpB;AACF;;;;"}
+{"version":3,"file":"hocuspocus-redis.esm.js","sources":["../src/Redis.ts"],"sourcesContent":["import RedisClient, {\n  ClusterNode, ClusterOptions, RedisOptions, Cluster as RedisClusterClient,\n} from 'ioredis'\nimport { v4 as uuid } from 'uuid'\nimport {\n  IncomingMessage,\n  OutgoingMessage,\n  Document,\n  Extension,\n  afterLoadDocumentPayload,\n  onDisconnectPayload,\n  onAwarenessUpdatePayload,\n  onChangePayload,\n  MessageReceiver,\n  Debugger,\n  onConfigurePayload,\n  beforeBroadcastStatelessPayload, Hocuspocus,\n} from '@hocuspocus/server'\n\nexport type RedisInstance = RedisClient | RedisClusterClient\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   * 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    disconnectDelay: 1000,\n  }\n\n  pub: RedisInstance\n\n  sub: RedisInstance\n\n  instance!: Hocuspocus\n\n  logger: Debugger\n\n  public constructor(configuration: Partial<Configuration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\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 as RedisOptions)\n      this.sub = new RedisClient(port, host, options as RedisOptions)\n    }\n    this.sub.on('pmessageBuffer', this.handleIncomingMessage)\n\n    // We’ll replace that in the onConfigure hook with the global instance.\n    this.logger = new Debugger()\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  /**\n   * Once a document is laoded, 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.publish(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.publish(\n      this.pubKey(documentName),\n      Buffer.from(awarenessMessage.toUint8Array()),\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.publish(\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.publish(\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.publish(\n      this.pubKey(data.documentName),\n      Buffer.from(message.toUint8Array()),\n    )\n  }\n\n}\n"],"names":["uuid"],"mappings":";;;;MAgEa,KAAK,CAAA;AAwBhB,IAAA,WAAA,CAAmB,aAAqC,EAAA;AAvBxD;;;;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,eAAe,EAAE,IAAI;SACtB,CAAA;AA2HD;;;;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,OAAO,CACrB,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;QA/KC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SACjB,CAAA;;AAGD,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,OAAuB,CAAC,CAAA;AAC/D,YAAA,IAAI,CAAC,GAAG,GAAG,IAAI,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,OAAuB,CAAC,CAAA;AAChE,SAAA;QACD,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,gBAAgB,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAA;;AAGzD,QAAA,IAAI,CAAC,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAA;KAC7B;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;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,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,CAAA;KAC5F;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,OAAO,CACrB,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EACzB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC,CAC7C,CAAA;KACF;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,OAAO,CACrB,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,OAAO,CACrB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EAC9B,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CACpC,CAAA;KACF;AAEF;;;;"}

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

@@ -1,7 +1,6 @@
-import RedisClient, { ClusterNode, ClusterOptions, RedisOptions } from 'ioredis';
-import Redlock from 'redlock';
-import { Extension, afterLoadDocumentPayload, afterStoreDocumentPayload, onDisconnectPayload, onStoreDocumentPayload, onAwarenessUpdatePayload, onChangePayload, Debugger, onConfigurePayload, onListenPayload, beforeBroadcastStatelessPayload, Hocuspocus } from '@hocuspocus/server';
-export type RedisInstance = RedisClient.Cluster | RedisClient.Redis;
+import RedisClient, { ClusterNode, ClusterOptions, RedisOptions, Cluster as RedisClusterClient } from 'ioredis';
+import { Extension, afterLoadDocumentPayload, onDisconnectPayload, onAwarenessUpdatePayload, onChangePayload, Debugger, onConfigurePayload, beforeBroadcastStatelessPayload, Hocuspocus } from '@hocuspocus/server';
+export type RedisInstance = RedisClient | RedisClusterClient;
 export interface Configuration {
     /**
      * Redis port
@@ -38,10 +37,6 @@ export interface Configuration {
      * Namespace for Redis keys, if none is provided 'hocuspocus' is used
      */
     prefix: string;
-    /**
-     * The maximum time for the Redis lock in ms (in case it can’t be released).
-     */
-    lockTimeout: number;
     /**
      * A delay before onDisconnect is executed. This allows last minute updates'
      * sync messages to be received by the subscription before it's closed.
@@ -59,16 +54,12 @@ export declare class Redis implements Extension {
     pub: RedisInstance;
     sub: RedisInstance;
     instance: Hocuspocus;
-    redlock: Redlock;
-    locks: Map<string, Redlock.Lock>;
     logger: Debugger;
     constructor(configuration: Partial<Configuration>);
     onConfigure({ instance }: onConfigurePayload): Promise<void>;
-    onListen({ configuration }: onListenPayload): Promise<void>;
     private getKey;
     private pubKey;
     private subKey;
-    private lockKey;
     /**
      * Once a document is laoded, subscribe to the channel in Redis.
      */
@@ -81,15 +72,6 @@ export declare class Redis implements Extension {
      * Let’s ask Redis who is connected already.
      */
     private requestAwarenessFromOtherInstances;
-    /**
-     * Before the document is stored, make sure to set a lock in Redis.
-     * That’s meant to avoid conflicts with other instances trying to store the document.
-     */
-    onStoreDocument({ documentName }: onStoreDocumentPayload): Promise<unknown>;
-    /**
-     * Release the Redis lock, so other instances can store documents.
-     */
-    afterStoreDocument({ documentName }: afterStoreDocumentPayload): Promise<void>;
     /**
      * Handle awareness update messages received directly by this Hocuspocus instance.
      */
@@ -110,8 +92,4 @@ export declare class Redis implements Extension {
      */
     onDisconnect: ({ documentName }: onDisconnectPayload) => Promise<void>;
     beforeBroadcastStateless(data: beforeBroadcastStatelessPayload): Promise<number>;
-    /**
-     * Kill the Redlock connection immediately.
-     */
-    onDestroy(): Promise<void>;
 }

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

@@ -7,6 +7,6 @@ export declare class MessageReceiver {
     logger: Debugger;
     constructor(message: IncomingMessage, logger: Debugger);
     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;
+    readSyncMessage(message: IncomingMessage, document: Document, connection?: Connection, reply?: (message: Uint8Array) => void, requestFirstSync?: boolean): 0 | 1 | 2;
     applyQueryAwarenessMessage(document: Document, reply?: (message: Uint8Array) => void): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/extension-redis",
-  "version": "2.0.6",
+  "version": "2.1.0-alpha.0",
   "description": "Scale Hocuspocus horizontally with Redis",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -27,16 +27,13 @@
     "dist"
   ],
   "devDependencies": {
-    "@types/ioredis": "^4.28.7",
-    "@types/lodash.debounce": "^4.0.6",
-    "@types/redlock": "^4.0.3"
+    "@types/lodash.debounce": "^4.0.6"
   },
   "dependencies": {
-    "@hocuspocus/server": "^2.0.6",
-    "ioredis": "^4.28.2",
+    "@hocuspocus/server": "^2.1.0-alpha.0",
+    "ioredis": "^5.0.4",
     "kleur": "^4.1.4",
     "lodash.debounce": "^4.0.8",
-    "redlock": "^4.2.0",
     "uuid": "^9.0.0"
   },
   "peerDependencies": {

package/src/Redis.ts

@@ -1,5 +1,6 @@
-import RedisClient, { ClusterNode, ClusterOptions, RedisOptions } from 'ioredis'
-import Redlock from 'redlock'
+import RedisClient, {
+  ClusterNode, ClusterOptions, RedisOptions, Cluster as RedisClusterClient,
+} from 'ioredis'
 import { v4 as uuid } from 'uuid'
 import {
   IncomingMessage,
@@ -7,20 +8,16 @@ import {
   Document,
   Extension,
   afterLoadDocumentPayload,
-  afterStoreDocumentPayload,
   onDisconnectPayload,
-  onStoreDocumentPayload,
   onAwarenessUpdatePayload,
   onChangePayload,
   MessageReceiver,
   Debugger,
   onConfigurePayload,
-  onListenPayload,
   beforeBroadcastStatelessPayload, Hocuspocus,
 } from '@hocuspocus/server'
-import kleur from 'kleur'
 
-export type RedisInstance = RedisClient.Cluster | RedisClient.Redis
+export type RedisInstance = RedisClient | RedisClusterClient
 
 export interface Configuration {
   /**
@@ -58,10 +55,6 @@ export interface Configuration {
    * Namespace for Redis keys, if none is provided 'hocuspocus' is used
    */
   prefix: string,
-  /**
-   * The maximum time for the Redis lock in ms (in case it can’t be released).
-   */
-  lockTimeout: number,
   /**
    * A delay before onDisconnect is executed. This allows last minute updates'
    * sync messages to be received by the subscription before it's closed.
@@ -82,7 +75,6 @@ export class Redis implements Extension {
     host: '127.0.0.1',
     prefix: 'hocuspocus',
     identifier: `host-${uuid()}`,
-    lockTimeout: 1000,
     disconnectDelay: 1000,
   }
 
@@ -92,10 +84,6 @@ export class Redis implements Extension {
 
   instance!: Hocuspocus
 
-  redlock: Redlock
-
-  locks = new Map<string, Redlock.Lock>()
-
   logger: Debugger
 
   public constructor(configuration: Partial<Configuration>) {
@@ -104,9 +92,6 @@ export class Redis implements Extension {
       ...configuration,
     }
 
-    // We’ll replace that in the onConfigure hook with the global instance.
-    this.logger = new Debugger()
-
     // Create Redis instance
     const {
       port,
@@ -127,12 +112,13 @@ export class Redis implements Extension {
       this.pub = new RedisClient.Cluster(nodes, options)
       this.sub = new RedisClient.Cluster(nodes, options)
     } else {
-      this.pub = new RedisClient(port, host, options)
-      this.sub = new RedisClient(port, host, options)
+      this.pub = new RedisClient(port, host, options as RedisOptions)
+      this.sub = new RedisClient(port, host, options as RedisOptions)
     }
     this.sub.on('pmessageBuffer', this.handleIncomingMessage)
 
-    this.redlock = new Redlock([this.pub])
+    // We’ll replace that in the onConfigure hook with the global instance.
+    this.logger = new Debugger()
   }
 
   async onConfigure({ instance }: onConfigurePayload) {
@@ -140,15 +126,6 @@ export class Redis implements Extension {
     this.instance = instance
   }
 
-  async onListen({ configuration }: onListenPayload) {
-    if (configuration.quiet) {
-      return
-    }
-
-    console.warn(`  ${kleur.yellow('[BREAKING CHANGE] Wait, the Redis extension got an overhaul. The new Redis extension doesn’t persist data, it only syncs data between instances. Use @hocuspocus/extension-database to store your documents. It works well with the Redis extension.')}`)
-    console.log()
-  }
-
   private getKey(documentName: string) {
     return `${this.configuration.prefix}:${documentName}`
   }
@@ -161,10 +138,6 @@ export class Redis implements Extension {
     return `${this.getKey(documentName)}:*`
   }
 
-  private lockKey(documentName: string) {
-    return `${this.getKey(documentName)}:lock`
-  }
-
   /**
    * Once a document is laoded, subscribe to the channel in Redis.
    */
@@ -194,7 +167,7 @@ export class Redis implements Extension {
       .createSyncMessage()
       .writeFirstSyncStepFor(document)
 
-    return this.pub.publishBuffer(this.pubKey(documentName), Buffer.from(syncMessage.toUint8Array()))
+    return this.pub.publish(this.pubKey(documentName), Buffer.from(syncMessage.toUint8Array()))
   }
 
   /**
@@ -204,49 +177,12 @@ export class Redis implements Extension {
     const awarenessMessage = new OutgoingMessage(documentName)
       .writeQueryAwareness()
 
-    return this.pub.publishBuffer(
+    return this.pub.publish(
       this.pubKey(documentName),
       Buffer.from(awarenessMessage.toUint8Array()),
     )
   }
 
-  /**
-   * Before the document is stored, make sure to set a lock in Redis.
-   * That’s meant to avoid conflicts with other instances trying to store the document.
-   */
-  async onStoreDocument({ documentName }: onStoreDocumentPayload) {
-    // Attempt to acquire a lock and read lastReceivedTimestamp from Redis,
-    // to avoid conflict with other instances storing the same document.
-    return new Promise((resolve, reject) => {
-      this.redlock.lock(this.lockKey(documentName), this.configuration.lockTimeout, async (error, lock) => {
-        if (error || !lock) {
-          // Expected behavior: Could not acquire lock, another instance locked it already.
-          // No further `onStoreDocument` hooks will be executed.
-          reject()
-          return
-        }
-
-        this.locks.set(this.lockKey(documentName), lock)
-
-        resolve(undefined)
-      })
-    })
-  }
-
-  /**
-   * Release the Redis lock, so other instances can store documents.
-   */
-  async afterStoreDocument({ documentName }: afterStoreDocumentPayload) {
-    this.locks.get(this.lockKey(documentName))?.unlock()
-      .catch(() => {
-        // Not able to unlock Redis. The lock will expire after ${lockTimeout} ms.
-        // console.error(`Not able to unlock Redis. The lock will expire after ${this.configuration.lockTimeout}ms.`)
-      })
-      .finally(() => {
-        this.locks.delete(this.lockKey(documentName))
-      })
-  }
-
   /**
    * Handle awareness update messages received directly by this Hocuspocus instance.
    */
@@ -257,7 +193,7 @@ export class Redis implements Extension {
     const message = new OutgoingMessage(documentName)
       .createAwarenessUpdateMessage(awareness, changedClients)
 
-    return this.pub.publishBuffer(
+    return this.pub.publish(
       this.pubKey(documentName),
       Buffer.from(message.toUint8Array()),
     )
@@ -290,7 +226,7 @@ export class Redis implements Extension {
       message,
       this.logger,
     ).apply(document, undefined, reply => {
-      return this.pub.publishBuffer(
+      return this.pub.publish(
         this.pubKey(document.name),
         Buffer.from(reply),
       )
@@ -332,16 +268,10 @@ export class Redis implements Extension {
     const message = new OutgoingMessage(data.documentName)
       .writeBroadcastStateless(data.payload)
 
-    return this.pub.publishBuffer(
+    return this.pub.publish(
       this.pubKey(data.documentName),
       Buffer.from(message.toUint8Array()),
     )
   }
 
-  /**
-   * Kill the Redlock connection immediately.
-   */
-  async onDestroy() {
-    this.redlock.quit()
-  }
 }