fix(desktop): read run records saved before runs had a state as the state they meant

Author: waleedlatif1

apps/desktop/src/main/terminal/run-ledger.test.ts

@@ -114,6 +114,34 @@ describe('the tmux run ledger', () => {
     expect(createRunLedger(dir).list()).toEqual([{ ...RUN, state: 'stop' }])
   })
 
+  it('reads a record saved before runs had a state as the state it meant', () => {
+    const dir = scratch()
+    mkdirSync(dir, { recursive: true })
+    const { state: _state, ...saved } = RUN
+    const legacy = {
+      'run-started': { delivered: false },
+      'run-delivered': { delivered: true },
+      'run-stop': { delivered: false, mustStop: true },
+      // A stop wins over an acknowledgement.
+      'run-stop-delivered': { delivered: true, mustStop: true },
+    }
+    for (const [runId, fields] of Object.entries(legacy)) {
+      writeFileSync(join(dir, `${runId}.json`), JSON.stringify({ ...saved, runId, ...fields }))
+    }
+
+    const states = Object.fromEntries(
+      createRunLedger(dir)
+        .list()
+        .map((record) => [record.runId, record.state])
+    )
+    expect(states).toEqual({
+      'run-started': 'started',
+      'run-delivered': 'delivered',
+      'run-stop': 'stop',
+      'run-stop-delivered': 'stop',
+    })
+  })
+
   it('finds the run a call started, a previous process recorded it or this one', () => {
     const dir = scratch()
     // Recovery may hand the model the result of a previous process's call.

apps/desktop/src/main/terminal/run-ledger.ts

@@ -52,16 +52,31 @@ export interface RunLedger {
 /** Run tags are generated ids; anything else in the directory is not a record. */
 const RUN_ID = /^[A-Za-z0-9_-]{1,128}$/
 
+/** A record as saved: the current shape, or the earlier one with `delivered` and `mustStop`. */
+type SavedRecord = Partial<RunRecord> & { delivered?: unknown; mustStop?: unknown }
+
+/**
+ * The record's state. A record from before `state` existed (a released build wrote them) is read
+ * as the state it meant: `mustStop` as `stop`, which wins, then `delivered` as `delivered`.
+ */
+function stateOf(saved: SavedRecord): RunState | null {
+  if (RUN_STATES.includes(saved.state as RunState)) return saved.state as RunState
+  if (typeof saved.delivered !== 'boolean') return null
+  if (saved.mustStop === true) return 'stop'
+  return saved.delivered ? 'delivered' : 'started'
+}
+
 function parseRecord(text: string): RunRecord | null {
   try {
-    const parsed = JSON.parse(text) as Partial<RunRecord>
+    const parsed = JSON.parse(text) as SavedRecord
+    const state = stateOf(parsed)
     if (
       typeof parsed.runId === 'string' &&
       RUN_ID.test(parsed.runId) &&
       typeof parsed.pane === 'string' &&
       /^%\d+$/.test(parsed.pane) &&
       typeof parsed.callId === 'string' &&
-      RUN_STATES.includes(parsed.state as RunState) &&
+      state &&
       typeof parsed.socket === 'string' &&
       parsed.socket.startsWith('/')
     ) {
@@ -70,7 +85,7 @@ function parseRecord(text: string): RunRecord | null {
         pane: parsed.pane,
         socket: parsed.socket,
         callId: parsed.callId,
-        state: parsed.state as RunState,
+        state,
       }
     }
   } catch {