Feature Updates: User Groups, Favourites, Secondary Location & Bugsnag Integration (#7)

* Feature: User favourites (#2)

* Feature: initial routers / methods for favourites

- add env documentation / adminer image for easier inspection of db
- create / delete favourite entry in database
- fetch list of favourites by user

* Chore: update formatting, tests

* update test methods / logging

-

* updates

* expand tests / logging

* env updates

* .env updates (#8)

* env updates

* update example env

* initial routes

* update methods

* Add secondary country to signals data (#10)

* initial routes

* update methods

* Fix: Update Python setup action to v4 and fix cache configuration

* Update signal.py

* Collaborative signal editing (user groups etc) (#9)

* full routers / entities / test setup

* update methods

* Delete signal_collaborators.sql

---------

Co-authored-by: amaguire-undp <[email protected]>

* add endpoints to get auth user's groups + signals

* add emails to user group routes

* configure application with bugsnag

* update app configuration with bugsnag

---------

Co-authored-by: amaguire-undp <[email protected]>

Author: happy-devs

.env.example

@@ -0,0 +1,40 @@
+# Authentication
+TENANT_ID="<microsoft-entra-tenant-id>"
+CLIENT_ID="<app-id>"
+API_KEY="<strong-password>" # for accessing "public" endpoints
+
+# Database and Storage
+DB_CONNECTION="postgresql://<user>:<password>@<host>:5432/<staging|production>"
+SAS_URL="https://<account-name>.blob.core.windows.net/<container-name>?<sas-token>"
+
+# Azure OpenAI, only required for `/signals/generation`
+AZURE_OPENAI_ENDPOINT="https://<subdomain>.openai.azure.com/"
+AZURE_OPENAI_API_KEY="<api-key>"
+
+# Testing, only required to run tests, must be a valid token of a regular user
+API_JWT="<json-token>"
+# Email Configuration
+MS_FROM_EMAIL=[email protected]
+EMAIL_SERVICE_TYPE=ms_graph
+
+# SendGrid Configuration (if using SendGrid email service)
+SENDGRID_API_KEY=
+SENDGRID_FROM_EMAIL=
+
+# Azure Authentication
+TENANT_ID=
+CLIENT_ID=
+
+# API Authentication
+API_KEY=
+API_JWT=
+
+# Database Connection
+DB_CONNECTION=
+
+# Azure Storage
+SAS_URL=
+
+# Azure OpenAI Configuration
+AZURE_OPENAI_ENDPOINT=
+AZURE_OPENAI_API_KEY= 

.env.local

@@ -0,0 +1,13 @@
+TENANT_ID=
+CLIENT_ID=
+API_KEY=
+
+DB_CONNECTION=
+SAS_URL=
+
+AZURE_OPENAI_ENDPOINT=
+AZURE_OPENAI_API_KEY=
+
+API_JWT=  
+
+NEWS_API_KEY=

.github/workflows/azure-webapps-python.yml

@@ -24,10 +24,11 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Set up Python version
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-          cache: 'pip'
+          cache: pip
+          cache-dependency-path: 'requirements.txt'
 
       - name: Create and start virtual environment
         run: |

.gitignore

@@ -140,3 +140,9 @@ cython_debug/
 # Manually added for this project
 .idea/
 **/.DS_Store
+create_test_user.sql
+.env.production
+/.prs
+Taskfile.yml
+.env.local
+/.logs

Dockerfile

@@ -1,10 +1,26 @@
 FROM python:3.11.7-slim
+
+# Install system dependencies
 RUN apt-get update -y \
-    && apt-get install libpq-dev -y \
+    && apt-get install -y \
+    libpq-dev \
+    postgresql-client \
+    curl \
     && rm -rf /var/lib/apt/lists/*
+
 WORKDIR /app
-COPY requirements.txt .
-RUN pip install --no-cache-dir --upgrade -r requirements.txt
+
+# Install Python dependencies including development dependencies
+COPY requirements.txt requirements_dev.txt ./
+RUN pip install --no-cache-dir --upgrade -r requirements.txt -r requirements_dev.txt
+
+# Copy application code
 COPY . .
+
 EXPOSE 8000
+
+# Add healthcheck
+HEALTHCHECK --interval=30s --timeout=30s --start-period=5s --retries=3 \
+    CMD curl --fail http://localhost:8000/signals/search || exit 1
+
 CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8000"]

Makefile

@@ -5,4 +5,4 @@ format:
 lint:
 	pylint main.py src/
 test:
-	python -m pytest tests/
+	python -m pytest tests/

docker-compose.yaml

@@ -5,16 +5,43 @@ services:
     env_file: .env
     environment:
       - DB_CONNECTION=postgresql://postgres:password@db:5432/postgres
+      - ENV_MODE=local
     ports:
       - "8000:8000"
+    volumes:
+      - .:/app
     depends_on:
-      - db
+      db:
+        condition: service_healthy
+    command: >
+      sh -c "sleep 5 && uvicorn main:app --host 0.0.0.0 --port 8000 --reload"
   db:
     image: postgres:16.4-alpine
     environment:
       POSTGRES_PASSWORD: password
+      POSTGRES_DB: postgres
     ports:
-      - "5432:5432"
+      - 5432:5432
     volumes:
-      - ./sql:/docker-entrypoint-initdb.d
+      - postgres_data:/var/lib/postgresql/data
+      - ./sql/create_tables.sql:/docker-entrypoint-initdb.d/1-create_tables.sql
+      - ./sql/import_data.sql:/docker-entrypoint-initdb.d/2-import_data.sql
+      - ./sql/init_test_data.sql:/docker-entrypoint-initdb.d/3-init_test_data.sql
+      - ./sql/add_secondary_location.sql:/app/sql/add_secondary_location.sql
       - ./data:/docker-entrypoint-initdb.d/data
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U postgres"]
+      interval: 5s
+      timeout: 5s
+      retries: 5
+  adminer:
+    image: adminer
+    restart: always
+    ports:
+      - 4040:8080
+    depends_on:
+      db:
+        condition: service_healthy
+
+volumes:
+  postgres_data:

main.py

@@ -3,13 +3,31 @@
 the frontend platform with the backend database.
 """
 
+import os
+import logging
+import datetime
 from dotenv import load_dotenv
-from fastapi import Depends, FastAPI
+from fastapi import Depends, FastAPI, Request
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi.responses import JSONResponse
 
 from src import routers
 from src.authentication import authenticate_user
+from src.config.logging_config import setup_logging
+from src.bugsnag_config import configure_bugsnag, setup_bugsnag_logging, get_bugsnag_middleware, BUGSNAG_ENABLED
 
+# Load environment variables and set up logging
 load_dotenv()
+setup_logging()
+
+# Get application version
+app_version = os.environ.get("RELEASE_VERSION", "dev")
+app_env = os.environ.get("ENVIRONMENT", "development")
+logging.info(f"Starting application - version: {app_version}, environment: {app_env}")
+
+# Configure Bugsnag for error tracking
+configure_bugsnag()
+setup_bugsnag_logging()
 
 app = FastAPI(
     debug=False,
@@ -42,11 +60,82 @@
         {"name": "trends", "description": "CRUD operations on trends."},
         {"name": "users", "description": "CRUD operations on users."},
         {"name": "choices", "description": "List valid options for forms fields."},
+        {"name": "favourites", "description": "Manage user's favorite signals."},
     ],
     docs_url="/",
     redoc_url=None,
 )
 
+# Add global exception handler to report errors to Bugsnag
+@app.exception_handler(Exception)
+async def global_exception_handler(request: Request, exc: Exception):
+    logging.error(f"Unhandled exception: {str(exc)}", exc_info=True)
+    
+    if BUGSNAG_ENABLED:
+        import bugsnag
+        bugsnag.notify(
+            exc,
+            metadata={
+                "request": {
+                    "url": str(request.url),
+                    "method": request.method,
+                    "headers": dict(request.headers),
+                    "client": request.client.host if request.client else None,
+                }
+            }
+        )
+    
+    return JSONResponse(
+        status_code=500,
+        content={"detail": "Internal server error"},
+    )
+
+# allow cors
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=["*"],
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
+
+# Add Bugsnag exception handling middleware
+# Important: Add middleware AFTER registering exception handlers
+bugsnag_app = get_bugsnag_middleware(app)
 
 for router in routers.ALL:
     app.include_router(router=router, dependencies=[Depends(authenticate_user)])
+
+# Add diagnostic endpoint for health checks and Bugsnag verification
+@app.get("/_health", include_in_schema=False)
+async def health_check():
+    """Health check endpoint that also shows the current environment and version."""
+    return {
+        "status": "ok",
+        "environment": app_env,
+        "version": app_version,
+        "bugsnag_enabled": BUGSNAG_ENABLED
+    }
+
+# Test endpoint to trigger a test error report to Bugsnag if enabled
+@app.get("/_test-error", include_in_schema=False)
+async def test_error():
+    """Trigger a test error to verify Bugsnag is working."""
+    if BUGSNAG_ENABLED:
+        import bugsnag
+        bugsnag.notify(
+            Exception("Test error triggered via /_test-error endpoint"),
+            metadata={
+                "test_info": {
+                    "environment": app_env,
+                    "version": app_version,
+                    "timestamp": str(datetime.datetime.now())
+                }
+            }
+        )
+        return {"status": "error_reported", "message": "Test error sent to Bugsnag"}
+    else:
+        return {"status": "disabled", "message": "Bugsnag is not enabled"}
+
+# Use the Bugsnag middleware wrapped app for ASGI
+app = bugsnag_app

requirements.txt

@@ -14,3 +14,4 @@ pillow ~= 11.0.0
 beautifulsoup4 ~= 4.12.3
 lxml ~= 5.3.0
 openai == 1.52.2
+bugsnag>=4.0.0

requirements_dev.txt

@@ -4,3 +4,6 @@ isort ~= 5.13.2
 pylint ~= 3.3.1
 pytest ~= 8.3.3
 notebook ~= 7.2.2
+pytest-asyncio==0.21.1
+pytest-cov==4.1.0
+pytest-watch==4.2.0

setup.py

@@ -0,0 +1,13 @@
+from setuptools import find_packages, setup
+
+setup(
+    name="ftss-api",
+    version="0.1",
+    packages=find_packages(),
+    install_requires=[
+        "fastapi",
+        "uvicorn",
+        "psycopg",
+        "pydantic",
+    ],
+) 

sql/add_secondary_location.sql

@@ -0,0 +1,24 @@
+/*
+Migration script to add secondary_location column to signals table.
+Run this script to update the database schema.
+*/
+
+-- Add secondary_location column to signals table
+ALTER TABLE signals ADD COLUMN IF NOT EXISTS secondary_location TEXT[];
+
+-- Update the index to include the new column
+DROP INDEX IF EXISTS signals_idx;
+CREATE INDEX ON signals (
+    status,
+    created_by,
+    created_for,
+    created_unit,
+    steep_primary,
+    steep_secondary,
+    signature_primary,
+    signature_secondary,
+    sdgs,
+    location,
+    secondary_location,
+    score
+); 

sql/create_tables.sql

@@ -24,11 +24,13 @@ CREATE TABLE users (
 	role VARCHAR(255) NOT NULL,
 	name VARCHAR(255),
 	unit  VARCHAR(255),
-    acclab BOOLEAN
+    acclab BOOLEAN,
+    api_key VARCHAR(255) UNIQUE
 );
 
 CREATE INDEX ON users (email);
 CREATE INDEX ON users (role);
+CREATE INDEX ON users (api_key);
 
 -- signals table and indices
 CREATE TABLE signals (
@@ -118,6 +120,19 @@ CREATE TABLE connections (
 	CONSTRAINT connection_pk PRIMARY KEY (signal_id, trend_id)
 );
 
+-- favourites table to track user's favourite signals
+CREATE TABLE favourites (
+    user_id INT REFERENCES users(id) ON DELETE CASCADE,
+    signal_id INT REFERENCES signals(id) ON DELETE CASCADE,
+    created_at TIMESTAMP NOT NULL DEFAULT NOW(),
+    CONSTRAINT favourites_pk PRIMARY KEY (user_id, signal_id)
+);
+
+CREATE INDEX ON favourites (user_id, created_at);
+
+CREATE INDEX favourites_user_signal_idx ON favourites (user_id, signal_id);
+CREATE INDEX favourites_created_at_idx ON favourites (created_at DESC);
+
 -- locations table and indices
 CREATE TABLE locations (
     id SERIAL PRIMARY KEY,
@@ -134,4 +149,4 @@ CREATE TABLE units (
 	name TEXT NOT NULL,
 	region VARCHAR(255)
 );
-CREATE INDEX ON units (name, region);
+CREATE INDEX ON units (name, region);