arize-phoenix 4.27.0__tar.gz → 4.29.0__tar.gz

{arize_phoenix-4.27.0 → arize_phoenix-4.29.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: arize-phoenix
-Version: 4.27.0
+Version: 4.29.0
 Summary: AI Observability and Evaluation
 Project-URL: Documentation, https://docs.arize.com/phoenix/
 Project-URL: Issues, https://github.com/Arize-ai/phoenix/issues
@@ -21,6 +21,7 @@ Requires-Dist: aioitertools
 Requires-Dist: aiosqlite
 Requires-Dist: alembic<2,>=1.3.0
 Requires-Dist: arize-phoenix-evals>=0.13.1
+Requires-Dist: arize-phoenix-otel>=0.4.1
 Requires-Dist: cachetools
 Requires-Dist: fastapi
 Requires-Dist: grpcio

{arize_phoenix-4.27.0 → arize_phoenix-4.29.0}/pyproject.toml

@@ -59,6 +59,7 @@ dependencies = [
   "cachetools",
   "python-multipart",  # see https://www.starlette.io/#dependencies
   "arize-phoenix-evals>=0.13.1",
+  "arize-phoenix-otel>=0.4.1",
   "fastapi",
   "pydantic>=1.0,!=2.0.*,<3", # exclude 2.0.* since it does not support the `json_encoders` configuration setting
   "pyjwt",

{arize_phoenix-4.27.0 → arize_phoenix-4.29.0}/src/phoenix/auth.py

@@ -39,7 +39,10 @@ def validate_password_format(password: str) -> None:
         raise ValueError("Password cannot contain whitespace characters")
     if not password.isascii():
         raise ValueError("Password can contain only ASCII characters")
+    if not len(password) >= MIN_PASSWORD_LENGTH:
+        raise ValueError(f"Password must be at least {MIN_PASSWORD_LENGTH} characters long")
 
 
 EMAIL_PATTERN = re.compile(r"^[^@\s]+@[^@\s]+[.][^@\s]+\Z")
 NUM_ITERATIONS = 10_000
+MIN_PASSWORD_LENGTH = 4

{arize_phoenix-4.27.0 → arize_phoenix-4.29.0}/src/phoenix/server/api/context.py

@@ -2,6 +2,7 @@ from dataclasses import dataclass
 from pathlib import Path
 from typing import Any, Optional
 
+from starlette.responses import Response as StarletteResponse
 from strawberry.fastapi import BaseContext
 
 from phoenix.core.model_schema import Model
@@ -77,7 +78,7 @@ class Context(BaseContext):
     secret: Optional[str] = None
 
     def get_secret(self) -> str:
-        """A type safe way to get the application secret. Throws an error if the secret is not set.
+        """A type-safe way to get the application secret. Throws an error if the secret is not set.
 
         Returns:
             str: the phoenix secret
@@ -88,3 +89,11 @@ class Context(BaseContext):
                 " Please set the PHOENIX_SECRET environment variable and re-deploy the application."
             )
         return self.secret
+
+    def get_response(self) -> StarletteResponse:
+        """
+        A type-safe way to get the response object. Throws an error if the response is not set.
+        """
+        if (response := self.response) is None:
+            raise ValueError("no response is set")
+        return response

{arize_phoenix-4.27.0 → arize_phoenix-4.29.0}/src/phoenix/server/api/dataloaders/dataset_example_revisions.py

@@ -10,6 +10,7 @@ from strawberry.dataloader import DataLoader
 from typing_extensions import TypeAlias
 
 from phoenix.db import models
+from phoenix.server.api.exceptions import NotFound
 from phoenix.server.api.types.DatasetExampleRevision import DatasetExampleRevision
 from phoenix.server.types import DbSessionFactory
 
@@ -24,7 +25,7 @@ class DatasetExampleRevisionsDataLoader(DataLoader[Key, Result]):
         super().__init__(load_fn=self._load_fn)
         self._db = db
 
-    async def _load_fn(self, keys: List[Key]) -> List[Union[Result, ValueError]]:
+    async def _load_fn(self, keys: List[Key]) -> List[Union[Result, NotFound]]:
         # sqlalchemy has limited SQLite support for VALUES, so use UNION ALL instead.
         # For details, see https://github.com/sqlalchemy/sqlalchemy/issues/7228
         keys_subquery = union(
@@ -95,4 +96,4 @@ class DatasetExampleRevisionsDataLoader(DataLoader[Key, Result]):
                 ) in await session.stream(query)
                 if is_valid_version
             }
