From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id AFE8C1FF15C for ; Fri, 17 Oct 2025 13:11:45 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 11962272E9; Fri, 17 Oct 2025 13:12:07 +0200 (CEST) Mime-Version: 1.0 Date: Fri, 17 Oct 2025 13:12:03 +0200 Message-Id: From: "Lukas Wagner" To: "Shannon Sterz" , "Lukas Wagner" X-Mailer: aerc 0.21.0-0-g5549850facc2-dirty References: <20251015124711.312943-1-l.wagner@proxmox.com> <20251015124711.312943-3-l.wagner@proxmox.com> In-Reply-To: X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1760699519963 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.028 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [lib.rs] Subject: Re: [pdm-devel] [PATCH proxmox-datacenter-manager 02/12] pdm-api-types: add types for remote upgrade summary X-BeenThere: pdm-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Datacenter Manager development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox Datacenter Manager development discussion Cc: Proxmox Datacenter Manager development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pdm-devel-bounces@lists.proxmox.com Sender: "pdm-devel" On Fri Oct 17, 2025 at 12:15 PM CEST, Shannon Sterz wrote: > On Wed Oct 15, 2025 at 2:47 PM CEST, Lukas Wagner wrote: >> This type contains the number of available updates per remote node, >> without any details. This is useful for a global "give me the update >> availability for all managed nodes" API endpoint. >> >> Signed-off-by: Lukas Wagner >> --- >> lib/pdm-api-types/src/lib.rs | 2 + >> lib/pdm-api-types/src/remote_updates.rs | 126 ++++++++++++++++++++++++ >> 2 files changed, 128 insertions(+) >> create mode 100644 lib/pdm-api-types/src/remote_updates.rs >> >> diff --git a/lib/pdm-api-types/src/lib.rs b/lib/pdm-api-types/src/lib.rs >> index a3566142..2fb61ef7 100644 >> --- a/lib/pdm-api-types/src/lib.rs >> +++ b/lib/pdm-api-types/src/lib.rs >> @@ -96,6 +96,8 @@ pub use openid::*; >> >> pub mod remotes; >> >> +pub mod remote_updates; >> + >> pub mod resource; >> >> pub mod rrddata; >> diff --git a/lib/pdm-api-types/src/remote_updates.rs b/lib/pdm-api-types/src/remote_updates.rs >> new file mode 100644 >> index 00000000..d04a7a79 >> --- /dev/null >> +++ b/lib/pdm-api-types/src/remote_updates.rs >> @@ -0,0 +1,126 @@ >> +use std::{ >> + collections::HashMap, >> + ops::{Deref, DerefMut}, >> +}; >> + > > nit: i think we prefer module level imports these days. so this should > be > > use std::collections::HashMap; > use std::ops::{Deref, DerefMut}; > > but no hard feelings from my side and certainly not a blocker > Right, thanks for the hint! Although I have to say that I'm not a fan of enforcing this 'rule' or 'guideline' as long as we cannot teach rustfmt to 'do the right thing'. 99% of my 'use' statements are produced by rust-analyzer and I'm not a fan of having to micro-manage these, if I'm perfectly honest. >> +use proxmox_schema::{api, ApiType, ObjectSchema}; >> +use serde::{Deserialize, Serialize}; >> + > > nit: ordering of use statements should be std -> generic crates (serde, > anyhow etc.) -> proxmox* -> project; each separate by an empty line, to > my knowledge. > > so: > > ``` > use serde::{Deserialize, Serialize}; > > use proxmox_schema::{api, ApiType, ObjectSchema}; > ``` > > again not a > blocker, just saw it and thought id mention it Thanks for the reminder! Usually I check for this nowadays, but sometimes I forget to. I wonder if we could create custom linter script/tool checking for these - maybe using the treesitter library. > >> +use crate::remotes::RemoteType; + +#[api] +#[derive(Clone, Debug, >> Default, Deserialize, Serialize)] +#[serde(rename_all = >> "kebab-case")] +/// Update summary for all remotes. +pub struct >> UpdateSummary { + /// Map containing the update summary each >> remote. + pub remotes: RemoteUpdateSummaryWrapper, +} + +// This >> is a hack to allow actual 'maps' (mapping remote name to per-remote >> data) +// within the realms of our API macro. +#[derive(Clone, Debug, >> Default, Deserialize, Serialize)] +#[serde(rename_all = >> "kebab-case")] +pub struct RemoteUpdateSummaryWrapper { + >> #[serde(flatten)] + remotes: HashMap, >> +} > > just wondering whether you have considered changing this to > > pub struct RemoteUpdateSummaryWrapper(HashMap RemoteUpdateSummary>); > > would save you a `flatten` from what i can tell? > Thanks for the idea, I did not really think about this before. But then again it does not really have any benefits apart from not having to write the 'flatten' statement, does it? >> +impl ApiType for RemoteUpdateSummaryWrapper { + const API_SCHEMA: >> proxmox_schema::Schema = + ObjectSchema::new("Map of >> per-remote update summaries", &[]) + .additional_properties(true) + >> .schema(); +} + +impl Deref for RemoteUpdateSummaryWrapper { + >> type Target = HashMap; + + fn >> deref(&self) -> &Self::Target { + &self.remotes + } +} + +impl >> DerefMut for RemoteUpdateSummaryWrapper { + fn deref_mut(&mut >> self) -> &mut Self::Target { + &mut self.remotes + } +} + >> +#[api] +#[derive(Clone, Debug, Deserialize, Serialize)] >> +#[serde(rename_all = "kebab-case")] +/// Update summary for a single >> remote. +pub struct RemoteUpdateSummary { + /// Map containing the >> update summary for each node of this remote. + pub nodes: >> NodeUpdateSummaryWrapper, + pub remote_type: RemoteType, + pub >> status: RemoteUpdateStatus, +} + +#[api] +#[derive(Clone, Debug, >> Deserialize, Serialize, PartialEq)] +#[serde(rename_all = >> "kebab-case")] +/// Status for the entire remote. +pub enum >> RemoteUpdateStatus { + /// Successfully polled remote. + >> Success, + /// Remote could not be polled. + Error, + /// >> Remote has not been polled yet. + Unknown, +} + +#[derive(Clone, >> Debug, Default, Deserialize, Serialize)] +#[serde(rename_all = >> "kebab-case")] +pub struct NodeUpdateSummaryWrapper { + >> #[serde(flatten)] + nodes: HashMap, +} >> + +impl ApiType for NodeUpdateSummaryWrapper { + const API_SCHEMA: >> proxmox_schema::Schema = + ObjectSchema::new("Map of per-node >> update summaries", &[]) + .additional_properties(true) + >> .schema(); +} + +impl Deref for NodeUpdateSummaryWrapper { + type >> Target = HashMap; + + fn deref(&self) >> -> &Self::Target { + &self.nodes + } +} + +impl DerefMut >> for NodeUpdateSummaryWrapper { + fn deref_mut(&mut self) -> &mut >> Self::Target { + &mut self.nodes + } +} + +#[api] >> +#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)] >> +#[serde(rename_all = "kebab-case")] +/// Status for the entire >> remote. +pub enum NodeUpdateStatus { + /// Successfully polled >> node. + Success, + /// Node could not be polled. + Error, +} >> + +#[api] +#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)] >> +#[serde(rename_all = "kebab-case")] +/// Per-node update summary. >> +pub struct NodeUpdateSummary { + /// Number of available updates. >> + pub number_of_updates: u32, + /// Unix timestamp of the last >> refresh. + pub last_refresh: i64, + /// Status + pub status: >> NodeUpdateStatus, + /// Status message (e.g. error message) + pub >> status_message: Option, +} _______________________________________________ pdm-devel mailing list pdm-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pdm-devel