Refactor the service layer db session call method (#850)

* Refactor the service layer db session call method

* Fix lint

* Update paging interfaces

* Fix some errors

Author: wu-clan

backend/app/admin/api/v1/auth/auth.py

@@ -10,13 +10,16 @@
 from backend.app.admin.service.auth_service import auth_service
 from backend.common.response.response_schema import ResponseModel, ResponseSchemaModel, response_base
 from backend.common.security.jwt import DependsJwtAuth
+from backend.database.db import CurrentSession, CurrentSessionTransaction
 
 router = APIRouter()
 
 
 @router.post('/login/swagger', summary='swagger 调试专用', description='用于快捷获取 token 进行 swagger 认证')
-async def login_swagger(obj: Annotated[HTTPBasicCredentials, Depends()]) -> GetSwaggerToken:
-    token, user = await auth_service.swagger_login(obj=obj)
+async def login_swagger(
+    db: CurrentSessionTransaction, obj: Annotated[HTTPBasicCredentials, Depends()]
+) -> GetSwaggerToken:
+    token, user = await auth_service.swagger_login(db=db, obj=obj)
     return GetSwaggerToken(access_token=token, user=user)
 
 
@@ -27,24 +30,24 @@ async def login_swagger(obj: Annotated[HTTPBasicCredentials, Depends()]) -> GetS
     dependencies=[Depends(RateLimiter(times=5, minutes=1))],
 )
 async def login(
-    request: Request,
+    db: CurrentSessionTransaction,
     response: Response,
     obj: AuthLoginParam,
     background_tasks: BackgroundTasks,
 ) -> ResponseSchemaModel[GetLoginToken]:
-    data = await auth_service.login(request=request, response=response, obj=obj, background_tasks=background_tasks)
+    data = await auth_service.login(db=db, response=response, obj=obj, background_tasks=background_tasks)
     return response_base.success(data=data)
 
 
 @router.get('/codes', summary='获取所有授权码', description='适配 vben admin v5', dependencies=[DependsJwtAuth])
-async def get_codes(request: Request) -> ResponseSchemaModel[list[str]]:
-    codes = await auth_service.get_codes(request=request)
+async def get_codes(db: CurrentSession, request: Request) -> ResponseSchemaModel[list[str]]:
+    codes = await auth_service.get_codes(db=db, request=request)
     return response_base.success(data=codes)
 
 
 @router.post('/refresh', summary='刷新 token')
-async def refresh_token(request: Request) -> ResponseSchemaModel[GetNewToken]:
-    data = await auth_service.refresh_token(request=request)
+async def refresh_token(db: CurrentSession, request: Request) -> ResponseSchemaModel[GetNewToken]:
+    data = await auth_service.refresh_token(db=db, request=request)
     return response_base.success(data=data)
 
 

backend/app/admin/api/v1/auth/captcha.py

@@ -1,7 +1,7 @@
 from uuid import uuid4
 
 from fast_captcha import img_captcha
-from fastapi import APIRouter, Depends, Request
+from fastapi import APIRouter, Depends
 from fastapi_limiter.depends import RateLimiter
 from starlette.concurrency import run_in_threadpool
 
@@ -18,7 +18,7 @@
     summary='获取登录验证码',
     dependencies=[Depends(RateLimiter(times=5, seconds=10))],
 )
-async def get_captcha(request: Request) -> ResponseSchemaModel[GetCaptchaDetail]:
+async def get_captcha() -> ResponseSchemaModel[GetCaptchaDetail]:
     """
     此接口可能存在性能损耗，尽管是异步接口，但是验证码生成是IO密集型任务，使用线程池尽量减少性能损耗
     """

backend/app/admin/api/v1/log/login_log.py

@@ -4,12 +4,12 @@
 
 from backend.app.admin.schema.login_log import DeleteLoginLogParam, GetLoginLogDetail
 from backend.app.admin.service.login_log_service import login_log_service
-from backend.common.pagination import DependsPagination, PageData, paging_data
+from backend.common.pagination import DependsPagination, PageData
 from backend.common.response.response_schema import ResponseModel, ResponseSchemaModel, response_base
 from backend.common.security.jwt import DependsJwtAuth
 from backend.common.security.permission import RequestPermission
 from backend.common.security.rbac import DependsRBAC
-from backend.database.db import CurrentSession
+from backend.database.db import CurrentSession, CurrentSessionTransaction
 
 router = APIRouter()
 
@@ -22,14 +22,14 @@
         DependsPagination,
     ],
 )