-        return [results.get(key, ValueError("Could not find revision.")) for key in keys]
+        return [results.get(key, NotFound("Could not find revision.")) for key in keys]

arize_phoenix-4.29.0/src/phoenix/server/api/exceptions.py

@@ -0,0 +1,41 @@
+from graphql.error import GraphQLError
+from strawberry.extensions import MaskErrors
+
+
+class CustomGraphQLError(Exception):
+    """
+    An error that represents an expected error scenario in a GraphQL resolver.
+    """
+
+
+class BadRequest(CustomGraphQLError):
+    """
+    An error raised due to a malformed or invalid request.
+    """
+
+
+class NotFound(CustomGraphQLError):
+    """
+    An error raised when the requested resource is not found.
+    """
+
+
+class Unauthorized(CustomGraphQLError):
+    """
+    An error raised when login fails or a user or other entity is not authorized
+    to access a resource.
+    """
+
+
+def get_mask_errors_extension() -> MaskErrors:
+    return MaskErrors(
+        should_mask_error=_should_mask_error,
+        error_message="an unexpected error occurred",
+    )
+
+
+def _should_mask_error(error: GraphQLError) -> bool:
+    """
+    Masks unexpected errors raised from GraphQL resolvers.
+    """
+    return not isinstance(error.original_error, CustomGraphQLError)

{arize_phoenix-4.27.0 → arize_phoenix-4.29.0}/src/phoenix/server/api/mutations/__init__.py

@@ -1,6 +1,7 @@
 import strawberry
 
 from phoenix.server.api.mutations.api_key_mutations import ApiKeyMutationMixin
+from phoenix.server.api.mutations.auth_mutations import AuthMutationMixin
 from phoenix.server.api.mutations.dataset_mutations import DatasetMutationMixin
 from phoenix.server.api.mutations.experiment_mutations import ExperimentMutationMixin
 from phoenix.server.api.mutations.export_events_mutations import ExportEventsMutationMixin
@@ -12,13 +13,14 @@ from phoenix.server.api.mutations.user_mutations import UserMutationMixin
 
 @strawberry.type
 class Mutation(
-    ProjectMutationMixin,
+    ApiKeyMutationMixin,
+    AuthMutationMixin,
     DatasetMutationMixin,
     ExperimentMutationMixin,
     ExportEventsMutationMixin,
+    ProjectMutationMixin,
     SpanAnnotationMutationMixin,
     TraceAnnotationMutationMixin,
-    ApiKeyMutationMixin,
     UserMutationMixin,
 ):
     pass

{arize_phoenix-4.27.0 → arize_phoenix-4.29.0}/src/phoenix/server/api/mutations/api_key_mutations.py

@@ -5,12 +5,15 @@ import jwt
 import strawberry
 from sqlalchemy import insert, select
 from strawberry import UNSET
+from strawberry.relay import GlobalID
 from strawberry.types import Info
 
 from phoenix.db import models
 from phoenix.server.api.context import Context
+from phoenix.server.api.exceptions import NotFound
 from phoenix.server.api.mutations.auth import HasSecret, IsAuthenticated
 from phoenix.server.api.queries import Query
+from phoenix.server.api.types.node import from_global_id_with_expected_type
 from phoenix.server.api.types.SystemApiKey import SystemApiKey
 
 
@@ -28,6 +31,16 @@ class CreateApiKeyInput:
     expires_at: Optional[datetime] = UNSET
 
 
+@strawberry.input
+class DeleteApiKeyInput:
+    id: GlobalID
+
+
+@strawberry.type
+class DeleteSystemApiKeyMutationPayload:
+    id: GlobalID
+
+
 @strawberry.type
 class ApiKeyMutationMixin:
     @strawberry.mutation(permission_classes=[HasSecret, IsAuthenticated])  # type: ignore
