feat : audit log (table + writer + listener + API + admin UI + timeline) (#9)
## Résumé
Implémente le journal d'audit append-only couvrant les 5 tickets de `doc/audit-log.md` et embarque au passage plusieurs corrections périphériques (sidebar Admin/Mon compte, drawer RBAC, Swagger, schema_filter Doctrine) ainsi que l'initialisation de la suite e2e Playwright. Toutes les mutations Doctrine sur les entités portant `#[Auditable]` sont tracées dans une table PostgreSQL dédiée, exposée en lecture seule via API Platform et consultable par les admins dans une page dédiée.
## Ce qui change
### Audit log — cœur de la PR
**Backend**
- Migration : table `audit_log` (UUID v7 natif Postgres en PK, `jsonb changes`, 3 index pour tri chrono, par entité et par utilisateur).
- `AuditLogWriter` : service bas-niveau, écrit via une connexion DBAL dédiée `audit` (même DSN que `default`, service séparé) pour sortir de la transaction ORM en batch. Blacklist defense-in-depth `password`/`plainPassword`/`token`/`secret`.
- `RequestIdProvider` : UUID v4 généré au `kernel.request` principal, injecté dans chaque ligne d'audit de la requête.
- Attributs `#[Auditable]` / `#[AuditIgnore]` dans `src/Shared/Domain/Attribute/` (accessibles par tous les modules).
- `AuditListener` : capture `onFlush` / écriture `postFlush` avec pattern swap-and-clear contre les flushes ré-entrants. Erreurs loguées, jamais propagées. Entité `User` annotée (password / plainPassword ignorés).
- API Platform read-only `/api/audit-logs` (permission RBAC `core.audit_log.view`) : `GET` collection paginée + `GET` item, pas de POST/PUT/PATCH/DELETE. Filtres `entity_type`, `entity_id`, `action`, `performed_by`, `performed_at[after]`/`[before]`.
- `DbalPaginator` implémentant `PaginatorInterface` : `hydra:view` généré automatiquement par API Platform, pas de construction manuelle.
- Ressource `AuditLogEntityTypesResource` + provider dédié pour peupler le filtre par type d'entité côté UI (réponse cachée, pas de requête à chaque ouverture du drawer).
- Permission `core.audit_log.view` déclarée dans `CoreModule::permissions()`.
- `audit_log` exclu du `schema_filter` Doctrine : plus de faux diff sur `make migration-diff`.
**Frontend**
- Page admin `/admin/audit-log` : tableau paginé, filtres locaux (état dans le composant, non persistés dans l'URL — conforme règle CLAUDE.md « Tableaux : pas de persistance URL »), drawer de détail (diff + timeline complète de l'entité), badges colorés par action.
- Composable partagé `useAuditLog` avec `resetAuditLog()` auto-enregistré sur `onAuthSessionCleared` (règle CLAUDE.md composables singletons).
- Composant réutilisable `<AuditTimeline :entity-type :entity-id>` : garde permission (pas d'appel API sans le droit), lazy loading (10 items + bouton « Voir plus »), dates relatives FR via `Intl.RelativeTimeFormat`, skeleton loader.
- Entrée sidebar « Journal d'audit » gated sur `core.audit_log.view` + clés i18n imbriquées dans `fr.json`.
### Fixes embarqués
- **Review fixes audit-log** (commits `37eafd2`, `1505e84`, `99c77eb`) : précision des timestamps, `ESCAPE` sur les `LIKE`, plafond pagination, diverses remarques du 1er tour de review.
- **Sidebar** (`701a480`, `e2fbf51`) : nouvelle section « Administration » + groupe « Mon compte », gate de section sur permissions, « Tableau de bord » déplacé dans « Mon compte ». Convention admin documentée.
- **Drawer RBAC utilisateurs** (`617ee31`, `5f5afcc`) : corrige l'affichage des sites et l'écrasement via merge-patch (garde anti-écrasement + spec `GET /users/{id}/rbac` documentée).
- **Swagger UI** (`6db955f`) : réactivé en ajoutant `symfony/twig-bundle` aux deps (régression depuis l'arrivée d'API Platform 4.2).
- **`phpunit.dist.xml`** : `<env APP_ENV=dev>` forçait la suite à tourner sous `framework.test=false` (→ `test.service_container` introuvable) ; `JWT_PASSPHRASE` ne matchait pas les clés de dev. Corrigés pour débloquer la suite.
### E2E Playwright (nouveau, commit `4603ab2`)
- `playwright.config.ts` + structure `frontend/tests/e2e/` (personas, helpers `loginAs`, page objects `LoginPage` + `SidebarComponent`).
- Specs : `auth/login.spec.ts` + `permissions/sidebar-visibility.spec.ts` (vérifie la visibilité de la sidebar par rôle RBAC).
- Commande `SeedE2ECommand` pour préparer un jeu de données déterministe côté backend.
- `make e2e` ajouté au Makefile.
## Décisions techniques
- **UUID v7 natif Postgres** (16 octets vs 36 en varchar) : index `performed_at` ~40 % plus petit sur une table append-only à croissance infinie.
- **`entity_type` format `module.Entity`** (ex: `core.User`) : évite les collisions si deux modules ont des entités de même nom.
- **`performed_by` dénormalisé** (string, pas FK) : le nom persiste même après suppression de l'utilisateur.
- **Connexion DBAL dédiée `audit`** : évite l'entanglement transactionnel entre audit et ORM en batch.
- **`ManyToMany` non audité** : limitation connue (`getEntityChangeSet()` ne couvre pas les collections) ; extension future via `getScheduledCollectionUpdates()` si besoin.
- **Filtres locaux non persistés dans l'URL** : choix assumé (cf. CLAUDE.md) pour éviter le couplage table ↔ routeur.
## Test plan
- [x] `make test` : 218 tests passent (writer unitaires + listener intégration + API fonctionnels + UserRbacProcessor).
- [x] `npm run lint` + `npm run test` + `npm run build` (frontend).
- [x] Migration appliquée sur dev + test, `audit_log` ignoré par `schema_filter`.
- [x] Permissions synchronisées (`app:sync-permissions`).
- [x] Swagger `/api/docs` accessible de nouveau.
- [ ] Playwright : `make e2e` vert en local (login + sidebar-visibility).
- [ ] Vérifier en local : création/modif/suppression d'un user apparaît dans `/admin/audit-log`.
- [ ] Vérifier : user sans `core.audit_log.view` → 403 sur l'endpoint + item absent de la sidebar.
- [ ] Vérifier : expansion d'une ligne affiche la timeline de l'entité avec dates relatives FR.
- [ ] Vérifier : drawer RBAC utilisateur n'écrase plus la liste des sites au `PATCH`.
## Points d'attention pour le review
- `AuditListener` : pattern swap-and-clear sur `postFlush` — relire la gestion des flushes ré-entrants.
- `DbalPaginator` : vérifier que l'absence d'`Iterator` custom ne casse pas la normalisation API Platform sur collections vides.
- `UserRbacProcessor` : logique merge-patch + garde anti-écrasement des sites (régression corrigée dans `617ee31`).
- Playwright : nouvelle dépendance de dev, s'assurer que `make e2e` ne fait pas partie du pipeline CI par défaut (à brancher explicitement).
Co-authored-by: Matthieu <mtholot19@gmail.com>
Reviewed-on: #9
Co-authored-by: matthieu <matthieu@yuno.malio.fr>
Co-committed-by: matthieu <matthieu@yuno.malio.fr>
This commit was merged in pull request #9.
This commit is contained in:
@@ -590,3 +590,112 @@ Le ticket autorise un user sans sites (`sites: []`, `currentSite: null`). Mais a
|
||||
- [ ] `make test` passe toutes les suites (les 5 nouvelles + les existantes ajustees aux fixtures).
|
||||
- [ ] `make php-cs-fixer-allow-risky` propre sur les fichiers nouveaux et modifies.
|
||||
- [ ] Desactiver `SitesModule::class` dans `config/modules.php` ne casse pas les endpoints Core (la DB reste valide, les users conservent leurs sites meme si l'UI ne les expose plus).
|
||||
|
||||
## 10. Evolutions post-livraison — drawer RBAC et defense in depth
|
||||
|
||||
Apres la livraison initiale du ticket, un bug utilisateur a revele que le drawer
|
||||
`UserRbacDrawer.vue` demarrait toujours avec 0 site coche pour un user qui en
|
||||
avait en BDD, et que la sauvegarde ecrasait silencieusement les sites
|
||||
existants. Root cause : l'endpoint `GET /api/users` utilise le groupe `user:list`
|
||||
qui n'expose pas la collection `sites` (choix assume pour garder le payload
|
||||
leger et eviter toute fuite croisee site). Le drawer initialisait donc
|
||||
`selectedSiteIds` a partir d'un `user.sites` toujours `undefined`.
|
||||
|
||||
Deux evolutions ont ete apportees pour corriger cela proprement sans elargir la
|
||||
surface de fuite de `/api/users` :
|
||||
|
||||
### 10.1 — Nouvelle operation `GET /users/{id}/rbac`
|
||||
|
||||
Une operation API Platform `Get` est ajoutee sur `User`, symetrique au `Patch`
|
||||
existant, sous la meme URI `/users/{id}/rbac` :
|
||||
|
||||
```php
|
||||
new Get(
|
||||
name: 'user_rbac_get',
|
||||
uriTemplate: '/users/{id}/rbac',
|
||||
security: "is_granted('core.users.manage')",
|
||||
normalizationContext: ['groups' => ['user:rbac:read']],
|
||||
),
|
||||
```
|
||||
|
||||
Raisons du design :
|
||||
- **Symetrie REST** : GET et PATCH partagent la meme URI et le meme groupe de
|
||||
normalisation, documentation OpenAPI et appels clients lisibles.
|
||||
- **Separation list/detail** : `/api/users` (`user:list`) reste maigre — pas de
|
||||
collection, pas de fuite. `/users/{id}/rbac` (`user:rbac:read`) porte le
|
||||
detail riche requis par le drawer d'edition.
|
||||
- **Garde de permission plus stricte** : `core.users.manage` (et non `.view`)
|
||||
— le detail RBAC est concu pour l'edition, pas la consultation.
|
||||
- **Isolation du couplage Sites** : la dependance au module Sites reste scopee
|
||||
a cet endpoint et a `/api/me`. Elle n'est pas disseminee dans tous les
|
||||
payloads de liste.
|
||||
|
||||
Cote frontend (`UserRbacDrawer.vue`) :
|
||||
- `loadData(userId)` fetch desormais `/users/{id}/rbac` en parallele des
|
||||
referentiels (roles, permissions, sites globaux).
|
||||
- Le watch combine `[modelValue, user.id]` recharge le detail a chaque
|
||||
ouverture ou changement de user sans dependance fragile sur `props.user`.
|
||||
- Le type `UserListItem` perd `sites` (inutilise) ; un nouveau type
|
||||
`UserRbacDetail` represente le payload du GET dedie.
|
||||
- La colonne "Sites" de `/admin/users` est retiree : l'info est consultee
|
||||
dans le drawer. Cela supprime aussi le second fetch `/api/sites` sur la
|
||||
page de liste.
|
||||
|
||||
### 10.2 — Garde anti-ecrasement dans `UserRbacProcessor`
|
||||
|
||||
API Platform denormalize les collections ManyToMany comme des `ArrayCollection`
|
||||
vides quand la cle JSON correspondante est absente du payload, violant la
|
||||
semantique `merge-patch+json` qui impose que les cles absentes ne mutent PAS
|
||||
les proprietes. Pour un PATCH qui ne veut toucher que `isAdmin`, cela
|
||||
detruirait tous les sites/roles/directPermissions du user.
|
||||
|
||||
Le processor injecte desormais `RequestStack`, lit le body JSON brut au debut
|
||||
de `process()`, et pour chaque collection absente du payload restaure l'etat
|
||||
d'origine a partir du snapshot Doctrine :
|
||||
|
||||
```php
|
||||
// Mapping cle JSON → accesseurs PHP (note : 'roles' → getRbacRoles)
|
||||
private const COLLECTION_MAP = [
|
||||
'roles' => ['getter' => 'getRbacRoles', ...],
|
||||
'directPermissions' => ['getter' => 'getDirectPermissions', ...],
|
||||
'sites' => ['getter' => 'getSites', ...],
|
||||
];
|
||||
|
||||
private function restoreAbsentCollections(User $user): void
|
||||
{
|
||||
$payload = json_decode($this->requestStack->getCurrentRequest()?->getContent() ?? '', true);
|
||||
foreach (self::COLLECTION_MAP as $jsonKey => $accessors) {
|
||||
if (array_key_exists($jsonKey, $payload)) {
|
||||
continue; // cle presente = la denormalisation fait foi
|
||||
}
|
||||
// cle absente = restaurer le snapshot PersistentCollection
|
||||
// (voir implementation complete dans UserRbacProcessor.php)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Semantique finale garantie :
|
||||
|
||||
| Payload | Effet sur la collection |
|
||||
|---------------------------------|------------------------------------|
|
||||
| Cle absente | Preservee (etat BDD inchange) |
|
||||
| `"sites": []` | Collection videe explicitement |
|
||||
| `"sites": ["/api/sites/1"]` | Collection remplacee |
|
||||
|
||||
La garde `ensureCurrentSiteConsistency` continue de s'executer apres persist
|
||||
avec la meme logique : elle est triggered uniquement si la collection a
|
||||
effectivement mute (detection via `PersistentCollection::isDirty()` post-restore).
|
||||
|
||||
### 10.3 — Criteres de validation additionnels
|
||||
|
||||
- [ ] `GET /users/{id}/rbac` retourne 200 pour `core.users.manage`, 403 sinon.
|
||||
- [ ] Le payload contient `{ id, isAdmin, roles, directPermissions, sites }`.
|
||||
- [ ] `GET /api/users` ne contient plus `sites` (verification non-regression).
|
||||
- [ ] Ouvrir le drawer d'un user avec des sites en BDD affiche les cases
|
||||
pre-cochees correspondantes.
|
||||
- [ ] `PATCH /users/{id}/rbac` avec `{ "isAdmin": true }` (sans autre cle) ne
|
||||
modifie pas sites/roles/directPermissions.
|
||||
- [ ] `PATCH /users/{id}/rbac` avec `{ "sites": [] }` vide explicitement la
|
||||
collection et bascule `currentSite` a `NULL` via la garde existante.
|
||||
- [ ] `PATCH /users/{id}/rbac` avec `{ "sites": [...] }` remplace la
|
||||
collection comme auparavant.
|
||||
|
||||
Reference in New Issue
Block a user