Module adcp.reporting.outbox.durable

What the notification layer asks of a database-backed ledger.

adcp ships the in-memory stores and checks their composition inline. Every other ledger (the PostgreSQL store in adcp-reporting-storage, or an adopter's own) answers the same questions through these protocols, so the capability checks in :mod:adcp.reporting.outbox never import a storage implementation. Each validate_* method raises :class:~adcp.reporting.ledger.notification_models.ReportingNotificationError with the code the inline checks use, and a store that does not implement a protocol is treated as not durable.

Classes

class ReportingDurableNotificationLedger (*args, **kwargs)
Expand source code
@runtime_checkable
class ReportingDurableNotificationLedger(Protocol):
    """A ledger whose notification outbox shares its durable storage."""

    @property
    def storage_identity(self) -> object:
        """The storage resource every participant must share; compared by identity."""
        ...

    @property
    def notifications_enabled(self) -> bool: ...

    @property
    def durable_reconciliation(self) -> bool:
        """Whether this ledger froze destination bindings transactionally (Managed tier)."""
        ...

    async def validate_notification_chain(self, outbox: object) -> None:
        """Raise ``notification_chain_unready`` unless ``outbox`` is this ledger's queue.

        Includes the installed-schema check for the notification tables.
        """
        ...

    def validate_activity_chain(self, outbox: object) -> None:
        """Raise ``activity_chain_unready`` unless ``outbox`` is this ledger's activity queue."""
        ...

    def validate_composite_activity_chain(
        self, *, outbox: object, status_store: object, reader: object
    ) -> None:
        """Raise ``activity_chain_unready`` unless the B+C activity union is closed."""
        ...

    def activity_schema_contract(self, *, composite: bool) -> str:
        """A digest of the manifests ``validate_activity_schema`` checks."""
        ...

    async def validate_activity_schema(self, *, composite: bool) -> None:
        """Raise ``notification_schema_unready`` unless the activity catalog is installed."""
        ...

A ledger whose notification outbox shares its durable storage.

Ancestors

  • typing.Protocol
  • typing.Generic

Instance variables

prop durable_reconciliation : bool
Expand source code
@property
def durable_reconciliation(self) -> bool:
    """Whether this ledger froze destination bindings transactionally (Managed tier)."""
    ...

Whether this ledger froze destination bindings transactionally (Managed tier).

prop notifications_enabled : bool
Expand source code
@property
def notifications_enabled(self) -> bool: ...
prop storage_identity : object
Expand source code
@property
def storage_identity(self) -> object:
    """The storage resource every participant must share; compared by identity."""
    ...

The storage resource every participant must share; compared by identity.

Methods

def activity_schema_contract(self, *, composite: bool) ‑> str
Expand source code
def activity_schema_contract(self, *, composite: bool) -> str:
    """A digest of the manifests ``validate_activity_schema`` checks."""
    ...

A digest of the manifests validate_activity_schema checks.

def validate_activity_chain(self, outbox: object) ‑> None
Expand source code
def validate_activity_chain(self, outbox: object) -> None:
    """Raise ``activity_chain_unready`` unless ``outbox`` is this ledger's activity queue."""
    ...

Raise activity_chain_unready unless outbox is this ledger's activity queue.

async def validate_activity_schema(self, *, composite: bool) ‑> None
Expand source code
async def validate_activity_schema(self, *, composite: bool) -> None:
    """Raise ``notification_schema_unready`` unless the activity catalog is installed."""
    ...

Raise notification_schema_unready unless the activity catalog is installed.

def validate_composite_activity_chain(self, *, outbox: object, status_store: object, reader: object) ‑> None
Expand source code
def validate_composite_activity_chain(
    self, *, outbox: object, status_store: object, reader: object
) -> None:
    """Raise ``activity_chain_unready`` unless the B+C activity union is closed."""
    ...

Raise activity_chain_unready unless the B+C activity union is closed.

async def validate_notification_chain(self, outbox: object) ‑> None
Expand source code
async def validate_notification_chain(self, outbox: object) -> None:
    """Raise ``notification_chain_unready`` unless ``outbox`` is this ledger's queue.

    Includes the installed-schema check for the notification tables.
    """
    ...

Raise notification_chain_unready unless outbox is this ledger's queue.

Includes the installed-schema check for the notification tables.

class ReportingDurableStatusStore (*args, **kwargs)
Expand source code
@runtime_checkable
class ReportingDurableStatusStore(Protocol):
    """A status-notification store whose queue shares the ledger's durable storage."""

    #: The ledger the status queue reads; the activity chain requires the same object.
    ledger: Any
    #: The store's own status queue, which its worker must drive.
    outbox: Any

    async def status_queue_durable(self, worker: ReportingNotificationWorker) -> bool:
        """Whether ``worker`` drives this store's own durable queue with its schema installed."""
        ...

    async def managed_delivery_recorded(self, *, account_id: str) -> bool:
        """Whether the account holds a frozen destination binding (Managed tier)."""
        ...

A status-notification store whose queue shares the ledger's durable storage.

Ancestors

  • typing.Protocol
  • typing.Generic

Class variables

var ledger : Any

The ledger the status queue reads; the activity chain requires the same object.

var outbox : Any

The store's own status queue, which its worker must drive.

Methods

async def managed_delivery_recorded(self, *, account_id: str) ‑> bool
Expand source code
async def managed_delivery_recorded(self, *, account_id: str) -> bool:
    """Whether the account holds a frozen destination binding (Managed tier)."""
    ...

Whether the account holds a frozen destination binding (Managed tier).

async def status_queue_durable(self, worker: ReportingNotificationWorker) ‑> bool
Expand source code
async def status_queue_durable(self, worker: ReportingNotificationWorker) -> bool:
    """Whether ``worker`` drives this store's own durable queue with its schema installed."""
    ...

Whether worker drives this store's own durable queue with its schema installed.