Add parameter to sort graphql endpoint

Author: dgarros

backend/infrahub/graphql/api/endpoints.py

@@ -2,14 +2,15 @@
 
 from typing import TYPE_CHECKING
 
-from fastapi import APIRouter, Depends
+from fastapi import APIRouter, Depends, Query
 from fastapi.responses import PlainTextResponse
-from graphql import print_schema
+from graphql import parse, print_ast, print_schema
 from starlette.routing import Route, WebSocketRoute
 
 from infrahub.api.dependencies import get_branch_dep, get_current_user
 from infrahub.core import registry
 from infrahub.graphql.registry import registry as graphql_registry
+from infrahub.graphql.schema_sort import sort_schema_ast
 
 from .dependencies import build_graphql_app
 
@@ -27,11 +28,20 @@
 router.routes.append(WebSocketRoute(path="/graphql/{branch_name:str}", endpoint=graphql_app))
 
 
-@router.get("/schema.graphql", include_in_schema=False)
+@router.get("/schema.graphql")
 async def get_graphql_schema(
-    branch: Branch = Depends(get_branch_dep), _: AccountSession = Depends(get_current_user)
+    branch: Branch = Depends(get_branch_dep),
+    _: AccountSession = Depends(get_current_user),
+    sort_schema: bool = Query(default=False, alias="sorted", description="Whether to sort the schema alphabetically."),
 ) -> PlainTextResponse:
     schema_branch = registry.schema.get_schema_branch(name=branch.name)
     gqlm = graphql_registry.get_manager_for_branch(branch=branch, schema_branch=schema_branch)
     graphql_schema = gqlm.get_graphql_schema()
+
+    if sort_schema:
+        schema_str = print_schema(graphql_schema)
+        schema_ast = parse(schema_str)
+        sorted_schema_ast = sort_schema_ast(schema_ast)
+        return PlainTextResponse(content=print_ast(sorted_schema_ast))
+
     return PlainTextResponse(content=print_schema(graphql_schema))

backend/tests/unit/api/test_20_graphql.py

@@ -230,3 +230,16 @@ async def test_download_schema_anonymous_account(
     with client:
         response = client.get("/schema.graphql")
         assert response.status_code == 200 if allow_anonymous_access else 401
+
+
+@pytest.mark.parametrize("allow_anonymous_access", [False, True])
+async def test_download_graphql_schema_sorted(
+    db: InfrahubDatabase, client, client_headers, allow_anonymous_access: bool
+):
+    config.SETTINGS.main.allow_anonymous_access = allow_anonymous_access
+
+    # Must execute in a with block to execute the startup/shutdown events
+    with client:
+        response = client.get("/schema.graphql?sorted=true")
+        assert response.text
+        assert response.status_code == 200 if allow_anonymous_access else 401