content: /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements.  See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to You under the Apache License, Version 2.0
   * (the "License"); you may not use this file except in compliance with
   * the License.  You may obtain a copy of the License at
   *
   *    http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  package org.apache.dolphinscheduler.api.controller;
  
  import static org.apache.dolphinscheduler.api.enums.Status.CLOSE_TASK_GROUP_ERROR;
  import static org.apache.dolphinscheduler.api.enums.Status.CREATE_TASK_GROUP_ERROR;
  import static org.apache.dolphinscheduler.api.enums.Status.QUERY_TASK_GROUP_LIST_ERROR;
  import static org.apache.dolphinscheduler.api.enums.Status.QUERY_TASK_GROUP_QUEUE_LIST_ERROR;
  import static org.apache.dolphinscheduler.api.enums.Status.START_TASK_GROUP_ERROR;
  import static org.apache.dolphinscheduler.api.enums.Status.UPDATE_TASK_GROUP_ERROR;
  
  import org.apache.dolphinscheduler.api.exceptions.ApiException;
  import org.apache.dolphinscheduler.api.service.TaskGroupQueueService;
  import org.apache.dolphinscheduler.api.service.TaskGroupService;
  import org.apache.dolphinscheduler.api.utils.Result;
  import org.apache.dolphinscheduler.common.constants.Constants;
  import org.apache.dolphinscheduler.dao.entity.User;
  
  import java.util.Map;
  
  import org.springframework.beans.factory.annotation.Autowired;
  import org.springframework.http.HttpStatus;
  import org.springframework.web.bind.annotation.GetMapping;
  import org.springframework.web.bind.annotation.PostMapping;
  import org.springframework.web.bind.annotation.RequestAttribute;
  import org.springframework.web.bind.annotation.RequestMapping;
  import org.springframework.web.bind.annotation.RequestParam;
  import org.springframework.web.bind.annotation.ResponseStatus;
  import org.springframework.web.bind.annotation.RestController;
  
  import io.swagger.v3.oas.annotations.Operation;
  import io.swagger.v3.oas.annotations.Parameter;
  import io.swagger.v3.oas.annotations.Parameters;
  import io.swagger.v3.oas.annotations.media.Schema;
  import io.swagger.v3.oas.annotations.tags.Tag;
  
  /**
   * task group controller
   */
  @Tag(name = "TASK_GROUP_TAG")
  @RestController
  @RequestMapping("/task-group")
  public class TaskGroupController extends BaseController {
  
      @Autowired
      private TaskGroupService taskGroupService;
  
      /**
       * query task group list
       *
       * @param loginUser   login user
       * @param name        name
       * @param description description
       * @param groupSize   group size
       * @param name        project id
       * @return result and msg code
       */
      @Operation(summary = "create", description = "CREATE_TASK_GROUP_NOTE")
      @Parameters({
              @Parameter(name = "name", description = "NAME", schema = @Schema(implementation = String.class)),
              @Parameter(name = "projectCode", description = "PROJECT_CODE", schema = @Schema(implementation = long.class)),
              @Parameter(name = "description", description = "TASK_GROUP_DESCRIPTION", schema = @Schema(implementation = String.class)),
              @Parameter(name = "groupSize", description = "GROUP_SIZE", schema = @Schema(implementation = int.class)),
  
      })
      @PostMapping(value = "/create")
      @ResponseStatus(HttpStatus.CREATED)
      @ApiException(CREATE_TASK_GROUP_ERROR)
      public Result createTaskGroup(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
                                    @RequestParam("name") String name,
                                    @RequestParam(value = "projectCode", required = false, defaultValue = "0") Long projectCode,
                                    @RequestParam("description") String description,
                                    @RequestParam("groupSize") Integer groupSize) {
          Map<String, Object> result =
                  taskGroupService.createTaskGroup(loginUser, projectCode, name, description, groupSize);
          return returnDataList(result);
      }
  
      /**
       * update task group list
       *
       * @param loginUser   login user
       * @param name        name
       * @param description description
       * @param groupSize   group size
       * @param name        project id
       * @return result and msg code
       */
      @Operation(summary = "update", description = "UPDATE_TASK_GROUP_NOTE")
      @Parameters({
              @Parameter(name = "id", description = "TASK_GROUP_ID", schema = @Schema(implementation = int.class)),
              @Parameter(name = "name", description = "TASK_GROUP_NAME", schema = @Schema(implementation = String.class)),
              @Parameter(name = "description", description = "TASK_GROUP_DESCRIPTION", schema = @Schema(implementation = String.class)),
              @Parameter(name = "groupSize", description = "GROUP_SIZE", schema = @Schema(implementation = int.class)),
  
      })
      @PostMapping(value = "/update")
      @ResponseStatus(HttpStatus.CREATED)
      @ApiException(UPDATE_TASK_GROUP_ERROR)
      public Result updateTaskGroup(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
                                    @RequestParam("id") Integer id,
                                    @RequestParam("name") String name,
                                    @RequestParam("description") String description,
                                    @RequestParam("groupSize") Integer groupSize) {
          Map<String, Object> result = taskGroupService.updateTaskGroup(loginUser, id, name, description, groupSize);
          return returnDataList(result);
      }
  
      /**
       * query task group list paging
       *
       * @param loginUser login user
       * @param pageNo    page number
       * @param pageSize  page size
       * @return queue list
       */
      @Operation(summary = "list-paging", description = "QUERY_ALL_TASK_GROUP_NOTES")
      @Parameters({
              @Parameter(name = "pageNo", description = "PAGE_NO", required = true, schema = @Schema(implementation = int.class, example = "1")),
              @Parameter(name = "name", description = "TASK_GROUP_NAME", required = false, schema = @Schema(implementation = String.class)),
              @Parameter(name = "pageSize", description = "PAGE_SIZE", required = true, schema = @Schema(implementation = int.class, example = "20"))
      })
      @GetMapping(value = "/list-paging")
      @ResponseStatus(HttpStatus.OK)
      @ApiException(QUERY_TASK_GROUP_LIST_ERROR)
      public Result queryAllTaskGroup(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
                                      @RequestParam(value = "name", required = false) String name,
                                      @RequestParam(value = "status", required = false) Integer status,
                                      @RequestParam("pageNo") Integer pageNo,
                                      @RequestParam("pageSize") Integer pageSize) {
          Map<String, Object> result = taskGroupService.queryAllTaskGroup(loginUser, name, status, pageNo, pageSize);
          return returnDataList(result);
      }
  
      /**
       * query task group list paging
       *
       * @param loginUser login user
       * @param pageNo    page number
       * @param status    status
       * @param pageSize  page size
       * @return queue list
       */
      @Operation(summary = "queryTaskGroupByStatus", description = "QUERY_TASK_GROUP_LIST_BY_STATUS_NOTES")
      @Parameters({
              @Parameter(name = "pageNo", description = "PAGE_NO", required = true, schema = @Schema(implementation = int.class, example = "1")),
              @Parameter(name = "pageSize", description = "PAGE_SIZE", required = true, schema = @Schema(implementation = int.class, example = "20")),
              @Parameter(name = "status", description = "TASK_GROUP_STATUS", required = true, schema = @Schema(implementation = int.class))
      })
      @GetMapping(value = "/query-list-by-status")
      @ResponseStatus(HttpStatus.OK)
      @ApiException(QUERY_TASK_GROUP_LIST_ERROR)
      public Result queryTaskGroupByStatus(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
                                           @RequestParam("pageNo") Integer pageNo,
                                           @RequestParam(value = "status", required = false) Integer status,
                                           @RequestParam("pageSize") Integer pageSize) {
          Map<String, Object> result = taskGroupService.queryTaskGroupByStatus(loginUser, pageNo, pageSize, status);
          return returnDataList(result);
      }
  
      /**
       * query task group list paging by project code
       *
       * @param loginUser   login user
       * @param pageNo      page number
       * @param projectCode project code
       * @param pageSize    page size
       * @return queue list
       */
      @Operation(summary = "queryTaskGroupByName", description = "QUERY_TASK_GROUP_LIST_BY_PROJECT_ID_NOTES")
      @Parameters({
              @Parameter(name = "pageNo", description = "PAGE_NO", required = true, schema = @Schema(implementation = int.class, example = "1")),
              @Parameter(name = "pageSize", description = "PAGE_SIZE", required = true, schema = @Schema(implementation = int.class, example = "20")),
              @Parameter(name = "projectCode", description = "PROJECT_CODE", required = true, schema = @Schema(implementation = String.class))
      })
      @GetMapping(value = "/query-list-by-projectCode")
      @ResponseStatus(HttpStatus.OK)
      @ApiException(QUERY_TASK_GROUP_LIST_ERROR)
      public Result queryTaskGroupByCode(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
                                         @RequestParam("pageNo") Integer pageNo,
                                         @RequestParam(value = "projectCode", required = false) Long projectCode,
                                         @RequestParam("pageSize") Integer pageSize) {
          Map<String, Object> result =
                  taskGroupService.queryTaskGroupByProjectCode(loginUser, pageNo, pageSize, projectCode);
          return returnDataList(result);
      }
  
      /**
       * close a task group
       *
       * @param loginUser login user
       * @param id        id
       * @return result
       */
      @Operation(summary = "closeTaskGroup", description = "CLOSE_TASK_GROUP_NOTES")
      @Parameters({
              @Parameter(name = "id", description = "ID", required = true, schema = @Schema(implementation = int.class))
      })
      @PostMapping(value = "/close-task-group")
      @ResponseStatus(HttpStatus.CREATED)
      @ApiException(CLOSE_TASK_GROUP_ERROR)
      public Result closeTaskGroup(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
                                   @RequestParam(value = "id", required = false) Integer id) {
  
          Map<String, Object> result = taskGroupService.closeTaskGroup(loginUser, id);
          return returnDataList(result);
      }
  
      /**
       * start a task group
       *
       * @param loginUser login user
       * @param id        id
       * @return result
       */
      @Operation(summary = "startTaskGroup", description = "START_TASK_GROUP_NOTES")
      @Parameters({
              @Parameter(name = "id", description = "TASK_GROUP_ID", required = true, schema = @Schema(implementation = int.class))
      })
      @PostMapping(value = "/start-task-group")
      @ResponseStatus(HttpStatus.CREATED)
      @ApiException(START_TASK_GROUP_ERROR)
      public Result startTaskGroup(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
                                   @RequestParam(value = "id", required = false) Integer id) {
          Map<String, Object> result = taskGroupService.startTaskGroup(loginUser, id);
          return returnDataList(result);
      }
  
      /**
       * force start task without task group
       *
       * @param loginUser login user
       * @param queueId   task group queue id
       * @return result
       */
      @Operation(summary = "forceStart", description = "FORCE_START_TASK_GROUP")
      @Parameters({
              @Parameter(name = "queueId", description = "TASK_GROUP_QUEUE_ID", required = true, schema = @Schema(implementation = int.class))
      })
      @PostMapping(value = "/forceStart")
      @ResponseStatus(HttpStatus.CREATED)
      @ApiException(START_TASK_GROUP_ERROR)
      public Result forceStart(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
                               @RequestParam(value = "queueId") Integer queueId) {
          Map<String, Object> result = taskGroupService.forceStartTask(loginUser, queueId);
          return returnDataList(result);
      }
  
      /**
       * force start task without task group
       *
       * @param loginUser login user
       * @param queueId   task group queue id
       * @return result
       */
      @Operation(summary = "modifyPriority", description = "MODIFY_TASK_GROUP_PRIORITY")
      @Parameters({
              @Parameter(name = "queueId", description = "TASK_GROUP_QUEUE_ID", required = true, schema = @Schema(implementation = int.class)),
              @Parameter(name = "priority", description = "TASK_GROUP_QUEUE_PRIORITY", required = true, schema = @Schema(implementation = int.class))
      })
      @PostMapping(value = "/modifyPriority")
      @ResponseStatus(HttpStatus.CREATED)
      @ApiException(START_TASK_GROUP_ERROR)
      public Result modifyPriority(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
                                   @RequestParam(value = "queueId") Integer queueId,
                                   @RequestParam(value = "priority") Integer priority) {
          Map<String, Object> result = taskGroupService.modifyPriority(loginUser, queueId, priority);
          return returnDataList(result);
      }
  
      @Autowired
      private TaskGroupQueueService taskGroupQueueService;
  
      /**
       * query task group queue list paging
       *
       * @param groupId     ID for task group
       * @param taskName    Task Name
       * @param processName Process instance name
       * @param status      Task queue status
       * @param loginUser   login user
       * @param pageNo      page number
       * @param pageSize    page size
       * @return queue list
       */
      @Operation(summary = "queryTaskGroupQueuesByGroupId", description = "QUERY_TASKS_GROUP_GROUP_QUEUES")
      @Parameters({
              @Parameter(name = "groupId", description = "GROUP_ID", required = false, schema = @Schema(implementation = int.class, example = "1", defaultValue = "-1")),
              @Parameter(name = "taskInstanceName", description = "TASK_INSTANCE_NAME", required = false, schema = @Schema(implementation = String.class, example = "taskName")),
              @Parameter(name = "processInstanceName", description = "PROCESS_INSTANCE_NAME", required = false, schema = @Schema(implementation = String.class, example = "processName")),
              @Parameter(name = "status", description = "TASK_GROUP_STATUS", required = false, schema = @Schema(implementation = int.class, example = "1")),
              @Parameter(name = "pageNo", description = "PAGE_NO", required = true, schema = @Schema(implementation = int.class, example = "1")),
              @Parameter(name = "pageSize", description = "PAGE_SIZE", required = true, schema = @Schema(implementation = int.class, example = "20"))
      })
      @GetMapping(value = "/query-list-by-group-id")
      @ResponseStatus(HttpStatus.OK)
      @ApiException(QUERY_TASK_GROUP_QUEUE_LIST_ERROR)
      public Result queryTaskGroupQueues(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
                                         @RequestParam(value = "groupId", required = false, defaultValue = "-1") Integer groupId,
                                         @RequestParam(value = "taskInstanceName", required = false) String taskName,
                                         @RequestParam(value = "processInstanceName", required = false) String processName,
                                         @RequestParam(value = "status", required = false) Integer status,
                                         @RequestParam("pageNo") Integer pageNo,
                                         @RequestParam("pageSize") Integer pageSize) {
          Map<String, Object> result = taskGroupQueueService.queryTasksByGroupId(
                  loginUser,
                  taskName,
                  processName,
                  status,
                  groupId,
                  pageNo,
                  pageSize);
          return returnDataList(result);
      }
  
  }
  