Skip to content

Open-source personal finance manager. Self-hosted, privacy-first.

3.0 KB
Raw Blame
import uuid
from typing import TYPE_CHECKING, Optional

from sqlalchemy import ForeignKey, Index, Integer, String, text
from sqlalchemy.dialects.postgresql import UUID
from sqlalchemy.orm import Mapped, mapped_column, relationship

from app.core.database import Base

if TYPE_CHECKING:
    from app.models.asset import Asset
    from app.models.institution import Institution
    from app.models.user import User


class AssetGroup(Base):
    """A user-facing "wallet" that bundles related assets under one total.

    Groups can be manually created (the user picks a name like "US Stocks"
    or "Long-term fixed income") or auto-created when a provider syncs:
    each Pluggy item becomes one group so brokerage positions collapse
    into a single expandable row instead of 20 sibling cards.

    Assets link via nullable `group_id` — deleting a group leaves its
    assets behind ungrouped rather than cascading away real user data.
    """

    __tablename__ = "asset_groups"
    # Mirrors migration 034 so the test schema enforces the same wallet-key
    # uniqueness the sync code's adoption guards rely on.
    __table_args__ = (
        Index(
            "ux_asset_groups_user_source_external",
            "user_id",
            "source",
            "external_id",
            unique=True,
            postgresql_where=text("external_id IS NOT NULL"),
            sqlite_where=text("external_id IS NOT NULL"),
        ),
    )

    id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
    user_id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), ForeignKey("users.id"))
    workspace_id: Mapped[uuid.UUID] = mapped_column(
        UUID(as_uuid=True), ForeignKey("workspaces.id", ondelete="CASCADE"), index=True
    )
    name: Mapped[str] = mapped_column(String(100))
    icon: Mapped[str] = mapped_column(String(50), default="wallet")
    color: Mapped[str] = mapped_column(String(7), default="#0EA5E9")
    position: Mapped[int] = mapped_column(Integer, default=0)

    # Provenance fields — mirror Asset's sync fields so sync code can
    # upsert groups idempotently by (user_id, source, external_id).
    source: Mapped[str] = mapped_column(String(50), default="manual")
    connection_id: Mapped[Optional[uuid.UUID]] = mapped_column(
        UUID(as_uuid=True), ForeignKey("bank_connections.id", ondelete="SET NULL"), nullable=True
    )
    external_id: Mapped[Optional[str]] = mapped_column(String(255), nullable=True)
    # The institution backing a synced wallet (issue #345); null for manual
    # wallets. Renders the "Synced from …" subtitle without falling back to
    # the connection's first institution.
    institution_id: Mapped[Optional[uuid.UUID]] = mapped_column(
        UUID(as_uuid=True), ForeignKey("institutions.id", ondelete="SET NULL"),
        nullable=True, index=True,
    )

    user: Mapped["User"] = relationship()
    assets: Mapped[list["Asset"]] = relationship(back_populates="group")
    institution: Mapped[Optional["Institution"]] = relationship(lazy="selectin")