Git commit amend (#973)

* Add commit amend tokens to file list

* Add amend flag to commit model

* Add commit amend option to right context menu

* Add git amend handler and command

Note that this is using amend without editing the commit message.

* Add push force option

* Formatting

* Update model for amend commits and force push

* Add amend checkbox

* Fix tests

* Changes from code review

* Remove extra command, replace with argument
* Use force-with-lease instead of force
* Minor fixes

* Add test for commitbox

Author: SinaKhalili

jupyterlab_git/git.py

@@ -916,11 +916,18 @@ async def checkout_all(self, path):
             return {"code": code, "command": " ".join(cmd), "message": error}
         return {"code": code}
 
-    async def commit(self, commit_msg, path):
+    async def commit(self, commit_msg, amend, path):
         """
         Execute git commit <filename> command & return the result.
+
+        If the amend argument is true, amend the commit instead of creating a new one.
         """
-        cmd = ["git", "commit", "-m", commit_msg]
+        cmd = ["git", "commit"]
+        if amend:
+            cmd.extend(["--amend", "--no-edit"])
+        else:
+            cmd.extend(["--m", commit_msg])
+
         code, _, error = await execute(cmd, cwd=path)
 
         if code != 0:
@@ -976,11 +983,15 @@ async def pull(self, path, auth=None, cancel_on_conflict=False):
 
         return response
 
-    async def push(self, remote, branch, path, auth=None, set_upstream=False):
+    async def push(
+        self, remote, branch, path, auth=None, set_upstream=False, force=False
+    ):
         """
         Execute `git push $UPSTREAM $BRANCH`. The choice of upstream and branch is up to the caller.
         """
         command = ["git", "push"]
+        if force:
+            command.append("--force-with-lease")
         if set_upstream:
             command.append("--set-upstream")
         command.extend([remote, branch])

jupyterlab_git/handlers.py

@@ -463,7 +463,7 @@ async def post(self, path: str = ""):
 
 class GitCommitHandler(GitHandler):
     """
-    Handler for 'git commit -m <message>'. Commits files.
+    Handler for 'git commit -m <message>' and 'git commit --amend'. Commits files.
     """
 
     @tornado.web.authenticated
@@ -473,7 +473,8 @@ async def post(self, path: str = ""):
         """
         data = self.get_json_body()
         commit_msg = data["commit_msg"]
-        body = await self.git.commit(commit_msg, self.url2localpath(path))
+        amend = data.get("amend", False)
+        body = await self.git.commit(commit_msg, amend, self.url2localpath(path))
 
         if body["code"] != 0:
             self.set_status(500)
@@ -533,11 +534,13 @@ async def post(self, path: str = ""):
         Request body:
         {
             remote?: string # Remote to push to; i.e. <remote_name> or <remote_name>/<branch>
+            force: boolean # Whether or not to force the push
         }
         """
         local_path = self.url2localpath(path)
         data = self.get_json_body()
         known_remote = data.get("remote")
+        force = data.get("force", False)
 
         current_local_branch = await self.git.get_current_branch(local_path)
 
@@ -565,6 +568,7 @@ async def post(self, path: str = ""):
                 local_path,
                 data.get("auth", None),
                 set_upstream,
+                force,
             )
 
         else:
@@ -590,6 +594,7 @@ async def post(self, path: str = ""):
                     local_path,
                     data.get("auth", None),
                     set_upstream=True,
