## 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>
163 lines
5.4 KiB
PHP
163 lines
5.4 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace App\Module\Core\Domain\Entity;
|
|
|
|
use ApiPlatform\Doctrine\Orm\Filter\BooleanFilter;
|
|
use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
|
|
use ApiPlatform\Metadata\ApiFilter;
|
|
use ApiPlatform\Metadata\ApiResource;
|
|
use ApiPlatform\Metadata\Get;
|
|
use ApiPlatform\Metadata\GetCollection;
|
|
use App\Module\Core\Infrastructure\Doctrine\DoctrinePermissionRepository;
|
|
use App\Shared\Domain\Attribute\Auditable;
|
|
use Doctrine\ORM\Mapping as ORM;
|
|
use InvalidArgumentException;
|
|
use Symfony\Component\Serializer\Attribute\Groups;
|
|
|
|
#[ApiResource(
|
|
operations: [
|
|
// Guard RBAC du catalogue de permissions : accepte les gestionnaires
|
|
// de users et de roles en plus du code dedie `core.permissions.view`.
|
|
// Justification : les drawers `UserRbacDrawer`/`RoleDrawer` fetchent
|
|
// systematiquement ce catalogue pour afficher les checkboxes de
|
|
// permissions ; exiger uniquement `core.permissions.view` casserait
|
|
// ces workflows pour tout gestionnaire non-admin. L'endpoint n'expose
|
|
// que des codes/libelles (pas de secret), le bypass reste acceptable.
|
|
new GetCollection(
|
|
normalizationContext: ['groups' => ['permission:read']],
|
|
security: "is_granted('core.permissions.view') or is_granted('core.users.manage') or is_granted('core.roles.manage')",
|
|
),
|
|
new Get(
|
|
normalizationContext: ['groups' => ['permission:read']],
|
|
security: "is_granted('core.permissions.view') or is_granted('core.users.manage') or is_granted('core.roles.manage')",
|
|
),
|
|
],
|
|
)]
|
|
#[ApiFilter(SearchFilter::class, properties: ['module' => 'exact'])]
|
|
#[ApiFilter(BooleanFilter::class, properties: ['orphan'])]
|
|
#[ORM\Entity(repositoryClass: DoctrinePermissionRepository::class)]
|
|
#[ORM\Table(name: 'permission')]
|
|
#[Auditable]
|
|
#[ORM\UniqueConstraint(name: 'uniq_permission_code', columns: ['code'])]
|
|
#[ORM\Index(name: 'idx_permission_module', columns: ['module'])]
|
|
#[ORM\Index(name: 'idx_permission_orphan', columns: ['orphan'])]
|
|
class Permission
|
|
{
|
|
#[ORM\Id]
|
|
#[ORM\GeneratedValue]
|
|
#[ORM\Column]
|
|
#[Groups(['permission:read'])]
|
|
private ?int $id = null;
|
|
|
|
#[ORM\Column(length: 255)]
|
|
#[Groups(['permission:read'])]
|
|
private string $code;
|
|
|
|
#[ORM\Column(length: 255)]
|
|
#[Groups(['permission:read'])]
|
|
private string $label;
|
|
|
|
#[ORM\Column(length: 100)]
|
|
#[Groups(['permission:read'])]
|
|
private string $module;
|
|
|
|
#[ORM\Column(options: ['default' => false])]
|
|
#[Groups(['permission:read'])]
|
|
private bool $orphan = false;
|
|
|
|
/**
|
|
* Invariants : une permission doit avoir un code non vide respectant la
|
|
* convention "module.resource[.sub].action" (donc contenir au moins un
|
|
* point), un libelle non vide et un module proprietaire non vide. Ces
|
|
* garde-fous evitent la persistence de lignes incoherentes si un appelant
|
|
* (fixture, commande de synchro, import) oublie un champ ou passe une
|
|
* chaine vide.
|
|
*/
|
|
public function __construct(string $code, string $label, string $module)
|
|
{
|
|
if ('' === $code) {
|
|
throw new InvalidArgumentException('Le code de permission ne peut pas etre vide.');
|
|
}
|
|
if (!str_contains($code, '.')) {
|
|
throw new InvalidArgumentException(sprintf('Le code de permission "%s" ne respecte pas la convention "module.resource[.sub].action".', $code));
|
|
}
|
|
if ('' === $label) {
|
|
throw new InvalidArgumentException('Le libelle de permission ne peut pas etre vide.');
|
|
}
|
|
if ('' === $module) {
|
|
throw new InvalidArgumentException('Le module proprietaire de la permission ne peut pas etre vide.');
|
|
}
|
|
|
|
$this->code = $code;
|
|
$this->label = $label;
|
|
$this->module = $module;
|
|
}
|
|
|
|
public function getId(): ?int
|
|
{
|
|
return $this->id;
|
|
}
|
|
|
|
public function getCode(): string
|
|
{
|
|
return $this->code;
|
|
}
|
|
|
|
public function getLabel(): string
|
|
{
|
|
return $this->label;
|
|
}
|
|
|
|
public function getModule(): string
|
|
{
|
|
return $this->module;
|
|
}
|
|
|
|
public function isOrphan(): bool
|
|
{
|
|
return $this->orphan;
|
|
}
|
|
|
|
/**
|
|
* Marque la permission comme orpheline : son code n'est plus declare par
|
|
* aucun module. Elle reste en base pour preserver les assignations et
|
|
* permettre une reactivation ulterieure, mais doit etre ignoree par les
|
|
* verifications d'autorisation.
|
|
*/
|
|
public function markOrphan(): static
|
|
{
|
|
$this->orphan = true;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Reactive une permission precedemment orpheline : son code reapparait
|
|
* dans le code source d'un module. Equivaut a updateMetadata() suivi d'un
|
|
* clearing du flag orphan ; on delegue a updateMetadata() pour ne pas
|
|
* dupliquer la logique d'affectation des metadonnees.
|
|
*/
|
|
public function revive(string $label, string $module): static
|
|
{
|
|
$this->updateMetadata($label, $module);
|
|
$this->orphan = false;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Met a jour les metadonnees d'une permission active sans toucher a son
|
|
* statut d'orphelin. Utilise par la commande de synchronisation lorsque
|
|
* seul le libelle ou le module proprietaire a change cote code.
|
|
*/
|
|
public function updateMetadata(string $label, string $module): static
|
|
{
|
|
$this->label = $label;
|
|
$this->module = $module;
|
|
|
|
return $this;
|
|
}
|
|
}
|