outline/server/collaboration/persistence.js

// @flow
import { debounce } from "lodash";
import * as Y from "yjs";
import documentUpdater from "../commands/documentUpdater";
import Logger from "../logging/logger";
import { Document, User } from "../models";
import markdownToYDoc from "./utils/markdownToYDoc";

const DELAY = 3000;

export default class Persistence {
  async onCreateDocument({
    documentName,
    ...data
  }: {
    documentName: string,
    document: Y.Doc,
  }) {
    const [, documentId] = documentName.split(".");
    const fieldName = "default";

    // Check if the given field already exists in the given y-doc. This is import
    // so we don't import a document fresh if it exists already.
    if (!data.document.isEmpty(fieldName)) {
      return;
    }

    const document = await Document.findByPk(documentId);

    if (document.state) {
      const ydoc = new Y.Doc();
      Logger.info(
        "collaboration",
        `Document ${documentId} is in database state`
      );
      Y.applyUpdate(ydoc, document.state);
      return ydoc;
    }

    Logger.info(
      "collaboration",
      `Document ${documentId} is not in state, creating from markdown`
    );
    const ydoc = markdownToYDoc(document.text, fieldName);
    const state = Y.encodeStateAsUpdate(ydoc);

    await document.update({ state: Buffer.from(state) }, { hooks: false });
    return ydoc;
  }

  onChange = debounce(
    async ({
      document,
      context,
      documentName,
    }: {
      document: Y.Doc,
      context: { user: User },
      documentName: string,
    }) => {
      const [, documentId] = documentName.split(".");

      Logger.info("collaboration", `Persisting ${documentId}`);

      await documentUpdater({
        documentId,
        ydoc: document,
        userId: context.user.id,
      });
    },
    DELAY,
    {
      maxWait: DELAY * 3,
    }
  );
}