fix: custom app openapi metadata (#19)

* test: reproduce the error

tdd is great

* fix: set serve to false

* fix: add pydantic to reqs

* expected tests

---------

Co-authored-by: Matteo Ferrando <[email protected]>

Author: badayvedat

projects/fal/src/fal/api.py

@@ -792,7 +792,7 @@ def order_schema_object(schema: dict[str, Any]):
             if "properties" in schema:
                 mark_order(schema, "properties")
 
-        for key in spec["components"].get("schemas") or {}:
+        for key in spec.get("components", {}).get("schemas") or {}:
             order_schema_object(spec["components"]["schemas"][key])
 
         return spec

projects/fal/tests/test_apps.py

@@ -36,6 +36,47 @@ def addition_app(input: Input) -> Output:
     return Output(result=input.lhs + input.rhs)
 
 
+@fal.function(
+    keep_alive=0,
+    requirements=["fastapi", "uvicorn", "pydantic==1.10.12"],
+    machine_type="S",
+    max_concurrency=1,
+    exposed_port=8000,
+)
+def calculator_app():
+    from fastapi import FastAPI
+    from fastapi.middleware.cors import CORSMiddleware
+    from uvicorn import run
+
+    app = FastAPI()
+
+    def _wait(wait_time: int):
+        print("starting...")
+        for _ in range(wait_time):
+            print("sleeping...")
+            time.sleep(1)
+
+    @app.post("/add")
+    def add(input: Input) -> Output:
+        _wait(input.wait_time)
+        return Output(result=input.lhs + input.rhs)
+
+    @app.post("/subtract")
+    def subtract(input: Input) -> Output:
+        _wait(input.wait_time)
+        return Output(result=input.lhs - input.rhs)
+
+    app.add_middleware(
+        CORSMiddleware,
+        allow_credentials=True,
+        allow_headers=("*"),
+        allow_methods=("*"),
+        allow_origins=("*"),
+    )
+
+    run(app, host="0.0.0.0", port=8080)
+
+
 @pytest.fixture(scope="module")
 def aliased_app() -> Generator[tuple[str, str], None, None]:
     # Create a temporary app, register it, and return the ID of it.
@@ -67,6 +108,20 @@ def test_app():
     yield f"{user_id}-{app_revision}"
 
 
+@pytest.fixture(scope="module")
+def test_fastapi_app():
+    # Create a temporary app, register it, and return the ID of it.
+
+    from fal.cli import _get_user_id
+
+    app_revision = calculator_app.host.register(
+        func=calculator_app.func,
+        options=calculator_app.options,
+    )
+    user_id = _get_user_id()
+    yield f"{user_id}-{app_revision}"
+
+
 def test_app_client(test_app: str):
     response = apps.run(test_app, arguments={"lhs": 1, "rhs": 2})
     assert response["result"] == 3
@@ -105,7 +160,7 @@ def test_app_client_async(test_app: str):
     assert result == {"result": 5}
 
 
-def test_app_openapi_spec_metadata(test_app: str):
+def test_app_openapi_spec_metadata(test_app: str, request: pytest.FixtureRequest):
     user_id, _, app_id = test_app.partition("-")
     res = app_metadata.sync_detailed(
         app_alias_or_id=app_id, app_user_id=user_id, client=REST_CLIENT
@@ -121,6 +176,26 @@ def test_app_openapi_spec_metadata(test_app: str):
         assert key in openapi_spec, f"{key} key missing from openapi {openapi_spec}"
 
 
+def test_app_no_serve_spec_metadata(
+    test_fastapi_app: str, request: pytest.FixtureRequest
+):
+    # We do not store the openapi spec for apps that do not use serve=True
+    user_id, _, app_id = test_fastapi_app.partition("-")
+    res = app_metadata.sync_detailed(
+        app_alias_or_id=app_id, app_user_id=user_id, client=REST_CLIENT
+    )
+
+    assert (
+        res.status_code == 200
+    ), f"Failed to fetch metadata for app {test_fastapi_app}"
+    assert res.parsed, f"Failed to parse metadata for app {test_fastapi_app}"
+
+    metadata = res.parsed.to_dict()
+    assert (
+        "openapi" not in metadata
+    ), f"openapi should not be present in metadata {metadata}"
+
+
 def test_app_update_app(aliased_app: tuple[str, str]):
     app_revision, app_alias = aliased_app