anyscale 0.26.21__py3-none-any.whl → 0.26.22__py3-none-any.whl

anyscale/commands/util.py

@@ -1,5 +1,5 @@
 from copy import deepcopy
-from typing import Dict, Tuple
+from typing import Dict, Tuple, TypeVar
 
 import click
 
@@ -136,9 +136,10 @@ def convert_kv_strings_to_dict(strings: Tuple[str]) -> Dict[str, str]:
     return ret_dict
 
 
-def override_env_vars(
-    config: WorkloadConfig, overrides: Dict[str, str]
-) -> WorkloadConfig:
+T = TypeVar("T", bound=WorkloadConfig)
+
+
+def override_env_vars(config: T, overrides: Dict[str, str]) -> T:
     """Returns a new copy of the WorkloadConfig with env vars overridden.
 
     This is a per-key override, so keys already in the config that are not specified in

anyscale/controllers/service_controller.py

@@ -2,7 +2,6 @@ import os
 from typing import Any, Dict, List, Optional
 
 import click
-import tabulate
 import yaml
 
 from anyscale import AnyscaleSDK
@@ -14,9 +13,6 @@ from anyscale.client.openapi_client.api.default_api import DefaultApi as Interna
 from anyscale.client.openapi_client.models.decorated_list_service_api_model import (
     DecoratedListServiceAPIModel,
 )
-from anyscale.client.openapi_client.models.decorated_production_service_v2_api_model import (
-    DecoratedProductionServiceV2APIModel,
-)
 from anyscale.controllers.base_controller import BaseController
 from anyscale.models.service_model import ServiceConfig
 from anyscale.project_utils import infer_project_id
@@ -81,6 +77,12 @@ class ServiceController(BaseController):
             max_surge_percent=config.max_surge_percent,
         )
 
+    def get_authenticated_user_id(self) -> str:
+        user_info_response = (
+            self.internal_api_client.get_user_info_api_v2_userinfo_get()
+        )
+        return user_info_response.result.id
+
     def _get_services_by_name(
         self,
         *,
@@ -93,12 +95,7 @@ class ServiceController(BaseController):
 
         Note that "name" is an *exact match* (different from the REST API semantics).
         """
-        creator_id = None
-        if created_by_me:
-            user_info_response = (
-                self.internal_api_client.get_user_info_api_v2_userinfo_get()
-            )
-            creator_id = user_info_response.result.id
+        creator_id = self.get_authenticated_user_id() if created_by_me else None
 
         paging_token = None
         services_list: List[DecoratedListServiceAPIModel] = []
@@ -364,75 +361,6 @@ class ServiceController(BaseController):
                 log=self.log,
             )
 
