Merge branch 'main' into sidebar-toggle

Author: VasuS609

.env.example

@@ -271,15 +271,16 @@ jobs:
       matrix:
         include:
           - platform: "macos-latest"
-            args: "--target aarch64-apple-darwin"
+            # Enable CI feature so prod() spawns backend + sync in release builds
+            args: "--target aarch64-apple-darwin --features ci"
             server-artifact: "PictoPy-MacOS"
             sync-artifact: "PictoPy-Sync-MacOS"
           - platform: "ubuntu-22.04"
-            args: ""
+            args: "--features ci"
             server-artifact: "PictoPy-Ubuntu"
             sync-artifact: "PictoPy-Sync-Ubuntu"
           - platform: "windows-latest"
-            args: ""
+            args: "--features ci"
             server-artifact: "PictoPy-Windows"
             sync-artifact: "PictoPy-Sync-Windows"
     runs-on: ${{ matrix.platform }}

.github/workflows/build-and-release.yml

@@ -12,11 +12,11 @@ jobs:
       matrix:
         include:
           - platform: "macos-latest"
-            args: "--target aarch64-apple-darwin"
+            args: "--target aarch64-apple-darwin --features ci"
           - platform: "ubuntu-22.04"
-            args: ""
+            args: "--features ci"
           - platform: "windows-latest"
-            args: ""
+            args: "--features ci"
     runs-on: ${{ matrix.platform }}
     steps:
       - uses: actions/checkout@v4

.github/workflows/pr-check-build.yml

@@ -1,3 +1,6 @@
+from platformdirs import user_data_dir
+import os
+
 # Model Exports Path
 MODEL_EXPORTS_PATH = "app/models/ONNX_Exports"
 
@@ -20,6 +23,9 @@
 
 TEST_INPUT_PATH = "tests/inputs"
 TEST_OUTPUT_PATH = "tests/outputs"
-DATABASE_PATH = "app/database/PictoPy.db"
-THUMBNAIL_IMAGES_PATH = "./images/thumbnails"
+if os.getenv("GITHUB_ACTIONS") == "true":
+    DATABASE_PATH = os.path.join(os.getcwd(), "test_db.sqlite3")
+else:
+    DATABASE_PATH = os.path.join(user_data_dir("PictoPy"), "database", "PictoPy.db")
+THUMBNAIL_IMAGES_PATH = os.path.join(user_data_dir("PictoPy"), "thumbnails")
 IMAGES_PATH = "./images"

__pycache__/app.cpython-313.pyc

@@ -0,0 +1,66 @@
+import asyncio
+import os
+import platform
+import signal
+from fastapi import APIRouter
+from pydantic import BaseModel
+from app.logging.setup_logging import get_logger
+
+logger = get_logger(__name__)
+
+router = APIRouter(tags=["Shutdown"])
+
+
+class ShutdownResponse(BaseModel):
+    """Response model for shutdown endpoint."""
+
+    status: str
+    message: str
+
+
+async def _delayed_shutdown(delay: float = 0.5):
+    """
+    Shutdown the server after a short delay to allow the response to be sent.
+
+    Args:
+        delay: Seconds to wait before signaling shutdown
+    """
+    await asyncio.sleep(delay)
+    logger.info("Backend shutdown initiated, exiting process...")
+
+    if platform.system() == "Windows":
+        # Windows: SIGTERM doesn't work reliably with uvicorn subprocesses
+        os._exit(0)
+    else:
+        # Unix (Linux/macOS): SIGTERM allows cleanup handlers to run
+        os.kill(os.getpid(), signal.SIGTERM)
+
+
+@router.post("/shutdown", response_model=ShutdownResponse)
+async def shutdown():
+    """
+    Gracefully shutdown the PictoPy backend.
+
+    This endpoint schedules backend server termination after response is sent.
+    The frontend is responsible for shutting down the sync service separately.
+
+    Returns:
+        ShutdownResponse with status and message
+    """
+    logger.info("Shutdown request received for PictoPy backend")
+
+    # Define callback to handle potential exceptions in the background task
+    def _handle_shutdown_exception(task: asyncio.Task):
+        try:
+            task.result()
+        except Exception as e:
+            logger.error(f"Shutdown task failed: {e}")
+
+    # Schedule backend shutdown after response is sent
+    shutdown_task = asyncio.create_task(_delayed_shutdown())
+    shutdown_task.add_done_callback(_handle_shutdown_exception)
+
+    return ShutdownResponse(
+        status="shutting_down",
+        message="PictoPy backend shutdown initiated.",
+    )

app.py

@@ -6,6 +6,7 @@
 import os
 import json
 
+from app.config.settings import DATABASE_PATH, THUMBNAIL_IMAGES_PATH
 from uvicorn import Config, Server
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
@@ -25,6 +26,7 @@
 from app.routes.images import router as images_router
 from app.routes.face_clusters import router as face_clusters_router
 from app.routes.user_preferences import router as user_preferences_router
