From 0cf56ee2b59488f5ed811fd325efee5edac39b25 Mon Sep 17 00:00:00 2001 From: kimpaev Date: Tue, 3 Nov 2026 17:30:05 +0300 Subject: [PATCH] =?UTF-8?q?=D0=9B=D0=A0=202:=20PostgreSQL=20=D0=B8=20?= =?UTF-8?q?=D1=81=D0=B5=D1=81=D1=81=D0=B8=D0=B8,=20=D0=BE=D1=86=D0=B5?= =?UTF-8?q?=D0=BD=D0=BA=D0=B0=203?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Dockerfile | 9 ++ REPORT.md | 163 +++++++++++++++++++++++++++++++------ app/__init__.py | 0 app/dependencies.py | 26 ++++++ app/main.py | 63 ++++++++++++++ app/models/__init__.py | 0 app/models/chats.py | 39 +++++++++ app/models/messages.py | 33 ++++++++ app/models/time_format.py | 9 ++ app/models/users.py | 28 +++++++ app/routers/__init__.py | 0 app/routers/chats.py | 52 ++++++++++++ app/routers/messages.py | 60 ++++++++++++++ app/routers/users.py | 78 ++++++++++++++++++ app/storage.py | 29 +++++++ compose.yaml | 36 ++++++++ migrations/001_initial.sql | 35 ++++++++ requirements.txt | 3 + scripts/restart.cmd | 4 + scripts/restart.sh | 4 + scripts/setup.sh | 21 +++++ 21 files changed, 668 insertions(+), 24 deletions(-) create mode 100644 Dockerfile create mode 100644 app/__init__.py create mode 100644 app/dependencies.py create mode 100644 app/main.py create mode 100644 app/models/__init__.py create mode 100644 app/models/chats.py create mode 100644 app/models/messages.py create mode 100644 app/models/time_format.py create mode 100644 app/models/users.py create mode 100644 app/routers/__init__.py create mode 100644 app/routers/chats.py create mode 100644 app/routers/messages.py create mode 100644 app/routers/users.py create mode 100644 app/storage.py create mode 100644 compose.yaml create mode 100644 migrations/001_initial.sql create mode 100644 requirements.txt create mode 100644 scripts/restart.cmd create mode 100644 scripts/restart.sh create mode 100644 scripts/setup.sh diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..83ca335 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,9 @@ +FROM python:3.12-slim +WORKDIR /srv +ENV PYTHONDONTWRITEBYTECODE=1 PYTHONUNBUFFERED=1 +COPY requirements.txt ./ +RUN pip install --no-cache-dir -r requirements.txt +COPY app ./app +COPY migrations ./migrations +EXPOSE 8080 +CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "8080"] diff --git a/REPORT.md b/REPORT.md index e42f2b0..8ae3cb7 100644 --- a/REPORT.md +++ b/REPORT.md @@ -1,37 +1,152 @@ -# Отчёт — лабораторная 2 +# Отчёт по лабораторной работе № 2 -- Автор, группа: TODO -- Целевая оценка; выбранный трек 5, если нужен: TODO -- Commit/PR: TODO после публикации -- Использованные источники, библиотеки и помощь ИИ: TODO +**Тема:** PostgreSQL, сессии и Redis/Valkey +**Студент:** Кимпаев А.Р. +**Группа:** БПИ2303 +**Целевая оценка:** **3** +**Трек уровня 5:** не заявлен +**Ветка решения:** `solution/bpi2303-kimpaev` -## Запуск из чистого clone +## 1. Цель и выполненная работа -TODO: версии runtime/образов, prerequisites, команды создания локальных secrets/.env, build, миграций, запуска, ожидания готовности, тестов и остановки. Указать необходимые действия оператора. Не вставлять секреты. Отдельно указать безопасную остановку и команду намеренного удаления учебных данных. +Цель — перенести серверную часть мессенджера из ЛР № 1 на постоянное хранилище PostgreSQL, реализовать аутентификацию и обеспечить сохранность подтверждённых данных и действующих сессий при перезапуске приложения и БД. -## Архитектура и решения +Перенесены функции ЛР № 1: регистрация пользователей, создание и просмотр чатов, управление составом участников при создании чата, отправка сообщений и чтение истории с пагинацией. С учётом перехода контракта ЛР № 2 регистрация требует пароль; `POST /api/v1/auth/sessions` использует HTTP Basic; остальные защищённые операции — Bearer-токен вместо `X-User-Id`. Добавлены завершение сеанса (`logout`) и время действия сессии. -TODO: схема процессов/хранилищ, источник истины, транзакционные границы, ограничения. Что перенесено из lab1, что изменено в этой работе. Соответствие переменных из .env.example реальной конфигурации. +Использованы Python 3.12, FastAPI, Pydantic, psycopg 3, PostgreSQL 16.8, Docker Compose. Redis/Valkey не использованы: на уровне оценки «3» источником истины для данных и сессий является PostgreSQL. -## Доказательства критериев +## 2. Архитектура и схема данных -| Критерий README | Команда/сценарий | Наблюдаемый результат | Файл доказательства | -| --- | --- | --- | --- | -| Публичный smoke | make test | TODO | TODO | -| Остальные пункты уровня 3 | TODO | TODO | TODO | -| Все пункты уровня 4, если заявлен | TODO | TODO | TODO | -| Выбранный трек 5, если заявлен | TODO | TODO | TODO | +```text +HTTP-клиент + | + v +FastAPI (api, порт localhost:8080) + | + v +PostgreSQL (db, порт 5432 внутри сети Compose) + | + v +Именованный volume postgres_data +``` -TODO: добавить отдельную строку для каждого заявленного критерия. PASS без команды и наблюдения не является доказательством. Проверка инфраструктурного hook требует подтверждения, какие реальные процессы/хранилища перезапущены. +Структура описана миграцией `migrations/001_initial.sql`: -## Эксперименты и отказы +| Таблица | Назначение | Ключевые ограничения и индексы | +| --- | --- | --- | +| `users` | Пользователи и хеши паролей | `id` — PK; `username` — UNIQUE; ограничение формата username | +| `chats` | Чаты | `id` — PK | +| `chat_members` | Участие пользователей в чатах | Составной PK (`chat_id`, `user_id`); FK на чаты/пользователей; индекс (`user_id`, `chat_id`) | +| `messages` | Сообщения | `id` — PK; FK на чат и отправителя; запрет пустого текста; индекс (`chat_id`, `created_at`, `id`) | +| `sessions` | Авторизованные сессии | PK `token_hash`, FK `user_id`, `expires_at`, индекс по времени истечения | +| `schema_migrations` | Применённые версии миграций | PK `version` | -TODO: гипотеза, hardware/лимиты, версии, объём данных, профиль нагрузки, concurrency/arrival rate, длительность/прогрев, повторы, успешные RPS, ошибки, p50/p95/p99, CPU/RAM. Сохранить raw summary без tokens и объяснить ограничения измерения. +При запуске FastAPI вызывает `migrate()`. Скрипты `migrations/*.sql` применяются по порядку; выполненные версии фиксируются в `schema_migrations`, повторное применение пропускается. Ограничения `IF NOT EXISTS` в начальной миграции дополнительно позволяют безопасно создавать отсутствующие объекты. -| Воздействие | Что ожидаем | Что наблюдали | Время восстановления / потеря данных | -| --- | --- | --- | --- | -| TODO | TODO | TODO | TODO | +**Транзакционные границы:** создание чата (`chats` + все строки `chat_members`) производится в одной транзакции psycopg: ошибка отменяет операцию целиком. Вставка сообщения подтверждается завершением транзакции (COMMIT) перед возвращением успешного HTTP-ответа. История сообщений использует keyset-пагинацию по `(created_at, id)` и составной индекс с первым полем `chat_id`. -## Ограничения и следующие шаги +**Сохранность:** все постоянные данные и сессии находятся в PostgreSQL, которая использует именованный volume `postgres_data`. Перезапуск контейнеров без удаления volume не уничтожает уже подтверждённые записи. При сбое до COMMIT результат незавершённого запроса не гарантируется. -TODO: какие отказы выдерживаются и какие нет; что не реализовано; где учебное упрощение; какое улучшение подтверждено, а какое пока гипотеза. +## 3. Аутентификация, авторизация и безопасность + +- При регистрации пароль обрабатывается `scrypt` (password KDF) с индивидуальной случайной солью. В БД хранится производный хеш, а не исходный пароль. +- Вход выполняется через HTTP Basic только на `POST /api/v1/auth/sessions`. При успешном входе создаётся случайный opaque Bearer-токен; клиент получает сам токен, PostgreSQL хранит только его SHA-256. +- Срок действия сессии задаётся `SESSION_TTL_SECONDS` (по умолчанию 3600 секунд). При обращениях проверяется `expires_at > now()`; после истечения срока сессия перестаёт действовать. +- Выход `DELETE /api/v1/auth/sessions/current` удаляет соответствующую запись из `sessions`. Повторное использование отозванного токена не допускается. +- Для защищённых операций `X-User-Id` не является доказательством входа. Доступ к конкретному чату проверяется по `chat_members`; постороннему пользователю данные чата не выдаются. +- SQL-параметры передаются через плейсхолдеры psycopg. Файлы `.env` и `secrets/` исключены из Git через `.gitignore`. + +## 4. Запуск из чистого clone + +**Требования:** установленный и запущенный Docker Desktop (Docker Engine + Compose), Python 3.9+ для публичных тестов, `make`; команды выполнять в корне репозитория ЛР № 2. + +### Linux / WSL / Git Bash + +```sh +bash scripts/setup.sh +docker compose --env-file .env config --quiet +docker compose --env-file .env up -d --build +curl http://localhost:8080/health/ready +make check +make test +``` + +`setup.sh` создаёт локальные файлы `secrets/db_password`, `secrets/database_url` и `.env`, если их ещё нет. При первом запуске PostgreSQL использует пароль из `db_password`; при сохранённом volume смена файла сама по себе **не меняет пароль роли в БД**. Не перегенерируйте секреты на уже инициализированном volume без синхронизации учётных данных. + +Проверка сохранности с Linux/WSL-скриптом: + +```sh +chmod +x scripts/restart.sh +make test-persistence ACTION_SCRIPT=scripts/restart.sh +``` + +В Windows Git Bash с Windows Python прямой запуск `*.sh` из `subprocess` может завершаться `WinError 193`. Для этого окружения применён эквивалентный `scripts/restart.cmd`: + +```bat +@echo off +cd /d "%~dp0.." +docker compose --env-file .env restart db api +exit /b %errorlevel% +``` + +Проверка в Git Bash на Windows: + +```sh +make test-persistence ACTION_SCRIPT=scripts/restart.cmd +``` + +Сценарии `restart.sh` / `restart.cmd` выполняют `docker compose restart db api`, **не вызывают** `down -v`, не удаляют volumes и не пересоздают тестовые данные. Для доказательства охвата перезапуска преподавателю можно показать текст скрипта и состояние контейнеров перед/после теста: + +```sh +docker compose ps +docker compose logs --tail=30 api db +``` + +Swagger UI: `http://localhost:8080/docs`. Проверка liveness: `http://localhost:8080/health/live`; readiness (с подключением к БД): `http://localhost:8080/health/ready`. + +Остановка без потери данных: `docker compose down`. Команду `docker compose down -v` **не использовать**, если данные требуется сохранить. + +## 5. Результаты проверок + +Проверки выполнены **03.11.2026**, Windows 11 / Git Bash (UCRT64), локальный Docker Compose, `http://localhost:8080`. + +| Проверка | Команда | Фактический результат | +| --- | --- | --- | +| Структура проекта и синтаксис | `make check` | **PASS** — `offline skeleton structure, local refs and Python syntax; application NOT tested.` | +| Публичный сценарий API | `make test` | **PASS** — `lab2 public API scenario; infrastructure and grading evidence remain separate.` | +| Сохранность данных и сессии после перезапуска | `make test-persistence ACTION_SCRIPT=scripts/restart.cmd` | **PASS** — `persistence preserved confirmed data and existing session. Hook scope needs operator evidence.` | +| Прямой health-check | `curl http://localhost:8080/health/live` | `{"status":"ok"}` | +| Контейнеры после запуска | `docker compose ps` | `api` — Up, `db` — Up (healthy) | + +Вывод последней проверки persistence: + +```text +python3 tests/resilience.py --mode persistence --action-script "scripts/restart.cmd" --base-url "http://localhost:8080" +Executing explicit persistence hook; hook output suppressed to avoid leaking secrets. +PASS: persistence preserved confirmed data and existing session. Hook scope needs operator evidence. +``` + +Проверка `test-persistence` подтвердила сохранение созданных тестом данных и действующего токена. При этом сам тест **не доказывает**, что hook действительно рестартовал оба контейнера; это подтверждается содержимым `scripts/restart.cmd`/`scripts/restart.sh` и демонстрацией Docker Compose. Отдельная проверка короткого TTL и повторного применения миграций на чистом volume в приведённых логах не зафиксирована; их можно продемонстрировать дополнительно на защите. + +## 6. Ограничения и известные особенности + +1. Это локальный учебный стенд, слушающий `127.0.0.1:8080`, без HTTPS на внешнем интерфейсе; Basic-аутентификацию нельзя использовать по незашифрованному соединению в публичной сети. +2. Нет Redis/Valkey, горизонтального масштабирования и отдельного connection pool — это не заявлено для уровня «3». +3. При недоступности PostgreSQL операции с данными невозможны; приложение обрабатывает `psycopg.OperationalError` как ошибку зависимости. Не подтверждённые сервером записи после сбоя не считаются сохранёнными. +4. Для проверки persistence на Windows с Windows Python нужен `restart.cmd`, а на Linux/WSL — `restart.sh`. +5. Публичные smoke/persistence тесты не заменяют полноценные нагрузочные, security и конкурентные испытания. Оценка преподавателем не определяется одним сообщением `PASS`. + +## 7. Источники и использование ИИ + +Реализация выполнена на базе собственного проекта ЛР № 1 и skeleton ЛР № 2. Использованы требования `README.md`, `COURSE.md`, `contracts/`, `tests/README.md`, `CONTRIBUTING.md`, а также документация Python/FastAPI, PostgreSQL и Docker Compose. При подготовке и отладке кода, Docker-конфигурации и документации применялась помощь **ChatGPT (OpenAI)**. Запуск контейнеров и публичных тестов произведён локально; фактические результаты приведены выше. Пароли, токены и содержимое `secrets/` в отчёт не включены. + +## 8. Контрольный список перед отправкой MR + +- [x] Реализованы основные функции ЛР № 1 с объявленным переходом на Basic/Bearer. +- [x] PostgreSQL, миграции, ограничения и хранение действующих сессий. +- [x] Локальный Compose-стенд с именованным volume. +- [x] `make check` и `make test` — PASS. +- [x] Persistence с `scripts/restart.cmd` на Windows — PASS. +- [x] Имеется `scripts/restart.sh` для Linux/WSL. +- [ ] Перед публикацией проверить `git status`, `git diff --cached` и отсутствие `.env`, `secrets/`, данных volume. +- [ ] После push вставить ссылку на MR и commit в раздел в начале отчёта. diff --git a/app/__init__.py b/app/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/dependencies.py b/app/dependencies.py new file mode 100644 index 0000000..a52061f --- /dev/null +++ b/app/dependencies.py @@ -0,0 +1,26 @@ +import hashlib +from fastapi import Header, HTTPException +from app.storage import db + +BEARER_CHALLENGE = {"WWW-Authenticate": 'Bearer realm="messenger"'} +BASIC_CHALLENGE = {"WWW-Authenticate": 'Basic realm="messenger", charset="UTF-8"'} + + +def unauthorized(basic=False): + raise HTTPException(status_code=401, detail="Unauthorized", headers=BASIC_CHALLENGE if basic else BEARER_CHALLENGE) + + +def current_user(authorization: str | None = Header(default=None)): + if not authorization or not authorization.startswith("Bearer "): + unauthorized() + token = authorization[7:] + if not token or " " in token: + unauthorized() + with db() as conn: + user = conn.execute("""SELECT u.id,u.username,u.display_name,u.created_at FROM sessions s + JOIN users u ON u.id=s.user_id + WHERE s.token_hash=%s AND s.expires_at > now()""", + (hashlib.sha256(token.encode()).hexdigest(),)).fetchone() + if user is None: + unauthorized() + return user diff --git a/app/main.py b/app/main.py new file mode 100644 index 0000000..f44c46a --- /dev/null +++ b/app/main.py @@ -0,0 +1,63 @@ +from contextlib import asynccontextmanager +from uuid import uuid4 +from fastapi import FastAPI, Request, HTTPException +from fastapi.exceptions import RequestValidationError +from fastapi.responses import JSONResponse +from psycopg import OperationalError +from app.routers import users,chats,messages +from app.storage import db,migrate + +@asynccontextmanager +async def lifespan(app): + migrate() + yield + +app=FastAPI(lifespan=lifespan) + + +def error_code(status): + return {400:'invalid_request',401:'unauthorized',404:'not_found',409:'conflict',503:'unavailable'}.get(status,'internal_error') + + +def error_response(request,status,message,headers=None): + result=JSONResponse(status_code=status,content={'error':{ + 'code':error_code(status),'message':message,'request_id':request.state.request_id}},headers=headers) + result.headers['X-Request-Id']=request.state.request_id + return result + + +@app.middleware('http') +async def add_request_id(request:Request,call_next): + request.state.request_id=str(uuid4()) + try: + response=await call_next(request) + except OperationalError: + response=error_response(request,503,'Database unavailable') + except Exception: + response=error_response(request,500,'Internal server error') + response.headers['X-Request-Id']=request.state.request_id + return response + + +@app.exception_handler(HTTPException) +async def http_error(request,exc): + return error_response(request,exc.status_code,str(exc.detail),exc.headers) + + +@app.exception_handler(RequestValidationError) +async def validation_error(request,exc): + return error_response(request,400,'Invalid request') + +app.include_router(users.router) +app.include_router(chats.router) +app.include_router(messages.router) + +@app.get('/health/live') +def live(): + return {'status':'ok'} + +@app.get('/health/ready') +def ready(): + with db() as conn: + conn.execute('SELECT 1') + return {'status':'ok'} diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/models/chats.py b/app/models/chats.py new file mode 100644 index 0000000..751ca46 --- /dev/null +++ b/app/models/chats.py @@ -0,0 +1,39 @@ +from datetime import datetime +from app.models.time_format import utc_z +from uuid import UUID +from pydantic import BaseModel, ConfigDict, Field, field_validator, field_serializer + +class CreateChat(BaseModel): + model_config = ConfigDict(extra="forbid") + title: str = Field(min_length=1, max_length=100) + member_ids: list[UUID] = Field(min_length=1, max_length=100) + + @field_validator("title") + @classmethod + def title_must_not_be_blank(cls, value: str) -> str: + if not value.strip(): + raise ValueError("title must not be blank") + return value + + @field_validator("member_ids") + @classmethod + def member_ids_must_be_unique(cls, value: list[UUID]) -> list[UUID]: + if len(value) != len(set(value)): + raise ValueError("member_ids must be unique") + return value + +class Chat(BaseModel): + model_config = ConfigDict(extra="forbid") + id: UUID + title: str + member_ids: list[UUID] + created_at: datetime + + @field_serializer("created_at", when_used="json") + def serialize_created_at(self, value: datetime) -> str: + return utc_z(value) + +class ChatPage(BaseModel): + model_config = ConfigDict(extra="forbid") + items: list[Chat] + next_cursor: str | None diff --git a/app/models/messages.py b/app/models/messages.py new file mode 100644 index 0000000..b866f73 --- /dev/null +++ b/app/models/messages.py @@ -0,0 +1,33 @@ +from datetime import datetime +from app.models.time_format import utc_z +from uuid import UUID +from pydantic import BaseModel, ConfigDict, Field, field_validator, field_serializer + +class CreateMessage(BaseModel): + model_config = ConfigDict(extra="forbid") + text: str = Field(min_length=1, max_length=4000) + + @field_validator("text") + @classmethod + def text_must_not_be_blank(cls, value: str) -> str: + if not value.strip(): + raise ValueError("text must not be blank") + return value + +class Message(BaseModel): + model_config = ConfigDict(extra="forbid") + id: UUID + chat_id: UUID + sender_id: UUID + text: str + created_at: datetime + + @field_serializer("created_at", when_used="json") + def serialize_created_at(self, value: datetime) -> str: + return utc_z(value) + +class MessagePage(BaseModel): + model_config = ConfigDict(extra="forbid") + + items: list[Message] + next_cursor: str | None diff --git a/app/models/time_format.py b/app/models/time_format.py new file mode 100644 index 0000000..10670db --- /dev/null +++ b/app/models/time_format.py @@ -0,0 +1,9 @@ +"""Contract requires RFC3339 UTC timestamps with a literal Z suffix.""" +from datetime import datetime, timezone + + +def utc_z(value: datetime) -> str: + if value.tzinfo is None: + # Database columns are TIMESTAMPTZ, but keep the serializer defensive. + value = value.replace(tzinfo=timezone.utc) + return value.astimezone(timezone.utc).isoformat().replace('+00:00', 'Z') diff --git a/app/models/users.py b/app/models/users.py new file mode 100644 index 0000000..7b8d92a --- /dev/null +++ b/app/models/users.py @@ -0,0 +1,28 @@ +from datetime import datetime +from app.models.time_format import utc_z +from uuid import UUID +from pydantic import BaseModel, ConfigDict, Field, field_validator, field_serializer + +class CreateUser(BaseModel): + model_config = ConfigDict(extra="forbid") + username: str = Field(pattern=r"^[a-z0-9_]{3,32}$") + display_name: str = Field(min_length=1, max_length=100) + password: str = Field(min_length=12, max_length=128) + + @field_validator("display_name") + @classmethod + def nonempty(cls, value): + if not value.strip(): + raise ValueError("Blank display name") + return value + +class User(BaseModel): + model_config = ConfigDict(extra="forbid") + id: UUID + username: str + display_name: str + created_at: datetime + + @field_serializer("created_at", when_used="json") + def serialize_created_at(self, value: datetime) -> str: + return utc_z(value) diff --git a/app/routers/__init__.py b/app/routers/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/routers/chats.py b/app/routers/chats.py new file mode 100644 index 0000000..5bab142 --- /dev/null +++ b/app/routers/chats.py @@ -0,0 +1,52 @@ +from uuid import UUID, uuid4 +from fastapi import APIRouter, Depends, HTTPException, Query +from app.dependencies import current_user +from app.models.chats import Chat, ChatPage, CreateChat +from app.storage import db + +router = APIRouter() + + +def get_chat_row(conn, chat_id, user_id): + return conn.execute("""SELECT c.id,c.title,c.created_at FROM chats c + JOIN chat_members cm ON cm.chat_id=c.id WHERE c.id=%s AND cm.user_id=%s""", + (chat_id,user_id)).fetchone() + + +def chat_output(conn,row): + members=conn.execute('SELECT user_id FROM chat_members WHERE chat_id=%s ORDER BY user_id',(row['id'],)).fetchall() + return {**row, 'member_ids':[m['user_id'] for m in members]} + + +@router.post('/api/v1/chats', response_model=Chat, status_code=201) +def create_chat(payload:CreateChat,user=Depends(current_user)): + if user['id'] not in payload.member_ids: + raise HTTPException(status_code=400,detail='Creator must be a chat member') + with db() as conn: + rows=conn.execute('SELECT id FROM users WHERE id = ANY(%s)',(payload.member_ids,)).fetchall() + if len(rows)!=len(payload.member_ids): + raise HTTPException(status_code=400,detail='Unknown member') + chat=conn.execute('INSERT INTO chats(id,title) VALUES (%s,%s) RETURNING id,title,created_at', + (uuid4(),payload.title)).fetchone() + for member in payload.member_ids: + conn.execute('INSERT INTO chat_members(chat_id,user_id) VALUES (%s,%s)',(chat['id'],member)) + return chat_output(conn,chat) + + +@router.get('/api/v1/chats',response_model=ChatPage) +def list_chats(limit:int=Query(default=50,ge=1,le=100),user=Depends(current_user)): + with db() as conn: + rows=conn.execute("""SELECT c.id,c.title,c.created_at FROM chats c + JOIN chat_members m ON m.chat_id=c.id WHERE m.user_id=%s + ORDER BY c.created_at,c.id LIMIT %s""",(user['id'],limit+1)).fetchall() + items=[chat_output(conn,row) for row in rows[:limit]] + return {'items':items,'next_cursor':None} + + +@router.get('/api/v1/chats/{chat_id}',response_model=Chat) +def get_chat(chat_id:UUID,user=Depends(current_user)): + with db() as conn: + row=get_chat_row(conn,chat_id,user['id']) + if row is None: + raise HTTPException(status_code=404,detail='Chat not found') + return chat_output(conn,row) diff --git a/app/routers/messages.py b/app/routers/messages.py new file mode 100644 index 0000000..dc172e6 --- /dev/null +++ b/app/routers/messages.py @@ -0,0 +1,60 @@ +import base64 +import binascii +import json +from datetime import datetime +from uuid import UUID,uuid4 +from fastapi import APIRouter,Depends,HTTPException,Query +from app.dependencies import current_user +from app.models.messages import CreateMessage,Message,MessagePage +from app.routers.chats import get_chat_row +from app.storage import db + +router=APIRouter() + + +def encode_cursor(chat_id,row): + raw=json.dumps({'chat_id':str(chat_id),'created_at':row['created_at'].isoformat(),'id':str(row['id'])}).encode() + return base64.urlsafe_b64encode(raw).decode().rstrip('=') + + +def decode_cursor(chat_id,cursor): + try: + raw=base64.b64decode(cursor+'='*(-len(cursor)%4),altchars=b'-_',validate=True) + data=json.loads(raw) + ts=datetime.fromisoformat(data['created_at']) + ident=UUID(data['id']) + if data['chat_id']!=str(chat_id) or ts.tzinfo is None: + raise ValueError('Wrong cursor') + return ts,ident + except (ValueError,KeyError,TypeError,UnicodeDecodeError,binascii.Error): + raise HTTPException(status_code=400,detail='Invalid cursor') + + +@router.post('/api/v1/chats/{chat_id}/messages',response_model=Message,status_code=201) +def create_message(chat_id:UUID,payload:CreateMessage,user=Depends(current_user)): + with db() as conn: + if get_chat_row(conn,chat_id,user['id']) is None: + raise HTTPException(status_code=404,detail='Chat not found') + row=conn.execute("""INSERT INTO messages(id,chat_id,sender_id,text) + VALUES (%s,%s,%s,%s) RETURNING id,chat_id,sender_id,text,created_at""", + (uuid4(),chat_id,user['id'],payload.text)).fetchone() + return row + + +@router.get('/api/v1/chats/{chat_id}/messages',response_model=MessagePage) +def list_messages(chat_id:UUID,limit:int=Query(default=50,ge=1,le=100), + cursor:str|None=Query(default=None,min_length=1),user=Depends(current_user)): + with db() as conn: + if get_chat_row(conn,chat_id,user['id']) is None: + raise HTTPException(status_code=404,detail='Chat not found') + if cursor is not None: + ts,ident=decode_cursor(chat_id,cursor) + rows=conn.execute("""SELECT id,chat_id,sender_id,text,created_at FROM messages + WHERE chat_id=%s AND (created_at,id)>(%s,%s) + ORDER BY created_at,id LIMIT %s""",(chat_id,ts,ident,limit+1)).fetchall() + else: + rows=conn.execute("""SELECT id,chat_id,sender_id,text,created_at FROM messages + WHERE chat_id=%s ORDER BY created_at,id LIMIT %s""",(chat_id,limit+1)).fetchall() + items=rows[:limit] + next_cursor=encode_cursor(chat_id,items[-1]) if len(rows)>limit else None + return {'items':items,'next_cursor':next_cursor} diff --git a/app/routers/users.py b/app/routers/users.py new file mode 100644 index 0000000..d015dcb --- /dev/null +++ b/app/routers/users.py @@ -0,0 +1,78 @@ +import base64 +import binascii +import hashlib +import hmac +import os +import secrets +from datetime import datetime, timedelta, timezone +from uuid import uuid4 +from fastapi import APIRouter, Depends, Header, HTTPException, Response +from psycopg.errors import UniqueViolation +from app.dependencies import current_user, unauthorized +from app.models.users import CreateUser, User +from app.models.time_format import utc_z +from app.storage import db + +router = APIRouter() + + +def password_hash(password): + salt = os.urandom(16) + derived = hashlib.scrypt(password.encode('utf-8'), salt=salt, n=2**14, r=8, p=1, dklen=32) + return 'scrypt$' + salt.hex() + '$' + derived.hex() + + +def verify_password(password, encoded): + try: + _, salt_hex, expected_hex = encoded.split('$') + actual = hashlib.scrypt(password.encode('utf-8'),salt=bytes.fromhex(salt_hex),n=2**14,r=8,p=1,dklen=32) + return hmac.compare_digest(actual, bytes.fromhex(expected_hex)) + except (ValueError, TypeError): + return False + + +@router.post('/api/v1/users', response_model=User, status_code=201) +def register_user(payload: CreateUser): + with db() as conn: + try: + user = conn.execute("""INSERT INTO users(id,username,display_name,password_hash) + VALUES (%s,%s,%s,%s) RETURNING id,username,display_name,created_at""", + (uuid4(),payload.username,payload.display_name,password_hash(payload.password))).fetchone() + except UniqueViolation: + raise HTTPException(status_code=409,detail='Username already exists') + return user + + +@router.get('/api/v1/users/me', response_model=User) +def get_current_user(user=Depends(current_user)): + return user + + +@router.post('/api/v1/auth/sessions', status_code=201) +def create_session(authorization: str | None = Header(default=None)): + if not authorization or not authorization.startswith('Basic '): + unauthorized(basic=True) + try: + raw = base64.b64decode(authorization[6:],validate=True).decode('utf-8') + username, password = raw.split(':',1) + except (ValueError, UnicodeDecodeError, binascii.Error): + unauthorized(basic=True) + with db() as conn: + row = conn.execute('SELECT * FROM users WHERE username=%s',(username,)).fetchone() + if row is None or not verify_password(password,row['password_hash']): + unauthorized(basic=True) + token = secrets.token_urlsafe(48) + ttl = int(os.getenv('SESSION_TTL_SECONDS','3600')) + expires = datetime.now(timezone.utc)+timedelta(seconds=ttl) + conn.execute('INSERT INTO sessions(token_hash,user_id,expires_at) VALUES (%s,%s,%s)', + (hashlib.sha256(token.encode()).hexdigest(),row['id'],expires)) + return {'token':token,'token_type':'Bearer','expires_at':utc_z(expires), + 'user':User.model_validate({key:row[key] for key in ('id','username','display_name','created_at')})} + + +@router.delete('/api/v1/auth/sessions/current',status_code=204) +def logout(authorization: str | None = Header(default=None),user=Depends(current_user)): + token=authorization[7:] + with db() as conn: + conn.execute('DELETE FROM sessions WHERE token_hash=%s',(hashlib.sha256(token.encode()).hexdigest(),)) + return Response(status_code=204) diff --git a/app/storage.py b/app/storage.py new file mode 100644 index 0000000..f327c7a --- /dev/null +++ b/app/storage.py @@ -0,0 +1,29 @@ +"""PostgreSQL is the source of truth, including bearer sessions.""" +import os +from contextlib import contextmanager +from pathlib import Path +import psycopg +from psycopg.rows import dict_row + + +def database_url(): + secret_file = os.getenv("DATABASE_URL_FILE") + if secret_file: + return Path(secret_file).read_text().strip() + return os.environ["DATABASE_URL"] + + +@contextmanager +def db(): + with psycopg.connect(database_url(), row_factory=dict_row, connect_timeout=5) as conn: + yield conn + + +def migrate(): + with db() as conn: + conn.execute("CREATE TABLE IF NOT EXISTS schema_migrations (version TEXT PRIMARY KEY)") + for file in sorted((Path(__file__).parent.parent / "migrations").glob("*.sql")): + if conn.execute("SELECT 1 FROM schema_migrations WHERE version=%s", (file.name,)).fetchone(): + continue + conn.execute(file.read_text()) + conn.execute("INSERT INTO schema_migrations(version) VALUES (%s)", (file.name,)) diff --git a/compose.yaml b/compose.yaml new file mode 100644 index 0000000..ba242c4 --- /dev/null +++ b/compose.yaml @@ -0,0 +1,36 @@ +services: + db: + image: postgres:16.8-alpine + environment: + POSTGRES_DB: messenger + POSTGRES_USER: messenger + POSTGRES_PASSWORD_FILE: /run/secrets/db_password + secrets: + - db_password + volumes: + - postgres_data:/var/lib/postgresql/data + healthcheck: + test: ["CMD-SHELL", "pg_isready -U messenger -d messenger"] + interval: 2s + timeout: 3s + retries: 30 + api: + build: . + ports: + - "127.0.0.1:8080:8080" + environment: + DATABASE_URL_FILE: /run/secrets/database_url + SESSION_TTL_SECONDS: ${SESSION_TTL_SECONDS:-3600} + secrets: + - database_url + depends_on: + db: + condition: service_healthy + restart: unless-stopped +secrets: + db_password: + file: ./secrets/db_password + database_url: + file: ./secrets/database_url +volumes: + postgres_data: diff --git a/migrations/001_initial.sql b/migrations/001_initial.sql new file mode 100644 index 0000000..9573c00 --- /dev/null +++ b/migrations/001_initial.sql @@ -0,0 +1,35 @@ +CREATE TABLE IF NOT EXISTS users ( + id UUID PRIMARY KEY, + username VARCHAR(32) NOT NULL UNIQUE, + display_name VARCHAR(100) NOT NULL, + password_hash TEXT NOT NULL, + created_at TIMESTAMPTZ NOT NULL DEFAULT now(), + CONSTRAINT username_format CHECK (username ~ '^[a-z0-9_]{3,32}$') +); +CREATE TABLE IF NOT EXISTS chats ( + id UUID PRIMARY KEY, + title VARCHAR(100) NOT NULL, + created_at TIMESTAMPTZ NOT NULL DEFAULT now() +); +CREATE TABLE IF NOT EXISTS chat_members ( + chat_id UUID NOT NULL REFERENCES chats(id) ON DELETE CASCADE, + user_id UUID NOT NULL REFERENCES users(id), + PRIMARY KEY (chat_id, user_id) +); +CREATE INDEX IF NOT EXISTS chat_members_user ON chat_members(user_id, chat_id); +CREATE TABLE IF NOT EXISTS messages ( + id UUID PRIMARY KEY, + chat_id UUID NOT NULL REFERENCES chats(id) ON DELETE CASCADE, + sender_id UUID NOT NULL REFERENCES users(id), + text VARCHAR(4000) NOT NULL, + created_at TIMESTAMPTZ NOT NULL DEFAULT now(), + CONSTRAINT nonblank_message CHECK (length(btrim(text)) > 0) +); +CREATE INDEX IF NOT EXISTS messages_chat_cursor ON messages(chat_id, created_at, id); +CREATE TABLE IF NOT EXISTS sessions ( + token_hash CHAR(64) PRIMARY KEY, + user_id UUID NOT NULL REFERENCES users(id) ON DELETE CASCADE, + expires_at TIMESTAMPTZ NOT NULL, + created_at TIMESTAMPTZ NOT NULL DEFAULT now() +); +CREATE INDEX IF NOT EXISTS sessions_expiry ON sessions(expires_at); diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..55e88b4 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +fastapi==0.115.12 +uvicorn==0.34.2 +psycopg[binary]==3.2.6 diff --git a/scripts/restart.cmd b/scripts/restart.cmd new file mode 100644 index 0000000..19bc105 --- /dev/null +++ b/scripts/restart.cmd @@ -0,0 +1,4 @@ +@echo off +cd /d "%~dp0.." +docker compose --env-file .env restart db api +exit /b %errorlevel% diff --git a/scripts/restart.sh b/scripts/restart.sh new file mode 100644 index 0000000..5e55541 --- /dev/null +++ b/scripts/restart.sh @@ -0,0 +1,4 @@ +#!/bin/sh +set -eu +cd "$(dirname "$0")/.." +docker compose --env-file .env restart db api diff --git a/scripts/setup.sh b/scripts/setup.sh new file mode 100644 index 0000000..4ae856a --- /dev/null +++ b/scripts/setup.sh @@ -0,0 +1,21 @@ +#!/bin/sh +set -eu +cd "$(dirname "$0")/.." +mkdir -p secrets +chmod 700 secrets +if [ ! -f secrets/db_password ]; then + python3 -c 'import secrets; print(secrets.token_urlsafe(32))' > secrets/db_password +fi +chmod 600 secrets/db_password +if [ ! -f secrets/database_url ]; then + python3 - <<'PY2' > secrets/database_url +from pathlib import Path +from urllib.parse import quote +p=Path('secrets/db_password').read_text().strip() +print('postgresql://messenger:'+quote(p,safe='')+'@db:5432/messenger') +PY2 +fi +chmod 600 secrets/database_url +if [ ! -f .env ]; then + printf 'SESSION_TTL_SECONDS=3600\n' > .env +fi