svc-infra 0.1.182__tar.gz → 0.1.184__tar.gz

{svc_infra-0.1.182 → svc_infra-0.1.184}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: svc-infra
-Version: 0.1.182
+Version: 0.1.184
 Summary: Infrastructure for building and deploying prod-ready services
 License: MIT
 Keywords: fastapi,sqlalchemy,alembic,auth,infra,async,pydantic

{svc_infra-0.1.182 → svc_infra-0.1.184}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "svc-infra"
-version = "0.1.182"
+version = "0.1.184"
 description = "Infrastructure for building and deploying prod-ready services"
 authors = ["Ali Khatami <aliikhatami94@gmail.com>"]
 license = "MIT"

svc_infra-0.1.184/src/svc_infra/api/fastapi/db/uniq.py

@@ -0,0 +1,82 @@
+from __future__ import annotations
+
+from typing import Iterable, Optional, Dict, Any, Callable
+from sqlalchemy import func, and_
+from sqlalchemy.ext.asyncio import AsyncSession
+
+from .repository import Repository
+from svc_infra.db.uniq import ColumnSpec, _as_tuple
+
+def make_uniqueness_hooks(
+        *,
+        model: type,
+        repo: Repository,
+        unique_cs: Iterable[ColumnSpec] = (),
+        unique_ci: Iterable[ColumnSpec] = (),
+        tenant_field: Optional[str] = None,
+        duplicate_message: str = "Duplicate resource violates uniqueness policy.",
+) -> tuple[
+    Callable[[Dict[str, Any]], Any],  # async pre_create(data) -> data
+    Callable[[Dict[str, Any]], Any],  # async pre_update(data) -> data
+]:
+    """Return (pre_create, pre_update) hooks that check duplicates *before* insert/update.
+
+    Usage with ServiceWithHooks:
+        pre_c, pre_u = make_uniqueness_hooks(model=User, repo=repo, unique_ci=["email"], tenant_field="tenant_id")
+        svc = ServiceWithHooks(repo, pre_create=pre_c, pre_update=pre_u)
+    """
+    cs_specs = [_as_tuple(s) for s in unique_cs]
+    ci_specs = [_as_tuple(s) for s in unique_ci]
+
+    def _build_wheres(data: Dict[str, Any]):
+        wheres = []
+
+        def col(name: str):
+            return getattr(model, name)
+
+        tenant_val = data.get(tenant_field) if tenant_field else None
+
+        # case-sensitive groups
+        for spec in cs_specs:
+            if not all(k in data for k in spec):
+                continue
+            parts = []
+            if tenant_field:
+                parts.append(col(tenant_field).is_(None) if tenant_val is None else col(tenant_field) == tenant_val)
+            for k in spec:
+                parts.append(col(k) == data[k])
+            wheres.append(and_(*parts))
+
+        # case-insensitive groups
+        for spec in ci_specs:
+            if not all(k in data for k in spec):
+                continue
+            parts = []
+            if tenant_field:
+                parts.append(col(tenant_field).is_(None) if tenant_val is None else col(tenant_field) == tenant_val)
+            for k in spec:
+                # compare lower(db_col) == lower(<value>) safely
+                parts.append(func.lower(col(k)) == func.lower(func.cast(data[k], col(k).type)))
+            wheres.append(and_(*parts))
+
+        return wheres
+
+    async def _deferred_check(session: AsyncSession, data: Dict[str, Any]):
+        wheres = _build_wheres(data)
+        for where in wheres:
+            if await repo.exists(session, where=[where]):
+                from fastapi import HTTPException
+                raise HTTPException(status_code=409, detail=duplicate_message)
+
+    async def _pre_create(data: Dict[str, Any]) -> Dict[str, Any]:
+        # store a coroutine to be awaited when a session is available in Service.create
+        data = dict(data)
+        data.setdefault("__uniq_check__", _deferred_check)
+        return data
+
+    async def _pre_update(data: Dict[str, Any]) -> Dict[str, Any]:
+        data = dict(data)
+        data.setdefault("__uniq_check__", _deferred_check)
+        return data
+
+    return _pre_create, _pre_update

{svc_infra-0.1.182 → svc_infra-0.1.184}/src/svc_infra/auth/user_default.py

