@hocuspocus/extension-redis 1.0.0-alpha.60 → 1.0.0-alpha.63

package/dist/hocuspocus-redis.cjs

@@ -2,67 +2,189 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var yRedis = require('y-redis');
+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
-     */
     constructor(configuration) {
-        this.configuration = {};
-        this.cluster = false;
+        /**
+         * Make sure to give that extension a higher priority, so
+         * the `onStoreDocument` hook is able to intercept the chain,
+         * before documents are stored to the database.
+         */
+        this.priority = 1000;
+        this.configuration = {
+            port: 6379,
+            host: '127.0.0.1',
+            prefix: 'hocuspocus',
+            identifier: `host-${uuid.v4()}`,
+            lockTimeout: 1000,
+        };
+        this.documents = new Map();
+        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
+         * in Redis to filter these.
+        */
+        this.handleIncomingMessage = async (channel, pattern, data) => {
+            const channelName = pattern.toString();
+            const [_, documentName, identifier] = channelName.split(':');
+            const document = this.documents.get(documentName);
+            if (identifier === this.configuration.identifier) {
+                return;
+            }
+            if (!document) {
+                return;
+            }
+            new server.MessageReceiver(new server.IncomingMessage(data), this.logger).apply(document, undefined, reply => {
+                return this.pub.publishBuffer(this.pubKey(document.name), Buffer.from(reply));
+            });
+        };
+        /**
+         * Make sure to *not* listen for further changes, when there’s
+         * noone connected anymore.
+         */
+        this.onDisconnect = async ({ documentName, clientsCount }) => {
+            // Do nothing, when other users are still connected to the document.
+            if (clientsCount > 0) {
+                return;
+            }
+            // It was indeed the last connected user.
+            this.documents.delete(documentName);
+            // Time to end the subscription on the document channel.
+            this.sub.punsubscribe(this.subKey(documentName), error => {
+                if (error) {
+                    console.error(error);
+                }
+            });
+        };
         this.configuration = {
             ...this.configuration,
             ...configuration,
         };
+        const { port, host, options } = this.configuration;
+        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.redlock = new Redlock__default["default"]([this.pub]);
+        // We’ll replace that in the onConfigure hook with the global instance.
+        this.logger = new server.Debugger();
     }
-    /*
-     * onLoadDocument hook
-     */
-    async onLoadDocument(data) {
-        if (!this.persistence) {
-            return;
-        }
-        // If another connection has already loaded this doc, return this one instead
-        const binding = this.persistence.docs.get(data.documentName);
-        if (binding) {
-            return binding.doc;
-        }
-        await this.persistence.bindState(data.documentName, data.document).synced;
+    async onConfigure({ instance }) {
+        this.logger = instance.debugger;
     }
-    async onConnect(data) {
-        // Bind to Redis already? Ok, no worries.
-        if (this.persistence) {
+    async onListen({ configuration }) {
+        if (configuration.quiet) {
             return;
         }
-        this.persistence = new yRedis.RedisPersistence(
-        // @ts-ignore
-        this.cluster
-            ? { redisClusterOpts: this.configuration }
-            : { redisOpts: this.configuration });
+        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();
     }
-    async onDisconnect(data) {
-        // Not binded to Redis? Never mind!
-        if (!this.persistence) {
-            return;
-        }
-        // Still clients connected?
-        if (data.clientsCount > 0) {
-            return;
-        }
-        // Fine, let’s remove the binding …
-        this.persistence.destroy();
-        this.persistence = undefined;
+    getKey(documentName) {
+        return `${this.configuration.prefix}:${documentName}`;
     }
-}
-
-class RedisCluster extends Redis {
-    constructor() {
-        super(...arguments);
-        this.cluster = true;
+    pubKey(documentName) {
+        return `${this.getKey(documentName)}:${this.configuration.identifier.replace(/:/g, '')}`;
+    }
+    subKey(documentName) {
+        return `${this.getKey(documentName)}:*`;
+    }
+    lockKey(documentName) {
+        return `${this.getKey(documentName)}:lock`;
+    }
+    /**
+     * Once a document is laoded, subscribe to the channel in Redis.
+     */
+    async afterLoadDocument({ documentName, document }) {
+        this.documents.set(documentName, document);
+        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) => {
+                if (error) {
+                    reject(error);
+                    return;
+                }
+                this.publishFirstSyncStep(documentName, document);
+                this.requestAwarenessFromOtherInstances(documentName);
+                resolve(undefined);
+            });
+        });
+    }
+    /**
+     * Publish the first sync step through Redis.
+     */
+    async publishFirstSyncStep(documentName, document) {
+        const syncMessage = new server.OutgoingMessage()
+            .createSyncMessage()
+            .writeFirstSyncStepFor(document);
+        return this.pub.publishBuffer(this.pubKey(documentName), Buffer.from(syncMessage.toUint8Array()));
+    }
+    /**
+     * Let’s ask Redis who is connected already.
+     */
+    async requestAwarenessFromOtherInstances(documentName) {
+        const awarenessMessage = new server.OutgoingMessage()
+            .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));
+        });
+    }
+    /**
+     * Handle awareness update messages received directly by this Hocuspocus instance.
+     */
+    async onAwarenessUpdate({ documentName, awareness }) {
+        const message = new server.OutgoingMessage()
+            .createAwarenessUpdateMessage(awareness);
+        return this.pub.publishBuffer(this.pubKey(documentName), Buffer.from(message.toUint8Array()));
+    }
+    /**
+     * Kill the Redlock connection immediately.
+     */
+    async onDestroy() {
+        this.redlock.quit();
     }
 }
 
 exports.Redis = Redis;
-exports.RedisCluster = RedisCluster;
 //# sourceMappingURL=hocuspocus-redis.cjs.map

