forked from apache/dolphinscheduler
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[feat][API] New restful API for workflow state (apache#13031)
- Loading branch information
Showing
20 changed files
with
998 additions
and
51 deletions.
There are no files selected for viewing
206 changes: 206 additions & 0 deletions
206
...-api/src/main/java/org/apache/dolphinscheduler/api/controller/StatisticsV2Controller.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,206 @@ | ||
| /* | ||
| * 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.COUNT_PROCESS_DEFINITION_USER_ERROR; | ||
| import static org.apache.dolphinscheduler.api.enums.Status.QUERY_ALL_WORKFLOW_COUNT_ERROR; | ||
| import static org.apache.dolphinscheduler.api.enums.Status.QUERY_ONE_TASK_STATES_COUNT_ERROR; | ||
| import static org.apache.dolphinscheduler.api.enums.Status.QUERY_ONE_WORKFLOW_STATE_COUNT_ERROR; | ||
| import static org.apache.dolphinscheduler.api.enums.Status.QUERY_TASK_STATES_COUNT_ERROR; | ||
| import static org.apache.dolphinscheduler.api.enums.Status.QUERY_WORKFLOW_STATES_COUNT_ERROR; | ||
|
|
||
| import org.apache.dolphinscheduler.api.aspect.AccessLogAnnotation; | ||
| import org.apache.dolphinscheduler.api.dto.project.StatisticsStateRequest; | ||
| import org.apache.dolphinscheduler.api.exceptions.ApiException; | ||
| import org.apache.dolphinscheduler.api.service.DataAnalysisService; | ||
| import org.apache.dolphinscheduler.api.utils.Result; | ||
| import org.apache.dolphinscheduler.common.constants.Constants; | ||
| import org.apache.dolphinscheduler.dao.entity.User; | ||
|
|
||
| import org.apache.commons.lang3.StringUtils; | ||
|
|
||
| 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.PathVariable; | ||
| import org.springframework.web.bind.annotation.RequestAttribute; | ||
| import org.springframework.web.bind.annotation.RequestBody; | ||
| import org.springframework.web.bind.annotation.RequestMapping; | ||
| 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.tags.Tag; | ||
| /** | ||
| * StatisticsV2 controller | ||
| */ | ||
| @Tag(name = "STATISTICS_V2") | ||
| @RestController | ||
| @RequestMapping("/v2/statistics") | ||
| public class StatisticsV2Controller extends BaseController { | ||
|
|
||
| @Autowired | ||
| private DataAnalysisService dataAnalysisService; | ||
|
|
||
| /** | ||
| * query all workflow count | ||
| * @param loginUser login user | ||
| * @return workflow count | ||
| */ | ||
| @Operation(summary = "queryAllWorkflowCount", description = "QUERY_ALL_WORKFLOW_COUNT") | ||
| @GetMapping(value = "/workflows/count") | ||
| @ResponseStatus(HttpStatus.OK) | ||
| @ApiException(QUERY_ALL_WORKFLOW_COUNT_ERROR) | ||
| @AccessLogAnnotation(ignoreRequestArgs = "loginUser") | ||
| public Result queryWorkflowInstanceCounts(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser) { | ||
| Map<String, Object> result = dataAnalysisService.queryAllWorkflowCounts(loginUser); | ||
| return returnDataList(result); | ||
| } | ||
|
|
||
| /** | ||
| * query all workflow states count | ||
| * @param loginUser login user | ||
| * @param statisticsStateRequest statisticsStateRequest | ||
| * @return workflow states count | ||
| */ | ||
| @Operation(summary = "queryAllWorkflowStatesCount", description = "QUERY_ALL_WORKFLOW_STATES_COUNT") | ||
| @GetMapping(value = "/workflows/states/count") | ||
| @ResponseStatus(HttpStatus.OK) | ||
| @ApiException(QUERY_WORKFLOW_STATES_COUNT_ERROR) | ||
| @AccessLogAnnotation(ignoreRequestArgs = "loginUser") | ||
| public Result queryWorkflowStatesCounts(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser, | ||
| @RequestBody(required = false) StatisticsStateRequest statisticsStateRequest) { | ||
| Map<String, Object> result = | ||
| dataAnalysisService.countWorkflowStates(loginUser, statisticsStateRequest); | ||
| return returnDataList(result); | ||
| } | ||
|
|
||
| /** | ||
| * query one workflow states count | ||
| * @param loginUser login user | ||
| * @param workflowCode workflowCode | ||
| * @return workflow states count | ||
| */ | ||
| @Operation(summary = "queryOneWorkflowStatesCount", description = "QUERY_One_WORKFLOW_STATES_COUNT") | ||
| @GetMapping(value = "/{workflowCode}/states/count") | ||
| @ResponseStatus(HttpStatus.OK) | ||
| @ApiException(QUERY_ONE_WORKFLOW_STATE_COUNT_ERROR) | ||
| @AccessLogAnnotation(ignoreRequestArgs = "loginUser") | ||
| public Result queryOneWorkflowStates(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser, | ||
| @PathVariable("workflowCode") Long workflowCode) { | ||
| Map<String, Object> result = | ||
| dataAnalysisService.countOneWorkflowStates(loginUser, workflowCode); | ||
| return returnDataList(result); | ||
| } | ||
|
|
||
| /** | ||
| * query all task states count | ||
| * @param loginUser login user | ||
| * @param statisticsStateRequest statisticsStateRequest | ||
| * @return tasks states count | ||
| */ | ||
| @Operation(summary = "queryAllTaskStatesCount", description = "QUERY_ALL_TASK_STATES_COUNT") | ||
| @GetMapping(value = "/tasks/states/count") | ||
| @ResponseStatus(HttpStatus.OK) | ||
| @ApiException(QUERY_TASK_STATES_COUNT_ERROR) | ||
| @AccessLogAnnotation(ignoreRequestArgs = "loginUser") | ||
| public Result queryTaskStatesCounts(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser, | ||
| @RequestBody(required = false) StatisticsStateRequest statisticsStateRequest) { | ||
| Map<String, Object> result = | ||
| dataAnalysisService.countTaskStates(loginUser, statisticsStateRequest); | ||
| return returnDataList(result); | ||
| } | ||
|
|
||
| /** | ||
| * query one task states count | ||
| * @param loginUser login user | ||
| * @param taskCode taskCode | ||
| * @return tasks states count | ||
| */ | ||
| @Operation(summary = "queryOneTaskStatesCount", description = "QUERY_ONE_TASK_STATES_COUNT") | ||
| @GetMapping(value = "/tasks/{taskCode}/states/count") | ||
| @ResponseStatus(HttpStatus.OK) | ||
| @ApiException(QUERY_ONE_TASK_STATES_COUNT_ERROR) | ||
| @AccessLogAnnotation(ignoreRequestArgs = "loginUser") | ||
| public Result queryOneTaskStatesCounts(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser, | ||
| @PathVariable("taskCode") Long taskCode) { | ||
| Map<String, Object> result = | ||
| dataAnalysisService.countOneTaskStates(loginUser, taskCode); | ||
| return returnDataList(result); | ||
| } | ||
|
|
||
| /** | ||
| * statistics the workflow quantities of certain user | ||
| * @param loginUser login user | ||
| * @param statisticsStateRequest statisticsStateRequest | ||
| * @return workflow count in project code | ||
| */ | ||
| @Operation(summary = "countDefinitionV2ByUserId", description = "COUNT_PROCESS_DEFINITION_V2_BY_USERID_NOTES") | ||
| @GetMapping(value = "/workflows/users/count") | ||
| @ResponseStatus(HttpStatus.OK) | ||
| @ApiException(COUNT_PROCESS_DEFINITION_USER_ERROR) | ||
| @AccessLogAnnotation(ignoreRequestArgs = "loginUser") | ||
| public Result countDefinitionByUser(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser, | ||
| @RequestBody(required = false) StatisticsStateRequest statisticsStateRequest) { | ||
| String projectName = statisticsStateRequest.getProjectName(); | ||
| Long projectCode = statisticsStateRequest.getProjectCode(); | ||
| if (null == projectCode && !StringUtils.isBlank(projectName)) { | ||
| projectCode = dataAnalysisService.getProjectCodeByName(projectName); | ||
| } | ||
| Map<String, Object> result = dataAnalysisService.countDefinitionByUserV2(loginUser, projectCode, null, null); | ||
| return returnDataList(result); | ||
| } | ||
|
|
||
| /** | ||
| * statistics the workflow quantities of certain userId | ||
| * @param loginUser login user | ||
| * @param userId userId | ||
| * @return workflow count in project code | ||
| */ | ||
| @Operation(summary = "countDefinitionV2ByUser", description = "COUNT_PROCESS_DEFINITION_V2_BY_USER_NOTES") | ||
| @GetMapping(value = "/workflows/users/{userId}/count") | ||
| @ResponseStatus(HttpStatus.OK) | ||
| @ApiException(COUNT_PROCESS_DEFINITION_USER_ERROR) | ||
| @AccessLogAnnotation(ignoreRequestArgs = "loginUser") | ||
| public Result countDefinitionByUserId(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser, | ||
| @PathVariable("userId") Integer userId) { | ||
| Map<String, Object> result = dataAnalysisService.countDefinitionByUserV2(loginUser, null, userId, null); | ||
| return returnDataList(result); | ||
| } | ||
| /** | ||
| * statistics the workflow quantities of certain userId and releaseState | ||
| * @param loginUser login user | ||
| * @param userId userId | ||
| * @param releaseState releaseState | ||
| * @return workflow count in project code | ||
| */ | ||
| @Operation(summary = "countDefinitionV2ByUser", description = "COUNT_PROCESS_DEFINITION_V2_BY_USER_NOTES") | ||
| @GetMapping(value = "/workflows/users/{userId}/{releaseState}/count") | ||
| @ResponseStatus(HttpStatus.OK) | ||
| @ApiException(COUNT_PROCESS_DEFINITION_USER_ERROR) | ||
| @AccessLogAnnotation(ignoreRequestArgs = "loginUser") | ||
| public Result countDefinitionByUserState(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser, | ||
| @PathVariable("userId") Integer userId, | ||
| @PathVariable("releaseState") Integer releaseState) { | ||
| Map<String, Object> result = dataAnalysisService.countDefinitionByUserV2(loginUser, null, userId, releaseState); | ||
| return returnDataList(result); | ||
| } | ||
| } |
60 changes: 60 additions & 0 deletions
60
...api/src/main/java/org/apache/dolphinscheduler/api/dto/project/StatisticsStateRequest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| /* | ||
| * 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.dto.project; | ||
|
|
||
| import java.util.Date; | ||
|
|
||
| import lombok.Data; | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonIgnoreProperties; | ||
| import com.fasterxml.jackson.annotation.JsonInclude; | ||
| import io.swagger.v3.oas.annotations.media.Schema; | ||
|
|
||
| @Data | ||
| @JsonIgnoreProperties(ignoreUnknown = true) | ||
| @JsonInclude(JsonInclude.Include.NON_NULL) | ||
| public class StatisticsStateRequest { | ||
|
|
||
| @Schema(name = "isAll", example = "true") | ||
| boolean isAll; | ||
|
|
||
| @Schema(name = "projectName", example = "PROJECT-NAME") | ||
| String projectName; | ||
|
|
||
| @Schema(name = "projectCode", example = "1234567890") | ||
| Long projectCode; | ||
|
|
||
| @Schema(name = "workflowName", example = "WORKFLOW-NAME") | ||
| String workflowName; | ||
|
|
||
| @Schema(name = "workflowCode", example = "1234567890") | ||
| Long workflowCode; | ||
|
|
||
| @Schema(name = "taskName", example = "TASK-NAME") | ||
| String taskName; | ||
|
|
||
| @Schema(name = "taskCode", example = "1234567890") | ||
| Long taskCode; | ||
|
|
||
| @Schema(name = "startDate", example = "2022-01-01 10:01:02") | ||
| Date startTime; | ||
|
|
||
| @Schema(name = "endDate", example = "2022-01-02 10:01:02") | ||
| Date endTime; | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.