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

package/dist/playground/frontend/vite.config.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("vite").UserConfigExport;
-export default _default;
+declare const _default: import("vite").UserConfigExport;
+export default _default;

package/dist/tests/extension-database/fetch.d.ts

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

package/dist/tests/extension-logger/onListen.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/dist/tests/extension-throttle/banning.d.ts

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

package/dist/tests/extension-throttle/configuration.d.ts

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

package/dist/tests/provider/observe.d.ts

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

package/dist/tests/provider/observeDeep.d.ts

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

package/dist/tests/provider/onAuthenticated.d.ts

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

package/dist/tests/provider/onAuthenticationFailed.d.ts

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

package/dist/tests/provider/onAwarenessChange.d.ts

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

package/dist/tests/provider/onAwarenessUpdate.d.ts

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

package/dist/tests/provider/onClose.d.ts

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

package/dist/tests/provider/onConnect.d.ts

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

package/dist/tests/provider/onDisconnect.d.ts

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

package/dist/tests/provider/onMessage.d.ts

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

package/dist/tests/provider/onOpen.d.ts

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

package/dist/tests/provider/onStateless.d.ts

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

package/dist/tests/provider/onSynced.d.ts

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

package/dist/tests/providerwebsocket/configuration.d.ts

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

package/dist/tests/server/address.d.ts

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

package/dist/tests/server/afterStoreDocument.d.ts

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

package/dist/tests/server/beforeBroadcastStateless.d.ts

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

package/dist/tests/server/beforeHandleMessage.d.ts

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

package/dist/tests/server/closeConnections.d.ts

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

package/dist/tests/server/getConnectionsCount.d.ts

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

package/dist/tests/server/getDocumentsCount.d.ts

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

package/dist/tests/server/getMessageLogs.d.ts

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

package/dist/tests/server/listen.d.ts

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

package/dist/tests/server/onAuthenticate.d.ts

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

package/dist/tests/server/onAwarenessUpdate.d.ts

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

package/dist/tests/server/onChange.d.ts

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

package/dist/tests/server/onClose.d.ts

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

package/dist/tests/server/onConfigure.d.ts

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

package/dist/tests/server/onConnect.d.ts

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

package/dist/tests/server/onDestroy.d.ts

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

package/dist/tests/server/onDisconnect.d.ts

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

package/dist/tests/server/onListen.d.ts

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

package/dist/tests/server/onLoadDocument.d.ts

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

package/dist/tests/server/onRequest.d.ts

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

package/dist/tests/server/onStateless.d.ts

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

package/dist/tests/server/onStoreDocument.d.ts

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

package/dist/tests/server/onUpgrade.d.ts

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

package/dist/tests/server/openDirectConnection.d.ts

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

package/dist/tests/server/requiresAuthentication.d.ts

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

package/dist/tests/server/websocketError.d.ts

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

package/dist/tests/transformer/TiptapTransformer.d.ts

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

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

@@ -1 +1 @@
-export declare const createDirectory: (dir: string) => void;
+export declare const createDirectory: (dir: string) => void;

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

@@ -1 +1 @@
-export declare const flushRedis: () => Promise<string>;
+export declare const flushRedis: () => Promise<string>;

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

@@ -1,9 +1,9 @@
-export * from './createDirectory';
-export * from './flushRedis';
-export * from './newHocuspocus';
-export * from './newHocuspocusProvider';
-export * from './newHocuspocusProviderWebsocket';
-export * from './randomInteger';
-export * from './redisConnectionSettings';
-export * from './removeDirectory';
-export * from './sleep';
+export * from './createDirectory.js';
+export * from './flushRedis.js';
+export * from './newHocuspocus.js';
+export * from './newHocuspocusProvider.js';
+export * from './newHocuspocusProviderWebsocket.js';
+export * from './randomInteger.js';
+export * from './redisConnectionSettings.js';
+export * from './removeDirectory.js';
+export * from './sleep.js';

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

@@ -1,2 +1,2 @@
-import { Hocuspocus, Configuration } from '@hocuspocus/server';
-export declare const newHocuspocus: (options?: Partial<Configuration>) => Promise<Hocuspocus>;
+import { Hocuspocus, Configuration } from '@hocuspocus/server';
+export declare const newHocuspocus: (options?: Partial<Configuration>) => Promise<Hocuspocus>;

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

