Protei/PromucFlow_constructor
2
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore: refactor git constants (#16287)

Browse Source
This commit is contained in:
Anagh Hegde 2022-08-25 20:52:25 +05:30 committed by GitHub
parent a5851cd171
commit 043705f343
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 45 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
app/server/appsmith-interfaces/src/main/java/com/appsmith/external/constants/GitConstants.java vendored
View File

@ -7,4 +7,16 @@ public class GitConstants {
public static final String PAGE_LIST = "pageList";
public static final String ACTION_LIST = "actionList";
public static final String ACTION_COLLECTION_LIST = "actionCollectionList";
public static final String DEFAULT_COMMIT_MESSAGE = "System generated commit, ";
public static final String EMPTY_COMMIT_ERROR_MESSAGE = "On current branch nothing to commit, working tree clean";
public static final String MERGE_CONFLICT_BRANCH_NAME = "_mergeConflict";
public static final String CONFLICTED_SUCCESS_MESSAGE = "branch has been created from conflicted state. Please " +
"resolve merge conflicts in remote and pull again";
public static final String GIT_CONFIG_ERROR = "Unable to find the git configuration, please configure your application " +
"with git to use version control service";
public static final String GIT_PROFILE_ERROR = "Unable to find git author configuration for logged-in user. You can" +
" set up a git profile from the user profile section.";
}

18
app/server/appsmith-server/src/main/java/com/appsmith/server/constants/GitDefaultCommitMessage.java Normal file
View File

@ -0,0 +1,18 @@
package com.appsmith.server.constants;
public enum GitDefaultCommitMessage {
CONFLICT_STATE("for conflicted state"),
CONNECT_FLOW("initial commit"),
BRANCH_CREATED("after creating a new branch: "),
SYNC_WITH_REMOTE_AFTER_PULL("for syncing changes with remote after git pull"),
SYNC_REMOTE_AFTER_MERGE("for syncing changes with local branch after git merge, branch: ");
private final String reason;
GitDefaultCommitMessage(String reason) {
this.reason = reason;
}
public String getReason() {
return this.reason;
}
}

53
app/server/appsmith-server/src/main/java/com/appsmith/server/services/ce/GitServiceCEImpl.java
View File

@ -14,6 +14,7 @@ import com.appsmith.external.constants.AnalyticsEvents;
import com.appsmith.server.constants.Assets;
import com.appsmith.server.constants.Entity;
import com.appsmith.server.constants.FieldName;
import com.appsmith.server.constants.GitDefaultCommitMessage;
import com.appsmith.server.constants.SerialiseApplicationObjective;
import com.appsmith.server.domains.Application;
import com.appsmith.server.dtos.ApplicationJson;
@ -79,6 +80,12 @@ import java.util.Optional;
import java.util.concurrent.TimeoutException;
import java.util.stream.Collectors;
import static com.appsmith.external.constants.GitConstants.CONFLICTED_SUCCESS_MESSAGE;
import static com.appsmith.external.constants.GitConstants.DEFAULT_COMMIT_MESSAGE;
import static com.appsmith.external.constants.GitConstants.EMPTY_COMMIT_ERROR_MESSAGE;
import static com.appsmith.external.constants.GitConstants.GIT_CONFIG_ERROR;
import static com.appsmith.external.constants.GitConstants.GIT_PROFILE_ERROR;
import static com.appsmith.external.constants.GitConstants.MERGE_CONFLICT_BRANCH_NAME;
import static com.appsmith.server.acl.AclPermission.MANAGE_ACTIONS;
import static com.appsmith.server.acl.AclPermission.MANAGE_APPLICATIONS;
import static com.appsmith.server.acl.AclPermission.MANAGE_DATASOURCES;
@ -124,36 +131,6 @@ public class GitServiceCEImpl implements GitServiceCE {
private final DatasourceService datasourceService;
private final PluginService pluginService;
private final static String DEFAULT_COMMIT_MESSAGE = "System generated commit, ";
private final static String EMPTY_COMMIT_ERROR_MESSAGE = "On current branch nothing to commit, working tree clean";
private final static String MERGE_CONFLICT_BRANCH_NAME = "_mergeConflict";
private final static String CONFLICTED_SUCCESS_MESSAGE = "branch has been created from conflicted state. Please " +
"resolve merge conflicts in remote and pull again";
private final static String GIT_CONFIG_ERROR = "Unable to find the git configuration, please configure your application " +
"with git to use version control service";
private final static String GIT_PROFILE_ERROR = "Unable to find git author configuration for logged-in user. You can" +
" set up a git profile from the user profile section.";
private enum DEFAULT_COMMIT_REASONS {
CONFLICT_STATE("for conflicted state"),
CONNECT_FLOW("initial commit"),
BRANCH_CREATED("after creating a new branch: "),
SYNC_WITH_REMOTE_AFTER_PULL("for syncing changes with remote after git pull"),
SYNC_REMOTE_AFTER_MERGE("for syncing changes with local branch after git merge, branch: ");
private final String reason;
DEFAULT_COMMIT_REASONS(String reason) {
this.reason = reason;
}
private String getReason() {
return this.reason;
}
}
@Override
public Mono<Application> updateGitMetadata(String applicationId, GitApplicationMetadata gitApplicationMetadata) {
@ -359,7 +336,7 @@ public class GitServiceCEImpl implements GitServiceCE {
StringBuilder result = new StringBuilder();
if (commitMessage == null || commitMessage.isEmpty()) {
commitDTO.setCommitMessage(DEFAULT_COMMIT_MESSAGE + DEFAULT_COMMIT_REASONS.CONNECT_FLOW.getReason());
commitDTO.setCommitMessage(DEFAULT_COMMIT_MESSAGE + GitDefaultCommitMessage.CONNECT_FLOW.getReason());
}
if (StringUtils.isEmptyOrNull(branchName)) {
throw new AppsmithException(AppsmithError.INVALID_PARAMETER, FieldName.BRANCH_NAME);
@ -848,7 +825,7 @@ public class GitServiceCEImpl implements GitServiceCE {
}
return gitExecutor.commitApplication(
tuple.getT1(),
DEFAULT_COMMIT_MESSAGE + DEFAULT_COMMIT_REASONS.CONNECT_FLOW.getReason(),
DEFAULT_COMMIT_MESSAGE + GitDefaultCommitMessage.CONNECT_FLOW.getReason(),
profile.getAuthorName(),
profile.getAuthorEmail(),
false,
@ -859,7 +836,7 @@ public class GitServiceCEImpl implements GitServiceCE {
// Commit and push application to check if the SSH key has the write access
GitCommitDTO commitDTO = new GitCommitDTO();
commitDTO.setDoPush(true);
commitDTO.setCommitMessage(DEFAULT_COMMIT_MESSAGE + DEFAULT_COMMIT_REASONS.CONNECT_FLOW.getReason());
commitDTO.setCommitMessage(DEFAULT_COMMIT_MESSAGE + GitDefaultCommitMessage.CONNECT_FLOW.getReason());
return this.commitApplication(commitDTO, defaultApplicationId, application.getGitApplicationMetadata().getBranchName(), true)
@ -1208,7 +1185,7 @@ public class GitServiceCEImpl implements GitServiceCE {
// new branch from uncommitted branch
GitApplicationMetadata gitData = application.getGitApplicationMetadata();
GitCommitDTO commitDTO = new GitCommitDTO();
commitDTO.setCommitMessage(DEFAULT_COMMIT_MESSAGE + DEFAULT_COMMIT_REASONS.BRANCH_CREATED.getReason() + gitData.getBranchName());
commitDTO.setCommitMessage(DEFAULT_COMMIT_MESSAGE + GitDefaultCommitMessage.BRANCH_CREATED.getReason() + gitData.getBranchName());
commitDTO.setDoPush(true);
return commitApplication(commitDTO, gitData.getDefaultApplicationId(), gitData.getBranchName())
.thenReturn(application);
@ -1692,7 +1669,7 @@ public class GitServiceCEImpl implements GitServiceCE {
.flatMap(application1 -> {
GitCommitDTO commitDTO = new GitCommitDTO();
commitDTO.setDoPush(true);
commitDTO.setCommitMessage(DEFAULT_COMMIT_MESSAGE + DEFAULT_COMMIT_REASONS.SYNC_REMOTE_AFTER_MERGE.getReason() + sourceBranch);
commitDTO.setCommitMessage(DEFAULT_COMMIT_MESSAGE + GitDefaultCommitMessage.SYNC_REMOTE_AFTER_MERGE.getReason() + sourceBranch);
return this.commitApplication(commitDTO, defaultApplicationId, destinationBranch)
.map(commitStatus -> mergeStatusDTO)
.zipWith(Mono.just(application1));
@ -1826,7 +1803,7 @@ public class GitServiceCEImpl implements GitServiceCE {
Path repoSuffix = tuple.getT3();
return gitExecutor.createAndCheckoutToBranch(repoSuffix, branchName + MERGE_CONFLICT_BRANCH_NAME)
.flatMap(conflictedBranchName ->
commitAndPushWithDefaultCommit(repoSuffix, gitData.getGitAuth(), gitData, DEFAULT_COMMIT_REASONS.CONFLICT_STATE)
commitAndPushWithDefaultCommit(repoSuffix, gitData.getGitAuth(), gitData, GitDefaultCommitMessage.CONFLICT_STATE)
.flatMap(successMessage -> gitExecutor.checkoutToBranch(repoSuffix, branchName))
.flatMap(isCheckedOut -> gitExecutor.deleteBranch(repoSuffix, conflictedBranchName))
.thenReturn(conflictedBranchName + CONFLICTED_SUCCESS_MESSAGE)
@ -2255,7 +2232,7 @@ public class GitServiceCEImpl implements GitServiceCE {
private Mono<String> commitAndPushWithDefaultCommit(Path repoSuffix,
GitAuth auth,
GitApplicationMetadata gitApplicationMetadata,
DEFAULT_COMMIT_REASONS reason) {
GitDefaultCommitMessage reason) {
return gitExecutor.commitApplication(repoSuffix, DEFAULT_COMMIT_MESSAGE + reason.getReason(), APPSMITH_BOT_USERNAME, emailConfig.getSupportEmailAddress(), true, false)
.onErrorResume(error -> {
if (error instanceof EmptyCommitException) {
@ -2424,7 +2401,7 @@ public class GitServiceCEImpl implements GitServiceCE {
)
.flatMap(application -> {
GitCommitDTO commitDTO = new GitCommitDTO();
commitDTO.setCommitMessage(DEFAULT_COMMIT_MESSAGE + DEFAULT_COMMIT_REASONS.SYNC_WITH_REMOTE_AFTER_PULL.getReason());
commitDTO.setCommitMessage(DEFAULT_COMMIT_MESSAGE + GitDefaultCommitMessage.SYNC_WITH_REMOTE_AFTER_PULL.getReason());
commitDTO.setDoPush(true);
GitPullDTO gitPullDTO = new GitPullDTO();