package/dist/hocuspocus-redis.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"hocuspocus-redis.cjs","sources":["../src/Redis.ts","../src/RedisCluster.ts"],"sourcesContent":["import { RedisPersistence } from 'y-redis'\nimport {\n  Extension,\n  onConnectPayload,\n  onLoadDocumentPayload,\n  onDisconnectPayload,\n} from '@hocuspocus/server'\n\nexport interface Configuration {\n}\n\nexport class Redis implements Extension {\n\n  configuration: Configuration = {}\n\n  cluster = false\n\n  persistence!: RedisPersistence | undefined\n\n  /**\n   * Constructor\n   */\n  constructor(configuration?: Partial<Configuration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n  }\n\n  /*\n   * onLoadDocument hook\n   */\n  async onLoadDocument(data: onLoadDocumentPayload) {\n    if (!this.persistence) {\n      return\n    }\n\n    // If another connection has already loaded this doc, return this one instead\n    const binding = this.persistence.docs.get(data.documentName)\n\n    if (binding) {\n      return binding.doc\n    }\n\n    await this.persistence.bindState(data.documentName, data.document).synced\n  }\n\n  async onConnect(data: onConnectPayload) {\n    // Bind to Redis already? Ok, no worries.\n    if (this.persistence) {\n      return\n    }\n\n    this.persistence = new RedisPersistence(\n      // @ts-ignore\n      this.cluster\n        ? { redisClusterOpts: this.configuration }\n        : { redisOpts: this.configuration },\n    )\n\n  }\n\n  async onDisconnect(data: onDisconnectPayload) {\n    // Not binded to Redis? Never mind!\n    if (!this.persistence) {\n      return\n    }\n\n    // Still clients connected?\n    if (data.clientsCount > 0) {\n      return\n    }\n\n    // Fine, let’s remove the binding …\n    this.persistence.destroy()\n    this.persistence = undefined\n\n  }\n\n}\n","import { Redis } from './Redis'\n\nexport class RedisCluster extends Redis {\n\n  cluster = true\n\n}\n"],"names":["RedisPersistence"],"mappings":";;;;;;MAWa,KAAK;;;;IAWhB,YAAY,aAAsC;QATlD,kBAAa,GAAkB,EAAE,CAAA;QAEjC,YAAO,GAAG,KAAK,CAAA;QAQb,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;YACrB,GAAG,aAAa;SACjB,CAAA;KACF;;;;IAKD,MAAM,cAAc,CAAC,IAA2B;QAC9C,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YACrB,OAAM;SACP;;QAGD,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QAE5D,IAAI,OAAO,EAAE;YACX,OAAO,OAAO,CAAC,GAAG,CAAA;SACnB;QAED,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAA;KAC1E;IAED,MAAM,SAAS,CAAC,IAAsB;;QAEpC,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAM;SACP;QAED,IAAI,CAAC,WAAW,GAAG,IAAIA,uBAAgB;;QAErC,IAAI,CAAC,OAAO;cACR,EAAE,gBAAgB,EAAE,IAAI,CAAC,aAAa,EAAE;cACxC,EAAE,SAAS,EAAE,IAAI,CAAC,aAAa,EAAE,CACtC,CAAA;KAEF;IAED,MAAM,YAAY,CAAC,IAAyB;;QAE1C,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YACrB,OAAM;SACP;;QAGD,IAAI,IAAI,CAAC,YAAY,GAAG,CAAC,EAAE;YACzB,OAAM;SACP;;QAGD,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAA;QAC1B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAA;KAE7B;;;MC3EU,YAAa,SAAQ,KAAK;IAAvC;;QAEE,YAAO,GAAG,IAAI,CAAA;KAEf;;;;;;"}
+{"version":3,"file":"hocuspocus-redis.cjs","sources":["../src/Redis.ts"],"sourcesContent":["import RedisClient 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  MessageReceiver,\n  Debugger,\n  onConfigurePayload,\n  onListenPayload,\n} from '@hocuspocus/server'\nimport kleur from 'kleur'\n\nexport interface Configuration {\n  /**\n   * Redis port\n   */\n  port: number,\n  /**\n   * Redis host\n   */\n  host: string,\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?: RedisClient.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\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  }\n\n  pub: RedisClient.Redis\n\n  sub: RedisClient.Redis\n\n  documents: Map<string, Document> = new Map()\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    const { port, host, options } = this.configuration\n\n    this.pub = new RedisClient(port, host, options)\n\n    this.sub = new RedisClient(port, host, options)\n    this.sub.on('pmessageBuffer', this.handleIncomingMessage)\n\n    this.redlock = new Redlock([this.pub])\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  }\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    this.documents.set(documentName, document)\n\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()\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()\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({ documentName, awareness }: onAwarenessUpdatePayload) {\n    const message = new OutgoingMessage()\n      .createAwarenessUpdateMessage(awareness)\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 channelName = pattern.toString()\n    const [_, documentName, identifier] = channelName.split(':')\n    const document = this.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      new IncomingMessage(data),\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   * Make sure to *not* listen for further changes, when there’s\n   * noone connected anymore.\n   */\n  public onDisconnect = async ({ documentName, clientsCount }: onDisconnectPayload) => {\n    // Do nothing, when other users are still connected to the document.\n    if (clientsCount > 0) {\n      return\n    }\n\n    // It was indeed the last connected user.\n    this.documents.delete(documentName)\n\n    // Time to end the subscription on the document channel.\n    this.sub.punsubscribe(this.subKey(documentName), error => {\n      if (error) {\n        console.error(error)\n      }\n    })\n  }\n\n  /**\n   * Kill the Redlock connection immediately.\n   */\n  async onDestroy() {\n    this.redlock.quit()\n  }\n}\n"],"names":["uuid","MessageReceiver","IncomingMessage","RedisClient","Redlock","Debugger","kleur","OutgoingMessage"],"mappings":";;;;;;;;;;;;;;;;MAkDa,KAAK,CAAA;AA4BhB,IAAA,WAAA,CAAmB,aAAqC,EAAA;AA3BxD;;;;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;SAClB,CAAA;AAMD,QAAA,IAAA,CAAA,SAAS,GAA0B,IAAI,GAAG,EAAE,CAAA;AAI5C,QAAA,IAAA,CAAA,KAAK,GAAG,IAAI,GAAG,EAAwB,CAAA;AAqJvC;;;;AAIE;QACM,IAAqB,CAAA,qBAAA,GAAG,OAAO,OAAe,EAAE,OAAe,EAAE,IAAY,KAAI;AACvF,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;YAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;AAEjD,YAAA,IAAI,UAAU,KAAK,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE;gBAChD,OAAM;AACP,aAAA;YAED,IAAI,CAAC,QAAQ,EAAE;gBACb,OAAM;AACP,aAAA;YAED,IAAIC,sBAAe,CACjB,IAAIC,sBAAe,CAAC,IAAI,CAAC,EACzB,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;AAED;;;AAGG;QACI,IAAY,CAAA,YAAA,GAAG,OAAO,EAAE,YAAY,EAAE,YAAY,EAAuB,KAAI;;YAElF,IAAI,YAAY,GAAG,CAAC,EAAE;gBACpB,OAAM;AACP,aAAA;;AAGD,YAAA,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;;AAGnC,YAAA,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,KAAK,IAAG;AACvD,gBAAA,IAAI,KAAK,EAAE;AACT,oBAAA,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;AACrB,iBAAA;AACH,aAAC,CAAC,CAAA;AACJ,SAAC,CAAA;QAhMC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SACjB,CAAA;QAED,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,aAAa,CAAA;AAElD,QAAA,IAAI,CAAC,GAAG,GAAG,IAAIC,+BAAW,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AAE/C,QAAA,IAAI,CAAC,GAAG,GAAG,IAAIA,+BAAW,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;QAC/C,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;;AAGtC,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;KAChC;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,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAA;QAE1C,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,EAAE;AACtC,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,EAAE;AAC3C,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,EAAE,YAAY,EAAE,SAAS,EAA4B,EAAA;AAC3E,QAAA,MAAM,OAAO,GAAG,IAAIA,sBAAe,EAAE;aAClC,4BAA4B,CAAC,SAAS,CAAC,CAAA;QAE1C,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;AAoDD;;AAEG;AACH,IAAA,MAAM,SAAS,GAAA;AACb,QAAA,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;KACpB;AACF;;;;"}

