Merge pull request #816 from fcollonval/fcollonval/issue308

Delete local branch

Author: ianhi

jupyterlab_git/git.py

@@ -497,6 +497,17 @@ async def branch(self, current_path):
             "current_branch": heads["current_branch"],
         }
 
+    async def branch_delete(self, current_path, branch):
+        """Execute 'git branch -D <branchname>'"""
+        cmd = ["git", "branch", "-D", branch]
+        code, _, error = await execute(
+            cmd, cwd=os.path.join(self.root_dir, current_path)
+        )
+        if code != 0:
+            return {"code": code, "command": " ".join(cmd), "message": error}
+        else:
+            return {"code": code}
+
     async def branch_heads(self, current_path):
         """
         Execute 'git for-each-ref' command on refs/heads & return the result.

jupyterlab_git/handlers.py

@@ -234,6 +234,31 @@ async def post(self):
         self.finish(json.dumps(result))
 
 
+class GitBranchDeleteHandler(GitHandler):
+    """
+    Handler for 'git branch -D <branch>'
+    """
+
+    @web.authenticated
+    async def post(self):
+        """
+        POST request handler, delete branch in current repository.
+
+        Body: {
+            "current_path": Git repository path relatively to the server root,
+            "branch": Branch name to be deleted
+        }
+        """
+        data = self.get_json_body()
+        result = await self.git.branch_delete(data["current_path"], data["branch"])
+
+        if result["code"] != 0:
+            self.set_status(500)
+            self.finish(json.dumps(result))
+        else:
+            self.set_status(204)
+
+
 class GitAddHandler(GitHandler):
     """
     Handler for git add <filename>'.
@@ -747,6 +772,7 @@ def setup_handlers(web_app):
         ("/git/add_all_untracked", GitAddAllUntrackedHandler),
         ("/git/all_history", GitAllHistoryHandler),
         ("/git/branch", GitBranchHandler),
+        ("/git/branch/delete", GitBranchDeleteHandler),
         ("/git/changed_files", GitChangedFilesHandler),
         ("/git/checkout", GitCheckoutHandler),
         ("/git/clone", GitCloneHandler),

package.json

@@ -21,7 +21,7 @@
     "clean:slate": "jlpm clean:more && jlpm clean:labextension && rimraf node_modules",
     "contributors:generate": "jlpm run all-contributors generate",
     "lint": "eslint . --ext .ts,.tsx --fix",
-    "test": "jest --no-cache",
+    "test": "jest",
     "eslint-check": "eslint . --ext .ts,.tsx",
     "prepare": "jlpm run build",
     "watch": "tsc -w"

src/components/BranchMenu.tsx

@@ -6,8 +6,10 @@ import * as React from 'react';
 import { FixedSizeList, ListChildComponentProps } from 'react-window';
 import { classes } from 'typestyle';
 import { Logger } from '../logger';
+import { hiddenButtonStyle } from '../style/ActionButtonStyle';
 import {
   activeListItemClass,
+  nameClass,
   filterClass,
   filterClearClass,
   filterInputClass,
@@ -17,8 +19,9 @@ import {
   newBranchButtonClass,
   wrapperClass
 } from '../style/BranchMenu';
-import { branchIcon } from '../style/icons';
+import { branchIcon, trashIcon } from '../style/icons';
 import { Git, IGitExtension, Level } from '../tokens';
+import { ActionButton } from './ActionButton';
 import { NewBranchDialog } from './NewBranchDialog';
 
 const CHANGES_ERR_MSG =
@@ -254,7 +257,18 @@ export class BranchMenu extends React.Component<
         style={style}
       >
         <branchIcon.react className={listItemIconClass} tag="span" />
-        {branch.name}
+        <span className={nameClass}>{branch.name}</span>
+        {!branch.is_remote_branch && !isActive && (
+          <ActionButton
+            className={hiddenButtonStyle}
+            icon={trashIcon}
+            title={'Delete this branch locally'}
+            onClick={(event: React.MouseEvent) => {
+              event.stopPropagation();
+              this._onDeleteBranch(branch.name);
+            }}
+          />
+        )}
       </ListItem>
     );
   };
@@ -297,6 +311,34 @@ export class BranchMenu extends React.Component<
     });
   };
 
