[PR #377] [MERGED] fix: viewport culling stale data #495

New issue

Closed

opened 2026-03-02 23:46:46 +03:00 by kerem · 0 comments

kerem commented

2026-03-02 23:46:46 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/anomalyco/opentui/pull/377
Author: @kommander
Created: 12/3/2025
Status: ✅ Merged
Merged: 12/3/2025
Merged by: @kommander

Base: main ← Head: vieport-culling-stale-data

📝 Commits (10+)

5389062 reproduce
386ec4a frame recorder
0de2fcc document
cfbc2bf update docs
e79c9e1 renderer idle promise
270501e reproduce high level
9a554f1 test
5a0a76f fix
adf84b8 cleanup
12ecd0f cleanup

📊 Changes

14 files changed (+890 additions, -54 deletions)

View changed files

📝 packages/core/src/Renderable.ts (+15 -0)
📝 packages/core/src/examples/editor-demo.ts (+0 -1)
📝 packages/core/src/examples/index.ts (+3 -4)
📝 packages/core/src/renderables/Diff.regression.test.ts (+3 -4)
📝 packages/core/src/renderables/__tests__/LineNumberRenderable.scrollbox-simple.test.ts (+0 -22)
📝 packages/core/src/renderer.ts (+92 -19)
📝 packages/core/src/testing.ts (+1 -0)
📝 packages/core/src/testing/README.md (+55 -1)
➕ packages/core/src/testing/test-recorder.test.ts (+283 -0)
➕ packages/core/src/testing/test-recorder.ts (+105 -0)
📝 packages/core/src/tests/renderer.control.test.ts (+2 -1)
➕ packages/core/src/tests/renderer.idle.test.ts (+221 -0)
➕ packages/core/src/tests/scrollbox-culling-bug.test.ts (+108 -0)
📝 packages/core/src/tests/scrollbox.test.ts (+2 -2)

📄 Description

Fix for viewport culling using stale data when a new renderable was added to the scrollbox, which lead to flicker and empty space at the scrollbox bottom until another render pass was triggered.

Introduces maxFps (default: 60), to cap automatic re-renders when renderables change via requestRender. Configurable via renderer options.

For testing introduces .idle():Promise on renderer, for tests to wait until automatic rendering is done and TestRecorder to record all frames between .rec() and .stop().

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/anomalyco/opentui/pull/377 **Author:** [@kommander](https://github.com/kommander) **Created:** 12/3/2025 **Status:** ✅ Merged **Merged:** 12/3/2025 **Merged by:** [@kommander](https://github.com/kommander) **Base:** `main` ← **Head:** `vieport-culling-stale-data` --- ### 📝 Commits (10+) - [`5389062`](https://github.com/anomalyco/opentui/commit/5389062b9f7f5530c0256cf603257ef9269f8506) reproduce - [`386ec4a`](https://github.com/anomalyco/opentui/commit/386ec4aafa9aabb05634e0a95cbccdc272d91f6d) frame recorder - [`0de2fcc`](https://github.com/anomalyco/opentui/commit/0de2fccc353151d48b9fcf8f0e2f6d71be2cb915) document - [`cfbc2bf`](https://github.com/anomalyco/opentui/commit/cfbc2bf4551e59c6266f08bd7b70501d2c9c9e0f) update docs - [`e79c9e1`](https://github.com/anomalyco/opentui/commit/e79c9e16ae1e5b5138a9fb482dd787a998baa26d) renderer idle promise - [`270501e`](https://github.com/anomalyco/opentui/commit/270501ec9168b52acc9b6f6b3792f8e69798c95f) reproduce high level - [`9a554f1`](https://github.com/anomalyco/opentui/commit/9a554f192a785ed8f520a55ab9e4bb752151534c) test - [`5a0a76f`](https://github.com/anomalyco/opentui/commit/5a0a76f63dac695dd22312c49fcff421255fc9ea) fix - [`adf84b8`](https://github.com/anomalyco/opentui/commit/adf84b8e4711c950acb572140f953f41fc7d7a10) cleanup - [`12ecd0f`](https://github.com/anomalyco/opentui/commit/12ecd0f03a3d1a738ca8ab22182bcfd8e0987cdc) cleanup ### 📊 Changes **14 files changed** (+890 additions, -54 deletions) <details> <summary>View changed files</summary> 📝 `packages/core/src/Renderable.ts` (+15 -0) 📝 `packages/core/src/examples/editor-demo.ts` (+0 -1) 📝 `packages/core/src/examples/index.ts` (+3 -4) 📝 `packages/core/src/renderables/Diff.regression.test.ts` (+3 -4) 📝 `packages/core/src/renderables/__tests__/LineNumberRenderable.scrollbox-simple.test.ts` (+0 -22) 📝 `packages/core/src/renderer.ts` (+92 -19) 📝 `packages/core/src/testing.ts` (+1 -0) 📝 `packages/core/src/testing/README.md` (+55 -1) ➕ `packages/core/src/testing/test-recorder.test.ts` (+283 -0) ➕ `packages/core/src/testing/test-recorder.ts` (+105 -0) 📝 `packages/core/src/tests/renderer.control.test.ts` (+2 -1) ➕ `packages/core/src/tests/renderer.idle.test.ts` (+221 -0) ➕ `packages/core/src/tests/scrollbox-culling-bug.test.ts` (+108 -0) 📝 `packages/core/src/tests/scrollbox.test.ts` (+2 -2) </details> ### 📄 Description Fix for viewport culling using stale data when a new renderable was added to the scrollbox, which lead to flicker and empty space at the scrollbox bottom until another render pass was triggered. Introduces `maxFps` (default: 60), to cap automatic re-renders when renderables change via `requestRender`. Configurable via renderer options. For testing introduces `.idle():Promise` on renderer, for tests to wait until automatic rendering is done and `TestRecorder` to record all frames between `.rec()` and `.stop()`. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>