Check config schema

Author: joseivanlopez

rust/agama-lib/src/questions/http_client.rs

@@ -38,6 +38,8 @@ pub enum QuestionsHTTPClientError {
     HTTP(#[from] BaseHTTPClientError),
     #[error("Unknown question with ID {0}")]
     UnknownQuestion(u32),
+    #[error(transparent)]
+    Json(#[from] serde_json::Error),
 }
 
 pub struct HTTPClient {
@@ -100,7 +102,7 @@ impl HTTPClient {
         };
 
         let patch = Patch {
-            update: Some(config),
+            update: Some(serde_json::to_value(config)?),
         };
 
         _ = self.client.patch_void("/v2/config", &patch).await?;
@@ -121,7 +123,7 @@ impl HTTPClient {
         };
 
         let patch = Patch {
-            update: Some(config),
+            update: Some(serde_json::to_value(config)?),
         };
         self.client.patch_void("/v2/config", &patch).await?;
         Ok(())

rust/agama-server/src/server.rs

@@ -20,3 +20,5 @@
 
 pub mod web;
 pub use web::server_service;
+
+mod config_schema;

rust/agama-server/src/server/config_schema.rs

@@ -0,0 +1,45 @@
+// Copyright (c) [2025] SUSE LLC
+//
+// All Rights Reserved.
+//
+// This program is free software; you can redistribute it and/or modify it
+// under the terms of the GNU General Public License as published by the Free
+// Software Foundation; either version 2 of the License, or (at your option)
+// any later version.
+//
+// This program is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+// more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with this program; if not, contact SUSE LLC.
+//
+// To contact SUSE LLC about this file by physical or electronic mail, you may
+// find current contact information at www.suse.com.
+
+//! This module provides utilities to check the config schema.
+
+use agama_lib::{
+    error::ProfileError,
+    profile::{ProfileValidator, ValidationOutcome},
+};
+
+#[derive(thiserror::Error, Debug)]
+pub enum Error {
+    #[error("The config does not match the schema: {0}")]
+    Schema(String),
+    #[error(transparent)]
+    ProfileValidator(#[from] ProfileError),
+    #[error(transparent)]
+    Json(#[from] serde_json::Error),
+}
+
+pub fn check(json: &serde_json::Value) -> Result<(), Error> {
+    let raw_json = serde_json::to_string(json)?;
+    let result = ProfileValidator::default_schema()?.validate_str(&raw_json)?;
+    match result {
+        ValidationOutcome::Valid => Ok(()),
+        ValidationOutcome::NotValid(reasons) => Err(Error::Schema(reasons.join(", "))),
+    }
+}

rust/agama-server/src/server/web.rs

@@ -20,6 +20,7 @@
 
 //! This module implements Agama's HTTP API.
 
+use crate::server::config_schema;
 use agama_lib::error::ServiceError;
 use agama_manager::{self as manager, message};
 use agama_utils::{
@@ -39,14 +40,18 @@ use axum::{
 };
 use hyper::StatusCode;
 use serde::Serialize;
-use serde_json::{json, value::RawValue};
+use serde_json::{json, value::RawValue, Value};
 
 #[derive(thiserror::Error, Debug)]
 pub enum Error {
     #[error(transparent)]
     Manager(#[from] manager::service::Error),
     #[error(transparent)]
     Questions(#[from] question::service::Error),
+    #[error(transparent)]
+    ConfigSchema(#[from] config_schema::Error),
+    #[error(transparent)]
+    Json(#[from] serde_json::Error),
 }
 
 impl IntoResponse for Error {
@@ -179,13 +184,12 @@ async fn get_config(State(state): State<ServerState>) -> ServerResult<Json<Confi
         (status = 400, description = "Not possible to replace the configuration.")
     ),
     params(
-        ("config" = Config, description = "Configuration to apply.")
+        ("config" = Value, description = "Configuration to apply.")
     )
 )]
-async fn put_config(
-    State(state): State<ServerState>,
-    Json(config): Json<Config>,
-) -> ServerResult<()> {
+async fn put_config(State(state): State<ServerState>, Json(json): Json<Value>) -> ServerResult<()> {
+    config_schema::check(&json)?;
+    let config = serde_json::from_value(json)?;
     state.manager.call(message::SetConfig::new(config)).await?;
     Ok(())
 }
@@ -202,14 +206,16 @@ async fn put_config(
         (status = 400, description = "Not possible to patch the configuration.")
     ),
     params(
-        ("config" = Config, description = "Changes in the configuration.")
+        ("config" = config::Patch, description = "Changes in the configuration.")
     )
 )]
 async fn patch_config(
     State(state): State<ServerState>,
     Json(patch): Json<config::Patch>,
 ) -> ServerResult<()> {
-    if let Some(config) = patch.update {
+    if let Some(json) = patch.update {
+        config_schema::check(&json)?;
+        let config = serde_json::from_value(json)?;
         state
             .manager
             .call(message::UpdateConfig::new(config))

rust/agama-utils/src/api/config.rs

@@ -20,7 +20,7 @@
 
 use crate::api::{l10n, question};
 use serde::{Deserialize, Serialize};
-use serde_json::value::RawValue;
+use serde_json::{value::RawValue, Value};
 
 #[derive(Clone, Debug, Default, Deserialize, Serialize, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]
@@ -43,5 +43,5 @@ pub struct Config {
 #[serde(rename_all = "camelCase")]
 pub struct Patch {
     /// Update for the current config.
-    pub update: Option<Config>,
+    pub update: Option<Value>,
 }