SurfSense/surfsense_backend/app/automations/persistence/__init__.py

"""SQLAlchemy models and enums for the automation tables."""

from __future__ import annotations

from .enums import AutomationStatus, RunStatus, TriggerType
from .models import Automation, AutomationRun, AutomationTrigger

__all__ = [
    "Automation",
    "AutomationRun",
    "AutomationStatus",
    "AutomationTrigger",
    "RunStatus",
    "TriggerType",
]
chore(automation): trim docstrings to intent only Cut the docstrings and Field(description=...) text across the entire automations/ tree down to single-line intent statements, matching the multi_agent_chat conciseness style: - Module docstrings: one line stating what the file is. - Class docstrings: deleted when the class name + module docstring already cover intent; kept only where they add a constraint or rationale not visible in the signature. - Pydantic Field descriptions: short noun phrases / clauses, not full sentences. Reasoning that belonged in the design plan moved out of the code. - Enum values: per-value docstrings replaced with terse inline comments where the meaning isn't obvious from the name. Behaviour is unchanged. The same 33 files, same public surface, same imports — verified by re-running the 10-point registry smoke test and the 8-point schema round-trip / constraint suite from commits 9 and 10. LOC: 1180 → 691 (-42%). 2026-05-26 23:01:22 +02:00			`"""SQLAlchemy models and enums for the automation tables."""`
feat(automation): scaffold isolated module structure Create app/automations/ with the SRP-per-file / grouped-folders layout that mirrors app/agents/multi_agent_chat/. Twelve __init__.py files, each a thin re-export with a single-line docstring describing the subpackage's role, no exports yet (filled in subsequent commits). Tree: app/automations/ ├── persistence/ │ ├── enums/ (status / type enums; one per file) │ └── models/ (SQLAlchemy tables; one per file) ├── schemas/ │ ├── definition/ (the JSON envelope, broken by concern) │ ├── triggers/ (per-trigger config schemas) │ └── actions/ (per-action config schemas) └── registries/ ├── capabilities/ (types.py + store.py) ├── actions/ (types.py + store.py) └── triggers/ (types.py + store.py) The persistence/ folder is named to avoid surfsense_backend/.gitignore's data/ ignore rule, which silently masked the original data/ name and its contents from version control. Isolation invariant: the module imports only from app.db (foundational Base + FK targets, unavoidable) and stdlib / SQLAlchemy / Pydantic. No imports from app.agents., app.services., app.tasks., app.routes. or any other business-logic module. Confirmed importable with no side effects. 2026-05-26 22:38:41 +02:00
			`from __future__ import annotations`

feat(automation): add SQLAlchemy models for the three v1 tables Three enums (one file each) plus three models (one file each), all under app/automations/persistence/. The module imports from app.db only (Base/BaseModel/TimestampMixin and FK targets searchspaces.id / user.id); no business-logic imports. Enums: - AutomationStatus: active \| paused \| archived - RunStatus: pending \| running \| succeeded \| failed \| cancelled \| timed_out - TriggerType: schedule \| manual (Phase-2/3 add webhook \| event) Models: - Automation: search_space-scoped, created_by_user_id (SET NULL), name + description, status enum, definition JSONB, version int, updated_at with onupdate. - AutomationTrigger: FK → automations (CASCADE), type enum, config JSONB, enabled bool, last_fired_at. Webhook secret_hash is omitted until Phase 2. - AutomationRun: FK → automations (CASCADE), nullable trigger_id (SET NULL — null = manual via UI), status enum, definition_snapshot for immutable history, trigger_payload / resolved_inputs / step_results / output / artifacts / error JSONB columns, started_at / finished_at timestamps, agent_session_id for linking to the LangGraph trace. cost_usd column omitted until at least one v1 capability records token-level cost. Verified: Base.metadata exposes all three table names; columns and enums introspect as documented; no linter errors. 2026-05-26 22:42:50 +02:00			`from .enums import AutomationStatus, RunStatus, TriggerType`
			`from .models import Automation, AutomationRun, AutomationTrigger`

			`__all__ = [`
			`"Automation",`
			`"AutomationRun",`
			`"AutomationStatus",`
			`"AutomationTrigger",`
			`"RunStatus",`
			`"TriggerType",`
			`]`