Skip to content

[codex] Structure desktop update persistence errors#3261

Merged
juliusmarminge merged 8 commits into
mainfrom
codex/desktop-update-settings-errors
Jun 21, 2026
Merged

[codex] Structure desktop update persistence errors#3261
juliusmarminge merged 8 commits into
mainfrom
codex/desktop-update-settings-errors

Conversation

@juliusmarminge

@juliusmarminge juliusmarminge commented Jun 20, 2026

Copy link
Copy Markdown
Member

Summary

  • add channel context to update-channel persistence and in-progress errors while retaining the exact settings-write cause chain
  • keep user-facing persistence messages structural and independent of nested cause messages
  • remove the valueless desktop settings error constructor wrapper and instantiate errors at each failure boundary
  • use catchTags for the three exact Electron updater failure channels
  • add focused coverage for requested-channel context, union predicates, stable messages, and cause identity

Validation

  • vp test apps/desktop/src/updates/DesktopUpdates.test.ts apps/desktop/src/settings/DesktopAppSettings.test.ts
  • vp check (0 errors; 20 pre-existing unrelated warnings)
  • vp run typecheck

Note

Medium Risk
Touches desktop update actions, quit/install flow, and what users see on failure, but behavior is tightened with recovery paths and broad unit tests rather than new external surface area.

Overview
Restructures desktop auto-update error handling so user-visible state and logs use stable, structural messages instead of raw updater or disk failure text, while preserving full cause chains on typed errors for programmatic handling.

Update channel changes now fail with DesktopUpdateChannelPersistenceError (channel + DesktopSettingsWriteError cause), DesktopUpdateActionInProgressError includes the requested channel, and isDesktopUpdateSetChannelError guards the set-channel error union. Settings writes drop the writeError helper and construct DesktopSettingsWriteError at each I/O boundary.

Check, download, and install use Effect.catchTags for the three Electron updater failure types; unexpected defects during download/install map to DesktopUpdateUnexpectedActionError, with state rollback on interrupt and quitting/install flags reset when install setup fails. Background pollers and malformed updater events get dedicated tagged errors; raw error events become DesktopUpdaterReportedError with bounded log annotations (errorTag, channel, etc.).

Tests cover cause identity, secret-free messages, download retry after interrupt, and persistence failure wrapping.

Reviewed by Cursor Bugbot for commit 5c21085. Bugbot is set up for automated code reviews on this repo. Configure here.

Note

Structure desktop update persistence errors with bounded messages and typed error classes

  • Introduces several new tagged error classes in DesktopUpdates.ts: DesktopUpdatePollerError, DesktopUpdateEventHandlingError, DesktopUpdaterReportedError, DesktopUpdateUnexpectedActionError, and DesktopUpdateChannelPersistenceError, replacing generic catch-all error handling.
  • DesktopUpdateActionInProgressError now includes a requestedChannel field and a more specific message; setChannel maps persistence failures to DesktopUpdateChannelPersistenceError with channel and underlying cause.
  • Error state and logs now use bounded messages with structured annotations (e.g. { errorTag, channel }) instead of raw cause strings, preventing secret leakage.
  • Download and install actions now restore state on interruption or unexpected failure via Effect.onInterrupt and Effect.catchCause.
  • Adds isDesktopUpdateSetChannelError type guard and extensive test coverage in DesktopUpdates.test.ts for error preservation, recovery, and channel persistence behavior.

Macroscope summarized 5c21085.

@coderabbitai

coderabbitai Bot commented Jun 20, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 7511e9c7-6fc0-4910-a49a-d46a9d1035a0

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/desktop-update-settings-errors

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added vouch:trusted PR author is trusted by repo permissions or the VOUCHED list. size:L 100-499 changed lines (additions + deletions). labels Jun 20, 2026
@macroscopeapp

macroscopeapp Bot commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

Approvability

Verdict: Approved

Refactors desktop update error handling to use structured error classes with sanitized messages that don't leak sensitive information. Includes comprehensive test coverage. No behavioral changes beyond improved error presentation and proper interrupt handling.

You can customize Macroscope's approvability policy. Learn more.

macroscopeapp[bot]
macroscopeapp Bot previously approved these changes Jun 20, 2026
@macroscopeapp macroscopeapp Bot dismissed their stale review June 20, 2026 13:39

Dismissing prior approval to re-evaluate 12714d8

macroscopeapp[bot]
macroscopeapp Bot previously approved these changes Jun 20, 2026
@macroscopeapp macroscopeapp Bot dismissed their stale review June 20, 2026 16:40

Dismissing prior approval to re-evaluate 22015b0

macroscopeapp[bot]
macroscopeapp Bot previously approved these changes Jun 20, 2026
@macroscopeapp macroscopeapp Bot dismissed their stale review June 20, 2026 16:50

