@theia/plugin-ext 1.34.0 → 1.34.2

package/src/plugin/tree/tree-views.ts

@@ -34,7 +34,6 @@ import { URI } from '@theia/core/shared/vscode-uri';
 import { UriComponents } from '@theia/core/lib/common/uri';
 
 export class TreeViewsExtImpl implements TreeViewsExt {
-
     private proxy: TreeViewsMain;
 
     private readonly treeViews = new Map<string, TreeViewExtImpl<any>>();
@@ -45,9 +44,9 @@ export class TreeViewsExtImpl implements TreeViewsExt {
         commandRegistry.registerArgumentProcessor({
             processArgument: arg => {
                 if (TreeViewItemReference.is(arg)) {
-                    return this.toTreeItem(arg);
+                    return this.toTreeElement(arg);
                 } else if (Array.isArray(arg)) {
-                    return arg.map(param => TreeViewItemReference.is(param) ? this.toTreeItem(param) : param);
+                    return arg.map(param => TreeViewItemReference.is(param) ? this.toTreeElement(param) : param);
                 } else {
                     return arg;
                 }
@@ -62,8 +61,8 @@ export class TreeViewsExtImpl implements TreeViewsExt {
         return this.getTreeView(treeViewId).handleDrop!(treeItemId, dataTransferItems, token);
     }
 
-    protected toTreeItem(treeViewItemRef: TreeViewItemReference): any {
-        return this.treeViews.get(treeViewItemRef.viewId)?.getTreeItem(treeViewItemRef.itemId);
+    protected toTreeElement(treeViewItemRef: TreeViewItemReference): any {
+        return this.treeViews.get(treeViewItemRef.viewId)?.getElement(treeViewItemRef.itemId);
     }
 
     registerTreeDataProvider<T>(plugin: Plugin, treeViewId: string, treeDataProvider: TreeDataProvider<T>): PluginDisposable {
@@ -186,6 +185,10 @@ interface TreeExtNode<T> extends Disposable {
 }
 
 class TreeViewExtImpl<T> implements Disposable {
+    private static readonly ID_COMPUTED = 'c';
+    private static readonly ID_ITEM = 'i';
+
+    private nextItemId: 0;
 
     private readonly onDidExpandElementEmitter = new Emitter<TreeViewExpansionEvent<T>>();
     readonly onDidExpandElement = this.onDidExpandElementEmitter.event;
@@ -274,7 +277,7 @@ class TreeViewExtImpl<T> implements Disposable {
         this.proxy.$setDescription(this.treeViewId, this._description);
     }
 
-    getTreeItem(treeItemId: string): T | undefined {
+    getElement(treeItemId: string): T | undefined {
         return this.nodes.get(treeItemId)?.value;
     }
 
@@ -312,14 +315,9 @@ class TreeViewExtImpl<T> implements Disposable {
             // parent is inconsistent
             return undefined;
         }
-        const idLabel = this.getTreeItemIdLabel(treeItem);
-        let possibleIndex = children.length;
-        // find the right element id by searching all possible id names in the cache
-        while (possibleIndex-- > 0) {
-            const candidateId = this.buildTreeItemId(parentId, possibleIndex, idLabel);
-            if (this.nodes.has(candidateId)) {
-                return chain.concat(candidateId);
-            }
+        const candidateId = this.buildTreeItemId(parentId, treeItem);
+        if (this.nodes.has(candidateId)) {
+            return chain.concat(candidateId);
         }
         // couldn't calculate consistent parent chain and id
         return undefined;
@@ -335,7 +333,7 @@ class TreeViewExtImpl<T> implements Disposable {
         return typeof treeItemLabel === 'object' ? treeItemLabel.highlights : undefined;
     }
 
-    private getTreeItemIdLabel(treeItem: TreeItem): string | undefined {
+    private getItemLabel(treeItem: TreeItem): string | undefined {
         let idLabel = this.getTreeItemLabel(treeItem);
         // Use resource URI if label is not set
         if (idLabel === undefined && treeItem.resourceUri) {
@@ -348,8 +346,18 @@ class TreeViewExtImpl<T> implements Disposable {
         return idLabel;
     }
 
-    private buildTreeItemId(parentId: string, index: number, idLabel: string | undefined): string {
-        return `${parentId}/${index}:${idLabel}`;
+    private buildTreeItemId(parentId: string, item: TreeItem): string {
+        // build tree id according to https://code.visualstudio.com/api/references/vscode-api#TreeItem
+        // note: the front end tree implementation cannot handle reparenting items, hence the id is set to the "path" of individual ids
+        let id = typeof item.id === 'string' ? item.id : this.getItemLabel(item);
+        if (id) {
+            // we use '' as the id of the root, we don't consider that a valid id
+            // since '' is falsy, we'll never get '' in this branch
+            id = TreeViewExtImpl.ID_ITEM + id;
+        } else {
+            id = TreeViewExtImpl.ID_COMPUTED + this.nextItemId++;
+        }
+        return `${parentId}/${id}`;
     }
 
     async getChildren(parentId: string): Promise<TreeViewItem[] | undefined> {
@@ -369,20 +377,19 @@ class TreeViewExtImpl<T> implements Disposable {
         // ask data provider for children for cached element
         const result = await this.options.treeDataProvider.getChildren(parent);
         if (result) {
-            const treeItemPromises = result.map(async (value, index) => {
+            const treeItemPromises = result.map(async value => {
 
                 // Ask data provider for a tree item for the value
                 // Data provider must return theia.TreeItem
                 const treeItem = await this.options.treeDataProvider.getTreeItem(value);
                 // Convert theia.TreeItem to the TreeViewItem
 
-                const label = this.getTreeItemLabel(treeItem);
+                const label = this.getItemLabel(treeItem);
                 const highlights = this.getTreeItemLabelHighlights(treeItem);
-                const idLabel = this.getTreeItemIdLabel(treeItem);
 
                 // Generate the ID
                 // ID is used for caching the element
-                const id = treeItem.id || this.buildTreeItemId(parentId, index, idLabel);
+                const id = this.buildTreeItemId(parentId, treeItem);
 
                 const toDisposeElement = new DisposableCollection();
                 const node: TreeExtNode<T> = {
@@ -467,7 +474,7 @@ class TreeViewExtImpl<T> implements Disposable {
 
     async onExpanded(treeItemId: string): Promise<any> {
         // get element from a cache
-        const cachedElement = this.getTreeItem(treeItemId);
+        const cachedElement = this.getElement(treeItemId);
 
         // fire an event
         if (cachedElement) {
@@ -479,7 +486,7 @@ class TreeViewExtImpl<T> implements Disposable {
 
     async onCollapsed(treeItemId: string): Promise<any> {
         // get element from a cache
-        const cachedElement = this.getTreeItem(treeItemId);
+        const cachedElement = this.getElement(treeItemId);
 
         // fire an event
         if (cachedElement) {
@@ -513,7 +520,7 @@ class TreeViewExtImpl<T> implements Disposable {
     get selectedElements(): T[] {
         const items: T[] = [];
         for (const id of this.selectedItemIds) {
-            const item = this.getTreeItem(id);
+            const item = this.getElement(id);
             if (item) {
                 items.push(item);
             }
@@ -554,7 +561,7 @@ class TreeViewExtImpl<T> implements Disposable {
     async onDragStarted(treeItemIds: string[], token: CancellationToken): Promise<UriComponents[] | undefined> {
         const treeItems: T[] = [];
         for (const id of treeItemIds) {
-            const item = this.getTreeItem(id);
+            const item = this.getElement(id);
             if (item) {
                 treeItems.push(item);
             }
@@ -571,7 +578,7 @@ class TreeViewExtImpl<T> implements Disposable {
     }
 
     async handleDrop(treeItemId: string | undefined, dataTransferItems: [string, string | DataTransferFileDTO][], token: CancellationToken): Promise<void> {
-        const treeItem = treeItemId ? this.getTreeItem(treeItemId) : undefined;
+        const treeItem = treeItemId ? this.getElement(treeItemId) : undefined;
         const dropTransfer = new DataTransfer();
         if (this.options.dragAndDropController?.handleDrop) {
             this.localDataTransfer.forEach((item, type) => {