mirror of
https://github.com/block/buzz.git
synced 2026-11-10 19:32:00 +00:00
The mobile app can now be built as a public build or an internal build, set explicitly with `BUZZ_DISTRIBUTION=internal|public`. Each build trusts exactly one Builderlab (`BUZZ_BUILDERLAB_URL`), and sends that Builderlab's relay assertions only to the relays in `BUZZ_BUILDERLAB_RELAYS`. The three settings are set together or not at all; with none set, the app is a Nostr-only development build. The decision is recorded in `docs/adr/0001-internal-and-public-mobile-builds.md`, and the terms are defined in `CONTEXT.md`. Before this change, one build supported a public Builderlab and an organization Builderlab at the same time, with two sessions. An organization's members could reach public communities from the organization's app. ### Behavior - **Public build:** QR pairing, email sign-in and multiple communities are unchanged. It has no knowledge of any organization. An organization's relay already rejects clients that can't present its Builderlab's assertion, and the public build relies on that. - **Internal build:** the first screen has a single **Sign in** button that goes straight to the organization's single sign-on and then joins the organization's community. There is no QR pairing, community link or community creation, and the community switcher is hidden. Only the exact relay hosts listed in `BUZZ_BUILDERLAB_RELAYS` are reachable. - **Identity (internal):** a member whose account has no Nostr identity yet gets a new key on first sign-in; the first relay assertion binds it, and the app backs it up to the organization automatically. A member whose account is already bound uses that key from this device, or restores it from the organization's backup. If neither is possible, Sign in says it couldn't restore the identity and saves nothing. - **Sign-out (internal):** a destructive **Sign out** row at the bottom of Settings, the build's only way out. It removes the community, closes Settings and returns to Sign in. The Builderlab session is cleared from storage immediately and can never be reused to sign back in. The relay push-stop keeps the retired credential in memory only, for up to 10 minutes, and uses it only to get an assertion for a key that is already bound. It is a best-effort request. - **Upgrade to an internal build:** a saved public Builderlab session is cleared. Communities on other relays are hidden, not deleted, and their keys stay on the device. - `BUZZ_HOSTED_RELAY_AUTH` is unchanged here. ### Screenshots (internal build) | Sign in | Community menu | Settings | | --- | --- | --- | |  |  |  | Gateway-side push revocation, which needs no Builderlab session, is planned as a separate PR. ### Validation Added tests: - An internal-build journey: one Sign in creates and binds a key, and a retry after a cancelled join reuses it. The app uploads that key's backup itself. Sign out from Settings closes it and returns to the landing, which ends the session, and Sign in then restores the same identity from the backup. Communities on other relays stay stored but hidden. - Internal Sign in for a bound account: the key on this device, a key restored from backup, and no backup (clear error, nothing saved). Each guard was shown to fail when removed. - Organization relay assertions: assertions go only to exact listed hosts, not subdomains. After sign-out, only a push stop for a bound key gets an assertion, and nothing can sign back in. Proven to fail without the fix. - Builderlab build setting parsing. CI runs the internal and public journeys in their own lanes with those settings. The full suite passes in the default configuration. The full suite isn't meant to run under the internal configuration, because most fixtures use relays that an internal build hides. Automated full-app run on an iPhone 17 Pro simulator at the current head: - Public build, upgraded in place over a signed-in install: home loads, a channel opens and a message sends. - Internal build: a fresh install shows only Sign in. With a saved organization community, the community menu has no Switch community, and Settings → Sign out → confirm returns to Sign in. Real single sign-on can't run in the simulator. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Signed-off-by: Tom Brow <tomb@squareup.com> Co-authored-by: Tom Brow <tomb@squareup.com> Co-authored-by: studio <dc2fc481343672df31a689840c09299972e704dac592e0da6f18486646a7ee3e@buzz.block.builderlab.xyz> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: studio <dc2fc481343672df31a689840c09299972e704dac592e0da6f18486646a7ee3e@localhost>
147 lines
4.9 KiB
Dart
147 lines
4.9 KiB
Dart
import 'dart:convert';
|
||
|
||
import 'package:flutter/foundation.dart';
|
||
import 'package:hooks_riverpod/hooks_riverpod.dart';
|
||
import 'package:http/http.dart' as http;
|
||
|
||
import '../../shared/deeplink/deep_link.dart';
|
||
import '../../shared/hosted/hosted_environment.dart';
|
||
import '../../shared/utils/bounded_fetch.dart';
|
||
import 'agent_avatar_picker.dart';
|
||
|
||
/// Creates the HTTP client that fetches a card's `agent.json`; overridden in
|
||
/// tests.
|
||
final agentCardClientProvider = Provider<http.Client Function()>(
|
||
(ref) => http.Client.new,
|
||
);
|
||
|
||
/// Largest `agent.json` accepted, far above any real card.
|
||
const maxAgentCardBytes = 2 * 1024 * 1024;
|
||
|
||
/// Why a card's draft could not be loaded, worded for the user.
|
||
class AgentCardException implements Exception {
|
||
const AgentCardException(this.message);
|
||
|
||
final String message;
|
||
|
||
@override
|
||
String toString() => 'AgentCardException: $message';
|
||
}
|
||
|
||
/// Initial, fully editable values for [CreateAgentPage], from a link.
|
||
///
|
||
/// Unlike an unfinished setup in `RemoteAgentController.pending`, a draft has
|
||
/// created nothing: every field stays editable and nothing is persisted.
|
||
class AgentCreationDraft {
|
||
const AgentCreationDraft({
|
||
required this.name,
|
||
required this.instructions,
|
||
this.avatar,
|
||
this.modelId,
|
||
this.reasoningEffort,
|
||
});
|
||
|
||
final String name;
|
||
final String instructions;
|
||
|
||
/// Card avatar, or null to let the form pick its usual default.
|
||
final AgentAvatarSelection? avatar;
|
||
|
||
/// Requested model, applied only if the live catalog lists it.
|
||
final String? modelId;
|
||
|
||
/// Requested effort, applied only if the chosen model supports it.
|
||
final String? reasoningEffort;
|
||
|
||
/// Fetches [link]'s card from this build's avatars CDN and reads its draft.
|
||
static Future<AgentCreationDraft> fetch(
|
||
AgentCreationDeepLink link,
|
||
http.Client client,
|
||
) async {
|
||
final cdn = HostedEnvironment.avatarsCdnOrigin;
|
||
if (cdn == null) {
|
||
throw const AgentCardException(
|
||
'Agent cards aren’t available in this build.',
|
||
);
|
||
}
|
||
// The id is opaque; pathSegments percent-encodes anything path-unsafe.
|
||
final url = cdn.replace(pathSegments: [link.cardId, 'agent.json']);
|
||
final BoundedResponse response;
|
||
try {
|
||
response = await boundedGet(
|
||
client,
|
||
url,
|
||
maxBytes: maxAgentCardBytes,
|
||
headers: const {'accept': 'application/json'},
|
||
// A redirect could lead off the CDN; treat it as unavailable.
|
||
followRedirects: false,
|
||
);
|
||
} on ResponseTooLargeException {
|
||
throw const AgentCardException('This agent card is too large.');
|
||
} on Exception {
|
||
throw const AgentCardException(
|
||
'Couldn’t load this agent card. Check your connection and reopen the '
|
||
'link.',
|
||
);
|
||
}
|
||
if (response.statusCode == 403 || response.statusCode == 404) {
|
||
throw const AgentCardException('This agent card isn’t available.');
|
||
}
|
||
if (response.statusCode != 200) {
|
||
debugPrint('agents: agent card HTTP ${response.statusCode}');
|
||
throw const AgentCardException(
|
||
'Couldn’t load this agent card. Try again later.',
|
||
);
|
||
}
|
||
final Object? json;
|
||
try {
|
||
json = jsonDecode(utf8.decode(response.bytes));
|
||
} on FormatException {
|
||
throw const AgentCardException('This agent card is invalid.');
|
||
}
|
||
if (json is! Map<String, dynamic>) {
|
||
throw const AgentCardException('This agent card is invalid.');
|
||
}
|
||
return parseAgentCard(json, link.cardId);
|
||
}
|
||
|
||
/// Reads a card's draft from its `agent.json`. `id` (matching [cardId]),
|
||
/// `name` and `avatarUrl` (an https URL) are required; `instructions`,
|
||
/// `model` and `reasoningEffort` are optional and left for the user when
|
||
/// absent or blank. A missing required field, or a known field of the wrong
|
||
/// type, makes the card invalid. Any other key, including `v` and
|
||
/// `description` (agents have no description to prefill), is ignored
|
||
/// whatever its type, so Builderlab can add fields without breaking
|
||
/// released apps.
|
||
static AgentCreationDraft parseAgentCard(
|
||
Map<String, dynamic> json,
|
||
String cardId,
|
||
) {
|
||
const invalid = AgentCardException('This agent card is invalid.');
|
||
if (json['id'] != cardId) throw invalid;
|
||
final name = json['name'];
|
||
final avatarUrl = json['avatarUrl'];
|
||
if (name is! String || name.trim().isEmpty || avatarUrl is! String) {
|
||
throw invalid;
|
||
}
|
||
final avatar = Uri.tryParse(avatarUrl);
|
||
if (avatar == null || avatar.scheme != 'https' || avatar.host.isEmpty) {
|
||
throw invalid;
|
||
}
|
||
String? optional(String key) {
|
||
final value = json[key];
|
||
if (value != null && value is! String) throw invalid;
|
||
final text = (value as String?)?.trim();
|
||
return text == null || text.isEmpty ? null : text;
|
||
}
|
||
|
||
return AgentCreationDraft(
|
||
name: name.trim(),
|
||
instructions: optional('instructions') ?? '',
|
||
avatar: AgentAvatarSelection.url(avatarUrl),
|
||
modelId: optional('model'),
|
||
reasoningEffort: optional('reasoningEffort'),
|
||
);
|
||
}
|
||
}
|