sqlspec 0.36.0__cp310-cp310-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl

sqlspec/adapters/psqlpy/events/backend.py

@@ -0,0 +1,310 @@
+"""Psqlpy LISTEN/NOTIFY and hybrid event backends."""
+
+# pyright: ignore=reportPrivateUsage
+import asyncio
+import contextlib
+import logging
+from datetime import datetime, timezone
+from typing import TYPE_CHECKING, Any, cast
+
+from sqlspec.core import SQL
+from sqlspec.exceptions import ImproperConfigurationError
+from sqlspec.extensions.events import (
+    AsyncTableEventQueue,
+    EventMessage,
+    build_queue_backend,
+    decode_notify_payload,
+    encode_notify_payload,
+)
+from sqlspec.extensions.events import normalize_event_channel_name as _normalize_channel
+from sqlspec.protocols import NotificationProtocol
+from sqlspec.utils.logging import get_logger, log_with_context
+from sqlspec.utils.serializers import to_json
+from sqlspec.utils.uuids import uuid4
+
+if TYPE_CHECKING:
+    from psqlpy import Listener
+
+    from sqlspec.adapters.psqlpy.config import PsqlpyConfig
+
+
+logger = get_logger("sqlspec.events.psqlpy")
+
+__all__ = ("PsqlpyEventsBackend", "PsqlpyHybridEventsBackend", "create_event_backend")
+
+_PSQLPY_CALLBACK_MIN_ARGS = 3
+
+
+class _PsqlpyNotifyCapture:
+    __slots__ = ("_channel", "_event", "payload")
+
+    def __init__(self, channel: str, event: asyncio.Event) -> None:
+        self._channel = channel
+        self._event = event
+        self.payload: str | None = None
+
+    async def __call__(self, *args: Any) -> None:
+        if not args:
+            return
+
+        notified_channel: str | None = None
+        payload: str | None = None
+
+        if len(args) == 1:
+            message = args[0]
+            if isinstance(message, NotificationProtocol):
+                notified_channel = message.channel
+                payload = message.payload
+        elif len(args) >= _PSQLPY_CALLBACK_MIN_ARGS:
+            value1 = cast("str", args[1])
+            value2 = cast("str", args[2])
+            if value1 == self._channel:
+                notified_channel = value1
+                payload = value2
+            elif value2 == self._channel:
+                notified_channel = value2
+                payload = value1
+            else:
+                return
+
+        if notified_channel == self._channel and payload is not None and self.payload is None:
+            self.payload = payload
+            self._event.set()
+
+
+class _PsqlpyNotifySignal:
+    __slots__ = ("_channel", "_event")
+
+    def __init__(self, channel: str, event: asyncio.Event) -> None:
+        self._channel = channel
+        self._event = event
+
+    async def __call__(self, *args: Any) -> None:
+        if not args:
+            return
+
+        notified_channel: str | None = None
+        if len(args) == 1:
+            message = args[0]
+            if isinstance(message, NotificationProtocol):
+                notified_channel = message.channel
+        elif len(args) >= _PSQLPY_CALLBACK_MIN_ARGS:
+            value1 = cast("str", args[1])
+            value2 = cast("str", args[2])
+            if value1 == self._channel:
+                notified_channel = value1
+            elif value2 == self._channel:
+                notified_channel = value2
+
+        if notified_channel == self._channel:
+            self._event.set()
+
+
+class PsqlpyEventsBackend:
+    """Native LISTEN/NOTIFY backend for psqlpy adapters.
+
+    Uses psqlpy's Listener API which provides a dedicated connection for
+    receiving PostgreSQL NOTIFY messages via callbacks or async iteration.
+    """
+
+    __slots__ = ("_config", "_listener", "_listener_started", "_runtime")
+
+    supports_sync = False
+    supports_async = True
+    backend_name = "listen_notify"
+
+    def __init__(self, config: "PsqlpyConfig") -> None:
+        if "psqlpy" not in type(config).__module__:
+            msg = "Psqlpy events backend requires a Psqlpy adapter"
+            raise ImproperConfigurationError(msg)
+        self._config = config
+        self._runtime = config.get_observability_runtime()
+        self._listener: Any | None = None
+        self._listener_started: bool = False
+        log_with_context(
+            logger,
+            logging.DEBUG,
+            "event.listen",
+            adapter_name="psqlpy",
+            backend_name=self.backend_name,
+            mode="async",
+            status="backend_ready",
+        )
+
+    async def publish(self, channel: str, payload: "dict[str, Any]", metadata: "dict[str, Any] | None" = None) -> str:
+        event_id = uuid4().hex
+        async with self._config.provide_session() as driver:
+            await driver.execute_script(
+                SQL("SELECT pg_notify($1, $2)", channel, encode_notify_payload(event_id, payload, metadata))
+            )
+            await driver.commit()
+        self._runtime.increment_metric("events.publish.native")
+        return event_id
+
+    async def dequeue(self, channel: str, poll_interval: float) -> EventMessage | None:
+        listener = await self._ensure_listener(channel)
+        event = asyncio.Event()
+        callback = _PsqlpyNotifyCapture(channel, event)
+        await listener.add_callback(channel=channel, callback=callback.__call__)
+
+        if not self._listener_started:
+            listener.listen()
+            self._listener_started = True
+            await asyncio.sleep(0.05)
+
+        with contextlib.suppress(asyncio.TimeoutError):
+            await asyncio.wait_for(event.wait(), timeout=poll_interval)
+
+        await listener.clear_channel_callbacks(channel=channel)
+        return decode_notify_payload(channel, callback.payload) if callback.payload is not None else None
+
+    async def ack(self, _event_id: str) -> None:
+        self._runtime.increment_metric("events.ack")
+
+    async def nack(self, _event_id: str) -> None:
+        """Return an event to the queue (no-op for native LISTEN/NOTIFY)."""
+
+    async def shutdown(self) -> None:
+        """Shutdown the listener and release resources."""
+        if self._listener is not None:
+            if self._listener_started:
+                self._listener.abort_listen()
+                self._listener_started = False
+            await self._listener.shutdown()
+            self._listener = None
+
+    async def _ensure_listener(self, channel: str) -> "Listener":
+        """Ensure a listener is created for receiving notifications."""
+        _normalize_channel(channel)
+        if self._listener is None:
+            pool = await self._config.provide_pool()
+            self._listener = pool.listener()
+            await self._listener.startup()
+        return self._listener
+
+
+class PsqlpyHybridEventsBackend:
+    """Durable hybrid backend combining queue storage with LISTEN/NOTIFY wakeups.
+
+    Uses psqlpy's Listener API for real-time notifications while persisting
+    events to a durable queue table.
+    """
+
+    __slots__ = ("_config", "_listener", "_listener_started", "_queue", "_runtime")
+
+    supports_sync = False
+    supports_async = True
+    backend_name = "listen_notify_durable"
+
+    def __init__(self, config: "PsqlpyConfig", queue: "AsyncTableEventQueue") -> None:
+        if "psqlpy" not in type(config).__module__:
+            msg = "Psqlpy hybrid backend requires a Psqlpy adapter"
+            raise ImproperConfigurationError(msg)
+        self._config = config
+        self._queue = queue
+        self._runtime = config.get_observability_runtime()
+        self._listener: Any | None = None
+        self._listener_started: bool = False
+        log_with_context(
+            logger,
+            logging.DEBUG,
+            "event.listen",
+            adapter_name="psqlpy",
+            backend_name=self.backend_name,
+            mode="async",
+            status="backend_ready",
+        )
+
+    async def publish(self, channel: str, payload: "dict[str, Any]", metadata: "dict[str, Any] | None" = None) -> str:
+        event_id = uuid4().hex
+        await self._publish_durable(channel, event_id, payload, metadata)
+        self._runtime.increment_metric("events.publish.native")
+        return event_id
+
+    async def dequeue(self, channel: str, poll_interval: float) -> EventMessage | None:
+        listener = await self._ensure_listener(channel)
+        event = asyncio.Event()
+        callback = _PsqlpyNotifySignal(channel, event)
+        await listener.add_callback(channel=channel, callback=callback.__call__)
+
+        if not self._listener_started:
+            listener.listen()
+            self._listener_started = True
+            await asyncio.sleep(0.05)
+
+        with contextlib.suppress(asyncio.TimeoutError):
+            await asyncio.wait_for(event.wait(), timeout=poll_interval)
+
+        await listener.clear_channel_callbacks(channel=channel)
+        return await self._queue.dequeue(channel, poll_interval)
+
+    async def ack(self, event_id: str) -> None:
+        await self._queue.ack(event_id)
+        self._runtime.increment_metric("events.ack")
+
+    async def nack(self, event_id: str) -> None:
+        await self._queue.nack(event_id)
+        self._runtime.increment_metric("events.nack")
+
+    async def shutdown(self) -> None:
+        """Shutdown the listener and release resources."""
+        if self._listener is not None:
+            if self._listener_started:
+                self._listener.abort_listen()
+                self._listener_started = False
+            await self._listener.shutdown()
+            self._listener = None
+
+    async def _ensure_listener(self, channel: str) -> "Listener":
+        """Ensure a listener is created for receiving notifications."""
+        _normalize_channel(channel)
+        if self._listener is None:
+            pool = await self._config.provide_pool()
+            self._listener = pool.listener()
+            await self._listener.startup()
+        return self._listener
+
+    async def _publish_durable(
+        self, channel: str, event_id: str, payload: "dict[str, Any]", metadata: "dict[str, Any] | None"
+    ) -> None:
+        now = datetime.now(timezone.utc)
+        async with self._config.provide_session() as driver:
+            await driver.execute(
+                SQL(
+                    self._queue._upsert_sql,  # pyright: ignore[reportPrivateUsage]
+                    {
+                        "event_id": event_id,
+                        "channel": channel,
+                        "payload_json": payload,
+                        "metadata_json": metadata,
+                        "status": "pending",
+                        "available_at": now,
+                        "lease_expires_at": None,
+                        "attempts": 0,
+                        "created_at": now,
+                    },
+                    statement_config=self._queue._statement_config,  # pyright: ignore[reportPrivateUsage]
+                )
+            )
+            await driver.execute_script(SQL("SELECT pg_notify($1, $2)", channel, to_json({"event_id": event_id})))
+            await driver.commit()
+
+
+def create_event_backend(
+    config: "PsqlpyConfig", backend_name: str, extension_settings: "dict[str, Any]"
+) -> PsqlpyEventsBackend | PsqlpyHybridEventsBackend | None:
+    """Factory used by EventChannel to create the native psqlpy backend."""
+    match backend_name:
+        case "listen_notify":
+            try:
+                return PsqlpyEventsBackend(config)
+            except ImproperConfigurationError:
+                return None
+        case "listen_notify_durable":
+            queue = cast("AsyncTableEventQueue", build_queue_backend(config, extension_settings, adapter_name="psqlpy"))
+            try:
+                return PsqlpyHybridEventsBackend(config, queue)
+            except ImproperConfigurationError:
+                return None
+        case _:
+            return None

sqlspec/adapters/psqlpy/events/store.py

@@ -0,0 +1,20 @@
+"""Psqlpy event queue store."""
+
+from sqlspec.adapters.psqlpy.config import PsqlpyConfig
+from sqlspec.extensions.events import BaseEventQueueStore
+
+__all__ = ("PsqlpyEventQueueStore",)
+
+
+class PsqlpyEventQueueStore(BaseEventQueueStore[PsqlpyConfig]):
+    """Provide PostgreSQL column mappings for the queue table.
+
+    PostgreSQL uses JSONB for efficient binary JSON storage with indexing support,
+    and TIMESTAMPTZ for timezone-aware timestamps.
+    """
+
+    __slots__ = ()
+
+    def _column_types(self) -> "tuple[str, str, str]":
+        """Return PostgreSQL-optimized column types for the event queue."""
+        return "JSONB", "JSONB", "TIMESTAMPTZ"

sqlspec/adapters/psqlpy/litestar/__init__.py

@@ -0,0 +1,5 @@
+"""Litestar integration for psqlpy adapter."""
+
+from sqlspec.adapters.psqlpy.litestar.store import PsqlpyStore
+
+__all__ = ("PsqlpyStore",)

sqlspec/adapters/psqlpy/litestar/store.py

@@ -0,0 +1,270 @@
+"""Psqlpy session store for Litestar integration."""
+
+from datetime import datetime, timedelta, timezone
+from typing import TYPE_CHECKING
+
+from sqlspec.extensions.litestar.store import BaseSQLSpecStore
+
+if TYPE_CHECKING:
+    from sqlspec.adapters.psqlpy.config import PsqlpyConfig
+
+
+__all__ = ("PsqlpyStore",)
+
+
+class PsqlpyStore(BaseSQLSpecStore["PsqlpyConfig"]):
+    """PostgreSQL session store using Psqlpy driver.
+
+    Implements server-side session storage for Litestar using PostgreSQL
+    via the Psqlpy driver (Rust-based async driver). Provides efficient
+    session management with:
+    - Native async PostgreSQL operations via Rust
+    - UPSERT support using ON CONFLICT
+    - Automatic expiration handling
+    - Efficient cleanup of expired sessions
+
+    Args:
+        config: PsqlpyConfig instance.
+
+    Example:
+        from sqlspec.adapters.psqlpy import PsqlpyConfig
+        from sqlspec.adapters.psqlpy.litestar.store import PsqlpyStore
+
+        config = PsqlpyConfig(connection_config={"dsn": "postgresql://..."})
+        store = PsqlpyStore(config)
+        await store.create_table()
+    """
+
+    __slots__ = ()
+
+    def __init__(self, config: "PsqlpyConfig") -> None:
+        """Initialize Psqlpy session store.
+
+        Args:
+            config: PsqlpyConfig instance.
+
+        Notes:
+            Table name is read from config.extension_config["litestar"]["session_table"].
+        """
+        super().__init__(config)
+
+    def _get_create_table_sql(self) -> str:
+        """Get PostgreSQL CREATE TABLE SQL with optimized schema.
+
+        Returns:
+            SQL statement to create the sessions table with proper indexes.
+
+        Notes:
+            - Uses TIMESTAMPTZ for timezone-aware expiration timestamps
+            - Partial index WHERE expires_at IS NOT NULL reduces index size/maintenance
+            - FILLFACTOR 80 leaves space for HOT updates, reducing table bloat
+            - Audit columns (created_at, updated_at) help with debugging
+            - Table name is internally controlled, not user input (S608 suppressed)
+        """
+        return f"""
+        CREATE TABLE IF NOT EXISTS {self._table_name} (
+            session_id TEXT PRIMARY KEY,
+            data BYTEA NOT NULL,
+            expires_at TIMESTAMPTZ,
+            created_at TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP,
+            updated_at TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP
+        ) WITH (fillfactor = 80);
+
+        CREATE INDEX IF NOT EXISTS idx_{self._table_name}_expires_at
+        ON {self._table_name}(expires_at) WHERE expires_at IS NOT NULL;
+
+        ALTER TABLE {self._table_name} SET (
+            autovacuum_vacuum_scale_factor = 0.05,
+            autovacuum_analyze_scale_factor = 0.02
+        );
+        """
+
+    def _get_drop_table_sql(self) -> "list[str]":
+        """Get PostgreSQL DROP TABLE SQL statements.
+
+        Returns:
+            List of SQL statements to drop indexes and table.
+        """
+        return [f"DROP INDEX IF EXISTS idx_{self._table_name}_expires_at", f"DROP TABLE IF EXISTS {self._table_name}"]
+
+    async def create_table(self) -> None:
+        """Create the session table if it doesn't exist."""
+        sql = self._get_create_table_sql()
+        async with self._config.provide_session() as driver:
+            await driver.execute_script(sql)
+        self._log_table_created()
+
+    async def get(self, key: str, renew_for: "int | timedelta | None" = None) -> "bytes | None":
+        """Get a session value by key.
+
+        Args:
+            key: Session ID to retrieve.
+            renew_for: If given, renew the expiry time for this duration.
+
+        Returns:
+            Session data as bytes if found and not expired, None otherwise.
+
+        Notes:
+            Uses CURRENT_TIMESTAMP instead of NOW() for SQL standard compliance.
+            The query planner can use the partial index for expires_at > CURRENT_TIMESTAMP.
+        """
+        sql = f"""
+        SELECT data, expires_at FROM {self._table_name}
+        WHERE session_id = $1
+        AND (expires_at IS NULL OR expires_at > CURRENT_TIMESTAMP)
+        """
+
+        async with self._config.provide_connection() as conn:
+            query_result = await conn.fetch(sql, [key])
+            rows = query_result.result()
+
+            if not rows:
+                return None
+
+            row = rows[0]
+
+            if renew_for is not None and row["expires_at"] is not None:
+                new_expires_at = self._calculate_expires_at(renew_for)
+                if new_expires_at is not None:
+                    update_sql = f"""
+                    UPDATE {self._table_name}
+                    SET expires_at = $1, updated_at = CURRENT_TIMESTAMP
+                    WHERE session_id = $2
+                    """
+                    await conn.execute(update_sql, [new_expires_at, key])
+
+            return bytes(row["data"])
+
+    async def set(self, key: str, value: "str | bytes", expires_in: "int | timedelta | None" = None) -> None:
+        """Store a session value.
+
+        Args:
+            key: Session ID.
+            value: Session data.
+            expires_in: Time until expiration.
+
+        Notes:
+            Uses EXCLUDED to reference the proposed insert values in ON CONFLICT.
+            Updates updated_at timestamp on every write for audit trail.
+        """
+        data = self._value_to_bytes(value)
+        expires_at = self._calculate_expires_at(expires_in)
+
+        sql = f"""
+        INSERT INTO {self._table_name} (session_id, data, expires_at)
+        VALUES ($1, $2, $3)
+        ON CONFLICT (session_id)
+        DO UPDATE SET
+            data = EXCLUDED.data,
+            expires_at = EXCLUDED.expires_at,
+            updated_at = CURRENT_TIMESTAMP
+        """
+
+        async with self._config.provide_connection() as conn:
+            await conn.execute(sql, [key, data, expires_at])
+
+    async def delete(self, key: str) -> None:
+        """Delete a session by key.
+
+        Args:
+            key: Session ID to delete.
+        """
+        sql = f"DELETE FROM {self._table_name} WHERE session_id = $1"
+
+        async with self._config.provide_connection() as conn:
+            await conn.execute(sql, [key])
+
+    async def delete_all(self) -> None:
+        """Delete all sessions from the store."""
+        sql = f"DELETE FROM {self._table_name}"
+
+        async with self._config.provide_connection() as conn:
+            await conn.execute(sql)
+        self._log_delete_all()
+
+    async def exists(self, key: str) -> bool:
+        """Check if a session key exists and is not expired.
+
+        Args:
+            key: Session ID to check.
+
+        Returns:
+            True if the session exists and is not expired.
+
+        Notes:
+            Uses CURRENT_TIMESTAMP for consistency with get() method.
+            Uses fetch() instead of fetch_val() to handle zero-row case.
+        """
+        sql = f"""
+        SELECT 1 FROM {self._table_name}
+        WHERE session_id = $1
+        AND (expires_at IS NULL OR expires_at > CURRENT_TIMESTAMP)
+        """
+
+        async with self._config.provide_connection() as conn:
+            query_result = await conn.fetch(sql, [key])
+            rows = query_result.result()
+            return len(rows) > 0
+
+    async def expires_in(self, key: str) -> "int | None":
+        """Get the time in seconds until the session expires.
+
+        Args:
+            key: Session ID to check.
+
+        Returns:
+            Seconds until expiration, or None if no expiry or key doesn't exist.
+
+        Notes:
+            Uses fetch() to handle the case where the key doesn't exist.
+        """
+        sql = f"""
+        SELECT expires_at FROM {self._table_name}
+        WHERE session_id = $1
+        """
+
+        async with self._config.provide_connection() as conn:
+            query_result = await conn.fetch(sql, [key])
+            rows = query_result.result()
+
+            if not rows:
+                return None
+
+            expires_at = rows[0]["expires_at"]
+
+            if expires_at is None:
+                return None
+
+            now = datetime.now(timezone.utc)
+            if expires_at <= now:
+                return 0
+
+            delta = expires_at - now
+            return int(delta.total_seconds())
+
+    async def delete_expired(self) -> int:
+        """Delete all expired sessions.
+
+        Returns:
+            Number of sessions deleted.
+
+        Notes:
+            Uses CURRENT_TIMESTAMP for consistency.
+            Uses RETURNING to get deleted row count since psqlpy QueryResult
+            doesn't expose command tags.
+            For very large tables (10M+ rows), consider batching deletes
+            to avoid holding locks too long.
+        """
+        sql = f"""
+        DELETE FROM {self._table_name}
+        WHERE expires_at <= CURRENT_TIMESTAMP
+        RETURNING session_id
+        """
+
+        async with self._config.provide_connection() as conn:
+            query_result = await conn.fetch(sql, [])
+            rows = query_result.result()
+            count = len(rows)
+            if count > 0:
+                self._log_delete_expired(count)
+            return count