@@ -1,7 +1,7 @@
 from typing import Any, Dict
 from fastapi import HTTPException
 from fastapi_users.password import PasswordHelper
-from sqlalchemy import func, and_, or_
+from sqlalchemy import func
 
 from svc_infra.api.fastapi.db.service_hooks import ServiceWithHooks
 from svc_infra.api.fastapi.db.repository import Repository

{svc_infra-0.1.182 → svc_infra-0.1.184}/src/svc_infra/db/templates/models_schemas/auth/models.py.tmpl

@@ -12,6 +12,7 @@ from sqlalchemy.ext.mutable import MutableDict, MutableList
 
 from svc_infra.db.base import ModelBase
 from svc_infra.auth.user_default import _pwd
+from svc_infra.db.uniq import make_unique_indexes
 
 
 class User(ModelBase):
@@ -60,23 +61,12 @@ class User(ModelBase):
         return f"<User id={self.id} email={self.email!r}>"
 
 
-# ---------- Uniqueness: case-insensitive email per-tenant ----------
-# Because tenant_id is Optional (nullable), use two partial unique indexes:
-# - When tenant_id IS NULL: email (lowercased) must be globally unique
-# - When tenant_id IS NOT NULL: (tenant_id, lower(email)) must be unique
-Index(
-    "uq_users_email_lower_global",
-    func.lower(User.email),
-    unique=True,
-    postgresql_where=User.tenant_id.is_(None),
-)
-Index(
-    "uq_users_email_lower_per_tenant",
-    func.lower(User.email),
-    User.tenant_id,
-    unique=True,
-    postgresql_where=User.tenant_id.isnot(None),
-)
-
-# Optional helper index for case-insensitive lookups (non-unique)
-Index("ix_users_email_lower", func.lower(User.email))
+# Unique indexes, including case-insensitive and/or tenant-scoped.
+for _ix in make_unique_indexes(
+    User,
+    unique_ci=["email"],            # case-insensitive unique email
+    tenant_field="tenant_id",       # scoped by tenant if provided
+):
+    # Simply iterating keeps them registered with the Table metadata.
+    # (No further action needed if you use Alembic autogenerate or metadata.create_all.)
+    pass

svc_infra-0.1.184/src/svc_infra/db/templates/models_schemas/entity/models.py.tmpl

@@ -0,0 +1,52 @@
+# models/${table_name}.py
+from __future__ import annotations
+from datetime import datetime
+from typing import Optional
+import uuid
+
+from sqlalchemy import String, Boolean, DateTime, JSON, Text, func
+from sqlalchemy.dialects.postgresql import UUID
+from sqlalchemy.orm import Mapped, mapped_column
+from sqlalchemy.ext.mutable import MutableDict
+
+from svc_infra.db.base import ModelBase
+from svc_infra.db.uniq import make_unique_indexes
+
+
+class ${Entity}(ModelBase):
+    __tablename__ = "${table_name}"
+
+    # identity
+    id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
+
+    # core fields
+    name: Mapped[str] = mapped_column(String(255), nullable=False, index=True)
+    description: Mapped[Optional[str]] = mapped_column(Text)
+
+${tenant_field}\
+${soft_delete_field}\
+    # misc (avoid attr name "metadata" clash)
+    extra: Mapped[dict] = mapped_column(MutableDict.as_mutable(JSON), default=dict)
+
+    # auditing (DB-side timestamps)
+    created_at: Mapped[datetime] = mapped_column(
+        DateTime(timezone=True), server_default=func.now(), nullable=False
+    )
+    updated_at: Mapped[datetime] = mapped_column(
+        DateTime(timezone=True), server_default=func.now(), onupdate=func.now(), nullable=False
+    )
+
+    def __repr__(self) -> str:
+        return f"<${Entity} id={self.id} name={self.name!r}>"
+
+
+# --- Uniqueness policy --------------------------------------------------------
+# Register functional unique indexes (case-insensitive on "name"),
+# optionally scoped by tenant if present.
+for _ix in make_unique_indexes(
+    ${Entity},
+    unique_ci=["name"]${tenant_arg}
+):
+    # Iteration is enough to attach them to the Table metadata
+    # (Alembic autogenerate / metadata.create_all will pick them up)
+    pass

