chore: Improve connection awareness

Author: zfields

Diff for: src/Arduino_NotecardConnectionHandler.cpp

@@ -162,9 +162,9 @@ int NotecardConnectionHandler::setWiFiCredentials (const String & ssid_, const S
   int result;
 
   // Validate the connection state is not in an initialization state
-  if (check() == NetworkConnectionState::INIT)
+  if (NetworkConnectionState::INIT == _current_net_connection_state)
   {
-    Debug.print(DBG_ERROR, F("Failed to set WiFi credentials. Connection has not been initialized."));
+    Debug.print(DBG_ERROR, F("Unable to set WiFi credentials. Connection to Notecard uninitialized."));
     result = NotecardCommunicationError::NOTECARD_ERROR_GENERIC;
   } else if (J *req = _notecard.newRequest("card.wifi")) {
     JAddStringToObject(req, "ssid", ssid_.c_str());
@@ -195,10 +195,11 @@ int NotecardConnectionHandler::setWiFiCredentials (const String & ssid_, const S
 
 const String & NotecardConnectionHandler::syncArduinoDeviceId (const String & device_id_)
 {
-  // Validate the connection state is not in an initialization state
-  if (check() == NetworkConnectionState::INIT)
+  // Validate the connection state is not uninitialized or in error state
+  if ((NetworkConnectionState::INIT == _current_net_connection_state)
+  || (NetworkConnectionState::ERROR == _current_net_connection_state))
   {
-    Debug.print(DBG_ERROR, F("Failed to sync Arduino Device ID. Connection has not been initialized."));
+    Debug.print(DBG_ERROR, F("Unable to sync Arduino Device ID. Connection to Notecard uninitialized or in error state."));
     return device_id_;
   }
 
@@ -249,23 +250,29 @@ int NotecardConnectionHandler::syncSecretDeviceKey (const String & secret_device
 {
   int result;
 
-  // Validate the connection state is not in an initialization state
-  if (check() == NetworkConnectionState::INIT)
+  // Validate the connection state is not uninitialized or in error state
+  if ((NetworkConnectionState::INIT == _current_net_connection_state)
+  || (NetworkConnectionState::ERROR == _current_net_connection_state))
   {
-    Debug.print(DBG_ERROR, F("Failed to sync Secret Device Key. Connection has not been initialized."));
+    Debug.print(DBG_ERROR, F("Unable to sync Secret Device Key. Connection to Notecard uninitialized or in error state."));
     result = NotecardCommunicationError::NOTECARD_ERROR_GENERIC;
   } else if (J *req = _notecard.newRequest("var.set")) {
     JAddStringToObject(req, "file", NOTEFILE_SECURE_DATABASE);
     JAddStringToObject(req, "name", "secret_device_key");
     if (secret_device_key_.length() > 0) {
       JAddStringToObject(req, "text", secret_device_key_.c_str());
     }
-    JAddBoolToObject(req, "live", true);
-    JAddBoolToObject(req, "sync", true);
+    if (NetworkConnectionState::CONNECTED == _current_net_connection_state) {
+      JAddBoolToObject(req, "live", true);
+      JAddBoolToObject(req, "sync", true);
+    }
     if (J *rsp = _notecard.requestAndResponse(req)) {
       // Check the response for errors
       if (NoteResponseError(rsp)) {
         const char *err = JGetString(rsp, "err");
+        if (NoteErrorContains(err, "{hub-not-connected}")) {
+          _current_net_connection_state = NetworkConnectionState::DISCONNECTED;
+        }
         Debug.print(DBG_ERROR, F("%s"), err);
         Debug.print(DBG_ERROR, F("Failed to sync Secret Device Key."));
         result = NotecardCommunicationError::NOTECARD_ERROR_GENERIC;
@@ -372,13 +379,19 @@ int NotecardConnectionHandler::write(const uint8_t * buf_, size_t size_)
 {
   int result;
 
-  if (J * req = _notecard.newRequest("note.add")) {
+  // Validate the connection state is not uninitialized or in error state
+  if ((NetworkConnectionState::INIT == _current_net_connection_state)
+  || (NetworkConnectionState::ERROR == _current_net_connection_state))
+  {
+    Debug.print(DBG_ERROR, F("Unable to write message. Connection to Notecard uninitialized or in error state."));
+    result = NotecardCommunicationError::NOTECARD_ERROR_GENERIC;
+  } else if (J * req = _notecard.newRequest("note.add")) {
     JAddStringToObject(req, "file", NOTEFILE_SECURE_OUTBOUND);
     if (buf_) {
       JAddBinaryToObject(req, "payload", buf_, size_);
     }
-    // Queue the Note when `_keep_alive` is disabled
-    if (_keep_alive) {
+    // Queue the Note when `_keep_alive` is disabled or not connected to Notehub
+    if (_keep_alive && (NetworkConnectionState::CONNECTED == _current_net_connection_state)) {
       JAddBoolToObject(req, "live", true);
       JAddBoolToObject(req, "sync", true);
     }
@@ -387,6 +400,9 @@ int NotecardConnectionHandler::write(const uint8_t * buf_, size_t size_)
       J * rsp = _notecard.requestAndResponse(req);
       if (NoteResponseError(rsp)) {
         const char *err = JGetString(rsp, "err");
+        if (NoteErrorContains(err, "{hub-not-connected}")) {
+          _current_net_connection_state = NetworkConnectionState::DISCONNECTED;
+        }
         Debug.print(DBG_ERROR, F("%s\n"), err);
         result = NotecardCommunicationError::NOTECARD_ERROR_GENERIC;
       } else {
@@ -786,11 +802,11 @@ bool NotecardConnectionHandler::configureConnection (bool connect_) const
     // Configure the connection mode based on the `connect_` parameter
     if (connect_) {
       JAddStringToObject(req, "mode", "continuous");
-      JAddIntToObject(req, "inbound", 15);  // Unnecessary fail safe value
+      JAddIntToObject(req, "inbound", 15);  // Fail-safe (theoretically unnecessary)
       JAddBoolToObject(req, "sync", true);
     } else {
       JAddStringToObject(req, "mode", "periodic");
-      JAddIntToObject(req, "inbound", 1440);  //TODO: Revisit this value
+      JAddIntToObject(req, "inbound", 1440);  // Once daily
       JAddIntToObject(req, "outbound", -1);
       JAddStringToObject(req, "vinbound", "-");
       JAddStringToObject(req, "voutbound", "-");
@@ -939,16 +955,23 @@ int NotecardConnectionHandler::initiateNotehubSync (void) const
 int NotecardConnectionHandler::notehubLogging (bool enable_) const
 {
   int result;
+  Debug.print(DBG_INFO, F("%sabling Notehub logging..."), (enable_ ? "En" : "Dis"));
 
-  if (J * req = _notecard.newRequest("note.add")) {
+  // Validate the connection state is not uninitialized or in error state
+  if ((NetworkConnectionState::INIT == _current_net_connection_state)
+  || (NetworkConnectionState::ERROR == _current_net_connection_state))
+  {
+    Debug.print(DBG_ERROR, F("Unable to %sable Notehub logging. Connection to Notecard uninitialized or in error state."), (enable_ ? "en" : "dis"));
+    result = NotecardCommunicationError::NOTECARD_ERROR_GENERIC;
+  } else if (J * req = _notecard.newRequest("note.add")) {
     JAddStringToObject(req, "file", NOTEFILE_SECURE_OUTBOUND);
     if (enable_) {
       JAddBinaryToObject(req, "payload", "1", sizeof("1"));
     } else {
       JAddBinaryToObject(req, "payload", "0", sizeof("0"));
     }
-    // Queue the Note when `_keep_alive` is disabled
-    if (_keep_alive) {
+    // Queue the Note when `_keep_alive` is disabled or not connected to Notehub
+    if (_keep_alive && (NetworkConnectionState::CONNECTED == _current_net_connection_state)) {
       JAddBoolToObject(req, "live", true);
       JAddBoolToObject(req, "sync", true);
     }
@@ -957,6 +980,9 @@ int NotecardConnectionHandler::notehubLogging (bool enable_) const
       J * rsp = _notecard.requestAndResponse(req);
       if (NoteResponseError(rsp)) {
         const char *err = JGetString(rsp, "err");
+        if (NoteErrorContains(err, "{hub-not-connected}")) {
+          _current_net_connection_state = NetworkConnectionState::DISCONNECTED;
+        }
         Debug.print(DBG_ERROR, F("%s\n"), err);
         result = NotecardCommunicationError::NOTECARD_ERROR_GENERIC;
       } else {

Diff for: src/Arduino_NotecardConnectionHandler.h

@@ -15,8 +15,6 @@
    a commercial license, send an email to [email protected].
 */
 
-//TODO: Understand how `_keep_alive` is updated and used in the `ConnectionHandler` class
-
 #ifndef ARDUINO_NOTECARD_CONNECTION_HANDLER_H_
 #define ARDUINO_NOTECARD_CONNECTION_HANDLER_H_
 
@@ -76,12 +74,10 @@ class NotecardConnectionHandler final : public ConnectionHandler
     // Notehub Logging
     inline int disableNotehubLogging (void) const
     {
-      Debug.print(DBG_INFO, F("Disabling Notehub logging..."));
       return notehubLogging(false);
     }
     inline int enableNotehubLogging (void) const
     {
-      Debug.print(DBG_INFO, F("Enabling Notehub logging..."));
       return notehubLogging(true);
     }