@@ -79,6 +92,22 @@ class ApiKeyMutationMixin:
             query=Query(),
         )
 
+    @strawberry.mutation(permission_classes=[HasSecret, IsAuthenticated])  # type: ignore
+    async def delete_system_api_key(
+        self, info: Info[Context, None], input: DeleteApiKeyInput
+    ) -> DeleteSystemApiKeyMutationPayload:
+        api_key_id = from_global_id_with_expected_type(
+            input.id, expected_type_name=SystemApiKey.__name__
+        )
+        async with info.context.db() as session:
+            api_key = await session.get(models.APIKey, api_key_id)
+            if api_key is None:
+                raise NotFound(f"Unknown System API Key: {input.id}")
+
+            await session.delete(api_key)
+
+        return DeleteSystemApiKeyMutationPayload(id=input.id)
+
 
 def create_jwt(
     *,

arize_phoenix-4.29.0/src/phoenix/server/api/mutations/auth_mutations.py

@@ -0,0 +1,65 @@
+import asyncio
+from datetime import timedelta
+
+import strawberry
+from sqlalchemy import select
+from strawberry.types import Info
+
+from phoenix.auth import is_valid_password
+from phoenix.db import models
+from phoenix.server.api.context import Context
+from phoenix.server.api.exceptions import Unauthorized
+from phoenix.server.api.mutations.auth import HasSecret
+
+PHOENIX_ACCESS_TOKEN_COOKIE_NAME = "phoenix-access-token"
+PHOENIX_ACCESS_TOKEN_COOKIE_MAX_AGE_IN_SECONDS = int(timedelta(days=31).total_seconds())
+FAILED_LOGIN_MESSAGE = "login failed"
+
+
+@strawberry.input
+class LoginMutationInput:
+    email: str
+    password: str
+
+
+@strawberry.type
+class AuthMutationMixin:
+    @strawberry.mutation(permission_classes=[HasSecret])  # type: ignore
+    async def login(
+        self,
+        info: Info[Context, None],
+        input: LoginMutationInput,
+    ) -> None:
+        async with info.context.db() as session:
+            if (
+                user := await session.scalar(
+                    select(models.User).where(models.User.email == input.email)
+                )
+            ) is None or (password_hash := user.password_hash) is None:
+                raise Unauthorized(FAILED_LOGIN_MESSAGE)
+        secret = info.context.get_secret()
+        loop = asyncio.get_running_loop()
+        if not await loop.run_in_executor(
+            executor=None,
+            func=lambda: is_valid_password(
+                password=input.password, salt=secret, password_hash=password_hash
+            ),
+        ):
+            raise Unauthorized(FAILED_LOGIN_MESSAGE)
+        response = info.context.get_response()
+        response.set_cookie(
+            key=PHOENIX_ACCESS_TOKEN_COOKIE_NAME,
+            value="token",  # todo: compute access token
+            secure=True,
+            httponly=True,
+            samesite="strict",
+            max_age=PHOENIX_ACCESS_TOKEN_COOKIE_MAX_AGE_IN_SECONDS,
+        )
+
+    @strawberry.mutation(permission_classes=[HasSecret])  # type: ignore
+    async def logout(
+        self,
+        info: Info[Context, None],
+    ) -> None:
+        response = info.context.get_response()
+        response.delete_cookie(key=PHOENIX_ACCESS_TOKEN_COOKIE_NAME)

{arize_phoenix-4.27.0 → arize_phoenix-4.29.0}/src/phoenix/server/api/mutations/dataset_mutations.py

@@ -13,6 +13,7 @@ from strawberry.types import Info
 from phoenix.db import models
 from phoenix.db.helpers import get_eval_trace_ids_for_datasets, get_project_names_for_datasets
 from phoenix.server.api.context import Context
+from phoenix.server.api.exceptions import BadRequest, NotFound
 from phoenix.server.api.helpers.dataset_helpers import (
     get_dataset_example_input,
     get_dataset_example_output,
@@ -362,7 +363,7 @@ class DatasetMutationMixin:
                 expected_type_name=Dataset.__name__,
             )
         except ValueError:
-            raise ValueError(f"Unknown dataset: {input.dataset_id}")
+            raise NotFound(f"Unknown dataset: {input.dataset_id}")
         project_names_stmt = get_project_names_for_datasets(dataset_id)
         eval_trace_ids_stmt = get_eval_trace_ids_for_datasets(dataset_id)
         stmt = (
@@ -372,7 +373,7 @@ class DatasetMutationMixin:
             project_names = await session.scalars(project_names_stmt)
             eval_trace_ids = await session.scalars(eval_trace_ids_stmt)
             if not (dataset := await session.scalar(stmt)):
-                raise ValueError(f"Unknown dataset: {input.dataset_id}")
+                raise NotFound(f"Unknown dataset: {input.dataset_id}")
         await asyncio.gather(
             delete_projects(info.context.db, *project_names),
             delete_traces(info.context.db, *eval_trace_ids),
@@ -388,7 +389,7 @@ class DatasetMutationMixin:
         input: PatchDatasetExamplesInput,
     ) -> DatasetMutationPayload:
         if not (patches := input.patches):
-            raise ValueError("Must provide examples to patch.")
+            raise BadRequest("Must provide examples to patch.")
         by_numeric_id = [
             (
                 from_global_id_with_expected_type(patch.example_id, DatasetExample.__name__),
@@ -399,9 +400,9 @@ class DatasetMutationMixin:
         ]
         example_ids, _, patches = map(list, zip(*sorted(by_numeric_id)))
         if len(set(example_ids)) < len(example_ids):
-            raise ValueError("Cannot patch the same example more than once per mutation.")
+            raise BadRequest("Cannot patch the same example more than once per mutation.")
         if any(patch.is_empty() for patch in patches):
-            raise ValueError("Received one or more empty patches that contain no fields to update.")
+            raise BadRequest("Received one or more empty patches that contain no fields to update.")
         version_description = input.version_description or None
         version_metadata = input.version_metadata
         async with info.context.db() as session:
@@ -419,9 +420,9 @@ class DatasetMutationMixin:
                 )
             ).all()
             if not datasets:
-                raise ValueError("No examples found.")
+                raise NotFound("No examples found.")
             if len(set(ds.id for ds in datasets)) > 1:
-                raise ValueError("Examples must come from the same dataset.")
+                raise BadRequest("Examples must come from the same dataset.")
             dataset = datasets[0]
 
             revision_ids = (
@@ -445,7 +446,7 @@ class DatasetMutationMixin:
                 )
             ).all()
             if (num_missing_examples := len(example_ids) - len(revisions)) > 0:
