docs: WS-7 PR-2 follow-up — RFC §3.6 + §3.14 + BACKLOG OBS entries

RFC §3.6 — context tagging tabel volledig vervangen na de PR-2 follow-up
architecturale fixes. Belangrijkste wijzigingen:
- Tag-binding gesplitst in route-scope (BindSentryRouteContext middleware)
  en auth-scope (AuthScopeContextListener op Authenticated event).
- Nieuwe actor_scope tag (organisation/platform/user/anonymous).
- Multi-tenant invariant verfijnd: organisation_id is altijd correct
  gerelateerd aan actor_scope in plaats van "altijd aanwezig". Platform-
  routes zonder org-context worden niet meer gefabriceerd; default
  authenticated user-scope omitt organisation_id (Crewli's User<->Organisation
  is many-to-many, geen reliable single-org hint).
- impersonation.* tags expliciet gedocumenteerd als afkomstig uit
  HandleImpersonation middleware (post-swap), niet uit auth-listener.
- ActorType waarden bijgewerkt na verwijdering van VOLUNTEER case.

RFC §3.14 — status-note toegevoegd dat D-06 indexes al via Spatie's
nullableMorphs default-migratie zijn aangemaakt, met regression-guard
verwijzing.

§6 acceptance criterium 12 markeert D-06 als al voldaan.

BACKLOG.md krijgt vier nieuwe OBS-entries:
- OBS-1: VOLUNTEER actor_type promotion wanneer rol komt
- OBS-4: PHPUnit metadata deprecation cleanup pre-PHPUnit-12
- OBS-6: sentry-laravel install gap awareness + bootstrap test
- OBS-7: custom render handlers report() invariant + coverage

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-05-06 13:03:00 +02:00
parent eb8202584c
commit 0379016c7e
3 changed files with 139 additions and 20 deletions

View File

@@ -1638,5 +1638,105 @@ voeden).
---
_Laatste update: April 2026_
_Voeg nieuwe items toe met prefix: ARCH-, COMM-, OPS-, VOL-, ART-, FORM-, SUP-, DIFF-, APPS-, TECH-, UX-_
_Laatste update: Mei 2026_
_Voeg nieuwe items toe met prefix: ARCH-, COMM-, OPS-, VOL-, ART-, FORM-, SUP-, DIFF-, APPS-, TECH-, UX-, OBS-_
---
## Observability follow-ups (post WS-7 PR-2)
### OBS-1 — Promote ActorType::VOLUNTEER when volunteer role is introduced
**Aanleiding:** WS-7 PR-2 architectural-fix-commit verwijderde de
`ActorType::VOLUNTEER` enum-case omdat Crewli vandaag geen dedicated
`volunteer` Spatie-rol heeft — vrijwilligers zijn behaviorally bepaald
(users met shift-assignments), niet identitair. De resolver mapt
non-admin authenticated users naar `ORG_MEMBER`.
**Wat:** Wanneer Crewli een `volunteer` rol invoert (bijv. via
volunteer-onboarding workflow), her-introduceer dan de `VOLUNTEER`
case in `app/Enums/Observability/ActorType.php` en update
`ActorType::resolve()` om de rol te checken vóór `ORG_MEMBER`. Update
ook `AuthScopeContextListenerTest` met een `actor_type=volunteer`
testcase.
**Prioriteit:** Laag — wachten op een product-besluit over volunteer-rol
modellering. Geen blocker.
**Refs:** `app/Enums/Observability/ActorType.php`,
RFC-WS-7-OBSERVABILITY.md §3.6.
### OBS-4 — PHPUnit metadata-in-doc-comment deprecation cleanup
**Aanleiding:** PHPUnit warnt dat metadata in doc-comments (zoals
`@test`, `@dataProvider`) deprecated is en in PHPUnit 12 verwijderd
wordt. Crewli heeft drie tests met deze pattern:
- `Tests\Unit\Support\Json\JsonCanonicalizerTest::test_scalar_passthrough()`
- `Tests\Feature\FormBuilder\Purposes\PurposeSchemaLifecycleTest::test_create_and_publish_succeeds_for_purpose()`
- `Tests\Feature\Schema\UlidPrimaryKeyTest::test_model_uses_has_ulids_and_generates_crockford_ulid()`
**Wat:** Vervang de doc-comment metadata door PHPUnit attributes
(bijv. `#[Test]`, `#[DataProvider]`). Raak alleen aan vóór de PHPUnit 12
upgrade gepland wordt — nu blokkeert het niets.
**Prioriteit:** Laag — kosmetisch totdat PHPUnit 12 upgrade landt.
**Refs:** PHPUnit changelog, de drie genoemde test-files.
### OBS-6 — sentry-laravel installation gap awareness
**Aanleiding:** WS-7 PR-2 smoke test faalde silent omdat sentry-laravel
4.x de `Integration::handles($exceptions)` registratie niet
auto-registreert in zijn ServiceProvider. De host-app moet de regel
expliciet aan `bootstrap/app.php` toevoegen. README documenteert dit,
maar tijdens `composer require sentry/sentry-laravel` +
`php artisan sentry:publish` workflow is het makkelijk te missen.
**Wat:**
- Voeg een waarschuwing toe in `dev-docs/SETUP.md` onder een nieuwe
sectie "Laravel package installation patterns": bij elke nieuwe
package altijd verifiëren dat het package zijn ServiceProvider-
registraties doet voor exception handlers, queue listeners, en log
channels — niet alleen voor routes/views/migrations.
- Overweeg een `tests/Feature/Bootstrap/ExceptionHandlerRegistrationTest.php`
die `app(\Illuminate\Foundation\Exceptions\Handler::class)->getReportableCallbacks()`
introspecteert en assertert dat sentry-laravel's callback
geregistreerd is. Vangt een toekomstige refactor die per ongeluk
`Integration::handles` uit `bootstrap/app.php` verwijdert.
**Prioriteit:** Laag — fix is gedaan en getest, regression mogelijk
maar onwaarschijnlijk gezien de explicit comment in `bootstrap/app.php`.
**Refs:** `bootstrap/app.php`,
`vendor/sentry/sentry-laravel/src/Sentry/Laravel/Integration.php`,
RFC-WS-7-OBSERVABILITY.md §3.10.
### OBS-7 — Custom $exceptions->render() handlers report() invariant
**Aanleiding:** WS-7 PR-2 smoke-test debugging onthulde dat Crewli's
`bootstrap/app.php` 5 custom render handlers heeft. Met
`Integration::handles($exceptions)` geregistreerd werkt
report-before-render correct. Maar een toekomstige render handler die
een Throwable consumeert zonder `report($e)` aan te roepen vóór return
zou Sentry-capture kunnen overslaan voor die exception class.
**Wat:**
- Documenteer in `bootstrap/app.php` (boven het withExceptions block)
een comment: "Render handlers consume exceptions; Laravel's
ExceptionHandler::handle() doet report() vóór render() zodat capture
automatisch is. NIEUWE render handlers MOGEN NIET short-circuiten
voordat report() bereikt is. Verifieer via
tests/Feature/Observability/ExceptionReportingTest.php."
- Uitbreiden van `ExceptionReportingTest.php` met assertions per
bestaande render handler class: throw die exception, assert event
captured.
**Prioriteit:** Medium — bestaande handlers zijn correct, maar het
invariant is subtiel en silent-failure-prone bij toevoegingen.
**Refs:** `bootstrap/app.php`,
`tests/Feature/Observability/ExceptionReportingTest.php`,
RFC-WS-7-OBSERVABILITY.md §3.10.