kh-blazor-razor #66
@@ -7,7 +7,7 @@ gitea: none
|
||||
|
||||
In diesem Abschnitt wird meine persönliche Aufgabenstellung im Rahmen des Projektes (`Alumnihub`) beschrieben.
|
||||
|
|
||||
|
||||
### Auftrag / persönliche Aufgabenstellungen
|
||||
### 1.1 Auftrag / persönliche Aufgabenstellungen
|
||||
|
||||
Meine Zuständigkeiten und Verantwortlichkeiten:
|
||||
|
||||
@@ -17,18 +17,26 @@ Meine Zuständigkeiten und Verantwortlichkeiten:
|
||||
- Auswertungen
|
||||
- Schwarzes Brett
|
||||
|
||||
### Motivation
|
||||
### 1.2 Motivation
|
||||
|
gitea-actions
commented
Grammatik und Rechtschreibung: 'entwickel' -> 'entwickle'. 'React.JS' -> 'React.js'. Der erste Satz ist ein Fragment; besser: 'Das Ziel ist das Erlernen von...'. Grammatik und Rechtschreibung: 'entwickel' -> 'entwickle'. 'React.JS' -> 'React.js'. Der erste Satz ist ein Fragment; besser: 'Das Ziel ist das Erlernen von...'.
```suggestion
Das Erlernen von ASP.NET und der Entwicklung mit Blazor und Oqtane. Ich habe Interesse an dem Thema Webentwicklung. Privat entwickle ich schon seit Jahren viel mit React.js.
```
gitea-actions
commented
Grammatik: Die 1. Person Singular von 'entwickeln' ist 'entwickle'. Grammatik: Die 1. Person Singular von 'entwickeln' ist 'entwickle'.
```suggestion
Lernen von ASP.NET und der Entwicklung mit Blazor und Oqtane. Ich habe Interesse an dem Thema Webentwicklung. Privat entwickle ich schon seit Jahren viel mit React.JS.
```
|
||||
|
||||
Lernen von ASP.NET und der Entwicklung mit Blazor und Oqtane. Ich habe Interesse an dem Thema Webentwicklung. Privat entwickle ich schon seit Jahren viel mit React.JS.
|
||||
|
||||
## 2. Anforderungen an das entwickelte Modul bzw. die Funktionalität
|
||||
|
||||
### 2.1 Modulanforderungen / funktionale Anforderungen
|
||||
|
||||
### 2.2 Infrastrukturanforderungen / nicht‑funktionale Anforderungen
|
||||
|
gitea-actions
commented
Stil/Grammatik: Kein Komma vor 'sowie'. 'Einfach' wirkt zudem etwas umgangssprachlich. Stil/Grammatik: Kein Komma vor 'sowie'. 'Einfach' wirkt zudem etwas umgangssprachlich.
```suggestion
Mein Aufgabenbereich umfasst einerseits die Entwicklung eigener Module sowie das Bereitstellen der Services. Als Betriebssystem habe ich mich für Linux entschieden, da ich mit Linux im Serverumfeld die meisten und besten Erfahrungen gemacht habe.
```
|
||||
|
||||
- funktionale / nicht‑funktionale Anforderungen
|
||||
- Use Cases
|
||||
|
gitea-actions
commented
Grammatik und Stil: 'im Lauf' -> 'im Laufe'. '.NET Core 10' wird offiziell nur noch '.NET 10' genannt. Grammatik und Stil: 'im Lauf' -> 'im Laufe'. '.NET Core 10' wird offiziell nur noch '.NET 10' genannt.
```suggestion
Nachdem wir im Unterricht fast ausschließlich mit C# entwickelt haben und nicht in eine komplett unbekannte Entwicklungsumgebung abdriften wollten, haben wir uns für Webentwicklung mit ASP.NET Core 9 und (Upgrade im Laufe der Diplomarbeit auf .NET 10) dem CMS Oqtane entschieden. Auch hier gab es einige Kandidaten:
```
gitea-actions
commented
Grammatik/Stil: 'Laufe' statt 'Lauf'. 'Abdriften' ist sehr umgangssprachlich. Grammatik/Stil: 'Laufe' statt 'Lauf'. 'Abdriften' ist sehr umgangssprachlich.
```suggestion
Auch steht die Wahl der Programmiersprache und des CMS an. Nachdem wir im Unterricht fast ausschließlich mit C# entwickelt haben und nicht in eine komplett unbekannte Entwicklungsumgebung wechseln wollten, haben wir uns für Webentwicklung mit ASP.NET Core 9 und (Upgrade im Laufe der Diplomarbeit auf .NET Core 10) dem CMS Oqtane entschieden.
```
|
||||
|
||||
## 3. Technische Grundlagen
|
||||
## 3. Technisches Umfeld
|
||||
|
||||
Mein Aufgabenbereich umfasst einerseits die Entwicklung eigener Module, sowie das Bereitstellen des Services. Als Betriebssystem habe ich mich für Linux entschieden, einfach, da ich mit Linux im Serverumfeld die meisten und besten Erfahrungen gemacht habe.
|
||||
Mein Aufgabenbereich umfasst einerseits die Entwicklung eigener Module, sowie das Bereitstellen des Services.
|
||||
|
gitea-actions
commented
Rechtschreibung: 'großen und ganzen' wird großgeschrieben. Rechtschreibung: 'großen und ganzen' wird großgeschrieben.
```suggestion
Viel Arbeit mit Partials, welche in der Admin Oberfläche geschieht, aber sehr gut dokumentiert. Im Großen und Ganzen wirkt Umbraco nicht so flexibel.
```
gitea-actions
commented
Rechtschreibung: 'Großen und Ganzen' wird großgeschrieben. Rechtschreibung: 'Großen und Ganzen' wird großgeschrieben.
```suggestion
Viel Arbeit mit Partials, welche in der Admin Oberfläche geschieht, aber sehr gut dokumentiert. Im Großen und Ganzen wirkt Umbraco nicht so flexibel.
```
|
||||
|
||||
### 3.1 Auswahlverfahren
|
||||
|
gitea-actions
commented
Grammatik und Stil: 'Und ein Windows Server würde ich ich...' ist umgangssprachlich und enthält ein doppeltes Wort. 'kostet' ist redundant zu 'Lizenzkosten'. Grammatik und Stil: 'Und ein Windows Server würde ich ich...' ist umgangssprachlich und enthält ein doppeltes Wort. 'kostet' ist redundant zu 'Lizenzkosten'.
```suggestion
Platzhirsch. Bekannt, wird von der DNN Foundation gewartet. Arbeitet mit dem .NET Framework, welches nicht unter Linux läuft. Einen Windows-Server würde ich nicht einfach so im Internet betreiben, abgesehen von den anfallenden Lizenzkosten.
```
gitea-actions
commented
Grammatik/Syntax: 'einen Windows Server' (Akkusativ), Wortwiederholung 'ich ich' und ein fehlendes Verb wie 'stellen'. Grammatik/Syntax: 'einen Windows Server' (Akkusativ), Wortwiederholung 'ich ich' und ein fehlendes Verb wie 'stellen'.
```suggestion
Platzhirsch. Kennt man, wird von der DNN Foundation gewartet. Arbeitet mit dem Dotnet Framework, welches nicht unter Linux läuft. Und einen Windows Server würde ich nicht einfach so ins Internet stellen, abgesehen von den Lizenzkosten, die anfallen würden.
```
|
||||
|
||||
#### 3.1.1 Entscheidungsfindung CMS
|
||||
|
||||
Auch steht die Wahl der Programmiersprache und des CMS an. Nachdem wir im Unterricht fast ausschließlich mit C# entwickelt haben und nicht in eine komplett unbekannte Entwicklungsumgebung abdriften wollten, haben wir uns für die Webentwicklung mit ASP.NET Core 9 (Upgrade im Lauf der Diplomarbeit auf .NET Core 10) und dem CMS Oqtane entschieden. Auch hier gab es einige Kandidaten:
|
||||
|
gitea-actions
commented
Grammatik: Genitiv 'des Oqtane Frameworks'. Grammatik: Genitiv 'des Oqtane Frameworks'.
```suggestion
Am Ende haben wir uns für das Oqtane Framework trotz seiner schlechten Dokumentation entschieden.
```
|
||||
|
||||
@@ -43,6 +51,10 @@ Auch steht die Wahl der Programmiersprache und des CMS an. Nachdem wir im Unterr
|
||||
|
||||
Insbesondere aufgrund seiner sehr hohen Flexibilität, haben wir uns am Ende für Oqtane entschieden.
|
||||
|
||||
|
gitea-actions
commented
Stil: 'Webseiten' bezieht sich meist auf einzelne Seiten, 'Websites' oder 'Webauftritte' auf das gesamte System. Stil: 'Webseiten' bezieht sich meist auf einzelne Seiten, 'Websites' oder 'Webauftritte' auf das gesamte System.
```suggestion
Oqtane ist ein Framework und CMS zur Entwicklung von Websites mithilfe von ASP.NET und Blazor. [^5] Ein Oqtane-System besteht aus mehreren Komponenten.
```
|
||||
#### 3.1.2 Entscheidungsfindung restliche Infrastruktur
|
||||
|
||||
Als Betriebssystem habe ich mich für Linux entschieden, einfach, da ich mit Linux im Serverumfeld die meisten und besten Erfahrungen gemacht habe.
|
||||
|
||||
|
gitea-actions
commented
Rechtschreibung: Im Deutschen schreibt man eher 'Webseite'. Rechtschreibung: Im Deutschen schreibt man eher 'Webseite'.
```suggestion
Ein `Module` (Modul) soll neue Funktionalitäten in das CMS hinzufügen und ein `Theme` soll die ganze Gestaltung der Webseite (die Shell) festlegen. [^6]
```
|
||||
Im Bereich der Datenbanken musste ich mir ein paar Fragen stellen:
|
||||
|
||||
1. Auf welche Art Datenbank setzen wir? SQL, NoSQL, Graph, ...
|
||||
@@ -51,9 +63,7 @@ Im Bereich der Datenbanken musste ich mir ein paar Fragen stellen:
|
||||
|
||||
Es war von Anfang an klar, dass es ein SQL-basiertes System wird, da wir im Team nur mit SQL-basierten Systemen Erfahrungen haben. Außerdem unterstützt unser CMS (Oqtane) nur SQL-basierte Systeme. In der Linuxwelt kommen jetzt nur noch ein paar Datenbankmanagementsysteme in die Auswahl: PostgreSQL, MySQL / MariaDB, SQLite. Da ist die Wahl auf PostgreSQL gefallen. Grund dafür war meine Vorerfahrung mit diesem Datenbankmanagementsystem, welche ich in meinem Nebenjob errungen habe.
|
||||
|
||||
|
gitea-actions
commented
Rechtschreibung: 'Inferfaces' -> 'Interfaces', 'Client-Staruplogik' -> 'Client-Startuplogik'. Rechtschreibung: 'Inferfaces' -> 'Interfaces', 'Client-Staruplogik' -> 'Client-Startuplogik'.
```suggestion
Im Client-Projekt liegen Code und Razor-Komponenten für den Client. Also Client-Startuplogik, Client-Services (+ Interfaces dafür, die Services hier sollen lediglich die Server-Services über HTTP aufrufen), Ressourcendateien (.resx), die Komponenten / das User Interface und die Moduldefinitionen für jedes Modul.
```
gitea-actions
commented
Stil: 'Quellcode' statt 'Sourcecode' (optionaler Stilvorschlag für Deutsch). Stil: 'Quellcode' statt 'Sourcecode' (optionaler Stilvorschlag für Deutsch).
```suggestion
Im Server-Projekt liegt der Quellcode, welcher serverseitig ausgeführt werden soll. In der Praxis bedeutet das: alle Repositories, Controller, Manager, Migrationen und Server-Services (entwickelt nach einem Interface definiert im Client) und Server-Startuplogik.
```
|
||||
# Technologie
|
||||
|
||||
## Was ist Oqtane? Architektur von Oqtane?
|
||||
### 3.2 Beschreibung und Architektur von Oqtane
|
||||
|
||||
|
gitea-actions
commented
Rechtschreibung: Tippfehler in 'Startuplogik' und 'Interfaces'. Rechtschreibung: Tippfehler in 'Startuplogik' und 'Interfaces'.
```suggestion
Im Client-Projekt liegen Code und Razor-Komponenten für den Client. Also Client-Startuplogik, Client-Services (+ Interfaces dafür, die Services hier sollen lediglich die Server-Services über HTTP aufrufen), Ressourcendateien (.resx), die Komponenten / das User Interface und die Moduldefinitionen für jedes Modul.
```
|
||||
Oqtane ist ein Framework und CMS zur Entwicklung von Webseiten mithilfe von ASP.NET und Blazor. [^5] Ein Oqtane-System besteht aus mehreren Komponenten.
|
||||
|
||||
@@ -65,7 +75,7 @@ Ein `Module` (Modul) soll neue Funktionalitäten in das CMS hinzufügen und ein
|
||||
|
||||
[^6]: https://docs.oqtane.org/dev/extensions/index.html
|
||||
|
||||
|
gitea-actions
commented
Rechtschreibung: 'mitels' -> 'mittels', 'Challanges' -> 'Challenges'. 'NginX' -> 'Nginx'. Rechtschreibung: 'mitels' -> 'mittels', 'Challanges' -> 'Challenges'. 'NginX' -> 'Nginx'.
```suggestion
In diesem Kapitel erkläre ich wie die ausgewählten Komponenten zusammenspielen. Wir verwenden Nginx als Reverse Proxy, welcher bei uns die SSL Terminierung macht. Das Zertifikat, welches verwendet wird, wird von Let's Encrypt bereit gestellt und mittels HTTP-Challenges und dem Certbot auf dem Server aktualisiert und verwaltet. Oqtane selber läuft als Systemd-Service im Kestrel Backend. Kestrel ist ein kleiner Webserver, welcher in das ASP.NET Core Framework eingebaut worden ist. Oqtane (bzw. der ASP.NET Core Server "Kestrel") hört auf der Loopback IP und Port 5000. Damit ist Oqtane nur durch Nginx erreichbar. PostgreSQL ist die Datenbank in dem System: Sie hört wieder auf der Loopback IP und Port 5432.
```
gitea-actions
commented
Grammatik/Rechtschreibung: Komma nach 'erkläre ich'. 'bereitgestellt' zusammen, 'mittels' mit zwei t, 'Challenges' korrigiert. Grammatik/Rechtschreibung: Komma nach 'erkläre ich'. 'bereitgestellt' zusammen, 'mittels' mit zwei t, 'Challenges' korrigiert.
```suggestion
In diesem Kapitel erkläre ich, wie die ausgewählten Komponenten zusammenspielen. Wir verwenden Nginx als Reverse Proxy, welcher bei uns die SSL-Terminierung macht. Das Zertifikat, welches verwendet wird, wird von Let's Encrypt bereitgestellt und mittels HTTP-Challenges und dem Certbot auf dem Server aktualisiert und verwaltet. Oqtane selbst läuft als Systemd-Service im Kestrel-Backend. Kestrel ist ein kleiner Webserver, welcher in das ASP.NET Core Framework eingebaut worden ist. Oqtane (bzw. der ASP.NET Core Server 'Kestrel') hört auf der Loopback-IP und Port 5000. Damit ist Oqtane nur durch Nginx erreichbar. PostgreSQL ist die Datenbank im System: Sie hört wieder auf der Loopback-IP und Port 5432.
```
|
||||
### Architektur eines Moduls
|
||||
#### 3.2.1 Architektur eines Moduls
|
||||
|
||||
Ein Modul in Oqtane besteht aus vier Projekten:
|
||||
|
||||
@@ -79,7 +89,7 @@ Ein Modul in Oqtane besteht aus vier Projekten:
|
||||
- Beim Debug werden die DLLs, PDBs und statischen Assets wie Skripte und Stylesheets der drei anderen Projekte in den bereits gebauten Oqtane.Server `oqtane.framework/oqtane.server/bin/debug/net10.0/...` kopiert.
|
||||
- Beim Release wird ein NuGet-Paket erstellt und unter oqtane.framework/oqtane.server/Packages abgelegt. Dort abgelegte NuGet-Pakete werden beim nächsten Start des Oqtane Servers installiert (Datenbank Migrationen werden gemacht und die Pakete entpackt).
|
||||
|
||||
## Systemarchitektur (Postgres / Oqtane / Nginx)
|
||||
### 3.3 Zusammenspiel der Infrastruktur
|
||||
|
||||
In diesem Kapitel erkläre ich wie die ausgewählten Komponenten zusammenspielen. Wir verwenden NginX als Reverse Proxy, welcher bei uns die SSL Terminierung macht. Das Zertifikat, welches verwendet wird, wird von Let's Encrypt bereit gestellt und mittels HTTP-Challenges und dem Certbot auf dem Server aktualisiert und verwaltet. Oqtane selber läuft als Systemd-Service im Kestrel Backend. Kestrel ist ein kleiner Webserver, welcher in das ASP.NET Core Framework eingebaut worden ist. Oqtane (bzw. der ASP.NET Core Server "Kestrel") hört auf der Loopback IP und Port 5000. Damit ist Oqtane nur durch NginX erreichbar. PostgreSQL ist die Datenbank in dem System: Sie hört wieder auf der Loopback IP und Port 5432. In der folgenden Grafik ist das System Schematisch dargestellt.
|
||||
|
gitea-actions
commented
Rechtschreibung: 'High-Port' statt 'Hight-Port'. Rechtschreibung: 'High-Port' statt 'Hight-Port'.
```suggestion
Zusätzlich gab es einen Administrationszugang zu den Servern, welcher über SSH möglich war. Dieser wurde für die Installation und Konfiguration der einzelnen Komponenten verwendet. Bei Hetzner war dieser Zugang nur über eine Wireguard VPN erreichbar. Bei der Schule war dieser Zugang direkt (über einen High-Port) möglich. Und bei LiveDesign war dieser Zugang wieder über eine VPN geregelt. Anfänglich mit SSL VPN, später mit einem IPSEC / Strongswan.
```
|
||||
|
||||
@@ -108,9 +118,9 @@ Zusätzlich gab es einen Administrationszugang zu den Servern, welcher über SSH
|
||||
|
||||
Die VPN basierten Zugänge sind tendenziell schwieriger zu finden und auszunutzen, während die Lösung in der Schule mittels Highport den SSH Service öffentlich erreichbar macht. Durch den `Highport` ist der SSH Service schwieriger zu finden. Zur Authentifizierung mit SSH verwenden wir SSH-Keys, da diese durch ihre komplexität sicherer sind, als Passwörter.
|
||||
|
||||
## Entwicklung mit ASP.NET (Was ist Blazor? / Was ist Razor? / Kestrel)
|
||||
### 3.4 Entwicklung mit ASP.NET
|
||||
|
||||
### Blazor [^7]
|
||||
#### 3.4.1 Blazor [^7]
|
||||
|
||||
Blazor ist ein kostenloses und quelloffenes Web-Framework, welches es möglich macht Benutzeroberflächen für Web-Browser, basierend auf C# and HTML, zu erstellen. Es wird von Microsoft als teil des ASP.NET Core Frameworks entwickelt.
|
||||
|
||||
@@ -155,15 +165,11 @@ Razor hat auch eine Reihe an Keywords, wie zum Beipsiel (nur Auszugsweise, bzw.
|
||||
|
||||
[^7]: https://en.wikipedia.org/wiki/Blazor
|
||||
|
||||
### Kommunikation zwischen Front- und Backend
|
||||
#### 3.4.2 Kommunikation zwischen Front- und Backend
|
||||
|
||||
Wie Front- und Backend miteinander interagieren hängt hauptsächlich vom Render Modus ab. Oqtane kann auf verschiedene Arten betrieben werden. Hierbei ist es dem Modulentwickler ziemlich egal, welche Art der Kommunikation (WebSockets, HTTP Long-Polling, REST) verwendet wird.
|
||||
Wie Front- und Backend miteinander interagieren hängt hauptsächlich vom Render-Modus ab. Oqtane kann auf verschiedene Arten betrieben werden. Hierbei ist es dem Modulentwickler ziemlich egal, welche Art der Kommunikation (WebSockets, HTTP Long-Polling, REST) verwendet wird. SignalR ist eine Library aus dem ASP.NET Framework, welche es möglich macht, Server zu Client Kommunikation zu betreiben. Oqtane verwendet SignalR im `Interactive Server (SignalR)` Render-Modus.
|
||||
|
||||
#### SignalR
|
||||
|
||||
SignalR ist eine Library aus dem ASP.NET Framework, welche es möglich macht, Server zu Client Kommunikation zu betreiben. Oqtane verwendet SignalR im `Interactive Server (SignalR)` Render-Modus.
|
||||
|
||||
## Dependency Injection
|
||||
### 3.5 Dependency Injection
|
||||
|
||||
Dependency Injection ist ein Entwurfsmuster, bei dem die Abhängigkeiten eines Objekts nicht von diesem selbst erzeugt, sondern von außen „injiziert“ werden.
|
||||
|
||||
@@ -173,7 +179,7 @@ In den folgenden beiden Kapiteln wird das Dependency Inversion Principle und das
|
||||
|
||||
[^9]: https://martinfowler.com/articles/injection.html
|
||||
|
||||
### Dependency Inversion Principle [^1]
|
||||
#### 3.5.1 Dependency Inversion Principle [^1]
|
||||
|
||||
Das Dependency-Inversion-Principle (DIP / auf Deutsch: Abhängigkeits-Umkehr-Prinzip) ist eines von den fünf `SOLID` Prinzipien in der Softwareentwicklung.
|
||||
|
||||
|
gitea-actions
commented
Rechtschreibung: 'dannach' -> 'danach'. Rechtschreibung: 'dannach' -> 'danach'.
```suggestion
Beim Instanziieren einer Klasse werden alle im Konstruktor erwarteten Dependencies bereitgestellt, bzw. selbst instanziiert und danach bereitgestellt. [^4]
```
|
||||
@@ -207,7 +213,7 @@ architecture-beta
|
||||
|
||||
Das High-Level-Modul ruft lediglich eine Abstraktion eines Low-Level-Moduls auf, welche von einem, oder mehreren Low-Level-Modulen implementiert wurde. Für das High-Level-Modul ist es hier egal, welches Low-Level-Modul die Implementierung bereitstellt. Dadurch erhält man einen viel modulareren Aufbau in der Software. Die einzelnen Module sind auch leichter austauschbar und testbar. Genau diese Modularität macht Dependency Injection möglich.
|
||||
|
||||
### Microsoft Dependency Injection Framework
|
||||
#### 3.5.2 Microsoft Dependency Injection Framework
|
||||
|
||||
Dependency Injektion ist in .NET genau so wie Konfiguration, Protokollierung und das Optionsmuster ins Framework integriert. [^4]
|
||||
|
||||
@@ -279,9 +285,7 @@ architecture-beta
|
||||
|
||||
|
gitea-actions
commented
Rechtschreibung: 'einzurichten' statt 'zum einrichten'. 'Oktober'. 'auseinandergesetzt'. Rechtschreibung: 'einzurichten' statt 'zum einrichten'. 'Oktober'. 'auseinandergesetzt'.
```suggestion
Ein Learning, welches doch relativ schnell aufkam, ist im Bereich der IT eigentlich kein unbekanntes. Wir hatten dieses Learning relativ bald, im Frühling 2025, als die ersten Probleme mit dem Deployment von Oqtane aufkamen. Oqtane war zwar in unserer Entwicklungsumgebung sehr einfach einzurichten gewesen, das Deployment in der Cloud von Hetzner war jedoch geplagt von Problemen. Im Zeitraum von Mai bis Oktober hatten wir keine laufende Produktivumgebung. Dadurch sind wir mit dieser Diplomarbeit auch in [Zeitverzug](#Arbeitszeiteinschätzung-und-verzug) gekommen. Hätte ich mich vor dem Start der Diplomarbeit mit dem Deployment von Oqtane auseinandergesetzt, dann wäre das in [Probleme mit Oqtane](#Probleme mit Oqtane) beschriebene Problem früher aufgekommen und der Zeitverzug wäre nicht so groß oder noch ganz vermeidbar gewesen.
```
|
||||
[^4]: https://learn.microsoft.com/en-us/dotnet/core/extensions/dependency-injection/overview
|
||||
|
||||
# Continuous Integration
|
||||
|
||||
## Automatisierter Build und Release Prozess mithilfe von Gitea Actions.
|
||||
### 3.6 Continuous Integration
|
||||
|
||||
|
gitea-actions
commented
Rechtschreibung: 'vollkommen', 'Hälfte', 'Unterschreiben', 'Zeitplan'. Rechtschreibung: 'vollkommen', 'Hälfte', 'Unterschreiben', 'Zeitplan'.
```suggestion
Nachdem ich mich von Anfang an vollkommen in das Deploymentproblem von Oqtane gestürzt habe, habe ich meine Rolle als Teamleitung etwas schleifen gelassen. Dadurch fehlte bei einigen Teammitgliedern initial die Identifikation mit dem Projekt und in weiterer Folge auch die Motivation, an diesem Projekt mitzuarbeiten. Nachdem im Verlauf des Frühlings und über den Sommer von der Hälfte des Teams trotz Besprechungen und Mahnungen keine Beiträge zu dem Projekt kamen, haben Hr. Prof. Gürth und ich uns dazu entschieden, uns von 2 Personen vor dem Unterschreiben des Projektantrages zu trennen. Grund dazu war die Angst, die mangelnde Motivation zieht das restliche Team mit hinunter. Wir wollten uns trotz des Downsizings nicht an Funktionalitäten sparen und haben uns für das nächste halbe bis dreiviertel Jahr einen ziemlich strikten Zeitplan vorgenommen.
```
|
||||
Gitea, das Versionskontrollsystem dieser Diplomarbeit, hat einen Continuous-Integration-System eingebaut. Im Kern ist es baugleich zu den GitHub-Pipelines. Man kann im `.gitea/workflow` Ordner `.yml` Dateien ablegen, welche dann das Verhalten der Workflows definieren.
|
||||
|
||||
@@ -301,72 +305,29 @@ Anwendungen von Gitea Actions bei dieser Diplomarbeit:
|
||||
- PM Repository:
|
||||
> Zum automatischen Überprüfen der Dokumente, unter anderem, mithilfe von KI, wie zum Beispiel Gemini.
|
||||
|
||||
# Projektmanagement
|
||||
### 3.7 Debian Paket
|
||||
|
||||
## Scrum
|
||||
TODO
|
||||
|
||||
## YouTrack
|
||||
## 4 Projektmanagement
|
||||
|
||||
## Gitea (mit Issues)
|
||||
### 4.1 Scrum
|
||||
|
||||
## Git
|
||||
### 4.2 YouTrack
|
||||
|
||||
## Kommunikation
|
||||
### 4.3 Gitea (mit Issues)
|
||||
|
||||
# Learnings
|
||||
### 4.4 Git
|
||||
|
||||
## Produktion != Staging
|
||||
### 4.5 Kommunikation
|
||||
|
||||
Ein Learning, welches doch relativ schnell aufkam ist im Bereich der IT eigentlich kein unbekanntes. Wir hatten dieses Learning relativ bald, im Frühling 2025, als die ersten Probleme mit dem Deployment von Oqtane aufkamen. Oqtane war zwar in unserer Entwicklungsumgebung sehr einfach zum einrichten gewesen, das Deployment in der Cloud vom Hetzner war jedoch geplagt von Problemen. Im Zeitraum von Mai bis Okober hatten wir keine laufende Produktivumgebung. Dadurch sind wir mit dieser Diplomarbeit auch in [Zeitverzug](#Arbeitszeiteinschätzung-und-verzug) gekommen. Hätte ich mich vor dem Start der Diplomarbeit mit dem Deployment von Oqtane auseinander gesetzt, dann wäre das in [Probleme mit Oqtane](#Probleme mit Oqtane) beschriebene Problem früher aufgekommen und der Zeitverzug wäre nicht so groß, oder noch ganz vermeidbar gewesen.
|
||||
## 5 Module
|
||||
|
||||
## Teamleitung (Motivation / Downsizing)
|
||||
|
||||
Nachdem ich mich von Anfang an volkommen in das Deploymentproblem von Oqtane gestürzt habe, habe ich meine Rolle als Teamleitung etwas schleifen lassen. Dadurch fehlte bei einigen Teammitgliedern initial die Identifikation mit dem Projekt und in weitererfolge auch die Motivation an diesem Projekt mitzuarbeiten. Nachdem im Verlauf des Frühlings und über den Sommer von der hälfte des Teams trotz Besprechungen und Mahnungen keine Beiträge zu dem Projekt kamen, haben Hr. Prof. Gürth und ich uns dazu entschieden uns von 2 Personen vor unterschreiben des Projektantrages zu trennen. Grund dazu war die Angst, die mangelnde Motivation zieht das restliche Team mit hinunter. Wir wollten uns trotz des Downsizings nicht an Funktionalitäten sparen und haben uns für das nächste halbe bis dreiviertel Jahr einen ziemlich strikten Zeiplan vorgenommen.
|
||||
|
||||
## Arbeitszeiteinschätzung (Zeitverzug)
|
||||
|
||||
Ein wesentliches Learning aus dem Projektverlauf war die Diskrepanz zwischen der initialen Planung und dem tatsächlichen Aufwand. Ursprünglich wurde der Zeitaufwand für das Aufsetzen der Infrastruktur und die Einarbeitung in das Oqtane-Framework auf etwa drei Wochen geschätzt. In der Realität nahm dieser Prozess jedoch mehrere Monate in Anspruch.
|
||||
|
||||
Es gibt mehrere Gründe dafür:
|
||||
|
||||
- `Fehlende oder nur schlechte Dokumentation von Oqtane`: Einige Probleme im Deployment wurden in langer und mühseliger Arbeit auseinander gebrochen und in weitere immer kleinere Probleme unterteilt. Dadurch, dass wir alle keine Erfahrung mit der Entwicklung und dem Deployment von ASP.NET Code Anwendungen hatten und die Dokumentation doch schlecht war, blieb uns manchmal nichts anderes übrig als mit WireShark den Netzwerktraffic mit zu schneiden und nebenbei im Git Repository die geloggten Zeilen Code zu finden und so das Framework von innen heraus kennen zu lernen. Dadurch hatte ich dann nach einer Einarbeitungszeit von 4 Monaten ziemlich jede Stelle im Sourcecode von Oqtane gesehen und finde mich um das schneller zurecht.
|
||||
- `Team-Konsolidierung`: Durch das notwendige Downsizing des Teams mussten Aufgaben neu verteilt werden, was die individuelle Arbeitslast erhöhte und die Konzentration auf die Kernentwicklung zeitweise verzögert hat.
|
||||
- `Abhängigkeit von der Infrastruktur`: Dadurch, dass wir bis in den Oktober / November hinein nicht wussten, ob wir weiter bei Oqtane bleiben können, haben die anderen Teammitglieder nicht mit der sinnvollen Entwicklung ihrer Module starten können. Zitat: "Und was wenn wir am Ende doch noch das CMS umstellen müssen?" => Auch wenn der Auftrag war, mit der Modulentwicklung zu starten war die Motivation meiner Teammitglieder nicht so hoch. Selbst wenn sie nicht direkt von der Infrastruktur mit der Ausführung ihrer Aufgaben abhängig waren, motiviert waren sie wegen der Umstände auch nicht.
|
||||
|
||||
Reaktion auf den Verzug:
|
||||
Um das Projektziel dennoch zu erreichen, wurde der Zeitplan im Herbst 2025 massiv gestrafft. Durch die Umstellung auf einen strikteren 14-tägigen Sprint-Rhythmus und die Priorisierung von Core-Funktionalitäten (MVP-Ansatz) konnte der Rückstand teilweise aufgeholt werden.
|
||||
|
||||
> Fazit: Die Erfahrung zeigt, dass gerade bei "Nischen-Frameworks" wie Oqtane ein deutlich höherer Puffer für die Einarbeitungs- und Infrastrukturphase (Faktor 2 bis 3 der ursprünglichen Schätzung) eingeplant werden muss.
|
||||
|
||||
`90% fertig, oder fertig?`: Es gibt einige "Regeln", wie: das `Paretoprinzip`, `Hofstadter’s Law` und die `90-90 Regel`. Letztere wurde im Jahr 1985 von Jon Bentley in einer Kolumne "Programming pearls" veröffentlicht. Ausgeschrieben lautet sie:
|
||||
|
||||
> [Rule of Credibility] The first 90 percent of the code accounts for the first 90 percent of the development time. The remaining 10 percent of the code accounts for the other 90 percent of the development time.
|
||||
> (Jon Bentley. 1985. Programmimg pearls. Commun. ACM 28, 9 (Sept. 1985), 896–901. https://doi.org/10.1145/4284.315122) [^8]
|
||||
> Diese Diplomarbeit liefert weitere Evidenz, dass diese Faustregel stimmt.
|
||||
|
||||
[^8]: https://dl.acm.org/doi/10.1145/4284.315122
|
||||
|
||||
## Sprints und Meetings (in Zukunft ja asynchron)
|
||||
|
||||
Ein zentrales Problem in unserer ursprünglichen Arbeitsweise war die Kopplung von Besprechungsterminen mit festen „Commit-Deadlines“ (dem Ende des aktuellen Sprint zyklusses). Da wir uns einmal pro Woche für sechs Stunden am Stück trafen, entstand ein destruktives Muster:
|
||||
|
||||
- Der "Last-Minute-Commit"-Druck: In den Stunden unmittelbar vor dem Meeting wurden Aufgaben unter Zeitdruck abgeschlossen, um im Meeting Fortschritte präsentieren zu können. Dies führte dazu, dass unfertiger oder unzureichend getesteter Code („Quick and Dirty“) in das Repository gepusht wurde.
|
||||
- Fehlende Review-Kultur: Da die Commits erst kurz vor dem Meeting eintrafen, blieb dem restlichen Team keine Zeit für fundierte Code-Reviews. Die Besprechungszeit wurde somit für die Fehlersuche statt für strategische Planung genutzt.
|
||||
- Ineffizienz: Lange Präsenz-Meetings blockierten wertvolle Entwicklungszeit, ohne die technische Qualität zu steigern.
|
||||
|
||||
Lösungsansatz: Meetings und Besprechungen asynchron zueinander setzen.
|
||||
|
||||
- Asynchrone Daily-Updates: Statusberichte erfolgen schriftlich (z. B. in Gitea Issues oder YouTrack), nicht mehr in stundenlangen Call-Marathons. Das nimmt den zeitlichen Druck vom einzelnen Entwickler. Oder zumindest in kurzen Commitnachrichten, welche am Ende des Tages automatisch an alle Teammitglieder zum überblick gesendet werden (eventuell mit @username tagging, um eine Person nochmal genau anzusprechen)
|
||||
- Review-First-Policy: Ein Feature gilt erst dann als „fertig“, wenn es einen asynchronen Code-Review-Prozess durchlaufen hat. Das Meeting dient nur noch der Klärung von Blockern, nicht der Präsentation von Code. Das war eigentlich schon von Anfang an in unserer `Definition of Done` festgelegt worden.
|
||||
- Entkoppelung von Meeting und Deadline: Meetings sollten der Synchronisation dienen, während die Abgabe von Arbeitspaketen kontinuierlich (Continuous Integration) erfolgen muss, um Lastspitzen (in der [Gitea Actions](#Continuous Integration) Pipeline) am Tag der Besprechung zu vermeiden.
|
||||
|
||||
# Modules
|
||||
|
||||
## Admin Modules
|
||||
### 5.1 Admin Modules
|
||||
|
||||
Eine C#-Solution, welche einige Module, welche für den Admineinsatz geschrieben worden sind beinhaltet. Dieses Modul besteht aus 3 Teilmodulen. Einem Modul für den Versand von Rundmails, eines für die Einstellung von der Token Lebenszeit bei Tokens, welche per E-Mail verschickt werden und eines, welches das Reporting-System übernimmt.
|
||||
|
||||
### Mass Mailing
|
||||
#### 5.2 Mass Mailing
|
||||
|
||||
Das Mass Mailer Modul ist eine administrative Erweiterung für den Alumnihub, die es dem Vorstand ermöglicht, personalisierte Rundschreiben an alle registrierten Mitglieder zu versenden. Da die Pflege der Mitgliederdaten direkt im CMS erfolgt, bietet dieses Modul eine nahtlose Integration ohne den Export von CSV-Listen in externe Newsletter-Tools.
|
||||
|
||||
@@ -376,7 +337,7 @@ Für den tatsächlichen Versand der E-Mails nutzen wir den Cloud-Dienst Brevo. D
|
||||
|
||||
`Batch-Processing`: Mails werden nicht sofort ("Fire and Forget") versendet, sondern in eine Versandwarteschlange geschrieben. Nachdem schon die Notifications Infrastruktur, welche sich auch um den Mail versand kümmert, ins Framework eingebaut worden ist, nutzen wir diese geleich und `schedulen` unsere E-Mails. Immer 100 Mails alle 24 Stunden bis alle Ziele die Mails erhalten haben. Das Limit von 100 / Tag ist konservativ sehr niedrig angesetzt, damit funktionen wie Passwort Reset Mails nicht (leicht) dadurch beeinflusst werden können.
|
||||
|
||||
### Token Lifetime
|
||||
#### 5.3 Token Lifetime
|
||||
|
||||
Das Token Lifetime Modul wurde geschrieben, um die Token-Lebenszeit konfigurierbar zu machen. Notwendig war das, um die Passwort Reset Links im initialen Mail versand länger gultig sein zu lassen. Durch das `Batch Processing` war es Möglich, dass eine Mail erst Tage nach erstellen des Links hinaus geschickt wird und bei einer Standard Ablaufdauer von 2 Tagen sind machne Links schon ungültig, bis sie den Mail Server erreichen. Ziel war es, die Änderung der Lebenszeit für Administratoren im User Interface im Admin Bereich möglich zu machen.
|
||||
|
||||
@@ -393,7 +354,7 @@ Es gibt 2 Möglichkeiten, wie man dieses Problem Lösen kann:
|
||||
|
||||
[^11]: https://www.cs.umd.edu/projects/syschat/raceConditions.pdf
|
||||
|
||||
### Reporting System
|
||||
#### 5.4 Reporting System
|
||||
|
||||
Eine weitere Anforderung der Diplomarbeit war es Einträge in Modulen wie der `Hall of Fame`, dem `Schwarzen Brett` und dem Premium Bereich (`Engineer Applications`) melden zu können. Am Anfang war es wichtig, dass jeder schnell vorrankommt, allerdings haben wir die Kommunikation Teamintern ein wenig verschlafen und dadurch ein paar Funktionen doppelt geschrieben. Dadurch kam es zu inkonsistenzen in der Verwendung der unterschiedlichen Reporting Systeme. Deswegen haben wir uns am Ende für eine globales Reporting System entschieden.
|
||||
|
||||
@@ -435,6 +396,53 @@ Die Implementierung des IReportingComponents stellt nur eine Property (`ReportTy
|
||||
|
||||
Die Bereitstellund des Moduls geschieht im `AdminModules` Modul.
|
||||
|
||||
## Event Registration
|
||||
### 5.5 Event Registration
|
||||
|
||||
## Schwarzes Brett
|
||||
### 5.6 Schwarzes Brett
|
||||
|
||||
## 6 Learnings
|
||||
|
||||
### 6.1 Produktion != Staging
|
||||
|
||||
Ein Learning, welches doch relativ schnell aufkam ist im Bereich der IT eigentlich kein unbekanntes. Wir hatten dieses Learning relativ bald, im Frühling 2025, als die ersten Probleme mit dem Deployment von Oqtane aufkamen. Oqtane war zwar in unserer Entwicklungsumgebung sehr einfach zum einrichten gewesen, das Deployment in der Cloud vom Hetzner war jedoch geplagt von Problemen. Im Zeitraum von Mai bis Okober hatten wir keine laufende Produktivumgebung. Dadurch sind wir mit dieser Diplomarbeit auch in [Zeitverzug](#Arbeitszeiteinschätzung-und-verzug) gekommen. Hätte ich mich vor dem Start der Diplomarbeit mit dem Deployment von Oqtane auseinander gesetzt, dann wäre das in [Probleme mit Oqtane](#Probleme mit Oqtane) beschriebene Problem früher aufgekommen und der Zeitverzug wäre nicht so groß, oder noch ganz vermeidbar gewesen.
|
||||
|
||||
### 6.2 Teamleitung (Motivation / Downsizing)
|
||||
|
||||
Nachdem ich mich von Anfang an volkommen in das Deploymentproblem von Oqtane gestürzt habe, habe ich meine Rolle als Teamleitung etwas schleifen lassen. Dadurch fehlte bei einigen Teammitgliedern initial die Identifikation mit dem Projekt und in weitererfolge auch die Motivation an diesem Projekt mitzuarbeiten. Nachdem im Verlauf des Frühlings und über den Sommer von der hälfte des Teams trotz Besprechungen und Mahnungen keine Beiträge zu dem Projekt kamen, haben Hr. Prof. Gürth und ich uns dazu entschieden uns von 2 Personen vor unterschreiben des Projektantrages zu trennen. Grund dazu war die Angst, die mangelnde Motivation zieht das restliche Team mit hinunter. Wir wollten uns trotz des Downsizings nicht an Funktionalitäten sparen und haben uns für das nächste halbe bis dreiviertel Jahr einen ziemlich strikten Zeiplan vorgenommen.
|
||||
|
||||
### 6.3 Arbeitszeiteinschätzung (Zeitverzug)
|
||||
|
||||
Ein wesentliches Learning aus dem Projektverlauf war die Diskrepanz zwischen der initialen Planung und dem tatsächlichen Aufwand. Ursprünglich wurde der Zeitaufwand für das Aufsetzen der Infrastruktur und die Einarbeitung in das Oqtane-Framework auf etwa drei Wochen geschätzt. In der Realität nahm dieser Prozess jedoch mehrere Monate in Anspruch.
|
||||
|
||||
Es gibt mehrere Gründe dafür:
|
||||
|
||||
- `Fehlende oder nur schlechte Dokumentation von Oqtane`: Einige Probleme im Deployment wurden in langer und mühseliger Arbeit auseinander gebrochen und in weitere immer kleinere Probleme unterteilt. Dadurch, dass wir alle keine Erfahrung mit der Entwicklung und dem Deployment von ASP.NET Code Anwendungen hatten und die Dokumentation doch schlecht war, blieb uns manchmal nichts anderes übrig als mit WireShark den Netzwerktraffic mit zu schneiden und nebenbei im Git Repository die geloggten Zeilen Code zu finden und so das Framework von innen heraus kennen zu lernen. Dadurch hatte ich dann nach einer Einarbeitungszeit von 4 Monaten ziemlich jede Stelle im Sourcecode von Oqtane gesehen und finde mich um das schneller zurecht.
|
||||
- `Team-Konsolidierung`: Durch das notwendige Downsizing des Teams mussten Aufgaben neu verteilt werden, was die individuelle Arbeitslast erhöhte und die Konzentration auf die Kernentwicklung zeitweise verzögert hat.
|
||||
- `Abhängigkeit von der Infrastruktur`: Dadurch, dass wir bis in den Oktober / November hinein nicht wussten, ob wir weiter bei Oqtane bleiben können, haben die anderen Teammitglieder nicht mit der sinnvollen Entwicklung ihrer Module starten können. Zitat: "Und was wenn wir am Ende doch noch das CMS umstellen müssen?" => Auch wenn der Auftrag war, mit der Modulentwicklung zu starten war die Motivation meiner Teammitglieder nicht so hoch. Selbst wenn sie nicht direkt von der Infrastruktur mit der Ausführung ihrer Aufgaben abhängig waren, motiviert waren sie wegen der Umstände auch nicht.
|
||||
|
||||
Reaktion auf den Verzug:
|
||||
Um das Projektziel dennoch zu erreichen, wurde der Zeitplan im Herbst 2025 massiv gestrafft. Durch die Umstellung auf einen strikteren 14-tägigen Sprint-Rhythmus und die Priorisierung von Core-Funktionalitäten (MVP-Ansatz) konnte der Rückstand teilweise aufgeholt werden.
|
||||
|
||||
> Fazit: Die Erfahrung zeigt, dass gerade bei "Nischen-Frameworks" wie Oqtane ein deutlich höherer Puffer für die Einarbeitungs- und Infrastrukturphase (Faktor 2 bis 3 der ursprünglichen Schätzung) eingeplant werden muss.
|
||||
|
||||
`90% fertig, oder fertig?`: Es gibt einige "Regeln", wie: das `Paretoprinzip`, `Hofstadter’s Law` und die `90-90 Regel`. Letztere wurde im Jahr 1985 von Jon Bentley in einer Kolumne "Programming pearls" veröffentlicht. Ausgeschrieben lautet sie:
|
||||
|
||||
> [Rule of Credibility] The first 90 percent of the code accounts for the first 90 percent of the development time. The remaining 10 percent of the code accounts for the other 90 percent of the development time.
|
||||
> (Jon Bentley. 1985. Programmimg pearls. Commun. ACM 28, 9 (Sept. 1985), 896–901. https://doi.org/10.1145/4284.315122) [^8]
|
||||
> Diese Diplomarbeit liefert weitere Evidenz, dass diese Faustregel stimmt.
|
||||
|
||||
[^8]: https://dl.acm.org/doi/10.1145/4284.315122
|
||||
|
||||
### 6.4 Sprints und Meetings (in Zukunft ja asynchron)
|
||||
|
||||
Ein zentrales Problem in unserer ursprünglichen Arbeitsweise war die Kopplung von Besprechungsterminen mit festen „Commit-Deadlines“ (dem Ende des aktuellen Sprint zyklusses). Da wir uns einmal pro Woche für sechs Stunden am Stück trafen, entstand ein destruktives Muster:
|
||||
|
||||
- Der "Last-Minute-Commit"-Druck: In den Stunden unmittelbar vor dem Meeting wurden Aufgaben unter Zeitdruck abgeschlossen, um im Meeting Fortschritte präsentieren zu können. Dies führte dazu, dass unfertiger oder unzureichend getesteter Code („Quick and Dirty“) in das Repository gepusht wurde.
|
||||
- Fehlende Review-Kultur: Da die Commits erst kurz vor dem Meeting eintrafen, blieb dem restlichen Team keine Zeit für fundierte Code-Reviews. Die Besprechungszeit wurde somit für die Fehlersuche statt für strategische Planung genutzt.
|
||||
- Ineffizienz: Lange Präsenz-Meetings blockierten wertvolle Entwicklungszeit, ohne die technische Qualität zu steigern.
|
||||
|
||||
Lösungsansatz: Meetings und Besprechungen asynchron zueinander setzen.
|
||||
|
||||
- Asynchrone Daily-Updates: Statusberichte erfolgen schriftlich (z. B. in Gitea Issues oder YouTrack), nicht mehr in stundenlangen Call-Marathons. Das nimmt den zeitlichen Druck vom einzelnen Entwickler. Oder zumindest in kurzen Commitnachrichten, welche am Ende des Tages automatisch an alle Teammitglieder zum überblick gesendet werden (eventuell mit @username tagging, um eine Person nochmal genau anzusprechen)
|
||||
- Review-First-Policy: Ein Feature gilt erst dann als „fertig“, wenn es einen asynchronen Code-Review-Prozess durchlaufen hat. Das Meeting dient nur noch der Klärung von Blockern, nicht der Präsentation von Code. Das war eigentlich schon von Anfang an in unserer `Definition of Done` festgelegt worden.
|
||||
- Entkoppelung von Meeting und Deadline: Meetings sollten der Synchronisation dienen, während die Abgabe von Arbeitspaketen kontinuierlich (Continuous Integration) erfolgen muss, um Lastspitzen (in der [Gitea Actions](#Continuous Integration) Pipeline) am Tag der Besprechung zu vermeiden.
|
||||
|
||||
Grammatik: Genitiv von 'Projekt' ist im förmlichen Kontext vorzugsweise 'Projekts' oder 'Projektes'.