Files

270 lines
28 KiB
Plaintext

Du bist ein erfahrener Entwickler für Web-Anwendungen. Du erklärst Architekturentscheidungen bevor Code erzeugt wird.
Dazu benutzt du auch Diagramme, die Modulzusammenhänge mit den Schnittstellen und wesentliche Abläufe erläutern.
Die Webanwendung soll als Projektnamen CMBNet haben. Code und Webseitenkomponenten sollen in dem Projektverzeichnis gut strukturiert abgelegt werden.
Als Technik verwendest du serverseitig Python3 mit Flask als Framework.
Für das Frontend verwendest du reines Javascript (Vanilla Javascript).
Als CSS-Framework für das Frontend kommt pico.css zum Einsatz.
Weil die Webanwendung primär eine Kartenanwendung sein wird, wird leaflet als Javascript Bibliothek eingesetzt.
Die Zustände der Anwendung soll für die verschiedenen Clients mittels Websocket synchronisiert werden. Dazu muss im Server ein Routing implementiert werden, das Clients mit unterschiedlichen Accounts voneinander trennt und individuelle bedient.
Für die Kommunikation mittels Websocket soll ein eigenes Protokoll implementiert werden, dass ID's für Sender und Empfänger, einen Code zur Unterscheidung verschiedener Nachrichtentypen, einen Zeitstempel und ein Textfeld für die Nachricht vorsieht.
Zu Beginn der Websocketkommunikationn muss die Webseite sich nach dem Login über den Websocket selbst auch authentifizieren. Dazu ruft die Webseite nach dem Neuladen mittels AJAX die aktuellen Attribute aller Entitäten 1) und 2) ab und erhält mit diesem Request auch ein Zugriffstoken, den sie bei der Websocketkommunikation zur Authentifizierung verwendet.
Die Webanwendung soll mandantenfähig sein. Dazu soll im Datenmodell bei jeder Entität auch eine ID für den Mandanten vorgesehen sein. In der URL der jeweiligen Webzugriffe ist der Mandant codiert, Accounts beziehen sich eindeutig auf einen Mandanten.
Die Kartenansicht dient der Darstellung und Manipulation verschiedener Entitäten mit Attributen, deren Applikationslogik später entwickelt wird:
1) Strassen
a) ID
b) Name
c) State (mindestens: unbearbeitet, zugewiesen, erledigt)
d) Verknüpfung mit einer Gruppe (1:1) oder null beim State "unbearbeitet"
e) Hausnummer mininmal
f) Hausnummer maximal
g) Bounding Box (Geokoordinaten für Nordwest- und Südost-Ecke) im Format eines Javascript Arrays
2) Gruppen
a) ID
b) State (offen, unterwegs, online, pausierend, fertig)
c) Letzte geographische Position mit Datum und Uhrzeit
d) Aliasname
e) Verknüpfung mit Account (1:1)
3) Accounts
a) ID
b) Name
c) Rolle (Gast, Beobachter, Gruppe, Dispatcher, Administrator)
d) Passwordhash
Von Beginn an soll ein Zugangsschutz mittels Accounts eingebaut sein.
Für einen Account mit der Rolle eines Administrators sind spezielle Views bzw. Webseiten aufrufbar, die ausschließlich der Verwaltung (Anlegen, Bearbeiten, Löschen) der verschiedenen Entitätstypen dienen:
- Accountverwaltung: Nutzer anlegen mit Namen, Rolle, Passwordhash
- Gruppenverwaltung: Anlegen, Attribute verändern, Gruppe löschen, mit einem oder mehreren Accounts verknüpfen
- Strassenverwaltung: Hier soll mittels Dateiupload eine csv-Datei importiert werden, aus der die Entitäten extrahiert werden. Danach sollen hier auch einzelne Einträge editierbar sein und gelöscht werden können.
Alle Transaktionen auf diesen Entitäten sollen in ein Logfile lesbar mit Zeitstempel geschrieben werden.
Über State-Wechsel von 1) und 2) soll eine Historie mit Datum/Uhrzeit-Stempel geführt werden, die in der jeweiligen Verwaltungsseite aufrufbar ist. Durch Anklicken eines alten States soll dieser State wieder gültig werden, z.B. die geographische Position wird wieder darauf zurückgesetzt.
Alle Daten sollen mandantenfähig in einer SQLite3 Datenbank verwaltet werden.
Zur Administrierung der Entitäten sollen eigene Webseiten vorgesehen werden, die einem Account mit Administratorrechten das Anlegen, Löschen und Editieren erlauben.
Beschreibe zunächst in einer Architekturskizze, wie der grundsätzliche Aufbau des Projekts CMBNet mit diesen Vorgaben zur Darstellung unterschiedlicher Views aussehen wirfd.
------8<-----------------
Neben den oben erwähnten Views für die Administration und ein View für das Login soll es folgende Views geben:
- Dispatcher-View: Optimiert für Desktopansicht mit allen Informationen und Interaktion
- Präsentations-View: Alle Informationen aber Interaktion beschränkt auf Suche, keine Modifikatin von Entitäten
- Öffentlicher-View: Wie Präsentations-View aber ohne Berücksichtigung von Gruppen
- Dispatcher-Mobil-View: Ein für Smartphone-Nutzung optimierter Dispatcher-View mit selektiver Auswahl der dargestellten Entitäten
- Gruppen-View: Ein für Smartphone-Nutzung optimierter View für einen Account einer Gruppe, der nur Daten dieser Gruppe anzeigt und State-Wechsel erlaubt.
Wir beginnen mit der Serverseite und implementieren die wichtigsten Funktionen des Backends.
Zentral ist der Broker, der die Websocketverbindungen verarbeitet.
Damit die Anwendung benutzt werden kann, müssen zuerst die wesentlichen Funktionen der Zugriffe auf die Entitäten implementiert werden:
1) Strassen:
a) Abstraktionsschicht für die lesenden und schreibenden Datenbankzugriffe
b) Ein Handler, der den AJAX Request nach Neuladen eines Views behandelt und dazu ein JSON Dict mit allen Attributen einscließlich des aktuellen States versendet.
c) Eine Funktion, die Änderungen an Attributen einer Strasse in die Datenbank schreibt und mit dem neuen Attribut eine Nachricht über den Websocket Broker verschickt.
2) Gruppen:
a) Die Daten dazu werden beim Start der Anwendung und nach explizitem Invalidieren aus der Datenbank ausgelesen und im Speicher vorgehalten um die Performance zu gewährleisten.
b) Schreibende Zugriffe auf die Gruppen Daten werden zusätzlich zur In-Memory-Datenhaltung auch in die Datenbank geschrieben.
c) Eine Funktion, die prüft, ob ein Account mit einer Gruppe verknüpft ist.
d) Eine Funktion, die alle mit einer Gruppe verknüpften Accounts zurückgibt
e) Eine Funktion, die alle mit einer Gruppe verknüpften Strassen zurückgibt
f) Ein Handler, der den AJAX Request nach Neuladen eines Views behandelt, der ein JSON Dict mit allen Attributen einscließlich des aktuellen States sendet.
g) Eine Funktion, die Änderungen an Attributen einer Strasse in die Datenbank schreibt und mit dem neuen Attribut eine Nachricht über den Websocket Broker verschickt.
h) Bei allen Aktionen des zugehörigen Verwaltungsviews wird die In-Memory-Datenhaltung invalidiert.
3) Accounts:
a) Abstraktionsschicht für die lesenden und schreibenden Datenbankzugriffe
b) Eine Funktion, die den Passworthash mit dem übertragenen Passwort auf kryptografische Gültigkeit vergleicht
c) Eine Funktion, die prüft, ob der Account einer bestimmten Rolle angehört
d) Eine Ablage von Zugriffstokens für die jeweilige Session
Protokoll der Websocketkommunikation:
Der Broker verarbeitet eingehende Nachrichten aus den Websocketverbindungen, indem zuerst der Code der Nachricht ausgewertet wird:
- Ein Code < 100 dient nur zu internen Zwecken. Die Nachricht wird nicht auf der Weboberfläche angezeigt.
- Code = 100: Der State einer Straße hat sich geändert. Diese Nachricht wird an alle Accounts Dispatcher, Gast, Beobachter und die Gruppen verschickt, die mit dieser Straße verknüpft sind. Inhalt des Textes ist JSON mit den Attributen Name und State der Straße sowie der auslösende Account.
- Code = 200: Der State einer Gruppe hat sich geändert. Diese Nachricht wird an alle Accounts Dispatcher, Beobachter und an die betroffene Gruppe geschickt. Inhalt des Textes ist JSON mit dem neuen State, der Gruppen ID und dem auslösenden Account.
- Code = 300: Die geographische Position einer Gruppe hat sich geändert. Diese Nachricht wird an verbundene Accounts Dispatcher, Beobachter und an die betroffene Gruppe geschickt. Inhalt des Textes ist JSON mit den neuen Geokoordinaten und dem auslösenden Account.
- Code = 1000: Ein Dispatcher versendet eine Nachricht an alle Accounts des Typs Dispatcher, Beobachter und alle Gruppen (Broadcast). Inhalt des Textes ist Freitext aus der Nutzeroberfläche eines Dispatcher-Views oder Dispatcher-Mobil-Views.
- Code = 1100: Ein Dispatcher versendet eine Nachricht an alle Accounts des Typs Dispatcher, Beobachter und eine spezielle Gruppe. Inhalt des Textes ist Freitext aus der Nutzeroberfläche eines Dispatcher-Views dem der Aliasname der Gruppe vorangestellt wird.
- Code = 2000: Eine Gruppe versendet eine Nachricht an alle Accounts des Typs Dispatcher und Beobachter. Inhat des Textes ist JSON mit der Gruppen ID und Freitext aus der Nutzeroberfläche des Gruppen-Views.
Eine zyklische Routine im Server versendet jede Minute eine Nachricht mit dem Code=1, auf den alle über Websocket verbundenen Clients mit einer Nachricht dmit Code=2 antworten. Eine Nachricht mit Code=2 wird nur an angeschlossene Dispatcher-Views weitergeleitet.
Nachrichten mit Code>=1000 müssen auf dem Server in der Datenbank in einer eigenen Tabelle gespeichert werden. Meldet sich ein Client beim Broker an, dann werden nur diesem Client die für ihn erlaubten Nachrichten aus dieser Tabelle in der zeitlichen Reihenfolge übermittelt ("late entry" Funktion). Nachrichten, die alter als 8 Stundenn sind sollen nicht mehr versendet werden sondern werden dann aus der Datenbank gelöscht.
Entwickel dazu den notwendigen Python Code. Lege diesen in einer strukturierten Weise in einem Projekt an, das bereits die Grundlagen einer Flask Anwendung enthält.
Der Code soll ausführlich kommentiert werden. Erkläre die wichtigsten Entscheidungen.
Gib das Kommando zum Starten eines Entwicklungswebservers für diese Flask-Anwendung an.
------8<-----------------
Jetzt werden der Login-View, die drei Verwaltungsviews und als Prototyp eine einfache Variante des Dispatcher-Views für das Frontend angelegt.
Login-View:
Er besteht aus dem Eingabefeld des Accountnamens, des Passwords und einem Auswahlfeld für den Mandanten, das mit einer Auswahlliste ("BV", "RV", "SV") und Vorbelegung mit "RV" realisiert wird. Der Request-Handler auf Serverseite kann zu der ursprünglich aufgerufenen URL weiterleiten bei erfolgreicher Authentifizierung und erneutem Aufruf des Login-Views mit einer Fehlermeldung bei gescheitertert Authentifizierung.
Gibt es keine Weiterleitungs-URL, dann leitet der Request-Handler je nach Rolle des Accounts zu dem Dispatcher-View, Beobachter-View oder Gruppen-View weitergeleitet.
Accountverwaltung:
In einer Tabelle werden die existierenden Accounts aufgelistet. In der jeweiligen Tabellenzeile gibt es einen Button zum Neusetzen des Passworts mittels modalen Dialogs und einen Button zum Löschen nach einer Sicherheitsabfrage.
Die Rolle des Accounts kann über ein Auswahlfeld in der Zeile geändert werden.
Änderungen an bestehenden Accounts werden unmittelbar mittels AJAX dem Server mitgeteilt, der die Datenbank aktualisiert und die In-Memory-Verwaltung invalidiert.
Unterhalb der Tabelle ist ein Button, der einen modalen Dialog öffnet, mit dem alle Felder eines neuen Accounts befüllt werden können. Nach Drücken des "Anlegen" Buttons dieses Dialogs wird ebenso mittels AJAX die Datenbank aktualisiert und eine neue Zeile mit den Werten in der Ansicht erstellt.
Ein "Abbrechen" Button schließt den Dialog ohne weitere Aktionen.
Gruppenverwaltung:
In einer Tabelle werden die existierenden Gruppen aufgelistet.
Der State kann mit einer Auswahlliste geändert werden und hat den Defaultwert "offen".
Die Verknüpfung mit einem Account geschieht mit einer Auswahlliste über alle bestehenden Accounts der Rolle "Gruppe".
Die aktuelle geographische Position kann nicht editiert werden, aber auf einen vorherigen Wert aus der Historie gesetzt werden oder gelöscht. Der Defaultwert ist "unbekannt".
Änderungen an bestehenden Gruppen werden unmittelbar mittels AJAX dem Server mitgeteilt, der die Datenbank aktualisiert.
Unterhalb der Tabelle ist ein Button, der einen modalen Dialog öffnet, mit dem die Felder Aliasname und Verknüpfung mit einem Accout der Rolle "Gruppe" einer neuen Gruppe befüllt werden können. Nach Drücken des "Anlegen" Buttons dieses Dialogs wird ebenso mittels AJAX die Datenbank aktualisiert und eine neue Zeile mit den Werten in der Ansicht erstellt.
Ein "Abbrechen" Button schließt den Dialog ohne weitere Aktionen.
Strassenverwaltung:
In einer Tabelle werden die existerenden Strassen aufgelistet.
Alle Attribute können editiert werden. Dazu wird ans Ende der Zeile ein Button mit einem Bleistiftsymbol angefügt, der einen modalen Dialog öffnet. Alle Formularfelder werden mit den aktuellen Werten vorbelegt. Name und Bounding Box sind Freitextfelder, State und Gruppenverknüpfung Auswahllisten. Mit dem Drücken des "Speichern" Buttons des Dialogs wird mittels AJAX im Request-Handler des Servers die Datenbak aktualisiert und die Werte in der betreffenden Tabellenzeile. Bei einem Wechsel des States wird daraufhin vom Server die entsprechende Code=100 Nachricht über den Broker verschickt. Drücken des "Abbrechen" Buttons schließt den Dialog ohne Übernahme der Änderungen. Neben dem Button mit einem Bleistiftsymbol ist ein Button mit einem Trashcan Symbol. Damit wird die Löschung einer Zeile nach Sicherheitsabfrage in eienm modalen Dialog ausgelöst. Die Änderung wird mittels AJAX dem Server mitgeteilt, der die Datenbank aktualisiert.
Unter der Tabelle gibt es einen Button "Neue Strasse", der mittels eines Dialogs einer Zeile die Anlage und Befüllung einer neuen Zeile auslöst und mittels AJAX im passenden Request-Handler die Aktualisierung der Datenbank bewirkt. Dabei sind State und Gruppenverknüpfung nicht editierbar und der State wird auf "unbearbeitet" gesetzt.
Die Tabelle kann mittels Dateiupload ausgelöst durch einen Button "Import" neben diesem Button befüllt werden. Dabei wird eine Datei im CSV-Format erwartet, die als Trenner ';' verwendet und die Spalten "Name", "Hausnummer minimal", "Hausnummer maximal" und "Bounding Box" enthält. Je importierter Zeile wird dieselbe Aktion ausgeführt wie bei der Interaktion mit "Neue Strasse".
Prototyp des Dispatcher-Views:
Nach einem Neuladen der Seite werden zuerst interne Datenstrukturen gefüllt:
- Mittels AJAX wird die Liste der Strassen gefüllt (Zusammenspiel mit dem Handler aus 1) b))
- Mittels AJAX wird die Liste der Gruppen gefüllt (Zusammenspiel mit dem Handler aus 2) f))
- Mittels AJAX wird das gültige Zugriffstoken für die Kommunikation über den Websocket beim Server erfragt. Dieses zufällig erzeugte Token wird zum späteren Vergleich auch beim Broker hinterlegt.
Danach wird die Websocketkommunikation aufgebaut und als erstes eine Nachricht mit Code=0 versendet, die als Inhalt den Zugriffstoken hat. Der Broker vergleicht den übermittelten Token mit dem eben hinterlegten. Erst bei Übereinstimmung wird die Websocketkommunikation mit diesem Client erlaubt.
Die Webseitenansicht ist zweigeteilt: zwei Drittel nimmt auf der linken Seite eine Kartenansicht mittels leaflet ein. Das rechte Drittel der Seite wird von der Anwendung zur Interaktio ("Kontrollansicht") genutzt. Die Seite soll sich bei Gößenänderungen des Browserfensters automatisch anpassen. Die Kartenansicht soll die linke Seite ausfüllen ohne dass das div der Karte gescrollt werden muss.
* Initialisierung der Kartenansicht:
Der Ausschnitt soll zu Beginn das umfassende Rechteck aller Boundig Box Werte aus der Strassenliste umschließen. Wenn bei der Benutzung der Anwendung der Kartenausschnitt und die Zoomstufe geändert werden, dann sollen der jeweilige Kartenmittelpunkt und die Zoomstufe inm LocalStorage des Browsers gespeichert werden und so bei einem Neuladen der Seite die gespeicherten Werte wiederhergestellt werden. Das gilt ebenfalls für die noch zu beschreibenden Werte "Opacity" und "Markerbreite", die in der Kontrollansicht eingestellt werden.
Defaultwert für Opacity ist 0.7, für Markerbreite 20.
Für jede Strasse in der Liste existiert ein Eintrag in einem Javascript Dict "Strasse2Polylines". Strasse2Polylines wird in einer Datei str2pl.js extern bereitgestellt und liegt als eigenes Javascript Fragment bei den statischen Dateien und wird in der Webseite importiert. Ein Polyline-Segment ist darin ein Arry von Koordinaten-Paaren [Longitude, Latitude]. Zu jedem Eintrag, der als Key den Strassennamen hat, gibt es ein Array solcher Segmente, die zusammen den Strassenverlauf ergeben. Für jede Strasse wird dieses Array durchlaufen und jedes Segment als Polyline-Objekt aus leaflet erzeugt. Dabei werden die Werte für opacity=Opacity und weight=Markerbreite gesetzt. Die Farbe der Polyline wird vom State in der Liste der Strassen abgeleitet:
- unbearbeitet=blau
- zugewiesen=rot
- erledigt=grün
Für jede Polylne wird ein Handler eingebaut, der beim "click" Event einen Dialog öffnet, der zu dem Strassennamen eine Interaktion bereitstellt zum Ändern des States:
- von "unbearbeitet" auf "zugewiesen": Abfrage der jetz mit der Strasse verknüpften Gruppe und Versendung der Nachricht mit Code=100.
- von "zugewiesen" auf "zugewiesen": Abfrage der neu mit der Strasse verknüpften Gruppe und Versendung der Nachricht mit Code=100 an die alte und die neue Gruppe
- von "zugewiesen" auf "unbearbeitet": Versendung der Nachricht mit Code=100 an die bisher damit verknüpfte Gruppe
- von "zugewiesen" auf "erledigt": Versendung der Nachricht mit Code=100
- von "unbearbeitet" auf "erledigt": Versendung der Nachricht mit Code=100
Wird über den Websocket eine Code=100 Nachricht empfangen, dann wird die Farbe aller zu dieser Strasse gehörenden Polyline Segmente wie oben beschrieben geändert.
Für alle Gruppen wird ein Marker auf der Karte gezeichnet. Wenn die geographische Position zum Zeitpunkt des Neuladens unbekannt ist, wird der Marker auf die Posiiton gesetzt, die der Browser für die eigene Position ermittelt.
Der Marker soll für jede Gruppe eine individuell Farbe haben.
* Aufbau der Kontrollansicht:
Die Kontrollansicht hat vertikal angeordnet einen Header, einen zentralen Bereich und einen Footer.
Header:
Im Header wird der Wochentag, das Datum in kleinem Font und vergrößert die Uhrzeit angezeigt. Die Uhrzeit wird durch eine zyklische Routine sekundengenau aktualisiert.
Unterhalb davon ist ein Dropdown-Menü, mit dem die Hintergrundkarte ausgewählt werden kann:
- Openstreetmap Tiles
- Luftbild
Neben dem Dropdown ist ein Button mit dem Lautsprecher-Symbol. Damit wird ein Dialogfeld geöffnet, in dem Freitext eingegeben werden kann. Dieser Text wird als Code=1000 Nachricht via Websocket versendet.
Footer:
Im Footer sind einige wenige Steuerungselemente, die immer verfügbar sein sollen:
- ein Range Slider, der den Opacity Wert zwischen 0 und 1 in 20 Teilschritten einstellt.
- ein Range Slider, der die Markerbreite zwischen 1 und 100 in Schritten von 1 einstellt.
- ein Button mit dem Symbol einer Weltkugel, der die Kartenansicht auf die alle Bounding Boxes der Strassen umschließendes Rechteck einstellt.
- ein Button mit dem Exit-Symbol, der die Session beendet und auf den Login-View umleitet
Zentraler Bereich:
Hier werden die Gruppen als Accordion gruppiert dargestellt. Der Name in der Titelzeile eines Elements ist der Aliasname der Gruppe bzw. die ID der Gruppe, wenn der Aliasname leer ist.
Dem Namen vorangestellt ist ein keiner Kreis in der Farbe, die in der KArtenansicht für den MArker verwendet wird.
An den Namen angehängt ist der State der Gruppe. Wird eine Nachricht mit Code=200 empfangen wird der zu der in der Nachricht genannten Gruppe gehörende Titel aktualisiert.
Für den Inhalt eines Abschnitts des Accordion werden Informationen und Interaktionen mit der zugehörigen Gruppe implementiert:
- Wenn eine geographische Position bekannt ist, wird ein Button mit Kartenmarkierungssymbol aktiv geschaltet. Ein Druck auf diesen Button zentriert die Karte an dieser Position und stellt die Zoom-Stufe auf 15.
- Neben diesem Button ist ein Progressbar, der abhängig von der Zeitdifferenz der aktuiellen Zeit mit dem Zeitstempel der geographischen Position gesetzt wird:
100% sind bei Zeitdifferenzen unter einer Minute, 0% entsprechen Zeitdifferenzen größer 1 Stunde, dazwischen wird interpoliert.
In der Routine, die auch die Uhrzeit im Header aktualisiert werden für alle Gruppen diese Steuerelemente aktualisiert.
Bei Zeitdifferenzen größer als 1 Stunde wird der Button wieder inaktiv.
Bei Empfang einer Nachricht mit Code=300 werden diese Steuerelemente für alle Gruppen aktualisiert.
Gleichzeitig soll die Position des Markers für dies Gruppe auf der Kartenansicht aktualisiert werden.
Unterhalb davon ist ein Button mit dem Sympol eined Fadenkreuzes. Wird dieser Button gedrückt wird der Cursor der Kartenansicht in ein Fadenkreuz geändert.
In diesem Modus setzt ein Klick in die Karte die geographische Position mit dem aktuellen Zeitstempel auf die geographische Position dieser Gruppe an diese Koordinaten. Es wird danach eine NAchricht mit Code=300 versendet und die Kartenansicht aktualisiert.
Der Vorgang wird abgebrochen und der Cursor wieder zurückgesetzt, wenn erneut auf diesen Button geklickt wird oder die "ESC" Taste gedrückt wird.
Bei Empfang einer Nachricht mit Code=2000 wird mit dem Inhalt der Nachricht ein Textfeld unterhalb des Progressbars überschrieben.
Ein Klick in dieses Textfeld soll einen modalen Dialog starten, in dem alle Nachrichten mit Code>=1000 in Chatform für diese Gruppe dargestellt werden.
Entwickel für diese Views den Code für das Frontend und die notwendigen Anpassungen im Backend.
------8<-----------------
Die Logik des Brokers und das verwendete Protokoll soll auf korrekte Umsetzung untersucht werden.
Der Broker hat die Aufgabe, die Verbindung zu allen Clients (Websockets) zu verwalten,
Nachrichten entsprechend dem Protokoll von einem Client zu mehreren anderen Clients weiterzuleiten und
kurzzeitige Unterbrechungen in der Verbindung zu einem Client mit einer Nachrichten-Queue zu überbrücken.
Dabei muss Nebenläufigkeit berücksichtigt werden.
Welche Nachrichten konkret einem bestimmten Client weitergeleitet werden sollen, folgt aus der Rolle des jeweiligen Clients (also Account/View und eventuell Gruppenverknüpfung des Accounts)
Clients können über entsprechende Nachrichten Änderungen im State einer der Entitäten Gruppe oder Strasse in der Datenbank auslösen.
Gleichzeitig wird diese Zustandsänderung durch Weiterleitung an alle aktiven Clients kommuniziert.
Um neu hinzukommende Clients zu synchronisieren, werden unabhängig vom Broker die aktuellen Zustände per Web API übermittelt,
Die jeweiligen Websessions der Clients werden über Websocketverbindungsabbrüche hinweg anhand einer im Client generierten ID den entsprechenden Queues zugeordnet.
Bei neuen Websessions (d.h. dem Broker noch unbekannten Client-ID's) werden für diesen Client grundsätzlich bestimmte in der Datenbank historisierte Nachrichten initial übermittelt.
Nachrichten werden im JSON-Format verschickt. Die Nachrichten müssen Sender und Empfänger enthalten. Sofern dazu ID's verwendet werden, müssen für die korrekte Darstellung im Client Accountname oder Aliasname mitgesendet werden.
Primäres Merkmal jeder Nachricht ist der Nachrichten-Code, anhand dessen der Broker über die Weiterleitung entscheidet.
Nachfolgend die Beschreibug der Nachrichtencodes soweit bekannt:
- Code=0: Sender ist jeder Client nach Neuladen, mit dem ein Zugriffstoken und die Client-ID zur Authentifizierung dem Broker mitgeteilt wird. Keine weiteren Empfänger. Nur intern für den Broker zur Verwendung.
- Code=1: Sender ist der Broker selbst, der zyklisch (1/Minute) jeden Client ein "ping" sendet und eine Antwort mit Code=2 vom Client erwartet.
- Code=2: Sender ist ein Client als unmittelbare Antwort auf Code=1. Bleibt diese Nachricht aus, kann dies auf den State einer Gruppe Einfluss haben. In der Übersicht im Dashboard ddes Admins wird dies angezeigt.
- Code=99: Sender ist der Broker selbst, ein Admin-Client oder bei Änderung der Account/Gruppen-Zuordnung ein Dispatcher. Die Nachricht wird immer an alle CLients gesendet und soll direkt oder indirekt einen Neustart des Clients auslösen (s.o.). Die Behandlung der Queues im Broker ist oben beschrieben.
- Ein Code < 100 dient nur zu internen Zwecken.
- Code=100: Sender kann ein Dispatcher oder eine Gruppe sein. Der State einer Straße hat sich geändert. Diese Nachricht wird an alle Accounts Dispatcher, Gast, Beobachter und die Gruppen verschickt, die mit dieser Straße verknüpft sind.
- Code=200: Sender ist ein Dispatcher oder eine Gruppe. Diese Nachricht wird an alle Accounts Dispatcher, Beobachter und an die betroffene Gruppe geschickt.
- Code=300: Sender ist eine Gruppe oder ein Dispatcher. Die geographische Position einer Gruppe hat sich geändert. Diese Nachricht wird an alle Accounts Dispatcher, Beobachter und an die betroffene Gruppe geschickt. Inhalt der Nachricht sind die neuen Geokoordinaten und dem auslösenden Account.
- Ein Code >= 1000 soll immer in einer Chatansicht mit "Von -> An", dem Zeitstempel der Nachricht und dem Chat-Text angezeigt werden und dem Nutzer des Clients über einen Infodialog angezigt werden. Diese Nachrichten werden historisiert für einen (konfigurierbaren) Zeitraum (Default 8 Studen).
- Code=1000: Sender ist ein Dispatcher. Die Nachricht wird an alle Accounts des Typs Dispatcher, Beobachter und alle Gruppen (Broadcast) übermittelt.
- Code=1100: Sender ist ein Dispatcher. Die Nachricht wird an alle Accounts des Typs Dispatcher, Beobachter und die eine addressierte Gruppe gesender.
- Code=2000: Sender ist en Client eines Gruppen-Accounts. Die Nachricht wird an alle Accounts des Typs Dispatcher und Beobachter und innerhalb der Gruppe übermittelt.
Bitte erstelle eine Beschreibung des Protokolls und der Brokerlogik im Markdownformatm in der Datei doc/broker.md. Ergänze eventuell fehlende Nachrichtentypen.
Erläutere, an welchen Stellen die Beschreibung vom aktuellen Code-Stand abweicht.
Bau in die Software eine Debugausgabe für die beim Broker eingehenden Nachrichten ein einschließlich einer Ausgabe, an welche Clients diese weitergeleitet werden soll.
------8<-----------------
Aktuell verwaltet der Broker die Verbindungen anhand des Mandanten und des Accounts.
Künftig soll der Broker Verbindungen statt anhand von Accounts anhand der Client-ID verwalten.
Ziel soll sein, dass ein Account auch mehrere Clients betreiben kann.
Dazu muss der Broker selbst umgebaut werden.
Die Client-ID wird in jedem Webview einmalig nach dem Laden generiert. Deshalb muss sie auch nicht im SessionStorage gespeichert werden.
Ich sehe jetzt, dass beispielsweise Code-300 Nachrichten vom Gruppen-Client an den Broker geschickt werden, sie aktualisieren aber nicht die Karte oder sonst ein Element im User Interface.
Gleiches gilt auch für Code-100. Werden diese Nachrichten nicht über den Broker an die anderen Cleints weitergeleitet?
Oder werden sie im Client verworfen?
------8<-----------------
Um gezielt mobile Clients zu synchronisieren, soll der Broker in bestimmten Fällen diese durch eine Push Nachricht wecken.
Dazu soll Google Firebase verwendet werden. Die eigentlichen Kommunikationsinhalte sollen weiterhin über die Websocket-Verbindung transportiert werden.
Die Nachricht über Firebase Cloud Messaging (FCM) soll nur dazu dienen, den Service Worker der PWA zu wecken, die Websocket-Verbindung zu reconnecten,
gequeuete Nachrichten zu empfangen und gegebenenfalls durch einen Popup-Dialog zu visualisieren.
Wenn in den Einstellungen die ständige Übertragung der Eigenpisition aktiv ist, dann soll mindestens ein
Positionsupdate geschickt werden bevor der Service Worker die Arbeit wieder einstellen kann.
FCM transportiert nur das Signal an die PWA, keine Daten der Anwendungen.
Der Broker entscheidet anhand des Client-Typs (also nur bei Gruppen-View oder Dispatcher-Mobil-View), ob überhaupt FCM angewendet wird.
Wenn der Zustand des Clients als offline angenommen wird, dann wird im Fall einer gequeueten Nachricht das Signal über FCM an diesen Client geschickt.
Aber auch bei nicht gequeueten Nachrichten soll nach einer konfigurierbaren Zeitspanne (Default 5 Minuten)
von "offline" Zustand des mobilen Clients ein Aufwach-Signal gesendet werden, um ein Positionsupdate zu ermöglichen. Zusätzlich kann dies auch über einen Button im Dispatcher-View (auch im mobilen) manuell ausgelöst werden, der Button soll das Symbol eines Radarschirms zeigen.
Dokumentiere die Anpassungen im Code und die notwendigen Architekturentscheidungen sowie die Beschränkungen und Konsequenzen bei PWA's als Client für Android und iOS.
Beschreibe in einem eigenen Howto-Dokument, welche Schritte zur Nutzung von Firebase praktisch nötig sind, damit die Code-Änderungen auch wirksam gemacht werden können.
Implementiere die notwendigen Code-Anpassungen.
------8<-----------------