@@ -1,3 +1,3 @@
-import { HocuspocusProvider, HocuspocusProviderConfiguration, HocuspocusProviderWebsocketConfiguration } from '@hocuspocus/provider';
-import { Hocuspocus } from '@hocuspocus/server';
-export declare const newHocuspocusProvider: (server: Hocuspocus, options?: Partial<HocuspocusProviderConfiguration>, websocketOptions?: Partial<HocuspocusProviderWebsocketConfiguration>) => HocuspocusProvider;
+import { HocuspocusProvider, HocuspocusProviderConfiguration, HocuspocusProviderWebsocketConfiguration } from '@hocuspocus/provider';
+import { Hocuspocus } from '@hocuspocus/server';
+export declare const newHocuspocusProvider: (server: Hocuspocus, options?: Partial<HocuspocusProviderConfiguration>, websocketOptions?: Partial<HocuspocusProviderWebsocketConfiguration>) => HocuspocusProvider;

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

@@ -1,3 +1,3 @@
-import { HocuspocusProviderWebsocket, HocuspocusProviderWebsocketConfiguration } from '@hocuspocus/provider';
-import { Hocuspocus } from '@hocuspocus/server';
-export declare const newHocuspocusProviderWebsocket: (server: Hocuspocus, options?: Partial<Omit<HocuspocusProviderWebsocketConfiguration, 'url'>>) => HocuspocusProviderWebsocket;
+import { HocuspocusProviderWebsocket, HocuspocusProviderWebsocketConfiguration } from '@hocuspocus/provider';
+import { Hocuspocus } from '@hocuspocus/server';
+export declare const newHocuspocusProviderWebsocket: (server: Hocuspocus, options?: Partial<Omit<HocuspocusProviderWebsocketConfiguration, 'url'>>) => HocuspocusProviderWebsocket;

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

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

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

@@ -1,4 +1,4 @@
-export declare const redisConnectionSettings: {
-    host: string;
-    port: number;
-};
+export declare const redisConnectionSettings: {
+    host: string;
+    port: number;
+};

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

@@ -1 +1 @@
-export declare const removeDirectory: (dir: string) => void;
+export declare const removeDirectory: (dir: string) => void;

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

@@ -1,2 +1,2 @@
-import { ExecutionContext } from 'ava';
-export declare const retryableAssertion: (t: ExecutionContext, recoverableTry: (tt: ExecutionContext) => void) => Promise<void>;
+import { ExecutionContext } from 'ava';
+export declare const retryableAssertion: (t: ExecutionContext, recoverableTry: (tt: ExecutionContext) => void) => Promise<void>;

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

