Author SHA1 Message Date
dariam b5e88faca9 Обновить REPORT.md 2026-11-10 17:27:11 +03:00
dariam 448b3995e6 Обновить REPORT.md 2026-11-10 17:08:02 +03:00
pampixz e0263ad163 лр2 2026-11-10 16:58:53 +03:00
9 changed files with 481 additions and 24 deletions
+8
View File
@@ -0,0 +1,8 @@
FROM python:3.12-slim
WORKDIR /app
COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt
COPY main.py migrate.py ./
COPY migrations/ ./migrations/
EXPOSE 8080
CMD ["sh", "-c", "python migrate.py && exec uvicorn main:app --host 0.0.0.0 --port 8080"]
+132 -24
View File
@@ -1,37 +1,145 @@
# Отчёт — лабораторная 2
# Лабораторная работа № 2
- Автор, группа: TODO
- Целевая оценка; выбранный трек 5, если нужен: TODO
- Commit/PR: TODO после публикации
- Использованные источники, библиотеки и помощь ИИ: TODO
## Запуск из чистого clone
**Автор, группа:** Магазейщикова Дарья, БПИ2304
**Целевая оценка:** 3
**Commit/PR:** https://gitea.privcloud.tech/dariam/mtusi2026lab2.git
**Использованные источники, библиотеки и помощь ИИ:** Python 3.12, FastAPI, PostgreSQL, Psycopg, Docker, Docker Compose, Uvicorn, Password KDF, HTTP Basic, Bearer.
TODO: версии runtime/образов, prerequisites, команды создания локальных secrets/.env, build, миграций, запуска, ожидания готовности, тестов и остановки. Указать необходимые действия оператора. Не вставлять секреты. Отдельно указать безопасную остановку и команду намеренного удаления учебных данных.
## Цель
Перенести состояние мессенджера из оперативной памяти в PostgreSQL, реализовать аутентификацию и обеспечить сохранность подтверждённых сообщений и действующих сессий после полного перезапуска.
## Архитектура и решения
## Архитектура
Клиент → FastAPI → PostgreSQL. В Docker Compose сервисы `api` и `postgres`. Именованный volume `postgres_data` хранит файлы PostgreSQL.
TODO: схема процессов/хранилищ, источник истины, транзакционные границы, ограничения. Что перенесено из lab1, что изменено в этой работе. Соответствие переменных из .env.example реальной конфигурации.
### 3. Выполнение работы
## Доказательства критериев
#### 3.1. Перенос данных в PostgreSQL
| Критерий README | Команда/сценарий | Наблюдаемый результат | Файл доказательства |
| --- | --- | --- | --- |
| Публичный smoke | make test | TODO | TODO |
| Остальные пункты уровня 3 | TODO | TODO | TODO |
| Все пункты уровня 4, если заявлен | TODO | TODO | TODO |
| Выбранный трек 5, если заявлен | TODO | TODO | TODO |
В приложении реализовано постоянное хранение данных с использованием PostgreSQL.
TODO: добавить отдельную строку для каждого заявленного критерия. PASS без команды и наблюдения не является доказательством. Проверка инфраструктурного hook требует подтверждения, какие реальные процессы/хранилища перезапущены.
Созданы таблицы для хранения:
## Эксперименты и отказы
- Пользователей и хешей паролей.
- Чатов.
- Участников чатов.
- Сообщений.
- Пользовательских сессий.
TODO: гипотеза, hardware/лимиты, версии, объём данных, профиль нагрузки, concurrency/arrival rate, длительность/прогрев, повторы, успешные RPS, ошибки, p50/p95/p99, CPU/RAM. Сохранить raw summary без tokens и объяснить ограничения измерения.
Для таблиц определены первичные и внешние ключи, ограничения уникальности и необходимые индексы.
| Воздействие | Что ожидаем | Что наблюдали | Время восстановления / потеря данных |
| --- | --- | --- | --- |
| TODO | TODO | TODO | TODO |
#### 3.2. Реализация аутентификации
## Ограничения и следующие шаги
Реализована регистрация пользователей с безопасным хешированием паролей.
TODO: какие отказы выдерживаются и какие нет; что не реализовано; где учебное упрощение; какое улучшение подтверждено, а какое пока гипотеза.
Для создания сессии используется HTTP Basic Authentication.
После успешной авторизации пользователь получает Bearer-токен, который используется для доступа к защищённым endpoint.
Реализованы срок действия сессии и возможность выхода из системы (logout).
Сессии хранятся в PostgreSQL и сохраняются после перезапуска приложения.
#### 3.3. Реализация миграций
Для создания структуры базы данных используются версионируемые SQL-миграции.
Миграции выполняются при первоначальном запуске приложения.
Повторное выполнение миграций не приводит к дублированию таблиц и данных.
#### 3.4. Контейнеризация приложения
Для запуска приложения используется Docker Compose.
Созданы два основных сервиса:
- **api** — сервер FastAPI.
- **postgres** — база данных PostgreSQL.
Для PostgreSQL настроен именованный Docker volume, обеспечивающий сохранение данных после удаления и повторного создания контейнеров.
### 4. Тестирование
#### 4.1. Проверка запуска приложения
Для сборки и запуска контейнеров использовалась команда:
```bash
docker compose up -d --build --wait
```
**Результат:** контейнеры API и PostgreSQL успешно запущены и имеют статус `Healthy`.
#### 4.2. Проверка API
Для проверки основных функций приложения выполнена команда:
```bash
python tests/smoke.py
```
**Результат:**
```text
PASS: lab2 public API scenario; infrastructure and grading evidence remain separate.
```
Основной тест API успешно пройден.
#### 4.3. Проверка миграций
Для повторного применения миграций выполнена команда:
```bash
docker compose exec api python migrate.py
```
**Результат:**
```text
Migrations complete
```
Миграции успешно выполнены без ошибок.
#### 4.4. Проверка сохранения данных
Для проверки сохранения данных и пользовательских сессий после перезапуска выполнена команда:
```bash
python tests/resilience.py --mode persistence --action-script scripts/restart.cmd --base-url http://localhost:8080
```
**Результат:**
```text
PASS: persistence preserved confirmed data and existing session. Hook scope needs operator evidence.
```
Проверка подтвердила, что сообщения и действующие пользовательские сессии сохраняются после перезапуска API и PostgreSQL.
### 5. Результаты работы
В ходе выполнения лабораторной работы:
1. Реализовано постоянное хранение данных в PostgreSQL.
2. Добавлена регистрация с хешированием паролей.
3. Реализована аутентификация через Basic и Bearer.
4. Настроено хранение пользовательских сессий.
5. Добавлены версионируемые миграции базы данных.
6. Настроен запуск приложения через Docker Compose.
7. Обеспечено сохранение данных с использованием Docker volumes.
8. Успешно пройдены основные тесты API и сохранения данных.
### 6. Вывод
В результате выполнения лабораторной работы было разработано серверное приложение на FastAPI с использованием PostgreSQL для постоянного хранения данных.
Реализована аутентификация пользователей с использованием Basic и Bearer, а также сохранение действующих сессий.
Приложение запускается через Docker Compose и сохраняет данные после перезапуска контейнеров.
Проведённое тестирование подтвердило работоспособность API и сохранность данных.
**Цель лабораторной работы достигнута.**
+26
View File
@@ -0,0 +1,26 @@
services:
postgres:
image: postgres:16.8-alpine
environment:
POSTGRES_USER: ${POSTGRES_USER:-messenger}
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-messenger_local_only}
POSTGRES_DB: ${POSTGRES_DB:-messenger}
volumes:
- postgres_data:/var/lib/postgresql/data
healthcheck:
test: ["CMD-SHELL", "pg_isready -U $$POSTGRES_USER -d $$POSTGRES_DB"]
interval: 3s
timeout: 3s
retries: 20
api:
build: .
environment:
DATABASE_URL: postgresql://${POSTGRES_USER:-messenger}:${POSTGRES_PASSWORD:-messenger_local_only}@postgres:5432/${POSTGRES_DB:-messenger}
depends_on:
postgres:
condition: service_healthy
ports:
- "8080:8080"
restart: unless-stopped
volumes:
postgres_data:
+245
View File
@@ -0,0 +1,245 @@
import base64
import hashlib
import hmac
import json
import os
import re
import secrets
import uuid
from datetime import datetime, timezone, timedelta
from contextlib import contextmanager
import psycopg
from psycopg.rows import dict_row
from fastapi import FastAPI, Request
from fastapi.exceptions import RequestValidationError
from fastapi.responses import JSONResponse, Response
from pydantic import BaseModel, ConfigDict, Field, field_validator
DATABASE_URL = os.environ.get('DATABASE_URL', 'postgresql://messenger:messenger@localhost:5432/messenger')
app = FastAPI(title='Messenger PostgreSQL', version='1.2.0')
def utc(value):
return value.astimezone(timezone.utc).isoformat(timespec='milliseconds').replace('+00:00','Z')
def db():
return psycopg.connect(DATABASE_URL, row_factory=dict_row)
@contextmanager
def transaction():
with db() as conn:
with conn.transaction():
yield conn
def public_user(row):
return {k:(utc(row[k]) if k=='created_at' else str(row[k]) if k=='id' else row[k]) for k in ('id','username','display_name','created_at')}
def public_chat(conn, row):
members=conn.execute('SELECT user_id FROM chat_members WHERE chat_id=%s ORDER BY user_id',(row['id'],)).fetchall()
return {'id':str(row['id']),'title':row['title'],'member_ids':[str(x['user_id']) for x in members],'created_at':utc(row['created_at'])}
def public_message(row):
return {k:(utc(row[k]) if k=='created_at' else str(row[k]) if k in ('id','chat_id','sender_id') else row[k]) for k in ('id','chat_id','sender_id','text','created_at')}
def err(request,status,code='invalid_request',message='Некорректный запрос',challenge=None):
headers={'WWW-Authenticate':challenge} if challenge else {}
return JSONResponse(status_code=status,headers=headers,content={'error':{'code':code,'message':message,'request_id':request.state.request_id}})
@app.middleware('http')
async def middleware(request:Request, call_next):
request.state.request_id=str(uuid.uuid4())
try:
response=await call_next(request)
except Exception:
response=err(request,500,'internal_error','Внутренняя ошибка сервера')
response.headers['X-Request-Id']=request.state.request_id
return response
@app.exception_handler(RequestValidationError)
async def validation(request,exc):
return err(request,400)
class Strict(BaseModel):
model_config=ConfigDict(extra='forbid')
class CreateUser(Strict):
username:str=Field(min_length=3,max_length=32,pattern=r'^[a-z0-9_]{3,32}$')
display_name:str=Field(min_length=1,max_length=100)
password:str=Field(min_length=8,max_length=128)
@field_validator('display_name')
@classmethod
def nonblank(cls,v):
if not v.strip(): raise ValueError('blank')
return v
class CreateChat(Strict):
title:str=Field(min_length=1,max_length=100)
member_ids:list[uuid.UUID]=Field(min_length=1,max_length=100)
@field_validator('title')
@classmethod
def nonblank(cls,v):
if not v.strip(): raise ValueError('blank')
return v
class CreateMessage(Strict):
text:str=Field(min_length=1,max_length=4000)
@field_validator('text')
@classmethod
def nonblank(cls,v):
if not v.strip(): raise ValueError('blank')
return v
def password_hash(password):
salt=secrets.token_bytes(16)
result=hashlib.scrypt(password.encode(),salt=salt,n=16384,r=8,p=1)
return 'scrypt$'+salt.hex()+'$'+result.hex()
def verify(password,encoded):
try:
_,salt,digest=encoded.split('$')
candidate=hashlib.scrypt(password.encode(),salt=bytes.fromhex(salt),n=16384,r=8,p=1)
return hmac.compare_digest(candidate,bytes.fromhex(digest))
except (ValueError,TypeError): return False
def actor(request,conn):
header=request.headers.get('authorization','')
if not header.startswith('Bearer '): return None
token=header[7:]
if not token: return None
digest=hashlib.sha256(token.encode()).hexdigest()
return conn.execute('SELECT u.* FROM sessions s JOIN users u ON u.id=s.user_id WHERE s.token_hash=%s AND s.expires_at>now() AND s.revoked_at IS NULL',(digest,)).fetchone()
def require(request,conn):
user=actor(request,conn)
return user, None if user else err(request,401,'unauthorized','Требуется Bearer-сессия','Bearer')
def parse_uuid(value):
try: return uuid.UUID(value)
except (ValueError,TypeError): return None
def encode_cursor(resource,row):
payload=json.dumps({'resource':resource,'created_at':row['created_at'].astimezone(timezone.utc).isoformat(timespec='microseconds'),'id':str(row['id'])},separators=(',',':'))
return base64.urlsafe_b64encode(payload.encode()).decode().rstrip('=')
def decode_cursor(cursor,resource):
if cursor is None: return None
try:
d=json.loads(base64.urlsafe_b64decode(cursor+'='*(-len(cursor)%4)))
if set(d)!={'resource','created_at','id'} or d['resource']!=resource: return False
return (datetime.fromisoformat(d['created_at'].replace('Z','+00:00')),uuid.UUID(d['id']))
except Exception: return False
@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'}
@app.post('/api/v1/users',status_code=201)
def register(body:CreateUser,request:Request):
with transaction() as conn:
if conn.execute('SELECT 1 FROM users WHERE username=%s',(body.username,)).fetchone():
return err(request,409,'conflict','Имя пользователя занято')
row=conn.execute('INSERT INTO users(username,display_name,password_hash) VALUES (%s,%s,%s) RETURNING *',(body.username,body.display_name,password_hash(body.password))).fetchone()
return public_user(row)
@app.post('/api/v1/auth/sessions',status_code=201)
def login(request:Request):
auth=request.headers.get('authorization','')
try:
if not auth.startswith('Basic '): raise ValueError()
credentials=base64.b64decode(auth[6:],validate=True).decode('utf-8')
username,password=credentials.split(':',1)
except (ValueError,UnicodeError): return err(request,401,'unauthorized','Неверные учётные данные','Basic')
with transaction() as conn:
user=conn.execute('SELECT * FROM users WHERE username=%s',(username,)).fetchone()
if not user or not verify(password,user['password_hash']): return err(request,401,'unauthorized','Неверные учётные данные','Basic')
token=secrets.token_urlsafe(48)
expires=datetime.now(timezone.utc)+timedelta(hours=24)
conn.execute('INSERT INTO sessions(user_id,token_hash,expires_at) VALUES (%s,%s,%s)',(user['id'],hashlib.sha256(token.encode()).hexdigest(),expires))
return {'token':token,'token_type':'Bearer','expires_at':utc(expires),'user':public_user(user)}
@app.delete('/api/v1/auth/sessions/current',status_code=204)
def logout(request:Request):
with transaction() as conn:
user,e=require(request,conn)
if e:return e
digest=hashlib.sha256(request.headers['authorization'][7:].encode()).hexdigest()
conn.execute('UPDATE sessions SET revoked_at=now() WHERE token_hash=%s',(digest,))
return Response(status_code=204)
@app.get('/api/v1/users/me')
def me(request:Request):
with db() as conn:
user,e=require(request,conn)
return e or public_user(user)
@app.post('/api/v1/chats',status_code=201)
def create_chat(body:CreateChat,request:Request):
with transaction() as conn:
user,e=require(request,conn)
if e:return e
members=body.member_ids
if len(set(members))!=len(members) or user['id'] not in members:
return err(request,400)
found=conn.execute('SELECT count(*) AS n FROM users WHERE id=ANY(%s)',(members,)).fetchone()['n']
if found!=len(members):return err(request,400)
row=conn.execute('INSERT INTO chats(title) VALUES (%s) RETURNING *',(body.title,)).fetchone()
for member in members: conn.execute('INSERT INTO chat_members(chat_id,user_id) VALUES (%s,%s)',(row['id'],member))
return public_chat(conn,row)
def member_chat(conn,chat_id,user_id):
return conn.execute('SELECT c.* 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()
@app.get('/api/v1/chats')
def list_chats(request:Request,limit:int=50,cursor:str|None=None):
if not 1<=limit<=100:return err(request,400)
with db() as conn:
user,e=require(request,conn)
if e:return e
marker=decode_cursor(cursor,'chats:'+str(user['id']))
if marker is False:return err(request,400)
query='SELECT c.* FROM chats c JOIN chat_members cm ON cm.chat_id=c.id WHERE cm.user_id=%s'
params=[user['id']]
if marker:
query+=' AND (c.created_at,c.id)>(%s,%s)';params.extend(marker)
rows=conn.execute(query+' ORDER BY c.created_at,c.id LIMIT %s',(*params,limit+1)).fetchall()
page=rows[:limit]
return {'items':[public_chat(conn,r) for r in page],'next_cursor':encode_cursor('chats:'+str(user['id']),page[-1]) if len(rows)>limit else None}
@app.get('/api/v1/chats/{chat_id}')
def get_chat(chat_id:str,request:Request):
with db() as conn:
user,e=require(request,conn)
if e:return e
cid=parse_uuid(chat_id)
if cid is None:return err(request,400)
row=member_chat(conn,cid,user['id'])
return public_chat(conn,row) if row else err(request,404,'not_found','Чат не найден')
@app.post('/api/v1/chats/{chat_id}/messages',status_code=201)
def send(chat_id:str,body:CreateMessage,request:Request):
with transaction() as conn:
user,e=require(request,conn)
if e:return e
cid=parse_uuid(chat_id)
if cid is None:return err(request,400)
if not member_chat(conn,cid,user['id']):return err(request,404,'not_found','Чат не найден')
row=conn.execute('INSERT INTO messages(chat_id,sender_id,text) VALUES (%s,%s,%s) RETURNING *',(cid,user['id'],body.text)).fetchone()
return public_message(row)
@app.get('/api/v1/chats/{chat_id}/messages')
def list_messages(chat_id:str,request:Request,limit:int=50,cursor:str|None=None):
if not 1<=limit<=100:return err(request,400)
with db() as conn:
user,e=require(request,conn)
if e:return e
cid=parse_uuid(chat_id)
if cid is None:return err(request,400)
marker=decode_cursor(cursor,'messages:'+str(cid))
if marker is False:return err(request,400)
if not member_chat(conn,cid,user['id']):return err(request,404,'not_found','Чат не найден')
query='SELECT * FROM messages WHERE chat_id=%s';params=[cid]
if marker:
query+=' AND (created_at,id)>(%s,%s)';params.extend(marker)
rows=conn.execute(query+' ORDER BY created_at,id LIMIT %s',(*params,limit+1)).fetchall()
page=rows[:limit]
return {'items':[public_message(r) for r in page],'next_cursor':encode_cursor('messages:'+str(cid),page[-1]) if len(rows)>limit else None}
+14
View File
@@ -0,0 +1,14 @@
import os
from pathlib import Path
import psycopg
url=os.environ['DATABASE_URL']
with psycopg.connect(url) as conn:
with conn.transaction():
conn.execute('CREATE TABLE IF NOT EXISTS schema_migrations(version text PRIMARY KEY, applied_at timestamptz NOT NULL DEFAULT now())')
conn.execute('SELECT pg_advisory_xact_lock(18202602)')
for path in sorted(Path(__file__).parent.joinpath('migrations').glob('*.sql')):
if not conn.execute('SELECT 1 FROM schema_migrations WHERE version=%s',(path.name,)).fetchone():
conn.execute(path.read_text())
conn.execute('INSERT INTO schema_migrations(version) VALUES (%s)',(path.name,))
print('Applied',path.name)
print('Migrations complete')
+37
View File
@@ -0,0 +1,37 @@
CREATE TABLE IF NOT EXISTS users (
id uuid PRIMARY KEY DEFAULT gen_random_uuid(),
username varchar(32) NOT NULL UNIQUE CHECK (username ~ '^[a-z0-9_]{3,32}$'),
display_name varchar(100) NOT NULL CHECK (length(trim(display_name)) > 0),
password_hash text NOT NULL,
created_at timestamptz NOT NULL DEFAULT now()
);
CREATE TABLE IF NOT EXISTS chats (
id uuid PRIMARY KEY DEFAULT gen_random_uuid(),
title varchar(100) NOT NULL CHECK (length(trim(title)) > 0),
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) ON DELETE CASCADE,
PRIMARY KEY (chat_id,user_id)
);
CREATE INDEX IF NOT EXISTS idx_chat_members_user ON chat_members(user_id,chat_id);
CREATE TABLE IF NOT EXISTS messages (
id uuid PRIMARY KEY DEFAULT gen_random_uuid(),
chat_id uuid NOT NULL REFERENCES chats(id) ON DELETE CASCADE,
sender_id uuid NOT NULL REFERENCES users(id),
text varchar(4000) NOT NULL CHECK (length(trim(text)) > 0),
created_at timestamptz NOT NULL DEFAULT now(),
FOREIGN KEY (chat_id,sender_id) REFERENCES chat_members(chat_id,user_id)
);
CREATE INDEX IF NOT EXISTS idx_messages_page ON messages(chat_id,created_at,id);
CREATE INDEX IF NOT EXISTS idx_chats_page ON chats(created_at,id);
CREATE TABLE IF NOT EXISTS sessions (
id uuid PRIMARY KEY DEFAULT gen_random_uuid(),
user_id uuid NOT NULL REFERENCES users(id) ON DELETE CASCADE,
token_hash char(64) NOT NULL UNIQUE,
expires_at timestamptz NOT NULL,
revoked_at timestamptz,
created_at timestamptz NOT NULL DEFAULT now()
);
CREATE INDEX IF NOT EXISTS idx_sessions_user ON sessions(user_id);
+4
View File
@@ -0,0 +1,4 @@
fastapi==0.115.12
uvicorn==0.34.2
pydantic==2.11.4
psycopg[binary]==3.2.6
+10
View File
@@ -0,0 +1,10 @@
@echo off
cd /d "%~dp0.."
docker compose stop api postgres
if errorlevel 1 exit /b 1
docker compose up -d --wait postgres api
if errorlevel 1 exit /b 1
exit /b 0
+5
View File
@@ -0,0 +1,5 @@
#!/bin/sh
set -eu
cd "$(dirname "$0")/.."
docker compose stop api postgres
docker compose up -d --wait postgres api