feat: sync client versioning (#5645)

after this pr, server will only accept client that have some major version
the client version <0.12 will be rejected by the server, >= 0.12 can receive outdated messages and notify users

packages/backend/server/src/config/affine.env.ts

@@ -34,4 +34,8 @@ AFFiNE.ENV_MAP = {
   STRIPE_API_KEY: 'plugins.payment.stripe.keys.APIKey',
   STRIPE_WEBHOOK_KEY: 'plugins.payment.stripe.keys.webhookKey',
   FEATURES_EARLY_ACCESS_PREVIEW: ['featureFlags.earlyAccessPreview', 'boolean'],
+  FEATURES_SYNC_CLIENT_VERSION_CHECK: [
+    'featureFlags.syncClientVersionCheck',
+    'boolean',
+  ],
 };

packages/backend/server/src/core/sync/events/error.ts

@@ -1,4 +1,4 @@
-enum EventErrorCode {
+export enum EventErrorCode {
   WORKSPACE_NOT_FOUND = 'WORKSPACE_NOT_FOUND',
   DOC_NOT_FOUND = 'DOC_NOT_FOUND',
   NOT_IN_WORKSPACE = 'NOT_IN_WORKSPACE',

packages/backend/server/src/core/sync/events/events.gateway.ts

@@ -22,6 +22,7 @@ import {
   AccessDeniedError,
   DocNotFoundError,
   EventError,
+  EventErrorCode,
   InternalError,
   NotInWorkspaceError,
 } from './error';
@@ -112,13 +113,42 @@ export class EventsGateway implements OnGatewayConnection, OnGatewayDisconnect {
     metrics.socketio.gauge('realtime_connections').record(this.connectionCount);
   }
 
+  checkVersion(client: Socket, version?: string) {
+    if (
+      // @todo(@darkskygit): remove this flag after 0.12 goes stable
+      AFFiNE.featureFlags.syncClientVersionCheck &&
+      version !== AFFiNE.version
+    ) {
+      client.emit('server-version-rejected', {
+        currentVersion: version,
+        requiredVersion: AFFiNE.version,
+        reason: `Client version${
+          version ? ` ${version}` : ''
+        } is outdated, please update to ${AFFiNE.version}`,
+      });
+      return {
+        error: new EventError(
+          EventErrorCode.VERSION_REJECTED,
+          `Client version ${version} is outdated, please update to ${AFFiNE.version}`
+        ),
+      };
+    }
+    return null;
+  }
+
   @Auth()
   @SubscribeMessage('client-handshake-sync')
   async handleClientHandshakeSync(
     @CurrentUser() user: UserType,
-    @MessageBody() workspaceId: string,
+    @MessageBody('workspaceId') workspaceId: string,
+    @MessageBody('version') version: string | undefined,
     @ConnectedSocket() client: Socket
   ): Promise<EventResponse<{ clientId: string }>> {
+    const versionError = this.checkVersion(client, version);
+    if (versionError) {
+      return versionError;
+    }
+
     const canWrite = await this.permissions.tryCheckWorkspace(
       workspaceId,
       user.id,
@@ -143,9 +173,15 @@ export class EventsGateway implements OnGatewayConnection, OnGatewayDisconnect {
   @SubscribeMessage('client-handshake-awareness')
   async handleClientHandshakeAwareness(
     @CurrentUser() user: UserType,
-    @MessageBody() workspaceId: string,
+    @MessageBody('workspaceId') workspaceId: string,
+    @MessageBody('version') version: string | undefined,
     @ConnectedSocket() client: Socket
   ): Promise<EventResponse<{ clientId: string }>> {
+    const versionError = this.checkVersion(client, version);
+    if (versionError) {
+      return versionError;
+    }
+
     const canWrite = await this.permissions.tryCheckWorkspace(
       workspaceId,
       user.id,
@@ -172,29 +208,17 @@ export class EventsGateway implements OnGatewayConnection, OnGatewayDisconnect {
   @Auth()
   @SubscribeMessage('client-handshake')
   async handleClientHandShake(
-    @CurrentUser() user: UserType,
-    @MessageBody()
-    workspaceId: string,
+    @MessageBody() workspaceId: string,
     @ConnectedSocket() client: Socket
   ): Promise<EventResponse<{ clientId: string }>> {
-    const canWrite = await this.permissions.tryCheckWorkspace(
-      workspaceId,
-      user.id,
-      Permission.Write
-    );
-
-    if (canWrite) {
-      await client.join([`${workspaceId}:sync`, `${workspaceId}:awareness`]);
-      return {
-        data: {
-          clientId: client.id,
-        },
-      };
-    } else {
-      return {
-        error: new AccessDeniedError(workspaceId),
-      };
+    const versionError = this.checkVersion(client);
+    if (versionError) {
+      return versionError;
     }
+    // should unreachable
+    return {
+      error: new AccessDeniedError(workspaceId),
+    };
   }
 
   @SubscribeMessage('client-leave-sync')
@@ -227,118 +251,6 @@ export class EventsGateway implements OnGatewayConnection, OnGatewayDisconnect {
     }
   }
 
-  /**
-   * @deprecated use `client-leave-sync` and `client-leave-awareness` instead
-   */
-  @SubscribeMessage('client-leave')
-  async handleClientLeave(
-    @MessageBody() workspaceId: string,
-    @ConnectedSocket() client: Socket
-  ): Promise<EventResponse> {
-    if (client.rooms.has(`${workspaceId}:sync`)) {
-      await client.leave(`${workspaceId}:sync`);
-    }
-    if (client.rooms.has(`${workspaceId}:awareness`)) {
-      await client.leave(`${workspaceId}:awareness`);
-    }
-    return {};
-  }
-
-  /**
-   * This is the old version of the `client-update` event without any data protocol.
-   * It only exists for backwards compatibility to adapt older clients.
-   *
-   * @deprecated
-   */
-  @SubscribeMessage('client-update')
-  async handleClientUpdateV1(
-    @MessageBody()
-    {
-      workspaceId,
-      guid,
-      update,
-    }: {
-      workspaceId: string;
-      guid: string;
-      update: string;
-    },
-    @ConnectedSocket() client: Socket
-  ) {
-    if (!client.rooms.has(`${workspaceId}:sync`)) {
-      this.logger.verbose(
-        `Client ${client.id} tried to push update to workspace ${workspaceId} without joining it first`
-      );
-      return;
-    }
-
-    const docId = new DocID(guid, workspaceId);
-
-    client
-      .to(`${docId.workspace}:sync`)
-      .emit('server-update', { workspaceId, guid, update });
-
-    // broadcast to all clients with newer version that only listen to `server-updates`
-    client
-      .to(`${docId.workspace}:sync`)
-      .emit('server-updates', { workspaceId, guid, updates: [update] });
-
-    const buf = Buffer.from(update, 'base64');
-    await this.docManager.push(docId.workspace, docId.guid, buf);
-  }
-
-  /**
-   * This is the old version of the `doc-load` event without any data protocol.
-   * It only exists for backwards compatibility to adapt older clients.
-   *
-   * @deprecated
-   */
-  @Auth()
-  @SubscribeMessage('doc-load')
-  async loadDocV1(
-    @ConnectedSocket() client: Socket,
-    @CurrentUser() user: UserType,
-    @MessageBody()
-    {
-      workspaceId,
-      guid,
-      stateVector,
-    }: {
-      workspaceId: string;
-      guid: string;
-      stateVector?: string;
-    }
-  ): Promise<{ missing: string; state?: string } | false> {
-    if (!client.rooms.has(`${workspaceId}:sync`)) {
-      const canRead = await this.permissions.tryCheckWorkspace(
-        workspaceId,
-        user.id
-      );
-      if (!canRead) {
-        return false;
-      }
-    }
-
-    const docId = new DocID(guid, workspaceId);
-    const doc = await this.docManager.get(docId.workspace, docId.guid);
-
-    if (!doc) {
-      return false;
-    }
-
-    const missing = Buffer.from(
-      encodeStateAsUpdate(
-        doc,
-        stateVector ? Buffer.from(stateVector, 'base64') : undefined
-      )
-    ).toString('base64');
-    const state = Buffer.from(encodeStateVector(doc)).toString('base64');
-
-    return {
-      missing,
-      state,
-    };
-  }
-
   @SubscribeMessage('client-update-v2')
   async handleClientUpdateV2(
     @MessageBody()

packages/backend/server/src/fundamentals/config/def.ts

@@ -173,6 +173,7 @@ export interface AFFiNEConfig {
    */
   featureFlags: {
     earlyAccessPreview: boolean;
+    syncClientVersionCheck: boolean;
   };
 
   /**

packages/backend/server/src/fundamentals/config/default.ts

@@ -116,6 +116,7 @@ export const getDefaultAFFiNEConfig: () => AFFiNEConfig = () => {
     },
     featureFlags: {
       earlyAccessPreview: false,
+      syncClientVersionCheck: false,
     },
     https: false,
     host: 'localhost',