all the new shiny things
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 15m54s
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 15m54s
This commit is contained in:
@@ -87,7 +87,8 @@
|
||||
"Bash(docker ps:*)",
|
||||
"Bash(find:*)",
|
||||
"Bash(\"/c/Users/games3/.local/bin/uvx.exe\" markitdown-mcp --help)",
|
||||
"Bash(git stash:*)"
|
||||
"Bash(git stash:*)",
|
||||
"Bash(ping:*)"
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
@@ -240,7 +240,19 @@ jobs:
|
||||
# Run c8: read raw files from the temp dir, and output an Istanbul JSON report.
|
||||
# We only generate the 'json' report here because it's all nyc needs for merging.
|
||||
echo "Server coverage report about to be generated..."
|
||||
npx c8 report --exclude='**/*.test.ts' --exclude='**/tests/**' --exclude='**/mocks/**' --reporter=json --temp-directory .coverage/tmp/integration-server --reports-dir .coverage/integration-server
|
||||
npx c8 report \
|
||||
--include='src/**' \
|
||||
--exclude='**/*.test.ts' \
|
||||
--exclude='**/*.test.tsx' \
|
||||
--exclude='**/tests/**' \
|
||||
--exclude='**/mocks/**' \
|
||||
--exclude='hostexecutor/**' \
|
||||
--exclude='scripts/**' \
|
||||
--exclude='*.config.js' \
|
||||
--exclude='*.config.ts' \
|
||||
--reporter=json \
|
||||
--temp-directory .coverage/tmp/integration-server \
|
||||
--reports-dir .coverage/integration-server
|
||||
echo "Server coverage report generated. Verifying existence:"
|
||||
ls -l .coverage/integration-server/coverage-final.json
|
||||
|
||||
@@ -280,12 +292,18 @@ jobs:
|
||||
--reporter=html \
|
||||
--report-dir .coverage/ \
|
||||
--temp-dir "$NYC_SOURCE_DIR" \
|
||||
--include "src/**" \
|
||||
--exclude "**/*.test.ts" \
|
||||
--exclude "**/*.test.tsx" \
|
||||
--exclude "**/tests/**" \
|
||||
--exclude "**/mocks/**" \
|
||||
--exclude "**/index.tsx" \
|
||||
--exclude "**/vite-env.d.ts" \
|
||||
--exclude "**/vitest.setup.ts"
|
||||
--exclude "**/vitest.setup.ts" \
|
||||
--exclude "hostexecutor/**" \
|
||||
--exclude "scripts/**" \
|
||||
--exclude "*.config.js" \
|
||||
--exclude "*.config.ts"
|
||||
|
||||
# Re-enable secret masking for subsequent steps.
|
||||
echo "::secret-masking::"
|
||||
|
||||
27
CLAUDE.md
27
CLAUDE.md
@@ -15,17 +15,24 @@ Instead, ask the user to confirm the current state before providing instructions
|
||||
|
||||
**CRITICAL**: This application is designed to run **exclusively on Linux**. See [ADR-014](docs/adr/0014-containerization-and-deployment-strategy.md) for full details.
|
||||
|
||||
### Environment Terminology
|
||||
|
||||
- **Dev Container** (or just "dev"): The containerized Linux development environment (`flyer-crawler-dev`). This is where all development and testing should occur.
|
||||
- **Host**: The Windows machine running Podman/Docker and VS Code.
|
||||
|
||||
When instructions say "run in dev" or "run in the dev container", they mean executing commands inside the `flyer-crawler-dev` container.
|
||||
|
||||
### Test Execution Rules
|
||||
|
||||
1. **ALL tests MUST be executed on Linux** - either in the Dev Container or on a Linux host
|
||||
2. **NEVER run tests directly on Windows** - test results from Windows are unreliable
|
||||
3. **Always use the Dev Container for testing** when developing on Windows
|
||||
1. **ALL tests MUST be executed in the dev container** - the Linux container environment
|
||||
2. **NEVER run tests directly on Windows host** - test results from Windows are unreliable
|
||||
3. **Always use the dev container for testing** when developing on Windows
|
||||
|
||||
### How to Run Tests Correctly
|
||||
|
||||
```bash
|
||||
# If on Windows, first open VS Code and "Reopen in Container"
|
||||
# Then run tests inside the container:
|
||||
# Then run tests inside the dev container:
|
||||
npm test # Run all unit tests
|
||||
npm run test:unit # Run unit tests only
|
||||
npm run test:integration # Run integration tests (requires DB/Redis)
|
||||
@@ -33,13 +40,13 @@ npm run test:integration # Run integration tests (requires DB/Redis)
|
||||
|
||||
### Running Tests via Podman (from Windows host)
|
||||
|
||||
The command to run unit tests in the Linux container via podman:
|
||||
The command to run unit tests in the dev container via podman:
|
||||
|
||||
```bash
|
||||
podman exec -it flyer-crawler-dev npm run test:unit
|
||||
```
|
||||
|
||||
The command to run integration tests in the Linux container via podman:
|
||||
The command to run integration tests in the dev container via podman:
|
||||
|
||||
```bash
|
||||
podman exec -it flyer-crawler-dev npm run test:integration
|
||||
@@ -66,10 +73,10 @@ podman exec -it flyer-crawler-dev npm test -- --run src/hooks/useAuth.test.tsx
|
||||
## Development Workflow
|
||||
|
||||
1. Open project in VS Code
|
||||
2. Use "Reopen in Container" (Dev Containers extension required)
|
||||
3. Wait for container initialization to complete
|
||||
4. Run `npm test` to verify environment is working
|
||||
5. Make changes and run tests inside the container
|
||||
2. Use "Reopen in Container" (Dev Containers extension required) to enter the dev environment
|
||||
3. Wait for dev container initialization to complete
|
||||
4. Run `npm test` to verify the dev environment is working
|
||||
5. Make changes and run tests inside the dev container
|
||||
|
||||
## Code Change Verification
|
||||
|
||||
|
||||
152
Dockerfile.dev
152
Dockerfile.dev
@@ -7,7 +7,7 @@
|
||||
#
|
||||
# Base: Ubuntu 22.04 (LTS) - matches production server
|
||||
# Node: v20.x (LTS) - matches production
|
||||
# Includes: PostgreSQL client, Redis CLI, build tools
|
||||
# Includes: PostgreSQL client, Redis CLI, build tools, Bugsink, Logstash
|
||||
# ============================================================================
|
||||
|
||||
FROM ubuntu:22.04
|
||||
@@ -21,16 +21,23 @@ ENV DEBIAN_FRONTEND=noninteractive
|
||||
# - curl: for downloading Node.js setup script and health checks
|
||||
# - git: for version control operations
|
||||
# - build-essential: for compiling native Node.js modules (node-gyp)
|
||||
# - python3: required by some Node.js build tools
|
||||
# - python3, python3-pip, python3-venv: for Bugsink
|
||||
# - postgresql-client: for psql CLI (database initialization)
|
||||
# - redis-tools: for redis-cli (health checks)
|
||||
# - gnupg, apt-transport-https: for Elastic APT repository (Logstash)
|
||||
# - openjdk-17-jre-headless: required by Logstash
|
||||
RUN apt-get update && apt-get install -y \
|
||||
curl \
|
||||
git \
|
||||
build-essential \
|
||||
python3 \
|
||||
python3-pip \
|
||||
python3-venv \
|
||||
postgresql-client \
|
||||
redis-tools \
|
||||
gnupg \
|
||||
apt-transport-https \
|
||||
openjdk-17-jre-headless \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# ============================================================================
|
||||
@@ -39,6 +46,128 @@ RUN apt-get update && apt-get install -y \
|
||||
RUN curl -fsSL https://deb.nodesource.com/setup_20.x | bash - \
|
||||
&& apt-get install -y nodejs
|
||||
|
||||
# ============================================================================
|
||||
# Install Logstash (Elastic APT Repository)
|
||||
# ============================================================================
|
||||
# ADR-015: Log aggregation for Pino and Redis logs → Bugsink
|
||||
RUN curl -fsSL https://artifacts.elastic.co/GPG-KEY-elasticsearch | gpg --dearmor -o /usr/share/keyrings/elastic-keyring.gpg \
|
||||
&& echo "deb [signed-by=/usr/share/keyrings/elastic-keyring.gpg] https://artifacts.elastic.co/packages/8.x/apt stable main" | tee /etc/apt/sources.list.d/elastic-8.x.list \
|
||||
&& apt-get update \
|
||||
&& apt-get install -y logstash \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# ============================================================================
|
||||
# Install Bugsink (Python Package)
|
||||
# ============================================================================
|
||||
# ADR-015: Self-hosted Sentry-compatible error tracking
|
||||
# Create a virtual environment for Bugsink to avoid conflicts
|
||||
RUN python3 -m venv /opt/bugsink \
|
||||
&& /opt/bugsink/bin/pip install --upgrade pip \
|
||||
&& /opt/bugsink/bin/pip install bugsink gunicorn psycopg2-binary
|
||||
|
||||
# Create Bugsink directories
|
||||
RUN mkdir -p /var/log/bugsink /var/lib/bugsink
|
||||
|
||||
# Create Bugsink startup script
|
||||
# Uses DATABASE_URL environment variable (standard Docker approach per docs)
|
||||
RUN echo '#!/bin/bash\n\
|
||||
set -e\n\
|
||||
\n\
|
||||
# Build DATABASE_URL from individual env vars for flexibility\n\
|
||||
export DATABASE_URL="postgresql://${BUGSINK_DB_USER:-bugsink}:${BUGSINK_DB_PASSWORD:-bugsink_dev_password}@${BUGSINK_DB_HOST:-postgres}:${BUGSINK_DB_PORT:-5432}/${BUGSINK_DB_NAME:-bugsink}"\n\
|
||||
# SECRET_KEY is required by Bugsink/Django\n\
|
||||
export SECRET_KEY="${BUGSINK_SECRET_KEY:-dev-bugsink-secret-key-minimum-50-characters-for-security}"\n\
|
||||
\n\
|
||||
# Wait for PostgreSQL to be ready\n\
|
||||
until pg_isready -h ${BUGSINK_DB_HOST:-postgres} -p ${BUGSINK_DB_PORT:-5432} -U ${BUGSINK_DB_USER:-bugsink}; do\n\
|
||||
echo "Waiting for PostgreSQL..."\n\
|
||||
sleep 2\n\
|
||||
done\n\
|
||||
\n\
|
||||
echo "PostgreSQL is ready. Starting Bugsink..."\n\
|
||||
echo "DATABASE_URL: postgresql://${BUGSINK_DB_USER}:***@${BUGSINK_DB_HOST}:${BUGSINK_DB_PORT}/${BUGSINK_DB_NAME}"\n\
|
||||
\n\
|
||||
# Run migrations\n\
|
||||
/opt/bugsink/bin/bugsink-manage migrate --noinput\n\
|
||||
\n\
|
||||
# Create superuser if not exists (for dev convenience)\n\
|
||||
if [ -n "$BUGSINK_ADMIN_EMAIL" ] && [ -n "$BUGSINK_ADMIN_PASSWORD" ]; then\n\
|
||||
export CREATE_SUPERUSER="${BUGSINK_ADMIN_EMAIL}:${BUGSINK_ADMIN_PASSWORD}"\n\
|
||||
echo "Superuser configured: ${BUGSINK_ADMIN_EMAIL}"\n\
|
||||
fi\n\
|
||||
\n\
|
||||
# Start Bugsink with Gunicorn\n\
|
||||
echo "Starting Gunicorn on port ${BUGSINK_PORT:-8000}..."\n\
|
||||
exec /opt/bugsink/bin/gunicorn \\\n\
|
||||
--bind 0.0.0.0:${BUGSINK_PORT:-8000} \\\n\
|
||||
--workers ${BUGSINK_WORKERS:-2} \\\n\
|
||||
--access-logfile - \\\n\
|
||||
--error-logfile - \\\n\
|
||||
bugsink.wsgi:application\n\
|
||||
' > /usr/local/bin/start-bugsink.sh \
|
||||
&& chmod +x /usr/local/bin/start-bugsink.sh
|
||||
|
||||
# ============================================================================
|
||||
# Create Logstash Pipeline Configuration
|
||||
# ============================================================================
|
||||
# ADR-015: Pino and Redis logs → Bugsink
|
||||
RUN mkdir -p /etc/logstash/conf.d /app/logs
|
||||
|
||||
RUN echo 'input {\n\
|
||||
# Pino application logs\n\
|
||||
file {\n\
|
||||
path => "/app/logs/*.log"\n\
|
||||
codec => json\n\
|
||||
type => "pino"\n\
|
||||
tags => ["app"]\n\
|
||||
start_position => "beginning"\n\
|
||||
sincedb_path => "/var/lib/logstash/sincedb_pino"\n\
|
||||
}\n\
|
||||
\n\
|
||||
# Redis logs\n\
|
||||
file {\n\
|
||||
path => "/var/log/redis/*.log"\n\
|
||||
type => "redis"\n\
|
||||
tags => ["redis"]\n\
|
||||
start_position => "beginning"\n\
|
||||
sincedb_path => "/var/lib/logstash/sincedb_redis"\n\
|
||||
}\n\
|
||||
}\n\
|
||||
\n\
|
||||
filter {\n\
|
||||
# Pino error detection (level 50 = error, 60 = fatal)\n\
|
||||
if [type] == "pino" and [level] >= 50 {\n\
|
||||
mutate { add_tag => ["error"] }\n\
|
||||
}\n\
|
||||
\n\
|
||||
# Redis error detection\n\
|
||||
if [type] == "redis" {\n\
|
||||
grok {\n\
|
||||
match => { "message" => "%%{POSINT:pid}:%%{WORD:role} %%{MONTHDAY} %%{MONTH} %%{TIME} %%{WORD:loglevel} %%{GREEDYDATA:redis_message}" }\n\
|
||||
}\n\
|
||||
if [loglevel] in ["WARNING", "ERROR"] {\n\
|
||||
mutate { add_tag => ["error"] }\n\
|
||||
}\n\
|
||||
}\n\
|
||||
}\n\
|
||||
\n\
|
||||
output {\n\
|
||||
if "error" in [tags] {\n\
|
||||
http {\n\
|
||||
url => "http://localhost:8000/api/store/"\n\
|
||||
http_method => "post"\n\
|
||||
format => "json"\n\
|
||||
}\n\
|
||||
}\n\
|
||||
\n\
|
||||
# Debug output (comment out in production)\n\
|
||||
stdout { codec => rubydebug }\n\
|
||||
}\n\
|
||||
' > /etc/logstash/conf.d/bugsink.conf
|
||||
|
||||
# Create Logstash sincedb directory
|
||||
RUN mkdir -p /var/lib/logstash && chown -R logstash:logstash /var/lib/logstash
|
||||
|
||||
# ============================================================================
|
||||
# Set Working Directory
|
||||
# ============================================================================
|
||||
@@ -52,6 +181,25 @@ ENV NODE_ENV=development
|
||||
# Increase Node.js memory limit for large builds
|
||||
ENV NODE_OPTIONS='--max-old-space-size=8192'
|
||||
|
||||
# Bugsink defaults (ADR-015)
|
||||
ENV BUGSINK_DB_HOST=postgres
|
||||
ENV BUGSINK_DB_PORT=5432
|
||||
ENV BUGSINK_DB_NAME=bugsink
|
||||
ENV BUGSINK_DB_USER=bugsink
|
||||
ENV BUGSINK_DB_PASSWORD=bugsink_dev_password
|
||||
ENV BUGSINK_PORT=8000
|
||||
ENV BUGSINK_BASE_URL=http://localhost:8000
|
||||
ENV BUGSINK_ADMIN_EMAIL=admin@localhost
|
||||
ENV BUGSINK_ADMIN_PASSWORD=admin
|
||||
|
||||
# ============================================================================
|
||||
# Expose Ports
|
||||
# ============================================================================
|
||||
# 3000 - Vite frontend
|
||||
# 3001 - Express backend
|
||||
# 8000 - Bugsink error tracking
|
||||
EXPOSE 3000 3001 8000
|
||||
|
||||
# ============================================================================
|
||||
# Default Command
|
||||
# ============================================================================
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
# This file defines the local development environment using Docker/Podman.
|
||||
#
|
||||
# Services:
|
||||
# - app: Node.js application (API + Frontend)
|
||||
# - app: Node.js application (API + Frontend + Bugsink + Logstash)
|
||||
# - postgres: PostgreSQL 15 with PostGIS extension
|
||||
# - redis: Redis for caching and job queues
|
||||
#
|
||||
@@ -18,6 +18,10 @@
|
||||
# VS Code Dev Containers:
|
||||
# This file is referenced by .devcontainer/devcontainer.json for seamless
|
||||
# VS Code integration. Open the project in VS Code and use "Reopen in Container".
|
||||
#
|
||||
# Bugsink (ADR-015):
|
||||
# Access error tracking UI at http://localhost:8000
|
||||
# Default login: admin@localhost / admin
|
||||
# ============================================================================
|
||||
|
||||
version: '3.8'
|
||||
@@ -43,6 +47,7 @@ services:
|
||||
ports:
|
||||
- '3000:3000' # Frontend (Vite default)
|
||||
- '3001:3001' # Backend API
|
||||
- '8000:8000' # Bugsink error tracking (ADR-015)
|
||||
environment:
|
||||
# Core settings
|
||||
- NODE_ENV=development
|
||||
@@ -62,6 +67,17 @@ services:
|
||||
- JWT_SECRET=dev-jwt-secret-change-in-production
|
||||
# Worker settings
|
||||
- WORKER_LOCK_DURATION=120000
|
||||
# Bugsink error tracking (ADR-015)
|
||||
- BUGSINK_DB_HOST=postgres
|
||||
- BUGSINK_DB_PORT=5432
|
||||
- BUGSINK_DB_NAME=bugsink
|
||||
- BUGSINK_DB_USER=bugsink
|
||||
- BUGSINK_DB_PASSWORD=bugsink_dev_password
|
||||
- BUGSINK_PORT=8000
|
||||
- BUGSINK_BASE_URL=http://localhost:8000
|
||||
- BUGSINK_ADMIN_EMAIL=admin@localhost
|
||||
- BUGSINK_ADMIN_PASSWORD=admin
|
||||
- BUGSINK_SECRET_KEY=dev-bugsink-secret-key-minimum-50-characters-for-security
|
||||
depends_on:
|
||||
postgres:
|
||||
condition: service_healthy
|
||||
@@ -93,9 +109,10 @@ services:
|
||||
POSTGRES_INITDB_ARGS: '--encoding=UTF8 --locale=C'
|
||||
volumes:
|
||||
- postgres_data:/var/lib/postgresql/data
|
||||
# Mount the extensions init script to run on first database creation
|
||||
# The 00- prefix ensures it runs before any other init scripts
|
||||
# Mount init scripts to run on first database creation
|
||||
# Scripts run in alphabetical order: 00-extensions, 01-bugsink
|
||||
- ./sql/00-init-extensions.sql:/docker-entrypoint-initdb.d/00-init-extensions.sql:ro
|
||||
- ./sql/01-init-bugsink.sh:/docker-entrypoint-initdb.d/01-init-bugsink.sh:ro
|
||||
# Healthcheck ensures postgres is ready before app starts
|
||||
healthcheck:
|
||||
test: ['CMD-SHELL', 'pg_isready -U postgres -d flyer_crawler_dev']
|
||||
|
||||
@@ -2,17 +2,320 @@
|
||||
|
||||
**Date**: 2025-12-12
|
||||
|
||||
**Status**: Proposed
|
||||
**Status**: Accepted
|
||||
|
||||
**Updated**: 2026-01-11
|
||||
|
||||
## Context
|
||||
|
||||
While `ADR-004` established structured logging, the application lacks a high-level, aggregated view of its health, performance, and errors. It's difficult to spot trends, identify slow API endpoints, or be proactively notified of new types of errors.
|
||||
While `ADR-004` established structured logging with Pino, the application lacks a high-level, aggregated view of its health, performance, and errors. It's difficult to spot trends, identify slow API endpoints, or be proactively notified of new types of errors.
|
||||
|
||||
Key requirements:
|
||||
|
||||
1. **Self-hosted**: No external SaaS dependencies for error tracking
|
||||
2. **Sentry SDK compatible**: Leverage mature, well-documented SDKs
|
||||
3. **Lightweight**: Minimal resource overhead in the dev container
|
||||
4. **Production-ready**: Same architecture works on bare-metal production servers
|
||||
5. **AI-accessible**: MCP server integration for Claude Code and other AI tools
|
||||
|
||||
## Decision
|
||||
|
||||
We will integrate a dedicated Application Performance Monitoring (APM) and error tracking service like **Sentry**, **Datadog**, or **New Relic**. This will define how the service is integrated to automatically capture and report unhandled exceptions, performance data (e.g., transaction traces, database query times), and release health.
|
||||
We will implement a self-hosted error tracking stack using **Bugsink** as the Sentry-compatible backend, with the following components:
|
||||
|
||||
### 1. Error Tracking Backend: Bugsink
|
||||
|
||||
**Bugsink** is a lightweight, self-hosted Sentry alternative that:
|
||||
|
||||
- Runs as a single process (no Kafka, Redis, ClickHouse required)
|
||||
- Is fully compatible with Sentry SDKs
|
||||
- Supports ARM64 and AMD64 architectures
|
||||
- Can use SQLite (dev) or PostgreSQL (production)
|
||||
|
||||
**Deployment**:
|
||||
|
||||
- **Dev container**: Installed as a systemd service inside the container
|
||||
- **Production**: Runs as a systemd service on bare-metal, listening on localhost only
|
||||
- **Database**: Uses PostgreSQL with a dedicated `bugsink` user and `bugsink` database (same PostgreSQL instance as the main application)
|
||||
|
||||
### 2. Backend Integration: @sentry/node
|
||||
|
||||
The Express backend will integrate `@sentry/node` SDK to:
|
||||
|
||||
- Capture unhandled exceptions before PM2/process manager restarts
|
||||
- Report errors with full stack traces and context
|
||||
- Integrate with Pino logger for breadcrumbs
|
||||
- Track transaction performance (optional)
|
||||
|
||||
### 3. Frontend Integration: @sentry/react
|
||||
|
||||
The React frontend will integrate `@sentry/react` SDK to:
|
||||
|
||||
- Wrap the app in a Sentry Error Boundary
|
||||
- Capture unhandled JavaScript errors
|
||||
- Report errors with component stack traces
|
||||
- Track user session context
|
||||
|
||||
### 4. Log Aggregation: Logstash
|
||||
|
||||
**Logstash** parses application and infrastructure logs, forwarding error patterns to Bugsink:
|
||||
|
||||
- **Installation**: Installed inside the dev container (and on bare-metal prod servers)
|
||||
- **Inputs**:
|
||||
- Pino JSON logs from the Node.js application
|
||||
- Redis logs (connection errors, memory warnings, slow commands)
|
||||
- PostgreSQL function logs (future - see Implementation Steps)
|
||||
- **Filter**: Identifies error-level logs (5xx responses, unhandled exceptions, Redis errors)
|
||||
- **Output**: Sends to Bugsink via Sentry-compatible HTTP API
|
||||
|
||||
This provides a secondary error capture path for:
|
||||
|
||||
- Errors that occur before Sentry SDK initialization
|
||||
- Log-based errors that don't throw exceptions
|
||||
- Redis connection/performance issues
|
||||
- Database function errors and slow queries
|
||||
- Historical error analysis from log files
|
||||
|
||||
### 5. MCP Server Integration: sentry-selfhosted-mcp
|
||||
|
||||
For AI tool integration (Claude Code, Cursor, etc.), we use the open-source [sentry-selfhosted-mcp](https://github.com/ddfourtwo/sentry-selfhosted-mcp) server:
|
||||
|
||||
- **No code changes required**: Configurable via environment variables
|
||||
- **Capabilities**: List projects, get issues, view events, update status, add comments
|
||||
- **Configuration**:
|
||||
- `SENTRY_URL`: Points to Bugsink instance
|
||||
- `SENTRY_AUTH_TOKEN`: API token from Bugsink
|
||||
- `SENTRY_ORG_SLUG`: Organization identifier
|
||||
|
||||
## Architecture
|
||||
|
||||
```text
|
||||
┌─────────────────────────────────────────────────────────────────────────┐
|
||||
│ Dev Container / Production Server │
|
||||
├─────────────────────────────────────────────────────────────────────────┤
|
||||
│ │
|
||||
│ ┌──────────────────┐ ┌──────────────────┐ │
|
||||
│ │ Frontend │ │ Backend │ │
|
||||
│ │ (React) │ │ (Express) │ │
|
||||
│ │ @sentry/react │ │ @sentry/node │ │
|
||||
│ └────────┬─────────┘ └────────┬─────────┘ │
|
||||
│ │ │ │
|
||||
│ │ Sentry SDK Protocol │ │
|
||||
│ └───────────┬───────────────┘ │
|
||||
│ │ │
|
||||
│ ▼ │
|
||||
│ ┌──────────────────────┐ │
|
||||
│ │ Bugsink │ │
|
||||
│ │ (localhost:8000) │◄──────────────────┐ │
|
||||
│ │ │ │ │
|
||||
│ │ PostgreSQL backend │ │ │
|
||||
│ └──────────────────────┘ │ │
|
||||
│ │ │
|
||||
│ ┌──────────────────────┐ │ │
|
||||
│ │ Logstash │───────────────────┘ │
|
||||
│ │ (Log Aggregator) │ Sentry Output │
|
||||
│ │ │ │
|
||||
│ │ Inputs: │ │
|
||||
│ │ - Pino app logs │ │
|
||||
│ │ - Redis logs │ │
|
||||
│ │ - PostgreSQL (future) │
|
||||
│ └──────────────────────┘ │
|
||||
│ ▲ ▲ ▲ │
|
||||
│ │ │ │ │
|
||||
│ ┌───────────┘ │ └───────────┐ │
|
||||
│ │ │ │ │
|
||||
│ ┌────┴─────┐ ┌─────┴────┐ ┌──────┴─────┐ │
|
||||
│ │ Pino │ │ Redis │ │ PostgreSQL │ │
|
||||
│ │ Logs │ │ Logs │ │ Logs (TBD) │ │
|
||||
│ └──────────┘ └──────────┘ └────────────┘ │
|
||||
│ │
|
||||
│ ┌──────────────────────┐ │
|
||||
│ │ PostgreSQL │ │
|
||||
│ │ ┌────────────────┐ │ │
|
||||
│ │ │ flyer_crawler │ │ (main app database) │
|
||||
│ │ ├────────────────┤ │ │
|
||||
│ │ │ bugsink │ │ (error tracking database) │
|
||||
│ │ └────────────────┘ │ │
|
||||
│ └──────────────────────┘ │
|
||||
│ │
|
||||
└─────────────────────────────────────────────────────────────────────────┘
|
||||
|
||||
External (Developer Machine):
|
||||
┌──────────────────────────────────────┐
|
||||
│ Claude Code / Cursor / VS Code │
|
||||
│ ┌────────────────────────────────┐ │
|
||||
│ │ sentry-selfhosted-mcp │ │
|
||||
│ │ (MCP Server) │ │
|
||||
│ │ │ │
|
||||
│ │ SENTRY_URL=http://localhost:8000
|
||||
│ │ SENTRY_AUTH_TOKEN=... │ │
|
||||
│ │ SENTRY_ORG_SLUG=... │ │
|
||||
│ └────────────────────────────────┘ │
|
||||
└──────────────────────────────────────┘
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
### Environment Variables
|
||||
|
||||
| Variable | Description | Default (Dev) |
|
||||
| ------------------ | ------------------------------ | -------------------------- |
|
||||
| `BUGSINK_DSN` | Sentry-compatible DSN for SDKs | Set after project creation |
|
||||
| `BUGSINK_ENABLED` | Enable/disable error reporting | `true` |
|
||||
| `BUGSINK_BASE_URL` | Bugsink web UI URL (internal) | `http://localhost:8000` |
|
||||
|
||||
### PostgreSQL Setup
|
||||
|
||||
```sql
|
||||
-- Create dedicated Bugsink database and user
|
||||
CREATE USER bugsink WITH PASSWORD 'bugsink_dev_password';
|
||||
CREATE DATABASE bugsink OWNER bugsink;
|
||||
GRANT ALL PRIVILEGES ON DATABASE bugsink TO bugsink;
|
||||
```
|
||||
|
||||
### Bugsink Configuration
|
||||
|
||||
```bash
|
||||
# Environment variables for Bugsink service
|
||||
SECRET_KEY=<random-50-char-string>
|
||||
DATABASE_URL=postgresql://bugsink:bugsink_dev_password@localhost:5432/bugsink
|
||||
BASE_URL=http://localhost:8000
|
||||
PORT=8000
|
||||
```
|
||||
|
||||
### Logstash Pipeline
|
||||
|
||||
```conf
|
||||
# /etc/logstash/conf.d/bugsink.conf
|
||||
|
||||
# === INPUTS ===
|
||||
input {
|
||||
# Pino application logs
|
||||
file {
|
||||
path => "/app/logs/*.log"
|
||||
codec => json
|
||||
type => "pino"
|
||||
tags => ["app"]
|
||||
}
|
||||
|
||||
# Redis logs
|
||||
file {
|
||||
path => "/var/log/redis/*.log"
|
||||
type => "redis"
|
||||
tags => ["redis"]
|
||||
}
|
||||
|
||||
# PostgreSQL logs (for function logging - future)
|
||||
# file {
|
||||
# path => "/var/log/postgresql/*.log"
|
||||
# type => "postgres"
|
||||
# tags => ["postgres"]
|
||||
# }
|
||||
}
|
||||
|
||||
# === FILTERS ===
|
||||
filter {
|
||||
# Pino error detection (level 50 = error, 60 = fatal)
|
||||
if [type] == "pino" and [level] >= 50 {
|
||||
mutate { add_tag => ["error"] }
|
||||
}
|
||||
|
||||
# Redis error detection
|
||||
if [type] == "redis" {
|
||||
grok {
|
||||
match => { "message" => "%{POSINT:pid}:%{WORD:role} %{MONTHDAY} %{MONTH} %{TIME} %{WORD:loglevel} %{GREEDYDATA:redis_message}" }
|
||||
}
|
||||
if [loglevel] in ["WARNING", "ERROR"] {
|
||||
mutate { add_tag => ["error"] }
|
||||
}
|
||||
}
|
||||
|
||||
# PostgreSQL function error detection (future)
|
||||
# if [type] == "postgres" {
|
||||
# # Parse PostgreSQL log format and detect ERROR/FATAL levels
|
||||
# }
|
||||
}
|
||||
|
||||
# === OUTPUT ===
|
||||
output {
|
||||
if "error" in [tags] {
|
||||
http {
|
||||
url => "http://localhost:8000/api/store/"
|
||||
http_method => "post"
|
||||
format => "json"
|
||||
# Sentry envelope format
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Implementation Steps
|
||||
|
||||
1. **Update Dockerfile.dev**:
|
||||
- Install Bugsink (pip package or binary)
|
||||
- Install Logstash (Elastic APT repository)
|
||||
- Add systemd service files for both
|
||||
|
||||
2. **PostgreSQL initialization**:
|
||||
- Add Bugsink user/database creation to `sql/00-init-extensions.sql`
|
||||
|
||||
3. **Backend SDK integration**:
|
||||
- Install `@sentry/node`
|
||||
- Initialize in `server.ts` before Express app
|
||||
- Configure error handler middleware integration
|
||||
|
||||
4. **Frontend SDK integration**:
|
||||
- Install `@sentry/react`
|
||||
- Wrap `App` component with `Sentry.ErrorBoundary`
|
||||
- Configure in `src/index.tsx`
|
||||
|
||||
5. **Environment configuration**:
|
||||
- Add Bugsink variables to `src/config/env.ts`
|
||||
- Update `.env.example` and `compose.dev.yml`
|
||||
|
||||
6. **Logstash configuration**:
|
||||
- Create pipeline config for Pino → Bugsink
|
||||
- Configure Pino to write to log file in addition to stdout
|
||||
- Configure Redis log monitoring (connection errors, slow commands)
|
||||
|
||||
7. **MCP server documentation**:
|
||||
- Document `sentry-selfhosted-mcp` setup in CLAUDE.md
|
||||
|
||||
8. **PostgreSQL function logging** (future):
|
||||
- Configure PostgreSQL to log function execution errors
|
||||
- Add Logstash input for PostgreSQL logs
|
||||
- Define filter rules for function-level error detection
|
||||
- _Note: Ask for implementation details when this step is reached_
|
||||
|
||||
## Consequences
|
||||
|
||||
**Positive**: Provides critical observability into the application's real-world behavior. Enables proactive identification and resolution of performance bottlenecks and errors. Improves overall application reliability and user experience.
|
||||
**Negative**: Introduces a new third-party dependency and potential subscription costs. Requires initial setup and configuration of the APM/error tracking agent.
|
||||
### Positive
|
||||
|
||||
- **Full observability**: Aggregated view of errors, trends, and performance
|
||||
- **Self-hosted**: No external SaaS dependencies or subscription costs
|
||||
- **SDK compatibility**: Leverages mature Sentry SDKs with excellent documentation
|
||||
- **AI integration**: MCP server enables Claude Code to query and analyze errors
|
||||
- **Unified architecture**: Same setup works in dev container and production
|
||||
- **Lightweight**: Bugsink runs in a single process, unlike full Sentry (16GB+ RAM)
|
||||
|
||||
### Negative
|
||||
|
||||
- **Additional services**: Bugsink and Logstash add complexity to the container
|
||||
- **PostgreSQL overhead**: Additional database for error tracking
|
||||
- **Initial setup**: Requires configuration of multiple components
|
||||
- **Logstash learning curve**: Pipeline configuration requires Logstash knowledge
|
||||
|
||||
## Alternatives Considered
|
||||
|
||||
1. **Full Sentry self-hosted**: Rejected due to complexity (Kafka, Redis, ClickHouse, 16GB+ RAM minimum)
|
||||
2. **GlitchTip**: Considered, but Bugsink is lighter weight and easier to deploy
|
||||
3. **Sentry SaaS**: Rejected due to self-hosted requirement
|
||||
4. **Custom error aggregation**: Rejected in favor of proven Sentry SDK ecosystem
|
||||
|
||||
## References
|
||||
|
||||
- [Bugsink Documentation](https://www.bugsink.com/docs/)
|
||||
- [Bugsink Docker Install](https://www.bugsink.com/docs/docker-install/)
|
||||
- [@sentry/node Documentation](https://docs.sentry.io/platforms/javascript/guides/node/)
|
||||
- [@sentry/react Documentation](https://docs.sentry.io/platforms/javascript/guides/react/)
|
||||
- [sentry-selfhosted-mcp](https://github.com/ddfourtwo/sentry-selfhosted-mcp)
|
||||
- [Logstash Reference](https://www.elastic.co/guide/en/logstash/current/index.html)
|
||||
|
||||
@@ -2,17 +2,265 @@
|
||||
|
||||
**Date**: 2025-12-12
|
||||
|
||||
**Status**: Proposed
|
||||
**Status**: Accepted
|
||||
|
||||
**Implemented**: 2026-01-11
|
||||
|
||||
## Context
|
||||
|
||||
As the API grows, it becomes increasingly difficult for frontend developers and other consumers to understand its endpoints, request formats, and response structures. There is no single source of truth for API documentation.
|
||||
|
||||
Key requirements:
|
||||
|
||||
1. **Developer Experience**: Developers need interactive documentation to explore and test API endpoints.
|
||||
2. **Code-Documentation Sync**: Documentation should stay in sync with the actual code to prevent drift.
|
||||
3. **Low Maintenance Overhead**: The documentation approach should be "fast and lite" - minimal additional work for developers.
|
||||
4. **Security**: Documentation should not expose sensitive information in production environments.
|
||||
|
||||
## Decision
|
||||
|
||||
We will adopt **OpenAPI (Swagger)** for API documentation. We will use tools (e.g., JSDoc annotations with `swagger-jsdoc`) to generate an `openapi.json` specification directly from the route handler source code. This specification will be served via a UI like Swagger UI for interactive exploration.
|
||||
We will adopt **OpenAPI 3.0 (Swagger)** for API documentation using the following approach:
|
||||
|
||||
1. **JSDoc Annotations**: Use `swagger-jsdoc` to generate OpenAPI specs from JSDoc comments in route files.
|
||||
2. **Swagger UI**: Use `swagger-ui-express` to serve interactive documentation at `/docs/api-docs`.
|
||||
3. **Environment Restriction**: Only expose the Swagger UI in development and test environments, not production.
|
||||
4. **Incremental Adoption**: Start with key public routes and progressively add annotations to all endpoints.
|
||||
|
||||
### Tooling Selection
|
||||
|
||||
| Tool | Purpose |
|
||||
| -------------------- | ---------------------------------------------- |
|
||||
| `swagger-jsdoc` | Generates OpenAPI 3.0 spec from JSDoc comments |
|
||||
| `swagger-ui-express` | Serves interactive Swagger UI |
|
||||
|
||||
**Why JSDoc over separate schema files?**
|
||||
|
||||
- Documentation lives with the code, reducing drift
|
||||
- No separate files to maintain
|
||||
- Developers see documentation when editing routes
|
||||
- Lower learning curve for the team
|
||||
|
||||
## Implementation Details
|
||||
|
||||
### OpenAPI Configuration
|
||||
|
||||
Located in `src/config/swagger.ts`:
|
||||
|
||||
```typescript
|
||||
import swaggerJsdoc from 'swagger-jsdoc';
|
||||
|
||||
const options: swaggerJsdoc.Options = {
|
||||
definition: {
|
||||
openapi: '3.0.0',
|
||||
info: {
|
||||
title: 'Flyer Crawler API',
|
||||
version: '1.0.0',
|
||||
description: 'API for the Flyer Crawler application',
|
||||
contact: {
|
||||
name: 'API Support',
|
||||
},
|
||||
},
|
||||
servers: [
|
||||
{
|
||||
url: '/api',
|
||||
description: 'API server',
|
||||
},
|
||||
],
|
||||
components: {
|
||||
securitySchemes: {
|
||||
bearerAuth: {
|
||||
type: 'http',
|
||||
scheme: 'bearer',
|
||||
bearerFormat: 'JWT',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
apis: ['./src/routes/*.ts'],
|
||||
};
|
||||
|
||||
export const swaggerSpec = swaggerJsdoc(options);
|
||||
```
|
||||
|
||||
### JSDoc Annotation Pattern
|
||||
|
||||
Each route handler should include OpenAPI annotations using the `@openapi` tag:
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* @openapi
|
||||
* /health/ping:
|
||||
* get:
|
||||
* summary: Simple ping endpoint
|
||||
* description: Returns a pong response to verify server is responsive
|
||||
* tags:
|
||||
* - Health
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Server is responsive
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* data:
|
||||
* type: object
|
||||
* properties:
|
||||
* message:
|
||||
* type: string
|
||||
* example: pong
|
||||
*/
|
||||
router.get('/ping', validateRequest(emptySchema), (_req: Request, res: Response) => {
|
||||
return sendSuccess(res, { message: 'pong' });
|
||||
});
|
||||
```
|
||||
|
||||
### Route Documentation Priority
|
||||
|
||||
Document routes in this order of priority:
|
||||
|
||||
1. **Health Routes** - `/api/health/*` (public, critical for operations)
|
||||
2. **Auth Routes** - `/api/auth/*` (public, essential for integration)
|
||||
3. **Gamification Routes** - `/api/achievements/*` (simple, good example)
|
||||
4. **Flyer Routes** - `/api/flyers/*` (core functionality)
|
||||
5. **User Routes** - `/api/users/*` (common CRUD patterns)
|
||||
6. **Remaining Routes** - Budget, Recipe, Admin, etc.
|
||||
|
||||
### Swagger UI Setup
|
||||
|
||||
In `server.ts`, add the Swagger UI middleware (development/test only):
|
||||
|
||||
```typescript
|
||||
import swaggerUi from 'swagger-ui-express';
|
||||
import { swaggerSpec } from './src/config/swagger';
|
||||
|
||||
// Only serve Swagger UI in non-production environments
|
||||
if (process.env.NODE_ENV !== 'production') {
|
||||
app.use('/docs/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));
|
||||
|
||||
// Optionally expose raw JSON spec for tooling
|
||||
app.get('/docs/api-docs.json', (_req, res) => {
|
||||
res.setHeader('Content-Type', 'application/json');
|
||||
res.send(swaggerSpec);
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
### Response Schema Standardization
|
||||
|
||||
All API responses follow the standardized format from [ADR-028](./0028-api-response-standardization.md):
|
||||
|
||||
```typescript
|
||||
// Success response
|
||||
{
|
||||
"success": true,
|
||||
"data": { ... }
|
||||
}
|
||||
|
||||
// Error response
|
||||
{
|
||||
"success": false,
|
||||
"error": {
|
||||
"code": "ERROR_CODE",
|
||||
"message": "Human-readable message"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Define reusable schema components for these patterns:
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* @openapi
|
||||
* components:
|
||||
* schemas:
|
||||
* SuccessResponse:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* data:
|
||||
* type: object
|
||||
* ErrorResponse:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: false
|
||||
* error:
|
||||
* type: object
|
||||
* properties:
|
||||
* code:
|
||||
* type: string
|
||||
* message:
|
||||
* type: string
|
||||
*/
|
||||
```
|
||||
|
||||
### Security Considerations
|
||||
|
||||
1. **Production Disabled**: Swagger UI is not available in production to prevent information disclosure.
|
||||
2. **No Sensitive Data**: Never include actual secrets, tokens, or PII in example values.
|
||||
3. **Authentication Documented**: Clearly document which endpoints require authentication.
|
||||
|
||||
## API Route Tags
|
||||
|
||||
Organize endpoints using consistent tags:
|
||||
|
||||
| Tag | Description | Routes |
|
||||
| ------------ | ---------------------------------- | --------------------- |
|
||||
| Health | Server health and readiness checks | `/api/health/*` |
|
||||
| Auth | Authentication and authorization | `/api/auth/*` |
|
||||
| Users | User profile management | `/api/users/*` |
|
||||
| Flyers | Flyer uploads and retrieval | `/api/flyers/*` |
|
||||
| Achievements | Gamification and leaderboards | `/api/achievements/*` |
|
||||
| Budgets | Budget tracking | `/api/budgets/*` |
|
||||
| Recipes | Recipe management | `/api/recipes/*` |
|
||||
| Admin | Administrative operations | `/api/admin/*` |
|
||||
| System | System status and monitoring | `/api/system/*` |
|
||||
|
||||
## Testing
|
||||
|
||||
Verify API documentation is correct by:
|
||||
|
||||
1. **Manual Review**: Navigate to `/docs/api-docs` and test each endpoint.
|
||||
2. **Spec Validation**: Use OpenAPI validators to check the generated spec.
|
||||
3. **Integration Tests**: Existing integration tests serve as implicit documentation verification.
|
||||
|
||||
## Consequences
|
||||
|
||||
- **Positive**: Creates a single source of truth for API documentation that stays in sync with the code. Enables auto-generation of client SDKs and simplifies testing.
|
||||
- **Negative**: Requires developers to maintain JSDoc annotations on all routes. Adds a build step and new dependencies to the project.
|
||||
### Positive
|
||||
|
||||
- **Single Source of Truth**: Documentation lives with the code and stays in sync.
|
||||
- **Interactive Exploration**: Developers can try endpoints directly from the UI.
|
||||
- **SDK Generation**: OpenAPI spec enables automatic client SDK generation.
|
||||
- **Onboarding**: New developers can quickly understand the API surface.
|
||||
- **Low Overhead**: JSDoc annotations are minimal additions to existing code.
|
||||
|
||||
### Negative
|
||||
|
||||
- **Maintenance Required**: Developers must update annotations when routes change.
|
||||
- **Build Dependency**: Adds `swagger-jsdoc` and `swagger-ui-express` packages.
|
||||
- **Initial Investment**: Existing routes need annotations added incrementally.
|
||||
|
||||
### Mitigation
|
||||
|
||||
- Include documentation checks in code review process.
|
||||
- Start with high-priority routes and expand coverage over time.
|
||||
- Use TypeScript types to reduce documentation duplication where possible.
|
||||
|
||||
## Key Files
|
||||
|
||||
- `src/config/swagger.ts` - OpenAPI configuration
|
||||
- `src/routes/*.ts` - Route files with JSDoc annotations
|
||||
- `server.ts` - Swagger UI middleware setup
|
||||
|
||||
## Related ADRs
|
||||
|
||||
- [ADR-003](./0003-standardized-input-validation-using-middleware.md) - Input Validation (Zod schemas)
|
||||
- [ADR-028](./0028-api-response-standardization.md) - Response Standardization
|
||||
- [ADR-016](./0016-api-security-hardening.md) - Security Hardening
|
||||
|
||||
299
docs/adr/0049-gamification-and-achievement-system.md
Normal file
299
docs/adr/0049-gamification-and-achievement-system.md
Normal file
@@ -0,0 +1,299 @@
|
||||
# ADR-049: Gamification and Achievement System
|
||||
|
||||
**Date**: 2026-01-11
|
||||
|
||||
**Status**: Accepted
|
||||
|
||||
**Implemented**: 2026-01-11
|
||||
|
||||
## Context
|
||||
|
||||
The application implements a gamification system to encourage user engagement through achievements and points. Users earn achievements for completing specific actions within the platform, and these achievements contribute to a points-based leaderboard.
|
||||
|
||||
Key requirements:
|
||||
|
||||
1. **User Engagement**: Reward users for meaningful actions (uploads, recipes, sharing).
|
||||
2. **Progress Tracking**: Show users their accomplishments and progress.
|
||||
3. **Social Competition**: Leaderboard to compare users by points.
|
||||
4. **Idempotent Awards**: Achievements should only be awarded once per user.
|
||||
5. **Transactional Safety**: Achievement awards must be atomic with the triggering action.
|
||||
|
||||
## Decision
|
||||
|
||||
We will implement a database-driven gamification system with:
|
||||
|
||||
1. **Database Functions**: Core logic in PostgreSQL for atomicity and idempotency.
|
||||
2. **Database Triggers**: Automatic achievement awards on specific events.
|
||||
3. **Application-Level Awards**: Explicit calls from service layer when triggers aren't suitable.
|
||||
4. **Points Aggregation**: Stored in user profile for efficient leaderboard queries.
|
||||
|
||||
### Design Principles
|
||||
|
||||
- **Single Award**: Each achievement can only be earned once per user (enforced by unique constraint).
|
||||
- **Atomic Operations**: Achievement awards happen within the same transaction as the triggering action.
|
||||
- **Silent Failure**: If an achievement doesn't exist, the award function returns silently (no error).
|
||||
- **Points Sync**: Points are updated on the profile immediately when an achievement is awarded.
|
||||
|
||||
## Implementation Details
|
||||
|
||||
### Database Schema
|
||||
|
||||
```sql
|
||||
-- Achievements master table
|
||||
CREATE TABLE public.achievements (
|
||||
achievement_id BIGSERIAL PRIMARY KEY,
|
||||
name TEXT UNIQUE NOT NULL,
|
||||
description TEXT NOT NULL,
|
||||
icon TEXT NOT NULL,
|
||||
points_value INTEGER NOT NULL DEFAULT 0,
|
||||
created_at TIMESTAMPTZ DEFAULT NOW()
|
||||
);
|
||||
|
||||
-- User achievements (junction table)
|
||||
CREATE TABLE public.user_achievements (
|
||||
user_id UUID REFERENCES public.users(user_id) ON DELETE CASCADE,
|
||||
achievement_id BIGINT REFERENCES public.achievements(achievement_id) ON DELETE CASCADE,
|
||||
achieved_at TIMESTAMPTZ DEFAULT NOW(),
|
||||
PRIMARY KEY (user_id, achievement_id)
|
||||
);
|
||||
|
||||
-- Points stored on profile for efficient leaderboard
|
||||
ALTER TABLE public.profiles ADD COLUMN points INTEGER DEFAULT 0;
|
||||
```
|
||||
|
||||
### Award Achievement Function
|
||||
|
||||
Located in `sql/Initial_triggers_and_functions.sql`:
|
||||
|
||||
```sql
|
||||
CREATE OR REPLACE FUNCTION public.award_achievement(p_user_id UUID, p_achievement_name TEXT)
|
||||
RETURNS void
|
||||
LANGUAGE plpgsql
|
||||
SECURITY DEFINER
|
||||
AS $$
|
||||
DECLARE
|
||||
v_achievement_id BIGINT;
|
||||
v_points_value INTEGER;
|
||||
BEGIN
|
||||
-- Find the achievement by name to get its ID and point value.
|
||||
SELECT achievement_id, points_value INTO v_achievement_id, v_points_value
|
||||
FROM public.achievements WHERE name = p_achievement_name;
|
||||
|
||||
-- If the achievement doesn't exist, do nothing.
|
||||
IF v_achievement_id IS NULL THEN
|
||||
RETURN;
|
||||
END IF;
|
||||
|
||||
-- Insert the achievement for the user.
|
||||
-- ON CONFLICT DO NOTHING ensures idempotency.
|
||||
INSERT INTO public.user_achievements (user_id, achievement_id)
|
||||
VALUES (p_user_id, v_achievement_id)
|
||||
ON CONFLICT (user_id, achievement_id) DO NOTHING;
|
||||
|
||||
-- If the insert was successful (user didn't have it), update their points.
|
||||
IF FOUND THEN
|
||||
UPDATE public.profiles SET points = points + v_points_value WHERE user_id = p_user_id;
|
||||
END IF;
|
||||
END;
|
||||
$$;
|
||||
```
|
||||
|
||||
### Current Achievements
|
||||
|
||||
| Name | Description | Icon | Points |
|
||||
| -------------------- | ----------------------------------------------------------- | ------------ | ------ |
|
||||
| Welcome Aboard | Join the community by creating your account. | user-check | 5 |
|
||||
| First Recipe | Create your very first recipe. | chef-hat | 10 |
|
||||
| Recipe Sharer | Share a recipe with another user for the first time. | share-2 | 15 |
|
||||
| List Sharer | Share a shopping list with another user for the first time. | list | 20 |
|
||||
| First Favorite | Mark a recipe as one of your favorites. | heart | 5 |
|
||||
| First Fork | Make a personal copy of a public recipe. | git-fork | 10 |
|
||||
| First Budget Created | Create your first budget to track spending. | piggy-bank | 15 |
|
||||
| First-Upload | Upload your first flyer. | upload-cloud | 25 |
|
||||
|
||||
### Achievement Triggers
|
||||
|
||||
#### User Registration (Database Trigger)
|
||||
|
||||
Awards "Welcome Aboard" when a new user is created:
|
||||
|
||||
```sql
|
||||
-- In handle_new_user() function
|
||||
PERFORM public.award_achievement(new.user_id, 'Welcome Aboard');
|
||||
```
|
||||
|
||||
#### Flyer Upload (Database Trigger + Application Code)
|
||||
|
||||
Awards "First-Upload" when a flyer is inserted with an `uploaded_by` value:
|
||||
|
||||
```sql
|
||||
-- In log_new_flyer() trigger function
|
||||
IF NEW.uploaded_by IS NOT NULL THEN
|
||||
PERFORM public.award_achievement(NEW.uploaded_by, 'First-Upload');
|
||||
END IF;
|
||||
```
|
||||
|
||||
Additionally, the `FlyerPersistenceService.saveFlyer()` method explicitly awards the achievement within the transaction:
|
||||
|
||||
```typescript
|
||||
// In src/services/flyerPersistenceService.server.ts
|
||||
if (userId) {
|
||||
const gamificationRepo = new GamificationRepository(client);
|
||||
await gamificationRepo.awardAchievement(userId, 'First-Upload', logger);
|
||||
}
|
||||
```
|
||||
|
||||
### Repository Layer
|
||||
|
||||
Located in `src/services/db/gamification.db.ts`:
|
||||
|
||||
```typescript
|
||||
export class GamificationRepository {
|
||||
private db: Pick<Pool | PoolClient, 'query'>;
|
||||
|
||||
constructor(db: Pick<Pool | PoolClient, 'query'> = getPool()) {
|
||||
this.db = db;
|
||||
}
|
||||
|
||||
async getUserAchievements(
|
||||
userId: string,
|
||||
logger: Logger,
|
||||
): Promise<(UserAchievement & Achievement)[]> {
|
||||
const query = `
|
||||
SELECT ua.user_id, ua.achievement_id, ua.achieved_at,
|
||||
a.name, a.description, a.icon, a.points_value, a.created_at
|
||||
FROM public.user_achievements ua
|
||||
JOIN public.achievements a ON ua.achievement_id = a.achievement_id
|
||||
WHERE ua.user_id = $1
|
||||
ORDER BY ua.achieved_at DESC;
|
||||
`;
|
||||
const res = await this.db.query(query, [userId]);
|
||||
return res.rows;
|
||||
}
|
||||
|
||||
async awardAchievement(userId: string, achievementName: string, logger: Logger): Promise<void> {
|
||||
await this.db.query('SELECT public.award_achievement($1, $2)', [userId, achievementName]);
|
||||
}
|
||||
|
||||
async getLeaderboard(limit: number, logger: Logger): Promise<LeaderboardUser[]> {
|
||||
const query = `
|
||||
SELECT user_id, full_name, avatar_url, points,
|
||||
RANK() OVER (ORDER BY points DESC) as rank
|
||||
FROM public.profiles
|
||||
ORDER BY points DESC, full_name ASC
|
||||
LIMIT $1;
|
||||
`;
|
||||
const res = await this.db.query(query, [limit]);
|
||||
return res.rows;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### API Endpoints
|
||||
|
||||
| Method | Endpoint | Description |
|
||||
| ------ | ------------------------------- | ------------------------------- |
|
||||
| GET | `/api/achievements` | List all available achievements |
|
||||
| GET | `/api/achievements/me` | Get current user's achievements |
|
||||
| GET | `/api/achievements/leaderboard` | Get top users by points |
|
||||
|
||||
## Testing Considerations
|
||||
|
||||
### Critical Testing Requirements
|
||||
|
||||
When testing gamification features, be aware of the following:
|
||||
|
||||
1. **Database Seed Data**: Achievement definitions must exist in the database before tests run. The `award_achievement()` function silently returns if the achievement name doesn't exist.
|
||||
|
||||
2. **Transactional Context**: When awarding achievements from within a transaction:
|
||||
- The achievement is visible within the transaction immediately
|
||||
- External queries won't see the achievement until the transaction commits
|
||||
- Tests should wait for job completion before asserting achievement state
|
||||
|
||||
3. **Vitest Global Setup Context**: The integration test global setup runs in a separate Node.js context. Achievement verification must use direct database queries, not mocked services.
|
||||
|
||||
4. **Achievement Idempotency**: Calling `award_achievement()` multiple times for the same user/achievement combination is safe and expected. Only the first call actually inserts.
|
||||
|
||||
### Example Integration Test Pattern
|
||||
|
||||
```typescript
|
||||
it('should award the "First Upload" achievement after flyer processing', async () => {
|
||||
// 1. Create user (awards "Welcome Aboard" via database trigger)
|
||||
const { user: testUser, token } = await createAndLoginUser({...});
|
||||
|
||||
// 2. Upload flyer (triggers async job)
|
||||
const uploadResponse = await request
|
||||
.post('/api/flyers/upload')
|
||||
.set('Authorization', `Bearer ${token}`)
|
||||
.attach('flyerFile', testImagePath);
|
||||
expect(uploadResponse.status).toBe(202);
|
||||
|
||||
// 3. Wait for job to complete
|
||||
await poll(async () => {
|
||||
const status = await request.get(`/api/flyers/job/${jobId}/status`);
|
||||
return status.body.data.status === 'completed';
|
||||
}, { timeout: 15000 });
|
||||
|
||||
// 4. Wait for achievements to be visible (transaction committed)
|
||||
await vi.waitUntil(async () => {
|
||||
const achievements = await db.gamificationRepo.getUserAchievements(
|
||||
testUser.user.user_id,
|
||||
logger
|
||||
);
|
||||
return achievements.length >= 2; // Welcome Aboard + First-Upload
|
||||
}, { timeout: 15000, interval: 500 });
|
||||
|
||||
// 5. Assert specific achievements
|
||||
const userAchievements = await db.gamificationRepo.getUserAchievements(
|
||||
testUser.user.user_id,
|
||||
logger
|
||||
);
|
||||
expect(userAchievements.find(a => a.name === 'Welcome Aboard')).toBeDefined();
|
||||
expect(userAchievements.find(a => a.name === 'First-Upload')).toBeDefined();
|
||||
});
|
||||
```
|
||||
|
||||
### Common Test Pitfalls
|
||||
|
||||
1. **Missing Seed Data**: If tests fail with "achievement not found", ensure the test database has the achievements table populated.
|
||||
|
||||
2. **Race Conditions**: Achievement awards in async jobs may not be visible immediately. Always poll or use `vi.waitUntil()`.
|
||||
|
||||
3. **Wrong User ID**: Verify the user ID passed to `awardAchievement()` matches the user created in the test.
|
||||
|
||||
4. **Transaction Isolation**: When querying within a test, use the same database connection if checking mid-transaction state.
|
||||
|
||||
## Consequences
|
||||
|
||||
### Positive
|
||||
|
||||
- **Engagement**: Users have clear goals and rewards for platform activity.
|
||||
- **Scalability**: Points stored on profile enable O(1) leaderboard sorting.
|
||||
- **Reliability**: Database-level idempotency prevents duplicate awards.
|
||||
- **Flexibility**: New achievements can be added via SQL without code changes.
|
||||
|
||||
### Negative
|
||||
|
||||
- **Complexity**: Multiple award paths (triggers + application code) require careful coordination.
|
||||
- **Testing**: Async nature of some awards complicates integration testing.
|
||||
- **Coupling**: Achievement names are strings; typos fail silently.
|
||||
|
||||
### Mitigation
|
||||
|
||||
- Use constants for achievement names in application code.
|
||||
- Document all award trigger points clearly.
|
||||
- Test each achievement path independently.
|
||||
|
||||
## Key Files
|
||||
|
||||
- `sql/initial_data.sql` - Achievement definitions (seed data)
|
||||
- `sql/Initial_triggers_and_functions.sql` - `award_achievement()` function and triggers
|
||||
- `src/services/db/gamification.db.ts` - Repository layer
|
||||
- `src/routes/achievements.routes.ts` - API endpoints
|
||||
- `src/services/flyerPersistenceService.server.ts` - First-Upload award (application code)
|
||||
|
||||
## Related ADRs
|
||||
|
||||
- [ADR-002](./0002-standardized-transaction-management.md) - Transaction Management
|
||||
- [ADR-034](./0034-repository-pattern-standards.md) - Repository Pattern
|
||||
- [ADR-006](./0006-background-job-processing-and-task-queues.md) - Background Jobs (flyer processing)
|
||||
341
docs/adr/0050-postgresql-function-observability.md
Normal file
341
docs/adr/0050-postgresql-function-observability.md
Normal file
@@ -0,0 +1,341 @@
|
||||
# ADR-050: PostgreSQL Function Observability
|
||||
|
||||
**Date**: 2026-01-11
|
||||
|
||||
**Status**: Proposed
|
||||
|
||||
**Related**: [ADR-015](0015-application-performance-monitoring-and-error-tracking.md), [ADR-004](0004-standardized-application-wide-structured-logging.md)
|
||||
|
||||
## Context
|
||||
|
||||
The application uses 30+ PostgreSQL functions and 11+ triggers for business logic, including:
|
||||
|
||||
- Recipe recommendations and search
|
||||
- Shopping list generation from menu plans
|
||||
- Price history tracking
|
||||
- Achievement awards
|
||||
- Activity logging
|
||||
- User profile creation
|
||||
|
||||
**Current Problem**: These database functions can fail silently in several ways:
|
||||
|
||||
1. **`ON CONFLICT DO NOTHING`** - Swallows constraint violations without notification
|
||||
2. **`IF NOT FOUND THEN RETURN;`** - Silently exits when data is missing
|
||||
3. **Trigger functions returning `NULL`** - No indication of partial failures
|
||||
4. **No logging inside functions** - No visibility into function execution
|
||||
|
||||
When these silent failures occur:
|
||||
|
||||
- The application layer receives no error (function "succeeds" but does nothing)
|
||||
- No logs are generated for debugging
|
||||
- Issues are only discovered when users report missing data
|
||||
- Root cause analysis is extremely difficult
|
||||
|
||||
**Example of Silent Failure**:
|
||||
|
||||
```sql
|
||||
-- This function silently does nothing if achievement doesn't exist
|
||||
CREATE OR REPLACE FUNCTION public.award_achievement(p_user_id UUID, p_achievement_name TEXT)
|
||||
RETURNS void AS $$
|
||||
BEGIN
|
||||
SELECT achievement_id INTO v_achievement_id FROM achievements WHERE name = p_achievement_name;
|
||||
IF v_achievement_id IS NULL THEN
|
||||
RETURN; -- Silent failure - no log, no error
|
||||
END IF;
|
||||
-- ...
|
||||
END;
|
||||
$$;
|
||||
```
|
||||
|
||||
ADR-015 established Logstash + Bugsink for error tracking, with PostgreSQL log integration marked as "future". This ADR defines the implementation.
|
||||
|
||||
## Decision
|
||||
|
||||
We will implement a standardized PostgreSQL function observability strategy with three tiers of logging severity:
|
||||
|
||||
### 1. Function Logging Helper
|
||||
|
||||
Create a reusable logging function that outputs structured JSON to PostgreSQL logs:
|
||||
|
||||
```sql
|
||||
-- Function to emit structured log messages from PL/pgSQL
|
||||
CREATE OR REPLACE FUNCTION public.fn_log(
|
||||
p_level TEXT, -- 'DEBUG', 'INFO', 'NOTICE', 'WARNING', 'ERROR'
|
||||
p_function_name TEXT, -- The calling function name
|
||||
p_message TEXT, -- Human-readable message
|
||||
p_context JSONB DEFAULT NULL -- Additional context (user_id, params, etc.)
|
||||
)
|
||||
RETURNS void
|
||||
LANGUAGE plpgsql
|
||||
AS $$
|
||||
DECLARE
|
||||
log_line TEXT;
|
||||
BEGIN
|
||||
-- Build structured JSON log line
|
||||
log_line := jsonb_build_object(
|
||||
'timestamp', now(),
|
||||
'level', p_level,
|
||||
'source', 'postgresql',
|
||||
'function', p_function_name,
|
||||
'message', p_message,
|
||||
'context', COALESCE(p_context, '{}'::jsonb)
|
||||
)::text;
|
||||
|
||||
-- Use appropriate RAISE level
|
||||
CASE p_level
|
||||
WHEN 'DEBUG' THEN RAISE DEBUG '%', log_line;
|
||||
WHEN 'INFO' THEN RAISE INFO '%', log_line;
|
||||
WHEN 'NOTICE' THEN RAISE NOTICE '%', log_line;
|
||||
WHEN 'WARNING' THEN RAISE WARNING '%', log_line;
|
||||
WHEN 'ERROR' THEN RAISE LOG '%', log_line; -- Use LOG for errors to ensure capture
|
||||
ELSE RAISE NOTICE '%', log_line;
|
||||
END CASE;
|
||||
END;
|
||||
$$;
|
||||
```
|
||||
|
||||
### 2. Logging Tiers
|
||||
|
||||
#### Tier 1: Critical Functions (Always Log)
|
||||
|
||||
Functions where silent failure causes data corruption or user-facing issues:
|
||||
|
||||
| Function | Log Events |
|
||||
| ---------------------------------- | --------------------------------------- |
|
||||
| `handle_new_user()` | User creation, profile creation, errors |
|
||||
| `award_achievement()` | Achievement not found, already awarded |
|
||||
| `approve_correction()` | Correction not found, permission denied |
|
||||
| `complete_shopping_list()` | List not found, permission denied |
|
||||
| `add_menu_plan_to_shopping_list()` | Permission denied, items added |
|
||||
| `fork_recipe()` | Original not found, fork created |
|
||||
|
||||
**Pattern**:
|
||||
|
||||
```sql
|
||||
CREATE OR REPLACE FUNCTION public.award_achievement(p_user_id UUID, p_achievement_name TEXT)
|
||||
RETURNS void AS $$
|
||||
DECLARE
|
||||
v_achievement_id BIGINT;
|
||||
v_points_value INTEGER;
|
||||
v_context JSONB;
|
||||
BEGIN
|
||||
v_context := jsonb_build_object('user_id', p_user_id, 'achievement_name', p_achievement_name);
|
||||
|
||||
SELECT achievement_id, points_value INTO v_achievement_id, v_points_value
|
||||
FROM public.achievements WHERE name = p_achievement_name;
|
||||
|
||||
IF v_achievement_id IS NULL THEN
|
||||
-- Log the issue instead of silent return
|
||||
PERFORM fn_log('WARNING', 'award_achievement',
|
||||
'Achievement not found: ' || p_achievement_name, v_context);
|
||||
RETURN;
|
||||
END IF;
|
||||
|
||||
INSERT INTO public.user_achievements (user_id, achievement_id)
|
||||
VALUES (p_user_id, v_achievement_id)
|
||||
ON CONFLICT (user_id, achievement_id) DO NOTHING;
|
||||
|
||||
IF FOUND THEN
|
||||
UPDATE public.profiles SET points = points + v_points_value WHERE user_id = p_user_id;
|
||||
PERFORM fn_log('INFO', 'award_achievement',
|
||||
'Achievement awarded: ' || p_achievement_name, v_context);
|
||||
END IF;
|
||||
END;
|
||||
$$;
|
||||
```
|
||||
|
||||
#### Tier 2: Business Logic Functions (Log on Anomalies)
|
||||
|
||||
Functions where unexpected conditions should be logged but aren't critical:
|
||||
|
||||
| Function | Log Events |
|
||||
| -------------------------------------- | ---------------------------------- |
|
||||
| `suggest_master_item_for_flyer_item()` | No match found (below threshold) |
|
||||
| `recommend_recipes_for_user()` | No recommendations generated |
|
||||
| `find_recipes_from_pantry()` | Empty pantry, no recipes found |
|
||||
| `get_best_sale_prices_for_user()` | No watched items, no current sales |
|
||||
|
||||
**Pattern**: Log when results are unexpectedly empty or inputs are invalid.
|
||||
|
||||
#### Tier 3: Triggers (Log Errors Only)
|
||||
|
||||
Triggers should be fast, so only log when something goes wrong:
|
||||
|
||||
| Trigger Function | Log Events |
|
||||
| --------------------------------------------- | ------------------------- |
|
||||
| `update_price_history_on_flyer_item_insert()` | Failed to update history |
|
||||
| `update_recipe_rating_aggregates()` | Rating calculation failed |
|
||||
| `log_new_recipe()` | Profile lookup failed |
|
||||
| `log_new_flyer()` | Store lookup failed |
|
||||
|
||||
### 3. PostgreSQL Configuration
|
||||
|
||||
Enable logging in `postgresql.conf`:
|
||||
|
||||
```ini
|
||||
# Log all function notices and above
|
||||
log_min_messages = notice
|
||||
|
||||
# Include function name in log prefix
|
||||
log_line_prefix = '%t [%p] %u@%d '
|
||||
|
||||
# Log to file for Logstash pickup
|
||||
logging_collector = on
|
||||
log_directory = '/var/log/postgresql'
|
||||
log_filename = 'postgresql-%Y-%m-%d.log'
|
||||
log_rotation_age = 1d
|
||||
log_rotation_size = 100MB
|
||||
|
||||
# Capture slow queries from functions
|
||||
log_min_duration_statement = 1000 # Log queries over 1 second
|
||||
```
|
||||
|
||||
### 4. Logstash Integration
|
||||
|
||||
Update the Logstash pipeline (extends ADR-015 configuration):
|
||||
|
||||
```conf
|
||||
# PostgreSQL function log input
|
||||
input {
|
||||
file {
|
||||
path => "/var/log/postgresql/*.log"
|
||||
type => "postgres"
|
||||
tags => ["postgres"]
|
||||
start_position => "beginning"
|
||||
sincedb_path => "/var/lib/logstash/sincedb_postgres"
|
||||
}
|
||||
}
|
||||
|
||||
filter {
|
||||
if [type] == "postgres" {
|
||||
# Extract timestamp and process ID from PostgreSQL log prefix
|
||||
grok {
|
||||
match => { "message" => "%{TIMESTAMP_ISO8601:pg_timestamp} \[%{POSINT:pg_pid}\] %{USER:pg_user}@%{WORD:pg_database} %{GREEDYDATA:pg_message}" }
|
||||
}
|
||||
|
||||
# Check if this is a structured JSON log from fn_log()
|
||||
if [pg_message] =~ /^\{.*"source":"postgresql".*\}$/ {
|
||||
json {
|
||||
source => "pg_message"
|
||||
target => "fn_log"
|
||||
}
|
||||
|
||||
# Mark as error if level is WARNING or ERROR
|
||||
if [fn_log][level] in ["WARNING", "ERROR"] {
|
||||
mutate { add_tag => ["error", "db_function"] }
|
||||
}
|
||||
}
|
||||
|
||||
# Also catch native PostgreSQL errors
|
||||
if [pg_message] =~ /^ERROR:/ or [pg_message] =~ /^FATAL:/ {
|
||||
mutate { add_tag => ["error", "postgres_native"] }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
output {
|
||||
if "error" in [tags] and "postgres" in [tags] {
|
||||
http {
|
||||
url => "http://localhost:8000/api/store/"
|
||||
http_method => "post"
|
||||
format => "json"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 5. Dual-File Update Requirement
|
||||
|
||||
**IMPORTANT**: All SQL function changes must be applied to BOTH files:
|
||||
|
||||
1. `sql/Initial_triggers_and_functions.sql` - Used for incremental updates
|
||||
2. `sql/master_schema_rollup.sql` - Used for fresh database setup
|
||||
|
||||
Both files must remain in sync for triggers and functions.
|
||||
|
||||
## Implementation Steps
|
||||
|
||||
1. **Create `fn_log()` helper function**:
|
||||
- Add to both `Initial_triggers_and_functions.sql` and `master_schema_rollup.sql`
|
||||
- Test with `SELECT fn_log('INFO', 'test', 'Test message', '{"key": "value"}'::jsonb);`
|
||||
|
||||
2. **Update Tier 1 critical functions** (highest priority):
|
||||
- `award_achievement()` - Log missing achievements, duplicate awards
|
||||
- `handle_new_user()` - Log user creation success/failure
|
||||
- `approve_correction()` - Log not found, permission denied
|
||||
- `complete_shopping_list()` - Log permission checks
|
||||
- `add_menu_plan_to_shopping_list()` - Log permission checks, items added
|
||||
- `fork_recipe()` - Log original not found
|
||||
|
||||
3. **Update Tier 2 business logic functions**:
|
||||
- Add anomaly logging to suggestion/recommendation functions
|
||||
- Log empty result sets with context
|
||||
|
||||
4. **Update Tier 3 trigger functions**:
|
||||
- Add error-only logging to critical triggers
|
||||
- Wrap complex trigger logic in exception handlers
|
||||
|
||||
5. **Configure PostgreSQL logging**:
|
||||
- Update `postgresql.conf` in dev container
|
||||
- Update production PostgreSQL configuration
|
||||
- Verify logs appear in expected location
|
||||
|
||||
6. **Update Logstash pipeline**:
|
||||
- Add PostgreSQL input to `bugsink.conf`
|
||||
- Add filter rules for structured JSON extraction
|
||||
- Test end-to-end: function log → Logstash → Bugsink
|
||||
|
||||
7. **Verify in Bugsink**:
|
||||
- Confirm database function errors appear as issues
|
||||
- Verify context (user_id, function name, params) is captured
|
||||
|
||||
## Consequences
|
||||
|
||||
### Positive
|
||||
|
||||
- **Visibility**: Silent failures become visible in error tracking
|
||||
- **Debugging**: Function execution context captured for root cause analysis
|
||||
- **Proactive detection**: Anomalies logged before users report issues
|
||||
- **Unified monitoring**: Database errors appear alongside application errors in Bugsink
|
||||
- **Structured logs**: JSON format enables filtering and aggregation
|
||||
|
||||
### Negative
|
||||
|
||||
- **Performance overhead**: Logging adds latency to function execution
|
||||
- **Log volume**: Tier 1/2 functions may generate significant log volume
|
||||
- **Maintenance**: Two SQL files must be kept in sync
|
||||
- **PostgreSQL configuration**: Requires access to `postgresql.conf`
|
||||
|
||||
### Mitigations
|
||||
|
||||
- **Performance**: Only log meaningful events, not every function call
|
||||
- **Log volume**: Use appropriate log levels; Logstash filters reduce noise
|
||||
- **Sync**: Add CI check to verify SQL files match for function definitions
|
||||
- **Configuration**: Document PostgreSQL settings in deployment runbook
|
||||
|
||||
## Examples
|
||||
|
||||
### Before (Silent Failure)
|
||||
|
||||
```sql
|
||||
-- User thinks achievement was awarded, but it silently failed
|
||||
SELECT award_achievement('user-uuid', 'Nonexistent Badge');
|
||||
-- Returns: void (no error, no log)
|
||||
-- Result: User never gets achievement, nobody knows why
|
||||
```
|
||||
|
||||
### After (Observable Failure)
|
||||
|
||||
```sql
|
||||
SELECT award_achievement('user-uuid', 'Nonexistent Badge');
|
||||
-- Returns: void
|
||||
-- PostgreSQL log: {"timestamp":"2026-01-11T10:30:00Z","level":"WARNING","source":"postgresql","function":"award_achievement","message":"Achievement not found: Nonexistent Badge","context":{"user_id":"user-uuid","achievement_name":"Nonexistent Badge"}}
|
||||
-- Bugsink: New issue created with full context
|
||||
```
|
||||
|
||||
## References
|
||||
|
||||
- [ADR-015: Application Performance Monitoring](0015-application-performance-monitoring-and-error-tracking.md)
|
||||
- [ADR-004: Standardized Structured Logging](0004-standardized-application-wide-structured-logging.md)
|
||||
- [PostgreSQL RAISE Documentation](https://www.postgresql.org/docs/current/plpgsql-errors-and-messages.html)
|
||||
- [PostgreSQL Logging Configuration](https://www.postgresql.org/docs/current/runtime-config-logging.html)
|
||||
@@ -15,7 +15,7 @@ This document tracks the implementation status and estimated effort for all Arch
|
||||
|
||||
| Status | Count |
|
||||
| ---------------------------- | ----- |
|
||||
| Accepted (Fully Implemented) | 28 |
|
||||
| Accepted (Fully Implemented) | 30 |
|
||||
| Partially Implemented | 2 |
|
||||
| Proposed (Not Started) | 16 |
|
||||
|
||||
@@ -48,7 +48,7 @@ This document tracks the implementation status and estimated effort for all Arch
|
||||
| ------------------------------------------------------------------- | ------------------------ | ----------- | ------ | ------------------------------------- |
|
||||
| [ADR-003](./0003-standardized-input-validation-using-middleware.md) | Input Validation | Accepted | - | Fully implemented |
|
||||
| [ADR-008](./0008-api-versioning-strategy.md) | API Versioning | Proposed | L | Major URL/routing changes |
|
||||
| [ADR-018](./0018-api-documentation-strategy.md) | API Documentation | Proposed | M | OpenAPI/Swagger setup |
|
||||
| [ADR-018](./0018-api-documentation-strategy.md) | API Documentation | Accepted | - | OpenAPI/Swagger implemented |
|
||||
| [ADR-022](./0022-real-time-notification-system.md) | Real-time Notifications | Proposed | XL | WebSocket infrastructure |
|
||||
| [ADR-028](./0028-api-response-standardization.md) | Response Standardization | Implemented | L | Completed (routes, middleware, tests) |
|
||||
|
||||
@@ -65,10 +65,11 @@ This document tracks the implementation status and estimated effort for all Arch
|
||||
|
||||
### Category 5: Observability & Monitoring
|
||||
|
||||
| ADR | Title | Status | Effort | Notes |
|
||||
| -------------------------------------------------------------------------- | -------------------- | -------- | ------ | ----------------------- |
|
||||
| [ADR-004](./0004-standardized-application-wide-structured-logging.md) | Structured Logging | Accepted | - | Fully implemented |
|
||||
| [ADR-015](./0015-application-performance-monitoring-and-error-tracking.md) | APM & Error Tracking | Proposed | M | Third-party integration |
|
||||
| ADR | Title | Status | Effort | Notes |
|
||||
| -------------------------------------------------------------------------- | --------------------------- | -------- | ------ | --------------------------------- |
|
||||
| [ADR-004](./0004-standardized-application-wide-structured-logging.md) | Structured Logging | Accepted | - | Fully implemented |
|
||||
| [ADR-015](./0015-application-performance-monitoring-and-error-tracking.md) | APM & Error Tracking | Proposed | M | Third-party integration |
|
||||
| [ADR-050](./0050-postgresql-function-observability.md) | PostgreSQL Fn Observability | Proposed | M | Depends on ADR-015 implementation |
|
||||
|
||||
### Category 6: Deployment & Operations
|
||||
|
||||
@@ -113,6 +114,7 @@ This document tracks the implementation status and estimated effort for all Arch
|
||||
| [ADR-042](./0042-email-and-notification-architecture.md) | Email & Notifications | Accepted | - | Fully implemented |
|
||||
| [ADR-043](./0043-express-middleware-pipeline.md) | Middleware Pipeline | Accepted | - | Fully implemented |
|
||||
| [ADR-046](./0046-image-processing-pipeline.md) | Image Processing | Accepted | - | Fully implemented |
|
||||
| [ADR-049](./0049-gamification-and-achievement-system.md) | Gamification System | Accepted | - | Fully implemented |
|
||||
|
||||
---
|
||||
|
||||
@@ -120,35 +122,38 @@ This document tracks the implementation status and estimated effort for all Arch
|
||||
|
||||
These ADRs are proposed but not yet implemented, ordered by suggested implementation priority:
|
||||
|
||||
| Priority | ADR | Title | Effort | Rationale |
|
||||
| -------- | ------- | ------------------------ | ------ | ----------------------------------------------------- |
|
||||
| 1 | ADR-018 | API Documentation | M | Improves developer experience, enables SDK generation |
|
||||
| 2 | ADR-015 | APM & Error Tracking | M | Production visibility, debugging |
|
||||
| 3 | ADR-024 | Feature Flags | M | Safer deployments, A/B testing |
|
||||
| 4 | ADR-023 | Schema Migrations v2 | L | Database evolution support |
|
||||
| 5 | ADR-029 | Secret Rotation | L | Security improvement |
|
||||
| 6 | ADR-008 | API Versioning | L | Future API evolution |
|
||||
| 7 | ADR-030 | Circuit Breaker | L | Resilience improvement |
|
||||
| 8 | ADR-022 | Real-time Notifications | XL | Major feature enhancement |
|
||||
| 9 | ADR-011 | Authorization & RBAC | XL | Advanced permission system |
|
||||
| 10 | ADR-025 | i18n & l10n | XL | Multi-language support |
|
||||
| 11 | ADR-031 | Data Retention & Privacy | XL | Compliance requirements |
|
||||
| Priority | ADR | Title | Effort | Rationale |
|
||||
| -------- | ------- | --------------------------- | ------ | ------------------------------------------------- |
|
||||
| 1 | ADR-015 | APM & Error Tracking | M | Production visibility, debugging |
|
||||
| 1b | ADR-050 | PostgreSQL Fn Observability | M | Database function visibility (depends on ADR-015) |
|
||||
| 2 | ADR-024 | Feature Flags | M | Safer deployments, A/B testing |
|
||||
| 3 | ADR-023 | Schema Migrations v2 | L | Database evolution support |
|
||||
| 4 | ADR-029 | Secret Rotation | L | Security improvement |
|
||||
| 5 | ADR-008 | API Versioning | L | Future API evolution |
|
||||
| 6 | ADR-030 | Circuit Breaker | L | Resilience improvement |
|
||||
| 7 | ADR-022 | Real-time Notifications | XL | Major feature enhancement |
|
||||
| 8 | ADR-011 | Authorization & RBAC | XL | Advanced permission system |
|
||||
| 9 | ADR-025 | i18n & l10n | XL | Multi-language support |
|
||||
| 10 | ADR-031 | Data Retention & Privacy | XL | Compliance requirements |
|
||||
|
||||
---
|
||||
|
||||
## Recent Implementation History
|
||||
|
||||
| Date | ADR | Change |
|
||||
| ---------- | ------- | --------------------------------------------------------------------------------------------- |
|
||||
| 2026-01-09 | ADR-047 | Created - Documents target project file/folder organization with migration plan |
|
||||
| 2026-01-09 | ADR-041 | Created - Documents AI/Gemini integration with model fallback and rate limiting |
|
||||
| 2026-01-09 | ADR-042 | Created - Documents email and notification architecture with BullMQ queuing |
|
||||
| 2026-01-09 | ADR-043 | Created - Documents Express middleware pipeline ordering and patterns |
|
||||
| 2026-01-09 | ADR-044 | Created - Documents frontend feature-based folder organization |
|
||||
| 2026-01-09 | ADR-045 | Created - Documents test data factory pattern for mock generation |
|
||||
| 2026-01-09 | ADR-046 | Created - Documents image processing pipeline with Sharp and EXIF stripping |
|
||||
| 2026-01-09 | ADR-026 | Fully implemented - all client-side components, hooks, and services now use structured logger |
|
||||
| 2026-01-09 | ADR-028 | Fully implemented - all routes, middleware, and tests updated |
|
||||
| Date | ADR | Change |
|
||||
| ---------- | ------- | ---------------------------------------------------------------------- |
|
||||
| 2026-01-11 | ADR-050 | Created - PostgreSQL function observability with fn_log() and Logstash |
|
||||
| 2026-01-11 | ADR-018 | Implemented - OpenAPI/Swagger documentation at /docs/api-docs |
|
||||
| 2026-01-11 | ADR-049 | Created - Gamification system, achievements, and testing requirements |
|
||||
| 2026-01-09 | ADR-047 | Created - Project file/folder organization with migration plan |
|
||||
| 2026-01-09 | ADR-041 | Created - AI/Gemini integration with model fallback and rate limiting |
|
||||
| 2026-01-09 | ADR-042 | Created - Email and notification architecture with BullMQ queuing |
|
||||
| 2026-01-09 | ADR-043 | Created - Express middleware pipeline ordering and patterns |
|
||||
| 2026-01-09 | ADR-044 | Created - Frontend feature-based folder organization |
|
||||
| 2026-01-09 | ADR-045 | Created - Test data factory pattern for mock generation |
|
||||
| 2026-01-09 | ADR-046 | Created - Image processing pipeline with Sharp and EXIF stripping |
|
||||
| 2026-01-09 | ADR-026 | Fully implemented - client-side structured logger |
|
||||
| 2026-01-09 | ADR-028 | Fully implemented - all routes, middleware, and tests updated |
|
||||
|
||||
---
|
||||
|
||||
|
||||
284
package-lock.json
generated
284
package-lock.json
generated
@@ -45,6 +45,8 @@
|
||||
"react-router-dom": "^7.9.6",
|
||||
"recharts": "^3.4.1",
|
||||
"sharp": "^0.34.5",
|
||||
"swagger-jsdoc": "^6.2.8",
|
||||
"swagger-ui-express": "^5.0.1",
|
||||
"tsx": "^4.20.6",
|
||||
"zod": "^4.2.1",
|
||||
"zxcvbn": "^4.4.2"
|
||||
@@ -76,6 +78,8 @@
|
||||
"@types/react-dom": "^19.2.3",
|
||||
"@types/sharp": "^0.31.1",
|
||||
"@types/supertest": "^6.0.3",
|
||||
"@types/swagger-jsdoc": "^6.0.4",
|
||||
"@types/swagger-ui-express": "^4.1.8",
|
||||
"@types/zxcvbn": "^4.4.5",
|
||||
"@typescript-eslint/eslint-plugin": "^8.47.0",
|
||||
"@typescript-eslint/parser": "^8.47.0",
|
||||
@@ -139,6 +143,50 @@
|
||||
"url": "https://github.com/sponsors/sindresorhus"
|
||||
}
|
||||
},
|
||||
"node_modules/@apidevtools/json-schema-ref-parser": {
|
||||
"version": "9.1.2",
|
||||
"resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-9.1.2.tgz",
|
||||
"integrity": "sha512-r1w81DpR+KyRWd3f+rk6TNqMgedmAxZP5v5KWlXQWlgMUUtyEJch0DKEci1SorPMiSeM8XPl7MZ3miJ60JIpQg==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@jsdevtools/ono": "^7.1.3",
|
||||
"@types/json-schema": "^7.0.6",
|
||||
"call-me-maybe": "^1.0.1",
|
||||
"js-yaml": "^4.1.0"
|
||||
}
|
||||
},
|
||||
"node_modules/@apidevtools/openapi-schemas": {
|
||||
"version": "2.1.0",
|
||||
"resolved": "https://registry.npmjs.org/@apidevtools/openapi-schemas/-/openapi-schemas-2.1.0.tgz",
|
||||
"integrity": "sha512-Zc1AlqrJlX3SlpupFGpiLi2EbteyP7fXmUOGup6/DnkRgjP9bgMM/ag+n91rsv0U1Gpz0H3VILA/o3bW7Ua6BQ==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">=10"
|
||||
}
|
||||
},
|
||||
"node_modules/@apidevtools/swagger-methods": {
|
||||
"version": "3.0.2",
|
||||
"resolved": "https://registry.npmjs.org/@apidevtools/swagger-methods/-/swagger-methods-3.0.2.tgz",
|
||||
"integrity": "sha512-QAkD5kK2b1WfjDS/UQn/qQkbwF31uqRjPTrsCs5ZG9BQGAkjwvqGFjjPqAuzac/IYzpPtRzjCP1WrTuAIjMrXg==",
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/@apidevtools/swagger-parser": {
|
||||
"version": "10.0.3",
|
||||
"resolved": "https://registry.npmjs.org/@apidevtools/swagger-parser/-/swagger-parser-10.0.3.tgz",
|
||||
"integrity": "sha512-sNiLY51vZOmSPFZA5TF35KZ2HbgYklQnTSDnkghamzLb3EkNtcQnrBQEj5AOCxHpTtXpqMCRM1CrmV2rG6nw4g==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@apidevtools/json-schema-ref-parser": "^9.0.6",
|
||||
"@apidevtools/openapi-schemas": "^2.0.4",
|
||||
"@apidevtools/swagger-methods": "^3.0.2",
|
||||
"@jsdevtools/ono": "^7.1.3",
|
||||
"call-me-maybe": "^1.0.1",
|
||||
"z-schema": "^5.0.1"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"openapi-types": ">=7"
|
||||
}
|
||||
},
|
||||
"node_modules/@asamuzakjp/css-color": {
|
||||
"version": "4.1.1",
|
||||
"resolved": "https://registry.npmjs.org/@asamuzakjp/css-color/-/css-color-4.1.1.tgz",
|
||||
@@ -3052,6 +3100,12 @@
|
||||
"url": "https://opencollective.com/js-sdsl"
|
||||
}
|
||||
},
|
||||
"node_modules/@jsdevtools/ono": {
|
||||
"version": "7.1.3",
|
||||
"resolved": "https://registry.npmjs.org/@jsdevtools/ono/-/ono-7.1.3.tgz",
|
||||
"integrity": "sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg==",
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/@mapbox/node-pre-gyp": {
|
||||
"version": "1.0.11",
|
||||
"resolved": "https://registry.npmjs.org/@mapbox/node-pre-gyp/-/node-pre-gyp-1.0.11.tgz",
|
||||
@@ -3973,6 +4027,13 @@
|
||||
"win32"
|
||||
]
|
||||
},
|
||||
"node_modules/@scarf/scarf": {
|
||||
"version": "1.4.0",
|
||||
"resolved": "https://registry.npmjs.org/@scarf/scarf/-/scarf-1.4.0.tgz",
|
||||
"integrity": "sha512-xxeapPiUXdZAE3che6f3xogoJPeZgig6omHEy1rIY5WVsB3H2BHNnZH+gHG6x91SCWyQCzWGsuL2Hh3ClO5/qQ==",
|
||||
"hasInstallScript": true,
|
||||
"license": "Apache-2.0"
|
||||
},
|
||||
"node_modules/@smithy/abort-controller": {
|
||||
"version": "4.2.7",
|
||||
"resolved": "https://registry.npmjs.org/@smithy/abort-controller/-/abort-controller-4.2.7.tgz",
|
||||
@@ -5304,7 +5365,6 @@
|
||||
"version": "7.0.15",
|
||||
"resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz",
|
||||
"integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==",
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/@types/jsonwebtoken": {
|
||||
@@ -5617,6 +5677,24 @@
|
||||
"@types/superagent": "^8.1.0"
|
||||
}
|
||||
},
|
||||
"node_modules/@types/swagger-jsdoc": {
|
||||
"version": "6.0.4",
|
||||
"resolved": "https://registry.npmjs.org/@types/swagger-jsdoc/-/swagger-jsdoc-6.0.4.tgz",
|
||||
"integrity": "sha512-W+Xw5epcOZrF/AooUM/PccNMSAFOKWZA5dasNyMujTwsBkU74njSJBpvCCJhHAJ95XRMzQrrW844Btu0uoetwQ==",
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/@types/swagger-ui-express": {
|
||||
"version": "4.1.8",
|
||||
"resolved": "https://registry.npmjs.org/@types/swagger-ui-express/-/swagger-ui-express-4.1.8.tgz",
|
||||
"integrity": "sha512-AhZV8/EIreHFmBV5wAs0gzJUNq9JbbSXgJLQubCC0jtIo6prnI9MIRRxnU4MZX9RB9yXxF1V4R7jtLl/Wcj31g==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@types/express": "*",
|
||||
"@types/serve-static": "*"
|
||||
}
|
||||
},
|
||||
"node_modules/@types/use-sync-external-store": {
|
||||
"version": "0.0.6",
|
||||
"resolved": "https://registry.npmjs.org/@types/use-sync-external-store/-/use-sync-external-store-0.0.6.tgz",
|
||||
@@ -6354,7 +6432,6 @@
|
||||
"version": "2.0.1",
|
||||
"resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
|
||||
"integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==",
|
||||
"dev": true,
|
||||
"license": "Python-2.0"
|
||||
},
|
||||
"node_modules/aria-query": {
|
||||
@@ -7218,6 +7295,12 @@
|
||||
"url": "https://github.com/sponsors/ljharb"
|
||||
}
|
||||
},
|
||||
"node_modules/call-me-maybe": {
|
||||
"version": "1.0.2",
|
||||
"resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.2.tgz",
|
||||
"integrity": "sha512-HpX65o1Hnr9HH25ojC1YGs7HCQLq0GCOibSaWER0eNpgJ/Z1MZv2mTc7+xh6WOPxbRVcmgbv4hGU+uSQ/2xFZQ==",
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/callsites": {
|
||||
"version": "3.1.0",
|
||||
"resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz",
|
||||
@@ -9088,7 +9171,6 @@
|
||||
"version": "2.0.3",
|
||||
"resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz",
|
||||
"integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==",
|
||||
"dev": true,
|
||||
"license": "BSD-2-Clause",
|
||||
"engines": {
|
||||
"node": ">=0.10.0"
|
||||
@@ -11418,7 +11500,6 @@
|
||||
"version": "4.1.1",
|
||||
"resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.1.tgz",
|
||||
"integrity": "sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"argparse": "^2.0.1"
|
||||
@@ -12120,6 +12201,13 @@
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/lodash.get": {
|
||||
"version": "4.4.2",
|
||||
"resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz",
|
||||
"integrity": "sha512-z+Uw/vLuy6gQe8cfaFWD7p0wVv8fJl3mbzXh33RS+0oW2wvUqiRXiQ69gLWSLpgB5/6sU+r6BlQR0MBILadqTQ==",
|
||||
"deprecated": "This package is deprecated. Use the optional chaining (?.) operator instead.",
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/lodash.includes": {
|
||||
"version": "4.3.0",
|
||||
"resolved": "https://registry.npmjs.org/lodash.includes/-/lodash.includes-4.3.0.tgz",
|
||||
@@ -12138,6 +12226,13 @@
|
||||
"integrity": "sha512-Bz5mupy2SVbPHURB98VAcw+aHh4vRV5IPNhILUCsOzRmsTmSQ17jIuqopAentWoehktxGd9e/hbIXq980/1QJg==",
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/lodash.isequal": {
|
||||
"version": "4.5.0",
|
||||
"resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz",
|
||||
"integrity": "sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ==",
|
||||
"deprecated": "This package is deprecated. Use require('node:util').isDeepStrictEqual instead.",
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/lodash.isinteger": {
|
||||
"version": "4.0.4",
|
||||
"resolved": "https://registry.npmjs.org/lodash.isinteger/-/lodash.isinteger-4.0.4.tgz",
|
||||
@@ -12169,6 +12264,12 @@
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/lodash.mergewith": {
|
||||
"version": "4.6.2",
|
||||
"resolved": "https://registry.npmjs.org/lodash.mergewith/-/lodash.mergewith-4.6.2.tgz",
|
||||
"integrity": "sha512-GK3g5RPZWTRSeLSpgP8Xhra+pnjBC56q9FZYe1d5RN3TJ35dbkGy3YqBSMbyCrlbi+CM9Z3Jk5yTL7RCsqboyQ==",
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/lodash.once": {
|
||||
"version": "4.1.1",
|
||||
"resolved": "https://registry.npmjs.org/lodash.once/-/lodash.once-4.1.1.tgz",
|
||||
@@ -13450,6 +13551,13 @@
|
||||
"url": "https://github.com/sponsors/sindresorhus"
|
||||
}
|
||||
},
|
||||
"node_modules/openapi-types": {
|
||||
"version": "12.1.3",
|
||||
"resolved": "https://registry.npmjs.org/openapi-types/-/openapi-types-12.1.3.tgz",
|
||||
"integrity": "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw==",
|
||||
"license": "MIT",
|
||||
"peer": true
|
||||
},
|
||||
"node_modules/optionator": {
|
||||
"version": "0.9.4",
|
||||
"resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.4.tgz",
|
||||
@@ -16085,6 +16193,135 @@
|
||||
"url": "https://github.com/sponsors/ljharb"
|
||||
}
|
||||
},
|
||||
"node_modules/swagger-jsdoc": {
|
||||
"version": "6.2.8",
|
||||
"resolved": "https://registry.npmjs.org/swagger-jsdoc/-/swagger-jsdoc-6.2.8.tgz",
|
||||
"integrity": "sha512-VPvil1+JRpmJ55CgAtn8DIcpBs0bL5L3q5bVQvF4tAW/k/9JYSj7dCpaYCAv5rufe0vcCbBRQXGvzpkWjvLklQ==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"commander": "6.2.0",
|
||||
"doctrine": "3.0.0",
|
||||
"glob": "7.1.6",
|
||||
"lodash.mergewith": "^4.6.2",
|
||||
"swagger-parser": "^10.0.3",
|
||||
"yaml": "2.0.0-1"
|
||||
},
|
||||
"bin": {
|
||||
"swagger-jsdoc": "bin/swagger-jsdoc.js"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=12.0.0"
|
||||
}
|
||||
},
|
||||
"node_modules/swagger-jsdoc/node_modules/brace-expansion": {
|
||||
"version": "1.1.12",
|
||||
"resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz",
|
||||
"integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"balanced-match": "^1.0.0",
|
||||
"concat-map": "0.0.1"
|
||||
}
|
||||
},
|
||||
"node_modules/swagger-jsdoc/node_modules/commander": {
|
||||
"version": "6.2.0",
|
||||
"resolved": "https://registry.npmjs.org/commander/-/commander-6.2.0.tgz",
|
||||
"integrity": "sha512-zP4jEKbe8SHzKJYQmq8Y9gYjtO/POJLgIdKgV7B9qNmABVFVc+ctqSX6iXh4mCpJfRBOabiZ2YKPg8ciDw6C+Q==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 6"
|
||||
}
|
||||
},
|
||||
"node_modules/swagger-jsdoc/node_modules/doctrine": {
|
||||
"version": "3.0.0",
|
||||
"resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz",
|
||||
"integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==",
|
||||
"license": "Apache-2.0",
|
||||
"dependencies": {
|
||||
"esutils": "^2.0.2"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=6.0.0"
|
||||
}
|
||||
},
|
||||
"node_modules/swagger-jsdoc/node_modules/glob": {
|
||||
"version": "7.1.6",
|
||||
"resolved": "https://registry.npmjs.org/glob/-/glob-7.1.6.tgz",
|
||||
"integrity": "sha512-LwaxwyZ72Lk7vZINtNNrywX0ZuLyStrdDtabefZKAY5ZGJhVtgdznluResxNmPitE0SAO+O26sWTHeKSI2wMBA==",
|
||||
"deprecated": "Glob versions prior to v9 are no longer supported",
|
||||
"license": "ISC",
|
||||
"dependencies": {
|
||||
"fs.realpath": "^1.0.0",
|
||||
"inflight": "^1.0.4",
|
||||
"inherits": "2",
|
||||
"minimatch": "^3.0.4",
|
||||
"once": "^1.3.0",
|
||||
"path-is-absolute": "^1.0.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": "*"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/isaacs"
|
||||
}
|
||||
},
|
||||
"node_modules/swagger-jsdoc/node_modules/minimatch": {
|
||||
"version": "3.1.2",
|
||||
"resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
|
||||
"integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==",
|
||||
"license": "ISC",
|
||||
"dependencies": {
|
||||
"brace-expansion": "^1.1.7"
|
||||
},
|
||||
"engines": {
|
||||
"node": "*"
|
||||
}
|
||||
},
|
||||
"node_modules/swagger-jsdoc/node_modules/yaml": {
|
||||
"version": "2.0.0-1",
|
||||
"resolved": "https://registry.npmjs.org/yaml/-/yaml-2.0.0-1.tgz",
|
||||
"integrity": "sha512-W7h5dEhywMKenDJh2iX/LABkbFnBxasD27oyXWDS/feDsxiw0dD5ncXdYXgkvAsXIY2MpW/ZKkr9IU30DBdMNQ==",
|
||||
"license": "ISC",
|
||||
"engines": {
|
||||
"node": ">= 6"
|
||||
}
|
||||
},
|
||||
"node_modules/swagger-parser": {
|
||||
"version": "10.0.3",
|
||||
"resolved": "https://registry.npmjs.org/swagger-parser/-/swagger-parser-10.0.3.tgz",
|
||||
"integrity": "sha512-nF7oMeL4KypldrQhac8RyHerJeGPD1p2xDh900GPvc+Nk7nWP6jX2FcC7WmkinMoAmoO774+AFXcWsW8gMWEIg==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@apidevtools/swagger-parser": "10.0.3"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=10"
|
||||
}
|
||||
},
|
||||
"node_modules/swagger-ui-dist": {
|
||||
"version": "5.31.0",
|
||||
"resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-5.31.0.tgz",
|
||||
"integrity": "sha512-zSUTIck02fSga6rc0RZP3b7J7wgHXwLea8ZjgLA3Vgnb8QeOl3Wou2/j5QkzSGeoz6HusP/coYuJl33aQxQZpg==",
|
||||
"license": "Apache-2.0",
|
||||
"dependencies": {
|
||||
"@scarf/scarf": "=1.4.0"
|
||||
}
|
||||
},
|
||||
"node_modules/swagger-ui-express": {
|
||||
"version": "5.0.1",
|
||||
"resolved": "https://registry.npmjs.org/swagger-ui-express/-/swagger-ui-express-5.0.1.tgz",
|
||||
"integrity": "sha512-SrNU3RiBGTLLmFU8GIJdOdanJTl4TOmT27tt3bWWHppqYmAZ6IDuEuBvMU6nZq0zLEe6b/1rACXCgLZqO6ZfrA==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"swagger-ui-dist": ">=5.0.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= v0.10.32"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"express": ">=4.0.0 || >=5.0.0-beta"
|
||||
}
|
||||
},
|
||||
"node_modules/symbol-tree": {
|
||||
"version": "3.2.4",
|
||||
"resolved": "https://registry.npmjs.org/symbol-tree/-/symbol-tree-3.2.4.tgz",
|
||||
@@ -16821,6 +17058,15 @@
|
||||
"node": ">=10.12.0"
|
||||
}
|
||||
},
|
||||
"node_modules/validator": {
|
||||
"version": "13.15.26",
|
||||
"resolved": "https://registry.npmjs.org/validator/-/validator-13.15.26.tgz",
|
||||
"integrity": "sha512-spH26xU080ydGggxRyR1Yhcbgx+j3y5jbNXk/8L+iRvdIEQ4uTRH2Sgf2dokud6Q4oAtsbNvJ1Ft+9xmm6IZcA==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.10"
|
||||
}
|
||||
},
|
||||
"node_modules/vary": {
|
||||
"version": "1.1.2",
|
||||
"resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz",
|
||||
@@ -17428,6 +17674,36 @@
|
||||
"url": "https://github.com/sponsors/sindresorhus"
|
||||
}
|
||||
},
|
||||
"node_modules/z-schema": {
|
||||
"version": "5.0.5",
|
||||
"resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.5.tgz",
|
||||
"integrity": "sha512-D7eujBWkLa3p2sIpJA0d1pr7es+a7m0vFAnZLlCEKq/Ij2k0MLi9Br2UPxoxdYystm5K1yeBGzub0FlYUEWj2Q==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"lodash.get": "^4.4.2",
|
||||
"lodash.isequal": "^4.5.0",
|
||||
"validator": "^13.7.0"
|
||||
},
|
||||
"bin": {
|
||||
"z-schema": "bin/z-schema"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=8.0.0"
|
||||
},
|
||||
"optionalDependencies": {
|
||||
"commander": "^9.4.1"
|
||||
}
|
||||
},
|
||||
"node_modules/z-schema/node_modules/commander": {
|
||||
"version": "9.5.0",
|
||||
"resolved": "https://registry.npmjs.org/commander/-/commander-9.5.0.tgz",
|
||||
"integrity": "sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==",
|
||||
"license": "MIT",
|
||||
"optional": true,
|
||||
"engines": {
|
||||
"node": "^12.20.0 || >=14"
|
||||
}
|
||||
},
|
||||
"node_modules/zip-stream": {
|
||||
"version": "6.0.1",
|
||||
"resolved": "https://registry.npmjs.org/zip-stream/-/zip-stream-6.0.1.tgz",
|
||||
|
||||
@@ -65,6 +65,8 @@
|
||||
"react-router-dom": "^7.9.6",
|
||||
"recharts": "^3.4.1",
|
||||
"sharp": "^0.34.5",
|
||||
"swagger-jsdoc": "^6.2.8",
|
||||
"swagger-ui-express": "^5.0.1",
|
||||
"tsx": "^4.20.6",
|
||||
"zod": "^4.2.1",
|
||||
"zxcvbn": "^4.4.2"
|
||||
@@ -96,6 +98,8 @@
|
||||
"@types/react-dom": "^19.2.3",
|
||||
"@types/sharp": "^0.31.1",
|
||||
"@types/supertest": "^6.0.3",
|
||||
"@types/swagger-jsdoc": "^6.0.4",
|
||||
"@types/swagger-ui-express": "^4.1.8",
|
||||
"@types/zxcvbn": "^4.4.5",
|
||||
"@typescript-eslint/eslint-plugin": "^8.47.0",
|
||||
"@typescript-eslint/parser": "^8.47.0",
|
||||
|
||||
29
server.ts
29
server.ts
@@ -27,6 +27,10 @@ import healthRouter from './src/routes/health.routes';
|
||||
import { errorHandler } from './src/middleware/errorHandler';
|
||||
import { backgroundJobService, startBackgroundJobs } from './src/services/backgroundJobService';
|
||||
import type { UserProfile } from './src/types';
|
||||
|
||||
// API Documentation (ADR-018)
|
||||
import swaggerUi from 'swagger-ui-express';
|
||||
import { swaggerSpec } from './src/config/swagger';
|
||||
import {
|
||||
analyticsQueue,
|
||||
weeklyAnalyticsQueue,
|
||||
@@ -106,8 +110,8 @@ app.use(passport.initialize()); // Initialize Passport
|
||||
|
||||
// --- MOCK AUTH FOR TESTING ---
|
||||
// This MUST come after passport.initialize() and BEFORE any of the API routes.
|
||||
import { mockAuth } from './src/routes/passport.routes';
|
||||
app.use(mockAuth);
|
||||
import { mockAuth } from './src/routes/passport.routes';
|
||||
app.use(mockAuth);
|
||||
|
||||
// Add a request timeout middleware. This will help prevent requests from hanging indefinitely.
|
||||
// We set a generous 5-minute timeout to accommodate slow AI processing for large flyers.
|
||||
@@ -188,6 +192,27 @@ if (!process.env.JWT_SECRET) {
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
// --- API Documentation (ADR-018) ---
|
||||
// Only serve Swagger UI in non-production environments to prevent information disclosure.
|
||||
if (process.env.NODE_ENV !== 'production') {
|
||||
app.use(
|
||||
'/docs/api-docs',
|
||||
swaggerUi.serve,
|
||||
swaggerUi.setup(swaggerSpec, {
|
||||
customCss: '.swagger-ui .topbar { display: none }',
|
||||
customSiteTitle: 'Flyer Crawler API Documentation',
|
||||
}),
|
||||
);
|
||||
|
||||
// Expose raw OpenAPI JSON spec for tooling (SDK generation, testing, etc.)
|
||||
app.get('/docs/api-docs.json', (_req, res) => {
|
||||
res.setHeader('Content-Type', 'application/json');
|
||||
res.send(swaggerSpec);
|
||||
});
|
||||
|
||||
logger.info('API Documentation available at /docs/api-docs');
|
||||
}
|
||||
|
||||
// --- API Routes ---
|
||||
|
||||
// The order of route registration is critical.
|
||||
|
||||
40
sql/01-init-bugsink.sh
Normal file
40
sql/01-init-bugsink.sh
Normal file
@@ -0,0 +1,40 @@
|
||||
#!/bin/bash
|
||||
# sql/01-init-bugsink.sh
|
||||
# ============================================================================
|
||||
# BUGSINK DATABASE INITIALIZATION (ADR-015)
|
||||
# ============================================================================
|
||||
# This script creates the Bugsink database and user for error tracking.
|
||||
# It runs after 00-init-extensions.sql due to alphabetical ordering.
|
||||
#
|
||||
# Note: Shell scripts in docker-entrypoint-initdb.d/ can execute multiple
|
||||
# SQL commands including CREATE DATABASE (which requires a separate transaction).
|
||||
# ============================================================================
|
||||
|
||||
set -e
|
||||
|
||||
# Use the postgres superuser to create the bugsink user and database
|
||||
psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" --dbname "$POSTGRES_DB" <<-EOSQL
|
||||
-- Create Bugsink user (if not exists)
|
||||
DO \$\$
|
||||
BEGIN
|
||||
IF NOT EXISTS (SELECT FROM pg_catalog.pg_roles WHERE rolname = 'bugsink') THEN
|
||||
CREATE USER bugsink WITH PASSWORD 'bugsink_dev_password';
|
||||
RAISE NOTICE 'Created bugsink user';
|
||||
ELSE
|
||||
RAISE NOTICE 'Bugsink user already exists';
|
||||
END IF;
|
||||
END \$\$;
|
||||
EOSQL
|
||||
|
||||
# Check if bugsink database exists, create if not
|
||||
if psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" -lqt | cut -d \| -f 1 | grep -qw bugsink; then
|
||||
echo "Bugsink database already exists"
|
||||
else
|
||||
psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" --dbname "$POSTGRES_DB" <<-EOSQL
|
||||
CREATE DATABASE bugsink OWNER bugsink;
|
||||
GRANT ALL PRIVILEGES ON DATABASE bugsink TO bugsink;
|
||||
EOSQL
|
||||
echo "Created bugsink database"
|
||||
fi
|
||||
|
||||
echo "✅ Bugsink database and user have been configured (ADR-015)"
|
||||
@@ -1,6 +1,55 @@
|
||||
-- sql/Initial_triggers_and_functions.sql
|
||||
-- This file contains all trigger functions and trigger definitions for the database.
|
||||
|
||||
-- ============================================================================
|
||||
-- PART 0: OBSERVABILITY HELPERS (ADR-050)
|
||||
-- ============================================================================
|
||||
-- These functions provide structured logging capabilities for database functions.
|
||||
-- Logs are emitted via RAISE statements and can be captured by Logstash for
|
||||
-- forwarding to error tracking systems (see ADR-015).
|
||||
|
||||
-- Function to emit structured log messages from PL/pgSQL functions.
|
||||
-- This enables observability for database operations that might otherwise fail silently.
|
||||
DROP FUNCTION IF EXISTS public.fn_log(TEXT, TEXT, TEXT, JSONB);
|
||||
|
||||
CREATE OR REPLACE FUNCTION public.fn_log(
|
||||
p_level TEXT, -- 'DEBUG', 'INFO', 'NOTICE', 'WARNING', 'ERROR'
|
||||
p_function_name TEXT, -- The calling function name
|
||||
p_message TEXT, -- Human-readable message
|
||||
p_context JSONB DEFAULT NULL -- Additional context (user_id, params, etc.)
|
||||
)
|
||||
RETURNS void
|
||||
LANGUAGE plpgsql
|
||||
AS $$
|
||||
DECLARE
|
||||
log_line TEXT;
|
||||
BEGIN
|
||||
-- Build structured JSON log line for Logstash parsing
|
||||
log_line := jsonb_build_object(
|
||||
'timestamp', now(),
|
||||
'level', p_level,
|
||||
'source', 'postgresql',
|
||||
'function', p_function_name,
|
||||
'message', p_message,
|
||||
'context', COALESCE(p_context, '{}'::jsonb)
|
||||
)::text;
|
||||
|
||||
-- Use appropriate RAISE level based on severity
|
||||
-- Note: We use RAISE LOG for errors to ensure they're always captured
|
||||
-- regardless of client_min_messages setting
|
||||
CASE UPPER(p_level)
|
||||
WHEN 'DEBUG' THEN RAISE DEBUG '%', log_line;
|
||||
WHEN 'INFO' THEN RAISE INFO '%', log_line;
|
||||
WHEN 'NOTICE' THEN RAISE NOTICE '%', log_line;
|
||||
WHEN 'WARNING' THEN RAISE WARNING '%', log_line;
|
||||
WHEN 'ERROR' THEN RAISE LOG '%', log_line;
|
||||
ELSE RAISE NOTICE '%', log_line;
|
||||
END CASE;
|
||||
END;
|
||||
$$;
|
||||
|
||||
COMMENT ON FUNCTION public.fn_log IS 'Emits structured JSON log messages for database function observability (ADR-050)';
|
||||
|
||||
-- ============================================================================
|
||||
-- PART 3: DATABASE FUNCTIONS
|
||||
-- ============================================================================
|
||||
@@ -223,13 +272,32 @@ AS $$
|
||||
DECLARE
|
||||
list_owner_id UUID;
|
||||
item_to_add RECORD;
|
||||
v_items_added INTEGER := 0;
|
||||
v_context JSONB;
|
||||
BEGIN
|
||||
-- Build context for logging
|
||||
v_context := jsonb_build_object(
|
||||
'user_id', p_user_id,
|
||||
'menu_plan_id', p_menu_plan_id,
|
||||
'shopping_list_id', p_shopping_list_id
|
||||
);
|
||||
|
||||
-- Security Check: Ensure the user calling this function owns the target shopping list.
|
||||
SELECT user_id INTO list_owner_id
|
||||
FROM public.shopping_lists
|
||||
WHERE shopping_list_id = p_shopping_list_id;
|
||||
|
||||
IF list_owner_id IS NULL OR list_owner_id <> p_user_id THEN
|
||||
IF list_owner_id IS NULL THEN
|
||||
PERFORM fn_log('WARNING', 'add_menu_plan_to_shopping_list',
|
||||
'Shopping list not found',
|
||||
v_context);
|
||||
RAISE EXCEPTION 'Permission denied: You do not own shopping list %', p_shopping_list_id;
|
||||
END IF;
|
||||
|
||||
IF list_owner_id <> p_user_id THEN
|
||||
PERFORM fn_log('WARNING', 'add_menu_plan_to_shopping_list',
|
||||
'Permission denied: user does not own list',
|
||||
v_context || jsonb_build_object('list_owner_id', list_owner_id));
|
||||
RAISE EXCEPTION 'Permission denied: You do not own shopping list %', p_shopping_list_id;
|
||||
END IF;
|
||||
|
||||
@@ -244,9 +312,16 @@ BEGIN
|
||||
DO UPDATE SET
|
||||
quantity = shopping_list_items.quantity + EXCLUDED.quantity;
|
||||
|
||||
v_items_added := v_items_added + 1;
|
||||
|
||||
-- Return the details of the item that was added/updated.
|
||||
RETURN QUERY SELECT item_to_add.master_item_id, item_to_add.item_name, item_to_add.shopping_list_quantity;
|
||||
END LOOP;
|
||||
|
||||
-- Log completion (items_added = 0 is normal if pantry has everything)
|
||||
PERFORM fn_log('INFO', 'add_menu_plan_to_shopping_list',
|
||||
'Menu plan items added to shopping list',
|
||||
v_context || jsonb_build_object('items_added', v_items_added));
|
||||
END;
|
||||
$$;
|
||||
|
||||
@@ -520,16 +595,30 @@ SECURITY DEFINER
|
||||
AS $$
|
||||
DECLARE
|
||||
correction_record RECORD;
|
||||
v_context JSONB;
|
||||
BEGIN
|
||||
-- Build context for logging
|
||||
v_context := jsonb_build_object('correction_id', p_correction_id);
|
||||
|
||||
-- 1. Fetch the correction details, ensuring it's still pending.
|
||||
SELECT * INTO correction_record
|
||||
FROM public.suggested_corrections
|
||||
WHERE suggested_correction_id = p_correction_id AND status = 'pending';
|
||||
|
||||
IF NOT FOUND THEN
|
||||
PERFORM fn_log('WARNING', 'approve_correction',
|
||||
'Correction not found or already processed',
|
||||
v_context);
|
||||
RAISE EXCEPTION 'Correction with ID % not found or already processed.', p_correction_id;
|
||||
END IF;
|
||||
|
||||
-- Add correction details to context
|
||||
v_context := v_context || jsonb_build_object(
|
||||
'correction_type', correction_record.correction_type,
|
||||
'flyer_item_id', correction_record.flyer_item_id,
|
||||
'suggested_value', correction_record.suggested_value
|
||||
);
|
||||
|
||||
-- 2. Apply the correction based on its type.
|
||||
IF correction_record.correction_type = 'INCORRECT_ITEM_LINK' THEN
|
||||
UPDATE public.flyer_items
|
||||
@@ -545,6 +634,11 @@ BEGIN
|
||||
UPDATE public.suggested_corrections
|
||||
SET status = 'approved', reviewed_at = now()
|
||||
WHERE suggested_correction_id = p_correction_id;
|
||||
|
||||
-- Log successful correction approval
|
||||
PERFORM fn_log('INFO', 'approve_correction',
|
||||
'Correction approved and applied',
|
||||
v_context);
|
||||
END;
|
||||
$$;
|
||||
|
||||
@@ -566,7 +660,14 @@ SECURITY INVOKER
|
||||
AS $$
|
||||
DECLARE
|
||||
new_recipe_id BIGINT;
|
||||
v_context JSONB;
|
||||
BEGIN
|
||||
-- Build context for logging
|
||||
v_context := jsonb_build_object(
|
||||
'user_id', p_user_id,
|
||||
'original_recipe_id', p_original_recipe_id
|
||||
);
|
||||
|
||||
-- 1. Create a copy of the recipe, linking it to the new user and the original recipe.
|
||||
INSERT INTO public.recipes (
|
||||
user_id,
|
||||
@@ -605,6 +706,9 @@ BEGIN
|
||||
|
||||
-- If the original recipe didn't exist, new_recipe_id will be null.
|
||||
IF new_recipe_id IS NULL THEN
|
||||
PERFORM fn_log('WARNING', 'fork_recipe',
|
||||
'Original recipe not found',
|
||||
v_context);
|
||||
RETURN;
|
||||
END IF;
|
||||
|
||||
@@ -613,6 +717,11 @@ BEGIN
|
||||
INSERT INTO public.recipe_tags (recipe_id, tag_id) SELECT new_recipe_id, tag_id FROM public.recipe_tags WHERE recipe_id = p_original_recipe_id;
|
||||
INSERT INTO public.recipe_appliances (recipe_id, appliance_id) SELECT new_recipe_id, appliance_id FROM public.recipe_appliances WHERE recipe_id = p_original_recipe_id;
|
||||
|
||||
-- Log successful fork
|
||||
PERFORM fn_log('INFO', 'fork_recipe',
|
||||
'Recipe forked successfully',
|
||||
v_context || jsonb_build_object('new_recipe_id', new_recipe_id));
|
||||
|
||||
-- 3. Return the newly created recipe record.
|
||||
RETURN QUERY SELECT * FROM public.recipes WHERE recipe_id = new_recipe_id;
|
||||
END;
|
||||
@@ -889,13 +998,32 @@ AS $$
|
||||
DECLARE
|
||||
list_owner_id UUID;
|
||||
new_trip_id BIGINT;
|
||||
v_items_count INTEGER;
|
||||
v_context JSONB;
|
||||
BEGIN
|
||||
-- Build context for logging
|
||||
v_context := jsonb_build_object(
|
||||
'user_id', p_user_id,
|
||||
'shopping_list_id', p_shopping_list_id,
|
||||
'total_spent_cents', p_total_spent_cents
|
||||
);
|
||||
|
||||
-- Security Check: Ensure the user calling this function owns the target shopping list.
|
||||
SELECT user_id INTO list_owner_id
|
||||
FROM public.shopping_lists
|
||||
WHERE shopping_list_id = p_shopping_list_id;
|
||||
|
||||
IF list_owner_id IS NULL OR list_owner_id <> p_user_id THEN
|
||||
IF list_owner_id IS NULL THEN
|
||||
PERFORM fn_log('WARNING', 'complete_shopping_list',
|
||||
'Shopping list not found',
|
||||
v_context);
|
||||
RAISE EXCEPTION 'Permission denied: You do not own shopping list %', p_shopping_list_id;
|
||||
END IF;
|
||||
|
||||
IF list_owner_id <> p_user_id THEN
|
||||
PERFORM fn_log('WARNING', 'complete_shopping_list',
|
||||
'Permission denied: user does not own list',
|
||||
v_context || jsonb_build_object('list_owner_id', list_owner_id));
|
||||
RAISE EXCEPTION 'Permission denied: You do not own shopping list %', p_shopping_list_id;
|
||||
END IF;
|
||||
|
||||
@@ -910,10 +1038,17 @@ BEGIN
|
||||
FROM public.shopping_list_items
|
||||
WHERE shopping_list_id = p_shopping_list_id AND is_purchased = true;
|
||||
|
||||
GET DIAGNOSTICS v_items_count = ROW_COUNT;
|
||||
|
||||
-- 3. Delete the purchased items from the original shopping list.
|
||||
DELETE FROM public.shopping_list_items
|
||||
WHERE shopping_list_id = p_shopping_list_id AND is_purchased = true;
|
||||
|
||||
-- Log successful completion
|
||||
PERFORM fn_log('INFO', 'complete_shopping_list',
|
||||
'Shopping list completed successfully',
|
||||
v_context || jsonb_build_object('trip_id', new_trip_id, 'items_archived', v_items_count));
|
||||
|
||||
RETURN new_trip_id;
|
||||
END;
|
||||
$$;
|
||||
@@ -1047,13 +1182,19 @@ AS $$
|
||||
DECLARE
|
||||
v_achievement_id BIGINT;
|
||||
v_points_value INTEGER;
|
||||
v_context JSONB;
|
||||
BEGIN
|
||||
-- Build context for logging
|
||||
v_context := jsonb_build_object('user_id', p_user_id, 'achievement_name', p_achievement_name);
|
||||
|
||||
-- Find the achievement by name to get its ID and point value.
|
||||
SELECT achievement_id, points_value INTO v_achievement_id, v_points_value
|
||||
FROM public.achievements WHERE name = p_achievement_name;
|
||||
|
||||
-- If the achievement doesn't exist, do nothing.
|
||||
-- If the achievement doesn't exist, log warning and return.
|
||||
IF v_achievement_id IS NULL THEN
|
||||
PERFORM fn_log('WARNING', 'award_achievement',
|
||||
'Achievement not found: ' || p_achievement_name, v_context);
|
||||
RETURN;
|
||||
END IF;
|
||||
|
||||
@@ -1065,9 +1206,12 @@ BEGIN
|
||||
ON CONFLICT (user_id, achievement_id) DO NOTHING;
|
||||
|
||||
-- If the insert was successful (i.e., the user didn't have the achievement),
|
||||
-- update their total points. The `GET DIAGNOSTICS` command checks the row count of the last query.
|
||||
-- update their total points and log success.
|
||||
IF FOUND THEN
|
||||
UPDATE public.profiles SET points = points + v_points_value WHERE user_id = p_user_id;
|
||||
PERFORM fn_log('INFO', 'award_achievement',
|
||||
'Achievement awarded: ' || p_achievement_name,
|
||||
v_context || jsonb_build_object('points_awarded', v_points_value));
|
||||
END IF;
|
||||
END;
|
||||
$$;
|
||||
@@ -1165,13 +1309,25 @@ RETURNS TRIGGER AS $$
|
||||
DECLARE
|
||||
new_profile_id UUID;
|
||||
user_meta_data JSONB;
|
||||
v_context JSONB;
|
||||
BEGIN
|
||||
-- Build context for logging
|
||||
v_context := jsonb_build_object('user_id', new.user_id, 'email', new.email);
|
||||
|
||||
-- The user's metadata (full_name, avatar_url) is passed via a temporary session variable.
|
||||
user_meta_data := current_setting('my_app.user_metadata', true)::JSONB;
|
||||
|
||||
INSERT INTO public.profiles (user_id, role, full_name, avatar_url)
|
||||
VALUES (new.user_id, 'user', user_meta_data->>'full_name', user_meta_data->>'avatar_url')
|
||||
RETURNING user_id INTO new_profile_id;
|
||||
-- Create the user profile
|
||||
BEGIN
|
||||
INSERT INTO public.profiles (user_id, role, full_name, avatar_url)
|
||||
VALUES (new.user_id, 'user', user_meta_data->>'full_name', user_meta_data->>'avatar_url')
|
||||
RETURNING user_id INTO new_profile_id;
|
||||
EXCEPTION WHEN OTHERS THEN
|
||||
PERFORM fn_log('ERROR', 'handle_new_user',
|
||||
'Failed to create profile: ' || SQLERRM,
|
||||
v_context || jsonb_build_object('sqlstate', SQLSTATE));
|
||||
RAISE;
|
||||
END;
|
||||
|
||||
-- Also create a default shopping list for the new user.
|
||||
INSERT INTO public.shopping_lists (user_id, name)
|
||||
@@ -1185,6 +1341,14 @@ BEGIN
|
||||
jsonb_build_object('email', new.email)
|
||||
);
|
||||
|
||||
-- Award the 'Welcome Aboard' achievement for new user registration
|
||||
PERFORM public.award_achievement(new.user_id, 'Welcome Aboard');
|
||||
|
||||
-- Log successful user creation
|
||||
PERFORM fn_log('INFO', 'handle_new_user',
|
||||
'New user created successfully',
|
||||
v_context || jsonb_build_object('full_name', user_meta_data->>'full_name'));
|
||||
|
||||
RETURN new;
|
||||
END;
|
||||
$$ LANGUAGE plpgsql;
|
||||
|
||||
@@ -260,6 +260,7 @@ ON CONFLICT (name) DO NOTHING;
|
||||
|
||||
-- 9. Pre-populate the achievements table.
|
||||
INSERT INTO public.achievements (name, description, icon, points_value) VALUES
|
||||
('Welcome Aboard', 'Join the community by creating your account.', 'user-check', 5),
|
||||
('First Recipe', 'Create your very first recipe.', 'chef-hat', 10),
|
||||
('Recipe Sharer', 'Share a recipe with another user for the first time.', 'share-2', 15),
|
||||
('List Sharer', 'Share a shopping list with another user for the first time.', 'list', 20),
|
||||
|
||||
@@ -1258,6 +1258,7 @@ ON CONFLICT (name) DO NOTHING;
|
||||
|
||||
-- Pre-populate the achievements table.
|
||||
INSERT INTO public.achievements (name, description, icon, points_value) VALUES
|
||||
('Welcome Aboard', 'Join the community by creating your account.', 'user-check', 5),
|
||||
('First Recipe', 'Create your very first recipe.', 'chef-hat', 10),
|
||||
('Recipe Sharer', 'Share a recipe with another user for the first time.', 'share-2', 15),
|
||||
('List Sharer', 'Share a shopping list with another user for the first time.', 'list', 20),
|
||||
@@ -1267,6 +1268,55 @@ INSERT INTO public.achievements (name, description, icon, points_value) VALUES
|
||||
('First-Upload', 'Upload your first flyer.', 'upload-cloud', 25)
|
||||
ON CONFLICT (name) DO NOTHING;
|
||||
|
||||
-- ============================================================================
|
||||
-- PART 0: OBSERVABILITY HELPERS (ADR-050)
|
||||
-- ============================================================================
|
||||
-- These functions provide structured logging capabilities for database functions.
|
||||
-- Logs are emitted via RAISE statements and can be captured by Logstash for
|
||||
-- forwarding to error tracking systems (see ADR-015).
|
||||
|
||||
-- Function to emit structured log messages from PL/pgSQL functions.
|
||||
-- This enables observability for database operations that might otherwise fail silently.
|
||||
DROP FUNCTION IF EXISTS public.fn_log(TEXT, TEXT, TEXT, JSONB);
|
||||
|
||||
CREATE OR REPLACE FUNCTION public.fn_log(
|
||||
p_level TEXT, -- 'DEBUG', 'INFO', 'NOTICE', 'WARNING', 'ERROR'
|
||||
p_function_name TEXT, -- The calling function name
|
||||
p_message TEXT, -- Human-readable message
|
||||
p_context JSONB DEFAULT NULL -- Additional context (user_id, params, etc.)
|
||||
)
|
||||
RETURNS void
|
||||
LANGUAGE plpgsql
|
||||
AS $$
|
||||
DECLARE
|
||||
log_line TEXT;
|
||||
BEGIN
|
||||
-- Build structured JSON log line for Logstash parsing
|
||||
log_line := jsonb_build_object(
|
||||
'timestamp', now(),
|
||||
'level', p_level,
|
||||
'source', 'postgresql',
|
||||
'function', p_function_name,
|
||||
'message', p_message,
|
||||
'context', COALESCE(p_context, '{}'::jsonb)
|
||||
)::text;
|
||||
|
||||
-- Use appropriate RAISE level based on severity
|
||||
-- Note: We use RAISE LOG for errors to ensure they're always captured
|
||||
-- regardless of client_min_messages setting
|
||||
CASE UPPER(p_level)
|
||||
WHEN 'DEBUG' THEN RAISE DEBUG '%', log_line;
|
||||
WHEN 'INFO' THEN RAISE INFO '%', log_line;
|
||||
WHEN 'NOTICE' THEN RAISE NOTICE '%', log_line;
|
||||
WHEN 'WARNING' THEN RAISE WARNING '%', log_line;
|
||||
WHEN 'ERROR' THEN RAISE LOG '%', log_line;
|
||||
ELSE RAISE NOTICE '%', log_line;
|
||||
END CASE;
|
||||
END;
|
||||
$$;
|
||||
|
||||
COMMENT ON FUNCTION public.fn_log IS 'Emits structured JSON log messages for database function observability (ADR-050)';
|
||||
|
||||
-- ============================================================================
|
||||
-- PART 3: DATABASE FUNCTIONS
|
||||
-- ============================================================================
|
||||
@@ -1487,13 +1537,32 @@ AS $$
|
||||
DECLARE
|
||||
list_owner_id UUID;
|
||||
item_to_add RECORD;
|
||||
v_items_added INTEGER := 0;
|
||||
v_context JSONB;
|
||||
BEGIN
|
||||
-- Build context for logging
|
||||
v_context := jsonb_build_object(
|
||||
'user_id', p_user_id,
|
||||
'menu_plan_id', p_menu_plan_id,
|
||||
'shopping_list_id', p_shopping_list_id
|
||||
);
|
||||
|
||||
-- Security Check: Ensure the user calling this function owns the target shopping list.
|
||||
SELECT user_id INTO list_owner_id
|
||||
FROM public.shopping_lists
|
||||
WHERE shopping_list_id = p_shopping_list_id;
|
||||
|
||||
IF list_owner_id IS NULL OR list_owner_id <> p_user_id THEN
|
||||
IF list_owner_id IS NULL THEN
|
||||
PERFORM fn_log('WARNING', 'add_menu_plan_to_shopping_list',
|
||||
'Shopping list not found',
|
||||
v_context);
|
||||
RAISE EXCEPTION 'Permission denied: You do not own shopping list %', p_shopping_list_id;
|
||||
END IF;
|
||||
|
||||
IF list_owner_id <> p_user_id THEN
|
||||
PERFORM fn_log('WARNING', 'add_menu_plan_to_shopping_list',
|
||||
'Permission denied: user does not own list',
|
||||
v_context || jsonb_build_object('list_owner_id', list_owner_id));
|
||||
RAISE EXCEPTION 'Permission denied: You do not own shopping list %', p_shopping_list_id;
|
||||
END IF;
|
||||
|
||||
@@ -1508,9 +1577,16 @@ BEGIN
|
||||
DO UPDATE SET
|
||||
quantity = shopping_list_items.quantity + EXCLUDED.quantity;
|
||||
|
||||
v_items_added := v_items_added + 1;
|
||||
|
||||
-- Return the details of the item that was added/updated.
|
||||
RETURN QUERY SELECT item_to_add.master_item_id, item_to_add.item_name, item_to_add.shopping_list_quantity;
|
||||
END LOOP;
|
||||
|
||||
-- Log completion (items_added = 0 is normal if pantry has everything)
|
||||
PERFORM fn_log('INFO', 'add_menu_plan_to_shopping_list',
|
||||
'Menu plan items added to shopping list',
|
||||
v_context || jsonb_build_object('items_added', v_items_added));
|
||||
END;
|
||||
$$;
|
||||
|
||||
@@ -2038,13 +2114,32 @@ AS $$
|
||||
DECLARE
|
||||
list_owner_id UUID;
|
||||
new_trip_id BIGINT;
|
||||
v_items_count INTEGER;
|
||||
v_context JSONB;
|
||||
BEGIN
|
||||
-- Build context for logging
|
||||
v_context := jsonb_build_object(
|
||||
'user_id', p_user_id,
|
||||
'shopping_list_id', p_shopping_list_id,
|
||||
'total_spent_cents', p_total_spent_cents
|
||||
);
|
||||
|
||||
-- Security Check: Ensure the user calling this function owns the target shopping list.
|
||||
SELECT user_id INTO list_owner_id
|
||||
FROM public.shopping_lists
|
||||
WHERE shopping_list_id = p_shopping_list_id;
|
||||
|
||||
IF list_owner_id IS NULL OR list_owner_id <> p_user_id THEN
|
||||
IF list_owner_id IS NULL THEN
|
||||
PERFORM fn_log('WARNING', 'complete_shopping_list',
|
||||
'Shopping list not found',
|
||||
v_context);
|
||||
RAISE EXCEPTION 'Permission denied: You do not own shopping list %', p_shopping_list_id;
|
||||
END IF;
|
||||
|
||||
IF list_owner_id <> p_user_id THEN
|
||||
PERFORM fn_log('WARNING', 'complete_shopping_list',
|
||||
'Permission denied: user does not own list',
|
||||
v_context || jsonb_build_object('list_owner_id', list_owner_id));
|
||||
RAISE EXCEPTION 'Permission denied: You do not own shopping list %', p_shopping_list_id;
|
||||
END IF;
|
||||
|
||||
@@ -2059,10 +2154,17 @@ BEGIN
|
||||
FROM public.shopping_list_items
|
||||
WHERE shopping_list_id = p_shopping_list_id AND is_purchased = true;
|
||||
|
||||
GET DIAGNOSTICS v_items_count = ROW_COUNT;
|
||||
|
||||
-- 3. Delete the purchased items from the original shopping list.
|
||||
DELETE FROM public.shopping_list_items
|
||||
WHERE shopping_list_id = p_shopping_list_id AND is_purchased = true;
|
||||
|
||||
-- Log successful completion
|
||||
PERFORM fn_log('INFO', 'complete_shopping_list',
|
||||
'Shopping list completed successfully',
|
||||
v_context || jsonb_build_object('trip_id', new_trip_id, 'items_archived', v_items_count));
|
||||
|
||||
RETURN new_trip_id;
|
||||
END;
|
||||
$$;
|
||||
@@ -2197,16 +2299,30 @@ SECURITY DEFINER
|
||||
AS $$
|
||||
DECLARE
|
||||
correction_record RECORD;
|
||||
v_context JSONB;
|
||||
BEGIN
|
||||
-- Build context for logging
|
||||
v_context := jsonb_build_object('correction_id', p_correction_id);
|
||||
|
||||
-- 1. Fetch the correction details, ensuring it's still pending.
|
||||
SELECT * INTO correction_record
|
||||
FROM public.suggested_corrections
|
||||
WHERE suggested_correction_id = p_correction_id AND status = 'pending';
|
||||
|
||||
IF NOT FOUND THEN
|
||||
PERFORM fn_log('WARNING', 'approve_correction',
|
||||
'Correction not found or already processed',
|
||||
v_context);
|
||||
RAISE EXCEPTION 'Correction with ID % not found or already processed.', p_correction_id;
|
||||
END IF;
|
||||
|
||||
-- Add correction details to context
|
||||
v_context := v_context || jsonb_build_object(
|
||||
'correction_type', correction_record.correction_type,
|
||||
'flyer_item_id', correction_record.flyer_item_id,
|
||||
'suggested_value', correction_record.suggested_value
|
||||
);
|
||||
|
||||
-- 2. Apply the correction based on its type.
|
||||
IF correction_record.correction_type = 'INCORRECT_ITEM_LINK' THEN
|
||||
UPDATE public.flyer_items
|
||||
@@ -2222,6 +2338,11 @@ BEGIN
|
||||
UPDATE public.suggested_corrections
|
||||
SET status = 'approved', reviewed_at = now()
|
||||
WHERE suggested_correction_id = p_correction_id;
|
||||
|
||||
-- Log successful correction approval
|
||||
PERFORM fn_log('INFO', 'approve_correction',
|
||||
'Correction approved and applied',
|
||||
v_context);
|
||||
END;
|
||||
$$;
|
||||
|
||||
@@ -2236,13 +2357,19 @@ AS $$
|
||||
DECLARE
|
||||
v_achievement_id BIGINT;
|
||||
v_points_value INTEGER;
|
||||
v_context JSONB;
|
||||
BEGIN
|
||||
-- Build context for logging
|
||||
v_context := jsonb_build_object('user_id', p_user_id, 'achievement_name', p_achievement_name);
|
||||
|
||||
-- Find the achievement by name to get its ID and point value.
|
||||
SELECT achievement_id, points_value INTO v_achievement_id, v_points_value
|
||||
FROM public.achievements WHERE name = p_achievement_name;
|
||||
|
||||
-- If the achievement doesn't exist, do nothing.
|
||||
-- If the achievement doesn't exist, log warning and return.
|
||||
IF v_achievement_id IS NULL THEN
|
||||
PERFORM fn_log('WARNING', 'award_achievement',
|
||||
'Achievement not found: ' || p_achievement_name, v_context);
|
||||
RETURN;
|
||||
END IF;
|
||||
|
||||
@@ -2254,9 +2381,12 @@ BEGIN
|
||||
ON CONFLICT (user_id, achievement_id) DO NOTHING;
|
||||
|
||||
-- If the insert was successful (i.e., the user didn't have the achievement),
|
||||
-- update their total points. The `GET DIAGNOSTICS` command checks the row count of the last query.
|
||||
-- update their total points and log success.
|
||||
IF FOUND THEN
|
||||
UPDATE public.profiles SET points = points + v_points_value WHERE user_id = p_user_id;
|
||||
PERFORM fn_log('INFO', 'award_achievement',
|
||||
'Achievement awarded: ' || p_achievement_name,
|
||||
v_context || jsonb_build_object('points_awarded', v_points_value));
|
||||
END IF;
|
||||
END;
|
||||
$$;
|
||||
@@ -2279,7 +2409,14 @@ SECURITY INVOKER
|
||||
AS $$
|
||||
DECLARE
|
||||
new_recipe_id BIGINT;
|
||||
v_context JSONB;
|
||||
BEGIN
|
||||
-- Build context for logging
|
||||
v_context := jsonb_build_object(
|
||||
'user_id', p_user_id,
|
||||
'original_recipe_id', p_original_recipe_id
|
||||
);
|
||||
|
||||
-- 1. Create a copy of the recipe, linking it to the new user and the original recipe.
|
||||
INSERT INTO public.recipes (
|
||||
user_id,
|
||||
@@ -2318,6 +2455,9 @@ BEGIN
|
||||
|
||||
-- If the original recipe didn't exist, new_recipe_id will be null.
|
||||
IF new_recipe_id IS NULL THEN
|
||||
PERFORM fn_log('WARNING', 'fork_recipe',
|
||||
'Original recipe not found',
|
||||
v_context);
|
||||
RETURN;
|
||||
END IF;
|
||||
|
||||
@@ -2326,6 +2466,11 @@ BEGIN
|
||||
INSERT INTO public.recipe_tags (recipe_id, tag_id) SELECT new_recipe_id, tag_id FROM public.recipe_tags WHERE recipe_id = p_original_recipe_id;
|
||||
INSERT INTO public.recipe_appliances (recipe_id, appliance_id) SELECT new_recipe_id, appliance_id FROM public.recipe_appliances WHERE recipe_id = p_original_recipe_id;
|
||||
|
||||
-- Log successful fork
|
||||
PERFORM fn_log('INFO', 'fork_recipe',
|
||||
'Recipe forked successfully',
|
||||
v_context || jsonb_build_object('new_recipe_id', new_recipe_id));
|
||||
|
||||
-- 3. Return the newly created recipe record.
|
||||
RETURN QUERY SELECT * FROM public.recipes WHERE recipe_id = new_recipe_id;
|
||||
END;
|
||||
@@ -2346,13 +2491,25 @@ RETURNS TRIGGER AS $$
|
||||
DECLARE
|
||||
new_profile_id UUID;
|
||||
user_meta_data JSONB;
|
||||
v_context JSONB;
|
||||
BEGIN
|
||||
-- Build context for logging
|
||||
v_context := jsonb_build_object('user_id', new.user_id, 'email', new.email);
|
||||
|
||||
-- The user's metadata (full_name, avatar_url) is passed via a temporary session variable.
|
||||
user_meta_data := current_setting('my_app.user_metadata', true)::JSONB;
|
||||
|
||||
INSERT INTO public.profiles (user_id, role, full_name, avatar_url)
|
||||
VALUES (new.user_id, 'user', user_meta_data->>'full_name', user_meta_data->>'avatar_url')
|
||||
RETURNING user_id INTO new_profile_id;
|
||||
-- Create the user profile
|
||||
BEGIN
|
||||
INSERT INTO public.profiles (user_id, role, full_name, avatar_url)
|
||||
VALUES (new.user_id, 'user', user_meta_data->>'full_name', user_meta_data->>'avatar_url')
|
||||
RETURNING user_id INTO new_profile_id;
|
||||
EXCEPTION WHEN OTHERS THEN
|
||||
PERFORM fn_log('ERROR', 'handle_new_user',
|
||||
'Failed to create profile: ' || SQLERRM,
|
||||
v_context || jsonb_build_object('sqlstate', SQLSTATE));
|
||||
RAISE;
|
||||
END;
|
||||
|
||||
-- Also create a default shopping list for the new user.
|
||||
INSERT INTO public.shopping_lists (user_id, name)
|
||||
@@ -2365,6 +2522,15 @@ BEGIN
|
||||
'user-plus',
|
||||
jsonb_build_object('email', new.email)
|
||||
);
|
||||
|
||||
-- Award the 'Welcome Aboard' achievement for new user registration
|
||||
PERFORM public.award_achievement(new.user_id, 'Welcome Aboard');
|
||||
|
||||
-- Log successful user creation
|
||||
PERFORM fn_log('INFO', 'handle_new_user',
|
||||
'New user created successfully',
|
||||
v_context || jsonb_build_object('full_name', user_meta_data->>'full_name'));
|
||||
|
||||
RETURN new;
|
||||
END;
|
||||
$$ LANGUAGE plpgsql;
|
||||
|
||||
228
src/config/swagger.ts
Normal file
228
src/config/swagger.ts
Normal file
@@ -0,0 +1,228 @@
|
||||
// src/config/swagger.ts
|
||||
/**
|
||||
* @file OpenAPI/Swagger configuration for API documentation.
|
||||
* Implements ADR-018: API Documentation Strategy.
|
||||
*
|
||||
* This file configures swagger-jsdoc to generate an OpenAPI 3.0 specification
|
||||
* from JSDoc annotations in route files. The specification is used by
|
||||
* swagger-ui-express to serve interactive API documentation.
|
||||
*/
|
||||
import swaggerJsdoc from 'swagger-jsdoc';
|
||||
|
||||
const options: swaggerJsdoc.Options = {
|
||||
definition: {
|
||||
openapi: '3.0.0',
|
||||
info: {
|
||||
title: 'Flyer Crawler API',
|
||||
version: '1.0.0',
|
||||
description:
|
||||
'API for the Flyer Crawler application - a platform for discovering grocery deals, managing recipes, and tracking budgets.',
|
||||
contact: {
|
||||
name: 'API Support',
|
||||
},
|
||||
license: {
|
||||
name: 'Private',
|
||||
},
|
||||
},
|
||||
servers: [
|
||||
{
|
||||
url: '/api',
|
||||
description: 'API server',
|
||||
},
|
||||
],
|
||||
components: {
|
||||
securitySchemes: {
|
||||
bearerAuth: {
|
||||
type: 'http',
|
||||
scheme: 'bearer',
|
||||
bearerFormat: 'JWT',
|
||||
description: 'JWT token obtained from /auth/login or /auth/register',
|
||||
},
|
||||
},
|
||||
schemas: {
|
||||
// Standard success response wrapper (ADR-028)
|
||||
SuccessResponse: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
success: {
|
||||
type: 'boolean',
|
||||
example: true,
|
||||
},
|
||||
data: {
|
||||
type: 'object',
|
||||
description: 'Response payload - structure varies by endpoint',
|
||||
},
|
||||
},
|
||||
required: ['success', 'data'],
|
||||
},
|
||||
// Standard error response wrapper (ADR-028)
|
||||
ErrorResponse: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
success: {
|
||||
type: 'boolean',
|
||||
example: false,
|
||||
},
|
||||
error: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
code: {
|
||||
type: 'string',
|
||||
description: 'Machine-readable error code',
|
||||
example: 'VALIDATION_ERROR',
|
||||
},
|
||||
message: {
|
||||
type: 'string',
|
||||
description: 'Human-readable error message',
|
||||
example: 'Invalid request parameters',
|
||||
},
|
||||
},
|
||||
required: ['code', 'message'],
|
||||
},
|
||||
},
|
||||
required: ['success', 'error'],
|
||||
},
|
||||
// Common service health status
|
||||
ServiceHealth: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
status: {
|
||||
type: 'string',
|
||||
enum: ['healthy', 'degraded', 'unhealthy'],
|
||||
},
|
||||
latency: {
|
||||
type: 'number',
|
||||
description: 'Response time in milliseconds',
|
||||
},
|
||||
message: {
|
||||
type: 'string',
|
||||
description: 'Additional status information',
|
||||
},
|
||||
details: {
|
||||
type: 'object',
|
||||
description: 'Service-specific details',
|
||||
},
|
||||
},
|
||||
required: ['status'],
|
||||
},
|
||||
// Achievement schema
|
||||
Achievement: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
achievement_id: {
|
||||
type: 'integer',
|
||||
example: 1,
|
||||
},
|
||||
name: {
|
||||
type: 'string',
|
||||
example: 'First-Upload',
|
||||
},
|
||||
description: {
|
||||
type: 'string',
|
||||
example: 'Upload your first flyer',
|
||||
},
|
||||
icon: {
|
||||
type: 'string',
|
||||
example: 'upload-cloud',
|
||||
},
|
||||
points_value: {
|
||||
type: 'integer',
|
||||
example: 25,
|
||||
},
|
||||
created_at: {
|
||||
type: 'string',
|
||||
format: 'date-time',
|
||||
},
|
||||
},
|
||||
},
|
||||
// User achievement (with achieved_at)
|
||||
UserAchievement: {
|
||||
allOf: [
|
||||
{ $ref: '#/components/schemas/Achievement' },
|
||||
{
|
||||
type: 'object',
|
||||
properties: {
|
||||
user_id: {
|
||||
type: 'string',
|
||||
format: 'uuid',
|
||||
},
|
||||
achieved_at: {
|
||||
type: 'string',
|
||||
format: 'date-time',
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
// Leaderboard entry
|
||||
LeaderboardUser: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
user_id: {
|
||||
type: 'string',
|
||||
format: 'uuid',
|
||||
},
|
||||
full_name: {
|
||||
type: 'string',
|
||||
example: 'John Doe',
|
||||
},
|
||||
avatar_url: {
|
||||
type: 'string',
|
||||
nullable: true,
|
||||
},
|
||||
points: {
|
||||
type: 'integer',
|
||||
example: 150,
|
||||
},
|
||||
rank: {
|
||||
type: 'integer',
|
||||
example: 1,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
tags: [
|
||||
{
|
||||
name: 'Health',
|
||||
description: 'Server health and readiness checks',
|
||||
},
|
||||
{
|
||||
name: 'Auth',
|
||||
description: 'Authentication and authorization',
|
||||
},
|
||||
{
|
||||
name: 'Users',
|
||||
description: 'User profile management',
|
||||
},
|
||||
{
|
||||
name: 'Achievements',
|
||||
description: 'Gamification and leaderboards',
|
||||
},
|
||||
{
|
||||
name: 'Flyers',
|
||||
description: 'Flyer uploads and retrieval',
|
||||
},
|
||||
{
|
||||
name: 'Recipes',
|
||||
description: 'Recipe management',
|
||||
},
|
||||
{
|
||||
name: 'Budgets',
|
||||
description: 'Budget tracking and analysis',
|
||||
},
|
||||
{
|
||||
name: 'Admin',
|
||||
description: 'Administrative operations (requires admin role)',
|
||||
},
|
||||
{
|
||||
name: 'System',
|
||||
description: 'System status and monitoring',
|
||||
},
|
||||
],
|
||||
},
|
||||
// Path to the API routes files with JSDoc annotations
|
||||
apis: ['./src/routes/*.ts'],
|
||||
};
|
||||
|
||||
export const swaggerSpec = swaggerJsdoc(options);
|
||||
@@ -119,6 +119,27 @@ router.use(passport.authenticate('jwt', { session: false }), isAdmin);
|
||||
|
||||
// --- Admin Routes ---
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /admin/corrections:
|
||||
* get:
|
||||
* tags: [Admin]
|
||||
* summary: Get suggested corrections
|
||||
* description: Retrieve all suggested corrections for review. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of suggested corrections
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SuccessResponse'
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
*/
|
||||
router.get('/corrections', validateRequest(emptySchema), async (req, res, next: NextFunction) => {
|
||||
try {
|
||||
const corrections = await db.adminRepo.getSuggestedCorrections(req.log);
|
||||
@@ -129,6 +150,23 @@ router.get('/corrections', validateRequest(emptySchema), async (req, res, next:
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /admin/review/flyers:
|
||||
* get:
|
||||
* tags: [Admin]
|
||||
* summary: Get flyers for review
|
||||
* description: Retrieve flyers pending admin review. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of flyers for review
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
*/
|
||||
router.get('/review/flyers', validateRequest(emptySchema), async (req, res, next: NextFunction) => {
|
||||
try {
|
||||
req.log.debug('Fetching flyers for review via adminRepo');
|
||||
@@ -144,6 +182,23 @@ router.get('/review/flyers', validateRequest(emptySchema), async (req, res, next
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /admin/brands:
|
||||
* get:
|
||||
* tags: [Admin]
|
||||
* summary: Get all brands
|
||||
* description: Retrieve all brands. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of brands
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
*/
|
||||
router.get('/brands', validateRequest(emptySchema), async (req, res, next: NextFunction) => {
|
||||
try {
|
||||
const brands = await db.flyerRepo.getAllBrands(req.log);
|
||||
@@ -154,6 +209,23 @@ router.get('/brands', validateRequest(emptySchema), async (req, res, next: NextF
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /admin/stats:
|
||||
* get:
|
||||
* tags: [Admin]
|
||||
* summary: Get application stats
|
||||
* description: Retrieve overall application statistics. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Application statistics
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
*/
|
||||
router.get('/stats', validateRequest(emptySchema), async (req, res, next: NextFunction) => {
|
||||
try {
|
||||
const stats = await db.adminRepo.getApplicationStats(req.log);
|
||||
@@ -164,6 +236,23 @@ router.get('/stats', validateRequest(emptySchema), async (req, res, next: NextFu
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /admin/stats/daily:
|
||||
* get:
|
||||
* tags: [Admin]
|
||||
* summary: Get daily statistics
|
||||
* description: Retrieve daily statistics for the last 30 days. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Daily statistics for last 30 days
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
*/
|
||||
router.get('/stats/daily', validateRequest(emptySchema), async (req, res, next: NextFunction) => {
|
||||
try {
|
||||
const dailyStats = await db.adminRepo.getDailyStatsForLast30Days(req.log);
|
||||
@@ -174,6 +263,32 @@ router.get('/stats/daily', validateRequest(emptySchema), async (req, res, next:
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /admin/corrections/{id}/approve:
|
||||
* post:
|
||||
* tags: [Admin]
|
||||
* summary: Approve a correction
|
||||
* description: Approve a suggested correction. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Correction ID
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Correction approved successfully
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
* 404:
|
||||
* description: Correction not found
|
||||
*/
|
||||
router.post(
|
||||
'/corrections/:id/approve',
|
||||
validateRequest(numericIdParam('id')),
|
||||
@@ -190,6 +305,32 @@ router.post(
|
||||
},
|
||||
);
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /admin/corrections/{id}/reject:
|
||||
* post:
|
||||
* tags: [Admin]
|
||||
* summary: Reject a correction
|
||||
* description: Reject a suggested correction. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Correction ID
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Correction rejected successfully
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
* 404:
|
||||
* description: Correction not found
|
||||
*/
|
||||
router.post(
|
||||
'/corrections/:id/reject',
|
||||
validateRequest(numericIdParam('id')),
|
||||
@@ -206,6 +347,44 @@ router.post(
|
||||
},
|
||||
);
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /admin/corrections/{id}:
|
||||
* put:
|
||||
* tags: [Admin]
|
||||
* summary: Update a correction
|
||||
* description: Update a suggested correction's value. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Correction ID
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - suggested_value
|
||||
* properties:
|
||||
* suggested_value:
|
||||
* type: string
|
||||
* description: New suggested value
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Correction updated successfully
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
* 404:
|
||||
* description: Correction not found
|
||||
*/
|
||||
router.put(
|
||||
'/corrections/:id',
|
||||
validateRequest(updateCorrectionSchema),
|
||||
@@ -226,6 +405,44 @@ router.put(
|
||||
},
|
||||
);
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /admin/recipes/{id}/status:
|
||||
* put:
|
||||
* tags: [Admin]
|
||||
* summary: Update recipe status
|
||||
* description: Update a recipe's publication status. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Recipe ID
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - status
|
||||
* properties:
|
||||
* status:
|
||||
* type: string
|
||||
* enum: [private, pending_review, public, rejected]
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Recipe status updated successfully
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
* 404:
|
||||
* description: Recipe not found
|
||||
*/
|
||||
router.put(
|
||||
'/recipes/:id/status',
|
||||
validateRequest(updateRecipeStatusSchema),
|
||||
@@ -242,6 +459,47 @@ router.put(
|
||||
},
|
||||
);
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /admin/brands/{id}/logo:
|
||||
* post:
|
||||
* tags: [Admin]
|
||||
* summary: Upload brand logo
|
||||
* description: Upload or update a brand's logo image. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Brand ID
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* multipart/form-data:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - logoImage
|
||||
* properties:
|
||||
* logoImage:
|
||||
* type: string
|
||||
* format: binary
|
||||
* description: Logo image file (max 2MB)
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Brand logo updated successfully
|
||||
* 400:
|
||||
* description: Invalid file or missing logo image
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
* 404:
|
||||
* description: Brand not found
|
||||
*/
|
||||
router.post(
|
||||
'/brands/:id/logo',
|
||||
adminUploadLimiter,
|
||||
@@ -274,6 +532,23 @@ router.post(
|
||||
},
|
||||
);
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /admin/unmatched-items:
|
||||
* get:
|
||||
* tags: [Admin]
|
||||
* summary: Get unmatched flyer items
|
||||
* description: Retrieve flyer items that couldn't be matched to master items. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of unmatched flyer items
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
*/
|
||||
router.get(
|
||||
'/unmatched-items',
|
||||
validateRequest(emptySchema),
|
||||
@@ -289,7 +564,30 @@ router.get(
|
||||
);
|
||||
|
||||
/**
|
||||
* DELETE /api/admin/recipes/:recipeId - Admin endpoint to delete any recipe.
|
||||
* @openapi
|
||||
* /admin/recipes/{recipeId}:
|
||||
* delete:
|
||||
* tags: [Admin]
|
||||
* summary: Delete a recipe
|
||||
* description: Admin endpoint to delete any recipe. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: recipeId
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Recipe ID
|
||||
* responses:
|
||||
* 204:
|
||||
* description: Recipe deleted successfully
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
* 404:
|
||||
* description: Recipe not found
|
||||
*/
|
||||
router.delete(
|
||||
'/recipes/:recipeId',
|
||||
@@ -310,7 +608,30 @@ router.delete(
|
||||
);
|
||||
|
||||
/**
|
||||
* DELETE /api/admin/flyers/:flyerId - Admin endpoint to delete a flyer and its items.
|
||||
* @openapi
|
||||
* /admin/flyers/{flyerId}:
|
||||
* delete:
|
||||
* tags: [Admin]
|
||||
* summary: Delete a flyer
|
||||
* description: Admin endpoint to delete a flyer and its items. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: flyerId
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Flyer ID
|
||||
* responses:
|
||||
* 204:
|
||||
* description: Flyer deleted successfully
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
* 404:
|
||||
* description: Flyer not found
|
||||
*/
|
||||
router.delete(
|
||||
'/flyers/:flyerId',
|
||||
@@ -328,6 +649,44 @@ router.delete(
|
||||
},
|
||||
);
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /admin/comments/{id}/status:
|
||||
* put:
|
||||
* tags: [Admin]
|
||||
* summary: Update comment status
|
||||
* description: Update a recipe comment's visibility status. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Comment ID
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - status
|
||||
* properties:
|
||||
* status:
|
||||
* type: string
|
||||
* enum: [visible, hidden, reported]
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Comment status updated successfully
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
* 404:
|
||||
* description: Comment not found
|
||||
*/
|
||||
router.put(
|
||||
'/comments/:id/status',
|
||||
validateRequest(updateCommentStatusSchema),
|
||||
@@ -348,6 +707,23 @@ router.put(
|
||||
},
|
||||
);
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /admin/users:
|
||||
* get:
|
||||
* tags: [Admin]
|
||||
* summary: Get all users
|
||||
* description: Retrieve a list of all users. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of all users
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
*/
|
||||
router.get('/users', validateRequest(emptySchema), async (req, res, next: NextFunction) => {
|
||||
try {
|
||||
const users = await db.adminRepo.getAllUsers(req.log);
|
||||
@@ -358,6 +734,36 @@ router.get('/users', validateRequest(emptySchema), async (req, res, next: NextFu
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /admin/activity-log:
|
||||
* get:
|
||||
* tags: [Admin]
|
||||
* summary: Get activity log
|
||||
* description: Retrieve system activity log with pagination. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: query
|
||||
* name: limit
|
||||
* schema:
|
||||
* type: integer
|
||||
* default: 50
|
||||
* description: Maximum number of entries to return
|
||||
* - in: query
|
||||
* name: offset
|
||||
* schema:
|
||||
* type: integer
|
||||
* default: 0
|
||||
* description: Number of entries to skip
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Activity log entries
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
*/
|
||||
router.get(
|
||||
'/activity-log',
|
||||
validateRequest(activityLogSchema),
|
||||
@@ -376,6 +782,33 @@ router.get(
|
||||
},
|
||||
);
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /admin/users/{id}:
|
||||
* get:
|
||||
* tags: [Admin]
|
||||
* summary: Get user by ID
|
||||
* description: Retrieve a specific user's profile. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* format: uuid
|
||||
* description: User ID
|
||||
* responses:
|
||||
* 200:
|
||||
* description: User profile
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
* 404:
|
||||
* description: User not found
|
||||
*/
|
||||
router.get(
|
||||
'/users/:id',
|
||||
validateRequest(uuidParamSchema('id', 'A valid user ID is required.')),
|
||||
@@ -392,6 +825,45 @@ router.get(
|
||||
},
|
||||
);
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /admin/users/{id}:
|
||||
* put:
|
||||
* tags: [Admin]
|
||||
* summary: Update user role
|
||||
* description: Update a user's role. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* format: uuid
|
||||
* description: User ID
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - role
|
||||
* properties:
|
||||
* role:
|
||||
* type: string
|
||||
* enum: [user, admin]
|
||||
* responses:
|
||||
* 200:
|
||||
* description: User role updated successfully
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
* 404:
|
||||
* description: User not found
|
||||
*/
|
||||
router.put(
|
||||
'/users/:id',
|
||||
validateRequest(updateUserRoleSchema),
|
||||
@@ -408,6 +880,33 @@ router.put(
|
||||
},
|
||||
);
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /admin/users/{id}:
|
||||
* delete:
|
||||
* tags: [Admin]
|
||||
* summary: Delete a user
|
||||
* description: Delete a user account. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* format: uuid
|
||||
* description: User ID
|
||||
* responses:
|
||||
* 204:
|
||||
* description: User deleted successfully
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
* 404:
|
||||
* description: User not found
|
||||
*/
|
||||
router.delete(
|
||||
'/users/:id',
|
||||
validateRequest(uuidParamSchema('id', 'A valid user ID is required.')),
|
||||
@@ -426,8 +925,21 @@ router.delete(
|
||||
);
|
||||
|
||||
/**
|
||||
* POST /api/admin/trigger/daily-deal-check - Manually trigger the daily deal check job.
|
||||
* This is useful for testing or forcing an update without waiting for the cron schedule.
|
||||
* @openapi
|
||||
* /admin/trigger/daily-deal-check:
|
||||
* post:
|
||||
* tags: [Admin]
|
||||
* summary: Trigger daily deal check
|
||||
* description: Manually trigger the daily deal check job. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* responses:
|
||||
* 202:
|
||||
* description: Job triggered successfully
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
*/
|
||||
router.post(
|
||||
'/trigger/daily-deal-check',
|
||||
@@ -459,8 +971,21 @@ router.post(
|
||||
);
|
||||
|
||||
/**
|
||||
* POST /api/admin/trigger/analytics-report - Manually enqueue a job to generate the daily analytics report.
|
||||
* This is useful for testing or re-generating a report without waiting for the cron schedule.
|
||||
* @openapi
|
||||
* /admin/trigger/analytics-report:
|
||||
* post:
|
||||
* tags: [Admin]
|
||||
* summary: Trigger analytics report
|
||||
* description: Manually enqueue a job to generate the daily analytics report. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* responses:
|
||||
* 202:
|
||||
* description: Job enqueued successfully
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
*/
|
||||
router.post(
|
||||
'/trigger/analytics-report',
|
||||
@@ -489,8 +1014,30 @@ router.post(
|
||||
);
|
||||
|
||||
/**
|
||||
* POST /api/admin/flyers/:flyerId/cleanup - Enqueue a job to clean up a flyer's files.
|
||||
* This is triggered by an admin after they have verified the flyer processing was successful.
|
||||
* @openapi
|
||||
* /admin/flyers/{flyerId}/cleanup:
|
||||
* post:
|
||||
* tags: [Admin]
|
||||
* summary: Trigger flyer file cleanup
|
||||
* description: Enqueue a job to clean up a flyer's files. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: flyerId
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Flyer ID
|
||||
* responses:
|
||||
* 202:
|
||||
* description: Cleanup job enqueued successfully
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
* 404:
|
||||
* description: Flyer not found
|
||||
*/
|
||||
router.post(
|
||||
'/flyers/:flyerId/cleanup',
|
||||
@@ -520,8 +1067,21 @@ router.post(
|
||||
);
|
||||
|
||||
/**
|
||||
* POST /api/admin/trigger/failing-job - Enqueue a test job designed to fail.
|
||||
* This is for testing the retry mechanism and Bull Board UI.
|
||||
* @openapi
|
||||
* /admin/trigger/failing-job:
|
||||
* post:
|
||||
* tags: [Admin]
|
||||
* summary: Trigger failing test job
|
||||
* description: Enqueue a test job designed to fail for testing retry mechanisms. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* responses:
|
||||
* 202:
|
||||
* description: Failing test job enqueued successfully
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
*/
|
||||
router.post(
|
||||
'/trigger/failing-job',
|
||||
@@ -549,8 +1109,21 @@ router.post(
|
||||
);
|
||||
|
||||
/**
|
||||
* POST /api/admin/system/clear-geocode-cache - Clears the Redis cache for geocoded addresses.
|
||||
* Requires admin privileges.
|
||||
* @openapi
|
||||
* /admin/system/clear-geocode-cache:
|
||||
* post:
|
||||
* tags: [Admin]
|
||||
* summary: Clear geocode cache
|
||||
* description: Clears the Redis cache for geocoded addresses. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Cache cleared successfully
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
*/
|
||||
router.post(
|
||||
'/system/clear-geocode-cache',
|
||||
@@ -575,8 +1148,21 @@ router.post(
|
||||
);
|
||||
|
||||
/**
|
||||
* GET /api/admin/workers/status - Get the current running status of all BullMQ workers.
|
||||
* This is useful for a system health dashboard to see if any workers have crashed.
|
||||
* @openapi
|
||||
* /admin/workers/status:
|
||||
* get:
|
||||
* tags: [Admin]
|
||||
* summary: Get worker statuses
|
||||
* description: Get the current running status of all BullMQ workers. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Worker status information
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
*/
|
||||
router.get(
|
||||
'/workers/status',
|
||||
@@ -593,8 +1179,21 @@ router.get(
|
||||
);
|
||||
|
||||
/**
|
||||
* GET /api/admin/queues/status - Get job counts for all BullMQ queues.
|
||||
* This is useful for monitoring the health and backlog of background jobs.
|
||||
* @openapi
|
||||
* /admin/queues/status:
|
||||
* get:
|
||||
* tags: [Admin]
|
||||
* summary: Get queue statuses
|
||||
* description: Get job counts for all BullMQ queues. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Queue status information
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
*/
|
||||
router.get(
|
||||
'/queues/status',
|
||||
@@ -611,7 +1210,37 @@ router.get(
|
||||
);
|
||||
|
||||
/**
|
||||
* POST /api/admin/jobs/:queueName/:jobId/retry - Retries a specific failed job.
|
||||
* @openapi
|
||||
* /admin/jobs/{queueName}/{jobId}/retry:
|
||||
* post:
|
||||
* tags: [Admin]
|
||||
* summary: Retry a failed job
|
||||
* description: Retries a specific failed job in a queue. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: queueName
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* enum: [flyer-processing, email-sending, analytics-reporting, file-cleanup, weekly-analytics-reporting]
|
||||
* description: Queue name
|
||||
* - in: path
|
||||
* name: jobId
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* description: Job ID
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Job marked for retry successfully
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
* 404:
|
||||
* description: Job not found
|
||||
*/
|
||||
router.post(
|
||||
'/jobs/:queueName/:jobId/retry',
|
||||
@@ -634,7 +1263,21 @@ router.post(
|
||||
);
|
||||
|
||||
/**
|
||||
* POST /api/admin/trigger/weekly-analytics - Manually trigger the weekly analytics report job.
|
||||
* @openapi
|
||||
* /admin/trigger/weekly-analytics:
|
||||
* post:
|
||||
* tags: [Admin]
|
||||
* summary: Trigger weekly analytics
|
||||
* description: Manually trigger the weekly analytics report job. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* responses:
|
||||
* 202:
|
||||
* description: Job enqueued successfully
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
*/
|
||||
router.post(
|
||||
'/trigger/weekly-analytics',
|
||||
@@ -657,9 +1300,21 @@ router.post(
|
||||
);
|
||||
|
||||
/**
|
||||
* POST /api/admin/system/clear-cache - Clears the application data cache.
|
||||
* Clears cached flyers, brands, and stats data from Redis.
|
||||
* Requires admin privileges.
|
||||
* @openapi
|
||||
* /admin/system/clear-cache:
|
||||
* post:
|
||||
* tags: [Admin]
|
||||
* summary: Clear application cache
|
||||
* description: Clears cached flyers, brands, and stats data from Redis. Requires admin role.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Cache cleared successfully with details
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* 403:
|
||||
* description: Forbidden - admin role required
|
||||
*/
|
||||
router.post(
|
||||
'/system/clear-cache',
|
||||
|
||||
@@ -79,7 +79,68 @@ const resetPasswordSchema = z.object({
|
||||
|
||||
// --- Authentication Routes ---
|
||||
|
||||
// Registration Route
|
||||
/**
|
||||
* @openapi
|
||||
* /auth/register:
|
||||
* post:
|
||||
* summary: Register a new user
|
||||
* description: Creates a new user account and returns authentication tokens.
|
||||
* tags:
|
||||
* - Auth
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - email
|
||||
* - password
|
||||
* properties:
|
||||
* email:
|
||||
* type: string
|
||||
* format: email
|
||||
* example: user@example.com
|
||||
* password:
|
||||
* type: string
|
||||
* format: password
|
||||
* minLength: 8
|
||||
* description: Must be at least 8 characters with good entropy
|
||||
* full_name:
|
||||
* type: string
|
||||
* example: John Doe
|
||||
* avatar_url:
|
||||
* type: string
|
||||
* format: uri
|
||||
* responses:
|
||||
* 201:
|
||||
* description: User registered successfully
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* data:
|
||||
* type: object
|
||||
* properties:
|
||||
* message:
|
||||
* type: string
|
||||
* example: User registered successfully!
|
||||
* userprofile:
|
||||
* type: object
|
||||
* token:
|
||||
* type: string
|
||||
* description: JWT access token
|
||||
* 409:
|
||||
* description: Email already registered
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/ErrorResponse'
|
||||
*/
|
||||
router.post(
|
||||
'/register',
|
||||
registerLimiter,
|
||||
@@ -125,7 +186,60 @@ router.post(
|
||||
},
|
||||
);
|
||||
|
||||
// Login Route
|
||||
/**
|
||||
* @openapi
|
||||
* /auth/login:
|
||||
* post:
|
||||
* summary: Login with email and password
|
||||
* description: Authenticates user credentials and returns JWT tokens.
|
||||
* tags:
|
||||
* - Auth
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - email
|
||||
* - password
|
||||
* properties:
|
||||
* email:
|
||||
* type: string
|
||||
* format: email
|
||||
* example: user@example.com
|
||||
* password:
|
||||
* type: string
|
||||
* format: password
|
||||
* rememberMe:
|
||||
* type: boolean
|
||||
* description: If true, refresh token lasts 30 days
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Login successful
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* data:
|
||||
* type: object
|
||||
* properties:
|
||||
* userprofile:
|
||||
* type: object
|
||||
* token:
|
||||
* type: string
|
||||
* description: JWT access token
|
||||
* 401:
|
||||
* description: Invalid credentials
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/ErrorResponse'
|
||||
*/
|
||||
router.post(
|
||||
'/login',
|
||||
loginLimiter,
|
||||
@@ -181,7 +295,45 @@ router.post(
|
||||
},
|
||||
);
|
||||
|
||||
// Route to request a password reset
|
||||
/**
|
||||
* @openapi
|
||||
* /auth/forgot-password:
|
||||
* post:
|
||||
* summary: Request password reset
|
||||
* description: Sends a password reset email if the account exists. Always returns success to prevent email enumeration.
|
||||
* tags:
|
||||
* - Auth
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - email
|
||||
* properties:
|
||||
* email:
|
||||
* type: string
|
||||
* format: email
|
||||
* example: user@example.com
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Request processed (email sent if account exists)
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* data:
|
||||
* type: object
|
||||
* properties:
|
||||
* message:
|
||||
* type: string
|
||||
* example: If an account with that email exists, a password reset link has been sent.
|
||||
*/
|
||||
router.post(
|
||||
'/forgot-password',
|
||||
forgotPasswordLimiter,
|
||||
@@ -209,7 +361,41 @@ router.post(
|
||||
},
|
||||
);
|
||||
|
||||
// Route to reset the password using a token
|
||||
/**
|
||||
* @openapi
|
||||
* /auth/reset-password:
|
||||
* post:
|
||||
* summary: Reset password with token
|
||||
* description: Resets the user's password using a valid reset token from the forgot-password email.
|
||||
* tags:
|
||||
* - Auth
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - token
|
||||
* - newPassword
|
||||
* properties:
|
||||
* token:
|
||||
* type: string
|
||||
* description: Password reset token from email
|
||||
* newPassword:
|
||||
* type: string
|
||||
* format: password
|
||||
* minLength: 8
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Password reset successful
|
||||
* 400:
|
||||
* description: Invalid or expired token
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/ErrorResponse'
|
||||
*/
|
||||
router.post(
|
||||
'/reset-password',
|
||||
resetPasswordLimiter,
|
||||
@@ -240,7 +426,36 @@ router.post(
|
||||
},
|
||||
);
|
||||
|
||||
// New Route to refresh the access token
|
||||
/**
|
||||
* @openapi
|
||||
* /auth/refresh-token:
|
||||
* post:
|
||||
* summary: Refresh access token
|
||||
* description: Uses the refresh token cookie to issue a new access token.
|
||||
* tags:
|
||||
* - Auth
|
||||
* responses:
|
||||
* 200:
|
||||
* description: New access token issued
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* data:
|
||||
* type: object
|
||||
* properties:
|
||||
* token:
|
||||
* type: string
|
||||
* description: New JWT access token
|
||||
* 401:
|
||||
* description: Refresh token not found
|
||||
* 403:
|
||||
* description: Invalid or expired refresh token
|
||||
*/
|
||||
router.post(
|
||||
'/refresh-token',
|
||||
refreshTokenLimiter,
|
||||
@@ -264,9 +479,30 @@ router.post(
|
||||
);
|
||||
|
||||
/**
|
||||
* POST /api/auth/logout - Logs the user out by invalidating their refresh token.
|
||||
* It clears the refresh token from the database and instructs the client to
|
||||
* expire the `refreshToken` cookie.
|
||||
* @openapi
|
||||
* /auth/logout:
|
||||
* post:
|
||||
* summary: Logout user
|
||||
* description: Invalidates the refresh token and clears the cookie.
|
||||
* tags:
|
||||
* - Auth
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Logged out successfully
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* data:
|
||||
* type: object
|
||||
* properties:
|
||||
* message:
|
||||
* type: string
|
||||
* example: Logged out successfully.
|
||||
*/
|
||||
router.post('/logout', logoutLimiter, async (req: Request, res: Response) => {
|
||||
const { refreshToken } = req.cookies;
|
||||
@@ -288,6 +524,29 @@ router.post('/logout', logoutLimiter, async (req: Request, res: Response) => {
|
||||
|
||||
// --- OAuth Routes ---
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /auth/google:
|
||||
* get:
|
||||
* summary: Initiate Google OAuth
|
||||
* description: Redirects to Google for authentication. After success, redirects back to the app with a token.
|
||||
* tags:
|
||||
* - Auth
|
||||
* responses:
|
||||
* 302:
|
||||
* description: Redirects to Google OAuth consent screen
|
||||
*
|
||||
* /auth/github:
|
||||
* get:
|
||||
* summary: Initiate GitHub OAuth
|
||||
* description: Redirects to GitHub for authentication. After success, redirects back to the app with a token.
|
||||
* tags:
|
||||
* - Auth
|
||||
* responses:
|
||||
* 302:
|
||||
* description: Redirects to GitHub OAuth consent screen
|
||||
*/
|
||||
|
||||
/**
|
||||
* Handles the OAuth callback after successful authentication.
|
||||
* Generates tokens and redirects to the frontend with the access token.
|
||||
|
||||
@@ -46,7 +46,23 @@ router.use(passport.authenticate('jwt', { session: false }));
|
||||
router.use(budgetUpdateLimiter);
|
||||
|
||||
/**
|
||||
* GET /api/budgets - Get all budgets for the authenticated user.
|
||||
* @openapi
|
||||
* /budgets:
|
||||
* get:
|
||||
* tags: [Budgets]
|
||||
* summary: Get all budgets
|
||||
* description: Retrieve all budgets for the authenticated user.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of user budgets
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SuccessResponse'
|
||||
* 401:
|
||||
* description: Unauthorized - invalid or missing token
|
||||
*/
|
||||
router.get('/', async (req: Request, res: Response, next: NextFunction) => {
|
||||
const userProfile = req.user as UserProfile;
|
||||
@@ -60,7 +76,52 @@ router.get('/', async (req: Request, res: Response, next: NextFunction) => {
|
||||
});
|
||||
|
||||
/**
|
||||
* POST /api/budgets - Create a new budget for the authenticated user.
|
||||
* @openapi
|
||||
* /budgets:
|
||||
* post:
|
||||
* tags: [Budgets]
|
||||
* summary: Create budget
|
||||
* description: Create a new budget for the authenticated user.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - name
|
||||
* - amount_cents
|
||||
* - period
|
||||
* - start_date
|
||||
* properties:
|
||||
* name:
|
||||
* type: string
|
||||
* description: Budget name
|
||||
* amount_cents:
|
||||
* type: integer
|
||||
* minimum: 1
|
||||
* description: Budget amount in cents
|
||||
* period:
|
||||
* type: string
|
||||
* enum: [weekly, monthly]
|
||||
* description: Budget period
|
||||
* start_date:
|
||||
* type: string
|
||||
* format: date
|
||||
* description: Budget start date (YYYY-MM-DD)
|
||||
* responses:
|
||||
* 201:
|
||||
* description: Budget created
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SuccessResponse'
|
||||
* 400:
|
||||
* description: Validation error
|
||||
* 401:
|
||||
* description: Unauthorized - invalid or missing token
|
||||
*/
|
||||
router.post(
|
||||
'/',
|
||||
@@ -80,7 +141,56 @@ router.post(
|
||||
);
|
||||
|
||||
/**
|
||||
* PUT /api/budgets/:id - Update an existing budget.
|
||||
* @openapi
|
||||
* /budgets/{id}:
|
||||
* put:
|
||||
* tags: [Budgets]
|
||||
* summary: Update budget
|
||||
* description: Update an existing budget.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Budget ID
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* name:
|
||||
* type: string
|
||||
* description: Budget name
|
||||
* amount_cents:
|
||||
* type: integer
|
||||
* minimum: 1
|
||||
* description: Budget amount in cents
|
||||
* period:
|
||||
* type: string
|
||||
* enum: [weekly, monthly]
|
||||
* description: Budget period
|
||||
* start_date:
|
||||
* type: string
|
||||
* format: date
|
||||
* description: Budget start date (YYYY-MM-DD)
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Budget updated
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SuccessResponse'
|
||||
* 400:
|
||||
* description: Validation error - at least one field required
|
||||
* 401:
|
||||
* description: Unauthorized - invalid or missing token
|
||||
* 404:
|
||||
* description: Budget not found
|
||||
*/
|
||||
router.put(
|
||||
'/:id',
|
||||
@@ -108,7 +218,28 @@ router.put(
|
||||
);
|
||||
|
||||
/**
|
||||
* DELETE /api/budgets/:id - Delete a budget.
|
||||
* @openapi
|
||||
* /budgets/{id}:
|
||||
* delete:
|
||||
* tags: [Budgets]
|
||||
* summary: Delete budget
|
||||
* description: Delete a budget by ID.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Budget ID
|
||||
* responses:
|
||||
* 204:
|
||||
* description: Budget deleted
|
||||
* 401:
|
||||
* description: Unauthorized - invalid or missing token
|
||||
* 404:
|
||||
* description: Budget not found
|
||||
*/
|
||||
router.delete(
|
||||
'/:id',
|
||||
@@ -131,8 +262,40 @@ router.delete(
|
||||
);
|
||||
|
||||
/**
|
||||
* GET /api/spending-analysis - Get spending breakdown by category for a date range.
|
||||
* Query params: startDate (YYYY-MM-DD), endDate (YYYY-MM-DD)
|
||||
* @openapi
|
||||
* /budgets/spending-analysis:
|
||||
* get:
|
||||
* tags: [Budgets]
|
||||
* summary: Get spending analysis
|
||||
* description: Get spending breakdown by category for a date range.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: query
|
||||
* name: startDate
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* format: date
|
||||
* description: Start date (YYYY-MM-DD)
|
||||
* - in: query
|
||||
* name: endDate
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* format: date
|
||||
* description: End date (YYYY-MM-DD)
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Spending breakdown by category
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SuccessResponse'
|
||||
* 400:
|
||||
* description: Invalid date format
|
||||
* 401:
|
||||
* description: Unauthorized - invalid or missing token
|
||||
*/
|
||||
router.get(
|
||||
'/spending-analysis',
|
||||
|
||||
@@ -23,9 +23,23 @@ const bestWatchedPricesSchema = z.object({
|
||||
router.use(passport.authenticate('jwt', { session: false }));
|
||||
|
||||
/**
|
||||
* @route GET /api/users/deals/best-watched-prices
|
||||
* @description Fetches the best current sale price for each of the authenticated user's watched items.
|
||||
* @access Private
|
||||
* @openapi
|
||||
* /deals/best-watched-prices:
|
||||
* get:
|
||||
* tags: [Deals]
|
||||
* summary: Get best prices for watched items
|
||||
* description: Fetches the best current sale price for each of the authenticated user's watched items.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of best prices for watched items
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SuccessResponse'
|
||||
* 401:
|
||||
* description: Unauthorized - invalid or missing token
|
||||
*/
|
||||
router.get(
|
||||
'/best-watched-prices',
|
||||
|
||||
@@ -48,7 +48,54 @@ const trackItemSchema = z.object({
|
||||
});
|
||||
|
||||
/**
|
||||
* GET /api/flyers - Get a paginated list of all flyers.
|
||||
* @openapi
|
||||
* /flyers:
|
||||
* get:
|
||||
* summary: Get all flyers
|
||||
* description: Returns a paginated list of all flyers.
|
||||
* tags:
|
||||
* - Flyers
|
||||
* parameters:
|
||||
* - in: query
|
||||
* name: limit
|
||||
* schema:
|
||||
* type: integer
|
||||
* default: 20
|
||||
* description: Maximum number of flyers to return
|
||||
* - in: query
|
||||
* name: offset
|
||||
* schema:
|
||||
* type: integer
|
||||
* default: 0
|
||||
* description: Number of flyers to skip
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of flyers
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* data:
|
||||
* type: array
|
||||
* items:
|
||||
* type: object
|
||||
* properties:
|
||||
* flyer_id:
|
||||
* type: integer
|
||||
* store_id:
|
||||
* type: integer
|
||||
* flyer_name:
|
||||
* type: string
|
||||
* start_date:
|
||||
* type: string
|
||||
* format: date
|
||||
* end_date:
|
||||
* type: string
|
||||
* format: date
|
||||
*/
|
||||
router.get(
|
||||
'/',
|
||||
@@ -70,7 +117,25 @@ router.get(
|
||||
);
|
||||
|
||||
/**
|
||||
* GET /api/flyers/:id - Get a single flyer by its ID.
|
||||
* @openapi
|
||||
* /flyers/{id}:
|
||||
* get:
|
||||
* summary: Get flyer by ID
|
||||
* description: Returns a single flyer by its ID.
|
||||
* tags:
|
||||
* - Flyers
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: The flyer ID
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Flyer details
|
||||
* 404:
|
||||
* description: Flyer not found
|
||||
*/
|
||||
router.get(
|
||||
'/:id',
|
||||
@@ -90,7 +155,44 @@ router.get(
|
||||
);
|
||||
|
||||
/**
|
||||
* GET /api/flyers/:id/items - Get all items for a specific flyer.
|
||||
* @openapi
|
||||
* /flyers/{id}/items:
|
||||
* get:
|
||||
* summary: Get flyer items
|
||||
* description: Returns all items (deals) for a specific flyer.
|
||||
* tags:
|
||||
* - Flyers
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: The flyer ID
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of flyer items
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* data:
|
||||
* type: array
|
||||
* items:
|
||||
* type: object
|
||||
* properties:
|
||||
* item_id:
|
||||
* type: integer
|
||||
* item_name:
|
||||
* type: string
|
||||
* price:
|
||||
* type: number
|
||||
* unit:
|
||||
* type: string
|
||||
*/
|
||||
router.get(
|
||||
'/:id/items',
|
||||
@@ -113,7 +215,31 @@ router.get(
|
||||
);
|
||||
|
||||
/**
|
||||
* POST /api/flyers/items/batch-fetch - Get all items for multiple flyers at once.
|
||||
* @openapi
|
||||
* /flyers/items/batch-fetch:
|
||||
* post:
|
||||
* summary: Batch fetch flyer items
|
||||
* description: Returns all items for multiple flyers in a single request.
|
||||
* tags:
|
||||
* - Flyers
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - flyerIds
|
||||
* properties:
|
||||
* flyerIds:
|
||||
* type: array
|
||||
* items:
|
||||
* type: integer
|
||||
* minItems: 1
|
||||
* example: [1, 2, 3]
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Items for all requested flyers
|
||||
*/
|
||||
type BatchFetchRequest = z.infer<typeof batchFetchSchema>;
|
||||
router.post(
|
||||
@@ -135,7 +261,44 @@ router.post(
|
||||
);
|
||||
|
||||
/**
|
||||
* POST /api/flyers/items/batch-count - Get the total number of items for multiple flyers.
|
||||
* @openapi
|
||||
* /flyers/items/batch-count:
|
||||
* post:
|
||||
* summary: Batch count flyer items
|
||||
* description: Returns the total item count for multiple flyers.
|
||||
* tags:
|
||||
* - Flyers
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - flyerIds
|
||||
* properties:
|
||||
* flyerIds:
|
||||
* type: array
|
||||
* items:
|
||||
* type: integer
|
||||
* example: [1, 2, 3]
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Total item count
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* data:
|
||||
* type: object
|
||||
* properties:
|
||||
* count:
|
||||
* type: integer
|
||||
* example: 42
|
||||
*/
|
||||
type BatchCountRequest = z.infer<typeof batchCountSchema>;
|
||||
router.post(
|
||||
@@ -157,7 +320,50 @@ router.post(
|
||||
);
|
||||
|
||||
/**
|
||||
* POST /api/flyers/items/:itemId/track - Tracks a user interaction with a flyer item.
|
||||
* @openapi
|
||||
* /flyers/items/{itemId}/track:
|
||||
* post:
|
||||
* summary: Track item interaction
|
||||
* description: Records a view or click interaction with a flyer item for analytics.
|
||||
* tags:
|
||||
* - Flyers
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: itemId
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: The flyer item ID
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - type
|
||||
* properties:
|
||||
* type:
|
||||
* type: string
|
||||
* enum: [view, click]
|
||||
* description: Type of interaction
|
||||
* responses:
|
||||
* 202:
|
||||
* description: Tracking accepted (fire-and-forget)
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* data:
|
||||
* type: object
|
||||
* properties:
|
||||
* message:
|
||||
* type: string
|
||||
* example: Tracking accepted
|
||||
*/
|
||||
router.post(
|
||||
'/items/:itemId/track',
|
||||
|
||||
@@ -39,8 +39,28 @@ const awardAchievementSchema = z.object({
|
||||
// --- Public Routes ---
|
||||
|
||||
/**
|
||||
* GET /api/achievements - Get the master list of all available achievements.
|
||||
* This is a public endpoint.
|
||||
* @openapi
|
||||
* /achievements:
|
||||
* get:
|
||||
* summary: Get all achievements
|
||||
* description: Returns the master list of all available achievements in the system. This is a public endpoint.
|
||||
* tags:
|
||||
* - Achievements
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of all achievements
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* data:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: '#/components/schemas/Achievement'
|
||||
*/
|
||||
router.get('/', publicReadLimiter, async (req, res, next: NextFunction) => {
|
||||
try {
|
||||
@@ -53,8 +73,37 @@ router.get('/', publicReadLimiter, async (req, res, next: NextFunction) => {
|
||||
});
|
||||
|
||||
/**
|
||||
* GET /api/achievements/leaderboard - Get the top users by points.
|
||||
* This is a public endpoint.
|
||||
* @openapi
|
||||
* /achievements/leaderboard:
|
||||
* get:
|
||||
* summary: Get leaderboard
|
||||
* description: Returns the top users ranked by total points earned from achievements. This is a public endpoint.
|
||||
* tags:
|
||||
* - Achievements
|
||||
* parameters:
|
||||
* - in: query
|
||||
* name: limit
|
||||
* schema:
|
||||
* type: integer
|
||||
* minimum: 1
|
||||
* maximum: 50
|
||||
* default: 10
|
||||
* description: Maximum number of users to return
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Leaderboard entries
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* data:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: '#/components/schemas/LeaderboardUser'
|
||||
*/
|
||||
router.get(
|
||||
'/leaderboard',
|
||||
@@ -77,8 +126,36 @@ router.get(
|
||||
// --- Authenticated User Routes ---
|
||||
|
||||
/**
|
||||
* GET /api/achievements/me - Get all achievements for the authenticated user.
|
||||
* This is a protected endpoint.
|
||||
* @openapi
|
||||
* /achievements/me:
|
||||
* get:
|
||||
* summary: Get my achievements
|
||||
* description: Returns all achievements earned by the authenticated user.
|
||||
* tags:
|
||||
* - Achievements
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of user's earned achievements
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* data:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: '#/components/schemas/UserAchievement'
|
||||
* 401:
|
||||
* description: Unauthorized - JWT token missing or invalid
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/ErrorResponse'
|
||||
*/
|
||||
router.get(
|
||||
'/me',
|
||||
@@ -108,8 +185,55 @@ router.get(
|
||||
adminGamificationRouter.use(passport.authenticate('jwt', { session: false }), isAdmin);
|
||||
|
||||
/**
|
||||
* POST /api/achievements/award - Manually award an achievement to a user.
|
||||
* This is an admin-only endpoint.
|
||||
* @openapi
|
||||
* /achievements/award:
|
||||
* post:
|
||||
* summary: Award achievement to user (Admin only)
|
||||
* description: Manually award an achievement to a specific user. Requires admin role.
|
||||
* tags:
|
||||
* - Achievements
|
||||
* - Admin
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - userId
|
||||
* - achievementName
|
||||
* properties:
|
||||
* userId:
|
||||
* type: string
|
||||
* format: uuid
|
||||
* description: The user ID to award the achievement to
|
||||
* achievementName:
|
||||
* type: string
|
||||
* description: The name of the achievement to award
|
||||
* example: First-Upload
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Achievement awarded successfully
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* data:
|
||||
* type: object
|
||||
* properties:
|
||||
* message:
|
||||
* type: string
|
||||
* example: Successfully awarded 'First-Upload' to user abc123.
|
||||
* 401:
|
||||
* description: Unauthorized - JWT token missing or invalid
|
||||
* 403:
|
||||
* description: Forbidden - User is not an admin
|
||||
*/
|
||||
adminGamificationRouter.post(
|
||||
'/award',
|
||||
|
||||
@@ -127,7 +127,30 @@ async function checkStorage(): Promise<ServiceHealth> {
|
||||
const emptySchema = z.object({});
|
||||
|
||||
/**
|
||||
* GET /api/health/ping - A simple endpoint to check if the server is responsive.
|
||||
* @openapi
|
||||
* /health/ping:
|
||||
* get:
|
||||
* summary: Simple ping endpoint
|
||||
* description: Returns a pong response to verify server is responsive. Use this for basic connectivity checks.
|
||||
* tags:
|
||||
* - Health
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Server is responsive
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* data:
|
||||
* type: object
|
||||
* properties:
|
||||
* message:
|
||||
* type: string
|
||||
* example: pong
|
||||
*/
|
||||
router.get('/ping', validateRequest(emptySchema), (_req: Request, res: Response) => {
|
||||
return sendSuccess(res, { message: 'pong' });
|
||||
@@ -138,13 +161,36 @@ router.get('/ping', validateRequest(emptySchema), (_req: Request, res: Response)
|
||||
// =============================================================================
|
||||
|
||||
/**
|
||||
* GET /api/health/live - Liveness probe for container orchestration.
|
||||
*
|
||||
* Returns 200 OK if the server process is running.
|
||||
* If this fails, the orchestrator should restart the container.
|
||||
*
|
||||
* This endpoint is intentionally simple and has no external dependencies.
|
||||
* It only checks that the Node.js process can handle HTTP requests.
|
||||
* @openapi
|
||||
* /health/live:
|
||||
* get:
|
||||
* summary: Liveness probe
|
||||
* description: |
|
||||
* Returns 200 OK if the server process is running.
|
||||
* If this fails, the orchestrator should restart the container.
|
||||
* This endpoint is intentionally simple and has no external dependencies.
|
||||
* tags:
|
||||
* - Health
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Server process is alive
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* data:
|
||||
* type: object
|
||||
* properties:
|
||||
* status:
|
||||
* type: string
|
||||
* example: ok
|
||||
* timestamp:
|
||||
* type: string
|
||||
* format: date-time
|
||||
*/
|
||||
router.get('/live', validateRequest(emptySchema), (_req: Request, res: Response) => {
|
||||
return sendSuccess(res, {
|
||||
@@ -154,13 +200,54 @@ router.get('/live', validateRequest(emptySchema), (_req: Request, res: Response)
|
||||
});
|
||||
|
||||
/**
|
||||
* GET /api/health/ready - Readiness probe for container orchestration.
|
||||
*
|
||||
* Returns 200 OK if the server is ready to accept traffic.
|
||||
* Checks all critical dependencies (database, Redis).
|
||||
* If this fails, the orchestrator should remove the container from the load balancer.
|
||||
*
|
||||
* Response includes detailed status of each service for debugging.
|
||||
* @openapi
|
||||
* /health/ready:
|
||||
* get:
|
||||
* summary: Readiness probe
|
||||
* description: |
|
||||
* Returns 200 OK if the server is ready to accept traffic.
|
||||
* Checks all critical dependencies (database, Redis, storage).
|
||||
* If this fails, the orchestrator should remove the container from the load balancer.
|
||||
* tags:
|
||||
* - Health
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Server is ready to accept traffic
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* data:
|
||||
* type: object
|
||||
* properties:
|
||||
* status:
|
||||
* type: string
|
||||
* enum: [healthy, degraded, unhealthy]
|
||||
* timestamp:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* uptime:
|
||||
* type: number
|
||||
* description: Server uptime in seconds
|
||||
* services:
|
||||
* type: object
|
||||
* properties:
|
||||
* database:
|
||||
* $ref: '#/components/schemas/ServiceHealth'
|
||||
* redis:
|
||||
* $ref: '#/components/schemas/ServiceHealth'
|
||||
* storage:
|
||||
* $ref: '#/components/schemas/ServiceHealth'
|
||||
* 503:
|
||||
* description: Service is unhealthy and should not receive traffic
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/ErrorResponse'
|
||||
*/
|
||||
router.get('/ready', validateRequest(emptySchema), async (req: Request, res: Response) => {
|
||||
// Check all services in parallel for speed
|
||||
|
||||
@@ -14,7 +14,19 @@ const router = Router();
|
||||
const emptySchema = z.object({});
|
||||
|
||||
/**
|
||||
* GET /api/personalization/master-items - Get the master list of all grocery items.
|
||||
* @openapi
|
||||
* /personalization/master-items:
|
||||
* get:
|
||||
* tags: [Personalization]
|
||||
* summary: Get master items list
|
||||
* description: Get the master list of all grocery items. Response is cached for 1 hour.
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of all master grocery items
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SuccessResponse'
|
||||
*/
|
||||
router.get(
|
||||
'/master-items',
|
||||
@@ -38,7 +50,19 @@ router.get(
|
||||
);
|
||||
|
||||
/**
|
||||
* GET /api/personalization/dietary-restrictions - Get the master list of all dietary restrictions.
|
||||
* @openapi
|
||||
* /personalization/dietary-restrictions:
|
||||
* get:
|
||||
* tags: [Personalization]
|
||||
* summary: Get dietary restrictions
|
||||
* description: Get the master list of all available dietary restrictions.
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of all dietary restrictions
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SuccessResponse'
|
||||
*/
|
||||
router.get(
|
||||
'/dietary-restrictions',
|
||||
@@ -59,7 +83,19 @@ router.get(
|
||||
);
|
||||
|
||||
/**
|
||||
* GET /api/personalization/appliances - Get the master list of all kitchen appliances.
|
||||
* @openapi
|
||||
* /personalization/appliances:
|
||||
* get:
|
||||
* tags: [Personalization]
|
||||
* summary: Get kitchen appliances
|
||||
* description: Get the master list of all available kitchen appliances.
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of all kitchen appliances
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SuccessResponse'
|
||||
*/
|
||||
router.get(
|
||||
'/appliances',
|
||||
|
||||
@@ -6,8 +6,9 @@ import { aiService } from '../services/aiService.server';
|
||||
import passport from './passport.routes';
|
||||
import { validateRequest } from '../middleware/validation.middleware';
|
||||
import { requiredString, numericIdParam, optionalNumeric } from '../utils/zodUtils';
|
||||
import { publicReadLimiter, suggestionLimiter } from '../config/rateLimiters';
|
||||
import { publicReadLimiter, suggestionLimiter, userUpdateLimiter } from '../config/rateLimiters';
|
||||
import { sendSuccess, sendError, ErrorCode } from '../utils/apiResponse';
|
||||
import type { UserProfile } from '../types';
|
||||
|
||||
const router = Router();
|
||||
|
||||
@@ -38,8 +39,36 @@ const suggestRecipeSchema = z.object({
|
||||
}),
|
||||
});
|
||||
|
||||
const addCommentSchema = recipeIdParamsSchema.extend({
|
||||
body: z.object({
|
||||
content: requiredString('Comment content is required.'),
|
||||
parentCommentId: z.number().int().positive().optional(),
|
||||
}),
|
||||
});
|
||||
|
||||
/**
|
||||
* GET /api/recipes/by-sale-percentage - Get recipes based on the percentage of their ingredients on sale.
|
||||
* @openapi
|
||||
* /recipes/by-sale-percentage:
|
||||
* get:
|
||||
* tags: [Recipes]
|
||||
* summary: Get recipes by sale percentage
|
||||
* description: Get recipes based on the percentage of their ingredients currently on sale.
|
||||
* parameters:
|
||||
* - in: query
|
||||
* name: minPercentage
|
||||
* schema:
|
||||
* type: number
|
||||
* minimum: 0
|
||||
* maximum: 100
|
||||
* default: 50
|
||||
* description: Minimum percentage of ingredients on sale
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of recipes matching criteria
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SuccessResponse'
|
||||
*/
|
||||
router.get(
|
||||
'/by-sale-percentage',
|
||||
@@ -59,7 +88,27 @@ router.get(
|
||||
);
|
||||
|
||||
/**
|
||||
* GET /api/recipes/by-sale-ingredients - Get recipes by the minimum number of sale ingredients.
|
||||
* @openapi
|
||||
* /recipes/by-sale-ingredients:
|
||||
* get:
|
||||
* tags: [Recipes]
|
||||
* summary: Get recipes by sale ingredients count
|
||||
* description: Get recipes with at least a specified number of ingredients currently on sale.
|
||||
* parameters:
|
||||
* - in: query
|
||||
* name: minIngredients
|
||||
* schema:
|
||||
* type: integer
|
||||
* minimum: 1
|
||||
* default: 3
|
||||
* description: Minimum number of sale ingredients required
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of recipes matching criteria
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SuccessResponse'
|
||||
*/
|
||||
router.get(
|
||||
'/by-sale-ingredients',
|
||||
@@ -82,7 +131,34 @@ router.get(
|
||||
);
|
||||
|
||||
/**
|
||||
* GET /api/recipes/by-ingredient-and-tag - Find recipes by a specific ingredient and tag.
|
||||
* @openapi
|
||||
* /recipes/by-ingredient-and-tag:
|
||||
* get:
|
||||
* tags: [Recipes]
|
||||
* summary: Find recipes by ingredient and tag
|
||||
* description: Find recipes that contain a specific ingredient and have a specific tag.
|
||||
* parameters:
|
||||
* - in: query
|
||||
* name: ingredient
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* description: Ingredient name to search for
|
||||
* - in: query
|
||||
* name: tag
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* description: Tag to filter by
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of matching recipes
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SuccessResponse'
|
||||
* 400:
|
||||
* description: Missing required query parameters
|
||||
*/
|
||||
router.get(
|
||||
'/by-ingredient-and-tag',
|
||||
@@ -105,7 +181,28 @@ router.get(
|
||||
);
|
||||
|
||||
/**
|
||||
* GET /api/recipes/:recipeId/comments - Get all comments for a specific recipe.
|
||||
* @openapi
|
||||
* /recipes/{recipeId}/comments:
|
||||
* get:
|
||||
* tags: [Recipes]
|
||||
* summary: Get recipe comments
|
||||
* description: Get all comments for a specific recipe.
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: recipeId
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Recipe ID
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of comments
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SuccessResponse'
|
||||
* 404:
|
||||
* description: Recipe not found
|
||||
*/
|
||||
router.get(
|
||||
'/:recipeId/comments',
|
||||
@@ -125,7 +222,28 @@ router.get(
|
||||
);
|
||||
|
||||
/**
|
||||
* GET /api/recipes/:recipeId - Get a single recipe by its ID, including ingredients and tags.
|
||||
* @openapi
|
||||
* /recipes/{recipeId}:
|
||||
* get:
|
||||
* tags: [Recipes]
|
||||
* summary: Get recipe by ID
|
||||
* description: Get a single recipe by its ID, including ingredients and tags.
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: recipeId
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Recipe ID
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Recipe details with ingredients and tags
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SuccessResponse'
|
||||
* 404:
|
||||
* description: Recipe not found
|
||||
*/
|
||||
router.get(
|
||||
'/:recipeId',
|
||||
@@ -145,8 +263,40 @@ router.get(
|
||||
);
|
||||
|
||||
/**
|
||||
* POST /api/recipes/suggest - Generates a simple recipe suggestion from a list of ingredients.
|
||||
* This is a protected endpoint.
|
||||
* @openapi
|
||||
* /recipes/suggest:
|
||||
* post:
|
||||
* tags: [Recipes]
|
||||
* summary: Get AI recipe suggestion
|
||||
* description: Generate a recipe suggestion based on provided ingredients using AI.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - ingredients
|
||||
* properties:
|
||||
* ingredients:
|
||||
* type: array
|
||||
* items:
|
||||
* type: string
|
||||
* minItems: 1
|
||||
* description: List of ingredients to use
|
||||
* responses:
|
||||
* 200:
|
||||
* description: AI-generated recipe suggestion
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SuccessResponse'
|
||||
* 401:
|
||||
* description: Unauthorized - invalid or missing token
|
||||
* 503:
|
||||
* description: AI service unavailable
|
||||
*/
|
||||
router.post(
|
||||
'/suggest',
|
||||
@@ -175,4 +325,125 @@ router.post(
|
||||
},
|
||||
);
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /recipes/{recipeId}/comments:
|
||||
* post:
|
||||
* tags: [Recipes]
|
||||
* summary: Add comment to recipe
|
||||
* description: Add a comment to a recipe. Supports nested replies via parentCommentId.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: recipeId
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Recipe ID
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - content
|
||||
* properties:
|
||||
* content:
|
||||
* type: string
|
||||
* description: Comment content
|
||||
* parentCommentId:
|
||||
* type: integer
|
||||
* description: Parent comment ID for replies (optional)
|
||||
* responses:
|
||||
* 201:
|
||||
* description: Comment added
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SuccessResponse'
|
||||
* 401:
|
||||
* description: Unauthorized - invalid or missing token
|
||||
* 404:
|
||||
* description: Recipe or parent comment not found
|
||||
*/
|
||||
router.post(
|
||||
'/:recipeId/comments',
|
||||
userUpdateLimiter,
|
||||
passport.authenticate('jwt', { session: false }),
|
||||
validateRequest(addCommentSchema),
|
||||
async (req, res, next) => {
|
||||
try {
|
||||
const userProfile = req.user as UserProfile;
|
||||
const { params, body } = addCommentSchema.parse({ params: req.params, body: req.body });
|
||||
|
||||
const comment = await db.recipeRepo.addRecipeComment(
|
||||
params.recipeId,
|
||||
userProfile.user.user_id,
|
||||
body.content,
|
||||
req.log,
|
||||
body.parentCommentId,
|
||||
);
|
||||
|
||||
sendSuccess(res, comment, 201);
|
||||
} catch (error) {
|
||||
req.log.error({ error }, `Error adding comment to recipe ID ${req.params.recipeId}:`);
|
||||
next(error);
|
||||
}
|
||||
},
|
||||
);
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /recipes/{recipeId}/fork:
|
||||
* post:
|
||||
* tags: [Recipes]
|
||||
* summary: Fork recipe
|
||||
* description: Create a personal copy of a recipe that you can modify.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: recipeId
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Recipe ID to fork
|
||||
* responses:
|
||||
* 201:
|
||||
* description: Recipe forked successfully
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SuccessResponse'
|
||||
* 401:
|
||||
* description: Unauthorized - invalid or missing token
|
||||
* 404:
|
||||
* description: Recipe not found
|
||||
*/
|
||||
router.post(
|
||||
'/:recipeId/fork',
|
||||
userUpdateLimiter,
|
||||
passport.authenticate('jwt', { session: false }),
|
||||
validateRequest(recipeIdParamsSchema),
|
||||
async (req, res, next) => {
|
||||
try {
|
||||
const userProfile = req.user as UserProfile;
|
||||
const { params } = recipeIdParamsSchema.parse({ params: req.params });
|
||||
|
||||
const forkedRecipe = await db.recipeRepo.forkRecipe(
|
||||
userProfile.user.user_id,
|
||||
params.recipeId,
|
||||
req.log,
|
||||
);
|
||||
|
||||
sendSuccess(res, forkedRecipe, 201);
|
||||
} catch (error) {
|
||||
req.log.error({ error }, `Error forking recipe ID ${req.params.recipeId}:`);
|
||||
next(error);
|
||||
}
|
||||
},
|
||||
);
|
||||
|
||||
export default router;
|
||||
|
||||
@@ -22,8 +22,36 @@ const mostFrequentSalesSchema = z.object({
|
||||
});
|
||||
|
||||
/**
|
||||
* GET /api/stats/most-frequent-sales - Get a list of items that have been on sale most frequently.
|
||||
* This is a public endpoint for data analysis.
|
||||
* @openapi
|
||||
* /stats/most-frequent-sales:
|
||||
* get:
|
||||
* tags: [Stats]
|
||||
* summary: Get most frequent sale items
|
||||
* description: Get a list of items that have been on sale most frequently. Public endpoint for data analysis.
|
||||
* parameters:
|
||||
* - in: query
|
||||
* name: days
|
||||
* schema:
|
||||
* type: integer
|
||||
* minimum: 1
|
||||
* maximum: 365
|
||||
* default: 30
|
||||
* description: Number of days to look back
|
||||
* - in: query
|
||||
* name: limit
|
||||
* schema:
|
||||
* type: integer
|
||||
* minimum: 1
|
||||
* maximum: 50
|
||||
* default: 10
|
||||
* description: Maximum number of items to return
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of most frequently on-sale items
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SuccessResponse'
|
||||
*/
|
||||
router.get(
|
||||
'/most-frequent-sales',
|
||||
|
||||
@@ -28,8 +28,19 @@ const geocodeSchema = z.object({
|
||||
const emptySchema = z.object({});
|
||||
|
||||
/**
|
||||
* Checks the status of the 'flyer-crawler-api' process managed by PM2.
|
||||
* This is intended for development and diagnostic purposes.
|
||||
* @openapi
|
||||
* /system/pm2-status:
|
||||
* get:
|
||||
* tags: [System]
|
||||
* summary: Get PM2 process status
|
||||
* description: Checks the status of the 'flyer-crawler-api' process managed by PM2. For development and diagnostic purposes.
|
||||
* responses:
|
||||
* 200:
|
||||
* description: PM2 process status information
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SuccessResponse'
|
||||
*/
|
||||
router.get(
|
||||
'/pm2-status',
|
||||
@@ -45,8 +56,33 @@ router.get(
|
||||
);
|
||||
|
||||
/**
|
||||
* POST /api/system/geocode - Geocodes a given address string.
|
||||
* This acts as a secure proxy to the Google Maps Geocoding API.
|
||||
* @openapi
|
||||
* /system/geocode:
|
||||
* post:
|
||||
* tags: [System]
|
||||
* summary: Geocode an address
|
||||
* description: Geocodes a given address string. Acts as a secure proxy to the Google Maps Geocoding API.
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - address
|
||||
* properties:
|
||||
* address:
|
||||
* type: string
|
||||
* description: Address string to geocode
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Geocoded coordinates
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SuccessResponse'
|
||||
* 404:
|
||||
* description: Could not geocode the provided address
|
||||
*/
|
||||
router.post(
|
||||
'/geocode',
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -25,9 +25,15 @@ export class GamificationRepository {
|
||||
);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
handleDbError(error, logger, 'Database error in getAllAchievements', {}, {
|
||||
defaultMessage: 'Failed to retrieve achievements.',
|
||||
});
|
||||
handleDbError(
|
||||
error,
|
||||
logger,
|
||||
'Database error in getAllAchievements',
|
||||
{},
|
||||
{
|
||||
defaultMessage: 'Failed to retrieve achievements.',
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -60,9 +66,15 @@ export class GamificationRepository {
|
||||
const res = await this.db.query<UserAchievement & Achievement>(query, [userId]);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
handleDbError(error, logger, 'Database error in getUserAchievements', { userId }, {
|
||||
defaultMessage: 'Failed to retrieve user achievements.',
|
||||
});
|
||||
handleDbError(
|
||||
error,
|
||||
logger,
|
||||
'Database error in getUserAchievements',
|
||||
{ userId },
|
||||
{
|
||||
defaultMessage: 'Failed to retrieve user achievements.',
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -76,12 +88,18 @@ export class GamificationRepository {
|
||||
*/
|
||||
async awardAchievement(userId: string, achievementName: string, logger: Logger): Promise<void> {
|
||||
try {
|
||||
await this.db.query('SELECT public.award_achievement($1, $2)', [userId, achievementName]); // This was a duplicate, fixed.
|
||||
await this.db.query('SELECT public.award_achievement($1, $2)', [userId, achievementName]);
|
||||
} catch (error) {
|
||||
handleDbError(error, logger, 'Database error in awardAchievement', { userId, achievementName }, {
|
||||
fkMessage: 'The specified user or achievement does not exist.',
|
||||
defaultMessage: 'Failed to award achievement.',
|
||||
});
|
||||
handleDbError(
|
||||
error,
|
||||
logger,
|
||||
'Database error in awardAchievement',
|
||||
{ userId, achievementName },
|
||||
{
|
||||
fkMessage: 'The specified user or achievement does not exist.',
|
||||
defaultMessage: 'Failed to award achievement.',
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -106,9 +124,15 @@ export class GamificationRepository {
|
||||
const res = await this.db.query<LeaderboardUser>(query, [limit]);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
handleDbError(error, logger, 'Database error in getLeaderboard', { limit }, {
|
||||
defaultMessage: 'Failed to retrieve leaderboard.',
|
||||
});
|
||||
handleDbError(
|
||||
error,
|
||||
logger,
|
||||
'Database error in getLeaderboard',
|
||||
{ limit },
|
||||
{
|
||||
defaultMessage: 'Failed to retrieve leaderboard.',
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -24,9 +24,6 @@ export class FlyerPersistenceService {
|
||||
* @internal
|
||||
*/
|
||||
_setWithTransaction(fn: WithTransactionFn | null): void {
|
||||
console.error(
|
||||
`[DEBUG] FlyerPersistenceService._setWithTransaction called, ${fn ? 'replacing' : 'resetting'} withTransaction function`,
|
||||
);
|
||||
this.withTransaction = fn ?? defaultWithTransaction;
|
||||
}
|
||||
|
||||
@@ -40,12 +37,6 @@ export class FlyerPersistenceService {
|
||||
userId: string | undefined,
|
||||
logger: Logger,
|
||||
): Promise<Flyer> {
|
||||
console.error(
|
||||
`[DEBUG] FlyerPersistenceService.saveFlyer called, about to invoke withTransaction`,
|
||||
);
|
||||
console.error(
|
||||
`[DEBUG] withTransaction function name: ${this.withTransaction.name || 'anonymous'}`,
|
||||
);
|
||||
const flyer = await this.withTransaction(async (client) => {
|
||||
const { flyer, items } = await createFlyerAndItems(flyerData, itemsForDb, logger, client);
|
||||
|
||||
|
||||
@@ -84,8 +84,204 @@ describe('Budget API Routes Integration Tests', () => {
|
||||
});
|
||||
});
|
||||
|
||||
it.todo('should allow an authenticated user to create a new budget');
|
||||
it.todo('should allow an authenticated user to update their own budget');
|
||||
it.todo('should allow an authenticated user to delete their own budget');
|
||||
it.todo('should return spending analysis for the authenticated user');
|
||||
describe('POST /api/budgets', () => {
|
||||
it('should allow an authenticated user to create a new budget', async () => {
|
||||
const newBudgetData = {
|
||||
name: 'Weekly Snacks',
|
||||
amount_cents: 15000, // $150.00
|
||||
period: 'weekly',
|
||||
start_date: '2025-02-01',
|
||||
};
|
||||
|
||||
const response = await request
|
||||
.post('/api/budgets')
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.send(newBudgetData);
|
||||
|
||||
expect(response.status).toBe(201);
|
||||
const createdBudget: Budget = response.body.data;
|
||||
expect(createdBudget.name).toBe(newBudgetData.name);
|
||||
expect(createdBudget.amount_cents).toBe(newBudgetData.amount_cents);
|
||||
expect(createdBudget.period).toBe(newBudgetData.period);
|
||||
// The API returns an ISO timestamp, so we check if it starts with the expected date
|
||||
expect(createdBudget.start_date).toContain(newBudgetData.start_date);
|
||||
expect(createdBudget.user_id).toBe(testUser.user.user_id);
|
||||
expect(createdBudget.budget_id).toBeDefined();
|
||||
|
||||
// Track for cleanup
|
||||
createdBudgetIds.push(createdBudget.budget_id);
|
||||
});
|
||||
|
||||
it('should return 400 for invalid budget data', async () => {
|
||||
const invalidBudgetData = {
|
||||
name: '', // Invalid: empty name
|
||||
amount_cents: -100, // Invalid: negative amount
|
||||
period: 'daily', // Invalid: not 'weekly' or 'monthly'
|
||||
start_date: 'not-a-date',
|
||||
};
|
||||
|
||||
const response = await request
|
||||
.post('/api/budgets')
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.send(invalidBudgetData);
|
||||
|
||||
expect(response.status).toBe(400);
|
||||
});
|
||||
|
||||
it('should return 401 if user is not authenticated', async () => {
|
||||
const response = await request.post('/api/budgets').send({
|
||||
name: 'Unauthorized Budget',
|
||||
amount_cents: 10000,
|
||||
period: 'monthly',
|
||||
start_date: '2025-01-01',
|
||||
});
|
||||
|
||||
expect(response.status).toBe(401);
|
||||
});
|
||||
});
|
||||
|
||||
describe('PUT /api/budgets/:id', () => {
|
||||
it('should allow an authenticated user to update their own budget', async () => {
|
||||
const updatedData = {
|
||||
name: 'Updated Monthly Groceries',
|
||||
amount_cents: 60000, // $600.00
|
||||
};
|
||||
|
||||
const response = await request
|
||||
.put(`/api/budgets/${testBudget.budget_id}`)
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.send(updatedData);
|
||||
|
||||
expect(response.status).toBe(200);
|
||||
const updatedBudget: Budget = response.body.data;
|
||||
expect(updatedBudget.name).toBe(updatedData.name);
|
||||
expect(updatedBudget.amount_cents).toBe(updatedData.amount_cents);
|
||||
// Unchanged fields should remain the same
|
||||
expect(updatedBudget.period).toBe(testBudget.period);
|
||||
// The seeded budget start_date is a plain DATE, but API may return ISO timestamp
|
||||
expect(updatedBudget.start_date).toContain('2025-01-01');
|
||||
});
|
||||
|
||||
it('should return 404 when updating a non-existent budget', async () => {
|
||||
const response = await request
|
||||
.put('/api/budgets/999999')
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.send({ name: 'Non-existent' });
|
||||
|
||||
expect(response.status).toBe(404);
|
||||
});
|
||||
|
||||
it('should return 400 when no update fields are provided', async () => {
|
||||
const response = await request
|
||||
.put(`/api/budgets/${testBudget.budget_id}`)
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.send({});
|
||||
|
||||
expect(response.status).toBe(400);
|
||||
});
|
||||
|
||||
it('should return 401 if user is not authenticated', async () => {
|
||||
const response = await request
|
||||
.put(`/api/budgets/${testBudget.budget_id}`)
|
||||
.send({ name: 'Hacked Budget' });
|
||||
|
||||
expect(response.status).toBe(401);
|
||||
});
|
||||
});
|
||||
|
||||
describe('DELETE /api/budgets/:id', () => {
|
||||
it('should allow an authenticated user to delete their own budget', async () => {
|
||||
// Create a budget specifically for deletion
|
||||
const budgetToDelete = {
|
||||
name: 'To Be Deleted',
|
||||
amount_cents: 5000,
|
||||
period: 'weekly',
|
||||
start_date: '2025-03-01',
|
||||
};
|
||||
|
||||
const createResponse = await request
|
||||
.post('/api/budgets')
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.send(budgetToDelete);
|
||||
|
||||
expect(createResponse.status).toBe(201);
|
||||
const createdBudget: Budget = createResponse.body.data;
|
||||
|
||||
// Now delete it
|
||||
const deleteResponse = await request
|
||||
.delete(`/api/budgets/${createdBudget.budget_id}`)
|
||||
.set('Authorization', `Bearer ${authToken}`);
|
||||
|
||||
expect(deleteResponse.status).toBe(204);
|
||||
|
||||
// Verify it's actually deleted
|
||||
const getResponse = await request
|
||||
.get('/api/budgets')
|
||||
.set('Authorization', `Bearer ${authToken}`);
|
||||
|
||||
const budgets: Budget[] = getResponse.body.data;
|
||||
expect(budgets.some((b) => b.budget_id === createdBudget.budget_id)).toBe(false);
|
||||
});
|
||||
|
||||
it('should return 404 when deleting a non-existent budget', async () => {
|
||||
const response = await request
|
||||
.delete('/api/budgets/999999')
|
||||
.set('Authorization', `Bearer ${authToken}`);
|
||||
|
||||
expect(response.status).toBe(404);
|
||||
});
|
||||
|
||||
it('should return 401 if user is not authenticated', async () => {
|
||||
const response = await request.delete(`/api/budgets/${testBudget.budget_id}`);
|
||||
|
||||
expect(response.status).toBe(401);
|
||||
});
|
||||
});
|
||||
|
||||
describe('GET /api/budgets/spending-analysis', () => {
|
||||
it('should return spending analysis for the authenticated user', async () => {
|
||||
// Note: This test verifies the endpoint works and returns the correct structure.
|
||||
// In a real scenario with seeded shopping trip data, we'd verify actual values.
|
||||
const response = await request
|
||||
.get('/api/budgets/spending-analysis')
|
||||
.query({ startDate: '2025-01-01', endDate: '2025-12-31' })
|
||||
.set('Authorization', `Bearer ${authToken}`);
|
||||
|
||||
expect(response.status).toBe(200);
|
||||
expect(response.body.data).toBeInstanceOf(Array);
|
||||
|
||||
// Each item in the array should have the SpendingByCategory structure
|
||||
if (response.body.data.length > 0) {
|
||||
const firstItem = response.body.data[0];
|
||||
expect(firstItem).toHaveProperty('category_id');
|
||||
expect(firstItem).toHaveProperty('category_name');
|
||||
expect(firstItem).toHaveProperty('total_spent_cents');
|
||||
}
|
||||
});
|
||||
|
||||
it('should return 400 for invalid date format', async () => {
|
||||
const response = await request
|
||||
.get('/api/budgets/spending-analysis')
|
||||
.query({ startDate: 'invalid-date', endDate: '2025-12-31' })
|
||||
.set('Authorization', `Bearer ${authToken}`);
|
||||
|
||||
expect(response.status).toBe(400);
|
||||
});
|
||||
|
||||
it('should return 400 when required query params are missing', async () => {
|
||||
const response = await request
|
||||
.get('/api/budgets/spending-analysis')
|
||||
.set('Authorization', `Bearer ${authToken}`);
|
||||
|
||||
expect(response.status).toBe(400);
|
||||
});
|
||||
|
||||
it('should return 401 if user is not authenticated', async () => {
|
||||
const response = await request
|
||||
.get('/api/budgets/spending-analysis')
|
||||
.query({ startDate: '2025-01-01', endDate: '2025-12-31' });
|
||||
|
||||
expect(response.status).toBe(401);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -120,171 +120,159 @@ describe('Gamification Flow Integration Test', () => {
|
||||
await new Promise((resolve) => setTimeout(resolve, 50));
|
||||
});
|
||||
|
||||
// TODO: This test is flaky because the gamification event system doesn't reliably trigger
|
||||
// in the test environment. The flyer processing completes successfully (flyerId is returned),
|
||||
// but the "First Upload" achievement event doesn't fire. This may be related to:
|
||||
// 1. Event emission timing issues in the test environment
|
||||
// 2. The gamification event listener not being properly initialized in integration tests
|
||||
// 3. Race conditions between the worker completing and event handlers registering
|
||||
// Investigation needed in the gamification event system.
|
||||
it.todo(
|
||||
'should award the "First Upload" achievement after a user successfully uploads and processes their first flyer - gamification event not firing',
|
||||
async () => {
|
||||
// --- Arrange: Prepare a unique flyer file for upload ---
|
||||
const imagePath = path.resolve(__dirname, '../assets/test-flyer-image.jpg');
|
||||
const imageBuffer = await fs.readFile(imagePath);
|
||||
const uniqueContent = Buffer.concat([imageBuffer, Buffer.from(Date.now().toString())]);
|
||||
const uniqueFileName = `gamification-test-flyer-${Date.now()}.jpg`;
|
||||
const mockImageFile = new File([new Uint8Array(uniqueContent)], uniqueFileName, {
|
||||
type: 'image/jpeg',
|
||||
});
|
||||
const checksum = await generateFileChecksum(mockImageFile);
|
||||
it('should award the "First Upload" achievement after a user successfully uploads and processes their first flyer', async () => {
|
||||
// --- Arrange: Prepare a unique flyer file for upload ---
|
||||
const imagePath = path.resolve(__dirname, '../assets/test-flyer-image.jpg');
|
||||
const imageBuffer = await fs.readFile(imagePath);
|
||||
const uniqueContent = Buffer.concat([imageBuffer, Buffer.from(Date.now().toString())]);
|
||||
const uniqueFileName = `gamification-test-flyer-${Date.now()}.jpg`;
|
||||
const mockImageFile = new File([new Uint8Array(uniqueContent)], uniqueFileName, {
|
||||
type: 'image/jpeg',
|
||||
});
|
||||
const checksum = await generateFileChecksum(mockImageFile);
|
||||
|
||||
// Track created files for cleanup
|
||||
const uploadDir = path.resolve(__dirname, '../../../flyer-images');
|
||||
createdFilePaths.push(path.join(uploadDir, uniqueFileName));
|
||||
const iconFileName = `icon-${path.parse(uniqueFileName).name}.webp`;
|
||||
createdFilePaths.push(path.join(uploadDir, 'icons', iconFileName));
|
||||
// Track created files for cleanup
|
||||
const uploadDir = path.resolve(__dirname, '../../../flyer-images');
|
||||
createdFilePaths.push(path.join(uploadDir, uniqueFileName));
|
||||
const iconFileName = `icon-${path.parse(uniqueFileName).name}.webp`;
|
||||
createdFilePaths.push(path.join(uploadDir, 'icons', iconFileName));
|
||||
|
||||
// --- Act 1: Upload the flyer to trigger the background job ---
|
||||
const testBaseUrl = 'https://example.com';
|
||||
console.error(
|
||||
'--------------------------------------------------------------------------------',
|
||||
);
|
||||
console.error('[TEST DEBUG] STARTING UPLOAD STEP');
|
||||
console.error(`[TEST DEBUG] Env FRONTEND_URL: "${process.env.FRONTEND_URL}"`);
|
||||
console.error(`[TEST DEBUG] Sending baseUrl field: "${testBaseUrl}"`);
|
||||
console.error(
|
||||
'--------------------------------------------------------------------------------',
|
||||
);
|
||||
// --- Act 1: Upload the flyer to trigger the background job ---
|
||||
const testBaseUrl = 'https://example.com';
|
||||
console.error(
|
||||
'--------------------------------------------------------------------------------',
|
||||
);
|
||||
console.error('[TEST DEBUG] STARTING UPLOAD STEP');
|
||||
console.error(`[TEST DEBUG] Env FRONTEND_URL: "${process.env.FRONTEND_URL}"`);
|
||||
console.error(`[TEST DEBUG] Sending baseUrl field: "${testBaseUrl}"`);
|
||||
console.error(
|
||||
'--------------------------------------------------------------------------------',
|
||||
);
|
||||
|
||||
const uploadResponse = await request
|
||||
.post('/api/ai/upload-and-process')
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.field('checksum', checksum)
|
||||
.field('baseUrl', testBaseUrl)
|
||||
.attach('flyerFile', uniqueContent, uniqueFileName);
|
||||
const uploadResponse = await request
|
||||
.post('/api/ai/upload-and-process')
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.field('checksum', checksum)
|
||||
.field('baseUrl', testBaseUrl)
|
||||
.attach('flyerFile', uniqueContent, uniqueFileName);
|
||||
|
||||
console.error(
|
||||
'--------------------------------------------------------------------------------',
|
||||
);
|
||||
console.error(`[TEST DEBUG] Upload Response Status: ${uploadResponse.status}`);
|
||||
console.error(
|
||||
`[TEST DEBUG] Upload Response Body: ${JSON.stringify(uploadResponse.body, null, 2)}`,
|
||||
);
|
||||
console.error(
|
||||
'--------------------------------------------------------------------------------',
|
||||
);
|
||||
console.error(
|
||||
'--------------------------------------------------------------------------------',
|
||||
);
|
||||
console.error(`[TEST DEBUG] Upload Response Status: ${uploadResponse.status}`);
|
||||
console.error(
|
||||
`[TEST DEBUG] Upload Response Body: ${JSON.stringify(uploadResponse.body, null, 2)}`,
|
||||
);
|
||||
console.error(
|
||||
'--------------------------------------------------------------------------------',
|
||||
);
|
||||
|
||||
const { jobId } = uploadResponse.body.data;
|
||||
expect(jobId).toBeTypeOf('string');
|
||||
console.error(`[TEST DEBUG] Job ID received: ${jobId}`);
|
||||
const { jobId } = uploadResponse.body.data;
|
||||
expect(jobId).toBeTypeOf('string');
|
||||
console.error(`[TEST DEBUG] Job ID received: ${jobId}`);
|
||||
|
||||
// --- Act 2: Poll for job completion using the new utility ---
|
||||
const jobStatus = await poll(
|
||||
async () => {
|
||||
const statusResponse = await request
|
||||
.get(`/api/ai/jobs/${jobId}/status`)
|
||||
.set('Authorization', `Bearer ${authToken}`);
|
||||
console.error(
|
||||
`[TEST DEBUG] Polling status for ${jobId}: ${statusResponse.body?.data?.state}`,
|
||||
);
|
||||
return statusResponse.body.data;
|
||||
},
|
||||
(status) => status.state === 'completed' || status.state === 'failed',
|
||||
{ timeout: 180000, interval: 3000, description: 'gamification flyer processing' },
|
||||
);
|
||||
// --- Act 2: Poll for job completion using the new utility ---
|
||||
const jobStatus = await poll(
|
||||
async () => {
|
||||
const statusResponse = await request
|
||||
.get(`/api/ai/jobs/${jobId}/status`)
|
||||
.set('Authorization', `Bearer ${authToken}`);
|
||||
console.error(
|
||||
`[TEST DEBUG] Polling status for ${jobId}: ${statusResponse.body?.data?.state}`,
|
||||
);
|
||||
return statusResponse.body.data;
|
||||
},
|
||||
(status) => status.state === 'completed' || status.state === 'failed',
|
||||
{ timeout: 180000, interval: 3000, description: 'gamification flyer processing' },
|
||||
);
|
||||
|
||||
if (!jobStatus) {
|
||||
console.error('[DEBUG] Gamification test job timed out: No job status received.');
|
||||
throw new Error('Gamification test job timed out: No job status received.');
|
||||
if (!jobStatus) {
|
||||
console.error('[DEBUG] Gamification test job timed out: No job status received.');
|
||||
throw new Error('Gamification test job timed out: No job status received.');
|
||||
}
|
||||
|
||||
console.error(
|
||||
'--------------------------------------------------------------------------------',
|
||||
);
|
||||
console.error('[TEST DEBUG] Final Job Status Object:', JSON.stringify(jobStatus, null, 2));
|
||||
if (jobStatus.state === 'failed') {
|
||||
console.error(`[TEST DEBUG] Job Failed Reason: ${jobStatus.failedReason}`);
|
||||
// If there is a progress object with error details, log it
|
||||
if (jobStatus.progress) {
|
||||
console.error(
|
||||
`[TEST DEBUG] Job Progress/Error Details:`,
|
||||
JSON.stringify(jobStatus.progress, null, 2),
|
||||
);
|
||||
}
|
||||
}
|
||||
console.error(
|
||||
'--------------------------------------------------------------------------------',
|
||||
);
|
||||
|
||||
console.error(
|
||||
'--------------------------------------------------------------------------------',
|
||||
);
|
||||
console.error('[TEST DEBUG] Final Job Status Object:', JSON.stringify(jobStatus, null, 2));
|
||||
if (jobStatus.state === 'failed') {
|
||||
console.error(`[TEST DEBUG] Job Failed Reason: ${jobStatus.failedReason}`);
|
||||
// If there is a progress object with error details, log it
|
||||
if (jobStatus.progress) {
|
||||
console.error(
|
||||
`[TEST DEBUG] Job Progress/Error Details:`,
|
||||
JSON.stringify(jobStatus.progress, null, 2),
|
||||
);
|
||||
}
|
||||
}
|
||||
console.error(
|
||||
'--------------------------------------------------------------------------------',
|
||||
);
|
||||
// --- Assert 1: Verify the job completed successfully ---
|
||||
if (jobStatus?.state === 'failed') {
|
||||
console.error('[DEBUG] Gamification test job failed:', jobStatus.failedReason);
|
||||
console.error('[DEBUG] Job stack trace:', jobStatus.stacktrace);
|
||||
console.error('[DEBUG] Job return value:', JSON.stringify(jobStatus.returnValue, null, 2));
|
||||
}
|
||||
expect(jobStatus?.state).toBe('completed');
|
||||
|
||||
// --- Assert 1: Verify the job completed successfully ---
|
||||
if (jobStatus?.state === 'failed') {
|
||||
console.error('[DEBUG] Gamification test job failed:', jobStatus.failedReason);
|
||||
console.error('[DEBUG] Job stack trace:', jobStatus.stacktrace);
|
||||
console.error('[DEBUG] Job return value:', JSON.stringify(jobStatus.returnValue, null, 2));
|
||||
}
|
||||
expect(jobStatus?.state).toBe('completed');
|
||||
const flyerId = jobStatus?.returnValue?.flyerId;
|
||||
expect(flyerId).toBeTypeOf('number');
|
||||
createdFlyerIds.push(flyerId); // Track for cleanup
|
||||
|
||||
const flyerId = jobStatus?.returnValue?.flyerId;
|
||||
expect(flyerId).toBeTypeOf('number');
|
||||
createdFlyerIds.push(flyerId); // Track for cleanup
|
||||
// --- Assert 1.5: Verify the flyer was saved with the correct original filename ---
|
||||
const savedFlyer = await db.flyerRepo.findFlyerByChecksum(checksum, logger);
|
||||
expect(savedFlyer).toBeDefined();
|
||||
expect(savedFlyer?.file_name).toBe(uniqueFileName);
|
||||
if (savedFlyer?.store_id) {
|
||||
createdStoreIds.push(savedFlyer.store_id);
|
||||
}
|
||||
// Also add the final processed image path to the cleanup list.
|
||||
// This is important because JPEGs are re-processed to strip EXIF data, creating a new file.
|
||||
const savedImagePath = path.join(uploadDir, path.basename(savedFlyer!.image_url));
|
||||
createdFilePaths.push(savedImagePath);
|
||||
|
||||
// --- Assert 1.5: Verify the flyer was saved with the correct original filename ---
|
||||
const savedFlyer = await db.flyerRepo.findFlyerByChecksum(checksum, logger);
|
||||
expect(savedFlyer).toBeDefined();
|
||||
expect(savedFlyer?.file_name).toBe(uniqueFileName);
|
||||
if (savedFlyer?.store_id) {
|
||||
createdStoreIds.push(savedFlyer.store_id);
|
||||
}
|
||||
// Also add the final processed image path to the cleanup list.
|
||||
// This is important because JPEGs are re-processed to strip EXIF data, creating a new file.
|
||||
const savedImagePath = path.join(uploadDir, path.basename(savedFlyer!.image_url));
|
||||
createdFilePaths.push(savedImagePath);
|
||||
// --- Act 3: Fetch the user's achievements (triggers endpoint, response not needed) ---
|
||||
await request.get('/api/achievements/me').set('Authorization', `Bearer ${authToken}`);
|
||||
|
||||
// --- Act 3: Fetch the user's achievements (triggers endpoint, response not needed) ---
|
||||
await request.get('/api/achievements/me').set('Authorization', `Bearer ${authToken}`);
|
||||
// --- Assert 2: Verify the "First-Upload" achievement was awarded ---
|
||||
// The 'Welcome Aboard' achievement is awarded on user creation, so we expect at least two.
|
||||
// Wait for the asynchronous achievement event to process
|
||||
await vi.waitUntil(
|
||||
async () => {
|
||||
const achievements = await db.gamificationRepo.getUserAchievements(
|
||||
testUser.user.user_id,
|
||||
logger,
|
||||
);
|
||||
return achievements.length >= 2;
|
||||
},
|
||||
{ timeout: 15000, interval: 500 },
|
||||
);
|
||||
|
||||
// --- Assert 2: Verify the "First-Upload" achievement was awarded ---
|
||||
// The 'user_registered' achievement is awarded on creation, so we expect at least two.
|
||||
// Wait for the asynchronous achievement event to process
|
||||
await vi.waitUntil(
|
||||
async () => {
|
||||
const achievements = await db.gamificationRepo.getUserAchievements(
|
||||
testUser.user.user_id,
|
||||
logger,
|
||||
);
|
||||
console.error(`[GAMIFICATION TEST] Achievements count: ${achievements.length}`);
|
||||
return achievements.length >= 2;
|
||||
},
|
||||
{ timeout: 15000, interval: 500 },
|
||||
);
|
||||
// Final assertion and retrieval
|
||||
const userAchievements = await db.gamificationRepo.getUserAchievements(
|
||||
testUser.user.user_id,
|
||||
logger,
|
||||
);
|
||||
expect(userAchievements.length).toBeGreaterThanOrEqual(2);
|
||||
const firstUploadAchievement = userAchievements.find((ach) => ach.name === 'First-Upload');
|
||||
expect(firstUploadAchievement).toBeDefined();
|
||||
expect(firstUploadAchievement?.points_value).toBeGreaterThan(0);
|
||||
|
||||
// Final assertion and retrieval
|
||||
const userAchievements = await db.gamificationRepo.getUserAchievements(
|
||||
testUser.user.user_id,
|
||||
logger,
|
||||
);
|
||||
expect(userAchievements.length).toBeGreaterThanOrEqual(2);
|
||||
const firstUploadAchievement = userAchievements.find((ach) => ach.name === 'First-Upload');
|
||||
expect(firstUploadAchievement).toBeDefined();
|
||||
expect(firstUploadAchievement?.points_value).toBeGreaterThan(0);
|
||||
// --- Act 4: Fetch the leaderboard ---
|
||||
const leaderboardResponse = await request.get('/api/achievements/leaderboard');
|
||||
const leaderboard: LeaderboardUser[] = leaderboardResponse.body.data;
|
||||
|
||||
// --- Act 4: Fetch the leaderboard ---
|
||||
const leaderboardResponse = await request.get('/api/achievements/leaderboard');
|
||||
const leaderboard: LeaderboardUser[] = leaderboardResponse.body.data;
|
||||
|
||||
// --- Assert 3: Verify the user is on the leaderboard with points ---
|
||||
const userOnLeaderboard = leaderboard.find((u) => u.user_id === testUser.user.user_id);
|
||||
expect(userOnLeaderboard).toBeDefined();
|
||||
// The user should have points from 'user_registered' and 'First-Upload'.
|
||||
// We check that the points are greater than or equal to the points from the upload achievement.
|
||||
expect(Number(userOnLeaderboard?.points)).toBeGreaterThanOrEqual(
|
||||
firstUploadAchievement!.points_value,
|
||||
);
|
||||
},
|
||||
240000,
|
||||
); // Increase timeout to 240s to match other long-running processing tests
|
||||
// --- Assert 3: Verify the user is on the leaderboard with points ---
|
||||
const userOnLeaderboard = leaderboard.find((u) => u.user_id === testUser.user.user_id);
|
||||
expect(userOnLeaderboard).toBeDefined();
|
||||
// The user should have points from 'user_registered' and 'First-Upload'.
|
||||
// We check that the points are greater than or equal to the points from the upload achievement.
|
||||
expect(Number(userOnLeaderboard?.points)).toBeGreaterThanOrEqual(
|
||||
firstUploadAchievement!.points_value,
|
||||
);
|
||||
}, 240000); // Increase timeout to 240s to match other long-running processing tests
|
||||
|
||||
describe('Legacy Flyer Upload', () => {
|
||||
it('should process a legacy upload and save fully qualified URLs to the database', async () => {
|
||||
|
||||
@@ -3,7 +3,7 @@ import { describe, it, expect, beforeAll, afterAll, vi, afterEach } from 'vitest
|
||||
import supertest from 'supertest';
|
||||
import { createAndLoginUser } from '../utils/testHelpers';
|
||||
import { cleanupDb } from '../utils/cleanup';
|
||||
import type { UserProfile, Recipe } from '../../types';
|
||||
import type { UserProfile, Recipe, RecipeComment } from '../../types';
|
||||
import { getPool } from '../../services/db/connection.db';
|
||||
|
||||
import { aiService } from '../../services/aiService.server';
|
||||
@@ -130,11 +130,107 @@ describe('Recipe API Routes Integration Tests', () => {
|
||||
expect(verifyResponse.status).toBe(200);
|
||||
expect(verifyResponse.body.data.name).toBe(recipeUpdates.name);
|
||||
});
|
||||
it.todo("should prevent a user from updating another user's recipe");
|
||||
it.todo('should allow an authenticated user to delete their own recipe');
|
||||
it.todo("should prevent a user from deleting another user's recipe");
|
||||
it.todo('should allow an authenticated user to post a comment on a recipe');
|
||||
it.todo('should allow an authenticated user to fork a recipe');
|
||||
it("should prevent a user from updating another user's recipe", async () => {
|
||||
// Create a second user who will try to update the first user's recipe
|
||||
const { user: otherUser, token: otherToken } = await createAndLoginUser({
|
||||
email: `recipe-other-${Date.now()}@example.com`,
|
||||
fullName: 'Other Recipe User',
|
||||
request,
|
||||
});
|
||||
createdUserIds.push(otherUser.user.user_id);
|
||||
|
||||
// Attempt to update the testRecipe (owned by testUser) using otherUser's token
|
||||
const response = await request
|
||||
.put(`/api/users/recipes/${testRecipe.recipe_id}`)
|
||||
.set('Authorization', `Bearer ${otherToken}`)
|
||||
.send({ name: 'Hacked Recipe Name' });
|
||||
|
||||
// Should return 404 because the recipe doesn't belong to this user
|
||||
expect(response.status).toBe(404);
|
||||
});
|
||||
|
||||
it('should allow an authenticated user to delete their own recipe', async () => {
|
||||
// Create a recipe specifically for deletion
|
||||
const createRes = await request
|
||||
.post('/api/users/recipes')
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.send({
|
||||
name: 'Recipe To Delete',
|
||||
instructions: 'This recipe will be deleted.',
|
||||
description: 'A temporary recipe.',
|
||||
});
|
||||
|
||||
expect(createRes.status).toBe(201);
|
||||
const recipeToDelete: Recipe = createRes.body.data;
|
||||
|
||||
// Delete the recipe
|
||||
const deleteRes = await request
|
||||
.delete(`/api/users/recipes/${recipeToDelete.recipe_id}`)
|
||||
.set('Authorization', `Bearer ${authToken}`);
|
||||
|
||||
expect(deleteRes.status).toBe(204);
|
||||
|
||||
// Verify it's actually deleted by trying to fetch it
|
||||
const verifyRes = await request.get(`/api/recipes/${recipeToDelete.recipe_id}`);
|
||||
expect(verifyRes.status).toBe(404);
|
||||
});
|
||||
|
||||
it("should prevent a user from deleting another user's recipe", async () => {
|
||||
// Create a second user who will try to delete the first user's recipe
|
||||
const { user: otherUser, token: otherToken } = await createAndLoginUser({
|
||||
email: `recipe-deleter-${Date.now()}@example.com`,
|
||||
fullName: 'Deleter User',
|
||||
request,
|
||||
});
|
||||
createdUserIds.push(otherUser.user.user_id);
|
||||
|
||||
// Attempt to delete the testRecipe (owned by testUser) using otherUser's token
|
||||
const response = await request
|
||||
.delete(`/api/users/recipes/${testRecipe.recipe_id}`)
|
||||
.set('Authorization', `Bearer ${otherToken}`);
|
||||
|
||||
// Should return 404 because the recipe doesn't belong to this user
|
||||
expect(response.status).toBe(404);
|
||||
|
||||
// Verify the recipe still exists
|
||||
const verifyRes = await request.get(`/api/recipes/${testRecipe.recipe_id}`);
|
||||
expect(verifyRes.status).toBe(200);
|
||||
});
|
||||
|
||||
it('should allow an authenticated user to post a comment on a recipe', async () => {
|
||||
const commentContent = 'This is a great recipe! Thanks for sharing.';
|
||||
|
||||
const response = await request
|
||||
.post(`/api/recipes/${testRecipe.recipe_id}/comments`)
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.send({ content: commentContent });
|
||||
|
||||
expect(response.status).toBe(201);
|
||||
const comment: RecipeComment = response.body.data;
|
||||
expect(comment.content).toBe(commentContent);
|
||||
expect(comment.recipe_id).toBe(testRecipe.recipe_id);
|
||||
expect(comment.user_id).toBe(testUser.user.user_id);
|
||||
expect(comment.recipe_comment_id).toBeDefined();
|
||||
});
|
||||
|
||||
it('should allow an authenticated user to fork a recipe', async () => {
|
||||
const response = await request
|
||||
.post(`/api/recipes/${testRecipe.recipe_id}/fork`)
|
||||
.set('Authorization', `Bearer ${authToken}`);
|
||||
|
||||
expect(response.status).toBe(201);
|
||||
const forkedRecipe: Recipe = response.body.data;
|
||||
|
||||
// The forked recipe should have a new ID but reference the original
|
||||
expect(forkedRecipe.recipe_id).not.toBe(testRecipe.recipe_id);
|
||||
expect(forkedRecipe.original_recipe_id).toBe(testRecipe.recipe_id);
|
||||
expect(forkedRecipe.user_id).toBe(testUser.user.user_id);
|
||||
// The name should include "(Fork)" suffix
|
||||
expect(forkedRecipe.name).toContain('Fork');
|
||||
|
||||
// Track for cleanup
|
||||
createdRecipeIds.push(forkedRecipe.recipe_id);
|
||||
});
|
||||
|
||||
describe('POST /api/recipes/suggest', () => {
|
||||
it('should return a recipe suggestion based on ingredients', async () => {
|
||||
|
||||
@@ -43,7 +43,8 @@ const e2eConfig = mergeConfig(
|
||||
fileParallelism: false,
|
||||
coverage: {
|
||||
provider: 'v8',
|
||||
reporter: ['html', 'json-summary', 'json'],
|
||||
// Include 'text' reporter so coverage summary appears after e2e tests complete.
|
||||
reporter: [['text', { maxCols: 200 }], 'html', 'json-summary', 'json'],
|
||||
reportsDirectory: '.coverage/e2e',
|
||||
reportOnFailure: true,
|
||||
clean: true,
|
||||
|
||||
@@ -81,8 +81,8 @@ const finalConfig = mergeConfig(
|
||||
fileParallelism: false,
|
||||
coverage: {
|
||||
provider: 'v8',
|
||||
// We remove 'text' here. The final text report will be generated by `nyc` after merging.
|
||||
reporter: ['html', 'json-summary', 'json'],
|
||||
// Include 'text' reporter so coverage summary appears after integration tests complete.
|
||||
reporter: [['text', { maxCols: 200 }], 'html', 'json-summary', 'json'],
|
||||
reportsDirectory: '.coverage/integration',
|
||||
reportOnFailure: true, // This ensures the report generates even if tests fail
|
||||
clean: true,
|
||||
|
||||
Reference in New Issue
Block a user