Skip to content

fix(desktop): keep the editor selection valid when external content replaces the document - #7639

Merged
saddlepaddle merged 3 commits into
mainfrom
sentry/desktop-19h-external-content-selection
Sep 18, 2026
Merged

saddlepaddle merged 3 commits into
mainfrom
sentry/desktop-19h-external-content-selection

Conversation

@saddlepaddle

@saddlepaddle saddlepaddle commented Sep 18, 2026 •

Copy link
Copy Markdown
Collaborator

Problem

A renderer event on release 1.22.0 reported CodeMirror rejecting a Backspace with an invalid-change-range error where the range ran from the end of the document to offset 0. The keystroke is dropped and the error is unhandled. DESKTOP-QF (release 1.12.1, archived in August) is the same failure reached through paste, with a different document length in the message, so each occurrence groups as a fresh Sentry issue and archiving does not stick.

Root cause

Both code editors (the v1 file viewer/diff editor under screens/ and the v2 file pane editor under routes/) sync an externally changed file by dispatching a whole-document replace with no explicit selection. CodeMirror maps a non-empty selection through a change by mapping its start with assoc = 1 and its end with assoc = -1. For a replace that covers the whole selection that sends the start to the end of the inserted text and the end to the start of it, leaving an inverted range (newLength, 0). The very next edit command (deleteCharBackward, replaceSelection for paste or typing) builds a change from that range and ChangeSet.of throws.

This is not fixed by the CodeMirror bump main already took (state 6.6.0 → 6.7.1): SelectionRange.map is byte-identical in 6.6.0, 6.7.1 and the current upstream 6.7.5.

Control run against the current code path (state 6.7.1, no fix):

$ bun run control.ts
old replace path: RangeError: Invalid change range 2840 to 0 (in doc of length 2840)

Fix

One helper, replaceEditorDocument(state, value), builds the replace transaction and sets an explicit cursor computed against the document the change produces (CodeMirror normalizes CRLF on insert, so the string length is not the document length), clamped to its end and snapped to a grapheme-cluster boundary so it can never land between the halves of an astral character. All four whole-document replace sites (the two value-sync effects and the two adapter setValues) use it. The selection can no longer be inverted, and the user keeps their offset in the refreshed file instead of the mapped-to-zero position the old dispatch produced.

Verification

$ bunx biome check apps/desktop/src/renderer/lib/replaceEditorDocument <3 changed editor files>
Checked 24 files in 13ms. No fixes applied.
(re-run after each revision on the helper folder: Checked 3 files in 29ms. No fixes applied.)

$ cd apps/desktop && bun run typecheck
$ tsc --noEmit
typecheck exit=0

$ cd apps/desktop && bun test src/renderer/lib/replaceEditorDocument
 6 pass
 0 fail
 11 expect() calls
Ran 6 tests across 1 file. [89.00ms]

Refs DESKTOP-19H

Summary by CodeRabbit

  • Bug Fixes

    • Improved code editor document replacement to preserve valid cursor positions when content changes.
    • Prevented cursors from landing beyond the new document, inside grapheme clusters, or at positions affected by line-ending normalization.
    • Ensured selected ranges remain editable after replacing content.
    • Multiple selections now collapse to a single cursor when documents are replaced.
  • Tests

    • Added coverage for cursor positioning, selections, Unicode characters, shorter documents, and normalized line endings.

…eplaces the document

Both code editors sync an externally changed file by replacing the whole
document. CodeMirror maps a non-empty selection through that replace by
pushing its start to the end of the inserted text and its end to the
start, so the editor is left holding an inverted range. The next edit
command (Backspace, paste, typing) builds a change from that range and
CodeMirror rejects it with an invalid-change-range error, dropping the
keystroke.

Replace the document through one helper that also sets an explicit
cursor, clamped to the new length, so the selection is always valid and
the user keeps their place instead of jumping to the top of the file.

Refs DESKTOP-19H
@coderabbitai

coderabbitai Bot commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 59a8b3ca-6053-48b3-8806-c9cb8929da31

📥 Commits

Reviewing files that changed from the base of the PR and between 17d4790 and 1ad77b3.

📒 Files selected for processing (2)
  • apps/desktop/src/renderer/lib/replaceEditorDocument/replaceEditorDocument.test.ts
  • apps/desktop/src/renderer/lib/replaceEditorDocument/replaceEditorDocument.ts

Included review availability: Your plan provides up to 10 included reviews per hour; 6 remain after this review.


📝 Walkthrough

Walkthrough

A shared replaceEditorDocument helper now replaces CodeMirror documents, clamps cursors to the applied document, and avoids grapheme-cluster splits. Three editors use the helper. Tests cover cursor, selection, normalization, and document replacement behavior.

Changes

Editor document replacement

