mirror of
https://github.com/block/buzz.git
synced 2026-10-28 13:01:10 +00:00
Buzz push currently selects an application profile, such as `dogfood`, during client registration. We want each gateway to serve one Apple app configured by the operator instead. This removes profile selection from the client, relay, and gateway, while allowing internal and public gateways to use their own Apple identities. This PR implements that model in the Buzz source and upstream deployment chart. Discovery, enrollment, grants, and leases no longer carry an application-profile selector. Each gateway has one configured Apple application and APNs transport. The protocol changes are incompatible with the old registration format, so relays advertise `buzz-push-v1` instead of `nip-pl`. Old clients do not discover the new push capability. Updated clients use separate Keychain records and register again. The [push notes](https://github.com/block/buzz/blob/push-capability-v1/docs/buzz-push.md) describe the experimental contract. Landing this PR is the first step. Publish the matching gateway image and upstream chart, then land the [shared chart update](https://github.com/squareup/cash-helm-charts/pull/5740) and [gateway deployment update](https://github.com/squareup/builderbot-platform-core-infrastructure/pull/1085). Before cutover, stop old gateway instances and check legacy registration state. Migrations refuse to proceed if old gateway installations or active relay leases remain; they do not delete that state. Physical-device verification remains necessary before production activation. ### Validation Gateway and focused Flutter push tests pass, as do the Swift package, simulator build, and native notification/enrichment tests. A local relay advertises `buzz-push-v1` without `nip-pl` or `app_profiles`. The PostgreSQL suite passed 868 tests; its two migration-test failures were corrected and pass a focused rerun together with the gateway cutover guard. Chart rendering and release-contract checks pass. Desktop JavaScript tests, desktop and web builds, native desktop compilation, mobile analysis/tests, and desktop native tests pass. The full Rust unit lane and prescribed `just test` command pass, including workspace integration tests against task-isolated local services. The production overlay now requires an explicitly supplied APNs topic, with omission and rendered-value regression coverage. The corrected Swift checksum assertion passes the complete package suite: 78 XCTest tests and 42 Swift Testing tests. No physical-device enrollment or production cutover is claimed. Local merge validation: the embedded migration test and formatting pass after reserving profile migration 0060 behind rollback migration 0059. The local pre-push Rust lane failed ACP timing/steering tests (`idle_resets_on_stdout_activity`, `keepalive_resets_idle_past_deadline`, and the failed/missing-outcome steering tests). ACP and its dependency manifests are unchanged by this branch; all four pass in an isolated single-thread rerun. The documented local-check exception skips only the Rust pre-push lane for publication; required CI remains mandatory. Mobile and desktop pre-push lanes passed. Combined migration validation: after rollback 0059 landed, the main merge preserves profile migration 0060 and both embedded migration assertions. The focused migration test and formatting pass. The next local push again failed only the unchanged ACP idle/keepalive timing tests (1053 passed, 2 failed, 3 ignored); other lanes passed. Publication uses the same documented local Rust-lane exception; required CI remains mandatory. Follow-up review fix: removed the legacy profile column from the copied-lease fixture. All four event-follow-up contract tests pass on isolated PostgreSQL databases, covering desired and migrated schemas in dual and app-only modes. Formatting passes. Publication retains the prior passing local-lane evidence and uses the authorized pre-push exception for the known unrelated ACP timing failures; required CI remains mandatory. --------- Signed-off-by: Tom Brow <tomb@block.xyz>
357 lines
26 KiB
Markdown
357 lines
26 KiB
Markdown
# Buzz Push Gateway deployment
|
||
|
||
`buzz-push-gateway` is a standalone APNs last hop. Build it with `Dockerfile.push-gateway`; do not run it in the relay image or give relays APNs credentials.
|
||
|
||
## Network and health
|
||
|
||
- Public listener: `BUZZ_PUSH_BIND_ADDR` (default `0.0.0.0:8080`). Route the deployment hostname to this port; the binary needs no public-origin setting.
|
||
- Private health listener: `BUZZ_PUSH_HEALTH_ADDR` (default `0.0.0.0:8081`). Probe `/_liveness` and `/_readiness`; do not expose this port publicly. The chart has no pod-ingress allowance for 8081; Kubernetes node/kubelet-origin probe traffic is exempt from NetworkPolicy. Add a narrowly selected monitoring source only if the target CNI requires pod-origin health scraping.
|
||
- Readiness fails when PostgreSQL authority is unavailable. Graceful shutdown stops accepting new requests before draining in-flight APNs calls.
|
||
|
||
## Required configuration
|
||
|
||
| Variable | Purpose |
|
||
|---|---|
|
||
| `DATABASE_URL` | PostgreSQL authority/admission store. Runtime credentials need DML on the six gateway tables, not DDL. |
|
||
| `BUZZ_PUSH_MAX_GRANT_LIFETIME_SECONDS` | Maximum delegation capability lifetime (`1..=31536000`). |
|
||
| `BUZZ_PUSH_MAX_INSTALLATION_LIFETIME_SECONDS` | Maximum encrypted-token installation lifetime (default 90 days, max one year). Clients must renew before expiry. |
|
||
| `BUZZ_PUSH_APP_ATTEST_ROOT_CERT_PATH` | Read-only mounted Apple App Attest root certificate PEM. |
|
||
| `BUZZ_PUSH_APP_ATTEST_APP_ID` | Exact server-owned Apple App Attest application identifier (`TEAMID.bundle-id`). |
|
||
| `BUZZ_PUSH_APNS_TOPIC` | Server-owned APNs topic. Never accepted from a client. |
|
||
| `BUZZ_PUSH_APNS_ENVIRONMENT` | `production` or `sandbox`, selected by deployment configuration. |
|
||
| `BUZZ_PUSH_APNS_CERT_PATH` | Read-only certificate/private-key PEM. |
|
||
| `BUZZ_PUSH_GRANT_KEYS` | Capability AEAD keyring, `id:base64-32-bytes[,predecessor...]`; current key first. |
|
||
| `BUZZ_PUSH_TOKEN_KEYS` | Independent token-custody AEAD keyring in the same format. Never reuse grant keys. |
|
||
|
||
Each gateway serves one configured Apple application. App Attest validates
|
||
`application.appAttestAppId` (`TEAMID.bundle-id`) before enrollment. APNs uses
|
||
the configured topic, certificate and environment. Clients and relay grants
|
||
cannot select or override that identity. Separate applications use separate
|
||
gateway deployments and authority databases.
|
||
|
||
See [Buzz push notes](buzz-push.md) for the current experimental contract.
|
||
|
||
Optional endpoint quota policy variables are `BUZZ_PUSH_ENDPOINT_QUOTA_WINDOW_SECONDS` (default `10`, max `86400`) and `BUZZ_PUSH_ENDPOINT_QUOTA_MAX_DELIVERIES` (default `10`, max `10000`). These are Buzz policy hypotheses, not Apple-published limits; tune under load while retaining a hard ceiling.
|
||
|
||
## Personal device development
|
||
|
||
A development-signed iOS app uses Apple's development App Attest environment.
|
||
The ordinary gateway binary rejects those attestations. For an isolated personal
|
||
stack, build with Cargo feature `personal-dev-app-attest` (Docker build argument
|
||
`BUZZ_PUSH_CARGO_FEATURES=personal-dev-app-attest`) and set
|
||
`BUZZ_PUSH_APP_ATTEST_ENVIRONMENT=development`. The default remains `production`,
|
||
including in that special build; ordinary builds reject the development setting.
|
||
The gateway accepts exactly the selected AAGUID and still verifies the pinned
|
||
Apple root, certificate chain, nonce, application identity, public key,
|
||
credential ID, and counter. This is not a simulator or attestation bypass.
|
||
|
||
Set `BUZZ_PUSH_APP_ATTEST_APP_ID` to the personal `TEAMID.bundle-id`,
|
||
`BUZZ_PUSH_APNS_TOPIC` to that same bundle ID,
|
||
`BUZZ_PUSH_APNS_ENVIRONMENT=sandbox`, and supply its APNs certificate.
|
||
This isolated stack uses its own server-configured application identity.
|
||
Do not point distributed clients at this personal gateway.
|
||
|
||
Build the mobile client with the personal team and parent bundle ID, its matching
|
||
`.NotificationService` extension, development APNs/App Attest entitlements, and
|
||
an explicit `BUZZ_PUSH_GATEWAY_URL`. See `mobile/README.md` for gitignored signing
|
||
overrides. Both targets need matching provisioning profiles; the parent profile
|
||
must include the capabilities in `Runner.entitlements`. Validate enrollment and
|
||
notification presentation on a physical device, not a simulator.
|
||
|
||
## Secret and key rotation rules
|
||
|
||
Mount the App Attest root read-only and startup will reject any byte mismatch. The sole accepted artifact is Apple’s **Apple App Attestation Root CA** from `https://www.apple.com/certificateauthority/Apple_App_Attestation_Root_CA.pem`: certificate SHA-256 fingerprint `1C:B9:82:3B:A2:8B:A6:AD:2D:33:A0:06:94:1D:E2:AE:4F:51:3E:F1:D4:E8:31:B9:F7:E0:FA:7B:62:42:C9:32`; exact PEM-file SHA-256 `c778d09ac341f7fd9f8f3b19e2b815af6aed4ad4490e1e92c05cb355212a5013`. Treat an Apple root rotation as a reviewed code/config rollout, not an unpinned mount replacement. Mount the APNs certificate identity and both AEAD keyrings from a secret manager; never place values in an image, manifest, log, or metrics label. Keep the current AEAD key first and retain decrypt-only predecessors until every capability/token encrypted under them has expired or been re-encrypted. Grant and token key ids and bytes must be distinct. Rotation is an operator rollout: add the new current key while retaining predecessors, deploy, wait through the retention window, then remove the old key.
|
||
|
||
The gateway stores APNs tokens encrypted in PostgreSQL. Database backups therefore contain ciphertext plus authority metadata and must receive the same access controls and retention treatment as the service secrets.
|
||
|
||
## PostgreSQL and replicas
|
||
|
||
### First deployment, not a legacy upgrade
|
||
|
||
This gateway has never been deployed outside personal development infrastructure.
|
||
This release supports a fresh dedicated database, not migration of existing
|
||
development authority. Before running any schema migrations, `--migrate-only`
|
||
refuses a non-empty database that has not completed gateway initialization
|
||
(migration 0005). The error names the populated table and tells the operator to
|
||
stop the development gateway and provision a fresh database. It does not delete
|
||
or migrate that data. Normal deployments of an already initialized gateway may
|
||
retain their data.
|
||
|
||
Do not run a rolling upgrade from a pre-launch development binary. Stop that
|
||
deployment before initialization, use the fresh database, and do not roll back
|
||
to a pre-launch binary against the new database. The rolling strategy is for
|
||
compatible versions after initial deployment; no legacy writer compatibility or
|
||
mobile configured-to-unconfigured migration is supported. Push has no existing
|
||
enabled users. After enabling push, retain gateway configuration in updates to
|
||
that app identity; omitting it is not a push shutdown mechanism.
|
||
|
||
The gateway's dedicated pool does not consume the relay-oriented `BUZZ_DB_LOCK_TIMEOUT_MS`, `BUZZ_DB_IDLE_TXN_TIMEOUT_MS`, or `BUZZ_DB_STATEMENT_TIMEOUT_MS` settings. Its session-timeout policy remains separate from the `buzz-db` writer policy and must be designed and rolled out independently.
|
||
|
||
All replicas must share one PostgreSQL database. Delivery authority, replay admission, and endpoint quota reservation are transactional there, so replica count does not multiply the abuse ceiling. The gateway owns a scoped migration history under `crates/buzz-push-gateway/migrations`; it creates only the six `push_gateway_*` authority tables plus SQLx's migration-history table and never runs relay migrations.
|
||
|
||
The Helm chart runs a single pre-install/pre-upgrade migration Job using `migration.existingSecret`; that secret contains a DDL-capable `DATABASE_URL`. The URL MUST name a dedicated gateway database, not the relay database: SQLx stores its `_sqlx_migrations` history in `public`, so sharing a database would collide with another application's migration history. `migration.runtimeDatabaseRole` names an existing LOGIN role (the default is `buzz_push_gateway_runtime`) used by runtime `DATABASE_URL`. After scoped migrations, the Job revokes database `CREATE` from that role and schema `CREATE` from both `PUBLIC` and the role, then grants only database `CONNECT`, schema `USAGE`, and `SELECT, INSERT, UPDATE, DELETE` on the six gateway tables. The migration role must own the database/schema objects or otherwise be allowed to issue those grants; it is never provided to runtime replicas. Readiness rejects an empty/partial schema, missing DML, or a runtime role that retains database/schema `CREATE`. Helm waits for the migration hook before updating replicas, so rolling deployments never race unconditional startup migration. Readiness must be removed from load-balancer service endpoints before terminating a pod.
|
||
|
||
The service reaps expired challenges and replay rows, idle quota rows, expired/revoked delegations, and retention-eligible installations (including their encrypted token ciphertext) at startup and every five minutes. Monitor reaper failures and table growth; retention does not depend on process restarts.
|
||
|
||
## Metrics and alerting
|
||
|
||
The gateway serves Prometheus metrics at `GET /metrics` on the **private health listener** (`BUZZ_PUSH_HEALTH_ADDR`, default `0.0.0.0:8081`) — the same port as the probes, never on the public `8080`. All series are sanitized and bounded-cardinality: label values are drawn only from closed sets (the five APNs outcome classes, the fixed admission results, the static error codes already returned to callers, and the readiness causes). No endpoint, device token, relay pubkey, request id, or any request-scoped identifier is ever used as a label.
|
||
|
||
| Metric | Type | Labels | Meaning |
|
||
|---|---|---|---|
|
||
| `push_gateway_apns_send_attempts_total` | counter | none | Entries into the concrete APNs HTTP send seam. Compare with terminal outcomes to detect work that never reached transport. |
|
||
| `push_gateway_apns_deliveries_total` | counter | `outcome` = `accepted` \| `invalid_endpoint` \| `retry` \| `configuration_fault` \| `permanent_request_fault` | Terminal APNs send outcomes. |
|
||
| `push_gateway_apns_delivery_seconds` | histogram | — | APNs send round-trip latency (seconds). |
|
||
| `push_gateway_admissions_total` | counter | `result` = `admitted` \| `rejected` \| `unavailable` | Outcome at the `authorize_delivery` replay/quota fence. |
|
||
| `push_gateway_delivery_errors_total` | counter | `class` (static) | Selected delivery-handler exit classes only (see note). |
|
||
| `push_gateway_reaper_failures_total` | counter | — | Retention reaper sweep failures. |
|
||
| `push_gateway_readiness_failures_total` | counter | `cause` = `not_accepting` \| `authority` | Readiness probe failures by cause. |
|
||
|
||
`push_gateway_delivery_errors_total` is intentionally **narrow**: it counts only selected exit classes of the `/v1/deliveries/apns` handler. `class` ∈ `invalid_grant` (grant rejected at the admission seam, before a permit is issued), `rate_limited`, `temporarily_unavailable` (authority unavailable at the admission seam), `profile_mismatch`, `profile_disabled`, `token_custody` (endpoint-token open failure), `finish_failed` (detached disposition/join failure returned as 503). Request/auth/attestation/grant validation on the enrollment, delegation, rotation, and revocation handlers is **not** counted by this metric; it is a delivery-hot-path signal, not a total error rate across the API.
|
||
|
||
Scraping is **opt-in** and off by default, so the default chart render is unchanged and `8081` keeps no pod ingress. For prometheus-operator, set `podMonitor.enabled=true` and `networkPolicy.monitoring.enabled=true` with `networkPolicy.monitoring.namespaceSelector` / `podSelector` naming your scraper. For Datadog Autodiscovery, leave `podMonitor.enabled=false`, supply the OpenMetrics check through `podAnnotations`, and enable the same narrowly selected NetworkPolicy ingress:
|
||
|
||
```yaml
|
||
podAnnotations:
|
||
ad.datadoghq.com/gateway.checks: |
|
||
{
|
||
"openmetrics": {
|
||
"init_config": {},
|
||
"instances": [{
|
||
"openmetrics_endpoint": "http://%%host%%:8081/metrics",
|
||
"service": "buzz-push-gateway",
|
||
"namespace": "block.buzz_push_gateway",
|
||
"metrics": ["push_gateway_.*"],
|
||
"histogram_buckets_as_distributions": true,
|
||
"send_distribution_buckets": true,
|
||
"send_monotonic_counter": true,
|
||
"collect_counters_with_distributions": true
|
||
}]
|
||
}
|
||
}
|
||
networkPolicy:
|
||
monitoring:
|
||
enabled: true
|
||
namespaceSelector: # replace with the Datadog Agent namespace labels
|
||
kubernetes.io/metadata.name: datadog
|
||
podSelector: # replace with the Datadog Agent pod labels
|
||
app.kubernetes.io/name: datadog-agent
|
||
```
|
||
|
||
Both modes add one `8081` ingress rule scoped to the configured source, never a blanket allowance. Node/kubelet-origin probe traffic remains exempt from NetworkPolicy regardless. Do not enable `PodMonitor` in clusters without its CRD.
|
||
|
||
Alerting rules ship as an opt-in prometheus-operator `PrometheusRule` (`prometheusRule.enabled=true`). Thresholds and operator actions:
|
||
|
||
| Alert | Fires when | Severity | Action |
|
||
|---|---|---|---|
|
||
| `PushGatewayConfigurationFault` | any `configuration_fault` outcomes for 10m | critical | The APNs certificate/topic/environment is unhealthy. Check `BUZZ_PUSH_APNS_*` configuration. No endpoints are being invalidated. |
|
||
| `PushGatewayAdmissionUnavailable` | any admission `unavailable` for 5m | critical | PostgreSQL authority store is unreachable. Check DB connectivity and the pod's `postgresEgressCidrs` NetworkPolicy. |
|
||
| `PushGatewayReadinessAuthorityFailing` | readiness `authority` failures for 5m | warning | Replicas are being pulled from the Service on DB check failure. Fix DB health before capacity drops below the PodDisruptionBudget. |
|
||
| `PushGatewayReaperFailing` | reaper failed ≥2 times within 30m (runs every 5m) | warning | Expired reservations aren't being swept, growing the bounded-until-expiry window. Check DB write availability. |
|
||
| `PushGatewayHighApnsRetryRate` | retryable fraction > `prometheusRule.apnsRetryRatioThreshold` (default `0.25`) over a 10m window, above `apnsRetryMinSamples` (default `20`) attempts, held true for 15m | warning | APNs is throttling or degraded (429/500/503). Deliveries are delayed, not lost. |
|
||
|
||
## Relay configuration
|
||
|
||
Relay push is an explicit deployment opt-in through `BUZZ_PUSH_ENABLED=true`;
|
||
the established strict boolean parser rejects unknown values and the default is
|
||
false. When enabled, `BUZZ_PUSH_GATEWAY_DELIVERY_URL` is required and must be an
|
||
exact HTTP(S) `/v1/deliveries/apns` URL. Credentials, query and fragment are
|
||
not accepted. The relay signs and sends the same configured URL. An absent or explicitly empty URL while
|
||
enabled is a startup error. Only an enabled relay
|
||
advertises its host-scoped NIP-PL descriptor, accepts leases, and starts the
|
||
matcher and delivery worker. Relays retain lease matching, authorization, durable
|
||
jobs/retries, and generation checks; they receive only opaque capabilities and
|
||
never APNs tokens or provider credentials.
|
||
|
||
An enabled relay exports the following bounded-cardinality series on its
|
||
existing Prometheus endpoint. None carries a community, account, relay key,
|
||
installation, event, or request identifier as a label.
|
||
|
||
| Metric | Type | Labels | Meaning |
|
||
|---|---|---|---|
|
||
| `buzz_push_enabled` | gauge | — | `1` only when the deployment opt-in is active. |
|
||
| `buzz_push_enqueue_total` | counter | `result` = `completed` \| `full` \| `transaction_full` \| `closed` \| `error` \| `timeout` \| `shutdown` | Best-effort post-commit enqueue outcomes. |
|
||
| `buzz_push_match_jobs_total` | counter | `result` = `matched` \| `unmatched` \| `error` \| `context_error` | Accepted message events evaluated by the matcher. |
|
||
| `buzz_push_match_queue_seconds` | histogram | — | Relay receipt to matcher evaluation latency. |
|
||
| `buzz_push_wakes_total` | counter | `result` = `enqueued` \| `duplicate` \| `inactive_lease` | Durable wake-enqueue outcomes. |
|
||
| `buzz_push_wake_enqueue_errors_total` | counter | — | Set-wise outbox transactions that failed. |
|
||
| `buzz_push_wake_queue_seconds` | histogram | — | First-attempt outbox enqueue-to-worker latency. |
|
||
| `buzz_push_gateway_requests_total` | counter | — | Relay requests that reached the gateway transport seam. |
|
||
| `buzz_push_gateway_request_seconds` | histogram | — | Relay-observed gateway request latency. |
|
||
| `buzz_push_deliveries_total` | counter | `outcome` (static closed set) | Accepted, retried, suppressed, exhausted, invalid, or failed relay delivery outcomes. |
|
||
|
||
## Relay integration status
|
||
|
||
The operational relay integration is complete: per-origin event matching with
|
||
read-authorization checks, durable enqueue, send-time revalidation, and NIP-98
|
||
delivery run only when `BUZZ_PUSH_ENABLED=true`. End-to-end use still requires
|
||
the client App Attest enrollment/delegation flow to place a gateway-issued opaque
|
||
capability—not a raw APNs token—into the encrypted relay lease.
|
||
|
||
## Evaluation and rollout
|
||
|
||
Enable push only after a physical-device test with the deployment's configured
|
||
application identity, APNs topic, certificate and environment. Updated clients
|
||
require the NIP-11 `buzz-push-v1` capability. Keep `nip-pl` disabled on production
|
||
relays throughout the cutover.
|
||
|
||
Build a signed release candidate with both the app and Notification Service
|
||
Extension provisioned. Verify APNs delivery, fetched and signature-verified
|
||
notification content, and exact-message tap routing. Enable Apple's Communication
|
||
Notifications capability on the parent App ID for rich message presentation.
|
||
|
||
For each evaluation cohort, measure relay receipt-to-match, wake queue, relay-to-
|
||
gateway, and gateway-to-APNs latencies from the histograms above. Track the
|
||
ratio of accepted or replay-terminal relay outcomes to newly enqueued wakes,
|
||
gateway APNs accepted/retry/invalid/configuration outcomes, retry exhaustion,
|
||
and NSE resolution fallback. APNs acceptance cannot prove device presentation:
|
||
record a small manual physical-device sample with event-created, banner-visible,
|
||
and notification-tap timestamps, and verify that the visible title/body came
|
||
from fetched, signature-verified relay content and that the tap opened the exact
|
||
triggering message. Keep fallback-to-channel and placeholder/failure cases as
|
||
explicit counts in the manual sample until privacy-preserving client telemetry
|
||
is designed.
|
||
|
||
### Relay rollback and reactivation
|
||
|
||
Set `BUZZ_PUSH_ENABLED=false` in the approved configuration for **every writer
|
||
workload in the affected database scope**, then replace all previously enabled
|
||
relay processes. This is a startup setting, not a live configuration reload.
|
||
Keep the delivery URL, image, relay keys, schema, leases, client preferences and
|
||
gateway grants unchanged. Do not stop a shared gateway as part of relay rollback.
|
||
|
||
The relay copies the flag into `DbConfig::push_enabled`. Every physical writer
|
||
connection, including the audit pool and replacement connections, sets the
|
||
`buzz.push_enabled` PostgreSQL session setting. Other `DbConfig` callers default
|
||
to disabled. Updated writers also set `buzz.push_async_enqueue=on`, which makes
|
||
the surviving trigger skip enqueueing regardless of the enabled flag. The
|
||
application producer is created only when enabled. Disabled writes perform no
|
||
push locks, lease scans or queue writes.
|
||
The overlap migration updates only an existing trigger function; it does not
|
||
recreate a retired trigger or function. Deploy that migration before relying on
|
||
the flag with a surviving trigger. Older images and raw SQL writers with a
|
||
missing setting retain legacy enqueue behavior; inventory and replace or
|
||
explicitly disable all such connections before declaring rollback complete.
|
||
|
||
On SIGTERM/Ctrl-C, the relay cancels enqueue, matcher and delivery futures immediately,
|
||
before its listener drain. Uncommitted transactions roll back; committed claims
|
||
remain leased until their normal expiry. No cancellation cleanup deletes or
|
||
acknowledges queue entries. An HTTP request already accepted by the gateway may
|
||
still produce a notification. The process shutdown deadline remains the hard
|
||
backstop; a stalled replacement with old workers alive is incomplete rollback.
|
||
|
||
Verify all old writer sessions and workers have exited, eligible messages still
|
||
store and arrive in chat, no new matcher jobs appear, and gateway attempts stop
|
||
once in-flight work settles. Inspect enqueue activity as well as queue counts:
|
||
a stable count alone can conceal additions and removals. Ordinary reads, writes,
|
||
authentication and reconnects must remain healthy.
|
||
|
||
When enabled, updated application writers stage at most 256 event IDs per
|
||
transaction and submit them only after successful commit using a non-waiting
|
||
send. One background worker has a 256-item queue and a dedicated one-connection
|
||
pool; it never borrows a message-write connection. Each attempt has a two-second
|
||
deadline, a 500 ms lock timeout and a 1.5 second statement timeout. Saturation,
|
||
errors, deadlines, process loss and shutdown can drop notifications. They cannot
|
||
reject or roll back a committed message, and there is no replay/backfill of
|
||
in-memory work. Monitor `buzz_push_enqueue_total` by result (`completed`, `full`,
|
||
`transaction_full`, `closed`, `error`, `timeout`, `shutdown`). `completed` includes
|
||
jobs with no eligible lease. Database enqueue is conditional on a live event and
|
||
an eligible lease whose recorded update timestamp is no later than event receipt.
|
||
These timestamps do not establish transaction commit order. When registration
|
||
and message arrival overlap, either sending or suppressing the notification is
|
||
acceptable; there is no exact enrollment-order guarantee. A concurrent lease
|
||
update, including renewal of an active lease, can also suppress a notification
|
||
under this best-effort contract. Activation never scans
|
||
historical messages or deliberately backfills older notifications.
|
||
|
||
This isolation requires the overlap migration and updated writers. Old images
|
||
and raw SQL writers can still run the legacy transactional trigger until replaced.
|
||
|
||
Pending matcher jobs and pending/claimed delivery jobs remain dormant. Do not
|
||
process or delete them during urgent rollback. **Before re-enabling**, inspect
|
||
retained work across the full affected scope and record an explicit disposition
|
||
decision. Cleanup size, batching and scoped commands are an operator decision;
|
||
preserve leases and handle completed records through retention policy. There is
|
||
no automatic purge or startup queue interlock: enabling workers resumes eligible
|
||
retained work under existing expiry/retry rules. Thus an unchecked nonempty queue
|
||
must not be silently reactivated. Messages stored while disabled are not
|
||
backfilled on lease activation or re-enablement.
|
||
|
||
## Helm production inputs
|
||
|
||
The chart defaults to the `main` image tag because `.github/workflows/docker.yml` publishes it from the push-gateway lane. For a production rollout, open that workflow run's **Publish public push gateway image** job summary and copy its `sha256:...` digest. Verify the published subject and provenance before injecting it:
|
||
|
||
```bash
|
||
gh attestation verify \
|
||
oci://ghcr.io/block/buzz-push-gateway@sha256:<64-lowercase-hex> \
|
||
--repo block/buzz \
|
||
--signer-workflow block/buzz/.github/workflows/docker.yml \
|
||
--source-digest <40-lowercase-hex-source-commit>
|
||
```
|
||
|
||
Only after that command succeeds, inject the exact digest as `image.digest` in
|
||
the environment's GitOps values; the chart then renders
|
||
`ghcr.io/block/buzz-push-gateway@sha256:...` and ignores the mutable tag.
|
||
`values-production.yaml` remains an intentionally invalid production-input
|
||
contract: deployment CI must inject the verified image digest, the provisioned
|
||
distributed Apple application identifier, its matching APNs topic, and the actual PostgreSQL network. Set
|
||
`gatewayOrigin` only when enabling the chart’s optional HTTPRoute; it supplies
|
||
the routing hostname and is not passed to the gateway binary. In an
|
||
environment with an existing ingress or service mesh route, keep
|
||
`httpRoute.enabled=false`. If this chart owns a Gateway API route, enable it and
|
||
inject an environment-owned `parentRef`; schema validation rejects an enabled
|
||
route with no parent. The render guard proves both rejection of missing required
|
||
inputs and fully injected renders.
|
||
|
||
Network policy keeps APNs HTTPS and PostgreSQL egress in separate CIDR lists. APNs currently requires broad TCP/443 reachability; `networkPolicy.postgresEgressCidrs` must be narrowed to the production database network, and the DNS namespace/pod selectors must match the cluster DNS deployment. The sample private CIDR is not a claim about the production topology.
|
||
|
||
Kubernetes does not restart pods when referenced Secret bytes change. AEAD or APNs certificate rotation therefore requires an explicit rolling restart after the secret manager update (for example, `kubectl rollout restart deployment/<release>-buzz-push-gateway`) and readiness verification before removing predecessor keys. Service-account token automount is disabled.
|
||
|
||
## Gateway chart release
|
||
|
||
The gateway chart has a collision-free release lane separate from the main
|
||
`buzz` chart. To publish chart version `X.Y.Z`, update `version` in
|
||
`deploy/charts/buzz-push-gateway/Chart.yaml` and keep `appVersion` equal to the
|
||
gateway binary's workspace package version.
|
||
|
||
The render tests require Helm, Ruby, and the repository's Rust toolchain. They
|
||
pass rendered environment values into the gateway's configuration parser with
|
||
synthetic credentials; no running gateway or database is needed.
|
||
|
||
Validate the chart, then open a same-repository PR whose branch is exactly
|
||
`push-chart-release/X.Y.Z`:
|
||
|
||
```bash
|
||
deploy/charts/buzz-push-gateway/tests/render.sh
|
||
git switch -c push-chart-release/X.Y.Z
|
||
git add deploy/charts/buzz-push-gateway/Chart.yaml
|
||
git commit -m "release: push gateway chart X.Y.Z"
|
||
git push -u origin push-chart-release/X.Y.Z
|
||
```
|
||
|
||
When that PR merges, `.github/workflows/auto-tag-on-release-pr-merge.yml`
|
||
creates `push-chart-vX.Y.Z` and dispatches
|
||
`.github/workflows/push-gateway-helm-chart.yml` with that immutable tag and bare
|
||
version. The publisher verifies the checked-out commit is the tag target and the
|
||
chart version equals `X.Y.Z` before pushing
|
||
`oci://ghcr.io/block/buzz/charts/buzz-push-gateway`. A manually pushed
|
||
`push-chart-vX.Y.Z` tag is the documented rescue path and runs the same checks.
|
||
After the publisher succeeds, inspect and fetch the published chart version
|
||
before use:
|
||
|
||
```bash
|
||
helm show chart oci://ghcr.io/block/buzz/charts/buzz-push-gateway --version X.Y.Z
|
||
helm pull oci://ghcr.io/block/buzz/charts/buzz-push-gateway --version X.Y.Z
|
||
```
|
||
|
||
|
||
### Delivery URL at the gateway
|
||
|
||
The gateway verifies the signed method and delivery path using the NIP-98 event
|
||
format, rather than matching the full incoming HTTP(S) request URL. The signed
|
||
method must be `POST`; the signed URL path must be `/v1/deliveries/apns`, without
|
||
query, fragment or credentials. Incoming request queries are rejected.
|
||
Host and forwarding headers do not participate in delivery authentication.
|
||
Event signatures, body hashes, timestamps, grant checks and replay protection
|
||
remain enforced. No mobile App Attest audiences or relay activation settings change.
|