Hide diff icon for binary files

Author: fcollonval

jupyterlab_git/git.py

@@ -255,15 +255,36 @@ async def status(self, current_path):
                 "message": my_error,
             }
 
+        # Add attribute `is_binary`
+        command = [  # Compare stage to an empty tree see `_is_binary`
+            "git",
+            "diff",
+            "--numstat",
+            "-z",
+            "--cached",
+            "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
+        ]
+        text_code, text_output, _ = await execute(
+            command, cwd=os.path.join(self.root_dir, current_path),
+        )
+
+        are_binary = dict()
+        if text_code == 0:
+            for line in filter(lambda l: len(l) > 0, strip_and_split(text_output)):
+                diff, name = line.rsplit(maxsplit=1)
+                are_binary[name] = diff.startswith("-\t-")
+        
         result = []
         line_iterable = (line for line in strip_and_split(my_output) if line)
         for line in line_iterable:
+            name = line[3:]
             result.append({
                 "x": line[0],
                 "y": line[1],
-                "to": line[3:],
+                "to": name,
                 # if file was renamed, next line contains original path
-                "from": next(line_iterable) if line[0]=='R' else line[3:]
+                "from": next(line_iterable) if line[0]=='R' else name,
+                "is_binary": are_binary.get(name, None)
             })
         return {"code": code, "files": result}
 
@@ -324,6 +345,18 @@ async def detailed_log(self, selected_hash, current_path):
         if code != 0:
             return {"code": code, "command": " ".join(cmd), "message": my_error}
 
+        # Test for binary file
+        command = ["git", "diff", "--numstat", "-z", "4b825dc642cb6eb9a060e54bf8d69288fbee4904", selected_hash]
+        text_code, text_output, _ = await execute(
+            command, 
+            cwd=os.path.join(self.root_dir, current_path),
+        )
+        are_binary = dict()
+        if text_code == 0:
+            for line in filter(lambda l: len(l) > 0, strip_and_split(text_output)):
+                diff, name = line.rsplit(maxsplit=1)
+                are_binary[name] = diff.startswith("-\t-")
+
         total_insertions = 0
         total_deletions = 0
         result = []
@@ -339,15 +372,18 @@ async def detailed_log(self, selected_hash, current_path):
                 to_path = next(line_iterable)
                 modified_file_name = from_path + " => " + to_path
                 modified_file_path = to_path
+                is_binary = are_binary.get(to_path, None)
             else:
                 modified_file_name = file.split("/")[-1]
                 modified_file_path = file
+                is_binary = are_binary.get(file, None)
 
             result.append({
-                        "modified_file_path": modified_file_path,
-                        "modified_file_name": modified_file_name,
-                        "insertion": insertions,
-                        "deletion": deletions,
+                "modified_file_path": modified_file_path,
+                "modified_file_name": modified_file_name,
+                "insertion": insertions,
+                "deletion": deletions,
+                "is_binary": is_binary
             })
             total_insertions += int(insertions)
             total_deletions += int(deletions)

src/components/FileList.tsx

@@ -71,7 +71,8 @@ export class FileList extends React.Component<IFileListProps, IFileListState> {
               currentRef: { specialRef: 'WORKING' },
               previousRef: { gitRef: 'HEAD' }
             },
-            this.props.renderMime
+            this.props.renderMime,
+            !this.state.selectedFile.is_binary
           );
         }
       });
@@ -89,7 +90,8 @@ export class FileList extends React.Component<IFileListProps, IFileListState> {
               currentRef: { specialRef: 'INDEX' },
               previousRef: { gitRef: 'HEAD' }
             },
-            this.props.renderMime
+            this.props.renderMime,
+            !this.state.selectedFile.is_binary
           );
         }
       });
@@ -342,7 +344,7 @@ export class FileList extends React.Component<IFileListProps, IFileListState> {
               key={file.to}
               actions={
                 <React.Fragment>
-                  {this._createDiffButton(file.to, 'INDEX')}
+                  {this._createDiffButton(file, 'INDEX')}
                   <ActionButton
                     className={hiddenButtonStyle}
                     iconName={'git-remove'}
@@ -405,7 +407,7 @@ export class FileList extends React.Component<IFileListProps, IFileListState> {
                       this.discardChanges(file.to);
                     }}
                   />
-                  {this._createDiffButton(file.to, 'WORKING')}
+                  {this._createDiffButton(file, 'WORKING')}
                   <ActionButton
                     className={hiddenButtonStyle}
                     iconName={'git-add'}
@@ -498,11 +500,11 @@ export class FileList extends React.Component<IFileListProps, IFileListState> {
                     this.discardChanges(file.to);
                   }}
                 />
