Refactor contact management in MyMesh: replace lazy write delay with a debounced save mechanism. Introduce methods to track contact changes and ensure contacts are saved if modified before shutdown. Update UI tasks to flush contacts if dirty during reboot and power off.

Author: ViezeVingertjes

examples/companion_radio/MyMesh.cpp

@@ -80,7 +80,8 @@
 #define FLOOD_SEND_TIMEOUT_FACTOR       16.0f
 #define DIRECT_SEND_PERHOP_FACTOR       6.0f
 #define DIRECT_SEND_PERHOP_EXTRA_MILLIS 250
-#define LAZY_CONTACTS_WRITE_DELAY       5000
+#define CONTACTS_SAVE_QUIET_WINDOW_MS   60000   // save after this period (1 minute) of no structural changes
+#define CONTACTS_SAVE_MAX_WINDOW_MS     300000  // but never delay beyond this total coalesce window (5 minutes)
 
 #define PUBLIC_GROUP_PSK                "izOH6cXN6mrJ5e26oRXNcg=="
 
@@ -127,6 +128,15 @@ void MyMesh::writeDisabledFrame() {
   _serial->writeFrame(buf, 1);
 }
 
+void MyMesh::markContactsChanged() {
+  unsigned long now = _ms->getMillis();
+  contacts_last_change = now;
+  if (!contacts_dirty) {
+    contacts_dirty = true;
+    contacts_first_change = now;
+  }
+}
+
 void MyMesh::writeContactRespFrame(uint8_t code, const ContactInfo &contact) {
   int i = 0;
   out_frame[i++] = code;
@@ -268,8 +278,6 @@ void MyMesh::onDiscoveredContact(ContactInfo &contact, bool is_new, uint8_t path
     p->path_len = path_len;
     memcpy(p->path, path, p->path_len);
   }
-
-  dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY);
 }
 
 static int sort_by_recent(const void *a, const void *b) {
@@ -290,8 +298,6 @@ void MyMesh::onContactPathUpdated(const ContactInfo &contact) {
   out_frame[0] = PUSH_CODE_PATH_UPDATED;
   memcpy(&out_frame[1], contact.id.pub_key, PUB_KEY_SIZE);
   _serial->writeFrame(out_frame, 1 + PUB_KEY_SIZE); // NOTE: app may not be connected
-
-  dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY);
 }
 
 bool MyMesh::processAck(const uint8_t *data) {
@@ -374,8 +380,6 @@ void MyMesh::onCommandDataRecv(const ContactInfo &from, mesh::Packet *pkt, uint3
 void MyMesh::onSignedMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp,
                                  const uint8_t *sender_prefix, const char *text) {
   markConnectionActive(from);
-  // from.sync_since change needs to be persisted
-  dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY);
   queueMessage(from, TXT_TYPE_SIGNED_PLAIN, pkt, sender_timestamp, sender_prefix, 4, text);
 }
 
