dsh-autorestart 0.3.5 → 0.5.0

package/lib/checkpoint.js

@@ -105,6 +105,7 @@ const TOP_LEVEL_KEYS = new Set([
   'sessions',
   'parkedGoals',
   'disarmedGoals',
+  'seenFeatureVersions',
   'updatedAt',
 ]);
 
@@ -172,6 +173,7 @@ export function createEmptyState(now = Date.now()) {
     phase: 'idle',
     restart: null,
     sessions: {},
+    seenFeatureVersions: {},
     updatedAt: now,
   };
 }
@@ -277,6 +279,33 @@ function normalizeDisarmedGoals(raw) {
   return { disarmedGoals, changed };
 }
 
+/**
+ * Normalize the record of the feature announcements the user has already seen.
+ *
+ * The shape is `{ [feature]: version }`: the id of the feature and the version
+ * of the plugin that announced it. A record whose version is not a string is
+ * dropped — an unreadable record must never hide an announcement for ever,
+ * so a broken entry makes the announcement show up again instead.
+ *
+ * @param {unknown} raw
+ * @returns {{ seenFeatureVersions: Record<string, string>, changed: boolean }}
+ */
+function normalizeSeenFeatureVersions(raw) {
+  if (!isObject(raw)) {
+    return { seenFeatureVersions: {}, changed: raw !== null && raw !== undefined };
+  }
+  const seenFeatureVersions = {};
+  let changed = false;
+  for (const [feature, version] of Object.entries(raw)) {
+    if (typeof version !== 'string' || version === '') {
+      changed = true;
+      continue;
+    }
+    seenFeatureVersions[feature] = version;
+  }
+  return { seenFeatureVersions, changed };
+}
+
 /**
  * Normalize the handoff record of a session: `{ handedOffTo, handoffAt, carriedChars }`.
  * A missing record stays `null`; a corrupt one is dropped instead of being thrown on.
@@ -536,6 +565,15 @@ export function normalizeState(raw, now = Date.now()) {
     if (disarmed.changed) repaired = true;
   }
 
+  // The record of the feature announcements the user has already seen. It
+  // survives a restart of the Host: an announcement that was shown once must
+  // not come back with the next boot.
+  if (raw.seenFeatureVersions != null) {
+    const seen = normalizeSeenFeatureVersions(raw.seenFeatureVersions);
+    state.seenFeatureVersions = seen.seenFeatureVersions;
+    if (seen.changed) repaired = true;
+  }
+
   return { state, repaired };
 }