controller.py 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230
  1. from typing import Annotated
  2. from fastapi import APIRouter, Body, Depends, Path
  3. from fastapi.responses import JSONResponse
  4. from app.api.v1.module_system.auth.schema import AuthSchema
  5. from app.common.response import ResponseSchema, SuccessResponse
  6. from app.core.base_params import PaginationQueryParam
  7. from app.core.dependencies import AuthPermission
  8. from app.core.logger import log
  9. from app.core.router_class import OperationLogRoute
  10. from .schema import (
  11. NodeCreateSchema,
  12. NodeExecuteSchema,
  13. NodeOutSchema,
  14. NodeQueryParam,
  15. NodeUpdateSchema,
  16. )
  17. from .service import NodeService
  18. NodeRouter = APIRouter(route_class=OperationLogRoute, prefix="/cronjob/node", tags=["节点"])
  19. @NodeRouter.get(
  20. "/options",
  21. summary="获取定时任务节点列表",
  22. description="供 APScheduler 定时任务使用;工作流画布请调用 GET /task/workflow/node-type/options",
  23. response_model=ResponseSchema[list[dict]],
  24. )
  25. async def get_node_options_controller(
  26. auth: Annotated[AuthSchema, Depends(AuthPermission(["module_task:cronjob:node:query"]))],
  27. ) -> JSONResponse:
  28. """
  29. 获取数据库中的定时任务节点定义(task_node),与编排节点类型无关。
  30. 参数:
  31. - auth (AuthSchema): 认证信息。
  32. 返回:
  33. - JSONResponse: 成功响应,data 为选项列表。
  34. """
  35. result = await NodeService.get_node_options_service(auth=auth)
  36. log.info("获取定时任务节点选项成功")
  37. return SuccessResponse(data=result, msg="获取定时任务节点选项成功")
  38. @NodeRouter.get(
  39. "/detail/{id}",
  40. summary="获取节点详情",
  41. description="获取节点详情",
  42. response_model=ResponseSchema[NodeOutSchema],
  43. )
  44. async def get_obj_detail_controller(
  45. id: Annotated[int, Path(description="节点ID")],
  46. auth: Annotated[AuthSchema, Depends(AuthPermission(["module_task:cronjob:node:detail"]))],
  47. ) -> JSONResponse:
  48. """
  49. 获取节点详情
  50. 参数:
  51. - id (int): 节点ID
  52. - auth (AuthSchema): 认证信息模型
  53. 返回:
  54. - JSONResponse: 包含节点详情的JSON响应
  55. """
  56. result_dict = await NodeService.get_node_detail_service(id=id, auth=auth)
  57. log.info(f"获取节点详情成功 {id}")
  58. return SuccessResponse(data=result_dict, msg="获取节点详情成功")
  59. @NodeRouter.get(
  60. "/list",
  61. summary="查询节点",
  62. description="查询节点",
  63. response_model=ResponseSchema[list[NodeOutSchema]],
  64. )
  65. async def get_obj_list_controller(
  66. page: Annotated[PaginationQueryParam, Depends()],
  67. search: Annotated[NodeQueryParam, Depends()],
  68. auth: Annotated[AuthSchema, Depends(AuthPermission(["module_task:cronjob:node:query"]))],
  69. ) -> JSONResponse:
  70. """
  71. 查询节点
  72. 参数:
  73. - page (PaginationQueryParam): 分页查询参数模型
  74. - search (NodeQueryParam): 查询参数模型
  75. - auth (AuthSchema): 认证信息模型
  76. 返回:
  77. - JSONResponse: 包含分页后的节点列表的JSON响应
  78. """
  79. result_dict = await NodeService.get_node_page_service(
  80. auth=auth,
  81. page_no=page.page_no,
  82. page_size=page.page_size,
  83. search=search,
  84. order_by=page.order_by,
  85. )
  86. log.info("查询节点列表成功")
  87. return SuccessResponse(data=result_dict, msg="查询节点列表成功")
  88. @NodeRouter.post(
  89. "/create",
  90. summary="创建节点",
  91. description="创建节点(仅保存到数据库,不创建调度器任务)",
  92. response_model=ResponseSchema[NodeOutSchema],
  93. )
  94. async def create_obj_controller(
  95. data: NodeCreateSchema,
  96. auth: Annotated[AuthSchema, Depends(AuthPermission(["module_task:cronjob:node:create"]))],
  97. ) -> JSONResponse:
  98. """
  99. 创建节点
  100. 参数:
  101. - data (NodeCreateSchema): 创建参数模型
  102. - auth (AuthSchema): 认证信息模型
  103. 返回:
  104. - JSONResponse: 包含创建节点结果的JSON响应
  105. """
  106. result_dict = await NodeService.create_node_service(auth=auth, data=data)
  107. log.info(f"创建节点成功: {result_dict}")
  108. return SuccessResponse(data=result_dict, msg="创建节点成功")
  109. @NodeRouter.put(
  110. "/update/{id}",
  111. summary="修改节点",
  112. description="修改节点(仅更新数据库,不修改调度器任务)",
  113. response_model=ResponseSchema[NodeOutSchema],
  114. )
  115. async def update_obj_controller(
  116. data: NodeUpdateSchema,
  117. id: Annotated[int, Path(description="节点ID")],
  118. auth: Annotated[AuthSchema, Depends(AuthPermission(["module_task:cronjob:node:update"]))],
  119. ) -> JSONResponse:
  120. """
  121. 修改节点
  122. 参数:
  123. - data (NodeUpdateSchema): 更新参数模型
  124. - id (int): 节点ID
  125. - auth (AuthSchema): 认证信息模型
  126. 返回:
  127. - JSONResponse: 包含修改节点结果的JSON响应
  128. """
  129. result_dict = await NodeService.update_node_service(auth=auth, id=id, data=data)
  130. log.info(f"修改节点成功: {result_dict}")
  131. return SuccessResponse(data=result_dict, msg="修改节点成功")
  132. @NodeRouter.delete(
  133. "/delete",
  134. summary="删除节点",
  135. description="删除节点",
  136. response_model=ResponseSchema[None],
  137. )
  138. async def delete_obj_controller(
  139. ids: Annotated[list[int], Body(description="ID列表")],
  140. auth: Annotated[AuthSchema, Depends(AuthPermission(["module_task:cronjob:node:delete"]))],
  141. ) -> JSONResponse:
  142. """
  143. 删除节点
  144. 参数:
  145. - ids (list[int]): ID列表
  146. - auth (AuthSchema): 认证信息模型
  147. 返回:
  148. - JSONResponse: 包含删除节点结果的JSON响应
  149. """
  150. await NodeService.delete_node_service(auth=auth, ids=ids)
  151. log.info(f"删除节点成功: {ids}")
  152. return SuccessResponse(msg="删除节点成功")
  153. @NodeRouter.delete(
  154. "/clear",
  155. summary="清空节点",
  156. description="清空所有节点",
  157. response_model=ResponseSchema[None],
  158. )
  159. async def clear_obj_controller(
  160. auth: Annotated[AuthSchema, Depends(AuthPermission(["module_task:cronjob:node:delete"]))],
  161. ) -> JSONResponse:
  162. """
  163. 清空所有节点
  164. 参数:
  165. - auth (AuthSchema): 认证信息模型
  166. 返回:
  167. - JSONResponse: 包含清空节点结果的JSON响应
  168. """
  169. await NodeService.clear_node_service(auth=auth)
  170. log.info("清空节点成功")
  171. return SuccessResponse(msg="清空节点成功")
  172. @NodeRouter.post(
  173. "/execute/{id}",
  174. summary="调试节点",
  175. description="调试节点(创建调度器任务并执行)",
  176. response_model=ResponseSchema[dict],
  177. )
  178. async def execute_job_controller(
  179. id: Annotated[int, Path(description="节点ID")],
  180. data: NodeExecuteSchema,
  181. auth: Annotated[AuthSchema, Depends(AuthPermission(["module_task:cronjob:node:execute"]))],
  182. ) -> JSONResponse:
  183. """
  184. 调试节点
  185. 参数:
  186. - id (int): 节点ID
  187. - data (NodeExecuteSchema): 执行参数模型
  188. - auth (AuthSchema): 认证信息模型
  189. 返回:
  190. - JSONResponse: 包含调试结果的JSON响应
  191. """
  192. result = await NodeService.execute_node_service(auth=auth, id=id, execute_data=data)
  193. log.info(f"调试节点成功: {id}")
  194. return SuccessResponse(data=result, msg="调试节点成功")