[TECH] Ne pas permettre de créer de nouveau usecase dans api/lib (PIX-10667)

[yannbertrand]

🎄 Problème

Dans le cadre de la migration vers les Bounded Contexts, on a pour le moment pas d'outillage pour nous empêcher de créer des nouveaux usecases dans api/lib/domain/usecases/.

🎁 Proposition

Pour éviter ça, la proposition est d'ajouter une nouvelle configuration ESLint spécifiquement pour les fichiers ajoutés dans l'historique et qui se trouvent dans le mauvais dossier. Pour assurer une erreur, on active une règle de lint : le nombre de lignes maximum de fichiers doit être inférieur à 0.

Script lint:staged

Pour appliquer le lint sur les fichiers qui nous intéressent uniquement, on utilise :

git log --name-only --format='' --diff-filter=A dev..HEAD | grep 'api/lib/domain/usecases/' | sed -e 's|api/||g'

1. on récupère les noms des fichiers ajoutés (et rien d'autres) entre la branche locale dev et l'état courant,
2. on filtre les noms qui contiennent api/lib/domain/usecases/,
3. on supprime api/ du nom du fichier car on est déjà dans ce dossier lors du lint.

Cela donne une suite de noms de fichier du genre : lib/domain/usecases/fake-usecase.js.

Cette liste est envoyée à ESLint via :

eslint --config .eslint-new-files-in-lib-config.cjs --no-eslintrc ${...}

Ou on applique notre configuration particulière.

Fichier de config ESLint

On spécifie les mêmes paramètres de parsing que notre config de base (pour bien interpréter le JS), et on applique la fameuse règle : 'max-lines': ['error', 0],

🧦 Remarques

C'est une proposition qui a ses limites :

• La commande ne renvoie pas d'erreur tant que le fichier n'a pas été commité,
• Elle ne traite que les créations de fichiers, pas les renommages ou déplacements,

🎅 Pour tester

Un mauvais fichier a été ajouté en fin d'historique git, la CI doit être cassée sur celui ci à cause de notre nouvelle commande lint:staged.

[pix-bot-github]

Une fois les applications déployées, elles seront accessibles via les liens suivants :

• App (.fr)
• App (.org)
• Orga (.fr)
• Orga (.org)
• Certif (.fr)
• Certif (.org)
• 1D
• Admin
• API
• Audit Logger

Les variables d'environnement seront accessibles via les liens suivants :

• scalingo front
• scalingo api
• scalingo audit-logger

[yaf]

Cette PR a l'air très bien et semble fonctionner correctement. Il manque encore un truc pour la passer en « ready for review » ? Voir pour la déployer ?

[yannbertrand]

Cette PR a l'air très bien et semble fonctionner correctement. Il manque encore un truc pour la passer en « ready for review » ? Voir pour la déployer ?

Je pense que la description n'est pas tout à fait synchro avec ce que le code fait vraiment. Mais j'ai totalement oublié où j'en étais donc faudrait reprendre le sujet tranquillement...

[yannbertrand]

Clôt par manque d'activité