Add support for actions flow in Player config entries (#2572)

Author: marcelveldt

music_assistant/controllers/config.py

@@ -68,6 +68,7 @@
 from music_assistant.helpers.api import api_command
 from music_assistant.helpers.json import JSON_DECODE_EXCEPTIONS, async_json_dumps, async_json_loads
 from music_assistant.helpers.util import load_provider_module
+from music_assistant.models import ProviderModuleType
 
 if TYPE_CHECKING:
     import asyncio
@@ -244,7 +245,7 @@ async def get_provider_config_value(self, instance_id: str, key: str) -> ConfigV
         return val
 
     @api_command("config/providers/get_entries")
-    async def get_provider_config_entries(
+    async def get_provider_config_entries(  # noqa: PLR0915
         self,
         provider_domain: str,
         instance_id: str | None = None,
@@ -260,13 +261,21 @@ async def get_provider_config_entries(
         values: the (intermediate) raw values for config entries sent with the action.
         """
         # lookup provider manifest and module
+        prov_mod: ProviderModuleType | None
         for manifest in self.mass.get_provider_manifests():
             if manifest.domain == provider_domain:
-                prov_mod = await load_provider_module(provider_domain, manifest.requirements)
+                try:
+                    prov_mod = await load_provider_module(provider_domain, manifest.requirements)
+                except Exception as e:
+                    msg = f"Failed to load provider module for {provider_domain}: {e}"
+                    LOGGER.exception(msg)
+                    return []
                 break
         else:
             msg = f"Unknown provider domain: {provider_domain}"
-            raise KeyError(msg)
+            LOGGER.exception(msg)
+            return []
+
         if values is None:
             values = self.get(f"{CONF_PROVIDERS}/{instance_id}/values", {}) if instance_id else {}
 
@@ -416,14 +425,22 @@ async def get_player_configs(
         ]
 
     @api_command("config/players/get")
-    async def get_player_config(self, player_id: str) -> PlayerConfig:
+    async def get_player_config(
+        self,
+        player_id: str,
+        action: str | None = None,
+        values: dict[str, ConfigValueType] | None = None,
+    ) -> PlayerConfig:
         """Return (full) configuration for a single player."""
         raw_conf: dict[str, Any]
         if raw_conf := self.get(f"{CONF_PLAYERS}/{player_id}"):
             if player := self.mass.players.get(player_id, False):
                 raw_conf["default_name"] = player.display_name
                 raw_conf["provider"] = player.provider.lookup_key
-                conf_entries = await player.get_config_entries()
+                # pass action and values to get_config_entries
+                if values is None:
+                    values = raw_conf.get("values", {})
+                conf_entries = await player.get_config_entries(action=action, values=values)
             else:
                 # handle unavailable player and/or provider
                 conf_entries = []
@@ -434,6 +451,29 @@ async def get_player_config(self, player_id: str) -> PlayerConfig:
         msg = f"No config found for player id {player_id}"
         raise KeyError(msg)
 
+    @api_command("config/players/get_entries")
+    async def get_player_config_entries(
+        self,
+        player_id: str,
+        action: str | None = None,
+        values: dict[str, ConfigValueType] | None = None,
+    ) -> list[ConfigEntry]:
+        """
+        Return Config entries to configure a player.
+
+        player_id: id of an existing player instance.
+        action: [optional] action key called from config entries UI.
+        values: the (intermediate) raw values for config entries sent with the action.
+        """
+        if not (player := self.mass.players.get(player_id, False)):
+            msg = f"Player {player_id} not found"
+            raise KeyError(msg)
+
+        if values is None:
+            values = self.get(f"{CONF_PLAYERS}/{player_id}/values", {})
+
+        return await player.get_config_entries(action=action, values=values)
+
     @api_command("config/players/get_value")
     async def get_player_config_value(
         self,

music_assistant/controllers/players/sync_groups.py

@@ -13,7 +13,7 @@
 from typing import TYPE_CHECKING, cast
 
 import shortuuid
-from music_assistant_models.config_entries import ConfigEntry, ConfigValueOption
+from music_assistant_models.config_entries import ConfigEntry, ConfigValueOption, ConfigValueType
 from music_assistant_models.constants import PLAYER_CONTROL_NONE
 from music_assistant_models.enums import (
     ConfigEntryType,
@@ -184,11 +184,15 @@ def can_group_with(self) -> set[str]:
         else:
             return set()
 
-    async def get_config_entries(self) -> list[ConfigEntry]:
+    async def get_config_entries(
+        self,
+        action: str | None = None,
+        values: dict[str, ConfigValueType] | None = None,
+    ) -> list[ConfigEntry]:
         """Return all (provider/player specific) Config Entries for the given player (if any)."""
         entries: list[ConfigEntry] = [
             # default entries for player groups
-            *await super().get_config_entries(),
+            *await super().get_config_entries(action=action, values=values),
             # add syncgroup specific entries
             ConfigEntry(
                 key=CONF_GROUP_MEMBERS,

music_assistant/models/player.py

@@ -15,7 +15,12 @@
 from copy import deepcopy
 from typing import TYPE_CHECKING, Any, cast, final
 
-from music_assistant_models.config_entries import ConfigEntry, ConfigValueOption, PlayerConfig
+from music_assistant_models.config_entries import (
+    ConfigEntry,
+    ConfigValueOption,
+    ConfigValueType,
+    PlayerConfig,
+)
 from music_assistant_models.constants import (
     PLAYER_CONTROL_FAKE,
     PLAYER_CONTROL_NATIVE,
@@ -581,8 +586,14 @@ async def poll(self) -> None:
 
     async def get_config_entries(
         self,
+        action: str | None = None,
+        values: dict[str, ConfigValueType] | None = None,
     ) -> list[ConfigEntry]:
-        """Return all (provider/player specific) Config Entries for the player."""
+        """Return all (provider/player specific) Config Entries for the player.
+
+        action: [optional] action key called from config entries UI.
+        values: the (intermediate) raw values for config entries sent with the action.
+        """
         # Return all base config entries for a player.
         # Feel free to override but ensure to include the base entries by calling super() first.
         # To override the default config entries, simply define an entry with the same key
@@ -1426,8 +1437,16 @@ def synced_to(self) -> str | None:
         # default implementation: groups can't be synced
         return None
 
-    async def get_config_entries(self) -> list[ConfigEntry]:
-        """Return all (provider/player specific) Config Entries for the player."""
+    async def get_config_entries(
+        self,
+        action: str | None = None,
+        values: dict[str, ConfigValueType] | None = None,
+    ) -> list[ConfigEntry]:
+        """Return all (provider/player specific) Config Entries for the player.
+
+        action: [optional] action key called from config entries UI.
+        values: the (intermediate) raw values for config entries sent with the action.
+        """
         # Return all base config entries for a group player.
         # Feel free to override but ensure to include the base entries by calling super() first.
         # To override the default config entries, simply define an entry with the same key

music_assistant/providers/_demo_player_provider/player.py

@@ -4,7 +4,7 @@
 
 from typing import TYPE_CHECKING
 
-from music_assistant_models.config_entries import ConfigEntry
+from music_assistant_models.config_entries import ConfigEntry, ConfigValueType
 from music_assistant_models.enums import ConfigEntryType, PlaybackState, PlayerFeature, PlayerType
 from music_assistant_models.player import PlayerSource
 
@@ -84,14 +84,18 @@ def _source_list(self) -> list[PlayerSource]:
             ),
         ]
 
-    async def get_config_entries(self) -> list[ConfigEntry]:
+    async def get_config_entries(
+        self,
+        action: str | None = None,
+        values: dict[str, ConfigValueType] | None = None,
+    ) -> list[ConfigEntry]:
         """Return all (provider/player specific) Config Entries for the player."""
         # OPTIONAL
         # this method is optional and should be implemented if you need player specific
         # configuration entries. If you do not need player specific configuration entries,
         # you can leave this method out completely to accept the default implementation.
         # Please note that you need to call the super() method to get the default entries.
-        default_entries = await super().get_config_entries()
+        default_entries = await super().get_config_entries(action=action, values=values)
         return [
             *default_entries,
             # example of a player specific config entry

music_assistant/providers/airplay/player.py

@@ -6,7 +6,7 @@
 import time
 from typing import TYPE_CHECKING, cast
 
-from music_assistant_models.config_entries import ConfigEntry
+from music_assistant_models.config_entries import ConfigEntry, ConfigValueType
 from music_assistant_models.enums import (
     ConfigEntryType,
     ContentType,
@@ -104,10 +104,14 @@ def __init__(
         self._attr_can_group_with = {provider.lookup_key}
         self._attr_enabled_by_default = not is_broken_raop_model(manufacturer, model)
 
-    async def get_config_entries(self) -> list[ConfigEntry]:
+    async def get_config_entries(
+        self,
+        action: str | None = None,
+        values: dict[str, ConfigValueType] | None = None,
+    ) -> list[ConfigEntry]:
         """Return all (provider/player specific) Config Entries for the given player (if any)."""
-        base_entries = [
-            *await super().get_config_entries(),
+        base_entries = await super().get_config_entries(action=action, values=values)
+        base_entries += [
             CONF_ENTRY_FLOW_MODE_ENFORCED,
             CONF_ENTRY_DEPRECATED_EQ_BASS,
             CONF_ENTRY_DEPRECATED_EQ_MID,

music_assistant/providers/alexa/__init__.py

@@ -368,9 +368,13 @@ async def play_media(self, media: PlayerMedia) -> None:
                 self._attr_playback_state = PlaybackState.PLAYING
         self.update_state()
 
-    async def get_config_entries(self) -> list[ConfigEntry]:
+    async def get_config_entries(
+        self,
+        action: str | None = None,
+        values: dict[str, ConfigValueType] | None = None,
+    ) -> list[ConfigEntry]:
         """Return all (provider/player specific) Config Entries for the given player (if any)."""
-        base_entries = await super().get_config_entries()
+        base_entries = await super().get_config_entries(action=action, values=values)
         return [
             *base_entries,
             CONF_ENTRY_FLOW_MODE_ENFORCED,

music_assistant/providers/bluesound/player.py

@@ -6,7 +6,7 @@
 import time
 from typing import TYPE_CHECKING
 
-from music_assistant_models.config_entries import ConfigEntry
+from music_assistant_models.config_entries import ConfigEntry, ConfigValueType
 from music_assistant_models.enums import PlaybackState, PlayerFeature, PlayerType
 from music_assistant_models.errors import PlayerCommandFailed
 from pyblu import Player as BluosPlayer
@@ -84,10 +84,14 @@ async def setup(self) -> None:
             self._attr_supported_features.add(PlayerFeature.VOLUME_SET)
         await self.mass.players.register_or_update(self)
 
-    async def get_config_entries(self) -> list[ConfigEntry]:
+    async def get_config_entries(
+        self,
+        action: str | None = None,
+        values: dict[str, ConfigValueType] | None = None,
+    ) -> list[ConfigEntry]:
         """Return all (provider/player specific) Config Entries for the player."""
         return [
-            *await super().get_config_entries(),
+            *await super().get_config_entries(action=action, values=values),
             CONF_ENTRY_HTTP_PROFILE_DEFAULT_3,
             create_sample_rates_config_entry(
                 max_sample_rate=192000,

music_assistant/providers/builtin_player/player.py

@@ -7,7 +7,7 @@
 
 from aiohttp import web
 from music_assistant_models.builtin_player import BuiltinPlayerEvent, BuiltinPlayerState
-from music_assistant_models.config_entries import ConfigEntry
+from music_assistant_models.config_entries import ConfigEntry, ConfigValueType
 from music_assistant_models.constants import PLAYER_CONTROL_NATIVE
 from music_assistant_models.enums import (
     BuiltinPlayerEventType,
@@ -95,9 +95,13 @@ def register(self, player_name: str, update_state: bool = True) -> None:
         if update_state:
             self.update_state()
 
-    async def get_config_entries(self) -> list[ConfigEntry]:
+    async def get_config_entries(
+        self,
+        action: str | None = None,
+        values: dict[str, ConfigValueType] | None = None,
+    ) -> list[ConfigEntry]:
         """Return all (provider/player specific) Config Entries for the player."""
-        base_entries = await super().get_config_entries()
+        base_entries = await super().get_config_entries(action=action, values=values)
         return [
             *base_entries,
             CONF_ENTRY_FLOW_MODE_ENFORCED,

music_assistant/providers/chromecast/player.py

@@ -7,6 +7,10 @@
 from typing import TYPE_CHECKING, Any, cast
 from uuid import UUID
 
+from music_assistant_models.config_entries import ConfigEntry
+
+if TYPE_CHECKING:
+    from music_assistant_models.config_entries import ConfigValueType
 from music_assistant_models.enums import MediaType, PlaybackState, PlayerFeature, PlayerType
 from music_assistant_models.errors import PlayerUnavailableError
 from music_assistant_models.player import PlayerSource
@@ -104,9 +108,13 @@ def __init__(
             self.mz_controller = mz_controller
         self.cc.start()
 
-    async def get_config_entries(self) -> list[ConfigEntry]:
+    async def get_config_entries(
+        self,
+        action: str | None = None,
+        values: dict[str, ConfigValueType] | None = None,
+    ) -> list[ConfigEntry]:
         """Return all (provider/player specific) Config Entries for the given player (if any)."""
-        base_entries = await super().get_config_entries()
+        base_entries = await super().get_config_entries(action=action, values=values)
         if self.type == PlayerType.GROUP:
             return [
                 *base_entries,

music_assistant/providers/dlna/player.py

@@ -10,7 +10,7 @@
 from async_upnp_client.client import UpnpService, UpnpStateVariable
 from async_upnp_client.exceptions import UpnpError, UpnpResponseError
 from async_upnp_client.profiles.dlna import DmrDevice, TransportState
-from music_assistant_models.config_entries import ConfigEntry
+from music_assistant_models.config_entries import ConfigEntry, ConfigValueType
 from music_assistant_models.enums import PlaybackState, PlayerFeature
 from music_assistant_models.errors import PlayerUnavailableError
 from music_assistant_models.player import DeviceInfo, PlayerMedia
@@ -260,9 +260,11 @@ def _get_playback_state(self) -> PlaybackState | None:
 
     async def get_config_entries(
         self,
+        action: str | None = None,
+        values: dict[str, ConfigValueType] | None = None,
     ) -> list[ConfigEntry]:
         """Return all (provider/player specific) Config Entries for the given player (if any)."""
-        base_entries = await super().get_config_entries()
+        base_entries = await super().get_config_entries(action=action, values=values)
         return base_entries + PLAYER_CONFIG_ENTRIES
 
     # async def on_player_config_change(