-                raise ValueError(f"{num_missing_examples} example(s) could not be found.")
+                raise NotFound(f"{num_missing_examples} example(s) could not be found.")
 
             version_id = await session.scalar(
                 insert(models.DatasetVersion)

{arize_phoenix-4.27.0 → arize_phoenix-4.29.0}/src/phoenix/server/api/mutations/experiment_mutations.py

@@ -9,6 +9,7 @@ from strawberry.types import Info
 from phoenix.db import models
 from phoenix.db.helpers import get_eval_trace_ids_for_experiments, get_project_names_for_experiments
 from phoenix.server.api.context import Context
+from phoenix.server.api.exceptions import CustomGraphQLError
 from phoenix.server.api.input_types.DeleteExperimentsInput import DeleteExperimentsInput
 from phoenix.server.api.mutations.auth import IsAuthenticated
 from phoenix.server.api.types.Experiment import Experiment, to_gql_experiment
@@ -52,7 +53,7 @@ class ExperimentMutationMixin:
             }
             if unknown_experiment_ids := set(experiment_ids) - set(experiments.keys()):
                 await savepoint.rollback()
-                raise ValueError(
+                raise CustomGraphQLError(
                     "Failed to delete experiment(s), "
                     "probably due to invalid input experiment ID(s): "
                     + str(

{arize_phoenix-4.27.0 → arize_phoenix-4.29.0}/src/phoenix/server/api/queries.py

@@ -33,6 +33,7 @@ from phoenix.db.models import (
 )
 from phoenix.pointcloud.clustering import Hdbscan
 from phoenix.server.api.context import Context
+from phoenix.server.api.exceptions import NotFound
 from phoenix.server.api.helpers import ensure_list
 from phoenix.server.api.input_types.ClusterInput import ClusterInput
 from phoenix.server.api.input_types.Coordinates import (
@@ -391,7 +392,7 @@ class Query:
             async with info.context.db() as session:
                 project = (await session.execute(project_stmt)).first()
             if project is None:
-                raise ValueError(f"Unknown project: {id}")
+                raise NotFound(f"Unknown project: {id}")
             return Project(
                 id_attr=project.id,
                 name=project.name,
@@ -406,7 +407,7 @@ class Query:
             async with info.context.db() as session:
                 trace = (await session.execute(trace_stmt)).first()
             if trace is None:
-                raise ValueError(f"Unknown trace: {id}")
+                raise NotFound(f"Unknown trace: {id}")
             return Trace(
                 id_attr=trace.id, trace_id=trace.trace_id, project_rowid=trace.project_rowid
             )
@@ -421,13 +422,13 @@ class Query:
             async with info.context.db() as session:
                 span = await session.scalar(span_stmt)
             if span is None:
-                raise ValueError(f"Unknown span: {id}")
+                raise NotFound(f"Unknown span: {id}")
             return to_gql_span(span)
         elif type_name == Dataset.__name__:
             dataset_stmt = select(models.Dataset).where(models.Dataset.id == node_id)
             async with info.context.db() as session:
                 if (dataset := await session.scalar(dataset_stmt)) is None:
-                    raise ValueError(f"Unknown dataset: {id}")
+                    raise NotFound(f"Unknown dataset: {id}")
             return to_gql_dataset(dataset)
         elif type_name == DatasetExample.__name__:
             example_id = node_id
@@ -453,7 +454,7 @@ class Query:
                     )
                 )
             if not example:
-                raise ValueError(f"Unknown dataset example: {id}")
+                raise NotFound(f"Unknown dataset example: {id}")
             return DatasetExample(
                 id_attr=example.id,
                 created_at=example.created_at,
@@ -464,7 +465,7 @@ class Query:
                     select(models.Experiment).where(models.Experiment.id == node_id)
                 )
             if not experiment:
-                raise ValueError(f"Unknown experiment: {id}")
+                raise NotFound(f"Unknown experiment: {id}")
             return Experiment(
                 id_attr=experiment.id,
                 name=experiment.name,
@@ -485,9 +486,9 @@ class Query:
                         )
                     )
                 ):
-                    raise ValueError(f"Unknown experiment run: {id}")
+                    raise NotFound(f"Unknown experiment run: {id}")
             return to_gql_experiment_run(run)
-        raise Exception(f"Unknown node type: {type_name}")
+        raise NotFound(f"Unknown node type: {type_name}")
 
     @strawberry.field
     def clusters(

{arize_phoenix-4.27.0 → arize_phoenix-4.29.0}/src/phoenix/server/api/routers/v1/experiments.py

@@ -2,7 +2,7 @@ from datetime import datetime
 from random import getrandbits
 from typing import Any, Dict, List, Optional
 
-from fastapi import APIRouter, HTTPException
+from fastapi import APIRouter, HTTPException, Path
 from pydantic import Field
 from sqlalchemy import select
 from starlette.requests import Request
@@ -18,7 +18,7 @@ from phoenix.server.dml_event import ExperimentInsertEvent
 from .pydantic_compat import V1RoutesBaseModel
 from .utils import ResponseBody, add_errors_to_responses
 
-router = APIRouter(tags=["experiments"], include_in_schema=False)
+router = APIRouter(tags=["experiments"], include_in_schema=True)
 
 
 def _short_uuid() -> str:
@@ -90,8 +90,8 @@ class CreateExperimentResponseBody(ResponseBody[Experiment]):
 )
 async def create_experiment(
     request: Request,
-    dataset_id: str,
     request_body: CreateExperimentRequestBody,
+    dataset_id: str = Path(..., title="Dataset ID"),
 ) -> CreateExperimentResponseBody:
     dataset_globalid = GlobalID.from_id(dataset_id)
     try:
@@ -266,7 +266,7 @@ class ListExperimentsResponseBody(ResponseBody[List[Experiment]]):
 )
 async def list_experiments(
     request: Request,
-    dataset_id: str,
+    dataset_id: str = Path(..., title="Dataset ID"),
 ) -> ListExperimentsResponseBody:
     dataset_gid = GlobalID.from_id(dataset_id)
     try:

