mirror of
https://github.com/docmost/docmost.git
synced 2026-05-07 06:23:06 +08:00
fd36076ae7
* disconnect real-time collab if user is idle * log yjs document disconnect and unload in dev mode * no longer set editor to read-only mode on collab websocket disconnection * treat delayed collab websocket "connecting" state as disconnected * increase maxDebounce to 45 seconds * add reset handle to useIdle hook
260 lines
7.9 KiB
TypeScript
260 lines
7.9 KiB
TypeScript
import "@/features/editor/styles/index.css";
|
|
import React, {
|
|
useEffect,
|
|
useLayoutEffect,
|
|
useMemo,
|
|
useRef,
|
|
useState,
|
|
} from "react";
|
|
import { IndexeddbPersistence } from "y-indexeddb";
|
|
import * as Y from "yjs";
|
|
import { HocuspocusProvider, WebSocketStatus } from "@hocuspocus/provider";
|
|
import { EditorContent, EditorProvider, useEditor } from "@tiptap/react";
|
|
import {
|
|
collabExtensions,
|
|
mainExtensions,
|
|
} from "@/features/editor/extensions/extensions";
|
|
import { useAtom } from "jotai";
|
|
import useCollaborationUrl from "@/features/editor/hooks/use-collaboration-url";
|
|
import { currentUserAtom } from "@/features/user/atoms/current-user-atom";
|
|
import {
|
|
pageEditorAtom,
|
|
yjsConnectionStatusAtom,
|
|
} from "@/features/editor/atoms/editor-atoms";
|
|
import { asideStateAtom } from "@/components/layouts/global/hooks/atoms/sidebar-atom";
|
|
import {
|
|
activeCommentIdAtom,
|
|
showCommentPopupAtom,
|
|
} from "@/features/comment/atoms/comment-atom";
|
|
import CommentDialog from "@/features/comment/components/comment-dialog";
|
|
import { EditorBubbleMenu } from "@/features/editor/components/bubble-menu/bubble-menu";
|
|
import TableCellMenu from "@/features/editor/components/table/table-cell-menu.tsx";
|
|
import TableMenu from "@/features/editor/components/table/table-menu.tsx";
|
|
import ImageMenu from "@/features/editor/components/image/image-menu.tsx";
|
|
import CalloutMenu from "@/features/editor/components/callout/callout-menu.tsx";
|
|
import VideoMenu from "@/features/editor/components/video/video-menu.tsx";
|
|
import {
|
|
handleFileDrop,
|
|
handlePaste,
|
|
} from "@/features/editor/components/common/editor-paste-handler.tsx";
|
|
import LinkMenu from "@/features/editor/components/link/link-menu.tsx";
|
|
import ExcalidrawMenu from "./components/excalidraw/excalidraw-menu";
|
|
import DrawioMenu from "./components/drawio/drawio-menu";
|
|
import { useCollabToken } from "@/features/auth/queries/auth-query.tsx";
|
|
import { useDocumentVisibility } from "@mantine/hooks";
|
|
import { useIdle } from "@/hooks/use-idle.ts";
|
|
import { FIVE_MINUTES } from "@/lib/constants.ts";
|
|
|
|
interface PageEditorProps {
|
|
pageId: string;
|
|
editable: boolean;
|
|
content: any;
|
|
}
|
|
|
|
export default function PageEditor({
|
|
pageId,
|
|
editable,
|
|
content,
|
|
}: PageEditorProps) {
|
|
const collaborationURL = useCollaborationUrl();
|
|
const [currentUser] = useAtom(currentUserAtom);
|
|
const [, setEditor] = useAtom(pageEditorAtom);
|
|
const [, setAsideState] = useAtom(asideStateAtom);
|
|
const [, setActiveCommentId] = useAtom(activeCommentIdAtom);
|
|
const [showCommentPopup, setShowCommentPopup] = useAtom(showCommentPopupAtom);
|
|
const ydoc = useMemo(() => new Y.Doc(), [pageId]);
|
|
const [isLocalSynced, setLocalSynced] = useState(false);
|
|
const [isRemoteSynced, setRemoteSynced] = useState(false);
|
|
const [yjsConnectionStatus, setYjsConnectionStatus] = useAtom(
|
|
yjsConnectionStatusAtom,
|
|
);
|
|
const menuContainerRef = useRef(null);
|
|
const documentName = `page.${pageId}`;
|
|
const { data } = useCollabToken();
|
|
const { isIdle, resetIdle } = useIdle(FIVE_MINUTES, { initialState: false });
|
|
const documentState = useDocumentVisibility();
|
|
|
|
const localProvider = useMemo(() => {
|
|
const provider = new IndexeddbPersistence(documentName, ydoc);
|
|
|
|
provider.on("synced", () => {
|
|
setLocalSynced(true);
|
|
});
|
|
|
|
return provider;
|
|
}, [pageId, ydoc, data?.token]);
|
|
|
|
const remoteProvider = useMemo(() => {
|
|
const provider = new HocuspocusProvider({
|
|
name: documentName,
|
|
url: collaborationURL,
|
|
document: ydoc,
|
|
token: data?.token,
|
|
connect: false,
|
|
preserveConnection: false,
|
|
onStatus: (status) => {
|
|
if (status.status === "connected") {
|
|
setYjsConnectionStatus(status.status);
|
|
}
|
|
},
|
|
});
|
|
|
|
provider.on("synced", () => {
|
|
setRemoteSynced(true);
|
|
});
|
|
|
|
provider.on("disconnect", () => {
|
|
setYjsConnectionStatus(WebSocketStatus.Disconnected);
|
|
});
|
|
|
|
return provider;
|
|
}, [ydoc, pageId, data?.token]);
|
|
|
|
useLayoutEffect(() => {
|
|
remoteProvider.connect();
|
|
|
|
return () => {
|
|
setRemoteSynced(false);
|
|
setLocalSynced(false);
|
|
remoteProvider.destroy();
|
|
localProvider.destroy();
|
|
};
|
|
}, [remoteProvider, localProvider]);
|
|
|
|
const extensions = [
|
|
...mainExtensions,
|
|
...collabExtensions(remoteProvider, currentUser.user),
|
|
];
|
|
|
|
const editor = useEditor(
|
|
{
|
|
extensions,
|
|
editable,
|
|
immediatelyRender: true,
|
|
shouldRerenderOnTransaction: false,
|
|
editorProps: {
|
|
scrollThreshold: 80,
|
|
scrollMargin: 80,
|
|
handleDOMEvents: {
|
|
keydown: (_view, event) => {
|
|
if (["ArrowUp", "ArrowDown", "Enter"].includes(event.key)) {
|
|
const slashCommand = document.querySelector("#slash-command");
|
|
if (slashCommand) {
|
|
return true;
|
|
}
|
|
}
|
|
if (["ArrowUp", "ArrowDown", "ArrowLeft", "ArrowRight", "Enter"].includes(event.key)) {
|
|
const emojiCommand = document.querySelector("#emoji-command");
|
|
if (emojiCommand) {
|
|
return true;
|
|
}
|
|
}
|
|
},
|
|
},
|
|
handlePaste: (view, event, slice) =>
|
|
handlePaste(view, event, pageId, currentUser?.user.id),
|
|
handleDrop: (view, event, _slice, moved) =>
|
|
handleFileDrop(view, event, moved, pageId),
|
|
},
|
|
onCreate({ editor }) {
|
|
if (editor) {
|
|
// @ts-ignore
|
|
setEditor(editor);
|
|
editor.storage.pageId = pageId;
|
|
}
|
|
},
|
|
},
|
|
[pageId, editable, remoteProvider?.status],
|
|
);
|
|
|
|
const handleActiveCommentEvent = (event) => {
|
|
const { commentId } = event.detail;
|
|
setActiveCommentId(commentId);
|
|
setAsideState({ tab: "comments", isAsideOpen: true });
|
|
|
|
const selector = `div[data-comment-id="${commentId}"]`;
|
|
const commentElement = document.querySelector(selector);
|
|
commentElement?.scrollIntoView();
|
|
};
|
|
|
|
useEffect(() => {
|
|
document.addEventListener("ACTIVE_COMMENT_EVENT", handleActiveCommentEvent);
|
|
return () => {
|
|
document.removeEventListener(
|
|
"ACTIVE_COMMENT_EVENT",
|
|
handleActiveCommentEvent,
|
|
);
|
|
};
|
|
}, []);
|
|
|
|
useEffect(() => {
|
|
setActiveCommentId(null);
|
|
setShowCommentPopup(false);
|
|
setAsideState({ tab: "", isAsideOpen: false });
|
|
}, [pageId]);
|
|
|
|
useEffect(() => {
|
|
if (remoteProvider?.status === WebSocketStatus.Connecting) {
|
|
const timeout = setTimeout(() => {
|
|
setYjsConnectionStatus(WebSocketStatus.Disconnected);
|
|
}, 5000);
|
|
return () => clearTimeout(timeout);
|
|
}
|
|
}, [remoteProvider?.status]);
|
|
|
|
useEffect(() => {
|
|
if (
|
|
isIdle &&
|
|
documentState === "hidden" &&
|
|
remoteProvider?.status === WebSocketStatus.Connected
|
|
) {
|
|
remoteProvider.disconnect();
|
|
}
|
|
|
|
if (
|
|
documentState === "visible" &&
|
|
remoteProvider?.status === WebSocketStatus.Disconnected
|
|
) {
|
|
remoteProvider.connect();
|
|
resetIdle();
|
|
}
|
|
}, [isIdle, documentState, remoteProvider?.status]);
|
|
|
|
const isSynced = isLocalSynced && isRemoteSynced;
|
|
|
|
return isSynced ? (
|
|
<div>
|
|
<div ref={menuContainerRef}>
|
|
<EditorContent editor={editor} />
|
|
|
|
{editor && editor.isEditable && (
|
|
<div>
|
|
<EditorBubbleMenu editor={editor} />
|
|
<TableMenu editor={editor} />
|
|
<TableCellMenu editor={editor} appendTo={menuContainerRef} />
|
|
<ImageMenu editor={editor} />
|
|
<VideoMenu editor={editor} />
|
|
<CalloutMenu editor={editor} />
|
|
<ExcalidrawMenu editor={editor} />
|
|
<DrawioMenu editor={editor} />
|
|
<LinkMenu editor={editor} appendTo={menuContainerRef} />
|
|
</div>
|
|
)}
|
|
|
|
{showCommentPopup && <CommentDialog editor={editor} pageId={pageId} />}
|
|
</div>
|
|
|
|
<div
|
|
onClick={() => editor.commands.focus("end")}
|
|
style={{ paddingBottom: "20vh" }}
|
|
></div>
|
|
</div>
|
|
) : (
|
|
<EditorProvider
|
|
editable={false}
|
|
extensions={mainExtensions}
|
|
content={content}
|
|
></EditorProvider>
|
|
);
|
|
}
|