Add logs for building the tree (#3444)

Author: alexr00

src/common/logger.ts

@@ -8,6 +8,7 @@ const enum LogLevel {
 
 const SETTINGS_NAMESPACE = 'githubPullRequests';
 const LOG_LEVEL_SETTING = 'logLevel';
+export const PR_TREE = 'PullRequestTree';
 
 class Log {
 	private _outputChannel: vscode.OutputChannel;

src/view/prChangesTreeDataProvider.ts

@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import * as vscode from 'vscode';
-import Logger from '../common/logger';
+import Logger, { PR_TREE } from '../common/logger';
 import { FILE_LIST_LAYOUT } from '../common/settingKeys';
 import { FolderRepositoryManager, SETTINGS_NAMESPACE } from '../github/folderRepositoryManager';
 import { PullRequestModel } from '../github/pullRequestModel';
@@ -73,9 +73,11 @@ export class PullRequestChangesTreeDataProvider extends vscode.Disposable implem
 		reviewModel: ReviewModel,
 		shouldReveal: boolean,
 	) {
+		Logger.appendLine(`Adding PR #${pullRequestModel.number} to tree`, PR_TREE);
 		if (this._pullRequestManagerMap.has(pullRequestManager)) {
 			const existingNode = this._pullRequestManagerMap.get(pullRequestManager);
 			if (existingNode && (existingNode.pullRequestModel === pullRequestModel)) {
+				Logger.appendLine(`PR #${pullRequestModel.number} already exists in tree`, PR_TREE);
 				return;
 			} else {
 				existingNode?.dispose();
@@ -100,6 +102,8 @@ export class PullRequestChangesTreeDataProvider extends vscode.Disposable implem
 
 	async removePrFromView(pullRequestManager: FolderRepositoryManager) {
 		const oldPR = this._pullRequestManagerMap.has(pullRequestManager) ? this._pullRequestManagerMap.get(pullRequestManager) : undefined;
+		Logger.appendLine(`Removing PR #${oldPR?.pullRequestModel.number} from tree`, PR_TREE);
+
 		oldPR?.dispose();
 		this._pullRequestManagerMap.delete(pullRequestManager);
 		this.updateViewTitle();
@@ -132,7 +136,7 @@ export class PullRequestChangesTreeDataProvider extends vscode.Disposable implem
 		}
 	}
 
-	async getChildren(element?: GitFileChangeNode): Promise<TreeNode[]> {
+	async getChildren(element?: TreeNode): Promise<TreeNode[]> {
 		if (!element) {
 			const result: TreeNode[] = [];
 			if (this._pullRequestManagerMap.size >= 1) {

src/view/treeNodes/commitsCategoryNode.ts

@@ -4,6 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import * as vscode from 'vscode';
+import Logger, { PR_TREE } from '../../common/logger';
 import { FolderRepositoryManager } from '../../github/folderRepositoryManager';
 import { PullRequestModel } from '../../github/pullRequestModel';
 import { CommitNode } from './commitNode';
@@ -27,8 +28,14 @@ export class CommitsNode extends TreeNode implements vscode.TreeItem {
 		this.collapsibleState = vscode.TreeItemCollapsibleState.Collapsed;
 
 		this.childrenDisposables = [];
-		this.childrenDisposables.push(this._pr.onDidChangeReviewThreads(() => this.refresh(this)));
-		this.childrenDisposables.push(this._pr.onDidChangeComments(() => this.refresh(this)));
+		this.childrenDisposables.push(this._pr.onDidChangeReviewThreads(() => {
+			Logger.appendLine(`Review threads have changed, refreshing Commits node`, PR_TREE);
+			this.refresh(this);
+		}));
+		this.childrenDisposables.push(this._pr.onDidChangeComments(() => {
+			Logger.appendLine(`Comments have changed, refreshing Commits node`, PR_TREE);
+			this.refresh(this);
+		}));
 	}
 
 	getTreeItem(): vscode.TreeItem {
@@ -37,10 +44,12 @@ export class CommitsNode extends TreeNode implements vscode.TreeItem {
 
 	async getChildren(): Promise<TreeNode[]> {
 		try {
+			Logger.appendLine(`Getting children for Commits node`, PR_TREE);
 			const commits = await this._pr.getCommits();
 			const commitNodes = commits.map(
 				(commit, index) => new CommitNode(this, this._folderRepoManager, this._pr, commit, index === commits.length - 1),
 			);
+			Logger.appendLine(`Got all children for Commits node`, PR_TREE);
 			return Promise.resolve(commitNodes);
 		} catch (e) {
 			return Promise.resolve([]);

src/view/treeNodes/filesCategoryNode.ts

@@ -4,6 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import * as vscode from 'vscode';
+import Logger, { PR_TREE } from '../../common/logger';
 import { PullRequestModel } from '../../github/pullRequestModel';
 import { ReviewModel } from '../reviewModel';
 import { DirectoryTreeNode } from './directoryTreeNode';
@@ -22,16 +23,26 @@ export class FilesCategoryNode extends TreeNode implements vscode.TreeItem {
 		super();
 		this.collapsibleState = vscode.TreeItemCollapsibleState.Expanded;
 		this.childrenDisposables = [];
-		this.childrenDisposables.push(this._reviewModel.onDidChangeLocalFileChanges(() => this.refresh(this)));
-		this.childrenDisposables.push(_pullRequestModel.onDidChangeReviewThreads(() => this.refresh(this)));
-		this.childrenDisposables.push(_pullRequestModel.onDidChangeComments(() => this.refresh(this)));
+		this.childrenDisposables.push(this._reviewModel.onDidChangeLocalFileChanges(() => {
+			Logger.appendLine(`Local files have changed, refreshing Files node`, PR_TREE);
+			this.refresh(this);
+		}));
+		this.childrenDisposables.push(_pullRequestModel.onDidChangeReviewThreads(() => {
+			Logger.appendLine(`Review threads have changed, refreshing Files node`, PR_TREE);
+			this.refresh(this);
+		}));
+		this.childrenDisposables.push(_pullRequestModel.onDidChangeComments(() => {
+			Logger.appendLine(`Comments have changed, refreshing Files node`, PR_TREE);
+			this.refresh(this);
+		}));
 	}
 
 	getTreeItem(): vscode.TreeItem {
 		return this;
 	}
 
 	async getChildren(): Promise<TreeNode[]> {
+		Logger.appendLine(`Getting children for Files node`, PR_TREE);
 		if (this._reviewModel.localFileChanges.length === 0) {
 			// Provide loading feedback until we get the files.
 			return new Promise<TreeNode[]>(resolve => {
@@ -60,6 +71,7 @@ export class FilesCategoryNode extends TreeNode implements vscode.TreeItem {
 		} else {
 			nodes = this._reviewModel.localFileChanges;
 		}
+		Logger.appendLine(`Got all children for Files node`, PR_TREE);
 		return Promise.resolve(nodes);
 	}
 }

src/view/treeNodes/repositoryChangesNode.ts

@@ -4,6 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import * as vscode from 'vscode';
+import Logger, { PR_TREE } from '../../common/logger';
 import { FolderRepositoryManager } from '../../github/folderRepositoryManager';
 import { PullRequestModel } from '../../github/pullRequestModel';
 import { ReviewModel } from '../reviewModel';
@@ -61,6 +62,7 @@ export class RepositoryChangesNode extends DescriptionNode implements vscode.Tre
 
 	async getChildren(): Promise<TreeNode[]> {
 		if (!this._filesCategoryNode || !this._commitsCategoryNode) {
+			Logger.appendLine(`Creating file and commit nodes for PR #${this.pullRequestModel.number}`, PR_TREE);
 			this._filesCategoryNode = new FilesCategoryNode(this.parent, this._reviewModel, this._pullRequest);
 			this._commitsCategoryNode = new CommitsNode(
 				this.parent,