-    def list(
-        self,
-        *,
-        name: Optional[str] = None,
-        service_id: Optional[str] = None,
-        project_id: Optional[str] = None,
-        created_by_me: bool = False,
-        max_items: int = 10,
-    ) -> None:
-        self._list_via_service_list_endpoint(
-            name=name,
-            service_id=service_id,
-            project_id=project_id,
-            created_by_me=created_by_me,
-            max_items=max_items,
-        )
-
-    def _list_via_service_list_endpoint(
-        self,
-        *,
-        name: Optional[str] = None,
-        service_id: Optional[str] = None,
-        project_id: Optional[str] = None,
-        created_by_me: bool = False,
-        max_items: int,
-    ):
-        services = []
-        if service_id:
-            service_v2_result: DecoratedProductionServiceV2APIModel = (
-                self.internal_api_client.get_service_api_v2_services_v2_service_id_get(
-                    service_id
-                ).result
-            )
-            services.append(
-                [
-                    service_v2_result.name,
-                    service_v2_result.id,
-                    service_v2_result.current_state,
-                    # TODO: change to email once https://github.com/anyscale/product/pull/18189 is merged
-                    service_v2_result.creator_id,
-                ]
-            )
-
-        else:
-            services_data = self._get_services_by_name(
-                name=name,
-                project_id=project_id,
-                created_by_me=created_by_me,
-                max_items=max_items,
-            )
-
-            services = [
-                [
-                    service.name,
-                    service.id,
-                    service.current_state,
-                    service.creator.email,
-                ]
-                for service in services_data
-            ]
-
-        table = tabulate.tabulate(
-            services,
-            headers=["NAME", "ID", "CURRENT STATE", "CREATOR"],
-            tablefmt="plain",
-        )
-        self.log.info(f'View your Services in the UI at {get_endpoint("/services")}')
-        self.log.info(f"Services:\n{table}")
-
     def rollback(self, service_id: str, max_surge_percent: Optional[int] = None):
         service: ServiceModel = self.sdk.rollback_service(
             service_id,
@@ -445,10 +373,3 @@ class ServiceController(BaseController):
         self.log.info(
             f'View the service in the UI at {get_endpoint(f"/services/{service.id}")}'
         )
-
-    def terminate(self, service_id: str):
-        service: ServiceModel = self.sdk.terminate_service(service_id).result
-        self.log.info(f"Service {service.id} terminate initiated.")
-        self.log.info(
-            f'View the service in the UI at {get_endpoint(f"/services/{service.id}")}'
-        )

anyscale/service/__init__.py

@@ -1,6 +1,7 @@
-from typing import Optional, Union
+from typing import List, Optional, Union
 
 from anyscale._private.anyscale_client import AnyscaleClientInterface
+from anyscale._private.models.model_base import ResultIterator
 from anyscale._private.sdk import sdk_docs
 from anyscale._private.sdk.base_sdk import Timer
 from anyscale.cli_logger import BlockLogger
@@ -15,6 +16,8 @@ from anyscale.service.commands import (
     _DELETE_EXAMPLE,
     _DEPLOY_ARG_DOCSTRINGS,
     _DEPLOY_EXAMPLE,
+    _LIST_ARG_DOCSTRINGS,
+    _LIST_EXAMPLE,
     _ROLLBACK_ARG_DOCSTRINGS,
     _ROLLBACK_EXAMPLE,
     _STATUS_ARG_DOCSTRINGS,
@@ -26,6 +29,7 @@ from anyscale.service.commands import (
     archive,
     delete,
     deploy,
+    list,
     rollback,
     status,
     terminate,
@@ -34,8 +38,10 @@ from anyscale.service.commands import (
 from anyscale.service.models import (
     ServiceConfig,
     ServiceLogMode,
+    ServiceSortField,
     ServiceState,
     ServiceStatus,
+    SortOrder,
 )
 
 
@@ -122,6 +128,7 @@ class ServiceSDK:
     )
     def archive(  # noqa: F811
         self,
+        id: Optional[str] = None,  # noqa: A002
         name: Optional[str] = None,
         *,
         cloud: Optional[str] = None,
@@ -133,13 +140,14 @@ class ServiceSDK:
 
         Returns the ID of the archived service.
         """
-        return self._private_sdk.archive(name=name, cloud=cloud, project=project)
+        return self._private_sdk.archive(id=id, name=name, cloud=cloud, project=project)
 
     @sdk_docs(
         doc_py_example=_DELETE_EXAMPLE, arg_docstrings=_DELETE_ARG_DOCSTRINGS,
     )
     def delete(  # noqa: F811
         self,
+        id: Optional[str] = None,  # noqa: A002
         name: Optional[str] = None,
         *,
         cloud: Optional[str] = None,
@@ -149,7 +157,49 @@ class ServiceSDK:
 
         This command is asynchronous, so it always returns immediately.
         """
-        return self._private_sdk.delete(name=name, cloud=cloud, project=project)
+        return self._private_sdk.delete(id=id, name=name, cloud=cloud, project=project)
+
+    def list(  # noqa: F811, A001
+        self,
+        *,
+        # Single-item lookup
+        service_id: Optional[str] = None,
+        # Filters
+        name: Optional[str] = None,
+        state_filter: Optional[Union[List[ServiceState], List[str]]] = None,
+        creator_id: Optional[str] = None,
+        cloud: Optional[str] = None,
+        project: Optional[str] = None,
+        include_archived: bool = False,
+        # Paging
+        max_items: Optional[int] = None,
+        page_size: Optional[int] = None,
+        # Sorting
+        sort_field: Optional[Union[str, ServiceSortField]] = None,
+        sort_order: Optional[Union[str, SortOrder]] = None,
+    ) -> ResultIterator[ServiceStatus]:
+        """List services.
+
+        Returns
+        -------
+        ResultIterator[ServiceStatus]
+            An iterator yielding ServiceStatus objects. Fetches pages
+            lazily as needed. Use a `for` loop to iterate or `list()`
+            to consume all at once.
+        """
+        return self._private_sdk.list(
+            service_id=service_id,
+            name=name,
+            state_filter=state_filter,
+            creator_id=creator_id,
+            cloud=cloud,
+            project=project,
+            include_archived=include_archived,
+            max_items=max_items,
+            page_size=page_size,
+            sort_field=sort_field,
+            sort_order=sort_order,
+        )
 
     @sdk_docs(
         doc_py_example=_STATUS_EXAMPLE, arg_docstrings=_STATUS_ARG_DOCSTRINGS,

anyscale/service/_private/service_sdk.py

@@ -1,18 +1,30 @@
+import asyncio
 import copy
-from typing import Any, Dict, Optional, Union
+from typing import Any, Dict, List, Optional, Union
 
+from anyscale._private.models.model_base import ResultIterator
 from anyscale._private.workload import WorkloadSDK
+from anyscale.client.openapi_client.models.decorated_production_service_v2_api_model import (
+    DecoratedProductionServiceV2APIModel,
+)
+from anyscale.client.openapi_client.models.decoratedlistserviceapimodel_list_response import (
+    DecoratedlistserviceapimodelListResponse,
+)
+from anyscale.client.openapi_client.models.list_response_metadata import (
+    ListResponseMetadata,
+)
 from anyscale.compute_config.models import ComputeConfig
 from anyscale.sdk.anyscale_client.models import (
     AccessConfig,
-    ApplyServiceModel,
+    ApplyProductionServiceV2Model,
     GrpcProtocolConfig,
     ProductionServiceV2VersionModel,
     Protocols,
     RayGCSExternalStorageConfig as APIRayGCSExternalStorageConfig,
     ServiceConfig as ExternalAPIServiceConfig,
     ServiceEventCurrentState,
-    ServiceModel,
+    ServiceSortField,
+    SortOrder,
     TracingConfig as APITracingConfg,
 )
 from anyscale.service.models import (
@@ -32,6 +44,9 @@ from anyscale.utils.workspace_notification import (
 )
 
 
+MAX_PAGE_SIZE = 50
+
+
 class PrivateServiceSDK(WorkloadSDK):
     def _override_application_runtime_envs(
         self,
@@ -101,7 +116,10 @@ class PrivateServiceSDK(WorkloadSDK):
         return name
 
     def _log_deployed_service_info(
-        self, service: ServiceModel, *, canary_percent: Optional[int]
+        self,
+        service: DecoratedProductionServiceV2APIModel,
+        *,
+        canary_percent: Optional[int],
     ):
         """Log user-facing information about a deployed service."""
         version_id_info = "version ID: {version_id}".format(
@@ -177,9 +195,9 @@ class PrivateServiceSDK(WorkloadSDK):
         *,
         canary_percent: Optional[int] = None,
         max_surge_percent: Optional[int] = None,
-        existing_service: Optional[ServiceModel] = None,
-    ) -> ApplyServiceModel:
-        """Build the ApplyServiceModel for an in_place update.
+        existing_service: Optional[DecoratedProductionServiceV2APIModel] = None,
+    ) -> ApplyProductionServiceV2Model:
+        """Build the ApplyProductionServiceV2Model for an in_place update.
 
         in_place updates:
             - must be performed on an existing service.
@@ -246,7 +264,7 @@ class PrivateServiceSDK(WorkloadSDK):
         project_id = self.client.get_project_id(
             parent_cloud_id=cloud_id, name=config.project
         )
-        return ApplyServiceModel(
+        return ApplyProductionServiceV2Model(
             name=name,
             project_id=project_id,
             ray_serve_config=self._build_ray_serve_config(config),
@@ -269,9 +287,9 @@ class PrivateServiceSDK(WorkloadSDK):
         *,
         canary_percent: Optional[int] = None,
         max_surge_percent: Optional[int] = None,
-        existing_service: Optional[ServiceModel] = None,
-    ) -> ApplyServiceModel:
-        """Build the ApplyServiceModel for a rolling update."""
+        existing_service: Optional[DecoratedProductionServiceV2APIModel] = None,
+    ) -> ApplyProductionServiceV2Model:
+        """Build the ApplyProductionServiceV2Model for a rolling update."""
 
         build_id = None
         if config.containerfile is not None:
@@ -375,7 +393,7 @@ class PrivateServiceSDK(WorkloadSDK):
             if config.tracing_config.sampling_ratio is not None:
                 tracing_config.sampling_ratio = config.tracing_config.sampling_ratio
 
-        return ApplyServiceModel(
+        return ApplyProductionServiceV2Model(
             name=name,
             project_id=project_id,
             ray_serve_config=self._build_ray_serve_config(config),
@@ -417,7 +435,9 @@ class PrivateServiceSDK(WorkloadSDK):
                 raise ValueError("max_surge_percent must be between 0 and 100.")
 
         name = config.name or self._get_default_name()
-        existing_service: Optional[ServiceModel] = self.client.get_service(
+        existing_service: Optional[
+            DecoratedProductionServiceV2APIModel
+        ] = self.client.get_service(
             name=name, cloud=config.cloud, project=config.project
         )
         if existing_service is None:
@@ -444,7 +464,7 @@ class PrivateServiceSDK(WorkloadSDK):
                 existing_service=existing_service,
             )
 
-        service: ServiceModel = self.client.rollout_service(model)
+        service = self.client.rollout_service(model)
         self._log_deployed_service_info(service, canary_percent=canary_percent)
 
         return service.id
@@ -456,11 +476,11 @@ class PrivateServiceSDK(WorkloadSDK):
         cloud: Optional[str] = None,
         project: Optional[str] = None,
         include_archived: bool = False,
-    ) -> ServiceModel:
+    ) -> DecoratedProductionServiceV2APIModel:
         if name is None:
             name = self._get_default_name()
 
-        model: Optional[ServiceModel] = self.client.get_service(
+        model = self.client.get_service(
             name=name, cloud=cloud, project=project, include_archived=include_archived
         )
         if model is None:
@@ -539,7 +559,7 @@ class PrivateServiceSDK(WorkloadSDK):
         # in the DB to avoid breakages, but for now I'm copying the existing logic.
         return model.id[-SERVICE_VERSION_ID_TRUNCATED_LEN:]
 
-    def _service_version_model_to_status(
+    async def _service_version_model_to_status_async(
         self,
         model: ProductionServiceV2VersionModel,
         *,
@@ -547,10 +567,20 @@ class PrivateServiceSDK(WorkloadSDK):
         project_id: str,
         query_auth_token_enabled: bool,
     ) -> ServiceVersionStatus:
-        image_uri = self._image_sdk.get_image_uri_from_build_id(model.build_id)
+
+        image_uri, image_build, project, compute_config = await asyncio.gather(
+            asyncio.to_thread(
+                self._image_sdk.get_image_uri_from_build_id, model.build_id
+            ),
+            asyncio.to_thread(self._image_sdk.get_image_build, model.build_id),
+            asyncio.to_thread(self.client.get_project, project_id),
+            asyncio.to_thread(
+                self.get_user_facing_compute_config, model.compute_config_id
+            ),
+        )
+
         if image_uri is None:
             raise RuntimeError(f"Failed to get image URI for ID {model.build_id}.")
-        image_build = self._image_sdk.get_image_build(model.build_id)
         if image_build is None:
             raise RuntimeError(f"Failed to get image build for ID {model.build_id}.")
 
@@ -562,8 +592,6 @@ class PrivateServiceSDK(WorkloadSDK):
                 certificate_path=model.ray_gcs_external_storage_config.redis_certificate_path,
             )
 
-        project = self.client.get_project(project_id)
-        compute_config = self.get_user_facing_compute_config(model.compute_config_id)
         tracing_config = None
         if model.tracing_config is not None:
             tracing_config = TracingConfig(
@@ -574,6 +602,7 @@ class PrivateServiceSDK(WorkloadSDK):
 
         return ServiceVersionStatus(
             id=self._get_user_facing_service_version_id(model),
+            created_at=model.created_at,
             state=model.current_state,
             # NOTE(edoakes): there is also a "current_weight" field but it does not match the UI.
             weight=model.weight,
@@ -615,50 +644,137 @@ class PrivateServiceSDK(WorkloadSDK):
 
         return state
 
-    def _service_model_to_status(self, model: ServiceModel) -> ServiceStatus:
-        # TODO(edoakes): for some reason the primary_version is populated
-        # when the service is terminated. This should be fixed in the backend.
-        is_terminated = model.current_state == ServiceEventCurrentState.TERMINATED
-
+    async def _service_model_to_status_async(
+        self, model: DecoratedProductionServiceV2APIModel
+    ) -> ServiceStatus:
         # TODO(edoakes): this is currently only exposed at the service level in the API,
         # which means that the per-version `query_auth_token_enabled` field will lie if
         # it's changed.
         query_auth_token_enabled = model.auth_token is not None
 
-        primary_version = None
-        if not is_terminated and model.primary_version is not None:
-            primary_version = self._service_version_model_to_status(
-                model.primary_version,
-                service_name=model.name,
-                project_id=model.project_id,
-                query_auth_token_enabled=query_auth_token_enabled,
+        primary_version_task = None
+        if model.primary_version is not None:
+            primary_version_task = asyncio.create_task(
+                self._service_version_model_to_status_async(
+                    model.primary_version,
+                    service_name=model.name,
+                    project_id=model.project_id,
+                    query_auth_token_enabled=query_auth_token_enabled,
+                )
             )
 
-        canary_version = None
-        if not is_terminated and model.canary_version is not None:
-            canary_version = self._service_version_model_to_status(
-                model.canary_version,
-                service_name=model.name,
-                project_id=model.project_id,
-                query_auth_token_enabled=query_auth_token_enabled,
+        canary_version_task = None
+        if model.canary_version is not None:
+            canary_version_task = asyncio.create_task(
+                self._service_version_model_to_status_async(
+                    model.canary_version,
+                    service_name=model.name,
+                    project_id=model.project_id,
+                    query_auth_token_enabled=query_auth_token_enabled,
+                )
             )
 
+        primary_version = await primary_version_task if primary_version_task else None
+        canary_version = await canary_version_task if canary_version_task else None
+
+        project_name = None
+        if primary_version and isinstance(primary_version.config, ServiceConfig):
+            project_name = primary_version.config.project
+
         return ServiceStatus(
             id=model.id,
             name=model.name,
+            creator=model.creator.email if model.creator else None,
             state=self._model_state_to_state(model.current_state),
             query_url=model.base_url,
             query_auth_token=model.auth_token,
             primary_version=primary_version,
             canary_version=canary_version,
+            project=project_name,
         )
 
     def status(
         self, name: str, *, cloud: Optional[str] = None, project: Optional[str] = None
     ) -> ServiceStatus:
         model = self._resolve_to_service_model(name=name, cloud=cloud, project=project)
+        return asyncio.run(self._service_model_to_status_async(model))
 
-        return self._service_model_to_status(model)
+    def list(  # noqa: PLR0912
+        self,
+        *,
+        # Single-item lookup
+        service_id: Optional[str] = None,
+        # Filters
+        name: Optional[str] = None,
+        state_filter: Optional[Union[List[ServiceState], List[str]]] = None,
+        creator_id: Optional[str] = None,
+        cloud: Optional[str] = None,
+        project: Optional[str] = None,
+        include_archived: bool = False,
+        # Paging
+        max_items: Optional[int] = None,  # Controls total items yielded by iterator
+        page_size: Optional[int] = None,  # Controls items fetched per API call
+        # Sorting
+        sort_field: Optional[Union[str, ServiceSortField]] = None,
+        sort_order: Optional[Union[str, SortOrder]] = None,
+    ) -> ResultIterator[ServiceStatus]:
+
+        if page_size is not None and (page_size <= 0 or page_size > MAX_PAGE_SIZE):
+            raise ValueError(
+                f"page_size must be between 1 and {MAX_PAGE_SIZE}, inclusive."
+            )
+
+        if service_id is not None:
+            raw = self.client.get_service_by_id(service_id)
+
+            def _fetch_single_page(
+                _token: Optional[str],
+            ) -> DecoratedlistserviceapimodelListResponse:
+                # Only return data on the first call (token=None), simulate single-item page
+                if _token is None and raw is not None:
+                    results = [raw]
+                    metadata = ListResponseMetadata(total=1, next_paging_token=None)
+                else:
+                    results = []
+                    metadata = ListResponseMetadata(total=0, next_paging_token=None)
+
+                return DecoratedlistserviceapimodelListResponse(
+                    results=results, metadata=metadata,
+                )
+
+            return ResultIterator(
+                page_token=None,
+                max_items=1,
+                fetch_page=_fetch_single_page,
+                async_parse_fn=self._service_model_to_status_async,
+                parse_fn=None,
+            )
+
+        normalised_states = _normalize_state_filter(state_filter)
+
+        def _fetch_page(
+            token: Optional[str],
+        ) -> DecoratedlistserviceapimodelListResponse:
+            return self.client.list_services(
+                name=name,
+                state_filter=normalised_states,
+                creator_id=creator_id,
+                cloud=cloud,
+                project=project,
+                include_archived=include_archived,
+                count=page_size,
+                paging_token=token,
+                sort_field=sort_field,
+                sort_order=sort_order,
+            )
+
+        return ResultIterator(
+            page_token=None,
+            max_items=max_items,
+            fetch_page=_fetch_page,
+            async_parse_fn=self._service_model_to_status_async,
+            parse_fn=None,
+        )
 
     def wait(
         self,
@@ -738,3 +854,23 @@ class PrivateServiceSDK(WorkloadSDK):
         return self.client.controller_logs_for_service_version(
             model.primary_version, head, max_lines
         )
+
+
+def _normalize_state_filter(
+    states: Optional[Union[List[ServiceState], List[str]]]
+) -> Optional[List[str]]:
+    if states is None:
+        return None
+
+    normalized: List[str] = []
+    for s in states:
+        if isinstance(s, ServiceState):
+            normalized.append(s.value)
+        elif isinstance(s, str):
+            normalized.append(s.upper())
+        else:
+            raise TypeError(
+                "'state_filter' entries must be ServiceState or str, "
+                f"got {type(s).__name__}"
+            )
+    return normalized