✨ Support reviewing resolutions with merge editor (#103)

Changes: 1. add optional configuration property "diffEditorType". If set to "merge" then open resolutions using merge editor. Otherwise use the diff editor. 2. create text document content provider for serving read only virtual files to be used as left side of the merge. Register the provider under "konveyorReadOnly" scheme. --------- Signed-off-by: Radoslaw Szwajkowski <[email protected]>
konveyor · Nov 21, 2024 · 126cbe9 · 126cbe9
1 parent 88daae4
commit 126cbe9
Show file tree

Hide file tree

Showing 6 changed files with 73 additions and 10 deletions.
diff --git a/vscode/package.json b/vscode/package.json
@@ -162,11 +162,23 @@
         "category": "diffEditor",
         "title": "Apply Block"
       },
+      {
+        "command": "konveyor.diffView.applySelectionInline",
+        "icon": "$(check)",
+        "category": "diffEditor",
+        "title": "Apply Selection"
+      },
       {
         "command": "konveyor.diffView.applyBlock",
         "icon": "$(arrow-left)",
         "category": "diffEditor",
         "title": "Apply Block"
+      },
+      {
+        "command": "konveyor.diffView.applySelection",
+        "icon": "$(arrow-left)",
+        "category": "diffEditor",
+        "title": "Apply Selection"
       }
     ],
     "submenus": [
@@ -262,26 +274,26 @@
       ],
       "diffEditor/gutter/selection": [
         {
-          "command": "konveyor.diffView.applyBlockInline",
+          "command": "konveyor.diffView.applySelectionInline",
           "group": "primary",
-          "when": "diffEditorModifiedWritable && diffEditorInlineMode && (diffEditorModifiedUri =~ /^konveyorMemFs\\:.*$/ || diffEditorOriginalUri =~ /^konveyorMemFs\\:.*$/)"
+          "when": "diffEditorInlineMode && ((diffEditorModifiedUri =~ /^konveyorMemFs\\:.*$/ && diffEditorOriginalWritable) || (diffEditorOriginalUri =~ /^konveyorMemFs\\:.*$/ && diffEditorModifiedWritable))"
         },
         {
-          "command": "konveyor.diffView.applyBlock",
+          "command": "konveyor.diffView.applySelection",
           "group": "primary",
-          "when": "diffEditorModifiedWritable && !diffEditorInlineMode && (diffEditorModifiedUri =~ /^konveyorMemFs\\:.*$/ || diffEditorOriginalUri =~ /^konveyorMemFs\\:.*$/)"
+          "when": "!diffEditorInlineMode && ((diffEditorModifiedUri =~ /^konveyorMemFs\\:.*$/ && diffEditorOriginalWritable) || (diffEditorOriginalUri =~ /^konveyorMemFs\\:.*$/ && diffEditorModifiedWritable))"
         }
       ],
       "diffEditor/gutter/hunk": [
         {
           "command": "konveyor.diffView.applyBlockInline",
           "group": "primary",
-          "when": "diffEditorModifiedWritable && diffEditorInlineMode && (diffEditorModifiedUri =~ /^konveyorMemFs\\:.*$/ || diffEditorOriginalUri =~ /^konveyorMemFs\\:.*$/)"
+          "when": "diffEditorInlineMode && ((diffEditorModifiedUri =~ /^konveyorMemFs\\:.*$/ && diffEditorOriginalWritable) || (diffEditorOriginalUri =~ /^konveyorMemFs\\:.*$/ && diffEditorModifiedWritable))"
         },
         {
           "command": "konveyor.diffView.applyBlock",
           "group": "primary",
-          "when": "diffEditorModifiedWritable && !diffEditorInlineMode && (diffEditorModifiedUri =~ /^konveyorMemFs\\:.*$/ || diffEditorOriginalUri =~ /^konveyorMemFs\\:.*$/)"
+          "when": "!diffEditorInlineMode && ((diffEditorModifiedUri =~ /^konveyorMemFs\\:.*$/ && diffEditorOriginalWritable) || (diffEditorOriginalUri =~ /^konveyorMemFs\\:.*$/ && diffEditorModifiedWritable))"
         }
       ],
       "explorer/context": [

diff --git a/vscode/src/commands.ts b/vscode/src/commands.ts
@@ -355,6 +355,8 @@ const commandsMap: (state: ExtensionState) => {
     "konveyor.reloadLastResolutions": () => reloadLastResolutions(state),
     "konveyor.diffView.applyBlock": applyBlock,
     "konveyor.diffView.applyBlockInline": applyBlock,
+    "konveyor.diffView.applySelection": applyBlock,
+    "konveyor.diffView.applySelectionInline": applyBlock,
   };
 };
 

