CRDT ラボ:カウンター、集合、ベクタークロック、テキストで学ぶローカルファーストの同期

このラボでは、生徒ひとりひとりに専用の JupyterLab を渡します。中には、Python だけで書いた CRDT が入っていて、全部を読み通せる短さです。G-Counter と PN-Counter、後勝ちレジスタ、観測削除集合(OR-Set)、ベクタークロック、そしてトゥームストーンを持つ RGA 風の小さなテキスト CRDT です。11本の短いスクリプトが、素朴な同期で編集が消える様子から、たくさんのオフラインの変更のあとで3つのレプリカが一致する様子まで、考え方を1つずつ見せます。

どのレプリカも Python のオブジェクトで、オフラインとは、まだマージしていない2つのオブジェクトのことです。ネットワークには何も流れず、毎回同じ結果を表示します。どのコピーもインターネットにも、ほかの生徒にもつながらず、何もダウンロードされません。

生徒が学ぶこと

ローカルファーストのアプリがオフラインでも動き続ける理由と、最後に保存したコピーをまるごと残す同期が編集を失う理由です。ラボでは、スマートフォンのタイトルの変更がそうして消えます。3つのレプリカの G-Counter をどの順番でマージしても毎回 10 になり、ただの数は同じメッセージを2回数えて 19 になります。後勝ちレジスタが遅れた時計のせいで書き込みを失う様子、あるレプリカが消してほかのレプリカがもう一度足した品物を OR-Set が残す様子、1行のテキストへの2つのオフラインの編集が両方のレプリカで同じ言葉にマージされる様子を見ます。ベクタークロックを先、あと、等しい、並行に分け、7890 バイトの状態の代わりに 29 バイトのデルタを送り、どのトゥームストーンを捨てられるかを確かめます。分散システム、データベース、モバイルや Web の開発の講座に向いています。正確な文言は、お使いの資格団体の単元で確認してください。ここには引用していません。

ブラウザーで実行する

ラボは jupyter というサービスをひとつ起動します。このサービスは、crdt.py、rga.py、はじめのノートブック、短いスクリプトを作業フォルダーに書き出し、何もダウンロードしません。JupyterLab はトークンを求めません。プラットフォームの入口が、開いている人をすでに知っているからです。ラボの横のターミナルには専用の Python がないので、docker exec jupyter に続けて実行するコマンドを書き、ラボの Python を使います。

  1. コンテナーのページを開く. バーの「つくる」を開き、「コンテナーを実行」を選びます。ページは誰でも開けて、Git ラボと SQL ラボはアカウントなしで起動できます。ほかのラボには無料アカウントが必要です。アカウントを作成してサインインし、「起動」を押します。
  2. ラボを探す. 「サンプルラボ」のカードにすべてのサンプルが並んでいます。ローカルファースト:マージできる CRDT のカウンター、集合、テキストを探します。
  3. 「起動」を押す. 「起動」はそのまま1回の操作で実行します。「先にファイルを編集」は compose ファイルを開くので、起動する前に変更できます。
  4. 開く. ラボのページのバーに JupyterLab というリンクがあります。押すとブラウザーで JupyterLab が開くので、ファイルエディターで crdt.py を読みます。次に「ターミナルを開く」を押し、docker exec jupyter python3 steps/orset.py と入力すると、あるレプリカが消し、ほかのレプリカがもう一度足した品物を、共有のリストが残す様子が表示されます。

生徒に提出してもらうもの

これらのファイルを使って、自分で選んだ問いに答える自分のノートブックを提出してもらいます。たとえば、マージの順番で結果が変わることはあるか、OR-Set が品物を残す場面で削除が勝つ集合ならどうなるか、1日編集した文書にトゥームストーンはいくつ残るか、などです。JupyterLab の File、Download でダウンロードします。そこに、分かったことを自分の言葉で1、2文書いてもらいます。自動では採点されません。この文が、理解できたかどうかを示します。さらに力を見たいときは、2つの数の大きい方を取るマージなら、なぜ安全に繰り返せるのかを説明してもらいます。

このラボの基本レッスン

