@hocuspocus/extension-redis - npm Package Compare versions

Comparing version 1.1.0 to 2.0.0-alpha.0

dist/hocuspocus-redis.esm.js

 import RedisClient from 'ioredis';
 import Redlock from 'redlock';
 import { v4 } from 'uuid';
-import { MessageReceiver, IncomingMessage, Debugger, OutgoingMessage } from '@hocuspocus/server';
+import { IncomingMessage, MessageReceiver, Debugger, OutgoingMessage } from '@hocuspocus/server';
 import kleur from 'kleur';
@@ -30,2 +30,6 @@
         this.handleIncomingMessage = async (channel, pattern, data) => {
+            const message = new IncomingMessage(data);
+            // we don't need the documentName from the message, we are just taking it from the redis channelName.
+            // we have to immediately write it back to the encoder though, to make sure the structure of the message is correct
+            message.writeVarString(message.readVarString());
             const channelName = pattern.toString();
@@ -40,3 +44,3 @@ const [_, documentName, identifier] = channelName.split(':');
             }
-            new MessageReceiver(new IncomingMessage(data), this.logger).apply(document, undefined, reply => {
+            new MessageReceiver(message, this.logger).apply(document, undefined, reply => {
                 return this.pub.publishBuffer(this.pubKey(document.name), Buffer.from(reply));
@@ -135,3 +139,3 @@ });
     async publishFirstSyncStep(documentName, document) {
-        const syncMessage = new OutgoingMessage()
+        const syncMessage = new OutgoingMessage(documentName)
             .createSyncMessage()
@@ -145,3 +149,3 @@ .writeFirstSyncStepFor(document);
     async requestAwarenessFromOtherInstances(documentName) {
-        const awarenessMessage = new OutgoingMessage()
+        const awarenessMessage = new OutgoingMessage(documentName)
             .writeQueryAwareness();
@@ -187,3 +191,3 @@ return this.pub.publishBuffer(this.pubKey(documentName), Buffer.from(awarenessMessage.toUint8Array()));
         const changedClients = added.concat(updated, removed);
-        const message = new OutgoingMessage()
+        const message = new OutgoingMessage(documentName)
             .createAwarenessUpdateMessage(awareness, changedClients);
@@ -199,3 +203,3 @@ return this.pub.publishBuffer(this.pubKey(documentName), Buffer.from(message.toUint8Array()));
     async beforeBroadcastStateless(data) {
-        const message = new OutgoingMessage()
+        const message = new OutgoingMessage(data.documentName)
             .writeBroadcastStateless(data.payload);
@@ -202,0 +206,0 @@ return this.pub.publishBuffer(this.pubKey(data.documentName), Buffer.from(message.toUint8Array()));

dist/packages/extension-monitor/src/Dashboard.d.ts

 /// <reference types="node" />
 import { IncomingMessage, ServerResponse } from 'http';
+import { Socket } from 'net';
 import WebSocket, { WebSocketServer } from 'ws';
-import { Socket } from 'net';
 import { Storage } from './Storage';
@@ -6,0 +6,0 @@ export interface Configuration {

dist/packages/extension-monitor/src/index.d.ts

 /// <reference types="node" />
+import { IncomingMessage, ServerResponse } from 'http';
 import { Extension, onChangePayload, onConfigurePayload, onLoadDocumentPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload, connectedPayload } from '@hocuspocus/server';
-import { IncomingMessage, ServerResponse } from 'http';
 import WebSocket from 'ws';
@@ -5,0 +5,0 @@ import { Storage } from './Storage';

dist/packages/provider/src/HocuspocusCloudProvider.d.ts

 import { HocuspocusProvider, HocuspocusProviderConfiguration } from './HocuspocusProvider';
-export declare type HocuspocusCloudProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & AdditionalHocuspocusCloudProviderConfiguration;
+import { HocuspocusProviderWebsocketConfiguration } from './HocuspocusProviderWebsocket';
+export declare type HocuspocusCloudProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & Partial<Pick<HocuspocusProviderWebsocketConfiguration, 'url'>> & AdditionalHocuspocusCloudProviderConfiguration;
 export interface AdditionalHocuspocusCloudProviderConfiguration {
@@ -4,0 +5,0 @@ /**

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

 import * as Y from 'yjs';
 import { Awareness } from 'y-protocols/awareness';
 import * as mutex from 'lib0/mutex';
-import type { Event, CloseEvent, MessageEvent } from 'ws';
+import type { CloseEvent, Event, MessageEvent } from 'ws';
 import EventEmitter from './EventEmitter';
 import { ConstructableOutgoingMessage, onAuthenticationFailedParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onStatusParameters, onSyncedParameters, WebSocketStatus } from './types';
+import { HocuspocusProviderWebsocket } from './HocuspocusProviderWebsocket';
 import { onAwarenessChangeParameters, onAwarenessUpdateParameters } from '.';
-export declare type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, 'url' | 'name'>> & Partial<CompleteHocuspocusProviderConfiguration>;
+export declare type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, 'name' | 'websocketProvider'>> & Partial<CompleteHocuspocusProviderConfiguration>;
 export interface CompleteHocuspocusProviderConfiguration {
     /**
-     * URL of your @hocuspocus/server instance
-     */
-    url: string;
-    /**
      * The identifier/name of your document
@@ -23,6 +20,2 @@ */
     /**
-     * Pass `false` to start the connection manually.
-     */
-    connect: boolean;
-    /**
      * Pass false to disable broadcasting between browser tabs.
@@ -46,5 +39,5 @@ */
     /**
-     * An optional WebSocket polyfill, for example for Node.js
+     * Hocuspocus websocket provider
      */
-    WebSocketPolyfill: any;
+    websocketProvider: HocuspocusProviderWebsocket;
     /**
@@ -54,38 +47,2 @@ * Force syncing the document in the defined interval.
     forceSyncInterval: false | number;
-    /**
-     * Disconnect when no message is received for the defined amount of milliseconds.
-     */
-    messageReconnectTimeout: number;
-    /**
-     * The delay between each attempt in milliseconds. You can provide a factor to have the delay grow exponentially.
-     */
-    delay: number;
-    /**
-     * The intialDelay is the amount of time to wait before making the first attempt. This option should typically be 0 since you typically want the first attempt to happen immediately.
-     */
-    initialDelay: number;
-    /**
-     * The factor option is used to grow the delay exponentially.
-     */
-    factor: number;
-    /**
-     * The maximum number of attempts or 0 if there is no limit on number of attempts.
-     */
-    maxAttempts: number;
-    /**
-     * minDelay is used to set a lower bound of delay when jitter is enabled. This property has no effect if jitter is disabled.
-     */
-    minDelay: number;
-    /**
-     * The maxDelay option is used to set an upper bound for the delay when factor is enabled. A value of 0 can be provided if there should be no upper bound when calculating delay.
-     */
-    maxDelay: number;
-    /**
-     * If jitter is true then the calculated delay will be a random integer value between minDelay and the calculated delay for the current iteration.
-     */
-    jitter: boolean;
-    /**
-     * A timeout in milliseconds. If timeout is non-zero then a timer is set using setTimeout. If the timeout is triggered then future attempts will be aborted.
-     */
-    timeout: number;
     onAuthenticated: () => void;
@@ -113,28 +70,14 @@ onAuthenticationFailed: (data: onAuthenticationFailedParameters) => void;
     subscribedToBroadcastChannel: boolean;
-    webSocket: WebSocket | null;
-    shouldConnect: boolean;
-    status: WebSocketStatus;
     isSynced: boolean;
     unsyncedChanges: number;
+    status: WebSocketStatus;
     isAuthenticated: boolean;
-    lastMessageReceived: number;
     mux: mutex.mutex;
     intervals: any;
-    connectionAttempt: {
-        resolve: (value?: any) => void;
-        reject: (reason?: any) => void;
-    } | null;
     constructor(configuration: HocuspocusProviderConfiguration);
+    onStatus({ status }: onStatusParameters): void;
     setConfiguration(configuration?: Partial<HocuspocusProviderConfiguration>): void;
-    boundConnect: () => Promise<unknown>;
-    cancelWebsocketRetry?: () => void;
-    connect(): Promise<unknown>;
-    createWebSocketConnection(): Promise<unknown>;
-    resolveConnectionAttempt(): void;
-    stopConnectionAttempt(): void;
-    rejectConnectionAttempt(): void;
     get document(): Y.Doc;
     get awareness(): Awareness;
     get hasUnsyncedChanges(): boolean;
-    checkConnection(): void;
     forceSync(): void;
@@ -147,6 +90,2 @@ boundBeforeUnload: () => void;
     awarenessUpdateHandler({ added, updated, removed }: any, origin: any): void;
-    permissionDeniedHandler(reason: string): void;
-    authenticatedHandler(): void;
-    get serverUrl(): string;
-    get url(): string;
     get synced(): boolean;
@@ -160,6 +99,8 @@ set synced(state: boolean);
     startSync(): void;
-    send(Message: ConstructableOutgoingMessage, args: any, broadcast?: boolean): void;
+    send(message: ConstructableOutgoingMessage, args: any, broadcast?: boolean): void;
     onMessage(event: MessageEvent): void;
     onClose(event: CloseEvent): void;
     destroy(): void;
+    permissionDeniedHandler(reason: string): void;
+    authenticatedHandler(): void;
     get broadcastChannel(): string;
@@ -166,0 +107,0 @@ boundBroadcastChannelSubscriber: (data: ArrayBuffer) => void;

dist/packages/provider/src/IncomingMessage.d.ts

@@ -10,6 +10,8 @@ import { Decoder } from 'lib0/decoding';
     readVarUint(): MessageType;
+    readVarString(): string;
     readVarUint8Array(): Uint8Array;
     writeVarUint(type: MessageType): void;
+    writeVarString(string: string): void;
     writeVarUint8Array(data: Uint8Array): void;
     length(): number;
 }

dist/packages/provider/src/index.d.ts

 export * from './HocuspocusProvider';
 export * from './HocuspocusCloudProvider';
+export * from './HocuspocusProviderWebsocket';
 export * from './types';

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

@@ -30,2 +30,3 @@ import { Awareness } from 'y-protocols/awareness';
 export interface OutgoingMessageArguments {
+    documentName: string;
     token: string;
@@ -32,0 +33,0 @@ document: Y.Doc;

dist/packages/server/src/Connection.d.ts

 /// <reference types="node" />
+import { IncomingMessage as HTTPIncomingMessage } from 'http';
 import AsyncLock from 'async-lock';
 import WebSocket from 'ws';
-import { IncomingMessage as HTTPIncomingMessage } from 'http';
 import { CloseEvent } from '@hocuspocus/common';
@@ -65,13 +65,3 @@ import Document from './Document';
     private handleMessage;
-    /**
-     * Get the underlying connection instance
-     * @deprecated
-     */
-    get instance(): WebSocket;
-    /**
-     * Get the underlying connection instance
-     * @deprecated
-     */
-    get connection(): WebSocket;
 }
 export default Connection;

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

 /// <reference types="node" />
+import { IncomingMessage, Server as HTTPServer } from 'http';
 import WebSocket, { AddressInfo, WebSocketServer } from 'ws';
-import { IncomingMessage, Server as HTTPServer } from 'http';
-import { Configuration, HookName, HookPayload } from './types';
+import { Configuration, HookName, HookPayload, onListenPayload } from './types';
 import Document from './Document';
 import { Debugger } from './Debugger';
-import { onListenPayload } from '.';
 export declare const defaultConfiguration: {
@@ -71,3 +70,3 @@ name: null;
      */
-    handleConnection(incoming: WebSocket, request: IncomingMessage, documentName: string, context?: any): void;
+    handleConnection(incoming: WebSocket, request: IncomingMessage, context?: any): void;
     /**
@@ -102,6 +101,2 @@ * Handle update of the given document
     private static getParameters;
-    /**
-     * Get document name by the given request
-     */
-    private getDocumentNameFromRequest;
     enableDebugging(): void;
@@ -108,0 +103,0 @@ enableMessageLogging(): void;

dist/packages/server/src/IncomingMessage.d.ts

@@ -19,3 +19,4 @@ import { Decoder } from 'lib0/decoding';
     writeVarUint(type: MessageType): void;
+    writeVarString(string: string): void;
     get length(): number;
 }

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

@@ -1,2 +0,1 @@
-import { Awareness } from 'y-protocols/awareness';
 import Connection from './Connection';
@@ -12,3 +11,3 @@ import { IncomingMessage } from './IncomingMessage';
     readSyncMessage(message: IncomingMessage, document: Document, connection?: Connection, reply?: (message: Uint8Array) => void, requestFirstSync?: boolean): 0 | 2 | 1;
-    applyQueryAwarenessMessage(awareness: Awareness, reply?: (message: Uint8Array) => void): void;
+    applyQueryAwarenessMessage(document: Document, reply?: (message: Uint8Array) => void): void;
 }

dist/packages/server/src/OutgoingMessage.d.ts

@@ -8,3 +8,3 @@ import { Encoder } from 'lib0/encoding';
     category?: string;
-    constructor();
+    constructor(documentName: string);
     createSyncMessage(): OutgoingMessage;
@@ -11,0 +11,0 @@ createSyncReplyMessage(): OutgoingMessage;

dist/tests/utils/index.d.ts

@@ -5,2 +5,3 @@ export * from './createDirectory';
 export * from './newHocuspocusProvider';
+export * from './newHocuspocusProviderWebsocket';
 export * from './randomInteger';
@@ -7,0 +8,0 @@ export * from './redisConnectionSettings';

dist/tests/utils/newHocuspocusProvider.d.ts

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

package.json

 {
   "name": "@hocuspocus/extension-redis",
-  "version": "1.1.0",
+  "version": "2.0.0-alpha.0",
   "description": "Scale Hocuspocus horizontally with Redis",
@@ -35,3 +35,3 @@ "homepage": "https://hocuspocus.dev",
   "dependencies": {
-    "@hocuspocus/server": "^1.1.0",
+    "@hocuspocus/server": "^2.0.0-alpha.0",
     "ioredis": "^4.28.2",
@@ -38,0 +38,0 @@ "kleur": "^4.1.4",

src/Redis.ts

@@ -188,3 +188,3 @@ import RedisClient, { ClusterNode, ClusterOptions, RedisOptions } from 'ioredis'
   private async publishFirstSyncStep(documentName: string, document: Document) {
-    const syncMessage = new OutgoingMessage()
+    const syncMessage = new OutgoingMessage(documentName)
       .createSyncMessage()
@@ -200,3 +200,3 @@ .writeFirstSyncStepFor(document)
   private async requestAwarenessFromOtherInstances(documentName: string) {
-    const awarenessMessage = new OutgoingMessage()
+    const awarenessMessage = new OutgoingMessage(documentName)
       .writeQueryAwareness()
@@ -254,3 +254,3 @@
     const changedClients = added.concat(updated, removed)
-    const message = new OutgoingMessage()
+    const message = new OutgoingMessage(documentName)
       .createAwarenessUpdateMessage(awareness, changedClients)
@@ -270,2 +270,7 @@
   private handleIncomingMessage = async (channel: Buffer, pattern: Buffer, data: Buffer) => {
+    const message = new IncomingMessage(data)
+    // we don't need the documentName from the message, we are just taking it from the redis channelName.
+    // we have to immediately write it back to the encoder though, to make sure the structure of the message is correct
+    message.writeVarString(message.readVarString())
+
     const channelName = pattern.toString()
@@ -284,3 +289,3 @@ const [_, documentName, identifier] = channelName.split(':')
     new MessageReceiver(
-      new IncomingMessage(data),
+      message,
       this.logger,
@@ -324,3 +329,3 @@ ).apply(document, undefined, reply => {
   async beforeBroadcastStateless(data: beforeBroadcastStatelessPayload) {
-    const message = new OutgoingMessage()
+    const message = new OutgoingMessage(data.documentName)
       .writeBroadcastStateless(data.payload)
@@ -327,0 +332,0 @@

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

122421

increased by4.44%

Number of package files

125

increased by0.81%

Lines of code

2401

increased by2.65%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

Dependency changes

• + Added@hocuspocus/common@2.15.2(transitive)

• + Added@hocuspocus/server@2.15.2(transitive)

• + Addeduuid@11.0.5(transitive)

• - Removed@hocuspocus/common@1.1.3(transitive)

• - Removed@hocuspocus/server@1.1.3(transitive)

• - Removed@types/async-lock@1.4.2(transitive)

• - Removed@types/node@22.13.1(transitive)

• - Removed@types/uuid@9.0.8(transitive)

• - Removed@types/ws@8.5.14(transitive)

• - Removedundici-types@6.20.0(transitive)

• Updated@hocuspocus/server@^2.0.0-alpha.0