diff --git a/.github/e2e-stack/assert_tests_ran.py b/.github/e2e-stack/assert_tests_ran.py index 2303c42f4fb..1b051f860cc 100644 --- a/.github/e2e-stack/assert_tests_ran.py +++ b/.github/e2e-stack/assert_tests_ran.py @@ -1,3 +1,5 @@ +import os +import re import sys import xml.etree.ElementTree as ET from pathlib import Path @@ -15,6 +17,12 @@ def main() -> int: _ = sys.stdout.write("::error::could not read the test execution report\n") return 1 cases: Final = tuple(report.iter("testcase")) + expected_count: Final = os.environ.get("E2E_REQUIRED_TEST_COUNT") + if expected_count is not None and ( + len(cases) != int(expected_count) or any(case.find("skipped") is not None for case in cases) + ): + _ = sys.stdout.write("::error::required test count was not met or a required case was skipped\n") + return 1 passed: Final = frozenset( case.get("file") for case in cases if all(case.find(tag) is None for tag in ("skipped", "failure", "error")) ) @@ -38,6 +46,13 @@ def main() -> int: if case.get("file") != path or all(case.find(tag) is None for tag in ("failure", "error")): continue _ = sys.stdout.write(f" failed: {case.get('classname', '')}::{case.get('name', '')}\n") + for prop in case.findall("./properties/property"): + name = prop.get("name", "") + value = prop.get("value", "") + if name in ("oauth_failure_phase", "oauth_exception_type", "oauth_frame") and re.fullmatch( + r"[A-Za-z0-9_.:<>-]{1,240}", value + ): + _ = sys.stdout.write(f" {name}: {value}\n") if ( selected and not missing diff --git a/.github/e2e-stack/select_tests.py b/.github/e2e-stack/select_tests.py index 982e93cf642..a9ca1f88660 100644 --- a/.github/e2e-stack/select_tests.py +++ b/.github/e2e-stack/select_tests.py @@ -5,6 +5,7 @@ from typing import Final SELECTABLE: Final = re.compile(r"^tests/e2e/([A-Za-z0-9_.-]+/)*test_[A-Za-z0-9_.-]+\.py$") UNSUPPORTED: Final = re.compile( r"^tests/e2e/(ui|claude_code|load)/" + r"|^tests/e2e/mcp/test_mcp_oauth_happy_path_e2e\.py$" r"|^tests/e2e/llm_translation/realtime/test_realtime_pipecat_audio_e2e\.py$" r"|^tests/e2e/batches/test_managed_files_enforcement_e2e\.py$" r"|^tests/e2e/guardrails/test_presidio_masking_e2e\.py$" diff --git a/.github/workflows/test-mcp-oauth-e2e.yml b/.github/workflows/test-mcp-oauth-e2e.yml new file mode 100644 index 00000000000..034b9fe49ec --- /dev/null +++ b/.github/workflows/test-mcp-oauth-e2e.yml @@ -0,0 +1,177 @@ +name: MCP OAuth happy path + +on: + pull_request: + paths: + - '.github/workflows/test-mcp-oauth-e2e.yml' + - '.github/e2e-stack/**' + - 'tests/e2e/*.py' + - 'tests/e2e/pytest.ini' + - 'tests/e2e/idp_realm.json' + - 'tests/e2e/mcp/**' + - 'litellm/experimental_mcp_client/**' + - 'litellm/proxy/_experimental/mcp_server/**' + - 'litellm/proxy/auth/**' + - 'litellm/proxy/management_endpoints/*sso*.py' + - 'litellm/proxy/management_endpoints/sso/**' + - 'litellm/proxy/common_utils/encrypt_decrypt_utils.py' + - 'litellm/proxy/proxy_server.py' + - 'litellm/proxy/schema.prisma' + - 'ui/litellm-dashboard/src/app/connect/**' + - 'ui/litellm-dashboard/src/app/mcp/oauth/**' + - 'pyproject.toml' + - 'uv.lock' + workflow_dispatch: + +permissions: {} + +concurrency: + group: mcp-oauth-${{ github.ref }} + cancel-in-progress: true + +jobs: + oauth: + if: github.event_name == 'workflow_dispatch' || github.event.pull_request.head.repo.full_name == github.repository + runs-on: ubuntu-latest + environment: e2e-changed + timeout-minutes: 45 + permissions: + contents: read + id-token: write + services: + postgres: + image: postgres:16.6 + env: + POSTGRES_USER: litellm + POSTGRES_PASSWORD: dbpassword9090 + POSTGRES_DB: litellm + ports: + - 5432:5432 + options: >- + --health-cmd "pg_isready -U litellm" + --health-interval 5s + --health-timeout 5s + --health-retries 10 + env: + DATABASE_HOST: 127.0.0.1 + DATABASE_PORT: '5432' + DATABASE_USER: litellm + DATABASE_PASSWORD: dbpassword9090 + DATABASE_NAME: litellm + DATABASE_URL: postgresql://litellm:dbpassword9090@127.0.0.1:5432/litellm + E2E_KEYCLOAK_URL: http://127.0.0.1:8081 + E2E_KEYCLOAK_ADMIN_USER: admin + E2E_KEYCLOAK_ADMIN_PASSWORD: e2e-ephemeral-idp-not-a-secret + E2E_FIXTURE_MODE: live + E2E_PROVIDER_CACHE: '0' + E2E_MCP_OAUTH_LIVE: '1' + E2E_REQUIRED_TEST_COUNT: '4' + steps: + - name: Checkout the tested source + uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0 + with: + ref: ${{ github.event.pull_request.head.sha || github.sha }} + persist-credentials: false + + - name: Require and materialize the upstream login + env: + STORAGE_STATE: ${{ secrets.E2E_LINEAR_STORAGE_STATE_B64 }} + run: | + umask 077 + python3 - <<'PY' + import base64 + import json + import os + import secrets + from pathlib import Path + encoded = os.environ.get("STORAGE_STATE", "") + if not encoded: + raise SystemExit("E2E_LINEAR_STORAGE_STATE_B64 is required; capture and provision a test-account login") + state = json.loads(base64.b64decode(encoded, validate=True)) + if not isinstance(state, dict) or not state.get("cookies"): + raise SystemExit("The captured login must contain browser cookies") + directory = Path(os.environ["RUNNER_TEMP"]) / "mcp-oauth-private" + directory.mkdir(mode=0o700) + path = directory / "linear-state.json" + path.write_text(json.dumps(state)) + with open(os.environ["GITHUB_ENV"], "a") as output: + output.write(f"E2E_LINEAR_STORAGE_STATE={path}\n") + for name in ("LITELLM_MASTER_KEY", "LITELLM_SALT_KEY"): + value = "sk-e2e-" + secrets.token_hex(24) + print(f"::add-mask::{value}") + output.write(f"{name}={value}\n") + PY + + - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 + with: + python-version: '3.13' + - uses: ./.github/actions/setup-uv-with-retries + with: + version: '0.10.9' + - uses: ./.github/actions/cache-cargo-build + - name: Install the frozen E2E environment + run: | + .github/scripts/uv_sync_with_retries.sh --frozen --extra proxy --extra proxy-runtime --extra extra_proxy --group ci --group proxy-dev --group e2e-dev + uv run --no-sync python scripts/prisma_generate_if_needed.py + uv run --no-sync playwright install --with-deps chromium + + - name: Configure license access + id: aws + uses: aws-actions/configure-aws-credentials@e7f100cf4c008499ea8adda475de1042d6975c7b # v6.2.0 + with: + role-to-assume: ${{ vars.E2E_AWS_ROLE_TO_ASSUME }} + aws-region: us-east-1 + role-session-name: mcp-oauth-${{ github.run_id }} + role-duration-seconds: 900 + output-env-credentials: false + output-credentials: true + - name: Load the E2E license + env: + AWS_ACCESS_KEY_ID: ${{ steps.aws.outputs.aws-access-key-id }} + AWS_SECRET_ACCESS_KEY: ${{ steps.aws.outputs.aws-secret-access-key }} + AWS_SESSION_TOKEN: ${{ steps.aws.outputs.aws-session-token }} + AWS_DEFAULT_REGION: us-east-1 + run: | + license="$(aws secretsmanager get-secret-value --secret-id litellm-e2e-changed-license --query SecretString --output text)" + test -n "${license}" + echo "::add-mask::${license}" + echo "LITELLM_LICENSE=${license}" >> "${GITHUB_ENV}" + + - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + with: + node-version-file: ui/litellm-dashboard/.nvmrc + - name: Build the gateway consent UI at the tested commit + run: | + cd ui/litellm-dashboard + ../../scripts/with_dashboard_node.sh npm ci + ../../scripts/with_dashboard_node.sh npm run build + mkdir -p ../../litellm/proxy/_experimental/out + cp -r out/. ../../litellm/proxy/_experimental/out/ + find ../../litellm/proxy/_experimental/out -name '*.html' ! -name index.html | while read -r page; do + mkdir -p "${page%.html}" + mv "${page}" "${page%.html}/index.html" + done + + - name: Prepare the isolated database and IdP + run: | + umask 077 + bash .github/e2e-stack/start-idp.sh + uv run --no-sync python migrations/run.py > "${RUNNER_TEMP}/mcp-oauth-private/migrations.log" 2>&1 + + - name: Run every required OAuth variant without retries + run: | + umask 077 + uv run --no-sync pytest -c tests/e2e/pytest.ini tests/e2e/mcp/test_mcp_oauth_happy_path_e2e.py \ + --rootdir=. --reruns 0 --tb=short -o junit_family=xunit1 \ + --junitxml="${RUNNER_TEMP}/mcp-oauth-private/results.xml" \ + > "${RUNNER_TEMP}/mcp-oauth-private/pytest.log" 2>&1 + - name: Report JUnit results and reject skipped or missing cases + if: always() + run: | + uv run --no-sync python .github/e2e-stack/assert_tests_ran.py \ + "${RUNNER_TEMP}/mcp-oauth-private/results.xml" tests/e2e/mcp/test_mcp_oauth_happy_path_e2e.py + - name: Remove private login and logs + if: always() + run: | + docker rm -f e2e-keycloak >/dev/null 2>&1 || true + rm -rf "${RUNNER_TEMP}/mcp-oauth-private" diff --git a/enterprise/litellm_enterprise/enterprise_callbacks/send_emails/endpoints.py b/enterprise/litellm_enterprise/enterprise_callbacks/send_emails/endpoints.py index 61681c27ee9..1ab173a915a 100644 --- a/enterprise/litellm_enterprise/enterprise_callbacks/send_emails/endpoints.py +++ b/enterprise/litellm_enterprise/enterprise_callbacks/send_emails/endpoints.py @@ -60,6 +60,11 @@ async def _get_email_settings(prisma_client) -> Dict[str, bool]: async def _save_email_settings(prisma_client, settings: Dict[str, bool]): """Helper function to save email settings to general_settings in db""" + from litellm.proxy.proxy_server import proxy_config + + proxy_config.reject_config_owned_writes( + section_name="general_settings", changed_keys={"email_settings": settings} + ) try: verbose_proxy_logger.debug( f"Saving email settings to general_settings: {settings}" @@ -168,6 +173,8 @@ async def update_event_settings( await _save_email_settings(prisma_client, settings_dict) return {"message": "Email event settings updated successfully"} + except HTTPException: + raise except Exception as e: verbose_proxy_logger.exception(f"Error updating email settings: {str(e)}") raise HTTPException(status_code=500, detail=str(e)) @@ -197,6 +204,8 @@ async def reset_event_settings( await _save_email_settings(prisma_client, default_settings) return {"message": "Email event settings reset to defaults"} + except HTTPException: + raise except Exception as e: verbose_proxy_logger.exception(f"Error resetting email settings: {str(e)}") raise HTTPException(status_code=500, detail=str(e)) diff --git a/enterprise/litellm_enterprise/proxy/hooks/managed_files.py b/enterprise/litellm_enterprise/proxy/hooks/managed_files.py index 4899b87da7a..09cd0ed192f 100644 --- a/enterprise/litellm_enterprise/proxy/hooks/managed_files.py +++ b/enterprise/litellm_enterprise/proxy/hooks/managed_files.py @@ -20,6 +20,7 @@ from typing import ( ) from uuid import NAMESPACE_URL, uuid5 +import httpx from fastapi import HTTPException from pydantic import ValidationError @@ -34,6 +35,7 @@ from litellm.litellm_core_utils.prompt_templates.common_utils import ( ) from openai.types.file_deleted import FileDeleted +from litellm.llms.base_llm.files.storage_backend_factory import get_storage_backend from litellm.llms.base_llm.files.transformation import BaseFileEndpoints from litellm.llms.base_llm.managed_resources.isolation import ( build_list_page, @@ -59,6 +61,7 @@ from litellm.proxy.openai_files_endpoints.common_utils import ( get_content_type_from_file_object, get_model_id_from_unified_batch_id, get_original_file_id, + is_litellm_executed_batch, map_raw_file_ids_to_unified, normalize_mime_type_for_provider, resolve_managed_output_file_model_name, @@ -75,6 +78,7 @@ from litellm.types.llms.openai import ( # pyright: ignore[reportAttributeAccess CreateFileRequest, FileListPage, FileObject, + HttpxBinaryResponseContent, OpenAIFileObject, ResponsesAPIResponse, ) @@ -86,10 +90,6 @@ from litellm.types.utils import ( SpecialEnums, ) -if TYPE_CHECKING: - from litellm.types.llms.openai import HttpxBinaryResponseContent - - if TYPE_CHECKING: from opentelemetry.trace import Span as _Span from prisma.models import ( @@ -204,6 +204,19 @@ def _managed_object_table(prisma_client: PrismaClient) -> _ManagedObjectTableAct return prisma_client.db.litellm_managedobjecttable +def _storage_metadata_of(file_object: OpenAIFileObject | None) -> Mapping[str, str]: + hidden_params: Final = cast( # cast-ok: _hidden_params is an untyped attribute the upload path sets + "Mapping[str, object]", getattr(file_object, "_hidden_params", None) or {} + ) + return MappingProxyType( + { + key: value + for key in ("storage_backend", "storage_url") + if isinstance(value := hidden_params.get(key), str) + } + ) + + class _PROXY_LiteLLMManagedFiles(CustomLogger, BaseFileEndpoints): # Class variables or attributes def __init__(self, internal_usage_cache: InternalUsageCache, prisma_client: PrismaClient): @@ -226,6 +239,7 @@ class _PROXY_LiteLLMManagedFiles(CustomLogger, BaseFileEndpoints): user_api_key_dict: UserAPIKeyAuth, ) -> None: verbose_logger.info(f"Storing LiteLLM Managed File object with id={file_id} in cache") + storage_metadata: Final = _storage_metadata_of(file_object) if file_object is not None: litellm_managed_file_object = LiteLLM_ManagedFileTable( unified_file_id=file_id, @@ -235,6 +249,8 @@ class _PROXY_LiteLLMManagedFiles(CustomLogger, BaseFileEndpoints): created_by=resolve_resource_owner_id(user_api_key_dict), team_id=user_api_key_dict.team_id, updated_by=user_api_key_dict.user_id, + storage_backend=storage_metadata.get("storage_backend"), + storage_url=storage_metadata.get("storage_url"), ) await self.internal_usage_cache.async_set_cache( key=file_id, @@ -262,14 +278,8 @@ class _PROXY_LiteLLMManagedFiles(CustomLogger, BaseFileEndpoints): file_object_json = file_object.model_dump_json() db_data["file_object"] = file_object_json update_data["file_object"] = file_object_json - # Extract storage metadata from hidden params if present - hidden_params = getattr(file_object, "_hidden_params", {}) or {} - if "storage_backend" in hidden_params: - db_data["storage_backend"] = hidden_params["storage_backend"] - update_data["storage_backend"] = hidden_params["storage_backend"] - if "storage_url" in hidden_params: - db_data["storage_url"] = hidden_params["storage_url"] - update_data["storage_url"] = hidden_params["storage_url"] + db_data.update(storage_metadata) + update_data.update(storage_metadata) verbose_logger.debug( f"Storage metadata: storage_backend={db_data.get('storage_backend')}, " @@ -314,6 +324,7 @@ class _PROXY_LiteLLMManagedFiles(CustomLogger, BaseFileEndpoints): request_tags: Sequence[str] | None = None, persist_attribution: bool = False, create_if_missing: bool = True, + batch_processed: bool = False, ) -> None: """Persist a managed object row, caching it and upserting it in the DB. @@ -328,6 +339,10 @@ class _PROXY_LiteLLMManagedFiles(CustomLogger, BaseFileEndpoints): row absent from the table is left absent rather than created with the observer as its creator, because created_by and team_id are written from whoever calls the create branch. + + batch_processed is set by callers that have already billed the batch + themselves, so CheckBatchCost skips the row instead of billing it twice. + It is written only in the upsert create branch. """ verbose_logger.info(f"Storing LiteLLM Managed {file_purpose} object with id={unified_object_id} in cache") litellm_managed_object = LiteLLM_ManagedObjectTable( @@ -379,6 +394,7 @@ class _PROXY_LiteLLMManagedFiles(CustomLogger, BaseFileEndpoints): "updated_by": user_api_key_dict.user_id, "status": file_object.status, **attribution_columns, + "batch_processed": batch_processed, }, "update": update_columns, }, @@ -1343,6 +1359,9 @@ class _PROXY_LiteLLMManagedFiles(CustomLogger, BaseFileEndpoints): self, data: Dict, user_api_key_dict: UserAPIKeyAuth, response: LLMResponseTypes ) -> LLMResponseTypes: if isinstance(response, LiteLLMBatch): + decoded_batch_id: Final = _is_base64_encoded_unified_file_id(response.id) + if decoded_batch_id and is_litellm_executed_batch(decoded_batch_id): + return response ## Check if unified_file_id is in the response unified_file_id = response._hidden_params.get("unified_file_id") # managed file id unified_batch_id = response._hidden_params.get("unified_batch_id") # managed batch id @@ -1794,24 +1813,11 @@ class _PROXY_LiteLLMManagedFiles(CustomLogger, BaseFileEndpoints): # Check if file deletion should be blocked due to batch references await self._check_file_deletion_allowed(file_id) - # file_id = convert_b64_uid_to_unified_uid(file_id) - model_file_id_mapping = await self.get_model_file_id_mapping([file_id], litellm_parent_otel_span) - - specific_model_file_id_mapping = model_file_id_mapping.get(file_id) - if specific_model_file_id_mapping: - # Remove conflicting keys from data to avoid duplicate keyword arguments - filtered_data = {k: v for k, v in data.items() if k not in ("model", "file_id")} - for model_id, model_file_id in specific_model_file_id_mapping.items(): - credentials = llm_router.get_deployment_credentials_with_provider(model_id=model_id) - delete_data = { - **{k: v for k, v in filtered_data.items() if k != "_litellm_internal_model_credentials"}, - **( - {"_litellm_internal_model_credentials": MappingProxyType(dict(credentials))} - if credentials is not None - else {} - ), - } - await llm_router.afile_delete(model=model_id, file_id=model_file_id, **delete_data) + managed_file: Final = await self.get_unified_file_id(file_id, litellm_parent_otel_span) + if managed_file is not None and managed_file.storage_backend and managed_file.storage_url: + await self._delete_storage_backend_content(managed_file.storage_backend, managed_file.storage_url) + else: + await self._delete_provider_files(file_id, litellm_parent_otel_span, llm_router, data) await self.delete_unified_file_id(file_id, litellm_parent_otel_span) @@ -1820,16 +1826,53 @@ class _PROXY_LiteLLMManagedFiles(CustomLogger, BaseFileEndpoints): prom_logger.record_managed_file_deleted(result="success") return FileDeleted(id=file_id, object="file", deleted=True) + async def _delete_storage_backend_content(self, storage_backend_name: str, storage_url: str) -> None: + try: + storage_backend: Final = get_storage_backend(storage_backend_name, prisma_client=self.prisma_client) + except ValueError as e: + raise HTTPException(status_code=400, detail=f"Cannot delete the stored file content: {e}") from e + await storage_backend.delete_file(storage_url) + + async def _delete_provider_files( + self, + file_id: str, + litellm_parent_otel_span: Span | None, + llm_router: Router, + data: Mapping[str, object], + ) -> None: + model_file_id_mapping: Final = await self.get_model_file_id_mapping([file_id], litellm_parent_otel_span) + specific_model_file_id_mapping: Final = model_file_id_mapping.get(file_id) + if not specific_model_file_id_mapping: + return + filtered_data: Final = { + k: v for k, v in data.items() if k not in ("model", "file_id", "_litellm_internal_model_credentials") + } + for model_id, model_file_id in specific_model_file_id_mapping.items(): + credentials = llm_router.get_deployment_credentials_with_provider(model_id=model_id) + delete_data = { + **filtered_data, + **( + {"_litellm_internal_model_credentials": MappingProxyType(dict(credentials))} + if credentials is not None + else {} + ), + } + await llm_router.afile_delete(model=model_id, file_id=model_file_id, **delete_data) + async def afile_content( self, file_id: str, litellm_parent_otel_span: Optional[Span], llm_router: Router, **data: Dict, - ) -> "HttpxBinaryResponseContent": + ) -> HttpxBinaryResponseContent: """ Get the content of a file from first model that has it """ + managed_file: Final = await self.get_unified_file_id(file_id, litellm_parent_otel_span) + if managed_file is not None and managed_file.storage_backend and managed_file.storage_url: + return await self._storage_backend_content(managed_file.storage_backend, managed_file.storage_url) + model_file_id_mapping = data.pop("model_file_id_mapping", None) model_file_id_mapping = model_file_id_mapping or await self.get_model_file_id_mapping( [file_id], litellm_parent_otel_span @@ -1859,6 +1902,11 @@ class _PROXY_LiteLLMManagedFiles(CustomLogger, BaseFileEndpoints): else: raise Exception(f"LiteLLM Managed File object with id={file_id} not found") + async def _storage_backend_content(self, storage_backend_name: str, storage_url: str) -> HttpxBinaryResponseContent: + storage_backend: Final = get_storage_backend(storage_backend_name, prisma_client=self.prisma_client) + content: Final = await storage_backend.download_file(storage_url) + return HttpxBinaryResponseContent(response=httpx.Response(status_code=httpx.codes.OK, content=content)) + async def _convert_storage_files_to_base64( self, messages: List[AllMessageValues], @@ -1889,16 +1937,12 @@ class _PROXY_LiteLLMManagedFiles(CustomLogger, BaseFileEndpoints): # File is stored in a storage backend, download and convert to base64 try: - from litellm.llms.base_llm.files.storage_backend_factory import ( - get_storage_backend, - ) - storage_backend_name = db_file.storage_backend storage_url = db_file.storage_url # Get storage backend (uses same env vars as callback) try: - storage_backend = get_storage_backend(storage_backend_name) + storage_backend = get_storage_backend(storage_backend_name, prisma_client=self.prisma_client) except ValueError as e: verbose_logger.warning( f"Storage backend '{storage_backend_name}' error for file {file_id}: {str(e)}" diff --git a/enterprise/pyproject.toml b/enterprise/pyproject.toml index 06b1da7ea76..729f3264706 100644 --- a/enterprise/pyproject.toml +++ b/enterprise/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "litellm-enterprise" -version = "0.1.68" +version = "0.1.69" description = "Package for LiteLLM Enterprise features" readme = "README.md" requires-python = ">=3.9" @@ -26,7 +26,7 @@ required-version = ">=0.10.9" module-root = "" [tool.commitizen] -version = "0.1.68" +version = "0.1.69" version_files = [ "pyproject.toml:^version", "../pyproject.toml:litellm-enterprise==", diff --git a/litellm-proxy-extras/litellm_proxy_extras/migrations/20260915000000_add_autorouter_savings_estimate_coverage/migration.sql b/litellm-proxy-extras/litellm_proxy_extras/migrations/20260915000000_add_autorouter_savings_estimate_coverage/migration.sql new file mode 100644 index 00000000000..88e404b189d --- /dev/null +++ b/litellm-proxy-extras/litellm_proxy_extras/migrations/20260915000000_add_autorouter_savings_estimate_coverage/migration.sql @@ -0,0 +1,5 @@ +ALTER TABLE "LiteLLM_AutoRouterSession" +ADD COLUMN IF NOT EXISTS "savings_estimated_turns" INTEGER NOT NULL DEFAULT 0, +ADD COLUMN IF NOT EXISTS "savings_estimated_actual_spend" DOUBLE PRECISION NOT NULL DEFAULT 0, +ADD COLUMN IF NOT EXISTS "savings_estimated_saved_spend" DOUBLE PRECISION NOT NULL DEFAULT 0, +ADD COLUMN IF NOT EXISTS "savings_estimated_baseline_models" JSONB NOT NULL DEFAULT '{}'; diff --git a/litellm-proxy-extras/litellm_proxy_extras/migrations/20260915010000_add_autorouter_baseline_state/migration.sql b/litellm-proxy-extras/litellm_proxy_extras/migrations/20260915010000_add_autorouter_baseline_state/migration.sql new file mode 100644 index 00000000000..1720ee03843 --- /dev/null +++ b/litellm-proxy-extras/litellm_proxy_extras/migrations/20260915010000_add_autorouter_baseline_state/migration.sql @@ -0,0 +1,36 @@ +CREATE TABLE IF NOT EXISTS "LiteLLM_AutoRouterBaselineComparison" ( + "scope" TEXT PRIMARY KEY, + "api_key" TEXT NOT NULL, + "session_id" TEXT NOT NULL, + "router_name" TEXT NOT NULL, + "initial_equivalent" BOOLEAN NOT NULL, + "revision" BIGINT NOT NULL DEFAULT 0, + "published_revision" BIGINT NOT NULL DEFAULT 0, + "history" TEXT, + "attempted_at" TIMESTAMP(3), + "retired" BOOLEAN NOT NULL DEFAULT FALSE, + "updated_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP +); + +CREATE INDEX IF NOT EXISTS "idx_autorouter_baseline_scope" + ON "LiteLLM_AutoRouterBaselineComparison" ("api_key", "session_id", "router_name"); +CREATE INDEX IF NOT EXISTS "idx_autorouter_baseline_updated" + ON "LiteLLM_AutoRouterBaselineComparison" ("updated_at"); +CREATE INDEX IF NOT EXISTS "idx_autorouter_baseline_dirty" + ON "LiteLLM_AutoRouterBaselineComparison" ("attempted_at", "updated_at", "scope") + WHERE NOT "retired" AND "revision" <> "published_revision"; + +CREATE TABLE IF NOT EXISTS "LiteLLM_AutoRouterBaselineObservation" ( + "request_id" TEXT PRIMARY KEY, + "scope" TEXT NOT NULL, + "started_at" DOUBLE PRECISION NOT NULL, + "revision" BIGINT NOT NULL, + "data" TEXT NOT NULL, + "publication" TEXT, + "conflicted" BOOLEAN NOT NULL DEFAULT FALSE +); + +CREATE INDEX IF NOT EXISTS "idx_autorouter_baseline_event_order" + ON "LiteLLM_AutoRouterBaselineObservation" ("scope", "started_at", "request_id"); +CREATE INDEX IF NOT EXISTS "idx_autorouter_baseline_event_revision" + ON "LiteLLM_AutoRouterBaselineObservation" ("scope", "revision", "started_at"); diff --git a/litellm-proxy-extras/litellm_proxy_extras/migrations/20260918000000_add_managed_file_content_table/migration.sql b/litellm-proxy-extras/litellm_proxy_extras/migrations/20260918000000_add_managed_file_content_table/migration.sql new file mode 100644 index 00000000000..bb1a3eab6ee --- /dev/null +++ b/litellm-proxy-extras/litellm_proxy_extras/migrations/20260918000000_add_managed_file_content_table/migration.sql @@ -0,0 +1,8 @@ +-- CreateTable +CREATE TABLE IF NOT EXISTS "LiteLLM_ManagedFileContentTable" ( + "id" TEXT NOT NULL, + "content" BYTEA NOT NULL, + "created_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP, + + CONSTRAINT "LiteLLM_ManagedFileContentTable_pkey" PRIMARY KEY ("id") +); diff --git a/litellm-proxy-extras/litellm_proxy_extras/schema.prisma b/litellm-proxy-extras/litellm_proxy_extras/schema.prisma index 91b59e56906..d2032cec0d0 100644 --- a/litellm-proxy-extras/litellm_proxy_extras/schema.prisma +++ b/litellm-proxy-extras/litellm_proxy_extras/schema.prisma @@ -1107,6 +1107,12 @@ model LiteLLM_ManagedObjectTable { // for batches or finetuning jobs which use t @@index([team_id, created_at(sort: Desc)]) } +model LiteLLM_ManagedFileContentTable { + id String @id @default(uuid()) + content Bytes + created_at DateTime @default(now()) +} + model LiteLLM_ManagedVectorStoreTable { id String @id @default(uuid()) unified_resource_id String @unique // The base64 encoded unified vector store ID @@ -1545,6 +1551,36 @@ model LiteLLM_AdaptiveRouterSession { @@index([last_activity_at], map: "idx_adaptive_router_session_activity") } +model LiteLLM_AutoRouterBaselineComparison { + scope String @id + api_key String + session_id String + router_name String + initial_equivalent Boolean + revision BigInt @default(0) + published_revision BigInt @default(0) + history String? + attempted_at DateTime? + retired Boolean @default(false) + updated_at DateTime @default(now()) + + @@index([api_key, session_id, router_name], map: "idx_autorouter_baseline_scope") + @@index([updated_at], map: "idx_autorouter_baseline_updated") +} + +model LiteLLM_AutoRouterBaselineObservation { + request_id String @id + scope String + started_at Float + revision BigInt + data String + publication String? + conflicted Boolean @default(false) + + @@index([scope, started_at, request_id], map: "idx_autorouter_baseline_event_order") + @@index([scope, revision, started_at], map: "idx_autorouter_baseline_event_revision") +} + model LiteLLM_AutoRouterSession { api_key String session_id String @@ -1571,6 +1607,10 @@ model LiteLLM_AutoRouterSession { total_tokens BigInt @default(0) spend Float @default(0) saved_spend Float @default(0) + savings_estimated_turns Int @default(0) + savings_estimated_actual_spend Float @default(0) + savings_estimated_saved_spend Float @default(0) + savings_estimated_baseline_models Json @default("{}") classifier_cost Float @default(0) classifier_cost_recorded_turns Int @default(0) tier_turns Json @default("{}") diff --git a/litellm-proxy-extras/pyproject.toml b/litellm-proxy-extras/pyproject.toml index 604ffc3abd4..fb9022f89a5 100644 --- a/litellm-proxy-extras/pyproject.toml +++ b/litellm-proxy-extras/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "litellm-proxy-extras" -version = "0.4.99" +version = "0.4.100" description = "Additional files for the LiteLLM Proxy. Reduces the size of the main litellm package." readme = "README.md" requires-python = ">=3.9" @@ -26,7 +26,7 @@ required-version = ">=0.10.9" module-root = "" [tool.commitizen] -version = "0.4.99" +version = "0.4.100" version_files = [ "pyproject.toml:^version", "../pyproject.toml:litellm-proxy-extras==", diff --git a/litellm-rust/Cargo.lock b/litellm-rust/Cargo.lock index 860f01c4ad1..ebab2a118fc 100644 --- a/litellm-rust/Cargo.lock +++ b/litellm-rust/Cargo.lock @@ -3046,7 +3046,6 @@ checksum = "eddd3ca559203180a307f12d114c268abf583f59b03cb906fd0b3ff8646c1147" dependencies = [ "base64 0.22.1", "bytes", - "futures-channel", "futures-core", "futures-util", "h2 0.4.15", diff --git a/litellm-rust/Cargo.toml b/litellm-rust/Cargo.toml index 8634dce92d0..fa2bdb4224c 100644 --- a/litellm-rust/Cargo.toml +++ b/litellm-rust/Cargo.toml @@ -34,7 +34,7 @@ pyo3 = "0.29.2" pyo3-async-runtimes = { version = "0.29.0", features = ["tokio-runtime"] } pythonize = "0.29.0" rand = "0.8" -reqwest = { version = "0.12", default-features = false, features = ["blocking", "json", "multipart", "rustls-tls", "http2", "stream"] } +reqwest = { version = "0.12", default-features = false, features = ["json", "multipart", "rustls-tls", "http2", "stream"] } rstest = "0.26.1" rstest_reuse = "0.7.0" rustls = { version = "0.23", default-features = false, features = ["ring", "std", "tls12"] } diff --git a/litellm-rust/clippy.toml b/litellm-rust/clippy.toml new file mode 100644 index 00000000000..f7e3293069b --- /dev/null +++ b/litellm-rust/clippy.toml @@ -0,0 +1,10 @@ +# The Tokio runtime is reached only through `host-python/src/execution.rs`, whose fork gate +# must see every entry. Going around it makes a fork-after-use hang instead of raising. +disallowed-methods = [ + { path = "pyo3_async_runtimes::tokio::get_runtime", reason = "use litellm_host_python::run_sync / run_sync_value" }, + { path = "pyo3_async_runtimes::tokio::future_into_py", reason = "use litellm_host_python::run_async / run_async_value" }, + { path = "pyo3_async_runtimes::tokio::future_into_py_with_locals", reason = "use litellm_host_python::run_async / run_async_value" }, + { path = "pyo3_async_runtimes::tokio::local_future_into_py", reason = "use litellm_host_python::run_async / run_async_value" }, + { path = "pyo3_async_runtimes::tokio::run", reason = "use litellm_host_python::run_sync / run_sync_value" }, + { path = "pyo3_async_runtimes::tokio::run_until_complete", reason = "use litellm_host_python::run_sync / run_sync_value" }, +] diff --git a/litellm-rust/crates/host-python/src/execution.rs b/litellm-rust/crates/host-python/src/execution.rs index 45a1183acf5..083c184e37e 100644 --- a/litellm-rust/crates/host-python/src/execution.rs +++ b/litellm-rust/crates/host-python/src/execution.rs @@ -4,6 +4,7 @@ use std::pin::Pin; use std::task::{Context, Poll, Waker}; use std::time::Duration; +use crate::fork_gate::{ForkGate, Refused, RuntimeAlreadyStarted}; use crate::{Pythonized, panic_to_pyerr, release_gil}; use futures_util::FutureExt; use pyo3::exceptions::PyRuntimeError; @@ -12,6 +13,67 @@ use serde::Serialize; use tokio::runtime::{Handle, Runtime}; use tokio::time::{self, MissedTickBehavior}; +pyo3::create_exception!( + _native, + ForkedAfterNativeRuntimeStarted, + PyRuntimeError, + "This process was forked after the native runtime started. Runtime threads do not survive fork(), so native routes cannot run here." +); + +pyo3::create_exception!( + _native, + ProcessReservedForForking, + PyRuntimeError, + "This process was reserved for forking workers, so native routes cannot run here." +); + +static FORK_GATE: ForkGate = ForkGate::new(); + +/// Whether this process has started the Tokio runtime. +pub fn runtime_started() -> bool { + FORK_GATE.started(std::process::id()) +} + +/// Declares that this process exists to fork workers, so it must never start the runtime. +/// Fails if it already has. Workers are unaffected: the reservation is keyed by pid. +pub fn reserve_process_for_forking() -> Result<(), RuntimeAlreadyStarted> { + FORK_GATE.reserve(std::process::id()) +} + +/// The only door to the Tokio runtime: every route reaches it through this module, which is +/// what lets the gate speak for the whole extension. `clippy.toml` disallows going around it. +fn enter_runtime() -> PyResult<()> { + FORK_GATE + .enter(std::process::id()) + .map_err(|refused| match refused { + Refused::ReservedForForking => ProcessReservedForForking::new_err( + "this process is reserved for forking workers and cannot run native routes; \ + move the call into a worker, after the fork", + ), + Refused::ForkedAfterStart => ForkedAfterNativeRuntimeStarted::new_err( + "this process was forked after the native runtime started, and runtime threads \ + do not survive fork(); start workers with spawn or forkserver, or fork before \ + the first native call", + ), + }) +} + +#[expect(clippy::disallowed_methods, reason = "this is the gated door")] +fn runtime() -> PyResult<&'static Runtime> { + enter_runtime()?; + Ok(pyo3_async_runtimes::tokio::get_runtime()) +} + +#[expect(clippy::disallowed_methods, reason = "this is the gated door")] +fn future_into_py(py: Python<'_>, future: F) -> PyResult> +where + F: Future> + Send + 'static, + T: for<'py> IntoPyObject<'py> + Send + 'static, +{ + enter_runtime()?; + pyo3_async_runtimes::tokio::future_into_py(py, future) +} + pub fn run_sync( py: Python<'_>, future: F, @@ -22,12 +84,7 @@ where E: Send + 'static, F: Future> + Send + 'static, { - run_sync_on( - py, - pyo3_async_runtimes::tokio::get_runtime(), - future, - map_error, - ) + run_sync_on(py, runtime()?, future, map_error) } pub fn run_sync_value(py: Python<'_>, future: F) -> PyResult @@ -35,7 +92,7 @@ where T: Send + 'static, F: Future> + Send + 'static, { - run_sync_value_on(py, pyo3_async_runtimes::tokio::get_runtime(), future) + run_sync_value_on(py, runtime()?, future) } fn run_sync_value_on(py: Python<'_>, runtime: &Runtime, future: F) -> PyResult @@ -83,7 +140,7 @@ where E: Send + 'static, F: Future> + Send + 'static, { - pyo3_async_runtimes::tokio::future_into_py(py, async move { + future_into_py(py, async move { let result = catch_future_panic(future).await?; let result = map_core_result(result, map_error)?; Ok(Pythonized(result)) @@ -95,7 +152,7 @@ where T: for<'py> IntoPyObject<'py> + Send + 'static, F: Future> + Send + 'static, { - pyo3_async_runtimes::tokio::future_into_py(py, async move { catch_future_panic(future).await? }) + future_into_py(py, async move { catch_future_panic(future).await? }) } pub fn poll_async_value(py: Python<'_>, future: Pin<&mut F>) -> PyResult> @@ -103,8 +160,9 @@ where T: Send, F: Future> + Send, { + let runtime = runtime()?; let result = release_gil(py, || { - let _runtime = pyo3_async_runtimes::tokio::get_runtime().enter(); + let _runtime = runtime.enter(); std::panic::catch_unwind(AssertUnwindSafe(|| { future.poll(&mut Context::from_waker(Waker::noop())) })) @@ -286,27 +344,25 @@ mod tests { } #[pyfunction] - fn runtime_worker_count() -> usize { - pyo3_async_runtimes::tokio::get_runtime() - .metrics() - .num_workers() + fn runtime_worker_count() -> PyResult { + Ok(runtime()?.metrics().num_workers()) } #[pyfunction] - fn runtime_is_responsive(_py: Python<'_>, expected_completions: usize) -> bool { + fn runtime_is_responsive(_py: Python<'_>, expected_completions: usize) -> PyResult { let completion_deadline = Instant::now() + Duration::from_secs(2); while ASYNC_PROBE_COMPLETED.load(Ordering::SeqCst) < expected_completions { if Instant::now() >= completion_deadline { - return false; + return Ok(false); } thread::sleep(Duration::from_millis(1)); } let (heartbeat_tx, heartbeat_rx) = mpsc::sync_channel(1); - pyo3_async_runtimes::tokio::get_runtime().spawn(async move { + runtime()?.spawn(async move { let _ = heartbeat_tx.send(()); }); - heartbeat_rx.recv_timeout(Duration::from_secs(2)).is_ok() + Ok(heartbeat_rx.recv_timeout(Duration::from_secs(2)).is_ok()) } fn extract_bool(py: Python<'_>, result: PyResult>) -> bool { @@ -317,6 +373,16 @@ mod tests { .expect("result should convert") } + #[rstest] + fn reaching_the_runtime_marks_the_process_as_started( + #[from(initialized_python)] python: &InitializedPython, + ) { + python.attach(|py| { + run_sync_value(py, async { Ok(()) }).unwrap(); + assert!(runtime_started()); + }); + } + #[rstest] fn inline_poll_releases_gil_and_enters_runtime( #[from(initialized_python)] python: &InitializedPython, diff --git a/litellm-rust/crates/host-python/src/fork_gate.rs b/litellm-rust/crates/host-python/src/fork_gate.rs new file mode 100644 index 00000000000..c4842dd9223 --- /dev/null +++ b/litellm-rust/crates/host-python/src/fork_gate.rs @@ -0,0 +1,139 @@ +use std::sync::atomic::{AtomicU32, Ordering}; + +const UNSET: u32 = 0; + +/// Decides which process may use the Tokio runtime. Its worker threads do not survive +/// `fork()`: a child forked after they started hangs on its first native call. The gate turns +/// both halves of that hazard into errors, keyed by pid so a fork needs no hook to be seen: +/// a process reserved for forking can never start the runtime, and a child of a process that +/// did start it is refused instead of hanging. +pub(crate) struct ForkGate { + runtime_pid: AtomicU32, + fork_only_pid: AtomicU32, +} + +#[derive(Debug, PartialEq, Eq)] +pub(crate) enum Refused { + ReservedForForking, + ForkedAfterStart, +} + +#[derive(Debug, PartialEq, Eq)] +pub struct RuntimeAlreadyStarted; + +impl ForkGate { + pub(crate) const fn new() -> Self { + Self { + runtime_pid: AtomicU32::new(UNSET), + fork_only_pid: AtomicU32::new(UNSET), + } + } + + /// Claims the runtime for `pid`. Claim first, then look for a reservation: `reserve` does + /// the mirror image, so when the two race at least one of them sees the other. + pub(crate) fn enter(&self, pid: u32) -> Result<(), Refused> { + match self + .runtime_pid + .compare_exchange(UNSET, pid, Ordering::SeqCst, Ordering::SeqCst) + { + Err(owner) if owner != pid => return Err(Refused::ForkedAfterStart), + _ => {} + } + + if self.fork_only_pid.load(Ordering::SeqCst) == pid { + // Nothing was started, so the workers forked from here must still find it unclaimed. + let _ = + self.runtime_pid + .compare_exchange(pid, UNSET, Ordering::SeqCst, Ordering::SeqCst); + return Err(Refused::ReservedForForking); + } + + Ok(()) + } + + /// Reserves `pid` for forking. Reserve first, then look for a started runtime: `enter` does + /// the mirror image, so when the two race at least one of them sees the other. A refused + /// reservation leaves the gate exactly as it was, so a process already running the runtime + /// keeps refusing the children it forks. + pub(crate) fn reserve(&self, pid: u32) -> Result<(), RuntimeAlreadyStarted> { + self.fork_only_pid.store(pid, Ordering::SeqCst); + if self.runtime_pid.load(Ordering::SeqCst) == pid { + let _ = + self.fork_only_pid + .compare_exchange(pid, UNSET, Ordering::SeqCst, Ordering::SeqCst); + return Err(RuntimeAlreadyStarted); + } + Ok(()) + } + + pub(crate) fn started(&self, pid: u32) -> bool { + self.runtime_pid.load(Ordering::SeqCst) == pid + } +} + +#[cfg(test)] +mod tests { + use super::*; + + const MASTER: u32 = 100; + const WORKER: u32 = 101; + + #[test] + fn unreserved_process_starts_the_runtime_and_stays_started() { + let gate = ForkGate::new(); + + assert!(!gate.started(MASTER)); + assert_eq!(gate.enter(MASTER), Ok(())); + assert_eq!(gate.enter(MASTER), Ok(())); + assert!(gate.started(MASTER)); + } + + #[test] + fn reserved_process_can_never_start_the_runtime() { + let gate = ForkGate::new(); + + assert_eq!(gate.reserve(MASTER), Ok(())); + assert_eq!(gate.enter(MASTER), Err(Refused::ReservedForForking)); + assert_eq!(gate.enter(MASTER), Err(Refused::ReservedForForking)); + assert!(!gate.started(MASTER)); + } + + #[test] + fn workers_forked_from_a_reserved_process_start_their_own_runtime() { + let gate = ForkGate::new(); + gate.reserve(MASTER).unwrap(); + gate.enter(MASTER).unwrap_err(); + + assert_eq!(gate.enter(WORKER), Ok(())); + assert!(gate.started(WORKER)); + } + + #[test] + fn reserving_after_the_runtime_started_is_refused() { + let gate = ForkGate::new(); + gate.enter(MASTER).unwrap(); + + assert_eq!(gate.reserve(MASTER), Err(RuntimeAlreadyStarted)); + } + + #[test] + fn a_refused_reservation_leaves_the_runtime_claimed_and_its_children_refused() { + let gate = ForkGate::new(); + gate.enter(MASTER).unwrap(); + + assert_eq!(gate.reserve(MASTER), Err(RuntimeAlreadyStarted)); + assert_eq!(gate.enter(MASTER), Ok(())); + assert!(gate.started(MASTER)); + assert_eq!(gate.enter(WORKER), Err(Refused::ForkedAfterStart)); + } + + #[test] + fn child_forked_after_the_runtime_started_is_refused_instead_of_hanging() { + let gate = ForkGate::new(); + gate.enter(MASTER).unwrap(); + + assert_eq!(gate.enter(WORKER), Err(Refused::ForkedAfterStart)); + assert!(!gate.started(WORKER)); + assert_eq!(gate.enter(MASTER), Ok(())); + } +} diff --git a/litellm-rust/crates/host-python/src/lib.rs b/litellm-rust/crates/host-python/src/lib.rs index 583a4eb91b6..7d164ab7535 100644 --- a/litellm-rust/crates/host-python/src/lib.rs +++ b/litellm-rust/crates/host-python/src/lib.rs @@ -8,6 +8,7 @@ mod argument; mod callable; mod driver; mod execution; +mod fork_gate; mod gil; mod handle; mod marshal; @@ -18,7 +19,12 @@ pub use adapter::{ pub use argument::lookup; pub use callable::wrap_failure; pub use driver::run_call; -pub use execution::{poll_async_value, run_async, run_async_value, run_sync, run_sync_value}; +pub use execution::{ + ForkedAfterNativeRuntimeStarted, ProcessReservedForForking, poll_async_value, + reserve_process_for_forking, run_async, run_async_value, run_sync, run_sync_value, + runtime_started, +}; +pub use fork_gate::RuntimeAlreadyStarted; pub use gil::{release_count, release_gil}; pub use handle::{Execution, ExecutionBody, ExecutionStep}; pub use marshal::{Pythonized, from_py, from_py_argument, panic_to_pyerr, to_py}; diff --git a/litellm-rust/crates/python-bridge/src/diagnostics.rs b/litellm-rust/crates/python-bridge/src/diagnostics.rs index 39fa8bc3596..687a090e768 100644 --- a/litellm-rust/crates/python-bridge/src/diagnostics.rs +++ b/litellm-rust/crates/python-bridge/src/diagnostics.rs @@ -1,5 +1,5 @@ -use litellm_host_python::release_count; -use pyo3::{prelude::*, types::PyDict}; +use litellm_host_python::{release_count, runtime_started}; +use pyo3::{exceptions::PyRuntimeError, prelude::*, types::PyDict}; #[pyfunction] pub(crate) fn gil_stats(py: Python<'_>) -> PyResult> { @@ -8,6 +8,20 @@ pub(crate) fn gil_stats(py: Python<'_>) -> PyResult> { Ok(stats.into_any().unbind()) } +/// True once this process has started the native runtime, which does not survive `fork()`. +#[pyfunction] +pub(crate) fn process_state_started() -> bool { + runtime_started() +} + +/// Declares that this process only forks workers: from now on every native route raises here, +/// so the runtime can never start. Raises if it already has. Forked workers are unaffected. +#[pyfunction] +pub(crate) fn reserve_process_for_forking() -> PyResult<()> { + litellm_host_python::reserve_process_for_forking() + .map_err(|_| PyRuntimeError::new_err("the native runtime already started in this process")) +} + #[cfg(feature = "panic-test")] #[pyfunction] pub(crate) fn _panic_for_test() { diff --git a/litellm-rust/crates/python-bridge/src/lib.rs b/litellm-rust/crates/python-bridge/src/lib.rs index 7eba0d201be..46f98736aa1 100644 --- a/litellm-rust/crates/python-bridge/src/lib.rs +++ b/litellm-rust/crates/python-bridge/src/lib.rs @@ -13,7 +13,7 @@ mod _native { #[pymodule_export] use crate::diagnostics::_panic_for_test; #[pymodule_export] - use crate::diagnostics::gil_stats; + use crate::diagnostics::{gil_stats, process_state_started, reserve_process_for_forking}; #[pymodule_export] use crate::errors::{RustBridgeDeclined, RustUpstreamError}; #[pymodule_export] @@ -30,6 +30,8 @@ mod _native { use crate::routes::responses::ResponsesWebSocketConnection; #[pymodule_export] use crate::token_counter::TokenCounter; + #[pymodule_export] + use litellm_host_python::{ForkedAfterNativeRuntimeStarted, ProcessReservedForForking}; } use pyo3::prelude::*; @@ -50,6 +52,8 @@ mod tests { let mut expected = vec![ "RustBridgeDeclined", "RustUpstreamError", + "ForkedAfterNativeRuntimeStarted", + "ProcessReservedForForking", "ocr", "aocr", "transcription", @@ -62,6 +66,8 @@ mod tests { "ResponsesWebSocketConnection", "TokenCounter", "gil_stats", + "process_state_started", + "reserve_process_for_forking", ]; expected.sort_unstable(); diff --git a/litellm-rust/crates/python-bridge/src/routes/responses.rs b/litellm-rust/crates/python-bridge/src/routes/responses.rs index 9c10d58de4f..2e7e8fcbc21 100644 --- a/litellm-rust/crates/python-bridge/src/routes/responses.rs +++ b/litellm-rust/crates/python-bridge/src/routes/responses.rs @@ -25,7 +25,7 @@ impl ResponsesWebSocketConnection { ) -> PyResult> { let headers = marshal_headers(headers)?; let timeout = optional_timeout(timeout_seconds); - pyo3_async_runtimes::tokio::future_into_py(py, async move { + litellm_host_python::run_async_value(py, async move { let inner = RustResponsesWebSocketConnection::connect_url(&url, &headers, timeout) .await .map_err(responses_error_to_pyerr)?; @@ -35,7 +35,7 @@ impl ResponsesWebSocketConnection { fn send_text<'py>(&self, py: Python<'py>, text: String) -> PyResult> { let inner = self.inner.clone(); - pyo3_async_runtimes::tokio::future_into_py(py, async move { + litellm_host_python::run_async_value(py, async move { inner .send_text(text) .await @@ -45,14 +45,14 @@ impl ResponsesWebSocketConnection { fn recv_text<'py>(&self, py: Python<'py>) -> PyResult> { let inner = self.inner.clone(); - pyo3_async_runtimes::tokio::future_into_py(py, async move { + litellm_host_python::run_async_value(py, async move { inner.recv_text().await.map_err(responses_error_to_pyerr) }) } fn close<'py>(&self, py: Python<'py>) -> PyResult> { let inner = self.inner.clone(); - pyo3_async_runtimes::tokio::future_into_py(py, async move { + litellm_host_python::run_async_value(py, async move { inner.close().await.map_err(responses_error_to_pyerr) }) } @@ -68,6 +68,10 @@ mod tests { use tokio_tungstenite::{accept_async, tungstenite::Message}; #[test] + #[expect( + clippy::disallowed_methods, + reason = "the test server shares the routes' runtime" + )] fn responses_websocket_connection_round_trips_through_python() { Python::initialize(); let runtime = pyo3_async_runtimes::tokio::get_runtime(); diff --git a/litellm/constants.py b/litellm/constants.py index 4c8c51ee860..95ccad93284 100644 --- a/litellm/constants.py +++ b/litellm/constants.py @@ -1697,6 +1697,7 @@ LOGIN_THROTTLE_NOT_BLOCKED: Final = (0, 0) LITELLM_PROXY_ADMIN_NAME: Final = "default_user_id" LITELLM_PROXY_BUDGET_NAME: Final = "litellm-proxy-budget" GLOBAL_PROXY_SPEND_CACHE_KEY: Final = f"{LITELLM_PROXY_ADMIN_NAME}:spend" +LITELLM_EXECUTED_BATCH_CONCURRENCY: Final = max(1, int(os.getenv("LITELLM_EXECUTED_BATCH_CONCURRENCY", "4"))) ########################### CLI SSO AUTHENTICATION CONSTANTS ########################### LITELLM_CLI_SOURCE_IDENTIFIER: Final = "litellm-cli" diff --git a/litellm/integrations/otel/model/payloads.py b/litellm/integrations/otel/model/payloads.py index 467c286db9d..c23b3291365 100644 --- a/litellm/integrations/otel/model/payloads.py +++ b/litellm/integrations/otel/model/payloads.py @@ -7,9 +7,11 @@ from collections.abc import Mapping, Sequence from dataclasses import dataclass, field from enum import Enum from types import MappingProxyType -from typing import TYPE_CHECKING, ClassVar, Final, cast +from typing import TYPE_CHECKING, ClassVar, Final, Literal, cast from urllib.parse import urlsplit +from typing_extensions import ReadOnly, TypedDict + from litellm.integrations.otel.model.metadata import RequestContext, RequestIdentity from litellm.integrations.otel.model.semconv import ( GenAIOperation, @@ -25,6 +27,7 @@ from litellm.integrations.otel.model.utils import ( as_float, as_int, as_str, + as_str_mapping, as_str_tuple, ) @@ -424,7 +427,7 @@ class LLMCallSpanData: # plain ``.get`` — no repeated ``isinstance`` guards. raw_response: Final = payload.get("response") response: Final = cast(Mapping[str, object], raw_response if isinstance(raw_response, dict) else {}) - choices_out: Final = _dicts(response.get("choices")) + choices_out: Final = _dicts(response.get("choices")) or _responses_choices(response) # ``finish_reasons`` is metadata, not content, so derive it from # ``choices_out`` before gating. The raw message/choice bodies are only # retained when content capture is enabled (see ``capture_span_content``); @@ -703,6 +706,84 @@ def _finish_reasons(choices: tuple[Mapping[str, object], ...]) -> tuple[str, ... return tuple(r for c in choices if (r := as_str(c.get("finish_reason")))) +class _ToolFunction(TypedDict): + name: ReadOnly[str] + arguments: ReadOnly[str] + + +class _ToolCall(TypedDict): + id: ReadOnly[str] + type: ReadOnly[Literal["function"]] + function: ReadOnly[_ToolFunction] + + +class _AssistantMessage(TypedDict): + role: ReadOnly[str] + content: ReadOnly[str | None] + refusal: ReadOnly[str | None] + tool_calls: ReadOnly[tuple[_ToolCall, ...] | None] + + +class _Choice(TypedDict): + message: ReadOnly[_AssistantMessage] + finish_reason: ReadOnly[str | None] + + +_RESPONSES_TOOL_CALL_TYPES: Final = frozenset({"function_call", "custom_tool_call"}) + + +def _responses_choices(response: Mapping[str, object]) -> tuple[_Choice, ...]: + """A Responses API ``output`` folded into one chat-shaped assistant choice.""" + items: Final = _dicts(response.get("output")) + messages: Final = tuple(item for item in items if item.get("type") == "message") + parts: Final = tuple(part for item in messages for part in _dicts(item.get("content"))) + tool_calls: Final = tuple( + _responses_tool_call(item) for item in items if item.get("type") in _RESPONSES_TOOL_CALL_TYPES + ) + if not messages and not tool_calls: + return () + message: Final[_AssistantMessage] = { + "role": next((role for item in messages if (role := as_str(item.get("role")))), "assistant"), + "content": _responses_parts_text(parts, "output_text", "text"), + "refusal": _responses_parts_text(parts, "refusal", "refusal"), + "tool_calls": tool_calls or None, + } + choice: Final[_Choice] = {"message": message, "finish_reason": _responses_finish_reason(response, bool(tool_calls))} + return (choice,) + + +def _responses_parts_text(parts: tuple[Mapping[str, object], ...], part_type: str, field: str) -> str | None: + texts: Final = tuple( + text for part in parts if part.get("type") == part_type if (text := as_str(part.get(field))) is not None + ) + return "".join(texts) if texts else None + + +def _responses_tool_call(item: Mapping[str, object]) -> _ToolCall: + custom: Final = item.get("type") == "custom_tool_call" + function: Final[_ToolFunction] = { + "name": as_str(item.get("name")) or "", + "arguments": as_str(item.get("input" if custom else "arguments")) or "", + } + tool_call: Final[_ToolCall] = { + "id": as_str(item.get("call_id")) or as_str(item.get("id")) or "", + "type": "function", + "function": function, + } + return tool_call + + +def _responses_finish_reason(response: Mapping[str, object], has_tool_calls: bool) -> str | None: + status: Final = as_str(response.get("status")) + if status == "completed": + return "tool_calls" if has_tool_calls else "stop" + if status != "incomplete": + return None + details: Final = as_str_mapping(response.get("incomplete_details")) + reason: Final = details.get("reason") if details is not None else None + return "content_filter" if reason == "content_filter" else "length" + + def _parse_error(payload: StandardLoggingPayload) -> SpanError | None: """A ``SpanError`` for a failed request, or ``None`` on success.""" if payload.get("status") != "failure": diff --git a/litellm/litellm_core_utils/litellm_logging.py b/litellm/litellm_core_utils/litellm_logging.py index f7679b31f69..ba8addbaaa0 100644 --- a/litellm/litellm_core_utils/litellm_logging.py +++ b/litellm/litellm_core_utils/litellm_logging.py @@ -212,6 +212,7 @@ if TYPE_CHECKING: from litellm.integrations.otel.model.config import ExporterSpec, OpenTelemetryV2Config from litellm.litellm_core_utils.llm_cost_calc.utils import BilledTokenRates from litellm.llms.base_llm.passthrough.transformation import PassthroughStreamCollector + from litellm.proxy.hooks.autorouter_baseline_cache import BaselineCacheContext, CapturedBaselineObservation try: from litellm_enterprise.enterprise_callbacks.callback_controls import ( EnterpriseCallbackControls, @@ -501,6 +502,8 @@ class Logging(LiteLLMLoggingBaseClass): litellm_request_debug: bool = False streamed_anthropic_message_id: str | None = None classifier_input: Mapping[str, JsonValue] | None = None + baseline_cache_context: "BaselineCacheContext | None" = None + baseline_observation: "CapturedBaselineObservation | None" = None def __init__( self, @@ -508,7 +511,7 @@ class Logging(LiteLLMLoggingBaseClass): messages, stream, call_type, - start_time, + start_time: datetime.datetime, litellm_call_id: str, function_id: str, litellm_trace_id: str | None = None, @@ -2181,6 +2184,7 @@ class Logging(LiteLLMLoggingBaseClass): logging_result, start_time, end_time, + build_logging_payload: bool = True, ): """Resolve hidden params, compute response cost, and emit the standard logging payload.""" hidden_params: Final = getattr(logging_result, "_hidden_params", {}) @@ -2205,6 +2209,9 @@ class Logging(LiteLLMLoggingBaseClass): else: self.model_call_details["response_cost"] = self._response_cost_calculator(result=logging_result) + if not build_logging_payload: + return + self.model_call_details["standard_logging_object"] = self._build_standard_logging_payload( logging_result, start_time, end_time ) @@ -2215,6 +2222,19 @@ class Logging(LiteLLMLoggingBaseClass): if standard_logging_payload is not None: emit_standard_logging_payload(standard_logging_payload) + async def _prepare_baseline_cache_estimate(self, response_obj: object) -> None: + if self.baseline_cache_context is None: + return + from litellm.proxy.hooks.autorouter_baseline_cache import finalize_baseline_cache + + await finalize_baseline_cache(self, response_obj) + + async def invalidate_baseline_cache_estimate(self, reason: str, *, completed: bool = False) -> None: + """Invalidate uncertain attempts; retire the reservation at logical completion.""" + from litellm.proxy.hooks.autorouter_baseline_cache import invalidate_baseline_cache + + await invalidate_baseline_cache(self, reason, completed=completed) + def _build_standard_logging_payload( self, init_response_obj: object, start_time: Any, end_time: Any ) -> StandardLoggingPayload | None: @@ -2266,6 +2286,7 @@ class Logging(LiteLLMLoggingBaseClass): end_time=None, cache_hit=None, standard_logging_object: StandardLoggingPayload | None = None, + build_logging_payload: bool = True, ): try: if start_time is None: @@ -2303,6 +2324,7 @@ class Logging(LiteLLMLoggingBaseClass): logging_result=logging_result, start_time=start_time, end_time=end_time, + build_logging_payload=build_logging_payload, ) elif standard_logging_object is not None: self.model_call_details["standard_logging_object"] = standard_logging_object @@ -3051,8 +3073,17 @@ class Logging(LiteLLMLoggingBaseClass): result=result, cache_hit=cache_hit, standard_logging_object=kwargs.get("standard_logging_object", None), + build_logging_payload=self.baseline_cache_context is None, ) + if self.stream is not True and self.baseline_cache_context is not None: + await self._prepare_baseline_cache_estimate(result) + self.model_call_details["standard_logging_object"] = self._build_standard_logging_payload( + result, start_time, end_time + ) + if (prepared_payload := self.model_call_details.get("standard_logging_object")) is not None: + emit_standard_logging_payload(prepared_payload) + ## BUILD COMPLETE STREAMED RESPONSE if "async_complete_streaming_response" in self.model_call_details: return # break out of this. @@ -3097,6 +3128,8 @@ class Logging(LiteLLMLoggingBaseClass): self._merge_hidden_params_from_response_into_metadata(complete_streaming_response) + await self._prepare_baseline_cache_estimate(complete_streaming_response) + ## STANDARDIZED LOGGING PAYLOAD try: self.model_call_details["standard_logging_object"] = self._build_standard_logging_payload( @@ -3125,6 +3158,7 @@ class Logging(LiteLLMLoggingBaseClass): # Only build standard_logging_object if not already built by # _success_handler_helper_fn if self.model_call_details.get("standard_logging_object") is None: + await self._prepare_baseline_cache_estimate(result) ## STANDARDIZED LOGGING PAYLOAD self.model_call_details["standard_logging_object"] = self._build_standard_logging_payload( result, start_time, end_time @@ -3631,6 +3665,8 @@ class Logging(LiteLLMLoggingBaseClass): """ Implementing async callbacks, to handle asyncio event loop issues when custom integrations need to use async functions. """ + if self.baseline_cache_context is not None: + await self.invalidate_baseline_cache_estimate("failed_request") await self.special_failure_handlers(exception=exception) if not self.should_run_logging(event_type="async_failure"): # prevent double logging return @@ -5528,6 +5564,10 @@ class StandardLoggingPayloadSetup: for key in metadata.keys() & _STANDARD_LOGGING_METADATA_KEYS: clean_metadata[key] = metadata[key] + recorded_guardrails: Final = metadata.get("applied_guardrails") + if applied_guardrails and isinstance(recorded_guardrails, list): + clean_metadata["applied_guardrails"] = list(dict.fromkeys([*applied_guardrails, *recorded_guardrails])) + user_api_key: Final = metadata.get("user_api_key") if user_api_key and isinstance(user_api_key, str) and is_valid_sha256_hash(user_api_key): clean_metadata["user_api_key_hash"] = user_api_key @@ -6149,6 +6189,8 @@ def _autorouter_savings_for_payload( model_id: str | None, usage_object: Mapping[str, object] | None, cost_breakdown: Mapping[str, object] | None, + baseline_usage: Usage | None = None, + baseline_provenance: Literal["observed_initial", "modeled"] | None = None, ) -> float | None: """The auto-router savings figure for the payload, or ``None`` when there is none. @@ -6167,6 +6209,8 @@ def _autorouter_savings_for_payload( model_id=model_id, usage_object=usage_object, cost_breakdown=cost_breakdown, + baseline_usage=baseline_usage, + baseline_provenance=baseline_provenance, ) except Exception as e: # noqa: BLE001 # a savings figure must never fail request logging verbose_logger.debug("autorouter savings skipped on logging payload: %s", e) @@ -6343,13 +6387,18 @@ def get_standard_logging_object_payload( model_name = response_model_name request_cost_breakdown: Final = cost_breakdown_with_guardrail(logging_obj.cost_breakdown, guardrail_cost) - autorouter_savings: Final = _autorouter_savings_for_payload( - request_metadata=metadata, - model=model_name, - custom_llm_provider=custom_llm_provider, - model_id=_model_id, - usage_object=usage_dict, - cost_breakdown=request_cost_breakdown, + captured_baseline: Final = logging_obj.baseline_observation + autorouter_savings: Final = ( + None + if status != "success" or cache_hit or logging_obj.baseline_cache_context is not None + else _autorouter_savings_for_payload( + request_metadata=metadata, + model=model_name, + custom_llm_provider=custom_llm_provider, + model_id=_model_id, + usage_object=usage_dict, + cost_breakdown=request_cost_breakdown, + ) ) payload: Final[StandardLoggingPayload] = StandardLoggingPayload( @@ -6396,6 +6445,26 @@ def get_standard_logging_object_payload( response_cost=response_cost, cost_breakdown=request_cost_breakdown, autorouter_savings=autorouter_savings, + autorouter_savings_estimate=( + { + "version": 3, + "status": "unknown", + "reason": "pending_projection", + } # mutable-ok: spend-log JSON serialization requires plain mappings + if captured_baseline is not None + else ( + { # mutable-ok: spend-log JSON serialization requires plain mappings + "version": 1, + "status": "estimated" if autorouter_savings is not None else "unknown", + "reason": "uncached_usage" if autorouter_savings is not None else "baseline_unavailable", + } + if metadata.get("routing_decision") + else None + ) + ), + autorouter_baseline_observation=( + captured_baseline.model_dump_json() if captured_baseline is not None else None + ), total_tokens=usage_dict.get("total_tokens", 0), prompt_tokens=usage_dict.get("prompt_tokens", 0), completion_tokens=usage_dict.get("completion_tokens", 0), diff --git a/litellm/litellm_core_utils/redact_messages.py b/litellm/litellm_core_utils/redact_messages.py index 9d22a5ddef5..b409b181a79 100644 --- a/litellm/litellm_core_utils/redact_messages.py +++ b/litellm/litellm_core_utils/redact_messages.py @@ -128,6 +128,8 @@ def _redact_responses_api_output(output_items): for content_part in output_item.content: if getattr(content_part, "text", None) is not None: content_part.text = REDACTED_BY_LITELLM + if getattr(content_part, "refusal", None) is not None: + content_part.refusal = REDACTED_BY_LITELLM # Redact reasoning items in output array if hasattr(output_item, "type") and output_item.type == "reasoning": @@ -138,6 +140,8 @@ def _redact_responses_api_output(output_items): if hasattr(output_item, "type") and output_item.type == "function_call" and hasattr(output_item, "arguments"): output_item.arguments = REDACTED_BY_LITELLM + if hasattr(output_item, "type") and output_item.type == "custom_tool_call" and hasattr(output_item, "input"): + output_item.input = REDACTED_BY_LITELLM def _redact_responses_api_output_dict(output_items, redacted_str: str): @@ -153,6 +157,8 @@ def _redact_responses_api_output_dict(output_items, redacted_str: str): for content_item in output_item["content"]: if isinstance(content_item, dict) and content_item.get("text") is not None: content_item["text"] = redacted_str + if isinstance(content_item, dict) and content_item.get("refusal") is not None: + content_item["refusal"] = redacted_str if output_item.get("type") == "reasoning" and isinstance(output_item.get("summary"), list): for summary_item in output_item["summary"]: @@ -161,6 +167,8 @@ def _redact_responses_api_output_dict(output_items, redacted_str: str): if output_item.get("type") == "function_call" and "arguments" in output_item: output_item["arguments"] = redacted_str + if output_item.get("type") == "custom_tool_call" and "input" in output_item: + output_item["input"] = redacted_str def redacted_standard_logging_payload(payload: Mapping[str, object]) -> Mapping[str, object]: diff --git a/litellm/llms/anthropic/chat/handler.py b/litellm/llms/anthropic/chat/handler.py index dc8bbc9edac..359b8bb08c9 100644 --- a/litellm/llms/anthropic/chat/handler.py +++ b/litellm/llms/anthropic/chat/handler.py @@ -4,7 +4,8 @@ Calling + translation logic for anthropic's `/v1/messages` endpoint import copy import json -from collections.abc import Callable +from collections.abc import Callable, Mapping +from types import MappingProxyType from typing import TYPE_CHECKING, Any, Final, Literal, Union, cast import httpx @@ -31,7 +32,6 @@ from litellm.types.llms.anthropic import ( ContentBlockStop, MessageBlockDelta, MessageStartBlock, - UsageDelta, ) from litellm.types.llms.openai import ( ChatCompletionRedactedThinkingBlock, @@ -557,6 +557,7 @@ class ModelResponseIterator: self.tool_index = -1 self.json_mode = json_mode self.speed = speed + self._cumulative_usage: Mapping[str, object] = MappingProxyType({}) # rewritten-name -> caller's original. Built per-request from the # forward map in AnthropicConfig._build_request_tool_name_maps; only # contains entries we actually rewrote, so a tool legitimately named @@ -631,10 +632,12 @@ class ModelResponseIterator: return True return False - def _handle_usage(self, anthropic_usage_chunk: dict | UsageDelta) -> Usage: + def _handle_usage(self, anthropic_usage_chunk: Mapping[str, object]) -> Usage: + # message_delta usage is cumulative but may omit fields reported at message_start. + self._cumulative_usage = MappingProxyType({**self._cumulative_usage, **anthropic_usage_chunk}) reasoning_content: Final = "".join(self.reasoning_content_chunks) if self.reasoning_content_chunks else None usage: Final = AnthropicConfig().calculate_usage( - usage_object=cast(dict, anthropic_usage_chunk), + usage_object=self._cumulative_usage, reasoning_content=reasoning_content, speed=self.speed, ) diff --git a/litellm/llms/anthropic/count_tokens/handler.py b/litellm/llms/anthropic/count_tokens/handler.py index 38cd429d99a..dd2135f4918 100644 --- a/litellm/llms/anthropic/count_tokens/handler.py +++ b/litellm/llms/anthropic/count_tokens/handler.py @@ -4,9 +4,11 @@ Anthropic CountTokens API handler. Uses httpx for HTTP requests instead of the Anthropic SDK. """ -from typing import Any, Final +from collections.abc import Mapping +from typing import Final import httpx +from pydantic import JsonValue, TypeAdapter import litellm from litellm._logging import verbose_logger @@ -16,6 +18,8 @@ from litellm.llms.anthropic.count_tokens.transformation import ( ) from litellm.llms.custom_httpx.http_handler import get_async_httpx_client +_COUNT_RESPONSE: Final = TypeAdapter(dict[str, JsonValue]) + class AnthropicCountTokensHandler(AnthropicCountTokensConfig): """ @@ -27,13 +31,14 @@ class AnthropicCountTokensHandler(AnthropicCountTokensConfig): async def handle_count_tokens_request( self, model: str, - messages: list[dict[str, Any]], + messages: list[dict[str, JsonValue]], api_key: str, api_base: str | None = None, timeout: float | httpx.Timeout | None = None, - tools: list[dict[str, Any]] | None = None, - system: Any | None = None, - ) -> dict[str, Any]: + tools: list[dict[str, JsonValue]] | None = None, + system: JsonValue = None, + optional_params: Mapping[str, JsonValue] | None = None, + ) -> dict[str, JsonValue]: """ Handle a CountTokens request using httpx. @@ -52,7 +57,7 @@ class AnthropicCountTokensHandler(AnthropicCountTokensConfig): """ try: # Validate the request - self.validate_request(model, messages) + self.validate_request(model, messages, system=system, tools=tools) verbose_logger.debug("Processing Anthropic CountTokens request for model: %s", model) @@ -62,6 +67,7 @@ class AnthropicCountTokensHandler(AnthropicCountTokensConfig): messages=messages, tools=tools, system=system, + optional_params=optional_params, ) verbose_logger.debug("Transformed request: %s", request_body) @@ -97,7 +103,7 @@ class AnthropicCountTokensHandler(AnthropicCountTokensConfig): message=error_text, ) - anthropic_response: Final = response.json() + anthropic_response: Final = _COUNT_RESPONSE.validate_json(response.content) verbose_logger.debug("Anthropic response: %s", anthropic_response) diff --git a/litellm/llms/anthropic/count_tokens/transformation.py b/litellm/llms/anthropic/count_tokens/transformation.py index 12581b9f658..fb12747cec0 100644 --- a/litellm/llms/anthropic/count_tokens/transformation.py +++ b/litellm/llms/anthropic/count_tokens/transformation.py @@ -4,10 +4,17 @@ Anthropic CountTokens API transformation logic. This module handles the transformation of requests to Anthropic's CountTokens API format. """ -from typing import Any, Final +from collections.abc import Mapping, Sequence +from types import MappingProxyType +from typing import Final + +from pydantic import JsonValue, TypeAdapter from litellm.constants import ANTHROPIC_TOKEN_COUNTING_BETA_VERSION +_COUNT_REQUEST: Final = TypeAdapter(dict[str, JsonValue]) +COUNT_TOKEN_OPTION_NAMES: Final = ("thinking", "tool_choice", "output_config") + class AnthropicCountTokensConfig: """ @@ -31,27 +38,31 @@ class AnthropicCountTokensConfig: def transform_request_to_count_tokens( self, model: str, - messages: list[dict[str, Any]], - tools: list[dict[str, Any]] | None = None, - system: Any | None = None, - ) -> dict[str, Any]: + messages: list[dict[str, JsonValue]], + tools: list[dict[str, JsonValue]] | None = None, + system: JsonValue = None, + optional_params: Mapping[str, JsonValue] | None = None, + ) -> dict[str, JsonValue]: # mutable-ok: provider transport requires JSON dictionaries """ Transform request to Anthropic CountTokens format. Includes optional system and tools fields for accurate token counting. """ - request: Final[dict[str, Any]] = { - "model": model, - "messages": messages, - } - - if system is not None: - request["system"] = system - - if tools is not None: - request["tools"] = tools - - return request + options: Final[Mapping[str, JsonValue]] = optional_params or MappingProxyType({}) + return _COUNT_REQUEST.validate_python( + MappingProxyType( + { + "model": model, + "messages": messages, + **MappingProxyType( + {key: value for key, value in (("system", system), ("tools", tools)) if value is not None} + ), + **MappingProxyType( + {key: value for key, value in options.items() if key in COUNT_TOKEN_OPTION_NAMES} + ), + } + ) + ) def get_required_headers(self, api_key: str) -> dict[str, str]: """ @@ -76,7 +87,14 @@ class AnthropicCountTokensConfig: headers, _ = optionally_handle_anthropic_oauth(headers=headers, api_key=api_key) return headers - def validate_request(self, model: str, messages: list[dict[str, Any]]) -> None: + def validate_request( + self, + model: str, + messages: Sequence[Mapping[str, JsonValue]], + *, + system: JsonValue = None, + tools: list[dict[str, JsonValue]] | None = None, + ) -> None: """ Validate the incoming count tokens request. @@ -90,7 +108,7 @@ class AnthropicCountTokensConfig: if not model: raise ValueError("model parameter is required") - if not messages: + if not messages and not system and not tools: raise ValueError("messages parameter is required") if not isinstance(messages, list): diff --git a/litellm/llms/anthropic/prompt_cache_prediction.py b/litellm/llms/anthropic/prompt_cache_prediction.py index e69a02bd93a..447cefb1c45 100644 --- a/litellm/llms/anthropic/prompt_cache_prediction.py +++ b/litellm/llms/anthropic/prompt_cache_prediction.py @@ -1,10 +1,11 @@ from __future__ import annotations +import asyncio import hashlib import json from collections.abc import Mapping, Sequence -from dataclasses import dataclass -from itertools import accumulate +from dataclasses import dataclass, field +from itertools import accumulate, groupby from types import MappingProxyType from typing import Annotated, Final, Literal, Protocol, TypeAlias @@ -14,9 +15,14 @@ from pydantic import BaseModel, ConfigDict, Field, JsonValue, StrictInt, TypeAda import litellm from litellm.llms.anthropic.common_utils import AnthropicModelInfo, is_anthropic_oauth_key from litellm.llms.anthropic.count_tokens.handler import AnthropicCountTokensHandler -from litellm.llms.anthropic.experimental_pass_through.messages.transformation import DEFAULT_ANTHROPIC_API_VERSION +from litellm.llms.anthropic.count_tokens.transformation import COUNT_TOKEN_OPTION_NAMES +from litellm.llms.anthropic.experimental_pass_through.messages.transformation import ( + DEFAULT_ANTHROPIC_API_VERSION, + AnthropicMessagesConfig, +) from litellm.types.router import LiteLLM_Params from litellm.types.utils import ModelResponse +from litellm.utils import supports_thinking_cache_preservation _JSON_OBJECT: Final = TypeAdapter(dict[str, JsonValue]) _HEADERS: Final = TypeAdapter(dict[str, str]) @@ -100,10 +106,7 @@ _Block: TypeAlias = Annotated[_Text | _ToolUse | _ToolResult, Field(discriminato class _Message(_StrictModel): role: Literal["user", "assistant"] - content: str | Annotated[tuple[_Block, ...], Field(strict=False)] - - def blocks(self) -> tuple[_Text | _ToolUse | _ToolResult, ...]: - return (_Text(type="text", text=self.content),) if isinstance(self.content, str) else tuple(self.content) + content: Annotated[str, Field(min_length=1, pattern=r"\S")] | Annotated[tuple[_Block, ...], Field(strict=False)] class _Tool(_StrictModel): @@ -113,10 +116,7 @@ class _Tool(_StrictModel): type: Literal["custom"] | None = None -class _Request(_StrictModel): - messages: tuple[_Message, ...] = Field(min_length=1, strict=False) - system: str | Annotated[tuple[_ResultText, ...], Field(strict=False)] | None = None - tools: Annotated[tuple[_Tool, ...], Field(strict=False)] | None = None +class _RequestOptions(_StrictModel): model: str | None = None max_tokens: int | None = None stream: bool | None = None @@ -127,6 +127,289 @@ class _Request(_StrictModel): metadata: Mapping[str, JsonValue] | None = None +class _Request(_RequestOptions): + messages: tuple[_Message, ...] = Field(min_length=1, strict=False) + system: str | Annotated[tuple[_ResultText, ...], Field(strict=False)] | None = None + tools: Annotated[tuple[_Tool, ...], Field(strict=False)] | None = None + + +class _Thinking(_StrictModel): + type: Literal["thinking"] + thinking: str + signature: str = Field(min_length=1) + + +_PlanBlock: TypeAlias = Annotated[_Text | _ToolUse | _ToolResult | _Thinking, Field(discriminator="type")] + + +class _PlanMessage(_StrictModel): + role: Literal["user", "assistant", "system"] + content: str | Annotated[tuple[_PlanBlock, ...], Field(strict=False)] + + +class _PlanTool(_Tool): + cache_control: _CacheControl | None = None + + +class _PlanRequest(_RequestOptions): + messages: tuple[_PlanMessage, ...] = Field(min_length=1, strict=False) + system: str | Annotated[tuple[_Text, ...], Field(strict=False)] | None = None + tools: Annotated[tuple[_PlanTool, ...], Field(strict=False)] | None = None + cache_control: _CacheControl | None = None + thinking: Mapping[str, JsonValue] | None = None + tool_choice: Mapping[str, JsonValue] | None = None + output_config: Mapping[str, JsonValue] | None = None + speed: Literal["fast", "standard"] | None = None + service_tier: Literal["auto", "standard_only"] | None = None + + +@dataclass(frozen=True, slots=True) +class CacheBoundary: + fingerprint: str + prefix_body: Mapping[str, JsonValue] = field(repr=False) + ttl_seconds: int + lookback_fingerprints: tuple[str, ...] + content_fingerprint: str = "" + lookback_content_fingerprints: tuple[str, ...] = () + + +@dataclass(frozen=True, slots=True) +class PromptCachePlan: + full_body: Mapping[str, JsonValue] = field(repr=False) + breakpoints: tuple[CacheBoundary, ...] + + +@dataclass(frozen=True, slots=True) +class UnsupportedCachePlan: + reason: Literal[ + "unsupported_prompt_shape", + "conflicting_cache_ttl", + "too_many_cache_breakpoints", + "invalid_cache_ttl_order", + "unsupported_thinking_cache_semantics", + "token_count_unavailable", + "inconsistent_prefix_token_count", + ] + + +@dataclass(frozen=True, slots=True) +class CountedBreakpoint: + fingerprint: str + ttl_seconds: int + prefix_tokens: int + lookback_fingerprints: tuple[str, ...] + content_fingerprint: str = "" + lookback_content_fingerprints: tuple[str, ...] = () + + +@dataclass(frozen=True, slots=True) +class CountedPromptCachePlan: + total_tokens: int + breakpoints: tuple[CountedBreakpoint, ...] + + +@dataclass(frozen=True, slots=True) +class _Position: + section: Literal["tools", "system", "messages"] + message_index: int + role: str + block: Mapping[str, JsonValue] + marker: _CacheControl | None + + +def _content_blocks(content: JsonValue) -> tuple[Mapping[str, JsonValue], ...]: + if isinstance(content, str): + return (MappingProxyType({"type": "text", "text": content}),) + return tuple(_JSON_OBJECT.validate_python(block) for block in content) if isinstance(content, list) else () + + +def _position( + section: Literal["tools", "system", "messages"], + message_index: int, + role: str, + block: Mapping[str, JsonValue], +) -> _Position: + control: Final = block.get("cache_control") + return _Position( + section, + message_index, + role, + MappingProxyType({key: value for key, value in block.items() if key != "cache_control"}), + _CacheControl.model_validate(control) if control is not None else None, + ) + + +def _positions(body: Mapping[str, JsonValue]) -> tuple[_Position, ...]: + tools: Final = body.get("tools") + messages: Final = body.get("messages") + return ( + *tuple( + _position("tools", -1, "", _JSON_OBJECT.validate_python(tool)) + for tool in (tools if isinstance(tools, list) else ()) + ), + *tuple(_position("system", -1, "", block) for block in _content_blocks(body.get("system"))), + *tuple( + _position("messages", message_index, str(message.get("role")), block) + for message_index, raw_message in enumerate(messages if isinstance(messages, list) else ()) + for message in (_JSON_OBJECT.validate_python(raw_message),) + for block in _content_blocks(message.get("content")) + ), + ) + + +def _prefix_body( + body: Mapping[str, JsonValue], + positions: tuple[_Position, ...], + last_index: int, +) -> Mapping[str, JsonValue]: + prefix: Final = positions[: last_index + 1] + sections: Final = MappingProxyType( + { + section: _count_objects(tuple(position.block for position in prefix if position.section == section)) + for section in ("tools", "system") + if any(position.section == section for position in prefix) + } + ) + messages: Final = tuple( + MappingProxyType( + _JSON_OBJECT.validate_python( + MappingProxyType( + {"role": group[0].role, "content": _count_objects(tuple(position.block for position in group))} + ) + ) + ) + for _, values in groupby( + (position for position in prefix if position.section == "messages"), + key=lambda position: position.message_index, + ) + for group in (tuple(values),) + ) + return MappingProxyType( + _JSON_OBJECT.validate_python( + MappingProxyType( + { + **MappingProxyType({key: body[key] for key in COUNT_TOKEN_OPTION_NAMES if key in body}), + **sections, + "messages": _count_objects(messages), + } + ) + ) + ) + + +def _position_group(position: _Position, index: int) -> tuple[str, int, str | int]: + block_type: Final = position.block.get("type") + return ( + position.section, + position.message_index, + block_type if isinstance(block_type, str) and block_type in ("tool_use", "tool_result") else index, + ) + + +def _chain_digest(previous: str, current: str) -> str: + return _digest((previous, current)) + + +def _cacheable_position(position: _Position) -> bool: + block_type: Final = position.block.get("type") + if block_type == "thinking": + return False + text: Final = position.block.get("text") + return block_type != "text" or (isinstance(text, str) and bool(text.strip())) + + +def _entry_fingerprint(fingerprint: str, ttl_seconds: int) -> str: + return _digest(("native-cache-prefix-v2", fingerprint, ttl_seconds)) + + +def parse_cache_plan(body: Mapping[str, JsonValue]) -> PromptCachePlan | UnsupportedCachePlan: + try: + request: Final = _PlanRequest.model_validate(body) + positions: Final = _positions(body) + except ValidationError: + return UnsupportedCachePlan("unsupported_prompt_shape") + explicit: Final = tuple( + (index, position.marker) for index, position in enumerate(positions) if position.marker is not None + ) + automatic_index: Final = next( + (index for index in reversed(range(len(positions))) if _cacheable_position(positions[index])), None + ) + automatic_existing: Final = next((marker for index, marker in explicit if index == automatic_index), None) + if ( + request.cache_control is not None + and automatic_existing is not None + and automatic_existing != request.cache_control + ): + return UnsupportedCachePlan("conflicting_cache_ttl") + automatic: Final = ( + ((automatic_index, request.cache_control),) + if (request.cache_control is not None and automatic_index is not None and automatic_existing is None) + else () + ) + markers: Final = tuple(sorted((*explicit, *automatic), key=lambda value: value[0])) + if len(markers) > 4: + return UnsupportedCachePlan("too_many_cache_breakpoints") + ttls: Final = tuple(3600 if marker.ttl == "1h" else 300 for _, marker in markers) + if any(first < second for first, second in zip(ttls, ttls[1:])): + return UnsupportedCachePlan("invalid_cache_ttl_order") + settings: Final = MappingProxyType( + { + key: body[key] + for key in ("thinking", "output_config", "speed") + if key in body and not (key == "speed" and body[key] == "standard") + } + ) + hashes: Final = tuple( + accumulate( + ( + _digest( + ( + position.section, + position.message_index, + position.role, + position.block, + body.get("tool_choice") if position.section == "messages" else None, + ) + ) + for position in positions + ), + _chain_digest, + initial=_digest(settings), + ) + )[1:] + groups: Final = tuple( + tuple(index for index, _ in values) + for _, values in groupby( + enumerate(positions), + key=lambda item: _position_group(item[1], item[0]), + ) + ) + return PromptCachePlan( + full_body=MappingProxyType(dict(body)), + breakpoints=tuple( + CacheBoundary( + fingerprint=_entry_fingerprint(hashes[index], ttl), + prefix_body=_prefix_body(body, positions, index), + ttl_seconds=ttl, + lookback_fingerprints=tuple( + _entry_fingerprint(hashes[earlier], ttl) + for group in reversed(tuple(group for group in groups if group[0] <= index)[-20:]) + for earlier in reversed(group) + if earlier <= index + ), + content_fingerprint=hashes[index], + lookback_content_fingerprints=tuple( + hashes[earlier] + for group in reversed(tuple(group for group in groups if group[0] <= index)[-20:]) + for earlier in reversed(group) + if earlier <= index + ), + ) + for (index, _), ttl in zip(markers, ttls) + ), + ) + + @dataclass(frozen=True, slots=True) class PromptPrefix: prefix_body: Mapping[str, JsonValue] @@ -137,68 +420,28 @@ class PromptPrefix: def _digest(value: object) -> str: return hashlib.sha256( - json.dumps(value, sort_keys=True, separators=(",", ":"), ensure_ascii=False).encode() + json.dumps(value, default=_json_object, separators=(",", ":"), ensure_ascii=False).encode() ).hexdigest() -def _next_digest(previous: str, boundary: tuple[int, str, Mapping[str, JsonValue]]) -> str: - return _digest((previous, boundary)) +def _json_object(value: object) -> dict[str, JsonValue]: # mutable-ok: JSON serialization requires a dictionary + return _JSON_OBJECT.validate_python(value) def parse_prompt(body: Mapping[str, JsonValue]) -> PromptPrefix | None: try: - request: Final = _Request.model_validate(body) - blocks: Final = tuple(message.blocks() for message in request.messages) + _Request.model_validate(body) except ValidationError: return None - markers: Final = tuple( - (message_index, block_index, block.cache_control) - for message_index, message_blocks in enumerate(blocks) - for block_index, block in enumerate(message_blocks) - if block.cache_control is not None - ) - if len(markers) != 1: + plan: Final = parse_cache_plan(body) + if isinstance(plan, UnsupportedCachePlan) or len(plan.breakpoints) != 1: return None - message_end, block_end, marker = markers[0] - normalized: Final = _JSON_OBJECT.validate_python(request.model_dump(mode="json", exclude_none=True)) - context: Final = MappingProxyType({key: normalized[key] for key in ("system", "tools") if key in normalized}) - boundaries: Final = tuple( - ( - message_index, - request.messages[message_index].role, - _JSON_OBJECT.validate_python( - block.model_dump(mode="json", exclude=MappingProxyType({"cache_control": True}), exclude_none=True) - ), - ) - for message_index, message_blocks in enumerate(blocks[: message_end + 1]) - for block_index, block in enumerate(message_blocks) - if message_index < message_end or block_index <= block_end - ) - hashes: Final = tuple( - accumulate(boundaries, _next_digest, initial=_digest((_JSON_OBJECT.validate_python(context), marker.ttl))) - )[1:] - prefix_messages: Final = tuple( - _Message( - role=request.messages[message_index].role, - content=tuple( - block - for block_index, block in enumerate(message_blocks) - if message_index < message_end or block_index <= block_end - ), - ) - for message_index, message_blocks in enumerate(blocks[: message_end + 1]) - ) + prefix: Final = plan.breakpoints[0] return PromptPrefix( - prefix_body=MappingProxyType( - _JSON_OBJECT.validate_python( - _Request(messages=prefix_messages, system=request.system, tools=request.tools).model_dump( - mode="json", exclude_none=True - ) - ) - ), - fingerprint=hashes[-1], - fingerprints=tuple(reversed(hashes[-20:])), - ttl_seconds=3600 if marker.ttl == "1h" else 300, + prefix_body=prefix.prefix_body, + fingerprint=prefix.fingerprint, + fingerprints=prefix.lookback_fingerprints, + ttl_seconds=prefix.ttl_seconds, ) @@ -246,6 +489,9 @@ class _CountBody(BaseModel): messages: Sequence[Mapping[str, JsonValue]] tools: Sequence[Mapping[str, JsonValue]] | None = None system: str | Sequence[Mapping[str, JsonValue]] | None = None + thinking: Mapping[str, JsonValue] | None = None + tool_choice: Mapping[str, JsonValue] | None = None + output_config: Mapping[str, JsonValue] | None = None class _CountResult(BaseModel): @@ -262,16 +508,36 @@ def _count_objects( return [dict(value) for value in values] # mutable-ok: serialize read-only inputs at the provider API boundary -async def count_prompt_tokens(model: str, api_key: str, body: Mapping[str, JsonValue]) -> int | None: - native: Final = _CountBody.model_validate(body) +def _messages_url(model: str, api_key: str, api_base: str | None) -> str: + return AnthropicMessagesConfig().get_complete_url( # pyright: ignore[reportUnknownMemberType] # canonical native URL owner takes legacy JSON arguments + api_base=api_base, + api_key=api_key, + model=model, + optional_params=_JSON_OBJECT.validate_python(MappingProxyType({})), + litellm_params=_JSON_OBJECT.validate_python(MappingProxyType({})), + ) + + +async def count_prompt_tokens( + model: str, + api_key: str, + body: Mapping[str, JsonValue], + api_base: str | None = None, +) -> int | None: try: + native: Final = _CountBody.model_validate(body) + count_url: Final = _messages_url(model, api_key, api_base) + "/count_tokens" result: Final = _CountResult.model_validate( await _counter.handle_count_tokens_request( model=model, messages=_count_objects(native.messages), tools=_count_objects(native.tools) if native.tools is not None else None, - system=native.system, + system=_JSON_OBJECT.validate_python(MappingProxyType({"system": native.system}))["system"], api_key=api_key, + api_base=count_url, + optional_params=_JSON_OBJECT.validate_python( + MappingProxyType({key: body[key] for key in COUNT_TOKEN_OPTION_NAMES if key in body}) + ), timeout=15.0, ) ) @@ -280,10 +546,55 @@ async def count_prompt_tokens(model: str, api_key: str, body: Mapping[str, JsonV return result.input_tokens +async def count_cache_plan( + model: str, + api_key: str, + plan: PromptCachePlan, + token_counter: TokenCounter = count_prompt_tokens, +) -> CountedPromptCachePlan | UnsupportedCachePlan: + if any(position.block.get("type") == "thinking" for position in _positions(plan.full_body)): + if not supports_thinking_cache_preservation(model, "anthropic"): + return UnsupportedCachePlan("unsupported_thinking_cache_semantics") + total: Final = await token_counter(model, api_key, plan.full_body) + if total is None: + return UnsupportedCachePlan("token_count_unavailable") + counts: Final = tuple( + await asyncio.gather(*(token_counter(model, api_key, marker.prefix_body) for marker in plan.breakpoints)) + ) + if any(value is None for value in counts): + return UnsupportedCachePlan("token_count_unavailable") + known: Final = tuple(value for value in counts if value is not None) + if any(value < 0 for value in (total, *known)) or any( + first > second for first, second in zip(known, (*known[1:], total)) + ): + return UnsupportedCachePlan("inconsistent_prefix_token_count") + return CountedPromptCachePlan( + total, + tuple( + CountedBreakpoint( + marker.fingerprint, + marker.ttl_seconds, + count, + marker.lookback_fingerprints, + marker.content_fingerprint, + marker.lookback_content_fingerprints, + ) + for marker, count in zip(plan.breakpoints, known) + ), + ) + + @dataclass(frozen=True, slots=True) class NativePredictionTarget: model: str - api_key: str + api_key: str = field(repr=False) + api_base: str | None = None + + +def supported_baseline_recipient(target: NativePredictionTarget, wire: httpx.Request) -> bool: + return wire.headers.get("x-api-key") == target.api_key and wire.url == httpx.URL( + _messages_url(target.model, target.api_key, target.api_base) + ) @dataclass(frozen=True, slots=True) @@ -297,11 +608,26 @@ class UnsupportedPredictionTarget: def resolve_prediction_target(params: LiteLLM_Params) -> NativePredictionTarget | UnsupportedPredictionTarget: + return _resolve_prediction_target(params, allow_configured_endpoint=False) + + +def resolve_baseline_prediction_target(params: LiteLLM_Params) -> NativePredictionTarget | UnsupportedPredictionTarget: + return _resolve_prediction_target(params, allow_configured_endpoint=True) + + +def _resolve_prediction_target( + params: LiteLLM_Params, + *, + allow_configured_endpoint: bool, +) -> NativePredictionTarget | UnsupportedPredictionTarget: configured_options: Final = frozenset(params.model_dump(exclude_defaults=True, exclude_none=True)) if configured_options - _DEPLOYMENT_OPTIONS: return UnsupportedPredictionTarget("unsupported_deployment_configuration") api_base: Final = AnthropicModelInfo.get_api_base(params.api_base) - if api_base not in ("https://api.anthropic.com", "https://api.anthropic.com/v1/messages"): + if not allow_configured_endpoint and api_base not in ( + "https://api.anthropic.com", + "https://api.anthropic.com/v1/messages", + ): return UnsupportedPredictionTarget("unsupported_provider_endpoint") try: model, provider, _, _ = litellm.get_llm_provider( @@ -314,7 +640,7 @@ def resolve_prediction_target(params: LiteLLM_Params) -> NativePredictionTarget api_key: Final = AnthropicModelInfo.get_api_key(params.api_key) if api_key is None or not _supported_provider_key(api_key): return UnsupportedPredictionTarget("unsupported_provider_credentials") - return NativePredictionTarget(model=model, api_key=api_key) + return NativePredictionTarget(model=model, api_key=api_key, api_base=api_base) def _supported_provider_key(api_key: str) -> bool: diff --git a/litellm/llms/azure/chat/gpt_transformation.py b/litellm/llms/azure/chat/gpt_transformation.py index 6d17a1359bc..424422612db 100644 --- a/litellm/llms/azure/chat/gpt_transformation.py +++ b/litellm/llms/azure/chat/gpt_transformation.py @@ -280,10 +280,17 @@ class AzureOpenAIConfig(BaseConfig): ordered_messages: Final = system_messages_first(messages) if litellm.openai_system_messages_first else messages stripped_messages: Final = drop_tool_reference_parts_from_tool_messages(ordered_messages) azure_messages: Final = convert_to_azure_openai_messages(hoist_images_from_tool_messages(stripped_messages)) + request_params: Final = MappingProxyType( + { + key: value + for key, value in optional_params.items() + if key != "tool_choice" or optional_params.get("tools") or optional_params.get("functions") + } + ) return { "model": model, "messages": azure_messages, - **optional_params, + **request_params, **sanitized_tools_update(optional_params), } diff --git a/litellm/llms/base_llm/files/litellm_db_storage_backend.py b/litellm/llms/base_llm/files/litellm_db_storage_backend.py new file mode 100644 index 00000000000..a686062b2f7 --- /dev/null +++ b/litellm/llms/base_llm/files/litellm_db_storage_backend.py @@ -0,0 +1,40 @@ +from typing import TYPE_CHECKING, Final + +from litellm.llms.base_llm.files.storage_backend import BaseFileStorageBackend +from litellm.repositories.managed_file_content_repository import ManagedFileContentRepository + +if TYPE_CHECKING: + from litellm.proxy.utils import PrismaClient + +LITELLM_DB_STORAGE_BACKEND_NAME: Final = "litellm_db" +LITELLM_DB_STORAGE_URL_PREFIX: Final = f"{LITELLM_DB_STORAGE_BACKEND_NAME}://" + + +def storage_url_to_row_id(storage_url: str) -> str: + if not storage_url.startswith(LITELLM_DB_STORAGE_URL_PREFIX): + raise ValueError(f"Not a {LITELLM_DB_STORAGE_BACKEND_NAME} storage url: {storage_url}") + return storage_url.removeprefix(LITELLM_DB_STORAGE_URL_PREFIX) + + +class LiteLLMDbStorageBackend(BaseFileStorageBackend): + def __init__(self, prisma_client: "PrismaClient") -> None: + self._contents = ManagedFileContentRepository(prisma_client) + + async def upload_file( + self, + file_content: bytes, + filename: str, + content_type: str, + path_prefix: str | None = None, + file_naming_strategy: str = "uuid", + ) -> str: + return f"{LITELLM_DB_STORAGE_URL_PREFIX}{await self._contents.store(file_content)}" + + async def download_file(self, storage_url: str) -> bytes: + content: Final = await self._contents.load(storage_url_to_row_id(storage_url)) + if content is None: + raise ValueError(f"No stored file content for {storage_url}") + return content + + async def delete_file(self, storage_url: str) -> None: + await self._contents.delete(storage_url_to_row_id(storage_url)) diff --git a/litellm/llms/base_llm/files/storage_backend_factory.py b/litellm/llms/base_llm/files/storage_backend_factory.py index 0cf8164bc4a..e126da44d0a 100644 --- a/litellm/llms/base_llm/files/storage_backend_factory.py +++ b/litellm/llms/base_llm/files/storage_backend_factory.py @@ -6,32 +6,46 @@ based on the backend type. Backends use the same configuration as their correspo callbacks (e.g., azure_storage uses the same env vars as AzureBlobStorageLogger). """ +from typing import TYPE_CHECKING + from litellm._logging import verbose_logger from .azure_blob_storage_backend import AzureBlobStorageBackend +from .litellm_db_storage_backend import LITELLM_DB_STORAGE_BACKEND_NAME, LiteLLMDbStorageBackend from .storage_backend import BaseFileStorageBackend +if TYPE_CHECKING: + from litellm.proxy.utils import PrismaClient -def get_storage_backend(backend_type: str) -> BaseFileStorageBackend: + +def get_storage_backend(backend_type: str, prisma_client: "PrismaClient | None" = None) -> BaseFileStorageBackend: """ Factory function to create a storage backend instance. Backends are configured using the same environment variables as their corresponding callbacks. For example, "azure_storage" uses the same - env vars as AzureBlobStorageLogger. + env vars as AzureBlobStorageLogger. "litellm_db" stores file bytes in the + proxy's own database and needs the connected Prisma client. Args: - backend_type: Backend type identifier (e.g., "azure_storage") + backend_type: Backend type identifier (e.g., "azure_storage", "litellm_db") + prisma_client: The proxy's database client, required by "litellm_db" Returns: BaseFileStorageBackend: Instance of the appropriate storage backend Raises: - ValueError: If backend_type is not supported + ValueError: If backend_type is not supported, or "litellm_db" is asked for without a database """ verbose_logger.debug("Creating storage backend: type=%s", backend_type) if backend_type == "azure_storage": return AzureBlobStorageBackend() - else: - raise ValueError(f"Unsupported storage backend type: {backend_type}. Supported types: azure_storage") + if backend_type == LITELLM_DB_STORAGE_BACKEND_NAME: + if prisma_client is None: + raise ValueError(f"Storage backend {LITELLM_DB_STORAGE_BACKEND_NAME} requires a database-connected proxy") + return LiteLLMDbStorageBackend(prisma_client) + raise ValueError( + f"Unsupported storage backend type: {backend_type}. " + f"Supported types: azure_storage, {LITELLM_DB_STORAGE_BACKEND_NAME}" + ) diff --git a/litellm/llms/custom_httpx/llm_http_handler.py b/litellm/llms/custom_httpx/llm_http_handler.py index 8e0cdf547a2..49a332e62bb 100644 --- a/litellm/llms/custom_httpx/llm_http_handler.py +++ b/litellm/llms/custom_httpx/llm_http_handler.py @@ -2163,6 +2163,8 @@ class BaseLLMHTTPHandler: e=e, litellm_params=litellm_params_dict ) if should_retry and not hit_max_attempt: + if logging_obj.baseline_cache_context is not None: + await logging_obj.invalidate_baseline_cache_estimate("retried_request") verbose_logger.debug( "Anthropic /v1/messages: invalid thinking signature; " "stripping thinking blocks and retrying (attempt %s/%s).", diff --git a/litellm/model_prices_and_context_window_backup.json b/litellm/model_prices_and_context_window_backup.json index 7cf858ed9ff..4b0f5e8b49a 100644 --- a/litellm/model_prices_and_context_window_backup.json +++ b/litellm/model_prices_and_context_window_backup.json @@ -14510,6 +14510,7 @@ "supports_native_structured_output": true, "supports_pdf_input": true, "supports_prompt_caching": true, + "supports_thinking_cache_preservation": true, "supports_reasoning": true, "supports_response_schema": true, "supports_sampling_params": false, @@ -14547,6 +14548,7 @@ "supports_function_calling": true, "supports_pdf_input": true, "supports_prompt_caching": true, + "supports_thinking_cache_preservation": true, "supports_reasoning": true, "supports_response_schema": true, "supports_native_structured_output": true, @@ -14698,6 +14700,7 @@ "supports_function_calling": true, "supports_pdf_input": true, "supports_prompt_caching": true, + "supports_thinking_cache_preservation": true, "supports_reasoning": true, "supports_response_schema": true, "supports_native_structured_output": true, @@ -14727,6 +14730,7 @@ "supports_function_calling": true, "supports_pdf_input": true, "supports_prompt_caching": true, + "supports_thinking_cache_preservation": true, "supports_reasoning": true, "supports_response_schema": true, "supports_native_structured_output": true, @@ -14759,6 +14763,7 @@ "supports_function_calling": true, "supports_pdf_input": true, "supports_prompt_caching": true, + "supports_thinking_cache_preservation": true, "supports_reasoning": true, "supports_response_schema": true, "supports_native_structured_output": true, @@ -14796,6 +14801,7 @@ "supports_function_calling": true, "supports_pdf_input": true, "supports_prompt_caching": true, + "supports_thinking_cache_preservation": true, "supports_reasoning": true, "supports_response_schema": true, "supports_native_structured_output": true, @@ -14831,6 +14837,7 @@ "supports_function_calling": true, "supports_pdf_input": true, "supports_prompt_caching": true, + "supports_thinking_cache_preservation": true, "supports_reasoning": true, "supports_response_schema": true, "supports_native_structured_output": true, @@ -14869,6 +14876,7 @@ "supports_function_calling": true, "supports_pdf_input": true, "supports_prompt_caching": true, + "supports_thinking_cache_preservation": true, "supports_reasoning": true, "supports_response_schema": true, "supports_native_structured_output": true, @@ -14986,6 +14994,7 @@ "supports_function_calling": true, "supports_pdf_input": true, "supports_prompt_caching": true, + "supports_thinking_cache_preservation": true, "supports_reasoning": true, "supports_response_schema": true, "supports_native_structured_output": true, @@ -15027,6 +15036,7 @@ "supports_function_calling": true, "supports_pdf_input": true, "supports_prompt_caching": true, + "supports_thinking_cache_preservation": true, "supports_reasoning": true, "supports_response_schema": true, "supports_native_structured_output": true, diff --git a/litellm/models/autorouter_session.py b/litellm/models/autorouter_session.py index c7126236ec3..ddce2b5ef81 100644 --- a/litellm/models/autorouter_session.py +++ b/litellm/models/autorouter_session.py @@ -8,6 +8,8 @@ maintains per (api_key, session_id, router_name). from collections.abc import Mapping from datetime import datetime +from pydantic import Field + from litellm.types.llms.base import LiteLLMPydanticObjectBase @@ -22,18 +24,25 @@ class LiteLLM_AutoRouterSession(LiteLLMPydanticObjectBase): turns: int spend: float saved_spend: float + savings_estimated_turns: int = 0 + savings_estimated_actual_spend: float = 0.0 + savings_estimated_saved_spend: float = 0.0 + savings_estimated_baseline_models: Mapping[str, int] = Field(default_factory=dict) classifier_cost: float tier_turns: Mapping[str, int] baseline_models: Mapping[str, int] @property def baseline_model(self) -> str | None: - """The baseline most of this session's turns were priced against, or None when no turn recorded one. + """The baseline most covered turns were priced against, or None when none were estimated. A router reconfigured mid-session leaves turns priced against two baselines; the row keeps both counts, and the label is the one that priced the most money-carrying turns rather than whatever the router is configured with now. """ - if not self.baseline_models: + if not self.savings_estimated_baseline_models: return None - return max(self.baseline_models, key=lambda model: (self.baseline_models[model], model)) + return max( + self.savings_estimated_baseline_models, + key=lambda model: (self.savings_estimated_baseline_models[model], model), + ) diff --git a/litellm/proxy/_types.py b/litellm/proxy/_types.py index 6322a1212fe..56b3f590210 100644 --- a/litellm/proxy/_types.py +++ b/litellm/proxy/_types.py @@ -13,6 +13,7 @@ from pydantic import ( ConfigDict, Field, Json, + JsonValue, PositiveInt, field_validator, model_validator, @@ -123,6 +124,7 @@ class SupportedDBObjectType(str, enum.Enum): MODEL_COST_MAP = "model_cost_map" TOOLS = "tools" CONFIG_OVERRIDES = "config_overrides" + WEBSEARCH_INTERCEPTION_SETTINGS = "websearch_interception_settings" def __str__(self): return str(self.value) @@ -3940,6 +3942,7 @@ class SpendLogsRouterMetadata(TypedDict): class SpendLogsMetadata(TypedDict): + autorouter_baseline_observation: ReadOnly[str | None] """ Specific metadata k,v pairs logged to spendlogs for easier cost tracking """ @@ -3980,7 +3983,8 @@ class SpendLogsMetadata(TypedDict): original_model_group: ReadOnly[str | None] # Model group requested before any fallbacks cost_breakdown: CostBreakdown | None # Detailed cost breakdown (input_cost, output_cost, margin, discount, etc.) compression_savings: CompressionSavingsMetadata | None - autorouter_savings: ReadOnly[float | None] # stamped by the logging payload; None = not auto-routed + autorouter_savings: ReadOnly[float | None] + autorouter_savings_estimate: ReadOnly[Mapping[str, JsonValue] | None] litellm_gateway_injected_cache: ReadOnly[str | None] router_metadata: ReadOnly[SpendLogsRouterMetadata | None] # None = deployment not flagged internal_router_model azure_spillover: ReadOnly[AzureSpillover | None] # None = Azure did not report spillover diff --git a/litellm/proxy/auth/auth_checks.py b/litellm/proxy/auth/auth_checks.py index 61d2fa572a1..2ae285d6eef 100644 --- a/litellm/proxy/auth/auth_checks.py +++ b/litellm/proxy/auth/auth_checks.py @@ -4012,6 +4012,64 @@ async def get_org_object( return _org_obj +def _last_known_org_cache_key(org_id: str) -> str: + return f"org_id:{org_id}:with_budget:last_known" + + +async def _keep_last_known_org( + org: LiteLLM_OrganizationTable, org_id: str, user_api_key_cache: UserApiKeyCache +) -> None: + cache_key: Final = _last_known_org_cache_key(org_id) + held_locally: Final = await user_api_key_cache.async_get_cache( + key=cache_key, local_only=True, model_type=LiteLLM_OrganizationTable + ) + if held_locally is not None: + return + await user_api_key_cache.async_set_cache( + key=cache_key, + value=org, + model_type=LiteLLM_OrganizationTable, + ttl=get_management_object_ttl(user_api_key_cache), + ) + + +async def get_org_object_for_request( + org_id: str, + prisma_client: PrismaClient, + user_api_key_cache: UserApiKeyCache, + parent_otel_span: Span | None, + proxy_logging_obj: ProxyLogging | None, +) -> LiteLLM_OrganizationTable | None: + try: + org: Final = await get_org_object( + org_id=org_id, + prisma_client=prisma_client, + user_api_key_cache=user_api_key_cache, + parent_otel_span=parent_otel_span, + proxy_logging_obj=proxy_logging_obj, + include_budget_table=True, + ) + except OrganizationNotFoundError: + return None + except Exception as e: # noqa: BLE001 # only a DB outage may fail auth here, anything else degrades to no org limits + if not PrismaDBExceptionHandler.is_database_service_unavailable_error_in_chain(e): + verbose_proxy_logger.debug("org lookup failed, continuing without org limits", exc_info=True) + return None + last_known_org: Final = await user_api_key_cache.async_get_cache( + key=_last_known_org_cache_key(org_id), + model_type=LiteLLM_OrganizationTable, + ) + if last_known_org is not None: + return last_known_org + if PrismaDBExceptionHandler.should_allow_request_on_db_unavailable(): + return None + raise + if org is None: + return None + await _keep_last_known_org(org, org_id, user_api_key_cache) + return org + + async def _get_resources_from_access_groups( access_group_ids: Sequence[str], resource_field: Literal["access_model_names", "access_mcp_server_ids", "access_agent_ids"], @@ -5680,7 +5738,7 @@ async def _project_max_budget_check( if project_object.litellm_budget_table is not None: max_budget = project_object.litellm_budget_table.max_budget - if max_budget is None or max_budget <= 0 or not math.isfinite(max_budget): + if max_budget is None or not math.isfinite(max_budget): return from litellm.proxy.proxy_server import get_current_spend diff --git a/litellm/proxy/auth/user_api_key_auth.py b/litellm/proxy/auth/user_api_key_auth.py index 6f6db73f99e..de0131772bc 100644 --- a/litellm/proxy/auth/user_api_key_auth.py +++ b/litellm/proxy/auth/user_api_key_auth.py @@ -58,6 +58,7 @@ from litellm.proxy.auth.auth_checks import ( get_jwt_key_mapping_object, get_key_end_user_budget_id, get_object_permission, + get_org_object_for_request, get_project_object, get_team_membership, get_team_object, @@ -2611,6 +2612,47 @@ def _token_can_vouch_for_team(valid_token: UserAPIKeyAuth, lookup_error: BaseExc return PrismaDBExceptionHandler.should_allow_request_on_db_unavailable() +async def _inherit_org_identity( + user_api_key_auth_obj: UserAPIKeyAuth, + team_object: LiteLLM_TeamTableCachedObj | None, + prisma_client: PrismaClient | None, + user_api_key_cache: UserApiKeyCache, + parent_otel_span: Span | None, + proxy_logging_obj: ProxyLogging | None, +) -> None: + if user_api_key_auth_obj.org_id is None and team_object is not None and team_object.organization_id is not None: + user_api_key_auth_obj.org_id = team_object.organization_id + already_populated: Final = any( + value is not None + for value in ( + user_api_key_auth_obj.organization_alias, + user_api_key_auth_obj.organization_max_budget, + user_api_key_auth_obj.organization_tpm_limit, + user_api_key_auth_obj.organization_rpm_limit, + user_api_key_auth_obj.organization_metadata, + ) + ) + if user_api_key_auth_obj.org_id is None or already_populated or prisma_client is None: + return + org_object: Final = await get_org_object_for_request( + org_id=user_api_key_auth_obj.org_id, + prisma_client=prisma_client, + user_api_key_cache=user_api_key_cache, + parent_otel_span=parent_otel_span, + proxy_logging_obj=proxy_logging_obj, + ) + if org_object is None: + return + user_api_key_auth_obj.organization_alias = org_object.organization_alias + user_api_key_auth_obj.organization_metadata = org_object.metadata + budget: Final = org_object.litellm_budget_table + if budget is None: + return + user_api_key_auth_obj.organization_max_budget = budget.max_budget + user_api_key_auth_obj.organization_tpm_limit = budget.tpm_limit + user_api_key_auth_obj.organization_rpm_limit = budget.rpm_limit + + def is_no_auth_dev_mode(master_key: str | None, general_settings: Mapping[str, object]) -> bool: return master_key is None and not any( general_settings.get(flag, False) @@ -2849,8 +2891,14 @@ async def _run_centralized_common_checks( user_object=user_object, ) - if user_api_key_auth_obj.org_id is None and team_object is not None and team_object.organization_id is not None: - user_api_key_auth_obj.org_id = team_object.organization_id + await _inherit_org_identity( + user_api_key_auth_obj=user_api_key_auth_obj, + team_object=team_object, + prisma_client=prisma_client, + user_api_key_cache=user_api_key_cache, + parent_otel_span=parent_otel_span, + proxy_logging_obj=proxy_logging_obj, + ) # common_checks identifies admin via user_object, not the token # (non_proxy_admin_allowed_routes_check). JWT admin shortcut and diff --git a/litellm/proxy/batches_endpoints/endpoints.py b/litellm/proxy/batches_endpoints/endpoints.py index 0e348fa6e06..6d5f7a65855 100644 --- a/litellm/proxy/batches_endpoints/endpoints.py +++ b/litellm/proxy/batches_endpoints/endpoints.py @@ -7,10 +7,12 @@ import asyncio import os from collections.abc import Mapping +from datetime import datetime from types import MappingProxyType -from typing import Any, Final, cast +from typing import TYPE_CHECKING, Any, Final, Literal, cast from fastapi import APIRouter, Depends, HTTPException, Path, Request, Response +from pydantic import TypeAdapter import litellm from litellm._logging import verbose_proxy_logger @@ -18,6 +20,15 @@ from litellm.batches.main import CancelBatchRequest, RetrieveBatchRequest from litellm.proxy._types import * from litellm.proxy.auth.user_api_key_auth import user_api_key_auth from litellm.proxy.batches_endpoints.common_utils import validate_batch_list_limit +from litellm.proxy.batches_endpoints.litellm_executed_batches import ( + LITELLM_EXECUTED_BATCH_UPLOAD_GUIDANCE, + LiteLLMExecutedBatchRunner, + ManagedBatchStore, + batch_error, + executed_batch_runner_lost, + litellm_executed_provider_for, + resolve_litellm_executed_provider, +) from litellm.proxy.common_request_processing import ( ProxyBaseLLMRequestProcessing, log_llm_api_exception, @@ -47,16 +58,87 @@ from litellm.proxy.openai_files_endpoints.common_utils import ( get_model_id_from_unified_batch_id, get_models_from_unified_file_id, get_original_file_id, + is_litellm_executed_batch, prepare_data_with_credentials, update_batch_in_database, validate_managed_id_requirement, ) +from litellm.proxy.pass_through_endpoints.llm_provider_handlers.batch_attribution import request_tags_from_metadata from litellm.proxy.route_llm_request import raise_if_required_body_param_missing -from litellm.proxy.utils import handle_exception_on_proxy, is_known_model +from litellm.proxy.utils import PrismaClient, ProxyLogging, handle_exception_on_proxy, is_known_model +from litellm.repositories.managed_batch_repository import ManagedBatchRepository from litellm.repositories.table_repositories import ManagedFileRepository +from litellm.router import Router from litellm.types.llms.openai import LiteLLMBatchCreateRequest +from litellm.types.utils import LiteLLMBatch + +if TYPE_CHECKING: + from prisma.models import LiteLLM_ManagedObjectTable router: Final = APIRouter() +_METADATA_ADAPTER: Final[TypeAdapter[Mapping[str, object]]] = TypeAdapter(Mapping[str, object]) + + +def _request_tags(data: Mapping[str, object]) -> tuple[str, ...] | None: + metadata: Final = data.get("litellm_metadata") + if metadata is None: + return None + return request_tags_from_metadata(_METADATA_ADAPTER.validate_python(metadata)) + + +def _litellm_executed_batch_runner(llm_router: Router, proxy_logging_obj: ProxyLogging) -> LiteLLMExecutedBatchRunner: + from litellm.proxy.proxy_server import general_settings, prisma_client + + managed_files: Final = proxy_logging_obj.get_proxy_hook("managed_files") + if prisma_client is None or not isinstance(managed_files, ManagedBatchStore): + raise batch_error( + 400, + "LiteLLM-executed batches need a database: set DATABASE_URL so LiteLLM can keep the batch and its files", + ) + return LiteLLMExecutedBatchRunner( + llm_router=llm_router, + prisma_client=prisma_client, + managed_files=managed_files, + batches=ManagedBatchRepository(prisma_client), + proxy_logging_obj=proxy_logging_obj, + general_settings=general_settings, + ) + + +async def _batch_from_database( + batch_id: str, + unified_batch_id: str | Literal[False], + executed_batch: bool, + managed_files_obj: object, + prisma_client: PrismaClient | None, + llm_router: Router | None, + proxy_logging_obj: ProxyLogging, + user_api_key_dict: UserAPIKeyAuth, +) -> tuple["LiteLLM_ManagedObjectTable | None", LiteLLMBatch | None]: + row, batch = await get_batch_from_database( + batch_id=batch_id, + unified_batch_id=unified_batch_id, + managed_files_obj=managed_files_obj, + prisma_client=prisma_client, + verbose_proxy_logger=verbose_proxy_logger, + ) + updated_at: Final[object] = getattr(row, "updated_at", None) + if not executed_batch or batch is None or llm_router is None or not isinstance(updated_at, datetime): + return row, batch + if not executed_batch_runner_lost(batch.status, updated_at): + return row, batch + runner: Final = _litellm_executed_batch_runner(llm_router, proxy_logging_obj) + return row, await runner.fail_abandoned(batch, user_api_key_dict) + + +async def _raise_when_input_file_must_be_managed(model: str, credentials: Mapping[str, object]) -> None: + if await litellm_executed_provider_for(credentials) is None: + return + raise batch_error( + 400, + f"Batches for {model} run inside LiteLLM, so the input file must be a LiteLLM managed file: " + f"{LITELLM_EXECUTED_BATCH_UPLOAD_GUIDANCE}", + ) def _raise_not_found_when_openai_fallback_unservable( @@ -101,6 +183,24 @@ async def _resolve_managed_input_file_storage_url(input_file_id: str) -> "str | return db_file.storage_url or None +async def _create_provider_batch_for_managed_file( + llm_router: Router, + create_batch_data: LiteLLMBatchCreateRequest, + input_file_id: str, + unified_file_id: str, +) -> LiteLLMBatch: + resolved_storage_url: Final = await _resolve_managed_input_file_storage_url(input_file_id) + request: Final[LiteLLMBatchCreateRequest] = { + **create_batch_data, + "input_file_id": resolved_storage_url or input_file_id, + "disable_fallbacks": True, + } + response: Final = await llm_router.acreate_batch(**request) + response.input_file_id = input_file_id + response._hidden_params["unified_file_id"] = unified_file_id + return response + + @router.post( "/{provider}/v1/batches", dependencies=[Depends(user_api_key_auth)], @@ -296,24 +396,35 @@ async def create_batch( await authorize_model_for_key(model_id=model, llm_router=llm_router, user_api_key_dict=user_api_key_dict) _create_batch_data["model"] = model - resolved_storage_url: Final = await _resolve_managed_input_file_storage_url(input_file_id) - if resolved_storage_url is not None: - _create_batch_data["input_file_id"] = resolved_storage_url - if llm_router is None: raise HTTPException( status_code=500, detail={"error": "LLM Router not initialized. Ensure models added to proxy."}, ) - _create_batch_data.update(disable_fallbacks=True) # pyright: ignore[reportCallIssue] # router flag - response = await llm_router.acreate_batch(**_create_batch_data) - response.input_file_id = input_file_id - response._hidden_params["unified_file_id"] = unified_file_id + executed_provider: Final = await resolve_litellm_executed_provider( + llm_router, model, user_api_key_dict.team_id + ) + response = ( + await _litellm_executed_batch_runner(llm_router, proxy_logging_obj).create( + create_request=_create_batch_data, + unified_input_file_id=input_file_id, + model=model, + provider=executed_provider, + user_api_key_dict=user_api_key_dict, + request_tags=_request_tags(_create_batch_data), + ) + if executed_provider is not None + else await _create_provider_batch_for_managed_file( + llm_router, _create_batch_data, input_file_id, unified_file_id + ) + ) else: # Check if model specified via header/query/body param model_param: Final = ( - data.get("model") or request.query_params.get("model") or request.headers.get("x-litellm-model") + _create_batch_data.get("model") + or request.query_params.get("model") + or request.headers.get("x-litellm-model") ) # SCENARIO 2 & 3: Model from header/query OR custom_llm_provider fallback @@ -325,6 +436,7 @@ async def create_batch( user_api_key_dict=user_api_key_dict, operation_context="batch creation", ) + await _raise_when_input_file_must_be_managed(model_param, credentials) prepare_data_with_credentials( data=_create_batch_data, @@ -486,23 +598,26 @@ async def retrieve_batch( managed_files_obj: Final = proxy_logging_obj.get_proxy_hook("managed_files") from litellm.proxy.proxy_server import prisma_client - db_batch_object, response = await get_batch_from_database( + executed_batch: Final = isinstance(unified_batch_id, str) and is_litellm_executed_batch(unified_batch_id) + db_batch_object, response = await _batch_from_database( batch_id=batch_id, unified_batch_id=unified_batch_id, + executed_batch=executed_batch, managed_files_obj=managed_files_obj, prisma_client=prisma_client, - verbose_proxy_logger=verbose_proxy_logger, + llm_router=llm_router, + proxy_logging_obj=proxy_logging_obj, + user_api_key_dict=user_api_key_dict, ) + if executed_batch and response is None: + raise batch_error(404, f"No batch found with id '{batch_id}'.") + # If batch is in a terminal state, return immediately. # Include "complete" (DB-normalized form of "completed"). - if response is not None and response.status in [ - "completed", - "complete", - "failed", - "cancelled", - "expired", - ]: + if response is not None and ( + response.status in ("completed", "complete", "failed", "cancelled", "expired") or executed_batch + ): # Call hooks and return response = await proxy_logging_obj.post_call_success_hook( data=data, user_api_key_dict=user_api_key_dict, response=response @@ -978,6 +1093,17 @@ async def cancel_batch( proxy_config=proxy_config, ) + unified_model_id: Final = get_model_id_from_unified_batch_id(unified_batch_id) if unified_batch_id else None + if unified_model_id is not None: + resolved_unified_model: Final = ( + llm_router.resolve_model_name_from_model_id(unified_model_id) if llm_router is not None else None + ) + await authorize_model_for_key( + model_id=resolved_unified_model or unified_model_id, + llm_router=llm_router, + user_api_key_dict=user_api_key_dict, + ) + # SCENARIO 1: Batch ID is encoded with model info if model_from_id is not None: credentials: Final = await get_authorized_credentials_for_model( @@ -1009,6 +1135,12 @@ async def cancel_batch( ) # SCENARIO 2: target_model_names based routing + elif unified_batch_id and is_litellm_executed_batch(unified_batch_id): + if llm_router is None: + raise batch_error(500, "LLM Router not initialized. Ensure models added to proxy.") + response = await _litellm_executed_batch_runner( # rebind-ok: each cancel path sets the route's response + llm_router, proxy_logging_obj + ).cancel(batch_id, user_api_key_dict) elif unified_batch_id: if llm_router is None: raise HTTPException( @@ -1022,11 +1154,6 @@ async def cancel_batch( status_code=400, detail={"error": "Invalid LiteLLM managed batch ID. Missing model_id."}, ) - await authorize_model_for_key( - model_id=llm_router.resolve_model_name_from_model_id(model_id_from_batch) or model_id_from_batch, - llm_router=llm_router, - user_api_key_dict=user_api_key_dict, - ) data["model"] = model_id_from_batch data["batch_id"] = get_batch_id_from_unified_batch_id(unified_batch_id) response = await llm_router.acancel_batch(**data) diff --git a/litellm/proxy/batches_endpoints/litellm_executed_batches.py b/litellm/proxy/batches_endpoints/litellm_executed_batches.py new file mode 100644 index 00000000000..67201d99422 --- /dev/null +++ b/litellm/proxy/batches_endpoints/litellm_executed_batches.py @@ -0,0 +1,716 @@ +import asyncio +import json +import time +from collections.abc import Awaitable, Callable, Mapping, Sequence +from dataclasses import dataclass +from datetime import datetime, timedelta, timezone +from itertools import pairwise +from types import MappingProxyType +from typing import TYPE_CHECKING, Final, Literal, Protocol, TypeAlias, runtime_checkable + +import httpx +from openai.types.batch import Errors +from openai.types.batch_error import BatchError +from openai.types.batch_request_counts import BatchRequestCounts +from pydantic import BaseModel, ConfigDict, TypeAdapter, ValidationError +from typing_extensions import ReadOnly, TypedDict + +import litellm +from litellm._logging import verbose_proxy_logger +from litellm._uuid import uuid as uuid_module +from litellm.constants import LITELLM_EXECUTED_BATCH_CONCURRENCY +from litellm.integrations.prometheus import PrometheusLogger +from litellm.llms.base_llm.files.litellm_db_storage_backend import LITELLM_DB_STORAGE_BACKEND_NAME +from litellm.llms.base_llm.files.storage_backend import BaseFileStorageBackend +from litellm.llms.base_llm.files.storage_backend_factory import get_storage_backend +from litellm.llms.custom_httpx.http_handler import get_async_httpx_client +from litellm.models.managed_files import LiteLLM_ManagedFileTable +from litellm.proxy._types import ProxyErrorTypes, ProxyException, UserAPIKeyAuth +from litellm.proxy.auth.auth_utils import is_request_body_safe +from litellm.proxy.litellm_pre_call_utils import LiteLLMProxyRequestSetup +from litellm.proxy.openai_files_endpoints.common_utils import LITELLM_EXECUTED_BATCH_ID_PREFIX +from litellm.proxy.openai_files_endpoints.storage_backend_service import StorageBackendFileService +from litellm.proxy.utils import PrismaClient, ProxyLogging +from litellm.repositories.managed_batch_repository import ManagedBatchRepository +from litellm.types.llms.openai import LiteLLMBatchCreateRequest, OpenAIFileObject, OpenAIFilesPurpose +from litellm.types.utils import LITELLM_EXECUTED_BATCH_PROVIDERS, ExtractedFileData, LiteLLMBatch, LlmProviders + +if TYPE_CHECKING: + from prisma import types as prisma_types + + from litellm.router import Router + +BatchEndpoint: TypeAlias = Literal["/v1/chat/completions", "/v1/embeddings", "/v1/completions", "/v1/responses"] +BatchStatus: TypeAlias = Literal[ + "in_progress", "finalizing", "completed", "failed", "cancelling", "cancelled", "expired" +] +TERMINAL_BATCH_STATUSES: Final[frozenset[str]] = frozenset({"completed", "failed", "cancelled", "expired"}) +_STOP_STATUSES: Final[frozenset[str]] = TERMINAL_BATCH_STATUSES | frozenset({"cancelling"}) +_BATCH_ENDPOINT_ADAPTER: Final[TypeAdapter[BatchEndpoint]] = TypeAdapter(BatchEndpoint) +_CANCEL_POLL_SECONDS: Final = 1.0 +_HEARTBEAT_SECONDS: Final = 30.0 +_STALE_AFTER_SECONDS: Final = 180.0 +_FILES_API_PROBE_TIMEOUT_SECONDS: Final = 5.0 +_COMPLETION_WINDOW_SECONDS: Final = 24 * 60 * 60 +_RUNNER_LOST_MESSAGE: Final = "the proxy replica running this batch stopped before it finished; resubmit the batch" +_EXPIRED_MESSAGE: Final = "This request could not be executed before the completion window expired." +_ROUTER_METHODS: Final[Mapping[BatchEndpoint, str]] = MappingProxyType( + { + "/v1/chat/completions": "acompletion", + "/v1/completions": "atext_completion", + "/v1/embeddings": "aembedding", + "/v1/responses": "aresponses", + } +) +_CANCELLING_TRANSITIONS: Final[Mapping[BatchStatus, BatchStatus]] = MappingProxyType( + {"completed": "cancelled", "expired": "cancelled", "in_progress": "cancelling", "finalizing": "cancelling"} +) +LITELLM_EXECUTED_BATCH_UPLOAD_GUIDANCE: Final = ( + "upload it through POST /v1/files with purpose=batch and either the x-litellm-model header or the " + "target_model_names form field naming the model, so LiteLLM keeps the file and runs the batch itself" +) +_RUNNING_BATCHES: Final[set[asyncio.Task[None]]] = set() # mutable-ok: strong references keep running batch tasks alive +_NO_FIELDS: Final[Mapping[str, object]] = MappingProxyType({}) +_NO_HEADERS: Final[Mapping[str, str]] = MappingProxyType({}) + + +class _ErrorDetail(TypedDict): + message: ReadOnly[str] + type: ReadOnly[str] + param: ReadOnly[None] + code: ReadOnly[None] + + +class _ErrorBody(TypedDict): + error: ReadOnly[_ErrorDetail] + + +class _ResultResponse(TypedDict): + status_code: ReadOnly[int] + request_id: ReadOnly[str] + body: ReadOnly[Mapping[str, object]] + + +class _LineError(TypedDict): + code: ReadOnly[str] + message: ReadOnly[str] + + +class _ResultLine(TypedDict): + id: ReadOnly[str] + custom_id: ReadOnly[str] + response: ReadOnly[_ResultResponse | None] + error: ReadOnly[_LineError | None] + + +class BatchInputLine(BaseModel): + model_config = ConfigDict(extra="forbid", frozen=True) + + custom_id: str + method: Literal["POST"] + url: str + body: Mapping[str, object] + + +@dataclass(frozen=True, slots=True) +class InvalidBatchInput: + line_number: int | None + reason: str + + def describe(self) -> str: + return f"line {self.line_number}: {self.reason}" if self.line_number is not None else self.reason + + +@dataclass(frozen=True, slots=True) +class RowOutcome: + custom_id: str + status_code: int + body: Mapping[str, object] + succeeded: bool + + +@dataclass(frozen=True, slots=True) +class ExpiredRow: + custom_id: str + + +@dataclass(frozen=True, slots=True) +class _BatchRun: + unified_batch_id: str + llm_batch_id: str + model: str + endpoint: BatchEndpoint + lines: tuple[BatchInputLine, ...] + user_api_key_dict: UserAPIKeyAuth + request_tags: tuple[str, ...] + deadline: float + + +@runtime_checkable +class ManagedBatchStore(Protocol): + def get_unified_batch_id(self, batch_id: str, model_id: str) -> str: ... + + async def get_unified_file_id( + self, file_id: str, litellm_parent_otel_span: object | None = None + ) -> LiteLLM_ManagedFileTable | None: ... + + async def store_unified_object_id( + self, + unified_object_id: str, + file_object: LiteLLMBatch, + litellm_parent_otel_span: object | None, + model_object_id: str, + file_purpose: Literal["batch", "fine-tune", "response"], + user_api_key_dict: UserAPIKeyAuth, + request_tags: Sequence[str] | None = None, + persist_attribution: bool = False, + batch_processed: bool = False, + ) -> None: ... + + +class _StorageBackendFactory(Protocol): + def __call__(self, backend_type: str, prisma_client: PrismaClient | None = None) -> BaseFileStorageBackend: ... + + +class _ResultFileUploader(Protocol): + def __call__( + self, + file_data: Mapping[str, object], + target_storage: str, + target_model_names: Sequence[str], + purpose: OpenAIFilesPurpose, + proxy_logging_obj: ProxyLogging, + user_api_key_dict: UserAPIKeyAuth, + prisma_client: PrismaClient | None = None, + ) -> Awaitable[OpenAIFileObject]: ... + + +@runtime_checkable +class _RouterCall(Protocol): + def __call__(self, **params: object) -> Awaitable[object]: ... # kwargs-ok: the request body is passed as keywords + + +def litellm_executed_provider_of(credentials: Mapping[str, object]) -> str | None: + explicit_provider: Final = credentials.get("custom_llm_provider") + provider: Final = ( + explicit_provider if isinstance(explicit_provider, str) else _provider_of(credentials.get("model")) + ) + return provider if provider in LITELLM_EXECUTED_BATCH_PROVIDERS else None + + +class _HttpGetter(Protocol): + async def get( + self, url: str, *, headers: dict[str, str] | None = None, timeout: float | httpx.Timeout | None = None + ) -> httpx.Response: ... + + +class FilesApiProbe(Protocol): + async def __call__(self, api_base: str, api_key: str | None) -> bool: ... + + +class BodyRejection(Protocol): + def __call__(self, body: Mapping[str, object], /) -> str | None: ... + + +async def upstream_lacks_files_api(api_base: str, api_key: str | None, http_client: _HttpGetter | None = None) -> bool: + client: Final = http_client or get_async_httpx_client(llm_provider=LlmProviders.HOSTED_VLLM) + try: + response: Final = await client.get( + f"{api_base.rstrip('/')}/files", + headers=( + {"Authorization": f"Bearer {api_key}"} # mutable-ok: AsyncHTTPHandler.get wants a plain dict + if api_key + else None + ), + timeout=_FILES_API_PROBE_TIMEOUT_SECONDS, + ) + except httpx.HTTPError: + return False + return response.status_code == httpx.codes.NOT_FOUND + + +def _upstream_of(credentials: Mapping[str, object], provider: str) -> tuple[str, str | None] | None: + model: Final = credentials.get("model") + api_base: Final = credentials.get("api_base") + api_key: Final = credentials.get("api_key") + if not isinstance(model, str): + return None + try: + _, _, resolved_api_key, resolved_api_base = litellm.get_llm_provider( + model=model, + custom_llm_provider=provider, + api_base=api_base if isinstance(api_base, str) else None, + api_key=api_key if isinstance(api_key, str) else None, + ) + except Exception: # noqa: BLE001 # get_llm_provider raises on a model it cannot map, which means nothing to probe + return None + return None if resolved_api_base is None else (resolved_api_base, resolved_api_key) + + +async def litellm_executed_provider_for( + credentials: Mapping[str, object], lacks_files_api: FilesApiProbe = upstream_lacks_files_api +) -> str | None: + provider: Final = litellm_executed_provider_of(credentials) + if provider is None: + return None + upstream: Final = _upstream_of(credentials, provider) + if upstream is None: + return None + return provider if await lacks_files_api(*upstream) else None + + +async def resolve_litellm_executed_provider( + llm_router: "Router", + model: str, + team_id: str | None, + lacks_files_api: FilesApiProbe = upstream_lacks_files_api, +) -> str | None: + credentials: Final = llm_router.get_deployment_credentials_with_provider(model_id=model, team_id=team_id) + return None if credentials is None else await litellm_executed_provider_for(credentials, lacks_files_api) + + +def _provider_of(model: object) -> str | None: + if not isinstance(model, str): + return None + try: + return litellm.get_llm_provider(model=model)[1] + except Exception: # noqa: BLE001 # get_llm_provider raises on an unknown model, which means no provider + return None + + +def _validation_reason(error: ValidationError) -> str: + return "; ".join( + f"{'.'.join(str(part) for part in item['loc'])}: {item['msg']}" if item["loc"] else item["msg"] + for item in error.errors() + ) + + +def _accept_every_body(_body: Mapping[str, object]) -> str | None: + return None + + +def _parse_line( + line_number: int, raw: bytes, endpoint: BatchEndpoint, reject_body: BodyRejection +) -> BatchInputLine | InvalidBatchInput: + try: + line: Final = BatchInputLine.model_validate_json(raw) + except ValidationError as e: + return InvalidBatchInput(line_number, _validation_reason(e)) + if line.url != endpoint: + return InvalidBatchInput(line_number, f"url {line.url!r} does not match the batch endpoint {endpoint!r}") + if line.body.get("stream"): + return InvalidBatchInput(line_number, "streaming requests are not supported in a batch") + rejection: Final = reject_body(line.body) + if rejection is not None: + return InvalidBatchInput(line_number, rejection) + return line + + +def parse_batch_input( + content: bytes, endpoint: BatchEndpoint, reject_body: BodyRejection = _accept_every_body +) -> tuple[BatchInputLine, ...] | InvalidBatchInput: + raw_lines: Final = tuple((number, raw) for number, raw in enumerate(content.splitlines(), start=1) if raw.strip()) + if not raw_lines: + return InvalidBatchInput(None, "the input file has no requests") + parsed: Final = tuple(_parse_line(number, raw, endpoint, reject_body) for number, raw in raw_lines) + first_invalid: Final = next((item for item in parsed if isinstance(item, InvalidBatchInput)), None) + if first_invalid is not None: + return first_invalid + lines: Final = tuple(item for item in parsed if isinstance(item, BatchInputLine)) + custom_ids: Final = sorted(line.custom_id for line in lines) + duplicate: Final = next((first for first, second in pairwise(custom_ids) if first == second), None) + if duplicate is not None: + return InvalidBatchInput(None, f"custom_id {duplicate!r} is used more than once") + return lines + + +def batch_error(status_code: int, message: str) -> ProxyException: + error_type: Final = "invalid_request_error" if status_code < 500 else ProxyErrorTypes.internal_server_error.value + return ProxyException(message=message, type=error_type, param=None, code=status_code) + + +def _validate_endpoint(endpoint: object) -> BatchEndpoint: + try: + return _BATCH_ENDPOINT_ADAPTER.validate_python(endpoint) + except ValidationError: + raise batch_error(400, f"endpoint {endpoint!r} is not supported for a LiteLLM-executed batch") + + +def _status_code_of(error: Exception) -> int: + status_code: Final[object] = getattr(error, "status_code", None) + return status_code if isinstance(status_code, int) else 500 + + +def _error_body(error: Exception) -> _ErrorBody: + body: Final[_ErrorBody] = { + "error": {"message": str(error), "type": type(error).__name__, "param": None, "code": None} + } + return body + + +def _line_response(outcome: RowOutcome | ExpiredRow) -> _ResultResponse | None: + if isinstance(outcome, ExpiredRow): + return None + response: Final[_ResultResponse] = { + "status_code": outcome.status_code, + "request_id": f"req_{uuid_module.uuid4().hex[:24]}", + "body": outcome.body, + } + return response + + +def _line_error(outcome: RowOutcome | ExpiredRow) -> _LineError | None: + if isinstance(outcome, RowOutcome): + return None + error: Final[_LineError] = {"code": "batch_expired", "message": _EXPIRED_MESSAGE} + return error + + +def _result_line(outcome: RowOutcome | ExpiredRow) -> _ResultLine: + line: Final[_ResultLine] = { + "id": f"batch_req_{uuid_module.uuid4().hex[:24]}", + "custom_id": outcome.custom_id, + "response": _line_response(outcome), + "error": _line_error(outcome), + } + return line + + +def _dump(response: object) -> Mapping[str, object]: + if isinstance(response, BaseModel): + return response.model_dump(mode="json") + raise TypeError(f"Batch rows must return a single response object, got {type(response).__name__}") + + +def _resolve_transition(current_status: str, requested: BatchStatus) -> BatchStatus: + if current_status != "cancelling": + return requested + return _CANCELLING_TRANSITIONS.get(requested, requested) + + +def executed_batch_runner_lost(status: str, updated_at: datetime) -> bool: + if status in TERMINAL_BATCH_STATUSES: + return False + return (datetime.now(timezone.utc) - updated_at).total_seconds() > _STALE_AFTER_SECONDS + + +class _StopWatch: + def __init__(self, load_status: Callable[[], Awaitable[str | None]], interval_seconds: float) -> None: + self._load_status = load_status + self._interval_seconds = interval_seconds + self._checked_at = float("-inf") + self._stopped = False + + async def stopped(self) -> bool: + if self._stopped: + return True + now: Final = time.monotonic() + if now - self._checked_at < self._interval_seconds: + return False + self._checked_at = now + self._stopped = await self._load_status() in _STOP_STATUSES + return self._stopped + + +class LiteLLMExecutedBatchRunner: + def __init__( + self, + llm_router: "Router", + prisma_client: PrismaClient, + managed_files: ManagedBatchStore, + batches: ManagedBatchRepository, + proxy_logging_obj: ProxyLogging, + general_settings: Mapping[str, object], + concurrency: int = LITELLM_EXECUTED_BATCH_CONCURRENCY, + heartbeat_seconds: float = _HEARTBEAT_SECONDS, + completion_window_seconds: float = _COMPLETION_WINDOW_SECONDS, + storage_backend_factory: _StorageBackendFactory = get_storage_backend, + upload_result_file: _ResultFileUploader = StorageBackendFileService.upload_file_to_storage_backend, + ) -> None: + self.llm_router = llm_router + self.prisma_client = prisma_client + self.managed_files = managed_files + self.batches = batches + self.proxy_logging_obj = proxy_logging_obj + self.general_settings = general_settings + self.concurrency = concurrency + self.heartbeat_seconds = heartbeat_seconds + self.completion_window_seconds = completion_window_seconds + self.storage_backend_factory = storage_backend_factory + self.upload_result_file = upload_result_file + + async def create( + self, + create_request: LiteLLMBatchCreateRequest, + unified_input_file_id: str, + model: str, + provider: str, + user_api_key_dict: UserAPIKeyAuth, + request_tags: Sequence[str] | None, + ) -> LiteLLMBatch: + endpoint: Final = _validate_endpoint(create_request.get("endpoint")) + content: Final = await self._download_input(unified_input_file_id, user_api_key_dict) + parsed: Final = parse_batch_input(content, endpoint, self._body_rejection(model)) + if isinstance(parsed, InvalidBatchInput): + raise batch_error(400, f"Invalid batch input file: {parsed.describe()}") + llm_batch_id: Final = f"{LITELLM_EXECUTED_BATCH_ID_PREFIX}{uuid_module.uuid4().hex}" + model_id: Final = next(iter(self.llm_router.get_model_ids(model_name=model)), model) + unified_batch_id: Final = self.managed_files.get_unified_batch_id(batch_id=llm_batch_id, model_id=model_id) + now: Final = time.time() + created_at: Final = int(now) + batch: Final = LiteLLMBatch( + id=unified_batch_id, + object="batch", + endpoint=endpoint, + input_file_id=unified_input_file_id, + completion_window="24h", + status="validating", + created_at=created_at, + expires_at=created_at + int(self.completion_window_seconds), + metadata=create_request.get("metadata"), + model=model, + request_counts=BatchRequestCounts(completed=0, failed=0, total=len(parsed)), + ) + await self.managed_files.store_unified_object_id( + unified_object_id=unified_batch_id, + file_object=batch, + litellm_parent_otel_span=user_api_key_dict.parent_otel_span, + model_object_id=llm_batch_id, + file_purpose="batch", + user_api_key_dict=user_api_key_dict, + request_tags=request_tags, + persist_attribution=True, + batch_processed=True, + ) + _record_batch_created(model, provider, user_api_key_dict) + run: Final = _BatchRun( + unified_batch_id=unified_batch_id, + llm_batch_id=llm_batch_id, + model=model, + endpoint=endpoint, + lines=parsed, + user_api_key_dict=user_api_key_dict, + request_tags=tuple(request_tags or ()), + deadline=now + self.completion_window_seconds, + ) + task: Final = asyncio.create_task(self._run(run)) + _RUNNING_BATCHES.add(task) + task.add_done_callback(_RUNNING_BATCHES.discard) + return batch + + async def cancel(self, unified_batch_id: str, user_api_key_dict: UserAPIKeyAuth) -> LiteLLMBatch: + current: Final = await self.batches.load_batch(unified_batch_id) + if current is None: + raise batch_error(404, f"Batch {unified_batch_id} not found") + if current.status in TERMINAL_BATCH_STATUSES: + raise batch_error(400, f"Cannot cancel a batch with status '{current.status}'") + if current.status == "cancelling": + return current + cancelling: Final = current.model_copy( + update=MappingProxyType({"status": "cancelling", "cancelling_at": int(time.time())}) + ) + unchanged: Final[prisma_types.LiteLLM_ManagedObjectTableWhereInput] = {"status": current.status} + if await self.batches.compare_and_set(cancelling, unchanged, user_api_key_dict.user_id): + return cancelling + return await self.cancel(unified_batch_id, user_api_key_dict) + + async def fail_abandoned(self, batch: LiteLLMBatch, user_api_key_dict: UserAPIKeyAuth) -> LiteLLMBatch: + error: Final = BatchError(message=_RUNNER_LOST_MESSAGE, code="runner_lost") + errors: Final = Errors(data=[error], object="list") # mutable-ok: Errors.data is typed as a list + failed: Final = batch.model_copy( + update=MappingProxyType({"status": "failed", "failed_at": int(time.time()), "errors": errors}) + ) + untouched: Final[prisma_types.DateTimeFilter] = { + "lt": datetime.now(timezone.utc) - timedelta(seconds=_STALE_AFTER_SECONDS) + } + still_abandoned: Final[prisma_types.LiteLLM_ManagedObjectTableWhereInput] = { + "status": batch.status, + "updated_at": untouched, + } + if await self.batches.compare_and_set(failed, still_abandoned, user_api_key_dict.user_id): + return failed + return await self.batches.load_batch(batch.id) or batch + + def _body_rejection(self, model: str) -> BodyRejection: + def reject(body: Mapping[str, object]) -> str | None: + try: + is_request_body_safe( + request_body=dict(body), # mutable-ok: is_request_body_safe takes a dict + general_settings=dict(self.general_settings), # mutable-ok: is_request_body_safe takes a dict + llm_router=self.llm_router, + model=model, + ) + except ValueError as e: + return str(e) + return None + + return reject + + async def _download_input(self, unified_input_file_id: str, user_api_key_dict: UserAPIKeyAuth) -> bytes: + stored: Final = await self.managed_files.get_unified_file_id( + unified_input_file_id, litellm_parent_otel_span=user_api_key_dict.parent_otel_span + ) + if stored is None or not stored.storage_backend or not stored.storage_url: + raise batch_error( + 400, + f"LiteLLM does not hold the content of input file {unified_input_file_id}: " + f"{LITELLM_EXECUTED_BATCH_UPLOAD_GUIDANCE}", + ) + try: + backend: Final = self.storage_backend_factory(stored.storage_backend, prisma_client=self.prisma_client) + return await backend.download_file(stored.storage_url) + except ValueError as e: + raise batch_error(400, str(e)) + + async def _run(self, run: _BatchRun) -> None: + heartbeat: Final = asyncio.create_task(self._heartbeat(run)) + try: + await self._execute(run) + except Exception as e: # noqa: BLE001 # whatever fails, the batch must end up marked failed + verbose_proxy_logger.exception("LiteLLM-executed batch %s failed: %s", run.unified_batch_id, e) + error: Final = BatchError(message=str(e), code="internal_error") + errors: Final = Errors(data=[error], object="list") # mutable-ok: Errors.data is typed as a list + try: + await self._advance(run, "failed", MappingProxyType({"errors": errors})) + except Exception as advance_error: # noqa: BLE001 # a failed status write is logged, never raised + verbose_proxy_logger.exception( + "LiteLLM-executed batch %s could not be marked failed: %s", run.unified_batch_id, advance_error + ) + finally: + heartbeat.cancel() + + async def _heartbeat(self, run: _BatchRun) -> None: + while True: + await asyncio.sleep(self.heartbeat_seconds) + try: + await self._touch(run) + except Exception as e: # noqa: BLE001 # a missed beat is logged and the next one retries + verbose_proxy_logger.warning("LiteLLM-executed batch %s heartbeat failed: %s", run.unified_batch_id, e) + + async def _touch(self, run: _BatchRun) -> None: + await self.batches.touch(run.unified_batch_id, run.user_api_key_dict.user_id) + + async def _execute(self, run: _BatchRun) -> None: + await self._advance(run, "in_progress") + watch: Final = _StopWatch(lambda: self.batches.load_status(run.unified_batch_id), _CANCEL_POLL_SECONDS) + semaphore: Final = asyncio.Semaphore(self.concurrency) + results: Final = await asyncio.gather(*(self._run_row(run, line, watch, semaphore) for line in run.lines)) + outcomes: Final = tuple(outcome for outcome in results if outcome is not None) + if await self._advance(run, "finalizing") is None: + return + succeeded: Final = tuple( + outcome for outcome in outcomes if isinstance(outcome, RowOutcome) and outcome.succeeded + ) + failed: Final = tuple( + outcome for outcome in outcomes if isinstance(outcome, ExpiredRow) or not outcome.succeeded + ) + output_file_id: Final = await self._upload_results(run, "output", succeeded) + error_file_id: Final = await self._upload_results(run, "error", failed) + request_counts: Final = BatchRequestCounts(completed=len(succeeded), failed=len(failed), total=len(run.lines)) + final_status: Final[BatchStatus] = ( + "expired" if any(isinstance(outcome, ExpiredRow) for outcome in outcomes) else "completed" + ) + await self._advance( + run, + final_status, + MappingProxyType( + {"output_file_id": output_file_id, "error_file_id": error_file_id, "request_counts": request_counts} + ), + ) + + async def _run_row( + self, run: _BatchRun, line: BatchInputLine, watch: _StopWatch, semaphore: asyncio.Semaphore + ) -> RowOutcome | ExpiredRow | None: + async with semaphore: + if await watch.stopped(): + return None + remaining: Final = run.deadline - time.time() + if remaining <= 0: + return ExpiredRow(custom_id=line.custom_id) + try: + return await asyncio.wait_for(self._row_outcome(run, line), timeout=remaining) + except asyncio.TimeoutError: + return ExpiredRow(custom_id=line.custom_id) + + async def _row_outcome(self, run: _BatchRun, line: BatchInputLine) -> RowOutcome: + try: + body: Final = await self._dispatch(run, line) + except Exception as e: # noqa: BLE001 # a provider error becomes the row's error line, never a crashed batch + return RowOutcome( + custom_id=line.custom_id, status_code=_status_code_of(e), body=_error_body(e), succeeded=False + ) + return RowOutcome(custom_id=line.custom_id, status_code=200, body=body, succeeded=True) + + async def _dispatch(self, run: _BatchRun, line: BatchInputLine) -> Mapping[str, object]: + params: Final = MappingProxyType( + {**line.body, "model": run.model, "metadata": self._row_metadata(run), "disable_fallbacks": True} + ) + return _dump(await self._router_call(run.endpoint)(**params)) + + def _router_call(self, endpoint: BatchEndpoint) -> _RouterCall: + method: Final[object] = getattr(self.llm_router, _ROUTER_METHODS[endpoint], None) + if not isinstance(method, _RouterCall): + raise TypeError(f"the router has no callable for {endpoint}") + return method + + def _row_metadata(self, run: _BatchRun) -> dict[str, object]: # mutable-ok: router updates metadata in place + return { # mutable-ok: the router updates request metadata in place + **LiteLLMProxyRequestSetup.get_sanitized_user_information_from_key(run.user_api_key_dict), + "user_api_key": run.user_api_key_dict.api_key, + "user_api_end_user_max_budget": run.user_api_key_dict.end_user_max_budget, + "tags": list(run.request_tags), # mutable-ok: litellm types request tags as a list + "batch_id": run.unified_batch_id, + } + + async def _upload_results( + self, run: _BatchRun, kind: Literal["output", "error"], outcomes: Sequence[RowOutcome | ExpiredRow] + ) -> str | None: + if not outcomes: + return None + content: Final = "".join(f"{json.dumps(_result_line(outcome))}\n" for outcome in outcomes).encode() + file_data: Final[ExtractedFileData] = { + "filename": f"{run.llm_batch_id}_{kind}.jsonl", + "content": content, + "content_type": "application/jsonl", + "headers": _NO_HEADERS, + } + file_object: Final = await self.upload_result_file( + file_data=file_data, + target_storage=LITELLM_DB_STORAGE_BACKEND_NAME, + target_model_names=(run.model,), + purpose="batch_output", + proxy_logging_obj=self.proxy_logging_obj, + user_api_key_dict=run.user_api_key_dict, + prisma_client=self.prisma_client, + ) + return file_object.id + + async def _advance( + self, run: _BatchRun, requested: BatchStatus, fields: Mapping[str, object] = _NO_FIELDS + ) -> BatchStatus | None: + current: Final = await self.batches.load_batch(run.unified_batch_id) + if current is None: + raise RuntimeError(f"Batch {run.unified_batch_id} is no longer stored") + if current.status in TERMINAL_BATCH_STATUSES: + return None + status: Final = _resolve_transition(current.status, requested) + updated: Final = current.model_copy( + update=MappingProxyType({**fields, "status": status, f"{status}_at": int(time.time())}) + ) + unchanged: Final[prisma_types.LiteLLM_ManagedObjectTableWhereInput] = {"status": current.status} + if await self.batches.compare_and_set(updated, unchanged, run.user_api_key_dict.user_id): + return status + return await self._advance(run, requested, fields) + + +def _record_batch_created(model: str, provider: str, user_api_key_dict: UserAPIKeyAuth) -> None: + prometheus_logger: Final = PrometheusLogger.get_instance() + if prometheus_logger is None: + return + prometheus_logger.record_managed_batch_created( + model=model, + api_provider=provider, + user=user_api_key_dict.user_id or "", + user_email=user_api_key_dict.user_email or "", + api_key_alias=user_api_key_dict.key_alias or "", + ) diff --git a/litellm/proxy/client/cli/commands/statusline_script.py b/litellm/proxy/client/cli/commands/statusline_script.py index 47be3888a58..09dd062c888 100644 --- a/litellm/proxy/client/cli/commands/statusline_script.py +++ b/litellm/proxy/client/cli/commands/statusline_script.py @@ -32,6 +32,7 @@ import unicodedata import urllib.error import urllib.request from collections.abc import Callable, Mapping +from math import isfinite from pathlib import Path from types import MappingProxyType from typing import IO, Final, NamedTuple, Protocol @@ -43,6 +44,7 @@ FETCH_TIMEOUT_SECONDS: Final = 3 BAR_WIDTH: Final = 24 BAR_FULL: Final = "\u2588" BAR_EMPTY: Final = "\u2591" +SEPARATOR: Final = " \u00b7 " TRANSCRIPT_SCAN_LIMIT_BYTES: Final = 4 * 1024 * 1024 CLAUDE_BASE_URL_ENV_KEYS: Final = ("ANTHROPIC_BASE_URL",) CLAUDE_API_KEY_ENV_KEYS: Final = ("ANTHROPIC_AUTH_TOKEN", "ANTHROPIC_API_KEY") @@ -63,8 +65,11 @@ class Session(NamedTuple): router_name: str last_model: str spend: float - baseline_spend: float + baseline_spend: float | None baseline_model: str | None + turns: int | None = None + savings_estimated_turns: int | None = None + savings_estimated_actual_spend: float | None = None class Credentials(NamedTuple): @@ -205,17 +210,38 @@ def _session_from_payload(payload: Mapping[str, object]) -> Session | None: router_name: Final = printable(payload.get("router_name")) last_model: Final = printable(payload.get("last_model")) spend: Final = payload.get("spend") - baseline_spend: Final = payload.get("baseline_spend") + baseline_spend: Final = payload.get("savings_estimated_baseline_spend", payload.get("baseline_spend")) + turns: Final = payload.get("turns") + estimated_turns: Final = payload.get("savings_estimated_turns") + estimated_actual: Final = payload.get("savings_estimated_actual_spend") if not router_name or not last_model: return None - if not isinstance(spend, (int, float)) or not isinstance(baseline_spend, (int, float)): + if not isinstance(spend, (int, float)) or isinstance(spend, bool) or not isfinite(spend): + return None + if baseline_spend is not None and ( + not isinstance(baseline_spend, (int, float)) or isinstance(baseline_spend, bool) or not isfinite(baseline_spend) + ): return None return Session( router_name=router_name, last_model=last_model, spend=float(spend), - baseline_spend=float(baseline_spend), + baseline_spend=float(baseline_spend) if baseline_spend is not None else None, baseline_model=printable(payload.get("baseline_model")) or None, + turns=turns if isinstance(turns, int) and not isinstance(turns, bool) and turns >= 0 else None, + savings_estimated_turns=( + estimated_turns + if isinstance(estimated_turns, int) and not isinstance(estimated_turns, bool) and estimated_turns >= 0 + else (0 if estimated_turns is not None else None) + ), + savings_estimated_actual_spend=( + float(estimated_actual) + if isinstance(estimated_actual, (int, float)) + and not isinstance(estimated_actual, bool) + and isfinite(estimated_actual) + and estimated_actual >= 0 + else None + ), ) @@ -314,15 +340,36 @@ def render(model: str, session: Session | None, config_dir: Path, use_color: boo return f"{code}{text}{RESET}" if use_color else text routed: Final = paint(BOLD, f"Routed to: {model}") - if session is None or session.baseline_model is None or session.baseline_spend <= 0: + if session is None: return routed + if session.savings_estimated_turns == 0 or session.baseline_spend is None: + return f"{routed}{SEPARATOR}Savings unavailable" + if session.baseline_model is None or session.baseline_spend <= 0: + return routed + if session.savings_estimated_turns is not None and ( + session.savings_estimated_actual_spend is None + or session.turns is None + or session.savings_estimated_turns > session.turns + ): + return f"{routed}{SEPARATOR}Savings unavailable" + compared_spend: Final = ( + session.savings_estimated_actual_spend + if session.savings_estimated_turns is not None and session.savings_estimated_actual_spend is not None + else session.spend + ) + coverage: Final = ( + f"{SEPARATOR}{session.savings_estimated_turns} of {session.turns} turns estimated" + if session.savings_estimated_turns is not None + else "" + ) reference: Final = baseline_label(session.baseline_model, config_dir) - pct: Final = (session.baseline_spend - session.spend) / session.baseline_spend * 100 - delta: Final = paint(LITELLM_COLOR, f"{'-' if pct >= 0 else '+'}{abs(round(pct))}% vs {reference}") - peak: Final = max(session.spend, session.baseline_spend) + pct: Final = round((session.baseline_spend - compared_spend) / session.baseline_spend * 100) + sign: Final = "-" if pct > 0 else "+" if pct < 0 else "" + delta: Final = paint(LITELLM_COLOR, f"{sign}{abs(pct)}% vs {reference}") + peak: Final = max(compared_spend, session.baseline_spend) label_width: Final = max(_display_width(session.router_name), _display_width(reference)) rows: Final = ( - (session.router_name, session.spend, LITELLM_COLOR), + (session.router_name, compared_spend, LITELLM_COLOR), (reference, session.baseline_spend, BASELINE_COLOR), ) lines: Final = ( @@ -331,7 +378,7 @@ def render(model: str, session: Session | None, config_dir: Path, use_color: boo f"{paint(DIM, f'${amount:.2f}')}" for label, amount, color in rows ) - return "\n".join((f"{routed} {delta}", *lines)) + return "\n".join((f"{routed} {delta}{coverage}", *lines)) def color_enabled(env: Mapping[str, str]) -> bool: diff --git a/litellm/proxy/common_request_processing.py b/litellm/proxy/common_request_processing.py index 6f769e6971a..9484fd7c723 100644 --- a/litellm/proxy/common_request_processing.py +++ b/litellm/proxy/common_request_processing.py @@ -3749,6 +3749,14 @@ class ProxyBaseLLMRequestProcessing: "async_streaming_data_generator: error closing response stream: %s", e, ) + logging_obj: Final = request_data.get("litellm_logging_obj") + if ( + not stream_completed + and isinstance(logging_obj, LiteLLMLoggingObj) + and logging_obj.baseline_cache_context is not None + and logging_obj.model_call_details.get("prompt_cache_response_complete") is not True + ): + await logging_obj.invalidate_baseline_cache_estimate("incomplete_response", completed=True) @staticmethod async def async_streaming_data_generator( diff --git a/litellm/proxy/config_resolvers/settings_store.py b/litellm/proxy/config_resolvers/settings_store.py index 90f1da76bf6..291000b3b6a 100644 --- a/litellm/proxy/config_resolvers/settings_store.py +++ b/litellm/proxy/config_resolvers/settings_store.py @@ -60,9 +60,7 @@ class SettingsStore(MutableMapping[str, JsonValue]): def rejected_writes(self, incoming: Mapping[str, JsonValue]) -> tuple[str, ...]: return tuple( - sorted( - key for key, value in incoming.items() if self.owned_by_config(key) and value != self._yaml_values[key] - ) + sorted(key for key, value in incoming.items() if self.owned_by_config(key) and value != self.get(key)) ) def shadowed_db_keys(self) -> tuple[str, ...]: @@ -74,8 +72,13 @@ class SettingsStore(MutableMapping[str, JsonValue]): def apply_db_row(self, row: DbRow, db_row: Mapping[str, JsonValue]) -> None: previous_row: Final = self._database_rows.get(row, _EMPTY_VALUES) + changed: Final = frozenset( + key + for key in (*previous_row, *db_row) + if previous_row.get(key, ABSENT) != db_row.get(key, ABSENT) # pyright: ignore[reportUnknownArgumentType] # JsonValue vs Absent compare + ) self._database_rows = MappingProxyType({**self._database_rows, row: MappingProxyType(dict(db_row))}) - self._clear_runtime_keys(frozenset((*previous_row, *db_row))) + self._clear_runtime_keys(changed) def resolved(self) -> Mapping[str, JsonValue]: return MappingProxyType(dict(self)) @@ -130,6 +133,9 @@ class SettingsStore(MutableMapping[str, JsonValue]): def __len__(self) -> int: return sum(1 for _ in self) + def __bool__(self) -> bool: + return any(True for _ in self) + def _clear_runtime(self) -> None: self._runtime_values = _EMPTY_VALUES self._deleted_runtime_keys = frozenset() @@ -160,7 +166,12 @@ class SettingsStore(MutableMapping[str, JsonValue]): def _db_value_is_shadowed(self, key: str) -> bool: db_value: Final = self._db_value(key) - return not isinstance(db_value, Absent) and db_value is not None and db_value != self.get(key) + return ( + not isinstance(db_value, Absent) + and db_value is not None + and db_value != self.get(key) + and db_value != self.config_value(key) + ) def _resolution_for(self, key: str) -> Resolved: yaml_value: Final[SettingValue] = self._yaml_values.get(key, ABSENT) diff --git a/litellm/proxy/db/autorouter_session_rollup.py b/litellm/proxy/db/autorouter_session_rollup.py index 3a61da164d0..0d812ee812a 100644 --- a/litellm/proxy/db/autorouter_session_rollup.py +++ b/litellm/proxy/db/autorouter_session_rollup.py @@ -26,6 +26,7 @@ from typing import TYPE_CHECKING, Final, NamedTuple from litellm._logging import verbose_proxy_logger from litellm.constants import INTERNAL_CALL_ORIGIN_METADATA_KEY from litellm.proxy._types import DB_RETRY_SAFE_ERROR_TYPES +from litellm.proxy.db.create_views import SupportsExecuteRaw if TYPE_CHECKING: from litellm.proxy._types import SpendLogsPayload @@ -75,6 +76,9 @@ SELECT COALESCE(SUM(total_tokens), 0)::bigint AS total_tokens, COALESCE(SUM(spend), 0)::float8 AS spend, COALESCE(SUM(saved_spend), 0)::float8 AS saved_spend, + COALESCE(SUM(savings_estimated_turns), 0)::int AS savings_estimated_turns, + COALESCE(SUM(savings_estimated_actual_spend), 0)::float8 AS savings_estimated_actual_spend, + COALESCE(SUM(savings_estimated_saved_spend), 0)::float8 AS savings_estimated_saved_spend, COALESCE(SUM(classifier_cost), 0)::float8 AS classifier_cost, COALESCE(SUM(classifier_cost_recorded_turns), 0)::int AS classifier_cost_recorded_turns, COALESCE(SUM(EXTRACT(EPOCH FROM (last_turn_at - first_turn_at))), 0)::float8 AS session_seconds @@ -104,6 +108,9 @@ class AutoRouterTurnTransaction: cache_touched: bool tier: str | None = None baseline_model: str | None = None + savings_estimated_turns: int = 0 + savings_estimated_actual_spend: float = 0.0 + savings_estimated_saved_spend: float = 0.0 class TurnCacheFacts(NamedTuple): @@ -215,13 +222,18 @@ def build_autorouter_turn_transaction( turn_at: Final = _turn_time_utc(str(payload.get("startTime") or "")) if turn_at is None: return None - from litellm.proxy.spend_tracking.savings import classifier_cost_from_decision + from litellm.proxy.spend_tracking.savings import ( + classifier_cost_from_decision, + recorded_estimated_autorouter_savings, + ) usage_object_raw: Final = metadata.get("usage_object") cache: Final = turn_cache_facts(usage_object_raw if isinstance(usage_object_raw, Mapping) else None) tier_raw: Final = routing_decision.get("tier") baseline_raw: Final = routing_decision.get("savings_baseline_model") classifier_cost: Final = classifier_cost_from_decision(routing_decision) + actual_spend: Final = float(payload.get("spend") or 0.0) + (classifier_cost or 0.0) + estimated_savings: Final = recorded_estimated_autorouter_savings(metadata) return AutoRouterTurnTransaction( api_key=api_key, session_id=bounded_session_id(session_id), @@ -232,13 +244,16 @@ def build_autorouter_turn_transaction( model=model, turn_at=turn_at, total_tokens=int(payload.get("prompt_tokens") or 0) + int(payload.get("completion_tokens") or 0), - spend=float(payload.get("spend") or 0.0) + (classifier_cost or 0.0), + spend=actual_spend, saved_spend=saved_spend, classifier_cost=classifier_cost or 0.0, covered=cache.covered, cache_hit=cache.read_tokens > 0, cache_ttl_seconds=cache.write_ttl_seconds, cache_touched=cache.touched, + savings_estimated_turns=int(estimated_savings is not None), + savings_estimated_actual_spend=actual_spend if estimated_savings is not None else 0.0, + savings_estimated_saved_spend=estimated_savings if estimated_savings is not None else 0.0, ) @@ -263,6 +278,10 @@ _BASELINE: Final = f"{_p('baseline_model')}::text" _BASELINE_DELTA: Final = ( f"(CASE WHEN {_BASELINE} IS NULL THEN '{{}}'::jsonb ELSE jsonb_build_object({_BASELINE}, 1) END)" ) +_ESTIMATED_BASELINE: Final = f"{_p('savings_estimated_turns')}::int = 1 AND {_BASELINE} IS NOT NULL" +_ESTIMATED_BASELINE_DELTA: Final = ( + f"(CASE WHEN {_ESTIMATED_BASELINE} THEN jsonb_build_object({_BASELINE}, 1) ELSE '{{}}'::jsonb END)" +) _IN_ORDER: Final = f"{_TURN_AT}::timestamp >= t.last_turn_at" _SAME: Final = f"{_IN_ORDER} AND t.last_model = {_MODEL}" @@ -281,7 +300,8 @@ INSERT INTO "LiteLLM_AutoRouterSession" AS t ( same_model_turns, same_model_hits, first_visit_turns, first_visit_hits, return_turns, return_hits, return_expired_misses, return_within_ttl_misses, ttl_5m_turns, ttl_1h_turns, total_tokens, spend, saved_spend, classifier_cost, classifier_cost_recorded_turns, tier_turns, - baseline_models + baseline_models, savings_estimated_turns, savings_estimated_actual_spend, savings_estimated_saved_spend, + savings_estimated_baseline_models ) VALUES ( {_p("api_key")}, {_p("session_id")}, {_p("router_name")}, {_p("router_type")}, {_TURN_AT}::timestamp, {_TURN_AT}::timestamp, @@ -292,13 +312,18 @@ VALUES ( (CASE WHEN {_CACHE_TTL}::int = {CACHE_TTL_5M_SECONDS} THEN 1 ELSE 0 END), (CASE WHEN {_CACHE_TTL}::int = {CACHE_TTL_1H_SECONDS} THEN 1 ELSE 0 END), {_p("total_tokens")}::bigint, {_p("spend")}::float8, {_p("saved_spend")}::float8, - {_p("classifier_cost")}::float8, 1, {_TIER_DELTA}, {_BASELINE_DELTA} + {_p("classifier_cost")}::float8, 1, {_TIER_DELTA}, {_BASELINE_DELTA}, + {_p("savings_estimated_turns")}::int, {_p("savings_estimated_actual_spend")}::float8, + {_p("savings_estimated_saved_spend")}::float8, {_ESTIMATED_BASELINE_DELTA} ) ON CONFLICT (api_key, session_id, router_name) DO UPDATE SET turns = t.turns + 1, total_tokens = t.total_tokens + EXCLUDED.total_tokens, spend = t.spend + EXCLUDED.spend, saved_spend = t.saved_spend + EXCLUDED.saved_spend, + savings_estimated_turns = t.savings_estimated_turns + EXCLUDED.savings_estimated_turns, + savings_estimated_actual_spend = t.savings_estimated_actual_spend + EXCLUDED.savings_estimated_actual_spend, + savings_estimated_saved_spend = t.savings_estimated_saved_spend + EXCLUDED.savings_estimated_saved_spend, classifier_cost = t.classifier_cost + EXCLUDED.classifier_cost, classifier_cost_recorded_turns = t.classifier_cost_recorded_turns + 1, covered_turns = t.covered_turns + EXCLUDED.covered_turns, @@ -331,6 +356,10 @@ ON CONFLICT (api_key, session_id, router_name) DO UPDATE SET baseline_models = (CASE WHEN {_BASELINE} IS NOT NULL THEN t.baseline_models || jsonb_build_object({_BASELINE}, COALESCE((t.baseline_models ->> {_BASELINE})::int, 0) + 1) ELSE t.baseline_models END), + savings_estimated_baseline_models = (CASE WHEN {_ESTIMATED_BASELINE} + THEN t.savings_estimated_baseline_models || jsonb_build_object( + {_BASELINE}, COALESCE((t.savings_estimated_baseline_models ->> {_BASELINE})::int, 0) + 1) + ELSE t.savings_estimated_baseline_models END), first_turn_at = LEAST(t.first_turn_at, EXCLUDED.first_turn_at), last_turn_at = GREATEST(t.last_turn_at, EXCLUDED.last_turn_at) """ @@ -348,6 +377,10 @@ def _upsert_params(transaction: AutoRouterTurnTransaction) -> tuple[str | float return tuple(_as_sql_param(getattr(transaction, name)) for name in _UPSERT_PARAM_FIELDS) +async def write_autorouter_turn(db: SupportsExecuteRaw, transaction: AutoRouterTurnTransaction) -> None: + await db.execute_raw(UPSERT_AUTOROUTER_SESSION_SQL, *_upsert_params(transaction)) + + async def _upsert_turn_with_retry( prisma_client: PrismaClient, transaction: AutoRouterTurnTransaction, @@ -355,7 +388,7 @@ async def _upsert_turn_with_retry( ) -> None: for attempt in range(n_retry_times + 1): try: - await prisma_client.db.execute_raw(UPSERT_AUTOROUTER_SESSION_SQL, *_upsert_params(transaction)) + await write_autorouter_turn(prisma_client.db, transaction) except DB_RETRY_SAFE_ERROR_TYPES: if attempt >= n_retry_times: raise diff --git a/litellm/proxy/db/baseline_accounting.py b/litellm/proxy/db/baseline_accounting.py new file mode 100644 index 00000000000..8622cb9e481 --- /dev/null +++ b/litellm/proxy/db/baseline_accounting.py @@ -0,0 +1,640 @@ +from __future__ import annotations + +import asyncio +import json +from collections.abc import AsyncIterator, Callable, Sequence +from datetime import datetime, timedelta +from functools import reduce +from itertools import groupby +from types import MappingProxyType +from typing import TYPE_CHECKING, Final, Literal, Protocol, cast + +from pydantic import BaseModel, ConfigDict, Field, TypeAdapter, model_validator +from typing_extensions import Self + +from litellm._logging import verbose_proxy_logger +from litellm.proxy.db.autorouter_session_rollup import ( + AutoRouterTurnTransaction, + write_autorouter_turn, +) +from litellm.proxy.db.create_views import SupportsRawQueries +from litellm.proxy.db.daily_spend_bulk_upsert import ( + DAILY_SPEND_TABLES, + DailySpendEntity, + SpendRow, + build_bulk_upsert, + merge_by_conflict_key, +) +from litellm.proxy.db.routing_prisma_wrapper import writer_wrapper +from litellm.proxy.spend_tracking.baseline_accounting import ( + BaselineEstimate, + BaselineHistory, + BaselineObservation, + advance_baseline_history, +) +from litellm.proxy.spend_tracking.savings import BaselineCosts, BaselineCostSnapshot, price_baseline_comparison + +if TYPE_CHECKING: + from litellm.proxy.utils import PrismaClient + + +class DailyBaselineTarget(BaseModel): + model_config = ConfigDict(extra="forbid", frozen=True, strict=True) + + entity: DailySpendEntity + entity_id: str | None + + +class DailyBaselineAttribution(BaseModel): + model_config = ConfigDict(extra="forbid", frozen=True, strict=True) + + date: str + api_key: str + model: str | None = None + custom_llm_provider: str | None = None + model_group: str | None = None + endpoint: str | None = None + mcp_namespaced_tool_name: str | None = None + targets: tuple[DailyBaselineTarget, ...] = () + + def adjustment(self, target: DailyBaselineTarget, savings_delta: float, request_id: str) -> SpendRow: + table: Final = DAILY_SPEND_TABLES[target.entity] + return MappingProxyType( + { + "date": self.date, + "api_key": self.api_key, + "model": self.model, + "custom_llm_provider": self.custom_llm_provider, + "model_group": self.model_group, + "endpoint": self.endpoint, + "mcp_namespaced_tool_name": self.mcp_namespaced_tool_name, + table.entity_id_column: target.entity_id, + "request_id": request_id, + "autorouter_savings_spend": savings_delta, + } + ) + + +class BaselineAccountingRecord(BaseModel): + model_config = ConfigDict(extra="forbid", frozen=True, strict=True) + + scope: str = Field(pattern=r"^autorouter-baseline:v3:[a-f0-9]{64}$") + api_key: str = Field(min_length=1) + session_id: str = Field(min_length=1, max_length=256) + router_name: str = Field(min_length=1) + baseline_model: str = Field(min_length=1) + observation: BaselineObservation + pricing: BaselineCostSnapshot + turn: AutoRouterTurnTransaction | None + daily: DailyBaselineAttribution | None + + @model_validator(mode="after") + def consistent_turn(self) -> Self: + turn: Final = self.turn + if turn is not None and ( + (turn.api_key, turn.session_id, turn.router_name, turn.baseline_model) + != (self.api_key, self.session_id, self.router_name, self.baseline_model) + or turn.spend != self.pricing.actual_spend + self.pricing.classifier_cost + or any( + ( + turn.saved_spend, + turn.savings_estimated_turns, + turn.savings_estimated_actual_spend, + turn.savings_estimated_saved_spend, + ) + ) + ): + raise ValueError("Baseline observation must own an unestimated turn with matching scope and actual cost") + return self + + +class BaselinePublication(BaseModel): + model_config = ConfigDict(extra="forbid", frozen=True, strict=True) + + version: Literal[3] = 3 + comparison_id: str + comparison_started_at: float + status: Literal["estimated", "unknown"] + reason: str + provenance: Literal["observed_identical", "modeled"] | None = None + actual_spend: float | None = None + baseline_spend: float | None = None + input_tokens: int | None = None + cache_read_input_tokens: int | None = None + cache_creation_5m_input_tokens: int | None = None + cache_creation_1h_input_tokens: int | None = None + + @property + def costs(self) -> BaselineCosts | None: + if self.status != "estimated" or self.actual_spend is None or self.baseline_spend is None: + return None + return BaselineCosts(self.actual_spend, self.baseline_spend) + + +def baseline_publication( + record: BaselineAccountingRecord, estimate: BaselineEstimate, first_at: float +) -> BaselinePublication: + costs: Final = price_baseline_comparison(record.pricing, estimate.usage, estimate.provenance) + details: Final = estimate.usage.prompt_tokens_details if estimate.usage is not None else None + writes: Final = details.cache_creation_token_details if details is not None else None + return BaselinePublication( + comparison_id=record.scope, + comparison_started_at=first_at, + status="estimated" if costs is not None else "unknown", + reason=estimate.reason if costs is not None or estimate.usage is None else "pricing_unavailable", + provenance=estimate.provenance if costs is not None else None, + actual_spend=costs.actual if costs is not None else None, + baseline_spend=costs.baseline if costs is not None else None, + input_tokens=details.text_tokens if details is not None else None, + cache_read_input_tokens=details.cached_tokens if details is not None else None, + cache_creation_5m_input_tokens=writes.ephemeral_5m_input_tokens if writes is not None else None, + cache_creation_1h_input_tokens=writes.ephemeral_1h_input_tokens if writes is not None else None, + ) + + +class _Comparison(BaseModel): + revision: int + published_revision: int + initial_equivalent: bool + retired: bool + history: str | None + + +class _StoredRecord(BaseModel): + data: str + publication: str | None + conflicted: bool + started_at: float + + +class _Change(BaseModel): + request_id: str + publication: BaselinePublication + api_key: str + session_id: str + router_name: str + baseline_model: str + covered_delta: int + actual_delta: float + savings_delta: float + daily: DailyBaselineAttribution | None + + +class _TransactionManager(Protocol): + async def __aenter__(self) -> SupportsRawQueries: ... + + async def __aexit__(self, exc_type: object, exc_value: object, traceback: object) -> bool | None: ... + + +class _TransactionalDatabase(Protocol): + def tx(self, *, timeout: timedelta) -> _TransactionManager: ... + + +_COMPARISONS: Final = TypeAdapter(tuple[_Comparison, ...]) +_RECORDS: Final = TypeAdapter(tuple[_StoredRecord, ...]) +_HISTORY: Final = TypeAdapter(BaselineHistory) +_PAGE_TIMESTAMPS: Final = 128 +_TRANSACTION_TIMEOUT: Final = timedelta(seconds=10) + +_CREATE_COMPARISON: Final = """ +INSERT INTO "LiteLLM_AutoRouterBaselineComparison" + (scope, api_key, session_id, router_name, initial_equivalent) +VALUES ($1, $2, $3, $4, NOT EXISTS ( + SELECT 1 FROM "LiteLLM_AutoRouterSession" + WHERE api_key = $2 AND session_id = $3 AND router_name = $4 +)) ON CONFLICT (scope) DO NOTHING +""" +_LOCK_COMPARISON: Final = """ +SELECT revision, published_revision, initial_equivalent, retired, history +FROM "LiteLLM_AutoRouterBaselineComparison" WHERE scope = $1 FOR UPDATE +""" +_INSERT_RECORD: Final = """ +INSERT INTO "LiteLLM_AutoRouterBaselineObservation" + (request_id, scope, started_at, revision, data) +VALUES ($1, $2, $3::float8, $4::bigint, $5) +ON CONFLICT (request_id) DO NOTHING +""" +_MARK_CONFLICT: Final = """ +UPDATE "LiteLLM_AutoRouterBaselineObservation" +SET conflicted = TRUE, revision = $4::bigint +WHERE request_id = $1 AND scope = $2 AND data <> $3 AND NOT conflicted +""" +_READ_PAGE: Final = """ +WITH times AS ( + SELECT DISTINCT started_at FROM "LiteLLM_AutoRouterBaselineObservation" + WHERE scope = $1 AND revision > $2::bigint + AND ($3::float8 IS NULL OR started_at > $3::float8) + AND ($5::float8 IS NULL OR ( + started_at >= $5::float8 AND publication::jsonb->>'status' = 'estimated' + )) + ORDER BY started_at LIMIT $4::int +) +SELECT data, publication, conflicted, started_at +FROM "LiteLLM_AutoRouterBaselineObservation" +WHERE scope = $1 AND revision > $2::bigint + AND started_at IN (SELECT started_at FROM times) + AND ($5::float8 IS NULL OR publication::jsonb->>'status' = 'estimated') +ORDER BY started_at, request_id +""" +_UPDATE_LOGS: Final = """ +WITH changes AS ( + SELECT request_id, publication::jsonb AS publication + FROM jsonb_to_recordset($1::jsonb) AS x(request_id text, publication jsonb) +) +UPDATE "LiteLLM_SpendLogs" AS logs +SET metadata = (COALESCE(logs.metadata::jsonb, '{}'::jsonb) - 'autorouter_baseline_observation') || jsonb_build_object( + 'autorouter_savings_estimate', changes.publication, + 'autorouter_savings', CASE WHEN changes.publication->>'status' = 'estimated' THEN + (changes.publication->>'baseline_spend')::float8 - (changes.publication->>'actual_spend')::float8 + ELSE NULL END +) +FROM changes WHERE logs.request_id = changes.request_id +""" +_UPDATE_PUBLICATIONS: Final = """ +UPDATE "LiteLLM_AutoRouterBaselineObservation" AS observations +SET publication = x.publication::text +FROM jsonb_to_recordset($1::jsonb) AS x(request_id text, publication jsonb) +WHERE observations.request_id = x.request_id +""" +_UPDATE_SESSIONS: Final = """ +WITH changes AS ( + SELECT * FROM jsonb_to_recordset($1::jsonb) AS x( + api_key text, session_id text, router_name text, baseline_model text, + covered_delta int, actual_delta float8, savings_delta float8 + ) +), totals AS ( + SELECT api_key, session_id, router_name, SUM(covered_delta)::int AS covered_delta, + SUM(actual_delta) AS actual_delta, SUM(savings_delta) AS savings_delta + FROM changes GROUP BY api_key, session_id, router_name +), models AS ( + SELECT api_key, session_id, router_name, jsonb_object_agg(baseline_model, delta) AS deltas + FROM ( + SELECT api_key, session_id, router_name, baseline_model, SUM(covered_delta)::int AS delta + FROM changes GROUP BY api_key, session_id, router_name, baseline_model + ) grouped GROUP BY api_key, session_id, router_name +) +UPDATE "LiteLLM_AutoRouterSession" AS session +SET saved_spend = session.saved_spend + totals.savings_delta, + savings_estimated_turns = session.savings_estimated_turns + totals.covered_delta, + savings_estimated_actual_spend = session.savings_estimated_actual_spend + totals.actual_delta, + savings_estimated_saved_spend = session.savings_estimated_saved_spend + totals.savings_delta, + savings_estimated_baseline_models = ( + SELECT COALESCE(jsonb_object_agg(key, value), '{}'::jsonb) FROM ( + SELECT key, SUM(value::int)::int AS value FROM ( + SELECT * FROM jsonb_each_text(session.savings_estimated_baseline_models) + UNION ALL SELECT * FROM jsonb_each_text(models.deltas) + ) combined GROUP BY key HAVING SUM(value::int) > 0 + ) counts + ) +FROM totals JOIN models USING (api_key, session_id, router_name) +WHERE session.api_key = totals.api_key AND session.session_id = totals.session_id + AND session.router_name = totals.router_name +""" + + +def _primary_transaction(client: PrismaClient) -> _TransactionManager: + primary: Final = cast(_TransactionalDatabase, writer_wrapper(client.db)) + return primary.tx(timeout=_TRANSACTION_TIMEOUT) + + +def _serialized(model: BaseModel) -> str: + return json.dumps(model.model_dump(mode="json"), sort_keys=True, separators=(",", ":")) + + +def _change(record: BaselineAccountingRecord, old: BaselinePublication | None, new: BaselinePublication) -> _Change: + previous: Final = old.costs if old is not None else None + current: Final = new.costs + return _Change( + request_id=record.observation.request_id, + publication=new, + api_key=record.api_key, + session_id=record.session_id, + router_name=record.router_name, + baseline_model=record.baseline_model, + covered_delta=int(current is not None) - int(previous is not None), + actual_delta=(current.actual if current is not None else 0.0) + - (previous.actual if previous is not None else 0.0), + savings_delta=(current.savings if current is not None else 0.0) + - (previous.savings if previous is not None else 0.0), + daily=record.daily, + ) + + +def _project_group( + previous: tuple[BaselineHistory, tuple[_Change, ...]], stored: Sequence[_StoredRecord] +) -> tuple[BaselineHistory, tuple[_Change, ...]]: + history, prior_changes = previous + records: Final = tuple(BaselineAccountingRecord.model_validate_json(item.data) for item in stored) + observations: Final = tuple( + record.observation.model_copy( + update=MappingProxyType( + {"outcome": "uncertain", "baseline_equivalent": False, "reason": "conflicting_observation"} + ) + ) + if row.conflicted + else record.observation + for record, row in zip(records, stored) + ) + advanced, estimates = advance_baseline_history(history, observations) + publications: Final = tuple( + baseline_publication( + record, estimate, advanced.first_at if advanced.first_at is not None else observations[0].started_at + ) + for record, estimate in zip(records, estimates) + ) + changes: Final = tuple( + _change(record, old, publication) + for record, row, publication in zip(records, stored, publications) + for old in (BaselinePublication.model_validate_json(row.publication) if row.publication else None,) + if publication != old + ) + return advanced, (*prior_changes, *changes) + + +async def _publish(db: SupportsRawQueries, changes: Sequence[_Change]) -> None: + if not changes: + return + serialized: Final = json.dumps(tuple(change.model_dump(mode="json") for change in changes), separators=(",", ":")) + await db.execute_raw(_UPDATE_LOGS, serialized) + await db.execute_raw(_UPDATE_SESSIONS, serialized) + for entity, table in DAILY_SPEND_TABLES.items(): + if adjustments := tuple( + change.daily.adjustment(target, change.savings_delta, change.request_id) + for change in changes + if change.daily is not None and change.savings_delta != 0 + for target in change.daily.targets + if target.entity == entity + ): + statement, values = build_bulk_upsert(table, merge_by_conflict_key(table, adjustments)) + await db.execute_raw(statement, *values) + await db.execute_raw(_UPDATE_PUBLICATIONS, serialized) + + +class BaselineAccountingStore: + def __init__(self, transaction: Callable[[], _TransactionManager]) -> None: + self.transaction: Final = transaction + + @classmethod + def for_client(cls, client: PrismaClient) -> BaselineAccountingStore: + def transaction() -> _TransactionManager: + return _primary_transaction(client) + + return cls(transaction) + + async def append( + self, record: BaselineAccountingRecord + ) -> Literal["recorded", "retired", "conflict", "unavailable"]: + try: + async with self.transaction() as db: + await db.execute_raw("SET LOCAL statement_timeout = 5000") + await db.execute_raw("SET LOCAL lock_timeout = 1000") + await db.execute_raw( + _CREATE_COMPARISON, record.scope, record.api_key, record.session_id, record.router_name + ) + rows: Final = _COMPARISONS.validate_python(tuple(await db.query_raw(_LOCK_COMPARISON, record.scope))) + if not rows: + return "unavailable" + revision: Final = rows[0].revision + 1 + data: Final = _serialized(record) + inserted: Final = await db.execute_raw( + _INSERT_RECORD, + record.observation.request_id, + record.scope, + record.observation.started_at, + revision, + data, + ) + if inserted and record.turn is not None: + await write_autorouter_turn(db, record.turn) + conflicted: Final = ( + 0 + if inserted + else await db.execute_raw( + _MARK_CONFLICT, record.observation.request_id, record.scope, data, revision + ) + ) + canonical: Final = ( + _RECORDS.validate_python( + tuple( + await db.query_raw( + 'SELECT data, publication, conflicted, started_at FROM "LiteLLM_AutoRouterBaselineObservation" ' + "WHERE request_id=$1 AND scope=$2", + record.observation.request_id, + record.scope, + ) + ) + ) + if not inserted + else () + ) + if not inserted and not canonical: + return "conflict" + if rows[0].retired: + await _publish( + db, + ( + _change( + BaselineAccountingRecord.model_validate_json(canonical[0].data) + if canonical + else record, + BaselinePublication.model_validate_json(canonical[0].publication) + if canonical and canonical[0].publication is not None + else None, + BaselinePublication( + comparison_id=record.scope, + comparison_started_at=canonical[0].started_at + if canonical + else record.observation.started_at, + status="unknown", + reason="comparison_retired", + ), + ), + ), + ) + return "retired" + if inserted or conflicted: + await self._withdraw( + db, record.scope, canonical[0].started_at if canonical else record.observation.started_at + ) + await db.execute_raw( + 'UPDATE "LiteLLM_AutoRouterBaselineComparison" SET revision = $2::bigint, ' + "updated_at = CURRENT_TIMESTAMP, attempted_at = NULL WHERE scope = $1", + record.scope, + revision, + ) + return "recorded" + except Exception: # noqa: BLE001 # accounting failure must not change inference or actual billing + verbose_proxy_logger.warning("Auto-router baseline observation could not be persisted") + return "unavailable" + + async def _pages( + self, db: SupportsRawQueries, scope: str, after_revision: int, withdraw_from: float | None = None + ) -> AsyncIterator[tuple[_StoredRecord, ...]]: + cursor: float | None = None + while page := _RECORDS.validate_python( + tuple(await db.query_raw(_READ_PAGE, scope, after_revision, cursor, _PAGE_TIMESTAMPS, withdraw_from)) + ): + yield page + cursor = page[-1].started_at # rebind-ok: keyset pagination advances after each complete timestamp group + + async def _withdraw(self, db: SupportsRawQueries, scope: str, started_at: float) -> None: + async for page in self._pages(db, scope, 0, withdraw_from=started_at): + await _publish( + db, + tuple( + _change( + BaselineAccountingRecord.model_validate_json(row.data), + previous, + BaselinePublication( + comparison_id=scope, + comparison_started_at=min(previous.comparison_started_at, started_at), + status="unknown", + reason="pending_projection", + ), + ) + for row in page + if row.publication is not None + for previous in (BaselinePublication.model_validate_json(row.publication),) + ), + ) + + async def retire_before(self, cutoff: datetime, batch_size: int, timeout_ms: int) -> None: + async with self.transaction() as db: + await db.execute_raw(f"SET LOCAL statement_timeout = {max(1, timeout_ms)}") + await db.execute_raw(f"SET LOCAL lock_timeout = {max(1, timeout_ms)}") + await db.execute_raw( + 'WITH expired AS (SELECT scope FROM "LiteLLM_AutoRouterBaselineComparison" ' + "WHERE NOT retired AND updated_at < $1::timestamptz ORDER BY updated_at " + "LIMIT $2::int FOR UPDATE SKIP LOCKED) " + 'UPDATE "LiteLLM_AutoRouterBaselineComparison" AS comparison ' + "SET retired=TRUE, history=NULL FROM expired WHERE comparison.scope=expired.scope", + cutoff, + batch_size, + ) + await db.execute_raw( + 'DELETE FROM "LiteLLM_AutoRouterBaselineObservation" WHERE request_id IN (' + 'SELECT event.request_id FROM "LiteLLM_AutoRouterBaselineObservation" AS event ' + 'JOIN "LiteLLM_AutoRouterBaselineComparison" AS comparison USING (scope) ' + "WHERE comparison.retired AND comparison.updated_at < $1::timestamptz " + "LIMIT $2::int)", + cutoff, + batch_size, + ) + + async def project(self, scope: str) -> Literal["published", "unchanged", "unavailable"]: + try: + async with self.transaction() as db: + await db.execute_raw("SET LOCAL statement_timeout = 5000") + await db.execute_raw("SET LOCAL lock_timeout = 1000") + rows: Final = _COMPARISONS.validate_python(tuple(await db.query_raw(_LOCK_COMPARISON, scope))) + if not rows or rows[0].retired or rows[0].revision == rows[0].published_revision: + return "unchanged" + missing_log: Final = await db.query_raw( + 'SELECT 1 FROM "LiteLLM_AutoRouterBaselineObservation" AS observation ' + 'WHERE scope=$1 AND publication IS NULL AND NOT EXISTS (SELECT 1 FROM "LiteLLM_SpendLogs" AS log ' + "WHERE log.request_id=observation.request_id) LIMIT 1", + scope, + ) + if missing_log: + return "unavailable" + state: Final = rows[0] + checkpoint: Final = ( + _HISTORY.validate_json(state.history) + if state.history is not None + else BaselineHistory(equivalent=state.initial_equivalent) + ) + changed: Final = await db.query_raw( + 'SELECT 1 FROM "LiteLLM_AutoRouterBaselineObservation" ' + "WHERE scope = $1 AND revision > $2::bigint AND started_at <= $3::float8 LIMIT 1", + scope, + state.published_revision, + checkpoint.last_at, + ) + history = BaselineHistory(equivalent=state.initial_equivalent) if changed else checkpoint + async for page in self._pages(db, scope, 0 if changed else state.published_revision): + history, updates = reduce( + _project_group, + (tuple(group) for _, group in groupby(page, key=lambda item: item.started_at)), + (history, ()), + ) + await _publish(db, updates) + await db.execute_raw( + 'UPDATE "LiteLLM_AutoRouterBaselineComparison" ' + "SET published_revision = revision, history = $2 WHERE scope = $1", + scope, + _HISTORY.dump_json(history).decode(), + ) + return "published" + except Exception: # noqa: BLE001 # rollback leaves the durable revision dirty for a later flush + verbose_proxy_logger.warning("Auto-router baseline projection remains pending") + return "unavailable" + + +class _Scope(BaseModel): + scope: str + + +_SCOPES: Final = TypeAdapter(tuple[_Scope, ...]) +_CLAIM_DIRTY: Final = """ +WITH candidates AS ( + SELECT scope FROM "LiteLLM_AutoRouterBaselineComparison" + WHERE NOT retired AND revision <> published_revision + AND (attempted_at IS NULL OR attempted_at < CURRENT_TIMESTAMP - INTERVAL '30 seconds') + ORDER BY attempted_at NULLS FIRST, updated_at, scope LIMIT 32 FOR UPDATE SKIP LOCKED +) +UPDATE "LiteLLM_AutoRouterBaselineComparison" AS comparison +SET attempted_at = CURRENT_TIMESTAMP FROM candidates +WHERE comparison.scope = candidates.scope RETURNING comparison.scope +""" + + +async def _flush_records( + store: BaselineAccountingStore, records: Sequence[BaselineAccountingRecord] +) -> tuple[BaselineAccountingRecord, ...]: + slots: Final = asyncio.Semaphore(4) + + async def append(record: BaselineAccountingRecord) -> bool: + async with slots: + return await store.append(record) == "unavailable" + + failed: Final = await asyncio.gather(*(append(record) for record in records)) + return tuple(record for record, retry in zip(records, failed) if retry) + + +async def flush_baseline_accounting(client: PrismaClient) -> None: + from litellm.proxy.utils import request_spend_log_flush + + store: Final = BaselineAccountingStore.for_client(client) + async with client.baseline_accounting_lock: + batch: Final = tuple(client.baseline_accounting_transactions[:32]) + client.baseline_accounting_transactions = client.baseline_accounting_transactions[ + 32: + ] # rebind-ok: drain under lock + more_queued: Final = bool(client.baseline_accounting_transactions) + try: + remaining: Final = await asyncio.wait_for(_flush_records(store, batch), timeout=5) + except (Exception, asyncio.CancelledError) as error: # noqa: BLE001 # unknown acknowledgements can be replayed safely + async with client.baseline_accounting_lock: + client.baseline_accounting_transactions.extend(batch) + if isinstance(error, asyncio.CancelledError): + raise + return + async with client.baseline_accounting_lock: + client.baseline_accounting_transactions.extend(remaining) + if more_queued and len(remaining) < len(batch): + request_spend_log_flush(client) + try: + async with store.transaction() as db: + await db.execute_raw("SET LOCAL statement_timeout = 1000") + scopes: Final = _SCOPES.validate_python(tuple(await db.query_raw(_CLAIM_DIRTY))) + slots: Final = asyncio.Semaphore(4) + + async def project(item: _Scope) -> str: + async with slots: + return await store.project(item.scope) + + outcomes: Final = await asyncio.wait_for(asyncio.gather(*(project(item) for item in scopes)), timeout=5) + if len(scopes) == 32 and "published" in outcomes: + request_spend_log_flush(client) + except Exception: # noqa: BLE001 # durable dirty comparisons remain eligible after the retry interval + verbose_proxy_logger.warning("Auto-router baseline projection will retry on a later spend flush") diff --git a/litellm/proxy/db/daily_spend_bulk_upsert.py b/litellm/proxy/db/daily_spend_bulk_upsert.py index 108b0e884ba..eb130a5196f 100644 --- a/litellm/proxy/db/daily_spend_bulk_upsert.py +++ b/litellm/proxy/db/daily_spend_bulk_upsert.py @@ -14,6 +14,8 @@ from itertools import groupby from types import MappingProxyType from typing import Final, Literal +from pydantic import TypeAdapter + DailySpendEntity = Literal["user", "team", "org", "tag", "end_user", "agent"] SqlValue = str | int | float | None @@ -43,6 +45,36 @@ DAILY_SPEND_TABLES: Final[Mapping[DailySpendEntity, DailySpendTable]] = MappingP } ) +_ENTITY_INPUT_KEYS: Final[Mapping[DailySpendEntity, str]] = MappingProxyType( + { + "user": "user", + "team": "team_id", + "org": "organization_id", + "end_user": "end_user", + "agent": "agent_id", + "tag": "request_tags", + } +) +_TAGS: Final = TypeAdapter(tuple[str, ...]) + + +def daily_spend_entity_ids(payload: Mapping[str, object], entity: DailySpendEntity) -> tuple[str | None, ...]: + key: Final = _ENTITY_INPUT_KEYS[entity] + if key not in payload: + return () + value: Final = payload[key] + if entity == "tag": + if value is None: + return () + tags: Final = _TAGS.validate_json(value) if isinstance(value, str) else _TAGS.validate_python(value) + return tuple(dict.fromkeys(tags)) + if value is None: + return (None,) if entity == "user" else () + if not isinstance(value, str) or (entity == "end_user" and not value): + return () + return (value,) + + # The unique constraint's columns after the entity id, in constraint order. A NULL can # never match itself in a unique index, so every one of these is normalized to '': the # conflict target has to be NULL-free or the row is re-inserted on every single flush. diff --git a/litellm/proxy/db/db_spend_update_writer.py b/litellm/proxy/db/db_spend_update_writer.py index 165486a4669..ba92c1e4f65 100644 --- a/litellm/proxy/db/db_spend_update_writer.py +++ b/litellm/proxy/db/db_spend_update_writer.py @@ -18,6 +18,7 @@ from types import MappingProxyType from typing import TYPE_CHECKING, Any, Final, Literal, Protocol, TypeVar, cast, overload from urllib.parse import quote, unquote +from pydantic import TypeAdapter from typing_extensions import LiteralString, ReadOnly, TypedDict import litellm @@ -51,6 +52,7 @@ from litellm.proxy.common_utils.user_api_key_cache import project_cache_key from litellm.proxy.db.daily_spend_bulk_upsert import ( DAILY_SPEND_TABLES, build_bulk_upsert, + daily_spend_entity_ids, merge_by_conflict_key, ) from litellm.proxy.db.db_transaction_queue.daily_spend_update_queue import ( @@ -82,6 +84,8 @@ from litellm.repositories.prisma_protocols import BatchTable from litellm.types.utils import CallTypes if TYPE_CHECKING: + from litellm.proxy.db.autorouter_session_rollup import AutoRouterTurnTransaction + from litellm.proxy.db.baseline_accounting import DailyBaselineAttribution from litellm.proxy.utils import PrismaClient, ProxyLogging else: PrismaClient = Any @@ -89,6 +93,7 @@ else: RESPONSES_SESSION_CALL_TYPES: Final = frozenset({CallTypes.responses.value, CallTypes.aresponses.value}) +_SPEND_METADATA_ADAPTER: Final = TypeAdapter(Mapping[str, object]) def _org_member_transaction_key(org_id: str, user_id: str) -> str: @@ -579,25 +584,31 @@ class DBSpendUpdateWriter: metadata_raw: Final = payload.get("metadata") if not metadata_raw: return - metadata: Final = json.loads(metadata_raw) - if not isinstance(metadata, dict) or not metadata.get("routing_decision"): + metadata: Final = _SPEND_METADATA_ADAPTER.validate_json(metadata_raw) + routing_decision: Final = metadata.get("routing_decision") + if not isinstance(routing_decision, Mapping) or not routing_decision: return from litellm.proxy.db.autorouter_session_rollup import ( build_autorouter_turn_transaction, ) usage_object_raw: Final = metadata.get("usage_object") + cost_breakdown: Final = metadata.get("cost_breakdown") + savings_estimate: Final = metadata.get("autorouter_savings_estimate") savings_spend: Final = compute_savings_spend( model=payload.get("model"), custom_llm_provider=payload.get("custom_llm_provider"), compression_saved_tokens=0, gateway_injected_cache=marks_gateway_injection(metadata, payload.get("model_id")), - routing_decision=metadata.get("routing_decision"), + routing_decision=routing_decision, usage_object=usage_object_raw if isinstance(usage_object_raw, dict) else None, model_id=payload.get("model_id"), llm_router=get_llm_router, - cost_breakdown=metadata.get("cost_breakdown"), + cost_breakdown=cost_breakdown if isinstance(cost_breakdown, Mapping) else None, recorded_autorouter_savings=metadata.get("autorouter_savings"), + recorded_autorouter_savings_estimate=( + savings_estimate if isinstance(savings_estimate, Mapping) else None + ), billed_at=payload.get("endTime"), ) transaction: Final = build_autorouter_turn_transaction( @@ -605,6 +616,11 @@ class DBSpendUpdateWriter: metadata=metadata, saved_spend=savings_spend.autorouter, ) + try: + if await self._enqueue_baseline_accounting(payload, metadata, transaction, prisma_client): + return + except Exception: # noqa: BLE001 # optional baseline capture must preserve the original actual-spend rollup + verbose_proxy_logger.warning("Auto-router baseline observation was unavailable; actual turn retained") if transaction is None: return async with prisma_client._autorouter_turn_transactions_lock: @@ -612,6 +628,95 @@ class DBSpendUpdateWriter: except Exception as e: # noqa: BLE001 # a metrics enqueue must never fail the spend write verbose_proxy_logger.debug("_enqueue_autorouter_turn_transaction error (non-blocking): %s", e) + async def _enqueue_baseline_accounting( + self, + payload: SpendLogsPayload, + metadata: Mapping[str, object], + turn: "AutoRouterTurnTransaction | None", + prisma_client: "PrismaClient", + ) -> bool: + from litellm.proxy.db.baseline_accounting import ( + BaselineAccountingRecord, + ) + from litellm.proxy.hooks.autorouter_baseline_cache import CapturedBaselineObservation + from litellm.proxy.spend_tracking.savings import baseline_cost_snapshot + + serialized: Final = metadata.get("autorouter_baseline_observation") + if not isinstance(serialized, str): + return False + captured: Final = CapturedBaselineObservation.model_validate_json(serialized) + if captured.api_key != payload["api_key"] or captured.session_id != payload["session_id"]: + return False + decision: Final = _SPEND_METADATA_ADAPTER.validate_python( + metadata.get("routing_decision") or MappingProxyType({}) + ) + breakdown: Final = _SPEND_METADATA_ADAPTER.validate_python( + metadata.get("cost_breakdown") or MappingProxyType({}) + ) + daily: Final = await self._baseline_daily_attribution(payload, prisma_client) + record: Final = BaselineAccountingRecord( + scope=captured.scope, + api_key=captured.api_key, + session_id=captured.session_id, + router_name=captured.router_name, + baseline_model=captured.baseline_model, + observation=captured.observation.model_copy(update=MappingProxyType({"request_id": payload["request_id"]})), + pricing=baseline_cost_snapshot(captured.model, captured.prices, payload["spend"], breakdown, decision), + turn=turn, + daily=daily, + ) + async with prisma_client.baseline_accounting_lock: + if len(prisma_client.baseline_accounting_transactions) >= 10000: + verbose_proxy_logger.warning("Auto-router baseline observation queue is full") + return False + prisma_client.baseline_accounting_transactions.append(record) + from litellm.proxy.utils import request_spend_log_flush + + request_spend_log_flush(prisma_client) + return True + + async def _baseline_daily_attribution( + self, + payload: SpendLogsPayload, + prisma_client: "PrismaClient", + ) -> "DailyBaselineAttribution | None": + from litellm.proxy.db.baseline_accounting import DailyBaselineAttribution, DailyBaselineTarget + + normalized: Final = cast(SpendLogsPayload, MappingProxyType({**payload, "end_user_id": payload["end_user"]})) + bases: Final = tuple( + zip( + DAILY_SPEND_TABLES, + await asyncio.gather( + *( + self._common_add_spend_log_transaction_to_daily_transaction( # pyright: ignore[reportUnknownMemberType] # legacy payload union; this caller supplies a validated spend payload + normalized, + prisma_client, + "request_tags" if entity == "tag" else entity, + ) + for entity in DAILY_SPEND_TABLES + ) + ), + ) + ) + base: Final = next((base for _, base in bases if base is not None), None) + if base is None: + return None + return DailyBaselineAttribution( + date=base["date"], + api_key=base["api_key"], + model=base.get("model"), + custom_llm_provider=base.get("custom_llm_provider"), + model_group=base.get("model_group"), + endpoint=base.get("endpoint"), + mcp_namespaced_tool_name=base.get("mcp_namespaced_tool_name"), + targets=tuple( + DailyBaselineTarget(entity=entity, entity_id=identity) + for entity, values in bases + if values is not None + for identity in daily_spend_entity_ids(payload, entity) + ), + ) + def _enqueue_tool_registry_upsert( self, kwargs: dict | None, @@ -2322,21 +2427,13 @@ class DBSpendUpdateWriter: prisma_client: PrismaClient, type: Literal["user", "team", "org", "request_tags", "end_user", "agent"] = "user", ) -> BaseDailySpendTransaction | None: - common_expected_keys: Final = ["startTime", "api_key"] - if type == "user": - expected_keys = ["user", *common_expected_keys] - elif type == "team": - expected_keys = ["team_id", *common_expected_keys] - elif type == "org": - expected_keys = ["organization_id", *common_expected_keys] - elif type == "request_tags": - expected_keys = ["request_tags", *common_expected_keys] - elif type == "end_user": - expected_keys = ["end_user_id", *common_expected_keys] - elif type == "agent": - expected_keys = ["agent_id", *common_expected_keys] - else: - raise ValueError(f"Invalid type: {type}") + entity: Final = "tag" if type == "request_tags" else type + identity_payload: Final = ( + MappingProxyType({**payload, "end_user": payload.get("end_user_id")}) if type == "end_user" else payload + ) + if not daily_spend_entity_ids(identity_payload, entity): + return None + expected_keys: Final = ("startTime", "api_key") if not all(key in payload for key in expected_keys): verbose_proxy_logger.debug( "Missing expected keys: %s, in payload, skipping from daily_user_spend_transactions", expected_keys @@ -2399,6 +2496,7 @@ class DBSpendUpdateWriter: usage_object=usage_obj, cost_breakdown=_metadata.get("cost_breakdown"), recorded_autorouter_savings=_metadata.get("autorouter_savings"), + recorded_autorouter_savings_estimate=_metadata.get("autorouter_savings_estimate"), billed_at=payload.get("endTime"), ) timed_duration_ms: Final = _timed_request_duration_ms(payload, request_status, is_internal_call) @@ -2597,14 +2695,10 @@ class DBSpendUpdateWriter: verbose_proxy_logger.debug("request_tags is None for request. Skipping incrementing tag spend.") return - request_tags: Sequence[str] = [] - if isinstance(payload["request_tags"], str): - request_tags = json.loads(payload["request_tags"]) - elif isinstance(payload["request_tags"], list): - request_tags = payload["request_tags"] - else: - raise ValueError(f"Invalid request_tags: {payload['request_tags']}") + request_tags: Final = daily_spend_entity_ids(payload, "tag") for tag in request_tags: + if tag is None: + continue endpoint_str = base_daily_transaction.get("endpoint") or "" daily_transaction_key = f"{tag}_{base_daily_transaction['date']}_{payload['api_key']}_{payload['model']}_{payload['custom_llm_provider']}_{endpoint_str}" daily_transaction = DailyTagSpendTransaction( diff --git a/litellm/proxy/db/db_transaction_queue/spend_log_cleanup.py b/litellm/proxy/db/db_transaction_queue/spend_log_cleanup.py index e97e9f6e683..b28a653c9aa 100644 --- a/litellm/proxy/db/db_transaction_queue/spend_log_cleanup.py +++ b/litellm/proxy/db/db_transaction_queue/spend_log_cleanup.py @@ -549,6 +549,17 @@ class SpendLogCleanup: Prune auto-router session rollup rows, which carry their own retention horizon. """ session_cutoff: Final = datetime.now(timezone.utc) - timedelta(seconds=float(retention_seconds)) + from litellm.proxy.db.baseline_accounting import BaselineAccountingStore + + if remaining_ms := self._remaining_timeout_ms(deadline)(): + try: + await BaselineAccountingStore.for_client(prisma_client).retire_before( + session_cutoff, + self.batch_size, + remaining_ms, + ) + except Exception: # noqa: BLE001 # retained observations are retried by the next cleanup job + verbose_proxy_logger.warning("Auto-router baseline retention remains pending") sessions_result: Final = await self._delete_old_autorouter_session_rows(prisma_client, session_cutoff, deadline) verbose_proxy_logger.info("Deleted %s expired auto-router session rollup rows", sessions_result.rows_deleted) return (sessions_result,) diff --git a/litellm/proxy/hooks/__init__.py b/litellm/proxy/hooks/__init__.py index a504c2ba102..0e78a0843cd 100644 --- a/litellm/proxy/hooks/__init__.py +++ b/litellm/proxy/hooks/__init__.py @@ -2,6 +2,7 @@ import os from typing import Final, Literal from . import * +from .autorouter_baseline_cache import AutoRouterBaselineCache from .cache_control_check import _PROXY_CacheControlCheck from .litellm_skills import SkillsInjectionHook from .max_budget_per_session_limiter import _PROXY_MaxBudgetPerSessionHandler @@ -25,6 +26,7 @@ PROXY_HOOKS: Final = { "max_budget_per_session_limiter": _PROXY_MaxBudgetPerSessionHandler, "sensitive_data_routing": _PROXY_SensitiveDataRoutingHandler, "prompt_cache_prediction": PromptCacheObserver, + "autorouter_baseline_cache": AutoRouterBaselineCache, } ## FEATURE FLAG HOOKS ## diff --git a/litellm/proxy/hooks/autorouter_baseline_cache.py b/litellm/proxy/hooks/autorouter_baseline_cache.py new file mode 100644 index 00000000000..8cea7d0e364 --- /dev/null +++ b/litellm/proxy/hooks/autorouter_baseline_cache.py @@ -0,0 +1,344 @@ +from __future__ import annotations + +import asyncio +import hashlib +import json +import time +from collections.abc import Callable, Mapping +from dataclasses import dataclass, replace +from datetime import datetime +from types import MappingProxyType +from typing import TYPE_CHECKING, Final + +import httpx +from pydantic import BaseModel, ConfigDict, Field, JsonValue, TypeAdapter + +from litellm._logging import verbose_proxy_logger +from litellm.constants import INTERNAL_CALL_ORIGIN_METADATA_KEY +from litellm.integrations.custom_logger import CustomLogger +from litellm.litellm_core_utils.core_helpers import ( + get_litellm_metadata_from_kwargs, # pyright: ignore[reportUnknownVariableType] # legacy metadata boundary validated below +) +from litellm.llms.anthropic.prompt_cache_prediction import ( + CountedPromptCachePlan, + NativePredictionTarget, + TokenCounter, + UnsupportedCachePlan, + UnsupportedPredictionTarget, + count_cache_plan, + count_prompt_tokens, + parse_cache_plan, + resolve_baseline_prediction_target, + supported_baseline_recipient, + supported_prediction_headers, +) +from litellm.proxy.spend_tracking.baseline_accounting import BaselineObservation +from litellm.proxy.spend_tracking.savings import ( + _effective_model_info, # pyright: ignore[reportPrivateUsage] # existing deployment-price owner + _proxy_llm_router, # pyright: ignore[reportPrivateUsage] # existing optional proxy-router owner +) +from litellm.types.router import BaselineRouteStamp +from litellm.types.utils import CallTypes, ModelInfo, Usage +from litellm.utils import get_prompt_cache_min_tokens + +if TYPE_CHECKING: + from litellm.litellm_core_utils.litellm_logging import Logging + from litellm.proxy.utils import PrismaClient + from litellm.router import Router + +_METADATA: Final = TypeAdapter(Mapping[str, object]) +_PRICES: Final[TypeAdapter[ModelInfo | None]] = TypeAdapter(ModelInfo | None) +_JSON_BODY: Final = TypeAdapter(dict[str, JsonValue]) +_COUNT_TIMEOUT: Final = 3.0 +_MAX_COUNTS: Final = 4096 + + +class CapturedBaselineObservation(BaseModel): + model_config = ConfigDict(extra="forbid", frozen=True, strict=True) + + scope: str + api_key: str + session_id: str + router_name: str + baseline_model: str + model: str + prices: ModelInfo | None + observation: BaselineObservation + + +@dataclass(frozen=True, slots=True) +class BaselineCacheContext: + collector: AutoRouterBaselineCache + capture: CapturedBaselineObservation + target: NativePredictionTarget | UnsupportedPredictionTarget + baseline_deployment_id: str + invalidated: str | None = None + + +class _Metadata(BaseModel): + model_config = ConfigDict(strict=True, arbitrary_types_allowed=True) + route: BaselineRouteStamp = Field(alias="_autorouter_baseline_route") + user_api_key_hash: str = Field(min_length=1) + session_id: str | None = None + + +class _WireEvent(BaseModel): + model_config = ConfigDict(strict=True, arbitrary_types_allowed=True) + httpx_response: httpx.Response + api_call_start_time: datetime + completion_start_time: datetime + custom_llm_provider: str + stream: bool = False + prompt_cache_response_complete: bool = False + + +class _ResponseUsage(BaseModel): + model_config = ConfigDict(strict=True, from_attributes=True) + usage: Usage | None = None + + +def _digest(value: object) -> str: + return hashlib.sha256(json.dumps(value, sort_keys=True, separators=(",", ":")).encode()).hexdigest() + + +class AutoRouterBaselineCache(CustomLogger): + def __init__( + self, + prisma_client: PrismaClient | None, + router: Callable[[], Router | None] = _proxy_llm_router, + token_counter: TokenCounter | None = None, + clock: Callable[[], float] = time.time, + ) -> None: + super().__init__() # pyright: ignore[reportUnknownMemberType] # legacy callback constructor + self.router: Final = router + self.token_counter: Final = token_counter + self.clock: Final = clock + self.count_slots: Final = asyncio.Semaphore(8) + self.counts: Mapping[str, tuple[int, float]] = MappingProxyType({}) + + async def async_pre_call_deployment_hook(self, kwargs: Mapping[str, object], call_type: CallTypes | None) -> None: + from litellm.litellm_core_utils.litellm_logging import Logging + + logging_obj: Final = kwargs.get("litellm_logging_obj") + if not isinstance(logging_obj, Logging) or call_type != CallTypes.anthropic_messages: + return + try: + metadata: Final = _METADATA.validate_python( + get_litellm_metadata_from_kwargs( + {"litellm_params": kwargs} # mutable-ok: legacy metadata owner requires a dictionary + ) + ) + if metadata.get(INTERNAL_CALL_ORIGIN_METADATA_KEY): + return + if logging_obj.baseline_cache_context is not None: + await invalidate_baseline_cache(logging_obj, "retried_request") + return + request: Final = _Metadata.model_validate(metadata) + session: Final = kwargs.get("litellm_session_id") or request.session_id or logging_obj.litellm_session_id + if not isinstance(session, str) or not session or len(session) > 256: + return + router: Final = self.router() + deployment: Final = router.get_deployment(request.route.baseline_deployment_id) if router else None + if deployment is None: + return + target: Final = resolve_baseline_prediction_target(deployment.litellm_params) + prices: Final = _PRICES.validate_python( + _effective_model_info(router, request.route.baseline_deployment_id, request.route.baseline_model) + ) + scope: Final = "autorouter-baseline:v3:" + _digest( + ( + request.user_api_key_hash, + session, + request.route.router_name, + request.route.baseline_deployment_id, + deployment.litellm_params.model_dump(mode="json"), + prices, + ) + ) + started: Final = logging_obj.start_time.timestamp() + capture: Final = CapturedBaselineObservation( + scope=scope, + api_key=request.user_api_key_hash, + session_id=session, + router_name=request.route.router_name, + baseline_model=request.route.baseline_model, + model=target.model if isinstance(target, NativePredictionTarget) else request.route.baseline_model, + prices=prices, + observation=BaselineObservation( + request_id=logging_obj.litellm_call_id, + started_at=started, + available_at=started, + outcome="uncertain", + baseline_equivalent=False, + reason="incomplete_response", + ), + ) + logging_obj.baseline_cache_context = BaselineCacheContext( + self, capture, target, request.route.baseline_deployment_id + ) + except Exception: # noqa: BLE001 # optional observation cannot fail inference + verbose_proxy_logger.warning("Auto-router baseline observation could not be initialized") + + async def _count(self, target: NativePredictionTarget, body: Mapping[str, JsonValue]) -> int | None: + key: Final = _digest((target.model, target.api_key, target.api_base, _JSON_BODY.validate_python(body))) + now: Final = self.clock() + cached: Final = self.counts.get(key) + if cached is not None and cached[1] > now: + return cached[0] + async with self.count_slots: + tokens: Final = ( + await self.token_counter(target.model, target.api_key, body) + if self.token_counter is not None + else await count_prompt_tokens(target.model, target.api_key, body, api_base=target.api_base) + ) + if tokens is None or tokens < 0: + return None + retained: Final = tuple((k, v) for k, v in self.counts.items() if v[1] > now and k != key)[-(_MAX_COUNTS - 1) :] + self.counts = MappingProxyType(dict((*retained, (key, (tokens, now + 3600))))) + return tokens + + async def plan( + self, target: NativePredictionTarget, wire: httpx.Request, body: Mapping[str, JsonValue], usage: Usage | None + ) -> tuple[CountedPromptCachePlan | None, str | None]: + if not supported_prediction_headers(wire.headers): + return None, "unsupported_request_headers" + plan: Final = parse_cache_plan(body) + if isinstance(plan, UnsupportedCachePlan): + return None, plan.reason + details: Final = usage.prompt_tokens_details if usage is not None else None + if ( + not plan.breakpoints + and details is not None + and ((details.cached_tokens or 0) + (details.cache_creation_tokens or 0)) + ): + return None, "implicit_cache_without_breakpoints" + + async def count(model: str, api_key: str, body: Mapping[str, JsonValue]) -> int | None: + return await self._count(target, body) + + try: + counted: Final = await asyncio.wait_for( + count_cache_plan(target.model, target.api_key, plan, token_counter=count), timeout=_COUNT_TIMEOUT + ) + return (None, counted.reason) if isinstance(counted, UnsupportedCachePlan) else (counted, None) + except TimeoutError: + return None, "token_count_timeout" + except Exception: # noqa: BLE001 # token counting cannot fail a completed request + return None, "token_count_unavailable" + + +async def invalidate_baseline_cache(logging_obj: Logging, reason: str, *, completed: bool = False) -> None: + context: Final = logging_obj.baseline_cache_context + if context is not None: + logging_obj.baseline_cache_context = replace( + context, invalidated=reason + ) # rebind-ok: request-owned retry marker + logging_obj.baseline_observation = context.capture.model_copy( + update=MappingProxyType( + { # rebind-ok: capture uncertainty for failure logging + "observation": context.capture.observation.model_copy( + update=MappingProxyType( + { + "available_at": max(context.capture.observation.started_at, context.collector.clock()), + "reason": reason, + } + ) + ), + } + ) + ) + + +async def finalize_baseline_cache(logging_obj: Logging, response_obj: object) -> None: + context: Final = logging_obj.baseline_cache_context + if context is None: + return + try: + capture: Final = await _capture(context, logging_obj, response_obj) + if logging_obj.baseline_cache_context is context: + logging_obj.baseline_observation = capture # rebind-ok: attach only to the captured request owner + except Exception: # noqa: BLE001 # observation failures must preserve inference and billing + await invalidate_baseline_cache(logging_obj, "observation_unavailable") + + +async def _capture( + context: BaselineCacheContext, logging_obj: Logging, response_obj: object +) -> CapturedBaselineObservation: + original: Final = context.capture.observation + details: Final = _METADATA.validate_python(logging_obj.model_call_details) + if details.get("cache_hit") is True: + return context.capture.model_copy( + update=MappingProxyType( + { + "observation": original.model_copy( + update=MappingProxyType({"outcome": "response_cache", "reason": "response_cache_hit"}) + ) + } + ) + ) + event: Final = _WireEvent.model_validate(details) + wire: Final = event.httpx_response.request + usage: Final = _ResponseUsage.model_validate(response_obj).usage + complete: Final = ( + event.custom_llm_provider == "anthropic" + and event.httpx_response.status_code == 200 + and (not event.stream or event.prompt_cache_response_complete) + ) + started: Final = original.started_at + available: Final = event.completion_start_time.timestamp() + if context.invalidated or not complete or not started <= available <= context.collector.clock(): + return context.capture.model_copy( + update=MappingProxyType( + { + "observation": original.model_copy( + update=MappingProxyType( + { + "available_at": max(started, context.collector.clock()), + "reason": context.invalidated or "incomplete_response", + } + ) + ) + } + ) + ) + target: Final = context.target + if isinstance(target, UnsupportedPredictionTarget) or not supported_baseline_recipient(target, wire): + return context.capture.model_copy( + update=MappingProxyType( + { + "observation": original.model_copy( + update=MappingProxyType( + { + "available_at": available, + "reason": target.reason + if isinstance(target, UnsupportedPredictionTarget) + else "unsupported_baseline_recipient", + } + ) + ) + } + ) + ) + body: Final = _JSON_BODY.validate_json(wire.content) + same: Final = ( + logging_obj.get_router_model_id() == context.baseline_deployment_id and body.get("model") == target.model + ) + plan, reason = await context.collector.plan(target, wire, body, usage) + minimum: Final = get_prompt_cache_min_tokens(target.model) + return context.capture.model_copy( + update=MappingProxyType( + { + "observation": BaselineObservation( + request_id=original.request_id, + started_at=started, + available_at=available, + outcome="complete", + baseline_equivalent=same, + usage=usage, + plan=plan, + minimum_cache_tokens=minimum, + reason=reason, + ) + } + ) + ) diff --git a/litellm/proxy/management_endpoints/auto_router_endpoints.py b/litellm/proxy/management_endpoints/auto_router_endpoints.py index 200ed6c3bf3..a6d5a17d73e 100644 --- a/litellm/proxy/management_endpoints/auto_router_endpoints.py +++ b/litellm/proxy/management_endpoints/auto_router_endpoints.py @@ -556,6 +556,9 @@ class _SessionAggRow(BaseModel): total_tokens: int spend: float saved_spend: float + savings_estimated_turns: int = 0 + savings_estimated_actual_spend: float = 0.0 + savings_estimated_saved_spend: float = 0.0 classifier_cost: float classifier_cost_recorded_turns: int session_seconds: float @@ -582,9 +585,19 @@ def _cache_bucket(turns: int, hits: int) -> AutoRouterCacheBucket: return AutoRouterCacheBucket(turns=turns, hits=hits, hit_rate_pct=_pct(hits, turns)) +def _savings_cohort( + turns: int, estimated_turns: int, actual_spend: float, saved_spend: float +) -> tuple[float | None, float | None]: + if turns > 0 and estimated_turns == 0: + return None, None + return saved_spend, actual_spend + saved_spend + + def _benchmark_totals(row: _SessionAggRow) -> AutoRouterBenchmarkTotals: return_misses: Final = row.return_turns - row.return_hits - baseline_spend: Final = row.spend + row.saved_spend + saved_spend, baseline_spend = _savings_cohort( + row.turns, row.savings_estimated_turns, row.savings_estimated_actual_spend, row.savings_estimated_saved_spend + ) sessions: Final = row.sessions return AutoRouterBenchmarkTotals( sessions=sessions, @@ -593,11 +606,15 @@ def _benchmark_totals(row: _SessionAggRow) -> AutoRouterBenchmarkTotals: avg_session_seconds=row.session_seconds / sessions if sessions else 0.0, avg_tokens_per_session=row.total_tokens / sessions if sessions else 0.0, spend=row.spend, - saved_spend=row.saved_spend, + savings_estimated_turns=row.savings_estimated_turns, + savings_estimated_actual_spend=row.savings_estimated_actual_spend, + saved_spend=saved_spend, classifier_cost=row.classifier_cost if row.classifier_cost_recorded_turns == row.turns else None, baseline_spend=baseline_spend, - saved_pct=_pct(row.saved_spend, baseline_spend), - saved_per_session=row.saved_spend / sessions if sessions else 0.0, + saved_pct=_pct(saved_spend, baseline_spend) if saved_spend is not None and baseline_spend is not None else None, + saved_per_session=(row.savings_estimated_saved_spend / sessions if sessions else 0.0) + if row.savings_estimated_turns == row.turns + else None, cache=AutoRouterCacheStats( coverage_pct=_pct(row.covered_turns, row.turns), hit_rate_pct=_pct(row.cache_hits, row.covered_turns), @@ -627,6 +644,8 @@ def _benchmark_group(row: _SessionAggRow) -> AutoRouterBenchmarkGroup: avg_tokens_per_session=totals.avg_tokens_per_session, spend=totals.spend, saved_spend=totals.saved_spend, + savings_estimated_turns=totals.savings_estimated_turns, + savings_estimated_actual_spend=totals.savings_estimated_actual_spend, classifier_cost=totals.classifier_cost, baseline_spend=totals.baseline_spend, saved_pct=totals.saved_pct, @@ -658,6 +677,9 @@ def _summed_agg_row(rows: Sequence[_SessionAggRow]) -> _SessionAggRow: total_tokens=sum(row.total_tokens for row in rows), spend=sum(row.spend for row in rows), saved_spend=sum(row.saved_spend for row in rows), + savings_estimated_turns=sum(row.savings_estimated_turns for row in rows), + savings_estimated_actual_spend=sum(row.savings_estimated_actual_spend for row in rows), + savings_estimated_saved_spend=sum(row.savings_estimated_saved_spend for row in rows), classifier_cost=sum(row.classifier_cost for row in rows), classifier_cost_recorded_turns=sum(row.classifier_cost_recorded_turns for row in rows), session_seconds=sum(row.session_seconds for row in rows), @@ -807,6 +829,9 @@ async def get_auto_router_session( raise HTTPException( status_code=404, detail=f"No auto-routed turns recorded for session {session_id!r} under this key" ) + saved_spend, baseline_spend = _savings_cohort( + row.turns, row.savings_estimated_turns, row.savings_estimated_actual_spend, row.savings_estimated_saved_spend + ) return AutoRouterSessionResponse( session_id=session_id, router_name=row.router_name, @@ -814,10 +839,13 @@ async def get_auto_router_session( turns=row.turns, last_model=row.last_model, spend=row.spend, - saved_spend=row.saved_spend, - baseline_spend=row.spend + row.saved_spend, + savings_estimated_turns=row.savings_estimated_turns, + savings_estimated_actual_spend=row.savings_estimated_actual_spend, + saved_spend=saved_spend, + baseline_spend=baseline_spend if row.savings_estimated_turns == row.turns else None, + savings_estimated_baseline_spend=baseline_spend, baseline_model=row.baseline_model, - baseline_models=row.baseline_models, + baseline_models=row.savings_estimated_baseline_models, ) diff --git a/litellm/proxy/management_endpoints/coordination_redis_endpoints.py b/litellm/proxy/management_endpoints/coordination_redis_endpoints.py index 8e64e1ea651..c59ee92f073 100644 --- a/litellm/proxy/management_endpoints/coordination_redis_endpoints.py +++ b/litellm/proxy/management_endpoints/coordination_redis_endpoints.py @@ -364,6 +364,11 @@ async def update_coordination_redis_settings( settings: Final = _merge_over_saved(request.settings, saved_settings or {}) _validated_params(settings) + from litellm.proxy.proxy_server import proxy_config + + proxy_config.reject_config_owned_writes( + section_name=_GENERAL_SETTINGS_PARAM_NAME, changed_keys={_COORDINATION_REDIS_KEY: settings} + ) general_settings: Final = await _read_general_settings() before_settings: Final = general_settings.get(_COORDINATION_REDIS_KEY) action: Final[AUDIT_ACTIONS] = "updated" if isinstance(before_settings, dict) else "created" diff --git a/litellm/proxy/openai_files_endpoints/common_utils.py b/litellm/proxy/openai_files_endpoints/common_utils.py index b6b7c0585d7..f6f91832603 100644 --- a/litellm/proxy/openai_files_endpoints/common_utils.py +++ b/litellm/proxy/openai_files_endpoints/common_utils.py @@ -38,6 +38,7 @@ if TYPE_CHECKING: FILE_LIST_CONTINUATION_CHUNK_SIZE: Final = 500 BATCH_CREATE_HIDDEN_PARAM: Final = "batch_create" +LITELLM_EXECUTED_BATCH_ID_PREFIX: Final = "litellm_batch_" def validate_file_list_limit(limit: int | None) -> None: @@ -179,6 +180,11 @@ def get_batch_id_from_unified_batch_id(file_id: str) -> str: return re.split(r"[;,]", batch_id, maxsplit=1)[0] +def is_litellm_executed_batch(decoded_unified_batch_id: str) -> bool: + _, marker, batch_id = decoded_unified_batch_id.partition("llm_batch_id:") + return bool(marker) and batch_id.startswith(LITELLM_EXECUTED_BATCH_ID_PREFIX) + + def encode_file_id_with_model(file_id: str, model: str, id_type: Literal["file", "batch"] = "file") -> str: """ Encode a file/batch ID with model routing information. diff --git a/litellm/proxy/openai_files_endpoints/files_endpoints.py b/litellm/proxy/openai_files_endpoints/files_endpoints.py index 91fce11a871..9f12b6faa61 100644 --- a/litellm/proxy/openai_files_endpoints/files_endpoints.py +++ b/litellm/proxy/openai_files_endpoints/files_endpoints.py @@ -7,7 +7,7 @@ import asyncio import traceback -from collections.abc import Mapping +from collections.abc import Mapping, Sequence from typing import Any, BinaryIO, Final, TypedDict, cast, get_args import httpx @@ -32,10 +32,15 @@ from litellm.litellm_core_utils.cloud_storage_security import ( is_managed_cloud_storage_uri, ) from litellm.litellm_core_utils.core_helpers import get_or_create_metadata_bucket +from litellm.llms.base_llm.files.litellm_db_storage_backend import LITELLM_DB_STORAGE_BACKEND_NAME from litellm.llms.base_llm.files.transformation import BaseFileEndpoints from litellm.llms.base_llm.managed_resources.isolation import build_list_page from litellm.proxy._types import * from litellm.proxy.auth.user_api_key_auth import user_api_key_auth +from litellm.proxy.batches_endpoints.litellm_executed_batches import ( + litellm_executed_provider_of, + resolve_litellm_executed_provider, +) from litellm.proxy.common_request_processing import ProxyBaseLLMRequestProcessing from litellm.proxy.common_utils.http_parsing_utils import ( _read_request_body, @@ -67,6 +72,7 @@ from litellm.proxy.openai_files_endpoints.common_utils import ( _is_base64_encoded_unified_file_id, add_internal_model_credentials, apply_team_provider_credentials, + authorize_model_for_key, encode_file_id_with_model, extract_file_creation_params, get_authorized_credentials_for_model, @@ -86,7 +92,7 @@ from litellm.proxy.openai_files_endpoints.general_upload_validation import ( coerce_optional_str_list_setting, raise_upload_validation_failure, ) -from litellm.proxy.utils import ProxyLogging, is_known_model +from litellm.proxy.utils import PrismaClient, ProxyLogging, is_known_model from litellm.repositories.table_repositories import ManagedFileRepository from litellm.router import Router from litellm.types.llms.openai import ( @@ -99,6 +105,64 @@ from litellm.types.llms.openai import ( router: Final = APIRouter() + +def _names_a_litellm_executed_provider(llm_router: Router, candidate: str, team_id: str | None) -> bool: + credentials: Final = llm_router.get_deployment_credentials_with_provider(model_id=candidate, team_id=team_id) + return credentials is not None and litellm_executed_provider_of(credentials) is not None + + +async def _litellm_executed_batch_input_model( + llm_router: Router | None, + purpose: OpenAIFilesPurpose, + model: str | None, + target_model_names_list: Sequence[str], + user_api_key_dict: UserAPIKeyAuth, + explicit_storage: str | None, +) -> str | None: + if llm_router is None: + return None + candidates: Final = (model,) if model is not None else tuple(target_model_names_list) + team_id: Final = user_api_key_dict.team_id + await asyncio.gather( + *( + authorize_model_for_key(model_id=candidate, llm_router=llm_router, user_api_key_dict=user_api_key_dict) + for candidate in candidates + if _names_a_litellm_executed_provider(llm_router, candidate, team_id) + ) + ) + if explicit_storage is not None: + return None + providers: Final = await asyncio.gather( + *(resolve_litellm_executed_provider(llm_router, candidate, team_id) for candidate in candidates) + ) + executed: Final = tuple( + candidate for candidate, provider in zip(candidates, providers, strict=True) if provider is not None + ) + if not executed: + return None + if purpose != "batch": + raise ProxyException( + message=( + f"The server behind {', '.join(executed)} has no Files API, so LiteLLM keeps only batch input " + f"files for it and runs the batch itself: upload with purpose=batch; got purpose={purpose}" + ), + type="invalid_request_error", + param="purpose", + code=400, + ) + if len(candidates) == 1: + return executed[0] + raise ProxyException( + message=( + f"LiteLLM runs batches for {', '.join(executed)} itself and keeps their input files, so a batch " + f"input file can target only that one model; got target_model_names={', '.join(candidates)}" + ), + type="invalid_request_error", + param="target_model_names", + code=400, + ) + + _MAX_BATCH_FILE_SIZE_MB_ADAPTER: Final = TypeAdapter(int | None) _LISTED_FILES_ADAPTER: Final = TypeAdapter(list[OpenAIFileObject]) @@ -244,30 +308,41 @@ async def route_create_file( 5. Else -> use custom_llm_provider with files_settings """ - # Handle custom storage backend - if target_storage and target_storage != "default": + explicit_storage: Final = target_storage if target_storage and target_storage != "default" else None + if explicit_storage == LITELLM_DB_STORAGE_BACKEND_NAME: + raise ProxyException( + message=( + f"target_storage={LITELLM_DB_STORAGE_BACKEND_NAME} is not a storage a caller can pick: LiteLLM " + "chooses it on its own for the batch input files of a model whose batches it runs itself, so " + "upload with purpose=batch and name that model instead of target_storage" + ), + type="invalid_request_error", + param="target_storage", + code=400, + ) + executed_model: Final = await _litellm_executed_batch_input_model( + llm_router, purpose, model, target_model_names_list, user_api_key_dict, explicit_storage + ) + storage: Final = explicit_storage or (LITELLM_DB_STORAGE_BACKEND_NAME if executed_model is not None else None) + if storage is not None: from litellm.litellm_core_utils.prompt_templates.common_utils import ( extract_file_data, ) from litellm.proxy.openai_files_endpoints.storage_backend_service import ( StorageBackendFileService, ) + from litellm.proxy.proxy_server import prisma_client - # Extract file data - file_data: Final = extract_file_data(cast(Any, _create_file_request.get("file"))) - - # Use storage backend service to handle upload - file_object: Final = await StorageBackendFileService.upload_file_to_storage_backend( - file_data=file_data, - target_storage=target_storage, - target_model_names=target_model_names_list, + return await StorageBackendFileService.upload_file_to_storage_backend( + file_data=extract_file_data(cast(Any, _create_file_request.get("file"))), + target_storage=storage, + target_model_names=(executed_model,) if executed_model is not None else target_model_names_list, purpose=purpose, proxy_logging_obj=proxy_logging_obj, user_api_key_dict=user_api_key_dict, + prisma_client=prisma_client, ) - return file_object - # NEW: Handle model-based routing (no DB required) if model is not None: # Get credentials from model_list via router @@ -848,7 +923,7 @@ async def get_file_content( # Check if file is stored in a storage backend (check DB) if hasattr(managed_files_obj, "prisma_client") and getattr(managed_files_obj, "prisma_client", None): - prisma_client: Final = getattr(managed_files_obj, "prisma_client") + prisma_client: Final[PrismaClient] = getattr(managed_files_obj, "prisma_client") db_file: Final = await ManagedFileRepository(prisma_client).table.find_first( where={"unified_file_id": file_id} ) @@ -863,7 +938,7 @@ async def get_file_content( try: # Get storage backend (uses same env vars as callback) - storage_backend: Final = get_storage_backend(storage_backend_name) + storage_backend: Final = get_storage_backend(storage_backend_name, prisma_client=prisma_client) file_content: Final = await storage_backend.download_file(storage_url) # Return file content diff --git a/litellm/proxy/openai_files_endpoints/storage_backend_service.py b/litellm/proxy/openai_files_endpoints/storage_backend_service.py index e766f335071..66dbcd87c0b 100644 --- a/litellm/proxy/openai_files_endpoints/storage_backend_service.py +++ b/litellm/proxy/openai_files_endpoints/storage_backend_service.py @@ -7,15 +7,16 @@ storage backends (e.g., Azure Blob Storage) and managing associated metadata. import base64 import time -from collections.abc import Mapping +from collections.abc import Mapping, Sequence from typing import Any, Final, cast from litellm._logging import verbose_proxy_logger from litellm._uuid import uuid as uuid_module +from litellm.llms.base_llm.files.storage_backend import BaseFileStorageBackend from litellm.llms.base_llm.files.storage_backend_factory import get_storage_backend from litellm.llms.base_llm.files.transformation import BaseFileEndpoints from litellm.proxy._types import ProxyException, UserAPIKeyAuth -from litellm.proxy.utils import ProxyLogging +from litellm.proxy.utils import PrismaClient, ProxyLogging from litellm.types.llms.openai import OpenAIFileObject, OpenAIFilesPurpose from litellm.types.utils import SpecialEnums @@ -35,21 +36,23 @@ class StorageBackendFileService: async def upload_file_to_storage_backend( file_data: Mapping[str, Any], target_storage: str, - target_model_names: list[str], + target_model_names: Sequence[str], purpose: OpenAIFilesPurpose, proxy_logging_obj: ProxyLogging, user_api_key_dict: UserAPIKeyAuth, + prisma_client: PrismaClient | None = None, ) -> OpenAIFileObject: """ Upload a file to a storage backend and create a file object. Args: file_data: File data dictionary from extract_file_data() - target_storage: Storage backend name (e.g., "azure_storage") + target_storage: Storage backend name (e.g., "azure_storage", "litellm_db") target_model_names: List of model names for managed files purpose: File purpose (e.g., "user_data", "batch") proxy_logging_obj: Proxy logging object for accessing hooks user_api_key_dict: User API key authentication data + prisma_client: The proxy's database client, required by the "litellm_db" backend Returns: OpenAIFileObject: Created file object with storage metadata @@ -59,7 +62,7 @@ class StorageBackendFileService: """ # Get storage backend instance try: - storage_backend: Final = get_storage_backend(target_storage) + storage_backend: Final = get_storage_backend(target_storage, prisma_client=prisma_client) except ValueError as e: raise ProxyException( message=str(e), @@ -103,8 +106,9 @@ class StorageBackendFileService: storage_url=storage_url, ) - # Store in managed files if target_model_names provided - if target_model_names: + if not target_model_names: + return file_object + try: await StorageBackendFileService._store_in_managed_files( file_object=file_object, file_data=file_data, @@ -114,9 +118,25 @@ class StorageBackendFileService: proxy_logging_obj=proxy_logging_obj, user_api_key_dict=user_api_key_dict, ) - + except Exception: + await StorageBackendFileService._discard_orphaned_content(storage_backend, storage_url, target_storage) + raise return file_object + @staticmethod + async def _discard_orphaned_content( + storage_backend: BaseFileStorageBackend, storage_url: str, target_storage: str + ) -> None: + try: + await storage_backend.delete_file(storage_url) + except Exception as e: # noqa: BLE001 # the metadata failure is what surfaces; a failed cleanup is only logged + verbose_proxy_logger.warning( + "Could not delete orphaned content at %s on %s after its metadata write failed: %s", + storage_url, + target_storage, + e, + ) + @staticmethod def _create_file_object_with_storage_metadata( file_content: bytes, @@ -164,7 +184,7 @@ class StorageBackendFileService: @staticmethod def _create_unified_file_id( file_type: str, - target_model_names: list[str], + target_model_names: Sequence[str], file_id: str, ) -> str: """ @@ -194,7 +214,7 @@ class StorageBackendFileService: async def _store_in_managed_files( file_object: OpenAIFileObject, file_data: Mapping[str, Any], - target_model_names: list[str], + target_model_names: Sequence[str], target_storage: str, storage_url: str, proxy_logging_obj: ProxyLogging, diff --git a/litellm/proxy/proxy_cli.py b/litellm/proxy/proxy_cli.py index 9f2e4c9802e..0477b6c62e9 100644 --- a/litellm/proxy/proxy_cli.py +++ b/litellm/proxy/proxy_cli.py @@ -589,6 +589,11 @@ class ProxyInitializationHelpers: gunicorn_options["certfile"] = ssl_certfile_path gunicorn_options["keyfile"] = ssl_keyfile_path + # The master preloads the app and then forks every worker, so native routes are + # forbidden in it: their runtime threads would not survive the fork. + from litellm.rust_bridge.fork_guard import reserve_process_for_forking + + reserve_process_for_forking("the gunicorn master") start_query_engine_reaper() StandaloneApplication(app=app, options=gunicorn_options).run() # Run gunicorn diff --git a/litellm/proxy/proxy_server.py b/litellm/proxy/proxy_server.py index 3c7d06268ad..af25d418a63 100644 --- a/litellm/proxy/proxy_server.py +++ b/litellm/proxy/proxy_server.py @@ -4787,6 +4787,22 @@ def _swap_in_model_cost_map(new_model_cost_map: dict) -> int: return adopt_model_cost_map(new_model_cost_map) +def _websearch_handler_params(stored: Mapping[str, object]) -> dict[str, object]: + """ + Translate stored web search interception settings into handler kwargs. + + Drops ``enabled``, which gates the callback rather than configuring it, and + drops an ``enabled_providers`` that is not a non-empty list so the handler + applies its own default. An empty list otherwise matches no provider at all, + and a bare string is iterated one character at a time. + """ + params: Final = {key: value for key, value in stored.items() if key != "enabled"} + providers: Final = params.get("enabled_providers") + if not isinstance(providers, list) or not providers: + params.pop("enabled_providers", None) + return params + + def should_load_db_object(object_type: str | SupportedDBObjectType) -> bool: """ Check if an object type should be loaded from the database based on general_settings.supported_db_objects. @@ -4888,6 +4904,7 @@ class ProxyConfig: def __init__(self) -> None: self.config: Mapping[str, object] = MappingProxyType({}) self._last_semantic_filter_config: dict[str, object] | None = None + self._last_websearch_interception_config: dict[str, object] | None = None self._last_hashicorp_vault_config: dict[str, object] | None = None self._last_cyberark_config: dict[str, object] | None = None # mutable-ok: change-detection cache self._cyberark_boot_env: dict[str, str | None] | None = None # mutable-ok: deployment env snapshot, set once @@ -5117,6 +5134,15 @@ class ProxyConfig: store.apply_db_row(cast(DbRow, section_name), wrote_section) await invalidate_config_param(section_name) + def reject_config_owned_deletes(self, *, section_name: str, keys: tuple[str, ...]) -> None: + """Refuse a delete of a setting the config file owns; unlike a write, the value never makes it allowed.""" + store: Final = self._settings_stores.get(cast(Section, section_name)) + if store is None: + return + owned: Final = tuple(sorted(key for key in keys if store.owned_by_config(key))) + if owned: + self._raise_config_owned(section_name=section_name, rejected=owned, store=store) + def reject_config_owned_writes(self, *, section_name: str, changed_keys: Mapping[str, JsonValue]) -> None: """Refuse a write to a setting the config file owns, rather than storing a value that never applies.""" store: Final = self._settings_stores.get(cast(Section, section_name)) @@ -5125,6 +5151,9 @@ class ProxyConfig: rejected: Final = store.rejected_writes(changed_keys) if not rejected: return + self._raise_config_owned(section_name=section_name, rejected=rejected, store=store) + + def _raise_config_owned(self, *, section_name: str, rejected: tuple[str, ...], store: SettingsStore) -> None: subject: Final = ( f"key '{rejected[0]}' is" if len(rejected) == 1 else f"keys {', '.join(repr(key) for key in rejected)} are" ) @@ -7697,6 +7726,9 @@ class ProxyConfig: if self._should_load_db_object(object_type="semantic_filter_settings"): await self._init_semantic_filter_settings_in_db(prisma_client=prisma_client) + if self._should_load_db_object(object_type=SupportedDBObjectType.WEBSEARCH_INTERCEPTION_SETTINGS): + await self.init_websearch_interception_settings_in_db(prisma_client=prisma_client) + if self._should_load_db_object(object_type="config_overrides"): await self._init_hashicorp_vault_config_override(prisma_client=prisma_client) await self._init_cyberark_config_override(prisma_client=prisma_client) @@ -7775,6 +7807,66 @@ class ProxyConfig: except Exception as e: verbose_proxy_logger.exception("Error initializing semantic filter settings from DB: %s", e) + async def init_websearch_interception_settings_in_db(self, prisma_client: PrismaClient): + """ + Initialize web search interception settings from database. + Called periodically (approximately every 10 seconds) by background task to hot-reload settings across all pods. + """ + import json + + import litellm + from litellm.integrations.websearch_interception.handler import ( + WebSearchInterceptionLogger, + ) + + try: + config_record: Final = await get_config_param(prisma_client, "litellm_settings") + + if config_record is None or config_record.param_value is None: + return + + litellm_settings = config_record.param_value + if isinstance(litellm_settings, str): + litellm_settings = json.loads(litellm_settings) + + websearch_config: Final = litellm_settings.get("websearch_interception_params", None) + + if not isinstance(websearch_config, Mapping): + return + + if "enabled" not in websearch_config and self._last_websearch_interception_config is None: + verbose_proxy_logger.debug( + "Web search interception: stored settings carry no 'enabled' flag and none were applied " + "before, so litellm_settings.callbacks keeps ownership of the callback." + ) + return + + enabled: Final = bool(coerce_bool(websearch_config.get("enabled", True))) + registered: Final = bool( + litellm.logging_callback_manager.get_custom_loggers_for_type(WebSearchInterceptionLogger) + ) + if self._last_websearch_interception_config == websearch_config and registered == enabled: + return + + replacement: Final = ( + WebSearchInterceptionLogger.from_config_yaml(_websearch_handler_params(websearch_config)) + if enabled + else None + ) + + litellm.logging_callback_manager.remove_callbacks_by_type(litellm.callbacks, WebSearchInterceptionLogger) + + if replacement is not None: + litellm.logging_callback_manager.add_litellm_callback(replacement) + verbose_proxy_logger.info("Web search interception reinitialized from DB") + else: + verbose_proxy_logger.info("Web search interception disabled") + + self._last_websearch_interception_config = dict(websearch_config) + + except Exception as e: + verbose_proxy_logger.exception("Error initializing web search interception settings from DB: %s", e) + async def _init_sso_settings_in_db(self, prisma_client: PrismaClient): """ Initialize SSO settings from database into the router on startup. @@ -9684,10 +9776,12 @@ class ProxyStartupEvent: user_api_key_cache: UserApiKeyCache, ): """Initialize JWT auth on startup""" - if general_settings.get("litellm_jwtauth", None) is not None: - for k, v in general_settings["litellm_jwtauth"].items(): - if isinstance(v, str) and v.startswith("os.environ/"): - general_settings["litellm_jwtauth"][k] = get_secret(v) + declared_jwtauth: Final = general_settings.get("litellm_jwtauth", None) + if declared_jwtauth is not None: + resolved_jwtauth: Final = { + key: (get_secret(value) if isinstance(value, str) and value.startswith("os.environ/") else value) + for key, value in declared_jwtauth.items() + } # ``user_config_file_path`` is set by ``ProxyConfig._get_config_from_file`` # during startup. Threading it through lets an operator- # configured ``custom_validate: s3://...`` resolve through @@ -9695,7 +9789,7 @@ class ProxyStartupEvent: # file context) hit the gate and refuse remote loads. litellm_jwtauth = LiteLLM_JWTAuth( config_file_path=user_config_file_path, - **general_settings["litellm_jwtauth"], + **resolved_jwtauth, ) else: litellm_jwtauth = LiteLLM_JWTAuth() @@ -17665,9 +17759,12 @@ async def get_config_general_settings( detail={"error": f"Field name={field_name} is not set"}, ) + declared: Final = ( + settings.config_value(field_name) if settings.owned_by_config(field_name) else settings[field_name] + ) field_value = _redact_general_setting_value( field_name, - settings[field_name], + declared, user_api_key_dict.user_role == LitellmUserRoles.PROXY_ADMIN, ) if field_name == "plugins" and isinstance(field_value, list): @@ -18041,6 +18138,8 @@ async def delete_config_general_settings( detail={"error": f"Invalid field={data.field_name} passed in."}, ) + proxy_config.reject_config_owned_deletes(section_name="general_settings", keys=(data.field_name,)) + ## get general settings from db db_general_settings: Final[_ConfigParamRow | None] = await _config_param_table(prisma_client).find_first( where={"param_name": "general_settings"} diff --git a/litellm/proxy/public_endpoints/public_endpoints.py b/litellm/proxy/public_endpoints/public_endpoints.py index 94a59828451..e395f56194f 100644 --- a/litellm/proxy/public_endpoints/public_endpoints.py +++ b/litellm/proxy/public_endpoints/public_endpoints.py @@ -23,6 +23,7 @@ from litellm.proxy._types import ( ) from litellm.proxy.utils import get_custom_url from litellm.repositories.table_repositories import ClaudeCodePluginRepository +from litellm.router_strategy.complexity_router.fuse_presets import FusePresetCatalog, get_fuse_presets from litellm.types.agents import AgentCard from litellm.types.mcp import MCPPublicServer from litellm.types.proxy.management_endpoints.model_management_endpoints import ( @@ -424,6 +425,14 @@ async def get_complexity_scorer_defaults() -> ComplexityScorerDefaults: ) +@router.get( + "/public/complexity_router/fuse_presets", + response_model=FusePresetCatalog, +) +async def get_public_fuse_presets() -> FusePresetCatalog: + return get_fuse_presets() + + @router.get( "/public/litellm_model_cost_map", tags=["public", "model management"], diff --git a/litellm/proxy/schema.prisma b/litellm/proxy/schema.prisma index 91b59e56906..d2032cec0d0 100644 --- a/litellm/proxy/schema.prisma +++ b/litellm/proxy/schema.prisma @@ -1107,6 +1107,12 @@ model LiteLLM_ManagedObjectTable { // for batches or finetuning jobs which use t @@index([team_id, created_at(sort: Desc)]) } +model LiteLLM_ManagedFileContentTable { + id String @id @default(uuid()) + content Bytes + created_at DateTime @default(now()) +} + model LiteLLM_ManagedVectorStoreTable { id String @id @default(uuid()) unified_resource_id String @unique // The base64 encoded unified vector store ID @@ -1545,6 +1551,36 @@ model LiteLLM_AdaptiveRouterSession { @@index([last_activity_at], map: "idx_adaptive_router_session_activity") } +model LiteLLM_AutoRouterBaselineComparison { + scope String @id + api_key String + session_id String + router_name String + initial_equivalent Boolean + revision BigInt @default(0) + published_revision BigInt @default(0) + history String? + attempted_at DateTime? + retired Boolean @default(false) + updated_at DateTime @default(now()) + + @@index([api_key, session_id, router_name], map: "idx_autorouter_baseline_scope") + @@index([updated_at], map: "idx_autorouter_baseline_updated") +} + +model LiteLLM_AutoRouterBaselineObservation { + request_id String @id + scope String + started_at Float + revision BigInt + data String + publication String? + conflicted Boolean @default(false) + + @@index([scope, started_at, request_id], map: "idx_autorouter_baseline_event_order") + @@index([scope, revision, started_at], map: "idx_autorouter_baseline_event_revision") +} + model LiteLLM_AutoRouterSession { api_key String session_id String @@ -1571,6 +1607,10 @@ model LiteLLM_AutoRouterSession { total_tokens BigInt @default(0) spend Float @default(0) saved_spend Float @default(0) + savings_estimated_turns Int @default(0) + savings_estimated_actual_spend Float @default(0) + savings_estimated_saved_spend Float @default(0) + savings_estimated_baseline_models Json @default("{}") classifier_cost Float @default(0) classifier_cost_recorded_turns Int @default(0) tier_turns Json @default("{}") diff --git a/litellm/proxy/spend_tracking/baseline_accounting.py b/litellm/proxy/spend_tracking/baseline_accounting.py new file mode 100644 index 00000000000..5980fb66211 --- /dev/null +++ b/litellm/proxy/spend_tracking/baseline_accounting.py @@ -0,0 +1,348 @@ +"""Pure, chronological cache accounting for the recorded baseline comparison. + +Observation collection, pricing and durable publication belong to their existing +owners. Replaying these values in event order is independent of callback order. +""" + +from __future__ import annotations + +from collections.abc import Sequence +from dataclasses import dataclass +from itertools import groupby +from math import isfinite +from types import MappingProxyType +from typing import Final, Literal + +from pydantic import BaseModel, ConfigDict, Field + +from litellm.llms.anthropic.prompt_cache_prediction import CountedBreakpoint, CountedPromptCachePlan +from litellm.types.utils import CacheCreationTokenDetails, PromptTokensDetailsWrapper, Usage + +MAX_CACHE_TTL: Final = 3600 +MAX_CACHE_ENTRIES: Final = 1024 + + +class BaselineObservation(BaseModel): + model_config = ConfigDict(extra="forbid", frozen=True, strict=True) + + version: Literal[3] = 3 + request_id: str = Field(min_length=1) + started_at: float = Field(allow_inf_nan=False, ge=0) + available_at: float = Field(allow_inf_nan=False, ge=0) + outcome: Literal["complete", "uncertain", "response_cache"] + baseline_equivalent: bool + usage: Usage | None = None + plan: CountedPromptCachePlan | None = None + minimum_cache_tokens: int = Field(default=0, ge=0) + reason: str | None = None + + +@dataclass(frozen=True, slots=True) +class BaselineEstimate: + request_id: str + reason: str + provenance: Literal["observed_identical", "modeled"] | None = None + usage: Usage | None = None + + +@dataclass(frozen=True, slots=True) +class CacheEntry: + fingerprint: str + content_fingerprint: str + tokens: int + ttl_seconds: int + available_at: float + expires_at: float + uncertain: bool = False + + +@dataclass(frozen=True, slots=True) +class BaselineHistory: + first_at: float | None = None + last_at: float | None = None + equivalent: bool = True + uncertain_before: float = 0.0 + entries: tuple[CacheEntry, ...] = () + blocked_until: float = 0.0 + + +def _complete_usage(usage: Usage | None) -> bool: + if usage is None or usage.prompt_tokens < 0 or usage.completion_tokens < 0: + return False + details: Final = usage.prompt_tokens_details + if details is None: + return False + values: Final = (details.text_tokens, details.cached_tokens, details.cache_creation_tokens) + if any(value is None or value < 0 for value in values): + return False + split: Final = details.cache_creation_token_details + writes: Final = details.cache_creation_tokens or 0 + return ( + usage.total_tokens == usage.prompt_tokens + usage.completion_tokens + and sum(value or 0 for value in values) == usage.prompt_tokens + and ( + writes == 0 + or ( + split is not None + and split.ephemeral_5m_input_tokens is not None + and split.ephemeral_1h_input_tokens is not None + and min(split.ephemeral_5m_input_tokens, split.ephemeral_1h_input_tokens) >= 0 + and split.ephemeral_5m_input_tokens + split.ephemeral_1h_input_tokens == writes + ) + ) + ) + + +def _valid_plan(plan: CountedPromptCachePlan | None) -> bool: + if plan is None or plan.total_tokens < 0 or len(plan.breakpoints) > 4: + return False + return all( + marker.fingerprint + and marker.content_fingerprint + and marker.fingerprint in marker.lookback_fingerprints + and marker.content_fingerprint in marker.lookback_content_fingerprints + and marker.ttl_seconds in (300, 3600) + and 0 <= marker.prefix_tokens <= plan.total_tokens + for marker in plan.breakpoints + ) and all( + left.prefix_tokens <= right.prefix_tokens and left.ttl_seconds >= right.ttl_seconds + for left, right in zip(plan.breakpoints, plan.breakpoints[1:]) + ) + + +def _markers(observation: BaselineObservation) -> tuple[CountedBreakpoint, ...]: + return ( + tuple( + marker + for marker in observation.plan.breakpoints + if marker.prefix_tokens >= observation.minimum_cache_tokens + ) + if observation.plan is not None + else () + ) + + +def _matches(entry: CacheEntry, markers: tuple[CountedBreakpoint, ...], started: float) -> bool: + return entry.available_at <= started < entry.expires_at and any( + entry.fingerprint in marker.lookback_fingerprints + and entry.tokens <= marker.prefix_tokens + and entry.ttl_seconds == marker.ttl_seconds + for marker in markers + ) + + +def _ambiguous(entry: CacheEntry, markers: tuple[CountedBreakpoint, ...], started: float) -> bool: + return entry.available_at <= started < entry.expires_at and any( + entry.content_fingerprint in marker.lookback_content_fingerprints + and (entry.uncertain or entry.ttl_seconds != marker.ttl_seconds) + for marker in markers + ) + + +def _usage_with_cache(usage: Usage, total: int, read: int, write_5m: int, write_1h: int) -> Usage: + writes: Final = write_5m + write_1h + original_details: Final = usage.prompt_tokens_details or PromptTokensDetailsWrapper() + details: Final = original_details.model_copy( + deep=True, + update=MappingProxyType( + { + "text_tokens": total - read - writes, + "cached_tokens": read, + "cache_creation_tokens": writes, + "cache_write_tokens": writes, + "cache_creation_token_details": CacheCreationTokenDetails( + ephemeral_5m_input_tokens=write_5m, + ephemeral_1h_input_tokens=write_1h, + ), + } + ), + ) + return Usage.model_validate( + { # mutable-ok: Usage only runs its normalizing constructor for a plain dictionary + **usage.model_dump(), + "prompt_tokens": total, + "total_tokens": total + usage.completion_tokens, + "prompt_tokens_details": details, + "cache_read_input_tokens": read, + "cache_creation_input_tokens": writes, + }, + ) + + +def _estimate(history: BaselineHistory, observation: BaselineObservation, equivalent: bool) -> BaselineEstimate: + if observation.outcome != "complete" or not _complete_usage(observation.usage): + return BaselineEstimate(observation.request_id, observation.reason or observation.outcome) + usage: Final = observation.usage + if usage is None: + return BaselineEstimate(observation.request_id, "missing_usage") + if equivalent and observation.baseline_equivalent: + return BaselineEstimate( + observation.request_id, "identical_baseline_path", "observed_identical", usage.model_copy(deep=True) + ) + if observation.started_at < history.blocked_until: + return BaselineEstimate(observation.request_id, "concurrent_uncertainty") + plan: Final = observation.plan + if not _valid_plan(plan) or plan is None: + return BaselineEstimate(observation.request_id, observation.reason or "unsupported_cache_plan") + markers: Final = _markers(observation) + if any(_ambiguous(entry, markers, observation.started_at) for entry in history.entries): + return BaselineEstimate(observation.request_id, "cache_ttl_changed") + read: Final = max( + ( + entry.tokens + for entry in history.entries + if not entry.uncertain and _matches(entry, markers, observation.started_at) + ), + default=0, + ) + end: Final = markers[-1].prefix_tokens if markers else 0 + if read < end and observation.started_at < history.uncertain_before + max(marker.ttl_seconds for marker in markers): + return BaselineEstimate(observation.request_id, "history_unavailable") + one_hour: Final = max( + (marker.prefix_tokens for marker in markers if marker.ttl_seconds == 3600 and marker.prefix_tokens > read), + default=read, + ) + expired: Final = any( + entry.expires_at <= observation.started_at + and any(entry.fingerprint in marker.lookback_fingerprints for marker in markers) + for entry in history.entries + ) + reason: Final = ( + "cache_prefix_available" + if read + else "cache_prefix_expired" + if expired + else "cache_prefix_cold" + if markers + else "below_cache_minimum" + if plan.breakpoints + else "no_cache_breakpoints" + ) + return BaselineEstimate( + observation.request_id, + reason, + "modeled", + _usage_with_cache(usage, plan.total_tokens, read, end - one_hour, one_hour - read), + ) + + +def _writes(history: BaselineHistory, observation: BaselineObservation) -> tuple[CacheEntry, ...]: + if ( + observation.outcome != "complete" + or observation.started_at < history.blocked_until + or not _complete_usage(observation.usage) + or not _valid_plan(observation.plan) + ): + return () + markers: Final = _markers(observation) + ambiguous: Final = tuple(entry for entry in history.entries if _ambiguous(entry, markers, observation.started_at)) + hit: Final = ( + max( + ( + entry + for entry in history.entries + if not entry.uncertain and _matches(entry, markers, observation.started_at) + ), + key=lambda entry: entry.tokens, + default=None, + ) + if not ambiguous + else None + ) + refresh: Final = ( + ( + CacheEntry( + hit.fingerprint, + hit.content_fingerprint, + hit.tokens, + hit.ttl_seconds, + observation.available_at, + observation.started_at + hit.ttl_seconds, + ), + ) + if hit is not None and all(marker.fingerprint != hit.fingerprint for marker in markers) + else () + ) + return ( + *refresh, + *( + CacheEntry( + marker.fingerprint, + marker.content_fingerprint, + marker.prefix_tokens, + marker.ttl_seconds, + observation.available_at, + observation.started_at + max((marker.ttl_seconds, *(entry.ttl_seconds for entry in ambiguous))), + uncertain=bool(ambiguous), + ) + for marker in markers + ), + ) + + +def _entry_key(entry: CacheEntry) -> tuple[str, str, int, int, bool]: + return entry.fingerprint, entry.content_fingerprint, entry.tokens, entry.ttl_seconds, entry.uncertain + + +def _compact_entries(entries: tuple[CacheEntry, ...], started: float) -> tuple[CacheEntry, ...]: + ordered: Final = sorted((entry for entry in entries if entry.expires_at >= started - MAX_CACHE_TTL), key=_entry_key) + return tuple( + retained + for _, values in groupby(ordered, key=_entry_key) + for group in (tuple(values),) + for retained in ( + max( + (entry for entry in group if entry.available_at <= started), + key=lambda entry: entry.expires_at, + default=None, + ), + *(entry for entry in group if entry.available_at > started), + ) + if retained is not None + ) + + +def advance_baseline_history( + history: BaselineHistory, + simultaneous: Sequence[BaselineObservation], +) -> tuple[BaselineHistory, tuple[BaselineEstimate, ...]]: + """Apply one request-start timestamp; ties cannot manufacture initial equality. + + The storage owner groups and orders observations before calling this function. + Equal timestamps are evaluated against the same preceding cache snapshot. + """ + if not simultaneous: + return history, () + started: Final = simultaneous[0].started_at + valid_order: Final = ( + isfinite(started) + and all(item.started_at == started and item.available_at >= started for item in simultaneous) + and (history.last_at is None or started > history.last_at) + ) + if not valid_order: + return history, tuple(BaselineEstimate(item.request_id, "invalid_observation_order") for item in simultaneous) + first: Final = started if history.first_at is None else history.first_at + uncertain: Final = max(history.uncertain_before, first) + relevant: Final = tuple(item for item in simultaneous if item.outcome != "response_cache") + equivalent: Final = history.equivalent and all(item.baseline_equivalent for item in relevant) + before: Final = BaselineHistory( + first, history.last_at, equivalent, uncertain, history.entries, history.blocked_until + ) + estimates: Final = tuple(_estimate(before, item, equivalent) for item in simultaneous) + invalidated: Final = any( + item.outcome != "complete" or not _complete_usage(item.usage) or not _valid_plan(item.plan) for item in relevant + ) + blocked: Final = max((history.blocked_until, *(item.available_at for item in relevant if invalidated))) + entries: Final = _compact_entries( + () if invalidated else (*history.entries, *(entry for item in relevant for entry in _writes(before, item))), + started, + ) + overflow: Final = len(entries) > MAX_CACHE_ENTRIES + return BaselineHistory( + first_at=first, + last_at=started, + equivalent=equivalent, + uncertain_before=max(started, blocked) if invalidated or overflow else uncertain, + entries=() if overflow else entries, + blocked_until=blocked, + ), estimates diff --git a/litellm/proxy/spend_tracking/savings.py b/litellm/proxy/spend_tracking/savings.py index 7d9b6514a34..b7a2ac62844 100644 --- a/litellm/proxy/spend_tracking/savings.py +++ b/litellm/proxy/spend_tracking/savings.py @@ -10,7 +10,11 @@ have been aggregated across models. from collections.abc import Callable, Mapping from datetime import datetime -from typing import TYPE_CHECKING, Final, NamedTuple +from math import isclose, isfinite +from types import MappingProxyType +from typing import TYPE_CHECKING, Final, Literal, NamedTuple + +from pydantic import BaseModel, ConfigDict, Field import litellm from litellm._logging import verbose_proxy_logger @@ -65,7 +69,7 @@ def _resolve_model(model: str | None, custom_llm_provider: str | None) -> _Model return None try: resolved_model, provider, _, _ = litellm.get_llm_provider(model=model, custom_llm_provider=custom_llm_provider) - except Exception as e: # noqa: BLE001 # get_llm_provider raises for unroutable names; degrade to zero savings + except Exception as e: # noqa: BLE001 # get_llm_provider raises for unroutable names; degrade to an unavailable estimate verbose_proxy_logger.debug( "savings: cannot resolve provider for model=%s custom_llm_provider=%s (%s)", model, custom_llm_provider, e ) @@ -118,6 +122,68 @@ class PricingBasis(NamedTuple): _STANDARD_RATES: Final = PricingBasis() +class BaselineCostSnapshot(BaseModel): + model_config = ConfigDict(extra="forbid", frozen=True, strict=True) + + model: str + provider: str + prices: ModelInfo | None + basis: PricingBasis = _STANDARD_RATES + actual_spend: float = Field(allow_inf_nan=False, ge=0) + actual_token_cost: float | None = Field(default=None, allow_inf_nan=False, ge=0) + classifier_cost: float = Field(default=0.0, allow_inf_nan=False, ge=0) + + +def baseline_cost_snapshot( + model: str, + prices: ModelInfo | None, + actual_spend: float, + cost_breakdown: Mapping[str, object] | None, + routing_decision: Mapping[str, object] | None, +) -> BaselineCostSnapshot: + return BaselineCostSnapshot( + model=model, + provider="anthropic", + prices=prices, + actual_spend=actual_spend, + basis=_pricing_basis(cost_breakdown), + actual_token_cost=_recorded_token_cost(cost_breakdown), + classifier_cost=classifier_cost_from_decision(routing_decision) or 0.0, + ) + + +class BaselineCosts(NamedTuple): + actual: float + baseline: float + + @property + def savings(self) -> float: + return self.baseline - self.actual + + +def price_baseline_comparison( + snapshot: BaselineCostSnapshot, + baseline_usage: Usage | None, + provenance: Literal["observed_identical", "modeled"] | None, +) -> BaselineCosts | None: + if baseline_usage is None or provenance is None: + return None + actual: Final = snapshot.actual_spend + snapshot.classifier_cost + if provenance == "observed_identical": + return BaselineCosts(actual=actual, baseline=snapshot.actual_spend) + if snapshot.prices is None or snapshot.actual_token_cost is None: + return None + token_cost: Final = _cost_of_usage( + _ModelIdentity(snapshot.model, snapshot.provider), baseline_usage, snapshot.prices, snapshot.basis + ) + if token_cost is None or not isfinite(token_cost) or token_cost < 0: + return None + baseline: Final = snapshot.actual_spend + token_cost - snapshot.actual_token_cost + if not isfinite(baseline) or baseline < 0: + return None + return BaselineCosts(actual=actual, baseline=baseline) + + def _pricing_basis(cost_breakdown: Mapping[str, object] | None) -> PricingBasis: """The basis recorded on a request, defaulting to standard rates when absent. @@ -225,56 +291,16 @@ def _baseline_cache_rate_keys(baseline_info: ModelInfo | None) -> tuple[bool, bo ) -def _baseline_usage(usage: Usage, conversation_continuing: bool, baseline_info: ModelInfo | None = None) -> Usage: - """The same request as a single-model baseline would have met it. - - The baseline is one model serving every turn, so whether it had this prompt cached - is simply whether the conversation was already underway. On a continuing - conversation it wrote the prompt on an earlier turn and would only read it now, so - the cache tokens move into the read bucket and whatever this request paid to write - counts against the saving; that write is what switching models costs. - - On a conversation's first turn nothing was cached anywhere, for any model. The - baseline would have written the same prompt, so the cache buckets stay where they are - and both arms carry the write at their own rates, unless the baseline has no rate for - a bucket, in which case those tokens are its plain input. Charging the write to this case - too, which is all a single rollup row can support, understates a first turn to a - few percent of its value and can render a profitable route as a loss. - - A continuing turn that mostly read from cache is the third case: the selected model - was already warm, so it is the one that has been serving this conversation and the - baseline's cache holds exactly what its does. The tokens written are the turn's own - growth, new to every model, and the baseline would have paid to write them too. - Moving them would forgive the baseline a write it really owes and shrink the - reported saving. "Mostly read" rather than "read anything" on purpose: a switch onto - a model holding a small prefix of this prompt still writes most of it, and must keep - counting that write against the saving. - - Only the cache buckets move. Every other field the request was priced on travels - through untouched, audio and image and video counts among them, because the baseline - is this same request served by a model that happened to be warm; naming the fields to - keep instead would price the baseline on a request that never ran, and would go stale - the next time a priced field is added. - """ +def _baseline_usage(usage: Usage, baseline_info: ModelInfo | None = None) -> Usage: cache_read, cache_creation = _cache_token_split(usage) details: Final = usage.prompt_tokens_details if details is None or (cache_read <= 0 and cache_creation <= 0): return usage - - # The tokens this request paid to write move into the cached count and the creation - # charge is dropped: on one model that cache was already warm, so the baseline would - # have read them rather than paying to create them. The 5m/1h breakdown goes with - # them; left behind it re-charges the write. - warm: Final = conversation_continuing and cache_creation > 0 and cache_read <= cache_creation - reads = cache_read + cache_creation if warm else cache_read - writes = 0 if warm else cache_creation - prices_reads, prices_writes = _baseline_cache_rate_keys(baseline_info) - reads = reads if prices_reads else 0 - writes = writes if prices_writes else 0 + reads: Final = cache_read if prices_reads else 0 + writes: Final = cache_creation if prices_writes else 0 if (reads, writes) == (cache_read, cache_creation): return usage - other_modalities: Final = sum( (getattr(details, field, 0) or 0) for field in ("audio_tokens", "image_tokens", "video_tokens") ) @@ -309,64 +335,47 @@ def compute_autorouter_savings( cost_breakdown: Mapping[str, object] | None = None, baseline_deployment_id: str | None = None, selected_deployment_id: str | None = None, -) -> float: - """Net dollars the router saved, or cost, by serving this request on ``selected_model``. - - Signed on purpose. Switching models leaves the new one with a cold cache, so the - request pays a cache-creation charge that staying on one model would not have - incurred; when that charge outweighs the cheaper rates, routing lost money and the - dashboard has to be able to say so. Zero when both sides resolve to the same - deployment, or when either cannot be resolved or priced. - - Only one side of this subtraction is a counterfactual. What the request cost on the - model that served it is a number the operator was actually billed, and the cost - calculator already wrote it down, so ``cost_breakdown`` is read rather than - re-derived. Recomputing it means restating every pricing dimension the biller - applied, and each one omitted is a silent disagreement with the ``spend`` column - beside it; a request billed at a priority tier recomputed at standard rates reads as - half its real cost. - - The baseline has no such record, since it never ran, so it is priced through the same - cost engine on the basis the biller used for this request. An operator running that - one model instead of the router would have sent this request to the same tier and the - same region, because both are properties of the request and the deployment's - contract, not of which model the router happened to pick. - - ``conversation_continuing`` says whether the baseline would already have had this - prompt cached. It defaults to True because that is the conservative reading: a - request whose shape the router could not determine is charged the write and - under-claims rather than inflating a savings figure. - """ - # No provider argument for the baseline on purpose: it arrives from the routing - # metadata as a single self-describing string, already qualified by the auto-router, - # so there is no second field that could disagree with it. + baseline_usage: Usage | None = None, + baseline_provenance: Literal["observed_initial", "modeled"] | None = None, +) -> float | None: + """Price established baseline usage; conversation shape cannot establish cache warmth.""" baseline: Final = _resolve_model(baseline_model, None) selected: Final = _resolve_model(selected_model, selected_provider) if baseline is None or selected is None: - return 0.0 - same_target: Final = ( - baseline_deployment_id == selected_deployment_id - if baseline_deployment_id and selected_deployment_id - else baseline == selected - ) - if same_target: - return 0.0 + return None + if baseline_usage is None and any(_cache_token_split(usage)): + return None basis: Final = _pricing_basis(cost_breakdown) effective_baseline_info: Final = baseline_info if baseline_info is not None else _model_info(baseline) + modeled_usage: Final = baseline_usage if baseline_usage is not None else usage baseline_cost: Final = _cost_of_usage( - baseline, - _baseline_usage(usage, conversation_continuing, effective_baseline_info), - effective_baseline_info, - basis, + baseline, _baseline_usage(modeled_usage, effective_baseline_info), effective_baseline_info, basis + ) + recorded_selected_cost: Final = _recorded_token_cost(cost_breakdown) + selected_cost: Final = ( + recorded_selected_cost + if recorded_selected_cost is not None + else _cost_of_usage(selected, usage, selected_info, basis) ) - # Falls back to pricing the request only when the biller recorded nothing, which is - # every row written before the breakdown carried its basis. - selected_cost = _recorded_token_cost(cost_breakdown) - if selected_cost is None: - selected_cost = _cost_of_usage(selected, usage, selected_info, basis) if baseline_cost is None or selected_cost is None: - return 0.0 - return baseline_cost - selected_cost + return None + if baseline_provenance == "observed_initial": + same_prices: Final = effective_baseline_info == ( + selected_info if selected_info is not None else _model_info(selected) + ) + equivalent: Final = ( + baseline_usage is not None + and baseline_usage == usage + and baseline == selected + and bool(baseline_deployment_id) + and baseline_deployment_id == selected_deployment_id + and same_prices + and recorded_selected_cost is not None + and isclose(baseline_cost, recorded_selected_cost, rel_tol=1e-9, abs_tol=1e-12) + ) + return 0.0 if equivalent else None + difference: Final = baseline_cost - selected_cost + return difference if isfinite(difference) else None def _usage_from_spend_log(usage_object: Mapping[str, object] | None) -> Usage | None: @@ -463,11 +472,23 @@ def _proxy_llm_router() -> "Router | None": def _numeric_savings(value: object) -> float | None: """``value`` as a recorded savings figure, or ``None`` when it is not one.""" - if isinstance(value, bool) or not isinstance(value, (int, float)): + if isinstance(value, bool) or not isinstance(value, (int, float)) or not isfinite(value): return None return float(value) +def recorded_estimated_autorouter_savings(metadata: Mapping[str, object]) -> float | None: + estimate: Final = metadata.get("autorouter_savings_estimate") + if ( + not isinstance(estimate, Mapping) + or type(estimate.get("version")) is not int + or estimate.get("version") not in (1, 2, 3) + or estimate.get("status") != "estimated" + ): + return None + return _numeric_savings(metadata.get("autorouter_savings")) + + def classifier_cost_from_decision(routing_decision: Mapping[str, object] | None) -> float | None: """The LLM-classifier cost a routing decision recorded, or ``None`` when it holds none. @@ -490,22 +511,10 @@ def autorouter_savings_for_request( model_id: str | None = None, llm_router: "Callable[[], Router | None] | None" = None, cost_breakdown: Mapping[str, object] | None = None, + baseline_usage: Usage | None = None, + baseline_provenance: Literal["observed_initial", "modeled"] | None = None, ) -> float | None: - """Auto-router savings for one request, net of the classifier call that routed it, - or ``None`` when the driver is off. - - ``None`` and ``0.0`` are different facts: ``None`` means this request cannot carry a - figure at all (no routing decision, no baseline, unusable usage), while ``0.0`` is a - real figure for a routed request whose baseline resolved to the served deployment. - Never raises: pricing failures inside degrade to zero, and the driver-off cases - return ``None``, so this is safe on the logging path where a raise would fail the - request's logging. - - The classifier deduction lives here, at the figure's one computation owner, rather - than in any reader: the stamped ``autorouter_savings`` is then already net, so the - session rollup, the daily tables and every logging consumer agree without each - re-deriving the deduction, and the recorded-figure-wins path cannot deduct twice. - """ + """Return net savings for established usage, or None when the estimate is unavailable.""" usage: Final = _usage_from_spend_log(usage_object) if usage is None or not model: return None @@ -522,15 +531,16 @@ def autorouter_savings_for_request( selected_model=model, selected_provider=custom_llm_provider, usage=usage, - # Absent means the router never recorded a shape, which is the conservative - # reading: charge the cache write rather than claim a first turn's saving. - conversation_continuing=decision.get("conversation_continuing") is not False, selected_info=_effective_model_info(router_instance, model_id, model or ""), baseline_info=_effective_model_info(router_instance, baseline_id, baseline_model or ""), cost_breakdown=cost_breakdown, baseline_deployment_id=baseline_id, selected_deployment_id=model_id, + baseline_usage=baseline_usage, + baseline_provenance=baseline_provenance, ) + if gross is None: + return None classifier_cost: Final = classifier_cost_from_decision(decision) return gross if classifier_cost is None else gross - classifier_cost @@ -542,6 +552,8 @@ def autorouter_savings_for_logging_payload( model_id: str | None, usage_object: Mapping[str, object] | None, cost_breakdown: Mapping[str, object] | None, + baseline_usage: Usage | None = None, + baseline_provenance: Literal["observed_initial", "modeled"] | None = None, ) -> float | None: """The figure the logging payload records for a request, or ``None`` when none should be. @@ -561,6 +573,8 @@ def autorouter_savings_for_logging_payload( model_id=model_id, llm_router=_proxy_llm_router, cost_breakdown=cost_breakdown, + baseline_usage=baseline_usage, + baseline_provenance=baseline_provenance, ) @@ -575,6 +589,7 @@ def compute_savings_spend( llm_router: "Callable[[], Router | None] | None" = None, cost_breakdown: Mapping[str, object] | None = None, recorded_autorouter_savings: object = None, + recorded_autorouter_savings_estimate: Mapping[str, object] | None = None, billed_at: datetime | str | None = None, ) -> SavingsSpend: """ @@ -604,11 +619,9 @@ def compute_savings_spend( figure is normally the smaller of the two, being a subset of the same requests, but not always: a request that only writes cache and never reads it has negative net savings, and dropping such a request from the attributed figure can lift it above - the total. Auto-router savings compare the - served ``model`` against the counterfactual baseline the router recorded on - its ``routing_decision``, and are zero unless the two differ. That record - also says whether the conversation was already underway, which is what tells - a mid-conversation switch from a first turn. + the total. Auto-router savings compare established baseline usage against the + recorded selected-model cost. Versioned unknown estimates contribute no dollars + to this subtotal and are excluded from the separately reported coverage cohort. ``llm_router`` is passed as a provider rather than a router because every spend write calls this and only auto-routed ones need one, so looking it up eagerly at the call @@ -653,10 +666,21 @@ def compute_savings_spend( # The figure the logging path recorded wins, before the usage gate on purpose: a row # whose usage no longer parses still carries the number computed when it did. - recorded_savings: Final = _numeric_savings(recorded_autorouter_savings) + recorded_savings: Final = ( + recorded_estimated_autorouter_savings( + MappingProxyType( + { + "autorouter_savings": recorded_autorouter_savings, + "autorouter_savings_estimate": recorded_autorouter_savings_estimate, + } + ) + ) + if recorded_autorouter_savings_estimate is not None + else _numeric_savings(recorded_autorouter_savings) + ) autorouter: Final = ( recorded_savings - if recorded_savings is not None + if recorded_savings is not None or recorded_autorouter_savings_estimate is not None else autorouter_savings_for_request( model=model, custom_llm_provider=custom_llm_provider, diff --git a/litellm/proxy/spend_tracking/spend_tracking_utils.py b/litellm/proxy/spend_tracking/spend_tracking_utils.py index 9756844b587..8f85ecdd480 100644 --- a/litellm/proxy/spend_tracking/spend_tracking_utils.py +++ b/litellm/proxy/spend_tracking/spend_tracking_utils.py @@ -9,7 +9,7 @@ from functools import reduce from types import MappingProxyType from typing import TYPE_CHECKING, Final, Literal, Protocol, cast, runtime_checkable -from pydantic import BaseModel +from pydantic import BaseModel, JsonValue import litellm from litellm._logging import verbose_proxy_logger @@ -137,7 +137,15 @@ def _get_router_metadata_for_spend_log( ) -_STAMPED_METADATA_KEYS: Final = frozenset(("router_metadata", "azure_spillover")) +_STAMPED_METADATA_KEYS: Final = frozenset( + ( + "router_metadata", + "azure_spillover", + "autorouter_savings", + "autorouter_savings_estimate", + "autorouter_baseline_observation", + ) +) def _get_spend_logs_metadata( @@ -156,6 +164,8 @@ def _get_spend_logs_metadata( cost_breakdown: CostBreakdown | None = None, litellm_call_id: str | None = None, autorouter_savings: float | None = None, + autorouter_savings_estimate: Mapping[str, JsonValue] | None = None, + autorouter_baseline_observation: str | None = None, router_metadata: SpendLogsRouterMetadata | None = None, azure_spillover: AzureSpillover | None = None, ) -> SpendLogsMetadata: @@ -196,6 +206,8 @@ def _get_spend_logs_metadata( cost_breakdown=None, compression_savings=None, autorouter_savings=autorouter_savings, + autorouter_savings_estimate=autorouter_savings_estimate, + autorouter_baseline_observation=autorouter_baseline_observation, litellm_gateway_injected_cache=None, litellm_call_id=litellm_call_id, router_metadata=router_metadata, @@ -207,7 +219,12 @@ def _get_spend_logs_metadata( # Filter the metadata dictionary to include only the specified keys clean_metadata: Final = SpendLogsMetadata( - **{key: metadata.get(key) for key in SpendLogsMetadata.__annotations__ if key not in _STAMPED_METADATA_KEYS}, + **MappingProxyType( + {key: metadata.get(key) for key in SpendLogsMetadata.__annotations__ if key not in _STAMPED_METADATA_KEYS} + ), + autorouter_savings=autorouter_savings, + autorouter_savings_estimate=autorouter_savings_estimate, + autorouter_baseline_observation=autorouter_baseline_observation, router_metadata=router_metadata, azure_spillover=azure_spillover, ) @@ -231,7 +248,6 @@ def _get_spend_logs_metadata( clean_metadata["cold_storage_object_key"] = cold_storage_object_key clean_metadata["litellm_overhead_time_ms"] = litellm_overhead_time_ms clean_metadata["cost_breakdown"] = cost_breakdown - clean_metadata["autorouter_savings"] = autorouter_savings clean_metadata["litellm_call_id"] = litellm_call_id return clean_metadata @@ -660,6 +676,16 @@ def get_logging_payload( autorouter_savings=( standard_logging_payload.get("autorouter_savings", None) if standard_logging_payload is not None else None ), + autorouter_savings_estimate=( + standard_logging_payload.get("autorouter_savings_estimate") + if standard_logging_payload is not None + else None + ), + autorouter_baseline_observation=( + standard_logging_payload.get("autorouter_baseline_observation") + if standard_logging_payload is not None + else None + ), litellm_call_id=litellm_call_id, router_metadata=_get_router_metadata_for_spend_log( metadata=metadata, diff --git a/litellm/proxy/ui_crud_endpoints/proxy_setting_endpoints.py b/litellm/proxy/ui_crud_endpoints/proxy_setting_endpoints.py index b2baef126e9..a972f08b8bf 100644 --- a/litellm/proxy/ui_crud_endpoints/proxy_setting_endpoints.py +++ b/litellm/proxy/ui_crud_endpoints/proxy_setting_endpoints.py @@ -6,6 +6,7 @@ from collections import Counter from collections.abc import Mapping, MutableMapping, Sequence from types import MappingProxyType from typing import ( + Annotated, Final, NamedTuple, Protocol, @@ -477,6 +478,72 @@ class MCPToolSearchSettingsResponse(SettingsResponse): """Response model for native MCP tool search settings""" +class WebSearchInterceptionSettings(BaseModel): + """Configuration for server-side web search interception""" + + enabled: bool = Field( + default=False, + description="Serve web search tool calls from a configured search tool instead of passing them upstream", + ) + + enabled_providers: list[str] = Field( + default_factory=list, + description="LLM providers to intercept for (e.g. 'bedrock', 'vertex_ai'). Empty intercepts Bedrock only.", + ) + + search_tool_name: str | None = Field( + default=None, + description="Name of the configured search tool to run searches through. Empty uses the first one available.", + ) + + max_agentic_loops: int | None = Field( + default=None, + ge=1, + description="How many follow-up model calls one intercepted request may chain. Empty applies the default of 3.", + ) + + +class WebSearchInterceptionSettingsResponse(SettingsResponse): + """Response model for web search interception settings""" + + +def _with_websearch_enabled_resolved(config: Mapping[str, object]) -> dict[str, object]: + """ + Answer with the stored flag when there is one, and only otherwise with what + this process is running. + + A stored flag is the cluster's own answer, so it is the same on every pod and + is safe for the page to send back on save. Deriving the answer from this + process instead would report off on a pod that has not polled yet, and the + next save would persist that as a cluster-wide off. Without a stored flag the + only available answer is local: litellm_settings.callbacks activates + interception without storing one, and a write through the generic config + endpoint can drop the flag from a block that is still live. Reporting the + field default there would claim the feature is off while it serves. + """ + from litellm.integrations.websearch_interception.handler import ( + WebSearchInterceptionLogger, + ) + + litellm_settings: Final[Mapping[str, object]] = _as_settings_section(config.get("litellm_settings")) + stored: Final[Mapping[str, object]] = _as_settings_section(litellm_settings.get("websearch_interception_params")) + if "enabled" in stored: + return dict(config) + + resolved: Final = { + **stored, + "enabled": bool(litellm.logging_callback_manager.get_custom_loggers_for_type(WebSearchInterceptionLogger)), + } + return { + **config, + "litellm_settings": {**litellm_settings, "websearch_interception_params": resolved}, + } + + +def _as_settings_section(value: object) -> Mapping[str, object]: + return cast("Mapping[str, object]", value) if isinstance(value, Mapping) else MappingProxyType({}) + + @router.get( "/get/allowed_ips", tags=["Budget & Spend Tracking"], @@ -875,7 +942,13 @@ async def update_default_team_member_budget(teams: list[NewUserRequestTeam], use async def _update_litellm_setting( - settings: DefaultInternalUserParams | DefaultTeamSSOParams | MCPSemanticFilterSettings | MCPToolSearchSettings, + settings: ( + DefaultInternalUserParams + | DefaultTeamSSOParams + | MCPSemanticFilterSettings + | MCPToolSearchSettings + | WebSearchInterceptionSettings + ), settings_key: str, success_message: str, user_api_key_dict: UserAPIKeyAuth, @@ -1399,6 +1472,77 @@ async def update_mcp_semantic_filter_settings( return result +@router.get( + "/get/websearch_interception_settings", + tags=["Settings"], + dependencies=[Depends(user_api_key_auth)], + response_model=WebSearchInterceptionSettingsResponse, +) +async def get_websearch_interception_settings( + user_api_key_dict: Annotated[UserAPIKeyAuth, Depends(user_api_key_auth)], +): + """ + Get web search interception configuration. + + Returns the current settings plus their schema, for the Admin UI to render. + """ + from litellm.proxy.proxy_server import prisma_client, proxy_config + + if prisma_client is None: + raise HTTPException( + status_code=500, + detail={"error": "Database not connected. Please connect a database."}, + ) + + config: Final = await proxy_config.get_config() + + return await _get_settings_with_schema( + settings_key="websearch_interception_params", + settings_class=WebSearchInterceptionSettings, + config=_with_websearch_enabled_resolved(config), + ) + + +@router.patch( + "/update/websearch_interception_settings", + tags=["Settings"], + dependencies=[Depends(user_api_key_auth)], +) +async def update_websearch_interception_settings( + settings: WebSearchInterceptionSettings, + user_api_key_dict: Annotated[UserAPIKeyAuth, Depends(user_api_key_auth)], +): + """ + Update web search interception settings in database. + + Settings will be picked up by all pods within approximately 10 seconds via background polling. + """ + if user_api_key_dict.user_role != LitellmUserRoles.PROXY_ADMIN: + raise HTTPException( + status_code=403, + detail="Only proxy admins can update web search interception settings.", + ) + + result: Final = await _update_litellm_setting( + settings=settings, + settings_key="websearch_interception_params", + success_message=( + "Web search interception settings updated successfully. " + "Changes will be applied across all pods within 10 seconds." + ), + user_api_key_dict=user_api_key_dict, + ) + try: + from litellm.proxy.proxy_server import prisma_client, proxy_config + + if prisma_client is not None: + await proxy_config.init_websearch_interception_settings_in_db(prisma_client=prisma_client) + except Exception as e: + verbose_proxy_logger.warning("Failed to reinitialize web search interception settings immediately: %s", e) + + return result + + @router.get( "/get/mcp_tool_search_settings", tags=["Settings"], # mutable-ok: FastAPI's route decorator only accepts a list diff --git a/litellm/proxy/utils.py b/litellm/proxy/utils.py index 434a6179d14..2ecce7725e5 100644 --- a/litellm/proxy/utils.py +++ b/litellm/proxy/utils.py @@ -249,6 +249,7 @@ if TYPE_CHECKING: from litellm.llms.base_llm.guardrail_translation.base_translation import BaseTranslation from litellm.models.team import LiteLLM_TeamTableCachedObj from litellm.proxy.db.autorouter_session_rollup import AutoRouterTurnTransaction + from litellm.proxy.db.baseline_accounting import BaselineAccountingRecord from litellm.proxy.db.spend_log_tool_index import ToolUsageTransaction from litellm.repositories.prisma_protocols import TableActions from litellm.types.proxy.policy_engine.pipeline_types import GuardrailPipeline @@ -471,12 +472,16 @@ def _record_raising_guardrail(request_data: Mapping[str, object], callback: obje class _UpstreamStreamBoundary(Generic[_T]): - __slots__ = ("_upstream", "failure") + __slots__ = ("_source", "_upstream", "failure") def __init__(self, upstream: AsyncIterable[_T]) -> None: + self._source: Final = upstream self._upstream: Final = upstream.__aiter__() self.failure: BaseException | None = None + def __getattr__(self, name: str) -> object: + return getattr(self._source, name) + def __aiter__(self) -> "_UpstreamStreamBoundary[_T]": return self @@ -3037,6 +3042,10 @@ class ProxyLogging: Otherwise, returns None and the original exception is used. """ + logging_obj: Final[object] = request_data.get("litellm_logging_obj") # pyright: ignore[reportUnknownVariableType, reportUnknownMemberType] # legacy request data is narrowed to Logging below + if isinstance(logging_obj, Logging) and logging_obj.baseline_cache_context is not None: + await logging_obj.invalidate_baseline_cache_estimate("failed_request", completed=True) + ### ALERTING ### await self.update_request_status(litellm_call_id=request_data.get("litellm_call_id", ""), status="fail") if AlertType.llm_exceptions in self.alert_types and not _is_client_error_exception(original_exception): @@ -4190,6 +4199,10 @@ class PrismaClient: http_client: "HttpConfig | None" = None, ): ## init logging object + self.baseline_accounting_transactions: list[ + BaselineAccountingRecord + ] = [] # mutable-ok: locked background queue + self.baseline_accounting_lock: Final = asyncio.Lock() self.proxy_logging_obj = proxy_logging_obj self.token_auth: DatabaseTokenAuth | None = resolve_database_token_auth() verbose_proxy_logger.debug("Creating Prisma Client..") @@ -7204,7 +7217,15 @@ async def _total_queued_spend_transactions(prisma_client: PrismaClient) -> int: autorouter_queue_size: Final = len(prisma_client.autorouter_turn_transactions) from litellm.proxy.db.shadow_eval_funnel import pending_shadow_eval_funnel_events - return spend_queue_size + tool_queue_size + autorouter_queue_size + pending_shadow_eval_funnel_events() + async with prisma_client.baseline_accounting_lock: + baseline_queue_size: Final = len(prisma_client.baseline_accounting_transactions) + return ( + spend_queue_size + + tool_queue_size + + autorouter_queue_size + + baseline_queue_size + + pending_shadow_eval_funnel_events() + ) async def update_daily_tag_spend( @@ -7263,7 +7284,10 @@ async def update_spend_logs_job( This job is triggered based on queue size rather than time. Pops the batch once, writes spend logs, then runs guardrail usage tracking. """ + from litellm.proxy.db.baseline_accounting import flush_baseline_accounting + if await _total_queued_spend_transactions(prisma_client) == 0: + await flush_baseline_accounting(prisma_client) return async with prisma_client.spend_log_write_lock: await _run_spend_logs_job(prisma_client, db_writer_client, proxy_logging_obj) @@ -7274,6 +7298,8 @@ async def _run_spend_logs_job( db_writer_client: AsyncHTTPHandler | None, proxy_logging_obj: ProxyLogging, ) -> None: + from litellm.proxy.db.baseline_accounting import flush_baseline_accounting + n_retry_times: Final = 3 MAX_LOGS_PER_INTERVAL: Final = 10000 @@ -7331,6 +7357,8 @@ async def _run_spend_logs_job( tool_tracking_err, ) + await flush_baseline_accounting(prisma_client) + async with prisma_client._autorouter_turn_transactions_lock: autorouter_turns_to_process: Final = prisma_client.autorouter_turn_transactions[:MAX_LOGS_PER_INTERVAL] remaining_autorouter_turns: Final = prisma_client.autorouter_turn_transactions[ @@ -7473,7 +7501,9 @@ async def _monitor_spend_logs_queue( proxy_logging_obj=proxy_logging_obj, ) else: - # Exponential backoff when no logs to process + from litellm.proxy.db.baseline_accounting import flush_baseline_accounting + + await flush_baseline_accounting(prisma_client) current_interval = min(current_interval * backoff_multiplier, max_backoff) if await _wait_for_spend_log_flush_request(flush_requested, current_interval): diff --git a/litellm/repositories/managed_batch_repository.py b/litellm/repositories/managed_batch_repository.py new file mode 100644 index 00000000000..3f85251fdbd --- /dev/null +++ b/litellm/repositories/managed_batch_repository.py @@ -0,0 +1,48 @@ +from collections.abc import Mapping +from typing import TYPE_CHECKING, Final + +from litellm.repositories.table_repositories import PrismaTableRepository +from litellm.types.utils import LiteLLMBatch + +if TYPE_CHECKING: + from prisma import models as prisma_models + + +def _batch_of(blob: object) -> LiteLLMBatch: + return LiteLLMBatch.model_validate_json(blob) if isinstance(blob, str) else LiteLLMBatch.model_validate(blob) + + +class ManagedBatchRepository(PrismaTableRepository["prisma_models.LiteLLM_ManagedObjectTable"]): + table_name = "litellm_managedobjecttable" + + async def load_batch(self, unified_batch_id: str) -> LiteLLMBatch | None: + row: Final = await self._find_row(unified_batch_id) + return None if row is None or not row.file_object else _batch_of(row.file_object) + + async def load_status(self, unified_batch_id: str) -> str | None: + row: Final = await self._find_row(unified_batch_id) + return row.status if row is not None else None + + async def compare_and_set( + self, batch: LiteLLMBatch, unchanged: Mapping[str, object], updated_by: str | None + ) -> bool: + updated_rows: Final = await self.table.update_many( + where={"unified_object_id": batch.id, **unchanged}, # mutable-ok: prisma filters are plain dicts + data={ # mutable-ok: prisma payloads are plain dicts + "file_object": batch.model_dump_json(), + "status": batch.status, + "updated_by": updated_by, + }, + ) + return updated_rows > 0 + + async def touch(self, unified_batch_id: str, updated_by: str | None) -> None: + await self.table.update_many( + where={"unified_object_id": unified_batch_id}, # mutable-ok: prisma filters are plain dicts + data={"updated_by": updated_by}, # mutable-ok: prisma payloads are plain dicts + ) + + async def _find_row(self, unified_batch_id: str) -> "prisma_models.LiteLLM_ManagedObjectTable | None": + return await self.table.find_first( + where={"unified_object_id": unified_batch_id} # mutable-ok: prisma filters are plain dicts + ) diff --git a/litellm/repositories/managed_file_content_repository.py b/litellm/repositories/managed_file_content_repository.py new file mode 100644 index 00000000000..c55d0060080 --- /dev/null +++ b/litellm/repositories/managed_file_content_repository.py @@ -0,0 +1,32 @@ +from typing import TYPE_CHECKING, Final + +from litellm.repositories.table_repositories import PrismaTableRepository + +if TYPE_CHECKING: + from prisma import models as prisma_models + + +class ManagedFileContentRepository(PrismaTableRepository["prisma_models.LiteLLM_ManagedFileContentTable"]): + table_name = "litellm_managedfilecontenttable" + + async def store(self, content: bytes) -> str: + from prisma import Base64 + + row: Final = await self.table.create( + data={"content": Base64.encode(content)} # mutable-ok: prisma payloads are plain dicts + ) + return row.id + + async def load(self, row_id: str) -> bytes | None: + row: Final[prisma_models.LiteLLM_ManagedFileContentTable | None] = await self.table.find_unique( + where={"id": row_id} # mutable-ok: prisma filters are plain dicts + ) + return None if row is None else row.content.decode() + + async def delete(self, row_id: str) -> None: + from prisma.errors import RecordNotFoundError + + try: + await self.table.delete(where={"id": row_id}) # mutable-ok: prisma filters are plain dicts + except RecordNotFoundError: + return diff --git a/litellm/router.py b/litellm/router.py index 3f3daaf2eae..300b069a464 100644 --- a/litellm/router.py +++ b/litellm/router.py @@ -13723,6 +13723,20 @@ class Router: to the deployment that actually served the request. Every attempt therefore writes or clears, never just writes. """ + from litellm.types.router import BaselineRouteStamp + + baseline_model: Final = routing_decision.get("savings_baseline_model") if routing_decision else None + baseline_id: Final = routing_decision.get("savings_baseline_deployment_id") if routing_decision else None + router_name: Final = routing_decision.get("router_model_name") if routing_decision else None + Router._stamp_or_clear_metadata_key( + request_kwargs=request_kwargs, + key="_autorouter_baseline_route", + value=( + BaselineRouteStamp(router_name, baseline_model, baseline_id) + if router_name and baseline_model and baseline_id + else None + ), + ) Router._stamp_or_clear_metadata_key( request_kwargs=request_kwargs, key="routing_decision", diff --git a/litellm/router_strategy/complexity_router/complexity_router.py b/litellm/router_strategy/complexity_router/complexity_router.py index c29f3b3a542..a3d6ccbd437 100644 --- a/litellm/router_strategy/complexity_router/complexity_router.py +++ b/litellm/router_strategy/complexity_router/complexity_router.py @@ -75,6 +75,7 @@ from litellm.types.utils import ( AUTOROUTER_CLASSIFIER_CALL_ORIGIN, ModelResponse, RoutingDecisionCause, + StandardLoggingHeuristicV2Forecast, StandardLoggingRoutingDecision, StandardLoggingRoutingDecisionTierBoundaries, ) @@ -1043,6 +1044,7 @@ class ClassificationOutcome(NamedTuple): capability_forecast: CapabilityClassifierForecast | None = None llm_v2_forecast: LLMV2Decision | None = None jev_verdict: JevVerdict | None = None + heuristic_v2_forecast: StandardLoggingHeuristicV2Forecast | None = None def _with_signal(outcome: ClassificationOutcome, signal: str | None) -> ClassificationOutcome: @@ -1075,6 +1077,8 @@ def _with_classifier_forecast( decision: StandardLoggingRoutingDecision, outcome: ClassificationOutcome ) -> StandardLoggingRoutingDecision: """Attach validated forecasts and their applied policy to the routing decision.""" + if outcome.heuristic_v2_forecast is not None: + return {**decision, "heuristic_v2_forecast": outcome.heuristic_v2_forecast} if outcome.jev_verdict is not None: forecasted_decision: Final[StandardLoggingRoutingDecision] = { **decision, @@ -1772,6 +1776,7 @@ class ComplexityRouter(CustomLogger): conversation_continuing: bool = True, tier_litellm_params: Mapping[str, object] | None = None, context_escalation_original_tier: ComplexityTier | str | None = None, + heuristic_v2_forecast: StandardLoggingHeuristicV2Forecast | None = None, ) -> StandardLoggingRoutingDecision: """Assemble the per-request provenance record for this router's decision. @@ -1831,7 +1836,9 @@ class ComplexityRouter(CustomLogger): masked_tier_litellm_params: Final = mask_credentials_in_payload(tier_litellm_params) if isinstance(masked_tier_litellm_params, Mapping): decision["tier_litellm_params"] = masked_tier_litellm_params - return decision + return ( + decision if heuristic_v2_forecast is None else {**decision, "heuristic_v2_forecast": heuristic_v2_forecast} + ) async def aclassify( self, @@ -1888,6 +1895,15 @@ class ComplexityRouter(CustomLogger): score=None, signals=(f"request-type:{request_type.value}", *probability_signals), cause="heuristic_v2", + heuristic_v2_forecast=StandardLoggingHeuristicV2Forecast( + probabilities={ + candidate.value: prediction.probabilities[index] + for index, candidate in enumerate(TIER_SEVERITY_ORDER, start=1) + }, + threshold=predictor.routing_threshold, + predicted_tier=tier.value, + request_type=request_type.value, + ), ) async def _classify_heuristic_first( @@ -3553,6 +3569,7 @@ class ComplexityRouter(CustomLogger): context_escalation_original_tier=( decision.get("context_escalation_original_tier") if decision is not None else None ), + heuristic_v2_forecast=decision.get("heuristic_v2_forecast") if decision is not None else None, ) from litellm.types.router import PreRoutingHookResponse as HookResponse @@ -3732,6 +3749,7 @@ class ComplexityRouter(CustomLogger): conversation_continuing=bool(decision.get("conversation_continuing", True)), tier_litellm_params=self._litellm_params_for_model(candidate_tier, new_model), context_escalation_original_tier=decision.get("context_escalation_original_tier"), + heuristic_v2_forecast=decision.get("heuristic_v2_forecast"), ) return response.model_copy( update={ # mutable-ok: model_copy types update as a plain dict @@ -3776,6 +3794,7 @@ class ComplexityRouter(CustomLogger): conversation_continuing=bool(decision.get("conversation_continuing", True)), tier_litellm_params=self._litellm_params_for_model(None, default_model), context_escalation_original_tier=decision.get("context_escalation_original_tier"), + heuristic_v2_forecast=decision.get("heuristic_v2_forecast"), ) return response.model_copy( update={ # mutable-ok: model_copy types update as a plain dict diff --git a/litellm/router_strategy/complexity_router/fuse_presets.json b/litellm/router_strategy/complexity_router/fuse_presets.json new file mode 100644 index 00000000000..4006366dc25 --- /dev/null +++ b/litellm/router_strategy/complexity_router/fuse_presets.json @@ -0,0 +1,100 @@ +{ + "version": "2026-09-17-v1", + "models": [ + { + "id": "gpt-6-astra-v1", + "label": "GPT-6 Astra", + "model": "gpt-6-astra", + "text": "OpenAI model for demanding end-to-end work, including reasoning, coding, research, and document tasks", + "sources": ["https://developers.openai.com/api/docs/models/gpt-6-astra"] + }, + { + "id": "gpt-5.6-sol-v1", + "label": "GPT-5.6 Sol", + "model": "gpt-5.6-sol", + "text": "OpenAI model for complex professional work, supporting reasoning and tool calling", + "sources": ["https://developers.openai.com/api/docs/models/gpt-5.6-sol"] + }, + { + "id": "gpt-5.6-luna-v1", + "label": "GPT-5.6 Luna", + "model": "gpt-5.6-luna", + "text": "OpenAI model for high-volume workloads, supporting reasoning and tool calling", + "sources": ["https://developers.openai.com/api/docs/models/gpt-5.6-luna"] + }, + { + "id": "gpt-5.6-terra-v1", + "label": "GPT-5.6 Terra", + "model": "gpt-5.6-terra", + "text": "OpenAI general-purpose model supporting reasoning, text and image input, and tool calling", + "sources": ["https://developers.openai.com/api/docs/models/gpt-5.6-terra"] + }, + { + "id": "claude-haiku-4-5-v1", + "label": "Claude Haiku 4.5", + "model": "claude-haiku-4-5", + "text": "Anthropic latency-focused model supporting text and image input, tool use, and extended thinking", + "sources": ["https://platform.claude.com/docs/en/models/haiku-4-5/overview"] + }, + { + "id": "claude-sonnet-5-v1", + "label": "Claude Sonnet 5", + "model": "claude-sonnet-5", + "text": "Anthropic model balancing speed and capability, with adaptive thinking and tool use", + "sources": ["https://platform.claude.com/docs/en/models/sonnet-5/overview"] + }, + { + "id": "claude-opus-5-v1", + "label": "Claude Opus 5", + "model": "claude-opus-5", + "text": "Anthropic model for complex agentic coding and enterprise work, with adaptive thinking", + "sources": ["https://platform.claude.com/docs/en/models/opus-5/overview"] + }, + { + "id": "claude-fable-5-v1", + "label": "Claude Fable 5", + "model": "claude-fable-5", + "text": "Anthropic model for demanding reasoning and long-running agent tasks, with always-on adaptive thinking", + "sources": ["https://platform.claude.com/docs/en/models/fable-5/introducing-claude-fable-5-and-claude-mythos-5"] + }, + { + "id": "claude-fable-5-1-v1", + "label": "Claude Fable 5.1", + "model": "claude-fable-5-1", + "text": "Anthropic model for demanding reasoning, long-running agentic coding, and multistep research, with always-on adaptive thinking", + "sources": ["https://platform.claude.com/docs/en/models/fable-5-1/overview"] + } + ], + "harnesses": [ + { + "id": "unspecified-v1", + "label": "Unspecified runtime", + "text": "Agent runtime is unspecified. Assess the task using the supplied context without assuming repository access, runnable tests, network access, additional tools, or a step, time, or spending budget", + "sources": ["https://code.claude.com/docs/en/how-claude-code-works", "https://mini-swe-agent.com/latest/faq/"] + }, + { + "id": "claude-code-v1", + "label": "Claude Code", + "text": "Claude Code supplies an agent loop with context management and configured tools. Available actions depend on the session's tools, permissions, and execution environment. The runtime name alone does not establish repository access, runnable tests, network access, additional tools, or a step, time, or spending budget", + "sources": ["https://code.claude.com/docs/en/how-claude-code-works"] + }, + { + "id": "codex-cli-v1", + "label": "Codex CLI", + "text": "Codex CLI supplies a terminal-based coding agent. File operations, command execution, and integrations depend on the session's tools, permissions, and sandbox. The runtime name alone does not establish repository access, runnable tests, network access, additional tools, or a step, time, or spending budget", + "sources": ["https://learn.chatgpt.com/docs/codex/cli", "https://learn.chatgpt.com/codex/permissions"] + }, + { + "id": "opencode-v1", + "label": "OpenCode", + "text": "OpenCode supplies a configurable agent runtime. Available actions depend on the selected agent, tools, permissions, and execution environment. The runtime name alone does not establish repository access, runnable tests, network access, additional tools, or a step, time, or spending budget", + "sources": ["https://opencode.ai/docs/agents/"] + }, + { + "id": "mini-swe-agent-v1", + "label": "mini-SWE-agent", + "text": "The standard mini-SWE-agent setup uses a bash-only action interface and separate command executions. Available commands and resources depend on its configured environment. The runtime name alone does not establish repository access, runnable tests, network access, additional tools, or a step, time, or spending budget", + "sources": ["https://mini-swe-agent.com/latest/faq/"] + } + ] +} diff --git a/litellm/router_strategy/complexity_router/fuse_presets.py b/litellm/router_strategy/complexity_router/fuse_presets.py new file mode 100644 index 00000000000..66a96ec5ad5 --- /dev/null +++ b/litellm/router_strategy/complexity_router/fuse_presets.py @@ -0,0 +1,52 @@ +from functools import lru_cache +from importlib.resources import files +from typing import Annotated, Final, Literal, TypeAlias + +from pydantic import BaseModel, ConfigDict, Field, StringConstraints + +ProfileText: TypeAlias = Annotated[str, StringConstraints(strip_whitespace=True, min_length=1, max_length=4000)] + + +class FuseModelPreset(BaseModel): + model_config = ConfigDict(extra="forbid", frozen=True) + + id: str + label: str + text: ProfileText + sources: tuple[str, ...] = Field(min_length=1) + model: str + + +class FuseHarnessPreset(BaseModel): + model_config = ConfigDict(extra="forbid", frozen=True) + + id: str + label: str + text: ProfileText + sources: tuple[str, ...] = Field(min_length=1) + + +class FusePresetCatalog(BaseModel): + model_config = ConfigDict(extra="forbid", frozen=True) + + version: str + models: tuple[FuseModelPreset, ...] + harnesses: tuple[FuseHarnessPreset, ...] + + +@lru_cache(maxsize=1) +def get_fuse_presets() -> FusePresetCatalog: + return FusePresetCatalog.model_validate_json( + files(__package__).joinpath("fuse_presets.json").read_text(encoding="utf-8") + ) + + +def resolve_fuse_profile(text: str | None, preset_id: str | None, kind: Literal["model", "harness"]) -> str | None: + if preset_id is None: + return text + catalog: Final = get_fuse_presets() + presets: Final = catalog.models if kind == "model" else catalog.harnesses + preset: Final = next((entry for entry in presets if entry.id == preset_id), None) + if preset is None: + return None + return text if text is not None else preset.text diff --git a/litellm/router_strategy/complexity_router/llm_v2.py b/litellm/router_strategy/complexity_router/llm_v2.py index 2f545a65aaa..18351237e65 100644 --- a/litellm/router_strategy/complexity_router/llm_v2.py +++ b/litellm/router_strategy/complexity_router/llm_v2.py @@ -7,15 +7,15 @@ from dataclasses import dataclass from sys import float_info from typing import Annotated, Final, Literal, TypeAlias -from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StringConstraints, TypeAdapter +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StringConstraints, TypeAdapter, model_validator from typing_extensions import ReadOnly, TypedDict from litellm.llms.base_llm.base_utils import ( type_to_response_format_param, # pyright: ignore[reportUnknownVariableType] # legacy output validated below ) +from litellm.router_strategy.complexity_router.fuse_presets import ProfileText, resolve_fuse_profile ShortText: TypeAlias = Annotated[str, StringConstraints(strip_whitespace=True, min_length=1, max_length=512)] -ProfileText: TypeAlias = Annotated[str, StringConstraints(strip_whitespace=True, min_length=1, max_length=4000)] class _SolverProfile(TypedDict): @@ -139,20 +139,41 @@ class LLMV2Config(BaseModel): efficient_tier: str = "SIMPLE" capable_tier: str = "REASONING" - efficient_profile: ProfileText - capable_profile: ProfileText - harness: ProfileText + efficient_profile: ProfileText | None = None + capable_profile: ProfileText | None = None + harness: ProfileText | None = None + efficient_profile_preset: str | None = None + capable_profile_preset: str | None = None + harness_preset: str | None = None max_quality_gap: float = Field(ge=0.0, le=1.0, description="Maximum estimated success loss allowed for efficient.") max_output_tokens: int = Field(default=1024, ge=1) response_format: Literal["json_schema", "json_object"] = "json_schema" calibration: LLMV2Calibration | None = None + @model_validator(mode="after") + def validate_profiles(self) -> LLMV2Config: + self._profile_texts() + return self + + def _profile_texts(self) -> tuple[str, str, str]: + efficient: Final = resolve_fuse_profile(self.efficient_profile, self.efficient_profile_preset, "model") + capable: Final = resolve_fuse_profile(self.capable_profile, self.capable_profile_preset, "model") + harness: Final = resolve_fuse_profile(self.harness, self.harness_preset, "harness") + if efficient is None: + raise ValueError("efficient_profile requires text or a known efficient_profile_preset") + if capable is None: + raise ValueError("capable_profile requires text or a known capable_profile_preset") + if harness is None: + raise ValueError("harness requires text or a known harness_preset") + return efficient, capable, harness + def system_prompt(self, efficient_model: str, capable_model: str) -> str: + efficient, capable, harness = self._profile_texts() profiles: Final[_SolverProfiles] = { "prompt_version": LLM_V2_PROMPT_VERSION, - "harness": self.harness, - "efficient": {"model": efficient_model, "profile": self.efficient_profile}, - "capable": {"model": capable_model, "profile": self.capable_profile}, + "harness": harness, + "efficient": {"model": efficient_model, "profile": efficient}, + "capable": {"model": capable_model, "profile": capable}, } schema: Final = ( "\n\nResponse JSON schema:\n" + json.dumps(LLMV2Verdict.model_json_schema()) diff --git a/litellm/rust_bridge/_native.pyi b/litellm/rust_bridge/_native.pyi index 9f959c056de..c0a06364261 100644 --- a/litellm/rust_bridge/_native.pyi +++ b/litellm/rust_bridge/_native.pyi @@ -9,6 +9,8 @@ from litellm.types.llms.anthropic_messages.anthropic_response import AnthropicMe class RustBridgeDeclined(Exception): ... class RustUpstreamError(Exception): ... +class ForkedAfterNativeRuntimeStarted(RuntimeError): ... +class ProcessReservedForForking(RuntimeError): ... def ocr( request: LiteLLMOcrRequest, @@ -101,8 +103,12 @@ class TokenCounter: def acount_request(self, body: bytes) -> Future[dict[str, object]]: ... def gil_stats() -> dict[str, int]: ... +def process_state_started() -> bool: ... +def reserve_process_for_forking() -> None: ... __all__ = [ + "ForkedAfterNativeRuntimeStarted", + "ProcessReservedForForking", "ResponsesWebSocketConnection", "RustBridgeDeclined", "RustUpstreamError", @@ -116,5 +122,7 @@ __all__ = [ "gil_stats", "messages", "ocr", + "process_state_started", + "reserve_process_for_forking", "transcription", ] diff --git a/litellm/rust_bridge/fork_guard.py b/litellm/rust_bridge/fork_guard.py new file mode 100644 index 00000000000..c94665fb8db --- /dev/null +++ b/litellm/rust_bridge/fork_guard.py @@ -0,0 +1,47 @@ +"""Fork safety of the Rust extension. + +Its runtime threads do not survive ``fork``, so a child forked after the first native call +cannot run native routes: it raises ``ForkedAfterNativeRuntimeStarted`` instead of hanging. +Fork before the first native call, or start workers with ``spawn`` / ``forkserver``. + +A process whose job is to fork workers (the gunicorn master under ``preload``) reserves itself: +from then on any native route called in it raises ``ProcessReservedForForking`` at the call +site, so the runtime can never start there. Workers forked from it are unaffected. +""" + +from __future__ import annotations + +from typing import Final + +from litellm.rust_bridge.loader import get_native_bridge + + +class NativeStateStartedBeforeFork(RuntimeError): + pass + + +class _NeverRaised(RuntimeError): + """Stands in for a native exception when the extension is unavailable or predates it.""" + + +_native: Final = get_native_bridge() +ForkedAfterNativeRuntimeStarted: Final[type[RuntimeError]] = getattr( + _native, "ForkedAfterNativeRuntimeStarted", _NeverRaised +) +ProcessReservedForForking: Final[type[RuntimeError]] = getattr(_native, "ProcessReservedForForking", _NeverRaised) + + +def reserve_process_for_forking(where: str) -> None: + """Forbid native routes in this process. Raises if one already ran here.""" + native: Final = get_native_bridge() + reserve: Final = getattr(native, "reserve_process_for_forking", None) + if not callable(reserve): + return + try: + reserve() + except RuntimeError as error: + raise NativeStateStartedBeforeFork( + f"The LiteLLM Rust extension already ran a native route in {where}, and its runtime " + "threads do not survive fork(). Move the native call (warm-up, health check, " + "import-time initialization) into the worker, after the fork." + ) from error diff --git a/litellm/types/llms/openai.py b/litellm/types/llms/openai.py index dd0518237c1..bc44eb5b5b7 100644 --- a/litellm/types/llms/openai.py +++ b/litellm/types/llms/openai.py @@ -512,6 +512,7 @@ class CreateBatchRequest(TypedDict, total=False): class LiteLLMBatchCreateRequest(CreateBatchRequest, total=False): model: str + disable_fallbacks: ReadOnly[bool] class RetrieveBatchRequest(TypedDict, total=False): diff --git a/litellm/types/management_endpoints/auto_router_endpoints.py b/litellm/types/management_endpoints/auto_router_endpoints.py index 9f29f27e41d..fd2202a1156 100644 --- a/litellm/types/management_endpoints/auto_router_endpoints.py +++ b/litellm/types/management_endpoints/auto_router_endpoints.py @@ -199,13 +199,20 @@ class AutoRouterBenchmarkTotals(BaseModel): description="Recorded LLM classifier cost already included in spend; null when any session turns predate " "subtotal recording, and zero for an empty window" ) - saved_spend: float = Field( - description="Signed dollars saved versus each router's savings baseline (derived from its hardest " - "tier, or the configured override), from the same per-request savings record the usage tab reads" + savings_estimated_turns: int = Field( + description="Turns covered by the current savings estimator; legacy estimates are excluded" + ) + savings_estimated_actual_spend: float = Field( + description="Actual spend, including classifier cost, for covered turns only" + ) + saved_spend: float | None = Field( + description="Signed savings for covered turns only; null when traffic has no current estimates" + ) + baseline_spend: float | None = Field(description="Estimated single-model cost for covered turns only") + saved_pct: float | None = Field(description="Covered savings over covered baseline spend, as a percentage") + saved_per_session: float | None = Field( + description="Average session savings; unavailable unless every turn is covered" ) - baseline_spend: float = Field(description="spend plus saved_spend: the estimated single-model cost") - saved_pct: float = Field(description="saved_spend over baseline_spend, as a percentage") - saved_per_session: float cache: AutoRouterCacheStats @@ -236,16 +243,27 @@ class AutoRouterSessionResponse(BaseModel): turns: int = Field(description="Auto-routed turns the rollup has recorded for this session so far") last_model: str = Field(description="The deployment model the most recent turn was routed to") spend: float = Field(description="What the session's routed traffic actually cost, classifier calls included") - saved_spend: float = Field(description="Estimated savings against the baseline, net of classifier cost") - baseline_spend: float = Field(description="spend plus saved_spend: the estimated single-model cost") + savings_estimated_turns: int = Field( + description="Turns covered by the current savings estimator; legacy estimates are excluded" + ) + savings_estimated_actual_spend: float = Field( + description="Actual spend, including classifier cost, for covered turns only" + ) + saved_spend: float | None = Field(description="Estimated savings for covered turns only, net of classifier cost") + baseline_spend: float | None = Field( + description="Estimated single-model cost; unavailable unless every turn is covered" + ) + savings_estimated_baseline_spend: float | None = Field( + description="Estimated single-model cost for covered turns only" + ) baseline_model: str | None = Field( - description="The savings baseline most of this session's turns were priced against, recorded turn by " + description="The savings baseline most covered turns were priced against, recorded turn by " "turn, so it still names the counterfactual after the router is reconfigured or removed. None when no " "turn recorded one: rows from before the baseline was recorded, and adaptive and quality routers, " "which derive no baseline and so report no savings" ) baseline_models: Mapping[str, int] = Field( - description="Turns priced against each baseline model; more than one entry means the router's " + description="Covered turns priced against each baseline model; more than one entry means the router's " "baseline changed mid-session and baseline_spend mixes both" ) diff --git a/litellm/types/router.py b/litellm/types/router.py index adadb053ab2..aef64c09417 100644 --- a/litellm/types/router.py +++ b/litellm/types/router.py @@ -1057,6 +1057,13 @@ class TaggedPreRoutingStrategy(Generic[_PreRoutingStrategyT_co]): strategy: _PreRoutingStrategyT_co +@dataclass(frozen=True, slots=True) +class BaselineRouteStamp: + router_name: str + baseline_model: str + baseline_deployment_id: str + + @dataclass(frozen=True, slots=True) class ConsumedRequestTagsStamp: """The model group a tagged router rewrote to, plus the request tags spent selecting it.""" diff --git a/litellm/types/utils.py b/litellm/types/utils.py index d416e2af33a..b725acf6906 100644 --- a/litellm/types/utils.py +++ b/litellm/types/utils.py @@ -146,6 +146,7 @@ class ProviderSpecificModelInfo(TypedDict, total=False): supports_assistant_prefill: bool | None supports_prompt_caching: bool | None supports_prompt_cache_breakpoint: ReadOnly[bool | None] + supports_thinking_cache_preservation: ReadOnly[bool | None] supports_computer_use: bool | None supports_audio_input: bool | None supports_embedding_image_input: bool | None @@ -2974,6 +2975,13 @@ LLM_AS_A_JUDGE_GUARDRAIL_CALL_ORIGIN: Final[InternalCallOrigin] = "llm_as_a_judg BACKGROUND_RESPONSE_COST_POLL_CALL_ORIGIN: Final[InternalCallOrigin] = "background_response_cost_poll" +class StandardLoggingHeuristicV2Forecast(TypedDict): + probabilities: ReadOnly[Mapping[str, float]] + threshold: ReadOnly[float] + predicted_tier: ReadOnly[str] + request_type: ReadOnly[str] + + class StandardLoggingRoutingDecision(TypedDict, total=False): """Per-request provenance for a pre-routing strategy (auto-router) decision.""" @@ -2992,6 +3000,7 @@ class StandardLoggingRoutingDecision(TypedDict, total=False): classifier_cost: float classifier_probabilities: ReadOnly[Mapping[str, float]] classifier_confidence: ReadOnly[float] + heuristic_v2_forecast: ReadOnly[StandardLoggingHeuristicV2Forecast] classifier_crux: str # writable-ok: added only when a capability verdict is available classifier_primary_rule: str # writable-ok: added only when a capability verdict is available classifier_capability_boundary: str # writable-ok: added only when a capability verdict is available @@ -3037,6 +3046,7 @@ DERIVED_ROUTING_DECISION_FIELDS: Final[frozenset[str]] = frozenset( "classifier_cost", "classifier_probabilities", "classifier_confidence", + "heuristic_v2_forecast", "classifier_primary_rule", "classifier_capability_boundary", "classifier_p_solve", @@ -3450,7 +3460,9 @@ class StandardLoggingPayload(ClassifierAudit): stream: bool | None response_cost: float cost_breakdown: CostBreakdown | None # Detailed cost breakdown - autorouter_savings: ReadOnly[float | None] # None = not an auto-routed caller request; 0.0 is a real figure + autorouter_savings: ReadOnly[float | None] + autorouter_savings_estimate: ReadOnly[Mapping[str, JsonValue] | None] + autorouter_baseline_observation: ReadOnly[str | None] response_cost_failure_debug_info: StandardLoggingModelCostFailureDebugInformation | None status: StandardLoggingPayloadStatus status_fields: StandardLoggingPayloadStatusFields @@ -4178,6 +4190,8 @@ FILE_CONTENT_STREAMING_PROVIDERS: Final[frozenset[str]] = frozenset( {*OPENAI_COMPATIBLE_BATCH_AND_FILES_PROVIDERS, LlmProviders.VERTEX_AI.value} ) +LITELLM_EXECUTED_BATCH_PROVIDERS: Final[frozenset[str]] = frozenset({LlmProviders.HOSTED_VLLM.value}) + ListBatchesSupportedProvider = Literal["openai", "azure", "hosted_vllm", "litellm_proxy", "vertex_ai"] LIST_BATCHES_SUPPORTED_PROVIDERS: Final[frozenset[str]] = frozenset(get_args(ListBatchesSupportedProvider)) diff --git a/litellm/utils.py b/litellm/utils.py index 48d13bc16af..b724313641f 100644 --- a/litellm/utils.py +++ b/litellm/utils.py @@ -1881,6 +1881,7 @@ def client(original_function): # Type assertion: logging_obj is guaranteed to be non-None after function_setup assert logging_obj is not None, "logging_obj should not be None after function_setup" + kwargs["litellm_logging_obj"] = logging_obj modified_kwargs: Final = await async_pre_call_deployment_hook(kwargs, call_type) if modified_kwargs is not None: kwargs = modified_kwargs @@ -2848,6 +2849,14 @@ def supports_prompt_cache_breakpoint(model: str, custom_llm_provider: str | None ) +def supports_thinking_cache_preservation(model: str, custom_llm_provider: str | None = None) -> bool: + return _supports_factory( + model=model, + custom_llm_provider=custom_llm_provider, + key="supports_thinking_cache_preservation", + ) + + def supports_computer_use(model: str, custom_llm_provider: str | None = None) -> bool: """ Check if the given model supports computer use and return a boolean value. @@ -5822,6 +5831,7 @@ def _get_model_info_helper( supports_assistant_prefill=None, supports_prompt_caching=None, supports_prompt_cache_breakpoint=None, + supports_thinking_cache_preservation=None, supports_computer_use=None, supports_pdf_input=None, ) @@ -6094,6 +6104,7 @@ def _get_model_info_helper( supports_assistant_prefill=_model_info.get("supports_assistant_prefill", None), supports_prompt_caching=_model_info.get("supports_prompt_caching", None), supports_prompt_cache_breakpoint=_model_info.get("supports_prompt_cache_breakpoint", None), + supports_thinking_cache_preservation=_model_info.get("supports_thinking_cache_preservation", None), supports_audio_input=_model_info.get("supports_audio_input", None), supports_audio_output=_model_info.get("supports_audio_output", None), supports_pdf_input=_model_info.get("supports_pdf_input", None), diff --git a/model_prices_and_context_window.json b/model_prices_and_context_window.json index 7cf858ed9ff..4b0f5e8b49a 100644 --- a/model_prices_and_context_window.json +++ b/model_prices_and_context_window.json @@ -14510,6 +14510,7 @@ "supports_native_structured_output": true, "supports_pdf_input": true, "supports_prompt_caching": true, + "supports_thinking_cache_preservation": true, "supports_reasoning": true, "supports_response_schema": true, "supports_sampling_params": false, @@ -14547,6 +14548,7 @@ "supports_function_calling": true, "supports_pdf_input": true, "supports_prompt_caching": true, + "supports_thinking_cache_preservation": true, "supports_reasoning": true, "supports_response_schema": true, "supports_native_structured_output": true, @@ -14698,6 +14700,7 @@ "supports_function_calling": true, "supports_pdf_input": true, "supports_prompt_caching": true, + "supports_thinking_cache_preservation": true, "supports_reasoning": true, "supports_response_schema": true, "supports_native_structured_output": true, @@ -14727,6 +14730,7 @@ "supports_function_calling": true, "supports_pdf_input": true, "supports_prompt_caching": true, + "supports_thinking_cache_preservation": true, "supports_reasoning": true, "supports_response_schema": true, "supports_native_structured_output": true, @@ -14759,6 +14763,7 @@ "supports_function_calling": true, "supports_pdf_input": true, "supports_prompt_caching": true, + "supports_thinking_cache_preservation": true, "supports_reasoning": true, "supports_response_schema": true, "supports_native_structured_output": true, @@ -14796,6 +14801,7 @@ "supports_function_calling": true, "supports_pdf_input": true, "supports_prompt_caching": true, + "supports_thinking_cache_preservation": true, "supports_reasoning": true, "supports_response_schema": true, "supports_native_structured_output": true, @@ -14831,6 +14837,7 @@ "supports_function_calling": true, "supports_pdf_input": true, "supports_prompt_caching": true, + "supports_thinking_cache_preservation": true, "supports_reasoning": true, "supports_response_schema": true, "supports_native_structured_output": true, @@ -14869,6 +14876,7 @@ "supports_function_calling": true, "supports_pdf_input": true, "supports_prompt_caching": true, + "supports_thinking_cache_preservation": true, "supports_reasoning": true, "supports_response_schema": true, "supports_native_structured_output": true, @@ -14986,6 +14994,7 @@ "supports_function_calling": true, "supports_pdf_input": true, "supports_prompt_caching": true, + "supports_thinking_cache_preservation": true, "supports_reasoning": true, "supports_response_schema": true, "supports_native_structured_output": true, @@ -15027,6 +15036,7 @@ "supports_function_calling": true, "supports_pdf_input": true, "supports_prompt_caching": true, + "supports_thinking_cache_preservation": true, "supports_reasoning": true, "supports_response_schema": true, "supports_native_structured_output": true, diff --git a/model_prices_and_context_window.schema.json b/model_prices_and_context_window.schema.json index 44b2569defd..509f957b8d1 100644 --- a/model_prices_and_context_window.schema.json +++ b/model_prices_and_context_window.schema.json @@ -911,6 +911,9 @@ "supports_system_messages": { "type": "boolean" }, + "supports_thinking_cache_preservation": { + "type": "boolean" + }, "supports_tool_choice": { "type": "boolean" }, diff --git a/pyproject.toml b/pyproject.toml index f2ee1d92d7f..821f885dbfc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -71,8 +71,8 @@ proxy = [ "mcp>=2.2.0,<3", "httpx2>=2.5.0,<3", "pydantic>=2.12.0,<3", - "litellm-proxy-extras==0.4.99", - "litellm-enterprise==0.1.68", + "litellm-proxy-extras==0.4.100", + "litellm-enterprise==0.1.69", "RestrictedPython>=8.5,<9.0", "rich>=13.9.4,<14.0", "InquirerPy>=0.3.4,<1.0", @@ -302,6 +302,7 @@ editable-profile = "dev" include = [ "litellm/proxy/_experimental/out/**", "litellm/router_strategy/complexity_router/artifacts/*.json", + "litellm/router_strategy/complexity_router/fuse_presets.json", "litellm/proxy/client/cli/commands/codex_base_instructions.md", ] exclude = [ diff --git a/schema.prisma b/schema.prisma index 91b59e56906..d2032cec0d0 100644 --- a/schema.prisma +++ b/schema.prisma @@ -1107,6 +1107,12 @@ model LiteLLM_ManagedObjectTable { // for batches or finetuning jobs which use t @@index([team_id, created_at(sort: Desc)]) } +model LiteLLM_ManagedFileContentTable { + id String @id @default(uuid()) + content Bytes + created_at DateTime @default(now()) +} + model LiteLLM_ManagedVectorStoreTable { id String @id @default(uuid()) unified_resource_id String @unique // The base64 encoded unified vector store ID @@ -1545,6 +1551,36 @@ model LiteLLM_AdaptiveRouterSession { @@index([last_activity_at], map: "idx_adaptive_router_session_activity") } +model LiteLLM_AutoRouterBaselineComparison { + scope String @id + api_key String + session_id String + router_name String + initial_equivalent Boolean + revision BigInt @default(0) + published_revision BigInt @default(0) + history String? + attempted_at DateTime? + retired Boolean @default(false) + updated_at DateTime @default(now()) + + @@index([api_key, session_id, router_name], map: "idx_autorouter_baseline_scope") + @@index([updated_at], map: "idx_autorouter_baseline_updated") +} + +model LiteLLM_AutoRouterBaselineObservation { + request_id String @id + scope String + started_at Float + revision BigInt + data String + publication String? + conflicted Boolean @default(false) + + @@index([scope, started_at, request_id], map: "idx_autorouter_baseline_event_order") + @@index([scope, revision, started_at], map: "idx_autorouter_baseline_event_revision") +} + model LiteLLM_AutoRouterSession { api_key String session_id String @@ -1571,6 +1607,10 @@ model LiteLLM_AutoRouterSession { total_tokens BigInt @default(0) spend Float @default(0) saved_spend Float @default(0) + savings_estimated_turns Int @default(0) + savings_estimated_actual_spend Float @default(0) + savings_estimated_saved_spend Float @default(0) + savings_estimated_baseline_models Json @default("{}") classifier_cost Float @default(0) classifier_cost_recorded_turns Int @default(0) tier_turns Json @default("{}") diff --git a/scripts/check_test_quality.py b/scripts/check_test_quality.py index 41342acd23a..1ef4aed8675 100644 --- a/scripts/check_test_quality.py +++ b/scripts/check_test_quality.py @@ -60,6 +60,13 @@ TQ007 A module global that a conftest saves before every test and restores aft names are read from the keys the conftest assigns directly and from whatever the save loop iterates, including a module-level tuple or dict it names rather than spells out. +TQ009 A child interpreter spawned as `subprocess.run([sys.executable, ...])` without + `-I`/`-P` as its first flag. Without isolation the child's sys.path leads with + the working directory, so a source checkout shadows the installed package and + the child tests a different `litellm` than the parent imported -- TQ003 is the + same working-directory hazard seen from the child's side. Use + tests.test_litellm_rust.support.child_interpreter.run_child_interpreter, which + also asserts the child resolved the same `litellm.__file__` as the parent. Every rule is suppressible with `# test-quality-ok: ` on the reported line, following the repo's `*-ok: ` convention. A suppression without a @@ -140,6 +147,9 @@ SKIP_CALLS: Final = frozenset(("pytest.skip", "skip")) CONFTEST_NAME: Final = "conftest.py" SDK_MODULE: Final = "litellm" +SUBPROCESS_SPAWNS: Final = frozenset(("run", "Popen", "check_output", "check_call", "call")) +INTERPRETER_ISOLATION_FLAGS: Final = frozenset(("-I", "-P")) + CREDENTIAL_NAME_RE: Final = re.compile( r"(?:API_KEY|_KEY|TOKEN|SECRET|PASSWORD|CREDENTIAL|DATABASE_URL|ACCESS_KEY_ID)$" ) @@ -709,6 +719,35 @@ def _snapshotted_names(tree: ast.Module) -> Iterator[tuple[str, int]]: yield from _string_members(iterable) +def iter_child_interpreter_violations(path: Path, tree: ast.Module) -> Iterator[Violation]: + for node in ast.walk(tree): + if not (isinstance(node, ast.Call) and node.args): + continue + if _dotted_name(node.func).rsplit(".", 1)[-1] not in SUBPROCESS_SPAWNS: + continue + argv: Final = node.args[0] + if not isinstance(argv, (ast.List, ast.Tuple)) or not argv.elts: + continue + if _dotted_name(argv.elts[0]) != "sys.executable": + continue + isolated: Final = ( + len(argv.elts) > 1 + and isinstance(argv.elts[1], ast.Constant) + and argv.elts[1].value in INTERPRETER_ISOLATION_FLAGS + ) + if isolated: + continue + yield Violation( + path, + node.lineno, + "TQ009", + "child interpreter spawned without -I/-P; the working directory lands on sys.path " + "and a source checkout can shadow the installed package, use " + "tests.test_litellm_rust.support.child_interpreter.run_child_interpreter or pass -I " + f"(suppress: `# {SUPPRESSION_TOKEN}: `)", + ) + + def iter_conftest_inventory_violations(path: Path, tree: ast.Module) -> Iterator[Violation]: if path.name != CONFTEST_NAME: return @@ -746,6 +785,7 @@ def check_file(path: Path) -> tuple[Violation, ...]: *iter_credential_skip_violations(path, tree), *iter_conftest_inventory_violations(path, tree), *iter_internal_patch_violations(path, tree), + *iter_child_interpreter_violations(path, tree), ) if violation.line not in skip ) diff --git a/terraform/provider/docs/index.md b/terraform/provider/docs/index.md index e6641782a4d..c446567549d 100644 --- a/terraform/provider/docs/index.md +++ b/terraform/provider/docs/index.md @@ -43,22 +43,22 @@ resource "litellm_team" "dev_team" { The LiteLLM provider supports the following resources: -* [`litellm_model`](./resources/model) - Manage LiteLLM model configurations -* [`litellm_team`](./resources/team) - Manage teams and their permissions -* [`litellm_team_member`](./resources/team_member) - Manage team member configurations -* [`litellm_team_member_add`](./resources/team_member_add) - Add members to teams -* [`litellm_key`](./resources/key) - Manage API keys -* [`litellm_mcp_server`](./resources/mcp_server) - Manage MCP (Model Context Protocol) servers -* [`litellm_credential`](./resources/credential) - Manage credentials for various providers -* [`litellm_vector_store`](./resources/vector_store) - Manage vector stores -* [`litellm_jwt_key_mapping`](./resources/jwt_key_mapping) - Map JWT claim values to virtual keys +* `litellm_model` - Manage LiteLLM model configurations +* `litellm_team` - Manage teams and their permissions +* `litellm_team_member` - Manage team member configurations +* `litellm_team_member_add` - Add members to teams +* `litellm_key` - Manage API keys +* `litellm_mcp_server` - Manage MCP (Model Context Protocol) servers +* `litellm_credential` - Manage credentials for various providers +* `litellm_vector_store` - Manage vector stores +* `litellm_jwt_key_mapping` - Map JWT claim values to virtual keys ## Available Data Sources The LiteLLM provider supports the following data sources: -* [`litellm_credential`](./data-sources/credential) - Retrieve credential information -* [`litellm_vector_store`](./data-sources/vector_store) - Retrieve vector store information +* `litellm_credential` - Retrieve credential information +* `litellm_vector_store` - Retrieve vector store information ## Authentication diff --git a/test-quality-budget.json b/test-quality-budget.json index 3c12371f02f..ae4ea4d31be 100644 --- a/test-quality-budget.json +++ b/test-quality-budget.json @@ -22,5 +22,8 @@ }, "TQ008": { "limit": 10993 + }, + "TQ009": { + "limit": 59 } } diff --git a/tests/code_coverage_tests/test_e2e_changed_gate.py b/tests/code_coverage_tests/test_e2e_changed_gate.py index 5ae0863baf0..707566c0333 100644 --- a/tests/code_coverage_tests/test_e2e_changed_gate.py +++ b/tests/code_coverage_tests/test_e2e_changed_gate.py @@ -226,3 +226,31 @@ def test_an_unusable_secret_is_named_without_printing_its_value( assert unprintable not in result.stderr assert result.stdout == "" assert not env_path.exists() + + +@pytest.mark.parametrize("phase", ("setup", "call", "teardown")) +def test_oauth_failure_diagnostics_do_not_publish_private_payloads(tmp_path: Path, phase: str) -> None: + suite: Final = ET.Element("testsuite") + case: Final = ET.SubElement(suite, "testcase", file=SELECTED[0]) + private: Final = "private-token-in-exception-message" + failure: Final = ET.SubElement(case, "failure", message=private) + failure.text = private + properties: Final = ET.SubElement(case, "properties") + for name, value in ( + ("oauth_failure_phase", phase), + ("oauth_exception_type", "AssertionError"), + ("oauth_frame", "oauth_gateway.py:120:start"), + ("oauth_frame", f"injected\\n{private}"), + ("unrelated_property", private), + ): + _ = ET.SubElement(properties, "property", name=name, value=value) + report: Final = tmp_path / "report.xml" + ET.ElementTree(suite).write(report) + result: Final = subprocess.run( + [sys.executable, "-I", str(GATE), str(report), SELECTED[0]], capture_output=True, text=True + ) + assert result.returncode == 1 + assert f"oauth_failure_phase: {phase}" in result.stdout + assert "oauth_exception_type: AssertionError" in result.stdout + assert "oauth_frame: oauth_gateway.py:120:start" in result.stdout + assert private not in result.stdout + result.stderr diff --git a/tests/e2e/AGENTS.md b/tests/e2e/AGENTS.md index 8a56e8673c4..9b662e511b8 100644 --- a/tests/e2e/AGENTS.md +++ b/tests/e2e/AGENTS.md @@ -14,7 +14,7 @@ Each subdirectory under `tests/e2e/` is one suite, scoped to an endpoint family - `quota_management/` - quota enforcement and accounting, one subfolder per behavior: `ratelimit/` (rpm/tpm blocks, window reset, pacing headers on live traffic), `budgets/` (budget definition, enforcement, and reset windows: key, team, tag, soft, multi-window), and `spend_tracking/` (spend logging and cost attribution on `/spend/*`) - `management/` - key/team/user/organization management routes: create/update/delete persistence via the info routes, team membership, and llm-only-key route denials (API surface; not Playwright) - `a2a/` - the A2A (agent-to-agent) surface: admin registration via `/v1/agents`, proxy-fronted card discovery at `/.well-known/agent-card.json`, and JSON-RPC `message/send` invocation, driving agents backed by the litellm completion bridge (a real provider) and asserting protocol-version normalization (0.3 vs 1.0) -- `mcp/` - the MCP server surface over api_key auth against the real Datadog remote MCP server (see "MCP suite: real Datadog only" below); plus the gateway-managed OAuth (authorization_code) path exercised through `/chat/completions`, the one behavior Datadog's static-header auth cannot reach, seeding the per-user upstream token via the interactive authorize dance driven with the mcp SDK's own OAuth client (headless-browser consent from a saved session) and asserting the completion lists and executes the server's tools with the stored per-user token +- `mcp/` - the MCP server surface over api_key auth against the real Datadog remote MCP server (see "MCP suite: real Datadog only" below); plus the gateway-managed OAuth (authorization_code) path exercised through `/chat/completions` in `test_mcp_chat_completion_oauth_e2e.py` and direct MCP protocol operations in `test_mcp_oauth_happy_path_e2e.py`, the one behavior Datadog's static-header auth cannot reach, seeding the per-user upstream token via the interactive authorize dance driven with the mcp SDK's own OAuth client (headless-browser consent from a saved session) and asserting the completion or protocol call lists and executes the server's tools with the stored per-user token - `logging/` - logging-integration delivery (datadog and friends) - `security/` - secret handling and log-leak protection - `router/` - routing and reliability behavior (fallbacks, cooldowns) plus the memory regression test (`test_reliability_memory_e2e.py`: a few hundred failing requests with retries and fallbacks must not grow proxy RSS past a fixed budget nor store a request snapshot past a fixed size, the release-gate check for the v1.100.0 retry-breadcrumb leak) @@ -26,14 +26,14 @@ Each subdirectory under `tests/e2e/` is one suite, scoped to an endpoint family ## MCP suite: real Datadog only -Every test under `tests/e2e/mcp/` must exercise the proxy against the real Datadog remote MCP server. Do not add a compose service, FastMCP fixture, mock upstream, or any other fake MCP host for this suite +Every test under `tests/e2e/mcp/` must exercise the proxy against the real Datadog remote MCP server, except the two Linear OAuth tests `test_mcp_chat_completion_oauth_e2e.py` and `test_mcp_oauth_happy_path_e2e.py`. Do not add a compose service, FastMCP fixture, mock upstream, or any other fake MCP host for this suite - Register via `register_datadog_mcp` in `tests/e2e/mcp/datadog_mcp.py` (or extend that helper if you need a different `toolsets=` / `allowed_tools` slice of the same Datadog endpoint). That posts `/v1/mcp/server` with `url=datadog_mcp_url(...)` and static headers `DD-API-KEY` / `DD-APPLICATION-KEY` from the process env - Auth is Datadog's documented CI/header path, not a browser OAuth authorize/token dance. Hard-fail when `DD_API_KEY` or `DD_APP_KEY` is missing (`assert_dd_mcp_creds`); never skip for a missing fake upstream - Prefer calling real Datadog tools that prove the product path (e.g. `search_datadog_logs` for list/call and permission denials). Seed a unique marker (`e2e-datadog-mcp-*`) in a chat completion when you need a log the tool can find; dual-read with `dd_logs` from conftest when delivery matters - Delete the MCP server (and any keys) through `resources.defer` the same way every other suite tears down - If a new MCP behavior cannot be covered with Datadog's tool surface, say so in the PR and get agreement before inventing another upstream; the default is always Datadog -- The one standing exception is `test_mcp_chat_completion_oauth_e2e.py`. Datadog authenticates with the static `DD-API-KEY` / `DD-APPLICATION-KEY` headers and exposes no authorize/token dance at all, so it cannot exercise gateway-managed OAuth or per-user token seeding in any form. That test drives a real Linear MCP server instead; it is still a real remote upstream, so the no-mock, no-fixture rule above holds unchanged +- The two standing exceptions are `test_mcp_chat_completion_oauth_e2e.py` and `test_mcp_oauth_happy_path_e2e.py`. Datadog authenticates with the static `DD-API-KEY` / `DD-APPLICATION-KEY` headers and exposes no authorize/token dance at all, so these tests drive a real Linear MCP server instead; they are still real remote upstreams, so the no-mock, no-fixture rule above holds unchanged. The direct OAuth test also uses the existing live provider edge to inspect forwarded headers without replay, and owns a separate source-built gateway for cold restarts ## Lay the pattern down in a class @@ -152,7 +152,7 @@ MCPs - endpoint features with the protocol op as the variant mcp... operation : list_tools | call_tool | list_resources | read_resource | list_prompts | get_prompt auth_family : none | api_key | bearer | oauth - assertion : succeeds | denied_without_permission + assertion : succeeds | denied_without_permission | persists_across_processes e.g. mcp.call_tool.oauth.succeeds ``` diff --git a/tests/e2e/CONTRIBUTING.md b/tests/e2e/CONTRIBUTING.md index 2afcc563824..6c3dc4d0bd1 100644 --- a/tests/e2e/CONTRIBUTING.md +++ b/tests/e2e/CONTRIBUTING.md @@ -248,3 +248,56 @@ The semantic header set is `content-type`, `accept`, `anthropic-version`, `anthr Excluded transport and telemetry headers are `host`, `content-length`, `connection`, `accept-encoding`, `user-agent`, `traceparent`, `tracestate`, `x-request-id`, `x-client-request-id` and `x-stainless-*`. Inbound transfer-encoding is unsupported; send JSON with content-length framing. The destination represents host identity and the relay carries original body bytes. Replay does not verify credentials, SDK timeout/retry behavior, transport performance, model availability or stateful remote IDs. Live relay uses original request bytes and header values, never the stored identity Strict replay harness regression tests live in `tests/code_coverage_tests/test_provider_replay_harness.py`. The CircleCI `provider_replay_harness` job runs them alongside the existing legacy harness files with `--noconftest -o pythonpath=tests/e2e`; they need only synthetic HTTP providers and temporary fixture storage + + +## MCP OAuth happy path + +`test_mcp_oauth_happy_path_e2e.py` runs one shared scenario with four variants: +aggregate gateway SSO and explicitly configured per-server JWT, each directly +against Linear and through the live provider edge. The edge forwards to real +Linear without replay and compares the forwarded bearer to the encrypted +canonical user/server credential. This observes the forwarding boundary, not +Linear's internal logs. Direct variants independently exercise discovery + +Use the existing database preparation, Prisma generation and Keycloak setup. +Build and stage the dashboard from the tested checkout as in the UI runner. +Provide `DATABASE_URL`, `LITELLM_MASTER_KEY`, `LITELLM_SALT_KEY`, `LITELLM_LICENSE`, +and the `E2E_KEYCLOAK_*` settings. Capture a test-account Linear login using +`mcp/linear_session_capture.py` and set `E2E_LINEAR_STORAGE_STATE` to that private +file. The test workspace must contain a team. Do not publish browser state or +raw test/proxy output + +```bash +E2E_MCP_OAUTH_LIVE=1 E2E_FIXTURE_MODE=live E2E_PROVIDER_CACHE=0 \ + uv run --no-sync pytest tests/e2e/mcp/test_mcp_oauth_happy_path_e2e.py \ + --rootdir=. --reruns 0 +``` + +The test starts and restarts its own source-built proxy on a free loopback port, +retaining its database and SSO client but no Redis or process-local cache. It +does not restart an existing proxy or clear shared databases. Gateway login, +consent, immediate list/call and post-restart reconnect must all succeed. The +aggregate client never injects a gateway header; the explicitly labeled JWT +variant configures `x-litellm-api-key` for the first consent and reconnects with +only its gateway JWT after restart + +`.github/workflows/test-mcp-oauth-e2e.yml` automatically requests a run for +same-repository pull requests changing MCP, gateway authentication/SSO, consent +UI, dependencies or the relevant E2E harness/workflow paths. It retains manual +`workflow_dispatch` for targeted verification. The four cases run in the +protected `e2e-changed` environment after its normal deployment approval; +reviewers should approve and inspect this separate OAuth check when it appears. +Fork pull requests do not run this credentialed job; use a reviewed +same-repository branch for their verification. The workflow's path-filtered +check is not configured here as a globally required branch-protection check. +Provision `E2E_LINEAR_STORAGE_STATE_B64` as a secret there and retain the existing E2E license/AWS role configuration. A missing or +expired session fails the job; collection, deselection and skips are not passes. +The generic changed-test job excludes this file because it requires an owned +proxy and consent UI. No LLM call is needed + +Coverage remains limited to authorization-code OAuth over HTTP. M2M, OBO, +PKCE passthrough, static/BYOK, ID-JAG, forwarding, SigV4 and stdio are outside this +scenario; consult the registry and LIT-3559 for their existing coverage and gaps. +LIT-4506 owns broader isolation/failure regressions. LIT-7737 retains ownership +of dependency/Python compatibility and its matrix; this test reuses its delivered +environment and does not change dependency constraints or compatibility gates diff --git a/tests/e2e/batches/test_batches_e2e.py b/tests/e2e/batches/test_batches_e2e.py index eff8f297f25..9b3c06d9a1b 100644 --- a/tests/e2e/batches/test_batches_e2e.py +++ b/tests/e2e/batches/test_batches_e2e.py @@ -1160,62 +1160,151 @@ def _vllm_params(api_base: str, api_key: str | None, model_id: str) -> LiteLLMPa ) -class TestHostedVllmBatch: - """hosted_vllm file upload + batch create (OpenAI-compatible path, LIT-3266). +HOSTED_VLLM_DEFAULT_MODEL = "Qwen/Qwen2.5-0.5B-Instruct" +HOSTED_VLLM_BAD_LINE_CUSTOM_ID = "req-bad" - hosted_vllm is in OPENAI_COMPATIBLE_BATCH_AND_FILES_PROVIDERS, so /v1/files - and /v1/batches route through the OpenAI handler against the deployment's - api_base. Skipped for now: it needs a live vLLM (or OpenAI-compatible) server - exposing the files/batches APIs (HOSTED_VLLM_API_BASE), which the e2e - environment does not currently provision. + +def _hosted_vllm_deployment(client: BatchClient, resources: ResourceManager) -> str: + api_base = os.environ.get("HOSTED_VLLM_API_BASE") + if api_base is None: + pytest.skip("set HOSTED_VLLM_API_BASE (the live vLLM server this deployment targets)") + api_key = (os.environ.get("HOSTED_VLLM_API_KEY") or "").strip() or None + model_id = (os.environ.get("HOSTED_VLLM_MODEL") or HOSTED_VLLM_DEFAULT_MODEL).strip() + proxy_name = batch_model_name("hosted-vllm-batch") + model_row_id = client.create_model(proxy_name, _vllm_params(api_base, api_key, model_id)) + resources.defer(lambda: client.delete_model(model_row_id)) + return proxy_name + + +def _upload_hosted_vllm_input( + client: BatchClient, content: bytes, *, proxy_name: str, key: str, upload_route: str +) -> Result[FileObject]: + if upload_route == "model_query": + return client.upload_file(content=content, form=FileUploadForm(purpose="batch"), model=proxy_name, key=key) + return client.upload_file( + content=content, form=FileUploadForm(purpose="batch", target_model_names=proxy_name), key=key + ) + + +def _jsonl_with_a_failing_line(model: str) -> bytes: + bad_line = { + "custom_id": HOSTED_VLLM_BAD_LINE_CUSTOM_ID, + "method": "POST", + "url": "/v1/chat/completions", + "body": {"model": model, "messages": [{"role": "user", "content": "ping"}], "max_tokens": -1}, + } + return render_jsonl(model) + (json.dumps(bad_line) + "\n").encode() + + +def _download_managed_file(client: BatchClient, file_id: str, *, key: str) -> list[str]: + downloaded = client.proxy.transport.download( + f"/v1/files/{file_id}/content", headers=client.proxy.transport.bearer(key) + ) + assert downloaded.status_code == 200, ( + f"file content must be 200, got {downloaded.status_code}: {downloaded.body[:300]}" + ) + return downloaded.body.strip().splitlines() + + +class TestHostedVllmBatch: + """hosted_vllm file upload + batch execution (LIT-5739). + + vLLM implements neither /v1/files nor /v1/batches, so LiteLLM keeps the batch + input in its own database, runs every line through the deployment's + /v1/chat/completions itself, and serves the batch plus its output and error + files from that database under the creating key. Needs a live vLLM server + (HOSTED_VLLM_API_BASE), which the default e2e stack does not provision, so + the cases skip without it. """ - @pytest.mark.skip( - reason="hosted_vllm batch/files needs a live vLLM server (HOSTED_VLLM_API_BASE) " - "not provisioned in the e2e environment; re-enable when available (LIT-3266)" - ) + @pytest.mark.parametrize("upload_route", ["target_model_names", "model_query"]) @pytest.mark.covers( "llm.batches.hosted_vllm.basic.nonstream.works", "llm.files.hosted_vllm.upload.nonstream.works", exercised_on=["batches", "files"], ) - def test_unified_file_and_batch_create( - self, client: BatchClient, resources: ResourceManager + def test_batch_runs_to_completion_with_a_downloadable_output( + self, client: BatchClient, resources: ResourceManager, upload_route: str ) -> None: - api_base = os.environ["HOSTED_VLLM_API_BASE"] - api_key = (os.environ.get("HOSTED_VLLM_API_KEY") or "").strip() or None - model_id = ( - os.environ.get("HOSTED_VLLM_MODEL") or "meta-llama/Llama-3.2-3B-Instruct" - ).strip() - proxy_name = batch_model_name("hosted-vllm-batch") - - model_row_id = client.create_model( - proxy_name, _vllm_params(api_base, api_key, model_id) - ) - resources.defer(lambda: client.delete_model(model_row_id)) + proxy_name = _hosted_vllm_deployment(client, resources) key = resources.key() file = unwrap( - client.upload_file( - content=render_jsonl(model_id), - form=FileUploadForm(purpose="batch", target_model_names=proxy_name), - key=key, + _upload_hosted_vllm_input( + client, render_jsonl(proxy_name), proxy_name=proxy_name, key=key, upload_route=upload_route ) ) resources.defer(lambda: cleanup_file(client, file.id, key=key)) assert_file_object(file, provider="hosted_vllm") + assert is_managed_id(file.id), f"hosted_vllm batch input must stay in LiteLLM, got file id {file.id!r}" created = client.create_batch(body=BatchCreateBody(input_file_id=file.id), key=key) require_successful_call(created) batch = BatchObject.model_validate_json(created.body) - resources.defer(lambda: cleanup_batch(client, batch.id, key=key)) - - assert batch.id, f"hosted_vllm create returned no batch id: {created.body[:200]}" - assert batch.status in CREATED_BATCH_STATUSES, ( - f"hosted_vllm batch has non-transitional status {batch.status!r}" - ) + resources.defer(lambda: cleanup_batch(client, batch.id, key=key, delete_output_files=True)) + assert is_managed_id(batch.id), f"hosted_vllm batch must be LiteLLM-managed, got {batch.id!r}" + assert batch.status in CREATED_BATCH_STATUSES, f"hosted_vllm batch has non-transitional status {batch.status!r}" assert_batch_object(batch) + finished = _poll_until_terminal(client, batch.id, key) + assert finished.status == "completed", f"hosted_vllm batch ended {finished.status!r}: {finished.errors!r}" + assert finished.output_file_id, "completed hosted_vllm batch has no output_file_id" + assert finished.error_file_id is None, f"all lines succeeded but error_file_id={finished.error_file_id!r}" + + output_lines = _download_managed_file(client, finished.output_file_id, key=key) + assert len(output_lines) == 1, f"one input line must yield one output line, got {output_lines!r}" + first_line = BatchOutputLine.model_validate_json(output_lines[0]) + assert first_line.custom_id == "req-1", f"output line lost its custom_id: {output_lines[0][:300]}" + assert first_line.response.status_code == 200, f"batch output line reports failure: {output_lines[0][:400]}" + assert first_line.response.body is not None and first_line.response.body.choices, ( + "batch output line has no choices" + ) + + rows = client.proxy.poll_logs_for_key( + key, predicate=lambda found: any(row.call_type == "acompletion" for row in found) + ) + line_rows = [row for row in rows if row.call_type == "acompletion"] + assert line_rows, f"the batch line's chat call was not logged under the creating key: {rows!r}" + assert all(row.custom_llm_provider == "hosted_vllm" for row in line_rows), ( + f"batch line rows must be attributed to hosted_vllm: {line_rows!r}" + ) + + @pytest.mark.covers("llm.batches.hosted_vllm.basic.nonstream.works", exercised_on=["batches", "files"]) + def test_failing_line_lands_in_the_error_file_not_the_batch_status( + self, client: BatchClient, resources: ResourceManager + ) -> None: + proxy_name = _hosted_vllm_deployment(client, resources) + key = resources.key() + + file = unwrap( + _upload_hosted_vllm_input( + client, + _jsonl_with_a_failing_line(proxy_name), + proxy_name=proxy_name, + key=key, + upload_route="target_model_names", + ) + ) + resources.defer(lambda: cleanup_file(client, file.id, key=key)) + + created = client.create_batch(body=BatchCreateBody(input_file_id=file.id), key=key) + require_successful_call(created) + batch = BatchObject.model_validate_json(created.body) + resources.defer(lambda: cleanup_batch(client, batch.id, key=key, delete_output_files=True)) + + finished = _poll_until_terminal(client, batch.id, key) + assert finished.status == "completed", f"a failing line must not fail the batch, got {finished.status!r}" + assert finished.output_file_id, "the good line must still produce an output file" + assert finished.error_file_id, "the failing line must produce an error file" + + output_lines = _download_managed_file(client, finished.output_file_id, key=key) + error_lines = _download_managed_file(client, finished.error_file_id, key=key) + assert [BatchOutputLine.model_validate_json(line).custom_id for line in output_lines] == ["req-1"] + assert len(error_lines) == 1, f"one failing line must yield one error line, got {error_lines!r}" + error_line = BatchOutputLine.model_validate_json(error_lines[0]) + assert error_line.custom_id == HOSTED_VLLM_BAD_LINE_CUSTOM_ID + assert error_line.response.status_code == 400, f"error line must carry the provider's 4xx: {error_lines[0][:400]}" + BATCH_TERMINAL_STATUSES = frozenset({"completed", "failed", "expired", "cancelled"}) FAILED_BATCH_POLL_SECONDS = 120.0 @@ -1443,6 +1532,7 @@ class BatchOutputResponse(BaseModel): class BatchOutputLine(BaseModel): + custom_id: str | None = None response: BatchOutputResponse diff --git a/tests/e2e/conftest.py b/tests/e2e/conftest.py index e83827fac74..b0904e39a1f 100644 --- a/tests/e2e/conftest.py +++ b/tests/e2e/conftest.py @@ -17,6 +17,7 @@ import functools import os from collections.abc import Generator, Iterator from datetime import datetime, timezone +from pathlib import Path from types import MappingProxyType from typing import Final @@ -28,6 +29,7 @@ from e2e_config import ( FIXTURE_DIR, FIXTURE_MODE_RAW, MANAGED_FILES_OPT_IN_ENV, + MCP_OAUTH_LIVE_OPT_IN_ENV, PROMPT_CACHING_OPT_IN_ENV, PROXY_BASE_URL, REDIS_CHAOS_OPT_IN_ENV, @@ -56,6 +58,7 @@ OPT_IN_MARKERS: Final = MappingProxyType( "prompt_caching_stack": PROMPT_CACHING_OPT_IN_ENV, "redis_chaos": REDIS_CHAOS_OPT_IN_ENV, "cli_determinism": CLI_DETERMINISM_OPT_IN_ENV, + "mcp_oauth_live": MCP_OAUTH_LIVE_OPT_IN_ENV, } ) @@ -132,6 +135,11 @@ def pytest_configure(config: pytest.Config) -> None: "redis_chaos: load test that pauses the proxy's Redis outright mid-run; needs a proxy booted from " "gateway/redis_chaos_ci_config.yml on the same host, and is deselected unless E2E_REDIS_CHAOS is set", ) + config.addinivalue_line( + "markers", + "mcp_oauth_live: real Linear OAuth consent via a captured browser session; deselected unless " + "E2E_MCP_OAUTH_LIVE is set", + ) def pytest_sessionstart(session: pytest.Session) -> None: @@ -213,6 +221,8 @@ def pytest_runtest_setup(item: pytest.Item) -> None: LIVE_PROVIDER_REQUIRED.set(item.get_closest_marker("provider_live") is not None) if item.get_closest_marker("e2e") is None: return + if isinstance(item, pytest.Function) and "oauth_gateway" in item.fixturenames: + return reason = _proxy_fail_reason() if reason is not None: pytest.fail(reason) @@ -236,6 +246,13 @@ def pytest_runtest_makereport( """Stash the call-phase outcome so teardown can tell a passed test from a failed one without re-deriving it.""" report = yield + if item.get_closest_marker("mcp_oauth_live") is not None and call.excinfo is not None: + # Publish code locations only, never exception messages, source text or locals. + item.user_properties.append(("oauth_failure_phase", report.when)) + item.user_properties.append(("oauth_exception_type", call.excinfo.type.__name__)) + for entry in call.excinfo.traceback: + item.user_properties.append(("oauth_frame", f"{Path(entry.path).name}:{entry.lineno + 1}:{entry.name}")) + report.user_properties = list(item.user_properties) if report.when == "call": item.stash[_CALL_PASSED] = report.passed return report diff --git a/tests/e2e/coverage_registry/mcp.yaml b/tests/e2e/coverage_registry/mcp.yaml index 85ace835144..1cdeac7b77f 100644 --- a/tests/e2e/coverage_registry/mcp.yaml +++ b/tests/e2e/coverage_registry/mcp.yaml @@ -71,6 +71,14 @@ assertions: [succeeds] source: "db.py user_oauth_credential lookup" rationale: OAuth2 token passthrough; per-user credential storage +- id: mcp.call_tool.oauth.persists_across_processes + module: mcp + tier: P1 + operation: call_tool + auth_family: oauth + assertions: [persists_across_processes] + source: "outbound_credentials/per_user_oauth_store.py V2PerUserTokenStore" + rationale: Stored per-user token survives a verified restart of an owned gateway with no Redis cache - id: mcp.list_tools.none.succeeds module: mcp tier: P1 diff --git a/tests/e2e/coverage_registry/mgmt.yaml b/tests/e2e/coverage_registry/mgmt.yaml index 9890902fa5e..85fbd0acd91 100644 --- a/tests/e2e/coverage_registry/mgmt.yaml +++ b/tests/e2e/coverage_registry/mgmt.yaml @@ -72,7 +72,6 @@ - {id: mgmt.callback.list.happy_path, module: mgmt, tier: P2, surface: api, assertions: [happy_path], source: "callback_management_endpoints.py", rationale: "Callback config (smoke)"} - {id: mgmt.cost_tracking.estimate.happy_path, module: mgmt, tier: P2, surface: api, assertions: [happy_path], source: "cost_tracking_settings.py", rationale: "Cost estimate (smoke)"} - {id: mgmt.router_settings.update.happy_path, module: mgmt, tier: P2, surface: api, assertions: [happy_path], source: "router_settings_endpoints.py", rationale: "Router config (smoke)"} -- {id: mgmt.config.allowed_ip.changed_key_only, module: mgmt, tier: P2, surface: api, assertions: [persists], source: "proxy_setting_endpoints.py:496", rationale: "An allowed-IP change leaves unrelated file settings out of the DB row"} - {id: mgmt.jwt_key_mapping.new.happy_path, module: mgmt, tier: P2, surface: api, assertions: [happy_path], source: "jwt_key_mapping_endpoints.py", rationale: "JWT->key mapping (smoke)"} - {id: mgmt.compliance.gdpr.happy_path, module: mgmt, tier: P2, surface: api, assertions: [happy_path], source: "compliance_endpoints.py", rationale: "GDPR ops (smoke)"} - {id: mgmt.tool_management.list.happy_path, module: mgmt, tier: P2, surface: api, assertions: [happy_path], source: "tool_management_endpoints.py", rationale: "Tool inventory (smoke)"} diff --git a/tests/e2e/e2e_config.py b/tests/e2e/e2e_config.py index 11c52d1398c..a79c158f9c4 100644 --- a/tests/e2e/e2e_config.py +++ b/tests/e2e/e2e_config.py @@ -52,6 +52,7 @@ CHEAP_OPENAI_MODEL = os.environ.get("E2E_CHEAP_OPENAI_MODEL", "gpt-5.5") LINEAR_MCP_URL = os.environ.get("E2E_LINEAR_MCP_URL", "https://mcp.linear.app/mcp") LINEAR_STORAGE_STATE = os.environ.get("E2E_LINEAR_STORAGE_STATE", "") +LINEAR_READONLY_TOOL: Final = "list_teams" # as listed by tools/list on mcp.linear.app when PR #33787 landed # Jaeger query API of the compose stack's OTEL trace destination (the `jaeger` # service in docker-compose.yml maps it to host 16686). Trace-completeness tests @@ -144,6 +145,7 @@ MANAGED_FILES_OPT_IN_ENV = "E2E_MANAGED_FILES_STACK" PROMPT_CACHING_OPT_IN_ENV = "E2E_PROMPT_CACHING_STACK" REDIS_CHAOS_OPT_IN_ENV = "E2E_REDIS_CHAOS" CLI_DETERMINISM_OPT_IN_ENV = "E2E_CLI_DETERMINISM" +MCP_OAUTH_LIVE_OPT_IN_ENV: Final = "E2E_MCP_OAUTH_LIVE" ANOMALY_SESSIONS = int(os.environ.get("E2E_ANOMALY_SESSIONS", "6")) ANOMALY_TURNS_PER_SESSION = int(os.environ.get("E2E_ANOMALY_TURNS_PER_SESSION", "6")) ANOMALY_TURN_ATTEMPTS = int(os.environ.get("E2E_ANOMALY_TURN_ATTEMPTS", "3")) diff --git a/tests/e2e/gateway/stage_mirror_ci_config.yml b/tests/e2e/gateway/stage_mirror_ci_config.yml index 1b6ae93f461..8c8e64443cb 100644 --- a/tests/e2e/gateway/stage_mirror_ci_config.yml +++ b/tests/e2e/gateway/stage_mirror_ci_config.yml @@ -1,5 +1,4 @@ general_settings: - max_parallel_requests: 100 proxy_batch_write_at: 5 enable_jwt_auth: true litellm_jwtauth: diff --git a/tests/e2e/idp.py b/tests/e2e/idp.py index 2dc7c2ad71b..a89a036baeb 100644 --- a/tests/e2e/idp.py +++ b/tests/e2e/idp.py @@ -435,7 +435,7 @@ def _signal_process_group(process_id: int, signum: int) -> bool: return True -def _stop_process_group(child: subprocess.Popen[bytes]) -> None: +def stop_process_group(child: subprocess.Popen[bytes]) -> None: _signal_process_group(child.pid, signal.SIGTERM) deadline: Final = time.monotonic() + 5 while _process_group_exists(child.pid): @@ -476,7 +476,7 @@ def run_oidc_profile(proxy_url: str, command: list[str]) -> int: try: return child.wait() finally: - _stop_process_group(child) + stop_process_group(child) if __name__ == "__main__": diff --git a/tests/e2e/management/test_config_misc_endpoints_e2e.py b/tests/e2e/management/test_config_misc_endpoints_e2e.py index 20e98e993d4..a3be0a64e7f 100644 --- a/tests/e2e/management/test_config_misc_endpoints_e2e.py +++ b/tests/e2e/management/test_config_misc_endpoints_e2e.py @@ -7,13 +7,18 @@ so a read-back reflects the change. Router settings, which mutate global proxy state, are exercised with a benign, self-restoring change so a shared proxy is left as it was found. -Cache settings and the Vault config override are deliberately not covered here. -Both routes reconfigure the whole proxy: /cache/settings persists what it receives -into a row that outranks the YAML cache_params and is re-applied on a timer, and -/config_overrides/hashicorp_vault swaps the process-wide secret manager. Neither can -be exercised safely against the shared proxy the suites run on, so they need an -isolated proxy before a test lands. Do not add a read-then-write-back test for -either one. +Cache settings, the Vault config override and the allowed-IP routes are deliberately +not covered here. All three reconfigure the whole proxy: /cache/settings persists what +it receives into a row that outranks the YAML cache_params and is re-applied on a timer, +/config_overrides/hashicorp_vault swaps the process-wide secret manager, and +/add/allowed_ip mutates the live general_settings["allowed_ips"] that +auth_utils._check_valid_ip reads, so the first call locks every other client out of the +shared proxy. The allowlist is an exact string match with no CIDR support, and no route +reports the caller's address as the proxy sees it, so a test cannot allowlist itself +first; /delete/allowed_ip sits behind the same auth dependency, so the cleanup is locked +out too and the proxy stays poisoned for the rest of the build. None of the three can be +exercised safely against the shared proxy the suites run on, so they need an isolated +proxy before a test lands. Do not add a read-then-write-back test for any of them. """ from __future__ import annotations @@ -21,10 +26,9 @@ from __future__ import annotations import math import time from collections.abc import Callable -from typing import Final import pytest -from pydantic import BaseModel, JsonValue, RootModel +from pydantic import BaseModel from e2e_config import unique_marker from e2e_http import NoBody, Success, unwrap, unwrap_status @@ -188,7 +192,7 @@ class JwtKeyMappingResponse(BaseModel): class RouterSettingsPatch(BaseModel): - num_retries: int + retry_after: int class ConfigUpdateBody(BaseModel): @@ -199,39 +203,8 @@ class ConfigUpdateResponse(BaseModel): message: str -class AllowedIpBody(BaseModel): - ip: str - - -class ConfigFieldInfoParams(BaseModel): - field_name: str - - -class ConfigFieldInfoResponse(BaseModel): - field_name: str - field_value: JsonValue - source: str - editable: bool - - -class ConfigListParams(BaseModel): - config_type: str - - -class ConfigListEntry(BaseModel): - field_name: str - field_value: JsonValue - stored_in_db: bool | None - source: str - editable: bool - - -class ConfigListResponse(RootModel[list[ConfigListEntry]]): - pass - - class RouterCurrentValues(BaseModel): - num_retries: int | None = None + retry_after: int | None = None class RouterSettingsResponse(BaseModel): @@ -493,17 +466,25 @@ class TestRouterSettings: ) -> None: """/config/update is the only write path for router_settings (there is no dedicated router-settings write route). The change is restored on teardown so - the shared proxy keeps its original retry policy.""" - original = self._read_num_retries(client) - assert original is not None, "GET /router/settings did not report num_retries; cannot prove a change" - resources.defer(lambda: self._write_num_retries(client, original)) + the shared proxy keeps its original retry policy. - target = original + 5 + retry_after is the subject because it satisfies all three constraints at once: + no lane's config file declares it, so the database owns it and the write is not + refused as config-owned; it is in RUNTIME_UPDATABLE_ROUTER_SETTINGS, so + /config/update accepts it; and it is in ROUTER_SETTINGS_FIELDS backed by an + always-set Router attribute, so GET /router/settings reports it for the + read-back. Bumping it by one second is the smallest change that proves the + round-trip without slowing a concurrent test that hits a retry.""" + original = self._read_retry_after(client) + assert original is not None, "GET /router/settings did not report retry_after; cannot prove a change" + resources.defer(lambda: self._write_retry_after(client, original)) + + target = original + 1 response = unwrap( client.proxy.transport.post( "/config/update", headers=client.proxy.transport.master, - json=ConfigUpdateBody(router_settings=RouterSettingsPatch(num_retries=target)), + json=ConfigUpdateBody(router_settings=RouterSettingsPatch(retry_after=target)), response_type=ConfigUpdateResponse, ) ) @@ -513,20 +494,20 @@ class TestRouterSettings: _ = _poll( client, - lambda: True if self._read_num_retries(client) == target else None, - f"GET /router/settings never reported num_retries {target} after /config/update", + lambda: True if self._read_retry_after(client) == target else None, + f"GET /router/settings never reported retry_after {target} after /config/update", ) - self._write_num_retries(client, original) + self._write_retry_after(client, original) restored = _poll( client, - lambda: original if self._read_num_retries(client) == original else None, - f"GET /router/settings never returned to the original num_retries {original} after the restore", + lambda: original if self._read_retry_after(client) == original else None, + f"GET /router/settings never returned to the original retry_after {original} after the restore", ) - assert restored == original, f"router num_retries left at {restored}, expected the original {original}" + assert restored == original, f"router retry_after left at {restored}, expected the original {original}" @staticmethod - def _read_num_retries(client: ManagementClient) -> int | None: + def _read_retry_after(client: ManagementClient) -> int | None: return unwrap( client.proxy.transport.get( "/router/settings", @@ -534,72 +515,20 @@ class TestRouterSettings: params=NoBody(), response_type=RouterSettingsResponse, ) - ).current_values.num_retries + ).current_values.retry_after @staticmethod - def _write_num_retries(client: ManagementClient, value: int) -> None: + def _write_retry_after(client: ManagementClient, value: int) -> None: _ = unwrap( client.proxy.transport.post( "/config/update", headers=client.proxy.transport.master, - json=ConfigUpdateBody(router_settings=RouterSettingsPatch(num_retries=value)), + json=ConfigUpdateBody(router_settings=RouterSettingsPatch(retry_after=value)), response_type=ConfigUpdateResponse, ) ) -class TestConfigPersistence: - @pytest.mark.covers("mgmt.config.allowed_ip.changed_key_only") - def test_add_allowed_ip_does_not_store_unrelated_config_value( - self, client: ManagementClient, resources: ResourceManager - ) -> None: - allowed_ip: Final = "127.0.0.1" - added: Final = unwrap( - client.proxy.transport.post( - "/add/allowed_ip", - headers=client.proxy.transport.master, - json=AllowedIpBody(ip=allowed_ip), - response_type=ConfigUpdateResponse, - ) - ) - resources.defer( - lambda: unwrap( - client.proxy.transport.post( - "/delete/allowed_ip", - headers=client.proxy.transport.master, - json=AllowedIpBody(ip=allowed_ip), - response_type=ConfigUpdateResponse, - ) - ) - ) - assert added.message == f"IP {allowed_ip} address added successfully" - - listed: Final = unwrap( - client.proxy.transport.get( - "/config/list", - headers=client.proxy.transport.master, - params=ConfigListParams(config_type="general_settings"), - response_type=ConfigListResponse, - ) - ) - unrelated: Final = next(entry for entry in listed.root if entry.field_name == "max_parallel_requests") - assert unrelated.stored_in_db is not True - assert unrelated.source == "config" - assert unrelated.editable is False - - field_info: Final = unwrap( - client.proxy.transport.get( - "/config/field/info", - headers=client.proxy.transport.master, - params=ConfigFieldInfoParams(field_name="max_parallel_requests"), - response_type=ConfigFieldInfoResponse, - ) - ) - assert field_info.source == "config" - assert field_info.editable is False - assert field_info.field_value == unrelated.field_value - - class TestMcpServerSubmission: @pytest.mark.covers("mgmt.mcp_server.register.happy_path") def test_register_submits_pending_server(self, client: ManagementClient, resources: ResourceManager) -> None: diff --git a/tests/e2e/mcp/oauth_chat_client.py b/tests/e2e/mcp/oauth_chat_client.py index 763b348b197..0c5c6106259 100644 --- a/tests/e2e/mcp/oauth_chat_client.py +++ b/tests/e2e/mcp/oauth_chat_client.py @@ -18,7 +18,7 @@ import asyncio import re import time from dataclasses import dataclass -from typing import TYPE_CHECKING +from typing import TYPE_CHECKING, Final from urllib.parse import parse_qsl import httpx @@ -26,11 +26,21 @@ import httpx2 import pytest from e2e_config import PROXY_BASE_URL, REQUEST_TIMEOUT from e2e_http import AuthHeaders, NoBody, unwrap +from idp import Identity from mcp import ClientSession from mcp.client.auth import OAuthClientProvider from mcp.client.streamable_http import streamable_http_client from mcp.shared.auth import AuthorizationCodeResult, OAuthClientInformationFull, OAuthClientMetadata, OAuthToken -from models import ChatBody, ChatResponse, McpServerCreateBody, McpServerInfo +from mcp.types import TextContent +from models import ( + ChatBody, + ChatResponse, + McpOauthUserCredentialStatus, + McpServerCreateBody, + McpServerInfo, + McpServerUserCredentialListResponse, + McpServerUserCredentialRow, +) from proxy_client import ProxyClient if TYPE_CHECKING: @@ -44,8 +54,8 @@ OAUTH_CLIENT_REDIRECT_URI = "http://127.0.0.1:53682/e2e/callback" BROWSER_CONSENT_TIMEOUT = 60.0 -def _mcp_url(alias: str) -> str: - return f"{PROXY_BASE_URL}/{alias}/mcp" +def _mcp_url(alias: str, base_url: str = PROXY_BASE_URL) -> str: + return f"{base_url.rstrip('/')}/{alias}/mcp" class InMemoryTokenStorage: @@ -69,7 +79,13 @@ class InMemoryTokenStorage: self._client_info = client_info -async def _browser_follow_authorize(start_url: str, storage_state_path: str) -> tuple[str, str | None]: +async def _browser_follow_authorize( + start_url: str, + storage_state_path: str, + identity: Identity | None = None, + server_alias: str | None = None, + allow_upstream_consent: bool = True, +) -> tuple[str, str | None]: """Play the browser's role for a real upstream whose authorize endpoint serves an interactive consent page (Linear). A headless Chromium primed with a human's saved Linear session opens the gateway authorize URL and @@ -85,6 +101,9 @@ async def _browser_follow_authorize(start_url: str, storage_state_path: str) -> def _note_request(request: object) -> None: url = getattr(request, "url", "") + host = httpx.URL(url).host + if not allow_upstream_consent and (host == "linear.app" or host.endswith(".linear.app")): + captured["upstream_consent"] = "seen" if url.startswith(OAUTH_CLIENT_REDIRECT_URI) and "url" not in captured: captured["url"] = url @@ -96,7 +115,7 @@ async def _browser_follow_authorize(start_url: str, storage_state_path: str) -> context = await browser.new_context(storage_state=storage_state_path) await context.route(re.compile(re.escape(OAUTH_CLIENT_REDIRECT_URI) + r".*"), _swallow_redirect) page = await context.new_page() - page.on("request", _note_request) + context.on("request", _note_request) page.on("framenavigated", lambda frame: trail.append(frame.url.split("?", 1)[0])) await page.goto(start_url, wait_until="domcontentloaded") deadline = time.monotonic() + BROWSER_CONSENT_TIMEOUT @@ -105,8 +124,29 @@ async def _browser_follow_authorize(start_url: str, storage_state_path: str) -> await page.wait_for_load_state("networkidle", timeout=8000) except Exception: # noqa: BLE001 - a busy consent page never idles; fall through and try to advance it pass - if "url" in captured: + if "upstream_consent" in captured or "url" in captured: break + if await page.locator("#username").count() and identity is not None: + await page.locator("#username").fill(identity.username) + await page.locator("#password").fill(identity.password) + await page.locator("#kc-login").click() + continue + if "/ui/connect" in page.url and server_alias is not None: + card = page.locator("div.cursor-pointer").filter(has=page.get_by_text(server_alias, exact=True)) + if await card.count() != 1: + await asyncio.sleep(0.5) + continue + connect = card.get_by_text("Connect", exact=True) + if await connect.count(): + await connect.click() + continue + if not await card.locator("svg.text-success").count(): + await asyncio.sleep(0.5) + continue + finish = page.get_by_role("button", name="Finish connecting", exact=True) + if await finish.count() and await finish.is_enabled(): + await finish.click() + continue control = page.locator( 'button[name="action"][value="approve"], button:has-text("Authorize"), ' 'button:has-text("Allow"), button:has-text("@"), a:has-text("@")' @@ -118,27 +158,44 @@ async def _browser_follow_authorize(start_url: str, storage_state_path: str) -> final_url = page.url await browser.close() + # A redirect chain can finish inside goto/networkidle before the loop checks the page. + assert "upstream_consent" not in captured, "cold reconnect required upstream consent" landing = captured.get("url") assert landing is not None, ( f"consent flow never reached {OAUTH_CLIENT_REDIRECT_URI}; " f"final={final_url.split('?', 1)[0]!r}; trail={trail[-6:]}" ) params = dict(parse_qsl(httpx.URL(landing).query.decode())) - assert "code" in params, f"client redirect_uri carried no code: {landing}" + assert "code" in params, "client redirect_uri carried no authorization code" return params["code"], params.get("state") -def _oauth_provider(url: str, storage: InMemoryTokenStorage, storage_state_path: str) -> OAuthClientProvider: +def _oauth_provider( + url: str, + storage: InMemoryTokenStorage, + storage_state_path: str | None, + identity: Identity | None = None, + server_alias: str | None = None, + allow_upstream_consent: bool = True, +) -> OAuthClientProvider: """The SDK's real OAuth machinery (RFC 9728/8414 discovery, RFC 7591 DCR, PKCE, token exchange) with the browser leg driven by Playwright against the upstream's consent screen.""" code_holder: dict[str, str | None] = {} # mutable-ok: hand-off between the two SDK callbacks - async def redirect_handler(authorize_url: str) -> None: - code, state = await _browser_follow_authorize(authorize_url, storage_state_path) + async def _reject_redirect(_: str) -> None: + raise AssertionError("gateway demanded a fresh upstream consent; stored per-user token was not reused") + + async def _follow_redirect(authorize_url: str) -> None: + assert storage_state_path is not None + code, state = await _browser_follow_authorize( + authorize_url, storage_state_path, identity, server_alias, allow_upstream_consent + ) code_holder["code"] = code code_holder["state"] = state + redirect_handler: Final = _reject_redirect if storage_state_path is None else _follow_redirect + async def callback_handler() -> AuthorizationCodeResult: code = code_holder.get("code") assert code is not None, "callback_handler ran before the authorize redirect completed" @@ -167,24 +224,45 @@ class _HeaderInjectingTransport(httpx2.AsyncBaseTransport): store the upstream token for from the key on the token exchange, exactly like a production MCP host configured with a LiteLLM key header.""" - def __init__(self, inner: httpx2.AsyncBaseTransport, headers: dict[str, str]) -> None: + def __init__(self, inner: httpx2.AsyncBaseTransport, headers: dict[str, str], gateway_url: str) -> None: self._inner = inner self._headers = headers + self._gateway_url = httpx2.URL(gateway_url) + + @staticmethod + def _port(url: httpx2.URL) -> int | None: + if url.port is not None: + return url.port + return {"http": 80, "https": 443}.get(url.scheme) async def handle_async_request(self, request: httpx2.Request) -> httpx2.Response: - for name, value in self._headers.items(): - if name not in request.headers: - request.headers[name] = value + same_origin: Final = ( + request.url.scheme == self._gateway_url.scheme + and request.url.host == self._gateway_url.host + and self._port(request.url) == self._port(self._gateway_url) + ) + if same_origin: + for name, value in self._headers.items(): + if name not in request.headers: + request.headers[name] = value + else: + for name, value in self._headers.items(): + if request.headers.get(name) == value: + del request.headers[name] return await self._inner.handle_async_request(request) + async def aclose(self) -> None: + await self._inner.aclose() -def _oauth_http_client(headers: dict[str, str], auth: OAuthClientProvider) -> httpx2.AsyncClient: + +def _oauth_http_client( + headers: dict[str, str], auth: OAuthClientProvider, gateway_url: str = PROXY_BASE_URL +) -> httpx2.AsyncClient: return httpx2.AsyncClient( - headers=headers, auth=auth, timeout=httpx2.Timeout(REQUEST_TIMEOUT), follow_redirects=True, - transport=_HeaderInjectingTransport(httpx2.AsyncHTTPTransport(), headers), + transport=_HeaderInjectingTransport(httpx2.AsyncHTTPTransport(), headers, gateway_url), ) @@ -199,6 +277,43 @@ async def _seed_via_dance( return tuple(sorted(tool.name for tool in listed.tools)) +@dataclass(frozen=True, slots=True) +class OauthToolRun: + tools: tuple[str, ...] + is_error: bool + text: str + + +async def _list_and_call( + url: str, + headers: dict[str, str], + storage: InMemoryTokenStorage, + storage_state_path: str | None, + tool: str, + arguments: dict[str, str], + gateway_url: str = PROXY_BASE_URL, + identity: Identity | None = None, + server_alias: str | None = None, + allow_upstream_consent: bool = True, +) -> OauthToolRun: + async with _oauth_http_client( + headers, + _oauth_provider(url, storage, storage_state_path, identity, server_alias, allow_upstream_consent), + gateway_url, + ) as http_client: + async with streamable_http_client(url, http_client=http_client) as (read, write): + async with ClientSession(read, write) as session: + await session.initialize() + listed: Final = await session.list_tools() + result: Final = await session.call_tool(tool, arguments) + text: Final = "".join(content.text for content in result.content if isinstance(content, TextContent)) + return OauthToolRun( + tools=tuple(sorted(tool_item.name for tool_item in listed.tools)), + is_error=result.is_error, + text=text, + ) + + @dataclass(frozen=True, slots=True) class ChatMcpClient: proxy: ProxyClient @@ -252,6 +367,53 @@ class ChatMcpClient: f"last error: {last_error!r}" ) + def list_and_call( + self, + alias: str, + headers: dict[str, str], + storage: InMemoryTokenStorage, + storage_state_path: str | None, + tool: str, + arguments: dict[str, str], + base_url: str = PROXY_BASE_URL, + identity: Identity | None = None, + allow_upstream_consent: bool = True, + ) -> OauthToolRun: + return asyncio.run( + _list_and_call( + f"{base_url.rstrip('/')}/mcp" if identity is not None else _mcp_url(alias, base_url), + headers, + storage, + storage_state_path, + tool, + arguments, + base_url, + identity, + alias, + allow_upstream_consent, + ) + ) + + def server_user_credentials(self, server_id: str) -> tuple[McpServerUserCredentialRow, ...]: + return unwrap( + self.proxy.transport.get( + f"/v1/mcp/server/{server_id}/user-credentials", + headers=self.proxy.transport.master, + params=NoBody(), + response_type=McpServerUserCredentialListResponse, + ) + ).root + + def revoke_user_token(self, server_id: str, headers: AuthHeaders) -> None: + _ = unwrap( + self.proxy.transport.delete( + f"/v1/mcp/server/{server_id}/oauth-user-credential", + headers=headers, + json=NoBody(), + response_type=McpOauthUserCredentialStatus, + ) + ) + def chat_with_mcp(self, headers: AuthHeaders, body: ChatBody) -> ChatResponse: """POST /chat/completions carrying the LiteLLM key in `headers` (either ingress form) with an MCP server attached in `body.tools`. The gateway diff --git a/tests/e2e/mcp/oauth_gateway.py b/tests/e2e/mcp/oauth_gateway.py new file mode 100644 index 00000000000..82bb5f7ba0b --- /dev/null +++ b/tests/e2e/mcp/oauth_gateway.py @@ -0,0 +1,198 @@ +"""An owned, source-built OAuth gateway with cold restarts and credential observations. + +Only this child process is restarted. Its database and SSO client survive while +its process-local caches do not; Redis is deliberately absent from its config. +The optional live edge measures headers without recording credentials or bodies. +""" + +from __future__ import annotations + +import os +import socket +import subprocess +import sys +import threading +import time +from collections.abc import Callable, Mapping +from contextlib import ExitStack +from dataclasses import dataclass, field +from pathlib import Path +from typing import Final + +import psycopg +from e2e_http import NoBody +from idp import Keycloak, stop_process_group +from proxy_client import ProxyClient, build_proxy_client +from psycopg.rows import class_row +from pydantic import BaseModel, SecretStr, TypeAdapter, ValidationError + +INHERITED_ENV_PREFIXES: Final = ("REDIS_", "MICROSOFT_", "GOOGLE_", "GENERIC_", "PROXY_") + + +class StoredOAuth(BaseModel): + type: str + access_token: SecretStr + + +@dataclass(frozen=True, slots=True) +class CredentialRow: + credential_b64: str = field(repr=False) + + +def stored_oauth(user_id: str, server_id: str) -> StoredOAuth: + """Read the encrypted credential because management APIs omit the plaintext token.""" + from litellm.proxy.common_utils.encrypt_decrypt_utils import decrypt_value_helper + + with psycopg.Connection[CredentialRow].connect( + os.environ["DATABASE_URL"], row_factory=class_row(CredentialRow) + ) as conn: + row: Final = conn.execute( + 'SELECT credential_b64 FROM "LiteLLM_MCPUserCredentials" WHERE user_id = %s AND server_id = %s', + (user_id, server_id), + ).fetchone() + assert row is not None, "canonical user/server has no persisted credential" + plaintext: Final = decrypt_value_helper( + row.credential_b64, "e2e_mcp_oauth", exception_type="debug", return_original_value=False + ) + assert plaintext is not None, "persisted credential must decrypt with the gateway salt" + assert plaintext != row.credential_b64, "persisted credential must be encrypted" + try: + credential: Final = StoredOAuth.model_validate_json(plaintext) + except ValidationError: + raise AssertionError("decrypted credential is not an OAuth payload") from None + assert credential.type == "oauth2" + assert bool(credential.access_token.get_secret_value()), "stored upstream token is empty" + return credential + + +class RpcMethod(BaseModel): + method: str = "" + + +@dataclass(slots=True) +class OAuthObservation: + gateway_token: str = field(default="", repr=False) + _seen: tuple[tuple[str, str, bool], ...] = field(default=(), init=False, repr=False) + _lock: threading.Lock = field(default_factory=threading.Lock, init=False, repr=False) + + def observe(self, url: str, headers: Mapping[str, str], body: bytes | None) -> None: + if body is None or not url.endswith("/mcp"): + return + try: + operation: Final = RpcMethod.model_validate_json(body).method + except ValidationError: + return + if operation not in ("tools/list", "tools/call"): + return + received: Final = headers.get("authorization", "") + gateway_leaked: Final = any( + value in (self.gateway_token, f"Bearer {self.gateway_token}") for value in headers.values() + ) + with self._lock: + self._seen = (*self._seen, (operation, received, gateway_leaked)) + + def assert_forwarded(self, expected: StoredOAuth) -> None: + with self._lock: + snapshot: Final = self._seen + self._seen = () + assert {item[0] for item in snapshot} == {"tools/list", "tools/call"}, "missing upstream observations" + expected_header: Final = f"Bearer {expected.access_token.get_secret_value()}" + assert all(item[1] == expected_header for item in snapshot), "upstream bearer did not match the stored token" + assert all(not item[2] for item in snapshot), "gateway bearer leaked to the upstream" + + +def available_port() -> int: + with socket.socket() as listener: + listener.bind(("127.0.0.1", 0)) + return TypeAdapter(tuple[str, int]).validate_python(listener.getsockname())[1] + + +@dataclass(slots=True) +class OAuthGateway: + base_url: str + proxy: ProxyClient + _environment: Mapping[str, str] = field(repr=False) + _command: tuple[str, ...] = field(repr=False) + _log_path: Path + _child: subprocess.Popen[bytes] | None = field(default=None, init=False, repr=False) + + def start(self) -> None: + with self._log_path.open("ab") as log: + self._child = subprocess.Popen( + self._command, + env=self._environment, + stdout=log, + stderr=log, + start_new_session=True, + ) + deadline: Final = time.monotonic() + 120 + while time.monotonic() < deadline: + assert self._child.poll() is None, "owned OAuth gateway exited; inspect its private log" + result = self.proxy.transport.probe("/health/liveliness", params=NoBody()) + if result.status_code == 200: + return + time.sleep(0.5) + raise AssertionError("owned OAuth gateway did not become ready") + + def stop(self) -> None: + if self._child is not None: + stop_process_group(self._child) + assert self._child.poll() is not None, "old gateway process is still alive" + + def restart(self) -> None: + assert self._child is not None + previous: Final = self._child.pid + self.stop() + self.start() + assert self._child.pid != previous, "gateway restart did not create a new process" + + +def owned_gateway(idp: Keycloak, directory: Path, cleanup: ExitStack) -> OAuthGateway: + for name in ("DATABASE_URL", "LITELLM_LICENSE", "LITELLM_SALT_KEY", "LITELLM_MASTER_KEY"): + assert os.environ.get(name), f"{name} is required for the owned OAuth gateway" + port: Final = available_port() + base_url: Final = f"http://127.0.0.1:{port}" + + def defer(callback: Callable[[], object]) -> None: + cleanup.callback(callback) + + browser: Final = idp.browser_client(callback_url=f"{base_url}/sso/callback", defer=defer) + config: Final = directory / "oauth-gateway.yaml" + config.write_text( + "model_list: []\n" + "general_settings:\n" + " master_key: os.environ/LITELLM_MASTER_KEY\n" + " database_url: os.environ/DATABASE_URL\n" + " enable_jwt_auth: true\n" + " litellm_jwtauth:\n" + " user_id_jwt_field: sub\n" + " user_email_jwt_field: email\n" + " team_ids_jwt_field: groups\n" + " user_id_upsert: true\n" + ) + environment: Final = { + **{key: value for key, value in os.environ.items() if not key.startswith(INHERITED_ENV_PREFIXES)}, + **browser.environment(idp.discovery()), + "PROXY_BASE_URL": base_url, + "JWT_PUBLIC_KEY_URL": idp.jwks_url, + "JWT_ISSUER": idp.issuer, + "JWT_AUDIENCE": "litellm-e2e", + "DISABLE_SCHEMA_UPDATE": "true", + "STORE_MODEL_IN_DB": "True", + "PYTHONPATH": str(Path(__file__).resolve().parents[3]), + } + gateway: Final = OAuthGateway( + base_url=base_url, + proxy=build_proxy_client( + base_url=base_url, + control_plane_base_url=base_url, + replica_urls=(base_url,), + master_key=os.environ["LITELLM_MASTER_KEY"], + ), + _environment=environment, + _command=(sys.executable, "-m", "litellm.proxy.proxy_cli", "--config", str(config), "--port", str(port)), + _log_path=directory / "oauth-gateway.log", + ) + cleanup.callback(gateway.stop) + gateway.start() + return gateway diff --git a/tests/e2e/mcp/test_mcp_oauth_happy_path_e2e.py b/tests/e2e/mcp/test_mcp_oauth_happy_path_e2e.py new file mode 100644 index 00000000000..c20b73c0d63 --- /dev/null +++ b/tests/e2e/mcp/test_mcp_oauth_happy_path_e2e.py @@ -0,0 +1,207 @@ +"""Real OAuth consent, immediate MCP operations and cold-restart persistence. + +Aggregate SSO uses the SDK's normal authentication. The per-server variant is +explicitly a configured two-header client, not an Authorization-only OAuth host. +The observed variants forward to the same real Linear upstream and compare its +bearer at the forwarding boundary; direct variants retain unmodified discovery. +""" + +from __future__ import annotations + +import os +from collections.abc import Iterator +from contextlib import ExitStack +from pathlib import Path +from types import MappingProxyType +from typing import Final, Literal + +import pytest +from e2e_config import LINEAR_MCP_URL, LINEAR_READONLY_TOOL, LINEAR_STORAGE_STATE, unique_marker +from e2e_http import AuthHeaders, NoBody, get_external, unwrap +from idp import Identity, Keycloak +from lifecycle import ResourceManager +from models import ( + McpOauthCredentials, + McpServerCreateBody, + ObjectPermission, + TeamMemberAddBody, + TeamMemberEntry, + TeamUpdateBody, +) +from oauth_chat_client import ChatMcpClient, InMemoryTokenStorage, OauthToolRun, build_chat_client +from oauth_gateway import OAuthGateway, OAuthObservation, owned_gateway, stored_oauth +from provider_edge import LiveEdge, start_provider_edge +from proxy_client import ProxyClient +from pydantic import BaseModel, ValidationError + +pytestmark = [pytest.mark.e2e, pytest.mark.mcp_oauth_live, pytest.mark.provider_live] + + +class OAuthMetadata(BaseModel): + authorization_endpoint: str + token_endpoint: str + registration_endpoint: str + + +class LinearTeam(BaseModel): + id: str + name: str + + +class LinearTeams(BaseModel): + teams: tuple[LinearTeam, ...] + + +def assert_tool_result(run: OauthToolRun, tool: str) -> None: + assert tool in run.tools + assert run.is_error is False + try: + result: Final = LinearTeams.model_validate_json(run.text) + except ValidationError: + raise AssertionError("list_teams did not return the expected teams payload") from None + assert result.teams, "the test workspace must contain at least one team" + assert all(team.id and team.name for team in result.teams), "team results must contain identifiers and names" + + +@pytest.fixture(scope="module") +def oauth_gateway(idp: Keycloak, tmp_path_factory: pytest.TempPathFactory) -> Iterator[OAuthGateway]: + assert LINEAR_STORAGE_STATE and Path(LINEAR_STORAGE_STATE).is_file(), ( + "E2E_LINEAR_STORAGE_STATE must name a captured Linear login; see mcp/linear_session_capture.py" + ) + assert os.environ.get("E2E_FIXTURE_MODE", "live") == "live", "OAuth acceptance cannot use replay" + with ExitStack() as cleanup: + yield owned_gateway(idp, tmp_path_factory.mktemp("mcp-oauth"), cleanup) + + +@pytest.fixture(scope="module") +def proxy(oauth_gateway: OAuthGateway) -> ProxyClient: + return oauth_gateway.proxy + + +@pytest.fixture(scope="module") +def client(proxy: ProxyClient) -> ChatMcpClient: + return build_chat_client(proxy) + + +class TestMcpOauthHappyPath: + @pytest.mark.covers("mcp.list_tools.oauth.succeeds") + @pytest.mark.covers("mcp.call_tool.oauth.succeeds") + @pytest.mark.covers("mcp.call_tool.oauth.persists_across_processes") + @pytest.mark.parametrize("route", ("aggregate_sso", "explicit_header_jwt")) + @pytest.mark.parametrize("observed", (False, True), ids=("direct", "observed")) + def test_consent_list_call_and_cold_restart( + self, + client: ChatMcpClient, + resources: ResourceManager, + jwt_identity: Identity, + idp: Keycloak, + oauth_gateway: OAuthGateway, + route: Literal["aggregate_sso", "explicit_header_jwt"], + observed: bool, + ) -> None: + alias: Final = f"e2elinear{unique_marker()}" + tool: Final = f"{alias}-{LINEAR_READONLY_TOOL}" + token: Final = idp.access_token(jwt_identity) + observation: Final = OAuthObservation(gateway_token=token) + edge: Final = ( + start_provider_edge( + LiveEdge(observe_request=observation.observe), + mounts=MappingProxyType( + {"linear": "https://mcp.linear.app", ".well-known": "https://mcp.linear.app/.well-known"} + ), + ) + if observed + else None + ) + if edge is not None: + resources.defer(edge.shutdown) + metadata: Final = ( + unwrap( + get_external( + "https://mcp.linear.app/.well-known/oauth-authorization-server", + response_type=OAuthMetadata, + ) + ) + if observed + else None + ) + created: Final = client.create_server( + McpServerCreateBody( + alias=alias, + server_name=alias, + url=f"{edge.edge.api_base('linear')}/mcp" if edge is not None else LINEAR_MCP_URL, + transport="http", + allow_all_keys=False, + auth_type="oauth2", + oauth2_flow="authorization_code", + per_server_oauth_discovery=route == "explicit_header_jwt", + authorization_url=metadata.authorization_endpoint if metadata else None, + token_url=metadata.token_endpoint if metadata else None, + registration_url=metadata.registration_endpoint if metadata else None, + credentials=McpOauthCredentials(upstream_resource=LINEAR_MCP_URL) if observed else None, + ) + ) + resources.defer(lambda: client.delete_server(created.server_id)) + assert client.server_user_credentials(created.server_id) == (), ( + "scenario must start without upstream credentials" + ) + unwrap( + client.proxy.transport.post( + "/team/member_add", + headers=client.proxy.transport.master, + json=TeamMemberAddBody( + team_id=jwt_identity.group, member=TeamMemberEntry(user_id=jwt_identity.user_id, role="user") + ), + response_type=NoBody, + ) + ) + client.proxy.update_team( + TeamUpdateBody( + team_id=jwt_identity.group, + object_permission=ObjectPermission(mcp_servers=[created.server_id]), + ) + ) + headers: Final = {"x-litellm-api-key": f"Bearer {token}"} if route == "explicit_header_jwt" else {} + resources.defer( + lambda: client.revoke_user_token( + created.server_id, + AuthHeaders(authorization=f"Bearer {idp.access_token(jwt_identity)}"), + ) + ) + identity: Final = jwt_identity if route == "aggregate_sso" else None + first: Final = client.list_and_call( + alias, + headers, + InMemoryTokenStorage(), + LINEAR_STORAGE_STATE, + tool, + {}, + base_url=oauth_gateway.base_url, + identity=identity, + ) + assert_tool_result(first, tool) + credentials: Final = client.server_user_credentials(created.server_id) + assert len(credentials) == 1 + assert credentials[0].user_id == jwt_identity.user_id + assert credentials[0].credential_type == "oauth2" + first_stored_oauth: Final = stored_oauth(jwt_identity.user_id, created.server_id) + if observed: + observation.assert_forwarded(first_stored_oauth) + oauth_gateway.restart() + fresh_token: Final = idp.access_token(jwt_identity) + observation.gateway_token = fresh_token + second: Final = client.list_and_call( + alias, + {"Authorization": f"Bearer {fresh_token}"} if identity is None else {}, + InMemoryTokenStorage(), + LINEAR_STORAGE_STATE if identity is not None else None, + tool, + {}, + base_url=oauth_gateway.base_url, + identity=identity, + allow_upstream_consent=False, + ) + assert_tool_result(second, tool) + second_stored_oauth: Final = stored_oauth(jwt_identity.user_id, created.server_id) + if observed: + observation.assert_forwarded(second_stored_oauth) diff --git a/tests/e2e/models.py b/tests/e2e/models.py index 9f49c5974d0..4b202e3c663 100644 --- a/tests/e2e/models.py +++ b/tests/e2e/models.py @@ -192,7 +192,7 @@ class ImageUrl(BaseModel): class TextContentPart(BaseModel): type: str = "text" text: str - cache_control: "CacheControl | None" = None + cache_control: CacheControl | None = None class ImageContentPart(BaseModel): @@ -572,6 +572,10 @@ class McpInfo(BaseModel): logo_url: str | None = None +class McpOauthCredentials(BaseModel): + upstream_resource: str + + class McpServerCreateBody(BaseModel): """POST /v1/mcp/server. For a gateway-managed OAuth server, `auth_type` is `oauth2` and `oauth2_flow` is `authorization_code`; the upstream endpoints @@ -584,8 +588,11 @@ class McpServerCreateBody(BaseModel): allow_all_keys: bool = True auth_type: str | None = None oauth2_flow: Literal["client_credentials", "authorization_code"] | None = None + per_server_oauth_discovery: bool | None = None authorization_url: str | None = None token_url: str | None = None + registration_url: str | None = None + credentials: McpOauthCredentials | None = None server_name: str | None = None description: str | None = None mcp_info: McpInfo | None = None @@ -625,6 +632,26 @@ class McpServerListResponse(RootModel[list[McpServerRow]]): """GET /v1/mcp/server answers with a bare array of servers.""" +class McpServerUserCredentialRow(BaseModel): + user_id: str + credential_type: Literal["oauth2", "byok"] + expires_at: str | None = None + connected_at: str | None = None + updated_at: str + + +class McpServerUserCredentialListResponse(RootModel[tuple[McpServerUserCredentialRow, ...]]): + """GET /v1/mcp/server/{server_id}/user-credentials answers with a bare array.""" + + +class McpOauthUserCredentialStatus(BaseModel): + server_id: str + has_credential: bool + expires_at: str | None = None + is_expired: bool = False + connected_at: str | None = None + + class ToolsetTool(BaseModel): server_id: str tool_name: str @@ -1172,8 +1199,9 @@ class TeamNewResponse(BaseModel): class TeamUpdateBody(BaseModel): team_id: str - team_alias: str + team_alias: str | None = None models: list[str] | None = None + object_permission: ObjectPermission | None = None class TeamInfoParams(BaseModel): diff --git a/tests/e2e/provider_edge.py b/tests/e2e/provider_edge.py index 7bbb1375623..136b00208f7 100644 --- a/tests/e2e/provider_edge.py +++ b/tests/e2e/provider_edge.py @@ -46,7 +46,7 @@ import os import re import threading from collections import deque -from collections.abc import Generator, Mapping, Sequence +from collections.abc import Callable, Generator, Mapping, Sequence from contextlib import closing, contextmanager from dataclasses import dataclass, field, replace from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer @@ -538,7 +538,7 @@ class ReplayEdge: @dataclass(frozen=True, slots=True) class LiveEdge: - pass + observe_request: Callable[[str, Mapping[str, str], bytes | None], None] | None = None type EdgeBackend = RecordEdge | ReplayEdge | LiveEdge | CacheEdge @@ -787,10 +787,13 @@ def _handle_record( def _handle_live( method: str, url: str, headers: Mapping[str, str], body: bytes | None, timeout: float, cache: CacheEdge | None = None, mount: str = "", test_key: str | None = None, + observe_request: Callable[[str, Mapping[str, str], bytes | None], None] | None = None, ) -> EdgeOutcome: forwarded: Final = { name: value for name, value in headers.items() if name.lower() not in _REQUEST_DROPPED_HEADERS } + if observe_request is not None: + observe_request(url, forwarded, body) head: Final = ( forward_stream(method, url, headers=forwarded, body=body, timeout=timeout) if cache is None else cache.forward(mount, method, url, forwarded, body, timeout, test_key=test_key) @@ -868,9 +871,10 @@ def handle_edge_request( method, _upstream_url(upstream_base, upstream_path, split.query), headers, body, timeout, backend, mount, test_key, ) - case LiveEdge(): + case LiveEdge(observe_request=observe_request): return _handle_live( - method, _upstream_url(upstream_base, upstream_path, split.query), headers, body, timeout + method, _upstream_url(upstream_base, upstream_path, split.query), headers, body, timeout, + observe_request=observe_request, ) case RecordEdge(): return _handle_record( diff --git a/tests/e2e/proxy_client.py b/tests/e2e/proxy_client.py index 44d9df5e5c5..c6ede240c3b 100644 --- a/tests/e2e/proxy_client.py +++ b/tests/e2e/proxy_client.py @@ -89,6 +89,7 @@ from models import ( TeamDeleteBody, TeamNewBody, TeamNewResponse, + TeamUpdateBody, ToolsetCreateBody, ToolsetRow, ToolsetUpdateBody, @@ -871,6 +872,16 @@ class ProxyClient: ) ).team_id + def update_team(self, body: TeamUpdateBody) -> None: + unwrap( + self.transport.post( + "/team/update", + headers=self.transport.master, + json=body, + response_type=NoBody, + ) + ) + def delete_team(self, team_id: str) -> None: result = self.transport.post( "/team/delete", diff --git a/tests/e2e/pytest.ini b/tests/e2e/pytest.ini index f9e5995079b..97acb9ec52b 100644 --- a/tests/e2e/pytest.ini +++ b/tests/e2e/pytest.ini @@ -12,3 +12,4 @@ markers = prompt_caching_stack: needs a proxy running with router_settings.optional_pre_call_checks including prompt_caching; deselected unless E2E_PROMPT_CACHING_STACK is set cli_determinism: drives the real claude CLI for several seconds; deselected unless E2E_CLI_DETERMINISM is set redis_chaos: load test that pauses the proxy's Redis outright mid-run; needs a proxy booted from gateway/redis_chaos_ci_config.yml on the same host, and is deselected unless E2E_REDIS_CHAOS is set + mcp_oauth_live: real Linear OAuth consent via a captured browser session; deselected unless E2E_MCP_OAUTH_LIVE is set diff --git a/tests/integration/_support/mcp.py b/tests/integration/_support/mcp.py index d924ee6dad0..bdf60becbaa 100644 --- a/tests/integration/_support/mcp.py +++ b/tests/integration/_support/mcp.py @@ -9,7 +9,7 @@ import httpx from integration._support.asgi import asgi_server from integration._support.client import Gateway, Scenario from integration._support.database import read_rows -from mcp.server.fastmcp import FastMCP +from mcp.server.mcpserver import MCPServer from mcp.server.transport_security import TransportSecuritySettings from mcp_tests.mcp_e2e_upstream_server import add, multiply from starlette.requests import Request @@ -27,12 +27,7 @@ class McpPeer: @contextmanager def mcp_peer() -> Iterator[McpPeer]: - service: Final = FastMCP( - "integration-math", - stateless_http=True, - json_response=True, - transport_security=TransportSecuritySettings(enable_dns_rebinding_protection=False), - ) + service: Final = MCPServer("integration-math") service.add_tool(add) service.add_tool(multiply) @@ -40,7 +35,11 @@ def mcp_peer() -> Iterator[McpPeer]: def fail() -> str: raise ValueError("synthetic tool failure") - app: Final = service.streamable_http_app() + app: Final = service.streamable_http_app( + stateless_http=True, + json_response=True, + transport_security=TransportSecuritySettings(enable_dns_rebinding_protection=False), + ) observed: Final[queue.Queue[dict[str, object]]] = queue.Queue() async def capture(scope: Scope, receive: Receive, send: Send) -> None: @@ -94,9 +93,7 @@ def tool_names(gateway: Gateway, key: str, identity: str) -> dict[str, str]: } -def call_tool( - gateway: Gateway, key: str, identity: str, name: str, arguments: dict[str, object] -) -> httpx.Response: +def call_tool(gateway: Gateway, key: str, identity: str, name: str, arguments: dict[str, object]) -> httpx.Response: return gateway.client.post( "/mcp-rest/tools/call", headers={"x-litellm-api-key": key}, diff --git a/tests/integration/contracts.json b/tests/integration/contracts.json index fe7b6dfe7ac..3f1ecab3489 100644 --- a/tests/integration/contracts.json +++ b/tests/integration/contracts.json @@ -1311,6 +1311,27 @@ ], "tests/integration/cost_calculation/test_cost_tracking.py::test_case_bills_expected_cost[us.anthropic.claude-opus-5-v1:0-stream_full_usage]": [ "quota_management.spend_tracking.scripted_wire.logs_cost" + ], + "tests/integration/mcp/test_mcp_lifecycle.py::test_health_intersects_route_restricted_key_grants_in_both_management_modes": [ + "other.mcp.health.restricted_keys_intersect_grants_in_both_modes" + ], + "tests/integration/mcp/test_mcp_lifecycle.py::test_warm_credential_removal_rejects_without_upstream_traffic": [ + "other.mcp.credentials.warm_removal_fails_closed_without_upstream_traffic" + ], + "tests/integration/observability/test_guardrail_effects.py::test_request_selected_mcp_guardrail_blocks_direct_and_virtual_calls": [ + "other.mcp.guardrails.request_selection_blocks_resolved_tool_without_execution" + ], + "tests/integration/mcp/test_oauth_configuration.py::test_same_url_oauth_credentials_and_revocation_are_isolated_by_user_and_server[revoke]": [ + "other.mcp.oauth.same_url_credentials_are_isolated_by_user_and_server" + ], + "tests/integration/mcp/test_oauth_configuration.py::test_same_url_oauth_credentials_and_revocation_are_isolated_by_user_and_server[expire]": [ + "other.mcp.oauth.same_url_credentials_are_isolated_by_user_and_server" + ], + "tests/integration/mcp/test_mcp_lifecycle.py::test_same_url_server_grants_scope_discovery_and_direct_or_virtual_execution[anonymous]": [ + "other.mcp.permissions.same_url_servers_enforce_discovery_and_execution" + ], + "tests/integration/mcp/test_mcp_lifecycle.py::test_same_url_server_grants_scope_discovery_and_direct_or_virtual_execution[bearer]": [ + "other.mcp.permissions.same_url_servers_enforce_discovery_and_execution" ] }, "browser": { diff --git a/tests/integration/mcp/README.md b/tests/integration/mcp/README.md new file mode 100644 index 00000000000..6260d128a2c --- /dev/null +++ b/tests/integration/mcp/README.md @@ -0,0 +1,28 @@ +# MCP security regression coverage + +[LIT-4506](https://linear.app/litellm-ai/issue/LIT-4506) tracks ten gateway guards and the later JWT/OAuth acceptance. This inventory distinguishes executable assertions from unresolved coverage. A listed test counts as verified only when its exact commit has an executed, passing result + +Run the controlled gateway cases through `python tests/integration/run.py extensions`. They use real HTTP, PostgreSQL, scoped non-master keys and an SDK upstream. The existing runner supplies test entitlement; these tests do not validate licenses or external-provider consent. Canonical nodes and contract IDs live in `../contracts.json` + +| Requested guard | Existing or added coverage | Remaining limitation and owner | +| --- | --- | --- | +| 1. Discovery scoped by org/team/user/key | `test_mcp_lifecycle.py` checks the exact key-granted catalog and health visibility in both management modes. [PR #38680](https://github.com/BerriAI/litellm/pull/38680) adds team/org/user toolset E2E assertions | Per-principal native MCP coverage is not established by REST results; reuse #38680 rather than duplicate it | +| 2. Users cannot attach unauthorized servers to their own keys | Existing live probes are recorded on LIT-4506; they are not durable endpoint regression tests | Own-key create/update escalation and its permission-validator boundary remain on existing management security tickets, including [LIT-4502](https://linear.app/litellm-ai/issue/LIT-4502). A generic route denial does not prove that validator ran | +| 3. UI/API permission parity | Existing dashboard tests cover admin operations | The same non-admin actor must be tested through browser and API; admin UI tests do not establish parity. Retained with [LIT-3644](https://linear.app/litellm-ai/issue/LIT-3644) | +| 4. Server ID determines identity | `test_mcp_lifecycle.py` grants one of two servers sharing a URL and denies calls to the other, using explicit server IDs for direct REST calls and server-qualified search results for virtual calls, with and without bearer credentials | Virtual calls identify the target by the searched tool name, not the REST `server_id` field. Bare names such as `add` are ambiguous across servers; duplicate aliases/names and unprefixed protocol routing remain with [LIT-4500](https://linear.app/litellm-ai/issue/LIT-4500) | +| 5. Same-URL servers do not share credentials | `test_oauth_configuration.py` crosses two gateway users with two server IDs and four distinct stored OAuth tokens. It checks actual upstream headers and successful results, then invalidates only one tuple | Controlled stored-token tests do not prove separate external-provider accounts or consent flows | +| 6. OAuth never falls back to anonymous | OAuth isolation variants remove a stored token or expire it without refresh, require separate list/call auth failures and no upstream requests, and preserve all other valid tuples. `test_mcp_lifecycle.py` also covers warm static-header removal and OBO without a caller JWT | External upstream revocation, refresh/reauthorization and aggregate challenges remain with [LIT-4501](https://linear.app/litellm-ai/issue/LIT-4501), [LIT-3433](https://linear.app/litellm-ai/issue/LIT-3433), [LIT-4422](https://linear.app/litellm-ai/issue/LIT-4422) and [LIT-4436](https://linear.app/litellm-ai/issue/LIT-4436) | +| 7. Stateful HTTP/session continuity | Legacy public-client tests exercise initialized sessions | No claim here proves upstream session state continuity; retained under [LIT-3143](https://linear.app/litellm-ai/issue/LIT-3143) | +| 8. Production guardrails/hooks run | `../observability/test_guardrail_effects.py` checks selected pre-call guards on direct and virtual execution, key/team/request selection, allowed results and zero denied executions. The two legacy test-owned dispatcher files are removed | This does not establish every post-call/output-scanning or concurrent hook contract | +| 9. Permissions enforced at discovery and execution | Exact key catalog and virtual search results plus forbidden direct/virtual calls in `test_mcp_lifecycle.py`; existing `../compatibility/test_persisted_toolsets.py` checks tool-level ceiling, denied sibling and allowed control | All principal/transport combinations are not established; link #38680's evidence for its additional principal cases | +| 10. Stateless/stateful matrix | These controlled peers use stateless HTTP upstreams | Stateful combinations depend on LIT-3143 and shared conformance runs. Modern-agent/legacy-upstream interaction remains deferred; legacy passes do not establish modern conformance | + +## Additional JWT/OAuth acceptance + +[LIT-3467 / PR #41909](https://github.com/BerriAI/litellm/pull/41909) owns one shared real login/consent, immediate list/call and cold-restart implementation, with aggregate SSO and explicitly configured per-server JWT variants. Reuse that implementation and its protected login secret; do not create another browser bootstrap here. Credit its exact-commit evidence separately from these controlled credential tests + +The two-user/two-server cases here create non-admin users and scoped API keys through management APIs. They store synthetic upstream OAuth credentials through the real credential endpoint and assert the actual bearer at the owned upstream. This deliberately isolates credential lookup, expiry and revocation from consent. No gateway API key may replace the expected upstream token + +Gateway JWT precedence, invalid/expired gateway JWTs, inactive-user denial, and their MCP-specific interaction with isolated credential lookup remain unverified by these API-key cases. General JWT unit/API tests are useful existing coverage but do not substitute for those MCP outcomes. Real-provider auth failures should extend LIT-3467's settled helpers; its explicit-header case must not be described as an uninterrupted Authorization-only OAuth flow + +[PR #41718 / LIT-7737](https://github.com/BerriAI/litellm/pull/41718) owns dependency and public-client compatibility checks. This suite consumes the merged SDK2 API and keeps the existing dependency constraints. Its result must be reported independently of an installation-matrix pass diff --git a/tests/integration/mcp/test_mcp_lifecycle.py b/tests/integration/mcp/test_mcp_lifecycle.py index 7ded23794be..b32cf97605f 100644 --- a/tests/integration/mcp/test_mcp_lifecycle.py +++ b/tests/integration/mcp/test_mcp_lifecycle.py @@ -1,14 +1,18 @@ +import json import uuid from contextlib import ExitStack +from pathlib import Path from typing import Final import pytest +import yaml from hypothesis import strategies as st from hypothesis.stateful import RuleBasedStateMachine, invariant, rule, run_state_machine_as_test from integration._support.client import Gateway from integration._support.database import read_rows from integration._support.generation import LIFECYCLE_SETTINGS, bounded_http_requests +from integration._support.process import owned_proxy from integration._support.mcp import call_tool, mcp_peer, register_mcp, tool_names @@ -53,7 +57,7 @@ def test_tool_error_remains_error_and_healthy_sibling_returns_value(gateway: Gat failure: Final = call_tool(gateway, key, identity, names["fail"], {}) assert failure.status_code == 200, failure.text assert failure.json()["isError"] is True - assert "synthetic tool failure" in failure.json()["content"][0]["text"] + assert failure.json()["content"][0]["text"] == "Error executing tool fail" healthy: Final = call_tool(gateway, key, identity, names["multiply"], {"a": 3, "b": 5}) assert healthy.status_code == 200, healthy.text assert healthy.json()["isError"] is False @@ -121,3 +125,182 @@ def test_generated_mcp_edits_preserve_actual_headers_and_tool_results(gateway: G self.resources.close() run_state_machine_as_test(Servers, settings=LIFECYCLE_SETTINGS) + + +@pytest.mark.covers("other.mcp.health.restricted_keys_intersect_grants_in_both_modes") +def test_health_intersects_route_restricted_key_grants_in_both_management_modes( + gateway: Gateway, tmp_path: Path +) -> None: + for mode in ("restricted", "view_all"): + config = yaml.safe_load(Path("tests/integration/proxy_config.yaml").read_text()) + config["general_settings"]["user_mcp_management_mode"] = mode + path = tmp_path / f"health-{mode}.yaml" + path.write_text(yaml.safe_dump(config)) + with ( + owned_proxy(gateway, tmp_path, {}, config=path) as candidate, + mcp_peer() as peer, + candidate.scenario() as scenario, + ): + first = register_mcp(scenario, peer, "health" + uuid.uuid4().hex) + second = register_mcp(scenario, peer, "health" + uuid.uuid4().hex) + control = scenario.key(object_permission={"mcp_servers": [first]}) + names = tool_names(candidate, control, first) + healthy = call_tool(candidate, control, first, names["add"], {"a": 3, "b": 5}) + assert healthy.status_code == 200 and healthy.json()["content"][0]["text"] == "8", healthy.text + for grants in ([first], [second], []): + key = scenario.key( + allowed_routes=["/v1/mcp/server", "/v1/mcp/server/health"], + object_permission={"mcp_servers": grants}, + ) + listed = candidate.request("GET", "/v1/mcp/server", key=key) + assert listed.status_code == 200, listed.text + assert {row["server_id"] for row in listed.json()} == set(grants), listed.text + for requested in (None, [second], [first, second]): + response = candidate.client.get( + "/v1/mcp/server/health", + headers={"Authorization": f"Bearer {key}"}, + params=[] if requested is None else [("server_ids", identity) for identity in requested], + ) + assert response.status_code == 200, response.text + expected = set(grants) if requested is None else set(grants).intersection(requested) + assert {row["server_id"] for row in response.json()} == expected, response.text + assert all(row["status"] == "healthy" for row in response.json()) + + +@pytest.mark.covers("other.mcp.credentials.warm_removal_fails_closed_without_upstream_traffic") +def test_warm_credential_removal_rejects_without_upstream_traffic(gateway: Gateway) -> None: + with mcp_peer() as peer, gateway.scenario() as scenario: + identity = register_mcp( + scenario, + peer, + "credentials" + uuid.uuid4().hex, + auth_type="bearer_token", + static_headers={"Authorization": "Bearer synthetic-upstream-credential"}, + ) + key = scenario.key(object_permission={"mcp_servers": [identity]}) + names = tool_names(gateway, key, identity) + warm = call_tool(gateway, key, identity, names["add"], {"a": 3, "b": 5}) + assert warm.status_code == 200 and warm.json()["content"][0]["text"] == "8", warm.text + calls = tuple(item for item in peer.drain() if item["body"].get("method") == "tools/call") + assert len(calls) == 1 + assert calls[0]["headers"][b"authorization"] == b"Bearer synthetic-upstream-credential" + removed = gateway.request("PUT", "/v1/mcp/server", {"server_id": identity, "static_headers": {}}) + assert removed.status_code == 202, removed.text + stored = gateway.request("GET", f"/v1/mcp/server/{identity}") + assert stored.status_code == 200, stored.text + assert stored.json()["auth_type"] == "bearer_token" + assert not stored.json().get("static_headers"), stored.text + peer.drain() + for operation in ("list", "call"): + rejected = ( + gateway.client.get( + "/mcp-rest/tools/list", params={"server_id": identity}, headers={"x-litellm-api-key": key} + ) + if operation == "list" + else call_tool(gateway, key, identity, names["add"], {"a": 3, "b": 5}) + ) + assert rejected.status_code == 500, rejected.text + if operation == "list": + assert rejected.json()["detail"]["error"] == "internal", rejected.text + assert "Failed to list tools from server" in rejected.json()["detail"]["message"], rejected.text + else: + assert "requires a usable upstream credential" in rejected.text, rejected.text + assert peer.drain() == (), "missing static credential escaped to upstream" + changed = gateway.request( + "PUT", + "/v1/mcp/server", + { + "server_id": identity, + "auth_type": "oauth2_token_exchange", + "token_exchange_endpoint": peer.url + "/token", + "credentials": {"client_id": "synthetic-client"}, + }, + ) + assert changed.status_code == 202, changed.text + peer.drain() + rejected_subject = call_tool(gateway, key, identity, names["add"], {"a": 3, "b": 5}) + assert rejected_subject.status_code == 401, rejected_subject.text + assert peer.drain() == (), "virtual key cannot supply an OBO subject token" + control_id = register_mcp(scenario, peer, "control" + uuid.uuid4().hex, auth_type="none") + control_key = scenario.key(object_permission={"mcp_servers": [control_id]}) + control_names = tool_names(gateway, control_key, control_id) + control = call_tool(gateway, control_key, control_id, control_names["multiply"], {"a": 3, "b": 5}) + assert control.status_code == 200 and control.json()["content"][0]["text"] == "15", control.text + + +@pytest.mark.parametrize("authenticated", (False, True), ids=("anonymous", "bearer")) +@pytest.mark.covers("other.mcp.permissions.same_url_servers_enforce_discovery_and_execution") +def test_same_url_server_grants_scope_discovery_and_direct_or_virtual_execution( + gateway: Gateway, authenticated: bool +) -> None: + with mcp_peer() as peer, gateway.scenario() as scenario: + aliases: Final = tuple("scope" + uuid.uuid4().hex for _ in range(2)) + servers: Final = tuple( + register_mcp( + scenario, + peer, + alias, + auth_type="bearer_token" if authenticated else "none", + static_headers={ + "X-Integration-Server": alias, + **({"Authorization": f"Bearer synthetic-{alias}"} if authenticated else {}), + }, + ) + for alias in aliases + ) + for virtual in (False, True): + keys: Final = tuple( + scenario.key(object_permission={"mcp_servers": [server], "mcp_tool_search_enabled": virtual}) + for server in servers + ) + for server, alias, key in zip(servers, aliases, keys): + catalog: Final = gateway.request("GET", "/mcp-rest/tools/list", key=key) + assert catalog.status_code == 200, catalog.text + if virtual: + assert {tool["name"] for tool in catalog.json()["tools"]} == { + "mcp_tool_search", + "mcp_tool_call", + "agent_search", + "skill_search", + }, catalog.text + search: Final = gateway.request( + "POST", + "/mcp-rest/tools/call", + {"name": "mcp_tool_search", "arguments": {"query": "add", "top_k": 10}}, + key=key, + ) + assert search.status_code == 200 and search.json()["isError"] is False, search.text + assert [tool["name"] for tool in json.loads(search.json()["content"][0]["text"])] == [ + f"{alias}-add" + ], search.text + else: + assert {tool["mcp_info"]["server_id"] for tool in catalog.json()["tools"]} == {server} + assert {tool["name"] for tool in catalog.json()["tools"]} == {"add", "multiply", "fail"} + for server_index, caller_index in ((0, 0), (1, 0), (1, 1)): + peer.drain() + response: Final = gateway.request( + "POST", + "/mcp-rest/tools/call", + { + "name": "mcp_tool_call" if virtual else "add", + **({} if virtual else {"server_id": servers[server_index]}), + "arguments": ( + {"tool_name": f"{aliases[server_index]}-add", "arguments": {"a": 3, "b": 5}} + if virtual + else {"a": 3, "b": 5} + ), + }, + key=keys[caller_index], + ) + observed: Final = peer.drain() + if server_index != caller_index: + assert response.status_code == 403 and "not allowed" in response.text, response.text + assert observed == (), "forbidden server reached the upstream" + continue + assert response.status_code == 200 and response.json()["isError"] is False, response.text + assert response.json()["content"][0]["text"] == "8", response.text + calls: Final = tuple(item for item in observed if item["body"].get("method") == "tools/call") + assert len(calls) == 1 + assert calls[0]["headers"][b"x-integration-server"] == aliases[server_index].encode() + expected_auth: Final = f"Bearer synthetic-{aliases[server_index]}".encode() if authenticated else None + assert all(item["headers"].get(b"authorization") == expected_auth for item in observed) diff --git a/tests/integration/mcp/test_oauth_configuration.py b/tests/integration/mcp/test_oauth_configuration.py index 45d407f2423..4c46c706054 100644 --- a/tests/integration/mcp/test_oauth_configuration.py +++ b/tests/integration/mcp/test_oauth_configuration.py @@ -2,14 +2,14 @@ import json import queue import uuid from urllib.parse import parse_qs, urlsplit -from typing import Final +from typing import Final, Literal from pathlib import Path import pytest from integration._support.client import Gateway, eventually from integration._support.database import read_rows -from integration._support.mcp import McpPeer, register_mcp +from integration._support.mcp import McpPeer, call_tool, mcp_peer, register_mcp, tool_names from integration._support.process import owned_proxy from integration._support.wire import Reply, Request, wire_server @@ -102,3 +102,87 @@ def test_partial_discovery_and_unrelated_edit_keep_actual_authorization_destinat "PUT", "/v1/mcp/server", {"server_id": identity, "server_name": alias + "renamed"} ) assert updated.status_code == 202, updated.text + + +@pytest.mark.covers("other.mcp.oauth.same_url_credentials_are_isolated_by_user_and_server") +@pytest.mark.parametrize("transition", ("revoke", "expire")) +def test_same_url_oauth_credentials_and_revocation_are_isolated_by_user_and_server( + gateway: Gateway, + transition: Literal["revoke", "expire"], +) -> None: + with mcp_peer() as peer, gateway.scenario() as scenario: + servers: Final = tuple( + register_mcp( + scenario, + peer, + "oauth" + uuid.uuid4().hex, + auth_type="oauth2", + oauth2_flow="authorization_code", + authorization_url=peer.url + "/authorize", + token_url=peer.url + "/token", + credentials={"client_id": "synthetic-oauth-client"}, + ) + for _ in range(2) + ) + users: Final = tuple(scenario.user(user_role="internal_user") for _ in range(2)) + keys: Final = tuple( + scenario.key(user_id=user, object_permission={"mcp_servers": list(servers)}) for user in users + ) + for user_index, key in enumerate(keys): + for server_index, server_id in enumerate(servers): + stored: Final = gateway.request( + "POST", + f"/v1/mcp/server/{server_id}/oauth-user-credential", + {"access_token": f"synthetic-user-{user_index}-server-{server_index}", "expires_in": 3600}, + key=key, + ) + assert stored.status_code == 200 and stored.json()["has_credential"] is True, stored.text + scenario.cleanups.callback( + gateway.request, + "DELETE", + f"/v1/mcp/server/{server_id}/oauth-user-credential", + key=key, + ) + names: Final = tuple(tool_names(gateway, keys[0], server) for server in servers) + for generation in range(2): + for user_index, key in enumerate(keys): + for server_index, server_id in enumerate(servers): + peer.drain() + discovery: Final = gateway.request( + "GET", + "/mcp-rest/tools/list", + key=key, + params={"server_id": server_id}, + ) + call: Final = call_tool(gateway, key, server_id, names[server_index]["add"], {"a": 3, "b": 5}) + observed: Final = peer.drain() + if generation == 1 and user_index == 0 and server_index == 0: + for rejected in (discovery, call): + assert rejected.status_code == 401, rejected.text + assert rejected.json() == {"detail": "Unauthorized"}, rejected.text + assert "resource_metadata=" in rejected.headers["www-authenticate"] + assert observed == (), "unusable credentials must not fall back to another user or server" + else: + assert discovery.status_code == 200, discovery.text + assert {tool["name"] for tool in discovery.json()["tools"]} == set(names[server_index].values()) + assert call.status_code == 200 and call.json()["isError"] is False, call.text + assert call.json()["content"][0]["text"] == "8", call.text + calls: Final = tuple(item for item in observed if item["body"].get("method") == "tools/call") + assert len(calls) == 1 + expected: Final = f"Bearer synthetic-user-{user_index}-server-{server_index}".encode() + assert calls[0]["headers"][b"authorization"] == expected + assert all(item["headers"].get(b"authorization") == expected for item in observed) + if generation == 0: + changed: Final = gateway.request( + "DELETE" if transition == "revoke" else "POST", + f"/v1/mcp/server/{servers[0]}/oauth-user-credential", + None + if transition == "revoke" + else { + "access_token": "synthetic-expired-user-0-server-0", + "expires_in": -60, + }, + key=keys[0], + ) + assert changed.status_code == 200, changed.text + assert changed.json()["has_credential"] is (transition == "expire"), changed.text diff --git a/tests/integration/observability/test_guardrail_effects.py b/tests/integration/observability/test_guardrail_effects.py index 645af77526f..5a79b619906 100644 --- a/tests/integration/observability/test_guardrail_effects.py +++ b/tests/integration/observability/test_guardrail_effects.py @@ -8,6 +8,7 @@ import yaml from integration._support.client import Gateway, eventually from integration._support.database import read_rows +from integration._support.mcp import mcp_peer, register_mcp, tool_names from integration._support.process import owned_proxy from integration._support.wire import Reply, Request, wire_server @@ -143,3 +144,73 @@ def test_guardrail_denial_prevents_provider_and_preserves_allowed_control(gatewa ) assert len(observed.get("/__observations").json()["requests"]) == 1 assert len(policy.drain()) == 2 + + +@pytest.mark.covers("other.mcp.guardrails.request_selection_blocks_resolved_tool_without_execution") +def test_request_selected_mcp_guardrail_blocks_direct_and_virtual_calls(gateway: Gateway, tmp_path: Path) -> None: + guardrail = "mcp-policy-" + uuid.uuid4().hex + config = yaml.safe_load(Path("tests/integration/proxy_config.yaml").read_text()) + config["guardrails"] = [ + { + "guardrail_name": guardrail, + "litellm_params": { + "guardrail": "custom_code", + "mode": "pre_mcp_call", + "default_on": False, + "custom_code": ( + "def apply_guardrail(inputs, request_data, input_type):\n" + ' if inputs.get("tools", [{}])[0].get("function", {}).get("name") == "add":\n' + ' return block("integration resolved add denied")\n' + " return allow()\n" + ), + }, + } + ] + path = tmp_path / "mcp-guardrail.yaml" + path.write_text(yaml.safe_dump(config)) + with ( + owned_proxy(gateway, tmp_path, {}, config=path) as candidate, + mcp_peer() as peer, + candidate.scenario() as scenario, + ): + identity = register_mcp(scenario, peer, "guardrail" + uuid.uuid4().hex) + permission = {"mcp_servers": [identity], "mcp_tool_search_enabled": True} + key = scenario.key(object_permission=permission) + key_selected = scenario.key(object_permission=permission, guardrails=[guardrail]) + team = scenario.team(guardrails=[guardrail], object_permission={"mcp_servers": [identity]}) + team_selected = scenario.key(team_id=team, object_permission=permission) + catalog_key = scenario.key(object_permission={"mcp_servers": [identity]}) + names = tool_names(candidate, catalog_key, identity) + assert set(names) == {"add", "multiply", "fail"} + for virtual in (False, True): + for caller, selected, tool, expected in ( + (key, [], "add", 8), + (key, [guardrail], "add", None), + (key_selected, [], "add", None), + (team_selected, [], "add", None), + (key, [guardrail], "multiply", 15), + ): + arguments = {"a": 3, "b": 5} + peer.drain() + response = candidate.client.post( + "/mcp-rest/tools/call", + headers={"x-litellm-api-key": caller}, + json={ + "server_id": identity, + "name": "mcp_tool_call" if virtual else names[tool], + "arguments": {"tool_name": names[tool], "arguments": arguments} if virtual else arguments, + "guardrails": selected, + }, + ) + calls = tuple(item for item in peer.drain() if item["body"].get("method") == "tools/call") + if expected is None: + assert response.status_code == 400, response.text + assert "integration resolved add denied" in response.text, response.text + assert calls == (), "pre-call denial must prevent upstream execution" + else: + assert response.status_code == 200, response.text + assert response.json()["isError"] is False + assert response.json()["content"][0]["text"] == str(expected), response.text + assert len(calls) == 1 + assert calls[0]["body"]["params"]["name"] == tool + assert calls[0]["body"]["params"]["arguments"] == arguments diff --git a/tests/mcp_tests/mcp_e2e_upstream_server.py b/tests/mcp_tests/mcp_e2e_upstream_server.py index 28fb0846481..3361163badf 100644 --- a/tests/mcp_tests/mcp_e2e_upstream_server.py +++ b/tests/mcp_tests/mcp_e2e_upstream_server.py @@ -1,6 +1,6 @@ """Deterministic upstream MCP server for the mcp e2e suite. -A tiny FastMCP server exposing `add` and `multiply` over streamable-http so the +A tiny MCP server exposing `add` and `multiply` over streamable-http so the suite has a self-hosted, offline upstream to register and exercise. DNS-rebinding protection is turned off because the litellm container reaches this over the compose network by service name (`mcp-upstream:8090`), not localhost, and the @@ -9,15 +9,10 @@ stack is an isolated throwaway. Bind host/port come from MCP_HOST/MCP_PORT. import os -from mcp.server.fastmcp import FastMCP +from mcp.server.mcpserver import MCPServer from mcp.server.transport_security import TransportSecuritySettings -mcp: FastMCP = FastMCP( - "e2e-math", - host=os.getenv("MCP_HOST", "0.0.0.0"), - port=int(os.getenv("MCP_PORT", "8090")), - transport_security=TransportSecuritySettings(enable_dns_rebinding_protection=False), -) +mcp: MCPServer = MCPServer("e2e-math") @mcp.tool() @@ -33,7 +28,12 @@ def multiply(a: int, b: int) -> int: def main() -> None: - mcp.run(transport="streamable-http") + mcp.run( + transport="streamable-http", + host=os.getenv("MCP_HOST", "0.0.0.0"), + port=int(os.getenv("MCP_PORT", "8090")), + transport_security=TransportSecuritySettings(enable_dns_rebinding_protection=False), + ) if __name__ == "__main__": diff --git a/tests/mcp_tests/test_mcp_guardrails.py b/tests/mcp_tests/test_mcp_guardrails.py deleted file mode 100644 index 04401992449..00000000000 --- a/tests/mcp_tests/test_mcp_guardrails.py +++ /dev/null @@ -1,770 +0,0 @@ -""" -Test file for MCP Guardrails Feature - -This file tests the MCP guardrails functionality for both pre and during MCP call hooks, -including various guardrail types and proper exception handling. -""" - -import asyncio -import pytest -from datetime import datetime -from typing import Optional, Dict, Any -from unittest.mock import MagicMock, AsyncMock, patch - -# Add the project root to the path - -import litellm -from litellm.exceptions import BlockedPiiEntityError, GuardrailRaisedException -from litellm.integrations.custom_guardrail import CustomGuardrail -from litellm.integrations.custom_logger import CustomLogger -from litellm.proxy._types import UserAPIKeyAuth -from litellm.caching.caching import DualCache -from litellm.types.mcp import ( - MCPPreCallRequestObject, - MCPPreCallResponseObject, - MCPDuringCallRequestObject, - MCPDuringCallResponseObject, -) -from litellm.types.llms.base import HiddenParams -from litellm.types.guardrails import GuardrailEventHooks -from fastapi import HTTPException - - -class MockPiiGuardrail(CustomGuardrail): - """Mock PII guardrail that raises BlockedPiiEntityError""" - - def __init__(self, should_block: bool = True, entity_type: str = "EMAIL_ADDRESS"): - super().__init__() - self.should_block = should_block - self.entity_type = entity_type - self.guardrail_name = "mock-pii-guardrail" - self.call_count = 0 - - def should_run_guardrail(self, data: dict, event_type: GuardrailEventHooks) -> bool: - """Always run for testing""" - return True - - async def async_pre_call_hook( - self, - user_api_key_dict: UserAPIKeyAuth, - cache: DualCache, - data: dict, - call_type: str, - ): - """Mock pre-call hook that raises BlockedPiiEntityError""" - self.call_count += 1 - - if self.should_block: - raise BlockedPiiEntityError( - entity_type=self.entity_type, - guardrail_name=self.guardrail_name, - ) - return None - - -class MockContentGuardrail(CustomGuardrail): - """Mock content guardrail that raises GuardrailRaisedException""" - - def __init__(self, should_block: bool = True): - super().__init__() - self.should_block = should_block - self.guardrail_name = "mock-content-guardrail" - self.call_count = 0 - - def should_run_guardrail(self, data: dict, event_type: GuardrailEventHooks) -> bool: - """Always run for testing""" - return True - - async def async_pre_call_hook( - self, - user_api_key_dict: UserAPIKeyAuth, - cache: DualCache, - data: dict, - call_type: str, - ): - """Mock pre-call hook that raises GuardrailRaisedException""" - self.call_count += 1 - - if self.should_block: - raise GuardrailRaisedException( - guardrail_name=self.guardrail_name, message="Content violates policy" - ) - return None - - -class MockHttpGuardrail(CustomGuardrail): - """Mock HTTP guardrail that raises HTTPException""" - - def __init__(self, should_block: bool = True): - super().__init__() - self.should_block = should_block - self.guardrail_name = "mock-http-guardrail" - self.call_count = 0 - - def should_run_guardrail(self, data: dict, event_type: GuardrailEventHooks) -> bool: - """Always run for testing""" - return True - - async def async_pre_call_hook( - self, - user_api_key_dict: UserAPIKeyAuth, - cache: DualCache, - data: dict, - call_type: str, - ): - """Mock pre-call hook that raises HTTPException""" - self.call_count += 1 - - if self.should_block: - raise HTTPException( - status_code=400, detail={"error": "Violated guardrail policy"} - ) - return None - - -class MockDuringCallGuardrail(CustomGuardrail): - """Mock guardrail for during-call testing""" - - def __init__(self, should_block: bool = True): - super().__init__() - self.should_block = should_block - self.guardrail_name = "mock-during-guardrail" - self.call_count = 0 - - def should_run_guardrail(self, data: dict, event_type: GuardrailEventHooks) -> bool: - """Always run for testing""" - return True - - async def async_moderation_hook( - self, - data: dict, - user_api_key_dict: UserAPIKeyAuth, - call_type: str, - ): - """Mock during-call hook that raises exceptions""" - self.call_count += 1 - - if self.should_block: - raise BlockedPiiEntityError( - entity_type="PHONE_NUMBER", - guardrail_name=self.guardrail_name, - ) - return None - - -class MockProxyLogging: - """Mock proxy logging object for testing MCP guardrails""" - - def __init__(self, guardrails: Optional[list] = None): - self.guardrails = guardrails if guardrails is not None else [] - self.call_details = {"user_api_key_cache": DualCache()} - self.dynamic_success_callbacks = [] - self.call_count = 0 - - def get_combined_callback_list(self, dynamic_success_callbacks, global_callbacks): - """Return the guardrails for testing""" - return self.guardrails - - def _convert_mcp_to_llm_format(self, request_obj, kwargs: dict) -> dict: - """Convert MCP tool call to LLM message format""" - tool_call_content = ( - f"Tool: {request_obj.tool_name}\nArguments: {request_obj.arguments}" - ) - - return { - "messages": [{"role": "user", "content": tool_call_content}], - "model": kwargs.get("model", "mcp-tool-call"), - "user_api_key_user_id": kwargs.get("user_api_key_user_id"), - "user_api_key_team_id": kwargs.get("user_api_key_team_id"), - } - - def _convert_llm_result_to_mcp_response(self, llm_result, request_obj): - """Convert LLM result back to MCP response format""" - return None # For testing, we don't need to convert back - - def _parse_pre_mcp_call_hook_response(self, response, original_request): - """Parse pre MCP call hook response""" - return response - - async def async_pre_mcp_tool_call_hook( - self, - kwargs: dict, - request_obj: Any, - start_time: datetime, - end_time: datetime, - ) -> Optional[Any]: - """Mock pre MCP tool call hook""" - self.call_count += 1 - - # Simulate the actual hook logic - for guardrail in self.guardrails: - if isinstance(guardrail, CustomGuardrail): - try: - synthetic_data = self._convert_mcp_to_llm_format( - request_obj, kwargs - ) - - # Check if guardrail should run - if not guardrail.should_run_guardrail( - synthetic_data, GuardrailEventHooks.pre_mcp_call - ): - continue - - result = await guardrail.async_pre_call_hook( - user_api_key_dict=kwargs.get("user_api_key_auth"), - cache=self.call_details["user_api_key_cache"], - data=synthetic_data, - call_type="mcp_call", - ) - if result is not None: - return self._parse_pre_mcp_call_hook_response( - result, request_obj - ) - except ( - BlockedPiiEntityError, - GuardrailRaisedException, - HTTPException, - ) as e: - # Re-raise guardrail exceptions - raise e - except Exception as e: - # Log non-guardrail exceptions as non-blocking - print( - f"LiteLLM.LoggingError: [Non-Blocking] Exception occurred while logging {str(e)}" - ) - - return None - - async def async_during_mcp_tool_call_hook( - self, - kwargs: dict, - request_obj: Any, - start_time: datetime, - end_time: datetime, - ) -> Optional[Any]: - """Mock during MCP tool call hook""" - self.call_count += 1 - - # Simulate the actual hook logic - for guardrail in self.guardrails: - if isinstance(guardrail, CustomGuardrail): - try: - synthetic_data = self._convert_mcp_to_llm_format( - request_obj, kwargs - ) - result = await guardrail.async_moderation_hook( - data=synthetic_data, - user_api_key_dict=kwargs.get("user_api_key_auth"), - call_type="mcp_call", - ) - if result is not None: - return result - except ( - BlockedPiiEntityError, - GuardrailRaisedException, - HTTPException, - ) as e: - # Re-raise guardrail exceptions - raise e - except Exception as e: - # Log non-guardrail exceptions as non-blocking - print( - f"LiteLLM.LoggingError: [Non-Blocking] Exception occurred while logging {str(e)}" - ) - - return None - - -@pytest.fixture -def mock_user_api_key(): - """Mock user API key for testing""" - return UserAPIKeyAuth(api_key="test_key", user_id="test_user") - - -@pytest.fixture -def mock_cache(): - """Mock cache for testing""" - return DualCache() - - -@pytest.fixture -def mock_pii_guardrail(): - """Mock PII guardrail that blocks""" - return MockPiiGuardrail(should_block=True) - - -@pytest.fixture -def mock_pii_guardrail_allow(): - """Mock PII guardrail that allows""" - return MockPiiGuardrail(should_block=False) - - -@pytest.fixture -def mock_content_guardrail(): - """Mock content guardrail that blocks""" - return MockContentGuardrail(should_block=True) - - -@pytest.fixture -def mock_http_guardrail(): - """Mock HTTP guardrail that blocks""" - return MockHttpGuardrail(should_block=True) - - -@pytest.fixture -def mock_during_guardrail(): - """Mock during-call guardrail that blocks""" - return MockDuringCallGuardrail(should_block=True) - - -@pytest.fixture -def mock_proxy_logging(): - """Mock proxy logging object""" - return MockProxyLogging() - - -class TestMCPGuardrailsPreCall: - """Test MCP guardrails for pre-call hooks""" - - @pytest.mark.asyncio - async def test_pii_guardrail_blocks_pre_call( - self, mock_pii_guardrail, mock_user_api_key, mock_cache - ): - """Test that PII guardrail properly blocks pre-call""" - proxy_logging = MockProxyLogging([mock_pii_guardrail]) - - # Create MCP request - request_obj = MCPPreCallRequestObject( - tool_name="email_tool", - arguments={"email": "test@example.com"}, - server_name="email_server", - user_api_key_auth=mock_user_api_key.model_dump(), - hidden_params=HiddenParams(), - ) - - kwargs = { - "name": "email_tool", - "arguments": {"email": "test@example.com"}, - "server_name": "email_server", - "user_api_key_auth": mock_user_api_key, - } - - # Test that BlockedPiiEntityError is raised - with pytest.raises(BlockedPiiEntityError) as excinfo: - await proxy_logging.async_pre_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - # Verify the error details - assert excinfo.value.entity_type == "EMAIL_ADDRESS" - assert excinfo.value.guardrail_name == "mock-pii-guardrail" - assert mock_pii_guardrail.call_count == 1 - - @pytest.mark.asyncio - async def test_pii_guardrail_allows_pre_call( - self, mock_pii_guardrail_allow, mock_user_api_key, mock_cache - ): - """Test that PII guardrail allows pre-call when configured to allow""" - proxy_logging = MockProxyLogging([mock_pii_guardrail_allow]) - - request_obj = MCPPreCallRequestObject( - tool_name="email_tool", - arguments={"email": "test@example.com"}, - server_name="email_server", - user_api_key_auth=mock_user_api_key.model_dump(), - hidden_params=HiddenParams(), - ) - - kwargs = { - "name": "email_tool", - "arguments": {"email": "test@example.com"}, - "server_name": "email_server", - "user_api_key_auth": mock_user_api_key, - } - - # Test that no exception is raised - result = await proxy_logging.async_pre_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - assert result is None - assert mock_pii_guardrail_allow.call_count == 1 - - @pytest.mark.asyncio - async def test_content_guardrail_blocks_pre_call( - self, mock_content_guardrail, mock_user_api_key, mock_cache - ): - """Test that content guardrail properly blocks pre-call""" - proxy_logging = MockProxyLogging([mock_content_guardrail]) - - request_obj = MCPPreCallRequestObject( - tool_name="content_tool", - arguments={"content": "sensitive content"}, - server_name="content_server", - user_api_key_auth=mock_user_api_key.model_dump(), - hidden_params=HiddenParams(), - ) - - kwargs = { - "name": "content_tool", - "arguments": {"content": "sensitive content"}, - "server_name": "content_server", - "user_api_key_auth": mock_user_api_key, - } - - # Test that GuardrailRaisedException is raised - with pytest.raises(GuardrailRaisedException) as excinfo: - await proxy_logging.async_pre_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - # Verify the error details - assert "Content violates policy" in str(excinfo.value) - assert excinfo.value.guardrail_name == "mock-content-guardrail" - assert mock_content_guardrail.call_count == 1 - - @pytest.mark.asyncio - async def test_http_guardrail_blocks_pre_call( - self, mock_http_guardrail, mock_user_api_key, mock_cache - ): - """Test that HTTP guardrail properly blocks pre-call""" - proxy_logging = MockProxyLogging([mock_http_guardrail]) - - request_obj = MCPPreCallRequestObject( - tool_name="http_tool", - arguments={"url": "http://example.com"}, - server_name="http_server", - user_api_key_auth=mock_user_api_key.model_dump(), - hidden_params=HiddenParams(), - ) - - kwargs = { - "name": "http_tool", - "arguments": {"url": "http://example.com"}, - "server_name": "http_server", - "user_api_key_auth": mock_user_api_key, - } - - # Test that HTTPException is raised - with pytest.raises(HTTPException) as excinfo: - await proxy_logging.async_pre_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - # Verify the error details - assert excinfo.value.status_code == 400 - assert "Violated guardrail policy" in str(excinfo.value.detail) - assert mock_http_guardrail.call_count == 1 - - @pytest.mark.asyncio - async def test_multiple_guardrails_pre_call( - self, mock_pii_guardrail, mock_content_guardrail, mock_user_api_key, mock_cache - ): - """Test multiple guardrails - first one should block""" - proxy_logging = MockProxyLogging([mock_pii_guardrail, mock_content_guardrail]) - - request_obj = MCPPreCallRequestObject( - tool_name="test_tool", - arguments={"email": "test@example.com"}, - server_name="test_server", - user_api_key_auth=mock_user_api_key.model_dump(), - hidden_params=HiddenParams(), - ) - - kwargs = { - "name": "test_tool", - "arguments": {"email": "test@example.com"}, - "server_name": "test_server", - "user_api_key_auth": mock_user_api_key, - } - - # Test that first guardrail blocks - with pytest.raises(BlockedPiiEntityError): - await proxy_logging.async_pre_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - # Verify only first guardrail was called - assert mock_pii_guardrail.call_count == 1 - assert mock_content_guardrail.call_count == 0 - - -class TestMCPGuardrailsDuringCall: - """Test MCP guardrails for during-call hooks""" - - @pytest.mark.asyncio - async def test_during_call_guardrail_blocks( - self, mock_during_guardrail, mock_user_api_key, mock_cache - ): - """Test that during-call guardrail properly blocks execution""" - proxy_logging = MockProxyLogging([mock_during_guardrail]) - - request_obj = MCPDuringCallRequestObject( - tool_name="phone_tool", - arguments={"phone": "555-123-4567"}, - server_name="phone_server", - start_time=datetime.now().timestamp(), - hidden_params=HiddenParams(), - ) - - kwargs = { - "name": "phone_tool", - "arguments": {"phone": "555-123-4567"}, - "server_name": "phone_server", - } - - # Test that BlockedPiiEntityError is raised - with pytest.raises(BlockedPiiEntityError) as excinfo: - await proxy_logging.async_during_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - # Verify the error details - assert excinfo.value.entity_type == "PHONE_NUMBER" - assert excinfo.value.guardrail_name == "mock-during-guardrail" - assert mock_during_guardrail.call_count == 1 - - -class TestMCPGuardrailsIntegration: - """Test MCP guardrails integration with MCP server manager""" - - @pytest.mark.asyncio - async def test_mcp_server_manager_with_guardrails(self): - """Test MCP server manager with guardrail integration""" - - mock_proxy_logging = MockProxyLogging([MockPiiGuardrail(should_block=True)]) - - # Test that guardrail exception is properly raised in the hook - with pytest.raises(BlockedPiiEntityError): - await mock_proxy_logging.async_pre_mcp_tool_call_hook( - kwargs={ - "name": "email_tool", - "arguments": {"email": "test@example.com"}, - }, - request_obj=MagicMock(), - start_time=datetime.now(), - end_time=datetime.now(), - ) - - @pytest.mark.asyncio - async def test_guardrail_exception_propagation(self): - """Test that guardrail exceptions properly propagate through the system""" - # Test BlockedPiiEntityError - with pytest.raises(BlockedPiiEntityError): - raise BlockedPiiEntityError( - entity_type="EMAIL_ADDRESS", guardrail_name="test-guardrail" - ) - - # Test GuardrailRaisedException - with pytest.raises(GuardrailRaisedException): - raise GuardrailRaisedException( - guardrail_name="test-guardrail", message="Test message" - ) - - # Test HTTPException - with pytest.raises(HTTPException): - raise HTTPException(status_code=400, detail={"error": "Test error"}) - - -class TestMCPGuardrailsErrorHandling: - """Test MCP guardrails error handling scenarios""" - - @pytest.mark.asyncio - async def test_non_guardrail_exception_logging(self, mock_user_api_key, mock_cache): - """Test that non-guardrail exceptions are logged as non-blocking""" - - class MockFailingGuardrail(CustomGuardrail): - def should_run_guardrail( - self, data: dict, event_type: GuardrailEventHooks - ) -> bool: - return True - - async def async_pre_call_hook( - self, - user_api_key_dict: UserAPIKeyAuth, - cache: DualCache, - data: dict, - call_type: str, - ): - raise Exception("Non-guardrail error") - - proxy_logging = MockProxyLogging([MockFailingGuardrail()]) - - request_obj = MCPPreCallRequestObject( - tool_name="test_tool", - arguments={"test": "data"}, - server_name="test_server", - user_api_key_auth=mock_user_api_key.model_dump(), - hidden_params=HiddenParams(), - ) - - kwargs = { - "name": "test_tool", - "arguments": {"test": "data"}, - "server_name": "test_server", - "user_api_key_auth": mock_user_api_key, - } - - # Test that non-guardrail exceptions are handled gracefully - result = await proxy_logging.async_pre_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - # Should return None (not raise exception) - assert result is None - - @pytest.mark.asyncio - async def test_guardrail_should_not_run(self, mock_user_api_key, mock_cache): - """Test that guardrails don't run when should_run_guardrail returns False""" - - class MockConditionalGuardrail(CustomGuardrail): - def should_run_guardrail( - self, data: dict, event_type: GuardrailEventHooks - ) -> bool: - return False # Don't run - - async def async_pre_call_hook( - self, - user_api_key_dict: UserAPIKeyAuth, - cache: DualCache, - data: dict, - call_type: str, - ): - raise BlockedPiiEntityError("EMAIL_ADDRESS", "test-guardrail") - - proxy_logging = MockProxyLogging([MockConditionalGuardrail()]) - - request_obj = MCPPreCallRequestObject( - tool_name="test_tool", - arguments={"test": "data"}, - server_name="test_server", - user_api_key_auth=mock_user_api_key.model_dump(), - hidden_params=HiddenParams(), - ) - - kwargs = { - "name": "test_tool", - "arguments": {"test": "data"}, - "server_name": "test_server", - "user_api_key_auth": mock_user_api_key, - } - - # Test that guardrail doesn't run and no exception is raised - result = await proxy_logging.async_pre_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - # Should return None (guardrail didn't run) - assert result is None - - -class TestMCPGuardrailsEdgeCases: - """Test MCP guardrails edge cases and error conditions""" - - @pytest.mark.asyncio - async def test_empty_guardrails_list(self, mock_user_api_key, mock_cache): - """Test behavior with empty guardrails list""" - proxy_logging = MockProxyLogging([]) # No guardrails - - request_obj = MCPPreCallRequestObject( - tool_name="test_tool", - arguments={"test": "data"}, - server_name="test_server", - user_api_key_auth=mock_user_api_key.model_dump(), - hidden_params=HiddenParams(), - ) - - kwargs = { - "name": "test_tool", - "arguments": {"test": "data"}, - "server_name": "test_server", - "user_api_key_auth": mock_user_api_key, - } - - # Should return None without any issues - result = await proxy_logging.async_pre_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - assert result is None - - @pytest.mark.asyncio - async def test_guardrail_with_invalid_data(self, mock_user_api_key, mock_cache): - """Test guardrail behavior with invalid data""" - - class MockInvalidDataGuardrail(CustomGuardrail): - def should_run_guardrail( - self, data: dict, event_type: GuardrailEventHooks - ) -> bool: - return True - - async def async_pre_call_hook( - self, - user_api_key_dict: UserAPIKeyAuth, - cache: DualCache, - data: dict, - call_type: str, - ): - # Try to access invalid data - invalid_data = data.get("invalid_key", {}) - if invalid_data.get("should_fail"): - raise BlockedPiiEntityError("EMAIL_ADDRESS", "test-guardrail") - return None - - proxy_logging = MockProxyLogging([MockInvalidDataGuardrail()]) - - request_obj = MCPPreCallRequestObject( - tool_name="test_tool", - arguments={"test": "data"}, - server_name="test_server", - user_api_key_auth=mock_user_api_key.model_dump(), - hidden_params=HiddenParams(), - ) - - kwargs = { - "name": "test_tool", - "arguments": {"test": "data"}, - "server_name": "test_server", - "user_api_key_auth": mock_user_api_key, - } - - # Should handle invalid data gracefully - result = await proxy_logging.async_pre_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - assert result is None - - -if __name__ == "__main__": - pytest.main([__file__]) diff --git a/tests/mcp_tests/test_mcp_hooks.py b/tests/mcp_tests/test_mcp_hooks.py deleted file mode 100644 index 6dac7da6d07..00000000000 --- a/tests/mcp_tests/test_mcp_hooks.py +++ /dev/null @@ -1,475 +0,0 @@ -""" -Test file for MCP Hook Architecture - -This file demonstrates the new MCP hook system with comprehensive examples -and validation tests. -""" - -import asyncio -import pytest -from datetime import datetime -from typing import Optional - -from litellm.integrations.custom_logger import CustomLogger -from litellm.types.mcp import ( - MCPPreCallRequestObject, - MCPPreCallResponseObject, - MCPDuringCallRequestObject, - MCPDuringCallResponseObject, - MCPPostCallResponseObject, -) -from litellm.types.llms.base import HiddenParams - - -class TestMCPAccessControlHook(CustomLogger): - """Test hook for access control functionality""" - - def __init__(self): - self.allowed_tools = {"github/create_issue", "zapier/send_email"} - self.blocked_users = {"user123", "user456"} - self.call_count = 0 - - async def async_pre_mcp_tool_call_hook( - self, kwargs, request_obj: MCPPreCallRequestObject, start_time, end_time - ) -> Optional[MCPPreCallResponseObject]: - """Test access control validation""" - self.call_count += 1 - - tool_name = request_obj.tool_name - user_id = kwargs.get("user_api_key_auth", {}).get("user_id") - - # Check if user is blocked - if user_id in self.blocked_users: - return MCPPreCallResponseObject( - should_proceed=False, - error_message=f"User {user_id} is not authorized to use MCP tools", - ) - - # Check if tool is allowed - if tool_name not in self.allowed_tools: - return MCPPreCallResponseObject( - should_proceed=False, - error_message=f"Tool {tool_name} is not authorized", - ) - - return None # Allow execution to proceed - - -class TestMCPCostTrackingHook(CustomLogger): - """Test hook for cost tracking functionality""" - - def __init__(self): - self.cost_map = { - "github/create_issue": 0.10, - "zapier/send_email": 0.05, - "default": 0.01, - } - self.call_count = 0 - - async def async_post_mcp_tool_call_hook( - self, kwargs, response_obj: MCPPostCallResponseObject, start_time, end_time - ) -> Optional[MCPPostCallResponseObject]: - """Test cost calculation after tool execution""" - self.call_count += 1 - - tool_name = kwargs.get("name", "") - cost = self.cost_map.get(tool_name, self.cost_map["default"]) - - # Set the response cost - response_obj.hidden_params.response_cost = cost - - return response_obj - - -class TestMCPMonitoringHook(CustomLogger): - """Test hook for real-time monitoring functionality""" - - def __init__(self): - self.max_execution_time = 30.0 # seconds - self.call_count = 0 - - async def async_during_mcp_tool_call_hook( - self, kwargs, request_obj: MCPDuringCallRequestObject, start_time, end_time - ) -> Optional[MCPDuringCallResponseObject]: - """Test execution time monitoring""" - self.call_count += 1 - - tool_name = request_obj.tool_name - execution_time = (datetime.now() - start_time).total_seconds() - - # Check if execution is taking too long - if execution_time > self.max_execution_time: - return MCPDuringCallResponseObject( - should_continue=False, - error_message=f"Tool {tool_name} execution timeout after {execution_time}s", - ) - - return None # Allow execution to continue - - -class TestMCPArgumentValidationHook(CustomLogger): - """Test hook for argument validation functionality""" - - def __init__(self): - self.call_count = 0 - - async def async_pre_mcp_tool_call_hook( - self, kwargs, request_obj: MCPPreCallRequestObject, start_time, end_time - ) -> Optional[MCPPreCallResponseObject]: - """Test argument validation and sanitization""" - self.call_count += 1 - - tool_name = request_obj.tool_name - arguments = request_obj.arguments.copy() # Create a copy to modify - - # Example: Validate GitHub issue creation - if tool_name == "github/create_issue": - if not arguments.get("title"): - return MCPPreCallResponseObject( - should_proceed=False, error_message="GitHub issue title is required" - ) - - # Sanitize the title - title = arguments["title"] - if len(title) > 100: - title = title[:97] + "..." - arguments["title"] = title - - # Example: Validate email sending - elif tool_name == "zapier/send_email": - if not arguments.get("to"): - return MCPPreCallResponseObject( - should_proceed=False, error_message="Email recipient is required" - ) - - return MCPPreCallResponseObject( - should_proceed=True, modified_arguments=arguments - ) - - -# Test fixtures -@pytest.fixture -def access_control_hook(): - return TestMCPAccessControlHook() - - -@pytest.fixture -def cost_tracking_hook(): - return TestMCPCostTrackingHook() - - -@pytest.fixture -def monitoring_hook(): - return TestMCPMonitoringHook() - - -@pytest.fixture -def argument_validation_hook(): - return TestMCPArgumentValidationHook() - - -# Test cases -class TestMCPHooks: - """Test cases for MCP hook functionality""" - - @pytest.mark.asyncio - async def test_access_control_hook_allowed_tool(self, access_control_hook): - """Test that allowed tools pass validation""" - kwargs = { - "user_api_key_auth": {"user_id": "user789"}, - "name": "github/create_issue", - } - request_obj = MCPPreCallRequestObject( - tool_name="github/create_issue", - arguments={"title": "Test issue"}, - user_api_key_auth={"user_id": "user789"}, - ) - - result = await access_control_hook.async_pre_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - assert result is None # Should allow execution - assert access_control_hook.call_count == 1 - - @pytest.mark.asyncio - async def test_access_control_hook_blocked_user(self, access_control_hook): - """Test that blocked users are rejected""" - kwargs = { - "user_api_key_auth": {"user_id": "user123"}, - "name": "github/create_issue", - } - request_obj = MCPPreCallRequestObject( - tool_name="github/create_issue", - arguments={"title": "Test issue"}, - user_api_key_auth={"user_id": "user123"}, - ) - - result = await access_control_hook.async_pre_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - assert result is not None - assert result.should_proceed is False - assert "not authorized" in result.error_message - - @pytest.mark.asyncio - async def test_access_control_hook_unauthorized_tool(self, access_control_hook): - """Test that unauthorized tools are rejected""" - kwargs = { - "user_api_key_auth": {"user_id": "user789"}, - "name": "unauthorized_tool", - } - request_obj = MCPPreCallRequestObject( - tool_name="unauthorized_tool", - arguments={"param": "value"}, - user_api_key_auth={"user_id": "user789"}, - ) - - result = await access_control_hook.async_pre_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - assert result is not None - assert result.should_proceed is False - assert "not authorized" in result.error_message - - @pytest.mark.asyncio - async def test_cost_tracking_hook(self, cost_tracking_hook): - """Test cost tracking functionality""" - kwargs = {"name": "github/create_issue"} - response_obj = MCPPostCallResponseObject( - mcp_tool_call_response=[], hidden_params=HiddenParams() - ) - - result = await cost_tracking_hook.async_post_mcp_tool_call_hook( - kwargs=kwargs, - response_obj=response_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - assert result is not None - assert result.hidden_params.response_cost == 0.10 - assert cost_tracking_hook.call_count == 1 - - @pytest.mark.asyncio - async def test_cost_tracking_hook_default_cost(self, cost_tracking_hook): - """Test default cost assignment""" - kwargs = {"name": "unknown_tool"} - response_obj = MCPPostCallResponseObject( - mcp_tool_call_response=[], hidden_params=HiddenParams() - ) - - result = await cost_tracking_hook.async_post_mcp_tool_call_hook( - kwargs=kwargs, - response_obj=response_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - assert result is not None - assert result.hidden_params.response_cost == 0.01 # Default cost - - @pytest.mark.asyncio - async def test_monitoring_hook_normal_execution(self, monitoring_hook): - """Test monitoring hook with normal execution time""" - kwargs = {"name": "test_tool"} - request_obj = MCPDuringCallRequestObject( - tool_name="test_tool", arguments={}, start_time=datetime.now().timestamp() - ) - - result = await monitoring_hook.async_during_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - assert result is None # Should allow execution to continue - assert monitoring_hook.call_count == 1 - - @pytest.mark.asyncio - async def test_argument_validation_hook_valid_github_issue( - self, argument_validation_hook - ): - """Test argument validation for valid GitHub issue""" - kwargs = {"name": "github/create_issue"} - request_obj = MCPPreCallRequestObject( - tool_name="github/create_issue", arguments={"title": "Valid issue title"} - ) - - result = await argument_validation_hook.async_pre_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - assert result is not None - assert result.should_proceed is True - assert result.modified_arguments == {"title": "Valid issue title"} - assert argument_validation_hook.call_count == 1 - - @pytest.mark.asyncio - async def test_argument_validation_hook_missing_title( - self, argument_validation_hook - ): - """Test argument validation for missing GitHub issue title""" - kwargs = {"name": "github/create_issue"} - request_obj = MCPPreCallRequestObject( - tool_name="github/create_issue", arguments={} # Missing title - ) - - result = await argument_validation_hook.async_pre_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - assert result is not None - assert result.should_proceed is False - assert "title is required" in result.error_message - - @pytest.mark.asyncio - async def test_argument_validation_hook_long_title_sanitization( - self, argument_validation_hook - ): - """Test argument validation with title sanitization""" - kwargs = {"name": "github/create_issue"} - long_title = "A" * 150 # Very long title - request_obj = MCPPreCallRequestObject( - tool_name="github/create_issue", arguments={"title": long_title} - ) - - result = await argument_validation_hook.async_pre_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - assert result is not None - assert result.should_proceed is True - assert len(result.modified_arguments["title"]) == 100 # Truncated - assert result.modified_arguments["title"].endswith("...") - - @pytest.mark.asyncio - async def test_argument_validation_hook_email_validation( - self, argument_validation_hook - ): - """Test argument validation for email sending""" - kwargs = {"name": "zapier/send_email"} - request_obj = MCPPreCallRequestObject( - tool_name="zapier/send_email", - arguments={"to": "test@example.com", "subject": "Test"}, - ) - - result = await argument_validation_hook.async_pre_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - assert result is not None - assert result.should_proceed is True - assert result.modified_arguments == { - "to": "test@example.com", - "subject": "Test", - } - - @pytest.mark.asyncio - async def test_argument_validation_hook_missing_email_recipient( - self, argument_validation_hook - ): - """Test argument validation for missing email recipient""" - kwargs = {"name": "zapier/send_email"} - request_obj = MCPPreCallRequestObject( - tool_name="zapier/send_email", - arguments={"subject": "Test"}, # Missing 'to' field - ) - - result = await argument_validation_hook.async_pre_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - assert result is not None - assert result.should_proceed is False - assert "recipient is required" in result.error_message - - -# Integration test -class TestMCPHookIntegration: - """Integration tests for MCP hook system""" - - @pytest.mark.asyncio - async def test_hook_chain_execution(self): - """Test that multiple hooks can work together""" - access_hook = TestMCPAccessControlHook() - cost_hook = TestMCPCostTrackingHook() - validation_hook = TestMCPArgumentValidationHook() - - # Test data - kwargs = { - "user_api_key_auth": {"user_id": "user789"}, - "name": "github/create_issue", - } - request_obj = MCPPreCallRequestObject( - tool_name="github/create_issue", - arguments={"title": "Integration test issue"}, - user_api_key_auth={"user_id": "user789"}, - ) - - # Execute pre-hooks - access_result = await access_hook.async_pre_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - validation_result = await validation_hook.async_pre_mcp_tool_call_hook( - kwargs=kwargs, - request_obj=request_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - # Both hooks should allow execution - assert access_result is None - assert validation_result is not None - assert validation_result.should_proceed is True - - # Simulate post-hook execution - response_obj = MCPPostCallResponseObject( - mcp_tool_call_response=[], hidden_params=HiddenParams() - ) - - cost_result = await cost_hook.async_post_mcp_tool_call_hook( - kwargs=kwargs, - response_obj=response_obj, - start_time=datetime.now(), - end_time=datetime.now(), - ) - - assert cost_result is not None - assert cost_result.hidden_params.response_cost == 0.10 - - -if __name__ == "__main__": - # Run the tests - pytest.main([__file__, "-v"]) diff --git a/tests/proxy_behavior/spend/test_autorouter_session_rollup.py b/tests/proxy_behavior/spend/test_autorouter_session_rollup.py index e8caa241a53..f3c68b489a5 100644 --- a/tests/proxy_behavior/spend/test_autorouter_session_rollup.py +++ b/tests/proxy_behavior/spend/test_autorouter_session_rollup.py @@ -11,6 +11,7 @@ from datetime import datetime, timedelta, timezone from typing import Final import pytest +from prisma import Prisma from litellm.proxy.db.autorouter_session_rollup import ( AUTOROUTER_BENCHMARKS_SQL, @@ -43,6 +44,7 @@ async def _turn( classifier_cost: float = 0.0, tier: "str | None" = None, baseline: "str | None" = None, + estimated: bool = True, ) -> None: touched: Final = 1 if (hit or ttl is not None or not covered) else 0 await db.execute_raw( @@ -63,6 +65,9 @@ async def _turn( touched, tier, baseline, + int(estimated), + spend if estimated else 0.0, + saved if estimated else 0.0, ) @@ -208,6 +213,9 @@ async def test_subtotal_coverage_survives_legacy_and_rolling_writers(db, writers assert row["saved_spend"] == pytest.approx(0.02 * len(writers)) assert row["classifier_cost"] == pytest.approx(0.004 * sum(writers)) assert row["classifier_cost_recorded_turns"] == sum(writers) + assert row["savings_estimated_turns"] == sum(writers) + assert row["savings_estimated_actual_spend"] == pytest.approx(0.01 * sum(writers)) + assert row["savings_estimated_saved_spend"] == pytest.approx(0.02 * sum(writers)) groups: Final = await db.query_raw( AUTOROUTER_BENCHMARKS_SQL, T0.isoformat(), (T0 + timedelta(days=1)).isoformat(), key ) @@ -217,6 +225,32 @@ async def test_subtotal_coverage_survives_legacy_and_rolling_writers(db, writers assert groups[0]["turns"] == len(writers) assert groups[0]["spend"] == row["spend"] assert groups[0]["saved_spend"] == row["saved_spend"] + assert groups[0]["savings_estimated_turns"] == sum(writers) + assert groups[0]["savings_estimated_actual_spend"] == row["savings_estimated_actual_spend"] + assert groups[0]["savings_estimated_saved_spend"] == row["savings_estimated_saved_spend"] + + +async def test_unknown_and_legacy_turns_preserve_actual_spend_without_entering_the_estimated_cohort(db: Prisma) -> None: + key: Final = f"k-{uuid.uuid4()}" + await _turn(db, key, "A", T0, spend=0.25, saved=-0.05, baseline="opus") + await _turn( + db, key, "B", T0 + timedelta(seconds=1), spend=0.7, saved=0, baseline="sonnet", estimated=False + ) + await _legacy_turn(db, key, T0 + timedelta(seconds=2)) + + row: Final = await _row(db, key) + assert row["saved_spend"] == pytest.approx(-0.03) + assert row["savings_estimated_baseline_models"] == {"opus": 1} + groups: Final = await db.query_raw( + AUTOROUTER_BENCHMARKS_SQL, T0.isoformat(), (T0 + timedelta(days=1)).isoformat(), key + ) + assert len(groups) == 1 + for actual in (row, groups[0]): + assert actual["turns"] == 3 + assert actual["spend"] == pytest.approx(0.96) + assert actual["savings_estimated_turns"] == 1 + assert actual["savings_estimated_actual_spend"] == pytest.approx(0.25) + assert actual["savings_estimated_saved_spend"] == pytest.approx(-0.05) async def test_the_benchmarks_aggregate_reads_only_overlapping_sessions(db): diff --git a/tests/proxy_behavior/spend/test_baseline_accounting.py b/tests/proxy_behavior/spend/test_baseline_accounting.py new file mode 100644 index 00000000000..e187a44c29d --- /dev/null +++ b/tests/proxy_behavior/spend/test_baseline_accounting.py @@ -0,0 +1,263 @@ +import asyncio +import json +import uuid +from collections.abc import AsyncIterator, Callable +from contextlib import asynccontextmanager +from datetime import datetime, timezone +from typing import Final + +import pytest +from prisma import Prisma + +import litellm +from litellm.llms.anthropic.prompt_cache_prediction import CountedBreakpoint, CountedPromptCachePlan +from litellm.proxy.db.autorouter_session_rollup import AutoRouterTurnTransaction +from litellm.proxy.db.baseline_accounting import ( + BaselineAccountingRecord, + BaselineAccountingStore, + DailyBaselineAttribution, + DailyBaselineTarget, +) +from litellm.proxy.db.create_views import SupportsRawQueries +from litellm.proxy.spend_tracking.baseline_accounting import BaselineObservation +from litellm.proxy.spend_tracking.savings import BaselineCostSnapshot +from litellm.types.utils import Usage + +pytestmark = pytest.mark.asyncio(loop_scope="session") + + +@asynccontextmanager +async def _transaction(db: Prisma, *, before_commit: bool = False, after_commit: bool = False) -> AsyncIterator[SupportsRawQueries]: + async with db.tx() as tx: + yield tx + if before_commit: + raise RuntimeError("injected pre-commit interruption") + if after_commit: + raise RuntimeError("injected lost commit acknowledgement") + + +def _store(db: Prisma, **faults: bool) -> BaselineAccountingStore: + def transaction(): + return _transaction(db, **faults) + + return BaselineAccountingStore(transaction) + + +@pytest.fixture +def record() -> Callable[..., BaselineAccountingRecord]: + run: Final = uuid.uuid4().hex + marker: Final = CountedBreakpoint("prefix", 3600, 6000, ("prefix",), "content", ("content",)) + usage: Final = Usage( + prompt_tokens=6200, completion_tokens=30, total_tokens=6230, + cache_creation_input_tokens=6000, cache_read_input_tokens=0, + prompt_tokens_details={ + "text_tokens": 200, "cached_tokens": 0, "cache_creation_tokens": 6000, + "cache_creation_token_details": {"ephemeral_5m_input_tokens": 0, "ephemeral_1h_input_tokens": 6000}, + }, + ) + + def create(label: str = "first", started: float = 10000.0, identical: bool = True) -> BaselineAccountingRecord: + return BaselineAccountingRecord( + scope="autorouter-baseline:v3:" + run * 2, api_key=run, session_id=run, + router_name="test-router", baseline_model="anthropic/claude-opus-5", + observation=BaselineObservation( + request_id=run + label, started_at=started, available_at=started + 0.1, + outcome="complete", baseline_equivalent=identical, usage=usage, + plan=CountedPromptCachePlan(6200, (marker,)), minimum_cache_tokens=4096, + ), + pricing=BaselineCostSnapshot( + model="claude-opus-5", provider="anthropic", + prices=litellm.get_model_info("claude-opus-5", custom_llm_provider="anthropic"), + actual_spend=0.17, actual_token_cost=0.17, + ), + turn=AutoRouterTurnTransaction( + api_key=run, session_id=run, router_name="test-router", router_type="heuristic", + model="claude-opus-5", turn_at=datetime.fromtimestamp(started, timezone.utc), + total_tokens=6230, spend=0.17, saved_spend=0.0, classifier_cost=0.0, + covered=True, cache_hit=False, cache_ttl_seconds=3600, cache_touched=True, + baseline_model="anthropic/claude-opus-5", + ), + daily=DailyBaselineAttribution( + date="2026-09-15", api_key=run, model="claude-opus-5", custom_llm_provider="anthropic", + targets=tuple(DailyBaselineTarget(entity=entity, entity_id=run) for entity in ("user", "team", "org", "end_user", "agent", "tag")), + ), + ) + + return create + + +async def _log(db: Prisma, record: BaselineAccountingRecord) -> None: + await db.execute_raw( + 'INSERT INTO "LiteLLM_SpendLogs" (request_id,call_type,api_key,spend,"startTime","endTime") ' + "VALUES ($1, 'anthropic_messages', $2, 0.17, to_timestamp($3::float8), to_timestamp($3::float8))", + record.observation.request_id, record.api_key, record.observation.started_at, + ) + + +async def _session(db: Prisma, record: BaselineAccountingRecord): + rows: Final = await db.query_raw('SELECT * FROM "LiteLLM_AutoRouterSession" WHERE api_key=$1', record.api_key) + return rows[0] + + +async def test_late_replay_updates_all_projections_without_rebilling(db: Prisma, record: Callable[..., BaselineAccountingRecord]) -> None: + store: Final = _store(db) + late: Final = record("late", 10001.0) + early: Final = record("early", identical=False) + await _log(db, late) + assert await store.append(late) == "recorded" + assert await store.project(late.scope) == "published" + before: Final = await _session(db, late) + assert before["savings_estimated_actual_spend"] == before["spend"] == 0.17 + assert before["saved_spend"] == 0.0 + await _log(db, early) + assert await store.append(early) == "recorded" + pending: Final = await _session(db, late) + assert pending["spend"] == 0.34 and pending["savings_estimated_turns"] == 0 + assert pending["saved_spend"] == pending["savings_estimated_actual_spend"] == 0.0 + waiting: Final = await db.query_raw('SELECT metadata FROM "LiteLLM_SpendLogs" WHERE request_id=$1', late.observation.request_id) + assert waiting[0]["metadata"]["autorouter_savings"] is None + assert waiting[0]["metadata"]["autorouter_savings_estimate"]["reason"] == "pending_projection" + assert await store.project(early.scope) == "published" + after: Final = await _session(db, late) + assert after["spend"] == 0.34 and after["turns"] == 2 + assert after["savings_estimated_actual_spend"] == 0.17 and after["savings_estimated_turns"] == 1 + logs: Final = await db.query_raw('SELECT spend, metadata FROM "LiteLLM_SpendLogs" WHERE request_id=$1', late.observation.request_id) + assert logs[0]["spend"] == 0.17 + assert logs[0]["metadata"]["autorouter_savings_estimate"]["provenance"] == "modeled" + assert after["saved_spend"] == pytest.approx(logs[0]["metadata"]["autorouter_savings"]) + for table in ("DailyUserSpend", "DailyTeamSpend", "DailyOrganizationSpend", "DailyEndUserSpend", "DailyAgentSpend", "DailyTagSpend"): + rows: Final = await db.query_raw(f'SELECT spend,api_requests,autorouter_savings_spend FROM "LiteLLM_{table}" WHERE api_key=$1', late.api_key) + assert rows[0]["spend"] == rows[0]["api_requests"] == 0 + assert rows[0]["autorouter_savings_spend"] == pytest.approx(after["saved_spend"]) + + +async def test_commit_ack_loss_and_concurrent_duplicate_delivery_are_idempotent(db: Prisma, record: Callable[..., BaselineAccountingRecord]) -> None: + event: Final = record() + await _log(db, event) + assert await _store(db, after_commit=True).append(event) == "unavailable" + store: Final = _store(db) + assert set(await asyncio.gather(*(store.append(event) for _ in range(4)))) == {"recorded"} + assert await store.project(event.scope) == "published" + assert await store.project(event.scope) == "unchanged" + session: Final = await _session(db, event) + assert session["turns"] == session["savings_estimated_turns"] == 1 + assert session["spend"] == session["savings_estimated_actual_spend"] == 0.17 + + +async def test_publication_rollback_keeps_dirty_revision_for_retry(db: Prisma, record: Callable[..., BaselineAccountingRecord]) -> None: + event: Final = record() + await _log(db, event) + store: Final = _store(db) + assert await store.append(event) == "recorded" + assert await _store(db, before_commit=True).project(event.scope) == "unavailable" + session: Final = await _session(db, event) + assert session["spend"] == 0.17 and session["savings_estimated_turns"] == 0 + revisions: Final = await db.query_raw('SELECT revision,published_revision FROM "LiteLLM_AutoRouterBaselineComparison" WHERE scope=$1', event.scope) + assert revisions[0]["revision"] > revisions[0]["published_revision"] + assert await store.project(event.scope) == "published" + assert (await _session(db, event))["savings_estimated_turns"] == 1 + + +async def test_conflicting_duplicate_cannot_restore_an_observed_estimate(db: Prisma, record: Callable[..., BaselineAccountingRecord]) -> None: + event: Final = record() + await _log(db, event) + store: Final = _store(db) + assert await store.append(event) == "recorded" + assert await store.project(event.scope) == "published" + conflict: Final = event.model_copy(update={"observation": event.observation.model_copy(update={"baseline_equivalent": False, "started_at": 20000.0, "available_at": 20001.0})}) + assert await store.append(conflict) == "recorded" + assert (await _session(db, event))["savings_estimated_turns"] == 0 + assert await store.append(event) == "recorded" + assert await store.project(event.scope) == "published" + session: Final = await _session(db, event) + assert session["turns"] == 1 and session["savings_estimated_turns"] == 0 + rows: Final = await db.query_raw('SELECT publication FROM "LiteLLM_AutoRouterBaselineObservation" WHERE request_id=$1', event.observation.request_id) + assert json.loads(rows[0]["publication"])["reason"] == "conflicting_observation" + + +async def test_retired_history_never_recreates_an_initial_zero(db: Prisma, record: Callable[..., BaselineAccountingRecord]) -> None: + original: Final = record() + await _log(db, original) + store: Final = _store(db) + assert await store.append(original) == "recorded" + assert await store.project(original.scope) == "published" + await db.execute_raw('UPDATE "LiteLLM_AutoRouterBaselineComparison" SET updated_at=to_timestamp(0) WHERE scope=$1', original.scope) + await store.retire_before(datetime(2000, 1, 1, tzinfo=timezone.utc), 1000, 1000) + next_turn: Final = record("after-retention", 20000.0) + await _log(db, next_turn) + assert await store.append(next_turn) == "retired" + assert await store.project(original.scope) == "unchanged" + after: Final = await _session(db, original) + assert after["turns"] == 2 and after["spend"] == 0.34 + assert after["savings_estimated_turns"] == 1 and after["savings_estimated_actual_spend"] == 0.17 + + +async def test_native_observation_enters_spend_pipeline_once_with_shared_daily_attribution( + db: Prisma, record: Callable[..., BaselineAccountingRecord], monkeypatch: pytest.MonkeyPatch, +) -> None: + import os + from litellm.proxy.common_utils.user_api_key_cache import UserApiKeyCache + from litellm.proxy.db.db_spend_update_writer import DBSpendUpdateWriter + from litellm.proxy.hooks.autorouter_baseline_cache import CapturedBaselineObservation + from litellm.proxy.utils import PrismaClient, ProxyLogging + + event: Final = record("routed", identical=False) + capture: Final = CapturedBaselineObservation( + scope=event.scope, api_key=event.api_key, session_id=event.session_id, + router_name=event.router_name, baseline_model=event.baseline_model, + model=event.pricing.model, prices=event.pricing.prices, observation=event.observation, + ) + metadata: Final = { + "routing_decision": {"router_model_name": event.router_name, "savings_baseline_model": event.baseline_model}, + "usage_object": event.observation.usage.model_dump(), + "cost_breakdown": {"input_cost": 0.16, "output_cost": 0.01}, + "autorouter_savings": None, "autorouter_savings_estimate": {"version": 3, "status": "unknown", "reason": "pending_projection"}, + "autorouter_baseline_observation": capture.model_dump_json(), + } + payload: Final = { + "request_id": event.observation.request_id, "api_key": event.api_key, "session_id": event.session_id, + "startTime": datetime.fromtimestamp(event.observation.started_at, timezone.utc).isoformat(), + "endTime": datetime.fromtimestamp(event.observation.available_at, timezone.utc).isoformat(), + "spend": 0.17, "prompt_tokens": 6200, "completion_tokens": 30, "model": event.pricing.model, + "model_group": event.router_name, "model_id": "baseline", "custom_llm_provider": "anthropic", + "call_type": "anthropic_messages", "status": "success", "metadata": json.dumps(metadata), + "user": None, "team_id": "", "organization_id": "org", "agent_id": None, + "end_user": "", "request_tags": '["tag","tag"]', + } + monkeypatch.delenv("DATABASE_URL_READ_REPLICA", raising=False) + client: Final = PrismaClient(os.environ["DATABASE_URL"], ProxyLogging(UserApiKeyCache())) + writer: Final = DBSpendUpdateWriter() + try: + await client.db.connect() + await _log(db, event) + await writer._enqueue_autorouter_turn_transaction(payload, client) + assert len(client.baseline_accounting_transactions) == 1 + queued: Final = client.baseline_accounting_transactions[0] + assert queued.daily is not None + assert [(target.entity, target.entity_id) for target in queued.daily.targets] == [ + ("user", None), ("team", ""), ("org", "org"), ("tag", "tag"), + ] + await writer.add_spend_log_transaction_to_daily_tag_transaction(payload, client) + actual_tags: Final = await writer.daily_tag_spend_update_queue.flush_and_get_aggregated_daily_spend_update_transactions() + assert len(actual_tags) == 1 + assert next(iter(actual_tags.values()))["spend"] == 0.17 + durable: Final = BaselineAccountingStore.for_client(client) + anchor: Final = record("anchor", 9999.0) + await _log(db, anchor) + assert await durable.append(anchor) == "recorded" + assert await durable.append(queued) == "recorded" + assert await durable.append(queued) == "recorded" + assert await durable.project(queued.scope) == "published" + session: Final = await _session(db, queued) + assert session["turns"] == session["savings_estimated_turns"] == 2 + assert session["spend"] == session["savings_estimated_actual_spend"] == 0.34 + tag_rows: Final = await db.query_raw( + 'SELECT spend, api_requests, autorouter_savings_spend FROM "LiteLLM_DailyTagSpend" WHERE api_key=$1 AND tag=$2', + queued.api_key, "tag", + ) + assert session["saved_spend"] < 0 + assert len(tag_rows) == 1 + assert tag_rows[0]["autorouter_savings_spend"] == pytest.approx(session["saved_spend"]) + assert tag_rows[0]["spend"] == tag_rows[0]["api_requests"] == 0 + finally: + await client.db.disconnect() diff --git a/tests/proxy_migration_tests/test_autorouter_baseline_state.py b/tests/proxy_migration_tests/test_autorouter_baseline_state.py new file mode 100644 index 00000000000..d9021414bc4 --- /dev/null +++ b/tests/proxy_migration_tests/test_autorouter_baseline_state.py @@ -0,0 +1,103 @@ +"""Idempotent journal migration and primary transactional ownership.""" + +import asyncio +import os +import time +from collections.abc import AsyncGenerator, Iterator +from contextlib import asynccontextmanager +from datetime import timedelta +from pathlib import Path +from typing import Final +from uuid import uuid4 + +import psycopg +import pytest +from psycopg import sql + +from litellm.proxy.common_utils.user_api_key_cache import UserApiKeyCache +from litellm.proxy.db.baseline_accounting import BaselineAccountingStore +from litellm.proxy.db.routing_prisma_wrapper import RoutingPrismaWrapper +from litellm.proxy.utils import PrismaClient, ProxyLogging + +_MIGRATION: Final = Path(__file__).parents[2] / ( + "litellm-proxy-extras/litellm_proxy_extras/migrations/20260915010000_add_autorouter_baseline_state/migration.sql" +) + + +@pytest.fixture +def database() -> Iterator[tuple[str, psycopg.Connection[tuple[object, ...]]]]: + base: Final = os.environ["DATABASE_URL"].split("?")[0] + schema: Final = f"baseline_{uuid4().hex}" + with psycopg.connect(base, autocommit=True) as connection: + connection.execute(sql.SQL("CREATE SCHEMA {}").format(sql.Identifier(schema))) + connection.execute(sql.SQL("SET search_path TO {}").format(sql.Identifier(schema))) + try: + connection.execute(_MIGRATION.read_bytes()) + connection.execute(_MIGRATION.read_bytes()) + yield f"{base}?schema={schema}", connection + finally: + connection.execute(sql.SQL("DROP SCHEMA {} CASCADE").format(sql.Identifier(schema))) + + +@asynccontextmanager +async def _client(env: pytest.MonkeyPatch, url: str, replica: str | None = None) -> AsyncGenerator[PrismaClient]: + with env.context() as context: + context.setenv("DATABASE_URL", url) + context.delenv("DATABASE_URL_READ_REPLICA", raising=False) + if replica is not None: + context.setenv("DATABASE_URL_READ_REPLICA", replica) + client: Final = PrismaClient(url, ProxyLogging(UserApiKeyCache())) + try: + await client.db.connect(timeout=timedelta(seconds=1)) + yield client + finally: + await client.db.disconnect() + + +@pytest.mark.asyncio +async def test_migration_and_projector_use_the_primary_across_clients( + database: tuple[str, psycopg.Connection[tuple[object, ...]]], monkeypatch: pytest.MonkeyPatch, +) -> None: + url, connection = database + connection.execute('CREATE TABLE "LiteLLM_SpendLogs" (request_id TEXT PRIMARY KEY)') + connection.execute('INSERT INTO "LiteLLM_AutoRouterBaselineComparison" ' + '(scope,api_key,session_id,router_name,initial_equivalent,revision) ' + "VALUES ('test','key','session','router',TRUE,1)") + async with _client(monkeypatch, url, url.split("?")[0]) as first: + assert await BaselineAccountingStore.for_client(first).project("test") == "published" + async with _client(monkeypatch, url) as restarted: + assert await BaselineAccountingStore.for_client(restarted).project("test") == "unchanged" + assert connection.execute('SELECT revision=published_revision FROM "LiteLLM_AutoRouterBaselineComparison"').fetchone() == (True,) + + +@pytest.mark.asyncio +async def test_primary_outage_and_missing_table_are_unavailable( + database: tuple[str, psycopg.Connection[tuple[object, ...]]], monkeypatch: pytest.MonkeyPatch, +) -> None: + url, connection = database + async with _client(monkeypatch, "postgresql://unused:unused@127.0.0.1:1/unreachable", url) as degraded: + assert isinstance(degraded.db, RoutingPrismaWrapper) and degraded.db.writer_unavailable + assert await BaselineAccountingStore.for_client(degraded).project("scope") == "unavailable" + connection.execute('DROP TABLE "LiteLLM_AutoRouterBaselineComparison"') + async with _client(monkeypatch, url) as missing: + assert await BaselineAccountingStore.for_client(missing).project("scope") == "unavailable" + + +@pytest.mark.asyncio +async def test_locked_projection_is_bounded_and_cancellation_propagates( + database: tuple[str, psycopg.Connection[tuple[object, ...]]], monkeypatch: pytest.MonkeyPatch, +) -> None: + url, connection = database + async with _client(monkeypatch, url) as client: + store: Final = BaselineAccountingStore.for_client(client) + with connection.transaction(): + connection.execute('LOCK TABLE "LiteLLM_AutoRouterBaselineComparison" IN ACCESS EXCLUSIVE MODE') + started: Final = time.monotonic() + assert await store.project("scope") == "unavailable" + assert time.monotonic() - started < 2 + pending: Final = asyncio.create_task(store.project("scope")) + await asyncio.sleep(0.01) + pending.cancel() + with pytest.raises(asyncio.CancelledError): + await pending + assert await store.project("scope") == "unchanged" diff --git a/tests/proxy_unit_tests/test_update_spend.py b/tests/proxy_unit_tests/test_update_spend.py index 8d78b4b61c1..ebe505b3d60 100644 --- a/tests/proxy_unit_tests/test_update_spend.py +++ b/tests/proxy_unit_tests/test_update_spend.py @@ -37,10 +37,15 @@ class MockPrismaClient: self.daily_user_spend_transactions = {} self.tool_usage_transactions = [] self.autorouter_turn_transactions = [] + self.baseline_accounting_transactions = [] + self.baseline_accounting_lock = asyncio.Lock() + self.spend_log_flush_requested = None + self.db.tx = MagicMock() + self.db.tx.return_value.__aenter__ = AsyncMock(return_value=self.db) + self.db.tx.return_value.__aexit__ = AsyncMock(return_value=None) + self.db.query_raw.return_value = [] # Add locks for the transaction queues (matches real PrismaClient) - import asyncio - self._spend_log_transactions_lock = asyncio.Lock() self.spend_log_write_lock = asyncio.Lock() self._tool_usage_transactions_lock = asyncio.Lock() diff --git a/tests/test_litellm/enterprise/enterprise_callbacks/send_emails/test_endpoints.py b/tests/test_litellm/enterprise/enterprise_callbacks/send_emails/test_endpoints.py index f0e1461c616..7b32d9e8c44 100644 --- a/tests/test_litellm/enterprise/enterprise_callbacks/send_emails/test_endpoints.py +++ b/tests/test_litellm/enterprise/enterprise_callbacks/send_emails/test_endpoints.py @@ -260,3 +260,90 @@ async def test_endpoint_with_no_prisma_client(mock_user_api_key_auth): with pytest.raises(HTTPException) as exc_info: await reset_event_settings(user_api_key_dict=mock_user_api_key_auth) assert exc_info.value.status_code == 500 + + +def _prisma_recording_upserts(upserts): + client = mock.MagicMock() + + async def find_unique(*args, **kwargs): + return None + + async def upsert(*args, **kwargs): + upserts.append(kwargs) + return None + + client.db.litellm_config.find_unique = find_unique + client.db.litellm_config.upsert = upsert + return client + + +def _proxy_config_owning(general_settings): + from litellm.proxy.proxy_server import ProxyConfig + + proxy_config = ProxyConfig() + proxy_config._load_yaml_settings_stores({"general_settings": general_settings}) + return proxy_config + + +@pytest.mark.asyncio +async def test_save_email_settings_refuses_a_config_owned_email_settings(): + upserts = [] + client = _prisma_recording_upserts(upserts) + proxy_config = _proxy_config_owning({"email_settings": {EmailEvent.new_user_invitation.value: True}}) + + with mock.patch("litellm.proxy.proxy_server.proxy_config", proxy_config): # test-quality-ok: the endpoint reads these proxy_server module globals at call time; there is no injection seam + with pytest.raises(HTTPException) as refused: + await _save_email_settings(client, {EmailEvent.new_user_invitation.value: False}) + + assert refused.value.status_code == 400 + assert refused.value.detail["keys"] == ["email_settings"] + assert upserts == [] + + +@pytest.mark.asyncio +async def test_update_event_settings_surfaces_the_config_owned_refusal(mock_user_api_key_auth): + upserts = [] + client = _prisma_recording_upserts(upserts) + proxy_config = _proxy_config_owning({"email_settings": {EmailEvent.virtual_key_created.value: False}}) + request = EmailEventSettingsUpdateRequest( + settings=[EmailEventSettings(event=EmailEvent.virtual_key_created, enabled=True)] + ) + + with mock.patch("litellm.proxy.proxy_server.prisma_client", client): # test-quality-ok: the endpoint reads these proxy_server module globals at call time; there is no injection seam + with mock.patch("litellm.proxy.proxy_server.proxy_config", proxy_config): # test-quality-ok: the endpoint reads these proxy_server module globals at call time; there is no injection seam + with pytest.raises(HTTPException) as refused: + await update_event_settings(request=request, user_api_key_dict=mock_user_api_key_auth) + + assert refused.value.status_code == 400 + assert refused.value.detail["keys"] == ["email_settings"] + assert upserts == [] + + +@pytest.mark.asyncio +async def test_save_email_settings_still_writes_when_the_config_file_is_silent(): + upserts = [] + client = _prisma_recording_upserts(upserts) + proxy_config = _proxy_config_owning({}) + + with mock.patch("litellm.proxy.proxy_server.proxy_config", proxy_config): # test-quality-ok: the endpoint reads these proxy_server module globals at call time; there is no injection seam + await _save_email_settings(client, {EmailEvent.new_user_invitation.value: False}) + + assert len(upserts) == 1 + written = json.loads(upserts[0]["data"]["create"]["param_value"]) + assert written["email_settings"] == {EmailEvent.new_user_invitation.value: False} + + +@pytest.mark.asyncio +async def test_reset_event_settings_surfaces_the_config_owned_refusal(mock_user_api_key_auth): + upserts = [] + client = _prisma_recording_upserts(upserts) + proxy_config = _proxy_config_owning({"email_settings": {EmailEvent.new_user_invitation.value: True}}) + + with mock.patch("litellm.proxy.proxy_server.prisma_client", client): # test-quality-ok: the endpoint reads these proxy_server module globals at call time; there is no injection seam + with mock.patch("litellm.proxy.proxy_server.proxy_config", proxy_config): # test-quality-ok: the endpoint reads these proxy_server module globals at call time; there is no injection seam + with pytest.raises(HTTPException) as refused: + await reset_event_settings(user_api_key_dict=mock_user_api_key_auth) + + assert refused.value.status_code == 400 + assert refused.value.detail["keys"] == ["email_settings"] + assert upserts == [] diff --git a/tests/test_litellm/enterprise/proxy/test_managed_files_hook.py b/tests/test_litellm/enterprise/proxy/test_managed_files_hook.py index cb08e00ff65..74bd67efaf2 100644 --- a/tests/test_litellm/enterprise/proxy/test_managed_files_hook.py +++ b/tests/test_litellm/enterprise/proxy/test_managed_files_hook.py @@ -1067,6 +1067,7 @@ async def test_afile_content_passes_trusted_model_credentials_to_router(): managed_files = _make_managed_files_instance() unified_file_id = "unified-file-id" s3_uri = "s3://my-bucket/litellm-batch-outputs/job-123/input.jsonl.out" + managed_files.get_unified_file_id = AsyncMock(return_value=None) managed_files.get_model_file_id_mapping = AsyncMock( return_value={unified_file_id: {"model-123": s3_uri}} ) @@ -1238,6 +1239,7 @@ async def test_afile_content_bedrock_unified_id_end_to_end(monkeypatch): managed_files = _make_managed_files_instance() unified_file_id = "unified-file-id" s3_uri = "s3://my-bucket/litellm-batch-outputs/job-123/input.jsonl.out" + managed_files.get_unified_file_id = AsyncMock(return_value=None) managed_files.get_model_file_id_mapping = AsyncMock( return_value={unified_file_id: {"model-123": s3_uri}} ) @@ -1268,6 +1270,7 @@ async def test_afile_content_error_reports_unified_id_not_provider_uri(): managed_files = _make_managed_files_instance() unified_file_id = "litellm_proxy_unified_id_abc" s3_uri = "s3://my-bucket/litellm-batch-outputs/job-123/input.jsonl.out" + managed_files.get_unified_file_id = AsyncMock(return_value=None) managed_files.get_model_file_id_mapping = AsyncMock( return_value={unified_file_id: {"model-123": s3_uri}} ) @@ -1732,6 +1735,40 @@ async def test_batch_retrieve_hook_does_not_claim_attribution(): assert managed_files.store_unified_object_id.await_args.kwargs["persist_attribution"] is False +def _unified_batch_id(llm_batch_id: str) -> str: + decoded = f"litellm_proxy;model_id:my-vllm;llm_batch_id:{llm_batch_id}" + return base64.urlsafe_b64encode(decoded.encode()).decode().rstrip("=") + + +@pytest.mark.asyncio +@pytest.mark.parametrize( + "llm_batch_id, stores", + [("litellm_batch_abc", False), ("batch_abc", True)], + ids=["litellm-executed batch is left alone", "provider batch is still stored"], +) +async def test_post_call_hook_leaves_litellm_executed_batches_untouched(llm_batch_id: str, stores: bool): + managed_files = _make_managed_files_instance() + response = _make_batch_response(status="in_progress", output_file_id=None) + response.id = _unified_batch_id(llm_batch_id) + response._hidden_params = { + "unified_batch_id": response.id, + "model_id": "my-vllm", + "model_name": "hosted_vllm/qwen", + } + original_id = response.id + + returned = await managed_files.async_post_call_success_hook( + data={}, + user_api_key_dict=UserAPIKeyAuth(api_key="sk-the-poller", user_id="bob", parent_otel_span=None), + response=response, + ) + + assert returned is response + assert managed_files.store_unified_object_id.await_count == (1 if stores else 0) + if not stores: + assert response.id == original_id + + @pytest.mark.asyncio async def test_afile_delete_passes_trusted_model_credentials_to_router(): """ @@ -1743,6 +1780,7 @@ async def test_afile_delete_passes_trusted_model_credentials_to_router(): managed_files = _make_managed_files_instance() unified_file_id = "unified-file-id" s3_uri = "s3://my-bucket/litellm-bedrock-files/job-123/input.jsonl" + managed_files.get_unified_file_id = AsyncMock(return_value=None) managed_files.get_model_file_id_mapping = AsyncMock(return_value={unified_file_id: {"model-123": s3_uri}}) managed_files.delete_unified_file_id = AsyncMock(return_value=_make_file_object(unified_file_id)) @@ -1809,6 +1847,7 @@ async def test_afile_delete_bedrock_unified_id_end_to_end(monkeypatch): managed_files = _make_managed_files_instance() unified_file_id = "unified-file-id" s3_uri = "s3://my-bucket/litellm-bedrock-files/job-123/input.jsonl" + managed_files.get_unified_file_id = AsyncMock(return_value=None) managed_files.get_model_file_id_mapping = AsyncMock(return_value={unified_file_id: {"model-123": s3_uri}}) managed_files.delete_unified_file_id = AsyncMock(return_value=_make_file_object(unified_file_id)) @@ -1827,3 +1866,147 @@ async def test_afile_delete_bedrock_unified_id_end_to_end(monkeypatch): assert response.id == unified_file_id assert response.model_dump() == {"id": unified_file_id, "object": "file", "deleted": True} managed_files.delete_unified_file_id.assert_awaited_once_with(unified_file_id, None) + + +@pytest.mark.asyncio +async def test_afile_delete_storage_backed_row_deletes_stored_content_not_provider_files(): + from litellm_enterprise.proxy.hooks.managed_files import _PROXY_LiteLLMManagedFiles + from openai.types import FileDeleted + + from litellm.caching import DualCache + from litellm.models.managed_files import LiteLLM_ManagedFileTable + + storage_url = "litellm_db://content-row-1" + unified_file_id = _managed_deletion_file_id(storage_url) + row = LiteLLM_ManagedFileTable( + unified_file_id=unified_file_id, + model_mappings={"vllm-batch": storage_url}, + flat_model_file_ids=[storage_url], + file_object=_make_file_object(unified_file_id), + storage_backend="litellm_db", + storage_url=storage_url, + ) + file_table = MagicMock(find_first=AsyncMock(return_value=row), delete=AsyncMock()) + content_table = MagicMock(delete=AsyncMock()) + managed_files = _PROXY_LiteLLMManagedFiles( + internal_usage_cache=DualCache(), + prisma_client=MagicMock( + db=MagicMock(litellm_managedfiletable=file_table, litellm_managedfilecontenttable=content_table) + ), + ) + router = MagicMock( + get_deployment_credentials_with_provider=MagicMock(return_value=None), + afile_delete=AsyncMock(), + ) + + response = await managed_files.afile_delete( + file_id=unified_file_id, + litellm_parent_otel_span=None, + llm_router=router, + ) + + content_table.delete.assert_awaited_once_with(where={"id": "content-row-1"}) + router.afile_delete.assert_not_awaited() + file_table.delete.assert_awaited_once_with(where={"unified_file_id": unified_file_id}) + assert response == FileDeleted(id=unified_file_id, object="file", deleted=True) + + +@pytest.mark.asyncio +async def test_afile_content_storage_backed_row_returns_stored_bytes_not_provider_content(): + from litellm_enterprise.proxy.hooks.managed_files import _PROXY_LiteLLMManagedFiles + from prisma import Base64 + + from litellm.caching import DualCache + from litellm.models.managed_files import LiteLLM_ManagedFileTable + + storage_url = "litellm_db://content-row-1" + unified_file_id = _managed_deletion_file_id(storage_url) + stored_bytes = b'{"custom_id": "line-1", "method": "POST", "url": "/v1/chat/completions", "body": {}}\n' + row = LiteLLM_ManagedFileTable( + unified_file_id=unified_file_id, + model_mappings={"vllm-batch": storage_url}, + flat_model_file_ids=[storage_url], + file_object=_make_file_object(unified_file_id), + storage_backend="litellm_db", + storage_url=storage_url, + ) + file_table = MagicMock(find_first=AsyncMock(return_value=row)) + content_table = MagicMock(find_unique=AsyncMock(return_value=MagicMock(content=Base64.encode(stored_bytes)))) + managed_files = _PROXY_LiteLLMManagedFiles( + internal_usage_cache=DualCache(), + prisma_client=MagicMock( + db=MagicMock(litellm_managedfiletable=file_table, litellm_managedfilecontenttable=content_table) + ), + ) + router = MagicMock( + get_deployment_credentials_with_provider=MagicMock(return_value=None), + afile_content=AsyncMock(), + ) + + response = await managed_files.afile_content( + file_id=unified_file_id, + litellm_parent_otel_span=None, + llm_router=router, + ) + + assert response.content == stored_bytes + content_table.find_unique.assert_awaited_once_with(where={"id": "content-row-1"}) + router.afile_content.assert_not_awaited() + + +@pytest.mark.asyncio +async def test_store_unified_object_id_batch_processed_is_written_only_when_asked(): + managed_files, mock_prisma = _make_object_store_instance() + upsert = mock_prisma.db.litellm_managedobjecttable.upsert + creator = UserAPIKeyAuth(api_key="sk-creator", user_id="alice", team_id="team-alpha", parent_otel_span=None) + + await managed_files.store_unified_object_id( + unified_object_id="uoi-processed", + file_object=_make_batch_response(status="completed"), + litellm_parent_otel_span=None, + model_object_id="batch-processed", + file_purpose="batch", + user_api_key_dict=creator, + batch_processed=True, + ) + await managed_files.store_unified_object_id( + unified_object_id="uoi-default", + file_object=_make_batch_response(status="completed"), + litellm_parent_otel_span=None, + model_object_id="batch-default", + file_purpose="batch", + user_api_key_dict=creator, + ) + + processed_create, default_create = (call.kwargs["data"]["create"] for call in upsert.await_args_list) + assert processed_create["batch_processed"] is True + assert default_create["batch_processed"] is False + + +@pytest.mark.asyncio +async def test_store_unified_file_id_caches_the_storage_location_the_db_row_gets(): + from litellm_enterprise.proxy.hooks.managed_files import _PROXY_LiteLLMManagedFiles + + from litellm.caching import DualCache + + file_table = MagicMock(upsert=AsyncMock(), find_first=AsyncMock(side_effect=AssertionError("cache miss"))) + managed_files = _PROXY_LiteLLMManagedFiles( + internal_usage_cache=DualCache(), + prisma_client=MagicMock(db=MagicMock(litellm_managedfiletable=file_table)), + ) + stored = _make_file_object("file-kept").model_copy(update={"purpose": "batch"}) + stored._hidden_params = {"storage_backend": "litellm_db", "storage_url": "litellm_db://content-row-1"} + + await managed_files.store_unified_file_id( + file_id="unified-kept", + file_object=stored, + litellm_parent_otel_span=None, + model_mappings={"vllm-batch": "litellm_db://content-row-1"}, + user_api_key_dict=_make_user_api_key_dict(), + ) + cached = await managed_files.get_unified_file_id("unified-kept") + + assert cached is not None + assert (cached.storage_backend, cached.storage_url) == ("litellm_db", "litellm_db://content-row-1") + create_data = file_table.upsert.await_args.kwargs["data"]["create"] + assert (create_data["storage_backend"], create_data["storage_url"]) == ("litellm_db", "litellm_db://content-row-1") diff --git a/tests/test_litellm/integrations/otel/test_otel_v2_sources_of_truth.py b/tests/test_litellm/integrations/otel/test_otel_v2_sources_of_truth.py index f4a8691f72f..17de3cf1e8a 100644 --- a/tests/test_litellm/integrations/otel/test_otel_v2_sources_of_truth.py +++ b/tests/test_litellm/integrations/otel/test_otel_v2_sources_of_truth.py @@ -738,6 +738,140 @@ def test_embedding_summary_is_absent_without_vectors_and_for_chat_data_lists(): assert chat.embedding_output is None +def _responses_payload(output: list[object], status: str = "completed", **response_fields: object): + return _sample_payload( + call_type="aresponses", + model="gpt-5.4-nano", + response={"id": "resp_1", "object": "response", "status": status, "output": output, **response_fields}, + ) + + +_RESPONSES_TEXT_ITEM = { + "type": "message", + "role": "assistant", + "status": "completed", + "content": [{"type": "output_text", "text": "po", "annotations": []}, {"type": "output_text", "text": "ng"}], +} + + +def test_responses_output_text_becomes_one_assistant_choice_with_stop(): + data = LLMCallSpanData.from_standard_logging_payload( + _responses_payload([{"type": "reasoning", "summary": []}, _RESPONSES_TEXT_ITEM]), capture_content=True + ) + + assert json.loads(json.dumps(data.choices_out)) == [ + { + "message": {"role": "assistant", "content": "pong", "refusal": None, "tool_calls": None}, + "finish_reason": "stop", + } + ] + assert data.finish_reasons == ("stop",) + assert data.response_id == "resp_1" + + +def test_responses_tool_calls_fold_into_the_assistant_message_with_tool_calls_finish_reason(): + data = LLMCallSpanData.from_standard_logging_payload( + _responses_payload( + [ + _RESPONSES_TEXT_ITEM, + {"type": "function_call", "call_id": "call_1", "name": "get_weather", "arguments": '{"city": "sf"}'}, + {"type": "custom_tool_call", "call_id": "call_2", "name": "grep", "input": "-r TODO"}, + ] + ), + capture_content=True, + ) + + assert len(data.choices_out) == 1 + message = data.choices_out[0]["message"] + assert message["content"] == "pong" + assert json.loads(json.dumps(message["tool_calls"])) == [ + {"id": "call_1", "type": "function", "function": {"name": "get_weather", "arguments": '{"city": "sf"}'}}, + {"id": "call_2", "type": "function", "function": {"name": "grep", "arguments": "-r TODO"}}, + ] + assert data.finish_reasons == ("tool_calls",) + + +def test_responses_tool_call_only_output_has_no_content(): + data = LLMCallSpanData.from_standard_logging_payload( + _responses_payload([{"type": "function_call", "id": "fc_1", "name": "get_weather", "arguments": "{}"}]), + capture_content=True, + ) + + assert data.choices_out[0]["message"]["content"] is None + assert data.choices_out[0]["message"]["tool_calls"][0]["id"] == "fc_1" + + +@pytest.mark.parametrize( + ("status", "response_fields", "expected"), + [ + ("incomplete", {"incomplete_details": {"reason": "max_output_tokens"}}, ("length",)), + ("incomplete", {"incomplete_details": {"reason": "content_filter"}}, ("content_filter",)), + ("incomplete", {}, ("length",)), + ("failed", {}, ()), + ], +) +def test_responses_status_maps_to_finish_reasons(status, response_fields, expected): + data = LLMCallSpanData.from_standard_logging_payload( + _responses_payload([_RESPONSES_TEXT_ITEM], status=status, **response_fields), capture_content=True + ) + + assert data.finish_reasons == expected + assert data.choices_out[0]["message"]["content"] == "pong" + + +def test_responses_output_follows_the_content_capture_gate_but_finish_reasons_do_not(): + data = LLMCallSpanData.from_standard_logging_payload(_responses_payload([_RESPONSES_TEXT_ITEM])) + + assert data.choices_out == () + assert data.finish_reasons == ("stop",) + + +def test_responses_content_only_reads_output_text_parts(): + item = { + "type": "message", + "role": "assistant", + "content": [{"type": "refusal", "refusal": "no", "text": "not output"}, {"type": "output_text", "text": "ok"}], + } + data = LLMCallSpanData.from_standard_logging_payload(_responses_payload([item]), capture_content=True) + + assert data.choices_out[0]["message"]["content"] == "ok" + assert data.choices_out[0]["message"]["refusal"] == "no" + + +def test_responses_refusal_only_output_keeps_the_refusal_text(): + item = { + "type": "message", + "role": "assistant", + "content": [{"type": "refusal", "refusal": "I can't "}, {"type": "refusal", "refusal": "help with that."}], + } + data = LLMCallSpanData.from_standard_logging_payload(_responses_payload([item]), capture_content=True) + + assert json.loads(json.dumps(data.choices_out)) == [ + { + "message": {"role": "assistant", "content": None, "refusal": "I can't help with that.", "tool_calls": None}, + "finish_reason": "stop", + } + ] + + +def test_responses_output_without_messages_or_tool_calls_stays_empty(): + data = LLMCallSpanData.from_standard_logging_payload( + _responses_payload([{"type": "reasoning", "summary": []}]), capture_content=True + ) + + assert data.choices_out == () + assert data.finish_reasons == () + + +def test_chat_choices_win_over_a_responses_output_list(): + payload = _sample_payload(response={"choices": [{"finish_reason": "stop", "message": {"content": "chat"}}]}) + payload["response"]["output"] = [_RESPONSES_TEXT_ITEM] + data = LLMCallSpanData.from_standard_logging_payload(payload, capture_content=True) + + assert data.choices_out[0]["message"]["content"] == "chat" + assert data.finish_reasons == ("stop",) + + def test_request_identity_prefers_canonical_team_keys(): from litellm.integrations.otel.model.payloads import RequestIdentity diff --git a/tests/test_litellm/integrations/otel/test_otel_v2_vendor_mappers.py b/tests/test_litellm/integrations/otel/test_otel_v2_vendor_mappers.py index c5ebc4bc53a..4e375de0494 100644 --- a/tests/test_litellm/integrations/otel/test_otel_v2_vendor_mappers.py +++ b/tests/test_litellm/integrations/otel/test_otel_v2_vendor_mappers.py @@ -196,6 +196,37 @@ def test_langfuse_mapper_keeps_chat_output_when_no_embedding_summary(): assert json.loads(attrs["langfuse.observation.output"]) == [{"role": "assistant", "content": "Sunny."}] +def test_langfuse_mapper_renders_a_responses_api_call_from_the_standard_logging_payload(): + payload = { + "call_type": "aresponses", + "custom_llm_provider": "openai", + "model": "gpt-5.4-nano", + "messages": [{"role": "user", "content": "weather in sf?"}], + "response": { + "id": "resp_1", + "status": "completed", + "output": [ + {"type": "message", "role": "assistant", "content": [{"type": "output_text", "text": "Checking."}]}, + {"type": "function_call", "call_id": "call_1", "name": "get_weather", "arguments": '{"city": "sf"}'}, + ], + }, + } + data = LLMCallSpanData.from_standard_logging_payload(payload, capture_content=True) + attrs = LangfuseMapper().map(data) + + assert json.loads(attrs["langfuse.observation.output"]) == [ + { + "role": "assistant", + "content": "Checking.", + "refusal": None, + "tool_calls": [ + {"id": "call_1", "type": "function", "function": {"name": "get_weather", "arguments": '{"city": "sf"}'}} + ], + } + ] + assert attrs["langfuse.observation.type"] == "generation" + + # --------------------------------------------------------------------------- # # Weave # --------------------------------------------------------------------------- # diff --git a/tests/test_litellm/litellm_core_utils/test_litellm_logging.py b/tests/test_litellm/litellm_core_utils/test_litellm_logging.py index 999adbdd935..626a13c8061 100644 --- a/tests/test_litellm/litellm_core_utils/test_litellm_logging.py +++ b/tests/test_litellm/litellm_core_utils/test_litellm_logging.py @@ -3532,6 +3532,24 @@ def test_function_setup_litellm_metadata_guardrail_writes_visible_after_setup(): assert merged.get("applied_guardrails") == ["pam-ethical-request"] +def test_get_standard_logging_metadata_merges_recorded_applied_guardrails(): + from litellm.litellm_core_utils.litellm_logging import StandardLoggingPayloadSetup + + result = StandardLoggingPayloadSetup.get_standard_logging_metadata( + metadata={"applied_guardrails": ["blocker"]}, + litellm_params={}, + applied_guardrails=["guard-a", "blocker", "guard-b"], + ) + assert result["applied_guardrails"] == ["guard-a", "blocker", "guard-b"] + + result = StandardLoggingPayloadSetup.get_standard_logging_metadata( + metadata={"applied_guardrails": ["blocker"]}, + litellm_params={}, + applied_guardrails=["guard-a"], + ) + assert result["applied_guardrails"] == ["guard-a", "blocker"] + + def test_function_setup_metadata_takes_precedence_over_litellm_metadata(): """ Test that when BOTH metadata and litellm_metadata are present (e.g., user sets diff --git a/tests/test_litellm/litellm_core_utils/test_redact_messages.py b/tests/test_litellm/litellm_core_utils/test_redact_messages.py index 584a3ac471c..276a67e0bd4 100644 --- a/tests/test_litellm/litellm_core_utils/test_redact_messages.py +++ b/tests/test_litellm/litellm_core_utils/test_redact_messages.py @@ -493,6 +493,40 @@ class TestPerformRedaction: assert redacted["output"][0]["arguments"] == "redacted-by-litellm" assert redacted["output"][0]["name"] == "get_weather" + def test_redacts_responses_api_custom_tool_call_input_dict(self): + result = { + "output": [ + {"type": "custom_tool_call", "name": "grep", "input": "-r secret-token", "call_id": "call_1"}, + {"type": "function_call", "name": "get_weather", "input": "not-a-custom-input", "call_id": "call_2"}, + ] + } + + redacted = perform_redaction({}, result) + + assert redacted["output"][0]["input"] == "redacted-by-litellm" + assert redacted["output"][0]["name"] == "grep" + assert redacted["output"][1]["input"] == "not-a-custom-input" + + def test_redacts_responses_api_refusal_parts_dict(self): + result = { + "output": [ + { + "type": "message", + "role": "assistant", + "content": [ + {"type": "refusal", "refusal": "I cannot share the secret"}, + {"type": "output_text", "text": "ok"}, + ], + } + ] + } + + redacted = perform_redaction({}, result) + + assert redacted["output"][0]["content"][0]["refusal"] == "redacted-by-litellm" + assert redacted["output"][0]["content"][0]["type"] == "refusal" + assert redacted["output"][0]["content"][1]["text"] == "redacted-by-litellm" + def test_redacts_every_tool_call_in_multi_element_list(self): result = litellm.ModelResponse( id="resp-multi", @@ -563,6 +597,23 @@ class TestPerformRedaction: assert output_item.arguments == "redacted-by-litellm" assert output_item.name == "get_weather" + def test_redacts_responses_api_custom_tool_call_input_object(self): + output_item = SimpleNamespace(type="custom_tool_call", name="grep", input="-r secret-token", call_id="call_1") + + _redact_responses_api_output([output_item]) + + assert output_item.input == "redacted-by-litellm" + assert output_item.name == "grep" + + def test_redacts_responses_api_refusal_parts_object(self): + refusal = SimpleNamespace(type="refusal", refusal="I cannot share the secret") + output_item = SimpleNamespace(type="message", role="assistant", content=[refusal]) + + _redact_responses_api_output([output_item]) + + assert refusal.refusal == "redacted-by-litellm" + assert refusal.type == "refusal" + def test_redacts_response_output_objects_with_top_level_text(self): output_items = [ SimpleNamespace(text="top-level output"), diff --git a/tests/test_litellm/llms/anthropic/chat/test_anthropic_chat_transformation.py b/tests/test_litellm/llms/anthropic/chat/test_anthropic_chat_transformation.py index 5e179f950a0..633dd1d9460 100644 --- a/tests/test_litellm/llms/anthropic/chat/test_anthropic_chat_transformation.py +++ b/tests/test_litellm/llms/anthropic/chat/test_anthropic_chat_transformation.py @@ -124,22 +124,32 @@ def test_calculate_usage_prefers_served_speed_from_response_usage(): assert no_response_speed.speed == "fast" -def test_streaming_iterator_persists_served_speed_across_usage_chunks(): +@pytest.mark.parametrize("input_update, expected_fresh", [({}, 1000), ({"input_tokens": 0}, 0), ({"input_tokens": 2000}, 2000)]) +def test_streaming_iterator_persists_cumulative_usage_across_partial_chunks(input_update, expected_fresh): """ - Only ``message_start`` usage carries the served speed; the final - ``message_delta`` usage does not. The iterator must remember the served - value so the last usage chunk, which wins in the stream chunk builder, does - not fall back to the requested speed. + Omitted input/cache/pricing fields retain their last cumulative values; + explicit input updates, including zero, replace them. """ from litellm.llms.anthropic.chat.handler import ModelResponseIterator iterator = ModelResponseIterator(None, sync_stream=True, speed="fast") - start_usage = iterator._handle_usage({"input_tokens": 12, "output_tokens": 1, "speed": "standard"}) - delta_usage = iterator._handle_usage({"output_tokens": 5}) + start_usage = iterator._handle_usage({ + "input_tokens": 1000, "output_tokens": 1, "speed": "standard", "inference_geo": "us", + "cache_creation_input_tokens": 3000, "cache_read_input_tokens": 2000, + "cache_creation": {"ephemeral_5m_input_tokens": 0, "ephemeral_1h_input_tokens": 3000}, + }) + delta_usage = iterator._handle_usage({"output_tokens": 5, **input_update}) assert start_usage.speed == "standard" assert delta_usage.speed == "standard" + assert delta_usage.inference_geo == "us" + assert delta_usage.prompt_tokens == expected_fresh + 5000 + assert delta_usage.completion_tokens == 5 + details = delta_usage.prompt_tokens_details + assert (details.text_tokens, details.cached_tokens, details.cache_creation_tokens) == (expected_fresh, 2000, 3000) + assert details.cache_creation_token_details.ephemeral_1h_input_tokens == 3000 + assert start_usage.prompt_tokens_details.text_tokens == 1000 def test_calculate_usage_aggregates_cache_creation_split_across_iterations(): diff --git a/tests/test_litellm/llms/anthropic/test_anthropic_prompt_cache_prediction.py b/tests/test_litellm/llms/anthropic/test_anthropic_prompt_cache_prediction.py index 2b36866a1a0..62099f97b71 100644 --- a/tests/test_litellm/llms/anthropic/test_anthropic_prompt_cache_prediction.py +++ b/tests/test_litellm/llms/anthropic/test_anthropic_prompt_cache_prediction.py @@ -15,11 +15,17 @@ from litellm.caching.llm_caching_handler import LLMClientCache from litellm.llms.anthropic.count_tokens import handler as count_handler from litellm.llms.anthropic.experimental_pass_through.messages.transformation import DEFAULT_ANTHROPIC_API_VERSION from litellm.llms.anthropic.prompt_cache_prediction import ( + CountedPromptCachePlan, NativePredictionTarget, + PromptCachePlan, + UnsupportedCachePlan, cache_scope, + count_cache_plan, count_prompt_tokens, + parse_cache_plan, parse_observed_cache, parse_prompt, + resolve_baseline_prediction_target, resolve_prediction_target, supported_prediction_headers, ) @@ -207,3 +213,232 @@ async def test_named_credential_is_explicitly_unsupported_before_count( assert arm.cache_state == "unknown" assert arm.reason == "unsupported_deployment_configuration" assert arm.estimate is None and arm.cold is None and arm.warm is None + + +def _cache_plan(body: Mapping[str, JsonValue]) -> PromptCachePlan: + plan: Final = parse_cache_plan(body) + assert isinstance(plan, PromptCachePlan) + return plan + + +def _text(text: str, ttl: str | None = None) -> dict[str, JsonValue]: + return {"type": "text", "text": text, + **({"cache_control": {"type": "ephemeral", "ttl": ttl}} if ttl else {})} + + +def _prompt(*blocks: dict[str, JsonValue], role: str = "user", **options: JsonValue) -> dict[str, JsonValue]: + return {**options, "messages": [{"role": role, "content": list(blocks)}]} + + +@pytest.mark.parametrize("text, supported", [("", False), (" \t", False), ("Context", True)]) +def test_public_predictor_preserves_string_message_policy(text: str, supported: bool) -> None: + body: Final = _body() + messages: Final = body["messages"] + assert isinstance(messages, list) + request: Final[dict[str, JsonValue]] = {**body, "messages": [{"role": "user", "content": text}, *messages]} + assert (parse_prompt(request) is not None) is supported + + +def test_cache_plan_preserves_hierarchical_prefixes_and_public_policy() -> None: + body: Final = _prompt( + _text("First turn", "5m"), system=[_text("Stable instructions", "1h")], + tools=[{"name": "lookup", "input_schema": {"type": "object"}, + "cache_control": {"type": "ephemeral", "ttl": "1h"}}], + ) + plan: Final = _cache_plan(body) + changed: Final = _cache_plan({**body, "system": [_text("Changed instructions", "1h")]}) + assert tuple(marker.ttl_seconds for marker in plan.breakpoints) == (3600, 3600, 300) + assert plan.breakpoints[0].fingerprint == changed.breakpoints[0].fingerprint + assert all(left.fingerprint != right.fingerprint for left, right + in zip(plan.breakpoints[1:], changed.breakpoints[1:])) + assert plan.breakpoints[0].prefix_body == { + "tools": [{"name": "lookup", "input_schema": {"type": "object"}}], + "messages": [], + } + assert parse_prompt(body) is None + + +@pytest.mark.parametrize("kind, added, matches", [ + ("text", 19, True), ("text", 20, False), ("tool_use", 30, True), + ("tool_result", 30, True), +]) +def test_cache_plan_lookback_counts_native_positions( + kind: str, added: int, matches: bool, +) -> None: + previous: Final = _cache_plan(_body()) + appended: Final[list[dict[str, JsonValue]]] = [ + {"type": "tool_use", "id": f"tool_{index}", "name": "lookup", "input": {}} + if kind == "tool_use" else + {"type": "tool_result", "tool_use_id": f"tool_{index}", "content": "done"} + if kind == "tool_result" else + {"type": "text", "text": f"Added {index}"} + for index in range(added) + ] + current: Final = _cache_plan({**_body(), **_prompt( + _text("A cacheable prefix"), *appended[:-1], + {**appended[-1], "cache_control": {"type": "ephemeral"}}, + )}) + assert (previous.breakpoints[0].fingerprint + in current.breakpoints[0].lookback_fingerprints) is matches + + +@pytest.mark.parametrize("change, same_prefix, same_content", [ + ("tool_order", False, False), ("effort", False, False), + ("standard_speed", True, True), ("ttl", False, True), +]) +def test_cache_plan_identity_respects_settings_and_preserves_content( + change: str, same_prefix: bool, same_content: bool, +) -> None: + tool_input: Final[dict[str, JsonValue]] = {"a": 1, "b": 2, "cache_control": {"ttl": "user-data"}} + block: Final[dict[str, JsonValue]] = { + "type": "tool_use", "id": "tool_1", "name": "lookup", "input": tool_input, + "cache_control": {"type": "ephemeral", "ttl": "5m"}, + } + changed_block: Final = ( + {**block, "input": dict(reversed(tool_input.items()))} if change == "tool_order" else + {**block, "cache_control": {"type": "ephemeral", "ttl": "1h"}} if change == "ttl" else block + ) + before: Final = _cache_plan(_prompt(block, role="assistant", output_config={"effort": "low"})).breakpoints[0] + after: Final = _cache_plan(_prompt( + changed_block, role="assistant", output_config={"effort": "high" if change == "effort" else "low"}, + **({"speed": "standard"} if change == "standard_speed" else {}), + )).breakpoints[0] + assert (before.fingerprint == after.fingerprint) is same_prefix + assert (before.fingerprint in after.lookback_fingerprints) is same_prefix + assert (before.content_fingerprint == after.content_fingerprint) is same_content + assert (before.content_fingerprint in after.lookback_content_fingerprints) is same_content + assert "user-data" in json.dumps(dict(before.prefix_body)) + assert not supported_prediction_headers({"anthropic-beta": "fast-mode-2026-02-01"}) + + +def test_cache_plan_automatic_cache_and_thinking_use_last_cacheable_block() -> None: + body: Final = _prompt( + _text("A stable answer"), {"type": "thinking", "thinking": "Thinking", "signature": "signature"}, + role="assistant", thinking={"type": "adaptive"}, cache_control={"type": "ephemeral", "ttl": "1h"}, + ) + plan: Final = _cache_plan(body) + assert len(plan.breakpoints) == 1 + assert plan.breakpoints[0].ttl_seconds == 3600 + assert plan.breakpoints[0].prefix_body == { + "thinking": {"type": "adaptive"}, + "messages": [{"role": "assistant", "content": [ + {"type": "text", "text": "A stable answer"}, + ]}], + } + assert parse_prompt(body) is None + + +@pytest.mark.parametrize("body, reason", [ + (_prompt({"type": "image"}), "unsupported_prompt_shape"), + ({**_body(), "unknown_native_setting": True}, "unsupported_prompt_shape"), + ({**_body(), "cache_control": {"type": "ephemeral", "ttl": "1h"}}, + "conflicting_cache_ttl"), + (_prompt(_text("five", "5m"), _text("hour", "1h")), "invalid_cache_ttl_order"), +]) +def test_cache_plan_unsupported_is_explicit( + body: Mapping[str, JsonValue], reason: str, +) -> None: + result: Final = parse_cache_plan(body) + assert isinstance(result, UnsupportedCachePlan) + assert result.reason == reason + + +@pytest.mark.asyncio +@pytest.mark.parametrize("model, counts, reason", [ + (None, (100, 150, 200), None), + (None, (100, 201, 200), "inconsistent_prefix_token_count"), + (None, (151, 150, 200), "inconsistent_prefix_token_count"), + (None, (None, 150, 200), "token_count_unavailable"), + ("claude-opus-5", (100, 150, 200), None), + ("claude-sonnet-5", (100, 150, 200), None), + ("declared-cache-model", (100, 150, 200), None), + ("unknown-cache-model", (100, 150, 200), "unsupported_thinking_cache_semantics"), + ("claude-haiku-4-5", (100, 150, 200), "unsupported_thinking_cache_semantics"), + ("claude-sonnet-4-5", (100, 150, 200), "unsupported_thinking_cache_semantics"), +]) +async def test_cache_plan_count_conserves_total_and_rejects_unknown( + model: str | None, counts: tuple[int | None, int | None, int], reason: str | None, + monkeypatch: pytest.MonkeyPatch, +) -> None: + monkeypatch.setitem(litellm.model_cost, "declared-cache-model", { + "litellm_provider": "anthropic", "mode": "chat", "supports_thinking_cache_preservation": True, + }) + plan: Final = _cache_plan(_prompt( + {"type": "thinking", "thinking": "Retained thought", "signature": "signature"} + if model else _text("first", "5m"), + _text("second", "5m"), _text("uncached"), role="assistant" if model else "user", + )) + + async def count(model: str, api_key: str, body: Mapping[str, JsonValue]) -> int | None: + assert reason != "unsupported_thinking_cache_semantics", "Unverified thinking retention must skip counting" + if body is plan.full_body: + return counts[2] + return counts[0] if body is plan.breakpoints[0].prefix_body else counts[1] + + result: Final = await count_cache_plan(model or _MODEL, _KEY, plan, count) + if reason is not None: + assert isinstance(result, UnsupportedCachePlan) + assert result.reason == reason + else: + assert isinstance(result, CountedPromptCachePlan) + assert result.total_tokens == 200 + assert tuple(marker.prefix_tokens for marker in result.breakpoints) == ((100,) if model else (100, 150)) + + +@pytest.mark.asyncio +@pytest.mark.parametrize("section", ["system", "tools"]) +@pytest.mark.parametrize("rejects_prefix", (False, True)) +async def test_native_count_preserves_settings_and_requires_every_prefix( + section: str, rejects_prefix: bool, monkeypatch: pytest.MonkeyPatch, +) -> None: + monkeypatch.setattr(litellm, "disable_aiohttp_transport", True) + monkeypatch.setattr(litellm, "in_memory_llm_clients_cache", LLMClientCache()) + params: Final = LiteLLM_Params( + model=f"anthropic/{_MODEL}", api_key=_KEY, + api_base="https://gateway.example/v1/messages", + ) + target: Final = resolve_baseline_prediction_target(params) + assert isinstance(target, NativePredictionTarget) + assert target.api_base == params.api_base + assert not isinstance(resolve_prediction_target(params), NativePredictionTarget) + body: Final = _body() + marker: Final[dict[str, JsonValue]] = {"type": "ephemeral", "ttl": "1h"} + body[section] = ([_text("A cached system", "1h")] if section == "system" else [{ + "name": "lookup", "input_schema": {"type": "object"}, "cache_control": marker, + }]) + plan: Final = _cache_plan({**body, **_prompt( + _text("A later prefix", "5m"), _text("An uncached suffix"), + thinking={"type": "adaptive"}, tool_choice={"type": "auto"}, output_config={"effort": "high"}, + )}) + assert len(plan.breakpoints) == 2 + assert plan.breakpoints[0].prefix_body["messages"] == [] + + async def count(model: str, api_key: str, body: Mapping[str, JsonValue]) -> int | None: + return await count_prompt_tokens( + model, api_key, {**body, "max_tokens": 100}, api_base=target.api_base, + ) + + with respx.mock(assert_all_called=False) as upstream: + endpoint: Final = "https://gateway.example/v1/messages/count_tokens" + routes: Final = tuple( + upstream.post(endpoint, json={**body, "model": _MODEL}).respond( + 400 if rejects_prefix and index == 1 else 200, + json={"detail": {"error": "messages parameter is required"}} + if rejects_prefix and index == 1 else {"input_tokens": tokens}, + ) + for index, (body, tokens) in enumerate(( + (plan.full_body, 6000), (plan.breakpoints[0].prefix_body, 5000), + (plan.breakpoints[1].prefix_body, 5800), + )) + ) + unexpected: Final = upstream.post(endpoint).respond(200, json={"input_tokens": 1}) + result: Final = await count_cache_plan(target.model, target.api_key, plan, count) + + if rejects_prefix: + assert result == UnsupportedCachePlan("token_count_unavailable") + else: + assert isinstance(result, CountedPromptCachePlan) + assert result.total_tokens == 6000 + assert tuple(marker.prefix_tokens for marker in result.breakpoints) == (5000, 5800) + assert tuple(route.call_count for route in routes) == (1, 1, 1) + assert unexpected.call_count == 0 diff --git a/tests/test_litellm/llms/azure/chat/test_azure_chat_gpt_transformation.py b/tests/test_litellm/llms/azure/chat/test_azure_chat_gpt_transformation.py index 7ea69a3e416..d445fb0fb59 100644 --- a/tests/test_litellm/llms/azure/chat/test_azure_chat_gpt_transformation.py +++ b/tests/test_litellm/llms/azure/chat/test_azure_chat_gpt_transformation.py @@ -335,6 +335,129 @@ class TestAzureToolSchemaCombinatorFlattening: assert request["temperature"] == 0.2 +@pytest.mark.parametrize("tool_choice", ["none", "auto"]) +def test_azure_drops_tool_choice_without_tools_or_functions(tool_choice: str) -> None: + optional_params = {"tool_choice": tool_choice, "temperature": 0.2} + request = AzureOpenAIConfig().transform_request( + model="gpt-4o", + messages=[{"role": "user", "content": "hi"}], + optional_params=optional_params, + litellm_params={"custom_llm_provider": "azure"}, + headers={}, + ) + + assert "tool_choice" not in request + assert request["temperature"] == 0.2 + assert optional_params["tool_choice"] == tool_choice + + +def test_azure_tools_empty_drops_tool_choice() -> None: + request = AzureOpenAIConfig().transform_request( + model="gpt-4o", + messages=[{"role": "user", "content": "hi"}], + optional_params={"tools": [], "tool_choice": "auto"}, + litellm_params={"custom_llm_provider": "azure"}, + headers={}, + ) + + assert request["tools"] == [] + assert "tool_choice" not in request + + +def test_azure_functions_empty_drops_tool_choice() -> None: + request = AzureOpenAIConfig().transform_request( + model="gpt-4o", + messages=[{"role": "user", "content": "hi"}], + optional_params={"functions": [], "tool_choice": "none"}, + litellm_params={"custom_llm_provider": "azure"}, + headers={}, + ) + + assert request["functions"] == [] + assert "tool_choice" not in request + + +def test_azure_preserves_tool_choice_with_tools() -> None: + tools = [{"type": "function", "function": {"name": "get_weather", "parameters": {}}}] + request = AzureOpenAIConfig().transform_request( + model="gpt-4o", + messages=[{"role": "user", "content": "hi"}], + optional_params={"tools": tools, "tool_choice": "auto"}, + litellm_params={"custom_llm_provider": "azure"}, + headers={}, + ) + + assert request["tools"] == tools + assert request["tool_choice"] == "auto" + + +def test_azure_preserves_tool_choice_with_legacy_functions() -> None: + functions = [{"name": "get_weather", "parameters": {}}] + request = AzureOpenAIConfig().transform_request( + model="gpt-4o", + messages=[{"role": "user", "content": "hi"}], + optional_params={"functions": functions, "tool_choice": "auto"}, + litellm_params={"custom_llm_provider": "azure"}, + headers={}, + ) + + assert request["functions"] == functions + assert request["tool_choice"] == "auto" + + +def test_azure_preserves_function_call_without_tools() -> None: + request = AzureOpenAIConfig().transform_request( + model="gpt-4o", + messages=[{"role": "user", "content": "hi"}], + optional_params={"function_call": "none", "tool_choice": "auto"}, + litellm_params={"custom_llm_provider": "azure"}, + headers={}, + ) + + assert request["function_call"] == "none" + assert "tool_choice" not in request + + +def test_azure_gpt5_drops_tool_choice_without_tools() -> None: + request = AzureOpenAIGPT5Config().transform_request( + model="gpt5_series/gpt-5.6-sol", + messages=[{"role": "user", "content": "hi"}], + optional_params={"tool_choice": "none"}, + litellm_params={"custom_llm_provider": "azure"}, + headers={}, + ) + + assert request["model"] == "gpt-5.6-sol" + assert "tool_choice" not in request + + +@pytest.mark.asyncio +async def test_azure_async_transform_drops_tool_choice_without_tools() -> None: + request = await AzureOpenAIConfig().async_transform_request( + model="gpt-4o", + messages=[{"role": "user", "content": "hi"}], + optional_params={"tool_choice": "none"}, + litellm_params={"custom_llm_provider": "azure"}, + headers={}, + ) + + assert "tool_choice" not in request + + +@pytest.mark.asyncio +async def test_azure_gpt5_async_transform_drops_tool_choice_without_tools() -> None: + request = await AzureOpenAIGPT5Config().async_transform_request( + model="gpt5_series/gpt-5.6-sol", + messages=[{"role": "user", "content": "hi"}], + optional_params={"tool_choice": "auto"}, + litellm_params={"custom_llm_provider": "azure"}, + headers={}, + ) + + assert request["model"] == "gpt-5.6-sol" + assert "tool_choice" not in request + + def test_transform_request_strips_litellm_format_from_managed_file_id(): import base64 diff --git a/tests/test_litellm/llms/base_llm/files/test_litellm_db_storage_backend.py b/tests/test_litellm/llms/base_llm/files/test_litellm_db_storage_backend.py new file mode 100644 index 00000000000..fabcb340a48 --- /dev/null +++ b/tests/test_litellm/llms/base_llm/files/test_litellm_db_storage_backend.py @@ -0,0 +1,92 @@ +from types import SimpleNamespace +from unittest.mock import AsyncMock, MagicMock + +import pytest +from prisma import Base64 +from prisma.errors import RecordNotFoundError + +from litellm.llms.base_llm.files.litellm_db_storage_backend import ( + LITELLM_DB_STORAGE_URL_PREFIX, + LiteLLMDbStorageBackend, + storage_url_to_row_id, +) + + +def _backend_with_table(): + table = MagicMock(create=AsyncMock(), find_unique=AsyncMock(), delete=AsyncMock()) + prisma_client = MagicMock(db=MagicMock(litellm_managedfilecontenttable=table)) + return LiteLLMDbStorageBackend(prisma_client), table + + +@pytest.mark.asyncio +async def test_upload_stores_bytes_and_returns_prefixed_row_id(): + backend, table = _backend_with_table() + table.create.return_value = SimpleNamespace(id="row-1") + content = b"\x00\x01binary jsonl\n" + + storage_url = await backend.upload_file(file_content=content, filename="input.jsonl", content_type="text/plain") + + assert storage_url == f"{LITELLM_DB_STORAGE_URL_PREFIX}row-1" + stored = table.create.await_args.kwargs["data"]["content"] + assert isinstance(stored, Base64) + assert stored.decode() == content + + +@pytest.mark.asyncio +async def test_download_returns_exact_bytes_of_the_row(): + backend, table = _backend_with_table() + content = b'{"custom_id": "1"}\n' + table.find_unique.return_value = SimpleNamespace(id="row-1", content=Base64.encode(content)) + + downloaded = await backend.download_file(f"{LITELLM_DB_STORAGE_URL_PREFIX}row-1") + + assert downloaded == content + table.find_unique.assert_awaited_once_with(where={"id": "row-1"}) + + +@pytest.mark.asyncio +async def test_download_missing_row_raises_value_error_naming_the_url(): + backend, table = _backend_with_table() + table.find_unique.return_value = None + storage_url = f"{LITELLM_DB_STORAGE_URL_PREFIX}missing" + + with pytest.raises(ValueError, match="missing"): + await backend.download_file(storage_url) + + +@pytest.mark.asyncio +async def test_download_rejects_url_without_prefix_before_touching_the_db(): + backend, table = _backend_with_table() + + with pytest.raises(ValueError, match="https://elsewhere/blob"): + await backend.download_file("https://elsewhere/blob") + + table.find_unique.assert_not_awaited() + + +@pytest.mark.asyncio +async def test_delete_removes_the_parsed_row(): + backend, table = _backend_with_table() + + await backend.delete_file(f"{LITELLM_DB_STORAGE_URL_PREFIX}row-1") + + table.delete.assert_awaited_once_with(where={"id": "row-1"}) + + +@pytest.mark.asyncio +async def test_delete_tolerates_a_row_that_is_already_gone(): + backend, table = _backend_with_table() + table.delete.side_effect = RecordNotFoundError({"user_facing_error": {"message": "gone"}}) + + await backend.delete_file(f"{LITELLM_DB_STORAGE_URL_PREFIX}row-1") + + table.delete.assert_awaited_once_with(where={"id": "row-1"}) + + +def test_storage_url_to_row_id_round_trips(): + assert storage_url_to_row_id(f"{LITELLM_DB_STORAGE_URL_PREFIX}abc-123") == "abc-123" + + +def test_storage_url_to_row_id_rejects_foreign_urls(): + with pytest.raises(ValueError, match="s3://bucket/key"): + storage_url_to_row_id("s3://bucket/key") diff --git a/tests/test_litellm/llms/base_llm/files/test_storage_backend_factory.py b/tests/test_litellm/llms/base_llm/files/test_storage_backend_factory.py new file mode 100644 index 00000000000..945691c5b98 --- /dev/null +++ b/tests/test_litellm/llms/base_llm/files/test_storage_backend_factory.py @@ -0,0 +1,34 @@ +from types import SimpleNamespace +from unittest.mock import AsyncMock, MagicMock + +import pytest + +from litellm.llms.base_llm.files.litellm_db_storage_backend import ( + LITELLM_DB_STORAGE_BACKEND_NAME, + LITELLM_DB_STORAGE_URL_PREFIX, + LiteLLMDbStorageBackend, +) +from litellm.llms.base_llm.files.storage_backend_factory import get_storage_backend + + +@pytest.mark.asyncio +async def test_litellm_db_backend_stores_through_the_given_prisma_client(): + table = MagicMock(create=AsyncMock(return_value=SimpleNamespace(id="row-1"))) + prisma_client = MagicMock(db=MagicMock(litellm_managedfilecontenttable=table)) + + backend = get_storage_backend(LITELLM_DB_STORAGE_BACKEND_NAME, prisma_client=prisma_client) + + assert isinstance(backend, LiteLLMDbStorageBackend) + stored_at = await backend.upload_file(file_content=b"line\n", filename="input.jsonl", content_type="text/plain") + assert stored_at == f"{LITELLM_DB_STORAGE_URL_PREFIX}row-1" + table.create.assert_awaited_once() + + +def test_litellm_db_backend_without_a_database_is_rejected(): + with pytest.raises(ValueError, match="database-connected proxy"): + get_storage_backend(LITELLM_DB_STORAGE_BACKEND_NAME) + + +def test_unknown_backend_is_still_rejected(): + with pytest.raises(ValueError, match="Unsupported storage backend type: nope"): + get_storage_backend("nope", prisma_client=MagicMock()) diff --git a/tests/test_litellm/llms/custom_httpx/test_llm_http_handler.py b/tests/test_litellm/llms/custom_httpx/test_llm_http_handler.py index fff1372f271..420adc9338e 100644 --- a/tests/test_litellm/llms/custom_httpx/test_llm_http_handler.py +++ b/tests/test_litellm/llms/custom_httpx/test_llm_http_handler.py @@ -1552,7 +1552,7 @@ async def test_anthropic_post_uses_prebuilt_body_without_redumping(): provider_config = Mock() provider_config.max_retry_on_anthropic_messages_http_error = 2 - logging_obj = Mock() + logging_obj: Final = Mock(baseline_cache_context=None) logging_obj.model_call_details = {} out = await handler._async_post_anthropic_messages_with_http_error_retry( @@ -1592,7 +1592,7 @@ async def test_anthropic_post_falls_back_to_json_dumps_when_unsigned_none(): provider_config = Mock() provider_config.max_retry_on_anthropic_messages_http_error = 1 - logging_obj = Mock() + logging_obj: Final = Mock(baseline_cache_context=None) logging_obj.model_call_details = {} await handler._async_post_anthropic_messages_with_http_error_retry( @@ -1640,7 +1640,7 @@ async def test_anthropic_post_retry_reserializes_mutated_body(): # Re-sign returns no signed body (native anthropic path) -> must re-dump. provider_config.sign_request = Mock(return_value=({}, None)) - logging_obj = Mock() + logging_obj: Final = Mock(baseline_cache_context=None) logging_obj.model_call_details = {} await handler._async_post_anthropic_messages_with_http_error_retry( @@ -2579,7 +2579,7 @@ async def test_anthropic_invalid_thinking_signature_retry_resigns_bedrock_reques posts.append({"headers": dict(headers), "data": data}) return invalid_signature_response if len(posts) == 1 else ok_response - logging_obj = Mock() + logging_obj: Final = Mock(baseline_cache_context=None) logging_obj.model_call_details = {} response = await handler._async_post_anthropic_messages_with_http_error_retry( diff --git a/tests/test_litellm/models/test_models.py b/tests/test_litellm/models/test_models.py index 7774f6b543d..777b4a265ac 100644 --- a/tests/test_litellm/models/test_models.py +++ b/tests/test_litellm/models/test_models.py @@ -629,7 +629,7 @@ class TestManagedTables: class TestAutoRouterSession: @staticmethod - def _row(baseline_models: dict) -> LiteLLM_AutoRouterSession: + def _row(estimated_baseline_models: dict[str, int]) -> LiteLLM_AutoRouterSession: return LiteLLM_AutoRouterSession( api_key="k", session_id="s", @@ -643,7 +643,9 @@ class TestAutoRouterSession: saved_spend=0.24, classifier_cost=0.0, tier_turns={}, - baseline_models=baseline_models, + baseline_models={"legacy-baseline": 100}, + savings_estimated_turns=sum(estimated_baseline_models.values()), + savings_estimated_baseline_models=estimated_baseline_models, ) def test_the_baseline_label_is_the_one_most_turns_were_priced_against(self): @@ -655,5 +657,5 @@ class TestAutoRouterSession: assert self._row({"b-model": 1, "a-model": 1}).baseline_model == "b-model" assert self._row({"a-model": 1, "b-model": 1}).baseline_model == "b-model" - def test_a_row_whose_turns_recorded_no_baseline_has_no_label(self): + def test_a_row_without_current_estimates_has_no_baseline_label(self) -> None: assert self._row({}).baseline_model is None diff --git a/tests/test_litellm/proxy/_experimental/mcp_server/auth/test_user_api_key_auth_mcp.py b/tests/test_litellm/proxy/_experimental/mcp_server/auth/test_user_api_key_auth_mcp.py index 90ce821d62e..4380df194ed 100644 --- a/tests/test_litellm/proxy/_experimental/mcp_server/auth/test_user_api_key_auth_mcp.py +++ b/tests/test_litellm/proxy/_experimental/mcp_server/auth/test_user_api_key_auth_mcp.py @@ -5739,9 +5739,15 @@ class TestMCPDcrBridgeDelegateAdmission: prisma and are swallowed (``_safe_fetch`` / the SCIM gate's fail-open), so their checks skip. Yields the ``get_key_object`` mock so callers can assert the sealed ``key_hash`` was the reload key.""" + from litellm.proxy.auth.auth_checks import OrganizationNotFoundError + get_key_object = AsyncMock(return_value=return_value, side_effect=side_effect) + get_org_object = AsyncMock(side_effect=OrganizationNotFoundError("Organization doesn't exist in db.")) patchers = [ patch("litellm.proxy.auth.auth_checks.get_key_object", get_key_object), + patch( # test-quality-ok: central auth now resolves org limits; this fixture models a missing org row + "litellm.proxy.auth.auth_checks.get_org_object", get_org_object + ), patch("litellm.proxy.proxy_server.prisma_client", MagicMock()), patch("litellm.proxy.proxy_server.user_api_key_cache", MagicMock()), ] diff --git a/tests/test_litellm/proxy/_experimental/mcp_server/test_discoverable_endpoints.py b/tests/test_litellm/proxy/_experimental/mcp_server/test_discoverable_endpoints.py index d7666f5e694..b0cda30dfe5 100644 --- a/tests/test_litellm/proxy/_experimental/mcp_server/test_discoverable_endpoints.py +++ b/tests/test_litellm/proxy/_experimental/mcp_server/test_discoverable_endpoints.py @@ -11974,9 +11974,13 @@ async def test_oauth_credential_write_keeps_virtual_key_permissions( from litellm.proxy._experimental.mcp_server import mcp_server_manager from litellm.proxy._experimental.mcp_server.bridge_token_flow import authorize_oauth_credential_request from litellm.proxy._types import UserAPIKeyAuth, hash_token - from litellm.proxy.auth.auth_checks import jwt_key_mapping_cache_key + from litellm.proxy.auth.auth_checks import OrganizationNotFoundError, jwt_key_mapping_cache_key handler, signing_key = jwt_oauth_identity + monkeypatch.setattr( + "litellm.proxy.auth.auth_checks.get_org_object", + AsyncMock(side_effect=OrganizationNotFoundError("Organization doesn't exist in db.")), + ) key: Final = "sk-oauth-permission-test" hashed: Final = hash_token(key) credential: Final = UserAPIKeyAuth( diff --git a/tests/test_litellm/proxy/auth/test_auth_checks.py b/tests/test_litellm/proxy/auth/test_auth_checks.py index 1ae986db23b..a0256e40b8c 100644 --- a/tests/test_litellm/proxy/auth/test_auth_checks.py +++ b/tests/test_litellm/proxy/auth/test_auth_checks.py @@ -6087,6 +6087,107 @@ async def test_organization_budget_check_carries_org_state_on_the_token(): assert token.org_budget_snapshot == OrgBudgetSnapshot(spend=12.5, max_budget=100.0) +@pytest.mark.parametrize("warmed_by_auth_prefetch", [False, True]) +@pytest.mark.asyncio +async def test_get_org_object_for_request_serves_last_known_org_through_db_outage(warmed_by_auth_prefetch): + """A JWT whose team sits in an org resolves the org on every request, and the org row + is cached for only DEFAULT_IN_MEMORY_TTL seconds while the team and user rows ride the + 60s management-object TTL. Without a last-known copy, a DB outage a few seconds old + turned that traffic into 503s while the same request through a virtual key kept + succeeding on its cached team. The copy must exist whoever filled the short-lived entry: + this lookup's own DB read, or the virtual-key auth prefetch warming it for the same org.""" + from litellm.proxy._types import LiteLLM_OrganizationTable + from litellm.proxy.auth.auth_checks import get_org_object_for_request + + org_columns = { + "organization_id": "org-1", + "organization_alias": "platform-org", + "budget_id": "b1", + "created_by": "admin", + "updated_by": "admin", + "litellm_budget_table": {"budget_id": "b1", "max_budget": 50.0, "tpm_limit": 700, "rpm_limit": 7}, + } + org_row = MagicMock() + org_row.model_dump = lambda: org_columns + db_outage = ConnectionRefusedError("db unavailable") + prisma_client = MagicMock() + prisma_client.db.litellm_organizationtable.find_unique = AsyncMock( + side_effect=[db_outage] if warmed_by_auth_prefetch else [org_row, db_outage] + ) + user_api_key_cache = UserApiKeyCache() + if warmed_by_auth_prefetch: + await user_api_key_cache.async_set_cache( + key="org_id:org-1:with_budget", + value=LiteLLM_OrganizationTable.model_validate(org_columns), + model_type=LiteLLM_OrganizationTable, + ) + + async def _lookup(): + return await get_org_object_for_request( + org_id="org-1", + prisma_client=prisma_client, + user_api_key_cache=user_api_key_cache, + parent_otel_span=None, + proxy_logging_obj=None, + ) + + with patch("litellm.proxy.proxy_server.general_settings", {}): # test-quality-ok: the outage fallback reads this module global; no dependency injection seam exists + warm = await _lookup() + assert warm is not None and warm.organization_alias == "platform-org" + await user_api_key_cache.async_delete_cache("org_id:org-1:with_budget") + + during_outage = await _lookup() + + assert prisma_client.db.litellm_organizationtable.find_unique.await_count == (1 if warmed_by_auth_prefetch else 2) + assert during_outage is not None + assert during_outage.organization_alias == "platform-org" + assert during_outage.litellm_budget_table is not None + assert during_outage.litellm_budget_table.rpm_limit == 7 + assert during_outage.litellm_budget_table.max_budget == 50.0 + + +@pytest.mark.asyncio +async def test_get_org_object_for_request_writes_the_last_known_org_only_when_absent(): + """The last-known copy is written when this worker holds none, never per request: + with Redis attached, a write on every cached org hit would cost one SET per JWT request.""" + from litellm.proxy._types import LiteLLM_OrganizationTable + from litellm.proxy.auth.auth_checks import get_org_object_for_request + + class _WriteRecordingCache(UserApiKeyCache): + def __init__(self): + super().__init__() + self.written_keys = [] + + async def async_set_cache(self, key, value, local_only=False, **kwargs): + self.written_keys.append(key) + return await super().async_set_cache(key=key, value=value, local_only=local_only, **kwargs) + + user_api_key_cache = _WriteRecordingCache() + await user_api_key_cache.async_set_cache( + key="org_id:org-1:with_budget", + value=LiteLLM_OrganizationTable( + organization_id="org-1", + organization_alias="platform-org", + budget_id="b1", + created_by="admin", + updated_by="admin", + ), + model_type=LiteLLM_OrganizationTable, + ) + + for _ in range(3): + org = await get_org_object_for_request( + org_id="org-1", + prisma_client=MagicMock(), + user_api_key_cache=user_api_key_cache, + parent_otel_span=None, + proxy_logging_obj=None, + ) + assert org is not None and org.organization_alias == "platform-org" + + assert user_api_key_cache.written_keys.count("org_id:org-1:with_budget:last_known") == 1 + + @pytest.mark.parametrize( "max_budget, spend, expect_blocked", [ @@ -7572,7 +7673,7 @@ async def test_project_allowlist_enforced_when_key_models_empty(): assert exc_info.value.code == "403" -def _project_with_budget(spend: float, max_budget: float): +def _project_with_budget(spend: float, max_budget: float | None): from litellm.proxy._types import LiteLLM_BudgetTable, LiteLLM_ProjectTableCachedObj return LiteLLM_ProjectTableCachedObj( @@ -7592,11 +7693,12 @@ def _project_with_budget(spend: float, max_budget: float): pytest.param(4.99, 0.0, 5.0, False, id="counter-under-budget-admits"), pytest.param(None, 5.0, 5.0, True, id="no-counter-falls-back-to-persisted-spend"), pytest.param(None, 0.0, 5.0, False, id="no-counter-and-no-persisted-spend-admits"), - pytest.param(12.5, 12.5, 0.0, False, id="zero-budget-is-unbudgeted"), - pytest.param(12.5, 12.5, -1.0, False, id="negative-budget-is-unbudgeted"), + pytest.param(None, 0.0, 0.0, True, id="zero-budget-blocks-before-any-spend"), + pytest.param(12.5, 12.5, 0.0, True, id="zero-budget-blocks-with-spend"), + pytest.param(12.5, 12.5, None, False, id="null-budget-is-unlimited"), ], ) -async def test_project_max_budget_check_blocks_only_when_live_spend_reaches_a_positive_budget( +async def test_project_max_budget_check_blocks_when_live_spend_reaches_the_budget( counter_spend, db_spend, max_budget, blocks ): from litellm.caching.dual_cache import DualCache @@ -7631,7 +7733,7 @@ async def test_project_max_budget_check_blocks_only_when_live_spend_reaches_a_po assert exc_info.value.entity_type == Litellm_EntityType.PROJECT.value assert exc_info.value.entity_id == "p-budget" - assert exc_info.value.current_cost == 5.0 + assert exc_info.value.current_cost == (db_spend if counter_spend is None else counter_spend) proxy_logging_obj.budget_alerts.assert_awaited_once() assert proxy_logging_obj.budget_alerts.await_args.kwargs["type"] == "project_budget" diff --git a/tests/test_litellm/proxy/auth/test_user_api_key_auth.py b/tests/test_litellm/proxy/auth/test_user_api_key_auth.py index e6975edd4cb..8593be751fa 100644 --- a/tests/test_litellm/proxy/auth/test_user_api_key_auth.py +++ b/tests/test_litellm/proxy/auth/test_user_api_key_auth.py @@ -25,6 +25,7 @@ from litellm.proxy._types import ( LiteLLM_JWTAuth, LiteLLM_BudgetTable, LiteLLM_EndUserTable, + LiteLLM_OrganizationTable, LiteLLM_TeamTableCachedObj, LiteLLM_UserTable, LitellmUserRoles, @@ -35,6 +36,7 @@ from litellm.proxy._types import ( ) from litellm.proxy.auth.handle_jwt import JWTHandler from litellm.proxy.auth.auth_checks import ( + OrganizationNotFoundError, TeamNotFoundError, UserNotFoundError, get_key_object, @@ -5986,6 +5988,152 @@ async def test_centralized_common_checks_backfills_org_id_from_team(key_org_id, setattr(_proxy_server_mod, k, v) +@pytest.mark.asyncio +@pytest.mark.parametrize( + "key_org_id,team_id,team_org_id,existing_alias,existing_rpm,lookup_mode,allow_db_unavailable,expect_lookup_error,expected_org_id,expected_alias,expected_limits", + [ + (None, "t1", "org-from-team", None, None, "success", False, False, "org-from-team", "acme-org", (12.5, 700, 7)), + ("org-jwt", None, None, None, None, "success", False, False, "org-jwt", "acme-org", (12.5, 700, 7)), + ("org-pinned", None, None, "preset", None, "success", False, False, "org-pinned", "preset", (None, None, None)), + ("org-view", None, None, None, 3, "success", False, False, "org-view", None, (None, None, 3)), + ("org-missing", None, None, None, None, "missing", False, False, "org-missing", None, (None, None, None)), + ("org-db-failure-allowed", None, None, None, None, "db_failure", True, False, "org-db-failure-allowed", None, (None, None, None)), + ("org-db-failure-denied", None, None, None, None, "db_failure", False, True, "org-db-failure-denied", None, (None, None, None)), + ("org-bad-row", None, None, None, None, "bad_row", False, False, "org-bad-row", None, (None, None, None)), + ("org-nobudget", None, None, None, None, "no_budget", False, False, "org-nobudget", "acme-org", (None, None, None)), + ], +) +async def test_centralized_common_checks_inherits_org_identity( + key_org_id: str | None, + team_id: str | None, + team_org_id: str | None, + existing_alias: str | None, + existing_rpm: int | None, + lookup_mode: str, + allow_db_unavailable: bool, + expect_lookup_error: bool, + expected_org_id: str | None, + expected_alias: str | None, + expected_limits: tuple[float | None, int | None, int | None], +) -> None: + import litellm.proxy.proxy_server as _proxy_server_mod + from fastapi import Request + from starlette.datastructures import URL + + from litellm.proxy._types import LiteLLM_TeamTableCachedObj + + token = UserAPIKeyAuth( + api_key="sk-test", + user_id="u", + team_id=team_id, + org_id=key_org_id, + organization_alias=existing_alias, + organization_rpm_limit=existing_rpm, + ) + request = Request(scope={"type": "http"}) + request._url = URL(url="/chat/completions") + + fetched_team = ( + LiteLLM_TeamTableCachedObj(team_id="t1", organization_id=team_org_id) if team_id is not None else None + ) + organization = LiteLLM_OrganizationTable( + organization_id=expected_org_id, + organization_alias="acme-org", + budget_id="budget-id", + metadata={"model_rpm_limit": {"gpt-4o": 2}}, + models=[], + created_by="test", + updated_by="test", + litellm_budget_table=( + None + if lookup_mode == "no_budget" + else LiteLLM_BudgetTable(budget_id="budget-id", max_budget=12.5, tpm_limit=700, rpm_limit=7) + ), + ) + + attrs = _proxy_attrs_for_centralized_checks(user_custom_auth=None) + attrs["prisma_client"] = MagicMock() + attrs["general_settings"] = {"allow_requests_on_db_unavailable": allow_db_unavailable} + originals = {a: getattr(_proxy_server_mod, a, None) for a in attrs} + try: + for k, v in attrs.items(): + setattr(_proxy_server_mod, k, v) + with ( + patch( # test-quality-ok: centralized auth calls this module helper directly; no dependency injection seam exists + "litellm.proxy.auth.user_api_key_auth.get_team_object", + new_callable=AsyncMock, + return_value=fetched_team, + ) as mock_get_team_object, + patch( # test-quality-ok: centralized auth calls this module helper directly; no dependency injection seam exists + "litellm.proxy.auth.auth_checks.get_org_object", + new_callable=AsyncMock, + return_value=organization, + ) as mock_get_org_object, + patch( # test-quality-ok: capture downstream token state without invoking unrelated common checks + "litellm.proxy.auth.user_api_key_auth.common_checks", + new_callable=AsyncMock, + ) as mock_checks, + ): + if lookup_mode == "missing": + mock_get_org_object.side_effect = OrganizationNotFoundError("x") + elif lookup_mode == "db_failure": + mock_get_org_object.side_effect = ConnectionRefusedError("db unavailable") + elif lookup_mode == "bad_row": + mock_get_org_object.side_effect = ValueError("row failed validation") + + if expect_lookup_error: + with pytest.raises(ConnectionRefusedError, match="db unavailable"): + await _run_centralized_common_checks( + user_api_key_auth_obj=token, + request=request, + request_data={"model": "gpt-4o"}, + route="/chat/completions", + ) + else: + await _run_centralized_common_checks( + user_api_key_auth_obj=token, + request=request, + request_data={"model": "gpt-4o"}, + route="/chat/completions", + ) + + assert token.org_id == expected_org_id + if expect_lookup_error: + mock_checks.assert_not_awaited() + assert token.organization_alias is None + assert token.organization_max_budget is None + assert token.organization_tpm_limit is None + assert token.organization_rpm_limit is None + return + + mock_checks.assert_awaited_once() + assert token.organization_alias == expected_alias + assert ( + token.organization_max_budget, + token.organization_tpm_limit, + token.organization_rpm_limit, + ) == expected_limits + checked_token = mock_checks.await_args.kwargs["valid_token"] + assert checked_token.org_id == expected_org_id + assert checked_token.organization_alias == expected_alias + if team_id is None: + mock_get_team_object.assert_not_awaited() + else: + mock_get_team_object.assert_awaited_once() + if existing_alias is not None or existing_rpm is not None: + mock_get_org_object.assert_not_awaited() + assert token.organization_metadata is None + else: + mock_get_org_object.assert_awaited_once() + assert mock_get_org_object.await_args.kwargs["org_id"] == expected_org_id + assert mock_get_org_object.await_args.kwargs["include_budget_table"] is True + if lookup_mode not in {"missing", "db_failure", "bad_row"}: + assert token.organization_metadata == {"model_rpm_limit": {"gpt-4o": 2}} + finally: + for k, v in originals.items(): + setattr(_proxy_server_mod, k, v) + + @pytest.mark.asyncio async def test_cli_session_token_org_backfilled_from_team(monkeypatch): """LIT-4688 root cause: CLI session tokens (from /sso/cli/poll) are minted diff --git a/tests/test_litellm/proxy/batches_endpoints/test_endpoints.py b/tests/test_litellm/proxy/batches_endpoints/test_endpoints.py index 1b3f3806d79..8571ff20e57 100644 --- a/tests/test_litellm/proxy/batches_endpoints/test_endpoints.py +++ b/tests/test_litellm/proxy/batches_endpoints/test_endpoints.py @@ -34,10 +34,13 @@ import json import logging from contextlib import ExitStack from dataclasses import dataclass +from datetime import datetime, timedelta, timezone from typing import Any, Dict, Optional from unittest.mock import AsyncMock, MagicMock, patch +import httpx import pytest +import respx from litellm_enterprise.proxy.hooks.managed_files import _PROXY_LiteLLMManagedFiles import litellm @@ -52,7 +55,7 @@ from litellm.proxy.utils import ProxyLogging from litellm.router import Router from litellm.types.llms.openai import BatchJobStatus from litellm.types.router import Deployment, LiteLLM_Params, ModelInfo -from litellm.types.utils import CredentialItem, LiteLLMBatch +from litellm.types.utils import CredentialItem, LiteLLMBatch, SpecialEnums from fastapi import Request, Response @@ -74,6 +77,12 @@ CREDS: Dict[str, Dict[str, str]] = { "api_base": "https://vertex.test", "model": "vertex_ai/gemini-2.0", }, + "my-vllm": { + "custom_llm_provider": "hosted_vllm", + "api_key": "sk-vllm", + "api_base": "http://vllm.test/v1", + "model": "hosted_vllm/qwen", + }, } # A real model-encoded file id: decodes to "azure/gpt-4o", strips to "file-original123". @@ -147,6 +156,7 @@ class Harness: router: MagicMock logging: MagicMock creds_resolver: MagicMock + upstream_files_route: respx.Route @property def router_acreate(self) -> AsyncMock: @@ -162,13 +172,14 @@ class Harness: return dict(self.router_acreate.call_args.kwargs) -def _creds_lookup(*, model_id: str) -> Dict[str, str]: - # KeyError on an unknown/hardcoded model_id - the bug cannot hide. - return dict(CREDS[model_id]) +def _creds_lookup(*, model_id: str, team_id: str | None = None) -> dict[str, str] | None: + # An unknown/hardcoded model_id resolves to None exactly like the real router, + # which the endpoint turns into a 400 and a missing dispatch - the bug cannot hide. + return dict(CREDS[model_id]) if model_id in CREDS else None @pytest.fixture -def harness(): +def harness(monkeypatch: pytest.MonkeyPatch): """Seam harness. Patches only true I/O boundaries; pure encode/decode/merge helpers run for real. Object mocks are spec'd so unknown method calls raise.""" body_holder: Dict[str, Any] = {} @@ -192,6 +203,7 @@ def harness(): provider_from_headers = MagicMock(return_value=None) is_known_model = MagicMock(return_value=False) litellm_acreate = AsyncMock(return_value=make_batch()) + monkeypatch.setattr(litellm, "disable_aiohttp_transport", True) with ExitStack() as stack: stack.enter_context(patch.object(endpoints, "_read_request_body", read_body)) @@ -213,6 +225,10 @@ def harness(): stack.enter_context(patch.object(endpoints, "is_known_model", is_known_model)) stack.enter_context(patch.object(litellm, "acreate_batch", litellm_acreate)) stack.enter_context(patch.object(litellm, "enable_loadbalancing_on_batch_endpoints", False)) + upstream = stack.enter_context(respx.mock(assert_all_called=False)) + upstream_files_route = upstream.get(f"{CREDS['my-vllm']['api_base']}/files").mock( + return_value=httpx.Response(404, json={"detail": "Not Found"}) + ) stack.enter_context(patch.object(proxy_server, "llm_router", router)) stack.enter_context(patch.object(proxy_server, "proxy_logging_obj", logging)) stack.enter_context(patch.object(proxy_server, "general_settings", {})) @@ -231,6 +247,7 @@ def harness(): router=router, logging=logging, creds_resolver=router.get_deployment_credentials_with_provider, + upstream_files_route=upstream_files_route, ) yield h @@ -255,6 +272,25 @@ async def call_create( ) +@pytest.fixture +def executed_runner(): + runner = MagicMock(spec=endpoints.LiteLLMExecutedBatchRunner) + runner.create = AsyncMock(return_value=make_batch(id="litellm-executed-batch")) + runner.cancel = AsyncMock(return_value=make_batch(id="litellm-executed-batch", status="cancelling")) + factory = MagicMock(return_value=runner) + with patch.object( # test-quality-ok: the route builds its runner from proxy_server globals; the factory is the only seam + endpoints, "_litellm_executed_batch_runner", factory + ): + yield runner, factory + + +def _managed_input_file_id(model: str) -> str: + unified = SpecialEnums.LITELLM_MANAGED_FILE_COMPLETE_STR.value.format( + "application/jsonl", "managed-id", model, "file-id", "file-model-id" + ) + return base64.urlsafe_b64encode(unified.encode()).decode().rstrip("=") + + # =========================================================================== # # SCENARIO 1 - input_file_id encoded with model. The full showcase: every # assertion type from the design lives here. @@ -766,6 +802,137 @@ async def test_create__unified_file_id_legacy_row_without_storage_url_dispatches assert harness.router_kwargs()["input_file_id"] == "litellm_proxy_unified_id" +# --------------------------------------------------------------------------- # +# LiteLLM-executed batches: a unified file targeting a provider whose API has +# no /v1/batches (hosted_vllm) runs inside LiteLLM instead of being forwarded. +# --------------------------------------------------------------------------- # + + +@pytest.mark.asyncio +async def test_create__unified_executed_provider_runs_inside_litellm(harness, executed_runner): + runner, factory = executed_runner + caller = UserAPIKeyAuth(api_key="sk-test", team_id="team-vllm") + input_file_id = _managed_input_file_id("my-vllm") + set_body( + harness, + { + "input_file_id": input_file_id, + "endpoint": "/v1/chat/completions", + "completion_window": "24h", + "litellm_metadata": {"tags": ["batch-tag"]}, + }, + ) + resp = await call_create(harness, user=caller) + + harness.router_acreate.assert_not_called() + harness.litellm_acreate.assert_not_called() + harness.creds_resolver.assert_called_once_with(model_id="my-vllm", team_id="team-vllm") + factory.assert_called_once_with(harness.router, harness.logging) + runner.create.assert_awaited_once() + create_kwargs = runner.create.call_args.kwargs + assert create_kwargs["unified_input_file_id"] == input_file_id + assert create_kwargs["model"] == "my-vllm" + assert create_kwargs["provider"] == "hosted_vllm" + assert create_kwargs["request_tags"] == ("batch-tag",) + assert create_kwargs["user_api_key_dict"] is caller + assert create_kwargs["create_request"]["model"] == "my-vllm" + assert resp.id == "litellm-executed-batch" + + +@pytest.mark.asyncio +async def test_create__unified_executed_provider_without_database_400(harness): + set_body( + harness, + { + "input_file_id": _managed_input_file_id("my-vllm"), + "endpoint": "/v1/chat/completions", + "completion_window": "24h", + }, + ) + with pytest.raises(ProxyException) as exc: + await call_create(harness) + + assert exc.value.code == "400" + assert "need a database" in exc.value.message + harness.router_acreate.assert_not_called() + harness.litellm_acreate.assert_not_called() + + +@pytest.mark.asyncio +async def test_create__unified_executed_provider_with_its_own_files_api_goes_to_the_provider(harness, executed_runner): + runner, factory = executed_runner + harness.upstream_files_route.mock(return_value=httpx.Response(200, json={"object": "list", "data": []})) + set_body( + harness, + { + "input_file_id": _managed_input_file_id("my-vllm"), + "endpoint": "/v1/chat/completions", + "completion_window": "24h", + }, + ) + await call_create(harness) + + factory.assert_not_called() + runner.create.assert_not_called() + assert harness.router_kwargs()["model"] == "my-vllm" + + +@pytest.mark.asyncio +async def test_create__unified_provider_model_never_touches_executed_runner(harness, executed_runner): + runner, factory = executed_runner + set_body( + harness, + { + "input_file_id": _managed_input_file_id("azure/gpt-4o"), + "endpoint": "/v1/chat/completions", + "completion_window": "24h", + }, + ) + await call_create(harness) + + factory.assert_not_called() + runner.create.assert_not_called() + harness.creds_resolver.assert_called_once_with(model_id="azure/gpt-4o", team_id=None) + assert harness.router_kwargs()["model"] == "azure/gpt-4o" + + +@pytest.mark.asyncio +@pytest.mark.parametrize("via", ["body", "header"]) +async def test_create__raw_file_with_executed_model_400_with_upload_guidance(harness, via): + body = {"input_file_id": "file-plain", "endpoint": "/v1/chat/completions", "completion_window": "24h"} + set_body(harness, {**body, "model": "my-vllm"} if via == "body" else body) + headers = {"x-litellm-model": "my-vllm"} if via == "header" else None + + with pytest.raises(ProxyException) as exc: + await call_create(harness, headers=headers) + + assert exc.value.code == "400" + assert "POST /v1/files" in exc.value.message + assert "x-litellm-model" in exc.value.message + harness.litellm_acreate.assert_not_called() + harness.router_acreate.assert_not_called() + + +@pytest.mark.asyncio +@pytest.mark.parametrize( + "upstream_answer", + [httpx.Response(200, json={"object": "list", "data": []}), httpx.Response(405), httpx.ConnectError("refused")], + ids=["lists files", "files route without list", "unreachable"], +) +async def test_create__raw_file_with_executed_model_is_forwarded_unless_the_server_lacks_a_files_api( + harness, upstream_answer +): + harness.upstream_files_route.mock(side_effect=[upstream_answer]) + set_body(harness, {"input_file_id": "file-plain", "endpoint": "/v1/chat/completions", "completion_window": "24h"}) + + await call_create(harness, headers={"x-litellm-model": "my-vllm"}) + + forwarded = harness.acreate_kwargs() + assert forwarded["input_file_id"] == "file-plain" + assert forwarded["custom_llm_provider"] == "hosted_vllm" + assert forwarded["api_base"] == CREDS["my-vllm"]["api_base"] + + @pytest.mark.asyncio async def test_create__model_encoded_beats_unified(harness): """Precedence row: a file id that is BOTH model-encoded and (pretend) unified @@ -1146,6 +1313,11 @@ AZURE_BATCH_ID = encode_file_id_with_model("batch_orig123", "azure/gpt-4o", id_t # returns). model_id / llm_batch_id are parsed out of this by the real helpers. UNIFIED_BATCH_ID = "litellm_proxy;model_id:gpt-4o-mini;llm_batch_id:batch-raw-xyz" +# A decoded unified id of a batch LiteLLM runs itself: the llm_batch_id carries +# the litellm_batch_ prefix, so no provider holds a batch to sync with. +EXECUTED_BATCH_ID = "litellm_proxy;model_id:my-vllm;llm_batch_id:litellm_batch_abc" +EXECUTED_BATCH_B64 = base64.urlsafe_b64encode(EXECUTED_BATCH_ID.encode()).decode().rstrip("=") + @dataclass class RetrieveHarness: @@ -1580,6 +1752,69 @@ async def test_retrieve__db_non_terminal_state_syncs_with_provider(retrieve_harn assert retrieve_harness.update_batch_in_db.call_count == 1 +@pytest.mark.asyncio +@pytest.mark.parametrize("status", ["validating", "in_progress", "finalizing", "cancelling"]) +async def test_retrieve__executed_batch_served_from_db_in_every_status(retrieve_harness, status): + db_response = make_batch(id="litellm-executed-batch", status=status) + db_batch_object = MagicMock() + db_batch_object.updated_at = datetime.now(timezone.utc) + retrieve_harness.get_batch_from_db.return_value = (db_batch_object, db_response) + + resp = await call_retrieve(retrieve_harness, EXECUTED_BATCH_B64) + + assert resp is db_response + retrieve_harness.litellm_aretrieve.assert_not_called() + retrieve_harness.router_aretrieve.assert_not_called() + retrieve_harness.update_batch_in_db.assert_not_called() + retrieve_harness.ensure_managed_files.assert_called_once() + assert retrieve_harness.ensure_managed_files.call_args.kwargs["unified_batch_id"] == EXECUTED_BATCH_ID + + +@pytest.mark.asyncio +async def test_retrieve__executed_batch_abandoned_by_its_runner_is_served_failed(retrieve_harness, executed_runner): + runner, _ = executed_runner + failed = make_batch(id="litellm-executed-batch", status="failed") + runner.fail_abandoned = AsyncMock(return_value=failed) + db_response = make_batch(id="litellm-executed-batch", status="in_progress") + db_batch_object = MagicMock() + db_batch_object.updated_at = datetime.now(timezone.utc) - timedelta(minutes=10) + retrieve_harness.get_batch_from_db.return_value = (db_batch_object, db_response) + user = UserAPIKeyAuth(api_key="sk-test", user_id="user-1") + + resp = await call_retrieve(retrieve_harness, EXECUTED_BATCH_B64, user=user) + + assert resp is failed + runner.fail_abandoned.assert_awaited_once_with(db_response, user) + retrieve_harness.litellm_aretrieve.assert_not_called() + retrieve_harness.router_aretrieve.assert_not_called() + retrieve_harness.ensure_managed_files.assert_called_once() + + +@pytest.mark.asyncio +async def test_retrieve__executed_batch_with_a_fresh_heartbeat_is_left_running(retrieve_harness, executed_runner): + runner, _ = executed_runner + runner.fail_abandoned = AsyncMock() + db_response = make_batch(id="litellm-executed-batch", status="in_progress") + db_batch_object = MagicMock() + db_batch_object.updated_at = datetime.now(timezone.utc) - timedelta(seconds=30) + retrieve_harness.get_batch_from_db.return_value = (db_batch_object, db_response) + + resp = await call_retrieve(retrieve_harness, EXECUTED_BATCH_B64) + + assert resp is db_response + runner.fail_abandoned.assert_not_awaited() + + +@pytest.mark.asyncio +async def test_retrieve__executed_batch_without_db_row_404(retrieve_harness): + with pytest.raises(ProxyException) as exc: + await call_retrieve(retrieve_harness, EXECUTED_BATCH_B64) + + assert exc.value.code == "404" + retrieve_harness.litellm_aretrieve.assert_not_called() + retrieve_harness.router_aretrieve.assert_not_called() + + # --------------------------------------------------------------------------- # # Cross-cutting: enrichment route_type and failure-hook on provider error. # --------------------------------------------------------------------------- # @@ -2299,6 +2534,35 @@ async def test_cancel__unified_no_router_500(cancel_harness): assert exc.value.code == "500" +@pytest.mark.asyncio +async def test_cancel__executed_batch_routes_to_runner(cancel_harness, executed_runner): + runner, factory = executed_runner + caller = UserAPIKeyAuth(api_key="sk-test", user_id="user-cancel-2") + resp = await call_cancel(cancel_harness, EXECUTED_BATCH_B64, user=caller) + + runner.cancel.assert_awaited_once_with(EXECUTED_BATCH_B64, caller) + factory.assert_called_once_with(cancel_harness.router, cancel_harness.logging) + cancel_harness.router_acancel.assert_not_called() + cancel_harness.litellm_acancel.assert_not_called() + cancel_harness.creds_resolver.assert_not_called() + assert resp is runner.cancel.return_value + assert cancel_harness.update_batch_in_db.call_args.kwargs["operation"] == "cancel" + + +@pytest.mark.asyncio +async def test_cancel__executed_batch_no_router_500(cancel_harness, executed_runner): + runner, factory = executed_runner + with patch.object( # test-quality-ok: proxy_server module global is the endpoint's only injection point + proxy_server, "llm_router", None + ): + with pytest.raises(ProxyException) as exc: + await call_cancel(cancel_harness, EXECUTED_BATCH_B64) + + assert exc.value.code == "500" + factory.assert_not_called() + runner.cancel.assert_not_called() + + # --------------------------------------------------------------------------- # # SCENARIO 3 - fallback to custom_llm_provider. Rebuilds a CancelBatchRequest # and forwards only {custom_llm_provider, batch_id}. @@ -2956,3 +3220,16 @@ async def test_cancel__unified_batch_id_rejects_key_without_model_grant(cancel_h assert exc_info.value.code == "403" cancel_harness.router_acancel.assert_not_called() + + +@pytest.mark.asyncio +async def test_cancel__executed_batch_rejects_key_without_model_grant(cancel_harness, executed_runner): + runner, factory = executed_runner + + with pytest.raises(ProxyException) as exc_info: + await call_cancel(cancel_harness, EXECUTED_BATCH_B64, user=_key_restricted_to("vertex-model")) + + assert exc_info.value.code == "403" + factory.assert_not_called() + runner.cancel.assert_not_called() + cancel_harness.router_acancel.assert_not_called() diff --git a/tests/test_litellm/proxy/batches_endpoints/test_litellm_executed_batches.py b/tests/test_litellm/proxy/batches_endpoints/test_litellm_executed_batches.py new file mode 100644 index 00000000000..6f2341a578c --- /dev/null +++ b/tests/test_litellm/proxy/batches_endpoints/test_litellm_executed_batches.py @@ -0,0 +1,1130 @@ +import asyncio +import json +from collections.abc import Callable, Mapping, Sequence +from dataclasses import dataclass +from datetime import datetime, timedelta, timezone +from types import MappingProxyType +from typing import Final, Literal, cast +from unittest.mock import AsyncMock, MagicMock + +import httpx +import pytest +from litellm_enterprise.proxy.hooks.managed_files import _PROXY_LiteLLMManagedFiles +from openai.types.batch_request_counts import BatchRequestCounts + +from litellm.models.managed_files import LiteLLM_ManagedFileTable +from litellm.proxy._types import ProxyException, UserAPIKeyAuth +from litellm.proxy.batches_endpoints import litellm_executed_batches +from litellm.proxy.batches_endpoints.litellm_executed_batches import ( + BatchEndpoint, + BatchInputLine, + BatchStatus, + InvalidBatchInput, + LiteLLMExecutedBatchRunner, + _resolve_transition, + executed_batch_runner_lost, + litellm_executed_provider_for, + litellm_executed_provider_of, + parse_batch_input, + resolve_litellm_executed_provider, + upstream_lacks_files_api, +) +from litellm.proxy.openai_files_endpoints.common_utils import ( + _is_base64_encoded_unified_file_id, + get_batch_id_from_unified_batch_id, + is_litellm_executed_batch, +) +from litellm.proxy.utils import PrismaClient, ProxyLogging +from litellm.repositories.managed_batch_repository import ManagedBatchRepository +from litellm.router import Router +from litellm.types.llms.openai import LiteLLMBatchCreateRequest, OpenAIFileObject, OpenAIFilesPurpose +from litellm.types.utils import EmbeddingResponse, LiteLLMBatch, ModelResponse, SpecialEnums + +BATCH_MODEL: Final = "batch-model" +DEPLOYMENT_ID: Final = "deployment-id-1" +INPUT_FILE_ID: Final = "unified-input-file" +STORAGE_BACKEND: Final = "s3" +STORAGE_URL: Final = "s3://bucket/input.jsonl" +CHAT_ENDPOINT: Final = "/v1/chat/completions" +ROUTER_METHODS: Final = ("acompletion", "atext_completion", "aembedding", "aresponses") +ALL_STATUSES: Final[tuple[BatchStatus, ...]] = ( + "in_progress", + "finalizing", + "completed", + "failed", + "cancelling", + "cancelled", + "expired", +) + + +def chat_row(custom_id: str, content: str, **body_extra: object) -> dict[str, object]: + return { + "custom_id": custom_id, + "method": "POST", + "url": CHAT_ENDPOINT, + "body": {"model": "row-model", "messages": [{"role": "user", "content": content}], **body_extra}, + } + + +def jsonl(*rows: Mapping[str, object]) -> bytes: + return "".join(f"{json.dumps(row)}\n" for row in rows).encode() + + +TWO_CHAT_ROWS: Final = jsonl(chat_row("row-1", "hi 1"), chat_row("row-2", "hi 2")) + + +def chat_response(content: str) -> ModelResponse: + return ModelResponse( + id=f"chatcmpl-{content}", + model=BATCH_MODEL, + choices=[{"index": 0, "message": {"role": "assistant", "content": f"echo {content}"}, "finish_reason": "stop"}], + ) + + +def managed_input_file(storage_backend: str | None = STORAGE_BACKEND) -> LiteLLM_ManagedFileTable: + return LiteLLM_ManagedFileTable( + unified_file_id=INPUT_FILE_ID, + model_mappings={}, + flat_model_file_ids=[], + storage_backend=storage_backend, + storage_url=STORAGE_URL, + ) + + +def batch_request(endpoint: str) -> LiteLLMBatchCreateRequest: + return cast( + "LiteLLMBatchCreateRequest", + {"endpoint": endpoint, "input_file_id": INPUT_FILE_ID, "completion_window": "24h"}, + ) + + +class ProviderRateLimited(Exception): + status_code = 429 + + +@dataclass(frozen=True, slots=True) +class StoredObject: + file_object: str + status: str + updated_at: datetime + + def batch(self) -> LiteLLMBatch: + return LiteLLMBatch.model_validate_json(self.file_object) + + +@dataclass(frozen=True, slots=True) +class StoreCall: + unified_object_id: str + model_object_id: str + status: str + request_tags: tuple[str, ...] | None + persist_attribution: bool + batch_processed: bool + + +@dataclass(frozen=True, slots=True) +class StatusWrite: + unified_object_id: str + status: str + columns: frozenset[str] + + +STATUS_WRITE_COLUMNS: Final = frozenset({"file_object", "status", "updated_by"}) +STALE: Final = timedelta(seconds=litellm_executed_batches._STALE_AFTER_SECONDS + 20) + + +class FakeManagedBatchStore: + def __init__(self, files: Mapping[str, LiteLLM_ManagedFileTable]) -> None: + self.files = files + self.objects: dict[str, StoredObject] = {} + self.calls: list[StoreCall] = [] + + def get_unified_batch_id(self, batch_id: str, model_id: str) -> str: + return SpecialEnums.LITELLM_MANAGED_BATCH_COMPLETE_STR.value.format(model_id, batch_id) + + async def get_unified_file_id( + self, file_id: str, litellm_parent_otel_span: object | None = None + ) -> LiteLLM_ManagedFileTable | None: + return self.files.get(file_id) + + async def store_unified_object_id( + self, + unified_object_id: str, + file_object: LiteLLMBatch, + litellm_parent_otel_span: object | None, + model_object_id: str, + file_purpose: Literal["batch", "fine-tune", "response"], + user_api_key_dict: UserAPIKeyAuth, + request_tags: Sequence[str] | None = None, + persist_attribution: bool = False, + batch_processed: bool = False, + ) -> None: + self.calls.append( + StoreCall( + unified_object_id=unified_object_id, + model_object_id=model_object_id, + status=file_object.status, + request_tags=tuple(request_tags) if request_tags is not None else None, + persist_attribution=persist_attribution, + batch_processed=batch_processed, + ) + ) + self.write(file_object) + + def write(self, batch: LiteLLMBatch, age: timedelta = timedelta(0)) -> None: + self.objects[batch.id] = StoredObject( + file_object=batch.model_dump_json(), status=batch.status, updated_at=datetime.now(timezone.utc) - age + ) + + def batch(self, unified_batch_id: str) -> LiteLLMBatch: + return self.objects[unified_batch_id].batch() + + +REAL_HOOK: Final = _PROXY_LiteLLMManagedFiles(internal_usage_cache=MagicMock(), prisma_client=MagicMock()) + + +class RealIdManagedBatchStore(FakeManagedBatchStore): + def get_unified_batch_id(self, batch_id: str, model_id: str) -> str: + return REAL_HOOK.get_unified_batch_id(batch_id=batch_id, model_id=model_id) + + +def row_matches(row: StoredObject, where: Mapping[str, object]) -> bool: + if "status" in where and row.status != where["status"]: + return False + match where.get("updated_at"): + case {"lt": datetime() as before}: + return row.updated_at < before + case _: + return True + + +class FakeManagedObjectTable: + def __init__(self, objects: dict[str, StoredObject]) -> None: + self.objects = objects + self.touches: list[tuple[str, str | None]] = [] + self.writes: list[StatusWrite] = [] + self.after_read: Callable[[StoredObject | None], None] | None = None + + async def find_first(self, where: Mapping[str, str]) -> StoredObject | None: + row = self.objects.get(where["unified_object_id"]) + if self.after_read is not None: + self.after_read(row) + return row + + async def update_many(self, where: Mapping[str, object], data: Mapping[str, str | None]) -> int: + unified_object_id = str(where["unified_object_id"]) + row = self.objects.get(unified_object_id) + if row is None or not row_matches(row, where): + return 0 + now = datetime.now(timezone.utc) + if "status" not in data: + self.touches.append((unified_object_id, data["updated_by"])) + self.objects[unified_object_id] = StoredObject(row.file_object, row.status, now) + return 1 + self.writes.append(StatusWrite(unified_object_id, str(data["status"]), frozenset(data))) + self.objects[unified_object_id] = StoredObject(str(data["file_object"]), str(data["status"]), now) + return 1 + + +class FakeDb: + def __init__(self, objects: dict[str, StoredObject]) -> None: + self.litellm_managedobjecttable = FakeManagedObjectTable(objects) + + +class FakePrismaClient: + def __init__(self, objects: dict[str, StoredObject]) -> None: + self.db = FakeDb(objects) + + +class FakeRouter: + def __init__(self) -> None: + self.acompletion = AsyncMock(return_value=chat_response("default")) + self.atext_completion = AsyncMock(return_value=chat_response("default")) + self.aembedding = AsyncMock( + return_value=EmbeddingResponse( + model=BATCH_MODEL, data=[{"embedding": [0.1], "index": 0, "object": "embedding"}] + ) + ) + self.aresponses = AsyncMock(return_value=chat_response("default")) + + def get_model_ids(self, model_name: str) -> list[str]: + return [DEPLOYMENT_ID] if model_name == BATCH_MODEL else [] + + def get_model_group_info(self, model_group: str) -> None: + return None + + +class FakeStorageBackend: + def __init__(self, contents: Mapping[str, bytes]) -> None: + self.contents = contents + self.downloads: list[str] = [] + + async def download_file(self, storage_url: str) -> bytes: + self.downloads.append(storage_url) + return self.contents[storage_url] + + +class FakeStorageBackendFactory: + def __init__(self, backend: FakeStorageBackend, error: ValueError | None) -> None: + self.backend = backend + self.error = error + self.calls: list[tuple[str, object]] = [] + + def __call__(self, backend_type: str, prisma_client: object = None) -> FakeStorageBackend: + self.calls.append((backend_type, prisma_client)) + if self.error is not None: + raise self.error + return self.backend + + +@dataclass(frozen=True, slots=True) +class UploadCall: + content: bytes + filename: str + target_storage: str + target_model_names: tuple[str, ...] + purpose: str + user_api_key_dict: UserAPIKeyAuth + prisma_client: object + + def lines(self) -> dict[str, dict[str, object]]: + parsed = tuple(json.loads(line) for line in self.content.decode().splitlines()) + return {str(line["custom_id"]): line for line in parsed} + + +class FakeResultFileUploader: + def __init__(self, error: Exception | None) -> None: + self.error = error + self.calls: list[UploadCall] = [] + + async def __call__( + self, + file_data: Mapping[str, object], + target_storage: str, + target_model_names: list[str], + purpose: OpenAIFilesPurpose, + proxy_logging_obj: ProxyLogging, + user_api_key_dict: UserAPIKeyAuth, + prisma_client: object = None, + ) -> OpenAIFileObject: + content = file_data["content"] + assert isinstance(content, bytes) + self.calls.append( + UploadCall( + content=content, + filename=str(file_data["filename"]), + target_storage=target_storage, + target_model_names=tuple(target_model_names), + purpose=purpose, + user_api_key_dict=user_api_key_dict, + prisma_client=prisma_client, + ) + ) + if self.error is not None: + raise self.error + return OpenAIFileObject( + id=f"unified-output-{len(self.calls)}", + object="file", + bytes=len(content), + created_at=0, + filename=str(file_data["filename"]), + purpose=purpose, + status="uploaded", + ) + + +@dataclass(frozen=True, slots=True) +class Harness: + runner: LiteLLMExecutedBatchRunner + store: FakeManagedBatchStore + router: FakeRouter + uploads: FakeResultFileUploader + storage: FakeStorageBackend + storage_factory: FakeStorageBackendFactory + prisma: FakePrismaClient + user: UserAPIKeyAuth + + async def create(self, endpoint: str = CHAT_ENDPOINT) -> LiteLLMBatch: + return await self.runner.create( + create_request=batch_request(endpoint), + unified_input_file_id=INPUT_FILE_ID, + model=BATCH_MODEL, + provider="hosted_vllm", + user_api_key_dict=self.user, + request_tags=["tag-a"], + ) + + async def create_and_finish(self, endpoint: str = CHAT_ENDPOINT) -> tuple[LiteLLMBatch, LiteLLMBatch]: + created = await self.create(endpoint) + await asyncio.gather(*list(litellm_executed_batches._RUNNING_BATCHES)) + return created, self.store.batch(created.id) + + @property + def table(self) -> FakeManagedObjectTable: + return self.prisma.db.litellm_managedobjecttable + + def written_statuses(self) -> list[str]: + return [write.status for write in self.table.writes] + + +def make_runner( + content: bytes = TWO_CHAT_ROWS, + concurrency: int = 4, + files: Mapping[str, LiteLLM_ManagedFileTable] | None = None, + upload_error: Exception | None = None, + storage_error: ValueError | None = None, + store_factory: Callable[[Mapping[str, LiteLLM_ManagedFileTable]], FakeManagedBatchStore] = FakeManagedBatchStore, + general_settings: Mapping[str, object] = MappingProxyType({}), + heartbeat_seconds: float = 30.0, + completion_window_seconds: float = 24 * 60 * 60, +) -> Harness: + store = store_factory({INPUT_FILE_ID: managed_input_file()} if files is None else files) + router = FakeRouter() + uploads = FakeResultFileUploader(upload_error) + storage = FakeStorageBackend({STORAGE_URL: content}) + storage_factory = FakeStorageBackendFactory(storage, storage_error) + prisma = FakePrismaClient(store.objects) + user = UserAPIKeyAuth( + api_key="sk-batch-key", user_id="user-1", team_id="team-1", key_alias="alias-1", user_email="user@example.com" + ) + runner = LiteLLMExecutedBatchRunner( + llm_router=cast("Router", router), + prisma_client=cast("PrismaClient", prisma), + managed_files=store, + batches=ManagedBatchRepository(prisma), + proxy_logging_obj=MagicMock(spec=ProxyLogging), + general_settings=general_settings, + concurrency=concurrency, + heartbeat_seconds=heartbeat_seconds, + completion_window_seconds=completion_window_seconds, + storage_backend_factory=storage_factory, + upload_result_file=uploads, + ) + return Harness(runner, store, router, uploads, storage, storage_factory, prisma, user) + + +def seeded_batch( + store: FakeManagedBatchStore, status: Literal["in_progress", "completed"], age: timedelta = timedelta(0) +) -> LiteLLMBatch: + batch = LiteLLMBatch( + id=store.get_unified_batch_id(batch_id="litellm_batch_seed", model_id=DEPLOYMENT_ID), + object="batch", + endpoint=CHAT_ENDPOINT, + input_file_id=INPUT_FILE_ID, + completion_window="24h", + status=status, + created_at=1, + model=BATCH_MODEL, + ) + store.write(batch, age) + return batch + + +@pytest.mark.parametrize( + ("content", "line_number", "reason_fragment"), + [ + (b"", None, "no requests"), + (b"\n \n", None, "no requests"), + (b"{not json", 1, "JSON"), + (jsonl({"custom_id": "a", "method": "POST", "url": CHAT_ENDPOINT}), 1, "body"), + (jsonl({**chat_row("a", "hi"), "extra_field": 1}), 1, "extra_field"), + ( + jsonl(chat_row("a", "hi")) + b"\n" + jsonl({**chat_row("b", "hi"), "url": "/v1/embeddings"}), + 3, + "/v1/embeddings", + ), + (jsonl(chat_row("a", "hi", stream=True)), 1, "streaming"), + (jsonl(chat_row("a", "hi"), chat_row("a", "again")), None, "'a'"), + ], + ids=["empty", "blank lines", "not json", "missing body", "unknown field", "url mismatch", "stream", "duplicate id"], +) +def test_parse_batch_input_rejects(content: bytes, line_number: int | None, reason_fragment: str) -> None: + result = parse_batch_input(content, CHAT_ENDPOINT) + assert isinstance(result, InvalidBatchInput) + assert result.line_number == line_number + assert reason_fragment in result.reason + + +def test_parse_batch_input_keeps_every_request_and_skips_blank_lines() -> None: + content = b"\n" + jsonl(chat_row("a", "hi 1")) + b"\n" + jsonl(chat_row("b", "hi 2")) + b"\n\n" + lines = parse_batch_input(content, CHAT_ENDPOINT) + assert isinstance(lines, tuple) + assert [line.custom_id for line in lines] == ["a", "b"] + assert lines[1] == BatchInputLine( + custom_id="b", + method="POST", + url=CHAT_ENDPOINT, + body={"model": "row-model", "messages": [{"role": "user", "content": "hi 2"}]}, + ) + + +@pytest.mark.parametrize("current", ["validating", "in_progress", "finalizing"]) +@pytest.mark.parametrize("requested", ALL_STATUSES) +def test_resolve_transition_keeps_the_requested_status_unless_cancelling(current: str, requested: BatchStatus) -> None: + assert _resolve_transition(current, requested) == requested + + +@pytest.mark.parametrize( + ("requested", "expected"), + [ + ("completed", "cancelled"), + ("expired", "cancelled"), + ("in_progress", "cancelling"), + ("finalizing", "cancelling"), + ("failed", "failed"), + ("cancelling", "cancelling"), + ("cancelled", "cancelled"), + ], +) +def test_resolve_transition_from_cancelling(requested: BatchStatus, expected: BatchStatus) -> None: + assert _resolve_transition("cancelling", requested) == expected + + +@pytest.mark.parametrize( + ("status", "age_seconds", "lost"), + [ + ("validating", 200, True), + ("in_progress", 200, True), + ("in_progress", 100, False), + ("finalizing", 200, True), + ("cancelling", 200, True), + ("completed", 200, False), + ("failed", 200, False), + ("cancelled", 200, False), + ("expired", 200, False), + ], +) +def test_executed_batch_runner_lost_only_for_a_stale_non_terminal_batch( + status: str, age_seconds: int, lost: bool +) -> None: + updated_at = datetime.now(timezone.utc) - timedelta(seconds=age_seconds) + assert executed_batch_runner_lost(status, updated_at) is lost + + +@pytest.mark.parametrize( + ("credentials", "expected"), + [ + ({"custom_llm_provider": "hosted_vllm", "model": "openai/gpt-4o"}, "hosted_vllm"), + ({"model": "hosted_vllm/qwen"}, "hosted_vllm"), + ({"custom_llm_provider": "openai", "model": "gpt-4o"}, None), + ({"model": "gpt-4o"}, None), + ], + ids=["explicit hosted_vllm", "model prefix", "explicit openai", "openai model"], +) +def test_litellm_executed_provider_of(credentials: Mapping[str, object], expected: str | None) -> None: + assert litellm_executed_provider_of(credentials) == expected + + +VLLM_CREDENTIALS: Final[Mapping[str, object]] = { + "model": "hosted_vllm/qwen", + "api_base": "http://vllm.test/v1/", + "api_key": "vllm-key", +} + + +@dataclass(slots=True) +class FakeFilesApiProbe: + lacks_files_api: bool + upstreams: list[tuple[str, str | None]] + + async def __call__(self, api_base: str, api_key: str | None) -> bool: + self.upstreams.append((api_base, api_key)) + return self.lacks_files_api + + +@dataclass(slots=True) +class FakeHttpGetter: + outcome: int | httpx.HTTPError + requests: list[tuple[str, dict[str, str] | None]] + + async def get( + self, url: str, *, headers: dict[str, str] | None = None, timeout: float | httpx.Timeout | None = None + ) -> httpx.Response: + self.requests.append((url, headers)) + if isinstance(self.outcome, httpx.HTTPError): + raise self.outcome + return httpx.Response(self.outcome) + + +@pytest.mark.parametrize( + ("outcome", "expected"), + [ + (404, True), + (200, False), + (405, False), + (401, False), + (500, False), + (httpx.ConnectError("refused"), False), + (httpx.ReadTimeout("slow"), False), + ], + ids=["no files route", "lists files", "files route without list", "unauthorized", "server error", "down", "slow"], +) +async def test_upstream_lacks_files_api_only_when_the_files_route_is_a_404( + outcome: int | httpx.HTTPError, expected: bool +) -> None: + assert await upstream_lacks_files_api("http://vllm.test/v1", "vllm-key", FakeHttpGetter(outcome, [])) is expected + + +@pytest.mark.parametrize( + ("api_base", "api_key", "expected_headers"), + [ + ("http://vllm.test/v1/", "vllm-key", {"Authorization": "Bearer vllm-key"}), + ("http://vllm.test/v1", None, None), + ], + ids=["trailing slash with key", "keyless"], +) +async def test_upstream_lacks_files_api_asks_the_files_route_under_the_api_base( + api_base: str, api_key: str | None, expected_headers: dict[str, str] | None +) -> None: + http_client = FakeHttpGetter(404, []) + await upstream_lacks_files_api(api_base, api_key, http_client) + assert http_client.requests == [("http://vllm.test/v1/files", expected_headers)] + + +@pytest.mark.parametrize( + ("lacks_files_api", "expected"), [(True, "hosted_vllm"), (False, None)], ids=["bare", "router"] +) +async def test_litellm_executed_provider_for_leaves_a_server_with_its_own_files_api_alone( + lacks_files_api: bool, expected: str | None +) -> None: + probe = FakeFilesApiProbe(lacks_files_api, []) + assert await litellm_executed_provider_for(VLLM_CREDENTIALS, probe) == expected + assert probe.upstreams == [("http://vllm.test/v1/", "vllm-key")] + + +@pytest.mark.parametrize( + "credentials", + [{"custom_llm_provider": "openai", "model": "gpt-4o", "api_base": "http://openai.test/v1"}, {"model": 7}], + ids=["provider runs its own batches", "no model to resolve an api_base from"], +) +async def test_litellm_executed_provider_for_never_probes_what_it_would_not_run( + credentials: Mapping[str, object], +) -> None: + probe = FakeFilesApiProbe(True, []) + assert await litellm_executed_provider_for(credentials, probe) is None + assert probe.upstreams == [] + + +@pytest.mark.parametrize( + ("credentials", "expected"), [(None, None), (VLLM_CREDENTIALS, "hosted_vllm")], ids=["unknown", "vllm"] +) +async def test_resolve_litellm_executed_provider_asks_the_router_for_the_team_scoped_deployment( + credentials: Mapping[str, object] | None, expected: str | None +) -> None: + router = MagicMock(spec=Router) + router.get_deployment_credentials_with_provider.return_value = credentials + assert ( + await resolve_litellm_executed_provider(router, BATCH_MODEL, "team-1", FakeFilesApiProbe(True, [])) == expected + ) + router.get_deployment_credentials_with_provider.assert_called_once_with(model_id=BATCH_MODEL, team_id="team-1") + + +async def test_create_stores_a_validating_batch_and_completes_it_in_the_background() -> None: + harness = make_runner() + created, finished = await harness.create_and_finish() + + assert created.status == "validating" + assert is_litellm_executed_batch(created.id) + assert created.id.startswith(f"litellm_proxy;model_id:{DEPLOYMENT_ID};llm_batch_id:litellm_batch_") + assert (created.model, created.input_file_id) == (BATCH_MODEL, INPUT_FILE_ID) + assert created.request_counts == BatchRequestCounts(completed=0, failed=0, total=2) + first_write = harness.store.calls[0] + assert (first_write.unified_object_id, first_write.model_object_id) == ( + created.id, + get_batch_id_from_unified_batch_id(created.id), + ) + assert (first_write.persist_attribution, first_write.batch_processed, first_write.request_tags) == ( + True, + True, + ("tag-a",), + ) + assert harness.storage_factory.calls == [(STORAGE_BACKEND, harness.prisma)] + assert harness.storage.downloads == [STORAGE_URL] + + assert finished.status == "completed" + assert finished.request_counts == BatchRequestCounts(completed=2, failed=0, total=2) + assert (finished.output_file_id, finished.error_file_id) == ("unified-output-1", None) + assert finished.in_progress_at is not None + assert finished.completed_at is not None + + +async def test_create_dispatches_each_row_with_the_batch_model_and_the_key_metadata() -> None: + harness = make_runner() + created, _ = await harness.create_and_finish() + + calls = {call.kwargs["messages"][0]["content"]: call.kwargs for call in harness.router.acompletion.await_args_list} + assert set(calls) == {"hi 1", "hi 2"} + for content, kwargs in calls.items(): + assert kwargs["model"] == BATCH_MODEL + assert kwargs["messages"] == [{"role": "user", "content": content}] + metadata = kwargs["metadata"] + assert metadata["user_api_key"] == harness.user.api_key + assert metadata["tags"] == ["tag-a"] + assert metadata["batch_id"] == created.id + assert metadata["user_api_key_user_id"] == "user-1" + assert metadata["user_api_key_team_id"] == "team-1" + assert metadata["user_api_key_alias"] == "alias-1" + assert metadata["user_api_key_user_email"] == "user@example.com" + + +async def test_create_uploads_one_output_line_per_row_with_the_router_response() -> None: + harness = make_runner() + replies = {"hi 1": chat_response("hi 1"), "hi 2": chat_response("hi 2")} + harness.router.acompletion.side_effect = lambda **kwargs: replies[kwargs["messages"][0]["content"]] + created, _ = await harness.create_and_finish() + + assert len(harness.uploads.calls) == 1 + upload = harness.uploads.calls[0] + assert (upload.target_storage, upload.purpose, upload.target_model_names) == ( + "litellm_db", + "batch_output", + (BATCH_MODEL,), + ) + assert upload.filename == f"{get_batch_id_from_unified_batch_id(created.id)}_output.jsonl" + assert upload.user_api_key_dict is harness.user + assert upload.prisma_client is harness.prisma + lines = upload.lines() + assert set(lines) == {"row-1", "row-2"} + for custom_id, content in (("row-1", "hi 1"), ("row-2", "hi 2")): + line = lines[custom_id] + assert str(line["id"]).startswith("batch_req_") + assert line["error"] is None + response = line["response"] + assert isinstance(response, dict) + assert response["status_code"] == 200 + assert response["body"] == replies[content].model_dump(mode="json") + + +async def test_create_splits_failed_rows_into_the_error_file() -> None: + harness = make_runner() + failure = ProviderRateLimited("slow down") + reply = chat_response("hi 1") + + def dispatch(messages: Sequence[Mapping[str, str]], **_: object) -> ModelResponse: + if messages[0]["content"] == "hi 1": + return reply + raise failure + + harness.router.acompletion.side_effect = dispatch + created, finished = await harness.create_and_finish() + + assert finished.status == "completed" + assert finished.request_counts == BatchRequestCounts(completed=1, failed=1, total=2) + assert (finished.output_file_id, finished.error_file_id) == ("unified-output-1", "unified-output-2") + llm_batch_id = get_batch_id_from_unified_batch_id(created.id) + assert [call.filename for call in harness.uploads.calls] == [ + f"{llm_batch_id}_output.jsonl", + f"{llm_batch_id}_error.jsonl", + ] + assert set(harness.uploads.calls[0].lines()) == {"row-1"} + error_lines = harness.uploads.calls[1].lines() + assert set(error_lines) == {"row-2"} + response = error_lines["row-2"]["response"] + assert isinstance(response, dict) + assert response["status_code"] == 429 + assert response["body"] == { + "error": {"message": str(failure), "type": "ProviderRateLimited", "param": None, "code": None} + } + + +async def test_create_rejects_an_unsupported_endpoint() -> None: + harness = make_runner() + with pytest.raises(ProxyException) as raised: + await harness.create(endpoint="/v1/moderations") + assert raised.value.code == "400" + assert raised.value.type == "invalid_request_error" + assert "/v1/moderations" in raised.value.message + assert harness.store.calls == [] + assert harness.storage_factory.calls == [] + + +@pytest.mark.parametrize( + "files", + [{}, {INPUT_FILE_ID: managed_input_file(storage_backend=None)}], + ids=["unknown file", "no stored content"], +) +async def test_create_rejects_an_input_file_litellm_does_not_hold( + files: Mapping[str, LiteLLM_ManagedFileTable], +) -> None: + harness = make_runner(files=files) + with pytest.raises(ProxyException) as raised: + await harness.create() + assert raised.value.code == "400" + assert "POST /v1/files" in raised.value.message + assert harness.storage_factory.calls == [] + assert harness.store.calls == [] + + +async def test_create_rejects_an_invalid_input_file() -> None: + harness = make_runner(content=jsonl(chat_row("a", "hi"), chat_row("a", "again"))) + with pytest.raises(ProxyException) as raised: + await harness.create() + assert raised.value.code == "400" + assert raised.value.message.startswith("Invalid batch input file:") + assert "'a'" in raised.value.message + assert harness.store.calls == [] + + +async def test_create_surfaces_a_storage_backend_error_as_a_400() -> None: + harness = make_runner(storage_error=ValueError("Unknown storage backend 's3'")) + with pytest.raises(ProxyException) as raised: + await harness.create() + assert raised.value.code == "400" + assert raised.value.message == "Unknown storage backend 's3'" + assert harness.store.calls == [] + + +CREDENTIAL_ROWS: Final = jsonl(chat_row("row-1", "hi 1"), chat_row("row-2", "hi 2", api_base="https://evil.example")) + + +async def test_create_rejects_a_row_carrying_client_side_credentials() -> None: + harness = make_runner(content=CREDENTIAL_ROWS) + with pytest.raises(ProxyException) as raised: + await harness.create() + assert raised.value.code == "400" + assert raised.value.message.startswith("Invalid batch input file: line 2") + assert "api_base" in raised.value.message + assert "allow_client_side_credentials" in raised.value.message + assert harness.store.calls == [] + assert harness.router.acompletion.await_count == 0 + + +async def test_create_forwards_row_credentials_when_the_admin_opted_in() -> None: + harness = make_runner( + content=CREDENTIAL_ROWS, general_settings=MappingProxyType({"allow_client_side_credentials": True}) + ) + _, finished = await harness.create_and_finish() + + assert finished.status == "completed" + assert finished.request_counts == BatchRequestCounts(completed=2, failed=0, total=2) + by_content = { + call.kwargs["messages"][0]["content"]: call.kwargs for call in harness.router.acompletion.await_args_list + } + assert by_content["hi 2"]["api_base"] == "https://evil.example" + assert "api_base" not in by_content["hi 1"] + + +async def test_running_batch_touches_its_row_until_it_finishes() -> None: + harness = make_runner(heartbeat_seconds=0.01) + + async def slow_dispatch(**_: object) -> ModelResponse: + await asyncio.sleep(0.05) + return chat_response("slow") + + harness.router.acompletion.side_effect = slow_dispatch + created, finished = await harness.create_and_finish() + + touches = harness.table.touches + assert finished.status == "completed" + assert touches + assert set(touches) == {(created.id, "user-1")} + assert [call.status for call in harness.store.calls] == ["validating"] + assert harness.written_statuses() == ["in_progress", "finalizing", "completed"] + beats_at_finish = len(touches) + await asyncio.sleep(0.05) + assert len(touches) == beats_at_finish + + +async def test_fail_abandoned_marks_a_stale_batch_failed_with_the_runner_lost_error() -> None: + harness = make_runner() + batch = seeded_batch(harness.store, "in_progress", age=STALE) + + failed = await harness.runner.fail_abandoned(batch, harness.user) + + assert failed.status == "failed" + assert failed.failed_at is not None + assert failed.errors is not None + assert [(error.message, error.code) for error in failed.errors.data or []] == [ + (litellm_executed_batches._RUNNER_LOST_MESSAGE, "runner_lost") + ] + assert harness.store.batch(batch.id).status == "failed" + assert harness.store.calls == [] + assert harness.table.writes == [StatusWrite(batch.id, "failed", STATUS_WRITE_COLUMNS)] + + +async def test_fail_abandoned_leaves_a_batch_that_finished_after_the_stale_read() -> None: + harness = make_runner() + stale_read = seeded_batch(harness.store, "in_progress", age=STALE) + harness.store.write(stale_read.model_copy(update={"status": "completed", "output_file_id": "out-1"}), age=STALE) + + current = await harness.runner.fail_abandoned(stale_read, harness.user) + + assert (current.status, current.output_file_id) == ("completed", "out-1") + assert harness.store.batch(stale_read.id).status == "completed" + assert harness.table.writes == [] + + +async def test_fail_abandoned_leaves_a_batch_its_runner_touched_since_the_read() -> None: + harness = make_runner() + batch = seeded_batch(harness.store, "in_progress", age=STALE) + harness.store.write(batch) + + current = await harness.runner.fail_abandoned(batch, harness.user) + + assert current.status == "in_progress" + assert harness.store.batch(batch.id).status == "in_progress" + assert harness.table.writes == [] + + +async def test_run_does_not_reverse_a_failure_written_between_its_read_and_its_completed_write() -> None: + harness = make_runner() + + def fail_once_finalizing_is_read(row: StoredObject | None) -> None: + if row is not None and row.status == "finalizing": + harness.store.write(row.batch().model_copy(update={"status": "failed"})) + + harness.table.after_read = fail_once_finalizing_is_read + _, finished = await harness.create_and_finish() + + assert finished.status == "failed" + assert finished.output_file_id is None + assert harness.written_statuses() == ["in_progress", "finalizing"] + + +async def test_run_honours_a_cancel_written_between_its_read_and_its_finalizing_write() -> None: + harness = make_runner(content=jsonl(chat_row("row-1", "hi 1"))) + + def cancel_once_the_row_is_dispatched(row: StoredObject | None) -> None: + if row is not None and row.status == "in_progress" and harness.router.acompletion.await_count == 1: + harness.store.write(row.batch().model_copy(update={"status": "cancelling"})) + + harness.table.after_read = cancel_once_the_row_is_dispatched + _, finished = await harness.create_and_finish() + + assert finished.status == "cancelled" + assert finished.request_counts == BatchRequestCounts(completed=1, failed=0, total=1) + assert finished.output_file_id == "unified-output-1" + assert harness.written_statuses() == ["in_progress", "cancelling", "cancelled"] + + +async def test_running_batch_stops_and_writes_nothing_once_a_retriever_marked_it_failed( + monkeypatch: pytest.MonkeyPatch, +) -> None: + monkeypatch.setattr(litellm_executed_batches, "_CANCEL_POLL_SECONDS", 0.0) + rows = jsonl(chat_row("row-1", "hi 1"), chat_row("row-2", "hi 2"), chat_row("row-3", "hi 3")) + harness = make_runner(content=rows, concurrency=1) + + def dispatch(metadata: Mapping[str, object], **_: object) -> ModelResponse: + running = harness.store.batch(str(metadata["batch_id"])) + harness.store.write(running.model_copy(update={"status": "failed"})) + return chat_response("hi 1") + + harness.router.acompletion.side_effect = dispatch + _, finished = await harness.create_and_finish() + + assert harness.router.acompletion.await_count == 1 + assert finished.status == "failed" + assert [call.status for call in harness.store.calls] == ["validating"] + assert harness.written_statuses() == ["in_progress"] + assert harness.uploads.calls == [] + + +@pytest.mark.parametrize( + ("endpoint", "body", "method"), + [ + ("/v1/chat/completions", {"messages": [{"role": "user", "content": "hi"}]}, "acompletion"), + ("/v1/completions", {"prompt": "hi"}, "atext_completion"), + ("/v1/embeddings", {"input": "hi"}, "aembedding"), + ("/v1/responses", {"input": "hi"}, "aresponses"), + ], +) +async def test_each_endpoint_awaits_only_its_router_method( + endpoint: BatchEndpoint, body: Mapping[str, object], method: str +) -> None: + row = {"custom_id": "a", "method": "POST", "url": endpoint, "body": {"model": "row-model", **body}} + harness = make_runner(content=jsonl(row)) + _, finished = await harness.create_and_finish(endpoint) + + assert finished.request_counts == BatchRequestCounts(completed=1, failed=0, total=1) + awaited = {name: getattr(harness.router, name).await_count for name in ROUTER_METHODS} + assert awaited == {name: int(name == method) for name in ROUTER_METHODS} + kwargs = getattr(harness.router, method).await_args.kwargs + assert kwargs["model"] == BATCH_MODEL + assert kwargs["disable_fallbacks"] is True + assert all(kwargs[key] == value for key, value in body.items()) + + +async def test_cancel_unknown_batch_is_404() -> None: + harness = make_runner() + with pytest.raises(ProxyException) as raised: + await harness.runner.cancel("missing-batch", harness.user) + assert raised.value.code == "404" + + +async def test_cancel_terminal_batch_is_400() -> None: + harness = make_runner() + batch = seeded_batch(harness.store, "completed") + with pytest.raises(ProxyException) as raised: + await harness.runner.cancel(batch.id, harness.user) + assert raised.value.code == "400" + assert "completed" in raised.value.message + assert harness.table.writes == [] + + +async def test_cancel_marks_a_running_batch_cancelling_once() -> None: + harness = make_runner() + batch = seeded_batch(harness.store, "in_progress") + + cancelled = await harness.runner.cancel(batch.id, harness.user) + + assert cancelled.status == "cancelling" + assert cancelled.cancelling_at is not None + assert harness.store.batch(batch.id).status == "cancelling" + assert harness.store.calls == [] + assert harness.table.writes == [StatusWrite(batch.id, "cancelling", STATUS_WRITE_COLUMNS)] + + again = await harness.runner.cancel(batch.id, harness.user) + + assert again.model_dump() == cancelled.model_dump() + assert len(harness.table.writes) == 1 + + +async def test_cancel_racing_a_completion_is_400_and_leaves_the_batch_completed() -> None: + harness = make_runner() + batch = seeded_batch(harness.store, "in_progress") + + def complete_once_read(row: StoredObject | None) -> None: + if row is not None and row.status == "in_progress": + harness.store.write(row.batch().model_copy(update={"status": "completed"})) + + harness.table.after_read = complete_once_read + with pytest.raises(ProxyException) as raised: + await harness.runner.cancel(batch.id, harness.user) + + assert raised.value.code == "400" + assert harness.store.batch(batch.id).status == "completed" + assert harness.table.writes == [] + + +async def test_running_batch_skips_the_remaining_rows_after_an_operator_cancel( + monkeypatch: pytest.MonkeyPatch, +) -> None: + monkeypatch.setattr(litellm_executed_batches, "_CANCEL_POLL_SECONDS", 0.0) + rows = jsonl(chat_row("row-1", "hi 1"), chat_row("row-2", "hi 2"), chat_row("row-3", "hi 3")) + harness = make_runner(content=rows, concurrency=1) + reply = chat_response("hi 1") + + def dispatch(metadata: Mapping[str, object], **_: object) -> ModelResponse: + running = harness.store.batch(str(metadata["batch_id"])) + harness.store.write(running.model_copy(update={"status": "cancelling"})) + return reply + + harness.router.acompletion.side_effect = dispatch + _, finished = await harness.create_and_finish() + + assert harness.router.acompletion.await_count == 1 + assert finished.status == "cancelled" + assert finished.cancelled_at is not None + assert finished.request_counts == BatchRequestCounts(completed=1, failed=0, total=3) + assert (finished.output_file_id, finished.error_file_id) == ("unified-output-1", None) + + +async def test_batch_expires_at_the_completion_window_and_keeps_what_finished() -> None: + rows = jsonl(chat_row("row-1", "hi 1"), chat_row("row-2", "hi 2"), chat_row("row-3", "hi 3")) + harness = make_runner(content=rows, concurrency=1, completion_window_seconds=0.2) + reply = chat_response("hi 1") + + async def dispatch(messages: Sequence[Mapping[str, str]], **_: object) -> ModelResponse: + if messages[0]["content"] == "hi 1": + return reply + await asyncio.Event().wait() + raise AssertionError("a row still running at the completion window must be cut off") + + harness.router.acompletion.side_effect = dispatch + created, finished = await harness.create_and_finish() + + assert created.expires_at == created.created_at + assert finished.status == "expired" + assert finished.expired_at is not None + assert finished.request_counts == BatchRequestCounts(completed=1, failed=2, total=3) + assert (finished.output_file_id, finished.error_file_id) == ("unified-output-1", "unified-output-2") + assert set(harness.uploads.calls[0].lines()) == {"row-1"} + error_lines = harness.uploads.calls[1].lines() + assert set(error_lines) == {"row-2", "row-3"} + for line in error_lines.values(): + assert line["response"] is None + error = line["error"] + assert isinstance(error, dict) + assert error["code"] == "batch_expired" + + +async def test_a_provider_timeout_fails_its_row_without_expiring_the_batch() -> None: + harness = make_runner() + reply = chat_response("hi 2") + + def dispatch(messages: Sequence[Mapping[str, str]], **_: object) -> ModelResponse: + if messages[0]["content"] == "hi 1": + raise asyncio.TimeoutError("the provider took too long") + return reply + + harness.router.acompletion.side_effect = dispatch + _, finished = await harness.create_and_finish() + + assert finished.status == "completed" + assert finished.expired_at is None + assert finished.request_counts == BatchRequestCounts(completed=1, failed=1, total=2) + assert set(harness.uploads.calls[0].lines()) == {"row-2"} + error_lines = harness.uploads.calls[1].lines() + assert set(error_lines) == {"row-1"} + assert error_lines["row-1"]["error"] is None + response = error_lines["row-1"]["response"] + assert isinstance(response, dict) + assert response["status_code"] == 500 + assert response["body"] == { + "error": {"message": "the provider took too long", "type": "TimeoutError", "param": None, "code": None} + } + + +async def test_batch_created_past_its_window_dispatches_nothing() -> None: + harness = make_runner(completion_window_seconds=0) + _, finished = await harness.create_and_finish() + + assert harness.router.acompletion.await_count == 0 + assert finished.status == "expired" + assert finished.request_counts == BatchRequestCounts(completed=0, failed=2, total=2) + assert (finished.output_file_id, finished.error_file_id) == (None, "unified-output-1") + assert set(harness.uploads.calls[0].lines()) == {"row-1", "row-2"} + + +async def test_upload_failure_marks_the_batch_failed() -> None: + harness = make_runner(upload_error=RuntimeError("storage exploded")) + _, finished = await harness.create_and_finish() + + assert finished.status == "failed" + assert finished.failed_at is not None + assert finished.output_file_id is None + assert finished.errors is not None + assert [(error.message, error.code) for error in finished.errors.data or []] == [ + ("storage exploded", "internal_error") + ] + + +async def test_only_the_create_write_carries_attribution_and_billing_flags() -> None: + harness = make_runner() + await harness.create_and_finish() + + assert [(call.status, call.persist_attribution, call.batch_processed) for call in harness.store.calls] == [ + ("validating", True, True) + ] + assert [write.columns for write in harness.table.writes] == [STATUS_WRITE_COLUMNS] * 3 + + +async def test_run_completes_under_the_real_hooks_base64_batch_id() -> None: + harness = make_runner(store_factory=RealIdManagedBatchStore) + created, finished = await harness.create_and_finish() + + assert _is_base64_encoded_unified_file_id(created.id) + assert finished.status == "completed" + assert [call.model_object_id.startswith("litellm_batch_") for call in harness.store.calls] == [True] + assert [write.unified_object_id for write in harness.table.writes] == [created.id] * 3 + + +async def test_cancel_works_under_the_real_hooks_base64_batch_id() -> None: + harness = make_runner(store_factory=RealIdManagedBatchStore) + batch = seeded_batch(harness.store, "in_progress") + cancelled = await harness.runner.cancel(batch.id, harness.user) + + assert cancelled.status == "cancelling" + assert harness.store.batch(batch.id).status == "cancelling" + assert [write.unified_object_id for write in harness.table.writes] == [batch.id] diff --git a/tests/test_litellm/proxy/client/cli/test_statusline_script.py b/tests/test_litellm/proxy/client/cli/test_statusline_script.py index 39d0e24d7b0..0cbeec86ee8 100644 --- a/tests/test_litellm/proxy/client/cli/test_statusline_script.py +++ b/tests/test_litellm/proxy/client/cli/test_statusline_script.py @@ -325,9 +325,12 @@ class TestRender: use_color=False, ) - def test_a_session_that_cost_more_than_its_baseline_reads_as_a_plus(self, config_dir): - dearer = RECORDED._replace(spend=0.50, baseline_spend=0.40) - assert "+25% vs Claude Opus 5" in render("m", dearer, config_dir, use_color=False) + @pytest.mark.parametrize("spend,delta", ((0.50, "+25%"), (0.40, "0%"), (0.4001, "0%"), (0.3999, "0%"), (0.30, "-25%"))) + def test_rounded_cost_delta_uses_a_sign_only_for_nonzero_percentages( + self, config_dir: Path, spend: float, delta: str, + ) -> None: + session: Final = RECORDED._replace(spend=spend, baseline_spend=0.40) + assert render("m", session, config_dir, use_color=False).splitlines()[0] == f"Routed to: m {delta} vs Claude Opus 5" def test_without_a_baseline_only_the_routed_line_shows(self, config_dir): assert render("m", RECORDED._replace(baseline_model=None), config_dir, False) == "Routed to: m" @@ -339,6 +342,37 @@ class TestRender: class TestClaudeCodeMode: + @pytest.mark.parametrize("estimated_turns", (0, 1)) + def test_current_estimates_keep_the_routed_model_and_compare_only_covered_turns( + self, tmp_path: Path, transcript: Path, config_dir: Path, estimated_turns: int + ) -> None: + session: Final = statusline_script._session_from_payload( + { + **RECORDED._asdict(), + "spend": 10.0, + "baseline_spend": None, + "savings_estimated_baseline_spend": 1.5 if estimated_turns else None, + "turns": 3, + "savings_estimated_turns": estimated_turns, + "savings_estimated_actual_spend": 2.0 if estimated_turns else 0.0, + } + ) + assert session is not None + + def fetch(credentials: Credentials, session_id: str) -> Fetched: + return Fetched(session, True) + + first: Final = _run(_payload(transcript), _env(tmp_path, config_dir), fetch) + assert first == _run(_payload(transcript), _env(tmp_path, config_dir), fetch) + assert first.startswith("Routed to: claude-sonnet-5") + if estimated_turns: + assert "+33% vs Claude Opus 5 · 1 of 3 turns estimated" in first + assert "$2.00" in first and "$1.50" in first + assert "$10.00" not in first and "+567%" not in first + else: + assert "Savings unavailable" in first + assert "%" not in first and "$" not in first + @pytest.mark.parametrize("transcript_model", ("claude-auto", "anthropic/claude-opus-5")) def test_the_session_names_the_routed_model_even_when_the_transcript_differs( self, tmp_path: Path, config_dir: Path, transcript_model: str diff --git a/tests/test_litellm/proxy/config_resolvers/test_settings_store.py b/tests/test_litellm/proxy/config_resolvers/test_settings_store.py index daf6609325e..806b2d5e5aa 100644 --- a/tests/test_litellm/proxy/config_resolvers/test_settings_store.py +++ b/tests/test_litellm/proxy/config_resolvers/test_settings_store.py @@ -359,3 +359,93 @@ def test_settings_store_refusal_stays_quiet_about_the_database_when_nothing_is_s assert refused.value.shadows_db_value is False assert "stored in the database" not in str(refused.value) assert "config file" in str(refused.value) + + +def test_settings_store_keeps_a_resolved_runtime_value_when_a_db_row_repeats_it() -> None: + store: Final = SettingsStore("general_settings") + store.apply_db_row("general_settings", {"litellm_key_header_name": "os.environ/HDR"}) + store.apply_runtime_values({"litellm_key_header_name": "X-Resolved-Header"}) + + store.apply_db_row("general_settings", {"litellm_key_header_name": "os.environ/HDR"}) + + assert store["litellm_key_header_name"] == "X-Resolved-Header" + + +def test_settings_store_drops_a_resolved_runtime_value_when_a_db_row_changes_it() -> None: + store: Final = SettingsStore("general_settings") + store.apply_db_row("general_settings", {"litellm_key_header_name": "os.environ/HDR"}) + store.apply_runtime_values({"litellm_key_header_name": "X-Resolved-Header"}) + + store.apply_db_row("general_settings", {"litellm_key_header_name": "os.environ/OTHER"}) + + assert store["litellm_key_header_name"] == "os.environ/OTHER" + + +def test_settings_store_accepts_the_writes_it_does_not_report_as_rejected() -> None: + store: Final = SettingsStore("general_settings") + store.load_yaml({"litellm_key_header_name": "os.environ/HDR"}) + store.apply_runtime_values({"litellm_key_header_name": "X-Resolved-Header"}) + incoming: Final[dict[str, JsonValue]] = {"litellm_key_header_name": "X-Resolved-Header"} + + assert store.rejected_writes(incoming) == () + store["litellm_key_header_name"] = "X-Resolved-Header" + assert store["litellm_key_header_name"] == "X-Resolved-Header" + + +def test_settings_store_reports_a_rejected_write_the_store_itself_refuses() -> None: + store: Final = SettingsStore("general_settings") + store.load_yaml({"litellm_key_header_name": "os.environ/HDR"}) + store.apply_runtime_values({"litellm_key_header_name": "X-Resolved-Header"}) + + assert store.rejected_writes({"litellm_key_header_name": "X-Other-Header"}) == ("litellm_key_header_name",) + with pytest.raises(ConfigOwnedKeyError): + store["litellm_key_header_name"] = "X-Other-Header" + + +def test_settings_store_reports_no_shadowing_when_the_database_repeats_the_config_template() -> None: + store: Final = SettingsStore("general_settings") + store.load_yaml({"litellm_key_header_name": "os.environ/HDR"}) + store.apply_db_row("general_settings", {"litellm_key_header_name": "os.environ/HDR"}) + store.apply_runtime_values({"litellm_key_header_name": "X-Resolved-Header"}) + + assert store.shadowed_db_keys() == () + assert store.shadows_db_value("litellm_key_header_name") is False + + +def test_settings_store_still_reports_shadowing_when_the_database_holds_another_template() -> None: + store: Final = SettingsStore("general_settings") + store.load_yaml({"litellm_key_header_name": "os.environ/HDR"}) + store.apply_db_row("general_settings", {"litellm_key_header_name": "os.environ/OTHER"}) + store.apply_runtime_values({"litellm_key_header_name": "X-Resolved-Header"}) + + assert store.shadowed_db_keys() == ("litellm_key_header_name",) + + +def test_settings_store_truthiness_stops_at_the_first_key() -> None: + store: Final = SettingsStore("general_settings") + store.load_yaml({f"key_{index}": index for index in range(25)}) + resolutions: Final[list[str]] = [] + original: Final = SettingsStore._resolution_for + + def counted(self: SettingsStore, key: str): + resolutions.append(key) + return original(self, key) + + with patch.object(SettingsStore, "_resolution_for", counted): # test-quality-ok: counting resolutions is the only way to observe that truthiness short-circuits + assert bool(store) is True + truthiness_resolutions: Final = len(resolutions) + resolutions.clear() + assert len(store) == 25 + + assert len(resolutions) == 25 + assert truthiness_resolutions <= 1 + + +def test_settings_store_truthiness_matches_emptiness() -> None: + store: Final = SettingsStore("general_settings") + + assert bool(store) is False + store["max_parallel_requests"] = 3 + assert bool(store) is True + del store["max_parallel_requests"] + assert bool(store) is False diff --git a/tests/test_litellm/proxy/db/test_autorouter_session_rollup.py b/tests/test_litellm/proxy/db/test_autorouter_session_rollup.py index 271751a3ff8..acd3dc18b54 100644 --- a/tests/test_litellm/proxy/db/test_autorouter_session_rollup.py +++ b/tests/test_litellm/proxy/db/test_autorouter_session_rollup.py @@ -281,6 +281,9 @@ class TestFlush: 0, "medium", "anthropic/claude-opus-5", + 0, + 0.0, + 0.0, ) def test_a_connect_error_retries_the_same_statement(self): @@ -307,7 +310,20 @@ class TestFlush: class TestEnqueueSeam: @pytest.mark.asyncio @pytest.mark.parametrize("classifier_cost", [0.005, 0.0, None]) - async def test_update_database_seam_enqueues_only_auto_routed_success(self, classifier_cost: float | None): + @pytest.mark.parametrize("estimate, covered, saved", [ + ({"version": 1, "status": "estimated"}, 1, -0.003), + ({"version": 1, "status": "estimated"}, 1, 0.0), + ({"version": 2, "status": "estimated"}, 1, 0.0), + ({"version": 3, "status": "estimated"}, 1, -0.003), + ({"version": 1, "status": "unknown"}, 0, 0.0), + ({"version": 0, "status": "estimated"}, 0, 0.0), + ({"version": 4, "status": "estimated"}, 0, 0.0), + ({"version": True, "status": "estimated"}, 0, 0.0), + (None, 0, -0.003), + ]) + async def test_update_database_seam_enqueues_only_auto_routed_success( + self, classifier_cost: float | None, estimate: dict[str, object] | None, covered: int, saved: float, + ) -> None: from litellm.proxy.db.db_spend_update_writer import DBSpendUpdateWriter writer: Final = DBSpendUpdateWriter() @@ -315,7 +331,8 @@ class TestEnqueueSeam: _autorouter_turn_transactions_lock=asyncio.Lock(), autorouter_turn_transactions=[] ) metadata: Final = _metadata( - routing_decision={**ROUTING_DECISION, "classifier_cost": classifier_cost}, autorouter_savings=-0.003 + routing_decision={**ROUTING_DECISION, "classifier_cost": classifier_cost}, + autorouter_savings=saved if covered else -0.003, autorouter_savings_estimate=estimate, ) for payload in ( _payload(metadata=json.dumps(metadata)), @@ -330,7 +347,10 @@ class TestEnqueueSeam: assert transaction.router_name == "live-auto" assert transaction.spend == pytest.approx(0.01 + (classifier_cost or 0.0)) assert transaction.classifier_cost == (classifier_cost or 0.0) - assert transaction.saved_spend == -0.003 + assert transaction.saved_spend == saved + assert transaction.savings_estimated_turns == covered + assert transaction.savings_estimated_actual_spend == pytest.approx(transaction.spend if covered else 0.0) + assert transaction.savings_estimated_saved_spend == (saved if covered else 0.0) def test_every_drain_trigger_reads_the_one_queue_census_owner(): diff --git a/tests/test_litellm/proxy/db/test_db_spend_update_writer.py b/tests/test_litellm/proxy/db/test_db_spend_update_writer.py index d08ff77f364..2ed5f263775 100644 --- a/tests/test_litellm/proxy/db/test_db_spend_update_writer.py +++ b/tests/test_litellm/proxy/db/test_db_spend_update_writer.py @@ -2758,7 +2758,18 @@ async def test_daily_transaction_carries_compression_saved_tokens(): @pytest.mark.asyncio -async def test_daily_transaction_compression_saved_tokens_zero_when_absent(): +@pytest.mark.parametrize("estimate, recorded_savings, expected", [ + pytest.param(None, None, -0.005, id="plain-classifier-cost"), + pytest.param({"version": 1, "status": "unknown"}, None, 0.0, id="unknown"), + pytest.param({"version": 2, "status": "unknown"}, None, 0.0, id="unknown-v2"), + pytest.param({"version": 1, "status": "unknown"}, -0.003, 0.0, id="unknown-stale-value"), + pytest.param({"version": 0, "status": "estimated"}, -0.003, 0.0, id="unsupported-version"), + pytest.param({"version": 1, "status": "estimated"}, -0.003, -0.003, id="estimated"), + pytest.param(None, -0.003, -0.003, id="legacy"), +]) +async def test_daily_transaction_compression_saved_tokens_zero_when_absent( + estimate: dict[str, object] | None, recorded_savings: float | None, expected: float, +) -> None: """Requests without any compression metadata produce a zero count.""" writer = DBSpendUpdateWriter() mock_prisma = MagicMock() @@ -2776,7 +2787,12 @@ async def test_daily_transaction_compression_saved_tokens_zero_when_absent(): "prompt_tokens": 100, "completion_tokens": 10, "spend": 0.01, - "metadata": json.dumps({"usage_object": {}}), + "metadata": json.dumps({ + "usage_object": {"prompt_tokens": 100, "completion_tokens": 10}, + "routing_decision": {"savings_baseline_model": "anthropic/claude-sonnet-5", "classifier_cost": 0.005}, + "autorouter_savings": recorded_savings, + "autorouter_savings_estimate": estimate, + }), } transaction = await writer._common_add_spend_log_transaction_to_daily_transaction( @@ -2789,6 +2805,8 @@ async def test_daily_transaction_compression_saved_tokens_zero_when_absent(): assert transaction["compression_saved_tokens"] == 0 assert transaction["compression_savings_spend"] == 0 assert transaction["prompt_caching_savings_spend"] == 0 + assert transaction["spend"] == 0.01 + assert transaction["autorouter_savings_spend"] == expected # --------------------------------------------------------------------------- diff --git a/tests/test_litellm/proxy/hooks/test_autorouter_baseline_cache.py b/tests/test_litellm/proxy/hooks/test_autorouter_baseline_cache.py new file mode 100644 index 00000000000..c6bb7833310 --- /dev/null +++ b/tests/test_litellm/proxy/hooks/test_autorouter_baseline_cache.py @@ -0,0 +1,326 @@ +import asyncio +import json +from collections.abc import AsyncIterator, Callable, Generator, Mapping +from contextlib import contextmanager +from datetime import datetime +from types import MappingProxyType +from typing import Final, cast +from uuid import uuid4 + +import httpx +import pytest +import respx +from pydantic import JsonValue, TypeAdapter +from typing_extensions import NotRequired, ReadOnly, TypedDict + +import litellm +from litellm.integrations.custom_logger import CustomLogger +from litellm.litellm_core_utils.litellm_logging import Logging +from litellm.llms.anthropic.prompt_cache_prediction import NativePredictionTarget, TokenCounter +from litellm.proxy.hooks.autorouter_baseline_cache import AutoRouterBaselineCache, CapturedBaselineObservation +from litellm.router import Router +from litellm.types.router import RetryPolicy +from litellm.types.utils import CallTypes, StandardLoggingRoutingDecision + +pytestmark: Final = pytest.mark.asyncio + + +_JSON_OBJECT: Final = TypeAdapter(dict[str, JsonValue]) + + +_OBJECTS: Final = TypeAdapter(dict[str, object]) + + +_MESSAGES: Final = TypeAdapter(list[dict[str, JsonValue]]) + + +_MESSAGES_JSON: Final = """[{"role":"user","content":[ + {"type":"text","text":"stable","cache_control":{"type":"ephemeral","ttl":"1h"}}, + {"type":"text","text":"question"}]}]""" + + +_MODELS: Final = _MESSAGES.validate_json("""[ + {"model_name":"test-router","litellm_params":{"model":"auto_router/complexity_router", + "complexity_router_config":{"tiers":{"SIMPLE":"sonnet","MEDIUM":"sonnet","COMPLEX":"sonnet", + "REASONING":"opus"},"session_affinity":false, + "keyword_tier_rules":[{"keywords":["USE_OPUS"],"tier":"REASONING"}]}}}, + {"model_name":"sonnet","litellm_params":{"model":"anthropic/claude-sonnet-5","api_key":"test-selected"}, + "model_info":{"id":"selected"}}, + {"model_name":"opus","litellm_params":{"model":"anthropic/claude-opus-5","api_key":"test-selected"}, + "model_info":{"id":"baseline"}}]""") + + +def _message(completed: bool, model: str) -> Mapping[str, JsonValue]: + return _JSON_OBJECT.validate_json(f"""{{ + "id":"msg_baseline_test","type":"message","role":"assistant","model":{json.dumps(model)}, + "content":{'[{"type":"text","text":"OK"}]' if completed else "[]"}, + "stop_reason":{'"end_turn"' if completed else "null"},"stop_sequence":null, + "usage":{{"input_tokens":1000,"output_tokens":{10 if completed else 0}, + "cache_creation_input_tokens":5000,"cache_read_input_tokens":0, + "cache_creation":{{"ephemeral_5m_input_tokens":0,"ephemeral_1h_input_tokens":5000}}}}}}""") + + +_EVENTS: Final = _MESSAGES.validate_json("""[ + {"type":"content_block_start","index":0,"content_block":{"type":"text","text":""}}, + {"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":"OK"}}, + {"type":"content_block_stop","index":0}, + {"type":"message_delta","delta":{"stop_reason":"end_turn"},"usage":{"output_tokens":10}}, + {"type":"message_stop"} +]""") + + +async def _count(model: str, api_key: str, body: Mapping[str, JsonValue]) -> int: + assert model == "claude-opus-5" + return 6000 if "question" in json.dumps(_JSON_OBJECT.validate_python(body)) else 5000 + + +class _CallContext(TypedDict): + litellm_logging_obj: NotRequired[ReadOnly[Logging]] + litellm_call_id: ReadOnly[str] + litellm_metadata: ReadOnly[Mapping[str, object]] + litellm_session_id: ReadOnly[str] + + +def _kwargs(logging_obj: Logging, trusted: bool = True, *, explicit_logging: bool = True) -> _CallContext: + context: Final = _OBJECTS.validate_json('{"litellm_metadata":{"user_api_key_hash":"test-caller-hash"}}') + Router._record_routing_decision( # pyright: ignore[reportUnknownMemberType, reportPrivateUsage] # production trusted stamp owner + context, + StandardLoggingRoutingDecision( + router_model_name="test-router", + router_type="complexity", + routed_model="sonnet", + cause="heuristic_scorer", + conversation_continuing=True, + savings_baseline_model="anthropic/claude-opus-5", + savings_baseline_deployment_id="baseline", + ), + ) + metadata: Final = _OBJECTS.validate_python(context["litellm_metadata"]) + if not trusted: + metadata["_autorouter_baseline_route"] = _JSON_OBJECT.validate_json( + '{"router_name":"test-router","baseline_model":"anthropic/claude-opus-5","baseline_deployment_id":"baseline"}' + ) + envelope: Final[_CallContext] = { + "litellm_call_id": logging_obj.litellm_call_id, + "litellm_session_id": "baseline-session", + "litellm_metadata": metadata, + } + supplied: Final[_CallContext] = {**envelope, "litellm_logging_obj": logging_obj} + return supplied if explicit_logging else envelope + + +def _stream(logging_obj: Logging) -> bool: + return logging_obj.stream is True # pyright: ignore[reportUnknownMemberType] # normalize the legacy Logging flag + + +def _sse(completed: bool = True, model: str = "claude-sonnet-5") -> tuple[bytes, ...]: + events: Final = ( + { # mutable-ok: json.dumps needs a concrete event dictionary + "type": "message_start", + "message": _message(False, model), + }, + *_EVENTS, + ) + return tuple( + f"event: {event['type']}\ndata: {json.dumps(event)}\n\n".encode() + for event in (events if completed else events[:-1]) + ) + + +def _upstream(request: httpx.Request) -> httpx.Response: + body: Final = _JSON_OBJECT.validate_json(request.content) + model: Final = body.get("model") + assert isinstance(model, str) + stream: Final = body.get("stream") is True + content: Final = b"".join(_sse(model=model)) if stream else json.dumps(_message(True, model)).encode() + return httpx.Response(200, content=content, request=request, + headers=MappingProxyType({"content-type": "text/event-stream" if stream else "application/json"}), + ) + + +def _error(request: httpx.Request, code: int, message: str) -> httpx.Response: + return httpx.Response( + code, + text='{"type":"error","error":{"type":"rate_limit_error","message":' + json.dumps(message) + "}}", + headers=MappingProxyType({"retry-after": "0"}), + request=request, + ) + + +@contextmanager +def _transport(upstream: Callable[[httpx.Request], httpx.Response]) -> Generator[respx.Route]: + with respx.mock() as transport: + yield transport.post("https://api.anthropic.com/v1/messages").mock(side_effect=upstream) + + +class _NativeOptions(TypedDict): + api_key: NotRequired[ReadOnly[str]] + num_retries: NotRequired[ReadOnly[int]] + + +async def _call( + target: Router | None, + logging_obj: Logging, + *, + trusted: bool = True, + messages: str = _MESSAGES_JSON, + explicit_logging: bool = True, +) -> None: + invoke: Final = target.anthropic_messages if target else litellm.anthropic_messages # pyright: ignore[reportUnknownMemberType, reportUnknownVariableType] # legacy native call signatures + options: Final = _NativeOptions() if target else _NativeOptions(api_key="test-selected", num_retries=0) + response: Final[object] = await invoke( # pyright: ignore[reportUnknownVariableType] # native Router returns an opaque SDK result + model="test-router" if target else "anthropic/claude-sonnet-5", + max_tokens=16, + stream=_stream(logging_obj), + messages=_MESSAGES.validate_json(messages), + **options, + **_kwargs(logging_obj, trusted, explicit_logging=explicit_logging), + ) + assert response is not None + if _stream(logging_obj): + assert isinstance(response, AsyncIterator) + stream: Final = cast(AsyncIterator[object], response) # cast-ok: iterator checked; all items satisfy object + assert tuple([chunk async for chunk in stream]) + +class _Capture(CustomLogger): + def __init__(self, call_id: str) -> None: + self.call_id: Final = call_id + self.payloads: Final[asyncio.Queue[Mapping[str, object]]] = asyncio.Queue() + + async def async_log_success_event( + self, kwargs: Mapping[str, object], response_obj: object, start_time: datetime, end_time: datetime + ) -> None: + payload: Final = _OBJECTS.validate_python(kwargs.get("standard_logging_object")) + if payload.get("litellm_call_id") == self.call_id: + self.payloads.put_nowait(payload) + + async def payload(self) -> Mapping[str, object]: + return await asyncio.wait_for(self.payloads.get(), timeout=20) + + +class _Rig: + def __init__(self, monkeypatch: pytest.MonkeyPatch, *, retries: int = 0, count: TokenCounter = _count) -> None: + self.router: Final = Router(model_list=_MODELS, num_retries=retries, + retry_policy=RetryPolicy(RateLimitErrorRetries=retries), disable_cooldowns=True) + + def router() -> Router: + return self.router + + self.hook: Final = AutoRouterBaselineCache(None, router=router, token_counter=count) + self.call_id: Final = uuid4().hex + self.capture: Final = _Capture(self.call_id) + monkeypatch.setattr(litellm, "disable_aiohttp_transport", True) + for name in ("ANTHROPIC_API_BASE", "ANTHROPIC_BASE_URL"): + monkeypatch.delenv(name, raising=False) + monkeypatch.setattr(litellm, "callbacks", [self.hook]) + for name in ("success_callback", "failure_callback", "_async_failure_callback"): + monkeypatch.setattr(litellm, name, []) + monkeypatch.setattr(litellm, "_async_success_callback", [self.capture]) + + def logging(self, stream: bool = False) -> Logging: + return Logging(model="anthropic/claude-sonnet-5", messages=_MESSAGES.validate_json(_MESSAGES_JSON), + stream=stream, call_type=CallTypes.anthropic_messages.value, start_time=datetime.now(), + litellm_call_id=self.call_id, function_id=self.call_id, kwargs={"litellm_session_id":"baseline-session"}) + + +def _observation(payload: Mapping[str, object]) -> CapturedBaselineObservation: + encoded: Final = payload["autorouter_baseline_observation"] + assert isinstance(encoded, str) + assert "test-selected" not in encoded and "stable" not in encoded and "x-api-key" not in encoded + return CapturedBaselineObservation.model_validate_json(encoded) + + +@pytest.mark.parametrize("stream,baseline", ((False, False), (True, False), (False, True), (True, True))) +async def test_native_logging_captures_usage_without_publishing_hypothetical_savings( + monkeypatch: pytest.MonkeyPatch, stream: bool, baseline: bool, +) -> None: + rig: Final = _Rig(monkeypatch) + messages: Final = _MESSAGES_JSON.replace("question", "question USE_OPUS") if baseline else _MESSAGES_JSON + with _transport(_upstream): + await _call(rig.router, rig.logging(stream), messages=messages) + payload: Final = await rig.capture.payload() + captured: Final = _observation(payload) + assert payload["autorouter_savings"] is None + assert _OBJECTS.validate_python(payload["autorouter_savings_estimate"])["reason"] == "pending_projection" + assert captured.observation.outcome == "complete" + assert captured.observation.baseline_equivalent == baseline + assert captured.observation.usage is not None and captured.observation.usage.completion_tokens == 10 + assert captured.observation.plan is not None and captured.observation.plan.total_tokens == 6000 + + +async def test_count_failure_preserves_initial_observed_equivalence(monkeypatch: pytest.MonkeyPatch) -> None: + async def count(model: str, api_key: str, body: Mapping[str, JsonValue]) -> int | None: + return None + + rig: Final = _Rig(monkeypatch, count=count) + with _transport(_upstream): + await _call(rig.router, rig.logging(), messages=_MESSAGES_JSON.replace("question", "question USE_OPUS")) + captured: Final = _observation(await rig.capture.payload()) + assert captured.observation.baseline_equivalent and captured.observation.usage is not None + assert captured.observation.plan is None and captured.observation.reason == "token_count_unavailable" + + +async def test_native_retry_is_uncertain_even_when_final_response_succeeds(monkeypatch: pytest.MonkeyPatch) -> None: + rig: Final = _Rig(monkeypatch, retries=1) + + def upstream(request: httpx.Request) -> httpx.Response: + return _upstream(request) if route.call_count else _error(request, 429, "retry") + + with _transport(upstream) as route: + await _call(rig.router, rig.logging()) + captured: Final = _observation(await rig.capture.payload()) + assert route.call_count == 2 + assert captured.observation.outcome == "uncertain" + assert captured.observation.reason == "retried_request" + + +async def test_caller_cannot_forge_an_observation_scope(monkeypatch: pytest.MonkeyPatch) -> None: + rig: Final = _Rig(monkeypatch) + with _transport(_upstream): + await _call(None, rig.logging(), trusted=False) + payload: Final = await rig.capture.payload() + assert payload["autorouter_baseline_observation"] is None + assert payload["autorouter_savings"] is None + + +@pytest.mark.parametrize("model,key,endpoint", ( + ("claude-sonnet-5", "test-first", None), + ("claude-opus-5", "test-second", None), + ("claude-opus-5", "test-first", "https://example.test"), +)) +async def test_count_memo_is_scoped_to_provider_recipient(model: str, key: str, endpoint: str | None) -> None: + counts: Final = iter((5000, 6000)) + + async def count(model: str, api_key: str, body: Mapping[str, JsonValue]) -> int: + return next(counts) + + collector: Final = AutoRouterBaselineCache(None, token_counter=count) + original: Final = NativePredictionTarget("claude-opus-5", "test-first") + other: Final = NativePredictionTarget(model, key, endpoint) + assert await collector._count(original, {}) == 5000 # pyright: ignore[reportPrivateUsage] + assert await collector._count(other, {}) == 6000 # pyright: ignore[reportPrivateUsage] + assert await collector._count(original, {}) == 5000 # pyright: ignore[reportPrivateUsage] + + +@pytest.mark.parametrize("stream", (False, True)) +async def test_provider_counting_does_not_hold_the_inference_response( + monkeypatch: pytest.MonkeyPatch, stream: bool, +) -> None: + counting: Final = asyncio.Event() + release: Final = asyncio.Event() + + async def count(model: str, api_key: str, body: Mapping[str, JsonValue]) -> int: + counting.set() + await release.wait() + return await _count(model, api_key, body) + + rig: Final = _Rig(monkeypatch, count=count) + try: + with _transport(_upstream): + await asyncio.wait_for(_call(rig.router, rig.logging(stream)), timeout=2) + await asyncio.wait_for(counting.wait(), timeout=2) + assert rig.capture.payloads.empty() + release.set() + assert _observation(await rig.capture.payload()).observation.plan is not None + finally: + release.set() diff --git a/tests/test_litellm/proxy/management_endpoints/test_auto_router_endpoints.py b/tests/test_litellm/proxy/management_endpoints/test_auto_router_endpoints.py index 067f30c2fd7..6ac053f4e15 100644 --- a/tests/test_litellm/proxy/management_endpoints/test_auto_router_endpoints.py +++ b/tests/test_litellm/proxy/management_endpoints/test_auto_router_endpoints.py @@ -546,6 +546,9 @@ class TestAutoRouterBenchmarks: total_tokens=4000, spend=10.0, saved_spend=30.0, + savings_estimated_turns=40, + savings_estimated_actual_spend=10.0, + savings_estimated_saved_spend=30.0, classifier_cost=0.4, classifier_cost_recorded_turns=40, session_seconds=400.0, @@ -582,12 +585,29 @@ class TestAutoRouterBenchmarks: def test_a_losing_router_reports_negative_savings(self): from litellm.proxy.management_endpoints.auto_router_endpoints import _benchmark_totals - losing = self.ROW.model_copy(update={"saved_spend": -5.0}) + losing = self.ROW.model_copy(update={"saved_spend": -5.0, "savings_estimated_saved_spend": -5.0}) totals = _benchmark_totals(losing) assert totals.baseline_spend == 5.0 assert totals.saved_pct == -100.0 assert totals.classifier_cost == 0.4 + @pytest.mark.parametrize("estimated_turns", [0, 4]) + def test_savings_compare_only_the_current_estimated_cohort(self, estimated_turns: int) -> None: + from litellm.proxy.management_endpoints.auto_router_endpoints import _benchmark_totals + + row: Final = self.ROW.model_copy(update={ + "savings_estimated_turns": estimated_turns, + "savings_estimated_actual_spend": 2.0 if estimated_turns else 0.0, + "savings_estimated_saved_spend": -0.5 if estimated_turns else 0.0, + }) + totals: Final = _benchmark_totals(row) + assert totals.spend == 10.0 + assert totals.savings_estimated_turns == estimated_turns + assert totals.saved_spend == (-0.5 if estimated_turns else None) + assert totals.baseline_spend == (1.5 if estimated_turns else None) + assert totals.saved_pct == (pytest.approx(-33.3) if estimated_turns else None) + assert totals.saved_per_session is None + def test_an_empty_window_folds_to_zeros(self): from litellm.proxy.management_endpoints.auto_router_endpoints import ( _benchmark_totals, @@ -607,7 +627,10 @@ class TestAutoRouterBenchmarks: _summed_agg_row, ) - other = self.ROW.model_copy(update={"router_name": "auto-2", "sessions": 1, "turns": 10, "spend": 0.0}) + other = self.ROW.model_copy(update={ + "router_name": "auto-2", "sessions": 1, "turns": 10, "spend": 0.0, + "savings_estimated_turns": 10, "savings_estimated_actual_spend": 0.0, + }) summed = _summed_agg_row([self.ROW, other]) totals = _benchmark_totals(summed) assert summed.sessions == 5 @@ -696,6 +719,9 @@ class TestAutoRouterBenchmarks: "turns": 10, "spend": 2.0, "saved_spend": -0.5, + "savings_estimated_turns": 10, + "savings_estimated_actual_spend": 2.0, + "savings_estimated_saved_spend": -0.5, "classifier_cost": recorded_turns * 0.02, "classifier_cost_recorded_turns": recorded_turns, } @@ -876,6 +902,10 @@ class TestAutoRouterSession: "last_model": "anthropic/claude-sonnet-5", "spend": 0.14, "saved_spend": 0.24, + "savings_estimated_turns": 3, + "savings_estimated_actual_spend": 0.14, + "savings_estimated_saved_spend": 0.24, + "savings_estimated_baseline_models": {"anthropic/claude-opus-5": 3}, "classifier_cost": 0.0, "tier_turns": {"simple": 1, "complex": 2}, "baseline_models": {"anthropic/claude-opus-5": 3}, @@ -899,25 +929,33 @@ class TestAutoRouterSession: return lookups @pytest.mark.asyncio + @pytest.mark.parametrize("turns, estimated", [(3, True), (10, True), (10, False)], ids=["full", "partial", "legacy"]) async def test_a_key_reads_its_own_session_with_the_baseline_its_turns_were_priced_against( - self, monkeypatch: pytest.MonkeyPatch - ): + self, monkeypatch: pytest.MonkeyPatch, turns: int, estimated: bool, + ) -> None: from litellm.proxy.management_endpoints.auto_router_endpoints import get_auto_router_session caller = UserAPIKeyAuth(api_key="sk-caller") - self._rig(monkeypatch, [{**self.ROW, "api_key": caller.api_key, "session_id": "sess-1"}]) + row: Final = {key: value for key, value in self.ROW.items() if estimated or not key.startswith("savings_estimated_")} + spend: Final = 0.14 if turns == 3 else 10.0 + if estimated and turns != 3: + row["savings_estimated_saved_spend"] = -0.04 + self._rig(monkeypatch, [{**row, "api_key": caller.api_key, "session_id": "sess-1", "turns": turns, "spend": spend}]) response = await get_auto_router_session(user_api_key_dict=caller, session_id="sess-1") assert response.model_dump() == { "session_id": "sess-1", "router_name": "claude-auto", "router_type": "complexity", - "turns": 3, + "turns": turns, "last_model": "anthropic/claude-sonnet-5", - "spend": 0.14, - "saved_spend": 0.24, - "baseline_spend": pytest.approx(0.38), - "baseline_model": "anthropic/claude-opus-5", - "baseline_models": {"anthropic/claude-opus-5": 3}, + "spend": spend, + "saved_spend": (0.24 if turns == 3 else -0.04) if estimated else None, + "savings_estimated_turns": 3 if estimated else 0, + "savings_estimated_actual_spend": 0.14 if estimated else 0.0, + "baseline_spend": pytest.approx(0.38) if turns == 3 else None, + "savings_estimated_baseline_spend": pytest.approx(0.38 if turns == 3 else 0.1) if estimated else None, + "baseline_model": "anthropic/claude-opus-5" if estimated else None, + "baseline_models": {"anthropic/claude-opus-5": 3} if estimated else {}, } @pytest.mark.asyncio @@ -959,22 +997,14 @@ class TestAutoRouterSession: from litellm.proxy.management_endpoints.auto_router_endpoints import get_auto_router_session priced = {"anthropic/claude-opus-5": 2, "anthropic/claude-sonnet-5": 1} - self._rig(monkeypatch, [{**self.ROW, "api_key": ADMIN.api_key, "session_id": "s", "baseline_models": priced}]) + self._rig(monkeypatch, [{ + **self.ROW, "api_key": ADMIN.api_key, "session_id": "s", + "baseline_models": {"old-baseline": 100}, "savings_estimated_baseline_models": priced, + }]) response = await get_auto_router_session(user_api_key_dict=ADMIN, session_id="s") assert response.baseline_model == "anthropic/claude-opus-5" assert response.baseline_models == priced - @pytest.mark.asyncio - async def test_a_session_whose_turns_recorded_no_baseline_reports_the_money_without_a_name( - self, monkeypatch: pytest.MonkeyPatch - ): - from litellm.proxy.management_endpoints.auto_router_endpoints import get_auto_router_session - - self._rig(monkeypatch, [{**self.ROW, "api_key": ADMIN.api_key, "session_id": "s", "baseline_models": {}}]) - response = await get_auto_router_session(user_api_key_dict=ADMIN, session_id="s") - assert response.baseline_model is None - assert response.baseline_spend == pytest.approx(0.38) - @pytest.mark.asyncio async def test_an_oversized_client_session_id_is_bounded_like_the_writer_bounded_it( self, monkeypatch: pytest.MonkeyPatch diff --git a/tests/test_litellm/proxy/management_endpoints/test_coordination_redis_endpoints.py b/tests/test_litellm/proxy/management_endpoints/test_coordination_redis_endpoints.py index 4481a87c9e7..7c6e8154107 100644 --- a/tests/test_litellm/proxy/management_endpoints/test_coordination_redis_endpoints.py +++ b/tests/test_litellm/proxy/management_endpoints/test_coordination_redis_endpoints.py @@ -616,3 +616,64 @@ async def test_connection_test_rejects_proxy_admin_viewer(): user_api_key_dict=UserAPIKeyAuth(api_key="hashed", user_role=LitellmUserRoles.PROXY_ADMIN_VIEW_ONLY), ) assert exc_info.value.status_code == 403 + + +def _real_proxy_config(file_general_settings: dict) -> "object": + from litellm.proxy.proxy_server import ProxyConfig + + proxy_config = ProxyConfig() + proxy_config._load_yaml_settings_stores({"general_settings": file_general_settings}) + proxy_config.get_config_state = MagicMock( + return_value={"general_settings": file_general_settings} + ) + return proxy_config + + +@pytest.mark.asyncio +async def test_update_refuses_a_config_owned_coordination_redis_block(monkeypatch): + monkeypatch.setattr(litellm, "store_audit_logs", False) + mock_prisma = _prisma_with_general_settings({"master_key": "sk-1234"}) + from_file = {"coordination_redis": {"host": "yaml-redis.example.com", "port": 6379}} + + with ( + patch("litellm.proxy.proxy_server.prisma_client", mock_prisma), # test-quality-ok: the endpoint reads these proxy_server module globals at call time; there is no injection seam + patch("litellm.proxy.proxy_server.proxy_config", _real_proxy_config(from_file)), # test-quality-ok: the endpoint reads these proxy_server module globals at call time; there is no injection seam + patch("litellm.proxy.proxy_server.store_model_in_db", True), # test-quality-ok: the endpoint reads these proxy_server module globals at call time; there is no injection seam + ): + with pytest.raises(HTTPException) as refused: + await update_coordination_redis_settings( + request=CoordinationRedisSettingsRequest(settings={"host": "db-redis.example.com", "port": 6380}), + user_api_key_dict=_admin_auth(), + litellm_changed_by=None, + ) + + assert refused.value.status_code == 400 + assert refused.value.detail["keys"] == ["coordination_redis"] + mock_prisma.db.litellm_config.upsert.assert_not_called() + + +@pytest.mark.asyncio +async def test_update_still_persists_when_the_config_file_declares_no_block(monkeypatch): + monkeypatch.setattr(litellm, "store_audit_logs", False) + mock_prisma = _prisma_with_general_settings({"master_key": "sk-1234"}) + + async def _capture_invalidate(param_name: str) -> None: + return None + + with ( + patch("litellm.proxy.proxy_server.prisma_client", mock_prisma), # test-quality-ok: the endpoint reads these proxy_server module globals at call time; there is no injection seam + patch("litellm.proxy.proxy_server.proxy_config", _real_proxy_config({"master_key": "sk-1234"})), # test-quality-ok: the endpoint reads these proxy_server module globals at call time; there is no injection seam + patch("litellm.proxy.proxy_server.store_model_in_db", True), # test-quality-ok: the endpoint reads these proxy_server module globals at call time; there is no injection seam + patch( # test-quality-ok: the endpoint reads these proxy_server module globals at call time; there is no injection seam + "litellm.proxy.management_endpoints.coordination_redis_endpoints.invalidate_config_param", + new=_capture_invalidate, + ), + ): + await update_coordination_redis_settings( + request=CoordinationRedisSettingsRequest(settings={"host": "db-redis.example.com", "port": 6380}), + user_api_key_dict=_admin_auth(), + litellm_changed_by=None, + ) + + persisted = json.loads(mock_prisma.db.litellm_config.upsert.call_args.kwargs["data"]["update"]["param_value"]) + assert persisted["coordination_redis"] == {"host": "db-redis.example.com", "port": 6380} diff --git a/tests/test_litellm/proxy/openai_files_endpoint/test_files_common_utils.py b/tests/test_litellm/proxy/openai_files_endpoint/test_files_common_utils.py index ef8af7bdbd3..50768e48d43 100644 --- a/tests/test_litellm/proxy/openai_files_endpoint/test_files_common_utils.py +++ b/tests/test_litellm/proxy/openai_files_endpoint/test_files_common_utils.py @@ -4,10 +4,10 @@ from unittest.mock import AsyncMock, MagicMock import pytest - from litellm.proxy.openai_files_endpoints.common_utils import ( apply_unified_file_ids, get_credentials_for_model, + is_litellm_executed_batch, map_raw_file_ids_to_unified, ) from litellm.proxy.route_llm_request import ProxyModelNotFoundError @@ -500,3 +500,17 @@ class TestCompletedBatchSafeToRetire: def test_no_output_and_unknown_counts_is_not_safe(self): assert _completed_batch_safe_to_retire(_completed_batch_for_retire(None)) is False + + +@pytest.mark.parametrize( + "decoded_unified_batch_id, executed", + [ + ("litellm_proxy;model_id:my-vllm;llm_batch_id:litellm_batch_0123abcd", True), + ("litellm_proxy;model_id:my-vllm;llm_batch_id:batch_0123abcd", False), + ("litellm_proxy;model_id:my-vllm;generic_response_id:resp_0123abcd", False), + ("litellm_proxy;model_id:my-vllm;llm_output_file_id:file-0123abcd", False), + ("batch_0123abcd", False), + ], +) +def test_is_litellm_executed_batch_reads_the_llm_batch_id_prefix(decoded_unified_batch_id: str, executed: bool): + assert is_litellm_executed_batch(decoded_unified_batch_id) is executed diff --git a/tests/test_litellm/proxy/openai_files_endpoint/test_files_endpoint.py b/tests/test_litellm/proxy/openai_files_endpoint/test_files_endpoint.py index dd67dc337ea..48699b47e7f 100644 --- a/tests/test_litellm/proxy/openai_files_endpoint/test_files_endpoint.py +++ b/tests/test_litellm/proxy/openai_files_endpoint/test_files_endpoint.py @@ -609,6 +609,246 @@ def test_target_storage_with_target_models( app.dependency_overrides.pop(ps.user_api_key_auth, None) +BATCH_JSONL_LINE = ( + b'{"custom_id": "req-1", "method": "POST", "url": "/v1/chat/completions", ' + b'"body": {"model": "my-vllm", "messages": [{"role": "user", "content": "hi"}]}}\n' +) + + +def _router_with_executed_batch_model() -> Router: + return Router( + model_list=[ + { + "model_name": "my-vllm", + "litellm_params": { + "model": "hosted_vllm/qwen", + "api_key": "sk-vllm", + "api_base": "http://vllm.test/v1", + }, + "model_info": {"id": "my-vllm-id"}, + }, + { + "model_name": "gemini-2.0-flash", + "litellm_params": {"model": "gemini/gemini-2.0-flash"}, + "model_info": {"id": "gemini-2.0-flash-id"}, + }, + ] + ) + + +@pytest.fixture +def batch_upload_seams(mocker: MockerFixture, monkeypatch): + import litellm.proxy.proxy_server as ps + from litellm.proxy._types import LitellmUserRoles + + llm_router = _router_with_executed_batch_model() + monkeypatch.setattr("litellm.proxy.proxy_server.master_key", None) + monkeypatch.setattr("litellm.proxy.proxy_server.prisma_client", None) + monkeypatch.setattr("litellm.proxy.proxy_server.llm_router", llm_router) + setup_proxy_logging_object(monkeypatch, llm_router) + monkeypatch.setattr(litellm, "disable_aiohttp_transport", True) + app.dependency_overrides[ps.user_api_key_auth] = lambda: UserAPIKeyAuth( + user_role=LitellmUserRoles.PROXY_ADMIN, user_id="test-user" + ) + uploaded = OpenAIFileObject( + id="file-kept", + object="file", + purpose="batch", + created_at=0, + bytes=len(BATCH_JSONL_LINE), + filename="batch.jsonl", + status="uploaded", + ) + stored = mocker.patch( # test-quality-ok: the route calls the storage service directly with no injection seam + "litellm.proxy.openai_files_endpoints.storage_backend_service.StorageBackendFileService.upload_file_to_storage_backend", + new=mocker.AsyncMock(return_value=uploaded), + ) + provider_upload = mocker.patch( # test-quality-ok: the route calls litellm.acreate_file directly with no injection seam + "litellm.acreate_file", new=mocker.AsyncMock(return_value=uploaded) + ) + try: + with respx.mock(assert_all_called=False) as upstream: + upstream_files_route = upstream.get("http://vllm.test/v1/files").mock( + return_value=httpx.Response(404, json={"detail": "Not Found"}) + ) + yield stored, provider_upload, upstream_files_route + finally: + app.dependency_overrides.pop(ps.user_api_key_auth, None) + + +def _upload_batch_file(headers: dict[str, str], form: dict[str, str]): + return client.post( + "/v1/files", + files={"file": ("batch.jsonl", BATCH_JSONL_LINE, "application/jsonl")}, + data={"purpose": "batch", **form}, + headers={"Authorization": "Bearer test-key", **headers}, + ) + + +@pytest.mark.parametrize( + "headers, form", + [({"x-litellm-model": "my-vllm"}, {}), ({}, {"target_model_names": "my-vllm"})], + ids=["x-litellm-model header", "target_model_names form field"], +) +def test_batch_upload_for_a_litellm_executed_model_is_kept_by_litellm( + batch_upload_seams, headers: dict[str, str], form: dict[str, str] +): + stored, provider_upload, _ = batch_upload_seams + + response = _upload_batch_file(headers, form) + + assert response.status_code == 200, response.text + provider_upload.assert_not_awaited() + stored.assert_awaited_once() + kwargs = stored.call_args.kwargs + assert kwargs["target_storage"] == "litellm_db" + assert tuple(kwargs["target_model_names"]) == ("my-vllm",) + assert kwargs["purpose"] == "batch" + + +@pytest.mark.parametrize( + "headers, form", + [({"x-litellm-model": "my-vllm"}, {}), ({}, {"target_model_names": "my-vllm"})], + ids=["x-litellm-model header", "target_model_names form field"], +) +def test_batch_upload_for_a_litellm_executed_model_the_key_cannot_call_is_refused_before_the_server_is_probed( + batch_upload_seams, headers: dict[str, str], form: dict[str, str] +): + import litellm.proxy.proxy_server as ps + + stored, provider_upload, upstream_files_route = batch_upload_seams + app.dependency_overrides[ps.user_api_key_auth] = lambda: UserAPIKeyAuth( + user_id="restricted-user", models=["gemini-2.0-flash"] + ) + + response = _upload_batch_file(headers, form) + + assert response.status_code == 403, response.text + assert "my-vllm" in response.text + assert upstream_files_route.call_count == 0 + stored.assert_not_awaited() + provider_upload.assert_not_awaited() + + +def test_batch_upload_naming_an_executed_and_a_provider_model_is_rejected(batch_upload_seams): + stored, provider_upload, _ = batch_upload_seams + + response = _upload_batch_file({}, {"target_model_names": "my-vllm,gemini-2.0-flash"}) + + assert response.status_code == 400, response.text + assert "my-vllm" in response.text + assert "target_model_names" in response.text + stored.assert_not_awaited() + provider_upload.assert_not_awaited() + + +@pytest.mark.parametrize("purpose", ["assistants", "user_data"]) +def test_non_batch_upload_for_a_litellm_executed_model_is_rejected_with_the_purpose_to_use( + batch_upload_seams, purpose: str +): + stored, provider_upload, _ = batch_upload_seams + + response = _upload_batch_file({"x-litellm-model": "my-vllm"}, {"purpose": purpose}) + + assert response.status_code == 400, response.text + error = response.json()["error"] + assert error["type"] == "invalid_request_error" + assert error["param"] == "purpose" + assert "purpose=batch" in error["message"] + assert f"purpose={purpose}" in error["message"] + stored.assert_not_awaited() + provider_upload.assert_not_awaited() + + +@pytest.mark.parametrize("purpose", ["batch", "assistants"]) +@pytest.mark.parametrize( + "upstream_answer", + [httpx.Response(200, json={"object": "list", "data": []}), httpx.Response(405), httpx.ConnectError("refused")], + ids=["lists files", "files route without list", "unreachable"], +) +def test_upload_for_a_litellm_executed_model_goes_to_the_provider_unless_the_server_lacks_a_files_api( + batch_upload_seams, upstream_answer: httpx.Response | httpx.ConnectError, purpose: str +): + stored, provider_upload, upstream_files_route = batch_upload_seams + upstream_files_route.mock(side_effect=[upstream_answer]) + + response = _upload_batch_file({"x-litellm-model": "my-vllm"}, {"purpose": purpose}) + + assert response.status_code == 200, response.text + stored.assert_not_awaited() + provider_upload.assert_awaited_once() + assert provider_upload.call_args.kwargs["custom_llm_provider"] == "hosted_vllm" + assert provider_upload.call_args.kwargs["api_base"] == "http://vllm.test/v1" + + +@pytest.mark.parametrize( + "form", + [{}, {"target_model_names": "my-vllm"}, {"target_model_names": "gemini-2.0-flash"}], + ids=["no model", "litellm-executed model", "provider model"], +) +def test_upload_naming_litellm_db_as_target_storage_is_rejected(batch_upload_seams, form: dict[str, str]): + stored, provider_upload, upstream_files_route = batch_upload_seams + + response = _upload_batch_file({}, {**form, "target_storage": "litellm_db"}) + + assert response.status_code == 400, response.text + error = response.json()["error"] + assert error["type"] == "invalid_request_error" + assert error["param"] == "target_storage" + assert "litellm_db" in error["message"] + assert upstream_files_route.call_count == 0 + stored.assert_not_awaited() + provider_upload.assert_not_awaited() + + +@pytest.mark.parametrize("purpose", ["user_data", "batch"]) +def test_upload_with_an_explicit_target_storage_goes_where_the_caller_said_without_probing_the_server( + batch_upload_seams, purpose: str +): + stored, provider_upload, upstream_files_route = batch_upload_seams + + response = _upload_batch_file( + {}, {"purpose": purpose, "target_model_names": "my-vllm", "target_storage": "azure_storage"} + ) + + assert response.status_code == 200, response.text + assert upstream_files_route.call_count == 0 + provider_upload.assert_not_awaited() + stored.assert_awaited_once() + kwargs = stored.call_args.kwargs + assert kwargs["target_storage"] == "azure_storage" + assert tuple(kwargs["target_model_names"]) == ("my-vllm",) + assert kwargs["purpose"] == purpose + + +def test_upload_with_an_explicit_target_storage_still_refuses_a_key_without_the_executed_model(batch_upload_seams): + import litellm.proxy.proxy_server as ps + + stored, provider_upload, upstream_files_route = batch_upload_seams + app.dependency_overrides[ps.user_api_key_auth] = lambda: UserAPIKeyAuth( + user_id="restricted-user", models=["gemini-2.0-flash"] + ) + + response = _upload_batch_file({}, {"target_model_names": "my-vllm", "target_storage": "azure_storage"}) + + assert response.status_code == 403, response.text + assert "my-vllm" in response.text + assert upstream_files_route.call_count == 0 + stored.assert_not_awaited() + provider_upload.assert_not_awaited() + + +def test_batch_upload_for_a_provider_model_still_goes_to_the_provider(batch_upload_seams): + stored, provider_upload, _ = batch_upload_seams + + response = _upload_batch_file({"x-litellm-model": "gemini-2.0-flash"}, {}) + + assert response.status_code == 200, response.text + stored.assert_not_awaited() + provider_upload.assert_awaited_once() + assert provider_upload.call_args.kwargs["custom_llm_provider"] == "gemini" + + @pytest.mark.skip(reason="mock respx fails on ci/cd - unclear why") def test_create_file_and_call_chat_completion_e2e( mocker: MockerFixture, monkeypatch, llm_router: Router diff --git a/tests/test_litellm/proxy/openai_files_endpoint/test_storage_backend_service.py b/tests/test_litellm/proxy/openai_files_endpoint/test_storage_backend_service.py index 07a85a70815..81c5803da33 100644 --- a/tests/test_litellm/proxy/openai_files_endpoint/test_storage_backend_service.py +++ b/tests/test_litellm/proxy/openai_files_endpoint/test_storage_backend_service.py @@ -1,3 +1,5 @@ +from unittest.mock import MagicMock + import pytest from litellm.llms.base_llm.files.transformation import BaseFileEndpoints @@ -6,16 +8,24 @@ from litellm.proxy.openai_files_endpoints import storage_backend_service from litellm.proxy.openai_files_endpoints.storage_backend_service import ( StorageBackendFileService, ) +from litellm.proxy.utils import PrismaClient class _RecordingStorageBackend: - def __init__(self): + def __init__(self, delete_error: Exception | None = None): self.upload_calls = [] + self.delete_calls: list[str] = [] + self.delete_error = delete_error async def upload_file(self, **kwargs): self.upload_calls.append(kwargs) return "https://storage.example/blob-1" + async def delete_file(self, storage_url: str) -> None: + self.delete_calls.append(storage_url) + if self.delete_error is not None: + raise self.delete_error + class _FakeManagedFilesHook(BaseFileEndpoints): def __init__(self): @@ -42,6 +52,11 @@ class _FakeManagedFilesHook(BaseFileEndpoints): self.stored.append(kwargs) +class _FailingManagedFilesHook(_FakeManagedFilesHook): + async def store_unified_file_id(self, **kwargs): + raise RuntimeError("db down") + + class _FakeProxyLogging: def __init__(self, hook): self._hook = hook @@ -57,7 +72,7 @@ def _file_data(): @pytest.mark.asyncio async def test_upload_with_target_model_names_but_no_hook_raises_before_uploading(monkeypatch): backend = _RecordingStorageBackend() - monkeypatch.setattr(storage_backend_service, "get_storage_backend", lambda name: backend) + monkeypatch.setattr(storage_backend_service, "get_storage_backend", lambda name, prisma_client=None: backend) with pytest.raises(ProxyException) as exc_info: await StorageBackendFileService.upload_file_to_storage_backend( @@ -80,7 +95,7 @@ async def test_upload_with_target_model_names_but_no_hook_raises_before_uploadin @pytest.mark.asyncio async def test_upload_without_target_model_names_skips_hook_requirement(monkeypatch): backend = _RecordingStorageBackend() - monkeypatch.setattr(storage_backend_service, "get_storage_backend", lambda name: backend) + monkeypatch.setattr(storage_backend_service, "get_storage_backend", lambda name, prisma_client=None: backend) file_object = await StorageBackendFileService.upload_file_to_storage_backend( file_data=_file_data(), @@ -101,7 +116,7 @@ async def test_upload_without_target_model_names_skips_hook_requirement(monkeypa @pytest.mark.asyncio async def test_upload_with_target_model_names_and_hook_stores_unified_id(monkeypatch): backend = _RecordingStorageBackend() - monkeypatch.setattr(storage_backend_service, "get_storage_backend", lambda name: backend) + monkeypatch.setattr(storage_backend_service, "get_storage_backend", lambda name, prisma_client=None: backend) hook = _FakeManagedFilesHook() file_object = await StorageBackendFileService.upload_file_to_storage_backend( @@ -125,3 +140,50 @@ async def test_upload_with_target_model_names_and_hook_stores_unified_id(monkeyp "stored_id_matches_response": True, "model_mappings": {"gpt-x": "https://storage.example/blob-1"}, } + + +@pytest.mark.asyncio +async def test_upload_hands_the_prisma_client_to_the_storage_backend_factory(monkeypatch: pytest.MonkeyPatch): + backend = _RecordingStorageBackend() + factory_calls: list[tuple[str, PrismaClient | None]] = [] + + def _factory(name: str, prisma_client: PrismaClient | None = None) -> _RecordingStorageBackend: + factory_calls.append((name, prisma_client)) + return backend + + monkeypatch.setattr(storage_backend_service, "get_storage_backend", _factory) + prisma_client = MagicMock() + + await StorageBackendFileService.upload_file_to_storage_backend( + file_data=_file_data(), + target_storage="litellm_db", + target_model_names=[], + purpose="batch", + proxy_logging_obj=_FakeProxyLogging(hook=None), + user_api_key_dict=UserAPIKeyAuth(api_key="sk-test"), + prisma_client=prisma_client, + ) + + assert factory_calls == [("litellm_db", prisma_client)] + + +@pytest.mark.asyncio +@pytest.mark.parametrize("delete_error", [None, OSError("blob locked")], ids=["delete succeeds", "delete fails"]) +async def test_upload_deletes_the_uploaded_content_when_the_metadata_write_fails( + monkeypatch: pytest.MonkeyPatch, delete_error: Exception | None +): + backend = _RecordingStorageBackend(delete_error=delete_error) + monkeypatch.setattr(storage_backend_service, "get_storage_backend", lambda name, prisma_client=None: backend) + + with pytest.raises(RuntimeError, match="db down"): + await StorageBackendFileService.upload_file_to_storage_backend( + file_data=_file_data(), + target_storage="azure_storage", + target_model_names=["gpt-x"], + purpose="batch", + proxy_logging_obj=_FakeProxyLogging(hook=_FailingManagedFilesHook()), + user_api_key_dict=UserAPIKeyAuth(api_key="sk-test"), + ) + + assert len(backend.upload_calls) == 1 + assert backend.delete_calls == ["https://storage.example/blob-1"] diff --git a/tests/test_litellm/proxy/proxy_server/test_proxy_config.py b/tests/test_litellm/proxy/proxy_server/test_proxy_config.py index 76e4214c35a..462489f48b0 100644 --- a/tests/test_litellm/proxy/proxy_server/test_proxy_config.py +++ b/tests/test_litellm/proxy/proxy_server/test_proxy_config.py @@ -4526,3 +4526,191 @@ async def test_add_deployment_syncs_ui_settings_even_when_the_model_reconcile_fa await config.add_deployment(prisma_client=prisma_client, proxy_logging_obj=MagicMock()) assert general_settings["allow_agents_for_team_admins"] is True + + +def _websearch_logger_cls(): + from litellm.integrations.websearch_interception.handler import ( + WebSearchInterceptionLogger, + ) + + return WebSearchInterceptionLogger + + +def _run_websearch_init(monkeypatch, stored_params, starting_callbacks): + pc = ProxyConfig() + monkeypatch.setattr(litellm, "callbacks", list(starting_callbacks)) + monkeypatch.setattr( + "litellm.proxy.proxy_server.get_config_param", + AsyncMock(return_value=SimpleNamespace(param_value={"websearch_interception_params": stored_params})) + if stored_params is not None + else AsyncMock(return_value=SimpleNamespace(param_value={})), + ) + asyncio.run(pc.init_websearch_interception_settings_in_db(prisma_client=MagicMock())) + return pc + + +def _poll_websearch_init(pc, monkeypatch, stored_params): + monkeypatch.setattr( + "litellm.proxy.proxy_server.get_config_param", + AsyncMock(return_value=SimpleNamespace(param_value={"websearch_interception_params": stored_params})), + ) + asyncio.run(pc.init_websearch_interception_settings_in_db(prisma_client=MagicMock())) + + +def test_init_websearch_interception_resyncs_after_a_write_drops_the_enabled_flag(monkeypatch): + logger_cls = _websearch_logger_cls() + pc = ProxyConfig() + monkeypatch.setattr(litellm, "callbacks", []) + + _poll_websearch_init(pc, monkeypatch, {"enabled": True, "search_tool_name": "old-tool"}) + _poll_websearch_init(pc, monkeypatch, {"search_tool_name": "new-tool"}) + + registered = [cb for cb in litellm.callbacks if isinstance(cb, logger_cls)] + assert len(registered) == 1 + assert registered[0].search_tool_name == "new-tool" + + +def test_init_websearch_interception_ignores_a_non_list_providers_value(monkeypatch): + logger_cls = _websearch_logger_cls() + + _run_websearch_init( + monkeypatch, + stored_params={"enabled": True, "enabled_providers": "bedrock", "search_tool_name": "stored-tool"}, + starting_callbacks=[], + ) + + registered = [cb for cb in litellm.callbacks if isinstance(cb, logger_cls)] + assert len(registered) == 1 + assert registered[0].enabled_providers == ["bedrock"] + + +def test_init_websearch_interception_absent_key_leaves_callbacks_untouched(monkeypatch): + logger_cls = _websearch_logger_cls() + config_registered = logger_cls(search_tool_name="from-config-yaml") + + _run_websearch_init(monkeypatch, stored_params=None, starting_callbacks=[config_registered]) + + assert litellm.callbacks == [config_registered] + + +def test_init_websearch_interception_without_enabled_key_leaves_callbacks_untouched(monkeypatch): + logger_cls = _websearch_logger_cls() + config_registered = logger_cls(search_tool_name="from-config-yaml") + + _run_websearch_init( + monkeypatch, + stored_params={"search_tool_name": "stored-tool"}, + starting_callbacks=[config_registered], + ) + + assert litellm.callbacks == [config_registered] + + +def test_init_websearch_interception_registers_when_explicitly_enabled(monkeypatch): + logger_cls = _websearch_logger_cls() + + _run_websearch_init( + monkeypatch, + stored_params={"enabled": True, "search_tool_name": "stored-tool"}, + starting_callbacks=[], + ) + + registered = [cb for cb in litellm.callbacks if isinstance(cb, logger_cls)] + assert len(registered) == 1 + assert registered[0].search_tool_name == "stored-tool" + + +def test_init_websearch_interception_treats_string_false_as_disabled(monkeypatch): + logger_cls = _websearch_logger_cls() + existing = logger_cls(search_tool_name="stored-tool") + + _run_websearch_init( + monkeypatch, + stored_params={"enabled": "false", "search_tool_name": "stored-tool"}, + starting_callbacks=[existing], + ) + + assert [cb for cb in litellm.callbacks if isinstance(cb, logger_cls)] == [] + + +def test_init_websearch_interception_empty_providers_falls_back_to_handler_default(monkeypatch): + logger_cls = _websearch_logger_cls() + + _run_websearch_init( + monkeypatch, + stored_params={"enabled": True, "enabled_providers": [], "search_tool_name": "stored-tool"}, + starting_callbacks=[], + ) + + registered = [cb for cb in litellm.callbacks if isinstance(cb, logger_cls)] + assert len(registered) == 1 + assert registered[0].enabled_providers == ["bedrock"] + + +def test_init_websearch_interception_keeps_working_callback_when_new_one_cannot_be_built(monkeypatch): + logger_cls = _websearch_logger_cls() + working = logger_cls(search_tool_name="stored-tool", max_agentic_loops=3) + + _run_websearch_init( + monkeypatch, + stored_params={"enabled": True, "search_tool_name": "stored-tool", "max_agentic_loops": 0}, + starting_callbacks=[working], + ) + + assert litellm.callbacks == [working] + + +def test_init_websearch_interception_disabled_removes_the_callback(monkeypatch): + logger_cls = _websearch_logger_cls() + existing = logger_cls(search_tool_name="stored-tool") + + _run_websearch_init( + monkeypatch, + stored_params={"enabled": False, "search_tool_name": "stored-tool"}, + starting_callbacks=[existing], + ) + + assert [cb for cb in litellm.callbacks if isinstance(cb, logger_cls)] == [] + + +def test_init_websearch_interception_replaces_stale_instance_on_param_change(monkeypatch): + logger_cls = _websearch_logger_cls() + stale = logger_cls(search_tool_name="old-tool", max_agentic_loops=2) + + _run_websearch_init( + monkeypatch, + stored_params={"enabled": True, "search_tool_name": "new-tool", "max_agentic_loops": 7}, + starting_callbacks=[stale], + ) + + registered = [cb for cb in litellm.callbacks if isinstance(cb, logger_cls)] + assert len(registered) == 1 + assert (registered[0].search_tool_name, registered[0].max_agentic_loops) == ("new-tool", 7) + + +def test_init_websearch_interception_honors_enabled_providers(monkeypatch): + logger_cls = _websearch_logger_cls() + + _run_websearch_init( + monkeypatch, + stored_params={"enabled": True, "enabled_providers": ["bedrock", "vertex_ai"]}, + starting_callbacks=[], + ) + + registered = [cb for cb in litellm.callbacks if isinstance(cb, logger_cls)] + assert len(registered) == 1 + assert registered[0].enabled_providers == ["bedrock", "vertex_ai"] + + +def test_websearch_interception_settings_can_be_named_in_supported_db_objects(monkeypatch): + from litellm.proxy import proxy_server + from litellm.proxy._types import ConfigGeneralSettings + + allowlist = ConfigGeneralSettings(supported_db_objects=["websearch_interception_settings"]).supported_db_objects + assert allowlist + + monkeypatch.setattr(proxy_server, "general_settings", {"supported_db_objects": allowlist}) + assert proxy_server.should_load_db_object(object_type="websearch_interception_settings") is True + + monkeypatch.setattr(proxy_server, "general_settings", {"supported_db_objects": ["models"]}) + assert proxy_server.should_load_db_object(object_type="websearch_interception_settings") is False diff --git a/tests/test_litellm/proxy/public_endpoints/test_public_endpoints.py b/tests/test_litellm/proxy/public_endpoints/test_public_endpoints.py index aaa3b205312..680dd4df0ae 100644 --- a/tests/test_litellm/proxy/public_endpoints/test_public_endpoints.py +++ b/tests/test_litellm/proxy/public_endpoints/test_public_endpoints.py @@ -11,12 +11,23 @@ from fastapi.testclient import TestClient from litellm.proxy.auth.user_api_key_auth import user_api_key_auth from litellm.proxy.public_endpoints import router +from litellm.router_strategy.complexity_router.fuse_presets import get_fuse_presets from litellm.types.proxy.management_endpoints.model_management_endpoints import ( ModelGroupInfoProxy, ) from litellm.types.utils import LlmProviders +def test_fuse_presets_route_serves_the_shared_catalog_without_authentication() -> None: + app: Final = FastAPI() + app.include_router(router) + client: Final = TestClient(app) + response: Final = client.get("/public/complexity_router/fuse_presets") + assert response.status_code == 200 + assert response.json() == get_fuse_presets().model_dump(mode="json") + assert client.get("/public/complexity_router/fuse_presets").json() == response.json() + + def test_get_supported_providers_returns_enum_values(): app_instance = FastAPI() app_instance.include_router(router) diff --git a/tests/test_litellm/proxy/spend_tracking/test_baseline_accounting.py b/tests/test_litellm/proxy/spend_tracking/test_baseline_accounting.py new file mode 100644 index 00000000000..a188d65502d --- /dev/null +++ b/tests/test_litellm/proxy/spend_tracking/test_baseline_accounting.py @@ -0,0 +1,199 @@ +from dataclasses import replace +from itertools import groupby +from typing import Final + +import pytest + +import litellm +from litellm.llms.anthropic.cost_calculation import cost_per_token +from litellm.llms.anthropic.prompt_cache_prediction import CountedBreakpoint, CountedPromptCachePlan +from litellm.proxy.spend_tracking.baseline_accounting import ( + BaselineEstimate, + BaselineHistory, + BaselineObservation, + CacheEntry, + advance_baseline_history, +) +from litellm.types.utils import CacheCreationTokenDetails, PromptTokensDetailsWrapper, Usage + + +def _usage() -> Usage: + return Usage( + prompt_tokens=6200, + completion_tokens=30, + total_tokens=6230, + cache_read_input_tokens=0, + cache_creation_input_tokens=6000, + speed="fast", + inference_geo="us", + completion_tokens_details={"reasoning_tokens": 20}, + server_tool_use={"web_search_requests": 1}, + prompt_tokens_details=PromptTokensDetailsWrapper( + text_tokens=200, + cached_tokens=0, + cache_creation_tokens=6000, + cache_write_tokens=6000, + cache_creation_token_details=CacheCreationTokenDetails( + ephemeral_5m_input_tokens=0, ephemeral_1h_input_tokens=6000 + ), + ), + ) + + +def _marker( + name: str = "prefix", ttl: int = 3600, tokens: int = 6000, previous: tuple[str, ...] = () +) -> CountedBreakpoint: + return CountedBreakpoint( + fingerprint=f"{name}:{ttl}", + ttl_seconds=ttl, + prefix_tokens=tokens, + lookback_fingerprints=(*(f"{item}:{ttl}" for item in previous), f"{name}:{ttl}"), + content_fingerprint=name, + lookback_content_fingerprints=(*previous, name), + ) + + +def _observation(request_id: str, started: float = 10000.0, **overrides: object) -> BaselineObservation: + return BaselineObservation.model_validate( + { + "request_id": request_id, + "started_at": started, + "available_at": started + 0.1, + "outcome": "complete", + "baseline_equivalent": False, + "usage": _usage(), + "plan": CountedPromptCachePlan(6200, (_marker(),)), + "minimum_cache_tokens": 4096, + **overrides, + } + ) + + +def _replay(*observations: BaselineObservation) -> tuple[BaselineEstimate, ...]: + history = BaselineHistory() + results: list[BaselineEstimate] = [] + for _, group in groupby(sorted(observations, key=lambda item: item.started_at), key=lambda item: item.started_at): + history, estimates = advance_baseline_history(history, tuple(group)) + results.extend(estimates) + return tuple(results) + + +def test_initial_identical_path_preserves_full_usage_without_counting_or_exclusive_owner() -> None: + initial: Final = _observation("main", baseline_equivalent=True, plan=None, reason="unsupported_request_headers") + background: Final = initial.model_copy(update={"request_id": "background"}) + later: Final = initial.model_copy(update={"request_id": "later", "started_at": 10001.0, "available_at": 10002.0}) + estimates: Final = _replay(initial, background, later) + assert all(item.provenance == "observed_identical" and item.usage == initial.usage for item in estimates) + assert all(item.usage is not initial.usage for item in estimates) + assert all(item.usage.prompt_tokens == 6200 for item in estimates if item.usage is not None) + + +def test_late_divergent_observation_replays_in_event_order_and_removes_initial_zero() -> None: + same: Final = _observation("same", 10001.0, baseline_equivalent=True) + early: Final = _observation("early") + assert _replay(same)[0].provenance == "observed_identical" + replayed: Final = _replay(same, early) + assert replayed == _replay(early, same) + assert replayed[0].usage is None + assert replayed[1].provenance == "modeled" + assert replayed[1].usage is not None and replayed[1].usage.prompt_tokens_details.cached_tokens == 6000 + + +@pytest.mark.parametrize("ttl", [300, 3600]) +def test_prefix_match_expiry_and_usage_pricing_fields(ttl: int) -> None: + plan: Final = CountedPromptCachePlan(6200, (_marker(ttl=ttl),)) + first: Final = _observation("first", baseline_equivalent=True, plan=plan) + # Each replay starts from the original observation, so warm does not refresh the expiry case. + warm: Final = _replay(first, _observation("warm", 10000.0 + ttl - 0.01, plan=plan))[-1] + cold: Final = _replay(first, _observation("cold", 10000.0 + ttl, plan=plan))[-1] + assert warm.reason == "cache_prefix_available" and cold.reason == "cache_prefix_expired" + assert warm.usage is not None and cold.usage is not None + assert warm.usage.prompt_tokens_details.cached_tokens == 6000 + assert cold.usage.prompt_tokens_details.cached_tokens == 0 + assert cold.usage.prompt_tokens_details.cache_creation_tokens == 6000 + unaffected: Final = {"prompt_tokens", "total_tokens", "prompt_tokens_details", "cache_read_input_tokens", "cache_creation_input_tokens"} + assert warm.usage.model_dump(exclude=unaffected) == first.usage.model_dump(exclude=unaffected) + assert cold.usage.model_dump(exclude=unaffected) == first.usage.model_dump(exclude=unaffected) + + +@pytest.mark.parametrize("warm_tail", (False, True)) +def test_growth_lookback_and_mixed_ttl_keep_distinct_read_write_buckets(warm_tail: bool) -> None: + first: Final = _observation("first", baseline_equivalent=True) + grown: Final = CountedPromptCachePlan(7100, (_marker("grown", 3600, 6500, ("prefix",)), _marker("tail", 300, 7000))) + # Initial unseen suffixes remain unknown within their potential pre-existing cache horizon. + second: Final = _replay(first, _observation("second", 10001.0, plan=grown))[-1] + assert second.reason == "history_unavailable" + history: Final = BaselineHistory( + first_at=1.0, last_at=10000.0, equivalent=False, uncertain_before=1.0, + entries=(CacheEntry("tail:300", "tail", 7000, 300, 10000.0, 10300.0),) if warm_tail else (), + ) + _, estimates = advance_baseline_history(history, (_observation("mixed", 10001.0, plan=grown),)) + usage: Final = estimates[0].usage + assert usage is not None + assert usage.prompt_tokens_details.text_tokens == 100 + # Anthropic billing locations: B is the highest 1h breakpoint AFTER the highest hit A. + # https://platform.claude.com/docs/en/build-with-claude/prompt-caching#mixing-different-ttls (2026-09-15) + assert usage.prompt_tokens_details.cached_tokens == (7000 if warm_tail else 0) + assert usage.prompt_tokens_details.cache_creation_token_details.ephemeral_1h_input_tokens == (0 if warm_tail else 6500) + assert usage.prompt_tokens_details.cache_creation_token_details.ephemeral_5m_input_tokens == (0 if warm_tail else 500) + + +@pytest.mark.parametrize("change", ["prefix", "ttl", "unavailable", "failed", "response_cache"]) +def test_uncertainty_and_replays_do_not_manufacture_hits(change: str) -> None: + first: Final = _observation("first", baseline_equivalent=True) + changes: Final = { + "prefix": {"plan": CountedPromptCachePlan(6200, (_marker("changed"),))}, + "ttl": {"plan": CountedPromptCachePlan(6200, (_marker(ttl=300),))}, + "unavailable": {"plan": None, "reason": "token_count_unavailable"}, + "failed": {"outcome": "uncertain", "reason": "incomplete_response"}, + "response_cache": {"outcome": "response_cache"}, + } + second: Final = _observation("second", 10001.0, **changes[change]) + third: Final = _observation("third", 10002.0) + middle, result = _replay(first, second, third)[1:] + assert middle.usage is None + if change in ("unavailable", "failed", "ttl"): + assert result.usage is None + else: + assert result.usage is not None and result.usage.prompt_tokens_details.cached_tokens == 6000 + + +def test_first_token_availability_and_simultaneous_divergence_are_conservative() -> None: + slow: Final = _observation("slow", available_at=10002.0, baseline_equivalent=True) + overlap: Final = _observation("overlap", 10001.0) + assert _replay(slow, overlap)[-1].usage is None + assert all(item.provenance != "observed_identical" for item in _replay(slow, _observation("tie"))) + + +def test_invalid_usage_and_invalid_count_plan_cannot_seed_cache() -> None: + bad: Final = _observation("bad", baseline_equivalent=True, usage=_usage().model_copy(update={"total_tokens": 1})) + assert all(item.usage is None for item in _replay(bad, _observation("next", 10001.0))) + broken: Final = CountedPromptCachePlan(6200, (replace(_marker(), prefix_tokens=7000),)) + assert _replay(_observation("bad", plan=broken))[0].usage is None + + +def test_overlapping_uncertain_request_cannot_be_warmed_by_a_later_callback() -> None: + uncertain: Final = _observation("incomplete", outcome="uncertain", available_at=10010.0) + overlap: Final = _observation("overlap", 10001.0) + during: Final = _observation("during", 10002.0) + after: Final = _observation("after", 10011.0) + warmed: Final = _observation("warmed", 10012.0) + estimates: Final = _replay(uncertain, overlap, during, after, warmed) + assert estimates[1].reason == estimates[2].reason == "concurrent_uncertainty" + assert estimates[3].usage is None + assert estimates[4].usage is not None and estimates[4].usage.prompt_tokens_details.cached_tokens == 6000 + + +def test_modeled_read_cannot_recharge_the_original_private_write_count() -> None: + warm: Final = _replay(_observation("initial", baseline_equivalent=True), _observation("warm", 10001.0))[-1] + assert warm.usage is not None + prices: Final = { + **litellm.get_model_info("claude-opus-5", custom_llm_provider="anthropic"), + "input_cost_per_token": 1e-6, + "output_cost_per_token": 2e-6, + "cache_read_input_token_cost": 1e-7, + "cache_creation_input_token_cost": 1.25e-6, + "provider_specific_entry": {"fast": 2.0, "us": 1.1}, + } + input_cost, output_cost = cost_per_token("claude-opus-5", warm.usage, model_info=prices) + assert input_cost + output_cost == pytest.approx((200 * 1e-6 + 6000 * 1e-7 + 30 * 2e-6) * 2.0 * 1.1) diff --git a/tests/test_litellm/proxy/spend_tracking/test_savings.py b/tests/test_litellm/proxy/spend_tracking/test_savings.py index 615938f2e33..aae966022e3 100644 --- a/tests/test_litellm/proxy/spend_tracking/test_savings.py +++ b/tests/test_litellm/proxy/spend_tracking/test_savings.py @@ -1,4 +1,4 @@ -from typing import Final +from typing import Final, Literal import pytest @@ -23,13 +23,13 @@ pytestmark = pytest.mark.usefixtures("local_model_cost_map") def test_baseline_preserves_anthropic_pricing_fields(modifier: dict[str, str], continuing: bool) -> None: usage: Final = _usage(1000, 0, 1000, 100).model_copy(update=modifier) expected: Final = (_usage(1000, 1000, 0, 100) if continuing else usage).model_copy(update=modifier) - normalized: Final = _baseline_usage(usage, continuing) + normalized: Final = _baseline_usage(expected) cache_fields: Final = {"prompt_tokens_details", "cache_read_input_tokens", "cache_creation_input_tokens"} assert normalized.model_dump(exclude=cache_fields) == usage.model_dump(exclude=cache_fields) assert usage.prompt_tokens_details.cached_tokens == 0 selected_cost: Final = 0.013 assert compute_autorouter_savings( - "claude-opus-5", "claude-sonnet-5", "anthropic", usage, conversation_continuing=continuing, + "claude-opus-5", "claude-sonnet-5", "anthropic", usage, baseline_usage=expected, cost_breakdown={"input_cost": 0.01, "output_cost": 0.003}, ) == pytest.approx(sum(anthropic_cost_per_token("claude-opus-5", expected)) - selected_cost) @@ -41,7 +41,7 @@ def test_anthropic_baseline_keeps_negotiated_prices_with_provider_multiplier() - } usage: Final = _usage(1000, 1000, 0, 100).model_copy(update={"speed": "fast"}) assert compute_autorouter_savings( - "claude-opus-5", "claude-sonnet-5", "anthropic", usage, baseline_info=info, + "claude-opus-5", "claude-sonnet-5", "anthropic", usage, baseline_info=info, baseline_usage=usage, cost_breakdown={"input_cost": 0.01, "output_cost": 0.003}, ) == pytest.approx(0.0015 * 2 - 0.013) @@ -405,146 +405,109 @@ def test_negative_token_counts_clamp_to_zero(): assert result.prompt_caching == 0.0 -def _usage(fresh: int, cached: int, written: int, out: int) -> Usage: +def _usage(fresh: int, cached: int, written: int, out: int, *, hour: bool = False, image: int = 0) -> Usage: """Usage as the spend log records it; `prompt_tokens` is the inclusive total.""" return Usage( prompt_tokens=fresh + cached + written, completion_tokens=out, total_tokens=fresh + cached + written + out, - prompt_tokens_details={"cached_tokens": cached, "cache_creation_tokens": written, "text_tokens": fresh}, + prompt_tokens_details={ + "cached_tokens": cached, "cache_creation_tokens": written, "text_tokens": fresh - image, "image_tokens": image, + "cache_creation_token_details": {"ephemeral_1h_input_tokens": written} if hour else None, + }, cache_read_input_tokens=cached, cache_creation_input_tokens=written, ) -def _savings(baseline: str, selected: str, usage: Usage, continuing: bool = True) -> float: - """Savings for a request, defaulting to a conversation already underway. - - `continuing=True` is the mid-conversation case, where the baseline had the prompt - cached and this request's write is what the switch cost. `continuing=False` is a - conversation's first turn, where nothing was cached for any model. - """ +def _savings(baseline: str, selected: str, usage: Usage, baseline_usage: Usage | None = None) -> float | None: return compute_autorouter_savings( baseline_model=baseline, selected_model=selected, selected_provider="anthropic", usage=usage, - conversation_continuing=continuing, + baseline_usage=baseline_usage, ) -def test_switching_models_mid_conversation_charges_the_cold_cache_write(): - """Staying on one model writes the cache once and reads it thereafter. Switching - leaves the new model cold, so it pays to write the whole prompt again; when that - charge outweighs the cheaper rates the route lost money and must report a loss. - - Pricing the baseline as if it too re-wrote the cache credits a charge it never - paid, which is how a losing switch used to read as the largest saving on the page. - """ - usage = _usage(fresh=3, cached=500, written=12304, out=500) - result = _savings("claude-sonnet-5", "claude-haiku-4-5", usage) - - sonnet = litellm.get_model_info("claude-sonnet-5", "anthropic") - haiku = litellm.get_model_info("claude-haiku-4-5", "anthropic") - warm_baseline = ( - 3 * sonnet["input_cost_per_token"] - + 12804 * sonnet["cache_read_input_token_cost"] - + 500 * sonnet["output_cost_per_token"] +@pytest.mark.parametrize("baseline, selected, actual, modeled, loses_money", [ + pytest.param("claude-sonnet-5", "claude-haiku-4-5", _usage(3, 500, 12304, 500), + _usage(3, 12804, 0, 500), True, id="warm-baseline-cold-route"), + pytest.param("claude-opus-5", "claude-opus-5", _usage(0, 0, 20000, 1000), + _usage(0, 20000, 0, 1000), True, id="same-model-cold-route"), + pytest.param("claude-opus-5", "claude-sonnet-5", _usage(0, 19000, 1000, 1000), + _usage(0, 19500, 500, 1000), False, id="partly-cached-growth"), + pytest.param("claude-opus-5", "claude-sonnet-5", _usage(0, 0, 100000, 1000, hour=True), + _usage(0, 0, 100000, 1000, hour=True), False, id="expired-one-hour"), + pytest.param("claude-opus-5", "claude-sonnet-5", _usage(0, 0, 100000, 1000, hour=True), + _usage(0, 100000, 0, 1000), True, id="invented-one-hour-hit"), + pytest.param("claude-opus-5", "claude-sonnet-5", _usage(4000, 0, 16000, 1000, hour=True, image=4000), + _usage(4000, 0, 16000, 1000, hour=True, image=4000), False, id="image-and-one-hour-write"), +]) +def test_supplied_baseline_usage_is_priced_independently( + baseline: str, selected: str, actual: Usage, modeled: Usage, loses_money: bool, +) -> None: + result: Final = _savings(baseline, selected, actual, modeled) + expected: Final = sum(generic_cost_per_token(model=baseline, usage=modeled, custom_llm_provider="anthropic")) - sum( + generic_cost_per_token(model=selected, usage=actual, custom_llm_provider="anthropic") ) - actually_paid = ( - 3 * haiku["input_cost_per_token"] - + 500 * haiku["cache_read_input_token_cost"] - + 12304 * haiku["cache_creation_input_token_cost"] - + 500 * haiku["output_cost_per_token"] - ) - assert result == pytest.approx(warm_baseline - actually_paid) - assert result < 0, "a cache-thrashing switch must report a loss, not a saving" - - phantom = 12304 * sonnet["cache_creation_input_token_cost"] - assert result != pytest.approx(warm_baseline + phantom - actually_paid) + assert result == pytest.approx(expected) + assert result is not None and (result < 0) is loses_money + assert _baseline_usage(modeled).prompt_tokens_details == modeled.prompt_tokens_details -def test_a_cold_switch_never_beats_turning_caching_off(): - """Switching to a cold model makes it write the whole prompt again. That write is a - real cost of switching, so the same traffic must look worse than if caching were off - entirely. - - The baseline is priced as a warm cache even though this request read nothing: a - switch reads nothing precisely because the new model's cache is empty, and staying - on one model would have had the prompt cached already. Gating the warm baseline on - a read charged the baseline a write it would never repeat, which made a cold switch - report a larger saving than no caching at all. - """ - cold_switch = _savings("anthropic/claude-opus-5", "claude-haiku-4-5", _usage(0, 0, 20_000, 1_000)) - caching_off = _savings("anthropic/claude-opus-5", "claude-haiku-4-5", _usage(20_000, 0, 0, 1_000)) - - assert cold_switch < caching_off - - opus = litellm.get_model_info("claude-opus-5", "anthropic") - haiku = litellm.get_model_info("claude-haiku-4-5", "anthropic") - warm_baseline = 20_000 * opus["cache_read_input_token_cost"] + 1_000 * opus["output_cost_per_token"] - actually_paid = 20_000 * haiku["cache_creation_input_token_cost"] + 1_000 * haiku["output_cost_per_token"] - assert cold_switch == pytest.approx(warm_baseline - actually_paid) +@pytest.mark.parametrize("modifier, multiplier", [({}, 1.0), ({"inference_geo": "us"}, 1.1), ({"speed": "fast"}, 2.0)]) +@pytest.mark.parametrize("negotiated", [False, True]) +@pytest.mark.parametrize("provenance", [None, "modeled", "observed_initial"]) +def test_observed_initial_uses_provider_billing_and_effective_rates( + modifier: dict[str, str], multiplier: float, negotiated: bool, + provenance: Literal["modeled", "observed_initial"] | None, +) -> None: + usage: Final = _usage(1000, 2000, 3000, 100).model_copy(update=modifier) + info: Final = litellm.get_model_info("claude-opus-5", "anthropic").copy() + if negotiated: + info["input_cost_per_token"] = 1e-6 + info["output_cost_per_token"] = 2e-6 + info["cache_read_input_token_cost"] = 3e-7 + info["cache_creation_input_token_cost"] = 4e-6 + billed: Final = anthropic_cost_per_token("claude-opus-5", usage, model_info=info) + if negotiated: + assert sum(billed) == pytest.approx(0.0138 * multiplier) + assert compute_autorouter_savings( + "anthropic/claude-opus-5", "claude-opus-5", "anthropic", usage, + selected_info=info, baseline_info=info, baseline_usage=usage, + baseline_deployment_id="same", selected_deployment_id="same", + cost_breakdown={"input_cost": billed[0], "output_cost": billed[1]}, + baseline_provenance=provenance, + ) == 0.0 -def test_moving_one_token_between_cache_buckets_does_not_move_the_answer(): - """A continuing conversation writes a few new tokens and reads the rest. Treating the - presence of a write as the signal for a switch made that ordinary increment flip the - result, so a request reading 19,999 and writing 1 landed somewhere entirely different - from one reading 20,000 and writing none. - """ - reads_nothing = _savings("anthropic/claude-opus-5", "claude-haiku-4-5", _usage(0, 0, 20_000, 1_000)) - reads_one = _savings("anthropic/claude-opus-5", "claude-haiku-4-5", _usage(0, 1, 19_999, 1_000)) - assert reads_one == pytest.approx(reads_nothing, abs=1e-4) - - -def test_multimodal_prompts_are_priced_on_the_baseline_too(): - """The baseline is this same request met by a warm cache, so every field it was - priced on has to survive. Rebuilding the details from the cache buckets alone - dropped the image and audio counts, which priced the baseline as a text-only - request that never ran and shrank the reported saving on multimodal traffic. - """ - details = {"cached_tokens": 0, "cache_creation_tokens": 16_000, "text_tokens": 0, "image_tokens": 4_000} - with_images = Usage( - prompt_tokens=20_000, - completion_tokens=1_000, - total_tokens=21_000, - prompt_tokens_details=details, - ) - baseline = _baseline_usage(with_images, conversation_continuing=True) - - assert baseline.prompt_tokens_details.image_tokens == 4_000, "image tokens must survive into the baseline" - - opus = litellm.get_model_info("claude-opus-5", "anthropic") - priced, _ = generic_cost_per_token(model="claude-opus-5", usage=baseline, custom_llm_provider="anthropic") - text_only = 20_000 * opus["cache_read_input_token_cost"] - assert priced > text_only, "dropping the image tokens undercharges the baseline and hides the saving" - - -def test_the_baseline_is_never_charged_a_cache_write(): - """Carrying the details through must not carry the 5m/1h creation breakdown with - them. `generic_cost_per_token` charges a creation cost whenever that breakdown is - present, even against a zeroed creation count, which would put the phantom write - back on the baseline for every long-cache request. - """ - long_cache = Usage( - prompt_tokens=20_000, - completion_tokens=1_000, - total_tokens=21_000, - prompt_tokens_details={ - "cached_tokens": 0, - "cache_creation_tokens": 20_000, - "text_tokens": 0, - "cache_creation_token_details": {"ephemeral_1h_input_tokens": 20_000}, - }, - ) - baseline = _baseline_usage(long_cache, conversation_continuing=True) - - opus = litellm.get_model_info("claude-opus-5", "anthropic") - priced, _ = generic_cost_per_token(model="claude-opus-5", usage=baseline, custom_llm_provider="anthropic") - assert priced == pytest.approx(20_000 * opus["cache_read_input_token_cost"]), ( - "the baseline reads a warm cache; it never pays to create one" - ) +@pytest.mark.parametrize("model, deployment, known, delta", [ + ("claude-sonnet-5", "same", "observed", 0.0), + ("claude-opus-5", "other", "observed", 0.0), + ("claude-opus-5", "", "observed", 0.0), + ("claude-opus-5", "same", "missing", 0.0), + ("claude-opus-5", "same", "different", 0.0), + ("claude-opus-5", "same", "observed", 0.01), + ("claude-opus-5", "same", "prices", 0.0), + ("claude-opus-5", "same", "unbilled", 0.0), +]) +def test_initial_provenance_cannot_override_mismatched_evidence( + model: str, deployment: str, known: Literal["observed", "missing", "different", "prices", "unbilled"], delta: float, +) -> None: + usage: Final = _usage(1000, 0, 1000, 100) + billed: Final = anthropic_cost_per_token("claude-opus-5", usage) + info: Final = litellm.get_model_info(model, "anthropic").copy() + if known == "prices": + info["cache_read_input_token_cost"] = 0.001 # No reads here: equal charge alone cannot establish equal rates. + assert compute_autorouter_savings( + "claude-opus-5", model, "anthropic", usage, + baseline_usage=(None if known == "missing" else _usage(1000, 1000, 0, 100) if known == "different" else usage), + selected_info=info, + baseline_provenance="observed_initial", + baseline_deployment_id="same", selected_deployment_id=deployment, + cost_breakdown=None if known == "unbilled" else {"input_cost": billed[0] + delta, "output_cost": billed[1]}, + ) is None def test_uncached_request_is_the_plain_rate_difference(): @@ -565,11 +528,12 @@ def test_escalation_reports_its_real_cost(): def test_autorouter_savings_zero_when_model_unchanged(): - assert _savings("claude-opus-5", "claude-opus-5", _usage(3, 500, 12304, 500)) == 0.0 + usage: Final = _usage(3, 500, 12304, 500) + assert _savings("claude-opus-5", "claude-opus-5", usage, usage) == 0.0 -def test_autorouter_savings_unknown_baseline_fails_open_to_zero(): - assert _savings("totally-made-up-model-xyz", "claude-haiku-4-5", _usage(3, 500, 12304, 500)) == 0.0 +def test_autorouter_savings_unknown_baseline_remains_unknown(): + assert _savings("totally-made-up-model-xyz", "claude-haiku-4-5", _usage(3, 500, 12304, 500)) is None def test_autorouter_savings_zero_without_baseline(): @@ -584,9 +548,7 @@ def test_autorouter_savings_zero_without_baseline(): assert result.autorouter == 0.0 -def test_compute_savings_spend_carries_a_losing_switch_through(): - """The signed value must survive into SavingsSpend; clamping it here would put the - dashboard back to only ever showing gains.""" +def test_compute_savings_spend_carries_a_recorded_losing_switch_through(): result = compute_savings_spend( model="claude-haiku-4-5", custom_llm_provider="anthropic", @@ -594,6 +556,7 @@ def test_compute_savings_spend_carries_a_losing_switch_through(): gateway_injected_cache=True, routing_decision={"conversation_continuing": True, "savings_baseline_model": "anthropic/claude-sonnet-5"}, usage_object=_cached_usage_object(), + recorded_autorouter_savings=-0.01, ) assert result.autorouter < 0 @@ -628,18 +591,10 @@ def test_malformed_usage_object_does_not_fail_the_spend_write(): assert result.compression > 0 -def test_the_same_deployment_spelled_two_ways_is_not_a_switch(): - """The spend log records a normalized model name while the baseline arrives as the - operator wrote it in config. Comparing the raw strings makes a request that never - changed model look like a switch, and prices one deployment against itself.""" - # Must be a cached request: the baseline arm is priced against a warm cache and the - # selected arm against what was actually paid, so treating one deployment as two - # charges it a cold-cache write it never took, inventing a loss on a request that - # never changed model. An uncached request prices identically either way and would - # make this assertion vacuous. - usage = _usage(fresh=3, cached=500, written=12304, out=500) - assert _savings("anthropic/claude-opus-5", "claude-opus-5", usage) == 0.0 - assert _savings("claude-opus-5", "anthropic/claude-opus-5", usage) == 0.0 +def test_equal_modeled_usage_is_zero_under_equivalent_model_names() -> None: + usage: Final = _usage(3, 500, 12304, 500) + assert _savings("anthropic/claude-opus-5", "claude-opus-5", usage, usage) == 0.0 + assert _savings("claude-opus-5", "anthropic/claude-opus-5", usage, usage) == 0.0 def test_baseline_is_priced_under_its_own_provider(): @@ -663,99 +618,9 @@ def test_baseline_is_priced_under_its_own_provider(): assert azure > 0 > deepseek -def test_unresolvable_baseline_fails_open_to_zero(): +def test_unresolvable_baseline_remains_unknown(): usage = _usage(fresh=2000, cached=0, written=0, out=500) - assert _savings("no-such-provider-xyz/no-such-model", "claude-haiku-4-5", usage) == 0.0 - - -def test_a_first_turn_is_the_rate_difference_not_a_switch_penalty(): - """Nothing was cached anywhere on a conversation's first turn, so the baseline would - have paid the same cache write. Charging it to the selected arm alone reported a - fraction of the real saving; on this shape roughly 4% of it. - """ - usage = _usage(fresh=0, cached=0, written=20_000, out=1_000) - first_turn = _savings("anthropic/claude-opus-5", "claude-haiku-4-5", usage, continuing=False) - - opus = litellm.get_model_info("claude-opus-5", "anthropic") - haiku = litellm.get_model_info("claude-haiku-4-5", "anthropic") - both_write = (20_000 * opus["cache_creation_input_token_cost"] + 1_000 * opus["output_cost_per_token"]) - ( - 20_000 * haiku["cache_creation_input_token_cost"] + 1_000 * haiku["output_cost_per_token"] - ) - assert first_turn == pytest.approx(both_write) - - mid_conversation = _savings("anthropic/claude-opus-5", "claude-haiku-4-5", usage) - assert first_turn > mid_conversation * 10, "a first turn must not be priced as a switch" - - -def test_a_first_turn_that_saves_money_never_reports_a_loss(): - """The write premium is fixed by prompt size while the saving grows with completion - length, so charging the write to a first turn made short answers over a large cached - prompt read as losses on requests that genuinely saved. That is the shape most likely - to be on the dashboard, and the sign has to be right. - """ - short_answer = _usage(fresh=0, cached=0, written=20_000, out=200) - assert _savings("anthropic/claude-opus-5", "claude-haiku-4-5", short_answer, continuing=False) > 0 - assert _savings("anthropic/claude-opus-5", "claude-haiku-4-5", short_answer) < 0 - - -def test_an_undetermined_conversation_shape_stays_conservative(): - """The default must charge the write. A caller that cannot be read, or a surface the - router never classified, has said nothing about whether the baseline was warm, and a - savings figure must not inflate on a guess. - """ - usage = _usage(fresh=0, cached=0, written=20_000, out=1_000) - defaulted = compute_autorouter_savings( - baseline_model="anthropic/claude-opus-5", - selected_model="claude-haiku-4-5", - selected_provider="anthropic", - usage=usage, - ) - assert defaulted == pytest.approx(_savings("anthropic/claude-opus-5", "claude-haiku-4-5", usage)) - assert defaulted < _savings("anthropic/claude-opus-5", "claude-haiku-4-5", usage, continuing=False) - - -def test_a_continuing_turn_on_the_same_model_writes_its_growth_on_both_arms(): - """A conversation that grew by a few tokens writes those on whatever model serves - it, and they are new to every model, so the baseline would have written them too. - Moving them into the baseline's read bucket forgives it a write it really owes and - shrinks the reported saving on ordinary steady-state traffic. - """ - usage = _usage(fresh=0, cached=19_900, written=100, out=1_000) - opus = litellm.get_model_info("claude-opus-5", "anthropic") - haiku = litellm.get_model_info("claude-haiku-4-5", "anthropic") - - def cost(info: dict) -> float: - return ( - 19_900 * info["cache_read_input_token_cost"] - + 100 * info["cache_creation_input_token_cost"] - + 1_000 * info["output_cost_per_token"] - ) - - both_write_the_growth = cost(opus) - cost(haiku) - assert _savings("anthropic/claude-opus-5", "claude-haiku-4-5", usage) == pytest.approx(both_write_the_growth) - - -def test_a_switch_onto_a_partly_cached_model_still_pays_for_the_write(): - """A model holding a small prefix of this prompt still has to write the rest, and - that write is the switch's cost. Keying the same-model case off reading *anything* - rather than reading *most of it* would hand this request the full rate gap and - inflate the saving by an order of magnitude. - """ - mostly_written = _usage(fresh=0, cached=500, written=19_500, out=1_000) - reported = _savings("anthropic/claude-opus-5", "claude-haiku-4-5", mostly_written) - - opus = litellm.get_model_info("claude-opus-5", "anthropic") - haiku = litellm.get_model_info("claude-haiku-4-5", "anthropic") - if_treated_as_same_model = ( - 500 * opus["cache_read_input_token_cost"] - + 19_500 * opus["cache_creation_input_token_cost"] - + 1_000 * opus["output_cost_per_token"] - ) - ( - 500 * haiku["cache_read_input_token_cost"] - + 19_500 * haiku["cache_creation_input_token_cost"] - + 1_000 * haiku["output_cost_per_token"] - ) - assert reported < if_treated_as_same_model / 10, "a mostly-cold switch must not be priced as a continuation" + assert _savings("no-such-provider-xyz/no-such-model", "claude-haiku-4-5", usage) is None def test_a_baseline_that_prices_caching_implicitly_still_pays_for_its_prompt(): @@ -771,7 +636,7 @@ def test_a_baseline_that_prices_caching_implicitly_still_pays_for_its_prompt(): selected_model="claude-haiku-4-5", selected_provider="anthropic", usage=first_turn, - conversation_continuing=False, + baseline_usage=first_turn, ) gpt5 = litellm.get_model_info("gpt-5", "openai") @@ -807,7 +672,7 @@ def _priced_chat_model_without_cache_read_rate() -> tuple[str, str, str]: usage=_usage(fresh=1_000, cached=0, written=0, out=100), conversation_continuing=True, ) - if priced == 0.0: + if priced is None or priced == 0.0: continue return key, key.removeprefix(f"{provider}/"), provider raise AssertionError("the bundled map has no per-token chat model without a cache-read rate") @@ -825,7 +690,7 @@ def test_a_baseline_with_no_cache_read_rate_is_charged_its_input_rate(): selected_model="claude-haiku-4-5", selected_provider="anthropic", usage=continuing, - conversation_continuing=True, + baseline_usage=_usage(0, 20000, 0, 1000), ) baseline = litellm.get_model_info(baseline_name, baseline_provider) @@ -966,7 +831,7 @@ def test_a_baseline_recorded_on_the_decision_turns_the_driver_on(): compression_saved_tokens=0, gateway_injected_cache=True, routing_decision={"conversation_continuing": True, "savings_baseline_model": "anthropic/claude-opus-5"}, - usage_object=_cached_usage_object(), + usage_object=_usage(12807, 0, 0, 500).model_dump(), ) assert result.autorouter != 0.0 @@ -981,13 +846,13 @@ def test_a_leftover_configured_baseline_does_not_override_the_recorded_one(monke compression_saved_tokens=0, gateway_injected_cache=True, routing_decision={"conversation_continuing": True, "savings_baseline_model": "anthropic/claude-opus-5"}, - usage_object=_cached_usage_object(), + usage_object=_usage(12807, 0, 0, 500).model_dump(), ) against_opus = compute_autorouter_savings( baseline_model="anthropic/claude-opus-5", selected_model="claude-haiku-4-5", selected_provider="anthropic", - usage=Usage(**_cached_usage_object()), + usage=_usage(12807, 0, 0, 500), ) assert result.autorouter == against_opus @@ -1054,12 +919,12 @@ def test_prompt_caching_prices_at_the_deployment_rate_not_the_public_one(): ("baseline", "selected", 2.0, None, 0.0, -0.015), ("baseline", "selected", 1.0, None, 0.0, 0.0), ("baseline", "selected", 0.1, 0.004, 0.001, 0.01), - ("baseline", "baseline", 0.1, 0.004, 0.001, -0.001), - (None, "selected", 0.1, None, 0.0, 0.0), - ("baseline", None, 0.1, None, 0.0, 0.0), + ("baseline", "baseline", 0.1, 0.004, 0.001, 0.01), + (None, "selected", 0.1, None, 0.0, 0.006), + ("baseline", None, 0.1, None, 0.0, 0.0075), (None, None, 0.1, None, 0.0, 0.0), - ("", "selected", 0.1, None, 0.0, 0.0), - ("baseline", "", 0.1, None, 0.0, 0.0), + ("", "selected", 0.1, None, 0.0, 0.006), + ("baseline", "", 0.1, None, 0.0, 0.0075), ], ) def test_autorouter_savings_distinguishes_priced_deployments( @@ -1172,7 +1037,7 @@ def test_a_recorded_baseline_deployment_prices_at_its_configured_rate(): compression_saved_tokens=0, gateway_injected_cache=True, routing_decision=decision, - usage_object=_cached_usage_object(), + usage_object=_usage(12807, 0, 0, 500).model_dump(), llm_router=lambda: router, ) at_public_rate = compute_savings_spend( @@ -1181,7 +1046,7 @@ def test_a_recorded_baseline_deployment_prices_at_its_configured_rate(): compression_saved_tokens=0, gateway_injected_cache=True, routing_decision={k: v for k, v in decision.items() if k != "savings_baseline_deployment_id"}, - usage_object=_cached_usage_object(), + usage_object=_usage(12807, 0, 0, 500).model_dump(), llm_router=lambda: router, ) assert with_deployment_rate.autorouter > at_public_rate.autorouter @@ -1234,9 +1099,8 @@ def test_a_boolean_is_not_a_recorded_savings_figure(): assert result.autorouter == 0.0 -def test_rows_written_before_the_field_shipped_recompute(): - """No recorded figure means the row predates the logging-path stamp; the writer - recomputes exactly what the one shared helper would have recorded.""" +@pytest.mark.parametrize("continuing", [False, True]) +def test_legacy_cache_rows_without_an_estimate_do_not_invent_a_new_figure(continuing: bool) -> None: from litellm.proxy.spend_tracking.savings import autorouter_savings_for_request recomputed = compute_savings_spend( @@ -1244,17 +1108,17 @@ def test_rows_written_before_the_field_shipped_recompute(): custom_llm_provider="anthropic", compression_saved_tokens=0, gateway_injected_cache=False, - routing_decision=_routed_decision(), + routing_decision={**_routed_decision(), "conversation_continuing": continuing}, usage_object=_cached_usage_object(), ) direct = autorouter_savings_for_request( model="claude-haiku-4-5", custom_llm_provider="anthropic", - routing_decision=_routed_decision(), + routing_decision={**_routed_decision(), "conversation_continuing": continuing}, usage_object=_cached_usage_object(), ) - assert direct is not None and direct != 0.0 - assert recomputed.autorouter == direct + assert direct is None + assert recomputed.autorouter == 0.0 def test_driver_off_is_none_not_zero_for_the_request_helper(): @@ -1294,7 +1158,7 @@ def test_logging_payload_never_stamps_internal_calls(): model="claude-haiku-4-5", custom_llm_provider="anthropic", model_id=None, - usage_object=_cached_usage_object(), + usage_object=_usage(12807, 0, 0, 500).model_dump(), cost_breakdown=None, ) assert stamped is not None and stamped != 0.0 @@ -1304,7 +1168,7 @@ def test_logging_payload_never_stamps_internal_calls(): model="claude-haiku-4-5", custom_llm_provider="anthropic", model_id=None, - usage_object=_cached_usage_object(), + usage_object=_usage(12807, 0, 0, 500).model_dump(), cost_breakdown=None, ) assert internal is None @@ -1320,13 +1184,13 @@ def test_savings_are_net_of_a_priced_classifier(): model="claude-haiku-4-5", custom_llm_provider="anthropic", routing_decision=_routed_decision(), - usage_object=_cached_usage_object(), + usage_object=_usage(12807, 0, 0, 500).model_dump(), ) net = autorouter_savings_for_request( model="claude-haiku-4-5", custom_llm_provider="anthropic", routing_decision={**_routed_decision(), "classifier_cost": 0.005}, - usage_object=_cached_usage_object(), + usage_object=_usage(12807, 0, 0, 500).model_dump(), ) assert gross is not None and net == pytest.approx(gross - 0.005) @@ -1339,13 +1203,13 @@ def test_an_unpriced_classifier_deducts_nothing(classifier_cost: object): model="claude-haiku-4-5", custom_llm_provider="anthropic", routing_decision=_routed_decision(), - usage_object=_cached_usage_object(), + usage_object=_usage(12807, 0, 0, 500).model_dump(), ) with_cost_field = autorouter_savings_for_request( model="claude-haiku-4-5", custom_llm_provider="anthropic", routing_decision={**_routed_decision(), "classifier_cost": classifier_cost}, - usage_object=_cached_usage_object(), + usage_object=_usage(12807, 0, 0, 500).model_dump(), ) assert with_cost_field == gross @@ -1454,4 +1318,41 @@ def test_marks_gateway_injection_credits_only_the_deployment_that_was_injected() assert marks_gateway_injection({"litellm_gateway_injected_cache": ""}, "dep-a") is True assert marks_gateway_injection({"litellm_gateway_injected_cache": ""}, None) is True assert marks_gateway_injection({"litellm_call_id": "c1"}, "dep-a") is False + + +@pytest.mark.parametrize("classifier", [0.0, 0.02]) +def test_observed_baseline_keeps_both_costs_and_classifier_overhead(classifier: float) -> None: + from litellm.proxy.spend_tracking.savings import BaselineCostSnapshot, price_baseline_comparison + + snapshot: Final = BaselineCostSnapshot( + model="baseline", provider="anthropic", prices=None, + actual_spend=0.17, classifier_cost=classifier, + ) + restored: Final = BaselineCostSnapshot.model_validate_json(snapshot.model_dump_json()) + result: Final = price_baseline_comparison(restored, Usage(prompt_tokens=100, completion_tokens=10), "observed_identical") + assert result is not None + assert result.baseline == snapshot.actual_spend + assert result.actual == snapshot.actual_spend + classifier + assert result.savings == pytest.approx(-classifier) + assert price_baseline_comparison(restored, None, None) is None + + +def test_modeled_baseline_uses_recorded_prices_and_preserves_other_actual_charges() -> None: + from litellm.proxy.spend_tracking.savings import BaselineCostSnapshot, price_baseline_comparison + + snapshot: Final = BaselineCostSnapshot( + model="claude-opus-5", provider="anthropic", + prices={ + **litellm.get_model_info("claude-opus-5", custom_llm_provider="anthropic"), + "input_cost_per_token": 0.001, "output_cost_per_token": 0.002, + }, + actual_token_cost=0.2, actual_spend=0.23, classifier_cost=0.01, + ) + usage: Final = Usage(prompt_tokens=100, completion_tokens=10) + result: Final = price_baseline_comparison(snapshot, usage, "modeled") + assert result is not None + assert result.actual == pytest.approx(0.24) + assert result.baseline == pytest.approx(0.12 + 0.03) + assert result.savings == pytest.approx(-0.09) + assert price_baseline_comparison(snapshot.model_copy(update={"prices": None}), usage, "modeled") is None assert marks_gateway_injection({"litellm_gateway_injected_cache": True}, "dep-a") is False diff --git a/tests/test_litellm/proxy/spend_tracking/test_spend_management_endpoints.py b/tests/test_litellm/proxy/spend_tracking/test_spend_management_endpoints.py index 8d15fb094d5..9de6679472e 100644 --- a/tests/test_litellm/proxy/spend_tracking/test_spend_management_endpoints.py +++ b/tests/test_litellm/proxy/spend_tracking/test_spend_management_endpoints.py @@ -3745,7 +3745,7 @@ class TestSpendLogsPayload: "model": "gpt-4o", "user": "", "team_id": "", - "metadata": '{"applied_guardrails": [], "attempted_fallbacks": null, "original_model_group": null, "batch_models": null, "batch_successful_requests": null, "batch_failed_requests": null, "mcp_tool_call_metadata": null, "vector_store_request_metadata": null, "routing_decision": null, "internal_call_origin": null, "guardrail_information": null, "compression_savings": null, "litellm_gateway_injected_cache": null, "router_metadata": null, "azure_spillover": null, "usage_object": {"completion_tokens": 20, "prompt_tokens": 10, "total_tokens": 30, "completion_tokens_details": null, "prompt_tokens_details": null}, "model_map_information": {"model_map_key": "gpt-4o", "model_map_value": {"key": "gpt-4o", "max_tokens": 16384, "max_input_tokens": 128000, "max_output_tokens": 16384, "input_cost_per_token": 2.5e-06, "cache_creation_input_token_cost": null, "cache_read_input_token_cost": 1.25e-06, "input_cost_per_character": null, "input_cost_per_token_above_128k_tokens": null, "input_cost_per_token_above_200k_tokens": null, "input_cost_per_query": null, "input_cost_per_second": null, "input_cost_per_audio_token": null, "input_cost_per_token_batches": 1.25e-06, "output_cost_per_token_batches": 5e-06, "output_cost_per_token": 1e-05, "output_cost_per_audio_token": null, "output_cost_per_character": null, "output_cost_per_token_above_128k_tokens": null, "output_cost_per_character_above_128k_tokens": null, "output_cost_per_token_above_200k_tokens": null, "output_cost_per_second": null, "output_cost_per_reasoning_token": null, "output_cost_per_image": null, "output_vector_size": null, "litellm_provider": "openai", "mode": "chat", "supports_system_messages": true, "supports_response_schema": true, "supports_vision": true, "supports_function_calling": true, "supports_tool_choice": true, "supports_assistant_prefill": false, "supports_prompt_caching": true, "supports_audio_input": false, "supports_audio_output": false, "supports_pdf_input": false, "supports_embedding_image_input": false, "supports_native_streaming": null, "supports_web_search": true, "supports_reasoning": false, "search_context_cost_per_query": {"search_context_size_low": 0.03, "search_context_size_medium": 0.035, "search_context_size_high": 0.05}, "tpm": null, "rpm": null, "supported_openai_params": ["frequency_penalty", "logit_bias", "logprobs", "top_logprobs", "max_tokens", "max_completion_tokens", "modalities", "prediction", "n", "presence_penalty", "seed", "stop", "stream", "stream_options", "temperature", "top_p", "tools", "tool_choice", "function_call", "functions", "max_retries", "extra_headers", "parallel_tool_calls", "audio", "response_format", "user"]}}, "additional_usage_values": {"completion_tokens_details": null, "prompt_tokens_details": null}}', + "metadata": '{"applied_guardrails": [], "attempted_fallbacks": null, "original_model_group": null, "batch_models": null, "batch_successful_requests": null, "batch_failed_requests": null, "mcp_tool_call_metadata": null, "vector_store_request_metadata": null, "routing_decision": null, "internal_call_origin": null, "guardrail_information": null, "compression_savings": null, "litellm_gateway_injected_cache": null, "router_metadata": null, "autorouter_savings_estimate": null, "autorouter_baseline_observation": null, "azure_spillover": null, "usage_object": {"completion_tokens": 20, "prompt_tokens": 10, "total_tokens": 30, "completion_tokens_details": null, "prompt_tokens_details": null}, "model_map_information": {"model_map_key": "gpt-4o", "model_map_value": {"key": "gpt-4o", "max_tokens": 16384, "max_input_tokens": 128000, "max_output_tokens": 16384, "input_cost_per_token": 2.5e-06, "cache_creation_input_token_cost": null, "cache_read_input_token_cost": 1.25e-06, "input_cost_per_character": null, "input_cost_per_token_above_128k_tokens": null, "input_cost_per_token_above_200k_tokens": null, "input_cost_per_query": null, "input_cost_per_second": null, "input_cost_per_audio_token": null, "input_cost_per_token_batches": 1.25e-06, "output_cost_per_token_batches": 5e-06, "output_cost_per_token": 1e-05, "output_cost_per_audio_token": null, "output_cost_per_character": null, "output_cost_per_token_above_128k_tokens": null, "output_cost_per_character_above_128k_tokens": null, "output_cost_per_token_above_200k_tokens": null, "output_cost_per_second": null, "output_cost_per_reasoning_token": null, "output_cost_per_image": null, "output_vector_size": null, "litellm_provider": "openai", "mode": "chat", "supports_system_messages": true, "supports_response_schema": true, "supports_vision": true, "supports_function_calling": true, "supports_tool_choice": true, "supports_assistant_prefill": false, "supports_prompt_caching": true, "supports_audio_input": false, "supports_audio_output": false, "supports_pdf_input": false, "supports_embedding_image_input": false, "supports_native_streaming": null, "supports_web_search": true, "supports_reasoning": false, "search_context_cost_per_query": {"search_context_size_low": 0.03, "search_context_size_medium": 0.035, "search_context_size_high": 0.05}, "tpm": null, "rpm": null, "supported_openai_params": ["frequency_penalty", "logit_bias", "logprobs", "top_logprobs", "max_tokens", "max_completion_tokens", "modalities", "prediction", "n", "presence_penalty", "seed", "stop", "stream", "stream_options", "temperature", "top_p", "tools", "tool_choice", "function_call", "functions", "max_retries", "extra_headers", "parallel_tool_calls", "audio", "response_format", "user"]}}, "additional_usage_values": {"completion_tokens_details": null, "prompt_tokens_details": null}}', "cache_key": "Cache OFF", "spend": 0.00022500000000000002, "total_tokens": 30, @@ -3841,7 +3841,7 @@ class TestSpendLogsPayload: "model": "claude-4-sonnet-20250514", "user": "", "team_id": "", - "metadata": '{"applied_guardrails": [], "attempted_fallbacks": null, "original_model_group": null, "batch_models": null, "batch_successful_requests": null, "batch_failed_requests": null, "mcp_tool_call_metadata": null, "vector_store_request_metadata": null, "routing_decision": null, "internal_call_origin": null, "guardrail_information": null, "compression_savings": null, "litellm_gateway_injected_cache": null, "router_metadata": null, "azure_spillover": null, "usage_object": {"completion_tokens": 503, "prompt_tokens": 2095, "total_tokens": 2598, "completion_tokens_details": null, "prompt_tokens_details": {"audio_tokens": null, "cached_tokens": 0}, "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0}, "model_map_information": {"model_map_key": "claude-4-sonnet-20250514", "model_map_value": {"key": "claude-4-sonnet-20250514", "max_tokens": 128000, "max_input_tokens": 200000, "max_output_tokens": 128000, "input_cost_per_token": 3e-06, "cache_creation_input_token_cost": 3.75e-06, "cache_read_input_token_cost": 3e-07, "input_cost_per_character": null, "input_cost_per_token_above_128k_tokens": null, "input_cost_per_token_above_200k_tokens": null, "input_cost_per_query": null, "input_cost_per_second": null, "input_cost_per_audio_token": null, "input_cost_per_token_batches": null, "output_cost_per_token_batches": null, "output_cost_per_token": 1.5e-05, "output_cost_per_audio_token": null, "output_cost_per_character": null, "output_cost_per_token_above_128k_tokens": null, "output_cost_per_character_above_128k_tokens": null, "output_cost_per_token_above_200k_tokens": null, "output_cost_per_second": null, "output_cost_per_image": null, "output_vector_size": null, "litellm_provider": "anthropic", "mode": "chat", "supports_system_messages": null, "supports_response_schema": true, "supports_vision": true, "supports_function_calling": true, "supports_tool_choice": true, "supports_assistant_prefill": true, "supports_prompt_caching": true, "supports_audio_input": false, "supports_audio_output": false, "supports_pdf_input": true, "supports_embedding_image_input": false, "supports_native_streaming": null, "supports_web_search": false, "supports_reasoning": true, "search_context_cost_per_query": null, "tpm": null, "rpm": null, "supported_openai_params": ["stream", "stop", "temperature", "top_p", "max_tokens", "max_completion_tokens", "tools", "tool_choice", "extra_headers", "parallel_tool_calls", "response_format", "user", "reasoning_effort", "thinking"]}}, "additional_usage_values": {"completion_tokens_details": {"accepted_prediction_tokens": null, "audio_tokens": null, "reasoning_tokens": null, "rejected_prediction_tokens": null, "text_tokens": 503, "image_tokens": null}, "prompt_tokens_details": {"audio_tokens": null, "cached_tokens": 0, "text_tokens": null, "image_tokens": null}, "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0}}', + "metadata": '{"applied_guardrails": [], "attempted_fallbacks": null, "original_model_group": null, "batch_models": null, "batch_successful_requests": null, "batch_failed_requests": null, "mcp_tool_call_metadata": null, "vector_store_request_metadata": null, "routing_decision": null, "internal_call_origin": null, "guardrail_information": null, "compression_savings": null, "litellm_gateway_injected_cache": null, "router_metadata": null, "autorouter_savings_estimate": null, "autorouter_baseline_observation": null, "azure_spillover": null, "usage_object": {"completion_tokens": 503, "prompt_tokens": 2095, "total_tokens": 2598, "completion_tokens_details": null, "prompt_tokens_details": {"audio_tokens": null, "cached_tokens": 0}, "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0}, "model_map_information": {"model_map_key": "claude-4-sonnet-20250514", "model_map_value": {"key": "claude-4-sonnet-20250514", "max_tokens": 128000, "max_input_tokens": 200000, "max_output_tokens": 128000, "input_cost_per_token": 3e-06, "cache_creation_input_token_cost": 3.75e-06, "cache_read_input_token_cost": 3e-07, "input_cost_per_character": null, "input_cost_per_token_above_128k_tokens": null, "input_cost_per_token_above_200k_tokens": null, "input_cost_per_query": null, "input_cost_per_second": null, "input_cost_per_audio_token": null, "input_cost_per_token_batches": null, "output_cost_per_token_batches": null, "output_cost_per_token": 1.5e-05, "output_cost_per_audio_token": null, "output_cost_per_character": null, "output_cost_per_token_above_128k_tokens": null, "output_cost_per_character_above_128k_tokens": null, "output_cost_per_token_above_200k_tokens": null, "output_cost_per_second": null, "output_cost_per_image": null, "output_vector_size": null, "litellm_provider": "anthropic", "mode": "chat", "supports_system_messages": null, "supports_response_schema": true, "supports_vision": true, "supports_function_calling": true, "supports_tool_choice": true, "supports_assistant_prefill": true, "supports_prompt_caching": true, "supports_audio_input": false, "supports_audio_output": false, "supports_pdf_input": true, "supports_embedding_image_input": false, "supports_native_streaming": null, "supports_web_search": false, "supports_reasoning": true, "search_context_cost_per_query": null, "tpm": null, "rpm": null, "supported_openai_params": ["stream", "stop", "temperature", "top_p", "max_tokens", "max_completion_tokens", "tools", "tool_choice", "extra_headers", "parallel_tool_calls", "response_format", "user", "reasoning_effort", "thinking"]}}, "additional_usage_values": {"completion_tokens_details": {"accepted_prediction_tokens": null, "audio_tokens": null, "reasoning_tokens": null, "rejected_prediction_tokens": null, "text_tokens": 503, "image_tokens": null}, "prompt_tokens_details": {"audio_tokens": null, "cached_tokens": 0, "text_tokens": null, "image_tokens": null}, "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0}}', "cache_key": "Cache OFF", "spend": 0.01383, "total_tokens": 2598, @@ -3935,7 +3935,7 @@ class TestSpendLogsPayload: "model": "claude-4-sonnet-20250514", "user": "", "team_id": "", - "metadata": '{"applied_guardrails": [], "attempted_fallbacks": 0, "original_model_group": "my-anthropic-model-group", "batch_models": null, "batch_successful_requests": null, "batch_failed_requests": null, "mcp_tool_call_metadata": null, "vector_store_request_metadata": null, "routing_decision": null, "internal_call_origin": null, "guardrail_information": null, "compression_savings": null, "litellm_gateway_injected_cache": null, "router_metadata": null, "azure_spillover": null, "usage_object": {"completion_tokens": 503, "prompt_tokens": 2095, "total_tokens": 2598, "completion_tokens_details": null, "prompt_tokens_details": {"audio_tokens": null, "cached_tokens": 0}, "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0}, "model_map_information": {"model_map_key": "claude-4-sonnet-20250514", "model_map_value": {"key": "claude-4-sonnet-20250514", "max_tokens": 128000, "max_input_tokens": 200000, "max_output_tokens": 128000, "input_cost_per_token": 3e-06, "cache_creation_input_token_cost": 3.75e-06, "cache_read_input_token_cost": 3e-07, "input_cost_per_character": null, "input_cost_per_token_above_128k_tokens": null, "input_cost_per_token_above_200k_tokens": null, "input_cost_per_query": null, "input_cost_per_second": null, "input_cost_per_audio_token": null, "input_cost_per_token_batches": null, "output_cost_per_token_batches": null, "output_cost_per_token": 1.5e-05, "output_cost_per_audio_token": null, "output_cost_per_character": null, "output_cost_per_token_above_128k_tokens": null, "output_cost_per_character_above_128k_tokens": null, "output_cost_per_token_above_200k_tokens": null, "output_cost_per_second": null, "output_cost_per_image": null, "output_vector_size": null, "litellm_provider": "anthropic", "mode": "chat", "supports_system_messages": null, "supports_response_schema": true, "supports_vision": true, "supports_function_calling": true, "supports_tool_choice": true, "supports_assistant_prefill": true, "supports_prompt_caching": true, "supports_audio_input": false, "supports_audio_output": false, "supports_pdf_input": true, "supports_embedding_image_input": false, "supports_native_streaming": null, "supports_web_search": false, "supports_reasoning": true, "search_context_cost_per_query": null, "tpm": null, "rpm": null, "supported_openai_params": ["stream", "stop", "temperature", "top_p", "max_tokens", "max_completion_tokens", "tools", "tool_choice", "extra_headers", "parallel_tool_calls", "response_format", "user", "reasoning_effort", "thinking"]}}, "additional_usage_values": {"completion_tokens_details": {"accepted_prediction_tokens": null, "audio_tokens": null, "reasoning_tokens": null, "rejected_prediction_tokens": null, "text_tokens": 503, "image_tokens": null}, "prompt_tokens_details": {"audio_tokens": null, "cached_tokens": 0, "text_tokens": null, "image_tokens": null}, "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0}}', + "metadata": '{"applied_guardrails": [], "attempted_fallbacks": 0, "original_model_group": "my-anthropic-model-group", "batch_models": null, "batch_successful_requests": null, "batch_failed_requests": null, "mcp_tool_call_metadata": null, "vector_store_request_metadata": null, "routing_decision": null, "internal_call_origin": null, "guardrail_information": null, "compression_savings": null, "litellm_gateway_injected_cache": null, "router_metadata": null, "autorouter_savings_estimate": null, "autorouter_baseline_observation": null, "azure_spillover": null, "usage_object": {"completion_tokens": 503, "prompt_tokens": 2095, "total_tokens": 2598, "completion_tokens_details": null, "prompt_tokens_details": {"audio_tokens": null, "cached_tokens": 0}, "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0}, "model_map_information": {"model_map_key": "claude-4-sonnet-20250514", "model_map_value": {"key": "claude-4-sonnet-20250514", "max_tokens": 128000, "max_input_tokens": 200000, "max_output_tokens": 128000, "input_cost_per_token": 3e-06, "cache_creation_input_token_cost": 3.75e-06, "cache_read_input_token_cost": 3e-07, "input_cost_per_character": null, "input_cost_per_token_above_128k_tokens": null, "input_cost_per_token_above_200k_tokens": null, "input_cost_per_query": null, "input_cost_per_second": null, "input_cost_per_audio_token": null, "input_cost_per_token_batches": null, "output_cost_per_token_batches": null, "output_cost_per_token": 1.5e-05, "output_cost_per_audio_token": null, "output_cost_per_character": null, "output_cost_per_token_above_128k_tokens": null, "output_cost_per_character_above_128k_tokens": null, "output_cost_per_token_above_200k_tokens": null, "output_cost_per_second": null, "output_cost_per_image": null, "output_vector_size": null, "litellm_provider": "anthropic", "mode": "chat", "supports_system_messages": null, "supports_response_schema": true, "supports_vision": true, "supports_function_calling": true, "supports_tool_choice": true, "supports_assistant_prefill": true, "supports_prompt_caching": true, "supports_audio_input": false, "supports_audio_output": false, "supports_pdf_input": true, "supports_embedding_image_input": false, "supports_native_streaming": null, "supports_web_search": false, "supports_reasoning": true, "search_context_cost_per_query": null, "tpm": null, "rpm": null, "supported_openai_params": ["stream", "stop", "temperature", "top_p", "max_tokens", "max_completion_tokens", "tools", "tool_choice", "extra_headers", "parallel_tool_calls", "response_format", "user", "reasoning_effort", "thinking"]}}, "additional_usage_values": {"completion_tokens_details": {"accepted_prediction_tokens": null, "audio_tokens": null, "reasoning_tokens": null, "rejected_prediction_tokens": null, "text_tokens": 503, "image_tokens": null}, "prompt_tokens_details": {"audio_tokens": null, "cached_tokens": 0, "text_tokens": null, "image_tokens": null}, "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0}}', "cache_key": "Cache OFF", "spend": 0.01383, "total_tokens": 2598, diff --git a/tests/test_litellm/proxy/spend_tracking/test_spend_tracking_utils.py b/tests/test_litellm/proxy/spend_tracking/test_spend_tracking_utils.py index 0004711954a..f471e3f8fbb 100644 --- a/tests/test_litellm/proxy/spend_tracking/test_spend_tracking_utils.py +++ b/tests/test_litellm/proxy/spend_tracking/test_spend_tracking_utils.py @@ -3,6 +3,7 @@ import datetime import json from collections.abc import Callable, Mapping from datetime import timezone +from types import MappingProxyType from typing import Any, Final, cast from unittest.mock import AsyncMock, MagicMock, patch @@ -5208,3 +5209,17 @@ def test_azure_spillover_absent_without_spillover_headers(): ) metadata = json.loads(payload["metadata"]) assert metadata["azure_spillover"] is None + + +def test_baseline_estimate_metadata_comes_from_the_logging_stamp() -> None: + supplied: Final = MappingProxyType({"version": 1, "status": "estimated", "reason": "caller_supplied"}) + recorded: Final = MappingProxyType({"version": 1, "status": "unknown", "reason": "history_unavailable"}) + result: Final = _get_spend_logs_metadata( + {"autorouter_savings": 999.0, "autorouter_savings_estimate": supplied}, # mutable-ok: legacy metadata helper accepts dicts + autorouter_savings=None, + autorouter_savings_estimate=recorded, + ) + assert result["autorouter_savings"] is None + assert result["autorouter_savings_estimate"] == recorded + absent: Final = _get_spend_logs_metadata({"autorouter_savings_estimate": supplied}) # mutable-ok: legacy metadata helper accepts dicts + assert absent["autorouter_savings_estimate"] is None diff --git a/tests/test_litellm/proxy/test_proxy_cli.py b/tests/test_litellm/proxy/test_proxy_cli.py index 712c526b244..c806725d594 100644 --- a/tests/test_litellm/proxy/test_proxy_cli.py +++ b/tests/test_litellm/proxy/test_proxy_cli.py @@ -21,6 +21,15 @@ from uvicorn.importer import import_from_string from litellm.proxy.proxy_cli import ProxyInitializationHelpers, run_server +@pytest.fixture(autouse=True) +def fork_reservation(): + """Reserving is irreversible: it would forbid native routes in this pytest worker for good""" + with patch( # test-quality-ok: process-global native state, a real reservation would poison every later test in the worker + "litellm.rust_bridge.fork_guard.reserve_process_for_forking" + ) as reserve: + yield reserve + + @pytest.mark.xdist_group("proxy_cli") class TestProxyInitializationHelpers: @patch("importlib.metadata.version") @@ -1574,6 +1583,32 @@ class TestProxyInitializationHelpers: assert captured["options"]["max_requests"] == 1000 assert captured["options"]["max_requests_jitter"] == 50 + @pytest.mark.skipif(os.name == "nt", reason="gunicorn server path skips Windows") + def test_gunicorn_master_is_reserved_for_forking_before_it_runs(self, fork_reservation): + """preload forks workers from the master, so native routes are forbidden there first""" + pytest.importorskip("gunicorn") + reserved_before_run: list = [] + + def capture_run(self): + reserved_before_run.append(fork_reservation.call_args) + + with ( + patch("gunicorn.app.base.BaseApplication.run", capture_run), + patch( # test-quality-ok: option tests must not start a thread or change the pytest worker's child ownership + "litellm.proxy.proxy_cli.start_query_engine_reaper" + ), + ): + ProxyInitializationHelpers._run_gunicorn_server( + host="127.0.0.1", + port=4012, + app=MagicMock(), + num_workers=2, + ssl_certfile_path=None, + ssl_keyfile_path=None, + ) + + assert [call.args for call in reserved_before_run] == [("the gunicorn master",)] + @pytest.mark.skipif(os.name == "nt", reason="gunicorn server path skips Windows") def test_gunicorn_jitter_without_base_warns(self): """gunicorn path warns when jitter is set without --max_requests_before_restart""" diff --git a/tests/test_litellm/proxy/test_proxy_server.py b/tests/test_litellm/proxy/test_proxy_server.py index 935cc6ad8b7..08a4621de24 100644 --- a/tests/test_litellm/proxy/test_proxy_server.py +++ b/tests/test_litellm/proxy/test_proxy_server.py @@ -14737,3 +14737,99 @@ async def test_auth_cache_invalidation_subscriber_evicts_byok_credentials_cached byok_credential_cache.flush_cache() assert evicted, "the subscriber does not evict the BYOK credential cache on a peer worker's broadcast" + + +@pytest.mark.asyncio +async def test_delete_config_general_settings_refuses_a_key_the_config_file_owns(monkeypatch): + from litellm.proxy._types import ConfigFieldDelete + from litellm.proxy.proxy_server import ProxyConfig, delete_config_general_settings + + pc = ProxyConfig() + pc._load_yaml_settings_stores({"general_settings": {"max_request_size_mb": 42}}) + monkeypatch.setattr(proxy_server_module, "proxy_config", pc) + monkeypatch.setattr(proxy_server_module, "prisma_client", _fake_prisma_with_config({"max_request_size_mb": 99})) + + admin = UserAPIKeyAuth(api_key="hashed-admin", user_id="admin-1", user_role=LitellmUserRoles.PROXY_ADMIN) + with pytest.raises(HTTPException) as refused: + await delete_config_general_settings( + data=ConfigFieldDelete(field_name="max_request_size_mb", config_type="general_settings"), + user_api_key_dict=admin, + ) + + assert refused.value.status_code == 400 + assert refused.value.detail["keys"] == ["max_request_size_mb"] + assert "config file" in refused.value.detail["error"] + assert pc.settings["max_request_size_mb"] == 42 + + +@pytest.mark.asyncio +async def test_delete_config_general_settings_still_removes_a_key_the_database_owns(monkeypatch): + from litellm.proxy._types import ConfigFieldDelete + from litellm.proxy.proxy_server import ProxyConfig, delete_config_general_settings + + pc = ProxyConfig() + pc._load_yaml_settings_stores({"general_settings": {}}) + pc.settings.apply_db_row("general_settings", {"max_request_size_mb": 42}) + monkeypatch.setattr(proxy_server_module, "proxy_config", pc) + monkeypatch.setattr(proxy_server_module, "prisma_client", _fake_prisma_with_config({"max_request_size_mb": 42})) + + admin = UserAPIKeyAuth(api_key="hashed-admin", user_id="admin-1", user_role=LitellmUserRoles.PROXY_ADMIN) + await delete_config_general_settings( + data=ConfigFieldDelete(field_name="max_request_size_mb", config_type="general_settings"), + user_api_key_dict=admin, + ) + + assert "max_request_size_mb" not in pc.settings + + +@pytest.mark.asyncio +async def test_config_field_info_reports_the_declared_value_of_a_config_owned_secret(monkeypatch): + from litellm.proxy.proxy_server import ProxyConfig, get_config_general_settings + + pc = ProxyConfig() + pc._load_yaml_settings_stores({"general_settings": {"master_key": "os.environ/PROXY_MASTER_KEY"}}) + pc.settings.apply_runtime_values({"master_key": "sk-resolved-secret"}) + monkeypatch.setattr(proxy_server_module, "proxy_config", pc) + monkeypatch.setattr(proxy_server_module, "prisma_client", _fake_prisma_with_config({})) + + admin = UserAPIKeyAuth(api_key="hashed-admin", user_id="admin-1", user_role=LitellmUserRoles.PROXY_ADMIN) + info = await get_config_general_settings(field_name="master_key", user_api_key_dict=admin) + + assert info.field_value == "os.environ/PROXY_MASTER_KEY" + assert info.source == "config" + assert info.editable is False + + +@pytest.mark.asyncio +async def test_config_field_info_still_reports_a_database_owned_value(monkeypatch): + from litellm.proxy.proxy_server import ProxyConfig, get_config_general_settings + + pc = ProxyConfig() + pc._load_yaml_settings_stores({"general_settings": {}}) + pc.settings.apply_db_row("general_settings", {"max_request_size_mb": 42}) + monkeypatch.setattr(proxy_server_module, "proxy_config", pc) + monkeypatch.setattr(proxy_server_module, "prisma_client", _fake_prisma_with_config({"max_request_size_mb": 42})) + + admin = UserAPIKeyAuth(api_key="hashed-admin", user_id="admin-1", user_role=LitellmUserRoles.PROXY_ADMIN) + info = await get_config_general_settings(field_name="max_request_size_mb", user_api_key_dict=admin) + + assert info.field_value == 42 + assert info.source == "db" + + +@pytest.mark.asyncio +async def test_initialize_jwt_auth_leaves_the_declared_jwtauth_mapping_unresolved(monkeypatch): + from litellm.proxy.proxy_server import ProxyStartupEvent + + declared = {"public_key_ttl": "600", "team_id_jwt_field": "os.environ/JWT_TEAM_FIELD"} + general_settings = {"litellm_jwtauth": declared} + monkeypatch.setattr(proxy_server_module, "get_secret", lambda value: "resolved-team-field") + + ProxyStartupEvent._initialize_jwt_auth( + general_settings=general_settings, + prisma_client=None, + user_api_key_cache=DualCache(), + ) + + assert declared["team_id_jwt_field"] == "os.environ/JWT_TEAM_FIELD" + assert proxy_server_module.jwt_handler.litellm_jwtauth.team_id_jwt_field == "resolved-team-field" diff --git a/tests/test_litellm/proxy/ui_crud_endpoints/test_proxy_setting_endpoints.py b/tests/test_litellm/proxy/ui_crud_endpoints/test_proxy_setting_endpoints.py index 58201bd14ce..14d4929d27e 100644 --- a/tests/test_litellm/proxy/ui_crud_endpoints/test_proxy_setting_endpoints.py +++ b/tests/test_litellm/proxy/ui_crud_endpoints/test_proxy_setting_endpoints.py @@ -2604,6 +2604,67 @@ def test_add_allowed_ip_writes_audit_log(mock_proxy_config, monkeypatch): app.dependency_overrides.pop(user_api_key_auth, None) +def test_add_allowed_ip_hands_save_config_only_the_changed_general_setting(monkeypatch): + """An allowed-IP write must not drag the config file's own general_settings into + the database row. This covers the route end of that contract: what /add/allowed_ip + hands save_config differs from the loaded config in allowed_ips and nothing else. + save_config's end -- that the row it writes holds only those changed keys -- is + covered by test_ProxyConfig_save_config_merges_changed_keys_without_copying_file_settings. + + This lives here rather than in the e2e suite because /add/allowed_ip mutates the + live general_settings["allowed_ips"] that auth_utils._check_valid_ip reads, so on a + shared proxy the first call locks every later request out, cleanup included. + """ + from types import MappingProxyType + from typing import Final + from unittest.mock import AsyncMock, MagicMock + + import litellm.proxy.proxy_server as proxy_server_module + from litellm.proxy._types import UserAPIKeyAuth + from litellm.proxy.auth.user_api_key_auth import user_api_key_auth + from litellm.proxy.config_resolvers.changed_section_keys import changed_section_keys + from litellm.proxy.config_resolvers.settings_store import SettingsStore + + file_settings: Final = MappingProxyType({"max_parallel_requests": 100, "proxy_config_reload_interval_seconds": 7}) + store: Final = SettingsStore("general_settings") + store.load_yaml(file_settings) + + fake_prisma: Final = MagicMock() + fake_prisma.db.litellm_auditlog.create = AsyncMock() + save_config: Final = AsyncMock(side_effect=lambda new_config: new_config) + + async def _get_config(): + return {"general_settings": dict(file_settings)} + + monkeypatch.setattr(proxy_server_module, "prisma_client", fake_prisma) + monkeypatch.setattr(proxy_server_module, "store_model_in_db", True) + monkeypatch.setattr(proxy_server_module, "premium_user", True) + monkeypatch.setattr(proxy_server_module, "general_settings", store) + monkeypatch.setattr(proxy_server_module.proxy_config, "get_config", _get_config) + monkeypatch.setattr(proxy_server_module.proxy_config, "save_config", save_config) + + async def _admin_auth(): + return UserAPIKeyAuth( + user_id="config-admin", + api_key="hashed-admin-key", + user_role=LitellmUserRoles.PROXY_ADMIN, + ) + + app.dependency_overrides[user_api_key_auth] = _admin_auth + try: + resp: Final = client.post("/add/allowed_ip", json={"ip": "203.0.113.77"}) + assert resp.status_code == 200, resp.text + + save_config.assert_awaited_once() + persisted: Final = save_config.await_args.kwargs["new_config"]["general_settings"] + changed, removed = changed_section_keys(file_settings, persisted) + assert dict(changed) == {"allowed_ips": ["203.0.113.77"]} + assert removed == frozenset() + assert store["allowed_ips"] == ["203.0.113.77"] + finally: + app.dependency_overrides.pop(user_api_key_auth, None) + + def test_delete_allowed_ip_writes_deleted_audit_log(monkeypatch): """Removing an allowed IP must be audited as a deletion, symmetric with the add path.""" @@ -3127,6 +3188,182 @@ class TestMcpToolSearchSettingsEndpoints: assert mock_proxy_config["save_call_count"]() == 0 +class TestWebSearchInterceptionSettingsEndpoints: + @staticmethod + def _override_auth(role: LitellmUserRoles): + from litellm.proxy._types import UserAPIKeyAuth + from litellm.proxy.auth.user_api_key_auth import user_api_key_auth + + app.dependency_overrides[user_api_key_auth] = lambda: UserAPIKeyAuth( + user_id="u", api_key="hashed", user_role=role + ) + + def test_get_returns_stored_values_and_field_schema(self, mock_proxy_config, mock_auth, monkeypatch): + import litellm + from litellm.integrations.websearch_interception.handler import ( + WebSearchInterceptionLogger, + ) + + monkeypatch.setattr("litellm.proxy.proxy_server.prisma_client", object()) + monkeypatch.setattr(litellm, "callbacks", [WebSearchInterceptionLogger(search_tool_name="running")]) + mock_proxy_config["config"]["litellm_settings"]["websearch_interception_params"] = { + "enabled": True, + "enabled_providers": ["bedrock", "vertex_ai"], + "search_tool_name": "my-perplexity-search", + } + + resp = client.get("/get/websearch_interception_settings") + + assert resp.status_code == 200, resp.text + assert resp.json()["values"] == { + "enabled": True, + "enabled_providers": ["bedrock", "vertex_ai"], + "search_tool_name": "my-perplexity-search", + "max_agentic_loops": None, + } + assert resp.json()["field_schema"]["properties"]["enabled_providers"]["type"] == "array" + + def test_update_requires_proxy_admin(self, monkeypatch): + monkeypatch.setattr("litellm.proxy.proxy_server.store_model_in_db", True) + self._override_auth(LitellmUserRoles.INTERNAL_USER) + try: + resp = client.patch("/update/websearch_interception_settings", json={"enabled": True}) + finally: + app.dependency_overrides.clear() + assert resp.status_code == 403 + assert "proxy admin" in resp.json()["detail"].lower() + + def test_update_persists_settings(self, mock_proxy_config, monkeypatch): + monkeypatch.setattr("litellm.proxy.proxy_server.store_model_in_db", True) + self._override_auth(LitellmUserRoles.PROXY_ADMIN) + payload = { + "enabled": True, + "enabled_providers": ["bedrock"], + "search_tool_name": "my-perplexity-search", + "max_agentic_loops": 5, + } + try: + resp = client.patch("/update/websearch_interception_settings", json=payload) + finally: + app.dependency_overrides.clear() + + assert resp.status_code == 200, resp.text + assert mock_proxy_config["save_call_count"]() == 1 + assert mock_proxy_config["config"]["litellm_settings"]["websearch_interception_params"] == payload + + def test_get_reports_enabled_while_the_callback_is_running_without_a_stored_flag( + self, mock_proxy_config, mock_auth, monkeypatch + ): + import litellm + from litellm.integrations.websearch_interception.handler import ( + WebSearchInterceptionLogger, + ) + + monkeypatch.setattr("litellm.proxy.proxy_server.prisma_client", object()) + monkeypatch.setattr(litellm, "callbacks", [WebSearchInterceptionLogger(search_tool_name="from-config")]) + mock_proxy_config["config"]["litellm_settings"]["websearch_interception_params"] = { + "enabled_providers": ["bedrock"], + "search_tool_name": "my-perplexity-search", + } + + resp = client.get("/get/websearch_interception_settings") + + assert resp.status_code == 200, resp.text + assert resp.json()["values"]["enabled"] is True + + def test_get_reports_disabled_when_nothing_is_stored_and_nothing_is_running( + self, mock_proxy_config, mock_auth, monkeypatch + ): + import litellm + + monkeypatch.setattr("litellm.proxy.proxy_server.prisma_client", object()) + monkeypatch.setattr(litellm, "callbacks", []) + mock_proxy_config["config"]["litellm_settings"]["websearch_interception_params"] = { + "enabled_providers": ["bedrock"], + } + + resp = client.get("/get/websearch_interception_settings") + + assert resp.status_code == 200, resp.text + assert resp.json()["values"]["enabled"] is False + assert resp.json()["values"]["enabled_providers"] == ["bedrock"] + + def test_update_reapplies_settings_to_the_running_proxy(self, mock_proxy_config, monkeypatch): + from unittest.mock import AsyncMock + + monkeypatch.setattr("litellm.proxy.proxy_server.store_model_in_db", True) + monkeypatch.setattr("litellm.proxy.proxy_server.prisma_client", object()) + reapply = AsyncMock() + monkeypatch.setattr( + "litellm.proxy.proxy_server.proxy_config.init_websearch_interception_settings_in_db", + reapply, + ) + self._override_auth(LitellmUserRoles.PROXY_ADMIN) + try: + resp = client.patch("/update/websearch_interception_settings", json={"enabled": True}) + finally: + app.dependency_overrides.clear() + + assert resp.status_code == 200, resp.text + reapply.assert_awaited_once() + + def test_get_keeps_the_stored_flag_when_this_pod_has_not_reinitialized( + self, mock_proxy_config, mock_auth, monkeypatch + ): + import litellm + + monkeypatch.setattr("litellm.proxy.proxy_server.prisma_client", object()) + monkeypatch.setattr(litellm, "callbacks", []) + mock_proxy_config["config"]["litellm_settings"]["websearch_interception_params"] = { + "enabled": True, + "search_tool_name": "cluster-search", + } + + resp = client.get("/get/websearch_interception_settings") + + assert resp.status_code == 200, resp.text + assert resp.json()["values"]["enabled"] is True + + def test_get_reports_no_database_instead_of_empty_settings(self, mock_proxy_config, mock_auth, monkeypatch): + monkeypatch.setattr("litellm.proxy.proxy_server.prisma_client", None) + + resp = client.get("/get/websearch_interception_settings") + + assert resp.status_code == 500, resp.text + assert "Database not connected" in resp.json()["detail"]["error"] + + def test_update_still_saves_when_the_live_reinit_fails(self, mock_proxy_config, monkeypatch): + from unittest.mock import AsyncMock + + monkeypatch.setattr("litellm.proxy.proxy_server.store_model_in_db", True) + monkeypatch.setattr("litellm.proxy.proxy_server.prisma_client", object()) + monkeypatch.setattr( + "litellm.proxy.proxy_server.proxy_config.init_websearch_interception_settings_in_db", + AsyncMock(side_effect=RuntimeError("callback blew up")), + ) + self._override_auth(LitellmUserRoles.PROXY_ADMIN) + try: + resp = client.patch("/update/websearch_interception_settings", json={"enabled": True}) + finally: + app.dependency_overrides.clear() + + assert resp.status_code == 200, resp.text + assert mock_proxy_config["save_call_count"]() == 1 + + def test_update_rejects_zero_max_agentic_loops(self, mock_proxy_config, monkeypatch): + monkeypatch.setattr("litellm.proxy.proxy_server.store_model_in_db", True) + self._override_auth(LitellmUserRoles.PROXY_ADMIN) + try: + resp = client.patch( + "/update/websearch_interception_settings", + json={"enabled": True, "max_agentic_loops": 0}, + ) + finally: + app.dependency_overrides.clear() + assert resp.status_code == 422 + assert mock_proxy_config["save_call_count"]() == 0 + + def test_upload_logo_requires_proxy_admin(monkeypatch): """Any authenticated key could previously write a file to the server's disk here.""" from litellm.proxy._types import UserAPIKeyAuth diff --git a/tests/test_litellm/proxy/utils/proxy_logging/test_post_call_failure_hook.py b/tests/test_litellm/proxy/utils/proxy_logging/test_post_call_failure_hook.py index d7a6124dd97..a4bb7d63548 100644 --- a/tests/test_litellm/proxy/utils/proxy_logging/test_post_call_failure_hook.py +++ b/tests/test_litellm/proxy/utils/proxy_logging/test_post_call_failure_hook.py @@ -5,6 +5,7 @@ from __future__ import annotations import asyncio from datetime import datetime +from typing import Any, Final from unittest.mock import AsyncMock, MagicMock import pytest @@ -13,7 +14,7 @@ from fastapi import HTTPException import litellm from litellm.exceptions import GuardrailRaisedException from litellm.integrations.custom_logger import CustomLogger -from litellm.proxy._types import AlertType, ProxyErrorTypes +from litellm.proxy._types import AlertType, ProxyErrorTypes, UserAPIKeyAuth from litellm.proxy.utils import ProxyLogging @@ -156,6 +157,23 @@ async def test_post_call_failure_hook_non_http_exception_in_callback_swallowed( assert out is None +@pytest.mark.asyncio +@pytest.mark.parametrize("logging_value", (None, "caller-controlled", {"baseline_cache_context": "untrusted"})) # mutable-ok: emulate an untrusted JSON request field +async def test_terminal_baseline_cleanup_ignores_missing_or_untrusted_logging( + proxy_logging: ProxyLogging, monkeypatch: pytest.MonkeyPatch, logging_value: object +) -> None: + monkeypatch.setattr(litellm, "callbacks", ()) + proxy_logging.alert_types = [] # mutable-ok: disable optional alert sinks for this boundary test # rebind-ok: isolate the fixture-owned alert configuration + request_data: Final = {"litellm_call_id": "untrusted-logging", "litellm_logging_obj": logging_value} # mutable-ok: the production failure owner removes internal fields in place + result: Final = await proxy_logging.post_call_failure_hook( # pyright: ignore[reportUnknownMemberType] # exercise the existing proxy terminal owner with its legacy request dictionary contract + request_data=request_data, + original_exception=ValueError("original provider failure"), + user_api_key_dict=UserAPIKeyAuth(request_route="/v1/messages"), + ) + assert result is None + assert "litellm_logging_obj" not in request_data + + # --------------------------------------------------------------------------- # _handle_logging_proxy_only_error # --------------------------------------------------------------------------- diff --git a/tests/test_litellm/proxy/utils/proxy_logging/test_streaming_hooks.py b/tests/test_litellm/proxy/utils/proxy_logging/test_streaming_hooks.py index 6fb000b4fa7..5132aeb02e8 100644 --- a/tests/test_litellm/proxy/utils/proxy_logging/test_streaming_hooks.py +++ b/tests/test_litellm/proxy/utils/proxy_logging/test_streaming_hooks.py @@ -12,7 +12,7 @@ from __future__ import annotations import asyncio from collections.abc import AsyncGenerator, AsyncIterator from datetime import datetime -from typing import Any, Dict, List +from typing import Any, Dict, Final, List from unittest.mock import AsyncMock, MagicMock import pytest @@ -179,6 +179,29 @@ async def _one_chunk() -> AsyncGenerator[object, None]: yield "chunk" +class _AttributeStream: + _hidden_params = {"model_id": "m-1"} + model = "gpt-x" + + def __init__(self) -> None: + self._chunks = ("chunk-1", "chunk-2") + self._index = 0 + self.closed = False + + def __aiter__(self) -> "_AttributeStream": + return self + + async def __anext__(self) -> str: + if self._index >= len(self._chunks): + raise StopAsyncIteration + chunk = self._chunks[self._index] + self._index += 1 + return chunk + + async def aclose(self) -> None: + self.closed = True + + @pytest.mark.asyncio async def test_wrap_streaming_iterator_with_enrichment_passes_through_chunks(proxy_logging): async def gen(): @@ -247,6 +270,68 @@ async def test_wrap_streaming_iterator_leaves_upstream_http_exception_unattribut assert request_data == {} +@pytest.mark.asyncio +async def test_wrap_streaming_iterator_forwards_response_attributes_to_hook(proxy_logging): + async def prefix_hook(*, response: AsyncIterator[object]) -> AsyncGenerator[object, None]: + async for chunk in response: + yield f"{response._hidden_params['model_id']}:{response.model}:{chunk}" + + source = _AttributeStream() + wrapped = proxy_logging._wrap_streaming_iterator_with_enrichment( + callback=MagicMock(guardrail_name="g", event_hook="post_call"), + response=source, + hook=prefix_hook, + request_data={}, + ) + + assert [chunk async for chunk in wrapped] == [ + "m-1:gpt-x:chunk-1", + "m-1:gpt-x:chunk-2", + ] + + +@pytest.mark.asyncio +async def test_wrap_streaming_iterator_forwards_aclose_to_upstream(proxy_logging): + async def close_hook(*, response: AsyncIterator[object]) -> AsyncGenerator[object, None]: + first: Final = await response.__anext__() + yield first + await response.aclose() + + source = _AttributeStream() + request_data: dict[str, object] = {} + wrapped = proxy_logging._wrap_streaming_iterator_with_enrichment( + callback=MagicMock(guardrail_name="g", event_hook="post_call"), + response=source, + hook=close_hook, + request_data=request_data, + ) + + assert [chunk async for chunk in wrapped] == ["chunk-1"] + assert source.closed is True + assert request_data == {} + + +@pytest.mark.asyncio +async def test_wrap_streaming_iterator_missing_attribute_still_raises(proxy_logging): + async def missing_attribute_hook(*, response: AsyncIterator[object]) -> AsyncGenerator[object, None]: + _missing: Final = response.not_there + if False: + yield + + request_data: dict[str, object] = {} + wrapped = proxy_logging._wrap_streaming_iterator_with_enrichment( + callback=MagicMock(guardrail_name="hook-bug", event_hook="post_call"), + response=_one_chunk(), + hook=missing_attribute_hook, + request_data=request_data, + ) + + with pytest.raises(AttributeError): + async for _ in wrapped: + pass + assert request_data["metadata"]["applied_guardrails"] == ["hook-bug"] + + # --------------------------------------------------------------------------- # async_post_call_streaming_hook # --------------------------------------------------------------------------- diff --git a/tests/test_litellm/repositories/test_repositories.py b/tests/test_litellm/repositories/test_repositories.py index b6b4a8072fa..63fde9b2b8f 100644 --- a/tests/test_litellm/repositories/test_repositories.py +++ b/tests/test_litellm/repositories/test_repositories.py @@ -2269,6 +2269,10 @@ class TestAutoRouterSessionRepository: "classifier_cost": 0.01, "tier_turns": {"complex": 3}, "baseline_models": {"anthropic/claude-opus-5": 3}, + "savings_estimated_turns": 3, + "savings_estimated_actual_spend": 0.14, + "savings_estimated_saved_spend": 0.24, + "savings_estimated_baseline_models": {"anthropic/claude-opus-5": 3}, } @staticmethod @@ -2295,6 +2299,9 @@ class TestAutoRouterSessionRepository: assert (row.router_name, row.turns, row.spend, row.saved_spend) == ("claude-auto", 3, 0.14, 0.24) assert row.baseline_models == {"anthropic/claude-opus-5": 3} assert row.baseline_model == "anthropic/claude-opus-5" + assert row.savings_estimated_turns == 3 + assert row.savings_estimated_actual_spend == 0.14 + assert row.savings_estimated_saved_spend == 0.24 @pytest.mark.asyncio async def test_find_latest_for_key_is_none_when_the_key_wrote_no_such_session(self): diff --git a/tests/test_litellm/router_strategy/test_complexity_router.py b/tests/test_litellm/router_strategy/test_complexity_router.py index 9b25c869f1c..ecd25ff654f 100644 --- a/tests/test_litellm/router_strategy/test_complexity_router.py +++ b/tests/test_litellm/router_strategy/test_complexity_router.py @@ -3721,7 +3721,11 @@ class TestLLMClassifier: assert outcome.score is not None @pytest.mark.asyncio - async def test_heuristic_v2_routes_directly_to_predicted_builtin_tier(self, mock_router_instance): + @pytest.mark.parametrize("redact", (False, True)) + async def test_heuristic_v2_routes_directly_to_predicted_builtin_tier( + self, mock_router_instance: MagicMock, redact: bool, monkeypatch: pytest.MonkeyPatch + ) -> None: + monkeypatch.setattr(litellm, "turn_off_message_logging", redact) router = ComplexityRouter( model_name="tier-router", litellm_router_instance=mock_router_instance, @@ -3754,6 +3758,21 @@ class TestLLMClassifier: "tier-probability:complex=0.892157", "tier-probability:reasoning=0.980392", ] + redacted: Final = Router._redact_prompt_text_if_needed( + request_kwargs={}, routing_decision=response.routing_decision + ) + assert ("signals" in redacted) is not redact + assert redacted["heuristic_v2_forecast"] == { + "probabilities": { + "SIMPLE": 11 / 102, + "MEDIUM": 21 / 102, + "COMPLEX": 91 / 102, + "REASONING": 100 / 102, + }, + "threshold": 0.8, + "predicted_tier": "COMPLEX", + "request_type": "general", + } def test_heuristic_v2_needs_no_classifier_model(self): config = ComplexityRouterConfig(classifier_type="heuristic_v2") @@ -8879,13 +8898,29 @@ class TestRoutingDecisionSurvivesToSpendLogOnEveryMetadataShape: ], ) @pytest.mark.asyncio - async def test_decision_reaches_the_spend_log_payload(self, request_kwargs, expected_bucket): + @pytest.mark.parametrize("classifier_type", ("heuristic", "heuristic_v2")) + async def test_decision_reaches_the_spend_log_payload(self, request_kwargs, expected_bucket, classifier_type): import datetime import json from litellm.proxy.spend_tracking.spend_tracking_utils import get_logging_payload - router = Router(model_list=self.MODEL_LIST) + model_list: Final = [ + { + **row, + "litellm_params": { + **row["litellm_params"], + "complexity_router_config": { + **row["litellm_params"]["complexity_router_config"], + "classifier_type": classifier_type, + }, + }, + } + if row["model_name"] == "smart-router" + else row + for row in self.MODEL_LIST + ] + router = Router(model_list=model_list) response = await router.async_pre_routing_hook( model="smart-router", request_kwargs=request_kwargs, @@ -8915,6 +8950,15 @@ class TestRoutingDecisionSurvivesToSpendLogOnEveryMetadataShape: persisted = json.loads(payload["metadata"])["routing_decision"] assert persisted is not None, f"routing_decision dropped for {expected_bucket}" assert persisted["router_model_name"] == "smart-router" + if classifier_type == "heuristic_v2": + assert persisted["heuristic_v2_forecast"] == request_kwargs[expected_bucket]["routing_decision"][ + "heuristic_v2_forecast" + ] + assert set(persisted["heuristic_v2_forecast"]["probabilities"]) == { + "SIMPLE", "MEDIUM", "COMPLEX", "REASONING" + } + else: + assert "heuristic_v2_forecast" not in persisted class TestRoutingDecisionIsPerAttempt: @@ -9001,19 +9045,26 @@ class TestRecordRoutingDecision: Router._record_routing_decision(request_kwargs=request_kwargs, routing_decision=None) assert request_kwargs == {} - def test_clearing_the_decision_takes_the_savings_facts_with_it(self): + def test_clearing_the_decision_takes_the_savings_facts_with_it(self) -> None: """A fallback to a plain model group re-enters the hook with the same `request_kwargs`. The baseline and the conversation shape ride inside the decision rather than beside it, so one clear cannot leave either behind and attribute an auto-router saving to a deployment that never routed.""" - decision = { + from litellm.types.router import BaselineRouteStamp + + decision: Final = { "router_model_name": "smart-router", "router_type": "complexity", "routed_model": "gpt-4o-mini", "savings_baseline_model": "anthropic/claude-opus-5", + "savings_baseline_deployment_id": "opus-deployment", "conversation_continuing": False, } - request_kwargs: Dict = {"litellm_metadata": {"routing_decision": decision}} + request_kwargs: Final[dict[str, dict[str, object]]] = {"litellm_metadata": {}} + Router._record_routing_decision(request_kwargs=request_kwargs, routing_decision=decision) + stamp: Final = request_kwargs["litellm_metadata"]["_autorouter_baseline_route"] + assert isinstance(stamp, BaselineRouteStamp) + assert stamp.baseline_deployment_id == "opus-deployment" Router._record_routing_decision(request_kwargs=request_kwargs, routing_decision=None) assert request_kwargs["litellm_metadata"] == {} @@ -14104,6 +14155,33 @@ class TestModalityRouting: BASE_TIERS = {"SIMPLE": "text-cheap", "MEDIUM": "vision-mid", "COMPLEX": "vision-big"} BASE_VISION = {"text-cheap": False, "vision-mid": True, "vision-big": True, "vision-default": True} + @pytest.mark.asyncio + async def test_modality_escalation_preserves_the_original_heuristic_v2_forecast( + self, mock_router_instance: MagicMock + ) -> None: + router: Final = self._router( + mock_router_instance, + { + "classifier_type": "heuristic_v2", + "heuristic_v2_artifact": _heuristic_v2_artifact(), + "tiers": {"COMPLEX": "text-cheap", "REASONING": "vision-big"}, + "modality_routing": True, + }, + self.BASE_VISION, + ) + original: Final = await router.aclassify("What color is this?") + result: Final = await router.async_pre_routing_hook( + model="m", request_kwargs={}, messages=self.IMAGE_MESSAGE + ) + + assert original.heuristic_v2_forecast is not None + assert result is not None and result.routing_decision is not None + assert result.model == "vision-big" + assert result.routing_decision["cause"] == "modality_escalation" + assert result.routing_decision["tier"] == "REASONING" + assert result.routing_decision["heuristic_v2_forecast"] == original.heuristic_v2_forecast + assert result.routing_decision["heuristic_v2_forecast"]["predicted_tier"] == "COMPLEX" + @staticmethod def _router(mock_router_instance, config, vision_by_model): """vision_by_model: model name -> True/False (deployment model_info) or None (undeclared).""" @@ -14479,6 +14557,69 @@ class TestModalityRouting: @pytest.mark.usefixtures("local_model_cost_map") class TestHealthFallbackDispatch: + @pytest.mark.asyncio + @pytest.mark.parametrize("peer", (True, False), ids=("peer_failover", "default_fallback")) + async def test_health_rewrites_preserve_the_original_heuristic_v2_forecast(self, peer: bool) -> None: + router: Final = self._router( + config={ + "classifier_type": "heuristic_v2", + "heuristic_v2_artifact": _heuristic_v2_artifact(), + "tiers": {"COMPLEX": ["primary", "peer"] if peer else "primary"}, + } + ) + + def select_primary(models: Sequence[str]) -> str: + return max(models) + + with patch( # test-quality-ok: force initial classification onto the failing group in a mixed tier pool + "litellm.router_strategy.complexity_router.complexity_router.random.choice", + side_effect=select_primary, + ): + original: Final = await router.async_pre_routing_hook( + model="health-router", request_kwargs={}, messages=[{"role": "user", "content": "Hello!"}] + ) + self._unavailable(router, "primary-id", "cooldown") + result: Final = await router.async_pre_routing_hook( + model="health-router", request_kwargs={}, messages=[{"role": "user", "content": "Hello!"}] + ) + + assert original is not None and original.routing_decision is not None + assert original.model == "primary" + assert original.routing_decision["cause"] == "heuristic_v2" + assert result is not None and result.routing_decision is not None + assert result.model == ("peer" if peer else "fallback") + assert result.routing_decision["cause"] == ("health_failover" if peer else "health_default_fallback") + assert result.routing_decision["heuristic_v2_forecast"] == original.routing_decision["heuristic_v2_forecast"] + + @pytest.mark.asyncio + @pytest.mark.parametrize("pinned", (False, True), ids=("keyword_bypass", "session_pin")) + async def test_heuristic_v2_bypasses_have_no_fabricated_forecast(self, pinned: bool) -> None: + router: Final = self._router( + session=pinned, + config={ + "classifier_type": "heuristic_v2", + "heuristic_v2_artifact": _heuristic_v2_artifact(), + "tiers": {"COMPLEX": "primary"}, + "keyword_tier_rules": [{"keywords": ["quick lookup"], "tier": "COMPLEX"}], + }, + ) + original: Final = await router.async_pre_routing_hook( + model="health-router", + request_kwargs={"metadata": {"session_id": "v2-forecast"}}, + messages=[{"role": "user", "content": "Hello!"}], + ) + result: Final = await router.async_pre_routing_hook( + model="health-router", + request_kwargs={"metadata": {"session_id": "v2-forecast"}}, + messages=[{"role": "user", "content": "quick lookup"}], + ) + + assert original is not None and original.routing_decision is not None + assert "heuristic_v2_forecast" in original.routing_decision + assert result is not None and result.routing_decision is not None + assert result.routing_decision["cause"] == ("session_affinity_pin" if pinned else "literal_keyword_match") + assert "heuristic_v2_forecast" not in result.routing_decision + @pytest.fixture(autouse=True) def httpx_transport(self, monkeypatch: pytest.MonkeyPatch) -> None: monkeypatch.setattr(litellm, "disable_aiohttp_transport", True) diff --git a/tests/test_litellm/router_strategy/test_fuse_presets.py b/tests/test_litellm/router_strategy/test_fuse_presets.py new file mode 100644 index 00000000000..0cd4b1f660b --- /dev/null +++ b/tests/test_litellm/router_strategy/test_fuse_presets.py @@ -0,0 +1,69 @@ +import json +from hashlib import sha256 +from importlib.resources import files +from typing import Final, Literal + +import pytest +from pydantic import ValidationError + +from litellm.router_strategy.complexity_router.fuse_presets import get_fuse_presets, resolve_fuse_profile + + +def test_catalog_is_loaded_once_and_preserves_bundled_content() -> None: + get_fuse_presets.cache_clear() + first: Final = get_fuse_presets() + second: Final = get_fuse_presets() + assert first is second + bundled: Final = json.loads( + files("litellm.router_strategy.complexity_router").joinpath("fuse_presets.json").read_text(encoding="utf-8") + ) + assert first.model_dump(mode="json") == bundled + entries: Final = (*first.models, *first.harnesses) + assert len({entry.id for entry in entries}) == len(entries) + assert all(entry.sources and all(source.startswith("https://") for source in entry.sources) for entry in entries) + + +@pytest.mark.parametrize( + ("kind", "preset_id", "expected_digest"), + ( + ("model", "gpt-6-astra-v1", "a9403b0c00ea64081b7b08b5b968850670f3a047d219a7e0668f2169146ae96e"), + ("model", "gpt-5.6-sol-v1", "2b91a6c43e0e93183aaaf9c355e1bbb8ed2e9817aab6b0c2f50148f53a23247b"), + ("model", "gpt-5.6-luna-v1", "fff94a9e01bf4519798d5be4e76a3f9d57b75a2d9966a59dc92cbfeb5cd08d07"), + ("model", "gpt-5.6-terra-v1", "75de040f3bea841fa4764885738303893ee7ac0804aed1e932cd3959185ff893"), + ("model", "claude-haiku-4-5-v1", "91c1920953073462b6b70ef810596a5325f08286b5e62630cff47938fc4157db"), + ("model", "claude-sonnet-5-v1", "133f4414c644a707cd8cf565a486153856f4836ca4e4f75ee0553f2b7a1e3663"), + ("model", "claude-opus-5-v1", "9cbfcae45d2e3a2575e44ce5adf618f56614abff4b3221d35900c647200b99ef"), + ("model", "claude-fable-5-v1", "25c275d7403f1572ffb4fe899d5feecd9a434ebdc37b4dd9ef601a8ecf4850fc"), + ("model", "claude-fable-5-1-v1", "37693107c878ab6266530395bbdc2d2813d676d179bf281d05e5a5ec1b9d4c60"), + ("harness", "unspecified-v1", "d9eb30b61509456f0c71ca805b33d821cab6605578d567a29ab421d8f602ce7b"), + ("harness", "claude-code-v1", "7ee8e9d50f1cf44a8a58461efff66d6182f245d25499702c144d1c642c101ed9"), + ("harness", "codex-cli-v1", "0678047e34562ef05b5e2fba099c1f9e5876304f7eaf3b0d8c3809e707eb3311"), + ("harness", "opencode-v1", "8b6cc240d90091ac2ef9b374b535f981a55abb91e25d4c04fdb9fc206eeb907e"), + ("harness", "mini-swe-agent-v1", "21e2dc4a8a2320a5a554a498b30516326dc3592ebf20b0f4db20ddb33e879a39"), + ), +) +def test_existing_preset_text_is_unchanged( + kind: Literal["model", "harness"], preset_id: str, expected_digest: str +) -> None: + text: Final = resolve_fuse_profile(None, preset_id, kind) + assert text is not None + assert sha256(text.encode("utf-8")).hexdigest() == expected_digest + + +def test_every_catalog_entry_resolves_without_changing_custom_ownership() -> None: + catalog: Final = get_fuse_presets() + for entry in catalog.models: + assert resolve_fuse_profile(None, entry.id, "model") == entry.text + assert resolve_fuse_profile("Custom text", entry.id, "model") == "Custom text" + for entry in catalog.harnesses: + assert resolve_fuse_profile(None, entry.id, "harness") == entry.text + assert resolve_fuse_profile("Custom text", entry.id, "harness") == "Custom text" + assert resolve_fuse_profile("Custom text", None, "model") == "Custom text" + assert resolve_fuse_profile("Custom text", None, "harness") == "Custom text" + + +def test_cached_catalog_and_records_cannot_be_modified() -> None: + catalog: Final = get_fuse_presets() + for record, field in ((catalog, "version"), (catalog.models[0], "text"), (catalog.harnesses[0], "text")): + with pytest.raises(ValidationError, match="frozen"): + setattr(record, field, "Changed") diff --git a/tests/test_litellm/router_strategy/test_llm_v2.py b/tests/test_litellm/router_strategy/test_llm_v2.py index 5447c8b43ce..27d31cbe640 100644 --- a/tests/test_litellm/router_strategy/test_llm_v2.py +++ b/tests/test_litellm/router_strategy/test_llm_v2.py @@ -11,8 +11,10 @@ from litellm import ModelResponse, Router from litellm.caching.dual_cache import DualCache from litellm.router_strategy.complexity_router.complexity_router import ComplexityRouter from litellm.router_strategy.complexity_router.config import ComplexityRouterConfig, ComplexityTier +from litellm.router_strategy.complexity_router.fuse_presets import get_fuse_presets from litellm.router_strategy.complexity_router.llm_v2 import ( LLM_V2_PROMPT_VERSION, + LLM_V2_SYSTEM_PROMPT, LLMV2Calibration, LLMV2Config, LLMV2ProbabilityCalibration, @@ -174,6 +176,114 @@ def test_invalid_forecast_settings_are_rejected(overrides: dict[str, object]) -> LLMV2Config.model_validate({**base.model_dump(), **overrides}) +def _preset_config(**overrides: object) -> LLMV2Config: + catalog: Final = get_fuse_presets() + return LLMV2Config.model_validate( + { + "efficient_profile_preset": catalog.models[0].id, + "capable_profile_preset": catalog.models[-1].id, + "harness_preset": catalog.harnesses[-1].id, + "max_quality_gap": 0.05, + **overrides, + } + ) + + +def test_preset_roundtrip_keeps_references_without_materializing_text() -> None: + config: Final = _preset_config() + serialized: Final = config.model_dump(exclude_none=True) + assert serialized["efficient_profile_preset"] == config.efficient_profile_preset + assert serialized["capable_profile_preset"] == config.capable_profile_preset + assert serialized["harness_preset"] == config.harness_preset + assert not {"efficient_profile", "capable_profile", "harness"}.intersection(serialized) + assert LLMV2Config.model_validate(config.model_dump()) == config + assert LLMV2Config.model_validate_json(config.model_dump_json()) == config + + +@pytest.mark.parametrize("field", ("efficient_profile", "capable_profile", "harness")) +def test_preset_explicit_override_wins_and_survives_roundtrip(field: str) -> None: + config: Final = _preset_config(**{field: " Operator description "}) + roundtrip: Final = LLMV2Config.model_validate_json(config.model_dump_json()) + assert roundtrip.model_dump()[field] == "Operator description" + assert roundtrip.efficient_profile_preset == config.efficient_profile_preset + assert roundtrip.capable_profile_preset == config.capable_profile_preset + assert roundtrip.harness_preset == config.harness_preset + payload: Final = json.loads( + roundtrip.system_prompt("opaque-efficient", "opaque-capable").split("Configured solver profiles:\n")[1] + ) + if field == "harness": + assert payload["harness"] == "Operator description" + else: + assert payload[field.removesuffix("_profile")]["profile"] == "Operator description" + + +@pytest.mark.parametrize("field", ("efficient_profile", "capable_profile", "harness")) +@pytest.mark.parametrize("invalid", ("", " \n\t", "x" * 4001)) +def test_preset_does_not_bypass_supplied_text_bounds(field: str, invalid: str) -> None: + with pytest.raises(ValidationError, match=field): + _preset_config(**{field: invalid}) + + +@pytest.mark.parametrize("field", ("efficient_profile", "capable_profile", "harness")) +@pytest.mark.parametrize("override", (None, "Custom override")) +@pytest.mark.parametrize("invalid_id", ("missing-v1", "")) +def test_preset_unknown_reference_rejects_even_when_overridden( + field: str, override: str | None, invalid_id: str +) -> None: + with pytest.raises(ValidationError, match=f"{field}.*preset"): + _preset_config(**{field: override, f"{field}_preset": invalid_id}) + + +@pytest.mark.parametrize("field", ("efficient_profile", "capable_profile", "harness")) +def test_preset_missing_text_and_reference_rejects(field: str) -> None: + with pytest.raises(ValidationError, match=field): + _preset_config(**{f"{field}_preset": None}) + + +@pytest.mark.parametrize("field", ("efficient_profile", "capable_profile", "harness")) +def test_preset_reference_rejects_the_wrong_catalog_kind(field: str) -> None: + catalog: Final = get_fuse_presets() + wrong_id: Final = catalog.models[0].id if field == "harness" else catalog.harnesses[0].id + with pytest.raises(ValidationError, match=field): + _preset_config(**{f"{field}_preset": wrong_id}) + + +@pytest.mark.parametrize("mode", ("json_schema", "json_object")) +def test_custom_profile_prompt_bytes_are_unchanged(mode: str) -> None: + base: Final = _config().llm_v2_config + assert base is not None + config: Final = LLMV2Config.model_validate({**base.model_dump(), "response_format": mode}) + old_payload: Final = { + "prompt_version": LLM_V2_PROMPT_VERSION, + "harness": config.harness, + "efficient": {"model": "opaque-efficient", "profile": config.efficient_profile}, + "capable": {"model": "opaque-capable", "profile": config.capable_profile}, + } + schema: Final = ( + "\n\nResponse JSON schema:\n" + json.dumps(LLMV2Verdict.model_json_schema()) if mode == "json_object" else "" + ) + assert config.system_prompt("opaque-efficient", "opaque-capable") == ( + LLM_V2_SYSTEM_PROMPT + "\n\nConfigured solver profiles:\n" + json.dumps(old_payload) + schema + ) + + +@pytest.mark.asyncio +async def test_preset_router_passes_catalog_text_and_opaque_group_names_to_judge() -> None: + catalog: Final = get_fuse_presets() + config: Final = _config(llm_v2_config=_preset_config().model_dump()) + router, client = _router(_verdict().model_dump_json(), config) + outcome: Final = await router.aclassify("Complete the supplied task") + assert outcome.tier == ComplexityTier.SIMPLE + prompt: Final = client.acompletion.call_args.kwargs["messages"][0]["content"] + payload: Final = json.loads(prompt.split("Configured solver profiles:\n")[1]) + assert payload == { + "prompt_version": LLM_V2_PROMPT_VERSION, + "harness": catalog.harnesses[-1].text, + "efficient": {"model": "efficient", "profile": catalog.models[0].text}, + "capable": {"model": "capable", "profile": catalog.models[-1].text}, + } + + @pytest.mark.asyncio async def test_one_judge_fuses_whole_task_and_keeps_caller_text_out_of_system_prompt() -> None: router, client = _router(_verdict().model_dump_json()) diff --git a/tests/test_litellm/router_utils/test_auto_router_model_naming.py b/tests/test_litellm/router_utils/test_auto_router_model_naming.py index 3dcb8d5af94..7d59a0590f2 100644 --- a/tests/test_litellm/router_utils/test_auto_router_model_naming.py +++ b/tests/test_litellm/router_utils/test_auto_router_model_naming.py @@ -1,7 +1,10 @@ from collections.abc import Mapping +from typing import Final import pytest +from litellm.router_strategy.complexity_router.fuse_presets import get_fuse_presets + from litellm.router_utils.auto_router_model_naming import ( carries_complexity_router_settings, classify_strategy_router_model, @@ -171,6 +174,52 @@ def test_validate_accepts_loadable_complexity_config(complexity_router_config): assert validate_complexity_router_config_write(complexity_router_config=complexity_router_config) is None +def _fuse_write_config(profiles: Mapping[str, object]) -> Mapping[str, object]: + return { + "classifier_type": "llm_v2", + "classifier_llm_config": {"model": "judge"}, + "tiers": {"SIMPLE": ["opaque-efficient"], "REASONING": ["opaque-capable"]}, + "llm_v2_config": {"max_quality_gap": 0.05, **profiles}, + } + + +def test_fuse_write_accepts_presets_and_custom_text_with_the_same_entitlement() -> None: + catalog: Final = get_fuse_presets() + presets: Final = _fuse_write_config( + { + "efficient_profile_preset": catalog.models[0].id, + "capable_profile_preset": catalog.models[-1].id, + "harness_preset": catalog.harnesses[0].id, + } + ) + custom: Final = _fuse_write_config( + { + "efficient_profile": catalog.models[0].text, + "capable_profile": catalog.models[-1].text, + "harness": catalog.harnesses[0].text, + } + ) + assert validate_complexity_router_config_write(presets) is None + assert validate_complexity_router_config_write(custom) is None + assert claimed_capability(presets) is claimed_capability(custom) + assert claimed_capability(presets) is not None + + +@pytest.mark.parametrize("field", ("efficient_profile", "capable_profile", "harness")) +def test_fuse_write_rejects_unknown_preset_even_with_custom_text(field: str) -> None: + config: Final = _fuse_write_config( + { + "efficient_profile": "Custom efficient solver", + "capable_profile": "Custom capable solver", + "harness": "Custom runtime", + f"{field}_preset": "unknown-v1", + } + ) + violation: Final = validate_complexity_router_config_write(config) + assert violation is not None + assert f"{field}_preset" in violation + + def test_naming_check_ignores_the_config_entirely(): """The naming contract and the config's contents are separate questions with separate owners; a write may carry a config without naming a model, so neither can stand in for the other.""" diff --git a/tests/test_litellm/rust_bridge/test_fork_guard.py b/tests/test_litellm/rust_bridge/test_fork_guard.py new file mode 100644 index 00000000000..88ae017ec39 --- /dev/null +++ b/tests/test_litellm/rust_bridge/test_fork_guard.py @@ -0,0 +1,36 @@ +from types import SimpleNamespace + +import pytest + +from litellm.rust_bridge import fork_guard + + +def _reserve_with(monkeypatch: pytest.MonkeyPatch, native: object) -> None: + monkeypatch.setattr(fork_guard, "get_native_bridge", lambda: native) + fork_guard.reserve_process_for_forking("the gunicorn master") + + +def test_missing_extension_has_nothing_to_reserve(monkeypatch: pytest.MonkeyPatch) -> None: + assert _reserve_with(monkeypatch, None) is None + + +def test_extension_built_before_reservation_existed_passes(monkeypatch: pytest.MonkeyPatch) -> None: + assert _reserve_with(monkeypatch, SimpleNamespace()) is None + + +def test_unused_extension_is_reserved(monkeypatch: pytest.MonkeyPatch) -> None: + calls: list[None] = [] + + _reserve_with(monkeypatch, SimpleNamespace(reserve_process_for_forking=lambda: calls.append(None))) + + assert calls == [None] + + +def test_used_extension_refuses_and_names_the_place(monkeypatch: pytest.MonkeyPatch) -> None: + def reserve() -> None: + raise RuntimeError("the native runtime already started in this process") + + with pytest.raises(fork_guard.NativeStateStartedBeforeFork, match="the gunicorn master") as raised: + _reserve_with(monkeypatch, SimpleNamespace(reserve_process_for_forking=reserve)) + + assert isinstance(raised.value.__cause__, RuntimeError) diff --git a/tests/test_litellm/test_check_test_quality.py b/tests/test_litellm/test_check_test_quality.py index a75b1e43fb7..bfe503e74d1 100644 --- a/tests/test_litellm/test_check_test_quality.py +++ b/tests/test_litellm/test_check_test_quality.py @@ -737,3 +737,28 @@ def test_a_fanned_out_run_reports_each_generated_file_exactly_once(tmp_path): assert len(reported) == len(paths) assert len({line.split(":")[0] for line in reported}) == len(paths) assert all(" TQ001 " in line for line in reported) + + +def test_sys_executable_child_without_isolation_flag_is_flagged(tmp_path): + source = 'import subprocess, sys\nsubprocess.run([sys.executable, "-c", "pass"])\n' + assert _codes(tmp_path, source) == ["TQ009"] + + +def test_sys_executable_child_with_dash_i_is_clean(tmp_path): + source = 'import subprocess, sys\nsubprocess.run([sys.executable, "-I", "-c", "pass"])\n' + assert _codes(tmp_path, source) == [] + + +def test_sys_executable_child_with_dash_p_is_clean(tmp_path): + source = 'import subprocess, sys\nsubprocess.run([sys.executable, "-P", "-c", "pass"])\n' + assert _codes(tmp_path, source) == [] + + +def test_non_interpreter_subprocess_call_is_untouched(tmp_path): + source = 'import subprocess\nsubprocess.run(["python", "-c", "pass"])\n' + assert _codes(tmp_path, source) == [] + + +def test_popen_sys_executable_tuple_is_flagged(tmp_path): + source = 'import subprocess, sys\nsubprocess.Popen((sys.executable, "script.py"))\n' + assert _codes(tmp_path, source) == ["TQ009"] diff --git a/tests/test_litellm/test_test_quality_gate.py b/tests/test_litellm/test_test_quality_gate.py index 6652211a828..cde33787c6c 100644 --- a/tests/test_litellm/test_test_quality_gate.py +++ b/tests/test_litellm/test_test_quality_gate.py @@ -136,7 +136,9 @@ def test_the_shipped_budget_covers_every_rule_the_checker_can_emit(): import json budget = json.loads((_REPO_ROOT / "test-quality-budget.json").read_text()) - assert set(budget) == {"TQ001", "TQ002", "TQ003", "TQ004", "TQ005", "TQ006", "TQ007", "TQ008"} + assert set(budget) == { + "TQ001", "TQ002", "TQ003", "TQ004", "TQ005", "TQ006", "TQ007", "TQ008", "TQ009" + } assert all(spec["limit"] >= 0 for spec in budget.values()) diff --git a/tests/test_litellm/test_utils.py b/tests/test_litellm/test_utils.py index b40c10de428..3336ad6d33a 100644 --- a/tests/test_litellm/test_utils.py +++ b/tests/test_litellm/test_utils.py @@ -869,6 +869,7 @@ def test_aaamodel_prices_and_context_window_json_is_valid(): "supports_pdf_input": {"type": "boolean"}, "prompt_cache_min_tokens": {"type": "number"}, "supports_prompt_cache_breakpoint": {"type": "boolean"}, + "supports_thinking_cache_preservation": {"type": "boolean"}, "supports_prompt_caching": {"type": "boolean"}, "supports_response_schema": {"type": "boolean"}, "supports_system_messages": {"type": "boolean"}, diff --git a/tests/test_litellm_rust/support/child_interpreter.py b/tests/test_litellm_rust/support/child_interpreter.py new file mode 100644 index 00000000000..26bbe03a2d8 --- /dev/null +++ b/tests/test_litellm_rust/support/child_interpreter.py @@ -0,0 +1,36 @@ +from __future__ import annotations + +import os +import subprocess +import sys +from collections.abc import Mapping +from typing import Final + +import litellm + +PARENT_LITELLM_FILE: Final = "LITELLM_TEST_PARENT_LITELLM_FILE" + +_PROLOGUE: Final = ( + "import os as _os, litellm as _litellm; _parent = _os.environ.pop({key!r}); " + 'assert _litellm.__file__ == _parent, f"child imported litellm from {{_litellm.__file__}}, parent from {{_parent}}"; ' + "del _os, _litellm, _parent\n" +) + + +def run_child_interpreter( + source: str, *, env: Mapping[str, str] | None = None, timeout: float +) -> subprocess.CompletedProcess[str]: + """Run `source` in a fresh interpreter that imports the same `litellm` as this process. + + `-I` keeps the working directory off sys.path so a source checkout cannot shadow an + installed wheel, and the prologue fails fast with both paths if the child still + resolves a different package. + """ + environment: Final = {**(os.environ if env is None else env), PARENT_LITELLM_FILE: litellm.__file__} + return subprocess.run( + [sys.executable, "-I", "-c", _PROLOGUE.format(key=PARENT_LITELLM_FILE) + source], + capture_output=True, + text=True, + timeout=timeout, + env=environment, + ) diff --git a/tests/test_litellm_rust/test_fork_guard.py b/tests/test_litellm_rust/test_fork_guard.py new file mode 100644 index 00000000000..086397bab5c --- /dev/null +++ b/tests/test_litellm_rust/test_fork_guard.py @@ -0,0 +1,146 @@ +import os +import textwrap + +import pytest + +from tests.test_litellm_rust.support.child_interpreter import run_child_interpreter + +pytestmark = pytest.mark.requires_rust_extension + +_NATIVE_CONTRACT = textwrap.dedent( + """ + import os + from litellm.rust_bridge import _native + from litellm.rust_bridge.fork_guard import reserve_process_for_forking + + def native_route_error(): + import asyncio + + async def call(): + await _native.ResponsesWebSocketConnection.connect("ws://127.0.0.1:1", {}, 0.2) + + try: + asyncio.run(call()) + except Exception as error: + return f"{type(error).__name__}: {error}" + return "" + + assert _native.process_state_started() is False + reserve_process_for_forking("the test master") + assert native_route_error().startswith("ProcessReservedForForking: ") + assert _native.process_state_started() is False + + pid = os.fork() + if pid == 0: + error = native_route_error() + started = _native.process_state_started() + os._exit(0 if started and "reserved" not in error and "forked" not in error else 1) + assert os.waitpid(pid, 0)[1] == 0 + + pid = os.fork() + if pid == 0: + native_route_error() + grandchild = os.fork() + if grandchild == 0: + os._exit(0 if native_route_error().startswith("ForkedAfterNativeRuntimeStarted: ") else 1) + os._exit(os.waitpid(grandchild, 0)[1]) + assert os.waitpid(pid, 0)[1] == 0 + """ +) + + +@pytest.mark.skipif(not hasattr(os, "fork"), reason="fork only") +def test_compiled_extension_forbids_the_master_and_frees_its_workers() -> None: + env = {**os.environ, "OBJC_DISABLE_INITIALIZE_FORK_SAFETY": "YES"} + + result = run_child_interpreter(_NATIVE_CONTRACT, env=env, timeout=60) + + assert result.returncode == 0, result.stderr + + +_SDK_CONTRACT = textwrap.dedent( + """ + import asyncio, json, multiprocessing, os, threading + from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer + + import litellm + from litellm.rust_bridge.fork_guard import ForkedAfterNativeRuntimeStarted + + class Handler(BaseHTTPRequestHandler): + def do_POST(self): + self.rfile.read(int(self.headers["Content-Length"])) + if self.headers.get("User-Agent", "").startswith("python-httpx"): + self.send_response(418) + self.end_headers() + return + body = json.dumps({ + "pages": [{"index": 0, "markdown": "native", "images": [], "dimensions": None}], + "model": "mistral-ocr-latest", + "usage_info": {"pages_processed": 1, "doc_size_bytes": 3}, + }).encode() + self.send_response(200) + self.send_header("Content-Type", "application/json") + self.send_header("Content-Length", str(len(body))) + self.end_headers() + self.wfile.write(body) + + def log_message(self, *args): + pass + + server = ThreadingHTTPServer(("127.0.0.1", 0), Handler) + threading.Thread(target=server.serve_forever, daemon=True).start() + arguments = { + "model": "mistral/mistral-ocr-latest", + "document": {"type": "document_url", "document_url": "data:application/pdf;base64,YWJj"}, + "api_key": "test-key", + "api_base": f"http://127.0.0.1:{server.server_port}", + "num_retries": 0, + } + litellm.rust(True) + + SERVED, REFUSED, OTHER = 0, 3, 4 + + def outcome(asynchronous): + try: + response = asyncio.run(litellm.aocr(**arguments)) if asynchronous else litellm.ocr(**arguments) + except ForkedAfterNativeRuntimeStarted: + return REFUSED + except Exception: + return OTHER + return SERVED if response.pages[0].markdown == "native" else OTHER + + def forked(asynchronous): + pid = os.fork() + if pid == 0: + os._exit(outcome(asynchronous)) + return os.waitstatus_to_exitcode(os.waitpid(pid, 0)[1]) + + def pooled(asynchronous): + with multiprocessing.get_context("fork").Pool(1) as pool: + return pool.apply(outcome, (asynchronous,)) + + # Forking before the first native call is fine: the child starts its own runtime. + assert [forked(False), forked(True)] == [SERVED, SERVED] + + assert outcome(False) == SERVED + # After it, a forked child is told so instead of hanging on threads that do not exist. + assert [forked(False), forked(True)] == [REFUSED, REFUSED] + assert [pooled(False), pooled(True)] == [REFUSED, REFUSED] + # The parent is not poisoned by any of it. + assert [outcome(False), outcome(True)] == [SERVED, SERVED] + """ +) + + +@pytest.mark.skipif(not hasattr(os, "fork"), reason="fork only") +def test_sdk_call_in_a_child_forked_after_native_use_raises_instead_of_hanging() -> None: + env = { + **os.environ, + "OBJC_DISABLE_INITIALIZE_FORK_SAFETY": "YES", + "LITELLM_RUST": "1", + "LITELLM_LOCAL_MODEL_COST_MAP": "True", + } + + result = run_child_interpreter(_SDK_CONTRACT, env=env, timeout=120) + + assert result.returncode == 0, result.stderr diff --git a/ui/litellm-dashboard/src/app/(dashboard)/admin-panel/_components/AdminPanel.tsx b/ui/litellm-dashboard/src/app/(dashboard)/admin-panel/_components/AdminPanel.tsx index 1c8425251fd..386cbebd38d 100644 --- a/ui/litellm-dashboard/src/app/(dashboard)/admin-panel/_components/AdminPanel.tsx +++ b/ui/litellm-dashboard/src/app/(dashboard)/admin-panel/_components/AdminPanel.tsx @@ -22,6 +22,7 @@ import UserBannerSettings from "@/components/Settings/AdminSettings/UserBannerSe import CyberArk from "@/components/Settings/AdminSettings/CyberArk/CyberArk"; import HashicorpVault from "@/components/Settings/AdminSettings/HashicorpVault/HashicorpVault"; import PluginSettings from "@/components/Settings/AdminSettings/PluginSettings/PluginSettings"; +import WebSearchInterceptionSettings from "@/components/Settings/AdminSettings/WebSearchInterceptionSettings/WebSearchInterceptionSettings"; import SSOModals from "@/components/SSOModals"; import { emptySSOSettingsFormValues, @@ -408,6 +409,11 @@ const AdminPanel: React.FC = ({ proxySettings }) => { label: "Plugins", children: , }, + { + key: "web-search-interception", + label: "Web Search Interception", + children: , + }, ]; return ( diff --git a/ui/litellm-dashboard/src/app/(dashboard)/cost-optimization/_components/AutoRouterBenchmarksTab.test.tsx b/ui/litellm-dashboard/src/app/(dashboard)/cost-optimization/_components/AutoRouterBenchmarksTab.test.tsx index 2820a9dce83..5c7453c1394 100644 --- a/ui/litellm-dashboard/src/app/(dashboard)/cost-optimization/_components/AutoRouterBenchmarksTab.test.tsx +++ b/ui/litellm-dashboard/src/app/(dashboard)/cost-optimization/_components/AutoRouterBenchmarksTab.test.tsx @@ -68,6 +68,8 @@ const totals = (overrides: Partial = {}): Totals => ({ avg_session_seconds: 7560, avg_tokens_per_session: 5_300_000, spend: 359.86, + savings_estimated_turns: overrides.turns ?? 3073, + savings_estimated_actual_spend: overrides.spend ?? 359.86, classifier_cost: 6.146, saved_spend: 2174.59, baseline_spend: 2534.45, @@ -100,6 +102,8 @@ const zeroTotals: Totals = { avg_session_seconds: 0, avg_tokens_per_session: 0, spend: 0, + savings_estimated_turns: 0, + savings_estimated_actual_spend: 0, classifier_cost: 0, saved_spend: 0, baseline_spend: 0, @@ -153,6 +157,39 @@ describe("AutoRouterBenchmarksTab", () => { mockAutoRouters(); }); + it.each([ + { estimatedTurns: 0, saved: null, pct: null }, + { estimatedTurns: 10, saved: -0.5, pct: -33.3 }, + { estimatedTurns: 10, saved: 0, pct: 0 }, + ])("preserves costs for $estimatedTurns estimated turns with savings $saved", ({ estimatedTurns, saved, pct }) => { + const cohort = { + savings_estimated_turns: estimatedTurns, + savings_estimated_actual_spend: estimatedTurns ? 2 : 0, + saved_spend: saved, + baseline_spend: estimatedTurns ? 2 + (saved ?? 0) : null, + saved_pct: pct, + saved_per_session: null, + }; + const partial = totals(cohort); + mockHook({ data: response([], partial) }); + renderTab(); + expect(screen.getByText("Estimated savings on covered turns")).toBeInTheDocument(); + expect(screen.getByText(`${estimatedTurns} of 3,073 turns estimated`)).toBeInTheDocument(); + expect(screen.getByText("$359.86")).toBeInTheDocument(); + expect(screen.getByText("Actual spend on covered turns")).toBeInTheDocument(); + expect(screen.getByText("Estimated baseline spend on covered turns")).toBeInTheDocument(); + expect(screen.getAllByText("Unavailable")).toHaveLength(estimatedTurns ? 1 : 3); + if (saved === 0) { + expect(screen.getByText("0%")).toBeInTheDocument(); + expect(screen.getAllByText("$2.00")).toHaveLength(2); + } else if (estimatedTurns) { + expect(screen.getByText("-$0.5000")).toBeInTheDocument(); + expect(screen.getByText("+33%")).toBeInTheDocument(); + } else { + expect(screen.queryByText("+0%")).not.toBeInTheDocument(); + } + }); + it("leads with total estimated savings, before the four session-shape metrics", () => { mockHook({ data: response([group(), group({ router_name: "gpt-auto" })]) }); renderTab(); diff --git a/ui/litellm-dashboard/src/app/(dashboard)/cost-optimization/_components/AutoRouterBenchmarksTab.tsx b/ui/litellm-dashboard/src/app/(dashboard)/cost-optimization/_components/AutoRouterBenchmarksTab.tsx index ce5ab1c6776..ce55b633b60 100644 --- a/ui/litellm-dashboard/src/app/(dashboard)/cost-optimization/_components/AutoRouterBenchmarksTab.tsx +++ b/ui/litellm-dashboard/src/app/(dashboard)/cost-optimization/_components/AutoRouterBenchmarksTab.tsx @@ -73,26 +73,37 @@ const SpendRow: React.FC<{ label: string; value: string; hint?: string; subdued? const HeroCard: React.FC<{ view: BenchmarkView }> = ({ view }) => { const stats = view.stats; - const cheaper = stats.saved_spend >= 0; + const cheaper = stats.saved_spend != null && stats.saved_spend >= 0; + const completeCoverage = stats.savings_estimated_turns === stats.turns; return (

- Total estimated savings + {completeCoverage ? "Total estimated savings" : "Estimated savings on covered turns"}

- {usd(stats.saved_spend)} + {stats.saved_spend == null ? "Unavailable" : usd(stats.saved_spend)}

- - {stats.saved_spend !== 0 && (cheaper ? "-" : "+")} - {Math.abs(stats.saved_pct).toFixed(0)}% - + {stats.saved_pct != null && ( + + {stats.saved_spend !== 0 && (cheaper ? "-" : "+")} + {Math.abs(stats.saved_pct).toFixed(0)}% + + )}
+

+ {stats.savings_estimated_turns.toLocaleString()} of {stats.turns.toLocaleString()} turns estimated +

+ {!completeCoverage && ( +

+ Turns without a current estimate are excluded, including older estimates. +

+ )}
@@ -120,7 +131,15 @@ const HeroCard: React.FC<{ view: BenchmarkView }> = ({ view }) => {

)} - + {!completeCoverage && ( + + )} +
@@ -279,7 +298,7 @@ const BenchmarksBody: React.FC = ({ isPending, error, data,
@@ -288,12 +307,13 @@ const BenchmarksBody: React.FC = ({ isPending, error, data,

- Compares your actual routed spend with the estimated cost of using only the most expensive model configured in - the auto-router. It accounts for both the cache savings from staying on one model and the added cache costs from - switching models. Savings are net of recorded LLM classification cost, which is included in actual spend. - Classification cost per 1K turns is averaged over all auto-router turns, including those that skip - classification. The range counts whole sessions that overlap it, so totals can differ slightly from the Overall - tab, which buckets savings by UTC day. + Compares covered turns with the estimated cost of using the router's highest-tier baseline model. Estimates + use registered requests since tracking began, matching cache prefixes and expiry, and the actual response + length. Total actual spend includes every turn; savings and baseline spend include only turns with a current + estimate, including turns with zero savings. Savings are net of recorded LLM classification cost. Classification + cost per 1K turns is averaged over all auto-router turns, including those that skip classification. The range + counts whole sessions that overlap it, so totals can differ slightly from the Overall tab, which buckets savings + by UTC day.

diff --git a/ui/litellm-dashboard/src/app/(dashboard)/cost-optimization/_components/TierTurnsChart.test.tsx b/ui/litellm-dashboard/src/app/(dashboard)/cost-optimization/_components/TierTurnsChart.test.tsx index da4af8baf29..e4417d77463 100644 --- a/ui/litellm-dashboard/src/app/(dashboard)/cost-optimization/_components/TierTurnsChart.test.tsx +++ b/ui/litellm-dashboard/src/app/(dashboard)/cost-optimization/_components/TierTurnsChart.test.tsx @@ -21,6 +21,8 @@ const totalsOnly = { avg_session_seconds: 60, avg_tokens_per_session: 100, spend: 1, + savings_estimated_turns: 9, + savings_estimated_actual_spend: 1, saved_spend: 1, baseline_spend: 2, saved_pct: 50, diff --git a/ui/litellm-dashboard/src/app/(dashboard)/cost-optimization/_components/autoRouterBenchmarks.test.ts b/ui/litellm-dashboard/src/app/(dashboard)/cost-optimization/_components/autoRouterBenchmarks.test.ts index 22d6336e86f..0586163e77e 100644 --- a/ui/litellm-dashboard/src/app/(dashboard)/cost-optimization/_components/autoRouterBenchmarks.test.ts +++ b/ui/litellm-dashboard/src/app/(dashboard)/cost-optimization/_components/autoRouterBenchmarks.test.ts @@ -37,6 +37,8 @@ const totals = (overrides: Partial = {}) => ({ avg_session_seconds: 7560, avg_tokens_per_session: 5_300_000, spend: 359.86, + savings_estimated_turns: overrides.turns ?? 3073, + savings_estimated_actual_spend: overrides.spend ?? 359.86, classifier_cost: 6.146, saved_spend: 2174.59, baseline_spend: 2534.45, diff --git a/ui/litellm-dashboard/src/app/(dashboard)/hooks/webSearchInterceptionSettings/useUpdateWebSearchInterceptionSettings.ts b/ui/litellm-dashboard/src/app/(dashboard)/hooks/webSearchInterceptionSettings/useUpdateWebSearchInterceptionSettings.ts new file mode 100644 index 00000000000..ae6454aaba0 --- /dev/null +++ b/ui/litellm-dashboard/src/app/(dashboard)/hooks/webSearchInterceptionSettings/useUpdateWebSearchInterceptionSettings.ts @@ -0,0 +1,23 @@ +import { updateWebSearchInterceptionSettings, type WebSearchInterceptionSettings } from "@/components/networking"; +import { useMutation, useQueryClient } from "@tanstack/react-query"; +import { createQueryKeys } from "../common/queryKeysFactory"; + +const webSearchInterceptionSettingsKeys = createQueryKeys("webSearchInterceptionSettings"); + +export const useUpdateWebSearchInterceptionSettings = (accessToken: string) => { + const queryClient = useQueryClient(); + + return useMutation({ + mutationFn: async (settings: WebSearchInterceptionSettings) => { + if (!accessToken) { + throw new Error("Access token is required"); + } + return updateWebSearchInterceptionSettings(accessToken, settings); + }, + onSuccess: () => { + queryClient.invalidateQueries({ + queryKey: webSearchInterceptionSettingsKeys.all, + }); + }, + }); +}; diff --git a/ui/litellm-dashboard/src/app/(dashboard)/hooks/webSearchInterceptionSettings/useWebSearchInterceptionSettings.ts b/ui/litellm-dashboard/src/app/(dashboard)/hooks/webSearchInterceptionSettings/useWebSearchInterceptionSettings.ts new file mode 100644 index 00000000000..0e6a28ad742 --- /dev/null +++ b/ui/litellm-dashboard/src/app/(dashboard)/hooks/webSearchInterceptionSettings/useWebSearchInterceptionSettings.ts @@ -0,0 +1,17 @@ +import { getWebSearchInterceptionSettings, type WebSearchInterceptionSettingsResponse } from "@/components/networking"; +import { useQuery } from "@tanstack/react-query"; +import { createQueryKeys } from "../common/queryKeysFactory"; +import useAuthorized from "../useAuthorized"; + +const webSearchInterceptionSettingsKeys = createQueryKeys("webSearchInterceptionSettings"); + +export const useWebSearchInterceptionSettings = () => { + const { accessToken } = useAuthorized(); + return useQuery({ + queryKey: webSearchInterceptionSettingsKeys.list({}), + queryFn: async () => await getWebSearchInterceptionSettings(accessToken), + enabled: !!accessToken, + staleTime: 60 * 60 * 1000, + gcTime: 60 * 60 * 1000, + }); +}; diff --git a/ui/litellm-dashboard/src/components/Settings/AdminSettings/WebSearchInterceptionSettings/WebSearchInterceptionSettings.test.tsx b/ui/litellm-dashboard/src/components/Settings/AdminSettings/WebSearchInterceptionSettings/WebSearchInterceptionSettings.test.tsx new file mode 100644 index 00000000000..ae981aa9767 --- /dev/null +++ b/ui/litellm-dashboard/src/components/Settings/AdminSettings/WebSearchInterceptionSettings/WebSearchInterceptionSettings.test.tsx @@ -0,0 +1,192 @@ +import React from "react"; +import { describe, it, expect, vi, beforeEach } from "vitest"; +import { render, screen, act } from "@testing-library/react"; +import userEvent from "@testing-library/user-event"; +import WebSearchInterceptionSettings from "./WebSearchInterceptionSettings"; +import { useWebSearchInterceptionSettings } from "@/app/(dashboard)/hooks/webSearchInterceptionSettings/useWebSearchInterceptionSettings"; +import { useUpdateWebSearchInterceptionSettings } from "@/app/(dashboard)/hooks/webSearchInterceptionSettings/useUpdateWebSearchInterceptionSettings"; +import useAuthorized from "@/app/(dashboard)/hooks/useAuthorized"; + +vi.mock("@/app/(dashboard)/hooks/webSearchInterceptionSettings/useWebSearchInterceptionSettings", () => ({ + useWebSearchInterceptionSettings: vi.fn(), +})); + +vi.mock("@/app/(dashboard)/hooks/webSearchInterceptionSettings/useUpdateWebSearchInterceptionSettings", () => ({ + useUpdateWebSearchInterceptionSettings: vi.fn(), +})); + +vi.mock("@/app/(dashboard)/hooks/useAuthorized", () => ({ + default: vi.fn(), +})); + +vi.mock("@/components/networking", () => ({ + fetchSearchTools: vi.fn().mockResolvedValue({ + search_tools: [{ search_tool_name: "my-perplexity-search" }, { search_tool_name: "backup-search" }], + }), +})); + +const mockMutate = vi.fn(); + +const ENABLED_PAYLOAD = { + enabled: true, + enabled_providers: ["bedrock"], + search_tool_name: "my-perplexity-search", + max_agentic_loops: null, +}; + +const storedSettings = { + field_schema: { + properties: { + enabled: { description: "Serve web search tool calls from a configured search tool" }, + }, + }, + values: { + enabled: false, + enabled_providers: ["bedrock"], + search_tool_name: "my-perplexity-search", + max_agentic_loops: null, + }, +}; + +async function renderSettings() { + const result = render(); + await act(async () => {}); + return result; +} + +describe("WebSearchInterceptionSettings", () => { + beforeEach(() => { + vi.clearAllMocks(); + vi.mocked(useAuthorized).mockReturnValue({ accessToken: "test-token" } as any); + vi.mocked(useWebSearchInterceptionSettings).mockReturnValue({ + data: storedSettings, + isLoading: false, + isError: false, + error: null, + } as any); + vi.mocked(useUpdateWebSearchInterceptionSettings).mockReturnValue({ + mutate: mockMutate, + isPending: false, + error: null, + } as any); + }); + + it("renders the settings section", async () => { + await renderSettings(); + expect(screen.getByText("Web Search Interception")).toBeInTheDocument(); + }); + + it("shows a login prompt when there is no access token", () => { + vi.mocked(useAuthorized).mockReturnValue({ accessToken: null } as any); + render(); + expect(screen.getByText(/please log in/i)).toBeInTheDocument(); + }); + + it("hides the settings while loading", async () => { + vi.mocked(useWebSearchInterceptionSettings).mockReturnValue({ + data: undefined, + isLoading: true, + isError: false, + error: null, + } as any); + await renderSettings(); + expect(screen.queryByText("Enable Web Search Interception")).not.toBeInTheDocument(); + }); + + it("surfaces a load failure", async () => { + vi.mocked(useWebSearchInterceptionSettings).mockReturnValue({ + data: undefined, + isLoading: false, + isError: true, + error: new Error("boom"), + } as any); + await renderSettings(); + expect(screen.getByText("Could not load web search interception settings")).toBeInTheDocument(); + expect(screen.getByText("boom")).toBeInTheDocument(); + }); + + it("keeps save disabled until something changes", async () => { + const user = userEvent.setup(); + await renderSettings(); + + const save = screen.getByRole("button", { name: /save settings/i }); + expect(save).toBeDisabled(); + + await user.click(save); + expect(mockMutate).not.toHaveBeenCalled(); + }); + + it("submits the stored values with the toggled enabled flag", async () => { + const user = userEvent.setup(); + await renderSettings(); + + await user.click(screen.getByRole("switch")); + await user.click(screen.getByRole("button", { name: /save settings/i })); + + expect(mockMutate).toHaveBeenCalledTimes(1); + expect(mockMutate.mock.calls[0][0]).toEqual(ENABLED_PAYLOAD); + }); + + it("ignores stored values whose types do not match the field", async () => { + vi.mocked(useWebSearchInterceptionSettings).mockReturnValue({ + data: { + ...storedSettings, + values: { + enabled: "yes", + enabled_providers: "bedrock", + search_tool_name: 7, + max_agentic_loops: "3", + }, + }, + isLoading: false, + isError: false, + error: null, + } as any); + + await renderSettings(); + + expect(screen.getByRole("switch")).not.toBeChecked(); + expect(screen.getByLabelText(/max agentic loops/i)).toHaveValue(null); + expect(screen.queryByText("bedrock")).not.toBeInTheDocument(); + }); + + it("reseeds the form when the stored settings change underneath it", async () => { + vi.mocked(useWebSearchInterceptionSettings).mockReturnValue({ + data: { ...storedSettings, values: { ...storedSettings.values, max_agentic_loops: 3 } }, + isLoading: false, + isError: false, + error: null, + } as any); + const { rerender } = await renderSettings(); + expect(screen.getByRole("spinbutton")).toHaveValue(3); + + vi.mocked(useWebSearchInterceptionSettings).mockReturnValue({ + data: { ...storedSettings, values: { ...storedSettings.values, max_agentic_loops: 9 } }, + isLoading: false, + isError: false, + error: null, + } as any); + await act(async () => { + rerender(); + }); + + expect(screen.getByRole("spinbutton")).toHaveValue(9); + }); + + it("sends null rather than a number when the loop cap is cleared", async () => { + const user = userEvent.setup(); + vi.mocked(useWebSearchInterceptionSettings).mockReturnValue({ + data: { ...storedSettings, values: { ...storedSettings.values, max_agentic_loops: 5 } }, + isLoading: false, + isError: false, + error: null, + } as any); + await renderSettings(); + + await user.clear(screen.getByRole("spinbutton")); + await user.click(screen.getByRole("button", { name: /save settings/i })); + + expect(mockMutate).toHaveBeenCalledTimes(1); + expect(mockMutate.mock.calls[0][0].max_agentic_loops).toBeNull(); + }); +}); diff --git a/ui/litellm-dashboard/src/components/Settings/AdminSettings/WebSearchInterceptionSettings/WebSearchInterceptionSettings.tsx b/ui/litellm-dashboard/src/components/Settings/AdminSettings/WebSearchInterceptionSettings/WebSearchInterceptionSettings.tsx new file mode 100644 index 00000000000..3e9e04e720b --- /dev/null +++ b/ui/litellm-dashboard/src/components/Settings/AdminSettings/WebSearchInterceptionSettings/WebSearchInterceptionSettings.tsx @@ -0,0 +1,317 @@ +"use client"; + +import { useWebSearchInterceptionSettings } from "@/app/(dashboard)/hooks/webSearchInterceptionSettings/useWebSearchInterceptionSettings"; +import { useUpdateWebSearchInterceptionSettings } from "@/app/(dashboard)/hooks/webSearchInterceptionSettings/useUpdateWebSearchInterceptionSettings"; +import useAuthorized from "@/app/(dashboard)/hooks/useAuthorized"; +import { toast } from "@/lib/toast"; +import { Skeleton } from "@/components/ui/skeleton"; +import { CircleHelp, Info, Save } from "lucide-react"; +import { Alert, AlertDescription, AlertTitle } from "@/components/shared/Alert"; +import { useEffect, useState } from "react"; +import { useForm } from "react-hook-form"; +import { FieldGroup } from "@/components/ui/field"; +import { FormField } from "@/components/shared/form/FormField"; +import { MultiSelect } from "@/components/shared/MultiSelect"; +import { SearchSelect } from "@/components/shared/SearchSelect"; +import { Button } from "@/components/ui/button"; +import { Card, CardContent } from "@/components/ui/card"; +import { Input } from "@/components/ui/input"; +import { Switch } from "@/components/ui/switch"; +import { Tooltip, TooltipContent, TooltipProvider, TooltipTrigger } from "@/components/ui/tooltip"; +import { UiLoadingSpinner } from "@/components/ui/ui-loading-spinner"; +import { Providers, provider_map } from "@/components/provider_info_helpers"; +import { fetchSearchTools } from "@/components/networking"; + +interface WebSearchInterceptionStoredValues { + enabled?: boolean; + enabled_providers?: string[]; + search_tool_name?: string | null; + max_agentic_loops?: number | null; +} + +interface WebSearchInterceptionFieldSchema { + properties?: { + enabled?: { description?: string }; + enabled_providers?: { description?: string }; + search_tool_name?: { description?: string }; + max_agentic_loops?: { description?: string }; + }; +} + +interface WebSearchInterceptionFormValues { + enabled: boolean; + enabled_providers: string[]; + search_tool_name: string | null; + max_agentic_loops: number | null; +} + +const NO_STORED_VALUES: Readonly> = {}; + +const MAX_AGENTIC_LOOPS_MIN = 1; + +const PROVIDER_OPTIONS = Object.entries(provider_map) + .map(([enumKey, providerValue]) => ({ + label: Providers[enumKey as keyof typeof Providers] ?? providerValue, + value: providerValue, + })) + .sort((a, b) => a.label.localeCompare(b.label)); + +const labelWithHint = (label: string, hint: string): React.ReactNode => ( + <> + {label} + + } /> + {hint} + + +); + +const parseLoops = (raw: string, rawAsNumber: number): number | null => + raw === "" || Number.isNaN(rawAsNumber) ? null : rawAsNumber; + +const isStringArray = (value: unknown): value is string[] => + Array.isArray(value) && value.every((entry) => typeof entry === "string"); + +const toStoredValues = (raw: Readonly>): WebSearchInterceptionStoredValues => ({ + enabled: typeof raw.enabled === "boolean" ? raw.enabled : undefined, + enabled_providers: isStringArray(raw.enabled_providers) ? raw.enabled_providers : undefined, + search_tool_name: typeof raw.search_tool_name === "string" ? raw.search_tool_name : null, + max_agentic_loops: typeof raw.max_agentic_loops === "number" ? raw.max_agentic_loops : null, +}); + +const toFormValues = (values: WebSearchInterceptionStoredValues): WebSearchInterceptionFormValues => ({ + enabled: values.enabled ?? false, + enabled_providers: values.enabled_providers ?? [], + search_tool_name: values.search_tool_name ?? null, + max_agentic_loops: values.max_agentic_loops ?? null, +}); + +const readSearchToolNames = (response: unknown): string[] => { + const payload = response as { search_tools?: unknown; data?: unknown } | null; + const tools = Array.isArray(payload?.search_tools) ? payload.search_tools : payload?.data; + if (!Array.isArray(tools)) { + return []; + } + return tools + .map((tool: { search_tool_name?: string }) => tool?.search_tool_name) + .filter((name: unknown): name is string => typeof name === "string" && name.length > 0); +}; + +const useSearchToolNames = (accessToken: string) => { + const [searchTools, setSearchTools] = useState([]); + const [loadingSearchTools, setLoadingSearchTools] = useState(true); + + useEffect(() => { + const loadSearchTools = async () => { + if (!accessToken) return; + try { + setSearchTools(readSearchToolNames(await fetchSearchTools(accessToken))); + } catch (loadError) { + console.error("Error fetching search tools:", loadError); + } finally { + setLoadingSearchTools(false); + } + }; + + loadSearchTools(); + }, [accessToken]); + + return { searchTools, loadingSearchTools }; +}; + +interface WebSearchInterceptionFormProps { + accessToken: string; + initial: WebSearchInterceptionFormValues; + schema: WebSearchInterceptionFieldSchema | undefined; +} + +function WebSearchInterceptionForm({ accessToken, initial, schema }: WebSearchInterceptionFormProps) { + const { + mutate: updateSettings, + isPending: isUpdating, + error: updateError, + } = useUpdateWebSearchInterceptionSettings(accessToken); + const { searchTools, loadingSearchTools } = useSearchToolNames(accessToken); + const form = useForm({ defaultValues: initial }); + const isDirty = form.formState.isDirty; + + const handleSave = (formValues: WebSearchInterceptionFormValues) => { + updateSettings(formValues, { + onSuccess: () => { + form.reset(formValues); + toast.success("Settings updated successfully. Changes will be applied across all pods within 10 seconds."); + }, + onError: (saveError) => { + toast.fromError(saveError); + }, + }); + }; + + return ( + <> + {updateError && ( + + Could not update settings + {updateError instanceof Error && {updateError.message}} + + )} + + +
event.preventDefault()} noValidate> + + + + + {({ value, onChange, onBlur, id }) => ( + + )} + + + + {({ value, onChange, id }) => ( + + )} + + + + {({ value, onChange, id }) => ( + ({ label: name, value: name }))} + value={value} + onValueChange={onChange} + placeholder="Select a search tool (defaults to the first available)" + disabled={isUpdating || loadingSearchTools} + /> + )} + + + + {({ value, onChange, onBlur, id, ref }) => ( + onChange(parseLoops(event.target.value, event.target.valueAsNumber))} + onBlur={onBlur} + disabled={isUpdating} + /> + )} + + + + + +
+ +
+
+ + + ); +} + +export default function WebSearchInterceptionSettings() { + const { accessToken } = useAuthorized(); + const { data, isLoading, isError, error } = useWebSearchInterceptionSettings(); + + if (!accessToken) { + return ( +
+ Please log in to configure web search interception settings. +
+ ); + } + + if (isLoading) { + return ( +
+ + + + +
+ ); + } + + if (isError) { + return ( + + Could not load web search interception settings + {error instanceof Error && {error.message}} + + ); + } + + const values: WebSearchInterceptionStoredValues = toStoredValues(data?.values ?? NO_STORED_VALUES); + + return ( +
+ + + Web Search Interception + + Serve web search tool calls from a configured search tool instead of passing them upstream, so models without + native web search can still answer with fresh results. Click 'Save Settings' to apply changes across + all pods (takes effect within 10 seconds). + + + + +
+ ); +} diff --git a/ui/litellm-dashboard/src/components/add_model/ForecastClassifierConfig.integration.test.tsx b/ui/litellm-dashboard/src/components/add_model/ForecastClassifierConfig.integration.test.tsx index 4a574ac736d..a03ccb11456 100644 --- a/ui/litellm-dashboard/src/components/add_model/ForecastClassifierConfig.integration.test.tsx +++ b/ui/litellm-dashboard/src/components/add_model/ForecastClassifierConfig.integration.test.tsx @@ -1,7 +1,7 @@ import React, { useState } from "react"; -import { describe, expect, it, vi } from "vitest"; +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import userEvent from "@testing-library/user-event"; -import { fireEvent, renderWithProviders, screen } from "../../../tests/test-utils"; +import { act, fireEvent, renderWithProviders, screen, testQueryClient, waitFor } from "../../../tests/test-utils"; import ClassificationMethodConfig from "./ClassificationMethodConfig"; import AutoRouterClassifierTabs from "./AutoRouterClassifierTabs"; import ForecastClassifierConfig from "./ForecastClassifierConfig"; @@ -37,6 +37,53 @@ const fuseInitial: ComplexityRouterConfigValue = { }, }; const options = ["judge", "efficient", "capable"].map((model) => ({ value: model, label: model })); +const catalog = { + version: "catalog-v1", + models: [ + { + id: "efficient-v1", + label: "Efficient preset", + text: "Maintained efficient profile", + sources: ["https://example.com/efficient"], + model: "efficient-model", + }, + { + id: "capable-v1", + label: "Capable preset", + text: "Maintained capable profile", + sources: ["https://example.com/capable"], + model: "capable-model", + }, + ], + harnesses: [ + { + id: "runtime-v1", + label: "Runtime preset", + text: "Maintained runtime profile", + sources: ["https://example.com/runtime"], + }, + ], +}; +const presetConfig = { + efficient_profile_preset: catalog.models[0].id, + capable_profile_preset: catalog.models[1].id, + harness_preset: catalog.harnesses[0].id, + max_quality_gap: 0.05, +}; +const presetInitial = { ...fuseInitial, llm_v2_config: presetConfig }; + +beforeEach(() => { + testQueryClient.clear(); + vi.stubGlobal( + "fetch", + vi.fn().mockImplementation(async () => Response.json(catalog)), + ); +}); + +afterEach(() => { + testQueryClient.clear(); + vi.unstubAllGlobals(); +}); function Form({ initialValue = initial }: { initialValue?: ComplexityRouterConfigValue }) { const [value, setValue] = useState(initialValue); @@ -72,6 +119,193 @@ function Form({ initialValue = initial }: { initialValue?: ComplexityRouterConfi } describe("forecast classifier form", () => { + it("selects all three maintained presets, previews provenance, and saves only references", async () => { + const user = userEvent.setup(); + renderWithProviders(
); + await user.click(screen.getByRole("combobox", { name: "Efficient solver profile preset" })); + await user.click(await screen.findByRole("option", { name: /^Efficient preset/ })); + await user.click(screen.getByRole("combobox", { name: "Capable solver profile preset" })); + await user.click(screen.getByRole("option", { name: /^Capable preset/ })); + await user.click(screen.getByRole("combobox", { name: "Harness and budget preset" })); + await user.click(screen.getByRole("option", { name: /^Runtime preset/ })); + expect(screen.getByLabelText("Efficient solver profile")).toHaveValue(catalog.models[0].text); + expect(screen.getByLabelText("Efficient solver profile")).toHaveAttribute("readonly"); + expect(screen.getByLabelText("Capable solver profile")).toHaveValue(catalog.models[1].text); + expect(screen.getByLabelText("Harness and budget")).toHaveValue(catalog.harnesses[0].text); + expect(screen.getAllByText(`Catalog version: ${catalog.version}`)).toHaveLength(3); + expect(screen.getByText(`Model: ${catalog.models[0].model}`)).toBeInTheDocument(); + expect(screen.getAllByRole("link", { name: "Source 1" }).map((link) => link.getAttribute("href"))).toEqual([ + catalog.models[0].sources[0], + catalog.models[1].sources[0], + catalog.harnesses[0].sources[0], + ]); + fireEvent.click(screen.getByRole("button", { name: "Save configuration" })); + expect(JSON.parse(screen.getByRole("status", { name: "Saved configuration" }).textContent!).llm_v2_config).toEqual( + presetConfig, + ); + expect(fetch).toHaveBeenCalledTimes(1); + expect(fetch).toHaveBeenCalledWith( + expect.objectContaining({ url: expect.stringMatching(/\/public\/complexity_router\/fuse_presets$/) }), + ); + }); + + it.each([undefined, null, "Explicit override"])( + "copies effective text to Custom and clears only that reference, override=%s", + async (override) => { + const user = userEvent.setup(); + renderWithProviders( + , + ); + const effectiveText = override ?? catalog.models[0].text; + await waitFor(() => expect(screen.getByLabelText("Efficient solver profile")).toHaveValue(effectiveText)); + await user.click(screen.getByRole("combobox", { name: "Efficient solver profile preset" })); + await user.click(screen.getByRole("option", { name: "Custom" })); + expect(screen.getByLabelText("Efficient solver profile")).not.toHaveAttribute("readonly"); + expect(screen.getByLabelText("Efficient solver profile")).toHaveValue(effectiveText); + fireEvent.change(screen.getByLabelText("Efficient solver profile"), { target: { value: "Custom budget" } }); + fireEvent.click(screen.getByRole("button", { name: "Save configuration" })); + const { efficient_profile_preset: _preset, ...rest } = presetConfig; + expect( + JSON.parse(screen.getByRole("status", { name: "Saved configuration" }).textContent!).llm_v2_config, + ).toEqual({ + ...rest, + efficient_profile: "Custom budget", + }); + }, + ); + + it.each([ + { ...fuseInitial.llm_v2_config!, efficient_profile: catalog.models[0].text }, + { + ...presetConfig, + efficient_profile: "Explicit override", + capable_profile: "Capable override", + harness: "Harness override", + }, + ])("keeps existing custom ownership and references on an unchanged save: %j", async (settings) => { + renderWithProviders(); + await waitFor(() => expect(screen.queryByText(/Loading profile presets/)).not.toBeInTheDocument()); + expect(screen.getByRole("combobox", { name: "Efficient solver profile preset" })).toHaveValue("Custom"); + expect(screen.getByLabelText("Efficient solver profile")).toHaveValue(settings.efficient_profile); + fireEvent.click(screen.getByRole("button", { name: "Save configuration" })); + expect(JSON.parse(screen.getByRole("status", { name: "Saved configuration" }).textContent!).llm_v2_config).toEqual( + settings, + ); + }); + + it.each([true, false])( + "keeps edits and stored IDs while the pending catalog settles, success=%s", + async (success) => { + let resolveCatalog: (response: Response) => void = () => {}; + vi.mocked(fetch).mockReturnValue( + new Promise((resolve) => { + resolveCatalog = resolve; + }), + ); + const settings = { ...presetConfig, efficient_profile: "Original override" }; + renderWithProviders(); + expect(screen.getByText(/Loading profile presets/)).toBeInTheDocument(); + fireEvent.change(screen.getByLabelText("Efficient solver profile"), { target: { value: "Typed while loading" } }); + await act(async () => + resolveCatalog(success ? Response.json(catalog) : Response.json({ error: "unavailable" }, { status: 503 })), + ); + if (success) await screen.findAllByText(`Catalog version: ${catalog.version}`); + else expect(await screen.findByText(/Profile presets could not be loaded/)).toBeInTheDocument(); + expect(screen.getByLabelText("Efficient solver profile")).toHaveValue("Typed while loading"); + fireEvent.click(screen.getByRole("button", { name: "Save configuration" })); + expect( + JSON.parse(screen.getByRole("status", { name: "Saved configuration" }).textContent!).llm_v2_config, + ).toEqual({ ...settings, efficient_profile: "Typed while loading" }); + }, + ); + + it.each([ + ["efficient_profile", "Efficient solver profile"], + ["capable_profile", "Capable solver profile"], + ["harness", "Harness and budget"], + ] as const)( + "preserves the saved %s reference during a catalog outage until Custom text replaces it", + async (field, label) => { + const user = userEvent.setup(); + vi.mocked(fetch).mockImplementation(async () => Response.json({ error: "unavailable" }, { status: 503 })); + renderWithProviders(); + expect(await screen.findByText(/Profile presets could not be loaded/)).toBeInTheDocument(); + const save = screen.getByRole("button", { name: "Save configuration" }); + const output = screen.getByRole("status", { name: "Saved configuration" }); + expect(save).toBeEnabled(); + await user.click(save); + expect(JSON.parse(output.textContent!).llm_v2_config).toEqual(presetConfig); + + await user.click(screen.getByRole("combobox", { name: `${label} preset` })); + await user.click(screen.getByRole("option", { name: "Custom" })); + expect(screen.getByLabelText(label)).toHaveValue(""); + expect(screen.getByLabelText(label)).not.toHaveAttribute("readonly"); + expect(screen.getByRole("combobox", { name: `${label} preset` })).toHaveValue("Custom"); + expect(save).toBeEnabled(); + await user.click(save); + expect(JSON.parse(output.textContent!).llm_v2_config).toEqual(presetConfig); + + fireEvent.change(screen.getByLabelText(label), { target: { value: " " } }); + expect(save).toBeDisabled(); + await user.click(screen.getByRole("button", { name: `Keep saved ${label.toLowerCase()} preset` })); + expect(screen.getByLabelText(label)).toHaveAttribute("readonly"); + expect(save).toBeEnabled(); + await user.click(save); + expect(JSON.parse(output.textContent!).llm_v2_config).toEqual(presetConfig); + + await user.click(screen.getByRole("combobox", { name: `${label} preset` })); + await user.click(screen.getByRole("option", { name: "Custom" })); + const replacement = "Manually authored replacement"; + fireEvent.change(screen.getByLabelText(label), { target: { value: replacement } }); + expect(save).toBeEnabled(); + await user.click(save); + const referenceKey = `${field}_preset` as const; + const { [referenceKey]: _reference, ...remaining } = presetConfig; + expect(JSON.parse(output.textContent!).llm_v2_config).toEqual({ ...remaining, [field]: replacement }); + }, + ); + + it.each([true, false])( + "keeps a reference selected as Custom while the catalog settles, success=%s", + async (success) => { + const user = userEvent.setup(); + const response = Promise.withResolvers(); + vi.mocked(fetch).mockReturnValue(response.promise); + renderWithProviders(); + await user.click(screen.getByRole("combobox", { name: "Efficient solver profile preset" })); + await user.click(screen.getByRole("option", { name: "Custom" })); + await act(async () => response.resolve(success ? Response.json(catalog) : Response.json({}, { status: 503 }))); + if (success) await screen.findAllByText(`Catalog version: ${catalog.version}`); + else await screen.findByText(/Profile presets could not be loaded/); + expect(screen.getByLabelText("Efficient solver profile")).toHaveValue(success ? catalog.models[0].text : ""); + await user.click(screen.getByRole("button", { name: "Save configuration" })); + expect( + JSON.parse(screen.getByRole("status", { name: "Saved configuration" }).textContent!).llm_v2_config, + ).toEqual(presetConfig); + fireEvent.change(screen.getByLabelText("Efficient solver profile"), { target: { value: "Replacement" } }); + await user.click(screen.getByRole("button", { name: "Save configuration" })); + const { efficient_profile_preset: _reference, ...remaining } = presetConfig; + expect( + JSON.parse(screen.getByRole("status", { name: "Saved configuration" }).textContent!).llm_v2_config, + ).toEqual({ + ...remaining, + efficient_profile: "Replacement", + }); + }, + ); + + it("keeps unknown saved IDs visible with unavailable previews rather than replacing them", async () => { + const settings = { ...presetConfig, efficient_profile_preset: "unavailable-v8" }; + renderWithProviders(); + await screen.findAllByText(`Catalog version: ${catalog.version}`); + expect(screen.getByRole("combobox", { name: "Efficient solver profile preset" })).toHaveValue("unavailable-v8"); + expect(screen.getByText("Preset preview unavailable. The saved reference is preserved")).toBeInTheDocument(); + fireEvent.click(screen.getByRole("button", { name: "Save configuration" })); + expect(JSON.parse(screen.getByRole("status", { name: "Saved configuration" }).textContent!).llm_v2_config).toEqual( + settings, + ); + }); + it("switches a populated standard router to Capability without saving hidden pools or their overrides", () => { renderWithProviders( { fireEvent.click(screen.getByRole("tab", { name: "Complexity" })); fireEvent.click(screen.getByRole("radio", { name: new RegExp(`^${target}`) })); await user.click(screen.getByRole("combobox", { name: "Classifier Model" })); - await user.click(screen.getByRole("option", { name: "judge", exact: true })); + await user.click(screen.getByRole("option", { name: "judge" })); fireEvent.click(screen.getByRole("button", { name: "Save configuration" })); const output = screen.getByRole("status", { name: "Saved configuration" }); expect(output).toHaveTextContent('"classification_rubric":"agentic"'); diff --git a/ui/litellm-dashboard/src/components/add_model/ForecastClassifierConfig.tsx b/ui/litellm-dashboard/src/components/add_model/ForecastClassifierConfig.tsx index b901a509435..c336423fe39 100644 --- a/ui/litellm-dashboard/src/components/add_model/ForecastClassifierConfig.tsx +++ b/ui/litellm-dashboard/src/components/add_model/ForecastClassifierConfig.tsx @@ -3,7 +3,7 @@ import { Collapsible, CollapsibleContent, CollapsibleTrigger } from "@/component import { ChevronRight } from "lucide-react"; import { Input } from "@/components/ui/input"; import { Label } from "@/components/ui/label"; -import { Textarea } from "@/components/ui/textarea"; +import FuseProfilePresets from "./FuseProfilePresets"; import { Switch } from "@/components/ui/switch"; import { SearchSelect } from "@/components/shared/SearchSelect"; import { MultiSelect } from "@/components/shared/MultiSelect"; @@ -239,35 +239,13 @@ const ForecastClassifierConfig = ({ value, onChange, modelOptions, effortOptions ) : ( <> - {(["efficient_profile", "capable_profile", "harness"] as const).map((field) => { - const label = { - efficient_profile: "Efficient solver profile", - capable_profile: "Capable solver profile", - harness: "Harness and budget", - }[field]; - return ( -
- -