Shows default remote branches in Branches view

eamodio · eamodio · commit 54376304f835 · 2024-12-02T14:58:21.000-05:00
diff --git a/src/git/models/branch.ts b/src/git/models/branch.ts
@@ -38,6 +38,7 @@ export type GitBranchStatus =
 
 export interface BranchSortOptions {
 	current?: boolean;
+	groupByType?: boolean;
 	missingUpstream?: boolean;
 	orderBy?: BranchSorting;
 	openedWorktreesByBranch?: Set<string>;
@@ -311,7 +312,7 @@ export function isOfBranchRefType(branch: GitReference | undefined) {
 }
 
 export function sortBranches(branches: GitBranch[], options?: BranchSortOptions) {
-	options = { current: true, orderBy: configuration.get('sortBranchesBy'), ...options };
+	options = { current: true, groupByType: true, orderBy: configuration.get('sortBranchesBy'), ...options };
 
 	switch (options.orderBy) {
 		case 'date:asc':
@@ -324,7 +325,7 @@ export function sortBranches(branches: GitBranch[], options?: BranchSortOptions)
 						  (options.openedWorktreesByBranch.has(b.id) ? -1 : 1)
 						: 0) ||
 					(a.starred ? -1 : 1) - (b.starred ? -1 : 1) ||
-					(b.remote ? -1 : 1) - (a.remote ? -1 : 1) ||
+					(options.groupByType ? (b.remote ? -1 : 1) - (a.remote ? -1 : 1) : 0) ||
 					(a.date == null ? -1 : a.date.getTime()) - (b.date == null ? -1 : b.date.getTime()) ||
 					sortCompare(a.name, b.name),
 			);
@@ -341,7 +342,7 @@ export function sortBranches(branches: GitBranch[], options?: BranchSortOptions)
 					(a.name === 'main' ? -1 : 1) - (b.name === 'main' ? -1 : 1) ||
 					(a.name === 'master' ? -1 : 1) - (b.name === 'master' ? -1 : 1) ||
 					(a.name === 'develop' ? -1 : 1) - (b.name === 'develop' ? -1 : 1) ||
-					(b.remote ? -1 : 1) - (a.remote ? -1 : 1) ||
+					(options.groupByType ? (b.remote ? -1 : 1) - (a.remote ? -1 : 1) : 0) ||
 					sortCompare(a.name, b.name),
 			);
 		case 'name:desc':
@@ -357,7 +358,7 @@ export function sortBranches(branches: GitBranch[], options?: BranchSortOptions)
 					(a.name === 'main' ? -1 : 1) - (b.name === 'main' ? -1 : 1) ||
 					(a.name === 'master' ? -1 : 1) - (b.name === 'master' ? -1 : 1) ||
 					(a.name === 'develop' ? -1 : 1) - (b.name === 'develop' ? -1 : 1) ||
-					(b.remote ? -1 : 1) - (a.remote ? -1 : 1) ||
+					(options.groupByType ? (b.remote ? -1 : 1) - (a.remote ? -1 : 1) : 0) ||
 					sortCompare(b.name, a.name),
 			);
 		case 'date:desc':
@@ -371,7 +372,7 @@ export function sortBranches(branches: GitBranch[], options?: BranchSortOptions)
 						  (options.openedWorktreesByBranch.has(b.id) ? -1 : 1)
 						: 0) ||
 					(a.starred ? -1 : 1) - (b.starred ? -1 : 1) ||
-					(b.remote ? -1 : 1) - (a.remote ? -1 : 1) ||
+					(options.groupByType ? (b.remote ? -1 : 1) - (a.remote ? -1 : 1) : 0) ||
 					(b.date == null ? -1 : b.date.getTime()) - (a.date == null ? -1 : a.date.getTime()) ||
 					sortCompare(b.name, a.name),
 			);
@@ -414,3 +415,15 @@ export async function getLocalBranchByUpstream(
 
 	return undefined;
 }
+
+export async function getLocalBranchUpstreamNames(branches: PageableResult<GitBranch>): Promise<Set<string>> {
+	const remoteBranches = new Set<string>();
+
+	for await (const branch of branches.values()) {
+		if (!branch.remote && branch.upstream?.name != null) {
+			remoteBranches.add(branch.upstream.name);
+		}
+	}
+
+	return remoteBranches;
+}
diff --git a/src/git/models/remote.ts b/src/git/models/remote.ts
@@ -1,7 +1,7 @@
 import type { ColorTheme } from 'vscode';
 import { Uri, window } from 'vscode';
 import { GlyphChars } from '../../constants';
-import { Container } from '../../container';
+import type { Container } from '../../container';
 import type { HostingIntegration } from '../../plus/integrations/integration';
 import { memoize } from '../../system/decorators/memoize';
 import { equalsIgnoreCase, sortCompare } from '../../system/string';
