Spaces:
Running
Running
File size: 7,065 Bytes
da4845b f14a5c8 da4845b f14a5c8 c1940a6 f14a5c8 7b03b73 f14a5c8 da4845b f14a5c8 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 | """Tests for middleware in HTTP apps."""
from collections.abc import Callable
from typing import Any
import httpx
from httpx import ASGITransport
from starlette.middleware import Middleware
from starlette.middleware.base import BaseHTTPMiddleware
from starlette.requests import Request
from starlette.responses import JSONResponse
from starlette.routing import BaseRoute, Route
from starlette.types import ASGIApp
from fastmcp.server import FastMCP
from fastmcp.server.http import create_sse_app, create_streamable_http_app
class HeaderMiddleware(BaseHTTPMiddleware):
"""Simple middleware that adds a custom header to responses."""
def __init__(self, app: ASGIApp, header_name: str, header_value: str):
super().__init__(app)
self.header_name = header_name
self.header_value = header_value
async def dispatch(self, request: Request, call_next: Callable):
response = await call_next(request)
response.headers[self.header_name] = self.header_value
return response
class RequestModifierMiddleware(BaseHTTPMiddleware):
"""Middleware that adds a value to request state."""
def __init__(self, app: ASGIApp, key: str, value: Any):
super().__init__(app)
self.key = key
self.value = value
async def dispatch(self, request: Request, call_next: Callable):
request.state.custom_value = {self.key: self.value}
return await call_next(request)
async def endpoint_handler(request: Request):
"""Endpoint that returns request state or headers."""
if hasattr(request.state, "custom_value"):
return JSONResponse({"state": request.state.custom_value})
return JSONResponse({"message": "Hello, world!"})
async def test_sse_app_with_custom_middleware():
"""Test that custom middleware works with SSE app."""
server = FastMCP(name="TestServer")
# Create custom middleware
custom_middleware = [
Middleware(
HeaderMiddleware, header_name="X-Custom-Header", header_value="test-value"
)
]
# Add a test route to server's additional routes
routes: list[BaseRoute] = [Route("/test", endpoint_handler)]
server._additional_http_routes = routes
# Create the app with custom middleware
app = server.http_app(transport="sse", middleware=custom_middleware)
# Create a test client
transport = ASGITransport(app=app)
async with httpx.AsyncClient(
transport=transport, base_url="http://testserver"
) as client:
response = await client.get("/test")
# Verify middleware was applied
assert response.status_code == 200
assert response.headers["X-Custom-Header"] == "test-value"
async def test_streamable_http_app_with_custom_middleware():
"""Test that custom middleware works with StreamableHTTP app."""
server = FastMCP(name="TestServer")
# Create custom middleware
custom_middleware = [
Middleware(
HeaderMiddleware, header_name="X-Custom-Header", header_value="test-value"
)
]
# Add a test route to server's additional routes
routes: list[BaseRoute] = [Route("/test", endpoint_handler)]
server._additional_http_routes = routes
# Create the app with custom middleware
app = server.http_app(transport="http", middleware=custom_middleware)
# Create a test client
transport = ASGITransport(app=app)
async with httpx.AsyncClient(
transport=transport, base_url="http://testserver"
) as client:
response = await client.get("/test")
# Verify middleware was applied
assert response.status_code == 200
assert response.headers["X-Custom-Header"] == "test-value"
async def test_create_sse_app_with_custom_middleware():
"""Test that custom middleware works with create_sse_app function."""
server = FastMCP(name="TestServer")
# Create custom middleware
custom_middleware = [
Middleware(RequestModifierMiddleware, key="modified_by", value="middleware")
]
# Add a test route
additional_routes: list[BaseRoute] = [Route("/test", endpoint_handler)]
# Create the app with custom middleware
app = create_sse_app(
server=server,
message_path="/message",
sse_path="/sse/",
middleware=custom_middleware,
routes=additional_routes,
)
# Create a test client
transport = ASGITransport(app=app)
async with httpx.AsyncClient(
transport=transport, base_url="http://testserver"
) as client:
response = await client.get("/test")
# Verify middleware was applied
assert response.status_code == 200
data = response.json()
assert "state" in data
assert data["state"]["modified_by"] == "middleware"
async def test_create_streamable_http_app_with_custom_middleware():
"""Test that custom middleware works with create_streamable_http_app function."""
server = FastMCP(name="TestServer")
# Create custom middleware
custom_middleware = [
Middleware(RequestModifierMiddleware, key="modified_by", value="middleware")
]
# Add a test route
additional_routes: list[BaseRoute] = [Route("/test", endpoint_handler)]
# Create the app with custom middleware
app = create_streamable_http_app(
server=server,
streamable_http_path="/streamable",
middleware=custom_middleware,
routes=additional_routes,
)
# Create a test client
transport = ASGITransport(app=app)
async with httpx.AsyncClient(
transport=transport, base_url="http://testserver"
) as client:
response = await client.get("/test")
# Verify middleware was applied
assert response.status_code == 200
data = response.json()
assert "state" in data
assert data["state"]["modified_by"] == "middleware"
async def test_multiple_middleware_ordering():
"""Test that multiple middleware are applied in the correct order."""
server = FastMCP(name="TestServer")
# Create multiple middleware
custom_middleware = [
Middleware(
HeaderMiddleware, header_name="X-First-Header", header_value="first"
),
Middleware(
HeaderMiddleware, header_name="X-Second-Header", header_value="second"
),
]
# Add a test route to server's additional routes
routes: list[BaseRoute] = [Route("/test", endpoint_handler)]
server._additional_http_routes = routes
# Create the app with custom middleware
app = server.http_app(transport="sse", middleware=custom_middleware)
# Create a test client
transport = ASGITransport(app=app)
async with httpx.AsyncClient(
transport=transport, base_url="http://testserver"
) as client:
response = await client.get("/test")
# Verify both middleware were applied
assert response.status_code == 200
assert response.headers["X-First-Header"] == "first"
assert response.headers["X-Second-Header"] == "second"
|