Files
buzz/crates/buzz-admin/tests/postgres_user_inventory.rs
Logan Johnson 700e690193 feat(db): enforce unique listed channel names with an index (#8787)
## Summary

Stacked on https://github.com/block/buzz/pull/8782 (merged), which makes
the relay refuse a second open channel with a name that another channel
in the community already has. That check lives in relay code, so an
older relay, a direct database write or a missed code path can still
create a duplicate.

This PR adds the same rule to the database: a unique index on channel
name, ignoring case, for the channels that show in the channel list.
With the index in place, a duplicate fails at the write, whatever wrote
it. The relay's own name check from
https://github.com/block/buzz/pull/8782 is no longer needed, so this PR
removes it. Clients still get the same refusal, `invalid: an open
channel named "…" already exists`.

The migration builds the index itself, also on a populated `channels`
table, so an auto-migrating relay upgrades with no operator index step
(the rule from https://github.com/block/buzz/pull/8802). It still
refuses to run while duplicate names remain, because the index cannot
exist over them. `docs/channel-name-uniqueness-deployment.md` gives the
full rollout.

## Details

- **The index** (migration `0083_channels_listed_name_unique.sql`):
  ```sql
  CREATE UNIQUE INDEX idx_channels_listed_name
      ON public.channels (community_id, lower(name))
      WHERE visibility = 'open' AND NOT unlisted
        AND channel_type IN ('stream', 'forum') AND deleted_at IS NULL;
  ```
It covers open, not unlisted streams and forums that are not deleted,
archived ones included. Private channels, DMs and unlisted channels may
still repeat names.
- **The migration builds the index inline, as `0049` does.** When
`to_regclass` finds no index, it runs a plain `CREATE UNIQUE INDEX`
under `lock_timeout` 1s and `statement_timeout` 5s. On a busy or very
large table it fails on those budgets, records nothing, and the relay
retries at its next start. When the index already exists (a concurrent
prebuild), it skips `CREATE` so it never requests the write-blocking
lock. In both cases it then checks that the index is valid, ready and
has the exact expected definition.
- **One refusal stays: duplicate names.** The migration refuses to run
while listed duplicates remain, and its error names the rename script.
The renames must go through the relay so clients get the new kind:39000,
and a migration must not change rows (`docs/database.md` Rule 3). This
is the "fails closed until its repair has run" case in
`migrations/AGENTS.md`, so the writer release from
https://github.com/block/buzz/pull/8782 and the rename are a required
stop.
- **Relay.** A write that takes the name of a concurrent, uncommitted
write waits for it, and fails if that write commits. So the post-write
check and the per-name lock from https://github.com/block/buzz/pull/8782
are removed. The store already maps the index violation to the same
"name taken" error.
- **Desired-state schema.** `schema/tables/public/channels.sql` has the
same index, and the schema parity test compares its live shape between
the desired-state schema and the migrations.
- **Rollout** (`docs/channel-name-uniqueness-deployment.md`), in order:
1. Deploy https://github.com/block/buzz/pull/8782 and wait until no
older relay pod serves.
2. Rename the existing duplicates in each community with that PR's
script, while relays keep serving. The script needs `psql` and
`python3`, and the operator key must be a member of each community. The
doc covers archived communities and communities being deleted.
  3. Confirm that no duplicate remains.
4. Only for a deployment that migrates out of band and is too large for
the budgets: build the index with `CREATE UNIQUE INDEX CONCURRENTLY` and
verify it.
5. Deploy this release. With auto-migration on, the relay applies 0083
at startup. With it off, run `buzz-admin migrate` first, never the file
through `psql`.

Rollback goes to the https://github.com/block/buzz/pull/8782 release
only. Keep the index, and keep auto-migration off.
- **Test fixtures.** Tests that inserted two open channels with one name
now use distinct names. Tests that migrate a populated database through
0083 no longer prebuild the index.

### Related issue

None found. Follows https://github.com/block/buzz/pull/8782.

### Testing

- Migration tests (`listed_channel_name_postgres_tests.rs`) start from a
database migrated through 0082:
  - With duplicates, 0083 fails and changes nothing.
- After the rename plan is applied, a channel writer that holds its lock
makes the inline build fail on the 1s lock budget, with nothing
recorded.
- With no writer, the populated table migrates with no prebuild, and a
raw duplicate insert fails on the index.
- An index with a different definition, and an invalid one, are refused.
A valid prebuilt index is accepted, and not replaced, while another
transaction is writing to `channels`.
- The store and relay name tests from
https://github.com/block/buzz/pull/8782 pass with the relay check
removed: the index refuses the duplicate, and the client still gets
`invalid:`.
- The rename plan and script tests from
https://github.com/block/buzz/pull/8782 run on a database at 0082, the
state the script runs in.
- Local Postgres runs on `108737dc0`, one fresh database per test as the
nextest wrapper does: 38 of 40 buzz-db migration-lane tests pass (both
listed-name tests, the migration parity test, the thread-window and
invite-upgrade tests that migrate populated databases through 0083). The
2 `event_follow_up` contract tests fail locally the same way on main.
All 49 buzz-db channel and channel-member store tests pass.

### Database review checklist

- [x] Phase: contract. Before it:
https://github.com/block/buzz/pull/8782 (writer release, required stop)
and its rename script. Nothing after it.
- [x] No trigger, function, procedure, rule or foreign key.
- [x] No migration mutates rows. The renames happen before it, through
the relay, with the script in https://github.com/block/buzz/pull/8782.
- [x] Never refuses a table because it has rows. Fails closed only with
duplicates (repair not run) or with an invalid or different index; then
0083 raises and the relay does not start. The release notes must name
the release that contains https://github.com/block/buzz/pull/8782 as a
required stop.
- [x] Rule 4: `migrations/`, `schema/tables/public/channels.sql` and the
parity test. A live catalog comparison covers the index.
- [x] Deployed relay: the https://github.com/block/buzz/pull/8782 relay
answers `invalid:` beside the index (its tests pass with the index
present). A relay older than that still writes, but gets a database
error, not `invalid:`, for a duplicate. That is why
https://github.com/block/buzz/pull/8782 is a required stop.
- [x] Timeouts and index build: `lock_timeout` 1s, `statement_timeout`
5s. The migration builds the index inline (plain `CREATE UNIQUE INDEX`,
skipped when `to_regclass` finds a prebuilt one). Only out-of-band
deployments too large for the budgets prebuild it with `CREATE UNIQUE
INDEX CONCURRENTLY` (doc step 4).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Signed-off-by: Logan Johnson <loganj@squareup.com>
Co-authored-by: Larry <627498bd4bd1f281a16431e3c6cce3b5c25b6692798c78672298aefbf2f8f8b5@buzz.block.builderlab.xyz>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-04 22:47:23 -05:00

395 lines
14 KiB
Rust

//! Exercise the real CLI with SELECT-only access and no workflow tables.
use nostr::ToBech32;
use serde_json::Value;
use sqlx::PgPool;
use tokio::process::Command;
use url::Url;
use uuid::Uuid;
fn admin_binary() -> std::ffi::OsString {
// Nextest relocates binaries when extracting an archive. Cargo's build-time
// path remains the fallback for local cargo test runs.
std::env::var_os("NEXTEST_BIN_EXE_buzz_admin")
.unwrap_or_else(|| env!("CARGO_BIN_EXE_buzz-admin").into())
}
#[tokio::test]
#[ignore = "requires Postgres"]
async fn cluster_global_inventory_cli_uses_only_existing_membership_tables() {
let database_url = std::env::var("BUZZ_TEST_DATABASE_URL")
.or_else(|_| std::env::var("DATABASE_URL"))
.unwrap();
let pool = PgPool::connect(&database_url).await.unwrap();
// All interpolated identifiers are this fixed prefix plus generated hex.
let name = format!("inventory_{}", Uuid::new_v4().simple());
let mut tx = pool.begin().await.unwrap();
sqlx::raw_sql(sqlx::AssertSqlSafe(format!(
"CREATE SCHEMA {name}; SET LOCAL search_path TO {name}, public;"
)))
.execute(&mut *tx)
.await
.unwrap();
// These are existing deployed tables. No entity_deletion_* schema is needed.
sqlx::raw_sql(include_str!(
"../../../schema/tables/public/communities.sql"
))
.execute(&mut *tx)
.await
.unwrap();
sqlx::raw_sql(include_str!(
"../../../schema/tables/public/relay_members.sql"
))
.execute(&mut *tx)
.await
.unwrap();
for schema in [
include_str!("../../../schema/tables/public/channels.sql"),
include_str!("../../../schema/tables/public/channel_members.sql"),
] {
sqlx::raw_sql(schema).execute(&mut *tx).await.unwrap();
}
let pubkey = "5e4083a7a793d02575876eaf47932b4835999f5af2653d26250a909b450da7c9";
let community = Uuid::new_v4();
sqlx::query("INSERT INTO communities (id, host) VALUES ($1, 'inventory-cli.example')")
.bind(community)
.execute(&mut *tx)
.await
.unwrap();
sqlx::query("INSERT INTO relay_members (community_id, pubkey, role) VALUES ($1, $2, 'member')")
.bind(community)
.bind(pubkey)
.execute(&mut *tx)
.await
.unwrap();
let participant_community = Uuid::new_v4();
sqlx::query("INSERT INTO communities (id, host) VALUES ($1, 'channel-only-cli.example')")
.bind(participant_community)
.execute(&mut *tx)
.await
.unwrap();
for target in [community, participant_community] {
for _ in 0..2 {
let channel = Uuid::new_v4();
sqlx::query("INSERT INTO channels (community_id, id, name, created_by) VALUES ($1, $2, 'inventory-test-' || $2::uuid::text, decode($3, 'hex'))")
.bind(target).bind(channel).bind(pubkey).execute(&mut *tx).await.unwrap();
sqlx::query("INSERT INTO channel_members (community_id, channel_id, pubkey) VALUES ($1, $2, decode($3, 'hex'))")
.bind(target).bind(channel).bind(pubkey).execute(&mut *tx).await.unwrap();
}
}
sqlx::raw_sql(sqlx::AssertSqlSafe(format!(
"CREATE ROLE {name} LOGIN PASSWORD 'inventory-local-fixture'; \
GRANT USAGE ON SCHEMA {name} TO {name}; \
GRANT SELECT ON ALL TABLES IN SCHEMA {name} TO {name};"
)))
.execute(&mut *tx)
.await
.unwrap();
tx.commit().await.unwrap();
let mut reader_url = Url::parse(&database_url).unwrap();
reader_url.set_username(&name).unwrap();
reader_url
.set_password(Some("inventory-local-fixture"))
.unwrap();
reader_url
.query_pairs_mut()
.append_pair("options", &format!("-csearch_path={name}"));
let npub = nostr::PublicKey::parse(pubkey)
.unwrap()
.to_bech32()
.unwrap();
let mut outputs = Vec::new();
for input in [pubkey, npub.as_str()] {
outputs.push(
tokio::time::timeout(
std::time::Duration::from_secs(15),
Command::new(admin_binary())
.args(["user-deletions", "inventory", "--pubkey", input])
.env("DATABASE_URL", reader_url.as_str())
.kill_on_drop(true)
.output(),
)
.await
.unwrap()
.unwrap(),
);
}
let demo = Command::new(admin_binary())
.args(["user-deletions", "inventory"])
.env("DATABASE_URL", reader_url.as_str())
.kill_on_drop(true)
.output()
.await
.unwrap();
// Clean cluster-wide role state before asserting the subprocess results.
sqlx::raw_sql(sqlx::AssertSqlSafe(format!(
"DROP SCHEMA {name} CASCADE; DROP OWNED BY {name}; DROP ROLE {name};"
)))
.execute(&pool)
.await
.unwrap();
let inventories: Vec<Value> = outputs
.into_iter()
.map(|output| {
assert!(
output.status.success(),
"{}",
String::from_utf8_lossy(&output.stderr)
);
serde_json::from_slice(&output.stdout).unwrap()
})
.collect();
assert_eq!(inventories[0], inventories[1]);
assert!(
demo.status.success(),
"{}",
String::from_utf8_lossy(&demo.stderr)
);
let demo: Value = serde_json::from_slice(&demo.stdout).unwrap();
assert_eq!(
demo,
serde_json::json!({
"communities": [
{"community_id": "00000000-0000-0000-0000-00000000000b", "label": "demo:community-b", "relationship": "participant"},
{"community_id": "00000000-0000-0000-0000-00000000000c", "label": "demo:community-c", "relationship": "former_participant"}
]
})
);
let inventory = &inventories[0];
assert_eq!(inventory.as_object().unwrap().len(), 1);
assert_eq!(demo.as_object().unwrap().len(), 1);
let communities = inventory["communities"].as_array().unwrap();
assert_eq!(communities.len(), 2);
let explicit_member = communities
.iter()
.find(|item| item["community_id"] == community.to_string())
.unwrap();
assert_eq!(explicit_member["label"], "inventory-cli.example");
assert_eq!(explicit_member["relationship"], "participant");
let participant = communities
.iter()
.find(|item| item["community_id"] == participant_community.to_string())
.unwrap();
assert_eq!(participant["label"], "channel-only-cli.example");
assert_eq!(participant["relationship"], "participant");
for output in [&demo, inventory] {
for row in output["communities"].as_array().unwrap() {
assert_eq!(row.as_object().unwrap().len(), 3);
}
}
}
#[test]
fn invalid_inventory_key_fails_before_database_connection() {
let output = std::process::Command::new(admin_binary())
.args(["user-deletions", "inventory", "--pubkey", "invalid-npub"])
.env_remove("DATABASE_URL")
.output()
.unwrap();
assert_eq!(output.status.code(), Some(2));
assert!(output.stdout.is_empty());
assert!(String::from_utf8_lossy(&output.stderr)
.contains("expected a 64-character hex public key or an npub"));
}
async fn workflow_cli(url: &str, args: &[&str], success: bool) -> Value {
let output = tokio::time::timeout(
std::time::Duration::from_secs(20),
Command::new(admin_binary())
.arg("user-deletions")
.args(args)
.env("DATABASE_URL", url)
.env("BUZZ_DB_POOL_SIZE", "1")
.kill_on_drop(true)
.output(),
)
.await
.unwrap()
.unwrap();
assert_eq!(
output.status.success(),
success,
"{args:?}: {}",
String::from_utf8_lossy(&output.stderr)
);
if success {
serde_json::from_slice(&output.stdout).unwrap()
} else {
Value::Null
}
}
#[tokio::test]
#[ignore = "requires Postgres"]
async fn inventory_submission_runs_demo_and_public_key_workflows_end_to_end() {
let url = std::env::var("BUZZ_TEST_DATABASE_URL").unwrap();
let pool = PgPool::connect(&url).await.unwrap();
let key = "ab".repeat(32);
let npub = nostr::PublicKey::parse(&key).unwrap().to_bech32().unwrap();
let community = Uuid::new_v4();
let channel = Uuid::new_v4();
sqlx::query("INSERT INTO communities (id, host) VALUES ($1, 'workflow-fixture.example')")
.bind(community)
.execute(&pool)
.await
.unwrap();
sqlx::query("INSERT INTO channels (community_id, id, name, created_by) VALUES ($1, $2, 'fixture', decode($3, 'hex'))")
.bind(community).bind(channel).bind(&key).execute(&pool).await.unwrap();
sqlx::query("INSERT INTO channel_members (community_id, channel_id, pubkey) VALUES ($1, $2, decode($3, 'hex'))")
.bind(community).bind(channel).bind(&key).execute(&pool).await.unwrap();
for subject in ["demo", npub.as_str()] {
let preview = workflow_cli(&url, &["inventory", "--pubkey", subject], true).await;
let saved = workflow_cli(
&url,
&[
"submit",
"--pubkey",
subject,
"--requested-by",
"operator-a",
],
true,
)
.await;
assert_eq!(saved["inventory_manifest"], preview);
assert_eq!(
saved["target"],
if subject == "demo" {
"demo:default"
} else {
&key
}
);
assert_eq!(saved["status"], "inventoried");
let id = saved["id"].as_str().unwrap();
workflow_cli(&url, &["run", id], false).await;
workflow_cli(
&url,
&[
"approve",
id,
"--approved-by",
"operator-b",
"--inventory-digest",
"wrong",
],
false,
)
.await;
let approved = workflow_cli(
&url,
&[
"approve",
id,
"--approved-by",
"operator-b",
"--inventory-digest",
saved["inventory_digest"].as_str().unwrap(),
],
true,
)
.await;
assert!(approved["stage_history"].as_array().unwrap().is_empty());
let stepped = workflow_cli(&url, &["run", id, "--next-step"], true).await;
assert_eq!(stepped["stage_history"][0]["status"], "completed");
let first_id = stepped["stage_history"][0]["id"].clone();
let done = workflow_cli(&url, &["run", id], true).await;
assert_eq!(done["status"], "completed");
assert_eq!(done["stage_history"][0]["id"], first_id);
let stages = done["stage_history"].as_array().unwrap();
assert_eq!(stages.len(), if subject == "demo" { 5 } else { 3 });
assert!(stages
.iter()
.all(|s| s["status"] == "completed" && s["is_current"] == false));
let inspected = workflow_cli(&url, &["inspect", id], true).await;
assert_eq!(inspected, done);
// Hex and npub converge on the same saved request without rediscovery.
let repeat = workflow_cli(
&url,
&[
"submit",
"--pubkey",
if subject == "demo" { "demo" } else { &key },
"--requested-by",
"operator-a",
],
true,
)
.await;
for (field, value) in repeat.as_object().unwrap() {
assert_eq!(value, &done[field]);
}
workflow_cli(
&url,
&[
"submit",
"--pubkey",
subject,
"--requested-by",
"someone-else",
],
false,
)
.await;
}
// Real membership data remains unchanged after all dummy handlers execute.
let count: i64 = sqlx::query_scalar("SELECT count(*) FROM channel_members WHERE community_id = $1 AND pubkey = decode($2, 'hex')")
.bind(community).bind(&key).fetch_one(&pool).await.unwrap();
assert_eq!(count, 1);
}
#[tokio::test]
#[ignore = "requires Postgres"]
async fn inventory_approval_and_resume_use_saved_account_identity_without_resolution() {
let url = std::env::var("BUZZ_TEST_DATABASE_URL").unwrap();
let pool = PgPool::connect(&url).await.unwrap();
let saved = workflow_cli(
&url,
&[
"submit",
"--target",
"demo:resolved-account",
"--requested-by",
"operator-a",
],
true,
)
.await;
let id = saved["id"].as_str().unwrap();
// Model the output of a future account resolver. This is not CLI support
// for resolving account IDs: the inventory is already saved and complete.
let account = "builderlab:account-123";
sqlx::query("UPDATE entity_deletion_requests SET target = $2 WHERE id = $1")
.bind(Uuid::parse_str(id).unwrap())
.bind(account)
.execute(&pool)
.await
.unwrap();
workflow_cli(
&url,
&[
"approve",
id,
"--approved-by",
"operator-b",
"--inventory-digest",
saved["inventory_digest"].as_str().unwrap(),
],
true,
)
.await;
let stepped = workflow_cli(&url, &["run", id, "--next-step"], true).await;
let first_stage = stepped["stage_history"][0]["id"].clone();
let completed = workflow_cli(&url, &["run", id], true).await;
assert_eq!(completed["target"], account);
assert_eq!(completed["inventory_manifest"], saved["inventory_manifest"]);
assert_eq!(completed["status"], "completed");
assert_eq!(completed["stage_history"][0]["id"], first_stage);
for stage in completed["stage_history"].as_array().unwrap() {
assert_eq!(stage["metadata_json"]["inputs"]["target"], account);
assert_eq!(stage["status"], "completed");
}
}