Files
outline/server/commands/documentCollaborativeUpdater.ts

94 lines
2.5 KiB
TypeScript

import { yDocToProsemirrorJSON } from "@getoutline/y-prosemirror";
import isEqual from "fast-deep-equal";
import uniq from "lodash/uniq";
import { Node } from "prosemirror-model";
import * as Y from "yjs";
import { ProsemirrorData } from "@shared/types";
import { schema, serializer } from "@server/editor";
import Logger from "@server/logging/Logger";
import { Document, Event } from "@server/models";
import { sequelize } from "@server/storage/database";
type Props = {
/** The document ID to update */
documentId: string;
/** Current collaobrative state */
ydoc: Y.Doc;
/** The user ID that is performing the update, if known */
userId?: string;
/** Whether the last connection to the document left */
isLastConnection: boolean;
};
export default async function documentCollaborativeUpdater({
documentId,
ydoc,
userId,
isLastConnection,
}: Props) {
return sequelize.transaction(async (transaction) => {
const document = await Document.unscoped()
.scope("withoutState")
.findOne({
where: {
id: documentId,
},
transaction,
lock: {
of: Document,
level: transaction.LOCK.UPDATE,
},
rejectOnEmpty: true,
paranoid: false,
});
const state = Y.encodeStateAsUpdate(ydoc);
const content = yDocToProsemirrorJSON(ydoc, "default") as ProsemirrorData;
const node = Node.fromJSON(schema, content);
const text = serializer.serialize(node, undefined);
const isUnchanged = isEqual(document.content, content);
const lastModifiedById = userId ?? document.lastModifiedById;
if (isUnchanged) {
return;
}
Logger.info(
"multiplayer",
`Persisting ${documentId}, attributed to ${lastModifiedById}`
);
// extract collaborators from doc user data
const pud = new Y.PermanentUserData(ydoc);
const pudIds = Array.from(pud.clients.values());
const collaboratorIds = uniq([...document.collaboratorIds, ...pudIds]);
await document.update(
{
text,
content,
state: Buffer.from(state),
lastModifiedById,
collaboratorIds,
},
{
transaction,
hooks: false,
}
);
await Event.schedule({
name: "documents.update",
documentId: document.id,
collectionId: document.collectionId,
teamId: document.teamId,
actorId: lastModifiedById,
data: {
multiplayer: true,
title: document.title,
done: isLastConnection,
},
});
});
}