-async def get_login_logs_paged(
+async def get_login_logs_paginated(
     db: CurrentSession,
     username: Annotated[str | None, Query(description='用户名')] = None,
     status: Annotated[int | None, Query(description='状态')] = None,
     ip: Annotated[str | None, Query(description='IP 地址')] = None,
 ) -> ResponseSchemaModel[PageData[GetLoginLogDetail]]:
-    log_select = await login_log_service.get_select(username=username, status=status, ip=ip)
-    page_data = await paging_data(db, log_select)
+    page_data = await login_log_service.get_list(db=db, username=username, status=status, ip=ip)
+
     return response_base.success(data=page_data)
 
 
@@ -41,8 +41,8 @@ async def get_login_logs_paged(
         DependsRBAC,
     ],
 )
-async def delete_login_logs(obj: DeleteLoginLogParam) -> ResponseModel:
-    count = await login_log_service.delete(obj=obj)
+async def delete_login_logs(db: CurrentSessionTransaction, obj: DeleteLoginLogParam) -> ResponseModel:
+    count = await login_log_service.delete(db=db, obj=obj)
     if count > 0:
         return response_base.success()
     return response_base.fail()
@@ -56,6 +56,6 @@ async def delete_login_logs(obj: DeleteLoginLogParam) -> ResponseModel:
         DependsRBAC,
     ],
 )
-async def delete_all_login_logs() -> ResponseModel:
-    await login_log_service.delete_all()
+async def delete_all_login_logs(db: CurrentSessionTransaction) -> ResponseModel:
+    await login_log_service.delete_all(db=db)
     return response_base.success()

backend/app/admin/api/v1/log/opera_log.py

@@ -4,12 +4,12 @@
 
 from backend.app.admin.schema.opera_log import DeleteOperaLogParam, GetOperaLogDetail
 from backend.app.admin.service.opera_log_service import opera_log_service
-from backend.common.pagination import DependsPagination, PageData, paging_data
+from backend.common.pagination import DependsPagination, PageData
 from backend.common.response.response_schema import ResponseModel, ResponseSchemaModel, response_base
 from backend.common.security.jwt import DependsJwtAuth
 from backend.common.security.permission import RequestPermission
 from backend.common.security.rbac import DependsRBAC
-from backend.database.db import CurrentSession
+from backend.database.db import CurrentSession, CurrentSessionTransaction
 
 router = APIRouter()
 
@@ -22,14 +22,14 @@
         DependsPagination,
     ],
 )
-async def get_opera_logs_paged(
+async def get_opera_logs_paginated(
     db: CurrentSession,
     username: Annotated[str | None, Query(description='用户名')] = None,
     status: Annotated[int | None, Query(description='状态')] = None,
     ip: Annotated[str | None, Query(description='IP 地址')] = None,
 ) -> ResponseSchemaModel[PageData[GetOperaLogDetail]]:
-    log_select = await opera_log_service.get_select(username=username, status=status, ip=ip)
-    page_data = await paging_data(db, log_select)
+    page_data = await opera_log_service.get_list(db=db, username=username, status=status, ip=ip)
+
     return response_base.success(data=page_data)
 
 
@@ -41,8 +41,8 @@ async def get_opera_logs_paged(
         DependsRBAC,
     ],
 )
-async def delete_opera_logs(obj: DeleteOperaLogParam) -> ResponseModel:
-    count = await opera_log_service.delete(obj=obj)
+async def delete_opera_logs(db: CurrentSessionTransaction, obj: DeleteOperaLogParam) -> ResponseModel:
+    count = await opera_log_service.delete(db=db, obj=obj)
     if count > 0:
         return response_base.success()
     return response_base.fail()
@@ -56,6 +56,6 @@ async def delete_opera_logs(obj: DeleteOperaLogParam) -> ResponseModel:
         DependsRBAC,
     ],
 )
-async def delete_all_opera_logs() -> ResponseModel:
-    await opera_log_service.delete_all()
+async def delete_all_opera_logs(db: CurrentSessionTransaction) -> ResponseModel:
+    await opera_log_service.delete_all(db=db)
     return response_base.success()

backend/app/admin/api/v1/monitor/online.py

@@ -2,7 +2,7 @@
 
 from typing import Annotated
 
-from fastapi import APIRouter, Path, Query, Request
+from fastapi import APIRouter, Path, Query
 
 from backend.app.admin.schema.token import GetTokenDetail
 from backend.common.enums import StatusType
