mirror of
https://github.com/block/buzz.git
synced 2026-10-27 12:40:30 +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>
547 lines
16 KiB
Dart
547 lines
16 KiB
Dart
import 'dart:convert';
|
|
|
|
import 'package:buzz/shared/auth/auth_provider.dart';
|
|
import 'package:buzz/shared/crypto/nip44.dart';
|
|
import 'package:buzz/shared/push/dev_push_lease.dart';
|
|
import 'package:buzz/shared/push/push_bridge.dart';
|
|
import 'package:buzz/shared/push/push_subscription.dart';
|
|
import 'package:buzz/shared/relay/nostr_models.dart';
|
|
import 'package:buzz/shared/relay/relay_session.dart';
|
|
import 'package:buzz/shared/relay/relay_socket.dart';
|
|
import 'package:buzz/shared/relay/signed_event_relay.dart';
|
|
import 'package:flutter_test/flutter_test.dart';
|
|
import 'package:hooks_riverpod/hooks_riverpod.dart';
|
|
import 'package:http/http.dart' as http;
|
|
import 'package:http/testing.dart';
|
|
import 'package:nostr/nostr.dart' as nostr;
|
|
|
|
void main() {
|
|
final signer = nostr.Keys.generate();
|
|
final relay = nostr.Keys.generate();
|
|
final descriptor = _descriptor(relay.public);
|
|
final grant = _grant(relay.public);
|
|
final now = DateTime.fromMillisecondsSinceEpoch(1752620000 * 1000);
|
|
|
|
test('legacy capability does not enable Buzz push', () {
|
|
final information = _descriptorJson(relay.public);
|
|
information['supported_extensions'] = ['nip-pl'];
|
|
expect(
|
|
() => BuzzPushLeaseDescriptor.fromRelayInformation(information),
|
|
throwsFormatException,
|
|
);
|
|
});
|
|
|
|
test('publishes strict kind-30350 lease and waits for accepted OK', () async {
|
|
Map<String, dynamic>? submitted;
|
|
final publication = await publishBuzzDevPushLease(
|
|
grant: grant,
|
|
leaseGeneration: 7,
|
|
descriptor: descriptor,
|
|
nsec: signer.nsec,
|
|
memberPubkey: signer.public,
|
|
subscriptions: [
|
|
BuzzPushSubscription(
|
|
filter: BuzzPushFilter(kinds: const [9], pTags: [signer.public]),
|
|
notificationClass: 'default',
|
|
),
|
|
],
|
|
now: () => now,
|
|
submit:
|
|
({required kind, required content, required tags, createdAt}) async {
|
|
submitted = {
|
|
'kind': kind,
|
|
'content': content,
|
|
'tags': tags,
|
|
'createdAt': createdAt,
|
|
};
|
|
return const NostrEvent(
|
|
id: 'accepted-id',
|
|
pubkey: '',
|
|
createdAt: 0,
|
|
kind: 0,
|
|
tags: [],
|
|
content: 'saved',
|
|
sig: '',
|
|
);
|
|
},
|
|
);
|
|
|
|
expect(publication.eventId, 'accepted-id');
|
|
expect(grant.relayOrigin, descriptor.origin);
|
|
expect(jsonDecode(publication.plaintext)['origin'], descriptor.origin);
|
|
expect(submitted!['kind'], buzzPushLeaseKind);
|
|
expect(submitted!['createdAt'], 1752620000);
|
|
expect(submitted!['tags'], [
|
|
['d', 'c' * 32],
|
|
['expiration', '1755212000'],
|
|
['exec', 'relay-v1'],
|
|
]);
|
|
final plaintext = nip44Decrypt(
|
|
getConversationKey(relay.secret, signer.public),
|
|
submitted!['content'] as String,
|
|
);
|
|
expect(jsonDecode(plaintext), {
|
|
'v': 1,
|
|
'origin': 'wss://tenant.example:8443',
|
|
'transport': 'apns',
|
|
'endpoint': 'opaque-grant',
|
|
'generation': 7,
|
|
'active': true,
|
|
'subscriptions': [
|
|
{
|
|
'filter': {
|
|
'kinds': [9],
|
|
'#p': [signer.public],
|
|
},
|
|
'class': 'default',
|
|
},
|
|
],
|
|
});
|
|
});
|
|
|
|
test('uses the community lease address instead of the endpoint id', () async {
|
|
List<List<String>>? submittedTags;
|
|
|
|
await publishBuzzDevPushLease(
|
|
grant: grant,
|
|
leaseInstallationId: 'e' * 32,
|
|
descriptor: descriptor,
|
|
nsec: signer.nsec,
|
|
memberPubkey: signer.public,
|
|
subscriptions: const [],
|
|
now: () => now,
|
|
submit:
|
|
({required kind, required content, required tags, createdAt}) async {
|
|
submittedTags = tags;
|
|
return const NostrEvent(
|
|
id: 'accepted-id',
|
|
pubkey: '',
|
|
createdAt: 0,
|
|
kind: 0,
|
|
tags: [],
|
|
content: 'saved',
|
|
sig: '',
|
|
);
|
|
},
|
|
);
|
|
|
|
expect(submittedTags!.first, ['d', 'e' * 32]);
|
|
});
|
|
|
|
test('rejects a malformed community lease address', () async {
|
|
await expectLater(
|
|
publishBuzzDevPushLease(
|
|
grant: grant,
|
|
leaseInstallationId: 'malformed',
|
|
descriptor: descriptor,
|
|
nsec: signer.nsec,
|
|
memberPubkey: signer.public,
|
|
subscriptions: const [],
|
|
now: () => now,
|
|
submit:
|
|
({
|
|
required kind,
|
|
required content,
|
|
required tags,
|
|
createdAt,
|
|
}) async => throw StateError('should not publish'),
|
|
),
|
|
throwsFormatException,
|
|
);
|
|
});
|
|
|
|
test(
|
|
'mutation control rejects relay OK false then accepts restored event',
|
|
() async {
|
|
final events = <NostrEvent>[];
|
|
final acknowledgements = <List<dynamic>>[];
|
|
final session = RelaySessionNotifier();
|
|
final container = ProviderContainer(
|
|
overrides: [
|
|
relaySessionProvider.overrideWith(() => session),
|
|
authProvider.overrideWith(() => _UnauthenticatedAuthNotifier()),
|
|
],
|
|
);
|
|
await container.read(authProvider.future);
|
|
final subscription = container.listen(relaySessionProvider, (_, _) {});
|
|
addTearDown(subscription.close);
|
|
addTearDown(container.dispose);
|
|
final socket = _MutatingRelaySocket(
|
|
events,
|
|
onEvent: (event) => event.kind == 40002
|
|
? (accepted: false, message: 'invalid: kind not push-eligible')
|
|
: (accepted: true, message: 'saved'),
|
|
onAcknowledgement: acknowledgements.add,
|
|
);
|
|
session.debugAttachSocketForTest(socket);
|
|
final relayClient = SignedEventRelay(session: session, nsec: signer.nsec);
|
|
|
|
final mutated = relayClient.submit(
|
|
kind: 40002,
|
|
content: 'mutated',
|
|
tags: const [],
|
|
createdAt: 1752620000,
|
|
);
|
|
final rejection = expectLater(
|
|
mutated,
|
|
throwsA(
|
|
isA<Exception>().having(
|
|
(error) => error.toString(),
|
|
'message',
|
|
contains('invalid: kind not push-eligible'),
|
|
),
|
|
),
|
|
);
|
|
await _deliverAcknowledgement(acknowledgements, session);
|
|
await rejection;
|
|
final acceptedFuture = relayClient.submit(
|
|
kind: buzzPushLeaseKind,
|
|
content: 'restored',
|
|
tags: [
|
|
['d', 'c' * 32],
|
|
['expiration', '1755212000'],
|
|
['exec', 'relay-v1'],
|
|
],
|
|
createdAt: 1752620001,
|
|
);
|
|
await _deliverAcknowledgement(acknowledgements, session);
|
|
final accepted = await acceptedFuture;
|
|
|
|
expect(accepted.content, 'saved');
|
|
expect(events.map((event) => event.kind), [40002, buzzPushLeaseKind]);
|
|
expect(events.every((event) => event.pubkey == signer.public), isTrue);
|
|
for (final event in events) {
|
|
expect(
|
|
() => nostr.Event(
|
|
event.id,
|
|
event.pubkey,
|
|
event.createdAt,
|
|
event.kind,
|
|
event.tags,
|
|
event.content,
|
|
event.sig,
|
|
),
|
|
returnsNormally,
|
|
);
|
|
}
|
|
},
|
|
);
|
|
|
|
test('propagates relay rejection instead of accepting locally', () async {
|
|
await expectLater(
|
|
publishBuzzDevPushLease(
|
|
grant: grant,
|
|
descriptor: descriptor,
|
|
nsec: signer.nsec,
|
|
memberPubkey: signer.public,
|
|
subscriptions: [
|
|
BuzzPushSubscription(
|
|
filter: BuzzPushFilter(kinds: const [9], pTags: [signer.public]),
|
|
notificationClass: 'default',
|
|
),
|
|
],
|
|
now: () => now,
|
|
submit:
|
|
({
|
|
required kind,
|
|
required content,
|
|
required tags,
|
|
createdAt,
|
|
}) async => throw Exception('invalid: origin mismatch'),
|
|
),
|
|
throwsA(
|
|
isA<Exception>().having(
|
|
(error) => error.toString(),
|
|
'message',
|
|
contains('invalid: origin mismatch'),
|
|
),
|
|
),
|
|
);
|
|
});
|
|
|
|
test('publishes a minimal higher-generation inactive tombstone', () async {
|
|
Map<String, dynamic>? submitted;
|
|
final publication = await publishBuzzPushLeaseTombstone(
|
|
descriptor: descriptor,
|
|
installationId: grant.installationId,
|
|
generation: 3,
|
|
nsec: signer.nsec,
|
|
memberPubkey: signer.public,
|
|
now: () => now,
|
|
submit:
|
|
({required kind, required content, required tags, createdAt}) async {
|
|
submitted = {
|
|
'kind': kind,
|
|
'content': content,
|
|
'tags': tags,
|
|
'createdAt': createdAt,
|
|
};
|
|
return const NostrEvent(
|
|
id: 'tombstone-id',
|
|
pubkey: '',
|
|
createdAt: 0,
|
|
kind: 0,
|
|
tags: [],
|
|
content: 'saved',
|
|
sig: '',
|
|
);
|
|
},
|
|
);
|
|
|
|
expect(publication.eventId, 'tombstone-id');
|
|
expect(jsonDecode(publication.plaintext), {
|
|
'v': 1,
|
|
'origin': descriptor.origin,
|
|
'generation': 3,
|
|
'active': false,
|
|
});
|
|
expect(submitted!['kind'], buzzPushLeaseKind);
|
|
expect(submitted!['tags'], [
|
|
['d', grant.installationId],
|
|
['expiration', '1755212000'],
|
|
['exec', descriptor.executorKeyId],
|
|
]);
|
|
final plaintext = nip44Decrypt(
|
|
getConversationKey(relay.secret, signer.public),
|
|
submitted!['content'] as String,
|
|
);
|
|
expect(jsonDecode(plaintext), jsonDecode(publication.plaintext));
|
|
});
|
|
|
|
group('NIP-11 forward compatibility', () {
|
|
final metadata = <String, Object?>{
|
|
'read_state_snapshot': {
|
|
'version': 1,
|
|
'community_id': '00000000-0000-4000-8000-000000000001',
|
|
'max_events': 4096,
|
|
'max_event_array_bytes': 8388608,
|
|
},
|
|
'future_object': {
|
|
'nested': [1, true, null],
|
|
},
|
|
'future_array': [1, 'two'],
|
|
'future_scalar': false,
|
|
'future_null': null,
|
|
};
|
|
|
|
for (final entry in metadata.entries) {
|
|
test('ignores unrelated top-level ${entry.key}', () {
|
|
final information = _descriptorJson(relay.public)
|
|
..[entry.key] = entry.value;
|
|
final parsed = BuzzPushLeaseDescriptor.fromRelayInformation(
|
|
information,
|
|
);
|
|
expect(parsed.origin, descriptor.origin);
|
|
expect(parsed.executorPubkey, descriptor.executorPubkey);
|
|
expect(parsed.executorKeyId, descriptor.executorKeyId);
|
|
expect(parsed.transport, descriptor.transport);
|
|
expect(parsed.maxLeaseTtlSeconds, descriptor.maxLeaseTtlSeconds);
|
|
expect(parsed.maxContentLength, descriptor.maxContentLength);
|
|
expect(parsed.maxPlaintextLength, descriptor.maxPlaintextLength);
|
|
expect(parsed.maxEndpointLength, descriptor.maxEndpointLength);
|
|
expect(parsed.maxStringLength, descriptor.maxStringLength);
|
|
});
|
|
}
|
|
|
|
test('HTTP discovery accepts unrelated metadata', () async {
|
|
final information = _descriptorJson(relay.public)..addAll(metadata);
|
|
final client = MockClient((request) async {
|
|
expect(request.url, Uri.parse('https://tenant.example:8443/'));
|
|
expect(request.headers['Accept'], 'application/nostr+json');
|
|
return http.Response(jsonEncode(information), 200);
|
|
});
|
|
addTearDown(client.close);
|
|
|
|
final parsed = await fetchBuzzPushLeaseDescriptor(
|
|
'https://tenant.example:8443',
|
|
client: client,
|
|
);
|
|
expect(parsed.executorPubkey, relay.public);
|
|
expect(parsed.origin, descriptor.origin);
|
|
});
|
|
|
|
for (final field in [
|
|
'origin',
|
|
'keys',
|
|
'push_kinds',
|
|
'h_grammar',
|
|
'class_support',
|
|
'limitation',
|
|
]) {
|
|
for (final missing in [true, false]) {
|
|
test(
|
|
'${missing ? 'missing' : 'malformed'} push.$field fails with future metadata',
|
|
() {
|
|
final information = _descriptorJson(relay.public)..addAll(metadata);
|
|
final push = information['push'] as Map<String, dynamic>;
|
|
if (missing) {
|
|
push.remove(field);
|
|
} else {
|
|
push[field] = false;
|
|
}
|
|
expect(
|
|
() => BuzzPushLeaseDescriptor.fromRelayInformation(information),
|
|
throwsA(
|
|
isA<FormatException>().having(
|
|
(error) => error.message,
|
|
'rejected field',
|
|
contains(field),
|
|
),
|
|
),
|
|
);
|
|
},
|
|
);
|
|
}
|
|
}
|
|
|
|
for (final extensions in [
|
|
null,
|
|
false,
|
|
<String>[],
|
|
['nip-er'],
|
|
]) {
|
|
test('invalid extension advertisement $extensions fails', () {
|
|
final information = _descriptorJson(relay.public)
|
|
..addAll(metadata)
|
|
..['supported_extensions'] = extensions;
|
|
expect(
|
|
() => BuzzPushLeaseDescriptor.fromRelayInformation(information),
|
|
throwsA(isA<FormatException>()),
|
|
);
|
|
});
|
|
}
|
|
});
|
|
|
|
test('descriptor rejects canonical origin with a trailing slash', () {
|
|
final information = _descriptorJson(relay.public);
|
|
(information['push'] as Map<String, dynamic>)['origin'] =
|
|
'wss://tenant.example:8443/';
|
|
|
|
expect(
|
|
() => BuzzPushLeaseDescriptor.fromRelayInformation(information),
|
|
throwsA(isA<FormatException>()),
|
|
);
|
|
});
|
|
|
|
test('descriptor rejects unsupported h grammar', () {
|
|
final information = _descriptorJson(relay.public);
|
|
(information['push'] as Map<String, dynamic>)['h_grammar'] = 'opaque';
|
|
|
|
expect(
|
|
() => BuzzPushLeaseDescriptor.fromRelayInformation(information),
|
|
throwsA(isA<FormatException>()),
|
|
);
|
|
});
|
|
|
|
test('descriptor rejects unknown push fields', () {
|
|
final information = _descriptorJson(relay.public);
|
|
(information['push'] as Map<String, dynamic>)['future'] = true;
|
|
|
|
expect(
|
|
() => BuzzPushLeaseDescriptor.fromRelayInformation(information),
|
|
throwsA(isA<FormatException>()),
|
|
);
|
|
});
|
|
}
|
|
|
|
class _UnauthenticatedAuthNotifier extends AuthNotifier {
|
|
@override
|
|
Future<AuthState> build() async =>
|
|
const AuthState(status: AuthStatus.unauthenticated);
|
|
}
|
|
|
|
class _MutatingRelaySocket extends RelaySocket {
|
|
final List<NostrEvent> events;
|
|
final ({bool accepted, String message}) Function(NostrEvent event) onEvent;
|
|
final void Function(List<dynamic> message) _onAcknowledgement;
|
|
|
|
_MutatingRelaySocket(
|
|
this.events, {
|
|
required this.onEvent,
|
|
required void Function(List<dynamic> message) onAcknowledgement,
|
|
}) : _onAcknowledgement = onAcknowledgement,
|
|
super(
|
|
wsUrl: 'wss://tenant.example:8443',
|
|
nsec: null,
|
|
onMessage: _ignoreMessage,
|
|
onConnected: _ignoreConnected,
|
|
onDisconnected: _ignoreDisconnected,
|
|
);
|
|
|
|
@override
|
|
SocketState get state => SocketState.connected;
|
|
|
|
@override
|
|
void send(List<dynamic> payload) {
|
|
if (payload case ['EVENT', final Map<String, dynamic> eventJson]) {
|
|
final event = NostrEvent.fromJson(eventJson);
|
|
events.add(event);
|
|
final response = onEvent(event);
|
|
_onAcknowledgement(['OK', event.id, response.accepted, response.message]);
|
|
}
|
|
}
|
|
|
|
@override
|
|
Future<void> disconnect() async {}
|
|
|
|
@override
|
|
void dispose() {}
|
|
}
|
|
|
|
void _ignoreConnected() {}
|
|
void _ignoreDisconnected(Object? _) {}
|
|
void _ignoreMessage(List<dynamic> _) {}
|
|
|
|
Future<void> _deliverAcknowledgement(
|
|
List<List<dynamic>> acknowledgements,
|
|
RelaySessionNotifier session,
|
|
) async {
|
|
while (acknowledgements.isEmpty) {
|
|
await Future<void>.delayed(Duration.zero);
|
|
}
|
|
session.debugHandleMessage(acknowledgements.removeAt(0));
|
|
}
|
|
|
|
BuzzPushLeaseDescriptor _descriptor(String relayPubkey) =>
|
|
BuzzPushLeaseDescriptor.fromRelayInformation(_descriptorJson(relayPubkey));
|
|
|
|
Map<String, dynamic> _descriptorJson(String relayPubkey) => {
|
|
'supported_extensions': ['nip-er', 'buzz-push-v1'],
|
|
'push': {
|
|
'origin': 'wss://tenant.example:8443',
|
|
'keys': [
|
|
{'id': 'relay-v1', 'pubkey': relayPubkey, 'current': true},
|
|
],
|
|
'push_kinds': [9, 40002, 45001, 45003],
|
|
'h_grammar': 'uuid-v4-lowercase',
|
|
'class_support': {
|
|
'apns': ['default'],
|
|
},
|
|
'limitation': {
|
|
'max_lease_ttl': 2592000,
|
|
'max_leases_per_pubkey': 16,
|
|
'max_subscriptions_per_lease': 16,
|
|
'max_kinds': 16,
|
|
'max_authors': 20,
|
|
'max_h': 50,
|
|
'max_tag_values': 20,
|
|
'max_ignore': 8,
|
|
'max_content_len': 65536,
|
|
'max_plaintext_len': 32768,
|
|
'max_endpoint_len': 4096,
|
|
'max_string_len': 512,
|
|
},
|
|
},
|
|
};
|
|
|
|
BuzzPushEndpointGrant _grant(String relayPubkey) => BuzzPushEndpointGrant(
|
|
relayOrigin: 'wss://tenant.example:8443',
|
|
relayPubkey: relayPubkey,
|
|
installationId: 'c' * 32,
|
|
endpointGrant: 'opaque-grant',
|
|
endpointHash: 'd' * 64,
|
|
endpointEpoch: 1,
|
|
generation: 1,
|
|
expiresAt: 1756212000,
|
|
);
|