Skip to content

settings_ui: Stop reading the clipboard on every frame - #56075

Merged
agu-z merged 1 commit into
mainfrom
settings-ui-stop-reading-clipboard-on-render
May 7, 2026
Merged

settings_ui: Stop reading the clipboard on every frame#56075
agu-z merged 1 commit into
mainfrom
settings-ui-stop-reading-clipboard-on-render

Conversation

@agu-z

@agu-z agu-z commented May 7, 2026

Copy link
Copy Markdown
Contributor

render_settings_item_link was calling cx.read_from_clipboard() during render so it could show a check icon by the copy-link button when the matching link was on the clipboard. This had two problems:

  • A clipboard read per visible setting per frame is too expensive.
  • On Windows, reading the clipboard pumps the system message queue. If a queued message handler updates App while we're still rendering, GPUI panics with RefCell already borrowed (many occurrences observed).

Track the json_path of the most recently copied setting locally instead. The check icon now reflects what was copied in this session via this UI rather than whatever is on the system clipboard.

While this removes the most common offender, the underlying gpui_windows reentrancy bug still exists: on_close callbacks can be invoked while App is already borrowed on Windows, and can be triggered by any other clipboard-touching code path.

Self-Review Checklist:

  • I've reviewed my own diff for quality, security, and reliability
  • Unsafe blocks (if any) have justifying comments
  • The content is consistent with the UI/UX checklist
  • Tests cover the new/changed behavior
  • Performance impact has been considered and is acceptable

Release Notes:

  • Fixed a crash on Windows that could occur when closing the settings window
  • Improved the overall performance of the settings window

render_settings_item_link was calling cx.read_from_clipboard() during
render so it could show a check icon next to the copy-link button when
the matching link was on the clipboard. This had two problems:

- A clipboard read per visible setting per frame is too expensive.
- On Windows, the clipboard syscall can reentrantly dispatch window
  messages, which while App is borrowed for rendering panics with
  "RefCell already borrowed" (ZED-7GP).

Track the json_path of the most recently copied setting locally instead.
The check icon now reflects what was copied in this session via this UI
rather than whatever is on the system clipboard.
@cla-bot cla-bot Bot added the cla-signed The user has signed the Contributor License Agreement label May 7, 2026
@zed-community-bot zed-community-bot Bot added the staff Pull requests authored by a current member of Zed staff label May 7, 2026
@agu-z
agu-z requested a review from probably-neb May 7, 2026 16:48
@agu-z
agu-z added this pull request to the merge queue May 7, 2026
@agu-z

agu-z commented May 7, 2026

Copy link
Copy Markdown
Contributor Author

/cherry-pick preview

