feat: User 模型添加 time_zone 字段 (#244)

Author: xogas

sdks/bkpaas-auth/bkpaas_auth/backends.py

@@ -70,6 +70,7 @@ def authenticate(self, request: HttpRequest, auth_credentials: Dict) -> Optional
             token.user_info = UserInfo(
                 username=user_account.bk_username,
                 display_name=user_account.display_name,
+                time_zone=user_account.time_zone,
                 tenant_id=user_account.tenant_id,
             )
             logger.debug("New login token exchanged by credentials")
@@ -235,8 +236,8 @@ def authenticate_with_signature_v3(
         request: HttpRequest,
         gateway_name: str,
         bk_username: str,
-        tenant_id: str,
-        verified: bool,
+        tenant_id: str | None = None,
+        verified: bool = False,
         **credentials: Dict,
     ) -> Union[User, AnonymousUser]:
         """authenticate function with signature required by ApiGatewayJWTUserMiddleware in apigw_manager == '^3.0.0'"""

sdks/bkpaas-auth/bkpaas_auth/core/token.py

@@ -34,11 +34,13 @@ class UserAccount(NamedTuple):
 
     :param bk_username: 用户唯一标识，全局唯一
     :param display_name: 用户展示名.
+    :param time_zone: 用户时区信息. 为 None 时表示用户无时区信息(可能接口不支持)
     :param tenant_id: 用户所属租户 ID. 为 None 时表示用户无租户信息(可能接口不支持)
     """
 
     bk_username: str
     display_name: str
+    time_zone: str | None = None
     tenant_id: str | None = None
 
 
@@ -98,6 +100,7 @@ def _request_apigw(**credentials) -> UserAccount:
             return UserAccount(
                 bk_username=bk_username,
                 display_name=resp_json["data"].get("display_name") or bk_username,
+                time_zone=resp_json["data"].get("time_zone"),
                 tenant_id=resp_json["data"].get("tenant_id"),
             )
 

sdks/bkpaas-auth/bkpaas_auth/core/user_info.py

@@ -16,6 +16,7 @@ class UserInfo:
     def __init__(self, username, **kwargs):
         self.username = username
         self.display_name = kwargs.get("display_name") or username
+        self.time_zone = kwargs.get("time_zone")
         self.tenant_id = kwargs.get("tenant_id")
 
     def provide(self, user: 'User'):

sdks/bkpaas-auth/bkpaas_auth/models.py

@@ -13,7 +13,7 @@ class AbstractUserWithProvider(models.AbstractBaseUser, models.AnonymousUser):
 
     bkpaas_user_id = db_models.CharField(primary_key=True, max_length=255)
     USERNAME_FIELD = 'bkpaas_user_id'
-    USERINFO_FIELDS = ('display_name', 'tenant_id', 'nickname', 'chinese_name', 'avatar_url', 'email', 'phone')
+    USERINFO_FIELDS = ('display_name', 'tenant_id', 'time_zone', 'nickname', 'chinese_name', 'avatar_url', 'email', 'phone')
 
     def __init__(self, provider_type, username):
         if not provider_type:

sdks/bkpaas-auth/tests/conftest.py

@@ -79,6 +79,7 @@ def get_rtx_user_info_response(settings):
             "bk_username": settings.USER_NAME,
             "LoginName": settings.USER_NAME,
             "ChineseName": settings.USER_NICKNAME,
+            "time_zone": "Asia/Shanghai",
             "avatar_url": "",
         },
         "result": True,

sdks/bkpaas-auth/tests/test_backends.py

@@ -48,14 +48,14 @@ def test_authenticate_bk_token(self, mock_request, mocker):
     )
     @mock.patch("requests.Session.request")
     def test_authenticate_bk_token_for_tenant_mode(self, mock_request, mocker):
+        """Test basic fields validation for tenant mode authentication"""
         mock_request.return_value = mock_raw_response(
             {
                 "data": {
                     "bk_username": "5461b239-5ef2-4c81-a682-5907dbd5f394",
                     "tenant_id": "system",
                     "display_name": "foo",
                     "language": "zh-cn",
-                    "time_zone": "Asia/Shanghai",
                 }
             }
         )
@@ -71,6 +71,45 @@ def test_authenticate_bk_token_for_tenant_mode(self, mock_request, mocker):
         assert getattr(user, "display_name") == "foo"
         assert getattr(user, "tenant_id") == "system"
 
+    @override_settings(
+        BKAUTH_ENABLE_MULTI_TENANT_MODE=True,
+        BKAUTH_BACKEND_TYPE="bk_token",
+        BKAUTH_USER_INFO_APIGW_URL="fake_url",
+    )
+    @pytest.mark.parametrize(
+        ("api_time_zone", "expected_time_zone"),
+        [
+            # Valid time zones
+            ("Asia/Shanghai", "Asia/Shanghai"),
+            ("UTC", "UTC"),
+            ("Asia/Tokyo", "Asia/Tokyo"),
+            # Missing time_zone field
+            (None, None),
+        ],
+    )
+    @mock.patch("requests.Session.request")
+    def test_authenticate_bk_token_for_tenant_mode_time_zone(
+        self, mock_request, mocker, api_time_zone, expected_time_zone
+    ):
+        """Test time_zone field handling in tenant mode authentication"""
+        response_data = {
+            "data": {
+                "bk_username": "test_user",
+                "tenant_id": "system",
+                "display_name": "test",
+                "language": "zh-cn",
+            }
+        }
+        if api_time_zone is not None:
+            response_data["data"]["time_zone"] = api_time_zone
+
+        mock_request.return_value = mock_raw_response(response_data)
+
+        user = UniversalAuthBackend().authenticate(
+            request=mocker.MagicMock(), auth_credentials={"bk_token": generate_random_string()}
+        )
+
+        assert getattr(user, "time_zone") == expected_time_zone
 
 class TestAPIGatewayAuthBackend:
     @pytest.fixture()

sdks/bkpaas-auth/tests/test_models.py

@@ -1,6 +1,8 @@
 # -*- coding: utf-8 -*-
+import copy
 from unittest import mock
 
+import pytest
 from django.conf import settings
 
 from bkpaas_auth.core.constants import ProviderType
@@ -27,6 +29,7 @@ def test_user_authenticated(self):
         assert user.is_anonymous is False
 
     def test_user_info(self, get_rtx_user_info_response):
+        """Test base user info fields mapping from RTX user info"""
         with mock.patch('requests.Session.request') as mocked_request:
             mocked_request.return_value = mock_json_response(get_rtx_user_info_response)
 
@@ -41,3 +44,36 @@ def test_user_info(self, get_rtx_user_info_response):
             assert user.email == f'{settings.USER_NAME}@tencent.com'
             assert user.username == settings.USER_NAME
             assert user.chinese_name == settings.USER_NICKNAME
+
+    @mock.patch('django.core.cache.cache.set')
+    @mock.patch('django.core.cache.cache.get', return_value=None)
+    @pytest.mark.parametrize(
+        ("api_time_zone", "expected_time_zone"),
+        [
+            # Valid IANA time zones
+            ("Asia/Shanghai", "Asia/Shanghai"),
+            ("UTC", "UTC"),
+            # Missing time_zone field
+            (None, None),
+        ],
+    )
+    def test_user_info_time_zone(
+        self, _mock_cache_get, _mock_cache_set, get_rtx_user_info_response, api_time_zone, expected_time_zone
+    ):
+        """Test time_zone field handling with various values"""
+        with mock.patch('requests.Session.request') as mocked_request:
+            response_data = copy.deepcopy(get_rtx_user_info_response)
+            if api_time_zone is None:
+                response_data["data"].pop("time_zone", None)
+            else:
+                response_data["data"]["time_zone"] = api_time_zone
+
+            mocked_request.return_value = mock_json_response(response_data)
+
+            user_info = get_rtx_user_info(username=settings.USER_NAME)
+            assert user_info.time_zone == expected_time_zone
+
+            token = LoginToken('token', expires_in=86400)
+            user = User(token)
+            user_info.provide(user)
+            assert user.time_zone == expected_time_zone