Switches from flask to FastAPI.

Author: robotoer

README.md

@@ -75,12 +75,12 @@ Once the database, server, and webapp are running, the database itself needs to
 To update your database to the latest version, first start the database and server containers, run the relevant docker-compose alias command (above), then run:
 ```sh
 #sh
-./server.sh db upgrade
+./server.sh alembic upgrade
 ```
 
 ```powershell
 #powershell
-./server.ps1 db upgrade
+./server.ps1 alembic upgrade
 ```
 
 Whenever changes to the database schema for Flow are made, new migration(s) get created in the server/migrations/versions/ directory. 

docker-compose.dev-nodb.yaml

@@ -18,7 +18,7 @@ services:
       context: server
       args:
         REACT_APP_VERSION: local+devcontainer
-    command: "python -m flask run --host=0.0.0.0 --port=5000"
+    command: uvicorn main:app --port 5000 --host 0.0.0.0 --timeout-keep-alive 120 --reload --log-level trace
     environment:
       - "SQLALCHEMY_ECHO=True"
     volumes:

docker-compose.dev.yaml

@@ -18,7 +18,7 @@ services:
       context: server
       args:
         REACT_APP_VERSION: local+devcontainer
-    command: "python -m flask run --host=0.0.0.0 --port=5000"
+    command: uvicorn main:app --port 5000 --host 0.0.0.0 --timeout-keep-alive 120 --reload --log-level trace
     environment:
       - "SQLALCHEMY_ECHO=True"
     volumes:

server/Dockerfile

@@ -18,4 +18,4 @@ COPY ./ .
 ENV FLASK_APP=/app/main.py
 ENV SERVER_VERSION=$SERVER_VERSION
 
-CMD gunicorn --bind 0.0.0.0:${PORT} main:app --access-logfile - --error-logfile - --timeout 120 --limit-request-line 0 --workers 4 --log-level=DEBUG
+CMD uvicorn main:app --port ${PORT} --host 0.0.0.0 --timeout-keep-alive 120 --log-level debug

server/Pipfile

@@ -4,16 +4,16 @@ verify_ssl = true
 name = "pypi"
 
 [packages]
-alembic_utils = "*"
-flask = "*"
-flask-cors = "*"
-flask-migrate = "*"
-flask-restx = "*"
-flask-sqlalchemy = "*"
-gunicorn = "*"
-python-jose = "*"
+alembic = "*"
+fastapi = "*"
+fastapi-cloudauth = "*"
+graphene = "*"
+graphene-sqlalchemy = "*"
+sqlalchemy = "*"
+pydantic = "*"
+uvicorn = "*"
+python-multipart = "*"
 pg8000 = "==1.16.5"
-Werkzeug = "*"
 casbin = "*"
 casbin-sqlalchemy-adapter = "*"
 deepdiff = {extras = ["murmur"], version = "*"}

server/Pipfile.lock

@@ -1,23 +1,14 @@
-from flask_restx import Resource, fields, Namespace
+from typing import List
 
-from authorization import requires_auth, requires_scope, get_all_roles
+from authorization import get_all_roles
+from server import app
+from models import Group
 
 
-api = Namespace('groups', description='Extra-Simple operations on groups.', path='/')
-
-
-group_output = api.model('GroupOutput', { 'id': fields.String() })
-groups_output = fields.List(fields.Nested(group_output))
-
-
-@api.route('/group')
-class GroupsResource(Resource):
-    @api.doc(security='token', model=groups_output)
-    @requires_auth
-    # @requires_scope('read:groups')
-    def get(self):
-        return [
-            {'id': role}
-            for role
-            in get_all_roles()
-        ]
+@app.get('/group', tags=['groups'], response_model=List[Group], response_model_exclude_none=True)
+async def get_groups():
+    return [
+        Group(id=role)
+        for role
+        in get_all_roles()
+    ]

server/api/group.py

@@ -1,33 +1,30 @@
-from flask_restx import Resource, fields, Namespace
-
-from server import app, db
-
-
-api = Namespace('server-health', description="Service health checks.", path='/')
-
-
-health_output = api.model('HealthOutput', {
-    'version': fields.String(),
-    'server': fields.Boolean(),
-    'database': fields.Boolean(),
-    'database_error': fields.String()
-})
-
-
-@api.route('/health')
-class HealthResource(Resource):
-    @api.doc(model=health_output)
-    def get(self):
-        status = {
-            'version': app.config['SERVER_VERSION'],
-            'server': True,
-            'database': True
-        }
-
-        try:
-            db.session.execute('SELECT 1')
-        except Exception as err:
-            status['database'] = False
-            status['database_error'] = str(err)
-            return status, 500
-        return status
+from typing import Union
+from fastapi import Depends
+from fastapi.responses import JSONResponse
+from sqlalchemy.orm import Session
+
+from authorization import get_all_roles
+from server import app, get_db
+from settings import settings
+from models import HealthCheck
+
+
+@app.get('/health', tags=['system'], response_model=HealthCheck, response_model_exclude_none=True)
+async def health_check(db: Session = Depends(get_db)):
+    status = {
+        'version': settings.server_version,
+        'server': True,
+        'database': True
+    }
+
+    try:
+        db.execute('SELECT 1')
+    except Exception as err:
+        status['database'] = False
+        status['database_error'] = str(err)
+        return JSONResponse(
+            status_code=500,
+            content=status,
+        )
+    # return HealthCheck(**status)
+    return status