not
2125fb0cfd
## What & why S-19b-1. A write to the Objecten API now produces a **delivered** notification on the `objecten` kanaal in Open Notificaties. ADR-0028 switched Objecten's notifications off on purpose — there was no broker, worker, kanaal or abonnement, so wiring only the client side would have dropped every message on the floor. This slice builds the real path and turns it back on. - `objecten-celery` worker (mirrors `oz-celery`) + `CELERY_BROKER_URL`/`RESULT_BACKEND` on objecten-redis db 1 (db 0 is already the cache). `notifications_api_common` only *queues* the send; without a worker every register write is silently undelivered. - `nrc` service + `notifications_config` in Objecten's `setup_configuration`, reusing the `big-reference-seed` credential OpenZaak publishes with (NRC authorizes it via OpenZaak's AC, which grants it `heeft_alle_autorisaties` — no second credential needed). - The `objecten` kanaal in NRC's `setup_configuration`. The name is fixed by the Objects API (`NOTIFICATIONS_KANAAL`), not chosen here; publishing to an unregistered kanaal is exactly what the red check reported first. - `NOTIFICATIONS_DISABLED: "false"` in both compose files. - Writers address Objecten as `objecten.local` — see *Notes for reviewers*. - `make verify-objecten-notifications` — registers an abonnement on `objecten` pointing at a throwaway sink, writes a `RegisterRecord` exactly as the ACL does on approval, asserts the delivery. One assertion covering the whole chain: Objecten -> objecten-celery -> NRC -> nrc-beat -> callback. Wired into the CI `verify-stack` job and the summary table. **ADR-0029** records the decisions; ADR-0028's ceiling now points at it. Closes #152 ## Definition of Done - [x] Linked Gitea issue (above). - [x] Failing test committed before the implementation (dc9ca2c, red at the first hop: `NRC POST /api/v1/abonnement -> 400 "Kanaal met deze naam bestaat niet."`). - [x] Implementation makes the test pass (4488962, + two fixes found by CI, below). - [x] Conventional Commits referencing the issue (`refs #152`). - [x] CI green — all six jobs ona5fd47e, including `verify-stack` end to end (e2e included). - [x] `docker compose up` from a fresh clone reaches green health checks within 3 minutes (`verify-stack`'s bring-up step). - [x] Docs updated — ADR-0029 added, ADR-0028's ceiling annotated, BACKLOG.md split. - [x] ADR added in `docs/architecture/`. - [x] Demo note in `docs/demo-script.md` if user-visible — n/a, infrastructure only; nothing consumes the kanaal until S-19b-2 (#153). ## Notes for reviewers **The one genuinely non-obvious bit: writers address Objecten as `objecten.local:8000`, not `objecten:8000`.** NRC types a notification's `hoofdObject`/`resourceUrl` as DRF `URLField`, so Django's `URLValidator` runs on them — and it rejects a **single-label** host. Objecten fills both from the object url DRF built with `request.build_absolute_uri`, i.e. *the Host the caller used*. Writing via the plain service name returns 201 and then fails every publish in the background, forever, with ``` 400 {"hoofdObject":["Voer een geldige URL in."],"resourceUrl":["Voer een geldige URL in."]} ``` So the `objecten` service carries an `objecten.local` network alias and every writer uses it — `Acl__Objecten__BaseUrl`, `ObjectenGatewayIntegrationTests`, this slice's verify driver. An alias rather than a bare dotted `SITE_DOMAIN` so the host still *resolves*: a subscriber following `resourceUrl` reaches the record, which S-19b-2 will do. Readers keep the plain name. Same class of constraint as ADR-0028's Objecttypen base-URL rule. **Ceiling, stated in the ADR:** nothing enforces the alias — a future writer using `objecten:8000` gets a 201 and silently no notification. If a second writer ever appears, rename the compose service rather than adding a lint. **Two CI-only failures on the way here**, both worth knowing: 1. `SITE_DOMAIN` was my first guess at the mechanism and is simply not what builds those URLs — dropped ind76abf2. 2. The check correlated the delivery on the `reference` inside the record it wrote. An NRC notification carries `kanaal`/`resource`/`kenmerken`/`hoofdObject`/`resourceUrl` and **never the record data**, so it correlates on the object URL now (a5fd47e). **Cost:** one more long-running container on the memory-tight runner. It inherits the capped `UWSGI_PROCESSES: "1"` env, which the celery command ignores; if `verify-stack` gets tight again, celery concurrency is the next knob. **Follow-up:** S-19b-2 (#153) sources the projection from these events. Nothing subscribes to the `objecten` kanaal in the product yet — only the verify check does.Reviewed-on: #154
60 lines
2.7 KiB
YAML
60 lines
2.7 KiB
YAML
# Objecten API setup_configuration (S-18b). Streamed into the external rr-objecten-config volume by
|
|
# infra/seed-config.sh and applied by objecten-init (RUN_SETUP_CONFIG). Declarative + idempotent.
|
|
#
|
|
# Two things: (1) register the Objecttypen API (S-18a) as a trusted service so an object can
|
|
# reference its objecttype — authenticating with the dev static token Objecttypen provisioned; and
|
|
# (2) a dev static token so peers (the ACL, S-19) can write objects here. Dev-only, not for prod.
|
|
|
|
# (1) Trust the Objecttypen API. `orc` = overige RESTful component (how zgw_consumers classifies the
|
|
# Objecttypen API). The RegisterRecord objecttype (S-18c) will reference an objecttype under this
|
|
# service by uuid.
|
|
zgw_consumers_config_enable: true
|
|
zgw_consumers:
|
|
services:
|
|
- identifier: objecttypen
|
|
label: Objecttypen API
|
|
api_type: orc
|
|
api_root: http://objecttypen:8000/api/v2/
|
|
auth_type: api_key
|
|
header_key: Authorization
|
|
header_value: Token 0123456789abcdef0123456789abcdef01234567
|
|
# (1b) The NRC Objecten publishes register-record events to (S-19b-1, ADR-0029). Same shape and
|
|
# same big-reference-seed credential OpenZaak publishes with — NRC verifies the JWT and
|
|
# authorizes it via OpenZaak's AC, which grants that client heeft_alle_autorisaties.
|
|
- identifier: nrc
|
|
label: Open Notificaties
|
|
api_type: nrc
|
|
api_root: http://nrc-web:8000/api/v1/
|
|
auth_type: zgw
|
|
client_id: big-reference-seed
|
|
secret: insecure-dev-secret-change-me
|
|
|
|
# (2) Permit the RegisterRecord objecttype (S-19a). Objecten refuses to store an object whose
|
|
# objecttype it has not been configured with ("ObjectType with url=… is not configured"), and it
|
|
# identifies one by uuid — which is why infra/objecttypen-registerrecord/register.py pins that uuid
|
|
# instead of letting Objecttypen assign one. Keep the two in step.
|
|
objecttypes_config_enable: true
|
|
objecttypes:
|
|
items:
|
|
- uuid: 1f4b4e26-8b1f-4e2f-9d6c-6a1b7a2f0e01
|
|
name: RegisterRecord
|
|
service_identifier: objecttypen
|
|
|
|
# (3) Static API token peers use to write/read objects.
|
|
tokenauth_config_enable: true
|
|
tokenauth:
|
|
items:
|
|
- identifier: register-referentie
|
|
token: 1234567890abcdef1234567890abcdef12345678
|
|
contact_person: Register Referentie
|
|
email: admin@localhost
|
|
organization: Respellion
|
|
is_superuser: true
|
|
|
|
# (4) Point Objecten's notifications at that NRC service (S-19b-1, ADR-0029). Requires
|
|
# NOTIFICATIONS_DISABLED=false plus a celery broker + worker — without the worker the message is
|
|
# queued and never sent, which is exactly the half-wired state S-19a refused to ship (ADR-0028).
|
|
notifications_config_enable: true
|
|
notifications_config:
|
|
notifications_api_service_identifier: nrc
|