Skip to content

πŸ™Œ OpenHands: AI-Driven Development

fix(enterprise): migrate auth models to SQLAlchemy 2.0 [7/13] (#13853)

Rohit Malhotraae2f13ecbadd
diff --git a/enterprise/storage/api_key.py b/enterprise/storage/api_key.py
index 7c462208f8..afc4b41516 100644
--- a/enterprise/storage/api_key.py
+++ b/enterprise/storage/api_key.py
@@ -1,8 +1,14 @@
-from sqlalchemy import Column, DateTime, ForeignKey, Integer, String, text
-from sqlalchemy.dialects.postgresql import UUID
-from sqlalchemy.orm import relationship
+from datetime import datetime
+from typing import TYPE_CHECKING
+from uuid import UUID
+
+from sqlalchemy import DateTime, ForeignKey, String, text
+from sqlalchemy.orm import Mapped, mapped_column, relationship
from storage.base import Base
+if TYPE_CHECKING:
+ from storage.org import Org
+
class ApiKey(Base):
"""
@@ -10,16 +16,19 @@ class ApiKey(Base):
"""
__tablename__ = 'api_keys'
- id = Column(Integer, primary_key=True, autoincrement=True)
- key = Column(String(255), nullable=False, unique=True, index=True)
- user_id = Column(String(255), nullable=False, index=True)
- org_id = Column(UUID(as_uuid=True), ForeignKey('org.id'), nullable=True)
- name = Column(String(255), nullable=True)
- created_at = Column(
+
+ id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+ key: Mapped[str] = mapped_column(
+ String(255), nullable=False, unique=True, index=True
+ )
+ user_id: Mapped[str] = mapped_column(String(255), nullable=False, index=True)
+ org_id: Mapped[UUID | None] = mapped_column(ForeignKey('org.id'), nullable=True)
+ name: Mapped[str | None] = mapped_column(String(255), nullable=True)
+ created_at: Mapped[datetime] = mapped_column(
DateTime, server_default=text('CURRENT_TIMESTAMP'), nullable=False
)
- last_used_at = Column(DateTime, nullable=True)
- expires_at = Column(DateTime, nullable=True)
+ last_used_at: Mapped[datetime | None] = mapped_column(DateTime, nullable=True)
+ expires_at: Mapped[datetime | None] = mapped_column(DateTime, nullable=True)
# Relationships
- org = relationship('Org', back_populates='api_keys')
+ org: Mapped['Org | None'] = relationship('Org', back_populates='api_keys')
diff --git a/enterprise/storage/auth_tokens.py b/enterprise/storage/auth_tokens.py
index c73a3f6302..e78fc45ffc 100644
--- a/enterprise/storage/auth_tokens.py
+++ b/enterprise/storage/auth_tokens.py
@@ -1,18 +1,20 @@
-from sqlalchemy import BigInteger, Column, Identity, Index, Integer, String
+from sqlalchemy import BigInteger, Identity, Index, String
+from sqlalchemy.orm import Mapped, mapped_column
from storage.base import Base
-class AuthTokens(Base): # type: ignore
+class AuthTokens(Base):
__tablename__ = 'auth_tokens'
- id = Column(Integer, Identity(), primary_key=True)
- keycloak_user_id = Column(String, nullable=False, index=True)
- identity_provider = Column(String, nullable=False)
- access_token = Column(String, nullable=False)
- refresh_token = Column(String, nullable=False)
- access_token_expires_at = Column(
+
+ id: Mapped[int] = mapped_column(Identity(), primary_key=True)
+ keycloak_user_id: Mapped[str] = mapped_column(String, nullable=False, index=True)
+ identity_provider: Mapped[str] = mapped_column(String, nullable=False)
+ access_token: Mapped[str] = mapped_column(String, nullable=False)
+ refresh_token: Mapped[str] = mapped_column(String, nullable=False)
+ access_token_expires_at: Mapped[int] = mapped_column(
BigInteger, nullable=False
) # Time since epoch in seconds
- refresh_token_expires_at = Column(
+ refresh_token_expires_at: Mapped[int] = mapped_column(
BigInteger, nullable=False
) # Time since epoch in seconds
diff --git a/enterprise/storage/role.py b/enterprise/storage/role.py
index b9f5445e41..b3ca91e080 100644
--- a/enterprise/storage/role.py
+++ b/enterprise/storage/role.py
@@ -2,20 +2,28 @@
SQLAlchemy model for Role.
"""
-from sqlalchemy import Column, Identity, Integer, String
-from sqlalchemy.orm import relationship
+from typing import TYPE_CHECKING
+
+from sqlalchemy import Identity, String
+from sqlalchemy.orm import Mapped, mapped_column, relationship
from storage.base import Base
+if TYPE_CHECKING:
+ from storage.org_member import OrgMember
+ from storage.user import User
+
-class Role(Base): # type: ignore
+class Role(Base):
"""Role model for user permissions."""
__tablename__ = 'role'
- id = Column(Integer, Identity(), primary_key=True)
- name = Column(String, nullable=False, unique=True)
- rank = Column(Integer, nullable=False)
+ id: Mapped[int] = mapped_column(Identity(), primary_key=True)
+ name: Mapped[str] = mapped_column(String, nullable=False, unique=True)
+ rank: Mapped[int] = mapped_column(nullable=False)
# Relationships
- users = relationship('User', back_populates='role')
- org_members = relationship('OrgMember', back_populates='role')
+ users: Mapped[list['User']] = relationship('User', back_populates='role')
+ org_members: Mapped[list['OrgMember']] = relationship(
+ 'OrgMember', back_populates='role'
+ )