Layer / File(s) Summary
Replacement helper and validation
apps/desktop/src/renderer/lib/replaceEditorDocument/*
Adds the replacement transaction, barrel export, and tests for cursor preservation, document-length clamping, grapheme boundaries, line-ending normalization, editable selections, and multiple-selection collapse.
Editor integrations
apps/desktop/src/renderer/routes/.../CodeEditor/*, apps/desktop/src/renderer/screens/.../CodeEditor/*
Replaces inline full-document transactions with replaceEditorDocument calls in editor adapters, setValue methods, and external value synchronization. Existing update guards remain in place.

Priority: ➖ Normal

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Bug fix

Merge Risk: ⚪ Minimal · up to 1ad77

The editor replacement paths now preserve a valid cursor after external content updates, including normalized line endings and emoji boundaries. No actionable merge risk remains.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 7 functions across 6 files. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title uses conventional commit format and clearly states the main fix: keeping editor selections valid when external content replaces the document.
Description check ✅ Passed The description clearly explains the problem, root cause, fix, affected editors, and verification results. It does not include the template checklist or screenshot guidance, but the required technical…
  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 2
📝 Generate docstrings 💡
  • Commit to this branch
  • Create a new PR
🛠️ Fix failing CI checks 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

A clamped offset can fall between the two halves of an astral character
in the new content, and the next Backspace would then leave a lone
surrogate behind. Snap the cursor to the cluster boundary at or before
the offset.
CodeMirror splits inserted text on CR, LF and CRLF, so a CRLF file's
document is shorter than the string it came from. Clamp and snap the
cursor against the document the change produces, not the raw value.
@saddlepaddle
saddlepaddle merged commit ed984e2 into main Sep 18, 2026
23 of 24 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

🧹 Preview Cleanup Complete

The following preview resources have been cleaned up:

  • ⚠️ Neon database branch

Thank you for your contribution! 🎉

Kitenite added a commit that referenced this pull request Sep 23, 2026
* docs: update weekly product documentation for September 23

Source of truth: live Notion SOP https://www.notion.so/3b3b9d5bf616810dbacaca7dd2305259
Window: GitHub merged:>=2026-09-16, through this run on 2026-09-23. gh returned 103 PRs (limit 1000, avoiding the SOP example’s 50-PR truncation).
Workspace baseline: 2158895. Prior session stopped at a usage limit; the checkout was clean.

## Changes

- Pages, CLI, and MCP: public sharing, workspace menus, origin labels, pagination, first-publish opening, version previews, mobile comments, and link handling: #7570, #7658, #7726, #7472, #7532, #7718. Files: pages.mdx; cli/cli-reference.mdx; mcp-server.mdx.
- iPhone launch, requirements, setup, host states, and Pro checklist: #7703, #7686, #7697, #7661, #7642, #7494. Files: install.mdx; faq.mdx; overview.mdx; remote-access.mdx.
- Editor save conflicts and Markdown link actions: #7711, #7621. Files: editor.mdx.
- Terminal locations, copying, and ended-session recovery: #7712, #7709, #7618. Files: terminal-integration.mdx.
- Model catalog, embedded sign-in, and leaderboard history: #7741, #7740, #7651. Files: agent-integration.mdx; usage.mdx; cli/cli-reference.mdx.
- Repository picker, cloud working branches and attachments, mobile sessions, sidebar naming and ordering: #7694, #7620, #7622, #7633, #7604, #7650, #7575. Files: first-workspace.mdx; workspaces.mdx.
- Slack plugin tools and gated thread follow-ups, queuing, mute and stop controls: #7583, #7585, #7586, #7588, #7592, #7594. Files: use-with-slack.mdx.
- New CLI transcript, environment, and page deletion commands; connected-service plugins and MCP CLI migration: #7602, #7317. Files: cli/cli-reference.mdx; skills.mdx.
- Startup recovery and pre-account workspace migration: #7764, #7649. Files: troubleshooting.mdx.

Current source wins over PR descriptions: page ordering is newest-created first, search includes description, default CLI output remains a bare array, and the leaderboard automatically backfills since launch (there is no history-range picker). Slack thread commands and Mobile settings retain their availability qualifications. No assumption that every merged fix is already in the latest download.

## Deliberately skipped

- [#7765](#7765) fix(host-service): report GitHub being unreachable as unavailable, not a 500: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7756](#7756) fix(pages): restore page.list's bare-array contract for released clients: Restores compatibility for released clients; checked the current listPaginated implementation when documenting #7726.
- [#7749](#7749) fix(build): build every dist-types a filtered mobile typecheck needs: Internal build, tests, migration, developer tooling, or recovery plumbing; no new user-facing instructions.
- [#7748](#7748) feat(mobile): refresh the App Store listing and load review creds from .env: Marketing/store copy, layout, or launch assets; no separate product-doc change. The released iPhone workflow is covered by #7686 and #7703.
- [#7747](#7747) feat(mobile): ask for a rating on returning Home after real use: App Store rating timing needs no setup or reference instructions.
- [#7746](#7746) feat(mobile): start Sentry natively so launch crashes carry native context: Internal build, tests, migration, developer tooling, or recovery plumbing; no new user-facing instructions.
- [#7744](#7744) fix(email): make the welcome email unsubscribable via a Resend automation: Welcome email unsubscribe delivery is not a product workflow needing docs.
- [#7734](#7734) fix(desktop): restore locale provider test mocks: Internal build, tests, migration, developer tooling, or recovery plumbing; no new user-facing instructions.
- [#7733](#7733) fix(marketing): hide leaderboard vertical guide lines: Marketing/store copy, layout, or launch assets; no separate product-doc change. The released iPhone workflow is covered by #7686 and #7703.
- [#7732](#7732) chore(desktop): bump version to 1.30.2: Version bump only.
- [#7723](#7723) fix(desktop): preserve sidebar order and missing group members: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7717](#7717) fix(desktop): keep terminal links within URL boundaries: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7715](#7715) fix(ci): unblock CLI publishing and retry macOS installs: Internal build, tests, migration, developer tooling, or recovery plumbing; no new user-facing instructions.
- [#7714](#7714) fix(desktop): prevent tab close clicks from starting a drag: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7710](#7710) feat(marketing): add Vladimir mobile testimonial and rank quotes: Marketing/store copy, layout, or launch assets; no separate product-doc change. The released iPhone workflow is covered by #7686 and #7703.
- [#7704](#7704) feat(marketing): add App Store icon to footer: Marketing/store copy, layout, or launch assets; no separate product-doc change. The released iPhone workflow is covered by #7686 and #7703.
- [#7701](#7701) chore(desktop): bump version to 1.30.1: Version bump only.
- [#7700](#7700) fix(marketing): refine hero copy and demo details: Marketing/store copy, layout, or launch assets; no separate product-doc change. The released iPhone workflow is covered by #7686 and #7703.
- [#7698](#7698) feat(marketing): replace mobile feature cards with customer testimonials: Marketing/store copy, layout, or launch assets; no separate product-doc change. The released iPhone workflow is covered by #7686 and #7703.
- [#7696](#7696) fix: write managed configs and workspace files through symlinks: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7695](#7695) fix(marketing): isolate and scale the mobile phone demo: Marketing/store copy, layout, or launch assets; no separate product-doc change. The released iPhone workflow is covered by #7686 and #7703.
- [#7691](#7691) fix(terminal): preserve agent paste mode across host restarts: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7690](#7690) feat(marketing): showcase mobile workflows and simplify the homepage: Marketing/store copy, layout, or launch assets; no separate product-doc change. The released iPhone workflow is covered by #7686 and #7703.
- [#7689](#7689) chore(mobile): bump version to 1.1.1 for TestFlight: Version bump only.
- [#7688](#7688) fix(desktop): resolve dev Dock names across workspace path aliases: Internal build, tests, migration, developer tooling, or recovery plumbing; no new user-facing instructions.
- [#7685](#7685) docs(marketing): add September 20 weekly changelog: Marketing/store copy, layout, or launch assets; no separate product-doc change. The released iPhone workflow is covered by #7686 and #7703.
- [#7684](#7684) docs(skills): share mobile demo recording and film tooling: Internal build, tests, migration, developer tooling, or recovery plumbing; no new user-facing instructions.
- [#7683](#7683) fix(ui): truncate the page title instead of running it under the header actions: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7680](#7680) fix(host-service): treat a socket torn down mid-request as the cloud being unreachable: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7678](#7678) fix(desktop): keep markdown link and image attributes as strings so a paste can't stop the editor saving: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7676](#7676) docs(db): migration safety checklist and deploy workflow pitfalls from the 17 September outage: Internal build, tests, migration, developer tooling, or recovery plumbing; no new user-facing instructions.
- [#7675](#7675) fix(integrations): backfill existing connections into the table #7317 reads: Internal build, tests, migration, developer tooling, or recovery plumbing; no new user-facing instructions.
- [#7672](#7672) fix(ci): a failed production migration can no longer pass as a success: Internal build, tests, migration, developer tooling, or recovery plumbing; no new user-facing instructions.
- [#7671](#7671) fix(db,ci): make migration 0119 online-safe and bound production migrations: Internal build, tests, migration, developer tooling, or recovery plumbing; no new user-facing instructions.
- [#7670](#7670) fix(desktop): send text to running terminals as a bracketed paste, not raw keystrokes: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7669](#7669) feat(skills): audit page usage in the 10x skill: Existing skills page already describes the 10x audit; page-usage audit is an internal skill refinement.
- [#7668](#7668) fix(mobile): scroll-to-bottom button drives Claude Code's fullscreen view: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7666](#7666) fix(host-service): treat a gh that cannot start as no token: Internal build, tests, migration, developer tooling, or recovery plumbing; no new user-facing instructions.
- [#7665](#7665) chore(desktop): bump version to 1.30.0: Version bump only.
- [#7664](#7664) refactor(marketing): share the store badges with the mobile launch post: Marketing/store copy, layout, or launch assets; no separate product-doc change. The released iPhone workflow is covered by #7686 and #7703.
- [#7662](#7662) chore(mobile): simulator verification skill, stand-in host, and host-state flows: Internal build, tests, migration, developer tooling, or recovery plumbing; no new user-facing instructions.
- [#7659](#7659) fix(host-service): stop the Linux file watcher from taking the host down, and make superset start recover: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7655](#7655) feat(marketing): add /mobile landing page behind the mobile-launch flag: Marketing/store copy, layout, or launch assets; no separate product-doc change. The released iPhone workflow is covered by #7686 and #7703.
- [#7647](#7647) fix(agent-setup): restore Codex working status: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7644](#7644) fix(desktop): refresh commits after external changes: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7643](#7643) fix(mobile): a long press lifts the whole session tab, not its text: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7641](#7641) fix(desktop): harden renderer error boundaries and recovery: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7639](#7639) fix(desktop): keep the editor selection valid when external content replaces the document: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7638](#7638) fix(desktop): stop the file tree throwing when a lookup walks through a file: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7636](#7636) fix(host-service): classify an index its storage cannot deliver as environmental: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7615](#7615) fix(cli-framework,i18n): `bun run dev` runs the CLI instead of dying: Internal build, tests, migration, developer tooling, or recovery plumbing; no new user-facing instructions.
- [#7613](#7613) fix(host-service): a terminal in a cloud workspace knows it is in one: Internal build, tests, migration, developer tooling, or recovery plumbing; no new user-facing instructions.
- [#7611](#7611) feat(marketing): Superset Mobile launch post (hidden until launch): Marketing/store copy, layout, or launch assets; no separate product-doc change. The released iPhone workflow is covered by #7686 and #7703.
- [#7608](#7608) fix(sandbox): the release probe checks the display from inside the box: Internal build, tests, migration, developer tooling, or recovery plumbing; no new user-facing instructions.
- [#7606](#7606) fix(relay): tolerate slow connections with coordinated deadlines: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7605](#7605) fix(desktop): drop duplicate create-workspace submits while one is in flight: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7603](#7603) fix(desktop): preserve translation context for route errors: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7601](#7601) feat(mobile): let the workspace list scroll under a transparent header: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7598](#7598) fix(desktop): keep viewport emulation on a crashed browser pane from crashing the app: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7597](#7597) fix(host-service): pin git's diff prefixes so the Changes pane can parse every patch: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7593](#7593) fix(api): post the Slack agent's reply after its run budget is spent: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7587](#7587) fix(desktop): keep new sidebar group orders on the integer lane: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7582](#7582) fix(api): bound every Slack agent call by the run budget: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7581](#7581) feat(api): Slack agent foundation — shared handler, execution guard, thread window, model and output fixes: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.
- [#7573](#7573) feat(pages): publish without a workspace: Standalone publishing is already documented in pages.mdx; preserved that guidance and included its contract in the new CLI/MCP reference.
- [#7255](#7255) fix(host-service): preserve consumed Claude prompts in handoffs: Reliability or visual fix restores expected behavior; no new workflow or necessary workaround to document.

## Validation

- bun install: passed; no tracked dependency changes.
- bun run lint:fix: passed, no code fixes.
- bun run lint: passed.
- bun run --cwd apps/docs typecheck: passed.
- Vale on all 16 changed docs: zero errors and warnings. Small pre-existing prose violations in touched pages were corrected to satisfy the SOP.
- git diff --check: passed.

Only apps/docs/content/docs/ and the required append-only root TODO log are included. No push or PR.

37 PRs drove changes; 66 were deliberately skipped as separate documentation work.

* docs: correct stale claims and consolidate weekly updates

Replace outdated remote-port and privacy claims, correct the 90-day leaderboard backfill cap and link settings location, and describe credential use and comment-watch registration accurately. Consolidate iPhone requirements and troubleshooting, trim repeated Pages prose, and keep launch effort details in the CLI reference.

Remove the #7764 startup entry because it does not identify a fixed release and its upgrade instructions are too vague. This supersedes that item in the original PR audit. Validate with docs typecheck, lint:fix, lint, Vale (zero errors or warnings), and git diff --check.

* docs: trim repeated explanations across user guides

* docs: clarify iPhone cloud workspace requirements
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant