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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: svc-infra
-Version: 0.1.183
+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.183 → svc_infra-0.1.184}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "svc-infra"
-version = "0.1.183"
+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.183 → svc_infra-0.1.184}/src/svc_infra/db/uniq.py

@@ -2,42 +2,28 @@ from __future__ import annotations
 from typing import Iterable, Sequence, Tuple, Union, List, Optional
 from sqlalchemy import Index, func
 
-
-ColumnSpec = Union[str, Sequence[str]]  # "email" or ("first_name","last_name")
-
+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,
         *,
-        # Case-sensitive uniqueness specs (exact match)
         unique_cs: Iterable[ColumnSpec] = (),
-        # Case-insensitive uniqueness specs: lower() applied to string columns
         unique_ci: Iterable[ColumnSpec] = (),
-        # Optional tenant scoping (e.g. "tenant_id"). If provided:
-        #   - when tenant is NULL -> global uniqueness
-        #   - when tenant is NOT NULL -> uniqueness within tenant
         tenant_field: Optional[str] = None,
-        # Prefix for index names
         name_prefix: str = "uq",
 ) -> List[Index]:
-    """
-    Returns a list of SQLAlchemy Index objects enforcing uniqueness.
+    """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)
 
-    Notes:
-    - For case-insensitive specs, we use functional unique indexes with lower(col).
-    - If tenant_field is given and the tenant column is nullable, we generate two partial
-      unique indexes: one for tenant IS NULL (global), one for tenant IS NOT NULL (scoped).
-    - Attach these indexes after your model class definition, before migrations/DDL run:
-        Indexes = make_unique_indexes(User, unique_ci=["email"], tenant_field="tenant_id")
-        for ix in Indexes:
-            ix.create(model.metadata.bind)  # OR just rely on Alembic autogenerate / metadata.create_all
-      Most apps just *define* them at module import time:
-        for ix in Indexes:  # they auto-register with the Table; no manual create() needed
-            pass
+    Declare right after your model class; Alembic or metadata.create_all will pick them up.
     """
     idxs: List[Index] = []
 
@@ -53,7 +39,6 @@ def make_unique_indexes(
 
     tenant_col = _col(tenant_field) if tenant_field else None
 
-    # Helper: name like uq_<table>_<tenant?>_<ci/cs>_<joined-columns>
     def _name(ci: bool, spec: Tuple[str, ...], null_bucket: Optional[str] = None):
         parts = [name_prefix, model.__tablename__]
         if tenant_field:
@@ -64,18 +49,14 @@ def make_unique_indexes(
         parts.extend(spec)
         return "_".join(parts)
 
-    # Build indexes for both CS and CI specs
     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:
-                # simple global unique (with or without lower())
                 idxs.append(Index(_name(ci, spec_t), *cols, unique=True))
             else:
-                # two partial unique indexes to treat NULL tenant as its own bucket
-                # 1) global bucket (tenant IS NULL)
                 idxs.append(
                     Index(
                         _name(ci, spec_t, "null"),
@@ -84,7 +65,6 @@ def make_unique_indexes(
                         postgresql_where=tenant_col.is_(None),
                     )
                 )
-                # 2) per-tenant bucket (tenant IS NOT NULL)
                 idxs.append(
                     Index(
                         _name(ci, spec_t, "notnull"),
@@ -94,5 +74,4 @@ def make_unique_indexes(
                         postgresql_where=tenant_col.isnot(None),
                     )
                 )
-
     return idxs