mooriii's blog

article icon

リアルタイム共同編集を実現できるライブラリLoroを試してみる

この記事はAtrae Advent Calendar 2024の6日目の記事です。前回は@motonosuke_devによる「改善余地のあるコードから考える学びの重要性」でした。

今日はリアルタイム共同編集が実現できるライブラリのLoroを試してみようと思います。似たようなライブラリには、Yjsがありますが、筆者の個人的な感想としてはYjsよりドキュメントがわかりやすく、かつタイムトラベル機能が容易に実装できるのが魅力的です。

Examples – LoroThe examples of basic usage in Loro
favicon of loro.dev
ogp of https://i.ibb.co/T1x1bSf/IMG-8191.jpg

Loroとは

LoroはCRDT(Conflict-free Replicated Data Types)というデータ構造を活用したライブラリで、リアルタイムの共同編集やバージョン管理機能をアプリケーションに組み込むことができます。

Loro – Reimagine state management with CRDTsLoro - Reimagine state management with CRDTs | Built for local-first software.
favicon of loro.dev
ogp of https://i.ibb.co/T1x1bSf/IMG-8191.jpg

簡単に言うと、複数人で同時にデータを操作しても競合を起こさないでいい感じにマージしてくれるライブラリです。 同時編集中に接続が切れオフラインで操作をしても、オンライン復帰時に他の人の操作も含めていい感じにマージしてくれます。

CRDTについてはCRDT (Conflict-free Replicated Data Type)を15分で説明してみるが参考になるのでぜひご覧ください。

CRDT (Conflict-free Replicated Data Type)を15分で説明してみる - QiitaCRDTについて勉強したので纏めてみました。15分くらいでざっとわかったつもりになれる感じで纏めてみたつもりです。全体スライドSlideshareのスライドが埋め込めなかったので、↓からアクセス…
favicon of https://qiita.com/everpeace/items/bb73ec64d3e682279d26qiita.com
ogp of https://qiita-user-contents.imgix.net/https%3A%2F%2Fqiita-user-contents.imgix.net%2Fhttps%253A%252F%252Fcdn.qiita.com%252Fassets%252Fpublic%252Farticle-ogp-background-afbab5eb44e0b055cce1258705637a91.png%3Fixlib%3Drb-4.0.0%26w%3D1200%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLXByb2ZpbGUtaW1hZ2VzLmltZ2l4Lm5ldC9odHRwcyUzQSUyRiUyRnFpaXRhLWltYWdlLXN0b3JlLnMzLmFtYXpvbmF3cy5jb20lMkYwJTJGODY3OCUyRnByb2ZpbGUtaW1hZ2VzJTJGMTQ3MzY4MTExMz9peGxpYj1yYi00LjAuMCZhcj0xJTNBMSZmaXQ9Y3JvcCZtYXNrPWVsbGlwc2UmZm09cG5nMzImcz1kNTQ5OTJjNTU5NTJhNTEzY2Q2MGY0OTI3YjU3OTY4Mw%26blend-x%3D120%26blend-y%3D467%26blend-w%3D82%26blend-h%3D82%26blend-mode%3Dnormal%26s%3D89208f8737bc5d0988091b1af63943ab?ixlib=rb-4.0.0&w=1200&fm=jpg&mark64=aHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTk2MCZoPTMyNCZ0eHQ9Q1JEVCUyMCUyOENvbmZsaWN0LWZyZWUlMjBSZXBsaWNhdGVkJTIwRGF0YSUyMFR5cGUlMjklRTMlODIlOTIxNSVFNSU4OCU4NiVFMyU4MSVBNyVFOCVBQSVBQyVFNiU5OCU4RSVFMyU4MSU5NyVFMyU4MSVBNiVFMyU4MSVCRiVFMyU4MiU4QiZ0eHQtYWxpZ249bGVmdCUyQ3RvcCZ0eHQtY29sb3I9JTIzMUUyMTIxJnR4dC1mb250PUhpcmFnaW5vJTIwU2FucyUyMFc2JnR4dC1zaXplPTU2JnR4dC1wYWQ9MCZzPTI0OTlmZDAxNDMxYTVmOTkwMjk2OGEyNWYwNjUzZjc0&mark-x=120&mark-y=112&blend64=aHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTgzOCZoPTU4JnR4dD0lNDBldmVycGVhY2UmdHh0LWNvbG9yPSUyMzFFMjEyMSZ0eHQtZm9udD1IaXJhZ2lubyUyMFNhbnMlMjBXNiZ0eHQtc2l6ZT0zNiZ0eHQtcGFkPTAmcz1kN2NhZjMyZGQyMDUyMDJhZjE5MWIxMzU0NzRhZmRkYw&blend-x=242&blend-y=480&blend-w=838&blend-h=46&blend-fit=crop&blend-crop=left%2Cbottom&blend-mode=normal&s=b3bdf349f3a9f294bbf707963b579696

