calvinjiang commented on code in PR #14264: URL: https://github.com/apache/dolphinscheduler/pull/14264#discussion_r1225031212
########## dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/service/impl/ProjectParameterServiceImpl.java: ########## @@ -0,0 +1,273 @@ +/* + * 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.service.impl; + +import static org.apache.dolphinscheduler.api.constants.ApiFuncIdentificationConstant.PROJECT; + +import org.apache.dolphinscheduler.api.enums.Status; +import org.apache.dolphinscheduler.api.exceptions.ServiceException; +import org.apache.dolphinscheduler.api.service.ProjectParameterService; +import org.apache.dolphinscheduler.api.service.ProjectService; +import org.apache.dolphinscheduler.api.utils.PageInfo; +import org.apache.dolphinscheduler.api.utils.Result; +import org.apache.dolphinscheduler.common.constants.Constants; +import org.apache.dolphinscheduler.common.utils.CodeGenerateUtils; +import org.apache.dolphinscheduler.dao.entity.Project; +import org.apache.dolphinscheduler.dao.entity.ProjectParameter; +import org.apache.dolphinscheduler.dao.entity.User; +import org.apache.dolphinscheduler.dao.mapper.ProjectMapper; +import org.apache.dolphinscheduler.dao.mapper.ProjectParameterMapper; + +import org.apache.commons.collections4.CollectionUtils; +import org.apache.commons.lang3.StringUtils; + +import java.util.Date; +import java.util.List; +import java.util.Set; +import java.util.stream.Collectors; + +import lombok.extern.slf4j.Slf4j; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +import com.baomidou.mybatisplus.core.metadata.IPage; +import com.baomidou.mybatisplus.extension.plugins.pagination.Page; +import com.google.common.collect.Lists; + +@Service +@Slf4j +public class ProjectParameterServiceImpl extends BaseServiceImpl implements ProjectParameterService { + + @Autowired + private ProjectParameterMapper projectParameterMapper; + + @Autowired + private ProjectService projectService; + + @Autowired + private ProjectMapper projectMapper; + + @Override + @Transactional + public Result createProjectParameter(User loginUser, long projectCode, String projectParameterName, + String projectParameterValue) { + Result result = new Result(); + + // check if user have write perm for project + Project project = projectMapper.queryByCode(projectCode); + boolean hasProjectAndWritePerm = projectService.hasProjectAndWritePerm(loginUser, project, result); + if (!hasProjectAndWritePerm) { + return result; Review Comment: It would be good to put a message that can clarify why users can't create the project parameter. ```suggestion return result; ``` ```suggestion return result; ``` ########## dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/service/impl/ProjectParameterServiceImpl.java: ########## @@ -0,0 +1,273 @@ +/* + * 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.service.impl; + +import static org.apache.dolphinscheduler.api.constants.ApiFuncIdentificationConstant.PROJECT; + +import org.apache.dolphinscheduler.api.enums.Status; +import org.apache.dolphinscheduler.api.exceptions.ServiceException; +import org.apache.dolphinscheduler.api.service.ProjectParameterService; +import org.apache.dolphinscheduler.api.service.ProjectService; +import org.apache.dolphinscheduler.api.utils.PageInfo; +import org.apache.dolphinscheduler.api.utils.Result; +import org.apache.dolphinscheduler.common.constants.Constants; +import org.apache.dolphinscheduler.common.utils.CodeGenerateUtils; +import org.apache.dolphinscheduler.dao.entity.Project; +import org.apache.dolphinscheduler.dao.entity.ProjectParameter; +import org.apache.dolphinscheduler.dao.entity.User; +import org.apache.dolphinscheduler.dao.mapper.ProjectMapper; +import org.apache.dolphinscheduler.dao.mapper.ProjectParameterMapper; + +import org.apache.commons.collections4.CollectionUtils; +import org.apache.commons.lang3.StringUtils; + +import java.util.Date; +import java.util.List; +import java.util.Set; +import java.util.stream.Collectors; + +import lombok.extern.slf4j.Slf4j; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +import com.baomidou.mybatisplus.core.metadata.IPage; +import com.baomidou.mybatisplus.extension.plugins.pagination.Page; +import com.google.common.collect.Lists; + +@Service +@Slf4j +public class ProjectParameterServiceImpl extends BaseServiceImpl implements ProjectParameterService { + + @Autowired + private ProjectParameterMapper projectParameterMapper; + + @Autowired + private ProjectService projectService; + + @Autowired + private ProjectMapper projectMapper; + + @Override + @Transactional + public Result createProjectParameter(User loginUser, long projectCode, String projectParameterName, + String projectParameterValue) { + Result result = new Result(); + + // check if user have write perm for project + Project project = projectMapper.queryByCode(projectCode); + boolean hasProjectAndWritePerm = projectService.hasProjectAndWritePerm(loginUser, project, result); + if (!hasProjectAndWritePerm) { + return result; + } + + ProjectParameter projectParameter = projectParameterMapper.queryByName(projectParameterName); + if (projectParameter != null) { + log.warn("ProjectParameter {} already exists.", projectParameter.getParamName()); + putMsg(result, Status.PROJECT_PARAMETER_ALREADY_EXISTS, projectParameter.getParamName()); + return result; + } + + Date now = new Date(); + + try { + projectParameter = ProjectParameter + .builder() + .paramName(projectParameterName) + .paramValue(projectParameterValue) + .code(CodeGenerateUtils.getInstance().genCode()) + .projectCode(projectCode) + .userId(loginUser.getId()) + .createTime(now) + .updateTime(now) + .build(); + } catch (CodeGenerateUtils.CodeGenerateException e) { + log.error("Generate project parameter code error.", e); + putMsg(result, Status.CREATE_PROJECT_PARAMETER_ERROR); + return result; + } + + if (projectParameterMapper.insert(projectParameter) > 0) { + log.info("Project parameter is created and id is :{}", projectParameter.getId()); + result.setData(projectParameter); + putMsg(result, Status.SUCCESS); + } else { + log.error("Project parameter create error, projectName:{}.", projectParameter.getParamName()); + putMsg(result, Status.CREATE_PROJECT_PARAMETER_ERROR); + } + return result; + } + + @Override + public Result updateProjectParameter(User loginUser, long projectCode, long code, String projectParameterName, + String projectParameterValue) { + Result result = new Result(); + + // check if user have write perm for project + Project project = projectMapper.queryByCode(projectCode); + boolean hasProjectAndWritePerm = projectService.hasProjectAndWritePerm(loginUser, project, result); + if (!hasProjectAndWritePerm) { + return result; + } + + ProjectParameter projectParameter = projectParameterMapper.queryByCode(code); + // check project parameter exists + if (projectParameter == null || projectCode != projectParameter.getProjectCode()) { + log.error("Project parameter does not exist, code:{}.", code); + putMsg(result, Status.PROJECT_PARAMETER_NOT_EXISTS, String.valueOf(code)); + return result; + } + + // check if project parameter name exists + ProjectParameter tempProjectParameter = projectParameterMapper.queryByName(projectParameterName); + if (tempProjectParameter != null) { + log.error("Project parameter name {} already exists", projectParameterName); + putMsg(result, Status.PROJECT_PARAMETER_ALREADY_EXISTS, projectParameterName); + return result; + } + + projectParameter.setParamName(projectParameterName); + projectParameter.setParamValue(projectParameterValue); + + if (projectParameterMapper.updateById(projectParameter) > 0) { + log.info("Project parameter is updated and id is :{}", projectParameter.getId()); + result.setData(projectParameter); + putMsg(result, Status.SUCCESS); + } else { + log.error("Project parameter update error, {}.", projectParameterName); + putMsg(result, Status.UPDATE_PROJECT_PARAMETER_ERROR); + } + return result; + } + + @Override + public Result deleteProjectParametersByCode(User loginUser, long projectCode, long code) { + Result result = new Result(); + + // check if user have write perm for project + Project project = projectMapper.queryByCode(projectCode); + boolean hasProjectAndWritePerm = projectService.hasProjectAndWritePerm(loginUser, project, result); + if (!hasProjectAndWritePerm) { + return result; + } + + ProjectParameter projectParameter = projectParameterMapper.queryByCode(code); + // check project parameter exists + if (projectParameter == null || projectCode != projectParameter.getProjectCode()) { + log.error("Project parameter does not exist, code:{}.", code); + putMsg(result, Status.PROJECT_PARAMETER_NOT_EXISTS, String.valueOf(code)); + return result; + } + + if (projectParameterMapper.deleteById(projectParameter.getId()) > 0) { + log.info("Project parameter is deleted and id is :{}.", projectParameter.getId()); + result.setData(Boolean.TRUE); + putMsg(result, Status.SUCCESS); + } else { + log.error("Project parameter delete error, {}.", projectParameter.getParamName()); + putMsg(result, Status.DELETE_PROJECT_PARAMETER_ERROR); + } + return result; + } + + @Override + public Result batchDeleteProjectParametersByCodes(User loginUser, long projectCode, String codes) { + Result result = new Result(); + + if (StringUtils.isEmpty(codes)) { + log.error("Project parameter codes is empty, projectCode is {}.", projectCode); + putMsg(result, Status.PROJECT_PARAMETER_CODE_EMPTY); + return result; + } + Review Comment: This here should verify if user has the permission. ########## dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/service/impl/ProjectParameterServiceImpl.java: ########## @@ -0,0 +1,273 @@ +/* + * 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.service.impl; + +import static org.apache.dolphinscheduler.api.constants.ApiFuncIdentificationConstant.PROJECT; + +import org.apache.dolphinscheduler.api.enums.Status; +import org.apache.dolphinscheduler.api.exceptions.ServiceException; +import org.apache.dolphinscheduler.api.service.ProjectParameterService; +import org.apache.dolphinscheduler.api.service.ProjectService; +import org.apache.dolphinscheduler.api.utils.PageInfo; +import org.apache.dolphinscheduler.api.utils.Result; +import org.apache.dolphinscheduler.common.constants.Constants; +import org.apache.dolphinscheduler.common.utils.CodeGenerateUtils; +import org.apache.dolphinscheduler.dao.entity.Project; +import org.apache.dolphinscheduler.dao.entity.ProjectParameter; +import org.apache.dolphinscheduler.dao.entity.User; +import org.apache.dolphinscheduler.dao.mapper.ProjectMapper; +import org.apache.dolphinscheduler.dao.mapper.ProjectParameterMapper; + +import org.apache.commons.collections4.CollectionUtils; +import org.apache.commons.lang3.StringUtils; + +import java.util.Date; +import java.util.List; +import java.util.Set; +import java.util.stream.Collectors; + +import lombok.extern.slf4j.Slf4j; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +import com.baomidou.mybatisplus.core.metadata.IPage; +import com.baomidou.mybatisplus.extension.plugins.pagination.Page; +import com.google.common.collect.Lists; + +@Service +@Slf4j +public class ProjectParameterServiceImpl extends BaseServiceImpl implements ProjectParameterService { + + @Autowired + private ProjectParameterMapper projectParameterMapper; + + @Autowired + private ProjectService projectService; + + @Autowired + private ProjectMapper projectMapper; + + @Override + @Transactional + public Result createProjectParameter(User loginUser, long projectCode, String projectParameterName, + String projectParameterValue) { + Result result = new Result(); + + // check if user have write perm for project + Project project = projectMapper.queryByCode(projectCode); + boolean hasProjectAndWritePerm = projectService.hasProjectAndWritePerm(loginUser, project, result); + if (!hasProjectAndWritePerm) { + return result; + } + + ProjectParameter projectParameter = projectParameterMapper.queryByName(projectParameterName); + if (projectParameter != null) { + log.warn("ProjectParameter {} already exists.", projectParameter.getParamName()); + putMsg(result, Status.PROJECT_PARAMETER_ALREADY_EXISTS, projectParameter.getParamName()); + return result; + } + + Date now = new Date(); + + try { + projectParameter = ProjectParameter + .builder() + .paramName(projectParameterName) + .paramValue(projectParameterValue) + .code(CodeGenerateUtils.getInstance().genCode()) + .projectCode(projectCode) + .userId(loginUser.getId()) + .createTime(now) + .updateTime(now) + .build(); + } catch (CodeGenerateUtils.CodeGenerateException e) { + log.error("Generate project parameter code error.", e); + putMsg(result, Status.CREATE_PROJECT_PARAMETER_ERROR); + return result; + } + + if (projectParameterMapper.insert(projectParameter) > 0) { + log.info("Project parameter is created and id is :{}", projectParameter.getId()); + result.setData(projectParameter); + putMsg(result, Status.SUCCESS); + } else { + log.error("Project parameter create error, projectName:{}.", projectParameter.getParamName()); + putMsg(result, Status.CREATE_PROJECT_PARAMETER_ERROR); + } + return result; + } + + @Override + public Result updateProjectParameter(User loginUser, long projectCode, long code, String projectParameterName, + String projectParameterValue) { + Result result = new Result(); + + // check if user have write perm for project + Project project = projectMapper.queryByCode(projectCode); + boolean hasProjectAndWritePerm = projectService.hasProjectAndWritePerm(loginUser, project, result); + if (!hasProjectAndWritePerm) { + return result; + } + + ProjectParameter projectParameter = projectParameterMapper.queryByCode(code); + // check project parameter exists + if (projectParameter == null || projectCode != projectParameter.getProjectCode()) { + log.error("Project parameter does not exist, code:{}.", code); + putMsg(result, Status.PROJECT_PARAMETER_NOT_EXISTS, String.valueOf(code)); + return result; + } + + // check if project parameter name exists + ProjectParameter tempProjectParameter = projectParameterMapper.queryByName(projectParameterName); + if (tempProjectParameter != null) { + log.error("Project parameter name {} already exists", projectParameterName); + putMsg(result, Status.PROJECT_PARAMETER_ALREADY_EXISTS, projectParameterName); + return result; + } + + projectParameter.setParamName(projectParameterName); + projectParameter.setParamValue(projectParameterValue); + + if (projectParameterMapper.updateById(projectParameter) > 0) { + log.info("Project parameter is updated and id is :{}", projectParameter.getId()); + result.setData(projectParameter); + putMsg(result, Status.SUCCESS); + } else { + log.error("Project parameter update error, {}.", projectParameterName); + putMsg(result, Status.UPDATE_PROJECT_PARAMETER_ERROR); + } + return result; + } + + @Override + public Result deleteProjectParametersByCode(User loginUser, long projectCode, long code) { + Result result = new Result(); + + // check if user have write perm for project + Project project = projectMapper.queryByCode(projectCode); + boolean hasProjectAndWritePerm = projectService.hasProjectAndWritePerm(loginUser, project, result); + if (!hasProjectAndWritePerm) { + return result; + } + + ProjectParameter projectParameter = projectParameterMapper.queryByCode(code); + // check project parameter exists + if (projectParameter == null || projectCode != projectParameter.getProjectCode()) { + log.error("Project parameter does not exist, code:{}.", code); + putMsg(result, Status.PROJECT_PARAMETER_NOT_EXISTS, String.valueOf(code)); + return result; + } + + if (projectParameterMapper.deleteById(projectParameter.getId()) > 0) { Review Comment: In my opinion, before deleting a parameter, this here should check if there's any workflows that has used the parameter. Or it might be risky to delete a parameter. ########## dolphinscheduler-dao/src/main/resources/sql/dolphinscheduler_postgresql.sql: ########## @@ -588,6 +588,26 @@ create index user_id_index on t_ds_project (user_id); CREATE UNIQUE INDEX unique_name on t_ds_project (name); CREATE UNIQUE INDEX unique_code on t_ds_project (code); +-- +-- Table structure for table t_ds_project_parameter +-- + +DROP TABLE IF EXISTS t_ds_project_parameter; +CREATE TABLE t_ds_project_parameter ( + id int NOT NULL , + param_name varchar(255) NOT NULL , + param_value varchar(255) NOT NULL , + code bigint NOT NULL, + project_code bigint NOT NULL, + user_id int DEFAULT NULL , + create_time timestamp DEFAULT CURRENT_TIMESTAMP , + update_time timestamp DEFAULT CURRENT_TIMESTAMP , + PRIMARY KEY (id) +) ; + +CREATE UNIQUE INDEX unique_project_parameter_name on t_ds_project_parameter (param_name); Review Comment: The parameter name in a project should be unique. But it should be allowed to exist in another project. So this here need to be "CREATE UNIQUE INDEX unique_project_parameter_name on t_ds_project_parameter (project_code,param_name);" ########## dolphinscheduler-dao/src/main/resources/sql/dolphinscheduler_mysql.sql: ########## @@ -664,6 +664,28 @@ CREATE TABLE `t_ds_project` ( -- Records of t_ds_project -- ---------------------------- +-- ---------------------------- +-- Table structure for t_ds_project_parameter +-- ---------------------------- +DROP TABLE IF EXISTS `t_ds_project_parameter`; +CREATE TABLE `t_ds_project_parameter` ( + `id` int(11) NOT NULL AUTO_INCREMENT COMMENT 'key', + `param_name` varchar(255) NOT NULL COMMENT 'project parameter name', + `param_value` varchar(255) NOT NULL COMMENT 'project parameter value', + `code` bigint(20) NOT NULL COMMENT 'encoding', + `project_code` bigint(20) NOT NULL COMMENT 'project code', + `user_id` int(11) DEFAULT NULL COMMENT 'creator id', + `create_time` datetime NOT NULL COMMENT 'create time', + `update_time` datetime DEFAULT NULL COMMENT 'update time', + PRIMARY KEY (`id`), + UNIQUE KEY `unique_project_parameter_name`(`param_name`), Review Comment: The problem is same as in "dolphinscheduler_postgresql.sql". -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
