From 498ce1e0d20c7ffc45ef71b81f5ce3cfa56208ec Mon Sep 17 00:00:00 2001 From: gytall Date: Sat, 14 Nov 2026 03:51:10 +0300 Subject: [PATCH 1/4] created skeleton for lab 6 --- .dockerignore | 3 + .env.example | 106 +++- .gitignore | 6 + Dockerfile | 29 ++ Makefile | 119 ++++- REPORT.md | 9 + RUNNING.md | 90 ++++ alembic.ini | 38 ++ app/__init__.py | 0 app/__main__.py | 4 + app/core/__init__.py | 0 app/core/background.py | 40 ++ app/core/cleanup.py | 66 +++ app/core/config.py | 129 +++++ app/core/database.py | 28 + app/core/image_processing.py | 16 + app/core/image_worker.py | 24 + app/core/instance.py | 40 ++ app/core/job_admin.py | 82 +++ app/core/job_worker.py | 170 ++++++ app/core/jobs.py | 37 ++ app/core/lifecycle.py | 50 ++ app/core/outbox_publisher.py | 88 ++++ app/core/redis.py | 24 + app/core/request_capacity.py | 42 ++ app/core/request_id.py | 22 + app/core/s3.py | 47 ++ app/core/security.py | 63 +++ app/core/thumbnail_worker.py | 32 ++ app/domain/__init__.py | 1 + app/domain/attachment_jobs.py | 265 ++++++++++ app/domain/attachments.py | 340 ++++++++++++ app/domain/auth.py | 84 +++ app/domain/chats.py | 104 ++++ app/domain/health.py | 36 ++ app/domain/idempotency.py | 78 +++ app/domain/image_pipeline.py | 105 ++++ app/domain/image_validation.py | 23 + app/domain/images.py | 48 ++ app/domain/job_admin.py | 161 ++++++ app/domain/job_files.py | 72 +++ app/domain/job_retry.py | 51 ++ app/domain/messages.py | 48 ++ app/domain/pagination.py | 83 +++ app/domain/users.py | 41 ++ app/endpoints/__init__.py | 0 app/endpoints/attachments.py | 74 +++ app/endpoints/auth.py | 32 ++ app/endpoints/chats.py | 32 ++ app/endpoints/dependencies.py | 112 ++++ app/endpoints/health.py | 23 + app/endpoints/messages.py | 42 ++ app/endpoints/users.py | 17 + app/errors/__init__.py | 0 app/errors/exceptions.py | 145 ++++++ app/errors/handlers.py | 238 +++++++++ app/main.py | 94 ++++ app/models/__init__.py | 25 + app/models/attachment.py | 71 +++ app/models/base.py | 27 + app/models/chat.py | 32 ++ app/models/chat_member.py | 26 + app/models/counter.py | 13 + app/models/idempotency_key.py | 24 + app/models/job.py | 40 ++ app/models/job_replay.py | 22 + app/models/message.py | 30 ++ app/models/user.py | 31 ++ app/schemas/__init__.py | 6 + app/schemas/attachment.py | 53 ++ app/schemas/base.py | 35 ++ app/schemas/chat.py | 22 + app/schemas/job.py | 22 + app/schemas/message.py | 41 ++ app/schemas/session.py | 17 + app/schemas/user.py | 25 + app/storage/__init__.py | 1 + app/storage/attachments.py | 99 ++++ app/storage/broker.py | 94 ++++ app/storage/chats.py | 71 +++ app/storage/health.py | 15 + app/storage/idempotency.py | 70 +++ app/storage/job_admin.py | 59 +++ app/storage/jobs.py | 160 ++++++ app/storage/messages.py | 62 +++ app/storage/outbox.py | 33 ++ app/storage/s3.py | 180 +++++++ app/storage/sessions.py | 38 ++ app/storage/types.py | 6 + app/storage/users.py | 47 ++ compose.test.yaml | 10 + compose.yaml | 416 +++++++++++++++ infra/broker/start-broker.sh | 8 + infra/minio/Dockerfile | 22 + infra/minio/bootstrap.py | 120 +++++ infra/nginx/nginx.conf | 140 +++++ infra/redis/redis.conf | 5 + infra/redis/start-redis.sh | 10 + migrations/env.py | 68 +++ migrations/script.py.mako | 25 + migrations/versions/.gitkeep | 0 .../49d2c947a3f1_add_idempotency_keys.py | 48 ++ .../versions/8f31b94a2d10_add_attachments.py | 98 ++++ .../versions/a62c950e18b3_rabbitmq_cutover.py | 21 + .../versions/abd273076068_add_counters.py | 34 ++ .../c35e91a2f706_async_attachment_jobs.py | 113 ++++ .../db06fd3126ff_create_initial_schema.py | 107 ++++ .../e7048b6da913_attachment_crop_webp.py | 55 ++ .../versions/f9183d27a640_job_replay.py | 51 ++ pytest.ini | 6 + requirements.txt | 53 ++ scripts/__init__.py | 1 + scripts/check_jobs.py | 429 ++++++++++++++++ scripts/check_nginx.py | 261 ++++++++++ scripts/check_outbox_recovery.py | 147 ++++++ scripts/check_s3.py | 152 ++++++ scripts/deployment.py | 73 +++ scripts/init_local.py | 38 ++ scripts/restart.sh | 37 ++ scripts/stop-one.sh | 30 ++ student-tests/conftest.py | 202 ++++++++ student-tests/helpers.py | 88 ++++ student-tests/test_attachments.py | 483 ++++++++++++++++++ student-tests/test_auth.py | 298 +++++++++++ student-tests/test_chats.py | 209 ++++++++ student-tests/test_concurrency.py | 273 ++++++++++ student-tests/test_constraints.py | 46 ++ student-tests/test_errors.py | 76 +++ student-tests/test_failures.py | 138 +++++ student-tests/test_health.py | 62 +++ student-tests/test_history_plan.py | 76 +++ student-tests/test_idempotency.py | 190 +++++++ student-tests/test_image_pipeline.py | 113 ++++ student-tests/test_instance.py | 110 ++++ student-tests/test_jobs.py | 267 ++++++++++ student-tests/test_lifecycle.py | 50 ++ student-tests/test_limits.py | 122 +++++ student-tests/test_messages.py | 238 +++++++++ student-tests/test_migrations.py | 79 +++ student-tests/test_pagination.py | 137 +++++ student-tests/test_s3_stream.py | 63 +++ student-tests/test_sessions.py | 173 +++++++ student-tests/test_users.py | 128 +++++ tests/__init__.py | 0 144 files changed, 11428 insertions(+), 21 deletions(-) create mode 100644 Dockerfile create mode 100644 RUNNING.md create mode 100644 alembic.ini create mode 100644 app/__init__.py create mode 100644 app/__main__.py create mode 100644 app/core/__init__.py create mode 100644 app/core/background.py create mode 100644 app/core/cleanup.py create mode 100644 app/core/config.py create mode 100644 app/core/database.py create mode 100644 app/core/image_processing.py create mode 100644 app/core/image_worker.py create mode 100644 app/core/instance.py create mode 100644 app/core/job_admin.py create mode 100644 app/core/job_worker.py create mode 100644 app/core/jobs.py create mode 100644 app/core/lifecycle.py create mode 100644 app/core/outbox_publisher.py create mode 100644 app/core/redis.py create mode 100644 app/core/request_capacity.py create mode 100644 app/core/request_id.py create mode 100644 app/core/s3.py create mode 100644 app/core/security.py create mode 100644 app/core/thumbnail_worker.py create mode 100644 app/domain/__init__.py create mode 100644 app/domain/attachment_jobs.py create mode 100644 app/domain/attachments.py create mode 100644 app/domain/auth.py create mode 100644 app/domain/chats.py create mode 100644 app/domain/health.py create mode 100644 app/domain/idempotency.py create mode 100644 app/domain/image_pipeline.py create mode 100644 app/domain/image_validation.py create mode 100644 app/domain/images.py create mode 100644 app/domain/job_admin.py create mode 100644 app/domain/job_files.py create mode 100644 app/domain/job_retry.py create mode 100644 app/domain/messages.py create mode 100644 app/domain/pagination.py create mode 100644 app/domain/users.py create mode 100644 app/endpoints/__init__.py create mode 100644 app/endpoints/attachments.py create mode 100644 app/endpoints/auth.py create mode 100644 app/endpoints/chats.py create mode 100644 app/endpoints/dependencies.py create mode 100644 app/endpoints/health.py create mode 100644 app/endpoints/messages.py create mode 100644 app/endpoints/users.py create mode 100644 app/errors/__init__.py create mode 100644 app/errors/exceptions.py create mode 100644 app/errors/handlers.py create mode 100644 app/main.py create mode 100644 app/models/__init__.py create mode 100644 app/models/attachment.py create mode 100644 app/models/base.py create mode 100644 app/models/chat.py create mode 100644 app/models/chat_member.py create mode 100644 app/models/counter.py create mode 100644 app/models/idempotency_key.py create mode 100644 app/models/job.py create mode 100644 app/models/job_replay.py create mode 100644 app/models/message.py create mode 100644 app/models/user.py create mode 100644 app/schemas/__init__.py create mode 100644 app/schemas/attachment.py create mode 100644 app/schemas/base.py create mode 100644 app/schemas/chat.py create mode 100644 app/schemas/job.py create mode 100644 app/schemas/message.py create mode 100644 app/schemas/session.py create mode 100644 app/schemas/user.py create mode 100644 app/storage/__init__.py create mode 100644 app/storage/attachments.py create mode 100644 app/storage/broker.py create mode 100644 app/storage/chats.py create mode 100644 app/storage/health.py create mode 100644 app/storage/idempotency.py create mode 100644 app/storage/job_admin.py create mode 100644 app/storage/jobs.py create mode 100644 app/storage/messages.py create mode 100644 app/storage/outbox.py create mode 100644 app/storage/s3.py create mode 100644 app/storage/sessions.py create mode 100644 app/storage/types.py create mode 100644 app/storage/users.py create mode 100644 compose.test.yaml create mode 100644 compose.yaml create mode 100755 infra/broker/start-broker.sh create mode 100644 infra/minio/Dockerfile create mode 100644 infra/minio/bootstrap.py create mode 100644 infra/nginx/nginx.conf create mode 100644 infra/redis/redis.conf create mode 100644 infra/redis/start-redis.sh create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako create mode 100644 migrations/versions/.gitkeep create mode 100644 migrations/versions/49d2c947a3f1_add_idempotency_keys.py create mode 100644 migrations/versions/8f31b94a2d10_add_attachments.py create mode 100644 migrations/versions/a62c950e18b3_rabbitmq_cutover.py create mode 100644 migrations/versions/abd273076068_add_counters.py create mode 100644 migrations/versions/c35e91a2f706_async_attachment_jobs.py create mode 100644 migrations/versions/db06fd3126ff_create_initial_schema.py create mode 100644 migrations/versions/e7048b6da913_attachment_crop_webp.py create mode 100644 migrations/versions/f9183d27a640_job_replay.py create mode 100644 pytest.ini create mode 100644 requirements.txt create mode 100644 scripts/__init__.py create mode 100644 scripts/check_jobs.py create mode 100644 scripts/check_nginx.py create mode 100644 scripts/check_outbox_recovery.py create mode 100644 scripts/check_s3.py create mode 100644 scripts/deployment.py create mode 100644 scripts/init_local.py create mode 100755 scripts/restart.sh create mode 100755 scripts/stop-one.sh create mode 100644 student-tests/conftest.py create mode 100644 student-tests/helpers.py create mode 100644 student-tests/test_attachments.py create mode 100644 student-tests/test_auth.py create mode 100644 student-tests/test_chats.py create mode 100644 student-tests/test_concurrency.py create mode 100644 student-tests/test_constraints.py create mode 100644 student-tests/test_errors.py create mode 100644 student-tests/test_failures.py create mode 100644 student-tests/test_health.py create mode 100644 student-tests/test_history_plan.py create mode 100644 student-tests/test_idempotency.py create mode 100644 student-tests/test_image_pipeline.py create mode 100644 student-tests/test_instance.py create mode 100644 student-tests/test_jobs.py create mode 100644 student-tests/test_lifecycle.py create mode 100644 student-tests/test_limits.py create mode 100644 student-tests/test_messages.py create mode 100644 student-tests/test_migrations.py create mode 100644 student-tests/test_pagination.py create mode 100644 student-tests/test_s3_stream.py create mode 100644 student-tests/test_sessions.py create mode 100644 student-tests/test_users.py create mode 100644 tests/__init__.py diff --git a/.dockerignore b/.dockerignore index bc16e55..13de046 100644 --- a/.dockerignore +++ b/.dockerignore @@ -18,3 +18,6 @@ __pycache__ node_modules evidence .DS_Store + +# Перенесённые исключения lab5 +docs diff --git a/.env.example b/.env.example index 2b32655..21e018a 100644 --- a/.env.example +++ b/.env.example @@ -1,30 +1,110 @@ -# Copy to .env for your LOCAL synthetic test environment; never commit .env. -# These are logical interface suggestions; map actual framework names in REPORT.md. +# Скопируйте в .env для локального окружения; .env не коммитится. +# Настройки приложения, Compose и очереди. APP_HOST=0.0.0.0 APP_PORT=8080 -APP_ENV=lab +APP_ENV=development +LOG_LEVEL=INFO + +MAX_MESSAGES=100000 +# Лимит одновременных запросов НА ОДНУ реплику +MAX_IN_FLIGHT=16 + SESSION_TTL_SECONDS=3600 -# Choose credentials locally. File paths contain no secret values. -DATABASE_URL_FILE=/run/secrets/database_url -# Optional on 3, required use on 4 in lab2; Redis OR Valkey: -SESSION_STORE=postgres -CACHE_URL_FILE=/run/secrets/cache_url +SESSION_STORE=redis + +REDIS_HOST=redis +REDIS_PORT=6379 +REDIS_DB=0 +REDIS_MAX_CONNECTIONS=20 +REDIS_POOL_TIMEOUT_SECONDS=1 +REDIS_CONNECT_TIMEOUT_SECONDS=1 +REDIS_SOCKET_TIMEOUT_SECONDS=0.5 + +DB_HOST=postgres +DB_PORT=5432 +DB_NAME=messenger +DB_USER=messenger + +# Пул на одну реплику: суммарно API_REPLICAS * (POOL_SIZE + MAX_OVERFLOW) +# соединений должно помещаться в max_connections PostgreSQL. +DB_POOL_SIZE=5 +DB_MAX_OVERFLOW=10 +DB_POOL_TIMEOUT_SECONDS=3 +DB_CONNECT_TIMEOUT_SECONDS=3 +DB_STATEMENT_TIMEOUT_MS=5000 + +# --- Балансировка и идемпотентность --- API_REPLICAS=2 +API_IMAGE=messenger:local +API_BUILD_REVISION=development IDEMPOTENCY_TTL_SECONDS=86400 -S3_ENDPOINT=http://s3:9000 +SHUTDOWN_DRAIN_SECONDS=1 +GRACEFUL_SHUTDOWN_TIMEOUT_SECONDS=5 +READINESS_TIMEOUT_SECONDS=2 + +# Порт единственной публичной точки входа (nginx) +LB_HOST_PORT=18081 +# Используются только тестовым стендом (compose.test.yaml) +DB_HOST_PORT=25432 +REDIS_HOST_PORT=26379 + +# --- MinIO, ограниченный upload и очистка журнала --- +S3_ENDPOINT=http://minio:9000 S3_REGION=us-east-1 S3_BUCKET=messenger-attachments S3_ACCESS_KEY_ID_FILE=/run/secrets/s3_access_key_id S3_SECRET_ACCESS_KEY_FILE=/run/secrets/s3_secret_access_key -MAX_UPLOAD_BYTES=10485760 -MAX_IMAGE_PIXELS=40000000 -BROKER_URL_FILE=/run/secrets/broker_url +S3_CONNECT_TIMEOUT_SECONDS=2 +S3_READ_TIMEOUT_SECONDS=10 +S3_UPLOAD_TIMEOUT_SECONDS=30 +S3_DOWNLOAD_TIMEOUT_SECONDS=60 +S3_IMAGE_TIMEOUT_SECONDS=10 +S3_MAX_UPLOAD_BYTES=10485760 +S3_MAX_IMAGE_PIXELS=40000000 +S3_CHUNK_BYTES=65536 +S3_MAX_CONCURRENT_UPLOADS=2 +S3_CLEANUP_GRACE_SECONDS=86400 +S3_CLEANUP_INTERVAL_SECONDS=300 + +# Пути секретов внутри контейнеров; должны совпадать с secrets mounts. +POSTGRES_PASSWORD_FILE=/run/secrets/db_password +MINIO_ROOT_USER_FILE=/run/secrets/minio_root_user +MINIO_ROOT_PASSWORD_FILE=/run/secrets/minio_root_password +MINIO_BROWSER=off + +# Отдельный RabbitMQ broker и ограниченный worker. WORKER_CONCURRENCY=2 JOB_MAX_ATTEMPTS=5 JOB_TIMEOUT_SECONDS=60 STAGING_RETENTION_SECONDS=86400 +BROKER_HOST=broker +BROKER_PORT=5672 +BROKER_PASSWORD_FILE=/run/secrets/broker_password +BROKER_QUEUE=attachment-jobs +BROKER_USER=messenger +BROKER_VHOST=/ +JOB_LEASE_SECONDS=90 +JOB_RETRY_SECONDS=5 +PUBLISHER_POLL_SECONDS=1 + +# Качество вариантов и лимиты одного процесса обработки +IMAGE_JPEG_QUALITY=85 +IMAGE_WEBP_QUALITY=80 +IMAGE_WEBP_METHOD=4 +IMAGE_MEMORY_MIB=768 +IMAGE_CPU_SECONDS=20 + +# Retry cap and retained failed sources for explicit replay +JOB_RETRY_MAX_SECONDS=120 +FAILED_STAGING_RETENTION_SECONDS=604800 + +# Дополнительные предложения skeleton lab6; пока не подключены к перенесённому стенду. +DATABASE_URL_FILE=/run/secrets/database_url +CACHE_URL_FILE=/run/secrets/cache_url +MAX_UPLOAD_BYTES=10485760 +MAX_IMAGE_PIXELS=40000000 +BROKER_URL_FILE=/run/secrets/broker_url OTEL_SERVICE_NAME=messenger-api -# Worker must set a distinct service.name. OTEL_EXPORTER_OTLP_ENDPOINT=http://otel-collector:4318 OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf OTEL_RESOURCE_ATTRIBUTES=deployment.environment.name=lab diff --git a/.gitignore b/.gitignore index b5a7189..966823e 100644 --- a/.gitignore +++ b/.gitignore @@ -30,3 +30,9 @@ coverage/ .vscode/ # Keep small, sanitized evidence summaries in evidence/ under version control. # Inspect git diff --cached: ignore rules are not a secret scanner. + +# Перенесённые исключения lab5 +venv/ +.pytest_cache/ +.ruff_cache/ +/docs/ diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..24102d5 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,29 @@ +FROM python:3.12.15-slim-bookworm + +ENV PYTHONDONTWRITEBYTECODE=1 \ + PYTHONUNBUFFERED=1 \ + PIP_NO_CACHE_DIR=1 \ + PIP_DISABLE_PIP_VERSION_CHECK=1 + +WORKDIR /app + +RUN useradd --system --uid 10001 --no-create-home appuser + +COPY requirements.txt . +RUN pip install -r requirements.txt + +COPY alembic.ini ./ +COPY migrations ./migrations +COPY app ./app + +ARG API_BUILD_REVISION +LABEL org.opencontainers.image.revision=$API_BUILD_REVISION + +USER appuser + +EXPOSE 8080 + +HEALTHCHECK --interval=3s --timeout=3s --start-period=10s --retries=2 \ + CMD ["python", "-c", "import os, urllib.request; urllib.request.urlopen('http://127.0.0.1:' + os.environ['APP_PORT'] + '/health/ready', timeout=2.5)"] + +CMD ["python", "-m", "app"] diff --git a/Makefile b/Makefile index 5d86d17..38fc435 100644 --- a/Makefile +++ b/Makefile @@ -1,13 +1,80 @@ -PYTHON ?= python3 -BASE_URL ?= http://localhost:8080 +-include .env + +PYTHON ?= $(if $(wildcard .venv/bin/python),.venv/bin/python,$(if $(wildcard venv/bin/python),venv/bin/python,python3)) +PYTEST_ARGS ?= +BASE_URL ?= http://localhost:$(or $(LB_HOST_PORT),8080) CA_FILE ?= +SERVICE ?= ACTION_SCRIPT ?= TLS_ARGS = $(if $(CA_FILE),--ca-file "$(CA_FILE)",) +COMPOSE = docker compose --env-file .env -.PHONY: help check validate test load test-persistence test-failover +TEST_PROJECT ?= messenger-test +TEST_LB_PORT ?= 28080 +TEST_DB_PORT ?= $(DB_HOST_PORT) +TEST_REDIS_PORT ?= $(REDIS_HOST_PORT) +TEST_BASE_URL = http://localhost:$(TEST_LB_PORT) +TEST_ENV = COMPOSE_PROJECT_NAME=$(TEST_PROJECT) COMPOSE_FILE=compose.yaml:compose.test.yaml \ + LB_HOST_PORT=$(TEST_LB_PORT) DB_HOST_PORT=$(TEST_DB_PORT) REDIS_HOST_PORT=$(TEST_REDIS_PORT) +TEST_COMPOSE = $(TEST_ENV) $(COMPOSE) + +TEST_DB_PASSWORD = $(if $(wildcard secrets/db_password),$(file asyncio.Event: + stop = asyncio.Event() + loop = asyncio.get_running_loop() + for signum in (signal.SIGTERM, signal.SIGINT): + loop.add_signal_handler(signum, stop.set) + return stop + + +async def wait_or_stop(stop: asyncio.Event, seconds: float) -> None: + try: + async with asyncio.timeout(seconds): + await stop.wait() + except TimeoutError: + pass + + +def log_background_error(operation: str, error: Exception) -> None: + # SDK/DB exceptions могут содержать параметры и credentials; выводим только тип. + logger.warning("%s: %s", operation, type(error).__name__) diff --git a/app/core/cleanup.py b/app/core/cleanup.py new file mode 100644 index 0000000..722e1a0 --- /dev/null +++ b/app/core/cleanup.py @@ -0,0 +1,66 @@ +"""Периодическая компенсация незавершённых загрузок; отдельный Compose-сервис.""" + +import argparse +import asyncio +from dataclasses import asdict +import json + +from app.core.config import Settings +from app.core.jobs import JobSettings +from app.core.database import create_db_engine, create_session_factory +from app.core.s3 import S3Settings +from app.domain.attachments import reconcile_attachments +from app.domain.attachment_jobs import cleanup_staging +from app.errors.handlers import RECOVERABLE_STORAGE_ERRORS, log_recoverable_error +from app.storage.s3 import create_s3_storage + + +async def cleanup_once(factory, storage, apply: bool, jobs: JobSettings) -> bool: + completed = True + try: + async with factory() as session: + result = await reconcile_attachments(session, storage, dry_run=not apply) + staging = await cleanup_staging(session, storage, jobs, apply=apply) + print( + json.dumps({**asdict(result), "terminal_staging": staging}), flush=True + ) + except RECOVERABLE_STORAGE_ERRORS as error: + log_recoverable_error("Reconciliation", error) + completed = False + return completed + + +async def run(once: bool, apply: bool) -> None: + settings = Settings() # type: ignore + s3_settings = S3Settings() + jobs = JobSettings() + engine = create_db_engine(settings) + factory = create_session_factory(engine) + storage = create_s3_storage(s3_settings) + try: + while True: + completed = await cleanup_once(factory, storage, apply, jobs) + if once: + if not completed: + raise SystemExit(1) + break + await asyncio.sleep(s3_settings.cleanup_interval_seconds) + finally: + await storage.aclose() + await engine.dispose() + + +def main() -> None: + parser = argparse.ArgumentParser(description="Сверка журнала загрузок MinIO/БД") + parser.add_argument("--once", action="store_true") + parser.add_argument( + "--apply", + action="store_true", + help="удалять безопасные кандидаты; по умолчанию dry-run", + ) + args = parser.parse_args() + asyncio.run(run(args.once, args.apply)) + + +if __name__ == "__main__": + main() diff --git a/app/core/config.py b/app/core/config.py new file mode 100644 index 0000000..6b74370 --- /dev/null +++ b/app/core/config.py @@ -0,0 +1,129 @@ +from enum import StrEnum +from pathlib import Path +from typing import Literal, Self + +from pydantic import Field, SecretStr, model_validator +from pydantic_settings import ( + BaseSettings, + PydanticBaseSettingsSource, + SettingsConfigDict, +) +from sqlalchemy import URL +from app.core.s3 import S3Settings + +ASYNC_DRIVER = "postgresql+asyncpg" +SECRETS_DIR = next( + ( + path + for path in ( + Path("/run/secrets"), + Path(__file__).resolve().parents[2] / "secrets", + ) + if (path / "db_password").is_file() + ), + None, +) + + +class LogLevel(StrEnum): + DEBUG = "DEBUG" + INFO = "INFO" + WARNING = "WARNING" + ERROR = "ERROR" + CRITICAL = "CRITICAL" + + +class Settings(BaseSettings): + s3_enabled: bool = True + s3: S3Settings = Field(default_factory=S3Settings) + app_host: str + app_port: int = Field(ge=1, le=65535) + app_env: str + log_level: LogLevel = LogLevel.INFO + + max_messages: int = Field(ge=1) + max_in_flight: int = Field(ge=1) + + session_ttl_seconds: int = Field(default=3600, ge=1) + session_store: Literal["redis"] = "redis" + + redis_host: str = "localhost" + redis_port: int = Field(default=6379, ge=1, le=65535) + redis_db: int = Field(default=0, ge=0) + redis_password: SecretStr | None = None + + redis_max_connections: int = Field(default=20, ge=1) + redis_pool_timeout_seconds: float = Field(default=1.0, gt=0) + redis_connect_timeout_seconds: float = Field(default=1.0, gt=0) + redis_socket_timeout_seconds: float = Field(default=0.5, gt=0) + + database_url: SecretStr | None = None + db_host: str | None = None + db_port: int = Field(default=5432, ge=1, le=65535) + db_name: str | None = None + db_user: str | None = None + db_password: SecretStr | None = None + + db_pool_size: int = Field(default=5, ge=1) + db_max_overflow: int = Field(default=5, ge=0) + db_pool_timeout_seconds: float = Field(default=3.0, gt=0) + db_connect_timeout_seconds: int = Field(default=3, ge=1) + db_statement_timeout_ms: int = Field(default=5000, ge=1) + + instance_id: str | None = None + idempotency_ttl_seconds: int = Field(default=86400, ge=1) + shutdown_drain_seconds: float = Field(default=1, ge=0) + graceful_shutdown_timeout_seconds: int = Field(default=5, ge=1) + readiness_timeout_seconds: float = Field(default=2, gt=0, lt=2.5) + + model_config = SettingsConfigDict( + env_file=".env", + env_file_encoding="utf-8", + case_sensitive=False, + extra="ignore", + secrets_dir=SECRETS_DIR, + ) + + @classmethod + def settings_customise_sources( + cls, + settings_cls: type[BaseSettings], + init_settings: PydanticBaseSettingsSource, + env_settings: PydanticBaseSettingsSource, + dotenv_settings: PydanticBaseSettingsSource, + file_secret_settings: PydanticBaseSettingsSource, + ) -> tuple[PydanticBaseSettingsSource, ...]: + """Явные параметры и файлы имеют приоритет над окружением.""" + return init_settings, file_secret_settings, env_settings, dotenv_settings + + @model_validator(mode="after") + def _require_database_source(self) -> Self: + if self.shutdown_drain_seconds + self.graceful_shutdown_timeout_seconds >= 8: + raise ValueError( + "Drain и graceful shutdown должны суммарно занимать менее 8 секунд" + ) + if self.database_url is not None: + if not self.database_url.get_secret_value().startswith(ASYNC_DRIVER): + raise ValueError(f"DATABASE_URL должен начинаться с {ASYNC_DRIVER}://") + return self + + if not (self.db_host and self.db_name and self.db_user and self.db_password): + raise ValueError( + "Нужны DATABASE_URL либо DB_HOST, DB_NAME, DB_USER и секрет db_password" + ) + return self + + def get_database_url(self) -> str: + if self.database_url is not None: + return self.database_url.get_secret_value() + + assert self.db_password is not None + url = URL.create( + ASYNC_DRIVER, + username=self.db_user, + password=self.db_password.get_secret_value(), + host=self.db_host, + port=self.db_port, + database=self.db_name, + ) + return url.render_as_string(hide_password=False) diff --git a/app/core/database.py b/app/core/database.py new file mode 100644 index 0000000..c7a6538 --- /dev/null +++ b/app/core/database.py @@ -0,0 +1,28 @@ +from sqlalchemy.ext.asyncio import ( + AsyncEngine, + AsyncSession, + async_sessionmaker, + create_async_engine, +) + +from app.core.config import Settings + + +def create_db_engine(settings: Settings) -> AsyncEngine: + return create_async_engine( + settings.get_database_url(), + pool_size=settings.db_pool_size, + max_overflow=settings.db_max_overflow, + pool_timeout=settings.db_pool_timeout_seconds, + pool_pre_ping=True, + connect_args={ + "timeout": settings.db_connect_timeout_seconds, + "server_settings": { + "statement_timeout": str(settings.db_statement_timeout_ms) + }, + }, + ) + + +def create_session_factory(engine: AsyncEngine) -> async_sessionmaker[AsyncSession]: + return async_sessionmaker(bind=engine, expire_on_commit=False, autoflush=False) diff --git a/app/core/image_processing.py b/app/core/image_processing.py new file mode 100644 index 0000000..107dc42 --- /dev/null +++ b/app/core/image_processing.py @@ -0,0 +1,16 @@ +"""Качество вариантов и пределы отдельного процесса обработки.""" + +from pydantic import Field +from pydantic_settings import BaseSettings, SettingsConfigDict + + +class ImageSettings(BaseSettings): + model_config = SettingsConfigDict( + env_prefix="IMAGE_", env_file=".env", extra="ignore" + ) + + jpeg_quality: int = Field(default=85, ge=1, le=95) + webp_quality: int = Field(default=80, ge=1, le=100) + webp_method: int = Field(default=4, ge=0, le=6) + memory_mib: int = Field(default=768, ge=256, le=1024) + cpu_seconds: int = Field(default=20, ge=1, le=120) diff --git a/app/core/image_worker.py b/app/core/image_worker.py new file mode 100644 index 0000000..a74795c --- /dev/null +++ b/app/core/image_worker.py @@ -0,0 +1,24 @@ +"""Одноразовый Linux-процесс декодирования с пределами памяти и CPU""" + +from pathlib import Path +import resource +import sys + +from app.domain.image_validation import decode_image +from app.errors.exceptions import IMAGE_WORKER_ERRORS, image_worker_error_code + + +def main() -> int: + resource.setrlimit(resource.RLIMIT_AS, (512 * 1024 * 1024, 512 * 1024 * 1024)) + resource.setrlimit(resource.RLIMIT_CPU, (10, 10)) + path, content_type, maximum = sys.argv[1:] + status = 0 + try: + decode_image(Path(path), content_type, int(maximum)) + except IMAGE_WORKER_ERRORS as error: + status = image_worker_error_code(error) + return status + + +if __name__ == "__main__": + raise SystemExit(main()) diff --git a/app/core/instance.py b/app/core/instance.py new file mode 100644 index 0000000..75bf844 --- /dev/null +++ b/app/core/instance.py @@ -0,0 +1,40 @@ +"""Идентификатор API-реплики и заголовок X-Instance-Id.""" + +import os +from uuid import uuid4 + +from starlette.middleware.base import BaseHTTPMiddleware, RequestResponseEndpoint +from starlette.requests import Request +from starlette.responses import Response + +INSTANCE_ID_HEADER = "X-Instance-Id" + + +def resolve_instance_id(configured: str | None) -> str: + """Выбирает INSTANCE_ID, HOSTNAME или UUID при старте приложения.""" + if configured and configured.strip(): + return configured.strip() + + hostname = os.getenv("HOSTNAME", "").strip() + if hostname: + return hostname + + return str(uuid4()) + + +class InstanceIdMiddleware(BaseHTTPMiddleware): + """Добавляет сохранённый идентификатор реплики в ответ.""" + + def __init__(self, app, instance_id: str) -> None: + super().__init__(app) + self.instance_id = instance_id + + async def dispatch( + self, + request: Request, + call_next: RequestResponseEndpoint, + ) -> Response: + response = await call_next(request) + response.headers[INSTANCE_ID_HEADER] = self.instance_id + + return response diff --git a/app/core/job_admin.py b/app/core/job_admin.py new file mode 100644 index 0000000..f75efa6 --- /dev/null +++ b/app/core/job_admin.py @@ -0,0 +1,82 @@ +"""Операторский интерфейс failed registry. Доступ требует credentials стенда.""" + +import argparse +import asyncio +import json +from uuid import UUID + +from app.core.background import log_background_error +from app.core.config import Settings +from app.core.database import create_db_engine, create_session_factory +from app.core.jobs import JobSettings +from app.domain.job_admin import ( + REPLAY_REASONS, + history, + list_failed, + replay_failed_job, + show_job, +) +from app.errors.exceptions import JobOperationError +from app.storage.s3 import create_s3_storage + + +async def execute(args): + settings = Settings() + engine = create_db_engine(settings) + storage = None + try: + factory = create_session_factory(engine) + async with factory() as session: + if args.command == "list-failed": + result = await list_failed(session, args.limit) + elif args.command == "show": + result = await show_job(session, args.job_id) + elif args.command == "history": + result = await history(session, args.job_id) + else: + storage = create_s3_storage(settings.s3) + result = await replay_failed_job( + session, + storage, + JobSettings(), + args.job_id, + request_id=args.request_id, + actor=args.actor, + reason=args.reason, + ) + print(json.dumps(result, default=str), flush=True) + finally: + if storage is not None: + await storage.aclose() + await engine.dispose() + + +def main(): + parser = argparse.ArgumentParser( + description="Реестр failed и явный replay с аудитом" + ) + commands = parser.add_subparsers(dest="command", required=True) + listing = commands.add_parser("list-failed") + listing.add_argument( + "--limit", type=int, choices=range(1, 501), default=50, metavar="1..500" + ) + for name in ("show", "history", "replay"): + command = commands.add_parser(name) + command.add_argument("job_id", type=UUID) + if name == "replay": + command.add_argument("--request-id", type=UUID, required=True) + command.add_argument("--actor", required=True) + command.add_argument("--reason", choices=REPLAY_REASONS, required=True) + args = parser.parse_args() + try: + asyncio.run(execute(args)) + except JobOperationError as error: + print(json.dumps({"error_code": error.code}), flush=True) + raise SystemExit(2) from None + except Exception as error: + log_background_error("Job administration failed", error) + raise SystemExit(1) from None + + +if __name__ == "__main__": + main() diff --git a/app/core/job_worker.py b/app/core/job_worker.py new file mode 100644 index 0000000..168d186 --- /dev/null +++ b/app/core/job_worker.py @@ -0,0 +1,170 @@ +"""Отдельные consumers с ограниченной конкуренцией; API не выполняет resize.""" + +import argparse +import asyncio +from dataclasses import dataclass +import json +import logging +import os +import signal +from uuid import UUID, uuid4 + +from PIL import features +from pydantic import ValidationError + +from app.core.background import ( + TRANSIENT_JOB_ERRORS, + log_background_error, + shutdown_event, + wait_or_stop, +) +from app.core.config import Settings +from app.core.database import create_db_engine, create_session_factory +from app.core.jobs import JobSettings +from app.domain.attachment_jobs import process_attachment_job +from app.errors.exceptions import ProcessingError +from app.schemas.job import JobMessage +from app.storage.broker import JobBroker +from app.storage.s3 import create_s3_storage + + +@dataclass(frozen=True) +class Faults: + """Только явные CLI-флаги; обычный worker не включает инъекции сбоев.""" + + crash_after_object: UUID | None = None + crash_before_ack: UUID | None = None + fail_transient: UUID | None = None + fail_permanent: UUID | None = None + object_name: str = "optimized" + + def kill(self, attachment_id: UUID, phase: str) -> None: + print( + json.dumps({"fault": phase, "attachment_id": str(attachment_id)}), + flush=True, + ) + os.kill(os.getpid(), signal.SIGKILL) + + def after_object(self, attachment_id: UUID, name: str) -> None: + if attachment_id == self.crash_after_object and name == self.object_name: + self.kill(attachment_id, "after_object:" + name) + + def before_ack(self, attachment_id: UUID) -> None: + if attachment_id == self.crash_before_ack: + self.kill(attachment_id, "before_ack") + + def before_processing(self, attachment_id: UUID) -> None: + if attachment_id == self.fail_transient: + raise TimeoutError("injected transient failure") + if attachment_id == self.fail_permanent: + raise ProcessingError("injected_permanent") + + +async def consume_connected( + factory, + storage, + broker: JobBroker, + settings: JobSettings, + stop: asyncio.Event, + faults: Faults, +) -> None: + consumer = uuid4().hex + while not stop.is_set(): + try: + await broker.ensure_ready() + delivery = await broker.receive(consumer) + if delivery is None: + continue + try: + message = JobMessage.model_validate_json(delivery.payload) + except ValidationError: + await broker.reject_invalid(delivery.id) + continue + try: + async with factory() as session: + acknowledge = await process_attachment_job( + session, + storage, + message, + settings, + after_object=faults.after_object, + before_processing=faults.before_processing, + ) + except ProcessingError: + await broker.reject_invalid(delivery.id) + else: + if acknowledge: + faults.before_ack(message.attachment_id) + await broker.acknowledge_job(delivery.id) + else: + await broker.defer_job(delivery.id) + except TRANSIENT_JOB_ERRORS as error: + log_background_error("Worker delivery deferred", error) + await broker.aclose() + await wait_or_stop(stop, settings.publisher_poll_seconds) + + +async def consume(factory, storage, settings, stop, faults) -> None: + broker = JobBroker(settings) + try: + await consume_connected(factory, storage, broker, settings, stop, faults) + finally: + await broker.aclose() + + +async def run_worker(faults: Faults) -> None: + settings = Settings() + jobs = JobSettings() + logging.basicConfig(level=settings.log_level) + if not features.check("webp"): + logging.error("Pillow requires WebP support for the image worker") + raise RuntimeError("WebP codec is unavailable") + stop = shutdown_event() + engine = create_db_engine(settings) + storage = None + try: + storage = create_s3_storage(settings.s3) + factory = create_session_factory(engine) + async with asyncio.TaskGroup() as group: + tasks = [ + group.create_task(consume(factory, storage, jobs, stop, faults)) + for _ in range(jobs.worker_concurrency) + ] + await stop.wait() + # Отмена убивает resize-процесс, дожидается SDK и не отправляет ack. + for task in tasks: + task.cancel() + finally: + if storage is not None: + await storage.aclose() + await engine.dispose() + + +def main() -> None: + parser = argparse.ArgumentParser( + description="Image worker с явными fault-injection hooks" + ) + modes = parser.add_mutually_exclusive_group() + for flag in ( + "crash-after-object", + "crash-before-ack", + "fail-transient", + "fail-permanent", + ): + modes.add_argument("--" + flag, type=UUID, metavar="ATTACHMENT_ID") + parser.add_argument( + "--object-name", + choices=("original", "thumbnail", "crop", "optimized"), + default="optimized", + ) + args = parser.parse_args() + faults = Faults(**vars(args)) + try: + asyncio.run(run_worker(faults)) + except Exception as error: + log_background_error("Worker stopped", error) + raise SystemExit(1) from None + + +if __name__ == "__main__": + main() diff --git a/app/core/jobs.py b/app/core/jobs.py new file mode 100644 index 0000000..a67c86d --- /dev/null +++ b/app/core/jobs.py @@ -0,0 +1,37 @@ +"""Настройки очереди из .env; credentials брокера читаются отдельно из файла.""" + +from pathlib import Path +from typing import Self + +from pydantic import Field, model_validator +from pydantic_settings import BaseSettings, SettingsConfigDict + + +class JobSettings(BaseSettings): + model_config = SettingsConfigDict(env_file=".env", extra="ignore") + + broker_host: str = "broker" + broker_port: int = Field(default=5672, ge=1, le=65535) + broker_password_file: Path = Path("/run/secrets/broker_password") + broker_queue: str = "attachment-jobs" + broker_user: str = "messenger" + broker_vhost: str = "/" + worker_concurrency: int = Field(default=2, ge=1, le=4) + job_max_attempts: int = Field(default=5, ge=1, le=100) + job_timeout_seconds: int = Field(default=60, ge=10, le=300) + job_lease_seconds: int = Field(default=90, ge=20, le=600) + job_retry_seconds: int = Field(default=5, ge=1, le=300) + job_retry_max_seconds: int = Field(default=120, ge=1, le=3600) + failed_staging_retention_seconds: int = Field(default=604800, ge=300) + publisher_poll_seconds: float = Field(default=1, gt=0, le=10) + staging_retention_seconds: int = Field(default=86400, ge=300) + + @model_validator(mode="after") + def validate_lease(self) -> Self: + if self.job_lease_seconds < self.job_timeout_seconds + 30: + raise ValueError( + "Lease должен превышать timeout задания минимум на 30 секунд" + ) + if self.job_retry_max_seconds < self.job_retry_seconds: + raise ValueError("Retry maximum must be at least the base delay") + return self diff --git a/app/core/lifecycle.py b/app/core/lifecycle.py new file mode 100644 index 0000000..c9e06a8 --- /dev/null +++ b/app/core/lifecycle.py @@ -0,0 +1,50 @@ +"""Готовность реплики и мягкое завершение сервера.""" + +import asyncio +from types import FrameType + +import uvicorn + + +class Lifecycle: + """Хранит состояние завершения реплики.""" + + def __init__(self) -> None: + self._draining = False + + @property + def draining(self) -> bool: + return self._draining + + def start_draining(self) -> None: + """Отключает приём новых бизнес-запросов.""" + self._draining = True + + +class GracefulServer(uvicorn.Server): + """Оставляет время для исключения завершающейся реплики.""" + + def __init__( + self, config: uvicorn.Config, lifecycle: Lifecycle, drain_seconds: float + ) -> None: + super().__init__(config) + self.lifecycle = lifecycle + self.drain_seconds = drain_seconds + self._drain_task: asyncio.Task[None] | None = None + + def handle_exit(self, sig: int, frame: FrameType | None) -> None: + """Первый сигнал запускает drain, повторный ускоряет остановку.""" + if self._drain_task is not None: + if not self._drain_task.done(): + self._drain_task.cancel() + super().handle_exit(sig, frame) + return + self.lifecycle.start_draining() + self._drain_task = asyncio.get_running_loop().create_task( + self._finish_draining(sig, frame) + ) + + async def _finish_draining(self, sig: int, frame: FrameType | None) -> None: + """Передаёт остановку Uvicorn после drain-периода.""" + await asyncio.sleep(self.drain_seconds) + super().handle_exit(sig, frame) diff --git a/app/core/outbox_publisher.py b/app/core/outbox_publisher.py new file mode 100644 index 0000000..54ef3a2 --- /dev/null +++ b/app/core/outbox_publisher.py @@ -0,0 +1,88 @@ +"""Доставка намерений из PostgreSQL; crash hook включается только явно через CLI.""" + +import argparse +import asyncio +import json +import logging +import os +import signal +from uuid import UUID + +from app.core.background import ( + TRANSIENT_JOB_ERRORS, + log_background_error, + shutdown_event, + wait_or_stop, +) +from app.core.config import Settings +from app.core.database import create_db_engine, create_session_factory +from app.core.jobs import JobSettings +from app.domain.attachment_jobs import publish_next_job, recover_expired_jobs +from app.storage.broker import JobBroker + + +def crash_before_publish(attachment_id: UUID) -> None: + """Реальный SIGKILL после чтения принятой job, до publisher confirm и отметки publish.""" + print( + json.dumps({"fault": "before_publish", "attachment_id": str(attachment_id)}), + flush=True, + ) + os.kill(os.getpid(), signal.SIGKILL) + + +async def run_publisher(crash_attachment_id: UUID | None = None) -> None: + settings = Settings() + jobs = JobSettings() + logging.basicConfig(level=settings.log_level) + stop = shutdown_event() + engine = create_db_engine(settings) + broker = None + try: + broker = JobBroker(jobs) + factory = create_session_factory(engine) + while not stop.is_set(): + published = False + try: + await broker.ensure_ready() + async with factory() as session: + await recover_expired_jobs(session, jobs) + published = await publish_next_job( + session, + broker, + attachment_id=crash_attachment_id, + before_publish=( + crash_before_publish + if crash_attachment_id is not None + else None + ), + ) + except TRANSIENT_JOB_ERRORS as error: + log_background_error("Publisher deferred", error) + if not published: + await wait_or_stop(stop, jobs.publisher_poll_seconds) + finally: + if broker is not None: + await broker.aclose() + await engine.dispose() + + +def main() -> None: + parser = argparse.ArgumentParser( + description="Публикация устойчивых jobs в RabbitMQ" + ) + parser.add_argument( + "--crash-before-publish", + type=UUID, + metavar="ATTACHMENT_ID", + help="аварийно завершить этот процесс перед публикацией только указанного вложения", + ) + args = parser.parse_args() + try: + asyncio.run(run_publisher(args.crash_before_publish)) + except Exception as error: + log_background_error("Publisher stopped", error) + raise SystemExit(1) from None + + +if __name__ == "__main__": + main() diff --git a/app/core/redis.py b/app/core/redis.py new file mode 100644 index 0000000..fb61304 --- /dev/null +++ b/app/core/redis.py @@ -0,0 +1,24 @@ +from redis.asyncio import BlockingConnectionPool, Redis +from redis.asyncio.retry import Retry +from redis.backoff import NoBackoff + +from app.core.config import Settings + + +def create_redis_client(settings: Settings) -> Redis: + password = ( + settings.redis_password.get_secret_value() if settings.redis_password else None + ) + pool = BlockingConnectionPool( + host=settings.redis_host, + port=settings.redis_port, + db=settings.redis_db, + password=password, + max_connections=settings.redis_max_connections, + timeout=settings.redis_pool_timeout_seconds, + socket_connect_timeout=settings.redis_connect_timeout_seconds, + socket_timeout=settings.redis_socket_timeout_seconds, + retry=Retry(NoBackoff(), retries=1), + decode_responses=True, + ) + return Redis.from_pool(pool) diff --git a/app/core/request_capacity.py b/app/core/request_capacity.py new file mode 100644 index 0000000..31968e7 --- /dev/null +++ b/app/core/request_capacity.py @@ -0,0 +1,42 @@ +from collections.abc import AsyncIterator + +from fastapi import Request + +from app.errors.exceptions import rate_limited, unavailable + + +class RequestCapacity: + def __init__(self, max_in_flight: int) -> None: + self._max_in_flight = max_in_flight + self._in_flight = 0 + + @property + def in_flight(self) -> int: + return self._in_flight + + def try_acquire(self) -> bool: + if self._in_flight >= self._max_in_flight: + return False + self._in_flight += 1 + return True + + def release(self) -> None: + self._in_flight -= 1 + + +def create_request_capacity(max_in_flight: int) -> RequestCapacity: + return RequestCapacity(max_in_flight) + + +async def acquire_request_slot(request: Request) -> AsyncIterator[None]: + if request.app.state.lifecycle.draining: + raise unavailable("Реплика завершает работу") + capacity: RequestCapacity = request.app.state.request_capacity + + if not capacity.try_acquire(): + raise rate_limited() + + try: + yield + finally: + capacity.release() diff --git a/app/core/request_id.py b/app/core/request_id.py new file mode 100644 index 0000000..a78a860 --- /dev/null +++ b/app/core/request_id.py @@ -0,0 +1,22 @@ +from uuid import uuid4 + +from starlette.middleware.base import BaseHTTPMiddleware, RequestResponseEndpoint +from starlette.requests import Request +from starlette.responses import Response + +REQUEST_ID_HEADER = "X-Request-Id" + + +class RequestIdMiddleware(BaseHTTPMiddleware): + async def dispatch( + self, + request: Request, + call_next: RequestResponseEndpoint, + ) -> Response: + request_id = str(uuid4()) + request.state.request_id = request_id + + response = await call_next(request) + response.headers[REQUEST_ID_HEADER] = request_id + + return response diff --git a/app/core/s3.py b/app/core/s3.py new file mode 100644 index 0000000..f2de188 --- /dev/null +++ b/app/core/s3.py @@ -0,0 +1,47 @@ +"""Конфигурация MinIO; значения credentials читаются только из файлов.""" + +from pathlib import Path +from urllib.parse import urlsplit + +from pydantic import Field, model_validator +from pydantic_settings import BaseSettings, SettingsConfigDict + + +class S3Settings(BaseSettings): + endpoint: str = "http://minio:9000" + region: str = "us-east-1" + bucket: str = "messenger-attachments" + access_key_id_file: Path = Path("/run/secrets/s3_access_key_id") + secret_access_key_file: Path = Path("/run/secrets/s3_secret_access_key") + connect_timeout_seconds: float = Field(default=2, gt=0, le=5) + read_timeout_seconds: float = Field(default=10, gt=0, le=15) + upload_timeout_seconds: float = Field(default=30, gt=0, le=60) + download_timeout_seconds: float = Field(default=60, gt=0, le=120) + image_timeout_seconds: float = Field(default=10, gt=0, le=15) + max_upload_bytes: int = Field(default=10_485_760, ge=1, le=10_485_760) + max_image_pixels: int = Field(default=40_000_000, ge=1, le=40_000_000) + chunk_bytes: int = Field(default=65_536, ge=1024, le=262_144) + max_concurrent_uploads: int = Field(default=2, ge=1, le=2) + cleanup_grace_seconds: int = Field(default=86_400, ge=300) + cleanup_interval_seconds: int = Field(default=300, ge=1) + + model_config = SettingsConfigDict( + env_prefix="S3_", env_file=".env", extra="ignore", frozen=True + ) + + @model_validator(mode="after") + def validate_endpoint(self): + url = urlsplit(self.endpoint) + if ( + url.scheme not in {"http", "https"} + or not url.hostname + or url.username + or url.password + or url.path not in {"", "/"} + or url.query + or url.fragment + ): + raise ValueError( + "S3_ENDPOINT должен быть http(s) адресом без credentials/пути" + ) + return self diff --git a/app/core/security.py b/app/core/security.py new file mode 100644 index 0000000..bfddf19 --- /dev/null +++ b/app/core/security.py @@ -0,0 +1,63 @@ +"""Хеширование паролей (Argon2id) и выпуск непрозрачных токенов сессий.""" + +import asyncio +import hashlib +import os +import secrets +from concurrent.futures import ThreadPoolExecutor + +from argon2 import PasswordHasher +from argon2.exceptions import InvalidHashError, VerificationError + +TOKEN_BYTES = 32 + +_hasher = PasswordHasher() +_executor = ThreadPoolExecutor( + max_workers=max(1, min(2, (os.cpu_count() or 1) // _hasher.parallelism)), + thread_name_prefix="argon2", +) + + +def _hash_password_sync(password: str) -> str: + """Блокирующий расчёт Argon2id-хеша со случайной солью в формате PHC.""" + return _hasher.hash(password) + + +def _verify_password_sync(password: str, password_hash: str) -> bool: + """Блокирующая проверка пароля по PHC-строке; False при несовпадении или повреждённом хеше.""" + try: + return _hasher.verify(password_hash, password) + except (VerificationError, InvalidHashError): + return False + + +_DUMMY_HASH = _hash_password_sync(secrets.token_urlsafe(TOKEN_BYTES)) + + +async def hash_password(password: str) -> str: + """Хеширует пароль в пуле потоков, не блокируя event loop.""" + loop = asyncio.get_running_loop() + return await loop.run_in_executor(_executor, _hash_password_sync, password) + + +async def verify_password(password: str, password_hash: str) -> bool: + """Проверяет пароль в пуле потоков, не блокируя event loop.""" + loop = asyncio.get_running_loop() + return await loop.run_in_executor( + _executor, _verify_password_sync, password, password_hash + ) + + +async def dummy_verify_password(password: str) -> None: + """Проверка против фиктивного хеша: время ответа не выдаёт отсутствие пользователя.""" + await verify_password(password, _DUMMY_HASH) + + +def generate_token() -> str: + """Непрозрачный токен сессии: 32 случайных байта в base64url.""" + return secrets.token_urlsafe(TOKEN_BYTES) + + +def hash_token(token: str) -> str: + """SHA-256 токена в hex: детерминированный ключ для хранилища сессий.""" + return hashlib.sha256(token.encode()).hexdigest() diff --git a/app/core/thumbnail_worker.py b/app/core/thumbnail_worker.py new file mode 100644 index 0000000..2c46510 --- /dev/null +++ b/app/core/thumbnail_worker.py @@ -0,0 +1,32 @@ +"""Один pipeline изображений в Linux-процессе с лимитами памяти и CPU.""" + +from pathlib import Path +import resource +import sys + +from app.core.image_processing import ImageSettings +from app.domain.image_pipeline import create_variants +from app.errors.exceptions import IMAGE_WORKER_ERRORS, pipeline_worker_error_code + + +def main() -> int: + settings = ImageSettings() + memory = settings.memory_mib * 1024 * 1024 + resource.setrlimit(resource.RLIMIT_AS, (memory, memory)) + resource.setrlimit( + resource.RLIMIT_CPU, (settings.cpu_seconds, settings.cpu_seconds) + ) + source, directory, metadata, content_type, maximum = sys.argv[1:] + code = 0 + try: + result = create_variants( + Path(source), Path(directory), content_type, int(maximum), settings + ) + Path(metadata).write_text(result.model_dump_json()) + except IMAGE_WORKER_ERRORS as error: + code = pipeline_worker_error_code(error) + return code + + +if __name__ == "__main__": + raise SystemExit(main()) diff --git a/app/domain/__init__.py b/app/domain/__init__.py new file mode 100644 index 0000000..93c96d5 --- /dev/null +++ b/app/domain/__init__.py @@ -0,0 +1 @@ +"""Бизнес-логика: проверки доступа, транзакции и ошибки API.""" diff --git a/app/domain/attachment_jobs.py b/app/domain/attachment_jobs.py new file mode 100644 index 0000000..ccf9934 --- /dev/null +++ b/app/domain/attachment_jobs.py @@ -0,0 +1,265 @@ +"""Приём, durable публикация, попытки и фиксация результата обработки.""" + +import asyncio +from collections.abc import Callable +from dataclasses import dataclass +from pathlib import Path +from tempfile import TemporaryDirectory +from uuid import UUID, uuid4 + +from minio.error import MinioException +from sqlalchemy.ext.asyncio import AsyncSession +from urllib3.exceptions import HTTPError as StorageHTTPError + +from app.core.jobs import JobSettings +from app.domain.job_retry import classify_failure, retry_delay +from app.domain.job_files import fetch_original, render_variants +from app.errors.exceptions import ProcessingError +from app.schemas.attachment import VARIANT_FILENAMES +from app.schemas.job import JobMessage +from app.storage import jobs, outbox +from app.storage.broker import JobBroker +from app.storage.jobs import JobWork +from app.storage.s3 import MinioStorage + + +@dataclass(frozen=True) +class Claim: + work: JobWork | None = None + acknowledge: bool = False + + +async def enqueue_attachment_job( + session: AsyncSession, attachment_id: UUID, staging_key: str +) -> UUID: + """Включить намерение обработки в транзакцию queued metadata; без commit.""" + return await jobs.create_job(session, attachment_id, staging_key) + + +async def publish_next_job( + session: AsyncSession, + broker: JobBroker, + *, + attachment_id: UUID | None = None, + before_publish: Callable[[UUID], None] | None = None, +) -> bool: + """Отметка publish следует за durable publisher confirm; crash допускает тот же job-дубль.""" + job = await outbox.next_unpublished_job(session, attachment_id=attachment_id) + published = job is not None + if job is not None: + if before_publish is not None: + before_publish(job.attachment_id) + await broker.publish_job( + JobMessage( + job_id=job.id, + attachment_id=job.attachment_id, + pipeline_version=job.pipeline_version, + attempt=job.attempt + 1, + created_at=job.created_at, + ) + ) + outbox.mark_published(job) + await session.commit() + return published + + +async def claim_job( + session: AsyncSession, message: JobMessage, settings: JobSettings +) -> Claim: + """Дубликат не захватывает живую аренду и не откатывает terminal-состояние.""" + row = await jobs.lock_job(session, message.job_id) + result = Claim() + if row is None: + raise ProcessingError("unknown_job") + job, attachment = row + if ( + message.attachment_id != attachment.id + or message.pipeline_version != job.pipeline_version + ): + raise ProcessingError("invalid_job") + now = await jobs.database_time(session) + if job.attempt_limit is None: + job.attempt_limit = settings.job_max_attempts + if attachment.status in {"ready", "failed"}: + result = Claim(acknowledge=True) + elif message.attempt <= job.attempt and attachment.status == "queued": + # Предыдущая попытка уже устойчиво заменена новой в PostgreSQL. + result = Claim(acknowledge=True) + elif message.attempt < job.attempt: + result = Claim(acknowledge=True) + elif message.attempt > job.attempt + 1: + raise ProcessingError("invalid_attempt") + elif attachment.status == "queued" and job.next_attempt_at <= now: + if ( + job.attempt >= (job.attempt_limit or settings.job_max_attempts) + or job.staging_key is None + ): + jobs.record_failure( + job, attachment, now, "retry_exhausted", terminal=True, retry_seconds=0 + ) + result = Claim(acknowledge=True) + else: + result = Claim( + work=jobs.start_job( + job, attachment, uuid4(), now, settings.job_lease_seconds + ) + ) + await session.commit() + return result + + +async def save_failure( + session: AsyncSession, + work: JobWork, + settings: JobSettings, + code: str, + *, + permanent: bool, +) -> None: + # Неоднозначный COMMIT проверяется повторным чтением: ready сохраняется. + await session.rollback() + row = await jobs.lock_job(session, work.job_id) + if row is not None: + job, attachment = row + if attachment.status == "processing" and job.lease_token == work.lease_token: + exhausted = job.attempt >= (job.attempt_limit or settings.job_max_attempts) + jobs.record_failure( + job, + attachment, + await jobs.database_time(session), + "retry_exhausted" if exhausted and not permanent else code, + terminal=permanent or exhausted, + retry_seconds=retry_delay( + settings, job.attempt - job.cycle_start_attempt + ), + ) + job.last_error_code = code + job.last_error_permanent = permanent + await session.commit() + + +async def build_result( + session: AsyncSession, + storage: MinioStorage, + work: JobWork, + after_object: Callable[[UUID, str], None] | None = None, +) -> bool: + """Фиксированные ключи и блокировка job защищают PUT от устаревшей попытки.""" + with TemporaryDirectory(prefix="messenger-job-") as directory: + source = Path(directory) / "original" + await fetch_original(storage, work, source) + result = await render_variants(storage, work, source, Path(directory)) + row = await jobs.lock_job(session, work.job_id) + if row is None: + await session.rollback() + return True + job, attachment = row + now = await jobs.database_time(session) + if attachment.status != "processing" or job.lease_token != work.lease_token: + await session.rollback() + return True + if job.lease_until is None or job.lease_until <= now: + await session.rollback() + return False + # Блокировка остаётся до завершения PUT/COMMIT; reaper использует SKIP LOCKED. + # При отмене S3 adapter дожидается SDK-потока до освобождения блокировки. + await storage.put_file( + work.original_key, + source, + size_bytes=work.size_bytes, + content_type=work.content_type, + sha256=work.sha256, + ) + if after_object is not None: + after_object(work.attachment_id, "original") + for variant in result.variants: + await storage.put_file( + work.variant_key(variant.name), + Path(directory) / VARIANT_FILENAMES[variant.name], + size_bytes=variant.size_bytes, + content_type=variant.content_type, + sha256=variant.sha256, + ) + if after_object is not None: + after_object(work.attachment_id, variant.name) + jobs.complete_job( + job, + attachment, + work, + [variant.model_dump() for variant in result.variants], + await jobs.database_time(session), + ) + await session.commit() + return True + + +async def process_attachment_job( + session: AsyncSession, + storage: MinioStorage, + message: JobMessage, + settings: JobSettings, + *, + after_object: Callable[[UUID, str], None] | None = None, + before_processing: Callable[[UUID], None] | None = None, +) -> bool: + claim = await claim_job(session, message, settings) + acknowledge = claim.acknowledge + if claim.work is not None: + work = claim.work + try: + async with asyncio.timeout(settings.job_timeout_seconds): + if before_processing is not None: + before_processing(work.attachment_id) + acknowledge = await build_result(session, storage, work, after_object) + except ( + ProcessingError, + MinioException, + StorageHTTPError, + OSError, + TimeoutError, + ) as error: + code, permanent = classify_failure(error) + await save_failure(session, work, settings, code, permanent=permanent) + acknowledge = True + # Ошибка БД/неизвестная ошибка или отмена не подтверждают доставку. + return acknowledge + + +async def recover_expired_jobs(session: AsyncSession, settings: JobSettings) -> int: + rows = await jobs.expired_jobs(session) + now = await jobs.database_time(session) + for job, attachment in rows: + if job.attempt_limit is None: + job.attempt_limit = settings.job_max_attempts + exhausted = job.attempt >= (job.attempt_limit or settings.job_max_attempts) + jobs.record_failure( + job, + attachment, + now, + "retry_exhausted" if exhausted else "worker_timeout", + terminal=exhausted, + retry_seconds=retry_delay(settings, job.attempt - job.cycle_start_attempt), + ) + job.last_error_code = "worker_timeout" + job.last_error_permanent = False + await session.commit() + return len(rows) + + +async def cleanup_staging( + session: AsyncSession, storage: MinioStorage, settings: JobSettings, *, apply: bool +) -> int: + rows = await jobs.terminal_staging( + session, + settings.staging_retention_seconds, + settings.failed_staging_retention_seconds, + ) + if apply: + for job, attachment in rows: + if job.staging_key != attachment.object_key: + await storage.delete_object(job.staging_key) + jobs.clear_staging(job) + await session.commit() + else: + await session.rollback() + return len(rows) diff --git a/app/domain/attachments.py b/app/domain/attachments.py new file mode 100644 index 0000000..2a33d01 --- /dev/null +++ b/app/domain/attachments.py @@ -0,0 +1,340 @@ +"""Авторизация, приём оригинала и согласованность PostgreSQL/MinIO.""" + +from collections.abc import AsyncIterator, Iterator +from contextlib import contextmanager, suppress +from dataclasses import dataclass +import hashlib +from pathlib import Path +from tempfile import TemporaryDirectory +from uuid import UUID, uuid4 + +from anyio import CancelScope +from sqlalchemy.ext.asyncio import AsyncSession + +from app.core.request_capacity import RequestCapacity +from app.domain.chats import ensure_chat_member +from app.domain.attachment_jobs import enqueue_attachment_job +from app.domain.images import validate_filename, validate_image +from app.errors.exceptions import ( + conflict, + invalid_request, + not_found, + payload_too_large, + rate_limited, + unavailable, + unsupported_media_type, +) +from app.errors.handlers import ( + RECOVERABLE_STORAGE_ERRORS, + log_recoverable_error, + operation_timeout, +) +from app.schemas.attachment import Attachment, VARIANT_FILENAMES +from app.schemas.user import User +from app.storage import attachments as repository +from app.storage.s3 import MinioStorage + + +@dataclass(frozen=True) +class CleanupResult: + examined: int + candidates: int + deleted: int + + +@dataclass(frozen=True) +class OriginalFile: + path: Path + size_bytes: int + sha256: str + + +def require_storage(storage: MinioStorage | None) -> MinioStorage: + if storage is None: + raise unavailable("Объектное хранилище не настроено") + return storage + + +def validate_declared_size(value: str | None, maximum: int) -> None: + if value is not None: + if not value.isascii() or not value.isdecimal() or len(value) > 20: + raise invalid_request("Некорректный Content-Length") + if int(value) > maximum: + raise payload_too_large() + + +@contextmanager +def upload_slot(capacity: RequestCapacity) -> Iterator[None]: + if not capacity.try_acquire(): + raise rate_limited() + try: + yield + finally: + capacity.release() + + +async def receive_attachment( + session: AsyncSession, + storage: MinioStorage | None, + user: User, + chat_id: UUID, + *, + capacity: RequestCapacity, + filename: str, + content_type: str, + declared_length: str | None, + chunks: AsyncIterator[bytes], +) -> Attachment: + storage = require_storage(storage) + validate_declared_size(declared_length, storage.settings.max_upload_bytes) + timeout_error = invalid_request("Истекло время загрузки") + with upload_slot(capacity): + async with operation_timeout( + storage.settings.upload_timeout_seconds, timeout_error + ): + result = await upload_attachment( + session, + storage, + user, + chat_id, + filename=filename, + content_type=content_type, + chunks=chunks, + ) + return result + + +async def read_original( + chunks: AsyncIterator[bytes], + path: Path, + maximum: int, + chunk_bytes: int, +) -> OriginalFile: + checksum = hashlib.sha256() + size = 0 + with path.open("wb") as target: + async for chunk in chunks: + size += len(chunk) + if size > maximum: + raise payload_too_large() + checksum.update(chunk) + view = memoryview(chunk) + for offset in range(0, len(view), chunk_bytes): + target.write(view[offset : offset + chunk_bytes]) + if size == 0: + raise unsupported_media_type("Пустой файл") + return OriginalFile(path, size, checksum.hexdigest()) + + +async def compensate_upload( + session: AsyncSession, storage: MinioStorage, id: UUID +) -> None: + """Неоднозначный COMMIT сначала проверяется в БД: готовый объект не удаляется.""" + await session.rollback() + intent = await repository.lock_upload(session, id) + if intent is not None: + if await repository.get_by_key(session, intent.object_key) is None: + await storage.delete_object(intent.object_key) + await repository.finish_upload(session, id) + await session.commit() + + +async def recover_upload( + session: AsyncSession, storage: MinioStorage, id: UUID +) -> None: + """Локальное восстановление после ошибки; журнал остаётся при отказе компенсации.""" + try: + await compensate_upload(session, storage, id) + except RECOVERABLE_STORAGE_ERRORS as error: + log_recoverable_error("Upload compensation", error) + # Ошибка повторного rollback не должна скрыть исходную ошибку или отмену. + with suppress(*RECOVERABLE_STORAGE_ERRORS): + await session.rollback() + + +async def stage_attachment( + session: AsyncSession, + storage: MinioStorage, + user: User, + chat_id: UUID, + *, + original: OriginalFile, + filename: str, + content_type: str, +) -> Attachment: + """Сохранить исходник в staging и атомарно принять metadata/job.""" + id = uuid4() + key = f"staging/{uuid4().hex}" + # Журнал устойчив до PUT, включая аварию процесса и неоднозначный COMMIT. + await repository.reserve_upload(session, id, key) + await session.commit() + try: + if await repository.lock_upload(session, id) is None: + raise unavailable("Загрузка отменена до записи оригинала") + await storage.put_file( + key, + original.path, + size_bytes=original.size_bytes, + content_type=content_type, + sha256=original.sha256, + ) + record = await repository.create_attachment( + session, + id=id, + chat_id=chat_id, + owner_id=user.id, + object_key=f"originals/{id.hex}/v1", + status="queued", + filename=filename, + content_type=content_type, + size_bytes=original.size_bytes, + sha256=original.sha256, + ) + await enqueue_attachment_job(session, id, key) + await repository.finish_upload(session, id) + # Снимок queued строится до COMMIT, даже если worker очень быстрый. + result = Attachment.model_validate(record) + await session.commit() + except BaseException: + # Отмена тоже требует дождаться SDK и компенсировать незавершённый PUT. + with CancelScope(shield=True): + await recover_upload(session, storage, id) + raise + return result + + +async def upload_attachment( + session: AsyncSession, + storage: MinioStorage, + user: User, + chat_id: UUID, + *, + filename: str, + content_type: str, + chunks: AsyncIterator[bytes], +) -> Attachment: + await ensure_chat_member(session, user, chat_id) + validate_filename(filename) + if content_type not in {"image/png", "image/jpeg"}: + raise unsupported_media_type("Принимаются только image/png и image/jpeg") + # Не держим соединение PostgreSQL во время чтения медленного клиента. + await session.rollback() + settings = storage.settings + with TemporaryDirectory(prefix="messenger-upload-") as directory: + original = await read_original( + chunks, + Path(directory) / "original", + settings.max_upload_bytes, + settings.chunk_bytes, + ) + await validate_image(original.path, content_type, settings) + result = await stage_attachment( + session, + storage, + user, + chat_id, + original=original, + filename=filename, + content_type=content_type, + ) + return result + + +async def get_attachment( + session: AsyncSession, user: User, attachment_id: UUID +) -> Attachment: + record = await repository.get_attachment(session, attachment_id) + if record is None: + raise not_found() + await ensure_chat_member(session, user, record.chat_id) + return Attachment.model_validate(record) + + +@dataclass(frozen=True) +class DownloadInfo: + filename: str + content_type: str + size_bytes: int + + +async def download_attachment( + session: AsyncSession, + storage: MinioStorage | None, + user: User, + attachment_id: UUID, + *, + variant: str = "original", +) -> tuple[DownloadInfo, AsyncIterator[bytes]]: + result = await get_attachment(session, user, attachment_id) + if result.status != "ready": + raise conflict("Вложение пока недоступно для скачивания") + storage = require_storage(storage) + record = await repository.get_attachment(session, attachment_id) + if record is None: + raise not_found() + if variant == "original": + key = record.object_key + info = DownloadInfo(result.filename, result.content_type, result.size_bytes) + else: + selected = next( + (item for item in result.variants if item.name == variant), None + ) + keys = { + "thumbnail": record.thumbnail_key, + "crop": record.crop_key, + "optimized": record.optimized_key, + } + key = keys.get(variant) + if selected is None or key is None: + raise not_found() + info = DownloadInfo( + VARIANT_FILENAMES[variant], selected.content_type, selected.size_bytes + ) + await session.rollback() + stored = await storage.stat_object(key) + if stored.size_bytes != info.size_bytes or stored.content_type != info.content_type: + raise unavailable("Файл временно недоступен") + stream = await storage.open_object(key) + return info, stream + + +async def validate_message_attachments( + session: AsyncSession, + user: User, + chat_id: UUID, + attachment_ids: list[UUID], +) -> None: + await ensure_chat_member(session, user, chat_id) + records = await repository.get_for_chat(session, chat_id, attachment_ids) + if len(records) != len(attachment_ids): + raise not_found() + if any(record.status == "failed" for record in records): + raise conflict("Обработка вложения завершилась ошибкой") + + +async def reconcile_attachments( + session: AsyncSession, + storage: MinioStorage, + *, + batch_size: int = 20, + dry_run: bool = True, +) -> CleanupResult: + if not 1 <= batch_size <= 100: + raise invalid_request("batch_size должен быть от 1 до 100") + intents = await repository.stale_uploads( + session, storage.settings.cleanup_grace_seconds, batch_size + ) + candidates = deleted = 0 + for intent in intents: + if await repository.get_by_key(session, intent.object_key) is None: + candidates += 1 + if not dry_run: + await storage.delete_object(intent.object_key) + deleted += 1 + if not dry_run: + await repository.finish_upload(session, intent.id) + if dry_run: + await session.rollback() + else: + await session.commit() + return CleanupResult(len(intents), candidates, deleted) diff --git a/app/domain/auth.py b/app/domain/auth.py new file mode 100644 index 0000000..63f4f3c --- /dev/null +++ b/app/domain/auth.py @@ -0,0 +1,84 @@ +import re +from datetime import UTC, datetime, timedelta + +from redis.asyncio import Redis +from sqlalchemy.ext.asyncio import AsyncSession + +from app.core import security +from app.domain.users import to_user_schema +from app.errors.exceptions import unauthorized_basic, unauthorized_bearer +from app.schemas.session import AuthSession +from app.schemas.user import ( + PASSWORD_MAX_LENGTH, + PASSWORD_MIN_LENGTH, + USERNAME_PATTERN, + User, +) +from app.storage import sessions as sessions_storage +from app.storage import users as users_storage + +USERNAME_RE = re.compile(USERNAME_PATTERN) + + +async def create_session( + session: AsyncSession, + redis: Redis, + username: str, + password: str, + ttl_seconds: int, +) -> AuthSession: + """Проверяет учётные данные и выдаёт новый Bearer-токен.""" + if ( + USERNAME_RE.fullmatch(username) is None + or not PASSWORD_MIN_LENGTH <= len(password) <= PASSWORD_MAX_LENGTH + or not password.strip() + ): + raise unauthorized_basic() + + user = await users_storage.get_user_by_username(session, username) + await session.commit() + + if user is None: + await security.dummy_verify_password(password) + raise unauthorized_basic() + + if not await security.verify_password(password, user.password_hash): + raise unauthorized_basic() + + token = security.generate_token() + expires_at = datetime.now(UTC) + timedelta(seconds=ttl_seconds) + await sessions_storage.create_session( + redis, + token_hash=security.hash_token(token), + user_id=user.id, + expires_at=expires_at, + ) + auth_session = AuthSession( + token=token, expires_at=expires_at, user=to_user_schema(user) + ) + return auth_session + + +async def authenticate_token(session: AsyncSession, redis: Redis, token: str) -> User: + """Возвращает владельца действующей сессии или бросает 401.""" + user_id = await sessions_storage.get_session_user_id( + redis, security.hash_token(token) + ) + if user_id is None: + raise unauthorized_bearer() + + user = await users_storage.get_user_by_id(session, user_id) + if user is None: + raise unauthorized_bearer() + + current_user = to_user_schema(user) + return current_user + + +async def revoke_session(redis: Redis, token: str) -> None: + """Отзывает текущую сессию; повторный отзыв даёт 401.""" + is_deleted = await sessions_storage.delete_session( + redis, security.hash_token(token) + ) + if not is_deleted: + raise unauthorized_bearer() diff --git a/app/domain/chats.py b/app/domain/chats.py new file mode 100644 index 0000000..c810a98 --- /dev/null +++ b/app/domain/chats.py @@ -0,0 +1,104 @@ +from uuid import UUID + +from sqlalchemy.exc import IntegrityError +from sqlalchemy.ext.asyncio import AsyncSession + +from app.domain.pagination import ( + KIND_CHATS, + build_next_cursor, + decode_cursor, + split_page, +) +from app.errors.exceptions import invalid_request, not_found +from app.models.chat import Chat as ChatModel +from app.schemas.chat import Chat, ChatPage, CreateChat +from app.schemas.user import User +from app.storage import chats as chats_storage +from app.storage import users as users_storage +from app.storage.types import Position + +UNKNOWN_MEMBER_MESSAGE = "member_ids содержит неизвестного пользователя" + + +def to_chat_schema(chat: ChatModel) -> Chat: + """Преобразует ORM-модель чата с загруженными участниками в схему.""" + chat_schema = Chat( + id=chat.id, + title=chat.title, + member_ids=[member.user_id for member in chat.members], + created_at=chat.created_at, + ) + return chat_schema + + +def validate_new_chat(creator: User, new_chat: CreateChat) -> None: + """Проверяет состав участников без обращения к базе.""" + member_ids = new_chat.member_ids + + if creator.id not in member_ids: + raise invalid_request("Создатель чата должен входить в member_ids") + + if len(set(member_ids)) != len(member_ids): + raise invalid_request("member_ids содержит дубликаты") + + +async def create_chat( + session: AsyncSession, creator: User, new_chat: CreateChat +) -> Chat: + """Создаёт чат с участниками атомарно; неверный состав даёт 400.""" + validate_new_chat(creator, new_chat) + + existing_ids = await users_storage.get_existing_user_ids( + session, new_chat.member_ids + ) + if existing_ids != set(new_chat.member_ids): + raise invalid_request(UNKNOWN_MEMBER_MESSAGE) + + try: + chat = await chats_storage.create_chat( + session, title=new_chat.title, member_ids=new_chat.member_ids + ) + await session.commit() + except IntegrityError: + await session.rollback() + raise invalid_request(UNKNOWN_MEMBER_MESSAGE) from None + + created_chat = to_chat_schema(chat) + return created_chat + + +async def get_chat(session: AsyncSession, user: User, chat_id: UUID) -> Chat: + """Возвращает чат участнику; чужой и несуществующий чат дают 404.""" + chat = await chats_storage.get_chat_for_member(session, chat_id, user.id) + if chat is None: + raise not_found() + + found_chat = to_chat_schema(chat) + return found_chat + + +async def ensure_chat_member(session: AsyncSession, user: User, chat_id: UUID) -> None: + """Бросает 404, если пользователь не состоит в чате или чата нет.""" + if not await chats_storage.is_chat_member(session, chat_id, user.id): + raise not_found() + + +async def list_chats( + session: AsyncSession, + user: User, + cursor: str | None, + limit: int, +) -> ChatPage: + """Возвращает страницу чатов пользователя по (created_at, id).""" + after: Position | None = None + if cursor is not None: + after = decode_cursor(cursor, KIND_CHATS, user.id) + + rows = await chats_storage.list_chats_for_user(session, user.id, after, limit + 1) + page_rows, has_next = split_page(rows, limit) + items = [to_chat_schema(chat) for chat in page_rows] + page = ChatPage( + items=items, + next_cursor=build_next_cursor(KIND_CHATS, user.id, items, has_next), + ) + return page diff --git a/app/domain/health.py b/app/domain/health.py new file mode 100644 index 0000000..c5d6ac3 --- /dev/null +++ b/app/domain/health.py @@ -0,0 +1,36 @@ +"""Условия готовности реплики и ограниченная проверка зависимостей.""" + +import asyncio + +from redis.asyncio import Redis +from sqlalchemy.ext.asyncio import AsyncEngine + +from app.core.lifecycle import Lifecycle +from app.errors.exceptions import unavailable +from app.errors.handlers import operation_timeout +from app.schemas.base import Health +from app.storage.health import check_database, check_redis +from app.storage.s3 import MinioStorage + + +def liveness() -> Health: + return Health(status="ok") + + +async def readiness( + engine: AsyncEngine, + redis: Redis, + storage: MinioStorage | None, + lifecycle: Lifecycle, + timeout_seconds: float, +) -> Health: + if lifecycle.draining: + raise unavailable() + checks = [check_database(engine), check_redis(redis)] + if storage is not None: + checks.append(storage.check_available()) + async with operation_timeout(timeout_seconds, unavailable()): + dependencies = await asyncio.gather(*checks, return_exceptions=True) + if not all(result is True for result in dependencies): + raise unavailable() + return Health(status="ok") diff --git a/app/domain/idempotency.py b/app/domain/idempotency.py new file mode 100644 index 0000000..5ad9390 --- /dev/null +++ b/app/domain/idempotency.py @@ -0,0 +1,78 @@ +"""Атомарная отправка сообщения с защитой от повторов.""" + +import hashlib +import json +import re +from uuid import UUID + +from sqlalchemy.ext.asyncio import AsyncSession + +from app.domain.chats import ensure_chat_member +from app.domain.attachments import validate_message_attachments +from app.errors.exceptions import conflict, invalid_request, unavailable +from app.schemas.message import CreateMessage, Message +from app.schemas.user import User +from app.storage import idempotency as key_storage +from app.storage import messages as message_storage +from app.storage import attachments as attachment_storage + +IDEMPOTENCY_KEY_PATTERN = re.compile(r"[A-Za-z0-9._:-]{1,128}") + + +def validate_idempotency_key(key: str | None) -> str: + """Проверяет обязательный ASCII-ключ запроса.""" + if key is None or IDEMPOTENCY_KEY_PATTERN.fullmatch(key) is None: + raise invalid_request("Требуется корректный Idempotency-Key") + return key + + +def request_fingerprint(new_message: CreateMessage) -> str: + """Хеширует нормализованное содержимое запроса.""" + body = new_message.model_dump(mode="json") + # Сохраняет прежние отпечатки текстовых запросов и равенство absent / []. + if not body["attachment_ids"]: + body.pop("attachment_ids") + canonical = json.dumps(body, sort_keys=True, ensure_ascii=False) + return hashlib.sha256(canonical.encode()).hexdigest() + + +async def send_message_idempotent( + session: AsyncSession, + sender: User, + chat_id: UUID, + new_message: CreateMessage, + idempotency_key: str, + max_messages: int, + ttl_seconds: int, +) -> Message: + """Создаёт сообщение или возвращает результат прежнего запроса.""" + await ensure_chat_member(session, sender, chat_id) + scope = (sender.id, "POST", f"/api/v1/chats/{chat_id}/messages", idempotency_key) + fingerprint = request_fingerprint(new_message) + + await key_storage.lock_key(session, scope) + previous = await key_storage.get_active_key(session, scope, ttl_seconds) + if previous is not None: + if previous.request_hash != fingerprint: + raise conflict("Idempotency-Key уже использован для другого сообщения") + message = await message_storage.get_message(session, previous.message_id) + else: + await validate_message_attachments( + session, sender, chat_id, new_message.attachment_ids + ) + if not await message_storage.reserve_message_slot(session, max_messages): + raise unavailable("Достигнут лимит количества сообщений") + message = await message_storage.create_message( + session, chat_id=chat_id, sender_id=sender.id, text=new_message.text + ) + await attachment_storage.bind_attachments( + session, message.id, new_message.attachment_ids + ) + await key_storage.save_result(session, scope, fingerprint, message.id) + + links = await attachment_storage.message_attachment_ids(session, [message.id]) + result = Message.model_validate(message).model_copy( + update={"attachment_ids": links[message.id]} + ) + await session.commit() + return result diff --git a/app/domain/image_pipeline.py b/app/domain/image_pipeline.py new file mode 100644 index 0000000..c7f6353 --- /dev/null +++ b/app/domain/image_pipeline.py @@ -0,0 +1,105 @@ +"""Thumbnail, crop и WebP; один ограниченный процесс, последовательная обработка.""" + +import hashlib +from pathlib import Path + +from PIL import Image, ImageOps + +from app.core.image_processing import ImageSettings +from app.domain.image_validation import decode_image +from app.schemas.attachment import PipelineResult, Variant + + +def fitted_size(size: tuple[int, int], maximum: int) -> tuple[int, int]: + """Вписать без увеличения, округляя вниз, минимум один пиксель.""" + longest = max(size) + result = size + if longest > maximum: + result = ( + max(1, size[0] * maximum // longest), + max(1, size[1] * maximum // longest), + ) + return result + + +def describe_variant( + name: str, content_type: str, path: Path, size: tuple[int, int] +) -> Variant: + checksum = hashlib.sha256() + with path.open("rb") as source: + for chunk in iter(lambda: source.read(65536), b""): + checksum.update(chunk) + return Variant( + name=name, + content_type=content_type, + size_bytes=path.stat().st_size, + width=size[0], + height=size[1], + sha256=checksum.hexdigest(), + ) + + +def save_jpeg(image: Image.Image, destination: Path, quality: int) -> None: + """Белая подложка и новый image без EXIF/ICC/XMP/текстовых метаданных.""" + with Image.new("RGB", image.size, "white") as clean: + with image.getchannel("A") as alpha: + clean.paste(image, mask=alpha) + clean.save(destination, format="JPEG", quality=quality, exif=b"") + + +def create_thumbnail(image: Image.Image, destination: Path, quality: int) -> Variant: + size = fitted_size(image.size, 256) + with image.resize(size, Image.Resampling.LANCZOS) as resized: + save_jpeg(resized, destination, quality) + return describe_variant("thumbnail", "image/jpeg", destination, size) + + +def create_crop(image: Image.Image, destination: Path, quality: int) -> Variant: + """Центрированный JPEG 128×128; маленький исходник допускает увеличение.""" + with ImageOps.fit( + image, (128, 128), method=Image.Resampling.LANCZOS, centering=(0.5, 0.5) + ) as crop: + save_jpeg(crop, destination, quality) + return describe_variant("crop", "image/jpeg", destination, (128, 128)) + + +def create_optimized( + image: Image.Image, destination: Path, settings: ImageSettings +) -> Variant: + """WebP ≤1280×1280 без увеличения; alpha сохраняется, метаданные удаляются.""" + size = fitted_size(image.size, 1280) + with image.resize(size, Image.Resampling.LANCZOS) as resized: + with Image.new("RGBA", size) as clean: + clean.paste(resized) + clean.save( + destination, + format="WEBP", + lossless=False, + quality=settings.webp_quality, + method=settings.webp_method, + exif=b"", + icc_profile=b"", + xmp=b"", + ) + return describe_variant("optimized", "image/webp", destination, size) + + +def create_variants( + source: Path, + directory: Path, + content_type: str, + max_pixels: int, + settings: ImageSettings, +) -> PipelineResult: + decode_image(source, content_type, max_pixels) + with Image.open(source, formats=["PNG", "JPEG"]) as image: + ImageOps.exif_transpose(image, in_place=True) + with image.convert("RGBA") as pixels: + variants = [ + create_thumbnail( + pixels, directory / "thumbnail.jpg", settings.jpeg_quality + ), + create_crop(pixels, directory / "crop.jpg", settings.jpeg_quality), + create_optimized(pixels, directory / "optimized.webp", settings), + ] + return PipelineResult(variants=variants) diff --git a/app/domain/image_validation.py b/app/domain/image_validation.py new file mode 100644 index 0000000..c004d29 --- /dev/null +++ b/app/domain/image_validation.py @@ -0,0 +1,23 @@ +"""Синхронная проверка изображения; вызывается только из ограниченного процесса.""" + +from pathlib import Path +import warnings + +from PIL import Image + +from app.errors.exceptions import payload_too_large, unsupported_media_type + + +def decode_image(path: Path, content_type: str, max_pixels: int) -> None: + Image.MAX_IMAGE_PIXELS = max_pixels + warnings.simplefilter("error", Image.DecompressionBombWarning) + with Image.open(path, formats=["PNG", "JPEG"]) as image: + if image.width * image.height > max_pixels: + raise payload_too_large("Превышен лимит пикселей изображения") + image_format = image.format + if image_format is None or Image.MIME.get(image_format) != content_type: + raise unsupported_media_type("Содержимое не соответствует Content-Type") + image.verify() + # Для JPEG одной verify() недостаточно: декодировать весь оригинал. + with Image.open(path, formats=["PNG", "JPEG"]) as image: + image.load() diff --git a/app/domain/images.py b/app/domain/images.py new file mode 100644 index 0000000..4436656 --- /dev/null +++ b/app/domain/images.py @@ -0,0 +1,48 @@ +"""Проверка имени и запуск ограниченного декодера.""" + +import asyncio +from pathlib import Path +import sys +import unicodedata + +from anyio import CancelScope + +from app.core.s3 import S3Settings +from app.errors.exceptions import ( + image_validation_error, + invalid_request, + payload_too_large, +) +from app.errors.handlers import operation_timeout + + +def validate_filename(filename: str) -> None: + if not 1 <= len(filename) <= 255 or any( + char in "/\\" or unicodedata.category(char) in {"Cc", "Cf", "Cs"} + for char in filename + ): + raise invalid_request("Недопустимое имя файла") + + +async def validate_image(path: Path, content_type: str, settings: S3Settings) -> None: + process = await asyncio.create_subprocess_exec( + sys.executable, + "-m", + "app.core.image_worker", + str(path), + content_type, + str(settings.max_image_pixels), + stdout=asyncio.subprocess.DEVNULL, + stderr=asyncio.subprocess.DEVNULL, + ) + error = payload_too_large("Превышен бюджет проверки изображения") + try: + async with operation_timeout(settings.image_timeout_seconds, error): + code = await process.wait() + finally: + if process.returncode is None: + process.kill() + with CancelScope(shield=True): + await process.wait() + if code != 0: + raise image_validation_error(code) diff --git a/app/domain/job_admin.py b/app/domain/job_admin.py new file mode 100644 index 0000000..5bfb82e --- /dev/null +++ b/app/domain/job_admin.py @@ -0,0 +1,161 @@ +"""Replay только failed с проверенным исходником и ограниченным новым бюджетом.""" + +import asyncio +import re +from pathlib import Path +from tempfile import TemporaryDirectory +from uuid import uuid4 + +from minio.error import S3Error + +from app.domain.job_files import fetch_original +from app.errors.exceptions import JobOperationError, ProcessingError +from app.storage import job_admin, jobs +from app.storage.jobs import JobWork + +REPLAY_REASONS = ("dependency_restored", "configuration_fixed", "manual_review") + + +def snapshot(job, attachment): + return dict( + job_id=str(job.id), + attachment_id=str(attachment.id), + status=attachment.status, + attempt=job.attempt, + attempt_limit=job.attempt_limit, + cycle_start_attempt=job.cycle_start_attempt, + error_code=attachment.error_code, + last_error_code=job.last_error_code, + last_error_permanent=job.last_error_permanent, + staging_retained=job.staging_key is not None, + next_attempt_at=job.next_attempt_at, + lease_until=job.lease_until, + finished_at=job.finished_at, + ) + + +async def list_failed(session, limit): + return [ + snapshot(job, attachment) + for job, attachment in await job_admin.failed_jobs(session, limit) + ] + + +async def show_job(session, job_id): + row = await jobs.lock_job(session, job_id) + if row is None: + raise JobOperationError("unknown_job") + result = snapshot(*row) + await session.rollback() + return result + + +async def history(session, job_id): + return [ + dict( + request_id=str(row.id), + actor=row.actor, + reason=row.reason, + previous_attempt=row.previous_attempt, + attempt_limit=row.attempt_limit, + previous_error_code=row.previous_error_code, + created_at=row.created_at, + ) + for row in await job_admin.replay_history(session, job_id) + ] + + +def same_request(record, job_id, actor, reason): + if record.job_id != job_id or record.actor != actor or record.reason != reason: + raise JobOperationError("request_conflict") + return { + "request_id": str(record.id), + "job_id": str(job_id), + "already_applied": True, + } + + +def validate_replay_request(actor: str, reason: str) -> None: + """Проверить данные оператора для записи аудита.""" + if ( + re.fullmatch(r"[A-Za-z0-9._-]{1,64}", actor) is None + or reason not in REPLAY_REASONS + ): + raise JobOperationError("invalid_audit_fields") + + +def validate_replay_job(job, attachment) -> None: + """Разрешить новый replay только для failed с сохранённым исходником.""" + if attachment.status != "failed": + raise JobOperationError("job_not_failed") + if job.staging_key is None: + raise JobOperationError("source_expired") + + +async def verify_replay_source(storage, settings, job, attachment) -> None: + """Проверить размер и SHA-256 исходника в S3 под блокировкой job.""" + work = JobWork( + job.id, + attachment.id, + uuid4(), + job.pipeline_version, + job.staging_key, + attachment.content_type, + attachment.size_bytes, + attachment.sha256, + ) + try: + async with asyncio.timeout(settings.job_timeout_seconds): + with TemporaryDirectory(prefix="replay-source-") as directory: + await fetch_original(storage, work, Path(directory) / "original") + except ProcessingError as error: + raise JobOperationError(error.code) from None + except S3Error as error: + if error.code in {"NoSuchKey", "NoSuchObject"}: + raise JobOperationError("source_missing") from None + raise + + +async def replay_failed_job( + session, storage, settings, job_id, *, request_id, actor, reason +): + """Организовать replay; блокировка, rollback и commit остаются здесь.""" + validate_replay_request(actor, reason) + row = await jobs.lock_job(session, job_id) + if row is None: + raise JobOperationError("unknown_job") + record = await job_admin.replay_record(session, request_id) + if record is not None: + result = same_request(record, job_id, actor, reason) + await session.rollback() + return result + job, attachment = row + validate_replay_job(job, attachment) + # Блокировка сохраняется во время проверки S3, аудита и изменения job. + await verify_replay_source(storage, settings, job, attachment) + limit = job.attempt + settings.job_max_attempts + inserted = await job_admin.insert_replay( + session, + id=request_id, + job_id=job_id, + actor=actor, + reason=reason, + previous_attempt=job.attempt, + attempt_limit=limit, + previous_error_code=job.last_error_code, + ) + if not inserted: + result = same_request( + await job_admin.replay_record(session, request_id), job_id, actor, reason + ) + await session.rollback() + return result + job_admin.reset_failed(job, attachment, await jobs.database_time(session), limit) + await session.commit() + return { + "request_id": str(request_id), + "job_id": str(job_id), + "already_applied": False, + "status": "queued", + "attempt_limit": limit, + } diff --git a/app/domain/job_files.py b/app/domain/job_files.py new file mode 100644 index 0000000..b99bda6 --- /dev/null +++ b/app/domain/job_files.py @@ -0,0 +1,72 @@ +"""Получение исходника и запуск изолированного процесса обработки вариантов.""" + +import asyncio +import errno +import hashlib +from pathlib import Path +import sys + +from anyio import CancelScope + +from app.errors.exceptions import ProcessingError +from app.schemas.attachment import PipelineResult +from app.storage.jobs import JobWork +from app.storage.s3 import MinioStorage + + +async def fetch_original( + storage: MinioStorage, work: JobWork, destination: Path +) -> None: + if work.size_bytes > storage.settings.max_upload_bytes: + raise ProcessingError("image_limits") + checksum = hashlib.sha256() + size = 0 + stream = await storage.open_object(work.staging_key) + try: + with destination.open("wb") as target: + async for chunk in stream: + size += len(chunk) + if size > work.size_bytes: + raise ProcessingError("source_mismatch") + target.write(chunk) + checksum.update(chunk) + finally: + await stream.aclose() + if size != work.size_bytes or checksum.hexdigest() != work.sha256: + raise ProcessingError("source_mismatch") + + +async def render_variants( + storage: MinioStorage, work: JobWork, source: Path, directory: Path +) -> PipelineResult: + metadata = directory / "variants.json" + process = await asyncio.create_subprocess_exec( + sys.executable, + "-m", + "app.core.thumbnail_worker", + str(source), + str(directory), + str(metadata), + work.content_type, + str(storage.settings.max_image_pixels), + stdout=asyncio.subprocess.DEVNULL, + stderr=asyncio.subprocess.DEVNULL, + ) + try: + code = await process.wait() + finally: + if process.returncode is None: + process.kill() + with CancelScope(shield=True): + await process.wait() + if code == 2: + raise ProcessingError("invalid_image") + if code == 3 or code < 0: + raise ProcessingError("image_limits") + if code == 4: + raise OSError(errno.EIO, "Pipeline filesystem unavailable") + if code == 5: + raise ProcessingError("processing_configuration") + if code != 0: + raise RuntimeError("Image pipeline subprocess failed") + return PipelineResult.model_validate_json(metadata.read_text()) diff --git a/app/domain/job_retry.py b/app/domain/job_retry.py new file mode 100644 index 0000000..f6a6790 --- /dev/null +++ b/app/domain/job_retry.py @@ -0,0 +1,51 @@ +"""Ограниченный exponential backoff: jitter сохраняется вместе с новой попыткой.""" + +import errno +import random + +from minio.error import S3Error + +from app.core.jobs import JobSettings +from app.errors.exceptions import ProcessingError + + +def retry_delay(settings: JobSettings, cycle_attempt: int) -> float: + ceiling = min( + settings.job_retry_max_seconds, + settings.job_retry_seconds * 2 ** min(30, max(0, cycle_attempt - 1)), + ) + return random.uniform(ceiling / 2, ceiling) + + +def classify_failure(error: Exception) -> tuple[str, bool]: + if isinstance(error, ProcessingError): + return error.code, True + if isinstance(error, S3Error): + if error.code in {"NoSuchKey", "NoSuchObject"}: + return "source_missing", True + if error.code in { + "AccessDenied", + "InvalidAccessKeyId", + "SignatureDoesNotMatch", + "NoSuchBucket", + }: + return "storage_configuration", True + if error.code in { + "InternalError", + "SlowDown", + "ServiceUnavailable", + "RequestTimeout", + "Throttling", + }: + return "storage_unavailable", False + return "storage_rejected", True + if isinstance(error, TimeoutError): + return "processing_timeout", False + if isinstance(error, OSError) and error.errno in { + errno.EACCES, + errno.EPERM, + errno.EROFS, + errno.ENOENT, + }: + return "processing_configuration", True + return "processing_unavailable", False diff --git a/app/domain/messages.py b/app/domain/messages.py new file mode 100644 index 0000000..dae112b --- /dev/null +++ b/app/domain/messages.py @@ -0,0 +1,48 @@ +from uuid import UUID + +from sqlalchemy.ext.asyncio import AsyncSession + +from app.domain.chats import ensure_chat_member +from app.domain.pagination import ( + KIND_MESSAGES, + build_next_cursor, + decode_cursor, + split_page, +) +from app.schemas.message import Message, MessagePage +from app.schemas.user import User +from app.storage import messages as messages_storage +from app.storage import attachments as attachments_storage +from app.storage.types import Position + + +async def list_messages( + session: AsyncSession, + user: User, + chat_id: UUID, + cursor: str | None, + limit: int, +) -> MessagePage: + """Возвращает страницу истории чата по (created_at, id).""" + after: Position | None = None + if cursor is not None: + after = decode_cursor(cursor, KIND_MESSAGES, chat_id) + + await ensure_chat_member(session, user, chat_id) + + rows = await messages_storage.list_messages(session, chat_id, after, limit + 1) + page_rows, has_next = split_page(rows, limit) + links = await attachments_storage.message_attachment_ids( + session, [message.id for message in page_rows] + ) + items = [ + Message.model_validate(message).model_copy( + update={"attachment_ids": links[message.id]}, + ) + for message in page_rows + ] + page = MessagePage( + items=items, + next_cursor=build_next_cursor(KIND_MESSAGES, chat_id, items, has_next), + ) + return page diff --git a/app/domain/pagination.py b/app/domain/pagination.py new file mode 100644 index 0000000..9894437 --- /dev/null +++ b/app/domain/pagination.py @@ -0,0 +1,83 @@ +import base64 +import json +from collections.abc import Sequence +from datetime import datetime +from typing import Protocol, TypeVar +from uuid import UUID + +from app.errors.exceptions import invalid_request +from app.storage.types import Position + +KIND_CHATS = "chats" +KIND_MESSAGES = "messages" + +T = TypeVar("T") + + +class Positioned(Protocol): + """Объект с позицией в порядке (created_at, id).""" + + @property + def id(self) -> UUID: ... + + @property + def created_at(self) -> datetime: ... + + +def encode_cursor( + kind: str, + resource_id: UUID, + created_at: datetime, + item_id: UUID, +) -> str: + """Кодирует позицию и ресурс, к которому она привязана, в непрозрачный cursor.""" + payload = { + "kind": kind, + "resource_id": str(resource_id), + "created_at": created_at.isoformat(), + "item_id": str(item_id), + } + raw = json.dumps(payload).encode() + return base64.urlsafe_b64encode(raw).decode() + + +def decode_cursor(cursor: str, kind: str, resource_id: UUID) -> Position: + """Возвращает позицию из cursor; битый или чужой cursor даёт 400.""" + try: + payload = json.loads(base64.urlsafe_b64decode(cursor)) + cursor_kind = payload["kind"] + cursor_resource_id = UUID(payload["resource_id"]) + created_at = datetime.fromisoformat(payload["created_at"]) + item_id = UUID(payload["item_id"]) + except (ValueError, KeyError, TypeError, AttributeError): + raise invalid_request("Некорректный cursor") from None + + if ( + cursor_kind != kind + or cursor_resource_id != resource_id + or created_at.tzinfo is None + ): + raise invalid_request("Некорректный cursor") + + return created_at, item_id + + +def split_page(rows: list[T], limit: int) -> tuple[list[T], bool]: + """Отделяет страницу от лишней строки limit + 1, по которой видно продолжение.""" + has_next = len(rows) > limit + items = rows[:limit] + return items, has_next + + +def build_next_cursor( + kind: str, + resource_id: UUID, + items: Sequence[Positioned], + has_next: bool, +) -> str | None: + """Возвращает cursor на последний элемент страницы или None, если она последняя.""" + if not has_next: + return None + + last_item = items[-1] + return encode_cursor(kind, resource_id, last_item.created_at, last_item.id) diff --git a/app/domain/users.py b/app/domain/users.py new file mode 100644 index 0000000..461bf0d --- /dev/null +++ b/app/domain/users.py @@ -0,0 +1,41 @@ +from sqlalchemy.exc import IntegrityError +from sqlalchemy.ext.asyncio import AsyncSession + +from app.core import security +from app.errors.exceptions import conflict +from app.models.user import User as UserModel +from app.schemas.user import CreateUser, User +from app.storage import users as users_storage + +USERNAME_TAKEN_MESSAGE = "Имя пользователя уже занято" + + +def to_user_schema(user: UserModel) -> User: + """Преобразует ORM-модель в публичную схему без password_hash.""" + user_schema = User.model_validate(user) + return user_schema + + +async def register_user(session: AsyncSession, new_user: CreateUser) -> User: + """Регистрирует пользователя; занятый username даёт 409.""" + existing_user = await users_storage.get_user_by_username(session, new_user.username) + await session.commit() + if existing_user is not None: + raise conflict(USERNAME_TAKEN_MESSAGE) + + password_hash = await security.hash_password(new_user.password) + + try: + user = await users_storage.create_user( + session, + username=new_user.username, + display_name=new_user.display_name, + password_hash=password_hash, + ) + await session.commit() + except IntegrityError: + await session.rollback() + raise conflict(USERNAME_TAKEN_MESSAGE) from None + + created_user = to_user_schema(user) + return created_user diff --git a/app/endpoints/__init__.py b/app/endpoints/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/endpoints/attachments.py b/app/endpoints/attachments.py new file mode 100644 index 0000000..ddeddfa --- /dev/null +++ b/app/endpoints/attachments.py @@ -0,0 +1,74 @@ +"""HTTP-параметры и упаковка ответов; сценарии находятся в domain.""" + +from typing import Annotated +from urllib.parse import quote +from uuid import UUID + +from fastapi import APIRouter, Query, Request +from fastapi.responses import StreamingResponse +from starlette.background import BackgroundTask + +from app.domain import attachments +from app.endpoints.dependencies import CurrentUser, DbSession, S3Storage, UploadCapacity +from app.schemas.attachment import Attachment + +router = APIRouter(prefix="/api/v1", tags=["attachments"]) + + +@router.post("/chats/{chat_id}/attachments", status_code=202) +async def upload( + request: Request, + chat_id: UUID, + user: CurrentUser, + session: DbSession, + storage: S3Storage, + capacity: UploadCapacity, + filename: Annotated[str, Query(min_length=1, max_length=255)], +) -> Attachment: + return await attachments.receive_attachment( + session, + storage, + user, + chat_id, + capacity=capacity, + filename=filename, + content_type=request.headers.get("content-type", "").lower(), + declared_length=request.headers.get("content-length"), + chunks=request.stream(), + ) + + +@router.get("/attachments/{attachment_id}") +async def metadata( + attachment_id: UUID, user: CurrentUser, session: DbSession +) -> Attachment: + return await attachments.get_attachment(session, user, attachment_id) + + +@router.get("/attachments/{attachment_id}/content") +async def content( + attachment_id: UUID, + user: CurrentUser, + session: DbSession, + storage: S3Storage, + variant: Annotated[str, Query()] = "original", +) -> StreamingResponse: + record, stream = await attachments.download_attachment( + session, + storage, + user, + attachment_id, + variant=variant, + ) + return StreamingResponse( + stream, + media_type=record.content_type, + headers={ + "Content-Length": str(record.size_bytes), + "Content-Disposition": "attachment; filename*=UTF-8''" + + quote(record.filename, safe=""), + "X-Content-Type-Options": "nosniff", + "Cache-Control": "private, no-store", + }, + background=BackgroundTask(stream.aclose), + ) diff --git a/app/endpoints/auth.py b/app/endpoints/auth.py new file mode 100644 index 0000000..69f4535 --- /dev/null +++ b/app/endpoints/auth.py @@ -0,0 +1,32 @@ +from fastapi import APIRouter, Response + +from app.domain.auth import create_session, revoke_session +from app.endpoints.dependencies import ( + AppSettings, + BasicCredentials, + BearerToken, + DbSession, + RedisClient, +) +from app.schemas.session import AuthSession + +router = APIRouter(prefix="/api/v1/auth", tags=["auth"]) + + +@router.post("/sessions", status_code=201) +async def login( + credentials: BasicCredentials, + session: DbSession, + redis: RedisClient, + settings: AppSettings, +) -> AuthSession: + username, password = credentials + return await create_session( + session, redis, username, password, settings.session_ttl_seconds + ) + + +@router.delete("/sessions/current", status_code=204) +async def logout(token: BearerToken, redis: RedisClient) -> Response: + await revoke_session(redis, token) + return Response(status_code=204) diff --git a/app/endpoints/chats.py b/app/endpoints/chats.py new file mode 100644 index 0000000..91f2b21 --- /dev/null +++ b/app/endpoints/chats.py @@ -0,0 +1,32 @@ +from typing import Annotated +from uuid import UUID + +from fastapi import APIRouter, Query + +from app.domain.chats import create_chat, get_chat, list_chats +from app.endpoints.dependencies import CurrentUser, DbSession +from app.schemas.chat import Chat, ChatPage, CreateChat + +router = APIRouter(prefix="/api/v1/chats", tags=["chats"]) + + +@router.post("", status_code=201) +async def create_new_chat( + new_chat: CreateChat, creator: CurrentUser, session: DbSession +) -> Chat: + return await create_chat(session, creator, new_chat) + + +@router.get("") +async def list_user_chats( + user: CurrentUser, + session: DbSession, + limit: Annotated[int, Query(ge=1, le=100)] = 50, + cursor: Annotated[str | None, Query(min_length=1)] = None, +) -> ChatPage: + return await list_chats(session, user, cursor, limit) + + +@router.get("/{chat_id}") +async def get_chat_by_id(chat_id: UUID, user: CurrentUser, session: DbSession) -> Chat: + return await get_chat(session, user, chat_id) diff --git a/app/endpoints/dependencies.py b/app/endpoints/dependencies.py new file mode 100644 index 0000000..39ffdf2 --- /dev/null +++ b/app/endpoints/dependencies.py @@ -0,0 +1,112 @@ +import base64 +import binascii +from collections.abc import AsyncIterator +from typing import Annotated + +from fastapi import Depends, Request, Security +from fastapi.openapi.models import HTTPBase, HTTPBearer +from fastapi.security.base import SecurityBase +from redis.asyncio import Redis +from sqlalchemy.ext.asyncio import AsyncSession + +from app.core.config import Settings +from app.core.request_capacity import RequestCapacity +from app.domain.auth import authenticate_token +from app.errors.exceptions import unauthorized_basic, unauthorized_bearer +from app.schemas.user import User +from app.storage.s3 import MinioStorage + + +async def get_settings(request: Request) -> Settings: + settings: Settings = request.app.state.settings + return settings + + +async def get_db(request: Request) -> AsyncIterator[AsyncSession]: + """Одна AsyncSession на HTTP-запрос; незакоммиченная транзакция откатывается.""" + session_factory = request.app.state.session_factory + async with session_factory() as session: + yield session + + +async def get_redis(request: Request) -> Redis: + redis: Redis = request.app.state.redis + return redis + + +def get_s3(request: Request) -> MinioStorage | None: + return request.app.state.s3 + + +def get_upload_capacity(request: Request) -> RequestCapacity: + return request.app.state.upload_capacity + + +class AuthorizationHeader(SecurityBase): + """Отдаёт сырой заголовок Authorization и описывает схему для OpenAPI.""" + + def __init__(self, model: HTTPBase, scheme_name: str) -> None: + self.model = model + self.scheme_name = scheme_name + + async def __call__(self, request: Request) -> str | None: + return request.headers.get("Authorization") + + +basic_auth = AuthorizationHeader(HTTPBase(scheme="basic"), "BasicAuth") +bearer_auth = AuthorizationHeader(HTTPBearer(), "BearerAuth") + + +def _split_authorization(authorization: str | None) -> tuple[str, str] | None: + if authorization is None: + return None + scheme, _, value = authorization.partition(" ") + if not value.strip(): + return None + return scheme.lower(), value.strip() + + +async def get_bearer_token( + authorization: Annotated[str | None, Security(bearer_auth)], +) -> str: + parts = _split_authorization(authorization) + if parts is None or parts[0] != "bearer": + raise unauthorized_bearer() + return parts[1] + + +async def get_basic_credentials( + authorization: Annotated[str | None, Security(basic_auth)], +) -> tuple[str, str]: + """(username, password) из `Authorization: Basic`; пароль может содержать ':'.""" + parts = _split_authorization(authorization) + if parts is None or parts[0] != "basic": + raise unauthorized_basic() + + try: + decoded = base64.b64decode(parts[1], validate=True).decode("utf-8") + except (binascii.Error, UnicodeDecodeError, ValueError): + raise unauthorized_basic() from None + + username, separator, password = decoded.partition(":") + if not separator or not username: + raise unauthorized_basic() + return username, password + + +DbSession = Annotated[AsyncSession, Depends(get_db)] +RedisClient = Annotated[Redis, Depends(get_redis)] +AppSettings = Annotated[Settings, Depends(get_settings)] +S3Storage = Annotated[MinioStorage | None, Depends(get_s3)] +UploadCapacity = Annotated[RequestCapacity, Depends(get_upload_capacity)] +BearerToken = Annotated[str, Depends(get_bearer_token)] +BasicCredentials = Annotated[tuple[str, str], Depends(get_basic_credentials)] + + +async def get_current_user( + token: BearerToken, session: DbSession, redis: RedisClient +) -> User: + return await authenticate_token(session, redis, token) + + +CurrentUser = Annotated[User, Depends(get_current_user)] diff --git a/app/endpoints/health.py b/app/endpoints/health.py new file mode 100644 index 0000000..2be984b --- /dev/null +++ b/app/endpoints/health.py @@ -0,0 +1,23 @@ +from fastapi import APIRouter, Request + +from app.domain import health +from app.schemas.base import Health + +router = APIRouter(prefix="/health", tags=["health"]) + + +@router.get("/live") +async def liveness() -> Health: + return health.liveness() + + +@router.get("/ready") +async def readiness(request: Request) -> Health: + state = request.app.state + return await health.readiness( + state.engine, + state.redis, + state.s3, + state.lifecycle, + state.settings.readiness_timeout_seconds, + ) diff --git a/app/endpoints/messages.py b/app/endpoints/messages.py new file mode 100644 index 0000000..4bfbd3f --- /dev/null +++ b/app/endpoints/messages.py @@ -0,0 +1,42 @@ +from typing import Annotated +from uuid import UUID + +from fastapi import APIRouter, Header, Query + +from app.domain.idempotency import send_message_idempotent, validate_idempotency_key +from app.domain.messages import list_messages +from app.endpoints.dependencies import AppSettings, CurrentUser, DbSession +from app.schemas.message import CreateMessage, Message, MessagePage + +router = APIRouter(prefix="/api/v1/chats", tags=["messages"]) + + +@router.post("/{chat_id}/messages", status_code=201) +async def send_new_message( + chat_id: UUID, + new_message: CreateMessage, + sender: CurrentUser, + session: DbSession, + settings: AppSettings, + idempotency_key: Annotated[str | None, Header(alias="Idempotency-Key")] = None, +) -> Message: + return await send_message_idempotent( + session, + sender, + chat_id, + new_message, + validate_idempotency_key(idempotency_key), + settings.max_messages, + settings.idempotency_ttl_seconds, + ) + + +@router.get("/{chat_id}/messages") +async def get_history_messages( + chat_id: UUID, + user: CurrentUser, + session: DbSession, + limit: Annotated[int, Query(ge=1, le=100)] = 50, + cursor: Annotated[str | None, Query(min_length=1)] = None, +) -> MessagePage: + return await list_messages(session, user, chat_id, cursor, limit) diff --git a/app/endpoints/users.py b/app/endpoints/users.py new file mode 100644 index 0000000..c502d01 --- /dev/null +++ b/app/endpoints/users.py @@ -0,0 +1,17 @@ +from fastapi import APIRouter + +from app.domain.users import register_user +from app.endpoints.dependencies import CurrentUser, DbSession +from app.schemas.user import CreateUser, User + +router = APIRouter(prefix="/api/v1/users", tags=["users"]) + + +@router.post("", status_code=201) +async def create_user(new_user: CreateUser, session: DbSession) -> User: + return await register_user(session, new_user) + + +@router.get("/me") +async def get_me(user: CurrentUser) -> User: + return user diff --git a/app/errors/__init__.py b/app/errors/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/errors/exceptions.py b/app/errors/exceptions.py new file mode 100644 index 0000000..72cc078 --- /dev/null +++ b/app/errors/exceptions.py @@ -0,0 +1,145 @@ +import errno + +from collections.abc import Mapping + +from PIL import Image, UnidentifiedImageError + +BASIC_CHALLENGE = 'Basic realm="messenger", charset="UTF-8"' +BEARER_CHALLENGE = 'Bearer realm="messenger"' + + +class ApiError(Exception): + def __init__( + self, + status_code: int, + code: str, + message: str, + headers: Mapping[str, str] | None = None, + ) -> None: + super().__init__(message) + self.status_code = status_code + self.code = code + self.message = message + self.headers = headers + + +def invalid_request(message: str = "Неверный запрос") -> ApiError: + """Создаёт ошибку некорректного или недопустимого запроса.""" + return ApiError(400, "invalid_request", message) + + +def unauthorized( + message: str = "Нет действительной аутентификации", + www_authenticate: str | None = None, +) -> ApiError: + """Создаёт ошибку отсутствующей или недействительной аутентификации.""" + headers = {"WWW-Authenticate": www_authenticate} if www_authenticate else None + return ApiError(401, "unauthorized", message, headers) + + +def unauthorized_basic(message: str = "Неверные учётные данные") -> ApiError: + """401 для POST /auth/sessions (одинаковый для неверного username и пароля).""" + return unauthorized(message, BASIC_CHALLENGE) + + +def unauthorized_bearer(message: str = "Нет действительной сессии") -> ApiError: + """401 для бизнес-endpoint: нет, истёк, отозван или неизвестен токен.""" + return unauthorized(message, BEARER_CHALLENGE) + + +def not_found(message: str = "Объект не найден") -> ApiError: + """Создаёт ошибку, указывающую на отсутствие запрошенного ресурса.""" + return ApiError(404, "not_found", message) + + +def conflict(message: str = "Конфликт") -> ApiError: + """Создаёт ошибку конфликта с текущим состоянием ресурса.""" + return ApiError(409, "conflict", message) + + +def payload_too_large(message: str = "Слишком большое тело запроса") -> ApiError: + """Создаёт ошибку, указывающую на превышение допустимого размера запроса.""" + return ApiError(413, "payload_too_large", message) + + +def unsupported_media_type( + message: str = "Требуется Content-Type: application/json", +) -> ApiError: + """Создаёт ошибку неподдерживаемого формата или типа содержимого запроса.""" + return ApiError(415, "unsupported_media_type", message) + + +def rate_limited(retry_after: int = 1) -> ApiError: + """Создаёт ошибку превышения допустимой частоты запросов.""" + return ApiError( + 429, + "rate_limited", + "Слишком много запросов", + {"Retry-After": str(max(1, retry_after))}, + ) + + +def unavailable(message: str = "Сервис временно недоступен") -> ApiError: + """Создаёт ошибку временной недоступности сервиса.""" + return ApiError(503, "unavailable", message) + + +def internal_error() -> ApiError: + """Создаёт ошибку внутренней ошибки сервера.""" + return ApiError(500, "internal_error", "Внутренняя ошибка сервера") + + +IMAGE_WORKER_ERRORS = ( + ApiError, + Image.DecompressionBombError, + Image.DecompressionBombWarning, + MemoryError, + UnidentifiedImageError, + OSError, + ValueError, + SyntaxError, +) + + +def image_worker_error_code(error: Exception) -> int: + code = 2 + resource_error = isinstance( + error, + (Image.DecompressionBombError, Image.DecompressionBombWarning, MemoryError), + ) + declared_limit = isinstance(error, ApiError) and error.status_code == 413 + if resource_error or declared_limit: + code = 3 + return code + + +def image_validation_error(code: int) -> ApiError: + error = unsupported_media_type("Повреждённое изображение или несовпадение MIME") + if code == 3 or code < 0: + error = payload_too_large("Превышен лимит пикселей или ресурсов изображения") + return error + + +class ProcessingError(Exception): + """Постоянная ошибка pipeline с безопасным машинным кодом.""" + + def __init__(self, code: str) -> None: + super().__init__(code) + self.code = code + + +class JobOperationError(Exception): + """Безопасный код отказа операторской команды.""" + + def __init__(self, code: str): + self.code = code + super().__init__(code) + + +def pipeline_worker_error_code(error: Exception) -> int: + """Отделить ошибки файловой системы от ошибки декодирования изображения.""" + if isinstance(error, OSError) and error.errno is not None: + if error.errno in {errno.EACCES, errno.EPERM, errno.EROFS, errno.ENOENT}: + return 5 + return 4 + return image_worker_error_code(error) diff --git a/app/errors/handlers.py b/app/errors/handlers.py new file mode 100644 index 0000000..faa8267 --- /dev/null +++ b/app/errors/handlers.py @@ -0,0 +1,238 @@ +import asyncio +import logging +from contextlib import asynccontextmanager +from collections.abc import Mapping +from uuid import uuid4 + +from fastapi import FastAPI, Request +from fastapi.exceptions import RequestValidationError +from fastapi.responses import JSONResponse +from minio.error import MinioException +from redis.exceptions import ConnectionError as RedisConnectionError +from redis.exceptions import TimeoutError as RedisTimeoutError +from sqlalchemy.exc import DBAPIError, InterfaceError, OperationalError, SQLAlchemyError +from sqlalchemy.exc import TimeoutError as PoolTimeoutError +from starlette.exceptions import HTTPException as StarletteHTTPException +from starlette.requests import ClientDisconnect +from urllib3.exceptions import HTTPError as StorageHTTPError + +from app.core.instance import INSTANCE_ID_HEADER +from app.core.request_id import REQUEST_ID_HEADER +from app.errors.exceptions import ( + ApiError, + internal_error, + invalid_request, + not_found, + unavailable, +) + +logger = logging.getLogger(__name__) + +TRANSIENT_SQLSTATE_CLASSES = ("08", "40", "53", "57") +TRANSIENT_SQLSTATES = frozenset({"55P03"}) +RECOVERABLE_STORAGE_ERRORS = ( + ApiError, + SQLAlchemyError, + MinioException, + StorageHTTPError, + OSError, + TimeoutError, +) + + +@asynccontextmanager +async def operation_timeout(seconds: float, error: ApiError): + """Единое преобразование таймаутов; владелец операции задаёт ожидаемую ошибку.""" + try: + async with asyncio.timeout(seconds): + yield + except TimeoutError: + raise error from None + + +async def client_disconnect_handler(request: Request, exc: Exception) -> JSONResponse: + return await api_error_handler( + request, invalid_request("Загрузка прервана клиентом") + ) + + +def log_recoverable_error(operation: str, error: Exception) -> None: + """Согласованный безопасный лог восстановления без содержимого SDK-ошибки.""" + logger.warning("%s deferred: %s", operation, type(error).__name__) + + +def _get_request_id(request: Request) -> str: + request_id = getattr(request.state, "request_id", None) + + if request_id is None: + request_id = str(uuid4()) + request.state.request_id = request_id + + return request_id + + +def _build_response( + request: Request, + status_code: int, + code: str, + message: str, + headers: Mapping[str, str] | None = None, +) -> JSONResponse: + request_id = _get_request_id(request) + + response_headers = { + **(headers or {}), + REQUEST_ID_HEADER: request_id, + } + instance_id = getattr(request.app.state, "instance_id", None) + if instance_id is not None: + response_headers[INSTANCE_ID_HEADER] = instance_id + + body = { + "error": { + "code": code, + "message": message, + "request_id": request_id, + } + } + + return JSONResponse( + status_code=status_code, + content=body, + headers=response_headers, + ) + + +async def api_error_handler( + request: Request, + exc: Exception, +) -> JSONResponse: + assert isinstance(exc, ApiError) + + return _build_response( + request, + exc.status_code, + exc.code, + exc.message, + exc.headers, + ) + + +async def routing_error_handler( + request: Request, + exc: Exception, +) -> JSONResponse: + assert isinstance(exc, StarletteHTTPException) + + error = invalid_request() + if exc.status_code == 404: + error = not_found() + return _build_response( + request, + exc.status_code, + error.code, + error.message, + exc.headers, + ) + + +async def validation_error_handler( + request: Request, + exc: Exception, +) -> JSONResponse: + assert isinstance(exc, RequestValidationError) + + fields = sorted({".".join(map(str, error["loc"])) for error in exc.errors()}) + message = "Неверный запрос" + + if fields: + message = f"{message}: {', '.join(fields)}" + + return _build_response( + request, + 400, + "invalid_request", + message, + ) + + +async def dependency_unavailable_handler( + request: Request, + exc: Exception, +) -> JSONResponse: + """PostgreSQL/Redis/S3 недоступны либо исчерпан пул: 503 без внутренних деталей.""" + request_id = _get_request_id(request) + logger.error( + "Dependency unavailable request_id=%s: %s", + request_id, + type(exc).__name__, + ) + + error = unavailable() + return _build_response( + request, + error.status_code, + error.code, + error.message, + {"Retry-After": "1"}, + ) + + +def _is_transient_database_error(exc: DBAPIError) -> bool: + sqlstate = getattr(exc.orig, "sqlstate", None) or "" + return ( + sqlstate.startswith(TRANSIENT_SQLSTATE_CLASSES) + or sqlstate in TRANSIENT_SQLSTATES + ) + + +async def database_error_handler( + request: Request, + exc: Exception, +) -> JSONResponse: + """Временные ошибки PostgreSQL (таймаут запроса, блокировки, нехватка ресурсов) — 503.""" + assert isinstance(exc, DBAPIError) + + handler = unhandled_error_handler + if _is_transient_database_error(exc): + handler = dependency_unavailable_handler + return await handler(request, exc) + + +async def unhandled_error_handler( + request: Request, + exc: Exception, +) -> JSONResponse: + request_id = _get_request_id(request) + + logger.error( + "Unhandled error request_id=%s", + request_id, + exc_info=exc, + ) + + error = internal_error() + + return _build_response( + request, + error.status_code, + error.code, + error.message, + ) + + +def register_exception_handlers(app: FastAPI) -> None: + app.add_exception_handler(ApiError, api_error_handler) + app.add_exception_handler(ClientDisconnect, client_disconnect_handler) + app.add_exception_handler(MinioException, dependency_unavailable_handler) + app.add_exception_handler(StorageHTTPError, dependency_unavailable_handler) + app.add_exception_handler(StarletteHTTPException, routing_error_handler) + app.add_exception_handler(RequestValidationError, validation_error_handler) + app.add_exception_handler(OperationalError, dependency_unavailable_handler) + app.add_exception_handler(InterfaceError, dependency_unavailable_handler) + app.add_exception_handler(PoolTimeoutError, dependency_unavailable_handler) + app.add_exception_handler(DBAPIError, database_error_handler) + app.add_exception_handler(RedisConnectionError, dependency_unavailable_handler) + app.add_exception_handler(RedisTimeoutError, dependency_unavailable_handler) + app.add_exception_handler(OSError, dependency_unavailable_handler) + app.add_exception_handler(Exception, unhandled_error_handler) diff --git a/app/main.py b/app/main.py new file mode 100644 index 0000000..f68247b --- /dev/null +++ b/app/main.py @@ -0,0 +1,94 @@ +import logging +from collections.abc import AsyncGenerator +from contextlib import asynccontextmanager + +import uvicorn +from fastapi import Depends, FastAPI + +from app.core.config import Settings +from app.core.database import create_db_engine, create_session_factory +from app.core.instance import InstanceIdMiddleware, resolve_instance_id +from app.core.lifecycle import GracefulServer, Lifecycle +from app.core.redis import create_redis_client +from app.core.request_capacity import acquire_request_slot, create_request_capacity +from app.core.request_id import RequestIdMiddleware +from app.endpoints.auth import router as auth_router +from app.endpoints.attachments import router as attachments_router +from app.endpoints.chats import router as chats_router +from app.endpoints.health import router as health_router +from app.endpoints.messages import router as messages_router +from app.endpoints.users import router as users_router +from app.errors.handlers import register_exception_handlers +from app.storage.s3 import create_s3_storage + + +def configure_logging(settings: Settings) -> None: + logging.basicConfig( + level=settings.log_level, + format="%(asctime)s %(levelname)s %(name)s %(message)s", + ) + + +def create_app(settings: Settings | None = None) -> FastAPI: + settings = settings or Settings() # type: ignore + configure_logging(settings) + + engine = create_db_engine(settings) + redis = create_redis_client(settings) + s3 = create_s3_storage(settings.s3) if settings.s3_enabled else None + + @asynccontextmanager + async def lifespan(_: FastAPI) -> AsyncGenerator[None]: + yield + if s3 is not None: + await s3.aclose() + await redis.aclose() + await engine.dispose() + + application = FastAPI(title="Messenger", version="1.5.0", lifespan=lifespan) + + application.state.settings = settings + application.state.engine = engine + application.state.session_factory = create_session_factory(engine) + application.state.redis = redis + application.state.s3 = s3 + application.state.upload_capacity = create_request_capacity( + settings.s3.max_concurrent_uploads + ) + application.state.request_capacity = create_request_capacity(settings.max_in_flight) + application.state.instance_id = resolve_instance_id(settings.instance_id) + application.state.lifecycle = Lifecycle() + application.add_middleware(RequestIdMiddleware) + application.add_middleware( + InstanceIdMiddleware, instance_id=application.state.instance_id + ) + register_exception_handlers(application) + + limited = [Depends(acquire_request_slot)] + application.include_router(health_router) + application.include_router(users_router, dependencies=limited) + application.include_router(auth_router, dependencies=limited) + application.include_router(chats_router, dependencies=limited) + application.include_router(messages_router, dependencies=limited) + application.include_router(attachments_router, dependencies=limited) + + return application + + +def main() -> None: + settings = Settings() # type: ignore + application = create_app(settings) + config = uvicorn.Config( + application, + host=settings.app_host, + port=settings.app_port, + log_level=settings.log_level.lower(), + timeout_graceful_shutdown=settings.graceful_shutdown_timeout_seconds, + ) + GracefulServer( + config, application.state.lifecycle, settings.shutdown_drain_seconds + ).run() + + +if __name__ == "__main__": + main() diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 0000000..d9476c4 --- /dev/null +++ b/app/models/__init__.py @@ -0,0 +1,25 @@ +from app.models.job_replay import JobReplay +from app.models.base import Base +from app.models.job import AttachmentJob +from app.models.attachment import Attachment, MessageAttachment, UploadIntent +from app.models.chat import Chat +from app.models.chat_member import ChatMember +from app.models.counter import Counter +from app.models.idempotency_key import IdempotencyKey +from app.models.message import Message +from app.models.user import User + +__all__ = [ + "JobReplay", + "AttachmentJob", + "Base", + "Attachment", + "MessageAttachment", + "UploadIntent", + "Chat", + "ChatMember", + "Counter", + "IdempotencyKey", + "Message", + "User", +] diff --git a/app/models/attachment.py b/app/models/attachment.py new file mode 100644 index 0000000..3afebe0 --- /dev/null +++ b/app/models/attachment.py @@ -0,0 +1,71 @@ +"""Метаданные оригиналов и журнал операций до записи в S3.""" + +import uuid +from datetime import datetime + +from sqlalchemy import CheckConstraint, ForeignKey, Index, String, func, text +from sqlalchemy.dialects.postgresql import JSONB +from sqlalchemy.orm import Mapped, mapped_column + +from app.models.base import Base + + +class Attachment(Base): + __tablename__ = "attachments" + __table_args__ = ( + CheckConstraint("size_bytes BETWEEN 1 AND 10485760", name="size_bytes"), + CheckConstraint( + "content_type IN ('image/png', 'image/jpeg')", name="content_type" + ), + CheckConstraint("sha256 ~ '^[a-f0-9]{64}$'", name="sha256"), + CheckConstraint( + "status IN ('queued', 'processing', 'ready', 'failed')", name="status" + ), + CheckConstraint( + "(status = 'failed' AND error_code IS NOT NULL) OR (status <> 'failed' AND error_code IS NULL)", + name="error_code", + ), + Index("ix_attachments_chat_id", "chat_id"), + ) + + id: Mapped[uuid.UUID] = mapped_column(primary_key=True, default=uuid.uuid4) + chat_id: Mapped[uuid.UUID] = mapped_column(ForeignKey("chats.id")) + owner_id: Mapped[uuid.UUID] = mapped_column(ForeignKey("users.id")) + object_key: Mapped[str] = mapped_column(String(128), unique=True) + filename: Mapped[str] = mapped_column(String(255)) + content_type: Mapped[str] = mapped_column(String(32)) + size_bytes: Mapped[int] + sha256: Mapped[str] = mapped_column(String(64)) + status: Mapped[str] = mapped_column(String(16), server_default="queued") + error_code: Mapped[str | None] = mapped_column(String(64)) + thumbnail_key: Mapped[str | None] = mapped_column(String(128)) + crop_key: Mapped[str | None] = mapped_column(String(128)) + optimized_key: Mapped[str | None] = mapped_column(String(128)) + variants: Mapped[list[dict]] = mapped_column( + JSONB, default=list, server_default=text("'[]'::jsonb") + ) + created_at: Mapped[datetime] = mapped_column(server_default=func.clock_timestamp()) + updated_at: Mapped[datetime] = mapped_column(server_default=func.clock_timestamp()) + + +class MessageAttachment(Base): + __tablename__ = "message_attachments" + + message_id: Mapped[uuid.UUID] = mapped_column( + ForeignKey("messages.id", ondelete="CASCADE"), primary_key=True + ) + attachment_id: Mapped[uuid.UUID] = mapped_column( + ForeignKey("attachments.id"), primary_key=True + ) + position: Mapped[int] + + +class UploadIntent(Base): + """Фиксируется до PUT; удаляется атомарно с принятием queued metadata/job.""" + + __tablename__ = "upload_intents" + __table_args__ = (Index("ix_upload_intents_created_at", "created_at"),) + + id: Mapped[uuid.UUID] = mapped_column(primary_key=True) + object_key: Mapped[str] = mapped_column(String(128), unique=True) + created_at: Mapped[datetime] = mapped_column(server_default=func.clock_timestamp()) diff --git a/app/models/base.py b/app/models/base.py new file mode 100644 index 0000000..15a748e --- /dev/null +++ b/app/models/base.py @@ -0,0 +1,27 @@ +import uuid +from datetime import datetime +from typing import Any, ClassVar + +from sqlalchemy import DateTime, MetaData +from sqlalchemy.dialects.postgresql import UUID as PG_UUID +from sqlalchemy.orm import DeclarativeBase +from sqlalchemy.types import TypeEngine + +NAMING_CONVENTION = { + "ix": "ix_%(column_0_label)s", + "uq": "uq_%(table_name)s_%(column_0_name)s", + "ck": "ck_%(table_name)s_%(constraint_name)s", + "fk": "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s", + "pk": "pk_%(table_name)s", +} + + +class Base(DeclarativeBase): + """Базовый класс ORM-моделей.""" + + metadata = MetaData(naming_convention=NAMING_CONVENTION) + + type_annotation_map: ClassVar[dict[Any, TypeEngine[Any]]] = { + uuid.UUID: PG_UUID(as_uuid=True), + datetime: DateTime(timezone=True), + } diff --git a/app/models/chat.py b/app/models/chat.py new file mode 100644 index 0000000..ffff7ec --- /dev/null +++ b/app/models/chat.py @@ -0,0 +1,32 @@ +import uuid +from datetime import datetime +from typing import TYPE_CHECKING + +from sqlalchemy import String, func +from sqlalchemy.orm import Mapped, mapped_column, relationship + +from app.models.base import Base + +if TYPE_CHECKING: + from app.models.chat_member import ChatMember + from app.models.message import Message + + +class Chat(Base): + """Чат с фиксированным составом участников.""" + + __tablename__ = "chats" + + id: Mapped[uuid.UUID] = mapped_column(primary_key=True, default=uuid.uuid4) + title: Mapped[str] = mapped_column(String(100)) + created_at: Mapped[datetime] = mapped_column(server_default=func.now()) + + members: Mapped[list["ChatMember"]] = relationship( + back_populates="chat", + cascade="all, delete-orphan", + passive_deletes=True, + lazy="selectin", + ) + messages: Mapped[list["Message"]] = relationship( + back_populates="chat", lazy="raise" + ) diff --git a/app/models/chat_member.py b/app/models/chat_member.py new file mode 100644 index 0000000..567ffd6 --- /dev/null +++ b/app/models/chat_member.py @@ -0,0 +1,26 @@ +import uuid +from typing import TYPE_CHECKING + +from sqlalchemy import ForeignKey, Index +from sqlalchemy.orm import Mapped, mapped_column, relationship + +from app.models.base import Base + +if TYPE_CHECKING: + from app.models.chat import Chat + from app.models.user import User + + +class ChatMember(Base): + """Членство пользователя в чате.""" + + __tablename__ = "chat_members" + __table_args__ = (Index("ix_chat_members_user_id_chat_id", "user_id", "chat_id"),) + + chat_id: Mapped[uuid.UUID] = mapped_column( + ForeignKey("chats.id", ondelete="CASCADE"), primary_key=True + ) + user_id: Mapped[uuid.UUID] = mapped_column(ForeignKey("users.id"), primary_key=True) + + chat: Mapped["Chat"] = relationship(back_populates="members", lazy="raise") + user: Mapped["User"] = relationship(back_populates="memberships", lazy="raise") diff --git a/app/models/counter.py b/app/models/counter.py new file mode 100644 index 0000000..5f6706b --- /dev/null +++ b/app/models/counter.py @@ -0,0 +1,13 @@ +from sqlalchemy import BigInteger, String +from sqlalchemy.orm import Mapped, mapped_column + +from app.models.base import Base + + +class Counter(Base): + """Именованный счётчик с атомарным обновлением.""" + + __tablename__ = "counters" + + name: Mapped[str] = mapped_column(String(64), primary_key=True) + value: Mapped[int] = mapped_column(BigInteger) diff --git a/app/models/idempotency_key.py b/app/models/idempotency_key.py new file mode 100644 index 0000000..5b1d355 --- /dev/null +++ b/app/models/idempotency_key.py @@ -0,0 +1,24 @@ +"""Сохранённый результат отправки сообщения.""" + +import uuid +from datetime import datetime + +from sqlalchemy import ForeignKey, Index, String, func +from sqlalchemy.orm import Mapped, mapped_column + +from app.models.base import Base + + +class IdempotencyKey(Base): + """Ключ запроса и связанное сообщение.""" + + __tablename__ = "idempotency_keys" + __table_args__ = (Index("ix_idempotency_keys_created_at", "created_at"),) + + user_id: Mapped[uuid.UUID] = mapped_column(ForeignKey("users.id"), primary_key=True) + method: Mapped[str] = mapped_column(String(8), primary_key=True) + path: Mapped[str] = mapped_column(String(255), primary_key=True) + key: Mapped[str] = mapped_column(String(128), primary_key=True) + request_hash: Mapped[str] = mapped_column(String(64)) + message_id: Mapped[uuid.UUID] = mapped_column(ForeignKey("messages.id")) + created_at: Mapped[datetime] = mapped_column(server_default=func.clock_timestamp()) diff --git a/app/models/job.py b/app/models/job.py new file mode 100644 index 0000000..01924ee --- /dev/null +++ b/app/models/job.py @@ -0,0 +1,40 @@ +"""Устойчивая работа и намерение публикации; один pipeline на вложение.""" + +from datetime import datetime +from uuid import UUID, uuid4 + +from sqlalchemy import CheckConstraint, ForeignKey, Index, String, func +from sqlalchemy.orm import Mapped, mapped_column + +from app.models.base import Base + + +class AttachmentJob(Base): + __tablename__ = "attachment_jobs" + __table_args__ = ( + CheckConstraint("pipeline_version = 1", name="pipeline_version"), + CheckConstraint("attempt >= 0 AND published_attempt >= 0", name="attempt"), + Index("ix_attachment_jobs_due", "next_attempt_at"), + Index("ix_attachment_jobs_lease", "lease_until"), + ) + + id: Mapped[UUID] = mapped_column(primary_key=True, default=uuid4) + attachment_id: Mapped[UUID] = mapped_column( + ForeignKey("attachments.id"), + unique=True, + ) + staging_key: Mapped[str | None] = mapped_column(String(128)) + pipeline_version: Mapped[int] = mapped_column(server_default="1") + attempt: Mapped[int] = mapped_column(server_default="0") + cycle_start_attempt: Mapped[int] = mapped_column(server_default="0") + attempt_limit: Mapped[int | None] + last_error_permanent: Mapped[bool | None] + published_attempt: Mapped[int] = mapped_column(server_default="0") + next_attempt_at: Mapped[datetime] = mapped_column( + server_default=func.clock_timestamp() + ) + lease_token: Mapped[UUID | None] + lease_until: Mapped[datetime | None] + last_error_code: Mapped[str | None] = mapped_column(String(64)) + finished_at: Mapped[datetime | None] + created_at: Mapped[datetime] = mapped_column(server_default=func.clock_timestamp()) diff --git a/app/models/job_replay.py b/app/models/job_replay.py new file mode 100644 index 0000000..7f2b27a --- /dev/null +++ b/app/models/job_replay.py @@ -0,0 +1,22 @@ +"""Аудит явного повторного запуска failed; request id обеспечивает идемпотентность.""" + +from datetime import datetime +from uuid import UUID + +from sqlalchemy import ForeignKey, String, func +from sqlalchemy.orm import Mapped, mapped_column + +from app.models.base import Base + + +class JobReplay(Base): + __tablename__ = "job_replays" + + id: Mapped[UUID] = mapped_column(primary_key=True) + job_id: Mapped[UUID] = mapped_column(ForeignKey("attachment_jobs.id"), index=True) + actor: Mapped[str] = mapped_column(String(64)) + reason: Mapped[str] = mapped_column(String(32)) + previous_attempt: Mapped[int] + attempt_limit: Mapped[int] + previous_error_code: Mapped[str | None] = mapped_column(String(64)) + created_at: Mapped[datetime] = mapped_column(server_default=func.clock_timestamp()) diff --git a/app/models/message.py b/app/models/message.py new file mode 100644 index 0000000..25dc8cf --- /dev/null +++ b/app/models/message.py @@ -0,0 +1,30 @@ +import uuid +from datetime import datetime +from typing import TYPE_CHECKING + +from sqlalchemy import ForeignKey, Index, Text, func +from sqlalchemy.orm import Mapped, mapped_column, relationship + +from app.models.base import Base + +if TYPE_CHECKING: + from app.models.chat import Chat + from app.models.user import User + + +class Message(Base): + """Сообщение в чате.""" + + __tablename__ = "messages" + __table_args__ = ( + Index("ix_messages_chat_id_created_at_id", "chat_id", "created_at", "id"), + ) + + id: Mapped[uuid.UUID] = mapped_column(primary_key=True, default=uuid.uuid4) + chat_id: Mapped[uuid.UUID] = mapped_column(ForeignKey("chats.id")) + sender_id: Mapped[uuid.UUID] = mapped_column(ForeignKey("users.id")) + text: Mapped[str] = mapped_column(Text) + created_at: Mapped[datetime] = mapped_column(server_default=func.clock_timestamp()) + + chat: Mapped["Chat"] = relationship(back_populates="messages", lazy="raise") + sender: Mapped["User"] = relationship(back_populates="messages", lazy="raise") diff --git a/app/models/user.py b/app/models/user.py new file mode 100644 index 0000000..74b690e --- /dev/null +++ b/app/models/user.py @@ -0,0 +1,31 @@ +import uuid +from datetime import datetime +from typing import TYPE_CHECKING + +from sqlalchemy import String, func +from sqlalchemy.orm import Mapped, mapped_column, relationship + +from app.models.base import Base + +if TYPE_CHECKING: + from app.models.chat_member import ChatMember + from app.models.message import Message + + +class User(Base): + """Пользователь и его учётные данные.""" + + __tablename__ = "users" + + id: Mapped[uuid.UUID] = mapped_column(primary_key=True, default=uuid.uuid4) + username: Mapped[str] = mapped_column(String(32), unique=True) + display_name: Mapped[str] = mapped_column(String(100)) + password_hash: Mapped[str] = mapped_column(String(255)) + created_at: Mapped[datetime] = mapped_column(server_default=func.now()) + + memberships: Mapped[list["ChatMember"]] = relationship( + back_populates="user", lazy="raise" + ) + messages: Mapped[list["Message"]] = relationship( + back_populates="sender", lazy="raise" + ) diff --git a/app/schemas/__init__.py b/app/schemas/__init__.py new file mode 100644 index 0000000..2f03894 --- /dev/null +++ b/app/schemas/__init__.py @@ -0,0 +1,6 @@ +from app.schemas.chat import Chat +from app.schemas.message import Message +from app.schemas.session import AuthSession +from app.schemas.user import User + +__all__ = ["AuthSession", "Chat", "Message", "User"] diff --git a/app/schemas/attachment.py b/app/schemas/attachment.py new file mode 100644 index 0000000..629e26b --- /dev/null +++ b/app/schemas/attachment.py @@ -0,0 +1,53 @@ +"""Публичные состояния и варианты; внутренние ключи S3 не сериализуются.""" + +from datetime import datetime +from typing import Literal +from uuid import UUID + +from pydantic import BaseModel, ConfigDict, Field, field_validator + +from app.schemas.base import Base + + +class Variant(BaseModel): + model_config = ConfigDict(extra="forbid", from_attributes=True) + + name: Literal["thumbnail", "crop", "optimized"] + content_type: Literal["image/jpeg", "image/png", "image/webp"] + size_bytes: int = Field(ge=1) + width: int = Field(ge=1) + height: int = Field(ge=1) + sha256: str = Field(pattern=r"^[a-f0-9]{64}$") + + +class Attachment(Base): + chat_id: UUID + owner_id: UUID + filename: str = Field(min_length=1, max_length=255) + content_type: Literal["image/png", "image/jpeg"] + size_bytes: int = Field(ge=1, le=10_485_760) + sha256: str = Field(pattern=r"^[a-f0-9]{64}$") + status: Literal["queued", "processing", "ready", "failed"] + variants: list[Variant] = Field(default_factory=list) + error_code: str | None = None + created_at: datetime + updated_at: datetime + + +VARIANT_FILENAMES = { + "thumbnail": "thumbnail.jpg", + "crop": "crop.jpg", + "optimized": "optimized.webp", +} + + +class PipelineResult(BaseModel): + model_config = ConfigDict(extra="forbid") + variants: list[Variant] = Field(min_length=3, max_length=3) + + @field_validator("variants") + @classmethod + def require_all_variants(cls, variants: list[Variant]) -> list[Variant]: + if {item.name for item in variants} != set(VARIANT_FILENAMES): + raise ValueError("Нужны thumbnail, crop и optimized без повторов") + return variants diff --git a/app/schemas/base.py b/app/schemas/base.py new file mode 100644 index 0000000..ca7f4de --- /dev/null +++ b/app/schemas/base.py @@ -0,0 +1,35 @@ +from typing import Literal +from uuid import UUID + +from pydantic import BaseModel, ConfigDict, field_validator + + +class Base(BaseModel): + model_config = ConfigDict(extra="forbid", from_attributes=True) + + id: UUID + + +class Health(BaseModel): + model_config = ConfigDict(extra="forbid") + + status: Literal["ok"] + + +class BaseCreate(BaseModel): + model_config = ConfigDict(extra="forbid") + + @field_validator("*", mode="before") + @classmethod + def reject_invalid_strings(cls, value: object) -> object: + """Отклоняет строки из одних пробелов и строки с NUL, который не хранит PostgreSQL.""" + if isinstance(value, str): + if not value.strip(): + raise ValueError("Строка не может состоять только из пробелов") + if "\x00" in value: + raise ValueError("Строка не может содержать символ NUL") + return value + + +class BasePage(BaseModel): + model_config = ConfigDict(extra="forbid") diff --git a/app/schemas/chat.py b/app/schemas/chat.py new file mode 100644 index 0000000..c0436da --- /dev/null +++ b/app/schemas/chat.py @@ -0,0 +1,22 @@ +from datetime import datetime +from uuid import UUID + +from pydantic import Field + +from app.schemas.base import Base, BaseCreate, BasePage + + +class Chat(Base): + title: str = Field(min_length=1, max_length=100) + member_ids: list[UUID] = Field(min_length=1, max_length=100) + created_at: datetime + + +class CreateChat(BaseCreate): + title: str = Field(min_length=1, max_length=100) + member_ids: list[UUID] = Field(min_length=1, max_length=100) + + +class ChatPage(BasePage): + items: list[Chat] + next_cursor: str | None diff --git a/app/schemas/job.py b/app/schemas/job.py new file mode 100644 index 0000000..7b78370 --- /dev/null +++ b/app/schemas/job.py @@ -0,0 +1,22 @@ +"""Сообщение брокера: только идентификаторы и служебные поля контракта v1.""" + +from typing import Literal +from uuid import UUID + +from pydantic import AwareDatetime, BaseModel, ConfigDict, Field + + +class JobMessage(BaseModel): + model_config = ConfigDict(extra="forbid") + + schema_version: Literal[1] = 1 + type: Literal["attachment.process.v1"] = "attachment.process.v1" + job_id: UUID + attachment_id: UUID + pipeline_version: int = Field(default=1, ge=1) + attempt: int = Field(ge=1) + created_at: AwareDatetime + traceparent: str | None = Field( + default=None, pattern=r"^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$" + ) + tracestate: str | None = Field(default=None, max_length=512) diff --git a/app/schemas/message.py b/app/schemas/message.py new file mode 100644 index 0000000..a085e03 --- /dev/null +++ b/app/schemas/message.py @@ -0,0 +1,41 @@ +from datetime import datetime +from typing import Self +from uuid import UUID + +from pydantic import Field, field_validator, model_validator + +from app.schemas.base import Base, BaseCreate, BasePage + + +class Message(Base): + chat_id: UUID + sender_id: UUID + text: str = Field(max_length=4000) + attachment_ids: list[UUID] = Field(default_factory=list, max_length=10) + created_at: datetime + + +class CreateMessage(BaseCreate): + text: str = Field(max_length=4000) + attachment_ids: list[UUID] = Field(default_factory=list, max_length=10) + + @field_validator("*", mode="before") + @classmethod + def reject_invalid_strings(cls, value: object) -> object: + if isinstance(value, str): + if "\x00" in value or (value != "" and not value.strip()): + raise ValueError("Некорректная строка сообщения") + return value + + @model_validator(mode="after") + def require_content(self) -> Self: + if not self.text and not self.attachment_ids: + raise ValueError("Нужен текст или вложение") + if len(self.attachment_ids) != len(set(self.attachment_ids)): + raise ValueError("attachment_ids содержит дубликаты") + return self + + +class MessagePage(BasePage): + items: list[Message] + next_cursor: str | None diff --git a/app/schemas/session.py b/app/schemas/session.py new file mode 100644 index 0000000..1cae0d2 --- /dev/null +++ b/app/schemas/session.py @@ -0,0 +1,17 @@ +from datetime import datetime +from typing import Literal + +from pydantic import BaseModel, ConfigDict, Field + +from app.schemas.user import User + + +class AuthSession(BaseModel): + """Ответ POST /auth/sessions (в OpenAPI — Session).""" + + model_config = ConfigDict(extra="forbid") + + token: str = Field(min_length=32) + token_type: Literal["Bearer"] = "Bearer" + expires_at: datetime + user: User diff --git a/app/schemas/user.py b/app/schemas/user.py new file mode 100644 index 0000000..1654851 --- /dev/null +++ b/app/schemas/user.py @@ -0,0 +1,25 @@ +from datetime import datetime + +from pydantic import Field + +from app.schemas.base import Base, BaseCreate + +USERNAME_PATTERN = r"^[a-z0-9_]{3,32}$" +PASSWORD_MIN_LENGTH = 12 +PASSWORD_MAX_LENGTH = 128 + + +class User(Base): + """Публичное представление пользователя. Пароль/хеш сюда не попадают никогда.""" + + username: str = Field(pattern=USERNAME_PATTERN) + display_name: str = Field(min_length=1, max_length=100) + created_at: datetime + + +class CreateUser(BaseCreate): + username: str = Field(pattern=USERNAME_PATTERN) + display_name: str = Field(min_length=1, max_length=100) + password: str = Field( + min_length=PASSWORD_MIN_LENGTH, max_length=PASSWORD_MAX_LENGTH, repr=False + ) diff --git a/app/storage/__init__.py b/app/storage/__init__.py new file mode 100644 index 0000000..c881665 --- /dev/null +++ b/app/storage/__init__.py @@ -0,0 +1 @@ +"""Доступ к данным PostgreSQL и Redis.""" diff --git a/app/storage/attachments.py b/app/storage/attachments.py new file mode 100644 index 0000000..3ef1765 --- /dev/null +++ b/app/storage/attachments.py @@ -0,0 +1,99 @@ +"""SQL-запросы метаданных и журнала; commit выполняется в domain.""" + +from datetime import timedelta +from uuid import UUID + +from sqlalchemy import delete, func, select +from sqlalchemy.ext.asyncio import AsyncSession + +from app.models.attachment import Attachment, MessageAttachment, UploadIntent + + +async def create_attachment(session: AsyncSession, **values) -> Attachment: + record = Attachment(**values) + session.add(record) + await session.flush() + return record + + +async def get_attachment( + session: AsyncSession, attachment_id: UUID +) -> Attachment | None: + return await session.get(Attachment, attachment_id) + + +async def get_by_key(session: AsyncSession, key: str) -> Attachment | None: + return await session.scalar(select(Attachment).where(Attachment.object_key == key)) + + +async def get_for_chat( + session: AsyncSession, chat_id: UUID, attachment_ids: list[UUID] +) -> list[Attachment]: + records = [] + if attachment_ids: + records = list( + await session.scalars( + select(Attachment).where( + Attachment.id.in_(attachment_ids), + Attachment.chat_id == chat_id, + ) + ) + ) + return records + + +async def bind_attachments( + session: AsyncSession, message_id: UUID, attachment_ids: list[UUID] +) -> None: + session.add_all( + MessageAttachment(message_id=message_id, attachment_id=id, position=position) + for position, id in enumerate(attachment_ids) + ) + await session.flush() + + +async def message_attachment_ids( + session: AsyncSession, message_ids: list[UUID] +) -> dict[UUID, list[UUID]]: + result: dict[UUID, list[UUID]] = {id: [] for id in message_ids} + if not message_ids: + return result + rows = await session.execute( + select(MessageAttachment) + .where(MessageAttachment.message_id.in_(message_ids)) + .order_by(MessageAttachment.position) + ) + for link in rows.scalars(): + result[link.message_id].append(link.attachment_id) + return result + + +async def reserve_upload(session: AsyncSession, id: UUID, key: str) -> None: + session.add(UploadIntent(id=id, object_key=key)) + await session.flush() + + +async def lock_upload(session: AsyncSession, id: UUID) -> UploadIntent | None: + return await session.scalar( + select(UploadIntent).where(UploadIntent.id == id).with_for_update() + ) + + +async def finish_upload(session: AsyncSession, id: UUID) -> None: + await session.execute(delete(UploadIntent).where(UploadIntent.id == id)) + + +async def stale_uploads( + session: AsyncSession, grace_seconds: int, limit: int +) -> list[UploadIntent]: + result = await session.scalars( + select(UploadIntent) + .where( + UploadIntent.created_at + < func.clock_timestamp() - timedelta(seconds=grace_seconds), + ) + .order_by(UploadIntent.created_at) + .limit(limit) + .with_for_update(skip_locked=True) + ) + return list(result) diff --git a/app/storage/broker.py b/app/storage/broker.py new file mode 100644 index 0000000..1932ffd --- /dev/null +++ b/app/storage/broker.py @@ -0,0 +1,94 @@ +"""RabbitMQ: durable queue, persistent messages, publisher confirms и manual ack.""" + +import asyncio +import logging +from dataclasses import dataclass + +import aio_pika +from aio_pika.abc import AbstractIncomingMessage + +from app.core.jobs import JobSettings +from app.schemas.job import JobMessage + + +@dataclass(frozen=True) +class Delivery: + id: AbstractIncomingMessage + payload: bytes + + +class JobBroker: + """Один consumer/канал на экземпляр; publisher использует отдельный экземпляр.""" + + def __init__(self, settings: JobSettings) -> None: + self.settings = settings + self.connection = self.channel = self.queue = self.iterator = None + # Transport exceptions могут содержать URL с credentials. + logging.getLogger("aio_pika").setLevel(logging.CRITICAL) + logging.getLogger("aiormq").setLevel(logging.CRITICAL) + + async def ensure_ready(self) -> None: + if ( + self.connection is None + or self.connection.is_closed + or self.channel is None + or self.channel.is_closed + ): + await self.aclose() + self.connection = await aio_pika.connect( + host=self.settings.broker_host, + port=self.settings.broker_port, + login=self.settings.broker_user, + password=self.settings.broker_password_file.read_text().strip(), + virtualhost=self.settings.broker_vhost, + timeout=5, + heartbeat=30, + ) + self.channel = await self.connection.channel( + publisher_confirms=True, on_return_raises=True + ) + await self.channel.set_qos(prefetch_count=1) + self.queue = await self.channel.declare_queue( + self.settings.broker_queue, durable=True + ) + + async def publish_job(self, message: JobMessage) -> None: + await self.ensure_ready() + await self.channel.default_exchange.publish( + aio_pika.Message( + body=message.model_dump_json(exclude_none=True).encode(), + content_type="application/json", + delivery_mode=aio_pika.DeliveryMode.PERSISTENT, + message_id=f"{message.job_id}:{message.attempt}", + ), + routing_key=self.settings.broker_queue, + mandatory=True, + timeout=10, + ) + + async def receive(self, consumer: str) -> Delivery: + await self.ensure_ready() + if self.iterator is None: + self.iterator = self.queue.iterator(no_ack=False, consumer_tag=consumer) + await self.iterator.__aenter__() + message = await self.iterator.__anext__() + return Delivery(message, message.body) + + async def acknowledge_job(self, delivery_id: AbstractIncomingMessage) -> None: + await delivery_id.ack() + + async def defer_job(self, delivery_id: AbstractIncomingMessage) -> None: + # Живая чужая lease: не удерживать единственный prefetch slot навсегда. + await asyncio.sleep(self.settings.publisher_poll_seconds) + await delivery_id.nack(requeue=True) + + async def reject_invalid(self, delivery_id: AbstractIncomingMessage) -> None: + # Failed jobs находятся в PostgreSQL; неизвестные payload не копируются в DLQ. + logging.getLogger(__name__).warning("Rejected invalid job envelope") + await delivery_id.reject(requeue=False) + + async def aclose(self) -> None: + connection = self.connection + self.connection = self.channel = self.queue = self.iterator = None + if connection is not None and not connection.is_closed: + await connection.close() diff --git a/app/storage/chats.py b/app/storage/chats.py new file mode 100644 index 0000000..f88ee0c --- /dev/null +++ b/app/storage/chats.py @@ -0,0 +1,71 @@ +from collections.abc import Sequence +from uuid import UUID + +from sqlalchemy import exists, select, tuple_ +from sqlalchemy.ext.asyncio import AsyncSession + +from app.models.chat import Chat +from app.models.chat_member import ChatMember +from app.storage.types import Position + + +async def create_chat( + session: AsyncSession, + *, + title: str, + member_ids: Sequence[UUID], +) -> Chat: + """Добавляет чат вместе с участниками.""" + chat = Chat( + title=title, + members=[ChatMember(user_id=user_id) for user_id in member_ids], + ) + session.add(chat) + await session.flush() + return chat + + +async def get_chat_for_member( + session: AsyncSession, + chat_id: UUID, + user_id: UUID, +) -> Chat | None: + """Возвращает чат, если пользователь в нём состоит, иначе None.""" + stmt = ( + select(Chat) + .join(ChatMember, ChatMember.chat_id == Chat.id) + .where(Chat.id == chat_id, ChatMember.user_id == user_id) + ) + result = await session.execute(stmt) + chat = result.scalar_one_or_none() + return chat + + +async def is_chat_member(session: AsyncSession, chat_id: UUID, user_id: UUID) -> bool: + """Возвращает True, если пользователь состоит в чате; одна проверка по PK.""" + stmt = select( + exists().where(ChatMember.chat_id == chat_id, ChatMember.user_id == user_id) + ) + result = await session.execute(stmt) + is_member = bool(result.scalar_one()) + return is_member + + +async def list_chats_for_user( + session: AsyncSession, + user_id: UUID, + after: Position | None, + limit: int, +) -> list[Chat]: + """Возвращает чаты пользователя по (created_at, id) строго после позиции after.""" + stmt = ( + select(Chat) + .join(ChatMember, ChatMember.chat_id == Chat.id) + .where(ChatMember.user_id == user_id) + ) + if after is not None: + stmt = stmt.where(tuple_(Chat.created_at, Chat.id) > tuple_(*after)) + stmt = stmt.order_by(Chat.created_at, Chat.id).limit(limit) + result = await session.execute(stmt) + chats = list(result.scalars().all()) + return chats diff --git a/app/storage/health.py b/app/storage/health.py new file mode 100644 index 0000000..2d034b7 --- /dev/null +++ b/app/storage/health.py @@ -0,0 +1,15 @@ +"""Простые проверки соединения с общими хранилищами.""" + +from redis.asyncio import Redis +from sqlalchemy import text +from sqlalchemy.ext.asyncio import AsyncEngine + + +async def check_database(engine: AsyncEngine) -> bool: + async with engine.connect() as connection: + await connection.execute(text("SELECT 1")) + return True + + +async def check_redis(client: Redis) -> bool: + return bool(await client.ping()) diff --git a/app/storage/idempotency.py b/app/storage/idempotency.py new file mode 100644 index 0000000..53e174c --- /dev/null +++ b/app/storage/idempotency.py @@ -0,0 +1,70 @@ +"""Хранение и блокировка ключей в PostgreSQL.""" + +from datetime import timedelta +import hashlib +import json +from uuid import UUID + +from sqlalchemy import BigInteger, func, literal, select, tuple_ +from sqlalchemy.dialects.postgresql import insert +from sqlalchemy.ext.asyncio import AsyncSession + +from app.models.idempotency_key import IdempotencyKey + +Scope = tuple[UUID, str, str, str] + + +async def lock_key(session: AsyncSession, scope: Scope) -> None: + """Сериализует один ключ до конца транзакции.""" + raw = json.dumps([str(scope[0]), *scope[1:]]).encode() + lock_id = int.from_bytes(hashlib.sha256(raw).digest()[:8], signed=True) + await session.execute( + select(func.pg_advisory_xact_lock(literal(lock_id, type_=BigInteger))) + ) + + +async def get_active_key( + session: AsyncSession, scope: Scope, ttl_seconds: int +) -> IdempotencyKey | None: + """Читает результат, пока срок ключа не истёк.""" + stmt = select(IdempotencyKey).where( + tuple_( + IdempotencyKey.user_id, + IdempotencyKey.method, + IdempotencyKey.path, + IdempotencyKey.key, + ) + == tuple_(*scope), + IdempotencyKey.created_at + > func.clock_timestamp() - timedelta(seconds=ttl_seconds), + ) + return await session.scalar(stmt) + + +async def save_result( + session: AsyncSession, scope: Scope, request_hash: str, message_id: UUID +) -> None: + """Сохраняет новый результат или заменяет истёкший.""" + stmt = insert(IdempotencyKey).values( + user_id=scope[0], + method=scope[1], + path=scope[2], + key=scope[3], + request_hash=request_hash, + message_id=message_id, + ) + await session.execute( + stmt.on_conflict_do_update( + index_elements=[ + IdempotencyKey.user_id, + IdempotencyKey.method, + IdempotencyKey.path, + IdempotencyKey.key, + ], + set_={ + "request_hash": request_hash, + "message_id": message_id, + "created_at": func.clock_timestamp(), + }, + ) + ) diff --git a/app/storage/job_admin.py b/app/storage/job_admin.py new file mode 100644 index 0000000..6780924 --- /dev/null +++ b/app/storage/job_admin.py @@ -0,0 +1,59 @@ +"""Операторские выборки и журнал replay; транзакция принадлежит domain.""" + +from sqlalchemy import select +from sqlalchemy.dialects.postgresql import insert + +from app.models.attachment import Attachment +from app.models.job import AttachmentJob +from app.models.job_replay import JobReplay + + +async def failed_jobs(session, limit: int): + result = await session.execute( + select(AttachmentJob, Attachment) + .join(Attachment, Attachment.id == AttachmentJob.attachment_id) + .where(Attachment.status == "failed") + .order_by(AttachmentJob.finished_at.desc(), AttachmentJob.id) + .limit(limit) + ) + return result.all() + + +async def replay_record(session, request_id): + return await session.get(JobReplay, request_id) + + +async def insert_replay(session, **values) -> bool: + result = await session.scalar( + insert(JobReplay) + .values(**values) + .on_conflict_do_nothing(index_elements=[JobReplay.id]) + .returning(JobReplay.id) + ) + return result is not None + + +async def replay_history(session, job_id): + return ( + await session.scalars( + select(JobReplay) + .where(JobReplay.job_id == job_id) + .order_by(JobReplay.created_at) + .limit(100) + ) + ).all() + + +def reset_failed(job, attachment, now, attempt_limit): + job.cycle_start_attempt = job.attempt + job.attempt_limit = attempt_limit + job.published_attempt = job.attempt + job.next_attempt_at = now + job.lease_token = None + job.lease_until = None + job.finished_at = None + job.last_error_code = None + job.last_error_permanent = None + attachment.status = "queued" + attachment.error_code = None + attachment.updated_at = now diff --git a/app/storage/jobs.py b/app/storage/jobs.py new file mode 100644 index 0000000..e0ca118 --- /dev/null +++ b/app/storage/jobs.py @@ -0,0 +1,160 @@ +"""SQL и изменения jobs/attachments; commit остаётся в domain.""" + +from dataclasses import dataclass +from datetime import datetime, timedelta +from uuid import UUID + +from sqlalchemy import and_, or_, func, select +from sqlalchemy.ext.asyncio import AsyncSession + +from app.models.attachment import Attachment +from app.models.job import AttachmentJob +from app.schemas.attachment import VARIANT_FILENAMES + + +@dataclass(frozen=True) +class JobWork: + job_id: UUID + attachment_id: UUID + lease_token: UUID + pipeline_version: int + staging_key: str + content_type: str + size_bytes: int + sha256: str + + @property + def original_key(self) -> str: + return f"originals/{self.attachment_id.hex}/v{self.pipeline_version}" + + def variant_key(self, name: str) -> str: + filename = VARIANT_FILENAMES[name] + return f"variants/{self.attachment_id.hex}/v{self.pipeline_version}/{filename}" + + +async def create_job( + session: AsyncSession, attachment_id: UUID, staging_key: str +) -> UUID: + job = AttachmentJob(attachment_id=attachment_id, staging_key=staging_key) + session.add(job) + await session.flush() + return job.id + + +async def lock_job(session: AsyncSession, job_id: UUID): + result = await session.execute( + select(AttachmentJob, Attachment) + .join(Attachment, Attachment.id == AttachmentJob.attachment_id) + .where(AttachmentJob.id == job_id) + .with_for_update(of=AttachmentJob) + .execution_options(populate_existing=True) + ) + return result.one_or_none() + + +async def database_time(session: AsyncSession) -> datetime: + return await session.scalar(select(func.clock_timestamp())) + + +async def expired_jobs(session: AsyncSession, limit: int = 20): + result = await session.execute( + select(AttachmentJob, Attachment) + .join(Attachment, Attachment.id == AttachmentJob.attachment_id) + .where( + Attachment.status == "processing", + AttachmentJob.lease_until < func.clock_timestamp(), + ) + .order_by(AttachmentJob.lease_until) + .limit(limit) + .with_for_update(of=AttachmentJob, skip_locked=True) + ) + return result.all() + + +def start_job( + job, attachment, token: UUID, now: datetime, lease_seconds: int +) -> JobWork: + job.attempt += 1 + job.lease_token = token + job.lease_until = now + timedelta(seconds=lease_seconds) + attachment.status = "processing" + attachment.updated_at = now + return JobWork( + job.id, + attachment.id, + token, + job.pipeline_version, + job.staging_key, + attachment.content_type, + attachment.size_bytes, + attachment.sha256, + ) + + +def record_failure( + job, + attachment, + now: datetime, + error_code: str, + *, + terminal: bool, + retry_seconds: float, +) -> None: + job.lease_token = None + job.lease_until = None + job.last_error_code = error_code + job.next_attempt_at = now + timedelta(seconds=retry_seconds) + job.finished_at = now if terminal else None + attachment.status = "failed" if terminal else "queued" + attachment.error_code = error_code if terminal else None + attachment.updated_at = now + + +def complete_job( + job, attachment, work: JobWork, variants: list[dict], now: datetime +) -> None: + attachment.object_key = work.original_key + attachment.thumbnail_key = work.variant_key("thumbnail") + attachment.crop_key = work.variant_key("crop") + attachment.optimized_key = work.variant_key("optimized") + attachment.variants = variants + attachment.status = "ready" + attachment.error_code = None + attachment.updated_at = now + job.lease_token = None + job.lease_until = None + job.last_error_code = None + job.last_error_permanent = None + job.finished_at = now + + +async def terminal_staging( + session: AsyncSession, retention: int, failed_retention: int, limit: int = 20 +): + result = await session.execute( + select(AttachmentJob, Attachment) + .join(Attachment, Attachment.id == AttachmentJob.attachment_id) + .where( + AttachmentJob.staging_key.is_not(None), + or_( + and_( + Attachment.status == "ready", + AttachmentJob.finished_at + < func.clock_timestamp() - timedelta(seconds=retention), + ), + and_( + Attachment.status == "failed", + AttachmentJob.finished_at + < func.clock_timestamp() - timedelta(seconds=failed_retention), + ), + ), + ) + .order_by(AttachmentJob.finished_at) + .limit(limit) + .with_for_update(of=AttachmentJob, skip_locked=True) + ) + return result.all() + + +def clear_staging(job) -> None: + job.staging_key = None diff --git a/app/storage/messages.py b/app/storage/messages.py new file mode 100644 index 0000000..e0f75af --- /dev/null +++ b/app/storage/messages.py @@ -0,0 +1,62 @@ +from uuid import UUID + +from sqlalchemy import select, tuple_ +from sqlalchemy.dialects.postgresql import insert +from sqlalchemy.ext.asyncio import AsyncSession + +from app.models.counter import Counter +from app.models.message import Message +from app.storage.types import Position + +MESSAGES_COUNTER = "messages" + + +async def get_message(session: AsyncSession, message_id: UUID) -> Message | None: + return await session.get(Message, message_id) + + +async def create_message( + session: AsyncSession, + *, + chat_id: UUID, + sender_id: UUID, + text: str, +) -> Message: + """Добавляет сообщение; id и created_at назначает сервер.""" + message = Message(chat_id=chat_id, sender_id=sender_id, text=text) + session.add(message) + await session.flush() + return message + + +async def list_messages( + session: AsyncSession, + chat_id: UUID, + after: Position | None, + limit: int, +) -> list[Message]: + """Возвращает сообщения чата по (created_at, id) строго после позиции after.""" + stmt = select(Message).where(Message.chat_id == chat_id) + if after is not None: + stmt = stmt.where(tuple_(Message.created_at, Message.id) > tuple_(*after)) + stmt = stmt.order_by(Message.created_at, Message.id).limit(limit) + result = await session.execute(stmt) + messages = list(result.scalars().all()) + return messages + + +async def reserve_message_slot(session: AsyncSession, max_messages: int) -> bool: + """Атомарно увеличивает счётчик сообщений, если лимит не исчерпан.""" + stmt = ( + insert(Counter) + .values(name=MESSAGES_COUNTER, value=1) + .on_conflict_do_update( + index_elements=[Counter.name], + set_={"value": Counter.value + 1}, + where=Counter.value < max_messages, + ) + .returning(Counter.value) + ) + result = await session.execute(stmt) + is_reserved = result.scalar_one_or_none() is not None + return is_reserved diff --git a/app/storage/outbox.py b/app/storage/outbox.py new file mode 100644 index 0000000..be50c31 --- /dev/null +++ b/app/storage/outbox.py @@ -0,0 +1,33 @@ +"""Jobs одновременно хранят намерение публикации очередной попытки.""" + +from uuid import UUID + +from sqlalchemy import func, select +from sqlalchemy.ext.asyncio import AsyncSession + +from app.models.attachment import Attachment +from app.models.job import AttachmentJob + + +async def next_unpublished_job( + session: AsyncSession, *, attachment_id: UUID | None = None +) -> AttachmentJob | None: + statement = ( + select(AttachmentJob) + .join(Attachment, Attachment.id == AttachmentJob.attachment_id) + .where( + Attachment.status == "queued", + AttachmentJob.next_attempt_at <= func.clock_timestamp(), + AttachmentJob.published_attempt <= AttachmentJob.attempt, + ) + .order_by(AttachmentJob.next_attempt_at, AttachmentJob.id) + .limit(1) + .with_for_update(of=AttachmentJob, skip_locked=True) + ) + if attachment_id is not None: + statement = statement.where(AttachmentJob.attachment_id == attachment_id) + return await session.scalar(statement) + + +def mark_published(job: AttachmentJob) -> None: + job.published_attempt = job.attempt + 1 diff --git a/app/storage/s3.py b/app/storage/s3.py new file mode 100644 index 0000000..b3355a3 --- /dev/null +++ b/app/storage/s3.py @@ -0,0 +1,180 @@ +"""MinIO SDK выполняется в потоках; ресурсы живут до конца операции.""" + +import asyncio +from collections.abc import Callable +from contextlib import suppress +from dataclasses import dataclass +from datetime import datetime +from pathlib import Path +from typing import TypeVar +import time +from urllib.parse import urlsplit + +from anyio import CancelScope +from minio import Minio +import urllib3 + +from app.core.s3 import S3Settings + +T = TypeVar("T") + + +async def run_sync( + operation: Callable[..., T], *args, discard_result=None, **kwargs +) -> T: + """При отмене дождаться потока: иначе PUT может догнать компенсацию удаления.""" + task = asyncio.create_task(asyncio.to_thread(operation, *args, **kwargs)) + try: + result = await asyncio.shield(task) + except asyncio.CancelledError: + with CancelScope(shield=True): + await settle_cancelled_call(task, discard_result) + raise + return result + + +async def settle_cancelled_call( + task: asyncio.Task, discard_result: Callable | None +) -> None: + """wait не переносит исключение SDK; повторная отмена не прерывает компенсацию.""" + while not task.done(): + with suppress(asyncio.CancelledError): + await asyncio.wait([task]) + completed = not task.cancelled() and task.exception() is None + if completed and discard_result is not None: + discard_result(task.result()) + + +@dataclass(frozen=True) +class ObjectInfo: + """Поля S3 сохраняют необязательность SDK; согласованность проверяет domain.""" + + key: str + size_bytes: int | None + content_type: str | None + last_modified: datetime | None + + +def close_response(response) -> None: + response.close() + response.release_conn() + + +class ObjectStream: + """Закрывается даже если StreamingResponse не успел начать итерацию.""" + + def __init__(self, storage, response): + self.storage = storage + self.response = response + self.deadline = time.monotonic() + storage.settings.download_timeout_seconds + self.closed = False + + def __aiter__(self): + return self + + async def __anext__(self): + if self.closed: + raise StopAsyncIteration + try: + remaining = self.deadline - time.monotonic() + if remaining <= 0: + raise TimeoutError + async with asyncio.timeout(remaining): + chunk = await self.storage._call( + lambda: self.response.read(self.storage.settings.chunk_bytes) + ) + if not chunk: + await self.aclose() + raise StopAsyncIteration + except BaseException: + await self.aclose() + raise + return chunk + + async def aclose(self): + if not self.closed: + self.closed = True + close_response(self.response) + + +class MinioStorage: + def __init__(self, settings: S3Settings) -> None: + self.settings = settings + # Клиент создаётся в event loop один раз, не конкурентно в worker threads. + url = urlsplit(settings.endpoint) + self._http = urllib3.PoolManager( + timeout=urllib3.Timeout( + connect=settings.connect_timeout_seconds, + read=settings.read_timeout_seconds, + ), + retries=urllib3.Retry(total=0), + maxsize=32, + ) + self._health_http = urllib3.PoolManager( + timeout=urllib3.Timeout(connect=0.25, read=0.5), + retries=urllib3.Retry(total=0), + ) + self._client = Minio( + url.netloc, + secure=url.scheme == "https", + region=settings.region, + access_key=settings.access_key_id_file.read_text().strip(), + secret_key=settings.secret_access_key_file.read_text().strip(), + http_client=self._http, + ) + + async def _call(self, operation: Callable, *, discard_result=None): + return await run_sync(operation, discard_result=discard_result) + + async def put_file( + self, key: str, path: Path, *, size_bytes: int, content_type: str, sha256: str + ) -> None: + def put(): + with path.open("rb") as source: + # Один PUT: размер части равен максимальному разрешённому файлу. + self._client.put_object( + self.settings.bucket, + key, + source, + size_bytes, + content_type=content_type, + metadata={"sha256": sha256}, + part_size=10_485_760, + num_parallel_uploads=1, + ) + + await self._call(put) + + async def open_object(self, key: str) -> ObjectStream: + response = await self._call( + lambda: self._client.get_object(self.settings.bucket, key), + discard_result=close_response, + ) + return ObjectStream(self, response) + + async def stat_object(self, key: str) -> ObjectInfo: + def stat(): + info = self._client.stat_object(self.settings.bucket, key) + return ObjectInfo(key, info.size, info.content_type, info.last_modified) + + return await self._call(stat) + + async def delete_object(self, key: str) -> None: + await self._call(lambda: self._client.remove_object(self.settings.bucket, key)) + + async def check_available(self) -> bool: + status = await self._call( + lambda: self._health_http.request( + "GET", + self.settings.endpoint.rstrip("/") + "/minio/health/ready", + ).status + ) + return status == 200 + + async def aclose(self) -> None: + self._http.clear() + self._health_http.clear() + + +def create_s3_storage(settings: S3Settings) -> MinioStorage: + return MinioStorage(settings) diff --git a/app/storage/sessions.py b/app/storage/sessions.py new file mode 100644 index 0000000..d8a30f2 --- /dev/null +++ b/app/storage/sessions.py @@ -0,0 +1,38 @@ +from datetime import datetime +from uuid import UUID + +from redis.asyncio import Redis + +SESSION_KEY_PREFIX = "session:" + + +def session_key(token_hash: str) -> str: + """Возвращает ключ Redis для хеша токена.""" + return f"{SESSION_KEY_PREFIX}{token_hash}" + + +async def create_session( + redis: Redis, + *, + token_hash: str, + user_id: UUID, + expires_at: datetime, +) -> None: + """Добавляет сессию с абсолютным временем истечения.""" + await redis.set(session_key(token_hash), str(user_id), pxat=expires_at) + + +async def get_session_user_id(redis: Redis, token_hash: str) -> UUID | None: + """Возвращает id владельца действующей сессии или None.""" + raw_user_id = await redis.get(session_key(token_hash)) + if isinstance(raw_user_id, bytes): + raw_user_id = raw_user_id.decode() + user_id = UUID(raw_user_id) if raw_user_id else None + return user_id + + +async def delete_session(redis: Redis, token_hash: str) -> bool: + """Удаляет сессию; возвращает True, если она существовала.""" + deleted_count = await redis.delete(session_key(token_hash)) + is_deleted = deleted_count > 0 + return is_deleted diff --git a/app/storage/types.py b/app/storage/types.py new file mode 100644 index 0000000..e0357cf --- /dev/null +++ b/app/storage/types.py @@ -0,0 +1,6 @@ +"""Общие типы слоя хранения.""" + +from datetime import datetime +from uuid import UUID + +Position = tuple[datetime, UUID] diff --git a/app/storage/users.py b/app/storage/users.py new file mode 100644 index 0000000..45214e9 --- /dev/null +++ b/app/storage/users.py @@ -0,0 +1,47 @@ +from collections.abc import Collection +from uuid import UUID + +from sqlalchemy import select +from sqlalchemy.ext.asyncio import AsyncSession + +from app.models.user import User + + +async def create_user( + session: AsyncSession, + *, + username: str, + display_name: str, + password_hash: str, +) -> User: + """Добавляет пользователя; занятый username даёт IntegrityError при flush.""" + user = User( + username=username, display_name=display_name, password_hash=password_hash + ) + session.add(user) + await session.flush() + return user + + +async def get_user_by_id(session: AsyncSession, user_id: UUID) -> User | None: + """Возвращает пользователя по id или None.""" + user = await session.get(User, user_id) + return user + + +async def get_user_by_username(session: AsyncSession, username: str) -> User | None: + """Возвращает пользователя по username или None.""" + stmt = select(User).where(User.username == username) + result = await session.execute(stmt) + user = result.scalar_one_or_none() + return user + + +async def get_existing_user_ids( + session: AsyncSession, user_ids: Collection[UUID] +) -> set[UUID]: + """Возвращает те из user_ids, что существуют, одним запросом.""" + stmt = select(User.id).where(User.id.in_(user_ids)) + result = await session.execute(stmt) + existing_ids = set(result.scalars().all()) + return existing_ids diff --git a/compose.test.yaml b/compose.test.yaml new file mode 100644 index 0000000..c20fa58 --- /dev/null +++ b/compose.test.yaml @@ -0,0 +1,10 @@ +# Override для отдельного тестового стенда (make test-stand-up): +# публикует PostgreSQL и Redis на 127.0.0.1, чтобы pytest из student-tests/ +# мог подключаться к ним напрямую. В основном стенде эти порты закрыты. +services: + postgres: + ports: + - "127.0.0.1:${DB_HOST_PORT:?Set DB_HOST_PORT in .env}:5432" + redis: + ports: + - "127.0.0.1:${REDIS_HOST_PORT:?Set REDIS_HOST_PORT in .env}:6379" diff --git a/compose.yaml b/compose.yaml new file mode 100644 index 0000000..af2748e --- /dev/null +++ b/compose.yaml @@ -0,0 +1,416 @@ +name: messenger + +x-api-image: &api-image + build: + context: . + args: + API_BUILD_REVISION: ${API_BUILD_REVISION:?Set API_BUILD_REVISION in .env} + image: ${API_IMAGE:?Set API_IMAGE in .env} + +x-base-env: &base-env + APP_HOST: ${APP_HOST:?Set APP_HOST in .env} + APP_PORT: ${APP_PORT:?Set APP_PORT in .env} + APP_ENV: ${APP_ENV:?Set APP_ENV in .env} + LOG_LEVEL: ${LOG_LEVEL:?Set LOG_LEVEL in .env} + MAX_MESSAGES: ${MAX_MESSAGES:?Set MAX_MESSAGES in .env} + MAX_IN_FLIGHT: ${MAX_IN_FLIGHT:?Set MAX_IN_FLIGHT in .env} + DB_HOST: ${DB_HOST:?Set DB_HOST in .env} + DB_PORT: ${DB_PORT:?Set DB_PORT in .env} + DB_NAME: ${DB_NAME:?Set DB_NAME in .env} + DB_USER: ${DB_USER:?Set DB_USER in .env} + DB_POOL_SIZE: ${DB_POOL_SIZE:?Set DB_POOL_SIZE in .env} + DB_MAX_OVERFLOW: ${DB_MAX_OVERFLOW:?Set DB_MAX_OVERFLOW in .env} + DB_POOL_TIMEOUT_SECONDS: ${DB_POOL_TIMEOUT_SECONDS:?Set DB_POOL_TIMEOUT_SECONDS in .env} + DB_CONNECT_TIMEOUT_SECONDS: ${DB_CONNECT_TIMEOUT_SECONDS:?Set DB_CONNECT_TIMEOUT_SECONDS in .env} + DB_STATEMENT_TIMEOUT_MS: ${DB_STATEMENT_TIMEOUT_MS:?Set DB_STATEMENT_TIMEOUT_MS in .env} + SHUTDOWN_DRAIN_SECONDS: ${SHUTDOWN_DRAIN_SECONDS:?Set SHUTDOWN_DRAIN_SECONDS in .env} + GRACEFUL_SHUTDOWN_TIMEOUT_SECONDS: ${GRACEFUL_SHUTDOWN_TIMEOUT_SECONDS:?Set GRACEFUL_SHUTDOWN_TIMEOUT_SECONDS in .env} + READINESS_TIMEOUT_SECONDS: ${READINESS_TIMEOUT_SECONDS:?Set READINESS_TIMEOUT_SECONDS in .env} + +x-s3-env: &s3-env + S3_ENDPOINT: ${S3_ENDPOINT:?Set S3_ENDPOINT in .env} + S3_REGION: ${S3_REGION:?Set S3_REGION in .env} + S3_BUCKET: ${S3_BUCKET:?Set S3_BUCKET in .env} + S3_ACCESS_KEY_ID_FILE: ${S3_ACCESS_KEY_ID_FILE:?Set S3_ACCESS_KEY_ID_FILE in .env} + S3_SECRET_ACCESS_KEY_FILE: ${S3_SECRET_ACCESS_KEY_FILE:?Set S3_SECRET_ACCESS_KEY_FILE in .env} + S3_CONNECT_TIMEOUT_SECONDS: ${S3_CONNECT_TIMEOUT_SECONDS:?Set S3_CONNECT_TIMEOUT_SECONDS in .env} + S3_READ_TIMEOUT_SECONDS: ${S3_READ_TIMEOUT_SECONDS:?Set S3_READ_TIMEOUT_SECONDS in .env} + S3_UPLOAD_TIMEOUT_SECONDS: ${S3_UPLOAD_TIMEOUT_SECONDS:?Set S3_UPLOAD_TIMEOUT_SECONDS in .env} + S3_DOWNLOAD_TIMEOUT_SECONDS: ${S3_DOWNLOAD_TIMEOUT_SECONDS:?Set S3_DOWNLOAD_TIMEOUT_SECONDS in .env} + S3_IMAGE_TIMEOUT_SECONDS: ${S3_IMAGE_TIMEOUT_SECONDS:?Set S3_IMAGE_TIMEOUT_SECONDS in .env} + S3_MAX_UPLOAD_BYTES: ${S3_MAX_UPLOAD_BYTES:?Set S3_MAX_UPLOAD_BYTES in .env} + S3_MAX_IMAGE_PIXELS: ${S3_MAX_IMAGE_PIXELS:?Set S3_MAX_IMAGE_PIXELS in .env} + S3_CHUNK_BYTES: ${S3_CHUNK_BYTES:?Set S3_CHUNK_BYTES in .env} + S3_MAX_CONCURRENT_UPLOADS: ${S3_MAX_CONCURRENT_UPLOADS:?Set S3_MAX_CONCURRENT_UPLOADS in .env} + S3_CLEANUP_GRACE_SECONDS: ${S3_CLEANUP_GRACE_SECONDS:?Set S3_CLEANUP_GRACE_SECONDS in .env} + S3_CLEANUP_INTERVAL_SECONDS: ${S3_CLEANUP_INTERVAL_SECONDS:?Set S3_CLEANUP_INTERVAL_SECONDS in .env} + +x-jobs-env: &jobs-env + BROKER_HOST: ${BROKER_HOST:?Set BROKER_HOST in .env} + BROKER_PORT: ${BROKER_PORT:?Set BROKER_PORT in .env} + BROKER_PASSWORD_FILE: ${BROKER_PASSWORD_FILE:?Set BROKER_PASSWORD_FILE in .env} + BROKER_QUEUE: ${BROKER_QUEUE:?Set BROKER_QUEUE in .env} + BROKER_USER: ${BROKER_USER:?Set BROKER_USER in .env} + BROKER_VHOST: ${BROKER_VHOST:?Set BROKER_VHOST in .env} + WORKER_CONCURRENCY: ${WORKER_CONCURRENCY:?Set WORKER_CONCURRENCY in .env} + JOB_MAX_ATTEMPTS: ${JOB_MAX_ATTEMPTS:?Set JOB_MAX_ATTEMPTS in .env} + JOB_TIMEOUT_SECONDS: ${JOB_TIMEOUT_SECONDS:?Set JOB_TIMEOUT_SECONDS in .env} + JOB_LEASE_SECONDS: ${JOB_LEASE_SECONDS:?Set JOB_LEASE_SECONDS in .env} + JOB_RETRY_MAX_SECONDS: ${JOB_RETRY_MAX_SECONDS:?Set JOB_RETRY_MAX_SECONDS in .env} + JOB_RETRY_SECONDS: ${JOB_RETRY_SECONDS:?Set JOB_RETRY_SECONDS in .env} + PUBLISHER_POLL_SECONDS: ${PUBLISHER_POLL_SECONDS:?Set PUBLISHER_POLL_SECONDS in .env} + FAILED_STAGING_RETENTION_SECONDS: ${FAILED_STAGING_RETENTION_SECONDS:?Set FAILED_STAGING_RETENTION_SECONDS in .env} + STAGING_RETENTION_SECONDS: ${STAGING_RETENTION_SECONDS:?Set STAGING_RETENTION_SECONDS in .env} + IMAGE_JPEG_QUALITY: ${IMAGE_JPEG_QUALITY:?Set IMAGE_JPEG_QUALITY in .env} + IMAGE_WEBP_QUALITY: ${IMAGE_WEBP_QUALITY:?Set IMAGE_WEBP_QUALITY in .env} + IMAGE_WEBP_METHOD: ${IMAGE_WEBP_METHOD:?Set IMAGE_WEBP_METHOD in .env} + IMAGE_MEMORY_MIB: ${IMAGE_MEMORY_MIB:?Set IMAGE_MEMORY_MIB in .env} + IMAGE_CPU_SECONDS: ${IMAGE_CPU_SECONDS:?Set IMAGE_CPU_SECONDS in .env} + +services: + minio: + build: + context: . + dockerfile: infra/minio/Dockerfile + target: server + image: messenger-minio:local + command: ["server", "/data", "--console-address", "127.0.0.1:9001"] + restart: unless-stopped + environment: + MINIO_ROOT_USER_FILE: ${MINIO_ROOT_USER_FILE:?Set MINIO_ROOT_USER_FILE in .env} + MINIO_ROOT_PASSWORD_FILE: ${MINIO_ROOT_PASSWORD_FILE:?Set MINIO_ROOT_PASSWORD_FILE in .env} + MINIO_BROWSER: ${MINIO_BROWSER:?Set MINIO_BROWSER in .env} + secrets: + - source: minio_root_user + target: ${MINIO_ROOT_USER_FILE:?Set MINIO_ROOT_USER_FILE in .env} + - source: minio_root_password + target: ${MINIO_ROOT_PASSWORD_FILE:?Set MINIO_ROOT_PASSWORD_FILE in .env} + volumes: + - miniodata:/data + networks: [objects] + healthcheck: + test: ["CMD", "python", "-c", "import urllib.request; urllib.request.urlopen('http://127.0.0.1:9000/minio/health/ready', timeout=2)"] + interval: 3s + timeout: 3s + retries: 10 + deploy: + resources: + limits: + cpus: "1.0" + memory: 512M + + minio-bootstrap: + build: + context: . + dockerfile: infra/minio/Dockerfile + target: bootstrap + image: messenger-minio-bootstrap:local + environment: + S3_ENDPOINT: ${S3_ENDPOINT:?Set S3_ENDPOINT in .env} + S3_BUCKET: ${S3_BUCKET:?Set S3_BUCKET in .env} + S3_ACCESS_KEY_ID_FILE: ${S3_ACCESS_KEY_ID_FILE:?Set S3_ACCESS_KEY_ID_FILE in .env} + S3_SECRET_ACCESS_KEY_FILE: ${S3_SECRET_ACCESS_KEY_FILE:?Set S3_SECRET_ACCESS_KEY_FILE in .env} + MINIO_ROOT_USER_FILE: ${MINIO_ROOT_USER_FILE:?Set MINIO_ROOT_USER_FILE in .env} + MINIO_ROOT_PASSWORD_FILE: ${MINIO_ROOT_PASSWORD_FILE:?Set MINIO_ROOT_PASSWORD_FILE in .env} + secrets: + - source: minio_root_user + target: ${MINIO_ROOT_USER_FILE:?Set MINIO_ROOT_USER_FILE in .env} + - source: minio_root_password + target: ${MINIO_ROOT_PASSWORD_FILE:?Set MINIO_ROOT_PASSWORD_FILE in .env} + - source: s3_access_key_id + target: ${S3_ACCESS_KEY_ID_FILE:?Set S3_ACCESS_KEY_ID_FILE in .env} + - source: s3_secret_access_key + target: ${S3_SECRET_ACCESS_KEY_FILE:?Set S3_SECRET_ACCESS_KEY_FILE in .env} + networks: [objects] + restart: "no" + depends_on: + minio: + condition: service_healthy + deploy: + resources: + limits: + cpus: "0.25" + memory: 128M + + postgres: + image: postgres:16.10-bookworm + restart: unless-stopped + environment: + POSTGRES_USER: ${DB_USER:?Set DB_USER in .env} + POSTGRES_DB: ${DB_NAME:?Set DB_NAME in .env} + POSTGRES_PASSWORD_FILE: ${POSTGRES_PASSWORD_FILE:?Set POSTGRES_PASSWORD_FILE in .env} + secrets: + - source: db_password + target: ${POSTGRES_PASSWORD_FILE:?Set POSTGRES_PASSWORD_FILE in .env} + volumes: + - pgdata:/var/lib/postgresql/data + healthcheck: + test: ["CMD-SHELL", "pg_isready -U $${POSTGRES_USER} -d $${POSTGRES_DB}"] + interval: 3s + timeout: 3s + retries: 10 + deploy: + resources: + limits: + cpus: "1.0" + memory: 512M + + redis: + image: redis:7.4.2-bookworm + restart: unless-stopped + entrypoint: ["/bin/sh", "/usr/local/bin/start-redis.sh"] + secrets: + - redis_password + volumes: + - ./infra/redis/redis.conf:/usr/local/etc/redis/redis.conf:ro + - ./infra/redis/start-redis.sh:/usr/local/bin/start-redis.sh:ro + - redisdata:/data + healthcheck: + test: ["CMD-SHELL", "REDISCLI_AUTH=\"$$(cat /run/secrets/redis_password)\" redis-cli ping"] + interval: 3s + timeout: 3s + retries: 10 + deploy: + resources: + limits: + cpus: "0.5" + memory: 512M + + broker: + image: rabbitmq:4.4.0 + hostname: broker + restart: unless-stopped + entrypoint: ["/bin/sh", "/usr/local/bin/start-broker.sh"] + environment: + BROKER_PORT: ${BROKER_PORT:?Set BROKER_PORT in .env} + BROKER_USER: ${BROKER_USER:?Set BROKER_USER in .env} + BROKER_VHOST: ${BROKER_VHOST:?Set BROKER_VHOST in .env} + BROKER_PASSWORD_FILE: ${BROKER_PASSWORD_FILE:?Set BROKER_PASSWORD_FILE in .env} + secrets: + - source: broker_password + target: ${BROKER_PASSWORD_FILE:?Set BROKER_PASSWORD_FILE in .env} + volumes: + - ./infra/broker/start-broker.sh:/usr/local/bin/start-broker.sh:ro + - rabbitmqdata:/var/lib/rabbitmq + healthcheck: + test: ["CMD", "rabbitmq-diagnostics", "-q", "ping"] + interval: 5s + timeout: 5s + retries: 20 + start_period: 20s + deploy: + resources: + limits: + cpus: "1.0" + memory: 768M + + publisher: + <<: *api-image + init: true + command: ["python", "-m", "app.core.outbox_publisher"] + restart: unless-stopped + environment: + <<: [*base-env, *jobs-env] + secrets: + - db_password + - source: broker_password + target: ${BROKER_PASSWORD_FILE:?Set BROKER_PASSWORD_FILE in .env} + depends_on: + postgres: + condition: service_healthy + broker: + condition: service_healthy + migrate: + condition: service_completed_successfully + healthcheck: + disable: true + stop_grace_period: 15s + deploy: + resources: + limits: + cpus: "0.5" + memory: 256M + + worker: + <<: *api-image + init: true + command: ["python", "-m", "app.core.job_worker"] + restart: unless-stopped + environment: + <<: [*base-env, *s3-env, *jobs-env] + secrets: + - db_password + - source: broker_password + target: ${BROKER_PASSWORD_FILE:?Set BROKER_PASSWORD_FILE in .env} + - source: s3_access_key_id + target: ${S3_ACCESS_KEY_ID_FILE:?Set S3_ACCESS_KEY_ID_FILE in .env} + - source: s3_secret_access_key + target: ${S3_SECRET_ACCESS_KEY_FILE:?Set S3_SECRET_ACCESS_KEY_FILE in .env} + networks: [default, objects] + tmpfs: + - /tmp:rw,noexec,nosuid,size=128m,mode=1777 + depends_on: + postgres: + condition: service_healthy + broker: + condition: service_healthy + minio: + condition: service_healthy + minio-bootstrap: + condition: service_completed_successfully + migrate: + condition: service_completed_successfully + healthcheck: + disable: true + stop_signal: SIGTERM + stop_grace_period: 20s + deploy: + resources: + limits: + cpus: "2.0" + memory: 2048M + + migrate: + <<: *api-image + command: ["alembic", "upgrade", "head"] + environment: *base-env + secrets: + - db_password + depends_on: + postgres: + condition: service_healthy + restart: "no" + healthcheck: + disable: true + deploy: + resources: + limits: + cpus: "0.5" + memory: 256M + + api: + <<: *api-image + restart: unless-stopped + environment: + <<: [*base-env, *s3-env] + REDIS_HOST: ${REDIS_HOST:?Set REDIS_HOST in .env} + REDIS_PORT: ${REDIS_PORT:?Set REDIS_PORT in .env} + REDIS_DB: ${REDIS_DB:?Set REDIS_DB in .env} + REDIS_MAX_CONNECTIONS: ${REDIS_MAX_CONNECTIONS:?Set REDIS_MAX_CONNECTIONS in .env} + REDIS_POOL_TIMEOUT_SECONDS: ${REDIS_POOL_TIMEOUT_SECONDS:?Set REDIS_POOL_TIMEOUT_SECONDS in .env} + REDIS_CONNECT_TIMEOUT_SECONDS: ${REDIS_CONNECT_TIMEOUT_SECONDS:?Set REDIS_CONNECT_TIMEOUT_SECONDS in .env} + REDIS_SOCKET_TIMEOUT_SECONDS: ${REDIS_SOCKET_TIMEOUT_SECONDS:?Set REDIS_SOCKET_TIMEOUT_SECONDS in .env} + SESSION_STORE: ${SESSION_STORE:?Set SESSION_STORE in .env} + SESSION_TTL_SECONDS: ${SESSION_TTL_SECONDS:?Set SESSION_TTL_SECONDS in .env} + IDEMPOTENCY_TTL_SECONDS: ${IDEMPOTENCY_TTL_SECONDS:?Set IDEMPOTENCY_TTL_SECONDS in .env} + secrets: + - db_password + - redis_password + - source: s3_access_key_id + target: ${S3_ACCESS_KEY_ID_FILE:?Set S3_ACCESS_KEY_ID_FILE in .env} + - source: s3_secret_access_key + target: ${S3_SECRET_ACCESS_KEY_FILE:?Set S3_SECRET_ACCESS_KEY_FILE in .env} + networks: [default, objects] + tmpfs: + - /tmp:rw,noexec,nosuid,size=64m,mode=1777 + deploy: + replicas: ${API_REPLICAS:?Set API_REPLICAS in .env} + resources: + limits: + cpus: "1.0" + memory: 1536M + healthcheck: + test: ["CMD", "python", "-c", "import os, urllib.request; urllib.request.urlopen('http://127.0.0.1:' + os.environ['APP_PORT'] + '/health/ready', timeout=2.5)"] + interval: 3s + timeout: 3s + start_period: 10s + retries: 2 + stop_signal: SIGTERM + stop_grace_period: 8s + depends_on: + minio: + condition: service_healthy + minio-bootstrap: + condition: service_completed_successfully + postgres: + condition: service_healthy + redis: + condition: service_healthy + migrate: + condition: service_completed_successfully + + cleanup: + <<: *api-image + command: ["python", "-m", "app.core.cleanup", "--apply"] + restart: unless-stopped + environment: + <<: [*base-env, *s3-env] + FAILED_STAGING_RETENTION_SECONDS: ${FAILED_STAGING_RETENTION_SECONDS:?Set FAILED_STAGING_RETENTION_SECONDS in .env} + STAGING_RETENTION_SECONDS: ${STAGING_RETENTION_SECONDS:?Set STAGING_RETENTION_SECONDS in .env} + secrets: + - db_password + - source: s3_access_key_id + target: ${S3_ACCESS_KEY_ID_FILE:?Set S3_ACCESS_KEY_ID_FILE in .env} + - source: s3_secret_access_key + target: ${S3_SECRET_ACCESS_KEY_FILE:?Set S3_SECRET_ACCESS_KEY_FILE in .env} + networks: [default, objects] + healthcheck: + disable: true + depends_on: + migrate: + condition: service_completed_successfully + minio-bootstrap: + condition: service_completed_successfully + deploy: + resources: + limits: + cpus: "0.25" + memory: 256M + + nginx: + image: nginx:1.28.0-alpine + restart: unless-stopped + volumes: + - ./infra/nginx/nginx.conf:/etc/nginx/nginx.conf:ro + ports: + - "127.0.0.1:${LB_HOST_PORT:?Set LB_HOST_PORT in .env}:8080" + healthcheck: + test: ["CMD", "wget", "-q", "-O", "/dev/null", "http://127.0.0.1:8080/lb-health"] + interval: 5s + timeout: 3s + retries: 5 + depends_on: + api: + condition: service_healthy + deploy: + resources: + limits: + cpus: "0.5" + memory: 128M + +volumes: + pgdata: + redisdata: + miniodata: + rabbitmqdata: + +networks: + default: + objects: + internal: true + +secrets: + broker_password: + file: ./secrets/broker_password + db_password: + file: ./secrets/db_password + redis_password: + file: ./secrets/redis_password + minio_root_user: + file: ./secrets/minio_root_user + minio_root_password: + file: ./secrets/minio_root_password + s3_access_key_id: + file: ./secrets/s3_access_key_id + s3_secret_access_key: + file: ./secrets/s3_secret_access_key diff --git a/infra/broker/start-broker.sh b/infra/broker/start-broker.sh new file mode 100755 index 0000000..8efdf06 --- /dev/null +++ b/infra/broker/start-broker.sh @@ -0,0 +1,8 @@ +#!/bin/sh +set -eu +# Secret читается внутри контейнера, не попадает в compose config/аргументы. +export RABBITMQ_DEFAULT_PASS="$(cat "${BROKER_PASSWORD_FILE:?}")" +export RABBITMQ_DEFAULT_USER="${BROKER_USER:?}" +export RABBITMQ_DEFAULT_VHOST="${BROKER_VHOST:?}" +export RABBITMQ_NODE_PORT="${BROKER_PORT:?}" +exec /usr/local/bin/docker-entrypoint.sh rabbitmq-server diff --git a/infra/minio/Dockerfile b/infra/minio/Dockerfile new file mode 100644 index 0000000..fd7cc06 --- /dev/null +++ b/infra/minio/Dockerfile @@ -0,0 +1,22 @@ +FROM golang:1.24.8-bookworm AS compiler +ENV CGO_ENABLED=0 GOTOOLCHAIN=local GOBIN=/out GOMAXPROCS=4 +RUN --mount=type=cache,target=/go/pkg/mod --mount=type=cache,target=/root/.cache/go-build \ + go install -p 4 -ldflags='-s -w -X github.com/minio/minio/cmd.Version=RELEASE.2025-10-15T17-29-55Z -X github.com/minio/minio/cmd.ReleaseTag=RELEASE.2025-10-15T17-29-55Z' github.com/minio/minio@RELEASE.2025-10-15T17-29-55Z +RUN --mount=type=cache,target=/go/pkg/mod --mount=type=cache,target=/root/.cache/go-build \ + go install -p 4 -ldflags='-s -w' github.com/minio/mc@RELEASE.2025-08-13T08-35-41Z + +FROM python:3.12.15-slim-bookworm AS runtime +RUN useradd --system --uid 10001 --no-create-home minio && mkdir /data && chown minio /data +USER minio + +FROM runtime AS server +COPY --from=compiler /out/minio /usr/local/bin/minio +LABEL org.opencontainers.image.source="https://github.com/minio/minio" \ + org.opencontainers.image.version="RELEASE.2025-10-15T17-29-55Z" +VOLUME ["/data"] +ENTRYPOINT ["/usr/local/bin/minio"] + +FROM runtime AS bootstrap +COPY --from=compiler /out/mc /usr/local/bin/mc +COPY infra/minio/bootstrap.py /bootstrap.py +ENTRYPOINT ["python", "/bootstrap.py"] diff --git a/infra/minio/bootstrap.py b/infra/minio/bootstrap.py new file mode 100644 index 0000000..b8f399f --- /dev/null +++ b/infra/minio/bootstrap.py @@ -0,0 +1,120 @@ +"""Идемпотентный private bucket и отдельная ограниченная учётная запись API.""" + +import json +import os +from pathlib import Path +import subprocess +from tempfile import TemporaryDirectory +import time +from urllib.request import urlopen + + +def secret(name): + value = Path(os.environ[name.upper() + "_FILE"]).read_text().strip() + if not value: + raise ValueError("Пустой файл секрета") + return value + + +def main(): + endpoint = os.environ["S3_ENDPOINT"] + bucket = os.environ["S3_BUCKET"] + root_user, root_password = secret("minio_root_user"), secret("minio_root_password") + access, password = secret("s3_access_key_id"), secret("s3_secret_access_key") + if access == root_user: + raise ValueError("API не должен использовать root credentials") + deadline = time.monotonic() + 60 + while True: + try: + with urlopen(endpoint + "/minio/health/ready", timeout=2) as response: + if response.status == 200: + break + except OSError: + pass + if time.monotonic() >= deadline: + raise RuntimeError("MinIO не готов за 60 секунд") + time.sleep(1) + with TemporaryDirectory(prefix="minio-bootstrap-") as directory: + config = Path(directory) + # Credentials не передаются mc alias set через аргументы или окружение. + config_file = config / "config.json" + config_file.write_text( + json.dumps( + { + "version": "10", + "aliases": { + "storage": { + "url": endpoint, + "accessKey": root_user, + "secretKey": root_password, + "api": "S3v4", + "path": "auto", + } + }, + } + ) + ) + config_file.chmod(0o600) + + def mc(*args): + result = subprocess.run( + ["mc", "--config-dir", directory, *args], + stdout=subprocess.DEVNULL, + stderr=subprocess.DEVNULL, + timeout=30, + ) + if result.returncode: + raise RuntimeError( + "Ошибка bootstrap MinIO; значения credentials скрыты" + ) + + mc("mb", "--ignore-existing", "storage/" + bucket) + mc("anonymous", "set", "none", "storage/" + bucket) + policy = { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Action": ["s3:GetBucketLocation", "s3:ListBucket"], + "Resource": [f"arn:aws:s3:::{bucket}"], + }, + { + "Effect": "Allow", + "Action": ["s3:GetObject", "s3:PutObject", "s3:DeleteObject"], + "Resource": [ + f"arn:aws:s3:::{bucket}/{prefix}/*" + for prefix in ("originals", "staging", "variants") + ], + }, + ], + } + policy_file = config / "policy.json" + policy_file.write_text(json.dumps(policy)) + mc( + "admin", + "policy", + "create", + "storage", + "messenger-attachments", + str(policy_file), + ) + # mc не поддерживает stdin для user add: вывод и ошибки команды скрыты. + mc("admin", "user", "add", "storage", access, password) + mc( + "admin", + "policy", + "attach", + "storage", + "messenger-attachments", + "--user", + access, + ) + print("MinIO private bucket and API policy configured", flush=True) + + +if __name__ == "__main__": + try: + main() + except Exception as error: + print("MinIO bootstrap failed: " + type(error).__name__, flush=True) + raise SystemExit(1) from None diff --git a/infra/nginx/nginx.conf b/infra/nginx/nginx.conf new file mode 100644 index 0000000..0d62297 --- /dev/null +++ b/infra/nginx/nginx.conf @@ -0,0 +1,140 @@ +# Единая точка входа: round-robin между API-репликами, без sticky sessions. +# Директивы рассчитаны на закреплённый nginx:1.28.0-alpine. + +worker_processes 2; + +events { + worker_connections 1024; +} + +http { + # В логе используем request_id ответа API, для собственных ошибок — id nginx. + map $upstream_http_x_request_id $response_request_id { + "" $request_id; + default $upstream_http_x_request_id; + } + + log_format requests escape=json + '{"time":"$time_iso8601","request_id":"$response_request_id",' + '"method":"$request_method","uri":"$uri","status":$status,' + '"bytes":$body_bytes_sent,"request_time":$request_time,' + '"upstream":"$upstream_addr","upstream_status":"$upstream_status",' + '"upstream_time":"$upstream_response_time",' + '"instance_id":"$upstream_http_x_instance_id",' + '"limit_status":"$limit_req_status"}'; + + access_log /dev/stdout requests; + error_log /dev/stderr warn; + server_tokens off; + + # DNS Docker возвращает адреса всех реплик сервиса api. + resolver 127.0.0.11 valid=5s ipv6=off; + resolver_timeout 1s; + + # Общий для worker-процессов лимит на IP, который видит nginx. + # Клиентский X-Forwarded-For не используется в качестве ключа лимита. + limit_req_zone $binary_remote_addr zone=per_client:10m rate=50r/s; + + gzip on; + gzip_vary on; + gzip_min_length 1024; + gzip_comp_level 3; + gzip_types application/json; + + upstream api_backend { + zone api_backend 64k; + server api:8080 resolve max_fails=1 fail_timeout=5s; + + # Кэш свободных соединений на worker, а не лимит запросов к API. + keepalive 16; + keepalive_timeout 4s; + } + + server { + listen 8080; + + client_header_timeout 10s; + client_body_timeout 10s; + # Размер ограничивает API при чтении, включая chunked-передачу. + client_max_body_size 0; + client_body_buffer_size 64k; + send_timeout 10s; + keepalive_timeout 30s; + + proxy_http_version 1.1; + proxy_set_header Connection ""; + proxy_set_header Host $host; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + + proxy_connect_timeout 500ms; + proxy_send_timeout 10s; + proxy_read_timeout 10s; + + # Пассивное обнаружение отказов; Docker healthcheck сам не управляет LB. + # non_idempotent не включён: уже отправленные POST не повторяем. + proxy_next_upstream error timeout http_502 http_503 http_504; + proxy_next_upstream_tries 2; + # Окно перехода на другой backend, не общий deadline ответа. + proxy_next_upstream_timeout 2s; + + # JSON и заголовки ошибок API передаются без подмены. + proxy_intercept_errors off; + error_page 429 = @rate_limited; + error_page 502 503 504 = @unavailable; + + # Проверка самого LB для healthcheck в compose; не проксируется в API. + location = /lb-health { + access_log off; + default_type text/plain; + return 200 "ok\n"; + } + + # Проверки готовности/жизни не расходуют бюджет бизнес-запросов. + location /health/ { + proxy_pass http://api_backend; + } + + location / { + limit_req zone=per_client burst=100 nodelay; + limit_req_status 429; + limit_req_log_level warn; + proxy_pass http://api_backend; + } + + location ~ ^/api/v1/chats/[^/]+/attachments$ { + limit_req zone=per_client burst=100 nodelay; + limit_req_status 429; + proxy_request_buffering off; + proxy_buffering off; + proxy_read_timeout 65s; + proxy_send_timeout 15s; + # Ошибка одного upload не должна скрыть работающую реплику для чатов. + proxy_next_upstream off; + proxy_pass http://api_backend; + } + + location ~ ^/api/v1/attachments/[^/]+/content$ { + limit_req zone=per_client burst=100 nodelay; + limit_req_status 429; + proxy_buffering off; + proxy_read_timeout 65s; + proxy_pass http://api_backend; + } + + # Это ответы балансировщика: X-Instance-Id реплики у них отсутствует. + location @rate_limited { + default_type application/json; + add_header X-Request-Id $request_id always; + add_header Retry-After 1 always; + return 429 '{"error":{"code":"rate_limited","message":"Request rate exceeded","request_id":"$request_id"}}'; + } + + location @unavailable { + default_type application/json; + add_header X-Request-Id $request_id always; + add_header Retry-After 1 always; + return 503 '{"error":{"code":"unavailable","message":"API temporarily unavailable","request_id":"$request_id"}}'; + } + } +} diff --git a/infra/redis/redis.conf b/infra/redis/redis.conf new file mode 100644 index 0000000..f2ae982 --- /dev/null +++ b/infra/redis/redis.conf @@ -0,0 +1,5 @@ +dir /data +appendonly yes +appendfsync always +maxmemory 256mb +maxmemory-policy noeviction diff --git a/infra/redis/start-redis.sh b/infra/redis/start-redis.sh new file mode 100644 index 0000000..49ee706 --- /dev/null +++ b/infra/redis/start-redis.sh @@ -0,0 +1,10 @@ +#!/bin/sh +set -eu + +password_hash=$(tr -d '\r\n' /run/redis/users.acl +chown redis:redis /run/redis/users.acl +chmod 600 /run/redis/users.acl +exec /usr/local/bin/docker-entrypoint.sh redis-server /usr/local/etc/redis/redis.conf --aclfile /run/redis/users.acl diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 0000000..d914a27 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,68 @@ +import asyncio +from logging.config import fileConfig + +from alembic import context +from sqlalchemy import pool +from sqlalchemy.engine import Connection +from sqlalchemy.ext.asyncio import async_engine_from_config + +from app.core.config import Settings +from app.models import Base + +config = context.config + +if config.config_file_name is not None: + fileConfig(config.config_file_name, disable_existing_loggers=False) + +target_metadata = Base.metadata + + +def _database_url() -> str: + explicit = config.get_main_option("sqlalchemy.url") + if explicit: + return explicit + return Settings().get_database_url() # type: ignore + + +def run_migrations_offline() -> None: + context.configure( + url=_database_url(), + target_metadata=target_metadata, + literal_binds=True, + compare_type=True, + ) + with context.begin_transaction(): + context.run_migrations() + + +def do_run_migrations(connection: Connection) -> None: + context.configure( + connection=connection, + target_metadata=target_metadata, + compare_type=True, + ) + with context.begin_transaction(): + context.run_migrations() + + +async def run_async_migrations() -> None: + section = config.get_section(config.config_ini_section, {}) + section["sqlalchemy.url"] = _database_url().replace("%", "%%") + connectable = async_engine_from_config( + section, prefix="sqlalchemy.", poolclass=pool.NullPool + ) + + async with connectable.connect() as connection: + await connection.run_sync(do_run_migrations) + + await connectable.dispose() + + +def run_migrations_online() -> None: + asyncio.run(run_async_migrations()) + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/migrations/script.py.mako b/migrations/script.py.mako new file mode 100644 index 0000000..17dcba0 --- /dev/null +++ b/migrations/script.py.mako @@ -0,0 +1,25 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +revision: str = ${repr(up_revision)} +down_revision: Union[str, None] = ${repr(down_revision)} +branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)} +depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)} + + +def upgrade() -> None: + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + ${downgrades if downgrades else "pass"} diff --git a/migrations/versions/.gitkeep b/migrations/versions/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/migrations/versions/49d2c947a3f1_add_idempotency_keys.py b/migrations/versions/49d2c947a3f1_add_idempotency_keys.py new file mode 100644 index 0000000..153425e --- /dev/null +++ b/migrations/versions/49d2c947a3f1_add_idempotency_keys.py @@ -0,0 +1,48 @@ +"""Добавляет результаты идемпотентных запросов.""" + +from alembic import op +import sqlalchemy as sa + +revision = "49d2c947a3f1" +down_revision = "abd273076068" +branch_labels = None +depends_on = None + + +def upgrade() -> None: + """Создаёт таблицу ключей без изменения существующих данных.""" + op.create_table( + "idempotency_keys", + sa.Column("user_id", sa.UUID(), nullable=False), + sa.Column("method", sa.String(8), nullable=False), + sa.Column("path", sa.String(255), nullable=False), + sa.Column("key", sa.String(128), nullable=False), + sa.Column("request_hash", sa.String(64), nullable=False), + sa.Column("message_id", sa.UUID(), nullable=False), + sa.Column( + "created_at", + sa.DateTime(timezone=True), + server_default=sa.text("clock_timestamp()"), + nullable=False, + ), + sa.ForeignKeyConstraint( + ["user_id"], ["users.id"], name=op.f("fk_idempotency_keys_user_id_users") + ), + sa.ForeignKeyConstraint( + ["message_id"], + ["messages.id"], + name=op.f("fk_idempotency_keys_message_id_messages"), + ), + sa.PrimaryKeyConstraint( + "user_id", "method", "path", "key", name=op.f("pk_idempotency_keys") + ), + ) + op.create_index( + "ix_idempotency_keys_created_at", "idempotency_keys", ["created_at"] + ) + + +def downgrade() -> None: + """Удаляет таблицу результатов запросов.""" + op.drop_index("ix_idempotency_keys_created_at", table_name="idempotency_keys") + op.drop_table("idempotency_keys") diff --git a/migrations/versions/8f31b94a2d10_add_attachments.py b/migrations/versions/8f31b94a2d10_add_attachments.py new file mode 100644 index 0000000..34d3a6d --- /dev/null +++ b/migrations/versions/8f31b94a2d10_add_attachments.py @@ -0,0 +1,98 @@ +"""Attachment, связи сообщений и устойчивый журнал загрузок.""" + +from alembic import op +import sqlalchemy as sa + +revision = "8f31b94a2d10" +down_revision = "49d2c947a3f1" +branch_labels = None +depends_on = None + + +def upgrade() -> None: + op.create_table( + "attachments", + sa.Column("id", sa.UUID(), nullable=False), + sa.Column("chat_id", sa.UUID(), nullable=False), + sa.Column("owner_id", sa.UUID(), nullable=False), + sa.Column("object_key", sa.String(128), nullable=False), + sa.Column("filename", sa.String(255), nullable=False), + sa.Column("content_type", sa.String(32), nullable=False), + sa.Column("size_bytes", sa.Integer(), nullable=False), + sa.Column("sha256", sa.String(64), nullable=False), + sa.Column("status", sa.String(16), server_default="ready", nullable=False), + sa.Column( + "created_at", + sa.DateTime(timezone=True), + server_default=sa.text("clock_timestamp()"), + nullable=False, + ), + sa.Column( + "updated_at", + sa.DateTime(timezone=True), + server_default=sa.text("clock_timestamp()"), + nullable=False, + ), + sa.CheckConstraint( + "size_bytes BETWEEN 1 AND 10485760", name=op.f("ck_attachments_size_bytes") + ), + sa.CheckConstraint( + "content_type IN ('image/png', 'image/jpeg')", + name=op.f("ck_attachments_content_type"), + ), + sa.CheckConstraint( + "sha256 ~ '^[a-f0-9]{64}$'", name=op.f("ck_attachments_sha256") + ), + sa.CheckConstraint("status = 'ready'", name=op.f("ck_attachments_status")), + sa.ForeignKeyConstraint( + ["chat_id"], ["chats.id"], name=op.f("fk_attachments_chat_id_chats") + ), + sa.ForeignKeyConstraint( + ["owner_id"], ["users.id"], name=op.f("fk_attachments_owner_id_users") + ), + sa.PrimaryKeyConstraint("id", name=op.f("pk_attachments")), + sa.UniqueConstraint("object_key", name=op.f("uq_attachments_object_key")), + ) + op.create_index("ix_attachments_chat_id", "attachments", ["chat_id"]) + op.create_table( + "message_attachments", + sa.Column("message_id", sa.UUID(), nullable=False), + sa.Column("attachment_id", sa.UUID(), nullable=False), + sa.Column("position", sa.Integer(), nullable=False), + sa.ForeignKeyConstraint( + ["message_id"], + ["messages.id"], + ondelete="CASCADE", + name=op.f("fk_message_attachments_message_id_messages"), + ), + sa.ForeignKeyConstraint( + ["attachment_id"], + ["attachments.id"], + name=op.f("fk_message_attachments_attachment_id_attachments"), + ), + sa.PrimaryKeyConstraint( + "message_id", "attachment_id", name=op.f("pk_message_attachments") + ), + ) + op.create_table( + "upload_intents", + sa.Column("id", sa.UUID(), nullable=False), + sa.Column("object_key", sa.String(128), nullable=False), + sa.Column( + "created_at", + sa.DateTime(timezone=True), + server_default=sa.text("clock_timestamp()"), + nullable=False, + ), + sa.PrimaryKeyConstraint("id", name=op.f("pk_upload_intents")), + sa.UniqueConstraint("object_key", name=op.f("uq_upload_intents_object_key")), + ) + op.create_index("ix_upload_intents_created_at", "upload_intents", ["created_at"]) + + +def downgrade() -> None: + op.drop_index("ix_upload_intents_created_at", table_name="upload_intents") + op.drop_table("upload_intents") + op.drop_table("message_attachments") + op.drop_index("ix_attachments_chat_id", table_name="attachments") + op.drop_table("attachments") diff --git a/migrations/versions/a62c950e18b3_rabbitmq_cutover.py b/migrations/versions/a62c950e18b3_rabbitmq_cutover.py new file mode 100644 index 0000000..3eb0cd8 --- /dev/null +++ b/migrations/versions/a62c950e18b3_rabbitmq_cutover.py @@ -0,0 +1,21 @@ +"""Offline cutover: повторно опубликовать queued jobs в RabbitMQ.""" + +from alembic import op + +revision = "a62c950e18b3" +down_revision = "f9183d27a640" +branch_labels = None +depends_on = None + + +def upgrade() -> None: + # Старые publisher/worker остановлены. Processing восстановится по lease. + op.execute(""" + UPDATE attachment_jobs j SET published_attempt = attempt + FROM attachments a WHERE a.id = j.attachment_id AND a.status = 'queued' + """) + + +def downgrade() -> None: + # При обратном переключении требуется такая же повторная публикация. + upgrade() diff --git a/migrations/versions/abd273076068_add_counters.py b/migrations/versions/abd273076068_add_counters.py new file mode 100644 index 0000000..cb6e08c --- /dev/null +++ b/migrations/versions/abd273076068_add_counters.py @@ -0,0 +1,34 @@ +"""add counters + +Revision ID: abd273076068 +Revises: db06fd3126ff +Create Date: 2026-10-26 22:01:01.910396 + +""" + +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa + +revision: str = "abd273076068" +down_revision: Union[str, None] = "db06fd3126ff" +branch_labels: Union[str, Sequence[str], None] = None +depends_on: Union[str, Sequence[str], None] = None + + +def upgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.create_table( + "counters", + sa.Column("name", sa.String(length=64), nullable=False), + sa.Column("value", sa.BigInteger(), nullable=False), + sa.PrimaryKeyConstraint("name", name=op.f("pk_counters")), + ) + # ### end Alembic commands ### + + +def downgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table("counters") + # ### end Alembic commands ### diff --git a/migrations/versions/c35e91a2f706_async_attachment_jobs.py b/migrations/versions/c35e91a2f706_async_attachment_jobs.py new file mode 100644 index 0000000..5d42ac5 --- /dev/null +++ b/migrations/versions/c35e91a2f706_async_attachment_jobs.py @@ -0,0 +1,113 @@ +"""Состояния, варианты и устойчивые jobs с намерением публикации.""" + +from alembic import op +import sqlalchemy as sa +from sqlalchemy.dialects import postgresql + +revision = "c35e91a2f706" +down_revision = "8f31b94a2d10" +branch_labels = None +depends_on = None + + +def upgrade() -> None: + op.drop_constraint(op.f("ck_attachments_status"), "attachments", type_="check") + op.create_check_constraint( + op.f("ck_attachments_status"), + "attachments", + "status IN ('queued', 'processing', 'ready', 'failed')", + ) + op.alter_column("attachments", "status", server_default="queued") + op.add_column("attachments", sa.Column("error_code", sa.String(64), nullable=True)) + op.add_column( + "attachments", sa.Column("thumbnail_key", sa.String(128), nullable=True) + ) + op.add_column( + "attachments", + sa.Column( + "variants", + postgresql.JSONB(), + nullable=False, + server_default=sa.text("'[]'::jsonb"), + ), + ) + op.create_check_constraint( + op.f("ck_attachments_error_code"), + "attachments", + "(status = 'failed' AND error_code IS NOT NULL) OR (status <> 'failed' AND error_code IS NULL)", + ) + op.create_table( + "attachment_jobs", + sa.Column("id", sa.UUID(), nullable=False), + sa.Column("attachment_id", sa.UUID(), nullable=False), + sa.Column("staging_key", sa.String(128), nullable=True), + sa.Column("pipeline_version", sa.Integer(), server_default="1", nullable=False), + sa.Column("attempt", sa.Integer(), server_default="0", nullable=False), + sa.Column( + "published_attempt", sa.Integer(), server_default="0", nullable=False + ), + sa.Column( + "next_attempt_at", + sa.DateTime(timezone=True), + server_default=sa.text("clock_timestamp()"), + nullable=False, + ), + sa.Column("lease_token", sa.UUID(), nullable=True), + sa.Column("lease_until", sa.DateTime(timezone=True), nullable=True), + sa.Column("last_error_code", sa.String(64), nullable=True), + sa.Column("finished_at", sa.DateTime(timezone=True), nullable=True), + sa.Column( + "created_at", + sa.DateTime(timezone=True), + server_default=sa.text("clock_timestamp()"), + nullable=False, + ), + sa.PrimaryKeyConstraint("id", name=op.f("pk_attachment_jobs")), + sa.ForeignKeyConstraint( + ["attachment_id"], + ["attachments.id"], + name=op.f("fk_attachment_jobs_attachment_id_attachments"), + ), + sa.UniqueConstraint( + "attachment_id", name=op.f("uq_attachment_jobs_attachment_id") + ), + sa.CheckConstraint( + "pipeline_version = 1", name=op.f("ck_attachment_jobs_pipeline_version") + ), + sa.CheckConstraint( + "attempt >= 0 AND published_attempt >= 0", + name=op.f("ck_attachment_jobs_attempt"), + ), + ) + op.create_index("ix_attachment_jobs_due", "attachment_jobs", ["next_attempt_at"]) + op.create_index("ix_attachment_jobs_lease", "attachment_jobs", ["lease_until"]) + # Прежние оригиналы остаются источником; worker создаст отсутствующий thumbnail. + op.execute( + "INSERT INTO attachment_jobs (id, attachment_id, staging_key) SELECT id, id, object_key FROM attachments" + ) + op.execute( + "UPDATE attachments SET status = 'queued', updated_at = clock_timestamp()" + ) + + +def downgrade() -> None: + connection = op.get_bind() + unfinished = connection.scalar( + sa.text("SELECT count(*) FROM attachments WHERE status <> 'ready'") + ) + if unfinished: + raise RuntimeError( + "Перед downgrade нужно завершить или вручную разобрать все queued/processing/failed вложения" + ) + op.drop_index("ix_attachment_jobs_lease", table_name="attachment_jobs") + op.drop_index("ix_attachment_jobs_due", table_name="attachment_jobs") + op.drop_table("attachment_jobs") + op.drop_constraint(op.f("ck_attachments_error_code"), "attachments", type_="check") + op.drop_column("attachments", "variants") + op.drop_column("attachments", "thumbnail_key") + op.drop_column("attachments", "error_code") + op.drop_constraint(op.f("ck_attachments_status"), "attachments", type_="check") + op.create_check_constraint( + op.f("ck_attachments_status"), "attachments", "status = 'ready'" + ) + op.alter_column("attachments", "status", server_default="ready") diff --git a/migrations/versions/db06fd3126ff_create_initial_schema.py b/migrations/versions/db06fd3126ff_create_initial_schema.py new file mode 100644 index 0000000..eec6e51 --- /dev/null +++ b/migrations/versions/db06fd3126ff_create_initial_schema.py @@ -0,0 +1,107 @@ +"""create initial schema + +Revision ID: db06fd3126ff +Revises: +Create Date: 2026-10-26 17:09:16.675339 + +""" + +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa + +revision: str = "db06fd3126ff" +down_revision: Union[str, None] = None +branch_labels: Union[str, Sequence[str], None] = None +depends_on: Union[str, Sequence[str], None] = None + + +def upgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.create_table( + "chats", + sa.Column("id", sa.UUID(), nullable=False), + sa.Column("title", sa.String(length=100), nullable=False), + sa.Column( + "created_at", + sa.DateTime(timezone=True), + server_default=sa.text("now()"), + nullable=False, + ), + sa.PrimaryKeyConstraint("id", name=op.f("pk_chats")), + ) + op.create_table( + "users", + sa.Column("id", sa.UUID(), nullable=False), + sa.Column("username", sa.String(length=32), nullable=False), + sa.Column("display_name", sa.String(length=100), nullable=False), + sa.Column("password_hash", sa.String(length=255), nullable=False), + sa.Column( + "created_at", + sa.DateTime(timezone=True), + server_default=sa.text("now()"), + nullable=False, + ), + sa.PrimaryKeyConstraint("id", name=op.f("pk_users")), + sa.UniqueConstraint("username", name=op.f("uq_users_username")), + ) + op.create_table( + "chat_members", + sa.Column("chat_id", sa.UUID(), nullable=False), + sa.Column("user_id", sa.UUID(), nullable=False), + sa.ForeignKeyConstraint( + ["chat_id"], + ["chats.id"], + name=op.f("fk_chat_members_chat_id_chats"), + ondelete="CASCADE", + ), + sa.ForeignKeyConstraint( + ["user_id"], ["users.id"], name=op.f("fk_chat_members_user_id_users") + ), + sa.PrimaryKeyConstraint("chat_id", "user_id", name=op.f("pk_chat_members")), + ) + op.create_index( + "ix_chat_members_user_id_chat_id", + "chat_members", + ["user_id", "chat_id"], + unique=False, + ) + op.create_table( + "messages", + sa.Column("id", sa.UUID(), nullable=False), + sa.Column("chat_id", sa.UUID(), nullable=False), + sa.Column("sender_id", sa.UUID(), nullable=False), + sa.Column("text", sa.Text(), nullable=False), + sa.Column( + "created_at", + sa.DateTime(timezone=True), + server_default=sa.text("clock_timestamp()"), + nullable=False, + ), + sa.ForeignKeyConstraint( + ["chat_id"], ["chats.id"], name=op.f("fk_messages_chat_id_chats") + ), + sa.ForeignKeyConstraint( + ["sender_id"], ["users.id"], name=op.f("fk_messages_sender_id_users") + ), + sa.PrimaryKeyConstraint("id", name=op.f("pk_messages")), + ) + op.create_index( + "ix_messages_chat_id_created_at_id", + "messages", + ["chat_id", "created_at", "id"], + unique=False, + ) + # ### end Alembic commands ### + + +def downgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.drop_index("ix_messages_chat_id_created_at_id", table_name="messages") + op.drop_table("messages") + op.drop_index("ix_chat_members_user_id_chat_id", table_name="chat_members") + op.drop_table("chat_members") + op.drop_table("users") + op.drop_table("chats") + # ### end Alembic commands ### diff --git a/migrations/versions/e7048b6da913_attachment_crop_webp.py b/migrations/versions/e7048b6da913_attachment_crop_webp.py new file mode 100644 index 0000000..b02f44f --- /dev/null +++ b/migrations/versions/e7048b6da913_attachment_crop_webp.py @@ -0,0 +1,55 @@ +"""Ключи crop/WebP и дообработка старых ready-вложений.""" + +from alembic import op +import sqlalchemy as sa + +revision = "e7048b6da913" +down_revision = "c35e91a2f706" +branch_labels = None +depends_on = None + + +def upgrade() -> None: + op.add_column("attachments", sa.Column("crop_key", sa.String(128), nullable=True)) + op.add_column( + "attachments", sa.Column("optimized_key", sa.String(128), nullable=True) + ) + # Старый staging сменяется надёжным ready-оригиналом, но не теряется из журнала cleanup. + op.execute(""" + INSERT INTO upload_intents (id, object_key) + SELECT gen_random_uuid(), j.staging_key + FROM attachment_jobs j JOIN attachments a ON a.id = j.attachment_id + WHERE a.status = 'ready' AND j.staging_key IS NOT NULL + AND j.staging_key <> a.object_key + ON CONFLICT (object_key) DO NOTHING + """) + op.execute(""" + UPDATE attachment_jobs j + SET staging_key = a.object_key, attempt = 0, published_attempt = 0, + next_attempt_at = clock_timestamp(), lease_token = NULL, lease_until = NULL, + last_error_code = NULL, finished_at = NULL + FROM attachments a + WHERE a.id = j.attachment_id AND a.status = 'ready' + """) + op.execute(""" + UPDATE attachments SET status = 'queued', variants = '[]'::jsonb, + updated_at = clock_timestamp() + WHERE status = 'ready' + """) + + +def downgrade() -> None: + active = op.get_bind().scalar( + sa.text( + "SELECT count(*) FROM attachments WHERE status IN ('queued', 'processing')" + ) + ) + if active: + raise RuntimeError("Перед downgrade необходимо завершить активные задания") + op.execute(""" + UPDATE attachments a SET variants = COALESCE( + (SELECT jsonb_agg(v) FROM jsonb_array_elements(a.variants) v + WHERE v->>'name' = 'thumbnail'), '[]'::jsonb) + """) + op.drop_column("attachments", "optimized_key") + op.drop_column("attachments", "crop_key") diff --git a/migrations/versions/f9183d27a640_job_replay.py b/migrations/versions/f9183d27a640_job_replay.py new file mode 100644 index 0000000..0c495fb --- /dev/null +++ b/migrations/versions/f9183d27a640_job_replay.py @@ -0,0 +1,51 @@ +"""Бюджет повторов и аудит операторского replay.""" + +from alembic import op +import sqlalchemy as sa + +revision = "f9183d27a640" +down_revision = "e7048b6da913" +branch_labels = None +depends_on = None + + +def upgrade() -> None: + op.add_column( + "attachment_jobs", + sa.Column( + "cycle_start_attempt", sa.Integer(), nullable=False, server_default="0" + ), + ) + op.add_column( + "attachment_jobs", sa.Column("attempt_limit", sa.Integer(), nullable=True) + ) + op.add_column( + "attachment_jobs", + sa.Column("last_error_permanent", sa.Boolean(), nullable=True), + ) + op.create_table( + "job_replays", + sa.Column("id", sa.Uuid(), primary_key=True), + sa.Column( + "job_id", sa.Uuid(), sa.ForeignKey("attachment_jobs.id"), nullable=False + ), + sa.Column("actor", sa.String(64), nullable=False), + sa.Column("reason", sa.String(32), nullable=False), + sa.Column("previous_attempt", sa.Integer(), nullable=False), + sa.Column("attempt_limit", sa.Integer(), nullable=False), + sa.Column("previous_error_code", sa.String(64), nullable=True), + sa.Column( + "created_at", + sa.DateTime(timezone=True), + nullable=False, + server_default=sa.func.clock_timestamp(), + ), + ) + op.create_index("ix_job_replays_job_id", "job_replays", ["job_id"]) + + +def downgrade() -> None: + op.drop_table("job_replays") + op.drop_column("attachment_jobs", "last_error_permanent") + op.drop_column("attachment_jobs", "attempt_limit") + op.drop_column("attachment_jobs", "cycle_start_attempt") diff --git a/pytest.ini b/pytest.ini new file mode 100644 index 0000000..b7dd8fa --- /dev/null +++ b/pytest.ini @@ -0,0 +1,6 @@ +[pytest] +testpaths = student-tests +python_files = test_*.py +asyncio_mode = auto +asyncio_default_fixture_loop_scope = session +asyncio_default_test_loop_scope = session diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..a3f67b5 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,53 @@ +alembic==1.20.0 +annotated-doc==0.0.5 +annotated-types==0.8.0 +anyio==4.15.1 +attrs==26.1.0 +certifi==2026.7.22 +charset-normalizer==3.5.2 +click==8.5.0 +fastapi==0.143.3 +h11==0.16.0 +httpcore2==2.13.1 +httpx2==2.13.1 +idna==3.20 +iniconfig==2.3.1 +jsonschema==4.26.0 +jsonschema-path==0.3.4 +jsonschema-specifications==2025.9.1 +lazy-object-proxy==1.12.0 +Mako==1.4.3 +MarkupSafe==3.0.4 +openapi-schema-validator==0.6.3 +openapi-spec-validator==0.7.2 +opentelemetry-api==1.45.1 +packaging==26.3 +pathable==0.4.4 +pluggy==1.7.0 +pydantic==2.14.1 +pydantic_core==2.50.1 +Pygments==2.21.0 +pytest==9.1.1 +PyYAML==6.0.3 +referencing==0.36.2 +requests==2.34.2 +rfc3339-validator==0.1.4 +rpds-py==2026.9.1 +six==1.17.0 +SQLAlchemy==2.1.4 +starlette==1.8.0 +truststore==0.10.5 +typing-inspection==0.4.4 +typing_extensions==4.16.0 +urllib3==2.8.0 +uvicorn==0.54.0 +asyncpg==0.32.0 +argon2-cffi==25.1.0 +redis==8.1.0 +greenlet==3.5.6 +pydantic-settings==2.16.0 +pytest-asyncio==1.4.1 +httpx==0.28.1 +minio==7.2.20 +Pillow==13.0.0 +aio-pika==10.2.2 diff --git a/scripts/__init__.py b/scripts/__init__.py new file mode 100644 index 0000000..592ea40 --- /dev/null +++ b/scripts/__init__.py @@ -0,0 +1 @@ +"""Команды управления учебным стендом.""" diff --git a/scripts/check_jobs.py b/scripts/check_jobs.py new file mode 100644 index 0000000..76519c5 --- /dev/null +++ b/scripts/check_jobs.py @@ -0,0 +1,429 @@ +"""Fault/recovery очереди на явно выбранном Compose-стенде; только синтетические данные.""" + +import argparse +from datetime import datetime +import hashlib +from io import BytesIO +import json +from pathlib import Path +import subprocess +import time +from uuid import UUID, uuid4 + +from PIL import Image + +from scripts.check_outbox_recovery import COMPOSE, ROOT, compose, require_compose +from scripts.deployment import ComposeProject +from tests.client import Client, check + +PROBE = """ +import asyncio, hashlib, json +from uuid import UUID +from sqlalchemy import select +from app.core.config import Settings +from app.core.database import create_db_engine, create_session_factory +from app.models.job import AttachmentJob +from app.models.attachment import Attachment +from app.storage.s3 import create_s3_storage +async def main(): + settings=Settings(); engine=create_db_engine(settings); storage=create_s3_storage(settings.s3) + try: + async with create_session_factory(engine)() as session: + job, att=(await session.execute(select(AttachmentJob,Attachment).join(Attachment,Attachment.id==AttachmentJob.attachment_id).where(Attachment.id==UUID(ATTACHMENT_ID)))).one() + result=dict(job_id=str(job.id),status=att.status,attempt=job.attempt,published_attempt=job.published_attempt,limit=job.attempt_limit,updated_at=att.updated_at,next_attempt_at=job.next_attempt_at,last_error_code=job.last_error_code,permanent=job.last_error_permanent) + objects=[] + for prefix in ('originals/'+UUID(ATTACHMENT_ID).hex+'/', 'variants/'+UUID(ATTACHMENT_ID).hex+'/'): + entries=await asyncio.to_thread(lambda: list(storage._client.list_objects(storage.settings.bucket,prefix=prefix,recursive=True))) + for obj in entries: + stream=await storage.open_object(obj.object_name); checksum=hashlib.sha256() + try: + async for chunk in stream: checksum.update(chunk) + finally: await stream.aclose() + objects.append(dict(name=obj.object_name.split('/')[-1],size=obj.size,sha256=checksum.hexdigest(),last_modified=obj.last_modified)) + result['objects']=sorted(objects,key=lambda x:x['name']);print(json.dumps(result,default=str)) + finally: await storage.aclose();await engine.dispose() +asyncio.run(main()) +""" + + +def probe(attachment_id): + code = "ATTACHMENT_ID = " + repr(str(UUID(attachment_id))) + "\n" + PROBE + result = subprocess.run( + COMPOSE + ["exec", "-T", "api", "python", "-"], + input=code, + text=True, + capture_output=True, + cwd=ROOT, + timeout=30, + ) + check(result.returncode == 0, "Probe failed; diagnostic output hidden") + return json.loads(result.stdout) + + +def admin(*arguments, expected=0): + result = compose( + "run", + "--rm", + "--no-deps", + "worker", + "python", + "-m", + "app.core.job_admin", + *arguments + ) + check(result.returncode == expected, "Unexpected operator command exit status") + return json.loads(result.stdout) + + +def verify_result(client, actor, attachment, original): + ready = client.wait_ready(actor, attachment, wait_seconds=180) + check(ready["id"] == attachment["id"], "Attachment identity changed") + path = "/api/v1/attachments/" + ready["id"] + "/content" + check( + client.call("GET", path, actor=actor)["bytes"] == original, "Original changed" + ) + check( + {v["name"] for v in ready["variants"]} == {"thumbnail", "crop", "optimized"}, + "Incomplete pipeline", + ) + for variant in ready["variants"]: + data = client.call("GET", path + "?variant=" + variant["name"], actor=actor)[ + "bytes" + ] + check( + hashlib.sha256(data).hexdigest() == variant["sha256"], "Checksum mismatch" + ) + with Image.open(BytesIO(data)) as image: + check( + image.size == (variant["width"], variant["height"]), + "Metadata dimensions mismatch", + ) + check( + image.format == ("WEBP" if variant["name"] == "optimized" else "JPEG"), + "Wrong format", + ) + check( + not image.getexif() + and not image.info.get("icc_profile") + and not image.info.get("xmp"), + "Metadata leaked", + ) + if variant["name"] == "crop": + check(image.size == (128, 128), "Wrong crop size") + snapshot = probe(ready["id"]) + check( + len(snapshot["objects"]) == 4, + "Expected exactly one original and three variants", + ) + return snapshot + + +def crash(client, actor, chat, mode): + name = "messenger-worker-fault-" + uuid4().hex + try: + require_compose("stop", "worker") + attachment, original = client.attachment(actor, chat) + result = compose( + "run", + "--rm", + "--no-deps", + "--name", + name, + "worker", + "python", + "-m", + "app.core.job_worker", + "--" + mode, + attachment["id"], + ) + phase = ( + "after_object:optimized" if mode == "crash-after-object" else "before_ack" + ) + marker = json.dumps({"fault": phase, "attachment_id": attachment["id"]}) + check( + result.returncode == 137 and marker in result.stdout, + "Targeted crash not observed", + ) + before = probe(attachment["id"]) + check( + before["status"] + == ("processing" if mode == "crash-after-object" else "ready"), + "Unexpected crash state", + ) + check(len(before["objects"]) == 4, "Crash must occur after all four PUTs") + finally: + subprocess.run(["docker", "rm", "-f", name], capture_output=True, timeout=30) + require_compose("start", "worker") + after = verify_result(client, actor, attachment, original) + if mode == "crash-before-ack": + # Wait for RabbitMQ to deliver and acknowledge the ready duplicate. + wait_queue_empty() + after = probe(attachment["id"]) + check(after == before, "Ready duplicate rewrote result") + else: + check( + after["attempt"] == before["attempt"] + 1, + "Lease did not recover the interrupted attempt", + ) + check( + [(x["name"], x["sha256"]) for x in before["objects"]] + == [(x["name"], x["sha256"]) for x in after["objects"]], + "Replay changed object content", + ) + return dict( + scenario=mode, + attachment_id=attachment["id"], + exit_code=137, + before=before, + after=after, + ) + + +def retry_replay(client, actor, chat, permanent): + name = "messenger-retry-fault-" + uuid4().hex + samples = [] + configuration = ComposeProject().config["services"]["worker"]["environment"] + retry_base = float(configuration["JOB_RETRY_SECONDS"]) + retry_max = float(configuration["JOB_RETRY_MAX_SECONDS"]) + try: + require_compose("stop", "worker") + attachment, original = client.attachment(actor, chat) + mode = "fail-permanent" if permanent else "fail-transient" + require_compose( + "run", + "-d", + "--no-deps", + "--name", + name, + "worker", + "python", + "-m", + "app.core.job_worker", + "--" + mode, + attachment["id"], + ) + deadline = time.monotonic() + 180 + while time.monotonic() < deadline: + sample = probe(attachment["id"]) + if ( + sample["attempt"] + and sample["status"] in {"queued", "failed"} + and (not samples or samples[-1]["attempt"] != sample["attempt"]) + ): + samples.append(sample) + if sample["status"] == "failed": + break + time.sleep(0.5) + check(sample["status"] == "failed", "Retry never reached failed") + check( + sample["attempt"] == (1 if permanent else sample["limit"]), + "Incorrect attempt budget", + ) + check(sample["permanent"] == permanent, "Incorrect error classification") + if not permanent: + check(len(samples) == sample["limit"], "Missed retry samples") + for entry in samples: + delay = ( + datetime.fromisoformat(entry["next_attempt_at"]) + - datetime.fromisoformat(entry["updated_at"]) + ).total_seconds() + ceiling = min(retry_max, retry_base * 2 ** (entry["attempt"] - 1)) + check( + ceiling / 2 <= delay <= ceiling, + "Retry delay outside configured jitter bounds", + ) + client.call( + "GET", + "/api/v1/attachments/" + attachment["id"] + "/content", + actor=actor, + expected=409, + ) + job_id = sample["job_id"] + request_id = str(uuid4()) + listing = admin("list-failed") + check( + any(row["job_id"] == job_id for row in listing), + "Job missing from failed registry", + ) + subprocess.run( + ["docker", "rm", "-f", name], capture_output=True, timeout=30, check=True + ) + first = admin( + "replay", + job_id, + "--request-id", + request_id, + "--actor", + "verification", + "--reason", + "dependency_restored", + ) + check(first["status"] == "queued", "Replay did not queue job") + finally: + subprocess.run(["docker", "rm", "-f", name], capture_output=True, timeout=30) + require_compose("start", "worker") + after = verify_result(client, actor, attachment, original) + repeat = admin( + "replay", + job_id, + "--request-id", + request_id, + "--actor", + "verification", + "--reason", + "dependency_restored", + ) + check(repeat["already_applied"], "Replay request id not idempotent") + refused = admin( + "replay", + job_id, + "--request-id", + str(uuid4()), + "--actor", + "verification", + "--reason", + "manual_review", + expected=2, + ) + check(refused["error_code"] == "job_not_failed", "Successful job was replayed") + check(probe(attachment["id"]) == after, "Operator replay altered ready job") + check(len(admin("history", job_id)) == 1, "Incorrect audit count") + return dict( + scenario=mode, + attachment_id=attachment["id"], + samples=samples, + after=after, + replay_idempotent=True, + ) + + +def queue_state(): + output = require_compose( + "exec", + "-T", + "broker", + "rabbitmqctl", + "list_queues", + "--formatter=json", + "name", + "messages_ready", + "messages_unacknowledged", + "consumers", + "durable", + ) + return next(row for row in json.loads(output) if row["name"] == "attachment-jobs") + + +def wait_queue_empty(): + deadline = time.monotonic() + 20 + while time.monotonic() < deadline: + state = queue_state() + if state["messages_ready"] == 0 and state["messages_unacknowledged"] == 0: + return state + time.sleep(0.5) + check(False, "RabbitMQ did not acknowledge all completed deliveries") + + +def persistence(client, actor, chat): + try: + require_compose("stop", "worker") + attachment, original = client.attachment(actor, chat) + client.message(actor, chat, "", attachments=[attachment["id"]]) + client.call( + "GET", + "/api/v1/attachments/" + attachment["id"] + "/content", + actor=actor, + expected=409, + ) + time.sleep(2) + queued_before = queue_state() + check( + queued_before["messages_ready"] >= 1 and queued_before["durable"], + "No durable queued message before restart", + ) + result = subprocess.run( + [str(ROOT / "scripts/restart.sh")], + cwd=ROOT, + capture_output=True, + timeout=180, + ) + check(result.returncode == 0, "Restart hook failed") + check( + "worker" + not in require_compose( + "ps", "--status", "running", "--services" + ).splitlines(), + "Restart started deliberately stopped worker", + ) + queued_after = queue_state() + check( + queued_after["messages_ready"] >= 1 and queued_after["durable"], + "Broker lost queued delivery across restart", + ) + client.message(actor, chat, "session and chat survived broker/API restart") + finally: + require_compose("start", "worker") + after = verify_result(client, actor, attachment, original) + return dict( + scenario="worker_stopped_restart_all", + attachment_id=attachment["id"], + queue_before=queued_before, + queue_after=queued_after, + after=after, + ) + + +def main(): + parser = argparse.ArgumentParser() + parser.add_argument("--base-url", required=True) + parser.add_argument("--ca-file") + parser.add_argument( + "--scenario", + choices=[ + "all", + "persistence", + "crash-after-object", + "crash-before-ack", + "fail-transient", + "fail-permanent", + ], + default="all", + ) + parser.add_argument("--output", default="evidence/jobs.json") + args = parser.parse_args() + client = Client(args.base_url, args.ca_file, timeout=40) + aliases = {r.instance_id for r in ComposeProject().replicas() if r.running} + check( + client.call("GET", "/health/live", schema="Health")["headers"].get( + "X-Instance-Id" + ) + in aliases, + "Wrong Compose project for BASE_URL", + ) + actor, _, _, chat = client.bootstrap() + results = [] + operations = { + "persistence": persistence, + "crash-after-object": lambda *x: crash(*x, "crash-after-object"), + "crash-before-ack": lambda *x: crash(*x, "crash-before-ack"), + "fail-transient": lambda *x: retry_replay(*x, False), + "fail-permanent": lambda *x: retry_replay(*x, True), + } + selected = ( + operations.values() if args.scenario == "all" else [operations[args.scenario]] + ) + for operation in selected: + result = operation(client, actor, chat) + results.append(result) + Path(args.output).parent.mkdir(parents=True, exist_ok=True) + Path(args.output).write_text( + json.dumps(dict(status="in_progress", results=results), indent=2) + "\n" + ) + print("PASS: " + result["scenario"], flush=True) + Path(args.output).write_text( + json.dumps(dict(status="passed", results=results), indent=2) + "\n" + ) + + +if __name__ == "__main__": + main() diff --git a/scripts/check_nginx.py b/scripts/check_nginx.py new file mode 100644 index 0000000..cd35034 --- /dev/null +++ b/scripts/check_nginx.py @@ -0,0 +1,261 @@ +#!/usr/bin/env python3 +"""Проверки реального nginx в отдельном Compose-проекте без БД и приложения.""" + +from concurrent.futures import ThreadPoolExecutor +import gzip +import json +from pathlib import Path +import subprocess +import tempfile +import time +from urllib.error import HTTPError, URLError +from urllib.request import Request, urlopen +from uuid import uuid4 + +ROOT = Path(__file__).resolve().parents[1] +IMAGE = "nginx:1.28.0-alpine" +PAYLOAD = json.dumps({"text": "message " * 256}).encode() + + +def check(condition: bool, message: str) -> None: + if not condition: + raise AssertionError(message) + + +class Stand: + def __init__(self, directory: str) -> None: + self.directory = Path(directory) + self.project = "messenger-nginx-check-" + uuid4().hex[:12] + self.base_url = "" + backend = self.directory / "backend.conf" + backend.write_text( + "worker_processes 1;\n" + "events { worker_connections 1024; }\n" + "http {\n" + " log_format backend 'BACKEND $request_method $uri';\n" + " access_log /dev/stdout backend;\n" + " server {\n" + " listen 8080;\n" + " default_type application/json;\n" + " add_header X-Instance-Id $hostname always;\n" + " add_header X-Request-Id $request_id always;\n" + " add_header Retry-After 7 always;\n" + ' location /health/ { return 200 \'{"status":"ok"}\'; }\n' + " location = /api/limited {\n" + ' return 429 \'{"error":{"code":"rate_limited",' + '"message":"upstream limit","request_id":"$request_id"}}\';\n' + " }\n" + " location = /api/post-failure {\n" + ' return 503 \'{"error":{"code":"unavailable",' + '"message":"upstream failure","request_id":"$request_id"}}\';\n' + " }\n" + " location / { return 200 '" + PAYLOAD.decode() + "'; }\n" + " }\n" + "}\n" + ) + self.compose_file = self.directory / "compose.json" + self.compose_file.write_text( + json.dumps( + { + "services": { + "api": { + "image": IMAGE, + "volumes": [f"{backend}:/etc/nginx/nginx.conf:ro"], + }, + "nginx": { + "image": IMAGE, + "volumes": [ + f"{ROOT / 'infra/nginx/nginx.conf'}:/etc/nginx/nginx.conf:ro" + ], + "ports": ["127.0.0.1::8080"], + }, + } + } + ) + ) + + def compose(self, *args: str) -> str: + # Явный файл, уникальный проект и пустой env-file исключают основной стенд. + result = subprocess.run( + [ + "docker", + "compose", + "--env-file", + "/dev/null", + "-f", + str(self.compose_file), + "-p", + self.project, + *args, + ], + cwd=self.directory, + capture_output=True, + text=True, + timeout=45, + ) + if result.returncode: + raise RuntimeError(result.stdout + result.stderr) + return result.stdout + result.stderr + + def call(self, path: str, *, method: str = "GET", encoding: str = "identity"): + request = Request( + self.base_url + path, + method=method, + headers={"Accept-Encoding": encoding}, + data=b"{}" if method == "POST" else None, + ) + try: + response = urlopen(request, timeout=3) + except HTTPError as error: + response = error + except (URLError, TimeoutError): + return 0, {}, b"" + with response: + return ( + response.status, + {key.lower(): value for key, value in response.headers.items()}, + response.read(), + ) + + def wait_instances(self, count: int) -> set[str]: + seen: set[str] = set() + deadline = time.monotonic() + 15 + while time.monotonic() < deadline: + status, headers, _ = self.call("/health/live") + if status == 200: + seen.add(headers["x-instance-id"]) + if len(seen) == count: + return seen + time.sleep(0.05) + raise AssertionError(f"Ожидалось {count} реплик, наблюдалось {len(seen)}") + + +def check_error(response, status: int, code: str) -> None: + actual_status, headers, body = response + check(actual_status == status, f"Ожидался HTTP {status}, получен {actual_status}") + check( + headers.get("content-type", "").startswith("application/json"), "Ошибка не JSON" + ) + error = json.loads(body)["error"] + check(error["code"] == code, "Неверный код ошибки") + check(error["request_id"] == headers.get("x-request-id"), "request_id не совпадает") + + +def run_checks(stand: Stand) -> None: + stand.compose("up", "-d", "--pull", "never", "--scale", "api=2", "api", "nginx") + address = stand.compose("port", "nginx", "8080").strip() + stand.base_url = "http://" + address + stand.wait_instances(2) + print(stand.compose("exec", "-T", "nginx", "nginx", "-v").strip()) + stand.compose("exec", "-T", "nginx", "nginx", "-t") + print("PASS: nginx -t и балансировка двух реплик") + + status, headers, body = stand.call("/api/large", encoding="gzip") + check( + status == 200 and headers.get("content-encoding") == "gzip", "Нет gzip для JSON" + ) + check(gzip.decompress(body) == PAYLOAD, "gzip изменил содержимое") + check(len(body) < len(PAYLOAD), "gzip не уменьшил тестовый ответ") + check( + "accept-encoding" in headers.get("vary", "").lower(), + "Нет Vary: Accept-Encoding", + ) + check(stand.call("/api/large")[2] == PAYLOAD, "Ответ без gzip изменён") + small = stand.call("/health/live", encoding="gzip") + check( + small[0] == 200 and "content-encoding" not in small[1], "Маленький ответ сжат" + ) + print(f"PASS: gzip {len(PAYLOAD)} → {len(body)} байт, содержимое сохранено") + + limited = stand.call("/api/limited") + check_error(limited, 429, "rate_limited") + check(limited[1].get("retry-after") == "7", "Подменён Retry-After приложения") + check("x-instance-id" in limited[1], "Потерян id backend на ошибке API") + print("PASS: JSON и заголовки ошибки API передаются без подмены") + + failure = stand.call("/api/post-failure", method="POST") + check_error(failure, 503, "unavailable") + backend_logs = stand.compose("logs", "--no-color", "--no-log-prefix", "api") + check(backend_logs.count("BACKEND POST /api/post-failure") == 1, "POST повторился") + print("PASS: отправленный POST не повторяется на другой реплике") + + with ThreadPoolExecutor(max_workers=32) as pool: + responses = list(pool.map(lambda _: stand.call("/api/large"), range(500))) + rejected = [response for response in responses if response[0] == 429] + check(bool(rejected), "Не удалось вызвать ограничение частоты") + check( + all(response[0] in (200, 429) for response in responses), "Ошибка при нагрузке" + ) + for response in rejected: + check_error(response, 429, "rate_limited") + check(response[1].get("retry-after") == "1", "Нет Retry-After балансировщика") + check("x-instance-id" not in response[1], "LB выдал себя за API-реплику") + with ThreadPoolExecutor(max_workers=16) as pool: + health = list(pool.map(lambda _: stand.call("/health/ready"), range(100))) + check(all(response[0] == 200 for response in health), "Лимит затронул health") + check(stand.call("/lb-health")[0] == 200, "Проверка LB недоступна") + print(f"PASS: лимит вернул {len(rejected)} ответов 429; health доступен") + + stand.compose( + "up", "-d", "--pull", "never", "--scale", "api=3", "--no-recreate", "api" + ) + instances = stand.wait_instances(3) + print("PASS: третья реплика обнаружена через DNS без reload nginx") + + target = sorted(instances)[0] + containers = stand.compose("ps", "-q", "api").splitlines() + matching = [container for container in containers if container.startswith(target)] + check(len(matching) == 1, "Не найдена тестовая реплика для остановки") + # Все id взяты только из уникального временного Compose-проекта. + started = time.monotonic() + subprocess.run( + ["docker", "stop", "--time", "1", matching[0]], check=True, capture_output=True + ) + recovery = None + for _ in range(20): + status, headers, _ = stand.call("/health/live") + if status == 200: + check(headers["x-instance-id"] != target, "Остановленная реплика отвечает") + if recovery is None: + recovery = time.monotonic() - started + check(recovery is not None and recovery < 10, "Чтение не восстановилось за 10 с") + print(f"PASS: отказ реплики, первое успешное чтение через {recovery:.3f} с") + + stand.compose("stop", "--timeout", "1", "api") + unavailable = stand.call("/health/ready") + check_error(unavailable, 503, "unavailable") + check( + unavailable[1].get("retry-after") == "1", "Нет Retry-After при отказе всех API" + ) + check("x-instance-id" not in unavailable[1], "У ошибки LB есть id реплики") + check(stand.call("/lb-health")[0] == 200, "Отказ API сломал проверку самого LB") + print("PASS: недоступность всех backend возвращает JSON 503") + + logs = stand.compose("logs", "--no-color", "--no-log-prefix", "nginx") + entries = [json.loads(line) for line in logs.splitlines() if line.startswith("{")] + check(bool(entries), "Нет JSON access log") + check( + all("request_id" in entry and "upstream_time" in entry for entry in entries), + "Неполный лог", + ) + check( + any(entry["limit_status"] == "REJECTED" for entry in entries), + "Лимит не отражён в логе", + ) + print("PASS: JSON access log содержит время backend и результат лимита") + + +def main() -> None: + with tempfile.TemporaryDirectory(prefix="messenger-nginx-check-") as directory: + stand = Stand(directory) + try: + run_checks(stand) + except Exception: + print(stand.compose("logs", "--no-color", "--tail", "20"), flush=True) + raise + finally: + stand.compose("down", "--volumes", "--remove-orphans", "--timeout", "1") + + +if __name__ == "__main__": + main() diff --git a/scripts/check_outbox_recovery.py b/scripts/check_outbox_recovery.py new file mode 100644 index 0000000..c52471a --- /dev/null +++ b/scripts/check_outbox_recovery.py @@ -0,0 +1,147 @@ +"""Сценарий COMMIT → SIGKILL до publish → ready без повторного upload. + +Требуется уже работающий отдельный стенд. Скрипт не выполняется при запуске API. +Публичные tests не изменяет, secrets/tokens не печатает и evidence сам не сохраняет. +""" + +import argparse +import hashlib +import json +from pathlib import Path +import subprocess +from uuid import uuid4 + +from scripts.deployment import ComposeProject +from tests.client import Client, check + +ROOT = Path(__file__).resolve().parents[1] +COMPOSE = ["docker", "compose", "--env-file", ".env"] + + +def compose(*arguments: str, timeout: int = 90) -> subprocess.CompletedProcess: + return subprocess.run( + COMPOSE + list(arguments), + cwd=ROOT, + text=True, + capture_output=True, + timeout=timeout, + ) + + +def require_compose(*arguments: str) -> str: + result = compose(*arguments) + check(result.returncode == 0, "Compose command failed; output hidden") + return result.stdout + + +def main() -> None: + parser = argparse.ArgumentParser( + description="Отказ publisher после COMMIT перед RabbitMQ publish" + ) + parser.add_argument("--base-url", required=True) + parser.add_argument("--ca-file") + args = parser.parse_args() + running = set( + require_compose("ps", "--status", "running", "--services").splitlines() + ) + check( + {"api", "postgres", "minio", "broker", "publisher", "worker"} <= running, + "Start the application stack before this scenario", + ) + client = Client(args.base_url, args.ca_file, timeout=40) + project = ComposeProject() + aliases = {replica.instance_id for replica in project.replicas() if replica.running} + live = client.call("GET", "/health/live", schema="Health") + check( + live["headers"].get("X-Instance-Id") in aliases, + "BASE_URL does not belong to the selected Compose project", + ) + alice, _, _, chat = client.bootstrap() + attachment = None + fault_container = "messenger-outbox-fault-" + uuid4().hex + try: + require_compose("stop", "publisher") + attachment, original = client.attachment(alice, chat) + message = client.message(alice, chat, "", attachments=[attachment["id"]])[ + "json" + ] + client.call( + "GET", + f"/api/v1/attachments/{attachment['id']}/content", + expected=409, + actor=alice, + ) + killed = compose( + "run", + "--rm", + "--no-deps", + "--name", + fault_container, + "publisher", + "python", + "-m", + "app.core.outbox_publisher", + "--crash-before-publish", + attachment["id"], + ) + marker = json.dumps( + {"fault": "before_publish", "attachment_id": attachment["id"]} + ) + check( + killed.returncode == 137 and marker in killed.stdout, + "Expected targeted SIGKILL before publish was not observed", + ) + pending = client.call( + "GET", + f"/api/v1/attachments/{attachment['id']}", + actor=alice, + schema="Attachment", + )["json"] + check(pending["status"] == "queued", "Crash must leave accepted job queued") + finally: + # Если docker compose run оборвался по timeout, одноразовый контейнер тоже удаляется. + try: + subprocess.run( + ["docker", "rm", "-f", fault_container], capture_output=True, timeout=30 + ) + finally: + require_compose("start", "publisher") + ready = client.wait_ready(alice, attachment, wait_seconds=60) + check(ready["id"] == attachment["id"], "Recovered a different attachment") + check( + {variant["name"] for variant in ready["variants"]} + == {"thumbnail", "crop", "optimized"}, + "Missing required variants", + ) + path = f"/api/v1/attachments/{attachment['id']}/content" + check( + client.call("GET", path, actor=alice)["bytes"] == original, + "Original changed after recovery", + ) + for variant in ready["variants"]: + downloaded = client.call( + "GET", path + "?variant=" + variant["name"], actor=alice + )["bytes"] + check( + len(downloaded) == variant["size_bytes"] + and hashlib.sha256(downloaded).hexdigest() == variant["sha256"], + "Recovered variant checksum mismatch", + ) + print( + json.dumps( + { + "scenario": "commit_before_publish", + "attachment_id": ready["id"], + "message_id": message["id"], + "publisher_exit_code": killed.returncode, + "status_after_crash": pending["status"], + "status_after_restart": ready["status"], + "variants": [variant["name"] for variant in ready["variants"]], + "reuploaded": False, + } + ) + ) + + +if __name__ == "__main__": + main() diff --git a/scripts/check_s3.py b/scripts/check_s3.py new file mode 100644 index 0000000..eddadaf --- /dev/null +++ b/scripts/check_s3.py @@ -0,0 +1,152 @@ +"""Реальный MinIO: повтор bootstrap, private bucket, ограниченные права и отказ.""" + +import json +import subprocess +import time + +from scripts.deployment import ComposeProject +from tests.client import Client, arguments, check, run + +PROBE = r""" +import asyncio, json, sys +from pathlib import Path +from uuid import UUID +from urllib.request import Request, urlopen +from urllib.error import HTTPError, URLError +from app.core.config import Settings +from app.core.database import create_db_engine, create_session_factory +from app.storage.s3 import create_s3_storage +from app.models.attachment import Attachment +from minio.error import S3Error +async def main(): + settings = Settings() + engine = create_db_engine(settings) + storage = create_s3_storage(settings.s3) + try: + async with create_session_factory(engine)() as session: + record = await session.get(Attachment, UUID(json.load(sys.stdin)['attachment_id'])) + key = record.object_key + results = {} + for method in ('GET', 'PUT'): + request = Request(settings.s3.endpoint + '/' + settings.s3.bucket + '/' + key, + method=method, data=b'x' if method == 'PUT' else None) + try: + with urlopen(request, timeout=3) as response: + results[method] = response.status + except HTTPError as error: + results[method] = error.code + error.close() + try: + storage._client.get_bucket_policy(settings.s3.bucket) + results['admin_denied'] = False + except S3Error as error: + results['admin_denied'] = error.code == 'AccessDenied' + try: + buckets = storage._client.list_buckets() + results['other_buckets_denied'] = all(bucket.name == settings.s3.bucket for bucket in buckets) + except S3Error as error: + results['other_buckets_denied'] = error.code == 'AccessDenied' + try: + with urlopen(settings.s3.endpoint.replace(':9000', ':9001'), timeout=1): + results['console_unreachable'] = False + except HTTPError as error: + results['console_unreachable'] = False + error.close() + except URLError: + results['console_unreachable'] = True + results['temp_originals_absent'] = not any(Path('/tmp').glob('messenger-upload-*')) + results['root_files_absent'] = not any(Path('/run/secrets', name).exists() + for name in ('minio_root_user', 'minio_root_password')) + print(json.dumps(results)) + finally: + await storage.aclose() + await engine.dispose() +asyncio.run(main()) +""" + + +def main(): + def configure(parser): + parser.add_argument( + "--with-outage", + action="store_true", + help="временно остановить MinIO выбранного проекта", + ) + + args = arguments("MinIO private bucket and failure checks", configure) + project = ComposeProject() + client = Client(args.base_url, args.ca_file, timeout=40) + alice, _, _, chat = client.bootstrap() + aliases = {replica.instance_id for replica in project.replicas() if replica.running} + live = client.call("GET", "/health/live", schema="Health") + check( + live["headers"].get("X-Instance-Id") in aliases, + "BASE_URL does not belong to the selected Compose project", + ) + attachment, original = client.attachment(alice, chat) + attachment = client.wait_ready(alice, attachment) + # Повторный bootstrap не должен очистить bucket или сменить используемые credentials. + for _ in range(2): + project.run("run", "--rm", "--no-deps", "minio-bootstrap", timeout=100) + replicas = project.replicas() + check(bool(replicas), "API not running") + result = subprocess.run( + ["docker", "exec", "-i", replicas[0].id, "python", "-c", PROBE], + input=json.dumps({"attachment_id": attachment["id"]}), + text=True, + capture_output=True, + timeout=20, + ) + check(result.returncode == 0, "private bucket probe failed (details hidden)") + statuses = json.loads(result.stdout) + check(statuses["GET"] == statuses["PUT"] == 403, "anonymous S3 access allowed") + check( + statuses["admin_denied"] + and statuses["other_buckets_denied"] + and statuses["root_files_absent"], + "API has excessive access", + ) + check(statuses["console_unreachable"], "console reachable from API network") + check(statuses["temp_originals_absent"], "API retained temporary originals") + check( + not project.config["services"]["minio"].get("ports"), + "MinIO publishes host ports", + ) + env = project.config["services"]["minio"]["environment"] + check(env["MINIO_BROWSER"] == "off", "browser enabled") + check( + "127.0.0.1:9001" in project.config["services"]["minio"]["command"], + "console is not bound to loopback", + ) + path = "/api/v1/attachments/" + attachment["id"] + "/content" + check( + client.call("GET", path, actor=alice)["bytes"] == original, + "bootstrap changed original", + ) + if args.with_outage: + try: + project.run("stop", "minio") + client.call("GET", path, expected=503, actor=alice) + finally: + project.run("start", "minio") + deadline = time.monotonic() + 60 + while True: + try: + client.call("GET", "/health/ready", schema="Health") + break + except Exception: + if time.monotonic() >= deadline: + raise + time.sleep(0.5) + check( + client.call("GET", path, actor=alice)["bytes"] == original, + "original lost after MinIO restart", + ) + print( + "PASS: idempotent bootstrap, anonymous GET/PUT denied, restricted API credentials, private console" + + (", MinIO outage/recovery" if args.with_outage else "") + ) + + +if __name__ == "__main__": + run(main) diff --git a/scripts/deployment.py b/scripts/deployment.py new file mode 100644 index 0000000..c629e6e --- /dev/null +++ b/scripts/deployment.py @@ -0,0 +1,73 @@ +"""Общие операции с репликами текущего Compose-проекта.""" + +from dataclasses import dataclass +import json +import os +from pathlib import Path +import subprocess + +ROOT = Path(__file__).resolve().parents[1] + + +@dataclass(frozen=True) +class Replica: + """Состояние контейнера API.""" + + id: str + image: str + instance_id: str + running: bool + health: str | None + + +class ComposeProject: + """Работает только с выбранным Compose-проектом.""" + + def __init__(self) -> None: + self.command = ["docker", "compose", "--env-file", ".env"] + self.config = json.loads(self.run("config", "--format", "json")) + self.name = self.config["name"] + + def docker(self, *args: str, timeout: int = 90, env=None) -> str: + """Выполняет Docker-команду с ограничением времени.""" + result = subprocess.run( + ["docker", *args], + cwd=ROOT, + text=True, + capture_output=True, + timeout=timeout, + env={**os.environ, **(env or {})}, + ) + if result.returncode: + raise RuntimeError(result.stderr.strip() or result.stdout.strip()) + return result.stdout.strip() + + def run(self, *args: str, timeout: int = 90, env=None) -> str: + """Выполняет команду Compose с текущими overrides.""" + return self.docker(*self.command[1:], *args, timeout=timeout, env=env) + + def replicas(self) -> list[Replica]: + """Читает состояние API без окружения контейнеров.""" + ids = self.run("ps", "--all", "--quiet", "api").splitlines() + if not ids: + return [] + template = ( + '{"id":{{json .Id}},"image":{{json .Image}},' + '"hostname":{{json .Config.Hostname}},"running":{{json .State.Running}},' + '"health":{{if .State.Health}}{{json .State.Health.Status}}{{else}}null{{end}}}' + ) + rows = self.docker("inspect", "--format", template, *ids).splitlines() + configured = str( + self.config["services"]["api"].get("environment", {}).get("INSTANCE_ID") + or "" + ).strip() + return [ + Replica( + row["id"], + row["image"], + configured or row["hostname"], + row["running"], + row["health"], + ) + for row in map(json.loads, rows) + ] diff --git a/scripts/init_local.py b/scripts/init_local.py new file mode 100644 index 0000000..7477cd0 --- /dev/null +++ b/scripts/init_local.py @@ -0,0 +1,38 @@ +"""Создаёт только отсутствующие локальные настройки и файловые секреты.""" + +import os +from pathlib import Path +import secrets + + +def main() -> None: + root = Path(__file__).resolve().parents[1] + destination = root / ".env" + if not destination.exists(): + with destination.open("x") as target: + target.write((root / ".env.example").read_text()) + destination.chmod(0o600) + directory = root / "secrets" + directory.mkdir(mode=0o700, exist_ok=True) + for name in ( + "db_password", + "redis_password", + "broker_password", + "minio_root_user", + "minio_root_password", + "s3_access_key_id", + "s3_secret_access_key", + ): + path = directory / name + try: + descriptor = os.open(path, os.O_WRONLY | os.O_CREAT | os.O_EXCL, 0o444) + except FileExistsError: + continue + with os.fdopen(descriptor, "w") as target: + target.write(secrets.token_urlsafe(24)) + print("Создан файл " + str(path.relative_to(root))) + print("Настройки готовы; существующие значения сохранены") + + +if __name__ == "__main__": + main() diff --git a/scripts/restart.sh b/scripts/restart.sh new file mode 100755 index 0000000..493ee34 --- /dev/null +++ b/scripts/restart.sh @@ -0,0 +1,37 @@ +#!/bin/sh +set -eu +cd "$(dirname "$0")/.." + +compose() { + docker compose --env-file .env "$@" +} + +wait_healthy() { + for service in "$@"; do + attempts=0 + until states=$(compose ps --format '{{.Health}}' "$service") \ + && [ -n "$states" ] \ + && [ -z "$(printf '%s\n' "$states" | grep -v '^healthy$')" ]; do + attempts=$((attempts + 1)) + if [ "$attempts" -ge 60 ]; then + echo "$service не стал healthy за 60 секунд" >&2 + exit 1 + fi + sleep 1 + done + done +} + +worker_running=$(compose ps --status running --quiet worker) +compose stop worker publisher cleanup +compose restart postgres redis minio broker +wait_healthy postgres redis minio broker +compose restart api +wait_healthy api +compose restart nginx +wait_healthy nginx +compose start publisher cleanup +# Сценарий с заранее остановленным worker сохраняет его остановленным. +if [ -n "$worker_running" ]; then + compose start worker +fi diff --git a/scripts/stop-one.sh b/scripts/stop-one.sh new file mode 100755 index 0000000..0dcd4da --- /dev/null +++ b/scripts/stop-one.sh @@ -0,0 +1,30 @@ +#!/bin/sh +set -eu +cd "$(dirname "$0")/.." +: "${TARGET_INSTANCE_ID:?test provides target API instance alias}" + +case "$TARGET_INSTANCE_ID" in + *[!a-zA-Z0-9_.:-]*|'') exit 1 ;; +esac + +target="" +for container in $(docker compose --env-file .env ps -q api); do + hostname=$(docker inspect --format '{{.Config.Hostname}}' "$container") + configured=$(docker inspect --format '{{range .Config.Env}}{{if eq (index (split . "=") 0) "INSTANCE_ID"}}{{println .}}{{end}}{{end}}' "$container" \ + | sed -n 's/^INSTANCE_ID=//p' | sed 's/^[[:space:]]*//;s/[[:space:]]*$//') + if [ "$TARGET_INSTANCE_ID" = "$hostname" ] || [ "$TARGET_INSTANCE_ID" = "$configured" ]; then + if [ -n "$target" ]; then + echo 'Instance id matches multiple API containers' >&2 + exit 1 + fi + target="$container" + fi +done + +if [ -z "$target" ]; then + echo 'Target API instance not found in this Compose project' >&2 + exit 1 +fi + +echo "Stopping API container $target" >&2 +docker stop --timeout 8 "$target" >/dev/null diff --git a/student-tests/conftest.py b/student-tests/conftest.py new file mode 100644 index 0000000..a72d190 --- /dev/null +++ b/student-tests/conftest.py @@ -0,0 +1,202 @@ +"""Фикстуры async-тестов на реальных PostgreSQL и Redis. + +Перед запуском: `make test-stand-up` (тестовый стенд из compose.yaml + compose.test.yaml +и база _test). +Переменные: + TEST_DATABASE_URL по умолчанию postgresql+asyncpg://messenger:messenger@localhost:5432/messenger_test + TEST_USE_MIGRATIONS=1 строить схему через `alembic upgrade head` вместо Base.metadata.create_all + TEST_REDIS_HOST/PORT/PASSWORD/DB по умолчанию localhost:6379, база 15 + DOCKER_TESTS=1 включить тесты, которые перезапускают контейнеры compose +""" + +import asyncio +import os +from collections.abc import AsyncIterator, Callable + +import httpx +import pytest +from alembic import command +from alembic.config import Config +from fastapi import FastAPI +from redis.asyncio import Redis +from redis.exceptions import RedisError +from sqlalchemy import text +from sqlalchemy.exc import SQLAlchemyError +from sqlalchemy.ext.asyncio import AsyncEngine, create_async_engine +from sqlalchemy.pool import NullPool + +from app.core.config import Settings +from app.core.redis import create_redis_client +from app.main import create_app +from app.models import Base + +DEFAULT_TEST_DATABASE_URL = ( + "postgresql+asyncpg://messenger:messenger@localhost:5432/messenger_test" +) + + +def _database_url() -> str: + return os.environ.get("TEST_DATABASE_URL", DEFAULT_TEST_DATABASE_URL) + + +def _redis_settings() -> dict[str, object]: + return { + "redis_host": os.environ.get("TEST_REDIS_HOST", "localhost"), + "redis_port": int(os.environ.get("TEST_REDIS_PORT", "6379")), + "redis_password": os.environ.get("TEST_REDIS_PASSWORD") or None, + "redis_db": int(os.environ.get("TEST_REDIS_DB", "15")), + } + + +def _alembic_config(url: str) -> Config: + config = Config("alembic.ini") + config.set_main_option("sqlalchemy.url", url.replace("%", "%%")) + return config + + +async def upgrade_head(url: str) -> None: + """alembic command.upgrade внутри вызывает asyncio.run, поэтому — в отдельном потоке.""" + await asyncio.to_thread(command.upgrade, _alembic_config(url), "head") + + +async def reset_schema(engine: AsyncEngine) -> None: + async with engine.begin() as connection: + await connection.run_sync(Base.metadata.drop_all) + await connection.execute(text("DROP TABLE IF EXISTS alembic_version")) + + +async def close_app(app: FastAPI) -> None: + """ASGITransport не запускает lifespan, поэтому ресурсы приложения закрываются явно.""" + await app.state.redis.aclose() + await app.state.engine.dispose() + + +@pytest.fixture(scope="session") +def database_url() -> str: + return _database_url() + + +@pytest.fixture(scope="session") +async def db_engine(database_url: str) -> AsyncIterator[AsyncEngine]: + engine = create_async_engine(database_url, poolclass=NullPool) + try: + async with engine.connect() as connection: + await connection.execute(text("SELECT 1")) + except (SQLAlchemyError, OSError) as error: + pytest.exit( + f"PostgreSQL недоступна по {engine.url.render_as_string(hide_password=True)}: " + f"{type(error).__name__}. Выполните `make test-stand-up`.", + returncode=2, + ) + + await reset_schema(engine) + + if os.environ.get("TEST_USE_MIGRATIONS") == "1": + await upgrade_head(database_url) + else: + async with engine.begin() as connection: + await connection.run_sync(Base.metadata.create_all) + + yield engine + await engine.dispose() + + +@pytest.fixture(scope="session") +async def redis_client() -> AsyncIterator[Redis]: + settings = build_settings(_database_url()) + if settings.redis_db == 0: + pytest.exit("TEST_REDIS_DB=0 запрещён: тесты очищают базу Redis.", returncode=2) + + client = create_redis_client(settings) + try: + await client.ping() + except (RedisError, OSError) as error: + pytest.exit( + f"Redis недоступен: {type(error).__name__}. Выполните `make test-stand-up`.", + returncode=2, + ) + + yield client + await client.flushdb() + await client.aclose() + + +@pytest.fixture(autouse=True) +async def clean_db(db_engine: AsyncEngine, redis_client: Redis) -> None: + names = ", ".join(f'"{table.name}"' for table in Base.metadata.sorted_tables) + if names: + async with db_engine.begin() as connection: + await connection.execute(text(f"TRUNCATE {names} RESTART IDENTITY CASCADE")) + await redis_client.flushdb() + + +def build_settings(database_url: str, **overrides: object) -> Settings: + values: dict[str, object] = { + # Регрессия проверяет PostgreSQL/Redis; MinIO подменяется отдельно. + "s3_enabled": False, + "app_host": "127.0.0.1", + "app_port": 8080, + "app_env": "test", + "max_messages": 1000, + "max_in_flight": 32, + "log_level": "CRITICAL", + "database_url": database_url, + "session_ttl_seconds": 300, + "db_pool_size": 10, + "db_max_overflow": 10, + **_redis_settings(), + } + values.update(overrides) + return Settings(_env_file=None, **values) # type: ignore[arg-type] + + +@pytest.fixture +def settings(database_url: str) -> Settings: + return build_settings(database_url) + + +@pytest.fixture +def make_settings(database_url: str) -> Callable[..., Settings]: + def factory(**overrides: object) -> Settings: + url = str(overrides.pop("database_url", database_url)) + return build_settings(url, **overrides) + + return factory + + +def make_client( + app, *, raise_app_exceptions: bool = True, timeout: float = 30 +) -> httpx.AsyncClient: + """ASGITransport не запускает lifespan, поэтому ресурсы закрывает вызывающий (close_app).""" + return httpx.AsyncClient( + transport=httpx.ASGITransport( + app=app, raise_app_exceptions=raise_app_exceptions + ), + base_url="http://testserver", + timeout=timeout, + ) + + +@pytest.fixture +def app(settings: Settings): + application = create_app(settings) + + @application.get("/__test__/explode", include_in_schema=False) + async def explode() -> None: + raise RuntimeError("test-secret") + + return application + + +@pytest.fixture +async def client(app) -> AsyncIterator[httpx.AsyncClient]: + async with make_client(app) as test_client: + yield test_client + await close_app(app) + + +@pytest.fixture +async def client_no_raise(app) -> AsyncIterator[httpx.AsyncClient]: + async with make_client(app, raise_app_exceptions=False) as test_client: + yield test_client + await close_app(app) diff --git a/student-tests/helpers.py b/student-tests/helpers.py new file mode 100644 index 0000000..97bf8f9 --- /dev/null +++ b/student-tests/helpers.py @@ -0,0 +1,88 @@ +import base64 +from uuid import uuid4 + +from httpx import AsyncClient + +PASSWORD = "Correct-horse-battery-1" + + +def basic_header(username: str, password: str) -> dict[str, str]: + raw = f"{username}:{password}".encode() + return {"Authorization": "Basic " + base64.b64encode(raw).decode()} + + +def bearer(actor: dict) -> dict[str, str]: + return {"Authorization": "Bearer " + actor["token"]} + + +async def register( + client: AsyncClient, + username: str | None = None, + display_name: str = "Тестовый пользователь", + password: str = PASSWORD, +) -> dict: + """Регистрация без входа. Возвращает User + password (нужен для login).""" + actual_username = username or "user_" + uuid4().hex[:12] + response = await client.post( + "/api/v1/users", + json={ + "username": actual_username, + "display_name": display_name, + "password": password, + }, + ) + assert response.status_code == 201, response.text + return {**response.json(), "password": password} + + +async def login(client: AsyncClient, user: dict) -> dict: + response = await client.post( + "/api/v1/auth/sessions", + headers=basic_header(user["username"], user["password"]), + ) + assert response.status_code == 201, response.text + return {**user, "token": response.json()["token"]} + + +async def create_user(client: AsyncClient, **kwargs) -> dict: + """Регистрация + вход: актор с полями id, username, token, ...""" + return await login(client, await register(client, **kwargs)) + + +async def create_chat( + client: AsyncClient, + user: dict, + *members: dict, + title: str = "Тестовый чат", +) -> dict: + member_ids = [user["id"], *(member["id"] for member in members)] + response = await client.post( + "/api/v1/chats", + headers=bearer(user), + json={"title": title, "member_ids": member_ids}, + ) + assert response.status_code == 201, response.text + return response.json() + + +def idempotency_header(key: str | None = None) -> dict[str, str]: + return {"Idempotency-Key": key or uuid4().hex} + + +async def send_message( + client: AsyncClient, user: dict, chat: dict, text: str, key: str | None = None +): + """POST сообщения требует Idempotency-Key; по умолчанию — новый ключ.""" + return await client.post( + f"/api/v1/chats/{chat['id']}/messages", + headers={**bearer(user), **idempotency_header(key)}, + json={"text": text}, + ) + + +def assert_request_id(response) -> str: + header_id = response.headers.get("X-Request-Id") + assert header_id + if response.status_code >= 400: + assert response.json()["error"]["request_id"] == header_id + return header_id diff --git a/student-tests/test_attachments.py b/student-tests/test_attachments.py new file mode 100644 index 0000000..dba63f9 --- /dev/null +++ b/student-tests/test_attachments.py @@ -0,0 +1,483 @@ +"""API и транзакции с реальной БД; байты S3 подменены управляемым адаптером.""" + +import asyncio +import hashlib +from io import BytesIO +from datetime import datetime, timedelta, timezone +from pathlib import Path +import struct +from uuid import UUID, uuid4 +import zlib + +import pytest +from PIL import Image +from sqlalchemy import func, select +from sqlalchemy.exc import OperationalError +from sqlalchemy.ext.asyncio import AsyncSession +from starlette.requests import ClientDisconnect + +from app.core.s3 import S3Settings +from app.core.jobs import JobSettings +from app.domain.attachment_jobs import process_attachment_job +from app.models.job import AttachmentJob +from app.schemas.job import JobMessage +from app.domain import attachments as domain +from app.errors.exceptions import unavailable +from app.models.attachment import Attachment, UploadIntent +from app.storage import attachments as repository +from app.storage.s3 import ObjectInfo +from helpers import bearer, create_chat, create_user, idempotency_header + +PNG = Path("tests/fixtures/sample.png").read_bytes() + + +class MemoryStorage: + """Только тестовый адаптер; production использует MinioStorage.""" + + def __init__(self): + self.settings = S3Settings(_env_file=None) + self.objects = {} + self.fail_put = self.fail_delete = self.down = False + + async def put_file(self, key, path, **metadata): + self.objects[key] = (path.read_bytes(), metadata) + if self.fail_put: + raise unavailable() + + async def delete_object(self, key): + if self.fail_delete: + raise unavailable() + self.objects.pop(key, None) + + async def stat_object(self, key): + if self.down: + raise unavailable() + info = None + if key in self.objects: + data, metadata = self.objects[key] + info = ObjectInfo( + key, len(data), metadata["content_type"], datetime.now(timezone.utc) + ) + return info + + async def open_object(self, key): + async def chunks(): + yield self.objects[key][0] + + return chunks() + + async def check_available(self): + return not self.down + + +@pytest.fixture +async def context(client, app): + storage = MemoryStorage() + app.state.s3 = storage + alice, bob, eve = [await create_user(client) for _ in range(3)] + chat = await create_chat(client, alice, bob) + return storage, alice, bob, eve, chat + + +async def upload( + client, actor, chat, data=PNG, filename="фото.png", content_type="image/png" +): + return await client.post( + f"/api/v1/chats/{chat['id']}/attachments", + params={"filename": filename}, + headers={**bearer(actor), "Content-Type": content_type}, + content=data, + ) + + +async def finish_attachment(client, storage, actor, attachment_id): + engine = client._transport.app.state.engine + async with AsyncSession(engine) as session: + job = await session.scalar( + select(AttachmentJob).where( + AttachmentJob.attachment_id == UUID(attachment_id) + ) + ) + message = JobMessage( + job_id=job.id, + attachment_id=job.attachment_id, + pipeline_version=job.pipeline_version, + attempt=job.attempt + 1, + created_at=job.created_at, + ) + await session.rollback() + assert await process_attachment_job( + session, storage, message, JobSettings(_env_file=None) + ) + result = await client.get( + f"/api/v1/attachments/{attachment_id}", headers=bearer(actor) + ) + assert result.json()["status"] == "ready" + return result.json() + + +async def test_upload_download_and_attachment_only_message(client, context): + storage, alice, bob, eve, chat = context + response = await upload(client, alice, chat) + assert response.status_code == 202, response.text + attachment = response.json() + assert attachment["status"] == "queued" + before = await client.get( + f"/api/v1/attachments/{attachment['id']}/content", headers=bearer(alice) + ) + assert before.status_code == 409 + attachment = await finish_attachment(client, storage, alice, attachment["id"]) + assert attachment["sha256"] == hashlib.sha256(PNG).hexdigest() + assert {v["name"] for v in attachment["variants"]} == { + "thumbnail", + "crop", + "optimized", + } + assert attachment["error_code"] is None + assert "object_key" not in attachment + id = attachment["id"] + for actor in (alice, bob): + content = await client.get( + f"/api/v1/attachments/{id}/content", headers=bearer(actor) + ) + assert content.status_code == 200 and content.content == PNG + assert content.headers["content-type"] == "image/png" + key = idempotency_header() + body = {"text": "", "attachment_ids": [id]} + path = f"/api/v1/chats/{chat['id']}/messages" + message = await client.post(path, json=body, headers={**bearer(bob), **key}) + assert message.status_code == 201, message.text + repeat = await client.post(path, json=body, headers={**bearer(bob), **key}) + assert repeat.json() == message.json() + history = await client.get(path, headers=bearer(alice)) + assert history.json()["items"][0]["attachment_ids"] == [id] + for suffix in ("", "/content"): + denied = await client.get( + f"/api/v1/attachments/{id}{suffix}", headers=bearer(eve) + ) + assert denied.status_code == 404 + + +@pytest.mark.parametrize( + "data,content_type", + [ + (b"not an image", "image/png"), + (PNG[:30], "image/png"), + (PNG, "image/jpeg"), + (PNG, "application/octet-stream"), + ], + ids=["not-image", "truncated-png", "mime-spoofing", "unsupported-type"], +) +async def test_invalid_image_and_mime_are_415(client, context, data, content_type): + storage, alice, _, _, chat = context + response = await upload(client, alice, chat, data, content_type=content_type) + assert response.status_code == 415, response.text + assert not storage.objects + + +async def test_jpeg_is_stored_without_reencoding(client, context): + storage, alice, _, _, chat = context + output = BytesIO() + Image.new("RGB", (32, 32), "blue").save(output, format="JPEG") + original = output.getvalue() + response = await upload(client, alice, chat, original, content_type="image/jpeg") + assert response.status_code == 202, response.text + id = response.json()["id"] + await finish_attachment(client, storage, alice, id) + downloaded = await client.get( + f"/api/v1/attachments/{id}/content", headers=bearer(alice) + ) + assert downloaded.content == original + + +@pytest.mark.parametrize( + "filename", ["../a.png", "a\\b.png", "a\x00.png", "a\n.png", "x" * 256] +) +async def test_unsafe_filename_is_400(client, context, filename): + storage, alice, _, _, chat = context + response = await upload(client, alice, chat, filename=filename) + assert response.status_code == 400 + assert not storage.objects + + +async def test_oversize_chunked_upload_is_413(client, context): + storage, alice, _, _, chat = context + + async def chunks(): + for _ in range(11): + yield b"x" * 1048576 + + response = await upload(client, alice, chat, chunks()) + assert response.status_code == 413 + assert not storage.objects + + +async def test_oversize_content_length_is_413(client, context): + _, alice, _, _, chat = context + response = await client.post( + f"/api/v1/chats/{chat['id']}/attachments?filename=a.png", + headers={ + **bearer(alice), + "Content-Type": "image/png", + "Content-Length": "10485761", + }, + content=PNG, + ) + assert response.status_code == 413 + + +async def test_exact_byte_limit_accepts_valid_png(client, context): + _, alice, _, _, chat = context + maximum = 10_485_760 + # Валидный ancillary chunk вместо данных после IEND. + payload = bytes(maximum - len(PNG) - 12) + kind = b"npAD" + padding = ( + struct.pack("!I", len(payload)) + + kind + + payload + + struct.pack("!I", zlib.crc32(kind + payload)) + ) + image = PNG[:-12] + padding + PNG[-12:] + response = await upload(client, alice, chat, image) + assert response.status_code == 202, response.text + assert response.json()["size_bytes"] == maximum + assert response.json()["sha256"] == hashlib.sha256(image).hexdigest() + + +async def test_exact_pixel_limit_accepts_valid_png(client, context): + _, alice, _, _, chat = context + output = BytesIO() + with Image.new("RGB", (8000, 5000), "blue") as image: + image.save(output, format="PNG") + response = await upload(client, alice, chat, output.getvalue()) + assert response.status_code == 202, response.text + + +async def test_pixel_limit_before_decoding(client, context): + _, alice, _, _, chat = context + + def chunk(kind, data): + return ( + struct.pack("!I", len(data)) + + kind + + data + + struct.pack("!I", zlib.crc32(kind + data)) + ) + + header = struct.pack("!IIBBBBB", 8000, 5001, 8, 2, 0, 0, 0) + image = ( + b"\x89PNG\r\n\x1a\n" + + chunk(b"IHDR", header) + + chunk(b"IDAT", zlib.compress(b"\0")) + + chunk(b"IEND", b"") + ) + response = await upload(client, alice, chat, image) + assert response.status_code == 413, response.text + + +async def test_unknown_and_other_chat_attachment_are_404(client, context): + _, alice, bob, _, chat = context + attachment = (await upload(client, alice, chat)).json() + other_chat = await create_chat(client, alice, bob) + for id in (attachment["id"], str(uuid4())): + response = await client.post( + f"/api/v1/chats/{other_chat['id']}/messages", + json={"text": "", "attachment_ids": [id]}, + headers={**bearer(alice), **idempotency_header()}, + ) + assert response.status_code == 404 + + +async def test_duplicate_ids_are_400(client, context): + _, alice, _, _, chat = context + id = (await upload(client, alice, chat)).json()["id"] + response = await client.post( + f"/api/v1/chats/{chat['id']}/messages", + json={"text": "", "attachment_ids": [id, id]}, + headers={**bearer(alice), **idempotency_header()}, + ) + assert response.status_code == 400 + + +async def test_empty_ids_and_absent_ids_have_same_idempotency(client, context): + _, alice, _, _, chat = context + headers = {**bearer(alice), **idempotency_header()} + path = f"/api/v1/chats/{chat['id']}/messages" + first = await client.post(path, json={"text": "same"}, headers=headers) + second = await client.post( + path, json={"text": "same", "attachment_ids": []}, headers=headers + ) + assert first.status_code == second.status_code == 201 + assert first.json() == second.json() + + +async def test_s3_outage_is_503(client, context): + storage, alice, _, _, chat = context + id = (await upload(client, alice, chat)).json()["id"] + await finish_attachment(client, storage, alice, id) + storage.down = True + response = await client.get( + f"/api/v1/attachments/{id}/content", headers=bearer(alice) + ) + assert response.status_code == 503 + assert (await client.get("/health/ready")).status_code == 503 + + +async def test_uncertain_put_is_compensated(client, context, db_engine): + storage, alice, _, _, chat = context + storage.fail_put = True + response = await upload(client, alice, chat) + assert response.status_code == 503 + assert not storage.objects + async with AsyncSession(db_engine) as session: + assert await session.scalar(select(func.count()).select_from(UploadIntent)) == 0 + + +async def test_failure_after_s3_write_compensates(client, context, monkeypatch): + storage, alice, _, _, chat = context + + async def fail(*args, **kwargs): + raise OperationalError("injected", {}, None) + + monkeypatch.setattr(repository, "create_attachment", fail) + response = await upload(client, alice, chat) + assert response.status_code == 503 + assert not storage.objects + + +async def test_ambiguous_successful_commit_keeps_original( + client, context, db_engine, monkeypatch +): + storage, alice, _, _, chat = context + original = AsyncSession.commit + count = 0 + + async def uncertain(session): + nonlocal count + count += 1 + await original(session) + if count == 2: + raise OperationalError("lost commit acknowledgement", {}, None) + + monkeypatch.setattr(AsyncSession, "commit", uncertain) + response = await upload(client, alice, chat) + assert response.status_code == 503 + assert len(storage.objects) == 1 + async with AsyncSession(db_engine) as session: + assert await session.scalar(select(func.count()).select_from(Attachment)) == 1 + assert await session.scalar(select(func.count()).select_from(UploadIntent)) == 0 + + +async def test_failed_compensation_then_dry_run_and_cleanup(client, context, db_engine): + storage, alice, _, _, chat = context + storage.fail_put = storage.fail_delete = True + assert (await upload(client, alice, chat)).status_code == 503 + assert len(storage.objects) == 1 + async with AsyncSession(db_engine) as session: + intent = await session.scalar(select(UploadIntent)) + intent.created_at = datetime.now(timezone.utc) - timedelta(days=2) + await session.commit() + storage.fail_put = storage.fail_delete = False + async with AsyncSession(db_engine) as session: + dry_run = await domain.reconcile_attachments(session, storage) + assert dry_run.candidates == 1 and dry_run.deleted == 0 + assert storage.objects + applied = await domain.reconcile_attachments(session, storage, dry_run=False) + assert applied.deleted == 1 and not storage.objects + repeated = await domain.reconcile_attachments(session, storage, dry_run=False) + assert repeated.deleted == 0 + + +async def test_cleanup_keeps_fresh_and_skips_locked_uploads(client, context, db_engine): + storage, _, _, _, _ = context + old_id, fresh_id = uuid4(), uuid4() + async with AsyncSession(db_engine) as session: + session.add_all( + [ + UploadIntent( + id=old_id, + object_key="originals/old", + created_at=datetime.now(timezone.utc) - timedelta(days=2), + ), + UploadIntent(id=fresh_id, object_key="originals/fresh"), + ] + ) + await session.commit() + async with AsyncSession(db_engine) as uploader, AsyncSession(db_engine) as cleaner: + await repository.lock_upload(uploader, old_id) + result = await domain.reconcile_attachments(cleaner, storage, dry_run=False) + assert result.examined == 0 + await uploader.rollback() + result = await domain.reconcile_attachments(cleaner, storage, dry_run=False) + assert result.examined == 1 + assert await cleaner.get(UploadIntent, fresh_id) is not None + + +async def test_client_disconnect_before_put_has_no_side_effects(client, context): + storage, alice, _, _, chat = context + + async def interrupted(): + yield PNG[:16] + raise ClientDisconnect() + + response = await upload(client, alice, chat, interrupted()) + assert response.status_code == 400 + assert not storage.objects + + +async def test_upload_deadline_cancels_validation(client, context, monkeypatch): + storage, alice, _, _, chat = context + storage.settings = storage.settings.model_copy( + update={"upload_timeout_seconds": 0.02} + ) + + async def stalled(*args): + await asyncio.sleep(10) + + monkeypatch.setattr(domain, "validate_image", stalled) + response = await upload(client, alice, chat) + assert response.status_code == 400 + assert not storage.objects + + +async def test_cancelled_put_is_compensated(client, context, db_engine, monkeypatch): + storage, alice, _, _, chat = context + entered = asyncio.Event() + original = storage.put_file + + async def interrupted(*args, **kwargs): + await original(*args, **kwargs) + entered.set() + await asyncio.sleep(10) + + monkeypatch.setattr(storage, "put_file", interrupted) + task = asyncio.create_task(upload(client, alice, chat)) + await asyncio.wait_for(entered.wait(), timeout=10) + task.cancel() + with pytest.raises(asyncio.CancelledError): + await task + assert not storage.objects + async with AsyncSession(db_engine) as session: + assert await session.scalar(select(func.count()).select_from(UploadIntent)) == 0 + + +async def test_cleanup_never_deletes_ready_attachment(client, context, db_engine): + storage, alice, _, _, chat = context + id = (await upload(client, alice, chat)).json()["id"] + await finish_attachment(client, storage, alice, id) + async with AsyncSession(db_engine) as session: + attachment = await session.get(Attachment, UUID(id)) + key = attachment.object_key + # Искусственно оставляем старый журнал у уже подтверждённого объекта. + session.add( + UploadIntent( + id=uuid4(), + object_key=key, + created_at=datetime.now(timezone.utc) - timedelta(days=2), + ) + ) + await session.commit() + result = await domain.reconcile_attachments(session, storage, dry_run=False) + assert result.examined == 1 and result.deleted == 0 + assert key in storage.objects diff --git a/student-tests/test_auth.py b/student-tests/test_auth.py new file mode 100644 index 0000000..6746320 --- /dev/null +++ b/student-tests/test_auth.py @@ -0,0 +1,298 @@ +import asyncio +import hashlib +from datetime import datetime + +from httpx import AsyncClient + +from app.main import create_app +from conftest import close_app, make_client +from helpers import ( + PASSWORD, + assert_request_id, + basic_header, + bearer, + create_user, + login, + register, +) + + +async def test_login_returns_opaque_bearer_session(client: AsyncClient): + user = await register(client) + + response = await client.post( + "/api/v1/auth/sessions", + headers=basic_header(user["username"], user["password"]), + ) + + assert response.status_code == 201 + body = response.json() + assert set(body) == {"token", "token_type", "expires_at", "user"} + assert body["token_type"] == "Bearer" + assert len(body["token"]) >= 43 + assert body["token"] not in (user["id"], user["username"]) + assert body["user"]["id"] == user["id"] + assert body["expires_at"].endswith("Z") + assert datetime.fromisoformat(body["expires_at"]) + assert_request_id(response) + + +async def test_each_login_issues_a_different_token(client: AsyncClient): + user = await register(client) + first = await login(client, user) + second = await login(client, user) + + assert first["token"] != second["token"] + + +async def test_password_with_colon_works(client: AsyncClient): + user = await register(client, password="pass:with:colons-123") + + assert (await login(client, user))["token"] + + +async def test_unicode_password_works(client: AsyncClient): + user = await register(client, password="Пароль-с-юникодом-🔑-123") + + assert (await login(client, user))["token"] + + +async def test_wrong_password_and_unknown_user_look_identical(client: AsyncClient): + user = await register(client) + + wrong_password = await client.post( + "/api/v1/auth/sessions", + headers=basic_header(user["username"], "wrong-password-123"), + ) + unknown_user = await client.post( + "/api/v1/auth/sessions", + headers=basic_header("no_such_user", "wrong-password-123"), + ) + + for response in (wrong_password, unknown_user): + assert response.status_code == 401 + assert response.json()["error"]["code"] == "unauthorized" + assert response.headers["WWW-Authenticate"].startswith( + 'Basic realm="messenger"' + ) + assert_request_id(response) + assert ( + wrong_password.json()["error"]["message"] + == unknown_user.json()["error"]["message"] + ) + + +async def test_login_requires_basic_scheme(client: AsyncClient): + user = await register(client) + session = await login(client, user) + + for headers in ({}, bearer(session), {"Authorization": "Basic !!!not-base64"}): + response = await client.post("/api/v1/auth/sessions", headers=headers) + assert response.status_code == 401 + assert response.headers["WWW-Authenticate"].startswith("Basic") + + +async def test_business_endpoints_require_bearer(client: AsyncClient): + user = await register(client) + + for headers in ( + {}, + basic_header(user["username"], user["password"]), + {"Authorization": "Bearer "}, + {"Authorization": "Bearer unknown-token-value"}, + {"X-User-Id": user["id"]}, + ): + response = await client.get("/api/v1/users/me", headers=headers) + assert response.status_code == 401, headers + assert response.json()["error"]["code"] == "unauthorized" + assert response.headers["WWW-Authenticate"].startswith( + 'Bearer realm="messenger"' + ) + assert_request_id(response) + + +async def test_x_user_id_cannot_override_bearer_identity(client: AsyncClient): + alice = await create_user(client) + eve = await create_user(client) + + response = await client.get( + "/api/v1/users/me", + headers={**bearer(alice), "X-User-Id": eve["id"]}, + ) + + assert response.status_code == 200 + assert response.json()["id"] == alice["id"] + + +async def test_logout_revokes_only_current_session(client: AsyncClient): + user = await register(client) + first = await login(client, user) + second = await login(client, user) + + assert ( + await client.delete("/api/v1/auth/sessions/current", headers=bearer(first)) + ).status_code == 204 + + assert ( + await client.get("/api/v1/users/me", headers=bearer(first)) + ).status_code == 401 + assert ( + await client.get("/api/v1/users/me", headers=bearer(second)) + ).status_code == 200 + + +async def test_logout_twice_returns_401(client: AsyncClient): + session = await create_user(client) + + first = await client.delete( + "/api/v1/auth/sessions/current", headers=bearer(session) + ) + again = await client.delete( + "/api/v1/auth/sessions/current", headers=bearer(session) + ) + + assert first.status_code == 204 + assert first.content == b"" + assert again.status_code == 401 + + +async def test_session_expires_after_ttl(make_settings): + app = create_app(make_settings(session_ttl_seconds=2)) + async with make_client(app) as client: + session = await create_user(client) + assert ( + await client.get("/api/v1/users/me", headers=bearer(session)) + ).status_code == 200 + + await asyncio.sleep(3) + + response = await client.get("/api/v1/users/me", headers=bearer(session)) + assert response.status_code == 401 + assert response.headers["WWW-Authenticate"].startswith("Bearer") + await close_app(app) + + +async def test_token_is_stored_only_as_sha256_key(client: AsyncClient, redis_client): + session = await create_user(client) + + keys = [key async for key in redis_client.scan_iter("session:*")] + token_hash = hashlib.sha256(session["token"].encode()).hexdigest() + + assert keys == [f"session:{token_hash}"] + assert await redis_client.get(keys[0]) == session["id"] + assert all(session["token"] not in key for key in keys) + + +async def test_password_is_not_stored_in_plaintext(client: AsyncClient, db_engine): + from sqlalchemy import text + + await register(client, username="hash_check") + + async with db_engine.connect() as connection: + result = await connection.execute( + text("SELECT password_hash FROM users WHERE username = 'hash_check'") + ) + stored = result.scalar_one() + + assert PASSWORD not in stored + assert stored.startswith("$argon2id$") + + +async def test_login_rejects_out_of_range_password_like_wrong_password( + client: AsyncClient, +): + user = await register(client) + reference = await client.post( + "/api/v1/auth/sessions", + headers=basic_header(user["username"], "wrong-password-123"), + ) + + for password in ("x" * 11, "x" * 129, ""): + response = await client.post( + "/api/v1/auth/sessions", + headers=basic_header(user["username"], password), + ) + assert response.status_code == 401 + assert ( + response.json()["error"]["message"] == reference.json()["error"]["message"] + ) + assert ( + response.headers["WWW-Authenticate"] + == reference.headers["WWW-Authenticate"] + ) + + +async def test_malformed_basic_credentials_return_401(client: AsyncClient): + import base64 + + def raw(value: bytes) -> dict[str, str]: + return {"Authorization": "Basic " + base64.b64encode(value).decode()} + + for headers in ( + raw(b"no-colon-here"), + raw(b":password-without-user"), + raw(b"\xff\xfe:invalid-utf8"), + {"Authorization": "Basic"}, + {"Authorization": "Digest abc"}, + ): + response = await client.post("/api/v1/auth/sessions", headers=headers) + assert response.status_code == 401, headers + assert response.headers["WWW-Authenticate"].startswith("Basic") + + +async def test_unknown_user_takes_comparable_time_to_wrong_password( + client: AsyncClient, +): + import statistics + import time + + user = await register(client) + + async def measure(username: str) -> float: + samples = [] + for _ in range(5): + started = time.perf_counter() + await client.post( + "/api/v1/auth/sessions", + headers=basic_header(username, "wrong-password-123"), + ) + samples.append(time.perf_counter() - started) + return statistics.median(samples) + + wrong_password = await measure(user["username"]) + unknown_user = await measure("no_such_user") + + assert unknown_user > wrong_password * 0.5 + + +async def test_invalid_basic_username_returns_401_not_500(client: AsyncClient): + user = await register(client) + reference = await client.post( + "/api/v1/auth/sessions", + headers=basic_header(user["username"], "wrong-password-123"), + ) + + for username in ("bad\u0000name", "UPPER", "no", "x" * 33, "имя", "a b c"): + response = await client.post( + "/api/v1/auth/sessions", + headers=basic_header(username, "wrong-password-123"), + ) + assert response.status_code == 401, username + assert ( + response.json()["error"]["message"] == reference.json()["error"]["message"] + ) + assert ( + response.headers["WWW-Authenticate"] + == reference.headers["WWW-Authenticate"] + ) + + +async def test_whitespace_only_password_at_login_returns_401(client: AsyncClient): + user = await register(client) + + response = await client.post( + "/api/v1/auth/sessions", headers=basic_header(user["username"], " " * 12) + ) + + assert response.status_code == 401 + assert response.headers["WWW-Authenticate"].startswith("Basic") diff --git a/student-tests/test_chats.py b/student-tests/test_chats.py new file mode 100644 index 0000000..475c946 --- /dev/null +++ b/student-tests/test_chats.py @@ -0,0 +1,209 @@ +from urllib.parse import quote +from uuid import uuid4 + +import pytest +from httpx import AsyncClient + +from helpers import assert_request_id, bearer, create_chat, create_user + + +async def test_create_and_get_chat(client: AsyncClient): + alice = await create_user(client) + bob = await create_user(client) + chat = await create_chat(client, alice, bob) + + response = await client.get( + f"/api/v1/chats/{chat['id']}", + headers=bearer(bob), + ) + + assert response.status_code == 200 + assert response.json() == chat + assert_request_id(response) + + +async def test_chat_is_not_visible_to_outsider(client: AsyncClient): + alice = await create_user(client) + bob = await create_user(client) + eve = await create_user(client) + chat = await create_chat(client, alice, bob) + + response = await client.get( + f"/api/v1/chats/{chat['id']}", + headers=bearer(eve), + ) + + assert response.status_code == 404 + assert response.json()["error"]["code"] == "not_found" + assert_request_id(response) + + +async def test_chat_creation_requires_creator_in_members(client: AsyncClient): + alice = await create_user(client) + bob = await create_user(client) + + response = await client.post( + "/api/v1/chats", + headers=bearer(alice), + json={"title": "Чат", "member_ids": [bob["id"]]}, + ) + + assert response.status_code == 400 + assert response.json()["error"]["code"] == "invalid_request" + + +@pytest.mark.parametrize( + "payload", + [ + {"title": "", "member_ids": []}, + {"title": " ", "member_ids": []}, + ], +) +async def test_chat_payload_boundaries(client: AsyncClient, payload: dict): + alice = await create_user(client) + payload["member_ids"] = [alice["id"]] + + response = await client.post( + "/api/v1/chats", + headers=bearer(alice), + json=payload, + ) + + assert response.status_code == 400 + assert response.json()["error"]["code"] == "invalid_request" + + +async def test_duplicate_members_are_rejected(client: AsyncClient): + alice = await create_user(client) + bob = await create_user(client) + + response = await client.post( + "/api/v1/chats", + headers=bearer(alice), + json={"title": "Чат", "member_ids": [alice["id"], bob["id"], bob["id"]]}, + ) + + assert response.status_code == 400 + assert response.json()["error"]["code"] == "invalid_request" + + +async def test_unknown_member_is_rejected(client: AsyncClient): + alice = await create_user(client) + + response = await client.post( + "/api/v1/chats", + headers=bearer(alice), + json={"title": "Чат", "member_ids": [alice["id"], str(uuid4())]}, + ) + + assert response.status_code == 400 + assert response.json()["error"]["code"] == "invalid_request" + + +async def test_chat_exact_title_limit_is_accepted(client: AsyncClient): + alice = await create_user(client) + response = await client.post( + "/api/v1/chats", + headers=bearer(alice), + json={"title": "x" * 100, "member_ids": [alice["id"]]}, + ) + + assert response.status_code == 201 + assert len(response.json()["title"]) == 100 + + +async def test_chat_list_hides_chats_without_membership(client: AsyncClient): + alice = await create_user(client) + bob = await create_user(client) + chat_for_bob = await create_chat(client, bob, title="Only Bob") + chat_for_alice = await create_chat(client, alice, title="Only Alice") + + response = await client.get( + "/api/v1/chats?limit=100", + headers=bearer(alice), + ) + + assert response.status_code == 200 + ids = {item["id"] for item in response.json()["items"]} + assert chat_for_alice["id"] in ids + assert chat_for_bob["id"] not in ids + + +async def test_nonexistent_chat_returns_404(client: AsyncClient): + alice = await create_user(client) + + response = await client.get( + "/api/v1/chats/00000000-0000-4000-8000-000000000000", + headers=bearer(alice), + ) + + assert response.status_code == 404 + assert response.json()["error"]["code"] == "not_found" + assert_request_id(response) + + +async def test_failed_chat_creation_leaves_no_partial_data( + client: AsyncClient, db_engine +): + """Атомарность: неизвестный участник -> нет ни чата, ни записей членства.""" + from sqlalchemy import text + + alice = await create_user(client) + response = await client.post( + "/api/v1/chats", + headers=bearer(alice), + json={"title": "Чат", "member_ids": [alice["id"], str(uuid4())]}, + ) + assert response.status_code == 400 + + async with db_engine.connect() as connection: + chats = ( + await connection.execute(text("SELECT count(*) FROM chats")) + ).scalar_one() + members = ( + await connection.execute(text("SELECT count(*) FROM chat_members")) + ).scalar_one() + assert chats == 0 and members == 0 + + +async def test_chat_list_pagination_and_order(client: AsyncClient): + alice = await create_user(client) + chats = [await create_chat(client, alice, title=f"chat-{i}") for i in range(5)] + + page1 = (await client.get("/api/v1/chats?limit=2", headers=bearer(alice))).json() + page2 = ( + await client.get( + f"/api/v1/chats?limit=2&cursor={quote(page1['next_cursor'], safe='')}", + headers=bearer(alice), + ) + ).json() + page3 = ( + await client.get( + f"/api/v1/chats?limit=2&cursor={quote(page2['next_cursor'], safe='')}", + headers=bearer(alice), + ) + ).json() + + ids = [c["id"] for page in (page1, page2, page3) for c in page["items"]] + assert ids == [c["id"] for c in chats] + assert page3["next_cursor"] is None + + +async def test_chat_endpoints_require_bearer(client: AsyncClient): + assert (await client.get("/api/v1/chats")).status_code == 401 + assert ( + await client.post("/api/v1/chats", json={"title": "x", "member_ids": []}) + ).status_code in (401, 400) + + +async def test_nul_in_chat_title_is_rejected(client: AsyncClient): + alice = await create_user(client) + + response = await client.post( + "/api/v1/chats", + headers=bearer(alice), + json={"title": "chat\u0000title", "member_ids": [alice["id"]]}, + ) + + assert response.status_code == 400 + assert response.json()["error"]["code"] == "invalid_request" diff --git a/student-tests/test_concurrency.py b/student-tests/test_concurrency.py new file mode 100644 index 0000000..bf07e6f --- /dev/null +++ b/student-tests/test_concurrency.py @@ -0,0 +1,273 @@ +"""Конкурентность на реальной БД: гонка регистрации и параллельная запись.""" + +import asyncio +from collections import Counter +from uuid import uuid4 + +from sqlalchemy import text + +from app.main import create_app +from conftest import close_app, make_client +from helpers import ( + PASSWORD, + basic_header, + bearer, + create_user, + idempotency_header, + register, +) + + +async def test_parallel_registration_of_same_username_creates_exactly_one_user( + make_settings, +): + app = create_app( + make_settings(max_in_flight=64, db_pool_size=20, db_max_overflow=20) + ) + + async with make_client(app) as client: + responses = await asyncio.gather( + *( + client.post( + "/api/v1/users", + json={ + "username": "race_user", + "display_name": "Race", + "password": PASSWORD, + }, + ) + for _ in range(16) + ) + ) + await close_app(app) + + statuses = Counter(response.status_code for response in responses) + assert statuses == Counter({201: 1, 409: 15}), statuses + + +async def test_100_messages_from_10_clients(make_settings): + app = create_app( + make_settings( + max_messages=1000, max_in_flight=100, db_pool_size=20, db_max_overflow=20 + ) + ) + + async with make_client(app) as client: + users = [ + await create_user(client, username=f"load_{i}_{uuid4().hex[:6]}") + for i in range(10) + ] + created = await client.post( + "/api/v1/chats", + headers=bearer(users[0]), + json={"title": "Concurrency", "member_ids": [u["id"] for u in users]}, + ) + chat = created.json() + + async def worker(index: int, user: dict) -> list[dict]: + responses = await asyncio.gather( + *( + client.post( + f"/api/v1/chats/{chat['id']}/messages", + headers={**bearer(user), **idempotency_header()}, + json={"text": f"client-{index}-message-{n}"}, + ) + for n in range(10) + ) + ) + assert all(r.status_code == 201 for r in responses), [ + r.text for r in responses if r.status_code != 201 + ] + return [r.json() for r in responses] + + results = await asyncio.gather(*(worker(i, u) for i, u in enumerate(users))) + messages = [m for batch in results for m in batch] + + assert len(messages) == 100 + assert len({m["id"] for m in messages}) == 100 + assert Counter(m["sender_id"] for m in messages) == Counter( + {u["id"]: 10 for u in users} + ) + + history = await client.get( + f"/api/v1/chats/{chat['id']}/messages?limit=100", headers=bearer(users[0]) + ) + items = history.json()["items"] + assert len(items) == 100 + assert len({m["id"] for m in items}) == 100 + await close_app(app) + + +async def test_chat_creation_in_parallel_is_atomic(make_settings, db_engine): + app = create_app( + make_settings(max_in_flight=32, db_pool_size=20, db_max_overflow=20) + ) + + async with make_client(app) as client: + alice = await create_user(client) + bob = await create_user(client) + responses = await asyncio.gather( + *( + client.post( + "/api/v1/chats", + headers=bearer(alice), + json={"title": f"c{i}", "member_ids": [alice["id"], bob["id"]]}, + ) + for i in range(10) + ) + ) + assert all(r.status_code == 201 for r in responses) + await close_app(app) + + async with db_engine.connect() as connection: + chats = ( + await connection.execute(text("SELECT count(*) FROM chats")) + ).scalar_one() + members = ( + await connection.execute(text("SELECT count(*) FROM chat_members")) + ).scalar_one() + assert chats == 10 and members == 20 + + +async def test_parallel_registration_of_distinct_usernames_all_succeed(make_settings): + app = create_app(make_settings(max_in_flight=64)) + async with make_client(app) as client: + responses = await asyncio.gather( + *( + client.post( + "/api/v1/users", + json={ + "username": f"distinct_{i}", + "display_name": "D", + "password": PASSWORD, + }, + ) + for i in range(12) + ) + ) + await close_app(app) + + assert [r.status_code for r in responses] == [201] * 12 + assert len({r.json()["id"] for r in responses}) == 12 + + +async def test_parallel_logins_issue_distinct_valid_tokens(make_settings): + app = create_app(make_settings(max_in_flight=64)) + async with make_client(app) as client: + user = await register(client) + responses = await asyncio.gather( + *( + client.post( + "/api/v1/auth/sessions", + headers=basic_header(user["username"], user["password"]), + ) + for _ in range(10) + ) + ) + tokens = [r.json()["token"] for r in responses] + checks = await asyncio.gather( + *( + client.get( + "/api/v1/users/me", headers={"Authorization": f"Bearer {token}"} + ) + for token in tokens + ) + ) + await close_app(app) + + assert all(r.status_code == 201 for r in responses) + assert len(set(tokens)) == 10 + assert all(r.status_code == 200 for r in checks) + + +async def test_parallel_logout_of_same_token_succeeds_once(make_settings): + app = create_app(make_settings(max_in_flight=64)) + async with make_client(app) as client: + session = await create_user(client) + responses = await asyncio.gather( + *( + client.delete("/api/v1/auth/sessions/current", headers=bearer(session)) + for _ in range(10) + ) + ) + await close_app(app) + + assert Counter(r.status_code for r in responses) == Counter({204: 1, 401: 9}) + + +async def test_message_limit_is_exact_under_concurrency(make_settings, db_engine): + app = create_app( + make_settings( + max_messages=5, max_in_flight=64, db_pool_size=20, db_max_overflow=20 + ) + ) + async with make_client(app) as client: + user = await create_user(client) + chat = ( + await client.post( + "/api/v1/chats", + headers=bearer(user), + json={"title": "limit", "member_ids": [user["id"]]}, + ) + ).json() + responses = await asyncio.gather( + *( + client.post( + f"/api/v1/chats/{chat['id']}/messages", + headers={**bearer(user), **idempotency_header()}, + json={"text": f"m{i}"}, + ) + for i in range(20) + ) + ) + await close_app(app) + + assert Counter(r.status_code for r in responses) == Counter({201: 5, 503: 15}) + async with db_engine.connect() as connection: + stored = ( + await connection.execute(text("SELECT count(*) FROM messages")) + ).scalar_one() + counter = ( + await connection.execute( + text("SELECT value FROM counters WHERE name = 'messages'") + ) + ).scalar_one() + assert stored == counter == 5 + + +async def test_failed_chat_insert_rolls_back_whole_transaction( + make_settings, db_engine, monkeypatch +): + import app.domain.chats as chats_domain + + async def accept_everyone(_session, user_ids): + return set(user_ids) + + app = create_app(make_settings()) + async with make_client(app) as client: + alice = await create_user(client) + monkeypatch.setattr( + chats_domain.users_storage, "get_existing_user_ids", accept_everyone + ) + response = await client.post( + "/api/v1/chats", + headers=bearer(alice), + json={"title": "broken", "member_ids": [alice["id"], str(uuid4())]}, + ) + monkeypatch.undo() + after = await client.post( + "/api/v1/chats", + headers=bearer(alice), + json={"title": "ok", "member_ids": [alice["id"]]}, + ) + await close_app(app) + + assert response.status_code == 400 + assert after.status_code == 201 + async with db_engine.connect() as connection: + titles = (await connection.execute(text("SELECT title FROM chats"))).scalars() + members = ( + await connection.execute(text("SELECT count(*) FROM chat_members")) + ).scalar_one() + assert list(titles) == ["ok"] + assert members == 1 diff --git a/student-tests/test_constraints.py b/student-tests/test_constraints.py new file mode 100644 index 0000000..11aa1f3 --- /dev/null +++ b/student-tests/test_constraints.py @@ -0,0 +1,46 @@ +"""Ограничения на уровне БД: приложение — не единственный защитник данных.""" + +import pytest +from sqlalchemy import text +from sqlalchemy.exc import IntegrityError + +from helpers import create_chat, create_user + + +async def test_duplicate_username_is_rejected_by_database(client, db_engine): + await create_user(client, username="unique_name") + + with pytest.raises(IntegrityError): + async with db_engine.begin() as connection: + await connection.execute( + text( + "INSERT INTO users (id, username, display_name, password_hash) " + "VALUES (gen_random_uuid(), 'unique_name', 'Other', 'hash')" + ) + ) + + +async def test_message_requires_existing_chat(client, db_engine): + alice = await create_user(client) + + with pytest.raises(IntegrityError): + async with db_engine.begin() as connection: + await connection.execute( + text( + "INSERT INTO messages (id, chat_id, sender_id, text) " + "VALUES (gen_random_uuid(), gen_random_uuid(), :sender, 'x')" + ), + {"sender": alice["id"]}, + ) + + +async def test_duplicate_membership_is_rejected_by_database(client, db_engine): + alice = await create_user(client) + chat = await create_chat(client, alice) + + with pytest.raises(IntegrityError): + async with db_engine.begin() as connection: + await connection.execute( + text("INSERT INTO chat_members (chat_id, user_id) VALUES (:c, :u)"), + {"c": chat["id"], "u": alice["id"]}, + ) diff --git a/student-tests/test_errors.py b/student-tests/test_errors.py new file mode 100644 index 0000000..3fe5e93 --- /dev/null +++ b/student-tests/test_errors.py @@ -0,0 +1,76 @@ +import json +import logging + +from httpx import AsyncClient + +from helpers import assert_request_id + + +async def test_missing_token_returns_401(client: AsyncClient): + response = await client.get("/api/v1/users/me") + + assert response.status_code == 401 + assert response.json()["error"]["code"] == "unauthorized" + assert_request_id(response) + + +async def test_garbage_token_returns_401(client: AsyncClient): + response = await client.get( + "/api/v1/users/me", headers={"Authorization": "Bearer garbage"} + ) + + assert response.status_code == 401 + assert response.json()["error"]["code"] == "unauthorized" + assert_request_id(response) + + +async def test_malformed_json_returns_400(client: AsyncClient): + response = await client.post( + "/api/v1/users", + content='{"username":"alice",', + headers={"Content-Type": "application/json"}, + ) + + assert response.status_code == 400 + assert response.json()["error"]["code"] == "invalid_request" + assert_request_id(response) + + +async def test_not_found_returns_404(client: AsyncClient): + response = await client.get("/no-such-path") + + assert response.status_code == 404 + assert response.json()["error"]["code"] == "not_found" + assert_request_id(response) + + +async def test_method_not_allowed_preserves_405(client: AsyncClient): + response = await client.delete("/api/v1/users") + + assert response.status_code == 405 + assert response.json()["error"]["code"] == "invalid_request" + assert_request_id(response) + + +async def test_unhandled_exception_is_hidden_from_client( + client_no_raise: AsyncClient, caplog +): + with caplog.at_level(logging.ERROR, logger="app.errors.handlers"): + response = await client_no_raise.get("/__test__/explode") + + assert response.status_code == 500 + payload = response.json() + assert payload["error"]["code"] == "internal_error" + assert payload["error"]["message"] == "Внутренняя ошибка сервера" + assert "test-secret" not in json.dumps(payload, ensure_ascii=False) + assert "Traceback" not in json.dumps(payload, ensure_ascii=False) + assert "Unhandled error request_id=" in caplog.text + assert "test-secret" in caplog.text + assert_request_id(response) + + +async def test_success_response_contains_request_id(client: AsyncClient): + response = await client.get("/health/live") + + assert response.status_code == 200 + assert response.headers.get("X-Request-Id") diff --git a/student-tests/test_failures.py b/student-tests/test_failures.py new file mode 100644 index 0000000..9338c3b --- /dev/null +++ b/student-tests/test_failures.py @@ -0,0 +1,138 @@ +"""Недоступность Redis и PostgreSQL: ограниченный 503, без анонимного доступа.""" + +import time + +from app.main import create_app +from conftest import close_app, make_client +from helpers import PASSWORD, assert_request_id, basic_header, bearer, create_user + +ME = "/api/v1/users/me" +DEAD_DATABASE_URL = "postgresql+asyncpg://nobody:secretpass@127.0.0.1:1/none" + + +def assert_unavailable(response) -> None: + assert response.status_code == 503, response.text + assert response.json()["error"]["code"] == "unavailable" + assert "secretpass" not in response.text + assert "Traceback" not in response.text + assert_request_id(response) + + +async def test_redis_down_gives_503_for_login_and_protected_endpoints(make_settings): + alive = create_app(make_settings()) + async with make_client(alive) as client: + session = await create_user(client) + await close_app(alive) + + app = create_app(make_settings(redis_port=1, redis_connect_timeout_seconds=0.5)) + async with make_client(app, raise_app_exceptions=False) as client: + started = time.perf_counter() + protected = await client.get(ME, headers=bearer(session)) + elapsed = time.perf_counter() - started + + login = await client.post( + "/api/v1/auth/sessions", + headers=basic_header(session["username"], session["password"]), + ) + logout = await client.delete( + "/api/v1/auth/sessions/current", headers=bearer(session) + ) + ready = await client.get("/health/ready") + live = await client.get("/health/live") + + await close_app(app) + + for response in (protected, login, logout, ready): + assert_unavailable(response) + assert live.status_code == 200 + assert elapsed < 3 + + +async def test_redis_down_keeps_registration_working(make_settings): + app = create_app(make_settings(redis_port=1, redis_connect_timeout_seconds=0.5)) + async with make_client(app, raise_app_exceptions=False) as client: + response = await client.post( + "/api/v1/users", + json={"username": "no_redis", "display_name": "N", "password": PASSWORD}, + ) + await close_app(app) + + assert response.status_code == 201 + + +async def test_database_down_with_valid_session_gives_503(make_settings): + alive = create_app(make_settings()) + async with make_client(alive) as client: + session = await create_user(client) + await close_app(alive) + + app = create_app( + make_settings(database_url=DEAD_DATABASE_URL, db_connect_timeout_seconds=1) + ) + async with make_client(app, raise_app_exceptions=False) as client: + protected = await client.get(ME, headers=bearer(session)) + chats = await client.get("/api/v1/chats", headers=bearer(session)) + login = await client.post( + "/api/v1/auth/sessions", + headers=basic_header(session["username"], session["password"]), + ) + await close_app(app) + + for response in (protected, chats, login): + assert_unavailable(response) + + +async def test_dependency_failure_never_authenticates_anonymous_requests(make_settings): + app = create_app(make_settings(redis_port=1, redis_connect_timeout_seconds=0.5)) + async with make_client(app, raise_app_exceptions=False) as client: + no_token = await client.get(ME) + garbage = await client.get(ME, headers={"Authorization": "Bearer garbage"}) + await close_app(app) + + assert no_token.status_code == 401 + assert_unavailable(garbage) + + +async def test_statement_timeout_gives_503(make_settings, monkeypatch): + from sqlalchemy import text + + import app.domain.users as users_domain + + async def slow_lookup(session, _username): + await session.execute(text("SELECT pg_sleep(1)")) + + app = create_app(make_settings(db_statement_timeout_ms=100)) + monkeypatch.setattr(users_domain.users_storage, "get_user_by_username", slow_lookup) + async with make_client(app, raise_app_exceptions=False) as client: + response = await client.post( + "/api/v1/users", + json={"username": "slow_user", "display_name": "S", "password": PASSWORD}, + ) + await close_app(app) + + assert_unavailable(response) + assert response.headers["Retry-After"] == "1" + + +async def test_non_transient_database_error_stays_500(make_settings, monkeypatch): + from sqlalchemy import text + + import app.domain.users as users_domain + + async def broken_lookup(session, _username): + await session.execute(text("SELECT 1 / 0")) + + app = create_app(make_settings()) + monkeypatch.setattr( + users_domain.users_storage, "get_user_by_username", broken_lookup + ) + async with make_client(app, raise_app_exceptions=False) as client: + response = await client.post( + "/api/v1/users", + json={"username": "broken_user", "display_name": "B", "password": PASSWORD}, + ) + await close_app(app) + + assert response.status_code == 500 + assert response.json()["error"]["code"] == "internal_error" + assert "division" not in response.text diff --git a/student-tests/test_health.py b/student-tests/test_health.py new file mode 100644 index 0000000..26d1589 --- /dev/null +++ b/student-tests/test_health.py @@ -0,0 +1,62 @@ +from httpx import AsyncClient + +from app.main import create_app +from conftest import close_app, make_client +from helpers import assert_request_id + + +async def test_liveness(client: AsyncClient): + response = await client.get("/health/live") + + assert response.status_code == 200 + assert response.json() == {"status": "ok"} + assert_request_id(response) + + +async def test_readiness(client: AsyncClient): + response = await client.get("/health/ready") + + assert response.status_code == 200 + assert response.json() == {"status": "ok"} + assert_request_id(response) + + +async def test_readiness_is_503_when_database_is_down(make_settings): + app = create_app( + make_settings( + database_url="postgresql+asyncpg://nobody:nopass@127.0.0.1:1/none", + db_connect_timeout_seconds=1, + ) + ) + async with make_client(app) as client: + assert (await client.get("/health/live")).status_code == 200 + + ready = await client.get("/health/ready") + assert ready.status_code == 503 + assert ready.json()["error"]["code"] == "unavailable" + assert_request_id(ready) + await close_app(app) + + +async def test_business_request_is_503_when_database_is_down(make_settings): + app = create_app( + make_settings( + database_url="postgresql+asyncpg://nobody:secretpass@127.0.0.1:1/none", + db_connect_timeout_seconds=1, + ) + ) + async with make_client(app, raise_app_exceptions=False) as client: + response = await client.post( + "/api/v1/users", + json={ + "username": "alice", + "display_name": "Alice", + "password": "Correct-horse-battery-1", + }, + ) + await close_app(app) + + assert response.status_code == 503 + assert response.json()["error"]["code"] == "unavailable" + assert "secretpass" not in response.text + assert_request_id(response) diff --git a/student-tests/test_history_plan.py b/student-tests/test_history_plan.py new file mode 100644 index 0000000..b19afca --- /dev/null +++ b/student-tests/test_history_plan.py @@ -0,0 +1,76 @@ +"""План запроса истории на >= 10 000 сообщений: индекс без Sort и полного скана.""" + +import json +from datetime import datetime +from uuid import UUID + +from sqlalchemy import text +from sqlalchemy.ext.asyncio import AsyncEngine + +from helpers import bearer, create_chat, create_user + +HISTORY_QUERY = """ +SELECT * FROM messages +WHERE chat_id = :chat_id AND (created_at, id) > (:after_created_at, :after_id) +ORDER BY created_at, id +LIMIT 51 +""" + + +def walk(node: dict) -> list[dict]: + nodes = [node] + for child in node.get("Plans", []): + nodes.extend(walk(child)) + return nodes + + +async def seed_messages( + engine: AsyncEngine, chat_id: str, sender_id: str, count: int +) -> None: + async with engine.begin() as connection: + await connection.execute( + text(""" + INSERT INTO messages (id, chat_id, sender_id, text, created_at) + SELECT gen_random_uuid(), :chat_id, :sender_id, 'message ' || g, + now() - make_interval(secs => :count - g) + FROM generate_series(1, :count) AS g + """), + {"chat_id": chat_id, "sender_id": sender_id, "count": count}, + ) + await connection.execute(text("ANALYZE messages")) + + +async def test_history_page_uses_composite_index(client, db_engine: AsyncEngine): + alice = await create_user(client) + target = await create_chat(client, alice, title="target") + noise = await create_chat(client, alice, title="noise") + await seed_messages(db_engine, target["id"], alice["id"], 10_000) + await seed_messages(db_engine, noise["id"], alice["id"], 10_000) + + middle = ( + await client.get( + f"/api/v1/chats/{target['id']}/messages?limit=100", headers=bearer(alice) + ) + ).json()["items"][-1] + + async with db_engine.connect() as connection: + raw_plan = ( + await connection.execute( + text(f"EXPLAIN (ANALYZE, BUFFERS, FORMAT JSON) {HISTORY_QUERY}"), + { + "chat_id": UUID(target["id"]), + "after_created_at": datetime.fromisoformat(middle["created_at"]), + "after_id": UUID(middle["id"]), + }, + ) + ).scalar_one() + + plan = (raw_plan if isinstance(raw_plan, list) else json.loads(raw_plan))[0]["Plan"] + nodes = walk(plan) + node_types = {node["Node Type"] for node in nodes} + index_names = {node.get("Index Name") for node in nodes} + + assert "ix_messages_chat_id_created_at_id" in index_names + assert "Sort" not in node_types + assert "Seq Scan" not in node_types + assert all(node.get("Actual Rows", 0) <= 51 for node in nodes) diff --git a/student-tests/test_idempotency.py b/student-tests/test_idempotency.py new file mode 100644 index 0000000..7c3aa49 --- /dev/null +++ b/student-tests/test_idempotency.py @@ -0,0 +1,190 @@ +"""Повторы сообщений через приложения с общими хранилищами.""" + +import asyncio +from contextlib import AsyncExitStack + +import pytest +from sqlalchemy import text + +from app.errors.exceptions import unavailable +from app.main import create_app +from app.storage import idempotency as key_storage +from conftest import close_app, make_client +from helpers import bearer, create_chat, create_user, idempotency_header, send_message + + +@pytest.fixture +async def replicas(request, make_settings): + overrides = getattr(request, "param", {}) + apps = [ + create_app(make_settings(instance_id=name, **overrides)) + for name in ("api-a", "api-b") + ] + try: + async with AsyncExitStack() as stack: + clients = [ + await stack.enter_async_context(make_client(app)) for app in apps + ] + yield clients + finally: + for app in apps: + await close_app(app) + + +@pytest.mark.parametrize("key", [None, "", "a b", "a/b", "x" * 129]) +async def test_invalid_key_returns_400(client, key): + user = await create_user(client) + chat = await create_chat(client, user) + headers = bearer(user) + if key is not None: + headers["Idempotency-Key"] = key + response = await client.post( + f"/api/v1/chats/{chat['id']}/messages", headers=headers, json={"text": "hello"} + ) + assert response.status_code == 400 + assert response.json()["error"]["code"] == "invalid_request" + + +@pytest.mark.parametrize("key", ["a", "x" * 128, "key_1.2:3-4"]) +async def test_valid_key_boundaries(client, key): + user = await create_user(client) + chat = await create_chat(client, user) + assert (await send_message(client, user, chat, "hello", key)).status_code == 201 + + +async def test_replay_and_conflict_across_replicas(replicas, db_engine): + first, second = replicas + user = await create_user(first) + chat = await create_chat(first, user) + original = await send_message(first, user, chat, "Привет", "same-key") + repeated = await second.post( + f"/api/v1/chats/{chat['id']}/messages", + headers={ + **bearer(user), + **idempotency_header("same-key"), + "Content-Type": "application/json", + }, + content='{ "text" : "\\u041f\\u0440\\u0438\\u0432\\u0435\\u0442" }', + ) + conflict = await send_message(second, user, chat, "другой текст", "same-key") + assert original.status_code == repeated.status_code == 201 + assert original.json() == repeated.json() + assert original.headers["X-Instance-Id"] != repeated.headers["X-Instance-Id"] + assert conflict.status_code == 409 + async with db_engine.connect() as connection: + assert ( + await connection.execute(text("SELECT count(*) FROM messages")) + ).scalar_one() == 1 + assert ( + await connection.execute( + text("SELECT value FROM counters WHERE name='messages'") + ) + ).scalar_one() == 1 + + +async def test_parallel_replays_create_one_message(replicas, db_engine): + user = await create_user(replicas[0]) + chat = await create_chat(replicas[0], user) + responses = await asyncio.gather( + *( + send_message(replicas[index % 2], user, chat, "parallel", "one-key") + for index in range(24) + ) + ) + assert all(response.status_code == 201 for response in responses) + assert len({response.json()["id"] for response in responses}) == 1 + assert {response.headers["X-Instance-Id"] for response in responses} == { + "api-a", + "api-b", + } + async with db_engine.connect() as connection: + assert ( + await connection.execute(text("SELECT count(*) FROM messages")) + ).scalar_one() == 1 + assert ( + await connection.execute(text("SELECT count(*) FROM idempotency_keys")) + ).scalar_one() == 1 + + +async def test_key_scope_separates_users_and_chats(client): + alice = await create_user(client) + bob = await create_user(client) + shared = await create_chat(client, alice, bob) + other = await create_chat(client, alice) + responses = [ + await send_message(client, alice, shared, "a", "shared-key"), + await send_message(client, bob, shared, "b", "shared-key"), + await send_message(client, alice, other, "c", "shared-key"), + ] + assert all(response.status_code == 201 for response in responses) + assert len({response.json()["id"] for response in responses}) == 3 + + +async def test_expired_key_can_be_reused_without_removing_message(client, db_engine): + user = await create_user(client) + chat = await create_chat(client, user) + first = await send_message(client, user, chat, "old", "expiring-key") + async with db_engine.begin() as connection: + await connection.execute( + text( + "UPDATE idempotency_keys SET created_at = clock_timestamp() - interval '25 hours'" + ) + ) + second = await send_message(client, user, chat, "new", "expiring-key") + assert first.status_code == second.status_code == 201 + assert first.json()["id"] != second.json()["id"] + history = await client.get( + f"/api/v1/chats/{chat['id']}/messages", headers=bearer(user) + ) + assert [item["text"] for item in history.json()["items"]] == ["old", "new"] + + +async def test_failed_transaction_does_not_poison_key(client, db_engine, monkeypatch): + user = await create_user(client) + chat = await create_chat(client, user) + original = key_storage.save_result + + async def fail_after_insert(*args): + await original(*args) + raise unavailable() + + monkeypatch.setattr(key_storage, "save_result", fail_after_insert) + failed = await send_message(client, user, chat, "retry", "retry-key") + assert failed.status_code == 503 + async with db_engine.connect() as connection: + for table in ("messages", "idempotency_keys", "counters"): + assert ( + await connection.execute(text(f"SELECT count(*) FROM {table}")) + ).scalar_one() == 0 + monkeypatch.setattr(key_storage, "save_result", original) + recovered = await send_message(client, user, chat, "retry", "retry-key") + assert recovered.status_code == 201 + + +@pytest.mark.parametrize("replicas", [{"max_messages": 1}], indirect=True) +async def test_replay_works_when_message_limit_is_full(replicas): + user = await create_user(replicas[0]) + chat = await create_chat(replicas[0], user) + first = await send_message(replicas[0], user, chat, "last", "last-key") + replay = await send_message(replicas[1], user, chat, "last", "last-key") + rejected = await send_message(replicas[1], user, chat, "extra", "other-key") + assert first.status_code == replay.status_code == 201 + assert first.json() == replay.json() + assert rejected.status_code == 503 + + +async def test_replay_checks_session_and_membership(client, db_engine): + user = await create_user(client) + chat = await create_chat(client, user) + assert ( + await send_message(client, user, chat, "private", "private-key") + ).status_code == 201 + async with db_engine.begin() as connection: + await connection.execute(text("DELETE FROM chat_members")) + assert ( + await send_message(client, user, chat, "private", "private-key") + ).status_code == 404 + await client.delete("/api/v1/auth/sessions/current", headers=bearer(user)) + assert ( + await send_message(client, user, chat, "private", "private-key") + ).status_code == 401 diff --git a/student-tests/test_image_pipeline.py b/student-tests/test_image_pipeline.py new file mode 100644 index 0000000..f317fa5 --- /dev/null +++ b/student-tests/test_image_pipeline.py @@ -0,0 +1,113 @@ +"""Реальные преобразования и OS-лимиты дочернего процесса worker.""" + +import asyncio +from io import BytesIO +import os +from pathlib import Path +import subprocess +import sys +from uuid import uuid4 + +from PIL import Image +import pytest + +from app.core.image_processing import ImageSettings +from app.domain.image_pipeline import create_variants +from app.domain.job_files import render_variants +from app.storage.jobs import JobWork +from test_attachments import MemoryStorage + + +@pytest.mark.parametrize("size,transparent", [((1600, 800), False), ((24, 12), True)]) +async def test_variant_geometry_metadata_and_alpha(tmp_path, size, transparent): + source = tmp_path / "source.png" + with Image.new("RGBA", size, (255, 0, 0, 0 if transparent else 255)) as image: + exif = Image.Exif() + exif[270] = "private description" + image.save(source, format="PNG", exif=exif) + result = create_variants( + source, tmp_path, "image/png", 40_000_000, ImageSettings(_env_file=None) + ) + variants = {v.name: v for v in result.variants} + assert (variants["crop"].width, variants["crop"].height) == (128, 128) + assert (variants["thumbnail"].width, variants["thumbnail"].height) == ( + (256, 128) if size[0] > 256 else size + ) + assert (variants["optimized"].width, variants["optimized"].height) == ( + (1280, 640) if size[0] > 1280 else size + ) + for name in ("thumbnail.jpg", "crop.jpg", "optimized.webp"): + with Image.open(tmp_path / name) as image: + assert ( + not image.getexif() + and not image.info.get("icc_profile") + and not image.info.get("xmp") + ) + if transparent: + if name.endswith("webp"): + assert image.getpixel((0, 0))[3] == 0 + else: + assert min(image.getpixel((0, 0))) >= 250 + + +async def test_exif_orientation_applied(tmp_path): + source = tmp_path / "source.jpg" + with Image.new("RGB", (400, 200), "blue") as image: + exif = Image.Exif() + exif[274] = 6 + image.save(source, exif=exif) + result = create_variants( + source, tmp_path, "image/jpeg", 40_000_000, ImageSettings(_env_file=None) + ) + assert (result.variants[0].width, result.variants[0].height) == (128, 256) + + +@pytest.mark.parametrize("failure", ["memory", "cpu"]) +async def test_worker_os_limits(failure, tmp_path): + body = ( + "return bytearray(2 * 1024 ** 3)" if failure == "memory" else "while True: pass" + ) + code = ( + "from app.core import thumbnail_worker as w\ndef fail(*args):\n " + + body + + "\nw.create_variants=fail\nraise SystemExit(w.main())" + ) + result = await asyncio.to_thread( + subprocess.run, + [ + sys.executable, + "-c", + code, + "source", + str(tmp_path), + str(tmp_path / "metadata"), + "image/png", + "40000000", + ], + env={**os.environ, "IMAGE_MEMORY_MIB": "256", "IMAGE_CPU_SECONDS": "1"}, + capture_output=True, + timeout=15, + ) + assert result.returncode == (3 if failure == "memory" else -9) + assert not (tmp_path / "metadata").exists() + + +async def test_render_timeout_kills_child(monkeypatch, tmp_path): + create = asyncio.create_subprocess_exec + children = [] + + async def slow_child(*args, **kwargs): + child = await create( + sys.executable, "-c", "import time;time.sleep(60)", **kwargs + ) + children.append(child) + return child + + monkeypatch.setattr(asyncio, "create_subprocess_exec", slow_child) + work = JobWork( + uuid4(), uuid4(), uuid4(), 1, "staging/test", "image/png", 1, "0" * 64 + ) + with pytest.raises(TimeoutError): + async with asyncio.timeout(0.2): + await render_variants(MemoryStorage(), work, tmp_path / "source", tmp_path) + assert len(children) == 1 and children[0].returncode is not None diff --git a/student-tests/test_instance.py b/student-tests/test_instance.py new file mode 100644 index 0000000..1f26247 --- /dev/null +++ b/student-tests/test_instance.py @@ -0,0 +1,110 @@ +"""Идентификатор реплики и заголовки ответов без PostgreSQL, Redis и Docker.""" + +from uuid import UUID + +import pytest +from fastapi import Request + +from app.core.instance import resolve_instance_id +from app.errors.exceptions import unavailable +from app.main import create_app +from conftest import close_app, make_client + + +@pytest.fixture(autouse=True) +def clean_db() -> None: + """Заменяет очистку БД из conftest: эти тесты не обращаются к хранилищам.""" + + +@pytest.mark.parametrize( + ("configured", "expected"), + [ + ("api-explicit", "api-explicit"), + (" api-explicit ", "api-explicit"), + (None, "container-123"), + ("", "container-123"), + (" ", "container-123"), + ], +) +def test_resolve_prefers_configured_id_then_hostname(monkeypatch, configured, expected): + monkeypatch.setenv("HOSTNAME", " container-123 ") + + assert resolve_instance_id(configured) == expected + + +@pytest.mark.parametrize("hostname", [None, "", " "]) +def test_resolve_without_config_or_hostname_returns_uuid(monkeypatch, hostname): + if hostname is None: + monkeypatch.delenv("HOSTNAME", raising=False) + else: + monkeypatch.setenv("HOSTNAME", hostname) + + assert UUID(resolve_instance_id(None)).version == 4 + + +@pytest.fixture +async def instance_client(make_settings): + app = create_app( + make_settings( + instance_id="api-test", + database_url="postgresql+asyncpg://unused@127.0.0.1:1/unused", + redis_port=1, + ) + ) + + @app.get("/__test__/request-id", include_in_schema=False) + async def request_id(request: Request) -> dict[str, str]: + return {"request_id": request.state.request_id} + + @app.get("/__test__/explode", include_in_schema=False) + async def explode() -> None: + raise RuntimeError("test error") + + @app.get("/__test__/unavailable", include_in_schema=False) + async def dependency_failure() -> None: + raise unavailable() + + try: + async with make_client(app, raise_app_exceptions=False) as client: + yield client + finally: + await close_app(app) + + +@pytest.mark.parametrize( + ("method", "path", "status"), + [ + ("GET", "/health/live", 200), + ("POST", "/api/v1/users", 400), + ("GET", "/api/v1/users/me", 401), + ("GET", "/no-such-path", 404), + ("DELETE", "/health/live", 405), + ("GET", "/__test__/explode", 500), + ("GET", "/__test__/unavailable", 503), + ], +) +async def test_instance_header_is_present_on_success_and_errors( + instance_client, method, path, status +): + response = await instance_client.request(method, path) + + assert response.status_code == status + assert response.headers["X-Instance-Id"] == "api-test" + assert response.headers["X-Request-Id"] + if status >= 400: + assert ( + response.json()["error"]["request_id"] == response.headers["X-Request-Id"] + ) + + +async def test_instance_id_is_stable_while_request_ids_are_distinct(instance_client): + first = await instance_client.get("/__test__/request-id") + second = await instance_client.get("/__test__/request-id") + + assert first.status_code == second.status_code == 200 + assert ( + first.headers["X-Instance-Id"] == second.headers["X-Instance-Id"] == "api-test" + ) + assert first.headers["X-Request-Id"] != second.headers["X-Request-Id"] + for response in (first, second): + assert response.json()["request_id"] == response.headers["X-Request-Id"] diff --git a/student-tests/test_jobs.py b/student-tests/test_jobs.py new file mode 100644 index 0000000..3582a09 --- /dev/null +++ b/student-tests/test_jobs.py @@ -0,0 +1,267 @@ +"""Retry/replay, fencing, cleanup, limits и транзакции реального PostgreSQL.""" + +import asyncio +from datetime import timedelta +import errno +from pathlib import Path +from tempfile import TemporaryDirectory +from uuid import UUID, uuid4 + +import pytest +from sqlalchemy import select +from sqlalchemy.ext.asyncio import AsyncSession + +from app.core.jobs import JobSettings +from app.domain import attachment_jobs +from app.domain.attachment_jobs import ( + claim_job, + process_attachment_job, + cleanup_staging, + build_result, +) +from app.domain.job_admin import replay_failed_job +from app.domain.job_retry import classify_failure, retry_delay +from app.errors.exceptions import JobOperationError, ProcessingError +from app.models.attachment import Attachment +from app.models.job import AttachmentJob +from app.models.job_replay import JobReplay +from app.schemas.job import JobMessage +from app.storage import jobs +from test_attachments import context, upload, finish_attachment + + +async def envelope(session, attachment_id): + job = await session.scalar( + select(AttachmentJob).where(AttachmentJob.attachment_id == UUID(attachment_id)) + ) + return JobMessage( + job_id=job.id, + attachment_id=job.attachment_id, + pipeline_version=1, + attempt=job.attempt + 1, + created_at=job.created_at, + ) + + +async def test_retry_budget_backoff_replay_and_duplicate(client, context, db_engine): + storage, alice, _, _, chat = context + attachment = (await upload(client, alice, chat)).json() + settings = JobSettings(_env_file=None, job_max_attempts=3) + + def fail(_): + raise TimeoutError + + async with AsyncSession(db_engine, expire_on_commit=False) as session: + first = await envelope(session, attachment["id"]) + for attempt in range(1, 4): + message = await envelope(session, attachment["id"]) + assert await process_attachment_job( + session, storage, message, settings, before_processing=fail + ) + job, item = await jobs.lock_job(session, first.job_id) + assert job.attempt == attempt + delay = (job.next_attempt_at - item.updated_at).total_seconds() + assert 5 * 2 ** (attempt - 1) / 2 <= delay <= 5 * 2 ** (attempt - 1) + assert item.status == ("failed" if attempt == 3 else "queued") + assert job.last_error_permanent is False + job.next_attempt_at = await jobs.database_time(session) - timedelta( + seconds=1 + ) + await session.commit() + assert item.error_code == "retry_exhausted" + request_id = uuid4() + result = await replay_failed_job( + session, + storage, + settings, + first.job_id, + request_id=request_id, + actor="test", + reason="dependency_restored", + ) + assert result["attempt_limit"] == 6 + # Old envelope cannot consume the fresh replay budget. + assert await process_attachment_job(session, storage, first, settings) + job, item = await jobs.lock_job(session, first.job_id) + assert job.attempt == 3 and item.status == "queued" + await session.commit() + message = await envelope(session, attachment["id"]) + assert await process_attachment_job(session, storage, message, settings) + before = dict(storage.objects) + assert await process_attachment_job(session, storage, message, settings) + assert storage.objects == before + repeat = await replay_failed_job( + session, + storage, + settings, + first.job_id, + request_id=request_id, + actor="test", + reason="dependency_restored", + ) + assert repeat["already_applied"] + with pytest.raises(JobOperationError, match="job_not_failed"): + await replay_failed_job( + session, + storage, + settings, + first.job_id, + request_id=uuid4(), + actor="test", + reason="manual_review", + ) + await session.rollback() + assert len((await session.scalars(select(JobReplay))).all()) == 1 + + +async def test_permanent_failure_and_missing_source_replay(client, context, db_engine): + storage, alice, _, _, chat = context + attachment = (await upload(client, alice, chat)).json() + + def fail(_): + raise ProcessingError("image_limits") + + settings = JobSettings(_env_file=None) + async with AsyncSession(db_engine, expire_on_commit=False) as session: + message = await envelope(session, attachment["id"]) + await process_attachment_job( + session, storage, message, settings, before_processing=fail + ) + job, item = await jobs.lock_job(session, message.job_id) + assert item.status == "failed" and job.attempt == 1 and job.last_error_permanent + job.staging_key = None + await session.commit() + with pytest.raises(JobOperationError, match="source_expired"): + await replay_failed_job( + session, + storage, + settings, + job.id, + request_id=uuid4(), + actor="test", + reason="manual_review", + ) + + +async def test_stale_worker_cannot_write_and_cleanup_keeps_active( + client, context, db_engine +): + storage, alice, _, _, chat = context + attachment = (await upload(client, alice, chat)).json() + settings = JobSettings(_env_file=None) + async with AsyncSession(db_engine, expire_on_commit=False) as session: + message = await envelope(session, attachment["id"]) + claim = await claim_job(session, message, settings) + job, item = await jobs.lock_job(session, message.job_id) + job.lease_token = uuid4() + job.finished_at = await jobs.database_time(session) - timedelta(days=10) + await session.commit() + assert await cleanup_staging(session, storage, settings, apply=True) == 0 + # Rendering must not be allowed to PUT on a stale lease. + before = dict(storage.objects) + assert await build_result(session, storage, claim.work) + assert storage.objects == before + + +async def test_cleanup_ready_preserves_final_objects(client, context, db_engine): + storage, alice, _, _, chat = context + attachment = (await upload(client, alice, chat)).json() + await finish_attachment(client, storage, alice, attachment["id"]) + async with AsyncSession(db_engine, expire_on_commit=False) as session: + message = await envelope(session, attachment["id"]) + job, item = await jobs.lock_job(session, message.job_id) + staging = job.staging_key + job.finished_at = await jobs.database_time(session) - timedelta(days=2) + await session.commit() + assert ( + await cleanup_staging( + session, storage, JobSettings(_env_file=None), apply=False + ) + == 1 + ) + assert staging in storage.objects + assert ( + await cleanup_staging( + session, storage, JobSettings(_env_file=None), apply=True + ) + == 1 + ) + assert staging not in storage.objects and len(storage.objects) == 4 + assert ( + await cleanup_staging( + session, storage, JobSettings(_env_file=None), apply=True + ) + == 0 + ) + + +async def test_retry_classification_and_cap(): + settings = JobSettings(_env_file=None) + for attempt in (1, 2, 6, 100): + cap = min(120, 5 * 2 ** min(30, attempt - 1)) + assert all(cap / 2 <= retry_delay(settings, attempt) <= cap for _ in range(100)) + assert classify_failure(TimeoutError()) == ("processing_timeout", False) + assert classify_failure(OSError(errno.EACCES, "denied"))[1] + assert not classify_failure(OSError(errno.ENOSPC, "full"))[1] + + +async def test_timeout_records_retry_and_clears_lease( + client, context, db_engine, monkeypatch +): + storage, alice, _, _, chat = context + attachment = (await upload(client, alice, chat)).json() + + async def stalled(*args, **kwargs): + await asyncio.sleep(60) + + monkeypatch.setattr(attachment_jobs, "build_result", stalled) + settings = JobSettings(_env_file=None).model_copy( + update={"job_timeout_seconds": 0.05} + ) + async with AsyncSession(db_engine, expire_on_commit=False) as session: + message = await envelope(session, attachment["id"]) + assert await process_attachment_job(session, storage, message, settings) + job, item = await jobs.lock_job(session, message.job_id) + assert item.status == "queued" and job.last_error_code == "processing_timeout" + assert job.lease_token is None and job.lease_until is None + + +async def test_failed_retention_and_source_checksum_protect_replay( + client, context, db_engine +): + storage, alice, _, _, chat = context + attachment = (await upload(client, alice, chat)).json() + + def fail(_): + raise ProcessingError("invalid_image") + + settings = JobSettings(_env_file=None) + async with AsyncSession(db_engine, expire_on_commit=False) as session: + message = await envelope(session, attachment["id"]) + await process_attachment_job( + session, storage, message, settings, before_processing=fail + ) + job, item = await jobs.lock_job(session, message.job_id) + key = job.staging_key + job.finished_at = await jobs.database_time(session) - timedelta(days=2) + await session.commit() + assert await cleanup_staging(session, storage, settings, apply=True) == 0 + data, metadata = storage.objects[key] + storage.objects[key] = (b"x" * len(data), metadata) + with pytest.raises(JobOperationError, match="source_mismatch"): + await replay_failed_job( + session, + storage, + settings, + message.job_id, + request_id=uuid4(), + actor="test", + reason="manual_review", + ) + await session.rollback() + assert not (await session.scalars(select(JobReplay))).all() + job, item = await jobs.lock_job(session, message.job_id) + job.finished_at = await jobs.database_time(session) - timedelta(days=8) + await session.commit() + assert await cleanup_staging(session, storage, settings, apply=True) == 1 + assert key not in storage.objects diff --git a/student-tests/test_lifecycle.py b/student-tests/test_lifecycle.py new file mode 100644 index 0000000..11e4dcb --- /dev/null +++ b/student-tests/test_lifecycle.py @@ -0,0 +1,50 @@ +"""Готовность при завершении и ограничение времени проверки зависимостей.""" + +import asyncio +import time + +import pytest + +from app.domain import health +from app.main import create_app +from conftest import close_app, make_client + + +@pytest.fixture(autouse=True) +def clean_db() -> None: + """Эти проверки не обращаются к хранилищам.""" + + +async def test_draining_keeps_liveness_but_rejects_new_work(make_settings): + app = create_app(make_settings()) + app.state.lifecycle.start_draining() + try: + async with make_client(app) as client: + assert (await client.get("/health/live")).status_code == 200 + assert (await client.get("/health/ready")).status_code == 503 + assert (await client.get("/api/v1/users/me")).status_code == 503 + finally: + await close_app(app) + + +async def test_readiness_timeout_cancels_dependency_checks(make_settings, monkeypatch): + cancelled = [] + + async def stalled(_): + try: + await asyncio.sleep(30) + finally: + cancelled.append(True) + + monkeypatch.setattr(health, "check_database", stalled) + monkeypatch.setattr(health, "check_redis", stalled) + app = create_app(make_settings(readiness_timeout_seconds=0.03)) + try: + async with make_client(app) as client: + started = time.monotonic() + response = await client.get("/health/ready") + assert response.status_code == 503 + assert time.monotonic() - started < 1 + assert len(cancelled) == 2 + finally: + await close_app(app) diff --git a/student-tests/test_limits.py b/student-tests/test_limits.py new file mode 100644 index 0000000..9cfca1d --- /dev/null +++ b/student-tests/test_limits.py @@ -0,0 +1,122 @@ +"""Ограничения нагрузки: MAX_IN_FLIGHT -> 429, MAX_MESSAGES -> 503.""" + +import asyncio + +import httpx + +from app.main import create_app +from conftest import close_app, make_client +from helpers import ( + assert_request_id, + bearer, + create_chat, + create_user, + idempotency_header, +) + + +def _assert_error(response: httpx.Response, status: int, code: str) -> None: + assert response.status_code == status + body = response.json() + assert body["error"]["code"] == code + assert response.headers.get("X-Request-Id") == body["error"]["request_id"] + + +async def test_message_limit_rejects_without_deleting_confirmed_messages(make_settings): + app = create_app(make_settings(max_messages=2)) + async with make_client(app) as client: + user = await create_user(client) + chat = await create_chat(client, user) + url = f"/api/v1/chats/{chat['id']}/messages" + + for index in range(2): + ok = await client.post( + url, + headers={**bearer(user), **idempotency_header()}, + json={"text": f"confirmed-{index}"}, + ) + assert ok.status_code == 201 + + rejected = await client.post( + url, + headers={**bearer(user), **idempotency_header()}, + json={"text": "rejected"}, + ) + _assert_error(rejected, 503, "unavailable") + + history = await client.get(f"{url}?limit=100", headers=bearer(user)) + assert history.status_code == 200 + assert [m["text"] for m in history.json()["items"]] == [ + "confirmed-0", + "confirmed-1", + ] + await close_app(app) + + +async def test_in_flight_limit_returns_429_and_recovers(make_settings, monkeypatch): + import app.endpoints.messages as message_endpoint + + app = create_app(make_settings(max_in_flight=2)) + + original_send_message = message_endpoint.send_message_idempotent + accepted_count = 0 + all_slots_taken = asyncio.Event() + release = asyncio.Event() + + async def blocking_send_message(*args, **kwargs): + nonlocal accepted_count + accepted_count += 1 + if accepted_count == 2: + all_slots_taken.set() + await asyncio.wait_for(release.wait(), timeout=5) + return await original_send_message(*args, **kwargs) + + async with make_client(app, timeout=10) as client: + user = await create_user(client) + chat = await create_chat(client, user) + + monkeypatch.setattr( + message_endpoint, "send_message_idempotent", blocking_send_message + ) + url = f"/api/v1/chats/{chat['id']}/messages" + + held = [ + asyncio.create_task( + client.post( + url, + headers={**bearer(user), **idempotency_header()}, + json={"text": f"held-{i}"}, + ) + ) + for i in range(2) + ] + + await asyncio.wait_for(all_slots_taken.wait(), timeout=2) + + rejected = await asyncio.gather( + *( + client.post( + url, + headers={**bearer(user), **idempotency_header()}, + json={"text": f"rejected-{i}"}, + ) + for i in range(4) + ) + ) + for response in rejected: + _assert_error(response, 429, "rate_limited") + assert response.headers.get("Retry-After") == "1" + + assert (await client.get("/health/live")).status_code == 200 + + release.set() + assert all(r.status_code == 201 for r in await asyncio.gather(*held)) + + recovered = await client.post( + url, + headers={**bearer(user), **idempotency_header()}, + json={"text": "after"}, + ) + assert recovered.status_code == 201 + assert_request_id(recovered) + await close_app(app) diff --git a/student-tests/test_messages.py b/student-tests/test_messages.py new file mode 100644 index 0000000..07fdc08 --- /dev/null +++ b/student-tests/test_messages.py @@ -0,0 +1,238 @@ +from urllib.parse import quote + +import pytest +from httpx import AsyncClient + +from helpers import ( + assert_request_id, + bearer, + create_chat, + create_user, + idempotency_header, + send_message, +) + + +async def _message(client: AsyncClient, user: dict, chat: dict, text: str): + return await send_message(client, user, chat, text) + + +async def test_send_and_list_message(client: AsyncClient): + alice = await create_user(client) + bob = await create_user(client) + chat = await create_chat(client, alice, bob) + + created = await _message(client, alice, chat, "Привет, мир 👋") + + assert created.status_code == 201 + message = created.json() + assert message["sender_id"] == alice["id"] + assert message["chat_id"] == chat["id"] + assert_request_id(created) + + listed = await client.get( + f"/api/v1/chats/{chat['id']}/messages?limit=1", + headers=bearer(bob), + ) + + assert listed.status_code == 200 + assert listed.json()["items"] == [message] + assert listed.json()["next_cursor"] is None + assert_request_id(listed) + + +@pytest.mark.parametrize("text", ["", " ", "x" * 4001]) +async def test_invalid_message_text(client: AsyncClient, text: str): + alice = await create_user(client) + chat = await create_chat(client, alice) + + response = await _message(client, alice, chat, text) + + assert response.status_code == 400 + assert response.json()["error"]["code"] == "invalid_request" + assert_request_id(response) + + +async def test_extra_message_field_is_rejected(client: AsyncClient): + alice = await create_user(client) + chat = await create_chat(client, alice) + + response = await client.post( + f"/api/v1/chats/{chat['id']}/messages", + headers={**bearer(alice), **idempotency_header()}, + json={"text": "hello", "sender_id": alice["id"]}, + ) + + assert response.status_code == 400 + assert response.json()["error"]["code"] == "invalid_request" + assert_request_id(response) + + +async def test_messages_are_private_to_chat_members(client: AsyncClient): + alice = await create_user(client) + eve = await create_user(client) + chat = await create_chat(client, alice) + await _message(client, alice, chat, "секрет") + + response = await client.get( + f"/api/v1/chats/{chat['id']}/messages", + headers=bearer(eve), + ) + + assert response.status_code == 404 + assert response.json()["error"]["code"] == "not_found" + + +async def test_pagination_has_no_duplicates(client: AsyncClient): + alice = await create_user(client) + chat = await create_chat(client, alice) + + created = [ + (await _message(client, alice, chat, f"message-{index}")).json() + for index in range(5) + ] + + page1 = ( + await client.get( + f"/api/v1/chats/{chat['id']}/messages?limit=2", + headers=bearer(alice), + ) + ).json() + page2 = ( + await client.get( + f"/api/v1/chats/{chat['id']}/messages?limit=2&cursor={quote(page1['next_cursor'], safe='')}", + headers=bearer(alice), + ) + ).json() + page3 = ( + await client.get( + f"/api/v1/chats/{chat['id']}/messages?limit=2&cursor={quote(page2['next_cursor'], safe='')}", + headers=bearer(alice), + ) + ).json() + + ids = [item["id"] for page in (page1, page2, page3) for item in page["items"]] + assert ids == [item["id"] for item in created] + assert len(ids) == len(set(ids)) == 5 + assert len(page1["items"]) == 2 + assert len(page2["items"]) == 2 + assert len(page3["items"]) == 1 + assert page3["next_cursor"] is None + + +async def test_cursor_cannot_be_used_for_another_chat(client: AsyncClient): + alice = await create_user(client) + chat_a = await create_chat(client, alice, title="A") + chat_b = await create_chat(client, alice, title="B") + + await _message(client, alice, chat_a, "a1") + await _message(client, alice, chat_a, "a2") + await _message(client, alice, chat_b, "b1") + await _message(client, alice, chat_b, "b2") + + page = ( + await client.get( + f"/api/v1/chats/{chat_a['id']}/messages?limit=1", + headers=bearer(alice), + ) + ).json() + + response = await client.get( + f"/api/v1/chats/{chat_b['id']}/messages?limit=1&cursor={quote(page['next_cursor'], safe='')}", + headers=bearer(alice), + ) + + assert response.status_code == 400 + assert response.json()["error"]["code"] == "invalid_request" + + +@pytest.mark.parametrize( + "limit, expected_status", [(0, 400), (1, 200), (100, 200), (101, 400)] +) +async def test_limit_boundaries(client: AsyncClient, limit: int, expected_status: int): + alice = await create_user(client) + chat = await create_chat(client, alice) + await _message(client, alice, chat, "one") + + response = await client.get( + f"/api/v1/chats/{chat['id']}/messages?limit={limit}", + headers=bearer(alice), + ) + + assert response.status_code == expected_status + assert_request_id(response) + + +async def test_message_exact_max_length_is_accepted(client: AsyncClient): + alice = await create_user(client) + chat = await create_chat(client, alice) + + response = await _message(client, alice, chat, "x" * 4000) + + assert response.status_code == 201 + assert len(response.json()["text"]) == 4000 + + +async def test_nonexistent_chat_messages_return_404(client: AsyncClient): + alice = await create_user(client) + + response = await client.get( + "/api/v1/chats/00000000-0000-4000-8000-000000000000/messages", + headers=bearer(alice), + ) + + assert response.status_code == 404 + assert response.json()["error"]["code"] == "not_found" + assert_request_id(response) + + +async def test_unauthenticated_requests_are_rejected(client: AsyncClient): + alice = await create_user(client) + chat = await create_chat(client, alice) + url = f"/api/v1/chats/{chat['id']}/messages" + + assert (await client.get(url)).status_code == 401 + assert (await client.post(url, json={"text": "hi"})).status_code == 401 + + +async def test_messages_survive_new_login(client: AsyncClient): + """Сообщения принадлежат пользователю, а не сессии: после logout/login видны.""" + from helpers import login + + alice = await create_user(client) + chat = await create_chat(client, alice) + message = (await _message(client, alice, chat, "до выхода")).json() + await client.delete("/api/v1/auth/sessions/current", headers=bearer(alice)) + + alice_again = await login(client, alice) + listed = await client.get( + f"/api/v1/chats/{chat['id']}/messages", headers=bearer(alice_again) + ) + + assert listed.json()["items"] == [message] + + +async def test_history_order_is_created_at_then_id(client: AsyncClient): + alice = await create_user(client) + chat = await create_chat(client, alice) + created = [(await _message(client, alice, chat, f"m{i}")).json() for i in range(10)] + + listed = ( + await client.get( + f"/api/v1/chats/{chat['id']}/messages?limit=100", headers=bearer(alice) + ) + ).json()["items"] + + assert [m["id"] for m in listed] == [m["id"] for m in created] + keys = [(m["created_at"], m["id"]) for m in listed] + assert keys == sorted(keys) + + +async def test_nul_in_message_text_is_rejected(client: AsyncClient): + alice = await create_user(client) + chat = await create_chat(client, alice) + + response = await _message(client, alice, chat, "hello\u0000world") + + assert response.status_code == 400 + assert response.json()["error"]["code"] == "invalid_request" diff --git a/student-tests/test_migrations.py b/student-tests/test_migrations.py new file mode 100644 index 0000000..c515ade --- /dev/null +++ b/student-tests/test_migrations.py @@ -0,0 +1,79 @@ +"""Миграции: применение с нуля, идемпотентный повтор, совпадение со схемой моделей.""" + +import pytest +from alembic.autogenerate import compare_metadata +from alembic.migration import MigrationContext +from sqlalchemy import inspect, text + +from app.models import Base +from conftest import reset_schema, upgrade_head + +EXPECTED_TABLES = { + "users", + "chats", + "chat_members", + "messages", + "counters", + "idempotency_keys", + "attachments", + "message_attachments", + "upload_intents", + "attachment_jobs", + "job_replays", +} + + +@pytest.fixture +async def migrated_engine(database_url, db_engine): + await reset_schema(db_engine) + await upgrade_head(database_url) + yield db_engine + + await reset_schema(db_engine) + async with db_engine.begin() as connection: + await connection.run_sync(Base.metadata.create_all) + + +async def test_upgrade_creates_all_tables(migrated_engine): + async with migrated_engine.connect() as connection: + tables = await connection.run_sync( + lambda sync: set(inspect(sync).get_table_names()) + ) + assert EXPECTED_TABLES <= tables + + +async def test_upgrade_twice_is_idempotent_and_keeps_data( + migrated_engine, database_url +): + async with migrated_engine.begin() as connection: + await connection.execute( + text( + "INSERT INTO users (id, username, display_name, password_hash) " + "VALUES (gen_random_uuid(), 'keep_me', 'Keep', 'hash')" + ) + ) + + await upgrade_head(database_url) + + async with migrated_engine.connect() as connection: + count = ( + await connection.execute( + text("SELECT count(*) FROM users WHERE username = 'keep_me'") + ) + ).scalar_one() + assert count == 1 + + +async def test_models_and_migrations_are_in_sync(migrated_engine): + def compare(sync_connection): + context = MigrationContext.configure( + sync_connection, opts={"compare_type": True} + ) + return compare_metadata(context, Base.metadata) + + async with migrated_engine.connect() as connection: + diff = await connection.run_sync(compare) + + assert ( + diff == [] + ), f"Создайте миграцию: alembic revision --autogenerate. Diff: {diff}" diff --git a/student-tests/test_pagination.py b/student-tests/test_pagination.py new file mode 100644 index 0000000..e45e5b1 --- /dev/null +++ b/student-tests/test_pagination.py @@ -0,0 +1,137 @@ +"""Курсоры: непрозрачность, привязка к ресурсу и устойчивость к подделке.""" + +import base64 +import json +from urllib.parse import quote + +import pytest +from httpx import AsyncClient + +from helpers import bearer, create_chat, create_user, send_message + + +def forged_cursor(**payload: str) -> str: + return base64.urlsafe_b64encode(json.dumps(payload).encode()).decode() + + +@pytest.mark.parametrize( + "cursor", + [ + "not-base64-%%%", + base64.urlsafe_b64encode(b"not json").decode(), + base64.urlsafe_b64encode(b"[1, 2, 3]").decode(), + forged_cursor(kind="messages"), + ], +) +async def test_garbage_cursor_returns_400(client: AsyncClient, cursor: str): + alice = await create_user(client) + chat = await create_chat(client, alice) + + for url in ( + f"/api/v1/chats?cursor={quote(cursor, safe='')}", + f"/api/v1/chats/{chat['id']}/messages?cursor={quote(cursor, safe='')}", + ): + response = await client.get(url, headers=bearer(alice)) + assert response.status_code == 400, url + assert response.json()["error"]["code"] == "invalid_request" + + +async def test_cursor_without_timezone_is_rejected(client: AsyncClient): + alice = await create_user(client) + cursor = forged_cursor( + kind="chats", + resource_id=alice["id"], + created_at="2026-01-01T00:00:00", + item_id="00000000-0000-4000-8000-000000000000", + ) + + response = await client.get( + f"/api/v1/chats?cursor={quote(cursor, safe='')}", headers=bearer(alice) + ) + + assert response.status_code == 400 + + +async def test_chat_list_cursor_is_bound_to_its_owner(client: AsyncClient): + alice = await create_user(client) + bob = await create_user(client) + for index in range(2): + await create_chat(client, alice, bob, title=f"shared-{index}") + + page = (await client.get("/api/v1/chats?limit=1", headers=bearer(alice))).json() + response = await client.get( + f"/api/v1/chats?limit=1&cursor={quote(page['next_cursor'], safe='')}", + headers=bearer(bob), + ) + + assert response.status_code == 400 + + +async def test_messages_cursor_is_not_accepted_by_chat_list(client: AsyncClient): + alice = await create_user(client) + chat = await create_chat(client, alice) + for index in range(2): + await send_message(client, alice, chat, f"m{index}") + + page = ( + await client.get( + f"/api/v1/chats/{chat['id']}/messages?limit=1", headers=bearer(alice) + ) + ).json() + response = await client.get( + f"/api/v1/chats?cursor={quote(page['next_cursor'], safe='')}", + headers=bearer(alice), + ) + + assert response.status_code == 400 + + +async def test_limit_can_change_between_pages(client: AsyncClient): + alice = await create_user(client) + chat = await create_chat(client, alice) + sent = [ + (await send_message(client, alice, chat, f"m{index}")).json() + for index in range(6) + ] + + first = ( + await client.get( + f"/api/v1/chats/{chat['id']}/messages?limit=1", headers=bearer(alice) + ) + ).json() + rest = ( + await client.get( + f"/api/v1/chats/{chat['id']}/messages?limit=100" + f"&cursor={quote(first['next_cursor'], safe='')}", + headers=bearer(alice), + ) + ).json() + + assert [m["id"] for m in first["items"] + rest["items"]] == [m["id"] for m in sent] + assert rest["next_cursor"] is None + + +async def test_message_sent_after_reading_last_page_is_seen_with_cursor( + client: AsyncClient, +): + alice = await create_user(client) + chat = await create_chat(client, alice) + await send_message(client, alice, chat, "first") + await send_message(client, alice, chat, "second") + + page = ( + await client.get( + f"/api/v1/chats/{chat['id']}/messages?limit=1", headers=bearer(alice) + ) + ).json() + new = (await send_message(client, alice, chat, "third")).json() + rest = ( + await client.get( + f"/api/v1/chats/{chat['id']}/messages?limit=100" + f"&cursor={quote(page['next_cursor'], safe='')}", + headers=bearer(alice), + ) + ).json() + + assert [m["text"] for m in rest["items"]] == ["second", "third"] + assert rest["items"][-1] == new diff --git a/student-tests/test_s3_stream.py b/student-tests/test_s3_stream.py new file mode 100644 index 0000000..67fc364 --- /dev/null +++ b/student-tests/test_s3_stream.py @@ -0,0 +1,63 @@ +"""Освобождение HTTP-соединения и порядок завершения SDK при отмене.""" + +import asyncio +from threading import Event +from types import SimpleNamespace + +from app.core.s3 import S3Settings +from app.storage.s3 import ObjectStream, run_sync + + +async def test_sdk_thread_finishes_before_cancellation_returns(): + entered, release, finished = Event(), Event(), Event() + + def operation(): + entered.set() + release.wait(timeout=3) + finished.set() + + task = asyncio.create_task(run_sync(operation)) + await asyncio.to_thread(entered.wait, 2) + task.cancel() + await asyncio.sleep(0) + assert not task.done() + release.set() + try: + await task + except asyncio.CancelledError: + pass + assert finished.is_set() + + +async def test_response_discarded_when_get_is_cancelled(): + entered, release = Event(), Event() + discarded = [] + response = object() + + def operation(): + entered.set() + release.wait(timeout=3) + return response + + task = asyncio.create_task(run_sync(operation, discard_result=discarded.append)) + await asyncio.to_thread(entered.wait, 2) + task.cancel() + release.set() + try: + await task + except asyncio.CancelledError: + pass + assert discarded == [response] + + +async def test_stream_closes_even_before_first_iteration(): + calls = [] + response = SimpleNamespace( + close=lambda: calls.append("close"), + release_conn=lambda: calls.append("release"), + ) + storage = SimpleNamespace(settings=S3Settings(_env_file=None)) + stream = ObjectStream(storage, response) + await stream.aclose() + await stream.aclose() + assert calls == ["close", "release"] diff --git a/student-tests/test_sessions.py b/student-tests/test_sessions.py new file mode 100644 index 0000000..e239e22 --- /dev/null +++ b/student-tests/test_sessions.py @@ -0,0 +1,173 @@ +"""Сессии в Redis: TTL, абсолютный срок, отзыв, потеря и перезапуск хранилища.""" + +import asyncio +import hashlib +import os +import time +from datetime import datetime + +import pytest +from httpx import AsyncClient +from redis.asyncio import Redis + +from app.main import create_app +from conftest import close_app, make_client +from helpers import basic_header, bearer, create_user, register + +ME = "/api/v1/users/me" +LOGOUT = "/api/v1/auth/sessions/current" + + +def session_key(token: str) -> str: + return "session:" + hashlib.sha256(token.encode()).hexdigest() + + +async def test_session_key_ttl_matches_expires_at( + client: AsyncClient, redis_client: Redis +): + user = await register(client) + response = await client.post( + "/api/v1/auth/sessions", + headers=basic_header(user["username"], user["password"]), + ) + body = response.json() + + expires_at = datetime.fromisoformat(body["expires_at"]) + expire_time_ms = await redis_client.pexpiretime(session_key(body["token"])) + + assert abs(expire_time_ms - expires_at.timestamp() * 1000) < 2 + assert 299_000 < await redis_client.pttl(session_key(body["token"])) <= 300_000 + + +async def test_session_ttl_is_absolute_and_not_extended_by_activity( + client: AsyncClient, redis_client: Redis +): + session = await create_user(client) + key = session_key(session["token"]) + expire_before = await redis_client.pexpiretime(key) + + for _ in range(5): + assert (await client.get(ME, headers=bearer(session))).status_code == 200 + + assert await redis_client.pexpiretime(key) == expire_before + + +async def test_logout_removes_session_key(client: AsyncClient, redis_client: Redis): + session = await create_user(client) + key = session_key(session["token"]) + assert await redis_client.exists(key) == 1 + + assert (await client.delete(LOGOUT, headers=bearer(session))).status_code == 204 + + assert await redis_client.exists(key) == 0 + assert (await client.get(ME, headers=bearer(session))).status_code == 401 + + +async def test_expired_session_is_rejected_everywhere(make_settings): + app = create_app(make_settings(session_ttl_seconds=1)) + async with make_client(app) as client: + session = await create_user(client) + assert (await client.get(ME, headers=bearer(session))).status_code == 200 + + await asyncio.sleep(1.5) + + for method, url in (("GET", ME), ("GET", "/api/v1/chats"), ("DELETE", LOGOUT)): + response = await client.request(method, url, headers=bearer(session)) + assert response.status_code == 401, (method, url) + assert response.headers["WWW-Authenticate"].startswith("Bearer") + await close_app(app) + + +async def test_relogin_after_expiry_issues_new_working_token(make_settings): + app = create_app(make_settings(session_ttl_seconds=1)) + async with make_client(app) as client: + user = await register(client) + first = ( + await client.post( + "/api/v1/auth/sessions", + headers=basic_header(user["username"], user["password"]), + ) + ).json() + await asyncio.sleep(1.5) + second = ( + await client.post( + "/api/v1/auth/sessions", + headers=basic_header(user["username"], user["password"]), + ) + ).json() + + assert first["token"] != second["token"] + assert (await client.get(ME, headers=bearer(first))).status_code == 401 + assert (await client.get(ME, headers=bearer(second))).status_code == 200 + await close_app(app) + + +async def test_tampered_token_is_rejected(client: AsyncClient): + session = await create_user(client) + token = session["token"] + tampered = token[:-1] + ("A" if token[-1] != "A" else "B") + + response = await client.get(ME, headers={"Authorization": f"Bearer {tampered}"}) + + assert response.status_code == 401 + + +async def test_session_of_deleted_user_is_rejected(client: AsyncClient, db_engine): + from sqlalchemy import text + + session = await create_user(client) + async with db_engine.begin() as connection: + await connection.execute( + text("DELETE FROM users WHERE id = :id"), {"id": session["id"]} + ) + + response = await client.get(ME, headers=bearer(session)) + + assert response.status_code == 401 + + +async def test_redis_flush_invalidates_all_sessions( + client: AsyncClient, redis_client: Redis +): + alice = await create_user(client) + bob = await create_user(client) + + await redis_client.flushdb() + + for session in (alice, bob): + assert (await client.get(ME, headers=bearer(session))).status_code == 401 + + +@pytest.mark.skipif( + os.environ.get("DOCKER_TESTS") != "1", + reason="перезапускает контейнер redis из compose; включается DOCKER_TESTS=1", +) +async def test_sessions_survive_redis_restart(client: AsyncClient, redis_client: Redis): + active = await create_user(client) + revoked = await create_user(client) + assert (await client.delete(LOGOUT, headers=bearer(revoked))).status_code == 204 + + process = await asyncio.create_subprocess_exec( + "docker", + "compose", + "restart", + "redis", + stdout=asyncio.subprocess.DEVNULL, + stderr=asyncio.subprocess.DEVNULL, + ) + assert await process.wait() == 0 + + deadline = time.monotonic() + 30 + while True: + try: + await redis_client.ping() + break + except Exception: + if time.monotonic() > deadline: + raise + await asyncio.sleep(0.5) + + response = await client.get(ME, headers=bearer(active)) + assert response.status_code == 200 + assert response.json()["id"] == active["id"] + assert (await client.get(ME, headers=bearer(revoked))).status_code == 401 diff --git a/student-tests/test_users.py b/student-tests/test_users.py new file mode 100644 index 0000000..554cf30 --- /dev/null +++ b/student-tests/test_users.py @@ -0,0 +1,128 @@ +import pytest +from httpx import AsyncClient + +from helpers import PASSWORD, assert_request_id, bearer, create_user, register + + +async def test_register_does_not_leak_password(client: AsyncClient): + response = await client.post( + "/api/v1/users", + json={"username": "alice", "display_name": "Алиса 👋", "password": PASSWORD}, + ) + + assert response.status_code == 201 + body = response.json() + assert set(body) == {"id", "username", "display_name", "created_at"} + assert PASSWORD not in response.text + assert_request_id(response) + + +async def test_get_current_user(client: AsyncClient): + user = await create_user(client, display_name="Алиса 👋") + + response = await client.get("/api/v1/users/me", headers=bearer(user)) + + assert response.status_code == 200 + assert response.json()["id"] == user["id"] + assert response.json()["username"] == user["username"] + assert_request_id(response) + + +@pytest.mark.parametrize( + "body", + [ + {"username": "alice", "display_name": "", "password": PASSWORD}, + {"username": "alice", "display_name": " ", "password": PASSWORD}, + {"username": "alice", "display_name": "a" * 101, "password": PASSWORD}, + {"username": "ab", "display_name": "Alice", "password": PASSWORD}, + {"username": "alice-123", "display_name": "Alice", "password": PASSWORD}, + {"username": "AlicE", "display_name": "Alice", "password": PASSWORD}, + {"username": "a" * 33, "display_name": "Alice", "password": PASSWORD}, + {"username": "alice", "display_name": "Alice"}, + {"username": "alice", "display_name": "Alice", "password": "x" * 11}, + {"username": "alice", "display_name": "Alice", "password": "x" * 129}, + ], +) +async def test_invalid_user_payloads(client: AsyncClient, body: dict): + response = await client.post("/api/v1/users", json=body) + + assert response.status_code == 400 + assert response.json()["error"]["code"] == "invalid_request" + assert_request_id(response) + + +async def test_password_length_boundaries_are_accepted(client: AsyncClient): + for index, password in enumerate( + ["x" * 12, "y" * 128, "п" * 12, " spaces inside "] + ): + response = await client.post( + "/api/v1/users", + json={ + "username": f"pw_user_{index}", + "display_name": "Alice", + "password": password, + }, + ) + assert response.status_code == 201, (index, response.text) + + +async def test_extra_user_field_is_rejected(client: AsyncClient): + response = await client.post( + "/api/v1/users", + json={ + "username": "alice", + "display_name": "Alice", + "password": PASSWORD, + "extra": True, + }, + ) + + assert response.status_code == 400 + assert response.json()["error"]["code"] == "invalid_request" + + +async def test_duplicate_username_returns_conflict(client: AsyncClient): + user = await register(client, username="duplicate_user") + + response = await client.post( + "/api/v1/users", + json={ + "username": user["username"], + "display_name": "Другой", + "password": PASSWORD, + }, + ) + + assert response.status_code == 409 + assert response.json()["error"]["code"] == "conflict" + assert_request_id(response) + + +async def test_user_exact_length_boundaries_are_accepted(client: AsyncClient): + for length in (3, 32): + user = await register(client, username=("a" * length), display_name="d" * 100) + assert len(user["username"]) == length + assert len(user["display_name"]) == 100 + + +@pytest.mark.parametrize("password", [" " * 12, "\t" * 12, " \n" * 6]) +async def test_whitespace_only_password_is_rejected(client: AsyncClient, password: str): + response = await client.post( + "/api/v1/users", + json={"username": "blank_pw", "display_name": "Blank", "password": password}, + ) + + assert response.status_code == 400 + assert response.json()["error"]["code"] == "invalid_request" + assert_request_id(response) + + +@pytest.mark.parametrize("field", ["display_name", "password"]) +async def test_nul_in_user_fields_is_rejected(client: AsyncClient, field: str): + body = {"username": "nul_user", "display_name": "Nul", "password": PASSWORD} + body[field] = body[field] + "\u0000tail" + + response = await client.post("/api/v1/users", json=body) + + assert response.status_code == 400 + assert response.json()["error"]["code"] == "invalid_request" diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 -- 2.54.0 From 52be9d282b8e3e9bbe0cafb1dad7d0b909ce6ac9 Mon Sep 17 00:00:00 2001 From: gytall Date: Sat, 14 Nov 2026 05:00:23 +0300 Subject: [PATCH 2/4] reyalysed grade 3 --- .env.example | 12 +- .gitignore | 2 + Makefile | 26 +- REPORT.md | 106 ++-- RUNNING.md | 102 ++-- app/core/job_worker.py | 36 +- app/core/telemetry.py | 160 ++++++ app/domain/attachment_jobs.py | 36 +- app/errors/handlers.py | 8 +- app/main.py | 9 +- compose.yaml | 98 ++++ evidence/README.md | 11 +- evidence/observability.json | 398 +++++++++++++++ evidence/verification.json | 472 ++++++++++++++++++ infra/otel/README.md | 21 +- infra/otel/collector.yaml | 53 ++ infra/otel/grafana/dashboards/messenger.json | 343 +++++++++++++ .../provisioning/dashboards/provider.yaml | 10 + .../provisioning/datasources/sources.yaml | 36 ++ infra/otel/loki.yaml | 39 ++ infra/otel/prometheus.yaml | 7 + infra/otel/tempo.yaml | 22 + requirements.txt | 3 + scripts/check_jobs.py | 4 +- scripts/check_observability.py | 291 +++++++++++ scripts/deployment.py | 142 ++++++ scripts/init_local.py | 1 + scripts/restart.sh | 19 +- student-tests/test_errors.py | 3 +- student-tests/test_telemetry.py | 126 +++++ 30 files changed, 2441 insertions(+), 155 deletions(-) create mode 100644 app/core/telemetry.py create mode 100644 evidence/observability.json create mode 100644 evidence/verification.json create mode 100644 infra/otel/collector.yaml create mode 100644 infra/otel/grafana/dashboards/messenger.json create mode 100644 infra/otel/grafana/provisioning/dashboards/provider.yaml create mode 100644 infra/otel/grafana/provisioning/datasources/sources.yaml create mode 100644 infra/otel/loki.yaml create mode 100644 infra/otel/prometheus.yaml create mode 100644 infra/otel/tempo.yaml create mode 100644 scripts/check_observability.py create mode 100644 student-tests/test_telemetry.py diff --git a/.env.example b/.env.example index 21e018a..c4a97de 100644 --- a/.env.example +++ b/.env.example @@ -98,13 +98,7 @@ IMAGE_CPU_SECONDS=20 JOB_RETRY_MAX_SECONDS=120 FAILED_STAGING_RETENTION_SECONDS=604800 -# Дополнительные предложения skeleton lab6; пока не подключены к перенесённому стенду. -DATABASE_URL_FILE=/run/secrets/database_url -CACHE_URL_FILE=/run/secrets/cache_url -MAX_UPLOAD_BYTES=10485760 -MAX_IMAGE_PIXELS=40000000 -BROKER_URL_FILE=/run/secrets/broker_url -OTEL_SERVICE_NAME=messenger-api +# Наблюдаемость: SDK экспортирует HTTP/protobuf в Collector. +OTEL_ENABLED=true OTEL_EXPORTER_OTLP_ENDPOINT=http://otel-collector:4318 -OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf -OTEL_RESOURCE_ATTRIBUTES=deployment.environment.name=lab +GRAFANA_HOST_PORT=13000 diff --git a/.gitignore b/.gitignore index 966823e..acbb212 100644 --- a/.gitignore +++ b/.gitignore @@ -36,3 +36,5 @@ venv/ .pytest_cache/ .ruff_cache/ /docs/ + +.verification-error.log diff --git a/Makefile b/Makefile index 38fc435..b861b8a 100644 --- a/Makefile +++ b/Makefile @@ -13,9 +13,11 @@ TEST_PROJECT ?= messenger-test TEST_LB_PORT ?= 28080 TEST_DB_PORT ?= $(DB_HOST_PORT) TEST_REDIS_PORT ?= $(REDIS_HOST_PORT) +TEST_GRAFANA_PORT ?= 23000 +GRAFANA_URL ?= http://localhost:$(or $(GRAFANA_HOST_PORT),13000) TEST_BASE_URL = http://localhost:$(TEST_LB_PORT) TEST_ENV = COMPOSE_PROJECT_NAME=$(TEST_PROJECT) COMPOSE_FILE=compose.yaml:compose.test.yaml \ - LB_HOST_PORT=$(TEST_LB_PORT) DB_HOST_PORT=$(TEST_DB_PORT) REDIS_HOST_PORT=$(TEST_REDIS_PORT) + LB_HOST_PORT=$(TEST_LB_PORT) DB_HOST_PORT=$(TEST_DB_PORT) REDIS_HOST_PORT=$(TEST_REDIS_PORT) GRAFANA_HOST_PORT=$(TEST_GRAFANA_PORT) TEST_COMPOSE = $(TEST_ENV) $(COMPOSE) TEST_DB_PASSWORD = $(if $(wildcard secrets/db_password),$(file None: consumer = uuid4().hex while not stop.is_set(): @@ -81,15 +85,21 @@ async def consume_connected( await broker.reject_invalid(delivery.id) continue try: - async with factory() as session: - acknowledge = await process_attachment_job( - session, - storage, - message, - settings, - after_object=faults.after_object, - before_processing=faults.before_processing, - ) + telemetry = telemetry or Telemetry("messenger-worker", enabled=False) + with telemetry.tracer.start_as_current_span( + "attachment.process.v1", context=Context(), kind=SpanKind.CONSUMER, + record_exception=False, set_status_on_exception=False, + attributes={"messaging.system": "rabbitmq", "job.type": message.type}, + ): + telemetry.event("job.received", job_id=str(message.job_id), + attachment_id=str(message.attachment_id)) + async with factory() as session: + acknowledge = await process_attachment_job( + session, storage, message, settings, + after_object=faults.after_object, + before_processing=faults.before_processing, + telemetry=telemetry, + ) except ProcessingError: await broker.reject_invalid(delivery.id) else: @@ -104,10 +114,10 @@ async def consume_connected( await wait_or_stop(stop, settings.publisher_poll_seconds) -async def consume(factory, storage, settings, stop, faults) -> None: +async def consume(factory, storage, settings, stop, faults, telemetry=None) -> None: broker = JobBroker(settings) try: - await consume_connected(factory, storage, broker, settings, stop, faults) + await consume_connected(factory, storage, broker, settings, stop, faults, telemetry) finally: await broker.aclose() @@ -115,6 +125,7 @@ async def consume(factory, storage, settings, stop, faults) -> None: async def run_worker(faults: Faults) -> None: settings = Settings() jobs = JobSettings() + telemetry = Telemetry("messenger-worker") logging.basicConfig(level=settings.log_level) if not features.check("webp"): logging.error("Pillow requires WebP support for the image worker") @@ -127,7 +138,7 @@ async def run_worker(faults: Faults) -> None: factory = create_session_factory(engine) async with asyncio.TaskGroup() as group: tasks = [ - group.create_task(consume(factory, storage, jobs, stop, faults)) + group.create_task(consume(factory, storage, jobs, stop, faults, telemetry)) for _ in range(jobs.worker_concurrency) ] await stop.wait() @@ -138,6 +149,7 @@ async def run_worker(faults: Faults) -> None: if storage is not None: await storage.aclose() await engine.dispose() + await asyncio.to_thread(telemetry.shutdown) def main() -> None: diff --git a/app/core/telemetry.py b/app/core/telemetry.py new file mode 100644 index 0000000..c234143 --- /dev/null +++ b/app/core/telemetry.py @@ -0,0 +1,160 @@ +"""Явная OTLP-инструментация: экспортируются только выбранные технические поля.""" + +from contextlib import contextmanager +from datetime import datetime, timezone +import json +import os +import socket +import time + +from opentelemetry import trace +from opentelemetry.context import Context +from opentelemetry._logs import SeverityNumber +from opentelemetry.exporter.otlp.proto.http._log_exporter import OTLPLogExporter +from opentelemetry.exporter.otlp.proto.http.metric_exporter import OTLPMetricExporter +from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter +from opentelemetry.sdk._logs import LoggerProvider +from opentelemetry.sdk._logs.export import BatchLogRecordProcessor +from opentelemetry.sdk.metrics import MeterProvider +from opentelemetry.sdk.metrics.export import PeriodicExportingMetricReader +from opentelemetry.sdk.metrics.view import ExplicitBucketHistogramAggregation, View +from opentelemetry.sdk.resources import Resource +from opentelemetry.sdk.trace import TracerProvider +from opentelemetry.sdk.trace.export import BatchSpanProcessor +from opentelemetry.trace import SpanKind, Status, StatusCode + +HTTP_BUCKETS = (0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10) +JOB_BUCKETS = (0.01, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, 30, 60) + + +class Telemetry: + def __init__(self, service: str, instance: str | None = None, *, enabled=None): + self.enabled = (os.getenv("OTEL_ENABLED", "false").lower() == "true" + if enabled is None else enabled) + self.service = service + if not self.enabled: + self.tracer = trace.NoOpTracerProvider().get_tracer("messenger") + return + endpoint = os.getenv("OTEL_EXPORTER_OTLP_ENDPOINT", "http://otel-collector:4318").rstrip("/") + resource = Resource({ + "service.name": service, + "service.version": "1.6.0", + "service.instance.id": instance or socket.gethostname(), + "deployment.environment.name": os.getenv("APP_ENV", "development"), + }) + self.traces = TracerProvider(resource=resource) + self.traces.add_span_processor(BatchSpanProcessor( + OTLPSpanExporter(endpoint=endpoint + "/v1/traces", timeout=2), + max_queue_size=512, max_export_batch_size=128, schedule_delay_millis=1000, + )) + self.tracer = self.traces.get_tracer("messenger", "1.6.0") + self.logs = LoggerProvider(resource=resource) + self.logs.add_log_record_processor(BatchLogRecordProcessor( + OTLPLogExporter(endpoint=endpoint + "/v1/logs", timeout=2), + max_queue_size=512, max_export_batch_size=128, schedule_delay_millis=1000, + )) + self.logger = self.logs.get_logger("messenger", "1.6.0") + self.metrics = MeterProvider(resource=resource, metric_readers=[ + PeriodicExportingMetricReader( + OTLPMetricExporter(endpoint=endpoint + "/v1/metrics", timeout=2), + export_interval_millis=5000, export_timeout_millis=3000, + ) + ], views=[ + View(instrument_name="messenger.http.duration", aggregation=ExplicitBucketHistogramAggregation(HTTP_BUCKETS)), + View(instrument_name="messenger.job.duration", aggregation=ExplicitBucketHistogramAggregation(JOB_BUCKETS)), + ]) + meter = self.metrics.get_meter("messenger", "1.6.0") + self.http_requests = meter.create_counter("messenger.http.requests", unit="1") + self.http_duration = meter.create_histogram("messenger.http.duration", unit="s") + self.jobs = meter.create_counter("messenger.job.attempts", unit="1") + self.job_duration = meter.create_histogram("messenger.job.duration", unit="s") + + def event(self, event: str, *, error=False, **fields): + if not self.enabled: + return + context = trace.get_current_span().get_span_context() + body = { + "timestamp": datetime.now(timezone.utc).isoformat(), + "severity": "ERROR" if error else "INFO", + "service_name": self.service, "event": event, + "trace_id": f"{context.trace_id:032x}", "span_id": f"{context.span_id:016x}", + **fields, + } + text = json.dumps(body, ensure_ascii=False) + # Не подключаем root logging: SDK/SQL-исключения могут содержать секреты. + self.logger.emit(body=text, severity_text=body["severity"], + severity_number=SeverityNumber.ERROR if error else SeverityNumber.INFO, + attributes={"event": event}) + print(text, flush=True) + + @contextmanager + def job_attempt(self): + started = time.monotonic() + result = {"outcome": "success"} + try: + yield result + except BaseException: + result["outcome"] = "error" + raise + finally: + if self.enabled: + attrs = {"job.type": "attachment.process.v1", "outcome": result["outcome"]} + elapsed = time.monotonic() - started + self.jobs.add(1, attrs) + self.job_duration.record(elapsed, attrs) + span = trace.get_current_span() + span.set_attribute("outcome", result["outcome"]) + span.set_status(Status(StatusCode.ERROR if result["outcome"] == "error" else StatusCode.OK)) + self.event("job.processed", error=result["outcome"] == "error", + job_type="attachment.process.v1", duration_seconds=elapsed, **result) + + def shutdown(self): + if self.enabled: + self.metrics.shutdown(timeout_millis=5000) + self.logs.shutdown() + self.traces.shutdown() + + +class HttpTelemetryMiddleware: + def __init__(self, app, telemetry: Telemetry): + self.app = app + self.telemetry = telemetry + + async def __call__(self, scope, receive, send): + if scope["type"] != "http" or not self.telemetry.enabled: + return await self.app(scope, receive, send) + telemetry = self.telemetry + method = scope["method"] + if method not in {"GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"}: + method = "OTHER" + started = time.monotonic() + status = 500 + request_id = "" + with telemetry.tracer.start_as_current_span( + "HTTP", context=Context(), kind=SpanKind.SERVER, + record_exception=False, set_status_on_exception=False, + ) as span: + async def observed_send(message): + nonlocal status, request_id + if message["type"] == "http.response.start": + status = message["status"] + headers = list(message.get("headers", [])) + request_id = next((v.decode() for k, v in headers if k.lower() == b"x-request-id"), "") + headers.append((b"x-trace-id", f"{span.get_span_context().trace_id:032x}".encode())) + message = {**message, "headers": headers} + await send(message) + try: + await self.app(scope, receive, observed_send) + finally: + request_id = request_id or scope.get("state", {}).get("request_id", "") + route = getattr(scope.get("route"), "path", "unmatched") + attrs = {"http.request.method": method, "http.route": route, + "http.response.status_class": f"{status // 100}xx"} + elapsed = time.monotonic() - started + telemetry.http_requests.add(1, attrs) + telemetry.http_duration.record(elapsed, attrs) + span.update_name(f"{method} {route}") + span.set_attributes({**attrs, "http.response.status_code": status}) + span.set_status(Status(StatusCode.ERROR if status >= 500 else StatusCode.OK)) + telemetry.event("http.request", error=status >= 500, method=method, route=route, + status_code=status, request_id=request_id, duration_seconds=elapsed) diff --git a/app/domain/attachment_jobs.py b/app/domain/attachment_jobs.py index ccf9934..f1013db 100644 --- a/app/domain/attachment_jobs.py +++ b/app/domain/attachment_jobs.py @@ -2,6 +2,7 @@ import asyncio from collections.abc import Callable +from contextlib import nullcontext from dataclasses import dataclass from pathlib import Path from tempfile import TemporaryDirectory @@ -12,6 +13,7 @@ from sqlalchemy.ext.asyncio import AsyncSession from urllib3.exceptions import HTTPError as StorageHTTPError from app.core.jobs import JobSettings +from app.core.telemetry import Telemetry from app.domain.job_retry import classify_failure, retry_delay from app.domain.job_files import fetch_original, render_variants from app.errors.exceptions import ProcessingError @@ -201,26 +203,30 @@ async def process_attachment_job( *, after_object: Callable[[UUID, str], None] | None = None, before_processing: Callable[[UUID], None] | None = None, + telemetry: Telemetry | None = None, ) -> bool: claim = await claim_job(session, message, settings) acknowledge = claim.acknowledge if claim.work is not None: work = claim.work - try: - async with asyncio.timeout(settings.job_timeout_seconds): - if before_processing is not None: - before_processing(work.attachment_id) - acknowledge = await build_result(session, storage, work, after_object) - except ( - ProcessingError, - MinioException, - StorageHTTPError, - OSError, - TimeoutError, - ) as error: - code, permanent = classify_failure(error) - await save_failure(session, work, settings, code, permanent=permanent) - acknowledge = True + with telemetry.job_attempt() if telemetry else nullcontext({}) as result: + try: + async with asyncio.timeout(settings.job_timeout_seconds): + if before_processing is not None: + before_processing(work.attachment_id) + acknowledge = await build_result(session, storage, work, after_object) + result["outcome"] = "success" if acknowledge else "deferred" + except ( + ProcessingError, + MinioException, + StorageHTTPError, + OSError, + TimeoutError, + ) as error: + code, permanent = classify_failure(error) + await save_failure(session, work, settings, code, permanent=permanent) + result.update(outcome="error", error_code=code) + acknowledge = True # Ошибка БД/неизвестная ошибка или отмена не подтверждают доставку. return acknowledge diff --git a/app/errors/handlers.py b/app/errors/handlers.py index faa8267..31d2d2b 100644 --- a/app/errors/handlers.py +++ b/app/errors/handlers.py @@ -167,6 +167,10 @@ async def dependency_unavailable_handler( request_id, type(exc).__name__, ) + telemetry = getattr(request.app.state, "telemetry", None) + if telemetry is not None: + telemetry.event("dependency.unavailable", error=True, + request_id=request_id, exception_type=type(exc).__name__) error = unavailable() return _build_response( @@ -206,9 +210,9 @@ async def unhandled_error_handler( request_id = _get_request_id(request) logger.error( - "Unhandled error request_id=%s", + "Unhandled error request_id=%s type=%s", request_id, - exc_info=exc, + type(exc).__name__, ) error = internal_error() diff --git a/app/main.py b/app/main.py index f68247b..f4bb612 100644 --- a/app/main.py +++ b/app/main.py @@ -1,3 +1,4 @@ +import asyncio import logging from collections.abc import AsyncGenerator from contextlib import asynccontextmanager @@ -12,6 +13,7 @@ from app.core.lifecycle import GracefulServer, Lifecycle from app.core.redis import create_redis_client from app.core.request_capacity import acquire_request_slot, create_request_capacity from app.core.request_id import RequestIdMiddleware +from app.core.telemetry import HttpTelemetryMiddleware, Telemetry from app.endpoints.auth import router as auth_router from app.endpoints.attachments import router as attachments_router from app.endpoints.chats import router as chats_router @@ -44,8 +46,9 @@ def create_app(settings: Settings | None = None) -> FastAPI: await s3.aclose() await redis.aclose() await engine.dispose() + await asyncio.to_thread(telemetry.shutdown) - application = FastAPI(title="Messenger", version="1.5.0", lifespan=lifespan) + application = FastAPI(title="Messenger", version="1.6.0", lifespan=lifespan) application.state.settings = settings application.state.engine = engine @@ -57,11 +60,14 @@ def create_app(settings: Settings | None = None) -> FastAPI: ) application.state.request_capacity = create_request_capacity(settings.max_in_flight) application.state.instance_id = resolve_instance_id(settings.instance_id) + telemetry = Telemetry("messenger-api", application.state.instance_id) + application.state.telemetry = telemetry application.state.lifecycle = Lifecycle() application.add_middleware(RequestIdMiddleware) application.add_middleware( InstanceIdMiddleware, instance_id=application.state.instance_id ) + application.add_middleware(HttpTelemetryMiddleware, telemetry=telemetry) register_exception_handlers(application) limited = [Depends(acquire_request_slot)] @@ -83,6 +89,7 @@ def main() -> None: host=settings.app_host, port=settings.app_port, log_level=settings.log_level.lower(), + access_log=False, timeout_graceful_shutdown=settings.graceful_shutdown_timeout_seconds, ) GracefulServer( diff --git a/compose.yaml b/compose.yaml index af2748e..8ddffa1 100644 --- a/compose.yaml +++ b/compose.yaml @@ -11,6 +11,8 @@ x-base-env: &base-env APP_HOST: ${APP_HOST:?Set APP_HOST in .env} APP_PORT: ${APP_PORT:?Set APP_PORT in .env} APP_ENV: ${APP_ENV:?Set APP_ENV in .env} + OTEL_ENABLED: ${OTEL_ENABLED:-true} + OTEL_EXPORTER_OTLP_ENDPOINT: ${OTEL_EXPORTER_OTLP_ENDPOINT:-http://otel-collector:4318} LOG_LEVEL: ${LOG_LEVEL:?Set LOG_LEVEL in .env} MAX_MESSAGES: ${MAX_MESSAGES:?Set MAX_MESSAGES in .env} MAX_IN_FLIGHT: ${MAX_IN_FLIGHT:?Set MAX_IN_FLIGHT in .env} @@ -388,11 +390,105 @@ services: cpus: "0.5" memory: 128M + + otel-collector: + image: otel/opentelemetry-collector-contrib:0.165.0 + command: ["--config=/etc/otelcol/config.yaml"] + restart: unless-stopped + volumes: + - ./infra/otel/collector.yaml:/etc/otelcol/config.yaml:ro + deploy: + resources: + limits: + cpus: "0.5" + memory: 256M + + prometheus: + image: prom/prometheus:v3.16.0 + command: ["--config.file=/etc/prometheus/prometheus.yml", "--storage.tsdb.retention.time=3d"] + restart: unless-stopped + volumes: + - ./infra/otel/prometheus.yaml:/etc/prometheus/prometheus.yml:ro + - prometheusdata:/prometheus + healthcheck: + test: ["CMD", "wget", "-q", "-O", "/dev/null", "http://127.0.0.1:9090/-/ready"] + interval: 5s + timeout: 3s + retries: 20 + deploy: + resources: + limits: + cpus: "0.5" + memory: 512M + + loki: + image: grafana/loki:3.7.10 + command: ["-config.file=/etc/loki/config.yaml"] + restart: unless-stopped + volumes: + - ./infra/otel/loki.yaml:/etc/loki/config.yaml:ro + - lokidata:/loki + deploy: + resources: + limits: + cpus: "0.5" + memory: 512M + + tempo: + image: grafana/tempo:2.9.0 + user: "0:0" + command: ["-config.file=/etc/tempo/config.yaml"] + restart: unless-stopped + volumes: + - ./infra/otel/tempo.yaml:/etc/tempo/config.yaml:ro + - tempodata:/var/tempo + deploy: + resources: + limits: + cpus: "0.5" + memory: 512M + + grafana: + image: grafana/grafana:13.3.1 + restart: unless-stopped + environment: + GF_AUTH_ANONYMOUS_ENABLED: "true" + GF_AUTH_ANONYMOUS_ORG_ROLE: Viewer + GF_SECURITY_ADMIN_PASSWORD__FILE: /run/secrets/grafana_admin_password + GF_USERS_ALLOW_SIGN_UP: "false" + GF_ANALYTICS_REPORTING_ENABLED: "false" + GF_ANALYTICS_CHECK_FOR_UPDATES: "false" + secrets: + - grafana_admin_password + ports: + - "127.0.0.1:${GRAFANA_HOST_PORT:-13000}:3000" + volumes: + - ./infra/otel/grafana/provisioning:/etc/grafana/provisioning:ro + - ./infra/otel/grafana/dashboards:/var/lib/grafana/dashboards:ro + - grafanadata:/var/lib/grafana + healthcheck: + # Loki/Tempo/Collector не содержат shell/HTTP-клиент: проверяем их из Grafana. + test: + - CMD-SHELL + - wget -q -T 2 -O /dev/null http://127.0.0.1:3000/api/health && wget -q -T 2 -O /dev/null http://loki:3100/ready && wget -q -T 2 -O /dev/null http://tempo:3200/ready && wget -q -T 2 -O /dev/null http://otel-collector:13133/ + interval: 5s + timeout: 10s + retries: 36 + deploy: + resources: + limits: + cpus: "0.5" + memory: 512M + volumes: pgdata: redisdata: miniodata: rabbitmqdata: + prometheusdata: + lokidata: + tempodata: + grafanadata: networks: default: @@ -400,6 +496,8 @@ networks: internal: true secrets: + grafana_admin_password: + file: ./secrets/grafana_admin_password broker_password: file: ./secrets/broker_password db_password: diff --git a/evidence/README.md b/evidence/README.md index 8df7001..9593c88 100644 --- a/evidence/README.md +++ b/evidence/README.md @@ -1,5 +1,10 @@ -# Доказательства +# Результаты проверок -Храните небольшие обезличенные результаты: команды и stdout проверок, JSON/CSV агрегатов нагрузки, EXPLAIN, dashboard JSON, текст разбора отказа. Укажите дату, commit, аппаратные лимиты и профиль нагрузки. +`make verify` заново собирает два файла одного прогона: -Не добавляйте .env, session tokens, cookies, приватные ключи, credentials, реальные сообщения, raw dumps и signed URLs. Для скриншотов скрывайте секреты. Большие логи/бинарные traces сохраняйте отдельно по правилам преподавателя; одного скриншота без методики недостаточно. +- `verification.json`: команды, время, результат регрессии, API/отказов и очистки. +- `observability.json`: нагрузка/CPU/RAM, метрики, корреляция логов и traces, + privacy, dashboard, инциденты и сохранность истории после restart. + +Сохраняются только +синтетические технические данные; credentials, токены и тела сообщений исключены. diff --git a/evidence/observability.json b/evidence/observability.json new file mode 100644 index 0000000..7ddd5db --- /dev/null +++ b/evidence/observability.json @@ -0,0 +1,398 @@ +{ + "date_utc": "2026-11-14T01:54:09.593067+00:00", + "project": "messenger-test", + "load": { + "date_utc": "2026-11-14T01:54:04.006033+00:00", + "workload": "synthetic POST messages; fixed arrival rate; no retries", + "duration_seconds": 10, + "elapsed_seconds": 9.929, + "arrival_rate": 10, + "concurrency_limit": 2, + "successful_requests": 100, + "failed_requests": 0, + "error_ratio": 0.0, + "successful_rps": 10.072, + "successful_latency_ms": { + "p50": 31.394, + "p95": 63.623, + "p99": 70.12 + }, + "dataset": { + "users": 3, + "chats": 1, + "messages": 100 + }, + "resource_samples": [ + { + "elapsed_seconds": 2.166, + "containers": [ + { + "Name": "messenger-test-api-1", + "CPUPerc": "54.62%", + "MemUsage": "90.74MiB / 1.5GiB", + "MemPerc": "5.91%" + }, + { + "Name": "messenger-test-api-2", + "CPUPerc": "13.14%", + "MemUsage": "91.79MiB / 1.5GiB", + "MemPerc": "5.98%" + }, + { + "Name": "messenger-test-broker-1", + "CPUPerc": "0.16%", + "MemUsage": "112.5MiB / 768MiB", + "MemPerc": "14.64%" + }, + { + "Name": "messenger-test-cleanup-1", + "CPUPerc": "0.00%", + "MemUsage": "74.46MiB / 256MiB", + "MemPerc": "29.08%" + }, + { + "Name": "messenger-test-grafana-1", + "CPUPerc": "0.85%", + "MemUsage": "373.6MiB / 512MiB", + "MemPerc": "72.96%" + }, + { + "Name": "messenger-test-loki-1", + "CPUPerc": "0.82%", + "MemUsage": "62.73MiB / 512MiB", + "MemPerc": "12.25%" + }, + { + "Name": "messenger-test-minio-1", + "CPUPerc": "66.11%", + "MemUsage": "155.6MiB / 512MiB", + "MemPerc": "30.39%" + }, + { + "Name": "messenger-test-nginx-1", + "CPUPerc": "0.35%", + "MemUsage": "4.312MiB / 128MiB", + "MemPerc": "3.37%" + }, + { + "Name": "messenger-test-otel-collector-1", + "CPUPerc": "0.86%", + "MemUsage": "55.17MiB / 256MiB", + "MemPerc": "21.55%" + }, + { + "Name": "messenger-test-postgres-1", + "CPUPerc": "20.53%", + "MemUsage": "77.13MiB / 512MiB", + "MemPerc": "15.06%" + }, + { + "Name": "messenger-test-prometheus-1", + "CPUPerc": "0.16%", + "MemUsage": "34.8MiB / 512MiB", + "MemPerc": "6.80%" + }, + { + "Name": "messenger-test-publisher-1", + "CPUPerc": "0.92%", + "MemUsage": "62.27MiB / 256MiB", + "MemPerc": "24.32%" + }, + { + "Name": "messenger-test-redis-1", + "CPUPerc": "0.45%", + "MemUsage": "8.496MiB / 512MiB", + "MemPerc": "1.66%" + }, + { + "Name": "messenger-test-tempo-1", + "CPUPerc": "0.62%", + "MemUsage": "224.5MiB / 512MiB", + "MemPerc": "43.85%" + }, + { + "Name": "messenger-test-worker-1", + "CPUPerc": "0.01%", + "MemUsage": "68.05MiB / 2GiB", + "MemPerc": "3.32%" + } + ] + }, + { + "elapsed_seconds": 7.274, + "containers": [ + { + "Name": "messenger-test-api-1", + "CPUPerc": "11.38%", + "MemUsage": "90.96MiB / 1.5GiB", + "MemPerc": "5.92%" + }, + { + "Name": "messenger-test-api-2", + "CPUPerc": "81.50%", + "MemUsage": "98.59MiB / 1.5GiB", + "MemPerc": "6.42%" + }, + { + "Name": "messenger-test-broker-1", + "CPUPerc": "0.25%", + "MemUsage": "112.5MiB / 768MiB", + "MemPerc": "14.64%" + }, + { + "Name": "messenger-test-cleanup-1", + "CPUPerc": "0.00%", + "MemUsage": "74.46MiB / 256MiB", + "MemPerc": "29.08%" + }, + { + "Name": "messenger-test-grafana-1", + "CPUPerc": "0.91%", + "MemUsage": "373.6MiB / 512MiB", + "MemPerc": "72.96%" + }, + { + "Name": "messenger-test-loki-1", + "CPUPerc": "0.98%", + "MemUsage": "62.27MiB / 512MiB", + "MemPerc": "12.16%" + }, + { + "Name": "messenger-test-minio-1", + "CPUPerc": "0.18%", + "MemUsage": "155.6MiB / 512MiB", + "MemPerc": "30.39%" + }, + { + "Name": "messenger-test-nginx-1", + "CPUPerc": "0.75%", + "MemUsage": "3.852MiB / 128MiB", + "MemPerc": "3.01%" + }, + { + "Name": "messenger-test-otel-collector-1", + "CPUPerc": "1.71%", + "MemUsage": "54.97MiB / 256MiB", + "MemPerc": "21.47%" + }, + { + "Name": "messenger-test-postgres-1", + "CPUPerc": "21.91%", + "MemUsage": "77.45MiB / 512MiB", + "MemPerc": "15.13%" + }, + { + "Name": "messenger-test-prometheus-1", + "CPUPerc": "0.84%", + "MemUsage": "35.03MiB / 512MiB", + "MemPerc": "6.84%" + }, + { + "Name": "messenger-test-publisher-1", + "CPUPerc": "1.10%", + "MemUsage": "62.28MiB / 256MiB", + "MemPerc": "24.33%" + }, + { + "Name": "messenger-test-redis-1", + "CPUPerc": "9.35%", + "MemUsage": "8.848MiB / 512MiB", + "MemPerc": "1.73%" + }, + { + "Name": "messenger-test-tempo-1", + "CPUPerc": "0.63%", + "MemUsage": "224.7MiB / 512MiB", + "MemPerc": "43.89%" + }, + { + "Name": "messenger-test-worker-1", + "CPUPerc": "0.49%", + "MemUsage": "68.05MiB / 2GiB", + "MemPerc": "3.32%" + } + ] + } + ], + "limits": "Latency covers successes from worker start; client scheduling is not included. Small controlled load, not a capacity benchmark." + }, + "api_replicas": 2, + "dashboard_uid": "messenger-overview", + "api_correlation": { + "trace_id": "0a0e27eba5d266cf6cdc3eb9bfc7f5ef", + "span_id": "a7638b6d19f2e057", + "log": { + "timestamp": "2026-11-14T01:54:07.311535+00:00", + "severity": "INFO", + "service_name": "messenger-api", + "event": "http.request", + "trace_id": "0a0e27eba5d266cf6cdc3eb9bfc7f5ef", + "span_id": "a7638b6d19f2e057", + "method": "POST", + "route": "/api/v1/chats/{chat_id}/messages", + "status_code": 201, + "request_id": "e60a3114-3fa6-4aa5-a24b-e11f081f041b", + "duration_seconds": 0.015342902999691432 + }, + "spans": [ + { + "name": "POST /api/v1/chats/{chat_id}/messages", + "kind": "SPAN_KIND_SERVER", + "spanId": "p2OLbRny4Fc=", + "startTimeUnixNano": "1794621247296110185", + "endTimeUnixNano": "1794621247311696146", + "status": { + "code": "STATUS_CODE_OK" + } + } + ] + }, + "worker_correlation": { + "trace_id": "e0b8ad546fdfe9dfd5d7391424b2fc18", + "span_id": "47ccae94dff8f378", + "log": { + "timestamp": "2026-11-14T01:54:07.762039+00:00", + "severity": "INFO", + "service_name": "messenger-worker", + "event": "job.received", + "trace_id": "e0b8ad546fdfe9dfd5d7391424b2fc18", + "span_id": "47ccae94dff8f378", + "job_id": "49ce2d69-4237-4836-b23b-e34c45fe9b15", + "attachment_id": "0358f440-2f03-49ae-992d-53447bba3baa" + }, + "spans": [ + { + "name": "attachment.process.v1", + "kind": "SPAN_KIND_CONSUMER", + "spanId": "R8yulN/483g=", + "startTimeUnixNano": "1794621247762005178", + "endTimeUnixNano": "1794621248800203658", + "status": { + "code": "STATUS_CODE_OK" + } + } + ] + }, + "metrics": { + "http_requests": [ + { + "metric": {}, + "value": [ + 1794621249.18, + "229" + ] + } + ], + "http_duration": [ + { + "metric": {}, + "value": [ + 1794621249.198, + "229" + ] + } + ], + "job_success": [ + { + "metric": {}, + "value": [ + 1794621249.248, + "1" + ] + } + ], + "job_duration": [ + { + "metric": {}, + "value": [ + 1794621249.264, + "1" + ] + } + ] + }, + "incidents": [ + { + "scenario": "postgres_unavailable", + "http_status": 503, + "correlation": { + "trace_id": "46bd5c67c04ee46676631207f4cdaaef", + "span_id": "9da26006f1e46fec", + "log": { + "timestamp": "2026-11-14T01:54:11.699761+00:00", + "severity": "ERROR", + "service_name": "messenger-api", + "event": "http.request", + "trace_id": "46bd5c67c04ee46676631207f4cdaaef", + "span_id": "9da26006f1e46fec", + "method": "POST", + "route": "/api/v1/users", + "status_code": 503, + "request_id": "5b3b6549-a5b7-44d9-aaa4-883e7f7f82a6", + "duration_seconds": 0.31245764100094675 + }, + "spans": [ + { + "name": "POST /api/v1/users", + "kind": "SPAN_KIND_SERVER", + "spanId": "naJgBvHkb+w=", + "startTimeUnixNano": "1794621251387164345", + "endTimeUnixNano": "1794621251699877506", + "status": { + "code": "STATUS_CODE_ERROR" + } + } + ] + }, + "diagnostic": { + "timestamp": "2026-11-14T01:54:11.698503+00:00", + "severity": "ERROR", + "service_name": "messenger-api", + "event": "dependency.unavailable", + "trace_id": "46bd5c67c04ee46676631207f4cdaaef", + "span_id": "9da26006f1e46fec", + "request_id": "5b3b6549-a5b7-44d9-aaa4-883e7f7f82a6", + "exception_type": "gaierror" + }, + "observed_after_seconds": 4.194, + "recovery_seconds": 5.664 + }, + { + "scenario": "permanent_processing_failure", + "recovered_status": "ready", + "log": { + "timestamp": "2026-11-14T01:54:18.958470+00:00", + "severity": "ERROR", + "service_name": "messenger-worker", + "event": "job.processed", + "trace_id": "c6bbd94e4fdbad5e5808a2655735b9ed", + "span_id": "40a757e89d4b1f76", + "job_type": "attachment.process.v1", + "duration_seconds": 0.009965533998183673, + "outcome": "error", + "error_code": "injected_permanent" + }, + "failed_jobs_metric": [ + { + "metric": {}, + "value": [ + 1794621294.923, + "1" + ] + } + ], + "metric_query": "sum(messenger_job_attempts_total{outcome=\"error\",service_instance_id=\"3b4f96f13e48\"})", + "failure_to_ready_seconds": 19.356 + } + ], + "privacy_checked_logs": 72, + "checks": { + "three_backends": true, + "dashboard_queries": true, + "server_consumer_traces": true, + "log_trace_correlation": true, + "low_cardinality": true, + "privacy": true, + "history_survives_restart": true + } +} diff --git a/evidence/verification.json b/evidence/verification.json new file mode 100644 index 0000000..4c6b71d --- /dev/null +++ b/evidence/verification.json @@ -0,0 +1,472 @@ +{ + "date_utc": "2026-11-14T01:50:28.592547+00:00", + "checks": [ + { + "name": "contract", + "command": [ + ".venv/bin/python", + "scripts/check_contract.py" + ], + "exit_code": 0, + "duration_seconds": 0.101, + "result": "PASS" + }, + { + "name": "openapi", + "command": [ + ".venv/bin/python", + "scripts/validate_openapi.py" + ], + "exit_code": 0, + "duration_seconds": 1.111, + "result": "PASS" + }, + { + "name": "compose", + "command": [ + "docker", + "compose", + "--env-file", + ".env", + "config", + "--quiet" + ], + "exit_code": 0, + "duration_seconds": 0.131, + "result": "PASS" + }, + { + "name": "startup", + "command": [ + "make", + "--no-print-directory", + "test-stand-up" + ], + "exit_code": 0, + "duration_seconds": 77.116, + "result": "PASS" + }, + { + "name": "regression", + "command": [ + "make", + "--no-print-directory", + "test-unit" + ], + "exit_code": 0, + "duration_seconds": 115.183, + "result": "PASS", + "summary": "206 passed in 112.44s (0:01:52)" + }, + { + "name": "api", + "command": [ + ".venv/bin/python", + "tests/smoke.py", + "--base-url", + "http://localhost:28080" + ], + "exit_code": 0, + "duration_seconds": 8.349, + "result": "PASS" + }, + { + "name": "observability", + "command": [ + ".venv/bin/python", + "-m", + "scripts.check_observability", + "--base-url", + "http://localhost:28080", + "--grafana-url", + "http://localhost:23000", + "--incidents", + "--restart-telemetry" + ], + "exit_code": 0, + "duration_seconds": 79.231, + "result": "PASS" + }, + { + "name": "persistence", + "command": [ + ".venv/bin/python", + "tests/resilience.py", + "--mode", + "persistence", + "--action-script", + "scripts/restart.sh", + "--base-url", + "http://localhost:28080" + ], + "exit_code": 0, + "duration_seconds": 62.485, + "result": "PASS" + }, + { + "name": "failover", + "command": [ + ".venv/bin/python", + "tests/resilience.py", + "--mode", + "failover", + "--action-script", + "scripts/stop-one.sh", + "--base-url", + "http://localhost:28080" + ], + "exit_code": 0, + "duration_seconds": 17.998, + "result": "PASS" + } + ], + "profile": { + "single_stack": true, + "load_duration_seconds": 10, + "load_requests_per_second": 10, + "load_concurrency": 2 + }, + "result": "PASS", + "cleanup": { + "projects": [ + "messenger", + "messenger-test" + ], + "resources": { + "containers": [ + "062d88c22d6c", + "5653c0121264", + "6e2b3ca3c86c", + "ac60f4044ea7", + "e633226993b5", + "1e21fe44a453", + "126c76cff388", + "76901c1e8b60", + "85731e19d4c6", + "79077e49c5ee", + "80a7e7e36fd1", + "69f42359b3e3", + "1a3d86fafd53", + "9f00acc93186", + "bd366e53bf42", + "b4f81e6b52c3", + "a9f375b0b17b" + ], + "networks": [ + "04eba990b02c", + "ff8d81906905" + ], + "volumes": [ + "messenger-test_grafanadata", + "messenger-test_lokidata", + "messenger-test_miniodata", + "messenger-test_pgdata", + "messenger-test_prometheusdata", + "messenger-test_rabbitmqdata", + "messenger-test_redisdata", + "messenger-test_tempodata" + ] + }, + "application_image_ids": [ + "490c0e5b26df", + "669227412939", + "af2ab3c10330" + ], + "local_settings_preserved": true, + "remaining": { + "containers": [], + "networks": [], + "volumes": [] + }, + "application_images_remaining": [], + "result": "PASS", + "verified": { + "containers_remaining": 0, + "volumes_remaining": 0, + "application_images_remaining": 0, + "local_settings_preserved": true + } + }, + "finished_at_utc": "2026-11-14T01:56:33.228789+00:00", + "source": { + "base_commit": "498ce1e0d20c7ffc45ef71b81f5ce3cfa56208ec", + "working_tree_modified": true + }, + "runtime": { + "python": "3.12.14", + "docker_engine": "29.9.3", + "compose": "5.7.0" + }, + "container_lifecycle": [ + { + "time_unix": 1794621212, + "action": "stop", + "service": "redis" + }, + { + "time_unix": 1794621212, + "action": "start", + "service": "redis" + }, + { + "time_unix": 1794621251, + "action": "stop", + "service": "postgres" + }, + { + "time_unix": 1794621251, + "action": "start", + "service": "publisher" + }, + { + "time_unix": 1794621254, + "action": "start", + "service": "postgres" + }, + { + "time_unix": 1794621255, + "action": "stop", + "service": "worker" + }, + { + "time_unix": 1794621256, + "action": "start", + "service": "worker" + }, + { + "time_unix": 1794621267, + "action": "start", + "service": "worker" + }, + { + "time_unix": 1794621269, + "action": "start", + "service": "worker" + }, + { + "time_unix": 1794621271, + "action": "start", + "service": "minio-bootstrap" + }, + { + "time_unix": 1794621272, + "action": "start", + "service": "migrate" + }, + { + "time_unix": 1794621275, + "action": "start", + "service": "worker" + }, + { + "time_unix": 1794621281, + "action": "start", + "service": "worker" + }, + { + "time_unix": 1794621284, + "action": "start", + "service": "worker" + }, + { + "time_unix": 1794621292, + "action": "start", + "service": "worker" + }, + { + "time_unix": 1794621295, + "action": "stop", + "service": "prometheus" + }, + { + "time_unix": 1794621295, + "action": "stop", + "service": "grafana" + }, + { + "time_unix": 1794621295, + "action": "start", + "service": "prometheus" + }, + { + "time_unix": 1794621295, + "action": "start", + "service": "grafana" + }, + { + "time_unix": 1794621295, + "action": "stop", + "service": "loki" + }, + { + "time_unix": 1794621296, + "action": "start", + "service": "loki" + }, + { + "time_unix": 1794621305, + "action": "stop", + "service": "tempo" + }, + { + "time_unix": 1794621305, + "action": "start", + "service": "tempo" + }, + { + "time_unix": 1794621314, + "action": "stop", + "service": "worker" + }, + { + "time_unix": 1794621314, + "action": "stop", + "service": "publisher" + }, + { + "time_unix": 1794621324, + "action": "stop", + "service": "cleanup" + }, + { + "time_unix": 1794621324, + "action": "stop", + "service": "otel-collector" + }, + { + "time_unix": 1794621325, + "action": "stop", + "service": "minio" + }, + { + "time_unix": 1794621325, + "action": "stop", + "service": "prometheus" + }, + { + "time_unix": 1794621325, + "action": "stop", + "service": "grafana" + }, + { + "time_unix": 1794621325, + "action": "stop", + "service": "broker" + }, + { + "time_unix": 1794621325, + "action": "stop", + "service": "redis" + }, + { + "time_unix": 1794621325, + "action": "stop", + "service": "postgres" + }, + { + "time_unix": 1794621325, + "action": "stop", + "service": "loki" + }, + { + "time_unix": 1794621325, + "action": "start", + "service": "minio" + }, + { + "time_unix": 1794621325, + "action": "start", + "service": "otel-collector" + }, + { + "time_unix": 1794621325, + "action": "start", + "service": "prometheus" + }, + { + "time_unix": 1794621325, + "action": "start", + "service": "grafana" + }, + { + "time_unix": 1794621325, + "action": "start", + "service": "broker" + }, + { + "time_unix": 1794621325, + "action": "start", + "service": "redis" + }, + { + "time_unix": 1794621325, + "action": "start", + "service": "postgres" + }, + { + "time_unix": 1794621325, + "action": "start", + "service": "loki" + }, + { + "time_unix": 1794621334, + "action": "stop", + "service": "tempo" + }, + { + "time_unix": 1794621335, + "action": "start", + "service": "tempo" + }, + { + "time_unix": 1794621335, + "action": "stop", + "service": "nginx" + }, + { + "time_unix": 1794621336, + "action": "start", + "service": "nginx" + }, + { + "time_unix": 1794621337, + "action": "stop", + "service": "api" + }, + { + "time_unix": 1794621337, + "action": "stop", + "service": "api" + }, + { + "time_unix": 1794621337, + "action": "start", + "service": "api" + }, + { + "time_unix": 1794621337, + "action": "start", + "service": "api" + }, + { + "time_unix": 1794621344, + "action": "start", + "service": "cleanup" + }, + { + "time_unix": 1794621344, + "action": "start", + "service": "publisher" + }, + { + "time_unix": 1794621345, + "action": "start", + "service": "worker" + }, + { + "time_unix": 1794621377, + "action": "stop", + "service": "api" + } + ] +} diff --git a/infra/otel/README.md b/infra/otel/README.md index c46fe89..6f27be2 100644 --- a/infra/otel/README.md +++ b/infra/otel/README.md @@ -1,7 +1,20 @@ -# Конфигурация наблюдаемости — реализовать +# Наблюдаемость Messenger -Добавьте `collector.yaml` с OTLP receivers, processors и exporters выбранной версии Collector. Укажите явные bind endpoints, внутренние сети, memory limits/batch и поведение при backpressure по уровню. Сопоставьте все три pipeline с реально развёрнутыми backend. +API и worker экспортируют OTLP HTTP/protobuf в Collector (:4318). +Метрики выдаются Prometheus на :8889, логи отправляются в native OTLP Loki, +traces — в Tempo. Grafana читает три хранилища через provisioned datasources. -Добавьте конфигурации storage, Grafana provisioning/datasources, provisioning/dashboards и импортируемые dashboard JSON. На 4 — alert rules и runbooks. Пустой dashboard или debug exporter, который только печатает данные в stdout, не заменяют хранилища/доказательства из `contracts/observability.md`. +Конфиги backend, Collector, dashboard и provisioning находятся в этом каталоге. +Dashboard UID: `messenger-overview`. Метрики — в секундах и счётчиках попыток; +точные запросы/единицы находятся в JSON. Resource environment берётся из APP_ENV. +В Loki индексируются service.name и окружение; instance ID — structured metadata. +Строка лога содержит trace/span ID, ссылка TraceID открывает Tempo. -Не публикуйте OTLP/metrics/административные ports в общую сеть без необходимости. В lab7 реализуйте TLS/mTLS по trust matrix; экспорт Authorization и message bodies запрещён. +История хранится в prometheusdata/lokidata/tempodata, retention 3 дня; +grafanadata содержит настройки Grafana. Внешний порт имеет только Grafana, +по умолчанию 127.0.0.1:13000. Её healthcheck проверяет также Loki, Tempo и Collector. +Бизнес-readiness API от этих сервисов не зависит. + +Проверка: `make test-observability`. Полный прогон с очисткой: `make verify`. +Инструкция запуска — в [RUNNING.md](../../RUNNING.md), ограничения и планы — в +[REPORT.md](../../REPORT.md). diff --git a/infra/otel/collector.yaml b/infra/otel/collector.yaml new file mode 100644 index 0000000..892f65c --- /dev/null +++ b/infra/otel/collector.yaml @@ -0,0 +1,53 @@ +receivers: + otlp: + protocols: + http: + endpoint: 0.0.0.0:4318 +processors: + memory_limiter: + check_interval: 1s + limit_mib: 192 + spike_limit_mib: 32 + batch: + timeout: 1s + send_batch_size: 128 + send_batch_max_size: 256 +exporters: + prometheus: + endpoint: 0.0.0.0:8889 + resource_to_telemetry_conversion: + enabled: true + otlphttp/loki: + endpoint: http://loki:3100/otlp + timeout: 3s + sending_queue: + queue_size: 256 + num_consumers: 2 + retry_on_failure: + max_elapsed_time: 30s + otlphttp/tempo: + endpoint: http://tempo:4318 + timeout: 3s + sending_queue: + queue_size: 256 + num_consumers: 2 + retry_on_failure: + max_elapsed_time: 30s +extensions: + health_check: + endpoint: 0.0.0.0:13133 +service: + extensions: [health_check] + pipelines: + metrics: + receivers: [otlp] + processors: [memory_limiter, batch] + exporters: [prometheus] + logs: + receivers: [otlp] + processors: [memory_limiter, batch] + exporters: [otlphttp/loki] + traces: + receivers: [otlp] + processors: [memory_limiter, batch] + exporters: [otlphttp/tempo] diff --git a/infra/otel/grafana/dashboards/messenger.json b/infra/otel/grafana/dashboards/messenger.json new file mode 100644 index 0000000..11c1d63 --- /dev/null +++ b/infra/otel/grafana/dashboards/messenger.json @@ -0,0 +1,343 @@ +{ + "uid": "messenger-overview", + "title": "Messenger — наблюдаемость", + "schemaVersion": 39, + "version": 1, + "tags": [ + "messenger", + "observability" + ], + "timezone": "browser", + "refresh": "5s", + "time": { + "from": "now-15m", + "to": "now" + }, + "panels": [ + { + "id": 1, + "title": "API: запросы в секунду", + "type": "timeseries", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + }, + "gridPos": { + "x": 0, + "y": 0, + "w": 12, + "h": 9 + }, + "targets": [ + { + "refId": "A", + "expr": "sum by (http_request_method, http_route) (rate(messenger_http_requests_total{http_route!~\"/health/.*\"}[1m]))", + "legendFormat": "{{http_request_method}} {{http_route}}" + } + ], + "description": "", + "fieldConfig": { + "defaults": { + "unit": "reqps" + }, + "overrides": [] + }, + "options": {} + }, + { + "id": 2, + "title": "API: доля 5xx", + "type": "timeseries", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + }, + "gridPos": { + "x": 12, + "y": 0, + "w": 12, + "h": 9 + }, + "targets": [ + { + "refId": "A", + "expr": "(sum(rate(messenger_http_requests_total{http_response_status_class=\"5xx\",http_route!~\"/health/.*\"}[1m])) or vector(0)) / clamp_min(sum(rate(messenger_http_requests_total{http_route!~\"/health/.*\"}[1m])), 0.000001)", + "legendFormat": "5xx / все бизнес-запросы" + } + ], + "description": "Ошибки сервера: 5xx / все запросы, кроме health. 4xx не считаются отказом сервера.", + "fieldConfig": { + "defaults": { + "unit": "percentunit" + }, + "overrides": [] + }, + "options": {} + }, + { + "id": 3, + "title": "API: время ответа p50/p95/p99", + "type": "timeseries", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + }, + "gridPos": { + "x": 0, + "y": 9, + "w": 12, + "h": 9 + }, + "targets": [ + { + "refId": "A", + "expr": "histogram_quantile(0.5, sum by (le) (rate(messenger_http_duration_seconds_bucket{http_route!~\"/health/.*\"}[1m])))", + "legendFormat": "p50" + }, + { + "refId": "B", + "expr": "histogram_quantile(0.95, sum by (le) (rate(messenger_http_duration_seconds_bucket{http_route!~\"/health/.*\"}[1m])))", + "legendFormat": "p95" + }, + { + "refId": "C", + "expr": "histogram_quantile(0.99, sum by (le) (rate(messenger_http_duration_seconds_bucket{http_route!~\"/health/.*\"}[1m])))", + "legendFormat": "p99" + } + ], + "description": "Histogram в секундах, buckets суммируются по репликам.", + "fieldConfig": { + "defaults": { + "unit": "s" + }, + "overrides": [] + }, + "options": {} + }, + { + "id": 4, + "title": "Worker: попытки в секунду по исходу", + "type": "timeseries", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + }, + "gridPos": { + "x": 12, + "y": 9, + "w": 12, + "h": 9 + }, + "targets": [ + { + "refId": "A", + "expr": "sum by (outcome) (rate(messenger_job_attempts_total[1m]))", + "legendFormat": "{{outcome}}" + } + ], + "description": "success — результат записан; error — попытка не удалась; deferred — истёк lease. Дубли без обработки не считаются.", + "fieldConfig": { + "defaults": { + "unit": "ops" + }, + "overrides": [] + }, + "options": {} + }, + { + "id": 5, + "title": "Worker: время обработки p95", + "type": "timeseries", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + }, + "gridPos": { + "x": 0, + "y": 18, + "w": 12, + "h": 9 + }, + "targets": [ + { + "refId": "A", + "expr": "histogram_quantile(0.95, sum by (le, outcome) (rate(messenger_job_duration_seconds_bucket[1m])))", + "legendFormat": "{{outcome}}" + } + ], + "description": "Одна фактическая попытка, включая S3, преобразования и фиксацию metadata.", + "fieldConfig": { + "defaults": { + "unit": "s" + }, + "overrides": [] + }, + "options": {} + }, + { + "id": 6, + "title": "Worker: обработанные попытки", + "type": "timeseries", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + }, + "gridPos": { + "x": 12, + "y": 18, + "w": 12, + "h": 9 + }, + "targets": [ + { + "refId": "A", + "expr": "sum by (outcome) (messenger_job_attempts_total)", + "legendFormat": "{{outcome}}" + } + ], + "description": "", + "fieldConfig": { + "defaults": { + "unit": "short" + }, + "overrides": [] + }, + "options": {} + }, + { + "id": 7, + "title": "API: структурные логи", + "type": "logs", + "datasource": { + "type": "loki", + "uid": "loki" + }, + "gridPos": { + "x": 0, + "y": 27, + "w": 12, + "h": 9 + }, + "targets": [ + { + "refId": "A", + "expr": "{service_name=\"messenger-api\"} | json", + "queryType": "range" + } + ], + "description": "", + "fieldConfig": { + "defaults": { + "unit": "short" + }, + "overrides": [] + }, + "options": {} + }, + { + "id": 8, + "title": "Worker: структурные логи", + "type": "logs", + "datasource": { + "type": "loki", + "uid": "loki" + }, + "gridPos": { + "x": 12, + "y": 27, + "w": 12, + "h": 9 + }, + "targets": [ + { + "refId": "A", + "expr": "{service_name=\"messenger-worker\"} | json", + "queryType": "range" + } + ], + "description": "", + "fieldConfig": { + "defaults": { + "unit": "short" + }, + "overrides": [] + }, + "options": {} + }, + { + "id": 9, + "title": "Реальные server/consumer traces", + "type": "table", + "datasource": { + "type": "tempo", + "uid": "tempo" + }, + "gridPos": { + "x": 0, + "y": 36, + "w": 12, + "h": 9 + }, + "targets": [ + { + "refId": "A", + "queryType": "traceqlSearch", + "query": "{ resource.service.name =~ \"messenger-api|messenger-worker\" }", + "limit": 20 + } + ], + "description": "Открыть trace в Explore; ссылка TraceID из строки Loki ведёт к той же трассе.", + "fieldConfig": { + "defaults": { + "unit": "short" + }, + "overrides": [] + }, + "options": {} + }, + { + "id": 10, + "title": "API: число 5xx бизнес-запросов", + "type": "stat", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + }, + "gridPos": { + "x": 12, + "y": 36, + "w": 12, + "h": 9 + }, + "targets": [ + { + "refId": "A", + "expr": "sum(messenger_http_requests_total{http_response_status_class=\"5xx\",http_route!~\"/health/.*\"}) or vector(0)", + "instant": true + } + ], + "fieldConfig": { + "defaults": { + "unit": "short" + }, + "overrides": [] + }, + "options": { + "reduceOptions": { + "calcs": [ + "lastNotNull" + ], + "fields": "", + "values": false + } + }, + "description": "Накопленное число 5xx: показывает и первую ошибку нового ряда, когда rate ещё не имеет двух разных точек." + } + ], + "annotations": { + "list": [] + }, + "templating": { + "list": [] + } +} diff --git a/infra/otel/grafana/provisioning/dashboards/provider.yaml b/infra/otel/grafana/provisioning/dashboards/provider.yaml new file mode 100644 index 0000000..8af1de4 --- /dev/null +++ b/infra/otel/grafana/provisioning/dashboards/provider.yaml @@ -0,0 +1,10 @@ +apiVersion: 1 +providers: + - name: Messenger + folder: Messenger + type: file + disableDeletion: true + editable: false + updateIntervalSeconds: 10 + options: + path: /var/lib/grafana/dashboards diff --git a/infra/otel/grafana/provisioning/datasources/sources.yaml b/infra/otel/grafana/provisioning/datasources/sources.yaml new file mode 100644 index 0000000..d95980b --- /dev/null +++ b/infra/otel/grafana/provisioning/datasources/sources.yaml @@ -0,0 +1,36 @@ +apiVersion: 1 +datasources: + - name: Prometheus + uid: prometheus + type: prometheus + access: proxy + url: http://prometheus:9090 + isDefault: true + editable: false + - name: Loki + uid: loki + type: loki + access: proxy + url: http://loki:3100 + editable: false + jsonData: + derivedFields: + - name: TraceID + matcherRegex: '"trace_id":\s*"([0-9a-f]{32})"' + datasourceUid: tempo + url: '$${__value.raw}' + urlDisplayLabel: Open trace + - name: Tempo + uid: tempo + type: tempo + access: proxy + url: http://tempo:3200 + editable: false + jsonData: + tracesToLogsV2: + datasourceUid: loki + spanStartTimeShift: '-1m' + spanEndTimeShift: '1m' + tags: [{key: service.name, value: service_name}] + filterByTraceID: true + filterBySpanID: false diff --git a/infra/otel/loki.yaml b/infra/otel/loki.yaml new file mode 100644 index 0000000..b022f72 --- /dev/null +++ b/infra/otel/loki.yaml @@ -0,0 +1,39 @@ +auth_enabled: false +server: + http_listen_port: 3100 +common: + path_prefix: /loki + replication_factor: 1 + ring: + kvstore: + store: inmemory + storage: + filesystem: + chunks_directory: /loki/chunks + rules_directory: /loki/rules +schema_config: + configs: + - from: 2024-01-01 + store: tsdb + object_store: filesystem + schema: v13 + index: + prefix: index_ + period: 24h +limits_config: + allow_structured_metadata: true + retention_period: 72h + otlp_config: + resource_attributes: + ignore_defaults: true + attributes_config: + - action: index_label + attributes: [service.name, deployment.environment.name] + - action: structured_metadata + attributes: [service.version, service.instance.id] +compactor: + working_directory: /loki/compactor + retention_enabled: true + delete_request_store: filesystem +analytics: + reporting_enabled: false diff --git a/infra/otel/prometheus.yaml b/infra/otel/prometheus.yaml new file mode 100644 index 0000000..8997d87 --- /dev/null +++ b/infra/otel/prometheus.yaml @@ -0,0 +1,7 @@ +global: + scrape_interval: 5s + evaluation_interval: 5s +scrape_configs: + - job_name: messenger + static_configs: + - targets: [otel-collector:8889] diff --git a/infra/otel/tempo.yaml b/infra/otel/tempo.yaml new file mode 100644 index 0000000..85bfea8 --- /dev/null +++ b/infra/otel/tempo.yaml @@ -0,0 +1,22 @@ +server: + http_listen_port: 3200 +distributor: + receivers: + otlp: + protocols: + http: + endpoint: 0.0.0.0:4318 +ingester: + max_block_duration: 1m +compactor: + compaction: + block_retention: 72h +storage: + trace: + backend: local + wal: + path: /var/tempo/wal + local: + path: /var/tempo/blocks +usage_report: + reporting_enabled: false diff --git a/requirements.txt b/requirements.txt index a3f67b5..15ce048 100644 --- a/requirements.txt +++ b/requirements.txt @@ -21,6 +21,9 @@ MarkupSafe==3.0.4 openapi-schema-validator==0.6.3 openapi-spec-validator==0.7.2 opentelemetry-api==1.45.1 +opentelemetry-sdk==1.45.1 +opentelemetry-exporter-otlp-proto-http==1.45.1 +opentelemetry-semantic-conventions==0.66b1 packaging==26.3 pathable==0.4.4 pluggy==1.7.0 diff --git a/scripts/check_jobs.py b/scripts/check_jobs.py index 76519c5..5bea24b 100644 --- a/scripts/check_jobs.py +++ b/scripts/check_jobs.py @@ -179,7 +179,7 @@ def crash(client, actor, chat, mode): ) -def retry_replay(client, actor, chat, permanent): +def retry_replay(client, actor, chat, permanent, on_failed=None): name = "messenger-retry-fault-" + uuid4().hex samples = [] configuration = ComposeProject().config["services"]["worker"]["environment"] @@ -238,6 +238,8 @@ def retry_replay(client, actor, chat, permanent): actor=actor, expected=409, ) + if on_failed is not None: + on_failed(sample, name) job_id = sample["job_id"] request_id = str(uuid4()) listing = admin("list-failed") diff --git a/scripts/check_observability.py b/scripts/check_observability.py new file mode 100644 index 0000000..330138e --- /dev/null +++ b/scripts/check_observability.py @@ -0,0 +1,291 @@ +"""Проверка наблюдаемости через реальные запросы Grafana к трём backend. + +--incidents явно разрешает два ограниченных отказа на выбранном Compose-проекте. +В evidence сохраняются только агрегаты и выбранные технические поля. +""" + +import argparse +import base64 +from concurrent.futures import ThreadPoolExecutor +import math +import subprocess +import threading +from datetime import datetime, timezone +import json +from pathlib import Path +import time +import urllib.parse +import urllib.request +from uuid import uuid4 + +from scripts.deployment import ComposeProject +from tests.client import Client, Failure, check + +ROOT = Path(__file__).resolve().parents[1] + + +def eventually(operation, message, timeout=90): + deadline = time.monotonic() + timeout + while time.monotonic() < deadline: + try: + value = operation() + if value: + return value + except (OSError, ValueError, KeyError, AssertionError): + pass + time.sleep(1) + raise AssertionError(message) + + +class Grafana: + def __init__(self, base): + self.base = base.rstrip('/') + secret = (ROOT / 'secrets/grafana_admin_password').read_text().strip() + self.authorization = 'Basic ' + base64.b64encode(('admin:' + secret).encode()).decode() + + def get(self, path, **params): + url = self.base + path + if params: + url += '?' + urllib.parse.urlencode(params) + request = urllib.request.Request(url, headers={'Authorization': self.authorization, 'Accept': 'application/json'}) + with urllib.request.urlopen(request, timeout=10) as response: + return json.load(response) + + def proxy(self, source, path, **params): + return self.get('/api/datasources/proxy/uid/' + source + path, **params) + + def query(self, expression): + value = self.proxy('prometheus', '/api/v1/query', query=expression) + check(value['status'] == 'success', 'Prometheus query failed') + return value['data']['result'] + + def logs(self, selector, start): + value = self.proxy('loki', '/loki/api/v1/query_range', query=selector, start=start, end=time.time_ns(), limit=1000, direction='forward') + check(value['status'] == 'success', 'Loki query failed') + return [json.loads(line) for stream in value['data']['result'] for _, line, *_ in stream['values']] + + def trace(self, trace_id): + return self.proxy('tempo', '/api/traces/' + trace_id) + + +def identifier_hex(value, byte_length): + if len(value) == byte_length * 2 and all(c in '0123456789abcdefABCDEF' for c in value): + return value.lower() + return base64.b64decode(value, validate=True).hex() + + +def spans_in(value): + found = [] + if isinstance(value, dict): + for key, item in value.items(): + if key == 'spans': + found.extend(item) + else: + found.extend(spans_in(item)) + elif isinstance(value, list): + for item in value: + found.extend(spans_in(item)) + return found + + +def correlation(grafana, service, start, *, trace_id=None, attachment_id=None, request_id=None): + selector = '{service_name="' + service + '"} | json' + if service == 'messenger-api': + selector += ' | event="http.request"' + if trace_id: + selector += ' | trace_id="' + trace_id + '"' + if attachment_id: + selector += ' | attachment_id="' + attachment_id + '"' + if request_id: + selector += ' | request_id="' + request_id + '"' + records = eventually(lambda: grafana.logs(selector, start), 'No correlated log for ' + service) + record = records[0] + trace_id = record['trace_id'] + def matching_trace(): + candidate = grafana.trace(trace_id) + return candidate if any(identifier_hex(span.get('spanId', ''), 8) == record['span_id'] for span in spans_in(candidate)) else None + trace = eventually(matching_trace, 'Matching span is missing in Tempo') + spans = [span for span in spans_in(trace) if identifier_hex(span.get('spanId', ''), 8) == record['span_id']] + # Tempo 2.9 JSON использует protobuf bytes (Base64); Loki хранит hex. + check(any(identifier_hex(span.get('spanId', ''), 8) == record['span_id'] for span in spans), 'Log span_id not found in real trace') + check(all(int(span['endTimeUnixNano']) > int(span['startTimeUnixNano']) for span in spans), 'Trace has no real duration') + return {'trace_id': trace_id, 'span_id': record['span_id'], 'log': record, + 'spans': [{key: span.get(key) for key in ('name', 'kind', 'spanId', 'startTimeUnixNano', 'endTimeUnixNano', 'status')} for span in spans]}, trace + + +def run_load(args): + check(1 <= args.duration <= 300 and 1 <= args.rate <= 40 and 1 <= args.concurrency <= 16, 'Load profile outside bounds') + client = Client(args.base_url) + actor, _, _, chat = client.bootstrap() + project = ComposeProject() + container_ids = project.run('ps', '--quiet').splitlines() + samples = [] + stop = threading.Event() + + def sample(): + while not stop.is_set(): + result = subprocess.run(['docker','stats','--no-stream','--format','{{json .}}',*container_ids],capture_output=True,text=True,timeout=15) + if result.returncode == 0: + samples.append({'elapsed_seconds':round(time.monotonic()-started,3), 'containers':[ + {k:row[k] for k in ('Name','CPUPerc','MemUsage','MemPerc')} for row in (json.loads(line) for line in result.stdout.splitlines())]}) + stop.wait(3) + + def write(index): + local = Client(args.base_url) + before = time.monotonic() + try: + local.message(actor,chat,'synthetic-observability-' + str(index)) + return time.monotonic()-before + except Failure: + return None + + started = time.monotonic() + sampler = threading.Thread(target=sample) + sampler.start() + try: + with ThreadPoolExecutor(max_workers=args.concurrency) as pool: + futures = [] + for index in range(args.duration * args.rate): + time.sleep(max(0, started + index/args.rate - time.monotonic())) + futures.append(pool.submit(write,index)) + results = [future.result() for future in futures] + elapsed = time.monotonic()-started + finally: + stop.set() + sampler.join() + latencies = sorted(value for value in results if value is not None) + failed = len(results)-len(latencies) + def percentile(q): + return round(latencies[max(0, math.ceil(q*len(latencies))-1)]*1000,3) if latencies else None + report = {'date_utc':datetime.now(timezone.utc).isoformat(), 'workload':'synthetic POST messages; fixed arrival rate; no retries', + 'duration_seconds':args.duration,'elapsed_seconds':round(elapsed,3),'arrival_rate':args.rate,'concurrency_limit':args.concurrency, + 'successful_requests':len(latencies),'failed_requests':failed,'error_ratio':failed/len(results), + 'successful_rps':round(len(latencies)/elapsed,3), 'successful_latency_ms':{name:percentile(q) for name,q in [('p50',.5),('p95',.95),('p99',.99)]}, + 'dataset':{'users':3,'chats':1,'messages':len(latencies)},'resource_samples':samples, + 'limits':'Latency covers successes from worker start; client scheduling is not included. Small controlled load, not a capacity benchmark.'} + check(bool(latencies) and failed == 0, 'Controlled load contains errors') + + return report + + +def main(): + parser = argparse.ArgumentParser() + parser.add_argument('--base-url', required=True) + parser.add_argument('--grafana-url', default='http://localhost:13000') + parser.add_argument('--incidents', action='store_true') + parser.add_argument('--restart-telemetry', action='store_true') + parser.add_argument('--output', default='evidence/observability.json') + parser.add_argument('--duration', type=int, default=10) + parser.add_argument('--rate', type=int, default=10) + parser.add_argument('--concurrency', type=int, default=2) + args = parser.parse_args() + load = run_load(args) + start = time.time_ns() + project = ComposeProject() + client = Client(args.base_url, timeout=40) + aliases = {r.instance_id for r in project.replicas() if r.running} + check(len(aliases) >= 2, 'Need two real API containers') + check(client.call('GET', '/health/live')['headers'].get('X-Instance-Id') in aliases, 'Wrong Compose project for BASE_URL') + grafana = Grafana(args.grafana_url) + eventually(lambda: grafana.get('/api/health').get('database') == 'ok', 'Grafana is not ready') + sources = grafana.get('/api/datasources') + check({'prometheus', 'loki', 'tempo'} <= {source['uid'] for source in sources}, 'Missing provisioned datasource') + dashboard = grafana.get('/api/dashboards/uid/messenger-overview')['dashboard'] + check(len(dashboard['panels']) >= 8, 'Dashboard is missing panels') + actor, bob, eve, chat = client.bootstrap() + sentinel = 'private-content-' + uuid4().hex + response = client.message(actor, chat, sentinel) + controlled_trace = response['headers'].get('X-Trace-Id') + check(bool(controlled_trace), 'No API trace identifier') + attachment, _ = client.attachment(actor, chat) + client.wait_ready(actor, attachment) + api, api_trace = correlation(grafana, 'messenger-api', start, trace_id=controlled_trace, request_id=response['headers']['X-Request-Id']) + worker, worker_trace = correlation(grafana, 'messenger-worker', start, attachment_id=attachment['id']) + check(api['log']['request_id'] == response['headers']['X-Request-Id'], 'Request id correlation lost') + check(any(span['kind'] in ('SPAN_KIND_SERVER', 2) for span in api['spans']), 'No server span') + check(any(span['kind'] in ('SPAN_KIND_CONSUMER', 5) for span in worker['spans']), 'No consumer span') + processed = eventually(lambda: grafana.logs('{service_name="messenger-worker"} | json | event="job.processed" | trace_id="' + worker['trace_id'] + '"', start), 'No worker result log') + check(processed[0]['outcome'] == 'success', 'Controlled worker did not succeed') + metrics = {} + expressions = { + 'http_requests': 'sum(messenger_http_requests_total)', + 'http_duration': 'sum(messenger_http_duration_seconds_count)', + 'job_success': 'sum(messenger_job_attempts_total{outcome="success"})', + 'job_duration': 'sum(messenger_job_duration_seconds_count)', + } + for name, expression in expressions.items(): + metrics[name] = eventually(lambda expression=expression: grafana.query(expression), 'Missing metric: ' + expression) + check(float(metrics[name][0]['value'][1]) > 0, 'Empty metric: ' + name) + # Все PromQL из dashboard должны давать численные данные после traffic. + for panel in dashboard['panels']: + if panel['datasource']['uid'] == 'prometheus': + eventually(lambda panel=panel: all(grafana.query(target['expr']) for target in panel['targets']), 'Empty dashboard panel: ' + panel['title']) + forbidden_labels = {'user_id','chat_id','message_id','attachment_id','request_id','filename','url','http_target','http_url'} + series = grafana.query('{__name__=~"messenger_.*"}') + check(not any(forbidden_labels & set(row['metric']) for row in series), 'High cardinality metric label') + report = {'date_utc': datetime.now(timezone.utc).isoformat(), 'project': project.name, + 'load': load, 'api_replicas': len(aliases), 'dashboard_uid': dashboard['uid'], + 'api_correlation': api, 'worker_correlation': worker, 'metrics': metrics, 'incidents': []} + if args.incidents: + # Восстановление выполняется даже при ошибке проверки. + try: + before = time.monotonic() + project.run('stop', 'postgres') + failed = client.call('POST', '/api/v1/users', expected=503, + body={'username':'fault_' + uuid4().hex[:12], 'display_name':'Synthetic', 'password':'not-exported-' + uuid4().hex}) + error_trace = failed['headers'].get('X-Trace-Id') + error, _ = correlation(grafana, 'messenger-api', start, trace_id=error_trace, request_id=failed['headers']['X-Request-Id']) + diagnostics = eventually(lambda: grafana.logs('{service_name="messenger-api"} | json | event="dependency.unavailable" | trace_id="' + error_trace + '"', start), 'No dependency diagnostic log') + check(error['log'].get('status_code') == 503 or any(s['status'].get('code') in ('STATUS_CODE_ERROR', 2) for s in error['spans']), 'DB failure not reflected in trace') + report['incidents'].append({'scenario':'postgres_unavailable','http_status':503,'correlation':error,'diagnostic':diagnostics[0], 'observed_after_seconds':round(time.monotonic()-before,3)}) + finally: + project.run('start', 'postgres') + eventually(lambda: _ready(client), 'API did not recover after PostgreSQL') + report['incidents'][-1]['recovery_seconds'] = round(time.monotonic() - before, 3) + # Явный fault hook обработки заданий: один permanent processing failure, затем replay. + from scripts.check_jobs import retry_replay + failed_instance = [] + def wait_failed_metric(sample, container_name): + instance = project.docker('inspect', '--format', '{{.Config.Hostname}}', container_name) + failed_instance.append(instance) + expression = 'sum(messenger_job_attempts_total{outcome="error",service_instance_id="' + instance + '"})' + eventually(lambda: grafana.query(expression), 'Failed job metric not exported before recovery') + incident = retry_replay(client, actor, chat, permanent=True, on_failed=wait_failed_metric) + error_logs = eventually(lambda: grafana.logs('{service_name="messenger-worker"} | json | event="job.processed" | outcome="error" | error_code="injected_permanent"', start), 'No failed job telemetry') + error_trace = eventually(lambda: grafana.trace(error_logs[-1]['trace_id']), 'No failed job trace') + check(any(span.get('status', {}).get('code') in ('STATUS_CODE_ERROR', 2) for span in spans_in(error_trace)), 'Worker error trace status lost') + expression = 'sum(messenger_job_attempts_total{outcome="error",service_instance_id="' + failed_instance[0] + '"})' + errors = eventually(lambda: grafana.query(expression), 'No failed jobs counter') + recovery = (datetime.fromisoformat(incident['after']['updated_at']) - datetime.fromisoformat(incident['samples'][-1]['updated_at'])).total_seconds() + report['incidents'].append({'scenario':'permanent_processing_failure','recovered_status':incident['after']['status'], 'log':error_logs[-1], 'failed_jobs_metric':errors, 'metric_query':expression, 'failure_to_ready_seconds':round(recovery,3)}) + # Не сохраняем API bodies или SDK exceptions; проверяем реальные выбранные сигналы. + logs = grafana.logs('{service_name=~"messenger-api|messenger-worker"}', start) + exported = json.dumps([logs, api_trace, worker_trace]) + private = [sentinel, *(person['token'] for person in (actor,bob,eve)), *(person['registration']['password'] for person in (actor,bob,eve))] + private.extend(path.read_text().strip() for path in (ROOT / 'secrets').iterdir() if path.is_file()) + check(not any(secret and secret in exported for secret in private), 'Private value found in telemetry') + check(all(record.get('trace_id') and record.get('span_id') and record.get('timestamp') and record.get('severity') for record in logs), 'Incomplete structured logs') + report['privacy_checked_logs'] = len(logs) + report['checks'] = {'three_backends':True, 'dashboard_queries':True,'server_consumer_traces':True,'log_trace_correlation':True,'low_cardinality':True,'privacy':True} + if args.restart_telemetry: + historical_time = time.time() + expression = 'sum(messenger_http_requests_total)' + before = grafana.proxy('prometheus', '/api/v1/query', query=expression, time=historical_time)['data']['result'] + project.run('restart', 'prometheus', 'loki', 'tempo', 'grafana') + after = eventually(lambda: grafana.proxy('prometheus', '/api/v1/query', query=expression, time=historical_time)['data']['result'], 'Prometheus history lost') + check(before == after, 'Historical metric changed after storage restart') + correlation(grafana, 'messenger-api', start, trace_id=api['trace_id']) + correlation(grafana, 'messenger-worker', start, trace_id=worker['trace_id']) + report['checks']['history_survives_restart'] = True + destination = ROOT / args.output + destination.parent.mkdir(parents=True, exist_ok=True) + destination.write_text(json.dumps(report,ensure_ascii=False,indent=2)+'\n') + print('PASS: telemetry, dashboard, privacy, correlations' + ('; two incidents recovered' if args.incidents else '')) + + +def _ready(client): + return client.call('GET', '/health/ready', expected=[200,503])['status'] == 200 + + +if __name__ == '__main__': + main() diff --git a/scripts/deployment.py b/scripts/deployment.py index c629e6e..6572e90 100644 --- a/scripts/deployment.py +++ b/scripts/deployment.py @@ -71,3 +71,145 @@ class ComposeProject: ) for row in map(json.loads, rows) ] + + +def cleanup_docker(*args, allow_failure=False): + result = subprocess.run(['docker',*args],cwd=ROOT,text=True,capture_output=True,timeout=120) + if result.returncode and not allow_failure: + raise RuntimeError('Docker cleanup failed: ' + ' '.join(args[:2])) + return result.stdout.strip() + + +def inventory(projects): + resources = {'containers':[], 'networks':[], 'volumes':[]} + for project in projects: + label = 'label=com.docker.compose.project=' + project + resources['containers'].extend(cleanup_docker('ps','-aq','--filter',label).splitlines()) + resources['networks'].extend(cleanup_docker('network','ls','-q','--filter',label).splitlines()) + resources['volumes'].extend(cleanup_docker('volume','ls','-q','--filter',label).splitlines()) + return resources + + + +def clean_stands(*, apply=False): + config = json.loads(cleanup_docker('compose','--env-file','.env','config','--format','json')) + projects = sorted({config['name'], os.getenv('MAIN_PROJECT', 'messenger'), os.getenv('TEST_PROJECT', 'messenger-test')}) + resources = inventory(projects) + names = {service['image'] for service in config['services'].values() if 'build' in service} + image_ids = set() + for name in names: + image_ids.update(cleanup_docker('image','ls','-q',name).splitlines()) + # У старых сборок API может уже не быть тега. Сверяем также команду и WORKDIR, + # чтобы не затронуть сторонние образы с обычным OCI revision label. + candidates = cleanup_docker('image','ls','-q','--filter','label=org.opencontainers.image.revision').splitlines() + for candidate in candidates: + image = json.loads(cleanup_docker('image','inspect',candidate))[0] + settings = image['Config'] + if settings.get('Cmd') == ['python','-m','app'] and settings.get('WorkingDir') == '/app': + image_ids.add(candidate) + plan = {'projects':projects, 'resources':resources, 'application_image_ids':sorted(image_ids), 'local_settings_preserved':True} + if not apply: + return plan + if resources['containers']: + cleanup_docker('rm','-f','-v',*resources['containers']) + if resources['networks']: + cleanup_docker('network','rm',*resources['networks']) + if resources['volumes']: + cleanup_docker('volume','rm',*resources['volumes']) + if image_ids: + cleanup_docker('image','rm',*sorted(image_ids)) + remaining = inventory(projects) + if any(remaining.values()): + raise RuntimeError('Cleanup incomplete') + plan['remaining'] = remaining + plan['application_images_remaining'] = [name for name in sorted(names) if cleanup_docker('image','ls','-q',name)] + if plan['application_images_remaining']: + raise RuntimeError('Application images remain') + plan['result'] = 'PASS' + return plan + + +def verify(): + """Один последовательный прогон на одном стенде с обязательной очисткой.""" + from datetime import datetime, timezone + import re + import sys + import time + + project_name = os.getenv('TEST_PROJECT', 'messenger-test') + os.environ.update(COMPOSE_PROJECT_NAME=project_name, + COMPOSE_FILE='compose.yaml:compose.test.yaml', + GRAFANA_HOST_PORT='23000', LB_HOST_PORT='28080', + DOCKER_TESTS='1') + report = {'date_utc': datetime.now(timezone.utc).isoformat(), 'checks': [], + 'profile': {'single_stack': True, 'load_duration_seconds': 10, + 'load_requests_per_second': 10, 'load_concurrency': 2}} + destination = ROOT / 'evidence/verification.json' + destination.parent.mkdir(exist_ok=True) + + def run(name, command, timeout=600): + print('RUN: ' + name, flush=True) + started = time.monotonic() + result = subprocess.run(command, cwd=ROOT, text=True, capture_output=True, timeout=timeout) + executable = Path(command[0]) + display_command = [str(executable.relative_to(ROOT)) if executable.is_relative_to(ROOT) + else command[0], *command[1:]] + entry = {'name': name, 'command': display_command, 'exit_code': result.returncode, + 'duration_seconds': round(time.monotonic()-started, 3), + 'result': 'PASS' if result.returncode == 0 else 'FAIL'} + if name == 'regression': + summary = re.search(r'\d+ passed[^\n]*', result.stdout) + if summary: + entry['summary'] = summary.group(0) + if result.returncode: + # Полные диагностические логи локальны; в evidence нет путей/credentials. + (ROOT / '.verification-error.log').write_text(result.stdout + result.stderr) + entry['diagnostics'] = '.verification-error.log (local, not committed)' + report['checks'].append(entry) + print(entry['result'] + ': ' + name, flush=True) + if result.returncode: + raise RuntimeError(name + ' failed; inspect local diagnostic log') + + try: + run('contract', [sys.executable, 'scripts/check_contract.py']) + run('openapi', [sys.executable, 'scripts/validate_openapi.py']) + run('compose', ['docker', 'compose', '--env-file', '.env', 'config', '--quiet']) + run('startup', ['make', '--no-print-directory', 'test-stand-up'], timeout=600) + run('regression', ['make', '--no-print-directory', 'test-unit']) + run('api', [sys.executable, 'tests/smoke.py', '--base-url', 'http://localhost:28080']) + run('observability', [sys.executable, '-m', 'scripts.check_observability', + '--base-url', 'http://localhost:28080', + '--grafana-url', 'http://localhost:23000', + '--incidents', '--restart-telemetry']) + run('persistence', [sys.executable, 'tests/resilience.py', '--mode', 'persistence', + '--action-script', 'scripts/restart.sh', '--base-url', 'http://localhost:28080']) + run('failover', [sys.executable, 'tests/resilience.py', '--mode', 'failover', + '--action-script', 'scripts/stop-one.sh', '--base-url', 'http://localhost:28080']) + report['result'] = 'PASS' + except BaseException: + report['result'] = 'FAIL' + raise + finally: + try: + print('RUN: cleanup', flush=True) + report['cleanup'] = clean_stands(apply=True) + print('PASS: cleanup', flush=True) + finally: + report['finished_at_utc'] = datetime.now(timezone.utc).isoformat() + destination.write_text(json.dumps(report, ensure_ascii=False, indent=2)+'\n') + + +def main(): + import argparse + parser = argparse.ArgumentParser(description='Проверка и очистка Compose-стендов') + parser.add_argument('command', choices=['verify', 'clean']) + parser.add_argument('--apply', action='store_true', help='Подтвердить удаление ресурсов') + args = parser.parse_args() + if args.command == 'verify': + verify() + else: + print(json.dumps(clean_stands(apply=args.apply), indent=2)) + + +if __name__ == '__main__': + main() diff --git a/scripts/init_local.py b/scripts/init_local.py index 7477cd0..3738367 100644 --- a/scripts/init_local.py +++ b/scripts/init_local.py @@ -15,6 +15,7 @@ def main() -> None: directory = root / "secrets" directory.mkdir(mode=0o700, exist_ok=True) for name in ( + "grafana_admin_password", "db_password", "redis_password", "broker_password", diff --git a/scripts/restart.sh b/scripts/restart.sh index 493ee34..e11918d 100755 --- a/scripts/restart.sh +++ b/scripts/restart.sh @@ -24,14 +24,19 @@ wait_healthy() { worker_running=$(compose ps --status running --quiet worker) compose stop worker publisher cleanup -compose restart postgres redis minio broker +compose restart postgres redis minio broker prometheus loki tempo grafana otel-collector wait_healthy postgres redis minio broker -compose restart api -wait_healthy api -compose restart nginx -wait_healthy nginx -compose start publisher cleanup +compose restart api nginx +wait_healthy api nginx +# Compose start также запускает завершённые migrate/bootstrap dependencies. +# Здесь нужны только ранее созданные фоновые контейнеры, без повторного bootstrap. +background_ids=$(compose ps --all --quiet publisher cleanup) +docker start $background_ids # Сценарий с заранее остановленным worker сохраняет его остановленным. if [ -n "$worker_running" ]; then - compose start worker + worker_ids=$(compose ps --all --quiet worker) + docker start $worker_ids fi +# Пока восстанавливался бизнес-путь, telemetry backend тоже успели запуститься. +# Grafana healthcheck проверяет также готовность Loki, Tempo и Collector. +wait_healthy prometheus grafana diff --git a/student-tests/test_errors.py b/student-tests/test_errors.py index 3fe5e93..e298d77 100644 --- a/student-tests/test_errors.py +++ b/student-tests/test_errors.py @@ -65,7 +65,8 @@ async def test_unhandled_exception_is_hidden_from_client( assert "test-secret" not in json.dumps(payload, ensure_ascii=False) assert "Traceback" not in json.dumps(payload, ensure_ascii=False) assert "Unhandled error request_id=" in caplog.text - assert "test-secret" in caplog.text + assert "test-secret" not in caplog.text + assert "RuntimeError" in caplog.text assert_request_id(response) diff --git a/student-tests/test_telemetry.py b/student-tests/test_telemetry.py new file mode 100644 index 0000000..2610c59 --- /dev/null +++ b/student-tests/test_telemetry.py @@ -0,0 +1,126 @@ +"""Проверки приватности и исходов на реальных SDK exporters в памяти.""" + +import json + +from fastapi import FastAPI +import httpx +from opentelemetry.sdk._logs.export import InMemoryLogRecordExporter +from opentelemetry.sdk.metrics.export import InMemoryMetricReader +from opentelemetry.sdk.trace.export.in_memory_span_exporter import InMemorySpanExporter +from opentelemetry.trace import SpanKind +import pytest + +from app.core import telemetry as module + + +@pytest.fixture(autouse=True) +async def clean_db(): + # Этот набор не использует БД, Redis и фикстуры приложения. + yield + + +@pytest.fixture +def telemetry(monkeypatch): + spans = InMemorySpanExporter() + logs = InMemoryLogRecordExporter() + metrics = InMemoryMetricReader() + monkeypatch.setattr(module, "OTLPSpanExporter", lambda **_: spans) + monkeypatch.setattr(module, "OTLPLogExporter", lambda **_: logs) + monkeypatch.setattr(module, "PeriodicExportingMetricReader", lambda *_, **__: metrics) + runtime = module.Telemetry("messenger-api", "unit", enabled=True) + yield runtime, spans, logs, metrics + runtime.shutdown() + + +async def test_http_template_correlation_and_private_data(telemetry): + runtime, spans, logs, metrics = telemetry + app = FastAPI() + + @app.post("/items/{item_id}") + async def item(item_id: str): + return {"ok": True} + + app.add_middleware(module.HttpTelemetryMiddleware, telemetry=runtime) + async with httpx.AsyncClient(transport=httpx.ASGITransport(app), base_url="http://test") as client: + # ASGI caller может иметь свой активный span, не относящийся к входящему HTTP. + with runtime.tracer.start_as_current_span("unrelated-task"): + response = await client.post("/items/private-id?token=private-query", json={"text":"private-body"}, headers={"Authorization":"Bearer private-token"}) + await client.get("/arbitrary-private-path") + runtime.traces.force_flush() + runtime.logs.force_flush() + finished = spans.get_finished_spans() + assert finished[0].kind == SpanKind.SERVER + assert finished[0].name == "POST /items/{item_id}" + assert finished[1].attributes["http.route"] == "unmatched" + assert finished[0].context.trace_id != finished[1].context.trace_id + assert all(span.parent is None for span in finished[:2]) + body = json.loads(logs.get_finished_logs()[0].log_record.body) + assert body["trace_id"] == response.headers["X-Trace-Id"] + assert int(body["span_id"], 16) == finished[0].context.span_id + data = metrics.get_metrics_data() + all_attributes = [dict(point.attributes) for resource in data.resource_metrics for scope in resource.scope_metrics for metric in scope.metrics for point in metric.data.data_points] + assert {"http.request.method":"POST", "http.route":"/items/{item_id}", "http.response.status_class":"2xx"} in all_attributes + exported = repr([(s.name, dict(s.attributes)) for s in finished]) + repr(all_attributes) + repr([str(log.log_record.body) for log in logs.get_finished_logs()]) + for private in ("private-id", "private-query", "private-body", "private-token", "arbitrary-private-path"): + assert private not in exported + + +async def test_unhandled_error_preserves_correlation_without_exception_payload(telemetry): + from app.core.request_id import RequestIdMiddleware + from app.errors.handlers import register_exception_handlers + runtime, spans, logs, _ = telemetry + app = FastAPI() + + @app.get("/explode") + async def explode(): + raise RuntimeError("private-error-with-credentials") + + app.add_middleware(RequestIdMiddleware) + app.add_middleware(module.HttpTelemetryMiddleware, telemetry=runtime) + register_exception_handlers(app) + async with httpx.AsyncClient(transport=httpx.ASGITransport(app, raise_app_exceptions=False), base_url="http://test") as client: + response = await client.get("/explode") + runtime.traces.force_flush() + runtime.logs.force_flush() + record = json.loads(logs.get_finished_logs()[0].log_record.body) + assert response.status_code == record["status_code"] == 500 + assert response.headers["X-Request-Id"] == record["request_id"] + assert spans.get_finished_spans()[0].status.status_code.name == "ERROR" + assert "private-error-with-credentials" not in repr(record) + + +def test_job_success_and_error_record_real_outcomes(telemetry): + runtime, spans, logs, metrics = telemetry + for fail in (False, True): + try: + with runtime.tracer.start_as_current_span("attachment.process.v1", kind=SpanKind.CONSUMER, record_exception=False, set_status_on_exception=False): + with runtime.job_attempt(): + if fail: + raise RuntimeError("private-exception-payload") + except RuntimeError: + pass + runtime.traces.force_flush() + runtime.logs.force_flush() + finished = spans.get_finished_spans() + assert [s.attributes["outcome"] for s in finished] == ["success", "error"] + assert finished[1].status.status_code.name == "ERROR" + assert not finished[1].events + records = [json.loads(item.log_record.body) for item in logs.get_finished_logs()] + assert [record["outcome"] for record in records] == ["success", "error"] + assert "private-exception-payload" not in repr(records) + data = metrics.get_metrics_data() + counters = [point for resource in data.resource_metrics for scope in resource.scope_metrics for metric in scope.metrics if metric.name == "messenger.job.attempts" for point in metric.data.data_points] + assert {p.attributes["outcome"]:p.value for p in counters} == {"success":1,"error":1} + + +def test_disabled_telemetry_has_no_exporters(): + runtime = module.Telemetry("messenger-api", enabled=False) + runtime.event("ignored") + runtime.shutdown() + assert not hasattr(runtime, "metrics") + + +def test_tempo_base64_and_hex_identifiers_match(): + from scripts.check_observability import identifier_hex + assert identifier_hex("3X/51BqmrXA=", 8) == "dd7ff9d41aa6ad70" + assert identifier_hex("dd7ff9d41aa6ad70", 8) == "dd7ff9d41aa6ad70" -- 2.54.0 From 27a3a6895f9ac4ac9d10e6a94f20a6414211338c Mon Sep 17 00:00:00 2001 From: gytall Date: Thu, 19 Nov 2026 19:09:19 +0300 Subject: [PATCH 3/4] created tasks for grade 4 --- .gitignore | 2 +- Makefile | 11 +- REPORT.md | 197 +++-- app/core/database.py | 25 + app/core/job_worker.py | 13 +- app/core/outbox_publisher.py | 17 +- app/core/telemetry.py | 39 +- app/domain/attachment_jobs.py | 88 +- app/main.py | 1 + app/models/job.py | 3 +- app/storage/broker.py | 4 + app/storage/jobs.py | 15 +- compose.local.yml | 45 + compose.yaml | 1 + evidence/observability.json | 810 ++++++++++++++---- evidence/verification.json | 360 +------- infra/otel/README.md | 8 +- infra/otel/alerts.yaml | 18 + infra/otel/collector.yaml | 8 + infra/otel/grafana/dashboards/messenger.json | 274 ++++++ infra/otel/prometheus.yaml | 4 + .../b55d0c6819ab_job_trace_context.py | 17 + scripts/check_jobs.py | 4 +- scripts/check_observability.py | 160 +++- scripts/deployment.py | 19 +- 25 files changed, 1492 insertions(+), 651 deletions(-) create mode 100644 compose.local.yml create mode 100644 infra/otel/alerts.yaml create mode 100644 migrations/versions/b55d0c6819ab_job_trace_context.py diff --git a/.gitignore b/.gitignore index acbb212..24b6c97 100644 --- a/.gitignore +++ b/.gitignore @@ -32,7 +32,7 @@ coverage/ # Inspect git diff --cached: ignore rules are not a secret scanner. # Перенесённые исключения lab5 -venv/ +.venv/ .pytest_cache/ .ruff_cache/ /docs/ diff --git a/Makefile b/Makefile index b861b8a..dba3628 100644 --- a/Makefile +++ b/Makefile @@ -8,6 +8,7 @@ SERVICE ?= ACTION_SCRIPT ?= TLS_ARGS = $(if $(CA_FILE),--ca-file "$(CA_FILE)",) COMPOSE = docker compose --env-file .env +LOCAL_COMPOSE = $(COMPOSE) -f compose.yaml -f compose.local.yml TEST_PROJECT ?= messenger-test TEST_LB_PORT ?= 28080 @@ -27,13 +28,14 @@ TEST_REDIS_PASSWORD ?= $(if $(wildcard secrets/redis_password),$(file 5% 5xx за 30 с с выдержкой 5 с. +`MessengerQueueLag` срабатывает, если очередь непуста и возраст старейшего +задания >15 с с выдержкой 5 с. Состояние доступно в Prometheus через +`ALERTS{alertstate="firing"}`. Внешняя доставка отключена. + +## Диагностика инцидентов + +1. **Рост 5xx.** В Grafana сопоставить частоту запросов, долю 5xx и задержку. + По X-Request-Id найти связанный лог и открыть TraceID. Ошибка на + `postgres.checkout` вместе с событием `dependency.unavailable` + указывает на проблему получения соединения с БД. После восстановления + проверить `/health/ready` и исчезновение firing. +2. **Растёт очередь.** Сверить глубину, возраст и занятость worker. При + остановленном worker задания принимаются, а новые попытки не появляются. + После восстановления проверить уменьшение очереди и исчезновение firing. + В Tempo открыть трассу upload и сравнить исходы отдельных попыток, затем + проверить spans S3/БД и состояние ready. +3. **Недоступен Loki.** Prometheus продолжает собирать бизнес-метрики и + внутренние метрики Collector. Сравнить число успешных сообщений, RSS, + размер экспортной очереди и прирост счётчиков отказа экспорта/постановки + в очередь. После старта Loki проверить появление новых связанных логов. + +Collector использует memory limiter 192 MiB со spike 32 MiB, пакетирование до +256 записей, очередь 256 пакетов на экспортёр, по два потребителя +на очередь и до 30 с повторов доставки. Контейнер ограничен 256 MiB. SDK +имеет ограниченные очереди span/log и таймауты. Потери считаются по +счётчикам Collector для остановленного Loki. Общие потери вне Collector +этими счётчиками не измеряются. + +## Полный прогон + +`make verify` поднимает один отдельный стенд с телеметрией, выполняет регрессию, +smoke, нагрузку, проверку сквозных трасс, оповещений и восстановления после +отказов, а также persistence/failover. В конце удаляются контейнеры, сеть и +тома только проверочного проекта. Настройки, общий кэш образов и данные +основного стенда сохраняются. + +Результаты прогона от 19.11.2026 сохранены в [журнале проверок](evidence/verification.json) +и [доказательствах наблюдаемости](evidence/observability.json). +Итог **PASS**, с 18:50 до 19:03 МСК. Контракт, OpenAPI, конфигурация и запуск +Compose, публичный smoke, наблюдаемость, persistence и failover прошли. +Регрессия: 206 тестов за 98,89 с. Инвентаризация после очистки показала +0 контейнеров, 0 сетей и 0 томов проверочного проекта. + +Нагрузка: 100 успешных сообщений, 0 ошибок, 10,078 запроса/с. Клиентские +p50/p95/p99 — 18,036 / 39,623 / 45,954 мс. Проверены все запросы панелей, +корреляция логов и трасс, отсутствие запрещённых полей и сохранение истории +после перезапуска хранилищ. В выборке приватности 413 логов. + +| Сценарий | Что зафиксировал прогон | +| --- | --- | +| PostgreSQL остановлен | HTTP 503, связанный ERROR span `postgres.checkout` и `dependency.unavailable` с `TimeoutError`. Firing замечен через 32,4 с от начала сценария, снятие — через 67,5 с. Trace ID `020e820d68045ad3195e842244670b11`. | +| Worker остановлен | Глубина 1, возраст 25,6 с на момент проверки. Firing замечен через 28,6 с после приёма задания. После исчерпания пяти инъецированных временных ошибок оператор выполнил replay, шестая попытка завершилась `ready`, глубина вернулась к 0, оповещение снялось. | +| Loki остановлен | 204 сообщения записаны при недоступных логах. За 51 с измерено 6 записей, потерянных после повторов экспорта, и 0 отказов постановки в очередь. Пик очереди 48 из 256 пакетов, RSS 228–231 MiB при лимите 256 MiB. После запуска Loki найден новый лог со связанной трассой. | + +Трасса повтора в Tempo — `ff8352e27270fbc16fea7216c3ff45c0`. В ней проверены +родительские связи HTTP upload → `rabbitmq.publish` → `attachment.process.v1` +для всех попыток и spans `s3.read_staging`, `s3.write_result`, +`postgres.commit_ready` успешной попытки. Контрольная трасса без инъекции — +`ad41b35e5e8b02c32f7a7b74d7b6278a`. После очистки их идентификаторы и дерево +spans остаются в JSON с доказательствами. ## Ограничения -Один Docker-host, без HA и защиты от потери диска. HTTP и анонимный Grafana Viewer — -только для локального стенда; Tempo использует root для записи в volume. -Сейчас API/worker traces независимы, alerts и сквозная связь ещё не реализованы. -SDK и Collector имеют ограниченные очереди, но длительный отказ backend пока не измерялся. -По наблюдению автора, долгий запуск контейнеров нагревает CPU примерно до 80 °C и выше: -проверки выполняются последовательно на одном стенде с немедленной очисткой. +Один Docker-host без высокой доступности и защиты от потери диска. +Контролируемая нагрузка проверяет сценарии и пригодность диагностики. +Долговременное соблюдение SLO требует наблюдения за полным 24-часовым окном. +В сценарии Loki измерен краткий отказ. Замеры RSS показывают небольшой рост, +а верхняя граница памяти обеспечивается настройками очередей и лимитом контейнера. diff --git a/app/core/database.py b/app/core/database.py index c7a6538..10b2bf0 100644 --- a/app/core/database.py +++ b/app/core/database.py @@ -1,3 +1,6 @@ +from contextlib import nullcontext + +from sqlalchemy.pool import AsyncAdaptedQueuePool from sqlalchemy.ext.asyncio import ( AsyncEngine, AsyncSession, @@ -8,9 +11,31 @@ from sqlalchemy.ext.asyncio import ( from app.core.config import Settings +class ObservedPool(AsyncAdaptedQueuePool): + telemetry = None + waiting = 0 + + def __init__(self, *args, pool_size, max_overflow, **kwargs): + self.capacity = pool_size + max_overflow if pool_size and max_overflow >= 0 else None + super().__init__(*args, pool_size=pool_size, max_overflow=max_overflow, **kwargs) + + def _do_get(self): + waiting = self.capacity is not None and self.checkedout() >= self.capacity + self.waiting += int(waiting) + try: + return super()._do_get() + finally: + self.waiting -= int(waiting) + + def connect(self): + with self.telemetry.span("postgres.checkout") if self.telemetry else nullcontext(): + return super().connect() + + def create_db_engine(settings: Settings) -> AsyncEngine: return create_async_engine( settings.get_database_url(), + poolclass=ObservedPool, pool_size=settings.db_pool_size, max_overflow=settings.db_max_overflow, pool_timeout=settings.db_pool_timeout_seconds, diff --git a/app/core/job_worker.py b/app/core/job_worker.py index d524c09..6574b50 100644 --- a/app/core/job_worker.py +++ b/app/core/job_worker.py @@ -12,6 +12,7 @@ from uuid import UUID, uuid4 from PIL import features from opentelemetry.context import Context from opentelemetry.trace import SpanKind +from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator from pydantic import ValidationError from app.core.background import ( @@ -86,10 +87,11 @@ async def consume_connected( continue try: telemetry = telemetry or Telemetry("messenger-worker", enabled=False) - with telemetry.tracer.start_as_current_span( - "attachment.process.v1", context=Context(), kind=SpanKind.CONSUMER, - record_exception=False, set_status_on_exception=False, - attributes={"messaging.system": "rabbitmq", "job.type": message.type}, + parent = TraceContextTextMapPropagator().extract(delivery.id.headers or {}, context=Context()) + with telemetry.span( + "attachment.process.v1", context=parent, kind=SpanKind.CONSUMER, + attributes={"messaging.system": "rabbitmq", "job.type": message.type, + "job.attempt": message.attempt}, ): telemetry.event("job.received", job_id=str(message.job_id), attachment_id=str(message.attachment_id)) @@ -132,6 +134,9 @@ async def run_worker(faults: Faults) -> None: raise RuntimeError("WebP codec is unavailable") stop = shutdown_event() engine = create_db_engine(settings) + telemetry.observe_pool(engine.pool) + telemetry.gauge("messenger.worker.busy", lambda: telemetry.busy) + telemetry.gauge("messenger.worker.capacity", lambda: jobs.worker_concurrency) storage = None try: storage = create_s3_storage(settings.s3) diff --git a/app/core/outbox_publisher.py b/app/core/outbox_publisher.py index 54ef3a2..993d206 100644 --- a/app/core/outbox_publisher.py +++ b/app/core/outbox_publisher.py @@ -6,6 +6,7 @@ import json import logging import os import signal +import time from uuid import UUID from app.core.background import ( @@ -19,6 +20,8 @@ from app.core.database import create_db_engine, create_session_factory from app.core.jobs import JobSettings from app.domain.attachment_jobs import publish_next_job, recover_expired_jobs from app.storage.broker import JobBroker +from app.storage.jobs import queued_backlog +from app.core.telemetry import Telemetry def crash_before_publish(attachment_id: UUID) -> None: @@ -36,6 +39,13 @@ async def run_publisher(crash_attachment_id: UUID | None = None) -> None: logging.basicConfig(level=settings.log_level) stop = shutdown_event() engine = create_db_engine(settings) + telemetry = Telemetry("messenger-publisher") + telemetry.observe_pool(engine.pool) + backlog = (0, 0.0) + labels = {"queue.name": jobs.broker_queue} + telemetry.gauge("messenger.queue.depth", lambda: backlog[0], attributes=labels) + telemetry.gauge("messenger.queue.oldest", lambda: backlog[1], unit="s", attributes=labels) + next_sample = 0.0 broker = None try: broker = JobBroker(jobs) @@ -43,12 +53,16 @@ async def run_publisher(crash_attachment_id: UUID | None = None) -> None: while not stop.is_set(): published = False try: - await broker.ensure_ready() async with factory() as session: + if telemetry.enabled and time.monotonic() >= next_sample: + backlog = await queued_backlog(session) + next_sample = time.monotonic() + 2 + await broker.ensure_ready() await recover_expired_jobs(session, jobs) published = await publish_next_job( session, broker, + telemetry=telemetry, attachment_id=crash_attachment_id, before_publish=( crash_before_publish @@ -64,6 +78,7 @@ async def run_publisher(crash_attachment_id: UUID | None = None) -> None: if broker is not None: await broker.aclose() await engine.dispose() + await asyncio.to_thread(telemetry.shutdown) def main() -> None: diff --git a/app/core/telemetry.py b/app/core/telemetry.py index c234143..1b61f80 100644 --- a/app/core/telemetry.py +++ b/app/core/telemetry.py @@ -4,6 +4,7 @@ from contextlib import contextmanager from datetime import datetime, timezone import json import os +from pathlib import Path import socket import time @@ -15,6 +16,7 @@ from opentelemetry.exporter.otlp.proto.http.metric_exporter import OTLPMetricExp from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter from opentelemetry.sdk._logs import LoggerProvider from opentelemetry.sdk._logs.export import BatchLogRecordProcessor +from opentelemetry.metrics import Observation from opentelemetry.sdk.metrics import MeterProvider from opentelemetry.sdk.metrics.export import PeriodicExportingMetricReader from opentelemetry.sdk.metrics.view import ExplicitBucketHistogramAggregation, View @@ -32,6 +34,7 @@ class Telemetry: self.enabled = (os.getenv("OTEL_ENABLED", "false").lower() == "true" if enabled is None else enabled) self.service = service + self.busy = 0 if not self.enabled: self.tracer = trace.NoOpTracerProvider().get_tracer("messenger") return @@ -61,14 +64,42 @@ class Telemetry: ) ], views=[ View(instrument_name="messenger.http.duration", aggregation=ExplicitBucketHistogramAggregation(HTTP_BUCKETS)), + View(instrument_name="messenger.job.time_to_ready", aggregation=ExplicitBucketHistogramAggregation(JOB_BUCKETS)), View(instrument_name="messenger.job.duration", aggregation=ExplicitBucketHistogramAggregation(JOB_BUCKETS)), ]) - meter = self.metrics.get_meter("messenger", "1.6.0") + meter = self.meter = self.metrics.get_meter("messenger", "1.6.0") self.http_requests = meter.create_counter("messenger.http.requests", unit="1") self.http_duration = meter.create_histogram("messenger.http.duration", unit="s") self.jobs = meter.create_counter("messenger.job.attempts", unit="1") self.job_duration = meter.create_histogram("messenger.job.duration", unit="s") + self.time_to_ready = meter.create_histogram("messenger.job.time_to_ready", unit="s") + self.gauge("messenger.process.cpu", time.process_time, unit="s", counter=True) + self.gauge("messenger.process.rss", resident_bytes, unit="By") + + def gauge(self, name, sample, *, unit="1", attributes=None, counter=False): + if self.enabled: + create = (self.meter.create_observable_counter if counter + else self.meter.create_observable_gauge) + create(name, callbacks=[lambda _: [Observation(sample(), attributes)]], unit=unit) + + def observe_pool(self, pool): + if self.enabled: + pool.telemetry = self + self.gauge("messenger.db.pool.used", pool.checkedout) + self.gauge("messenger.db.pool.waiting", lambda: pool.waiting) + + @contextmanager + def span(self, name, **kwargs): + with self.tracer.start_as_current_span( + name, record_exception=False, set_status_on_exception=False, **kwargs, + ) as span: + try: + yield span + except BaseException: + span.set_status(Status(StatusCode.ERROR)) + raise + def event(self, event: str, *, error=False, **fields): if not self.enabled: return @@ -89,6 +120,7 @@ class Telemetry: @contextmanager def job_attempt(self): + self.busy += 1 started = time.monotonic() result = {"outcome": "success"} try: @@ -97,6 +129,7 @@ class Telemetry: result["outcome"] = "error" raise finally: + self.busy -= 1 if self.enabled: attrs = {"job.type": "attachment.process.v1", "outcome": result["outcome"]} elapsed = time.monotonic() - started @@ -115,6 +148,10 @@ class Telemetry: self.traces.shutdown() +def resident_bytes(): + return int(Path("/proc/self/statm").read_text().split()[1]) * os.sysconf("SC_PAGE_SIZE") + + class HttpTelemetryMiddleware: def __init__(self, app, telemetry: Telemetry): self.app = app diff --git a/app/domain/attachment_jobs.py b/app/domain/attachment_jobs.py index f1013db..4b53fcd 100644 --- a/app/domain/attachment_jobs.py +++ b/app/domain/attachment_jobs.py @@ -9,6 +9,9 @@ from tempfile import TemporaryDirectory from uuid import UUID, uuid4 from minio.error import MinioException +from opentelemetry.context import Context +from opentelemetry.trace import SpanKind +from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator from sqlalchemy.ext.asyncio import AsyncSession from urllib3.exceptions import HTTPError as StorageHTTPError @@ -44,6 +47,7 @@ async def publish_next_job( *, attachment_id: UUID | None = None, before_publish: Callable[[UUID], None] | None = None, + telemetry: Telemetry | None = None, ) -> bool: """Отметка publish следует за durable publisher confirm; crash допускает тот же job-дубль.""" job = await outbox.next_unpublished_job(session, attachment_id=attachment_id) @@ -51,15 +55,20 @@ async def publish_next_job( if job is not None: if before_publish is not None: before_publish(job.attachment_id) - await broker.publish_job( - JobMessage( - job_id=job.id, - attachment_id=job.attachment_id, - pipeline_version=job.pipeline_version, - attempt=job.attempt + 1, - created_at=job.created_at, + parent = TraceContextTextMapPropagator().extract(job.trace_context or {}, context=Context()) + with telemetry.span( + "rabbitmq.publish", context=parent, kind=SpanKind.PRODUCER, + attributes={"messaging.system": "rabbitmq", "job.attempt": job.attempt + 1}, + ) if telemetry else nullcontext(): + await broker.publish_job( + JobMessage( + job_id=job.id, + attachment_id=job.attachment_id, + pipeline_version=job.pipeline_version, + attempt=job.attempt + 1, + created_at=job.created_at, + ) ) - ) outbox.mark_published(job) await session.commit() return published @@ -145,11 +154,13 @@ async def build_result( storage: MinioStorage, work: JobWork, after_object: Callable[[UUID, str], None] | None = None, + telemetry: Telemetry | None = None, ) -> bool: """Фиксированные ключи и блокировка job защищают PUT от устаревшей попытки.""" with TemporaryDirectory(prefix="messenger-job-") as directory: source = Path(directory) / "original" - await fetch_original(storage, work, source) + with telemetry.span("s3.read_staging") if telemetry else nullcontext(): + await fetch_original(storage, work, source) result = await render_variants(storage, work, source, Path(directory)) row = await jobs.lock_job(session, work.job_id) if row is None: @@ -165,33 +176,39 @@ async def build_result( return False # Блокировка остаётся до завершения PUT/COMMIT; reaper использует SKIP LOCKED. # При отмене S3 adapter дожидается SDK-потока до освобождения блокировки. - await storage.put_file( - work.original_key, - source, - size_bytes=work.size_bytes, - content_type=work.content_type, - sha256=work.sha256, - ) - if after_object is not None: - after_object(work.attachment_id, "original") - for variant in result.variants: + with telemetry.span("s3.write_result") if telemetry else nullcontext(): await storage.put_file( - work.variant_key(variant.name), - Path(directory) / VARIANT_FILENAMES[variant.name], - size_bytes=variant.size_bytes, - content_type=variant.content_type, - sha256=variant.sha256, + work.original_key, + source, + size_bytes=work.size_bytes, + content_type=work.content_type, + sha256=work.sha256, ) if after_object is not None: - after_object(work.attachment_id, variant.name) - jobs.complete_job( - job, - attachment, - work, - [variant.model_dump() for variant in result.variants], - await jobs.database_time(session), - ) - await session.commit() + after_object(work.attachment_id, "original") + for variant in result.variants: + await storage.put_file( + work.variant_key(variant.name), + Path(directory) / VARIANT_FILENAMES[variant.name], + size_bytes=variant.size_bytes, + content_type=variant.content_type, + sha256=variant.sha256, + ) + if after_object is not None: + after_object(work.attachment_id, variant.name) + with telemetry.span("postgres.commit_ready") if telemetry else nullcontext(): + ready_at = await jobs.database_time(session) + accepted_at = job.created_at + jobs.complete_job( + job, + attachment, + work, + [variant.model_dump() for variant in result.variants], + ready_at, + ) + await session.commit() + if telemetry and telemetry.enabled: + telemetry.time_to_ready.record(max(0, (ready_at - accepted_at).total_seconds())) return True @@ -205,7 +222,8 @@ async def process_attachment_job( before_processing: Callable[[UUID], None] | None = None, telemetry: Telemetry | None = None, ) -> bool: - claim = await claim_job(session, message, settings) + with telemetry.span("postgres.claim_job") if telemetry else nullcontext(): + claim = await claim_job(session, message, settings) acknowledge = claim.acknowledge if claim.work is not None: work = claim.work @@ -214,7 +232,7 @@ async def process_attachment_job( async with asyncio.timeout(settings.job_timeout_seconds): if before_processing is not None: before_processing(work.attachment_id) - acknowledge = await build_result(session, storage, work, after_object) + acknowledge = await build_result(session, storage, work, after_object, telemetry) result["outcome"] = "success" if acknowledge else "deferred" except ( ProcessingError, diff --git a/app/main.py b/app/main.py index f4bb612..4882359 100644 --- a/app/main.py +++ b/app/main.py @@ -61,6 +61,7 @@ def create_app(settings: Settings | None = None) -> FastAPI: application.state.request_capacity = create_request_capacity(settings.max_in_flight) application.state.instance_id = resolve_instance_id(settings.instance_id) telemetry = Telemetry("messenger-api", application.state.instance_id) + telemetry.observe_pool(engine.pool) application.state.telemetry = telemetry application.state.lifecycle = Lifecycle() application.add_middleware(RequestIdMiddleware) diff --git a/app/models/job.py b/app/models/job.py index 01924ee..b7723d0 100644 --- a/app/models/job.py +++ b/app/models/job.py @@ -3,7 +3,7 @@ from datetime import datetime from uuid import UUID, uuid4 -from sqlalchemy import CheckConstraint, ForeignKey, Index, String, func +from sqlalchemy import JSON, CheckConstraint, ForeignKey, Index, String, func from sqlalchemy.orm import Mapped, mapped_column from app.models.base import Base @@ -23,6 +23,7 @@ class AttachmentJob(Base): ForeignKey("attachments.id"), unique=True, ) + trace_context: Mapped[dict | None] = mapped_column(JSON, nullable=True) staging_key: Mapped[str | None] = mapped_column(String(128)) pipeline_version: Mapped[int] = mapped_column(server_default="1") attempt: Mapped[int] = mapped_column(server_default="0") diff --git a/app/storage/broker.py b/app/storage/broker.py index 1932ffd..2f5d2e4 100644 --- a/app/storage/broker.py +++ b/app/storage/broker.py @@ -6,6 +6,7 @@ from dataclasses import dataclass import aio_pika from aio_pika.abc import AbstractIncomingMessage +from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator from app.core.jobs import JobSettings from app.schemas.job import JobMessage @@ -54,10 +55,13 @@ class JobBroker: async def publish_job(self, message: JobMessage) -> None: await self.ensure_ready() + headers = {} + TraceContextTextMapPropagator().inject(headers) await self.channel.default_exchange.publish( aio_pika.Message( body=message.model_dump_json(exclude_none=True).encode(), content_type="application/json", + headers=headers, delivery_mode=aio_pika.DeliveryMode.PERSISTENT, message_id=f"{message.job_id}:{message.attempt}", ), diff --git a/app/storage/jobs.py b/app/storage/jobs.py index e0ca118..ace4ba9 100644 --- a/app/storage/jobs.py +++ b/app/storage/jobs.py @@ -4,6 +4,7 @@ from dataclasses import dataclass from datetime import datetime, timedelta from uuid import UUID +from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator from sqlalchemy import and_, or_, func, select from sqlalchemy.ext.asyncio import AsyncSession @@ -35,7 +36,10 @@ class JobWork: async def create_job( session: AsyncSession, attachment_id: UUID, staging_key: str ) -> UUID: - job = AttachmentJob(attachment_id=attachment_id, staging_key=staging_key) + carrier = {} + TraceContextTextMapPropagator().inject(carrier) + job = AttachmentJob(attachment_id=attachment_id, staging_key=staging_key, + trace_context=carrier or None) session.add(job) await session.flush() return job.id @@ -56,6 +60,15 @@ async def database_time(session: AsyncSession) -> datetime: return await session.scalar(select(func.clock_timestamp())) +async def queued_backlog(session: AsyncSession) -> tuple[int, float]: + count, oldest = (await session.execute( + select(func.count(), func.min(AttachmentJob.created_at)) + .join(Attachment, Attachment.id == AttachmentJob.attachment_id) + .where(Attachment.status == "queued") + )).one() + return count, max(0, ((await database_time(session)) - oldest).total_seconds()) if oldest else 0.0 + + async def expired_jobs(session: AsyncSession, limit: int = 20): result = await session.execute( select(AttachmentJob, Attachment) diff --git a/compose.local.yml b/compose.local.yml new file mode 100644 index 0000000..c9176dd --- /dev/null +++ b/compose.local.yml @@ -0,0 +1,45 @@ +# Локальный доступ к сервисам из VS Code и браузера. +# docker compose -f compose.yaml -f compose.local.yml up -d --wait +# Все опубликованные порты доступны только с этого компьютера. +services: + api: + # Docker выделяет каждой реплике отдельный свободный порт диапазона. + ports: + - "127.0.0.1:8081-8090:8080" + postgres: + ports: + - "127.0.0.1:${POSTGRES_LOCAL_PORT:-5432}:5432" + redis: + ports: + - "127.0.0.1:${REDIS_LOCAL_PORT:-6379}:6379" + minio: + command: ["server", "/data", "--console-address", "0.0.0.0:9001"] + environment: + MINIO_BROWSER: "on" + # Добавляем обычную сеть для доступа через опубликованные порты; + # внутренняя objects сохраняется для приложения и bootstrap. + networks: [default, objects] + ports: + - "127.0.0.1:${MINIO_LOCAL_PORT:-9000}:9000" + - "127.0.0.1:${MINIO_CONSOLE_LOCAL_PORT:-9001}:9001" + broker: + volumes: + - ./infra/broker/enabled_plugins.local:/etc/rabbitmq/enabled_plugins:ro + ports: + - "127.0.0.1:${BROKER_LOCAL_PORT:-5672}:5672" + - "127.0.0.1:${BROKER_MANAGEMENT_LOCAL_PORT:-15672}:15672" + prometheus: + ports: + - "127.0.0.1:${PROMETHEUS_LOCAL_PORT:-9090}:9090" + loki: + ports: + - "127.0.0.1:${LOKI_LOCAL_PORT:-3100}:3100" + tempo: + ports: + - "127.0.0.1:${TEMPO_LOCAL_PORT:-3200}:3200" + - "127.0.0.1:${TEMPO_OTLP_LOCAL_PORT:-14318}:4318" + otel-collector: + ports: + - "127.0.0.1:${OTEL_HTTP_LOCAL_PORT:-4318}:4318" + - "127.0.0.1:${OTEL_METRICS_LOCAL_PORT:-8889}:8889" + - "127.0.0.1:${OTEL_HEALTH_LOCAL_PORT:-13133}:13133" diff --git a/compose.yaml b/compose.yaml index 8ddffa1..f980818 100644 --- a/compose.yaml +++ b/compose.yaml @@ -409,6 +409,7 @@ services: restart: unless-stopped volumes: - ./infra/otel/prometheus.yaml:/etc/prometheus/prometheus.yml:ro + - ./infra/otel/alerts.yaml:/etc/prometheus/alerts.yaml:ro - prometheusdata:/prometheus healthcheck: test: ["CMD", "wget", "-q", "-O", "/dev/null", "http://127.0.0.1:9090/-/ready"] diff --git a/evidence/observability.json b/evidence/observability.json index 7ddd5db..1078a1b 100644 --- a/evidence/observability.json +++ b/evidence/observability.json @@ -1,21 +1,21 @@ { - "date_utc": "2026-11-14T01:54:09.593067+00:00", + "date_utc": "2026-11-19T15:56:59.724115+00:00", "project": "messenger-test", "load": { - "date_utc": "2026-11-14T01:54:04.006033+00:00", + "date_utc": "2026-11-19T15:56:52.469419+00:00", "workload": "synthetic POST messages; fixed arrival rate; no retries", "duration_seconds": 10, - "elapsed_seconds": 9.929, + "elapsed_seconds": 9.923, "arrival_rate": 10, "concurrency_limit": 2, "successful_requests": 100, "failed_requests": 0, "error_ratio": 0.0, - "successful_rps": 10.072, + "successful_rps": 10.078, "successful_latency_ms": { - "p50": 31.394, - "p95": 63.623, - "p99": 70.12 + "p50": 18.036, + "p95": 39.623, + "p99": 45.954 }, "dataset": { "users": 3, @@ -24,192 +24,192 @@ }, "resource_samples": [ { - "elapsed_seconds": 2.166, + "elapsed_seconds": 2.058, "containers": [ { "Name": "messenger-test-api-1", - "CPUPerc": "54.62%", - "MemUsage": "90.74MiB / 1.5GiB", - "MemPerc": "5.91%" + "CPUPerc": "40.63%", + "MemUsage": "94.64MiB / 1.5GiB", + "MemPerc": "6.16%" }, { "Name": "messenger-test-api-2", - "CPUPerc": "13.14%", - "MemUsage": "91.79MiB / 1.5GiB", - "MemPerc": "5.98%" + "CPUPerc": "5.96%", + "MemUsage": "87.06MiB / 1.5GiB", + "MemPerc": "5.67%" }, { "Name": "messenger-test-broker-1", - "CPUPerc": "0.16%", - "MemUsage": "112.5MiB / 768MiB", - "MemPerc": "14.64%" + "CPUPerc": "86.17%", + "MemUsage": "148.3MiB / 768MiB", + "MemPerc": "19.31%" }, { "Name": "messenger-test-cleanup-1", "CPUPerc": "0.00%", - "MemUsage": "74.46MiB / 256MiB", + "MemUsage": "74.44MiB / 256MiB", "MemPerc": "29.08%" }, { "Name": "messenger-test-grafana-1", - "CPUPerc": "0.85%", - "MemUsage": "373.6MiB / 512MiB", - "MemPerc": "72.96%" + "CPUPerc": "0.47%", + "MemUsage": "292.7MiB / 512MiB", + "MemPerc": "57.17%" }, { "Name": "messenger-test-loki-1", - "CPUPerc": "0.82%", - "MemUsage": "62.73MiB / 512MiB", - "MemPerc": "12.25%" + "CPUPerc": "0.58%", + "MemUsage": "69.43MiB / 512MiB", + "MemPerc": "13.56%" }, { "Name": "messenger-test-minio-1", - "CPUPerc": "66.11%", - "MemUsage": "155.6MiB / 512MiB", - "MemPerc": "30.39%" + "CPUPerc": "0.08%", + "MemUsage": "131.4MiB / 512MiB", + "MemPerc": "25.67%" }, { "Name": "messenger-test-nginx-1", - "CPUPerc": "0.35%", - "MemUsage": "4.312MiB / 128MiB", - "MemPerc": "3.37%" + "CPUPerc": "0.27%", + "MemUsage": "5.359MiB / 128MiB", + "MemPerc": "4.19%" }, { "Name": "messenger-test-otel-collector-1", - "CPUPerc": "0.86%", - "MemUsage": "55.17MiB / 256MiB", - "MemPerc": "21.55%" + "CPUPerc": "0.30%", + "MemUsage": "62.13MiB / 256MiB", + "MemPerc": "24.27%" }, { "Name": "messenger-test-postgres-1", - "CPUPerc": "20.53%", - "MemUsage": "77.13MiB / 512MiB", - "MemPerc": "15.06%" + "CPUPerc": "1.54%", + "MemUsage": "107.4MiB / 512MiB", + "MemPerc": "20.99%" }, { "Name": "messenger-test-prometheus-1", - "CPUPerc": "0.16%", - "MemUsage": "34.8MiB / 512MiB", - "MemPerc": "6.80%" + "CPUPerc": "0.14%", + "MemUsage": "37.91MiB / 512MiB", + "MemPerc": "7.41%" }, { "Name": "messenger-test-publisher-1", - "CPUPerc": "0.92%", - "MemUsage": "62.27MiB / 256MiB", - "MemPerc": "24.32%" + "CPUPerc": "0.73%", + "MemUsage": "65.48MiB / 256MiB", + "MemPerc": "25.58%" }, { "Name": "messenger-test-redis-1", - "CPUPerc": "0.45%", - "MemUsage": "8.496MiB / 512MiB", - "MemPerc": "1.66%" + "CPUPerc": "3.00%", + "MemUsage": "8.527MiB / 512MiB", + "MemPerc": "1.67%" }, { "Name": "messenger-test-tempo-1", - "CPUPerc": "0.62%", - "MemUsage": "224.5MiB / 512MiB", - "MemPerc": "43.85%" + "CPUPerc": "0.30%", + "MemUsage": "318.4MiB / 512MiB", + "MemPerc": "62.19%" }, { "Name": "messenger-test-worker-1", - "CPUPerc": "0.01%", - "MemUsage": "68.05MiB / 2GiB", - "MemPerc": "3.32%" + "CPUPerc": "0.19%", + "MemUsage": "73.34MiB / 2GiB", + "MemPerc": "3.58%" } ] }, { - "elapsed_seconds": 7.274, + "elapsed_seconds": 7.107, "containers": [ { "Name": "messenger-test-api-1", - "CPUPerc": "11.38%", - "MemUsage": "90.96MiB / 1.5GiB", - "MemPerc": "5.92%" + "CPUPerc": "7.55%", + "MemUsage": "94.69MiB / 1.5GiB", + "MemPerc": "6.16%" }, { "Name": "messenger-test-api-2", - "CPUPerc": "81.50%", - "MemUsage": "98.59MiB / 1.5GiB", - "MemPerc": "6.42%" + "CPUPerc": "39.26%", + "MemUsage": "87.07MiB / 1.5GiB", + "MemPerc": "5.67%" }, { "Name": "messenger-test-broker-1", - "CPUPerc": "0.25%", - "MemUsage": "112.5MiB / 768MiB", - "MemPerc": "14.64%" + "CPUPerc": "15.48%", + "MemUsage": "189.4MiB / 768MiB", + "MemPerc": "24.66%" }, { "Name": "messenger-test-cleanup-1", "CPUPerc": "0.00%", - "MemUsage": "74.46MiB / 256MiB", + "MemUsage": "74.44MiB / 256MiB", "MemPerc": "29.08%" }, { "Name": "messenger-test-grafana-1", - "CPUPerc": "0.91%", - "MemUsage": "373.6MiB / 512MiB", - "MemPerc": "72.96%" + "CPUPerc": "0.55%", + "MemUsage": "292.7MiB / 512MiB", + "MemPerc": "57.17%" }, { "Name": "messenger-test-loki-1", - "CPUPerc": "0.98%", - "MemUsage": "62.27MiB / 512MiB", - "MemPerc": "12.16%" + "CPUPerc": "0.56%", + "MemUsage": "69.18MiB / 512MiB", + "MemPerc": "13.51%" }, { "Name": "messenger-test-minio-1", - "CPUPerc": "0.18%", - "MemUsage": "155.6MiB / 512MiB", - "MemPerc": "30.39%" + "CPUPerc": "3.59%", + "MemUsage": "135.3MiB / 512MiB", + "MemPerc": "26.42%" }, { "Name": "messenger-test-nginx-1", - "CPUPerc": "0.75%", - "MemUsage": "3.852MiB / 128MiB", - "MemPerc": "3.01%" + "CPUPerc": "0.25%", + "MemUsage": "4.82MiB / 128MiB", + "MemPerc": "3.77%" }, { "Name": "messenger-test-otel-collector-1", - "CPUPerc": "1.71%", - "MemUsage": "54.97MiB / 256MiB", - "MemPerc": "21.47%" + "CPUPerc": "0.64%", + "MemUsage": "62.66MiB / 256MiB", + "MemPerc": "24.48%" }, { "Name": "messenger-test-postgres-1", - "CPUPerc": "21.91%", - "MemUsage": "77.45MiB / 512MiB", - "MemPerc": "15.13%" + "CPUPerc": "7.61%", + "MemUsage": "107.5MiB / 512MiB", + "MemPerc": "20.99%" }, { "Name": "messenger-test-prometheus-1", - "CPUPerc": "0.84%", - "MemUsage": "35.03MiB / 512MiB", - "MemPerc": "6.84%" + "CPUPerc": "0.21%", + "MemUsage": "38.25MiB / 512MiB", + "MemPerc": "7.47%" }, { "Name": "messenger-test-publisher-1", - "CPUPerc": "1.10%", - "MemUsage": "62.28MiB / 256MiB", - "MemPerc": "24.33%" + "CPUPerc": "0.65%", + "MemUsage": "65.73MiB / 256MiB", + "MemPerc": "25.68%" }, { "Name": "messenger-test-redis-1", - "CPUPerc": "9.35%", - "MemUsage": "8.848MiB / 512MiB", - "MemPerc": "1.73%" + "CPUPerc": "0.48%", + "MemUsage": "8.773MiB / 512MiB", + "MemPerc": "1.71%" }, { "Name": "messenger-test-tempo-1", - "CPUPerc": "0.63%", - "MemUsage": "224.7MiB / 512MiB", - "MemPerc": "43.89%" + "CPUPerc": "0.28%", + "MemUsage": "320.2MiB / 512MiB", + "MemPerc": "62.53%" }, { "Name": "messenger-test-worker-1", - "CPUPerc": "0.49%", - "MemUsage": "68.05MiB / 2GiB", - "MemPerc": "3.32%" + "CPUPerc": "0.01%", + "MemUsage": "73.34MiB / 2GiB", + "MemPerc": "3.58%" } ] } @@ -219,28 +219,28 @@ "api_replicas": 2, "dashboard_uid": "messenger-overview", "api_correlation": { - "trace_id": "0a0e27eba5d266cf6cdc3eb9bfc7f5ef", - "span_id": "a7638b6d19f2e057", + "trace_id": "b07429169c91eb6e67d211959181ab10", + "span_id": "96318acd3dddff53", "log": { - "timestamp": "2026-11-14T01:54:07.311535+00:00", + "timestamp": "2026-11-19T15:56:54.681885+00:00", "severity": "INFO", "service_name": "messenger-api", "event": "http.request", - "trace_id": "0a0e27eba5d266cf6cdc3eb9bfc7f5ef", - "span_id": "a7638b6d19f2e057", + "trace_id": "b07429169c91eb6e67d211959181ab10", + "span_id": "96318acd3dddff53", "method": "POST", "route": "/api/v1/chats/{chat_id}/messages", "status_code": 201, - "request_id": "e60a3114-3fa6-4aa5-a24b-e11f081f041b", - "duration_seconds": 0.015342902999691432 + "request_id": "171446ed-c27f-45e0-86b3-1b6e06420b4e", + "duration_seconds": 0.08245528700001614 }, "spans": [ { "name": "POST /api/v1/chats/{chat_id}/messages", "kind": "SPAN_KIND_SERVER", - "spanId": "p2OLbRny4Fc=", - "startTimeUnixNano": "1794621247296110185", - "endTimeUnixNano": "1794621247311696146", + "spanId": "ljGKzT3d/1M=", + "startTimeUnixNano": "1795103814599010618", + "endTimeUnixNano": "1795103814682418591", "status": { "code": "STATUS_CODE_OK" } @@ -248,25 +248,25 @@ ] }, "worker_correlation": { - "trace_id": "e0b8ad546fdfe9dfd5d7391424b2fc18", - "span_id": "47ccae94dff8f378", + "trace_id": "ad41b35e5e8b02c32f7a7b74d7b6278a", + "span_id": "ff9586c715f69b64", "log": { - "timestamp": "2026-11-14T01:54:07.762039+00:00", + "timestamp": "2026-11-19T15:56:55.880853+00:00", "severity": "INFO", "service_name": "messenger-worker", "event": "job.received", - "trace_id": "e0b8ad546fdfe9dfd5d7391424b2fc18", - "span_id": "47ccae94dff8f378", - "job_id": "49ce2d69-4237-4836-b23b-e34c45fe9b15", - "attachment_id": "0358f440-2f03-49ae-992d-53447bba3baa" + "trace_id": "ad41b35e5e8b02c32f7a7b74d7b6278a", + "span_id": "ff9586c715f69b64", + "job_id": "ce2dd02a-7263-43b3-9cdb-1caf53fcb262", + "attachment_id": "d49c525e-6cab-4a88-b348-867cc4185499" }, "spans": [ { "name": "attachment.process.v1", "kind": "SPAN_KIND_CONSUMER", - "spanId": "R8yulN/483g=", - "startTimeUnixNano": "1794621247762005178", - "endTimeUnixNano": "1794621248800203658", + "spanId": "/5WGxxX2m2Q=", + "startTimeUnixNano": "1795103815880827668", + "endTimeUnixNano": "1795103816744588122", "status": { "code": "STATUS_CODE_OK" } @@ -278,8 +278,8 @@ { "metric": {}, "value": [ - 1794621249.18, - "229" + 1795103819.091, + "383" ] } ], @@ -287,8 +287,8 @@ { "metric": {}, "value": [ - 1794621249.198, - "229" + 1795103819.104, + "383" ] } ], @@ -296,7 +296,7 @@ { "metric": {}, "value": [ - 1794621249.248, + 1795103819.119, "1" ] } @@ -305,39 +305,139 @@ { "metric": {}, "value": [ - 1794621249.264, + 1795103819.132, "1" ] } ] }, + "upload_trace": { + "trace_id": "ad41b35e5e8b02c32f7a7b74d7b6278a", + "chain": [ + { + "name": "POST /api/v1/chats/{chat_id}/attachments", + "kind": "SPAN_KIND_SERVER", + "span_id": "74b246705b53c840", + "parent_span_id": "", + "job": {} + }, + { + "name": "postgres.checkout", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "cf8900edf04666d0", + "parent_span_id": "74b246705b53c840", + "job": {} + }, + { + "name": "postgres.checkout", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "dc111544195865ab", + "parent_span_id": "74b246705b53c840", + "job": {} + }, + { + "name": "postgres.checkout", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "ea30143c06d7101a", + "parent_span_id": "74b246705b53c840", + "job": {} + }, + { + "name": "rabbitmq.publish", + "kind": "SPAN_KIND_PRODUCER", + "span_id": "9414f5609a1615fc", + "parent_span_id": "74b246705b53c840", + "job": { + "job.attempt": { + "intValue": "1" + } + } + }, + { + "name": "attachment.process.v1", + "kind": "SPAN_KIND_CONSUMER", + "span_id": "ff9586c715f69b64", + "parent_span_id": "9414f5609a1615fc", + "job": { + "job.attempt": { + "intValue": "1" + }, + "outcome": { + "stringValue": "success" + } + } + }, + { + "name": "postgres.checkout", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "3a99027f12c54d14", + "parent_span_id": "ff9586c715f69b64", + "job": {} + }, + { + "name": "s3.write_result", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "7238fed2427ff2b5", + "parent_span_id": "ff9586c715f69b64", + "job": {} + }, + { + "name": "postgres.commit_ready", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "6228546b59c97cc1", + "parent_span_id": "ff9586c715f69b64", + "job": {} + }, + { + "name": "postgres.claim_job", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "d038f59546905b0d", + "parent_span_id": "ff9586c715f69b64", + "job": {} + }, + { + "name": "postgres.checkout", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "8ddfdeb23bfdca06", + "parent_span_id": "d038f59546905b0d", + "job": {} + }, + { + "name": "s3.read_staging", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "87438655356f817f", + "parent_span_id": "ff9586c715f69b64", + "job": {} + } + ] + }, "incidents": [ { "scenario": "postgres_unavailable", "http_status": 503, "correlation": { - "trace_id": "46bd5c67c04ee46676631207f4cdaaef", - "span_id": "9da26006f1e46fec", + "trace_id": "020e820d68045ad3195e842244670b11", + "span_id": "d100199e5812f6e3", "log": { - "timestamp": "2026-11-14T01:54:11.699761+00:00", + "timestamp": "2026-11-19T15:57:03.906932+00:00", "severity": "ERROR", "service_name": "messenger-api", "event": "http.request", - "trace_id": "46bd5c67c04ee46676631207f4cdaaef", - "span_id": "9da26006f1e46fec", + "trace_id": "020e820d68045ad3195e842244670b11", + "span_id": "d100199e5812f6e3", "method": "POST", "route": "/api/v1/users", "status_code": 503, - "request_id": "5b3b6549-a5b7-44d9-aaa4-883e7f7f82a6", - "duration_seconds": 0.31245764100094675 + "request_id": "420eae93-41a6-41af-8f37-09e76b8ec997", + "duration_seconds": 3.004546160000018 }, "spans": [ { "name": "POST /api/v1/users", "kind": "SPAN_KIND_SERVER", - "spanId": "naJgBvHkb+w=", - "startTimeUnixNano": "1794621251387164345", - "endTimeUnixNano": "1794621251699877506", + "spanId": "0QAZnlgS9uM=", + "startTimeUnixNano": "1795103820902285656", + "endTimeUnixNano": "1795103823907032467", "status": { "code": "STATUS_CODE_ERROR" } @@ -345,47 +445,437 @@ ] }, "diagnostic": { - "timestamp": "2026-11-14T01:54:11.698503+00:00", + "timestamp": "2026-11-19T15:57:03.905870+00:00", "severity": "ERROR", "service_name": "messenger-api", "event": "dependency.unavailable", - "trace_id": "46bd5c67c04ee46676631207f4cdaaef", - "span_id": "9da26006f1e46fec", - "request_id": "5b3b6549-a5b7-44d9-aaa4-883e7f7f82a6", - "exception_type": "gaierror" + "trace_id": "020e820d68045ad3195e842244670b11", + "span_id": "d100199e5812f6e3", + "request_id": "420eae93-41a6-41af-8f37-09e76b8ec997", + "exception_type": "TimeoutError" }, - "observed_after_seconds": 4.194, - "recovery_seconds": 5.664 + "db_span": "postgres.checkout", + "alert": "MessengerHighErrorRate", + "firing_after_seconds": 32.361, + "resolved_after_seconds": 67.526 }, { - "scenario": "permanent_processing_failure", - "recovered_status": "ready", - "log": { - "timestamp": "2026-11-14T01:54:18.958470+00:00", - "severity": "ERROR", - "service_name": "messenger-worker", - "event": "job.processed", - "trace_id": "c6bbd94e4fdbad5e5808a2655735b9ed", - "span_id": "40a757e89d4b1f76", - "job_type": "attachment.process.v1", - "duration_seconds": 0.009965533998183673, - "outcome": "error", - "error_code": "injected_permanent" + "scenario": "worker_stopped_then_transient_retry", + "alert": "MessengerQueueLag", + "queue": { + "depth": 1.0, + "oldest_seconds": 25.641574, + "firing_after_seconds": 28.639, + "resolved": true, + "final_depth": 0 }, - "failed_jobs_metric": [ + "recovered_status": "ready", + "trace_id": "ff8352e27270fbc16fea7216c3ff45c0", + "chain": [ { - "metric": {}, - "value": [ - 1794621294.923, - "1" - ] + "name": "POST /api/v1/chats/{chat_id}/attachments", + "kind": "SPAN_KIND_SERVER", + "span_id": "a8daa5d1e858d802", + "parent_span_id": "", + "job": {} + }, + { + "name": "postgres.checkout", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "1bfe66add09278e5", + "parent_span_id": "a8daa5d1e858d802", + "job": {} + }, + { + "name": "postgres.checkout", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "cf5bdfb14aca0e03", + "parent_span_id": "a8daa5d1e858d802", + "job": {} + }, + { + "name": "postgres.checkout", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "fe476468bb06d3f2", + "parent_span_id": "a8daa5d1e858d802", + "job": {} + }, + { + "name": "rabbitmq.publish", + "kind": "SPAN_KIND_PRODUCER", + "span_id": "07218fe96edd8a9f", + "parent_span_id": "a8daa5d1e858d802", + "job": { + "job.attempt": { + "intValue": "1" + } + } + }, + { + "name": "rabbitmq.publish", + "kind": "SPAN_KIND_PRODUCER", + "span_id": "93984e580b7e86d5", + "parent_span_id": "a8daa5d1e858d802", + "job": { + "job.attempt": { + "intValue": "2" + } + } + }, + { + "name": "rabbitmq.publish", + "kind": "SPAN_KIND_PRODUCER", + "span_id": "a458e41372613973", + "parent_span_id": "a8daa5d1e858d802", + "job": { + "job.attempt": { + "intValue": "3" + } + } + }, + { + "name": "rabbitmq.publish", + "kind": "SPAN_KIND_PRODUCER", + "span_id": "bbf04d7c40b14fb3", + "parent_span_id": "a8daa5d1e858d802", + "job": { + "job.attempt": { + "intValue": "4" + } + } + }, + { + "name": "attachment.process.v1", + "kind": "SPAN_KIND_CONSUMER", + "span_id": "3c0af738c589e75e", + "parent_span_id": "07218fe96edd8a9f", + "job": { + "job.attempt": { + "intValue": "1" + }, + "outcome": { + "stringValue": "error" + } + } + }, + { + "name": "postgres.claim_job", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "36993e3e09207c51", + "parent_span_id": "3c0af738c589e75e", + "job": {} + }, + { + "name": "postgres.checkout", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "ea60348b52b97e80", + "parent_span_id": "36993e3e09207c51", + "job": {} + }, + { + "name": "postgres.checkout", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "a6ce9125f0f2b69a", + "parent_span_id": "3c0af738c589e75e", + "job": {} + }, + { + "name": "attachment.process.v1", + "kind": "SPAN_KIND_CONSUMER", + "span_id": "f7b2eab20244c154", + "parent_span_id": "93984e580b7e86d5", + "job": { + "job.attempt": { + "intValue": "2" + }, + "outcome": { + "stringValue": "error" + } + } + }, + { + "name": "postgres.claim_job", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "06c6bcc9ba7a345d", + "parent_span_id": "f7b2eab20244c154", + "job": {} + }, + { + "name": "postgres.checkout", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "83c7a52ecd57f72f", + "parent_span_id": "06c6bcc9ba7a345d", + "job": {} + }, + { + "name": "postgres.checkout", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "0310e2dd03331cb3", + "parent_span_id": "f7b2eab20244c154", + "job": {} + }, + { + "name": "attachment.process.v1", + "kind": "SPAN_KIND_CONSUMER", + "span_id": "f2c43df28f9d7a39", + "parent_span_id": "a458e41372613973", + "job": { + "job.attempt": { + "intValue": "3" + }, + "outcome": { + "stringValue": "error" + } + } + }, + { + "name": "postgres.claim_job", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "b81945a1dac3e54e", + "parent_span_id": "f2c43df28f9d7a39", + "job": {} + }, + { + "name": "postgres.checkout", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "206ffc2a7aaafca5", + "parent_span_id": "b81945a1dac3e54e", + "job": {} + }, + { + "name": "postgres.checkout", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "f6f62fbcc37d065f", + "parent_span_id": "f2c43df28f9d7a39", + "job": {} + }, + { + "name": "attachment.process.v1", + "kind": "SPAN_KIND_CONSUMER", + "span_id": "caf2f1cf5ab31318", + "parent_span_id": "bbf04d7c40b14fb3", + "job": { + "job.attempt": { + "intValue": "4" + }, + "outcome": { + "stringValue": "error" + } + } + }, + { + "name": "postgres.claim_job", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "0e0bdca52b68b3d7", + "parent_span_id": "caf2f1cf5ab31318", + "job": {} + }, + { + "name": "postgres.checkout", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "ff6de1ac78d07a28", + "parent_span_id": "0e0bdca52b68b3d7", + "job": {} + }, + { + "name": "postgres.checkout", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "2f459882491c3a7c", + "parent_span_id": "caf2f1cf5ab31318", + "job": {} + }, + { + "name": "rabbitmq.publish", + "kind": "SPAN_KIND_PRODUCER", + "span_id": "0a79dcefe6527245", + "parent_span_id": "a8daa5d1e858d802", + "job": { + "job.attempt": { + "intValue": "5" + } + } + }, + { + "name": "rabbitmq.publish", + "kind": "SPAN_KIND_PRODUCER", + "span_id": "a4e8cf406651958d", + "parent_span_id": "a8daa5d1e858d802", + "job": { + "job.attempt": { + "intValue": "6" + } + } + }, + { + "name": "attachment.process.v1", + "kind": "SPAN_KIND_CONSUMER", + "span_id": "6d709c8f5827479d", + "parent_span_id": "0a79dcefe6527245", + "job": { + "job.attempt": { + "intValue": "5" + }, + "outcome": { + "stringValue": "error" + } + } + }, + { + "name": "postgres.claim_job", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "0a5ed8ae1cdac4bd", + "parent_span_id": "6d709c8f5827479d", + "job": {} + }, + { + "name": "postgres.checkout", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "a6452306465ac351", + "parent_span_id": "0a5ed8ae1cdac4bd", + "job": {} + }, + { + "name": "postgres.checkout", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "d5c93140a00b63ab", + "parent_span_id": "6d709c8f5827479d", + "job": {} + }, + { + "name": "attachment.process.v1", + "kind": "SPAN_KIND_CONSUMER", + "span_id": "45c2e49b6f6471bf", + "parent_span_id": "a4e8cf406651958d", + "job": { + "job.attempt": { + "intValue": "6" + }, + "outcome": { + "stringValue": "success" + } + } + }, + { + "name": "postgres.claim_job", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "6d995da536f4d248", + "parent_span_id": "45c2e49b6f6471bf", + "job": {} + }, + { + "name": "postgres.checkout", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "ab6ddaa6b67c5663", + "parent_span_id": "6d995da536f4d248", + "job": {} + }, + { + "name": "s3.read_staging", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "ec1037446c0d5918", + "parent_span_id": "45c2e49b6f6471bf", + "job": {} + }, + { + "name": "postgres.checkout", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "4059610a72cf3cd0", + "parent_span_id": "45c2e49b6f6471bf", + "job": {} + }, + { + "name": "s3.write_result", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "741f62682fa8057f", + "parent_span_id": "45c2e49b6f6471bf", + "job": {} + }, + { + "name": "postgres.commit_ready", + "kind": "SPAN_KIND_INTERNAL", + "span_id": "17c7adc7b583eeda", + "parent_span_id": "45c2e49b6f6471bf", + "job": {} + } + ] + }, + { + "scenario": "loki_unavailable", + "successful_messages": 204, + "dropped_after_export_failure": 6.0, + "dropped_at_enqueue": 0.0, + "samples": [ + { + "seconds": 0.06, + "rss_bytes": 239079424.0, + "queued_batches": 0.0, + "capacity_batches": 256.0 + }, + { + "seconds": 5.14, + "rss_bytes": 239288320.0, + "queued_batches": 5.0, + "capacity_batches": 256.0 + }, + { + "seconds": 10.08, + "rss_bytes": 239292416.0, + "queued_batches": 10.0, + "capacity_batches": 256.0 + }, + { + "seconds": 15.12, + "rss_bytes": 240283648.0, + "queued_batches": 15.0, + "capacity_batches": 256.0 + }, + { + "seconds": 20.07, + "rss_bytes": 241635328.0, + "queued_batches": 20.0, + "capacity_batches": 256.0 + }, + { + "seconds": 25.09, + "rss_bytes": 241795072.0, + "queued_batches": 24.0, + "capacity_batches": 256.0 + }, + { + "seconds": 30.07, + "rss_bytes": 241836032.0, + "queued_batches": 29.0, + "capacity_batches": 256.0 + }, + { + "seconds": 35.09, + "rss_bytes": 241856512.0, + "queued_batches": 33.0, + "capacity_batches": 256.0 + }, + { + "seconds": 40.09, + "rss_bytes": 241860608.0, + "queued_batches": 38.0, + "capacity_batches": 256.0 + }, + { + "seconds": 45.09, + "rss_bytes": 242176000.0, + "queued_batches": 43.0, + "capacity_batches": 256.0 + }, + { + "seconds": 50.07, + "rss_bytes": 242384896.0, + "queued_batches": 48.0, + "capacity_batches": 256.0 } ], - "metric_query": "sum(messenger_job_attempts_total{outcome=\"error\",service_instance_id=\"3b4f96f13e48\"})", - "failure_to_ready_seconds": 19.356 + "log_export_recovered": true } ], - "privacy_checked_logs": 72, + "privacy_checked_logs": 413, "checks": { "three_backends": true, "dashboard_queries": true, diff --git a/evidence/verification.json b/evidence/verification.json index 4c6b71d..6a491ee 100644 --- a/evidence/verification.json +++ b/evidence/verification.json @@ -1,5 +1,5 @@ { - "date_utc": "2026-11-14T01:50:28.592547+00:00", + "date_utc": "2026-11-19T15:50:02.598982+00:00", "checks": [ { "name": "contract", @@ -8,7 +8,7 @@ "scripts/check_contract.py" ], "exit_code": 0, - "duration_seconds": 0.101, + "duration_seconds": 0.112, "result": "PASS" }, { @@ -18,7 +18,7 @@ "scripts/validate_openapi.py" ], "exit_code": 0, - "duration_seconds": 1.111, + "duration_seconds": 1.068, "result": "PASS" }, { @@ -32,7 +32,7 @@ "--quiet" ], "exit_code": 0, - "duration_seconds": 0.131, + "duration_seconds": 0.113, "result": "PASS" }, { @@ -43,7 +43,7 @@ "test-stand-up" ], "exit_code": 0, - "duration_seconds": 77.116, + "duration_seconds": 70.403, "result": "PASS" }, { @@ -54,9 +54,9 @@ "test-unit" ], "exit_code": 0, - "duration_seconds": 115.183, + "duration_seconds": 322.597, "result": "PASS", - "summary": "206 passed in 112.44s (0:01:52)" + "summary": "206 passed in 98.89s (0:01:38)" }, { "name": "api", @@ -67,7 +67,7 @@ "http://localhost:28080" ], "exit_code": 0, - "duration_seconds": 8.349, + "duration_seconds": 4.112, "result": "PASS" }, { @@ -84,7 +84,7 @@ "--restart-telemetry" ], "exit_code": 0, - "duration_seconds": 79.231, + "duration_seconds": 292.686, "result": "PASS" }, { @@ -100,7 +100,7 @@ "http://localhost:28080" ], "exit_code": 0, - "duration_seconds": 62.485, + "duration_seconds": 61.526, "result": "PASS" }, { @@ -116,7 +116,7 @@ "http://localhost:28080" ], "exit_code": 0, - "duration_seconds": 17.998, + "duration_seconds": 19.039, "result": "PASS" } ], @@ -128,345 +128,13 @@ }, "result": "PASS", "cleanup": { - "projects": [ - "messenger", - "messenger-test" - ], - "resources": { - "containers": [ - "062d88c22d6c", - "5653c0121264", - "6e2b3ca3c86c", - "ac60f4044ea7", - "e633226993b5", - "1e21fe44a453", - "126c76cff388", - "76901c1e8b60", - "85731e19d4c6", - "79077e49c5ee", - "80a7e7e36fd1", - "69f42359b3e3", - "1a3d86fafd53", - "9f00acc93186", - "bd366e53bf42", - "b4f81e6b52c3", - "a9f375b0b17b" - ], - "networks": [ - "04eba990b02c", - "ff8d81906905" - ], - "volumes": [ - "messenger-test_grafanadata", - "messenger-test_lokidata", - "messenger-test_miniodata", - "messenger-test_pgdata", - "messenger-test_prometheusdata", - "messenger-test_rabbitmqdata", - "messenger-test_redisdata", - "messenger-test_tempodata" - ] - }, - "application_image_ids": [ - "490c0e5b26df", - "669227412939", - "af2ab3c10330" - ], - "local_settings_preserved": true, + "project": "messenger-test", "remaining": { "containers": [], "networks": [], "volumes": [] }, - "application_images_remaining": [], - "result": "PASS", - "verified": { - "containers_remaining": 0, - "volumes_remaining": 0, - "application_images_remaining": 0, - "local_settings_preserved": true - } + "result": "PASS" }, - "finished_at_utc": "2026-11-14T01:56:33.228789+00:00", - "source": { - "base_commit": "498ce1e0d20c7ffc45ef71b81f5ce3cfa56208ec", - "working_tree_modified": true - }, - "runtime": { - "python": "3.12.14", - "docker_engine": "29.9.3", - "compose": "5.7.0" - }, - "container_lifecycle": [ - { - "time_unix": 1794621212, - "action": "stop", - "service": "redis" - }, - { - "time_unix": 1794621212, - "action": "start", - "service": "redis" - }, - { - "time_unix": 1794621251, - "action": "stop", - "service": "postgres" - }, - { - "time_unix": 1794621251, - "action": "start", - "service": "publisher" - }, - { - "time_unix": 1794621254, - "action": "start", - "service": "postgres" - }, - { - "time_unix": 1794621255, - "action": "stop", - "service": "worker" - }, - { - "time_unix": 1794621256, - "action": "start", - "service": "worker" - }, - { - "time_unix": 1794621267, - "action": "start", - "service": "worker" - }, - { - "time_unix": 1794621269, - "action": "start", - "service": "worker" - }, - { - "time_unix": 1794621271, - "action": "start", - "service": "minio-bootstrap" - }, - { - "time_unix": 1794621272, - "action": "start", - "service": "migrate" - }, - { - "time_unix": 1794621275, - "action": "start", - "service": "worker" - }, - { - "time_unix": 1794621281, - "action": "start", - "service": "worker" - }, - { - "time_unix": 1794621284, - "action": "start", - "service": "worker" - }, - { - "time_unix": 1794621292, - "action": "start", - "service": "worker" - }, - { - "time_unix": 1794621295, - "action": "stop", - "service": "prometheus" - }, - { - "time_unix": 1794621295, - "action": "stop", - "service": "grafana" - }, - { - "time_unix": 1794621295, - "action": "start", - "service": "prometheus" - }, - { - "time_unix": 1794621295, - "action": "start", - "service": "grafana" - }, - { - "time_unix": 1794621295, - "action": "stop", - "service": "loki" - }, - { - "time_unix": 1794621296, - "action": "start", - "service": "loki" - }, - { - "time_unix": 1794621305, - "action": "stop", - "service": "tempo" - }, - { - "time_unix": 1794621305, - "action": "start", - "service": "tempo" - }, - { - "time_unix": 1794621314, - "action": "stop", - "service": "worker" - }, - { - "time_unix": 1794621314, - "action": "stop", - "service": "publisher" - }, - { - "time_unix": 1794621324, - "action": "stop", - "service": "cleanup" - }, - { - "time_unix": 1794621324, - "action": "stop", - "service": "otel-collector" - }, - { - "time_unix": 1794621325, - "action": "stop", - "service": "minio" - }, - { - "time_unix": 1794621325, - "action": "stop", - "service": "prometheus" - }, - { - "time_unix": 1794621325, - "action": "stop", - "service": "grafana" - }, - { - "time_unix": 1794621325, - "action": "stop", - "service": "broker" - }, - { - "time_unix": 1794621325, - "action": "stop", - "service": "redis" - }, - { - "time_unix": 1794621325, - "action": "stop", - "service": "postgres" - }, - { - "time_unix": 1794621325, - "action": "stop", - "service": "loki" - }, - { - "time_unix": 1794621325, - "action": "start", - "service": "minio" - }, - { - "time_unix": 1794621325, - "action": "start", - "service": "otel-collector" - }, - { - "time_unix": 1794621325, - "action": "start", - "service": "prometheus" - }, - { - "time_unix": 1794621325, - "action": "start", - "service": "grafana" - }, - { - "time_unix": 1794621325, - "action": "start", - "service": "broker" - }, - { - "time_unix": 1794621325, - "action": "start", - "service": "redis" - }, - { - "time_unix": 1794621325, - "action": "start", - "service": "postgres" - }, - { - "time_unix": 1794621325, - "action": "start", - "service": "loki" - }, - { - "time_unix": 1794621334, - "action": "stop", - "service": "tempo" - }, - { - "time_unix": 1794621335, - "action": "start", - "service": "tempo" - }, - { - "time_unix": 1794621335, - "action": "stop", - "service": "nginx" - }, - { - "time_unix": 1794621336, - "action": "start", - "service": "nginx" - }, - { - "time_unix": 1794621337, - "action": "stop", - "service": "api" - }, - { - "time_unix": 1794621337, - "action": "stop", - "service": "api" - }, - { - "time_unix": 1794621337, - "action": "start", - "service": "api" - }, - { - "time_unix": 1794621337, - "action": "start", - "service": "api" - }, - { - "time_unix": 1794621344, - "action": "start", - "service": "cleanup" - }, - { - "time_unix": 1794621344, - "action": "start", - "service": "publisher" - }, - { - "time_unix": 1794621345, - "action": "start", - "service": "worker" - }, - { - "time_unix": 1794621377, - "action": "stop", - "service": "api" - } - ] + "finished_at_utc": "2026-11-19T16:03:05.425775+00:00" } diff --git a/infra/otel/README.md b/infra/otel/README.md index 6f27be2..bd43ee6 100644 --- a/infra/otel/README.md +++ b/infra/otel/README.md @@ -1,6 +1,6 @@ # Наблюдаемость Messenger -API и worker экспортируют OTLP HTTP/protobuf в Collector (:4318). +API, publisher и worker экспортируют OTLP HTTP/protobuf в Collector (:4318). Метрики выдаются Prometheus на :8889, логи отправляются в native OTLP Loki, traces — в Tempo. Grafana читает три хранилища через provisioned datasources. @@ -15,6 +15,6 @@ grafanadata содержит настройки Grafana. Внешний порт по умолчанию 127.0.0.1:13000. Её healthcheck проверяет также Loki, Tempo и Collector. Бизнес-readiness API от этих сервисов не зависит. -Проверка: `make test-observability`. Полный прогон с очисткой: `make verify`. -Инструкция запуска — в [RUNNING.md](../../RUNNING.md), ограничения и планы — в -[REPORT.md](../../REPORT.md). +`make test-observability` запускает контролируемые отказы на указанном стенде. +`make verify` создаёт отдельный проект и удаляет его ресурсы после прогона. +Правила Prometheus, запуск и порядок диагностики описаны в [REPORT.md](../../REPORT.md). diff --git a/infra/otel/alerts.yaml b/infra/otel/alerts.yaml new file mode 100644 index 0000000..95319e6 --- /dev/null +++ b/infra/otel/alerts.yaml @@ -0,0 +1,18 @@ +groups: + - name: messenger + interval: 5s + rules: + - alert: MessengerHighErrorRate + expr: | + sum(increase(messenger_http_requests_total{http_response_status_class="5xx",http_route!~"/health/.*"}[30s])) + / clamp_min(sum(increase(messenger_http_requests_total{http_route!~"/health/.*"}[30s])), 1) > 0.05 + for: 5s + annotations: + summary: "Более 5% бизнес-запросов завершились HTTP 5xx за 30 секунд" + runbook: "REPORT.md#диагностика-инцидентов" + - alert: MessengerQueueLag + expr: max(messenger_queue_oldest_seconds) > 15 and max(messenger_queue_depth_ratio) > 0 + for: 5s + annotations: + summary: "Старейшее ожидающее задание находится в очереди более 15 секунд" + runbook: "REPORT.md#диагностика-инцидентов" diff --git a/infra/otel/collector.yaml b/infra/otel/collector.yaml index 892f65c..93a5e72 100644 --- a/infra/otel/collector.yaml +++ b/infra/otel/collector.yaml @@ -37,6 +37,14 @@ extensions: health_check: endpoint: 0.0.0.0:13133 service: + telemetry: + metrics: + readers: + - pull: + exporter: + prometheus: + host: 0.0.0.0 + port: 8888 extensions: [health_check] pipelines: metrics: diff --git a/infra/otel/grafana/dashboards/messenger.json b/infra/otel/grafana/dashboards/messenger.json index 11c1d63..b21cf37 100644 --- a/infra/otel/grafana/dashboards/messenger.json +++ b/infra/otel/grafana/dashboards/messenger.json @@ -332,6 +332,280 @@ } }, "description": "Накопленное число 5xx: показывает и первую ошибку нового ряда, когда rate ещё не имеет двух разных точек." + }, + { + "id": 11, + "title": "Очередь: ожидающие задания", + "type": "timeseries", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 0, + "y": 45 + }, + "fieldConfig": { + "defaults": { + "unit": "short" + }, + "overrides": [] + }, + "targets": [ + { + "refId": "A", + "expr": "max by (queue_name) (messenger_queue_depth_ratio)", + "legendFormat": "Глубина {{service_name}}{{queue_name}}{{exporter}}", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + } + } + ] + }, + { + "id": 12, + "title": "Очередь: возраст старейшей задачи", + "type": "timeseries", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 12, + "y": 45 + }, + "fieldConfig": { + "defaults": { + "unit": "s" + }, + "overrides": [] + }, + "targets": [ + { + "refId": "A", + "expr": "max by (queue_name) (messenger_queue_oldest_seconds)", + "legendFormat": "Возраст {{service_name}}{{queue_name}}{{exporter}}", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + } + } + ] + }, + { + "id": 13, + "title": "PostgreSQL: соединения и ожидающие", + "type": "timeseries", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 0, + "y": 53 + }, + "fieldConfig": { + "defaults": { + "unit": "short" + }, + "overrides": [] + }, + "targets": [ + { + "refId": "A", + "expr": "sum by (service_name) (messenger_db_pool_used_ratio)", + "legendFormat": "Занято {{service_name}}{{queue_name}}{{exporter}}", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + } + }, + { + "refId": "B", + "expr": "sum by (service_name) (messenger_db_pool_waiting_ratio)", + "legendFormat": "Ожидают {{service_name}}{{queue_name}}{{exporter}}", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + } + } + ] + }, + { + "id": 14, + "title": "Worker: доля занятых слотов", + "type": "timeseries", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 12, + "y": 53 + }, + "fieldConfig": { + "defaults": { + "unit": "percentunit" + }, + "overrides": [] + }, + "targets": [ + { + "refId": "A", + "expr": "sum(messenger_worker_busy_ratio) / sum(messenger_worker_capacity_ratio)", + "legendFormat": "Загрузка {{service_name}}{{queue_name}}{{exporter}}", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + } + } + ] + }, + { + "id": 15, + "title": "Процессы: CPU в ядрах", + "type": "timeseries", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 0, + "y": 61 + }, + "fieldConfig": { + "defaults": { + "unit": "short" + }, + "overrides": [] + }, + "targets": [ + { + "refId": "A", + "expr": "sum by (service_name) (rate(messenger_process_cpu_seconds_total[1m]))", + "legendFormat": "CPU {{service_name}}{{queue_name}}{{exporter}}", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + } + } + ] + }, + { + "id": 16, + "title": "Процессы: резидентная память", + "type": "timeseries", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 12, + "y": 61 + }, + "fieldConfig": { + "defaults": { + "unit": "bytes" + }, + "overrides": [] + }, + "targets": [ + { + "refId": "A", + "expr": "sum by (service_name) (messenger_process_rss_bytes)", + "legendFormat": "RSS {{service_name}}{{queue_name}}{{exporter}}", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + } + } + ] + }, + { + "id": 17, + "title": "Вложения: p95 времени до ready", + "type": "timeseries", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 0, + "y": 69 + }, + "fieldConfig": { + "defaults": { + "unit": "s" + }, + "overrides": [] + }, + "targets": [ + { + "refId": "A", + "expr": "histogram_quantile(0.95, sum by (le) (rate(messenger_job_time_to_ready_seconds_bucket[5m])))", + "legendFormat": "p95 {{service_name}}{{queue_name}}{{exporter}}", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + } + } + ] + }, + { + "id": 18, + "title": "Collector: очереди экспорта", + "type": "timeseries", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 12, + "y": 69 + }, + "fieldConfig": { + "defaults": { + "unit": "short" + }, + "overrides": [] + }, + "targets": [ + { + "refId": "A", + "expr": "max by (exporter) (otelcol_exporter_queue_size)", + "legendFormat": "Размер {{service_name}}{{queue_name}}{{exporter}}", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + } + }, + { + "refId": "B", + "expr": "max by (exporter) (otelcol_exporter_queue_capacity)", + "legendFormat": "Ёмкость {{service_name}}{{queue_name}}{{exporter}}", + "datasource": { + "type": "prometheus", + "uid": "prometheus" + } + } + ] } ], "annotations": { diff --git a/infra/otel/prometheus.yaml b/infra/otel/prometheus.yaml index 8997d87..95b65b8 100644 --- a/infra/otel/prometheus.yaml +++ b/infra/otel/prometheus.yaml @@ -5,3 +5,7 @@ scrape_configs: - job_name: messenger static_configs: - targets: [otel-collector:8889] + - job_name: collector + static_configs: + - targets: [otel-collector:8888] +rule_files: [/etc/prometheus/alerts.yaml] diff --git a/migrations/versions/b55d0c6819ab_job_trace_context.py b/migrations/versions/b55d0c6819ab_job_trace_context.py new file mode 100644 index 0000000..079dd07 --- /dev/null +++ b/migrations/versions/b55d0c6819ab_job_trace_context.py @@ -0,0 +1,17 @@ +"""Сохранить W3C context между HTTP-транзакцией и publisher.""" + +import sqlalchemy as sa +from alembic import op + +revision = "b55d0c6819ab" +down_revision = "a62c950e18b3" +branch_labels = None +depends_on = None + + +def upgrade(): + op.add_column("attachment_jobs", sa.Column("trace_context", sa.JSON(), nullable=True)) + + +def downgrade(): + op.drop_column("attachment_jobs", "trace_context") diff --git a/scripts/check_jobs.py b/scripts/check_jobs.py index 5bea24b..b82e720 100644 --- a/scripts/check_jobs.py +++ b/scripts/check_jobs.py @@ -179,7 +179,7 @@ def crash(client, actor, chat, mode): ) -def retry_replay(client, actor, chat, permanent, on_failed=None): +def retry_replay(client, actor, chat, permanent, on_failed=None, on_queued=None): name = "messenger-retry-fault-" + uuid4().hex samples = [] configuration = ComposeProject().config["services"]["worker"]["environment"] @@ -188,6 +188,8 @@ def retry_replay(client, actor, chat, permanent, on_failed=None): try: require_compose("stop", "worker") attachment, original = client.attachment(actor, chat) + if on_queued is not None: + on_queued(attachment) mode = "fail-permanent" if permanent else "fail-transient" require_compose( "run", diff --git a/scripts/check_observability.py b/scripts/check_observability.py index 330138e..a9a93ae 100644 --- a/scripts/check_observability.py +++ b/scripts/check_observability.py @@ -1,6 +1,6 @@ """Проверка наблюдаемости через реальные запросы Grafana к трём backend. ---incidents явно разрешает два ограниченных отказа на выбранном Compose-проекте. +--incidents явно разрешает ограниченные отказы на выбранном Compose-проекте. В evidence сохраняются только агрегаты и выбранные технические поля. """ @@ -168,6 +168,84 @@ def run_load(args): return report +def metric(grafana, expression): + rows = grafana.query(expression) + return float(rows[0]['value'][1]) if rows else None + + +def alert_firing(grafana, name): + return bool(grafana.query(f'ALERTS{{alertname="{name}",alertstate="firing"}}')) + + +def trace_chain(grafana, trace_id, *, retry=False): + def inspect(): + spans = spans_in(grafana.trace(trace_id)) + by_id = {identifier_hex(span['spanId'], 8): span for span in spans} + workers = [span for span in spans if span['name'] == 'attachment.process.v1' + and span.get('kind') in ('SPAN_KIND_CONSUMER', 5)] + for worker in workers: + publisher = by_id.get(identifier_hex(worker.get('parentSpanId', ''), 8), {}) + if publisher.get('kind') not in ('SPAN_KIND_PRODUCER', 4): + return None + upload = by_id.get(identifier_hex(publisher.get('parentSpanId', ''), 8), {}) + if upload.get('name') != 'POST /api/v1/chats/{chat_id}/attachments': + return None + names = {span['name'] for span in spans} + if not workers or not {'s3.read_staging', 's3.write_result', 'postgres.commit_ready'} <= names: + return None + if retry: + outcomes = set() + for span in workers: + attrs = {row['key']: row['value'] for row in span.get('attributes', [])} + outcomes.add((int(attrs['job.attempt']['intValue']), attrs.get('outcome', {}).get('stringValue'))) + if not {(1, 'error'), (2, 'error')} <= outcomes or not any(n > 2 and outcome == 'success' for n, outcome in outcomes): + return None + return [{'name': span['name'], 'kind': span.get('kind'), + 'span_id': identifier_hex(span['spanId'], 8), + 'parent_span_id': identifier_hex(span.get('parentSpanId', ''), 8), + 'job': {entry['key']: entry['value'] for entry in span.get('attributes', []) + if entry['key'] in {'job.attempt', 'outcome'}}} for span in spans] + return eventually(inspect, 'Missing upload -> producer -> consumer -> S3/DB chain') + + +def telemetry_outage(project, client, grafana, actor, chat): + failed = 'sum({__name__=~"otelcol_exporter_send_failed_log_records(_total)?",exporter="otlphttp/loki"}) or vector(0)' + refused = 'sum({__name__=~"otelcol_exporter_enqueue_failed_log_records(_total)?",exporter="otlphttp/loki"}) or vector(0)' + baseline = [metric(grafana, expr) for expr in (failed, refused)] + rss = 'sum({__name__=~"otelcol_process_memory_rss(_bytes)?"})' + samples = [] + successful = 0 + try: + project.run('stop', 'loki') + start = time.monotonic() + for second in range(51): + for index in range(4): + client.message(actor, chat, f'outage-{second}-{index}') + successful += 1 + if second % 5 == 0: + samples.append({ + 'seconds': round(time.monotonic() - start, 2), + 'rss_bytes': metric(grafana, rss), + 'queued_batches': metric(grafana, 'sum(otelcol_exporter_queue_size{exporter="otlphttp/loki"})'), + 'capacity_batches': metric(grafana, 'sum(otelcol_exporter_queue_capacity{exporter="otlphttp/loki"})'), + }) + time.sleep(max(0, start + second + 1 - time.monotonic())) + losses = [metric(grafana, expr) - count for expr, count in zip((failed, refused), baseline)] + check(sum(losses) > 0, 'No measured Collector log loss during prolonged outage') + check(all(0 <= row['queued_batches'] <= row['capacity_batches'] == 256 for row in samples), 'Unexpected queue bound') + check(max(row['rss_bytes'] for row in samples) < 256 * 1024**2, 'Collector crossed container memory limit') + finally: + project.run('start', 'loki') + eventually(lambda: grafana.proxy('loki', '/loki/api/v1/labels').get('status') == 'success', + 'Loki did not recover') + restored = client.message(actor, chat, 'telemetry-backend-restored') + correlation(grafana, 'messenger-api', time.time_ns() - 30 * 10**9, + trace_id=restored['headers']['X-Trace-Id']) + return {'scenario':'loki_unavailable', 'successful_messages': successful, + 'dropped_after_export_failure': losses[0], 'dropped_at_enqueue': losses[1], + 'samples': samples, 'log_export_recovered': True} + + def main(): parser = argparse.ArgumentParser() parser.add_argument('--base-url', required=True) @@ -201,6 +279,7 @@ def main(): client.wait_ready(actor, attachment) api, api_trace = correlation(grafana, 'messenger-api', start, trace_id=controlled_trace, request_id=response['headers']['X-Request-Id']) worker, worker_trace = correlation(grafana, 'messenger-worker', start, attachment_id=attachment['id']) + accepted_chain = trace_chain(grafana, worker['trace_id']) check(api['log']['request_id'] == response['headers']['X-Request-Id'], 'Request id correlation lost') check(any(span['kind'] in ('SPAN_KIND_SERVER', 2) for span in api['spans']), 'No server span') check(any(span['kind'] in ('SPAN_KIND_CONSUMER', 5) for span in worker['spans']), 'No consumer span') @@ -225,42 +304,67 @@ def main(): check(not any(forbidden_labels & set(row['metric']) for row in series), 'High cardinality metric label') report = {'date_utc': datetime.now(timezone.utc).isoformat(), 'project': project.name, 'load': load, 'api_replicas': len(aliases), 'dashboard_uid': dashboard['uid'], - 'api_correlation': api, 'worker_correlation': worker, 'metrics': metrics, 'incidents': []} + 'api_correlation': api, 'worker_correlation': worker, 'metrics': metrics, 'upload_trace': {'trace_id':worker['trace_id'], 'chain':accepted_chain}, 'incidents': []} if args.incidents: - # Восстановление выполняется даже при ошибке проверки. + def fail_request(): + return client.call('POST', '/api/v1/users', expected=503, + body={'username':'fault_' + uuid4().hex[:12], + 'display_name':'Synthetic', 'password':'not-exported-' + uuid4().hex}) + + before = time.monotonic() try: - before = time.monotonic() project.run('stop', 'postgres') - failed = client.call('POST', '/api/v1/users', expected=503, - body={'username':'fault_' + uuid4().hex[:12], 'display_name':'Synthetic', 'password':'not-exported-' + uuid4().hex}) + failed = fail_request() error_trace = failed['headers'].get('X-Trace-Id') - error, _ = correlation(grafana, 'messenger-api', start, trace_id=error_trace, request_id=failed['headers']['X-Request-Id']) - diagnostics = eventually(lambda: grafana.logs('{service_name="messenger-api"} | json | event="dependency.unavailable" | trace_id="' + error_trace + '"', start), 'No dependency diagnostic log') - check(error['log'].get('status_code') == 503 or any(s['status'].get('code') in ('STATUS_CODE_ERROR', 2) for s in error['spans']), 'DB failure not reflected in trace') - report['incidents'].append({'scenario':'postgres_unavailable','http_status':503,'correlation':error,'diagnostic':diagnostics[0], 'observed_after_seconds':round(time.monotonic()-before,3)}) + error, db_trace = correlation(grafana, 'messenger-api', start, trace_id=error_trace, + request_id=failed['headers']['X-Request-Id']) + diagnostics = eventually(lambda: grafana.logs( + '{service_name="messenger-api"} | json | event="dependency.unavailable" | trace_id="' + error_trace + '"', start), + 'No dependency diagnostic log') + checkout = next(span for span in spans_in(db_trace) if span['name'] == 'postgres.checkout' + and span.get('status', {}).get('code') in ('STATUS_CODE_ERROR', 2)) + + def db_alert(): + for _ in range(4): + fail_request() + return alert_firing(grafana, 'MessengerHighErrorRate') + + eventually(db_alert, 'Error rate alert did not fire', timeout=75) + report['incidents'].append({'scenario':'postgres_unavailable','http_status':503,'correlation':error, + 'diagnostic':diagnostics[0], 'db_span':checkout['name'], + 'alert':'MessengerHighErrorRate', 'firing_after_seconds':round(time.monotonic()-before,3)}) finally: project.run('start', 'postgres') eventually(lambda: _ready(client), 'API did not recover after PostgreSQL') - report['incidents'][-1]['recovery_seconds'] = round(time.monotonic() - before, 3) - # Явный fault hook обработки заданий: один permanent processing failure, затем replay. + eventually(lambda: not alert_firing(grafana, 'MessengerHighErrorRate'), 'Error rate alert not resolved') + report['incidents'][-1]['resolved_after_seconds'] = round(time.monotonic() - before, 3) + from scripts.check_jobs import retry_replay - failed_instance = [] - def wait_failed_metric(sample, container_name): - instance = project.docker('inspect', '--format', '{{.Config.Hostname}}', container_name) - failed_instance.append(instance) - expression = 'sum(messenger_job_attempts_total{outcome="error",service_instance_id="' + instance + '"})' - eventually(lambda: grafana.query(expression), 'Failed job metric not exported before recovery') - incident = retry_replay(client, actor, chat, permanent=True, on_failed=wait_failed_metric) - error_logs = eventually(lambda: grafana.logs('{service_name="messenger-worker"} | json | event="job.processed" | outcome="error" | error_code="injected_permanent"', start), 'No failed job telemetry') - error_trace = eventually(lambda: grafana.trace(error_logs[-1]['trace_id']), 'No failed job trace') - check(any(span.get('status', {}).get('code') in ('STATUS_CODE_ERROR', 2) for span in spans_in(error_trace)), 'Worker error trace status lost') - expression = 'sum(messenger_job_attempts_total{outcome="error",service_instance_id="' + failed_instance[0] + '"})' - errors = eventually(lambda: grafana.query(expression), 'No failed jobs counter') - recovery = (datetime.fromisoformat(incident['after']['updated_at']) - datetime.fromisoformat(incident['samples'][-1]['updated_at'])).total_seconds() - report['incidents'].append({'scenario':'permanent_processing_failure','recovered_status':incident['after']['status'], 'log':error_logs[-1], 'failed_jobs_metric':errors, 'metric_query':expression, 'failure_to_ready_seconds':round(recovery,3)}) + queue = {} + + def observe_queue(_): + observed = time.monotonic() + eventually(lambda: alert_firing(grafana, 'MessengerQueueLag'), 'Queue lag alert did not fire') + queue.update(depth=metric(grafana, 'max(messenger_queue_depth_ratio)'), + oldest_seconds=metric(grafana, 'max(messenger_queue_oldest_seconds)'), + firing_after_seconds=round(time.monotonic()-observed,3)) + + incident = retry_replay(client, actor, chat, permanent=False, on_queued=observe_queue) + retried_worker, retry_trace = correlation(grafana, 'messenger-worker', start, + attachment_id=incident['attachment_id']) + chain = trace_chain(grafana, retried_worker['trace_id'], retry=True) + eventually(lambda: not alert_firing(grafana, 'MessengerQueueLag') + and metric(grafana, 'max(messenger_queue_depth_ratio)') == 0, 'Backlog did not drain') + queue.update(resolved=True, final_depth=0) + report['incidents'].append({'scenario':'worker_stopped_then_transient_retry', + 'alert':'MessengerQueueLag', 'queue':queue, 'recovered_status':incident['after']['status'], + 'trace_id':retried_worker['trace_id'], 'chain':chain}) + report['incidents'].append(telemetry_outage(project, client, grafana, actor, chat)) + else: + retry_trace = {} # Не сохраняем API bodies или SDK exceptions; проверяем реальные выбранные сигналы. logs = grafana.logs('{service_name=~"messenger-api|messenger-worker"}', start) - exported = json.dumps([logs, api_trace, worker_trace]) + exported = json.dumps([logs, api_trace, worker_trace, retry_trace]) private = [sentinel, *(person['token'] for person in (actor,bob,eve)), *(person['registration']['password'] for person in (actor,bob,eve))] private.extend(path.read_text().strip() for path in (ROOT / 'secrets').iterdir() if path.is_file()) check(not any(secret and secret in exported for secret in private), 'Private value found in telemetry') @@ -280,7 +384,7 @@ def main(): destination = ROOT / args.output destination.parent.mkdir(parents=True, exist_ok=True) destination.write_text(json.dumps(report,ensure_ascii=False,indent=2)+'\n') - print('PASS: telemetry, dashboard, privacy, correlations' + ('; two incidents recovered' if args.incidents else '')) + print('PASS: telemetry, dashboard, privacy, correlations' + ('; alerts and outage recovery verified' if args.incidents else '')) def _ready(client): diff --git a/scripts/deployment.py b/scripts/deployment.py index 6572e90..90ca14e 100644 --- a/scripts/deployment.py +++ b/scripts/deployment.py @@ -137,20 +137,23 @@ def verify(): import time project_name = os.getenv('TEST_PROJECT', 'messenger-test') + if any(inventory([project_name]).values()): + raise RuntimeError(f'Choose an unused TEST_PROJECT; {project_name} already has resources') os.environ.update(COMPOSE_PROJECT_NAME=project_name, COMPOSE_FILE='compose.yaml:compose.test.yaml', GRAFANA_HOST_PORT='23000', LB_HOST_PORT='28080', - DOCKER_TESTS='1') + DOCKER_TESTS='1', OTEL_ENABLED='true') report = {'date_utc': datetime.now(timezone.utc).isoformat(), 'checks': [], 'profile': {'single_stack': True, 'load_duration_seconds': 10, 'load_requests_per_second': 10, 'load_concurrency': 2}} destination = ROOT / 'evidence/verification.json' destination.parent.mkdir(exist_ok=True) - def run(name, command, timeout=600): + def run(name, command, timeout=600, *, env=None): print('RUN: ' + name, flush=True) started = time.monotonic() - result = subprocess.run(command, cwd=ROOT, text=True, capture_output=True, timeout=timeout) + result = subprocess.run(command, cwd=ROOT, text=True, capture_output=True, timeout=timeout, + env={**os.environ, **(env or {})}) executable = Path(command[0]) display_command = [str(executable.relative_to(ROOT)) if executable.is_relative_to(ROOT) else command[0], *command[1:]] @@ -175,7 +178,9 @@ def verify(): run('openapi', [sys.executable, 'scripts/validate_openapi.py']) run('compose', ['docker', 'compose', '--env-file', '.env', 'config', '--quiet']) run('startup', ['make', '--no-print-directory', 'test-stand-up'], timeout=600) - run('regression', ['make', '--no-print-directory', 'test-unit']) + # Локальные ASGI fixtures не находятся в сети Compose. Проверки SDK + # используют exporters в памяти, интеграционный стенд экспортирует OTLP. + run('regression', ['make', '--no-print-directory', 'test-unit'], env={'OTEL_ENABLED': 'false'}) run('api', [sys.executable, 'tests/smoke.py', '--base-url', 'http://localhost:28080']) run('observability', [sys.executable, '-m', 'scripts.check_observability', '--base-url', 'http://localhost:28080', @@ -192,7 +197,11 @@ def verify(): finally: try: print('RUN: cleanup', flush=True) - report['cleanup'] = clean_stands(apply=True) + ComposeProject().run('down', '--volumes', '--remove-orphans', timeout=120) + remaining = inventory([project_name]) + if any(remaining.values()): + raise RuntimeError('Verification project cleanup incomplete') + report['cleanup'] = {'project': project_name, 'remaining': remaining, 'result': 'PASS'} print('PASS: cleanup', flush=True) finally: report['finished_at_utc'] = datetime.now(timezone.utc).isoformat() -- 2.54.0 From 2b721844feb9ccf772c34e83d53e533a9de0d185 Mon Sep 17 00:00:00 2001 From: gytall Date: Fri, 20 Nov 2026 17:18:20 +0300 Subject: [PATCH 4/4] fix report.md --- REPORT.md | 150 ++++++++++++++++-------------------------------------- 1 file changed, 45 insertions(+), 105 deletions(-) diff --git a/REPORT.md b/REPORT.md index 5f6fc17..b0f2659 100644 --- a/REPORT.md +++ b/REPORT.md @@ -1,7 +1,7 @@ -# Отчёт +# Отчёт - лабораторная 6 - Автор: Григорян Илья Мурадович, БПИ2303. -- Цель: оценка **4**, лабораторная «Наблюдаемость». +- Цель: оценка **4** - Источники: OpenTelemetry SDK 1.45.1, FastAPI, SQLAlchemy 2.1.4, [внутренние метрики Collector](https://opentelemetry.io/docs/collector/internal-telemetry/), [контракт наблюдаемости](contracts/observability.md). Помощь Codex. @@ -20,53 +20,32 @@ make down ``` API доступен на http://localhost:18081, дашборд — на -http://localhost:13000/d/messenger-overview. Для подключения к хранилищам с -компьютера используйте [локальный режим](LOCAL_CONNECTIONS.md). +http://localhost:13000/d/messenger-overview. Инициализация создаёт только отсутствующие настройки и секреты. Миграции и настройка приватного bucket выполняются при запуске. `make down` сохраняет тома. ## Архитектура и трассировка -Две реплики API за nginx, PostgreSQL для сообщений и состояния заданий, Redis -для сессий, MinIO для файлов, RabbitMQ для доставки, отдельные publisher, -worker и cleanup. HTTP 202 возвращается после устойчивого приёма вложения. -Publisher отмечает доставку после подтверждения RabbitMQ, worker подтверждает -попытку после устойчивой фиксации исхода. +Две реплики API за nginx. PostgreSQL хранит сообщения и состояние заданий, +Redis — сессии, MinIO — файлы, RabbitMQ доставляет задания worker. +Миграции и настройка MinIO выполняются при запуске, доступы передаются +через файловые секреты. Версии, проверки готовности и тома заданы в +[compose.yaml](compose.yaml). -| Роль | Сервис и версия | Готовность, данные | -| --- | --- | --- | -| Балансировщик | nginx 1.28.0 | `/lb-health`, публикует API на `LB_HOST_PORT` | -| HTTP API | api, Python 3.12 | `/health/ready`, две реплики, `api:8080` | -| База | postgres 16.10 | `pg_isready`, `pgdata`, `postgres:5432` | -| Сессии | redis 7.4.2 | аутентифицированный `PING`, `redisdata`, `redis:6379` | -| Файлы | minio RELEASE.2025-10-15T17-29-55Z | `/minio/health/ready`, `miniodata`, `minio:9000` в сети `objects` | -| Очередь | broker, RabbitMQ 4.4.0 | `rabbitmq-diagnostics ping`, `rabbitmqdata`, `broker:5672` | +API, publisher и worker отправляют телеметрию по OTLP в Collector. +Prometheus хранит метрики, Loki — структурные логи, Tempo — трассы. +Grafana читает три источника и автоматически загружает дашборд. +История хранится 72 часа в именованных томах. -Учётные данные PostgreSQL, Redis, MinIO и RabbitMQ передаются через файловые -секреты Compose. Схему создаёт migrate, bucket и права — minio-bootstrap, -устойчивую очередь объявляют publisher и worker. +API сохраняет W3C `traceparent` и `tracestate` вместе с заданием. Publisher +создаёт дочерний producer span и передаёт контекст через заголовки RabbitMQ. +Каждая попытка получает свой consumer span в той же трассе. Успешная попытка +добавляет операции чтения и записи S3 и фиксации `ready` в PostgreSQL. -API, publisher и worker отправляют OTLP HTTP/protobuf в Collector 0.165.0. -Prometheus 3.16.0 собирает метрики, Loki 3.7.10 хранит структурные логи, -Tempo 2.9.0 хранит трассы. Grafana 13.3.1 читает три источника и загружает -дашборд из репозитория. История хранится в именованных томах, срок хранения 72 ч. -`deployment.environment.name` берётся из `APP_ENV`. В проверенном стенде -использовано значение `development`. - -При приёме вложения в транзакции сохраняются только W3C `traceparent` и -`tracestate` из текущего контекста. Publisher создаёт producer span как -потомка HTTP upload и переносит его контекст в заголовки AMQP. Каждая попытка, -в том числе после retry или replay, получает собственный дочерний consumer -span со своим номером и исходом. Успешная попытка показывает чтение staging, -запись объектов S3 и фиксацию ready в PostgreSQL. У старых строк контекст -может отсутствовать, обработка сохраняется. - -В логах есть timestamp, severity, event и trace/span ID. HTTP-ответ и лог -связаны через X-Request-Id, лог и трасса — через TraceID. У метрик только -ограниченные значения route template, method, status class, queue, job type -и outcome. Идентификаторы файлов используются в логах получения задания -для поиска нужной попытки. Тексты сообщений, пароли, токены, URL с -подписью, SQL и содержимое файлов в телеметрию не передаются. +HTTP-ответ и лог связаны по `X-Request-Id`, лог и трасса — по `trace_id`. +Метрики группируются по шаблону маршрута, методу, классу ответа, очереди, +типу и исходу задания. ID отдельных объектов используются для поиска в +логах, а тексты сообщений, секреты и содержимое файлов в телеметрию не передаются. ## Метрики и цели @@ -83,14 +62,11 @@ span со своим номером и исходом. Успешная попы | До готовности вложения | `histogram_quantile(0.95, sum by(le)(rate(messenger_job_time_to_ready_seconds_bucket[5m])))` | с | | Экспорт Collector | `otelcol_exporter_queue_size`, `otelcol_exporter_queue_capacity` | пакеты | -Очередь измеряется по устойчивому состоянию `queued` в PostgreSQL, включая -ещё не опубликованные и отложенные попытки. Возраст считается от первичного -принятия. Время до ready измеряется для успешных заданий от записи принятия -до фиксации ready, включая ожидание и повторы. Гистограммы объединяются по -границам buckets перед вычислением процентиля. CPU и RSS относятся к процессу -Python и не включают подпроцесс resize. -Суффикс `_ratio` добавляет экспортёр Prometheus для безразмерного unit `1`. -Для глубины очереди и пула эти ряды содержат абсолютные количества. +Глубина очереди — число заданий в состоянии `queued` в PostgreSQL, +включая отложенные повторы. Возраст считается от первого приёма. +Время до `ready` включает ожидание и повторы. Процентили вычисляются +по объединённой гистограмме всех реплик. Ряды глубины и пула с суффиксом +`_ratio` содержат абсолютные количества. SLI доступности — доля бизнес-запросов без 5xx. SLO — ≥99% за скользящие 24 часа. Для проверки используйте отношение сумм `increase(...[24h])`, @@ -103,65 +79,29 @@ SLI доступности — доля бизнес-запросов без 5xx ## Диагностика инцидентов -1. **Рост 5xx.** В Grafana сопоставить частоту запросов, долю 5xx и задержку. - По X-Request-Id найти связанный лог и открыть TraceID. Ошибка на - `postgres.checkout` вместе с событием `dependency.unavailable` - указывает на проблему получения соединения с БД. После восстановления - проверить `/health/ready` и исчезновение firing. -2. **Растёт очередь.** Сверить глубину, возраст и занятость worker. При - остановленном worker задания принимаются, а новые попытки не появляются. - После восстановления проверить уменьшение очереди и исчезновение firing. - В Tempo открыть трассу upload и сравнить исходы отдельных попыток, затем - проверить spans S3/БД и состояние ready. -3. **Недоступен Loki.** Prometheus продолжает собирать бизнес-метрики и - внутренние метрики Collector. Сравнить число успешных сообщений, RSS, - размер экспортной очереди и прирост счётчиков отказа экспорта/постановки - в очередь. После старта Loki проверить появление новых связанных логов. +| Инцидент | Как найти причину и подтвердить восстановление | +| --- | --- | +| PostgreSQL остановлен | Рост 5xx → лог по `X-Request-Id` → ERROR span `postgres.checkout` в связанной трассе. Оповещение вошло в firing через 32,4 с и снялось через 67,5 с от начала сценария. Готовность API восстановилась. | +| Worker остановлен | Растёт возраст очереди, новые попытки отсутствуют. Оповещение сработало через 28,6 с после приёма. После пяти временных ошибок и ручного replay шестая попытка завершилась `ready`, глубина вернулась к нулю, оповещение снялось. В трассе `ff8352e27270fbc16fea7216c3ff45c0` видны все попытки и операции S3/БД. | +| Loki остановлен | В Prometheus смотрим бизнес-запросы, RSS и экспортную очередь Collector. За 51 с записано 204 сообщения, потеряно 6 логов после повторов отправки. Пик очереди — 48 из 256 пакетов, RSS — 228–231 MiB. После запуска Loki найден новый связанный лог. | -Collector использует memory limiter 192 MiB со spike 32 MiB, пакетирование до -256 записей, очередь 256 пакетов на экспортёр, по два потребителя -на очередь и до 30 с повторов доставки. Контейнер ограничен 256 MiB. SDK -имеет ограниченные очереди span/log и таймауты. Потери считаются по -счётчикам Collector для остановленного Loki. Общие потери вне Collector -этими счётчиками не измеряются. +Collector использует memory limiter (192 MiB, запас для всплесков 32 MiB), +пакеты до 256 записей, очереди по 256 пакетов для Loki и Tempo и повторы +до 30 с. Лимит контейнера — 256 MiB. Потери измерены по счётчикам Collector +для этого короткого отказа. ## Полный прогон -`make verify` поднимает один отдельный стенд с телеметрией, выполняет регрессию, -smoke, нагрузку, проверку сквозных трасс, оповещений и восстановления после -отказов, а также persistence/failover. В конце удаляются контейнеры, сеть и -тома только проверочного проекта. Настройки, общий кэш образов и данные -основного стенда сохраняются. +`make verify` запускает регрессию, smoke, нагрузку, сценарии отказов, +проверки сохранности и переключения реплик на отдельном стенде, затем +удаляет его контейнеры, сеть и тома. -Результаты прогона от 19.11.2026 сохранены в [журнале проверок](evidence/verification.json) -и [доказательствах наблюдаемости](evidence/observability.json). -Итог **PASS**, с 18:50 до 19:03 МСК. Контракт, OpenAPI, конфигурация и запуск -Compose, публичный smoke, наблюдаемость, persistence и failover прошли. -Регрессия: 206 тестов за 98,89 с. Инвентаризация после очистки показала -0 контейнеров, 0 сетей и 0 томов проверочного проекта. +Прогон 19.11.2026, 18:50–19:03 МСК — **PASS**. Регрессия: **206 тестов** +за 98,89 с. Нагрузка: 100 успешных сообщений, 0 ошибок, около 10 запросов/с. +Клиентские p50/p95/p99 — 18,0 / 39,6 / 46,0 мс. Проверены панели, связность +трасс и логов, приватность и сохранение истории после перезапуска. +Доказательства сохранены в [журнале проверок](evidence/verification.json) +и [результатах наблюдаемости](evidence/observability.json). -Нагрузка: 100 успешных сообщений, 0 ошибок, 10,078 запроса/с. Клиентские -p50/p95/p99 — 18,036 / 39,623 / 45,954 мс. Проверены все запросы панелей, -корреляция логов и трасс, отсутствие запрещённых полей и сохранение истории -после перезапуска хранилищ. В выборке приватности 413 логов. - -| Сценарий | Что зафиксировал прогон | -| --- | --- | -| PostgreSQL остановлен | HTTP 503, связанный ERROR span `postgres.checkout` и `dependency.unavailable` с `TimeoutError`. Firing замечен через 32,4 с от начала сценария, снятие — через 67,5 с. Trace ID `020e820d68045ad3195e842244670b11`. | -| Worker остановлен | Глубина 1, возраст 25,6 с на момент проверки. Firing замечен через 28,6 с после приёма задания. После исчерпания пяти инъецированных временных ошибок оператор выполнил replay, шестая попытка завершилась `ready`, глубина вернулась к 0, оповещение снялось. | -| Loki остановлен | 204 сообщения записаны при недоступных логах. За 51 с измерено 6 записей, потерянных после повторов экспорта, и 0 отказов постановки в очередь. Пик очереди 48 из 256 пакетов, RSS 228–231 MiB при лимите 256 MiB. После запуска Loki найден новый лог со связанной трассой. | - -Трасса повтора в Tempo — `ff8352e27270fbc16fea7216c3ff45c0`. В ней проверены -родительские связи HTTP upload → `rabbitmq.publish` → `attachment.process.v1` -для всех попыток и spans `s3.read_staging`, `s3.write_result`, -`postgres.commit_ready` успешной попытки. Контрольная трасса без инъекции — -`ad41b35e5e8b02c32f7a7b74d7b6278a`. После очистки их идентификаторы и дерево -spans остаются в JSON с доказательствами. - -## Ограничения - -Один Docker-host без высокой доступности и защиты от потери диска. -Контролируемая нагрузка проверяет сценарии и пригодность диагностики. -Долговременное соблюдение SLO требует наблюдения за полным 24-часовым окном. -В сценарии Loki измерен краткий отказ. Замеры RSS показывают небольшой рост, -а верхняя граница памяти обеспечивается настройками очередей и лимитом контейнера. +Стенд работает на одном Docker-хосте. Соблюдение SLO требует наблюдения +за полным 24-часовым окном. -- 2.54.0