Feat: The plugin now performs a fetch and check for updates when pulling before stashing, this way local changes are not stashed if the local branch is up-to-date

Author: L1nc0ln

api/src/main/java/de/adito/git/api/IRepository.java

@@ -152,6 +152,15 @@ String commit(@NotNull String pMessage, @NotNull List<File> pFileList, @Nullable
    */
   Map<String, EPushResult> push(boolean pIsPushTags, @Nullable String pRemoteName) throws AditoGitException;
 
+  /**
+   * Checks if the branch contains all changes from the second branch
+   *
+   * @param pBranch    the current branch/branch to check
+   * @param pCompareTo the method checks if the changes from this branch are contained in the first branch. For a pull this would be the upstream branch
+   * @return true if the changes from the second branch are contained in the first, false otherwise
+   */
+  boolean isUpToDate(@NotNull IBranch pBranch, @NotNull IBranch pCompareTo) throws AditoGitException;
+
   /**
    * Pulls the current contents of the tracked remote branch of the currently selected local branch
    * from origin via pull --rebase

gui/src/main/java/de/adito/git/gui/actions/ActionUtility.java

@@ -1,5 +1,6 @@
 package de.adito.git.gui.actions;
 
+import com.google.inject.internal.Messages;
 import de.adito.git.api.IRepository;
 import de.adito.git.api.data.EResetType;
 import de.adito.git.api.data.ICommit;
@@ -10,19 +11,25 @@
 import de.adito.git.api.progress.IProgressHandle;
 import de.adito.git.gui.dialogs.IDialogProvider;
 import de.adito.git.gui.dialogs.results.IStashChangesQuestionDialogResult;
+import de.adito.git.impl.Util;
 import io.reactivex.Observable;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+import java.text.MessageFormat;
 import java.util.List;
 import java.util.Optional;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
 /**
  * @author m.kaspera, 01.07.2019
  */
 class ActionUtility
 {
 
+  private static final Logger LOGGER = Logger.getLogger(ActionUtility.class.getName());
+
   /**
    * Asks the user if he wants to stash the changed files, discard the changes or abort the current action
    *
@@ -46,14 +53,17 @@ static boolean handleStash(@NotNull IPrefStore pPrefStore, @NotNull IDialogProvi
     if (dialogResult.isStashChanges())
     {
       if (pHandle != null)
-        pHandle.setDescription("Stashing existing changes");
-      pPrefStore.put(pStashKey, pRepository.stashChanges(null, true));
+        pHandle.setDescription(Util.getResource(ActionUtility.class, "stashProgressMsg"));
+      String stashId = pRepository.stashChanges(null, true);
+      LOGGER.log(Level.INFO, () -> MessageFormat.format(Util.getResource(ActionUtility.class, "stashDoneMsg"), stashId));
+      pPrefStore.put(pStashKey, stashId);
     }
     else if (dialogResult.isDiscardChanges())
     {
       ICommit head = pRepository.getCommit(null);
       if (head == null)
-        throw new AditoGitException("Cannot determine HEAD, so the current changes can't be discarded");
+        throw new AditoGitException(Util.getResource(ActionUtility.class, "stashDiscardErrorMsg"));
+      LOGGER.log(Level.INFO, () -> Messages.format(Util.getResource(ActionUtility.class, "stashDiscardMsg"), head.getId()));
       pRepository.reset(head.getId(), EResetType.HARD);
     }
     return true;

gui/src/main/java/de/adito/git/gui/actions/PullAction.java

@@ -41,6 +41,7 @@ class PullAction extends AbstractAction
 {
   private static final String STASH_ID_KEY = "pull::stashCommitId";
   private static final String NO_VALID_REPO_MSG = "no valid repository found";
+  private final Logger logger = Logger.getLogger(this.getClass().getName());
   private final Observable<Optional<IRepository>> repository;
   private final IPrefStore prefStore;
   private final IDialogProvider dialogProvider;
@@ -67,8 +68,8 @@ class PullAction extends AbstractAction
     progressFacade = pProgressFacade;
     saveUtil = pSaveUtil;
     mergeConflictSequence = pMergeConflictSequence;
-    putValue(Action.NAME, "Pull");
-    putValue(Action.SHORT_DESCRIPTION, "Pull all changes from the remote Branch");
+    putValue(Action.NAME, Util.getResource(this.getClass(), "pullActionName"));
+    putValue(Action.SHORT_DESCRIPTION, Util.getResource(this.getClass(), "pullTooltipMsg"));
     repository = pRepository;
   }
 
@@ -78,7 +79,7 @@ class PullAction extends AbstractAction
   @Override
   public void actionPerformed(ActionEvent pEvent)
   {
-    progressFacade.executeAndBlockWithProgress("Updating Project...", this::_doRebase);
+    progressFacade.executeAndBlockWithProgress(Util.getResource(this.getClass(), "pullHandleTitleMsg"), this::_doRebase);
   }
 
   /**
@@ -88,12 +89,27 @@ public void actionPerformed(ActionEvent pEvent)
   private void _doRebase(@NotNull IProgressHandle pProgressHandle)
   {
     saveUtil.saveUnsavedFiles();
-    pProgressHandle.setDescription("Retrieving Repository");
+    pProgressHandle.setDescription(Util.getResource(this.getClass(), "pullGetRepoHandleMsg"));
     IRepository pRepo = repository.blockingFirst().orElseThrow(() -> new RuntimeException(NO_VALID_REPO_MSG));
     boolean doAbort = false;
     try
     {
       ICommit head = pRepo.getCommit(null);
+      IRepositoryState repositoryState = pRepo.getRepositoryState().blockingFirst(Optional.empty()).orElse(null);
+      if (repositoryState == null || repositoryState.getCurrentRemoteTrackedBranch() == null)
+      {
+        notifyUtil.notify(Util.getResource(this.getClass(), "pullAbortTitle"), Util.getResource(this.getClass(), "pullFailedRepoStateMsg"), false);
+        return;
+      }
+      else
+      {
+        pProgressHandle.setDescription(Util.getResource(this.getClass(), "pullFetchHandleMsg"));
+        if (pRepo.isUpToDate(repositoryState.getCurrentBranch(), repositoryState.getCurrentRemoteTrackedBranch()))
+        {
+          notifyUtil.notify(Util.getResource(this.getClass(), "pullBrancheUpToDateTitle"), Util.getResource(this.getClass(), "pullBrancheUpToDateMsg"), false);
+          return;
+        }
+      }
       if (pRepo.getStatus().blockingFirst().map(pStatus -> !pStatus.getConflicting().isEmpty()).orElse(false))
       {
         notifyUtil.notify(Util.getResource(this.getClass(), "pullExistingConflictingFilesTitle"),
@@ -111,7 +127,7 @@ private void _doRebase(@NotNull IProgressHandle pProgressHandle)
       }
       while (!doAbort)
       {
-        pProgressHandle.setDescription("Rebasing");
+        pProgressHandle.setDescription(Util.getResource(this.getClass(), "pullRebaseHandleMsg"));
         IRebaseResult rebaseResult =
             pRepo.pull(false);
         if (rebaseResult.isSuccess())
@@ -129,7 +145,7 @@ private void _doRebase(@NotNull IProgressHandle pProgressHandle)
         }
         if (!rebaseResult.getMergeConflicts().isEmpty())
         {
-          pProgressHandle.setDescription("Resolving Conflicts");
+          pProgressHandle.setDescription(Util.getResource(this.getClass(), "pullResolveConflictsHandleMsg"));
           // if the pull should be aborted, _handleConflictDialog returns true
           IMergeDetails mergeDetails = new MergeDetailsImpl(rebaseResult.getMergeConflicts(), "Local", "Remote");
           doAbort = _handleConflictDialog(pRepo, mergeDetails);
@@ -150,7 +166,7 @@ private void _doRebase(@NotNull IProgressHandle pProgressHandle)
     catch (AuthCancelledException pE)
     {
       notifyUtil.notify(Util.getResource(this.getClass(), "pullAbortTitle"), Util.getResource(this.getClass(), "pullAbortDueToAuthCancel"), false);
-      Logger.getLogger(this.getClass().getName()).log(Level.WARNING, pE, () -> Util.getResource(this.getClass(), "authCancelledLogMessage"));
+      logger.log(Level.WARNING, pE, () -> Util.getResource(this.getClass(), "authCancelledLogMessage"));
     }
     catch (AditoGitException e)
     {

gui/src/main/resources/de/adito/git/gui/actions/Bundle.properties

@@ -6,6 +6,9 @@ mergeSavedStateMsg=Saved the current merge state, use "resolve conflicts" to res
 mergeBranchesUpToDateTitle=Already up-to-date
 mergeBranchesUpToDateMsg=Branches are already up-to-date/merged
 # Pull Action
+pullActionName=Pull
+pullHandleTitleMsg=Updating Project...
+pullTooltipMsg=Pull all changes from the remote Branch
 pullSuccessTitle=Pull successful
 pullSuccessMsg=The pull --rebase was successful, files are now up-to-date
 pullAlreadyUpToDate=Files are already up-to-date
@@ -21,6 +24,13 @@ pullExistingConflictingFilesMsg=There are files that have the conflicting state,
 pullFailedUpstreamBranchMsg=Pull failed, could not determine upstream branch
 pullFailedExceptionMsg=Pull failed due to an exception
 rebaseMergeCommitsWarning=<html>Local unpushed commits contain a merge-commit, rebasing a merge-commit can lead to lost data.<br>Do you want to merge the remote branch into the current branch instead?</html>
+pullBrancheUpToDateTitle=Already up-to-date
+pullBrancheUpToDateMsg=The local branch already has all upstream changes
+pullFetchHandleMsg=Checking remote for updates
+pullRebaseHandleMsg=Rebasing
+pullResolveConflictsHandleMsg=Resolving Conflicts
+pullGetRepoHandleMsg=Retrieving Repository
+pullFailedRepoStateMsg=Failed to read repository state for the remote tracked branch
 #Commit Action
 noFilesToCommitMsg=No changed files detected, so there is nothing to commit
 noFilesToCommitTitle=No files to commit
@@ -73,7 +83,7 @@ tbnfeDetailsMsg=<html>The plugin is not able to determine the target branch or c
 resolveConflictsTitle=Resolve Conflicts
 resolveConflictsFailureMsg=Could determine neither the target nor the state before the operation that led to the conflict, please reset the current branch to the commit you based from manually
 #StashChangesAction
-stashProgressMsg=Stashing changes
+stashProgressMsg=Stashing existing changes
 stashFailureMsg=An error occurred during the stash process
 #UnStashChangesAction
 unstashFailureMsg=An error occurred while trying to unstash
@@ -87,3 +97,6 @@ unknownHostMsg=Could not resolve the repository url {0}, make sure it is a valid
 renormalizeNewlinesTitle=Renormalize newlines
 renormalizeNewlinesFailureNoRepo=Could not find suitable git repo, renormalize newlines was not attempted
 renormalizeNewlinesFailureException=Renormalizing the newlines failed
+stashDoneMsg=Stashed current changes with commit id {0}
+stashDiscardMsg=Git: Discarded current changes by resetting to HEAD commit with id {0}
+stashDiscardErrorMsg=Cannot determine HEAD, so the current changes can't be discarded

impl/src/main/java/de/adito/git/impl/RepositoryImpl.java

@@ -338,6 +338,21 @@ public Map<String, EPushResult> push(boolean pIsPushTags, @Nullable String pRemo
     return resultMap;
   }
 
+  @Override
+  public boolean isUpToDate(@NotNull IBranch pCommit, @NotNull IBranch pCompareTo) throws AditoGitException
+  {
+    fetch();
+    try
+    {
+      String forkPointId = ObjectId.toString(RepositoryImplHelper.findForkPoint(git, pCommit.getName(), pCompareTo.getName()));
+      return forkPointId.equals(pCompareTo.getId());
+    }
+    catch (IOException pE)
+    {
+      throw new AditoGitException("Failed to find find fork-point due to an exception", pE);
+    }
+  }
+
   private void _setRefSpec(PushCommand pPush, IRepositoryState pRepositoryState)
   {
     IBranch remoteTrackedBranch = pRepositoryState.getCurrentRemoteTrackedBranch();