+  /**
+   * Callback on delete branch name button
+   *
+   * @param branchName Branch name
+   */
+  private _onDeleteBranch = async (branchName: string): Promise<void> => {
+    const acknowledgement = await showDialog<void>({
+      title: 'Delete branch',
+      body: (
+        <p>
+          Are you sure you want to permanently delete the branch{' '}
+          <b>{branchName}</b>?
+          <br />
+          This action cannot be undone.
+        </p>
+      ),
+      buttons: [Dialog.cancelButton(), Dialog.warnButton({ label: 'Delete' })]
+    });
+    if (acknowledgement.button.accept) {
+      try {
+        await this.props.model.deleteBranch(branchName);
+        await this.props.model.refreshBranch();
+      } catch (error) {
+        console.error(`Failed to delete branch ${branchName}`, error);
+      }
+    }
+  };
+
   /**
    * Callback invoked upon clicking a button to create a new branch.
    *

src/components/TagMenu.tsx

@@ -6,6 +6,7 @@ import * as React from 'react';
 import { FixedSizeList, ListChildComponentProps } from 'react-window';
 import { Logger } from '../logger';
 import {
+  nameClass,
   filterClass,
   filterClearClass,
   filterInputClass,
@@ -241,7 +242,7 @@ export class TagMenu extends React.Component<ITagMenuProps, ITagMenuState> {
         style={style}
       >
         <tagIcon.react className={listItemIconClass} tag="span" />
-        {tag}
+        <span className={nameClass}>{tag}</span>
       </ListItem>
     );
   };

src/model.ts

@@ -486,15 +486,23 @@ export class GitExtension implements IGitExtension {
   }
 
   /**
-   * Dispose of model resources.
+   * Delete a branch
+   *
+   * @param branchName Branch name
+   * @returns promise which resolves when the branch has been deleted.
+   *
+   * @throws {Git.NotInRepository} If the current path is not a Git repository
+   * @throws {Git.GitResponseError} If the server response is not ok
+   * @throws {ServerConnection.NetworkError} If the request cannot be made
    */
-  dispose(): void {
-    if (this.isDisposed) {
-      return;
-    }
-    this._isDisposed = true;
-    this._poll.dispose();
-    Signal.clearData(this);
+  async deleteBranch(branchName: string): Promise<void> {
+    const path = await this._getPathRespository();
+    await this._taskHandler.execute<void>('git:branch:delete', async () => {
+      return await requestAPI<void>('branch/delete', 'POST', {
+        current_path: path,
+        branch: branchName
+      });
+    });
   }
 
   /**
@@ -530,6 +538,18 @@ export class GitExtension implements IGitExtension {
     return data;
   }
 
+  /**
+   * Dispose of model resources.
+   */
+  dispose(): void {
+    if (this.isDisposed) {
+      return;
+    }
+    this._isDisposed = true;
+    this._poll.dispose();
+    Signal.clearData(this);
+  }
+
   /**
    * Ensure a .gitignore file exists
    *

src/style/BranchMenu.ts

@@ -1,4 +1,12 @@
 import { style } from 'typestyle';
+import { showButtonOnHover } from './ActionButtonStyle';
+
+export const nameClass = style({
+  flex: '1 1 auto',
+  textOverflow: 'ellipsis',
+  overflow: 'hidden',
+  whiteSpace: 'nowrap'
+});
 
 export const wrapperClass = style({
   marginTop: '6px',
@@ -105,11 +113,12 @@ export const newBranchButtonClass = style({
   }
 });
 
-export const listItemClass = style({
-  paddingTop: '4px!important',
-  paddingBottom: '4px!important',
-  paddingLeft: '11px!important'
-});
+export const listItemClass = style(
+  {
+    padding: '4px 11px!important'
+  },
+  showButtonOnHover
+);
 
 export const activeListItemClass = style({
   color: 'white!important',

src/style/icons.ts

@@ -16,6 +16,7 @@ import pushSvg from '../../style/icons/push.svg';
 import removeSvg from '../../style/icons/remove.svg';
 import rewindSvg from '../../style/icons/rewind.svg';
 import tagSvg from '../../style/icons/tag.svg';
+import trashSvg from '../../style/icons/trash.svg';
 
 export const gitIcon = new LabIcon({ name: 'git', svgstr: gitSvg });
 export const addIcon = new LabIcon({
@@ -74,3 +75,7 @@ export const tagIcon = new LabIcon({
   name: 'git:tag',
   svgstr: tagSvg
 });
+export const trashIcon = new LabIcon({
+  name: 'git:trash',
+  svgstr: trashSvg
+});

src/tokens.ts

@@ -206,6 +206,18 @@ export interface IGitExtension extends IDisposable {
    */
   config(options?: JSONObject): Promise<JSONObject | void>;
 
+  /**
+   * Delete a branch
+   *
+   * @param branchName Branch name
+   * @returns promise which resolves when the branch has been deleted.
+   *
+   * @throws {Git.NotInRepository} If the current path is not a Git repository
+   * @throws {Git.GitResponseError} If the server response is not ok
+   * @throws {ServerConnection.NetworkError} If the request cannot be made
+   */
+  deleteBranch(branchName: string): Promise<void>;
+
   /**
    * Fetch commit information.
    *