FastAPI backend (#109)

Author: mariusandra

.github/workflows/e2e-docker.yml

@@ -0,0 +1,49 @@
+name: E2E Docker Image
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+
+      - name: Build Docker image
+        run: |
+          docker build -t frameos .
+
+      - name: Run Docker container
+        run: |
+          docker run -d \
+            -p 8989:8989 \
+            -v ./db:/app/db \
+            --name frameos \
+            --restart always \
+            -e SECRET_KEY="bananana" \
+            frameos
+
+      - name: Wait for service on port 8989
+        run: |
+          echo "Waiting up to 30s for the service to respond on port 8989..."
+          timeout 30 bash -c "until curl -s http://localhost:8989; do sleep 1; done"
+
+      - name: Test /signup endpoint
+        id: signup-test
+        run: |
+          # We'll capture the HTTP status code so we can fail the step if it's not 2xx
+          echo "Testing /api/signup with a sample payload..."
+          HTTP_CODE=$(curl -s -o /dev/stderr -w "%{http_code}" -X POST http://localhost:8989/api/signup \
+            -H "Content-Type: application/json" \
+            -d '{"email":"[email protected]","password":"asdfasdf","password2":"asdfasdf","newsletter":false}')
+
+          if [ "$HTTP_CODE" -ne 200 ]; then
+            echo "Signup request failed with status code $HTTP_CODE"
+            exit 1
+          else
+            echo "Signup request succeeded with status code $HTTP_CODE"
+          fi

.github/workflows/pull-request-tests.yml

@@ -95,6 +95,10 @@ jobs:
         run: |
           cd backend
           source .venv/bin/activate
+          # fake these folders so static asset serving doesn't fail
+          mkdir -p ../frontend/dist/assets
+          mkdir -p ../frontend/dist/img
+          mkdir -p ../frontend/dist/static
           TEST=1 pytest
 
   typescript:

.gitignore

@@ -21,6 +21,7 @@ dist-ssr
 # Editor directories and files
 .vscode/*
 !.vscode/extensions.json
+!.vscode/launch.json
 .idea
 .DS_Store
 *.suo
@@ -32,4 +33,7 @@ dist-ssr
 
 # Nim
 frameos/tmp/
-e2e/tmp/
+e2e/tmp/
+
+gpt.txt
+.env

.vscode/launch.json

@@ -0,0 +1,19 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: FastAPI",
+            "type": "debugpy",
+            "request": "launch",
+            "cwd": "${workspaceFolder}/backend",
+            "module": "app.fastapi",
+            "console": "integratedTerminal",
+            "env": {
+                "PYTHONPATH": "${workspaceFolder}",
+                "GEVENT_SUPPORT": "True",
+                "DEBUG": "True",
+            },
+            "justMyCode": false
+        }
+    ]
+}

CONTRIBUTING.md

@@ -12,37 +12,66 @@ Python >= 3.11
 
 ## FrameOS Backend
 
+Start a redis server if not running
+
+```bash
+redis-server --daemonize yes
+```
+
+Installing deps
 
 ```bash
 cd backend
 python3 -m venv env
 source env/bin/activate
-pip install -r requirements.txt
-flask db upgrade
+uv pip install -r requirements.txt
+DEBUG=1 alembic ugprade head
 
 cd ../frontend
 npm install
 
 cd ../frameos
 nimble install -d
 nimble setup
+cd ..
+```
+
+To run all services at once:
+
+```bash
+cd frontend
+npm run dev &
+cd ../backend
+bin/dev
+```
+
+To run all of these separately:
 
+```bash
+# start the frontend
+cd frontend
+npm run dev
 cd ..
 
-# start a redis server
-redis-server --daemonize yes
+# apply any migrations
+cd backend
+DEBUG=1 python -m alembic upgrade head
+
+# start the backend
+cd backend
+DEBUG=1 python -m app.fastapi
 
-honcho start
+# start the job queue
+cd backend
+DEBUG=1 arq app.tasks.worker
 ```
 
 ## Running migrations
 
 ```bash
 cd backend
 # create migration after changing a model
-flask db migrate -m "something changed"
-# apply the migrations
-flask db upgrade
+DEBUG=1 python -m alembic revision --autogenerate -m "name of migration"
 ```
 
 ## Installing pre-commit
@@ -60,7 +89,7 @@ pre-commit uninstall
 
 ```bash
 cd backend
-bin/tests
+pytest
 ```
 
 ## FrameOS on-frame software

Dockerfile

@@ -18,7 +18,7 @@ RUN apt-get update && \
   apt-get install -y curl xz-utils gcc openssl ca-certificates git # &&
 
 RUN mkdir -p /opt/nim && \
-    curl -L https://nim-lang.org/download/nim-2.0.4.tar.xz | tar -xJf - -C /opt/nim --strip-components=1 && \
+    curl -L https://nim-lang.org/download/nim-2.2.0.tar.xz | tar -xJf - -C /opt/nim --strip-components=1 && \
     cd /opt/nim && \
     sh build.sh && \
     bin/nim c koch && \

backend/migrations/alembic.ini renamed to backend/alembic.ini

@@ -3,6 +3,7 @@
 [alembic]
 # template used to generate migration files
 # file_template = %%(rev)s_%%(slug)s
+script_location = migrations
 
 # set to 'true' to run the environment during
 # the 'revision' command, regardless of autogenerate
@@ -11,7 +12,7 @@
 
 # Logging configuration
 [loggers]
-keys = root,sqlalchemy,alembic,flask_migrate
+keys = root,sqlalchemy,alembic
 
 [handlers]
 keys = console
@@ -34,11 +35,6 @@ level = INFO
 handlers =
 qualname = alembic
 
-[logger_flask_migrate]
-level = INFO
-handlers =
-qualname = flask_migrate
-
 [handler_console]
 class = StreamHandler
 args = (sys.stderr,)

backend/app/__init__.py

@@ -1,72 +0,0 @@
-from typing import Optional
-
-from gevent import monkey
-monkey.patch_all()
-
-import sentry_sdk
-import os
-from sqlalchemy.exc import OperationalError
-
-from flask import Flask
-from flask_login import LoginManager
-from flask_sqlalchemy import SQLAlchemy
-from flask_migrate import Migrate
-from flask_socketio import SocketIO
-from config import Config, get_config
-from urllib.parse import urlparse
-from redis import Redis
-
-# Initialize extensions
-db = SQLAlchemy()
-login_manager = LoginManager()
-login_manager.login_view = 'api.login'
-migrate = Migrate()
-socketio = SocketIO(async_mode='gevent')
-
-DEFAULT_REDIS_URL = 'redis://localhost:6379/0'
-
-# Redis setup
-def create_redis_connection():
-    redis_url = os.environ.get('REDIS_URL', DEFAULT_REDIS_URL)
-    parsed_url = urlparse(redis_url)
-    redis_host = parsed_url.hostname
-    redis_port = parsed_url.port or 6379
-    return Redis(host=redis_host, port=redis_port)
-
-redis = create_redis_connection()
-
-# Sentry setup
-def initialize_sentry(app):
-    with app.app_context():
-        from .models import get_settings_dict
-        try:
-            settings = get_settings_dict()
-            dsn = settings.get('sentry', {}).get('controller_dsn', None)
-        except OperationalError:
-            print("Could not get settings dict, db not initialized.")
-            return
-        if dsn:
-            sentry_sdk.init(dsn=dsn, traces_sample_rate=1.0, profiles_sample_rate=1.0)
-
-def create_app(config: Optional[Config] = None):
-    config = config or get_config()
-    app = Flask(__name__, static_folder='../../frontend/dist', static_url_path='/', template_folder='../templates')
-    app.config.from_object(config)
-
-    db.init_app(app)
-    with app.app_context():
-        os.makedirs('../db', exist_ok=True)
-
-        db.create_all()
-    login_manager.init_app(app)
-    migrate.init_app(app, db)
-    socketio.init_app(app, cors_allowed_origins="*", message_queue=os.environ.get('REDIS_URL', DEFAULT_REDIS_URL))
-    initialize_sentry(app)
-
-    from app.views.base import setup_base_routes
-    setup_base_routes(app)
-
-    from app.api import api as api_blueprint
-    app.register_blueprint(api_blueprint, url_prefix='/api')
-
-    return app

backend/app/api/__init__.py

@@ -1,13 +1,15 @@
-from flask import Blueprint
+from fastapi import APIRouter
 
-api = Blueprint('api', __name__)
+public_api = APIRouter()
+private_api = APIRouter()
+
+from .auth import *  # noqa: E402, F403
+from .apps import *  # noqa: E402, F403
+from .frames import *  # noqa: E402, F403
+from .log import *  # noqa: E402, F403
+from .repositories import *  # noqa: E402, F403
+from .settings import *  # noqa: E402, F403
+from .ssh import *  # noqa: E402, F403
+from .templates import *  # noqa: E402, F403
+from .users import *  # noqa: E402, F403
 
-from .apps import *
-from .frames import *
-from .log import *
-from .login import *
-from .repositories import *
-from .signup import *
-from .settings import *
-from .templates import *
-from .misc import *