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

"""Pydantic schemas for the automation definition and per-type configs."""

from __future__ import annotations

from .actions import AgentTaskActionConfig
from .definition import (
    AutomationDefinition,
    ExecutionBlock,
    InputsBlock,
    MetadataBlock,
    PlanStep,
    TriggerSpec,
)
from .triggers import ManualTriggerConfig, ScheduleTriggerConfig

__all__ = [
    "AgentTaskActionConfig",
    "AutomationDefinition",
    "ExecutionBlock",
    "InputsBlock",
    "ManualTriggerConfig",
    "MetadataBlock",
    "PlanStep",
    "ScheduleTriggerConfig",
    "TriggerSpec",
]
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			`"""Pydantic schemas for the automation definition and per-type configs."""`
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 Pydantic schemas for the automation definition Three layers of Pydantic models under app/automations/schemas/, one file per concern (SRP), matching the envelope in automation-design-plan.md §5. definition/ — the editable envelope persisted in automations.definition: - envelope.py AutomationDefinition (top-level shape) - plan_step.py PlanStep (one step in the sequential plan) - inputs.py InputsBlock (the inputs JSON Schema wrapper) - execution.py ExecutionBlock (timeouts, retries, concurrency, budget cap, on_failure plan) - metadata.py MetadataBlock (tags + created_from_nl + extras) - trigger_spec.py TriggerSpec (one entry in triggers[]) triggers/ — per-trigger config schemas, dispatched by registry on the TriggerSpec.type discriminator: - schedule.py ScheduleTriggerConfig(cron, timezone) - manual.py ManualTriggerConfig() — empty in v1 actions/ — per-action config schemas, dispatched by registry on the PlanStep.action discriminator: - agent_task.py AgentTaskActionConfig(prompt, tools, model, output_schema) Design properties verified by an inline smoke test: - The §5 worked example round-trips through model_validate_json / model_dump_json byte-for-byte (InputsBlock uses serialize_by_alias so the JSON key stays "schema" not "schema_"). - Envelope rejects unknown top-level keys (extra="forbid"). - MetadataBlock tolerates unknown keys (extra="allow"). - ExecutionBlock defaults apply when the block is omitted. - retry_backoff and concurrency are typed as Literal — bogus values rejected at validation time. - Per-type configs enforce their required fields (cron + timezone on schedule; non-empty prompt on agent_task). The envelope keeps trigger and action configs as untyped dicts on purpose — per-type validation is a registry-driven dispatch (commit 10), keeping the envelope free of every-type-knows-every-type coupling. 2026-05-26 22:50:52 +02:00			`from .actions import AgentTaskActionConfig`
			`from .definition import (`
			`AutomationDefinition,`
			`ExecutionBlock,`
			`InputsBlock,`
			`MetadataBlock,`
			`PlanStep,`
			`TriggerSpec,`
			`)`
			`from .triggers import ManualTriggerConfig, ScheduleTriggerConfig`

			`__all__ = [`
			`"AgentTaskActionConfig",`
			`"AutomationDefinition",`
			`"ExecutionBlock",`
			`"InputsBlock",`
			`"ManualTriggerConfig",`
			`"MetadataBlock",`
			`"PlanStep",`
			`"ScheduleTriggerConfig",`
			`"TriggerSpec",`
			`]`