Plain text diff

First version using CodeMirror

First good looking

Restructure CSS + improve look and feel

Add gutters

Remove `less` call

Use message in lower case

Rebase on master + comment

Author: Tim Lupo

.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

jupyterlab_git/__init__.py

@@ -12,17 +12,10 @@ def _jupyter_server_extension_paths():
     return [{"module": "jupyterlab_git"}]
 
 
-def _jupyter_nbextension_paths():
-    """
-    Declare the Jupyter notebook extension paths.
-    """
-    return [{"section": "notebook", "dest": "jupyterlab_git"}]
-
-
 def load_jupyter_server_extension(nbapp):
     """
     Load the Jupyter server extension.
     """
-    git = Git(nbapp.web_app.settings.get('server_root_dir'))
+    git = Git(nbapp.web_app.settings['contents_manager'])
     nbapp.web_app.settings["git"] = git
     setup_handlers(nbapp.web_app)

jupyterlab_git/git.py

@@ -64,8 +64,9 @@ class Git:
     A single parent class containing all of the individual git methods in it.
     """
 
-    def __init__(self, root_dir):
-        self.root_dir = os.path.expanduser(root_dir)
+    def __init__(self, contents_manager):
+        self.contents_manager = contents_manager
+        self.root_dir = os.path.realpath(os.path.expanduser(contents_manager.root_dir))
 
     def config(self, top_repo_path, **kwargs):
         """Get or set Git options.
@@ -892,3 +893,58 @@ def _get_tag(self, current_path, commit_sha):
                     error.decode("utf-8"), " ".join(command)
                 )
             )
+
+    def show(self, filename, ref, top_repo_path):
+        """
+        Execute git show<ref:filename> command & return the result.
+        """
+        command = ["git", "show", '{}:{}'.format(ref, filename)]
+        p = subprocess.Popen(
+            command,
+            stdout=PIPE,
+            stderr=PIPE,
+            cwd=top_repo_path
+        )
+        output, error = p.communicate()
+
+        error_messages = map(lambda n: n.lower(), [
+            "fatal: Path '{}' exists on disk, but not in '{}'".format(filename, ref),
+            "fatal: Path '{}' does not exist (neither on disk nor in the index)".format(filename)
+        ])
+        lower_error = error.decode('utf-8').lower()
+        if p.returncode == 0:
+            return output.decode('utf-8')
+        elif any([msg in lower_error for msg in error_messages]):
+            return ""
+        else:
+            raise Exception('Error [{}] occurred while executing [{}] command to retrieve plaintext diff.'.format(
+                error.decode('utf-8'),
+                ' '.join(command)
+            ))
+
+    def get_content(self, filename, top_repo_path):
+        """
+        Get the file content of filename.
+        """
+        relative_repo = os.path.relpath(top_repo_path, self.root_dir)
+        model = self.contents_manager.get(path=os.path.join(relative_repo, filename))
+        return model['content']
+
+    def diff_content(self, filename, prev_ref, curr_ref, top_repo_path):
+        """
+        Collect get content of prev and curr and return.
+        """
+        try:
+            prev_content = self.show(filename, prev_ref["git"], top_repo_path)
+            if "special" in curr_ref:
+                if curr_ref["special"] == "WORKING":
+                    curr_content = self.get_content(filename, top_repo_path)
+                elif curr_ref["special"] == "INDEX":
+                    curr_content = self.show(filename, "", top_repo_path)
+                else:
+                    raise Exception("Error while retrieving plaintext diff, unknown special ref '{}'.".format(curr_ref["specialref"]))
+            else:
+                curr_content = self.show(filename, curr_ref["git"], top_repo_path)
+            return {"prev_content": prev_content, "curr_content": curr_content}
+        except:
+            raise

jupyterlab_git/handlers.py