package/dist/hocuspocus-redis.esm.js

@@ -1,63 +1,180 @@
-import { RedisPersistence } from 'y-redis';
+import RedisClient from 'ioredis';
+import Redlock from 'redlock';
+import { v4 } from 'uuid';
+import { MessageReceiver, IncomingMessage, Debugger, OutgoingMessage } from '@hocuspocus/server';
+import kleur from 'kleur';
 
 class Redis {
-    /**
-     * Constructor
-     */
     constructor(configuration) {
-        this.configuration = {};
-        this.cluster = false;
+        /**
+         * Make sure to give that extension a higher priority, so
+         * the `onStoreDocument` hook is able to intercept the chain,
+         * before documents are stored to the database.
+         */
+        this.priority = 1000;
+        this.configuration = {
+            port: 6379,
+            host: '127.0.0.1',
+            prefix: 'hocuspocus',
+            identifier: `host-${v4()}`,
+            lockTimeout: 1000,
+        };
+        this.documents = new Map();
+        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
+         * in Redis to filter these.
+        */
+        this.handleIncomingMessage = async (channel, pattern, data) => {
+            const channelName = pattern.toString();
+            const [_, documentName, identifier] = channelName.split(':');
+            const document = this.documents.get(documentName);
+            if (identifier === this.configuration.identifier) {
+                return;
+            }
+            if (!document) {
+                return;
+            }
+            new MessageReceiver(new IncomingMessage(data), this.logger).apply(document, undefined, reply => {
+                return this.pub.publishBuffer(this.pubKey(document.name), Buffer.from(reply));
+            });
+        };
+        /**
+         * Make sure to *not* listen for further changes, when there’s
+         * noone connected anymore.
+         */
+        this.onDisconnect = async ({ documentName, clientsCount }) => {
+            // Do nothing, when other users are still connected to the document.
+            if (clientsCount > 0) {
+                return;
+            }
+            // It was indeed the last connected user.
+            this.documents.delete(documentName);
+            // Time to end the subscription on the document channel.
+            this.sub.punsubscribe(this.subKey(documentName), error => {
+                if (error) {
+                    console.error(error);
+                }
+            });
+        };
         this.configuration = {
             ...this.configuration,
             ...configuration,
         };
+        const { port, host, options } = this.configuration;
+        this.pub = new RedisClient(port, host, options);
+        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();
     }
-    /*
-     * onLoadDocument hook
-     */
-    async onLoadDocument(data) {
-        if (!this.persistence) {
-            return;
-        }
-        // If another connection has already loaded this doc, return this one instead
-        const binding = this.persistence.docs.get(data.documentName);
-        if (binding) {
-            return binding.doc;
-        }
-        await this.persistence.bindState(data.documentName, data.document).synced;
+    async onConfigure({ instance }) {
+        this.logger = instance.debugger;
     }
-    async onConnect(data) {
-        // Bind to Redis already? Ok, no worries.
-        if (this.persistence) {
+    async onListen({ configuration }) {
+        if (configuration.quiet) {
             return;
         }
-        this.persistence = new RedisPersistence(
-        // @ts-ignore
-        this.cluster
-            ? { redisClusterOpts: this.configuration }
-            : { redisOpts: this.configuration });
-    }
-    async onDisconnect(data) {
-        // Not binded to Redis? Never mind!
-        if (!this.persistence) {
-            return;
-        }
-        // Still clients connected?
-        if (data.clientsCount > 0) {
-            return;
-        }
-        // Fine, let’s remove the binding …
-        this.persistence.destroy();
-        this.persistence = undefined;
+        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();
     }
-}
-
-class RedisCluster extends Redis {
-    constructor() {
-        super(...arguments);
-        this.cluster = true;
+    getKey(documentName) {
+        return `${this.configuration.prefix}:${documentName}`;
+    }
+    pubKey(documentName) {
+        return `${this.getKey(documentName)}:${this.configuration.identifier.replace(/:/g, '')}`;
+    }
+    subKey(documentName) {
+        return `${this.getKey(documentName)}:*`;
+    }
+    lockKey(documentName) {
+        return `${this.getKey(documentName)}:lock`;
+    }
+    /**
+     * Once a document is laoded, subscribe to the channel in Redis.
+     */
+    async afterLoadDocument({ documentName, document }) {
+        this.documents.set(documentName, document);
+        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) => {
+                if (error) {
+                    reject(error);
+                    return;
+                }
+                this.publishFirstSyncStep(documentName, document);
+                this.requestAwarenessFromOtherInstances(documentName);
+                resolve(undefined);
+            });
+        });
+    }
+    /**
+     * Publish the first sync step through Redis.
+     */
+    async publishFirstSyncStep(documentName, document) {
+        const syncMessage = new OutgoingMessage()
+            .createSyncMessage()
+            .writeFirstSyncStepFor(document);
+        return this.pub.publishBuffer(this.pubKey(documentName), Buffer.from(syncMessage.toUint8Array()));
+    }
+    /**
+     * Let’s ask Redis who is connected already.
+     */
+    async requestAwarenessFromOtherInstances(documentName) {
+        const awarenessMessage = new OutgoingMessage()
+            .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));
+        });
+    }
+    /**
+     * Handle awareness update messages received directly by this Hocuspocus instance.
+     */
+    async onAwarenessUpdate({ documentName, awareness }) {
+        const message = new OutgoingMessage()
+            .createAwarenessUpdateMessage(awareness);
+        return this.pub.publishBuffer(this.pubKey(documentName), Buffer.from(message.toUint8Array()));
+    }
+    /**
+     * Kill the Redlock connection immediately.
+     */
+    async onDestroy() {
+        this.redlock.quit();
     }
 }
 