使い方

使い方は意外と簡単です。LoroDocと呼ばれるものを初期化して、好みのデータを追加したり削除したりしていきます。 サポートしてるデータ形式はList,Text,Mapなどです。詳しくは公式ドキュメントを参照してください。

const doc = new LoroDoc();
const text: LoroText = doc.getText("text");
text.insert(0, "Hello world!");
console.log(doc.toJSON()); // { "text": "Hello world!" }

共同で編集する場合は複数のLoroDocを同期させる必要がありますが、exportメソッドとimportメソッドが用意されているのでそれを使います。変更を共有したいLoroDocの内容をexportして、変更を取り込みたいLoroDocでimportするといった具合です。

exportメソッドは、用途に応じてエンコードモードを使い分けます。

以下は同時に同じmapを操作したときの例です。Loroのmapは最後に編集したものが反映されるLWW(Last Writer Wins)というポリシーを使用しています。また同時編集でコンフリクトが起きた際には、Lamport timestampの順序決定アルゴリズムを使用して競合を解消しているらしいです。

import { LoroDoc } from "loro-crdt";
 
const docA = new LoroDoc();
const docB = new LoroDoc();
docA.setPeerId(0) // 同時に編集が起きた場合は、peerId の大きい方が優先される. 
docB.setPeerId(1) // peerIdを反対にすると結果も反対になる.
docA.getMap("map").set("key1", "valueA");
docA.getMap("map").set("key2", "valueA"); 
docB.getMap("map").set("key1", "valueB"); 
 
const bytesA = docA.export({mode: "update"})
const bytesB = docB.export({mode: "update"})
 
console.log(docA.toJSON()) // { map: { key1: 'valueA', key2: 'valueA' } }
console.log(docB.toJSON()) // { map: { key1: 'valueB' } }
 
docB.import(bytesA)
docA.import(bytesB)
 
console.log(docA.toJSON()) // { map: { key1: 'valueB', key2: 'valueA' } }
console.log(docB.toJSON()) // { map: { key1: 'valueB', key2: 'valueA' } }

実際にアプリケーションの組み込んでみる

今回はホワイトボードライブラリの tldraw を使って、共同編集可能なホワイトボードを作ってみます。今回はサーバーでは状態を持たず、ひたすら差分を垂れ流すだけにして、各クライアントがLoroDocを管理する形にしてみます。

サンプルを用意しましたのでぜひ参考にしてみてください。

GitHub - mr04vv/tldraw-loro: loroを使ったtldrawのサンプルリポジトリloroを使ったtldrawのサンプルリポジトリ. Contribute to mr04vv/tldraw-loro development by creating an account on GitHub.
favicon of https://github.com/mr04vv/tldraw-lorogithub.com
ogp of https://opengraph.githubassets.com/dcad44116d62e4a52839e917d4cdfbb390405aef4132c56994c41c090cafdb17/mr04vv/tldraw-loro

受け取ったメッセージを他のクライアントに送信するWebsocketサーバーを作る

まずはメッセージを垂れ流すだけのWebsocketサーバーを作ります。

server.ts
import { Hono } from "hono";
import { createNodeWebSocket } from "@hono/node-ws";
import { serve } from "@hono/node-server";
import { WebSocket } from "ws";
 
