Add popup on setting write failure[CPP-478]

Author: john-michaelburke

console_backend/src/common_constants.rs

@@ -289,6 +289,8 @@ pub enum Keys {
     CONSOLE_VERSION,
     #[strum(serialize = "CONNECTION_MESSAGE")]
     CONNECTION_MESSAGE,
+    #[strum(serialize = "NOTIFICATION")]
+    NOTIFICATION,
 }
 
 #[derive(Clone, Debug, Display, EnumString, EnumVariantNames, Eq, Hash, PartialEq)]

console_backend/src/settings_tab.rs

@@ -63,7 +63,7 @@ fn tick(settings_tab: &SettingsTab, settings_state: SettingsTabState) {
     }
     if let Some(req) = settings_state.write {
         if let Err(e) = settings_tab.write_setting(&req.group, &req.name, &req.value) {
-            error!("Issue writing setting, {}", e);
+            settings_tab.send_notification(format!("Issue writing setting, {}", e));
         };
     }
     if settings_state.reset {
@@ -316,6 +316,17 @@ impl SettingsTab {
         Ok(())
     }
 
+    fn send_notification(&self, message: String) {
+        error!("{}", message);
+        let mut builder = Builder::new_default();
+        let msg = builder.init_root::<crate::console_backend_capnp::message::Builder>();
+        let mut status = msg.init_settings_notification();
+        status.set_message(&message);
+
+        self.client_sender
+            .send_data(serialize_capnproto_builder(builder));
+    }
+
     fn write_setting(&self, group: &str, name: &str, value: &str) -> Result<()> {
         {
             let settings = self.settings.lock();

resources/SettingsTab.qml

@@ -49,6 +49,10 @@ MainTab {
         repeat: true
         onTriggered: {
             settings_tab_model.fill_data(settingsTabData);
+            if (settingsTabData.notification !== "") {
+                settingsNotification.text = settingsTabData.notification;
+                settingsNotification.visible = true;
+            }
             if (settingsTabData.import_status !== "") {
                 if (settingsTabData.import_status === "success") {
                     importSuccess.visible = true;
@@ -129,6 +133,14 @@ MainTab {
         id: insSettingsPopup
     }
 
+    MessageDialog {
+        id: settingsNotification
+
+        title: "Settings Write Notification"
+        icon: StandardIcon.Warning
+        standardButtons: StandardButton.Close
+    }
+
     MessageDialog {
         id: importFailure
 

src/main/resources/base/console_backend.capnp

@@ -142,6 +142,10 @@ struct SettingsResetRequest {
     reset @0 :Void = void;
 }
 
+struct SettingsNotification {
+    message @0 :Text;
+}
+
 struct Point {
     x @0 :Float64;
     y @1 :Float64;
@@ -497,5 +501,6 @@ struct Message {
         autoSurveyRequest @50 : AutoSurveyRequest;
         loggingBarRecordingStatus @51 : LoggingBarRecordingStatus;
         connectionNotification @52 : ConnectionNotification;
+        settingsNotification @53 : SettingsNotification;
     }
 }

swiftnav_console/constants.py

@@ -137,6 +137,7 @@ class Keys(str, Enum):
     RECORDING_FILENAME = "RECORDING_FILENAME"
     CONSOLE_VERSION = "CONSOLE_VERSION"
     CONNECTION_MESSAGE = "CONNECTION_MESSAGE"
+    NOTIFICATION = "NOTIFICATION"
 
 
 class ConnectionState(str, Enum):

swiftnav_console/main.py

@@ -421,6 +421,8 @@ def receive_messages(app_, backend, messages):
             SETTINGS_TABLE[Keys.ENTRIES][:] = settings_rows_to_json(m.settingsTableStatus.data)
         elif m.which == Message.Union.SettingsImportResponse:
             SETTINGS_TAB[Keys.IMPORT_STATUS] = m.settingsImportResponse.status
+        elif m.which == Message.Union.SettingsNotification:
+            SETTINGS_TAB[Keys.NOTIFICATION] = m.settingsNotification.message
         elif m.which == Message.Union.InsSettingsChangeResponse:
             SETTINGS_TAB[Keys.RECOMMENDED_INS_SETTINGS][:] = [
                 [entry.settingName, entry.currentValue, entry.recommendedValue]

swiftnav_console/settings_tab.py

@@ -12,6 +12,7 @@
     Keys.IMPORT_STATUS: None,
     Keys.RECOMMENDED_INS_SETTINGS: [],
     Keys.NEW_INS_CONFIRMATON: False,
+    Keys.NOTIFICATION: "",
 }
 
 
@@ -25,6 +26,7 @@ class SettingsTabData(QObject):
     _import_status: str = ""
     _recommended_ins_settings: List[List[Any]] = []
     _new_ins_confirmation: bool = False
+    _notification: str = ""
 
     def get_import_status(self) -> str:
         return self._import_status
@@ -52,13 +54,23 @@ def get_new_ins_confirmation(self) -> bool:
 
     new_ins_confirmation = Property(bool, get_new_ins_confirmation, set_new_ins_confirmation)
 
+    def get_notification(self) -> str:
+        return self._notification
+
+    def set_notification(self, notification: str) -> None:
+        self._notification = notification
+
+    notification = Property(str, get_notification, set_notification)
+
 
 class SettingsTabModel(QObject):  # pylint: disable=too-few-public-methods
     @Slot(SettingsTabData)  # type: ignore
     def fill_data(self, cp: SettingsTabData) -> SettingsTabData:  # pylint:disable=no-self-use
         cp.set_import_status(SETTINGS_TAB[Keys.IMPORT_STATUS])
         cp.set_recommended_ins_settings(SETTINGS_TAB[Keys.RECOMMENDED_INS_SETTINGS])
         cp.set_new_ins_confirmation(SETTINGS_TAB[Keys.NEW_INS_CONFIRMATON])
+        cp.set_notification(SETTINGS_TAB[Keys.NOTIFICATION])
+        SETTINGS_TAB[Keys.NOTIFICATION] = ""
         return cp
 
     @Slot(SettingsTabData)  # type: ignore