File size: 14,196 Bytes
6aecb2e | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 | """
Database configuration and session management
"""
import os
import re
import logging
from urllib.parse import urlparse
from sqlalchemy import create_engine, text
from sqlalchemy.exc import OperationalError
from sqlalchemy.orm import sessionmaker
from sqlalchemy.ext.asyncio import create_async_engine, AsyncSession, async_sessionmaker
from ..core.config import app_config
logger = logging.getLogger(__name__)
DEFAULT_DATABASE_URL = "sqlite:///./landppt.db"
SQLITE_FALLBACK_URL = DEFAULT_DATABASE_URL
LEGACY_DOCKER_POSTGRES_URL = "postgresql://landppt:landppt@postgres:5432/landppt"
LEGACY_DOCKER_POSTGRES_URL_ALT = "postgres://landppt:landppt@postgres:5432/landppt"
def _resolve_database_urls(database_url: str) -> tuple[str, str, dict, dict, int, int]:
"""Build sync/async database URLs and engine settings from one URL."""
if database_url.startswith("sqlite:///"):
async_database_url = database_url.replace("sqlite:///", "sqlite+aiosqlite:///")
return (
database_url,
async_database_url,
{"check_same_thread": False, "timeout": 30},
{"timeout": 30},
100,
200,
)
if database_url.startswith("postgresql://"):
return (
database_url,
database_url.replace("postgresql://", "postgresql+asyncpg://"),
{},
{},
20,
40,
)
if database_url.startswith("postgres://"):
sync_url = database_url.replace("postgres://", "postgresql://")
return (
sync_url,
database_url.replace("postgres://", "postgresql+asyncpg://"),
{},
{},
20,
40,
)
return (database_url, database_url, {}, {}, 20, 40)
def _is_fallback_eligible_postgres_url(original_url: str) -> bool:
normalized_url = str(original_url or "").strip()
if normalized_url in {LEGACY_DOCKER_POSTGRES_URL, LEGACY_DOCKER_POSTGRES_URL_ALT}:
return True
try:
hostname = (urlparse(normalized_url).hostname or "").strip().lower()
except Exception:
hostname = ""
return hostname == "postgres"
def _is_postgres_connectivity_error(exc: Exception) -> bool:
if not isinstance(exc, OperationalError):
return False
message = str(exc or "").lower()
keywords = (
"could not translate host name",
"name or service not known",
"temporary failure in name resolution",
"connection refused",
"timed out",
"timeout expired",
"could not connect to server",
"connection to server at",
"nodename nor servname provided",
"no address associated with hostname",
)
return any(keyword in message for keyword in keywords)
def _should_fallback_to_sqlite(exc: Exception, original_url: str) -> bool:
missing_driver = isinstance(exc, ModuleNotFoundError) and exc.name in {"psycopg2", "asyncpg"}
connectivity_error = _is_postgres_connectivity_error(exc)
fallback_eligible_url = _is_fallback_eligible_postgres_url(original_url)
if not fallback_eligible_url:
return False
return missing_driver or connectivity_error
def _create_sync_engine(sync_database_url: str, sync_connect_args: dict, pool_size: int, max_overflow: int):
return create_engine(
sync_database_url,
connect_args=sync_connect_args,
echo=False, # Disable SQL logging to reduce noise
pool_pre_ping=True, # Verify connections before using
pool_size=pool_size,
max_overflow=max_overflow,
)
def _validate_database_connection(sync_engine, sync_database_url: str) -> None:
if not str(sync_database_url or "").startswith(("postgresql://", "postgres://")):
return
with sync_engine.connect() as connection:
connection.execute(text("SELECT 1"))
def _build_async_engine(async_database_url: str, async_connect_args: dict):
return create_async_engine(
async_database_url,
echo=False, # Disable SQL logging to reduce noise
pool_pre_ping=True,
connect_args=async_connect_args if "sqlite" in async_database_url else {}
)
def _qident(value: str) -> str:
"""Quote a PostgreSQL identifier safely."""
return '"' + (str(value or "").replace('"', '""')) + '"'
def _extract_duplicate_pg_type_name(exc: Exception) -> str | None:
"""
Extract the conflicting PostgreSQL composite type name from a duplicate-type error.
Example detail:
Key (typname, typnamespace)=(invite_codes, 2200) already exists.
"""
message = str(exc or "")
if "pg_type_typname_nsp_index" not in message:
return None
match = re.search(
r"Key \(typname, typnamespace\)=\(([^,]+),\s*\d+\) already exists",
message,
)
if not match:
return None
return (match.group(1) or "").strip().strip('"') or None
def _drop_postgres_orphan_composite_type(connection, table_name: str, schema: str = "public") -> bool:
"""
Drop an orphan PostgreSQL composite type left behind by a failed CREATE TABLE.
PostgreSQL creates a composite row type per table. In rare broken states, the
type can exist without the table relation, which later causes:
pg_type_typname_nsp_index duplicate key errors on CREATE TABLE.
"""
dialect_name = getattr(getattr(connection, "dialect", None), "name", "")
if dialect_name != "postgresql":
return False
table_name = (table_name or "").strip()
schema = (schema or "public").strip() or "public"
if not table_name:
return False
orphan_type_oid = connection.execute(
text(
"""
SELECT t.oid
FROM pg_type t
JOIN pg_namespace n
ON n.oid = t.typnamespace
LEFT JOIN pg_class c
ON c.oid = t.typrelid
AND c.relnamespace = t.typnamespace
AND c.relname = t.typname
AND c.relkind IN ('r', 'p')
WHERE n.nspname = :schema
AND t.typname = :table_name
AND t.typtype = 'c'
AND c.oid IS NULL
"""
),
{"schema": schema, "table_name": table_name},
).scalar()
if not orphan_type_oid:
return False
connection.execute(
text(f"DROP TYPE IF EXISTS {_qident(schema)}.{_qident(table_name)} CASCADE")
)
logger.warning(
"Dropped orphan PostgreSQL composite type for missing table: %s.%s",
schema,
table_name,
)
return True
def _drop_orphan_postgres_table_types(connection, metadata) -> None:
"""Best-effort cleanup for orphan PostgreSQL composite types in metadata tables."""
from sqlalchemy import inspect
if getattr(getattr(connection, "dialect", None), "name", "") != "postgresql":
return
inspector = inspect(connection)
for table in metadata.sorted_tables:
table_name = getattr(table, "name", None)
if not table_name:
continue
schema = getattr(table, "schema", None) or "public"
try:
if inspector.has_table(table_name, schema=schema):
continue
except Exception:
# If inspection fails, do not risk destructive cleanup.
continue
try:
_drop_postgres_orphan_composite_type(connection, table_name=table_name, schema=schema)
except Exception:
# Best-effort only; create_all may still fail and surface the real error.
continue
def _resolve_metadata_schema_for_type_name(metadata, type_name: str) -> str:
"""Resolve a metadata table name back to its schema, defaulting to public."""
normalized = (type_name or "").strip()
if not normalized:
return "public"
for table in metadata.sorted_tables:
if getattr(table, "name", None) == normalized:
return getattr(table, "schema", None) or "public"
return "public"
class _MissingAsyncSessionFactory:
def __init__(self, error: Exception):
self._error = error
def __call__(self, *args, **kwargs):
raise RuntimeError(
"Async database session is unavailable because the async database driver is not installed"
) from self._error
# Create database URL
configured_database_url = app_config.database_url
selected_database_url = configured_database_url
DATABASE_URL, ASYNC_DATABASE_URL, connect_args, async_connect_args, pool_size, max_overflow = (
_resolve_database_urls(selected_database_url)
)
try:
engine = _create_sync_engine(DATABASE_URL, connect_args, pool_size, max_overflow)
_validate_database_connection(engine, DATABASE_URL)
except Exception as exc:
if not _should_fallback_to_sqlite(exc, configured_database_url):
raise
logger.warning(
"Default PostgreSQL backend is unavailable for %s; falling back to SQLite at %s",
configured_database_url,
SQLITE_FALLBACK_URL,
)
selected_database_url = SQLITE_FALLBACK_URL
DATABASE_URL, ASYNC_DATABASE_URL, connect_args, async_connect_args, pool_size, max_overflow = (
_resolve_database_urls(selected_database_url)
)
engine = _create_sync_engine(DATABASE_URL, connect_args, pool_size, max_overflow)
logger.info("Database backend selected: %s", DATABASE_URL)
try:
async_engine = _build_async_engine(ASYNC_DATABASE_URL, async_connect_args)
AsyncSessionLocal = async_sessionmaker(
async_engine,
class_=AsyncSession,
expire_on_commit=False
)
except Exception as exc:
if not isinstance(exc, ModuleNotFoundError) or exc.name not in {"asyncpg", "aiosqlite"}:
raise
logger.warning(
"Async database driver is unavailable for %s; async DB endpoints will be disabled until the driver is installed",
ASYNC_DATABASE_URL,
)
async_engine = None
AsyncSessionLocal = _MissingAsyncSessionFactory(exc)
# Create session makers
SessionLocal = sessionmaker(
autocommit=False,
autoflush=False,
bind=engine,
expire_on_commit=False # Prevent errors after commit
)
def get_db():
"""Dependency to get database session"""
db = SessionLocal()
try:
yield db
finally:
db.close()
async def get_async_db():
"""Dependency to get async database session"""
if async_engine is None:
raise RuntimeError("Async database engine is unavailable")
async with AsyncSessionLocal() as session:
yield session
async def init_db():
"""Initialize database tables"""
# Import here to avoid circular imports
from .models import Base
import logging
from sqlalchemy import inspect
logger = logging.getLogger(__name__)
# PostgreSQL safety: pre-clean known orphan composite types before create_all.
async with async_engine.begin() as conn:
await conn.run_sync(lambda connection: _drop_orphan_postgres_table_types(connection, Base.metadata))
try:
async with async_engine.begin() as conn:
await conn.run_sync(Base.metadata.create_all, checkfirst=True)
except Exception as exc:
duplicate_type_name = _extract_duplicate_pg_type_name(exc)
if not duplicate_type_name:
raise
schema = _resolve_metadata_schema_for_type_name(Base.metadata, duplicate_type_name)
logger.warning(
"Detected PostgreSQL duplicate composite type during create_all for %s.%s; "
"attempting orphan-type cleanup and one retry",
schema,
duplicate_type_name,
)
async with async_engine.begin() as conn:
await conn.run_sync(
lambda connection: _drop_postgres_orphan_composite_type(
connection,
table_name=duplicate_type_name,
schema=schema,
)
)
async with async_engine.begin() as conn:
await conn.run_sync(Base.metadata.create_all, checkfirst=True)
# Check and add missing OAuth columns for existing databases
def add_missing_columns(connection):
inspector = inspect(connection)
if inspector.has_table("users"):
existing_columns = {col['name'] for col in inspector.get_columns("users")}
# Define columns to add if missing
columns_to_add = []
if 'github_id' not in existing_columns:
columns_to_add.append("ADD COLUMN github_id VARCHAR(50) UNIQUE")
if 'linuxdo_id' not in existing_columns:
columns_to_add.append("ADD COLUMN linuxdo_id VARCHAR(50) UNIQUE")
if 'oauth_provider' not in existing_columns:
columns_to_add.append("ADD COLUMN oauth_provider VARCHAR(20)")
if 'register_ip' not in existing_columns:
columns_to_add.append("ADD COLUMN register_ip VARCHAR(45)")
if 'last_login_ip' not in existing_columns:
columns_to_add.append("ADD COLUMN last_login_ip VARCHAR(45)")
if 'registration_channel' not in existing_columns:
columns_to_add.append("ADD COLUMN registration_channel VARCHAR(20)")
if 'invite_code_id' not in existing_columns:
columns_to_add.append("ADD COLUMN invite_code_id INTEGER")
for col_sql in columns_to_add:
try:
connection.execute(text(f"ALTER TABLE users {col_sql}"))
logger.info(f"Added column to users table: {col_sql}")
except Exception as e:
# Column might already exist, ignore error
logger.debug(f"Column already exists or error: {e}")
async with async_engine.begin() as conn:
await conn.run_sync(add_missing_columns)
# Optionally bootstrap an initial admin user
from ..auth.auth_service import init_default_admin
db = SessionLocal()
try:
init_default_admin(db)
finally:
db.close()
async def close_db():
"""Close database connections"""
if async_engine is not None:
await async_engine.dispose()
|