Compare commits
12 Commits
v0.1.32
...
feat/admin
| Author | SHA1 | Date | |
|---|---|---|---|
| edbe54cb8a | |||
| 1550f46b23 | |||
| cb6d2d72ec | |||
|
|
a15fc83222 | ||
|
|
caae752130 | ||
|
|
8bedab407d | ||
|
|
fd5d3fe36f | ||
| 296befe187 | |||
| 03c761eed4 | |||
| d137828919 | |||
| 105574ba2f | |||
| 8590e3e850 |
@@ -3,8 +3,10 @@
|
||||
declare(strict_types=1);
|
||||
use App\Module\Commercial\CommercialModule;
|
||||
use App\Module\Core\CoreModule;
|
||||
use App\Module\Sites\SitesModule;
|
||||
|
||||
return [
|
||||
CoreModule::class,
|
||||
CommercialModule::class,
|
||||
SitesModule::class,
|
||||
];
|
||||
|
||||
@@ -1,14 +1,15 @@
|
||||
api_platform:
|
||||
title: Coltura API
|
||||
version: 1.0.0
|
||||
# Scan du module Core pour decouvrir les classes ApiResource et ApiFilter.
|
||||
# Ajouter un chemin par module lors de l'ajout d'entites ApiResource dans d'autres modules.
|
||||
# Sans ces paths, le compile pass d'API Platform ne declare pas les
|
||||
# services de filtres annotes (les filtres etaient silencieusement
|
||||
# ignores sur Permission — cf. ticket #344).
|
||||
# Scan des modules pour decouvrir les classes ApiResource et ApiFilter.
|
||||
# Ajouter un chemin par module lors de l'ajout d'entites ApiResource
|
||||
# dans d'autres modules. Sans ces paths, le compile pass d'API Platform
|
||||
# ne declare pas les services de filtres annotes (les filtres etaient
|
||||
# silencieusement ignores sur Permission — cf. ticket #344).
|
||||
mapping:
|
||||
paths:
|
||||
- '%kernel.project_dir%/src/Module/Core/Domain/Entity'
|
||||
- '%kernel.project_dir%/src/Module/Sites/Domain/Entity'
|
||||
formats:
|
||||
jsonld: ['application/ld+json']
|
||||
json: ['application/json']
|
||||
@@ -18,3 +19,10 @@ api_platform:
|
||||
stateless: true
|
||||
cache_headers:
|
||||
vary: ['Content-Type', 'Authorization', 'Origin']
|
||||
# Active la negociation client de la pagination via ?itemsPerPage=X
|
||||
# (necessaire pour le dropdown perPage des DataTable admin). Borne
|
||||
# haute a 100 pour eviter qu'un client abuse en demandant 10000
|
||||
# items d'un coup — les UIs admin n'ont jamais besoin de plus de 50
|
||||
# en pratique.
|
||||
pagination_client_items_per_page: true
|
||||
pagination_maximum_items_per_page: 100
|
||||
|
||||
@@ -15,6 +15,16 @@ doctrine:
|
||||
dir: '%kernel.project_dir%/src/Module/Core/Domain/Entity'
|
||||
prefix: 'App\Module\Core\Domain\Entity'
|
||||
alias: Core
|
||||
# Mapping inconditionnelle du module Sites : la structure DB
|
||||
# existe meme si SitesModule::class est retire de config/modules.php.
|
||||
# L'activation fonctionnelle (ex: exposition des permissions, futurs
|
||||
# endpoints API) passe exclusivement par config/modules.php.
|
||||
Sites:
|
||||
type: attribute
|
||||
is_bundle: false
|
||||
dir: '%kernel.project_dir%/src/Module/Sites/Domain/Entity'
|
||||
prefix: 'App\Module\Sites\Domain\Entity'
|
||||
alias: Sites
|
||||
controller_resolver:
|
||||
auto_mapping: false
|
||||
|
||||
@@ -22,6 +32,20 @@ when@test:
|
||||
doctrine:
|
||||
dbal:
|
||||
dbname_suffix: '_test%env(default::TEST_TOKEN)%'
|
||||
orm:
|
||||
mappings:
|
||||
# Entite fictive SiteAware utilisee uniquement en tests du
|
||||
# module Sites (ticket 4). Le mapping n'est charge qu'en
|
||||
# environnement test, donc aucun impact sur les schemas
|
||||
# dev/prod. La table est creee a la volee par les tests
|
||||
# d'integration (via `SchemaTool::createSchema`) dans le
|
||||
# setUp de SiteScopedQueryExtensionTest.
|
||||
TestFixtures:
|
||||
type: attribute
|
||||
is_bundle: false
|
||||
dir: '%kernel.project_dir%/tests/Fixtures/SiteAware'
|
||||
prefix: 'App\Tests\Fixtures\SiteAware'
|
||||
alias: TestFixtures
|
||||
|
||||
when@prod:
|
||||
doctrine:
|
||||
|
||||
@@ -24,3 +24,9 @@ services:
|
||||
|
||||
App\Module\Core\Domain\Repository\UserRepositoryInterface:
|
||||
alias: App\Module\Core\Infrastructure\Doctrine\DoctrineUserRepository
|
||||
|
||||
App\Module\Sites\Domain\Repository\SiteRepositoryInterface:
|
||||
alias: App\Module\Sites\Infrastructure\Doctrine\DoctrineSiteRepository
|
||||
|
||||
App\Module\Sites\Application\Service\CurrentSiteProviderInterface:
|
||||
alias: App\Module\Sites\Application\Service\CurrentSiteProvider
|
||||
|
||||
@@ -48,6 +48,13 @@ return [
|
||||
'module' => 'core',
|
||||
'permission' => 'core.users.view',
|
||||
],
|
||||
[
|
||||
'label' => 'sidebar.core.sites',
|
||||
'to' => '/admin/sites',
|
||||
'icon' => 'mdi:domain',
|
||||
'module' => 'sites',
|
||||
'permission' => 'sites.view',
|
||||
],
|
||||
[
|
||||
'label' => 'sidebar.general.logout',
|
||||
'to' => '/logout',
|
||||
|
||||
287
docs/modules/site-aware.md
Normal file
287
docs/modules/site-aware.md
Normal file
@@ -0,0 +1,287 @@
|
||||
# Guide développeur — `SiteAwareInterface` (opt-in)
|
||||
|
||||
Ce guide explique comment adopter le pattern **site-aware** sur une entité
|
||||
d'un module métier pour que ses données soient automatiquement filtrées
|
||||
par le site courant de l'utilisateur connecté, et pour que les créations
|
||||
soient rattachées implicitement au site courant.
|
||||
|
||||
Ce pattern est **opt-in strict** : aucune entité n'est affectée tant qu'un
|
||||
module ne choisit pas explicitement d'implémenter `SiteAwareInterface`.
|
||||
|
||||
Livré par le ticket 4/4 du module Sites (cf. `docs/sites/ticket-04-spec.md`).
|
||||
|
||||
## 1. Quand adopter ?
|
||||
|
||||
Adopte le pattern si :
|
||||
|
||||
- Chaque ligne de l'entité appartient à **un et un seul site**.
|
||||
- Les utilisateurs du site A ne doivent **jamais** voir les lignes du site B.
|
||||
- Créer une ligne sans connaître le site n'a pas de sens métier.
|
||||
|
||||
Exemples typiques : `Supplier`, `Order`, `StockEntry`, `Employee` (si chaque
|
||||
site a sa propre équipe), `Invoice` (si facturation par site).
|
||||
|
||||
## 2. Quand NE PAS adopter ?
|
||||
|
||||
**Entités globales** : partagées par tous les sites, pas de notion de
|
||||
propriétaire. Ne pas adopter.
|
||||
|
||||
- `Role`, `Permission`, `User` (les users sont transverses, rattachés à
|
||||
plusieurs sites via la relation M2M `user_site`).
|
||||
- Catalogues mutualisés : produits, catégories, taxes — sauf si chaque
|
||||
site a son propre catalogue.
|
||||
- Documents / contrats multi-site (ex: contrat-cadre qui couvre plusieurs
|
||||
sites).
|
||||
|
||||
**Entités "par tenant"** : si le scope naturel est plus large que le site
|
||||
(ex: un groupe qui possède plusieurs sites comme entités filiales
|
||||
juridiquement distinctes), utilise plutôt `TenantAwareInterface` (déjà
|
||||
présent dans `src/Shared/Domain/Contract/`).
|
||||
|
||||
**Entités hybrides** : certaines lignes globales, d'autres par site. Le
|
||||
pattern ne supporte pas ce cas — crée deux entités distinctes si
|
||||
nécessaire.
|
||||
|
||||
## 3. Comment adopter ? Check-list
|
||||
|
||||
### 3.1 Entité
|
||||
|
||||
```php
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use App\Shared\Domain\Contract\SiteAwareInterface;
|
||||
|
||||
class Supplier implements SiteAwareInterface
|
||||
{
|
||||
#[ORM\ManyToOne(targetEntity: Site::class)]
|
||||
#[ORM\JoinColumn(name: 'site_id', referencedColumnName: 'id', nullable: false, onDelete: 'CASCADE')]
|
||||
private ?Site $site = null;
|
||||
|
||||
public function getSite(): ?Site
|
||||
{
|
||||
return $this->site;
|
||||
}
|
||||
|
||||
public function setSite(Site $site): void
|
||||
{
|
||||
$this->site = $site;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Points critiques :
|
||||
|
||||
- `nullable: false` au niveau de la `JoinColumn` — la table n'accepte
|
||||
jamais `site_id IS NULL` en régime nominal.
|
||||
- `onDelete: 'CASCADE'` — la suppression d'un site entraîne la suppression
|
||||
de toutes les lignes associées. À remplacer par `RESTRICT` (blocage) si
|
||||
ton métier exige d'empêcher la suppression d'un site contenant des
|
||||
données.
|
||||
- Le getter retourne `?Site` (nullable) pour permettre des états
|
||||
transitoires pré-persist (entité construite avant injection du site).
|
||||
|
||||
### 3.2 Migration
|
||||
|
||||
**Cas 1 — Nouvelle table** : ajoute directement `site_id INT NOT NULL`
|
||||
avec FK et index.
|
||||
|
||||
**Cas 2 — Table existante avec données legacy** : migration en trois étapes
|
||||
distinctes.
|
||||
|
||||
```php
|
||||
// Version1.php
|
||||
$this->addSql('ALTER TABLE supplier ADD site_id INT DEFAULT NULL');
|
||||
$this->addSql('CREATE INDEX IDX_supplier_site ON supplier (site_id)');
|
||||
$this->addSql('ALTER TABLE supplier ADD CONSTRAINT FK_supplier_site FOREIGN KEY (site_id) REFERENCES site (id) ON DELETE CASCADE');
|
||||
|
||||
// Backfill (manuellement ou via script custom selon ton métier)
|
||||
$this->addSql("UPDATE supplier SET site_id = (SELECT id FROM site WHERE name = 'Chatellerault') WHERE site_id IS NULL");
|
||||
|
||||
// Version2.php — après backfill confirmé
|
||||
$this->addSql('ALTER TABLE supplier ALTER COLUMN site_id SET NOT NULL');
|
||||
```
|
||||
|
||||
**Index obligatoire** : le filtre généré par `SiteScopedQueryExtension`
|
||||
est `WHERE x.site = :currentSite`. Sans index sur `site_id`, chaque
|
||||
requête fait un full-scan de la table. Ajoute-le dans la migration.
|
||||
|
||||
### 3.3 Sérialisation API
|
||||
|
||||
Expose la relation `site` dans le groupe de lecture de la ressource pour
|
||||
que le frontend sache à quel site appartient chaque ligne :
|
||||
|
||||
```php
|
||||
#[Groups(['supplier:read'])]
|
||||
private ?Site $site = null;
|
||||
```
|
||||
|
||||
Si tu veux aussi permettre à un admin de créer une ligne sur un autre
|
||||
site que son `currentSite` (ex: admin multi-site), ajoute aussi le groupe
|
||||
d'écriture :
|
||||
|
||||
```php
|
||||
#[Groups(['supplier:read', 'supplier:write'])]
|
||||
```
|
||||
|
||||
Dans ce cas, `SiteAwareInjectionProcessor` respecte la valeur explicite
|
||||
envoyée par le client (voir §4).
|
||||
|
||||
### 3.4 Processor custom
|
||||
|
||||
Si le module a déjà un processor custom sur les opérations POST/PATCH,
|
||||
assure-toi qu'il délègue à `api_platform.doctrine.orm.state.persist_processor`
|
||||
(et non à `$em->persist()` direct) pour que le decorator
|
||||
`SiteAwareInjectionProcessor` s'applique.
|
||||
|
||||
Pattern aligné sur `UserRbacProcessor` :
|
||||
|
||||
```php
|
||||
use Symfony\Component\DependencyInjection\Attribute\Autowire;
|
||||
|
||||
public function __construct(
|
||||
#[Autowire(service: 'api_platform.doctrine.orm.state.persist_processor')]
|
||||
private readonly ProcessorInterface $persistProcessor,
|
||||
) {}
|
||||
|
||||
public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = []): mixed
|
||||
{
|
||||
// Gardes métier custom ici...
|
||||
|
||||
// Délègue au persist processor décoré : SiteAwareInjectionProcessor
|
||||
// interceptera l'appel et injectera le currentSite si besoin.
|
||||
return $this->persistProcessor->process($data, $operation, $uriVariables, $context);
|
||||
}
|
||||
```
|
||||
|
||||
## 4. Comportement du processor d'injection
|
||||
|
||||
Le decorator `SiteAwareInjectionProcessor` s'applique automatiquement à
|
||||
**toute** persistance API Platform. Son comportement :
|
||||
|
||||
| Cas | Action |
|
||||
|---|---|
|
||||
| `$data` n'implémente pas `SiteAwareInterface` | Délégation directe (no-op). |
|
||||
| `$data` est `SiteAware` avec `$site` déjà positionné (ex: payload POST avec `site` explicite) | Délégation directe, **la valeur explicite est préservée**. |
|
||||
| `$data` est `SiteAware` sans site, `CurrentSiteProvider::get()` retourne un `Site` | Injection `$data->setSite($currentSite)` puis délégation. |
|
||||
| `$data` est `SiteAware` sans site, `CurrentSiteProvider::get()` retourne `null` | **Throw `BadRequestHttpException`** avec message "aucun site sélectionné". |
|
||||
|
||||
Conséquence : un user sans `currentSite` ne peut **pas** créer de ligne
|
||||
sur une entité `SiteAware`. C'est intentionnel : mieux vaut un 400 clair
|
||||
que persister une ligne incohérente.
|
||||
|
||||
## 5. Comportement en mode dégradé
|
||||
|
||||
### 5.1 Module Sites désactivé
|
||||
|
||||
Si `SitesModule::class` est retiré de `config/modules.php`,
|
||||
`CurrentSiteProvider::get()` retourne **toujours `null`** :
|
||||
|
||||
- `SiteScopedQueryExtension` → no-op. Toutes les lignes visibles, comme
|
||||
si le filtre n'existait pas.
|
||||
- `SiteAwareInjectionProcessor` → **throw 400 sur tout POST/PATCH** sans
|
||||
site explicite. L'écriture d'entités `SiteAware` nécessite que le
|
||||
client envoie systématiquement `site` dans le payload.
|
||||
|
||||
**Conséquence** : un module qui adopte le pattern **ne peut pas vivre**
|
||||
sans le module Sites actif pour les opérations d'écriture. À documenter
|
||||
fortement dans le README du module adopté.
|
||||
|
||||
### 5.2 User sans site (sites = [], currentSite = null)
|
||||
|
||||
Même comportement qu'un module désactivé : lecture no-op (tout visible),
|
||||
écriture bloquée par 400. L'UX doit gérer ce cas (ex: écran d'onboarding
|
||||
qui force l'assignation d'un site avant d'accéder aux écrans métier).
|
||||
|
||||
### 5.3 Bypass admin via `sites.bypass_scope`
|
||||
|
||||
Un utilisateur avec la permission `sites.bypass_scope` (ou admin par
|
||||
bypass total via `isAdmin = true`) voit **toutes** les lignes, tous
|
||||
sites confondus. Pratique pour audit, reporting, consolidation groupe.
|
||||
|
||||
Le processor d'injection ne respecte **pas** ce bypass : même un user
|
||||
avec `bypass_scope` verra son `currentSite` injecté à la création s'il
|
||||
n'envoie pas de `site` explicite. Le bypass est un droit de lecture,
|
||||
pas d'écriture multi-site.
|
||||
|
||||
## 6. Anti-patterns et gotchas
|
||||
|
||||
### 6.1 Sous-collections (`/api/clients/{id}/contacts`)
|
||||
|
||||
Si seul `Client` est `SiteAware` (et `Contact` hérite du scope via son
|
||||
parent), le filtre **ne se propage pas automatiquement** aux contacts.
|
||||
Deux options :
|
||||
|
||||
- Rendre `Contact` aussi `SiteAware` (redondance mais simple).
|
||||
- Ajouter un filtre custom qui joint sur `contact.client.site` et compare
|
||||
au `currentSite`.
|
||||
|
||||
Ce ticket ne couvre pas le second cas : à implémenter par le module
|
||||
concerné.
|
||||
|
||||
### 6.2 Repositories custom
|
||||
|
||||
Le filtre API Platform ne s'applique **qu'aux requêtes** générées par
|
||||
API Platform (via `ItemProvider` / `CollectionProvider` Doctrine). Si un
|
||||
repository custom fait une requête DQL manuelle (ex: `findTopRated()`
|
||||
appelé depuis un service), **aucun filtre n'est appliqué**.
|
||||
|
||||
Responsabilité du développeur du module : injecter `CurrentSiteProvider`
|
||||
dans le repository / service et ajouter manuellement la clause WHERE.
|
||||
|
||||
### 6.3 Tests d'intégration
|
||||
|
||||
Les tests qui persistent des entités `SiteAware` doivent :
|
||||
|
||||
- Soit logger un user avec un `currentSite` positionné (cas nominal).
|
||||
- Soit utiliser un user avec `sites.bypass_scope` pour voir toutes les
|
||||
lignes (cas reporting).
|
||||
- Soit positionner le site **explicitement** sur chaque entité persistée
|
||||
via fixture (bypass du processor d'injection qui n'est pas actif hors
|
||||
contexte HTTP).
|
||||
|
||||
### 6.4 Cascade delete d'un site
|
||||
|
||||
La migration type du §3.2 déclare `onDelete: 'CASCADE'` sur la FK
|
||||
`site_id`. **Conséquence** : supprimer un site détruit **toutes** les
|
||||
lignes de **toutes** les tables `SiteAware` rattachées à ce site, en
|
||||
cascade. Pour un `Supplier`, ça signifie perte de l'historique fournisseur
|
||||
du site supprimé.
|
||||
|
||||
Alternatives selon le besoin métier :
|
||||
|
||||
- `onDelete: 'RESTRICT'` : bloque la suppression du site tant qu'il reste
|
||||
des lignes. L'admin doit nettoyer manuellement avant delete.
|
||||
- `onDelete: 'SET NULL'` : transforme les lignes en "globales" après
|
||||
suppression du site — mais incompatible avec `nullable: false`, donc
|
||||
nécessite de relâcher la contrainte. Généralement à éviter.
|
||||
|
||||
## 7. Exemple d'adoption minimale (pseudo-ticket)
|
||||
|
||||
Pour un futur ticket qui adopte `SiteAwareInterface` sur `Supplier` du
|
||||
module Commercial :
|
||||
|
||||
1. Modifier `src/Module/Commercial/Domain/Entity/Supplier.php` : ajouter
|
||||
`implements SiteAwareInterface` + relation `$site`.
|
||||
2. Créer migration `Version<timestamp>.php` : `ALTER TABLE supplier ADD
|
||||
site_id ...`, backfill, `SET NOT NULL`, `CREATE INDEX`.
|
||||
3. Ajouter `#[Groups(['supplier:read'])]` sur `$site`.
|
||||
4. Mettre à jour les fixtures `CommercialFixtures` pour rattacher chaque
|
||||
supplier à un site (`setSite(...)`).
|
||||
5. Ajouter un test d'intégration qui vérifie que la collection
|
||||
`/api/suppliers` retourne bien uniquement les suppliers du site
|
||||
courant pour un user donné.
|
||||
6. Documenter dans le README du module Commercial que les opérations
|
||||
d'écriture sur Supplier nécessitent le module Sites actif + un user
|
||||
avec `currentSite`.
|
||||
|
||||
## 8. Permission `sites.bypass_scope`
|
||||
|
||||
Déclarée par `SitesModule::permissions()`, synchronisée automatiquement
|
||||
en base par `app:sync-permissions`. Une fois synchronisée, elle est
|
||||
assignable :
|
||||
|
||||
- Directement à un user via `/admin/users` (drawer RBAC, section
|
||||
"Permissions directes").
|
||||
- Via un rôle personnalisé (ex: rôle "Auditeur groupe") qui la porte.
|
||||
|
||||
Les admins l'obtiennent automatiquement par bypass total (`isAdmin`), pas
|
||||
besoin d'assignation explicite.
|
||||
410
docs/sites/ticket-01-spec.md
Normal file
410
docs/sites/ticket-01-spec.md
Normal file
@@ -0,0 +1,410 @@
|
||||
# Ticket #01 — 1/4 — Brique fondatrice du module Sites (Backend)
|
||||
|
||||
## 1. Objectif
|
||||
|
||||
Ce ticket livre la couche de donnees du module optionnel Sites. Il cree le bounded context, declare le module a Symfony, enregistre ses permissions RBAC, installe la table `site` en base et seed trois etablissements de demonstration utilises par les tickets suivants.
|
||||
|
||||
Le resultat attendu est un socle de persistance activable par tenant via `config/modules.php`, sans UI, sans API publique, sans couplage au module Core, et sur lequel les tickets 2/3/4 pourront greffer : rattachement utilisateurs, selecteur de site dans la navbar, administration CRUD.
|
||||
|
||||
## 2. Périmètre
|
||||
|
||||
### IN
|
||||
|
||||
- Creer le module `/home/m-tristan/workspace/Coltura/src/Module/Sites/SitesModule.php` avec `ID = 'sites'`, `LABEL = 'Sites'`, `REQUIRED = false`, et une methode statique `permissions()` declarant les deux codes RBAC `sites.view` et `sites.manage`.
|
||||
- Creer l'entite Doctrine `Site` avec `id`, `name` (unique), `city`, `postalCode`, `color`, `fullAddress`, `createdAt`, `updatedAt` et les contraintes de validation applicatives associees (NotBlank, Length, Regex hex `#RRGGBB`, Regex CP FR `^\d{5}$`, UniqueEntity).
|
||||
- Creer l'interface `SiteRepositoryInterface` et son implementation Doctrine `DoctrineSiteRepository`, avec un contrat CRUD complet (`findById`, `findByName`, `findAllOrderedByName`, `save`, `remove`) en anticipation du ticket 2.
|
||||
- Creer une migration Doctrine creant la table `site` avec son index unique `uniq_site_name`. La migration est placee dans `/home/m-tristan/workspace/Coltura/migrations/` au namespace racine `DoctrineMigrations` conformement a l'exception documentee dans `CLAUDE.md` (bug de tri alphabetique des migrations multi-namespaces dans Doctrine Migrations 3.x).
|
||||
- Creer `SitesFixtures` creant trois sites de demonstration : `Chatellerault` (`#056CF2`), `Saint-Jean` (`#10B981`), `Pommevic` (`#F59E0B`). Fixtures idempotentes via lookup par nom lorsque le purger Doctrine est desactive.
|
||||
- Enregistrer `SitesModule::class` dans `/home/m-tristan/workspace/Coltura/config/modules.php` pour l'activer par defaut.
|
||||
- Declarer le mapping Doctrine du module dans `/home/m-tristan/workspace/Coltura/config/packages/doctrine.yaml` (inconditionnel, le mapping reste charge meme si le module est retire de `modules.php`).
|
||||
- Enregistrer l'alias service `SiteRepositoryInterface → DoctrineSiteRepository` dans `/home/m-tristan/workspace/Coltura/config/services.yaml`.
|
||||
- Ajouter deux suites de tests PHPUnit :
|
||||
- `SiteTest` (pure `TestCase`) pour le comportement de l'entite (constructeur, getters/setters, lifecycle `PreUpdate`).
|
||||
- `SiteValidationTest` (`KernelTestCase`) pour la validation complete : regex hex, regex CP FR, NotBlank, Length, UniqueEntity via Doctrine.
|
||||
|
||||
### OUT
|
||||
|
||||
- Ticket `#02` : relation `User ↔ Site` (FK ou ManyToMany selon decision UX), expose les sites de l'utilisateur courant via `/api/me` et propage l'autorisation au niveau des ressources decoupees par site.
|
||||
- Ticket `#03` : integration dans la navbar Coltura (selecteur de site actif, persistance du choix cote front, consommation du flux issu du ticket 2).
|
||||
- Ticket `#04` : ecran d'administration CRUD des sites (page admin/sites, DataTable, drawer creation/edition, modale suppression, API Platform `Site` resource avec voters RBAC).
|
||||
- Gestion des soft-deletes sur `Site` : non introduite dans ce ticket.
|
||||
- Rattachement historique ou audit trail des modifications : hors scope.
|
||||
|
||||
## 3. Fichiers à créer
|
||||
|
||||
### Domaine — Entité
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/src/Module/Sites/Domain/Entity/Site.php` : entite Doctrine porteuse des attributs metier (nom unique, ville, code postal FR, couleur hex, adresse complete multi-ligne) et des timestamps auto-maintenus via lifecycle callbacks.
|
||||
|
||||
### Domaine — Repository
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/src/Module/Sites/Domain/Repository/SiteRepositoryInterface.php` : contrat d'acces domaine a l'entite Site (CRUD applicatif ; l'acces API Platform du ticket 4 utilisera le provider Doctrine par defaut).
|
||||
|
||||
### Infrastructure — Doctrine
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/src/Module/Sites/Infrastructure/Doctrine/DoctrineSiteRepository.php` : implementation Doctrine de `SiteRepositoryInterface` basee sur `ServiceEntityRepository`.
|
||||
|
||||
### Infrastructure — Migration
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/migrations/Version<timestamp>.php` : migration racine (namespace `DoctrineMigrations`) qui cree la table `site` et son index unique. Emplacement racine et non modulaire, cf. exception documentee dans `CLAUDE.md` (bug Doctrine 3.x sur le tri alphabetique des migrations multi-namespaces).
|
||||
|
||||
### Infrastructure — DataFixtures
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/src/Module/Sites/Infrastructure/DataFixtures/SitesFixtures.php` : fixture Doctrine seedant les 3 sites de demonstration. Ne declare pas de `DependentFixtureInterface` (aucune dependance a AppFixtures dans ce ticket).
|
||||
|
||||
### Module — Declaration
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/src/Module/Sites/SitesModule.php` : marker class du module avec `ID`, `LABEL`, `REQUIRED` et `permissions()`. Meme pattern que `CoreModule`.
|
||||
|
||||
### Tests
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/tests/Module/Sites/Domain/Entity/SiteTest.php` : tests unitaires purs (`TestCase`) couvrant constructeur, getters, setters et lifecycle `PreUpdate`.
|
||||
- `/home/m-tristan/workspace/Coltura/tests/Module/Sites/Domain/Entity/SiteValidationTest.php` : tests de validation (`KernelTestCase`) couvrant regex hex, regex CP FR, NotBlank, Length sur tous les champs, et `UniqueEntity` via la DB de test.
|
||||
|
||||
## 4. Fichiers à modifier
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/config/modules.php` : ajouter `App\Module\Sites\SitesModule::class` dans le tableau de retour. Le module est actif par defaut. Le commenter suffit a le desactiver sans autre intervention (les permissions deviendront orphelines a la prochaine sync mais la table reste).
|
||||
- `/home/m-tristan/workspace/Coltura/config/packages/doctrine.yaml` : ajouter une mapping `Sites:` alignee sur le pattern du module `Core:`. Le mapping est inconditionnel : il reste declare meme si `SitesModule::class` est retire de `modules.php`. Le commentaire doit etre explicite sur cette decoupe (activation fonctionnelle via `modules.php`, structure DB via la mapping Doctrine).
|
||||
- `/home/m-tristan/workspace/Coltura/config/services.yaml` : ajouter l'alias `App\Module\Sites\Domain\Repository\SiteRepositoryInterface` → `App\Module\Sites\Infrastructure\Doctrine\DoctrineSiteRepository`. Pattern aligne sur les trois aliases Core existants.
|
||||
|
||||
## 5. Schéma cible — mapping Doctrine
|
||||
|
||||
Comme pour le ticket RBAC (ticket-343), le schema est decrit par les attributs Doctrine plutot que par le SQL brut. Le fichier de migration contient le SQL final (section 6).
|
||||
|
||||
### Conventions respectées
|
||||
|
||||
- `declare(strict_types=1)` en tete de tous les fichiers PHP.
|
||||
- Identifiants de classe et proprietes en anglais, commentaires en francais (cf. `CLAUDE.md`).
|
||||
- PostgreSQL : noms de colonnes en snake_case minuscules, Doctrine les deduit des proprietes camelCase (`postalCode` → `postal_code`, `fullAddress` → `full_address`, `createdAt` → `created_at`, `updatedAt` → `updated_at`).
|
||||
- Le nom de table `site` n'est pas un mot reserve PostgreSQL : pas de backtick necessaire.
|
||||
|
||||
### Entité `Site`
|
||||
|
||||
```php
|
||||
#[ORM\Entity(repositoryClass: DoctrineSiteRepository::class)]
|
||||
#[ORM\Table(name: 'site')]
|
||||
#[ORM\UniqueConstraint(name: 'uniq_site_name', columns: ['name'])]
|
||||
#[ORM\HasLifecycleCallbacks]
|
||||
#[UniqueEntity(fields: ['name'], message: 'Un site avec ce nom existe deja.')]
|
||||
class Site
|
||||
{
|
||||
#[ORM\Id]
|
||||
#[ORM\GeneratedValue]
|
||||
#[ORM\Column]
|
||||
private ?int $id = null;
|
||||
|
||||
#[ORM\Column(length: 100)]
|
||||
#[Assert\NotBlank(message: 'Le nom du site est requis.')]
|
||||
#[Assert\Length(max: 100, ...)]
|
||||
private string $name;
|
||||
|
||||
#[ORM\Column(length: 100)]
|
||||
#[Assert\NotBlank(message: 'La ville du site est requise.')]
|
||||
#[Assert\Length(max: 100, ...)]
|
||||
private string $city;
|
||||
|
||||
#[ORM\Column(name: 'postal_code', length: 10)]
|
||||
#[Assert\NotBlank(message: 'Le code postal est requis.')]
|
||||
#[Assert\Length(max: 10, ...)]
|
||||
#[Assert\Regex(pattern: '/^\d{5}$/', message: '...')]
|
||||
private string $postalCode;
|
||||
|
||||
#[ORM\Column(length: 7)]
|
||||
#[Assert\NotBlank(message: 'La couleur est requise.')]
|
||||
#[Assert\Regex(pattern: '/^#[0-9A-Fa-f]{6}$/', message: '...')]
|
||||
private string $color;
|
||||
|
||||
#[ORM\Column(name: 'full_address', type: Types::TEXT)]
|
||||
#[Assert\NotBlank(message: 'L\'adresse complete est requise.')]
|
||||
#[Assert\Length(max: 500, ...)]
|
||||
private string $fullAddress;
|
||||
|
||||
#[ORM\Column(name: 'created_at', type: Types::DATETIME_IMMUTABLE)]
|
||||
private DateTimeImmutable $createdAt;
|
||||
|
||||
#[ORM\Column(name: 'updated_at', type: Types::DATETIME_IMMUTABLE)]
|
||||
private DateTimeImmutable $updatedAt;
|
||||
}
|
||||
```
|
||||
|
||||
Contraintes fonctionnelles :
|
||||
- `name` est unique en base (`uniq_site_name`) et porte egalement la contrainte applicative `UniqueEntity` pour que le validator remonte une violation lisible avant d'atteindre la violation DB.
|
||||
- `color` est contraint par regex a un code hex strict de 7 caracteres `#RRGGBB`, majuscules ou minuscules. La colonne `VARCHAR(7)` est dimensionnee au plus juste car la regex est exhaustive.
|
||||
- `postalCode` est contraint a 5 chiffres exacts via regex (format FR). La colonne `VARCHAR(10)` est volontairement plus large que la regex pour laisser marge si le projet etend plus tard la regex a d'autres formats (UK, PT, ...). Choix assume : evite une migration DDL au ticket suivant, cout DB negligeable sur un champ court.
|
||||
- `fullAddress` est de type `TEXT` (PostgreSQL) pour permettre une adresse multi-ligne, mais borne cote applicatif a 500 caracteres via `Assert\Length(max: 500)` comme garde DoS basique (une adresse FR complete tient largement dans cette enveloppe).
|
||||
- `createdAt` est seede dans le constructeur et **ne change plus jamais** apres persistance.
|
||||
- `updatedAt` est seede dans le constructeur a la meme valeur que `createdAt`, puis refresh a chaque update via le callback `#[ORM\PreUpdate]`.
|
||||
|
||||
### Mapping Doctrine — `doctrine.yaml`
|
||||
|
||||
```yaml
|
||||
# Mapping inconditionnelle du module Sites : la structure DB existe meme
|
||||
# si SitesModule::class est retire de config/modules.php. L'activation
|
||||
# fonctionnelle (ex: exposition des permissions, futurs endpoints API)
|
||||
# passe exclusivement par config/modules.php.
|
||||
Sites:
|
||||
type: attribute
|
||||
is_bundle: false
|
||||
dir: '%kernel.project_dir%/src/Module/Sites/Domain/Entity'
|
||||
prefix: 'App\Module\Sites\Domain\Entity'
|
||||
alias: Sites
|
||||
```
|
||||
|
||||
## 6. Plan de migration Doctrine
|
||||
|
||||
La migration est placee dans `/home/m-tristan/workspace/Coltura/migrations/Version<timestamp>.php` au namespace racine `DoctrineMigrations`, conformement a l'exception documentee dans `CLAUDE.md`. Tant que le bug de tri alphabetique des `MigrationsComparator` multi-namespaces n'est pas resolu (via un comparator custom ou un upgrade Doctrine), toute migration d'initialisation (creation de table sur base vide) reste au namespace racine.
|
||||
|
||||
### `up()` — ordre des instructions
|
||||
|
||||
1. Creer la table `site` avec toutes les colonnes NOT NULL :
|
||||
- `id INT GENERATED BY DEFAULT AS IDENTITY NOT NULL`
|
||||
- `name VARCHAR(100) NOT NULL`
|
||||
- `city VARCHAR(100) NOT NULL`
|
||||
- `postal_code VARCHAR(10) NOT NULL`
|
||||
- `color VARCHAR(7) NOT NULL`
|
||||
- `full_address TEXT NOT NULL`
|
||||
- `created_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL`
|
||||
- `updated_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL`
|
||||
- `PRIMARY KEY (id)`
|
||||
2. Creer l'index unique `uniq_site_name` sur `site(name)` pour garantir l'invariant metier "un site porte un nom unique" au niveau DB. Le validator applicatif `UniqueEntity` s'appuie dessus en lecture avant qu'une tentative d'insertion concurrente ne remonte la violation DB.
|
||||
|
||||
### `down()` — rollback
|
||||
|
||||
1. `DROP TABLE site`. Aucune FK n'existe depuis ou vers cette table dans ce ticket ; le rollback est donc trivial et safe.
|
||||
|
||||
### Precision timestamp
|
||||
|
||||
PostgreSQL `TIMESTAMP(0) WITHOUT TIME ZONE` stocke a la seconde pres. Les DateTimeImmutable PHP portent une precision microseconde mais perdent cette precision au round-trip DB. Les tests unitaires de lifecycle doivent en tenir compte (cf. section 10 — usage de reflection plutot qu'un `sleep`).
|
||||
|
||||
## 7. Intégration avec sync-permissions
|
||||
|
||||
Le ticket ne modifie pas `SyncPermissionsCommand`. Il exploite l'algorithme existant (cf. ticket-343 section 7) en declarant `SitesModule::permissions()` dans un format strictement conforme au contrat attendu par la commande :
|
||||
|
||||
```php
|
||||
public static function permissions(): array
|
||||
{
|
||||
return [
|
||||
['code' => 'sites.view', 'label' => 'Voir les sites'],
|
||||
['code' => 'sites.manage', 'label' => 'Gerer les sites (creer, editer, supprimer)'],
|
||||
];
|
||||
}
|
||||
```
|
||||
|
||||
Regles de validation appliquees par `SyncPermissionsCommand` :
|
||||
- Chaque entree doit contenir exactement les cles `code` et `label`.
|
||||
- Le prefixe du code doit correspondre a `SitesModule::ID . '.'`, soit `sites.`.
|
||||
- Ni `code` ni `label` ne peuvent etre une chaine vide.
|
||||
|
||||
Comportement a attendre :
|
||||
- Apres `php bin/console app:sync-permissions`, les deux lignes `sites.view` et `sites.manage` sont presentes dans la table `permission` avec `module = 'sites'` et `orphan = false`.
|
||||
- Si `SitesModule::class` est retire de `config/modules.php` et la commande relancee, les deux lignes sont marquees `orphan = true` (non supprimees, pour preserver les assignations). Reactiver le module les remet a `orphan = false`.
|
||||
- La cle `module` n'est **pas** presente dans le payload : elle est auto-injectee par la commande depuis `SitesModule::ID`.
|
||||
|
||||
### Granularité des permissions
|
||||
|
||||
`sites.manage` est une permission **composite** couvrant creation, edition et suppression. Ce choix reste simple pour un ticket fondateur, mais le ticket 4 (administration CRUD) devra arbitrer si une granularite plus fine (`sites.create`, `sites.edit`, `sites.delete`) est necessaire pour les besoins UX. Si oui, la migration de permissions se fera naturellement via la commande de sync : ajouter les trois codes dans `permissions()`, retirer `sites.manage` → la sync marque l'ancien orphelin sans casser les roles deja existants.
|
||||
|
||||
## 8. Méthodes clés détaillées
|
||||
|
||||
### `Site::__construct`
|
||||
|
||||
Le constructeur prend les cinq champs metier obligatoires et positionne les deux timestamps a la meme valeur :
|
||||
|
||||
```php
|
||||
public function __construct(
|
||||
string $name,
|
||||
string $city,
|
||||
string $postalCode,
|
||||
string $color,
|
||||
string $fullAddress,
|
||||
) {
|
||||
$this->name = $name;
|
||||
$this->city = $city;
|
||||
$this->postalCode = $postalCode;
|
||||
$this->color = $color;
|
||||
$this->fullAddress = $fullAddress;
|
||||
$now = new DateTimeImmutable();
|
||||
$this->createdAt = $now;
|
||||
$this->updatedAt = $now;
|
||||
}
|
||||
```
|
||||
|
||||
Justification :
|
||||
- Tous les champs sont passes au constructeur pour forcer l'invariant "un Site instancie est toujours complet". L'alternative (setters post-new) autoriserait des etats transitoires invalides.
|
||||
- `createdAt` et `updatedAt` partagent la meme valeur a l'instanciation, ce qui garantit `updated_at >= created_at` au niveau base. Le premier appel a `onPreUpdate()` fera avancer uniquement `updatedAt`.
|
||||
|
||||
### `Site::onPreUpdate`
|
||||
|
||||
```php
|
||||
#[ORM\PreUpdate]
|
||||
public function onPreUpdate(): void
|
||||
{
|
||||
$this->updatedAt = new DateTimeImmutable();
|
||||
}
|
||||
```
|
||||
|
||||
Justification :
|
||||
- Callback Doctrine declenche **uniquement** quand Doctrine detecte au moins un changement sur l'entite en session de persistance. Pas de risque de tick silencieux sur un find pur.
|
||||
- `createdAt` n'est volontairement jamais touche ici : il est immuable apres persistance.
|
||||
- Pas de `#[ORM\PrePersist]` : le constructeur gere deja l'initialisation, inutile de dupliquer la logique dans un callback qui pourrait etre appele a vide.
|
||||
|
||||
### `SitesFixtures::ensureSite`
|
||||
|
||||
```php
|
||||
private function ensureSite(
|
||||
ObjectManager $manager,
|
||||
string $name,
|
||||
string $city,
|
||||
string $postalCode,
|
||||
string $color,
|
||||
string $fullAddress,
|
||||
): Site {
|
||||
$site = $this->siteRepository->findByName($name);
|
||||
|
||||
if (null === $site) {
|
||||
$site = new Site($name, $city, $postalCode, $color, $fullAddress);
|
||||
$manager->persist($site);
|
||||
|
||||
return $site;
|
||||
}
|
||||
|
||||
$site->setCity($city);
|
||||
$site->setPostalCode($postalCode);
|
||||
$site->setColor($color);
|
||||
$site->setFullAddress($fullAddress);
|
||||
|
||||
return $site;
|
||||
}
|
||||
```
|
||||
|
||||
Contrat honnete sur l'idempotence (cf. docblock en tete de fixture) :
|
||||
- **Supporte** : lookup par nom avec purger Doctrine actif (cas nominal de `doctrine:fixtures:load`).
|
||||
- **Supporte** : lookup par nom hors purger si la fixture est rejouee telle quelle sur une base deja seedee → les autres champs sont re-alignes sur les valeurs de reference.
|
||||
- **Non supporte** : chargement cumulatif apres qu'une autre fixture ait `persist` (sans `flush`) des Site dans la meme session → `findByName` via `findOneBy` n'inspecte pas l'unit-of-work et peut creer un doublon.
|
||||
- **Non supporte** : renommage d'un site dans la fixture → le lookup par `name` rate, un nouveau site est cree, l'ancien reste en base si le purger est desactive.
|
||||
|
||||
## 9. Fixtures Sites
|
||||
|
||||
Trois sites de demonstration, avec des couleurs distinctes suffisamment contrastees pour un futur affichage visuel (ticket 3 — navbar) :
|
||||
|
||||
| Nom | Ville | CP | Couleur | Commentaire |
|
||||
|-----|-------|-----|---------|-------------|
|
||||
| Chatellerault | Chatellerault | 86100 | `#056CF2` | Couleur imposee par le ticket (bleu Coltura). |
|
||||
| Saint-Jean | Saint-Jean-de-Sauves | 86330 | `#10B981` | Vert emeraude (contraste avec le bleu). |
|
||||
| Pommevic | Pommevic | 82400 | `#F59E0B` | Ambre (troisieme teinte nettement distincte). |
|
||||
|
||||
Les adresses completes sont des chaines multi-lignes (voie + CP/ville), cas nominal d'exploitation du type `TEXT` sur `full_address`.
|
||||
|
||||
### Ordre d'execution global des fixtures
|
||||
|
||||
`SitesFixtures` est une `Fixture` sans dependance : elle peut s'executer dans n'importe quel ordre relatif aux autres fixtures Core (`AppFixtures`). Aucune FK inter-modules dans ce ticket.
|
||||
|
||||
Le ticket 2 introduira probablement une relation `User ↔ Site` ; `SitesFixtures` devra alors etre declare comme dependance de `AppFixtures` (ou inversement, selon la direction de la FK) via `DependentFixtureInterface::getDependencies()`.
|
||||
|
||||
## 10. Plan de tests PHPUnit
|
||||
|
||||
Deux suites separees, motivation :
|
||||
- `SiteTest` reste en `TestCase` pur (pas de kernel) pour tester le comportement mecanique de l'entite — rapide, zero dependance DB.
|
||||
- `SiteValidationTest` utilise `KernelTestCase` pour avoir acces au validator applicatif, **indispensable** pour tester `UniqueEntity` dont le validator est backed par Doctrine et necessite donc un `ManagerRegistry` reel.
|
||||
|
||||
### `SiteTest` — tests unitaires purs
|
||||
|
||||
1. `testConstructorInitialState` : verifie que le constructeur positionne correctement les 5 champs metier et les deux timestamps (`DateTimeImmutable`).
|
||||
2. `testCreatedAtAndUpdatedAtAreInitiallyEqual` : verifie l'invariant "a l'instanciation, `createdAt == updatedAt`".
|
||||
3. `testOnPreUpdateAdvancesUpdatedAtOnly` : utilise `Reflection` pour forcer `updatedAt` a une valeur anterieure (`-1 hour`), appelle `onPreUpdate()`, et verifie que `updatedAt` avance strictement mais que `createdAt` reste immuable.
|
||||
- **Justification reflection** : eviter un `sleep/usleep` flaky en CI et lent.
|
||||
4. `testSettersMutateFields` : verifie que les setters publics modifient correctement les champs metier.
|
||||
|
||||
### `SiteValidationTest` — tests d'integration validator
|
||||
|
||||
Bootstrap : `self::bootKernel()` dans `setUp()`, recuperation de `ValidatorInterface` et `EntityManagerInterface` depuis le container.
|
||||
|
||||
Tests de validation scalaire (via `DataProvider` PHPUnit 12+, attribut `#[DataProvider]`) :
|
||||
1. `testValidSitePassesValidation` : un Site correct passe sans violation.
|
||||
2. `testColorMustBeHexRrggbb` / `testValidColorsAreAccepted` : jeu de donnees invalide (`red`, `#FFF`, `FFFFFF`, `rgb(...)`, `#1234567`, `#12345G`, `""`) vs valide (`#ABCDEF`, `#abcdef`, `#0a1B2c`, `#000000`, `#FFFFFF`).
|
||||
3. `testPostalCodeMustMatchFrFormat` / `testValidPostalCodesAreAccepted` : jeu de donnees invalide (`1234`, `123456`, `8610A`, `86-100`, `""`, `86 100`) vs valide (`86100`, `75001`, `97100`, `20000`).
|
||||
4. `testBlankNameIsRejected`, `testBlankCityIsRejected`, `testBlankFullAddressIsRejected` : `NotBlank` sur chaque champ obligatoire.
|
||||
5. `testNameLongerThan100CharsIsRejected`, `testCityLongerThan100CharsIsRejected` : `Length(max: 100)`.
|
||||
|
||||
Test d'unicite :
|
||||
6. `testDuplicateNameIsRejected` : **auto-suffisant** — persiste lui-meme un site porteur d'un nom unique (`Test-Duplicate-<uniqid>`), flush, tente de valider un second Site avec le meme nom, verifie qu'au moins une violation porte `UniqueEntity::NOT_UNIQUE_ERROR` sur la property `name`, puis supprime le site en `finally`.
|
||||
- **Justification** : pas de dependance aux fixtures (robustesse, pas de couplage sur `Chatellerault`). Assertion precise sur le `code` de violation + `propertyPath`, pas sur le message (resistant aux traductions).
|
||||
|
||||
### Pattern `finally` pour cleanup
|
||||
|
||||
```php
|
||||
try {
|
||||
$duplicate = new Site($name, ...);
|
||||
$violations = $this->validator->validate($duplicate);
|
||||
// assertions...
|
||||
} finally {
|
||||
$this->em->remove($original);
|
||||
$this->em->flush();
|
||||
}
|
||||
```
|
||||
|
||||
Garantit le cleanup meme si une assertion rate, sans dependre d'une transaction globale de test.
|
||||
|
||||
## 11. Risques et points d'attention
|
||||
|
||||
### Risque 1 — Mapping Doctrine inconditionnel
|
||||
|
||||
Le mapping `Sites:` est declare dans `doctrine.yaml` sans dependance a `config/modules.php`. Consequence : retirer `SitesModule::class` de `modules.php` ne desactive **pas** le mapping Doctrine ni la table `site`.
|
||||
|
||||
Decision assumee et alignee avec le traitement du module `Core` :
|
||||
- La structure DB est "toujours la" (migrations jouees inconditionnellement).
|
||||
- L'activation fonctionnelle (exposition des permissions, futurs endpoints) passe exclusivement par `modules.php`.
|
||||
|
||||
Cela doit etre **explicite dans `doctrine.yaml`** via un commentaire en tete du bloc `Sites:` pour eviter qu'un futur reviewer n'interprete le mapping comme un oubli.
|
||||
|
||||
### Risque 2 — Migration racine vs migration modulaire
|
||||
|
||||
La migration est placee dans `migrations/` et non dans `src/Module/Sites/Infrastructure/Doctrine/Migrations/`. C'est une exception documentee dans `CLAUDE.md` et dans le docblock de la migration elle-meme, motivee par un bug de tri alphabetique des `MigrationsComparator` en Doctrine Migrations 3.x lorsque plusieurs `migrations_paths` sont declares.
|
||||
|
||||
Consequence pour les tickets futurs :
|
||||
- Tant que le bug n'est pas resolu, **toute nouvelle migration d'initialisation** (creation de table sur base vide) continuera d'aller au namespace racine.
|
||||
- Les migrations applicatives (ajout de colonne, backfill) qui supposent un schema deja en place peuvent vivre dans le namespace modulaire, comme prevu.
|
||||
- Une fois le bug resolu (comparator custom ou upgrade Doctrine), migrer les fichiers vers le namespace modulaire sera un simple `git mv` + ajustement du namespace PHP.
|
||||
|
||||
### Risque 3 — Idempotence des fixtures non cumulative
|
||||
|
||||
Le docblock de `SitesFixtures` declare explicitement les cas d'idempotence supportes et non supportes (cf. section 8). Ne pas promettre une robustesse que le pattern ne tient pas : si un futur ticket introduit une fixture persistant des Site **avant** `SitesFixtures` sans flush intermediaire, un doublon peut apparaitre. Le contrat ecrit permet au reviewer de ce futur ticket de reagir.
|
||||
|
||||
### Risque 4 — Regex couleur non normalisee
|
||||
|
||||
La regex `/^#[0-9A-Fa-f]{6}$/` accepte majuscules et minuscules. Les fixtures utilisent des majuscules ; si l'UI du ticket 4 permet de saisir en minuscules, deux couleurs "visuellement identiques" pourront coexister en base avec casse differente, cassant toute comparaison naive (`$a->color === $b->color`). A decider au ticket 4 : normaliser en uppercase a la persistance, ou assumer le stockage tel quel et normaliser uniquement a la comparaison.
|
||||
|
||||
### Risque 5 — Precision timestamp PostgreSQL TIMESTAMP(0)
|
||||
|
||||
PostgreSQL `TIMESTAMP(0)` ecrete a la seconde pres. Deux updates espaces de moins d'une seconde produisent le meme `updated_at` en base. Pas un probleme pour les cas d'usage metier de ce ticket (edition manuelle), mais a garder en tete si un ticket futur introduit un `updatedAt` comme cle de tri ou de detection de version optimiste.
|
||||
|
||||
## 12. Ordre d'exécution recommandé
|
||||
|
||||
1. **Exploration** — Lire le module Core (`CoreModule.php`, `User.php`, `Role.php`) pour aligner le style.
|
||||
2. **Module declaration** — Creer `SitesModule.php` avec `permissions()`.
|
||||
3. **Entite** — Creer `Site.php` avec tous les attributs Doctrine et contraintes de validation.
|
||||
4. **Repository** — Creer `SiteRepositoryInterface.php` puis `DoctrineSiteRepository.php`.
|
||||
5. **Configuration** — Enregistrer le mapping dans `doctrine.yaml`, l'alias dans `services.yaml`, le module dans `modules.php`.
|
||||
6. **Migration** — Generer le fichier de migration (manuellement ou via `doctrine:migrations:diff` puis ajuster), jouer `make migration-migrate`.
|
||||
7. **Fixtures** — Creer `SitesFixtures.php`, jouer `make fixtures` puis `make sync-permissions`.
|
||||
8. **Tests unitaires** — Ecrire `SiteTest.php` (TestCase pur).
|
||||
9. **Tests validation** — Ecrire `SiteValidationTest.php` (KernelTestCase).
|
||||
10. **Validation DoD** — `make test-db-setup && make test` (doit passer 148/148), verifier que designer SitesModule ne casse rien.
|
||||
11. **CS fixer** — `make php-cs-fixer-allow-risky FILES="src/Module/Sites tests/Module/Sites migrations/Version<timestamp>.php config/..."`.
|
||||
|
||||
## 13. Critères d'acceptation (DoD)
|
||||
|
||||
- [ ] `SitesModule.php` existe et declare exactement 2 permissions (`sites.view`, `sites.manage`) prefixees `sites.` conformement au format attendu par `SyncPermissionsCommand`.
|
||||
- [ ] `SitesModule::class` est enregistre dans `config/modules.php` et active par defaut.
|
||||
- [ ] Entite `Site` creee avec tous les champs, contraintes de validation (`NotBlank`, `Length`, `Regex hex`, `Regex CP FR`, `UniqueEntity`) et timestamps auto.
|
||||
- [ ] `SiteRepositoryInterface` expose au minimum `findById`, `findByName`, `findAllOrderedByName`, `save`, `remove` ; `DoctrineSiteRepository` l'implemente.
|
||||
- [ ] La migration existe dans `migrations/` (namespace `DoctrineMigrations`), cree la table `site` et l'index unique `uniq_site_name`, est jouable via `make migration-migrate`.
|
||||
- [ ] `SitesFixtures` cree les 3 sites avec couleurs distinctes et docblock honnete sur son idempotence.
|
||||
- [ ] `make fixtures` charge les 3 sites sans erreur et est rejouable apres purge.
|
||||
- [ ] Apres `app:sync-permissions`, la table `permission` contient `sites.view` et `sites.manage` avec `module = 'sites'` et `orphan = false`.
|
||||
- [ ] Le mapping `Sites:` est declare dans `doctrine.yaml` avec un commentaire explicite sur son caractere inconditionnel.
|
||||
- [ ] L'alias `SiteRepositoryInterface → DoctrineSiteRepository` est declare dans `services.yaml`.
|
||||
- [ ] `make test` passe 148/148 tests avec `SitesModule::class` active.
|
||||
- [ ] `make test` passe 148/148 tests avec `SitesModule::class` commente dans `config/modules.php`.
|
||||
- [ ] `make php-cs-fixer-allow-risky` ne signale aucune correction sur les fichiers du ticket.
|
||||
- [ ] Aucun import direct depuis `src/Module/Core/...` vers `src/Module/Sites/...` ni l'inverse (independance des bounded contexts).
|
||||
592
docs/sites/ticket-02-spec.md
Normal file
592
docs/sites/ticket-02-spec.md
Normal file
@@ -0,0 +1,592 @@
|
||||
# Ticket #02 — 2/4 — Exposition API, rattachement utilisateurs et admin CRUD
|
||||
|
||||
## 1. Objectif
|
||||
|
||||
Ce ticket transforme la brique de donnees du ticket 1 en module fonctionnel : il expose la ressource `Site` via API Platform (CRUD admin avec RBAC), introduit la notion de **sites autorises** et de **site courant** sur chaque utilisateur, ouvre un endpoint dedie au basculement du site courant, et livre la page d'administration `/admin/sites` ainsi que l'assignation des sites dans le drawer RBAC d'un user.
|
||||
|
||||
Le resultat attendu est un module Sites utilisable de bout en bout cote admin (creer, editer, supprimer des sites et en assigner aux users), avec une API `/api/me` enrichie que le ticket 3 consommera pour alimenter le selecteur de site dans la navbar. Le ticket etablit le couplage Core → Sites **au niveau modele** (la table `user` gagne deux relations vers `site`) tout en conservant le contrat "desactiver Sites dans `config/modules.php` ne casse pas l'app" via des decisions DB/mapping assumees.
|
||||
|
||||
## 2. Périmètre
|
||||
|
||||
### IN
|
||||
|
||||
- Exposer `Site` comme ressource API Platform avec les operations `GetCollection`, `Get`, `Post`, `Patch`, `Delete`, securisees par les permissions `sites.view` (lecture) et `sites.manage` (ecriture).
|
||||
- Ajouter deux relations sur `User` (module Core) :
|
||||
- `$sites` (M2M, `user_site`) : sites autorises.
|
||||
- `$currentSite` (M2O nullable) : site actuellement selectionne.
|
||||
- Ajouter la relation inverse `$users` sur `Site` (non exposee API).
|
||||
- Generer la migration Doctrine creant la table `user_site` et la colonne `user.current_site_id` avec les bonnes strategies `ON DELETE` pour garantir les cascades attendues (suppression d'un site → `user_site` purge, `currentSite` mis a `NULL`).
|
||||
- Etendre `/api/me` pour exposer `sites: Site[]` et `currentSite: Site | null` en objets serialises (pas en IRI), via les groupes `me:read` sur `User` **et** sur `Site`.
|
||||
- Ajouter un endpoint dedie de switch du site courant, implemente comme une ressource API Platform virtuelle `CurrentSite` avec une operation `Patch uriTemplate: '/me/current-site'` et un processor dedie. Le processor garantit que le site cible fait partie des `sites` de l'utilisateur authentifie, sinon il leve une exception traduite en `403`.
|
||||
- Etendre `UserRbacProcessor` et l'operation `PATCH /api/users/{id}/rbac` pour accepter un champ `sites: string[]` (IRIs) en plus des roles et permissions directes. Cas limite : si le `currentSite` du user cible n'est plus dans la liste, le processor le bascule a `NULL`.
|
||||
- Etendre l'exception metier Core pour couvrir "site non autorise" via une nouvelle exception domaine `SiteNotAuthorizedException` placee dans le module Sites, traduite en `ForbiddenHttpException` au niveau API.
|
||||
- Ajouter l'entree sidebar `sidebar.admin.sites` filtree par `module: 'sites'` + `permission: 'sites.view'` dans `config/sidebar.php`, sous la section admin Core existante.
|
||||
- Livrer la page d'administration `/admin/sites` cote front (layer Nuxt `frontend/modules/sites/`) : DataTable + drawer creation/edition + modale suppression, alignee visuellement et structurellement sur `/admin/roles` et `/admin/users`.
|
||||
- Etendre le drawer `UserRbacDrawer.vue` (module Core) pour afficher et editer la liste des sites autorises d'un user via un multi-select.
|
||||
- Ajouter les fixtures : rattacher les 3 users existants (`admin`, `alice`, `bob`) a au moins un site et positionner un `currentSite` coherent.
|
||||
- Couverture de tests PHPUnit : CRUD `/api/sites`, endpoint `/me/current-site` (cas OK + 403), extension `/api/me`, cascade DB a la suppression d'un site, extension `UserRbacProcessor` (ajout/retrait sites, auto-reset currentSite).
|
||||
|
||||
### OUT
|
||||
|
||||
- Ticket `#03` : selecteur de site dans la navbar, persistance du site actif cote front, integration visuelle avec la couleur du site.
|
||||
- Ticket `#04` : filtrage metier par site (ex: bloquer l'acces aux ressources Commercial si l'user n'est pas rattache au site de la ressource).
|
||||
- Soft-delete des sites : non introduit.
|
||||
- Audit trail des modifications : hors scope.
|
||||
- Color picker avance : un input hex simple avec preview de la puce suffit.
|
||||
- Recherche / tri server-side sur `/api/sites` : non requis, le volume reste <20 sites par instance.
|
||||
- Gestion des site "globaux" ou "par defaut" pour les nouveaux users : non introduite, les users crees via `CreateUserCommand` ou `/api/users` POST auront `sites: []` et `currentSite: null` jusqu'a rattachement explicite.
|
||||
|
||||
## 3. Fichiers à créer
|
||||
|
||||
### Backend — Module Sites
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/src/Module/Sites/Domain/Exception/SiteNotAuthorizedException.php` : exception domaine levee si un user tente de switcher vers un site qui ne fait pas partie de ses sites autorises. Porte un message i18n-able et le code du site cible.
|
||||
- `/home/m-tristan/workspace/Coltura/src/Module/Sites/Infrastructure/ApiPlatform/Resource/CurrentSiteResource.php` : ressource API Platform **virtuelle** (pas de mapping Doctrine, pas de `#[ORM\Entity]`). Sert uniquement a porter l'operation `Patch` `/me/current-site`. Expose une propriete `site: Site` en denormalisation pour recevoir l'IRI du site cible, et re-expose l'user courant en normalisation via le groupe `me:read`.
|
||||
- `/home/m-tristan/workspace/Coltura/src/Module/Sites/Infrastructure/ApiPlatform/State/Processor/CurrentSiteProcessor.php` : processor dedie a l'operation de switch. Valide l'appartenance du site aux `user.sites`, positionne `user.currentSite`, flush, retourne l'user.
|
||||
- `/home/m-tristan/workspace/Coltura/src/Module/Sites/Infrastructure/ApiPlatform/EventListener/SiteNotAuthorizedExceptionListener.php` : listener Kernel qui convertit `SiteNotAuthorizedException` en `ForbiddenHttpException` (403) avec un code i18n stable (cf. pattern `SystemRoleDeletionException` du module Core dans les tickets RBAC precedents).
|
||||
|
||||
### Backend — Migration
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/migrations/Version<timestamp2>.php` : migration au namespace racine `DoctrineMigrations` (cf. exception Doctrine documentee dans `CLAUDE.md`). Cree la table `user_site` et la colonne `user.current_site_id` avec les FKs et cascades appropriees.
|
||||
|
||||
### Backend — Tests API
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/tests/Module/Sites/Api/SiteApiTest.php` : CRUD complet `/api/sites` avec matrices RBAC (admin, user avec `sites.view`, user avec `sites.manage`, user sans permission).
|
||||
- `/home/m-tristan/workspace/Coltura/tests/Module/Sites/Api/CurrentSiteSwitchApiTest.php` : PATCH `/me/current-site` (OK avec site autorise, 403 avec site non autorise, 400 avec IRI invalide).
|
||||
- `/home/m-tristan/workspace/Coltura/tests/Module/Sites/Api/MeEndpointSitesTest.php` : `/api/me` expose bien `sites` et `currentSite` en objets. User sans site : `sites: []`, `currentSite: null`.
|
||||
- `/home/m-tristan/workspace/Coltura/tests/Module/Sites/Api/SiteCascadeTest.php` : suppression d'un site `X` → toutes les lignes `user_site` referencant `X` sont supprimees, tous les users ayant `X` en `currentSite` voient leur `currentSite` repasser a `NULL`.
|
||||
- `/home/m-tristan/workspace/Coltura/tests/Module/Core/Api/UserRbacSitesApiTest.php` : extension du endpoint `/api/users/{id}/rbac` — ajout de `sites: []` dans le payload, retrait du `currentSite` quand le site retire etait le courant.
|
||||
|
||||
### Frontend — Module Sites (nouveau layer)
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/modules/sites/nuxt.config.ts` : marker de layer Nuxt (vide). Declenche l'auto-detection par `nuxt.config.ts` racine.
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/modules/sites/pages/admin/sites.vue` : page `/admin/sites`. Reutilise les composants Malio UI (`MalioDataTable`, `MalioButton`, `MalioInputText`, `MalioInputTextArea`). Pattern identique a `frontend/modules/core/pages/admin/roles.vue`.
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/modules/sites/components/SiteDrawer.vue` : drawer creation/edition. Formulaire 5 champs (nom, ville, CP, couleur avec preview puce, adresse). Valide cote front sur le submit avant d'envoyer.
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/modules/sites/components/SiteDeleteModal.vue` : modale de confirmation suppression. Pattern aligne sur `RoleDeleteModal.vue`.
|
||||
|
||||
### Frontend — Types partages
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/shared/types/sites.ts` : types `Site`, `SiteInput`. Pattern identique a `frontend/shared/types/rbac.ts`.
|
||||
|
||||
### Tests frontend (optionnels mais recommandes)
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/modules/sites/pages/admin/sites.spec.ts` : smoke test Vitest (rendu + clic bouton "Nouveau site" ouvre le drawer).
|
||||
|
||||
## 4. Fichiers à modifier
|
||||
|
||||
### Backend — Module Core
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/src/Module/Core/Domain/Entity/User.php` :
|
||||
- Ajouter `private Collection $sites;` (M2M, `fetch: EAGER`, `JoinTable: user_site`), groupes `me:read`, `user:list`, `user:rbac:read`, `user:rbac:write`.
|
||||
- Ajouter `private ?Site $currentSite = null;` (M2O, `fetch: EAGER`, `onDelete: 'SET NULL'`), groupe `me:read`.
|
||||
- Initialiser `$this->sites = new ArrayCollection();` dans le constructeur.
|
||||
- Ajouter les accesseurs `getSites()`, `addSite(Site)`, `removeSite(Site)`, `hasSite(Site)`, `getCurrentSite()`, `setCurrentSite(?Site)`.
|
||||
- **Important** : `import` direct `App\Module\Sites\Domain\Entity\Site`. Ce ticket assume le couplage Core → Sites au niveau code PHP (cf. Risque 1).
|
||||
- `/home/m-tristan/workspace/Coltura/src/Module/Core/Infrastructure/ApiPlatform/State/Processor/UserRbacProcessor.php` :
|
||||
- Etendre le contrat d'entree pour accepter le champ `sites` (collection d'IRIs denormalisees en `Collection<Site>`).
|
||||
- Apres l'application des roles et permissions directes, detecter si `currentSite` du user cible n'est plus dans la nouvelle collection `sites` → basculer `currentSite` a `null`.
|
||||
- Conserver toutes les gardes existantes (auto-suicide admin, dernier admin global).
|
||||
- `/home/m-tristan/workspace/Coltura/src/Module/Core/Infrastructure/DataFixtures/AppFixtures.php` :
|
||||
- Declarer l'implementation `DependentFixtureInterface` avec `getDependencies(): [SitesFixtures::class]` (inversion de l'ordre actuel : AppFixtures doit tourner **apres** SitesFixtures pour pouvoir reference les sites).
|
||||
- Rattacher chaque user a au moins un site : `admin` a tous les sites (`Chatellerault`, `Saint-Jean`, `Pommevic`), `alice` a `Chatellerault`, `bob` a `Saint-Jean`.
|
||||
- Positionner `currentSite` : `admin.currentSite = Chatellerault`, `alice.currentSite = Chatellerault`, `bob.currentSite = Saint-Jean`.
|
||||
|
||||
### Backend — Module Sites
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/src/Module/Sites/Domain/Entity/Site.php` :
|
||||
- Ajouter les attributs `#[ApiResource]` + operations (cf. section 5 Schema).
|
||||
- Ajouter les groupes de serialisation `site:read`, `site:write`, `me:read` sur les proprietes scalaires.
|
||||
- Ajouter la relation inverse `private Collection $users;` (M2M mappedBy=`sites`), **sans** groupe de serialisation (pas d'exposition API cote Site).
|
||||
- Initialiser `$this->users = new ArrayCollection();` dans le constructeur.
|
||||
- Ajouter les accesseurs `getUsers()` pour les besoins metier (count / cascade manuel si besoin).
|
||||
- `/home/m-tristan/workspace/Coltura/src/Module/Sites/Infrastructure/DataFixtures/SitesFixtures.php` : aucun changement de contenu, mais verifier que la fixture n'est plus en bout de chaine de dependance (AppFixtures depend d'elle maintenant).
|
||||
|
||||
### Backend — Configuration
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/config/sidebar.php` : inserer l'entree `Sites` dans la section `sidebar.general.section` entre `sidebar.core.users` et `sidebar.general.logout` :
|
||||
```php
|
||||
[
|
||||
'label' => 'sidebar.core.sites',
|
||||
'to' => '/admin/sites',
|
||||
'icon' => 'mdi:domain',
|
||||
'module' => 'sites',
|
||||
'permission' => 'sites.view',
|
||||
],
|
||||
```
|
||||
- `/home/m-tristan/workspace/Coltura/config/services.yaml` : aucun changement requis. `CurrentSiteProcessor`, `SiteNotAuthorizedExceptionListener` sont autoconfigures.
|
||||
|
||||
### Frontend
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/modules/core/components/UserRbacDrawer.vue` :
|
||||
- Charger `GET /api/sites?itemsPerPage=999` a l'ouverture du drawer (parallelement aux roles et permissions deja charges).
|
||||
- Ajouter une section `sidebar.admin.usersDrawer.sitesSection` sous la section permissions directes, avec un groupe de `MalioCheckbox` par site (ou un `MalioMultiSelect` si le composant existe dans `@malio/layer-ui`).
|
||||
- Etendre le payload `PATCH /api/users/{id}/rbac` avec `sites: Array<string>` (IRIs).
|
||||
- Auto-refresh de l'auth store apres save si `isSelfEdit` (deja present, conserver).
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/shared/types/rbac.ts` : ajouter le champ `sites: string[]` a `UserListItem` (IRIs de sites attaches).
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/shared/stores/auth.ts` : le store auth expose deja `user` via `/api/me`. Aucune modification requise, les nouveaux champs `sites` et `currentSite` suivent automatiquement via la typologie — a condition de mettre a jour le type `UserData` dans `shared/types/` (ajouter `sites: Site[]` et `currentSite: Site | null`).
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/i18n/locales/fr.json` : cles
|
||||
- `sidebar.core.sites` = "Sites".
|
||||
- `admin.sites.title`, `admin.sites.newSite`, `admin.sites.editSite`, `admin.sites.createSite`, `admin.sites.noSites`.
|
||||
- `admin.sites.table.{name, city, postalCode, color, fullAddress}`.
|
||||
- `admin.sites.form.{name, city, postalCode, color, fullAddress}`.
|
||||
- `admin.sites.delete.{title, message}`.
|
||||
- `admin.sites.toast.{created, updated, deleted}`.
|
||||
- `admin.users.drawer.sitesSection` = "Sites autorises".
|
||||
- `errors.sites.notAuthorized` = "Vous n'etes pas autorise a selectionner ce site.".
|
||||
|
||||
## 5. Schéma cible — ApiResource et Doctrine
|
||||
|
||||
### Entite `Site` — attributs ApiResource
|
||||
|
||||
```php
|
||||
#[ApiResource(
|
||||
operations: [
|
||||
new GetCollection(
|
||||
security: "is_granted('sites.view')",
|
||||
normalizationContext: ['groups' => ['site:read']],
|
||||
),
|
||||
new Get(
|
||||
security: "is_granted('sites.view')",
|
||||
normalizationContext: ['groups' => ['site:read']],
|
||||
),
|
||||
new Post(
|
||||
security: "is_granted('sites.manage')",
|
||||
normalizationContext: ['groups' => ['site:read']],
|
||||
denormalizationContext: ['groups' => ['site:write']],
|
||||
),
|
||||
new Patch(
|
||||
security: "is_granted('sites.manage')",
|
||||
normalizationContext: ['groups' => ['site:read']],
|
||||
denormalizationContext: ['groups' => ['site:write']],
|
||||
),
|
||||
new Delete(security: "is_granted('sites.manage')"),
|
||||
],
|
||||
)]
|
||||
```
|
||||
|
||||
Groupes sur les proprietes de `Site` :
|
||||
- `id` : `site:read`, `me:read`.
|
||||
- `name`, `city`, `postalCode`, `color`, `fullAddress` : `site:read`, `site:write`, `me:read`.
|
||||
- `createdAt`, `updatedAt` : `site:read` uniquement (pas exposes en embed `me:read` pour garder le payload /me leger).
|
||||
|
||||
### Evolution de `User` — nouvelles relations
|
||||
|
||||
```php
|
||||
/** @var Collection<int, Site> */
|
||||
#[ORM\ManyToMany(targetEntity: Site::class, fetch: 'EAGER')]
|
||||
#[ORM\JoinTable(name: 'user_site')]
|
||||
#[Groups(['me:read', 'user:list', 'user:rbac:read', 'user:rbac:write'])]
|
||||
private Collection $sites;
|
||||
|
||||
#[ORM\ManyToOne(targetEntity: Site::class, fetch: 'EAGER')]
|
||||
#[ORM\JoinColumn(name: 'current_site_id', referencedColumnName: 'id', nullable: true, onDelete: 'SET NULL')]
|
||||
#[Groups(['me:read'])]
|
||||
private ?Site $currentSite = null;
|
||||
```
|
||||
|
||||
Justification fetch=EAGER :
|
||||
- Aligne sur les collections `$rbacRoles` et `$directPermissions` (cf. `User.php:87`).
|
||||
- Critique pour eviter un lazy-load silencieux pendant un refresh JWT (cf. ticket 343 section 11 risque 1).
|
||||
- Surcout SQL accepte a l'echelle d'un CRM PME (≤20 sites par instance).
|
||||
|
||||
### Relation inverse sur `Site`
|
||||
|
||||
```php
|
||||
/** @var Collection<int, User> */
|
||||
#[ORM\ManyToMany(targetEntity: User::class, mappedBy: 'sites')]
|
||||
private Collection $users;
|
||||
```
|
||||
|
||||
Pas de `#[Groups]` : la collection inverse n'est pas exposee dans la reponse API. Sa seule utilite est metier (compter les users d'un site, iterer pour un cascade applicatif si la cascade DB ne suffisait pas).
|
||||
|
||||
### Ressource virtuelle `CurrentSite`
|
||||
|
||||
```php
|
||||
#[ApiResource(
|
||||
shortName: 'CurrentSite',
|
||||
operations: [
|
||||
new Patch(
|
||||
uriTemplate: '/me/current-site',
|
||||
security: "is_granted('ROLE_USER')",
|
||||
normalizationContext: ['groups' => ['me:read']],
|
||||
denormalizationContext: ['groups' => ['current-site:write']],
|
||||
processor: CurrentSiteProcessor::class,
|
||||
read: false,
|
||||
),
|
||||
],
|
||||
)]
|
||||
final class CurrentSiteResource
|
||||
{
|
||||
#[Groups(['current-site:write'])]
|
||||
public ?Site $site = null;
|
||||
}
|
||||
```
|
||||
|
||||
- `read: false` : API Platform ne tente pas de charger une entite existante via un Provider — il se contente de denormaliser le body et de passer la ressource au processor.
|
||||
- `shortName: 'CurrentSite'` : evite la collision de nommage avec l'entite `Site`.
|
||||
- `security: "is_granted('ROLE_USER')"` : tout user authentifie peut tenter un switch ; l'autorisation fine (appartenance du site aux `sites` du user) est verifiee par le processor, pas par la voter RBAC.
|
||||
|
||||
## 6. Plan de migration Doctrine
|
||||
|
||||
La migration est placee dans `/home/m-tristan/workspace/Coltura/migrations/Version<timestamp2>.php` au namespace racine (cf. Risque 2 du ticket 1 et `CLAUDE.md`).
|
||||
|
||||
### `up()` — ordre des instructions
|
||||
|
||||
1. `ALTER TABLE "user" ADD current_site_id INT DEFAULT NULL` — colonne nullable, pas besoin de backfill.
|
||||
2. `CREATE TABLE user_site (user_id INT NOT NULL, site_id INT NOT NULL, PRIMARY KEY (user_id, site_id))`.
|
||||
3. `CREATE INDEX IDX_user_site_user ON user_site (user_id)`.
|
||||
4. `CREATE INDEX IDX_user_site_site ON user_site (site_id)`.
|
||||
5. `ALTER TABLE user_site ADD CONSTRAINT FK_user_site_user FOREIGN KEY (user_id) REFERENCES "user" (id) ON DELETE CASCADE`.
|
||||
6. `ALTER TABLE user_site ADD CONSTRAINT FK_user_site_site FOREIGN KEY (site_id) REFERENCES site (id) ON DELETE CASCADE`.
|
||||
7. `CREATE INDEX IDX_user_current_site ON "user" (current_site_id)`.
|
||||
8. `ALTER TABLE "user" ADD CONSTRAINT FK_user_current_site FOREIGN KEY (current_site_id) REFERENCES site (id) ON DELETE SET NULL`.
|
||||
|
||||
### `down()` — rollback
|
||||
|
||||
1. `ALTER TABLE "user" DROP CONSTRAINT FK_user_current_site`.
|
||||
2. `DROP INDEX IDX_user_current_site`.
|
||||
3. `ALTER TABLE "user" DROP current_site_id`.
|
||||
4. `ALTER TABLE user_site DROP CONSTRAINT FK_user_site_site`.
|
||||
5. `ALTER TABLE user_site DROP CONSTRAINT FK_user_site_user`.
|
||||
6. `DROP TABLE user_site`.
|
||||
|
||||
### Comportement des cascades
|
||||
|
||||
| Action | Effet |
|
||||
|--------|-------|
|
||||
| `DELETE FROM site WHERE id = X` | Toutes les lignes `user_site` avec `site_id = X` sont supprimees (FK `ON DELETE CASCADE`). Tous les users avec `current_site_id = X` voient leur `current_site_id` passer a `NULL` (FK `ON DELETE SET NULL`). |
|
||||
| `DELETE FROM "user" WHERE id = Y` | Toutes les lignes `user_site` avec `user_id = Y` sont supprimees. Pas d'effet sur `site`. |
|
||||
| `DELETE FROM user_site WHERE user_id = Y AND site_id = X` | Aucun effet auto sur `user.current_site_id` — si `X` etait le courant de `Y`, c'est le **UserRbacProcessor** qui doit le basculer a `NULL` en Php (cf. section 8). |
|
||||
|
||||
**Important** : la derniere ligne du tableau est la raison pour laquelle la logique de "retirer un site qui etait le courant remet currentSite a null" vit dans `UserRbacProcessor` cote applicatif et non dans la DB via un trigger. C'est un compromis assume : la regle est metier ("retirer un droit ne doit pas laisser l'user pointer sur un site interdit"), pas purement DB.
|
||||
|
||||
## 7. Algorithme du switch de site courant — `CurrentSiteProcessor`
|
||||
|
||||
### Entree
|
||||
|
||||
Body JSON envoye par le client :
|
||||
```json
|
||||
{ "site": "/api/sites/3" }
|
||||
```
|
||||
|
||||
API Platform denormalise vers `CurrentSiteResource { site: Site }` en resolvant l'IRI via son `IriConverter`.
|
||||
|
||||
### Algorithme
|
||||
|
||||
1. Recuperer l'user authentifie via `Security::getUser()`. Si absent → `LogicException` (l'operation exige `ROLE_USER`, ne doit pas arriver).
|
||||
2. Extraire `$targetSite = $resource->site`. Si `null` → `BadRequestHttpException('Le champ "site" est requis.')`.
|
||||
3. Verifier `$user->hasSite($targetSite)` :
|
||||
- Implementation : `$this->sites->contains($targetSite)` (comparaison par reference ; Doctrine garantit l'identite d'objet dans la meme session).
|
||||
- Si `false` → throw `SiteNotAuthorizedException($targetSite->getId())`.
|
||||
4. `$user->setCurrentSite($targetSite)`.
|
||||
5. `$this->entityManager->flush()`.
|
||||
6. Retourner `$user` — API Platform le normalise via les groupes `me:read` definis sur l'operation.
|
||||
|
||||
### Mapping d'exception
|
||||
|
||||
`SiteNotAuthorizedException` est convertie en `Symfony\Component\HttpKernel\Exception\HttpException` avec statut `403` par `SiteNotAuthorizedExceptionListener` (event `kernel.exception`, priority standard). Le corps de la reponse porte un code i18n-able `errors.sites.notAuthorized` pour le front.
|
||||
|
||||
## 8. Évolution du `UserRbacProcessor`
|
||||
|
||||
### Nouveau champ en entree
|
||||
|
||||
Le payload accepte desormais :
|
||||
```json
|
||||
{
|
||||
"isAdmin": false,
|
||||
"roles": ["/api/roles/2"],
|
||||
"directPermissions": [],
|
||||
"sites": ["/api/sites/1", "/api/sites/3"]
|
||||
}
|
||||
```
|
||||
|
||||
Le champ `sites` est optionnel : si absent, la collection n'est pas touchee (comportement PATCH standard). Si present, il remplace integralement la collection `$user->sites`.
|
||||
|
||||
### Garde "currentSite coherent"
|
||||
|
||||
Apres application des champs par le persist processor decore, `UserRbacProcessor` execute un controle final :
|
||||
|
||||
```php
|
||||
$currentSite = $data->getCurrentSite();
|
||||
if ($currentSite !== null && !$data->hasSite($currentSite)) {
|
||||
$data->setCurrentSite(null);
|
||||
}
|
||||
```
|
||||
|
||||
Justification : si un admin retire un site qui etait le `currentSite` de la cible, le modele serait incoherent (currentSite pointant vers un site non autorise). Le processor corrige automatiquement.
|
||||
|
||||
**Variante rejetee** : basculer vers "le premier site restant" plutot que `null`. Rejetee car :
|
||||
- "Premier restant" n'a pas de semantique metier claire (ordre de la collection non garanti strict).
|
||||
- `null` est une valeur deja supportee (user sans site courant) et explicite : le front du ticket 3 devra gerer ce cas de toute facon.
|
||||
|
||||
### Ordre d'execution dans le processor
|
||||
|
||||
1. Gardes auto-suicide admin + dernier admin global (code existant, inchange).
|
||||
2. `$this->persistProcessor->process($data, ...)` — applique tous les champs (roles, permissions directes, **sites**).
|
||||
3. Post-persist : controle coherence currentSite (code ajoute par ce ticket), flush si changement.
|
||||
4. Retour du user.
|
||||
|
||||
## 9. Fixtures — évolution de `AppFixtures`
|
||||
|
||||
`AppFixtures` devient dependant de `SitesFixtures` (inversion du "pas de dependance dure" declare au ticket 1 — justifie par le passage fonctionnel a la relation User ↔ Site).
|
||||
|
||||
```php
|
||||
class AppFixtures extends Fixture implements DependentFixtureInterface
|
||||
{
|
||||
public function getDependencies(): array
|
||||
{
|
||||
return [SitesFixtures::class];
|
||||
}
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
Dans `load()`, apres la creation des users et avant le `flush` final :
|
||||
|
||||
```php
|
||||
$chatellerault = $this->siteRepository->findByName('Chatellerault');
|
||||
$saintJean = $this->siteRepository->findByName('Saint-Jean');
|
||||
$pommevic = $this->siteRepository->findByName('Pommevic');
|
||||
|
||||
$admin->addSite($chatellerault);
|
||||
$admin->addSite($saintJean);
|
||||
$admin->addSite($pommevic);
|
||||
$admin->setCurrentSite($chatellerault);
|
||||
|
||||
$alice->addSite($chatellerault);
|
||||
$alice->setCurrentSite($chatellerault);
|
||||
|
||||
$bob->addSite($saintJean);
|
||||
$bob->setCurrentSite($saintJean);
|
||||
```
|
||||
|
||||
Le repository `SiteRepositoryInterface` est injecte dans le constructeur.
|
||||
|
||||
**Regle** : les 3 sites sont deja en base au moment ou `AppFixtures::load()` s'execute grace a `getDependencies()`. Si `findByName` retourne `null`, c'est une misconfiguration qui doit faire echouer fort (assertion via `\assert`).
|
||||
|
||||
## 10. Frontend — Page `/admin/sites`
|
||||
|
||||
### Structure
|
||||
|
||||
```
|
||||
frontend/modules/sites/
|
||||
├── nuxt.config.ts # marker layer Nuxt (vide)
|
||||
├── pages/
|
||||
│ └── admin/
|
||||
│ └── sites.vue # page listing
|
||||
└── components/
|
||||
├── SiteDrawer.vue # creation/edition
|
||||
└── SiteDeleteModal.vue # confirmation suppression
|
||||
```
|
||||
|
||||
### `pages/admin/sites.vue` — pattern
|
||||
|
||||
Aligne sur `frontend/modules/core/pages/admin/roles.vue` :
|
||||
- En-tete : titre + bouton `Nouveau site` (visible si `can('sites.manage')`).
|
||||
- `MalioDataTable` : colonnes `name`, `city`, `postalCode`, `color` (slot custom pour la puce), `fullAddress` (tronque).
|
||||
- Row click → ouvre `SiteDrawer` en mode edition si `can('sites.manage')`, sinon pas de clic (row-clickable guard).
|
||||
- `SiteDrawer` emet `saved` → reload de la liste, et `delete` → ouvre `SiteDeleteModal`.
|
||||
- `SiteDeleteModal` → DELETE `/api/sites/{id}` + reload.
|
||||
|
||||
### `components/SiteDrawer.vue`
|
||||
|
||||
Formulaire a 5 champs + preview de la couleur. Pattern `RoleDrawer.vue` :
|
||||
- `MalioInputText` pour `name`, `city`, `postalCode`.
|
||||
- `MalioInputText` pour `color` avec preview : une puce `<span>` 24×24 arrondie affichant la couleur en temps reel a cote du champ. Valider localement via regex avant submit (ne pas envoyer un hex invalide au backend).
|
||||
- `MalioInputTextArea` pour `fullAddress`.
|
||||
- Bouton save (variant primary), bouton delete (variant danger, visible uniquement en mode edition, **aucune garde system comme pour les roles** — tous les sites sont supprimables), bouton cancel (variant tertiary).
|
||||
|
||||
### `components/SiteDeleteModal.vue`
|
||||
|
||||
Pattern `RoleDeleteModal.vue` :
|
||||
- Modal avec message "Supprimer le site {name} ? Cette action est irreversible et retirera ce site a tous les utilisateurs rattaches."
|
||||
- Bouton cancel (secondary) + bouton delete (danger avec icone poubelle).
|
||||
- Emet `confirm` au clic delete.
|
||||
|
||||
### Extension de `UserRbacDrawer.vue`
|
||||
|
||||
Ajout d'une nouvelle section entre "Permissions directes" et "Resume des permissions effectives" :
|
||||
|
||||
```vue
|
||||
<!-- Section Sites autorises -->
|
||||
<div>
|
||||
<h4 class="mb-3 text-sm font-semibold text-neutral-700">
|
||||
{{ t('admin.users.drawer.sitesSection') }}
|
||||
</h4>
|
||||
<div class="flex flex-col gap-2">
|
||||
<MalioCheckbox
|
||||
v-for="site in allSites"
|
||||
:key="site.id"
|
||||
:id="`site-${site.id}`"
|
||||
:label="site.name"
|
||||
:model-value="selectedSiteIds.has(site.id)"
|
||||
label-class="text-sm text-neutral-600"
|
||||
@update:model-value="(val: boolean) => toggleSite(site.id, val)"
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
```
|
||||
|
||||
Chargement : ajout a `loadData()` d'un `api.get<{ member: Site[] }>('/sites', { itemsPerPage: 999 }, { toast: false })`.
|
||||
|
||||
Le `PATCH /api/users/{id}/rbac` envoie desormais `sites: Array.from(selectedSiteIds).map(id => `/api/sites/${id}`)`.
|
||||
|
||||
### Types TypeScript
|
||||
|
||||
`frontend/shared/types/sites.ts` :
|
||||
|
||||
```ts
|
||||
export interface Site {
|
||||
id: number
|
||||
name: string
|
||||
city: string
|
||||
postalCode: string
|
||||
color: string
|
||||
fullAddress: string
|
||||
}
|
||||
|
||||
export interface SiteInput {
|
||||
name: string
|
||||
city: string
|
||||
postalCode: string
|
||||
color: string
|
||||
fullAddress: string
|
||||
}
|
||||
```
|
||||
|
||||
`frontend/shared/types/rbac.ts` : ajouter `sites: string[]` (IRIs) dans `UserListItem`.
|
||||
|
||||
`frontend/shared/types/` (fichier utilisateur courant, probablement `user.ts` ou expose dans l'auth store) : ajouter `sites: Site[]` et `currentSite: Site | null` sur le type expose via `/api/me`.
|
||||
|
||||
### Sidebar
|
||||
|
||||
Entree ajoutee dans `config/sidebar.php` (cf. section 4). Le `SidebarProvider` filtre deja par `module` actif et par `permission`, aucune modification backend nouvelle.
|
||||
|
||||
i18n :
|
||||
```json
|
||||
"sidebar": {
|
||||
"core": {
|
||||
"sites": "Sites"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 11. Plan de tests PHPUnit
|
||||
|
||||
### `SiteApiTest` — CRUD `/api/sites`
|
||||
|
||||
1. `testAdminCanListSites` : admin → 200, 3 sites.
|
||||
2. `testUserWithSitesViewCanListSites` : user avec `sites.view` → 200.
|
||||
3. `testUserWithoutPermissionGetsForbidden` : user sans `sites.view` → 403.
|
||||
4. `testAdminCanCreateSite` : POST → 201, site present en base.
|
||||
5. `testAdminCanPatchSite` : PATCH `color` → 200.
|
||||
6. `testAdminCanDeleteSite` : DELETE → 204, site absent en base.
|
||||
7. `testUserWithViewButNotManageCannotDelete` : user avec `sites.view` mais pas `sites.manage` → 403 sur DELETE.
|
||||
8. `testCreateSiteWithDuplicateNameReturns422` : collision `uniq_site_name` → 422 avec message UniqueEntity.
|
||||
9. `testCreateSiteWithInvalidColorReturns422` : validation regex → 422.
|
||||
|
||||
### `CurrentSiteSwitchApiTest` — PATCH `/me/current-site`
|
||||
|
||||
1. `testUserCanSwitchToAuthorizedSite` : alice a `Chatellerault` dans ses sites → PATCH OK, 200, `currentSite.name == 'Chatellerault'`.
|
||||
2. `testUserCannotSwitchToUnauthorizedSite` : alice n'a pas `Pommevic` dans ses sites → PATCH → 403, pas de modification en base.
|
||||
3. `testSwitchWithMissingSiteFieldReturns400` : body `{}` → 400.
|
||||
4. `testSwitchWithInvalidIriReturns400` : body `{"site": "/api/sites/99999"}` (site inexistant) → 400 ou 404 (selon API Platform).
|
||||
5. `testAnonymousUserCannotSwitch` : client non authentifie → 401.
|
||||
|
||||
### `MeEndpointSitesTest` — extension `/api/me`
|
||||
|
||||
1. `testMeExposesSitesAsObjects` : alice → `sites[0]` est un objet avec `id`, `name`, `city`, ... (pas une string IRI).
|
||||
2. `testMeExposesCurrentSiteAsObject` : alice → `currentSite` est un objet, pas `null`.
|
||||
3. `testUserWithoutSitesHasEmptyArrayAndNullCurrent` : creer un user jetable sans sites → `sites: []`, `currentSite: null`.
|
||||
|
||||
### `SiteCascadeTest` — cascade DB a la suppression
|
||||
|
||||
1. `testDeletingSitePurgesUserSiteRows` : supprimer `Chatellerault` → les users qui l'avaient dans `sites` ne l'ont plus.
|
||||
2. `testDeletingSiteSetsCurrentSiteToNullOnReferencingUsers` : alice.currentSite = `Chatellerault`, supprimer `Chatellerault` → alice.currentSite = `null`.
|
||||
|
||||
### `UserRbacSitesApiTest` — extension `/rbac`
|
||||
|
||||
1. `testAdminCanAssignSitesToUser` : PATCH `/users/{alice}/rbac` avec `sites: ["/api/sites/2"]` → alice a desormais 1 site (`Saint-Jean`), plus `Chatellerault`.
|
||||
2. `testRemovingCurrentSiteResetsCurrentSiteToNull` : alice.currentSite = `Chatellerault`, PATCH avec `sites: []` → alice.currentSite = `null`.
|
||||
3. `testEmptySitesPayloadReplacesCollection` : alice avait 1 site, PATCH avec `sites: []` → 0 site.
|
||||
4. `testSitesPayloadWithDuplicateIrisIsAccepted` : PATCH avec `sites: ["/api/sites/1", "/api/sites/1"]` → 1 seul site (dedoublonnage via `ArrayCollection::contains`).
|
||||
|
||||
### Tests fixtures (sanity check)
|
||||
|
||||
Dans `AbstractApiTestCase` ou dans un test dedie `FixturesIntegrityTest` : verifier apres `make test-db-setup` que les 3 users fixtures ont bien leurs sites attendus. Evite qu'un renommage dans la fixture passe inapercu.
|
||||
|
||||
## 12. Risques et points d'attention
|
||||
|
||||
### Risque 1 — Couplage Core → Sites au niveau code PHP
|
||||
|
||||
L'ajout de `use App\Module\Sites\Domain\Entity\Site;` dans `User.php` introduit une dependance directe du module Core vers le module Sites. Consequence :
|
||||
|
||||
- **Desactiver `SitesModule::class` dans `config/modules.php` n'empeche pas Doctrine de charger le mapping `Site` ni `User`**, grace au caractere inconditionnel des mappings declares dans `doctrine.yaml` (choix assume ticket 1).
|
||||
- En revanche, la contrainte forte introduite ici est que **la table `site` doit exister** pour que la table `user` puisse etre creee (FK `user.current_site_id → site.id`). Si la migration Sites (ticket 1) n'a pas ete jouee, la migration de ce ticket echouera.
|
||||
- Conclusion : Sites n'est plus "optionnel au sens strict" apres ce ticket. Le declarer `REQUIRED = false` dans `SitesModule` reste vrai du point de vue de l'activation fonctionnelle (exposer les permissions et la sidebar), mais faux du point de vue DB. **A documenter explicitement dans le docblock de `SitesModule::REQUIRED`** au moment de ce ticket.
|
||||
|
||||
### Risque 2 — Cascade DB vs regle applicative
|
||||
|
||||
La cascade `user_site` → `ON DELETE CASCADE` gere la suppression d'un site, mais **n'est pas triggered** quand on retire un site d'un user (DELETE d'une ligne `user_site` uniquement). Dans ce cas, `user.current_site_id` peut rester pointe vers un site que l'user n'a plus — etat incoherent qui serait masque au niveau DB mais visible a l'usage.
|
||||
|
||||
La correction vit dans `UserRbacProcessor` (cf. section 8). Si un autre chemin applicatif modifie `user.sites` sans passer par ce processor (ex: une commande console custom), il devra dupliquer cette garde. **Point d'attention a consigner dans le docblock de `User::addSite()` / `User::removeSite()`** : "apres modification, verifier la coherence de `currentSite`".
|
||||
|
||||
### Risque 3 — Ressource virtuelle et routing API Platform
|
||||
|
||||
Le choix d'une ressource virtuelle `CurrentSite` avec `uriTemplate: '/me/current-site'` est fragile : si un futur ticket introduit une autre operation sur une URI qui commence par `/me/`, il faut verifier que le routing API Platform n'entre pas en conflit. Le pattern `priority: 1` (cf. `CLAUDE.md` section Backend) est recommande par prevention sur l'operation Patch. A valider par un test fonctionnel qui appelle explicitement `/api/me` (GET) et `/api/me/current-site` (PATCH) dans le meme scenario.
|
||||
|
||||
### Risque 4 — EAGER loading et payload `/api/me`
|
||||
|
||||
`User` a deja 3 collections EAGER (`$rbacRoles`, `$directPermissions`, plus les `permissions` de chaque role). Ajouter `$sites` (EAGER M2M) et `$currentSite` (EAGER M2O) augmente la taille du payload `/api/me` et le nombre de requetes SQL a chaque auth.
|
||||
|
||||
Mesure : apres implementation, verifier via le profiler Symfony que le nombre de requetes SQL sur `/api/me` reste raisonnable (≤ 6-8). Si >10, envisager une projection custom (cf. ticket 343 discussion `findForSecurity`). Pas bloquant dans ce ticket, mais a reverifier.
|
||||
|
||||
### Risque 5 — Tests fixtures-dependents
|
||||
|
||||
Les tests API existants (`UserApiTest`, `RoleApiTest`) s'appuient sur les users fixtures. L'evolution de `AppFixtures` (ajout de sites aux 3 users) modifie l'etat initial de la DB de test. Verifier que les tests existants continuent de passer (chaines d'assertions du type "user a 1 role" ne doivent pas casser). En particulier :
|
||||
- Les tests qui comptent les lignes d'une collection `member[]` sur `/api/users` peuvent voir le payload grossir (sites et currentSite ajoutes).
|
||||
- Les tests qui assertent sur la forme stricte d'un user (snapshot-like) devront etre adapter.
|
||||
|
||||
### Risque 6 — Serialisation infinie User ↔ Site
|
||||
|
||||
`User::$sites` expose `Site` en `me:read`. `Site::$users` est la collection inverse. Si un jour `Site::$users` recevait le groupe `me:read`, la serialisation entrerait dans une boucle infinie (User → sites → users → sites → ...). **Garde** : `Site::$users` ne doit **jamais** porter de `#[Groups]`. A verifier par un test qui serialise `/api/me` et asserte qu'aucun `Site` renvoye ne contient de cle `users`.
|
||||
|
||||
### Risque 7 — Pas de recours si l'utilisateur se retire tous ses sites
|
||||
|
||||
Le ticket autorise un user sans sites (`sites: []`, `currentSite: null`). Mais aucune garde ne l'empeche de se retirer tous ses sites via `/api/users/{mon_id}/rbac` si il porte `sites.manage`. Consequence : l'user se retrouve bloque sur l'app si le ticket 3 rend un site actif obligatoire pour naviguer. Compromis assume pour ce ticket : on ne bloque pas l'auto-retrait (coherence avec le pattern du ticket RBAC — l'auto-retrait admin est bloque, mais pas le reste). **A reevaluer au ticket 3** si le selecteur de navbar devient bloquant.
|
||||
|
||||
## 13. Ordre d'exécution recommandé
|
||||
|
||||
1. **Schema backend** — modifier `User.php` (ajout `$sites`, `$currentSite`, `$users` inverse sur `Site`). Ajouter attributs `ApiResource` sur `Site`.
|
||||
2. **Configuration** — aucun changement requis a `doctrine.yaml` ni `services.yaml` ni `modules.php`.
|
||||
3. **Migration** — ecrire `Version<timestamp2>.php` racine. Jouer `make migration-migrate`.
|
||||
4. **Fixtures** — modifier `AppFixtures` pour dependre de `SitesFixtures` et rattacher les users. Jouer `make fixtures && make sync-permissions`.
|
||||
5. **Endpoint CRUD sites** — verifier via `curl`/Postman que `GET /api/sites`, `POST /api/sites` etc. repondent avec les bonnes protections RBAC.
|
||||
6. **Endpoint switch** — creer `CurrentSiteResource`, `CurrentSiteProcessor`, `SiteNotAuthorizedException`, `SiteNotAuthorizedExceptionListener`. Tester via `curl`.
|
||||
7. **Extension MeProvider** — tester via `curl /api/me` que `sites` et `currentSite` apparaissent comme objets. Aucun code a changer dans `MeProvider` lui-meme, le travail est 100% fait via les groupes.
|
||||
8. **Extension UserRbacProcessor** — ajouter le champ `sites` et la garde `currentSite`. Tests d'integration.
|
||||
9. **Tests API** — ecrire et faire passer les 5 suites de tests decrites section 11.
|
||||
10. **Sidebar** — ajouter l'entree dans `config/sidebar.php` + cle i18n.
|
||||
11. **Frontend — types** — creer `shared/types/sites.ts`, etendre `shared/types/rbac.ts` et les types user.
|
||||
12. **Frontend — page admin** — creer `modules/sites/nuxt.config.ts`, `pages/admin/sites.vue`, `SiteDrawer.vue`, `SiteDeleteModal.vue`.
|
||||
13. **Frontend — extension UserRbacDrawer** — ajouter la section sites.
|
||||
14. **Frontend — i18n** — completer `fr.json`.
|
||||
15. **Validation end-to-end** — clique-droit sur chaque scenario UX : creer un site, l'editer, le supprimer, assigner sites a un user, switcher le site courant de l'user authentifie.
|
||||
16. **Tests front (si Vitest du ticket)** — smoke test du rendu de `/admin/sites`.
|
||||
17. **CS fixer** — `make php-cs-fixer-allow-risky` sur tous les fichiers touches.
|
||||
18. **DoD** — valider les 10 criteres section 14.
|
||||
|
||||
## 14. Critères d'acceptation (DoD)
|
||||
|
||||
- [ ] `GET /api/sites`, `GET /api/sites/{id}` retournent 200 pour un user avec `sites.view`, 403 sinon.
|
||||
- [ ] `POST /api/sites`, `PATCH /api/sites/{id}`, `DELETE /api/sites/{id}` retournent le code attendu pour un user avec `sites.manage`, 403 sinon.
|
||||
- [ ] `GET /api/me` retourne `sites: Site[]` (objets complets) et `currentSite: Site | null`, avec les 3 sites pour `admin`, 1 pour `alice`, 1 pour `bob`.
|
||||
- [ ] `PATCH /api/me/current-site` avec un site autorise → 200, `currentSite` mis a jour. Avec un site non autorise → 403.
|
||||
- [ ] `DELETE /api/sites/{id}` cascade correctement : les lignes `user_site` sont purgees, les `current_site_id` pointant dessus repassent a `NULL`.
|
||||
- [ ] `PATCH /api/users/{id}/rbac` accepte le champ `sites` ; retirer le `currentSite` de la liste le bascule a `null`.
|
||||
- [ ] Page `/admin/sites` : liste, creation, edition, suppression fonctionnelles.
|
||||
- [ ] `UserRbacDrawer.vue` : section "Sites autorises" visible et fonctionnelle.
|
||||
- [ ] Sidebar : entree "Sites" visible pour un user avec `sites.view`, masquee sinon. Disparait si `SitesModule::class` est retire de `config/modules.php`.
|
||||
- [ ] `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).
|
||||
542
docs/sites/ticket-03-spec.md
Normal file
542
docs/sites/ticket-03-spec.md
Normal file
@@ -0,0 +1,542 @@
|
||||
# Ticket #03 — 3/4 — Barre de sélection de site (navbar horizontale)
|
||||
|
||||
## 0. Pivots post-implémentation (2026-04-20)
|
||||
|
||||
Écarts assumés entre la spec initiale (écrite avant exploration de la lib) et
|
||||
le code livré après implémentation et test visuel. À lire en premier pour
|
||||
comprendre les divergences lors de la relecture.
|
||||
|
||||
1. **Contraste texte auto supprimé, texte blanc forcé conforme Figma.**
|
||||
La spec (sections 5, 6, 10) prévoyait un calcul de luminance WCAG pour
|
||||
décider entre texte noir et blanc sur chaque tile. Après test visuel, le
|
||||
choix design retenu est d'imposer **texte blanc partout** (default Malio
|
||||
`text-white font-bold uppercase tracking-wide`). Conséquence : charge à
|
||||
l'admin de choisir des couleurs de site suffisamment foncées pour que le
|
||||
blanc reste lisible. Les utilitaires `parseHex`, `getRelativeLuminance`,
|
||||
`getReadableTextColor` ont été supprimés comme code mort. Seul
|
||||
`isValidSiteColor(hex)` reste dans `shared/utils/color.ts` (consommé par
|
||||
`SiteDrawer`).
|
||||
|
||||
2. **Taille texte explicite `text-2xl` (24 px) appliquée via `labelClass`.**
|
||||
Malio applique `font-bold uppercase tracking-wide` sans taille explicite.
|
||||
Le wrapper `SiteSelector.vue` passe `labelClass="text-2xl"` pour garantir
|
||||
les 24 px de la maquette Figma.
|
||||
|
||||
3. **A11y : `ariaGroupLabel` au niveau radiogroup** au lieu de
|
||||
`ariaLabelActive` / `ariaLabelInactive` par tile. La raison : Malio rend
|
||||
déjà un `role="radio"` avec `aria-checked` par tile — le lecteur d'écran
|
||||
annonce "bouton radio coché/non coché" + le nom visible. Ajouter un
|
||||
`aria-label` par tile aurait dupliqué l'info et alourdi sans bénéfice.
|
||||
Le seul ajout nécessaire était un label au groupe, fait via
|
||||
`:aria-label="t('sites.selector.ariaGroupLabel')"` sur `MalioSiteSelector`.
|
||||
|
||||
4. **Auto-détection composables des layers dans `nuxt.config.ts`.**
|
||||
Pas prévu dans la spec. Ajouté car `imports.dirs` explicite override les
|
||||
auto-imports par défaut de Nuxt pour les composables de layer. Sans ça,
|
||||
`useCurrentSite` n'est pas résolu par Nuxt. Scan dynamique aligné sur le
|
||||
pattern `moduleLayers` existant.
|
||||
|
||||
5. **Couleurs fixtures finales :** `#056CF2` (Châtellerault), `#F3CB00`
|
||||
(Saint-Jean), `#74BF04` (Pommevic). Choix client post-maquette.
|
||||
|
||||
## 1. Objectif
|
||||
|
||||
Ce ticket livre l'UI de consommation du module Sites pour l'utilisateur final : une barre horizontale en haut de l'application qui liste les sites autorises de l'utilisateur connecte, met en avant le site courant et permet de basculer d'un site a l'autre en un clic.
|
||||
|
||||
Le ticket consomme la donnee posee par le ticket 2 (`/api/me` expose `sites` et `currentSite`, `PATCH /api/me/current-site` permet le switch) et s'appuie sur un nouveau composant `MalioSiteSelector` fourni par la version a jour de `@malio/layer-ui`.
|
||||
|
||||
Resultat attendu : apres merge, un user avec ≥ 1 site voit une barre sous la navbar horizontale ; un clic sur un site non actif le rend actif, change l'etat global, et est persiste cote serveur.
|
||||
|
||||
## 2. Périmètre
|
||||
|
||||
### IN
|
||||
|
||||
- **Upgrade** de `@malio/layer-ui` (actuellement `^1.3.0`) vers la version contenant `MalioSiteSelector`. La signature exacte du composant (props, slots, events) doit etre lue dans `node_modules/@malio/layer-ui/COMPONENTS.md` apres installation — la spec decrit le contrat attendu, le developpeur adapte selon l'API reelle (cf. Risque 1).
|
||||
- Ajouter les champs `sites: Site[]` et `currentSite: Site | null` dans le type `UserData` (`frontend/shared/types/user-data.ts`) pour refleter le payload `/api/me` enrichi au ticket 2.
|
||||
- Ajouter le type partage `Site` dans `frontend/shared/types/sites.ts` (deja cree au ticket 2, sinon a creer).
|
||||
- Creer le composable `useCurrentSite()` dans `frontend/modules/sites/composables/` qui expose `currentSite`, `availableSites`, `switchSite(site)`, `resetCurrentSite()`. Pattern aligne sur `useSidebar()`.
|
||||
- Creer le composable `useModules()` dans `frontend/shared/composables/` qui consomme `/api/modules` et expose `isModuleActive(id: string)`. Necessaire car `isModuleActive` est requis par le ticket mais n'existe pas encore cote front.
|
||||
- Creer `SiteSelector.vue` dans `frontend/modules/sites/components/` : wrapper fin autour de `MalioSiteSelector` qui branche le composable `useCurrentSite()`, gere l'optimistic update avec rollback, emet un toast de succes/erreur.
|
||||
- Integrer le selecteur dans `frontend/app/layouts/default.vue` — render conditionnel sur `isModuleActive('sites') && user.sites.length > 0`.
|
||||
- Appeler `resetCurrentSite()` au logout (`frontend/modules/core/pages/logout.vue`), aligne sur `resetSidebar()` deja present.
|
||||
- Gestion du **contraste automatique** : le texte du bloc passe en noir ou en blanc selon la luminance de `site.color`. Fonction utilitaire `getReadableTextColor(hex: string): 'black' | 'white'` dans `frontend/shared/utils/color.ts` (nouveau fichier utilitaire partage).
|
||||
- Accessibilite : chaque bloc est un `<button>` natif avec `aria-pressed` sur le site courant, focus visible (ring Tailwind), navigation clavier Tab + Enter fonctionnelle.
|
||||
- Responsive minimal : `flex-1` sur chaque bloc avec `min-w-[200px]` et `overflow-x-auto` sur le conteneur pour les cas 4+ sites sur petits ecrans.
|
||||
- Tests Vitest : unite sur `useCurrentSite` (switch, rollback, reset), unite sur `getReadableTextColor`, smoke test sur `SiteSelector.vue` (rendu, emission du PATCH, rollback en cas d'echec).
|
||||
|
||||
### OUT
|
||||
|
||||
- Ticket `#04` : filtrage metier par site (ex: bloquer l'acces aux ressources Commercial si l'user n'est pas rattache au site cible). Le site courant est simplement un **contexte UX** dans ce ticket, aucune regle d'autorisation ne s'appuie encore dessus.
|
||||
- Modification du layout `auth.vue` (login) : le selecteur n'est **jamais** rendu hors session authentifiee. Le layout login reste inchange.
|
||||
- Persistance du site actif cote front (localStorage, cookies) : le backend est source de verite, le front ne cache pas independamment.
|
||||
- Gestion d'une image / d'un logo par site : les sites sont identifies par nom + couleur uniquement dans ce ticket.
|
||||
- Pre-mount du selecteur sans `/api/me` complet : le middleware `auth.global.ts` garantit deja que `auth.user` est resolu avant le rendu — pas besoin de gerer un etat "chargement" specifique dans le selecteur.
|
||||
- Validation cote back d'une couleur "trop claire" : non introduite. Le ticket 2 accepte `#FFFFFF`. La compensation est faite cote front via le calcul de contraste ; une contrainte back arrivera si un abus se materialise.
|
||||
|
||||
## 3. Fichiers à créer
|
||||
|
||||
### Frontend — Module Sites (layer deja cree au ticket 2)
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/modules/sites/components/SiteSelector.vue` : wrapper Vue autour de `MalioSiteSelector`. Branche `useCurrentSite()`, gere l'optimistic update et les toasts.
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/modules/sites/composables/useCurrentSite.ts` : composable global exposant l'etat `currentSite` / `availableSites`, les actions `switchSite`, `resetCurrentSite`, et un flag `switching: Ref<boolean>` pour desactiver le selecteur pendant une requete en vol.
|
||||
|
||||
### Frontend — Shared
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/shared/composables/useModules.ts` : composable qui charge `/api/modules` et expose `isModuleActive(id: string): boolean`. Pattern aligne sur `useSidebar()` : ref singleton au niveau module, chargement idempotent, `resetModules()` expose pour le logout.
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/shared/utils/color.ts` : fonctions utilitaires de couleur, au minimum :
|
||||
- `parseHex(hex: string): { r: number; g: number; b: number }` — tolere la casse, rejette les formats hors `#RRGGBB`.
|
||||
- `getRelativeLuminance({r, g, b}): number` — formule WCAG standard.
|
||||
- `getReadableTextColor(hex: string): 'black' | 'white'` — renvoie `'black'` si la luminance > 0.5, `'white'` sinon. Seuil simple, suffisant pour un CRM interne (pas WCAG AAA).
|
||||
|
||||
### Frontend — Tests
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/modules/sites/composables/__tests__/useCurrentSite.spec.ts` : Vitest. Tests :
|
||||
- `switchSite` met a jour l'etat localement avant la requete (optimistic).
|
||||
- Si la requete reussit, l'etat reste aligne.
|
||||
- Si la requete echoue, l'etat rollback a l'ancien `currentSite`.
|
||||
- `resetCurrentSite` vide l'etat.
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/shared/composables/__tests__/useModules.spec.ts` : Vitest. Tests `isModuleActive` apres chargement, `resetModules` vide l'etat.
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/shared/utils/__tests__/color.spec.ts` : Vitest. Jeu de donnees sur `getReadableTextColor` : `#000000` → white, `#FFFFFF` → black, `#056CF2` (bleu Coltura) → white, `#F59E0B` (ambre) → black, `#10B981` (vert) → black ou white selon seuil (a verifier). Tester aussi le rejet de formats invalides.
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/modules/sites/components/__tests__/SiteSelector.spec.ts` : smoke test Vitest.
|
||||
|
||||
## 4. Fichiers à modifier
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/package.json` : upgrade `@malio/layer-ui` vers la version qui inclut `MalioSiteSelector`. Commit du `package-lock.json` dans le meme changeset.
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/shared/types/user-data.ts` : ajouter les champs
|
||||
```ts
|
||||
sites: Site[]
|
||||
currentSite: Site | null
|
||||
```
|
||||
Import du type `Site` depuis `./sites`. Note : si le type `Site` a deja ete introduit au ticket 2, reutiliser ; sinon, ce ticket le cree dans `frontend/shared/types/sites.ts`.
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/shared/types/sites.ts` : si absent, creer avec l'interface `Site` (cf. section Schema ticket 2 pour la forme). Si present, aucune modification.
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/app/layouts/default.vue` : integrer `SiteSelector` sous le header, avant `<main>`, dans le flex column. Rendu conditionnel via `v-if="showSiteSelector"` ou via un `defineAsyncComponent` chargement lazy si on veut eviter l'import statique quand le module est off.
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/app/middleware/auth.global.ts` : ajouter le chargement de `useModules().loadModules()` apres `loadSidebar()`. Necessaire pour que `isModuleActive` soit resolu quand le layout se rend.
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/modules/core/pages/logout.vue` : appeler `useCurrentSite().resetCurrentSite()` et `useModules().resetModules()` apres le `auth.logout()`, aligne sur le pattern `resetSidebar()` deja present.
|
||||
- `/home/m-tristan/workspace/Coltura/frontend/i18n/locales/fr.json` : ajouter les cles
|
||||
```json
|
||||
"sites": {
|
||||
"selector": {
|
||||
"switchSuccess": "Site courant change",
|
||||
"switchError": "Impossible de changer de site",
|
||||
"ariaLabelActive": "Site actif : {name}",
|
||||
"ariaLabelInactive": "Basculer sur le site {name}"
|
||||
}
|
||||
}
|
||||
```
|
||||
Ne **pas** mettre le nom du site en cle i18n : le nom est une donnee metier, pas un label.
|
||||
|
||||
## 5. Schéma cible — Composant `SiteSelector.vue`
|
||||
|
||||
### Render attendu (conforme Figma)
|
||||
|
||||
- Hauteur fixe : `h-[72px]`.
|
||||
- `width: 100%` (parent du `<main>` dans `layouts/default.vue`, donc occupe toute la zone a droite de la sidebar).
|
||||
- Flex horizontal, chaque bloc = `flex-1` avec `min-w-[200px]`.
|
||||
- Conteneur parent : `overflow-x-auto` pour scroll horizontal si 4+ sites sur ecran etroit.
|
||||
- Fond de chaque bloc : `site.color` (inline style car dynamique).
|
||||
- Texte : centre horizontalement et verticalement, `font-inter font-bold text-[24px] uppercase tracking-wide`, couleur calculee par `getReadableTextColor(site.color)`.
|
||||
- Opacite : `opacity-100` pour le site courant, `opacity-40` pour les autres.
|
||||
- Hover sur les inactifs : `hover:opacity-70 cursor-pointer transition-opacity`.
|
||||
- Focus clavier : `focus:ring-2 focus:ring-offset-2 focus:ring-primary-500 focus:outline-none`.
|
||||
- Semantique : chaque bloc est un `<button type="button">` (pas `<div>`), avec :
|
||||
- `aria-pressed="true"` sur le site courant.
|
||||
- `aria-label` dynamique via i18n (`sites.selector.ariaLabelActive` ou `ariaLabelInactive`).
|
||||
|
||||
### Contrat du wrapper `SiteSelector.vue`
|
||||
|
||||
```vue
|
||||
<template>
|
||||
<MalioSiteSelector
|
||||
:sites="availableSites"
|
||||
:current-site-id="currentSite?.id"
|
||||
:disabled="switching"
|
||||
@switch="handleSwitch"
|
||||
/>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
const { availableSites, currentSite, switching, switchSite } = useCurrentSite()
|
||||
|
||||
async function handleSwitch(siteId: number) {
|
||||
const target = availableSites.value.find(s => s.id === siteId)
|
||||
if (!target) return
|
||||
await switchSite(target)
|
||||
}
|
||||
</script>
|
||||
```
|
||||
|
||||
**Hypothese** : la signature exacte de `MalioSiteSelector` (nom du prop, nom de l'event) doit etre verifiee dans `@malio/layer-ui/COMPONENTS.md` apres upgrade. Si elle differe, adapter le wrapper sans toucher au composable. Le wrapper reste le seul point d'adherence a l'API externe.
|
||||
|
||||
Si `MalioSiteSelector` **n'embarque pas** le calcul de contraste texte, le wrapper doit le gerer en passant `:text-color` ou en injectant un style calcule. Si le composant delegue la couleur a un slot ou a un formatteur, ajuster l'appel.
|
||||
|
||||
### Composable `useCurrentSite()`
|
||||
|
||||
```ts
|
||||
import type { Site } from '~/shared/types/sites'
|
||||
|
||||
const currentSite = ref<Site | null>(null)
|
||||
const availableSites = ref<Site[]>([])
|
||||
const switching = ref(false)
|
||||
|
||||
export function useCurrentSite() {
|
||||
const auth = useAuthStore()
|
||||
const api = useApi()
|
||||
const { t } = useI18n()
|
||||
|
||||
// Hydratation depuis le store auth — single source of truth
|
||||
function syncFromAuth() {
|
||||
availableSites.value = auth.user?.sites ?? []
|
||||
currentSite.value = auth.user?.currentSite ?? null
|
||||
}
|
||||
|
||||
async function switchSite(site: Site) {
|
||||
if (switching.value) return
|
||||
const previous = currentSite.value
|
||||
|
||||
// Optimistic update
|
||||
currentSite.value = site
|
||||
switching.value = true
|
||||
|
||||
try {
|
||||
await api.patch('/me/current-site', { site: `/api/sites/${site.id}` }, {
|
||||
toastSuccessMessage: t('sites.selector.switchSuccess'),
|
||||
})
|
||||
// Propage au store auth pour que tous les consommateurs soient alignes
|
||||
if (auth.user) {
|
||||
auth.user.currentSite = site
|
||||
}
|
||||
} catch (error) {
|
||||
// Rollback
|
||||
currentSite.value = previous
|
||||
throw error // useApi a deja toast l'erreur si toast est active
|
||||
} finally {
|
||||
switching.value = false
|
||||
}
|
||||
}
|
||||
|
||||
function resetCurrentSite() {
|
||||
currentSite.value = null
|
||||
availableSites.value = []
|
||||
switching.value = false
|
||||
}
|
||||
|
||||
return {
|
||||
currentSite,
|
||||
availableSites,
|
||||
switching,
|
||||
switchSite,
|
||||
resetCurrentSite,
|
||||
syncFromAuth,
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Pattern** : state singleton au niveau module (refs module-level), meme convention que `useSidebar()`. Le singleton est necessaire pour que le logout + les consommateurs multiples partagent le meme etat. `resetCurrentSite()` est appele explicitement au logout (cf. section 4).
|
||||
|
||||
**Hydratation** : `syncFromAuth()` est appele au mount de `SiteSelector.vue` (dans un `onMounted` ou un `watch` sur `auth.user`). Alternative : appeler dans `auth.global.ts` apres `ensureSession()`.
|
||||
|
||||
### Composable `useModules()`
|
||||
|
||||
Pattern strictement aligne sur `useSidebar()` (cf. `frontend/shared/composables/useSidebar.ts`) :
|
||||
|
||||
```ts
|
||||
const activeModuleIds = ref<string[]>([])
|
||||
const loaded = ref(false)
|
||||
|
||||
export function useModules() {
|
||||
async function loadModules() {
|
||||
try {
|
||||
const api = useApi()
|
||||
const data = await api.get<{ modules: string[] }>('/modules', {}, { toast: false })
|
||||
activeModuleIds.value = data.modules ?? []
|
||||
loaded.value = true
|
||||
} catch {
|
||||
activeModuleIds.value = []
|
||||
loaded.value = true
|
||||
}
|
||||
}
|
||||
|
||||
function isModuleActive(id: string): boolean {
|
||||
return activeModuleIds.value.includes(id)
|
||||
}
|
||||
|
||||
function resetModules() {
|
||||
activeModuleIds.value = []
|
||||
loaded.value = false
|
||||
}
|
||||
|
||||
return { activeModuleIds, loaded, loadModules, isModuleActive, resetModules }
|
||||
}
|
||||
```
|
||||
|
||||
**Attention** : verifier la forme exacte de la reponse `/api/modules` via `curl /api/modules`. Les specs RBAC anterieurs suggerent `{ modules: string[] }` mais il faut valider.
|
||||
|
||||
## 6. Contraste automatique du texte
|
||||
|
||||
### Algorithme
|
||||
|
||||
Formule de luminance relative WCAG 2.1 (simplifiee) :
|
||||
|
||||
```ts
|
||||
function getRelativeLuminance({ r, g, b }: RGB): number {
|
||||
const [R, G, B] = [r, g, b].map(c => {
|
||||
const normalized = c / 255
|
||||
return normalized <= 0.03928
|
||||
? normalized / 12.92
|
||||
: ((normalized + 0.055) / 1.055) ** 2.4
|
||||
})
|
||||
return 0.2126 * R + 0.7152 * G + 0.0722 * B
|
||||
}
|
||||
|
||||
export function getReadableTextColor(hex: string): 'black' | 'white' {
|
||||
const rgb = parseHex(hex)
|
||||
return getRelativeLuminance(rgb) > 0.5 ? 'black' : 'white'
|
||||
}
|
||||
```
|
||||
|
||||
Le seuil 0.5 est un compromis pragmatique : simple, lisible, pas parfait WCAG AAA mais suffisant pour distinguer blancs/jaunes pales (→ texte noir) des bleus/verts/rouges saturés (→ texte blanc).
|
||||
|
||||
### Integration dans le selecteur
|
||||
|
||||
Le composable ou le template calcule la couleur pour chaque site une seule fois :
|
||||
|
||||
```ts
|
||||
const textColorsBySiteId = computed(() => {
|
||||
const map = new Map<number, string>()
|
||||
for (const site of availableSites.value) {
|
||||
map.set(site.id, getReadableTextColor(site.color))
|
||||
}
|
||||
return map
|
||||
})
|
||||
```
|
||||
|
||||
Le template applique `:style="{ color: textColorsBySiteId.get(site.id) }"` sur chaque bloc, ou passe la map au composant `MalioSiteSelector` si son API l'accepte.
|
||||
|
||||
### Cas limite — hex invalide
|
||||
|
||||
`parseHex` leve une `Error` si le format ne matche pas `#[0-9A-Fa-f]{6}`. Au niveau du selecteur, le template entoure l'acces dans un try/catch logique : si un site a une couleur invalide (improbable car la regex backend du ticket 1 bloque), fallback a texte blanc.
|
||||
|
||||
## 7. Intégration dans `layouts/default.vue`
|
||||
|
||||
### Structure actuelle
|
||||
|
||||
```
|
||||
<div class="h-screen overflow-hidden">
|
||||
<div class="flex h-full">
|
||||
<MalioSidebar ... />
|
||||
<div class="h-full flex-1 flex flex-col min-h-0 min-w-0">
|
||||
<main>...</main>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
```
|
||||
|
||||
### Structure cible
|
||||
|
||||
```
|
||||
<div class="h-screen overflow-hidden">
|
||||
<div class="flex h-full">
|
||||
<MalioSidebar ... />
|
||||
<div class="h-full flex-1 flex flex-col min-h-0 min-w-0">
|
||||
<SiteSelector v-if="showSiteSelector" />
|
||||
<main>...</main>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
```
|
||||
|
||||
Script :
|
||||
```ts
|
||||
const auth = useAuthStore()
|
||||
const { isModuleActive } = useModules()
|
||||
|
||||
const showSiteSelector = computed(() =>
|
||||
isModuleActive('sites') && (auth.user?.sites?.length ?? 0) > 0,
|
||||
)
|
||||
```
|
||||
|
||||
### Render conditionnel et flash
|
||||
|
||||
Le middleware `auth.global.ts` resout deja `auth.user` (via `ensureSession()`) avant le rendu des pages. Le middleware doit en plus declencher `loadModules()` pour que `isModuleActive` soit resolu au premier render. Sans ca, `showSiteSelector` sera `false` pendant un premier paint, puis `true` apres le chargement de `/api/modules` → flash visuel.
|
||||
|
||||
**Solution** : dans `auth.global.ts`, appeler `loadModules()` au meme niveau que `loadSidebar()`.
|
||||
|
||||
### Import statique vs dynamique
|
||||
|
||||
Deux options :
|
||||
- **Import statique** (`SiteSelector.vue` est toujours dans le bundle) : simple, le `v-if` gere l'affichage. Impact bundle minimal.
|
||||
- **Import dynamique** (`defineAsyncComponent`) : le composant n'est charge que si le module est actif. Plus propre au sens "desactiver Sites = zero code sites dans le bundle", mais le layer Nuxt rend le composant auto-importable → le code est deja dans le bundle de toute facon.
|
||||
|
||||
**Recommandation** : import statique. L'economie de bundle est marginale et le layer Nuxt charge deja tout le module.
|
||||
|
||||
## 8. i18n
|
||||
|
||||
### Clés ajoutées
|
||||
|
||||
```json
|
||||
{
|
||||
"sites": {
|
||||
"selector": {
|
||||
"switchSuccess": "Site courant change",
|
||||
"switchError": "Impossible de changer de site",
|
||||
"ariaLabelActive": "Site actif : {name}",
|
||||
"ariaLabelInactive": "Basculer sur le site {name}"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Règles
|
||||
|
||||
- **Jamais** traduire le nom d'un site (`site.name`). C'est une donnee metier, affichee telle quelle. L'`uppercase` est applique en CSS (`text-transform: uppercase`), pas dans la donnee.
|
||||
- Les `aria-label` interpollent `{name}` directement.
|
||||
- `switchError` est consomme par le toast d'erreur de `useApi` si la route serveur renvoie un code non-2xx. Pour une erreur 403 "site non autorise" (cf. ticket 2), le serveur renvoie deja un message traduit ou un code i18n stable — a arbitrer au moment de l'implementation selon la decision prise au ticket 2.
|
||||
|
||||
## 9. Accessibilité
|
||||
|
||||
- Chaque bloc est un `<button type="button">` (pas un `<div>` avec `role="button"` — preferer la semantique native).
|
||||
- `aria-pressed="true"` sur le bloc du site courant, `aria-pressed="false"` sur les autres.
|
||||
- `aria-label` : l'uppercase CSS est visuel ; l'aria-label garde la casse originale du nom pour le screen reader (`aria-label="Site actif : Chatellerault"`).
|
||||
- Focus visible : `focus:ring-2 focus:ring-offset-2 focus:ring-primary-500 focus:outline-none`.
|
||||
- Tab : parcourt les blocs de gauche a droite.
|
||||
- Enter / Espace : declenche le switch (comportement natif du `<button>`).
|
||||
- `tabindex="0"` n'est pas requis sur un `<button>` (deja focusable natif). Ne pas ajouter `tabindex="-1"` sur le bloc courant : l'user doit pouvoir revenir dessus.
|
||||
|
||||
## 10. Plan de tests
|
||||
|
||||
### Vitest — `useCurrentSite.spec.ts`
|
||||
|
||||
1. `switchSite met a jour currentSite localement immediatement` : avant la resolution de la promise, `currentSite.value` est deja le nouveau site.
|
||||
2. `switchSite persiste via /api/me/current-site` : mock `useApi`, verifier que la requete PATCH est appelee avec `site: '/api/sites/{id}'`.
|
||||
3. `switchSite rollback en cas d'erreur` : mock `useApi` pour rejeter, verifier que `currentSite.value` repasse a l'ancien site.
|
||||
4. `switchSite propagate au store auth apres succes` : `auth.user.currentSite` est mis a jour apres succes.
|
||||
5. `resetCurrentSite vide l'etat` : apres appel, `currentSite = null`, `availableSites = []`, `switching = false`.
|
||||
6. `switching est vrai pendant la requete, faux apres` : verifier le flag sur tout le cycle.
|
||||
7. `double switchSite concurrent est ignore` : si `switching = true`, un second appel retourne immediatement sans effet (garde anti-double-submit).
|
||||
|
||||
### Vitest — `useModules.spec.ts`
|
||||
|
||||
1. `loadModules charge /api/modules et alimente activeModuleIds`.
|
||||
2. `isModuleActive retourne true si l'id est present, false sinon`.
|
||||
3. `resetModules vide l'etat`.
|
||||
4. `loadModules swallow les erreurs et laisse activeModuleIds vide` (alignement avec `useSidebar`).
|
||||
|
||||
### Vitest — `color.spec.ts`
|
||||
|
||||
1. `getReadableTextColor('#FFFFFF') === 'black'`.
|
||||
2. `getReadableTextColor('#000000') === 'white'`.
|
||||
3. `getReadableTextColor('#056CF2') === 'white'` (bleu sature).
|
||||
4. `getReadableTextColor('#F59E0B') === 'black'` (ambre clair).
|
||||
5. `getReadableTextColor('#10B981') === 'white'` (vert medium-foncé). A verifier a l'implementation ; adapter l'assertion.
|
||||
6. `parseHex('red') → throw` (format invalide).
|
||||
7. `parseHex('#FFF') → throw` (hex court non supporte).
|
||||
8. `parseHex('#abcdef')` et `parseHex('#ABCDEF')` → meme resultat (tolere la casse).
|
||||
|
||||
### Vitest — `SiteSelector.spec.ts`
|
||||
|
||||
1. `Rendu : 3 sites rendus, bloc du site courant a opacity-100`.
|
||||
2. `Bloc inactif a opacity-40 et aria-pressed="false"`.
|
||||
3. `Clic sur un bloc inactif appelle switchSite avec le bon site`.
|
||||
4. `Si switchSite throw, l'UI affiche toujours l'ancien site courant` (via rollback).
|
||||
5. `Texte d'un site avec couleur claire (#FFFFFF) est rendu noir`.
|
||||
6. `Texte d'un site avec couleur foncee (#056CF2) est rendu blanc`.
|
||||
|
||||
### Tests PHPUnit
|
||||
|
||||
Pas de nouveau test backend dans ce ticket — le ticket 2 couvre deja l'endpoint `/api/me/current-site`. Si un comportement nouveau est introduit cote serveur (ce qui ne devrait pas arriver), ajouter les tests en consequence.
|
||||
|
||||
### Test visuel manuel
|
||||
|
||||
- `make dev-nuxt` (port 3004).
|
||||
- Login `admin` / `admin` → selecteur avec 3 blocs (Chatellerault actif, Saint-Jean et Pommevic a 40%).
|
||||
- Clic sur `Pommevic` → Pommevic devient actif (100%), Chatellerault passe a 40%, toast "Site courant change".
|
||||
- F5 → site actif persiste (Pommevic).
|
||||
- Logout puis re-login → Pommevic toujours actif.
|
||||
- Login `bob` / `bob` → un seul bloc (Saint-Jean), affiche par coherence (cf. regle metier "afficher meme pour 1 site").
|
||||
- Retirer tous les sites a `alice` via `/admin/users` → login alice → selecteur absent.
|
||||
- Desactiver `SitesModule::class` dans `config/modules.php`, restart backend, refresh front → selecteur absent, layout identique au comportement d'avant ce ticket.
|
||||
|
||||
## 11. Risques et points d'attention
|
||||
|
||||
### Risque 1 — Signature de `MalioSiteSelector` inconnue au moment de la spec
|
||||
|
||||
La version de `@malio/layer-ui` installee localement (1.3.0) ne contient pas `MalioSiteSelector`. La spec decrit le contrat attendu (props `sites`, `current-site-id`, event `switch`), mais la signature reelle est definie par la lib et peut differer (nom du prop, structure de l'event, slots disponibles, gestion du contraste texte).
|
||||
|
||||
**Mitigation** : apres `npm install` de la nouvelle version, consulter `node_modules/@malio/layer-ui/COMPONENTS.md` ou le fichier Vue du composant, adapter `SiteSelector.vue` (wrapper) sans toucher au composable `useCurrentSite()`. Le wrapper est le seul point d'adherence a l'API externe.
|
||||
|
||||
### Risque 2 — Flash au premier paint
|
||||
|
||||
Si `showSiteSelector` est `false` le temps de resoudre `/api/modules`, l'user voit le layout sans selecteur puis avec → flash desagreable. La solution est de bloquer le rendu sur `loaded.value` du composable modules dans le middleware `auth.global.ts` avant que le layout ne soit instancie.
|
||||
|
||||
A verifier apres implementation : ouvrir le devtools "Network throttling" en Slow 3G, login, observer. Si flash : ajouter une garde d'attente avant de rendre le layout ou utiliser un skeleton.
|
||||
|
||||
### Risque 3 — `auth.user` muté directement
|
||||
|
||||
Le composable `switchSite` mute `auth.user.currentSite = site` pour propager le changement au store auth. Pinia autorise cette mutation mais elle contourne les actions formelles. Alternative plus propre : ajouter une action `auth.setCurrentSite(site)` et l'appeler. Choix pragmatique dans cette spec → privilegier la mutation directe pour rester aligne sur le pattern existant (`auth.user.currentSite` est une propriete simple) ; si un reviewer prefere l'action formelle, c'est un changement localisé sans impact autre.
|
||||
|
||||
### Risque 4 — Composable singleton et tests
|
||||
|
||||
Les refs `currentSite`, `availableSites`, `switching` sont declarees au niveau module → partagees entre tous les appels a `useCurrentSite()`. En Vitest, cela fuit entre tests si on ne fait pas un `beforeEach(() => resetCurrentSite())`. A documenter en tete du fichier de tests pour eviter des bugs inter-tests.
|
||||
|
||||
### Risque 5 — Contraste texte et faux positifs
|
||||
|
||||
Le seuil de 0.5 sur la luminance peut donner des rendus sous-optimaux sur des couleurs "limite" (ex: vert emeraude `#10B981` a une luminance qui balance pres du seuil). Si un reviewer trouve le texte peu lisible en usage reel, deux options :
|
||||
- Raffiner le calcul : passer a la formule de contraste WCAG complete (ratio entre fond et texte, seuil a 4.5:1).
|
||||
- Contraindre la couleur a l'entree : ajouter une validation back (ticket 4 ?) qui rejette les couleurs trop claires si le texte noir donne < 4.5:1 de contraste.
|
||||
|
||||
Pour ce ticket, le seuil 0.5 suffit (fixtures testees : `#056CF2` bleu sombre → blanc, `#F59E0B` ambre clair → noir, `#10B981` vert → a voir ; l'admin peut toujours eviter les couleurs pales).
|
||||
|
||||
### Risque 6 — Debordement responsive avec 4+ sites
|
||||
|
||||
`flex-1` + `min-w-[200px]` + `overflow-x-auto` sur le conteneur gere le debordement de maniere acceptable. Mais sur ecran tres etroit (tablette portrait 768px) avec 4 sites a 200px chacun, le user doit scroller horizontalement — experience sous-optimale.
|
||||
|
||||
Alternative : `flex-wrap` + `h-auto` pour laisser les blocs passer a la ligne → le header n'est plus a hauteur fixe 72px. Compromis a trancher selon les usages reels. Ce ticket implemente la solution scroll car la contrainte Figma est "barre de 72px" ; relecture de cette contrainte au ticket 4 si besoin.
|
||||
|
||||
### Risque 7 — Auto-selection du currentSite au login si null
|
||||
|
||||
Le ticket mentionne : "si currentSite est null et user a ≥1 site, le backend doit avoir auto-selectionne le premier (ou a defaut, faire le switch cote frontend au premier mount du selecteur)".
|
||||
|
||||
Le ticket 2 **ne fait pas** d'auto-selection cote backend. Il faut donc gerer cote front : au mount du selecteur, si `currentSite === null && availableSites.length > 0`, appeler `switchSite(availableSites[0])` automatiquement. Cela genere un PATCH au premier chargement d'un user nouvellement rattache — acceptable.
|
||||
|
||||
**Alternative** : faire l'auto-selection cote backend au ticket 2. Si cette alternative est choisie en amont, retirer ce comportement cote front. A clarifier au sprint planning.
|
||||
|
||||
### Risque 8 — Conflit avec le scroll principal
|
||||
|
||||
Le selecteur est dans `flex-1 flex flex-col` au-dessus de `<main>`. `<main>` a `overflow-y-auto` qui permet son propre scroll. Le selecteur est en dehors du `overflow-y-auto` du `<main>` → il reste fige au top quand on scrolle le contenu. Verifier qu'il n'y a pas de collision avec le `sticky top-0 h-8` deja present dans `<main>` (ligne 19-21 de `default.vue`), qui sert de "gradient de lecture" sur le contenu.
|
||||
|
||||
## 12. Ordre d'exécution recommandé
|
||||
|
||||
1. **Upgrade Malio** — `npm install @malio/layer-ui@<version>`, verifier `node_modules/@malio/layer-ui/COMPONENTS.md` pour la signature de `MalioSiteSelector`.
|
||||
2. **Utilitaire couleur** — creer `frontend/shared/utils/color.ts` et ses tests. Isole et rapide a valider.
|
||||
3. **Types** — mettre a jour `frontend/shared/types/user-data.ts` et verifier que `frontend/shared/types/sites.ts` existe (sinon le creer).
|
||||
4. **Composable modules** — creer `useModules()` et ses tests.
|
||||
5. **Composable current site** — creer `useCurrentSite()` et ses tests.
|
||||
6. **Middleware** — brancher `loadModules()` dans `auth.global.ts`.
|
||||
7. **Composant SiteSelector** — creer `SiteSelector.vue`, implementer wrapper autour de `MalioSiteSelector`, gerer contraste texte.
|
||||
8. **Tests composant** — smoke test Vitest sur `SiteSelector.vue`.
|
||||
9. **Integration layout** — modifier `frontend/app/layouts/default.vue`, brancher `showSiteSelector`.
|
||||
10. **Logout reset** — ajouter `useCurrentSite().resetCurrentSite()` et `useModules().resetModules()` dans `frontend/modules/core/pages/logout.vue`.
|
||||
11. **i18n** — completer `frontend/i18n/locales/fr.json`.
|
||||
12. **Test visuel** — `make dev-nuxt`, scenarios section 10 "Test visuel manuel".
|
||||
13. **Nuxt-lint** — `make nuxt-lint`.
|
||||
14. **Vitest full run** — `make nuxt-test`, s'assurer que 100% des tests passent.
|
||||
|
||||
## 13. Critères d'acceptation (DoD)
|
||||
|
||||
- [ ] `@malio/layer-ui` upgrade vers la version contenant `MalioSiteSelector`. `package-lock.json` committe.
|
||||
- [ ] Layer `frontend/modules/sites/` contient bien les dossiers `components/` et `composables/` (layer deja initialise au ticket 2 pour la page admin).
|
||||
- [ ] `SiteSelector.vue` : hauteur `h-[72px]`, blocs `flex-1 min-w-[200px]`, text uppercase Inter Bold 24, fond = `site.color`, opacity 100% sur actif / 40% sur inactifs, hover 70% + cursor pointer.
|
||||
- [ ] Contraste texte calcule dynamiquement : `#FFFFFF` → noir, `#056CF2` → blanc, `#F59E0B` → noir (tests Vitest verts).
|
||||
- [ ] Chaque bloc est un `<button type="button">` avec `aria-pressed` et `aria-label` i18n, focus visible, navigation Tab/Enter fonctionnelle.
|
||||
- [ ] Integre dans `layouts/default.vue`, rendu conditionnel `isModuleActive('sites') && user.sites.length > 0`.
|
||||
- [ ] Clic sur un bloc inactif → PATCH `/api/me/current-site` via `useApi`, optimistic update, toast succes.
|
||||
- [ ] Erreur PATCH → rollback du `currentSite`, toast d'erreur (celui de `useApi` par defaut).
|
||||
- [ ] Switch persistant : F5 conserve le nouveau site actif.
|
||||
- [ ] Desactiver `SitesModule::class` dans `config/modules.php` → selecteur absent, layout identique a avant ce ticket.
|
||||
- [ ] User avec 0 site → selecteur absent (pas de "barre vide").
|
||||
- [ ] User avec 1 site → selecteur present (1 bloc unique, bloc actif).
|
||||
- [ ] User avec 4+ sites → scroll horizontal fonctionne, pas de debordement casse a 1280px.
|
||||
- [ ] `useCurrentSite().resetCurrentSite()` et `useModules().resetModules()` appeles au logout.
|
||||
- [ ] `make nuxt-lint` propre.
|
||||
- [ ] `make nuxt-test` passe tous les tests (existants + 4 nouveaux suites).
|
||||
- [ ] `make dev-nuxt` : aucun warning ni erreur console lors du switch et des cycles login/logout.
|
||||
531
docs/sites/ticket-04-spec.md
Normal file
531
docs/sites/ticket-04-spec.md
Normal file
@@ -0,0 +1,531 @@
|
||||
# Ticket #04 — 4/4 — Outillage opt-in « site-scoped » pour modules métier
|
||||
|
||||
## 1. Objectif
|
||||
|
||||
Ce ticket livre l'outillage qui permettra aux modules metier (Commercial, Stock, Production, etc.) de declarer leurs entites comme **scopees par site** : une fois l'adoption effectuee, un utilisateur ne verra en lecture que les lignes dont `site_id` correspond a son site courant, et les creations/editions injectent automatiquement ce site courant si le payload ne le precise pas.
|
||||
|
||||
Le ticket est volontairement **strictement infrastructurel** : il n'adopte le pattern sur aucune entite existante. Aucun module metier n'est modifie, aucune migration n'est jouee sur des tables deja en place. Les tickets futurs (ou des tickets annexes par module) adopteront l'interface au cas par cas apres arbitrage metier.
|
||||
|
||||
Le ticket livre aussi une documentation developpeur (`docs/modules/site-aware.md`) qui explique comment et quand adopter le pattern, et quelles entites **ne doivent pas** l'adopter (roles, permissions, users, catalogues globaux, etc.).
|
||||
|
||||
## 2. Périmètre
|
||||
|
||||
### IN
|
||||
|
||||
- Creer le contrat `App\Shared\Domain\Contract\SiteAwareInterface` : interface minimale `getSite(): ?Site` / `setSite(Site $site): void`, place dans `Shared/Domain/Contract/` pour que les modules metier en dependent **sans** importer le module Sites.
|
||||
- Creer `CurrentSiteProvider` (module Sites, couche Application) qui resout le site courant a partir de `Security::getUser()` + `User::getCurrentSite()`, et renvoie `null` si : pas d'user authentifie, `currentSite` null, **ou** module Sites inactif dans `config/modules.php`.
|
||||
- Creer `SiteScopedQueryExtension` (module Sites, Infrastructure API Platform) implementant `QueryCollectionExtensionInterface` et `QueryItemExtensionInterface` : ajoute la clause `WHERE <alias>.site = :currentSite` quand la resource cible implemente `SiteAwareInterface`, le provider retourne un site, et l'user n'a pas `sites.bypass_scope`.
|
||||
- Creer `SiteAwareInjectionProcessor` (module Sites, decorator de `api_platform.doctrine.orm.state.persist_processor`) : avant de deleguer la persistance, si `$data` est une instance de `SiteAwareInterface` et n'a pas deja de site positionne, injecte le `currentSite` fourni par le provider.
|
||||
- Declarer la permission `sites.bypass_scope` dans `SitesModule::permissions()`. Admin ou user avec cette permission → le filtre Query Extension saute, visibilite globale.
|
||||
- Ecrire `docs/modules/site-aware.md` : guide developpeur complet (cf. section 10).
|
||||
- Tests PHPUnit avec une entite fictive `FakeSiteAwareEntity` declaree uniquement dans la suite de tests (jamais en production) pour prouver que le filtrage et l'injection automatique fonctionnent bout en bout.
|
||||
- Tests du cas "Sites desactive" : desactiver `SitesModule::class` dans `config/modules.php` avant la suite, re-sync, verifier que l'outillage est no-op et qu'aucun test existant ne casse.
|
||||
|
||||
### OUT
|
||||
|
||||
- Adoption du pattern sur une entite metier reelle (ex: `Supplier`, `Client`, etc.) : **hors scope**. C'est aux tickets annexes ou aux tickets de feature de l'adopter quand necessaire, en suivant la doc.
|
||||
- Migration de donnees "legacy" : ce ticket documente le piege (entites existantes sans `site_id`) mais ne livre aucune migration par module.
|
||||
- Support CLI / commandes console : le filtre est uniquement actif dans le contexte API Platform (via les extensions). Une commande batch lira toutes les lignes sans filtre, comportement attendu pour les taches admin. Une eventuelle reimplementation via un Doctrine SQL Filter generique est citee en alternative non retenue (cf. Risque 4).
|
||||
- Double-ecriture avec un Doctrine `SQLFilter` : non retenu dans ce ticket. Le filtre via extension API Platform couvre 100% des usages HTTP, qui est le seul contexte ou le site courant a un sens metier (user authentifie). Les commandes CLI doivent gerer la portee explicitement.
|
||||
- Changement du comportement cote front : aucun. Le filtrage est transparent, le front continue de faire `GET /api/suppliers` et recoit une collection pre-filtree. Si une entite est adoptee au ticket futur, la page existante continue de fonctionner sans modification.
|
||||
- Support d'entites "partiellement site-aware" (colonne site_id nullable, certaines lignes globales partagees) : non retenu. Une entite est soit SiteAware, soit globale. Si un module a besoin de la semantique hybride, il devra creer deux entites distinctes.
|
||||
|
||||
## 3. Fichiers à créer
|
||||
|
||||
### Shared — Contrat
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/src/Shared/Domain/Contract/SiteAwareInterface.php` : interface minimale. Depends uniquement du type `App\Module\Sites\Domain\Entity\Site`, qui est deja couple cote Core depuis le ticket 2 — le placement dans Shared n'introduit pas de nouvelle dependance transversale non souhaitee.
|
||||
|
||||
### Module Sites — Application
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/src/Module/Sites/Application/Service/CurrentSiteProvider.php` : service injecte partout ou le site courant doit etre lu (extensions, processor, futurs voters). Gere les trois cas de retour `null` : pas d'user, `currentSite` null, module desactive.
|
||||
|
||||
### Module Sites — Infrastructure
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/src/Module/Sites/Infrastructure/ApiPlatform/Extension/SiteScopedQueryExtension.php` : une seule classe, implementant a la fois `QueryCollectionExtensionInterface` et `QueryItemExtensionInterface`. Le comportement est identique pour les deux, modulo que l'item manque retourne 404 (API Platform converti un `getOneOrNullResult` null en 404).
|
||||
- `/home/m-tristan/workspace/Coltura/src/Module/Sites/Infrastructure/ApiPlatform/State/Processor/SiteAwareInjectionProcessor.php` : decorator sur le persist processor Doctrine. Injecte le site courant sur `$data` si applicable, puis delegue a `$persistProcessor`.
|
||||
|
||||
### Documentation
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/docs/modules/site-aware.md` : guide developpeur (cf. contenu section 10).
|
||||
|
||||
### Tests
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/tests/Module/Sites/Infrastructure/ApiPlatform/Extension/SiteScopedQueryExtensionTest.php` : tests d'integration (`KernelTestCase`) avec l'entite `FakeSiteAwareEntity` (declaree uniquement dans le dossier de tests). Verifie :
|
||||
- Le filtre s'applique sur une resource `SiteAware` quand le provider retourne un site.
|
||||
- Le filtre est no-op si `SiteAware` mais provider null.
|
||||
- Le filtre est no-op si resource non `SiteAware`.
|
||||
- Le filtre est no-op si user a `sites.bypass_scope`.
|
||||
- `totalItems` Hydra reflete bien le filtrage.
|
||||
- `/home/m-tristan/workspace/Coltura/tests/Module/Sites/Infrastructure/ApiPlatform/State/Processor/SiteAwareInjectionProcessorTest.php` : tests unitaires (`TestCase` pur) avec mocks. Verifie :
|
||||
- `$data` SiteAware sans site → injection du site courant.
|
||||
- `$data` SiteAware avec site deja positionne → pas d'overwrite.
|
||||
- `$data` non-SiteAware → delegation directe sans modification.
|
||||
- Provider retourne null (module off ou user sans site) ET `$data` SiteAware sans site → BadRequestHttpException (400) "aucun site selectionne".
|
||||
- `/home/m-tristan/workspace/Coltura/tests/Module/Sites/Application/Service/CurrentSiteProviderTest.php` : tests unitaires `TestCase`. Couvre :
|
||||
- User authentifie avec currentSite → retourne le Site.
|
||||
- User authentifie sans currentSite → null.
|
||||
- Pas d'user → null.
|
||||
- Module desactive dans config/modules.php de test → null meme si user.currentSite existe.
|
||||
- `/home/m-tristan/workspace/Coltura/tests/Fixtures/SiteAware/FakeSiteAwareEntity.php` : entite Doctrine minimale (`id`, `name`, `site`) utilisee **uniquement** en tests. Mapping Doctrine declare via un `#[ORM\Entity]` mais la table n'existe jamais en prod car la fixture n'est jamais chargee hors tests. **Alternative** : utiliser un schema DB dedie au dossier de tests, cree a la volee par un helper setUp. A trancher a l'implementation.
|
||||
|
||||
## 4. Fichiers à modifier
|
||||
|
||||
- `/home/m-tristan/workspace/Coltura/src/Module/Sites/SitesModule.php` : ajouter la permission `sites.bypass_scope` dans `permissions()` :
|
||||
```php
|
||||
['code' => 'sites.bypass_scope', 'label' => 'Voir les donnees site-scoped de tous les sites (bypass du filtrage)'],
|
||||
```
|
||||
**Note importante** : la methode `permissions()` signale l'existence de la permission mais c'est la commande `app:sync-permissions` (inchangee) qui la positionne en base.
|
||||
- `/home/m-tristan/workspace/Coltura/config/services.yaml` : aucun changement requis. `SiteScopedQueryExtension`, `SiteAwareInjectionProcessor` et `CurrentSiteProvider` sont autoconfigures via les `_defaults` du module. Le decorator du persist processor est declare via `#[AsDecorator]` ou via tag (cf. section 8).
|
||||
- `/home/m-tristan/workspace/Coltura/phpunit.dist.xml` : aucune modification requise si la config des fixtures de tests est autonome. Si `FakeSiteAwareEntity` necessite un mapping dedie, l'option la plus propre est un `doctrine.yaml.test` ajoute via `when@test`, sans polluer la config dev/prod (cf. Risque 3).
|
||||
|
||||
## 5. Contrat `SiteAwareInterface`
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Shared\Domain\Contract;
|
||||
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
|
||||
/**
|
||||
* Contrat opt-in pour les entites dont la visibilite est scopee par site.
|
||||
*
|
||||
* Une entite implementant cette interface sera :
|
||||
* - filtree en lecture par SiteScopedQueryExtension (collection + item)
|
||||
* selon le site courant de l'utilisateur authentifie ;
|
||||
* - alimentee automatiquement en POST/PATCH par SiteAwareInjectionProcessor
|
||||
* si le payload ne precise pas de site.
|
||||
*
|
||||
* L'implementation concrete doit :
|
||||
* - Declarer une relation ManyToOne(Site::class) avec colonne `site_id` NOT NULL.
|
||||
* - Indexer `site_id` en base (sinon le filtre WHERE genere un full-scan).
|
||||
*
|
||||
* Ne PAS implementer cette interface pour :
|
||||
* - Des entites globales (catalogue partage, roles, permissions, users).
|
||||
* - Des entites dont le scope est "par tenant" plus large que le site
|
||||
* (utiliser TenantAwareInterface le cas echeant).
|
||||
* - Des entites transversales references par plusieurs sites.
|
||||
*
|
||||
* Voir `docs/modules/site-aware.md` pour le guide d'adoption complet.
|
||||
*/
|
||||
interface SiteAwareInterface
|
||||
{
|
||||
public function getSite(): ?Site;
|
||||
|
||||
public function setSite(Site $site): void;
|
||||
}
|
||||
```
|
||||
|
||||
### Remarque sur le typage du getter
|
||||
|
||||
`getSite(): ?Site` retourne nullable pour deux raisons :
|
||||
- Coherence avec des entites en cours de construction (pre-persist, avant injection).
|
||||
- Compat avec des colonnes qui deviendraient nullable lors d'une migration progressive (ex: deploiement en 2 etapes avec backfill).
|
||||
|
||||
En regime nominal, apres persistance, `getSite()` ne doit jamais etre null. Un `assert($entity->getSite() !== null)` dans du code sensible est acceptable.
|
||||
|
||||
## 6. Service `CurrentSiteProvider`
|
||||
|
||||
### Responsabilite
|
||||
|
||||
Expose **une seule** methode `get(): ?Site`. Resout le site courant selon la chaine :
|
||||
1. Si `SitesModule::class` n'est pas present dans `config/modules.php` → `null`.
|
||||
2. Sinon, si `Security::getUser()` est null → `null`.
|
||||
3. Sinon, si `$user->getCurrentSite()` est null → `null`.
|
||||
4. Sinon → retourne le Site.
|
||||
|
||||
### Detection d'activation du module
|
||||
|
||||
Deux strategies possibles :
|
||||
|
||||
**Strategie A — lire `config/modules.php` au boot du service** (pattern `ModulesProvider`) :
|
||||
```php
|
||||
public function __construct(
|
||||
private readonly Security $security,
|
||||
#[Autowire(param: 'kernel.project_dir')]
|
||||
string $projectDir,
|
||||
) {
|
||||
$moduleClasses = require $projectDir.'/config/modules.php';
|
||||
$this->sitesActive = in_array(SitesModule::class, $moduleClasses, true);
|
||||
}
|
||||
```
|
||||
|
||||
**Strategie B — extraire un service `ActiveModulesRegistry`** partage entre `ModulesProvider` et `CurrentSiteProvider` (refactor mineur).
|
||||
|
||||
**Recommandation** : strategie A dans ce ticket pour rester minimal. Si un troisieme consommateur apparait (probable), extraire le registry dans un ticket dedie.
|
||||
|
||||
### Contrat complet
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Module\Sites\Application\Service;
|
||||
|
||||
use App\Module\Core\Domain\Entity\User;
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use App\Module\Sites\SitesModule;
|
||||
use Symfony\Bundle\SecurityBundle\Security;
|
||||
use Symfony\Component\DependencyInjection\Attribute\Autowire;
|
||||
|
||||
final class CurrentSiteProvider
|
||||
{
|
||||
private readonly bool $sitesActive;
|
||||
|
||||
public function __construct(
|
||||
private readonly Security $security,
|
||||
#[Autowire(param: 'kernel.project_dir')]
|
||||
string $projectDir,
|
||||
) {
|
||||
$moduleClasses = require $projectDir.'/config/modules.php';
|
||||
$this->sitesActive = in_array(SitesModule::class, $moduleClasses, true);
|
||||
}
|
||||
|
||||
public function get(): ?Site
|
||||
{
|
||||
if (!$this->sitesActive) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$user = $this->security->getUser();
|
||||
if (!$user instanceof User) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return $user->getCurrentSite();
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 7. Extensions API Platform
|
||||
|
||||
### `SiteScopedQueryExtension`
|
||||
|
||||
Implemente a la fois `QueryCollectionExtensionInterface` et `QueryItemExtensionInterface`. La logique est commune et factorisee dans une methode privee `applyScope()`.
|
||||
|
||||
```php
|
||||
public function applyToCollection(
|
||||
QueryBuilder $queryBuilder,
|
||||
QueryNameGeneratorInterface $queryNameGenerator,
|
||||
string $resourceClass,
|
||||
?Operation $operation = null,
|
||||
array $context = [],
|
||||
): void {
|
||||
$this->applyScope($queryBuilder, $queryNameGenerator, $resourceClass);
|
||||
}
|
||||
|
||||
public function applyToItem(
|
||||
QueryBuilder $queryBuilder,
|
||||
QueryNameGeneratorInterface $queryNameGenerator,
|
||||
string $resourceClass,
|
||||
array $identifiers,
|
||||
?Operation $operation = null,
|
||||
array $context = [],
|
||||
): void {
|
||||
$this->applyScope($queryBuilder, $queryNameGenerator, $resourceClass);
|
||||
}
|
||||
|
||||
private function applyScope(
|
||||
QueryBuilder $queryBuilder,
|
||||
QueryNameGeneratorInterface $queryNameGenerator,
|
||||
string $resourceClass,
|
||||
): void {
|
||||
// 1) Resource SiteAware ?
|
||||
if (!is_subclass_of($resourceClass, SiteAwareInterface::class)) {
|
||||
return;
|
||||
}
|
||||
|
||||
// 2) Bypass admin / permission dediee ?
|
||||
if ($this->security->isGranted('sites.bypass_scope')) {
|
||||
return;
|
||||
}
|
||||
|
||||
// 3) Site courant disponible ?
|
||||
$currentSite = $this->currentSiteProvider->get();
|
||||
if ($currentSite === null) {
|
||||
// Decision assumee : no-op plutot que collection vide (cf. section 11 Risque 1).
|
||||
return;
|
||||
}
|
||||
|
||||
// 4) Applique WHERE site = :currentSite
|
||||
$rootAlias = $queryBuilder->getRootAliases()[0];
|
||||
$parameterName = $queryNameGenerator->generateParameterName('currentSite');
|
||||
$queryBuilder
|
||||
->andWhere(sprintf('%s.site = :%s', $rootAlias, $parameterName))
|
||||
->setParameter($parameterName, $currentSite);
|
||||
}
|
||||
```
|
||||
|
||||
### Ordre de priorite
|
||||
|
||||
L'extension doit s'executer **apres** les filtres natifs API Platform (Pagination, Order, Search). Priorite par defaut (0) convient, mais si un autre filtre custom est ajoute plus tard, verifier qu'il ne court-circuite pas. Declarer la priorite explicitement via `#[AsTaggedItem(priority: -100)]` est une option pour s'executer en dernier et etre robuste a l'ordre d'ajout d'autres extensions.
|
||||
|
||||
### JSON-LD `totalItems`
|
||||
|
||||
API Platform execute un `COUNT(*)` separe pour produire le `totalItems` dans la reponse Hydra. Ce count passe par les memes extensions → le totalItems reflete automatiquement le filtrage. A verifier par un test dedie (cf. section 11).
|
||||
|
||||
### `applyToItem` et 404
|
||||
|
||||
Quand un GET `/api/suppliers/{id}` cible un supplier qui existe en base mais appartient a un autre site, la requete `SELECT ... WHERE id = :id AND site = :currentSite` retourne `null` → API Platform converti en 404. Comportement desire : l'user ne doit pas pouvoir distinguer "cet item n'existe pas" de "cet item existe mais pas dans mon site" (anti-enumeration).
|
||||
|
||||
## 8. Processor d'injection automatique `SiteAwareInjectionProcessor`
|
||||
|
||||
### Pattern decorator
|
||||
|
||||
Le plus propre en API Platform est de decorer le processor de persistance Doctrine :
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Module\Sites\Infrastructure\ApiPlatform\State\Processor;
|
||||
|
||||
use ApiPlatform\Metadata\Operation;
|
||||
use ApiPlatform\State\ProcessorInterface;
|
||||
use App\Module\Sites\Application\Service\CurrentSiteProvider;
|
||||
use App\Shared\Domain\Contract\SiteAwareInterface;
|
||||
use Symfony\Component\DependencyInjection\Attribute\AsDecorator;
|
||||
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
|
||||
|
||||
#[AsDecorator('api_platform.doctrine.orm.state.persist_processor')]
|
||||
final class SiteAwareInjectionProcessor implements ProcessorInterface
|
||||
{
|
||||
public function __construct(
|
||||
private readonly ProcessorInterface $inner,
|
||||
private readonly CurrentSiteProvider $currentSiteProvider,
|
||||
) {}
|
||||
|
||||
public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = []): mixed
|
||||
{
|
||||
if ($data instanceof SiteAwareInterface && $data->getSite() === null) {
|
||||
$currentSite = $this->currentSiteProvider->get();
|
||||
|
||||
if ($currentSite === null) {
|
||||
throw new BadRequestHttpException(
|
||||
'Impossible de creer l\'enregistrement : aucun site selectionne.',
|
||||
);
|
||||
}
|
||||
|
||||
$data->setSite($currentSite);
|
||||
}
|
||||
|
||||
return $this->inner->process($data, $operation, $uriVariables, $context);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Effets de bord et compatibilite
|
||||
|
||||
- **S'applique a TOUS les processors qui heritent du persist processor natif API Platform**. Si un processor custom (ex: `UserRbacProcessor`) delegue a `api_platform.doctrine.orm.state.persist_processor` via autowire, il passe aussi par ce decorator — transparent pour User (non SiteAware).
|
||||
- **N'ecrase jamais un site deja positionne** : un admin qui POST un supplier avec `site: '/api/sites/2'` garde cette valeur, meme si son `currentSite` est 1. La regle metier "site different autorise uniquement si l'user a plusieurs sites" du ticket n'est **pas** implementee dans ce decorator : c'est au voter de securite (hors scope de ce ticket) de l'enforcer si necessaire.
|
||||
- **Erreur explicite si pas de site** : BadRequestHttpException plutot qu'un `null` silencieux. Le user comprend que l'operation necessite un site actif.
|
||||
|
||||
### Alternative rejetee — EventListener Doctrine `prePersist`
|
||||
|
||||
Un listener Doctrine intercepterait toutes les persistances, y compris hors HTTP (CLI, fixtures). **Rejetee** car :
|
||||
- `CurrentSiteProvider` depend de `Security`, indisponible en CLI.
|
||||
- Les fixtures doivent positionner explicitement le site (cf. `AppFixtures` ticket 2), ce qui est plus correct metier.
|
||||
- Les commandes batch peuvent vouloir creer des entites sans site actif (backoffice multi-sites) — un listener silencieux les bloquerait.
|
||||
|
||||
Le decorator HTTP-only est plus aligne avec le principe "opt-in controle".
|
||||
|
||||
## 9. Permission `sites.bypass_scope`
|
||||
|
||||
### Déclaration
|
||||
|
||||
Dans `SitesModule::permissions()` :
|
||||
|
||||
```php
|
||||
public static function permissions(): array
|
||||
{
|
||||
return [
|
||||
['code' => 'sites.view', 'label' => 'Voir les sites'],
|
||||
['code' => 'sites.manage', 'label' => 'Gerer les sites (creer, editer, supprimer)'],
|
||||
['code' => 'sites.bypass_scope', 'label' => 'Voir les donnees site-scoped de tous les sites (bypass du filtrage)'],
|
||||
];
|
||||
}
|
||||
```
|
||||
|
||||
### Semantique
|
||||
|
||||
- User avec `sites.bypass_scope` → le filtre `WHERE site = :currentSite` n'est pas applique. La collection retournee est **globale** (toutes les lignes).
|
||||
- User **admin** (`isAdmin = true`) → `is_granted()` retourne toujours true pour toute permission → le bypass est automatique. Pas besoin d'assignation explicite.
|
||||
- Cas typique d'attribution : un admin financier qui veut consolider les suppliers a l'echelle groupe.
|
||||
|
||||
### Absence de bypass sur le processor
|
||||
|
||||
Le processor d'injection ne respecte **pas** `sites.bypass_scope` : meme un user avec bypass verra son `currentSite` injecte si le payload n'en precise pas. Justification : l'injection n'est pas une restriction, c'est un default value. Le user bypass peut toujours envoyer un site explicite different.
|
||||
|
||||
## 10. Documentation développeur — `docs/modules/site-aware.md`
|
||||
|
||||
Le fichier livre **5 sections** :
|
||||
|
||||
### 10.1 Quand adopter `SiteAwareInterface`
|
||||
|
||||
- Entite qui existe "par site" : chaque ligne appartient a un et un seul site, les users ne doivent voir que celles de leur site courant.
|
||||
- Exemples : `Supplier` (chaque site a ses fournisseurs), `Order`, `StockEntry`, `Employee` (si chaque site a sa propre equipe).
|
||||
|
||||
### 10.2 Quand NE PAS adopter
|
||||
|
||||
- Entites globales : `Role`, `Permission`, `User` (les users sont transverses, rattaches a plusieurs sites).
|
||||
- Catalogues partages : produits, categories, taxes — s'ils sont mutualises entre sites.
|
||||
- Entites transversales : `Invoice` globale, `Contract` multi-site.
|
||||
- Entites dont la portee naturelle est "par tenant" plus large que "par site" : utiliser `TenantAwareInterface` (si pertinent pour le projet multi-tenant futur).
|
||||
|
||||
### 10.3 Comment adopter (check-list)
|
||||
|
||||
1. **Entite** :
|
||||
- Implementer `App\Shared\Domain\Contract\SiteAwareInterface`.
|
||||
- Ajouter la relation `#[ORM\ManyToOne(targetEntity: Site::class)] #[ORM\JoinColumn(name: 'site_id', nullable: false, onDelete: 'CASCADE')] private Site $site`.
|
||||
- Implementer `getSite()` et `setSite()`.
|
||||
2. **Migration** :
|
||||
- Creer une migration dediee au module concerne (ou racine si init critique, voir `CLAUDE.md`).
|
||||
- `ALTER TABLE <table> ADD COLUMN site_id INT NOT NULL`.
|
||||
- **Gestion legacy** : si des lignes existent deja, la colonne ne peut pas etre NOT NULL directement. Strategie :
|
||||
1. Ajouter la colonne nullable.
|
||||
2. Backfill manuel ou par script (ex: tout rattacher au site "Chatellerault" par defaut, ou laisser l'admin arbitrer).
|
||||
3. Rendre la colonne NOT NULL via une seconde migration.
|
||||
- **Index** : `CREATE INDEX IDX_<table>_site ON <table> (site_id)`. **Obligatoire** — le filtre `WHERE site_id = ?` genere un full-scan sinon.
|
||||
3. **Serialisation** : ajouter `site` au groupe de lecture API (`#[Groups(['<resource>:read'])]`) pour que le front voie a quel site appartient la ligne.
|
||||
4. **Processor custom** : si le module a deja un processor sur l'operation POST/PATCH, s'assurer qu'il delegue a `api_platform.doctrine.orm.state.persist_processor` (et non `ObjectManager::persist` direct) pour que le decorator d'injection s'applique.
|
||||
|
||||
### 10.4 Comportement en mode degrade
|
||||
|
||||
- **Module Sites desactive** (`config/modules.php`) : `CurrentSiteProvider::get()` retourne `null` → le filtre ne s'applique plus → toutes les lignes sont visibles, comme avant l'adoption. L'app reste fonctionnelle, juste sans segmentation. **Mais** : la colonne `site_id` NOT NULL reste en place, et le processor d'injection leve une 400 sur tout POST/PATCH sans site explicite. Consequence : **un module adopte ne peut pas vivre sans Sites active** pour les operations d'ecriture, sauf a envoyer systematiquement un `site` explicite dans le payload. A documenter **fortement**.
|
||||
- **User sans site** (sites.length = 0, currentSite = null) : meme comportement → no-op en lecture, 400 en ecriture. Le module doit documenter l'UX degradee.
|
||||
|
||||
### 10.5 Gotchas et anti-patterns
|
||||
|
||||
- **Sous-collections** (`/api/clients/{id}/contacts`) : l'extension s'applique a la resource chargee, ici `Contact`. Si `Contact` est SiteAware, le filtre passe. Si seul `Client` est SiteAware (et Contact herite du scope via son parent), **le filtre ne se propage pas automatiquement** : il faut soit rendre Contact SiteAware aussi (redondance), soit ajouter un filtre custom qui verifie `contact.client.site == currentSite`. Ce ticket ne couvre pas le second cas.
|
||||
- **Jointures** : si un repository custom fait une requete sans passer par API Platform (ex: `findByX()` appele depuis un processor), le filtre ne s'applique pas. Responsabilite du developpeur du module d'ajouter `->andWhere('x.site = :currentSite')` manuellement ou de passer par le `CurrentSiteProvider`.
|
||||
- **Tests d'integration** : les tests existants d'un module adopte devront soit logger un user avec un site actif, soit utiliser `sites.bypass_scope` pour voir toute la donnee. La suite de fixtures devra positionner un site coherent sur les entites de test.
|
||||
- **Cascade delete d'un site** : le ticket 2 met `user.current_site_id` a NULL si le site est supprime. Si une entite adoptee declare `onDelete: CASCADE` sur sa FK site, elle perdra toutes ses lignes au delete d'un site. Choisir explicitement : cascade (aligne sur l'invariant "une ligne SiteAware a toujours un site") ou blocage (empecher la suppression d'un site s'il reste des lignes adoptees).
|
||||
|
||||
## 11. Risques et points d'attention
|
||||
|
||||
### Risque 1 — Comportement "no-op si pas de site courant"
|
||||
|
||||
La spec choisit **no-op plutot que collection vide** quand `CurrentSiteProvider::get() === null`. Arbitrage :
|
||||
|
||||
- **No-op** (retenu) : un user sans site voit tout, un admin sans site aussi. Risque de fuite de donnees d'un site a l'autre, mais l'app reste utilisable.
|
||||
- **Collection vide** : un user sans site ne voit rien. Plus strict, mais bloque un admin qui consulterait l'app avant d'avoir configure un site.
|
||||
|
||||
Le ticket retient **no-op** car l'app reste utilisable. La permission `sites.bypass_scope` est explicite pour les admins qui veulent voir tout. Si la decision metier evolue, le changement est localise dans `SiteScopedQueryExtension::applyScope()`.
|
||||
|
||||
### Risque 2 — Fuite de donnees entre sites
|
||||
|
||||
Si un module adopte `SiteAwareInterface` mais qu'un repository custom court-circuite API Platform, le filtre ne s'applique pas. Consequence : un endpoint custom (`GET /api/suppliers/top-rated`) pourrait exposer tous les suppliers sans filtrage.
|
||||
|
||||
**Mitigation** : la doc insiste sur la responsabilite du developpeur d'adopter le filtre manuellement dans les repositories custom. Un test d'integration par module adopte est **fortement recommande**.
|
||||
|
||||
### Risque 3 — `FakeSiteAwareEntity` en tests
|
||||
|
||||
L'entite fictive doit etre mappee par Doctrine pour que le QueryBuilder fonctionne. Trois options :
|
||||
|
||||
1. **Declaration via `when@test`** : ajouter `config/packages/doctrine.yaml` dans un bloc `when@test` avec un mapping dedie pointant vers `tests/Fixtures/SiteAware/`. Propre mais ajoute un fichier de config.
|
||||
2. **Attribute Doctrine dans le fichier de test** : fonctionne si le kernel de test decouvre le namespace. Pas elegant.
|
||||
3. **Mock integral du QueryBuilder** : pas d'entite reelle, on mock Doctrine. Tests plus unitaires mais moins realistes.
|
||||
|
||||
**Recommandation** : option 1 (mapping `when@test`). La classe reste dans `tests/` et ne pollue jamais la prod.
|
||||
|
||||
### Risque 4 — Pas de Doctrine SQL Filter
|
||||
|
||||
Un Doctrine `SQLFilter` appliquerait le filtrage a **toutes** les requetes Doctrine, y compris hors API Platform (CLI, fixtures, cron, reports). Plus defensif mais plus risque :
|
||||
|
||||
- Les commandes batch devraient l'activer/desactiver explicitement.
|
||||
- Les fixtures devraient le desactiver pour seeder plusieurs sites.
|
||||
- Les tests d'integration devraient le gerer.
|
||||
|
||||
Le ticket retient la strategie **API Platform only** car le site courant n'a de sens que dans un contexte HTTP authentifie. Si un besoin emerge (rapport automatique scope par site, webhook multi-site, etc.), le refactor vers un SQL filter sera localise.
|
||||
|
||||
### Risque 5 — Priorite des extensions
|
||||
|
||||
Si un autre module introduit plus tard une extension avec une clause `HAVING` ou un `setMaxResults` qui suppose que le filtre de base n'est pas modifie, il peut y avoir des surprises. Declarer explicitement une priorite negative (`priority: -100`) sur `SiteScopedQueryExtension` via `#[AsTaggedItem]` la fait s'executer apres la plupart des filtres natifs, ce qui est generalement souhaitable pour un filtre applicatif.
|
||||
|
||||
### Risque 6 — `UserRbacProcessor` et les autres processors custom
|
||||
|
||||
Le decorator `SiteAwareInjectionProcessor` decore `api_platform.doctrine.orm.state.persist_processor`. Si un module declare un processor custom qui **ne delegue pas** au persist processor (ex: fait `$em->persist($data); $em->flush()` directement), l'injection de site n'a **pas** lieu. Le module doit explicitement passer par le persist processor pour beneficier du pattern.
|
||||
|
||||
A mitiger par un test qui genere une entite `FakeSiteAwareEntity` via un POST `api_platform.doctrine.orm.state.persist_processor` mocke et verifie que le decorator a bien injecte le site.
|
||||
|
||||
### Risque 7 — Performance du `require` au boot
|
||||
|
||||
`CurrentSiteProvider` fait un `require 'config/modules.php'` au constructeur. Le fichier est un simple `return [...]` → l'overhead est minimal et le resultat est opcache par PHP. Meme pattern que `ModulesProvider`, sans regression perf documentee.
|
||||
|
||||
### Risque 8 — Doc developpeur en francais vs anglais
|
||||
|
||||
Le fichier `docs/modules/site-aware.md` s'adresse aux developpeurs de Coltura. Il est redige en **francais**, aligne sur la convention projet (CLAUDE.md : "commentaires en francais, code en anglais"). Aucun extrait de code ne doit etre traduit, seules les explications.
|
||||
|
||||
## 12. Plan de tests
|
||||
|
||||
### Tests unitaires (`TestCase` pur)
|
||||
|
||||
#### `CurrentSiteProviderTest`
|
||||
|
||||
1. `testReturnsNullIfSitesModuleInactive` : config/modules.php de test ne contient pas SitesModule → null meme si user + site fixent.
|
||||
2. `testReturnsNullIfNoUser` : Security::getUser() = null → null.
|
||||
3. `testReturnsNullIfUserHasNoCurrentSite` : user.currentSite = null → null.
|
||||
4. `testReturnsSiteIfAllConditionsMet` : user + currentSite set → retourne le Site.
|
||||
|
||||
#### `SiteAwareInjectionProcessorTest`
|
||||
|
||||
1. `testInjectsCurrentSiteOnNewSiteAwareData` : $data SiteAware + getSite() = null + provider retourne Site → setSite appele avec le bon site.
|
||||
2. `testDoesNotOverrideExistingSite` : $data SiteAware + getSite() non-null → pas d'appel a setSite, delegation directe.
|
||||
3. `testSkipsNonSiteAwareData` : $data qui n'implemente pas SiteAwareInterface → aucune modification, delegation.
|
||||
4. `testThrowsBadRequestIfNoCurrentSite` : $data SiteAware + getSite() = null + provider retourne null → BadRequestHttpException 400.
|
||||
5. `testDelegatesToInnerAlways` : inner->process est appele dans tous les cas (sauf quand 400 throw).
|
||||
|
||||
### Tests d'intégration (`KernelTestCase`)
|
||||
|
||||
#### `SiteScopedQueryExtensionTest`
|
||||
|
||||
Fixture : 2 sites (siteA, siteB), 3 FakeSiteAwareEntity (2 sur siteA, 1 sur siteB), 1 user rattache a siteA.
|
||||
|
||||
1. `testCollectionFilteredByCurrentSite` : user avec currentSite=siteA → collection retourne 2 entites (celles de siteA).
|
||||
2. `testCollectionNotFilteredIfNoCurrentSite` : user sans currentSite → collection retourne 3 entites (no-op).
|
||||
3. `testCollectionNotFilteredIfResourceNotSiteAware` : query sur une entite non SiteAware → aucune clause additionnelle.
|
||||
4. `testCollectionNotFilteredIfBypassPermission` : user avec `sites.bypass_scope` → 3 entites.
|
||||
5. `testCollectionNotFilteredIfSitesModuleInactive` : desactiver SitesModule → provider null → no-op, 3 entites.
|
||||
6. `testItemNotFoundIfWrongSite` : GET sur un id dont le site est siteB alors que user sur siteA → 404 (ou `null` retourne par le QueryBuilder).
|
||||
7. `testItemFoundIfCorrectSite` : GET sur un id du site courant → 200.
|
||||
8. `testTotalItemsReflectsFilter` : collection Hydra `totalItems: 2` (et non 3) quand le filtre s'applique.
|
||||
|
||||
### Tests de non-régression
|
||||
|
||||
Apres implementation, **re-jouer toute la suite existante** en mode module Sites active et en mode module desactive. Aucun test existant ne doit changer.
|
||||
|
||||
## 13. Ordre d'exécution recommandé
|
||||
|
||||
1. **Contrat** — `SiteAwareInterface` dans `Shared/Domain/Contract/`.
|
||||
2. **Provider** — `CurrentSiteProvider` + tests unitaires.
|
||||
3. **Processor decorator** — `SiteAwareInjectionProcessor` + tests unitaires avec mocks.
|
||||
4. **Entite de test** — `FakeSiteAwareEntity` + mapping `when@test` si retenu.
|
||||
5. **Query extension** — `SiteScopedQueryExtension` + tests d'integration.
|
||||
6. **Permission bypass** — ajout dans `SitesModule::permissions()`, `make sync-permissions`, verifier en base.
|
||||
7. **Tests exhaustifs** — faire passer la matrice des 8 cas d'integration.
|
||||
8. **Tests non-regression** — `make test` avec SitesModule actif puis inactif.
|
||||
9. **Documentation** — rediger `docs/modules/site-aware.md` (5 sections).
|
||||
10. **CS fixer** — `make php-cs-fixer-allow-risky`.
|
||||
11. **DoD** — valider la check-list section 14.
|
||||
|
||||
## 14. Critères d'acceptation (DoD)
|
||||
|
||||
- [ ] `App\Shared\Domain\Contract\SiteAwareInterface` existe avec les deux methodes `getSite(): ?Site` et `setSite(Site $site): void`.
|
||||
- [ ] `CurrentSiteProvider::get()` retourne `null` dans les 3 cas : pas d'user, pas de currentSite, module inactif. Retourne le Site sinon.
|
||||
- [ ] `SiteScopedQueryExtension` applique le WHERE sur les resources SiteAware quand un site courant est resolu et que l'user n'a pas `sites.bypass_scope`.
|
||||
- [ ] `SiteAwareInjectionProcessor` injecte automatiquement le site courant sur POST/PATCH d'entites SiteAware sans site explicite.
|
||||
- [ ] `SiteAwareInjectionProcessor` leve une 400 si l'entite SiteAware n'a pas de site ET que le provider retourne null.
|
||||
- [ ] Permission `sites.bypass_scope` declaree dans `SitesModule::permissions()` et presente en base apres `app:sync-permissions`.
|
||||
- [ ] `docs/modules/site-aware.md` livre les 5 sections (quand/comment adopter, anti-patterns, degrade, gotchas).
|
||||
- [ ] Tests d'integration : au moins 8 cas couvrant filtrage collection/item, no-op dans les 3 scenarios (pas de site, resource non SiteAware, bypass), et `totalItems` Hydra.
|
||||
- [ ] Tests unitaires sur `CurrentSiteProvider` et `SiteAwareInjectionProcessor`.
|
||||
- [ ] Aucune migration sur des tables metier existantes (`supplier`, `client`, `user`, ...) — seules les migrations du ticket 1 et 2 sont presentes. Verifier via `make migration-migrate` : aucun SQL attendu sur la suite existante.
|
||||
- [ ] `make test` passe avec `SitesModule::class` actif dans `config/modules.php`.
|
||||
- [ ] `make test` passe avec `SitesModule::class` desactive dans `config/modules.php`.
|
||||
- [ ] `make php-cs-fixer-allow-risky` propre sur les fichiers nouveaux.
|
||||
- [ ] Aucun module metier (Commercial, Core hors User, etc.) n'a ete modifie par ce ticket — diff ne touche que `src/Shared/`, `src/Module/Sites/`, `tests/`, et `docs/`.
|
||||
@@ -14,6 +14,7 @@
|
||||
</MalioSidebar>
|
||||
|
||||
<div class="h-full flex-1 flex flex-col min-h-0 min-w-0">
|
||||
<SiteSelector v-if="showSiteSelector"/>
|
||||
<main
|
||||
class="flex flex-1 flex-col overflow-y-auto overflow-x-hidden bg-white px-4 pb-24 sm:px-8 lg:px-16">
|
||||
<div
|
||||
@@ -30,8 +31,21 @@
|
||||
const {t} = useI18n()
|
||||
const ui = useUiStore()
|
||||
const {sections} = useSidebar()
|
||||
const {isModuleActive} = useModules()
|
||||
const auth = useAuthStore()
|
||||
const route = useRoute()
|
||||
|
||||
// Le SiteSelector est rendu si :
|
||||
// - le module Sites est actif dans config/modules.php (sinon la feature
|
||||
// n'a pas de sens, cf. ticket 3 spec criteres d'acceptation) ;
|
||||
// - ET l'user connecte a au moins un site autorise (sinon "barre vide"
|
||||
// sans tile cliquable).
|
||||
// Les deux flags sont resolus par le middleware auth.global.ts avant
|
||||
// que le layout ne soit rendu (plan load parallele), donc pas de flash.
|
||||
const showSiteSelector = computed(() =>
|
||||
isModuleActive('sites') && (auth.user?.sites?.length ?? 0) > 0,
|
||||
)
|
||||
|
||||
const translatedSections = computed(() =>
|
||||
sections.value.map(section => ({
|
||||
label: t(section.label),
|
||||
|
||||
@@ -15,9 +15,16 @@ export default defineNuxtRouteMiddleware(async (to) => {
|
||||
}
|
||||
|
||||
if (auth.isAuthenticated) {
|
||||
const { loaded, loadSidebar } = useSidebar()
|
||||
if (!loaded.value) {
|
||||
await loadSidebar()
|
||||
}
|
||||
const { loaded: sidebarLoaded, loadSidebar } = useSidebar()
|
||||
const { loaded: modulesLoaded, loadModules } = useModules()
|
||||
|
||||
// Chargement parallele sidebar + modules actifs : les deux sont
|
||||
// consommes par layouts/default.vue (sidebar pour la nav, modules
|
||||
// pour conditionner le SiteSelector). Charger en parallele evite
|
||||
// le flash au premier paint de la barre.
|
||||
await Promise.all([
|
||||
sidebarLoaded.value ? Promise.resolve() : loadSidebar(),
|
||||
modulesLoaded.value ? Promise.resolve() : loadModules(),
|
||||
])
|
||||
}
|
||||
})
|
||||
|
||||
@@ -25,7 +25,8 @@
|
||||
},
|
||||
"core": {
|
||||
"roles": "Gestion des rôles",
|
||||
"users": "Utilisateurs"
|
||||
"users": "Utilisateurs",
|
||||
"sites": "Sites"
|
||||
}
|
||||
},
|
||||
"dashboard": {
|
||||
@@ -54,6 +55,15 @@
|
||||
"put": "Erreur lors de la mise a jour",
|
||||
"patch": "Erreur lors de la modification",
|
||||
"delete": "Erreur lors de la suppression"
|
||||
},
|
||||
"sites": {
|
||||
"notAuthorized": "Vous n'êtes pas autorisé à sélectionner ce site."
|
||||
}
|
||||
},
|
||||
"sites": {
|
||||
"selector": {
|
||||
"ariaGroupLabel": "Sélecteur de site actif",
|
||||
"switchSuccess": "Site courant changé"
|
||||
}
|
||||
},
|
||||
"success": {
|
||||
@@ -102,7 +112,8 @@
|
||||
"username": "Nom d'utilisateur",
|
||||
"admin": "Administrateur",
|
||||
"roles": "Roles",
|
||||
"directPermissions": "Permissions directes"
|
||||
"directPermissions": "Permissions directes",
|
||||
"sites": "Sites"
|
||||
},
|
||||
"drawer": {
|
||||
"title": "Permissions de {username}",
|
||||
@@ -110,6 +121,7 @@
|
||||
"adminToggle": "Administrateur (bypass total)",
|
||||
"rolesSection": "Rôles",
|
||||
"directPermissionsSection": "Permissions directes",
|
||||
"sitesSection": "Sites autorisés",
|
||||
"summarySection": "Résumé des permissions effectives",
|
||||
"noEffectivePermissions": "Aucune permission effective",
|
||||
"sourceRole": "via {role}",
|
||||
@@ -119,6 +131,39 @@
|
||||
"toast": {
|
||||
"updated": "Permissions mises à jour avec succès"
|
||||
}
|
||||
},
|
||||
"sites": {
|
||||
"title": "Gestion des sites",
|
||||
"newSite": "Nouveau site",
|
||||
"editSite": "Modifier le site",
|
||||
"createSite": "Créer un site",
|
||||
"noSites": "Aucun site configuré",
|
||||
"table": {
|
||||
"name": "Nom",
|
||||
"city": "Ville",
|
||||
"postalCode": "Code postal",
|
||||
"color": "Couleur",
|
||||
"fullAddress": "Adresse complète"
|
||||
},
|
||||
"form": {
|
||||
"name": "Nom",
|
||||
"street": "Rue",
|
||||
"complement": "Complément d'adresse",
|
||||
"complementPlaceholder": "Bâtiment, escalier, BP... (optionnel)",
|
||||
"postalCode": "Code postal",
|
||||
"city": "Ville",
|
||||
"color": "Couleur (format #RRGGBB)",
|
||||
"colorInvalid": "Format attendu : #RRGGBB (6 caractères hexadécimaux)"
|
||||
},
|
||||
"delete": {
|
||||
"title": "Supprimer le site",
|
||||
"message": "Êtes-vous sûr de vouloir supprimer le site \"{name}\" ? Cette action est irréversible et retirera ce site à tous les utilisateurs rattachés."
|
||||
},
|
||||
"toast": {
|
||||
"created": "Site créé avec succès",
|
||||
"updated": "Site mis à jour avec succès",
|
||||
"deleted": "Site supprimé avec succès"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -64,6 +64,27 @@
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Section Sites autorises (ticket 2 module Sites) -->
|
||||
<div>
|
||||
<h4 class="mb-3 text-sm font-semibold text-neutral-700">
|
||||
{{ t('admin.users.drawer.sitesSection') }}
|
||||
</h4>
|
||||
<div v-if="allSites.length === 0" class="text-sm text-neutral-400">
|
||||
{{ t('admin.sites.noSites') }}
|
||||
</div>
|
||||
<div class="flex flex-col gap-2">
|
||||
<MalioCheckbox
|
||||
v-for="site in allSites"
|
||||
:id="`site-${site.id}`"
|
||||
:key="site.id"
|
||||
:label="site.name"
|
||||
:model-value="selectedSiteIds.has(site.id)"
|
||||
label-class="text-sm text-neutral-600"
|
||||
@update:model-value="(val: boolean) => toggleSite(site.id, val)"
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Section Resume permissions effectives -->
|
||||
<div>
|
||||
<h4 class="mb-3 text-sm font-semibold text-neutral-700">
|
||||
@@ -92,6 +113,7 @@
|
||||
|
||||
<script setup lang="ts">
|
||||
import type { Permission, Role, UserListItem, EffectivePermission } from '~/shared/types/rbac'
|
||||
import type { Site } from '~/shared/types/sites'
|
||||
|
||||
interface PermissionModule {
|
||||
module: string
|
||||
@@ -115,10 +137,12 @@ const emit = defineEmits<{
|
||||
const saving = ref(false)
|
||||
const allRoles = ref<Role[]>([])
|
||||
const allPermissions = ref<Permission[]>([])
|
||||
const allSites = ref<Site[]>([])
|
||||
|
||||
const form = ref({ isAdmin: false })
|
||||
const selectedRoleIds = ref(new Set<number>())
|
||||
const selectedDirectPermissionIds = ref(new Set<number>())
|
||||
const selectedSiteIds = ref(new Set<number>())
|
||||
|
||||
// Detecter l'auto-edition
|
||||
const isSelfEdit = computed(() => props.user?.id === auth.user?.id)
|
||||
@@ -182,14 +206,17 @@ const effectivePermissions = computed<EffectivePermission[]>(() => {
|
||||
.sort((a, b) => a.code.localeCompare(b.code))
|
||||
})
|
||||
|
||||
// Charger roles et permissions
|
||||
// Charger roles, permissions et sites en parallele pour minimiser le TTFB
|
||||
// a l'ouverture du drawer.
|
||||
async function loadData() {
|
||||
const [rolesData, permsData] = await Promise.all([
|
||||
const [rolesData, permsData, sitesData] = await Promise.all([
|
||||
api.get<{ member: Role[] }>('/roles', {}, { toast: false }),
|
||||
api.get<{ member: Permission[] }>('/permissions', { orphan: false, itemsPerPage: 999 }, { toast: false }),
|
||||
api.get<{ member: Site[] }>('/sites', { itemsPerPage: 999 }, { toast: false }),
|
||||
])
|
||||
allRoles.value = rolesData.member
|
||||
allPermissions.value = permsData.member
|
||||
allSites.value = sitesData.member
|
||||
}
|
||||
|
||||
// Remplir le formulaire quand le user change
|
||||
@@ -198,10 +225,12 @@ watch(() => props.user, (user) => {
|
||||
form.value.isAdmin = user.isAdmin
|
||||
selectedRoleIds.value = new Set(user.roles.map(iriToId))
|
||||
selectedDirectPermissionIds.value = new Set(user.directPermissions.map(iriToId))
|
||||
selectedSiteIds.value = new Set((user.sites ?? []).map(iriToId))
|
||||
} else {
|
||||
form.value.isAdmin = false
|
||||
selectedRoleIds.value = new Set()
|
||||
selectedDirectPermissionIds.value = new Set()
|
||||
selectedSiteIds.value = new Set()
|
||||
}
|
||||
}, { immediate: true })
|
||||
|
||||
@@ -235,6 +264,13 @@ function handleToggleAll(module: string, selected: boolean) {
|
||||
selectedDirectPermissionIds.value = ids
|
||||
}
|
||||
|
||||
function toggleSite(id: number, selected: boolean) {
|
||||
const ids = new Set(selectedSiteIds.value)
|
||||
if (selected) ids.add(id)
|
||||
else ids.delete(id)
|
||||
selectedSiteIds.value = ids
|
||||
}
|
||||
|
||||
async function handleSave() {
|
||||
if (!props.user) return
|
||||
saving.value = true
|
||||
@@ -243,6 +279,7 @@ async function handleSave() {
|
||||
isAdmin: form.value.isAdmin,
|
||||
roles: Array.from(selectedRoleIds.value).map(id => `/api/roles/${id}`),
|
||||
directPermissions: Array.from(selectedDirectPermissionIds.value).map(id => `/api/permissions/${id}`),
|
||||
sites: Array.from(selectedSiteIds.value).map(id => `/api/sites/${id}`),
|
||||
}, {
|
||||
toastSuccessMessage: t('admin.users.toast.updated'),
|
||||
})
|
||||
|
||||
@@ -14,16 +14,68 @@
|
||||
/>
|
||||
</div>
|
||||
|
||||
<!-- Table des roles -->
|
||||
<!-- Table des roles avec filtres + pagination -->
|
||||
<MalioDataTable
|
||||
v-model:page="page"
|
||||
v-model:per-page="perPage"
|
||||
class="mt-6"
|
||||
:columns="columns"
|
||||
:items="roleItems"
|
||||
:total-items="roles.length"
|
||||
:total-items="totalItems"
|
||||
:row-clickable="canManage"
|
||||
:empty-message="t('admin.roles.noRoles')"
|
||||
@row-click="onRowClick"
|
||||
>
|
||||
<template #header-label>
|
||||
<input
|
||||
v-model="filters.label"
|
||||
type="text"
|
||||
:placeholder="t('admin.roles.table.label')"
|
||||
class="w-full border-0 border-b border-black bg-transparent px-0 py-1 text-xl outline-none"
|
||||
>
|
||||
</template>
|
||||
<template #header-code>
|
||||
<input
|
||||
v-model="filters.code"
|
||||
type="text"
|
||||
:placeholder="t('admin.roles.table.code')"
|
||||
class="w-full border-0 border-b border-black bg-transparent px-0 py-1 text-xl outline-none"
|
||||
>
|
||||
</template>
|
||||
<template #header-permissions>
|
||||
<select
|
||||
v-model="filters['permissions.code']"
|
||||
class="w-full appearance-none border-0 border-b border-black bg-transparent px-0 py-1 text-xl outline-none"
|
||||
>
|
||||
<option value="">
|
||||
{{ t('admin.roles.table.permissions') }}
|
||||
</option>
|
||||
<option
|
||||
v-for="perm in allPermissions"
|
||||
:key="perm.id"
|
||||
:value="perm.code"
|
||||
>
|
||||
{{ perm.label }}
|
||||
</option>
|
||||
</select>
|
||||
</template>
|
||||
<template #header-system>
|
||||
<select
|
||||
v-model="filters.isSystem"
|
||||
class="w-full appearance-none border-0 border-b border-black bg-transparent px-0 py-1 text-xl outline-none"
|
||||
>
|
||||
<option value="">
|
||||
{{ t('admin.roles.table.system') }}
|
||||
</option>
|
||||
<option value="true">
|
||||
{{ t('common.yes') }}
|
||||
</option>
|
||||
<option value="false">
|
||||
{{ t('common.no') }}
|
||||
</option>
|
||||
</select>
|
||||
</template>
|
||||
|
||||
<template #cell-code="{ item }">
|
||||
<span class="font-mono text-xs">{{ item.code }}</span>
|
||||
</template>
|
||||
@@ -59,7 +111,7 @@
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
import type { Role } from '~/shared/types/rbac'
|
||||
import type { Permission, Role } from '~/shared/types/rbac'
|
||||
|
||||
const { t } = useI18n()
|
||||
const api = useApi()
|
||||
@@ -68,8 +120,42 @@ const canManage = computed(() => can('core.roles.manage'))
|
||||
|
||||
useHead({ title: t('admin.roles.title') })
|
||||
|
||||
const roles = ref<Role[]>([])
|
||||
const loading = ref(false)
|
||||
// Etat DataTable centralise : pagination serveur + filtres debounces.
|
||||
// `isSystem` est une string ('true'/'false'/'') plutot qu'un bool : les
|
||||
// <select> HTML travaillent en string et API Platform BooleanFilter
|
||||
// accepte les strings 'true'/'false' telles quelles.
|
||||
const {
|
||||
items,
|
||||
totalItems,
|
||||
page,
|
||||
perPage,
|
||||
filters,
|
||||
reload,
|
||||
} = useDataTableServerState<Role>('/roles', {
|
||||
label: '',
|
||||
code: '',
|
||||
isSystem: '',
|
||||
'permissions.code': '',
|
||||
})
|
||||
|
||||
// Chargement one-shot des permissions pour alimenter le select filter.
|
||||
// Independant du composable de table : cette liste ne bouge pas pendant
|
||||
// la session admin.
|
||||
const allPermissions = ref<Permission[]>([])
|
||||
|
||||
async function loadPermissions(): Promise<void> {
|
||||
const data = await api.get<{ member: Permission[] }>(
|
||||
'/permissions',
|
||||
{ itemsPerPage: 999, orphan: false },
|
||||
{ toast: false },
|
||||
)
|
||||
// Tri par label pour coherence avec l'affichage du <option> : l'user
|
||||
// lit le label (ex: "Gerer les roles et permissions"), donc l'ordre
|
||||
// alphabetique doit etre base sur ce qu'il voit, pas sur le code.
|
||||
allPermissions.value = (data.member ?? []).sort(
|
||||
(a, b) => a.label.localeCompare(b.label),
|
||||
)
|
||||
}
|
||||
|
||||
const columns = [
|
||||
{ key: 'label', label: t('admin.roles.table.label') },
|
||||
@@ -80,45 +166,31 @@ const columns = [
|
||||
|
||||
// Transformer les roles en items compatibles MalioDataTable
|
||||
const roleItems = computed(() =>
|
||||
roles.value.map(role => ({
|
||||
items.value.map(role => ({
|
||||
id: role.id,
|
||||
label: role.label,
|
||||
code: role.code,
|
||||
permissions: role.permissions.length,
|
||||
isSystem: role.isSystem,
|
||||
system: '', // colonne geree par le slot
|
||||
}))
|
||||
})),
|
||||
)
|
||||
|
||||
function getRoleById(id: number): Role | undefined {
|
||||
return roles.value.find(r => r.id === id)
|
||||
return items.value.find(r => r.id === id)
|
||||
}
|
||||
|
||||
function onRowClick(item: Record<string, unknown>) {
|
||||
const role = getRoleById(item.id as number)
|
||||
if (role) openEditDrawer(role)
|
||||
}
|
||||
|
||||
const drawerOpen = ref(false)
|
||||
const selectedRole = ref<Role | null>(null)
|
||||
const deleteModalOpen = ref(false)
|
||||
const roleToDelete = ref<Role | null>(null)
|
||||
const deleting = ref(false)
|
||||
|
||||
// Charger la liste des roles
|
||||
async function loadRoles() {
|
||||
loading.value = true
|
||||
try {
|
||||
const data = await api.get<{ member: Role[] }>(
|
||||
'/roles',
|
||||
{},
|
||||
{ toast: false },
|
||||
)
|
||||
roles.value = data.member
|
||||
} finally {
|
||||
loading.value = false
|
||||
}
|
||||
}
|
||||
|
||||
function openCreateDrawer() {
|
||||
selectedRole.value = null
|
||||
drawerOpen.value = true
|
||||
@@ -145,17 +217,18 @@ async function handleDelete() {
|
||||
deleteModalOpen.value = false
|
||||
roleToDelete.value = null
|
||||
drawerOpen.value = false
|
||||
await loadRoles()
|
||||
reload()
|
||||
} finally {
|
||||
deleting.value = false
|
||||
}
|
||||
}
|
||||
|
||||
function onRoleSaved() {
|
||||
loadRoles()
|
||||
reload()
|
||||
}
|
||||
|
||||
onMounted(() => {
|
||||
loadRoles()
|
||||
loadPermissions()
|
||||
reload()
|
||||
})
|
||||
</script>
|
||||
|
||||
@@ -7,16 +7,77 @@
|
||||
</h1>
|
||||
</div>
|
||||
|
||||
<!-- Table des utilisateurs -->
|
||||
<!-- Table des utilisateurs avec filtres + pagination -->
|
||||
<MalioDataTable
|
||||
v-model:page="page"
|
||||
v-model:per-page="perPage"
|
||||
class="mt-6"
|
||||
:columns="columns"
|
||||
:items="userItems"
|
||||
:total-items="users.length"
|
||||
:total-items="totalItems"
|
||||
:row-clickable="canManage"
|
||||
:empty-message="t('admin.users.noUsers')"
|
||||
@row-click="onRowClick"
|
||||
>
|
||||
<template #header-username>
|
||||
<input
|
||||
v-model="filters.username"
|
||||
type="text"
|
||||
:placeholder="t('admin.users.table.username')"
|
||||
class="w-full border-0 border-b border-black bg-transparent px-0 py-1 text-xl outline-none"
|
||||
>
|
||||
</template>
|
||||
<template #header-admin>
|
||||
<select
|
||||
v-model="filters.isAdmin"
|
||||
class="w-full appearance-none border-0 border-b border-black bg-transparent px-0 py-1 text-xl outline-none"
|
||||
>
|
||||
<option value="">
|
||||
{{ t('admin.users.table.admin') }}
|
||||
</option>
|
||||
<option value="true">
|
||||
{{ t('common.yes') }}
|
||||
</option>
|
||||
<option value="false">
|
||||
{{ t('common.no') }}
|
||||
</option>
|
||||
</select>
|
||||
</template>
|
||||
<template #header-roles>
|
||||
<select
|
||||
v-model="filters['rbacRoles.code']"
|
||||
class="w-full appearance-none border-0 border-b border-black bg-transparent px-0 py-1 text-xl outline-none"
|
||||
>
|
||||
<option value="">
|
||||
{{ t('admin.users.table.roles') }}
|
||||
</option>
|
||||
<option
|
||||
v-for="role in allRoles"
|
||||
:key="role.id"
|
||||
:value="role.code"
|
||||
>
|
||||
{{ role.label }}
|
||||
</option>
|
||||
</select>
|
||||
</template>
|
||||
<template v-if="sitesModuleActive" #header-sites>
|
||||
<select
|
||||
v-model="filters['sites.name']"
|
||||
class="w-full appearance-none border-0 border-b border-black bg-transparent px-0 py-1 text-xl outline-none"
|
||||
>
|
||||
<option value="">
|
||||
{{ t('admin.users.table.sites') }}
|
||||
</option>
|
||||
<option
|
||||
v-for="site in allSites"
|
||||
:key="site.id"
|
||||
:value="site.name"
|
||||
>
|
||||
{{ site.name }}
|
||||
</option>
|
||||
</select>
|
||||
</template>
|
||||
|
||||
<template #cell-admin="{ item }">
|
||||
<span
|
||||
v-if="item.admin"
|
||||
@@ -37,54 +98,105 @@
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
import type { UserListItem } from '~/shared/types/rbac'
|
||||
import type { Role, UserListItem } from '~/shared/types/rbac'
|
||||
import type { Site } from '~/shared/types/sites'
|
||||
|
||||
const { t } = useI18n()
|
||||
const api = useApi()
|
||||
const { can } = usePermissions()
|
||||
const { isModuleActive } = useModules()
|
||||
|
||||
useHead({ title: t('admin.users.title') })
|
||||
|
||||
const canManage = computed(() => can('core.users.manage'))
|
||||
// Conditionne la colonne Sites + le filtre Sites : si le module Sites
|
||||
// est desactive, inutile de charger /api/sites ni d'afficher ces elements.
|
||||
// L'invariant "module inactif = app fonctionnelle" est preserve.
|
||||
const sitesModuleActive = computed(() => isModuleActive('sites'))
|
||||
|
||||
const users = ref<UserListItem[]>([])
|
||||
const loading = ref(false)
|
||||
const drawerOpen = ref(false)
|
||||
const selectedUser = ref<UserListItem | null>(null)
|
||||
// Etat DataTable centralise. On declare le filtre sites.name meme si le
|
||||
// module Sites est inactif : le composable omet les filtres a valeur
|
||||
// vide donc ca ne produit aucun impact cote API, et ca evite de casser
|
||||
// la forme du state si le module est reactive sans reloader la page.
|
||||
const {
|
||||
items,
|
||||
totalItems,
|
||||
page,
|
||||
perPage,
|
||||
filters,
|
||||
reload,
|
||||
} = useDataTableServerState<UserListItem>('/users', {
|
||||
username: '',
|
||||
isAdmin: '',
|
||||
'rbacRoles.code': '',
|
||||
'sites.name': '',
|
||||
})
|
||||
|
||||
const columns = [
|
||||
{ key: 'username', label: t('admin.users.table.username') },
|
||||
{ key: 'admin', label: t('admin.users.table.admin') },
|
||||
{ key: 'roles', label: t('admin.users.table.roles') },
|
||||
{ key: 'directPermissions', label: t('admin.users.table.directPermissions') },
|
||||
]
|
||||
const allRoles = ref<Role[]>([])
|
||||
const allSites = ref<Site[]>([])
|
||||
const sitesById = ref(new Map<number, Site>())
|
||||
|
||||
async function loadFilterOptions(): Promise<void> {
|
||||
const rolesPromise = api.get<{ member: Role[] }>(
|
||||
'/roles',
|
||||
{ itemsPerPage: 999 },
|
||||
{ toast: false },
|
||||
)
|
||||
|
||||
// /api/sites est protege par `sites.view`. On skip si module off pour
|
||||
// eviter un 403 inutile dans la console devtools — la UI ne consomme
|
||||
// pas le resultat dans ce cas.
|
||||
const sitesPromise = sitesModuleActive.value
|
||||
? api.get<{ member: Site[] }>('/sites', { itemsPerPage: 999 }, { toast: false })
|
||||
: Promise.resolve({ member: [] as Site[] })
|
||||
|
||||
const [rolesData, sitesData] = await Promise.all([rolesPromise, sitesPromise])
|
||||
allRoles.value = rolesData.member ?? []
|
||||
allSites.value = sitesData.member ?? []
|
||||
sitesById.value = new Map(allSites.value.map(s => [s.id, s]))
|
||||
}
|
||||
|
||||
// Colonnes dynamiques : on omet la colonne Sites si le module est off.
|
||||
const columns = computed(() => {
|
||||
const base = [
|
||||
{ key: 'username', label: t('admin.users.table.username') },
|
||||
{ key: 'admin', label: t('admin.users.table.admin') },
|
||||
{ key: 'roles', label: t('admin.users.table.roles') },
|
||||
{ key: 'directPermissions', label: t('admin.users.table.directPermissions') },
|
||||
]
|
||||
if (sitesModuleActive.value) {
|
||||
base.push({ key: 'sites', label: t('admin.users.table.sites') })
|
||||
}
|
||||
return base
|
||||
})
|
||||
|
||||
// Extraire l'id numerique depuis une IRI API Platform type `/api/sites/3`.
|
||||
function iriToId(iri: string): number {
|
||||
return Number(iri.split('/').pop())
|
||||
}
|
||||
|
||||
const userItems = computed(() =>
|
||||
users.value.map(user => ({
|
||||
items.value.map(user => ({
|
||||
id: user.id,
|
||||
username: user.username,
|
||||
admin: user.isAdmin,
|
||||
roles: user.roles.length,
|
||||
directPermissions: user.directPermissions.length,
|
||||
}))
|
||||
// Affichage : liste des noms de sites separes par virgule. Les IRIs
|
||||
// du payload /api/users (groupe user:list) sont resolues via la Map
|
||||
// construite par loadFilterOptions. Vide si module Sites off.
|
||||
sites: (user.sites ?? [])
|
||||
.map(iri => sitesById.value.get(iriToId(iri))?.name)
|
||||
.filter((name): name is string => Boolean(name))
|
||||
.join(', '),
|
||||
})),
|
||||
)
|
||||
|
||||
async function loadUsers() {
|
||||
loading.value = true
|
||||
try {
|
||||
const data = await api.get<{ member: UserListItem[] }>(
|
||||
'/users',
|
||||
{},
|
||||
{ toast: false },
|
||||
)
|
||||
users.value = data.member
|
||||
} finally {
|
||||
loading.value = false
|
||||
}
|
||||
}
|
||||
const drawerOpen = ref(false)
|
||||
const selectedUser = ref<UserListItem | null>(null)
|
||||
|
||||
function getUserById(id: number): UserListItem | undefined {
|
||||
return users.value.find(u => u.id === id)
|
||||
return items.value.find(u => u.id === id)
|
||||
}
|
||||
|
||||
function openDrawer(user: UserListItem) {
|
||||
@@ -98,10 +210,11 @@ function onRowClick(item: Record<string, unknown>) {
|
||||
}
|
||||
|
||||
function onUserSaved() {
|
||||
loadUsers()
|
||||
reload()
|
||||
}
|
||||
|
||||
onMounted(() => {
|
||||
loadUsers()
|
||||
loadFilterOptions()
|
||||
reload()
|
||||
})
|
||||
</script>
|
||||
|
||||
@@ -9,10 +9,23 @@ definePageMeta({ layout: 'auth' })
|
||||
|
||||
const auth = useAuthStore()
|
||||
const { resetSidebar } = useSidebar()
|
||||
const { resetModules } = useModules()
|
||||
const { resetCurrentSite } = useCurrentSite()
|
||||
|
||||
onMounted(async () => {
|
||||
await auth.logout()
|
||||
resetSidebar()
|
||||
await navigateTo('/login')
|
||||
try {
|
||||
await auth.logout()
|
||||
} finally {
|
||||
// Les resets sont garantis meme si auth.logout() rejette : eviter
|
||||
// qu'un user suivant (connecte sur le meme onglet) voie l'etat de
|
||||
// l'ancien. Les trois fonctions reset sont synchrones et ne
|
||||
// peuvent pas throw (juste des assignations reactives).
|
||||
// navigateTo est dans le finally pour garantir la redirection
|
||||
// meme si auth.logout() lance une exception (ex: reseau coupé).
|
||||
resetSidebar()
|
||||
resetModules()
|
||||
resetCurrentSite()
|
||||
await navigateTo('/login')
|
||||
}
|
||||
})
|
||||
</script>
|
||||
|
||||
76
frontend/modules/sites/components/SiteDeleteModal.vue
Normal file
76
frontend/modules/sites/components/SiteDeleteModal.vue
Normal file
@@ -0,0 +1,76 @@
|
||||
<template>
|
||||
<Teleport to="body">
|
||||
<Transition name="fade">
|
||||
<div
|
||||
v-if="modelValue"
|
||||
class="fixed inset-0 z-50 flex items-center justify-center bg-black/50"
|
||||
@click.self="cancel"
|
||||
>
|
||||
<div class="w-full max-w-md rounded-lg bg-white p-6 shadow-xl">
|
||||
<h3 class="text-lg font-semibold text-neutral-900">
|
||||
{{ t('admin.sites.delete.title') }}
|
||||
</h3>
|
||||
<p class="mt-3 text-sm text-neutral-600">
|
||||
{{ t('admin.sites.delete.message', { name: siteName }) }}
|
||||
</p>
|
||||
<div class="mt-6 flex justify-end gap-3">
|
||||
<MalioButton
|
||||
:label="t('common.cancel')"
|
||||
variant="secondary"
|
||||
@click="cancel"
|
||||
/>
|
||||
<MalioButton
|
||||
:label="t('common.delete')"
|
||||
variant="danger"
|
||||
icon-name="mdi:delete-outline"
|
||||
icon-position="left"
|
||||
:disabled="loading"
|
||||
@click="confirm"
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</Transition>
|
||||
</Teleport>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
const { t } = useI18n()
|
||||
|
||||
defineProps<{
|
||||
modelValue: boolean
|
||||
siteName: string
|
||||
loading: boolean
|
||||
}>()
|
||||
|
||||
const emit = defineEmits<{
|
||||
'update:modelValue': [value: boolean]
|
||||
confirm: []
|
||||
}>()
|
||||
|
||||
function cancel() {
|
||||
emit('update:modelValue', false)
|
||||
}
|
||||
|
||||
function confirm() {
|
||||
emit('confirm')
|
||||
}
|
||||
|
||||
function onKeydown(e: KeyboardEvent) {
|
||||
if (e.key === 'Escape') cancel()
|
||||
}
|
||||
|
||||
onMounted(() => document.addEventListener('keydown', onKeydown))
|
||||
onUnmounted(() => document.removeEventListener('keydown', onKeydown))
|
||||
</script>
|
||||
|
||||
<style scoped>
|
||||
.fade-enter-active,
|
||||
.fade-leave-active {
|
||||
transition: opacity 0.2s ease;
|
||||
}
|
||||
.fade-enter-from,
|
||||
.fade-leave-to {
|
||||
opacity: 0;
|
||||
}
|
||||
</style>
|
||||
185
frontend/modules/sites/components/SiteDrawer.vue
Normal file
185
frontend/modules/sites/components/SiteDrawer.vue
Normal file
@@ -0,0 +1,185 @@
|
||||
<template>
|
||||
<MalioDrawer
|
||||
:model-value="modelValue"
|
||||
:title="isEditMode ? t('admin.sites.editSite') : t('admin.sites.createSite')"
|
||||
drawer-class="w-full max-w-lg"
|
||||
@update:model-value="emit('update:modelValue', $event)"
|
||||
>
|
||||
<form class="flex flex-col gap-6 p-4" @submit.prevent="handleSave">
|
||||
<MalioInputText
|
||||
v-model="form.name"
|
||||
:label="t('admin.sites.form.name')"
|
||||
input-class="w-full"
|
||||
required
|
||||
/>
|
||||
|
||||
<MalioInputText
|
||||
v-model="form.street"
|
||||
:label="t('admin.sites.form.street')"
|
||||
input-class="w-full"
|
||||
required
|
||||
/>
|
||||
|
||||
<MalioInputText
|
||||
v-model="form.complement"
|
||||
:label="t('admin.sites.form.complement')"
|
||||
:placeholder="t('admin.sites.form.complementPlaceholder')"
|
||||
input-class="w-full"
|
||||
/>
|
||||
|
||||
<!-- Code postal FR : masque "#####" (5 chiffres stricts) +
|
||||
maxLength en double securite. La regex backend validera la
|
||||
forme finale, le masque empeche juste la saisie de
|
||||
caracteres non numeriques. -->
|
||||
<MalioInputText
|
||||
v-model="form.postalCode"
|
||||
:label="t('admin.sites.form.postalCode')"
|
||||
input-class="w-full"
|
||||
mask="#####"
|
||||
max-length="5"
|
||||
required
|
||||
/>
|
||||
|
||||
<MalioInputText
|
||||
v-model="form.city"
|
||||
:label="t('admin.sites.form.city')"
|
||||
input-class="w-full"
|
||||
required
|
||||
/>
|
||||
|
||||
<!-- Champ couleur avec preview puce -->
|
||||
<div>
|
||||
<label class="mb-1 block text-sm font-semibold text-neutral-700">
|
||||
{{ t('admin.sites.form.color') }}
|
||||
</label>
|
||||
<div class="flex items-center gap-3">
|
||||
<MalioInputText
|
||||
v-model="form.color"
|
||||
placeholder="#RRGGBB"
|
||||
input-class="w-full font-mono"
|
||||
required
|
||||
/>
|
||||
<span
|
||||
:style="{ backgroundColor: isValidHex ? form.color : 'transparent' }"
|
||||
class="inline-block size-10 shrink-0 rounded-lg border border-neutral-200"
|
||||
:class="{ 'border-dashed': !isValidHex }"
|
||||
/>
|
||||
</div>
|
||||
<p v-if="form.color && !isValidHex" class="mt-1 text-xs text-red-600">
|
||||
{{ t('admin.sites.form.colorInvalid') }}
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<!-- Boutons -->
|
||||
<div class="flex justify-end gap-3 border-t border-neutral-200 pt-4">
|
||||
<MalioButton
|
||||
v-if="isEditMode"
|
||||
:label="t('common.delete')"
|
||||
variant="danger"
|
||||
icon-name="mdi:delete-outline"
|
||||
icon-position="left"
|
||||
@click="emit('delete')"
|
||||
/>
|
||||
<MalioButton
|
||||
v-else
|
||||
:label="t('common.cancel')"
|
||||
variant="tertiary"
|
||||
@click="emit('update:modelValue', false)"
|
||||
/>
|
||||
<MalioButton
|
||||
:label="t('common.save')"
|
||||
variant="primary"
|
||||
:disabled="saving || !isValidHex"
|
||||
@click="handleSave"
|
||||
/>
|
||||
</div>
|
||||
</form>
|
||||
</MalioDrawer>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
import type { Site } from '~/shared/types/sites'
|
||||
import { isValidSiteColor } from '~/shared/utils/color'
|
||||
|
||||
const { t } = useI18n()
|
||||
const api = useApi()
|
||||
|
||||
const props = defineProps<{
|
||||
modelValue: boolean
|
||||
site: Site | null
|
||||
}>()
|
||||
|
||||
const emit = defineEmits<{
|
||||
'update:modelValue': [value: boolean]
|
||||
saved: []
|
||||
delete: []
|
||||
}>()
|
||||
|
||||
const saving = ref(false)
|
||||
|
||||
const form = ref({
|
||||
name: '',
|
||||
street: '',
|
||||
complement: '',
|
||||
postalCode: '',
|
||||
city: '',
|
||||
color: '#000000',
|
||||
})
|
||||
|
||||
const isEditMode = computed(() => props.site !== null)
|
||||
|
||||
// Validation locale du format hex #RRGGBB avant envoi backend.
|
||||
const isValidHex = computed(() => isValidSiteColor(form.value.color))
|
||||
|
||||
// Remplir le formulaire quand le site change
|
||||
watch(() => props.site, (site) => {
|
||||
if (site) {
|
||||
form.value.name = site.name
|
||||
form.value.street = site.street
|
||||
form.value.complement = site.complement ?? ''
|
||||
form.value.postalCode = site.postalCode
|
||||
form.value.city = site.city
|
||||
form.value.color = site.color
|
||||
} else {
|
||||
form.value.name = ''
|
||||
form.value.street = ''
|
||||
form.value.complement = ''
|
||||
form.value.postalCode = ''
|
||||
form.value.city = ''
|
||||
form.value.color = '#056CF2'
|
||||
}
|
||||
}, { immediate: true })
|
||||
|
||||
async function handleSave() {
|
||||
if (!isValidHex.value) return
|
||||
saving.value = true
|
||||
try {
|
||||
// Le champ complement est optionnel cote DB : on envoie null si vide
|
||||
// pour que le backend stocke NULL plutot qu'une chaine vide.
|
||||
const trimmedComplement = form.value.complement.trim()
|
||||
const payload = {
|
||||
name: form.value.name,
|
||||
street: form.value.street,
|
||||
complement: trimmedComplement === '' ? null : trimmedComplement,
|
||||
postalCode: form.value.postalCode,
|
||||
city: form.value.city,
|
||||
color: form.value.color,
|
||||
}
|
||||
|
||||
if (isEditMode.value && props.site) {
|
||||
await api.patch(`/sites/${props.site.id}`, payload, {
|
||||
toastSuccessMessage: t('admin.sites.toast.updated'),
|
||||
})
|
||||
} else {
|
||||
await api.post('/sites', payload, {
|
||||
toastSuccessMessage: t('admin.sites.toast.created'),
|
||||
})
|
||||
}
|
||||
|
||||
emit('saved')
|
||||
emit('update:modelValue', false)
|
||||
} finally {
|
||||
saving.value = false
|
||||
}
|
||||
}
|
||||
</script>
|
||||
92
frontend/modules/sites/components/SiteSelector.vue
Normal file
92
frontend/modules/sites/components/SiteSelector.vue
Normal file
@@ -0,0 +1,92 @@
|
||||
<template>
|
||||
<MalioSiteSelector
|
||||
:sites="mappedSites"
|
||||
:model-value="currentSite ? String(currentSite.id) : undefined"
|
||||
:group-class="groupClass"
|
||||
:tile-class="tileClass"
|
||||
:label-class="labelClass"
|
||||
:aria-label="t('sites.selector.ariaGroupLabel')"
|
||||
@change="onChange"
|
||||
/>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
const { t } = useI18n()
|
||||
const { currentSite, availableSites, syncFromAuth, switchSite } = useCurrentSite()
|
||||
const auth = useAuthStore()
|
||||
|
||||
// Hydratation initiale + watcher : garde le state aligne sur auth.user
|
||||
// meme si un autre composant modifie auth.user.currentSite (ex: switch
|
||||
// depuis un autre onglet via /api/me/current-site, ou refresh du token).
|
||||
// Le rollback de switchSite restaure AUSSI auth.user.currentSite (voir
|
||||
// useCurrentSite::switchSite) pour eviter tout cycle watchEffect -> sync
|
||||
// qui ecraserait l'etat local apres une erreur PATCH.
|
||||
watchEffect(() => {
|
||||
void auth.user?.currentSite
|
||||
void auth.user?.sites
|
||||
syncFromAuth()
|
||||
})
|
||||
|
||||
// Conversion id number -> string : l'API de MalioSiteSelector (v1.4.0)
|
||||
// travaille en string alors que notre type metier Site utilise un int
|
||||
// (ID Doctrine). On reconvertit dans onChange.
|
||||
const mappedSites = computed(() =>
|
||||
availableSites.value.map(site => ({
|
||||
id: String(site.id),
|
||||
name: site.name,
|
||||
color: site.color,
|
||||
})),
|
||||
)
|
||||
|
||||
// Note de rendu : MalioSiteSelector v1.4.0 utilise UNE SEULE `activeColor`
|
||||
// (couleur du site courant) comme fond pour TOUS les tiles. Les inactifs
|
||||
// sont differencies uniquement par `opacity: 0.4`. Le texte est TOUJOURS
|
||||
// blanc (conforme maquette Figma) — charge aux admins de choisir des
|
||||
// couleurs de site suffisamment foncees pour garantir la lisibilite.
|
||||
// On surcharge `labelClass` uniquement pour imposer la taille 24px
|
||||
// (Figma), le reste des attributs tex (blanc, bold, uppercase, tracking)
|
||||
// vient du default Malio via twMerge.
|
||||
|
||||
// Classes Tailwind passees a MalioSiteSelector via twMerge :
|
||||
// - groupClass : hauteur fixe 72px (spec Figma) + scroll horizontal si
|
||||
// debordement de 4+ sites sur petits ecrans.
|
||||
// - tileClass : largeur minimale pour lisibilite + focus ring WCAG.
|
||||
// - labelClass : taille de texte 24px imposee par la maquette Figma.
|
||||
// Tailwind `text-2xl` = 1.5rem = 24px. Merge avec le default Malio
|
||||
// (`text-white font-bold uppercase tracking-wide`).
|
||||
const groupClass = 'h-[72px] overflow-x-auto'
|
||||
const tileClass = 'min-w-[200px] flex items-center justify-center focus-visible:ring-2 focus-visible:ring-primary-500 focus-visible:ring-offset-2'
|
||||
const labelClass = 'text-2xl'
|
||||
|
||||
async function onChange(site: { id: string; name: string; color: string }): Promise<void> {
|
||||
const target = availableSites.value.find(s => String(s.id) === site.id)
|
||||
if (!target) {
|
||||
// Divergence entre mappedSites et availableSites (peut arriver si
|
||||
// un refresh concurrent a vide la collection). On ignore mais on
|
||||
// trace en dev pour faciliter le debug.
|
||||
if (import.meta.dev) {
|
||||
// Utilise console.error (pas warn) car la convention projet
|
||||
// eslint n'autorise que error (no-console avec allow: ['error']).
|
||||
console.error(`[SiteSelector] Site inconnu emis par MalioSiteSelector : id=${site.id}`)
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// TODO(cross-tab) : si l'utilisateur a change de site dans un autre
|
||||
// onglet, currentSite.value ici peut etre obsolete (state singleton
|
||||
// non synchronise entre onglets). La garde ci-dessous est donc
|
||||
// intentionnellement supprimee pour garantir qu'un clic sur le tile
|
||||
// "actif selon cet onglet" envoie quand meme le PATCH et re-synchronise
|
||||
// l'etat. Amelioration future : ecouter l'evenement `storage` sur la
|
||||
// cle `coltura:site-switch` pour mettre a jour les onglets inactifs
|
||||
// sans clic via auth.fetchUser() / auth.refreshUser().
|
||||
|
||||
try {
|
||||
await switchSite(target)
|
||||
} catch {
|
||||
// L'erreur est deja toastee par useApi ; le composable a rollback
|
||||
// le state local ET le store auth. Rien a faire ici au-dela de
|
||||
// silencer pour eviter une unhandledRejection dans la console.
|
||||
}
|
||||
}
|
||||
</script>
|
||||
189
frontend/modules/sites/components/__tests__/SiteSelector.spec.ts
Normal file
189
frontend/modules/sites/components/__tests__/SiteSelector.spec.ts
Normal file
@@ -0,0 +1,189 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { mount, flushPromises } from '@vue/test-utils'
|
||||
import { computed, defineComponent, h, ref, watchEffect } from 'vue'
|
||||
import type { Site } from '~/shared/types/sites'
|
||||
import { useCurrentSite } from '~/modules/sites/composables/useCurrentSite'
|
||||
import SiteSelector from '../SiteSelector.vue'
|
||||
|
||||
const mockPatch = vi.hoisted(() => vi.fn())
|
||||
const mockAuthUser = vi.hoisted(() => ({
|
||||
value: null as { sites: Site[]; currentSite: Site | null } | null,
|
||||
}))
|
||||
|
||||
// Stubs des auto-imports Nuxt. SiteSelector.vue utilise useCurrentSite,
|
||||
// useAuthStore, useI18n, watchEffect, computed sans import explicite
|
||||
// (pattern Nuxt). En Vitest on les expose comme globals.
|
||||
vi.stubGlobal('useCurrentSite', useCurrentSite)
|
||||
vi.stubGlobal('useApi', () => ({ patch: mockPatch }))
|
||||
vi.stubGlobal('useAuthStore', () => ({
|
||||
get user() {
|
||||
return mockAuthUser.value
|
||||
},
|
||||
setCurrentSite(site: Site | null) {
|
||||
if (mockAuthUser.value) {
|
||||
mockAuthUser.value.currentSite = site
|
||||
}
|
||||
},
|
||||
}))
|
||||
vi.stubGlobal('useI18n', () => ({ t: (key: string) => key }))
|
||||
vi.stubGlobal('watchEffect', watchEffect)
|
||||
vi.stubGlobal('computed', computed)
|
||||
vi.stubGlobal('ref', ref)
|
||||
// useSidebar et refreshNuxtData sont consommes par useCurrentSite apres
|
||||
// un switch reussi — stubs minimaux pour eviter ReferenceError au mount.
|
||||
vi.stubGlobal('useSidebar', () => ({ loadSidebar: vi.fn() }))
|
||||
vi.stubGlobal('refreshNuxtData', vi.fn())
|
||||
|
||||
// Stub de MalioSiteSelector : on se contente de tracker les props recues
|
||||
// et de re-emettre `change` quand on le simule via `trigger`. Evite de
|
||||
// monter la vraie lib Malio (qui aurait besoin de tout Tailwind + twMerge).
|
||||
const MalioSiteSelectorStub = defineComponent({
|
||||
name: 'MalioSiteSelector',
|
||||
props: {
|
||||
sites: { type: Array, required: true },
|
||||
modelValue: { type: String, default: undefined },
|
||||
groupClass: { type: String, default: '' },
|
||||
tileClass: { type: String, default: '' },
|
||||
labelClass: { type: String, default: '' },
|
||||
},
|
||||
emits: ['update:modelValue', 'change'],
|
||||
setup(props, { emit }) {
|
||||
return () => h('div', {
|
||||
'data-testid': 'malio-site-selector',
|
||||
'data-sites-count': String((props.sites as unknown[]).length),
|
||||
'data-active-id': String(props.modelValue ?? ''),
|
||||
'data-label-class': props.labelClass,
|
||||
}, [
|
||||
...(props.sites as Array<{ id: string; name: string; color: string }>).map(site =>
|
||||
h('button', {
|
||||
'data-testid': `tile-${site.id}`,
|
||||
// Emet les deux events comme le vrai MalioSiteSelector
|
||||
// (update:modelValue + change). Le wrapper n'ecoute que
|
||||
// change aujourd'hui, mais tracker les deux grave la
|
||||
// signature et prepare un eventuel v-model futur.
|
||||
onClick: () => {
|
||||
emit('update:modelValue', site.id)
|
||||
emit('change', site)
|
||||
},
|
||||
}, site.name),
|
||||
),
|
||||
])
|
||||
},
|
||||
})
|
||||
|
||||
const SITE_A: Site = {
|
||||
id: 1,
|
||||
name: 'Chatellerault',
|
||||
street: '14 All.',
|
||||
complement: null,
|
||||
postalCode: '86100',
|
||||
city: 'Châtellerault',
|
||||
color: '#056CF2',
|
||||
fullAddress: '14 All.\n86100 Châtellerault',
|
||||
}
|
||||
const SITE_B: Site = {
|
||||
id: 2,
|
||||
name: 'Saint-Jean',
|
||||
street: 'Z i',
|
||||
complement: null,
|
||||
postalCode: '17400',
|
||||
city: 'Fontenet',
|
||||
color: '#F3CB00',
|
||||
fullAddress: 'Z i\n17400 Fontenet',
|
||||
}
|
||||
|
||||
function mountSelector() {
|
||||
return mount(SiteSelector, {
|
||||
global: {
|
||||
stubs: { MalioSiteSelector: MalioSiteSelectorStub },
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
describe('SiteSelector', () => {
|
||||
beforeEach(() => {
|
||||
mockPatch.mockReset()
|
||||
mockAuthUser.value = {
|
||||
sites: [SITE_A, SITE_B],
|
||||
currentSite: SITE_A,
|
||||
}
|
||||
})
|
||||
|
||||
it('rend un tile par site autorise', () => {
|
||||
const wrapper = mountSelector()
|
||||
const stub = wrapper.find('[data-testid="malio-site-selector"]')
|
||||
|
||||
expect(stub.attributes('data-sites-count')).toBe('2')
|
||||
})
|
||||
|
||||
it('marque le site courant via modelValue (string)', () => {
|
||||
const wrapper = mountSelector()
|
||||
const stub = wrapper.find('[data-testid="malio-site-selector"]')
|
||||
|
||||
// Chatellerault id=1 => '1'
|
||||
expect(stub.attributes('data-active-id')).toBe('1')
|
||||
})
|
||||
|
||||
it('passe labelClass="text-2xl" pour forcer 24px conforme Figma', () => {
|
||||
// Decision design : texte blanc par defaut Malio mais taille 24px
|
||||
// imposee par la maquette. Le reste des attributs text (white, bold,
|
||||
// uppercase, tracking-wide) provient du default Malio via twMerge.
|
||||
const wrapper = mountSelector()
|
||||
const stub = wrapper.find('[data-testid="malio-site-selector"]')
|
||||
|
||||
expect(stub.attributes('data-label-class')).toBe('text-2xl')
|
||||
})
|
||||
|
||||
it('clic sur un tile inactif declenche switchSite via PATCH /me/current-site', async () => {
|
||||
mockPatch.mockResolvedValueOnce({})
|
||||
const wrapper = mountSelector()
|
||||
|
||||
await wrapper.find('[data-testid="tile-2"]').trigger('click')
|
||||
await flushPromises()
|
||||
|
||||
expect(mockPatch).toHaveBeenCalledWith(
|
||||
'/me/current-site',
|
||||
{ site: '/api/sites/2' },
|
||||
expect.anything(),
|
||||
)
|
||||
})
|
||||
|
||||
it('clic sur le tile deja actif declenche un PATCH (resync cross-tab)', async () => {
|
||||
// Le court-circuit "si deja actif, ne rien faire" a ete supprime
|
||||
// pour couvrir le cas ou un autre onglet a modifie le site courant
|
||||
// cote serveur : un clic sur la tile localement "active" (etat
|
||||
// potentiellement stale) force une resync via PATCH. Le prix est un
|
||||
// PATCH superflu quand l'etat local est effectivement a jour.
|
||||
const wrapper = mountSelector()
|
||||
|
||||
await wrapper.find('[data-testid="tile-1"]').trigger('click')
|
||||
await flushPromises()
|
||||
|
||||
expect(mockPatch).toHaveBeenCalledWith(
|
||||
'/me/current-site',
|
||||
{ site: '/api/sites/1' },
|
||||
expect.anything(),
|
||||
)
|
||||
})
|
||||
|
||||
it('rollback visuel : sur erreur PATCH, data-active-id revient au site initial', async () => {
|
||||
// Scenario : admin clique sur Saint-Jean alors que Chatellerault est
|
||||
// actif, mais le serveur rejette (ex : 500). Apres rollback dans
|
||||
// useCurrentSite, le composant doit re-afficher Chatellerault actif.
|
||||
mockPatch.mockRejectedValueOnce(new Error('server down'))
|
||||
const wrapper = mountSelector()
|
||||
|
||||
// Avant : Chatellerault (id=1) actif.
|
||||
expect(wrapper.find('[data-testid="malio-site-selector"]').attributes('data-active-id'))
|
||||
.toBe('1')
|
||||
|
||||
await wrapper.find('[data-testid="tile-2"]').trigger('click')
|
||||
await flushPromises()
|
||||
|
||||
// Apres rollback : Chatellerault (id=1) de nouveau actif.
|
||||
expect(wrapper.find('[data-testid="malio-site-selector"]').attributes('data-active-id'))
|
||||
.toBe('1')
|
||||
// Le store auth ne doit PAS avoir ete laisse avec SITE_B.
|
||||
expect(mockAuthUser.value?.currentSite).toEqual(SITE_A)
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,219 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import type { Site } from '~/shared/types/sites'
|
||||
import { useCurrentSite } from '../useCurrentSite'
|
||||
|
||||
const mockPatch = vi.hoisted(() => vi.fn())
|
||||
const mockAuthUser = vi.hoisted(() => ({
|
||||
value: null as { sites: Site[]; currentSite: Site | null } | null,
|
||||
}))
|
||||
|
||||
// Stub des auto-imports Nuxt consommes par le composable.
|
||||
vi.stubGlobal('useApi', () => ({ patch: mockPatch }))
|
||||
vi.stubGlobal('useAuthStore', () => ({
|
||||
get user() {
|
||||
return mockAuthUser.value
|
||||
},
|
||||
// Mime l'action Pinia ajoutee au ticket 3 review (S6) : mute
|
||||
// user.currentSite si user present, no-op sinon.
|
||||
setCurrentSite(site: Site | null) {
|
||||
if (mockAuthUser.value) {
|
||||
mockAuthUser.value.currentSite = site
|
||||
}
|
||||
},
|
||||
}))
|
||||
vi.stubGlobal('useI18n', () => ({
|
||||
t: (key: string) => key,
|
||||
}))
|
||||
// useSidebar est consomme par useCurrentSite pour rafraichir la sidebar
|
||||
// apres un switch reussi. Stub minimal retournant un loadSidebar no-op.
|
||||
vi.stubGlobal('useSidebar', () => ({
|
||||
loadSidebar: vi.fn(),
|
||||
}))
|
||||
// refreshNuxtData est appele apres un switch pour invalider les donnees
|
||||
// de page precedemment fetchees. Stub no-op pour les tests unitaires.
|
||||
vi.stubGlobal('refreshNuxtData', vi.fn())
|
||||
|
||||
const SITE_A: Site = {
|
||||
id: 1,
|
||||
name: 'Chatellerault',
|
||||
street: '14 All. d\'Argenson',
|
||||
complement: null,
|
||||
postalCode: '86100',
|
||||
city: 'Châtellerault',
|
||||
color: '#056CF2',
|
||||
fullAddress: '14 All. d\'Argenson\n86100 Châtellerault',
|
||||
}
|
||||
const SITE_B: Site = {
|
||||
id: 2,
|
||||
name: 'Saint-Jean',
|
||||
street: 'Z i',
|
||||
complement: null,
|
||||
postalCode: '17400',
|
||||
city: 'Fontenet',
|
||||
color: '#F3CB00',
|
||||
fullAddress: 'Z i\n17400 Fontenet',
|
||||
}
|
||||
|
||||
describe('useCurrentSite', () => {
|
||||
beforeEach(() => {
|
||||
mockPatch.mockReset()
|
||||
mockAuthUser.value = {
|
||||
sites: [SITE_A, SITE_B],
|
||||
currentSite: SITE_A,
|
||||
}
|
||||
const { resetCurrentSite } = useCurrentSite()
|
||||
resetCurrentSite()
|
||||
})
|
||||
|
||||
it('syncFromAuth hydrate le state depuis le store auth', () => {
|
||||
const { syncFromAuth, currentSite, availableSites } = useCurrentSite()
|
||||
|
||||
syncFromAuth()
|
||||
|
||||
expect(currentSite.value).toEqual(SITE_A)
|
||||
expect(availableSites.value).toEqual([SITE_A, SITE_B])
|
||||
})
|
||||
|
||||
it('syncFromAuth gere le cas user null (deconnecte)', () => {
|
||||
mockAuthUser.value = null
|
||||
const { syncFromAuth, currentSite, availableSites } = useCurrentSite()
|
||||
|
||||
syncFromAuth()
|
||||
|
||||
expect(currentSite.value).toBeNull()
|
||||
expect(availableSites.value).toEqual([])
|
||||
})
|
||||
|
||||
it('switchSite met a jour currentSite localement AVANT la requete (optimistic)', async () => {
|
||||
mockPatch.mockImplementation(async () => {
|
||||
// Au moment du resolve, currentSite est deja basculé.
|
||||
const state = useCurrentSite()
|
||||
expect(state.currentSite.value).toEqual(SITE_B)
|
||||
return {}
|
||||
})
|
||||
|
||||
const { syncFromAuth, switchSite, currentSite } = useCurrentSite()
|
||||
syncFromAuth()
|
||||
await switchSite(SITE_B)
|
||||
|
||||
expect(currentSite.value).toEqual(SITE_B)
|
||||
expect(mockPatch).toHaveBeenCalledWith(
|
||||
'/me/current-site',
|
||||
{ site: '/api/sites/2' },
|
||||
expect.objectContaining({ toastSuccessMessage: expect.any(String) }),
|
||||
)
|
||||
})
|
||||
|
||||
it('switchSite propage le nouveau currentSite au store auth en cas de succes', async () => {
|
||||
mockPatch.mockResolvedValueOnce({})
|
||||
const { syncFromAuth, switchSite } = useCurrentSite()
|
||||
syncFromAuth()
|
||||
|
||||
await switchSite(SITE_B)
|
||||
|
||||
expect(mockAuthUser.value?.currentSite).toEqual(SITE_B)
|
||||
})
|
||||
|
||||
it('switchSite rollback le currentSite local si la requete echoue', async () => {
|
||||
mockPatch.mockRejectedValueOnce(new Error('network'))
|
||||
const { syncFromAuth, switchSite, currentSite } = useCurrentSite()
|
||||
syncFromAuth()
|
||||
|
||||
await expect(switchSite(SITE_B)).rejects.toThrow('network')
|
||||
|
||||
expect(currentSite.value).toEqual(SITE_A)
|
||||
})
|
||||
|
||||
it('switchSite ne propage pas au store auth en cas d\'echec', async () => {
|
||||
mockPatch.mockRejectedValueOnce(new Error('network'))
|
||||
const { syncFromAuth, switchSite } = useCurrentSite()
|
||||
syncFromAuth()
|
||||
|
||||
await expect(switchSite(SITE_B)).rejects.toThrow()
|
||||
|
||||
expect(mockAuthUser.value?.currentSite).toEqual(SITE_A)
|
||||
})
|
||||
|
||||
it('switching est vrai pendant la requete et faux apres', async () => {
|
||||
let resolveRequest: (value: unknown) => void = () => {}
|
||||
mockPatch.mockImplementation(
|
||||
() => new Promise((resolve) => { resolveRequest = resolve }),
|
||||
)
|
||||
|
||||
const { syncFromAuth, switchSite, switching } = useCurrentSite()
|
||||
syncFromAuth()
|
||||
|
||||
const pending = switchSite(SITE_B)
|
||||
expect(switching.value).toBe(true)
|
||||
|
||||
resolveRequest({})
|
||||
await pending
|
||||
|
||||
expect(switching.value).toBe(false)
|
||||
})
|
||||
|
||||
it('double switchSite concurrent : le second appel est un no-op silencieux', async () => {
|
||||
let resolveRequest: (value: unknown) => void = () => {}
|
||||
mockPatch.mockImplementation(
|
||||
() => new Promise((resolve) => { resolveRequest = resolve }),
|
||||
)
|
||||
|
||||
const { syncFromAuth, switchSite } = useCurrentSite()
|
||||
syncFromAuth()
|
||||
|
||||
const first = switchSite(SITE_B)
|
||||
await switchSite(SITE_A) // doit etre no-op (switching=true)
|
||||
|
||||
// Le second appel ne declenche pas de PATCH additionnel.
|
||||
expect(mockPatch).toHaveBeenCalledTimes(1)
|
||||
|
||||
resolveRequest({})
|
||||
await first
|
||||
})
|
||||
|
||||
it('resetCurrentSite vide tout l\'etat singleton', () => {
|
||||
const { syncFromAuth, resetCurrentSite, currentSite, availableSites, switching } = useCurrentSite()
|
||||
syncFromAuth()
|
||||
expect(currentSite.value).not.toBeNull()
|
||||
|
||||
resetCurrentSite()
|
||||
|
||||
expect(currentSite.value).toBeNull()
|
||||
expect(availableSites.value).toEqual([])
|
||||
expect(switching.value).toBe(false)
|
||||
})
|
||||
|
||||
it('capture useI18n/useApi/useAuthStore UNE FOIS au setup (garde anti-regression bug runtime)', async () => {
|
||||
// Historique : une premiere version du composable appelait useI18n()
|
||||
// dans `switchSite` plutot qu'au top du setup. Consequence en runtime :
|
||||
// l'appel depuis un event handler (click) hors contexte setup levait
|
||||
// "Must be called at the top of a setup function". Ce test grave le
|
||||
// contrat : useCurrentSite() DOIT capturer les 3 services a
|
||||
// l'initialisation, pas paresseusement.
|
||||
//
|
||||
// Verification : on remplace useI18n par un mock qui throw au 2e appel.
|
||||
// Si switchSite invoque useI18n() lui-meme, ce test cassera.
|
||||
let i18nCallCount = 0
|
||||
vi.stubGlobal('useI18n', () => {
|
||||
i18nCallCount++
|
||||
if (i18nCallCount > 1) {
|
||||
throw new Error('useI18n called more than once — regression bug runtime')
|
||||
}
|
||||
return { t: (key: string) => key }
|
||||
})
|
||||
|
||||
mockPatch.mockResolvedValueOnce({})
|
||||
const { syncFromAuth, switchSite } = useCurrentSite()
|
||||
syncFromAuth()
|
||||
|
||||
// Si switchSite appelait useI18n() en interne, ce call incrementerait
|
||||
// i18nCallCount a 2 et throw. La garde du test passe uniquement si
|
||||
// la capture a bien eu lieu au setup (i18nCallCount reste a 1).
|
||||
await switchSite(SITE_B)
|
||||
|
||||
expect(i18nCallCount).toBe(1)
|
||||
|
||||
// Restaure le stub par defaut pour les tests suivants.
|
||||
vi.stubGlobal('useI18n', () => ({ t: (key: string) => key }))
|
||||
})
|
||||
})
|
||||
130
frontend/modules/sites/composables/useCurrentSite.ts
Normal file
130
frontend/modules/sites/composables/useCurrentSite.ts
Normal file
@@ -0,0 +1,130 @@
|
||||
/**
|
||||
* Composable de gestion du site courant (ticket 3 module Sites).
|
||||
*
|
||||
* Pattern aligne sur `useSidebar` : state singleton au niveau module,
|
||||
* hydrate depuis `useAuthStore().user`, mute de maniere optimistic avec
|
||||
* rollback si la requete PATCH `/api/me/current-site` echoue.
|
||||
*
|
||||
* Garantie d'unicite : le flag `switching` bloque les double-clicks
|
||||
* concurrents. Le reset explicite est appele au logout
|
||||
* (voir `modules/core/pages/logout.vue`).
|
||||
*
|
||||
* Auto-select : aucun. Le backend (`UserRbacProcessor::ensureCurrentSiteConsistency`)
|
||||
* garantit deja l'invariant "user avec sites non vide => currentSite non null"
|
||||
* apres tout PATCH /rbac. Le front consomme l'etat renvoye tel quel.
|
||||
*
|
||||
* Contrainte d'appel : `useCurrentSite()` doit etre invoque au top du
|
||||
* `setup()` d'un composant (ou d'un autre composable appele au setup).
|
||||
* Les dependances `useI18n`, `useApi` et `useAuthStore` sont resolues
|
||||
* a l'initialisation et reutilisees par `switchSite` — ceci evite le
|
||||
* "Must be called at the top of a setup function" qui se produirait
|
||||
* si on les appelait paresseusement depuis une fonction async declenchee
|
||||
* par un handler d'event (hors contexte setup).
|
||||
*/
|
||||
import { ref } from 'vue'
|
||||
import type { Site } from '~/shared/types/sites'
|
||||
import { onAuthSessionCleared } from '~/shared/stores/auth'
|
||||
|
||||
const currentSite = ref<Site | null>(null)
|
||||
const availableSites = ref<Site[]>([])
|
||||
const switching = ref(false)
|
||||
|
||||
// Enregistrement unique au niveau module (singleton) : quand clearSession()
|
||||
// est appelee par l'intercepteur 401 de useApi, le state local est purgé
|
||||
// de la meme facon qu'au logout explicite (logout.vue).
|
||||
onAuthSessionCleared(() => {
|
||||
currentSite.value = null
|
||||
availableSites.value = []
|
||||
switching.value = false
|
||||
})
|
||||
|
||||
export function useCurrentSite() {
|
||||
// Resolution au setup : les 3 services doivent etre invoques dans un
|
||||
// contexte composant. Leur capture ici permet a switchSite() de
|
||||
// s'executer plus tard (handler de click, async) sans crash.
|
||||
const auth = useAuthStore()
|
||||
const api = useApi()
|
||||
const { t } = useI18n()
|
||||
const { loadSidebar } = useSidebar()
|
||||
|
||||
/**
|
||||
* Synchronise le state singleton depuis le store auth. A appeler au
|
||||
* mount du SiteSelector (ou via un watcher sur `auth.user`).
|
||||
*/
|
||||
function syncFromAuth(): void {
|
||||
availableSites.value = auth.user?.sites ?? []
|
||||
currentSite.value = auth.user?.currentSite ?? null
|
||||
}
|
||||
|
||||
/**
|
||||
* Bascule le site courant. Optimistic UI : la mutation locale precede
|
||||
* la requete HTTP. En cas d'echec (`api.patch` throw), l'etat local est
|
||||
* restaure — le store auth n'a PAS ete muté a ce stade (la propagation
|
||||
* `auth.setCurrentSite` se fait uniquement apres un succes HTTP), donc
|
||||
* aucun rollback cote auth n'est necessaire.
|
||||
*
|
||||
* Garde anti-double-submit : si un switch est deja en vol, le second
|
||||
* appel est un no-op silencieux.
|
||||
*/
|
||||
async function switchSite(site: Site): Promise<void> {
|
||||
if (switching.value) {
|
||||
return
|
||||
}
|
||||
|
||||
const previousLocal = currentSite.value
|
||||
currentSite.value = site
|
||||
switching.value = true
|
||||
|
||||
try {
|
||||
await api.patch(
|
||||
'/me/current-site',
|
||||
{ site: `/api/sites/${site.id}` },
|
||||
{ toastSuccessMessage: t('sites.selector.switchSuccess') },
|
||||
)
|
||||
// Propage au store auth via l'action dediee — plus tracable que
|
||||
// la mutation directe et garantit la notification des watchers.
|
||||
// N'est appele qu'apres un succes HTTP donc pas de rollback a
|
||||
// prevoir sur cette ligne.
|
||||
auth.setCurrentSite(site)
|
||||
|
||||
// Apres un switch reussi : recharger la sidebar (les filtres de
|
||||
// modules peuvent dependre du site courant via SiteScopedQueryExtension)
|
||||
// et invalider toutes les donnees de page pour eviter que l'utilisateur
|
||||
// voie les donnees de l'ancien site sous un toast "Site change".
|
||||
try {
|
||||
await loadSidebar()
|
||||
} catch {
|
||||
// No-op : la sidebar non rafraichie n'est pas bloquante.
|
||||
}
|
||||
try {
|
||||
await refreshNuxtData()
|
||||
} catch {
|
||||
// No-op : certaines pages n'ont pas de useAsyncData a invalider.
|
||||
}
|
||||
} catch (error) {
|
||||
currentSite.value = previousLocal
|
||||
throw error
|
||||
} finally {
|
||||
switching.value = false
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Vide l'etat singleton. Appele au logout pour eviter qu'un user
|
||||
* suivant (connecte sur le meme onglet) voie les sites de l'ancien.
|
||||
*/
|
||||
function resetCurrentSite(): void {
|
||||
currentSite.value = null
|
||||
availableSites.value = []
|
||||
switching.value = false
|
||||
}
|
||||
|
||||
return {
|
||||
currentSite,
|
||||
availableSites,
|
||||
switching,
|
||||
switchSite,
|
||||
syncFromAuth,
|
||||
resetCurrentSite,
|
||||
}
|
||||
}
|
||||
1
frontend/modules/sites/nuxt.config.ts
Normal file
1
frontend/modules/sites/nuxt.config.ts
Normal file
@@ -0,0 +1 @@
|
||||
export default defineNuxtConfig({})
|
||||
195
frontend/modules/sites/pages/admin/sites.vue
Normal file
195
frontend/modules/sites/pages/admin/sites.vue
Normal file
@@ -0,0 +1,195 @@
|
||||
<template>
|
||||
<div>
|
||||
<!-- En-tete -->
|
||||
<div class="flex items-center justify-between">
|
||||
<h1 class="text-xl font-bold text-primary-500 sm:text-2xl">
|
||||
{{ t('admin.sites.title') }}
|
||||
</h1>
|
||||
<MalioButton
|
||||
v-if="can('sites.manage')"
|
||||
:label="t('admin.sites.newSite')"
|
||||
icon-name="mdi:plus"
|
||||
icon-position="left"
|
||||
@click="openCreateDrawer"
|
||||
/>
|
||||
</div>
|
||||
|
||||
<!-- Table des sites avec filtres + pagination -->
|
||||
<MalioDataTable
|
||||
v-model:page="page"
|
||||
v-model:per-page="perPage"
|
||||
class="mt-6"
|
||||
:columns="columns"
|
||||
:items="siteItems"
|
||||
:total-items="totalItems"
|
||||
:row-clickable="canManage"
|
||||
:empty-message="t('admin.sites.noSites')"
|
||||
@row-click="onRowClick"
|
||||
>
|
||||
<template #header-name>
|
||||
<input
|
||||
v-model="filters.name"
|
||||
type="text"
|
||||
:placeholder="t('admin.sites.table.name')"
|
||||
class="w-full border-0 border-b border-black bg-transparent px-0 py-1 text-xl outline-none"
|
||||
>
|
||||
</template>
|
||||
<template #header-city>
|
||||
<input
|
||||
v-model="filters.city"
|
||||
type="text"
|
||||
:placeholder="t('admin.sites.table.city')"
|
||||
class="w-full border-0 border-b border-black bg-transparent px-0 py-1 text-xl outline-none"
|
||||
>
|
||||
</template>
|
||||
<template #header-postalCode>
|
||||
<input
|
||||
v-model="filters.postalCode"
|
||||
type="text"
|
||||
:placeholder="t('admin.sites.table.postalCode')"
|
||||
class="w-full border-0 border-b border-black bg-transparent px-0 py-1 text-xl outline-none"
|
||||
>
|
||||
</template>
|
||||
|
||||
<template #cell-color="{ item }">
|
||||
<span class="inline-flex items-center gap-2">
|
||||
<span
|
||||
:style="{ backgroundColor: item.color }"
|
||||
class="inline-block size-5 rounded-full border border-neutral-200"
|
||||
/>
|
||||
<span class="font-mono text-xs">{{ item.color }}</span>
|
||||
</span>
|
||||
</template>
|
||||
<template #cell-fullAddress="{ item }">
|
||||
<span class="line-clamp-2 text-xs text-neutral-600">
|
||||
{{ item.fullAddress }}
|
||||
</span>
|
||||
</template>
|
||||
</MalioDataTable>
|
||||
|
||||
<!-- Drawer creation/edition -->
|
||||
<SiteDrawer
|
||||
v-model="drawerOpen"
|
||||
:site="selectedSite"
|
||||
@saved="onSiteSaved"
|
||||
@delete="onDeleteRequest"
|
||||
/>
|
||||
|
||||
<!-- Modale de suppression -->
|
||||
<SiteDeleteModal
|
||||
v-model="deleteModalOpen"
|
||||
:site-name="siteToDelete?.name ?? ''"
|
||||
:loading="deleting"
|
||||
@confirm="handleDelete"
|
||||
/>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
import type { Site } from '~/shared/types/sites'
|
||||
|
||||
const { t } = useI18n()
|
||||
const api = useApi()
|
||||
const auth = useAuthStore()
|
||||
const { can } = usePermissions()
|
||||
const canManage = computed(() => can('sites.manage'))
|
||||
|
||||
useHead({ title: t('admin.sites.title') })
|
||||
|
||||
// Etat DataTable centralise : pagination serveur + filtres debounces.
|
||||
// Les filtres name/city/postalCode sont des partiels SearchFilter cote API.
|
||||
const {
|
||||
items,
|
||||
totalItems,
|
||||
page,
|
||||
perPage,
|
||||
filters,
|
||||
reload,
|
||||
} = useDataTableServerState<Site>('/sites', {
|
||||
name: '',
|
||||
city: '',
|
||||
postalCode: '',
|
||||
})
|
||||
|
||||
const columns = [
|
||||
{ key: 'name', label: t('admin.sites.table.name') },
|
||||
{ key: 'city', label: t('admin.sites.table.city') },
|
||||
{ key: 'postalCode', label: t('admin.sites.table.postalCode') },
|
||||
{ key: 'color', label: t('admin.sites.table.color') },
|
||||
{ key: 'fullAddress', label: t('admin.sites.table.fullAddress') },
|
||||
]
|
||||
|
||||
// Transformer les sites en items compatibles MalioDataTable.
|
||||
// `fullAddress` provient du getter computed cote backend (Site::getFullAddress)
|
||||
// au format multi-lignes — on l'aplatit en virgules pour l'affichage table.
|
||||
const siteItems = computed(() =>
|
||||
items.value.map(site => ({
|
||||
id: site.id,
|
||||
name: site.name,
|
||||
city: site.city,
|
||||
postalCode: site.postalCode,
|
||||
color: site.color,
|
||||
fullAddress: site.fullAddress.split('\n').join(', '),
|
||||
})),
|
||||
)
|
||||
|
||||
function getSiteById(id: number): Site | undefined {
|
||||
return items.value.find(s => s.id === id)
|
||||
}
|
||||
|
||||
function onRowClick(item: Record<string, unknown>) {
|
||||
const site = getSiteById(item.id as number)
|
||||
if (site) openEditDrawer(site)
|
||||
}
|
||||
|
||||
const drawerOpen = ref(false)
|
||||
const selectedSite = ref<Site | null>(null)
|
||||
const deleteModalOpen = ref(false)
|
||||
const siteToDelete = ref<Site | null>(null)
|
||||
const deleting = ref(false)
|
||||
|
||||
function openCreateDrawer() {
|
||||
selectedSite.value = null
|
||||
drawerOpen.value = true
|
||||
}
|
||||
|
||||
function openEditDrawer(site: Site) {
|
||||
selectedSite.value = site
|
||||
drawerOpen.value = true
|
||||
}
|
||||
|
||||
function onDeleteRequest() {
|
||||
if (!selectedSite.value) return
|
||||
siteToDelete.value = selectedSite.value
|
||||
deleteModalOpen.value = true
|
||||
}
|
||||
|
||||
async function handleDelete() {
|
||||
if (!siteToDelete.value) return
|
||||
deleting.value = true
|
||||
try {
|
||||
await api.delete(`/sites/${siteToDelete.value.id}`, {}, {
|
||||
toastSuccessMessage: t('admin.sites.toast.deleted'),
|
||||
})
|
||||
deleteModalOpen.value = false
|
||||
siteToDelete.value = null
|
||||
drawerOpen.value = false
|
||||
reload()
|
||||
// Rafraichit auth.user apres suppression d'un site : le backend
|
||||
// applique ON DELETE SET NULL sur user.current_site_id, donc
|
||||
// auth.user.currentSite peut etre devenu null sans que le front
|
||||
// le sache. refreshUser() resynchronise depuis GET /api/me.
|
||||
await auth.refreshUser()
|
||||
} finally {
|
||||
deleting.value = false
|
||||
}
|
||||
}
|
||||
|
||||
function onSiteSaved() {
|
||||
reload()
|
||||
}
|
||||
|
||||
onMounted(() => {
|
||||
reload()
|
||||
})
|
||||
</script>
|
||||
@@ -3,11 +3,21 @@ import { resolve } from 'node:path'
|
||||
|
||||
// Auto-detect module layers: every directory under frontend/modules/ becomes a Nuxt layer.
|
||||
const modulesDir = resolve(__dirname, 'modules')
|
||||
const moduleLayers = existsSync(modulesDir)
|
||||
const moduleDirs = existsSync(modulesDir)
|
||||
? readdirSync(modulesDir, { withFileTypes: true })
|
||||
.filter(d => d.isDirectory())
|
||||
.map(d => `./modules/${d.name}`)
|
||||
.map(d => d.name)
|
||||
: []
|
||||
const moduleLayers = moduleDirs.map(name => `./modules/${name}`)
|
||||
|
||||
// Auto-detect composables dirs pour chaque layer module. Necessaire car le
|
||||
// `imports.dirs` explicite ci-dessous override le comportement par defaut
|
||||
// de Nuxt (qui scannerait composables/ de chaque layer automatiquement).
|
||||
// Sans ca, useCurrentSite / autres composables des modules ne seraient pas
|
||||
// resolus a l'execution — cf. ticket 3 bug detecte apres review.
|
||||
const moduleComposableDirs = moduleDirs
|
||||
.map(name => `./modules/${name}/composables`)
|
||||
.filter(path => existsSync(resolve(__dirname, path)))
|
||||
|
||||
export default defineNuxtConfig({
|
||||
compatibilityDate: '2025-07-15',
|
||||
@@ -51,6 +61,7 @@ export default defineNuxtConfig({
|
||||
'shared/composables',
|
||||
'shared/utils',
|
||||
'shared/stores',
|
||||
...moduleComposableDirs,
|
||||
],
|
||||
},
|
||||
vite: {
|
||||
|
||||
72
frontend/package-lock.json
generated
72
frontend/package-lock.json
generated
@@ -7,7 +7,7 @@
|
||||
"name": "coltura-frontend",
|
||||
"hasInstallScript": true,
|
||||
"dependencies": {
|
||||
"@malio/layer-ui": "^1.3.0",
|
||||
"@malio/layer-ui": "^1.4.2",
|
||||
"@nuxt/icon": "^2.2.1",
|
||||
"@nuxtjs/i18n": "^10.2.3",
|
||||
"@nuxtjs/tailwindcss": "^6.14.0",
|
||||
@@ -22,6 +22,7 @@
|
||||
"@nuxt/eslint-config": "^1.9.0",
|
||||
"@typescript-eslint/eslint-plugin": "^8.44.1",
|
||||
"@typescript-eslint/parser": "^8.44.1",
|
||||
"@vitejs/plugin-vue": "^6.0.6",
|
||||
"@vue/test-utils": "^2.4.6",
|
||||
"eslint": "^9.36.0",
|
||||
"eslint-plugin-vue": "^10.5.0",
|
||||
@@ -83,6 +84,7 @@
|
||||
"resolved": "https://registry.npmjs.org/@babel/core/-/core-7.29.0.tgz",
|
||||
"integrity": "sha512-CGOfOJqWjg2qW/Mb6zNsDm+u5vFQ8DxXfbM09z69p5Z6+mE1ikP2jUXw+j42Pf1XTYED2Rni5f95npYeuwMDQA==",
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"@babel/code-frame": "^7.29.0",
|
||||
"@babel/generator": "^7.29.0",
|
||||
@@ -580,27 +582,6 @@
|
||||
"integrity": "sha512-/B8YJGPzaYq1NbsQmwgP8EZqg40NpTw4ZB3suuI0TplbxKHeK94jeaawLmVhCv+YwUnOpiWEz9U6SeThku/8JQ==",
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/@emnapi/core": {
|
||||
"version": "1.10.0",
|
||||
"resolved": "https://registry.npmjs.org/@emnapi/core/-/core-1.10.0.tgz",
|
||||
"integrity": "sha512-yq6OkJ4p82CAfPl0u9mQebQHKPJkY7WrIuk205cTYnYe+k2Z8YBh11FrbRG/H6ihirqcacOgl2BIO8oyMQLeXw==",
|
||||
"license": "MIT",
|
||||
"optional": true,
|
||||
"dependencies": {
|
||||
"@emnapi/wasi-threads": "1.2.1",
|
||||
"tslib": "^2.4.0"
|
||||
}
|
||||
},
|
||||
"node_modules/@emnapi/runtime": {
|
||||
"version": "1.10.0",
|
||||
"resolved": "https://registry.npmjs.org/@emnapi/runtime/-/runtime-1.10.0.tgz",
|
||||
"integrity": "sha512-ewvYlk86xUoGI0zQRNq/mC+16R1QeDlKQy21Ki3oSYXNgLb45GV1P6A0M+/s6nyCuNDqe5VpaY84BzXGwVbwFA==",
|
||||
"license": "MIT",
|
||||
"optional": true,
|
||||
"dependencies": {
|
||||
"tslib": "^2.4.0"
|
||||
}
|
||||
},
|
||||
"node_modules/@emnapi/wasi-threads": {
|
||||
"version": "1.2.1",
|
||||
"resolved": "https://registry.npmjs.org/@emnapi/wasi-threads/-/wasi-threads-1.2.1.tgz",
|
||||
@@ -1839,9 +1820,9 @@
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/@malio/layer-ui": {
|
||||
"version": "1.3.0",
|
||||
"resolved": "https://gitea.malio.fr/api/packages/MALIO-DEV/npm/%40malio%2Flayer-ui/-/1.3.0/layer-ui-1.3.0.tgz",
|
||||
"integrity": "sha512-Gs4pnlWTWrhoF3QQKxYBu4IxN65O9B4bls7s+ONm05qvI2Y2x7N4VNFGjWvT+rNQ4BzHFCxSCzN4V3o6p0Q7uw==",
|
||||
"version": "1.4.2",
|
||||
"resolved": "https://gitea.malio.fr/api/packages/MALIO-DEV/npm/%40malio%2Flayer-ui/-/1.4.2/layer-ui-1.4.2.tgz",
|
||||
"integrity": "sha512-H8f5FJXHFH9ZI1Jx4u9XE7w6VlR/d9Zr2encfQyMax1I0UZ3SiGBUjictcL33r0OhgsrgSmPq0J9aF6aab85Nw==",
|
||||
"dependencies": {
|
||||
"@nuxt/icon": "^2.2.1",
|
||||
"@nuxtjs/tailwindcss": "^6.14.0",
|
||||
@@ -2186,6 +2167,7 @@
|
||||
"resolved": "https://registry.npmjs.org/@nuxt/kit/-/kit-4.4.2.tgz",
|
||||
"integrity": "sha512-5+IPRNX2CjkBhuWUwz0hBuLqiaJPRoKzQ+SvcdrQDbAyE+VDeFt74VpSFr5/R0ujrK4b+XnSHUJWdS72w6hsog==",
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"c12": "^3.3.3",
|
||||
"consola": "^3.4.2",
|
||||
@@ -2288,6 +2270,7 @@
|
||||
"resolved": "https://registry.npmjs.org/@nuxt/schema/-/schema-4.4.2.tgz",
|
||||
"integrity": "sha512-/q6C7Qhiricgi+PKR7ovBnJlKTL0memCbA1CzRT+itCW/oeYzUfeMdQ35mGntlBoyRPNrMXbzuSUhfDbSCU57w==",
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"@vue/shared": "^3.5.30",
|
||||
"defu": "^6.1.4",
|
||||
@@ -3957,9 +3940,9 @@
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/@rolldown/pluginutils": {
|
||||
"version": "1.0.0-rc.2",
|
||||
"resolved": "https://registry.npmjs.org/@rolldown/pluginutils/-/pluginutils-1.0.0-rc.2.tgz",
|
||||
"integrity": "sha512-izyXV/v+cHiRfozX62W9htOAvwMo4/bXKDrQ+vom1L1qRuexPock/7VZDAhnpHCLNejd3NJ6hiab+tO0D44Rgw==",
|
||||
"version": "1.0.0-rc.13",
|
||||
"resolved": "https://registry.npmjs.org/@rolldown/pluginutils/-/pluginutils-1.0.0-rc.13.tgz",
|
||||
"integrity": "sha512-3ngTAv6F/Py35BsYbeeLeecvhMKdsKm4AoOETVhAA+Qc8nrA2I0kF7oa93mE9qnIurngOSpMnQ0x2nQY2FPviA==",
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/@rollup/plugin-alias": {
|
||||
@@ -4628,6 +4611,7 @@
|
||||
"integrity": "sha512-+qIYRKdNYJwY3vRCZMdJbPLJAtGjQBudzZzdzwQYkEPQd+PJGixUL5QfvCLDaULoLv+RhT3LDkwEfKaAkgSmNQ==",
|
||||
"devOptional": true,
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"undici-types": "~7.19.0"
|
||||
}
|
||||
@@ -4690,6 +4674,7 @@
|
||||
"integrity": "sha512-/Zb/xaIDfxeJnvishjGdcR4jmr7S+bda8PKNhRGdljDM+elXhlvN0FyPSsMnLmJUrVG9aPO6dof80wjMawsASg==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"@typescript-eslint/scope-manager": "8.58.2",
|
||||
"@typescript-eslint/types": "8.58.2",
|
||||
@@ -5206,12 +5191,12 @@
|
||||
}
|
||||
},
|
||||
"node_modules/@vitejs/plugin-vue": {
|
||||
"version": "6.0.5",
|
||||
"resolved": "https://registry.npmjs.org/@vitejs/plugin-vue/-/plugin-vue-6.0.5.tgz",
|
||||
"integrity": "sha512-bL3AxKuQySfk1iGcBsQnoRVexTPJq0Z/ixFVM8OhVJAP6ZXXXLtM7NFKWhLl30Kg7uTBqIaPXbh+nuQCuBDedg==",
|
||||
"version": "6.0.6",
|
||||
"resolved": "https://registry.npmjs.org/@vitejs/plugin-vue/-/plugin-vue-6.0.6.tgz",
|
||||
"integrity": "sha512-u9HHgfrq3AjXlysn0eINFnWQOJQLO9WN6VprZ8FXl7A2bYisv3Hui9Ij+7QZ41F/WYWarHjwBbXtD7dKg3uxbg==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@rolldown/pluginutils": "1.0.0-rc.2"
|
||||
"@rolldown/pluginutils": "1.0.0-rc.13"
|
||||
},
|
||||
"engines": {
|
||||
"node": "^20.19.0 || >=22.12.0"
|
||||
@@ -5469,6 +5454,7 @@
|
||||
"resolved": "https://registry.npmjs.org/@vue/compiler-sfc/-/compiler-sfc-3.5.32.tgz",
|
||||
"integrity": "sha512-8UYUYo71cP/0YHMO814TRZlPuUUw3oifHuMR7Wp9SNoRSrxRQnhMLNlCeaODNn6kNTJsjFoQ/kqIj4qGvya4Xg==",
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"@babel/parser": "^7.29.2",
|
||||
"@vue/compiler-core": "3.5.32",
|
||||
@@ -5712,6 +5698,7 @@
|
||||
"resolved": "https://registry.npmjs.org/acorn/-/acorn-8.16.0.tgz",
|
||||
"integrity": "sha512-UVJyE9MttOsBQIDKw1skb9nAwQuR5wuGD3+82K6JgJlm/Y+KI92oNsMNGZCYdDsVtRHSak0pcV5Dno5+4jh9sw==",
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"bin": {
|
||||
"acorn": "bin/acorn"
|
||||
},
|
||||
@@ -6099,6 +6086,7 @@
|
||||
"resolved": "https://registry.npmjs.org/bare-events/-/bare-events-2.8.2.tgz",
|
||||
"integrity": "sha512-riJjyv1/mHLIPX4RwiK+oW9/4c3TEUeORHKefKAKnZ5kyslbN+HXowtbaVEqt4IMUB7OXlfixcs6gsFeo/jhiQ==",
|
||||
"license": "Apache-2.0",
|
||||
"peer": true,
|
||||
"peerDependencies": {
|
||||
"bare-abort-controller": "*"
|
||||
},
|
||||
@@ -6296,6 +6284,7 @@
|
||||
}
|
||||
],
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"baseline-browser-mapping": "^2.10.12",
|
||||
"caniuse-lite": "^1.0.30001782",
|
||||
@@ -6410,6 +6399,7 @@
|
||||
"resolved": "https://registry.npmjs.org/cac/-/cac-6.7.14.tgz",
|
||||
"integrity": "sha512-b6Ilus+c3RrdDk+JhLKUAQfzzgLEPy6wcXqS7f/xe1EETvsDP6GORG7SFuOs6cID5YkqchW/LXZbX5bc8j7ZcQ==",
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"engines": {
|
||||
"node": ">=8"
|
||||
}
|
||||
@@ -6604,7 +6594,8 @@
|
||||
"version": "0.2.2",
|
||||
"resolved": "https://registry.npmjs.org/citty/-/citty-0.2.2.tgz",
|
||||
"integrity": "sha512-+6vJA3L98yv+IdfKGZHBNiGW5KHn22e/JwID0Strsz8h4S/csAu/OuICwxrg44k5MRiZHWIo8XXuJgQTriRP4w==",
|
||||
"license": "MIT"
|
||||
"license": "MIT",
|
||||
"peer": true
|
||||
},
|
||||
"node_modules/clean-regexp": {
|
||||
"version": "1.0.0",
|
||||
@@ -7657,6 +7648,7 @@
|
||||
"resolved": "https://registry.npmjs.org/eslint/-/eslint-9.39.4.tgz",
|
||||
"integrity": "sha512-XoMjdBOwe/esVgEvLmNsD3IRHkm7fbKIUGvrleloJXUZgDHig2IPWNniv+GwjyJXzuNqVjlr5+4yVUZjycJwfQ==",
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"@eslint-community/eslint-utils": "^4.8.0",
|
||||
"@eslint-community/regexpp": "^4.12.1",
|
||||
@@ -8815,6 +8807,7 @@
|
||||
"integrity": "sha512-GZZ9mKe8r646NUAf/zemnGbjYh4Bt8/MqASJY+pSm5ZDtc3YQox+4gsLI7yi1hba6o+eCsGxpHn5+iEVn31/FQ==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"@types/node": ">=20.0.0",
|
||||
"@types/whatwg-mimetype": "^3.0.2",
|
||||
@@ -11205,6 +11198,7 @@
|
||||
"resolved": "https://registry.npmjs.org/nuxt/-/nuxt-4.4.2.tgz",
|
||||
"integrity": "sha512-iWVFpr/YEqVU/CenqIHMnIkvb2HE/9f+q8oxZ+pj2et+60NljGRClCgnmbvGPdmNFE0F1bEhoBCYfqbDOCim3Q==",
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"@dxup/nuxt": "^0.4.0",
|
||||
"@nuxt/cli": "^3.34.0",
|
||||
@@ -12263,6 +12257,7 @@
|
||||
"resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.4.tgz",
|
||||
"integrity": "sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g==",
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"deep-is": "^0.1.3",
|
||||
"fast-levenshtein": "^2.0.6",
|
||||
@@ -12314,6 +12309,7 @@
|
||||
"resolved": "https://registry.npmjs.org/oxc-parser/-/oxc-parser-0.112.0.tgz",
|
||||
"integrity": "sha512-7rQ3QdJwobMQLMZwQaPuPYMEF2fDRZwf51lZ//V+bA37nejjKW5ifMHbbCwvA889Y4RLhT+/wLJpPRhAoBaZYw==",
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"@oxc-project/types": "^0.112.0"
|
||||
},
|
||||
@@ -12580,6 +12576,7 @@
|
||||
"resolved": "https://registry.npmjs.org/pinia/-/pinia-3.0.4.tgz",
|
||||
"integrity": "sha512-l7pqLUFTI/+ESXn6k3nu30ZIzW5E2WZF/LaHJEpoq6ElcLD+wduZoB2kBN19du6K/4FDpPMazY2wJr+IndBtQw==",
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"@vue/devtools-api": "^7.7.7"
|
||||
},
|
||||
@@ -12658,6 +12655,7 @@
|
||||
}
|
||||
],
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"nanoid": "^3.3.11",
|
||||
"picocolors": "^1.1.1",
|
||||
@@ -13201,6 +13199,7 @@
|
||||
"resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz",
|
||||
"integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==",
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"cssesc": "^3.0.0",
|
||||
"util-deprecate": "^1.0.2"
|
||||
@@ -13820,6 +13819,7 @@
|
||||
"resolved": "https://registry.npmjs.org/rollup/-/rollup-4.60.1.tgz",
|
||||
"integrity": "sha512-VmtB2rFU/GroZ4oL8+ZqXgSA38O6GR8KSIvWmEFv63pQ0G6KaBH9s07PO8XTXP4vI+3UJUEypOfjkGfmSBBR0w==",
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"@types/estree": "1.0.8"
|
||||
},
|
||||
@@ -14717,6 +14717,7 @@
|
||||
"resolved": "https://registry.npmjs.org/tailwindcss/-/tailwindcss-3.4.19.tgz",
|
||||
"integrity": "sha512-3ofp+LL8E+pK/JuPLPggVAIaEuhvIz4qNcf3nA1Xn2o/7fb7s/TYpHhwGDv1ZU3PkBluUVaF8PyCHcm48cKLWQ==",
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"@alloc/quick-lru": "^5.2.0",
|
||||
"arg": "^5.0.2",
|
||||
@@ -15372,6 +15373,7 @@
|
||||
"dev": true,
|
||||
"hasInstallScript": true,
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"napi-postinstall": "^0.3.0"
|
||||
},
|
||||
@@ -15638,6 +15640,7 @@
|
||||
"resolved": "https://registry.npmjs.org/vite/-/vite-7.3.2.tgz",
|
||||
"integrity": "sha512-Bby3NOsna2jsjfLVOHKes8sGwgl4TT0E6vvpYgnAYDIF/tie7MRaFthmKuHx1NSXjiTueXH3do80FMQgvEktRg==",
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"esbuild": "^0.27.0",
|
||||
"fdir": "^6.5.0",
|
||||
@@ -16556,6 +16559,7 @@
|
||||
"resolved": "https://registry.npmjs.org/vue/-/vue-3.5.32.tgz",
|
||||
"integrity": "sha512-vM4z4Q9tTafVfMAK7IVzmxg34rSzTFMyIe0UUEijUCkn9+23lj0WRfA83dg7eQZIUlgOSGrkViIaCfqSAUXsMw==",
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"@vue/compiler-dom": "3.5.32",
|
||||
"@vue/compiler-sfc": "3.5.32",
|
||||
@@ -16600,6 +16604,7 @@
|
||||
"integrity": "sha512-Vxi9pJdbN3ZnVGLODVtZ7y4Y2kzAAE2Cm0CZ3ZDRvydVYxZ6VrnBhLikBsRS+dpwj4Jv4UCv21PTEwF5rQ9WXg==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"debug": "^4.4.0",
|
||||
"eslint-scope": "^8.2.0 || ^9.0.0",
|
||||
@@ -16636,6 +16641,7 @@
|
||||
"resolved": "https://registry.npmjs.org/vue-i18n/-/vue-i18n-11.3.1.tgz",
|
||||
"integrity": "sha512-azq8fhVnCwJAw0iXW7i44h9P+Bj+snNuevBAaJ9bxn0I3YVsRU3deVFPNnTfZ2uxVJefGp83JUmL68ddCPw5Pw==",
|
||||
"license": "MIT",
|
||||
"peer": true,
|
||||
"dependencies": {
|
||||
"@intlify/core-base": "11.3.1",
|
||||
"@intlify/devtools-types": "11.3.1",
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
"test:watch": "vitest"
|
||||
},
|
||||
"dependencies": {
|
||||
"@malio/layer-ui": "^1.3.0",
|
||||
"@malio/layer-ui": "^1.4.2",
|
||||
"@nuxt/icon": "^2.2.1",
|
||||
"@nuxtjs/i18n": "^10.2.3",
|
||||
"@nuxtjs/tailwindcss": "^6.14.0",
|
||||
@@ -30,6 +30,7 @@
|
||||
"@nuxt/eslint-config": "^1.9.0",
|
||||
"@typescript-eslint/eslint-plugin": "^8.44.1",
|
||||
"@typescript-eslint/parser": "^8.44.1",
|
||||
"@vitejs/plugin-vue": "^6.0.6",
|
||||
"@vue/test-utils": "^2.4.6",
|
||||
"eslint": "^9.36.0",
|
||||
"eslint-plugin-vue": "^10.5.0",
|
||||
|
||||
@@ -0,0 +1,203 @@
|
||||
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
|
||||
import { nextTick } from 'vue'
|
||||
import { useDataTableServerState } from '../useDataTableServerState'
|
||||
|
||||
const mockApiGet = vi.hoisted(() => vi.fn())
|
||||
vi.stubGlobal('useApi', () => ({ get: mockApiGet }))
|
||||
|
||||
function ldResponse<T>(member: T[], totalItems?: number): { member: T[], totalItems: number } {
|
||||
return { member, totalItems: totalItems ?? member.length }
|
||||
}
|
||||
|
||||
describe('useDataTableServerState', () => {
|
||||
beforeEach(() => {
|
||||
mockApiGet.mockReset()
|
||||
vi.useFakeTimers()
|
||||
})
|
||||
|
||||
afterEach(() => {
|
||||
vi.useRealTimers()
|
||||
})
|
||||
|
||||
it('fetch initial au premier reload() avec page=1 et perPage par defaut', async () => {
|
||||
mockApiGet.mockResolvedValueOnce(ldResponse([{ id: 1 }, { id: 2 }], 42))
|
||||
|
||||
const { items, totalItems, reload } = useDataTableServerState('/sites', { name: '' })
|
||||
reload()
|
||||
await vi.runAllTimersAsync()
|
||||
|
||||
expect(mockApiGet).toHaveBeenCalledWith(
|
||||
'/sites',
|
||||
{ page: 1, itemsPerPage: 10 },
|
||||
{ toast: false },
|
||||
)
|
||||
expect(items.value).toHaveLength(2)
|
||||
expect(totalItems.value).toBe(42)
|
||||
})
|
||||
|
||||
it('omet les filtres a valeur vide dans les query params', async () => {
|
||||
mockApiGet.mockResolvedValueOnce(ldResponse([]))
|
||||
|
||||
const { reload } = useDataTableServerState('/users', {
|
||||
username: '',
|
||||
isAdmin: null,
|
||||
})
|
||||
reload()
|
||||
await vi.runAllTimersAsync()
|
||||
|
||||
expect(mockApiGet).toHaveBeenCalledWith(
|
||||
'/users',
|
||||
{ page: 1, itemsPerPage: 10 },
|
||||
{ toast: false },
|
||||
)
|
||||
})
|
||||
|
||||
it('inclut les filtres renseignes dans les query params', async () => {
|
||||
// mockResolvedValue (sans Once) : chaque fetch retourne une
|
||||
// reponse valide, y compris ceux declenches par le debounce des
|
||||
// mutations de filters qui precedent reload().
|
||||
mockApiGet.mockResolvedValue(ldResponse([]))
|
||||
|
||||
const { filters, reload } = useDataTableServerState('/users', {
|
||||
username: '',
|
||||
isAdmin: null,
|
||||
})
|
||||
filters.value.username = 'alice'
|
||||
filters.value.isAdmin = true
|
||||
reload()
|
||||
await vi.runAllTimersAsync()
|
||||
|
||||
// Le reload() ecrase les scheduleReload en cours (clearTimeout),
|
||||
// donc on verifie juste que la derniere requete emise porte bien
|
||||
// les filtres + les parametres de pagination.
|
||||
expect(mockApiGet).toHaveBeenLastCalledWith(
|
||||
'/users',
|
||||
{ page: 1, itemsPerPage: 10, username: 'alice', isAdmin: true },
|
||||
{ toast: false },
|
||||
)
|
||||
})
|
||||
|
||||
it('change page declenche un fetch immediat (pas de debounce)', async () => {
|
||||
mockApiGet.mockResolvedValue(ldResponse([]))
|
||||
|
||||
const { page, reload } = useDataTableServerState('/sites', {})
|
||||
reload()
|
||||
await vi.runAllTimersAsync()
|
||||
expect(mockApiGet).toHaveBeenCalledTimes(1)
|
||||
|
||||
page.value = 3
|
||||
await nextTick()
|
||||
await vi.runAllTimersAsync()
|
||||
|
||||
expect(mockApiGet).toHaveBeenCalledTimes(2)
|
||||
expect(mockApiGet).toHaveBeenLastCalledWith(
|
||||
'/sites',
|
||||
{ page: 3, itemsPerPage: 10 },
|
||||
{ toast: false },
|
||||
)
|
||||
})
|
||||
|
||||
it('change filter debounce 300ms avant fetch', async () => {
|
||||
mockApiGet.mockResolvedValue(ldResponse([]))
|
||||
|
||||
const { filters, reload } = useDataTableServerState('/sites', { name: '' })
|
||||
reload()
|
||||
await vi.runAllTimersAsync()
|
||||
mockApiGet.mockClear()
|
||||
|
||||
filters.value.name = 'a'
|
||||
await nextTick()
|
||||
// Pas encore de requete : debounce en cours.
|
||||
expect(mockApiGet).not.toHaveBeenCalled()
|
||||
|
||||
filters.value.name = 'al'
|
||||
await nextTick()
|
||||
filters.value.name = 'ali'
|
||||
await nextTick()
|
||||
|
||||
// Avance le timer de 200ms : toujours pas fetch.
|
||||
vi.advanceTimersByTime(200)
|
||||
expect(mockApiGet).not.toHaveBeenCalled()
|
||||
|
||||
// Avance encore 100ms : debounce expire, fetch lance.
|
||||
vi.advanceTimersByTime(100)
|
||||
await vi.runAllTimersAsync()
|
||||
|
||||
expect(mockApiGet).toHaveBeenCalledTimes(1)
|
||||
expect(mockApiGet).toHaveBeenCalledWith(
|
||||
'/sites',
|
||||
{ page: 1, itemsPerPage: 10, name: 'ali' },
|
||||
{ toast: false },
|
||||
)
|
||||
})
|
||||
|
||||
it('changer un filtre reset page a 1', async () => {
|
||||
mockApiGet.mockResolvedValue(ldResponse([]))
|
||||
|
||||
const { page, filters, reload } = useDataTableServerState('/sites', { name: '' })
|
||||
reload()
|
||||
await vi.runAllTimersAsync()
|
||||
page.value = 5
|
||||
await vi.runAllTimersAsync()
|
||||
mockApiGet.mockClear()
|
||||
|
||||
filters.value.name = 'x'
|
||||
await nextTick()
|
||||
await vi.runAllTimersAsync()
|
||||
|
||||
// Page doit etre revenue a 1 avant le fetch.
|
||||
expect(page.value).toBe(1)
|
||||
expect(mockApiGet).toHaveBeenLastCalledWith(
|
||||
'/sites',
|
||||
expect.objectContaining({ page: 1, name: 'x' }),
|
||||
{ toast: false },
|
||||
)
|
||||
})
|
||||
|
||||
it('change perPage declenche un fetch immediat', async () => {
|
||||
mockApiGet.mockResolvedValue(ldResponse([]))
|
||||
|
||||
const { perPage, reload } = useDataTableServerState('/sites', {})
|
||||
reload()
|
||||
await vi.runAllTimersAsync()
|
||||
mockApiGet.mockClear()
|
||||
|
||||
perPage.value = 25
|
||||
await nextTick()
|
||||
await vi.runAllTimersAsync()
|
||||
|
||||
expect(mockApiGet).toHaveBeenLastCalledWith(
|
||||
'/sites',
|
||||
{ page: 1, itemsPerPage: 25 },
|
||||
{ toast: false },
|
||||
)
|
||||
})
|
||||
|
||||
it('race condition : seule la derniere reponse gagne', async () => {
|
||||
// Scenario : user tape tres vite, 2 requetes partent, la premiere
|
||||
// (plus ancienne) arrive apres la seconde. Le composable doit
|
||||
// ignorer la premiere.
|
||||
let resolveFirst!: (value: unknown) => void
|
||||
let resolveSecond!: (value: unknown) => void
|
||||
|
||||
mockApiGet
|
||||
.mockImplementationOnce(() => new Promise((r) => { resolveFirst = r }))
|
||||
.mockImplementationOnce(() => new Promise((r) => { resolveSecond = r }))
|
||||
|
||||
const { items, reload } = useDataTableServerState<{ id: number }>('/sites', {})
|
||||
|
||||
reload() // requete #1
|
||||
reload() // requete #2 (annule #1 du point de vue du token)
|
||||
|
||||
// Resout la seconde d'abord avec id=2
|
||||
resolveSecond(ldResponse([{ id: 2 }]))
|
||||
await vi.runAllTimersAsync()
|
||||
expect(items.value).toEqual([{ id: 2 }])
|
||||
|
||||
// Resout la premiere apres avec id=1 : DOIT etre ignore.
|
||||
resolveFirst(ldResponse([{ id: 1 }]))
|
||||
await vi.runAllTimersAsync()
|
||||
|
||||
expect(items.value).toEqual([{ id: 2 }])
|
||||
})
|
||||
})
|
||||
71
frontend/shared/composables/__tests__/useModules.test.ts
Normal file
71
frontend/shared/composables/__tests__/useModules.test.ts
Normal file
@@ -0,0 +1,71 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { useModules } from '../useModules'
|
||||
|
||||
// Mock de useApi : on peut scripter la reponse de /api/modules.
|
||||
const mockApiGet = vi.hoisted(() => vi.fn())
|
||||
|
||||
// useApi est auto-importe par Nuxt en prod. En Vitest isole, on expose le
|
||||
// mock comme global pour que l'appel sans import dans useModules.ts
|
||||
// (pattern aligne sur useSidebar) fonctionne.
|
||||
vi.stubGlobal('useApi', () => ({ get: mockApiGet }))
|
||||
|
||||
describe('useModules', () => {
|
||||
beforeEach(() => {
|
||||
mockApiGet.mockReset()
|
||||
// Reset l'etat singleton entre tests.
|
||||
const { resetModules } = useModules()
|
||||
resetModules()
|
||||
})
|
||||
|
||||
it('charge la liste des modules actifs depuis /api/modules', async () => {
|
||||
mockApiGet.mockResolvedValueOnce({ modules: ['core', 'sites'] })
|
||||
const { loadModules, activeModuleIds, loaded } = useModules()
|
||||
|
||||
await loadModules()
|
||||
|
||||
expect(mockApiGet).toHaveBeenCalledWith('/modules', {}, { toast: false })
|
||||
expect(activeModuleIds.value).toEqual(['core', 'sites'])
|
||||
expect(loaded.value).toBe(true)
|
||||
})
|
||||
|
||||
it('isModuleActive retourne true pour un id present', async () => {
|
||||
mockApiGet.mockResolvedValueOnce({ modules: ['core', 'sites'] })
|
||||
const { loadModules, isModuleActive } = useModules()
|
||||
await loadModules()
|
||||
|
||||
expect(isModuleActive('sites')).toBe(true)
|
||||
expect(isModuleActive('core')).toBe(true)
|
||||
})
|
||||
|
||||
it('isModuleActive retourne false pour un id absent', async () => {
|
||||
mockApiGet.mockResolvedValueOnce({ modules: ['core'] })
|
||||
const { loadModules, isModuleActive } = useModules()
|
||||
await loadModules()
|
||||
|
||||
expect(isModuleActive('sites')).toBe(false)
|
||||
expect(isModuleActive('inexistant')).toBe(false)
|
||||
})
|
||||
|
||||
it('swallow les erreurs reseau et laisse la liste vide', async () => {
|
||||
mockApiGet.mockRejectedValueOnce(new Error('boom'))
|
||||
const { loadModules, activeModuleIds, loaded, isModuleActive } = useModules()
|
||||
|
||||
await loadModules()
|
||||
|
||||
expect(activeModuleIds.value).toEqual([])
|
||||
expect(loaded.value).toBe(true)
|
||||
expect(isModuleActive('sites')).toBe(false)
|
||||
})
|
||||
|
||||
it('resetModules vide l\'etat', async () => {
|
||||
mockApiGet.mockResolvedValueOnce({ modules: ['core', 'sites'] })
|
||||
const { loadModules, resetModules, activeModuleIds, loaded } = useModules()
|
||||
await loadModules()
|
||||
expect(activeModuleIds.value.length).toBeGreaterThan(0)
|
||||
|
||||
resetModules()
|
||||
|
||||
expect(activeModuleIds.value).toEqual([])
|
||||
expect(loaded.value).toBe(false)
|
||||
})
|
||||
})
|
||||
71
frontend/shared/composables/__tests__/useSidebar.test.ts
Normal file
71
frontend/shared/composables/__tests__/useSidebar.test.ts
Normal file
@@ -0,0 +1,71 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { useSidebar } from '../useSidebar'
|
||||
|
||||
const mockApiGet = vi.hoisted(() => vi.fn())
|
||||
vi.stubGlobal('useApi', () => ({ get: mockApiGet }))
|
||||
|
||||
/**
|
||||
* Tests de l'invariant "loadSidebar ne reject jamais".
|
||||
*
|
||||
* Garantie utilisee par le middleware auth.global.ts qui fait un
|
||||
* Promise.all([loadSidebar(), loadModules()]) — si l'un throw, le
|
||||
* middleware echoue et toute l'app avec. Le swallow interne est donc
|
||||
* load-bearing et ce test le verrouille.
|
||||
*/
|
||||
describe('useSidebar', () => {
|
||||
beforeEach(() => {
|
||||
mockApiGet.mockReset()
|
||||
const { resetSidebar } = useSidebar()
|
||||
resetSidebar()
|
||||
})
|
||||
|
||||
it('charge sections et disabledRoutes depuis /api/sidebar', async () => {
|
||||
mockApiGet.mockResolvedValueOnce({
|
||||
sections: [{ label: 's', icon: 'i', items: [] }],
|
||||
disabledRoutes: ['/foo'],
|
||||
})
|
||||
const { loadSidebar, sections, disabledRoutes, loaded } = useSidebar()
|
||||
|
||||
await loadSidebar()
|
||||
|
||||
expect(sections.value).toHaveLength(1)
|
||||
expect(disabledRoutes.value).toEqual(['/foo'])
|
||||
expect(loaded.value).toBe(true)
|
||||
})
|
||||
|
||||
it('swallow les erreurs reseau sans rejeter (invariant middleware)', async () => {
|
||||
mockApiGet.mockRejectedValueOnce(new Error('boom'))
|
||||
const { loadSidebar, sections, disabledRoutes, loaded } = useSidebar()
|
||||
|
||||
// Assertion principale : la promise resout normalement meme sur erreur.
|
||||
await expect(loadSidebar()).resolves.toBeUndefined()
|
||||
expect(sections.value).toEqual([])
|
||||
expect(disabledRoutes.value).toEqual([])
|
||||
expect(loaded.value).toBe(true)
|
||||
})
|
||||
|
||||
it('isRouteDisabled matche exactement un chemin', async () => {
|
||||
mockApiGet.mockResolvedValueOnce({ sections: [], disabledRoutes: ['/foo'] })
|
||||
const { loadSidebar, isRouteDisabled } = useSidebar()
|
||||
await loadSidebar()
|
||||
|
||||
expect(isRouteDisabled('/foo')).toBe(true)
|
||||
expect(isRouteDisabled('/foo/bar')).toBe(true)
|
||||
expect(isRouteDisabled('/other')).toBe(false)
|
||||
})
|
||||
|
||||
it('resetSidebar vide l\'etat', async () => {
|
||||
mockApiGet.mockResolvedValueOnce({
|
||||
sections: [{ label: 's', icon: 'i', items: [] }],
|
||||
disabledRoutes: ['/foo'],
|
||||
})
|
||||
const { loadSidebar, resetSidebar, sections, loaded } = useSidebar()
|
||||
await loadSidebar()
|
||||
expect(loaded.value).toBe(true)
|
||||
|
||||
resetSidebar()
|
||||
|
||||
expect(sections.value).toEqual([])
|
||||
expect(loaded.value).toBe(false)
|
||||
})
|
||||
})
|
||||
149
frontend/shared/composables/useDataTableServerState.ts
Normal file
149
frontend/shared/composables/useDataTableServerState.ts
Normal file
@@ -0,0 +1,149 @@
|
||||
import { ref, watch } from 'vue'
|
||||
|
||||
/**
|
||||
* Composable generique pour les DataTables admin avec pagination, perPage
|
||||
* et filtres cote serveur (API Platform + Hydra).
|
||||
*
|
||||
* Usage type dans une page admin :
|
||||
*
|
||||
* ```ts
|
||||
* const { items, totalItems, page, perPage, filters, loading, reload } =
|
||||
* useDataTableServerState<Site>('/sites', {
|
||||
* name: '',
|
||||
* city: '',
|
||||
* postalCode: '',
|
||||
* })
|
||||
* ```
|
||||
*
|
||||
* Le composable :
|
||||
* - traque `page`, `perPage`, et un objet `filters` reactif.
|
||||
* - re-fetch automatiquement a chaque changement (debounce 300ms sur
|
||||
* `filters` pour eviter un spam lors de la frappe clavier).
|
||||
* - re-fetch immediat (pas de debounce) quand `page` ou `perPage` change
|
||||
* — ces changements sont deja des clics user discrets.
|
||||
* - reinitialise `page` a 1 des qu'un filtre bouge (coherence UX : un
|
||||
* filtre ajuste ne doit pas laisser l'user sur "page 5 de 2 pages").
|
||||
* - expose `loading` pour afficher un feedback pendant la requete.
|
||||
* - expose `reload()` pour forcer un fetch (ex: apres une mutation
|
||||
* POST/PATCH/DELETE).
|
||||
*
|
||||
* Type parameter T = la forme d'un item renvoye par l'API (le member[]
|
||||
* du payload Hydra est type T[]).
|
||||
*/
|
||||
export function useDataTableServerState<T = Record<string, unknown>>(
|
||||
endpoint: string,
|
||||
initialFilters: Record<string, string | boolean | null> = {},
|
||||
options: { debounceMs?: number, initialPerPage?: number } = {},
|
||||
) {
|
||||
const api = useApi()
|
||||
|
||||
const debounceMs = options.debounceMs ?? 300
|
||||
const initialPerPage = options.initialPerPage ?? 10
|
||||
|
||||
const items = ref<T[]>([]) as { value: T[] }
|
||||
const totalItems = ref(0)
|
||||
const page = ref(1)
|
||||
const perPage = ref(initialPerPage)
|
||||
const filters = ref<Record<string, string | boolean | null>>({ ...initialFilters })
|
||||
const loading = ref(false)
|
||||
|
||||
let debounceTimer: ReturnType<typeof setTimeout> | null = null
|
||||
// Token de generation : chaque reload incremente ce compteur. Quand
|
||||
// une reponse arrive, on verifie que son token est toujours le plus
|
||||
// recent — sinon on ignore (protection anti race condition si l'user
|
||||
// tape vite plusieurs filtres).
|
||||
let requestToken = 0
|
||||
|
||||
/**
|
||||
* Construit le payload query params pour useApi.get.
|
||||
* Les filtres a valeur vide (chaine vide, null) sont omis pour eviter
|
||||
* de filtrer sur "rien" (comportement API Platform : filtre present
|
||||
* avec valeur vide = ne retourne aucun resultat).
|
||||
*/
|
||||
function buildQueryParams(): Record<string, string | number | boolean> {
|
||||
const params: Record<string, string | number | boolean> = {
|
||||
page: page.value,
|
||||
itemsPerPage: perPage.value,
|
||||
}
|
||||
for (const [key, value] of Object.entries(filters.value)) {
|
||||
if (value === '' || value === null) continue
|
||||
params[key] = value as string | boolean
|
||||
}
|
||||
return params
|
||||
}
|
||||
|
||||
async function fetchItems(): Promise<void> {
|
||||
const currentToken = ++requestToken
|
||||
loading.value = true
|
||||
try {
|
||||
const data = await api.get<{ member: T[], totalItems: number }>(
|
||||
endpoint,
|
||||
buildQueryParams(),
|
||||
{ toast: false },
|
||||
)
|
||||
// Ignore si une requete plus recente a ete lancee entre-temps.
|
||||
if (currentToken !== requestToken) return
|
||||
// Defensive : un mock/test ou une API mal configuree peut
|
||||
// renvoyer undefined. On ne crash pas, on laisse les valeurs
|
||||
// par defaut.
|
||||
items.value = data?.member ?? []
|
||||
totalItems.value = data?.totalItems ?? 0
|
||||
} finally {
|
||||
if (currentToken === requestToken) {
|
||||
loading.value = false
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Force un refetch immediat, sans debounce. Utile apres une mutation
|
||||
* (POST/PATCH/DELETE) ou au mount initial.
|
||||
*/
|
||||
function reload(): void {
|
||||
if (debounceTimer) {
|
||||
clearTimeout(debounceTimer)
|
||||
debounceTimer = null
|
||||
}
|
||||
void fetchItems()
|
||||
}
|
||||
|
||||
/**
|
||||
* Programme un refetch debounced. Utilise par le watcher de `filters`.
|
||||
*/
|
||||
function scheduleReload(): void {
|
||||
if (debounceTimer) clearTimeout(debounceTimer)
|
||||
debounceTimer = setTimeout(() => {
|
||||
debounceTimer = null
|
||||
void fetchItems()
|
||||
}, debounceMs)
|
||||
}
|
||||
|
||||
// Watcher sur page/perPage : refetch immediat (pas de spam possible,
|
||||
// l'user clique sur un bouton pagination).
|
||||
watch([page, perPage], () => {
|
||||
reload()
|
||||
})
|
||||
|
||||
// Watcher sur filters : refetch debounced + reset page a 1 pour
|
||||
// eviter l'etat "filtre qui reduit le total mais user reste sur une
|
||||
// page inexistante".
|
||||
watch(filters, () => {
|
||||
if (page.value !== 1) {
|
||||
page.value = 1
|
||||
// Le changement de page declenchera son propre watcher, qui
|
||||
// appellera reload(). Pas besoin d'en programmer un.
|
||||
return
|
||||
}
|
||||
scheduleReload()
|
||||
}, { deep: true })
|
||||
|
||||
return {
|
||||
items,
|
||||
totalItems,
|
||||
page,
|
||||
perPage,
|
||||
filters,
|
||||
loading,
|
||||
reload,
|
||||
}
|
||||
}
|
||||
49
frontend/shared/composables/useModules.ts
Normal file
49
frontend/shared/composables/useModules.ts
Normal file
@@ -0,0 +1,49 @@
|
||||
/**
|
||||
* Composable de lecture des modules actifs (source : `/api/modules`).
|
||||
*
|
||||
* State singleton au niveau module : `useSidebar` suit la meme convention.
|
||||
* Chargement idempotent via le flag `loaded`, reset explicite au logout
|
||||
* (voir pages/logout.vue).
|
||||
*/
|
||||
import { ref } from 'vue'
|
||||
|
||||
const activeModuleIds = ref<string[]>([])
|
||||
const loaded = ref(false)
|
||||
|
||||
export function useModules() {
|
||||
async function loadModules() {
|
||||
try {
|
||||
const api = useApi()
|
||||
const data = await api.get<{ modules: string[] }>(
|
||||
'/modules',
|
||||
{},
|
||||
{ toast: false },
|
||||
)
|
||||
activeModuleIds.value = data.modules ?? []
|
||||
loaded.value = true
|
||||
} catch {
|
||||
// Swallow volontaire aligne sur useSidebar : un echec reseau ne
|
||||
// doit pas bloquer le rendu, l'app affichera juste sans la
|
||||
// granularite module (selector masque par defaut).
|
||||
activeModuleIds.value = []
|
||||
loaded.value = true
|
||||
}
|
||||
}
|
||||
|
||||
function isModuleActive(id: string): boolean {
|
||||
return activeModuleIds.value.includes(id)
|
||||
}
|
||||
|
||||
function resetModules() {
|
||||
activeModuleIds.value = []
|
||||
loaded.value = false
|
||||
}
|
||||
|
||||
return {
|
||||
activeModuleIds,
|
||||
loaded,
|
||||
loadModules,
|
||||
isModuleActive,
|
||||
resetModules,
|
||||
}
|
||||
}
|
||||
@@ -1,3 +1,4 @@
|
||||
import { ref } from 'vue'
|
||||
import type { SidebarSection } from '~/shared/types'
|
||||
|
||||
const sections = ref<SidebarSection[]>([])
|
||||
|
||||
@@ -1,7 +1,26 @@
|
||||
import { defineStore } from 'pinia'
|
||||
import type { UserData } from '~/shared/types/user-data'
|
||||
import type { Site } from '~/shared/types/sites'
|
||||
import { getCurrentUser, login, logout } from '~/shared/services/auth'
|
||||
|
||||
/**
|
||||
* Callbacks enregistres par les composables singletons qui doivent
|
||||
* reinitialiser leur etat quand la session est invalidee (ex: expiration
|
||||
* JWT, logout depuis un intercepteur 401). Utilise le pattern
|
||||
* "callback registration" (Option C) pour eviter une dependance croisee
|
||||
* depuis shared/ vers modules/ — chaque composable s'auto-enregistre.
|
||||
*/
|
||||
const onSessionClearedCallbacks: Array<() => void> = []
|
||||
|
||||
/**
|
||||
* Enregistre un callback a invoquer lorsque clearSession() est appelee.
|
||||
* Typiquement invoque au setup-time du composable (module-level), donc
|
||||
* une seule fois par instance de composable singleton.
|
||||
*/
|
||||
export function onAuthSessionCleared(cb: () => void): void {
|
||||
onSessionClearedCallbacks.push(cb)
|
||||
}
|
||||
|
||||
export const useAuthStore = defineStore('auth', {
|
||||
state: () => ({
|
||||
user: null as UserData | null,
|
||||
@@ -16,6 +35,10 @@ export const useAuthStore = defineStore('auth', {
|
||||
this.user = null
|
||||
this.checked = true
|
||||
this.isLoading = false
|
||||
// Notifie les composables singletons (useCurrentSite, etc.) afin
|
||||
// qu'ils reinitialisation leur etat — necessaire quand la session
|
||||
// est invalidee par un intercepteur 401 sans passer par logout.vue.
|
||||
onSessionClearedCallbacks.forEach((cb) => cb())
|
||||
},
|
||||
async ensureSession() {
|
||||
if (this.checked) {
|
||||
@@ -66,6 +89,18 @@ export const useAuthStore = defineStore('auth', {
|
||||
} catch {
|
||||
// Silently fail — user session might have expired
|
||||
}
|
||||
},
|
||||
/**
|
||||
* Action dediee au switch du site courant (ticket 3 module Sites).
|
||||
* Utilisee par useCurrentSite apres la confirmation serveur, et en
|
||||
* rollback si la requete PATCH echoue apres une mutation optimistic.
|
||||
* Passer explicitement par une action plutot que muter user.currentSite
|
||||
* directement garantit la tracabilite Pinia (devtools).
|
||||
*/
|
||||
setCurrentSite(site: Site | null) {
|
||||
if (this.user) {
|
||||
this.user.currentSite = site
|
||||
}
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
@@ -21,6 +21,8 @@ export interface UserListItem {
|
||||
isAdmin: boolean
|
||||
roles: string[]
|
||||
directPermissions: string[]
|
||||
/** IRIs des sites autorises (ticket 2 module Sites). */
|
||||
sites: string[]
|
||||
}
|
||||
|
||||
export interface EffectivePermission {
|
||||
|
||||
24
frontend/shared/types/sites.ts
Normal file
24
frontend/shared/types/sites.ts
Normal file
@@ -0,0 +1,24 @@
|
||||
export interface Site {
|
||||
id: number
|
||||
name: string
|
||||
street: string
|
||||
complement: string | null
|
||||
postalCode: string
|
||||
city: string
|
||||
color: string
|
||||
/** Adresse complete reconstituee cote backend (getter computed). Lecture seule. */
|
||||
fullAddress: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Payload accepte en POST/PATCH /api/sites. Volontairement sans `fullAddress`
|
||||
* (computed cote backend) ni champs read-only (id, timestamps).
|
||||
*/
|
||||
export interface SiteInput {
|
||||
name: string
|
||||
street: string
|
||||
complement: string | null
|
||||
postalCode: string
|
||||
city: string
|
||||
color: string
|
||||
}
|
||||
@@ -1,3 +1,5 @@
|
||||
import type { Site } from './sites'
|
||||
|
||||
export interface UserData {
|
||||
id: number
|
||||
username: string
|
||||
@@ -6,4 +8,8 @@ export interface UserData {
|
||||
isAdmin: boolean
|
||||
/** Codes de permission effectifs de l'utilisateur, tries alphabetiquement, sans doublon. */
|
||||
effectivePermissions: string[]
|
||||
/** Sites autorises pour l'utilisateur (ticket 2 module Sites). */
|
||||
sites: Site[]
|
||||
/** Site actuellement selectionne par l'utilisateur, ou null si aucun. */
|
||||
currentSite: Site | null
|
||||
}
|
||||
|
||||
42
frontend/shared/utils/__tests__/color.test.ts
Normal file
42
frontend/shared/utils/__tests__/color.test.ts
Normal file
@@ -0,0 +1,42 @@
|
||||
import { describe, it, expect } from 'vitest'
|
||||
import { isValidSiteColor } from '../color'
|
||||
|
||||
describe('isValidSiteColor', () => {
|
||||
it('accepte un hex majuscule', () => {
|
||||
expect(isValidSiteColor('#ABCDEF')).toBe(true)
|
||||
})
|
||||
|
||||
it('accepte un hex minuscule', () => {
|
||||
expect(isValidSiteColor('#abcdef')).toBe(true)
|
||||
})
|
||||
|
||||
it('accepte un hex mixte', () => {
|
||||
expect(isValidSiteColor('#0a1B2c')).toBe(true)
|
||||
})
|
||||
|
||||
it('accepte les couleurs fixtures du projet', () => {
|
||||
expect(isValidSiteColor('#056CF2')).toBe(true)
|
||||
expect(isValidSiteColor('#F3CB00')).toBe(true)
|
||||
expect(isValidSiteColor('#74BF04')).toBe(true)
|
||||
})
|
||||
|
||||
it('rejette un nom CSS', () => {
|
||||
expect(isValidSiteColor('red')).toBe(false)
|
||||
})
|
||||
|
||||
it('rejette un hex court', () => {
|
||||
expect(isValidSiteColor('#FFF')).toBe(false)
|
||||
})
|
||||
|
||||
it('rejette un hex sans diese', () => {
|
||||
expect(isValidSiteColor('FFFFFF')).toBe(false)
|
||||
})
|
||||
|
||||
it('rejette un caractere non hex', () => {
|
||||
expect(isValidSiteColor('#12345G')).toBe(false)
|
||||
})
|
||||
|
||||
it('rejette une chaine vide', () => {
|
||||
expect(isValidSiteColor('')).toBe(false)
|
||||
})
|
||||
})
|
||||
19
frontend/shared/utils/color.ts
Normal file
19
frontend/shared/utils/color.ts
Normal file
@@ -0,0 +1,19 @@
|
||||
/**
|
||||
* Utilitaires de couleur partages.
|
||||
*
|
||||
* Aligne sur la regex backend stricte #RRGGBB (voir Site.php).
|
||||
*/
|
||||
|
||||
const HEX_COLOR_REGEX = /^#[0-9A-Fa-f]{6}$/
|
||||
|
||||
/**
|
||||
* Valide qu'une chaine respecte le format #RRGGBB strict (7 caracteres,
|
||||
* 6 chiffres hexadecimaux apres le #). Tolere la casse (majuscules,
|
||||
* minuscules, mixte).
|
||||
*
|
||||
* Utilise cote front par SiteDrawer pour bloquer le submit avant l'envoi
|
||||
* backend — miroir du pattern Symfony Assert\Regex sur Site::$color.
|
||||
*/
|
||||
export function isValidSiteColor(hex: string): boolean {
|
||||
return HEX_COLOR_REGEX.test(hex)
|
||||
}
|
||||
@@ -1,13 +1,26 @@
|
||||
import type {Config} from 'tailwindcss'
|
||||
|
||||
/**
|
||||
* Config Tailwind du projet Coltura.
|
||||
*
|
||||
* @nuxtjs/tailwindcss merge automatiquement les configs de chaque layer
|
||||
* Nuxt declare dans `nuxt.config.ts:extends`. Le layer `@malio/layer-ui`
|
||||
* apporte deja :
|
||||
* - borderRadius.malio (var CSS --m-radius)
|
||||
* - colors.m.{primary,surface,border,text,muted,bg,disabled,danger,
|
||||
* success,btn-*,site-blue,site-yellow,site-green}
|
||||
* - fontFamily.sans (Helvetica Neue)
|
||||
*
|
||||
* Cette config locale ne redeclare QUE ce qui est specifique a Coltura
|
||||
* ou absent de la config Malio — evite la duplication et les derives.
|
||||
*/
|
||||
export default <Partial<Config>>{
|
||||
darkMode: 'class',
|
||||
theme: {
|
||||
extend: {
|
||||
fontFamily: {
|
||||
sans: ['"Helvetica Neue"', 'Helvetica', 'Arial', 'sans-serif']
|
||||
},
|
||||
colors: {
|
||||
// Couleurs applicatives Coltura (hors namespace `m` reserve
|
||||
// au design system Malio partage).
|
||||
primary: {
|
||||
500: '#222783',
|
||||
},
|
||||
@@ -20,27 +33,10 @@ export default <Partial<Config>>{
|
||||
blue: {
|
||||
500: '#056CF2'
|
||||
},
|
||||
// Extensions au namespace `m` non couvertes par Malio 1.4.1.
|
||||
m: {
|
||||
primary: 'rgb(var(--m-primary) / <alpha-value>)',
|
||||
secondary: 'rgb(var(--m-secondary, 75 77 237) / <alpha-value>)',
|
||||
tertiary: 'rgb(var(--m-tertiary, 243 244 248) / <alpha-value>)',
|
||||
border: 'rgb(var(--m-border) / <alpha-value>)',
|
||||
text: 'rgb(var(--m-text) / <alpha-value>)',
|
||||
muted: 'rgb(var(--m-muted) / <alpha-value>)',
|
||||
bg: 'rgb(var(--m-bg) / <alpha-value>)',
|
||||
surface: 'rgb(var(--m-surface) / <alpha-value>)',
|
||||
disabled: 'rgb(var(--m-disabled) / <alpha-value>)',
|
||||
danger: 'rgb(var(--m-danger) / <alpha-value>)',
|
||||
success: 'rgb(var(--m-success) / <alpha-value>)',
|
||||
'btn-primary': 'rgb(var(--m-btn-primary) / <alpha-value>)',
|
||||
'btn-primary-hover': 'rgb(var(--m-btn-primary-hover) / <alpha-value>)',
|
||||
'btn-primary-active': 'rgb(var(--m-btn-primary-active) / <alpha-value>)',
|
||||
'btn-secondary': 'rgb(var(--m-btn-secondary) / <alpha-value>)',
|
||||
'btn-secondary-hover': 'rgb(var(--m-btn-secondary-hover) / <alpha-value>)',
|
||||
'btn-secondary-active': 'rgb(var(--m-btn-secondary-active) / <alpha-value>)',
|
||||
'btn-danger': 'rgb(var(--m-btn-danger) / <alpha-value>)',
|
||||
'btn-danger-hover': 'rgb(var(--m-btn-danger-hover) / <alpha-value>)',
|
||||
'btn-danger-active': 'rgb(var(--m-btn-danger-active) / <alpha-value>)',
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
import { defineConfig } from 'vitest/config'
|
||||
import vue from '@vitejs/plugin-vue'
|
||||
import { fileURLToPath } from 'node:url'
|
||||
|
||||
export default defineConfig({
|
||||
plugins: [vue()],
|
||||
test: {
|
||||
environment: 'happy-dom',
|
||||
globals: true,
|
||||
|
||||
15
makefile
15
makefile
@@ -85,10 +85,23 @@ migration-migrate:
|
||||
|
||||
# Cree et initialise la base de test utilisee par PHPUnit
|
||||
# (le suffixe "_test" est applique automatiquement par Doctrine en APP_ENV=test)
|
||||
# Ordre : fixtures -> sync-permissions, car fixtures:load purge la table permission
|
||||
#
|
||||
# Ordre :
|
||||
# 1. migrations : crees le schema metier reel.
|
||||
# 2. schema:update : cree les tables mappees en `when@test` uniquement
|
||||
# (ex: fake_site_aware_entity du ticket 4) qui n'ont pas de migration.
|
||||
# `--force` sans `--complete` : ajoute les tables manquantes aux
|
||||
# mappings sans drop les tables DB non mappees (no-op sur un schema
|
||||
# deja aligne avec les migrations). Necessaire car le purger
|
||||
# doctrine:fixtures:load essaie de DELETE toutes les tables connues
|
||||
# via les mappings — si fake_site_aware_entity est mappe mais absent
|
||||
# en DB, le purger crash.
|
||||
# 3. fixtures -> sync-permissions : fixtures:load purge la table permission,
|
||||
# donc sync doit passer apres.
|
||||
test-db-setup:
|
||||
$(SYMFONY_CONSOLE) doctrine:database:create --env=test --if-not-exists
|
||||
$(SYMFONY_CONSOLE) doctrine:migrations:migrate --env=test --no-interaction
|
||||
$(SYMFONY_CONSOLE) doctrine:schema:update --env=test --force
|
||||
$(SYMFONY_CONSOLE) --env=test --no-interaction doctrine:fixtures:load
|
||||
$(SYMFONY_CONSOLE) --env=test --no-interaction app:sync-permissions
|
||||
|
||||
|
||||
72
migrations/Version20260417120000.php
Normal file
72
migrations/Version20260417120000.php
Normal file
@@ -0,0 +1,72 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace DoctrineMigrations;
|
||||
|
||||
use Doctrine\DBAL\Schema\Schema;
|
||||
use Doctrine\Migrations\AbstractMigration;
|
||||
|
||||
/**
|
||||
* Module Sites - Ticket 1/4 : brique fondatrice de donnees.
|
||||
*
|
||||
* Cree la table `site` qui porte les etablissements physiques de l'instance
|
||||
* Coltura. La table est creee inconditionnellement : meme si SitesModule est
|
||||
* desactive dans `config/modules.php`, la structure DB existe (pas de
|
||||
* dependance dure depuis Core, mais pas de coin d'ombre schema non plus).
|
||||
*
|
||||
* Note sur l'emplacement du fichier :
|
||||
* Par convention projet les migrations vivent dans
|
||||
* `src/Module/{Module}/Infrastructure/Doctrine/Migrations/`, sauf pour les
|
||||
* initialisations critiques. Cf. CLAUDE.md (section "Regles d'architecture")
|
||||
* qui documente le bug de tri alphabetique de Doctrine Migrations 3.x avec
|
||||
* plusieurs `migrations_paths` : tant que ce n'est pas corrige, toute
|
||||
* migration d'initialisation (creation de table sur base vide) reste au
|
||||
* namespace racine `DoctrineMigrations` dans `migrations/`.
|
||||
*/
|
||||
final class Version20260417120000 extends AbstractMigration
|
||||
{
|
||||
public function getDescription(): string
|
||||
{
|
||||
return 'Module Sites : creation de la table site (nom, ville, cp, couleur, adresse complete, timestamps).';
|
||||
}
|
||||
|
||||
public function up(Schema $schema): void
|
||||
{
|
||||
// Creation de la table site. Toutes les colonnes sont NOT NULL :
|
||||
// - le champ `color` est contraint cote applicatif au format #RRGGBB
|
||||
// (7 caracteres), la longueur DB est dimensionnee en consequence ;
|
||||
// - `postal_code` est limite a 10 caracteres pour laisser marge a
|
||||
// d'eventuels formats etrangers plus tard, tout en le validant
|
||||
// strictement en 5 chiffres cote applicatif (format FR).
|
||||
//
|
||||
// Note : `full_address` est restructure au ticket 2 (migration
|
||||
// Version20260420130000) en `street` + `complement` (nullable). La
|
||||
// structure d'origine est conservee ici pour ne pas casser les devs
|
||||
// qui ont deja joue cette migration en local.
|
||||
$this->addSql(<<<'SQL'
|
||||
CREATE TABLE site (
|
||||
id INT GENERATED BY DEFAULT AS IDENTITY NOT NULL,
|
||||
name VARCHAR(100) NOT NULL,
|
||||
city VARCHAR(100) NOT NULL,
|
||||
postal_code VARCHAR(10) NOT NULL,
|
||||
color VARCHAR(7) NOT NULL,
|
||||
full_address TEXT NOT NULL,
|
||||
created_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL,
|
||||
updated_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL,
|
||||
PRIMARY KEY (id)
|
||||
)
|
||||
SQL);
|
||||
|
||||
// Index unique sur le nom : garantit l'invariant metier "un site porte
|
||||
// un nom unique" et permet a la contrainte UniqueEntity cote Symfony
|
||||
// de s'appuyer sur une erreur DB en cas de race condition.
|
||||
$this->addSql('CREATE UNIQUE INDEX uniq_site_name ON site (name)');
|
||||
}
|
||||
|
||||
public function down(Schema $schema): void
|
||||
{
|
||||
// Drop direct : aucune FK depuis/vers la table dans ce ticket.
|
||||
$this->addSql('DROP TABLE site');
|
||||
}
|
||||
}
|
||||
88
migrations/Version20260417150000.php
Normal file
88
migrations/Version20260417150000.php
Normal file
@@ -0,0 +1,88 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace DoctrineMigrations;
|
||||
|
||||
use Doctrine\DBAL\Schema\Schema;
|
||||
use Doctrine\Migrations\AbstractMigration;
|
||||
|
||||
/**
|
||||
* Module Sites - Ticket 2/4 : rattachement User ↔ Site.
|
||||
*
|
||||
* Introduit deux nouvelles structures sur le schema existant :
|
||||
* - la table de jointure `user_site` (M2M) : liste des sites autorises
|
||||
* pour chaque utilisateur.
|
||||
* - la colonne `"user".current_site_id` (M2O nullable) : site actuellement
|
||||
* selectionne par l'utilisateur pour son contexte UX.
|
||||
*
|
||||
* Cascades choisies :
|
||||
* - `user_site.user_id` → `ON DELETE CASCADE` : supprimer un user purge
|
||||
* naturellement ses rattachements.
|
||||
* - `user_site.site_id` → `ON DELETE CASCADE` : supprimer un site purge
|
||||
* tous les rattachements a ce site.
|
||||
* - `"user".current_site_id` → `ON DELETE SET NULL` : supprimer un site
|
||||
* repasse le currentSite des users concernes a NULL (plutot que de
|
||||
* detruire les users, ce qui serait catastrophique).
|
||||
*
|
||||
* Note sur l'emplacement du fichier (namespace racine `DoctrineMigrations`)
|
||||
* Conforme a l'exception documentee dans `CLAUDE.md` : tant que le bug de
|
||||
* tri alphabetique des MigrationsComparator Doctrine 3.x n'est pas resolu,
|
||||
* toute migration touchant a la topologie des tables (creation, FKs
|
||||
* cross-module) vit au namespace racine. La migration croise ici les tables
|
||||
* `"user"` (module Core) et `site` (module Sites) — placement racine donc
|
||||
* justifie pour garantir l'ordre d'execution deterministe vis-a-vis des
|
||||
* deux migrations d'init deja presentes.
|
||||
*/
|
||||
final class Version20260417150000 extends AbstractMigration
|
||||
{
|
||||
public function getDescription(): string
|
||||
{
|
||||
return 'Module Sites : table user_site (M2M) + colonne user.current_site_id (M2O SET NULL).';
|
||||
}
|
||||
|
||||
public function up(Schema $schema): void
|
||||
{
|
||||
// 1) Creation de la table de jointure user_site.
|
||||
$this->addSql(<<<'SQL'
|
||||
CREATE TABLE user_site (
|
||||
user_id INT NOT NULL,
|
||||
site_id INT NOT NULL,
|
||||
PRIMARY KEY (user_id, site_id)
|
||||
)
|
||||
SQL);
|
||||
$this->addSql('CREATE INDEX IDX_user_site_user ON user_site (user_id)');
|
||||
$this->addSql('CREATE INDEX IDX_user_site_site ON user_site (site_id)');
|
||||
$this->addSql(<<<'SQL'
|
||||
ALTER TABLE user_site
|
||||
ADD CONSTRAINT FK_user_site_user
|
||||
FOREIGN KEY (user_id) REFERENCES "user" (id) ON DELETE CASCADE
|
||||
SQL);
|
||||
$this->addSql(<<<'SQL'
|
||||
ALTER TABLE user_site
|
||||
ADD CONSTRAINT FK_user_site_site
|
||||
FOREIGN KEY (site_id) REFERENCES site (id) ON DELETE CASCADE
|
||||
SQL);
|
||||
|
||||
// 2) Ajout de la colonne nullable user.current_site_id + FK SET NULL.
|
||||
$this->addSql('ALTER TABLE "user" ADD current_site_id INT DEFAULT NULL');
|
||||
$this->addSql('CREATE INDEX IDX_user_current_site ON "user" (current_site_id)');
|
||||
$this->addSql(<<<'SQL'
|
||||
ALTER TABLE "user"
|
||||
ADD CONSTRAINT FK_user_current_site
|
||||
FOREIGN KEY (current_site_id) REFERENCES site (id) ON DELETE SET NULL
|
||||
SQL);
|
||||
}
|
||||
|
||||
public function down(Schema $schema): void
|
||||
{
|
||||
// Rollback en ordre inverse : enfants avant parents.
|
||||
$this->addSql('ALTER TABLE "user" DROP CONSTRAINT FK_user_current_site');
|
||||
$this->addSql('DROP INDEX IDX_user_current_site');
|
||||
$this->addSql('ALTER TABLE "user" DROP current_site_id');
|
||||
|
||||
$this->addSql('ALTER TABLE user_site DROP CONSTRAINT FK_user_site_site');
|
||||
$this->addSql('ALTER TABLE user_site DROP CONSTRAINT FK_user_site_user');
|
||||
$this->addSql('DROP TABLE user_site');
|
||||
}
|
||||
}
|
||||
78
migrations/Version20260420130000.php
Normal file
78
migrations/Version20260420130000.php
Normal file
@@ -0,0 +1,78 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace DoctrineMigrations;
|
||||
|
||||
use Doctrine\DBAL\Schema\Schema;
|
||||
use Doctrine\Migrations\AbstractMigration;
|
||||
|
||||
/**
|
||||
* Module Sites - Ticket 2/4 : restructuration de l'adresse.
|
||||
*
|
||||
* Splitte la colonne `site.full_address` (TEXT NOT NULL, multi-lignes) en
|
||||
* deux champs structures :
|
||||
* - `street` (VARCHAR(255) NOT NULL) : numero + voie ;
|
||||
* - `complement` (VARCHAR(255) DEFAULT NULL) : batiment, escalier, BP...
|
||||
*
|
||||
* L'adresse complete affichable est desormais reconstituee cote applicatif
|
||||
* par Site::getFullAddress() (concatenation multi-lignes street\n[complement\n]CP ville)
|
||||
* et exposee en lecture API via le groupe `site:read` + `me:read`. Plus de
|
||||
* colonne DB redondante.
|
||||
*
|
||||
* Strategie de backfill (entre creation des nouvelles colonnes et drop de
|
||||
* l'ancienne) :
|
||||
* - `street` recoit la totalite de l'ancien `full_address` pour ne perdre
|
||||
* aucune donnee. C'est imparfait pour les adresses multi-lignes mais
|
||||
* safe : aucun risque de tronquage si l'ancienne adresse depasse 255
|
||||
* chars (PostgreSQL leve une erreur explicite ; charge a l'admin de
|
||||
* nettoyer manuellement si necessaire).
|
||||
* - `complement` reste null : pas d'heuristique fiable pour decouper une
|
||||
* adresse libre en street/complement.
|
||||
*
|
||||
* Cette migration evite un `make db-reset` force pour les developpeurs
|
||||
* ayant deja joue Version20260417120000 dans son etat initial (table site
|
||||
* avec full_address). Les fixtures sont mises a jour en parallele.
|
||||
*/
|
||||
final class Version20260420130000 extends AbstractMigration
|
||||
{
|
||||
public function getDescription(): string
|
||||
{
|
||||
return 'Module Sites : split full_address en street + complement (getter computed cote applicatif).';
|
||||
}
|
||||
|
||||
public function up(Schema $schema): void
|
||||
{
|
||||
// 1) Ajout des nouvelles colonnes en mode permissif :
|
||||
// - `street` nullable temporairement pour permettre le backfill.
|
||||
// - `complement` definitivement nullable.
|
||||
$this->addSql('ALTER TABLE site ADD street VARCHAR(255) DEFAULT NULL');
|
||||
$this->addSql('ALTER TABLE site ADD complement VARCHAR(255) DEFAULT NULL');
|
||||
|
||||
// 2) Backfill : recopier full_address dans street pour ne pas perdre
|
||||
// les donnees existantes. Les retours a la ligne sont preserves
|
||||
// (PostgreSQL VARCHAR accepte \n) ; un admin pourra reformater
|
||||
// apres coup si besoin. Cas d'adresse > 255 chars : la migration
|
||||
// echoue cleanly (pas de tronquage silencieux).
|
||||
$this->addSql('UPDATE site SET street = full_address');
|
||||
|
||||
// 3) Bascule street en NOT NULL une fois le backfill applique.
|
||||
$this->addSql('ALTER TABLE site ALTER COLUMN street SET NOT NULL');
|
||||
|
||||
// 4) Drop de l'ancienne colonne full_address.
|
||||
$this->addSql('ALTER TABLE site DROP full_address');
|
||||
}
|
||||
|
||||
public function down(Schema $schema): void
|
||||
{
|
||||
// Recreation de full_address (NOT NULL via DEFAULT '' pour eviter
|
||||
// un crash si la table a deja des lignes), puis backfill inverse,
|
||||
// puis drop des nouvelles colonnes.
|
||||
$this->addSql("ALTER TABLE site ADD full_address TEXT NOT NULL DEFAULT ''");
|
||||
$this->addSql("UPDATE site SET full_address = street || COALESCE(E'\\n' || complement, '')");
|
||||
$this->addSql('ALTER TABLE site ALTER COLUMN full_address DROP DEFAULT');
|
||||
|
||||
$this->addSql('ALTER TABLE site DROP street');
|
||||
$this->addSql('ALTER TABLE site DROP complement');
|
||||
}
|
||||
}
|
||||
@@ -5,6 +5,7 @@ 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\Delete;
|
||||
@@ -62,6 +63,15 @@ use Symfony\Component\Validator\Constraints as Assert;
|
||||
denormalizationContext: ['groups' => ['role:write']],
|
||||
)]
|
||||
#[ApiFilter(BooleanFilter::class, properties: ['isSystem'])]
|
||||
// Filtres /admin/roles : recherche partielle insensible a la casse
|
||||
// (ILIKE) sur label/code — un admin qui tape "ad" doit trouver
|
||||
// "Administrateur". Les relations restent en exact (alimentees par un
|
||||
// <select> cote front, donc casse maitrisee).
|
||||
#[ApiFilter(SearchFilter::class, properties: [
|
||||
'label' => 'ipartial',
|
||||
'code' => 'ipartial',
|
||||
'permissions.code' => 'exact',
|
||||
])]
|
||||
#[ORM\Entity(repositoryClass: DoctrineRoleRepository::class)]
|
||||
#[ORM\Table(name: '`role`')]
|
||||
#[ORM\UniqueConstraint(name: 'uniq_role_code', columns: ['code'])]
|
||||
|
||||
@@ -4,6 +4,9 @@ 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\Delete;
|
||||
use ApiPlatform\Metadata\Get;
|
||||
@@ -15,6 +18,14 @@ use App\Module\Core\Infrastructure\ApiPlatform\State\Processor\UserProcessor;
|
||||
use App\Module\Core\Infrastructure\ApiPlatform\State\Processor\UserRbacProcessor;
|
||||
use App\Module\Core\Infrastructure\ApiPlatform\State\Provider\MeProvider;
|
||||
use App\Module\Core\Infrastructure\Doctrine\DoctrineUserRepository;
|
||||
// Note architecture : User.php utilise SiteInterface (Shared) pour les
|
||||
// type-hints afin de ne pas coupler le module Core au module Sites.
|
||||
// La seule reference concrete a Site subsiste dans les metadonnees ORM
|
||||
// (targetEntity) via FQCN string, ce qui est obligatoire pour Doctrine.
|
||||
// SiteNotAuthorizedException est importee depuis Shared (sa location canonique).
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use App\Shared\Domain\Contract\SiteInterface;
|
||||
use App\Shared\Domain\Exception\SiteNotAuthorizedException;
|
||||
use DateTimeImmutable;
|
||||
use Doctrine\Common\Collections\ArrayCollection;
|
||||
use Doctrine\Common\Collections\Collection;
|
||||
@@ -53,6 +64,18 @@ use Symfony\Component\Serializer\Attribute\SerializedName;
|
||||
],
|
||||
denormalizationContext: ['groups' => ['user:write']],
|
||||
)]
|
||||
// Filtres /admin/users : recherche partielle insensible a la casse
|
||||
// (ILIKE) sur username + filtre bool isAdmin + filtres exacts sur les
|
||||
// relations (code de role ou nom de site).
|
||||
// Les relations sont filtrees par jointure : `rbacRoles.code=admin` declenche
|
||||
// un INNER JOIN user_role → role. `sites.name=Chatellerault` declenche
|
||||
// INNER JOIN user_site → site.
|
||||
#[ApiFilter(SearchFilter::class, properties: [
|
||||
'username' => 'ipartial',
|
||||
'rbacRoles.code' => 'exact',
|
||||
'sites.name' => 'exact',
|
||||
])]
|
||||
#[ApiFilter(BooleanFilter::class, properties: ['isAdmin'])]
|
||||
#[ORM\Entity(repositoryClass: DoctrineUserRepository::class)]
|
||||
#[ORM\Table(name: '`user`')]
|
||||
class User implements UserInterface, PasswordAuthenticatedUserInterface
|
||||
@@ -107,6 +130,45 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface
|
||||
#[Groups(['me:read', 'user:list', 'user:rbac:write', 'user:rbac:read'])]
|
||||
private Collection $directPermissions;
|
||||
|
||||
/**
|
||||
* Sites autorises pour l'utilisateur (ticket 2 du module Sites).
|
||||
*
|
||||
* Relation ManyToMany avec table de jointure `user_site`. Fetch LAZY :
|
||||
* le chargement est defere jusqu'a l'acces explicite a la collection.
|
||||
* MeProvider (ou un futur provider avec JOIN FETCH) est responsable de
|
||||
* precharger cette collection pour /api/me afin d'eviter N+1.
|
||||
*
|
||||
* Le groupe `user:list` a ete retire deliberement (securite : evite
|
||||
* de fuiter la liste des sites de chaque user via GET /api/users).
|
||||
*
|
||||
* @var Collection<int, Site>
|
||||
*/
|
||||
#[ORM\ManyToMany(targetEntity: 'App\Module\Sites\Domain\Entity\Site', inversedBy: 'users', fetch: 'LAZY')]
|
||||
#[ORM\JoinTable(name: 'user_site')]
|
||||
#[Groups(['me:read', 'user:rbac:read', 'user:rbac:write'])]
|
||||
private Collection $sites;
|
||||
|
||||
/**
|
||||
* Site courant selectionne par l'utilisateur (ticket 2 du module Sites).
|
||||
*
|
||||
* Relation ManyToOne nullable : un user peut ne pas avoir encore choisi
|
||||
* de site actif (par ex. apres creation avant premier login). La FK porte
|
||||
* `onDelete: SET NULL` pour que la suppression d'un site ne detruise pas
|
||||
* les users qui le pointaient — ils repassent simplement a `null`.
|
||||
*
|
||||
* Doit TOUJOURS pointer vers un site present dans `$sites`. L'invariant
|
||||
* est enforce par UserRbacProcessor qui bascule automatiquement a `null`
|
||||
* si le site courant est retire des sites autorises.
|
||||
*
|
||||
* Fetch LAZY : MeProvider (ou un futur provider avec JOIN FETCH) assure
|
||||
* le prechargement pour /api/me. Le groupe `user:list` a ete retire
|
||||
* deliberement (securite : evite de fuiter le site actif via /api/users).
|
||||
*/
|
||||
#[ORM\ManyToOne(targetEntity: 'App\Module\Sites\Domain\Entity\Site', fetch: 'LAZY')]
|
||||
#[ORM\JoinColumn(name: 'current_site_id', referencedColumnName: 'id', nullable: true, onDelete: 'SET NULL')]
|
||||
#[Groups(['me:read'])]
|
||||
private ?SiteInterface $currentSite = null;
|
||||
|
||||
#[ORM\Column]
|
||||
private ?string $password = null;
|
||||
|
||||
@@ -121,6 +183,7 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface
|
||||
$this->createdAt = new DateTimeImmutable();
|
||||
$this->rbacRoles = new ArrayCollection();
|
||||
$this->directPermissions = new ArrayCollection();
|
||||
$this->sites = new ArrayCollection();
|
||||
}
|
||||
|
||||
public function getId(): ?int
|
||||
@@ -313,4 +376,95 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface
|
||||
{
|
||||
$this->plainPassword = null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Collection<int, Site>
|
||||
*/
|
||||
public function getSites(): Collection
|
||||
{
|
||||
return $this->sites;
|
||||
}
|
||||
|
||||
/**
|
||||
* Idempotent : ajouter deux fois le meme site n'entraine pas de doublon.
|
||||
* Synchronise la collection inverse Site::$users en memoire pour eviter
|
||||
* un etat incoherent entre les deux cotes de la M2M dans une meme
|
||||
* session Doctrine (cf. ticket 2 review point #1).
|
||||
*
|
||||
* Le parametre est type SiteInterface pour eviter le couplage Core → Sites.
|
||||
* En pratique seule App\Module\Sites\Domain\Entity\Site est passee ici.
|
||||
*/
|
||||
public function addSite(SiteInterface $site): static
|
||||
{
|
||||
if (!$this->sites->contains($site)) {
|
||||
$this->sites->add($site);
|
||||
// @phpstan-ignore-next-line : Site concret toujours passe en pratique
|
||||
$site->addUser($this);
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retire un site de la collection + maintient la collection inverse en
|
||||
* memoire (cf. addSite). Attention : ne met PAS a jour `$currentSite`
|
||||
* si le site retire en etait le courant — cet invariant est enforce
|
||||
* par UserRbacProcessor (cote applicatif) ou doit etre maintenu
|
||||
* explicitement par l'appelant. Voir Risque 2 du ticket 2 spec.
|
||||
*/
|
||||
public function removeSite(SiteInterface $site): static
|
||||
{
|
||||
if ($this->sites->removeElement($site)) {
|
||||
// @phpstan-ignore-next-line : Site concret toujours passe en pratique
|
||||
$site->removeUser($this);
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Garde applicative rapide : teste la presence d'un site dans la
|
||||
* collection autorisee, via comparaison d'identite d'objet Doctrine.
|
||||
* Utilise par CurrentSiteProcessor pour valider un switch.
|
||||
*/
|
||||
public function hasSite(SiteInterface $site): bool
|
||||
{
|
||||
return $this->sites->contains($site);
|
||||
}
|
||||
|
||||
public function getCurrentSite(): ?SiteInterface
|
||||
{
|
||||
return $this->currentSite;
|
||||
}
|
||||
|
||||
/**
|
||||
* Setter brut, sans garde. Usage interne pour les flux qui doivent
|
||||
* pouvoir positionner un site arbitraire ou null (reset de coherence
|
||||
* post-PATCH RBAC, fixtures, init). Pour le flux user-facing
|
||||
* "selectionner un site dans la liste autorisee", utiliser
|
||||
* switchCurrentSite() qui porte la garde domaine.
|
||||
*/
|
||||
public function setCurrentSite(?SiteInterface $currentSite): static
|
||||
{
|
||||
$this->currentSite = $currentSite;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Garde domaine du switch utilisateur : refuse un site qui n'est pas
|
||||
* dans la collection autorisee. Levee d'une exception domaine que le
|
||||
* processor HTTP traduit en 403 (pattern aligne sur Role::ensureDeletable
|
||||
* → SystemRoleDeletionException).
|
||||
*
|
||||
* @throws SiteNotAuthorizedException si $site n'appartient pas a $this->sites
|
||||
*/
|
||||
public function switchCurrentSite(SiteInterface $site): void
|
||||
{
|
||||
if (!$this->hasSite($site)) {
|
||||
throw SiteNotAuthorizedException::forSite($site);
|
||||
}
|
||||
|
||||
$this->currentSite = $site;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -10,9 +10,11 @@ use App\Module\Core\Domain\Entity\User;
|
||||
use App\Module\Core\Domain\Exception\LastAdminProtectionException;
|
||||
use App\Module\Core\Domain\Security\AdminHeadcountGuardInterface;
|
||||
use Doctrine\ORM\EntityManagerInterface;
|
||||
use Doctrine\ORM\PersistentCollection;
|
||||
use LogicException;
|
||||
use Symfony\Bundle\SecurityBundle\Security;
|
||||
use Symfony\Component\DependencyInjection\Attribute\Autowire;
|
||||
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
|
||||
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
|
||||
|
||||
/**
|
||||
@@ -29,6 +31,21 @@ use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
|
||||
* - Dernier admin global : impossible de retirer `isAdmin` si c'est le
|
||||
* dernier administrateur de l'instance, meme par un tiers. Enforce via
|
||||
* AdminHeadcountGuardInterface.
|
||||
* - Permission sites.manage : si le payload mute la collection `sites`,
|
||||
* la permission `sites.manage` est requise en plus de `core.users.manage`.
|
||||
* - Coherence currentSite (ticket 2 module Sites) : apres persist des
|
||||
* sites autorises, si le `currentSite` n'est plus dans la collection,
|
||||
* il est repositionne automatiquement :
|
||||
* a) repasse a `null` s'il pointait vers un site retire ;
|
||||
* b) est auto-selectionne sur le premier site de `sites` s'il etait
|
||||
* null alors que la collection vient d'etre modifiee et n'est pas vide.
|
||||
* Un second flush est emis uniquement si la coherence a du etre corrigee.
|
||||
* La garde coherence est skippee si ni les sites ni le currentSite n'ont
|
||||
* change (evite le silent site-switch sur un PATCH ne touchant pas aux sites).
|
||||
*
|
||||
* Atomicite : persistProcessor->process() + ensureCurrentSiteConsistency() sont
|
||||
* executes dans une meme transaction wrapInTransaction pour eviter un etat
|
||||
* partiellement persiste en cas d'erreur entre les deux flush.
|
||||
*
|
||||
* @implements ProcessorInterface<User, User>
|
||||
*/
|
||||
@@ -80,6 +97,87 @@ final class UserRbacProcessor implements ProcessorInterface
|
||||
}
|
||||
}
|
||||
|
||||
return $this->persistProcessor->process($data, $operation, $uriVariables, $context);
|
||||
// Detection de la mutation de la collection `sites` avant tout flush.
|
||||
// La collection est deja denormalisee dans $data quand process() est appele.
|
||||
// On utilise PersistentCollection::isDirty() pour savoir si l'ORM a detecte
|
||||
// une modification depuis le chargement initial (ajout/retrait d'elements).
|
||||
$sitesCollection = $data->getSites();
|
||||
$sitesWereMutated = $sitesCollection instanceof PersistentCollection
|
||||
&& $sitesCollection->isDirty();
|
||||
|
||||
// Capture de l'ID du currentSite avant persist pour la detection post-flush.
|
||||
$originalCurrentSiteId = $data->getCurrentSite()?->getId();
|
||||
|
||||
// Garde sites.manage : la modification de la collection de sites rattaches
|
||||
// a un user est une operation sensible qui requiert une permission distincte
|
||||
// de core.users.manage (evite le bypass de sites.manage via /rbac).
|
||||
if ($sitesWereMutated && !$this->security->isGranted('sites.manage')) {
|
||||
throw new AccessDeniedHttpException(
|
||||
'La modification des sites rattaches a un user requiert la permission sites.manage.'
|
||||
);
|
||||
}
|
||||
|
||||
// Persistance + correction de coherence currentSite dans une seule transaction.
|
||||
// wrapInTransaction rollback automatiquement sur toute exception et la re-lance,
|
||||
// ce qui preserve le comportement attendu pour BadRequestHttpException.
|
||||
$result = null;
|
||||
$this->entityManager->wrapInTransaction(function () use (
|
||||
$data,
|
||||
$operation,
|
||||
$uriVariables,
|
||||
$context,
|
||||
$sitesWereMutated,
|
||||
$originalCurrentSiteId,
|
||||
&$result,
|
||||
): void {
|
||||
$result = $this->persistProcessor->process($data, $operation, $uriVariables, $context);
|
||||
|
||||
// Garde coherence currentSite (ticket 2 module Sites).
|
||||
// Post-persist : le champ `sites` a ete applique par le persist processor.
|
||||
// On s'assure que `currentSite` pointe toujours vers un site present
|
||||
// dans la collection ou est recale automatiquement — mais UNIQUEMENT si
|
||||
// les sites ou le currentSite ont effectivement ete touches dans ce PATCH.
|
||||
$currentSiteChangedByPersist = $originalCurrentSiteId !== $data->getCurrentSite()?->getId();
|
||||
if ($sitesWereMutated || $currentSiteChangedByPersist) {
|
||||
$this->ensureCurrentSiteConsistency($data);
|
||||
}
|
||||
});
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Applique deux corrections post-persist sur `currentSite` :
|
||||
* - si l'actuel n'est plus dans `sites` apres update → repasse a null ;
|
||||
* - si null et `sites` non vide → auto-selectionne le premier site
|
||||
* (coherent avec le choix de ne jamais laisser un user rattache a
|
||||
* plusieurs sites sans contexte courant apres une mutation effective).
|
||||
*
|
||||
* N'emet un flush additionnel que si une correction a ete necessaire :
|
||||
* pas de cout DB sur la majorite des requetes /rbac qui ne touchent pas
|
||||
* aux sites.
|
||||
*
|
||||
* Cette methode ne doit etre appelee que si les sites ont reellement
|
||||
* ete mutes dans la requete courante (voir logique dans process()).
|
||||
*/
|
||||
private function ensureCurrentSiteConsistency(User $user): void
|
||||
{
|
||||
$currentSite = $user->getCurrentSite();
|
||||
$sites = $user->getSites();
|
||||
$changed = false;
|
||||
|
||||
if (null !== $currentSite && !$user->hasSite($currentSite)) {
|
||||
$user->setCurrentSite(null);
|
||||
$changed = true;
|
||||
}
|
||||
|
||||
if (null === $user->getCurrentSite() && !$sites->isEmpty()) {
|
||||
$user->setCurrentSite($sites->first() ?: null);
|
||||
$changed = true;
|
||||
}
|
||||
|
||||
if ($changed) {
|
||||
$this->entityManager->flush();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -8,26 +8,50 @@ use App\Module\Core\Domain\Entity\Role;
|
||||
use App\Module\Core\Domain\Entity\User;
|
||||
use App\Module\Core\Domain\Repository\RoleRepositoryInterface;
|
||||
use App\Module\Core\Domain\Security\SystemRoles;
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use App\Module\Sites\Domain\Repository\SiteRepositoryInterface;
|
||||
use App\Module\Sites\Infrastructure\DataFixtures\SitesFixtures;
|
||||
use Doctrine\Bundle\FixturesBundle\Fixture;
|
||||
use Doctrine\Common\DataFixtures\DependentFixtureInterface;
|
||||
use Doctrine\Persistence\ObjectManager;
|
||||
use RuntimeException;
|
||||
use Symfony\Component\PasswordHasher\Hasher\UserPasswordHasherInterface;
|
||||
|
||||
/**
|
||||
* Fixtures de base du module Core : 3 utilisateurs (1 admin + 2 standards)
|
||||
* rattaches aux roles systeme RBAC seedes par la migration Version20260414150034.
|
||||
* rattaches aux roles systeme RBAC seedes par la migration Version20260414150034,
|
||||
* puis (ticket 2 module Sites) rattaches a au moins un site avec un currentSite
|
||||
* coherent.
|
||||
*
|
||||
* Note : le purger Doctrine execute avant load() supprime l'ensemble des
|
||||
* entites managees, ce qui inclut la table role. On re-seede donc les roles
|
||||
* systeme de maniere idempotente avant de rattacher les utilisateurs, afin
|
||||
* que le workflow "make db-reset && make fixtures" reste one-shot.
|
||||
*
|
||||
* Dependance explicite a SitesFixtures (ticket 2) : les 3 sites Chatellerault,
|
||||
* Saint-Jean et Pommevic doivent etre presents en base avant d'etre rattaches
|
||||
* aux users. L'inversion volontaire de l'ordre (AppFixtures ← SitesFixtures)
|
||||
* casse l'independance declaree au ticket 1 : c'est un couplage assume car
|
||||
* apres ticket 2 le modele metier exprime un besoin legitime de rattachement.
|
||||
*/
|
||||
class AppFixtures extends Fixture
|
||||
class AppFixtures extends Fixture implements DependentFixtureInterface
|
||||
{
|
||||
public function __construct(
|
||||
private readonly UserPasswordHasherInterface $passwordHasher,
|
||||
private readonly RoleRepositoryInterface $roleRepository,
|
||||
private readonly SiteRepositoryInterface $siteRepository,
|
||||
) {}
|
||||
|
||||
/**
|
||||
* @return array<int, class-string>
|
||||
*/
|
||||
public function getDependencies(): array
|
||||
{
|
||||
// SitesFixtures doit tourner AVANT AppFixtures pour que les sites
|
||||
// soient disponibles au rattachement des users ci-dessous.
|
||||
return [SitesFixtures::class];
|
||||
}
|
||||
|
||||
public function load(ObjectManager $manager): void
|
||||
{
|
||||
$adminRole = $this->ensureSystemRole(
|
||||
@@ -43,23 +67,43 @@ class AppFixtures extends Fixture
|
||||
'Role de base sans permission specifique',
|
||||
);
|
||||
|
||||
// Recupere les 3 sites seedes par SitesFixtures. Si absents, c'est
|
||||
// une misconfiguration (fixture hors purge ou dependance ignoree) :
|
||||
// on fail fort avec un message explicite plutot que de continuer
|
||||
// avec des users orphelins de site.
|
||||
$chatellerault = $this->requireSite('Chatellerault');
|
||||
$saintJean = $this->requireSite('Saint-Jean');
|
||||
$pommevic = $this->requireSite('Pommevic');
|
||||
|
||||
$admin = new User();
|
||||
$admin->setUsername('admin');
|
||||
$admin->setIsAdmin(true);
|
||||
$admin->setPassword($this->passwordHasher->hashPassword($admin, 'admin'));
|
||||
$admin->addRbacRole($adminRole);
|
||||
// Admin rattache aux 3 sites pour faciliter le dev / les tests manuels.
|
||||
$admin->addSite($chatellerault);
|
||||
$admin->addSite($saintJean);
|
||||
$admin->addSite($pommevic);
|
||||
$admin->setCurrentSite($chatellerault);
|
||||
$manager->persist($admin);
|
||||
|
||||
$alice = new User();
|
||||
$alice->setUsername('alice');
|
||||
$alice->setPassword($this->passwordHasher->hashPassword($alice, 'alice'));
|
||||
$alice->addRbacRole($userRole);
|
||||
// Alice : un seul site, site courant = ce site.
|
||||
$alice->addSite($chatellerault);
|
||||
$alice->setCurrentSite($chatellerault);
|
||||
$manager->persist($alice);
|
||||
|
||||
$bob = new User();
|
||||
$bob->setUsername('bob');
|
||||
$bob->setPassword($this->passwordHasher->hashPassword($bob, 'bob'));
|
||||
$bob->addRbacRole($userRole);
|
||||
// Bob : site different de Alice, pour prouver le filtrage par site
|
||||
// dans les futurs tests (ticket 4 outillage SiteAware).
|
||||
$bob->addSite($saintJean);
|
||||
$bob->setCurrentSite($saintJean);
|
||||
$manager->persist($bob);
|
||||
|
||||
$manager->flush();
|
||||
@@ -90,4 +134,19 @@ class AppFixtures extends Fixture
|
||||
|
||||
return $role;
|
||||
}
|
||||
|
||||
private function requireSite(string $name): Site
|
||||
{
|
||||
$site = $this->siteRepository->findByName($name);
|
||||
|
||||
if (null === $site) {
|
||||
throw new RuntimeException(sprintf(
|
||||
'SitesFixtures doit avoir seede le site "%s" avant le chargement des users. '
|
||||
.'Verifier que SitesFixtures est bien en dependance de AppFixtures.',
|
||||
$name,
|
||||
));
|
||||
}
|
||||
|
||||
return $site;
|
||||
}
|
||||
}
|
||||
|
||||
69
src/Module/Sites/Application/Service/CurrentSiteProvider.php
Normal file
69
src/Module/Sites/Application/Service/CurrentSiteProvider.php
Normal file
@@ -0,0 +1,69 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Module\Sites\Application\Service;
|
||||
|
||||
use App\Module\Core\Domain\Entity\User;
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use App\Module\Sites\SitesModule;
|
||||
use Symfony\Bundle\SecurityBundle\Security;
|
||||
use Symfony\Component\DependencyInjection\Attribute\Autowire;
|
||||
|
||||
use function in_array;
|
||||
|
||||
/**
|
||||
* Resout le site courant de l'utilisateur authentifie pour les besoins de
|
||||
* l'outillage opt-in "site-aware" (ticket 4 module Sites).
|
||||
*
|
||||
* Consomme par :
|
||||
* - SiteScopedQueryExtension : filtrage automatique des collections API.
|
||||
* - SiteAwareInjectionProcessor : injection automatique sur POST/PATCH.
|
||||
*
|
||||
* Retourne `null` dans trois cas distincts (chacun volontairement
|
||||
* silencieux pour que les extensions/processor deviennent no-op sans
|
||||
* erreur visible) :
|
||||
* 1. Le module Sites est desactive dans `config/modules.php`.
|
||||
* 2. Aucun user n'est authentifie (appel depuis un endpoint public).
|
||||
* 3. L'user authentifie n'a pas de `currentSite` positionne (cas rare
|
||||
* grace a la garde `UserRbacProcessor::ensureCurrentSiteConsistency`).
|
||||
*
|
||||
* Le flag `sitesActive` est calcule UNE FOIS au boot du service pour
|
||||
* eviter un `require` a chaque resolution.
|
||||
*/
|
||||
final class CurrentSiteProvider implements CurrentSiteProviderInterface
|
||||
{
|
||||
private readonly bool $sitesActive;
|
||||
|
||||
public function __construct(
|
||||
private readonly Security $security,
|
||||
#[Autowire(param: 'kernel.project_dir')]
|
||||
string $projectDir,
|
||||
) {
|
||||
// Lit config/modules.php (tableau de FQCN) et verifie la presence
|
||||
// de SitesModule::class. Pattern aligne sur ModulesProvider.
|
||||
$configPath = $projectDir.'/config/modules.php';
|
||||
$moduleClasses = file_exists($configPath) ? require $configPath : [];
|
||||
|
||||
$this->sitesActive = in_array(SitesModule::class, $moduleClasses, true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retourne le site courant de l'utilisateur authentifie, ou null si
|
||||
* l'une des 3 conditions de desactivation est remplie (cf. docblock
|
||||
* de classe).
|
||||
*/
|
||||
public function get(): ?Site
|
||||
{
|
||||
if (!$this->sitesActive) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$user = $this->security->getUser();
|
||||
if (!$user instanceof User) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return $user->getCurrentSite();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Module\Sites\Application\Service;
|
||||
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
|
||||
/**
|
||||
* Contrat de resolution du site courant pour l'outillage opt-in
|
||||
* "site-aware" (ticket 4 module Sites).
|
||||
*
|
||||
* Facilite le test de l'extension et du processor en permettant un mock
|
||||
* sans dependre de l'implementation concrete (qui garde `final` pour
|
||||
* l'immutabilite du service en prod).
|
||||
*
|
||||
* Retourne `null` dans trois cas (cf. CurrentSiteProvider) :
|
||||
* - module Sites desactive dans config/modules.php
|
||||
* - pas d'user authentifie
|
||||
* - user sans currentSite positionne
|
||||
*/
|
||||
interface CurrentSiteProviderInterface
|
||||
{
|
||||
public function get(): ?Site;
|
||||
}
|
||||
338
src/Module/Sites/Domain/Entity/Site.php
Normal file
338
src/Module/Sites/Domain/Entity/Site.php
Normal file
@@ -0,0 +1,338 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Module\Sites\Domain\Entity;
|
||||
|
||||
use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
|
||||
use ApiPlatform\Metadata\ApiFilter;
|
||||
use ApiPlatform\Metadata\ApiResource;
|
||||
use ApiPlatform\Metadata\Delete;
|
||||
use ApiPlatform\Metadata\Get;
|
||||
use ApiPlatform\Metadata\GetCollection;
|
||||
use ApiPlatform\Metadata\Patch;
|
||||
use ApiPlatform\Metadata\Post;
|
||||
use App\Module\Core\Domain\Entity\User;
|
||||
use App\Module\Sites\Infrastructure\Doctrine\DoctrineSiteRepository;
|
||||
use App\Shared\Domain\Contract\SiteInterface;
|
||||
use DateTimeImmutable;
|
||||
use Doctrine\Common\Collections\ArrayCollection;
|
||||
use Doctrine\Common\Collections\Collection;
|
||||
use Doctrine\DBAL\Types\Types;
|
||||
use Doctrine\ORM\Mapping as ORM;
|
||||
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
|
||||
use Symfony\Component\Serializer\Attribute\Groups;
|
||||
use Symfony\Component\Validator\Constraints as Assert;
|
||||
|
||||
/**
|
||||
* Site physique (usine / etablissement) appartenant a l'instance Coltura.
|
||||
*
|
||||
* Adresse decomposee en champs structures (rue, complement, CP, ville) pour
|
||||
* permettre des recherches/tris fins ulterieurs et eviter les divergences
|
||||
* entre champs duplique. La methode `getFullAddress()` fournit la version
|
||||
* concatenee multi-lignes pour les usages d'affichage.
|
||||
*
|
||||
* Expose en API Platform pour l'administration CRUD avec RBAC :
|
||||
* - lecture (GET list / item) : requiert la permission `sites.view`
|
||||
* - ecriture (POST / PATCH / DELETE) : requiert la permission `sites.manage`
|
||||
*
|
||||
* Egalement embarque dans la reponse `/api/me` (groupe `me:read`) pour que
|
||||
* le frontend connaisse les sites autorises et le site courant de l'user.
|
||||
*/
|
||||
#[ApiResource(
|
||||
operations: [
|
||||
new GetCollection(
|
||||
normalizationContext: ['groups' => ['site:read']],
|
||||
security: "is_granted('sites.view')",
|
||||
),
|
||||
new Get(
|
||||
normalizationContext: ['groups' => ['site:read']],
|
||||
security: "is_granted('sites.view')",
|
||||
),
|
||||
new Post(
|
||||
normalizationContext: ['groups' => ['site:read']],
|
||||
denormalizationContext: ['groups' => ['site:write']],
|
||||
security: "is_granted('sites.manage')",
|
||||
),
|
||||
new Patch(
|
||||
normalizationContext: ['groups' => ['site:read']],
|
||||
denormalizationContext: ['groups' => ['site:write']],
|
||||
security: "is_granted('sites.manage')",
|
||||
),
|
||||
new Delete(security: "is_granted('sites.manage')"),
|
||||
],
|
||||
normalizationContext: ['groups' => ['site:read']],
|
||||
denormalizationContext: ['groups' => ['site:write']],
|
||||
)]
|
||||
// Filtres cote API pour /admin/sites : recherche partielle insensible a
|
||||
// la casse (SQL ILIKE %x%) sur les champs texte saisis dans les headers
|
||||
// de la DataTable. postalCode est purement numerique donc le I/partial
|
||||
// donne le meme resultat, mais on reste coherent avec name/city.
|
||||
#[ApiFilter(SearchFilter::class, properties: [
|
||||
'name' => 'ipartial',
|
||||
'city' => 'ipartial',
|
||||
'postalCode' => 'ipartial',
|
||||
])]
|
||||
#[ORM\Entity(repositoryClass: DoctrineSiteRepository::class)]
|
||||
#[ORM\Table(name: 'site')]
|
||||
#[ORM\UniqueConstraint(name: 'uniq_site_name', columns: ['name'])]
|
||||
#[ORM\HasLifecycleCallbacks]
|
||||
#[UniqueEntity(fields: ['name'], message: 'Un site avec ce nom existe deja.')]
|
||||
class Site implements SiteInterface
|
||||
{
|
||||
#[ORM\Id]
|
||||
#[ORM\GeneratedValue]
|
||||
#[ORM\Column]
|
||||
#[Groups(['site:read', 'me:read'])]
|
||||
private ?int $id = null;
|
||||
|
||||
#[ORM\Column(length: 100)]
|
||||
#[Assert\NotBlank(message: 'Le nom du site est requis.')]
|
||||
#[Assert\Length(max: 100, maxMessage: 'Le nom du site ne peut pas depasser {{ limit }} caracteres.')]
|
||||
#[Groups(['site:read', 'site:write', 'me:read'])]
|
||||
private string $name;
|
||||
|
||||
// Premiere ligne d'adresse : numero + voie. Requise.
|
||||
#[ORM\Column(length: 255)]
|
||||
#[Assert\NotBlank(message: 'La rue est requise.')]
|
||||
#[Assert\Length(max: 255, maxMessage: 'La rue ne peut pas depasser {{ limit }} caracteres.')]
|
||||
#[Groups(['site:read', 'site:write', 'me:read'])]
|
||||
private string $street;
|
||||
|
||||
// Complement d'adresse optionnel : batiment, escalier, BP, etc.
|
||||
#[ORM\Column(length: 255, nullable: true)]
|
||||
#[Assert\Length(max: 255, maxMessage: 'Le complement ne peut pas depasser {{ limit }} caracteres.')]
|
||||
#[Groups(['site:read', 'site:write', 'me:read'])]
|
||||
private ?string $complement = null;
|
||||
|
||||
// Colonne mappee sur le snake_case PostgreSQL (convention projet : noms de
|
||||
// colonnes en minuscules dans le SQL brut). Le format est contraint au
|
||||
// code postal francais strict : 5 chiffres numeriques.
|
||||
#[ORM\Column(name: 'postal_code', length: 10)]
|
||||
#[Assert\NotBlank(message: 'Le code postal est requis.')]
|
||||
#[Assert\Length(max: 10, maxMessage: 'Le code postal ne peut pas depasser {{ limit }} caracteres.')]
|
||||
#[Assert\Regex(
|
||||
pattern: '/^\d{5}$/',
|
||||
message: 'Le code postal doit etre compose de 5 chiffres (format FR).',
|
||||
)]
|
||||
#[Groups(['site:read', 'site:write', 'me:read'])]
|
||||
private string $postalCode;
|
||||
|
||||
#[ORM\Column(length: 100)]
|
||||
#[Assert\NotBlank(message: 'La ville du site est requise.')]
|
||||
#[Assert\Length(max: 100, maxMessage: 'La ville ne peut pas depasser {{ limit }} caracteres.')]
|
||||
#[Groups(['site:read', 'site:write', 'me:read'])]
|
||||
private string $city;
|
||||
|
||||
// Couleur d'identification visuelle du site au format hex #RRGGBB (7 chars
|
||||
// incluant le diese). Utilisee par la navbar (ticket 3) pour distinguer
|
||||
// les sites d'un coup d'oeil.
|
||||
#[ORM\Column(length: 7)]
|
||||
#[Assert\NotBlank(message: 'La couleur est requise.')]
|
||||
#[Assert\Regex(
|
||||
pattern: '/^#[0-9A-Fa-f]{6}$/',
|
||||
message: 'La couleur doit etre un code hex de 7 caracteres au format #RRGGBB.',
|
||||
)]
|
||||
#[Groups(['site:read', 'site:write', 'me:read'])]
|
||||
private string $color;
|
||||
|
||||
// createdAt / updatedAt volontairement exclus du groupe `me:read` :
|
||||
// le payload `/api/me` doit rester leger, ces metadonnees ne sont utiles
|
||||
// qu'a l'admin (exposees uniquement via `site:read` sur /api/sites).
|
||||
#[ORM\Column(name: 'created_at', type: Types::DATETIME_IMMUTABLE)]
|
||||
#[Groups(['site:read'])]
|
||||
private DateTimeImmutable $createdAt;
|
||||
|
||||
#[ORM\Column(name: 'updated_at', type: Types::DATETIME_IMMUTABLE)]
|
||||
#[Groups(['site:read'])]
|
||||
private DateTimeImmutable $updatedAt;
|
||||
|
||||
/**
|
||||
* Collection inverse des users rattaches a ce site.
|
||||
*
|
||||
* Volontairement SANS `#[Groups]` : la collection n'est jamais exposee via
|
||||
* l'API pour deux raisons :
|
||||
* - eviter une boucle de serialisation infinie User → sites → users → ...
|
||||
* si un jour un developpeur ajoute `me:read` ici par megarde ;
|
||||
* - l'inverse n'a de valeur qu'en interne (compter les users d'un site,
|
||||
* iterer en test de cascade).
|
||||
*
|
||||
* @var Collection<int, User>
|
||||
*/
|
||||
#[ORM\ManyToMany(targetEntity: User::class, mappedBy: 'sites')]
|
||||
private Collection $users;
|
||||
|
||||
public function __construct(
|
||||
string $name,
|
||||
string $street,
|
||||
?string $complement,
|
||||
string $postalCode,
|
||||
string $city,
|
||||
string $color,
|
||||
) {
|
||||
$this->name = $name;
|
||||
$this->street = $street;
|
||||
$this->complement = $complement;
|
||||
$this->postalCode = $postalCode;
|
||||
$this->city = $city;
|
||||
$this->color = $color;
|
||||
$now = new DateTimeImmutable();
|
||||
$this->createdAt = $now;
|
||||
$this->updatedAt = $now;
|
||||
$this->users = new ArrayCollection();
|
||||
}
|
||||
|
||||
/**
|
||||
* Callback Doctrine : a chaque update en base on rafraichit updatedAt.
|
||||
* Ne pas toucher a createdAt ici (immutable apres creation).
|
||||
*/
|
||||
#[ORM\PreUpdate]
|
||||
public function onPreUpdate(): void
|
||||
{
|
||||
$this->updatedAt = new DateTimeImmutable();
|
||||
}
|
||||
|
||||
public function getId(): ?int
|
||||
{
|
||||
return $this->id;
|
||||
}
|
||||
|
||||
public function getName(): string
|
||||
{
|
||||
return $this->name;
|
||||
}
|
||||
|
||||
public function setName(string $name): static
|
||||
{
|
||||
$this->name = $name;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function getStreet(): string
|
||||
{
|
||||
return $this->street;
|
||||
}
|
||||
|
||||
public function setStreet(string $street): static
|
||||
{
|
||||
$this->street = $street;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function getComplement(): ?string
|
||||
{
|
||||
return $this->complement;
|
||||
}
|
||||
|
||||
public function setComplement(?string $complement): static
|
||||
{
|
||||
$this->complement = $complement;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function getPostalCode(): string
|
||||
{
|
||||
return $this->postalCode;
|
||||
}
|
||||
|
||||
public function setPostalCode(string $postalCode): static
|
||||
{
|
||||
$this->postalCode = $postalCode;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function getCity(): string
|
||||
{
|
||||
return $this->city;
|
||||
}
|
||||
|
||||
public function setCity(string $city): static
|
||||
{
|
||||
$this->city = $city;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function getColor(): string
|
||||
{
|
||||
return $this->color;
|
||||
}
|
||||
|
||||
public function setColor(string $color): static
|
||||
{
|
||||
$this->color = $color;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Adresse complete reconstituee : street, [complement,] {CP} {ville},
|
||||
* separes par des sauts de ligne. Methode pure, jamais persistee.
|
||||
*
|
||||
* Expose en lecture API (groupes site:read + me:read) pour que les
|
||||
* consommateurs (frontend, exports PDF) recoivent une adresse prete a
|
||||
* afficher sans dupliquer la logique de concatenation cote client.
|
||||
*/
|
||||
#[Groups(['site:read', 'me:read'])]
|
||||
public function getFullAddress(): string
|
||||
{
|
||||
$lines = [$this->street];
|
||||
|
||||
if (null !== $this->complement && '' !== trim($this->complement)) {
|
||||
$lines[] = $this->complement;
|
||||
}
|
||||
|
||||
$lines[] = sprintf('%s %s', $this->postalCode, $this->city);
|
||||
|
||||
return implode("\n", $lines);
|
||||
}
|
||||
|
||||
public function getCreatedAt(): DateTimeImmutable
|
||||
{
|
||||
return $this->createdAt;
|
||||
}
|
||||
|
||||
public function getUpdatedAt(): DateTimeImmutable
|
||||
{
|
||||
return $this->updatedAt;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Collection<int, User>
|
||||
*/
|
||||
public function getUsers(): Collection
|
||||
{
|
||||
return $this->users;
|
||||
}
|
||||
|
||||
/**
|
||||
* Synchronise la collection inverse cote Site quand User::addSite est
|
||||
* appele. Idempotent. Ne re-appelle pas $user->addSite($this) pour
|
||||
* eviter une recursion infinie : User::addSite est le point d'entree
|
||||
* unique de la mutation.
|
||||
*
|
||||
* @internal Appele uniquement par User::addSite()
|
||||
*/
|
||||
public function addUser(User $user): static
|
||||
{
|
||||
if (!$this->users->contains($user)) {
|
||||
$this->users->add($user);
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @internal Appele uniquement par User::removeSite()
|
||||
*/
|
||||
public function removeUser(User $user): static
|
||||
{
|
||||
$this->users->removeElement($user);
|
||||
|
||||
return $this;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,18 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Module\Sites\Domain\Exception;
|
||||
|
||||
use App\Shared\Domain\Exception\SiteNotAuthorizedException as SharedSiteNotAuthorizedException;
|
||||
|
||||
/**
|
||||
* Alias de retrocompatibilite vers Shared\Domain\Exception\SiteNotAuthorizedException.
|
||||
*
|
||||
* La classe canonique a ete deplacee dans Shared pour rompre le couplage
|
||||
* Core → Sites. Les consommateurs existants dans le module Sites
|
||||
* (CurrentSiteProcessor) continuent de l'attraper ici sans modification.
|
||||
*
|
||||
* @see SharedSiteNotAuthorizedException
|
||||
*/
|
||||
final class SiteNotAuthorizedException extends SharedSiteNotAuthorizedException {}
|
||||
@@ -0,0 +1,23 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Module\Sites\Domain\Repository;
|
||||
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
|
||||
interface SiteRepositoryInterface
|
||||
{
|
||||
public function findById(int $id): ?Site;
|
||||
|
||||
public function findByName(string $name): ?Site;
|
||||
|
||||
/**
|
||||
* @return list<Site>
|
||||
*/
|
||||
public function findAllOrderedByName(): array;
|
||||
|
||||
public function save(Site $site): void;
|
||||
|
||||
public function remove(Site $site): void;
|
||||
}
|
||||
@@ -0,0 +1,110 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Module\Sites\Infrastructure\ApiPlatform\Extension;
|
||||
|
||||
use ApiPlatform\Doctrine\Orm\Extension\QueryCollectionExtensionInterface;
|
||||
use ApiPlatform\Doctrine\Orm\Extension\QueryItemExtensionInterface;
|
||||
use ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface;
|
||||
use ApiPlatform\Metadata\Operation;
|
||||
use App\Module\Core\Domain\Entity\User;
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use Doctrine\ORM\QueryBuilder;
|
||||
use Symfony\Bundle\SecurityBundle\Security;
|
||||
|
||||
use function sprintf;
|
||||
|
||||
/**
|
||||
* Extension API Platform qui restreint les collections et items de la
|
||||
* resource Site (/api/sites) aux seuls sites auxquels l'utilisateur
|
||||
* authentifie est rattache (ticket module Sites — prevention de la fuite
|
||||
* de donnees cross-tenant).
|
||||
*
|
||||
* `Site` n'implemente pas `SiteAwareInterface` (ce serait circulaire : un
|
||||
* site ne s'appartient pas a lui-meme). Cette extension complementaire
|
||||
* cible specifiquement `Site::class` et applique un filtre IN sur les IDs
|
||||
* des sites de l'utilisateur.
|
||||
*
|
||||
* Comportement selon les cas :
|
||||
* - resource != Site::class → no-op (les autres resources sont
|
||||
* gerees par SiteScopedQueryExtension) ;
|
||||
* - is_granted('sites.bypass_scope') → pas de filtre (admin / bypass) ;
|
||||
* - user non authentifie → no-op (API Platform renvoie 401 avant) ;
|
||||
* - user sans aucun site → WHERE 1 = 0 (aucun acces) ;
|
||||
* - cas normal → WHERE site.id IN (:allowedSites).
|
||||
*
|
||||
* Consequence anti-enumeration : GET /api/sites/{id} retourne 404 et non
|
||||
* 403 si l'item existe mais n'appartient pas aux sites de l'utilisateur
|
||||
* (comportement natif API Platform quand Doctrine retourne null).
|
||||
*/
|
||||
final class SiteCollectionScopedExtension implements QueryCollectionExtensionInterface, QueryItemExtensionInterface
|
||||
{
|
||||
public function __construct(
|
||||
private readonly Security $security,
|
||||
) {}
|
||||
|
||||
public function applyToCollection(
|
||||
QueryBuilder $queryBuilder,
|
||||
QueryNameGeneratorInterface $queryNameGenerator,
|
||||
string $resourceClass,
|
||||
?Operation $operation = null,
|
||||
array $context = [],
|
||||
): void {
|
||||
$this->applyScope($queryBuilder, $queryNameGenerator, $resourceClass);
|
||||
}
|
||||
|
||||
public function applyToItem(
|
||||
QueryBuilder $queryBuilder,
|
||||
QueryNameGeneratorInterface $queryNameGenerator,
|
||||
string $resourceClass,
|
||||
array $identifiers,
|
||||
?Operation $operation = null,
|
||||
array $context = [],
|
||||
): void {
|
||||
$this->applyScope($queryBuilder, $queryNameGenerator, $resourceClass);
|
||||
}
|
||||
|
||||
/**
|
||||
* Applique le filtre IN sur les IDs de sites autorises si les conditions
|
||||
* d'application sont remplies. No-op sinon.
|
||||
*/
|
||||
private function applyScope(
|
||||
QueryBuilder $queryBuilder,
|
||||
QueryNameGeneratorInterface $queryNameGenerator,
|
||||
string $resourceClass,
|
||||
): void {
|
||||
// 1) Cette extension cible uniquement la resource Site.
|
||||
if (Site::class !== $resourceClass) {
|
||||
return;
|
||||
}
|
||||
|
||||
// 2) Admin ou user avec bypass explicite : visibilite globale.
|
||||
if ($this->security->isGranted('sites.bypass_scope')) {
|
||||
return;
|
||||
}
|
||||
|
||||
// 3) Pas d'user authentifie -> no-op (API Platform gere le 401 en amont).
|
||||
$user = $this->security->getUser();
|
||||
if (!$user instanceof User) {
|
||||
return;
|
||||
}
|
||||
|
||||
$rootAlias = $queryBuilder->getRootAliases()[0];
|
||||
|
||||
// 4) User sans aucun site rattache -> aucun acces possible.
|
||||
$siteIds = $user->getSites()->map(fn (Site $s) => $s->getId())->toArray();
|
||||
if (empty($siteIds)) {
|
||||
$queryBuilder->andWhere('1 = 0');
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// 5) Cas normal : restriction aux sites autorises de l'utilisateur.
|
||||
$param = $queryNameGenerator->generateParameterName('allowedSites');
|
||||
$queryBuilder
|
||||
->andWhere(sprintf('%s.id IN (:%s)', $rootAlias, $param))
|
||||
->setParameter($param, $siteIds)
|
||||
;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,108 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Module\Sites\Infrastructure\ApiPlatform\Extension;
|
||||
|
||||
use ApiPlatform\Doctrine\Orm\Extension\QueryCollectionExtensionInterface;
|
||||
use ApiPlatform\Doctrine\Orm\Extension\QueryItemExtensionInterface;
|
||||
use ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface;
|
||||
use ApiPlatform\Metadata\Operation;
|
||||
use App\Module\Sites\Application\Service\CurrentSiteProviderInterface;
|
||||
use App\Shared\Domain\Contract\SiteAwareInterface;
|
||||
use Doctrine\ORM\QueryBuilder;
|
||||
use Symfony\Bundle\SecurityBundle\Security;
|
||||
|
||||
use function is_subclass_of;
|
||||
use function sprintf;
|
||||
|
||||
/**
|
||||
* Extension API Platform qui filtre automatiquement les collections et les
|
||||
* items des resources implementant SiteAwareInterface selon le site
|
||||
* courant de l'utilisateur authentifie (ticket 4 module Sites).
|
||||
*
|
||||
* Appliquee automatiquement par API Platform sur toutes les requetes GET
|
||||
* (collection + item), mais devient no-op si :
|
||||
* - la resource cible n'implemente pas SiteAwareInterface ;
|
||||
* - l'user a la permission `sites.bypass_scope` ;
|
||||
* - CurrentSiteProvider::get() retourne null (module desactive, pas
|
||||
* d'user authentifie, ou user sans currentSite).
|
||||
*
|
||||
* Le filtrage est identique pour les deux interfaces Collection et Item,
|
||||
* factorise dans `applyScope()`. Consequence sur GET /api/resource/{id} :
|
||||
* si l'item existe en base mais appartient a un autre site, Doctrine
|
||||
* retourne null apres filtrage et API Platform converti en 404
|
||||
* (anti-enumeration : le user ne peut pas distinguer "n'existe pas" de
|
||||
* "appartient a un autre site").
|
||||
*/
|
||||
final class SiteScopedQueryExtension implements QueryCollectionExtensionInterface, QueryItemExtensionInterface
|
||||
{
|
||||
public function __construct(
|
||||
private readonly CurrentSiteProviderInterface $currentSiteProvider,
|
||||
private readonly Security $security,
|
||||
) {}
|
||||
|
||||
public function applyToCollection(
|
||||
QueryBuilder $queryBuilder,
|
||||
QueryNameGeneratorInterface $queryNameGenerator,
|
||||
string $resourceClass,
|
||||
?Operation $operation = null,
|
||||
array $context = [],
|
||||
): void {
|
||||
$this->applyScope($queryBuilder, $queryNameGenerator, $resourceClass);
|
||||
}
|
||||
|
||||
public function applyToItem(
|
||||
QueryBuilder $queryBuilder,
|
||||
QueryNameGeneratorInterface $queryNameGenerator,
|
||||
string $resourceClass,
|
||||
array $identifiers,
|
||||
?Operation $operation = null,
|
||||
array $context = [],
|
||||
): void {
|
||||
$this->applyScope($queryBuilder, $queryNameGenerator, $resourceClass);
|
||||
}
|
||||
|
||||
/**
|
||||
* Ajoute la clause `WHERE <alias>.site = :currentSite` au query builder
|
||||
* si les 3 conditions d'application sont remplies. No-op sinon.
|
||||
*/
|
||||
private function applyScope(
|
||||
QueryBuilder $queryBuilder,
|
||||
QueryNameGeneratorInterface $queryNameGenerator,
|
||||
string $resourceClass,
|
||||
): void {
|
||||
// 1) Filtrer uniquement les resources qui ont opt-in via l'interface.
|
||||
// `is_subclass_of` gere a la fois `implements` direct et herite.
|
||||
if (!is_subclass_of($resourceClass, SiteAwareInterface::class)) {
|
||||
return;
|
||||
}
|
||||
|
||||
// 2) Admin ou user avec bypass explicite : visibilite globale.
|
||||
// is_granted('sites.bypass_scope') retourne true pour les admins
|
||||
// (bypass total via isAdmin) meme sans permission explicite.
|
||||
if ($this->security->isGranted('sites.bypass_scope')) {
|
||||
return;
|
||||
}
|
||||
|
||||
// 3) Pas de site courant -> no-op plutot que collection vide.
|
||||
// Decision assumee (cf. ticket 4 spec Risque 1) : un user sans
|
||||
// currentSite voit tout. L'alternative "collection vide" est
|
||||
// rejetee car elle rendrait l'app inutilisable pour un user
|
||||
// mal configure.
|
||||
$currentSite = $this->currentSiteProvider->get();
|
||||
if (null === $currentSite) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Application du filtre : alias racine du QueryBuilder, parametre
|
||||
// genere pour eviter les collisions avec d'autres extensions.
|
||||
$rootAlias = $queryBuilder->getRootAliases()[0];
|
||||
$parameterName = $queryNameGenerator->generateParameterName('currentSite');
|
||||
|
||||
$queryBuilder
|
||||
->andWhere(sprintf('%s.site = :%s', $rootAlias, $parameterName))
|
||||
->setParameter($parameterName, $currentSite)
|
||||
;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,116 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Module\Sites\Infrastructure\ApiPlatform\Extension;
|
||||
|
||||
use ApiPlatform\Doctrine\Orm\Extension\QueryCollectionExtensionInterface;
|
||||
use ApiPlatform\Doctrine\Orm\Extension\QueryItemExtensionInterface;
|
||||
use ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface;
|
||||
use ApiPlatform\Metadata\Operation;
|
||||
use App\Module\Core\Domain\Entity\User;
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use Doctrine\ORM\QueryBuilder;
|
||||
use Symfony\Bundle\SecurityBundle\Security;
|
||||
|
||||
use function sprintf;
|
||||
|
||||
/**
|
||||
* Extension API Platform qui restreint /api/users (collection + item) aux
|
||||
* utilisateurs partageant au moins un site commun avec l'appelant.
|
||||
*
|
||||
* Objectif : empecher l'enumeration cross-site des utilisateurs. Sans ce
|
||||
* filtre, un user du site A pourrait lister tous les users du site B via
|
||||
* GET /api/users.
|
||||
*
|
||||
* Conditions de bypass :
|
||||
* - is_granted('sites.bypass_scope') → visibilite totale (admin ou bypass
|
||||
* explicite) ;
|
||||
* - user non authentifie → no-op (API Platform renvoie 401) ;
|
||||
*
|
||||
* Cas particulier — appelant sans aucun site rattache :
|
||||
* Comportement defensif : l'utilisateur ne voit que lui-meme. Cela evite
|
||||
* de bloquer completement un user mal configure tout en ne lui revelant
|
||||
* aucun autre utilisateur.
|
||||
*
|
||||
* Strategie DQL : JOIN sur la relation ManyToMany `.sites` + DISTINCT pour
|
||||
* eviter les doublons si un user partage plusieurs sites avec l'appelant.
|
||||
* Le alias `s_scope` est utilise pour la jointure intermediaire.
|
||||
*/
|
||||
final class UserSiteScopedExtension implements QueryCollectionExtensionInterface, QueryItemExtensionInterface
|
||||
{
|
||||
public function __construct(
|
||||
private readonly Security $security,
|
||||
) {}
|
||||
|
||||
public function applyToCollection(
|
||||
QueryBuilder $queryBuilder,
|
||||
QueryNameGeneratorInterface $queryNameGenerator,
|
||||
string $resourceClass,
|
||||
?Operation $operation = null,
|
||||
array $context = [],
|
||||
): void {
|
||||
$this->applyScope($queryBuilder, $queryNameGenerator, $resourceClass);
|
||||
}
|
||||
|
||||
public function applyToItem(
|
||||
QueryBuilder $queryBuilder,
|
||||
QueryNameGeneratorInterface $queryNameGenerator,
|
||||
string $resourceClass,
|
||||
array $identifiers,
|
||||
?Operation $operation = null,
|
||||
array $context = [],
|
||||
): void {
|
||||
$this->applyScope($queryBuilder, $queryNameGenerator, $resourceClass);
|
||||
}
|
||||
|
||||
/**
|
||||
* Applique le filtre de partage de site si les conditions d'application
|
||||
* sont remplies. No-op sinon.
|
||||
*/
|
||||
private function applyScope(
|
||||
QueryBuilder $queryBuilder,
|
||||
QueryNameGeneratorInterface $queryNameGenerator,
|
||||
string $resourceClass,
|
||||
): void {
|
||||
// 1) Cette extension cible uniquement la resource User.
|
||||
if (User::class !== $resourceClass) {
|
||||
return;
|
||||
}
|
||||
|
||||
// 2) Admin ou bypass explicite : visibilite totale.
|
||||
if ($this->security->isGranted('sites.bypass_scope')) {
|
||||
return;
|
||||
}
|
||||
|
||||
// 3) Pas d'user authentifie -> no-op (API Platform gere le 401 en amont).
|
||||
$user = $this->security->getUser();
|
||||
if (!$user instanceof User) {
|
||||
return;
|
||||
}
|
||||
|
||||
$rootAlias = $queryBuilder->getRootAliases()[0];
|
||||
$callerSiteIds = $user->getSites()->map(fn (Site $s) => $s->getId())->toArray();
|
||||
|
||||
// 4) Appelant sans site : comportement defensif -> il ne voit que lui-meme.
|
||||
if (empty($callerSiteIds)) {
|
||||
$queryBuilder
|
||||
->andWhere(sprintf('%s.id = :self', $rootAlias))
|
||||
->setParameter('self', $user->getId())
|
||||
;
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// 5) Cas normal : garder uniquement les users qui partagent au moins
|
||||
// un site avec l'appelant. JOIN sur la relation ManyToMany `.sites`
|
||||
// + filtre IN + DISTINCT pour eviter les lignes dupliquees.
|
||||
$param = $queryNameGenerator->generateParameterName('callerSites');
|
||||
$queryBuilder
|
||||
->innerJoin(sprintf('%s.sites', $rootAlias), 's_scope')
|
||||
->andWhere(sprintf('s_scope.id IN (:%s)', $param))
|
||||
->setParameter($param, $callerSiteIds)
|
||||
->distinct()
|
||||
;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,53 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Module\Sites\Infrastructure\ApiPlatform\Resource;
|
||||
|
||||
use ApiPlatform\Metadata\ApiResource;
|
||||
use ApiPlatform\Metadata\Patch;
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use App\Module\Sites\Infrastructure\ApiPlatform\State\Processor\CurrentSiteProcessor;
|
||||
use Symfony\Component\Serializer\Attribute\Groups;
|
||||
|
||||
/**
|
||||
* Ressource API Platform virtuelle (non mappee Doctrine) qui porte
|
||||
* l'operation `PATCH /api/me/current-site` : basculement du site courant
|
||||
* de l'utilisateur authentifie.
|
||||
*
|
||||
* `read: false` informe API Platform qu'il ne doit pas tenter de charger
|
||||
* une entite existante via un Provider — l'operation denormalise le payload
|
||||
* directement dans cette ressource, puis CurrentSiteProcessor prend le relais.
|
||||
*
|
||||
* `shortName: 'CurrentSite'` : evite toute collision avec l'entite `Site`
|
||||
* dans le routage et la documentation OpenAPI.
|
||||
*
|
||||
* Securite : l'autorisation "ROLE_USER" suffit au niveau voter — la verification
|
||||
* fine (le site demande fait-il partie des sites autorises de l'user ?)
|
||||
* est faite par CurrentSiteProcessor, car elle dependence de l'user
|
||||
* authentifie, pas d'une permission statique.
|
||||
*/
|
||||
#[ApiResource(
|
||||
shortName: 'CurrentSite',
|
||||
operations: [
|
||||
new Patch(
|
||||
uriTemplate: '/me/current-site',
|
||||
security: "is_granted('ROLE_USER')",
|
||||
normalizationContext: ['groups' => ['me:read']],
|
||||
denormalizationContext: ['groups' => ['current-site:write']],
|
||||
processor: CurrentSiteProcessor::class,
|
||||
read: false,
|
||||
priority: 1,
|
||||
),
|
||||
],
|
||||
)]
|
||||
final class CurrentSiteResource
|
||||
{
|
||||
/**
|
||||
* Site cible du switch, denormalise depuis l'IRI envoye dans le body :
|
||||
* `{ "site": "/api/sites/{id}" }`. Resolu automatiquement par
|
||||
* l'IriConverter d'API Platform en instance de `Site`.
|
||||
*/
|
||||
#[Groups(['current-site:write'])]
|
||||
public ?Site $site = null;
|
||||
}
|
||||
@@ -0,0 +1,99 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Module\Sites\Infrastructure\ApiPlatform\State\Processor;
|
||||
|
||||
use ApiPlatform\Metadata\Operation;
|
||||
use ApiPlatform\State\ProcessorInterface;
|
||||
use App\Module\Core\Domain\Entity\User;
|
||||
use App\Module\Sites\Domain\Exception\SiteNotAuthorizedException;
|
||||
use App\Module\Sites\Infrastructure\ApiPlatform\Resource\CurrentSiteResource;
|
||||
use Doctrine\ORM\EntityManagerInterface;
|
||||
use Doctrine\ORM\OptimisticLockException;
|
||||
use LogicException;
|
||||
use Symfony\Bundle\SecurityBundle\Security;
|
||||
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
|
||||
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
|
||||
|
||||
/**
|
||||
* Processor de l'operation `PATCH /api/me/current-site`.
|
||||
*
|
||||
* Flux :
|
||||
* 1. Recupere l'user authentifie via Security.
|
||||
* 2. Extrait le site cible depuis la ressource denormalisee.
|
||||
* 3. Refresh de l'user depuis la BDD pour eliminer la race condition TOCTOU :
|
||||
* si un autre thread a revoque le site entre le chargement de session et
|
||||
* ce PATCH, le refresh garantit que hasSite() reflete l'etat reel en base.
|
||||
* 4. Valide que le site fait partie des `sites` de l'user — sinon leve
|
||||
* SiteNotAuthorizedException convertie immediatement en 403.
|
||||
* 5. Positionne `currentSite`, flush, retourne l'user pour normalisation
|
||||
* par API Platform via les groupes `me:read` (payload identique a /api/me).
|
||||
*
|
||||
* Les etapes 3-5 sont executees dans une meme transaction pour garantir
|
||||
* un rollback propre en cas d'erreur entre le refresh et le flush.
|
||||
*
|
||||
* @implements ProcessorInterface<CurrentSiteResource, User>
|
||||
*/
|
||||
final class CurrentSiteProcessor implements ProcessorInterface
|
||||
{
|
||||
public function __construct(
|
||||
private readonly Security $security,
|
||||
private readonly EntityManagerInterface $entityManager,
|
||||
) {}
|
||||
|
||||
public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = []): mixed
|
||||
{
|
||||
if (!$data instanceof CurrentSiteResource) {
|
||||
throw new LogicException(sprintf(
|
||||
'CurrentSiteProcessor attend une instance de %s, %s recu.',
|
||||
CurrentSiteResource::class,
|
||||
get_debug_type($data),
|
||||
));
|
||||
}
|
||||
|
||||
$user = $this->security->getUser();
|
||||
if (!$user instanceof User) {
|
||||
// security: "is_granted('ROLE_USER')" sur l'operation doit deja
|
||||
// bloquer ce cas — garde defensive si la config change.
|
||||
throw new AccessDeniedHttpException('Authentification requise pour changer de site courant.');
|
||||
}
|
||||
|
||||
$targetSite = $data->site;
|
||||
if (null === $targetSite) {
|
||||
throw new BadRequestHttpException('Le champ "site" est requis.');
|
||||
}
|
||||
|
||||
// Refresh + switchCurrentSite + flush dans une transaction atomique.
|
||||
// Le refresh elimine la race condition TOCTOU : si un PATCH /rbac concurrent
|
||||
// a revoque le site de l'user entre le chargement de session et ici, le
|
||||
// refresh force un re-fetch de l'user et de sa collection de sites depuis
|
||||
// la BDD, garantissant que hasSite() reflete l'etat reel persisté.
|
||||
try {
|
||||
$this->entityManager->wrapInTransaction(function () use ($user, $targetSite): void {
|
||||
// Re-fetch de l'user + ses collections depuis la BDD (elimination TOCTOU).
|
||||
$this->entityManager->refresh($user);
|
||||
|
||||
try {
|
||||
$user->switchCurrentSite($targetSite);
|
||||
} catch (SiteNotAuthorizedException $e) {
|
||||
// Traduction HTTP immediate (pas de listener kernel necessaire) :
|
||||
// aligne sur le pattern RoleProcessor → SystemRoleDeletionException.
|
||||
throw new AccessDeniedHttpException($e->getMessage(), $e);
|
||||
}
|
||||
|
||||
$this->entityManager->flush();
|
||||
});
|
||||
} catch (OptimisticLockException $e) {
|
||||
// Protection future : si un champ @Version est ajoute sur User,
|
||||
// le conflit de version sera intercepte ici plutot que de remonter
|
||||
// comme une erreur generique.
|
||||
throw new BadRequestHttpException(
|
||||
'Conflit de version detecte lors du changement de site courant. Veuillez reessayer.',
|
||||
$e,
|
||||
);
|
||||
}
|
||||
|
||||
return $user;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,94 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Module\Sites\Infrastructure\ApiPlatform\State\Processor;
|
||||
|
||||
use ApiPlatform\Metadata\Operation;
|
||||
use ApiPlatform\State\ProcessorInterface;
|
||||
use App\Module\Core\Domain\Entity\User;
|
||||
use App\Module\Sites\Application\Service\CurrentSiteProviderInterface;
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use App\Shared\Domain\Contract\SiteAwareInterface;
|
||||
use Symfony\Bundle\SecurityBundle\Security;
|
||||
use Symfony\Component\DependencyInjection\Attribute\AsDecorator;
|
||||
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
|
||||
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
|
||||
|
||||
/**
|
||||
* Decorator du processor de persistance Doctrine d'API Platform qui injecte
|
||||
* automatiquement le site courant de l'utilisateur sur les entites
|
||||
* implementant SiteAwareInterface, si le payload ne precise pas de site.
|
||||
*
|
||||
* S'applique a TOUTES les operations POST/PATCH qui deleguent au persist
|
||||
* processor natif. Les processors custom qui appellent
|
||||
* `$this->persistProcessor->process()` (pattern UserRbacProcessor) passent
|
||||
* aussi par ce decorator, transparent pour les entites non-SiteAware.
|
||||
*
|
||||
* Comportement :
|
||||
* - $data pas SiteAware -> delegation directe (no-op).
|
||||
* - $data SiteAware avec site deja positionne, appelant a `sites.bypass_scope`
|
||||
* -> delegation directe (ex: admin qui cree une entite dans un autre site).
|
||||
* - $data SiteAware avec site deja positionne, appelant SANS `sites.bypass_scope`
|
||||
* -> validation que le site precise appartient aux sites autorises de l'user.
|
||||
* Si non, leve AccessDeniedHttpException (cross-site write interdite).
|
||||
* - $data SiteAware sans site, provider retourne un Site -> injection
|
||||
* puis delegation.
|
||||
* - $data SiteAware sans site, provider retourne null -> throw 400
|
||||
* BadRequestHttpException avec message explicite.
|
||||
*
|
||||
* Volontairement HTTP-only : ne couvre pas les persistances hors API
|
||||
* Platform (fixtures, commandes CLI, imports). Ces contextes doivent
|
||||
* positionner le site explicitement — c'est assume dans la doc
|
||||
* d'adoption (`docs/modules/site-aware.md`).
|
||||
*
|
||||
* @implements ProcessorInterface<mixed|SiteAwareInterface, mixed>
|
||||
*/
|
||||
#[AsDecorator('api_platform.doctrine.orm.state.persist_processor')]
|
||||
final class SiteAwareInjectionProcessor implements ProcessorInterface
|
||||
{
|
||||
public function __construct(
|
||||
private readonly ProcessorInterface $inner,
|
||||
private readonly CurrentSiteProviderInterface $currentSiteProvider,
|
||||
private readonly Security $security,
|
||||
) {}
|
||||
|
||||
public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = []): mixed
|
||||
{
|
||||
if ($data instanceof SiteAwareInterface) {
|
||||
if (null !== $data->getSite()) {
|
||||
// Le payload precise un site explicite : on valide que le site
|
||||
// appartient aux sites autorises de l'utilisateur courant, sauf
|
||||
// si celui-ci dispose de la permission `sites.bypass_scope`
|
||||
// (ex: admin effectuant une operation cross-site).
|
||||
if (!$this->security->isGranted('sites.bypass_scope')) {
|
||||
$user = $this->security->getUser();
|
||||
$explicitSite = $data->getSite();
|
||||
// hasSite() attend un Site concret. Si l'agent entity fait
|
||||
// evoluer la signature vers SiteInterface, le instanceof
|
||||
// reste valide (Site implemente SiteInterface) et le cast
|
||||
// disparaitra naturellement lors du prochain nettoyage.
|
||||
if ($user instanceof User && $explicitSite instanceof Site && !$user->hasSite($explicitSite)) {
|
||||
throw new AccessDeniedHttpException(
|
||||
'Le site specifie n\'est pas dans les sites autorises pour cet utilisateur.'
|
||||
);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// Aucun site dans le payload : injection automatique depuis le
|
||||
// site courant de l'utilisateur.
|
||||
$currentSite = $this->currentSiteProvider->get();
|
||||
|
||||
if (null === $currentSite) {
|
||||
throw new BadRequestHttpException(
|
||||
'Impossible de creer l\'enregistrement : aucun site selectionne.',
|
||||
);
|
||||
}
|
||||
|
||||
$data->setSite($currentSite);
|
||||
}
|
||||
}
|
||||
|
||||
return $this->inner->process($data, $operation, $uriVariables, $context);
|
||||
}
|
||||
}
|
||||
112
src/Module/Sites/Infrastructure/DataFixtures/SitesFixtures.php
Normal file
112
src/Module/Sites/Infrastructure/DataFixtures/SitesFixtures.php
Normal file
@@ -0,0 +1,112 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Module\Sites\Infrastructure\DataFixtures;
|
||||
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use App\Module\Sites\Domain\Repository\SiteRepositoryInterface;
|
||||
use Doctrine\Bundle\FixturesBundle\Fixture;
|
||||
use Doctrine\Persistence\ObjectManager;
|
||||
|
||||
/**
|
||||
* Fixtures du module Sites : 3 etablissements de demonstration utilises par
|
||||
* les tickets suivants (rattachement utilisateurs, navbar, etc.).
|
||||
*
|
||||
* Idempotence supportee : le purger Doctrine (ORMPurger) vide la table
|
||||
* `site` avant chaque `doctrine:fixtures:load`. Si le purger est
|
||||
* desactive et la fixture rejouee telle quelle sur une base deja seedee,
|
||||
* le lookup par nom evite le doublon et re-aligne les autres champs.
|
||||
*
|
||||
* Idempotence NON supportee :
|
||||
* - chargement cumulatif apres qu'une autre fixture ait persiste (sans
|
||||
* flush) des Site dans la meme session : `findByName()` s'appuie sur
|
||||
* `findOneBy`, qui n'inspecte pas les entites en attente dans l'unit-of-work
|
||||
* et peut renvoyer null alors qu'un homonyme est deja manage ;
|
||||
* - renommage d'un site : le nom etant la cle de lookup, modifier
|
||||
* `name` dans cette fixture cree un nouveau site et laisse l'ancien
|
||||
* en base (purger desactive). Les autres champs (city, color, etc.)
|
||||
* sont en revanche bien re-synchronises pour un site retrouve.
|
||||
*/
|
||||
class SitesFixtures extends Fixture
|
||||
{
|
||||
public function __construct(
|
||||
private readonly SiteRepositoryInterface $siteRepository,
|
||||
) {}
|
||||
|
||||
public function load(ObjectManager $manager): void
|
||||
{
|
||||
// Chatellerault : bleu Coltura.
|
||||
$this->ensureSite(
|
||||
$manager,
|
||||
name: 'Chatellerault',
|
||||
street: "14 All. d'Argenson",
|
||||
complement: null,
|
||||
postalCode: '86100',
|
||||
city: 'Châtellerault',
|
||||
color: '#056CF2',
|
||||
);
|
||||
|
||||
// Saint-Jean : jaune vif. Le nom du site (identifier) ne reflete
|
||||
// pas la ville reelle (Fontenet) — c'est une nomenclature interne
|
||||
// client.
|
||||
$this->ensureSite(
|
||||
$manager,
|
||||
name: 'Saint-Jean',
|
||||
street: 'Z i',
|
||||
complement: null,
|
||||
postalCode: '17400',
|
||||
city: 'Fontenet',
|
||||
color: '#F3CB00',
|
||||
);
|
||||
|
||||
// Pommevic : vert clair.
|
||||
$this->ensureSite(
|
||||
$manager,
|
||||
name: 'Pommevic',
|
||||
street: '1 Av. Jean Duquesne',
|
||||
complement: null,
|
||||
postalCode: '82400',
|
||||
city: 'Pommevic',
|
||||
color: '#74BF04',
|
||||
);
|
||||
|
||||
$manager->flush();
|
||||
}
|
||||
|
||||
/**
|
||||
* Cree le site s'il n'existe pas encore, sinon re-aligne rue, complement,
|
||||
* code postal, ville et couleur sur les valeurs de reference.
|
||||
*
|
||||
* Note : le nom sert de cle de lookup (il est unique en base) et n'est
|
||||
* donc pas resynchronise. Consequence : renommer un site dans la
|
||||
* fixture cree un nouveau site sans supprimer l'ancien, sauf si le
|
||||
* purger Doctrine est actif (cas nominal de `doctrine:fixtures:load`).
|
||||
*/
|
||||
private function ensureSite(
|
||||
ObjectManager $manager,
|
||||
string $name,
|
||||
string $street,
|
||||
?string $complement,
|
||||
string $postalCode,
|
||||
string $city,
|
||||
string $color,
|
||||
): Site {
|
||||
$site = $this->siteRepository->findByName($name);
|
||||
|
||||
if (null === $site) {
|
||||
$site = new Site($name, $street, $complement, $postalCode, $city, $color);
|
||||
$manager->persist($site);
|
||||
|
||||
return $site;
|
||||
}
|
||||
|
||||
$site->setStreet($street);
|
||||
$site->setComplement($complement);
|
||||
$site->setPostalCode($postalCode);
|
||||
$site->setCity($city);
|
||||
$site->setColor($color);
|
||||
|
||||
return $site;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,52 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Module\Sites\Infrastructure\Doctrine;
|
||||
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use App\Module\Sites\Domain\Repository\SiteRepositoryInterface;
|
||||
use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
|
||||
use Doctrine\Persistence\ManagerRegistry;
|
||||
|
||||
/**
|
||||
* @extends ServiceEntityRepository<Site>
|
||||
*/
|
||||
class DoctrineSiteRepository extends ServiceEntityRepository implements SiteRepositoryInterface
|
||||
{
|
||||
public function __construct(ManagerRegistry $registry)
|
||||
{
|
||||
parent::__construct($registry, Site::class);
|
||||
}
|
||||
|
||||
public function findById(int $id): ?Site
|
||||
{
|
||||
return $this->find($id);
|
||||
}
|
||||
|
||||
public function findByName(string $name): ?Site
|
||||
{
|
||||
return $this->findOneBy(['name' => $name]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return list<Site>
|
||||
*/
|
||||
public function findAllOrderedByName(): array
|
||||
{
|
||||
/** @var list<Site> $sites */
|
||||
return $this->findBy([], ['name' => 'ASC']);
|
||||
}
|
||||
|
||||
public function save(Site $site): void
|
||||
{
|
||||
$this->getEntityManager()->persist($site);
|
||||
$this->getEntityManager()->flush();
|
||||
}
|
||||
|
||||
public function remove(Site $site): void
|
||||
{
|
||||
$this->getEntityManager()->remove($site);
|
||||
$this->getEntityManager()->flush();
|
||||
}
|
||||
}
|
||||
38
src/Module/Sites/SitesModule.php
Normal file
38
src/Module/Sites/SitesModule.php
Normal file
@@ -0,0 +1,38 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Module\Sites;
|
||||
|
||||
final class SitesModule
|
||||
{
|
||||
public const string ID = 'sites';
|
||||
public const string LABEL = 'Sites';
|
||||
public const bool REQUIRED = false;
|
||||
|
||||
/**
|
||||
* Liste declarative des permissions RBAC exposees par le module Sites.
|
||||
*
|
||||
* Consommee par la commande `app:sync-permissions` (SyncPermissionsCommand)
|
||||
* qui se charge d'upserter ces entrees dans la table `permission`, de
|
||||
* reactiver les codes precedemment marques orphelins et de marquer comme
|
||||
* orphelins ceux qui ont disparu du code source.
|
||||
*
|
||||
* La cle `module` est auto-injectee par le sync command a partir de
|
||||
* `self::ID`, il est donc inutile de la repeter dans chaque entree.
|
||||
*
|
||||
* Convention de nommage des codes : `module.resource[.sub].action` en
|
||||
* snake_case, le prefixe module devant correspondre exactement a
|
||||
* `self::ID` (verifie par la commande de synchronisation).
|
||||
*
|
||||
* @return array<int, array{code: string, label: string}>
|
||||
*/
|
||||
public static function permissions(): array
|
||||
{
|
||||
return [
|
||||
['code' => 'sites.view', 'label' => 'Voir les sites'],
|
||||
['code' => 'sites.manage', 'label' => 'Gerer les sites (creer, editer, supprimer)'],
|
||||
['code' => 'sites.bypass_scope', 'label' => 'Voir les donnees site-scoped de tous les sites (bypass du filtrage)'],
|
||||
];
|
||||
}
|
||||
}
|
||||
37
src/Shared/Domain/Contract/SiteAwareInterface.php
Normal file
37
src/Shared/Domain/Contract/SiteAwareInterface.php
Normal file
@@ -0,0 +1,37 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Shared\Domain\Contract;
|
||||
|
||||
/**
|
||||
* Contrat opt-in pour les entites dont la visibilite est scopee par site.
|
||||
*
|
||||
* Une entite implementant cette interface sera :
|
||||
* - filtree en lecture par SiteScopedQueryExtension (collection + item)
|
||||
* selon le site courant de l'utilisateur authentifie ;
|
||||
* - alimentee automatiquement en POST/PATCH par SiteAwareInjectionProcessor
|
||||
* si le payload ne precise pas de site.
|
||||
*
|
||||
* L'implementation concrete doit :
|
||||
* - Declarer une relation ManyToOne vers l'entite concrete Site avec colonne
|
||||
* `site_id` NOT NULL (targetEntity: \App\Module\Sites\Domain\Entity\Site).
|
||||
* - Indexer `site_id` en base (sinon le filtre WHERE genere un full-scan).
|
||||
*
|
||||
* Les signatures utilisent SiteInterface (et non la classe concrete Site)
|
||||
* pour que Shared n'importe pas directement le module Sites.
|
||||
*
|
||||
* Ne PAS implementer cette interface pour :
|
||||
* - Des entites globales (catalogue partage, roles, permissions, users).
|
||||
* - Des entites dont le scope est "par tenant" plus large que le site
|
||||
* (utiliser TenantAwareInterface le cas echeant).
|
||||
* - Des entites transversales references par plusieurs sites.
|
||||
*
|
||||
* Voir `docs/modules/site-aware.md` pour le guide d'adoption complet.
|
||||
*/
|
||||
interface SiteAwareInterface
|
||||
{
|
||||
public function getSite(): ?SiteInterface;
|
||||
|
||||
public function setSite(SiteInterface $site): void;
|
||||
}
|
||||
20
src/Shared/Domain/Contract/SiteInterface.php
Normal file
20
src/Shared/Domain/Contract/SiteInterface.php
Normal file
@@ -0,0 +1,20 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Shared\Domain\Contract;
|
||||
|
||||
/**
|
||||
* Interface minimale exposant ce que le noyau (Shared/Core) doit connaitre
|
||||
* d'un Site, sans creer de couplage direct vers le module Sites.
|
||||
*
|
||||
* Implemente par App\Module\Sites\Domain\Entity\Site.
|
||||
* Utilisee comme type-hint dans SiteAwareInterface, User et toute entite
|
||||
* Shared/Core qui manipule un site sans avoir besoin des details metier.
|
||||
*/
|
||||
interface SiteInterface
|
||||
{
|
||||
public function getId(): ?int;
|
||||
|
||||
public function getName(): ?string;
|
||||
}
|
||||
31
src/Shared/Domain/Exception/SiteNotAuthorizedException.php
Normal file
31
src/Shared/Domain/Exception/SiteNotAuthorizedException.php
Normal file
@@ -0,0 +1,31 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Shared\Domain\Exception;
|
||||
|
||||
use App\Shared\Domain\Contract\SiteInterface;
|
||||
use DomainException;
|
||||
|
||||
/**
|
||||
* Levee lorsqu'un utilisateur tente de selectionner comme site courant un
|
||||
* site qui ne fait pas partie de ses sites autorises.
|
||||
*
|
||||
* Exception purement domaine : la traduction HTTP (403) est faite par le
|
||||
* CurrentSiteProcessor via try/catch, aligne sur le pattern
|
||||
* SystemRoleDeletionException du module Core.
|
||||
*
|
||||
* Deplacee dans Shared/Domain/Exception/ pour eviter que le module Core
|
||||
* n'importe directement depuis le module Sites (violation du principe de
|
||||
* non-couplage inter-modules).
|
||||
*/
|
||||
class SiteNotAuthorizedException extends DomainException
|
||||
{
|
||||
public static function forSite(SiteInterface $site): self
|
||||
{
|
||||
return new self(sprintf(
|
||||
'Le site "%s" ne fait pas partie de vos sites autorises.',
|
||||
$site->getName(),
|
||||
));
|
||||
}
|
||||
}
|
||||
74
tests/Fixtures/SiteAware/FakeSiteAwareEntity.php
Normal file
74
tests/Fixtures/SiteAware/FakeSiteAwareEntity.php
Normal file
@@ -0,0 +1,74 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Tests\Fixtures\SiteAware;
|
||||
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use App\Shared\Domain\Contract\SiteAwareInterface;
|
||||
use App\Shared\Domain\Contract\SiteInterface;
|
||||
use Doctrine\ORM\Mapping as ORM;
|
||||
use InvalidArgumentException;
|
||||
|
||||
/**
|
||||
* Entite fictive utilisee UNIQUEMENT en tests (ticket 4 module Sites).
|
||||
*
|
||||
* Implemente SiteAwareInterface pour valider que l'outillage
|
||||
* (SiteScopedQueryExtension + SiteAwareInjectionProcessor) se comporte
|
||||
* correctement sans avoir a adopter le pattern sur une entite metier
|
||||
* reelle. Le mapping Doctrine n'est charge qu'en environnement `test`
|
||||
* via un bloc `when@test` dans `config/packages/doctrine.yaml`, donc
|
||||
* cette classe n'existe jamais dans un schema prod.
|
||||
*
|
||||
* Le nom de table `fake_site_aware_entity` est volontairement verbeux
|
||||
* pour reduire le risque de collision avec une future table metier.
|
||||
*/
|
||||
#[ORM\Entity]
|
||||
#[ORM\Table(name: 'fake_site_aware_entity')]
|
||||
class FakeSiteAwareEntity implements SiteAwareInterface
|
||||
{
|
||||
#[ORM\Id]
|
||||
#[ORM\GeneratedValue]
|
||||
#[ORM\Column]
|
||||
private ?int $id = null;
|
||||
|
||||
#[ORM\Column(length: 100)]
|
||||
private string $name;
|
||||
|
||||
#[ORM\ManyToOne(targetEntity: Site::class)]
|
||||
#[ORM\JoinColumn(name: 'site_id', referencedColumnName: 'id', nullable: false, onDelete: 'CASCADE')]
|
||||
private ?Site $site = null;
|
||||
|
||||
public function __construct(string $name)
|
||||
{
|
||||
$this->name = $name;
|
||||
}
|
||||
|
||||
public function getId(): ?int
|
||||
{
|
||||
return $this->id;
|
||||
}
|
||||
|
||||
public function getName(): string
|
||||
{
|
||||
return $this->name;
|
||||
}
|
||||
|
||||
public function setName(string $name): void
|
||||
{
|
||||
$this->name = $name;
|
||||
}
|
||||
|
||||
public function getSite(): ?SiteInterface
|
||||
{
|
||||
return $this->site;
|
||||
}
|
||||
|
||||
public function setSite(SiteInterface $site): void
|
||||
{
|
||||
if (!$site instanceof Site) {
|
||||
throw new InvalidArgumentException('FakeSiteAwareEntity requires a concrete Site (Doctrine ManyToOne target).');
|
||||
}
|
||||
$this->site = $site;
|
||||
}
|
||||
}
|
||||
@@ -9,6 +9,7 @@ use ApiPlatform\Symfony\Bundle\Test\Client;
|
||||
use App\Module\Core\Domain\Entity\Permission;
|
||||
use App\Module\Core\Domain\Entity\Role;
|
||||
use App\Module\Core\Domain\Entity\User;
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use Doctrine\ORM\EntityManagerInterface;
|
||||
use Symfony\Component\PasswordHasher\Hasher\UserPasswordHasherInterface;
|
||||
|
||||
@@ -123,6 +124,19 @@ abstract class AbstractApiTestCase extends ApiTestCase
|
||||
$user->setIsAdmin(false);
|
||||
$user->setPassword($hasher->hashPassword($user, $password));
|
||||
$user->addRbacRole($role);
|
||||
|
||||
// Le helper attache le user jetable a tous les sites existants pour
|
||||
// neutraliser le filtrage par UserSiteScopedExtension : la plupart
|
||||
// des tests assume une visibilite globale sur les users cibles. Les
|
||||
// tests qui valident le comportement "sans sites" doivent creer leur
|
||||
// user a la main (pas via ce helper).
|
||||
$siteRepository = $em->getRepository(Site::class);
|
||||
if (null !== $siteRepository) {
|
||||
foreach ($siteRepository->findAll() as $site) {
|
||||
$user->addSite($site);
|
||||
}
|
||||
}
|
||||
|
||||
$em->persist($user);
|
||||
|
||||
$em->flush();
|
||||
@@ -130,4 +144,34 @@ abstract class AbstractApiTestCase extends ApiTestCase
|
||||
|
||||
return ['username' => $username, 'password' => $password];
|
||||
}
|
||||
|
||||
/**
|
||||
* Skip le test courant si le module Sites est desactive dans
|
||||
* `config/modules.php` de l'environnement de test.
|
||||
*
|
||||
* Mecanisme : on cherche la permission `sites.view` en base. Si le
|
||||
* module Sites est desactive, `app:sync-permissions` aura marque cette
|
||||
* permission comme orpheline et l'aura supprimee de la table — donc
|
||||
* `findOneBy(['code' => 'sites.view'])` renvoie null.
|
||||
*
|
||||
* Quand utiliser ce helper : tests qui s'appuient sur
|
||||
* `createUserWithPermission('sites.*')`. Les tests qui utilisent
|
||||
* uniquement l'admin (qui bypass via isAdmin) n'en ont pas besoin :
|
||||
* la classe Site reste mappee Doctrine et exposee via API Platform
|
||||
* meme module desactive (mapping inconditionnel, decision assumee
|
||||
* ticket 1).
|
||||
*/
|
||||
protected function skipIfSitesModuleDisabled(): void
|
||||
{
|
||||
if (!self::$kernel) {
|
||||
self::bootKernel();
|
||||
}
|
||||
$perm = $this->getEm()
|
||||
->getRepository(Permission::class)
|
||||
->findOneBy(['code' => 'sites.view'])
|
||||
;
|
||||
if (null === $perm) {
|
||||
self::markTestSkipped('Module Sites desactive : permission sites.view introuvable en base.');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
219
tests/Module/Core/Api/AdminFiltersApiTest.php
Normal file
219
tests/Module/Core/Api/AdminFiltersApiTest.php
Normal file
@@ -0,0 +1,219 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Tests\Module\Core\Api;
|
||||
|
||||
/**
|
||||
* Tests fonctionnels des ApiFilter ajoutes sur User, Role et Site pour
|
||||
* les DataTables admin (filtrage serveur + pagination negociee).
|
||||
*
|
||||
* Ces tests s'appuient uniquement sur les fixtures (admin, alice, bob +
|
||||
* 3 sites + 2 roles systeme + 6 permissions) — aucune mutation entre
|
||||
* tests, pas de cleanup necessaire.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class AdminFiltersApiTest extends AbstractApiTestCase
|
||||
{
|
||||
// ========================================================================
|
||||
// User filters
|
||||
// ========================================================================
|
||||
|
||||
public function testUsersFilterByUsernamePartial(): void
|
||||
{
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$response = $client->request('GET', '/api/users?username=ali');
|
||||
|
||||
self::assertResponseIsSuccessful();
|
||||
$data = $response->toArray();
|
||||
self::assertSame(1, $data['totalItems']);
|
||||
self::assertSame('alice', $data['member'][0]['username']);
|
||||
}
|
||||
|
||||
public function testUsersFilterByIsAdminTrueReturnsOnlyAdmins(): void
|
||||
{
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$response = $client->request('GET', '/api/users?isAdmin=true');
|
||||
|
||||
self::assertResponseIsSuccessful();
|
||||
$data = $response->toArray();
|
||||
self::assertGreaterThanOrEqual(1, $data['totalItems']);
|
||||
foreach ($data['member'] as $user) {
|
||||
self::assertTrue($user['isAdmin']);
|
||||
}
|
||||
}
|
||||
|
||||
public function testUsersFilterByIsAdminFalseExcludesAdmins(): void
|
||||
{
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$response = $client->request('GET', '/api/users?isAdmin=false');
|
||||
|
||||
$data = $response->toArray();
|
||||
foreach ($data['member'] as $user) {
|
||||
self::assertFalse($user['isAdmin']);
|
||||
}
|
||||
}
|
||||
|
||||
public function testUsersFilterBySiteNameReturnsUsersOfThatSite(): void
|
||||
{
|
||||
// alice est rattachee a Chatellerault uniquement, bob a Saint-Jean.
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$response = $client->request('GET', '/api/users?sites.name=Saint-Jean');
|
||||
|
||||
$data = $response->toArray();
|
||||
$usernames = array_column($data['member'], 'username');
|
||||
self::assertContains('admin', $usernames);
|
||||
self::assertContains('bob', $usernames);
|
||||
self::assertNotContains('alice', $usernames);
|
||||
}
|
||||
|
||||
public function testUsersFilterByRoleCodeReturnsUsersWithThatRole(): void
|
||||
{
|
||||
// admin porte le role systeme 'admin', alice/bob portent 'user'.
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$response = $client->request('GET', '/api/users?rbacRoles.code=admin');
|
||||
|
||||
$data = $response->toArray();
|
||||
$usernames = array_column($data['member'], 'username');
|
||||
self::assertContains('admin', $usernames);
|
||||
self::assertNotContains('alice', $usernames);
|
||||
}
|
||||
|
||||
// ========================================================================
|
||||
// Site filters
|
||||
// ========================================================================
|
||||
|
||||
public function testSitesFilterByNamePartial(): void
|
||||
{
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$response = $client->request('GET', '/api/sites?name=Chat');
|
||||
|
||||
$data = $response->toArray();
|
||||
self::assertSame(1, $data['totalItems']);
|
||||
self::assertSame('Chatellerault', $data['member'][0]['name']);
|
||||
}
|
||||
|
||||
public function testSitesFilterByCityPartial(): void
|
||||
{
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
// Fontenet est la ville du site Saint-Jean.
|
||||
$response = $client->request('GET', '/api/sites?city=Fonten');
|
||||
|
||||
$data = $response->toArray();
|
||||
self::assertSame(1, $data['totalItems']);
|
||||
self::assertSame('Saint-Jean', $data['member'][0]['name']);
|
||||
}
|
||||
|
||||
public function testSitesFilterByPostalCodePartial(): void
|
||||
{
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$response = $client->request('GET', '/api/sites?postalCode=82');
|
||||
|
||||
$data = $response->toArray();
|
||||
self::assertSame(1, $data['totalItems']);
|
||||
self::assertSame('Pommevic', $data['member'][0]['name']);
|
||||
}
|
||||
|
||||
// ========================================================================
|
||||
// Role filters
|
||||
// ========================================================================
|
||||
|
||||
public function testRolesFilterByLabelPartial(): void
|
||||
{
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$response = $client->request('GET', '/api/roles?label=Admin');
|
||||
|
||||
$data = $response->toArray();
|
||||
self::assertGreaterThanOrEqual(1, $data['totalItems']);
|
||||
foreach ($data['member'] as $role) {
|
||||
self::assertStringContainsStringIgnoringCase('admin', $role['label']);
|
||||
}
|
||||
}
|
||||
|
||||
public function testRolesFilterByLabelIsCaseInsensitive(): void
|
||||
{
|
||||
// Garde explicite : la strategy est `ipartial` (ILIKE) et pas
|
||||
// `partial` (LIKE). Chercher "ad" en minuscules DOIT trouver
|
||||
// "Administrateur" (A majuscule). Si un futur dev retombe en
|
||||
// strategy `partial` par megarde, ce test cassera.
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$response = $client->request('GET', '/api/roles?label=ad');
|
||||
|
||||
$data = $response->toArray();
|
||||
$labels = array_column($data['member'], 'label');
|
||||
self::assertContains('Administrateur', $labels);
|
||||
}
|
||||
|
||||
public function testRolesFilterByCodePartial(): void
|
||||
{
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$response = $client->request('GET', '/api/roles?code=user');
|
||||
|
||||
$data = $response->toArray();
|
||||
self::assertGreaterThanOrEqual(1, $data['totalItems']);
|
||||
foreach ($data['member'] as $role) {
|
||||
self::assertStringContainsString('user', $role['code']);
|
||||
}
|
||||
}
|
||||
|
||||
public function testRolesFilterByIsSystemTrueReturnsOnlySystemRoles(): void
|
||||
{
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$response = $client->request('GET', '/api/roles?isSystem=true');
|
||||
|
||||
$data = $response->toArray();
|
||||
self::assertGreaterThanOrEqual(2, $data['totalItems']);
|
||||
foreach ($data['member'] as $role) {
|
||||
self::assertTrue($role['isSystem']);
|
||||
}
|
||||
}
|
||||
|
||||
public function testRolesFilterByPermissionCodeReturnsRolesWithThatPermission(): void
|
||||
{
|
||||
// Le role systeme 'admin' a le flag isAdmin qui bypass toutes les
|
||||
// permissions — il n'a pas necessairement des permissions explicites.
|
||||
// On teste donc avec la permission sites.view qui devrait exister
|
||||
// mais potentiellement n'etre sur aucun role custom. Le filtre
|
||||
// fonctionne techniquement meme sur un resultat vide.
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$response = $client->request('GET', '/api/roles?permissions.code=sites.view');
|
||||
|
||||
self::assertResponseIsSuccessful();
|
||||
$data = $response->toArray();
|
||||
// On valide juste que la requete est acceptee (200) et que le
|
||||
// filtre transforme bien l'IRI en JOIN — nombre de resultats
|
||||
// depend de l'etat des fixtures.
|
||||
self::assertArrayHasKey('totalItems', $data);
|
||||
}
|
||||
|
||||
// ========================================================================
|
||||
// Pagination
|
||||
// ========================================================================
|
||||
|
||||
public function testPaginationWithItemsPerPageReducesMember(): void
|
||||
{
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$response = $client->request('GET', '/api/sites?itemsPerPage=2');
|
||||
|
||||
$data = $response->toArray();
|
||||
self::assertLessThanOrEqual(2, count($data['member']));
|
||||
// totalItems reflete le TOTAL pas la page courante.
|
||||
self::assertGreaterThanOrEqual(3, $data['totalItems']);
|
||||
}
|
||||
|
||||
public function testPaginationPage2SkipsFirstItems(): void
|
||||
{
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$page1 = $client->request('GET', '/api/sites?itemsPerPage=1&page=1')->toArray();
|
||||
$page2 = $client->request('GET', '/api/sites?itemsPerPage=1&page=2')->toArray();
|
||||
|
||||
self::assertCount(1, $page1['member']);
|
||||
self::assertCount(1, $page2['member']);
|
||||
self::assertNotSame(
|
||||
$page1['member'][0]['id'],
|
||||
$page2['member'][0]['id'],
|
||||
'Les items de la page 2 doivent differer de ceux de la page 1.',
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -7,6 +7,7 @@ namespace App\Tests\Module\Core\Api;
|
||||
use App\Module\Core\Domain\Entity\Permission;
|
||||
use App\Module\Core\Domain\Entity\Role;
|
||||
use App\Module\Core\Domain\Entity\User;
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use Symfony\Component\PasswordHasher\Hasher\UserPasswordHasherInterface;
|
||||
|
||||
/**
|
||||
@@ -41,11 +42,18 @@ final class UserRbacApiTest extends AbstractApiTestCase
|
||||
/** @var UserPasswordHasherInterface $hasher */
|
||||
$hasher = self::getContainer()->get(UserPasswordHasherInterface::class);
|
||||
|
||||
// User cible standard (non admin).
|
||||
// User cible standard (non admin). On lui attache tous les sites
|
||||
// fixtures pour rester visible depuis les callers non-admin munis de
|
||||
// sites (cf. UserSiteScopedExtension qui filtre `/api/users` par
|
||||
// intersection de sites). Sans cela, un user `core.users.manage`
|
||||
// sans site commun avec test_target recevrait un 404 sur le PATCH.
|
||||
$target = new User();
|
||||
$target->setUsername('test_target');
|
||||
$target->setIsAdmin(false);
|
||||
$target->setPassword($hasher->hashPassword($target, 'secret'));
|
||||
foreach ($em->getRepository(Site::class)->findAll() as $site) {
|
||||
$target->addSite($site);
|
||||
}
|
||||
$em->persist($target);
|
||||
|
||||
// User admin dedie pour le cas d'auto-suicide (pas l'admin fixture).
|
||||
|
||||
189
tests/Module/Core/Api/UserRbacSitesApiTest.php
Normal file
189
tests/Module/Core/Api/UserRbacSitesApiTest.php
Normal file
@@ -0,0 +1,189 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Tests\Module\Core\Api;
|
||||
|
||||
use App\Module\Core\Domain\Entity\User;
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
|
||||
/**
|
||||
* Tests d'extension de l'endpoint PATCH /api/users/{id}/rbac pour assigner
|
||||
* des sites a un user, avec les deux gardes post-persist :
|
||||
* - si currentSite n'est plus dans sites → null ;
|
||||
* - si currentSite null ET sites non vide → auto-select premier site.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class UserRbacSitesApiTest extends AbstractApiTestCase
|
||||
{
|
||||
public function testAdminCanAssignSitesToUser(): void
|
||||
{
|
||||
$em = $this->getEm();
|
||||
$saintJean = $em->getRepository(Site::class)->findOneBy(['name' => 'Saint-Jean']);
|
||||
self::assertNotNull($saintJean);
|
||||
|
||||
$alice = $em->getRepository(User::class)->findOneBy(['username' => 'alice']);
|
||||
$aliceId = $alice->getId();
|
||||
$em->clear();
|
||||
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$client->request('PATCH', '/api/users/'.$aliceId.'/rbac', [
|
||||
'headers' => ['Content-Type' => 'application/merge-patch+json'],
|
||||
'json' => [
|
||||
'sites' => ['/api/sites/'.$saintJean->getId()],
|
||||
],
|
||||
]);
|
||||
|
||||
self::assertResponseIsSuccessful();
|
||||
|
||||
// Verification cote base.
|
||||
$em = $this->getEm();
|
||||
$em->clear();
|
||||
$reloaded = $em->getRepository(User::class)->find($aliceId);
|
||||
self::assertNotNull($reloaded);
|
||||
self::assertCount(1, $reloaded->getSites());
|
||||
self::assertSame('Saint-Jean', $reloaded->getSites()->first()->getName());
|
||||
|
||||
// Restauration pour ne pas polluer les autres tests.
|
||||
$this->restoreAliceSites();
|
||||
}
|
||||
|
||||
public function testRemovingCurrentSiteResetsCurrentSiteToNullThenAutoSelectsFirst(): void
|
||||
{
|
||||
// alice a actuellement {Chatellerault}, currentSite=Chatellerault.
|
||||
// On lui attribue {Saint-Jean} : Chatellerault disparait → currentSite
|
||||
// devrait temporairement etre null, PUIS auto-select Saint-Jean (seul
|
||||
// site restant).
|
||||
$em = $this->getEm();
|
||||
$saintJean = $em->getRepository(Site::class)->findOneBy(['name' => 'Saint-Jean']);
|
||||
$alice = $em->getRepository(User::class)->findOneBy(['username' => 'alice']);
|
||||
$aliceId = $alice->getId();
|
||||
$em->clear();
|
||||
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$client->request('PATCH', '/api/users/'.$aliceId.'/rbac', [
|
||||
'headers' => ['Content-Type' => 'application/merge-patch+json'],
|
||||
'json' => [
|
||||
'sites' => ['/api/sites/'.$saintJean->getId()],
|
||||
],
|
||||
]);
|
||||
|
||||
self::assertResponseIsSuccessful();
|
||||
|
||||
$em = $this->getEm();
|
||||
$em->clear();
|
||||
$reloaded = $em->getRepository(User::class)->find($aliceId);
|
||||
self::assertNotNull($reloaded->getCurrentSite());
|
||||
self::assertSame('Saint-Jean', $reloaded->getCurrentSite()->getName());
|
||||
|
||||
$this->restoreAliceSites();
|
||||
}
|
||||
|
||||
public function testEmptySitesPayloadResetsCurrentSiteToNull(): void
|
||||
{
|
||||
$em = $this->getEm();
|
||||
$alice = $em->getRepository(User::class)->findOneBy(['username' => 'alice']);
|
||||
$aliceId = $alice->getId();
|
||||
$em->clear();
|
||||
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$client->request('PATCH', '/api/users/'.$aliceId.'/rbac', [
|
||||
'headers' => ['Content-Type' => 'application/merge-patch+json'],
|
||||
'json' => [
|
||||
'sites' => [],
|
||||
],
|
||||
]);
|
||||
|
||||
self::assertResponseIsSuccessful();
|
||||
|
||||
$em = $this->getEm();
|
||||
$em->clear();
|
||||
$reloaded = $em->getRepository(User::class)->find($aliceId);
|
||||
self::assertCount(0, $reloaded->getSites());
|
||||
self::assertNull($reloaded->getCurrentSite());
|
||||
|
||||
$this->restoreAliceSites();
|
||||
}
|
||||
|
||||
public function testCurrentSiteFieldInRbacPayloadIsSilentlyIgnored(): void
|
||||
{
|
||||
// Garde structurelle : `currentSite` n'est pas dans le groupe
|
||||
// user:rbac:write. Un client malveillant qui essaierait de set un
|
||||
// currentSite arbitraire via /rbac doit etre silencieusement
|
||||
// ignore (le seul flux autorise est PATCH /me/current-site).
|
||||
$em = $this->getEm();
|
||||
$pommevic = $em->getRepository(Site::class)->findOneBy(['name' => 'Pommevic']);
|
||||
$alice = $em->getRepository(User::class)->findOneBy(['username' => 'alice']);
|
||||
$aliceId = $alice->getId();
|
||||
$em->clear();
|
||||
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$client->request('PATCH', '/api/users/'.$aliceId.'/rbac', [
|
||||
'headers' => ['Content-Type' => 'application/merge-patch+json'],
|
||||
'json' => [
|
||||
'currentSite' => '/api/sites/'.$pommevic->getId(),
|
||||
],
|
||||
]);
|
||||
|
||||
self::assertResponseIsSuccessful();
|
||||
|
||||
// alice n'a Pommevic ni dans ses sites ni en currentSite (le champ
|
||||
// a ete ignore par le denormalizer). Son currentSite reste son
|
||||
// Chatellerault d'origine.
|
||||
$em = $this->getEm();
|
||||
$em->clear();
|
||||
$reloaded = $em->getRepository(User::class)->find($aliceId);
|
||||
self::assertNotNull($reloaded);
|
||||
self::assertNotNull($reloaded->getCurrentSite());
|
||||
self::assertSame('Chatellerault', $reloaded->getCurrentSite()->getName());
|
||||
}
|
||||
|
||||
public function testRbacPatchWithoutSitesFieldDoesNotChangeCurrentSite(): void
|
||||
{
|
||||
// Garde structurelle : si le payload /rbac ne contient pas le champ
|
||||
// `sites`, ensureCurrentSiteConsistency ne doit pas auto-modifier
|
||||
// le currentSite (alice avait deja Chatellerault). Un PATCH qui
|
||||
// change uniquement isAdmin ou roles ne doit pas remuer la
|
||||
// configuration site de l'user.
|
||||
$em = $this->getEm();
|
||||
$alice = $em->getRepository(User::class)->findOneBy(['username' => 'alice']);
|
||||
$aliceId = $alice->getId();
|
||||
$em->clear();
|
||||
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$client->request('PATCH', '/api/users/'.$aliceId.'/rbac', [
|
||||
'headers' => ['Content-Type' => 'application/merge-patch+json'],
|
||||
'json' => [
|
||||
'isAdmin' => false,
|
||||
],
|
||||
]);
|
||||
|
||||
self::assertResponseIsSuccessful();
|
||||
|
||||
$em = $this->getEm();
|
||||
$em->clear();
|
||||
$reloaded = $em->getRepository(User::class)->find($aliceId);
|
||||
self::assertNotNull($reloaded->getCurrentSite());
|
||||
self::assertSame('Chatellerault', $reloaded->getCurrentSite()->getName());
|
||||
}
|
||||
|
||||
/**
|
||||
* Remet alice dans l'etat des fixtures : un seul site Chatellerault,
|
||||
* currentSite Chatellerault. Evite la pollution inter-tests.
|
||||
*/
|
||||
private function restoreAliceSites(): void
|
||||
{
|
||||
$em = $this->getEm();
|
||||
$chatellerault = $em->getRepository(Site::class)->findOneBy(['name' => 'Chatellerault']);
|
||||
$alice = $em->getRepository(User::class)->findOneBy(['username' => 'alice']);
|
||||
|
||||
// Reset complet des sites
|
||||
foreach ($alice->getSites() as $existing) {
|
||||
$alice->removeSite($existing);
|
||||
}
|
||||
$alice->addSite($chatellerault);
|
||||
$alice->setCurrentSite($chatellerault);
|
||||
$em->flush();
|
||||
}
|
||||
}
|
||||
@@ -50,6 +50,14 @@ final class UserRbacProcessorTest extends TestCase
|
||||
|
||||
$this->entityManager->method('getUnitOfWork')->willReturn($this->unitOfWork);
|
||||
|
||||
// wrapInTransaction doit executer reellement la closure pour que le
|
||||
// resultat de persistProcessor->process() soit capture dans $result.
|
||||
// Sans ce stub, la closure n'est jamais invoquee et $result reste null.
|
||||
$this->entityManager
|
||||
->method('wrapInTransaction')
|
||||
->willReturnCallback(static fn (callable $fn) => $fn())
|
||||
;
|
||||
|
||||
$this->processor = new UserRbacProcessor(
|
||||
$this->persistProcessor,
|
||||
$this->entityManager,
|
||||
|
||||
99
tests/Module/Sites/Api/CurrentSiteSwitchApiTest.php
Normal file
99
tests/Module/Sites/Api/CurrentSiteSwitchApiTest.php
Normal file
@@ -0,0 +1,99 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Tests\Module\Sites\Api;
|
||||
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use App\Tests\Module\Core\Api\AbstractApiTestCase;
|
||||
|
||||
/**
|
||||
* Tests fonctionnels de l'endpoint PATCH /api/me/current-site (switch).
|
||||
*
|
||||
* Fixtures utilisees :
|
||||
* - alice : rattachee a Chatellerault uniquement (currentSite = Chatellerault).
|
||||
* - admin : rattache aux 3 sites.
|
||||
* - bob : rattache a Saint-Jean uniquement.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class CurrentSiteSwitchApiTest extends AbstractApiTestCase
|
||||
{
|
||||
public function testUserCanSwitchToAuthorizedSite(): void
|
||||
{
|
||||
// admin a les 3 sites. On le bascule de Chatellerault vers Pommevic.
|
||||
$em = $this->getEm();
|
||||
$pommevic = $em->getRepository(Site::class)->findOneBy(['name' => 'Pommevic']);
|
||||
self::assertNotNull($pommevic);
|
||||
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$response = $client->request('PATCH', '/api/me/current-site', [
|
||||
'headers' => ['Content-Type' => 'application/merge-patch+json'],
|
||||
'json' => ['site' => '/api/sites/'.$pommevic->getId()],
|
||||
]);
|
||||
|
||||
self::assertResponseIsSuccessful();
|
||||
$data = $response->toArray();
|
||||
self::assertSame('Pommevic', $data['currentSite']['name']);
|
||||
}
|
||||
|
||||
public function testUserCannotSwitchToUnauthorizedSite(): void
|
||||
{
|
||||
// alice n'a que Chatellerault. Tenter Pommevic → 400 (anti-enumeration).
|
||||
//
|
||||
// Depuis l'ajout de SiteCollectionScopedExtension, les sites hors
|
||||
// du scope de l'user sont filtres a la source : l'IriConverter ne
|
||||
// peut pas resoudre `/api/sites/{id}` pour un site non autorise et
|
||||
// leve 400 "Item not found". Reponse identique a "site inexistant",
|
||||
// ce qui empeche l'enumeration des ids de sites tiers. Avant la PR
|
||||
// scope, le processor traduisait SiteNotAuthorizedException → 403.
|
||||
$em = $this->getEm();
|
||||
$pommevic = $em->getRepository(Site::class)->findOneBy(['name' => 'Pommevic']);
|
||||
self::assertNotNull($pommevic);
|
||||
|
||||
$client = $this->authenticatedClient('alice', 'alice');
|
||||
$client->request('PATCH', '/api/me/current-site', [
|
||||
'headers' => ['Content-Type' => 'application/merge-patch+json'],
|
||||
'json' => ['site' => '/api/sites/'.$pommevic->getId()],
|
||||
]);
|
||||
|
||||
self::assertResponseStatusCodeSame(400);
|
||||
}
|
||||
|
||||
public function testSwitchWithMissingSiteFieldReturns400(): void
|
||||
{
|
||||
$client = $this->authenticatedClient('alice', 'alice');
|
||||
$client->request('PATCH', '/api/me/current-site', [
|
||||
'headers' => ['Content-Type' => 'application/merge-patch+json'],
|
||||
'json' => [],
|
||||
]);
|
||||
|
||||
self::assertResponseStatusCodeSame(400);
|
||||
}
|
||||
|
||||
public function testAnonymousUserCannotSwitch(): void
|
||||
{
|
||||
$client = self::createClient();
|
||||
$client->request('PATCH', '/api/me/current-site', [
|
||||
'headers' => ['Content-Type' => 'application/merge-patch+json'],
|
||||
'json' => ['site' => '/api/sites/1'],
|
||||
]);
|
||||
|
||||
self::assertResponseStatusCodeSame(401);
|
||||
}
|
||||
|
||||
public function testSwitchWithNonExistentSiteIriReturnsErrorStatus(): void
|
||||
{
|
||||
// IRI vers un site qui n'existe pas en base : API Platform leve un
|
||||
// 400 Bad Request a la denormalisation (l'IriConverter ne peut pas
|
||||
// resoudre l'IRI). On grave le code de retour reel pour eviter
|
||||
// qu'une regression silencieuse passe inapercue.
|
||||
$client = $this->authenticatedClient('alice', 'alice');
|
||||
$client->request('PATCH', '/api/me/current-site', [
|
||||
'headers' => ['Content-Type' => 'application/merge-patch+json'],
|
||||
'json' => ['site' => '/api/sites/999999'],
|
||||
]);
|
||||
|
||||
self::assertResponseStatusCodeSame(400);
|
||||
}
|
||||
}
|
||||
116
tests/Module/Sites/Api/MeEndpointSitesTest.php
Normal file
116
tests/Module/Sites/Api/MeEndpointSitesTest.php
Normal file
@@ -0,0 +1,116 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Tests\Module\Sites\Api;
|
||||
|
||||
use App\Module\Core\Domain\Entity\User;
|
||||
use App\Tests\Module\Core\Api\AbstractApiTestCase;
|
||||
|
||||
/**
|
||||
* Tests d'exposition des sites autorises et du site courant dans /api/me.
|
||||
*
|
||||
* Regression-guard du contrat avec le front (ticket 3) : `sites` doit etre
|
||||
* une liste d'objets Site complets (pas des IRIs), et `currentSite` doit
|
||||
* etre un objet ou null. Les clients front consomment directement ces
|
||||
* champs pour alimenter le SiteSelector et le store auth.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class MeEndpointSitesTest extends AbstractApiTestCase
|
||||
{
|
||||
public function testMeExposesSitesAsObjects(): void
|
||||
{
|
||||
$client = $this->authenticatedClient('alice', 'alice');
|
||||
$response = $client->request('GET', '/api/me');
|
||||
|
||||
self::assertResponseIsSuccessful();
|
||||
$data = $response->toArray();
|
||||
|
||||
self::assertArrayHasKey('sites', $data);
|
||||
self::assertIsArray($data['sites']);
|
||||
self::assertCount(1, $data['sites']);
|
||||
|
||||
$firstSite = $data['sites'][0];
|
||||
self::assertIsArray($firstSite, 'Un site doit etre serialise en objet, pas en IRI string.');
|
||||
self::assertArrayHasKey('id', $firstSite);
|
||||
self::assertArrayHasKey('name', $firstSite);
|
||||
self::assertArrayHasKey('street', $firstSite);
|
||||
self::assertArrayHasKey('city', $firstSite);
|
||||
self::assertArrayHasKey('color', $firstSite);
|
||||
// Le getter computed est expose en lecture pour eviter au front
|
||||
// de redupliquer la logique de concatenation.
|
||||
self::assertArrayHasKey('fullAddress', $firstSite);
|
||||
self::assertSame('Chatellerault', $firstSite['name']);
|
||||
|
||||
// Garde anti-cycle (cf. Site::$users sans Groups, ticket 2 spec
|
||||
// section 12 risque 6) : la collection inverse ne doit JAMAIS etre
|
||||
// serialisee dans /api/me sous peine de boucle infinie
|
||||
// User → sites → users → sites → ...
|
||||
self::assertArrayNotHasKey(
|
||||
'users',
|
||||
$firstSite,
|
||||
'Site.users ne doit JAMAIS etre serialise dans /api/me (cycle infini).',
|
||||
);
|
||||
}
|
||||
|
||||
public function testMeExposesCurrentSiteAsObject(): void
|
||||
{
|
||||
$client = $this->authenticatedClient('alice', 'alice');
|
||||
$response = $client->request('GET', '/api/me');
|
||||
|
||||
self::assertResponseIsSuccessful();
|
||||
$data = $response->toArray();
|
||||
|
||||
self::assertArrayHasKey('currentSite', $data);
|
||||
self::assertIsArray($data['currentSite'], 'currentSite doit etre un objet, pas une IRI.');
|
||||
self::assertSame('Chatellerault', $data['currentSite']['name']);
|
||||
}
|
||||
|
||||
public function testAdminHasAllThreeSites(): void
|
||||
{
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$response = $client->request('GET', '/api/me');
|
||||
|
||||
$data = $response->toArray();
|
||||
self::assertCount(3, $data['sites']);
|
||||
|
||||
$names = array_column($data['sites'], 'name');
|
||||
sort($names);
|
||||
self::assertSame(['Chatellerault', 'Pommevic', 'Saint-Jean'], $names);
|
||||
}
|
||||
|
||||
public function testUserWithoutSitesHasEmptyArrayAndNullCurrent(): void
|
||||
{
|
||||
// Creer un user jetable sans rattachement a un site.
|
||||
$em = $this->getEm();
|
||||
|
||||
$suffix = substr(bin2hex(random_bytes(4)), 0, 8);
|
||||
$username = 'orphan_'.$suffix;
|
||||
|
||||
$hasher = self::getContainer()->get('security.user_password_hasher');
|
||||
$user = new User();
|
||||
$user->setUsername($username);
|
||||
$user->setIsAdmin(false);
|
||||
$user->setPassword($hasher->hashPassword($user, 'testpass'));
|
||||
$em->persist($user);
|
||||
$em->flush();
|
||||
|
||||
try {
|
||||
$client = $this->authenticatedClient($username, 'testpass');
|
||||
$response = $client->request('GET', '/api/me');
|
||||
|
||||
self::assertResponseIsSuccessful();
|
||||
$data = $response->toArray();
|
||||
self::assertSame([], $data['sites']);
|
||||
self::assertNull($data['currentSite']);
|
||||
} finally {
|
||||
$em = $this->getEm();
|
||||
$reloaded = $em->getRepository(User::class)->findOneBy(['username' => $username]);
|
||||
if (null !== $reloaded) {
|
||||
$em->remove($reloaded);
|
||||
$em->flush();
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
235
tests/Module/Sites/Api/SiteApiTest.php
Normal file
235
tests/Module/Sites/Api/SiteApiTest.php
Normal file
@@ -0,0 +1,235 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Tests\Module\Sites\Api;
|
||||
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use App\Tests\Module\Core\Api\AbstractApiTestCase;
|
||||
|
||||
/**
|
||||
* Tests fonctionnels CRUD /api/sites avec matrices RBAC.
|
||||
*
|
||||
* Strategie : les 3 sites fixtures (Chatellerault, Saint-Jean, Pommevic)
|
||||
* sont presents a chaque test. On nettoie les sites crees par les tests
|
||||
* via un prefixe `Test-` en setUp + tearDown.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class SiteApiTest extends AbstractApiTestCase
|
||||
{
|
||||
private const TEST_NAME_PREFIX = 'Test-';
|
||||
|
||||
protected function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
$this->cleanupTestSites();
|
||||
}
|
||||
|
||||
protected function tearDown(): void
|
||||
{
|
||||
$this->cleanupTestSites();
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
public function testAdminCanListSites(): void
|
||||
{
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$response = $client->request('GET', '/api/sites');
|
||||
|
||||
self::assertResponseIsSuccessful();
|
||||
$data = $response->toArray();
|
||||
self::assertGreaterThanOrEqual(3, $data['totalItems']);
|
||||
}
|
||||
|
||||
public function testUserWithSitesViewCanListSites(): void
|
||||
{
|
||||
$this->skipIfSitesModuleDisabled();
|
||||
$credentials = $this->createUserWithPermission('sites.view');
|
||||
$client = $this->authenticatedClient($credentials['username'], $credentials['password']);
|
||||
$client->request('GET', '/api/sites');
|
||||
|
||||
self::assertResponseIsSuccessful();
|
||||
}
|
||||
|
||||
public function testUserWithoutPermissionGetsForbidden(): void
|
||||
{
|
||||
// alice a la permission via son role "user" ? Non : le role user par
|
||||
// defaut n'a aucune permission. Elle ne peut donc pas lister.
|
||||
$client = $this->authenticatedClient('alice', 'alice');
|
||||
$client->request('GET', '/api/sites');
|
||||
|
||||
self::assertResponseStatusCodeSame(403);
|
||||
}
|
||||
|
||||
public function testUnauthenticatedGetCollectionReturns401(): void
|
||||
{
|
||||
$client = self::createClient();
|
||||
$client->request('GET', '/api/sites');
|
||||
|
||||
self::assertResponseStatusCodeSame(401);
|
||||
}
|
||||
|
||||
public function testAdminCanCreateSite(): void
|
||||
{
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$response = $client->request('POST', '/api/sites', [
|
||||
'headers' => ['Content-Type' => 'application/ld+json'],
|
||||
'json' => [
|
||||
'name' => 'Test-New-Site',
|
||||
'street' => '1 rue du Test',
|
||||
'complement' => null,
|
||||
'postalCode' => '86000',
|
||||
'city' => 'Poitiers',
|
||||
'color' => '#AABBCC',
|
||||
],
|
||||
]);
|
||||
|
||||
self::assertResponseStatusCodeSame(201);
|
||||
$data = $response->toArray();
|
||||
self::assertSame('Test-New-Site', $data['name']);
|
||||
self::assertSame('#AABBCC', $data['color']);
|
||||
}
|
||||
|
||||
public function testAdminCanPatchSite(): void
|
||||
{
|
||||
$em = $this->getEm();
|
||||
$site = new Site('Test-Patch-Site', '1 rue Test', null, '86000', 'Poitiers', '#000000');
|
||||
$em->persist($site);
|
||||
$em->flush();
|
||||
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$response = $client->request('PATCH', '/api/sites/'.$site->getId(), [
|
||||
'headers' => ['Content-Type' => 'application/merge-patch+json'],
|
||||
'json' => ['color' => '#FF0000'],
|
||||
]);
|
||||
|
||||
self::assertResponseIsSuccessful();
|
||||
$data = $response->toArray();
|
||||
self::assertSame('#FF0000', $data['color']);
|
||||
}
|
||||
|
||||
public function testAdminCanDeleteSite(): void
|
||||
{
|
||||
$em = $this->getEm();
|
||||
$site = new Site('Test-Delete-Site', '1 rue Test', null, '86000', 'Poitiers', '#000000');
|
||||
$em->persist($site);
|
||||
$em->flush();
|
||||
$siteId = $site->getId();
|
||||
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$client->request('DELETE', '/api/sites/'.$siteId);
|
||||
|
||||
self::assertResponseStatusCodeSame(204);
|
||||
|
||||
$em->clear();
|
||||
self::assertNull($em->getRepository(Site::class)->find($siteId));
|
||||
}
|
||||
|
||||
public function testUserWithViewButNotManageCannotDelete(): void
|
||||
{
|
||||
$em = $this->getEm();
|
||||
$site = new Site('Test-Protected', '1 rue Test', null, '86000', 'Poitiers', '#000000');
|
||||
$em->persist($site);
|
||||
$em->flush();
|
||||
|
||||
$this->skipIfSitesModuleDisabled();
|
||||
$credentials = $this->createUserWithPermission('sites.view');
|
||||
$client = $this->authenticatedClient($credentials['username'], $credentials['password']);
|
||||
$client->request('DELETE', '/api/sites/'.$site->getId());
|
||||
|
||||
self::assertResponseStatusCodeSame(403);
|
||||
}
|
||||
|
||||
public function testCreateSiteWithDuplicateNameReturns422(): void
|
||||
{
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$client->request('POST', '/api/sites', [
|
||||
'headers' => ['Content-Type' => 'application/ld+json'],
|
||||
'json' => [
|
||||
'name' => 'Chatellerault',
|
||||
'street' => 'Autre rue',
|
||||
'postalCode' => '75001',
|
||||
'city' => 'Autre ville',
|
||||
'color' => '#FF0000',
|
||||
],
|
||||
]);
|
||||
|
||||
self::assertResponseStatusCodeSame(422);
|
||||
}
|
||||
|
||||
public function testCreateSiteWithInvalidColorReturns422(): void
|
||||
{
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$client->request('POST', '/api/sites', [
|
||||
'headers' => ['Content-Type' => 'application/ld+json'],
|
||||
'json' => [
|
||||
'name' => 'Test-Invalid-Color',
|
||||
'street' => '1 rue Test',
|
||||
'postalCode' => '86000',
|
||||
'city' => 'Poitiers',
|
||||
'color' => 'red',
|
||||
],
|
||||
]);
|
||||
|
||||
self::assertResponseStatusCodeSame(422);
|
||||
}
|
||||
|
||||
public function testCreateSiteIgnoresFullAddressInPayload(): void
|
||||
{
|
||||
// Garde structurelle : `fullAddress` est un getter computed cote
|
||||
// backend (Site::getFullAddress, groupe site:read uniquement). Si un
|
||||
// client envoie ce champ en POST, API Platform doit l'ignorer
|
||||
// silencieusement car il n'est pas dans le groupe site:write. On
|
||||
// grave ce comportement pour qu'un futur dev qui ajouterait un
|
||||
// setter casse ce test au lieu de casser l'invariant en silence.
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$response = $client->request('POST', '/api/sites', [
|
||||
'headers' => ['Content-Type' => 'application/ld+json'],
|
||||
'json' => [
|
||||
'name' => 'Test-FullAddress-Ignored',
|
||||
'street' => '1 rue Test',
|
||||
'postalCode' => '86000',
|
||||
'city' => 'Poitiers',
|
||||
'color' => '#000000',
|
||||
'fullAddress' => 'Adresse arbitraire envoyee par le client',
|
||||
],
|
||||
]);
|
||||
|
||||
self::assertResponseStatusCodeSame(201);
|
||||
$data = $response->toArray();
|
||||
// Le getter computed prevaut sur ce qu'envoie le client : street
|
||||
// determine la 1re ligne, jamais la valeur "Adresse arbitraire...".
|
||||
self::assertSame("1 rue Test\n86000 Poitiers", $data['fullAddress']);
|
||||
}
|
||||
|
||||
public function testCreateSiteWithInvalidPostalCodeReturns422(): void
|
||||
{
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$client->request('POST', '/api/sites', [
|
||||
'headers' => ['Content-Type' => 'application/ld+json'],
|
||||
'json' => [
|
||||
'name' => 'Test-Invalid-CP',
|
||||
'street' => '1 rue Test',
|
||||
'postalCode' => '123',
|
||||
'city' => 'Poitiers',
|
||||
'color' => '#000000',
|
||||
],
|
||||
]);
|
||||
|
||||
self::assertResponseStatusCodeSame(422);
|
||||
}
|
||||
|
||||
private function cleanupTestSites(): void
|
||||
{
|
||||
if (!self::$kernel) {
|
||||
self::bootKernel();
|
||||
}
|
||||
$em = $this->getEm();
|
||||
$em->createQuery('DELETE FROM '.Site::class.' s WHERE s.name LIKE :prefix')
|
||||
->setParameter('prefix', self::TEST_NAME_PREFIX.'%')
|
||||
->execute()
|
||||
;
|
||||
$em->clear();
|
||||
}
|
||||
}
|
||||
90
tests/Module/Sites/Api/SiteCascadeTest.php
Normal file
90
tests/Module/Sites/Api/SiteCascadeTest.php
Normal file
@@ -0,0 +1,90 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Tests\Module\Sites\Api;
|
||||
|
||||
use App\Module\Core\Domain\Entity\User;
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use App\Tests\Module\Core\Api\AbstractApiTestCase;
|
||||
|
||||
/**
|
||||
* Tests de cascade DB a la suppression d'un site.
|
||||
*
|
||||
* Verifie les deux comportements attendus :
|
||||
* - `user_site` a `ON DELETE CASCADE` : les rattachements sont supprimes ;
|
||||
* - `user.current_site_id` a `ON DELETE SET NULL` : les users pointant sur
|
||||
* le site supprime voient leur `currentSite` repasser a NULL.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class SiteCascadeTest extends AbstractApiTestCase
|
||||
{
|
||||
public function testDeletingSitePurgesUserSiteRows(): void
|
||||
{
|
||||
// Creer un site jetable et rattacher alice dessus.
|
||||
$em = $this->getEm();
|
||||
$site = new Site('Test-Cascade-Purge', '1 rue Test', null, '12345', 'Ville', '#000000');
|
||||
$em->persist($site);
|
||||
$em->flush();
|
||||
$siteId = $site->getId();
|
||||
|
||||
$alice = $em->getRepository(User::class)->findOneBy(['username' => 'alice']);
|
||||
self::assertNotNull($alice);
|
||||
$alice->addSite($site);
|
||||
$em->flush();
|
||||
$em->clear();
|
||||
|
||||
// Verifie presence du rattachement M2M via SQL direct (l'EM est cleared).
|
||||
$connection = $this->getEm()->getConnection();
|
||||
$before = (int) $connection->fetchOne(
|
||||
'SELECT COUNT(*) FROM user_site WHERE site_id = :id',
|
||||
['id' => $siteId],
|
||||
);
|
||||
self::assertSame(1, $before);
|
||||
|
||||
// Admin supprime le site.
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$client->request('DELETE', '/api/sites/'.$siteId);
|
||||
self::assertResponseStatusCodeSame(204);
|
||||
|
||||
// L'entree user_site doit avoir disparu via ON DELETE CASCADE.
|
||||
$after = (int) $connection->fetchOne(
|
||||
'SELECT COUNT(*) FROM user_site WHERE site_id = :id',
|
||||
['id' => $siteId],
|
||||
);
|
||||
self::assertSame(0, $after, 'Les rattachements user_site doivent etre purges en cascade.');
|
||||
}
|
||||
|
||||
public function testDeletingSiteSetsCurrentSiteToNullOnReferencingUsers(): void
|
||||
{
|
||||
$em = $this->getEm();
|
||||
$site = new Site('Test-Cascade-Current', '1 rue Test', null, '12345', 'Ville', '#000000');
|
||||
$em->persist($site);
|
||||
$em->flush();
|
||||
$siteId = $site->getId();
|
||||
|
||||
$alice = $em->getRepository(User::class)->findOneBy(['username' => 'alice']);
|
||||
self::assertNotNull($alice);
|
||||
$aliceId = $alice->getId();
|
||||
$alice->addSite($site);
|
||||
$alice->setCurrentSite($site);
|
||||
$em->flush();
|
||||
$em->clear();
|
||||
|
||||
// Admin supprime le site.
|
||||
$client = $this->authenticatedClient('admin', 'admin');
|
||||
$client->request('DELETE', '/api/sites/'.$siteId);
|
||||
self::assertResponseStatusCodeSame(204);
|
||||
|
||||
// currentSite d'alice doit etre passe a NULL via ON DELETE SET NULL.
|
||||
$em = $this->getEm();
|
||||
$em->clear();
|
||||
$reload = $em->getRepository(User::class)->find($aliceId);
|
||||
self::assertNotNull($reload);
|
||||
self::assertNull(
|
||||
$reload->getCurrentSite(),
|
||||
'currentSite doit etre NULL apres suppression du site reference.',
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,110 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Tests\Module\Sites\Application\Service;
|
||||
|
||||
use App\Module\Core\Domain\Entity\User;
|
||||
use App\Module\Sites\Application\Service\CurrentSiteProvider;
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use ReflectionClass;
|
||||
use Symfony\Bundle\SecurityBundle\Security;
|
||||
use Symfony\Component\Security\Core\User\InMemoryUser;
|
||||
|
||||
/**
|
||||
* Tests unitaires du CurrentSiteProvider.
|
||||
*
|
||||
* Le provider lit `config/modules.php` au boot via un `require`. Pour les
|
||||
* tests, on force la valeur du flag `sitesActive` via reflection plutot
|
||||
* que de mock le filesystem : le comportement du constructeur
|
||||
* (file_exists + require) est assez trivial pour etre couvert par un
|
||||
* test d'integration si besoin ; ici on se concentre sur la logique de
|
||||
* `get()`.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class CurrentSiteProviderTest extends TestCase
|
||||
{
|
||||
public function testReturnsNullIfSitesModuleInactive(): void
|
||||
{
|
||||
$user = new User();
|
||||
$user->setCurrentSite(new Site('Site', 'Rue', null, '12345', 'Ville', '#000000'));
|
||||
|
||||
$security = $this->createStub(Security::class);
|
||||
$security->method('getUser')->willReturn($user);
|
||||
|
||||
$provider = $this->makeProvider($security, sitesActive: false);
|
||||
|
||||
self::assertNull($provider->get());
|
||||
}
|
||||
|
||||
public function testReturnsNullIfNoUser(): void
|
||||
{
|
||||
$security = $this->createStub(Security::class);
|
||||
$security->method('getUser')->willReturn(null);
|
||||
|
||||
$provider = $this->makeProvider($security, sitesActive: true);
|
||||
|
||||
self::assertNull($provider->get());
|
||||
}
|
||||
|
||||
public function testReturnsNullIfUserIsNotAppUser(): void
|
||||
{
|
||||
// Un InMemoryUser Symfony n'est pas une instance de App\User donc
|
||||
// le provider ne peut pas lire son currentSite -> null defensif.
|
||||
$security = $this->createStub(Security::class);
|
||||
$security->method('getUser')->willReturn(new InMemoryUser('foo', 'bar'));
|
||||
|
||||
$provider = $this->makeProvider($security, sitesActive: true);
|
||||
|
||||
self::assertNull($provider->get());
|
||||
}
|
||||
|
||||
public function testReturnsNullIfUserHasNoCurrentSite(): void
|
||||
{
|
||||
$user = new User();
|
||||
// Pas d'appel a setCurrentSite, donc null par defaut.
|
||||
|
||||
$security = $this->createStub(Security::class);
|
||||
$security->method('getUser')->willReturn($user);
|
||||
|
||||
$provider = $this->makeProvider($security, sitesActive: true);
|
||||
|
||||
self::assertNull($provider->get());
|
||||
}
|
||||
|
||||
public function testReturnsSiteWhenAllConditionsMet(): void
|
||||
{
|
||||
$site = new Site('Chatellerault', 'Rue', null, '86100', 'Chatellerault', '#056CF2');
|
||||
$user = new User();
|
||||
$user->setCurrentSite($site);
|
||||
|
||||
$security = $this->createStub(Security::class);
|
||||
$security->method('getUser')->willReturn($user);
|
||||
|
||||
$provider = $this->makeProvider($security, sitesActive: true);
|
||||
|
||||
self::assertSame($site, $provider->get());
|
||||
}
|
||||
|
||||
/**
|
||||
* Factory helper : construit un provider avec `$sitesActive` force a
|
||||
* la valeur donnee, bypassant la lecture reelle de config/modules.php.
|
||||
*/
|
||||
private function makeProvider(Security $security, bool $sitesActive): CurrentSiteProvider
|
||||
{
|
||||
// Instance via reflection pour eviter l'appel reel au constructeur
|
||||
// qui require config/modules.php (non deterministe en test unit).
|
||||
$reflection = new ReflectionClass(CurrentSiteProvider::class);
|
||||
$provider = $reflection->newInstanceWithoutConstructor();
|
||||
|
||||
$securityProp = $reflection->getProperty('security');
|
||||
$securityProp->setValue($provider, $security);
|
||||
|
||||
$sitesActiveProp = $reflection->getProperty('sitesActive');
|
||||
$sitesActiveProp->setValue($provider, $sitesActive);
|
||||
|
||||
return $provider;
|
||||
}
|
||||
}
|
||||
133
tests/Module/Sites/Domain/Entity/SiteTest.php
Normal file
133
tests/Module/Sites/Domain/Entity/SiteTest.php
Normal file
@@ -0,0 +1,133 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Tests\Module\Sites\Domain\Entity;
|
||||
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use DateTimeImmutable;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use ReflectionClass;
|
||||
|
||||
/**
|
||||
* Tests unitaires de comportement de l'entite Site : etat initial, setters,
|
||||
* gestion des timestamps et getter d'adresse complete. Les contraintes de
|
||||
* validation (regex, unicite) sont couvertes par SiteValidationTest.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class SiteTest extends TestCase
|
||||
{
|
||||
public function testConstructorInitialState(): void
|
||||
{
|
||||
$site = new Site(
|
||||
name: 'Chatellerault',
|
||||
street: "1 avenue de l'Europe",
|
||||
complement: null,
|
||||
postalCode: '86100',
|
||||
city: 'Chatellerault',
|
||||
color: '#056CF2',
|
||||
);
|
||||
|
||||
self::assertNull($site->getId());
|
||||
self::assertSame('Chatellerault', $site->getName());
|
||||
self::assertSame("1 avenue de l'Europe", $site->getStreet());
|
||||
self::assertNull($site->getComplement());
|
||||
self::assertSame('86100', $site->getPostalCode());
|
||||
self::assertSame('Chatellerault', $site->getCity());
|
||||
self::assertSame('#056CF2', $site->getColor());
|
||||
self::assertInstanceOf(DateTimeImmutable::class, $site->getCreatedAt());
|
||||
self::assertInstanceOf(DateTimeImmutable::class, $site->getUpdatedAt());
|
||||
}
|
||||
|
||||
public function testCreatedAtAndUpdatedAtAreInitiallyEqual(): void
|
||||
{
|
||||
$site = new Site('A', 'Rue X', null, '12345', 'B', '#000000');
|
||||
|
||||
// A la creation, les deux timestamps sont seedes avec la meme valeur
|
||||
// pour garantir updated_at >= created_at au niveau base.
|
||||
self::assertEquals($site->getCreatedAt(), $site->getUpdatedAt());
|
||||
}
|
||||
|
||||
public function testOnPreUpdateAdvancesUpdatedAtOnly(): void
|
||||
{
|
||||
$site = new Site('A', 'Rue X', null, '12345', 'B', '#000000');
|
||||
$originalCreatedAt = $site->getCreatedAt();
|
||||
|
||||
// On force updatedAt a une valeur strictement anterieure via reflection
|
||||
// pour ne pas dependre d'un `sleep()` (flaky en CI, lent) : l'entite
|
||||
// n'expose volontairement pas de setter sur updatedAt, c'est le
|
||||
// callback Doctrine PreUpdate qui s'en charge.
|
||||
$pastUpdatedAt = new DateTimeImmutable('-1 hour');
|
||||
$reflection = new ReflectionClass(Site::class);
|
||||
$updatedAtProperty = $reflection->getProperty('updatedAt');
|
||||
$updatedAtProperty->setValue($site, $pastUpdatedAt);
|
||||
|
||||
$site->onPreUpdate();
|
||||
|
||||
self::assertSame($originalCreatedAt, $site->getCreatedAt(), 'created_at doit rester immuable apres un update.');
|
||||
self::assertGreaterThan($pastUpdatedAt, $site->getUpdatedAt(), 'updated_at doit avancer apres onPreUpdate().');
|
||||
}
|
||||
|
||||
public function testSettersMutateFields(): void
|
||||
{
|
||||
$site = new Site('Old', 'Old Street', null, '12345', 'OldCity', '#000000');
|
||||
|
||||
$site->setName('New');
|
||||
$site->setStreet('New Street');
|
||||
$site->setComplement('Bat A');
|
||||
$site->setPostalCode('67890');
|
||||
$site->setCity('NewCity');
|
||||
$site->setColor('#ABCDEF');
|
||||
|
||||
self::assertSame('New', $site->getName());
|
||||
self::assertSame('New Street', $site->getStreet());
|
||||
self::assertSame('Bat A', $site->getComplement());
|
||||
self::assertSame('67890', $site->getPostalCode());
|
||||
self::assertSame('NewCity', $site->getCity());
|
||||
self::assertSame('#ABCDEF', $site->getColor());
|
||||
}
|
||||
|
||||
public function testFullAddressGetterWithoutComplement(): void
|
||||
{
|
||||
$site = new Site(
|
||||
name: 'Site1',
|
||||
street: '1 avenue de l\'Europe',
|
||||
complement: null,
|
||||
postalCode: '86100',
|
||||
city: 'Chatellerault',
|
||||
color: '#000000',
|
||||
);
|
||||
|
||||
self::assertSame(
|
||||
"1 avenue de l'Europe\n86100 Chatellerault",
|
||||
$site->getFullAddress(),
|
||||
);
|
||||
}
|
||||
|
||||
public function testFullAddressGetterWithComplement(): void
|
||||
{
|
||||
$site = new Site(
|
||||
name: 'Site2',
|
||||
street: '12 route de Poitiers',
|
||||
complement: 'Batiment B',
|
||||
postalCode: '86330',
|
||||
city: 'Saint-Jean-de-Sauves',
|
||||
color: '#000000',
|
||||
);
|
||||
|
||||
self::assertSame(
|
||||
"12 route de Poitiers\nBatiment B\n86330 Saint-Jean-de-Sauves",
|
||||
$site->getFullAddress(),
|
||||
);
|
||||
}
|
||||
|
||||
public function testFullAddressGetterIgnoresEmptyComplement(): void
|
||||
{
|
||||
// Garde defensive : un complement vide ou whitespace-only ne doit
|
||||
// pas creer une ligne vide visuellement disgracieuse.
|
||||
$site = new Site('S', 'Rue', ' ', '12345', 'Ville', '#000000');
|
||||
|
||||
self::assertSame("Rue\n12345 Ville", $site->getFullAddress());
|
||||
}
|
||||
}
|
||||
291
tests/Module/Sites/Domain/Entity/SiteValidationTest.php
Normal file
291
tests/Module/Sites/Domain/Entity/SiteValidationTest.php
Normal file
@@ -0,0 +1,291 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Tests\Module\Sites\Domain\Entity;
|
||||
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use Doctrine\ORM\EntityManagerInterface;
|
||||
use PHPUnit\Framework\Attributes\DataProvider;
|
||||
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
|
||||
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
|
||||
use Symfony\Component\Validator\Validator\ValidatorInterface;
|
||||
|
||||
/**
|
||||
* Tests de validation de l'entite Site : contraintes scalaires (regex couleur
|
||||
* hex, regex code postal FR, NotBlank, Length) ET unicite du nom. Utilise le
|
||||
* validator applicatif (via KernelTestCase) afin que la contrainte
|
||||
* UniqueEntity, adossee a Doctrine, puisse reellement interroger la base de
|
||||
* test.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class SiteValidationTest extends KernelTestCase
|
||||
{
|
||||
private ValidatorInterface $validator;
|
||||
private EntityManagerInterface $em;
|
||||
|
||||
protected function setUp(): void
|
||||
{
|
||||
self::bootKernel();
|
||||
$container = self::getContainer();
|
||||
|
||||
/** @var ValidatorInterface $validator */
|
||||
$validator = $container->get(ValidatorInterface::class);
|
||||
$this->validator = $validator;
|
||||
|
||||
/** @var EntityManagerInterface $em */
|
||||
$em = $container->get(EntityManagerInterface::class);
|
||||
$this->em = $em;
|
||||
}
|
||||
|
||||
protected function tearDown(): void
|
||||
{
|
||||
// Liberation explicite des handles pour eviter les fuites inter-tests
|
||||
// (pattern recommande par Symfony lorsque l'on capture le container).
|
||||
$this->em->clear();
|
||||
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
public function testValidSitePassesValidation(): void
|
||||
{
|
||||
$site = $this->makeSite();
|
||||
$violations = $this->validator->validate($site);
|
||||
|
||||
self::assertCount(0, $violations, (string) $violations);
|
||||
}
|
||||
|
||||
public function testValidSiteWithComplementPassesValidation(): void
|
||||
{
|
||||
$site = $this->makeSite(complement: 'Batiment C');
|
||||
$violations = $this->validator->validate($site);
|
||||
|
||||
self::assertCount(0, $violations, (string) $violations);
|
||||
}
|
||||
|
||||
#[DataProvider('invalidColorProvider')]
|
||||
public function testColorMustBeHexRrggbb(string $color): void
|
||||
{
|
||||
$site = $this->makeSite(color: $color);
|
||||
$violations = $this->validator->validate($site);
|
||||
|
||||
self::assertGreaterThan(0, $violations->count(), sprintf('La couleur "%s" devrait etre rejetee.', $color));
|
||||
}
|
||||
|
||||
/**
|
||||
* @return iterable<string, array{string}>
|
||||
*/
|
||||
public static function invalidColorProvider(): iterable
|
||||
{
|
||||
yield 'nom CSS' => ['red'];
|
||||
|
||||
yield 'hex court' => ['#FFF'];
|
||||
|
||||
yield 'hex sans diese' => ['FFFFFF'];
|
||||
|
||||
yield 'rgb()' => ['rgb(255, 0, 0)'];
|
||||
|
||||
yield 'hex trop long' => ['#1234567'];
|
||||
|
||||
yield 'caractere non hex' => ['#12345G'];
|
||||
|
||||
yield 'vide' => [''];
|
||||
}
|
||||
|
||||
#[DataProvider('validColorProvider')]
|
||||
public function testValidColorsAreAccepted(string $color): void
|
||||
{
|
||||
$site = $this->makeSite(color: $color);
|
||||
$violations = $this->validator->validate($site);
|
||||
|
||||
self::assertCount(0, $violations, sprintf('La couleur "%s" devrait etre acceptee.', $color));
|
||||
}
|
||||
|
||||
/**
|
||||
* @return iterable<string, array{string}>
|
||||
*/
|
||||
public static function validColorProvider(): iterable
|
||||
{
|
||||
yield 'majuscules' => ['#ABCDEF'];
|
||||
|
||||
yield 'minuscules' => ['#abcdef'];
|
||||
|
||||
yield 'mixte' => ['#0a1B2c'];
|
||||
|
||||
yield 'noir' => ['#000000'];
|
||||
|
||||
yield 'blanc' => ['#FFFFFF'];
|
||||
}
|
||||
|
||||
#[DataProvider('invalidPostalCodeProvider')]
|
||||
public function testPostalCodeMustMatchFrFormat(string $postalCode): void
|
||||
{
|
||||
$site = $this->makeSite(postalCode: $postalCode);
|
||||
$violations = $this->validator->validate($site);
|
||||
|
||||
self::assertGreaterThan(0, $violations->count(), sprintf('Le CP "%s" devrait etre rejete.', $postalCode));
|
||||
}
|
||||
|
||||
/**
|
||||
* @return iterable<string, array{string}>
|
||||
*/
|
||||
public static function invalidPostalCodeProvider(): iterable
|
||||
{
|
||||
yield 'trop court' => ['1234'];
|
||||
|
||||
yield 'trop long' => ['123456'];
|
||||
|
||||
yield 'alphanumerique' => ['8610A'];
|
||||
|
||||
yield 'avec tiret' => ['86-100'];
|
||||
|
||||
yield 'vide' => [''];
|
||||
|
||||
yield 'avec espace' => ['86 100'];
|
||||
}
|
||||
|
||||
#[DataProvider('validPostalCodeProvider')]
|
||||
public function testValidPostalCodesAreAccepted(string $postalCode): void
|
||||
{
|
||||
$site = $this->makeSite(postalCode: $postalCode);
|
||||
$violations = $this->validator->validate($site);
|
||||
|
||||
self::assertCount(0, $violations, (string) $violations);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return iterable<string, array{string}>
|
||||
*/
|
||||
public static function validPostalCodeProvider(): iterable
|
||||
{
|
||||
yield 'metropole' => ['86100'];
|
||||
|
||||
yield 'paris' => ['75001'];
|
||||
|
||||
yield 'dom' => ['97100'];
|
||||
|
||||
yield 'corse' => ['20000'];
|
||||
}
|
||||
|
||||
public function testBlankNameIsRejected(): void
|
||||
{
|
||||
$site = $this->makeSite(name: '');
|
||||
$violations = $this->validator->validate($site);
|
||||
|
||||
self::assertGreaterThan(0, $violations->count());
|
||||
}
|
||||
|
||||
public function testBlankStreetIsRejected(): void
|
||||
{
|
||||
$site = $this->makeSite(street: '');
|
||||
$violations = $this->validator->validate($site);
|
||||
|
||||
self::assertGreaterThan(0, $violations->count());
|
||||
}
|
||||
|
||||
public function testBlankCityIsRejected(): void
|
||||
{
|
||||
$site = $this->makeSite(city: '');
|
||||
$violations = $this->validator->validate($site);
|
||||
|
||||
self::assertGreaterThan(0, $violations->count());
|
||||
}
|
||||
|
||||
public function testNameLongerThan100CharsIsRejected(): void
|
||||
{
|
||||
$site = $this->makeSite(name: str_repeat('a', 101));
|
||||
$violations = $this->validator->validate($site);
|
||||
|
||||
self::assertGreaterThan(0, $violations->count());
|
||||
}
|
||||
|
||||
public function testCityLongerThan100CharsIsRejected(): void
|
||||
{
|
||||
$site = $this->makeSite(city: str_repeat('a', 101));
|
||||
$violations = $this->validator->validate($site);
|
||||
|
||||
self::assertGreaterThan(0, $violations->count());
|
||||
}
|
||||
|
||||
public function testStreetLongerThan255CharsIsRejected(): void
|
||||
{
|
||||
$site = $this->makeSite(street: str_repeat('a', 256));
|
||||
$violations = $this->validator->validate($site);
|
||||
|
||||
self::assertGreaterThan(0, $violations->count());
|
||||
}
|
||||
|
||||
public function testComplementLongerThan255CharsIsRejected(): void
|
||||
{
|
||||
$site = $this->makeSite(complement: str_repeat('a', 256));
|
||||
$violations = $this->validator->validate($site);
|
||||
|
||||
self::assertGreaterThan(0, $violations->count());
|
||||
}
|
||||
|
||||
/**
|
||||
* Verifie que la contrainte UniqueEntity(name) est effectivement appliquee
|
||||
* par le validator Symfony (via le validateur Doctrine sous-jacent).
|
||||
*
|
||||
* Le test est auto-suffisant : il persiste lui-meme un site porteur d'un
|
||||
* nom unique, puis tente de valider un second Site avec le meme nom. Le
|
||||
* site cree est supprime en fin de test pour ne pas laisser de trace
|
||||
* inter-tests (pattern transactionnel non utilise ici car un seul test
|
||||
* persiste, un cleanup explicite suffit).
|
||||
*/
|
||||
public function testDuplicateNameIsRejected(): void
|
||||
{
|
||||
$name = 'Test-Duplicate-'.uniqid('', true);
|
||||
$original = $this->makeSite(name: $name);
|
||||
$this->em->persist($original);
|
||||
$this->em->flush();
|
||||
|
||||
try {
|
||||
$duplicate = $this->makeSite(name: $name, city: 'Autre');
|
||||
$violations = $this->validator->validate($duplicate);
|
||||
|
||||
self::assertGreaterThan(0, $violations->count(), 'Un site homonyme doit lever au moins une violation.');
|
||||
|
||||
// Assertion precise : on veut s'assurer que la violation levee
|
||||
// est bien UniqueEntity sur `name`, pas une autre contrainte
|
||||
// qui passerait par hasard (matching de message trop laxe).
|
||||
$found = false;
|
||||
foreach ($violations as $violation) {
|
||||
if (UniqueEntity::NOT_UNIQUE_ERROR === $violation->getCode()
|
||||
&& 'name' === $violation->getPropertyPath()) {
|
||||
$found = true;
|
||||
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
self::assertTrue($found, 'Violation UniqueEntity(name) attendue (code NOT_UNIQUE_ERROR sur property `name`).');
|
||||
} finally {
|
||||
$this->em->remove($original);
|
||||
$this->em->flush();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper : construit un Site valide avec un nom unique, sur lequel on
|
||||
* peut superposer un seul champ invalide pour tester une contrainte.
|
||||
*/
|
||||
private function makeSite(
|
||||
?string $name = null,
|
||||
string $street = '1 rue Test',
|
||||
?string $complement = null,
|
||||
string $postalCode = '12345',
|
||||
string $city = 'Poitiers',
|
||||
string $color = '#000000',
|
||||
): Site {
|
||||
return new Site(
|
||||
$name ?? 'Test-'.uniqid('', true),
|
||||
$street,
|
||||
$complement,
|
||||
$postalCode,
|
||||
$city,
|
||||
$color,
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,237 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Tests\Module\Sites\Infrastructure\ApiPlatform\Extension;
|
||||
|
||||
use ApiPlatform\Doctrine\Orm\Util\QueryNameGenerator;
|
||||
use App\Module\Core\Domain\Entity\User;
|
||||
use App\Module\Sites\Application\Service\CurrentSiteProviderInterface;
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use App\Module\Sites\Infrastructure\ApiPlatform\Extension\SiteScopedQueryExtension;
|
||||
use App\Tests\Fixtures\SiteAware\FakeSiteAwareEntity;
|
||||
use Doctrine\ORM\EntityManagerInterface;
|
||||
use Doctrine\ORM\Tools\SchemaTool;
|
||||
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
|
||||
use Symfony\Bundle\SecurityBundle\Security;
|
||||
|
||||
/**
|
||||
* Tests d'integration de SiteScopedQueryExtension.
|
||||
*
|
||||
* Approche : on cree la table `fake_site_aware_entity` a la volee via
|
||||
* SchemaTool dans le setUp, on y persiste 2 entites sur siteA + 1 sur
|
||||
* siteB, puis on construit un QueryBuilder via EntityManager et on
|
||||
* invoque l'extension a la main (pas besoin de monter un endpoint API
|
||||
* Platform complet — on teste la logique du filtre).
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class SiteScopedQueryExtensionTest extends KernelTestCase
|
||||
{
|
||||
private EntityManagerInterface $em;
|
||||
private Site $siteA;
|
||||
private Site $siteB;
|
||||
|
||||
protected function setUp(): void
|
||||
{
|
||||
self::bootKernel();
|
||||
$container = self::getContainer();
|
||||
|
||||
/** @var EntityManagerInterface $em */
|
||||
$em = $container->get(EntityManagerInterface::class);
|
||||
$this->em = $em;
|
||||
|
||||
// Creation de la table fake_site_aware_entity uniquement.
|
||||
// La base de test partage deja les autres tables (site, user, etc.).
|
||||
$metadata = $this->em->getClassMetadata(FakeSiteAwareEntity::class);
|
||||
$schema = new SchemaTool($this->em);
|
||||
// Drop si existe deja (re-run des tests), puis create.
|
||||
$schema->dropSchema([$metadata]);
|
||||
$schema->createSchema([$metadata]);
|
||||
|
||||
// Fixtures locales : 2 entites sur siteA, 1 sur siteB.
|
||||
$this->siteA = $this->em->getRepository(Site::class)->findOneBy(['name' => 'Chatellerault']);
|
||||
$this->siteB = $this->em->getRepository(Site::class)->findOneBy(['name' => 'Saint-Jean']);
|
||||
self::assertNotNull($this->siteA);
|
||||
self::assertNotNull($this->siteB);
|
||||
|
||||
$e1 = new FakeSiteAwareEntity('A-in-site-A');
|
||||
$e1->setSite($this->siteA);
|
||||
$e2 = new FakeSiteAwareEntity('B-in-site-A');
|
||||
$e2->setSite($this->siteA);
|
||||
$e3 = new FakeSiteAwareEntity('C-in-site-B');
|
||||
$e3->setSite($this->siteB);
|
||||
|
||||
$this->em->persist($e1);
|
||||
$this->em->persist($e2);
|
||||
$this->em->persist($e3);
|
||||
$this->em->flush();
|
||||
$this->em->clear();
|
||||
}
|
||||
|
||||
protected function tearDown(): void
|
||||
{
|
||||
// Drop de la table fake entre tests pour eviter toute pollution.
|
||||
if (isset($this->em)) {
|
||||
$metadata = $this->em->getClassMetadata(FakeSiteAwareEntity::class);
|
||||
$schema = new SchemaTool($this->em);
|
||||
$schema->dropSchema([$metadata]);
|
||||
$this->em->close();
|
||||
}
|
||||
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
public function testCollectionFilteredByCurrentSite(): void
|
||||
{
|
||||
$extension = $this->makeExtension($this->siteA);
|
||||
|
||||
$results = $this->runQuery($extension, FakeSiteAwareEntity::class);
|
||||
|
||||
self::assertCount(2, $results, '2 entites sur siteA doivent etre retournees.');
|
||||
foreach ($results as $entity) {
|
||||
self::assertSame($this->siteA->getId(), $entity->getSite()->getId());
|
||||
}
|
||||
}
|
||||
|
||||
public function testCollectionSwitchesToSiteB(): void
|
||||
{
|
||||
$extension = $this->makeExtension($this->siteB);
|
||||
|
||||
$results = $this->runQuery($extension, FakeSiteAwareEntity::class);
|
||||
|
||||
self::assertCount(1, $results);
|
||||
self::assertSame($this->siteB->getId(), $results[0]->getSite()->getId());
|
||||
}
|
||||
|
||||
public function testNoOpIfNoCurrentSite(): void
|
||||
{
|
||||
// Decision assumee (ticket 4 spec Risque 1) : no-op plutot que
|
||||
// collection vide. L'user sans currentSite voit TOUTES les entites.
|
||||
$extension = $this->makeExtension(currentSite: null);
|
||||
|
||||
$results = $this->runQuery($extension, FakeSiteAwareEntity::class);
|
||||
|
||||
self::assertCount(3, $results);
|
||||
}
|
||||
|
||||
public function testNoOpIfBypassScopePermission(): void
|
||||
{
|
||||
// User avec sites.bypass_scope voit TOUTES les entites, meme
|
||||
// avec un currentSite positionne. Comportement admin / audit.
|
||||
$extension = $this->makeExtension($this->siteA, bypassScope: true);
|
||||
|
||||
$results = $this->runQuery($extension, FakeSiteAwareEntity::class);
|
||||
|
||||
self::assertCount(3, $results);
|
||||
}
|
||||
|
||||
public function testNoOpIfResourceClassNotSiteAware(): void
|
||||
{
|
||||
// Une resource qui n'implemente pas SiteAwareInterface ne doit
|
||||
// jamais etre filtree (l'extension se contente d'un `return` tot).
|
||||
$extension = $this->makeExtension($this->siteA);
|
||||
|
||||
// On query les users (non SiteAware). Verification robuste : on
|
||||
// inspecte la partie WHERE du QueryBuilder avant et apres l'appel
|
||||
// a l'extension. Le before/after doit etre identique (idealement
|
||||
// null dans les deux cas vu qu'on n'a pas ajoute de WHERE).
|
||||
$qb = $this->em->createQueryBuilder()->select('u')->from(User::class, 'u');
|
||||
$nameGen = new QueryNameGenerator();
|
||||
|
||||
$whereBefore = $qb->getDQLPart('where');
|
||||
$extension->applyToCollection($qb, $nameGen, User::class);
|
||||
$whereAfter = $qb->getDQLPart('where');
|
||||
|
||||
self::assertEquals(
|
||||
$whereBefore,
|
||||
$whereAfter,
|
||||
'La clause WHERE du QueryBuilder doit etre intacte pour une resource non SiteAware.',
|
||||
);
|
||||
}
|
||||
|
||||
public function testItemNotFoundIfWrongSite(): void
|
||||
{
|
||||
// GET /api/entity/{id} pour un item du siteB alors que l'user est
|
||||
// sur siteA -> le filtre ajoute `WHERE site = siteA`, la requete
|
||||
// retourne null -> API Platform renverra 404.
|
||||
$em = $this->em;
|
||||
$entityB = $em->getRepository(FakeSiteAwareEntity::class)
|
||||
->findOneBy(['name' => 'C-in-site-B'])
|
||||
;
|
||||
self::assertNotNull($entityB);
|
||||
$idB = $entityB->getId();
|
||||
$em->clear();
|
||||
|
||||
$extension = $this->makeExtension($this->siteA);
|
||||
|
||||
$qb = $this->em->createQueryBuilder()
|
||||
->select('e')
|
||||
->from(FakeSiteAwareEntity::class, 'e')
|
||||
->andWhere('e.id = :id')
|
||||
->setParameter('id', $idB)
|
||||
;
|
||||
$nameGen = new QueryNameGenerator();
|
||||
|
||||
$extension->applyToItem($qb, $nameGen, FakeSiteAwareEntity::class, ['id' => $idB]);
|
||||
|
||||
self::assertNull($qb->getQuery()->getOneOrNullResult());
|
||||
}
|
||||
|
||||
public function testItemFoundIfCorrectSite(): void
|
||||
{
|
||||
$entityA = $this->em->getRepository(FakeSiteAwareEntity::class)
|
||||
->findOneBy(['name' => 'A-in-site-A'])
|
||||
;
|
||||
self::assertNotNull($entityA);
|
||||
$idA = $entityA->getId();
|
||||
$this->em->clear();
|
||||
|
||||
$extension = $this->makeExtension($this->siteA);
|
||||
|
||||
$qb = $this->em->createQueryBuilder()
|
||||
->select('e')
|
||||
->from(FakeSiteAwareEntity::class, 'e')
|
||||
->andWhere('e.id = :id')
|
||||
->setParameter('id', $idA)
|
||||
;
|
||||
$nameGen = new QueryNameGenerator();
|
||||
|
||||
$extension->applyToItem($qb, $nameGen, FakeSiteAwareEntity::class, ['id' => $idA]);
|
||||
|
||||
$result = $qb->getQuery()->getOneOrNullResult();
|
||||
self::assertNotNull($result);
|
||||
self::assertSame('A-in-site-A', $result->getName());
|
||||
}
|
||||
|
||||
/**
|
||||
* Construit une extension avec un provider et un security mockes selon
|
||||
* le scenario testé. Passe par reflection pour forcer le flag
|
||||
* sitesActive du provider sans toucher au filesystem.
|
||||
*/
|
||||
private function makeExtension(?Site $currentSite, bool $bypassScope = false): SiteScopedQueryExtension
|
||||
{
|
||||
// createStub : pas d'attentes sur le nombre d'appels, juste fixer
|
||||
// les valeurs de retour des methodes sollicitees. Evite les notices
|
||||
// PHPUnit "No expectations configured".
|
||||
$security = $this->createStub(Security::class);
|
||||
$security->method('isGranted')->willReturnCallback(
|
||||
fn (string $perm): bool => 'sites.bypass_scope' === $perm && $bypassScope,
|
||||
);
|
||||
|
||||
$provider = $this->createStub(CurrentSiteProviderInterface::class);
|
||||
$provider->method('get')->willReturn($currentSite);
|
||||
|
||||
return new SiteScopedQueryExtension($provider, $security);
|
||||
}
|
||||
|
||||
private function runQuery(SiteScopedQueryExtension $extension, string $resourceClass): array
|
||||
{
|
||||
$qb = $this->em->createQueryBuilder()->select('e')->from($resourceClass, 'e');
|
||||
$nameGen = new QueryNameGenerator();
|
||||
|
||||
$extension->applyToCollection($qb, $nameGen, $resourceClass);
|
||||
|
||||
return $qb->getQuery()->getResult();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,161 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Tests\Module\Sites\Infrastructure\ApiPlatform\State\Processor;
|
||||
|
||||
use ApiPlatform\Metadata\Operation;
|
||||
use ApiPlatform\Metadata\Post;
|
||||
use ApiPlatform\State\ProcessorInterface;
|
||||
use App\Module\Sites\Application\Service\CurrentSiteProviderInterface;
|
||||
use App\Module\Sites\Domain\Entity\Site;
|
||||
use App\Module\Sites\Infrastructure\ApiPlatform\State\Processor\SiteAwareInjectionProcessor;
|
||||
use App\Shared\Domain\Contract\SiteAwareInterface;
|
||||
use App\Shared\Domain\Contract\SiteInterface;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use stdClass;
|
||||
use Symfony\Bundle\SecurityBundle\Security;
|
||||
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
|
||||
|
||||
/**
|
||||
* Tests unitaires du SiteAwareInjectionProcessor.
|
||||
*
|
||||
* Mocks isoles : le processor decore, donc on verifie (a) les mutations
|
||||
* appliquees sur $data avant delegation, (b) que inner->process est
|
||||
* toujours invoque sauf en cas de throw, (c) le throw 400 explicite si
|
||||
* $data SiteAware sans site + provider null.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class SiteAwareInjectionProcessorTest extends TestCase
|
||||
{
|
||||
public function testInjectsCurrentSiteOnSiteAwareEntityWithoutSite(): void
|
||||
{
|
||||
$currentSite = new Site('Chatellerault', 'Rue', null, '86100', 'Chatellerault', '#056CF2');
|
||||
$data = $this->makeSiteAwareStub(null);
|
||||
|
||||
$inner = $this->createMock(ProcessorInterface::class);
|
||||
$inner->expects(self::once())
|
||||
->method('process')
|
||||
->willReturnArgument(0)
|
||||
;
|
||||
|
||||
$processor = $this->makeProcessor($inner, $currentSite);
|
||||
$processor->process($data, $this->makeOperation());
|
||||
|
||||
self::assertSame($currentSite, $data->getSite());
|
||||
}
|
||||
|
||||
public function testDoesNotOverrideExistingSite(): void
|
||||
{
|
||||
$existingSite = new Site('Existing', 'Rue', null, '12345', 'Ville', '#000000');
|
||||
$currentSite = new Site('Chatellerault', 'Rue', null, '86100', 'Chatellerault', '#056CF2');
|
||||
$data = $this->makeSiteAwareStub($existingSite);
|
||||
|
||||
$inner = $this->createMock(ProcessorInterface::class);
|
||||
$inner->expects(self::once())->method('process');
|
||||
|
||||
$processor = $this->makeProcessor($inner, $currentSite);
|
||||
$processor->process($data, $this->makeOperation());
|
||||
|
||||
self::assertSame(
|
||||
$existingSite,
|
||||
$data->getSite(),
|
||||
'Un site deja positionne doit etre preserve, pas ecrase par le currentSite.',
|
||||
);
|
||||
}
|
||||
|
||||
public function testSkipsNonSiteAwareData(): void
|
||||
{
|
||||
$nonSiteAware = new stdClass();
|
||||
|
||||
$inner = $this->createMock(ProcessorInterface::class);
|
||||
$inner->expects(self::once())
|
||||
->method('process')
|
||||
->with($nonSiteAware)
|
||||
;
|
||||
|
||||
$processor = $this->makeProcessor(
|
||||
$inner,
|
||||
new Site('Any', 'Rue', null, '12345', 'Ville', '#000000'),
|
||||
);
|
||||
$processor->process($nonSiteAware, $this->makeOperation());
|
||||
}
|
||||
|
||||
public function testThrowsBadRequestIfSiteAwareAndNoCurrentSite(): void
|
||||
{
|
||||
$data = $this->makeSiteAwareStub(null);
|
||||
|
||||
$inner = $this->createMock(ProcessorInterface::class);
|
||||
$inner->expects(self::never())
|
||||
->method('process')
|
||||
;
|
||||
|
||||
$processor = $this->makeProcessor($inner, currentSite: null);
|
||||
|
||||
$this->expectException(BadRequestHttpException::class);
|
||||
$this->expectExceptionMessage('aucun site selectionne');
|
||||
|
||||
$processor->process($data, $this->makeOperation());
|
||||
}
|
||||
|
||||
public function testDelegatesToInnerProcessorAlwaysWhenNoThrow(): void
|
||||
{
|
||||
$data = new stdClass();
|
||||
$inner = $this->createMock(ProcessorInterface::class);
|
||||
$inner->expects(self::once())
|
||||
->method('process')
|
||||
->willReturn('delegated-result')
|
||||
;
|
||||
|
||||
$processor = $this->makeProcessor(
|
||||
$inner,
|
||||
new Site('Any', 'Rue', null, '12345', 'Ville', '#000000'),
|
||||
);
|
||||
$result = $processor->process($data, $this->makeOperation());
|
||||
|
||||
self::assertSame('delegated-result', $result);
|
||||
}
|
||||
|
||||
private function makeProcessor(
|
||||
ProcessorInterface $inner,
|
||||
?Site $currentSite,
|
||||
): SiteAwareInjectionProcessor {
|
||||
// createStub : on n'a besoin que de fixer la valeur de retour, pas
|
||||
// d'attentes sur le nombre d'appels. Evite la notice PHPUnit
|
||||
// "No expectations were configured for the mock object".
|
||||
$provider = $this->createStub(CurrentSiteProviderInterface::class);
|
||||
$provider->method('get')->willReturn($currentSite);
|
||||
|
||||
// Stub Security : bypass_scope = true par defaut pour preserver le
|
||||
// comportement des tests historiques (pas de validation cross-site).
|
||||
// Les tests dedies a la validation cross-site instancient leur propre
|
||||
// Security via un helper dedie.
|
||||
$security = $this->createStub(Security::class);
|
||||
$security->method('isGranted')->willReturn(true);
|
||||
|
||||
return new SiteAwareInjectionProcessor($inner, $provider, $security);
|
||||
}
|
||||
|
||||
private function makeSiteAwareStub(?Site $initialSite): SiteAwareInterface
|
||||
{
|
||||
return new class($initialSite) implements SiteAwareInterface {
|
||||
public function __construct(private ?SiteInterface $site) {}
|
||||
|
||||
public function getSite(): ?SiteInterface
|
||||
{
|
||||
return $this->site;
|
||||
}
|
||||
|
||||
public function setSite(SiteInterface $site): void
|
||||
{
|
||||
$this->site = $site;
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
private function makeOperation(): Operation
|
||||
{
|
||||
return new Post();
|
||||
}
|
||||
}
|
||||
53
tests/Module/Sites/SitesModuleTest.php
Normal file
53
tests/Module/Sites/SitesModuleTest.php
Normal file
@@ -0,0 +1,53 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Tests\Module\Sites;
|
||||
|
||||
use App\Module\Sites\Infrastructure\ApiPlatform\State\Processor\SiteAwareInjectionProcessor;
|
||||
use App\Module\Sites\SitesModule;
|
||||
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
|
||||
|
||||
/**
|
||||
* Tests structurels du module Sites : contrat `permissions()` et
|
||||
* invariants d'enregistrement des services.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class SitesModuleTest extends KernelTestCase
|
||||
{
|
||||
public function testPermissionsSetContainsExactlyThreeCodes(): void
|
||||
{
|
||||
// Garde-fou : si quelqu'un ajoute une permission sans ajuster les
|
||||
// tests ou la doc, ce test casse explicitement. Si au contraire une
|
||||
// permission disparait (ex: bypass_scope retire par erreur), meme
|
||||
// effet. Le set de 3 permissions est fige par ce test.
|
||||
$codes = array_column(SitesModule::permissions(), 'code');
|
||||
sort($codes);
|
||||
|
||||
self::assertSame(
|
||||
['sites.bypass_scope', 'sites.manage', 'sites.view'],
|
||||
$codes,
|
||||
);
|
||||
}
|
||||
|
||||
public function testSiteAwareInjectionProcessorIsRegisteredAsDecoratorOfPersistProcessor(): void
|
||||
{
|
||||
// Garde d'integration : le ticket 4 compte sur le fait que tous
|
||||
// les processors existants qui deleguent au persist processor
|
||||
// (UserRbacProcessor, RoleProcessor, etc.) passent par notre
|
||||
// decorator SiteAwareInjectionProcessor. Si un refactor Symfony
|
||||
// change la resolution du service decore, ce test cassera en
|
||||
// amont des regressions invisibles dans les tests metier.
|
||||
self::bootKernel();
|
||||
$container = self::getContainer();
|
||||
|
||||
$persistProcessor = $container->get('api_platform.doctrine.orm.state.persist_processor');
|
||||
|
||||
self::assertInstanceOf(
|
||||
SiteAwareInjectionProcessor::class,
|
||||
$persistProcessor,
|
||||
'Le service api_platform.doctrine.orm.state.persist_processor doit etre decore par SiteAwareInjectionProcessor (#[AsDecorator]).',
|
||||
);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user