@@ -641,7 +645,8 @@ MyMesh::MyMesh(mesh::Radio &radio, mesh::RNG &rng, mesh::RTCClock &rtc, SimpleMe
   clearPendingReqs();
   next_ack_idx = 0;
   sign_data = NULL;
-  dirty_contacts_expiry = 0;
+  contacts_dirty = false;
+  contacts_last_change = contacts_first_change = 0;
   memset(advert_paths, 0, sizeof(advert_paths));
 
   // defaults
@@ -940,8 +945,6 @@ void MyMesh::handleCmdFrame(size_t len) {
     ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE);
     if (recipient) {
       recipient->out_path_len = -1;
-      // recipient->lastmod = ??   shouldn't be needed, app already has this version of contact
-      dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY);
       writeOKFrame();
     } else {
       writeErrFrame(ERR_CODE_NOT_FOUND); // unknown contact
@@ -953,15 +956,15 @@ void MyMesh::handleCmdFrame(size_t len) {
     if (recipient) {
       updateContactFromFrame(*recipient, last_mod, cmd_frame, len);
       recipient->lastmod = last_mod;
-      dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY);
+      markContactsChanged();
       writeOKFrame();
     } else {
       ContactInfo contact;
       updateContactFromFrame(contact, last_mod, cmd_frame, len);
       contact.lastmod = last_mod;
       contact.sync_since = 0;
       if (addContact(contact)) {
-        dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY);
+        markContactsChanged();
         writeOKFrame();
       } else {
         writeErrFrame(ERR_CODE_TABLE_FULL);
@@ -971,7 +974,7 @@ void MyMesh::handleCmdFrame(size_t len) {
     uint8_t *pub_key = &cmd_frame[1];
     ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE);
     if (recipient && removeContact(*recipient)) {
-      dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY);
+      markContactsChanged();
       writeOKFrame();
     } else {
       writeErrFrame(ERR_CODE_NOT_FOUND); // not found, or unable to remove
@@ -1116,9 +1119,7 @@ void MyMesh::handleCmdFrame(size_t len) {
     savePrefs();
     writeOKFrame();
   } else if (cmd_frame[0] == CMD_REBOOT && memcmp(&cmd_frame[1], "reboot", 6) == 0) {
-    if (dirty_contacts_expiry) { // is there are pending dirty contacts write needed?
-      saveContacts();
-    }
+    saveContactsIfDirty();
     board.reboot();
   } else if (cmd_frame[0] == CMD_GET_BATT_AND_STORAGE) {
     uint8_t reply[11];
@@ -1587,6 +1588,7 @@ void MyMesh::checkCLIRescueCmd() {
       }
 
     } else if (strcmp(cli_command, "reboot") == 0) {
+      saveContactsIfDirty();
       board.reboot();  // doesn't return
     } else {
       Serial.println("  Error: unknown command");
@@ -1632,10 +1634,16 @@ void MyMesh::loop() {
     checkSerialInterface();
   }
 
-  // is there are pending dirty contacts write needed?
-  if (dirty_contacts_expiry && millisHasNowPassed(dirty_contacts_expiry)) {
-    saveContacts();
-    dirty_contacts_expiry = 0;
+  // Debounced save
+  if (contacts_dirty) {
+    unsigned long now = _ms->getMillis();
+    bool quiet_met = (now - contacts_last_change) >= CONTACTS_SAVE_QUIET_WINDOW_MS;
+    bool max_reached = (now - contacts_first_change) >= CONTACTS_SAVE_MAX_WINDOW_MS;
+    if (quiet_met || max_reached) {
+      saveContacts();
+      contacts_dirty = false;
+      contacts_last_change = contacts_first_change = 0;
+    }
   }
 
 #ifdef DISPLAY_CLASS

examples/companion_radio/MyMesh.h

@@ -101,6 +101,9 @@ class MyMesh : public BaseChatMesh, public DataStoreHost {
 
   int  getRecentlyHeard(AdvertPath dest[], int max_num);
 
+  bool isContactsDirty() const { return contacts_dirty; }
+  void flushContactsIfDirty() { saveContactsIfDirty(); }
+
 protected:
   float getAirtimeBudgetFactor() const override;
   int getInterferenceThreshold() const override;
@@ -136,6 +139,15 @@ class MyMesh : public BaseChatMesh, public DataStoreHost {
   uint32_t calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t path_len) const override;
   void onSendTimeout() override;
 
+  bool hasDirtyContacts() const { return contacts_dirty; }
+  void saveContactsIfDirty() {
+    if (contacts_dirty) {
+      saveContacts();
+      contacts_dirty = false;
+      contacts_last_change = contacts_first_change = 0;
+    }
+  }
+
   // DataStoreHost methods
   bool onContactLoaded(const ContactInfo& contact) override { return addContact(contact); }
   bool getContactForSave(uint32_t idx, ContactInfo& contact) override { return getContactByIdx(idx, contact); }
@@ -147,6 +159,7 @@ class MyMesh : public BaseChatMesh, public DataStoreHost {
   }
 
 private:
+  void markContactsChanged();
   void writeOKFrame();
   void writeErrFrame(uint8_t err_code);
   void writeDisabledFrame();
@@ -189,7 +202,10 @@ class MyMesh : public BaseChatMesh, public DataStoreHost {
   uint8_t app_target_ver;
   uint8_t *sign_data;
   uint32_t sign_data_len;
-  unsigned long dirty_contacts_expiry;
+  
+  bool contacts_dirty;
+  unsigned long contacts_last_change;
+  unsigned long contacts_first_change;
 
   uint8_t cmd_frame[MAX_FRAME_SIZE + 1];
   uint8_t out_frame[MAX_FRAME_SIZE + 1];

examples/companion_radio/ui-new/UITask.cpp

@@ -472,9 +472,11 @@ void UITask::shutdown(bool restart){
   #endif // PIN_BUZZER
 
   if (restart) {
+    the_mesh.flushContactsIfDirty();
     _board->reboot();
   } else {
     _display->turnOff();
+    the_mesh.flushContactsIfDirty();
     _board->powerOff();
   }
 }

examples/companion_radio/ui-orig/UITask.cpp

@@ -292,10 +292,13 @@ void UITask::shutdown(bool restart){
 
   #endif // PIN_BUZZER
 
-  if (restart)
+  if (restart) {
+    the_mesh.flushContactsIfDirty();
     _board->reboot();
-  else
+  } else {
+    the_mesh.flushContactsIfDirty();
     _board->powerOff();
+  }
 }
 
 void UITask::loop() {