Move proposal to api

Author: joseivanlopez

rust/agama-l10n/src/lib.rs

@@ -44,12 +44,8 @@ pub use service::Service;
 mod model;
 pub use model::{Model, ModelAdapter};
 
-mod proposal;
-pub use proposal::Proposal;
-
-pub mod helpers;
-pub mod message;
-
 mod dbus;
 mod extended_config;
+pub mod helpers;
+pub mod message;
 mod monitor;

rust/agama-l10n/src/message.rs

@@ -18,11 +18,10 @@
 // To contact SUSE LLC about this file by physical or electronic mail, you may
 // find current contact information at www.suse.com.
 
-use crate::proposal::Proposal;
 use agama_locale_data::{KeymapId, LocaleId};
 use agama_utils::actor::Message;
 use agama_utils::api;
-use agama_utils::api::l10n::SystemInfo;
+use agama_utils::api::l10n::{Proposal, SystemInfo};
 use serde::Deserialize;
 
 #[derive(Clone)]

rust/agama-l10n/src/service.rs

@@ -21,12 +21,11 @@
 use crate::extended_config::ExtendedConfig;
 use crate::message;
 use crate::model::ModelAdapter;
-use crate::proposal::Proposal;
 use agama_locale_data::{InvalidKeymapId, InvalidLocaleId, InvalidTimezoneId, KeymapId, LocaleId};
 use agama_utils::actor::{self, Actor, Handler, MessageHandler};
 use agama_utils::api;
 use agama_utils::api::event::{self, Event};
-use agama_utils::api::l10n::SystemInfo;
+use agama_utils::api::l10n::{Proposal, SystemInfo};
 use agama_utils::api::scope::Scope;
 use agama_utils::issue::{self, Issue};
 use async_trait::async_trait;
