Register extension from web UI (#2230)

## Problem

- Extensions can be registered only from command line or in
autoinstallation

## Solution

- Implement the web UI

## Screenshots

The first proposal:


![agama-extension-ui](https://github.com/user-attachments/assets/ae6f8bfa-c985-428b-b2b8-bef186d063b9)

After registering the registration code field and the button is replaced
by "registered" status text:


![image](https://github.com/user-attachments/assets/e9b84c46-568f-4efe-8598-754e9b46960f)

Author: lslezak

.github/workflows/ci-rust.yml

@@ -114,7 +114,6 @@ jobs:
       continue-on-error: true
       uses: coverallsapp/github-action@v2
       # ignore errors in this step
-      continue-on-error: true
       with:
         base-path: ./rust
         format: cobertura
@@ -129,7 +128,6 @@ jobs:
       continue-on-error: true
       uses: coverallsapp/github-action@v2
       # ignore errors in this step
-      continue-on-error: true
       with:
         parallel-finished: true
         carryforward: "service,web"

live/src/config.sh

@@ -195,7 +195,7 @@ mkdir -p /etc/agama.d
 # insists on running systemd as PID 1 :-/
 ls -1 -d /usr/lib/locale/*.utf8 | sed -e "s#/usr/lib/locale/##" -e "s#utf8#UTF-8#" >/etc/agama.d/locales
 
-# delete translations and unusupported languages (makes ISO about 22MiB smaller)
+# delete translations and unsupported languages (makes ISO about 22MiB smaller)
 # build list of ignore options for "ls" with supported languages like "-I cs* -I de* -I es* ..."
 readarray -t IGNORE_OPTS < <(ls /usr/share/agama/web_ui/po.*.js.gz | sed -e "s#/usr/share/agama/web_ui/po\.\(.*\)\.js\.gz#-I\n\\1*#")
 # additionally keep the en_US translations

rust/agama-lib/src/product/client.rs

@@ -20,7 +20,7 @@
 
 use crate::dbus::{get_optional_property, get_property};
 use crate::error::ServiceError;
-use crate::software::model::AddonParams;
+use crate::software::model::{AddonParams, AddonProperties};
 use crate::software::proxies::SoftwareProductProxy;
 use serde::Serialize;
 use std::collections::HashMap;
@@ -146,6 +146,28 @@ impl<'a> ProductClient<'a> {
         Ok(addons)
     }
 
+    // details of available addons
+    pub async fn available_addons(&self) -> Result<Vec<AddonProperties>, ServiceError> {
+        self.registration_proxy
+            .available_addons()
+            .await?
+            .into_iter()
+            .map(|hash| {
+                Ok(AddonProperties {
+                    id: get_property(&hash, "id")?,
+                    version: get_property(&hash, "version")?,
+                    label: get_property(&hash, "label")?,
+                    available: get_property(&hash, "available")?,
+                    free: get_property(&hash, "free")?,
+                    recommended: get_property(&hash, "recommended")?,
+                    description: get_property(&hash, "description")?,
+                    release: get_property(&hash, "release")?,
+                    r#type: get_property(&hash, "type")?,
+                })
+            })
+            .collect()
+    }
+
     /// register product
     pub async fn register(&self, code: &str, email: &str) -> Result<(u32, String), ServiceError> {
         let mut options: HashMap<&str, &zbus::zvariant::Value> = HashMap::new();

rust/agama-lib/src/product/proxies.rs

@@ -75,4 +75,10 @@ pub trait Registration {
     /// registered addons property, list of tuples (name, version, reg_code))
     #[zbus(property)]
     fn registered_addons(&self) -> zbus::Result<Vec<(String, String, String)>>;
+
+    /// available addons property, a hash with string key
+    #[zbus(property)]
+    fn available_addons(
+        &self,
+    ) -> zbus::Result<Vec<std::collections::HashMap<String, zbus::zvariant::OwnedValue>>>;
 }

rust/agama-lib/src/software/model/registration.rs

@@ -41,6 +41,30 @@ pub struct AddonParams {
     pub registration_code: Option<String>,
 }
 
+/// Addon registration
+#[derive(Clone, Serialize, Deserialize, utoipa::ToSchema)]
+#[serde(rename_all = "camelCase")]
+pub struct AddonProperties {
+    /// Addon identifier
+    pub id: String,
+    /// Version of the addon
+    pub version: String,
+    /// User visible name
+    pub label: String,
+    /// Whether the addon is mirrored on the RMT server, on SCC it is always `true`
+    pub available: bool,
+    /// Whether a registration code is required for registering the addon
+    pub free: bool,
+    /// Whether the addon is recommended for the users
+    pub recommended: bool,
+    /// Short description of the addon (translated)
+    pub description: String,
+    /// Type of the addon, like "extension" or "module"
+    pub r#type: String,
+    /// Release status of the addon, e.g. "beta"
+    pub release: String,
+}
+
 /// Information about registration configuration (product, patterns, etc.).
 #[derive(Clone, Serialize, Deserialize, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]

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

@@ -38,7 +38,7 @@ use agama_lib::{
     product::{proxies::RegistrationProxy, Product, ProductClient},
     software::{
         model::{
-            AddonParams, License, LicenseContent, LicensesRepo, RegistrationError,
+            AddonParams, AddonProperties, License, LicenseContent, LicensesRepo, RegistrationError,
             RegistrationInfo, RegistrationParams, Repository, ResolvableParams, SoftwareConfig,
         },
         proxies::{Software1Proxy, SoftwareProductProxy},
@@ -218,6 +218,7 @@ pub async fn software_service(dbus: zbus::Connection) -> Result<Router, ServiceE
             "/registration/addons/registered",
             get(get_registered_addons),
         )
+        .route("/registration/addons/available", get(get_available_addons))
         .route("/proposal", get(proposal))
         .route("/config", put(set_config).get(get_config))
         .route("/probe", post(probe))
@@ -337,6 +338,26 @@ async fn get_registered_addons(
     Ok(Json(result))
 }
 
+/// returns list of available addons
+///
+/// * `state`: service state.
+#[utoipa::path(
+    get,
+    path = "/registration/addons/available",
+    context_path = "/api/software",
+    responses(
+        (status = 200, description = "List of available addons", body = Vec<AddonProperties>),
+        (status = 400, description = "The D-Bus service could not perform the action")
+    )
+)]
+async fn get_available_addons(
+    State(state): State<SoftwareState<'_>>,
+) -> Result<Json<Vec<AddonProperties>>, Error> {
+    let result = state.product.available_addons().await?;
+
+    Ok(Json(result))
+}
+
 /// Register an addon
 ///
 /// * `state`: service state.
@@ -484,7 +505,7 @@ pub struct SoftwareProposal {
     /// Space required for installation. It is returned as a formatted string which includes
     /// a number and a unit (e.g., "GiB").
     size: String,
-    /// Patterns selection. It is respresented as a hash map where the key is the pattern's name
+    /// Patterns selection. It is represented as a hash map where the key is the pattern's name
     /// and the value why the pattern is selected.
     patterns: HashMap<String, SelectedBy>,
 }

service/lib/agama/dbus/software/product.rb

@@ -151,6 +151,27 @@ def registered_addons
           end
         end
 
+        # list of available addons
+        #
+        # @return [Array<Hash<String, Object>>] List of addons
+        def available_addons
+          addons = backend.registration.available_addons || []
+
+          addons.map do |a|
+            {
+              "id"          => a.identifier,
+              "version"     => a.version,
+              "label"       => a.friendly_name,
+              "available"   => a.available,    # boolean
+              "free"        => a.free,         # boolean
+              "recommended" => a.recommended,  # boolean
+              "description" => a.description,
+              "type"        => a.product_type, # "extension"
+              "release"     => a.release_stage # "beta"
+            }
+          end
+        end
+
         # Tries to register with the given registration code.
         #
         # @note Software is not automatically probed after registering the product. The reason is
@@ -275,6 +296,8 @@ def deregister
 
           dbus_reader(:registered_addons, "a(sss)")
 
+          dbus_reader(:available_addons, "aa{sv}")
+
           dbus_method(:Register, "in reg_code:s, in options:a{sv}, out result:(us)") do |*args|
             [register(args[0], email: args[1]["Email"])]
           end

service/lib/agama/registration.rb

@@ -200,6 +200,20 @@ def finish
       end
     end
 
+    # Get the available addons for the specified base product.
+    #
+    # @note The result is bound to the registration code used for the base product, the result
+    # might be different for different codes. E.g. the Alpha/Beta extensions might or might not
+    # be included in the list.
+    def available_addons
+      return @available_addons if @available_addons
+
+      @available_addons = SUSE::Connect::YaST.show_product(base_target_product,
+        connect_params).extensions
+      @logger.info "Available addons: #{available_addons.inspect}"
+      @available_addons
+    end
+
     # Callbacks to be called when registration changes (e.g., a different product is selected).
     def on_change(&block)
       @on_change_callbacks ||= []
@@ -330,20 +344,6 @@ def repository_data(repo)
       data
     end
 
-    # Get the available addons for the specified base product.
-    #
-    # @note The result is bound to the registration code used for the base product, the result
-    # might be different for different codes. E.g. the Alpha/Beta extensions might or might not
-    # be included in the list.
-    def available_addons
-      return @available_addons if @available_addons
-
-      @available_addons = SUSE::Connect::YaST.show_product(base_target_product,
-        connect_params).extensions
-      @logger.info "Available addons: #{available_addons.inspect}"
-      @available_addons
-    end
-
     # Find the version for the specified addon, if none if multiple addons with the same name
     # are found an exception is thrown.
     #

web/src/api/software.ts

@@ -21,14 +21,16 @@
  */
 
 import {
+  AddonInfo,
+  License,
+  LicenseContent,
   Pattern,
   Product,
-  SoftwareConfig,
+  RegisteredAddonInfo,
   RegistrationInfo,
   Repository,
+  SoftwareConfig,
   SoftwareProposal,
-  License,
-  LicenseContent,
 } from "~/types/software";
 import { get, post, put } from "~/api/http";
 
@@ -63,6 +65,17 @@ const fetchLicense = (id: string, lang: string = "en"): Promise<LicenseContent>
  */
 const fetchRegistration = (): Promise<RegistrationInfo> => get("/api/software/registration");
 
+/**
+ * Returns list of available addons
+ */
+const fetchAddons = (): Promise<AddonInfo[]> => get("/api/software/registration/addons/available");
+
+/**
+ * Returns list of already registered addons
+ */
+const fetchRegisteredAddons = (): Promise<RegisteredAddonInfo[]> =>
+  get("/api/software/registration/addons/registered");
+
 /**
  * Returns the list of patterns for the selected product
  */
@@ -91,16 +104,25 @@ const probe = () => post("/api/software/probe");
 const register = ({ key, email }: { key: string; email?: string }) =>
   post("/api/software/registration", { key, email });
 
+/**
+ * Request registration of the selected addon
+ */
+const registerAddon = (addon: RegisteredAddonInfo) =>
+  post("/api/software/registration/addons/register", addon);
+
 export {
+  fetchAddons,
   fetchConfig,
+  fetchLicense,
+  fetchLicenses,
   fetchPatterns,
-  fetchProposal,
   fetchProducts,
-  fetchLicenses,
-  fetchLicense,
+  fetchProposal,
+  fetchRegisteredAddons,
   fetchRegistration,
   fetchRepositories,
-  updateConfig,
   probe,
   register,
+  registerAddon,
+  updateConfig,
 };