Как спроектировать совместный редактор документов
На этой странице
Совместный редактор (Google Docs, Notion, Figma) — задача повышенной сложности: несколько пользователей одновременно меняют один документ, и все должны прийти к одинаковому состоянию без потери правок. Основные решения: модель документа (дерево блоков, а не HTML-строка), операции вместо отправки целого документа, алгоритм слияния — OT (Operational Transformation) или CRDT (например, Yjs), WebSocket для синхронизации, presence (курсоры и выделения других), офлайн-правки и история версий. На уровне middle достаточно понимать модель и компромиссы, а не реализацию алгоритмов.
Вопрос
Как спроектировать совместный редактор документов? Как синхронизировать одновременные правки, показывать курсоры других пользователей и работать офлайн?
R — требования
- редактирование форматированного текста (заголовки, списки, изображения);
- несколько пользователей одновременно, видны их курсоры;
- автосохранение, история версий, комментарии (кратко);
- нефункциональные: задержка видимости правок < 200–500 мс, работа при обрыве сети, большие документы (сотни страниц), права (чтение / комментирование / редактирование).
A — архитектура
<EditorApp>
├─ <Toolbar>
├─ <Editor> ProseMirror / Tiptap / Lexical / Slate
│ └─ модель документа ⇄ DOM (contenteditable)
├─ <PresenceLayer> курсоры и выделения других
└─ <SidePanel> комментарии, история
Sync layer
├─ локальные операции → очередь → WebSocket
├─ удаленные операции → слияние (OT / CRDT) → модель → DOM
├─ awareness/presence канал (не сохраняется)
└─ IndexedDB: локальная копия и офлайн-измененияD — модель документа
type Block =
| { id: string; type: "paragraph"; content: Inline[] }
| { id: string; type: "heading"; level: 1 | 2 | 3; content: Inline[] }
| { id: string; type: "image"; src: string; width: number; height: number };
type Inline = { text: string; marks?: ("bold" | "italic" | "link")[]; href?: string };
type Doc = { id: string; version: number; blocks: Block[] };Почему не HTML: нужна валидная структура, стабильные id блоков, операции над позициями и безопасный вывод.
I — интерфейс
GET /api/docs/:id → снимок документа + версия (или CRDT-state)
GET /api/docs/:id/history → версии
WS /ws/docs/:id → операции, ack, presence{ "type": "op", "clientId": "c1", "baseVersion": 41, "ops": [{ "insert": "Привет", "at": 120 }] }
{ "type": "ack", "version": 42 }
{ "type": "presence", "userId": "u2", "cursor": { "anchor": 130, "head": 135 }, "color": "#e11d48" }O — ключевые решения
OT или CRDT:
| OT | CRDT (Yjs, Automerge) | |
|---|---|---|
| Идея | сервер трансформирует конкурирующие операции относительно друг друга | структура данных, которая сливается одинаково в любом порядке |
| Нужен центральный сервер | да | нет, возможен p2p |
| Офлайн | сложнее | естественно |
| Сложность реализации | высокая, много краевых случаев | берут готовую библиотеку |
| Накладные расходы | меньше | метаданные растут, нужна сборка мусора |
| Где | Google Docs | Notion-подобные, Figma (свой вариант), многие новые редакторы |
На интервью: «Возьму CRDT-библиотеку Yjs с провайдером WebSocket и привязкой к Tiptap/ProseMirror, а не буду писать алгоритм сам».
Синхронизация:
- отправлять операции, а не документ целиком; батчить быстрые правки (каждые 50–100 мс);
- локальная правка применяется мгновенно (оптимистично), удаленные — сливаются;
- после переподключения — обмен недостающими изменениями (state vector в Yjs), офлайн-правки хранятся в IndexedDB;
- автосохранение на сервере периодическими снимками + журнал операций для истории версий.
Presence: курсоры и выделения идут отдельным легким каналом (awareness), не сохраняются; throttle обновлений курсора; цвет и имя пользователя; таймаут неактивных.
Производительность больших документов: виртуализация рендеринга блоков вне экрана, ленивая загрузка изображений, ограничение частоты перерисовки presence.
Права и безопасность: роль проверяется сервером для каждой операции; режим только чтения отключает ввод; вставка из буфера санитизируется (HTML → модель документа).
a11y: contenteditable с правильными ролями, сочетания клавиш, объявление изменений форматирования, доступные курсоры других (имя по наведению и для скринридера — по запросу).
Что важно помнить
- Не пишите редактор с нуля на
contenteditableиinnerHTML— берут ProseMirror/Tiptap/Lexical. - Главная идея — сходимость: одинаковое итоговое состояние у всех независимо от порядка операций.
- Undo/redo в совместном режиме отменяет только свои операции.
- Отделяйте сохраняемые данные (документ) от эфемерных (курсоры, «печатает»).
- Связанные темы: realtime, надежность и офлайн.
Мини-шпаргалка
Модель документа — дерево блоков с id. Правки — операции, не весь документ. Слияние — OT (сервер трансформирует) или CRDT (Yjs, сливается в любом порядке). WebSocket + батчинг, оптимистичное применение, офлайн в IndexedDB, снимки + журнал для истории. Presence — отдельный эфемерный канал. Готовый редактор: ProseMirror / Tiptap / Lexical.
Документация
Yjs: Docs, Tiptap: Collaboration, ProseMirror Guide, crdt.tech: Resources.