[messages][messagegui] - fix music info handling

Author: kidneyhex

apps/messagegui/ChangeLog

@@ -119,3 +119,4 @@
 0.87: Make choosing of font size more repeatable
 0.88: Adjust padding calculation so messages are spaced out properly even when using international fonts
 0.89: Fix bugs related to empty titles and bodies
+0.90: Persist music info; Fix old music info copying into new music messages

apps/messagegui/lib.js

@@ -37,8 +37,11 @@ exports.listener = function(type, msg) {
   const appSettings = require("Storage").readJSON("messages.settings.json", 1) || {};
   let loadMessages = (Bangle.CLOCK || 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 (Bangle.CLOCK && msg.state && msg.title && appSettings.openMusic) {
+      loadMessages = true;
+    } else {
+      if (persistMusicInfo(msg)) return; // handled
+    }
   }
   // Write the message to Bangle.MESSAGES. We'll deal with it in messageTimeout below
   if (!Bangle.MESSAGES) Bangle.MESSAGES = [];
@@ -48,7 +51,9 @@ exports.listener = function(type, msg) {
     // 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);
+    // Load saved messages without applying the current msg to avoid
+    // applying it twice (getMessages(msg) would apply it already).
+    let messages = require("messages").getMessages();
     (Bangle.MESSAGES || []).forEach(m => require("messages").apply(m, messages));
     require("messages").write(messages);
     delete Bangle.MESSAGES;
@@ -105,3 +110,39 @@ exports.open = function(msg) {
 
   Bangle.load((msg && msg.new && msg.id!=="music") ? "messagegui.new.js" : "messagegui.app.js");
 };
+
+/**
+ * Persist info fields from music messages
+ * @param {*} msg Music message
+ * @returns true if the message was handled
+ */
+function persistMusicInfo(msg) {
+  msg.handled = true;
+  // if nothing to persist - return that it's handled
+  if (msg.artist === undefined && msg.track === undefined && msg.album === undefined && msg.dur === undefined) return true;
+
+  const a = msg.artist, t = msg.track, al = msg.album, d = msg.dur;
+
+  // try to find the last music message
+  const messagesMod = require("messages");
+  const messages = messagesMod.getMessages();
+  const mIdx = messages.findIndex(m => m.id === "music");
+  const stored = mIdx >= 0 ? messages[mIdx] : null;
+
+  if (!stored) {
+    // new msg, always write
+    const newEntry = { id: "music", artist: a, track: t, album: al, dur: d };
+    messages.unshift(Object.assign({}, newEntry));
+    messagesMod.write(messages);
+  } else {
+    // existing msg, only write if something changed
+    if (stored.artist !== a || stored.track !== t || stored.album !== al || stored.dur !== d) {
+      stored.artist = a;
+      stored.track = t;
+      stored.album = al;
+      stored.dur = d;
+      messagesMod.write(messages);
+    }
+  }
+  return true;
+}

apps/messagegui/metadata.json

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

apps/messages/ChangeLog

@@ -12,3 +12,4 @@
 0.66: Fix 'Auto-Open Unread Msg' polarity - previously checking the box would ignore unread messages
 0.67: Ensure default vibration pattern is longer
       Add Option to show widgets (Message GUI 0.86 removes them by default)
+0.68: Fix perserving music info between messages

apps/messages/lib.js

@@ -24,14 +24,20 @@ exports.pushMessage = function(event) {
     if (event.t==="add") {
       if (event.new===undefined) event.new = true; // Assume it should be new
     } else if (event.t==="modify") {
-      const old = exports.getMessages().find(m => m.id===event.id);
-      if (old) event = Object.assign(old, event);
+      // For non-music messages, merge with stored message 
+      // For music, skip merging to avoid old info
+      if (event.id !== "music") {
+        const old = exports.getMessages().find(m => m.id===event.id);
+        if (old) event = Object.assign(old, 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);
+      // Merge new msg into current music to preserve info
+      exports.music = Object.assign(exports.music, event);
+      event = exports.music;
     }
   }
   // reset state (just in case)
@@ -72,7 +78,7 @@ exports.apply = function(event, messages) {
     messages.splice(mIdx, 1);
   } else if (event.t==="add") {
     if (mIdx>=0) messages.splice(mIdx, 1); // duplicate ID! erase previous version
-    messages.unshift(event); // add at the beginning
+    messages.unshift(Object.assign({}, event)); // add a copy at the beginning
   } else if (event.t==="modify") {
     if (mIdx>=0) messages[mIdx] = Object.assign(messages[mIdx], event);
     else messages.unshift(event);

apps/messages/metadata.json

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