Allow renaming trace viewer tabs

[ebugden]

Allowing users to rename tabs lets them give concise and meaningful labels. This makes it easier to distinguish between tabs because, unlike the trace file names (which tend to be long), user written labels are more likely to fit inside narrow tabs without being cut off.

Examples of useful tab names:

• Crash A (Server 1), Crash A (Server 2)
• Before update, After update
• Baseline, Change A, Change B

Requirements:

• Changes made to the tab name shouldn't change the trace file name (or the trace group name).
• If the user clicks away while editing, the tab is renamed to what they typed.
• If the user hasn't typed anything, the tab keeps the previous name.

---

CC: @ssmagula

[thefinaljob]

Revised approach to solving the issue:

• Decouple code related to menu items in trace-explorer-opened-traces-widget.tsx by making it into its own component
  • pass in functions from the traces widget to the menu item component to avoid code duplication
  • move functions from trace widget to menu item component whenever possible
• Tie state of the tab to the state of the menu-item so that changes are reflected when the menu item is changed
  • Approach to this is TBD, could use a state store like Redux or callback functions

See below for a screenshot for the user story.

CC: @arfio

[ebugden]

@thefinaljob @ssmagula You plan to have the edit trace button appear in the opened traces section (A) rather than in the trace tab label (B)?

Couldn't we edit directly in the tab and either:

• When the pencil fades in, it obscures a portion of the title that was previously visible (instead of always leaving an empty space after the title), or
• On hover of the tab label text, the cursor changes to the "editable text" cursor: Ꮖ

My reflex would be to put it in the trace tab first:

• I think that's where people would look first. I don't think people would necessarily make the link that editing the name in the list of traces would affect the tab name.
• One main goal of renaming trace groups is to have a label that is readable within the space of a tab. Editing the tab label directly allows users to use the tab size as a reference for whether it will be readable or not.
• I don't think space would be a big issue. My guess is that tracers would have 1-2 (4 max) trace groups open. Although if you're also developing within the context of tracing you could have source files open as well...

[ebugden]

RE: Space for editing button - This shouldn't be an issue since the tab size doesn't shrink in Theia when there are too many tabs to display in the tab bar. In Theia, tab size is a function of label length. When there are too many tabs to display in the tab bar, a scroll wheel appears.

Example with a ton of tabs open:

TraceCompassTutorialTraces.Theia-Trace.Example.Application.-.Google.Chrome.2021-07-23.13-43-56.mp4

[ebugden]

After some discussion with @ssmagula and @thefinaljob:

• Renaming tabs via the tab is intuitive, but should be a contribution to theia rather than a trace extension contribution. A feature request should be created in that repo.
• Renaming trace groups with first be implemented via the "Opened Traces" menu (as thefinaljob proposed).