-export { Redis, RedisCluster };
+export { Redis };
 //# sourceMappingURL=hocuspocus-redis.esm.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"hocuspocus-redis.esm.js","sources":["../src/Redis.ts","../src/RedisCluster.ts"],"sourcesContent":["import { RedisPersistence } from 'y-redis'\nimport {\n  Extension,\n  onConnectPayload,\n  onLoadDocumentPayload,\n  onDisconnectPayload,\n} from '@hocuspocus/server'\n\nexport interface Configuration {\n}\n\nexport class Redis implements Extension {\n\n  configuration: Configuration = {}\n\n  cluster = false\n\n  persistence!: RedisPersistence | undefined\n\n  /**\n   * Constructor\n   */\n  constructor(configuration?: Partial<Configuration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n  }\n\n  /*\n   * onLoadDocument hook\n   */\n  async onLoadDocument(data: onLoadDocumentPayload) {\n    if (!this.persistence) {\n      return\n    }\n\n    // If another connection has already loaded this doc, return this one instead\n    const binding = this.persistence.docs.get(data.documentName)\n\n    if (binding) {\n      return binding.doc\n    }\n\n    await this.persistence.bindState(data.documentName, data.document).synced\n  }\n\n  async onConnect(data: onConnectPayload) {\n    // Bind to Redis already? Ok, no worries.\n    if (this.persistence) {\n      return\n    }\n\n    this.persistence = new RedisPersistence(\n      // @ts-ignore\n      this.cluster\n        ? { redisClusterOpts: this.configuration }\n        : { redisOpts: this.configuration },\n    )\n\n  }\n\n  async onDisconnect(data: onDisconnectPayload) {\n    // Not binded to Redis? Never mind!\n    if (!this.persistence) {\n      return\n    }\n\n    // Still clients connected?\n    if (data.clientsCount > 0) {\n      return\n    }\n\n    // Fine, let’s remove the binding …\n    this.persistence.destroy()\n    this.persistence = undefined\n\n  }\n\n}\n","import { Redis } from './Redis'\n\nexport class RedisCluster extends Redis {\n\n  cluster = true\n\n}\n"],"names":[],"mappings":";;MAWa,KAAK;;;;IAWhB,YAAY,aAAsC;QATlD,kBAAa,GAAkB,EAAE,CAAA;QAEjC,YAAO,GAAG,KAAK,CAAA;QAQb,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;YACrB,GAAG,aAAa;SACjB,CAAA;KACF;;;;IAKD,MAAM,cAAc,CAAC,IAA2B;QAC9C,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YACrB,OAAM;SACP;;QAGD,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QAE5D,IAAI,OAAO,EAAE;YACX,OAAO,OAAO,CAAC,GAAG,CAAA;SACnB;QAED,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAA;KAC1E;IAED,MAAM,SAAS,CAAC,IAAsB;;QAEpC,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAM;SACP;QAED,IAAI,CAAC,WAAW,GAAG,IAAI,gBAAgB;;QAErC,IAAI,CAAC,OAAO;cACR,EAAE,gBAAgB,EAAE,IAAI,CAAC,aAAa,EAAE;cACxC,EAAE,SAAS,EAAE,IAAI,CAAC,aAAa,EAAE,CACtC,CAAA;KAEF;IAED,MAAM,YAAY,CAAC,IAAyB;;QAE1C,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YACrB,OAAM;SACP;;QAGD,IAAI,IAAI,CAAC,YAAY,GAAG,CAAC,EAAE;YACzB,OAAM;SACP;;QAGD,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAA;QAC1B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAA;KAE7B;;;MC3EU,YAAa,SAAQ,KAAK;IAAvC;;QAEE,YAAO,GAAG,IAAI,CAAA;KAEf;;;;;"}