+from app.routes.shutdown import router as shutdown_router
 from fastapi.openapi.utils import get_openapi
 from app.logging.setup_logging import (
     configure_uvicorn_logging,
@@ -38,6 +40,11 @@
 # Configure Uvicorn logging to use our custom formatter
 configure_uvicorn_logging("backend")
 
+path = os.path.dirname(DATABASE_PATH)
+os.makedirs(path, exist_ok=True)
+
+os.makedirs(THUMBNAIL_IMAGES_PATH, exist_ok=True)
+
 
 @asynccontextmanager
 async def lifespan(app: FastAPI):
@@ -130,6 +137,7 @@ async def root():
 app.include_router(
     user_preferences_router, prefix="/user-preferences", tags=["User Preferences"]
 )
+app.include_router(shutdown_router, tags=["Shutdown"])
 
 
 # Entry point for running with: python3 main.py
@@ -138,7 +146,6 @@ async def root():
     logger = get_logger(__name__)
     logger.info("Starting PictoPy backend server...")
 
-    # Create a simple config with log_config=None to disable Uvicorn's default logging
     config = Config(
         app=app,
         host="localhost",

backend/app/config/settings.py

@@ -71,3 +71,4 @@ ruff>=0.0.241
 psutil>=5.9.5
 pytest-asyncio>=1.0.0
 setuptools==66.1.1
+platformdirs==4.5.1

backend/app/routes/shutdown.py

@@ -1117,14 +1117,9 @@
             "in": "query",
             "required": false,
             "schema": {
-              "allOf": [
-                {
-                  "$ref": "#/components/schemas/InputType"
-                }
-              ],
+              "$ref": "#/components/schemas/InputType",
               "description": "Choose input type: 'path' or 'base64'",
-              "default": "path",
-              "title": "Input Type"
+              "default": "path"
             },
             "description": "Choose input type: 'path' or 'base64'"
           }
@@ -1237,7 +1232,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/app__schemas__user_preferences__ErrorResponse"
+                  "$ref": "#/components/schemas/ErrorResponse"
                 }
               }
             }
@@ -1277,7 +1272,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/app__schemas__user_preferences__ErrorResponse"
+                  "$ref": "#/components/schemas/ErrorResponse"
                 }
               }
             }
@@ -1287,7 +1282,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/app__schemas__user_preferences__ErrorResponse"
+                  "$ref": "#/components/schemas/ErrorResponse"
                 }
               }
             }
@@ -1304,6 +1299,29 @@
           }
         }
       }
+    },
+    "/shutdown": {
+      "post": {
+        "tags": [
+          "Shutdown",
+          "Shutdown"
+        ],
+        "summary": "Shutdown",
+        "description": "Gracefully shutdown the PictoPy backend.\n\nThis endpoint schedules backend server termination after response is sent.\nThe frontend is responsible for shutting down the sync service separately.\n\nReturns:\n    ShutdownResponse with status and message",
+        "operationId": "shutdown_shutdown_post",
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ShutdownResponse"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {
@@ -1619,6 +1637,30 @@
         ],
         "title": "DeleteFoldersResponse"
       },
+      "ErrorResponse": {
+        "properties": {
+          "success": {
+            "type": "boolean",
+            "title": "Success"
+          },
+          "error": {
+            "type": "string",
+            "title": "Error"
+          },
+          "message": {
+            "type": "string",
+            "title": "Message"
+          }
+        },
+        "type": "object",
+        "required": [
+          "success",
+          "error",
+          "message"
+        ],
+        "title": "ErrorResponse",
+        "description": "Error response model"
+      },
       "FaceSearchRequest": {
         "properties": {
           "path": {
@@ -2204,6 +2246,7 @@
           "metadata": {
             "anyOf": [
               {
+                "additionalProperties": true,
                 "type": "object"
               },
               {
@@ -2425,6 +2468,25 @@
         ],
         "title": "RenameClusterResponse"
       },
+      "ShutdownResponse": {
+        "properties": {
+          "status": {
+            "type": "string",
+            "title": "Status"
+          },
+          "message": {
+            "type": "string",
+            "title": "Message"
+          }
+        },
+        "type": "object",
+        "required": [
+          "status",
+          "message"
+        ],
+        "title": "ShutdownResponse",
+        "description": "Response model for shutdown endpoint."
+      },
       "SuccessResponse": {
         "properties": {
           "success": {
@@ -2897,30 +2959,6 @@
           "error"
         ],
         "title": "ErrorResponse"
-      },
-      "app__schemas__user_preferences__ErrorResponse": {
-        "properties": {
-          "success": {
-            "type": "boolean",
-            "title": "Success"
-          },
-          "error": {
-            "type": "string",
-            "title": "Error"
-          },
-          "message": {
-            "type": "string",
-            "title": "Message"
-          }
-        },
-        "type": "object",
-        "required": [
-          "success",
-          "error",
-          "message"
-        ],
-        "title": "ErrorResponse",
-        "description": "Error response model"
       }
     }
   }