Implement read-only mode (#95)

This PR implements a read-only API by way of separating read/write endpoints to read/write routers, only serving the former in --read-only mode. The PR also introduces a convenient CLI for launching the server.

Author: edan-bainglass

aiida_restapi/__init__.py

@@ -1,5 +1,3 @@
-"""AiiDA REST API for data queries and workflow managment."""
+"""AiiDA REST API for data queries and workflow management."""
 
 __version__ = '0.1.0a1'
-
-from .main import app  # noqa: F401

aiida_restapi/cli/__init__.py

@@ -0,0 +1,31 @@
+import os
+
+import click
+import uvicorn
+
+
+@click.group()
+def cli() -> None:
+    """AiiDA REST API management CLI."""
+
+
+@cli.command()
+@click.option('--host', default='127.0.0.1', show_default=True)
+@click.option('--port', default=8000, show_default=True, type=int)
+@click.option('--read-only', is_flag=True)
+@click.option('--watch', is_flag=True)
+def start(read_only: bool, watch: bool, host: str, port: int) -> None:
+    """Start the AiiDA REST API service."""
+
+    os.environ['AIIDA_RESTAPI_READ_ONLY'] = '1' if read_only else '0'
+
+    click.echo(f'Starting REST API (read_only={read_only}, watch={watch}) on {host}:{port}')
+
+    uvicorn.run(
+        'aiida_restapi.main:create_app',
+        host=host,
+        port=port,
+        reload=watch,
+        reload_dirs=['aiida_restapi'],
+        factory=True,
+    )

aiida_restapi/cli/main.py

@@ -1,32 +1,45 @@
 """Declaration of FastAPI application."""
 
+import os
+import typing as t
+
 from fastapi import FastAPI, Request
 from fastapi.responses import HTMLResponse
 
 from aiida_restapi.graphql import main
 from aiida_restapi.routers import auth, computers, daemon, groups, nodes, submit, users
 from aiida_restapi.utils import generate_endpoints_table
 
-app = FastAPI()
 
+def generate_endpoints_table_endpoint(app: FastAPI) -> t.Callable[[Request], HTMLResponse]:
+    """Generate an endpoint that lists all registered API routes."""
+
+    def list_endpoints(request: Request) -> HTMLResponse:
+        """Return an HTML table of all registered API routes."""
+        return HTMLResponse(
+            content=generate_endpoints_table(
+                str(request.base_url).rstrip('/'),
+                app.routes,
+            ),
+        )
+
+    return list_endpoints
+
+
+def create_app() -> FastAPI:
+    """Create the FastAPI application and include the routers."""
+
+    read_only = os.getenv('AIIDA_RESTAPI_READ_ONLY') == '1'
 
-@app.get('/', response_class=HTMLResponse)
-def list_endpoints(request: Request) -> HTMLResponse:
-    """Return an HTML table of all registered API routes."""
-    return HTMLResponse(
-        content=generate_endpoints_table(
-            str(request.base_url).rstrip('/'),
-            app.routes,
-        ),
-    )
+    app = FastAPI()
 
+    for module in (auth, computers, daemon, groups, nodes, submit, users):
+        if read_router := getattr(module, 'read_router', None):
+            app.include_router(read_router)
+        if not read_only and (write_router := getattr(module, 'write_router', None)):
+            app.include_router(write_router)
 
-app.include_router(auth.router)
-app.include_router(computers.router)
-app.include_router(daemon.router)
-app.include_router(nodes.router)
-app.include_router(groups.router)
-app.include_router(users.router)
-app.include_router(submit.router)
+    app.add_route('/graphql', main.app)
+    app.add_route('/', lambda request: generate_endpoints_table_endpoint(app)(request))
 
-app.add_route('/graphql', main.app, name='graphql', methods=['POST'])
+    return app

aiida_restapi/main.py

@@ -35,7 +35,8 @@ class UserInDB(orm.User.Model):
 
 oauth2_scheme = OAuth2PasswordBearer(tokenUrl='token')
 
-router = APIRouter()
+read_router = APIRouter()
+write_router = APIRouter()
 
 
 def verify_password(plain_password: str, hashed_password: str) -> bool:
@@ -113,7 +114,7 @@ async def get_current_active_user(
     return current_user
 
 
-@router.post('/token', response_model=Token)
+@write_router.post('/token', response_model=Token)
 async def login_for_access_token(
     form_data: OAuth2PasswordRequestForm = Depends(),
 ) -> dict[str, t.Any]:
@@ -130,7 +131,7 @@ async def login_for_access_token(
     return {'access_token': access_token, 'token_type': 'bearer'}
 
 
-@router.get('/auth/me/', response_model=orm.User.Model)
+@read_router.get('/auth/me/', response_model=orm.User.Model)
 async def read_users_me(
     current_user: t.Annotated[orm.User.Model, Depends(get_current_active_user)],
 ) -> orm.User.Model:

aiida_restapi/routers/auth.py

@@ -15,12 +15,13 @@
 
 from .auth import UserInDB, get_current_active_user
 
-router = APIRouter()
+read_router = APIRouter()
+write_router = APIRouter()
 
 repository = EntityRepository[orm.Computer, orm.Computer.Model](orm.Computer)
 
 
-@router.get('/computers/schema')
+@read_router.get('/computers/schema')
 async def get_computers_schema(
     which: t.Literal['get', 'post'] = Query(
         'get',
@@ -39,7 +40,7 @@ async def get_computers_schema(
         raise HTTPException(status_code=422, detail=str(err)) from err
 
 
-@router.get('/computers/projectable_properties', response_model=list[str])
+@read_router.get('/computers/projectable_properties', response_model=list[str])
 async def get_computer_projectable_properties() -> list[str]:
     """Get projectable properties for AiiDA computers.
 
@@ -48,7 +49,7 @@ async def get_computer_projectable_properties() -> list[str]:
     return repository.get_projectable_properties()
 
 
-@router.get(
+@read_router.get(
     '/computers',
     response_model=PaginatedResults[orm.Computer.Model],
     response_model_exclude_none=True,
@@ -66,7 +67,7 @@ async def get_computers(
     return repository.get_entities(queries)
 
 
-@router.get(
+@read_router.get(
     '/computers/{computer_id}',
     response_model=orm.Computer.Model,
     response_model_exclude_none=True,
@@ -86,7 +87,7 @@ async def get_computer(computer_id: int) -> orm.Computer.Model:
         raise HTTPException(status_code=404, detail=f'Could not find a Computer with id {computer_id}')
 
 
-@router.get('/computers/{computer_id}/metadata', response_model=dict[str, t.Any])
+@read_router.get('/computers/{computer_id}/metadata', response_model=dict[str, t.Any])
 @with_dbenv()
 async def get_computer_metadata(computer_id: int) -> dict[str, t.Any]:
     """Get metadata of an AiiDA computer by id.
@@ -102,7 +103,7 @@ async def get_computer_metadata(computer_id: int) -> dict[str, t.Any]:
         raise HTTPException(status_code=404, detail=f'Could not find a Computer with id {computer_id}')
 
 
-@router.post(
+@write_router.post(
     '/computers',
     response_model=orm.Computer.Model,
     response_model_exclude_none=True,

aiida_restapi/routers/computers.py

@@ -11,7 +11,8 @@
 
 from .auth import UserInDB, get_current_active_user
 
-router = APIRouter()
+read_router = APIRouter()
+write_router = APIRouter()
 
 
 class DaemonStatusModel(BaseModel):
@@ -21,7 +22,7 @@ class DaemonStatusModel(BaseModel):
     num_workers: t.Optional[int] = Field(description='The number of workers if the daemon is running.')
 
 
-@router.get(
+@read_router.get(
     '/daemon/status',
     response_model=DaemonStatusModel,
 )
@@ -44,7 +45,7 @@ async def get_daemon_status() -> DaemonStatusModel:
     return DaemonStatusModel(running=True, num_workers=response['numprocesses'])
 
 
-@router.post(
+@write_router.post(
     '/daemon/start',
     response_model=DaemonStatusModel,
 )
@@ -71,7 +72,7 @@ async def get_daemon_start(
     return DaemonStatusModel(running=True, num_workers=response['numprocesses'])
 
 
-@router.post(
+@write_router.post(
     '/daemon/stop',
     response_model=DaemonStatusModel,
 )

aiida_restapi/routers/daemon.py

@@ -15,12 +15,13 @@
 
 from .auth import UserInDB, get_current_active_user
 
-router = APIRouter()
+read_router = APIRouter()
+write_router = APIRouter()
 
 repository = EntityRepository[orm.Group, orm.Group.Model](orm.Group)
 
 
-@router.get('/groups/schema')
+@read_router.get('/groups/schema')
 async def get_groups_schema(
     which: t.Literal['get', 'post'] = Query(
         'get',
@@ -39,7 +40,7 @@ async def get_groups_schema(
         raise HTTPException(status_code=422, detail=str(err)) from err
 
 
-@router.get('/groups/projectable_properties', response_model=list[str])
+@read_router.get('/groups/projectable_properties', response_model=list[str])
 async def get_group_projectable_properties() -> list[str]:
     """Get projectable properties for AiiDA groups.
 
@@ -48,7 +49,7 @@ async def get_group_projectable_properties() -> list[str]:
     return repository.get_projectable_properties()
 
 
-@router.get(
+@read_router.get(
     '/groups',
     response_model=PaginatedResults[orm.Group.Model],
     response_model_exclude_none=True,
@@ -66,7 +67,7 @@ async def get_groups(
     return repository.get_entities(queries)
 
 
-@router.get(
+@read_router.get(
     '/groups/{group_id}',
     response_model=orm.Group.Model,
     response_model_exclude_none=True,
@@ -89,7 +90,7 @@ async def get_group(group_id: int) -> orm.Group.Model:
         raise HTTPException(status_code=500, detail=str(err))
 
 
-@router.get(
+@read_router.get(
     '/groups/{group_id}/extras',
     response_model=dict[str, t.Any],
 )
@@ -110,7 +111,7 @@ async def get_group_extras(group_id: int) -> dict[str, t.Any]:
         raise HTTPException(status_code=500, detail=str(err)) from err
 
 
-@router.post(
+@write_router.post(
     '/groups',
     response_model=orm.Group.Model,
     response_model_exclude_none=True,