Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tests to check playground is served with api router configurations #579

Merged
merged 2 commits into from
Apr 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 105 additions & 0 deletions tests/unit_tests/test_api_playground.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
"""Test the playground API."""

from fastapi import APIRouter, FastAPI
from httpx import AsyncClient
from langchain_core.runnables import RunnableLambda

from langserve import add_routes


async def test_serve_playground() -> None:
"""Test the server directly via HTTP requests."""
app = FastAPI()
add_routes(
app,
RunnableLambda(lambda foo: "hello"),
)

async with AsyncClient(app=app, base_url="http://localhost:9999") as client:
response = await client.get("/playground/index.html")
assert response.status_code == 200
# Test that we can't access files that do not exist.
response = await client.get("/playground/i_do_not_exist.txt")
assert response.status_code == 404
# Test that we can't access files outside of the playground directory
response = await client.get("/playground//etc/passwd")
assert response.status_code == 404


async def test_serve_playground_with_api_router() -> None:
"""Test serving playground from an api router with a prefix."""
app = FastAPI()

# Make sure that we can add routers
# to an API router
router = APIRouter(prefix="/langserve_runnables")

add_routes(
router,
RunnableLambda(lambda foo: "hello"),
path="/chat",
)

app.include_router(router)

async with AsyncClient(app=app, base_url="http://localhost:9999") as client:
response = await client.get("/langserve_runnables/chat/playground/index.html")
assert response.status_code == 200


async def test_serve_playground_with_api_router_in_api_router() -> None:
"""Test serving playground from an api router within an api router."""
app = FastAPI()

router = APIRouter(prefix="/foo")

add_routes(
router,
RunnableLambda(lambda foo: "hello"),
)

parent_router = APIRouter(prefix="/parent")
parent_router.include_router(router, prefix="/bar")

# Now add parent router to the app
app.include_router(parent_router)

async with AsyncClient(app=app, base_url="http://localhost:9999") as client:
response = await client.get("/parent/bar/foo/playground/index.html")
assert response.status_code == 200


async def test_root_path_on_playground() -> None:
"""Test that the playground respects the root_path for requesting assets"""

for root_path in ("/home/root", "/home/root/"):
app = FastAPI(root_path=root_path)
add_routes(
app,
RunnableLambda(lambda foo: "hello"),
path="/chat",
)

router = APIRouter(prefix="/router")
add_routes(
router,
RunnableLambda(lambda foo: "hello"),
path="/chat",
)
app.include_router(router)

async_client = AsyncClient(app=app, base_url="http://localhost:9999")

response = await async_client.get("/chat/playground/index.html")
assert response.status_code == 200
assert (
f'src="{root_path.rstrip("/")}/chat/playground/assets/'
in response.content.decode()
), "html should contain reference to playground assets with root_path prefix"

response = await async_client.get("/router/chat/playground/index.html")
assert response.status_code == 200
assert (
f'src="{root_path.rstrip("/")}/router/chat/playground/assets/'
in response.content.decode()
), "html should contain reference to playground assets with root_path prefix"
67 changes: 0 additions & 67 deletions tests/unit_tests/test_server_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -293,73 +293,6 @@ def test_server(app: FastAPI) -> None:
# assert response.text == "event: data\r\ndata: 2\r\n\r\nevent: end\r\n\r\n"


def test_serve_playground(app: FastAPI) -> None:
"""Test the server directly via HTTP requests."""
sync_client = TestClient(app=app)
response = sync_client.get("/playground/index.html")
assert response.status_code == 200
response = sync_client.get("/playground/i_do_not_exist.txt")
assert response.status_code == 404
response = sync_client.get("/playground//etc/passwd")
assert response.status_code == 404


async def test_serve_playground_with_api_router() -> None:
"""Test serving playground from an api router with a prefix."""
app = FastAPI()

# Make sure that we can add routers
# to an API router
router = APIRouter(prefix="/langserve_runnables")

add_routes(
router,
RunnableLambda(lambda foo: "hello"),
path="/chat",
)

app.include_router(router)
async_client = AsyncClient(app=app, base_url="http://localhost:9999")
response = await async_client.get("/langserve_runnables/chat/playground/index.html")
assert response.status_code == 200


async def test_root_path_on_playground(event_loop: AbstractEventLoop) -> None:
"""Test that the playground respects the root_path for requesting assets"""

for root_path in ("/home/root", "/home/root/"):
app = FastAPI(root_path=root_path)
add_routes(
app,
RunnableLambda(lambda foo: "hello"),
path="/chat",
)

router = APIRouter(prefix="/router")
add_routes(
router,
RunnableLambda(lambda foo: "hello"),
path="/chat",
)
app.include_router(router)

async_client = AsyncClient(app=app, base_url="http://localhost:9999")

response = await async_client.get("/chat/playground/index.html")
assert response.status_code == 200
assert (
f'src="{root_path.rstrip("/")}/chat/playground/assets/'
in response.content.decode()
), "html should contain reference to playground assets with root_path prefix"

response = await async_client.get("/router/chat/playground/index.html")
assert response.status_code == 200
assert (
f'src="{root_path.rstrip("/")}/router/chat/playground/assets/'
in response.content.decode()
), "html should contain reference to playground assets with root_path prefix"


async def test_server_async(app: FastAPI) -> None:
"""Test the server directly via HTTP requests."""
async with get_async_test_client(app, raise_app_exceptions=True) as async_client:
Expand Down
Loading