+                    force=force,
                 )
             else:
                 response = {

jupyterlab_git/tests/test_handlers.py

@@ -327,7 +327,7 @@ async def test_push_handler_localbranch(mock_git, jp_fetch, jp_root_dir):
     mock_git.get_current_branch.assert_called_with(str(local_path))
     mock_git.get_upstream_branch.assert_called_with(str(local_path), "localbranch")
     mock_git.push.assert_called_with(
-        ".", "HEAD:localbranch", str(local_path), None, False
+        ".", "HEAD:localbranch", str(local_path), None, False, False
     )
 
     assert response.code == 200
@@ -357,7 +357,12 @@ async def test_push_handler_remotebranch(mock_git, jp_fetch, jp_root_dir):
     mock_git.get_current_branch.assert_called_with(str(local_path))
     mock_git.get_upstream_branch.assert_called_with(str(local_path), "foo/bar")
     mock_git.push.assert_called_with(
-        "origin/something", "HEAD:remote-branch-name", str(local_path), None, False
+        "origin/something",
+        "HEAD:remote-branch-name",
+        str(local_path),
+        None,
+        False,
+        False,
     )
 
     assert response.code == 200
@@ -458,7 +463,7 @@ async def test_push_handler_noupstream_unique_remote(mock_git, jp_fetch, jp_root
     mock_git.config.assert_called_with(str(local_path))
     mock_git.remote_show.assert_called_with(str(local_path))
     mock_git.push.assert_called_with(
-        remote, "foo", str(local_path), None, set_upstream=True
+        remote, "foo", str(local_path), None, set_upstream=True, force=False
     )
 
     assert response.code == 200
@@ -491,7 +496,7 @@ async def test_push_handler_noupstream_pushdefault(mock_git, jp_fetch, jp_root_d
     mock_git.config.assert_called_with(str(local_path))
     mock_git.remote_show.assert_called_with(str(local_path))
     mock_git.push.assert_called_with(
-        remote, "foo", str(local_path), None, set_upstream=True
+        remote, "foo", str(local_path), None, set_upstream=True, force=False
     )
 
     assert response.code == 200
@@ -525,7 +530,9 @@ async def test_push_handler_noupstream_pass_remote_nobranch(
     mock_git.get_upstream_branch.assert_called_with(str(local_path), "foo")
     mock_git.config.assert_not_called()
     mock_git.remote_show.assert_not_called()
-    mock_git.push.assert_called_with(remote, "HEAD:foo", str(local_path), None, True)
+    mock_git.push.assert_called_with(
+        remote, "HEAD:foo", str(local_path), None, True, False
+    )
 
     assert response.code == 200
     payload = json.loads(response.body)
@@ -560,7 +567,7 @@ async def test_push_handler_noupstream_pass_remote_branch(
     mock_git.config.assert_not_called()
     mock_git.remote_show.assert_not_called()
     mock_git.push.assert_called_with(
-        remote, "HEAD:" + remote_branch, str(local_path), None, True
+        remote, "HEAD:" + remote_branch, str(local_path), None, True, False
     )
 
     assert response.code == 200

src/commandsAndMenu.tsx

@@ -63,7 +63,8 @@ interface IGitCloneArgs {
 enum Operation {
   Clone = 'Clone',
   Pull = 'Pull',
-  Push = 'Push'
+  Push = 'Push',
+  ForcePush = 'ForcePush'
 }
 
 interface IFileDiffArgument {
@@ -344,18 +345,21 @@ export function addCommands(
 
   /** Add git push command */
   commands.addCommand(CommandIDs.gitPush, {
-    label: trans.__('Push to Remote'),
+    label: args =>
+      args.force
+        ? trans.__('Push to Remote (Force)')
+        : trans.__('Push to Remote'),
     caption: trans.__('Push code to remote repository'),
     isEnabled: () => gitModel.pathRepository !== null,
-    execute: async () => {
+    execute: async args => {
       logger.log({
         level: Level.RUNNING,
         message: trans.__('Pushing...')
       });
       try {
         const details = await Private.showGitOperationDialog(
           gitModel,
-          Operation.Push,
+          args.force ? Operation.ForcePush : Operation.Push,
           trans
         );
         logger.log({
@@ -932,6 +936,9 @@ export function createGitMenu(
     CommandIDs.gitAddRemote,
     CommandIDs.gitTerminalCommand
   ].forEach(command => {
+    if (command === CommandIDs.gitPush) {
+      menu.addItem({ command, args: { force: true } });
+    }
     menu.addItem({ command });
   });
 
@@ -1163,6 +1170,9 @@ namespace Private {
         case Operation.Push:
           result = await model.push(authentication);
           break;
+        case Operation.ForcePush:
+          result = await model.push(authentication, true);
+          break;
         default:
           result = { code: -1, message: 'Unknown git command' };
           break;

src/components/CommitBox.tsx

@@ -6,7 +6,8 @@ import {
   commitButtonClass,
   commitDescriptionClass,
   commitFormClass,
-  commitSummaryClass
+  commitSummaryClass,
+  commitInputWrapperClass
 } from '../style/CommitBox';
 import { CommandIDs } from '../tokens';
 
@@ -44,6 +45,11 @@ export interface ICommitBoxProps {
    */
   description: string;
 
+  /**
+   * Whether the "amend" checkbox is checked
+   */
+  amend: boolean;
+
   /**
    * Updates the commit message summary.
    *
@@ -58,6 +64,13 @@ export interface ICommitBoxProps {
    */
   setDescription: (description: string) => void;
 
+  /**
+   * Updates the amend checkbox state
+   *
+   * @param amend - amend toggle on/off
+   */
+  setAmend: (amend: boolean) => void;
+
   /**
    * Callback to invoke in order to commit changes.
    *
@@ -114,29 +127,52 @@ export class CommitBox extends React.Component<ICommitBoxProps> {
           className={commitSummaryClass}
           type="text"
           placeholder={summaryPlaceholder}
-          title={this.props.trans.__(
-            'Enter a commit message summary (a single line, preferably less than 50 characters)'
-          )}
+          title={
+            this.props.amend
+              ? this.props.trans.__(
+                  'Amending the commit will re-use the previous commit summary'
+                )
+              : this.props.trans.__(
+                  'Enter a commit message summary (a single line, preferably less than 50 characters)'
+                )
+          }
           value={this.props.summary}
           onChange={this._onSummaryChange}
           onKeyPress={this._onSummaryKeyPress}
+          disabled={this.props.amend}
         />
         <TextareaAutosize
           className={commitDescriptionClass}
           minRows={5}
           placeholder={this.props.trans.__('Description (optional)')}
-          title={this.props.trans.__('Enter a commit message description')}
+          title={
+            this.props.amend
+              ? this.props.trans.__(
+                  'Amending the commit will re-use the previous commit summary'
+                )
+              : this.props.trans.__('Enter a commit message description')
+          }
           value={this.props.description}
           onChange={this._onDescriptionChange}
+          disabled={this.props.amend}
         />
-        <input
-          className={commitButtonClass}
-          type="button"
-          title={title}
-          value={this.props.label}
-          disabled={disabled}
-          onClick={this.props.onCommit}
-        />
+        <div className={commitInputWrapperClass}>
+          <input
+            className={commitButtonClass}
+            type="button"
+            title={title}
+            value={this.props.label}
+            disabled={disabled}
+            onClick={this.props.onCommit}
+          />
+          <input
+            type="checkbox"
+            id="commit-amend"
+            onChange={this._onAmendChange}
+            checked={this.props.amend}
+          />
+          <label htmlFor="commit-amend">Amend</label>
+        </div>
       </form>
     );
   }
@@ -145,6 +181,9 @@ export class CommitBox extends React.Component<ICommitBoxProps> {
    * Whether a commit can be performed (files are staged and summary is not empty).
    */
   private _canCommit(): boolean {
+    if (this.props.amend) {
+      return this.props.hasFiles;
+    }
     return !!(this.props.hasFiles && this.props.summary);
   }
 
@@ -176,6 +215,15 @@ export class CommitBox extends React.Component<ICommitBoxProps> {
     this.props.setSummary(event.target.value);
   };
 
+  /**
+   * Callback invoked when the amend checkbox is toggled
+   *
+   * @param event - event object
+   */
+  private _onAmendChange = (event: any): void => {
+    this.props.setAmend(event.target.checked);
+  };
+
   /**
    * Callback invoked upon a `'keypress'` event when entering a commit message summary.
    *

src/components/FileList.tsx

@@ -73,7 +73,8 @@ export const CONTEXT_COMMANDS: ContextCommands = {
   staged: [
     ContextCommandIDs.gitFileOpen,
     ContextCommandIDs.gitFileUnstage,
-    ContextCommandIDs.gitFileDiff
+    ContextCommandIDs.gitFileDiff,
+    ContextCommandIDs.gitCommitAmendStaged
   ]
 };