@@ -2,8 +2,9 @@
 Module with all the individual handlers, which execute git commands and return the results to the frontend.
 """
 import json
+import os
 
-from notebook.utils import url_path_join as ujoin
+from notebook.utils import url_path_join as ujoin, url2path
 from notebook.base.handlers import APIHandler
 
 
@@ -470,6 +471,22 @@ def post(self):
             self.set_status(201)
         self.finish(json.dumps(response))
 
+class GitDiffContentHandler(GitHandler):
+    """
+    Handler for plain text diffs. Uses git show $REF:$FILE
+    Returns `prev_content` and `curr_content` with content of given file.
+    """
+
+    def post(self):
+        cm = self.contents_manager
+        data = self.get_json_body()
+        filename = data["filename"]
+        prev_ref = data["prev_ref"]
+        curr_ref = data["curr_ref"]
+        top_repo_path = os.path.join(cm.root_dir, url2path(data["top_repo_path"]))
+        response = self.git.diff_content(filename, prev_ref, curr_ref, top_repo_path)
+        self.finish(json.dumps(response))
+
 
 class GitServerRootHandler(GitHandler):
 
@@ -509,7 +526,8 @@ def setup_handlers(web_app):
         ("/git/upstream", GitUpstreamHandler),
         ("/git/config", GitConfigHandler),
         ("/git/changed_files", GitChangedFilesHandler),
-        ("/git/server_root", GitServerRootHandler)
+        ("/git/server_root", GitServerRootHandler),
+        ("/git/diffcontent", GitDiffContentHandler)
     ]
 
     # add the baseurl to our paths

package.json

@@ -3,6 +3,7 @@
   "version": "0.10.0",
   "description": "A JupyterLab extension for version control using git",
   "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "style": "style/index.css",
   "license": "BSD-3-Clause",
   "author": "Jupyter Development Team",
@@ -26,7 +27,7 @@
   "files": [
     "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
     "schema/**/*.{json,}",
-    "style/**/*.{css,svg}"
+    "style/**/*.{css,eot,gif,html,jpg,json,png,svg,woff2,ttf}"
   ],
   "sideEffects": [
     "style/*.css"
@@ -49,6 +50,7 @@
   "dependencies": {
     "@jupyterlab/application": "^1.1.0",
     "@jupyterlab/apputils": "^1.1.0",
+    "@jupyterlab/codemirror": "^1.1.0",
     "@jupyterlab/console": "^1.1.0",
     "@jupyterlab/coreutils": "^3.1.0",
     "@jupyterlab/filebrowser": "^1.1.0",
@@ -57,6 +59,7 @@
     "@jupyterlab/terminal": "^1.1.0",
     "@jupyterlab/ui-components": "^1.1.0",
     "@phosphor/widgets": "^1.8.0",
+    "diff-match-patch": "^1.0.4",
     "nbdime": "~5.0.1",
     "react": "~16.8.4",
     "react-dom": "~16.8.4",
@@ -67,6 +70,7 @@
     "@babel/preset-env": "^7.5.0",
     "@jupyterlab/testutils": "^1.1.0",
     "@types/codemirror": "^0.0.79",
+    "@types/diff-match-patch": "^1.0.32",
     "@types/enzyme": "3.1.15",
     "@types/jest": "^24",
     "@types/react": "~16.8.13",
@@ -87,7 +91,10 @@
     "tslint-config-prettier": "1.18.0",
     "tslint-plugin-prettier": "^2.0.0",
     "typescript": "~3.5.1",
-    "typescript-tslint-plugin": "0.3.1"
+    "typescript-tslint-plugin": "^0.5.4"
+  },
+  "peerDependencies": {
+    "codemirror": "^5.0.0"
   },
   "directories": {
     "lib": "lib"

src/components/diff/Diff.tsx

@@ -3,6 +3,7 @@ import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
 import * as React from 'react';
 import { IDiffContext } from './model';
 import { NBDiff } from './NbDiff';
+import { isText, PlainTextDiff } from './PlainTextDiff';
 
 /**
  * A registry which maintains mappings of file extension to diff provider components.
@@ -14,17 +15,30 @@ const DIFF_PROVIDER_REGISTRY: { [key: string]: typeof React.Component } = {
 /**
  * Determines if a given file is supported for diffs.
  *
- * This will be removed when "Plaintext" diffs are supported since that will be used
- * for cases where there is not a dedicated diff provider.
- *
  * @param path the file path
  */
 export function isDiffSupported(path: string): boolean {
-  return PathExt.extname(path).toLocaleLowerCase() in DIFF_PROVIDER_REGISTRY;
+  return (
+    PathExt.extname(path).toLocaleLowerCase() in DIFF_PROVIDER_REGISTRY ||
+    isText(path)
+  );
 }
 
+/** Diff component properties */
 export interface IDiffProps {
+  /**
+   * Path of the file to diff.
+   * It is relative to the git repository root folder
+   */
   path: string;
+  /**
+   * Git respository folder path.
+   * It is relative to the server root.
+   */
+  topRepoPath: string;
+  /**
+   * References to show the diff for.
+   */
   diffContext: IDiffContext;
 }
 
@@ -37,9 +51,9 @@ export function Diff(props: IDiffProps) {
   if (fileExtension in DIFF_PROVIDER_REGISTRY) {
     const DiffProvider = DIFF_PROVIDER_REGISTRY[fileExtension];
     return <DiffProvider {...props} />;
+  } else if (isText(props.path)) {
+    return <PlainTextDiff {...props} />;
   } else {
-    // This will be removed and delegated to a "Plaintext" diff provider for
-    // cases where the file extension does not have a dedicated diff provider.
     console.log(`Diff is not supported for ${fileExtension} files`);
     return null;
   }

src/components/diff/DiffWidget.tsx

@@ -35,10 +35,14 @@ export async function openDiffView(
       mainAreaItem = mainAreaItems.next();
     }
     if (!mainAreaItem) {
-      const relativeFilePath = model.getRelativeFilePath(filePath);
+      const serverRepoPath = model.getRelativeFilePath();
       const nbDiffWidget = ReactWidget.create(
         <RenderMimeProvider value={renderMime}>
-          <Diff path={relativeFilePath} diffContext={diffContext} />
+          <Diff
+            path={filePath}
+            diffContext={diffContext}
+            topRepoPath={serverRepoPath}
+          />
         </RenderMimeProvider>
       );
       nbDiffWidget.id = id;

src/components/diff/NbDiff.tsx

@@ -1,4 +1,4 @@
-import { nbformat } from '@jupyterlab/coreutils';
+import { nbformat, PathExt } from '@jupyterlab/coreutils';
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
 import { ServerConnection } from '@jupyterlab/services/lib/serverconnection';
 import { IDiffEntry } from 'nbdime/lib/diff/diffentries';
@@ -178,7 +178,7 @@ export class NBDiff extends React.Component<IDiffProps, INBDiffState> {
       }
 
       httpGitRequest('/nbdime/api/gitdiff', 'POST', {
-        file_path: this.props.path,
+        file_path: PathExt.join(this.props.topRepoPath, this.props.path),
         ref_local: { git: diffContext.previousRef.gitRef },
         ref_remote: currentRefValue
       }).then((response: Response) => {