[pdm-devel] [PATCH datacenter-manager 1/9] server: factor out task filters into `TaskFilters` type

[Dominik Csapak]

so we can reuse it

Signed-off-by: Dominik Csapak <d.csapak at proxmox.com>
---
 lib/pdm-api-types/src/lib.rs  | 81 ++++++++++++++++++++++++++++++++++-
 server/src/api/nodes/tasks.rs | 80 ++++++++--------------------------
 2 files changed, 98 insertions(+), 63 deletions(-)

diff --git a/lib/pdm-api-types/src/lib.rs b/lib/pdm-api-types/src/lib.rs
index bf312cc..3844907 100644
--- a/lib/pdm-api-types/src/lib.rs
+++ b/lib/pdm-api-types/src/lib.rs
@@ -219,7 +219,7 @@ pub enum NodePowerCommand {
 
 #[api]
 /// The state of a task.
-#[derive(Eq, PartialEq, Debug, Serialize, Deserialize)]
+#[derive(Clone, Eq, PartialEq, Debug, Serialize, Deserialize)]
 #[serde(rename_all = "lowercase")]
 pub enum TaskStateType {
     /// Ok
@@ -418,3 +418,82 @@ impl fmt::Display for RemoteUpid {
 
 serde_plain::derive_deserialize_from_fromstr!(RemoteUpid, "valid remote upid");
 serde_plain::derive_serialize_from_display!(RemoteUpid);
+
+fn limit_default() -> u64 {
+    50
+}
+
+#[api(
+    properties: {
+            start: {
+                type: u64,
+                description: "List tasks beginning from this offset.",
+                default: 0,
+                optional: true,
+            },
+            limit: {
+                type: u64,
+                description: "Only list this amount of tasks. (0 means no limit)",
+                default: 50,
+                optional: true,
+            },
+            running: {
+                type: bool,
+                description: "Only list running tasks.",
+                optional: true,
+                default: false,
+            },
+            errors: {
+                type: bool,
+                description: "Only list erroneous tasks.",
+                optional:true,
+                default: false,
+            },
+            userfilter: {
+                optional: true,
+                type: String,
+                description: "Only list tasks from this user.",
+            },
+            since: {
+                type: i64,
+                description: "Only list tasks since this UNIX epoch.",
+                optional: true,
+            },
+            until: {
+                type: i64,
+                description: "Only list tasks until this UNIX epoch.",
+                optional: true,
+            },
+            typefilter: {
+                optional: true,
+                type: String,
+                description: "Only list tasks whose type contains this.",
+            },
+            statusfilter: {
+                optional: true,
+                type: Array,
+                description: "Only list tasks which have any one of the listed status.",
+                items: {
+                    type: TaskStateType,
+                },
+            },
+    }
+)]
+/// Task filter settings
+#[derive(Deserialize, Serialize, Clone, PartialEq, Eq)]
+#[serde(rename_all = "kebab-case")]
+pub struct TaskFilters {
+    #[serde(default)]
+    pub start: u64,
+    #[serde(default = "limit_default")]
+    pub limit: u64,
+    #[serde(default)]
+    pub errors: bool,
+    #[serde(default)]
+    pub running: bool,
+    pub userfilter: Option<String>,
+    pub since: Option<i64>,
+    pub until: Option<i64>,
+    pub typefilter: Option<String>,
+    pub statusfilter: Option<Vec<TaskStateType>>,
+}
diff --git a/server/src/api/nodes/tasks.rs b/server/src/api/nodes/tasks.rs
index 37fe0d8..13a713a 100644
--- a/server/src/api/nodes/tasks.rs
+++ b/server/src/api/nodes/tasks.rs
@@ -12,8 +12,8 @@ use proxmox_schema::{api, Schema};
 use proxmox_sortable_macro::sortable;
 
 use pdm_api_types::{
-    Authid, TaskListItem, TaskStateType, Tokenname, Userid, NODE_SCHEMA, PRIV_SYS_AUDIT,
-    PRIV_SYS_MODIFY, UPID, UPID_SCHEMA,
+    Authid, TaskFilters, TaskListItem, TaskStateType, Tokenname, Userid, NODE_SCHEMA,
+    PRIV_SYS_AUDIT, PRIV_SYS_MODIFY, UPID, UPID_SCHEMA,
 };
 
 pub const ROUTER: Router = Router::new()
@@ -57,57 +57,9 @@ fn check_task_access(auth_id: &Authid, upid: &UPID) -> Result<(), Error> {
             node: {
                 schema: NODE_SCHEMA
             },
-            start: {
-                type: u64,
-                description: "List tasks beginning from this offset.",
-                default: 0,
-                optional: true,
-            },
-            limit: {
-                type: u64,
-                description: "Only list this amount of tasks. (0 means no limit)",
-                default: 50,
-                optional: true,
-            },
-            running: {
-                type: bool,
-                description: "Only list running tasks.",
-                optional: true,
-                default: false,
-            },
-            errors: {
-                type: bool,
-                description: "Only list erroneous tasks.",
-                optional:true,
-                default: false,
-            },
-            userfilter: {
-                optional: true,
-                type: String,
-                description: "Only list tasks from this user.",
-            },
-            since: {
-                type: i64,
-                description: "Only list tasks since this UNIX epoch.",
-                optional: true,
-            },
-            until: {
-                type: i64,
-                description: "Only list tasks until this UNIX epoch.",
-                optional: true,
-            },
-            typefilter: {
-                optional: true,
-                type: String,
-                description: "Only list tasks whose type contains this.",
-            },
-            statusfilter: {
-                optional: true,
-                type: Array,
-                description: "Only list tasks which have any one of the listed status.",
-                items: {
-                    type: TaskStateType,
-                },
+            filters: {
+                type: TaskFilters,
+                flatten: true,
             },
         },
     },
@@ -120,17 +72,21 @@ fn check_task_access(auth_id: &Authid, upid: &UPID) -> Result<(), Error> {
 /// List tasks.
 #[allow(clippy::too_many_arguments)]
 pub fn list_tasks(
-    start: u64,
-    limit: u64,
-    errors: bool,
-    running: bool,
-    userfilter: Option<String>,
-    since: Option<i64>,
-    until: Option<i64>,
-    typefilter: Option<String>,
-    statusfilter: Option<Vec<TaskStateType>>,
+    filters: TaskFilters,
     rpcenv: &mut dyn RpcEnvironment,
 ) -> Result<Vec<TaskListItem>, Error> {
+    let TaskFilters {
+        start,
+        limit,
+        errors,
+        running,
+        userfilter,
+        since,
+        until,
+        typefilter,
+        statusfilter,
+    } = filters;
+
     let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
     let user_info = CachedUserInfo::new()?;
     let user_privs = user_info.lookup_privs(&auth_id, &["system", "tasks"]);
-- 
2.39.5