@@ -1 +1 @@
-export declare const sleep: (time: number) => Promise<unknown>;
+export declare const sleep: (time: number) => Promise<unknown>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/extension-redis",
-  "version": "2.1.0-alpha.0",
+  "version": "2.2.0",
   "description": "Scale Hocuspocus horizontally with Redis",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -19,7 +19,8 @@
     },
     "default": {
       "import": "./dist/hocuspocus-redis.esm.js",
-      "require": "./dist/hocuspocus-redis.cjs"
+      "require": "./dist/hocuspocus-redis.cjs",
+      "types": "./dist/packages/extension-redis/src/index.d.ts"
     }
   },
   "files": [
@@ -27,13 +28,16 @@
     "dist"
   ],
   "devDependencies": {
-    "@types/lodash.debounce": "^4.0.6"
+    "@types/ioredis": "^4.28.7",
+    "@types/lodash.debounce": "^4.0.6",
+    "@types/redlock": "^4.0.3"
   },
   "dependencies": {
-    "@hocuspocus/server": "^2.1.0-alpha.0",
-    "ioredis": "^5.0.4",
+    "@hocuspocus/server": "^2.2.0",
+    "ioredis": "^4.28.2",
     "kleur": "^4.1.4",
     "lodash.debounce": "^4.0.8",
+    "redlock": "^4.2.0",
     "uuid": "^9.0.0"
   },
   "peerDependencies": {

package/src/Redis.ts

@@ -1,6 +1,5 @@
-import RedisClient, {
-  ClusterNode, ClusterOptions, RedisOptions, Cluster as RedisClusterClient,
-} from 'ioredis'
+import RedisClient, { ClusterNode, ClusterOptions, RedisOptions } from 'ioredis'
+import Redlock from 'redlock'
 import { v4 as uuid } from 'uuid'
 import {
   IncomingMessage,
@@ -8,7 +7,9 @@ import {
   Document,
   Extension,
   afterLoadDocumentPayload,
+  afterStoreDocumentPayload,
   onDisconnectPayload,
+  onStoreDocumentPayload,
   onAwarenessUpdatePayload,
   onChangePayload,
   MessageReceiver,
@@ -17,7 +18,7 @@ import {
   beforeBroadcastStatelessPayload, Hocuspocus,
 } from '@hocuspocus/server'
 
-export type RedisInstance = RedisClient | RedisClusterClient
+export type RedisInstance = RedisClient.Cluster | RedisClient.Redis
 
 export interface Configuration {
   /**
@@ -55,6 +56,10 @@ 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.
@@ -75,6 +80,7 @@ export class Redis implements Extension {
     host: '127.0.0.1',
     prefix: 'hocuspocus',
     identifier: `host-${uuid()}`,
+    lockTimeout: 1000,
     disconnectDelay: 1000,
   }
 
@@ -84,6 +90,10 @@ export class Redis implements Extension {
 
   instance!: Hocuspocus
 
+  redlock: Redlock
+
+  locks = new Map<string, Redlock.Lock>()
+
   logger: Debugger
 
   public constructor(configuration: Partial<Configuration>) {
@@ -92,6 +102,9 @@ 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,
@@ -112,13 +125,12 @@ 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 as RedisOptions)
-      this.sub = new RedisClient(port, host, options as RedisOptions)
+      this.pub = new RedisClient(port, host, options)
+      this.sub = new RedisClient(port, host, options)
     }
     this.sub.on('pmessageBuffer', this.handleIncomingMessage)
 
-    // We’ll replace that in the onConfigure hook with the global instance.
-    this.logger = new Debugger()
+    this.redlock = new Redlock([this.pub])
   }
 
   async onConfigure({ instance }: onConfigurePayload) {
@@ -138,6 +150,10 @@ 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.
    */
@@ -167,7 +183,7 @@ export class Redis implements Extension {
       .createSyncMessage()
       .writeFirstSyncStepFor(document)
 
-    return this.pub.publish(this.pubKey(documentName), Buffer.from(syncMessage.toUint8Array()))
+    return this.pub.publishBuffer(this.pubKey(documentName), Buffer.from(syncMessage.toUint8Array()))
   }
 
   /**
@@ -177,12 +193,49 @@ export class Redis implements Extension {
     const awarenessMessage = new OutgoingMessage(documentName)
       .writeQueryAwareness()
 
-    return this.pub.publish(
+    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)
+      })
+    })
+  }
+
+  /**
+   * 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.
    */
@@ -193,7 +246,7 @@ export class Redis implements Extension {
     const message = new OutgoingMessage(documentName)
       .createAwarenessUpdateMessage(awareness, changedClients)
 
-    return this.pub.publish(
+    return this.pub.publishBuffer(
       this.pubKey(documentName),
       Buffer.from(message.toUint8Array()),
     )
@@ -226,7 +279,7 @@ export class Redis implements Extension {
       message,
       this.logger,
     ).apply(document, undefined, reply => {
-      return this.pub.publish(
+      return this.pub.publishBuffer(
         this.pubKey(document.name),
         Buffer.from(reply),
       )
@@ -268,10 +321,18 @@ export class Redis implements Extension {
     const message = new OutgoingMessage(data.documentName)
       .writeBroadcastStateless(data.payload)
 
-    return this.pub.publish(
+    return this.pub.publishBuffer(
       this.pubKey(data.documentName),
       Buffer.from(message.toUint8Array()),
     )
   }
 
+  /**
+   * Kill the Redlock connection immediately.
+   */
+  async onDestroy() {
+    await this.redlock.quit()
+    this.pub.disconnect(false)
+    this.sub.disconnect(false)
+  }
 }

package/src/index.ts

@@ -1 +1 @@
-export * from './Redis'
+export * from './Redis.js'