[DOP-25282] Make User.email field optional

Author: dolfinus

.pre-commit-config.yaml

@@ -39,13 +39,13 @@ repos:
       - id: chmod
         args: ['644']
         exclude_types: [shell]
-        exclude: ^(.*__main__\.py|syncmaster/server/scripts/export_openapi_schema\.py)$
+        exclude: ^(.*__main__\.py|syncmaster/server/scripts/.*\.py)$
       - id: chmod
         args: ['755']
         types: [shell]
       - id: chmod
         args: ['755']
-        files: ^(.*__main__\.py|syncmaster/server/scripts/export_openapi_schema\.py)$
+        files: ^(.*__main__\.py|syncmaster/server/scripts/.*\.py)$
       - id: insert-license
         types: [python]
         exclude: ^(syncmaster/server/dependencies/stub.py|docs/.*\.py|tests/.*\.py)$

pyproject.toml

@@ -456,6 +456,7 @@ per-file-ignores = [
 # WPS102 Found incorrect module name pattern
 # WPS432 Found magic number: 256
   "*migrations/*.py:WPS102,WPS432",
+  "*db/models/*.py:WPS102,WPS432",
 # WPS237 Found a too complex `f` string
   "*exceptions/*.py:WPS237",
   "*exceptions/__init__.py:F40,WPS410",

syncmaster/db/migrations/versions/2023-11-23_0001_create_user_table.py

@@ -22,7 +22,7 @@ def upgrade():
         "user",
         sa.Column("id", sa.BigInteger(), nullable=False),
         sa.Column("username", sa.String(length=256), nullable=False),
-        sa.Column("email", sa.String(length=256), nullable=False),
+        sa.Column("email", sa.String(length=256), nullable=True),
         sa.Column("first_name", sa.String(length=256), nullable=True),
         sa.Column("last_name", sa.String(length=256), nullable=True),
         sa.Column("middle_name", sa.String(length=256), nullable=True),
@@ -32,7 +32,6 @@ def upgrade():
         sa.Column("updated_at", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
         sa.Column("is_deleted", sa.Boolean(), nullable=False),
         sa.PrimaryKeyConstraint("id", name=op.f("pk__user")),
-        sa.UniqueConstraint("email", name=op.f("uq__user__email")),
     )
     op.create_index(op.f("ix__user__username"), "user", ["username"], unique=True)
 

syncmaster/db/models/user.py

@@ -12,12 +12,12 @@
 class User(Base, TimestampMixin, DeletableMixin):
     id: Mapped[int] = mapped_column(BigInteger, primary_key=True)
     username: Mapped[str] = mapped_column(String(256), nullable=False, unique=True, index=True)
-    email: Mapped[str] = mapped_column(String(256), nullable=False, unique=True)
-    first_name: Mapped[str] = mapped_column(String(256), nullable=True)
-    last_name: Mapped[str] = mapped_column(String(256), nullable=True)
-    middle_name: Mapped[str] = mapped_column(String(256), nullable=True)
+    email: Mapped[str | None] = mapped_column(String(256), nullable=True)
+    first_name: Mapped[str | None] = mapped_column(String(256), nullable=True)
+    last_name: Mapped[str | None] = mapped_column(String(256), nullable=True)
+    middle_name: Mapped[str | None] = mapped_column(String(256), nullable=True)
     is_superuser: Mapped[bool] = mapped_column(Boolean, default=False, nullable=False)
-    is_active: Mapped[bool] = mapped_column(Boolean, default=False, nullable=False)
+    is_active: Mapped[bool] = mapped_column(Boolean, default=True, nullable=False)
 
     def __repr__(self) -> str:
         return f"User(username={self.username}, is_superuser={self.is_superuser}, is_active={self.is_active})"

syncmaster/db/repositories/user.py

@@ -58,8 +58,7 @@ async def update(self, user_id: int, data: dict) -> User:
     async def create(
         self,
         username: str,
-        email: str,
-        is_active: bool,
+        email: str | None = None,
         first_name: str | None = None,
         middle_name: str | None = None,
         last_name: str | None = None,
@@ -73,7 +72,6 @@ async def create(
                 first_name=first_name,
                 middle_name=middle_name,
                 last_name=last_name,
-                is_active=is_active,
                 is_superuser=is_superuser,
             )
             .returning(User)

syncmaster/server/providers/auth/dummy_provider.py

@@ -62,11 +62,7 @@ async def get_token_password_grant(
             try:
                 user = await self._uow.user.read_by_username(login)
             except EntityNotFoundError:
-                user = await self._uow.user.create(
-                    username=login,
-                    email=f"{login}@example.com",
-                    is_active=True,
-                )
+                user = await self._uow.user.create(username=login)
 
         log.info("User with id %r found", user.id)
         if not user.is_active:

syncmaster/server/providers/auth/keycloak_provider.py

@@ -72,7 +72,7 @@ async def get_token_authorization_code_grant(
         except Exception as e:
             raise AuthorizationError("Failed to get token") from e
 
-    async def get_current_user(self, access_token: str, *args, **kwargs) -> Any:
+    async def get_current_user(self, access_token: str, *args, **kwargs) -> Any:  # noqa: WPS231
         request: Request = kwargs["request"]
         refresh_token = request.session.get("refresh_token")
 
@@ -113,16 +113,12 @@ async def get_current_user(self, access_token: str, *args, **kwargs) -> Any:
         # these names are hardcoded in keycloak:
         # https://github.com/keycloak/keycloak/blob/3ca3a4ad349b4d457f6829eaf2ae05f1e01408be/core/src/main/java/org/keycloak/representations/IDToken.java
         # TODO: make sure which fields are guaranteed
-        user_id = token_info.get("sub")
         login = token_info["preferred_username"]
-        email = token_info["email"]
+        email = token_info.get("email")
         first_name = token_info.get("given_name")
         middle_name = token_info.get("middle_name")
         last_name = token_info.get("family_name")
 
-        if not user_id:
-            raise AuthorizationError("Invalid token payload")
-
         async with self._uow:
             try:
                 user = await self._uow.user.read_by_username(login)
@@ -133,7 +129,6 @@ async def get_current_user(self, access_token: str, *args, **kwargs) -> Any:
                     first_name=first_name,
                     middle_name=middle_name,
                     last_name=last_name,
-                    is_active=True,
                 )
         return user
 

syncmaster/server/scripts/manage_superusers.py

@@ -29,7 +29,7 @@ async def add_superusers(session: AsyncSession, usernames: list[str]) -> None:
 
     if not_found:
         for username in not_found:
-            session.add(User(username=username, email=f"{username}@mts.ru", is_active=True, is_superuser=True))
+            session.add(User(username=username, is_superuser=True))
             logging.info("    %r (new user)", username)
 
     await session.commit()

tests/test_unit/utils.py

@@ -35,10 +35,10 @@ async def create_user_cm(
     is_active: bool = False,
     is_superuser: bool = False,
     is_deleted: bool = False,
-    email: str = None,
-    first_name: str = None,
-    middle_name: str = None,
-    last_name: str = None,
+    email: str | None = None,
+    first_name: str | None = None,
+    middle_name: str | None = None,
+    last_name: str | None = None,
 ) -> AsyncGenerator[User, None]:
     email = email or f"{username}@user.user"
     first_name = first_name or f"{username}_first"
@@ -68,10 +68,10 @@ async def create_user(
     is_active: bool = False,
     is_superuser: bool = False,
     is_deleted: bool = False,
-    email: str = None,
-    first_name: str = None,
-    middle_name: str = None,
-    last_name: str = None,
+    email: str | None = None,
+    first_name: str | None = None,
+    middle_name: str | None = None,
+    last_name: str | None = None,
 ) -> User:
     email = email or f"{username}@user.user"
     first_name = first_name or f"{username}_first"