Rewrite of the Redis extension

.eslintrc.cjs

@@ -34,10 +34,11 @@ module.exports = {
         'airbnb-base',
       ],
       rules: {
+        "max-classes-per-file": 'off',
         'no-unreachable-loop': 'off',
-        'no-promise-executor-return': 'off',
         'default-param-last': 'off',
         'vue/multi-word-component-names': 'off',
+        'no-promise-executor-return': 'off',
 
         'no-alert': 'off',
         'no-shadow': 'off',

docs/api/configuration.md

@@ -5,7 +5,7 @@ tableOfContents: true
 # Configuration
 
 ## Introduction
-There’s only two settings to pass for now: A custom port and a connection timeout. Most things are controlled through [hooks](/api/hooks).
+There are only a few settings to pass for now. Most things are controlled through [hooks](/api/hooks).
 
 ## Settings
 
@@ -20,22 +20,33 @@ Default: `80`
 ### timeout
 A connection healthcheck interval in milliseconds.
 
-Default: `30000`
+Default: `30000` (= 30s)
+
+### debounce
+Debounces the call of the `onStoreDocument` hook for the given amount of time in ms. Otherwise every single update would be persisted.
+
+Default: `2000` (= 2s)
+
+### maxDebounce
+Makes sure to call `onStoreDocument` at least in the given amount of time (ms).
+
+Default: `10000` (= 10s)
 
 ### quiet
 By default, the servers show a start screen. If passed false, the server will start quietly.
 
 Default: `false`
 
 ## Usage
-
 ```js
 import { Server } from '@hocuspocus/server'
 
 const server = Server.configure({
   name: 'hocuspocus-fra1-01',
   port: 1234,
-  timout: 30000,
+  timeout: 30000,
+  debounce: 5000,
+  maxDebounce: 30000,
   quiet: true,
 })
 

docs/api/extensions/redis.md

@@ -5,61 +5,37 @@ tableOfContents: true
 # Redis
 
 ## Introduction
-
 :::warning Work in progress
 Currently, the Redis extension only syncs document changes. Awareness states, for example cursors, are not yet supported.
 :::
 
-hocuspocus can be scaled horizontally using the Redis extension. You can spawn multiple instances of the server behind a load balancer and sync changes between the instances through Redis pub/sub.
+This extension allows horizontal scaling of Hocuspocus instances, allowing any
+client to connect to any instance and share document state between them.
 
 ## Installation
-
-Install the Redis package with:
+Install the package with:
 
 ```bash
 npm install @hocuspocus/extension-redis
 ```
 
 ## Configuration
-
-For a full documentation on all available redis and redis cluster options, check out the [ioredis API docs](https://github.com/luin/ioredis/blob/master/API.md).
-
 ```js
 import { Server } from '@hocuspocus/server'
 import { Redis } from '@hocuspocus/extension-redis'
 
 const server = Server.configure({
   extensions: [
     new Redis({
-      // [required] Hostname of your Redis instance
-      host: '127.0.0.1',
-
-      // [required] Port of your Redis instance
-      port: 6379,
-    })
+      host: process.env.REDIS_HOST,
+      port: process.env.REDIS_PORT,
+      onPersist: async ({ document }) => {
+        // Write the document to the database here.
+      }
+    }),
   ],
 })
 
 server.listen()
 ```
 
-If you want to use a cluster instead of a single Redis instance, use the Redis cluster extension:
-
-```js
-import { Server } from '@hocuspocus/server'
-import { RedisCluster } from '@hocuspocus/redis'
-
-const server = Server.configure({
-  extensions: [
-    new RedisCluster({
-      scaleReads: 'all',
-      redisOptions: {
-        host: '127.0.0.1',
-        port: 6379,
-      },
-    })
-  ],
-})
-
-server.listen()
-```

docs/api/hooks/on-awareness-update.md

@@ -0,0 +1,9 @@
+---
+tableOfContents: true
+---
+
+# onAwarenessUpdate
+
+## Introduction
+
+TODO

docs/api/hooks/on-store-document.md

@@ -0,0 +1,9 @@
+---
+tableOfContents: true
+---
+
+# onStoreDocument
+
+## Introduction
+
+TODO

docs/guide/configuration.md

@@ -5,8 +5,7 @@ tableOfContents: true
 # Configuration
 
 ## Introduction
-
-hocuspocus provides a few useful options and configuring it is as easy as calling `configure` and passing it your custom configuration:
+Hocuspocus provides a few useful options and configuring it is as easy as calling `configure` and passing it your custom configuration:
 
 ```js
 import { Server } from '@hocuspocus/server'