diff --git a/vscode/src/data/readOnlyStorage.ts b/vscode/src/data/readOnlyStorage.ts
@@ -0,0 +1,17 @@
+import {
+  CancellationToken,
+  Event,
+  ProviderResult,
+  TextDocumentContentProvider,
+  Uri,
+  workspace,
+} from "vscode";
+
+export default class KonveyorReadOnlyProvider implements TextDocumentContentProvider {
+  onDidChange?: Event<Uri> | undefined;
+  provideTextDocumentContent(uri: Uri, _token: CancellationToken): ProviderResult<string> {
+    return workspace.fs
+      .readFile(Uri.from({ ...uri, scheme: "file" }))
+      .then((buffer) => buffer?.toString() ?? "");
+  }
+}
diff --git a/vscode/src/diffView/register.ts b/vscode/src/diffView/register.ts
@@ -2,7 +2,8 @@ import * as vscode from "vscode";
 import { KonveyorTreeDataProvider } from "./fileModel";
 import { Navigation } from "./navigation";
 import { ExtensionState } from "src/extensionState";
-import { KONVEYOR_SCHEME } from "../utilities";
+import { KONVEYOR_READ_ONLY_SCHEME, KONVEYOR_SCHEME } from "../utilities";
+import KonveyorReadOnlyProvider from "../data/readOnlyStorage";
 
 export function registerDiffView({
   extensionContext: context,
@@ -29,4 +30,13 @@ export function registerDiffView({
   provider.onDidChangeTreeData(() => {
     treeView.message = model.message;
   });
+
+  const readOnlyProvider = new KonveyorReadOnlyProvider();
+
+  context.subscriptions.push(
+    vscode.workspace.registerTextDocumentContentProvider(
+      KONVEYOR_READ_ONLY_SCHEME,
+      readOnlyProvider,
+    ),
+  );
 }
diff --git a/vscode/src/diffView/solutionCommands.ts b/vscode/src/diffView/solutionCommands.ts
@@ -1,6 +1,6 @@
 import * as vscode from "vscode";
 import { ExtensionState } from "src/extensionState";
-import { fromRelativeToKonveyor } from "../utilities";
+import { fromRelativeToKonveyor, KONVEYOR_READ_ONLY_SCHEME } from "../utilities";
 import { FileItem, toUri } from "./fileModel";
 
 export const applyAll = async (state: ExtensionState) => {
@@ -31,12 +31,33 @@ export const discardAll = async (state: ExtensionState) => {
   vscode.window.showInformationMessage(`Discarded all resolutions`);
 };
 
-export const viewFix = (uri: vscode.Uri, preserveFocus: boolean = false) =>
+export const viewFix = async (uri: vscode.Uri, preserveFocus: boolean) =>
+  vscode.workspace.getConfiguration("konveyor")?.get("diffEditorType") === "merge"
+    ? viewFixInMergeEditor(uri, preserveFocus)
+    : viewFixInDiffEditor(uri, preserveFocus);
+
+export const viewFixInMergeEditor = async (uri: vscode.Uri, preserveFocus: boolean = false) => {
+  const readOnlyUri = vscode.Uri.from({ ...uri, scheme: KONVEYOR_READ_ONLY_SCHEME });
+  const options = {
+    base: readOnlyUri,
+    input1: { uri: readOnlyUri, title: "Current" },
+    input2: {
+      uri: fromRelativeToKonveyor(vscode.workspace.asRelativePath(uri)),
+      title: "Suggested",
+    },
+    output: uri,
+    options: { preserveFocus },
+  };
+
+  await vscode.commands.executeCommand("_open.mergeEditor", options);
+};
+
+export const viewFixInDiffEditor = async (uri: vscode.Uri, preserveFocus: boolean = false) =>
   vscode.commands.executeCommand(
     "vscode.diff",
     uri,
     fromRelativeToKonveyor(vscode.workspace.asRelativePath(uri)),
-    "Current file <-> Suggested changes",
+    "Current ↔ Suggested",
     {
       preserveFocus,
     },

diff --git a/vscode/src/utilities/constants.ts b/vscode/src/utilities/constants.ts
@@ -1,3 +1,4 @@
 export const KONVEYOR_SCHEME = "konveyorMemFs";
+export const KONVEYOR_READ_ONLY_SCHEME = "konveyorReadOnly";
 export const RULE_SET_DATA_FILE_PREFIX = "analysis";
 export const SOLUTION_DATA_FILE_PREFIX = "solution";