Compare commits
12
Commits
v0.2
..
505cfe38f0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
505cfe38f0
|
||
|
|
85bcdcadb8
|
||
|
|
e67c475c38
|
||
|
|
07983dc5b0
|
||
|
|
5e9587b93f
|
||
|
|
fd62f2574d
|
||
|
|
828bd0639e
|
||
|
|
da13b0d2b8
|
||
|
|
d632dc0f6b
|
||
|
|
b60e4aa457
|
||
|
|
e262f35b27
|
||
|
|
77e4cab8ad
|
No files matched your search
@@ -0,0 +1,26 @@
|
|||||||
|
# Version control
|
||||||
|
.git
|
||||||
|
.github
|
||||||
|
|
||||||
|
# Gradle build outputs / caches (must always be rebuilt fresh inside the image)
|
||||||
|
.gradle
|
||||||
|
build/
|
||||||
|
.kotlin
|
||||||
|
!gradle/wrapper/gradle-wrapper.jar
|
||||||
|
|
||||||
|
# IDE
|
||||||
|
.idea
|
||||||
|
.vscode
|
||||||
|
.run
|
||||||
|
*.iml
|
||||||
|
*.iws
|
||||||
|
*.ipr
|
||||||
|
|
||||||
|
# Docker-only local files (secrets/env must never be baked into the image)
|
||||||
|
docker/.env
|
||||||
|
docker/*.env.docker
|
||||||
|
docker/*.secret
|
||||||
|
|
||||||
|
# Misc
|
||||||
|
*.hprof
|
||||||
|
.gradle-docker-cache/
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
* text=auto
|
||||||
|
* eol=lf
|
||||||
|
*.sh text eol=lf
|
||||||
|
*.png binary
|
||||||
|
*.jar binary
|
||||||
|
gradlew.bat eol=crlf
|
||||||
|
gradlew text eol=lf
|
||||||
+30
-18
@@ -80,36 +80,48 @@ jobs:
|
|||||||
continue-on-error: false
|
continue-on-error: false
|
||||||
|
|
||||||
test:
|
test:
|
||||||
needs: build
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
env:
|
||||||
|
GRADLE_CACHE_DIR: ${{ github.workspace }}/.gradle-docker-cache
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v6
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
- name: Set up JDK 21
|
- name: Install a pinned Docker Compose version
|
||||||
uses: actions/setup-java@v5
|
run: |
|
||||||
with:
|
mkdir -p ~/.docker/cli-plugins
|
||||||
distribution: 'temurin'
|
curl -fSL https://github.com/docker/compose/releases/download/v5.1.4/docker-compose-linux-x86_64 \
|
||||||
java-version: '21'
|
-o ~/.docker/cli-plugins/docker-compose
|
||||||
|
chmod +x ~/.docker/cli-plugins/docker-compose
|
||||||
|
docker compose version
|
||||||
|
|
||||||
- name: Restore Gradle cache
|
- name: Prepare docker secrets
|
||||||
|
run: |
|
||||||
|
[ -f docker/postgresql.secret ] || echo -n "changeit" > docker/postgresql.secret
|
||||||
|
|
||||||
|
- name: Generate cache key
|
||||||
|
id: cache-key-generator
|
||||||
|
run: echo "key=gradle-docker-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
- name: Restore Gradle cache (Docker)
|
||||||
uses: actions/cache@v6
|
uses: actions/cache@v6
|
||||||
with:
|
with:
|
||||||
path: |
|
path: ${{ env.GRADLE_CACHE_DIR }}
|
||||||
~/.gradle/caches
|
key: ${{ steps.cache-key-generator.outputs.key }}
|
||||||
~/.gradle/wrapper
|
|
||||||
key: ${{ needs.build.outputs.cache-key }}
|
|
||||||
restore-keys: |
|
restore-keys: |
|
||||||
gradle-${{ runner.os }}-
|
gradle-docker-${{ runner.os }}-
|
||||||
|
|
||||||
- name: Grant execute permission to Gradle wrapper
|
- name: Prepare cache directory permissions
|
||||||
run: chmod +x gradlew
|
run: |
|
||||||
|
mkdir -p "$GRADLE_CACHE_DIR"
|
||||||
|
chmod -R 777 "$GRADLE_CACHE_DIR"
|
||||||
|
|
||||||
- name: Start CI Docker Compose services
|
- name: Run tests in Docker
|
||||||
run: ./gradlew ciComposeUp -Pci
|
run: docker compose -f docker/docker-compose-test.yaml run tests
|
||||||
|
|
||||||
- name: Run tests
|
- name: Shut down Docker services
|
||||||
run: ./gradlew test -x ciComposeUp -Pci --no-daemon
|
if: always()
|
||||||
|
run: docker compose -f docker/docker-compose-test.yaml down -v
|
||||||
|
|
||||||
- name: Upload test reports
|
- name: Upload test reports
|
||||||
if: always()
|
if: always()
|
||||||
|
|||||||
@@ -37,3 +37,4 @@ out/
|
|||||||
/docker/.env
|
/docker/.env
|
||||||
/docker/*.secret
|
/docker/*.secret
|
||||||
*.hprof
|
*.hprof
|
||||||
|
/.gradle-docker-cache/
|
||||||
@@ -0,0 +1,133 @@
|
|||||||
|
# CLAUDE.md — event-demo
|
||||||
|
|
||||||
|
Ce fichier donne le contexte du projet pour toute session Claude Code future sur ce dépôt.
|
||||||
|
|
||||||
|
## Vue d'ensemble
|
||||||
|
|
||||||
|
`event-demo` est un projet démo personnel (Fabrice Lecomte) qui illustre plusieurs patterns
|
||||||
|
d'architecture backend :
|
||||||
|
|
||||||
|
- Event Sourcing
|
||||||
|
- Event-Driven (bus d'événements asynchrone)
|
||||||
|
- CQRS (séparation commandes / projections en lecture)
|
||||||
|
- Architecture Hexagonale (ports & adapters), un dossier par *bounded context*
|
||||||
|
|
||||||
|
Le cas d'usage servant de support est un jeu de cartes façon UNO (créer une partie, rejoindre,
|
||||||
|
jouer une carte, piocher, etc.), avec authentification des joueurs.
|
||||||
|
|
||||||
|
Dépôts distants configurés : `gitea` (auto-hébergé, git.gogn.synology.me — remote historique)
|
||||||
|
et `github` (`flecomte/event-demo`, miroir). Vérifier vers lequel pousser selon le contexte.
|
||||||
|
|
||||||
|
## Stack technique
|
||||||
|
|
||||||
|
- **Langage** : Kotlin 2.1.21, JDK 21 (toolchain Gradle)
|
||||||
|
- **Framework serveur** : Ktor 3.5.1 (Netty), DI via Koin 4.2.1
|
||||||
|
- **Sérialisation** : kotlinx.serialization (JSON)
|
||||||
|
- **Persistance** :
|
||||||
|
- PostgreSQL (event store, via HikariCP) + migrations Flyway (`migrations/events/`)
|
||||||
|
- RabbitMQ (bus d'événements / bus de commandes, via amqp-client)
|
||||||
|
- **Auth** : JWT (ktor-server-auth-jwt), hash de mot de passe via password4j
|
||||||
|
- **Infra dev/prod** : Docker Compose (fichiers `docker/docker-compose-{dev,test,prod}.yaml`
|
||||||
|
incluant des « parts » réutilisables dans `docker/parts/`), reverse proxy Træfik
|
||||||
|
- **Tests** : Kotest (runner JUnit5), MockK, kotest-extensions-koin, ArchUnit (test d'architecture)
|
||||||
|
- **Qualité** : ktlint (`ktlint_official`, standard + experimental activés), reporting checkstyle
|
||||||
|
- **CI** : GitHub Actions (`.github/workflows/tests.yml`) — build/cache Gradle, `ktlintCheck`,
|
||||||
|
puis tests exécutés **dans Docker** (`docker compose -f docker/docker-compose-test.yaml run tests`)
|
||||||
|
- **API** : documentée en OpenAPI (`resources/openapi/documentation.yaml`)
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
Un dossier par *bounded context* sous `src/main/kotlin/eventDemo/contexts/<context>/`, chacun
|
||||||
|
strictement découpé en 3 couches :
|
||||||
|
|
||||||
|
- `domain/` — aucune dépendance vers les autres couches
|
||||||
|
- `application/` — ne dépend que de `domain`
|
||||||
|
- `infrastructure/` — dépend de `domain` et `application`
|
||||||
|
|
||||||
|
Contexts actuels :
|
||||||
|
|
||||||
|
- **`auth`** : `User`, création de compte, login JWT, event store dédié (Postgresql),
|
||||||
|
projection utilisateur.
|
||||||
|
- **`game`** : cœur du jeu — `Card`, `DrawPile`/`DiscardPile`, `Player`, `GameId`, commandes
|
||||||
|
(`JoinTheGameCommand`, `PlayCardCommand`, `ReadyToPlayCommand`, `TakeCartFromDrawPileCommand`),
|
||||||
|
state machine du jeu via `sealed interface Game` (`GameInit` → `GameCreated` → `GameStarted` →
|
||||||
|
`GameEnded`), notifications, projections (liste de parties), listeners/réactions.
|
||||||
|
|
||||||
|
Libs transverses dans `libs/` (indépendantes de tout contexte) :
|
||||||
|
|
||||||
|
- `bus/` — abstraction `Bus<E>` avec implémentations in-memory et RabbitMQ (fanout exchange)
|
||||||
|
- `command/` — `Command`, `CommandUnicityChecker` (empêche la double exécution d'une commande,
|
||||||
|
cache glissant de 10 min par défaut)
|
||||||
|
- `eventSource/` — `Event`, `EventStream` (append/lecture par version, gestion de
|
||||||
|
`VersionConflictException`), `EventStore` in-memory / Postgresql
|
||||||
|
- `helpers/`, `serializer/` — utilitaires (conversion de frames WebSocket, sérialiseurs UUID, etc.)
|
||||||
|
|
||||||
|
## Patterns notables dans le code
|
||||||
|
|
||||||
|
- **Event sourcing** : `Game.loadFromHistory(events)` reconstruit l'état en repliant
|
||||||
|
(`fold`) les événements sur une state machine scellée, en utilisant la syntaxe Kotlin 2.1
|
||||||
|
`when` avec garde `if` (ex. `is GameCreatedEvent if this is GameInit -> applyEvent(event)`).
|
||||||
|
- **CQRS** : écriture via les command handlers (`application/command/handlers`), lecture via des
|
||||||
|
projections dédiées (`application/projections`), propagées via le bus RabbitMQ, pas de couplage
|
||||||
|
direct avec l'écriture.
|
||||||
|
- **Event-driven** : réactions asynchrones (`ReactionListener`, `EventToNotificationSubscriber`)
|
||||||
|
déclenchées par le bus RabbitMQ (exchange fanout, une queue par abonné).
|
||||||
|
- **Exceptions métier** : hiérarchie `GameException` / `IllegalActionException` dans
|
||||||
|
`domain/game/errors`, une exception par règle métier violée (ex.
|
||||||
|
`NeedMorePlayersToStartGameException`, `ItsNotTheTurnException`).
|
||||||
|
|
||||||
|
## Commandes utiles
|
||||||
|
|
||||||
|
```shell
|
||||||
|
./gradlew build # build complet
|
||||||
|
./gradlew test # tests (JUnit5 via Kotest)
|
||||||
|
./gradlew ktlintCheck # lint
|
||||||
|
./gradlew ktlintFormat # auto-format
|
||||||
|
./gradlew buildFatJar # jar exécutable "all-in-one" (utilisé par le Dockerfile prod)
|
||||||
|
|
||||||
|
# Dépendances seules (Postgres, RabbitMQ, Træfik, pgAdmin...) pour lancer l'app en local hors docker
|
||||||
|
docker compose -f docker/docker-compose-dev.yaml up -d
|
||||||
|
|
||||||
|
# Stack de test façon CI
|
||||||
|
docker compose -f docker/docker-compose-test.yaml up -d
|
||||||
|
# ou directement (comme en CI) :
|
||||||
|
docker compose -f docker/docker-compose-test.yaml run tests
|
||||||
|
|
||||||
|
# Stack complète en prod
|
||||||
|
docker compose -f docker/docker-compose-prod.yaml -p event-demo up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
URLs en dev (voir `doc/installation.md`, nécessite Træfik + résolution des `*.traefik.me`) :
|
||||||
|
API sur `http://api.traefik.me/`, dashboard
|
||||||
|
Træfik, pgAdmin et RabbitMQ management exposés via des sous-domaines `traefik.me`.
|
||||||
|
|
||||||
|
## Conventions de code
|
||||||
|
|
||||||
|
- ktlint en mode `ktlint_official` + règles `standard` et `experimental` activées
|
||||||
|
(voir `.editorconfig`), indentation **2 espaces**, virgules finales (*trailing commas*)
|
||||||
|
systématiques, wrapping forcé des expressions/signatures multi-lignes.
|
||||||
|
- Fins de ligne forcées en **LF** (`.gitattributes`), sauf `gradlew.bat` en CRLF.
|
||||||
|
- Code et identifiants en anglais.
|
||||||
|
- Style Kotlin idiomatique/fonctionnel : `fold`, `let`, `apply`, `when` exhaustifs, classes/interfaces
|
||||||
|
scellées (`sealed class`/`sealed interface`) pour modéliser états et événements plutôt que des enums
|
||||||
|
avec des champs optionnels.
|
||||||
|
|
||||||
|
## Pièges connus / choses à savoir avant de toucher au build ou à la CI
|
||||||
|
|
||||||
|
- **MockK/ByteBuddy en Docker** : l'auto-attach dynamique de MockK échoue dans les conteneurs
|
||||||
|
(le handshake SIGQUIT de l'AttachListener JVM time-out). Le `build.gradle.kts` charge donc
|
||||||
|
l'agent `byte-buddy-agent` de façon statique via `-javaagent` pour les tâches `Test`, afin
|
||||||
|
que MockK détecte l'instrumentation déjà présente et saute l'attach dynamique. Ne pas retirer
|
||||||
|
ce bloc sans repenser l'exécution des tests en Docker.
|
||||||
|
- **Secret Postgres en CI** : `docker/postgresql.secret` est généré à la volée par le workflow
|
||||||
|
GitHub Actions s'il n'existe pas (`echo -n "changeit" > docker/postgresql.secret`) — normal,
|
||||||
|
pas un fichier à committer.
|
||||||
|
- Les tests « officiels » de la CI tournent **dans Docker**, pas directement via `./gradlew test`
|
||||||
|
sur l'hôte — en cas de comportement différent entre local et CI, vérifier d'abord les
|
||||||
|
variables d'environnement/versions du `docker-compose-test.yaml`.
|
||||||
|
|
||||||
|
## Historique récent (pour contexte)
|
||||||
|
|
||||||
|
Le projet a connu un « Massive refactor to build the V2 » (commit `e2d7942`) : passage d'une
|
||||||
|
architecture par couches techniques plates (`adapter/presenter/domain`) à l'organisation actuelle
|
||||||
|
par bounded context (`auth`/`game`) avec 3 couches hexagonales chacune.
|
||||||
@@ -2,7 +2,6 @@ Event Demo
|
|||||||
==========
|
==========
|
||||||
- [Installation](./doc/installation.md)
|
- [Installation](./doc/installation.md)
|
||||||
- [What's the demo for ?](#whats-the-demo-for-)
|
- [What's the demo for ?](#whats-the-demo-for-)
|
||||||
- [What's in this demo](#whats-in-this-demo)
|
|
||||||
- [The stack](#the-stack)
|
- [The stack](#the-stack)
|
||||||
- [Architecture](./doc/architecture.md)
|
- [Architecture](./doc/architecture.md)
|
||||||
|
|
||||||
@@ -18,31 +17,6 @@ of different patterns and architectures.
|
|||||||
- The CQRS pattern.
|
- The CQRS pattern.
|
||||||
- With the Hexagonal architecture.
|
- With the Hexagonal architecture.
|
||||||
|
|
||||||
|
|
||||||
What's in this demo
|
|
||||||
-------------------
|
|
||||||
|
|
||||||
- The **event sourcing** pattern.
|
|
||||||
- The **event driven** pattern.
|
|
||||||
- The **CQRS** pattern with **command** and **query**.
|
|
||||||
- A fully **asynchronous** architecture.Concurently process.
|
|
||||||
- A **pure Kotlin** implementation of **readmodel**/**projection**.
|
|
||||||
- A **Redis** implementation of **readmodel**/**projection**.
|
|
||||||
- A **pure Kotlin** implementation of **Event Store**.
|
|
||||||
- A **Postgresql** implementation of **Event Store**.
|
|
||||||
- A **pure Kotlin** implementation of **Event Bus**.
|
|
||||||
- A **RabbitMQ** implementation of **Event Bus**.
|
|
||||||
- A **Hexagonal** architecture.
|
|
||||||
- Use of **Web Sockets**.
|
|
||||||
- Use of the classic **Rest** route.
|
|
||||||
- Simple usage of the **JWT**.
|
|
||||||
- The **Ktor** framework.
|
|
||||||
- The **Koin** Dependency Injection framework
|
|
||||||
- Concurrently process.
|
|
||||||
- Use of coroutines.
|
|
||||||
- Using **docker compose** for the stack with **traefik**.
|
|
||||||
- Use of **flyway** to migrate the postgresql schema.
|
|
||||||
|
|
||||||
The stack
|
The stack
|
||||||
---------
|
---------
|
||||||
|
|
||||||
@@ -51,11 +25,11 @@ Language
|
|||||||
|
|
||||||
Framework
|
Framework
|
||||||
- Ktor
|
- Ktor
|
||||||
|
- with Koin for Dependency Injection
|
||||||
|
|
||||||
Database
|
Database
|
||||||
- Postgresql
|
- Postgresql
|
||||||
- with Flyway
|
- with Flyway
|
||||||
- Redis
|
|
||||||
- RabbitMQ
|
- RabbitMQ
|
||||||
|
|
||||||
Infra
|
Infra
|
||||||
|
|||||||
+11
-72
@@ -1,4 +1,3 @@
|
|||||||
import com.avast.gradle.dockercompose.ComposeExtension
|
|
||||||
import org.jlleitschuh.gradle.ktlint.KtlintExtension
|
import org.jlleitschuh.gradle.ktlint.KtlintExtension
|
||||||
|
|
||||||
val ktorVersion: Provider<String> = providers.gradleProperty("ktor_version")
|
val ktorVersion: Provider<String> = providers.gradleProperty("ktor_version")
|
||||||
@@ -15,7 +14,6 @@ plugins {
|
|||||||
id("io.ktor.plugin") version "3.5.1"
|
id("io.ktor.plugin") version "3.5.1"
|
||||||
id("org.jetbrains.kotlin.plugin.serialization") version "2.4.10"
|
id("org.jetbrains.kotlin.plugin.serialization") version "2.4.10"
|
||||||
id("org.jlleitschuh.gradle.ktlint") version "14.2.0"
|
id("org.jlleitschuh.gradle.ktlint") version "14.2.0"
|
||||||
id("com.avast.gradle.docker-compose") version "0.17.12"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
group = "io.github.flecomte"
|
group = "io.github.flecomte"
|
||||||
@@ -48,74 +46,16 @@ java {
|
|||||||
|
|
||||||
tasks.withType<Test>().configureEach {
|
tasks.withType<Test>().configureEach {
|
||||||
useJUnitPlatform()
|
useJUnitPlatform()
|
||||||
}
|
jvmArgs("-Djdk.attach.allowAttachSelf=true", "-XX:+EnableDynamicAgentLoading")
|
||||||
|
// Dynamic self-attach (used by MockK/ByteBuddy) times out in Docker containers because the
|
||||||
configure<ComposeExtension> {
|
// SIGQUIT-triggered AttachListener handshake never completes there. Loading the byte-buddy
|
||||||
createNested("test").apply {
|
// agent jar statically via -javaagent avoids the attach handshake entirely: MockK detects the
|
||||||
useComposeFiles.set(listOf("docker/docker-compose-test.yaml"))
|
// pre-installed Instrumentation instance and skips dynamic attach.
|
||||||
setProjectName("event-demo-test")
|
doFirst {
|
||||||
}
|
val agentJar =
|
||||||
createNested("dev").apply {
|
classpath.files.firstOrNull { it.name.startsWith("byte-buddy-agent") }
|
||||||
useComposeFiles.set(listOf("docker/docker-compose-dev.yaml"))
|
?: error("byte-buddy-agent jar not found on test classpath")
|
||||||
setProjectName("event-demo-dev")
|
jvmArgs("-javaagent:$agentJar")
|
||||||
}
|
|
||||||
createNested("ci").apply {
|
|
||||||
useComposeFiles.set(listOf("docker/docker-compose-ci.yaml"))
|
|
||||||
setProjectName("event-demo-ci")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
tasks.test {
|
|
||||||
if (project.hasProperty("ci")) {
|
|
||||||
dependsOn("ciComposeUp")
|
|
||||||
} else {
|
|
||||||
dependsOn("testComposeUp")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
tasks.named("run") {
|
|
||||||
dependsOn("devComposeUp")
|
|
||||||
}
|
|
||||||
tasks.composeUp {
|
|
||||||
dependsOn("copyEnv")
|
|
||||||
}
|
|
||||||
tasks.named("devComposeUp") {
|
|
||||||
dependsOn("copyEnv")
|
|
||||||
}
|
|
||||||
tasks.named("testComposeUp") {
|
|
||||||
dependsOn("copyEnv")
|
|
||||||
}
|
|
||||||
tasks.named("ciComposeUp") {
|
|
||||||
dependsOn("copyEnv")
|
|
||||||
}
|
|
||||||
|
|
||||||
tasks.register<Copy>("copyEnv") {
|
|
||||||
group = "docker"
|
|
||||||
description = "copy the default dotenv file"
|
|
||||||
from("docker")
|
|
||||||
into("docker")
|
|
||||||
rename {
|
|
||||||
it.removeSuffix(".template")
|
|
||||||
}
|
|
||||||
include(".env.template")
|
|
||||||
eachFile {
|
|
||||||
if (File("docker/$name").exists()) {
|
|
||||||
exclude()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
val files =
|
|
||||||
buildList {
|
|
||||||
add(File("docker/postgresql.secret"))
|
|
||||||
if (!project.hasProperty("ci")) {
|
|
||||||
add(File("docker/pgadmin.secret"))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
outputs.files(*files.toTypedArray())
|
|
||||||
doLast {
|
|
||||||
files.forEach {
|
|
||||||
if (!it.exists()) {
|
|
||||||
it.writeText("changeit")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -141,7 +81,6 @@ dependencies {
|
|||||||
implementation("io.github.oshai:kotlin-logging-jvm:${kotlinLoggingVersion.get()}")
|
implementation("io.github.oshai:kotlin-logging-jvm:${kotlinLoggingVersion.get()}")
|
||||||
implementation("org.jetbrains.kotlinx:kotlinx-serialization-json-jvm:${kotlinSerializationVersion.get()}")
|
implementation("org.jetbrains.kotlinx:kotlinx-serialization-json-jvm:${kotlinSerializationVersion.get()}")
|
||||||
implementation("org.jetbrains.kotlinx:kotlinx-datetime:0.6.2")
|
implementation("org.jetbrains.kotlinx:kotlinx-datetime:0.6.2")
|
||||||
implementation("redis.clients:jedis:5.2.0")
|
|
||||||
implementation("org.postgresql:postgresql:42.7.13")
|
implementation("org.postgresql:postgresql:42.7.13")
|
||||||
implementation("com.zaxxer:HikariCP:6.3.0")
|
implementation("com.zaxxer:HikariCP:6.3.0")
|
||||||
implementation("com.rabbitmq:amqp-client:5.25.0")
|
implementation("com.rabbitmq:amqp-client:5.25.0")
|
||||||
@@ -154,6 +93,6 @@ dependencies {
|
|||||||
testImplementation("org.jetbrains.kotlin:kotlin-test-junit:${kotlinVersion.get()}")
|
testImplementation("org.jetbrains.kotlin:kotlin-test-junit:${kotlinVersion.get()}")
|
||||||
testImplementation("io.ktor:ktor-server-test-host-jvm:${ktorVersion.get()}")
|
testImplementation("io.ktor:ktor-server-test-host-jvm:${ktorVersion.get()}")
|
||||||
testImplementation("io.kotest:kotest-runner-junit5:${kotestVersion.get()}")
|
testImplementation("io.kotest:kotest-runner-junit5:${kotestVersion.get()}")
|
||||||
testImplementation("io.mockk:mockk:1.13.17")
|
testImplementation("io.mockk:mockk:1.14.11")
|
||||||
testImplementation("com.tngtech.archunit:archunit-junit5:1.3.0")
|
testImplementation("com.tngtech.archunit:archunit-junit5:1.3.0")
|
||||||
}
|
}
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
Architecture
|
|
||||||
============
|
|
||||||
|
|
||||||
The Workflow
|
|
||||||
------------
|
|
||||||

|
|
||||||
|
|
||||||
The business Entities
|
|
||||||
---------------------
|
|
||||||
|
|
||||||

|
|
||||||
@@ -1,67 +0,0 @@
|
|||||||
# Exemple de structure
|
|
||||||
|
|
||||||
Les couches, du plus interne au plus externe
|
|
||||||
```
|
|
||||||
Domain (le cœur, ne dépend de RIEN d'externe)
|
|
||||||
↑
|
|
||||||
Application (orchestre le Domain, ne connaît pas l'infra concrète)
|
|
||||||
↑
|
|
||||||
Infrastructure (WebSocket, DB, event store — dépend de tout le reste)
|
|
||||||
```
|
|
||||||
|
|
||||||
```
|
|
||||||
src/
|
|
||||||
└── contexts/
|
|
||||||
├── auth/
|
|
||||||
└── ...
|
|
||||||
└── game/
|
|
||||||
├── domain/ ← Le cœur métier, zéro dépendance externe
|
|
||||||
│ ├── game/
|
|
||||||
│ │ ├── Game.ts ← Aggregate Root
|
|
||||||
│ │ ├── Player.ts ← Entity interne
|
|
||||||
│ │ ├── Card.ts ← Entity
|
|
||||||
│ │ ├── Color.ts ← Value Object
|
|
||||||
│ │ ├── Deck.ts ← VO ou petite structure
|
|
||||||
│ │ └── errors/
|
|
||||||
│ │ ├── InvalidMoveError.ts
|
|
||||||
│ │ └── ColorChoiceRequiredError.ts
|
|
||||||
│ └── events/ ← Events de DOMAINE (internes)
|
|
||||||
│ ├── CardPlayed.ts
|
|
||||||
│ ├── CardDrawn.ts
|
|
||||||
│ ├── TurnPassed.ts
|
|
||||||
│ └── DomainEvent.ts ← interface/type de base
|
|
||||||
├── application/ ← Orchestration, cas d'usage
|
|
||||||
│ ├── commands/ ← Les Commandes (intentions)
|
|
||||||
│ │ ├── PlayCardCommand.ts
|
|
||||||
│ │ └── DrawCardCommand.ts
|
|
||||||
│ ├── handlers/ ← Un handler par commande
|
|
||||||
│ │ ├── PlayCardHandler.ts ← charge l'aggregate, appelle game.playCard(), save
|
|
||||||
│ │ └── DrawCardHandler.ts
|
|
||||||
│ ├── projections/ ← LA LOGIQUE de construction des projections
|
|
||||||
│ │ ├── GameSummaryProjector.kt ← écoute les events, met à jour la vue
|
|
||||||
│ │ └── PlayerStatsProjector.kt
|
|
||||||
│ └── ports/ ← INTERFACES seulement (le "hexagone")
|
|
||||||
│ ├── GameRepository.ts ← interface, pas d'implémentation
|
|
||||||
│ ├── EventPublisher.ts ← interface, pas d'implémentation
|
|
||||||
│ └── ProjectionStore.kt ← interface, où lire/écrire la projection
|
|
||||||
├── infrastructure/ ← Tout ce qui est technique/externe
|
|
||||||
│ ├── persistence/
|
|
||||||
│ │ ├── EventStoreGameRepository.ts ← implémente GameRepository
|
|
||||||
│ │ ├── EventStore.ts
|
|
||||||
│ │ ├── projections/
|
|
||||||
│ │ │ ├── GameSummaryProjectionStore.kt ← implémentation concrète (DB, table dédiée)
|
|
||||||
│ │ │ └── models/
|
|
||||||
│ │ │ └── GameSummaryView.kt ← structure de la vue elle-même
|
|
||||||
│ ├── websocket/
|
|
||||||
│ │ ├── WebSocketServer.ts
|
|
||||||
│ │ ├── connectionManager.ts ← Map<gameId, Map<playerId, WebSocket>>
|
|
||||||
│ │ └── commandRouter.ts ← reçoit le message brut, dispatch vers le bon handler
|
|
||||||
│ └── eventPublisher/
|
|
||||||
│ └── WebSocketEventPublisher.ts ← implémente EventPublisher, fait le broadcast
|
|
||||||
└── presentation/ ← Traduction vers/depuis le client (le fameux DTO layer)
|
|
||||||
├── clientEvents/
|
|
||||||
│ ├── ClientEvent.ts ← types des events envoyés au front
|
|
||||||
│ └── toClientEvent.ts ← fonction de traduction domain event → client event
|
|
||||||
└── clientCommands/
|
|
||||||
└── parseIncomingCommand.ts ← valide/parse le message brut du client → Command
|
|
||||||
```
|
|
||||||
+15
-5
@@ -1,23 +1,33 @@
|
|||||||
Installation
|
Installation
|
||||||
============
|
============
|
||||||
|
|
||||||
To run the stack:
|
To run the stack in production:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
docker compose -f docker\docker-compose-prod.yaml -p event-demo up -d
|
docker compose -f docker\docker-compose-prod.yaml -p event-demo up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
|
To run only the app dependencies in development mode and run the app localy (not in docker):
|
||||||
|
|
||||||
|
```shell
|
||||||
|
docker compose -f docker\docker-compose-dev.yaml up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
To run the tests in docker (it's designed for the CI):
|
||||||
|
|
||||||
|
```shell
|
||||||
|
docker compose -f docker\docker-compose-test.yaml up -d
|
||||||
|
```
|
||||||
|
|
||||||
Api url:
|
Api url:
|
||||||
- [Backend API](http://api.traefik.me/)
|
- [Backend API](http://api.traefik.me/)
|
||||||
- [Frontend web site](http://app.traefik.me/) (WIP)
|
- [Frontend web site](http://app.traefik.me/)
|
||||||
|
|
||||||
Exposed url on test env:
|
Exposed url on dev env:
|
||||||
- [PostgreSql](http://localhost:5432/)
|
- [PostgreSql](http://localhost:5432/)
|
||||||
- [Redis](http://localhost:6379/)
|
|
||||||
- [RabbitMQ](http://localhost:15672/)
|
- [RabbitMQ](http://localhost:15672/)
|
||||||
|
|
||||||
Admin service URL:
|
Admin service URL:
|
||||||
- [Træfik dashboard](http://traefik.traefik.me/)
|
- [Træfik dashboard](http://traefik.traefik.me/)
|
||||||
- [Redis insight](http://insight.redis.traefik.me/)
|
|
||||||
- [pgAdmin](http://pgadmin.postgresql.traefik.me/)
|
- [pgAdmin](http://pgadmin.postgresql.traefik.me/)
|
||||||
- [RabbitMQ management](http://management.rabbitmq.traefik.me/)
|
- [RabbitMQ management](http://management.rabbitmq.traefik.me/)
|
||||||
@@ -1,93 +0,0 @@
|
|||||||
@startuml
|
|
||||||
'https://plantuml.com/class-diagram
|
|
||||||
|
|
||||||
left to right direction
|
|
||||||
|
|
||||||
class GameList <<Projection>> {
|
|
||||||
+ status: Status
|
|
||||||
}
|
|
||||||
class GameState <<Projection>> {
|
|
||||||
+ players: List<Player>
|
|
||||||
+ currentPlayerTurn: Player
|
|
||||||
+ lastCardPlayer: Player
|
|
||||||
+ colorOnCurrentStack: Color
|
|
||||||
+ direction: Direction
|
|
||||||
+ readyPlayers: List<Player>
|
|
||||||
+ deck: Deck
|
|
||||||
+ isStarted: Boolean
|
|
||||||
+ playerWins: List<Player>
|
|
||||||
}
|
|
||||||
interface Card {
|
|
||||||
+ id: UUID
|
|
||||||
}
|
|
||||||
enum Color {
|
|
||||||
+ Blue
|
|
||||||
+ Red
|
|
||||||
+ Yellow
|
|
||||||
+ Green
|
|
||||||
}
|
|
||||||
class GameId {
|
|
||||||
+ id: UUID
|
|
||||||
}
|
|
||||||
class Player {
|
|
||||||
+ id: PlayerId
|
|
||||||
+ name: String
|
|
||||||
}
|
|
||||||
class Deck {
|
|
||||||
+ stack: Stack
|
|
||||||
+ discard: Discard
|
|
||||||
+ playersHands: PlayersHands
|
|
||||||
}
|
|
||||||
class Stack {
|
|
||||||
+ cards: List<Card>
|
|
||||||
+ shuffle()
|
|
||||||
}
|
|
||||||
class Discard {
|
|
||||||
+ cards: List<Card>
|
|
||||||
}
|
|
||||||
class PlayerHands {
|
|
||||||
+ map: Map<PlayerId, List<Card>>
|
|
||||||
}
|
|
||||||
|
|
||||||
class NumericCard {
|
|
||||||
+ number: Int
|
|
||||||
+ color: Color
|
|
||||||
}
|
|
||||||
class ReverseCard {
|
|
||||||
+ color: Color
|
|
||||||
}
|
|
||||||
class PassCard {
|
|
||||||
+ color: Color
|
|
||||||
}
|
|
||||||
class Plus2Card {
|
|
||||||
+ color: Color
|
|
||||||
}
|
|
||||||
class Plus4Card
|
|
||||||
class ChangeColorCard
|
|
||||||
|
|
||||||
GameState *-- Deck
|
|
||||||
GameState o-- "many" Player
|
|
||||||
Deck *-- PlayerHands
|
|
||||||
PlayerHands *-- "many" Card
|
|
||||||
PlayerHands o-- "many" Player
|
|
||||||
Stack *-- "many" Card
|
|
||||||
Discard *-- "many" Card
|
|
||||||
Deck *-- Stack
|
|
||||||
Deck *-- Discard
|
|
||||||
GameState *-- GameId
|
|
||||||
Card <|--- NumericCard
|
|
||||||
Card <|--- ReverseCard
|
|
||||||
Card <|--- PassCard
|
|
||||||
Card <|--- ChangeColorCard
|
|
||||||
Card <|--- Plus2Card
|
|
||||||
Card <|--- Plus4Card
|
|
||||||
|
|
||||||
ReverseCard o-- Color
|
|
||||||
NumericCard o-- Color
|
|
||||||
PassCard o-- Color
|
|
||||||
Plus2Card o-- Color
|
|
||||||
|
|
||||||
GameList *-- GameId
|
|
||||||
GameList o-- "many" Player
|
|
||||||
|
|
||||||
@enduml
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentStyleType="text/css" height="668px" preserveAspectRatio="none" style="width:1329px;height:668px;" version="1.1" viewBox="0 0 1329 668" width="1329px" zoomAndPan="magnify"><defs/><g><!--class GameList--><g id="elem_GameList"><rect codeLine="5" fill="#F1F1F1" height="79.2031" id="GameList" rx="2.5" ry="2.5" style="stroke:#181818;stroke-width:0.5;" width="110.8203" x="50.5" y="7"/><ellipse cx="72.7501" cy="29.291" fill="#ADD1B2" rx="11" ry="11" style="stroke:#181818;stroke-width:1.0;"/><path d="M75.5157,25.166 Q75.672,24.9473 75.8595,24.8379 Q76.047,24.7285 76.2657,24.7285 Q76.6407,24.7285 76.8751,24.9941 Q77.1095,25.2441 77.1095,25.8535 L77.1095,27.3066 Q77.1095,27.916 76.8751,28.1816 Q76.6407,28.4473 76.2657,28.4473 Q75.922,28.4473 75.7188,28.2441 Q75.5157,28.0566 75.4063,27.541 Q75.3595,27.1816 75.172,26.9941 Q74.8438,26.6191 74.2345,26.4004 Q73.6251,26.1816 73.0001,26.1816 Q72.2345,26.1816 71.5938,26.5098 Q70.9688,26.8379 70.4688,27.5879 Q69.9845,28.3379 69.9845,29.3691 L69.9845,30.4629 Q69.9845,31.6973 70.8751,32.5254 Q71.7657,33.3379 73.3595,33.3379 Q74.297,33.3379 74.9532,33.0879 Q75.3438,32.9316 75.7657,32.4941 Q76.0313,32.2285 76.172,32.1504 Q76.3282,32.0723 76.5313,32.0723 Q76.8595,32.0723 77.1095,32.3379 Q77.3751,32.5879 77.3751,32.9316 Q77.3751,33.2754 77.0313,33.6816 Q76.5313,34.2598 75.7345,34.5879 Q74.6563,35.041 73.3595,35.041 Q71.8438,35.041 70.6407,34.416 Q69.6563,33.916 68.9688,32.8535 Q68.2813,31.7754 68.2813,30.4941 L68.2813,29.3379 Q68.2813,28.0098 68.8907,26.8691 Q69.5157,25.7129 70.6095,25.1035 Q71.7032,24.4785 72.9376,24.4785 Q73.672,24.4785 74.3126,24.6504 Q74.9688,24.8066 75.5157,25.166 Z " fill="#000000"/><text fill="#000000" font-family="sans-serif" font-size="12" font-style="italic" lengthAdjust="spacing" textLength="66.709" x="86.3612" y="24.9492">«Projection»</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="59.9102" x="89.7606" y="43.0684">GameList</text><line style="stroke:#181818;stroke-width:0.5;" x1="51.5" x2="160.3203" y1="51.582" y2="51.582"/><ellipse cx="61.5" cy="66.3926" fill="none" rx="3" ry="3" style="stroke:#038048;stroke-width:1.0;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="84.8203" x="70.5" y="70.6895">status: Status</text><line style="stroke:#181818;stroke-width:0.5;" x1="51.5" x2="160.3203" y1="78.2031" y2="78.2031"/></g><!--class GameState--><g id="elem_GameState"><rect codeLine="8" fill="#F1F1F1" height="228.1719" id="GameState" rx="2.5" ry="2.5" style="stroke:#181818;stroke-width:0.5;" width="197.9512" x="7" y="121.5"/><ellipse cx="66.3188" cy="143.791" fill="#ADD1B2" rx="11" ry="11" style="stroke:#181818;stroke-width:1.0;"/><path d="M69.0845,139.666 Q69.2407,139.4473 69.4282,139.3379 Q69.6157,139.2285 69.8345,139.2285 Q70.2095,139.2285 70.4438,139.4941 Q70.6782,139.7441 70.6782,140.3535 L70.6782,141.8066 Q70.6782,142.416 70.4438,142.6816 Q70.2095,142.9473 69.8345,142.9473 Q69.4907,142.9473 69.2876,142.7441 Q69.0845,142.5566 68.9751,142.041 Q68.9282,141.6816 68.7407,141.4941 Q68.4126,141.1191 67.8032,140.9004 Q67.1938,140.6816 66.5688,140.6816 Q65.8032,140.6816 65.1626,141.0098 Q64.5376,141.3379 64.0376,142.0879 Q63.5532,142.8379 63.5532,143.8691 L63.5532,144.9629 Q63.5532,146.1973 64.4438,147.0254 Q65.3345,147.8379 66.9282,147.8379 Q67.8657,147.8379 68.522,147.5879 Q68.9126,147.4316 69.3345,146.9941 Q69.6001,146.7285 69.7407,146.6504 Q69.897,146.5723 70.1001,146.5723 Q70.4282,146.5723 70.6782,146.8379 Q70.9438,147.0879 70.9438,147.4316 Q70.9438,147.7754 70.6001,148.1816 Q70.1001,148.7598 69.3032,149.0879 Q68.2251,149.541 66.9282,149.541 Q65.4126,149.541 64.2095,148.916 Q63.2251,148.416 62.5376,147.3535 Q61.8501,146.2754 61.8501,144.9941 L61.8501,143.8379 Q61.8501,142.5098 62.4595,141.3691 Q63.0845,140.2129 64.1782,139.6035 Q65.272,138.9785 66.5063,138.9785 Q67.2407,138.9785 67.8813,139.1504 Q68.5376,139.3066 69.0845,139.666 Z " fill="#000000"/><text fill="#000000" font-family="sans-serif" font-size="12" font-style="italic" lengthAdjust="spacing" textLength="66.709" x="88.8711" y="139.4492">«Projection»</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="70.8135" x="86.8188" y="157.5684">GameState</text><line style="stroke:#181818;stroke-width:0.5;" x1="8" x2="203.9512" y1="166.082" y2="166.082"/><ellipse cx="18" cy="180.8926" fill="none" rx="3" ry="3" style="stroke:#038048;stroke-width:1.0;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="130.7305" x="27" y="185.1895">players: List<Player></text><ellipse cx="18" cy="199.5137" fill="none" rx="3" ry="3" style="stroke:#038048;stroke-width:1.0;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="159.5029" x="27" y="203.8105">currentPlayerTurn: PlayerLine truncated
|
|
||||||
|
Before Width: | Height: | Size: 48 KiB |
@@ -1,84 +0,0 @@
|
|||||||
@startuml
|
|
||||||
'https://plantuml.com/use-case-diagram
|
|
||||||
|
|
||||||
package Legend {
|
|
||||||
usecase (Queries) #7693C4
|
|
||||||
usecase (Projections) #AB64C9
|
|
||||||
usecase (Events) #5FAD56
|
|
||||||
}
|
|
||||||
|
|
||||||
actor User
|
|
||||||
entity Query #7693C4
|
|
||||||
|
|
||||||
entity Command #5FAD56
|
|
||||||
entity Event #5FAD56
|
|
||||||
entity Projection #AB64C9
|
|
||||||
|
|
||||||
database Postgresql
|
|
||||||
database Redis
|
|
||||||
queue RabbitMQ
|
|
||||||
|
|
||||||
usecase (Web socket adapter) #5FAD56
|
|
||||||
usecase (Command handler) #5FAD56
|
|
||||||
usecase/ (Action) #5FAD56
|
|
||||||
usecase (Event handler) #5FAD56
|
|
||||||
usecase (Version builder) #5FAD56
|
|
||||||
usecase (Event store) #5FAD56
|
|
||||||
usecase (Event stream) #5FAD56
|
|
||||||
usecase (Event bus) #5FAD56
|
|
||||||
usecase/ (Reaction listener) #5FAD56
|
|
||||||
|
|
||||||
usecase/ (Projection builder) #AB64C9
|
|
||||||
usecase (Projection repository) #AB64C9
|
|
||||||
usecase (Projection bus) #AB64C9
|
|
||||||
|
|
||||||
usecase (Controller) #7693C4
|
|
||||||
|
|
||||||
User -> Query : <<create>>
|
|
||||||
Command <- User : <<create>>
|
|
||||||
User ---> (Controller) : Get \nprojection
|
|
||||||
User <-- (Controller) : Returns \nprojection
|
|
||||||
|
|
||||||
(Controller) --------> (Projection repository) : Get \nprojection
|
|
||||||
|
|
||||||
User -> (Web socket adapter) : Send \ncommand
|
|
||||||
(Web socket adapter) --> (Command handler) : Send \ncommand
|
|
||||||
(Web socket adapter) ...> User : Send notification \n(error or success)
|
|
||||||
|
|
||||||
(Command handler) ..> (Web socket adapter) : Send \nnotification
|
|
||||||
(Command handler) -> (Action) : Execute action
|
|
||||||
(Command handler) <- (Action) : Returns \nevent builder
|
|
||||||
(Command handler) ---> (Event handler) : Dispatch \nevent \n(send an event builder)
|
|
||||||
(Command handler) --> Event : <<Create>>
|
|
||||||
|
|
||||||
(Event handler) --> (Event store) : Publish \nevent
|
|
||||||
(Event handler) <-- (Reaction listener) : Dispatch \n new event
|
|
||||||
(Version builder) <- (Event handler) : build next version
|
|
||||||
note "Acquire a lock, \nget the next event version, \nand then, build the event " as EventHandlerNote
|
|
||||||
EventHandlerNote <-- (Event handler)
|
|
||||||
|
|
||||||
(Event store) -left-> (Event stream)
|
|
||||||
(Event store) ---> (Event bus) : Publish \nevent
|
|
||||||
|
|
||||||
(Event stream) --> Postgresql : Persist \nevent
|
|
||||||
(Event bus) -> RabbitMQ : Publish \nevent
|
|
||||||
(Event bus) -> RabbitMQ : Subscribe \nto event
|
|
||||||
(Event bus) <. RabbitMQ : Emit event
|
|
||||||
|
|
||||||
(Reaction listener) ---> (Projection bus) : Subscribe
|
|
||||||
(Reaction listener) <.. (Projection bus) : Emit projection
|
|
||||||
|
|
||||||
(Projection bus) <- (Projection repository) : Publish \nprojection
|
|
||||||
RabbitMQ <- (Projection bus) : Publish \nprojection
|
|
||||||
RabbitMQ <- (Projection bus) : Subscribe \nto projection
|
|
||||||
RabbitMQ .> (Projection bus) : Emit projection
|
|
||||||
|
|
||||||
(Event bus) <---- (Projection repository) : Subscribe
|
|
||||||
(Event bus) ..> (Projection repository) : Emit event
|
|
||||||
|
|
||||||
(Projection repository) --> Redis : Persist \nprojection
|
|
||||||
(Projection repository) <- Redis : Get \nprojection
|
|
||||||
(Projection repository) -> (Projection builder) : Build \nprojection
|
|
||||||
|
|
||||||
(Projection builder) --> Projection : <<create projection>>
|
|
||||||
@enduml
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentStyleType="text/css" height="1460px" preserveAspectRatio="none" style="width:1185px;height:1460px;" version="1.1" viewBox="0 0 1185 1460" width="1185px" zoomAndPan="magnify"><defs/><g><!--cluster Legend--><g id="cluster_Legend"><path d="M897,6.0137 L947.7793,6.0137 A3.75,3.75 0 0 1 950.2793,8.5137 L957.2793,30.6348 L1176,30.6348 A2.5,2.5 0 0 1 1178.5,33.1348 L1178.5,207.5137 A2.5,2.5 0 0 1 1176,210.0137 L897,210.0137 A2.5,2.5 0 0 1 894.5,207.5137 L894.5,8.5137 A2.5,2.5 0 0 1 897,6.0137 " fill="none" style="stroke:#000000;stroke-width:1.5;"/><line style="stroke:#000000;stroke-width:1.5;" x1="894.5" x2="957.2793" y1="30.6348" y2="30.6348"/><text fill="#000000" font-family="sans-serif" font-size="14" font-weight="bold" lengthAdjust="spacing" textLength="49.7793" x="898.5" y="23.1211">Legend</text></g><g id="elem_Queries"><ellipse cx="957.5879" cy="59.315" fill="#7693C4" rx="46.5879" ry="16.3013" style="stroke:#181818;stroke-width:0.5;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="49.0205" x="930.0776" y="64.1187">Queries</text></g><g id="elem_Projections"><ellipse cx="1100.6745" cy="59.4601" fill="#AB64C9" rx="61.6745" ry="16.4464" style="stroke:#181818;stroke-width:0.5;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="69.2549" x="1063.0471" y="64.2638">Projections</text></g><g id="elem_Events"><ellipse cx="957.4528" cy="178.2499" fill="#5FAD56" rx="41.9528" ry="16.2362" style="stroke:#181818;stroke-width:0.5;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="42.7998" x="933.2413" y="183.0022">Events</text></g><!--entity User--><g id="elem_User"><ellipse cx="605.2793" cy="28.5137" fill="#F1F1F1" rx="8" ry="8" style="stroke:#181818;stroke-width:0.5;"/><path d="M605.2793,36.5137 L605.2793,63.5137 M592.2793,44.5137 L618.2793,44.5137 M605.2793,63.5137 L592.2793,78.5137 M605.2793,63.5137 L618.2793,78.5137 " fill="none" style="stroke:#181818;stroke-width:0.5;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="29.5586" x="590.5" y="95.1211">User</text></g><!--entity Query--><g id="elem_Query"><ellipse cx="726.562" cy="50.0137" fill="#7693C4" rx="12" ry="12" style="stroke:#181818;stroke-width:0.5;"/><line style="stroke:#181818;stroke-width:0.5;" x1="714.562" x2="738.562" y1="64.0137" y2="64.0137"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="38.124" x="707.5" y="81.1211">Query</text></g><!--entity Command--><g id="elem_Command"><ellipse cx="471.2896" cy="50.0137" fill="#5FAD56" rx="12" ry="12" style="stroke:#181818;stroke-width:0.5;"/><line style="stroke:#181818;stroke-width:0.5;" x1="459.2896" x2="483.2896" y1="64.0137" y2="64.0137"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="64.5791" x="439" y="81.1211">Command</text></g><!--entity Event--><g id="elem_Event"><ellipse cx="243.3999" cy="530.5137" fill="#5FAD56" rx="12" ry="12" style="stroke:#181818;stroke-width:0.5;"/><line style="stroke:#181818;stroke-width:0.5;" x1="231.3999" x2="255.3999" y1="544.5137" y2="544.5137"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="35.7998" x="225.5" y="561.6211">Event</text></g><!--entity Projection--><g id="elem_Projection"><ellipse cx="750.6274" cy="1410.0137" fill="#AB64C9" rx="12" ry="12" style="stroke:#181818;stroke-width:0.5;"/><line style="stroke:#181818;stroke-width:0.5;" x1="738.6274" x2="762.6274" y1="1424.0137" y2="1424.0137"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="62.2549" x="719.5" y="1441.1211">Projection</text></g><!--entity Postgresql--><g id="elem_Postgresql"><path d="M83.5,905.0137 C83.5,895.0137 126.5723,895.0137 126.5723,895.0137 C126.5723,895.0137 169.6445,895.0137 169.6445,905.0137 L169.6445,932.6348 C169.6445,942.6348 126.5723,942.6348 126.5723,942.6348 C126.5723,942.6348 83.5,942.6348 83.5,932.6348 L83.5,905.0137 " fill="#F1F1F1" style="stroke:#181818;stroke-width:0.5;"/><path d="M83.5,905.0137 C83.5,915.0137 126.5723,915.0137 126.5723,915.0137 C126.5723,915.0137 169.6445,915.0137 169.6445,905.0137 " fill="none" style="stroke:#181818;stroke-width:0.5;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="66.1445" x="93.5" y="934.1211">Postgresql</text></g><!--entity Redis--><g id="elem_Redis"><path d="M462.5,1405.5137 C462.5,1395.5137 490.3965,1395.5137 490.3965,1395.5137 C490.3965,1395.5137 518.293,1395.5137 518.293,1405.5137 L518.293,1433.1348 C518.293,1443.1348 490.3965,1443.1348 490.3965,1443.1348 C490.3965,1443.1348 462.5,1443.1348 462.5,1433.1348 L462.5,1405.5137 " fill="#F1F1F1" style="stroke:#181818;stroke-width:0.5;"/><path d="M462.5,1405.5137 C462.5,1415.5137 490.3965,Line truncated
|
|
||||||
|
Before Width: | Height: | Size: 35 KiB |
@@ -0,0 +1,2 @@
|
|||||||
|
POSTGRESQL_URL=jdbc:postgresql://postgresql/event-demo
|
||||||
|
RABBITMQ_URL=rabbitmq
|
||||||
@@ -1 +0,0 @@
|
|||||||
PGADMIN_DEFAULT_EMAIL=
|
|
||||||
+4
-4
@@ -1,5 +1,5 @@
|
|||||||
# Stage 1: Cache Gradle dependencies
|
# Stage 1: Cache Gradle dependencies
|
||||||
FROM gradle:latest AS cache
|
FROM gradle:9.6.1-jdk21-alpine AS cache
|
||||||
RUN mkdir -p /home/gradle/cache_home
|
RUN mkdir -p /home/gradle/cache_home
|
||||||
ENV GRADLE_USER_HOME=/home/gradle/cache_home
|
ENV GRADLE_USER_HOME=/home/gradle/cache_home
|
||||||
COPY build.gradle.* gradle.properties /home/gradle/app/
|
COPY build.gradle.* gradle.properties /home/gradle/app/
|
||||||
@@ -7,7 +7,7 @@ WORKDIR /home/gradle/app
|
|||||||
RUN gradle build -i -x check
|
RUN gradle build -i -x check
|
||||||
|
|
||||||
# Stage 2: Build Application
|
# Stage 2: Build Application
|
||||||
FROM gradle:latest AS build
|
FROM gradle:9.6.1-jdk21-alpine AS build
|
||||||
COPY --from=cache /home/gradle/cache_home /home/gradle/.gradle
|
COPY --from=cache /home/gradle/cache_home /home/gradle/.gradle
|
||||||
COPY --chown=gradle:gradle . /home/gradle/src
|
COPY --chown=gradle:gradle . /home/gradle/src
|
||||||
WORKDIR /home/gradle/src
|
WORKDIR /home/gradle/src
|
||||||
@@ -16,8 +16,8 @@ WORKDIR /home/gradle/src
|
|||||||
RUN gradle buildFatJar --no-daemon
|
RUN gradle buildFatJar --no-daemon
|
||||||
|
|
||||||
# Stage 3: Create the Runtime Image
|
# Stage 3: Create the Runtime Image
|
||||||
FROM amazoncorretto:21 AS runtime
|
FROM eclipse-temurin:21-jre-alpine AS runtime
|
||||||
EXPOSE 8080
|
EXPOSE 8080
|
||||||
RUN mkdir /app
|
RUN mkdir /app
|
||||||
COPY --from=build /home/gradle/src/build/libs/*.jar /app/event-demo-all.jar
|
COPY --from=build /home/gradle/src/build/libs/*-all.jar /app/event-demo-all.jar
|
||||||
ENTRYPOINT ["java","-jar","/app/event-demo-all.jar"]
|
ENTRYPOINT ["java","-jar","/app/event-demo-all.jar"]
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# Image officielle Gradle avec JDK 21 déjà installé
|
||||||
|
FROM gradle:9.6.1-jdk21
|
||||||
|
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
# Copie du wrapper et des fichiers de config en premier pour profiter du cache Docker
|
||||||
|
COPY build.gradle.kts settings.gradle.kts ./
|
||||||
|
|
||||||
|
# Lance les tests Kotlin
|
||||||
|
CMD ["gradle", "test", "--no-daemon"]
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
name: event-demo-ci
|
|
||||||
include:
|
|
||||||
- path:
|
|
||||||
- parts/docker-compose-databases.yaml
|
|
||||||
- parts/docker-compose-databases-expose.yaml
|
|
||||||
@@ -1,4 +1,17 @@
|
|||||||
name: event-demo-test
|
name: event-demo-dev
|
||||||
include:
|
include:
|
||||||
- path:
|
- path:
|
||||||
- docker-compose-test.yaml
|
- parts/docker-compose-databases.yaml
|
||||||
|
- parts/docker-compose-databases-expose.yaml
|
||||||
|
- parts/docker-compose-tools.yaml
|
||||||
|
- parts/docker-compose-tools-local.yaml
|
||||||
|
- parts/docker-compose-traefik.yaml
|
||||||
|
|
||||||
|
services:
|
||||||
|
postgresql:
|
||||||
|
environment:
|
||||||
|
POSTGRES_PASSWORD: "changeit"
|
||||||
|
|
||||||
|
pgadmin:
|
||||||
|
environment:
|
||||||
|
PGADMIN_DEFAULT_PASSWORD: "changeit"
|
||||||
@@ -5,3 +5,16 @@ include:
|
|||||||
- parts/docker-compose-app.yaml
|
- parts/docker-compose-app.yaml
|
||||||
- parts/docker-compose-tools.yaml
|
- parts/docker-compose-tools.yaml
|
||||||
- parts/docker-compose-traefik.yaml
|
- parts/docker-compose-traefik.yaml
|
||||||
|
|
||||||
|
services:
|
||||||
|
postgresql:
|
||||||
|
environment:
|
||||||
|
POSTGRES_PASSWORD_FILE: /run/secrets/postgresql_password
|
||||||
|
volumes:
|
||||||
|
- ./postgresql.secret:/run/secrets/postgresql_password:ro
|
||||||
|
|
||||||
|
pgadmin:
|
||||||
|
environment:
|
||||||
|
PGADMIN_DEFAULT_PASSWORD_FILE: /run/secrets/pgadmin_password
|
||||||
|
volumes:
|
||||||
|
- ./pgadmin.secret:/run/secrets/pgadmin_password:ro
|
||||||
@@ -2,6 +2,10 @@ name: event-demo-test
|
|||||||
include:
|
include:
|
||||||
- path:
|
- path:
|
||||||
- parts/docker-compose-databases.yaml
|
- parts/docker-compose-databases.yaml
|
||||||
- parts/docker-compose-databases-expose.yaml
|
- parts/docker-compose-test.yaml
|
||||||
- parts/docker-compose-tools.yaml
|
|
||||||
- parts/docker-compose-traefik.yaml
|
- parts/docker-compose-traefik.yaml
|
||||||
|
|
||||||
|
services:
|
||||||
|
postgresql:
|
||||||
|
environment:
|
||||||
|
POSTGRES_PASSWORD: "changeit"
|
||||||
@@ -10,8 +10,8 @@ services:
|
|||||||
condition: service_healthy
|
condition: service_healthy
|
||||||
rabbitmq:
|
rabbitmq:
|
||||||
condition: service_healthy
|
condition: service_healthy
|
||||||
redis:
|
env_file:
|
||||||
condition: service_healthy
|
- ../.env.docker
|
||||||
labels:
|
labels:
|
||||||
- "traefik.http.routers.api.rule=Host(`api.traefik.me`)"
|
- "traefik.http.routers.api.rule=Host(`api.traefik.me`)"
|
||||||
- "traefik.http.services.api.loadbalancer.server.port=8080"
|
- "traefik.http.services.api.loadbalancer.server.port=8080"
|
||||||
@@ -1,8 +1,4 @@
|
|||||||
services:
|
services:
|
||||||
redis:
|
|
||||||
ports:
|
|
||||||
- "6379:6379"
|
|
||||||
|
|
||||||
postgresql:
|
postgresql:
|
||||||
ports:
|
ports:
|
||||||
- "5432:5432"
|
- "5432:5432"
|
||||||
|
|||||||
@@ -1,12 +1,4 @@
|
|||||||
services:
|
services:
|
||||||
redis:
|
|
||||||
image: redis/redis-stack:7.4.0-v8
|
|
||||||
healthcheck:
|
|
||||||
test: [ "CMD", "redis-cli", "--raw", "incr", "ping" ]
|
|
||||||
volumes:
|
|
||||||
- redis_data:/data
|
|
||||||
- redisinsight_data:/redisinsight
|
|
||||||
|
|
||||||
flyway:
|
flyway:
|
||||||
image: flyway/flyway
|
image: flyway/flyway
|
||||||
command: migrate
|
command: migrate
|
||||||
@@ -22,7 +14,6 @@ services:
|
|||||||
image: postgres:18.4
|
image: postgres:18.4
|
||||||
command: postgres -c 'max_connections=500'
|
command: postgres -c 'max_connections=500'
|
||||||
environment:
|
environment:
|
||||||
POSTGRES_PASSWORD_FILE: /run/secrets/postgresql_password
|
|
||||||
POSTGRES_USER: event-demo
|
POSTGRES_USER: event-demo
|
||||||
healthcheck:
|
healthcheck:
|
||||||
test: ["CMD-SHELL", "sh -c 'pg_isready -U event-demo'"]
|
test: ["CMD-SHELL", "sh -c 'pg_isready -U event-demo'"]
|
||||||
@@ -31,7 +22,6 @@ services:
|
|||||||
retries: 10
|
retries: 10
|
||||||
volumes:
|
volumes:
|
||||||
- postgresql_data:/var/lib/postgresql
|
- postgresql_data:/var/lib/postgresql
|
||||||
- ../postgresql.secret:/run/secrets/postgresql_password:ro
|
|
||||||
|
|
||||||
rabbitmq:
|
rabbitmq:
|
||||||
image: rabbitmq:4-management-alpine
|
image: rabbitmq:4-management-alpine
|
||||||
@@ -47,7 +37,5 @@ services:
|
|||||||
- rabbitmq_data:/var/lib/rabbitmq/
|
- rabbitmq_data:/var/lib/rabbitmq/
|
||||||
|
|
||||||
volumes:
|
volumes:
|
||||||
redis_data:
|
|
||||||
redisinsight_data:
|
|
||||||
postgresql_data:
|
postgresql_data:
|
||||||
rabbitmq_data:
|
rabbitmq_data:
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
services:
|
||||||
|
tests:
|
||||||
|
build:
|
||||||
|
context: ../..
|
||||||
|
dockerfile: docker/DockerfileTest
|
||||||
|
volumes:
|
||||||
|
- ${GRADLE_CACHE_DIR:-gradle-cache}:/home/gradle/.gradle
|
||||||
|
- ../..:/app
|
||||||
|
depends_on:
|
||||||
|
flyway:
|
||||||
|
condition: service_completed_successfully
|
||||||
|
postgresql:
|
||||||
|
condition: service_healthy
|
||||||
|
rabbitmq:
|
||||||
|
condition: service_healthy
|
||||||
|
env_file:
|
||||||
|
- ../.env.docker
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
gradle-cache:
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
services:
|
||||||
|
pgadmin:
|
||||||
|
environment:
|
||||||
|
PGADMIN_CONFIG_SERVER_MODE: 'False'
|
||||||
|
PGADMIN_CONFIG_MASTER_PASSWORD_REQUIRED: 'False'
|
||||||
|
configs:
|
||||||
|
- source: pgpass
|
||||||
|
target: /pgpass
|
||||||
|
mode: 0600
|
||||||
|
uid: "5050"
|
||||||
|
gid: "5050"
|
||||||
|
- source: servers_json
|
||||||
|
target: /pgadmin4/servers.json
|
||||||
|
|
||||||
|
configs:
|
||||||
|
pgpass:
|
||||||
|
content: |
|
||||||
|
*:*:*:event-demo:changeit
|
||||||
@@ -2,32 +2,16 @@ services:
|
|||||||
pgadmin:
|
pgadmin:
|
||||||
image: dpage/pgadmin4
|
image: dpage/pgadmin4
|
||||||
environment:
|
environment:
|
||||||
PGADMIN_DEFAULT_EMAIL: $PGADMIN_DEFAULT_EMAIL
|
PGADMIN_DEFAULT_EMAIL: ${PGADMIN_DEFAULT_EMAIL:-admin@event-demo.dev}
|
||||||
PGADMIN_DEFAULT_PASSWORD_FILE: /run/secrets/pgadmin_password
|
|
||||||
PGADMIN_CONFIG_SERVER_MODE: 'False'
|
|
||||||
PGADMIN_CONFIG_MASTER_PASSWORD_REQUIRED: 'False'
|
|
||||||
secrets:
|
|
||||||
- pgadmin_password
|
|
||||||
volumes:
|
volumes:
|
||||||
- pgadmin_data:/var/lib/pgadmin
|
- pgadmin_data:/var/lib/pgadmin
|
||||||
configs:
|
configs:
|
||||||
- source: pgpass
|
|
||||||
target: /pgpass
|
|
||||||
mode: 0600
|
|
||||||
uid: "5050"
|
|
||||||
gid: "5050"
|
|
||||||
- source: servers_json
|
- source: servers_json
|
||||||
target: /pgadmin4/servers.json
|
target: /pgadmin4/servers.json
|
||||||
labels:
|
labels:
|
||||||
- "traefik.http.routers.pgadmin.rule=Host(`pgadmin.postgresql.traefik.me`)"
|
- "traefik.http.routers.pgadmin.rule=Host(`pgadmin.postgresql.traefik.me`)"
|
||||||
- "traefik.http.services.pgadmin.loadbalancer.server.port=80"
|
- "traefik.http.services.pgadmin.loadbalancer.server.port=80"
|
||||||
|
|
||||||
redis:
|
|
||||||
labels:
|
|
||||||
- "traefik.http.routers.redisinsight.rule=Host(`insight.redis.traefik.me`)"
|
|
||||||
- "traefik.http.routers.redisinsight.service=redisinsight"
|
|
||||||
- "traefik.http.services.redisinsight.loadbalancer.server.port=8001"
|
|
||||||
|
|
||||||
rabbitmq:
|
rabbitmq:
|
||||||
labels:
|
labels:
|
||||||
- "traefik.http.routers.rabbitmq-management.rule=Host(`management.rabbitmq.traefik.me`)"
|
- "traefik.http.routers.rabbitmq-management.rule=Host(`management.rabbitmq.traefik.me`)"
|
||||||
@@ -35,9 +19,6 @@ services:
|
|||||||
- "traefik.http.services.rabbitmq-management.loadbalancer.server.port=15672"
|
- "traefik.http.services.rabbitmq-management.loadbalancer.server.port=15672"
|
||||||
|
|
||||||
configs:
|
configs:
|
||||||
pgpass:
|
|
||||||
content: |
|
|
||||||
*:*:*:event-demo:changeit
|
|
||||||
servers_json:
|
servers_json:
|
||||||
content: |
|
content: |
|
||||||
{
|
{
|
||||||
@@ -55,9 +36,5 @@ configs:
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
secrets:
|
|
||||||
pgadmin_password:
|
|
||||||
file: ../pgadmin.secret
|
|
||||||
|
|
||||||
volumes:
|
volumes:
|
||||||
pgadmin_data:
|
pgadmin_data:
|
||||||
@@ -1,58 +1,264 @@
|
|||||||
openapi: "3.0.3"
|
openapi: "3.0.3"
|
||||||
info:
|
info:
|
||||||
title: "event_demo API"
|
title: "event_demo API"
|
||||||
description: "event_demo API"
|
description: |
|
||||||
version: "1.0.0"
|
API for the event_demo project: a small event-sourced Uno-like card game.
|
||||||
|
|
||||||
|
The API is split in two parts:
|
||||||
|
- a classic REST API used to authenticate, create users, list games and
|
||||||
|
replay a game's history.
|
||||||
|
- a WebSocket endpoint (`/games/{id}`) used to play a game in real time:
|
||||||
|
the client sends `GameCommand` messages and receives `Notification`
|
||||||
|
messages back. See the `x-websocket-channels` section below for details,
|
||||||
|
since WebSockets are not natively described by OpenAPI 3.0.
|
||||||
|
|
||||||
|
Authentication is done with a JWT bearer token obtained from `/login/{username}`.
|
||||||
|
Note that most polymorphic messages (`GameCommand`, `Notification`) are
|
||||||
|
discriminated by a `type` field whose value is the fully-qualified Kotlin
|
||||||
|
class name of the payload (since no custom serial name is declared for
|
||||||
|
these types), while `Card` uses short discriminator values
|
||||||
|
(`Simple`, `Reverse`, `Pass`, `Plus2`, `Plus4`, `ChangeColor`).
|
||||||
|
version: "2.0.0"
|
||||||
servers:
|
servers:
|
||||||
- url: "https://event_demo"
|
- url: "https://event_demo"
|
||||||
|
|
||||||
|
tags:
|
||||||
|
- name: Auth
|
||||||
|
description: User registration and authentication
|
||||||
|
- name: Games
|
||||||
|
description: Listing games and reading/playing their state
|
||||||
|
|
||||||
|
security:
|
||||||
|
- bearerAuth: []
|
||||||
|
|
||||||
paths:
|
paths:
|
||||||
"/game/{id}/card/last":
|
"/login/{username}":
|
||||||
get:
|
post:
|
||||||
description: get the last card played
|
tags: [Auth]
|
||||||
|
summary: Log in and obtain a JWT
|
||||||
|
security: []
|
||||||
|
parameters:
|
||||||
|
- name: username
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: password
|
||||||
|
in: query
|
||||||
|
description: The user's plain-text password.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: The last card
|
description: Successful login
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/Card"
|
$ref: "#/components/schemas/LoginResponse"
|
||||||
|
400:
|
||||||
|
description: Unknown username or invalid password
|
||||||
|
"/users/create":
|
||||||
|
post:
|
||||||
|
tags: [Auth]
|
||||||
|
summary: Create a new user account
|
||||||
|
description: Requires a valid JWT (any authenticated user can create new users).
|
||||||
|
parameters:
|
||||||
|
- name: username
|
||||||
|
in: query
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: password
|
||||||
|
in: query
|
||||||
|
description: The plain-text password, hashed server-side before being stored.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: The newly created user
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/CreateUserResponse"
|
||||||
|
401:
|
||||||
|
$ref: "#/components/responses/Unauthorized"
|
||||||
|
"/games":
|
||||||
|
get:
|
||||||
|
tags: [Games]
|
||||||
|
summary: List all known games
|
||||||
|
description: Returns up to the 100 most recent games (pagination is not yet exposed on this route).
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: The list of games
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: "#/components/schemas/GameList"
|
||||||
|
401:
|
||||||
|
$ref: "#/components/responses/Unauthorized"
|
||||||
|
"/games/{id}":
|
||||||
|
get:
|
||||||
|
tags: [Games]
|
||||||
|
summary: Replay a game's full notification history
|
||||||
|
description: |
|
||||||
|
Rebuilds every notification that would have been sent to the calling
|
||||||
|
player since the beginning of the game (from its event stream), so a
|
||||||
|
client reconnecting can catch up on the current game state.
|
||||||
|
|
||||||
|
This same path also accepts a WebSocket upgrade to play the game live,
|
||||||
|
see `x-websocket-channels` at the root of this document.
|
||||||
|
parameters:
|
||||||
|
- name: id
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: The full list of notifications for this game, from this player's point of view
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: "#/components/schemas/Notification"
|
||||||
|
401:
|
||||||
|
$ref: "#/components/responses/Unauthorized"
|
||||||
|
404:
|
||||||
|
description: No game found for this id
|
||||||
|
|
||||||
|
x-websocket-channels:
|
||||||
|
"/games/{id}":
|
||||||
|
description: |
|
||||||
|
WebSocket endpoint to join and play a game in real time. Requires the
|
||||||
|
same JWT bearer authentication as the REST routes (sent the same way,
|
||||||
|
e.g. via the `Authorization` header during the WebSocket handshake).
|
||||||
|
parameters:
|
||||||
|
- name: id
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
send:
|
||||||
|
description: Commands sent by the client to act on the game.
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/GameCommand"
|
||||||
|
receive:
|
||||||
|
description: Notifications sent by the server as the game progresses.
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/Notification"
|
||||||
|
|
||||||
components:
|
components:
|
||||||
|
securitySchemes:
|
||||||
|
bearerAuth:
|
||||||
|
type: http
|
||||||
|
scheme: bearer
|
||||||
|
bearerFormat: JWT
|
||||||
|
description: >
|
||||||
|
JWT obtained from `POST /login/{username}`. It carries the `username`
|
||||||
|
and `userid` claims and currently expires 60 seconds after issuance.
|
||||||
|
|
||||||
|
responses:
|
||||||
|
Unauthorized:
|
||||||
|
description: Missing, invalid or expired JWT
|
||||||
|
content:
|
||||||
|
text/plain:
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
example: "Token is not valid or has expired"
|
||||||
|
|
||||||
schemas:
|
schemas:
|
||||||
Card:
|
LoginResponse:
|
||||||
oneOf:
|
type: object
|
||||||
- $ref: "#/components/schemas/SimpleCard"
|
required: [token]
|
||||||
- $ref: "#/components/schemas/ReverseCard"
|
|
||||||
- $ref: "#/components/schemas/PassCard"
|
|
||||||
- $ref: "#/components/schemas/Plus2Card"
|
|
||||||
- $ref: "#/components/schemas/Plus4Card"
|
|
||||||
- $ref: "#/components/schemas/ChangeColorCard"
|
|
||||||
SimpleCard:
|
|
||||||
properties:
|
properties:
|
||||||
number:
|
token:
|
||||||
|
type: string
|
||||||
|
description: JWT bearer token to use on subsequent requests.
|
||||||
|
|
||||||
|
CreateUserResponse:
|
||||||
|
type: object
|
||||||
|
required: [id]
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
|
||||||
|
HttpErrorBadRequest:
|
||||||
|
type: object
|
||||||
|
description: Generic problem-details style error body used by some validation failures.
|
||||||
|
properties:
|
||||||
|
title:
|
||||||
|
type: string
|
||||||
|
statusCode:
|
||||||
type: integer
|
type: integer
|
||||||
color:
|
invalidParams:
|
||||||
$ref: "#/components/schemas/CardColor"
|
type: array
|
||||||
ReverseCard:
|
items:
|
||||||
|
$ref: "#/components/schemas/InvalidParam"
|
||||||
|
|
||||||
|
InvalidParam:
|
||||||
|
type: object
|
||||||
|
required: [name, reason]
|
||||||
properties:
|
properties:
|
||||||
color:
|
name:
|
||||||
$ref: "#/components/schemas/CardColor"
|
type: string
|
||||||
PassCard:
|
reason:
|
||||||
|
type: string
|
||||||
|
|
||||||
|
PlayerId:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
|
||||||
|
Player:
|
||||||
|
type: object
|
||||||
|
required: [name, userId, hand, id]
|
||||||
properties:
|
properties:
|
||||||
color:
|
name:
|
||||||
$ref: "#/components/schemas/CardColor"
|
type: string
|
||||||
Plus2Card:
|
userId:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
id:
|
||||||
|
$ref: "#/components/schemas/PlayerId"
|
||||||
|
hand:
|
||||||
|
description: The set of cards currently held by the player.
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: "#/components/schemas/Card"
|
||||||
|
|
||||||
|
GameList:
|
||||||
|
type: object
|
||||||
|
required: [aggregateId, status, players, winners]
|
||||||
properties:
|
properties:
|
||||||
color:
|
aggregateId:
|
||||||
$ref: "#/components/schemas/CardColor"
|
type: string
|
||||||
Plus4Card:
|
format: uuid
|
||||||
properties:
|
status:
|
||||||
nextColor:
|
$ref: "#/components/schemas/GameStatus"
|
||||||
$ref: "#/components/schemas/CardColor"
|
players:
|
||||||
ChangeColorCard:
|
type: array
|
||||||
properties:
|
items:
|
||||||
nextColor:
|
$ref: "#/components/schemas/Player"
|
||||||
$ref: "#/components/schemas/CardColor"
|
winners:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: "#/components/schemas/PlayerId"
|
||||||
|
|
||||||
|
GameStatus:
|
||||||
|
type: string
|
||||||
|
enum:
|
||||||
|
- OPENING
|
||||||
|
- IS_STARTED
|
||||||
|
- FINISH
|
||||||
|
- CANCELED
|
||||||
|
|
||||||
CardColor:
|
CardColor:
|
||||||
type: string
|
type: string
|
||||||
enum:
|
enum:
|
||||||
@@ -60,3 +266,401 @@ components:
|
|||||||
- Red
|
- Red
|
||||||
- Yellow
|
- Yellow
|
||||||
- Green
|
- Green
|
||||||
|
|
||||||
|
Card:
|
||||||
|
description: >
|
||||||
|
A playing card. Discriminated by the "type" field using the short
|
||||||
|
names declared on each Kotlin subtype (@SerialName), unlike
|
||||||
|
GameCommand/Notification below.
|
||||||
|
oneOf:
|
||||||
|
- $ref: "#/components/schemas/NumericCard"
|
||||||
|
- $ref: "#/components/schemas/ReverseCard"
|
||||||
|
- $ref: "#/components/schemas/PassCard"
|
||||||
|
- $ref: "#/components/schemas/Plus2Card"
|
||||||
|
- $ref: "#/components/schemas/Plus4Card"
|
||||||
|
- $ref: "#/components/schemas/ChangeColorCard"
|
||||||
|
discriminator:
|
||||||
|
propertyName: type
|
||||||
|
mapping:
|
||||||
|
Simple: "#/components/schemas/NumericCard"
|
||||||
|
Reverse: "#/components/schemas/ReverseCard"
|
||||||
|
Pass: "#/components/schemas/PassCard"
|
||||||
|
Plus2: "#/components/schemas/Plus2Card"
|
||||||
|
Plus4: "#/components/schemas/Plus4Card"
|
||||||
|
ChangeColor: "#/components/schemas/ChangeColorCard"
|
||||||
|
|
||||||
|
NumericCard:
|
||||||
|
description: A numbered card (0-9) of a given color.
|
||||||
|
type: object
|
||||||
|
required: [type, id, number, color]
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
enum: [Simple]
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
number:
|
||||||
|
type: integer
|
||||||
|
minimum: 0
|
||||||
|
maximum: 9
|
||||||
|
color:
|
||||||
|
$ref: "#/components/schemas/CardColor"
|
||||||
|
|
||||||
|
ReverseCard:
|
||||||
|
description: Reverses the turn order.
|
||||||
|
type: object
|
||||||
|
required: [type, id, color]
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
enum: [Reverse]
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
color:
|
||||||
|
$ref: "#/components/schemas/CardColor"
|
||||||
|
|
||||||
|
PassCard:
|
||||||
|
description: Skips the next player's turn.
|
||||||
|
type: object
|
||||||
|
required: [type, id, color]
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
enum: [Pass]
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
color:
|
||||||
|
$ref: "#/components/schemas/CardColor"
|
||||||
|
|
||||||
|
Plus2Card:
|
||||||
|
description: Forces the next player to draw 2 cards and skips their turn.
|
||||||
|
type: object
|
||||||
|
required: [type, id, color]
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
enum: [Plus2]
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
color:
|
||||||
|
$ref: "#/components/schemas/CardColor"
|
||||||
|
|
||||||
|
Plus4Card:
|
||||||
|
description: >
|
||||||
|
Forces the next player to draw 4 cards and skips their turn. The new
|
||||||
|
color is chosen separately, via the `chosenColor` field of
|
||||||
|
PlayCardCommand, and is not part of the card itself.
|
||||||
|
type: object
|
||||||
|
required: [type, id]
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
enum: [Plus4]
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
|
||||||
|
ChangeColorCard:
|
||||||
|
description: >
|
||||||
|
Changes the current color. The new color is chosen separately, via
|
||||||
|
the `chosenColor` field of PlayCardCommand, and is not part of the
|
||||||
|
card itself.
|
||||||
|
type: object
|
||||||
|
required: [type, id]
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
enum: [ChangeColor]
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
|
||||||
|
GameCommand:
|
||||||
|
description: >
|
||||||
|
A command sent by the client over the game WebSocket to act on a game.
|
||||||
|
Discriminated by "type", whose value is the fully-qualified Kotlin
|
||||||
|
class name of the command (no `@SerialName` is declared on these
|
||||||
|
types).
|
||||||
|
oneOf:
|
||||||
|
- $ref: "#/components/schemas/JoinTheGameCommand"
|
||||||
|
- $ref: "#/components/schemas/PlayCardCommand"
|
||||||
|
- $ref: "#/components/schemas/ReadyToPlayCommand"
|
||||||
|
- $ref: "#/components/schemas/TakeCartFromDrawPileCommand"
|
||||||
|
discriminator:
|
||||||
|
propertyName: type
|
||||||
|
mapping:
|
||||||
|
eventDemo.contexts.game.application.command.models.JoinTheGameCommand: "#/components/schemas/JoinTheGameCommand"
|
||||||
|
eventDemo.contexts.game.application.command.models.PlayCardCommand: "#/components/schemas/PlayCardCommand"
|
||||||
|
eventDemo.contexts.game.application.command.models.ReadyToPlayCommand: "#/components/schemas/ReadyToPlayCommand"
|
||||||
|
eventDemo.contexts.game.application.command.models.TakeCartFromDrawPileCommand: "#/components/schemas/TakeCartFromDrawPileCommand"
|
||||||
|
|
||||||
|
JoinTheGameCommand:
|
||||||
|
description: Join an existing (not yet started) game.
|
||||||
|
type: object
|
||||||
|
required: [type, userId, payload]
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
enum: [eventDemo.contexts.game.application.command.models.JoinTheGameCommand]
|
||||||
|
userId:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
payload:
|
||||||
|
type: object
|
||||||
|
required: [aggregateId]
|
||||||
|
properties:
|
||||||
|
aggregateId:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
description: The id of the game to join.
|
||||||
|
|
||||||
|
ReadyToPlayCommand:
|
||||||
|
description: Mark the calling player as ready, so the game can start once everyone is ready.
|
||||||
|
type: object
|
||||||
|
required: [type, userId, payload]
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
enum: [eventDemo.contexts.game.application.command.models.ReadyToPlayCommand]
|
||||||
|
userId:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
payload:
|
||||||
|
type: object
|
||||||
|
required: [aggregateId, playerId]
|
||||||
|
properties:
|
||||||
|
aggregateId:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
playerId:
|
||||||
|
$ref: "#/components/schemas/PlayerId"
|
||||||
|
|
||||||
|
TakeCartFromDrawPileCommand:
|
||||||
|
description: Draw a card from the draw pile.
|
||||||
|
type: object
|
||||||
|
required: [type, userId, payload]
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
enum: [eventDemo.contexts.game.application.command.models.TakeCartFromDrawPileCommand]
|
||||||
|
userId:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
payload:
|
||||||
|
type: object
|
||||||
|
required: [aggregateId, playerId]
|
||||||
|
properties:
|
||||||
|
aggregateId:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
playerId:
|
||||||
|
$ref: "#/components/schemas/PlayerId"
|
||||||
|
|
||||||
|
PlayCardCommand:
|
||||||
|
description: Play a card from the calling player's hand.
|
||||||
|
type: object
|
||||||
|
required: [type, userId, payload]
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
enum: [eventDemo.contexts.game.application.command.models.PlayCardCommand]
|
||||||
|
userId:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
payload:
|
||||||
|
type: object
|
||||||
|
required: [aggregateId, playerId, card]
|
||||||
|
properties:
|
||||||
|
aggregateId:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
playerId:
|
||||||
|
$ref: "#/components/schemas/PlayerId"
|
||||||
|
card:
|
||||||
|
$ref: "#/components/schemas/Card"
|
||||||
|
chosenColor:
|
||||||
|
description: The color to switch to, only required when playing a Plus4Card or ChangeColorCard.
|
||||||
|
nullable: true
|
||||||
|
allOf:
|
||||||
|
- $ref: "#/components/schemas/CardColor"
|
||||||
|
|
||||||
|
Notification:
|
||||||
|
description: >
|
||||||
|
A notification sent by the server, either replayed by `GET /games/{id}`
|
||||||
|
or streamed live over the game WebSocket. Discriminated by "type",
|
||||||
|
whose value is the fully-qualified Kotlin class name of the
|
||||||
|
notification (no `@SerialName` is declared on these types).
|
||||||
|
oneOf:
|
||||||
|
- $ref: "#/components/schemas/WelcomeToTheGameNotification"
|
||||||
|
- $ref: "#/components/schemas/PlayerAsJoinTheGameNotification"
|
||||||
|
- $ref: "#/components/schemas/PlayerWasReadyNotification"
|
||||||
|
- $ref: "#/components/schemas/TheGameWasStartedNotification"
|
||||||
|
- $ref: "#/components/schemas/ItsTheTurnOfNotification"
|
||||||
|
- $ref: "#/components/schemas/PlayerAsPlayACardNotification"
|
||||||
|
- $ref: "#/components/schemas/YourNewCardNotification"
|
||||||
|
- $ref: "#/components/schemas/PlayerHavePassNotification"
|
||||||
|
- $ref: "#/components/schemas/PilesShuffledNotification"
|
||||||
|
- $ref: "#/components/schemas/PlayerWinNotification"
|
||||||
|
discriminator:
|
||||||
|
propertyName: type
|
||||||
|
mapping:
|
||||||
|
eventDemo.contexts.game.application.notification.models.WelcomeToTheGameNotification: "#/components/schemas/WelcomeToTheGameNotification"
|
||||||
|
eventDemo.contexts.game.application.notification.models.PlayerAsJoinTheGameNotification: "#/components/schemas/PlayerAsJoinTheGameNotification"
|
||||||
|
eventDemo.contexts.game.application.notification.models.PlayerWasReadyNotification: "#/components/schemas/PlayerWasReadyNotification"
|
||||||
|
eventDemo.contexts.game.application.notification.models.TheGameWasStartedNotification: "#/components/schemas/TheGameWasStartedNotification"
|
||||||
|
eventDemo.contexts.game.application.notification.models.ItsTheTurnOfNotification: "#/components/schemas/ItsTheTurnOfNotification"
|
||||||
|
eventDemo.contexts.game.application.notification.models.PlayerAsPlayACardNotification: "#/components/schemas/PlayerAsPlayACardNotification"
|
||||||
|
eventDemo.contexts.game.application.notification.models.YourNewCardNotification: "#/components/schemas/YourNewCardNotification"
|
||||||
|
eventDemo.contexts.game.application.notification.models.PlayerHavePassNotification: "#/components/schemas/PlayerHavePassNotification"
|
||||||
|
eventDemo.contexts.game.application.notification.models.PilesShuffledNotification: "#/components/schemas/PilesShuffledNotification"
|
||||||
|
eventDemo.contexts.game.application.notification.models.PlayerWinNotification: "#/components/schemas/PlayerWinNotification"
|
||||||
|
|
||||||
|
WelcomeToTheGameNotification:
|
||||||
|
description: Sent to a player right after they join a game, listing all players currently in it.
|
||||||
|
type: object
|
||||||
|
required: [type, id, players]
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
enum: [eventDemo.contexts.game.application.notification.models.WelcomeToTheGameNotification]
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
players:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: "#/components/schemas/Player"
|
||||||
|
|
||||||
|
PlayerAsJoinTheGameNotification:
|
||||||
|
description: Sent to the other players when a new player joins the game.
|
||||||
|
type: object
|
||||||
|
required: [type, id, player]
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
enum: [eventDemo.contexts.game.application.notification.models.PlayerAsJoinTheGameNotification]
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
player:
|
||||||
|
$ref: "#/components/schemas/Player"
|
||||||
|
|
||||||
|
PlayerWasReadyNotification:
|
||||||
|
description: Sent to all players when a player marks themselves as ready.
|
||||||
|
type: object
|
||||||
|
required: [type, id, playerId]
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
enum: [eventDemo.contexts.game.application.notification.models.PlayerWasReadyNotification]
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
playerId:
|
||||||
|
$ref: "#/components/schemas/PlayerId"
|
||||||
|
|
||||||
|
TheGameWasStartedNotification:
|
||||||
|
description: Sent to each player when the game starts, with their initial hand.
|
||||||
|
type: object
|
||||||
|
required: [type, id, hand]
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
enum: [eventDemo.contexts.game.application.notification.models.TheGameWasStartedNotification]
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
hand:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: "#/components/schemas/Card"
|
||||||
|
|
||||||
|
ItsTheTurnOfNotification:
|
||||||
|
description: Sent to all players to indicate whose turn it now is.
|
||||||
|
type: object
|
||||||
|
required: [type, id, player]
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
enum: [eventDemo.contexts.game.application.notification.models.ItsTheTurnOfNotification]
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
player:
|
||||||
|
$ref: "#/components/schemas/Player"
|
||||||
|
|
||||||
|
PlayerAsPlayACardNotification:
|
||||||
|
description: Sent to all players when a player plays a card.
|
||||||
|
type: object
|
||||||
|
required: [type, id, playerId, card]
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
enum: [eventDemo.contexts.game.application.notification.models.PlayerAsPlayACardNotification]
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
playerId:
|
||||||
|
$ref: "#/components/schemas/PlayerId"
|
||||||
|
card:
|
||||||
|
$ref: "#/components/schemas/Card"
|
||||||
|
|
||||||
|
YourNewCardNotification:
|
||||||
|
description: Sent to a player with the cards they just drew from the draw pile.
|
||||||
|
type: object
|
||||||
|
required: [type, id, cards]
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
enum: [eventDemo.contexts.game.application.notification.models.YourNewCardNotification]
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
cards:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: "#/components/schemas/Card"
|
||||||
|
|
||||||
|
PlayerHavePassNotification:
|
||||||
|
description: Sent to the other players when a player draws a card and passes their turn.
|
||||||
|
type: object
|
||||||
|
required: [type, id, playerId]
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
enum: [eventDemo.contexts.game.application.notification.models.PlayerHavePassNotification]
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
playerId:
|
||||||
|
$ref: "#/components/schemas/PlayerId"
|
||||||
|
|
||||||
|
PilesShuffledNotification:
|
||||||
|
description: Sent to all players when the discard pile is reshuffled into the draw pile.
|
||||||
|
type: object
|
||||||
|
required: [type, id]
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
enum: [eventDemo.contexts.game.application.notification.models.PilesShuffledNotification]
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
|
||||||
|
PlayerWinNotification:
|
||||||
|
description: Sent to all players when a player wins the game.
|
||||||
|
type: object
|
||||||
|
required: [type, id, playerId]
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
enum: [eventDemo.contexts.game.application.notification.models.PlayerWinNotification]
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
playerId:
|
||||||
|
$ref: "#/components/schemas/PlayerId"
|
||||||
@@ -3,7 +3,6 @@ package eventDemo.configuration
|
|||||||
import io.ktor.server.config.ApplicationConfig
|
import io.ktor.server.config.ApplicationConfig
|
||||||
|
|
||||||
data class Configuration(
|
data class Configuration(
|
||||||
val redisUrl: String,
|
|
||||||
val jwtSecret: String,
|
val jwtSecret: String,
|
||||||
val postgresql: Postgresql,
|
val postgresql: Postgresql,
|
||||||
val rabbitmq: RabbitMQ,
|
val rabbitmq: RabbitMQ,
|
||||||
@@ -25,7 +24,6 @@ data class Configuration(
|
|||||||
val ApplicationConfig.configuration
|
val ApplicationConfig.configuration
|
||||||
get() =
|
get() =
|
||||||
Configuration(
|
Configuration(
|
||||||
redisUrl = getProperty("redis.url"),
|
|
||||||
jwtSecret = getProperty("jwt.secret"),
|
jwtSecret = getProperty("jwt.secret"),
|
||||||
postgresql =
|
postgresql =
|
||||||
Configuration.Postgresql(
|
Configuration.Postgresql(
|
||||||
|
|||||||
@@ -7,8 +7,6 @@ import org.koin.core.module.Module
|
|||||||
import org.koin.core.scope.Scope
|
import org.koin.core.scope.Scope
|
||||||
import org.koin.core.scope.ScopeCallback
|
import org.koin.core.scope.ScopeCallback
|
||||||
import org.koin.dsl.bind
|
import org.koin.dsl.bind
|
||||||
import redis.clients.jedis.JedisPooled
|
|
||||||
import redis.clients.jedis.UnifiedJedis
|
|
||||||
import javax.sql.DataSource
|
import javax.sql.DataSource
|
||||||
|
|
||||||
fun Module.configureDIDataSource(config: Configuration) {
|
fun Module.configureDIDataSource(config: Configuration) {
|
||||||
@@ -26,11 +24,6 @@ fun Module.configureDIDataSource(config: Configuration) {
|
|||||||
}
|
}
|
||||||
} bind DataSource::class
|
} bind DataSource::class
|
||||||
|
|
||||||
// Redis (for Projections)
|
|
||||||
single {
|
|
||||||
JedisPooled(config.redisUrl)
|
|
||||||
} bind UnifiedJedis::class
|
|
||||||
|
|
||||||
// RabbitMQ (for EventBus)
|
// RabbitMQ (for EventBus)
|
||||||
factory {
|
factory {
|
||||||
ConnectionFactory().apply {
|
ConnectionFactory().apply {
|
||||||
|
|||||||
@@ -12,11 +12,6 @@ jwt {
|
|||||||
secret = ${?JWT_SECRET}
|
secret = ${?JWT_SECRET}
|
||||||
}
|
}
|
||||||
|
|
||||||
redis {
|
|
||||||
url = "redis://localhost:6379"
|
|
||||||
url = ${?REDIS_URL}
|
|
||||||
}
|
|
||||||
|
|
||||||
postgresql {
|
postgresql {
|
||||||
url = "jdbc:postgresql://localhost:5432/event-demo"
|
url = "jdbc:postgresql://localhost:5432/event-demo"
|
||||||
url = ${?POSTGRESQL_URL}
|
url = ${?POSTGRESQL_URL}
|
||||||
|
|||||||
@@ -7,7 +7,5 @@ object Tag {
|
|||||||
|
|
||||||
object RabbitMQ : Tag()
|
object RabbitMQ : Tag()
|
||||||
|
|
||||||
object Redis : Tag()
|
|
||||||
|
|
||||||
object Concurrence : Tag()
|
object Concurrence : Tag()
|
||||||
}
|
}
|
||||||
@@ -6,12 +6,18 @@ import com.tngtech.archunit.library.Architectures.layeredArchitecture
|
|||||||
import org.junit.jupiter.api.Test
|
import org.junit.jupiter.api.Test
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Vérifie le respect des frontières de l'architecture hexagonale (ports & adapters).
|
* Vérifie le respect des frontières de l'architecture hexagonale (ports & adapters),
|
||||||
|
* pour chaque bounded context sous `eventDemo.contexts`.
|
||||||
*
|
*
|
||||||
* Convention attendue :
|
* Les contexts ne sont pas listés en dur : ils sont déduits des classes réellement
|
||||||
* eventDemo.contexts.uno.domain
|
* présentes sous `eventDemo.contexts.*`, de sorte que l'ajout d'un nouveau context
|
||||||
* eventDemo.contexts.uno.application
|
* (nouveau dossier `eventDemo.contexts.<xxx>`) soit automatiquement couvert par ce test,
|
||||||
* eventDemo.contexts.uno.infrastructure
|
* sans modification de ce fichier.
|
||||||
|
*
|
||||||
|
* Convention attendue, pour un contexte donné :
|
||||||
|
* eventDemo.contexts.<context>.domain
|
||||||
|
* eventDemo.contexts.<context>.application
|
||||||
|
* eventDemo.contexts.<context>.infrastructure
|
||||||
*
|
*
|
||||||
* Règles imposées :
|
* Règles imposées :
|
||||||
* – domain → ne dépend d'aucune autre couche (ni application, ni infrastructure)
|
* – domain → ne dépend d'aucune autre couche (ni application, ni infrastructure)
|
||||||
@@ -19,24 +25,42 @@ import org.junit.jupiter.api.Test
|
|||||||
* – infrastructure → ne dépend que de domain et application
|
* – infrastructure → ne dépend que de domain et application
|
||||||
*/
|
*/
|
||||||
class HexagonalArchitectureTest {
|
class HexagonalArchitectureTest {
|
||||||
private val basePackage = "eventDemo.contexts.uno"
|
private val rootPackage = "eventDemo.contexts"
|
||||||
|
|
||||||
private val classes =
|
private val classes =
|
||||||
ClassFileImporter()
|
ClassFileImporter()
|
||||||
.withImportOption(ImportOption.Predefined.DO_NOT_INCLUDE_TESTS)
|
.withImportOption(ImportOption.Predefined.DO_NOT_INCLUDE_TESTS)
|
||||||
.importPackages(basePackage)
|
.importPackages(rootPackage)
|
||||||
|
|
||||||
|
// Premier segment de package après "eventDemo.contexts." (ex. "auth", "game", ...),
|
||||||
|
// recalculé à chaque exécution à partir des classes importées.
|
||||||
|
private val contexts: Set<String> =
|
||||||
|
classes
|
||||||
|
.map { it.packageName }
|
||||||
|
.filter { it.startsWith("$rootPackage.") }
|
||||||
|
.map { it.removePrefix("$rootPackage.").substringBefore('.') }
|
||||||
|
.toSet()
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
fun `respecte les couches de l'architecture hexagonale`() {
|
fun `respecte les couches de l'architecture hexagonale`() {
|
||||||
@Suppress("ktlint:standard:chain-method-continuation")
|
check(contexts.isNotEmpty()) {
|
||||||
layeredArchitecture()
|
"Aucun context trouvé sous `$rootPackage` : le test ne vérifie rien, " +
|
||||||
.consideringAllDependencies()
|
"vérifiez que le package racine est correct."
|
||||||
.layer("Domain").definedBy("$basePackage.domain..")
|
}
|
||||||
.layer("Application").definedBy("$basePackage.application..")
|
|
||||||
.layer("Infrastructure").definedBy("$basePackage.infrastructure..")
|
contexts.forEach { context ->
|
||||||
.whereLayer("Domain").mayNotAccessAnyLayer()
|
val basePackage = "$rootPackage.$context"
|
||||||
.whereLayer("Application").mayOnlyAccessLayers("Domain")
|
|
||||||
.whereLayer("Infrastructure").mayOnlyAccessLayers("Domain", "Application")
|
@Suppress("ktlint:standard:chain-method-continuation")
|
||||||
.check(classes)
|
layeredArchitecture()
|
||||||
|
.consideringAllDependencies()
|
||||||
|
.layer("Domain").definedBy("$basePackage.domain..")
|
||||||
|
.layer("Application").definedBy("$basePackage.application..")
|
||||||
|
.layer("Infrastructure").definedBy("$basePackage.infrastructure..")
|
||||||
|
.whereLayer("Domain").mayNotAccessAnyLayer()
|
||||||
|
.whereLayer("Application").mayOnlyAccessLayers("Domain")
|
||||||
|
.whereLayer("Infrastructure").mayOnlyAccessLayers("Domain", "Application")
|
||||||
|
.check(classes)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -26,11 +26,13 @@ import eventDemo.testHelpers.createNewUser
|
|||||||
import eventDemo.testHelpers.testKoinApplicationWithConfig
|
import eventDemo.testHelpers.testKoinApplicationWithConfig
|
||||||
import io.kotest.assertions.nondeterministic.eventually
|
import io.kotest.assertions.nondeterministic.eventually
|
||||||
import io.kotest.assertions.nondeterministic.until
|
import io.kotest.assertions.nondeterministic.until
|
||||||
|
import io.kotest.assertions.retry
|
||||||
import io.kotest.core.spec.style.FunSpec
|
import io.kotest.core.spec.style.FunSpec
|
||||||
import io.kotest.matchers.collections.shouldContainExactly
|
import io.kotest.matchers.collections.shouldContainExactly
|
||||||
import io.kotest.matchers.equals.shouldBeEqual
|
import io.kotest.matchers.equals.shouldBeEqual
|
||||||
import io.kotest.matchers.equals.shouldEqual
|
import io.kotest.matchers.equals.shouldEqual
|
||||||
import io.kotest.matchers.nulls.shouldNotBeNull
|
import io.kotest.matchers.nulls.shouldNotBeNull
|
||||||
|
import io.kotest.matchers.should
|
||||||
import io.kotest.matchers.types.shouldBeInstanceOf
|
import io.kotest.matchers.types.shouldBeInstanceOf
|
||||||
import kotlinx.coroutines.DelicateCoroutinesApi
|
import kotlinx.coroutines.DelicateCoroutinesApi
|
||||||
import kotlinx.coroutines.Dispatchers
|
import kotlinx.coroutines.Dispatchers
|
||||||
@@ -49,223 +51,225 @@ class GameSimulationTest :
|
|||||||
tags(Tag.Postgresql)
|
tags(Tag.Postgresql)
|
||||||
|
|
||||||
test("Simulation of a game") {
|
test("Simulation of a game") {
|
||||||
withTimeout(10.seconds) {
|
should {
|
||||||
disableRandomForTest()
|
retry(maxRetry = 3, timeout = 20.seconds) {
|
||||||
val gameId = GameId()
|
disableRandomForTest()
|
||||||
val user1 = createNewUser("user1")
|
val gameId = GameId()
|
||||||
val user2 = createNewUser("user2")
|
val user1 = createNewUser("user1")
|
||||||
|
val user2 = createNewUser("user2")
|
||||||
|
|
||||||
val channelCommand1 = Channel<GameCommand>(Channel.BUFFERED)
|
val channelCommand1 = Channel<GameCommand>(Channel.BUFFERED)
|
||||||
val channelCommand2 = Channel<GameCommand>(Channel.BUFFERED)
|
val channelCommand2 = Channel<GameCommand>(Channel.BUFFERED)
|
||||||
val channelNotification1 = Channel<Notification>(Channel.BUFFERED)
|
val channelNotification1 = Channel<Notification>(Channel.BUFFERED)
|
||||||
val channelNotification2 = Channel<Notification>(Channel.BUFFERED)
|
val channelNotification2 = Channel<Notification>(Channel.BUFFERED)
|
||||||
|
|
||||||
var playedCard1: Card? = null
|
var playedCard1: Card? = null
|
||||||
var playedCard2: Card? = null
|
var playedCard2: Card? = null
|
||||||
|
|
||||||
var player1HasJoin = false
|
var player1HasJoin = false
|
||||||
|
|
||||||
testKoinApplicationWithConfig {
|
testKoinApplicationWithConfig {
|
||||||
val gameRepository = get<GameRepository>()
|
val gameRepository = get<GameRepository>()
|
||||||
val userRepository = get<UserRepository>()
|
val userRepository = get<UserRepository>()
|
||||||
userRepository.run {
|
userRepository.run {
|
||||||
save(user1)
|
save(user1)
|
||||||
save(user2)
|
save(user2)
|
||||||
}
|
}
|
||||||
|
|
||||||
gameRepository.create(gameId)
|
gameRepository.create(gameId)
|
||||||
|
|
||||||
// Run command/notification subscriber
|
// Run command/notification subscriber
|
||||||
// In the normal process, these subscriber is invoque on players connect to the websocket
|
// In the normal process, these subscriber is invoque on players connect to the websocket
|
||||||
GlobalScope.launch(Dispatchers.IO) {
|
GlobalScope.launch(Dispatchers.IO) {
|
||||||
get<GameChannelsSubscriber>().subscribePlayerToGameChannels(
|
get<GameChannelsSubscriber>().subscribePlayerToGameChannels(
|
||||||
gameId,
|
gameId,
|
||||||
user1.id,
|
user1.id,
|
||||||
channelCommand1,
|
channelCommand1,
|
||||||
channelNotification1,
|
channelNotification1,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
GlobalScope.launch(Dispatchers.IO) {
|
GlobalScope.launch(Dispatchers.IO) {
|
||||||
get<GameChannelsSubscriber>().subscribePlayerToGameChannels(
|
get<GameChannelsSubscriber>().subscribePlayerToGameChannels(
|
||||||
gameId,
|
gameId,
|
||||||
user2.id,
|
user2.id,
|
||||||
channelCommand2,
|
channelCommand2,
|
||||||
channelNotification2,
|
channelNotification2,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Consume etch notification of players, and put theses in a list.
|
// Consume etch notification of players, and put theses in a list.
|
||||||
// Is used later to control when other players can execute the next action
|
// Is used later to control when other players can execute the next action
|
||||||
val player1Notifications = mutableListOf<Notification>()
|
val player1Notifications = mutableListOf<Notification>()
|
||||||
val player2Notifications = mutableListOf<Notification>()
|
val player2Notifications = mutableListOf<Notification>()
|
||||||
run {
|
run {
|
||||||
GlobalScope.launch {
|
GlobalScope.launch {
|
||||||
for (notification in channelNotification1) {
|
for (notification in channelNotification1) {
|
||||||
player1Notifications.add(notification)
|
player1Notifications.add(notification)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
GlobalScope.launch {
|
||||||
|
for (notification in channelNotification2) {
|
||||||
|
player2Notifications.add(notification)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
GlobalScope.launch {
|
// Player 1 actions
|
||||||
for (notification in channelNotification2) {
|
val player1Job =
|
||||||
player2Notifications.add(notification)
|
launch {
|
||||||
}
|
createGameWithCommandsInChannels(channelCommand1, gameId, user1) {
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Player 1 actions
|
joinTheGame()
|
||||||
val player1Job =
|
player1Notifications.waitNotification<WelcomeToTheGameNotification> {
|
||||||
launch {
|
players.map { it.userId }.contains(user1.id)
|
||||||
createGameWithCommandsInChannels(channelCommand1, gameId, user1) {
|
|
||||||
|
|
||||||
joinTheGame()
|
|
||||||
player1Notifications.waitNotification<WelcomeToTheGameNotification> {
|
|
||||||
players.map { it.userId }.contains(user1.id)
|
|
||||||
}
|
|
||||||
|
|
||||||
player1HasJoin = true
|
|
||||||
|
|
||||||
player1Notifications.waitNotification<PlayerAsJoinTheGameNotification> {
|
|
||||||
player.userId == user2.id
|
|
||||||
}
|
|
||||||
|
|
||||||
readyToPlay()
|
|
||||||
player1Notifications.waitNotification<PlayerWasReadyNotification> {
|
|
||||||
playerId == getPlayer(user2).id
|
|
||||||
}
|
|
||||||
|
|
||||||
playedCard1 =
|
|
||||||
player1Notifications
|
|
||||||
.waitNotification<TheGameWasStartedNotification> { hand.size == 7 }
|
|
||||||
.hand
|
|
||||||
.first()
|
|
||||||
.apply {
|
|
||||||
this.shouldBeInstanceOf<Card.NumericCard>()
|
|
||||||
number shouldEqual 1
|
|
||||||
color shouldEqual Card.Color.Red
|
|
||||||
}
|
|
||||||
|
|
||||||
player1Notifications.waitNotification<ItsTheTurnOfNotification> {
|
|
||||||
if (player.userId == user2.id) error("WRONG PLAYER TURN")
|
|
||||||
player.userId == user1.id
|
|
||||||
}
|
|
||||||
|
|
||||||
game
|
|
||||||
.shouldBeInstanceOf<GameStarted>()
|
|
||||||
.discardPile
|
|
||||||
.topCard
|
|
||||||
.shouldNotBeNull()
|
|
||||||
.shouldBeInstanceOf<Card.NumericCard> {
|
|
||||||
it.number shouldEqual 0
|
|
||||||
it.color shouldEqual Card.Color.Red
|
|
||||||
}
|
}
|
||||||
|
|
||||||
playCard(playedCard1!!)
|
player1HasJoin = true
|
||||||
|
|
||||||
player1Notifications.waitNotification<ItsTheTurnOfNotification> {
|
player1Notifications.waitNotification<PlayerAsJoinTheGameNotification> {
|
||||||
player == getPlayer(user2)
|
player.userId == user2.id
|
||||||
}
|
|
||||||
|
|
||||||
player1Notifications.waitNotification<PlayerAsPlayACardNotification> {
|
|
||||||
playerId == getPlayer(user2).id && card == playedCard2
|
|
||||||
}
|
|
||||||
|
|
||||||
playedCard1 =
|
|
||||||
assertInstanceOf<GameStarted>(game)
|
|
||||||
.playableCards(currentPlayer.id)
|
|
||||||
.first()
|
|
||||||
|
|
||||||
playedCard1.run {
|
|
||||||
this.shouldBeInstanceOf<Card.NumericCard>()
|
|
||||||
number shouldEqual 2
|
|
||||||
color shouldEqual Card.Color.Red
|
|
||||||
}
|
|
||||||
|
|
||||||
playCard(playedCard1)
|
|
||||||
|
|
||||||
player1Notifications.waitNotification<ItsTheTurnOfNotification> {
|
|
||||||
player == getPlayer(user2)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Player 2 actions
|
|
||||||
val player2Job =
|
|
||||||
launch {
|
|
||||||
createGameWithCommandsInChannels(channelCommand2, gameId, user2) {
|
|
||||||
// wait player 1 has joined the game
|
|
||||||
until(3.seconds) { player1HasJoin }
|
|
||||||
|
|
||||||
joinTheGame()
|
|
||||||
|
|
||||||
player2Notifications.waitNotification<WelcomeToTheGameNotification> {
|
|
||||||
players.map { it.userId }.contains(user1.id) &&
|
|
||||||
players.map { it.userId }.contains(user2.id)
|
|
||||||
}
|
|
||||||
player2Notifications.waitNotification<PlayerWasReadyNotification> { playerId == getPlayer(user1).id }
|
|
||||||
|
|
||||||
readyToPlay()
|
|
||||||
|
|
||||||
playedCard2 =
|
|
||||||
player2Notifications
|
|
||||||
.waitNotification<TheGameWasStartedNotification> { hand.size == 7 }
|
|
||||||
.hand
|
|
||||||
.first()
|
|
||||||
.apply {
|
|
||||||
this.shouldBeInstanceOf<Card.NumericCard>()
|
|
||||||
number shouldEqual 8
|
|
||||||
color shouldEqual Card.Color.Red
|
|
||||||
}
|
|
||||||
|
|
||||||
player2Notifications.waitNotification<ItsTheTurnOfNotification> {
|
|
||||||
if (player.userId == user2.id) error("WRONG PLAYER TURN")
|
|
||||||
player.userId == user1.id
|
|
||||||
}
|
|
||||||
player2Notifications.waitNotification<PlayerAsPlayACardNotification> {
|
|
||||||
playerId == getPlayer(user1).id && card == playedCard1
|
|
||||||
}
|
|
||||||
|
|
||||||
player2Notifications.waitNotification<ItsTheTurnOfNotification> {
|
|
||||||
player == currentPlayer
|
|
||||||
}
|
|
||||||
|
|
||||||
game
|
|
||||||
.shouldBeInstanceOf<GameStarted>()
|
|
||||||
.discardPile
|
|
||||||
.topCard
|
|
||||||
.shouldNotBeNull()
|
|
||||||
.shouldBeInstanceOf<Card.NumericCard> {
|
|
||||||
it.number shouldEqual 1
|
|
||||||
it.color shouldEqual Card.Color.Red
|
|
||||||
}
|
}
|
||||||
|
|
||||||
playCard(playedCard2)
|
readyToPlay()
|
||||||
|
player1Notifications.waitNotification<PlayerWasReadyNotification> {
|
||||||
|
playerId == getPlayer(user2).id
|
||||||
|
}
|
||||||
|
|
||||||
player2Notifications.waitNotification<ItsTheTurnOfNotification> {
|
playedCard1 =
|
||||||
player.userId == user1.id
|
player1Notifications
|
||||||
}
|
.waitNotification<TheGameWasStartedNotification> { hand.size == 7 }
|
||||||
player2Notifications.waitNotification<PlayerAsPlayACardNotification> {
|
.hand
|
||||||
playerId == currentPlayer.id && card == playedCard2
|
.first()
|
||||||
|
.apply {
|
||||||
|
this.shouldBeInstanceOf<Card.NumericCard>()
|
||||||
|
number shouldEqual 1
|
||||||
|
color shouldEqual Card.Color.Red
|
||||||
|
}
|
||||||
|
|
||||||
|
player1Notifications.waitNotification<ItsTheTurnOfNotification> {
|
||||||
|
if (player.userId == user2.id) error("WRONG PLAYER TURN")
|
||||||
|
player.userId == user1.id
|
||||||
|
}
|
||||||
|
|
||||||
|
game
|
||||||
|
.shouldBeInstanceOf<GameStarted>()
|
||||||
|
.discardPile
|
||||||
|
.topCard
|
||||||
|
.shouldNotBeNull()
|
||||||
|
.shouldBeInstanceOf<Card.NumericCard> {
|
||||||
|
it.number shouldEqual 0
|
||||||
|
it.color shouldEqual Card.Color.Red
|
||||||
|
}
|
||||||
|
|
||||||
|
playCard(playedCard1!!)
|
||||||
|
|
||||||
|
player1Notifications.waitNotification<ItsTheTurnOfNotification> {
|
||||||
|
player == getPlayer(user2)
|
||||||
|
}
|
||||||
|
|
||||||
|
player1Notifications.waitNotification<PlayerAsPlayACardNotification> {
|
||||||
|
playerId == getPlayer(user2).id && card == playedCard2
|
||||||
|
}
|
||||||
|
|
||||||
|
playedCard1 =
|
||||||
|
assertInstanceOf<GameStarted>(game)
|
||||||
|
.playableCards(currentPlayer.id)
|
||||||
|
.first()
|
||||||
|
|
||||||
|
playedCard1.run {
|
||||||
|
this.shouldBeInstanceOf<Card.NumericCard>()
|
||||||
|
number shouldEqual 2
|
||||||
|
color shouldEqual Card.Color.Red
|
||||||
|
}
|
||||||
|
|
||||||
|
playCard(playedCard1)
|
||||||
|
|
||||||
|
player1Notifications.waitNotification<ItsTheTurnOfNotification> {
|
||||||
|
player == getPlayer(user2)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
// Wait the end of the game
|
// Player 2 actions
|
||||||
joinAll(player1Job, player2Job)
|
val player2Job =
|
||||||
|
launch {
|
||||||
|
createGameWithCommandsInChannels(channelCommand2, gameId, user2) {
|
||||||
|
// wait player 1 has joined the game
|
||||||
|
until(3.seconds) { player1HasJoin }
|
||||||
|
|
||||||
// Build the last state from the event store
|
joinTheGame()
|
||||||
val game = gameRepository.get(gameId)
|
|
||||||
assertInstanceOf<GameStarted>(game)
|
|
||||||
|
|
||||||
// Check if the state is correct
|
player2Notifications.waitNotification<WelcomeToTheGameNotification> {
|
||||||
game.aggregateId shouldBeEqual gameId
|
players.map { it.userId }.contains(user1.id) &&
|
||||||
game.players.map { it.userId } shouldContainExactly setOf(user1.id, user2.id)
|
players.map { it.userId }.contains(user2.id)
|
||||||
assertNotNull(game.players.find { it.userId == user1.id })
|
}
|
||||||
.hand.size shouldBeEqual 5
|
player2Notifications.waitNotification<PlayerWasReadyNotification> { playerId == getPlayer(user1).id }
|
||||||
assertNotNull(game.players.find { it.userId == user2.id })
|
|
||||||
.hand.size shouldBeEqual 6
|
readyToPlay()
|
||||||
game.direction shouldBeEqual Game.Direction.CLOCKWISE
|
|
||||||
assertNotNull(game.lastPlayer?.userId) shouldBeEqual user1.id
|
playedCard2 =
|
||||||
assertNotNull(game.discardPile.topCard) shouldBeEqual assertNotNull(playedCard1)
|
player2Notifications
|
||||||
|
.waitNotification<TheGameWasStartedNotification> { hand.size == 7 }
|
||||||
|
.hand
|
||||||
|
.first()
|
||||||
|
.apply {
|
||||||
|
this.shouldBeInstanceOf<Card.NumericCard>()
|
||||||
|
number shouldEqual 8
|
||||||
|
color shouldEqual Card.Color.Red
|
||||||
|
}
|
||||||
|
|
||||||
|
player2Notifications.waitNotification<ItsTheTurnOfNotification> {
|
||||||
|
if (player.userId == user2.id) error("WRONG PLAYER TURN")
|
||||||
|
player.userId == user1.id
|
||||||
|
}
|
||||||
|
player2Notifications.waitNotification<PlayerAsPlayACardNotification> {
|
||||||
|
playerId == getPlayer(user1).id && card == playedCard1
|
||||||
|
}
|
||||||
|
|
||||||
|
player2Notifications.waitNotification<ItsTheTurnOfNotification> {
|
||||||
|
player == currentPlayer
|
||||||
|
}
|
||||||
|
|
||||||
|
game
|
||||||
|
.shouldBeInstanceOf<GameStarted>()
|
||||||
|
.discardPile
|
||||||
|
.topCard
|
||||||
|
.shouldNotBeNull()
|
||||||
|
.shouldBeInstanceOf<Card.NumericCard> {
|
||||||
|
it.number shouldEqual 1
|
||||||
|
it.color shouldEqual Card.Color.Red
|
||||||
|
}
|
||||||
|
|
||||||
|
playCard(playedCard2)
|
||||||
|
|
||||||
|
player2Notifications.waitNotification<ItsTheTurnOfNotification> {
|
||||||
|
player.userId == user1.id
|
||||||
|
}
|
||||||
|
player2Notifications.waitNotification<PlayerAsPlayACardNotification> {
|
||||||
|
playerId == currentPlayer.id && card == playedCard2
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wait the end of the game
|
||||||
|
joinAll(player1Job, player2Job)
|
||||||
|
|
||||||
|
// Build the last state from the event store
|
||||||
|
val game = gameRepository.get(gameId)
|
||||||
|
assertInstanceOf<GameStarted>(game)
|
||||||
|
|
||||||
|
// Check if the state is correct
|
||||||
|
game.aggregateId shouldBeEqual gameId
|
||||||
|
game.players.map { it.userId } shouldContainExactly setOf(user1.id, user2.id)
|
||||||
|
assertNotNull(game.players.find { it.userId == user1.id })
|
||||||
|
.hand.size shouldBeEqual 5
|
||||||
|
assertNotNull(game.players.find { it.userId == user2.id })
|
||||||
|
.hand.size shouldBeEqual 6
|
||||||
|
game.direction shouldBeEqual Game.Direction.CLOCKWISE
|
||||||
|
assertNotNull(game.lastPlayer?.userId) shouldBeEqual user1.id
|
||||||
|
assertNotNull(game.discardPile.topCard) shouldBeEqual assertNotNull(playedCard1)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -274,7 +278,7 @@ class GameSimulationTest :
|
|||||||
context(user: User)
|
context(user: User)
|
||||||
private suspend inline fun <reified T : Notification> MutableList<Notification>.waitNotification(crossinline block: T.() -> Boolean): T {
|
private suspend inline fun <reified T : Notification> MutableList<Notification>.waitNotification(crossinline block: T.() -> Boolean): T {
|
||||||
println("NOTIFICATION WAITING: ${T::class.simpleName} for user: ${user.username}")
|
println("NOTIFICATION WAITING: ${T::class.simpleName} for user: ${user.username}")
|
||||||
return eventually(3.seconds) {
|
return eventually(5.seconds) {
|
||||||
filterIsInstance<T>()
|
filterIsInstance<T>()
|
||||||
.first { block(it) }
|
.first { block(it) }
|
||||||
.also { remove(it) }
|
.also { remove(it) }
|
||||||
|
|||||||
-21
@@ -1,21 +0,0 @@
|
|||||||
package eventDemo.contexts.game.intrastructure.persistence.connectors
|
|
||||||
|
|
||||||
import eventDemo.Tag
|
|
||||||
import eventDemo.testHelpers.testKoinApplicationWithConfig
|
|
||||||
import io.kotest.core.spec.style.FunSpec
|
|
||||||
import io.kotest.matchers.equals.shouldBeEqual
|
|
||||||
import redis.clients.jedis.UnifiedJedis
|
|
||||||
|
|
||||||
class RedisTest :
|
|
||||||
FunSpec({
|
|
||||||
tags(Tag.Redis)
|
|
||||||
|
|
||||||
test("test connection with jedis") {
|
|
||||||
testKoinApplicationWithConfig {
|
|
||||||
get<UnifiedJedis>().also {
|
|
||||||
it.set("test", "test")
|
|
||||||
it.get("test") shouldBeEqual "test"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
@@ -2,6 +2,7 @@ package eventDemo.libs.bus
|
|||||||
|
|
||||||
import com.rabbitmq.client.ConnectionFactory
|
import com.rabbitmq.client.ConnectionFactory
|
||||||
import eventDemo.testHelpers.spyPing
|
import eventDemo.testHelpers.spyPing
|
||||||
|
import eventDemo.testHelpers.testKoinApplicationWithConfig
|
||||||
import io.kotest.core.spec.style.FunSpec
|
import io.kotest.core.spec.style.FunSpec
|
||||||
import io.kotest.datatest.withData
|
import io.kotest.datatest.withData
|
||||||
import io.kotest.matchers.string.shouldStartWith
|
import io.kotest.matchers.string.shouldStartWith
|
||||||
@@ -15,33 +16,28 @@ private data class ObjTest(
|
|||||||
class BusTest :
|
class BusTest :
|
||||||
FunSpec({
|
FunSpec({
|
||||||
context("Pub/sub") {
|
context("Pub/sub") {
|
||||||
val factory =
|
testKoinApplicationWithConfig {
|
||||||
ConnectionFactory().apply {
|
val list: Map<String, Bus<ObjTest>> =
|
||||||
host = "localhost"
|
mapOf(
|
||||||
port = 5672
|
BusInMemory::class.java.simpleName to BusInMemory(),
|
||||||
username = "event-demo"
|
BusInRabbitMQ::class.java.simpleName to
|
||||||
password = "changeit"
|
BusInRabbitMQ(
|
||||||
}
|
get<ConnectionFactory>(),
|
||||||
val list: Map<String, Bus<ObjTest>> =
|
"testExchange",
|
||||||
mapOf(
|
{ it.value },
|
||||||
BusInMemory::class.java.simpleName to BusInMemory(),
|
{ ObjTest(it) },
|
||||||
BusInRabbitMQ::class.java.simpleName to
|
),
|
||||||
BusInRabbitMQ(
|
)
|
||||||
factory,
|
|
||||||
"testExchange",
|
|
||||||
{ it.value },
|
|
||||||
{ ObjTest(it) },
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
withData(list) { bus ->
|
withData(list) { bus ->
|
||||||
spyPing(exactly = 2, duration = 1.seconds) { ping ->
|
spyPing(exactly = 2, duration = 1.seconds) { ping ->
|
||||||
bus.subscribe { obj ->
|
bus.subscribe { obj ->
|
||||||
ping()
|
ping()
|
||||||
obj.value shouldStartWith "testMessage"
|
obj.value shouldStartWith "testMessage"
|
||||||
|
}
|
||||||
|
bus.publish(ObjTest("testMessage${Random.nextInt()}"))
|
||||||
|
bus.publish(ObjTest("testMessage${Random.nextInt()}"))
|
||||||
}
|
}
|
||||||
bus.publish(ObjTest("testMessage${Random.nextInt()}"))
|
|
||||||
bus.publish(ObjTest("testMessage${Random.nextInt()}"))
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -15,10 +15,13 @@ import org.koin.core.module.KoinApplicationDslMarker
|
|||||||
import org.koin.dsl.koinApplication
|
import org.koin.dsl.koinApplication
|
||||||
import org.koin.ktor.ext.getKoin
|
import org.koin.ktor.ext.getKoin
|
||||||
|
|
||||||
|
const val CONFIG_FILE_NAME = "application.conf"
|
||||||
|
|
||||||
@KoinApplicationDslMarker
|
@KoinApplicationDslMarker
|
||||||
suspend fun <T> testKoinApplicationWithConfig(block: suspend Koin.() -> T): T =
|
suspend fun <T> testKoinApplicationWithConfig(block: suspend Koin.() -> T): T =
|
||||||
koinApplication { modules(appKoinModule(ApplicationConfig("application.conf").configuration)) }
|
koinApplication {
|
||||||
.koin
|
modules(appKoinModule(ApplicationConfig(CONFIG_FILE_NAME).configuration))
|
||||||
|
}.koin
|
||||||
.run {
|
.run {
|
||||||
cleanDataTest()
|
cleanDataTest()
|
||||||
configureProjectionListener()
|
configureProjectionListener()
|
||||||
@@ -34,7 +37,7 @@ fun testApplicationWithConfig(
|
|||||||
) {
|
) {
|
||||||
val logger = KotlinLogging.logger {}
|
val logger = KotlinLogging.logger {}
|
||||||
testApplication {
|
testApplication {
|
||||||
val conf = ApplicationConfig("application.conf")
|
val conf = ApplicationConfig(CONFIG_FILE_NAME)
|
||||||
environment {
|
environment {
|
||||||
config = conf
|
config = conf
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
package eventDemo.testHelpers
|
package eventDemo.testHelpers
|
||||||
|
|
||||||
import org.koin.core.Koin
|
import org.koin.core.Koin
|
||||||
import redis.clients.jedis.UnifiedJedis
|
|
||||||
import javax.sql.DataSource
|
import javax.sql.DataSource
|
||||||
|
|
||||||
fun DataSource.cleanEventSource() {
|
fun DataSource.cleanEventSource() {
|
||||||
@@ -17,11 +16,6 @@ fun DataSource.cleanEventSource() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fun UnifiedJedis.cleanProjections() {
|
|
||||||
flushAll()
|
|
||||||
}
|
|
||||||
|
|
||||||
fun Koin.cleanDataTest() {
|
fun Koin.cleanDataTest() {
|
||||||
get<DataSource>().cleanEventSource()
|
get<DataSource>().cleanEventSource()
|
||||||
get<UnifiedJedis>().cleanProjections()
|
|
||||||
}
|
}
|
||||||
Reference in new issue
Block a user