Skip to content

Add per-provider search status reporting to SearchResults #331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jozefKruszynski wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −1
Draft

Add per-provider search status reporting to SearchResults #331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions music_assistant_models/enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -961,3 +961,21 @@ class ProviderStatus(StrEnum):
INCOMPATIBLE = "incompatible"
# error: setup failed for any other reason (see the provider's last_error)
ERROR = "error"


class ProviderSearchStatus(StrEnum):
"""
Enum representing how a single provider contributed to a global search.

Reported per provider on SearchResults.provider_search_statuses so clients can
distinguish "this provider genuinely found nothing" from "this provider did not
answer in time / errored" instead of guessing from an empty result.
"""

# complete: the provider answered, even if it returned no items
COMPLETE = "complete"
# timeout: the provider did not answer within the soft timeout; its search
# continues server-side and a retry can pick up the cached result
TIMEOUT = "timeout"
# failed: the provider search errored or exceeded the hard timeout
FAILED = "failed"
5 changes: 4 additions & 1 deletion music_assistant_models/media_items/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

from mashumaro import DataClassDictMixin

from music_assistant_models.enums import MediaType
from music_assistant_models.enums import MediaType, ProviderSearchStatus
from music_assistant_models.errors import InvalidDataError
from music_assistant_models.unique_list import UniqueList

Expand Down Expand Up @@ -121,6 +121,9 @@ class SearchResults(DataClassDictMixin):
audiobooks: Sequence[Audiobook | ItemMapping] = field(default_factory=list)
podcasts: Sequence[Podcast | ItemMapping] = field(default_factory=list)
sound_effects: Sequence[SoundEffect | ItemMapping] = field(default_factory=list)
# per-provider search status, keyed by provider instance_id (special key "library"
# for the library search); empty when the server does not report statuses
provider_search_statuses: dict[str, ProviderSearchStatus] = field(default_factory=dict)


def media_from_dict(media_item: dict[str, Any]) -> MediaItemType | ItemMapping:
Expand Down