Allow switching to other worktrees by switching branches

The upstream worktrees implementation allows automatically switching to another worktree by switching to the branch that was checked out in the worktree.
We had custom logic to check for these branches and disable them, which was carried over from the original implementation. This commit removes those checks and bring us closer to the upstream both in the implementation code and in the user-facing behavior

Author: pol-rivero

app/src/ui/branches/branch-list-item.tsx

@@ -28,9 +28,6 @@ interface IBranchListItemProps {
 
   readonly authorDate: Date | undefined
 
-  /** Name of the worktree where this branch is checked out, if any */
-  readonly worktreeName: string | null
-
   /** When a drag element has landed on a branch that is not current */
   readonly onDropOntoBranch?: (branchName: string) => void
 
@@ -98,10 +95,7 @@ export class BranchListItem extends React.Component<
   }
 
   public render() {
-    const { authorDate, isCurrentBranch, isLocalOnly, name, worktreeName } =
-      this.props
-
-    const isInUseByOtherWorktree = worktreeName !== null && !isCurrentBranch
+    const { authorDate, isCurrentBranch, name, isLocalOnly } = this.props
 
     function getIcon() {
       if (isLocalOnly) {
@@ -112,7 +106,6 @@ export class BranchListItem extends React.Component<
     const className = classNames('branches-list-item', {
       'drop-target': this.state.isDragInProgress,
       'local-only': isLocalOnly,
-      disabled: isInUseByOtherWorktree,
     })
 
     return (

app/src/ui/branches/branch-list.tsx

@@ -1,8 +1,6 @@
 import * as React from 'react'
-import * as Path from 'path'
 
 import { Branch } from '../../models/branch'
-import { WorktreeEntry } from '../../models/worktree'
 
 import { assertNever } from '../../lib/fatal-error'
 
@@ -54,11 +52,6 @@ interface IBranchListProps {
    */
   readonly recentBranches: ReadonlyArray<Branch>
 
-  /**
-   * All worktrees in the repository.
-   */
-  readonly allWorktrees: ReadonlyArray<WorktreeEntry>
-
   /**
    * The sort order for branch lists in the current user preferences.
    */
@@ -195,9 +188,9 @@ export class BranchList extends React.Component<IBranchListProps> {
   private get groups() {
     return this.getGroups(
       this.props.defaultBranch,
+      this.props.currentBranch,
       this.props.allBranches,
       this.props.recentBranches,
-      this.props.allWorktrees,
       this.props.branchSortOrder
     )
   }
@@ -311,20 +304,17 @@ export class BranchList extends React.Component<IBranchListProps> {
   ): JSX.Element | string | null => {
     const { tip, name } = item.branch
 
-    const absoluteDate = formatDate(tip.author.date, {
-      dateStyle: 'full',
-      timeStyle: 'short',
-    })
+    const authorDate = tip.author.date
+
+    const absoluteDate = authorDate
+      ? formatDate(authorDate, {
+          dateStyle: 'full',
+          timeStyle: 'short',
+        })
+      : null
 
-    const otherWorktreeName = this.inUseByOtherWorktreeName(item)
     return (
       <div className="branches-list-item-tooltip list-item-tooltip">
-        {otherWorktreeName && (
-          <div className="label tooltip-warning">
-            This branch cannot be checked out because it is in use by worktree
-            &quot;{otherWorktreeName}&quot;
-          </div>
-        )}
         <div>
           <div className="label">Full Name: </div>
           {name}
@@ -339,17 +329,6 @@ export class BranchList extends React.Component<IBranchListProps> {
     )
   }
 
-  private inUseByOtherWorktreeName(item: IBranchListItem): string | null {
-    const worktreeName = item.worktreeInUse
-      ? Path.basename(item.worktreeInUse.path)
-      : null
-
-    return worktreeName !== null &&
-      this.props.currentBranch?.name !== item.branch.name
-      ? worktreeName
-      : null
-  }
-
   private parseHeader(label: string): BranchGroupIdentifier | null {
     switch (label) {
       case 'default':
@@ -415,16 +394,6 @@ export class BranchList extends React.Component<IBranchListProps> {
   }
 
   private onItemClick = (item: IBranchListItem, source: ClickSource) => {
-    // Don't allow clicking branches that are in use by other worktrees
-    if (item.worktreeInUse !== null) {
-      const currentBranch = this.props.currentBranch
-      const isCurrentBranch =
-        currentBranch !== null && currentBranch.name === item.branch.name
-      if (!isCurrentBranch) {
-        return
-      }
-    }
-
     if (this.props.onItemClick) {
       this.props.onItemClick(item.branch, source)
     }
@@ -434,18 +403,6 @@ export class BranchList extends React.Component<IBranchListProps> {
     selectedItem: IBranchListItem | null,
     source: SelectionSource
   ) => {
-    // Don't allow selecting branches that are in use by other worktrees
-    if (selectedItem?.worktreeInUse !== null) {
-      const currentBranch = this.props.currentBranch
-      const isCurrentBranch =
-        currentBranch !== null &&
-        selectedItem !== null &&
-        currentBranch.name === selectedItem.branch.name
-      if (!isCurrentBranch) {
-        return
-      }
-    }
-
     if (this.props.onSelectionChanged) {
       this.props.onSelectionChanged(
         selectedItem ? selectedItem.branch : null,

app/src/ui/branches/branch-renderer.tsx

@@ -1,5 +1,4 @@
 import * as React from 'react'
-import * as Path from 'path'
 
 import { Branch, BranchType } from '../../models/branch'
 
@@ -20,19 +19,13 @@ export function renderDefaultBranch(
   const currentBranchName = currentBranch ? currentBranch.name : null
   const isLocalOnly =
     branch.type === BranchType.Local && (!branch.upstream || branch.isGone)
-
-  const worktreeName = item.worktreeInUse
-    ? Path.basename(item.worktreeInUse.path)
-    : null
-
   return (
     <BranchListItem
       name={branch.name}
       isCurrentBranch={branch.name === currentBranchName}
       authorDate={branch.tip.author.date}
       isLocalOnly={isLocalOnly}
       matches={matches}
-      worktreeName={worktreeName}
       onDropOntoBranch={onDropOntoBranch}
       onDropOntoCurrentBranch={onDropOntoCurrentBranch}
     />

app/src/ui/branches/branch-select.tsx

@@ -123,7 +123,6 @@ export class BranchSelect extends React.Component<
           defaultBranch={defaultBranch}
           branchSortOrder={this.props.branchSortOrder}
           recentBranches={recentBranches}
-          allWorktrees={[]}
           filterText={filterText}
           onFilterTextChanged={this.onFilterTextChanged}
           selectedBranch={selectedBranch}

app/src/ui/branches/branches-container.tsx

@@ -8,7 +8,6 @@ import {
 import { Branch } from '../../models/branch'
 import { BranchesTab } from '../../models/branches-tab'
 import { PopupType } from '../../models/popup'
-import { WorktreeEntry } from '../../models/worktree'
 
 import { Dispatcher } from '../dispatcher'
 import { FoldoutType } from '../../lib/app-state'
@@ -63,8 +62,6 @@ interface IBranchesContainerProps {
 
   readonly branchSortOrder: BranchSortOrder
 
-  readonly allWorktrees: ReadonlyArray<WorktreeEntry>
-
   /** The pull request associated with the current branch. */
   readonly currentPullRequest: PullRequest | null
 
@@ -282,7 +279,6 @@ export class BranchesContainer extends React.Component<
             allBranches={this.props.allBranches}
             recentBranches={this.props.recentBranches}
             branchSortOrder={this.props.branchSortOrder}
-            allWorktrees={this.props.allWorktrees}
             onItemClick={this.onBranchItemClick}
             filterText={this.state.branchFilterText}
             onFilterTextChanged={this.onBranchFilterTextChanged}

app/src/ui/branches/group-branches.ts

@@ -1,6 +1,5 @@
 import { Branch, BranchType } from '../../models/branch'
 import { BranchSortOrder } from '../../models/branch-sort-order'
-import { WorktreeEntry } from '../../models/worktree'
 import { IFilterListGroup, IFilterListItem } from '../lib/filter-list'
 
 export type BranchGroupIdentifier = 'default' | 'recent' | 'other'
@@ -9,8 +8,6 @@ export interface IBranchListItem extends IFilterListItem {
   readonly text: ReadonlyArray<string>
   readonly id: string
   readonly branch: Branch
-  /** The worktree where this branch is currently checked out, if any */
-  readonly worktreeInUse: WorktreeEntry | null
 }
 
 /**
@@ -21,49 +18,23 @@ export function isLocalOnlyBranch(branch: Branch): boolean {
   return branch.type === BranchType.Local && (!branch.upstream || branch.isGone)
 }
 
-/**
- * Finds the worktree where a given branch is currently checked out.
- * Returns null if the branch is not checked out in any worktree.
- */
-export function findWorktreeForBranch(
-  branchName: string,
-  worktrees: ReadonlyArray<WorktreeEntry>
-): WorktreeEntry | null {
-  for (const worktree of worktrees) {
-    if (worktree.branch === null) {
-      continue
-    }
-    // Extract branch name from refs/heads/branch-name format
-    const wtBranchName = worktree.branch.replace(/^refs\/heads\//, '')
-    if (wtBranchName === branchName) {
-      return worktree
-    }
-  }
-  return null
-}
-
 export function groupBranches(
   defaultBranch: Branch | null,
+  currentBranch: Branch | null,
   allBranches: ReadonlyArray<Branch>,
   recentBranches: ReadonlyArray<Branch>,
-  allWorktrees: ReadonlyArray<WorktreeEntry>,
   sortOrder: BranchSortOrder
 ): ReadonlyArray<IFilterListGroup<IBranchListItem>> {
   const groups = new Array<IFilterListGroup<IBranchListItem>>()
 
   if (defaultBranch) {
-    const worktreeInUse = findWorktreeForBranch(
-      defaultBranch.name,
-      allWorktrees
-    )
     groups.push({
       identifier: 'default',
       items: [
         {
           text: [defaultBranch.name],
           id: defaultBranch.name,
           branch: defaultBranch,
-          worktreeInUse,
         },
       ],
     })
@@ -78,12 +49,10 @@ export function groupBranches(
     const recentBranches = new Array<IBranchListItem>()
 
     for (const branch of recentBranchesWithoutDefault) {
-      const worktreeInUse = findWorktreeForBranch(branch.name, allWorktrees)
       recentBranches.push({
         text: [branch.name],
         id: branch.name,
         branch,
-        worktreeInUse,
       })
       recentBranchNames.add(branch.name)
     }
@@ -107,12 +76,10 @@ export function groupBranches(
   )
 
   const remainingItems = sortedRemainingBranches.map(b => {
-    const worktreeInUse = findWorktreeForBranch(b.name, allWorktrees)
     return {
       text: [b.name],
       id: b.name,
       branch: b,
-      worktreeInUse,
     }
   })
   groups.push({

app/src/ui/history/compare.tsx

@@ -423,7 +423,6 @@ export class CompareSidebar extends React.Component<
         currentBranch={this.props.currentBranch}
         allBranches={branches}
         recentBranches={recentBranches}
-        allWorktrees={[]}
         branchSortOrder={this.props.branchSortOrder}
         filterText={filterText}
         textbox={this.textbox!}

app/src/ui/multi-commit-operation/choose-branch/base-choose-branch-dialog.tsx

@@ -240,7 +240,6 @@ export class ChooseBranchDialog extends React.Component<
             currentBranch={currentBranch}
             defaultBranch={this.props.defaultBranch}
             recentBranches={this.props.recentBranches}
-            allWorktrees={[]}
             branchSortOrder={this.props.branchSortOrder}
             filterText={this.state.filterText}
             onFilterTextChanged={this.onFilterTextChanged}

app/src/ui/multi-commit-operation/choose-branch/choose-target-branch.tsx

@@ -194,7 +194,6 @@ export class ChooseTargetBranchDialog extends React.Component<
             currentBranch={this.props.currentBranch}
             defaultBranch={this.props.defaultBranch}
             recentBranches={this.props.recentBranches}
-            allWorktrees={[]}
             branchSortOrder={this.props.branchSortOrder}
             filterText={this.state.filterText}
             onFilterTextChanged={this.onFilterTextChanged}

app/src/ui/toolbar/branch-dropdown.tsx

@@ -27,14 +27,12 @@ import { TooltipTarget } from '../lib/tooltip'
 import { BranchType, Branch } from '../../models/branch'
 import { PopupType } from '../../models/popup'
 import { generateBranchContextMenuItems } from '../branches/branch-list-item-context-menu'
-import {
-  findWorktreeForBranch,
-  isLocalOnlyBranch,
-} from '../branches/group-branches'
+import { isLocalOnlyBranch } from '../branches/group-branches'
 import { showContextualMenu } from '../../lib/menu-item'
 import { Emoji } from '../../lib/emoji'
 import { BranchSortOrder } from '../../models/branch-sort-order'
 import { enableResizingToolbarButtons } from '../../lib/feature-flag'
+import { WorktreeEntry } from '../../models/worktree'
 
 interface IBranchDropdownProps {
   readonly dispatcher: Dispatcher
@@ -111,7 +109,6 @@ export class BranchDropdown extends React.Component<IBranchDropdownProps> {
         recentBranches={branchesState.recentBranches}
         currentBranch={currentBranch}
         defaultBranch={branchesState.defaultBranch}
-        allWorktrees={repositoryState.worktrees}
         dispatcher={this.props.dispatcher}
         repository={this.props.repository}
         selectedTab={this.props.selectedTab}
@@ -456,7 +453,7 @@ export class BranchDropdown extends React.Component<IBranchDropdownProps> {
     const branches = allBranches.filter(
       branch =>
         isLocalOnlyBranch(branch) &&
-        findWorktreeForBranch(branch.name, worktrees) === null
+        this.findWorktreeForBranch(branch.name, worktrees) === null
     )
 
     if (branches.length === 0) {
@@ -470,6 +467,22 @@ export class BranchDropdown extends React.Component<IBranchDropdownProps> {
     })
   }
 
+  private findWorktreeForBranch(
+    branchName: string,
+    worktrees: ReadonlyArray<WorktreeEntry>
+  ): WorktreeEntry | null {
+    for (const worktree of worktrees) {
+      if (worktree.branch === null) {
+        continue
+      }
+      const wtBranchName = worktree.branch.replace(/^refs\/heads\//, '')
+      if (wtBranchName === branchName) {
+        return worktree
+      }
+    }
+    return null
+  }
+
   private onCheckoutInNewWorktree = (branch: Branch) => {
     this.props.dispatcher.closeFoldout(FoldoutType.Branch)
     this.props.dispatcher.showPopup({