@@ -21,29 +20,61 @@ server.listen()
 ## List of available settings
 
 ### port
-
-hocuspocus listens on port `80`. But you're free to change it to whatever port you like:
+Hocuspocus listens on port `80`. But you're free to change it to whatever port you like:
 
 ```js
 import { Server } from '@hocuspocus/server'
 
 const server = Server.configure({
-  port: 80,
+  port: 1234,
 })
 
 server.listen()
 ```
 
+Default: `80`
+
 ### timeout
+There is a default connection timeout of `30000ms`. After this timeout non responding websocket connections are automatically terminated.
+
+```js
+import { Server } from '@hocuspocus/server'
+
+const server = Server.configure({
+  timeout: 15000,
+})
+
+server.listen()
+```
+
+Default: `30000` (= 30s)
 
-There's a default connection timeout of `30000ms`. After this timeout non responding websocket connections are automatically terminated.
+### debounce
+Debounces the call of the `onStoreDocument` hook for the given amount of time in ms. Otherwise every single update would be persisted.
 
 ```js
 import { Server } from '@hocuspocus/server'
 
 const server = Server.configure({
-  timeout: 30000,
+  debounce: 5000,
 })
 
 server.listen()
 ```
+
+Default: `2000` (= 2s)
+
+### maxDebounce
+Makes sure to call `onStoreDocument` at least in the given amount of time (ms).
+
+```js
+import { Server } from '@hocuspocus/server'
+
+const server = Server.configure({
+  maxDebounce: 30000,
+})
+
+server.listen()
+```
+
+Default: `10000` (= 10s)

docs/guide/extensions.md

@@ -16,7 +16,7 @@ We already created some very useful extensions you should check out for sure:
 
 **[@hocuspocus/extension-monitor](/api/extensions/monitor)**: A beautiful dashboard to monitor and debug your Hocuspocus instance.
 
-**[@hocuspocus/extension-redis](/api/extensions/redis)**: Scale Hocuspocus horizontally with redis.
+**[@hocuspocus/extension-redis](/api/extensions/redis)**: Scale Hocuspocus horizontally with Redis.
 
 **[@hocuspocus/extension-logger](/api/extensions/logger)**: Add logging to Hocuspocus.
 

docs/links.yaml

@@ -71,6 +71,12 @@
     - title: Hooks
       link: /api/hooks
       items:
+        - title: onConfigure
+          link: /api/hooks/on-configure
+        - title: onListen
+          link: /api/hooks/on-listen
+        - title: onUpgrade
+          link: /api/hooks/on-upgrade
         - title: onConnect
           link: /api/hooks/on-connect
         - title: onAuthenticate
@@ -79,18 +85,16 @@
           link: /api/hooks/on-load-document
         - title: onChange
           link: /api/hooks/on-change
+        - title: onStoreDocument
+          link: /api/hooks/on-store-document
+        - title: onAwarenessUpdate
+          link: /api/hooks/on-awareness-update
+        - title: onRequest
+          link: /api/hooks/on-request
         - title: onDisconnect
           link: /api/hooks/on-disconnect
-        - title: onListen
-          link: /api/hooks/on-listen
         - title: onDestroy
           link: /api/hooks/on-destroy
-        - title: onConfigure
-          link: /api/hooks/on-configure
-        - title: onRequest
-          link: /api/hooks/on-request
-        - title: onUpgrade
-          link: /api/hooks/on-upgrade
 
     - title: Extensions
       link: /api/extensions