@@ -76,7 +76,6 @@ def append_token_detail() -> None:
     dependencies=[DependsSuperUser],
 )
 async def delete_session(
-    request: Request,
     pk: Annotated[int, Path(description='用户 ID')],
     session_uuid: Annotated[str, Query(description='会话 UUID')],
 ) -> ResponseModel:

backend/app/admin/api/v1/sys/data_rule.py

@@ -10,12 +10,12 @@
     UpdateDataRuleParam,
 )
 from backend.app.admin.service.data_rule_service import data_rule_service
-from backend.common.pagination import DependsPagination, PageData, paging_data
+from backend.common.pagination import DependsPagination, PageData
 from backend.common.response.response_schema import ResponseModel, ResponseSchemaModel, response_base
 from backend.common.security.jwt import DependsJwtAuth
 from backend.common.security.permission import RequestPermission
 from backend.common.security.rbac import DependsRBAC
-from backend.database.db import CurrentSession
+from backend.database.db import CurrentSession, CurrentSessionTransaction
 
 router = APIRouter()
 
@@ -35,16 +35,17 @@ async def get_data_rule_model_columns(
 
 
 @router.get('/all', summary='获取所有数据规则', dependencies=[DependsJwtAuth])
-async def get_all_data_rules() -> ResponseSchemaModel[list[GetDataRuleDetail]]:
-    data = await data_rule_service.get_all()
+async def get_all_data_rules(db: CurrentSession) -> ResponseSchemaModel[list[GetDataRuleDetail]]:
+    data = await data_rule_service.get_all(db=db)
     return response_base.success(data=data)
 
 
 @router.get('/{pk}', summary='获取数据规则详情', dependencies=[DependsJwtAuth])
 async def get_data_rule(
+    db: CurrentSession,
     pk: Annotated[int, Path(description='数据规则 ID')],
 ) -> ResponseSchemaModel[GetDataRuleDetail]:
-    data = await data_rule_service.get(pk=pk)
+    data = await data_rule_service.get(db=db, pk=pk)
     return response_base.success(data=data)
 
 
@@ -56,12 +57,11 @@ async def get_data_rule(
         DependsPagination,
     ],
 )
-async def get_data_rules_paged(
+async def get_data_rules_paginated(
     db: CurrentSession,
     name: Annotated[str | None, Query(description='规则名称')] = None,
 ) -> ResponseSchemaModel[PageData[GetDataRuleDetail]]:
-    data_rule_select = await data_rule_service.get_select(name=name)
-    page_data = await paging_data(db, data_rule_select)
+    page_data = await data_rule_service.get_list(db=db, name=name)
     return response_base.success(data=page_data)
 
 
@@ -73,8 +73,8 @@ async def get_data_rules_paged(
         DependsRBAC,
     ],
 )
-async def create_data_rule(obj: CreateDataRuleParam) -> ResponseModel:
-    await data_rule_service.create(obj=obj)
+async def create_data_rule(db: CurrentSessionTransaction, obj: CreateDataRuleParam) -> ResponseModel:
+    await data_rule_service.create(db=db, obj=obj)
     return response_base.success()
 
 
@@ -87,10 +87,11 @@ async def create_data_rule(obj: CreateDataRuleParam) -> ResponseModel:
     ],
 )
 async def update_data_rule(
+    db: CurrentSessionTransaction,
     pk: Annotated[int, Path(description='数据规则 ID')],
     obj: UpdateDataRuleParam,
 ) -> ResponseModel:
-    count = await data_rule_service.update(pk=pk, obj=obj)
+    count = await data_rule_service.update(db=db, pk=pk, obj=obj)
     if count > 0:
         return response_base.success()
     return response_base.fail()
@@ -104,8 +105,8 @@ async def update_data_rule(
         DependsRBAC,
     ],
 )
-async def delete_data_rules(obj: DeleteDataRuleParam) -> ResponseModel:
-    count = await data_rule_service.delete(obj=obj)
+async def delete_data_rules(db: CurrentSessionTransaction, obj: DeleteDataRuleParam) -> ResponseModel:
+    count = await data_rule_service.delete(db=db, obj=obj)
     if count > 0:
         return response_base.success()
     return response_base.fail()

backend/app/admin/api/v1/sys/data_scope.py

@@ -11,35 +11,37 @@
     UpdateDataScopeRuleParam,
 )
 from backend.app.admin.service.data_scope_service import data_scope_service
-from backend.common.pagination import DependsPagination, PageData, paging_data
+from backend.common.pagination import DependsPagination, PageData
 from backend.common.response.response_schema import ResponseModel, ResponseSchemaModel, response_base
 from backend.common.security.jwt import DependsJwtAuth
 from backend.common.security.permission import RequestPermission
 from backend.common.security.rbac import DependsRBAC
