Add logging where we openTextDocument (#6133)

Part of #6109

Author: alexr00

src/github/prComment.ts

@@ -6,6 +6,7 @@
 import * as path from 'path';
 import * as vscode from 'vscode';
 import { IComment } from '../common/comment';
+import Logger from '../common/logger';
 import { DataUri } from '../common/uri';
 import { ALLOWED_USERS, JSDOC_NON_USERS, PHPDOC_NON_USERS } from '../common/user';
 import { stringReplaceAsync } from '../common/utils';
@@ -197,6 +198,7 @@ const SUGGESTION_EXPRESSION = /```suggestion(\u0020*(\r\n|\n))((?<suggestion>[\s
 const IMG_EXPRESSION = /<img .*src=['"](?<src>.+?)['"].*?>/g;
 
 export class GHPRComment extends CommentBase {
+	private static ID = 'GHPRComment';
 	public commentId: string;
 	public timestamp: Date;
 
@@ -379,6 +381,7 @@ ${lineContents}
 	}
 
 	private async replaceBody(body: string | vscode.MarkdownString): Promise<string> {
+		Logger.trace('Replace comment body', GHPRComment.ID);
 		if (body instanceof vscode.MarkdownString) {
 			const permalinkReplaced = await this.replacePermalink(body.value);
 			return this.replaceImg(this.replaceSuggestion(permalinkReplaced));

src/issues/shareProviders.ts

@@ -7,6 +7,7 @@ import * as pathLib from 'path';
 import * as vscode from 'vscode';
 import { Commit, Remote, Repository } from '../api/api';
 import { GitApiImpl } from '../api/api1';
+import Logger from '../common/logger';
 import { fromReviewUri, Schemes } from '../common/uri';
 import { FolderRepositoryManager } from '../github/folderRepositoryManager';
 import { RepositoriesManager } from '../github/repositoriesManager';
@@ -203,12 +204,14 @@ export class GitHubPermalinkShareProvider extends AbstractShareProvider implemen
 }
 
 export class GitHubPermalinkAsMarkdownShareProvider extends GitHubPermalinkShareProvider {
+	private static ID = 'GitHubPermalinkAsMarkdownShareProvider';
 
 	constructor(repositoryManager: RepositoriesManager, gitApi: GitApiImpl) {
 		super(repositoryManager, gitApi, 'githubComPermalinkAsMarkdown', vscode.l10n.t('Copy GitHub Permalink as Markdown'), 12);
 	}
 
 	async provideShare(item: vscode.ShareableItem): Promise<vscode.Uri | string | undefined> {
+		Logger.trace('providing permalink markdown share', GitHubPermalinkAsMarkdownShareProvider.ID);
 		const link = await super.provideShare(item);
 
 		const text = await this.getMarkdownLinkText(item);

src/issues/util.ts

@@ -171,6 +171,7 @@ async function findCodeLinksInIssue(body: string, repositoriesManager: Repositor
 	return findAndModifyString(body, CODE_PERMALINK, async (match: RegExpMatchArray) => {
 		const codeLink = await findCodeLinkLocally(match, repositoriesManager);
 		if (codeLink) {
+			Logger.trace('finding code links in issue', 'Issues');
 			const textDocument = await vscode.workspace.openTextDocument(codeLink?.file);
 			const endingTextDocumentLine = textDocument.lineAt(
 				codeLink.end < textDocument.lineCount ? codeLink.end : textDocument.lineCount - 1,

src/view/pullRequestCommentController.ts

@@ -8,6 +8,7 @@ import { v4 as uuid } from 'uuid';
 import * as vscode from 'vscode';
 import { CommentHandler, registerCommentHandler, unregisterCommentHandler } from '../commentHandlerResolver';
 import { DiffSide, IComment, SubjectType } from '../common/comment';
+import Logger from '../common/logger';
 import { ITelemetry } from '../common/telemetry';
 import { fromPRUri, Schemes } from '../common/uri';
 import { dispose, groupBy } from '../common/utils';
@@ -28,6 +29,7 @@ import {
 import { CommentControllerBase } from './commentControllBase';
 
 export class PullRequestCommentController extends CommentControllerBase implements CommentHandler, CommentReactionHandler {
+	private static ID = 'PullRequestCommentController';
 	private _pendingCommentThreadAdds: GHPRCommentThread[] = [];
 	private _commentHandlerId: string;
 	private _commentThreadCache: { [key: string]: GHPRCommentThread[] } = {};
@@ -113,6 +115,7 @@ export class PullRequestCommentController extends CommentControllerBase implemen
 				if (potentialEditor.editor) {
 					return Promise.resolve(potentialEditor.editor.document);
 				} else {
+					Logger.trace(`Opening text document for PR editor ${potentialEditor.uri.toString()}`, PullRequestCommentController.ID);
 					return vscode.workspace.openTextDocument(potentialEditor.uri);
 				}
 			}

src/view/reviewCommentController.ts

@@ -229,6 +229,7 @@ export class ReviewCommentController extends CommentControllerBase
 			for (const [file, change] of (this._folderRepoManager.activePullRequest?.fileChanges.entries() ?? [])) {
 				if (change.status !== GitChangeType.DELETE) {
 					const uri = vscode.Uri.joinPath(this._folderRepoManager.repository.rootUri, file);
+					Logger.trace(`Prefetching commenting ranges for ${uri.toString()}`, ReviewCommentController.ID);
 					vscode.workspace.openTextDocument(uri);
 				}
 			}