Merge pull request #279 from msupply-foundation/278-send-ok-message-c…

…an-trigger-unexpectedly

278 send ok message can trigger unexpectedly

backend/coldchain/src/alerts.rs

@@ -10,6 +10,8 @@ use service::{
     service_provider::ServiceContext,
 };
 
+use crate::sensor_state::SensorStatus;
+
 /*
 
 Temperature Alerts will look something like this...
@@ -46,6 +48,7 @@ pub struct ColdchainAlert {
     pub temperature: String,
     pub alert_type: AlertType,
     pub reminder_number: usize,
+    pub old_status: Option<SensorStatus>,
 }
 
 // Later this function probably won't exist, but serves as a reminder/POC...
@@ -135,6 +138,7 @@ mod tests {
             temperature: 10.12345.to_string(),
             alert_type: AlertType::High,
             reminder_number: 0,
+            old_status: None,
         };
 
         let recipient1 = NotificationTarget {
@@ -202,6 +206,7 @@ mod tests {
             temperature: 1.01.to_string(),
             alert_type: AlertType::Low,
             reminder_number: 0,
+            old_status: None,
         };
 
         let recipient1 = NotificationTarget {
@@ -269,6 +274,7 @@ mod tests {
             temperature: 1.01.to_string(),
             alert_type: AlertType::NoData,
             reminder_number: 0,
+            old_status: None,
         };
 
         let recipient1 = NotificationTarget {

backend/coldchain/src/process.rs

@@ -382,6 +382,7 @@ pub fn try_process_sensor_notification(
         temperature: current_temp,
         alert_type: AlertType::Ok,
         reminder_number,
+        old_status: Some(prev_sensor_state.status.clone()),
     };
 
     let alert = match curr_sensor_status {
@@ -407,10 +408,23 @@ pub fn try_process_sensor_notification(
             }
         },
         SensorStatus::Ok => match config.confirm_ok {
-            true => Some(ColdchainAlert {
-                alert_type: AlertType::Ok,
-                ..base_alert
-            }),
+            true => {
+                // only send an ok alert if the previous state was No Data see https://github.com/msupply-foundation/notify/issues/278
+                if prev_sensor_state.status == SensorStatus::NoData {
+                    log::info!("Sending Ok alert for sensor {}", sensor_row.id);
+                    Some(ColdchainAlert {
+                        alert_type: AlertType::Ok,
+                        ..base_alert
+                    })
+                } else {
+                    log::info!(
+                        "Not sending Ok alert for sensor {} as previous state was {:?}",
+                        sensor_row.id,
+                        prev_sensor_state.status
+                    );
+                    None
+                }
+            }
             false => {
                 log::info!("Confirm Ok alert disabled for sensor {}", sensor_row.id);
                 None

backend/coldchain/src/test/process.rs

@@ -361,9 +361,7 @@ fn test_try_process_sensor_notification_prev_high() {
         latest_temperature_row,
     );
     assert_eq!(sensor_state.status, SensorStatus::Ok);
-    assert_eq!(alert.is_some(), true);
-    let alert = alert.unwrap();
-    assert_eq!(alert.alert_type, AlertType::Ok);
+    assert_eq!(alert.is_none(), true);
 
     /*
         Test 2: Was High 1 Minute ago, Now High Temp -> No Alert!
@@ -516,9 +514,7 @@ fn test_try_process_sensor_notification_prev_low() {
         latest_temperature_row,
     );
     assert_eq!(sensor_state.status, SensorStatus::Ok);
-    assert_eq!(alert.is_some(), true);
-    let alert = alert.unwrap();
-    assert_eq!(alert.alert_type, AlertType::Ok);
+    assert_eq!(alert.is_none(), true);
 
     /*
         Test 2: Was Low 1 Minute ago, Now High Temp -> Alert!

backend/templates/coldchain/no_data.md

@@ -1,4 +1,4 @@
-**Monitoring connection lost**
+**📶 Monitoring connection lost!**
 
 **Facility**: {{ store_name }}
 {% if location_name %}

backend/templates/coldchain/recovered.md

@@ -1,4 +1,4 @@
-**✅ Sensor is now ok!**
+**{% if old_status == "NoData" %}✅ Monitoring connection restored{% else %}✅ Sensor is now ok!{% endif %}**
 
 **Facility**: {{ store_name }}
 {% if location_name %}
@@ -9,5 +9,5 @@
 **Date**: {{ last_data_time | date(format="%d %b %Y") }}
 **Time**: {{ last_data_time | date(format="%H:%M")}}
 
-**Temperature**: {{ temperature }}°C
+**Temperature**: {{ temperature }} °C
 **Last data received**: {{ data_age }} ago

backend/templates/coldchain/temperature.md

@@ -9,7 +9,7 @@
 **Date**: {{ last_data_time | date(format="%d %b %Y") }}
 **Time**: {{ last_data_time | date(format="%H:%M")}}
 
-**Temperature**: {{ temperature }}°C
+**Temperature**: {{ temperature }} °C
 {% if reminder_number %}
 **Reminder Number**: {{ reminder_number }}
 {% endif %}

frontend/packages/common/src/intl/locales/en/system.json

@@ -30,7 +30,7 @@
   "label.coldchain-low-temp-alerts": "Send low temperature excursion alerts when less than",
   "label.coldchain-no-data-alerts": "Send 'no temperature data' alert after",
   "label.coldchain-reminder-alerts": "Send follow-up reminders until alert is resolved, every",
-  "label.coldchain-message-alerts-resolved": "Send confirmation message when alert is resolved",
+  "label.coldchain-message-alerts-resolved": "Send confirmation message when monitoring connection is restored",
   "label.disable-user": "Disable User",
   "label.download-example": "Download an example file here",
   "label.edit-recipient": "Edit Recipient",
@@ -53,7 +53,7 @@
   "label.notification-type-TELEGRAM": "Telegram",
   "label.notification-type-UNKNOWN": "ERROR-UNSUPPORTED-NOTIFICATION-TYPE",
   "label.parameters-query-results": "Parameters and Query Results",
-  "label.parameters-save-local":"Save parameters in local storage",
+  "label.parameters-save-local": "Save parameters in local storage",
   "label.password-strength": "Password Strength",
   "label.password-warning": "Warning",
   "label.phone-number": "Phone Number",