Skip to content

Open-source AI teammates in Slack, Teams, Discord, Telegram and Mattermost. Self-host it, with any agent harness and any model.

feat(db): add the tenant model and scope the schema to it (CHOO-2623)

Wojciech Wojtyniak6923d8b1c82e
diff --git a/core/switch_core/db/models.py b/core/switch_core/db/models.py
index 91db96e0a..7f215c97e 100644
--- a/core/switch_core/db/models.py
+++ b/core/switch_core/db/models.py
@@ -8,6 +8,7 @@ from sqlalchemy import (
Column,
DateTime,
ForeignKey,
+ ForeignKeyConstraint,
Index,
Integer,
LargeBinary,
@@ -33,6 +34,73 @@ def _uuid() -> str:
return str(uuid.uuid4())
+# ── Tenants ─────────────────────────────────────────────────────────────────
+
+
+class Tenant(Base):
+ """The top-level customer boundary every scoped table hangs off.
+
+ Deliberately minimal: no `plan`, `status` or `deleted_at`. A later phase
+ adds plans and deletion; a `deleted_at` that nothing honours yet would
+ read as a guarantee the code does not make.
+ """
+
+ __tablename__ = "tenants"
+
+ id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
+ slug: Mapped[str] = mapped_column(Text, unique=True, nullable=False)
+ name: Mapped[str] = mapped_column(Text, nullable=False)
+ created_at: Mapped[str] = mapped_column(
+ DateTime(timezone=True), server_default=func.now(), nullable=False
+ )
+
+
+class TenantMember(Base):
+ """A user's membership in a tenant, and their role within it.
+
+ Membership is a row, not a column on the user: one login may belong to
+ several tenants. `role` is a checked string rather than an enum type,
+ matching how `users.role` is already stored — a later phase gives these
+ roles meaning; this one only records them.
+ """
+
+ __tablename__ = "tenant_members"
+ __table_args__ = (
+ CheckConstraint(
+ "role IN ('owner', 'admin', 'member')", name="ck_tenant_members_role"
+ ),
+ )
+
+ tenant_id: Mapped[str] = mapped_column(
+ Text, ForeignKey("tenants.id"), primary_key=True
+ )
+ user_id: Mapped[str] = mapped_column(Text, ForeignKey("users.id"), primary_key=True)
+ role: Mapped[str] = mapped_column(Text, nullable=False)
+ created_at: Mapped[str] = mapped_column(
+ DateTime(timezone=True), server_default=func.now(), nullable=False
+ )
+
+
+# The fixed id of the one tenant that exists before a second is ever onboarded.
+# Written into the migration verbatim rather than read from config, so a later
+# edit to `SwitchConfig.tenant_id` can never desync from the row it names.
+TENANT_ZERO_ID = "00000000-0000-0000-0000-000000000000"
+
+
+class TenantScoped:
+ """Mixin carrying the tenant column shared by every per-tenant table.
+
+ The Python-side default returns tenant zero — the only tenant that exists
+ today — so an ordinary ORM insert needs no change to land in the right
+ place. A later PR replaces this default with a value read from the
+ request/session context; nothing here reads from a contextvar yet.
+ """
+
+ tenant_id: Mapped[str] = mapped_column(
+ Text, ForeignKey("tenants.id"), nullable=False, default=TENANT_ZERO_ID
+ )
+
+
# ── Users ──────────────────────────────────────────────────────────────────────
@@ -113,11 +181,16 @@ class OidcIdentity(Base):
# ── API Keys ─────────────────────────────────────────────────────────────────
-class ApiKey(Base):
+class ApiKey(TenantScoped, Base):
__tablename__ = "api_keys"
+ __table_args__ = (
+ UniqueConstraint("id", "tenant_id", name="uq_api_keys_id_tenant"),
+ )
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
user_id: Mapped[str] = mapped_column(Text, ForeignKey("users.id"), nullable=False)
+ # Global on purpose: bearer auth resolves the hash before a tenant is
+ # known, so it cannot be scoped by one.
key_hash: Mapped[str] = mapped_column(Text, unique=True, nullable=False)
encrypted_key: Mapped[str] = mapped_column(Text, nullable=False)
label: Mapped[str] = mapped_column(Text, nullable=False)
@@ -130,11 +203,17 @@ class ApiKey(Base):
# ── Clients ────────────────────────────────────────────────────────────────────
-class Client(Base):
+class Client(TenantScoped, Base):
__tablename__ = "clients"
+ __table_args__ = (
+ UniqueConstraint(
+ "tenant_id", "matrix_user_id", name="uq_clients_tenant_matrix_user_id"
+ ),
+ UniqueConstraint("id", "tenant_id", name="uq_clients_id_tenant"),
+ )
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
- matrix_user_id: Mapped[str] = mapped_column(Text, unique=True, nullable=False)
+ matrix_user_id: Mapped[str] = mapped_column(Text, nullable=False)
display_name: Mapped[str] = mapped_column(Text, nullable=False)
type: Mapped[str] = mapped_column(Text, nullable=False)
config: Mapped[dict | None] = mapped_column(JSONB, nullable=True)
@@ -143,13 +222,23 @@ class Client(Base):
)
-class ClientRoom(Base):
+class ClientRoom(TenantScoped, Base):
__tablename__ = "client_rooms"
-
- client_id: Mapped[str] = mapped_column(
- Text, ForeignKey("clients.id"), primary_key=True
+ __table_args__ = (
+ ForeignKeyConstraint(
+ ["tenant_id", "client_id"],
+ ["clients.tenant_id", "clients.id"],
+ name="fk_client_rooms_client",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "room_id"],
+ ["rooms.tenant_id", "rooms.id"],
+ name="fk_client_rooms_room",
+ ),
)
- room_id: Mapped[str] = mapped_column(Text, ForeignKey("rooms.id"), primary_key=True)
+
+ client_id: Mapped[str] = mapped_column(Text, primary_key=True)
+ room_id: Mapped[str] = mapped_column(Text, primary_key=True)
joined_at: Mapped[str] = mapped_column(
DateTime(timezone=True), server_default=func.now(), nullable=False
)
@@ -158,12 +247,32 @@ class ClientRoom(Base):
# ── Agents ─────────────────────────────────────────────────────────────────────
-class Agent(Base):
+class Agent(TenantScoped, Base):
__tablename__ = "agents"
- __table_args__ = (Index("ix_agents_parent_agent_id", "parent_agent_id"),)
+ __table_args__ = (
+ Index("ix_agents_parent_agent_id", "parent_agent_id"),
+ UniqueConstraint("tenant_id", "name", name="uq_agents_tenant_name"),
+ UniqueConstraint("id", "tenant_id", name="uq_agents_id_tenant"),
+ ForeignKeyConstraint(
+ ["tenant_id", "client_id"],
+ ["clients.tenant_id", "clients.id"],
+ name="fk_agents_client",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "api_key_id"],
+ ["api_keys.tenant_id", "api_keys.id"],
+ name="fk_agents_api_key",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "parent_agent_id"],
+ ["agents.tenant_id", "agents.id"],
+ name="fk_agents_parent_agent",
+ ondelete="SET NULL (parent_agent_id)",
+ ),
+ )
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
- name: Mapped[str] = mapped_column(Text, unique=True, nullable=False)
+ name: Mapped[str] = mapped_column(Text, nullable=False)
description: Mapped[str] = mapped_column(Text, nullable=False)
# Absolute https URL of the agent's icon (CHOO-2171). Switch stores the
# link, never image bytes: whatever produces the picture — a generated-
@@ -180,15 +289,11 @@ class Agent(Base):
agent_type: Mapped[str] = mapped_column(Text, nullable=False)
connector_type: Mapped[str] = mapped_column(Text, nullable=False)
integration_profile: Mapped[dict] = mapped_column(JSONB, nullable=False)
- client_id: Mapped[str] = mapped_column(
- Text, ForeignKey("clients.id"), unique=True, nullable=False
- )
+ client_id: Mapped[str] = mapped_column(Text, unique=True, nullable=False)
# Indexed because bearer-token auth resolves the key row and then looks the
# agent up by this column on every authenticated request, heartbeats
# included — without it that is a sequential scan per beat.
- api_key_id: Mapped[str] = mapped_column(
- Text, ForeignKey("api_keys.id"), nullable=False, index=True
- )
+ api_key_id: Mapped[str] = mapped_column(Text, nullable=False, index=True)
owner_id: Mapped[str | None] = mapped_column(
Text, ForeignKey("users.id"), nullable=True
)
@@ -197,9 +302,7 @@ class Agent(Base):
# main Claude Code agent. NULL for ordinary top-level agents. ON DELETE
# SET NULL so deleting a parent orphans its children rather than removing
# them (they keep their own identity, rooms, and history).
- parent_agent_id: Mapped[str | None] = mapped_column(
- Text, ForeignKey("agents.id", ondelete="SET NULL"), nullable=True
- )
+ parent_agent_id: Mapped[str | None] = mapped_column(Text, nullable=True)
oauth_client_id: Mapped[str | None] = mapped_column(Text, nullable=True)
# Scoped agent-addressing permissions (CHOO-1585). NULL preserves today's
# open behaviour (anyone may address the agent); a stored policy is a
@@ -215,13 +318,20 @@ class Agent(Base):
# ── Tools ──────────────────────────────────────────────────────────────────────
-class Tool(Base):
+class Tool(TenantScoped, Base):
__tablename__ = "tools"
+ __table_args__ = (
+ ForeignKeyConstraint(
+ ["tenant_id", "agent_id"],
+ ["agents.tenant_id", "agents.id"],
+ name="fk_tools_agent",
+ ),
+ )
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
name: Mapped[str] = mapped_column(Text, nullable=False)
description: Mapped[str] = mapped_column(Text, nullable=False)
- agent_id: Mapped[str] = mapped_column(Text, ForeignKey("agents.id"), nullable=False)
+ agent_id: Mapped[str] = mapped_column(Text, nullable=False)
args_schema: Mapped[dict | None] = mapped_column(JSONB, nullable=True)
metadata_: Mapped[dict | None] = mapped_column("metadata", JSONB, nullable=True)
created_at: Mapped[str] = mapped_column(
@@ -232,13 +342,20 @@ class Tool(Base):
# ── Models ─────────────────────────────────────────────────────────────────────
-class Model(Base):
+class Model(TenantScoped, Base):
__tablename__ = "models"
+ __table_args__ = (
+ ForeignKeyConstraint(
+ ["tenant_id", "agent_id"],
+ ["agents.tenant_id", "agents.id"],
+ name="fk_models_agent",
+ ),
+ )
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
name: Mapped[str] = mapped_column(Text, nullable=False)
description: Mapped[str] = mapped_column(Text, nullable=False)
- agent_id: Mapped[str] = mapped_column(Text, ForeignKey("agents.id"), nullable=False)
+ agent_id: Mapped[str] = mapped_column(Text, nullable=False)
metadata_: Mapped[dict | None] = mapped_column("metadata", JSONB, nullable=True)
created_at: Mapped[str] = mapped_column(
DateTime(timezone=True), server_default=func.now(), nullable=False
@@ -251,22 +368,45 @@ class Model(Base):
agent_skills = Table(
"agent_skills",
Base.metadata,
- Column("agent_id", Text, ForeignKey("agents.id"), primary_key=True),
- Column("skill_id", Text, ForeignKey("skills.id"), primary_key=True),
+ Column(
+ "tenant_id",
+ Text,
+ ForeignKey("tenants.id"),
+ nullable=False,
+ default=TENANT_ZERO_ID,
+ ),
+ Column("agent_id", Text, primary_key=True),
+ Column("skill_id", Text, primary_key=True),
+ ForeignKeyConstraint(
+ ["tenant_id", "agent_id"],
+ ["agents.tenant_id", "agents.id"],
+ name="fk_agent_skills_agent",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "skill_id"],
+ ["skills.tenant_id", "skills.id"],
+ name="fk_agent_skills_skill",
+ ),
)
-class Skill(Base):
+class Skill(TenantScoped, Base):
__tablename__ = "skills"
+ __table_args__ = (
+ UniqueConstraint("id", "tenant_id", name="uq_skills_id_tenant"),
+ ForeignKeyConstraint(
+ ["tenant_id", "owner_agent_id"],
+ ["agents.tenant_id", "agents.id"],
+ name="fk_skills_owner_agent",
+ ),
+ )
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
name: Mapped[str] = mapped_column(Text, nullable=False)
version: Mapped[str] = mapped_column(Text, nullable=False)
description: Mapped[str] = mapped_column(Text, nullable=False)
visibility: Mapped[str] = mapped_column(Text, nullable=False)
- owner_agent_id: Mapped[str | None] = mapped_column(
- Text, ForeignKey("agents.id"), nullable=True
- )
+ owner_agent_id: Mapped[str | None] = mapped_column(Text, nullable=True)
created_by: Mapped[str | None] = mapped_column(
Text, ForeignKey("users.id"), nullable=True
)
@@ -283,8 +423,15 @@ class Skill(Base):
room_agents = Table(
"room_agents",
Base.metadata,
- Column("room_id", Text, ForeignKey("rooms.id"), primary_key=True),
- Column("agent_id", Text, ForeignKey("agents.id"), primary_key=True),
+ Column(
+ "tenant_id",
+ Text,
+ ForeignKey("tenants.id"),
+ nullable=False,
+ default=TENANT_ZERO_ID,
+ ),
+ Column("room_id", Text, primary_key=True),
+ Column("agent_id", Text, primary_key=True),
Column("last_connected_at", DateTime(timezone=True), nullable=True),
Column(
"receives_join_events",
@@ -295,17 +442,44 @@ room_agents = Table(
# Room-scoped alias: `@<alias>` addresses this agent in this room exactly
# like its real name. Null when the agent has no alias here.
Column("alias", Text, nullable=True),
+ ForeignKeyConstraint(
+ ["tenant_id", "room_id"],
+ ["rooms.tenant_id", "rooms.id"],
+ name="fk_room_agents_room",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "agent_id"],
+ ["agents.tenant_id", "agents.id"],
+ name="fk_room_agents_agent",
+ ),
)
room_skills = Table(
"room_skills",
Base.metadata,
- Column("room_id", Text, ForeignKey("rooms.id"), primary_key=True),
- Column("skill_id", Text, ForeignKey("skills.id"), primary_key=True),
+ Column(
+ "tenant_id",
+ Text,
+ ForeignKey("tenants.id"),
+ nullable=False,
+ default=TENANT_ZERO_ID,
+ ),
+ Column("room_id", Text, primary_key=True),
+ Column("skill_id", Text, primary_key=True),
+ ForeignKeyConstraint(
+ ["tenant_id", "room_id"],
+ ["rooms.tenant_id", "rooms.id"],
+ name="fk_room_skills_room",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "skill_id"],
+ ["skills.tenant_id", "skills.id"],
+ name="fk_room_skills_skill",
+ ),
)
-class Room(Base):
+class Room(TenantScoped, Base):
__tablename__ = "rooms"
__table_args__ = (
# A bridged channel maps to at most one Switch room. Partial so that
@@ -321,15 +495,28 @@ class Room(Base):
# and the ON DELETE SET NULL when a group is removed both scan the
# table. Mirrors ix_agents_parent_agent_id.
Index("ix_rooms_group_id", "group_id"),
+ UniqueConstraint(
+ "tenant_id", "matrix_room_id", name="uq_rooms_tenant_matrix_room_id"
+ ),
+ UniqueConstraint("id", "tenant_id", name="uq_rooms_id_tenant"),
+ ForeignKeyConstraint(
+ ["tenant_id", "bridge_id"],
+ ["collaboration_bridges.tenant_id", "collaboration_bridges.id"],
+ name="fk_rooms_bridge",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "group_id"],
+ ["room_groups.tenant_id", "room_groups.id"],
+ name="fk_rooms_group",
+ ondelete="SET NULL (group_id)",
+ ),
)
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
- matrix_room_id: Mapped[str] = mapped_column(Text, unique=True, nullable=False)
+ matrix_room_id: Mapped[str] = mapped_column(Text, nullable=False)
name: Mapped[str] = mapped_column(Text, nullable=False)
description: Mapped[str] = mapped_column(Text, nullable=False)
- bridge_id: Mapped[str | None] = mapped_column(
- Text, ForeignKey("collaboration_bridges.id"), nullable=True
- )
+ bridge_id: Mapped[str | None] = mapped_column(Text, nullable=True)
external_channel_id: Mapped[str | None] = mapped_column(Text, nullable=True)
channel_type: Mapped[str | None] = mapped_column(Text, nullable=True)
admin_mode: Mapped[bool] = mapped_column(
@@ -341,9 +528,7 @@ class Room(Base):
created_by: Mapped[str | None] = mapped_column(
Text, ForeignKey("users.id"), nullable=True
)
- group_id: Mapped[str | None] = mapped_column(
- Text, ForeignKey("room_groups.id", ondelete="SET NULL"), nullable=True
- )
+ group_id: Mapped[str | None] = mapped_column(Text, nullable=True)
owner_id: Mapped[str | None] = mapped_column(
Text, ForeignKey("users.id"), nullable=True
)
@@ -369,7 +554,7 @@ class Room(Base):
# ── Room Groups ─────────────────────────────────────────────────────────────────
-class RoomGroup(Base):
+class RoomGroup(TenantScoped, Base):
"""A named, optionally-nested organizational group for rooms.
Groups form a tree via the nullable `parent_group_id` self-reference;
@@ -386,15 +571,20 @@ class RoomGroup(Base):
__tablename__ = "room_groups"
__table_args__ = (
CheckConstraint("parent_group_id <> id", name="room_groups_no_self_parent"),
+ UniqueConstraint("id", "tenant_id", name="uq_room_groups_id_tenant"),
+ ForeignKeyConstraint(
+ ["tenant_id", "parent_group_id"],
+ ["room_groups.tenant_id", "room_groups.id"],
+ name="fk_room_groups_parent_group",
+ ondelete="SET NULL (parent_group_id)",
+ ),
)
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
name: Mapped[str] = mapped_column(Text, nullable=False)
description: Mapped[str | None] = mapped_column(Text, nullable=True)
color: Mapped[str | None] = mapped_column(Text, nullable=True)
- parent_group_id: Mapped[str | None] = mapped_column(
- Text, ForeignKey("room_groups.id", ondelete="SET NULL"), nullable=True
- )
+ parent_group_id: Mapped[str | None] = mapped_column(Text, nullable=True)
created_at: Mapped[str] = mapped_column(
DateTime(timezone=True), server_default=func.now(), nullable=False
)
@@ -403,7 +593,7 @@ class RoomGroup(Base):
# ── Room Links ────────────────────────────────────────────────────────────────
-class RoomLink(Base):
+class RoomLink(TenantScoped, Base):
"""Directed pointer from one room to another, with a free-text label.
A row represents a one-way link `source_room_id → target_room_id`. The pair
@@ -414,14 +604,22 @@ class RoomLink(Base):
__tablename__ = "room_links"
__table_args__ = (
CheckConstraint("source_room_id <> target_room_id", name="room_links_no_self"),
+ ForeignKeyConstraint(
+ ["tenant_id", "source_room_id"],
+ ["rooms.tenant_id", "rooms.id"],
+ name="fk_room_links_source_room",
+ ondelete="CASCADE",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "target_room_id"],
+ ["rooms.tenant_id", "rooms.id"],
+ name="fk_room_links_target_room",
+ ondelete="CASCADE",
+ ),
)
- source_room_id: Mapped[str] = mapped_column(
- Text, ForeignKey("rooms.id", ondelete="CASCADE"), primary_key=True
- )
- target_room_id: Mapped[str] = mapped_column(
- Text, ForeignKey("rooms.id", ondelete="CASCADE"), primary_key=True
- )
+ source_room_id: Mapped[str] = mapped_column(Text, primary_key=True)
+ target_room_id: Mapped[str] = mapped_column(Text, primary_key=True)
label: Mapped[str] = mapped_column(Text, nullable=False)
created_at: Mapped[str] = mapped_column(
DateTime(timezone=True), server_default=func.now(), nullable=False
@@ -431,17 +629,32 @@ class RoomLink(Base):
# ── Tasks ──────────────────────────────────────────────────────────────────────
-class Task(Base):
+class Task(TenantScoped, Base):
__tablename__ = "tasks"
+ __table_args__ = (
+ ForeignKeyConstraint(
+ ["tenant_id", "room_id"],
+ ["rooms.tenant_id", "rooms.id"],
+ name="fk_tasks_room",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "requester_agent_id"],
+ ["agents.tenant_id", "agents.id"],
+ name="fk_tasks_requester_agent",
+ ondelete="CASCADE",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "performer_agent_id"],
+ ["agents.tenant_id", "agents.id"],
+ name="fk_tasks_performer_agent",
+ ondelete="CASCADE",
+ ),
+ )
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
- room_id: Mapped[str] = mapped_column(Text, ForeignKey("rooms.id"), nullable=False)
- requester_agent_id: Mapped[str] = mapped_column(
- Text, ForeignKey("agents.id", ondelete="CASCADE"), nullable=False
- )
- performer_agent_id: Mapped[str] = mapped_column(
- Text, ForeignKey("agents.id", ondelete="CASCADE"), nullable=False
- )
+ room_id: Mapped[str] = mapped_column(Text, nullable=False)
+ requester_agent_id: Mapped[str] = mapped_column(Text, nullable=False)
+ performer_agent_id: Mapped[str] = mapped_column(Text, nullable=False)
summary: Mapped[str] = mapped_column(Text, nullable=False)
description: Mapped[str] = mapped_column(Text, nullable=False)
status: Mapped[str] = mapped_column(Text, nullable=False)
@@ -464,20 +677,57 @@ class Task(Base):
room_references = Table(
"room_references",
Base.metadata,
- Column("room_id", Text, ForeignKey("rooms.id"), primary_key=True),
- Column("reference_id", Text, ForeignKey("references.id"), primary_key=True),
+ Column(
+ "tenant_id",
+ Text,
+ ForeignKey("tenants.id"),
+ nullable=False,
+ default=TENANT_ZERO_ID,
+ ),
+ Column("room_id", Text, primary_key=True),
+ Column("reference_id", Text, primary_key=True),
+ ForeignKeyConstraint(
+ ["tenant_id", "room_id"],
+ ["rooms.tenant_id", "rooms.id"],
+ name="fk_room_references_room",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "reference_id"],
+ ["references.tenant_id", "references.id"],
+ name="fk_room_references_reference",
+ ),
)
room_documents = Table(
"room_documents",
Base.metadata,
- Column("room_id", Text, ForeignKey("rooms.id"), primary_key=True),
- Column("document_id", Text, ForeignKey("documents.id"), primary_key=True),
+ Column(
+ "tenant_id",
+ Text,
+ ForeignKey("tenants.id"),
+ nullable=False,
+ default=TENANT_ZERO_ID,
+ ),
+ Column("room_id", Text, primary_key=True),
+ Column("document_id", Text, primary_key=True),
+ ForeignKeyConstraint(
+ ["tenant_id", "room_id"],
+ ["rooms.tenant_id", "rooms.id"],
+ name="fk_room_documents_room",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "document_id"],
+ ["documents.tenant_id", "documents.id"],
+ name="fk_room_documents_document",
+ ),
)
-class Reference(Base):
+class Reference(TenantScoped, Base):
__tablename__ = "references"
+ __table_args__ = (
+ UniqueConstraint("id", "tenant_id", name="uq_references_id_tenant"),
+ )
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
owner_id: Mapped[str] = mapped_column(Text, ForeignKey("users.id"), nullable=False)
@@ -493,9 +743,21 @@ class Reference(Base):
)
-class ReferenceType(Base):
+class ReferenceType(TenantScoped, Base):
+ """A customer-defined reference type slug.
+
+ No surrogate `id`: the natural key is `(tenant_id, type)`, so `tenant_id`
+ joins the primary key directly here rather than through the `TenantScoped`
+ default alone — a type slug may collide across tenants the way `agents.name`
+ does. Nothing references this table by foreign key, so it is also the one
+ scoped table with no `unique (id, tenant_id)`.
+ """
+
__tablename__ = "reference_types"
+ tenant_id: Mapped[str] = mapped_column(
+ Text, ForeignKey("tenants.id"), primary_key=True, default=TENANT_ZERO_ID
+ )
type: Mapped[str] = mapped_column(Text, primary_key=True)
owner_id: Mapped[str] = mapped_column(Text, ForeignKey("users.id"), nullable=False)
read_visibility: Mapped[str] = mapped_column(Text, nullable=False)
@@ -508,7 +770,7 @@ class ReferenceType(Base):
)
-class Document(Base):
+class Document(TenantScoped, Base):
__tablename__ = "documents"
__table_args__ = (
Index(
@@ -518,18 +780,27 @@ class Document(Base):
unique=True,
postgresql_where=text("room_id IS NOT NULL"),
),
+ UniqueConstraint("id", "tenant_id", name="uq_documents_id_tenant"),
+ ForeignKeyConstraint(
+ ["tenant_id", "room_id"],
+ ["rooms.tenant_id", "rooms.id"],
+ name="fk_documents_room",
+ ondelete="CASCADE",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "created_by_agent_id"],
+ ["agents.tenant_id", "agents.id"],
+ name="fk_documents_created_by_agent",
+ ondelete="SET NULL (created_by_agent_id)",
+ ),
)
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
owner_id: Mapped[str | None] = mapped_column(
Text, ForeignKey("users.id"), nullable=True
)
- room_id: Mapped[str | None] = mapped_column(
- Text, ForeignKey("rooms.id", ondelete="CASCADE"), nullable=True
- )
- created_by_agent_id: Mapped[str | None] = mapped_column(
- Text, ForeignKey("agents.id", ondelete="SET NULL"), nullable=True
- )
+ room_id: Mapped[str | None] = mapped_column(Text, nullable=True)
+ created_by_agent_id: Mapped[str | None] = mapped_column(Text, nullable=True)
read_visibility: Mapped[str] = mapped_column(Text, nullable=False)
write_visibility: Mapped[str] = mapped_column(Text, nullable=False)
name: Mapped[str] = mapped_column(Text, nullable=False)
@@ -547,27 +818,81 @@ class Document(Base):
room_packages = Table(
"room_packages",
Base.metadata,
- Column("room_id", Text, ForeignKey("rooms.id"), primary_key=True),
- Column("package_id", Text, ForeignKey("packages.id"), primary_key=True),
+ Column(
+ "tenant_id",
+ Text,
+ ForeignKey("tenants.id"),
+ nullable=False,
+ default=TENANT_ZERO_ID,
+ ),
+ Column("room_id", Text, primary_key=True),
+ Column("package_id", Text, primary_key=True),
+ ForeignKeyConstraint(
+ ["tenant_id", "room_id"],
+ ["rooms.tenant_id", "rooms.id"],
+ name="fk_room_packages_room",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "package_id"],
+ ["packages.tenant_id", "packages.id"],
+ name="fk_room_packages_package",
+ ),
)
package_references = Table(
"package_references",
Base.metadata,
- Column("package_id", Text, ForeignKey("packages.id"), primary_key=True),
- Column("reference_id", Text, ForeignKey("references.id"), primary_key=True),
+ Column(
+ "tenant_id",
+ Text,
+ ForeignKey("tenants.id"),
+ nullable=False,
+ default=TENANT_ZERO_ID,
+ ),
+ Column("package_id", Text, primary_key=True),
+ Column("reference_id", Text, primary_key=True),
+ ForeignKeyConstraint(
+ ["tenant_id", "package_id"],
+ ["packages.tenant_id", "packages.id"],
+ name="fk_package_references_package",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "reference_id"],
+ ["references.tenant_id", "references.id"],
+ name="fk_package_references_reference",
+ ),
)
package_documents = Table(
"package_documents",
Base.metadata,
- Column("package_id", Text, ForeignKey("packages.id"), primary_key=True),
- Column("document_id", Text, ForeignKey("documents.id"), primary_key=True),
+ Column(
+ "tenant_id",
+ Text,
+ ForeignKey("tenants.id"),
+ nullable=False,
+ default=TENANT_ZERO_ID,
+ ),
+ Column("package_id", Text, primary_key=True),
+ Column("document_id", Text, primary_key=True),
+ ForeignKeyConstraint(
+ ["tenant_id", "package_id"],
+ ["packages.tenant_id", "packages.id"],
+ name="fk_package_documents_package",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "document_id"],
+ ["documents.tenant_id", "documents.id"],
+ name="fk_package_documents_document",
+ ),
)
-class Package(Base):
+class Package(TenantScoped, Base):
__tablename__ = "packages"
+ __table_args__ = (
+ UniqueConstraint("id", "tenant_id", name="uq_packages_id_tenant"),
+ )
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
owner_id: Mapped[str] = mapped_column(Text, ForeignKey("users.id"), nullable=False)
@@ -584,16 +909,31 @@ class Package(Base):
# ── Collaboration Bridges ──────────────────────────────────────────────────────
-class CollaborationBridge(Base):
+class CollaborationBridge(TenantScoped, Base):
__tablename__ = "collaboration_bridges"
+ __table_args__ = (
+ # The bridge new rooms land on when no bridge is named. At most one row
+ # per tenant may be true; this partial unique index is what actually
+ # enforces that, so concurrent writers cannot produce two defaults.
+ Index(
+ "ix_collaboration_bridges_single_default",
+ "tenant_id",
+ unique=True,
+ postgresql_where=text("is_default"),
+ ),
+ UniqueConstraint("id", "tenant_id", name="uq_collaboration_bridges_id_tenant"),
+ ForeignKeyConstraint(
+ ["tenant_id", "client_id"],
+ ["clients.tenant_id", "clients.id"],
+ name="fk_collaboration_bridges_client",
+ ),
+ )
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
type: Mapped[str] = mapped_column(Text, nullable=False)
display_name: Mapped[str] = mapped_column(Text, nullable=False)
connection_config: Mapped[dict | None] = mapped_column(JSONB, nullable=True)
- client_id: Mapped[str] = mapped_column(
- Text, ForeignKey("clients.id"), nullable=False
- )
+ client_id: Mapped[str] = mapped_column(Text, nullable=False)
status: Mapped[str] = mapped_column(Text, nullable=False)
agent_greetings_enabled: Mapped[bool] = mapped_column(
Boolean, server_default="true", nullable=False
@@ -608,9 +948,6 @@ class CollaborationBridge(Base):
channel_creation_enabled: Mapped[bool] = mapped_column(
Boolean, server_default="true", nullable=False
)
- # The bridge new rooms land on when no bridge is named. At most one row may
- # be true; the partial unique index below is what actually enforces that,
- # so concurrent writers cannot produce two defaults.
is_default: Mapped[bool] = mapped_column(
Boolean, server_default="false", nullable=False
)
@@ -618,29 +955,25 @@ class CollaborationBridge(Base):
DateTime(timezone=True), server_default=func.now(), nullable=False
)
- __table_args__ = (
- Index(
- "ix_collaboration_bridges_single_default",
- "is_default",
- unique=True,
- postgresql_where=text("is_default"),
- ),
- )
-
# ── Server-Side Connectors ────────────────────────────────────────────────────
-class ServerConnector(Base):
+class ServerConnector(TenantScoped, Base):
__tablename__ = "server_connectors"
+ __table_args__ = (
+ ForeignKeyConstraint(
+ ["tenant_id", "api_key_id"],
+ ["api_keys.tenant_id", "api_keys.id"],
+ name="fk_server_connectors_api_key",
+ ),
+ )
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
type: Mapped[str] = mapped_column(Text, nullable=False)
display_name: Mapped[str] = mapped_column(Text, nullable=False)
connection_config: Mapped[dict | None] = mapped_column(JSONB, nullable=True)
- api_key_id: Mapped[str] = mapped_column(
- Text, ForeignKey("api_keys.id"), nullable=False
- )
+ api_key_id: Mapped[str] = mapped_column(Text, nullable=False)
status: Mapped[str] = mapped_column(Text, nullable=False)
created_at: Mapped[str] = mapped_column(
DateTime(timezone=True), server_default=func.now(), nullable=False
@@ -650,25 +983,34 @@ class ServerConnector(Base):
# ── External Users ─────────────────────────────────────────────────────────────
-class ExternalUser(Base):
+class ExternalUser(TenantScoped, Base):
__tablename__ = "external_users"
- __table_args__ = (UniqueConstraint("bridge_id", "external_user_id"),)
+ __table_args__ = (
+ UniqueConstraint("bridge_id", "external_user_id"),
+ UniqueConstraint("id", "tenant_id", name="uq_external_users_id_tenant"),
+ ForeignKeyConstraint(
+ ["tenant_id", "bridge_id"],
+ ["collaboration_bridges.tenant_id", "collaboration_bridges.id"],
+ name="fk_external_users_bridge",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "client_id"],
+ ["clients.tenant_id", "clients.id"],
+ name="fk_external_users_client",
+ ),
+ )
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
- bridge_id: Mapped[str] = mapped_column(
- Text, ForeignKey("collaboration_bridges.id"), nullable=False
- )
+ bridge_id: Mapped[str] = mapped_column(Text, nullable=False)
external_user_id: Mapped[str] = mapped_column(Text, nullable=False)
external_username: Mapped[str] = mapped_column(Text, nullable=False)
- client_id: Mapped[str] = mapped_column(
- Text, ForeignKey("clients.id"), nullable=False
- )
+ client_id: Mapped[str] = mapped_column(Text, nullable=False)
created_at: Mapped[str] = mapped_column(
DateTime(timezone=True), server_default=func.now(), nullable=False
)
-class ExternalUserClaim(Base):
+class ExternalUserClaim(TenantScoped, Base):
"""A Switch user's claim that a platform account is theirs (CHOO-2137).
Deliberately many-to-many rather than a single owner per account: an
@@ -682,13 +1024,17 @@ class ExternalUserClaim(Base):
"""
__tablename__ = "external_user_claims"
- __table_args__ = (Index("ix_external_user_claims_user_id", "user_id"),)
-
- external_user_id: Mapped[str] = mapped_column(
- Text,
- ForeignKey("external_users.id", ondelete="CASCADE"),
- primary_key=True,
+ __table_args__ = (
+ Index("ix_external_user_claims_user_id", "user_id"),
+ ForeignKeyConstraint(
+ ["tenant_id", "external_user_id"],
+ ["external_users.tenant_id", "external_users.id"],
+ name="fk_external_user_claims_external_user",
+ ondelete="CASCADE",
+ ),
)
+
+ external_user_id: Mapped[str] = mapped_column(Text, primary_key=True)
user_id: Mapped[str] = mapped_column(
Text,
ForeignKey("users.id", ondelete="CASCADE"),
@@ -702,7 +1048,7 @@ class ExternalUserClaim(Base):
# ── Agent Sessions ────────────────────────────────────────────────────────────
-class AgentSession(Base):
+class AgentSession(TenantScoped, Base):
"""Tracks agent reachability and MCP-session room bindings.
Each row carries two independent pieces of state:
@@ -730,15 +1076,23 @@ class AgentSession(Base):
),
Index("ix_agent_sessions_agent_room", "agent_id", "room_id"),
Index("ix_agent_sessions_transport_session_id", "transport_session_id"),
+ ForeignKeyConstraint(
+ ["tenant_id", "agent_id"],
+ ["agents.tenant_id", "agents.id"],
+ name="fk_agent_sessions_agent",
+ ondelete="CASCADE",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "room_id"],
+ ["rooms.tenant_id", "rooms.id"],
+ name="fk_agent_sessions_room",
+ ondelete="CASCADE",
+ ),
)
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
- agent_id: Mapped[str] = mapped_column(
- Text, ForeignKey("agents.id", ondelete="CASCADE"), nullable=False
- )
- room_id: Mapped[str | None] = mapped_column(
- Text, ForeignKey("rooms.id", ondelete="CASCADE"), nullable=True
- )
+ agent_id: Mapped[str] = mapped_column(Text, nullable=False)
+ room_id: Mapped[str | None] = mapped_column(Text, nullable=True)
transport_session_id: Mapped[str | None] = mapped_column(Text, nullable=True)
lifecycle: Mapped[str] = mapped_column(Text, nullable=False)
last_seen_at: Mapped[str] = mapped_column(
@@ -749,7 +1103,7 @@ class AgentSession(Base):
)
-class AgentRuntimeState(Base):
+class AgentRuntimeState(TenantScoped, Base):
"""The runtime/liveness state of an agent's session as seen in one room.
Distinct from `AgentSession` (which tracks *reachability*): this captures
@@ -766,15 +1120,23 @@ class AgentRuntimeState(Base):
UniqueConstraint(
"agent_id", "room_id", name="uq_agent_runtime_states_agent_room"
),
+ ForeignKeyConstraint(
+ ["tenant_id", "agent_id"],
+ ["agents.tenant_id", "agents.id"],
+ name="fk_agent_runtime_states_agent",
+ ondelete="CASCADE",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "room_id"],
+ ["rooms.tenant_id", "rooms.id"],
+ name="fk_agent_runtime_states_room",
+ ondelete="CASCADE",
+ ),
)
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
- agent_id: Mapped[str] = mapped_column(
- Text, ForeignKey("agents.id", ondelete="CASCADE"), nullable=False
- )
- room_id: Mapped[str] = mapped_column(
- Text, ForeignKey("rooms.id", ondelete="CASCADE"), nullable=False
- )
+ agent_id: Mapped[str] = mapped_column(Text, nullable=False)
+ room_id: Mapped[str] = mapped_column(Text, nullable=False)
state: Mapped[str] = mapped_column(Text, nullable=False)
# The switchdash://session deeplink the reporting client (Switch Console) last
# sent for this (agent, room), so `!status` can surface an on-demand link to
@@ -797,7 +1159,7 @@ class AgentRuntimeState(Base):
# ── Room Roles ────────────────────────────────────────────────────────────────
-class RoomRole(Base):
+class RoomRole(TenantScoped, Base):
"""A first-class, per-room, assumable instruction bundle.
A role is a named bundle of instructions scoped to a single room, decoupled
@@ -817,12 +1179,17 @@ class RoomRole(Base):
__tablename__ = "room_roles"
__table_args__ = (
UniqueConstraint("room_id", "name", name="uq_room_roles_room_name"),
+ UniqueConstraint("id", "tenant_id", name="uq_room_roles_id_tenant"),
+ ForeignKeyConstraint(
+ ["tenant_id", "room_id"],
+ ["rooms.tenant_id", "rooms.id"],
+ name="fk_room_roles_room",
+ ondelete="CASCADE",
+ ),
)
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
- room_id: Mapped[str] = mapped_column(
- Text, ForeignKey("rooms.id", ondelete="CASCADE"), nullable=False
- )
+ room_id: Mapped[str] = mapped_column(Text, nullable=False)
name: Mapped[str] = mapped_column(Text, nullable=False)
instructions: Mapped[str] = mapped_column(Text, nullable=False)
exclusive: Mapped[bool] = mapped_column(
@@ -834,7 +1201,7 @@ class RoomRole(Base):
)
-class RoleLease(Base):
+class RoleLease(TenantScoped, Base):
"""The current holder of a room-role, with heartbeat-based auto-release.
A lease records that `agent_id` currently holds `role_id` in `room_id`. A
@@ -854,18 +1221,30 @@ class RoleLease(Base):
__table_args__ = (
UniqueConstraint("agent_id", name="uq_role_leases_agent"),
Index("ix_role_leases_role_id", "role_id"),
+ ForeignKeyConstraint(
+ ["tenant_id", "role_id"],
+ ["room_roles.tenant_id", "room_roles.id"],
+ name="fk_role_leases_role",
+ ondelete="CASCADE",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "room_id"],
+ ["rooms.tenant_id", "rooms.id"],
+ name="fk_role_leases_room",
+ ondelete="CASCADE",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "agent_id"],
+ ["agents.tenant_id", "agents.id"],
+ name="fk_role_leases_agent",
+ ondelete="CASCADE",
+ ),
)
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
- role_id: Mapped[str] = mapped_column(
- Text, ForeignKey("room_roles.id", ondelete="CASCADE"), nullable=False
- )
- room_id: Mapped[str] = mapped_column(
- Text, ForeignKey("rooms.id", ondelete="CASCADE"), nullable=False
- )
- agent_id: Mapped[str] = mapped_column(
- Text, ForeignKey("agents.id", ondelete="CASCADE"), nullable=False
- )
+ role_id: Mapped[str] = mapped_column(Text, nullable=False)
+ room_id: Mapped[str] = mapped_column(Text, nullable=False)
+ agent_id: Mapped[str] = mapped_column(Text, nullable=False)
transport_session_id: Mapped[str | None] = mapped_column(Text, nullable=True)
acquired_at: Mapped[str] = mapped_column(
DateTime(timezone=True), server_default=func.now(), nullable=False
@@ -878,7 +1257,7 @@ class RoleLease(Base):
# ── Bridge message map ──────────────────────────────────────────────────────────
-class BridgeMessageMap(Base):
+class BridgeMessageMap(TenantScoped, Base):
"""Durable correlation between a Switch event and its external counterpart.
One row per bridged message, written in both directions. Powers thread
@@ -892,12 +1271,16 @@ class BridgeMessageMap(Base):
__table_args__ = (
UniqueConstraint("bridge_id", "transport_event_id"),
UniqueConstraint("bridge_id", "external_post_id"),
+ ForeignKeyConstraint(
+ ["tenant_id", "bridge_id"],
+ ["collaboration_bridges.tenant_id", "collaboration_bridges.id"],
+ name="fk_bridge_message_map_bridge",
+ ondelete="CASCADE",
+ ),
)
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
- bridge_id: Mapped[str] = mapped_column(
- Text, ForeignKey("collaboration_bridges.id", ondelete="CASCADE"), nullable=False
- )
+ bridge_id: Mapped[str] = mapped_column(Text, nullable=False)
external_channel_id: Mapped[str] = mapped_column(Text, nullable=False)
transport_event_id: Mapped[str] = mapped_column(Text, nullable=False)
external_post_id: Mapped[str] = mapped_column(Text, nullable=False)
@@ -932,7 +1315,7 @@ class FeatureFlag(Base):
# ── Messages ─────────────────────────────────────────────────────────────────
-class Message(Base):
+class Message(TenantScoped, Base):
"""A message as it was sent into a room.
Written alongside the send to the message bus, which remains the source of
@@ -963,6 +1346,19 @@ class Message(Base):
"thread_root_event_id",
postgresql_where=text("thread_root_event_id IS NOT NULL"),
),
+ UniqueConstraint("id", "tenant_id", name="uq_messages_id_tenant"),
+ ForeignKeyConstraint(
+ ["tenant_id", "room_id"],
+ ["rooms.tenant_id", "rooms.id"],
+ name="fk_messages_room",
+ ondelete="CASCADE",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "sender_client_id"],
+ ["clients.tenant_id", "clients.id"],
+ name="fk_messages_sender_client",
+ ondelete="SET NULL (sender_client_id)",
+ ),
)
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
@@ -973,14 +1369,12 @@ class Message(Base):
# paging on `seq > n` would step straight over it. See the store for the
# argument in full.
seq: Mapped[int] = mapped_column(BigInteger, nullable=False)
- room_id: Mapped[str] = mapped_column(
- Text, ForeignKey("rooms.id", ondelete="CASCADE"), nullable=False
- )
+ room_id: Mapped[str] = mapped_column(Text, nullable=False)
+ # Global on purpose: a random, globally-unique identifier — scoping it
+ # buys nothing.
transport_event_id: Mapped[str] = mapped_column(Text, unique=True, nullable=False)
sender_id: Mapped[str] = mapped_column(Text, nullable=False)
- sender_client_id: Mapped[str | None] = mapped_column(
- Text, ForeignKey("clients.id", ondelete="SET NULL"), nullable=True
- )
+ sender_client_id: Mapped[str | None] = mapped_column(Text, nullable=True)
sender_name: Mapped[str | None] = mapped_column(Text, nullable=True)
event_type: Mapped[str] = mapped_column(Text, nullable=False)
msgtype: Mapped[str | None] = mapped_column(Text, nullable=True)
@@ -993,7 +1387,7 @@ class Message(Base):
)
-class MessageAttachment(Base):
+class MessageAttachment(TenantScoped, Base):
"""A file carried by a message.
One row per file, so a multi-file send is several rows against one message
@@ -1001,12 +1395,18 @@ class MessageAttachment(Base):
"""
__tablename__ = "message_attachments"
- __table_args__ = (Index("ix_message_attachments_message", "message_id"),)
+ __table_args__ = (
+ Index("ix_message_attachments_message", "message_id"),
+ ForeignKeyConstraint(
+ ["tenant_id", "message_id"],
+ ["messages.tenant_id", "messages.id"],
+ name="fk_message_attachments_message",
+ ondelete="CASCADE",
+ ),
+ )
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
- message_id: Mapped[str] = mapped_column(
- Text, ForeignKey("messages.id", ondelete="CASCADE"), nullable=False
- )
+ message_id: Mapped[str] = mapped_column(Text, nullable=False)
position: Mapped[int] = mapped_column(Integer, nullable=False)
uri: Mapped[str] = mapped_column(Text, nullable=False)
filename: Mapped[str | None] = mapped_column(Text, nullable=True)
@@ -1017,7 +1417,7 @@ class MessageAttachment(Base):
)
-class DeliveryCursor(Base):
+class DeliveryCursor(TenantScoped, Base):
"""How far one agent has been delivered in one room.
The cursor it replaces lived in memory in the event buffer, so a restart
@@ -1036,15 +1436,23 @@ class DeliveryCursor(Base):
__tablename__ = "delivery_cursors"
__table_args__ = (
UniqueConstraint("agent_id", "room_id", name="uq_delivery_cursors_agent_room"),
+ ForeignKeyConstraint(
+ ["tenant_id", "agent_id"],
+ ["agents.tenant_id", "agents.id"],
+ name="fk_delivery_cursors_agent",
+ ondelete="CASCADE",
+ ),
+ ForeignKeyConstraint(
+ ["tenant_id", "room_id"],
+ ["rooms.tenant_id", "rooms.id"],
+ name="fk_delivery_cursors_room",
+ ondelete="CASCADE",
+ ),
)
id: Mapped[str] = mapped_column(Text, primary_key=True, default=_uuid)
- agent_id: Mapped[str] = mapped_column(
- Text, ForeignKey("agents.id", ondelete="CASCADE"), nullable=False
- )
- room_id: Mapped[str] = mapped_column(
- Text, ForeignKey("rooms.id", ondelete="CASCADE"), nullable=False
- )
+ agent_id: Mapped[str] = mapped_column(Text, nullable=False)
+ room_id: Mapped[str] = mapped_column(Text, nullable=False)
last_seq: Mapped[int] = mapped_column(BigInteger, nullable=False, default=0)
updated_at: Mapped[str] = mapped_column(
DateTime(timezone=True),
@@ -1054,7 +1462,7 @@ class DeliveryCursor(Base):
)
-class MediaBlob(Base):
+class MediaBlob(TenantScoped, Base):
"""The bytes behind an attachment.
Media used to live in the homeserver's own store, reached by an opaque
@@ -1074,6 +1482,10 @@ class MediaBlob(Base):
unreferenced and a later sweep can find them by that. Cascading from the
attachment instead would delete the bytes of a file that two messages
quote.
+
+ Scoped although nothing references it by foreign key: it holds attachment
+ bytes reached by an opaque URI, and an unguessable identifier is not an
+ isolation boundary.
"""
__tablename__ = "media_blobs"
diff --git a/core/switch_core/db/stores/reference_type_store.py b/core/switch_core/db/stores/reference_type_store.py
index a86d3c81c..4a5455667 100644
--- a/core/switch_core/db/stores/reference_type_store.py
+++ b/core/switch_core/db/stores/reference_type_store.py
@@ -2,7 +2,7 @@ from sqlalchemy import ColumnElement, func, or_, select
from sqlalchemy.exc import IntegrityError
from sqlalchemy.ext.asyncio import AsyncSession
-from switch_core.db.models import Reference, ReferenceType
+from switch_core.db.models import TENANT_ZERO_ID, Reference, ReferenceType
class ReferenceTypeStore:
@@ -28,7 +28,8 @@ class ReferenceTypeStore:
return reference_type
async def get(self, session: AsyncSession, type_: str) -> ReferenceType | None:
- return await session.get(ReferenceType, type_)
+ # TODO(next PR): use the request's tenant instead of TENANT_ZERO_ID.
+ return await session.get(ReferenceType, (TENANT_ZERO_ID, type_))
async def get_many(
self, session: AsyncSession, types: list[str]
@@ -75,7 +76,8 @@ class ReferenceTypeStore:
read_visibility: str | None = None,
write_visibility: str | None = None,
) -> ReferenceType:
- rt = await session.get(ReferenceType, type_)
+ # TODO(next PR): use the request's tenant instead of TENANT_ZERO_ID.
+ rt = await session.get(ReferenceType, (TENANT_ZERO_ID, type_))
if rt is None:
raise ValueError(f"Reference type not found: {type_}")
if display_name is not None:
@@ -92,7 +94,8 @@ class ReferenceTypeStore:
return rt
async def delete(self, session: AsyncSession, type_: str) -> None:
- rt = await session.get(ReferenceType, type_)
+ # TODO(next PR): use the request's tenant instead of TENANT_ZERO_ID.
+ rt = await session.get(ReferenceType, (TENANT_ZERO_ID, type_))
if rt is None:
raise ValueError(f"Reference type not found: {type_}")
await session.delete(rt)
diff --git a/core/switch_core/migrations/versions/8b276792ee30_multi_tenancy_tenants_and_tenant_id.py b/core/switch_core/migrations/versions/8b276792ee30_multi_tenancy_tenants_and_tenant_id.py
new file mode 100644
index 000000000..abced0f85
--- /dev/null
+++ b/core/switch_core/migrations/versions/8b276792ee30_multi_tenancy_tenants_and_tenant_id.py
@@ -0,0 +1,807 @@
+"""multi-tenancy phase 1: tenants, tenant_members, and tenant_id everywhere
+
+Implements the schema half of Phase 1 multi-tenancy (see
+`docs/old/multi-tenancy-phase1-db.md`): every table holding customer data
+gains a non-null `tenant_id`, and every foreign key between two such tables
+gains it too, so a row can no longer reference a parent in another tenant.
+
+Order:
+
+1. Create `tenants` and `tenant_members`.
+2. Insert tenant zero — the one tenant that exists before this migration
+ runs — with a fixed id written literally below rather than imported from
+ `switch_core.db.models.TENANT_ZERO_ID`. A migration is a record of a
+ change that already happened; importing the live constant would let a
+ later edit to it silently change what this migration means, the same
+ reason the notify trigger keeps a frozen copy of its DDL instead of
+ importing `notify_ddl.py`.
+3. Insert a `tenant_members` row for every existing user: `owner` where
+ `users.role = 'admin'`, `member` otherwise.
+4. Add `tenant_id` to every scoped table as `NOT NULL DEFAULT '<zero>'`, then
+ drop the default. Since Postgres 11, adding a column with a constant
+ default is a metadata-only change — no rewrite, no table lock beyond
+ `ACCESS EXCLUSIVE` for the instant it takes to update the catalog. The
+ alternative sequence (nullable, backfill every row, then `SET NOT NULL`)
+ is what the spike proposed and is not needed here: there is only one
+ tenant to backfill to, the same constant for every row, so a computed
+ backfill buys nothing and would rewrite `messages` and `media_blobs`
+ (20MB rows) under an exclusive lock instead.
+5. Add the foreign key to `tenants`, and `UNIQUE (id, tenant_id)` on the
+ tables actually referenced by a composite key.
+6. Swap the uniqueness constraints that were global singletons and are not
+ anymore: `agents.name`, `clients.matrix_user_id`, `rooms.matrix_room_id`,
+ the `reference_types` primary key, and the `collaboration_bridges`
+ default-bridge partial index.
+7. Rewrite every scoped-to-scoped foreign key as composite: drop the old
+ single-column constraint, add the new one `NOT VALID`, then `VALIDATE
+ CONSTRAINT` — so the validation scan takes a lock no stronger than a
+ plain read for the duration of the scan, rather than blocking writes for
+ as long as the scan takes. Five keys use the Postgres 15+ column-list
+ `ON DELETE SET NULL (<col>)` form: a plain multi-column `SET NULL` would
+ null every referencing column including `tenant_id`, which then fails
+ the new NOT NULL constraint on the very delete this is meant to allow.
+
+This migration creates no roles, issues no grants, and adds no row-level
+security policy — that is a separate, later change (see the design doc's
+"runtime role" section).
+
+Only tenant zero exists when this runs, so the usual expand-then-contract
+caution does not apply yet: there is no second tenant's traffic to keep
+running against the old shape while this lands. From the next customer
+onward it does, and any future schema change here must be split into an
+expand migration (deployed, then the application updated to use the new
+shape) and a contract migration (deployed once nothing reads the old shape),
+never both at once.
+
+Revision ID: 8b276792ee30
+Revises: b47e0c39a1f5
+Create Date: 2026-09-09 00:00:00.000000
+
+"""
+
+from collections.abc import Sequence
+
+import sqlalchemy as sa
+from alembic import op
+
+revision: str = "8b276792ee30"
+down_revision: str | None = "b47e0c39a1f5"
+branch_labels: str | Sequence[str] | None = None
+depends_on: str | Sequence[str] | None = None
+
+# The fixed id of the one tenant that exists before a second is ever
+# onboarded. Matches `switch_core.db.models.TENANT_ZERO_ID`, copied rather
+# than imported — see the module docstring.
+TENANT_ZERO_ID = "00000000-0000-0000-0000-000000000000"
+
+# Every table gaining `tenant_id`. Order doesn't matter for the column add
+# (each statement stands alone), so this is alphabetical rather than
+# dependency order.
+SCOPED_TABLES = [
+ "agent_runtime_states",
+ "agent_sessions",
+ "agent_skills",
+ "agents",
+ "api_keys",
+ "bridge_message_map",
+ "client_rooms",
+ "clients",
+ "collaboration_bridges",
+ "delivery_cursors",
+ "documents",
+ "external_user_claims",
+ "external_users",
+ "media_blobs",
+ "message_attachments",
+ "messages",
+ "models",
+ "package_documents",
+ "package_references",
+ "packages",
+ "reference_types",
+ "references",
+ "role_leases",
+ "room_agents",
+ "room_documents",
+ "room_groups",
+ "room_links",
+ "room_packages",
+ "room_references",
+ "room_roles",
+ "room_skills",
+ "rooms",
+ "server_connectors",
+ "skills",
+ "tasks",
+ "tools",
+]
+
+# The 13 scoped tables referenced by a composite foreign key elsewhere, and so
+# need `UNIQUE (id, tenant_id)` in addition to the plain FK to `tenants`.
+# `reference_types` has no surrogate `id` at all (its natural key already
+# becomes the composite primary key below) so it is not in this list even
+# though it is scoped.
+ID_TENANT_UNIQUE_TABLES = [
+ "agents",
+ "api_keys",
+ "clients",
+ "collaboration_bridges",
+ "documents",
+ "external_users",
+ "messages",
+ "packages",
+ "references",
+ "room_groups",
+ "room_roles",
+ "rooms",
+ "skills",
+]
+
+# Every foreign key from a scoped table to another scoped table, rewritten to
+# carry `tenant_id`. `ondelete` is the *new* (possibly column-list) clause;
+# `downgrade` derives the original single-column clause from it.
+#
+# (table, old_constraint_name, local_column, ref_table, ref_column, new_constraint_name, ondelete)
+FK_REWRITES: list[tuple[str, str, str, str, str, str, str | None]] = [
+ (
+ "client_rooms",
+ "client_rooms_client_id_fkey",
+ "client_id",
+ "clients",
+ "id",
+ "fk_client_rooms_client",
+ None,
+ ),
+ (
+ "client_rooms",
+ "client_rooms_room_id_fkey",
+ "room_id",
+ "rooms",
+ "id",
+ "fk_client_rooms_room",
+ None,
+ ),
+ (
+ "agents",
+ "agents_client_id_fkey",
+ "client_id",
+ "clients",
+ "id",
+ "fk_agents_client",
+ None,
+ ),
+ (
+ "agents",
+ "fk_agents_api_key_id",
+ "api_key_id",
+ "api_keys",
+ "id",
+ "fk_agents_api_key",
+ None,
+ ),
+ (
+ "agents",
+ "fk_agents_parent_agent_id",
+ "parent_agent_id",
+ "agents",
+ "id",
+ "fk_agents_parent_agent",
+ "SET NULL (parent_agent_id)",
+ ),
+ (
+ "tools",
+ "tools_agent_id_fkey",
+ "agent_id",
+ "agents",
+ "id",
+ "fk_tools_agent",
+ None,
+ ),
+ (
+ "models",
+ "models_agent_id_fkey",
+ "agent_id",
+ "agents",
+ "id",
+ "fk_models_agent",
+ None,
+ ),
+ (
+ "skills",
+ "skills_owner_agent_id_fkey",
+ "owner_agent_id",
+ "agents",
+ "id",
+ "fk_skills_owner_agent",
+ None,
+ ),
+ (
+ "agent_skills",
+ "agent_skills_agent_id_fkey",
+ "agent_id",
+ "agents",
+ "id",
+ "fk_agent_skills_agent",
+ None,
+ ),
+ (
+ "agent_skills",
+ "agent_skills_skill_id_fkey",
+ "skill_id",
+ "skills",
+ "id",
+ "fk_agent_skills_skill",
+ None,
+ ),
+ (
+ "rooms",
+ "rooms_bridge_id_fkey",
+ "bridge_id",
+ "collaboration_bridges",
+ "id",
+ "fk_rooms_bridge",
+ None,
+ ),
+ (
+ "rooms",
+ "rooms_group_id_fkey",
+ "group_id",
+ "room_groups",
+ "id",
+ "fk_rooms_group",
+ "SET NULL (group_id)",
+ ),
+ (
+ "room_agents",
+ "room_agents_room_id_fkey",
+ "room_id",
+ "rooms",
+ "id",
+ "fk_room_agents_room",
+ None,
+ ),
+ (
+ "room_agents",
+ "room_agents_agent_id_fkey",
+ "agent_id",
+ "agents",
+ "id",
+ "fk_room_agents_agent",
+ None,
+ ),
+ (
+ "room_skills",
+ "room_skills_room_id_fkey",
+ "room_id",
+ "rooms",
+ "id",
+ "fk_room_skills_room",
+ None,
+ ),
+ (
+ "room_skills",
+ "room_skills_skill_id_fkey",
+ "skill_id",
+ "skills",
+ "id",
+ "fk_room_skills_skill",
+ None,
+ ),
+ (
+ "room_groups",
+ "room_groups_parent_group_id_fkey",
+ "parent_group_id",
+ "room_groups",
+ "id",
+ "fk_room_groups_parent_group",
+ "SET NULL (parent_group_id)",
+ ),
+ (
+ "room_links",
+ "room_links_source_room_id_fkey",
+ "source_room_id",
+ "rooms",
+ "id",
+ "fk_room_links_source_room",
+ "CASCADE",
+ ),
+ (
+ "room_links",
+ "room_links_target_room_id_fkey",
+ "target_room_id",
+ "rooms",
+ "id",
+ "fk_room_links_target_room",
+ "CASCADE",
+ ),
+ (
+ "room_roles",
+ "room_roles_room_id_fkey",
+ "room_id",
+ "rooms",
+ "id",
+ "fk_room_roles_room",
+ "CASCADE",
+ ),
+ (
+ "role_leases",
+ "role_leases_role_id_fkey",
+ "role_id",
+ "room_roles",
+ "id",
+ "fk_role_leases_role",
+ "CASCADE",
+ ),
+ (
+ "role_leases",
+ "role_leases_room_id_fkey",
+ "room_id",
+ "rooms",
+ "id",
+ "fk_role_leases_room",
+ "CASCADE",
+ ),
+ (
+ "role_leases",
+ "role_leases_agent_id_fkey",
+ "agent_id",
+ "agents",
+ "id",
+ "fk_role_leases_agent",
+ "CASCADE",
+ ),
+ ("tasks", "tasks_room_id_fkey", "room_id", "rooms", "id", "fk_tasks_room", None),
+ (
+ "tasks",
+ "tasks_requester_agent_id_fkey",
+ "requester_agent_id",
+ "agents",
+ "id",
+ "fk_tasks_requester_agent",
+ "CASCADE",
+ ),
+ (
+ "tasks",
+ "tasks_performer_agent_id_fkey",
+ "performer_agent_id",
+ "agents",
+ "id",
+ "fk_tasks_performer_agent",
+ "CASCADE",
+ ),
+ (
+ "documents",
+ "documents_room_id_fkey",
+ "room_id",
+ "rooms",
+ "id",
+ "fk_documents_room",
+ "CASCADE",
+ ),
+ (
+ "documents",
+ "documents_created_by_agent_id_fkey",
+ "created_by_agent_id",
+ "agents",
+ "id",
+ "fk_documents_created_by_agent",
+ "SET NULL (created_by_agent_id)",
+ ),
+ (
+ "room_references",
+ "room_references_room_id_fkey",
+ "room_id",
+ "rooms",
+ "id",
+ "fk_room_references_room",
+ None,
+ ),
+ (
+ "room_references",
+ "room_references_reference_id_fkey",
+ "reference_id",
+ "references",
+ "id",
+ "fk_room_references_reference",
+ None,
+ ),
+ (
+ "room_documents",
+ "room_documents_room_id_fkey",
+ "room_id",
+ "rooms",
+ "id",
+ "fk_room_documents_room",
+ None,
+ ),
+ (
+ "room_documents",
+ "room_documents_document_id_fkey",
+ "document_id",
+ "documents",
+ "id",
+ "fk_room_documents_document",
+ None,
+ ),
+ (
+ "room_packages",
+ "room_packages_room_id_fkey",
+ "room_id",
+ "rooms",
+ "id",
+ "fk_room_packages_room",
+ None,
+ ),
+ (
+ "room_packages",
+ "room_packages_package_id_fkey",
+ "package_id",
+ "packages",
+ "id",
+ "fk_room_packages_package",
+ None,
+ ),
+ (
+ "package_references",
+ "package_references_package_id_fkey",
+ "package_id",
+ "packages",
+ "id",
+ "fk_package_references_package",
+ None,
+ ),
+ (
+ "package_references",
+ "package_references_reference_id_fkey",
+ "reference_id",
+ "references",
+ "id",
+ "fk_package_references_reference",
+ None,
+ ),
+ (
+ "package_documents",
+ "package_documents_package_id_fkey",
+ "package_id",
+ "packages",
+ "id",
+ "fk_package_documents_package",
+ None,
+ ),
+ (
+ "package_documents",
+ "package_documents_document_id_fkey",
+ "document_id",
+ "documents",
+ "id",
+ "fk_package_documents_document",
+ None,
+ ),
+ (
+ "collaboration_bridges",
+ "collaboration_bridges_client_id_fkey",
+ "client_id",
+ "clients",
+ "id",
+ "fk_collaboration_bridges_client",
+ None,
+ ),
+ (
+ "server_connectors",
+ "server_connectors_api_key_id_fkey",
+ "api_key_id",
+ "api_keys",
+ "id",
+ "fk_server_connectors_api_key",
+ None,
+ ),
+ (
+ "external_users",
+ "external_users_bridge_id_fkey",
+ "bridge_id",
+ "collaboration_bridges",
+ "id",
+ "fk_external_users_bridge",
+ None,
+ ),
+ (
+ "external_users",
+ "external_users_client_id_fkey",
+ "client_id",
+ "clients",
+ "id",
+ "fk_external_users_client",
+ None,
+ ),
+ (
+ "external_user_claims",
+ "external_user_claims_external_user_id_fkey",
+ "external_user_id",
+ "external_users",
+ "id",
+ "fk_external_user_claims_external_user",
+ "CASCADE",
+ ),
+ (
+ "agent_sessions",
+ "agent_sessions_agent_id_fkey",
+ "agent_id",
+ "agents",
+ "id",
+ "fk_agent_sessions_agent",
+ "CASCADE",
+ ),
+ (
+ "agent_sessions",
+ "agent_sessions_room_id_fkey",
+ "room_id",
+ "rooms",
+ "id",
+ "fk_agent_sessions_room",
+ "CASCADE",
+ ),
+ (
+ "agent_runtime_states",
+ "agent_runtime_states_agent_id_fkey",
+ "agent_id",
+ "agents",
+ "id",
+ "fk_agent_runtime_states_agent",
+ "CASCADE",
+ ),
+ (
+ "agent_runtime_states",
+ "agent_runtime_states_room_id_fkey",
+ "room_id",
+ "rooms",
+ "id",
+ "fk_agent_runtime_states_room",
+ "CASCADE",
+ ),
+ (
+ "bridge_message_map",
+ "bridge_message_map_bridge_id_fkey",
+ "bridge_id",
+ "collaboration_bridges",
+ "id",
+ "fk_bridge_message_map_bridge",
+ "CASCADE",
+ ),
+ (
+ "messages",
+ "messages_room_id_fkey",
+ "room_id",
+ "rooms",
+ "id",
+ "fk_messages_room",
+ "CASCADE",
+ ),
+ (
+ "messages",
+ "messages_sender_client_id_fkey",
+ "sender_client_id",
+ "clients",
+ "id",
+ "fk_messages_sender_client",
+ "SET NULL (sender_client_id)",
+ ),
+ (
+ "message_attachments",
+ "message_attachments_message_id_fkey",
+ "message_id",
+ "messages",
+ "id",
+ "fk_message_attachments_message",
+ "CASCADE",
+ ),
+ (
+ "delivery_cursors",
+ "delivery_cursors_agent_id_fkey",
+ "agent_id",
+ "agents",
+ "id",
+ "fk_delivery_cursors_agent",
+ "CASCADE",
+ ),
+ (
+ "delivery_cursors",
+ "delivery_cursors_room_id_fkey",
+ "room_id",
+ "rooms",
+ "id",
+ "fk_delivery_cursors_room",
+ "CASCADE",
+ ),
+]
+
+
+def _single_column_ondelete(ondelete: str | None) -> str | None:
+ """Strip a column-list `SET NULL (col)` back to plain `SET NULL`."""
+ if ondelete is None:
+ return None
+ return ondelete.split(" (")[0]
+
+
+def upgrade() -> None:
+ # 1. New tables.
+ op.create_table(
+ "tenants",
+ sa.Column("id", sa.Text(), nullable=False),
+ sa.Column("slug", sa.Text(), nullable=False),
+ sa.Column("name", sa.Text(), nullable=False),
+ sa.Column(
+ "created_at",
+ sa.DateTime(timezone=True),
+ server_default=sa.text("now()"),
+ nullable=False,
+ ),
+ sa.PrimaryKeyConstraint("id"),
+ sa.UniqueConstraint("slug"),
+ )
+ op.create_table(
+ "tenant_members",
+ sa.Column("tenant_id", sa.Text(), nullable=False),
+ sa.Column("user_id", sa.Text(), nullable=False),
+ sa.Column("role", sa.Text(), nullable=False),
+ sa.Column(
+ "created_at",
+ sa.DateTime(timezone=True),
+ server_default=sa.text("now()"),
+ nullable=False,
+ ),
+ sa.CheckConstraint(
+ "role IN ('owner', 'admin', 'member')", name="ck_tenant_members_role"
+ ),
+ sa.ForeignKeyConstraint(["tenant_id"], ["tenants.id"]),
+ sa.ForeignKeyConstraint(["user_id"], ["users.id"]),
+ sa.PrimaryKeyConstraint("tenant_id", "user_id"),
+ )
+
+ # 2. Tenant zero.
+ op.execute(
+ f"""
+ INSERT INTO tenants (id, slug, name)
+ VALUES ('{TENANT_ZERO_ID}', 'default', 'Default')
+ """
+ )
+
+ # 3. A membership row for every existing user.
+ op.execute(
+ f"""
+ INSERT INTO tenant_members (tenant_id, user_id, role)
+ SELECT '{TENANT_ZERO_ID}', id, CASE WHEN role = 'admin' THEN 'owner' ELSE 'member' END
+ FROM users
+ """
+ )
+
+ # 4. `tenant_id` on every scoped table, metadata-only (default then drop
+ # the default, never backfill-then-set-not-null — see the docstring).
+ for table in SCOPED_TABLES:
+ op.add_column(
+ table,
+ sa.Column(
+ "tenant_id",
+ sa.Text(),
+ nullable=False,
+ server_default=TENANT_ZERO_ID,
+ ),
+ )
+ op.alter_column(table, "tenant_id", server_default=None)
+
+ # 5. FK to tenants, and UNIQUE (id, tenant_id) where referenced.
+ for table in SCOPED_TABLES:
+ op.create_foreign_key(
+ f"fk_{table}_tenant", table, "tenants", ["tenant_id"], ["id"]
+ )
+ for table in ID_TENANT_UNIQUE_TABLES:
+ op.create_unique_constraint(f"uq_{table}_id_tenant", table, ["id", "tenant_id"])
+
+ # 6. Uniqueness swaps.
+ op.drop_constraint("agents_name_key", "agents", type_="unique")
+ op.create_unique_constraint(
+ "uq_agents_tenant_name", "agents", ["tenant_id", "name"]
+ )
+
+ op.drop_constraint("clients_matrix_user_id_key", "clients", type_="unique")
+ op.create_unique_constraint(
+ "uq_clients_tenant_matrix_user_id", "clients", ["tenant_id", "matrix_user_id"]
+ )
+
+ op.drop_constraint("rooms_matrix_room_id_key", "rooms", type_="unique")
+ op.create_unique_constraint(
+ "uq_rooms_tenant_matrix_room_id", "rooms", ["tenant_id", "matrix_room_id"]
+ )
+
+ op.drop_constraint("reference_types_pkey", "reference_types", type_="primary")
+ op.create_primary_key(
+ "reference_types_pkey", "reference_types", ["tenant_id", "type"]
+ )
+
+ op.drop_index(
+ "ix_collaboration_bridges_single_default", table_name="collaboration_bridges"
+ )
+ op.create_index(
+ "ix_collaboration_bridges_single_default",
+ "collaboration_bridges",
+ ["tenant_id"],
+ unique=True,
+ postgresql_where=sa.text("is_default"),
+ )
+
+ # 7. Rewrite every scoped-to-scoped FK as composite.
+ for (
+ table,
+ old_name,
+ local_col,
+ ref_table,
+ ref_col,
+ new_name,
+ ondelete,
+ ) in FK_REWRITES:
+ op.drop_constraint(old_name, table, type_="foreignkey")
+ op.create_foreign_key(
+ new_name,
+ table,
+ ref_table,
+ ["tenant_id", local_col],
+ ["tenant_id", ref_col],
+ ondelete=ondelete,
+ postgresql_not_valid=True,
+ )
+ op.execute(f'ALTER TABLE "{table}" VALIDATE CONSTRAINT {new_name}')
+
+
+def downgrade() -> None:
+ # 7. Restore single-column FKs.
+ for table, old_name, local_col, ref_table, ref_col, new_name, ondelete in reversed(
+ FK_REWRITES
+ ):
+ op.drop_constraint(new_name, table, type_="foreignkey")
+ op.create_foreign_key(
+ old_name,
+ table,
+ ref_table,
+ [local_col],
+ [ref_col],
+ ondelete=_single_column_ondelete(ondelete),
+ )
+
+ # 6. Restore original uniqueness.
+ op.drop_index(
+ "ix_collaboration_bridges_single_default", table_name="collaboration_bridges"
+ )
+ op.create_index(
+ "ix_collaboration_bridges_single_default",
+ "collaboration_bridges",
+ ["is_default"],
+ unique=True,
+ postgresql_where=sa.text("is_default"),
+ )
+
+ op.drop_constraint("reference_types_pkey", "reference_types", type_="primary")
+ op.create_primary_key("reference_types_pkey", "reference_types", ["type"])
+
+ op.drop_constraint("uq_rooms_tenant_matrix_room_id", "rooms", type_="unique")
+ op.create_unique_constraint("rooms_matrix_room_id_key", "rooms", ["matrix_room_id"])
+
+ op.drop_constraint("uq_clients_tenant_matrix_user_id", "clients", type_="unique")
+ op.create_unique_constraint(
+ "clients_matrix_user_id_key", "clients", ["matrix_user_id"]
+ )
+
+ op.drop_constraint("uq_agents_tenant_name", "agents", type_="unique")
+ op.create_unique_constraint("agents_name_key", "agents", ["name"])
+
+ # 5. Drop UNIQUE (id, tenant_id) and the FK to tenants.
+ for table in ID_TENANT_UNIQUE_TABLES:
+ op.drop_constraint(f"uq_{table}_id_tenant", table, type_="unique")
+ for table in SCOPED_TABLES:
+ op.drop_constraint(f"fk_{table}_tenant", table, type_="foreignkey")
+
+ # 4. Drop tenant_id from every scoped table.
+ for table in SCOPED_TABLES:
+ op.drop_column(table, "tenant_id")
+
+ # 1. Drop the new tables.
+ op.drop_table("tenant_members")
+ op.drop_table("tenants")
diff --git a/core/tests/conftest.py b/core/tests/conftest.py
index 8eb7596c4..305d40bd7 100644
--- a/core/tests/conftest.py
+++ b/core/tests/conftest.py
@@ -4,7 +4,9 @@ from collections.abc import AsyncIterator, Iterator
import pytest
import pytest_asyncio
+from sqlalchemy import insert
from sqlalchemy.ext.asyncio import (
+ AsyncConnection,
AsyncSession,
async_sessionmaker,
create_async_engine,
@@ -15,6 +17,20 @@ from testcontainers.postgres import PostgresContainer
# create_all provisions the full schema (rooms, room_groups, FKs, …).
import switch_core.db.models # noqa: F401
from switch_core.db.base import Base
+from switch_core.db.models import TENANT_ZERO_ID, Tenant
+
+
+async def _seed_tenant_zero(conn: AsyncConnection) -> None:
+ """Insert the one tenant every scoped row's `tenant_id` default points at.
+
+ Every scoped table's `tenant_id` FK requires a matching `tenants` row, so
+ this must run right after the schema exists.
+ """
+ await conn.execute(
+ insert(Tenant.__table__).values(
+ id=TENANT_ZERO_ID, slug="default", name="Tenant Zero"
+ )
+ )
@pytest.fixture(scope="session")
@@ -41,6 +57,7 @@ async def session_factory(
engine = create_async_engine(postgres_url)
async with engine.begin() as conn:
await conn.run_sync(Base.metadata.create_all)
+ await _seed_tenant_zero(conn)
try:
yield async_sessionmaker(bind=engine, expire_on_commit=False)
finally:
diff --git a/core/tests/integration/conftest.py b/core/tests/integration/conftest.py
index 9b985cecc..9bad5e68b 100644
--- a/core/tests/integration/conftest.py
+++ b/core/tests/integration/conftest.py
@@ -30,7 +30,7 @@ from dataclasses import dataclass
import asyncpg
import pytest
import pytest_asyncio
-from sqlalchemy import text
+from sqlalchemy import insert, text
from sqlalchemy.ext.asyncio import AsyncEngine
from testcontainers.postgres import PostgresContainer
@@ -57,7 +57,7 @@ from switch_core.db.engine import (
create_session_factory,
create_unpooled_engine,
)
-from switch_core.db.models import User
+from switch_core.db.models import TENANT_ZERO_ID, Tenant, User
from switch_core.db.stores.agent_session_store import AgentSessionStore
from switch_core.db.stores.agent_store import AgentStore
from switch_core.db.stores.api_key_store import ApiKeyStore
@@ -309,6 +309,21 @@ async def _admin_dsn(stack: StackInfo) -> str:
)
+async def _seed_tenant_zero(engine: AsyncEngine) -> None:
+ """Insert the one tenant every scoped row's `tenant_id` default points at.
+
+ Needed right after schema creation, and again after every truncation:
+ `tenants` is in `Base.metadata.sorted_tables` like everything else, so
+ `_truncate_all` empties it along with the rest.
+ """
+ async with engine.begin() as conn:
+ await conn.execute(
+ insert(Tenant.__table__).values(
+ id=TENANT_ZERO_ID, slug="default", name="Tenant Zero"
+ )
+ )
+
+
async def _truncate_all(engine: AsyncEngine) -> None:
"""Reset row state between tests by truncating every mapped table at once.
@@ -320,6 +335,7 @@ async def _truncate_all(engine: AsyncEngine) -> None:
return
async with engine.begin() as conn:
await conn.execute(text(f"TRUNCATE TABLE {tables} RESTART IDENTITY CASCADE"))
+ await _seed_tenant_zero(engine)
@pytest_asyncio.fixture(scope="session", loop_scope="session")
@@ -343,6 +359,7 @@ async def session_env(switch_stack: StackInfo) -> AsyncIterator[SessionEnv]:
# separately by `just migrate`, not here.
async with engine.begin() as conn:
await conn.run_sync(Base.metadata.create_all)
+ await _seed_tenant_zero(engine)
env = SessionEnv(
config=config,