Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions .env.dev
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# Postgres
POSTGRES_USER=postgres
POSTGRES_PASSWORD=postgres
POSTGRES_DB=test
POSTGRES_HOST=backend-db
PGPORT=5433
PGPORT=5432

# Celery / Redis
CELERY_BROKER_URL=redis://backend-redis:6379/0
RQ_BROKER_URL=redis://backend-redis:6379/0
19 changes: 19 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

ifneq (,$(wildcard ../.env.dev))
include .env.dev
export
endif


.PHONY: local
local:
docker compose -f docker-compose.dev.yml --env-file .env.dev up -d --build --force-recreate --remove-orphans

.PHONY: alembic-upgrade
alembic-upgrade:
docker exec -it backend uv run alembic upgrade head


.PHONY: alembic-upgrade-dack
alembic-upgrade-dack:
docker exec -it backend uv run alembic downgrade -1
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,26 @@
**Запуск:**
1. ```docker compose -f docker-compose.dev.yml up```
2. ```docker exec -it backend alembic upgrade head```

3. вынес в make

**Открыть фронт:** ```http://localhost:3000/test```

**Открыть бэк:** ```http://localhost:8000/docs```

# Что сделано (что запомнил)
- декомпозированы сущности (aler, file)
- добавлено URI Versioning
- поправлен фронт под версионированное апи
- добавлен менеджер бд для управления жизненными циклами engine и session_maker
- получение сессии реализовано через di
- сделана ленивая инициализация динамически формируемых полей (DB_URL, STORAGE_DIR)
- миграции вынесены по сущностям
- изменены типы полей первичных ключей, изменен запрос получения списка предупреждений
(на каждый алерт улетал запрос для подгрузки данных о файле)
- json изменен на jsonb (в мирации правил)
- поправлен композник
- добавлен процесс накатывания миграций

# Что можно доделать
- возможно также добавление use_case для разделения логики взаимодействия с базой от сервисного слоя
- возможно добавление uow и объектов репозиториев (да и в целом можно довести до луковичной но покачто избыточно как будто)
12 changes: 12 additions & 0 deletions backend/.dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
*
!.env
!pyproject.toml
!cities.yaml
!uv.lock
!**/*.py
!**/*.html
!**/*.css
!**/*.js
!**/*.sh
!**/*.ini
!**/*.mako
2 changes: 1 addition & 1 deletion backend/.python-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.14
3.12
2 changes: 1 addition & 1 deletion backend/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM python:3.14-slim
FROM python:3.12-slim

ENV PYTHONDONTWRITEBYTECODE=1 \
PYTHONUNBUFFERED=1 \
Expand Down
24 changes: 24 additions & 0 deletions backend/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@

ifneq (,$(wildcard ../.env.dev))
include ../.env.dev
export
endif

.PHONY: lint
lint:
ruff check --fix
ruff format

.PHONY: alembic-revision
alembic-revision:
POSTGRES_HOST=127.0.0.1 uv run alembic revision --autogenerate


.PHONY: alembic-upgrade
alembic-upgrade:
POSTGRES_HOST=127.0.0.1 uv run alembic upgrade head

# почитать что куда по апгрейду и дауну
.PHONY: alembic-upgrade-dack
alembic-upgrade-dack:
POSTGRES_HOST=127.0.0.1 uv run alembic downgrade -1
123 changes: 13 additions & 110 deletions backend/alembic.ini
Original file line number Diff line number Diff line change
@@ -1,119 +1,11 @@
# A generic, single database configuration.

[alembic]
# path to migration scripts.
# this is typically a path given in POSIX (e.g. forward slashes)
# format, relative to the token %(here)s which refers to the location of this
# ini file
script_location = %(here)s/migrations

# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
# Uncomment the line below if you want the files to be prepended with date and time
# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
# for all available tokens
# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
# Or organize into date-based subdirectories (requires recursive_version_locations = true)
# file_template = %%(year)d/%%(month).2d/%%(day).2d_%%(hour).2d%%(minute).2d_%%(second).2d_%%(rev)s_%%(slug)s
file_template = %%(year)d-%%(month).2d-%%(day).2d-%%(hour).2d-%%(minute).2d-%%(rev)s
script_location = %(here)s/migrations

# sys.path path, will be prepended to sys.path if present.
# defaults to the current working directory. for multiple paths, the path separator
# is defined by "path_separator" below.
prepend_sys_path = .


# timezone to use when rendering the date within the migration file
# as well as the filename.
# If specified, requires the tzdata library which can be installed by adding
# `alembic[tz]` to the pip requirements.
# string value is passed to ZoneInfo()
# leave blank for localtime
# timezone =

# max length of characters to apply to the "slug" field
# truncate_slug_length = 40

# set to 'true' to run the environment during
# the 'revision' command, regardless of autogenerate
# revision_environment = false

# set to 'true' to allow .pyc and .pyo files without
# a source .py file to be detected as revisions in the
# versions/ directory
# sourceless = false

# version location specification; This defaults
# to <script_location>/versions. When using multiple version
# directories, initial revisions must be specified with --version-path.
# The path separator used here should be the separator specified by "path_separator"
# below.
# version_locations = %(here)s/bar:%(here)s/bat:%(here)s/alembic/versions

# path_separator; This indicates what character is used to split lists of file
# paths, including version_locations and prepend_sys_path within configparser
# files such as alembic.ini.
# The default rendered in new alembic.ini files is "os", which uses os.pathsep
# to provide os-dependent path splitting.
#
# Note that in order to support legacy alembic.ini files, this default does NOT
# take place if path_separator is not present in alembic.ini. If this
# option is omitted entirely, fallback logic is as follows:
#
# 1. Parsing of the version_locations option falls back to using the legacy
# "version_path_separator" key, which if absent then falls back to the legacy
# behavior of splitting on spaces and/or commas.
# 2. Parsing of the prepend_sys_path option falls back to the legacy
# behavior of splitting on spaces, commas, or colons.
#
# Valid values for path_separator are:
#
# path_separator = :
# path_separator = ;
# path_separator = space
# path_separator = newline
#
# Use os.pathsep. Default configuration used for new projects.
path_separator = os

# set to 'true' to search source files recursively
# in each "version_locations" directory
# new in Alembic version 1.10
# recursive_version_locations = false

# the output encoding used when revision files
# are written from script.py.mako
# output_encoding = utf-8

# database URL. This is consumed by the user-maintained env.py script only.
# other means of configuring database URLs may be customized within the env.py
# file.
sqlalchemy.url = driver://user:pass@localhost/dbname


[post_write_hooks]
# post_write_hooks defines scripts or Python functions that are run
# on newly generated revision scripts. See the documentation for further
# detail and examples

# format using "black" - use the console_scripts runner, against the "black" entrypoint
# hooks = black
# black.type = console_scripts
# black.entrypoint = black
# black.options = -l 79 REVISION_SCRIPT_FILENAME

# lint with attempts to fix using "ruff" - use the module runner, against the "ruff" module
# hooks = ruff
# ruff.type = module
# ruff.module = ruff
# ruff.options = check --fix REVISION_SCRIPT_FILENAME

# Alternatively, use the exec runner to execute a binary found on your PATH
# hooks = ruff
# ruff.type = exec
# ruff.executable = ruff
# ruff.options = check --fix REVISION_SCRIPT_FILENAME

# Logging configuration. This is also consumed by the user-maintained
# env.py script only.
[loggers]
keys = root,sqlalchemy,alembic

Expand Down Expand Up @@ -147,3 +39,14 @@ formatter = generic
[formatter_generic]
format = %(levelname)-5.5s [%(name)s] %(message)s
datefmt = %H:%M:%S

[post_write_hooks]
hooks = ruff_fix, ruff_format

ruff_fix.type = exec
ruff_fix.executable = uv
ruff_fix.options = run ruff check --fix REVISION_SCRIPT_FILENAME

ruff_format.type = exec
ruff_format.executable = uv
ruff_format.options = run ruff format REVISION_SCRIPT_FILENAME
5 changes: 2 additions & 3 deletions backend/migrations/env.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,13 @@
from sqlalchemy.engine import Connection
from sqlalchemy.ext.asyncio import async_engine_from_config
from alembic import context
from src.service import DB_URL
from src.settings import settings
from src.models import Base
import src.models

# this is the Alembic Config object, which provides
# access to the values within the .ini file in use.
config = context.config
config.set_main_option('sqlalchemy.url', DB_URL)
config.set_main_option("sqlalchemy.url", settings.DB_URL)

# Interpret the config file for Python logging.
# This line sets up loggers basically.
Expand Down
58 changes: 0 additions & 58 deletions backend/migrations/versions/0d6439d2e79f_init.py

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
"""empty message

Revision ID: d435d591f1b4
Revises:
Create Date: 2026-07-10 04:30:19.245161

"""

from typing import Sequence, Union

import sqlalchemy as sa
import uuid_utils
from alembic import op
from sqlalchemy.dialects import postgresql

# revision identifiers, used by Alembic.
revision: str = "d435d591f1b4"
down_revision: Union[str, Sequence[str], None] = None
branch_labels: Union[str, Sequence[str], None] = None
depends_on: Union[str, Sequence[str], None] = None


def upgrade() -> None:
"""Upgrade schema."""
# ### commands auto generated by Alembic - please adjust! ###
op.create_table(
"file",
sa.Column("id", sa.UUID(), default=uuid_utils.uuid7, nullable=False),
sa.Column("title", sa.String(length=255), nullable=False),
sa.Column("original_name", sa.String(length=255), nullable=False),
sa.Column("stored_name", sa.String(length=255), nullable=False),
sa.Column("mime_type", sa.String(length=255), nullable=False),
sa.Column("size", sa.Integer(), nullable=False),
sa.Column("processing_status", sa.String(length=50), nullable=False),
sa.Column("scan_status", sa.String(length=50), nullable=True),
sa.Column("scan_details", sa.String(length=500), nullable=True),
sa.Column("metadata_json", postgresql.JSONB(), nullable=True),
sa.Column("requires_attention", sa.Boolean(), nullable=False),
sa.Column(
"created_at",
sa.DateTime(timezone=True),
server_default=sa.text("now()"),
nullable=False,
),
sa.Column(
"updated_at",
sa.DateTime(timezone=True),
server_default=sa.text("now()"),
nullable=False,
),
sa.PrimaryKeyConstraint("id"),
sa.UniqueConstraint("stored_name"),
)
# ### end Alembic commands ###


def downgrade() -> None:
"""Downgrade schema."""
# ### commands auto generated by Alembic - please adjust! ###
op.drop_table("file")
# ### end Alembic commands ###
Loading