const app = new Hono();
 
const { injectWebSocket, upgradeWebSocket } = createNodeWebSocket({
  app,
});
 
const port = 1234;
const server = serve({ fetch: app.fetch, port });
injectWebSocket(server);
 
console.log(`Server is running on port ${port}`);
 
// 接続してるクライアントを管理する配列
const conns: WebSocket[] = [];
app.get(
  "/",
  upgradeWebSocket(() => {
    return {
      onOpen: async (evt, ws) => {
        if (!ws.raw) return;
        if (!(ws.raw instanceof WebSocket)) return;
        // すでに接続済みの場合はスキップ
        if (!conns.includes(ws.raw)) conns.push(ws.raw);
      },
      onMessage: (message, ws) => {
        if (!ws.raw) return;
        if (!(ws.raw instanceof WebSocket)) return;
        const update = message.data as ArrayBuffer;
        ws.raw.binaryType = "arraybuffer";
        for (const conn of conns) {
          // 送信元以外に垂れ流し
          if (conn === ws.raw) continue;
          conn.send(update);
        }
      }
    };
  }),
);

実態はほぼ33行目と38行目で、来たデータをそのまま他のクライアントに送り返してるだけです。

tldrawを使ったクライアントアプリを作る

続いてクライアントです。

tldraw-loro/apps/client at main · mr04vv/tldraw-loroloroを使ったtldrawのサンプルリポジトリ. Contribute to mr04vv/tldraw-loro development by creating an account on GitHub.
favicon of https://github.com/mr04vv/tldraw-loro/tree/main/apps/clientgithub.com
ogp of https://opengraph.githubassets.com/dcad44116d62e4a52839e917d4cdfbb390405aef4132c56994c41c090cafdb17/mr04vv/tldraw-loro

クライアントの処理の流れは大体以下のような感じです。

  1. tldrawの状態の変化を検知し、LoroDocを更新
  2. LoroDocの更新を検知してWebsocketに変更差分を送信
  3. (Websocketが他のクライアントに差分を垂れ流す)
  4. Websocketから送られてきた差分をLoroDocに適用
  5. LoroDocの更新を検知してtldrawに反映

1. tldrawの状態の変化を検知し、LoroDocを更新

tldrawのボード上にオブジェクトが追加されたり、更新・削除された場合、tldrawのstoreのイベントハンドラで変更を検知できます。イベントハンドラ内で、取得した変更を元にローカルのLoroDocを更新します。

  const editor = useEditor(); // tldrawが提供するhook
  const doc = new LoroDoc();
  // 中略
  useEffect(() => {
    // ホワイトボードの変更を検知
    const listen = editor.store.listen((e) => {
      const { changes, source } = e;
      if (source !== "user") return; // ローカルでの変更のみを処理
      const { added, removed, updated } = changes;
      
      for (const shape of added) {
          // LoroDocの更新
          doc.getMap("map").set(shape.id, shape)
      }
    });
    
    return listen;
  }, []);

2. LoroDocの更新を検知してWebsocketに変更差分を送信

ステップ1の13行目でのLoroDocの更新によって、Mapのイベントハンドラが発火します。Mapのイベントハンドラ内では、ローカルの変更をWebsocketサーバーに送信する処理を追加します。

versionRefはステップ4で説明します。

  const doc = new LoroDoc();
  const versionRef = useRef(); // 前回との差分のみを送信するために保持するref
  // 中略
  const handleMapUpdate = useCallback(
    (e: LoroEventBatch) => {
      if (e.by === "local") {
        // ローカルでの更新
        // websocketに差分を送信
        const updated = doc.export({
          mode: "update",
          from: versionRef.current,
        });
        websocket.send(update)
      }
    },
    [doc, editor.store, wsProvider],
  );
 
  useEffect(() => {
    doc.getMap("map").subscribe(handleMapUpdate);
  }, [doc, handleMapUpdate]);

3. (Websocketが他のクライアントに差分を垂れ流す)

4. Websocketから送られてきた差分をLoroDocに適用

ステップ2で変更差分が送信元以外のクライアントに送信されます。差分を受け取ったクライアントは、LoroDocに適用します。

