Feature 866 - Display Commit Description (jupyterlab#1134)

* test

test

* Removed unecessary commit history from testing

* Changed single quote to double quote

* Function detailed_log now returns commit message. Added additional check
for pytest test_detailed_log. Updated .prej-commit-config.yaml to latest
version of pre-commit from version 20.8b1 to 22.3.0 as commits were
failing using the old version.

* Changed variable name of commit message

* Test Summary

Test Description

* Revert 'Test Summary'

This reverts commit c7ac545

* Modified detailed_log function to also return commit message

The detailed_log function now uses --pretty=%B format to return all the commit info. Also added test case in pytest test_detailed_log.py

* Added additional function to run command(s) to request git log with specific formats.

* Renamed function and added comments to execute_log_command function. Started modify py.test for test_detailed_log.

* Added ability to see entire commit body when viewing history from SinglePastCommitInfo.tsx. Added minor padding to styling in SinglePastCommitInfo.ts padding.

* Update jupyterlab_git/git.py

Co-authored-by: Frédéric Collonval <[email protected]>

* Fixed styling issue with \n by applying 'whiteSpace: pre-wrap' style to the commitBodyClass.

* Fixed git log command to include --pretty=format:%b%x00 and added minor styling changes

* Modified test_detailed_log.py to return commit_body expected response

* Fixed issue with commit_body not removing white spaces correctly

* Update jupyterlab_git/git.py to simplify commit_body output.

Co-authored-by: Frédéric Collonval <[email protected]>

* Fixed issue with commit_body not removing x00 and added additional strip for strip_and_split function to remove new lines.

Co-authored-by: Frédéric Collonval <[email protected]>

Author: iflinda

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: 20.8b1 # Replace by any tag/version: https://github.com/psf/black/tags
+    rev: 22.3.0 # Replace by any tag/version: https://github.com/psf/black/tags
     hooks:
       - id: black
         language_version: python3 # Should be a command that runs python3.6+

jupyterlab_git/git.py

@@ -170,7 +170,7 @@ def strip_and_split(s):
     """strip trailing \x00 and split on \x00
     Useful for parsing output of git commands with -z flag.
     """
-    return s.strip("\x00").split("\x00")
+    return s.strip("\x00").strip("\n").split("\x00")
 
 
 class Git:
@@ -555,19 +555,29 @@ async def detailed_log(self, selected_hash, path):
         Execute git log -1 --numstat --oneline -z command (used to get
         insertions & deletions per file) & return the result.
         """
-        cmd = ["git", "log", "-1", "--numstat", "--oneline", "-z", selected_hash]
+        cmd = [
+            "git",
+            "log",
+            "-1",
+            "--numstat",
+            "--pretty=format:%b%x00",
+            "-z",
+            selected_hash,
+        ]
+
         code, my_output, my_error = await execute(
             cmd,
             cwd=path,
         )
-
         if code != 0:
             return {"code": code, "command": " ".join(cmd), "message": my_error}
 
         total_insertions = 0
         total_deletions = 0
         result = []
-        line_iterable = iter(strip_and_split(my_output)[1:])
+        first_split = my_output.split("\x00", 1)
+        commit_body = first_split[0].strip()
+        line_iterable = iter(strip_and_split(first_split[1].strip()))
         for line in line_iterable:
             is_binary = line.startswith("-\t-\t")
             previous_file_path = ""
@@ -609,6 +619,7 @@ async def detailed_log(self, selected_hash, path):
 
         return {
             "code": code,
+            "commit_body": commit_body,
             "modified_file_note": modified_file_note,
             "modified_files_count": str(len(result)),
             "number_of_insertions": str(total_insertions),

jupyterlab_git/tests/test_detailed_log.py

@@ -13,8 +13,8 @@ async def test_detailed_log():
     with patch("jupyterlab_git.git.execute") as mock_execute:
         # Given
         process_output = [
-            "f29660a (HEAD, origin/feature) Commit message",
-            "10\t3\tnotebook_without_spaces.ipynb",
+            "    Test Description with leading and trailing spaces    ",
+            "\n10\t3\tnotebook_without_spaces.ipynb",
             "11\t4\tNotebook with spaces.ipynb",
             "12\t5\tpath/notebook_without_spaces.ipynb",
             "13\t6\tpath/Notebook with spaces.ipynb",
@@ -31,6 +31,7 @@ async def test_detailed_log():
 
         expected_response = {
             "code": 0,
+            "commit_body": "Test Description with leading and trailing spaces",
             "modified_file_note": "7 files changed, 60 insertions(+), 19 deletions(-)",
             "modified_files_count": "7",
             "number_of_insertions": "60",
@@ -102,7 +103,7 @@ async def test_detailed_log():
                 "log",
                 "-1",
                 "--numstat",
-                "--oneline",
+                "--pretty=format:%b%x00",
                 "-z",
                 "f29660a2472e24164906af8653babeb48e4bf2ab",
             ],

src/components/SinglePastCommitInfo.tsx

@@ -4,7 +4,10 @@ import * as React from 'react';
 import { LoggerContext } from '../logger';
 import { GitExtension } from '../model';
 import { discardIcon, rewindIcon } from '../style/icons';
-import { actionButtonClass } from '../style/SinglePastCommitInfo';
+import {
+  actionButtonClass,
+  commitBodyClass
+} from '../style/SinglePastCommitInfo';
 import { Git } from '../tokens';
 import { ActionButton } from './ActionButton';
 import { CommitDiff } from './CommitDiff';
@@ -58,6 +61,11 @@ export interface ISinglePastCommitInfoState {
    */
   info: string;
 
+  /**
+   * Commit information.
+   */
+  commitBody: string;
+
   /**
    * Number of modified files.
    */
@@ -111,6 +119,7 @@ export class SinglePastCommitInfo extends React.Component<
     super(props);
     this.state = {
       info: '',
+      commitBody: '',
       numFiles: '',
       insertions: '',
       deletions: '',
@@ -130,6 +139,7 @@ export class SinglePastCommitInfo extends React.Component<
 
       this.setState({
         info: log.modified_file_note,
+        commitBody: log.commit_body,
         numFiles: log.modified_files_count,
         insertions: log.number_of_insertions,
         deletions: log.number_of_deletions,
@@ -159,47 +169,50 @@ export class SinglePastCommitInfo extends React.Component<
       return <div>{this.props.trans.__('Error loading commit data')}</div>;
     }
     return (
-      <CommitDiff
-        actions={
-          <>
-            <ActionButton
-              className={actionButtonClass}
-              icon={discardIcon}
-              title={this.props.trans.__(
-                'Revert changes introduced by this commit'
-              )}
-              onClick={this._onRevertClick}
-            />
-            <ActionButton
-              className={actionButtonClass}
-              icon={rewindIcon}
-              title={this.props.trans.__(
-                'Discard changes introduced *after* this commit (hard reset)'
-              )}
-              onClick={this._onResetClick}
-            />
-            <LoggerContext.Consumer>
-              {logger => (
-                <ResetRevertDialog
-                  open={this.state.resetRevertDialog}
-                  action={this.state.resetRevertAction}
-                  model={this.props.model}
-                  logger={logger}
-                  commit={this.props.commit}
-                  onClose={this._onResetRevertDialogClose}
-                  trans={this.props.trans}
-                />
-              )}
-            </LoggerContext.Consumer>
-          </>
-        }
-        numFiles={this.state.numFiles}
-        insertions={this.state.insertions}
-        deletions={this.state.deletions}
-        files={this.state.modifiedFiles}
-        onOpenDiff={this.props.onOpenDiff}
-        trans={this.props.trans}
-      ></CommitDiff>
+      <div>
+        <p className={commitBodyClass}>{this.state.commitBody}</p>
+        <CommitDiff
+          actions={
+            <>
+              <ActionButton
+                className={actionButtonClass}
+                icon={discardIcon}
+                title={this.props.trans.__(
+                  'Revert changes introduced by this commit'
+                )}
+                onClick={this._onRevertClick}
+              />
+              <ActionButton
+                className={actionButtonClass}
+                icon={rewindIcon}
+                title={this.props.trans.__(
+                  'Discard changes introduced *after* this commit (hard reset)'
+                )}
+                onClick={this._onResetClick}
+              />
+              <LoggerContext.Consumer>
+                {logger => (
+                  <ResetRevertDialog
+                    open={this.state.resetRevertDialog}
+                    action={this.state.resetRevertAction}
+                    model={this.props.model}
+                    logger={logger}
+                    commit={this.props.commit}
+                    onClose={this._onResetRevertDialogClose}
+                    trans={this.props.trans}
+                  />
+                )}
+              </LoggerContext.Consumer>
+            </>
+          }
+          numFiles={this.state.numFiles}
+          insertions={this.state.insertions}
+          deletions={this.state.deletions}
+          files={this.state.modifiedFiles}
+          onOpenDiff={this.props.onOpenDiff}
+          trans={this.props.trans}
+        ></CommitDiff>
+      </div>
     );
   }
 

src/style/SinglePastCommitInfo.ts

@@ -5,7 +5,8 @@ export const commitClass = style({
   width: '100%',
   fontSize: '12px',
   marginBottom: '10px',
-  marginTop: '5px'
+  marginTop: '5px',
+  paddingTop: '5px'
 });
 
 export const commitOverviewNumbersClass = style({
@@ -92,3 +93,9 @@ export const fileListClass = style({
 export const actionButtonClass = style({
   float: 'right'
 });
+
+export const commitBodyClass = style({
+  paddingTop: '5px',
+  whiteSpace: 'pre-wrap',
+  wordWrap: 'break-word'
+});

src/tokens.ts

@@ -957,6 +957,7 @@ export namespace Git {
    */
   export interface ISingleCommitFilePathInfo {
     code: number;
+    commit_body?: string;
     modified_file_note?: string;
     modified_files_count?: string;
     number_of_insertions?: string;