outline/server/collaboration/ViewsExtension.ts

import type {
  Extension,
  onDisconnectPayload,
  onChangePayload,
} from "@hocuspocus/server";
import { Minute } from "@shared/utils/time";
import Logger from "@server/logging/Logger";
import { trace } from "@server/logging/tracing";
import { View } from "@server/models";
import type { withContext } from "./types";

@trace()
export class ViewsExtension implements Extension {
  /**
   * Map of last view recorded by socket
   */
  lastViewBySocket: Map<string, Date> = new Map();

  /**
   * onChange hook. When a user changes a document, we update their "viewedAt"
   * timestamp if it's been more than a minute since their last change.
   *
   * @param data The change payload
   */
  async onChange({
    documentName,
    context,
    socketId,
  }: withContext<onChangePayload>) {
    if (!context.user) {
      return;
    }

    const lastUpdate = this.lastViewBySocket.get(socketId);
    const [, documentId] = documentName.split(".");

    if (!lastUpdate || Date.now() - lastUpdate.getTime() > Minute.ms) {
      this.lastViewBySocket.set(socketId, new Date());

      Logger.debug(
        "multiplayer",
        `User ${context.user.id} viewed "${documentName}"`
      );
      await Promise.all([
        View.touch(documentId, context.user.id, true),
        context.user.update({ lastActiveAt: new Date() }),
      ]);
    }
  }

  /**
   * onDisconnect hook. When a user disconnects, we remove their socket from
   * the lastViewBySocket map to cleanup memory.
   *
   * @param data The disconnect payload
   */
  async onDisconnect({ socketId }: onDisconnectPayload) {
    const interval = this.lastViewBySocket.get(socketId);
    if (interval) {
      this.lastViewBySocket.delete(socketId);
    }
  }

  /**
   * onDestroy hook
   * @param data The destroy payload
   */
  async onDestroy() {
    this.lastViewBySocket = new Map();
  }
}