@damiangilgonzalez/copypasta 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +227 -2
- package/catalog.yaml +140 -0
- package/cli/copypasta.js +4 -0
- package/cli/lib/catalog.js +131 -0
- package/cli/lib/commands.js +162 -0
- package/cli/lib/index.js +4 -0
- package/cli/lib/main.js +130 -0
- package/package.json +38 -4
- package/recipes/agents/agent-memory/RECIPE.md +75 -0
- package/recipes/agents/agent-memory/files/agentic/memory/__init__.py +25 -0
- package/recipes/agents/agent-memory/files/agentic/memory/base.py +101 -0
- package/recipes/agents/agent-memory/files/agentic/memory/factory.py +33 -0
- package/recipes/agents/agent-memory/files/agentic/memory/in_memory.py +59 -0
- package/recipes/agents/agent-memory/files/agentic/memory/models.py +66 -0
- package/recipes/agents/agent-memory/files/agentic/memory/settings.py +24 -0
- package/recipes/agents/agent-memory/files/agentic/memory/sql.py +177 -0
- package/recipes/agents/agent-memory/files/pytest.ini +5 -0
- package/recipes/agents/agent-memory/files/tests/__init__.py +0 -0
- package/recipes/agents/agent-memory/files/tests/memory_conformance.py +158 -0
- package/recipes/agents/agent-memory/files/tests/test_memory.py +74 -0
- package/recipes/agents/langchain-agent/RECIPE.md +101 -0
- package/recipes/agents/langchain-agent/files/agentic/__init__.py +10 -0
- package/recipes/agents/langchain-agent/files/agentic/agents/__init__.py +13 -0
- package/recipes/agents/langchain-agent/files/agentic/agents/agents.py +43 -0
- package/recipes/agents/langchain-agent/files/agentic/agents/base_agent.py +126 -0
- package/recipes/agents/langchain-agent/files/agentic/agents/models.py +46 -0
- package/recipes/agents/langchain-agent/files/agentic/context.py +21 -0
- package/recipes/agents/langchain-agent/files/agentic/llm/__init__.py +5 -0
- package/recipes/agents/langchain-agent/files/agentic/llm/models.py +45 -0
- package/recipes/agents/langchain-agent/files/agentic/llm/provider.py +78 -0
- package/recipes/agents/langchain-agent/files/agentic/llm/settings.py +62 -0
- package/recipes/agents/langchain-agent/files/agentic/middleware/__init__.py +3 -0
- package/recipes/agents/langchain-agent/files/agentic/middleware/language.py +28 -0
- package/recipes/agents/langchain-agent/files/agentic/prompts/__init__.py +3 -0
- package/recipes/agents/langchain-agent/files/agentic/prompts/assistant.en.yaml +15 -0
- package/recipes/agents/langchain-agent/files/agentic/prompts/assistant.es.yaml +15 -0
- package/recipes/agents/langchain-agent/files/agentic/prompts/loader.py +69 -0
- package/recipes/agents/langchain-agent/files/agentic/tools/__init__.py +25 -0
- package/recipes/agents/langchain-agent/files/agentic/tools/base_tool.py +62 -0
- package/recipes/agents/langchain-agent/files/agentic/tools/search_documents.py +42 -0
- package/recipes/agents/langchain-agent/files/pytest.ini +5 -0
- package/recipes/agents/langchain-agent/files/tests/__init__.py +0 -0
- package/recipes/agents/langchain-agent/files/tests/fakes.py +30 -0
- package/recipes/agents/langchain-agent/files/tests/test_agents.py +151 -0
- package/recipes/agents/langgraph-graph/RECIPE.md +63 -0
- package/recipes/agents/langgraph-graph/files/agentic/conversation.py +73 -0
- package/recipes/agents/langgraph-graph/files/agentic/graph/__init__.py +17 -0
- package/recipes/agents/langgraph-graph/files/agentic/graph/builder.py +37 -0
- package/recipes/agents/langgraph-graph/files/agentic/graph/edges.py +8 -0
- package/recipes/agents/langgraph-graph/files/agentic/graph/event_processor.py +48 -0
- package/recipes/agents/langgraph-graph/files/agentic/graph/events.py +30 -0
- package/recipes/agents/langgraph-graph/files/agentic/graph/graph.py +60 -0
- package/recipes/agents/langgraph-graph/files/agentic/graph/nodes.py +63 -0
- package/recipes/agents/langgraph-graph/files/agentic/graph/state.py +31 -0
- package/recipes/agents/langgraph-graph/files/agentic/registry.py +85 -0
- package/recipes/agents/langgraph-graph/files/tests/test_graph.py +145 -0
- package/recipes/backend/.gitkeep +0 -0
- package/recipes/backend/agent-chat-api/RECIPE.md +69 -0
- package/recipes/backend/agent-chat-api/files/api/agent/guards.py +35 -0
- package/recipes/backend/agent-chat-api/files/api/agent/router.py +86 -0
- package/recipes/backend/agent-chat-api/files/api/agent/sanitize.py +22 -0
- package/recipes/backend/agent-chat-api/files/api/agent/schemas.py +26 -0
- package/recipes/backend/agent-chat-api/files/api/agent/settings.py +14 -0
- package/recipes/backend/agent-chat-api/files/api/agent/tracing.py +38 -0
- package/recipes/backend/agent-chat-api/files/api/app.py +67 -0
- package/recipes/backend/agent-chat-api/files/api/auth.py +73 -0
- package/recipes/backend/agent-chat-api/files/pytest.ini +5 -0
- package/recipes/backend/agent-chat-api/files/tests/test_agent_api.py +237 -0
- package/recipes/backend/agent-feedback/RECIPE.md +63 -0
- package/recipes/backend/agent-feedback/files/api/feedback/__init__.py +0 -0
- package/recipes/backend/agent-feedback/files/api/feedback/router.py +72 -0
- package/recipes/backend/agent-feedback/files/api/feedback/schemas.py +44 -0
- package/recipes/backend/agent-feedback/files/feedback/__init__.py +25 -0
- package/recipes/backend/agent-feedback/files/feedback/base.py +53 -0
- package/recipes/backend/agent-feedback/files/feedback/factory.py +30 -0
- package/recipes/backend/agent-feedback/files/feedback/in_memory.py +29 -0
- package/recipes/backend/agent-feedback/files/feedback/models.py +48 -0
- package/recipes/backend/agent-feedback/files/feedback/settings.py +17 -0
- package/recipes/backend/agent-feedback/files/feedback/sql.py +102 -0
- package/recipes/backend/agent-feedback/files/pytest.ini +5 -0
- package/recipes/backend/agent-feedback/files/tests/feedback_conformance.py +89 -0
- package/recipes/backend/agent-feedback/files/tests/test_feedback.py +63 -0
- package/recipes/backend/agent-feedback/files/tests/test_feedback_api.py +95 -0
- package/recipes/backend/auth-verifier/RECIPE.md +63 -0
- package/recipes/backend/auth-verifier/files/api/auth.py +73 -0
- package/recipes/backend/auth-verifier/files/auth/__init__.py +23 -0
- package/recipes/backend/auth-verifier/files/auth/factory.py +28 -0
- package/recipes/backend/auth-verifier/files/auth/jwt_verifier.py +101 -0
- package/recipes/backend/auth-verifier/files/auth/models.py +29 -0
- package/recipes/backend/auth-verifier/files/auth/settings.py +45 -0
- package/recipes/backend/auth-verifier/files/auth/supabase.py +80 -0
- package/recipes/backend/auth-verifier/files/pytest.ini +5 -0
- package/recipes/backend/auth-verifier/files/tests/__init__.py +0 -0
- package/recipes/backend/auth-verifier/files/tests/test_auth.py +229 -0
- package/recipes/backend/conversation-history/RECIPE.md +49 -0
- package/recipes/backend/conversation-history/files/api/conversations/__init__.py +0 -0
- package/recipes/backend/conversation-history/files/api/conversations/router.py +55 -0
- package/recipes/backend/conversation-history/files/api/conversations/schemas.py +57 -0
- package/recipes/backend/conversation-history/files/pytest.ini +5 -0
- package/recipes/backend/conversation-history/files/tests/test_conversations_api.py +127 -0
- package/recipes/backend/fastapi-base/RECIPE.md +57 -0
- package/recipes/backend/fastapi-base/files/api/app.py +37 -0
- package/recipes/backend/fastapi-base/files/api/base.py +54 -0
- package/recipes/backend/fastapi-base/files/api/errors.py +31 -0
- package/recipes/backend/fastapi-base/files/api/health.py +19 -0
- package/recipes/backend/fastapi-base/files/api/logging_setup.py +26 -0
- package/recipes/backend/fastapi-base/files/api/request_id.py +62 -0
- package/recipes/backend/fastapi-base/files/api/settings.py +32 -0
- package/recipes/backend/fastapi-base/files/pytest.ini +5 -0
- package/recipes/backend/fastapi-base/files/tests/__init__.py +0 -0
- package/recipes/backend/fastapi-base/files/tests/test_api_base.py +136 -0
- package/recipes/backend/observability/RECIPE.md +68 -0
- package/recipes/backend/observability/files/observability/__init__.py +34 -0
- package/recipes/backend/observability/files/observability/factory.py +73 -0
- package/recipes/backend/observability/files/observability/langfuse_tracer.py +29 -0
- package/recipes/backend/observability/files/observability/langsmith_tracer.py +23 -0
- package/recipes/backend/observability/files/observability/models.py +90 -0
- package/recipes/backend/observability/files/observability/opik_tracer.py +30 -0
- package/recipes/backend/observability/files/observability/settings.py +58 -0
- package/recipes/backend/observability/files/observability/tracer.py +142 -0
- package/recipes/backend/observability/files/observability/usage.py +61 -0
- package/recipes/backend/observability/files/pytest.ini +5 -0
- package/recipes/backend/observability/files/tests/__init__.py +0 -0
- package/recipes/backend/observability/files/tests/test_observability.py +219 -0
- package/recipes/backend/project-settings/RECIPE.md +40 -0
- package/recipes/backend/project-settings/files/.env.example +7 -0
- package/recipes/backend/project-settings/files/core/__init__.py +0 -0
- package/recipes/backend/project-settings/files/core/config.py +41 -0
- package/recipes/backend/project-settings/files/pytest.ini +3 -0
- package/recipes/backend/project-settings/files/tests/__init__.py +0 -0
- package/recipes/backend/project-settings/files/tests/test_settings.py +44 -0
- package/recipes/backend/rag-retriever/RECIPE.md +79 -0
- package/recipes/backend/rag-retriever/files/pytest.ini +5 -0
- package/recipes/backend/rag-retriever/files/rag/__init__.py +53 -0
- package/recipes/backend/rag-retriever/files/rag/base.py +106 -0
- package/recipes/backend/rag-retriever/files/rag/chunking.py +84 -0
- package/recipes/backend/rag-retriever/files/rag/document_search.py +60 -0
- package/recipes/backend/rag-retriever/files/rag/embeddings.py +91 -0
- package/recipes/backend/rag-retriever/files/rag/factory.py +82 -0
- package/recipes/backend/rag-retriever/files/rag/in_memory.py +52 -0
- package/recipes/backend/rag-retriever/files/rag/models.py +107 -0
- package/recipes/backend/rag-retriever/files/rag/pgvector.py +138 -0
- package/recipes/backend/rag-retriever/files/rag/qdrant.py +96 -0
- package/recipes/backend/rag-retriever/files/rag/settings.py +48 -0
- package/recipes/backend/rag-retriever/files/tests/__init__.py +0 -0
- package/recipes/backend/rag-retriever/files/tests/rag_conformance.py +95 -0
- package/recipes/backend/rag-retriever/files/tests/test_rag.py +270 -0
- package/recipes/backend/rate-limit-quota/RECIPE.md +77 -0
- package/recipes/backend/rate-limit-quota/files/api/agent/guards.py +62 -0
- package/recipes/backend/rate-limit-quota/files/api/limits/__init__.py +0 -0
- package/recipes/backend/rate-limit-quota/files/api/limits/router.py +38 -0
- package/recipes/backend/rate-limit-quota/files/limits/__init__.py +43 -0
- package/recipes/backend/rate-limit-quota/files/limits/base.py +161 -0
- package/recipes/backend/rate-limit-quota/files/limits/factory.py +69 -0
- package/recipes/backend/rate-limit-quota/files/limits/in_memory.py +36 -0
- package/recipes/backend/rate-limit-quota/files/limits/models.py +108 -0
- package/recipes/backend/rate-limit-quota/files/limits/settings.py +32 -0
- package/recipes/backend/rate-limit-quota/files/limits/sql.py +94 -0
- package/recipes/backend/rate-limit-quota/files/pytest.ini +5 -0
- package/recipes/backend/rate-limit-quota/files/tests/limits_conformance.py +146 -0
- package/recipes/backend/rate-limit-quota/files/tests/test_limits.py +167 -0
- package/recipes/backend/rate-limit-quota/files/tests/test_limits_api.py +100 -0
- package/recipes/backend/voice-providers/RECIPE.md +73 -0
- package/recipes/backend/voice-providers/files/api/__init__.py +0 -0
- package/recipes/backend/voice-providers/files/api/voice/__init__.py +0 -0
- package/recipes/backend/voice-providers/files/api/voice/router.py +113 -0
- package/recipes/backend/voice-providers/files/pytest.ini +5 -0
- package/recipes/backend/voice-providers/files/tests/__init__.py +0 -0
- package/recipes/backend/voice-providers/files/tests/fake_openai.py +44 -0
- package/recipes/backend/voice-providers/files/tests/test_voice.py +164 -0
- package/recipes/backend/voice-providers/files/tests/test_voice_api.py +106 -0
- package/recipes/backend/voice-providers/files/tests/voice_conformance.py +80 -0
- package/recipes/backend/voice-providers/files/voice/__init__.py +29 -0
- package/recipes/backend/voice-providers/files/voice/base.py +116 -0
- package/recipes/backend/voice-providers/files/voice/factory.py +48 -0
- package/recipes/backend/voice-providers/files/voice/fake.py +51 -0
- package/recipes/backend/voice-providers/files/voice/models.py +85 -0
- package/recipes/backend/voice-providers/files/voice/openai_provider.py +116 -0
- package/recipes/backend/voice-providers/files/voice/settings.py +48 -0
- package/recipes/frontend/.gitkeep +0 -0
- package/recipes/frontend/playwright-e2e/RECIPE.md +48 -0
- package/recipes/frontend/playwright-e2e/files/.github/workflows/frontend.yml +35 -0
- package/recipes/frontend/playwright-e2e/files/e2e/helpers.ts +25 -0
- package/recipes/frontend/playwright-e2e/files/e2e/home.spec.ts +10 -0
- package/recipes/frontend/playwright-e2e/files/e2e/login.spec.ts +26 -0
- package/recipes/frontend/playwright-e2e/files/e2e/navigation.spec.ts +27 -0
- package/recipes/frontend/playwright-e2e/files/playwright.config.ts +35 -0
- package/recipes/frontend/react-agent-chat/RECIPE.md +69 -0
- package/recipes/frontend/react-agent-chat/files/src/features/chat/chat-api.ts +27 -0
- package/recipes/frontend/react-agent-chat/files/src/features/chat/chat.css +18 -0
- package/recipes/frontend/react-agent-chat/files/src/features/chat/chat.test.tsx +139 -0
- package/recipes/frontend/react-agent-chat/files/src/features/chat/components/ChatView.tsx +22 -0
- package/recipes/frontend/react-agent-chat/files/src/features/chat/components/Composer.tsx +40 -0
- package/recipes/frontend/react-agent-chat/files/src/features/chat/components/Markdown.tsx +20 -0
- package/recipes/frontend/react-agent-chat/files/src/features/chat/components/MessageList.tsx +42 -0
- package/recipes/frontend/react-agent-chat/files/src/features/chat/events.ts +42 -0
- package/recipes/frontend/react-agent-chat/files/src/features/chat/fake-chat-api.ts +44 -0
- package/recipes/frontend/react-agent-chat/files/src/features/chat/index.ts +6 -0
- package/recipes/frontend/react-agent-chat/files/src/features/chat/sse-parser.test.ts +97 -0
- package/recipes/frontend/react-agent-chat/files/src/features/chat/sse-parser.ts +85 -0
- package/recipes/frontend/react-agent-chat/files/src/features/chat/use-chat.ts +136 -0
- package/recipes/frontend/react-app-router/RECIPE.md +58 -0
- package/recipes/frontend/react-app-router/files/src/App.test.tsx +54 -0
- package/recipes/frontend/react-app-router/files/src/App.tsx +14 -0
- package/recipes/frontend/react-app-router/files/src/router/ErrorScreen.tsx +21 -0
- package/recipes/frontend/react-app-router/files/src/router/Layout.tsx +28 -0
- package/recipes/frontend/react-app-router/files/src/router/NotFoundScreen.tsx +12 -0
- package/recipes/frontend/react-app-router/files/src/router/index.ts +1 -0
- package/recipes/frontend/react-app-router/files/src/router/router.css +29 -0
- package/recipes/frontend/react-app-router/files/src/router/router.test.tsx +65 -0
- package/recipes/frontend/react-app-router/files/src/router/routes.tsx +59 -0
- package/recipes/frontend/react-app-router/files/src/screens/SettingsScreen.tsx +10 -0
- package/recipes/frontend/react-supabase-auth/RECIPE.md +77 -0
- package/recipes/frontend/react-supabase-auth/files/src/auth/LoginScreen.tsx +64 -0
- package/recipes/frontend/react-supabase-auth/files/src/auth/SignOutButton.tsx +12 -0
- package/recipes/frontend/react-supabase-auth/files/src/auth/auth.css +33 -0
- package/recipes/frontend/react-supabase-auth/files/src/auth/auth.test.ts +149 -0
- package/recipes/frontend/react-supabase-auth/files/src/auth/auth.ts +59 -0
- package/recipes/frontend/react-supabase-auth/files/src/auth/fake-auth.ts +87 -0
- package/recipes/frontend/react-supabase-auth/files/src/auth/fake-gotrue.ts +85 -0
- package/recipes/frontend/react-supabase-auth/files/src/auth/index.ts +7 -0
- package/recipes/frontend/react-supabase-auth/files/src/auth/make-auth.ts +20 -0
- package/recipes/frontend/react-supabase-auth/files/src/auth/session-context.tsx +35 -0
- package/recipes/frontend/react-supabase-auth/files/src/auth/session-store.ts +63 -0
- package/recipes/frontend/react-supabase-auth/files/src/auth/session.test.tsx +56 -0
- package/recipes/frontend/react-supabase-auth/files/src/auth/settings.ts +30 -0
- package/recipes/frontend/react-supabase-auth/files/src/auth/supabase-auth.ts +85 -0
- package/recipes/frontend/vite-react-base/RECIPE.md +69 -0
- package/recipes/frontend/vite-react-base/files/.env +6 -0
- package/recipes/frontend/vite-react-base/files/.env.fake +2 -0
- package/recipes/frontend/vite-react-base/files/index.html +12 -0
- package/recipes/frontend/vite-react-base/files/package.json +30 -0
- package/recipes/frontend/vite-react-base/files/src/App.test.tsx +49 -0
- package/recipes/frontend/vite-react-base/files/src/App.tsx +13 -0
- package/recipes/frontend/vite-react-base/files/src/api/api.ts +37 -0
- package/recipes/frontend/vite-react-base/files/src/api/fake/fake-api.ts +29 -0
- package/recipes/frontend/vite-react-base/files/src/api/http-api.ts +16 -0
- package/recipes/frontend/vite-react-base/files/src/api/http-client.test.ts +84 -0
- package/recipes/frontend/vite-react-base/files/src/api/http-client.ts +94 -0
- package/recipes/frontend/vite-react-base/files/src/api/make-api.ts +30 -0
- package/recipes/frontend/vite-react-base/files/src/api/types.ts +7 -0
- package/recipes/frontend/vite-react-base/files/src/app-context.tsx +24 -0
- package/recipes/frontend/vite-react-base/files/src/auth/token-provider.ts +27 -0
- package/recipes/frontend/vite-react-base/files/src/config.ts +18 -0
- package/recipes/frontend/vite-react-base/files/src/hooks/use-load.ts +46 -0
- package/recipes/frontend/vite-react-base/files/src/main.tsx +27 -0
- package/recipes/frontend/vite-react-base/files/src/screens/HomeScreen.tsx +28 -0
- package/recipes/frontend/vite-react-base/files/src/styles/global.css +25 -0
- package/recipes/frontend/vite-react-base/files/src/styles/tokens.css +33 -0
- package/recipes/frontend/vite-react-base/files/src/styles/tokens.test.ts +45 -0
- package/recipes/frontend/vite-react-base/files/src/test-setup.ts +8 -0
- package/recipes/frontend/vite-react-base/files/src/vite-env.d.ts +11 -0
- package/recipes/frontend/vite-react-base/files/tsconfig.json +18 -0
- package/recipes/frontend/vite-react-base/files/vite.config.ts +19 -0
- package/unpacked-files.json +3 -0
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
"""History routes over the app from agent-chat-api with an in-memory `Memory` and a fake clock.
|
|
2
|
+
Needs agent-chat-api (and what it requires) copied next to `api/conversations/`."""
|
|
3
|
+
|
|
4
|
+
import httpx
|
|
5
|
+
from langchain_core.messages import AIMessage, HumanMessage, ToolMessage
|
|
6
|
+
|
|
7
|
+
from agentic.memory import InMemoryMemory, MemoryKey
|
|
8
|
+
from api.agent.settings import AgentApiSettings
|
|
9
|
+
from api.app import create_app
|
|
10
|
+
from api.auth import StaticTokenVerifier
|
|
11
|
+
from api.conversations.router import router as conversations_router
|
|
12
|
+
|
|
13
|
+
from .memory_conformance import FakeClock
|
|
14
|
+
from .test_agent_api import TOKENS, auth
|
|
15
|
+
|
|
16
|
+
ALICE = MemoryKey(tenant_id="tenant-1", user_id="user-1", conversation_id="conv-1")
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
def make_app(clock: FakeClock | None = None) -> tuple[object, InMemoryMemory]:
|
|
20
|
+
memory = InMemoryMemory(clock=clock or FakeClock())
|
|
21
|
+
app = create_app(
|
|
22
|
+
settings=AgentApiSettings(),
|
|
23
|
+
token_verifier=StaticTokenVerifier(TOKENS),
|
|
24
|
+
memory=memory,
|
|
25
|
+
document_search=None,
|
|
26
|
+
)
|
|
27
|
+
app.include_router(conversations_router)
|
|
28
|
+
return app, memory
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
def client(app) -> httpx.AsyncClient:
|
|
32
|
+
return httpx.AsyncClient(transport=httpx.ASGITransport(app=app), base_url="http://test")
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
async def seed(memory: InMemoryMemory, clock: FakeClock) -> None:
|
|
36
|
+
await memory.add_messages(ALICE, [HumanMessage("¿Qué es RAG?", id="h1"), AIMessage("Retrieval…", id="a1")])
|
|
37
|
+
clock.advance(60)
|
|
38
|
+
await memory.add_messages(
|
|
39
|
+
ALICE.model_copy(update={"conversation_id": "conv-2"}),
|
|
40
|
+
[
|
|
41
|
+
HumanMessage("busca algo", id="h2"),
|
|
42
|
+
AIMessage("", id="call2", tool_calls=[{"name": "search", "args": {}, "id": "t2"}]),
|
|
43
|
+
ToolMessage("resultado", tool_call_id="t2", id="tool2"),
|
|
44
|
+
AIMessage("Encontré esto", id="a2"),
|
|
45
|
+
],
|
|
46
|
+
)
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
async def test_routes_need_a_token():
|
|
50
|
+
app, _ = make_app()
|
|
51
|
+
async with client(app) as c:
|
|
52
|
+
assert (await c.get("/conversations")).status_code == 401
|
|
53
|
+
assert (await c.get("/conversations/conv-1/messages")).status_code == 401
|
|
54
|
+
assert (await c.delete("/conversations/conv-1")).status_code == 401
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
async def test_list_is_newest_first_with_titles_and_pagination():
|
|
58
|
+
clock = FakeClock()
|
|
59
|
+
app, memory = make_app(clock)
|
|
60
|
+
await seed(memory, clock)
|
|
61
|
+
async with client(app) as c:
|
|
62
|
+
body = (await c.get("/conversations", headers=auth())).json()
|
|
63
|
+
page = (await c.get("/conversations?limit=1&offset=1", headers=auth())).json()
|
|
64
|
+
bob = (await c.get("/conversations", headers=auth("tok-bob"))).json()
|
|
65
|
+
bad = await c.get("/conversations?limit=0", headers=auth())
|
|
66
|
+
|
|
67
|
+
assert body == {
|
|
68
|
+
"conversations": [
|
|
69
|
+
{
|
|
70
|
+
"conversation_id": "conv-2",
|
|
71
|
+
"title": "busca algo",
|
|
72
|
+
"created_at": "2026-03-30T10:01:00Z",
|
|
73
|
+
"updated_at": "2026-03-30T10:01:00Z",
|
|
74
|
+
"message_count": 4,
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
"conversation_id": "conv-1",
|
|
78
|
+
"title": "¿Qué es RAG?",
|
|
79
|
+
"created_at": "2026-03-30T10:00:00Z",
|
|
80
|
+
"updated_at": "2026-03-30T10:00:00Z",
|
|
81
|
+
"message_count": 2,
|
|
82
|
+
},
|
|
83
|
+
]
|
|
84
|
+
}
|
|
85
|
+
assert [c["conversation_id"] for c in page["conversations"]] == ["conv-1"]
|
|
86
|
+
assert bob == {"conversations": []}
|
|
87
|
+
assert bad.status_code == 422
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
async def test_messages_show_only_user_and_assistant_text():
|
|
91
|
+
clock = FakeClock()
|
|
92
|
+
app, memory = make_app(clock)
|
|
93
|
+
await seed(memory, clock)
|
|
94
|
+
async with client(app) as c:
|
|
95
|
+
body = (await c.get("/conversations/conv-2/messages", headers=auth())).json()
|
|
96
|
+
|
|
97
|
+
assert body == {
|
|
98
|
+
"conversation_id": "conv-2",
|
|
99
|
+
"messages": [
|
|
100
|
+
{"id": "h2", "role": "user", "content": "busca algo", "created_at": "2026-03-30T10:01:00Z"},
|
|
101
|
+
{"id": "a2", "role": "assistant", "content": "Encontré esto", "created_at": "2026-03-30T10:01:00Z"},
|
|
102
|
+
],
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
async def test_someone_elses_or_unknown_conversation_is_404():
|
|
107
|
+
clock = FakeClock()
|
|
108
|
+
app, memory = make_app(clock)
|
|
109
|
+
await seed(memory, clock)
|
|
110
|
+
async with client(app) as c:
|
|
111
|
+
assert (await c.get("/conversations/conv-1/messages", headers=auth("tok-bob"))).status_code == 404
|
|
112
|
+
assert (await c.get("/conversations/nope/messages", headers=auth())).status_code == 404
|
|
113
|
+
assert (await c.get("/conversations/bad%20id/messages", headers=auth())).status_code == 422
|
|
114
|
+
assert (await c.delete("/conversations/conv-1", headers=auth("tok-bob"))).status_code == 404
|
|
115
|
+
assert len(await memory.get_history(ALICE)) == 2 # bob's delete did not touch alice's thread
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
async def test_delete_forgets_the_conversation():
|
|
119
|
+
clock = FakeClock()
|
|
120
|
+
app, memory = make_app(clock)
|
|
121
|
+
await seed(memory, clock)
|
|
122
|
+
async with client(app) as c:
|
|
123
|
+
assert (await c.delete("/conversations/conv-1", headers=auth())).status_code == 204
|
|
124
|
+
assert (await c.get("/conversations/conv-1/messages", headers=auth())).status_code == 404
|
|
125
|
+
remaining = (await c.get("/conversations", headers=auth())).json()["conversations"]
|
|
126
|
+
|
|
127
|
+
assert [r["conversation_id"] for r in remaining] == ["conv-2"]
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# fastapi-base
|
|
2
|
+
|
|
3
|
+
## Cuándo usarla
|
|
4
|
+
|
|
5
|
+
Para **arrancar cualquier backend FastAPI** con la fontanería que todos los proyectos acaban teniendo: id de petición en cada respuesta y en cada línea de log, fallos inesperados como 500 sin internals, un formato de error con `code`, CORS desde settings, `/health` y `/docs` solo cuando se pide. Es la base sobre la que `agent-chat-api` monta el chat.
|
|
6
|
+
|
|
7
|
+
No depende de otras recetas. **Usa `project-settings`** (bloque `ApiSettings`).
|
|
8
|
+
|
|
9
|
+
## Qué incluye
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
api/
|
|
13
|
+
base.py build_app(title, lifespan, docs, cors_origins): FastAPI + request id + CORS + /health
|
|
14
|
+
app.py create_app(settings): plantilla del create_app del proyecto (agent-chat-api la sustituye)
|
|
15
|
+
request_id.py X-Request-ID (del cliente si es sano, si no uuid), contextvar, RequestIdFilter, 500 sin internals
|
|
16
|
+
errors.py ApiError(status, code, **extra) → {"detail": {"code": ..., ...}} · ErrorDetail
|
|
17
|
+
logging_setup.py configure_logging(level): formato con [request_id], uvicorn.access y httpx silenciados
|
|
18
|
+
health.py GET /health {status: ok} sin auth ni dependencias
|
|
19
|
+
settings.py bloque ApiSettings: CORS_ORIGINS (coma), DOCS_ENABLED
|
|
20
|
+
tests/test_api_base.py 11 tests: health, request id propio y del cliente, 500 sin fuga, ApiError, CORS, docs, settings, logging
|
|
21
|
+
pytest.ini
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Decisiones
|
|
25
|
+
|
|
26
|
+
- **`build_app` y `create_app` separados.** `build_app` es la fontanería, igual en todos los proyectos; `create_app` es del proyecto: servicios en `app.state`, lifespan, routers. Las recetas que montan algo encima (`agent-chat-api`) traen su `create_app` y llaman a `build_app`. Nada lee el entorno: todo se inyecta.
|
|
27
|
+
- **El cuerpo de error sigue siendo `{"detail": ...}`.** Un sobre propio `{error: {code, message, request_id}}` es una opción válida, pero los frontends existentes (y `react-agent-chat`) leen `detail`, y FastAPI ya lo produce para 401, 404 y 422. La convención es: cuando el cliente tiene que distinguir casos, `detail` es un objeto con `code` (`ApiError`); si no, una cadena. Los 500 inesperados son `{"detail": {"code": "internal_error", "request_id"}}`.
|
|
28
|
+
- **El id de la petición lo pone el cliente si quiere:** se respeta `X-Request-ID` si es `[A-Za-z0-9._-]{1,64}`; si no, se genera. Va en `request.state`, en un contextvar para los logs y en la respuesta, también en los errores y en CORS (`expose_headers`).
|
|
29
|
+
- **500 sin internals, con el mismo id en el log.** El middleware captura lo que nadie manejó, hace `logger.exception` y responde con `code` e id. El cliente nunca ve el traceback; soporte cruza el id con el log.
|
|
30
|
+
- **CORS solo si hay orígenes** y añadido primero para que quede el más externo: el preflight se responde antes de pasar por nada. `allow_credentials=True` con lista explícita, nunca `*`.
|
|
31
|
+
- **`/health` sin dependencias.** Es liveness. Un readiness que toque la base de datos es otra ruta con sus timeouts; si no, la API cae con la base de datos.
|
|
32
|
+
- **`/docs` y `/openapi.json` apagados por defecto:** publican el mapa completo de la API. `DOCS_ENABLED=true` en local.
|
|
33
|
+
- **`logging` estándar con el id en el formato.** Un solo sitio (`configure_logging`) para cambiar a JSON o structlog cuando haya colector.
|
|
34
|
+
|
|
35
|
+
## Cómo adaptarla
|
|
36
|
+
|
|
37
|
+
1. Copia `files/` en la raíz del backend. Sustituye `{{app_name}}` en `api/app.py`.
|
|
38
|
+
2. **Settings:** `class Settings(ApiSettings, BaseAppSettings)`. En el `.env`: `CORS_ORIGINS=http://localhost:5173` y, en local, `DOCS_ENABLED=true`.
|
|
39
|
+
3. **`main.py`:**
|
|
40
|
+
|
|
41
|
+
```python
|
|
42
|
+
settings = get_settings()
|
|
43
|
+
configure_logging(settings.log_level)
|
|
44
|
+
app = create_app(settings=settings)
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
`uvicorn main:app`. Añade tus routers en `create_app` con `app.include_router(...)`.
|
|
48
|
+
4. **Errores con código:** `raise ApiError(409, "inventory_closed", closed_at=...)`. Para un 404 corriente, `HTTPException(404, "Not Found")` sigue valiendo.
|
|
49
|
+
5. **Excepciones de dominio:** `app.add_exception_handler(MyDomainError, handler)` en `create_app`, devolviendo `JSONResponse({"detail": {"code": ...}})`; el middleware añadirá el id.
|
|
50
|
+
6. Para comprobarla: `pytest` en solitario (11 tests) o con las recetas backend (`agent-chat-api` y las demás: 158 con las diez).
|
|
51
|
+
|
|
52
|
+
**Dependencias:** `fastapi`, `pydantic-settings>=2.7` (`NoDecode`); `httpx` en tests.
|
|
53
|
+
|
|
54
|
+
## Origen
|
|
55
|
+
|
|
56
|
+
- Probado en producción: middleware que etiqueta la petición con `request_id`, lo pone en el log y convierte cualquier fallo en un JSON sin internals; `create_app(settings)` con servicios en `app.state`; `/health` sin dependencias; `X-Request-ID` del cliente respetado y devuelto; CORS antes del resto de middlewares; docs apagados fuera de desarrollo; orígenes CORS separados por comas desde settings.
|
|
57
|
+
- Nuevo en esta receta: `detail` con `code` como formato único (en vez del sobre `{error: ...}`) y `ApiError`, para conservar el contrato que ya leen los frontends.
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
"""`create_app(...)`: the project's app. Everything it needs is injected; nothing reads the environment.
|
|
2
|
+
|
|
3
|
+
# main.py
|
|
4
|
+
settings = get_settings() # project-settings, with ApiSettings mixed in
|
|
5
|
+
configure_logging(settings.log_level)
|
|
6
|
+
app = create_app(settings=settings)
|
|
7
|
+
|
|
8
|
+
Other recipes replace this file with a `create_app` that takes their services (`agent-chat-api`
|
|
9
|
+
takes the token verifier and the memory) and still starts from `build_app`.
|
|
10
|
+
"""
|
|
11
|
+
|
|
12
|
+
from collections.abc import AsyncIterator
|
|
13
|
+
from contextlib import asynccontextmanager
|
|
14
|
+
|
|
15
|
+
from fastapi import FastAPI
|
|
16
|
+
|
|
17
|
+
from .base import build_app
|
|
18
|
+
from .settings import ApiSettings
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
def create_app(*, settings: ApiSettings, docs: bool | None = None) -> FastAPI:
|
|
22
|
+
"""`docs=None` -> `settings.docs_enabled`."""
|
|
23
|
+
|
|
24
|
+
@asynccontextmanager
|
|
25
|
+
async def lifespan(app: FastAPI) -> AsyncIterator[None]:
|
|
26
|
+
# Open what the app needs (DB engine, HTTP clients) and put it in app.state; close it after yield.
|
|
27
|
+
yield
|
|
28
|
+
|
|
29
|
+
app = build_app(
|
|
30
|
+
title="{{app_name}}",
|
|
31
|
+
lifespan=lifespan,
|
|
32
|
+
docs=settings.docs_enabled if docs is None else docs,
|
|
33
|
+
cors_origins=settings.cors_origins,
|
|
34
|
+
)
|
|
35
|
+
app.state.api_settings = settings
|
|
36
|
+
# app.include_router(my_router)
|
|
37
|
+
return app
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
"""`build_app(...)`: a FastAPI app with the plumbing every backend here has, and nothing else.
|
|
2
|
+
|
|
3
|
+
request id on every request, response and log line (request_id.py)
|
|
4
|
+
unexpected failures as 500 without internals (request_id.py)
|
|
5
|
+
CORS only when origins are configured
|
|
6
|
+
GET /health
|
|
7
|
+
/docs and /openapi.json only when asked for
|
|
8
|
+
|
|
9
|
+
Your `create_app` (see `app.py`) calls it, then puts services in `app.state` and includes routers.
|
|
10
|
+
Nothing is read from the environment here: the caller passes what it wants.
|
|
11
|
+
"""
|
|
12
|
+
|
|
13
|
+
from collections.abc import Callable, Sequence
|
|
14
|
+
from contextlib import AbstractAsyncContextManager
|
|
15
|
+
from typing import Any
|
|
16
|
+
|
|
17
|
+
from fastapi import FastAPI
|
|
18
|
+
from fastapi.middleware.cors import CORSMiddleware
|
|
19
|
+
|
|
20
|
+
from .health import router as health_router
|
|
21
|
+
from .request_id import install_request_id
|
|
22
|
+
|
|
23
|
+
Lifespan = Callable[[FastAPI], AbstractAsyncContextManager[Any]]
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
def build_app(
|
|
27
|
+
*,
|
|
28
|
+
title: str,
|
|
29
|
+
lifespan: Lifespan | None = None,
|
|
30
|
+
docs: bool = False,
|
|
31
|
+
cors_origins: Sequence[str] = (),
|
|
32
|
+
version: str = "0.1.0",
|
|
33
|
+
) -> FastAPI:
|
|
34
|
+
app = FastAPI(
|
|
35
|
+
title=title,
|
|
36
|
+
version=version,
|
|
37
|
+
lifespan=lifespan,
|
|
38
|
+
docs_url="/docs" if docs else None,
|
|
39
|
+
redoc_url=None,
|
|
40
|
+
openapi_url="/openapi.json" if docs else None,
|
|
41
|
+
)
|
|
42
|
+
if cors_origins:
|
|
43
|
+
# Added first so it ends up outermost: the preflight OPTIONS is answered before anything else.
|
|
44
|
+
app.add_middleware(
|
|
45
|
+
CORSMiddleware,
|
|
46
|
+
allow_origins=list(cors_origins),
|
|
47
|
+
allow_credentials=True,
|
|
48
|
+
allow_methods=["*"],
|
|
49
|
+
allow_headers=["*"],
|
|
50
|
+
expose_headers=["X-Request-ID", "Retry-After"],
|
|
51
|
+
)
|
|
52
|
+
install_request_id(app)
|
|
53
|
+
app.include_router(health_router)
|
|
54
|
+
return app
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
"""One error shape for the whole API, inside FastAPI's own `{"detail": ...}` envelope:
|
|
2
|
+
|
|
3
|
+
{"detail": {"code": "<machine_readable>", ...extra fields}}
|
|
4
|
+
|
|
5
|
+
`code` is what clients branch on (`rate_limited`, `ai_quota_daily_exhausted`...); the extra fields
|
|
6
|
+
are whatever that code needs (`resets_at`, `retry_after`). Plain `HTTPException(404, "Not Found")`
|
|
7
|
+
still works (its detail is a string) for errors nobody branches on. Unexpected failures become
|
|
8
|
+
`{"detail": {"code": "internal_error", "request_id": ...}}` (see `request_id.py`): the internals go
|
|
9
|
+
to the log, the id to the client, so support can match the two.
|
|
10
|
+
"""
|
|
11
|
+
|
|
12
|
+
from typing import Any
|
|
13
|
+
|
|
14
|
+
from fastapi import HTTPException
|
|
15
|
+
from pydantic import BaseModel, ConfigDict
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
class ErrorDetail(BaseModel):
|
|
19
|
+
"""What `detail` looks like when a client should branch on it. For OpenAPI and for tests."""
|
|
20
|
+
|
|
21
|
+
model_config = ConfigDict(frozen=True, extra="allow")
|
|
22
|
+
|
|
23
|
+
code: str
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
class ApiError(HTTPException):
|
|
27
|
+
"""`raise ApiError(409, "conversation_locked", resets_at=...)` -> 409 {"detail": {"code": ..., "resets_at": ...}}"""
|
|
28
|
+
|
|
29
|
+
def __init__(self, status_code: int, code: str, *, headers: dict[str, str] | None = None, **extra: Any) -> None:
|
|
30
|
+
super().__init__(status_code, {"code": code, **extra}, headers)
|
|
31
|
+
self.code = code
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"""GET /health: liveness, no auth, no dependencies. Readiness checks (DB, LLM provider) are a
|
|
2
|
+
different route with their own timeouts; a liveness probe that touches the DB takes the API
|
|
3
|
+
down with the DB."""
|
|
4
|
+
|
|
5
|
+
from fastapi import APIRouter
|
|
6
|
+
from pydantic import BaseModel, ConfigDict
|
|
7
|
+
|
|
8
|
+
router = APIRouter(tags=["health"])
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class HealthResponse(BaseModel):
|
|
12
|
+
model_config = ConfigDict(frozen=True)
|
|
13
|
+
|
|
14
|
+
status: str = "ok"
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
@router.get("/health", response_model=HealthResponse)
|
|
18
|
+
async def health() -> HealthResponse:
|
|
19
|
+
return HealthResponse()
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
"""Standard `logging` with the request id on every line. Called once, from `main.py`:
|
|
2
|
+
|
|
3
|
+
configure_logging(settings.log_level)
|
|
4
|
+
|
|
5
|
+
2026-03-30 10:00:00,000 INFO [3f2a9c1d8e7b4a05] api.agent.router: ...
|
|
6
|
+
|
|
7
|
+
Swap the format for JSON (or for structlog) here, in one place, when you ship to a log collector.
|
|
8
|
+
"""
|
|
9
|
+
|
|
10
|
+
import logging
|
|
11
|
+
import sys
|
|
12
|
+
|
|
13
|
+
from .request_id import RequestIdFilter
|
|
14
|
+
|
|
15
|
+
FORMAT = "%(asctime)s %(levelname)s [%(request_id)s] %(name)s: %(message)s"
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
def configure_logging(level: str = "INFO") -> None:
|
|
19
|
+
handler = logging.StreamHandler(sys.stdout)
|
|
20
|
+
handler.setFormatter(logging.Formatter(FORMAT))
|
|
21
|
+
handler.addFilter(RequestIdFilter())
|
|
22
|
+
root = logging.getLogger()
|
|
23
|
+
root.handlers = [handler]
|
|
24
|
+
root.setLevel(level.upper())
|
|
25
|
+
for noisy in ("uvicorn.access", "httpx"):
|
|
26
|
+
logging.getLogger(noisy).setLevel(max(logging.WARNING, root.level))
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
"""Every request gets an id, every response and every log line carry it, and nothing leaks on a crash.
|
|
2
|
+
|
|
3
|
+
- `X-Request-ID` from the client is kept (the frontend can generate one and trace end to end);
|
|
4
|
+
otherwise a short uuid4. Only `[A-Za-z0-9._-]{1,64}`: anything else is replaced, not trusted.
|
|
5
|
+
- The id lives in `request.state.request_id` and in a contextvar, so `logging` records get it
|
|
6
|
+
through `RequestIdFilter` without passing it around.
|
|
7
|
+
- An unhandled exception becomes 500 `{"detail": {"code": "internal_error", "request_id": ...}}`
|
|
8
|
+
and a `logger.exception` with the same id. The client never sees the traceback.
|
|
9
|
+
"""
|
|
10
|
+
|
|
11
|
+
import logging
|
|
12
|
+
import re
|
|
13
|
+
import uuid
|
|
14
|
+
from collections.abc import Awaitable, Callable
|
|
15
|
+
from contextvars import ContextVar
|
|
16
|
+
|
|
17
|
+
from fastapi import FastAPI, Request, Response
|
|
18
|
+
from fastapi.responses import JSONResponse
|
|
19
|
+
|
|
20
|
+
HEADER = "X-Request-ID"
|
|
21
|
+
VALID_ID = re.compile(r"^[A-Za-z0-9._-]{1,64}$")
|
|
22
|
+
|
|
23
|
+
request_id_var: ContextVar[str] = ContextVar("request_id", default="-")
|
|
24
|
+
logger = logging.getLogger(__name__)
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
def new_request_id() -> str:
|
|
28
|
+
return uuid.uuid4().hex[:16]
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
def current_request_id() -> str:
|
|
32
|
+
"""The id of the request being handled, or "-" outside one (startup, workers)."""
|
|
33
|
+
return request_id_var.get()
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
class RequestIdFilter(logging.Filter):
|
|
37
|
+
"""Adds `record.request_id` so a format can print `%(request_id)s`. See `logging_setup.py`."""
|
|
38
|
+
|
|
39
|
+
def filter(self, record: logging.LogRecord) -> bool:
|
|
40
|
+
record.request_id = request_id_var.get()
|
|
41
|
+
return True
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
async def request_id_middleware(request: Request, call_next: Callable[[Request], Awaitable[Response]]) -> Response:
|
|
45
|
+
incoming = request.headers.get(HEADER, "")
|
|
46
|
+
request_id = incoming if VALID_ID.match(incoming) else new_request_id()
|
|
47
|
+
request.state.request_id = request_id
|
|
48
|
+
token = request_id_var.set(request_id)
|
|
49
|
+
try:
|
|
50
|
+
try:
|
|
51
|
+
response = await call_next(request)
|
|
52
|
+
except Exception:
|
|
53
|
+
logger.exception("Unhandled error on %s %s", request.method, request.url.path)
|
|
54
|
+
response = JSONResponse({"detail": {"code": "internal_error", "request_id": request_id}}, status_code=500)
|
|
55
|
+
response.headers[HEADER] = request_id
|
|
56
|
+
return response
|
|
57
|
+
finally:
|
|
58
|
+
request_id_var.reset(token)
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
def install_request_id(app: FastAPI) -> None:
|
|
62
|
+
app.middleware("http")(request_id_middleware)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"""API settings BLOCK, meant to be mixed into the project settings (`project-settings` recipe):
|
|
2
|
+
|
|
3
|
+
class Settings(ApiSettings, BaseAppSettings): ...
|
|
4
|
+
|
|
5
|
+
Env vars: CORS_ORIGINS (comma-separated, empty = no CORS middleware), DOCS_ENABLED (false).
|
|
6
|
+
"""
|
|
7
|
+
|
|
8
|
+
from typing import Annotated
|
|
9
|
+
|
|
10
|
+
from pydantic import Field, field_validator
|
|
11
|
+
from pydantic_settings import BaseSettings, NoDecode, SettingsConfigDict
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
class ApiSettings(BaseSettings):
|
|
15
|
+
model_config = SettingsConfigDict(extra="ignore")
|
|
16
|
+
|
|
17
|
+
# NoDecode: pydantic-settings would otherwise expect JSON in the env var; we want "a, b".
|
|
18
|
+
cors_origins: Annotated[list[str], NoDecode] = Field(
|
|
19
|
+
default_factory=list,
|
|
20
|
+
description="Origins allowed to call the API from a browser. Empty: no CORS headers at all.",
|
|
21
|
+
)
|
|
22
|
+
docs_enabled: bool = Field(
|
|
23
|
+
default=False,
|
|
24
|
+
description="/docs and /openapi.json publish the whole map of the API: development only.",
|
|
25
|
+
)
|
|
26
|
+
|
|
27
|
+
@field_validator("cors_origins", mode="before")
|
|
28
|
+
@classmethod
|
|
29
|
+
def _split_commas(cls, value):
|
|
30
|
+
if isinstance(value, str):
|
|
31
|
+
return [origin.strip() for origin in value.split(",") if origin.strip()]
|
|
32
|
+
return value
|
|
File without changes
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
import logging
|
|
2
|
+
|
|
3
|
+
import httpx
|
|
4
|
+
import pytest
|
|
5
|
+
from fastapi import HTTPException
|
|
6
|
+
|
|
7
|
+
from api.base import build_app
|
|
8
|
+
from api.errors import ApiError, ErrorDetail
|
|
9
|
+
from api.logging_setup import FORMAT, configure_logging
|
|
10
|
+
from api.request_id import RequestIdFilter, current_request_id
|
|
11
|
+
from api.settings import ApiSettings
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
def make_app(**settings):
|
|
15
|
+
"""Straight from `build_app`, like any project's `create_app` does (so these tests also hold
|
|
16
|
+
when another recipe has replaced `api/app.py`)."""
|
|
17
|
+
api = ApiSettings(**settings)
|
|
18
|
+
app = build_app(title="test", docs=api.docs_enabled, cors_origins=api.cors_origins)
|
|
19
|
+
|
|
20
|
+
@app.get("/boom")
|
|
21
|
+
async def boom():
|
|
22
|
+
raise RuntimeError("db password is hunter2")
|
|
23
|
+
|
|
24
|
+
@app.get("/teapot")
|
|
25
|
+
async def teapot():
|
|
26
|
+
raise ApiError(418, "teapot", resets_at="never")
|
|
27
|
+
|
|
28
|
+
@app.get("/plain")
|
|
29
|
+
async def plain():
|
|
30
|
+
raise HTTPException(404, "Not Found")
|
|
31
|
+
|
|
32
|
+
@app.get("/whoami")
|
|
33
|
+
async def whoami():
|
|
34
|
+
return {"request_id": current_request_id()}
|
|
35
|
+
|
|
36
|
+
return app
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
def client(app) -> httpx.AsyncClient:
|
|
40
|
+
return httpx.AsyncClient(transport=httpx.ASGITransport(app=app), base_url="http://test")
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
async def test_health_needs_nothing():
|
|
44
|
+
async with client(make_app()) as c:
|
|
45
|
+
response = await c.get("/health")
|
|
46
|
+
assert response.status_code == 200 and response.json() == {"status": "ok"}
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
async def test_every_response_carries_a_request_id_and_the_handler_sees_the_same_one():
|
|
50
|
+
async with client(make_app()) as c:
|
|
51
|
+
response = await c.get("/whoami")
|
|
52
|
+
assert response.headers["x-request-id"] == response.json()["request_id"]
|
|
53
|
+
assert len(response.headers["x-request-id"]) == 16
|
|
54
|
+
assert current_request_id() == "-" # reset after the request
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
async def test_client_request_id_is_kept_when_sane_and_replaced_otherwise():
|
|
58
|
+
async with client(make_app()) as c:
|
|
59
|
+
kept = await c.get("/health", headers={"X-Request-ID": "front-abc.123"})
|
|
60
|
+
replaced = await c.get("/health", headers={"X-Request-ID": "x" * 65})
|
|
61
|
+
injected = await c.get("/health", headers={"X-Request-ID": "a b\n"})
|
|
62
|
+
assert kept.headers["x-request-id"] == "front-abc.123"
|
|
63
|
+
assert replaced.headers["x-request-id"] != "x" * 65
|
|
64
|
+
assert injected.headers["x-request-id"].isalnum()
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
async def test_unhandled_error_is_500_with_code_and_id_and_no_internals(caplog):
|
|
68
|
+
async with client(make_app()) as c:
|
|
69
|
+
with caplog.at_level(logging.ERROR):
|
|
70
|
+
response = await c.get("/boom")
|
|
71
|
+
assert response.status_code == 500
|
|
72
|
+
assert response.json() == {"detail": {"code": "internal_error", "request_id": response.headers["x-request-id"]}}
|
|
73
|
+
assert "hunter2" not in response.text
|
|
74
|
+
assert "hunter2" in caplog.text and "RuntimeError" in caplog.text
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
async def test_api_error_and_plain_http_exception_keep_the_detail_envelope():
|
|
78
|
+
async with client(make_app()) as c:
|
|
79
|
+
teapot = await c.get("/teapot")
|
|
80
|
+
plain = await c.get("/plain")
|
|
81
|
+
assert teapot.status_code == 418 and teapot.json() == {"detail": {"code": "teapot", "resets_at": "never"}}
|
|
82
|
+
assert ErrorDetail(**teapot.json()["detail"]).code == "teapot"
|
|
83
|
+
assert plain.status_code == 404 and plain.json() == {"detail": "Not Found"}
|
|
84
|
+
assert "x-request-id" in plain.headers
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
async def test_cors_only_when_origins_are_configured():
|
|
88
|
+
preflight = {"Origin": "https://app.example", "Access-Control-Request-Method": "GET"}
|
|
89
|
+
async with client(make_app()) as c:
|
|
90
|
+
assert "access-control-allow-origin" not in (await c.options("/health", headers=preflight)).headers
|
|
91
|
+
async with client(make_app(cors_origins="https://app.example, https://other.example")) as c:
|
|
92
|
+
preflight_response = await c.options("/health", headers=preflight)
|
|
93
|
+
assert preflight_response.headers["access-control-allow-origin"] == "https://app.example"
|
|
94
|
+
real = await c.get("/health", headers={"Origin": "https://app.example"})
|
|
95
|
+
assert "x-request-id" in real.headers["access-control-expose-headers"].lower()
|
|
96
|
+
assert "access-control-allow-origin" not in (
|
|
97
|
+
await c.get("/health", headers={"Origin": "https://evil.example"})
|
|
98
|
+
).headers
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
async def test_docs_hidden_unless_enabled():
|
|
102
|
+
async with client(make_app()) as c:
|
|
103
|
+
assert (await c.get("/docs")).status_code == 404
|
|
104
|
+
assert (await c.get("/openapi.json")).status_code == 404
|
|
105
|
+
async with client(make_app(docs_enabled=True)) as c:
|
|
106
|
+
assert (await c.get("/openapi.json")).status_code == 200
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
def test_settings_parse_comma_separated_origins(monkeypatch):
|
|
110
|
+
monkeypatch.setenv("CORS_ORIGINS", "http://localhost:5173, https://app.example")
|
|
111
|
+
monkeypatch.setenv("DOCS_ENABLED", "true")
|
|
112
|
+
settings = ApiSettings()
|
|
113
|
+
assert settings.cors_origins == ["http://localhost:5173", "https://app.example"]
|
|
114
|
+
assert settings.docs_enabled is True
|
|
115
|
+
assert ApiSettings(cors_origins=[]).cors_origins == []
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
def test_logging_format_prints_the_request_id():
|
|
119
|
+
configure_logging("DEBUG")
|
|
120
|
+
root = logging.getLogger()
|
|
121
|
+
assert root.level == logging.DEBUG and any(isinstance(f, RequestIdFilter) for f in root.handlers[0].filters)
|
|
122
|
+
record = logging.LogRecord("x", logging.INFO, __file__, 1, "hello", None, None)
|
|
123
|
+
RequestIdFilter().filter(record)
|
|
124
|
+
assert "[-] x: hello" in logging.Formatter(FORMAT).format(record)
|
|
125
|
+
root.handlers = [] # leave pytest's own capture alone
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
@pytest.mark.parametrize("status", [400, 429])
|
|
129
|
+
def test_api_error_exposes_its_code(status):
|
|
130
|
+
error = ApiError(status, "some_code", headers={"Retry-After": "5"}, retry_after=5)
|
|
131
|
+
assert (error.status_code, error.code, error.detail, error.headers) == (
|
|
132
|
+
status,
|
|
133
|
+
"some_code",
|
|
134
|
+
{"code": "some_code", "retry_after": 5},
|
|
135
|
+
{"Retry-After": "5"},
|
|
136
|
+
)
|