- Repo scaffolding: .gitignore, .env.example, Makefile, docker-compose.yml, README.md, CHANGELOG.md, pre-commit config. - Three-service stack: api (Flask 3), db (postgres:16-alpine), front (nginx serving the Vite bundle). Named volumes metamorph_db + metamorph_evidence. - Backend skeleton: Flask app factory, JSON structured logging on stdout, GET /api/v1/health, multi-stage Dockerfile, pyproject.toml driven by uv, Pydantic Settings with secret guard rails (refuses to boot in non-dev with placeholders), APP_ENV gating. - Frontend skeleton: Vite + React 18 + TypeScript strict + TailwindCSS, RTOps design tokens from tasks/design.md, self-hosted JetBrains Mono / IBM Plex Sans via @fontsource, base UI primitives (Card/Tag/SectionHeader/FlowNode/ Button), home page wired to /api/v1/health. - Engine-agnostic Makefile: auto-detects docker or podman, picks the matching compose driver. Targets: up/down/build/rebuild/dev/lint/fmt/test/migrate/ seed-mitre/print-install-token/e2e/inspect-health. - Playwright suite: e2e/tests/m0-smoke.spec.ts (8 tests) + HTML + JUnit reports + traces on retry. - Docs: tasks/spec.md (finalized after Q&A), tasks/design.md, tasks/todo.md (14 milestones), tasks/testing-m0.md, tasks/lessons.md. DoD: make up + make health + make e2e all pass on podman 5.x (Fedora) and docker. TLS terminated by external reverse proxy (spec §6 NF-network). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
14 KiB
14 KiB
type, project
| type | project |
|---|---|
| lessons | Metamorph |
Metamorph — Lessons learned
Capture session-level retrospectives here: surprises, traps avoided, decisions revisited. Keep entries short and actionable. Most recent first.
2026-05-08 — M0 bootstrap
- Spec finalisée d'abord (
tasks/spec.md), 8 tours de questions ciblées avant tout code → 0 hypothèse latente avant M0. Pattern à reproduire pour les futurs projets greenfield. - Choix
uvpour le backend Python (rapidité de lock, image Docker plus mince qu'avec poetry). - TLS terminé par reverse proxy externe (cf. spec §6 NF-network) → pas de Caddy/Traefik dans le compose, simplifie le M0.
- Bootstrap du 1er admin via token affiché dans les logs : retenu sur Token-in-logs plutôt que ENV pour éviter de mettre le password en clair dans
.env. - Piège Dockerfile : la process-substitution bash
<(...)ne marche pas dans une instructionRUNDocker car le shell par défaut estsh, pasbash. Soit ajouterSHELL ["/bin/bash", "-c"], soit refactor sans process-sub. Ici j'ai préféré refactor (plus portable) :uv venv+uv pip install --python /opt/venv/bin/python .. Quand unuv.lockexistera, basculer suruv sync --frozen --no-dev. - Vérification d'un compose sans Docker installé :
python3 -c "import yaml; yaml.safe_load(open('docker-compose.yml'))"valide la syntaxe YAML, et un script qui croise lesenvironment:du compose avec.env.exampledétecte les variables manquantes côté docs. - Lancer le subagent
spec-reviewerà chaque fin de milestone (HARD RULE 4 du CLAUDE.md global). J'avais oublié à la fin de M0 ; le user me l'a rappelé. Le reviewer a remonté 6 défauts légitimes en quelques minutes (pre-commit absent, fonts via CDN, secrets par défaut non gardés,make devno-op,database_urldead-code, Node engines non pinned). À automatiser dans le workflow de fin de milestone. - Spec §7 "pas de CDN runtime" s'applique aussi aux fonts, pas seulement aux libs JS. Self-host via
@fontsource/<name>plutôt que Google Fonts<link>— bonus OPSEC (pas de fingerprinting via fonts.googleapis.com). - Pattern de garde de secrets : un
model_validatorPydantic qui refuse de booter enAPP_ENV != "dev"avec des secrets manquants ou égaux aux placeholders de.env.example. Coût quasi nul, élimine la classe entière des "oubli de set en prod". - Makefile portable docker/podman :
ENGINE := $(shell command -v docker … podman …), puis sélection du compose driver en fonction (docker composevspodman composevspodman-composelegacy). Le piège classiqueCOMPOSE ?=ne marche pas si on veut conditionner la valeur par défaut surENGINE— il fautifndef COMPOSE+ifeq ($(ENGINE),docker). Tous les targets restent compose-driven ($(COMPOSE) exec, etc.) ; seulsvolumes/inspect-health/logs-apiont besoin de$(ENGINE)directement, et même là on évite les filtres par label projet (instables entre podman-compose et docker compose) en se reposant surcontainer_name:du compose file.
2026-05-10 — M0 DoD validation (réelle, pas paperware)
- JE DOIS LANCER LE DoD MOI-MÊME avant de déclarer un milestone done. L'utilisateur me l'a fait remonter ; le
make upinitial échouait sur 3 problèmes que la revue statique n'a pas vus. Règle : à chaque fin de milestone, exécuter le DoD localement (make up+ smoke + e2e) en plus du spec-reviewer. - Podman + Fedora exige des FQDN d'image (
docker.io/library/postgres:16-alpine, paspostgres:16-alpine). Le modeshort-name-mode=enforcingfail sans TTY pour prompter. Docker accepte le même préfixe transparente. → Dorénavant tous lesimage:etFROM …des projets cross-engine sont qualifiés. .dockerignorequi exclut*.mdcassepyproject.tomlqui référencereadme = "README.md": hatchling lit le README au build pour valider les métadonnées. Soit on copie le README explicitement, soit on n'exclut pas les*.md, soit on retire la cléreadme. J'ai retiré la clé pour découpler.extends HTMLAttributes<HTMLDivElement>clash surtitle: la prop native eststring, donc redéfinirtitle?: ReactNodeproduit TS2430. Pattern à retenir :Omit<HTMLAttributes<…>, 'title'>quand on overloadtitle/color/autoFocusetc.- Podman-compose 1.x ne surfait pas les
HEALTHCHECKdu Dockerfile danspodman inspect: il faut redéclarer le healthcheck dans ledocker-compose.ymlpour quemake inspect-healthvoie réellement l'état. Bonus : c'est aussi plus portable. - Piège shell :
make up 2>&1 | tail -80bloque quand la sortie est petite, parce quetailbufferise jusqu'à recevoir SIGPIPE en fin de pipeline ; quand le build est lent, on n'a aucune sortie pendant des minutes. Fix : rediriger vers fichier (>/tmp/log 2>&1) puistailséparément, ou utiliser leMonitortool pour streamer. PODMAN_COMPOSE_WARNING_LOGS=falsemasque le banner "Executing external compose provider …" qui spamme chaque commande. À exporter depuis le Makefile.
2026-05-10 — M1 schéma DB & migrations
- Compose pioche le DERNIER stage du Dockerfile par défaut. En ajoutant un stage
testaprèsruntime, le containerapis'est mis à exécuterpython -m pytestau lieu degunicorn, en boucle (exit 1 → restart → exit 1). Fix :target: runtimeexplicite dansdocker-compose.yml. Règle : toujours précisertarget:quand un Dockerfile a >1 stage final viable. - Snapshot vs référence (spec §11) : pour qu'un snapshot survive à un re-sync de la référence (ex : MITRE qui retire une technique), il faut dénormaliser les champs descriptifs dans la table snapshot (ici
mitre_external_id,mitre_name,mitre_url) et ne pas mettre de FK vers la table source. Si on garde une FK, la cascade détruit la donnée historique (CASCADE) ou bloque le sync (RESTRICT). La dénormalisation est le bon trade-off pour un état figé en lecture après archivage. SoftDeleteMixin.__table_args__est silencieusement écrasé par la classe enfant qui déclare son propre__table_args__. Pattern à éviter pour les mixins qui veulent ajouter des contraintes/index. Soit ne rien mettre dans__table_args__du mixin (et imposer aux classes de déclarer l'index), soit utiliserevent.listens_for("after_parent_attach", ...). J'ai choisi la 1re option : explicite > magique.- Workflow Alembic en container :
alembic revision --autogeneratecrée le fichier dans le container, qu'il fautpodman cpvers l'host avant rebuild. Sinon perdu. Ajouter ce détail dans la doc M1 (et envisager un bind mountdevplus tard). - Bypass
APP_ENVdoit couvrirdevETtest: un container test légitime ne doit pas avoir besoin de secrets prod-grade.if self.APP_ENV in ("dev", "test"): return self. pytestdans le runtime image, c'est non. Faire un stagetestdédié (multi-stage--target test) qui étenddeps+dev extras+tests/, lancé viapodman run --rm --network <project>_<network>en éphémère. Le runtime reste minimal en prod.- Le test d'intégration "expected tables/FK/CHECK" est le bon filet de sécurité pour M1+ : il a immédiatement attrapé les fixes du reviewer (le retrait de
ck_mission_test_mitre_tags_exactly_one_mitre_fkaurait été un oubli silencieux sinon). - Lancer le DoD avant de dire "M1 done" : règle gravée à M0, respectée ici.
make clean && make up && make migrate && make test-api && make e2eest la séquence canonique de fin de milestone.
2026-05-11 — M3 RBAC, groupes, users, invitations
logging.LogRecordréservenamecomme attribut interne (en plus demessage,levelname,pathname,filename,module,funcName,lineno,asctime,process,thread,args). Donclog.info("metamorph.x.created", extra={"name": entity.name})lèveKeyError: "Attempt to overwrite 'name' in LogRecord". Patron : préfixer toute clé risquée par l'entité (group_name,user_name,template_name). À documenter dans le style guide quand on en aura un.- Pattern "sentinel pour distinguer absent vs null" : Pydantic ne sait pas distinguer
{}de{"display_name": null}quand le champ eststr | None = None. Solution : lireraw = request.get_json()puis tester"display_name" in rawdans la couche API, passer un sentinel...au service, qui distingue "ne pas toucher" de "set à None". Lourd mais explicite. Si ça revient souvent, encapsuler dans un helpertriState(raw, key, payload). limiter.reset()flask-limiter est public et clean — pas besoin de toucher àlimiter._storage. À appeler dans/diag/resetquand le limiter estenabled. Toujours guarder avecif limiter.enabledpour ne pas planter enAPP_ENV=test.- Rate-limit scope
APP_ENV in ("prod", "staging"): meilleure granularité que prod-only. La spec NF-security est operator-facing, pas dev. Trade-off réconcilié dansapp/core/rate_limit.pyavec un docstring explicite. Dev = ergonomics totale, prod/staging = limiter actif, test = désactivé. - Playwright
workers: 1+fullyParallel: falsequand chaque spec file fait du/diag/reset(DB partagée). Avec parallélisme, les workers se truncate mutuellement entre eux → install token consumé, etc. Pattern simple et robuste : un seul worker pour les e2e, parallélisme intra-file laissé àtest.describe.configure({ mode: 'serial' }). - Sessions Playwright entre tests : chaque
test()reçoit unepageneuve (BrowserContext fresh). Pas de partage de session entre tests du mêmedescribe. HelperloginViaSpa()à appeler au début de chaque test SPA-driven (les tests purement API peuvent partager via une variable de spec mais c'est rare). Alternative :storageStateglobal, mais ça complique le truncate workflow. - Dual seed = boot + bootstrap : seeder les perms au boot ET dans
bootstrap_admin()n'est pas redondant. Sur DB fraîchement migrée vide, le boot suffit. Mais après/diag/reset(qui TRUNCATEpermissions+group_permissions+groups), seul/setupre-déclenche le chemin de seed viabootstrap_admin → seed_all. Sans ce 2e appel, l'admin créé auraitis_admin=Truemais le catalogue serait vide. - Snapshot UserView/GroupView détachés : retourner des
@dataclass(frozen=True)au lieu de l'ORM permet de fermer lesession_scopeimmédiatement. Plus simple ques.expunge()pour chaque champ, et la couche API peut sérialiser sans lazy-loading. Patron à reproduire pour tous les services. - Invariant "admin a toutes les perms" : même si le décorateur bypass via
is_admin = "admin" in group_names(et pas via le perm set), garder l'invariant côté API en refusantset_group_permissions(admin_group, !=all_codes). Future-proof : si on bouge le bypass à un check perm-based plus tard, l'invariant tient déjà.SystemGroupProtectedréutilisé pour le 409. - Toujours rebuild front + recreate containers :
make rebuildne recrée pas les containers, donc le bundle nginx reste l'ancien. Patron canonique :make down && make up. Documenté pour la 2e fois dans M3 ; à faire passer en runbook au prochaintasks/testing-m<N>.md.
2026-05-10 — M2 auth, JWT, invitations
pydantic.EmailStrrejette les TLD réservés (.local,.corp,.test, …) viaemail-validatorglobally_deliverable=True. Pour un outil red-team utilisé en lab/intranet, créer un type custom permissif (Annotated[str, AfterValidator(...)]) avec une regex RFC-shape. À garder en tête pour tout futur projet "internal".- Cookies
Secure=TruesurlocalhostHTTP : modern browsers (Chrome ≥89, Firefox ≥75) traitentlocalhostcomme un secure context et acceptent les cookiesSecuremême servis en HTTP. Donc on peut respecter la spec strictement (Securetoujours) sans casser le dev — pas besoin de gating parAPP_ENV. getByLabelde Playwright prend le nom accessible de l'input. Quand un<label>enveloppeinput+<span>hint +<span>error, le hint et l'error polluent le nom etgetByLabel('Password', exact: true)ne matche plus. Pattern correct :<div>parent,<label htmlFor>séparé du<input id>, hint et error en<p>siblings hors du<label>.flask-limiterdoit être désactivé enAPP_ENV=testsinon les tests qui font 10+ logins de suite rate-limit.Limiter(..., enabled=settings.APP_ENV != "test")règle le cas globalement.pydantic[email]extra est REQUIS dès qu'on utiliseEmailStr. Ne pas s'en rendre compte donne un crash gunicorn worker au boot avecImportError: email-validator is not installed. À dupliquer dans le starter pyproject pour les futurs projets.- Compose
target:est OBLIGATOIRE quand un Dockerfile a un stage après le runtime — par défaut compose builde le DERNIER stage. J'ai été mordu deux fois (M1 puis M2). Désormais : tout Dockerfile multi-stage avec un stage de test/dev →target: runtimeexplicite dansdocker-compose.yml. - Refresh token rotation + chain revoke : à chaque
/auth/refresh, on marque l'ancien tokenrevoked_at+replaced_by_id. Si quelqu'un re-présente un token déjà rotaté, on cascade-revoke toute la chaîne (compromise probable). Pattern à reproduire pour tout système JWT à long terme. make rebuildne recrée pas les containers — il fautmake down && make upaprès un changement front pour que nginx serve le nouveau bundle. Important quand on debug un test e2e qui attend un selecteur récemment ajouté côté React.podman compose stop apipuisup -d apicasse les dépendances entre containers (dbhealthy →apidepends on it) : podman-compose ne résout pas la chaîne de deps quand on cible un seul service. Pour un override d'env, mieux vautmake down && APP_ENV=test make up./diag/resettest-only : exposer un endpoint qui truncate la DB est tentant pour les e2e mais ouvre une grosse surface en cas de fuite. Compromise actuel : autorisé endevETtest(pas en prod), avec un logWARNINGà chaque appel. Si jamais on déploie une stack dev publique, désactiver l'endpoint via env var.