Attempt at improving messages/messagegui to stop un-needed writes to storage (and so allow music info to be stored too)

Author: gfwilliams

apps/android/ChangeLog

@@ -47,3 +47,4 @@
       version 85 when it's out)
 0.43: Ensure listRecs doesn't list old-style recorded tracks (Otherwise Gadgetbridge fails parsing the filename)
 0.44: Pass HTTP request timeout to Gadgetbridge
+0.45: Don't pass on music messages if nothing has changed

apps/android/lib.js

@@ -2,7 +2,7 @@ exports.gbSend = function(message) {
   Bluetooth.println("");
   Bluetooth.println(JSON.stringify(message));
 }
-let lastMsg, // for music messages - may not be needed now...
+let lastMsg, // for GadgetBridge workaround - may not be needed now...
     gpsState = {}, // keep information on GPS via Gadgetbridge
     settings = Object.assign({rp:true,as:true,vibrate:".."},
       require("Storage").readJSON("android.settings.json",1)||{}
@@ -38,6 +38,8 @@ exports.gbHandler = (event) => {
     },
     // {t:"musicstate", state:"play/pause",position,shuffle,repeat}
     "musicstate" : function() {
+      if (event.state===exports.musicState) return; // no change - avoid spamming message handling with identical messages
+      exports.musicState = event.state;
       require("messages").pushMessage({t:"modify",id:"music",title:"Music",state:event.state});
     },
     // {t:"musicinfo", artist,album,track,dur,c(track count),n(track num}

apps/android/metadata.json

@@ -2,7 +2,7 @@
   "id": "android",
   "name": "Android Integration",
   "shortName": "Android",
-  "version": "0.44",
+  "version": "0.45",
   "description": "Display notifications/music/etc sent from the Gadgetbridge app on Android. This replaces the old 'Gadgetbridge' Bangle.js widget.",
   "icon": "app.png",
   "tags": "tool,system,messages,notifications,gadgetbridge",

apps/messagegui/ChangeLog

@@ -121,3 +121,6 @@
 0.89: Fix bugs related to empty titles and bodies
 0.90: New settings for when to auto show new message (never, on clocks -
       default, if locked, always)
+0.91: Ensure music messages are actually saved in the messages list so the currently playing track persists
+      Use E.on("kill" event to ensure we always save messages before changing app
+      Simplify message handling now messages lib automatically applies Bangle.messages

apps/messagegui/app.js

@@ -61,11 +61,15 @@ to the clock. */
 var unreadTimeout;
 /// List of all our messages
 var MESSAGES = require("messages").getMessages();
-if (Bangle.MESSAGES) {
-  // fast loading messages
-  Bangle.MESSAGES.forEach(m => require("messages").apply(m, MESSAGES));
-  delete Bangle.MESSAGES;
+delete Bangle.MESSAGES; // now we're storing all messages and handling them ourselves
+if (Bangle.MESSAGES_KILL_HANDLER) {
+  E.removeListener("kill", Bangle.MESSAGES_KILL_HANDLER);
+  delete Bangle.MESSAGES_KILL_HANDLER;
 }
+E.on("kill", function() { // now ensure we write messages on exit
+  // if we write the exact same data it's ok - Bangle.js won't create a new file
+  require("messages").write(MESSAGES, true/*force*/);
+});
 
 var onMessagesModified = function(type,msg) {
   if (msg.handled) return;
@@ -86,10 +90,6 @@ var onMessagesModified = function(type,msg) {
 };
 Bangle.on("message", onMessagesModified);
 
-function saveMessages() {
-  require("messages").write(MESSAGES);
-}
-E.on("kill", saveMessages);
 
 /* Listens to drag events to allow the user to swipe up/down to change message on Bangle.js 2
 returns dragHandler which should then be removed with Bangle.removeListener("drah", dragHandler); on exit */

apps/messagegui/lib.js

@@ -1,11 +1,3 @@
-// Will calling Bangle.load reset everything? if false, we fast load
-function loadWillReset() {
-  return Bangle.load === load || !Bangle.uiRemove;
-    /* FIXME: Maybe we need a better way of deciding if an app will
-    be fast loaded than just hard-coding a Bangle.uiRemove check.
-    Bangle.load could return a bool (as the load doesn't happen immediately). */
-}
-
 /**
  * Listener set up in boot.js, calls into here to keep boot.js short
  */
@@ -40,27 +32,24 @@ exports.listener = function(type, msg) {
     (autoOpen === 1 && Bangle.CLOCK) || (autoOpen === 2 && (Bangle.isLocked() || Bangle.CLOCK)) || autoOpen === 3 ||
       msg.important
   ); // should we load the messages app?
-  if (type==="music") {
-    if (Bangle.CLOCK && msg.state && msg.title && appSettings.openMusic) loadMessages = true;
-    else return;
-  }
+  if (type==="music")
+    loadMessages = Bangle.CLOCK && msg.state && msg.title && appSettings.openMusic;
+
   // Write the message to Bangle.MESSAGES. We'll deal with it in messageTimeout below
   if (!Bangle.MESSAGES) Bangle.MESSAGES = [];
   require("messages").apply(msg, Bangle.MESSAGES);
   if (!Bangle.MESSAGES.length) delete Bangle.MESSAGES;
-  const saveToFlash = () => {
-    // save messages from RAM to flash if we decide not to launch app
-    // We apply all of Bangle.MESSAGES here in one write
-    if (!Bangle.MESSAGES || !Bangle.MESSAGES.length) return;
-    let messages = require("messages").getMessages(msg);
-    (Bangle.MESSAGES || []).forEach(m => require("messages").apply(m, messages));
-    require("messages").write(messages);
-    delete Bangle.MESSAGES;
+  else if (!Bangle.MESSAGES_KILL_HANDLER) { // ensure we save on exit now
+    Bangle.MESSAGES_KILL_HANDLER = function() {
+      if (!Bangle.MESSAGES || !Bangle.MESSAGES.length) return;
+      let messages = require("messages").getMessages(msg);
+      require("messages").write(messages);
+      delete Bangle.MESSAGES;
+    };
+    E.on("kill", Bangle.MESSAGES_KILL_HANDLER);
   }
   msg.handled = true;
-  if ((msg.t!=="add" || !msg.new) && (type!=="music")) // music always has t:"modify"
-    return saveToFlash();
-
+  if (!msg.new) return; //  if it's not new, we don't do anything - just save on exit
   const quiet = (require("Storage").readJSON("setting.json", 1) || {}).quiet;
   const unlockWatch = appSettings.unlockWatch;
   // don't auto-open messages in quiet mode if quietNoAutOpn is true
@@ -71,20 +60,16 @@ exports.listener = function(type, msg) {
   exports.messageTimeout = setTimeout(function() {
     delete exports.messageTimeout;
     if (!Bangle.MESSAGES) return; // message was removed during the delay
-    if (type!=="music") {
-      if (!loadMessages) {
-        // not opening the app, just buzz
-        saveToFlash();
-        return require("messages").buzz(msg.src);
-      }
+    if (!loadMessages) { // not opening the app, just buzz
+      if (type!=="music") require("messages").buzz(msg.src); // buzz ignores quiet mode
+    } else {
       if (!quiet && unlockWatch) {
         Bangle.setLocked(false);
         Bangle.setLCDPower(1); // turn screen on
       }
+      // now open the GUI
+      exports.open(msg);
     }
-    // if loading the gui would reload everything, we must save our messages
-    if (loadWillReset()) saveToFlash();
-    exports.open(msg);
   }, 500);
 };
 
@@ -93,19 +78,13 @@ exports.listener = function(type, msg) {
  * @param {object} msg
  */
 exports.open = function(msg) {
+  // force a display by setting it as new and ensuring it ends up at the beginning of messages list
   if (msg && msg.id) {
-    // force a display by setting it as new and ensuring it ends up at the beginning of messages list
     msg.new = 1;
-    if (loadWillReset()) {
-      // no fast loading: store message to load in flash - `msg` will be put in first
-      require("messages").save(msg, {force: 1});
-    } else {
-      // fast load - putting it at the end of Bangle.MESSAGES ensures it goes at the start of messages list
-      if (!Bangle.MESSAGES) Bangle.MESSAGES=[];
-      Bangle.MESSAGES = Bangle.MESSAGES.filter(m => m.id!=msg.id)
-      Bangle.MESSAGES.push(msg); // putting at the
-    }
+    if (!Bangle.MESSAGES) Bangle.MESSAGES=[];
+    Bangle.MESSAGES = Bangle.MESSAGES.filter(m => m.id!=msg.id)
+    Bangle.MESSAGES.push(msg);
   }
-
+  // load the app
   Bangle.load((msg && msg.new && msg.id!=="music") ? "messagegui.new.js" : "messagegui.app.js");
-};
+};

apps/messagegui/metadata.json

@@ -2,7 +2,7 @@
   "id": "messagegui",
   "name": "Message UI",
   "shortName": "Messages",
-  "version": "0.90",
+  "version": "0.91",
   "description": "Default app to display notifications from iOS and Gadgetbridge/Android",
   "icon": "app.png",
   "type": "app",

apps/messages/ChangeLog

@@ -14,3 +14,5 @@
       Add Option to show widgets (Message GUI 0.86 removes them by default)
 0.68: New settings for when to auto show new message (never, on clocks -
       default, if locked, always)
+0.69: Remove .music field (which is not used - require("messages").getMessages().find(m=>m.id=="music") works fine)
+      Ensure .getMessages uses Bangle.MESSAGES to return the most up to date message info

apps/messages/lib.js

@@ -1,4 +1,3 @@
-exports.music = {};
 /**
  * Emit "message" event with appropriate type from Bangle
  * @param {object} msg
@@ -18,9 +17,7 @@ function emit(msg) {
 */
 exports.pushMessage = function(event) {
   // now modify/delete as appropriate
-  if (event.t==="remove") {
-    if (event.id==="music") exports.music = {};
-  } else { // add/modify
+  if (event.t!=="remove") { // add/modify
     if (event.t==="add") {
       if (event.new===undefined) event.new = true; // Assume it should be new
     } else if (event.t==="modify") {
@@ -29,10 +26,8 @@ exports.pushMessage = function(event) {
     }
 
     // combine musicinfo and musicstate events
-    if (event.id==="music") {
-      if (event.state==="play") event.new = true; // new track, or playback (re)started
-      event = Object.assign(exports.music, event);
-    }
+    if (event.id==="music" && event.state==="play")
+      event.new = true; // new track, or playback (re)started
   }
   // reset state (just in case)
   delete event.handled;
@@ -153,7 +148,9 @@ exports.clearAll = function() {
 }
 
 /**
- * Get saved messages
+ * Get saved messages. If Bangle.MESSAGES was set by messagegui (messages
+ * that aren't yet written) apply them to the messages we read so we get
+ * up to date info.
  *
  * Optionally pass in a message to apply to the list, this is for event handlers:
  * By passing the message from the event, you can make sure the list is up-to-date,
@@ -170,6 +167,7 @@ exports.clearAll = function() {
 exports.getMessages = function(withMessage) {
   let messages = require("Storage").readJSON("messages.json", true);
   messages = Array.isArray(messages) ? messages : []; // make sure we always return an array
+  (Bangle.MESSAGES || []).forEach(m => require("messages").apply(m, messages)); // apply any usaved messages
   if (withMessage && withMessage.id) exports.apply(withMessage, messages);
   return messages;
 };

apps/messages/metadata.json

@@ -1,7 +1,7 @@
 {
   "id": "messages",
   "name": "Messages",
-  "version": "0.68",
+  "version": "0.69",
   "description": "Library to handle, load and store message events received from Android/iOS",
   "icon": "app.png",
   "type": "module",