@@ -25,7 +25,7 @@ export class GitRemote<TProvider extends RemoteProvider | undefined = RemoteProv
 	) {}
 
 	get default() {
-		const defaultRemote = Container.instance.storage.getWorkspace('remote:default');
+		const defaultRemote = this.container.storage.getWorkspace('remote:default');
 		// Check for `this.remoteKey` matches to handle previously saved data
 		return this.name === defaultRemote || this.remoteKey === defaultRemote;
 	}
@@ -90,7 +90,7 @@ export class GitRemote<TProvider extends RemoteProvider | undefined = RemoteProv
 	}
 
 	async setAsDefault(value: boolean = true) {
-		const repository = Container.instance.git.getRepository(this.repoPath);
+		const repository = this.container.git.getRepository(this.repoPath);
 		await repository?.setRemoteAsDefault(this, value);
 	}
 }
diff --git a/src/git/utils/branch-utils.ts b/src/git/utils/branch-utils.ts
@@ -4,7 +4,11 @@ import type { Container } from '../../container';
 import { getIconPathUris } from '../../system/vscode/vscode';
 import type { GitBranch } from '../models/branch';
 
-export function getBranchIconPath(container: Container, branch: GitBranch | undefined): IconPath {
+export function getBranchIconPath(
+	container: Container,
+	branch: GitBranch | undefined,
+	defaultIcon?: ThemeIcon,
+): IconPath {
 	const status = branch?.status;
 	switch (status) {
 		case 'ahead':
@@ -14,6 +18,6 @@ export function getBranchIconPath(container: Container, branch: GitBranch | unde
 		case 'upToDate':
 			return getIconPathUris(container, `icon-branch-synced.svg`);
 		default:
-			return new ThemeIcon('git-branch');
+			return defaultIcon ?? new ThemeIcon('git-branch');
 	}
 }
diff --git a/src/system/paging.ts b/src/system/paging.ts
@@ -3,7 +3,12 @@ import type { PagedResult } from '../git/gitProvider';
 export class PageableResult<T> {
 	private cached: Mutable<PagedResult<T>> | undefined;
 
-	constructor(private readonly fetch: (paging: PagedResult<T>['paging']) => Promise<PagedResult<T>>) {}
+	constructor(
+		private readonly fetch: (paging: PagedResult<T>['paging']) => Promise<PagedResult<T>>,
+		seed?: PagedResult<T>,
+	) {
+		this.cached = seed;
+	}
 
 	async *values(): AsyncIterable<NonNullable<T>> {
 		if (this.cached != null) {
diff --git a/src/views/branchesView.ts b/src/views/branchesView.ts
@@ -83,7 +83,11 @@ export class BranchesViewNode extends RepositoriesSubscribeableNode<BranchesView
 		if (this.children.length === 1) {
 			const [child] = this.children;
 
-			const branches = await child.repo.git.getBranches({ filter: b => !b.remote });
+			const defaultRemote = this.view.container.storage.getWorkspace('remote:default');
+
+			const branches = await child.repo.git.getBranches({
+				filter: b => !b.remote || (defaultRemote != null && b.getRemoteName() === defaultRemote),
+			});
 			if (branches.values.length === 0) {
 				this.view.message = 'No branches could be found.';
 				void child.ensureSubscription();
diff --git a/src/views/nodes/branchNode.ts b/src/views/nodes/branchNode.ts
@@ -423,6 +423,7 @@ export class BranchNode
 		const parts = await getBranchNodeParts(this.view.container, this.branch, this.current, {
 			pendingPullRequest: this.getState('pendingPullRequest'),
 			showAsCommits: this.options.showAsCommits,
+			showRemoteBranchesAsCloud: this.view.type === 'branches',
 			showStatusDecorationOnly: this.options.showStatusDecorationOnly,
 			useBaseNameOnly: !(this.view.config.branches?.layout !== 'tree' || this.compacted || this.avoidCompacting),
 			worktree: this.worktree,
@@ -548,6 +549,7 @@ export async function getBranchNodeParts(
 	options?: {
 		pendingPullRequest?: Promise<PullRequest | undefined> | undefined;
 		showAsCommits?: boolean;
+		showRemoteBranchesAsCloud?: boolean;
 		showStatusDecorationOnly?: boolean;
 		useBaseNameOnly: boolean;
 		worktree?: GitWorktree;
@@ -747,7 +749,13 @@ export async function getBranchNodeParts(
 				  ? new ThemeIcon('git-commit', iconColor)
 				  : options?.worktree != null
 				    ? getWorktreeBranchIconPath(container, branch)
-				    : getBranchIconPath(container, branch),
+				    : getBranchIconPath(
+								container,
+								branch,
+								branch.remote && options?.showRemoteBranchesAsCloud
+									? new ThemeIcon('cloud')
+									: undefined,
+				      ),
 		resourceUri: createViewDecorationUri('branch', {
 			status: localUnpublished ? 'unpublished' : status,
 			current: current,
diff --git a/src/views/nodes/branchesNode.ts b/src/views/nodes/branchesNode.ts
@@ -1,9 +1,12 @@
 import { ThemeIcon, TreeItem, TreeItemCollapsibleState } from 'vscode';
 import { GitUri } from '../../git/gitUri';
+import type { GitBranch } from '../../git/models/branch';
+import { getLocalBranchUpstreamNames } from '../../git/models/branch';
 import type { Repository } from '../../git/models/repository';
 import { getOpenedWorktreesByBranch } from '../../git/models/worktree';
 import { makeHierarchical } from '../../system/array';
 import { debug } from '../../system/decorators/log';
+import { PageableResult } from '../../system/paging';
 import type { ViewsWithBranchesNode } from '../viewBase';
 import { CacheableChildrenViewNode } from './abstract/cacheableChildrenViewNode';
 import type { ViewNode } from './abstract/viewNode';
@@ -35,27 +38,40 @@ export class BranchesNode extends CacheableChildrenViewNode<'branches', ViewsWit
 
 	async getChildren(): Promise<ViewNode[]> {
 		if (this.children == null) {
-			const branches = await this.repo.git.getBranches({
-				// only show local branches
-				filter: b => !b.remote,
+			const defaultRemote = this.view.container.storage.getWorkspace('remote:default');
+
+			const options: Parameters<typeof this.repo.git.getBranches>['0'] = {
+				// only show local branches or remote branches for the default remote
+				filter: b => !b.remote || (defaultRemote != null && b.getRemoteName() === defaultRemote),
 				sort: this.view.config.showCurrentBranchOnTop
 					? {
 							current: true,
+							groupByType: defaultRemote == null,
 							openedWorktreesByBranch: getOpenedWorktreesByBranch(this.context.worktreesByBranch),
 					  }
-					: { current: false },
-			});
-			if (branches.values.length === 0) return [new MessageNode(this.view, this, 'No branches could be found.')];
+					: { current: false, groupByType: defaultRemote == null },
+			};
+
+			const branches = new PageableResult<GitBranch>(p => this.repo.git.getBranches({ ...options, paging: p }));
+
+			let localUpstreamNames: Set<string> | undefined;
+			// Filter out remote branches that have a local branch
+			if (defaultRemote != null) {
+				localUpstreamNames = await getLocalBranchUpstreamNames(branches);
+			}
+
+			const branchNodes: BranchNode[] = [];
 
-			// TODO@eamodio handle paging
-			const branchNodes = branches.values.map(
-				b =>
+			for await (const branch of branches.values()) {
+				if (branch.remote && localUpstreamNames?.has(branch.name)) continue;
+
+				branchNodes.push(
 					new BranchNode(
-						GitUri.fromRepoPath(this.uri.repoPath!, b.ref),
+						GitUri.fromRepoPath(this.uri.repoPath!, branch.ref),
 						this.view,
 						this,
 						this.repo,
-						b,
+						branch,
 						false,
 						{
 							showComparison:
@@ -64,7 +80,10 @@ export class BranchesNode extends CacheableChildrenViewNode<'branches', ViewsWit
 									: this.view.config.showBranchComparison,
 						},
 					),
-			);
+				);
+			}
+
+			if (branchNodes.length === 0) return [new MessageNode(this.view, this, 'No branches could be found.')];
 			if (this.view.config.branches.layout === 'list') return branchNodes;
 
 			const hierarchy = makeHierarchical(

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`import type { ColorTheme } from 'vscode';`
`2`	`2`	`import { Uri, window } from 'vscode';`
`3`	`3`	`import { GlyphChars } from '../../constants';`
`4`		`-import { Container } from '../../container';`
	`4`	`+import type { Container } from '../../container';`
`5`	`5`	`import type { HostingIntegration } from '../../plus/integrations/integration';`
`6`	`6`	`import { memoize } from '../../system/decorators/memoize';`
`7`	`7`	`import { equalsIgnoreCase, sortCompare } from '../../system/string';`
`@@ -25,7 +25,7 @@ export class GitRemote<TProvider extends RemoteProvider \| undefined = RemoteProv`
`25`	`25`	`) {}`
`26`	`26`
`27`	`27`	`get default() {`
`28`		`- const defaultRemote = Container.instance.storage.getWorkspace('remote:default');`
	`28`	`+ const defaultRemote = this.container.storage.getWorkspace('remote:default');`
`29`	`29`	// Check for `this.remoteKey` matches to handle previously saved data
`30`	`30`	`return this.name === defaultRemote \|\| this.remoteKey === defaultRemote;`
`31`	`31`	`}`
`@@ -90,7 +90,7 @@ export class GitRemote<TProvider extends RemoteProvider \| undefined = RemoteProv`
`90`	`90`	`}`
`91`	`91`
`92`	`92`	`async setAsDefault(value: boolean = true) {`
`93`		`- const repository = Container.instance.git.getRepository(this.repoPath);`
	`93`	`+ const repository = this.container.git.getRepository(this.repoPath);`
`94`	`94`	`await repository?.setRemoteAsDefault(this, value);`
`95`	`95`	`}`
`96`	`96`	`}`