SurfSense/surfsense_backend/app/automations/persistence/models/trigger.py

"""``automation_triggers`` table — one row per (automation, trigger-instance) pair."""

from __future__ import annotations

from sqlalchemy import (
    TIMESTAMP,
    Boolean,
    Column,
    Enum as SQLAlchemyEnum,
    ForeignKey,
    Integer,
)
from sqlalchemy.dialects.postgresql import JSONB
from sqlalchemy.orm import relationship

from app.db import BaseModel, TimestampMixin

from ..enums.trigger_type import TriggerType


class AutomationTrigger(BaseModel, TimestampMixin):
    __tablename__ = "automation_triggers"

    automation_id = Column(
        Integer,
        ForeignKey("automations.id", ondelete="CASCADE"),
        nullable=False,
        index=True,
    )

    type = Column(
        SQLAlchemyEnum(
            TriggerType,
            name="automation_trigger_type",
            values_callable=lambda x: [e.value for e in x],
        ),
        nullable=False,
        index=True,
    )

    params = Column(JSONB, nullable=False)

    # Per-attachment domain values merged into every dispatched run's inputs.
    # Static wins over runtime data on key collision.
    static_inputs = Column(JSONB, nullable=False, server_default="{}")

    enabled = Column(
        Boolean,
        nullable=False,
        default=True,
        server_default="true",
        index=True,
    )

    last_fired_at = Column(TIMESTAMP(timezone=True), nullable=True)

    # Precomputed next fire moment in UTC; advanced after each fire by the
    # schedule tick. NULL means the trigger has never been scheduled (the
    # tick self-heals on first sight).
    next_fire_at = Column(TIMESTAMP(timezone=True), nullable=True)

    automation = relationship("Automation", back_populates="triggers")
    runs = relationship(
        "AutomationRun",
        back_populates="trigger",
        passive_deletes=True,
    )