この時LoroDocを更新したタイミングのバージョンをrefで保持しておきます。そうすることで、状態更新時に前のバージョンとの差分のみを取り出して送信できます。

  const doc = new LoroDoc();
  const ws = new Websocket();
  const versionRef = useRef();
  // 中略
  const handleWsMessage = useCallback(
    async (ev: MessageEvent) => {
      const data = ev.data;
      const arrayMessage = new Uint8Array(data);
      doc.import(arrayMessage); // LoroDocに適用
      versionRef.current = doc.version(); // バージョンをrefに保持
    },
    [doc],
  );
 
  useEffect(() => {
    ws.addEventListener("message", handleWsMessage);
    return () => {
      ws.removeEventListener("message", handleWsMessage);
    };
  }, [handleWsMessage, wsProvider]);

5. LoroDocの更新を検知してtldrawに反映

Loroではsubscribeメソッドが用意されていて、Docの変更をトリガーとしたイベントハンドラをセットできます。 イベントハンドラ内では、ローカルでの更新(map.set("hoge")等の直接の更新)とリモートの更新(importメソッドを使用した更新)を区別できるので、以下のようにそれぞれ処理を分けることができます。

自分の操作(→Websocketに送信)と他のクライアントから送信されたもの(→tldrawに反映)を区別するために、先程のMapのイベントハンドラに条件分岐を追加します。

  const doc = new LoroDoc();
 
  const handleMapUpdate = useCallback(
    (e: LoroEventBatch) => {
      if (e.by === "local") {
        // doc.getMap("map").set()による変更
      }
      if (e.by === "import") {
        // doc.importによる変更
        const updateShapes: TLRecord[] = [];
        const events = e.events;
        for (const event of events) {
          if (event.diff.type === "map") {
            const map = event.diff.updated;
            for (const key in map) {
              const shape = map[key] as unknown as TLShape;
                updateShapes.push(shape);
            }
          }
        }
        // tldrawにLoroDocの変更を反映
        editor.store.mergeRemoteChanges(() => {
          editor.store.put([...updateShapes]);
        });
      }
    },
    [doc, editor.store],
  );

うまくいくとこんな感じでリアルタイムに同期されたホワイトボードができるはずです。

同時編集しているホワイトボードのGIF

また、ドキュメントには書いてないのですが、Awarenessの実装もあるのでちょっと工夫すればユーザーカーソルの同期のように永続化しなくても良い情報の同期もよしなにできるようになります。

AwarenessについてはYjsのドキュメントを読んだほうが分かりやすいかもしれません。概念はおそらくほぼ同じです。

Websocketサーバーに一手間加えて永続化できるようにしてあげればリロードしても他のクライアントと同期できるようにもなります。

カーソルも同期されていて永続化されているデモ

まとめ

今回はLoroを使ってリアルタイムに共同編集できるホワイトボードを作ってみました。Yjsと比較してもドキュメントがわかりやすく操作も直感的な気がします。

履歴機能も割と簡単に作れちゃうのでぜひ皆さんも試してみてください。

CloudflareのDurable Objectsと組み合わせて使えたらかなり面白そうということで、後日Honoのアドベントカレンダーでチャレンジしようと思います。

それではまた次回お会いしましょう。

LGTM

宣伝

我が家の猫のLGTM画像サイトです。ぜひご自由に使ってください。

Lgtlatte - らてのLGTM画像飼い猫らてのLGTM画像を集めました
favicon of https://lgtlatte.mooriii.com/lgtlatte.mooriii.com
ogp of https://images.ctfassets.net/rd8mwctho8md/CvOcilcY3CGMuYLJPqxGL/4866b02e655a7d52c1fb19afcf9eb4c1/ogp.png

次回の7日目は @muttsu_623による「Androidアプリエンジニアからフルスタックエンジニアになった話 a.k.a. バックエンドの学び方【後編】」です。

この記事をシェアするx icon
アイコン画像
Takuto Mori@_mooriii

Wevoxというサービスのフロントエンジニアをしています。趣味は猫を眺めることです🐱