CRDT-Lab: Local-first-Abgleich mit Zählern, Mengen, Vektoruhren und Text in Python
Dieses Lab gibt allen Lernenden ein eigenes JupyterLab mit CRDTs in schlichtem Python, kurz genug, um alles zu lesen: einen G-Counter und einen PN-Counter, ein Last-Writer-Wins-Register, ein Observed-Remove-Set, Vektoruhren und ein kleines Text-CRDT nach Art von RGA mit Tombstones. Elf kleine Skripte zeigen je eine Idee, von einer Änderung, die ein naiver Abgleich verliert, bis zu drei Replikaten, die nach vielen Offline-Änderungen übereinstimmen.
Jedes Replikat ist ein Python-Objekt, und offline heißt: zwei Objekte, die noch nicht zusammengeführt wurden. Nichts geht über ein Netz, und jeder Lauf gibt dasselbe aus. Jede Kopie hat keinen Weg ins Internet und keinen zu anderen Lernenden, und es wird nichts hineingeladen.
Was Lernende lernen
Warum Local-first-Apps offline weiterarbeiten und warum ein Abgleich, der die zuletzt gespeicherte ganze Kopie behält, Änderungen verliert: Das Lab verliert so die Titeländerung eines Handys. Sie führen G-Counter dreier Replikate in jeder Reihenfolge zusammen und bekommen jedes Mal 10, während eine einfache Zahl eine wiederholte Nachricht doppelt zählt und 19 erreicht. Sie sehen ein Last-Writer-Wins-Register einen Schreibvorgang an eine nachgehende Uhr verlieren, ein OR-Set einen Eintrag behalten, den ein Replikat gestrichen und ein anderes neu hinzugefügt hat, und zwei Offline-Änderungen an einer Textzeile auf beiden Replikaten zu denselben Wörtern werden. Sie vergleichen Vektoruhren als vorher, nachher, gleich oder nebenläufig, senden ein Delta von 29 Bytes statt eines Zustands von 7890 und sehen, welche Tombstones wegfallen dürfen. Es passt zu Kursen in verteilten Systemen, Datenbanken und mobiler oder Web-Entwicklung; prüfen Sie die genaue Formulierung in der Einheit Ihrer eigenen Prüfungsstelle, hier wird keine zitiert.
Im Browser ausführen
Das Lab startet einen einzigen Dienst, jupyter, der crdt.py, rga.py, ein Start-Notebook und die kurzen Skripte in seinen Arbeitsordner schreibt, ohne etwas herunterzuladen. JupyterLab verlangt kein Token, weil die Tür der Plattform schon weiß, wer es öffnet. Das Terminal neben dem Lab hat kein eigenes Python, es erreicht das des Labs mit docker exec jupyter, gefolgt vom Befehl, der darin laufen soll.
- Container-Seite öffnen. Öffnen Sie in der Leiste „Entwickeln“ und wählen Sie „Einen Container ausführen“. Die Seite kann jeder öffnen, und das Git-Lab und das SQL-Lab starten ohne Konto. Alle anderen Labs brauchen ein kostenloses Konto: Erstellen Sie eines, melden Sie sich an und klicken Sie dann auf „Starten“.
- Lab suchen. Die Karte „Beispiel-Labs“ listet alle Beispiele auf. Suchen Sie Local-first: CRDT-Zähler, Mengen und Text, die sich zusammenführen.
- Auf „Starten“ klicken. „Starten“ führt das Lab unverändert mit einem einzigen Klick aus. „Zuerst die Datei bearbeiten“ öffnet die Compose-Datei, damit Sie sie vor dem Start ändern können.
- Öffnen. Auf der Seite des Labs hat die Lab-Leiste einen Link namens JupyterLab: Klicken Sie darauf, um JupyterLab im Browser zu öffnen und crdt.py im Dateieditor zu lesen. Klicken Sie dann auf „Terminal öffnen“ und tippen Sie docker exec jupyter python3 steps/orset.py. Sie sehen, wie eine gemeinsame Liste einen Eintrag behält, den ein Replikat gestrichen und ein anderes neu hinzugefügt hat.
Was Lernende abgeben sollen
Ein eigenes Notebook, das diese Dateien nutzt, um eine selbst gewählte Frage zu beantworten, zum Beispiel ob die Reihenfolge des Zusammenführens je ein Ergebnis ändert, was eine Menge, bei der Entfernen gewinnt, dort täte, wo das OR-Set einen Eintrag behält, oder wie viele Tombstones ein Dokument nach einem Tag Bearbeitung behält, heruntergeladen aus JupyterLab mit File, Download. Dazu ein oder zwei Sätze in eigenen Worten, was sie gefunden haben. Nichts wird automatisch bewertet: Der Satz zeigt, ob es verstanden wurde. Für anspruchsvollere Arbeiten lassen Sie erklären, warum sich ein Zusammenführen, das die größere von zwei Zahlen nimmt, gefahrlos wiederholen lässt.
Eine Basis-Lektion zu diesem Lab
CRDT Basics ist eine kleine Lektion, die in diesem Lab gearbeitet wird. Darin verlieren Lernende mit einem naiven Abgleich eine Änderung, führen Zähler dreier Replikate zusammen, behalten einen Eintrag in einer gemeinsamen Liste, führen zwei Änderungen an einer Textzeile zusammen, vergleichen Vektoruhren und gleichen drei Replikate nach vielen Offline-Änderungen ab.
Kostenlose persönliche Konten haben sie im Modul Basics, das auf der Startseite liegt, und jede Einrichtung kann sie aus dem Basics-Ordner der Bibliothek kopieren. Sie ist bewusst klein: Sie zeigt einer Lehrkraft, was eine im Lab gearbeitete Lektion ist, und das Lab leistet den Rest. Kopieren Sie sie in ein eigenes Modul, um sie zu ändern. Das Hochschulmodul Local-first-Software und CRDTs wird im selben Lab bearbeitet.
Der Code auf GitHub
Die Compose-Datei hat kein Dockerfile: Sie startet ein einziges öffentliches Standard-Image, das scipy-notebook der Jupyter Docker Stacks, auf ein datiertes Tag festgelegt, mit eigenem unprivilegiertem Konto und 512 MB Speicher, und die CRDTs nutzen nur die Standardbibliothek von Python. Das Image steht unter BSD-3-Clause und wird von uns nicht verteilt. Die Datei schreibt beim Start jede Python-Datei aus festem Text, und das eine Zufallsskript nutzt einen festen Startwert, daher gibt jede Kopie dasselbe aus und nichts wird heruntergeladen. Die Grenzen sind ehrlich: Das Image enthält keine CRDT-Bibliothek, also laufen Automerge und Yjs hier nicht und werden in Worten verglichen, und Replikate sind Objekte in einem Prozess statt Geräte in einem Netz. Beim Stoppen des Labs bleibt nichts erhalten, weshalb Lernende ihr Notebook vorher herunterladen.
Als Aufgabe stellen
Schreiben Sie in die Aufgabe, was abzugeben ist.
- Lab erstellen. Fügen Sie in Ihrem Modul eine Aufgabe hinzu und wählen Sie die Karte „Container-Lab“, dann „In einem GitHub-Repository“. Geben Sie https://github.com/mitsurutech/lab-crdt-lab mit dem Branch main an. Die Compose-Datei ist standardmäßig compose.yaml. Forken Sie das Repository zuerst, wenn Sie es ändern möchten, zum Beispiel für ein eigenes CRDT in crdt.py oder ein weiteres Skript in steps.
- Veröffentlichen und ausprobieren. „Veröffentlichen“ legt den Commit fest, den Sie gesehen haben. Eine spätere Änderung im Repository verändert also kein Lab, das Sie bereits gestellt haben. Starten Sie zuerst Ihre eigene Kopie.
- Zuweisen. Weisen Sie es wie jede Aufgabe zu, auf Wunsch mit Fälligkeitsdatum, und schreiben Sie in die Aufgabe, was zu tun ist und was abgegeben werden soll.
- Abgaben bewerten. Öffnen Sie die Kopie einer lernenden Person und die abgegebene Arbeit, bewerten Sie sie und geben Sie sie mit einer Begründung zur Überarbeitung zurück, wenn mehr nötig ist.
Dieses Lab ausprobieren, und was es kostet
Mit einem kostenlosen persönlichen Konto können Sie die Grundlagenlektionen in diesem Lab durcharbeiten, mit genug kostenlosem Guthaben pro Monat für die meisten Lektionen und ohne Karte. Für eine Klasse sind die ersten 365 Tage für eine Schule kostenlos, für bis zu 50 Lernende; danach zahlt sie je lernender Person und Jahr, alle Labs inklusive und Lehrkräfte kostenlos.
Häufige Fragen
- Warum muss ich kein Token oder Passwort eingeben?
- Die Webseite eines Labs ist nur über die Tür der Plattform erreichbar, die schon weiß, wer Sie sind, und nur Sie und die Lehrkräfte Ihres Moduls hineinlässt. Deshalb startet JupyterLab ohne Token. Starten Sie es nicht so auf einem Rechner, den andere erreichen können.
- Warum nutzt das Terminal docker exec jupyter?
- Das Terminal des Labs enthält einige Clients, aber kein Python. docker exec jupyter führt einen Befehl im Container des Labs aus, der Python hat. JupyterLab hat außerdem ein eigenes Terminal unter File, New, Terminal.
- Führt das Lab Automerge oder Yjs aus?
- Nein. Das Lab ist ein einziges Standard-Image, in das beim Start nichts geladen wird, und dieses Image enthält keine CRDT-Bibliothek. Dieselben Ideen, Zähler, Mengen, Vektoruhren und ein Text-CRDT mit Tombstones, stehen in schlichtem Python zum Lesen bereit, und die Lektionen erklären, wie die Bibliotheken dieselbe Arbeit erledigen.
- Wo ist das Netz?
- Es gibt absichtlich keines. Jedes Replikat ist ein Python-Objekt, und ein Abgleich ist ein Aufruf von merge. So bestimmen Lernende genau, welches Replikat was gehört hat, und jeder Lauf gibt dasselbe aus. Offline gehen heißt einfach, merge noch nicht aufzurufen.