outline/server/collaboration/EditorVersionExtension.ts

import type { Extension, onConnectPayload } from "@hocuspocus/server";
import semver from "semver";
import { EditorUpdateError } from "@shared/collaboration/CloseEvents";
import EDITOR_VERSION from "@shared/editor/version";
import Logger from "@server/logging/Logger";
import { trace } from "@server/logging/tracing";
import type { withContext } from "./types";

@trace()
export class EditorVersionExtension implements Extension {
  /**
   * On connect hook – prevents connections from clients with an outdated editor
   * version. See the equivalent logic for API in /server/routes/api/middlewares/editor.ts
   *
   * @param data The connect payload
   * @returns Promise, resolving will allow the connection, rejecting will drop.
   */
  onConnect({ requestParameters }: withContext<onConnectPayload>) {
    const clientVersion = requestParameters.get("editorVersion");

    if (!clientVersion) {
      Logger.debug(
        "multiplayer",
        "Dropping connection due to missing editor version"
      );
      return Promise.reject(EditorUpdateError);
    }

    const parsedClientVersion = semver.parse(clientVersion);
    const parsedServerVersion = semver.parse(EDITOR_VERSION);

    if (
      parsedClientVersion &&
      parsedServerVersion &&
      parsedClientVersion.major < parsedServerVersion.major
    ) {
      Logger.debug(
        "multiplayer",
        `Dropping connection due to outdated editor version: ${clientVersion} < ${EDITOR_VERSION}`
      );
      return Promise.reject(EditorUpdateError);
    }

    return Promise.resolve();
  }
}