Skip to content

DNM: port new update-agent to use the old endpoint #1116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
sfikastheo wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

DNM: port new update-agent to use the old endpoint #1116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
135 changes: 19 additions & 116 deletions update-agent/src/claim.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,6 @@ pub enum Error {
status_code: StatusCode,
msg: String,
},
#[error("Unable to determine current version for slot {slot:?} - release version not set in version map")]
MissingSlotVersion { slot: Slot },
#[error("no new version available - system is up to date")]
NoNewVersion,
}

impl Error {
Expand Down Expand Up @@ -116,26 +112,23 @@ fn from_remote(
url: &Url,
version_map: &VersionMap,
verify_manifest_signature_against: Backend,
) -> Result<Option<(String, Claim)>, Error> {
let current_version = version_map
.get_slot_version(slot)
.ok_or_else(|| Error::MissingSlotVersion { slot })?;

let mut api_url = url.clone();
api_url.set_path(&format!("/api/v2/orbs/{}/claim", id));
api_url
.query_pairs_mut()
.clear()
.append_pair("currentVersion", current_version);
) -> Result<(String, Claim), Error> {
let req_body = serde_json::json!({
"id": id,
"active_slot": slot.to_string(),
"versions": version_map.to_legacy(),
});

debug!(
"sending check request to: {} with currentVersion: {}",
api_url, current_version
"sending check request with body: {}",
serde_json::to_string(&req_body)
.expect("the json Value object contains only valid json"),
);

let client = crate::client::normal()?;
let resp = client
.get(api_url.clone())
.post(url.clone())
.json(&req_body)
.send()
.map_err(Error::SendCheckUpdateRequest)?;

Expand All @@ -151,24 +144,10 @@ fn from_remote(
Cow::Borrowed("")
}
};

if status == StatusCode::NOT_FOUND && !msg.is_empty() {
Err(Error::NoNewVersion)
} else {
Err(Error::status_code(status, msg))
}
Err(Error::status_code(status, msg))
} else {
let resp_txt = resp.text().map_err(Error::ResponseAsText)?;
debug!("server sent raw claim: {resp_txt}");

if let Ok(response) = serde_json::from_str::<serde_json::Value>(&resp_txt)
&& let Some(status) = response.get("status").and_then(|s| s.as_str())
&& status == "up_to_date"
{
debug!("system is up to date - no update available");
return Ok(None);
}

let claim_verification_context = ClaimVerificationContext(
pubkey_from_backend_type(verify_manifest_signature_against),
);
Expand All @@ -177,7 +156,7 @@ fn from_remote(
resp_txt.as_bytes(),
)
.map_err(Error::ReadJson)?;
Ok(Some((resp_txt, claim)))
Ok((resp_txt, claim))
}
}

Expand Down Expand Up @@ -263,33 +242,20 @@ pub fn get(settings: &Settings, version_map: &VersionMap) -> Result<Claim, Error
Err(e) => warn!("cannot progress with on-disk update claim: {e:?}"),
Ok(claim) => return Ok(claim),
}
info!("checking remote update at {url}, for orb {}", &settings.id);
let result = from_remote(
info!("checking remote update at {url}");
let (raw_txt, claim) = from_remote(
&settings.id,
settings.active_slot,
url,
version_map,
settings.verify_manifest_signature_against,
)
.map_err(|e| Error::remote(url, e))?;

match result {
Some((raw_txt, claim)) => {
info!("writing raw remote update claim to disk");
if let Err(e) = to_disk(&path, &raw_txt) {
warn!(
"failed writing remote claim to `{}`: {e:?}",
path.display()
);
}
Ok(claim)
}
None => {
info!("no update available - system is up to date");
info!("returning NoNewVersion error");
Err(Error::NoNewVersion)
}
info!("writing raw remote update claim to disk");
if let Err(e) = to_disk(&path, &raw_txt) {
warn!("failed writing remote claim to `{}`: {e:?}", path.display());
}
Ok(claim)
}
LocalOrRemote::Local(path) => {
info!("reading local update claim at {}", path.display());
Expand All @@ -309,71 +275,8 @@ fn pubkey_from_backend_type(backend: Backend) -> &'static VerifyingKey {

#[cfg(test)]
mod tests {
use super::*;
use orb_update_agent_core::{Slot, VersionMap};

#[test]
fn test_url_construction() {
let base_url = Url::parse("https://fleet.stage.orb.worldcoin.org").unwrap();
let id = "3d8af1da";
let slot = Slot::A;

let versions_json = r#"{
"releases": {
"slot_a": "test-version",
"slot_b": "other-version"
},
"slot_a": {},
"slot_b": {},
"singles": {}
}"#;

let versions: orb_update_agent_core::versions::VersionsLegacy =
serde_json::from_str(versions_json).unwrap();
let version_map = VersionMap::from_legacy(&versions);

let current_version = version_map.get_slot_version(slot).unwrap_or("unknown");
let mut api_url = base_url.clone();
api_url.set_path(&format!("/api/v2/orbs/{}/claim", id));
api_url
.query_pairs_mut()
.clear()
.append_pair("currentVersion", current_version);

assert_eq!(
api_url.to_string(),
"https://fleet.stage.orb.worldcoin.org/api/v2/orbs/3d8af1da/claim?currentVersion=test-version"
);
}

#[test]
fn test_up_to_date_response_parsing() {
let response = r#"{
"status": "up_to_date",
"current_version": "dupa",
"message": "No update available"
}"#;

let parsed_response: serde_json::Value =
serde_json::from_str(response).unwrap();

if let Some(status) = parsed_response.get("status").and_then(|s| s.as_str()) {
assert_eq!(status, "up_to_date");

let version = parsed_response
.get("current_version")
.and_then(|v| v.as_str())
.unwrap_or("unknown");
let message = parsed_response
.get("message")
.and_then(|m| m.as_str())
.unwrap_or("No update available");

assert_eq!(version, "dupa");
assert_eq!(message, "No update available");
}
}

#[test]
fn test_incomplete_versions_json_behavior() {
let versions_with_empty_json = r#"{
Expand Down
21 changes: 2 additions & 19 deletions update-agent/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,25 +252,8 @@ fn run(args: &Args) -> eyre::Result<()> {
}
}

let claim = match orb_update_agent::claim::get(&settings, &version_map) {
Ok(c) => c,

Err(e) => {
if matches!(&e, orb_update_agent::claim::Error::NoNewVersion) {
info!("No new version available - system is up to date");
if let Some(iface) = &update_iface
&& let Err(e) = interfaces::update_dbus_progress(
None,
Some(UpdateAgentState::NoNewVersion),
iface,
)
{
warn!("{e:?}");
}
}
return Err(e).wrap_err("unable to get update claim");
}
};
let claim = orb_update_agent::claim::get(&settings, &version_map)
.wrap_err("unable to get update claim")?;

if let Some(iface) = &update_iface {
interfaces::init_dbus_properties(&claim, iface);
Expand Down
Loading