Dismissing prior approval to re-evaluate b4641b4

macroscopeapp[bot]
macroscopeapp Bot previously approved these changes Jun 20, 2026
@juliusmarminge juliusmarminge force-pushed the codex/desktop-update-settings-errors branch from b4641b4 to f5ca17c Compare June 20, 2026 22:43
@macroscopeapp macroscopeapp Bot dismissed their stale review June 20, 2026 22:43

Dismissing prior approval to re-evaluate f5ca17c

macroscopeapp[bot]
macroscopeapp Bot previously approved these changes Jun 20, 2026
@juliusmarminge juliusmarminge force-pushed the codex/desktop-update-settings-errors branch 2 times, most recently from a820cc0 to 6e0bb59 Compare June 20, 2026 23:20

@cursor cursor Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using high effort and found 1 potential issue.

Autofix Details

Bugbot Autofix prepared a fix for the issue found in the latest run.

  • ✅ Fixed: Install failure leaves quitting stuck
    • Added Effect.onError after the ElectronUpdaterQuitAndInstallError catchTags to reset updateInstallInFlightRef and desktopState.quitting when backendManager.stop or electronWindow.destroyAll fail with a non-updater error tag, preventing the stuck state.

Create PR

Or push these changes by commenting:

@cursor push 2a00aa7b08
Preview (2a00aa7b08)
diff --git a/apps/desktop/src/updates/DesktopUpdates.ts b/apps/desktop/src/updates/DesktopUpdates.ts
--- a/apps/desktop/src/updates/DesktopUpdates.ts
+++ b/apps/desktop/src/updates/DesktopUpdates.ts
@@ -435,6 +435,11 @@
           },
         ),
       }),
+      Effect.onError(() =>
+        Ref.set(updateInstallInFlightRef, false).pipe(
+          Effect.andThen(Ref.set(desktopState.quitting, false)),
+        ),
+      ),
     );
   }).pipe(Effect.withSpan("desktop.updates.installDownloadedUpdate"));

You can send follow-ups to the cloud agent here.

Comment thread apps/desktop/src/updates/DesktopUpdates.ts
@macroscopeapp macroscopeapp Bot dismissed their stale review June 20, 2026 23:35

Dismissing prior approval to re-evaluate 459f9d7

@cursor cursor Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using high effort and found 2 potential issues.

Fix All in Cursor

Bugbot Autofix prepared fixes for both issues found in the latest run.

  • ✅ Fixed: Unexpected failures reject IPC promise
    • Replaced Effect.onError with Effect.catchCause in both download and install handlers so unexpected defects are caught and return { accepted: true, completed: false } instead of propagating the failure to the IPC promise.
  • ✅ Fixed: Interrupt leaves downloading status stuck
    • The download catchCause handler now calls reduceDesktopUpdateStateOnDownloadFailure on interrupt-only causes, rolling back the status from 'downloading' to 'available' so the UI is not stuck.

Create PR

Or push these changes by commenting:

@cursor push 3e0a9d307a
Preview (3e0a9d307a)
diff --git a/apps/desktop/src/updates/DesktopUpdates.test.ts b/apps/desktop/src/updates/DesktopUpdates.test.ts
--- a/apps/desktop/src/updates/DesktopUpdates.test.ts
+++ b/apps/desktop/src/updates/DesktopUpdates.test.ts
@@ -369,13 +369,13 @@
         harness.emit("update-available", { version: "1.2.4" });
         yield* flushCallbacks;
 
-        const exit = yield* Effect.exit(updates.download);
-        assert.equal(exit._tag, "Failure");
+        const result = yield* updates.download;
+        assert.equal(result.accepted, true);
+        assert.equal(result.completed, false);
 
-        const failedState = yield* updates.getState;
-        assert.equal(failedState.status, "available");
-        assert.equal(failedState.errorContext, "download");
-        assert.equal(failedState.message, "Desktop update download action failed unexpectedly.");
+        assert.equal(result.state.status, "available");
+        assert.equal(result.state.errorContext, "download");
+        assert.equal(result.state.message, "Desktop update download action failed unexpectedly.");
 
         const changedState = yield* updates.setChannel("nightly");
         assert.equal(changedState.channel, "nightly");
@@ -396,14 +396,14 @@
         harness.emit("update-downloaded", { version: "1.2.4" });
         yield* flushCallbacks;
 
-        const exit = yield* Effect.exit(updates.install);
-        assert.equal(exit._tag, "Failure");
+        const result = yield* updates.install;
+        assert.equal(result.accepted, true);
+        assert.equal(result.completed, false);
         assert.isFalse(yield* Ref.get(desktopState.quitting));
 
