Fetch the resolved file contents during merge conflict

- TODO: update file with resolved conflicts

Author: navn-r

src/commandsAndMenu.tsx

@@ -480,18 +480,37 @@ export function addCommands(
               tooltip: trans.__('Refresh diff widget'),
               className: 'jp-git-diff-refresh'
             });
-            refreshButton.hide();
-            diffWidget.toolbar.addItem('refresh', refreshButton);
 
-            const refresh = () => {
-              refreshButton.show();
-            };
-
-            model.changed.connect(refresh);
-            widget.disposed.connect(() => {
-              model.changed.disconnect(refresh);
+            const resolveButton = new ToolbarButton({
+              label: trans.__('Mark as resolved'),
+              onClick: async () => {
+                try {
+                  const resolvedFile: string = await widget.getResolvedFile();
+                  // TODO update the file without the conflicts, then close the tab
+                  console.log(resolvedFile);
+                } catch (reason) {
+                  console.error(reason);
+                }
+              },
+              tooltip: trans.__('Mark file as resolved'),
+              className: 'jp-git-diff-resolve'
             });
 
+            // Do not allow the user to refresh during merge conflicts
+            if (model.isConflict) {
+              diffWidget.toolbar.addItem('resolve', resolveButton);
+            } else {
+              refreshButton.hide();
+              diffWidget.toolbar.addItem('refresh', refreshButton);
+
+              const refresh = () => {
+                refreshButton.show();
+              };
+
+              model.changed.connect(refresh);
+              widget.disposed.connect(() => model.changed.disconnect(refresh));
+            }
+
             // Load the diff widget
             modelIsLoading.resolve();
             content.addWidget(widget);

src/components/diff/NotebookDiff.ts

@@ -93,7 +93,10 @@ export const createNotebookDiff = async (
 /**
  * NotebookDiff widget
  */
-export class NotebookDiff extends Panel implements Git.Diff.IDiffWidget {
+export class NotebookDiff
+  extends Panel
+  implements Git.Diff.IDiffWidget<string>
+{
   constructor(model: Git.Diff.IModel<string>, renderMime: IRenderMimeRegistry) {
     super();
     const getReady = new PromiseDelegate<void>();
@@ -139,6 +142,10 @@ export class NotebookDiff extends Panel implements Git.Diff.IDiffWidget {
     return this._isReady;
   }
 
+  async getResolvedFile(): Promise<string> {
+    return Promise.resolve('');
+  }
+
   /**
    * Refresh diff
    *

src/components/diff/PlainTextDiff.ts

@@ -4,7 +4,7 @@ import { PromiseDelegate } from '@lumino/coreutils';
 import { Widget } from '@lumino/widgets';
 import { MergeView } from 'codemirror';
 import { Git } from '../../tokens';
-import { mergeView, MergeView as LocalMergeView } from './mergeview';
+import { MergeView as LocalMergeView, mergeView } from './mergeview';
 
 /**
  * Diff callback to be registered for plain-text files.
@@ -25,7 +25,10 @@ export const createPlainTextDiff: Git.Diff.ICallback<string> = async (
 /**
  * Plain Text Diff widget
  */
-export class PlainTextDiff extends Widget implements Git.Diff.IDiffWidget {
+export class PlainTextDiff
+  extends Widget
+  implements Git.Diff.IDiffWidget<string>
+{
   constructor(model: Git.Diff.IModel<string>) {
     super({
       node: PlainTextDiff.createNode(
@@ -72,6 +75,19 @@ export class PlainTextDiff extends Widget implements Git.Diff.IDiffWidget {
     return this._isReady;
   }
 
+  /**
+   * Gets the file contents of a resolved merge conflict,
+   * and rejects if unable to retrieve.
+   */
+  getResolvedFile(): Promise<string> {
+    const value = this._mergeView?.editor().getValue() ?? null;
+    if (value !== null) {
+      return Promise.resolve(value);
+    } else {
+      return Promise.reject('Failed to get a valid file value.');
+    }
+  }
+
   /**
    * Callback to create the diff widget once the widget
    * is attached so CodeMirror get proper size.

src/components/diff/model.ts

@@ -6,7 +6,7 @@ import { Git } from '../../tokens';
  * Base DiffModel class
  */
 export class DiffModel<T> implements IDisposable, Git.Diff.IModel<T> {
-  constructor(props: Omit<Git.Diff.IModel<T>, 'changed'>) {
+  constructor(props: Omit<Git.Diff.IModel<T>, 'changed' | 'isConflict'>) {
     this._challenger = props.challenger;
     this._filename = props.filename;
     this._reference = props.reference;
@@ -84,14 +84,12 @@ export class DiffModel<T> implements IDisposable, Git.Diff.IModel<T> {
   get base(): Git.Diff.IContent<T> | undefined {
     return this._base;
   }
-  set base(v: Git.Diff.IContent<T>) {
-    // Only check changes if base is defined
-    const emitSignal = !this._base || this._didContentChange(this._base, v);
 
-    if (emitSignal) {
-      this._base = v;
-      this._changed.emit({ type: 'base' });
-    }
+  /**
+   * Helper to check if the file is conflicted.
+   */
+  get isConflict(): boolean {
+    return !!this._base;
   }
 
   /**

src/tokens.ts

@@ -469,13 +469,18 @@ export namespace Git {
     /**
      * Diff widget interface
      */
-    export interface IDiffWidget extends Widget {
+    export interface IDiffWidget<T> extends Widget {
       /**
        * Refresh the diff widget
        *
        * Note: Update the content and recompute the diff
        */
       refresh(): Promise<void>;
+      /**
+       * Gets the file contents of a resolved merge conflict,
+       * and rejects if unable to retrieve
+       */
+      getResolvedFile(): Promise<T>;
     }
 
     /**
@@ -489,7 +494,7 @@ export namespace Git {
     export type ICallback<T> = (
       model: IModel<T>,
       toolbar?: Toolbar
-    ) => Promise<IDiffWidget>;
+    ) => Promise<IDiffWidget<T>>;
 
     /**
      * Content and its context for diff
@@ -562,6 +567,10 @@ export namespace Git {
        * Optional base data, used only during merge conflicts
        */
       base?: IContent<T>;
+      /**
+       * Helper to check if the file is conflicted.
+       */
+      isConflict: boolean;
     }
 
     /**

style/diff-common.css

@@ -26,10 +26,18 @@ button.jp-git-diff-refresh {
   border: solid 1px var(--jp-warn-color2);
 }
 
+button.jp-git-diff-resolve {
+  border: solid 1px var(--jp-success-color2);
+}
+
 button.jp-git-diff-refresh .jp-ToolbarButtonComponent-label {
   color: var(--jp-warn-color1);
 }
 
+button.jp-git-diff-resolve .jp-ToolbarButtonComponent-label {
+  color: var(--jp-success-color1);
+}
+
 .jp-git-diff-banner {
   flex: 0 0 auto;
   margin-bottom: 5px;

tests/test-components/DiffModel.spec.tsx

@@ -55,16 +55,4 @@ describe('DiffModel', () => {
 
     await testChallenger;
   });
-
-  it('should emit a signal if base changes', async () => {
-    const testBase = testChangedSignal('base');
-
-    model.base = {
-      content: () => Promise.resolve('content2'),
-      label: 'base2',
-      source: 'base2'
-    };
-
-    await testBase;
-  });
 });