fix: Update compare editor handling to async. (#1622)

Author: ethanyhou

com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/tools/EditFileTool.java

@@ -10,6 +10,7 @@
 import java.util.Map;
 import java.util.concurrent.CompletableFuture;
 
+import org.eclipse.compare.CompareEditorInput;
 import org.eclipse.core.resources.IFile;
 import org.eclipse.core.resources.IResource;
 import org.eclipse.core.runtime.CoreException;
@@ -212,12 +213,15 @@ public void onUndoAllChanges(List<IFile> files) throws CoreException, IOExceptio
 
   @Override
   public void onViewDiff(IFile file) {
-    // Check if the file is already open in a compare editor and bring it to the top if is exists
-    if (compareEditorInputMap.containsKey(file) && bringCompareEditorToTop(compareEditorInputMap.get(file))) {
-      return;
+    CompareEditorInput input = compareEditorInputMap.get(file);
+    if (input != null) {
+      if (isCompareEditorOpen(input)) {
+        bringCompareEditorToTop(input);
+        return;
+      }
+      // Compare editor was closed by the user, remove stale entry and recreate
+      compareEditorInputMap.remove(file);
     }
-    // If the compare editor is created but closed, remove it from the map and create a new one
-    compareEditorInputMap.remove(file);
     compareStringWithFile(fileContentCache.get(file), file);
   }
 

com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/tools/FileToolBase.java

@@ -113,11 +113,13 @@ protected void compareStringWithFile(String originalFileContent, IFile file) {
     try {
       CompareEditorInput input = createCompareEditorInput(originalFileContent, file);
       input.run(new NullProgressMonitor());
-
-      // TODO: Add a progress monitor to show the progress of the operation input.run(new NullProgressMonitor());
       compareEditorInputMap.put(file, input);
-      SwtUtils.invokeOnDisplayThread(() -> {
-        CompareUI.openCompareEditor(input);
+      // TODO: Add a progress monitor to show the progress of the operation input.run(new NullProgressMonitor());
+      SwtUtils.invokeOnDisplayThreadAsync(() -> {
+        CompareEditorInput compareEditorInput = compareEditorInputMap.get(file);
+        if (compareEditorInput != null) {
+          CompareUI.openCompareEditor(compareEditorInput);
+        }
       });
     } catch (InvocationTargetException | InterruptedException e) {
       CopilotCore.LOGGER.error("Error opening compare editor", e);
@@ -138,15 +140,18 @@ protected void updateOrCreateCompareStringWithFile(String fileContent, IFile fil
     CompareEditorInput input = compareEditorInputMap.get(file);
     if (input != null) {
       if (fileContent.equals(fileContentCache.get(file))) {
-        SwtUtils.invokeOnDisplayThread(() -> {
+        SwtUtils.invokeOnDisplayThreadAsync(() -> {
           CompareUI.reuseCompareEditor(input, (IReusableEditor) getCompareEditor(input));
         });
       } else {
         CompareEditorInput newInput = createCompareEditorInput(fileContent, file);
-        SwtUtils.invokeOnDisplayThread(() -> {
-          CompareUI.reuseCompareEditor(newInput, (IReusableEditor) getCompareEditor(input));
-        });
         compareEditorInputMap.put(file, newInput);
+        SwtUtils.invokeOnDisplayThreadAsync(() -> {
+          CompareEditorInput compareEditorInput = compareEditorInputMap.get(file);
+          if (compareEditorInput != null) {
+            CompareUI.reuseCompareEditor(compareEditorInput, (IReusableEditor) getCompareEditor(compareEditorInput));
+          }
+        });
       }
       bringCompareEditorToTop(input);
     } else {
@@ -156,8 +161,8 @@ protected void updateOrCreateCompareStringWithFile(String fileContent, IFile fil
   }
 
   /**
-   * Refreshes the compare editor for the given file only if it is already open.
-   * Does not open a new editor or steal focus.
+   * Refreshes the compare editor for the given file only if it is already open. Does not open a new editor or steal
+   * focus.
    *
    * @param fileContent The original file content to compare against.
    * @param file The file whose compare editor should be refreshed.
@@ -172,8 +177,15 @@ protected void refreshCompareEditorIfOpen(String fileContent, IFile file) {
       compareEditorInputMap.put(file, newInput);
       SwtUtils.invokeOnDisplayThreadAsync(() -> {
         IEditorPart editor = getCompareEditor(input);
-        if (editor != null) {
-          CompareUI.reuseCompareEditor(newInput, (IReusableEditor) editor);
+        if (editor == null) {
+          // If the compare editor is closed, remove the input from the map and skip refreshing.
+          compareEditorInputMap.remove(file);
+          return;
+        } else {
+          CompareEditorInput compareEditorInput = compareEditorInputMap.get(file);
+          if (compareEditorInput != null) {
+            CompareUI.reuseCompareEditor(compareEditorInput, (IReusableEditor) editor);
+          }
         }
       });
     }
@@ -183,19 +195,27 @@ protected void refreshCompareEditorIfOpen(String fileContent, IFile file) {
    * Brings the compare editor to the top of the workbench.
    *
    * @param input The CompareEditorInput to be brought to the top.
-   * @return true if the editor was successfully brought to the top, false otherwise.
    */
-  protected boolean bringCompareEditorToTop(CompareEditorInput input) {
-    AtomicReference<Boolean> ref = new AtomicReference<>(false);
-    SwtUtils.invokeOnDisplayThread(() -> {
+  protected void bringCompareEditorToTop(CompareEditorInput input) {
+    SwtUtils.invokeOnDisplayThreadAsync(() -> {
       IWorkbenchPage page = UiUtils.getActivePage();
       IEditorPart editor = getCompareEditor(input);
       if (editor != null) {
         page.bringToTop(editor);
-        ref.set(true);
       }
     });
-    return ref.get();
+  }
+
+  /**
+   * Checks whether the compare editor for the given input is still open.
+   *
+   * @param input The CompareEditorInput to check.
+   * @return true if the editor is open, false otherwise.
+   */
+  protected boolean isCompareEditorOpen(CompareEditorInput input) {
+    AtomicReference<Boolean> isOpen = new AtomicReference<>(false);
+    SwtUtils.invokeOnDisplayThread(() -> isOpen.set(getCompareEditor(input) != null));
+    return isOpen.get();
   }
 
   private IEditorPart getCompareEditor(CompareEditorInput input) {