diff --git a/AGENTS.md b/AGENTS.md index 1282a26ce..7196e7b57 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -112,7 +112,8 @@ Wire types + socket plumbing: in the path, unlike `hive-core-agent-sock`. - **`forge-client/`** — the shared Forgejo client construction (`async_client`, `sync_client`), `TimeoutPolicy`, `TokenSource`, and the one drift-tolerant - `NotificationThread`; used by `hive-forge` and `hive-forge-notify`. + `NotificationThread`; used by `hive-forge`, `hive-forge-notify`, + `swarm-controller` and `swarm-ci-metrics`. - **`hive-sock-client/`** — the shared JSON-line unix-socket client; retry is a policy value (`Retry::None` / `Retry::RideOutRestart`). Also holds the bounded request-line reader (`read_request_line`) the socket servers diff --git a/Cargo.lock b/Cargo.lock index db44c8868..f0a367588 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -5087,6 +5087,7 @@ name = "swarm-ci-metrics" version = "0.1.0" dependencies = [ "anyhow", + "forge-client", "forgejo-api", "hive-log", "reqwest", @@ -5132,6 +5133,7 @@ dependencies = [ "base64 0.22.1", "bytes", "chrono", + "forge-client", "forgejo-api", "futures-util", "getrandom 0.3.4", diff --git a/forge-client/Cargo.toml b/forge-client/Cargo.toml index 0f081a103..673fb11ed 100644 --- a/forge-client/Cargo.toml +++ b/forge-client/Cargo.toml @@ -1,6 +1,6 @@ # `forge-client` — the one place hyperhive builds a Forgejo client and -# parses a Forgejo notification. Shared by `hive-forge` (blocking CLI) and -# `hive-forge-notify` (async poller) so that forgejo-api schema drift is +# parses a Forgejo notification. Shared by `hive-forge`, `hive-forge-notify`, +# `swarm-controller` and `swarm-ci-metrics` so that forgejo-api schema drift is # handled once. [package] name = "forge-client" diff --git a/forge-client/README.md b/forge-client/README.md index 690984f8a..78b94838c 100644 --- a/forge-client/README.md +++ b/forge-client/README.md @@ -1,9 +1,9 @@ # forge-client The one place hyperhive builds a Forgejo client and reads a Forgejo -notification. `hive-forge` (the blocking CLI) and `hive-forge-notify` (the -async poller) share it, so a Forgejo schema change that `forgejo-api` does not -yet model is fixed here once. +notification. `hive-forge` (the blocking CLI), `hive-forge-notify` (the +async poller), `swarm-controller` and `swarm-ci-metrics` share it, so a Forgejo +schema change that `forgejo-api` does not yet model is fixed here once. ## When to use it diff --git a/forge-client/src/lib.rs b/forge-client/src/lib.rs index 79cbf98db..03fcdd3e9 100644 --- a/forge-client/src/lib.rs +++ b/forge-client/src/lib.rs @@ -1,5 +1,5 @@ //! Forgejo client construction, timeout policy and the drift-tolerant -//! notification thread, shared by `hive-forge` and `hive-forge-notify`. +//! notification thread, shared by every hyperhive forge consumer. //! //! Construction takes a base URL and a [`TokenSource`]; the bounds on how //! long a call may take come from a [`TimeoutPolicy`] the caller names. diff --git a/swarm-ci-metrics/Cargo.toml b/swarm-ci-metrics/Cargo.toml index 81b0ab824..46f427675 100644 --- a/swarm-ci-metrics/Cargo.toml +++ b/swarm-ci-metrics/Cargo.toml @@ -9,6 +9,8 @@ path = "src/main.rs" [dependencies] anyhow.workspace = true +# Builds the forge client, from the `ci-metrics` account token. +forge-client.workspace = true # The runs list and the repo search, as the `ci-metrics` account. forgejo-api.workspace = true hive-log.workspace = true diff --git a/swarm-ci-metrics/src/main.rs b/swarm-ci-metrics/src/main.rs index 68d8b58f4..1b23ff507 100644 --- a/swarm-ci-metrics/src/main.rs +++ b/swarm-ci-metrics/src/main.rs @@ -19,8 +19,9 @@ use std::path::{Path, PathBuf}; use std::time::Duration; use anyhow::{Context as _, Result, bail}; +use forge_client::{StaticToken, async_client}; +use forgejo_api::Forgejo; use forgejo_api::structs::{ActionRun, ListActionRunsQuery, RepoSearchQuery}; -use forgejo_api::{Auth, Forgejo}; use swarm_queue_client::{ClientSecret, QueueConfig}; use swarm_secret_client::ci_metrics::{ClientSecret as StoredClientSecret, client_secret_path}; use swarm_secret_client::client::ENV_CLIENT_CERT; @@ -84,8 +85,11 @@ async fn main() -> Result<()> { state_file: PathBuf::from(state_dir).join("cursor.json"), }; - let forge = Forgejo::new(Auth::Token(&forge_token().await?), cfg.forge_url.clone()) - .context("building the forge client")?; + let forge = async_client( + cfg.forge_url.clone(), + &StaticToken::new(forge_token().await?), + ) + .context("building the forge client")?; let http = reqwest::Client::builder() .timeout(Duration::from_secs(30)) .build() diff --git a/swarm-controller/Cargo.toml b/swarm-controller/Cargo.toml index 6167a770e..d04c6ba39 100644 --- a/swarm-controller/Cargo.toml +++ b/swarm-controller/Cargo.toml @@ -18,6 +18,8 @@ backon.workspace = true # neither, does not claim to need them. async-nats = { workspace = true, features = ["kv"] } axum.workspace = true +# Builds every forgejo-api client (`forge/`), so the construction lives once. +forge-client.workspace = true # swarm-controller's own forge client (`forge.rs`) — self-contained, # deliberately not sharing code with `hive-c0re::forge` across the crate # boundary (see #3306's design discussion: forcing that split now, over a diff --git a/swarm-controller/src/forge/agent_token.rs b/swarm-controller/src/forge/agent_token.rs index 78e75ae95..cbcb666c5 100644 --- a/swarm-controller/src/forge/agent_token.rs +++ b/swarm-controller/src/forge/agent_token.rs @@ -18,8 +18,9 @@ use std::collections::BTreeSet; use std::sync::Arc; use anyhow::{Context, Result, bail}; +use forge_client::{StaticToken, async_client}; use forgejo_api::structs::{AccessToken, CreateAccessTokenOption}; -use forgejo_api::{ApiErrorKind, Auth, Forgejo, ForgejoError}; +use forgejo_api::{ApiErrorKind, ForgejoError}; use reqwest::StatusCode; use swarm_secret_client::{client::DEFAULT_CERT_MOUNT, forge, policy}; @@ -242,7 +243,7 @@ impl Client { ) .await?; - let as_agent = Forgejo::new(Auth::Token(&credential.value), self.url.clone()) + let as_agent = async_client(self.url.clone(), &StaticToken::new(&credential.value)) .context("building a forge client with the new token")?; let me = as_agent .user_get_current() diff --git a/swarm-controller/src/forge/api.rs b/swarm-controller/src/forge/api.rs index e1198b14a..e0e32ed3c 100644 --- a/swarm-controller/src/forge/api.rs +++ b/swarm-controller/src/forge/api.rs @@ -9,7 +9,8 @@ use std::sync::{Arc, Mutex}; -use forgejo_api::{ApiErrorKind, Auth, Forgejo, ForgejoError}; +use forge_client::{StaticToken, async_client}; +use forgejo_api::{ApiErrorKind, Forgejo, ForgejoError}; use futures_util::future::BoxFuture; use reqwest::StatusCode; use swarm_secret_client::stored_secret::StoredSecret; @@ -32,7 +33,7 @@ impl Api { /// `url` is not http(s), or the token is not ASCII. pub(crate) fn new(url: url::Url, token: StoredSecret) -> Result { let current = token.current(); - let api = Arc::new(Forgejo::new(Auth::Token(¤t), url.clone())?); + let api = Arc::new(async_client(url.clone(), &StaticToken::new(¤t))?); Ok(Self { url, token, @@ -45,7 +46,7 @@ impl Api { let token = self.token.current(); let mut built = self.built.lock().expect("unpoisoned"); if built.0 != token { - let api = Arc::new(Forgejo::new(Auth::Token(&token), self.url.clone())?); + let api = Arc::new(async_client(self.url.clone(), &StaticToken::new(&token))?); *built = (token.clone(), api); } Ok((token, Arc::clone(&built.1))) @@ -237,6 +238,38 @@ pub(crate) mod tests { assert_eq!(served.load(Ordering::SeqCst), 4); } + #[tokio::test(start_paused = true)] + async fn an_unchanged_token_keeps_the_client() { + let (url, served) = forge_accepting("old", None).await; + let (token, reads) = token("old", "new"); + let api = Api::new(url, token).unwrap(); + let (first_token, first) = api.current().unwrap(); + let (second_token, second) = api.current().unwrap(); + assert_eq!( + (first_token.as_str(), second_token.as_str()), + ("old", "old") + ); + assert!(Arc::ptr_eq(&first, &second)); + first.user_get_current().await.expect("sends the old token"); + assert_eq!(reads.load(Ordering::SeqCst), 0); + assert_eq!(served.load(Ordering::SeqCst), 1); + } + + #[tokio::test(start_paused = true)] + async fn a_changed_token_builds_a_client_sending_the_new_one() { + let (url, _) = forge_accepting("new", None).await; + let (token, _) = token("old", "new"); + let api = Api::new(url, token).unwrap(); + let (_, before) = api.current().unwrap(); + api.token.after_refusal("old").await.expect("a new token"); + let (token, after) = api.current().unwrap(); + assert_eq!(token, "new"); + assert!(!Arc::ptr_eq(&before, &after)); + after.user_get_current().await.expect("sends the new token"); + let err = before.user_get_current().await.expect_err("still the old"); + assert!(refuses_the_token(&err), "{err}"); + } + #[test] fn only_a_401_counts_as_refusing_the_token() { let unauthorized = forgejo_api::ApiError { diff --git a/swarm-controller/src/forge/builder_account.rs b/swarm-controller/src/forge/builder_account.rs index 18330f572..b0de52fb1 100644 --- a/swarm-controller/src/forge/builder_account.rs +++ b/swarm-controller/src/forge/builder_account.rs @@ -15,8 +15,8 @@ use std::sync::Arc; use anyhow::{Context, Result, bail}; +use forge_client::{StaticToken, async_client}; use forgejo_api::structs::RepoSearchQuery; -use forgejo_api::{Auth, Forgejo}; use swarm_secret_client::builder::forge_token_path; use swarm_secret_client::forge; @@ -93,7 +93,7 @@ impl Client { .replace_token(&store, LOGIN, TOKEN_NAME, TOKEN_SCOPES, &listed, &path) .await?; - Forgejo::new(Auth::Token(&credential.value), self.url.clone()) + async_client(self.url.clone(), &StaticToken::new(&credential.value)) .context("building a forge client with the new token")? .repo_search(RepoSearchQuery::default()) .await diff --git a/swarm-controller/src/forge/ci_metrics_account.rs b/swarm-controller/src/forge/ci_metrics_account.rs index 92b478596..bb168347a 100644 --- a/swarm-controller/src/forge/ci_metrics_account.rs +++ b/swarm-controller/src/forge/ci_metrics_account.rs @@ -17,11 +17,11 @@ use std::sync::Arc; use anyhow::{Context, Result, bail}; +use forge_client::{StaticToken, async_client}; use forgejo_api::structs::{ CreateTeamOption, CreateTeamOptionPermission, EditTeamOption, EditTeamOptionPermission, RepoSearchQuery, Team, TeamPermission, }; -use forgejo_api::{Auth, Forgejo}; use swarm_secret_client::ci_metrics::forge_token_path; use swarm_secret_client::forge; @@ -124,7 +124,7 @@ impl Client { .replace_token(&store, LOGIN, TOKEN_NAME, TOKEN_SCOPES, &listed, &path) .await?; - Forgejo::new(Auth::Token(&credential.value), self.url.clone()) + async_client(self.url.clone(), &StaticToken::new(&credential.value)) .context("building a forge client with the new token")? .repo_search(RepoSearchQuery::default()) .await diff --git a/swarm-controller/src/forge/classifier_account.rs b/swarm-controller/src/forge/classifier_account.rs index f687a94b2..70bdb5e4a 100644 --- a/swarm-controller/src/forge/classifier_account.rs +++ b/swarm-controller/src/forge/classifier_account.rs @@ -20,11 +20,12 @@ use std::sync::Arc; use anyhow::{Context, Result, bail}; +use forge_client::{StaticToken, async_client}; +use forgejo_api::Forgejo; use forgejo_api::structs::{ ChangeFileOperation, ChangeFileOperationOperation, ChangeFilesOptions, CreatePullReviewOptions, Identity, RepoSearchQuery, }; -use forgejo_api::{Auth, Forgejo}; use swarm_secret_client::forge; use swarm_secret_client::review_classifier::forge_token_path; @@ -122,7 +123,7 @@ impl Client { .replace_token(&store, LOGIN, TOKEN_NAME, TOKEN_SCOPES, &listed, &path) .await?; - Forgejo::new(Auth::Token(&credential.value), self.url.clone()) + async_client(self.url.clone(), &StaticToken::new(&credential.value)) .context("building a forge client with the new token")? .repo_search(RepoSearchQuery::default()) .await @@ -221,7 +222,7 @@ impl Client { else { bail!("nothing at {path}: the classifier's forge token is not minted yet"); }; - Forgejo::new(Auth::Token(&credential.value), self.url.clone()) + async_client(self.url.clone(), &StaticToken::new(&credential.value)) .context("building a forge client with the classifier's token") } @@ -462,7 +463,7 @@ mod tests { let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); let url = url::Url::parse(&format!("http://{}/", listener.local_addr().unwrap())).unwrap(); tokio::spawn(async move { axum::serve(listener, app).await }); - let forge = Forgejo::new(Auth::Token("stub-token"), url).unwrap(); + let forge = async_client(url, &StaticToken::new("stub-token")).unwrap(); let commit = BranchCommit { base: "main".to_owned(), branch: "review-classifier/alice-0a1b2c3d".to_owned(), diff --git a/swarm-controller/src/forge/hive_token.rs b/swarm-controller/src/forge/hive_token.rs index 28310c685..7c5328113 100644 --- a/swarm-controller/src/forge/hive_token.rs +++ b/swarm-controller/src/forge/hive_token.rs @@ -19,11 +19,11 @@ use std::sync::Arc; use anyhow::{Context, Result, bail}; +use forge_client::{StaticToken, async_client}; use forgejo_api::structs::{ AccessToken, CreateTeamOption, CreateTeamOptionPermission, EditTeamOption, EditTeamOptionPermission, RepoSearchQuery, Team, TeamPermission, }; -use forgejo_api::{Auth, Forgejo}; use swarm_secret_client::forge; use super::agent_token::{Decision, Observed, classify_named, is_not_found}; @@ -175,7 +175,7 @@ impl Client { ) .await?; - Forgejo::new(Auth::Token(&credential.value), self.url.clone()) + async_client(self.url.clone(), &StaticToken::new(&credential.value)) .context("building a forge client with the new token")? .repo_search(RepoSearchQuery::default()) .await diff --git a/swarm-controller/src/forge/service_avatars.rs b/swarm-controller/src/forge/service_avatars.rs index 754dd7da5..7d16fba88 100644 --- a/swarm-controller/src/forge/service_avatars.rs +++ b/swarm-controller/src/forge/service_avatars.rs @@ -21,8 +21,8 @@ use std::time::Duration; use anyhow::{Context, Result}; use base64::Engine as _; +use forge_client::{StaticToken, async_client}; use forgejo_api::structs::{CreateAccessTokenOption, UpdateUserAvatarOption}; -use forgejo_api::{Auth, Forgejo}; use sha2::{Digest as _, Sha256}; use super::agent_token::is_not_found; @@ -177,7 +177,7 @@ impl Client { .sha1 .filter(|v| !v.is_empty()) .with_context(|| format!("the forge created {login}'s token but returned no value"))?; - let uploaded = Forgejo::new(Auth::Token(&token), self.url.clone()) + let uploaded = async_client(self.url.clone(), &StaticToken::new(&token)) .context("building a forge client with the avatar token")? .user_update_avatar(UpdateUserAvatarOption { image: Some(base64::engine::general_purpose::STANDARD.encode(image)), diff --git a/swarm-controller/src/review_classifier/review.rs b/swarm-controller/src/review_classifier/review.rs index ead6226aa..62ebe65c1 100644 --- a/swarm-controller/src/review_classifier/review.rs +++ b/swarm-controller/src/review_classifier/review.rs @@ -2542,7 +2542,8 @@ mod tests { let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); let url = url::Url::parse(&format!("http://{}/", listener.local_addr().unwrap())).unwrap(); drop(listener); - let forge = forgejo_api::Forgejo::new(forgejo_api::Auth::Token("stub-token"), url).unwrap(); + let forge = + forge_client::async_client(url, &forge_client::StaticToken::new("stub-token")).unwrap(); forge.user_get_current().await.expect_err("nothing listens") }