filesCategoryNode.ts

/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

import * as vscode from 'vscode';
import { ViewedState } from '../../common/comment';
import Logger, { PR_TREE } from '../../common/logger';
import { FILE_LIST_LAYOUT, HIDE_VIEWED_FILES, PR_SETTINGS_NAMESPACE } from '../../common/settingKeys';
import { compareIgnoreCase } from '../../common/utils';
import { PullRequestModel } from '../../github/pullRequestModel';
import { ReviewModel } from '../reviewModel';
import { DirectoryTreeNode } from './directoryTreeNode';
import { LabelOnlyNode, TreeNode, TreeNodeParent } from './treeNode';

export class FilesCategoryNode extends TreeNode implements vscode.TreeItem {
	public override readonly label: string = vscode.l10n.t('Files');
	public collapsibleState: vscode.TreeItemCollapsibleState;
	private directories: TreeNode[] = [];

	constructor(
		parent: TreeNodeParent,
		private _reviewModel: ReviewModel,
		_pullRequestModel: PullRequestModel
	) {
		super(parent);
		this.collapsibleState = vscode.TreeItemCollapsibleState.Expanded;
		this.childrenDisposables = [];
		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.onDidChange(e => {
			if (e.comments) {
				Logger.appendLine(`Comments have changed, refreshing Files node`, PR_TREE);
				this.refresh(this);
			}
		}));
		this.childrenDisposables.push(_pullRequestModel.onDidChangeFileViewedState(() => {
			Logger.appendLine(`File viewed state has changed, refreshing Files node`, PR_TREE);
			this.refresh(this);
		}));
		this.childrenDisposables.push(vscode.workspace.onDidChangeConfiguration(e => {
			if (e.affectsConfiguration(`${PR_SETTINGS_NAMESPACE}.${HIDE_VIEWED_FILES}`)) {
				Logger.appendLine(`Hide viewed files setting has changed, refreshing Files node`, PR_TREE);
				this.refresh(this);
			}
		}));
	}

	getTreeItem(): vscode.TreeItem {
		return this;
	}

	override async getChildren(): Promise<TreeNode[]> {
		super.getChildren(false);

		Logger.appendLine(`Getting children for Files node`, PR_TREE);
		if (!this._reviewModel.hasLocalFileChanges) {
			// Provide loading feedback until we get the files.
			return new Promise<TreeNode[]>(resolve => {
				const promiseResolver = this._reviewModel.onDidChangeLocalFileChanges(() => {
					resolve([]);
					promiseResolver.dispose();
				});
			});
		}

		if (this._reviewModel.localFileChanges.length === 0) {
			return [new LabelOnlyNode(this, vscode.l10n.t('No changed files'))];
		}

		let nodes: TreeNode[];
		const layout = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<string>(FILE_LIST_LAYOUT);
		const hideViewedFiles = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<boolean>(HIDE_VIEWED_FILES, false);

		// Filter files based on hideViewedFiles setting
		const filesToShow = hideViewedFiles
			? this._reviewModel.localFileChanges.filter(f => f.changeModel.viewed !== ViewedState.VIEWED)
			: this._reviewModel.localFileChanges;

		if (filesToShow.length === 0 && hideViewedFiles) {
			return [new LabelOnlyNode(this, vscode.l10n.t('All files viewed'))];
		}

		const dirNode = new DirectoryTreeNode(this, '');
		filesToShow.forEach(f => dirNode.addFile(f));
		dirNode.finalize();
		if (dirNode.label === '') {
			// nothing on the root changed, pull children to parent
			this.directories = dirNode._children;
			this.directories.forEach(child => { child.parent = this; });
		} else {
			this.directories = [dirNode];
		}

		if (layout === 'tree') {
			nodes = this.directories;
		} else {
			const fileNodes = [...filesToShow];
			fileNodes.sort((a, b) => compareIgnoreCase(a.fileChangeResourceUri.toString(), b.fileChangeResourceUri.toString()));
			// In flat layout, files are rendered as direct children of this node.
			// Keep parent pointers aligned with the rendered hierarchy so reveal/getParent
			// don't try to walk through hidden DirectoryTreeNode instances.
			fileNodes.forEach(fileNode => {
				fileNode.parent = this;
			});
			nodes = fileNodes;
		}
		Logger.appendLine(`Got all children for Files node`, PR_TREE);
		this._children = nodes;
		return nodes;
	}
}