Branch list is not updated after a branch is deleted (#1096)

* Branch list is not updated after a branch is deleted
Fixes #833

* Fix unit test and extend interface

Author: fcollonval

src/components/BranchMenu.tsx

@@ -284,9 +284,9 @@ export class BranchMenu extends React.Component<
               className={hiddenButtonStyle}
               icon={trashIcon}
               title={this.props.trans.__('Delete this branch locally')}
-              onClick={(event: React.MouseEvent) => {
+              onClick={async (event: React.MouseEvent) => {
                 event.stopPropagation();
-                this._onDeleteBranch(branch.name);
+                await this._onDeleteBranch(branch.name);
               }}
             />
             <ActionButton

src/components/GitPanel.tsx

@@ -186,8 +186,11 @@ export class GitPanel extends React.Component<IGitPanelProps, IGitPanelState> {
         nCommitsBehind: model.status.behind
       });
     }, this);
+    model.branchesChanged.connect(async () => {
+      await this.refreshBranches();
+    }, this);
     model.headChanged.connect(async () => {
-      await this.refreshBranch();
+      await this.refreshCurrentBranch();
       if (this.state.tab === 1) {
         this.refreshHistory();
       }
@@ -215,11 +218,16 @@ export class GitPanel extends React.Component<IGitPanelProps, IGitPanelState> {
     Signal.clearData(this);
   }
 
-  refreshBranch = async (): Promise<void> => {
+  refreshBranches = async (): Promise<void> => {
+    this.setState({
+      branches: this.props.model.branches
+    });
+  };
+
+  refreshCurrentBranch = async (): Promise<void> => {
     const { currentBranch } = this.props.model;
 
     this.setState({
-      branches: this.props.model.branches,
       currentBranch: currentBranch ? currentBranch.name : 'master'
     });
   };
@@ -246,7 +254,7 @@ export class GitPanel extends React.Component<IGitPanelProps, IGitPanelState> {
    */
   refreshView = async (): Promise<void> => {
     if (this.props.model.pathRepository !== null) {
-      await this.refreshBranch();
+      await this.refreshBranches();
       await this.refreshHistory();
     }
   };

src/model.ts

@@ -2,7 +2,7 @@ import { IChangedArgs, PathExt, URLExt } from '@jupyterlab/coreutils';
 import { IDocumentManager } from '@jupyterlab/docmanager';
 import { DocumentRegistry } from '@jupyterlab/docregistry';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
-import { JSONObject } from '@lumino/coreutils';
+import { JSONExt, JSONObject } from '@lumino/coreutils';
 import { Poll } from '@lumino/polling';
 import { ISignal, Signal } from '@lumino/signaling';
 import { requestAPI } from './git';
@@ -206,6 +206,13 @@ export class GitExtension implements IGitExtension {
     return this._status;
   }
 
+  /**
+   * A signal emitted when the branches of the Git repository changes.
+   */
+  get branchesChanged(): ISignal<IGitExtension, void> {
+    return this._branchesChanged;
+  }
+
   /**
    * A signal emitted when the `HEAD` of the Git repository changes.
    */
@@ -912,7 +919,12 @@ export class GitExtension implements IGitExtension {
           this._currentBranch.top_commit !== data.current_branch.top_commit;
       }
 
-      this._branches = data.branches;
+      const branchesChanged = !JSONExt.deepEqual(
+        this._branches as any,
+        (data.branches ?? []) as any
+      );
+
+      this._branches = data.branches ?? [];
       this._currentBranch = data.current_branch;
       if (this._currentBranch) {
         // Set up the marker obj for the current (valid) repo/branch combination
@@ -921,6 +933,9 @@ export class GitExtension implements IGitExtension {
       if (headChanged) {
         this._headChanged.emit();
       }
+      if (branchesChanged) {
+        this._branchesChanged.emit();
+      }
 
       // Start fetch remotes if the repository has remote branches
       const hasRemote = this._branches.some(branch => branch.is_remote_branch);
@@ -930,13 +945,17 @@ export class GitExtension implements IGitExtension {
         this._fetchPoll.stop();
       }
     } catch (error) {
+      const branchesChanged = this._branches.length > 0;
       const headChanged = this._currentBranch !== null;
       this._branches = [];
       this._currentBranch = null;
       this._fetchPoll.stop();
       if (headChanged) {
         this._headChanged.emit();
       }
+      if (branchesChanged) {
+        this._branchesChanged.emit();
+      }
 
       if (!(error instanceof Git.NotInRepository)) {
         throw error;
@@ -1610,6 +1629,7 @@ export class GitExtension implements IGitExtension {
   private _selectedHistoryFile: Git.IStatusFile | null = null;
   private _hasDirtyStagedFiles = false;
 
+  private _branchesChanged = new Signal<IGitExtension, void>(this);
   private _headChanged = new Signal<IGitExtension, void>(this);
   private _markChanged = new Signal<IGitExtension, void>(this);
   private _selectedHistoryFileChanged = new Signal<

src/tokens.ts

@@ -24,6 +24,11 @@ export interface IGitExtension extends IDisposable {
    */
   currentBranch: Git.IBranch;
 
+  /**
+   * A signal emitted when the branches of the Git repository changes.
+   */
+  readonly branchesChanged: ISignal<IGitExtension, void>;
+
   /**
    * A signal emitted when the `HEAD` of the Git repository changes.
    */

tests/test-components/GitPanel.spec.tsx

@@ -233,6 +233,9 @@ describe('GitPanel', () => {
       } as any;
       props.model = {
         branches: [],
+        branchesChanged: {
+          connect: jest.fn()
+        },        
         headChanged: {
           connect: jest.fn()
         },