chore: reference lifecycle

app/server/appsmith-interfaces/src/main/java/com/appsmith/external/dtos/GitRefDTO.java

@@ -0,0 +1,20 @@
+package com.appsmith.external.dtos;
+
+import com.appsmith.external.git.constants.ce.RefType;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@AllArgsConstructor
+@NoArgsConstructor
+public class GitRefDTO {
+
+    String refName;
+
+    RefType refType;
+
+    boolean isDefault;
+
+    boolean createdFromLocal;
+}

app/server/appsmith-interfaces/src/main/java/com/appsmith/external/dtos/ce/GitStatusCE_DTO.java

@@ -8,6 +8,7 @@
 /**
  * DTO to convey the status local git repo
  */
+// TODO: @Manish modify git status DTO accordingly
 @Data
 public class GitStatusCE_DTO {
 

app/server/appsmith-interfaces/src/main/java/com/appsmith/external/git/constants/ce/RefType.java

@@ -0,0 +1,6 @@
+package com.appsmith.external.git.constants.ce;
+
+public enum RefType {
+    BRANCH,
+    TAG
+}

app/server/appsmith-server/src/main/java/com/appsmith/server/constants/ce/FieldNameCE.java

@@ -102,6 +102,7 @@ public class FieldNameCE {
     public static final String IS_REQUIRED = "isRequired";
     public static final String UNUSED_DATASOURCE = "UNUSED_DATASOURCE";
     public static final String BRANCH_NAME = "branchName";
+    public static final String REF_NAME = "refName";
     public static final String SOURCE_BRANCH = "sourceBranch";
     public static final String DESTINATION_BRANCH = "destinationBranch";
     public static final String DEFAULT = "default";

app/server/appsmith-server/src/main/java/com/appsmith/server/domains/ce/GitArtifactMetadataCE.java

@@ -1,8 +1,8 @@
 package com.appsmith.server.domains.ce;
 
+import com.appsmith.external.git.constants.ce.RefType;
 import com.appsmith.external.models.AppsmithDomain;
 import com.appsmith.external.views.Views;
-import com.appsmith.server.constants.ce.RefType;
 import com.appsmith.server.domains.AutoCommitConfig;
 import com.appsmith.server.domains.GitAuth;
 import com.appsmith.server.domains.GitProfile;

app/server/appsmith-server/src/main/java/com/appsmith/server/git/central/CentralGitServiceCE.java

@@ -1,8 +1,9 @@
 package com.appsmith.server.git.central;
 
+import com.appsmith.external.dtos.GitStatusDTO;
+import com.appsmith.external.git.constants.ce.RefType;
 import com.appsmith.git.dto.CommitDTO;
 import com.appsmith.server.constants.ArtifactType;
-import com.appsmith.server.constants.ce.RefType;
 import com.appsmith.server.domains.Artifact;
 import com.appsmith.server.dtos.ArtifactImportDTO;
 import com.appsmith.server.dtos.GitConnectDTO;
@@ -33,4 +34,15 @@ Mono<String> fetchRemoteChanges(
             RefType refType);
 
     Mono<? extends Artifact> discardChanges(String branchedArtifactId, ArtifactType artifactType, GitType gitType);
+
+    Mono<GitStatusDTO> getStatus(
+            String branchedArtifactId, boolean compareRemote, ArtifactType artifactType, GitType gitType);
+
+    Mono<? extends Artifact> checkoutReference(
+            String referenceArtifactId,
+            String referenceToBeCheckedOut,
+            boolean addFileLock,
+            ArtifactType artifactType,
+            GitType gitType,
+            RefType refType);
 }

app/server/appsmith-server/src/main/java/com/appsmith/server/git/central/GitHandlingServiceCE.java

@@ -1,5 +1,7 @@
 package com.appsmith.server.git.central;
 
+import com.appsmith.external.dtos.GitStatusDTO;
+import com.appsmith.external.git.constants.ce.RefType;
 import com.appsmith.git.dto.CommitDTO;
 import com.appsmith.server.domains.Artifact;
 import com.appsmith.server.domains.GitArtifactMetadata;
@@ -39,8 +41,16 @@ void setRepositoryDetailsInGitArtifactMetadata(
 
     Mono<Boolean> removeRepository(ArtifactJsonTransformationDTO artifactJsonTransformationDTO);
 
+    Mono<List<String>> listBranches(
+            ArtifactJsonTransformationDTO artifactJsonTransformationDTO, Boolean checkRemoteBranches);
+
     Mono<List<String>> listBranches(ArtifactJsonTransformationDTO artifactJsonTransformationDTO);
 
+    Mono<List<String>> listReferences(
+            ArtifactJsonTransformationDTO artifactJsonTransformationDTO,
+            Boolean checkRemoteReferences,
+            RefType refType);
+
     Mono<Boolean> validateEmptyRepository(ArtifactJsonTransformationDTO artifactJsonTransformationDTO);
 
     Mono<Boolean> initialiseReadMe(
@@ -51,14 +61,20 @@ Mono<Boolean> initialiseReadMe(
 
     Mono<String> createFirstCommit(ArtifactJsonTransformationDTO jsonTransformationDTO, CommitDTO commitDTO);
 
+    // TODO: provide a proper name
     Mono<Boolean> prepareChangesToBeCommitted(
             ArtifactJsonTransformationDTO jsonTransformationDTO, ArtifactExchangeJson artifactExchangeJson);
 
     Mono<Tuple2<? extends Artifact, String>> commitArtifact(
             Artifact branchedArtifact, CommitDTO commitDTO, ArtifactJsonTransformationDTO jsonTransformationDTO);
 
-    Mono<String> fetchRemoteChanges(ArtifactJsonTransformationDTO jsonTransformationDTO, GitAuth gitAuth);
+    Mono<String> fetchRemoteChanges(
+            ArtifactJsonTransformationDTO jsonTransformationDTO, GitAuth gitAuth, Boolean isFetchAll);
 
     Mono<? extends ArtifactExchangeJson> recreateArtifactJsonFromLastCommit(
             ArtifactJsonTransformationDTO jsonTransformationDTO);
+
+    Mono<GitStatusDTO> getStatus(ArtifactJsonTransformationDTO jsonTransformationDTO);
+
+    Mono<String> prepareForNewRefCreation(ArtifactJsonTransformationDTO artifactJsonTransformationDTO);
 }

app/server/appsmith-server/src/main/java/com/appsmith/server/git/dtos/ArtifactJsonTransformationDTO.java

@@ -1,7 +1,7 @@
 package com.appsmith.server.git.dtos;
 
+import com.appsmith.external.git.constants.ce.RefType;
 import com.appsmith.server.constants.ArtifactType;
-import com.appsmith.server.constants.ce.RefType;
 import lombok.Data;
 
 // TODO: Find a better name for this DTO

app/server/appsmith-server/src/main/java/com/appsmith/server/git/fs/GitFSServiceCEImpl.java

@@ -2,8 +2,10 @@
 
 import com.appsmith.external.constants.AnalyticsEvents;
 import com.appsmith.external.dtos.GitBranchDTO;
+import com.appsmith.external.dtos.GitStatusDTO;
 import com.appsmith.external.git.constants.GitConstants;
 import com.appsmith.external.git.constants.GitSpan;
+import com.appsmith.external.git.constants.ce.RefType;
 import com.appsmith.external.git.handler.FSGitHandler;
 import com.appsmith.git.dto.CommitDTO;
 import com.appsmith.server.acl.AclPermission;
@@ -261,22 +263,46 @@ public Mono<List<String>> listBranches(ArtifactJsonTransformationDTO artifactJso
         GitArtifactHelper<?> gitArtifactHelper =
                 gitArtifactHelperResolver.getArtifactHelper(artifactJsonTransformationDTO.getArtifactType());
 
+        return listBranches(artifactJsonTransformationDTO, Boolean.FALSE);
+    }
+
+    @Override
+    public Mono<List<String>> listBranches(
+            ArtifactJsonTransformationDTO jsonTransformationDTO, Boolean listRemoteBranches) {
+        GitArtifactHelper<?> gitArtifactHelper =
+                gitArtifactHelperResolver.getArtifactHelper(jsonTransformationDTO.getArtifactType());
+
         Path repoSuffix = gitArtifactHelper.getRepoSuffixPath(
-                artifactJsonTransformationDTO.getWorkspaceId(),
-                artifactJsonTransformationDTO.getBaseArtifactId(),
-                artifactJsonTransformationDTO.getRepoName());
+                jsonTransformationDTO.getWorkspaceId(),
+                jsonTransformationDTO.getBaseArtifactId(),
+                jsonTransformationDTO.getRepoName());
 
         return fsGitHandler
                 .listBranches(repoSuffix)
                 .flatMapMany(Flux::fromIterable)
                 .filter(gitBranchDTO -> {
-                    return StringUtils.hasText(gitBranchDTO.getBranchName())
-                            && !gitBranchDTO.getBranchName().startsWith("origin");
+                    boolean branchToBeListed = !gitBranchDTO.getBranchName().startsWith("origin")
+                            || Boolean.TRUE.equals(listRemoteBranches);
+
+                    return StringUtils.hasText(gitBranchDTO.getBranchName()) && branchToBeListed;
                 })
                 .map(GitBranchDTO::getBranchName)
                 .collectList();
     }
 
+    @Override
+    public Mono<List<String>> listReferences(
+            ArtifactJsonTransformationDTO artifactJsonTransformationDTO,
+            Boolean checkRemoteReferences,
+            RefType refType) {
+        if (RefType.BRANCH.equals(refType)) {
+            listBranches(artifactJsonTransformationDTO, checkRemoteReferences);
+        }
+
+        // TODO: include ref type for tags in fsGit Handler
+        return Mono.just(List.of());
+    }
+
     @Override
     public Mono<Boolean> validateEmptyRepository(ArtifactJsonTransformationDTO artifactJsonTransformationDTO) {
         GitArtifactHelper<?> gitArtifactHelper =
@@ -579,7 +605,8 @@ private Mono<String> pushArtifactErrorRecovery(String pushResult, Artifact artif
      * @return : returns string for remote fetch
      */
     @Override
-    public Mono<String> fetchRemoteChanges(ArtifactJsonTransformationDTO jsonTransformationDTO, GitAuth gitAuth) {
+    public Mono<String> fetchRemoteChanges(
+            ArtifactJsonTransformationDTO jsonTransformationDTO, GitAuth gitAuth, Boolean isFetchAll) {
 
         String workspaceId = jsonTransformationDTO.getWorkspaceId();
         String baseArtifactId = jsonTransformationDTO.getBaseArtifactId();
@@ -594,7 +621,7 @@ public Mono<String> fetchRemoteChanges(ArtifactJsonTransformationDTO jsonTransfo
         Mono<Boolean> checkoutBranchMono = fsGitHandler.checkoutToBranch(repoSuffix, refName);
 
         Mono<String> fetchRemoteMono = fsGitHandler.fetchRemote(
-                repoPath, gitAuth.getPublicKey(), gitAuth.getPrivateKey(), true, refName, false);
+                repoPath, gitAuth.getPublicKey(), gitAuth.getPrivateKey(), true, refName, isFetchAll);
 
         return checkoutBranchMono.then(Mono.defer(() -> fetchRemoteMono));
     }
@@ -617,4 +644,32 @@ public Mono<? extends ArtifactExchangeJson> recreateArtifactJsonFromLastCommit(
                     workspaceId, baseArtifactId, repoName, refName, artifactType);
         });
     }
+
+    @Override
+    public Mono<GitStatusDTO> getStatus(ArtifactJsonTransformationDTO jsonTransformationDTO) {
+        String workspaceId = jsonTransformationDTO.getWorkspaceId();
+        String baseArtifactId = jsonTransformationDTO.getBaseArtifactId();
+        String repoName = jsonTransformationDTO.getRepoName();
+        String refName = jsonTransformationDTO.getRefName();
+
+        ArtifactType artifactType = jsonTransformationDTO.getArtifactType();
+        GitArtifactHelper<?> gitArtifactHelper = gitArtifactHelperResolver.getArtifactHelper(artifactType);
+        Path repoSuffix = gitArtifactHelper.getRepoSuffixPath(workspaceId, baseArtifactId, repoName);
+
+        Path repoPath = fsGitHandler.createRepoPath(repoSuffix);
+        return fsGitHandler.getStatus(repoPath, refName);
+    }
+
+    @Override
+    public Mono<String> prepareForNewRefCreation(ArtifactJsonTransformationDTO jsonTransformationDTO) {
+        GitArtifactHelper<?> gitArtifactHelper =
+                gitArtifactHelperResolver.getArtifactHelper(jsonTransformationDTO.getArtifactType());
+
+        Path repoSuffix = gitArtifactHelper.getRepoSuffixPath(
+                jsonTransformationDTO.getWorkspaceId(),
+                jsonTransformationDTO.getBaseArtifactId(),
+                jsonTransformationDTO.getRepoName());
+
+        return fsGitHandler.createAndCheckoutToBranch(repoSuffix, jsonTransformationDTO.getRefName());
+    }
 }