-                {this._createDiffButton(file.to, 'WORKING')}
+                {this._createDiffButton(file, 'WORKING')}
               </React.Fragment>
             );
           } else if (file.status === 'staged') {
-            actions = this._createDiffButton(file.to, 'INDEX');
+            actions = this._createDiffButton(file, 'INDEX');
           }
 
           return (
@@ -526,28 +528,31 @@ export class FileList extends React.Component<IFileListProps, IFileListState> {
    * @param currentRef the ref to diff against the git 'HEAD' ref
    */
   private _createDiffButton(
-    path: string,
+    file: Git.IStatusFile,
     currentRef: ISpecialRef['specialRef']
   ): JSX.Element {
     return (
-      isDiffSupported(path) && (
+      (isDiffSupported(file.to) || !file.is_binary) && (
         <ActionButton
           className={hiddenButtonStyle}
           iconName={'git-diff'}
           title={'Diff this file'}
           onClick={async () => {
             try {
               await openDiffView(
-                path,
+                file.to,
                 this.props.model,
                 {
                   previousRef: { gitRef: 'HEAD' },
                   currentRef: { specialRef: currentRef }
                 },
-                this.props.renderMime
+                this.props.renderMime,
+                !file.is_binary
               );
             } catch (reason) {
-              console.error(`Fail to open diff view for ${path}.\n${reason}`);
+              console.error(
+                `Fail to open diff view for ${file.to}.\n${reason}`
+              );
             }
           }}
         />

src/components/SinglePastCommitInfo.tsx

@@ -230,7 +230,7 @@ export class SinglePastCommitInfo extends React.Component<
    */
   private _renderFile(file: Git.ICommitModifiedFile): React.ReactElement {
     const path = file.modified_file_path;
-    const flg = isDiffSupported(path);
+    const flg = isDiffSupported(path) || !file.is_binary;
     return (
       <li
         className={commitDetailFileClass}
@@ -330,7 +330,8 @@ export class SinglePastCommitInfo extends React.Component<
               gitRef: self.props.commit.commit
             }
           },
-          self.props.renderMime
+          self.props.renderMime,
+          bool
         );
       } catch (err) {
         console.error(`Failed to open diff view for ${fpath}.\n${err}`);

src/components/diff/Diff.tsx

@@ -3,7 +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';
+import { PlainTextDiff } from './PlainTextDiff';
 
 /**
  * A registry which maintains mappings of file extension to diff provider components.
@@ -18,10 +18,7 @@ const DIFF_PROVIDER_REGISTRY: { [key: string]: typeof React.Component } = {
  * @param path the file path
  */
 export function isDiffSupported(path: string): boolean {
-  return (
-    PathExt.extname(path).toLocaleLowerCase() in DIFF_PROVIDER_REGISTRY ||
-    isText(path)
-  );
+  return PathExt.extname(path).toLocaleLowerCase() in DIFF_PROVIDER_REGISTRY;
 }
 
 /** Diff component properties */
@@ -51,11 +48,14 @@ 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 {
-    console.log(`Diff is not supported for ${fileExtension} files`);
-    return null;
+    // Fallback to plain text diff
+    try {
+      return <PlainTextDiff {...props} />;
+    } catch (error) {
+      console.log(`Unable to render diff view for ${props.path}:\n${error}`);
+      return null;
+    }
   }
 }
 

src/components/diff/DiffWidget.tsx

@@ -15,15 +15,16 @@ import { GitExtension } from '../../model';
  * @param shell The JupyterLab shell instance
  * @param diffContext the context in which the diff is being requested
  * @param renderMime the renderMime registry instance from the
- * @param topRepoPath the Git repo root path.
+ * @param isText Is the file of textual type?
  */
 export async function openDiffView(
   filePath: string,
   model: GitExtension,
   diffContext: IDiffContext,
-  renderMime: IRenderMimeRegistry
+  renderMime: IRenderMimeRegistry,
+  isText = false
 ) {
-  if (isDiffSupported(filePath)) {
+  if (isDiffSupported(filePath) || isText) {
     const id = `nbdiff-${filePath}-${getRefValue(diffContext.currentRef)}`;
     let mainAreaItems = model.shell.widgets('main');
     let mainAreaItem = mainAreaItems.next();

src/components/diff/PlainTextDiff.tsx

@@ -138,12 +138,3 @@ export class PlainTextDiff extends React.Component<
 
   private _mergeViewRef: React.RefObject<HTMLDivElement>;
 }
-
-/**
- * Checks if a given path is supported language
- *
- * @param path the path of the file
- */
-export function isText(path: string): boolean {
-  return Mode.findBest(path) !== undefined;
-}

src/tokens.ts

@@ -374,6 +374,7 @@ export namespace Git {
     y: string;
     to: string;
     from: string;
+    is_binary: boolean | null;
   }
 
   /**
@@ -410,6 +411,7 @@ export namespace Git {
     modified_file_name: string;
     insertion: string;
     deletion: string;
+    is_binary: boolean | null;
   }
 
   /** Interface for GitDetailedLog request result,