feat(desktop): auto-update tab title from terminal by Kitenite · Pull Request #495 · superset-sh/superset

Kitenite · 2025-12-24T05:57:14Z

Summary

Listen for terminal title changes via OSC escape sequences (0, 1, 2)
Automatically update the tab title when programs set the terminal title
Update workspace name if it hasn't been customized (still using default branch name)

This allows shells and programs (vim, htop, ssh, etc.) that set the terminal title via escape sequences to have that reflected in the UI.

Test plan

Open a terminal and run a command that sets the title (e.g., echo -e "\033]0;My Custom Title\007")
Verify the tab title updates to "My Custom Title"
Verify the workspace name updates if it was still using the default branch name
Rename the workspace manually, then run the echo command again
Verify the workspace name does NOT change (respects user customization)

🤖 Generated with Claude Code

Summary by CodeRabbit

Release Notes

New Features
- Terminal tab titles now automatically update to reflect the current state and active commands in real-time with smooth performance.
Bug Fixes
- Fixed memory leak where terminal event listeners were not properly disposed when closing or unmounting terminal components, preventing resource waste.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Listen for terminal title changes (OSC 0, 1, 2 escape sequences) and automatically update the tab title. Also updates the workspace name if it hasn't been customized (still using the default branch name). This allows shells and programs (vim, htop, ssh, etc.) that set the terminal title to have that reflected in the UI. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

coderabbitai · 2025-12-24T05:57:20Z

📝 Walkthrough

Walkthrough

Adds an xterm onTitleChange event listener to the Terminal component that propagates terminal title updates to the parent tab through a debounced setter. The listener is registered during terminal initialization and properly disposed on unmount to prevent memory leaks.

Changes

Cohort / File(s)	Summary
Terminal title propagation `apps/desktop/src/renderer/screens/main/components/WorkspaceView/ContentView/TabsContent/Terminal/Terminal.tsx`	Registers `onTitleChange` handler on xterm instance to update parent tab title via `debouncedSetTabAutoTitleRef`; ensures listener disposal on unmount; minor import reordering

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant xterm
    participant Terminal Component
    participant Tab Store

    User->>xterm: Change terminal title
    xterm->>Terminal Component: Emit onTitleChange event
    Terminal Component->>Terminal Component: Debounce the update
    Terminal Component->>Tab Store: Call debouncedSetTabAutoTitleRef(title)
    Tab Store->>Tab Store: Update tab auto title
    
    Note over Terminal Component: On unmount
    Terminal Component->>Terminal Component: Dispose title listener

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

xterm ui #115 — Modifies the same Terminal component; this PR builds upon existing work in that file
feat(desktop): add userTitle field for user-renamed tabs #289 — Adds the TabsStore.setTabAutoTitle API that this PR directly utilizes for tab title updates

Poem

🐰 A whisker-twitch of title flow,
From xterm's heart, the updates glow,
Debounced soft through tab's window,
No leaks remain when we must go! 🌙

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically summarizes the main change: auto-updating the tab title from terminal output via OSC escape sequences.
Description check	✅ Passed	The description is substantially complete but lacks some template sections; Related Issues and Testing sections are missing or incomplete.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch auto-update-title

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dac746a and 08f1d68.

📒 Files selected for processing (1)

apps/desktop/src/renderer/screens/main/components/WorkspaceView/ContentView/TabsContent/Terminal/Terminal.tsx

🧰 Additional context used

📓 Path-based instructions (9)

**/*.{ts,tsx}