+{"version":3,"file":"hocuspocus-redis.esm.js","sources":["../src/Redis.ts"],"sourcesContent":["import RedisClient 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  MessageReceiver,\n  Debugger,\n  onConfigurePayload,\n  onListenPayload,\n} from '@hocuspocus/server'\nimport kleur from 'kleur'\n\nexport interface Configuration {\n  /**\n   * Redis port\n   */\n  port: number,\n  /**\n   * Redis host\n   */\n  host: string,\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?: RedisClient.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\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  }\n\n  pub: RedisClient.Redis\n\n  sub: RedisClient.Redis\n\n  documents: Map<string, Document> = new Map()\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    const { port, host, options } = this.configuration\n\n    this.pub = new RedisClient(port, host, options)\n\n    this.sub = new RedisClient(port, host, options)\n    this.sub.on('pmessageBuffer', this.handleIncomingMessage)\n\n    this.redlock = new Redlock([this.pub])\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  }\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    this.documents.set(documentName, document)\n\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()\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()\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({ documentName, awareness }: onAwarenessUpdatePayload) {\n    const message = new OutgoingMessage()\n      .createAwarenessUpdateMessage(awareness)\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 channelName = pattern.toString()\n    const [_, documentName, identifier] = channelName.split(':')\n    const document = this.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      new IncomingMessage(data),\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   * Make sure to *not* listen for further changes, when there’s\n   * noone connected anymore.\n   */\n  public onDisconnect = async ({ documentName, clientsCount }: onDisconnectPayload) => {\n    // Do nothing, when other users are still connected to the document.\n    if (clientsCount > 0) {\n      return\n    }\n\n    // It was indeed the last connected user.\n    this.documents.delete(documentName)\n\n    // Time to end the subscription on the document channel.\n    this.sub.punsubscribe(this.subKey(documentName), error => {\n      if (error) {\n        console.error(error)\n      }\n    })\n  }\n\n  /**\n   * Kill the Redlock connection immediately.\n   */\n  async onDestroy() {\n    this.redlock.quit()\n  }\n}\n"],"names":["uuid"],"mappings":";;;;;;MAkDa,KAAK,CAAA;AA4BhB,IAAA,WAAA,CAAmB,aAAqC,EAAA;AA3BxD;;;;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;SAClB,CAAA;AAMD,QAAA,IAAA,CAAA,SAAS,GAA0B,IAAI,GAAG,EAAE,CAAA;AAI5C,QAAA,IAAA,CAAA,KAAK,GAAG,IAAI,GAAG,EAAwB,CAAA;AAqJvC;;;;AAIE;QACM,IAAqB,CAAA,qBAAA,GAAG,OAAO,OAAe,EAAE,OAAe,EAAE,IAAY,KAAI;AACvF,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;YAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;AAEjD,YAAA,IAAI,UAAU,KAAK,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE;gBAChD,OAAM;AACP,aAAA;YAED,IAAI,CAAC,QAAQ,EAAE;gBACb,OAAM;AACP,aAAA;YAED,IAAI,eAAe,CACjB,IAAI,eAAe,CAAC,IAAI,CAAC,EACzB,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;AAED;;;AAGG;QACI,IAAY,CAAA,YAAA,GAAG,OAAO,EAAE,YAAY,EAAE,YAAY,EAAuB,KAAI;;YAElF,IAAI,YAAY,GAAG,CAAC,EAAE;gBACpB,OAAM;AACP,aAAA;;AAGD,YAAA,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;;AAGnC,YAAA,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,KAAK,IAAG;AACvD,gBAAA,IAAI,KAAK,EAAE;AACT,oBAAA,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;AACrB,iBAAA;AACH,aAAC,CAAC,CAAA;AACJ,SAAC,CAAA;QAhMC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SACjB,CAAA;QAED,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,aAAa,CAAA;AAElD,QAAA,IAAI,CAAC,GAAG,GAAG,IAAI,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AAE/C,QAAA,IAAI,CAAC,GAAG,GAAG,IAAI,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;QAC/C,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;;AAGtC,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;KAChC;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,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAA;QAE1C,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,EAAE;AACtC,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,EAAE;AAC3C,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,EAAE,YAAY,EAAE,SAAS,EAA4B,EAAA;AAC3E,QAAA,MAAM,OAAO,GAAG,IAAI,eAAe,EAAE;aAClC,4BAA4B,CAAC,SAAS,CAAC,CAAA;QAE1C,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;AAoDD;;AAEG;AACH,IAAA,MAAM,SAAS,GAAA;AACb,QAAA,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;KACpB;AACF;;;;"}

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