@@ -69,18 +68,13 @@ pub enum Error {
 /// * Holds the user configuration.
 /// * Applies the user configuration at the end of the installation.
 pub struct Service {
-    state: State,
+    system: SystemInfo,
+    config: ExtendedConfig,
     model: Box<dyn ModelAdapter + Send + 'static>,
     issues: Handler<issue::Service>,
     events: event::Sender,
 }
 
-struct State {
-    system: SystemInfo,
-    config: ExtendedConfig,
-    proposal: Option<Proposal>,
-}
-
 impl Service {
     pub fn new<T: ModelAdapter + Send + 'static>(
         model: T,
@@ -89,26 +83,33 @@ impl Service {
     ) -> Service {
         let system = model.read_system_info();
         let config = ExtendedConfig::new_from(&system);
-        let proposal = (&config).into();
-        let state = State {
-            system,
-            config,
-            proposal: Some(proposal),
-        };
 
         Self {
-            state,
+            system,
+            config,
             model: Box::new(model),
             issues,
             events,
         }
     }
 
+    fn get_proposal(&self) -> Option<Proposal> {
+        if !self.find_issues().is_empty() {
+            return None;
+        }
+
+        Some(Proposal {
+            keymap: self.config.keymap.clone(),
+            locale: self.config.locale.clone(),
+            timezone: self.config.timezone.clone(),
+        })
+    }
+
     /// Returns configuration issues.
     ///
     /// It returns an issue for each unknown element (locale, keymap and timezone).
     fn find_issues(&self) -> Vec<Issue> {
-        let config = &self.state.config;
+        let config = &self.config;
         let mut issues = vec![];
         if !self.model.locales_db().exists(&config.locale) {
             issues.push(Issue {
@@ -151,7 +152,7 @@ impl Actor for Service {
 #[async_trait]
 impl MessageHandler<message::GetSystem> for Service {
     async fn handle(&mut self, _message: message::GetSystem) -> Result<SystemInfo, Error> {
-        Ok(self.state.system.clone())
+        Ok(self.system.clone())
     }
 }
 
@@ -177,11 +178,10 @@ impl MessageHandler<message::SetSystem<message::SystemConfig>> for Service {
 #[async_trait]
 impl MessageHandler<message::GetConfig> for Service {
     async fn handle(&mut self, _message: message::GetConfig) -> Result<api::l10n::Config, Error> {
-        let config = self.state.config.clone();
         Ok(api::l10n::Config {
-            locale: Some(config.locale.to_string()),
-            keymap: Some(config.keymap.to_string()),
-            timezone: Some(config.timezone.to_string()),
+            locale: Some(self.config.locale.to_string()),
+            keymap: Some(self.config.keymap.to_string()),
+            timezone: Some(self.config.timezone.to_string()),
         })
     }
 }
@@ -192,21 +192,14 @@ impl MessageHandler<message::SetConfig<api::l10n::Config>> for Service {
         &mut self,
         message: message::SetConfig<api::l10n::Config>,
     ) -> Result<(), Error> {
-        let config = ExtendedConfig::new_from(&self.state.system);
+        let config = ExtendedConfig::new_from(&self.system);
         let merged = config.merge(&message.config)?;
-        if merged == self.state.config {
+        if merged == self.config {
             return Ok(());
         }
 
-        self.state.config = merged;
+        self.config = merged;
         let issues = self.find_issues();
-
-        self.state.proposal = if issues.is_empty() {
-            Some((&self.state.config).into())
-        } else {
-            None
-        };
-
         self.issues
             .cast(issue::message::Update::new(Scope::L10n, issues))?;
         self.events
@@ -218,14 +211,14 @@ impl MessageHandler<message::SetConfig<api::l10n::Config>> for Service {
 #[async_trait]
 impl MessageHandler<message::GetProposal> for Service {
     async fn handle(&mut self, _message: message::GetProposal) -> Result<Option<Proposal>, Error> {
-        Ok(self.state.proposal.clone())
+        Ok(self.get_proposal())
     }
 }
 
 #[async_trait]
 impl MessageHandler<message::Install> for Service {
     async fn handle(&mut self, _message: message::Install) -> Result<(), Error> {
-        let Some(proposal) = &self.state.proposal else {
+        let Some(proposal) = self.get_proposal() else {
             return Err(Error::MissingProposal);
         };
 
@@ -238,7 +231,7 @@ impl MessageHandler<message::Install> for Service {
 #[async_trait]
 impl MessageHandler<message::UpdateLocale> for Service {
     async fn handle(&mut self, message: message::UpdateLocale) -> Result<(), Error> {
-        self.state.system.locale = message.locale;
+        self.system.locale = message.locale;
         _ = self
             .events
             .send(Event::SystemChanged { scope: Scope::L10n });
@@ -249,7 +242,7 @@ impl MessageHandler<message::UpdateLocale> for Service {
 #[async_trait]
 impl MessageHandler<message::UpdateKeymap> for Service {
     async fn handle(&mut self, message: message::UpdateKeymap) -> Result<(), Error> {
-        self.state.system.keymap = message.keymap;
+        self.system.keymap = message.keymap;
         _ = self
             .events
             .send(Event::SystemChanged { scope: Scope::L10n });

rust/agama-manager/src/lib.rs

@@ -25,6 +25,5 @@ pub mod service;
 pub use service::Service;
 
 pub mod message;
-mod proposal;
 
 pub use agama_l10n as l10n;

rust/agama-manager/src/message.rs

@@ -19,10 +19,9 @@
 // find current contact information at www.suse.com.
 
 use crate::l10n;
-use crate::proposal::Proposal;
 use agama_lib::install_settings::InstallSettings;
 use agama_utils::actor::Message;
-use agama_utils::api::{Scope, Status, SystemInfo};
+use agama_utils::api::{Proposal, Scope, Status, SystemInfo};
 use agama_utils::issue::Issue;
 use serde::Deserialize;
 use std::collections::HashMap;

rust/agama-manager/src/service.rs

@@ -20,11 +20,10 @@
 
 use crate::l10n;
 use crate::message::{self, Action};
-use crate::proposal::Proposal;
 use agama_lib::install_settings::InstallSettings;
 use agama_utils::actor::{self, Actor, Handler, MessageHandler};
 use agama_utils::api::status::State;
-use agama_utils::api::{event, Event, Scope, Status, SystemInfo};
+use agama_utils::api::{event, Event, Proposal, Scope, Status, SystemInfo};
 use agama_utils::issue;
 use agama_utils::progress;
 use async_trait::async_trait;

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

@@ -162,13 +162,15 @@ impl ApiDocBuilder for ConfigApiDocBuilder {
             .schema_from::<crate::server::types::IssuesMap>()
             .schema_from::<crate::software::web::SoftwareProposal>()
             .schema_from::<agama_manager::message::Action>()
-            .schema_from::<agama_utils::api::Progress>()
             .schema_from::<agama_utils::api::Status>()
+            .schema_from::<agama_utils::api::Progress>()
             .schema_from::<agama_utils::api::status::State>()
             .schema_from::<agama_utils::api::Scope>()
             .schema_from::<agama_utils::api::SystemInfo>()
             .schema_from::<agama_utils::api::l10n::SystemInfo>()
             .schema_from::<agama_utils::api::l10n::Config>()
+            .schema_from::<agama_utils::api::Proposal>()
+            .schema_from::<agama_utils::api::l10n::Proposal>()
             .build()
     }
 }

rust/agama-utils/src/api.rs

@@ -36,4 +36,7 @@ pub use status::Status;
 pub mod system_info;
 pub use system_info::SystemInfo;
 
+pub mod proposal;
+pub use proposal::Proposal;
+
 pub mod l10n;

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

@@ -21,8 +21,11 @@
 //! This module contains all Agama public types that might be available over
 //! the HTTP and WebSocket API.
 
-pub mod config;
+mod config;
 pub use config::Config;
 
-pub mod system_info;
+mod system_info;
 pub use system_info::{Keymap, LocaleEntry, SystemInfo, TimezoneEntry};
+
+mod proposal;
+pub use proposal::Proposal;

rust/agama-l10n/src/proposal.rs rust/agama-utils/src/api/l10n/proposal.rsrust/agama-l10n/src/proposal.rs renamed to rust/agama-utils/src/api/l10n/proposal.rs

@@ -18,14 +18,13 @@
 // To contact SUSE LLC about this file by physical or electronic mail, you may
 // find current contact information at www.suse.com.
 
-use crate::extended_config::ExtendedConfig;
 use agama_locale_data::{KeymapId, LocaleId, TimezoneId};
 use serde::{Deserialize, Serialize};
 use serde_with::{serde_as, DisplayFromStr};
 
 /// Describes what Agama proposes for the target system.
 #[serde_as]
-#[derive(Clone, Debug, Deserialize, Serialize)]
+#[derive(Clone, Debug, Deserialize, Serialize, utoipa::ToSchema)]
 pub struct Proposal {
     /// Keymap (e.g., "us", "cz(qwerty)", etc.).
     #[serde_as(as = "DisplayFromStr")]
@@ -37,17 +36,3 @@ pub struct Proposal {
     #[serde_as(as = "DisplayFromStr")]
     pub timezone: TimezoneId,
 }
-
-/// Turns the configuration into a proposal.
-///
-/// It is possible because, in the l10n module, the configuration and the
-/// proposal are mostly the same.
-impl From<&ExtendedConfig> for Proposal {
-    fn from(config: &ExtendedConfig) -> Self {
-        Proposal {
-            keymap: config.keymap.clone(),
-            locale: config.locale.clone(),
-            timezone: config.timezone.clone(),
-        }
-    }
-}