-        const failedState = yield* updates.getState;
-        assert.equal(failedState.status, "downloaded");
-        assert.equal(failedState.errorContext, "install");
-        assert.equal(failedState.message, "Desktop update install action failed unexpectedly.");
+        assert.equal(result.state.status, "downloaded");
+        assert.equal(result.state.errorContext, "install");
+        assert.equal(result.state.message, "Desktop update install action failed unexpectedly.");
 
         const changedState = yield* updates.setChannel("nightly");
         assert.equal(changedState.channel, "nightly");

diff --git a/apps/desktop/src/updates/DesktopUpdates.ts b/apps/desktop/src/updates/DesktopUpdates.ts
--- a/apps/desktop/src/updates/DesktopUpdates.ts
+++ b/apps/desktop/src/updates/DesktopUpdates.ts
@@ -408,18 +408,22 @@
           },
         ),
       }),
-      Effect.onError((cause) => {
-        if (Cause.hasInterruptsOnly(cause)) {
-          return Effect.void;
-        }
-        const error = new DesktopUpdateUnexpectedActionError({ action: "download", cause });
-        return Effect.gen(function* () {
-          yield* updateState((current) =>
-            reduceDesktopUpdateStateOnDownloadFailure(current, error.message),
-          );
-          yield* logUpdaterError(error.message, { error });
-        });
-      }),
+      Effect.catchCause((cause) =>
+        Effect.gen(function* () {
+          if (Cause.hasInterruptsOnly(cause)) {
+            yield* updateState((current) =>
+              reduceDesktopUpdateStateOnDownloadFailure(current, "Download was interrupted."),
+            );
+          } else {
+            const error = new DesktopUpdateUnexpectedActionError({ action: "download", cause });
+            yield* updateState((current) =>
+              reduceDesktopUpdateStateOnDownloadFailure(current, error.message),
+            );
+            yield* logUpdaterError(error.message, { error });
+          }
+          return { accepted: true, completed: false };
+        }),
+      ),
       Effect.ensuring(Ref.set(updateDownloadInFlightRef, false)),
     );
   }).pipe(Effect.withSpan("desktop.updates.downloadAvailableUpdate"));
@@ -459,18 +463,18 @@
           },
         ),
       }),
-      Effect.onError((cause) =>
+      Effect.catchCause((cause) =>
         Effect.gen(function* () {
           yield* Ref.set(updateInstallInFlightRef, false);
           yield* Ref.set(desktopState.quitting, false);
-          if (Cause.hasInterruptsOnly(cause)) {
-            return;
+          if (!Cause.hasInterruptsOnly(cause)) {
+            const error = new DesktopUpdateUnexpectedActionError({ action: "install", cause });
+            yield* updateState((current) =>
+              reduceDesktopUpdateStateOnInstallFailure(current, error.message),
+            );
+            yield* logUpdaterError(error.message, { error });
           }
-          const error = new DesktopUpdateUnexpectedActionError({ action: "install", cause });
-          yield* updateState((current) =>
-            reduceDesktopUpdateStateOnInstallFailure(current, error.message),
-          );
-          yield* logUpdaterError(error.message, { error });
+          return { accepted: true, completed: false };
         }),
       ),
     );

You can send follow-ups to the cloud agent here.

Reviewed by Cursor Bugbot for commit 459f9d7. Configure here.

Comment thread apps/desktop/src/updates/DesktopUpdates.ts
Comment thread apps/desktop/src/updates/DesktopUpdates.ts
@juliusmarminge juliusmarminge force-pushed the codex/desktop-update-settings-errors branch from 459f9d7 to a82a80a Compare June 20, 2026 23:49
Comment thread apps/desktop/src/updates/DesktopUpdates.ts Outdated
juliusmarminge and others added 8 commits June 20, 2026 16:59
Co-authored-by: codex <codex@users.noreply.github.com>
Co-authored-by: codex <codex@users.noreply.github.com>
Co-authored-by: codex <codex@users.noreply.github.com>
Co-authored-by: codex <codex@users.noreply.github.com>
Co-authored-by: codex <codex@users.noreply.github.com>
Co-authored-by: codex <codex@users.noreply.github.com>
Co-authored-by: codex <codex@users.noreply.github.com>
Co-authored-by: codex <codex@users.noreply.github.com>
@juliusmarminge juliusmarminge force-pushed the codex/desktop-update-settings-errors branch from 2c777a9 to 5c21085 Compare June 21, 2026 00:00
@juliusmarminge juliusmarminge merged commit 9f7861a into main Jun 21, 2026
16 checks passed
@juliusmarminge juliusmarminge deleted the codex/desktop-update-settings-errors branch June 21, 2026 00:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:L 100-499 changed lines (additions + deletions). vouch:trusted PR author is trusted by repo permissions or the VOUCHED list.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant