refac(console): generalize controls widget #427
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Each view in tokio-console has a widget up the top that lists the available controls for that view. There was a common implementation of this for table based views (tasks, resources, and async_ops) and separate implementations for the task and resource views. The resource view included two controls widgets, one for the Resource details at the top of the view, and another above the table of Async Ops at the bottom of the view. This change centralises the logic for the creation of this controls widget. This change is mostly a precursor to also displaying the controls in the help view (at which point we can revisit whether the entire list needs to be shown at the top of the screen). Controls (an action and the key or keys used to invoke it) are defined in structs so that their definition can be separated from the display logic (which includes whether or not UTF-8 is supported). This allows the problem of the text in the controls widget wrapping in the middle of a control definition to be fixed. Previously a subset of the controls would have wrapped like this: ```text controls: select column (sort) = ←→ or h, l, scroll = ↑↓ or k, j, view details = ↵, invert sort (highest/lowest) = i, ``` Notice how "view details = ↵," was split across multiple lines. The same list of controls will now wrap at a full control definition. ```text controls: select column (sort) = ←→ or h, l, scroll = ↑↓ or k, j, view details = ↵, invert sort (highest/lowest) = i, ``` Additionally, the list of controls on the Resource view has been consolidated up the top of the screen. Universal controls, those that are available in all views, are also defined centrally. As well as the quit action, using the space bar to pause has been added to that list. This was previously somewhat of an undocumented feature.
hawkw
approved these changes
May 25, 2023
tokio-console/src/view/controls.rs
Outdated
Comment on lines
132
to
141
| pub(crate) fn universal_controls() -> &'static Vec<ControlDisplay> { | ||
| static UNIVERSAL_CONTROLS: OnceCell<Vec<ControlDisplay>> = OnceCell::new(); | ||
|
|
||
| UNIVERSAL_CONTROLS.get_or_init(|| { | ||
| vec![ | ||
| ControlDisplay::new_simple("toggle pause", "space"), | ||
| ControlDisplay::new_simple("quit", "q"), | ||
| ] | ||
| }) | ||
| } |
There was a problem hiding this comment.
if we changed the ControlDisplay type to own an &'static [KeyDisplay] rather than a Vec, like I described above, UNIVERSAL_CONTROLS could just be a constant, rather than needing to be lazily initialized.
There was a problem hiding this comment.
Done. Although in resource.rs I had to keep the OnceCell because I'm concatenating 2 arrays which it seems can't be dont in const.
If you know a way of doing this, that would be really cool.
hawkw
approved these changes
May 25, 2023
Co-authored-by: Eliza Weisman <eliza@buoyant.io>
Make a bunch of things around ControlDisplay and KeyDisplay by using array slices instead of vectors.
hawkw
pushed a commit
that referenced
this pull request
Sep 29, 2023
Each view in tokio-console has a widget up the top that lists the available controls for that view. There was a common implementation of this for table based views (tasks, resources, and async_ops) and separate implementations for the task and resource views. The resource view included two controls widgets, one for the Resource details at the top of the view, and another above the table of Async Ops at the bottom of the view. This change centralises the logic for the creation of this controls widget. This change is mostly a precursor to also displaying the controls in the help view (at which point we can revisit whether the entire list needs to be shown at the top of the screen). Controls (an action and the key or keys used to invoke it) are defined in structs so that their definition can be separated from the display logic (which includes whether or not UTF-8 is supported). This allows the problem of the text in the controls widget wrapping in the middle of a control definition to be fixed. Previously a subset of the controls would have wrapped like this: ```text controls: select column (sort) = ←→ or h, l, scroll = ↑↓ or k, j, view details = ↵, invert sort (highest/lowest) = i, ``` Notice how "view details = ↵," was split across multiple lines. The same list of controls will now wrap at a full control definition. ```text controls: select column (sort) = ←→ or h, l, scroll = ↑↓ or k, j, view details = ↵, invert sort (highest/lowest) = i, ``` Additionally, the list of controls on the Resource view has been consolidated up the top of the screen. Universal controls, those that are available in all views, are also defined centrally. As well as the quit action, using the space bar to pause has been added to that list. This was previously somewhat of an undocumented feature.
hds
pushed a commit
that referenced
this pull request
Feb 13, 2024
Each screen in Tokio Console has a controls section that lists all the possible keys that can be used to control that screen. However, on the Resource Detail screen, there were two controls sections - one at the top of the screen and another above the Async Ops table. Since the controls for the Async Ops view were already included in the Resource Detail view controls panel in #427, the controls for the Async Ops view only needed to be removed. This simplified the layout somewhat, as the Async Ops view now only contains a single-subview, the table itself. Closes #258
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Each view in tokio-console has a widget up the top that lists the
available controls for that view. There was a common implementation of
this for table based views (tasks, resources, and async_ops) and
separate implementations for the task and resource views. The resource
view included two controls widgets, one for the Resource details at the
top of the view, and another above the table of Async Ops at the bottom
of the view.
This change centralises the logic for the creation of this controls
widget. This change is mostly a precursor to also displaying the
controls in the help view (at which point we can revisit whether the
entire list needs to be shown at the top of the screen).
Controls (an action and the key or keys used to invoke it) are defined
in structs so that their definition can be separated from the display
logic (which includes whether or not UTF-8 is supported).
This allows the problem of the text in the controls widget wrapping in
the middle of a control definition to be fixed. Previously a subset of
the controls would have wrapped like this:
Notice how "view details = ↵," was split across multiple lines. The same
list of controls will now wrap at a full control definition.
Additionally, the list of controls on the Resource view has been
consolidated up the top of the screen.
Universal controls, those that are available in all views, are also
defined centrally. As well as the quit action, using the space bar to
pause has been added to that list. This was previously somewhat of an
undocumented feature.