feat: Menu Status Indicator

[CooperWang0912]

PR Description

• Created status indicator for the installation menu

Motivation

• Visually indicate which fields are preventing the user from installing
• Create instant feedback when user configures a field
• Provide better user experience for people unfamiliar with the installation process
• Closes [Feat] Menu Item Status Indicator #4658

Technical Description

1. Added method _get_status_prefix for menu item completion status, with red exclamation marks for required and uncompleted fields, yellow dots for optional and uncompleted fields, and green checks for completed fields.[¹] The checks are achieved using the following logic:

if item.read_only or item.key in (SpecialMenuKey.SAVE.value, SpecialMenuKey.INSTALL.value, SpecialMenuKey.ABORT.value):
			return ''

		if item.key == 'auth_config':
			auth_config: AuthenticationConfiguration | None = item.value
			is_auth_valid = auth_config is not None and (auth_config.root_enc_password is not None or auth_config.has_superuser())
			if is_auth_valid:
				return '[bold green][✓][/bold green] '
			return '[bold red][!][/bold red] '

		# Standard mandatory or configured item check
		if item.has_value():
			return '[bold green][✓][/bold green] '
		elif item.mandatory:
			return '[bold red][!][/bold red] '
		else:
			return '[bold yellow][•][/bold yellow] '

2. Added method _update_item_labels that updates the menu render based on _get_status_prefix. The code is as follows:

def _update_item_labels(self) -> None:
		"""
		Re-applies translated titles and status prefixes to all active menu items.
		"""
		raw_options = self._get_menu_options(wrap_actions=False)
		new_options = {o.key: o.text for o in raw_options if o.key is not None}

		for item in self._item_group.items:
			if item.key in new_options:
				base_title = new_options[item.key]
				prefix = self._get_status_prefix(item)
				item.text = f'{prefix}{base_title}'

3. In order to avoid stale feedback due to background process not instantly updating values, created a wrapper that calls the _update_item_labels when called, and is triggered with _get_menu_options.[²] The implementation is as follows:

def _wrap_action(self, item: MenuItem, action: Callable[..., Any]) -> Callable[..., Any]:
		@wraps(action)
		async def wrapper(*args: Any, **kwargs: Any) -> Any:
			try:
				if inspect.iscoroutinefunction(action):
					result = await action(*args, **kwargs)
				else:
					result = action(*args, **kwargs)
					if inspect.isawaitable(result):
						result = await result

				item.value = result

				return result

			finally:
				self._update_item_labels()

		return wrapper

Tests and Checks

• I have tested the code!

Notes

[¹] The color scheme and symbols are up for discussion, and changes to these would be fairly straight forward
[²] I am using this primarily to contain the blast radius inside global_menu, and I would be happy to rework the logic if needed

[svartkanin]

I'm not sure this is going in the right direction. as these symbols are not very intuitive.
What is the exact problem with the install preview pointing to the missing settings?

[CooperWang0912]

@svartkanin Thanks for the feedback. I am completely open to swapping out the symbols for something more intuitive, or just ditching the symbols altogether. Some other paths I can think of right now are to color code the fields directly or use colored texts instead of symbols, but I do think that any labelling would be a net positive for user experience, since currently there is quite literally no way to tell field configuration status from the menu bar.

As for the install preview, I think it provides limited functionality since it only indicates critical missing settings, which means that the users wouldn't know what other non-critical fields are not configured, such as the additional packages option. Having a status menu also means that the user gets an instant feedback when a field is configured, which I think would help with the overall flow of the installation process.

[CooperWang0912]

@svartkanin Here is the rendered menu for the other option of using colored tags, and we can also decide what the tags and their colors should be. In addition, I would also be happy to open up a discussion and see what the community prefers in terms of the UI design.

[KsanDjordje]

I wonder if colored tags are the right approach here. The installation summary already clearly shows which configuration is missing before the installation starts, so adding multiple colored status tags to the main menu might introduce more visual noise than value.

If we want to indicate progress in the menu itself, perhaps a simpler approach would be enough. For example, using a plain + for options that haven't been configured yet and a > (or another simple marker) for configured options, without the surrounding []. That would still provide a quick visual indication without drawing too much attention away from the menu itself. Simplicity and readability are key.

That's just my take.

[CooperWang0912]

@KsanDjordje Yeah that makes a lot of sense. I guess the main problem is figuring out simple and clear symbols to indicate configured vs missing fields. That was actually why I leaned into color coding, which I thought was easier to understand compared to the symbols and added a second level of safety.

Would love to see some community suggestions for implementation ideas.

[CooperWang0912]

Here is another render with removed brackets to avoid too much visual noise and hopefully more readable symbols: