diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..848787e --- /dev/null +++ b/alembic.ini @@ -0,0 +1,149 @@ +# 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/alembic + +# 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 + +# 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 /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 = + + +[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 + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARNING +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARNING +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/alembic/README b/alembic/README new file mode 100644 index 0000000..e0d0858 --- /dev/null +++ b/alembic/README @@ -0,0 +1 @@ +Generic single-database configuration with an async dbapi. \ No newline at end of file diff --git a/alembic/env.py b/alembic/env.py new file mode 100644 index 0000000..22fea51 --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,91 @@ +import asyncio +from logging.config import fileConfig + +from alembic import context +from sqlalchemy.engine import Connection +from sqlalchemy.ext.asyncio import create_async_engine + +from proxy_pool.accounts import models as _account_models # noqa: F401 +from proxy_pool.config import get_settings +from proxy_pool.db.base import Base + +# Import all models +from proxy_pool.proxy import models as _proxy_models # noqa: F401 + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +if config.config_file_name is not None: + fileConfig(config.config_file_name) + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +target_metadata = Base.metadata + +# other values from the config, defined by the needs of env.py, +# can be acquired: +# my_important_option = config.get_main_option("my_important_option") +# ... etc. + + +def run_migrations_offline() -> None: + """Run migrations in 'offline' mode. + + This configures the context with just a URL + and not an Engine, though an Engine is acceptable + here as well. By skipping the Engine creation + we don't even need a DBAPI to be available. + + Calls to context.execute() here emit the given string to the + script output. + + """ + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, + target_metadata=target_metadata, + literal_binds=True, + dialect_opts={"paramstyle": "named"}, + ) + + with context.begin_transaction(): + context.run_migrations() + + +def do_run_migrations(connection: Connection) -> None: + context.configure(connection=connection, target_metadata=target_metadata) + + with context.begin_transaction(): + context.run_migrations() + + +async def run_async_migrations() -> None: + """In this scenario we need to create an Engine + and associate a connection with the context. + + """ + + settings = get_settings() + connectable = create_async_engine(settings.database_url) + + async with connectable.connect() as connection: + await connection.run_sync(do_run_migrations) + + await connectable.dispose() + + +def run_migrations_online() -> None: + """Run migrations in 'online' mode.""" + + asyncio.run(run_async_migrations()) + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/alembic/script.py.mako b/alembic/script.py.mako new file mode 100644 index 0000000..1101630 --- /dev/null +++ b/alembic/script.py.mako @@ -0,0 +1,28 @@ +"""${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 identifiers, used by Alembic. +revision: str = ${repr(up_revision)} +down_revision: Union[str, Sequence[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: + """Upgrade schema.""" + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + """Downgrade schema.""" + ${downgrades if downgrades else "pass"} diff --git a/alembic/versions/854325b9cbe6_initial_schema.py b/alembic/versions/854325b9cbe6_initial_schema.py new file mode 100644 index 0000000..198b3b3 --- /dev/null +++ b/alembic/versions/854325b9cbe6_initial_schema.py @@ -0,0 +1,152 @@ +"""initial schema + +Revision ID: 854325b9cbe6 +Revises: +Create Date: 2026-03-14 13:48:44.859635 + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa +from sqlalchemy.dialects import postgresql + +# revision identifiers, used by Alembic. +revision: str = '854325b9cbe6' +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('proxy_sources', + sa.Column('url', sa.String(length=2048), nullable=False), + sa.Column('parser_name', sa.String(length=64), nullable=False), + sa.Column('cron_schedule', sa.String(length=64), nullable=True), + sa.Column('default_protocol', postgresql.ENUM('HTTP', 'HTTPS', 'SOCKS4', 'SOCKS5', name='proxy_protocol'), nullable=False), + sa.Column('is_active', sa.Boolean(), nullable=False), + sa.Column('last_scraped_at', sa.DateTime(), nullable=True), + sa.Column('id', sa.Uuid(), nullable=False), + sa.Column('created_at', sa.DateTime(), server_default=sa.text('now()'), nullable=False), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('url') + ) + op.create_table('users', + sa.Column('email', sa.String(length=320), nullable=False), + sa.Column('display_name', sa.String(length=128), nullable=True), + sa.Column('is_active', sa.Boolean(), nullable=False), + sa.Column('id', sa.Uuid(), nullable=False), + sa.Column('created_at', sa.DateTime(), server_default=sa.text('now()'), nullable=False), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('email') + ) + op.create_table('api_keys', + sa.Column('user_id', sa.Uuid(), nullable=False), + sa.Column('key_hash', sa.String(length=128), nullable=False), + sa.Column('prefix', sa.String(length=8), nullable=False), + sa.Column('label', sa.String(length=128), nullable=True), + sa.Column('is_active', sa.Boolean(), nullable=False), + sa.Column('last_used_at', sa.DateTime(), nullable=True), + sa.Column('expires_at', sa.DateTime(), nullable=True), + sa.Column('id', sa.Uuid(), nullable=False), + sa.Column('created_at', sa.DateTime(), server_default=sa.text('now()'), nullable=False), + sa.ForeignKeyConstraint(['user_id'], ['users.id'], ondelete='CASCADE'), + sa.PrimaryKeyConstraint('id') + ) + op.create_index('ix_api_keys_hash', 'api_keys', ['key_hash'], unique=True) + op.create_index('ix_api_keys_prefix', 'api_keys', ['prefix'], unique=False) + op.create_table('credit_ledger', + sa.Column('user_id', sa.Uuid(), nullable=False), + sa.Column('amount', sa.Integer(), nullable=False), + sa.Column('tx_type', postgresql.ENUM('PURCHASE', 'ACQUIRE', 'REFUND', 'ADMIN_ADJUST', name='credit_tx_type'), nullable=False), + sa.Column('description', sa.Text(), nullable=True), + sa.Column('reference_id', sa.Uuid(), nullable=True), + sa.Column('id', sa.Uuid(), nullable=False), + sa.Column('created_at', sa.DateTime(), server_default=sa.text('now()'), nullable=False), + sa.ForeignKeyConstraint(['user_id'], ['users.id'], ondelete='CASCADE'), + sa.PrimaryKeyConstraint('id') + ) + op.create_index('ix_ledger_user_created', 'credit_ledger', ['user_id', 'created_at'], unique=False) + op.create_table('proxies', + sa.Column('ip', postgresql.INET(), nullable=False), + sa.Column('port', sa.Integer(), nullable=False), + sa.Column('protocol', postgresql.ENUM('HTTP', 'HTTPS', 'SOCKS4', 'SOCKS5', name='proxy_protocol'), nullable=False), + sa.Column('source_id', sa.Uuid(), nullable=False), + sa.Column('status', postgresql.ENUM('UNCHECKED', 'ACTIVE', 'DEAD', name='proxy_status'), nullable=False), + sa.Column('anonymity', postgresql.ENUM('TRANSPARENT', 'ANONYMOUS', 'ELITE', name='anonymity_level'), nullable=True), + sa.Column('exit_ip', postgresql.INET(), nullable=True), + sa.Column('country', sa.String(length=2), nullable=True), + sa.Column('score', sa.Float(), nullable=False), + sa.Column('avg_latency_ms', sa.Float(), nullable=True), + sa.Column('uptime_pct', sa.Float(), nullable=True), + sa.Column('first_seen_at', sa.DateTime(), server_default=sa.text('now()'), nullable=False), + sa.Column('last_checked_at', sa.DateTime(), nullable=True), + sa.Column('id', sa.Uuid(), nullable=False), + sa.Column('created_at', sa.DateTime(), server_default=sa.text('now()'), nullable=False), + sa.ForeignKeyConstraint(['source_id'], ['proxy_sources.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.create_index('ix_proxies_ip_port_proto', 'proxies', ['ip', 'port', 'protocol'], unique=True) + op.create_index('ix_proxies_status_score', 'proxies', ['status', 'score'], unique=False) + op.create_table('proxy_checks', + sa.Column('proxy_id', sa.Uuid(), nullable=False), + sa.Column('checker_name', sa.String(length=64), nullable=False), + sa.Column('stage', sa.Integer(), nullable=False), + sa.Column('passed', sa.Boolean(), nullable=False), + sa.Column('latency_ms', sa.Float(), nullable=True), + sa.Column('detail', sa.Text(), nullable=True), + sa.Column('exit_ip', postgresql.INET(), nullable=True), + sa.Column('id', sa.Uuid(), nullable=False), + sa.Column('created_at', sa.DateTime(), server_default=sa.text('now()'), nullable=False), + sa.ForeignKeyConstraint(['proxy_id'], ['proxies.id'], ondelete='CASCADE'), + sa.PrimaryKeyConstraint('id') + ) + op.create_index('ix_checks_proxy_created', 'proxy_checks', ['proxy_id', 'created_at'], unique=False) + op.create_table('proxy_leases', + sa.Column('user_id', sa.Uuid(), nullable=False), + sa.Column('proxy_id', sa.Uuid(), nullable=False), + sa.Column('acquired_at', sa.DateTime(), server_default=sa.text('now()'), nullable=False), + sa.Column('expires_at', sa.DateTime(), nullable=False), + sa.Column('is_released', sa.Boolean(), nullable=False), + sa.Column('id', sa.Uuid(), nullable=False), + sa.ForeignKeyConstraint(['proxy_id'], ['proxies.id'], ), + sa.ForeignKeyConstraint(['user_id'], ['users.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.create_index('ix_leases_proxy_active', 'proxy_leases', ['proxy_id', 'is_released'], unique=False) + op.create_index('ix_leases_user', 'proxy_leases', ['user_id'], unique=False) + op.create_table('proxy_tags', + sa.Column('proxy_id', sa.Uuid(), nullable=False), + sa.Column('key', sa.String(length=64), nullable=False), + sa.Column('value', sa.String(length=256), nullable=False), + sa.Column('id', sa.Uuid(), nullable=False), + sa.ForeignKeyConstraint(['proxy_id'], ['proxies.id'], ondelete='CASCADE'), + sa.PrimaryKeyConstraint('id') + ) + op.create_index('ix_tags_proxy_key', 'proxy_tags', ['proxy_id', 'key'], unique=True) + # ### end Alembic commands ### + + +def downgrade() -> None: + """Downgrade schema.""" + # ### commands auto generated by Alembic - please adjust! ### + op.drop_index('ix_tags_proxy_key', table_name='proxy_tags') + op.drop_table('proxy_tags') + op.drop_index('ix_leases_user', table_name='proxy_leases') + op.drop_index('ix_leases_proxy_active', table_name='proxy_leases') + op.drop_table('proxy_leases') + op.drop_index('ix_checks_proxy_created', table_name='proxy_checks') + op.drop_table('proxy_checks') + op.drop_index('ix_proxies_status_score', table_name='proxies') + op.drop_index('ix_proxies_ip_port_proto', table_name='proxies') + op.drop_table('proxies') + op.drop_index('ix_ledger_user_created', table_name='credit_ledger') + op.drop_table('credit_ledger') + op.drop_index('ix_api_keys_prefix', table_name='api_keys') + op.drop_index('ix_api_keys_hash', table_name='api_keys') + op.drop_table('api_keys') + op.drop_table('users') + op.drop_table('proxy_sources') + # ### end Alembic commands ### diff --git a/pyproject.toml b/pyproject.toml index b3ce14f..eebffe7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -47,6 +47,7 @@ asyncio_mode = "auto" [tool.ruff] src = ["src"] target-version = "py312" +extend-exclude = ["alembic"] [tool.ruff.lint] select = ["E", "F", "I", "N", "UP", "B", "A", "SIM"]