-from backend.database.db import CurrentSession
+from backend.database.db import CurrentSession, CurrentSessionTransaction
 
 router = APIRouter()
 
 
 @router.get('/all', summary='获取所有数据范围', dependencies=[DependsJwtAuth])
-async def get_all_data_scope() -> ResponseSchemaModel[list[GetDataScopeDetail]]:
-    data = await data_scope_service.get_all()
+async def get_all_data_scope(db: CurrentSession) -> ResponseSchemaModel[list[GetDataScopeDetail]]:
+    data = await data_scope_service.get_all(db=db)
     return response_base.success(data=data)
 
 
 @router.get('/{pk}', summary='获取数据范围详情', dependencies=[DependsJwtAuth])
 async def get_data_scope(
+    db: CurrentSession,
     pk: Annotated[int, Path(description='数据范围 ID')],
 ) -> ResponseSchemaModel[GetDataScopeDetail]:
-    data = await data_scope_service.get(pk=pk)
+    data = await data_scope_service.get(db=db, pk=pk)
     return response_base.success(data=data)
 
 
 @router.get('/{pk}/rules', summary='获取数据范围所有规则', dependencies=[DependsJwtAuth])
 async def get_data_scope_rules(
+    db: CurrentSession,
     pk: Annotated[int, Path(description='数据范围 ID')],
 ) -> ResponseSchemaModel[GetDataScopeWithRelationDetail]:
-    data = await data_scope_service.get_rules(pk=pk)
+    data = await data_scope_service.get_rules(db=db, pk=pk)
     return response_base.success(data=data)
 
 
@@ -51,13 +53,12 @@ async def get_data_scope_rules(
         DependsPagination,
     ],
 )
-async def get_data_scopes_paged(
+async def get_data_scopes_paginated(
     db: CurrentSession,
     name: Annotated[str | None, Query(description='范围名称')] = None,
     status: Annotated[int | None, Query(description='状态')] = None,
 ) -> ResponseSchemaModel[PageData[GetDataScopeDetail]]:
-    data_scope_select = await data_scope_service.get_select(name=name, status=status)
-    page_data = await paging_data(db, data_scope_select)
+    page_data = await data_scope_service.get_list(db=db, name=name, status=status)
     return response_base.success(data=page_data)
 
 
@@ -69,8 +70,8 @@ async def get_data_scopes_paged(
         DependsRBAC,
     ],
 )
-async def create_data_scope(obj: CreateDataScopeParam) -> ResponseModel:
-    await data_scope_service.create(obj=obj)
+async def create_data_scope(db: CurrentSessionTransaction, obj: CreateDataScopeParam) -> ResponseModel:
+    await data_scope_service.create(db=db, obj=obj)
     return response_base.success()
 
 
@@ -83,10 +84,11 @@ async def create_data_scope(obj: CreateDataScopeParam) -> ResponseModel:
     ],
 )
 async def update_data_scope(
+    db: CurrentSessionTransaction,
     pk: Annotated[int, Path(description='数据范围 ID')],
     obj: UpdateDataScopeParam,
 ) -> ResponseModel:
-    count = await data_scope_service.update(pk=pk, obj=obj)
+    count = await data_scope_service.update(db=db, pk=pk, obj=obj)
     if count > 0:
         return response_base.success()
     return response_base.fail()
@@ -101,10 +103,11 @@ async def update_data_scope(
     ],
 )
 async def update_data_scope_rules(
+    db: CurrentSessionTransaction,
     pk: Annotated[int, Path(description='数据范围 ID')],
     rule_ids: UpdateDataScopeRuleParam,
 ) -> ResponseModel:
-    count = await data_scope_service.update_data_scope_rule(pk=pk, rule_ids=rule_ids)
+    count = await data_scope_service.update_data_scope_rule(db=db, pk=pk, rule_ids=rule_ids)
     if count > 0:
         return response_base.success()
     return response_base.fail()
@@ -118,8 +121,8 @@ async def update_data_scope_rules(
         DependsRBAC,
     ],
 )
-async def delete_data_scopes(obj: DeleteDataScopeParam) -> ResponseModel:
-    count = await data_scope_service.delete(obj=obj)
+async def delete_data_scopes(db: CurrentSessionTransaction, obj: DeleteDataScopeParam) -> ResponseModel:
+    count = await data_scope_service.delete(db=db, obj=obj)
     if count > 0:
         return response_base.success()
     return response_base.fail()