SCM - repositories view improvements (#279190)

* SCM - save/restore repositories tree view stage

* SCM - automatically expand repository if there is only one

Author: lszomoru

src/vs/workbench/contrib/scm/browser/scmRepositoriesViewPane.ts

@@ -42,8 +42,9 @@ import { URI } from '../../../../base/common/uri.js';
 import { basename } from '../../../../base/common/resources.js';
 import { ICompressibleTreeRenderer } from '../../../../base/browser/ui/tree/objectTree.js';
 import { ICompressedTreeNode } from '../../../../base/browser/ui/tree/compressedObjectTreeModel.js';
-import { ITreeCompressionDelegate } from '../../../../base/browser/ui/tree/asyncDataTree.js';
+import { IAsyncDataTreeViewState, ITreeCompressionDelegate } from '../../../../base/browser/ui/tree/asyncDataTree.js';
 import { Codicon } from '../../../../base/common/codicons.js';
+import { IStorageService, StorageScope, StorageTarget } from '../../../../platform/storage/common/storage.js';
 
 type TreeElement = ISCMRepository | SCMArtifactGroupTreeElement | SCMArtifactTreeElement | IResourceNode<SCMArtifactTreeElement, SCMArtifactGroupTreeElement>;
 
@@ -394,13 +395,18 @@ export class SCMRepositoriesViewPane extends ViewPane {
 		@IConfigurationService configurationService: IConfigurationService,
 		@IOpenerService openerService: IOpenerService,
 		@IThemeService themeService: IThemeService,
-		@IHoverService hoverService: IHoverService
+		@IHoverService hoverService: IHoverService,
+		@IStorageService private readonly storageService: IStorageService
 	) {
 		super({ ...options, titleMenuId: MenuId.SCMSourceControlTitle }, keybindingService, contextMenuService, configurationService, contextKeyService, viewDescriptorService, instantiationService, openerService, themeService, hoverService);
 
 		this.visibleCountObs = observableConfigValue('scm.repositories.visible', 10, this.configurationService);
 		this.providerCountBadgeObs = observableConfigValue<'hidden' | 'auto' | 'visible'>('scm.providerCountBadge', 'hidden', this.configurationService);
 
+		this.storageService.onWillSaveState(() => {
+			this.storeTreeViewState();
+		}, this, this._store);
+
 		this._register(this.updateChildrenThrottler);
 	}
 
@@ -416,7 +422,8 @@ export class SCMRepositoriesViewPane extends ViewPane {
 			treeContainer.classList.toggle('auto-provider-counts', providerCountBadge === 'auto');
 		}));
 
