External/buzz

Fork 0

mirror of https://github.com/block/buzz.git synced 2026-08-18 06:50:31 +02:00

Files

T

Will PflegerandGitHub 3b78dc5690 feat(mobile+desktop): two-tier Slack-style app icon badge (#802 )

2026-06-03 18:16:49 -07:00

19 KiB

Raw Permalink Blame History

AGENTS.md — AI Agent Contributor Guide

This guide is for AI agents contributing to the Sprout codebase. It covers agent-specific context and conventions. For general contributor info (setup, code style, PR process, architecture), see CONTRIBUTING.md.

Ecosystem

Sprout spans five repos. This one (block/sprout) is the OSS source for the relay, desktop, mobile, and CLI. The others handle internal builds and deployment:

Repo	Purpose
block/sprout	OSS source — relay, desktop app, mobile app, CLI, agent harness
squareup/sprout-releases	Buildkite pipeline producing Block-signed macOS + iOS builds with `-block` version suffix
squareup/sprout-oss	CI pipeline building the relay Docker image and pushing to internal ECR
squareup/block-coder-tf-stacks	Terraform + ArgoCD deploying the relay to the staging Kubernetes cluster
squareup/sprout-backend-blox	Desktop backend provider script connecting Blox workstation agents to the relay

block/sprout (source)
  ├─► sprout-releases    (desktop + mobile builds → Artifactory, GitHub, Mobile Releases)
  ├─► sprout-oss         (relay Docker image → ECR)
  │     └─► block-coder-tf-stacks  (Helm chart → ArgoCD → staging cluster)
  └─── sprout-backend-blox         (Blox compute provider for Desktop agent launch)

See RELEASING.md for the desktop release flow across block/sprout and sprout-releases.

Repo Structure

crates/
  # Relay + core
  sprout-relay        # WebSocket relay server — main entry point; also hosts git + huddle audio
  sprout-core         # Core types, event verification, filter matching, kind registry
  sprout-db           # Postgres event store and data access layer
  sprout-auth         # Authentication and authorization
  sprout-pubsub       # Redis pub/sub fan-out, presence, typing indicators
  sprout-search       # Typesense-backed full-text search
  sprout-audit        # Hash-chain audit log
  sprout-media        # Blossom/S3 media storage
  # Agent surface
  sprout-mcp          # MCP server providing AI agent tools (being phased out in favor of the CLI)
  sprout-acp          # ACP harness bridging Sprout events to AI agents
  sprout-agent        # Minimal ACP-compliant agent (non-streaming, tool-calls-as-output)
  sprout-dev-mcp      # Developer MCP server — shell + file-edit tools
  sprout-persona      # Agent persona packs
  sprout-workflow     # YAML-as-code workflow engine (evalexpr conditions)
  # Clients + interop
  sprout-proxy        # Nostr client compatibility proxy (NIP-28)
  sprout-pair-relay   # Ephemeral sidecar relay for NIP-AB device pairing
  sprout-pairing-cli  # CLI for NIP-AB device pairing interop testing
  git-sign-nostr      # Sign git objects with a Nostr key
  git-credential-nostr # Git credential helper for Nostr-authed push/fetch
  # Tooling + shared
  sprout-cli          # Agent-first CLI
  sprout-sdk          # Typed Nostr event builders
  sprout-admin        # Operator CLI for relay administration
  sprout-test-client  # Integration test client and E2E test suite
  sprig               # All-in-one harness bundling ACP, agent, and dev MCP

desktop/              # Tauri 2 + React 19 desktop app
web/                  # Browser web client (repo browser, served by the relay)
mobile/               # Flutter mobile app
migrations/           # SQL migrations (auto-applied on relay startup)
scripts/              # Dev tooling
.env.example          # Config template — copy to .env before running

Getting Started

. ./bin/activate-hermit   # activate hermit toolchain (Rust, Node, etc.)
cp .env.example .env      # configure local environment
just setup                # install deps, run migrations
just relay                # start relay at ws://localhost:3000
just ci                   # run before any PR

See CONTRIBUTING.md for full setup details and dependency requirements.

Quality Gates

Run just ci before every PR — it runs fmt + clippy + desktop lint + unit tests + builds. Clippy passing does not mean fmt passes; run both.

Run just test for integration tests if you touched sprout-relay, sprout-db, or sprout-auth — these require a running Postgres and Redis.

Pre-commit hooks are installed automatically by just setup and auto-fix formatting via stage_fixed. Pre-commit runs fix variants in parallel (Rust fmt, Tauri Rust fmt, desktop biome fix, web biome fix, mobile dart format). Auto-fixable issues are fixed and re-staged; unfixable lint issues block the commit. Pre-push hooks run clippy (workspace + Tauri) and fast unit tests in parallel (Rust, desktop JS, Tauri Rust, mobile Flutter) — no overlap with pre-commit. Builds are CI-only. Run just fix-all to auto-fix all formatting in one shot. Run just ci for the full local gate. Run just hooks to re-install hooks after env changes.

Additional rules:

No unsafe code
Do not introduce new unwrap() or expect() in production paths — use ? and proper error types
New public API must have doc comments

Key Patterns

Dual API surface: Sprout exposes both a REST API and a NIP-29 WebSocket relay. Both paths converge on shared DB functions in sprout-db. When adding a feature, implement the shared DB logic first, then wire up both surfaces.

Prefer Nostr events over new REST endpoints: For new feature work, model the operation as a Nostr event (new kind in sprout-core/src/kind.rs, handler in sprout-relay) rather than adding a new REST endpoint. REST is reserved for things that genuinely need an HTTP-only surface: media upload/download (Blossom), OAuth callbacks, health checks, and the existing read endpoints that proxy DB queries. Two helpful endpoints already exist and rarely need to be duplicated:

POST /events — submit any signed event (same path the WebSocket uses).
POST /query — Nostr REQ filters over HTTP. NIP-50 search filters are routed to sprout-search (Typesense-backed) automatically.
POST /count — Nostr COUNT filters over HTTP.

If you find yourself reaching for a new REST endpoint, first check whether an event kind would do the job — it usually will, and you get realtime fan-out, NIP-29 scoping, and the existing auth pipeline for free.

Reference https://github.com/nostr-protocol/nips

Event kinds: All event kind integers are defined in sprout-core/src/kind.rs. New features get new kind integers — add them here first, then implement handling in the relay.

Channel scoping: Channels use h tags (NIP-29 group tag), not e tags. Filters and queries must scope to h tags when operating within a channel.

Agent-facing operations go in sprout-cli, not sprout-mcp: sprout-mcp is being phased out. New agent-facing features belong in sprout-cli — add a subcommand there first, then wire the REST/WebSocket call in client.rs. Do not add new tools to sprout-mcp unless specifically required for backward compatibility. sprout-dev-mcp (shell + file tools for sprout-agent) is separate and not being phased out.

Workflow conditions: sprout-workflow uses evalexpr for condition evaluation. Keep expressions simple and testable.

Thread counters: reply_count and descendant_count are materialized on thread root events. Any code that inserts replies must update these counters — check existing reply handlers for the pattern.

Agent CLI (`sprout-cli`)

sprout is the agent-first CLI replacing sprout-mcp. Auth env vars (SPROUT_RELAY_URL, SPROUT_PRIVATE_KEY, SPROUT_AUTH_TAG) are auto-injected by the ACP harness into managed agent subprocesses. In development, set SPROUT_PRIVATE_KEY and SPROUT_RELAY_URL in your environment manually.

Building the CLI

cargo build --release -p sprout-cli

Binary location: ./target/release/sprout. Add ./target/release to PATH or invoke with the full path.

Deep Links

sprout://message?channel=<uuid>&id=<hex> links reference a specific message thread. To read the linked thread:

sprout messages thread --channel <uuid> --event <hex> --format compact

Extract channel and id from the URL query parameters. The optional thread parameter (root event ID) can be ignored — messages thread resolves the full thread from the event ID alone.

All reads return sig-stripped JSON arrays; all writes return {event_id, accepted, message}; creates add the entity ID. Exit codes: 0=ok, 1=input error, 2=network/relay, 3=auth, 4=other, 5=write conflict (NIP-33 LWW).

--format compact is a global flag — it goes before the subcommand: sprout --format compact channels list, NOT sprout channels list --format compact.

See crates/sprout-cli/TESTING.md for the full live-testing runbook.

Testing

just test-unit    # unit tests, no infrastructure needed
just test         # full integration suite (requires Postgres + Redis)

E2E tests live in crates/sprout-test-client/tests/:

e2e_relay.rs — WebSocket relay protocol
e2e_rest_api.rs — REST endpoint coverage
e2e_mcp.rs — MCP tool surface
e2e_tokens.rs — auth token flows
e2e_workflows.rs — workflow engine
e2e_media.rs — media upload/download (Blossom)
e2e_media_extended.rs — extended media scenarios
e2e_nostr_interop.rs — Nostr interop (NIP-50 search, NIP-10 threads, NIP-17 gift wraps)

Desktop E2E: cd desktop && pnpm exec playwright test

See TESTING.md for the full multi-agent E2E guide.

Desktop Screenshots (Playwright)

The desktop app requires the E2E mock bridge to render — it cannot run in a plain browser. Use just desktop-screenshot to capture screenshots (builds frontend, starts preview server, runs Playwright automatically):

just desktop-screenshot --name home
just desktop-screenshot --name channel --route /channels/general
just desktop-screenshot --name search --click open-search
just desktop-screenshot --name settings --click open-settings

Options: --name (filename), --route (client route), --active-channel (channel to view), --click (left-click data-testid or CSS selector), --right-click (right-click for context menus), --hover (hover before capture), --clip (crop region as x,y,w,h — e.g. 0,0,256,720 for sidebar only), --wait (ms, default 2000), --viewport (WxH, default 1280x720), --outdir (default test-results/screenshots), --messages (JSON file path). Output is a PNG path on stdout.

Use --messages to inject content into a channel before capture. The JSON file is an array of objects — channelName and content are required, all other fields are optional and passed through to __SPROUT_E2E_EMIT_MOCK_MESSAGE__:

[
  {
    "channelName": "random",
    "content": "Hey @tyler check this out",
    "pubkey": "953d...",
    "kind": 40002,
    "mentionPubkeys": ["deadbeef..."],
    "extraTags": [["broadcast", "1"], ["e", "some-root-id"]],
    "parentEventId": "abc123"
  }
]

Without --active-channel, all messages must target the same channel and the helper navigates to that channel (useful for showing message content). With --active-channel, messages can target multiple channels while the "camera" stays on the specified channel (useful for unread indicators, badges, etc.).

# Messages in the channel you're viewing (code blocks, formatting, etc.)
just desktop-screenshot --name code-blocks --messages /tmp/msgs.json

# Messages in OTHER channels to trigger unread state
just desktop-screenshot --name unread-dot \
  --active-channel general --messages /tmp/badge-msgs.json

# Cropped to sidebar only (256px wide)
just desktop-screenshot --name sidebar-unread \
  --active-channel general --messages /tmp/badge-msgs.json \
  --clip 0,0,256,720

# Context menu on an unread channel (wider crop to include popup)
just desktop-screenshot --name ctx-mark-read \
  --active-channel general --messages /tmp/badge-msgs.json \
  --right-click channel-random --clip 0,200,320,300

# Hover state (e.g. copy button reveal)
just desktop-screenshot --name copy-hover \
  --messages /tmp/code-msgs.json --hover "[data-testid='copy-code']"

Available mock channels: general, random, design, sales, engineering, agents, watercooler, announcements, alice-tyler, bob-tyler.

scripts/post-screenshots.sh hosts PNGs on a per-developer orphan branch (agent-screenshots/<github-username>) and posts a PR comment:

./scripts/post-screenshots.sh 803 test-results/screenshots
./scripts/post-screenshots.sh 803 test-results/screenshots body.md  # custom body prepended

The body file supports {{filename}} placeholders (without .png) to inline images at specific positions. Images not referenced by any placeholder are appended at the end. Without placeholders, all images are appended (backward compatible).

### Unread dot
A message arrives in `#random`.

{{01-unread-dot}}

### Context menu
Right-click shows "Mark as read".

{{02-context-menu}}

Re-runs for the same PR overwrite previous images. Cleanup: git push origin --delete agent-screenshots/<username>.

Common Gotchas

Kind 39000 for channel metadata, not 41 — kind 41 is NIP-01 (unused). All kinds defined in sprout-core/src/kind.rs.
Relay queries must specify kinds — omitting kinds triggers the p-gate (403). Always include explicit kind filters.
messages search must include --kinds — an open-ended search (no kinds) hits the relay p-gate and returns 403. Pass at least --kinds 9,45001,45003 to scope the query.
Worktrees: cd in the same command — shell CWD doesn't persist between tool calls. Use cd /path && cargo build as one command.
Desktop crate excluded from root workspace — cargo test at repo root does NOT run desktop tests. Use cargo test --manifest-path desktop/src-tauri/Cargo.toml explicitly.
Desktop Tauri fmt fails in worktrees and blocks commits — the pre-commit hook runs just desktop-tauri-fmt, which fails in git worktrees because cargo fmt resolves workspace paths relative to the worktree root. Run just desktop-tauri-fmt from the main checkout to apply the fix, then re-stage and commit. CI is unaffected.

Desktop App

The desktop app is Tauri 2 + React 19 + Vite + Tailwind CSS. Features are organized under desktop/src/features/. Biome handles linting and formatting.

just desktop-dev   # web-only dev server (faster iteration)
just dev           # full Tauri app with native shell

Workspace Switching

The desktop app supports multiple workspaces (each backed by a different relay). Switching workspaces does not reload the page — it uses React key-based remounting. <AppReady key={workspaceKey} /> in App.tsx forces the entire workspace-scoped subtree to unmount and remount with fresh state.

Module-level singletons must be explicitly reset. React remounting only clears React state (useState, useRef, context). Module-level variables (Maps, class instances, cached promises) survive across remounts. Every workspace-scoped singleton needs a reset function wired into resetWorkspaceState() in desktop/src/features/workspaces/useWorkspaceInit.ts.

Current singletons that are reset on workspace switch:

relayClient.disconnect() — WebSocket teardown + promise rejection
resetMediaCaches() — proxy port and relay origin caches
clearSearchHitEventCache() — search result event cache
clearAllDrafts() — message draft cache

If you add a new module-level cache, Map, or class instance that holds workspace-scoped data, you must add its reset to resetWorkspaceState(). Failure to do so causes data from the old workspace to leak into the new one.

Key files:

desktop/src/app/App.tsx — workspace key, init gate, remount boundary
desktop/src/features/workspaces/useWorkspaceInit.ts — resetWorkspaceState(), applies config to Tauri backend
desktop/src/features/workspaces/useWorkspaces.tsx — WorkspacesProvider context (shared state for App + AppShell)
desktop/src/main.tsx — provider hierarchy (QueryClientProvider > WorkspacesProvider > App)

Mobile App (Flutter)

The mobile app lives in mobile/ — a Flutter app using Riverpod + Hooks.

Architecture

State management: Riverpod + flutter_hooks (HookConsumerWidget)
Theme: Catppuccin Latte (light) / Macchiato (dark) — matches desktop
Features: Isolated under lib/features/, shared code in lib/shared/
Nostr models: lib/shared/relay/nostr_models.dart — event kinds must stay in sync with desktop/src/shared/constants/kinds.ts

Rules

NEVER use StatefulWidget — always use HookConsumerWidget or ConsumerWidget with flutter_hooks for local state.
NEVER run flutter run, flutter build, flutter clean, or flutter upgrade — only flutter test, flutter analyze, and dart format are safe for agents to run.
Do NOT use print() — use debugPrint() or structured logging.
Prefer context.colors and context.textTheme (via theme extensions) over raw Theme.of(context) calls.
Keep widgets small and composable.
Feature modules must not import from other feature modules — only from shared/.
Use Grid tokens for spacing, Radii for border radius.

Quality Checks

cd mobile
dart format --output=none --set-exit-if-changed .
flutter analyze
flutter test

Or from repo root: just mobile-fmt (auto-fix), just mobile-check (lint + fmt check), just mobile-test (tests).

To run the app locally (starts Docker, relay, iOS simulator automatically):

just mobile-dev

Testing Conventions

Prefer widget tests over unit tests for UI components — test the whole widget tree, not individual methods.
Use ProviderScope(overrides: [...]) to inject fake notifiers.
Fake notifiers should extend the real notifier class and override build().
Use the WidgetHelpers.testable() wrapper for simple widget tests or build a custom ProviderScope + MaterialApp when you need specific overrides.

19 KiB Raw Permalink Blame History