svc_infra-0.1.184/src/svc_infra/db/uniq.py

@@ -0,0 +1,77 @@
+from __future__ import annotations
+from typing import Iterable, Sequence, Tuple, Union, List, Optional
+from sqlalchemy import Index, func
+
+ColumnSpec = Union[str, Sequence[str]]
+
+def _as_tuple(spec: ColumnSpec) -> Tuple[str, ...]:
+    return (spec,) if isinstance(spec, str) else tuple(spec)
+
+def make_unique_indexes(
+        model: type,
+        *,
+        unique_cs: Iterable[ColumnSpec] = (),
+        unique_ci: Iterable[ColumnSpec] = (),
+        tenant_field: Optional[str] = None,
+        name_prefix: str = "uq",
+) -> List[Index]:
+    """Return SQLAlchemy Index objects that enforce uniqueness.
+
+    - unique_cs: case-sensitive unique specs
+    - unique_ci: case-insensitive unique specs (lower(column))
+    - tenant_field: if provided, create two partial unique indexes:
+        * tenant IS NULL (global bucket)
+        * tenant IS NOT NULL (scoped per-tenant)
+
+    Declare right after your model class; Alembic or metadata.create_all will pick them up.
+    """
+    idxs: List[Index] = []
+
+    def _col(name: str):
+        return getattr(model, name)
+
+    def _to_sa_cols(spec: Tuple[str, ...], *, ci: bool):
+        cols = []
+        for cname in spec:
+            c = _col(cname)
+            cols.append(func.lower(c) if ci else c)
+        return tuple(cols)
+
+    tenant_col = _col(tenant_field) if tenant_field else None
+
+    def _name(ci: bool, spec: Tuple[str, ...], null_bucket: Optional[str] = None):
+        parts = [name_prefix, model.__tablename__]
+        if tenant_field:
+            parts.append(tenant_field)
+        if null_bucket:
+            parts.append(null_bucket)
+        parts.append("ci" if ci else "cs")
+        parts.extend(spec)
+        return "_".join(parts)
+
+    for ci, spec_list in ((False, unique_cs), (True, unique_ci)):
+        for spec in spec_list:
+            spec_t = _as_tuple(spec)
+            cols = _to_sa_cols(spec_t, ci=ci)
+
+            if tenant_col is None:
+                idxs.append(Index(_name(ci, spec_t), *cols, unique=True))
+            else:
+                idxs.append(
+                    Index(
+                        _name(ci, spec_t, "null"),
+                        *cols,
+                        unique=True,
+                        postgresql_where=tenant_col.is_(None),
+                    )
+                )
+                idxs.append(
+                    Index(
+                        _name(ci, spec_t, "notnull"),
+                        tenant_col,
+                        *cols,
+                        unique=True,
+                        postgresql_where=tenant_col.isnot(None),
+                    )
+                )
+    return idxs

svc_infra-0.1.182/src/svc_infra/db/templates/models_schemas/entity/models.py.tmpl

@@ -1,29 +0,0 @@
-from __future__ import annotations
-from datetime import datetime
-from typing import Optional
-import uuid
-
-from sqlalchemy import String, Boolean, DateTime, JSON, Text, func, UniqueConstraint, Index
-from sqlalchemy.dialects.postgresql import UUID
-from sqlalchemy.orm import Mapped, mapped_column
-from sqlalchemy.ext.mutable import MutableDict
-
-from svc_infra.db.base import ModelBase
-
-
-class ${Entity}(ModelBase):
-    __tablename__ = "${table_name}"
-
-    id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
-    name: Mapped[str] = mapped_column(String(255), nullable=False)
-    description: Mapped[Optional[str]] = mapped_column(Text)
-
-${tenant_field}${soft_delete_field}    extra: Mapped[dict] = mapped_column(MutableDict.as_mutable(JSON), default=dict)
-
-    created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), server_default=func.now(), nullable=False)
-    updated_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), server_default=func.now(), onupdate=func.now(), nullable=False)
-
-${constraints}    def __repr__(self) -> str:
-        return f"<${Entity} id={self.id} name={self.name!r}>"
-
-${indexes}