SCM - add trace logging to the active repository controller to track down stale status bar items (microsoft#259804)

Author: lszomoru

src/vs/workbench/api/browser/mainThreadSCM.ts

@@ -30,6 +30,7 @@ import { ITextModel } from '../../../editor/common/model.js';
 import { structuralEquals } from '../../../base/common/equals.js';
 import { historyItemBaseRefColor, historyItemRefColor, historyItemRemoteRefColor } from '../../contrib/scm/browser/scmHistory.js';
 import { ColorIdentifier } from '../../../platform/theme/common/colorUtils.js';
+import { ILogService } from '../../../platform/log/common/log.js';
 
 function getIconFromIconDto(iconDto?: UriComponents | { light: UriComponents; dark: UriComponents } | ThemeIcon): URI | { light: URI; dark: URI } | ThemeIcon | undefined {
 	if (iconDto === undefined) {
@@ -312,6 +313,7 @@ class MainThreadSCMProvider implements ISCMProvider {
 		private readonly _rootUri: URI | undefined,
 		private readonly _iconPath: URI | { light: URI; dark: URI } | ThemeIcon | undefined,
 		private readonly _inputBoxTextModel: ITextModel,
+		private readonly _logService: ILogService,
 		private readonly _quickDiffService: IQuickDiffService,
 		private readonly _uriIdentService: IUriIdentityService,
 		private readonly _workspaceContextService: IWorkspaceContextService
@@ -346,6 +348,8 @@ class MainThreadSCMProvider implements ISCMProvider {
 		}
 
 		if (typeof features.statusBarCommands !== 'undefined') {
+			this._logService.trace('[MainThreadSCMProvider][$updateSourceControl] rootUri: ', this.rootUri?.toString());
+			this._logService.trace('[MainThreadSCMProvider][$updateSourceControl] statusBarCommands: ', features.statusBarCommands);
 			this._statusBarCommands.set(features.statusBarCommands, undefined);
 		}
 
@@ -552,6 +556,7 @@ export class MainThreadSCM implements MainThreadSCMShape {
 		@ISCMService private readonly scmService: ISCMService,
 		@ISCMViewService private readonly scmViewService: ISCMViewService,
 		@ILanguageService private readonly languageService: ILanguageService,
+		@ILogService private readonly logService: ILogService,
 		@IModelService private readonly modelService: IModelService,
 		@ITextModelService private readonly textModelService: ITextModelService,
 		@IQuickDiffService private readonly quickDiffService: IQuickDiffService,
@@ -577,7 +582,7 @@ export class MainThreadSCM implements MainThreadSCMShape {
 		this._repositoryBarriers.set(handle, new Barrier());
 
 		const inputBoxTextModelRef = await this.textModelService.createModelReference(URI.revive(inputBoxDocumentUri));
-		const provider = new MainThreadSCMProvider(this._proxy, handle, parentHandle, id, label, rootUri ? URI.revive(rootUri) : undefined, getIconFromIconDto(iconPath), inputBoxTextModelRef.object.textEditorModel, this.quickDiffService, this._uriIdentService, this.workspaceContextService);
+		const provider = new MainThreadSCMProvider(this._proxy, handle, parentHandle, id, label, rootUri ? URI.revive(rootUri) : undefined, getIconFromIconDto(iconPath), inputBoxTextModelRef.object.textEditorModel, this.logService, this.quickDiffService, this._uriIdentService, this.workspaceContextService);
 		const repository = this.scmService.registerSCMProvider(provider);
 		this._repositories.set(handle, repository);
 

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

@@ -24,6 +24,7 @@ import { autorun, autorunWithStore, derived, IObservable, observableFromEvent }
 import { observableConfigValue } from '../../../../platform/observable/common/platformObservableUtils.js';
 import { Command } from '../../../../editor/common/languages.js';
 import { ThemeIcon } from '../../../../base/common/themables.js';
+import { ILogService } from '../../../../platform/log/common/log.js';
 
 const ActiveRepositoryContextKeys = {
 	ActiveRepositoryName: new RawContextKey<string>('scmActiveRepositoryName', ''),
@@ -44,6 +45,7 @@ export class SCMActiveRepositoryController extends Disposable implements IWorkbe
 		@IActivityService private readonly activityService: IActivityService,
 		@IConfigurationService private readonly configurationService: IConfigurationService,
 		@IContextKeyService private readonly contextKeyService: IContextKeyService,
+		@ILogService private readonly logService: ILogService,
 		@ISCMService private readonly scmService: ISCMService,
 		@ISCMViewService private readonly scmViewService: ISCMViewService,
 		@IStatusbarService private readonly statusbarService: IStatusbarService,
@@ -109,11 +111,16 @@ export class SCMActiveRepositoryController extends Disposable implements IWorkbe
 		}));
 
 		this._register(autorunWithStore((reader, store) => {
+			this.logService.trace('[SCMActiveRepositoryController][updateStatusBarAutorun] start');
 			this._repositories.read(reader);
 			const repository = this.scmViewService.activeRepository.read(reader);
 			const commands = repository?.provider.statusBarCommands.read(reader);
 
+			this.logService.trace('[SCMActiveRepositoryController][updateStatusBarAutorun] commands: ', commands);
+			this.logService.trace('[SCMActiveRepositoryController][updateStatusBarAutorun] repository: ', repository?.provider.rootUri?.toString());
+
 			this._updateStatusBar(repository, commands ?? [], store);
+			this.logService.trace('[SCMActiveRepositoryController][updateStatusBarAutorun] end');
 		}));
 
 		this._register(autorun(reader => {
@@ -139,6 +146,7 @@ export class SCMActiveRepositoryController extends Disposable implements IWorkbe
 
 	private _updateStatusBar(repository: ISCMRepository | undefined, commands: readonly Command[], store: DisposableStore): void {
 		if (!repository) {
+			this.logService.trace('[SCMActiveRepositoryController][_updateStatusBar] no active repository');
 			return;
 		}