-
Notifications
You must be signed in to change notification settings - Fork 5.1k
[Improvement-18286][ApiServer] Remove the default workerGroup from the frontend and add backend validation for workerGroup #18293
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: dev
Are you sure you want to change the base?
Changes from 18 commits
3a82410
1d4e03d
8d60888
a497475
6c7c487
1c0c970
b9575ef
96647e1
9acd656
9f6e1bb
fe79ac0
1a4e69f
fa6a00e
2bde4ce
6429a6f
743117e
1ad45ac
564cee2
74919b0
978df66
b4c698b
f2531a5
9cd44c6
3cbac05
a75eacc
f327266
861d8c7
1ab127d
9b1fa14
ecc17f3
26ab2f7
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /* | ||
| * 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; | ||
|
|
||
| import lombok.Data; | ||
|
|
||
| @Data | ||
| public class ProjectPreferencesDTO { | ||
|
|
||
| private String taskPriority; | ||
|
|
||
| private String workerGroup; | ||
|
|
||
| private Long environmentCode; | ||
|
|
||
| private Integer failRetryTimes; | ||
|
|
||
| private Integer failRetryInterval; | ||
|
|
||
| private Integer cpuQuota; | ||
|
|
||
| private Integer memoryMax; | ||
|
|
||
| private Boolean timeoutFlag; | ||
|
|
||
| private String[] timeoutNotifyStrategy; | ||
|
|
||
| private Integer timeout; | ||
|
|
||
| private String warningType; | ||
|
|
||
| private String tenantCode; | ||
|
|
||
| private Integer warningGroupId; | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,17 +19,24 @@ | |
|
|
||
| import static org.apache.dolphinscheduler.api.constants.ApiFuncIdentificationConstant.PROJECT; | ||
|
|
||
| import org.apache.dolphinscheduler.api.dto.ProjectPreferencesDTO; | ||
| import org.apache.dolphinscheduler.api.enums.Status; | ||
| import org.apache.dolphinscheduler.api.exceptions.ServiceException; | ||
| import org.apache.dolphinscheduler.api.service.ProjectPreferenceService; | ||
| import org.apache.dolphinscheduler.api.service.ProjectService; | ||
| import org.apache.dolphinscheduler.api.utils.Result; | ||
| import org.apache.dolphinscheduler.api.validator.WorkerGroupValidationContext; | ||
| import org.apache.dolphinscheduler.api.validator.WorkerGroupValidator; | ||
| import org.apache.dolphinscheduler.common.utils.CodeGenerateUtils; | ||
| import org.apache.dolphinscheduler.common.utils.JSONUtils; | ||
| import org.apache.dolphinscheduler.dao.entity.Project; | ||
| import org.apache.dolphinscheduler.dao.entity.ProjectPreference; | ||
| import org.apache.dolphinscheduler.dao.entity.User; | ||
| import org.apache.dolphinscheduler.dao.mapper.ProjectPreferenceMapper; | ||
| import org.apache.dolphinscheduler.dao.repository.ProjectDao; | ||
|
|
||
| import org.apache.commons.lang3.StringUtils; | ||
|
|
||
| import java.util.Date; | ||
| import java.util.Objects; | ||
|
|
||
|
|
@@ -55,8 +62,11 @@ | |
| @Autowired | ||
| private ProjectDao projectDao; | ||
|
|
||
| @Autowired | ||
|
Check warning on line 65 in dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/service/impl/ProjectPreferenceServiceImpl.java
|
||
| private WorkerGroupValidator workerGroupValidator; | ||
|
|
||
| @Override | ||
| public Result updateProjectPreference(User loginUser, long projectCode, String preferences) { | ||
|
Check failure on line 69 in dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/service/impl/ProjectPreferenceServiceImpl.java
|
||
| Result result = new Result(); | ||
|
|
||
| // check if the user has the writing permission for project | ||
|
|
@@ -67,6 +77,27 @@ | |
| .selectOne(new QueryWrapper<ProjectPreference>().lambda().eq(ProjectPreference::getProjectCode, | ||
| projectCode)); | ||
|
|
||
| if (StringUtils.isNotEmpty(preferences)) { | ||
| try { | ||
| ProjectPreferencesDTO preferencesDTO = JSONUtils.parseObject(preferences, ProjectPreferencesDTO.class); | ||
| if (preferencesDTO != null && StringUtils.isNotEmpty(preferencesDTO.getWorkerGroup())) { | ||
| WorkerGroupValidationContext workerGroupContext = WorkerGroupValidationContext.builder() | ||
| .workerGroup(preferencesDTO.getWorkerGroup()) | ||
| .projectCode(projectCode) | ||
| .build(); | ||
| try { | ||
|
Check warning on line 88 in dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/service/impl/ProjectPreferenceServiceImpl.java
|
||
| workerGroupValidator.validate(workerGroupContext); | ||
| } catch (ServiceException e) { | ||
| putMsg(result, Status.WORKER_GROUP_NOT_ASSIGNED_TO_PROJECT, preferencesDTO.getWorkerGroup()); | ||
| return result; | ||
| } | ||
| } | ||
| } catch (Exception e) { | ||
| log.warn("Failed to parse preferences JSON: {}", preferences, e); | ||
Check warningCode scanning / CodeQL Log Injection Medium
This log entry depends on a
user-provided value Error loading related location Loading |
||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. throw
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
ok |
||
| throw new ServiceException(Status.UPDATE_PROJECT_PREFERENCE_ERROR); | ||
| } | ||
| } | ||
|
|
||
| Date now = new Date(); | ||
| if (Objects.isNull(projectPreference)) { | ||
| projectPreference = new ProjectPreference(); | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -51,6 +51,7 @@ | |
| import org.apache.dolphinscheduler.api.utils.PageInfo; | ||
| import org.apache.dolphinscheduler.api.utils.Result; | ||
| import org.apache.dolphinscheduler.api.validator.GlobalParamsValidator; | ||
| import org.apache.dolphinscheduler.api.validator.WorkerGroupValidator; | ||
| import org.apache.dolphinscheduler.common.constants.Constants; | ||
| import org.apache.dolphinscheduler.common.enums.ReleaseState; | ||
| import org.apache.dolphinscheduler.common.enums.UserType; | ||
|
|
@@ -209,6 +210,9 @@ | |
| @Autowired | ||
| private GlobalParamsValidator globalParamsValidator; | ||
|
|
||
| @Autowired | ||
|
Check warning on line 213 in dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/service/impl/WorkflowDefinitionServiceImpl.java
|
||
| private WorkerGroupValidator workerGroupValidator; | ||
|
|
||
| /** | ||
| * create workflow definition | ||
| * | ||
|
|
@@ -256,6 +260,10 @@ | |
| globalParamsValidator.validate(globalParams); | ||
|
|
||
| List<TaskDefinitionLog> taskDefinitionLogs = generateTaskDefinitionList(taskDefinitionJson); | ||
|
|
||
| // Validate worker groups in task definitions | ||
| validateTaskWorkerGroups(projectCode, taskDefinitionLogs); | ||
|
|
||
| List<WorkflowTaskRelationLog> taskRelationList = generateTaskRelationList(taskRelationJson, taskDefinitionLogs); | ||
|
|
||
| long workflowDefinitionCode = CodeGenerateUtils.genCode(); | ||
|
|
@@ -381,6 +389,21 @@ | |
| } | ||
| } | ||
|
|
||
| /** | ||
| * Validate worker groups in task definitions | ||
| */ | ||
| private void validateTaskWorkerGroups(long projectCode, List<TaskDefinitionLog> taskDefinitionLogs) { | ||
| if (CollectionUtils.isEmpty(taskDefinitionLogs)) { | ||
| return; | ||
| } | ||
|
|
||
| List<String> workerGroups = taskDefinitionLogs.stream() | ||
| .map(TaskDefinitionLog::getWorkerGroup) | ||
| .collect(Collectors.toList()); | ||
|
|
||
| workerGroupValidator.validate(workerGroups, projectCode); | ||
| } | ||
|
Comment on lines
+395
to
+405
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This kind of code should put into
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Okay, I will unify the logic. |
||
|
|
||
| private List<WorkflowTaskRelationLog> generateTaskRelationList(String taskRelationJson, | ||
| List<TaskDefinitionLog> taskDefinitionLogs) { | ||
| try { | ||
|
|
@@ -626,6 +649,10 @@ | |
| globalParamsValidator.validate(globalParams); | ||
|
|
||
| List<TaskDefinitionLog> taskDefinitionLogs = generateTaskDefinitionList(taskDefinitionJson); | ||
|
|
||
| // Validate worker groups in task definitions | ||
| validateTaskWorkerGroups(projectCode, taskDefinitionLogs); | ||
|
|
||
| List<WorkflowTaskRelationLog> taskRelationList = generateTaskRelationList(taskRelationJson, taskDefinitionLogs); | ||
|
|
||
| WorkflowDefinition workflowDefinition = workflowDefinitionDao.queryByCode(code).orElse(null); | ||
|
|
@@ -1636,7 +1663,6 @@ | |
| * | ||
| * @param srcProjectCode srcProjectCode | ||
| * @param targetProjectCode targetProjectCode | ||
| * @param result result | ||
| * @param failedWorkflowList failedWorkflowList | ||
| * @param isCopy isCopy | ||
| */ | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| /* | ||
| * 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.validator; | ||
|
|
||
| import lombok.AllArgsConstructor; | ||
| import lombok.Builder; | ||
| import lombok.Data; | ||
| import lombok.NoArgsConstructor; | ||
|
|
||
| @Data | ||
| @Builder | ||
| @NoArgsConstructor | ||
| @AllArgsConstructor | ||
| public class WorkerGroupValidationContext { | ||
|
|
||
| private String workerGroup; | ||
|
|
||
| private long projectCode; | ||
|
|
||
| } |
Uh oh!
There was an error while loading. Please reload this page.