{arize_phoenix-4.27.0 → arize_phoenix-4.29.0}/src/phoenix/server/api/schema.py

@@ -1,5 +1,6 @@
 import strawberry
 
+from phoenix.server.api.exceptions import get_mask_errors_extension
 from phoenix.server.api.mutations import Mutation
 from phoenix.server.api.queries import Query
 
@@ -10,4 +11,5 @@ from phoenix.server.api.queries import Query
 schema = strawberry.Schema(
     query=Query,
     mutation=Mutation,
+    extensions=[get_mask_errors_extension()],
 )

{arize_phoenix-4.27.0 → arize_phoenix-4.29.0}/src/phoenix/server/app.py

@@ -79,7 +79,6 @@ from phoenix.server.api.dataloaders import (
     TokenCountDataLoader,
     TraceRowIdsDataLoader,
 )
-from phoenix.server.api.routers.auth import router as auth_router
 from phoenix.server.api.routers.v1 import REST_API_VERSION
 from phoenix.server.api.routers.v1 import router as v1_router
 from phoenix.server.api.schema import schema
@@ -662,8 +661,6 @@ def create_app(
     app.include_router(router)
     app.include_router(graphql_router)
     app.add_middleware(GZipMiddleware)
-    if authentication_enabled:
-        app.include_router(auth_router)
     if serve_ui:
         app.mount(
             "/",

{arize_phoenix-4.27.0 → arize_phoenix-4.29.0}/src/phoenix/server/static/.vite/manifest.json

@@ -1,21 +1,21 @@
 {
-  "_components-1MfQimGx.js": {
-    "file": "assets/components-1MfQimGx.js",
+  "_components-BYH03rjA.js": {
+    "file": "assets/components-BYH03rjA.js",
     "name": "components",
     "imports": [
       "_vendor-aSQri0vz.js",
       "_vendor-arizeai-CsdcB1NH.js",
-      "_pages-CqZDVx20.js",
+      "_pages-DnbxgoTK.js",
       "_vendor-three-DwGkEfCM.js",
       "_vendor-codemirror-CYHkhs7D.js"
     ]
   },
-  "_pages-CqZDVx20.js": {
-    "file": "assets/pages-CqZDVx20.js",
+  "_pages-DnbxgoTK.js": {
+    "file": "assets/pages-DnbxgoTK.js",
     "name": "pages",
     "imports": [
       "_vendor-aSQri0vz.js",
-      "_components-1MfQimGx.js",
+      "_components-BYH03rjA.js",
       "_vendor-arizeai-CsdcB1NH.js",
       "_vendor-recharts-B0sannek.js",
       "_vendor-codemirror-CYHkhs7D.js"
@@ -61,15 +61,15 @@
     "name": "vendor-three"
   },
   "index.tsx": {
-    "file": "assets/index-B263sE2x.js",
+    "file": "assets/index-fqdjNpYm.js",
     "name": "index",
     "src": "index.tsx",
     "isEntry": true,
     "imports": [
       "_vendor-aSQri0vz.js",
       "_vendor-arizeai-CsdcB1NH.js",
-      "_pages-CqZDVx20.js",
-      "_components-1MfQimGx.js",
+      "_pages-DnbxgoTK.js",
+      "_components-BYH03rjA.js",
       "_vendor-three-DwGkEfCM.js",
       "_vendor-recharts-B0sannek.js",
       "_vendor-codemirror-CYHkhs7D.js"