[pdm-devel] [PATCH datacenter-manager 2/8] pdm-api-types: remote upid: make upid field private

[Lukas Wagner]

Shielding members behind a getter is beneficial in most cases. This
makes it easier to change the internal representation of the type
later.

Signed-off-by: Lukas Wagner <l.wagner at proxmox.com>
---
 lib/pdm-api-types/src/remote_upid.rs  | 12 +++++++++++-
 server/src/api/pve/tasks.rs           | 18 +++++++++---------
 server/src/remote_tasks/mod.rs        |  2 +-
 server/src/remote_tasks/task_cache.rs |  2 +-
 server/src/sdn_client.rs              |  2 +-
 ui/src/tasks.rs                       |  4 ++--
 6 files changed, 25 insertions(+), 15 deletions(-)

diff --git a/lib/pdm-api-types/src/remote_upid.rs b/lib/pdm-api-types/src/remote_upid.rs
index bf7c1797..6b0f8461 100644
--- a/lib/pdm-api-types/src/remote_upid.rs
+++ b/lib/pdm-api-types/src/remote_upid.rs
@@ -13,7 +13,7 @@ pub const REMOTE_UPID_SCHEMA: Schema = StringSchema::new("A remote UPID")
 pub struct RemoteUpid {
     remote: String,
     /// This is usually a pve upid, but may also be a pbs upid, they have distinct formats.
-    pub upid: String,
+    upid: String,
 }
 
 impl RemoteUpid {
@@ -24,6 +24,16 @@ impl RemoteUpid {
     pub fn into_remote(self) -> String {
         self.remote
     }
+
+    /// Get the raw UPID.
+    pub fn upid(&self) -> &str {
+        &self.upid
+    }
+
+    /// Get the raw UPID, consuming self.
+    pub fn into_upid(self) -> String {
+        self.upid
+    }
 }
 
 impl ApiType for RemoteUpid {
diff --git a/server/src/api/pve/tasks.rs b/server/src/api/pve/tasks.rs
index 0371fa00..9f04a448 100644
--- a/server/src/api/pve/tasks.rs
+++ b/server/src/api/pve/tasks.rs
@@ -89,13 +89,13 @@ async fn stop_task(remote: String, upid: RemoteUpid) -> Result<(), Error> {
     let pve = get_remote(&remotes, upid.remote())?;
 
     let pve_upid: PveUpid = upid
-        .upid
+        .upid()
         .parse()
-        .map_err(|err| format_err!("invalid upid for PVE: {} - {err}", upid.upid))?;
+        .map_err(|err| format_err!("invalid upid for PVE: {} - {err}", upid.upid()))?;
 
     let pve = connect(pve)?;
 
-    Ok(pve.stop_task(&pve_upid.node, &upid.upid).await?)
+    Ok(pve.stop_task(&pve_upid.node, upid.upid()).await?)
 }
 
 #[api(
@@ -135,14 +135,14 @@ pub async fn get_task_status(
     let pve = get_remote(&remotes, upid.remote())?;
 
     let pve_upid: PveUpid = upid
-        .upid
+        .upid()
         .parse()
-        .map_err(|err| format_err!("invalid upid for PVE: {} - {err}", upid.upid))?;
+        .map_err(|err| format_err!("invalid upid for PVE: {} - {err}", upid.upid()))?;
 
     let pve = connect(pve)?;
 
     loop {
-        let status = pve.get_task_status(&pve_upid.node, &upid.upid).await?;
+        let status = pve.get_task_status(&pve_upid.node, upid.upid()).await?;
         if !wait || !status.is_running() {
             break Ok(status);
         }
@@ -218,14 +218,14 @@ async fn read_task_log(
     let pve = get_remote(&remotes, upid.remote())?;
 
     let pve_upid: PveUpid = upid
-        .upid
+        .upid()
         .parse()
-        .map_err(|err| format_err!("invalid upid for PVE: {} - {err}", upid.upid))?;
+        .map_err(|err| format_err!("invalid upid for PVE: {} - {err}", upid.upid()))?;
 
     let pve = connect(pve)?;
 
     let response = pve
-        .get_task_log(&pve_upid.node, &upid.upid, download, limit, start)
+        .get_task_log(&pve_upid.node, upid.upid(), download, limit, start)
         .await?;
 
     for (key, value) in response.attribs {
diff --git a/server/src/remote_tasks/mod.rs b/server/src/remote_tasks/mod.rs
index c4939742..37e689e0 100644
--- a/server/src/remote_tasks/mod.rs
+++ b/server/src/remote_tasks/mod.rs
@@ -53,7 +53,7 @@ pub async fn get_tasks(
                     }
                 }
                 // TODO: Handle PBS tasks
-                let pve_upid: Result<PveUpid, Error> = task.upid.upid.parse();
+                let pve_upid: Result<PveUpid, Error> = task.upid.upid().parse();
                 match pve_upid {
                     Ok(pve_upid) => Some(TaskListItem {
                         upid: task.upid.to_string(),
diff --git a/server/src/remote_tasks/task_cache.rs b/server/src/remote_tasks/task_cache.rs
index 040266ad..cb3b6687 100644
--- a/server/src/remote_tasks/task_cache.rs
+++ b/server/src/remote_tasks/task_cache.rs
@@ -407,7 +407,7 @@ impl WritableTaskCache {
 
             // TODO:: Handle PBS tasks correctly.
             // TODO: This is awkward, maybe overhaul RemoteUpid type to make this easier
-            match task.upid.upid.parse::<PveUpid>() {
+            match task.upid.upid().parse::<PveUpid>() {
                 Ok(upid) => {
                     let node = &upid.node;
                     let remote = task.upid.remote();
diff --git a/server/src/sdn_client.rs b/server/src/sdn_client.rs
index f88d2a52..6b6bdfa9 100644
--- a/server/src/sdn_client.rs
+++ b/server/src/sdn_client.rs
@@ -334,7 +334,7 @@ impl<C> LockedSdnClients<C> {
         loop {
             tokio::time::sleep(Self::POLLING_INTERVAL).await;
 
-            let status = client.get_task_status(&node, &upid.upid).await?;
+            let status = client.get_task_status(&node, upid.upid()).await?;
 
             if !status.is_running() {
                 if status.finished_successfully() == Some(true) {
diff --git a/ui/src/tasks.rs b/ui/src/tasks.rs
index 4ff29755..41a8648d 100644
--- a/ui/src/tasks.rs
+++ b/ui/src/tasks.rs
@@ -112,9 +112,9 @@ pub fn register_pve_tasks() {
 /// If it's a [`RemoteUpid`], prefixes it with the remote name
 pub fn format_optional_remote_upid(upid: &str, include_remote: bool) -> String {
     if let Ok(remote_upid) = upid.parse::<RemoteUpid>() {
-        let description = match remote_upid.upid.parse::<PveUpid>() {
+        let description = match remote_upid.upid().parse::<PveUpid>() {
             Ok(upid) => format_task_description(&upid.worker_type, upid.worker_id.as_deref()),
-            Err(_) => format_upid(&remote_upid.upid),
+            Err(_) => format_upid(&remote_upid.upid()),
         };
         if include_remote {
             format!("{} - {}", remote_upid.remote(), description)
-- 
2.47.3