Stefan Zörner
20.06.2018
Micro Moves, Bauteil 5. Wir flanschen einen neuen Service in Node.js für die Schachregeln an.
Mittlerweile (seit dem dritten Teil dieser Serie) könnt Ihr auf unserer Online-Schachplattform FLEXess Schach spielen. Allerdings ist die Überprüfung der Züge bzgl. der Spielregeln rudimentär. Solange die Figur die richtige Farbe hat, kann sie ziehen, wohin sie will. Im Extremfall auch quer übers Brett direkt auf den gegnerischen König. Weiterhin merken wir nicht, wenn eine Partie zu Ende ist. Wir führen in diesem Teil einen neuen Service ein, der die Spielregeln anbietet. Und nutzen ihn aus dem games-Modul, um diese Mängel zu beheben.
Die komplizierten Spielregeln führen zu einem Quelltext-mäßig umfangreichen Bauteil rules. Wir implementieren es in JavaScript. Das Modul stellt seine Funktionalität per HTTP bereit. In Anlehnung an den letzten Teil der Serie machen wir sie im Reverse Proxy bekannt und bauen ein Docker-Image dazu, das wir in Docker Compose integrieren. Die rote (5) in der folgenden Abbildung markiert den Standpunkt von rules im Gesamtbild (“Sie befinden sich hier.").
Erster Verwender des Moduls ist das Partien-Subsystem games, das überprüfen möchte, ob z.B. aus play eingehende Züge regelkonform sind. Und wissen will, ob eine Partie bereits beendet ist (Stichworte: Schachmatt, Patt). Hierzu greift es auf rules zu; der Zugriff erfolgt synchron. Wir sichern ihn mit Netflix Hystrix ab (Stichwort Resilience).
Aber der Reihe nach …
Die Schachregeln sind verglichen mit anderen Spielen wie Dame oder Mühle vergleichsweise umfangreich. Es gibt sechs Figurenarten, die unterschiedlich ziehen. Der Bauer ist besonders kompliziert. Er schlägt anders als er zieht, darf am Anfang zwei Felder vor, mitunter en Passant schlagen und verwandelt sich auf der gegnerischen Grundlinie in eine andere Figur (engl. Promotion, für die englischen Schachbegriffe siehe diese Randnotiz). Darüber hinaus gibt es noch die Rochade, Schachmatt und Patt, die Regel, dass man nach seinem Zug nicht im Schach stehen darf … usw.
Eine vollständige Implementierung der Regeln ist aufwändig, aber nicht wirklich schwierig. Als nützlich erweist sich dabei eine Funktion, die für eine beliebige Position (im Wesentlichen die Platzierung der Figuren auf dem Brett, gegeben etwa in Forsyth-Edwards-Notation, siehe Randnotiz dazu) die Liste aller erlaubten Züge des am Zug befindlichen Spielers ermittelt. Mit dem Ergebnis könnt Ihr etwa prüfen, ob ein gegebener Zug gültig ist (er muss in der Liste auftauchen). Ist die Zugliste leer ist das Spiel beendet. Ob der König am Zug angegriffen ist macht dann den Unterschied aus zwischen Matt (verloren) und Patt (unentschieden aka Remis).
Die Spielregeln lassen sich prima automatisiert testen. Insbesondere die Funktion welche die gültigen Züge ermitteln. Auch hier leistet die Forsyth-Edwards-Notation gute Dienste, da man mit ihr in Unit-Tests sehr einfach die Eingabe als Zeichenkette repräsentieren kann. Hier ein Code-Fragment wie es in etwa in unseren Unit-Tests auftaucht
fen = "8/8/7R/3k4/8/3P4/7B/7K b - - 0 1"
expectedMoves = ["d5d4", "d5c5"]
pos = new Position(fen)
moves = ChessRules.getAllValidMoves(pos)
assert.equal(moves.length, expectedMoves.length)
...
In unserem Überblicksbild erkennt Ihr mögliche Verwender für Schachregeln. Neben dem Partien-Service games etwa die beiden Clients play (in Vue.js aus Folge 3) und später noch den Mobile Client. Diese Clients würden durch Nutzung der Spielregeln die Benutzbarkeit erhöhen, in dem sie etwa beim Auswählen einer Figur die Felder markieren, wo die Figur hinziehen darf. Und sie könnten einen eingegebenen Spielerzug prüfen, bevor sie ihn Richtung games schicken, und so den Server entlasten und unnötigen Netzwerkzugriffe (bei fehlerhaften Zügen) vermeiden.
Wenn jeder Client die Spielregeln selbst implementieren würde, ständen diesen Vorteilen der Nachteil des mehrfachen Aufwands gegenüber und die Gefahr von Inkonsistenzen.
Wenn wir die Spielregeln später ergänzen wollen, um auch so schöne Varianten wie Atom-Schach oder Zombie-Schach zu unterstützen, müssten wir an verschiedenen Stellen Änderungen vornehmen.
Schöne Anregungen für alternative Schachregeln finden sich übrigens im Buch rechts …
Die Spielregeln zentral zu entwicklen und als Bibliothek zur Verfügung zu stellen (vgl. Shared Kernel in DDD) wäre eine Option. Als problematisch könnten dabei unterschiedliche Programmiersprachen herausstellen. Eine weitere Möglichkeit wäre die Spielregeln im games-Modul zu integrieren. Ich habe mich dagegen entschieden, da dieses Modul eh schon recht groß ist, und ich es ungern neu deployen möchte, um neue Spielregeln zu unterstützen.
Die Wahl fiel daher auf einen eigenen Service rules, der die Spielregeln über eine HTTP-Schnittstelle bereitstellt. Im ersten Wurf nur Standard-Schach allerdings, kein Zombie-Schach.
Die für Micro Moves erstellte Implementierung der Spielregeln in JavaScript (Quelltext auf GitHub) benutzt folgendes Domänenmodell (folgende Abbildung). Die Felder des Brettes werden als Zahlen von 0..63 repräsentiert. Die zentrale Klasse Position spiegelt den Zustand einer Partie wider und orientiert sich an FEN. Objekte sind unveränderlich, die Methode performMove liefert eine neue Position mit der geänderten Spielsituation zurück.
Alle oben dargestellten Elemente finden sich in der Quelltextdatei domain.js. Die folgende Tabelle gibt einen Überblick über alle Dateien der Implementierung.
| Datei | Wesentliche Elemente | Beschreibung |
| domain.js | Colour, Move, Position | Domänenmodell für die Schachelemente |
| geometry.js | BoardGeometry | Geometrie des Schachbretts, inkl. Bewegungen gerade, schräg ... |
| rules.js | ChessRules | gültige Züge, angegriffene Felder, Schachmatt ... |
Für die Spielregeln liegen im Unterverzeichnis tests des Moduls eben solche. Realisiert sind sie mit dem Test-Framework Mocha, siehe etwa “Simple Node.js tests with assert and mocha”. Ihr führt sie einfach mit npm test aus, der folgende Screenshot zeigt einen Teil der Ausgabe:
Die folgende Tabelle skizziert die Operationen der Klasse ChessRules jeweils anhand Eingabe und Ergebnis.
| Funktion | Eingabe | Ergebnis |
| getAllValidMoves | Position | Liste der aus der Postion heraus möglichen Züge für den aktiven Spieler |
| isSquareAttackedByColour | Position, Feld, Farbe | boolean, ob das Feld in der Postion von einer Figur der betreffenden Farbe angegriffen ist |
| isCheckmate | Position | boolean, ob die gegebene Position ein Schachmatt für den aktiven Spieler ist. |
| isStalemate | Position | boolean, ob die betreffende Position ein Patt ist. |
Der eigentliche Service für die Spielregeln ist mit Node.js und dem Framework Express realisiert. Express bezeichnet sich selbst als schnelles, offenes, unkompliziertes Web-Framework für Node.js.
Im ersten Wurf unterstützt der Service nur zwei Funktionen. Über die URL /allValidMoves könnt Ihr zu einer Position (Request-Parameter fen) die Menge der möglichen Züge ermitteln (entspricht der Funktion getAllValidMoves aus den Regeln oben).
Weiterhin ist es mit /validateMove möglich eine Position (Request-Parameter fen) und einen Zug (Request-Parameter move) anzugeben. Zurückgeliefert wird ein JSON-Dokument, das einen Boolean-Wert enthält, ob der Zug gültig ist.
Weiterhin im Falle eines gültigen Zuges die neue Position nach Ausführung (in FEN), und ob diese Position ein Schachmatt ist oder ein Patt. Hier ein Beispiel-Resultat für einen Aufruf:
{
"fen":"rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1",
"move":"e2e4",
"valid":true,
"resultingFen":"rnbqkbnr/pppppppp/8/8/4P3/8/PPPP1PPP/RNBQKBNR b KQkq e3 0 1",
"checkmateAfterMove":false,
"stalemateAfterMove":false
}
Der Quelltext für den Service findet sich in der Datei server-main.js. Start mit npm start. Der Service enthält eine index.html als statische Testseite. Dort sind einige Aufrufe für die Funktionen verlinkt, damit Ihr sie direkt ausprobieren könnt, ohne selbst Aufrufe mit fen und move als URL-Parameter zu basteln. Die folgende Abbildung zeigt einen Screenshot der Seite, inkl. JSON-Ausgabe bei Aufruf eines Test-Links.
Das rules-Modul enthält darüber hinaus ein Dockerfile (vgl. Folge 4) und ist in die Docker Compose-Konfiguration von FLEXess integriert. Der Artikel “Dockerizing a Node.js web app” erklärt kurz und knackig wie Ihr Docker Images für Node.js-Anwendungen baut. Ich habe mich daran orientiert.
Mit der neuen Funktionalität wäre das games-Modul nun in der Lage, eingehende Züge bzgl. der Spielregeln zu überprüfen. Weiterhin könnte es die neue Spielsituation aus dem Zug ermitteln, und ein Spielende durch Matt oder Patt erkennen.
Immer wieder Thema im Zusammenhang mit vertikalen Architekturstilen ist die Kommunikation zwischen Teilen, in unserem Fall also zwischen games und rules. Oftmals etabliert bereits die Makroarchitektur Regeln oder Prinzipien. Ist Kommunikation zwischen Vertikalen überhaupt erlaubt? Falls ja: synchron, asynchron oder je nach Fall beides. Hinzu kommen Entscheidungen zu Protokollen und Technologien.
All diese Optionen haben Vor- und Nachteile, die je nach Fall mehr oder weniger ins Gewicht fallen (sonst würde da nicht so breit diskutiert). In FLEXess legen wir hier keinen allgemeinen Regeln fest, sondern zeigen in verschiedenen Folgen unterschiedlichen Ansätze. Und diskutieren diese.
In unserem Fall wirkt die Wahl einer synchronen Kommunikation natürlich: Bei games geht ein Zug zu einer Partie ein. Das games-Modul prüft mit einem Aufruf gegen rules, ob er regelkonform ist, und wartet auf das Ergebnis (synchron). Je nach Ausgang der Überprüfung wird der Zug ausgeführt und persistiert, oder abgelehnt. in jedem Fall erhält der Aufrufer ein Ergebnis (auf das er solange wartet).
Motivation für die synchrone Kommunikation ist hier, dass games ohne die Überprüfung in rules den Zug nicht annehmen oder ablehnen kann. Gleichzeitig warten auf der Client-Seite zwei Spieler auf diese Entscheidung. Und bei einem liefe in einem echten Spiel die Schachuhr für seine Bedenkzeit weiter. Wir brauchen das Ergebnis jetzt.
Größter Nachteil der synchronen Kommunikation, und der Grund warum in Microservices-Architekturen asynchrone Kommunikation (also das Versenden nach Nachrichten ohne Warten auf Reaktion) bevorzugt sind, ist die höhere Kopplung. Das nicht zur Verfügung stehen von rules führt dazu, dass games keine Züge annehmen kann. Wir kommen darauf noch zurück!
Im games-Modul kümmert sich die Klasse RulesClient (im Paket org.flexess.games.rulesclient, Quelltexte siehe GitHub) um die Anbindung an rules. Sie fungiert als Gateway (vgl. Pattern-Buch von Martin Fowler) und bietet zunächst nur die Methode validateMove (analog zur URL im Service) an.
Die Klasse kapselt den HTTP-Aufruf gegen rules und das Überführen der JSON-Anwort in ein geeignetes Java-Objekt (Klasse ValidateMoveResult). Als HTTP-Client nutze ich Java-Bordmittel aus java.net. Auf eine Service Registry verzichten wir wie hier – das rules-Modul (und ggf. auch mehrere Exemplare davon) ist durch Docker Compose im Docker-internen Netzwerk mit dem Hostnamen “rules” erreichbar.
Der RulesClient landet per Dependency Injection im GamesService, der ihn im Rahmen der Operation createAndPerformMove heranzieht, um den eingehen Zug auf Regelkonformität zu überprüfen. Ungültige Züge quittiert er (wie zuvor) mit einer Exception, die der REST-Service als Fehlermeldung zum Client (z.B. die Vue.js SPA play) sendet, siehe Screenshot:
Bei Problemen im RulesClient (z.B. rules-Service nicht verfügbar) kommt es zu IOException u.ä., die innerhalb des RulesClient behandelt dem Service als RuntimeException weitergereicht werden könnten. Sonderlich robust ist das nicht.
Der synchrone Ansatz birgt die Gefahr, dass ein Ausfall des Moduls rules die Arbeit des zentralen Moduls games massiv behindert. Auch wenn rules für die Bearbeitung von Anfragen lange braucht, zieht das games in Mitleidenschaft. Bei vielen parallelen Anfragen könnte der Thread-Pool von games für HTTP-Anfragen leerlaufen. games antwortet dann nicht nur (auch) langsam, sondern gar nicht mehr (Connection refused) – selbst bei Anfragen, welche die Spielregeln gar nicht betreffen!
Architekturmuster rund um Resilience (dt. “Unverwüstlichkeit”) zielen auf robuste, fehlertolerante Systeme ab. Hier reisst ein einzelnes Teilsystem nicht gleich die ganze Anwendung runter. In Microservices-Anwendungen, in denen synchrone Kommunikation zwischen Services lt. Makro-Architektur zulässig ist, ein wichtiger Punkt. Der Self-contained Systems-Ansatz (kurz SCS, siehe Charakteristiken) hingegen propagiert asynchrone Kommunikation zwischen SCSen, wo immer möglich.
Dort, wo synchrone Kommunikation zwischen Services in der Makroarchitektur zulässig ist (Paradebeispiel: Netflix) hat sich das Circuit Breaker-Pattern etabliert. Es orientiert sich an der Metapher des Schutzschalters in Stromkreisen. Im Falle von Überlast fliegt dort die Sicherung raus und verhindert dass etwa Brände durch überhitzte Leitungen entstehen. Circuit Breaker schützt den Zugriff auf externe Systeme, z.B. einen anderen Service. Antwortet dieser nicht oder langsam, wird der Schaltkreis unterbrochen. Der Service erhält keine Anfragen, bis sich die Situation beruhigt hat (was mit einzelnen Aufrufen ab und an getestet wird).
Martin Fowler beschreibt das Muster in einem Blog-Beitrag – wie für Muster üblich ist die kanonische Quelle allerdings ein Buch: der resilience-Klassiker “Release It!" von Michael Nygard (Cover oben). Die zweite Ausgabe ist in 2018 frisch erschienen.
Als konkrete Implementierung im Java-Umfeld stellt Netflix Hystrix als Bibliothek bereit. Es bezeichnet sich selbst als Latenz- und Fehlertoleranzlösung für verteilte Systeme. Für andere Programmiersprachen gibt es ähnliche Lösungen. Hystrix lässt sich über die Integration von Spring Cloud leicht in unser bestehendes games-Modul aufnehmen.
Um eine Operation (hier den Aufruf des rules-Service aus games) mit Hystrix abzusichern gibt es zwei Optionen. Entweder Ihr schreibt eine Command-Klasse gemäß der Hystrix-API, oder Ihr nutzt eine spezielle Annotation @HystrixCommand und “markiert” damit eine Methode. Spring wickelt dann gemäß AOP einen Proxy und umhüllt die Ausführung. Letzteres ist die einfachere Variante, Ihr findet den Quelltext dazu im games-Modul in den Klasse RulesClient. Dekoriert ist dort die Methode validateMove.
Falls rules nun nicht zur Verfügung steht oder langsam antwortet öffnet sich der Kreis, und rules wird nicht von weiteren Anfragen von games belästigt. Mit dem Hystrix Monitor lässt sich das Verhalten von außen beobachten (bei geeigneter Konfiguration – das Dashboard muss an den Stream kommen …). Im Folgenden Screenshot seht Ihr unsere anmontierte Methode einmal mit geschlossenem Stromkreis (links), einmal mit unterbrochenem.
Egal ob Ihr ein Command schreibt oder die Annotation nutzt: Ihr könnt einen Fallback implementieren bzw. angeben, der bei einem unterbrochenen Stromkreises greift. In der Regel kommt hier ein Default-Verhalten zum Einsatz, das weniger Schmerzen bereitet als ein Fehler. Beispielsweise könnten alte Werte aus einem Cache zurückgeliefert werden, wenn ein entferter Service gerade nicht zur Verfügung steht, und das fachlich akzeptabel ist. Klassisches Beispiel hier sind Wetterdaten, wo der Aufrufer ggf. auch gut mit älteren leben kann.
Im Falle unserer Schachregeln habe ich auf eine Alternative verzichtet. Der Aufrufer erhält die Nachricht, dass der Zug nicht überprüft werden konnte. Der folgende Screenshot zeigt die Situation in der Vue.js-SPA play.
Denkbar wäre auch im Fall der Nichtverfügbarkeit der Spielregeln den gegnerischen Spieler entscheiden zu lassen, ob der vorgelegte Zug regelkonform ist oder nicht. Im echten Schachspiel ist es ja auch so (man weist den Gegner auf einen fehlerhaften Zug hin). Die Idee gefällt mir. Auf eine Implementierung habe ich trotzdem verzichtet.
JavaScript hat durch Technologien wie Node.js oder Single Page Applikations deutlich an Relevanz gewonnen, auch im Unternehmensumfeld.
Es geht nicht mehr darum klassischen HTML-Anwendungen mit ein bisschen Feenstaub in Form von browser-seitigem Scripting ein wenig mehr Interaktivität einzuhauchen.
Stattdessen entstehen größere Softwarelösungen in dieser Sprache mit einem ganz eigenen, reichen Öko-System. Das Javascript von 1995 hat mit dem von heute nicht mehr viel zu tun.
Hingegen waren meine JavaScript-Kenntnisse lange durch diese alten Erinnerungen geprägt.
Ein Buch, das mir geholfen hat wieder Anschluss an das “zeitgenössische” JavaScript zu finden ist “Understanding ECMAScript6: The Definitive Guide for JavaScript Developers” von Nicholas Zakas (Cover siehe rechts).
Nachdem in dieser Folge die synchrone Kommunikation Thema war, zeigen wir als Alternative dazu später noch einen asynchronen Fall mir Messaging. Eine weiterer offener Punkt ist Security. Im Moment könnte jeder Benutzer an jedem Brett ziehen (er müsste nur auf die Partie klicken). In der Realität würden die tatsächlichem Spieler einem auf die Finger hauen. Später übernimmt das unsere Plattform.
Ach ja: Fragen und Anregungen sind natürlich jederzeit gerne Willkommen. Per Kommentar hier im Blog oder gerne auch per Mail direkt an mich …