Adopt cool new log filtering convention (#6645)

alexr00 · web-flow · commit a1ad55006500 · 2025-02-07T16:12:15.000+01:00
diff --git a/src/api/api1.ts b/src/api/api1.ts
@@ -74,6 +74,7 @@ export const enum Status {
 }
 
 export class GitApiImpl extends Disposable implements API, IGit {
+	static readonly ID = 'GitAPI';
 	private static _handlePool: number = 0;
 	private _providers = new Map<number, IGit>();
 
@@ -120,13 +121,13 @@ export class GitApiImpl extends Disposable implements API, IGit {
 	}
 
 	registerGitProvider(provider: IGit): vscode.Disposable {
-		Logger.appendLine(`Registering git provider`);
+		Logger.appendLine(`Registering git provider`, GitApiImpl.ID);
 		const handle = this._nextHandle();
 		this._providers.set(handle, provider);
 
 		this._register(provider.onDidCloseRepository(e => this._onDidCloseRepository.fire(e)));
 		this._register(provider.onDidOpenRepository(e => {
-			Logger.appendLine(`Repository ${e.rootUri} has been opened`);
+			Logger.appendLine(`Repository ${e.rootUri} has been opened`, GitApiImpl.ID);
 			this._updateReposContext();
 			this._onDidOpenRepository.fire(e);
 		}));
diff --git a/src/commands.ts b/src/commands.ts
@@ -825,7 +825,7 @@ export function registerCommands(
 				}
 
 				if (!pullRequestModel) {
-					Logger.appendLine('No pull request found.');
+					Logger.appendLine('No pull request found.', logId);
 					return;
 				}
 
diff --git a/src/common/logger.ts b/src/common/logger.ts
@@ -18,13 +18,13 @@ class Log extends Disposable {
 
 	public startPerfMarker(marker: string) {
 		const startTime = performance.now();
-		this._outputChannel.appendLine(`PERF_MARKER> Start ${marker}`);
+		this._outputChannel.appendLine(`[PERF_MARKER] Start ${marker}`);
 		this._activePerfMarkers.set(marker, startTime);
 	}
 
 	public endPerfMarker(marker: string) {
 		const endTime = performance.now();
-		this._outputChannel.appendLine(`PERF_MARKER> End ${marker}: ${endTime - this._activePerfMarkers.get(marker)!} ms`);
+		this._outputChannel.appendLine(`[PERF_MARKER] End ${marker}: ${endTime - this._activePerfMarkers.get(marker)!} ms`);
 		this._activePerfMarkers.delete(marker);
 	}
 
@@ -38,7 +38,7 @@ class Log extends Disposable {
 				message = JSON.stringify(message);
 			}
 		}
-		return component ? `${component}> ${message}` : message;
+		return component ? `[${component}] ${message}` : message;
 	}
 
 	public trace(message: any, component: string) {
@@ -49,7 +49,7 @@ class Log extends Disposable {
 		this._outputChannel.debug(this.logString(message, component));
 	}
 
-	public appendLine(message: any, component?: string) {
+	public appendLine(message: any, component: string) {
 		this._outputChannel.info(this.logString(message, component));
 	}
 
diff --git a/src/common/temporaryState.ts b/src/common/temporaryState.ts
@@ -9,6 +9,7 @@ import Logger from './logger';
 let tempState: TemporaryState | undefined;
 
 export class TemporaryState extends vscode.Disposable {
+	static readonly ID = 'TemporaryState';
 	private readonly SUBPATH = 'temp';
 	private readonly disposables: vscode.Disposable[] = [];
 	private readonly persistInSessionDisposables: vscode.Disposable[] = [];
@@ -86,12 +87,12 @@ export class TemporaryState extends vscode.Disposable {
 			try {
 				await vscode.workspace.fs.delete(tempState.path, { recursive: true });
 			} catch (e) {
-				Logger.appendLine(`TemporaryState> Error in initialization: ${e.message}`);
+				Logger.appendLine(`Error in initialization: ${e.message}`, TemporaryState.ID);
 			}
 			try {
 				await vscode.workspace.fs.createDirectory(tempState.path);
 			} catch (e) {
-				Logger.appendLine(`TemporaryState> Error in initialization: ${e.message}`);
+				Logger.appendLine(`Error in initialization: ${e.message}`, TemporaryState.ID);
 			}
 			context.subscriptions.push(tempState);
 			return tempState;
diff --git a/src/extension.ts b/src/extension.ts
@@ -48,6 +48,8 @@ const ingestionKey = '0c6ae279ed8443289764825290e4f9e2-1a736e7c-1324-4338-be46-f
 
 let telemetry: ExperimentationTelemetry;
 
+const ACTIVATION = 'Activation';
+
 async function init(
 	context: vscode.ExtensionContext,
 	git: GitApiImpl,
@@ -60,7 +62,7 @@ async function init(
 	createPrHelper: CreatePullRequestHelper
 ): Promise<void> {
 	context.subscriptions.push(Logger);
-	Logger.appendLine('Git repository found, initializing review manager and pr tree view.');
+	Logger.appendLine('Git repository found, initializing review manager and pr tree view.', ACTIVATION);
 
 	context.subscriptions.push(credentialStore.onDidChangeSessions(async e => {
 		if (e.provider.id === 'github') {
@@ -163,7 +165,7 @@ async function init(
 	context.subscriptions.push(reviewsManager);
 
 	git.onDidChangeState(() => {
-		Logger.appendLine(`Git initialization state changed: state=${git.state}`);
+		Logger.appendLine(`Git initialization state changed: state=${git.state}`, ACTIVATION);
 		reviewsManager.reviewManagers.forEach(reviewManager => reviewManager.updateState(true));
 	});
 
@@ -172,7 +174,7 @@ async function init(
 			// Make sure we don't already have a folder manager for this repo.
 			const existing = reposManager.folderManagers.find(manager => manager.repository.rootUri.toString() === repo.rootUri.toString());
 			if (existing) {
-				Logger.appendLine(`Repo ${repo.rootUri} has already been setup.`);
+				Logger.appendLine(`Repo ${repo.rootUri} has already been setup.`, ACTIVATION);
 				return;
 			}
 			const newFolderManager = new FolderRepositoryManager(reposManager.folderManagers.length, context, repo, telemetry, git, credentialStore, createPrHelper);
@@ -195,7 +197,7 @@ async function init(
 		addRepo();
 		tree.notificationProvider.refreshOrLaunchPolling();
 		const disposable = repo.state.onDidChange(() => {
-			Logger.appendLine(`Repo state for ${repo.rootUri} changed.`);
+			Logger.appendLine(`Repo state for ${repo.rootUri} changed.`, ACTIVATION);
 			addRepo();
 			disposable.dispose();
 		});
@@ -410,9 +412,9 @@ async function deferredActivate(context: vscode.ExtensionContext, apiImpl: GitAp
 	const prTree = new PullRequestsTreeDataProvider(telemetry, context, reposManager);
 	context.subscriptions.push(prTree);
 	context.subscriptions.push(credentialStore.onDidGetSession(() => prTree.refresh(undefined, true)));
-	Logger.appendLine('Looking for git repository');
+	Logger.appendLine('Looking for git repository', ACTIVATION);
 	const repositories = apiImpl.repositories;
-	Logger.appendLine(`Found ${repositories.length} repositories during activation`);
+	Logger.appendLine(`Found ${repositories.length} repositories during activation`, ACTIVATION);
 	const createPrHelper = new CreatePullRequestHelper();
 	context.subscriptions.push(createPrHelper);
 
diff --git a/src/github/folderRepositoryManager.ts b/src/github/folderRepositoryManager.ts
@@ -419,9 +419,9 @@ export class FolderRepositoryManager extends Disposable {
 
 		if (activeRemotes.length) {
 			await vscode.commands.executeCommand('setContext', 'github:hasGitHubRemotes', true);
-			Logger.appendLine(`Found GitHub remote for folder ${this.repository.rootUri.fsPath}`);
+			Logger.appendLine(`Found GitHub remote for folder ${this.repository.rootUri.fsPath}`, this.id);
 		} else {
-			Logger.appendLine(`No GitHub remotes found for folder ${this.repository.rootUri.fsPath}`);
+			Logger.appendLine(`No GitHub remotes found for folder ${this.repository.rootUri.fsPath}`, this.id);
 		}
 
 		return activeRemotes;
@@ -463,7 +463,7 @@ export class FolderRepositoryManager extends Disposable {
 
 	private async doUpdateRepositories(silent: boolean): Promise<boolean> {
 		if (this._git.state === 'uninitialized') {
-			Logger.appendLine('Cannot updates repositories as git is uninitialized');
+			Logger.appendLine('Cannot updates repositories as git is uninitialized', this.id);
 
 			return false;
 		}
@@ -601,7 +601,7 @@ export class FolderRepositoryManager extends Disposable {
 				}
 			}
 		} catch (e) {
-			Logger.appendLine(`Missing upstream check failed: ${e}`);
+			Logger.appendLine(`Missing upstream check failed: ${e}`, this.id);
 			// ignore
 		}
 		return false;
@@ -697,7 +697,7 @@ export class FolderRepositoryManager extends Disposable {
 		}
 
 		if (this._mentionableUsers) {
-			Logger.appendLine('Using in-memory cached mentionable users.');
+			Logger.appendLine('Using in-memory cached mentionable users.', this.id);
 			return this._mentionableUsers;
 		}
 
@@ -717,7 +717,7 @@ export class FolderRepositoryManager extends Disposable {
 		}
 
 		if (this._assignableUsers) {
-			Logger.appendLine('Using in-memory cached assignable users.');
+			Logger.appendLine('Using in-memory cached assignable users.', this.id);
 			return this._assignableUsers;
 		}
 
@@ -754,7 +754,7 @@ export class FolderRepositoryManager extends Disposable {
 		}
 
 		if (this._teamReviewers) {
-			Logger.appendLine('Using in-memory cached team reviewers.');
+			Logger.appendLine('Using in-memory cached team reviewers.', this.id);
 			return this._teamReviewers;
 		}
 
diff --git a/src/github/notifications.ts b/src/github/notifications.ts
@@ -283,9 +283,9 @@ export class NotificationProvider extends Disposable {
 		if (pollTimeSuggested !== this._pollingDuration) {
 			this._pollingDuration = pollTimeSuggested;
 			if (this._pollingHandler && NotificationProvider.isPRNotificationsOn()) {
-				Logger.appendLine('Notifications: Clearing interval');
+				Logger.appendLine('Notifications: Clearing interval', NotificationProvider.ID);
 				clearInterval(this._pollingHandler);
-				Logger.appendLine(`Notifications: Starting new polling interval with ${this._pollingDuration}`);
+				Logger.appendLine(`Notifications: Starting new polling interval with ${this._pollingDuration}`, NotificationProvider.ID);
 				this.startPolling();
 			}
 		}
diff --git a/src/github/repositoriesManager.ts b/src/github/repositoriesManager.ts
@@ -196,7 +196,7 @@ export class RepositoriesManager extends Disposable {
 		if (enterprise) {
 			const remoteToUse = getEnterpriseUri()?.toString() ?? (enterpriseRemotes.length ? enterpriseRemotes[0].normalizedHost : (unknownRemotes.length ? unknownRemotes[0].normalizedHost : undefined));
 			if (enterpriseRemotes.length === 0 && unknownRemotes.length === 0) {
-				Logger.appendLine(`Enterprise login selected, but no possible enterprise remotes discovered (${dotComRemotes.length} .com)`);
+				Logger.appendLine(`Enterprise login selected, but no possible enterprise remotes discovered (${dotComRemotes.length} .com)`, RepositoriesManager.ID);
 			}
 			if (remoteToUse) {
 				const promptResult = await vscode.window.showInformationMessage(vscode.l10n.t('Would you like to set up GitHub Pull Requests and Issues to authenticate with the enterprise server {0}?', remoteToUse),
diff --git a/src/view/reviewManager.ts b/src/view/reviewManager.ts
@@ -368,7 +368,7 @@ export class ReviewManager extends Disposable {
 		const { url, branchName, remoteName } = await this.getUpstreamUrlAndName(this._repository.state.HEAD!);
 		const metadataFromGithub = await this._folderRepoManager.getMatchingPullRequestMetadataFromGitHub(branch, remoteName, url, branchName);
 		if (metadataFromGithub) {
-			Logger.appendLine(`Found matching pull request metadata on GitHub for current branch ${branch.name}. Repo: ${metadataFromGithub.owner}/${metadataFromGithub.repositoryName} PR: ${metadataFromGithub.prNumber}`);
+			Logger.appendLine(`Found matching pull request metadata on GitHub for current branch ${branch.name}. Repo: ${metadataFromGithub.owner}/${metadataFromGithub.repositoryName} PR: ${metadataFromGithub.prNumber}`, this.id);
 			await PullRequestGitHelper.associateBranchWithPullRequest(
 				this._repository,
 				metadataFromGithub.model,

Original file line number	Diff line number	Diff line change
`@@ -825,7 +825,7 @@ export function registerCommands(`
`825`	`825`	`}`
`826`	`826`
`827`	`827`	`if (!pullRequestModel) {`
`828`		`- Logger.appendLine('No pull request found.');`
	`828`	`+ Logger.appendLine('No pull request found.', logId);`
`829`	`829`	`return;`
`830`	`830`	`}`
`831`	`831`
Original file line number	Diff line number	Diff line change
`@@ -18,13 +18,13 @@ class Log extends Disposable {`
`18`	`18`
`19`	`19`	`public startPerfMarker(marker: string) {`
`20`	`20`	`const startTime = performance.now();`
`21`		- this._outputChannel.appendLine(`PERF_MARKER> Start ${marker}`);
	`21`	+ this._outputChannel.appendLine(`[PERF_MARKER] Start ${marker}`);
`22`	`22`	`this._activePerfMarkers.set(marker, startTime);`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`public endPerfMarker(marker: string) {`
`26`	`26`	`const endTime = performance.now();`
`27`		- this._outputChannel.appendLine(`PERF_MARKER> End ${marker}: ${endTime - this._activePerfMarkers.get(marker)!} ms`);
	`27`	+ this._outputChannel.appendLine(`[PERF_MARKER] End ${marker}: ${endTime - this._activePerfMarkers.get(marker)!} ms`);
`28`	`28`	`this._activePerfMarkers.delete(marker);`
`29`	`29`	`}`
`30`	`30`
`@@ -38,7 +38,7 @@ class Log extends Disposable {`
`38`	`38`	`message = JSON.stringify(message);`
`39`	`39`	`}`
`40`	`40`	`}`
`41`		- return component ? `${component}> ${message}` : message;
	`41`	+ return component ? `[${component}] ${message}` : message;
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`public trace(message: any, component: string) {`
`@@ -49,7 +49,7 @@ class Log extends Disposable {`
`49`	`49`	`this._outputChannel.debug(this.logString(message, component));`
`50`	`50`	`}`
`51`	`51`
`52`		`- public appendLine(message: any, component?: string) {`
	`52`	`+ public appendLine(message: any, component: string) {`
`53`	`53`	`this._outputChannel.info(this.logString(message, component));`
`54`	`54`	`}`
`55`	`55`
Original file line number	Diff line number	Diff line change
`@@ -419,9 +419,9 @@ export class FolderRepositoryManager extends Disposable {`
`419`	`419`
`420`	`420`	`if (activeRemotes.length) {`
`421`	`421`	`await vscode.commands.executeCommand('setContext', 'github:hasGitHubRemotes', true);`
`422`		- Logger.appendLine(`Found GitHub remote for folder ${this.repository.rootUri.fsPath}`);
	`422`	+ Logger.appendLine(`Found GitHub remote for folder ${this.repository.rootUri.fsPath}`, this.id);
`423`	`423`	`} else {`
`424`		- Logger.appendLine(`No GitHub remotes found for folder ${this.repository.rootUri.fsPath}`);
	`424`	+ Logger.appendLine(`No GitHub remotes found for folder ${this.repository.rootUri.fsPath}`, this.id);
`425`	`425`	`}`
`426`	`426`
`427`	`427`	`return activeRemotes;`
`@@ -463,7 +463,7 @@ export class FolderRepositoryManager extends Disposable {`
`463`	`463`
`464`	`464`	`private async doUpdateRepositories(silent: boolean): Promise<boolean> {`
`465`	`465`	`if (this._git.state === 'uninitialized') {`
`466`		`- Logger.appendLine('Cannot updates repositories as git is uninitialized');`
	`466`	`+ Logger.appendLine('Cannot updates repositories as git is uninitialized', this.id);`
`467`	`467`
`468`	`468`	`return false;`
`469`	`469`	`}`
`@@ -601,7 +601,7 @@ export class FolderRepositoryManager extends Disposable {`
`601`	`601`	`}`
`602`	`602`	`}`
`603`	`603`	`} catch (e) {`
`604`		- Logger.appendLine(`Missing upstream check failed: ${e}`);
	`604`	+ Logger.appendLine(`Missing upstream check failed: ${e}`, this.id);
`605`	`605`	`// ignore`
`606`	`606`	`}`
`607`	`607`	`return false;`
`@@ -697,7 +697,7 @@ export class FolderRepositoryManager extends Disposable {`
`697`	`697`	`}`
`698`	`698`
`699`	`699`	`if (this._mentionableUsers) {`
`700`		`- Logger.appendLine('Using in-memory cached mentionable users.');`
	`700`	`+ Logger.appendLine('Using in-memory cached mentionable users.', this.id);`
`701`	`701`	`return this._mentionableUsers;`
`702`	`702`	`}`
`703`	`703`
`@@ -717,7 +717,7 @@ export class FolderRepositoryManager extends Disposable {`
`717`	`717`	`}`
`718`	`718`
`719`	`719`	`if (this._assignableUsers) {`
`720`		`- Logger.appendLine('Using in-memory cached assignable users.');`
	`720`	`+ Logger.appendLine('Using in-memory cached assignable users.', this.id);`
`721`	`721`	`return this._assignableUsers;`
`722`	`722`	`}`
`723`	`723`
`@@ -754,7 +754,7 @@ export class FolderRepositoryManager extends Disposable {`
`754`	`754`	`}`
`755`	`755`
`756`	`756`	`if (this._teamReviewers) {`
`757`		`- Logger.appendLine('Using in-memory cached team reviewers.');`
	`757`	`+ Logger.appendLine('Using in-memory cached team reviewers.', this.id);`
`758`	`758`	`return this._teamReviewers;`
`759`	`759`	`}`
`760`	`760`
Original file line number	Diff line number	Diff line change
`@@ -283,9 +283,9 @@ export class NotificationProvider extends Disposable {`
`283`	`283`	`if (pollTimeSuggested !== this._pollingDuration) {`
`284`	`284`	`this._pollingDuration = pollTimeSuggested;`
`285`	`285`	`if (this._pollingHandler && NotificationProvider.isPRNotificationsOn()) {`
`286`		`- Logger.appendLine('Notifications: Clearing interval');`
	`286`	`+ Logger.appendLine('Notifications: Clearing interval', NotificationProvider.ID);`
`287`	`287`	`clearInterval(this._pollingHandler);`
`288`		- Logger.appendLine(`Notifications: Starting new polling interval with ${this._pollingDuration}`);
	`288`	+ Logger.appendLine(`Notifications: Starting new polling interval with ${this._pollingDuration}`, NotificationProvider.ID);
`289`	`289`	`this.startPolling();`
`290`	`290`	`}`
`291`	`291`	`}`
Original file line number	Diff line number	Diff line change
`@@ -196,7 +196,7 @@ export class RepositoriesManager extends Disposable {`
`196`	`196`	`if (enterprise) {`
`197`	`197`	`const remoteToUse = getEnterpriseUri()?.toString() ?? (enterpriseRemotes.length ? enterpriseRemotes[0].normalizedHost : (unknownRemotes.length ? unknownRemotes[0].normalizedHost : undefined));`
`198`	`198`	`if (enterpriseRemotes.length === 0 && unknownRemotes.length === 0) {`
`199`		- Logger.appendLine(`Enterprise login selected, but no possible enterprise remotes discovered (${dotComRemotes.length} .com)`);
	`199`	+ Logger.appendLine(`Enterprise login selected, but no possible enterprise remotes discovered (${dotComRemotes.length} .com)`, RepositoriesManager.ID);
`200`	`200`	`}`
`201`	`201`	`if (remoteToUse) {`
`202`	`202`	`const promptResult = await vscode.window.showInformationMessage(vscode.l10n.t('Would you like to set up GitHub Pull Requests and Issues to authenticate with the enterprise server {0}?', remoteToUse),`