-		this.createTree(treeContainer);
+		const viewState = this.loadTreeViewState();
+		this.createTree(treeContainer, viewState);
 
 		this.onDidChangeBodyVisibility(async visible => {
 			if (!visible) {
@@ -426,7 +433,7 @@ export class SCMRepositoriesViewPane extends ViewPane {
 
 			this.treeOperationSequencer.queue(async () => {
 				// Initial rendering
-				await this.tree.setInput(this.scmViewService);
+				await this.tree.setInput(this.scmViewService, viewState);
 
 				// scm.repositories.visible setting
 				this.visibilityDisposables.add(autorun(reader => {
@@ -461,6 +468,17 @@ export class SCMRepositoriesViewPane extends ViewPane {
 				for (const repository of this.scmService.repositories) {
 					this.onDidAddRepository(repository);
 				}
+
+				// Expand repository if there is only one
+				this.visibilityDisposables.add(autorun(async reader => {
+					const explorerEnabledConfig = this.scmViewService.explorerEnabledConfig.read(reader);
+					const didFinishLoadingRepositories = this.scmViewService.didFinishLoadingRepositories.read(reader);
+
+					if (viewState === undefined && explorerEnabledConfig && didFinishLoadingRepositories && this.scmViewService.repositories.length === 1) {
+						await this.treeOperationSequencer.queue(() =>
+							this.tree.expand(this.scmViewService.repositories[0]));
+					}
+				}));
 			});
 		}, this, this._store);
 	}
@@ -475,7 +493,7 @@ export class SCMRepositoriesViewPane extends ViewPane {
 		this.tree.domFocus();
 	}
 
-	private createTree(container: HTMLElement): void {
+	private createTree(container: HTMLElement, viewState?: IAsyncDataTreeViewState): void {
 		this.treeIdentityProvider = new RepositoryTreeIdentityProvider();
 		this.treeDataSource = this.instantiationService.createInstance(RepositoryTreeDataSource);
 		this._register(this.treeDataSource);
@@ -504,7 +522,10 @@ export class SCMRepositoriesViewPane extends ViewPane {
 					}
 
 					// Explorer mode
-					if (isSCMArtifactNode(e)) {
+					if (viewState?.expanded && (isSCMRepository(e) || isSCMArtifactGroupTreeElement(e) || isSCMArtifactTreeElement(e))) {
+						// Only expand repositories/artifact groups/artifacts that were expanded before
+						return viewState.expanded.indexOf(this.treeIdentityProvider.getId(e)) === -1;
+					} else if (isSCMArtifactNode(e)) {
 						// Only expand artifact folders as they are compressed by default
 						return !(e.childrenCount === 1 && Iterable.first(e.children)?.element === undefined);
 					} else {
@@ -773,6 +794,26 @@ export class SCMRepositoriesViewPane extends ViewPane {
 			});
 	}
 
+	private loadTreeViewState(): IAsyncDataTreeViewState | undefined {
+		const storageViewState = this.storageService.get('scm.repositoriesViewState', StorageScope.WORKSPACE);
+		if (!storageViewState) {
+			return undefined;
+		}
+
+		try {
+			const treeViewState = JSON.parse(storageViewState);
+			return treeViewState;
+		} catch {
+			return undefined;
+		}
+	}
+
+	private storeTreeViewState(): void {
+		if (this.tree) {
+			this.storageService.store('scm.repositoriesViewState', JSON.stringify(this.tree.getViewState()), StorageScope.WORKSPACE, StorageTarget.MACHINE);
+		}
+	}
+
 	override dispose(): void {
 		this.visibilityDisposables.dispose();
 		super.dispose();

src/vs/workbench/contrib/scm/browser/scmViewService.ts

@@ -116,7 +116,6 @@ export class SCMViewService implements ISCMViewService {
 	readonly graphShowIncomingChangesConfig: IObservable<boolean>;
 	readonly graphShowOutgoingChangesConfig: IObservable<boolean>;
 
-	private didFinishLoading: boolean = false;
 	private didSelectRepository: boolean = false;
 	private previousState: ISCMViewServiceState | undefined;
 	private readonly disposables = new DisposableStore();
@@ -127,6 +126,8 @@ export class SCMViewService implements ISCMViewService {
 		return this._repositories.map(r => r.repository);
 	}
 
+	readonly didFinishLoadingRepositories = observableValue<boolean>(this, false);
+
 	get visibleRepositories(): ISCMRepository[] {
 		// In order to match the legacy behaviour, when the repositories are sorted by discovery time,
 		// the visible repositories are sorted by the selection index instead of the discovery time.
@@ -339,12 +340,12 @@ export class SCMViewService implements ISCMViewService {
 		// or during a profile switch.
 		extensionService.onWillStop(() => {
 			this.onWillSaveState();
-			this.didFinishLoading = false;
+			this.didFinishLoadingRepositories.set(false, undefined);
 		}, this, this.disposables);
 	}
 
 	private onDidAddRepository(repository: ISCMRepository): void {
-		if (!this.didFinishLoading) {
+		if (!this.didFinishLoadingRepositories.get()) {
 			this.eventuallyFinishLoading();
 		}
 
@@ -354,7 +355,7 @@ export class SCMViewService implements ISCMViewService {
 
 		let removed: Iterable<ISCMRepository> = Iterable.empty();
 
-		if (this.previousState && !this.didFinishLoading) {
+		if (this.previousState && !this.didFinishLoadingRepositories.get()) {
 			const index = this.previousState.all.indexOf(getProviderStorageKey(repository.provider));
 
 			if (index === -1) {
@@ -421,7 +422,7 @@ export class SCMViewService implements ISCMViewService {
 	}
 
 	private onDidRemoveRepository(repository: ISCMRepository): void {
-		if (!this.didFinishLoading) {
+		if (!this.didFinishLoadingRepositories.get()) {
 			this.eventuallyFinishLoading();
 		}
 
@@ -562,7 +563,8 @@ export class SCMViewService implements ISCMViewService {
 	}
 
 	private onWillSaveState(): void {
-		if (!this.didFinishLoading) { // don't remember state, if the workbench didn't really finish loading
+		if (!this.didFinishLoadingRepositories.get()) {
+			// Don't remember state, if the workbench didn't really finish loading
 			return;
 		}
 
@@ -579,11 +581,11 @@ export class SCMViewService implements ISCMViewService {
 	}
 
 	private finishLoading(): void {
-		if (this.didFinishLoading) {
+		if (this.didFinishLoadingRepositories.get()) {
 			return;
 		}
 
-		this.didFinishLoading = true;
+		this.didFinishLoadingRepositories.set(true, undefined);
 	}
 
 	dispose(): void {

src/vs/workbench/contrib/scm/common/scm.ts

@@ -237,6 +237,7 @@ export interface ISCMViewService {
 
 	repositories: ISCMRepository[];
 	readonly onDidChangeRepositories: Event<ISCMViewVisibleRepositoryChangeEvent>;
+	readonly didFinishLoadingRepositories: IObservable<boolean>;
 
 	visibleRepositories: readonly ISCMRepository[];
 	readonly onDidChangeVisibleRepositories: Event<ISCMViewVisibleRepositoryChangeEvent>;