Merged via the queue into main with commit 8bdcce8 May 7, 2026
45 checks passed
@agu-z
agu-z deleted the settings-ui-stop-reading-clipboard-on-render branch May 7, 2026 20:46
zed-zippy Bot added a commit that referenced this pull request May 7, 2026
…ry-pick to preview) (#56093)

Cherry-pick of #56075 to preview

----
`render_settings_item_link` was calling `cx.read_from_clipboard()`
during render so it could show a check icon next to the copy-link button
when the matching link was on the clipboard. This had two problems:

- A clipboard read per visible setting per frame is too expensive.
- On Windows, reading the clipboard pumps the system message queue. If a
queued message handler updates `App` while we're still rendering, GPUI
panics with `RefCell already borrowed` (many occurrences observed).

Track the `json_path` of the most recently copied setting locally
instead. The check icon now reflects what was copied in this session via
this UI rather than whatever is on the system clipboard.

While this removes the most common offender, the underlying
`gpui_windows` reentrancy bug still exists: `on_close` /
`on_request_frame` callbacks can be invoked while `App` is already
borrowed on Windows, and can be triggered by any other
clipboard-touching code path. We should consider a follow-up PR that
handles this at the platform layer -- either by deferring callbacks that
re-borrow `App`, or by guarding individual handlers in
`gpui_windows::events` against reentrant `borrow_mut` calls.

Self-Review Checklist:

- [x] I've reviewed my own diff for quality, security, and reliability
- [x] Unsafe blocks (if any) have justifying comments
- [x] The content is consistent with the [UI/UX

checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist)
- [ ] Tests cover the new/changed behavior
- [x] Performance impact has been considered and is acceptable

Release Notes:

- Fixed a crash on Windows that could occur when closing the settings
window
- Improved the overall performance of the settings window

Co-authored-by: Agus Zubiaga <agus@zed.dev>
@kylekz kylekz mentioned this pull request May 8, 2026
3 tasks
jonx pushed a commit to jonx/zed-aros that referenced this pull request Jul 17, 2026
…s#56075)

`render_settings_item_link` was calling `cx.read_from_clipboard()`
during render so it could show a check icon next to the copy-link button
when the matching link was on the clipboard. This had two problems:

- A clipboard read per visible setting per frame is too expensive.
- On Windows, reading the clipboard pumps the system message queue. If a
queued message handler updates `App` while we're still rendering, GPUI
panics with `RefCell already borrowed` (many occurrences observed).

Track the `json_path` of the most recently copied setting locally
instead. The check icon now reflects what was copied in this session via
this UI rather than whatever is on the system clipboard.

While this removes the most common offender, the underlying
`gpui_windows` reentrancy bug still exists: `on_close` /
`on_request_frame` callbacks can be invoked while `App` is already
borrowed on Windows, and can be triggered by any other
clipboard-touching code path. We should consider a follow-up PR that
handles this at the platform layer -- either by deferring callbacks that
re-borrow `App`, or by guarding individual handlers in
`gpui_windows::events` against reentrant `borrow_mut` calls.

Self-Review Checklist:

- [x] I've reviewed my own diff for quality, security, and reliability
- [x] Unsafe blocks (if any) have justifying comments
- [x] The content is consistent with the [UI/UX
checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist)
- [ ] Tests cover the new/changed behavior
- [x] Performance impact has been considered and is acceptable

Release Notes:

- Fixed a crash on Windows that could occur when closing the settings
window
- Improved the overall performance of the settings window
jolutz pushed a commit to jolutz/zed that referenced this pull request Aug 8, 2026
…s#56075)

`render_settings_item_link` was calling `cx.read_from_clipboard()`
during render so it could show a check icon next to the copy-link button
when the matching link was on the clipboard. This had two problems:

- A clipboard read per visible setting per frame is too expensive.
- On Windows, reading the clipboard pumps the system message queue. If a
queued message handler updates `App` while we're still rendering, GPUI
panics with `RefCell already borrowed` (many occurrences observed).

Track the `json_path` of the most recently copied setting locally
instead. The check icon now reflects what was copied in this session via
this UI rather than whatever is on the system clipboard.

While this removes the most common offender, the underlying
`gpui_windows` reentrancy bug still exists: `on_close` /
`on_request_frame` callbacks can be invoked while `App` is already
borrowed on Windows, and can be triggered by any other
clipboard-touching code path. We should consider a follow-up PR that
handles this at the platform layer -- either by deferring callbacks that
re-borrow `App`, or by guarding individual handlers in
`gpui_windows::events` against reentrant `borrow_mut` calls.

Self-Review Checklist:

- [x] I've reviewed my own diff for quality, security, and reliability
- [x] Unsafe blocks (if any) have justifying comments
- [x] The content is consistent with the [UI/UX
checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist)
- [ ] Tests cover the new/changed behavior
- [x] Performance impact has been considered and is acceptable

Release Notes:

- Fixed a crash on Windows that could occur when closing the settings
window
- Improved the overall performance of the settings window
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed The user has signed the Contributor License Agreement staff Pull requests authored by a current member of Zed staff

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants