Files
buzz/mobile/ios/Runner/PushSnapshotBridge.swift
Tom Brow c432a111ca feat(mobile): push notifications MVP (#6269)
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>
2026-08-28 15:15:09 -06:00

272 lines
9.1 KiB
Swift

import BuzzPushKit
import Flutter
import Foundation
final class BuzzPushSnapshotBridge {
private let appGroupIdentifier: String?
private let endpointGrantStore: BuzzPushEndpointGrantKeychainStore
private let keychainAccessGroup: String?
private let queue = DispatchQueue(
label: "xyz.block.buzz.push-snapshot",
qos: .utility
)
private lazy var store: BuzzPushPresentationCacheStore? = {
guard let appGroupIdentifier,
let container = FileManager.default.containerURL(
forSecurityApplicationGroupIdentifier: appGroupIdentifier
)
else { return nil }
return BuzzPushPresentationCacheStore(containerURL: container)
}()
init(
appGroupIdentifier: String?,
endpointGrantStore: BuzzPushEndpointGrantKeychainStore,
keychainAccessGroup: String?
) {
self.appGroupIdentifier = appGroupIdentifier
self.endpointGrantStore = endpointGrantStore
self.keychainAccessGroup = keychainAccessGroup
}
@discardableResult
func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) -> Bool {
guard call.method == "syncPushSnapshot",
let arguments = call.arguments as? [String: Any],
let section = arguments["section"] as? String
else {
return false
}
switch section {
case "communities": syncCommunities(arguments, result: result)
case "profiles": cacheProfiles(arguments, result: result)
case "channels": cacheChannels(arguments, result: result)
case "avatar": cacheAvatar(arguments, result: result)
default: return false
}
return true
}
private func syncCommunities(_ arguments: [String: Any], result: @escaping FlutterResult) {
guard let communities = arguments["communities"] as? [[String: Any]],
let signingKeys = arguments["signingKeys"] as? [String: String],
communities.count <= BuzzPushPresentationCacheStore.maximumCommunities
else {
result(
FlutterError(
code: "invalid_arguments",
message: "Expected bounded communities and signing keys.",
details: nil
)
)
return
}
queue.async { [weak self] in
do {
guard let self, let store else {
Self.complete(result, value: nil)
return
}
// Relay-metadata enrichment is optional presentation state. A damaged
// grant cache must not block the core NSE snapshot and key update.
let grants = (try? endpointGrantStore.records()) ?? []
let enriched = communities.map { community -> [String: Any] in
var community = community
guard let relayURL = community["relayUrl"] as? String,
let relayMetadataPubkey = Self.relayMetadataPubkey(
relayURL: relayURL,
grants: grants
)
else { return community }
community["relayMetadataPubkey"] = relayMetadataPubkey
return community
}
let data = try JSONSerialization.data(withJSONObject: enriched, options: [.sortedKeys])
let decoded = try JSONDecoder().decode([PushLeaseCommunity].self, from: data)
try store.replaceCommunities(decoded)
try BuzzPushKeychain.replace(
signingKeys: signingKeys,
accessGroup: keychainAccessGroup
)
Self.complete(result, value: nil)
} catch {
Self.complete(
result,
value: FlutterError(
code: "snapshot_sync_failed",
message: "Unable to sync push community state.",
details: error.localizedDescription
)
)
}
}
}
static func relayMetadataPubkey(
relayURL: String,
grants: [BuzzPushEndpointGrantRecord]
) -> String? {
guard let origin = BuzzPushPresentationCacheStore.canonicalRelayOrigin(relayURL) else {
return nil
}
return grants.filter {
$0.appProfile == BuzzDevPushEnrollmentDriver.appProfile
&& BuzzPushPresentationCacheStore.canonicalRelayOrigin($0.relayOrigin) == origin
}.max {
$0.generation < $1.generation
}?.relayMetadataPubkey
}
private func cacheProfiles(_ rawArguments: Any?, result: @escaping FlutterResult) {
guard let arguments = rawArguments as? [String: Any],
let communityID = arguments["communityId"] as? String,
let rawEvents = arguments["events"] as? [[String: Any]],
rawEvents.count <= BuzzPushPresentationCacheStore.maximumProfiles
else {
result(
FlutterError(
code: "invalid_arguments",
message: "Expected communityId and profile events.",
details: nil
)
)
return
}
queue.async { [weak self] in
do {
guard let self, let community = community(id: communityID) else {
Self.complete(result, value: nil)
return
}
let events = try decodeEvents(rawEvents)
try store?.updateProfiles(
communityID: communityID,
relayOrigin: community.relayUrl,
updates: events.map { BuzzPushProfileCacheUpdate(event: $0) }
)
Self.complete(result, value: nil)
} catch {
Self.complete(
result,
value: FlutterError(
code: "profile_cache_failed",
message: "Unable to cache push sender profiles.",
details: error.localizedDescription
)
)
}
}
}
private func cacheChannels(_ rawArguments: Any?, result: @escaping FlutterResult) {
guard let arguments = rawArguments as? [String: Any],
let communityID = arguments["communityId"] as? String,
let rawMetadataEvents = arguments["metadataEvents"] as? [[String: Any]],
let rawMembershipEvents = arguments["membershipEvents"] as? [[String: Any]],
rawMetadataEvents.count <= BuzzPushPresentationCacheStore.maximumChannels,
rawMembershipEvents.count <= BuzzPushPresentationCacheStore.maximumChannels
else {
result(
FlutterError(
code: "invalid_arguments",
message: "Expected communityId, channel metadata, and membership events.",
details: nil
)
)
return
}
queue.async { [weak self] in
do {
guard let self, let community = community(id: communityID),
let relayMetadataPubkey = community.relayMetadataPubkey
else {
Self.complete(result, value: nil)
return
}
try store?.updateChannels(
communityID: communityID,
relayOrigin: community.relayUrl,
relayMetadataPubkey: relayMetadataPubkey,
metadataEvents: try decodeEvents(rawMetadataEvents),
membershipEvents: try decodeEvents(rawMembershipEvents)
)
Self.complete(result, value: nil)
} catch {
Self.complete(
result,
value: FlutterError(
code: "channel_cache_failed",
message: "Unable to cache push channel metadata.",
details: error.localizedDescription
)
)
}
}
}
private func cacheAvatar(_ rawArguments: Any?, result: @escaping FlutterResult) {
guard let arguments = rawArguments as? [String: Any],
let communityID = arguments["communityId"] as? String,
let sourceURL = arguments["sourceUrl"] as? String,
let avatar = arguments["png"] as? FlutterStandardTypedData
else {
result(
FlutterError(
code: "invalid_arguments",
message: "Expected an avatar source and PNG thumbnail.",
details: nil
)
)
return
}
let avatarData = avatar.data
queue.async { [weak self] in
do {
guard let self, let community = community(id: communityID) else {
Self.complete(result, value: false)
return
}
let updated =
try store?.updateAvatar(
communityID: communityID,
relayOrigin: community.relayUrl,
sourceURL: sourceURL,
avatarPNG: avatarData
) ?? false
Self.complete(result, value: updated)
} catch {
Self.complete(
result,
value: FlutterError(
code: "avatar_cache_failed",
message: "Unable to cache a push sender avatar.",
details: error.localizedDescription
)
)
}
}
}
private func community(id: String) -> PushLeaseCommunity? {
guard let appGroupIdentifier,
let container = FileManager.default.containerURL(
forSecurityApplicationGroupIdentifier: appGroupIdentifier
),
let data = try? Data(contentsOf: container.appendingPathComponent(BuzzPushPresentationCacheStore.fileName)),
let snapshot = try? JSONDecoder().decode(BuzzPushPresentationCacheSnapshot.self, from: data)
else { return nil }
return snapshot.communities.first { $0.id == id }
}
private func decodeEvents(_ rawEvents: [[String: Any]]) throws -> [VerifiedNostrEvent] {
let data = try JSONSerialization.data(withJSONObject: rawEvents)
return try JSONDecoder().decode([VerifiedNostrEvent].self, from: data)
}
private static func complete(_ result: @escaping FlutterResult, value: Any?) {
DispatchQueue.main.async {
result(value)
}
}
}