@@ -3,7 +3,6 @@ import { Configuration, onConnectPayload, onDisconnectPayload, onLoadDocumentPay
 export declare class Collector {
     serverConfiguration: Partial<Configuration>;
     version: string;
-    yjsVersion: string;
     connections: {};
     messages: {};
     messageCounter: number;
@@ -51,12 +50,12 @@ export declare class Collector {
     documents(): {};
     info(): Promise<{
         configuration: Partial<Configuration>;
-        ipAddress: string;
+        ipAddress: string | null;
         nodeVersion: string;
         platform: NodeJS.Platform;
         started: string;
         version: string;
-        yjsVersion: string;
     }>;
+    private getIpAddress;
     private static readableYDoc;
 }

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

@@ -1,16 +1,94 @@
-import { RedisPersistence } from 'y-redis';
-import { Extension, onConnectPayload, onLoadDocumentPayload, onDisconnectPayload } from '@hocuspocus/server';
+import RedisClient from 'ioredis';
+import Redlock from 'redlock';
+import { Document, Extension, afterLoadDocumentPayload, afterStoreDocumentPayload, onDisconnectPayload, onStoreDocumentPayload, onAwarenessUpdatePayload, Debugger, onConfigurePayload, onListenPayload } from '@hocuspocus/server';
 export interface Configuration {
+    /**
+     * Redis port
+     */
+    port: number;
+    /**
+     * Redis host
+     */
+    host: string;
+    /**
+     * Options passed directly to Redis constructor
+     *
+     * https://github.com/luin/ioredis/blob/master/API.md#new-redisport-host-options
+     */
+    options?: RedisClient.RedisOptions;
+    /**
+     * An unique instance name, required to filter messages in Redis.
+     * If none is provided an unique id is generated.
+     */
+    identifier: string;
+    /**
+     * 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;
 }
 export declare class Redis implements Extension {
+    /**
+     * Make sure to give that extension a higher priority, so
+     * the `onStoreDocument` hook is able to intercept the chain,
+     * before documents are stored to the database.
+     */
+    priority: number;
     configuration: Configuration;
-    cluster: boolean;
-    persistence: RedisPersistence | undefined;
+    pub: RedisClient.Redis;
+    sub: RedisClient.Redis;
+    documents: Map<string, Document>;
+    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.
+     */
+    afterLoadDocument({ documentName, document }: afterLoadDocumentPayload): Promise<unknown>;
+    /**
+     * Publish the first sync step through Redis.
+     */
+    private publishFirstSyncStep;
+    /**
+     * 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.
+     */
+    onAwarenessUpdate({ documentName, awareness }: onAwarenessUpdatePayload): Promise<number>;
+    /**
+     * Handle incoming messages published on all subscribed document channels.
+     * Note that this will also include messages from ourselves as it is not possible
+     * in Redis to filter these.
+    */
+    private handleIncomingMessage;
+    /**
+     * Make sure to *not* listen for further changes, when there’s
+     * noone connected anymore.
+     */
+    onDisconnect: ({ documentName, clientsCount }: onDisconnectPayload) => Promise<void>;
     /**
-     * Constructor
+     * Kill the Redlock connection immediately.
      */
-    constructor(configuration?: Partial<Configuration>);
-    onLoadDocument(data: onLoadDocumentPayload): Promise<import("yjs").Doc | undefined>;
-    onConnect(data: onConnectPayload): Promise<void>;
-    onDisconnect(data: onDisconnectPayload): Promise<void>;
+    onDestroy(): Promise<void>;
 }

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

@@ -1,2 +1 @@
 export * from './Redis';
-export * from './RedisCluster';

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

@@ -3,14 +3,8 @@ import { Awareness } from 'y-protocols/awareness';
 import * as mutex from 'lib0/mutex';
 import type { Event, CloseEvent, MessageEvent } from 'ws';
 import EventEmitter from './EventEmitter';
-import { OutgoingMessage } from './OutgoingMessage';
-import { ConstructableOutgoingMessage } from './types';
+import { ConstructableOutgoingMessage, onAuthenticationFailedParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatusParameters, onSyncedParameters, WebSocketStatus } from './types';
 import { onAwarenessChangeParameters, onAwarenessUpdateParameters } from '.';
-export declare enum WebSocketStatus {
-    Connecting = "connecting",
-    Connected = "connected",
-    Disconnected = "disconnected"
-}
 export declare type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, 'url' | 'name'>> & Partial<CompleteHocuspocusProviderConfiguration>;
 export interface CompleteHocuspocusProviderConfiguration {
     /**
@@ -92,22 +86,18 @@ export interface CompleteHocuspocusProviderConfiguration {
      */
     timeout: number;
     onAuthenticated: () => void;
-    onAuthenticationFailed: ({ reason }: {
-        reason: string;
-    }) => void;
-    onOpen: (event: Event) => void;
+    onAuthenticationFailed: (data: onAuthenticationFailedParameters) => void;
+    onOpen: (data: onOpenParameters) => void;
     onConnect: () => void;
-    onMessage: (event: MessageEvent) => void;
-    onOutgoingMessage: (message: OutgoingMessage) => void;
-    onStatus: (status: any) => void;
-    onSynced: ({ state }: {
-        state: boolean;
-    }) => void;
-    onDisconnect: (event: CloseEvent) => void;
-    onClose: (event: CloseEvent) => void;
+    onMessage: (data: onMessageParameters) => void;
+    onOutgoingMessage: (data: onOutgoingMessageParameters) => void;
+    onStatus: (data: onStatusParameters) => void;
+    onSynced: (data: onSyncedParameters) => void;
+    onDisconnect: (data: onDisconnectParameters) => void;
+    onClose: (data: onCloseParameters) => void;
     onDestroy: () => void;
-    onAwarenessUpdate: ({ states }: onAwarenessUpdateParameters) => void;
-    onAwarenessChange: ({ states }: onAwarenessChangeParameters) => void;
+    onAwarenessUpdate: (data: onAwarenessUpdateParameters) => void;
+    onAwarenessChange: (data: onAwarenessChangeParameters) => void;
     /**
      * Don’t output any warnings.
      */

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

@@ -1,18 +1,26 @@
 import { Awareness } from 'y-protocols/awareness';
 import * as Y from 'yjs';
 import { Encoder } from 'lib0/encoding';
+import type { Event, CloseEvent, MessageEvent } from 'ws';
 import { AuthenticationMessage } from './OutgoingMessages/AuthenticationMessage';
 import { AwarenessMessage } from './OutgoingMessages/AwarenessMessage';
 import { QueryAwarenessMessage } from './OutgoingMessages/QueryAwarenessMessage';
 import { SyncStepOneMessage } from './OutgoingMessages/SyncStepOneMessage';
 import { SyncStepTwoMessage } from './OutgoingMessages/SyncStepTwoMessage';
 import { UpdateMessage } from './OutgoingMessages/UpdateMessage';
+import { IncomingMessage } from './IncomingMessage';
+import { OutgoingMessage } from './OutgoingMessage';
 export declare enum MessageType {
     Sync = 0,
     Awareness = 1,
     Auth = 2,
     QueryAwareness = 3
 }
+export declare enum WebSocketStatus {
+    Connecting = "connecting",
+    Connected = "connected",
+    Disconnected = "disconnected"
+}
 export interface OutgoingMessageInterface {
     encoder: Encoder;
     type?: MessageType;
@@ -32,6 +40,31 @@ export interface Constructable<T> {
     new (...args: any): T;
 }
 export declare type ConstructableOutgoingMessage = Constructable<AuthenticationMessage> | Constructable<AwarenessMessage> | Constructable<QueryAwarenessMessage> | Constructable<SyncStepOneMessage> | Constructable<SyncStepTwoMessage> | Constructable<UpdateMessage>;
+export declare type onAuthenticationFailedParameters = {
+    reason: string;
+};
+export declare type onOpenParameters = {
+    event: Event;
+};
+export declare type onMessageParameters = {
+    event: MessageEvent;
+    message: IncomingMessage;
+};
+export declare type onOutgoingMessageParameters = {
+    message: OutgoingMessage;
+};
+export declare type onStatusParameters = {
+    status: WebSocketStatus;
+};
+export declare type onSyncedParameters = {
+    state: boolean;
+};
+export declare type onDisconnectParameters = {
+    event: CloseEvent;
+};
+export declare type onCloseParameters = {
+    event: CloseEvent;
+};
 export declare type onAwarenessUpdateParameters = {
     states: StatesArray;
 };

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

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import WebSocket, { AddressInfo, WebSocketServer } from 'ws';
 import { IncomingMessage, Server as HTTPServer } from 'http';
-import { Configuration, Hook } from './types';
+import { Configuration, HookName, HookPayload } from './types';
 import Document from './Document';
 import { Debugger } from './Debugger';
 import { onListenPayload } from '.';
@@ -88,7 +88,7 @@ export declare class Hocuspocus {
      * Run the given hook on all configured extensions.
      * Runs the given callback after each hook.
      */
-    hooks(name: Hook, payload: any, callback?: Function | null): Promise<any>;
+    hooks(name: HookName, payload: HookPayload, callback?: Function | null): Promise<any>;
     /**
      * Get parameters by the given request
      */

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

@@ -1,9 +1,8 @@
-export * from './Hocuspocus';
 export * from './Connection';
+export * from './Debugger';
 export * from './Document';
+export * from './Hocuspocus';
 export * from './IncomingMessage';
+export * from './MessageReceiver';
 export * from './OutgoingMessage';
 export * from './types';
-export * from './MessageReceiver';
-export * from './Document';
-export * from './Connection';

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

@@ -1,7 +1,6 @@
 /// <reference types="node" />
 import { IncomingHttpHeaders, IncomingMessage, ServerResponse } from 'http';
 import { URLSearchParams } from 'url';
-import { Socket } from 'net';
 import { Awareness } from 'y-protocols/awareness';
 import Document from './Document';
 import { Hocuspocus } from './Hocuspocus';
@@ -44,11 +43,12 @@ export interface Extension {
     onDisconnect?(data: onDisconnectPayload): Promise<any>;
     onDestroy?(data: onDestroyPayload): Promise<any>;
 }
-export declare type Hook = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 
+export declare type HookName = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 
 /**
  * @deprecated onCreateDocument is deprecated, use onLoadDocument instead
  */
 'onCreateDocument' | 'onLoadDocument' | 'afterLoadDocument' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'onDestroy';
+export declare type HookPayload = onConfigurePayload | onListenPayload | onUpgradePayload | onConnectPayload | connectedPayload | onAuthenticatePayload | onLoadDocumentPayload | onLoadDocumentPayload | onLoadDocumentPayload | onChangePayload | onStoreDocumentPayload | afterStoreDocumentPayload | onAwarenessUpdatePayload | onRequestPayload | onDisconnectPayload | onDestroyPayload;
 export interface Configuration extends Extension {
     /**
      * A name for the instance, used for logging.
@@ -198,20 +198,21 @@ export interface onRequestPayload {
     instance: Hocuspocus;
 }
 export interface onUpgradePayload {
-    head: any;
     request: IncomingMessage;
-    socket: Socket;
+    socket: any;
+    head: any;
     instance: Hocuspocus;
 }
 export interface onListenPayload {
+    instance: Hocuspocus;
+    configuration: Configuration;
     port: number;
 }
 export interface onDestroyPayload {
     instance: Hocuspocus;
 }
 export interface onConfigurePayload {
+    instance: Hocuspocus;
     configuration: Configuration;
     version: string;
-    yjsVersion: string;
-    instance: Hocuspocus;
 }

package/dist/tests/utils/index.d.ts

@@ -2,6 +2,7 @@ export * from './createDirectory';
 export * from './flushRedis';
 export * from './newHocuspocus';
 export * from './newHocuspocusProvider';
+export * from './randomInteger';
 export * from './redisConnectionSettings';
 export * from './removeDirectory';
 export * from './sleep';

package/dist/tests/utils/randomInteger.d.ts

@@ -0,0 +1 @@
+export declare const randomInteger: (min: number, max: number) => number;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hocuspocus/extension-redis",
-  "version": "1.0.0-alpha.60",
-  "description": "hocuspocus persistence driver for Redis",
+  "version": "1.0.0-alpha.63",
+  "description": "Scale Hocuspocus horizontally with Redis",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
     "hocuspocus",
@@ -26,10 +26,20 @@
     "src",
     "dist"
   ],
+  "devDependencies": {
+    "@types/ioredis": "^4.28.7",
+    "@types/lodash.debounce": "^4.0.6",
+    "@types/redlock": "^4.0.3"
+  },
   "dependencies": {
-    "@hocuspocus/server": "^1.0.0-alpha.97",
-    "y-redis": "^1.0.3",
-    "yjs": "^13.5.28"
+    "@hocuspocus/server": "^1.0.0-alpha.100",
+    "ioredis": "^4.28.2",
+    "kleur": "^4.1.4",
+    "lodash.debounce": "^4.0.8",
+    "redlock": "^4.2.0",
+    "uuid": "^8.3.2",
+    "y-protocols": "^1.0.5",
+    "yjs": "^13.5.23"
   },
-  "gitHead": "673dd4b2c723e71bf9b33b8f7804ab35c8417417"
+  "gitHead": "29d403cdc2b972cf3129229abcaceb08e365fbb4"
 }

package/src/Redis.ts

@@ -1,80 +1,280 @@
-import { RedisPersistence } from 'y-redis'
+import RedisClient from 'ioredis'
+import Redlock from 'redlock'
+import { v4 as uuid } from 'uuid'
 import {
+  IncomingMessage,
+  OutgoingMessage,
+  Document,
   Extension,
-  onConnectPayload,
-  onLoadDocumentPayload,
+  afterLoadDocumentPayload,
+  afterStoreDocumentPayload,
   onDisconnectPayload,
+  onStoreDocumentPayload,
+  onAwarenessUpdatePayload,
+  MessageReceiver,
+  Debugger,
+  onConfigurePayload,
+  onListenPayload,
 } from '@hocuspocus/server'
+import kleur from 'kleur'
 
 export interface Configuration {
+  /**
+   * Redis port
+   */
+  port: number,
+  /**
+   * Redis host
+   */
+  host: string,
+  /**
+   * Options passed directly to Redis constructor
+   *
+   * https://github.com/luin/ioredis/blob/master/API.md#new-redisport-host-options
+   */
+  options?: RedisClient.RedisOptions,
+  /**
+   * An unique instance name, required to filter messages in Redis.
+   * If none is provided an unique id is generated.
+   */
+  identifier: string,
+  /**
+   * 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,
 }
 
 export class Redis implements Extension {
+  /**
+   * Make sure to give that extension a higher priority, so
+   * the `onStoreDocument` hook is able to intercept the chain,
+   * before documents are stored to the database.
+   */
+  priority = 1000
+
+  configuration: Configuration = {
+    port: 6379,
+    host: '127.0.0.1',
+    prefix: 'hocuspocus',
+    identifier: `host-${uuid()}`,
+    lockTimeout: 1000,
+  }
 
-  configuration: Configuration = {}
+  pub: RedisClient.Redis
 
-  cluster = false
+  sub: RedisClient.Redis
 
-  persistence!: RedisPersistence | undefined
+  documents: Map<string, Document> = new Map()
 
-  /**
-   * Constructor
-   */
-  constructor(configuration?: Partial<Configuration>) {
+  redlock: Redlock
+
+  locks = new Map<string, Redlock.Lock>()
+
+  logger: Debugger
+
+  public constructor(configuration: Partial<Configuration>) {
     this.configuration = {
       ...this.configuration,
       ...configuration,
     }
+
+    const { port, host, options } = this.configuration
+
+    this.pub = new RedisClient(port, host, options)
+
+    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()
   }
 
-  /*
-   * onLoadDocument hook
-   */
-  async onLoadDocument(data: onLoadDocumentPayload) {
-    if (!this.persistence) {
+  async onConfigure({ instance }: onConfigurePayload) {
+    this.logger = instance.debugger
+  }
+
+  async onListen({ configuration }: onListenPayload) {
+    if (configuration.quiet) {
       return
     }
 
-    // If another connection has already loaded this doc, return this one instead
-    const binding = this.persistence.docs.get(data.documentName)
+    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}`
+  }
 
-    if (binding) {
-      return binding.doc
-    }
+  private pubKey(documentName: string) {
+    return `${this.getKey(documentName)}:${this.configuration.identifier.replace(/:/g, '')}`
+  }
 
-    await this.persistence.bindState(data.documentName, data.document).synced
+  private subKey(documentName: string) {
+    return `${this.getKey(documentName)}:*`
   }
 
-  async onConnect(data: onConnectPayload) {
-    // Bind to Redis already? Ok, no worries.
-    if (this.persistence) {
-      return
-    }
+  private lockKey(documentName: string) {
+    return `${this.getKey(documentName)}:lock`
+  }
+
+  /**
+   * Once a document is laoded, subscribe to the channel in Redis.
+   */
+  public async afterLoadDocument({ documentName, document }: afterLoadDocumentPayload) {
+    this.documents.set(documentName, document)
 
-    this.persistence = new RedisPersistence(
-      // @ts-ignore
-      this.cluster
-        ? { redisClusterOpts: this.configuration }
-        : { redisOpts: this.configuration },
+    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 => {
+        if (error) {
+          reject(error)
+          return
+        }
+
+        this.publishFirstSyncStep(documentName, document)
+        this.requestAwarenessFromOtherInstances(documentName)
+
+        resolve(undefined)
+      })
+    })
+  }
+
+  /**
+   * Publish the first sync step through Redis.
+   */
+  private async publishFirstSyncStep(documentName: string, document: Document) {
+    const syncMessage = new OutgoingMessage()
+      .createSyncMessage()
+      .writeFirstSyncStepFor(document)
+
+    return this.pub.publishBuffer(this.pubKey(documentName), Buffer.from(syncMessage.toUint8Array()))
+  }
+
+  /**
+   * Let’s ask Redis who is connected already.
+   */
+  private async requestAwarenessFromOtherInstances(documentName: string) {
+    const awarenessMessage = new OutgoingMessage()
+      .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 }: 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)
+      })
+    })
   }
 
-  async onDisconnect(data: onDisconnectPayload) {
-    // Not binded to Redis? Never mind!
-    if (!this.persistence) {
+  /**
+   * 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.
+   */
+  async onAwarenessUpdate({ documentName, awareness }: onAwarenessUpdatePayload) {
+    const message = new OutgoingMessage()
+      .createAwarenessUpdateMessage(awareness)
+
+    return this.pub.publishBuffer(
+      this.pubKey(documentName),
+      Buffer.from(message.toUint8Array()),
+    )
+  }
+
+  /**
+   * Handle incoming messages published on all 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 channelName = pattern.toString()
+    const [_, documentName, identifier] = channelName.split(':')
+    const document = this.documents.get(documentName)
+
+    if (identifier === this.configuration.identifier) {
       return
     }
 
-    // Still clients connected?
-    if (data.clientsCount > 0) {
+    if (!document) {
       return
     }
 
-    // Fine, let’s remove the binding …
-    this.persistence.destroy()
-    this.persistence = undefined
+    new MessageReceiver(
+      new IncomingMessage(data),
+      this.logger,
+    ).apply(document, undefined, reply => {
+      return this.pub.publishBuffer(
+        this.pubKey(document.name),
+        Buffer.from(reply),
+      )
+    })
+  }
 
+  /**
+   * Make sure to *not* listen for further changes, when there’s
+   * noone connected anymore.
+   */
+  public onDisconnect = async ({ documentName, clientsCount }: onDisconnectPayload) => {
+    // Do nothing, when other users are still connected to the document.
+    if (clientsCount > 0) {
+      return
+    }
+
+    // It was indeed the last connected user.
+    this.documents.delete(documentName)
+
+    // Time to end the subscription on the document channel.
+    this.sub.punsubscribe(this.subKey(documentName), error => {
+      if (error) {
+        console.error(error)
+      }
+    })
   }
 
+  /**
+   * Kill the Redlock connection immediately.
+   */
+  async onDestroy() {
+    this.redlock.quit()
+  }
 }

package/src/index.ts

@@ -1,2 +1 @@
 export * from './Redis'
-export * from './RedisCluster'

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

@@ -1,4 +0,0 @@
-import { Redis } from './Redis';
-export declare class RedisCluster extends Redis {
-    cluster: boolean;
-}

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

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

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

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

package/src/RedisCluster.ts

@@ -1,7 +0,0 @@
-import { Redis } from './Redis'
-
-export class RedisCluster extends Redis {
-
-  cluster = true
-
-}