POC: FastAPI

docker/main/rootfs/usr/local/nginx/conf/nginx.conf

@@ -222,12 +222,16 @@ http {
  include proxy.conf;
  }
 
- location ~* /api/.*\.(jpg|jpeg|png|webp|gif)$ {
- include auth_request.conf;
- rewrite ^/api/(.*)$ $1 break;
- proxy_pass http://frigate_api;
- include proxy.conf;
- }
+# FIXME: Needed to disabled this rule, otherwise it fails for endpoints that end with one of those file extensions
+# 1. with httptools it passes the auth.conf but then throws a 400 error "WARN "Invalid HTTP request received." -> https://github.com/encode/uvicorn/blob/47304d9ae76321f0f5f649ff4f73e09b17085933/uvicorn/protocols/http/httptools_impl.py#L165
+# 2. With h11 it goes through the auth.conf but returns a 404 error
+# We might need to add extra rules that will allow endpoint that end with an extension OR find a fix without creating other rules
+# location ~* /api/.*\.(jpg|jpeg|png|webp|gif)$ {
+# include auth_request.conf;
+# rewrite ^/api/(.*)$ $1 break;
+# proxy_pass http://frigate_api;
+# include proxy.conf;
+# }
 
  location /api/ {
  include auth_request.conf;

frigate/api/app.py

@@ -10,18 +10,21 @@
 from typing import Optional
 
 import requests
+from fastapi import APIRouter, Path, Request, Response
+from fastapi.encoders import jsonable_encoder
+from fastapi.responses import JSONResponse
 from flask import Blueprint, Flask, current_app, jsonify, make_response, request
 from markupsafe import escape
 from peewee import operator
 from playhouse.sqliteq import SqliteQueueDatabase
 from werkzeug.middleware.proxy_fix import ProxyFix
 
 from frigate.api.auth import AuthBp, get_jwt_secret, limiter
+from frigate.api.defs.tags import Tags
 from frigate.api.event import EventBp
 from frigate.api.export import ExportBp
 from frigate.api.media import MediaBp
 from frigate.api.notification import NotificationBp
-from frigate.api.preview import PreviewBp
 from frigate.api.review import ReviewBp
 from frigate.config import FrigateConfig
 from frigate.const import CONFIG_DIR
@@ -47,11 +50,12 @@
 bp.register_blueprint(EventBp)
 bp.register_blueprint(ExportBp)
 bp.register_blueprint(MediaBp)
-bp.register_blueprint(PreviewBp)
 bp.register_blueprint(ReviewBp)
 bp.register_blueprint(AuthBp)
 bp.register_blueprint(NotificationBp)
 
+router = APIRouter()
+
 
 def create_app(
  frigate_config,
@@ -105,15 +109,15 @@ def _db_close(exc):
  return app
 
 
-@bp.route("/")
+@router.get("/", tags=[Tags.app])
 def is_healthy():
  return "Frigate is running. Alive and healthy!"
 
 
-@bp.route("/config/schema.json")
-def config_schema():
- return current_app.response_class(
- current_app.frigate_config.schema_json(), mimetype="application/json"
+@router.get("/config/schema.json", tags=[Tags.app])
+def config_schema(request: Request):
+ return Response(
+ content=request.app.frigate_config.schema_json(), media_type="application/json"
  )
 
 
@@ -454,19 +458,26 @@ def vainfo():
  )
 
 
-@bp.route("/logs/<service>", methods=["GET"])
-def logs(service: str):
+@router.get("/logs/{service}", tags=[Tags.logs])
+def logs(
+ service: str = Path(enum=["frigate", "nginx", "go2rtc", "chroma"]),
+ download: Optional[str] = None,
+ start: Optional[int] = 0,
+ end: Optional[int] = None,
+):
+ """Get logs for the requested service (frigate/nginx/go2rtc/chroma)"""
+
  def download_logs(service_location: str):
  try:
  file = open(service_location, "r")
  contents = file.read()
  file.close()
- return jsonify(contents)
+ return JSONResponse(jsonable_encoder(contents))
  except FileNotFoundError as e:
  logger.error(e)
- return make_response(
- jsonify({"success": False, "message": "Could not find log file"}),
- 500,
+ return JSONResponse(
+ content={"success": False, "message": "Could not find log file"},
+ status_code=500,
  )
 
  log_locations = {
@@ -478,17 +489,14 @@ def download_logs(service_location: str):
  service_location = log_locations.get(service)
 
  if not service_location:
- return make_response(
- jsonify({"success": False, "message": "Not a valid service"}),
- 404,
+ return JSONResponse(
+ content={"success": False, "message": "Not a valid service"},
+ status_code=404,
  )
 
- if request.args.get("download", type=bool, default=False):
+ if download:
  return download_logs(service_location)
 
- start = request.args.get("start", type=int, default=0)
- end = request.args.get("end", type=int)
-
  try:
  file = open(service_location, "r")
  contents = file.read()
@@ -529,15 +537,15 @@ def download_logs(service_location: str):
 
  logLines.append(currentLine)
 
- return make_response(
- jsonify({"totalLines": len(logLines), "lines": logLines[start:end]}),
- 200,
+ return JSONResponse(
+ content={"totalLines": len(logLines), "lines": logLines[start:end]},
+ status_code=200,
  )
  except FileNotFoundError as e:
  logger.error(e)
- return make_response(
- jsonify({"success": False, "message": "Could not find log file"}),
- 500,
+ return JSONResponse(
+ content={"success": False, "message": "Could not find log file"},
+ status_code=500,
  )
 
 

frigate/api/defs/tags.py

@@ -0,0 +1,8 @@
+from enum import Enum
+
+
+class Tags(Enum):
+ app = "App"
+ preview = "Preview"
+ logs = "Logs"
+ media = "Media"

frigate/api/fastapi_app.py

@@ -0,0 +1,37 @@
+import logging
+
+from fastapi import FastAPI
+
+from frigate.api import app as main_app
+from frigate.api import preview
+from frigate.plus import PlusApi
+from frigate.ptz.onvif import OnvifController
+from frigate.stats.emitter import StatsEmitter
+from frigate.storage import StorageMaintainer
+
+logger = logging.getLogger(__name__)
+
+
+def create_fastapi_app(
+ frigate_config,
+ detected_frames_processor,
+ storage_maintainer: StorageMaintainer,
+ onvif: OnvifController,
+ plus_api: PlusApi,
+ stats_emitter: StatsEmitter,
+):
+ logger.info("Starting FastAPI app")
+ app = FastAPI(debug=False)
+ # Routes
+ app.include_router(main_app.router)
+ app.include_router(preview.router)
+ # App Properties
+ app.frigate_config = frigate_config
+ app.detected_frames_processor = detected_frames_processor
+ app.storage_maintainer = storage_maintainer
+ app.camera_error_image = None
+ app.onvif = onvif
+ app.plus_api = plus_api
+ app.stats_emitter = stats_emitter
+
+ return app

frigate/api/preview.py

@@ -5,23 +5,21 @@
 from datetime import datetime, timedelta, timezone
 
 import pytz
-from flask import (
- Blueprint,
- jsonify,
- make_response,
-)
+from fastapi import APIRouter
+from fastapi.responses import JSONResponse
 
+from frigate.api.defs.tags import Tags
 from frigate.const import CACHE_DIR, PREVIEW_FRAME_TYPE
 from frigate.models import Previews
 
 logger = logging.getLogger(__name__)
 
-PreviewBp = Blueprint("previews", __name__)
 
+router = APIRouter(tags=[Tags.preview])
 
-@PreviewBp.route("/preview/<camera_name>/start/<int:start_ts>/end/<int:end_ts>")
-@PreviewBp.route("/preview/<camera_name>/start/<float:start_ts>/end/<float:end_ts>")
-def preview_ts(camera_name, start_ts, end_ts):
+
+@router.get("/preview/{camera_name}/start/{start_ts}/end/{end_ts}")
+def preview_ts(camera_name: str, start_ts: float, end_ts: float):
  """Get all mp4 previews relevant for time period."""
  if camera_name != "all":
  camera_clause = Previews.camera == camera_name
@@ -62,24 +60,20 @@ def preview_ts(camera_name, start_ts, end_ts):
  )
 
  if not clips:
- return make_response(
- jsonify(
- {
- "success": False,
- "message": "No previews found.",
- }
- ),
- 404,
+ return JSONResponse(
+ content={
+ "success": False,
+ "message": "No previews found.",
+ },
+ status_code=404,
  )
 
- return make_response(jsonify(clips), 200)
+ return JSONResponse(content=clips, status_code=200)
 
 
-@PreviewBp.route("/preview/<year_month>/<int:day>/<int:hour>/<camera_name>/<tz_name>")
-@PreviewBp.route(
- "/preview/<year_month>/<float:day>/<float:hour>/<camera_name>/<tz_name>"
-)
-def preview_hour(year_month, day, hour, camera_name, tz_name):
+@router.get("/preview/{year_month}/{day}/{hour}/{camera_name}/{tz_name}")
+def preview_hour(year_month: str, day: int, hour: int, camera_name: str, tz_name: str):
+ """Get all mp4 previews relevant for time period given the timezone"""
  parts = year_month.split("-")
  start_date = (
  datetime(int(parts[0]), int(parts[1]), int(day), int(hour), tzinfo=timezone.utc)
@@ -92,11 +86,8 @@ def preview_hour(year_month, day, hour, camera_name, tz_name):
  return preview_ts(camera_name, start_ts, end_ts)
 
 
-@PreviewBp.route("/preview/<camera_name>/start/<int:start_ts>/end/<int:end_ts>/frames")
-@PreviewBp.route(
- "/preview/<camera_name>/start/<float:start_ts>/end/<float:end_ts>/frames"
-)
-def get_preview_frames_from_cache(camera_name: str, start_ts, end_ts):
+@router.get("/preview/{camera_name}/start/{start_ts}/end/{end_ts}/frames")
+def get_preview_frames_from_cache(camera_name: str, start_ts: float, end_ts: float):
  """Get list of cached preview frames"""
  preview_dir = os.path.join(CACHE_DIR, "preview_frames")
  file_start = f"preview_{camera_name}"
@@ -116,4 +107,7 @@ def get_preview_frames_from_cache(camera_name: str, start_ts, end_ts):
 
  selected_previews.append(file)
 
- return jsonify(selected_previews)
+ return JSONResponse(
+ content=selected_previews,
+ status_code=200,
+ )

frigate/app.py

@@ -14,13 +14,16 @@
 from typing import Optional
 
 import psutil
+import uvicorn
+from fastapi.middleware.wsgi import WSGIMiddleware
 from peewee_migrate import Router
 from playhouse.sqlite_ext import SqliteExtDatabase
 from playhouse.sqliteq import SqliteQueueDatabase
 from pydantic import ValidationError
 
 from frigate.api.app import create_app
 from frigate.api.auth import hash_password
+from frigate.api.fastapi_app import create_fastapi_app
 from frigate.comms.config_updater import ConfigPublisher
 from frigate.comms.dispatcher import Communicator, Dispatcher
 from frigate.comms.inter_process import InterProcessCommunicator
@@ -397,6 +400,15 @@ def init_web_server(self) -> None:
  self.stats_emitter,
  )
 
+ self.fastapi_app = create_fastapi_app(
+ self.config,
+ self.detected_frames_processor,
+ self.storage_maintainer,
+ self.onvif_controller,
+ self.plus_api,
+ self.stats_emitter,
+ )
+
  def init_onvif(self) -> None:
  self.onvif_controller = OnvifController(self.config, self.ptz_metrics)
 
@@ -754,11 +766,17 @@ def receiveSignal(signalNumber: int, frame: Optional[FrameType]) -> None:
  signal.signal(signal.SIGTERM, receiveSignal)
 
  try:
- self.flask_app.run(host="127.0.0.1", port=5001, debug=False, threaded=True)
+ # Run the flask app inside fastapi: https://fastapi.tiangolo.com/advanced/sub-applications/
+ self.fastapi_app.mount("", WSGIMiddleware(self.flask_app))
+ uvicorn.run(
+ self.fastapi_app,
+ host="127.0.0.1",
+ port=5001,
+ )
  except KeyboardInterrupt:
  pass
 
- logger.info("Flask has exited...")
+ logger.info("FastAPI/Flask has exited...")
 
  self.stop()