CRDT Basics は、このラボで進める小さなレッスンです。生徒は素朴な同期で編集を失い、3つのレプリカのカウンターをマージし、共有のリストに品物を残し、1行のテキストへの2つの編集をマージし、ベクタークロックを比べ、たくさんのオフラインの変更のあとで3つのレプリカを同期します。

無料の個人アカウントでは「ホーム」にある Basics モジュールに入っていて、どの学校もライブラリーの Basics フォルダーからコピーできます。あえて小さくしてあり、ラボで進めるレッスンがどういうものかを先生に見せる役目です。あとはラボが受け持ちます。変更したいときは、自分のモジュールにコピーしてください。大学向けモジュール「ローカルファーストと CRDT」も、同じラボで進めます。

GitHub のコード

compose ファイルには Dockerfile がありません。公開されている既存のイメージをひとつだけ使います。Jupyter Docker Stacks の scipy-notebook を日付つきのタグに固定し、権限のない専用アカウントとメモリ 512 MB で動かします。CRDT のコードは Python の標準ライブラリだけを使います。イメージのライセンスは BSD-3-Clause で、私たちは再配布していません。起動のたびに、固定の文章から Python ファイルをすべて書き出し、ランダムを使う1本のスクリプトは固定のシードを使うので、どのコピーも同じ結果を表示し、何もダウンロードされません。限界もあります。イメージには CRDT ライブラリが入っていないので、Automerge と Yjs はここでは動かず、言葉で比べます。また、レプリカはネットワーク上の端末ではなく、1つのプロセスの中のオブジェクトです。ラボを止めると何も残らないので、生徒は先にノートブックをダウンロードします。

課題として出す

何を提出するかを課題に書いておきます。

  1. ラボを作る. モジュールで課題を追加し、「コンテナーラボ」のカードを選んでから「GitHub リポジトリ」を選びます。https://github.com/mitsurutech/lab-crdt-lab とブランチ main を指定します。compose ファイルは既定の compose.yaml です。変更したい場合は、たとえば crdt.py に自分の CRDT を足したり、steps に別のスクリプトを加えたりするときは、先にリポジトリをフォークしてください。
  2. 公開して試す. 「公開」すると、確認したコミットに固定されるので、あとでリポジトリを変更しても、すでに出したラボは変わりません。まず自分のコピーを起動してください。
  3. 配布する. ほかの課題と同じように配布します。期限を付けることもでき、課題には何をするか、何を提出するかを書いておきます。
  4. 提出物を採点する. 生徒のコピーを開いて提出された内容を確認し、採点します。足りない場合は理由を書いて差し戻します。

このラボを試す、そして費用

無料の個人アカウントで、このラボの基本レッスンに取り組めます。毎月、ほとんどのレッスンに足りる無料クレジットがあり、カードは要りません。クラスで使う場合、学校は最初の365日間、生徒50人まで無料で、その後は生徒1人あたりの年額です。すべてのラボが含まれ、教職員は無料です。

よくある質問

トークンやパスワードを入力しなくてよいのはなぜですか。
ラボのウェブページには、プラットフォームの入口を通ってしか届きません。入口はあなたが誰かをすでに知っていて、あなたとモジュールを教える先生だけを通します。そのため JupyterLab はトークンなしで起動します。ほかの人が届くマシンでは、この設定で動かさないでください。
ターミナルで docker exec jupyter を使うのはなぜですか。
ラボのターミナルにはいくつかのクライアントが入っていますが、Python はありません。docker exec jupyter は、Python のあるラボのコンテナーの中でコマンドを実行します。JupyterLab にも、File、New、Terminal で開く自分のターミナルがあります。
ラボで Automerge や Yjs は動きますか。
いいえ。ラボは起動しても何もダウンロードしない既製のイメージ1つで、そのイメージには CRDT ライブラリが入っていません。同じ考え方、つまりカウンター、集合、ベクタークロック、トゥームストーンを持つテキスト CRDT を、生徒が読めるように普通の Python で書いてあります。ライブラリが同じ仕事をどう行うかは、レッスンで説明します。
ネットワークはどこにありますか。
わざと、ありません。どのレプリカも Python のオブジェクトで、同期は merge の呼び出しです。そのため、どのレプリカが何を聞いたかを生徒が正確に決められ、毎回同じ結果になります。オフラインにするとは、まだ merge を呼ばないことです。