mirror of
https://github.com/block/buzz.git
synced 2026-10-29 13:31:44 +00:00
This PR implements MVP, iOS-only,
[NIP-PL](8d2d0ff5ad/docs/nips/NIP-PL.md)-compliant
push notifications.
A relay with `BUZZ_PUSH_ENABLED` will send a push notification for any
message that appears in the in-app Notifications tab.
## Enrollment flow
The first time the client first connects to a relay with
`BUZZ_PUSH_ENABLED`:
```mermaid
sequenceDiagram
autonumber
participant App as Buzz iOS app
participant iOS
participant Relay as Buzz relay
participant Attest as Apple App Attest
participant Gateway as Push gateway
App->>Relay: Fetch NIP-11 push capability
Relay-->>App: Push profile, current relay public key, and limits
par
App->>iOS: Request notification permission
iOS-->>App: Permission result
and
App->>iOS: Register for remote notifications
iOS-->>App: Device token
end
App->>Gateway: Request installation challenge
Gateway-->>App: Single-use challenge
App->>Attest: Attest installation transcript
Attest-->>App: Attestation proof
App->>Gateway: Enroll device token and proof
Gateway-->>App: Installation handle
App->>Gateway: Request delegation challenge
Gateway-->>App: Single-use challenge
App->>Attest: Assert relay-key delegation
Attest-->>App: Assertion
App->>Gateway: Create delegation
Gateway-->>App: Opaque endpoint grant
App->>Relay: Publish encrypted push lease and filters
Relay-->>App: Lease acknowledged
```
## Push-time flow
When a notification-eligible event is received by the relay:
```mermaid
%%{init: {
"sequence": {
"actorMargin": 20,
"width": 110,
"messageMargin": 18,
"diagramMarginX": 8,
"wrap": true
}
}}%%
sequenceDiagram
autonumber
participant Relay as Buzz relay
participant Gateway as Push gateway
participant APNs as Apple Push<br/>Notification service
participant iOS
participant NSE as Notification service<br/>extension
Relay->>Gateway: POST /v1/deliveries/apns<br/>opaque endpoint grant, request ID, expiry, NIP-98 authorization
Gateway->>APNs: POST /3/device/{device-token}<br/>topic, request ID, expiry, constant mutable-content payload
APNs-->>Gateway: 200 OK: request accepted
Gateway-->>Relay: 200 OK: accepted status
APNs-->>iOS: Notification: constant reconnect alert<br/>mutable-content = 1
iOS->>NSE: Invoke extension<br/>original notification content
NSE->>Relay: POST /query: subscription filters, limit 10<br/>NIP-98 authorization
Relay-->>NSE: 200 OK: signed Nostr events<br/>kinds 9, 40002, 45001, or 45003
NSE->>iOS: Complete notification: title, body, subtitle<br/>thread ID, exact-message target
```
relay → push gateway → APNs -> NSE -> Notification Center
## Known limitations
The APNs wake payload is intentionally constant and opaque: it contains
no originating community or message identifier, in keeping with the
implemented NIP-PL privacy design.
The Notification Service Extension must therefore reconnect to the relay
and resolve eligible messages after each wake. Around overlapping wakes,
timing boundaries, or resolution windows, notification presentation may
occasionally omit an expected message or display a message more than
once.
This best-effort behavior is deliberately accepted for the current
implementation and will be measured during the internal rollout to
determine whether the user experience is acceptable before any broader
deployment; the implementation does not claim exactly-once presentation.
## Validation
Live end-to-end hardware validation used an internal remotely hosted
development relay and push gateway, the APNs sandbox, and a physical
iPhone 12 mini:
- A second real Buzz client published a uniquely marked message through
the hosted relay.
- The relay matched the message and sent the constant opaque wake
through the hosted gateway. The gateway made an actual APNs request; no
`simctl push` or simulated notification was used.
- The iPhone received the notification on its lock screen. The
Notification Service Extension reconnected to the relay, fetched the
event, verified its ID and signature, and replaced the placeholder
content with the real notification title and body.
- After the app populated its shared presentation cache, a final marked
notification visibly showed the sender display name, sender avatar, and
hashtag-prefixed channel name.
- Tapping a lock-screen notification opened Buzz and exercised the
notification-response path and navigated to the corresponding message.
Final validation with a dogfood-signed artifact and production App
Attest/APNs configuration remains a release step.
## Independent pre-reviews
- **First pass:**
[Carl](buzz://message?channel=18882f4c-289f-41db-942f-81f6f8066da1&id=74ab9a93bb227f3e762568f1cf9fee66d7495b0edc3918735ff787238b9cc585)
found missing transient retries, executor-key rotation suppression,
duplicate installation renewal, and an unauthenticated challenge write
amplifier. These were resolved by [retry-safe
bootstrap](https://github.com/block/buzz/pull/6269/changes/12c66ea62)
and [authenticated renewal plus a cross-replica
quota](https://github.com/block/buzz/pull/6269/changes/8e5ece0bd).
[sol-max](buzz://message?channel=ad83385f-8e9e-4461-9a35-c1bf2e208532&id=d26d53daa4684669e2ed354638241f13f36c3a97027fe8b4dd738aff09038962)
found delegation generation burning and an edited applied migration,
resolved by [exact-generation
revocation](https://github.com/block/buzz/pull/6269/changes/c26d2159d)
and a [forward-only
migration](https://github.com/block/buzz/pull/6269/changes/956c1d099).
[k3-max](buzz://message?channel=5e46055d-a766-4065-ae25-05d1e4aaa6b2&id=d43139138a0b15f806cbdbeeedd8f69d992cadf2e805876db6fdde6a34c7eda1)
found no blockers.
- **Exact-head re-review:**
[Carl](buzz://message?channel=18882f4c-289f-41db-942f-81f6f8066da1&id=a897721673459301b0cf26e8b85a1478d7ebbb56a4621f93d774c98d395b8f68),
[sol-max](buzz://message?channel=ad83385f-8e9e-4461-9a35-c1bf2e208532&id=fb2159f709ec68f74f7b21459acd76da0e8a7c5c0f3d469f99826b0cc2380849),
and
[k3-max](buzz://message?channel=5e46055d-a766-4065-ae25-05d1e4aaa6b2&id=2ce2842910435f562e9d9cc718595848f281b122c94605e523a4b964254b8bfb)
independently returned **NO BLOCKERS** at `7eb3a650b`; k3-max also
revalidated every remediation and the endpoint-specific App Attest
enrollment bound.
---------
Signed-off-by: Tom Brow <tomb@squareup.com>
Signed-off-by: Tom Brow <tomb@block.xyz>
Co-authored-by: Tom Brow <tomb@squareup.com>
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: Jordan Mecom <jm@squareup.com>
186 lines
9.2 KiB
Bash
Executable File
186 lines
9.2 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
out=$(mktemp); production_out=$(mktemp)
|
|
trap 'rm -f "$out" "$production_out"' EXIT
|
|
|
|
# Defaults must lint and render without parameter injection.
|
|
helm lint deploy/charts/buzz-push-gateway >/dev/null
|
|
helm template push deploy/charts/buzz-push-gateway >"$out"
|
|
# Production values must attach push.buzz.xyz to an explicit Gateway.
|
|
production_args=(
|
|
-f deploy/charts/buzz-push-gateway/values-production.yaml
|
|
--set 'image.digest=sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
|
|
--set 'profiles.dogfood.appAttestAppId=REALTEAM.xyz.block.buzz.dogfood.mobile'
|
|
--set 'httpRoute.parentRefs[0].name=production-gateway'
|
|
--set 'httpRoute.parentRefs[0].namespace=gateway-system'
|
|
--set 'networkPolicy.postgresEgressCidrs[0]=10.42.0.0/16'
|
|
)
|
|
helm lint deploy/charts/buzz-push-gateway "${production_args[@]}" >/dev/null
|
|
helm template push deploy/charts/buzz-push-gateway "${production_args[@]}" >"$production_out"
|
|
|
|
env -u GEM_HOME -u GEM_PATH -u RUBYLIB -u RUBYOPT ruby -ryaml -rset \
|
|
- "$out" "$production_out" <<'RUBY'
|
|
def assert!(condition, detail = "assertion failed")
|
|
raise detail unless condition
|
|
end
|
|
|
|
xs = YAML.load_stream(File.read(ARGV[0])).compact
|
|
svc = xs.find { |x| x["kind"] == "Service" }
|
|
assert!(svc.dig("spec", "ports").map { |port| port["targetPort"] } == ["public"])
|
|
d = xs.find { |x| x["kind"] == "Deployment" }
|
|
j = xs.find { |x| x["kind"] == "Job" }
|
|
runtime = {
|
|
"app.kubernetes.io/name" => "buzz-push-gateway",
|
|
"app.kubernetes.io/instance" => "push",
|
|
"app.kubernetes.io/component" => "runtime",
|
|
}
|
|
migration = runtime.merge("app.kubernetes.io/component" => "migration")
|
|
assert!(svc.dig("spec", "selector") == runtime)
|
|
assert!(d.dig("spec", "selector", "matchLabels") == runtime)
|
|
assert!(d.dig("spec", "template", "metadata", "labels") == runtime)
|
|
assert!(j.dig("spec", "template", "metadata", "labels") == migration)
|
|
assert!(svc.dig("spec", "selector") != j.dig("spec", "template", "metadata", "labels"))
|
|
jenv = j.dig("spec", "template", "spec", "containers", 0, "env").to_h { |entry| [entry["name"], entry] }
|
|
assert!(jenv.dig("BUZZ_PUSH_RUNTIME_DATABASE_ROLE", "value") == "buzz_push_gateway_runtime")
|
|
assert!(jenv.fetch("DATABASE_URL").key?("valueFrom"))
|
|
assert!(j.dig("spec", "template", "spec", "containers", 0, "args") == ["--migrate-only"])
|
|
assert!(j.dig("metadata", "annotations") == {
|
|
"helm.sh/hook" => "pre-install,pre-upgrade",
|
|
"helm.sh/hook-weight" => "-5",
|
|
"helm.sh/hook-delete-policy" => "before-hook-creation,hook-succeeded",
|
|
})
|
|
env_names = d.dig("spec", "template", "spec", "containers", 0, "env")
|
|
.map { |entry| entry["name"] }.to_set
|
|
required = Set.new(%w[
|
|
DATABASE_URL BUZZ_PUSH_DOGFOOD_APNS_CERT_PATH
|
|
BUZZ_PUSH_DOGFOOD_APNS_TOPIC BUZZ_PUSH_DOGFOOD_APP_ATTEST_APP_ID
|
|
BUZZ_PUSH_GRANT_KEYS BUZZ_PUSH_TOKEN_KEYS BUZZ_PUSH_MAX_GRANT_LIFETIME_SECONDS
|
|
])
|
|
assert!(required.subset?(env_names))
|
|
assert!(!env_names.any? { |name| name.include?("APP_STORE") })
|
|
apns_volume = d.dig("spec", "template", "spec", "volumes").find { |volume| volume["name"] == "apns-dogfood" }
|
|
assert!(apns_volume.dig("secret", "defaultMode") == 0o400, apns_volume.inspect)
|
|
assert!(d.dig("spec", "replicas") >= 2)
|
|
assert!(!xs.any? { |x| x["kind"] == "HTTPRoute" })
|
|
# Observability is opt-in: default render exposes no scrape CRDs and 8081 stays
|
|
# free of pod ingress (only 8080 is reachable).
|
|
assert!(!xs.any? { |x| %w[PodMonitor PrometheusRule].include?(x["kind"]) })
|
|
nps = xs.select { |x| x["kind"] == "NetworkPolicy" }
|
|
np = nps.find { |x| x.dig("metadata", "name") == "push-buzz-push-gateway" }
|
|
migration_np = nps.find { |x| x.dig("metadata", "name") == "push-buzz-push-gateway-migration" }
|
|
assert!(np.dig("spec", "podSelector", "matchLabels") == runtime)
|
|
assert!(migration_np.dig("spec", "podSelector", "matchLabels") == migration)
|
|
assert!(migration_np.dig("metadata", "annotations") == {
|
|
"helm.sh/hook" => "pre-install,pre-upgrade",
|
|
"helm.sh/hook-weight" => "-10",
|
|
"helm.sh/hook-delete-policy" => "before-hook-creation",
|
|
})
|
|
assert!(migration_np.dig("metadata", "annotations", "helm.sh/hook-weight").to_i < j.dig("metadata", "annotations", "helm.sh/hook-weight").to_i)
|
|
assert!(migration_np.dig("spec", "ingress") == [])
|
|
assert!(migration_np.dig("spec", "policyTypes") == %w[Ingress Egress])
|
|
migration_ports = migration_np.dig("spec", "egress")
|
|
.flat_map { |rule| rule.fetch("ports", []) }.map { |port| port["port"] }.to_set
|
|
assert!(migration_ports == Set[53, 5432], migration_ports.inspect)
|
|
assert!(!migration_np.dig("spec", "egress").flat_map { |rule| rule.fetch("ports", []) }.any? { |port| port["port"] == 443 })
|
|
ingress_ports = np.dig("spec", "ingress")
|
|
.flat_map { |rule| rule.fetch("ports", []) }.map { |port| port["port"] }.to_set
|
|
assert!(ingress_ports == Set[8080], ingress_ports.inspect)
|
|
production = YAML.load_stream(File.read(ARGV[1])).compact
|
|
route = production.find { |x| x["kind"] == "HTTPRoute" }
|
|
assert!(!route.dig("spec", "parentRefs").empty?)
|
|
assert!(route.dig("spec", "hostnames").include?("push.buzz.xyz"))
|
|
RUBY
|
|
|
|
# Legacy token-auth values must fail rather than silently selecting the default
|
|
# certificate Secret.
|
|
if helm template push deploy/charts/buzz-push-gateway \
|
|
--set apnsKey.secretName=legacy-apns-secret \
|
|
--set apnsKey.secretKey=legacy-provider.p8 >/dev/null 2>&1; then
|
|
echo 'expected legacy apnsKey values to fail schema validation' >&2
|
|
exit 1
|
|
fi
|
|
|
|
# Enabling a route without a Gateway attachment must fail schema validation.
|
|
if helm template push deploy/charts/buzz-push-gateway --set httpRoute.enabled=true >/dev/null 2>&1; then
|
|
echo 'expected httpRoute.enabled=true without parentRefs to fail' >&2
|
|
exit 1
|
|
fi
|
|
|
|
# The checked-in production contract is intentionally undeployable until CI or
|
|
# the release system supplies an immutable digest and environment-owned values.
|
|
if helm template push deploy/charts/buzz-push-gateway -f deploy/charts/buzz-push-gateway/values-production.yaml >/dev/null 2>&1; then
|
|
echo 'expected uninjected production values to fail' >&2
|
|
exit 1
|
|
fi
|
|
|
|
# Enabling observability renders the scrape CRDs and adds a scoped 8081 ingress
|
|
# keyed to the named monitoring source — never a blanket 8081 rule.
|
|
monitoring_out=$(mktemp); trap 'rm -f "$out" "$production_out" "$monitoring_out"' EXIT
|
|
helm template push deploy/charts/buzz-push-gateway \
|
|
--set podMonitor.enabled=true \
|
|
--set prometheusRule.enabled=true \
|
|
--set networkPolicy.monitoring.enabled=true \
|
|
--set 'networkPolicy.monitoring.namespaceSelector.kubernetes\.io/metadata\.name=monitoring' \
|
|
--set 'networkPolicy.monitoring.podSelector.app\.kubernetes\.io/name=prometheus' \
|
|
>"$monitoring_out"
|
|
|
|
env -u GEM_HOME -u GEM_PATH -u RUBYLIB -u RUBYOPT ruby -ryaml -rset \
|
|
- "$monitoring_out" <<'RUBY'
|
|
def assert!(condition, detail = "assertion failed")
|
|
raise detail unless condition
|
|
end
|
|
|
|
xs = YAML.load_stream(File.read(ARGV[0])).compact
|
|
pm = xs.find { |x| x["kind"] == "PodMonitor" }
|
|
endpoint = pm.dig("spec", "podMetricsEndpoints", 0)
|
|
assert!(endpoint["port"] == "health" && endpoint["path"] == "/metrics", endpoint.inspect)
|
|
assert!(!xs.find { |x| x["kind"] == "PrometheusRule" }.dig("spec", "groups").empty?)
|
|
np = xs.find do |x|
|
|
x["kind"] == "NetworkPolicy" && x.dig("metadata", "name") == "push-buzz-push-gateway"
|
|
end
|
|
monitoring = np.dig("spec", "ingress").select do |rule|
|
|
rule.fetch("ports", []).map { |port| port["port"] }.to_set == Set[8081]
|
|
end
|
|
assert!(monitoring.length == 1, "exactly one scoped 8081 ingress rule")
|
|
from = monitoring[0].fetch("from")[0]
|
|
# 8081 ingress must be scoped by both selectors, never empty/blanket.
|
|
assert!(!from.dig("namespaceSelector", "matchLabels").empty? && !from.dig("podSelector", "matchLabels").empty?, from.inspect)
|
|
RUBY
|
|
|
|
# Negative: monitoring enabled with default empty selectors must fail (would
|
|
# otherwise render a blanket 8081 rule matching all namespaces/pods).
|
|
if helm template push deploy/charts/buzz-push-gateway \
|
|
--set podMonitor.enabled=true \
|
|
--set networkPolicy.monitoring.enabled=true >/dev/null 2>&1; then
|
|
echo 'expected monitoring.enabled with empty selectors to fail' >&2
|
|
exit 1
|
|
fi
|
|
|
|
# Negative: scrape flags must be coupled. PodMonitor without ingress = an
|
|
# unreachable scraper; ingress without a PodMonitor = an open hole with no
|
|
# scraper. Both mismatches must fail schema validation.
|
|
if helm template push deploy/charts/buzz-push-gateway \
|
|
--set podMonitor.enabled=true \
|
|
--set 'networkPolicy.monitoring.namespaceSelector.kubernetes\.io/metadata\.name=monitoring' \
|
|
--set 'networkPolicy.monitoring.podSelector.app\.kubernetes\.io/name=prometheus' \
|
|
>/dev/null 2>&1; then
|
|
echo 'expected podMonitor.enabled without monitoring ingress to fail' >&2
|
|
exit 1
|
|
fi
|
|
if helm template push deploy/charts/buzz-push-gateway \
|
|
--set networkPolicy.monitoring.enabled=true \
|
|
--set 'networkPolicy.monitoring.namespaceSelector.kubernetes\.io/metadata\.name=monitoring' \
|
|
--set 'networkPolicy.monitoring.podSelector.app\.kubernetes\.io/name=prometheus' \
|
|
>/dev/null 2>&1; then
|
|
echo 'expected monitoring ingress without podMonitor.enabled to fail' >&2
|
|
exit 1
|
|
fi
|
|
|
|
# Negative: retry-ratio threshold is a fraction; a value > 1 must fail schema.
|
|
if helm template push deploy/charts/buzz-push-gateway \
|
|
--set prometheusRule.enabled=true \
|
|
--set prometheusRule.apnsRetryRatioThreshold=2 >/dev/null 2>&1; then
|
|
echo 'expected apnsRetryRatioThreshold=2 to fail' >&2
|
|
exit 1
|
|
fi
|