@theia/plugin-ext 1.66.0-next.0 → 1.66.0-next.27

package/src/main/browser/status-bar-message-registry-main.ts

@@ -16,23 +16,27 @@
 import { interfaces } from '@theia/core/shared/inversify';
 import { Disposable, DisposableCollection } from '@theia/core/lib/common/disposable';
 import * as types from '../../plugin/types-impl';
-import { StatusBarMessageRegistryMain } from '../../common/plugin-api-rpc';
+import { StatusBarMessageRegistryMain, StatusBarMessageRegistryExt, MAIN_RPC_CONTEXT } from '../../common/plugin-api-rpc';
 import { StatusBar, StatusBarAlignment, StatusBarEntry } from '@theia/core/lib/browser/status-bar/status-bar';
 import { ColorRegistry } from '@theia/core/lib/browser/color-registry';
 import { MarkdownString } from '@theia/core/lib/common/markdown-rendering';
+import { RPCProtocol } from '../../common/rpc-protocol';
+import { CancellationToken } from '@theia/core';
 
 export class StatusBarMessageRegistryMainImpl implements StatusBarMessageRegistryMain, Disposable {
     private readonly delegate: StatusBar;
     private readonly entries = new Map<string, StatusBarEntry>();
+    private readonly proxy: StatusBarMessageRegistryExt;
     private readonly toDispose = new DisposableCollection(
         Disposable.create(() => { /* mark as not disposed */ })
     );
 
     protected readonly colorRegistry: ColorRegistry;
 
-    constructor(container: interfaces.Container) {
+    constructor(container: interfaces.Container, rpc: RPCProtocol) {
         this.delegate = container.get(StatusBar);
         this.colorRegistry = container.get(ColorRegistry);
+        this.proxy = rpc.getProxy(MAIN_RPC_CONTEXT.STATUS_BAR_MESSAGE_REGISTRY_EXT);
     }
 
     dispose(): void {
@@ -46,7 +50,7 @@ export class StatusBarMessageRegistryMainImpl implements StatusBarMessageRegistr
         alignment: number,
         color: string | undefined,
         backgroundColor: string | undefined,
-        tooltip: string | MarkdownString | undefined,
+        tooltip: string | MarkdownString | true | undefined,
         command: string | undefined,
         accessibilityInformation: types.AccessibilityInformation,
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -64,7 +68,8 @@ export class StatusBarMessageRegistryMainImpl implements StatusBarMessageRegistr
             color: color && (this.colorRegistry.getCurrentColor(color) || color),
             // In contrast to color, the backgroundColor must be a theme color. Thus, do not hand in the plain string if it cannot be resolved.
             backgroundColor: backgroundColor && (this.colorRegistry.getCurrentColor(backgroundColor)),
-            tooltip,
+            // true is used as a serializable sentinel value to indicate that the tooltip can be retrieved asynchronously
+            tooltip: tooltip === true ? (token: CancellationToken) => this.proxy.$getMessage(id, token) : tooltip,
             command,
             accessibilityInformation,
             args

package/src/main/browser/text-editor-model-service.ts

@@ -63,7 +63,7 @@ export class EditorModelService {
         });
 
         model.onModelWillSaveModel(async (e: WillSaveMonacoModelEvent) => {
-            await Listener.await(e, this.onModelWillSaveListeners);
+            await Listener.awaitAll(e, this.onModelWillSaveListeners);
         });
 
         model.onDirtyChanged(_ => {

package/src/plugin/plugin-context.ts

@@ -33,7 +33,7 @@ import {
 } from '../common/plugin-api-rpc';
 import { RPCProtocol } from '../common/rpc-protocol';
 import { MessageRegistryExt } from './message-registry';
-import { StatusBarMessageRegistryExt } from './status-bar-message-registry';
+import { StatusBarMessageRegistryExtImpl } from './status-bar-message-registry';
 import { WindowStateExtImpl } from './window-state';
 import { WorkspaceExtImpl } from './workspace';
 import { EnvExtImpl } from './env';
@@ -335,7 +335,7 @@ export function createAPIFactory(
     const notebookRenderers = rpc.set(MAIN_RPC_CONTEXT.NOTEBOOK_RENDERERS_EXT, new NotebookRenderersExtImpl(rpc, notebooksExt));
     const notebookKernels = rpc.set(MAIN_RPC_CONTEXT.NOTEBOOK_KERNELS_EXT, new NotebookKernelsExtImpl(rpc, notebooksExt, commandRegistry, webviewExt, workspaceExt));
     const notebookDocuments = rpc.set(MAIN_RPC_CONTEXT.NOTEBOOK_DOCUMENTS_EXT, new NotebookDocumentsExtImpl(notebooksExt));
-    const statusBarMessageRegistryExt = new StatusBarMessageRegistryExt(rpc, commandRegistry);
+    const statusBarMessageRegistryExt = rpc.set(MAIN_RPC_CONTEXT.STATUS_BAR_MESSAGE_REGISTRY_EXT, new StatusBarMessageRegistryExtImpl(rpc, commandRegistry));
     const terminalExt = rpc.set(MAIN_RPC_CONTEXT.TERMINAL_EXT, new TerminalServiceExtImpl(rpc));
     const outputChannelRegistryExt = rpc.set(MAIN_RPC_CONTEXT.OUTPUT_CHANNEL_REGISTRY_EXT, new OutputChannelRegistryExtImpl(rpc));
     const treeViewsExt = rpc.set(MAIN_RPC_CONTEXT.TREE_VIEWS_EXT, new TreeViewsExtImpl(rpc, commandRegistry));

package/src/plugin/status-bar/status-bar-item.ts

@@ -37,6 +37,7 @@ export class StatusBarItemImpl implements theia.StatusBarItem {
     private _name: string | undefined;
     private _text: string;
     private _tooltip: string | theia.MarkdownString | undefined;
+    private _tooltip2: string | theia.MarkdownString | undefined | ((token: theia.CancellationToken) => theia.ProviderResult<string | theia.MarkdownString>);
     private _color: string | ThemeColor | undefined;
     private _backgroundColor: ThemeColor | undefined;
     private _command: string | theia.Command;
@@ -47,12 +48,13 @@ export class StatusBarItemImpl implements theia.StatusBarItem {
 
     _proxy: StatusBarMessageRegistryMain;
 
-    constructor(_proxy: StatusBarMessageRegistryMain,
+    constructor(proxy: StatusBarMessageRegistryMain,
         private readonly commandRegistry: CommandRegistryImpl,
         alignment: StatusBarAlignment = StatusBarAlignment.Left,
         priority: number = 0,
-        id = StatusBarItemImpl.nextId()) {
-        this._proxy = _proxy;
+        id = StatusBarItemImpl.nextId(),
+        private onDispose?: () => void) {
+        this._proxy = proxy;
         this._alignment = alignment;
         this._priority = priority;
         this._id = id;
@@ -63,7 +65,7 @@ export class StatusBarItemImpl implements theia.StatusBarItem {
     }
 
     public get alignment(): theia.StatusBarAlignment {
-        return <theia.StatusBarAlignment>this._alignment;
+        return this._alignment;
     }
 
     public get priority(): number {
@@ -82,6 +84,17 @@ export class StatusBarItemImpl implements theia.StatusBarItem {
         return this._tooltip;
     }
 
+    public get tooltip2(): string | theia.MarkdownString | undefined | ((token: theia.CancellationToken) => theia.ProviderResult<string | theia.MarkdownString>) {
+        if (typeof this._tooltip2 === 'function') {
+            const getTooltip = this._tooltip2.bind(this);
+            return (token: theia.CancellationToken) => Promise.resolve(getTooltip(token)).then(res => {
+                this.processTooltip(res);
+                return res;
+            });
+        }
+        return this._tooltip2;
+    }
+
     public get color(): string | ThemeColor | undefined {
         return this._color;
     }
@@ -108,57 +121,14 @@ export class StatusBarItemImpl implements theia.StatusBarItem {
         this.update();
     }
 
-    public set tooltip(tooltip: string | theia.MarkdownString | undefined) {
-        if (tooltip && MarkdownString.isMarkdownString(tooltip)) {
-            const markdownTooltip = tooltip;
-            const content = markdownTooltip.value;
-            // Find all command links in the markdown content
-            const regex = /\[([^\]]+)\]\(command:([^?\s\)]+)(?:\?([^\s\)]+))?([^\)]*)\)/g;
-            let match;
-            let updatedContent = content;
-
-            while ((match = regex.exec(content)) !== null) {
-                const linkText = match[1];
-                const commandId = match[2];
-                const argsEncoded = match[3]; // This captures the encoded arguments
-                const tooltipPart = match[4] || ''; // This captures any tooltip or additional content after the command and args
-
-                let args: unknown[] = [];
-                if (argsEncoded) {
-                    try {
-                        const decoded = decodeURIComponent(argsEncoded);
-                        args = JSON.parse(decoded);
-                    } catch (e) {
-                        console.error('Failed to parse command arguments:', e);
-                    }
-                }
-
-                const safeCommand = this.commandRegistry.converter.toSafeCommand(
-                    {
-                        command: commandId,
-                        title: linkText,
-                        arguments: Array.isArray(args) ? args : [args]
-                    },
-                    new DisposableCollection()
-                );
-
-                if (safeCommand?.id) {
-                    let newArgsPart = '';
-                    if (safeCommand.arguments && safeCommand.arguments.length > 0) {
-                        newArgsPart = `?${encodeURIComponent(JSON.stringify(safeCommand.arguments))}`;
-                    }
-
-                    const argsPart = argsEncoded ? `?${argsEncoded}` : '';
-                    const originalLink = `[${linkText}](command:${commandId}${argsPart}${tooltipPart})`;
-                    const safeLink = `[${linkText}](command:${safeCommand.id}${newArgsPart}${tooltipPart})`;
-                    updatedContent = updatedContent.replace(originalLink, safeLink);
-                }
-            }
+    public set tooltip2(tooltip: string | theia.MarkdownString | ((token: theia.CancellationToken) => theia.ProviderResult<string | theia.MarkdownString>) | undefined) {
+        this.processTooltip(tooltip);
+        this._tooltip2 = tooltip;
+        this.update();
+    }
 
-            if (updatedContent !== content) {
-                markdownTooltip.value = updatedContent;
-            }
-        }
+    public set tooltip(tooltip: string | theia.MarkdownString | undefined) {
+        this.processTooltip(tooltip);
         this._tooltip = tooltip;
         this.update();
     }
@@ -200,6 +170,59 @@ export class StatusBarItemImpl implements theia.StatusBarItem {
         this._isVisible = false;
     }
 
+    private processTooltip(tooltip: string | theia.MarkdownString | ((token: theia.CancellationToken) => theia.ProviderResult<string | theia.MarkdownString>) | undefined): void {
+        if (!MarkdownString.isMarkdownString(tooltip)) {
+            return;
+        }
+        const content = tooltip.value;
+        // Find all command links in the markdown content
+        const regex = /\[([^\]]+)\]\(command:([^?\s\)]+)(?:\?([^\s\)]+))?([^\)]*)\)/g;
+        let match;
+        let updatedContent = content;
+
+        while ((match = regex.exec(content)) !== null) {
+            const linkText = match[1];
+            const commandId = match[2];
+            const argsEncoded = match[3]; // This captures the encoded arguments
+            const tooltipPart = match[4] || ''; // This captures any tooltip or additional content after the command and args
+
+            let args: unknown[] = [];
+            if (argsEncoded) {
+                try {
+                    const decoded = decodeURIComponent(argsEncoded);
+                    args = JSON.parse(decoded);
+                } catch (e) {
+                    console.error('Failed to parse command arguments:', e);
+                }
+            }
+
+            const safeCommand = this.commandRegistry.converter.toSafeCommand(
+                {
+                    command: commandId,
+                    title: linkText,
+                    arguments: Array.isArray(args) ? args : [args]
+                },
+                new DisposableCollection()
+            );
+
+            if (safeCommand?.id) {
+                let newArgsPart = '';
+                if (safeCommand.arguments && safeCommand.arguments.length > 0) {
+                    newArgsPart = `?${encodeURIComponent(JSON.stringify(safeCommand.arguments))}`;
+                }
+
+                const argsPart = argsEncoded ? `?${argsEncoded}` : '';
+                const originalLink = `[${linkText}](command:${commandId}${argsPart}${tooltipPart})`;
+                const safeLink = `[${linkText}](command:${safeCommand.id}${newArgsPart}${tooltipPart})`;
+                updatedContent = updatedContent.replace(originalLink, safeLink);
+            }
+        }
+
+        if (updatedContent !== content) {
+            tooltip.value = updatedContent;
+        }
+    }
+
     private update(): void {
         if (!this._isVisible) {
             return;
@@ -220,6 +243,8 @@ export class StatusBarItemImpl implements theia.StatusBarItem {
                 color = StatusBarItemImpl.BACKGROUND_COLORS.get(this.backgroundColor.id);
             }
 
+            const tooltip = typeof this._tooltip2 === 'function' ? true : this._tooltip2 ?? this.tooltip;
+
             // Set to status bar
             this._proxy.$setMessage(
                 this.id,
@@ -229,7 +254,7 @@ export class StatusBarItemImpl implements theia.StatusBarItem {
                 this.alignment,
                 typeof color === 'string' ? color : color?.id,
                 this.backgroundColor?.id,
-                this.tooltip,
+                tooltip,
                 commandId,
                 this.accessibilityInformation,
                 args);
@@ -237,6 +262,7 @@ export class StatusBarItemImpl implements theia.StatusBarItem {
     }
 
     public dispose(): void {
+        this.onDispose?.();
         this.hide();
     }
 

package/src/plugin/status-bar-message-registry.ts

@@ -14,20 +14,23 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
 // *****************************************************************************
 import { Disposable, StatusBarAlignment } from './types-impl';
-import { StatusBarItem } from '@theia/plugin';
+import { CancellationToken, ProviderResult, StatusBarItem } from '@theia/plugin';
 import {
-    PLUGIN_RPC_CONTEXT as Ext, StatusBarMessageRegistryMain
+    PLUGIN_RPC_CONTEXT as Ext, StatusBarMessageRegistryMain,
+    StatusBarMessageRegistryExt
 } from '../common/plugin-api-rpc';
 import { RPCProtocol } from '../common/rpc-protocol';
 import { StatusBarItemImpl } from './status-bar/status-bar-item';
 import { CommandRegistryImpl } from './command-registry';
+import { MarkdownString } from '../common/plugin-api-rpc-model';
 
 /*---------------------------------------------------------------------------------------------
  *  Copyright (c) Microsoft Corporation. All rights reserved.
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-export class StatusBarMessageRegistryExt {
+export class StatusBarMessageRegistryExtImpl implements StatusBarMessageRegistryExt {
+    private readonly items = new Map<string, StatusBarItemImpl>();
 
     proxy: StatusBarMessageRegistryMain;
 
@@ -38,6 +41,15 @@ export class StatusBarMessageRegistryExt {
         this.statusMessage = new StatusBarMessage(this);
     }
 
+    $getMessage(id: string, cancellation: CancellationToken): ProviderResult<string | MarkdownString> {
+        const item = this.items.get(id);
+        if (!item) { return undefined; }
+        if (typeof item.tooltip2 === 'function') {
+            return item.tooltip2(cancellation);
+        }
+        return item.tooltip2 ?? item.tooltip;
+    }
+
     // copied from https://github.com/Microsoft/vscode/blob/6c8f02b41db9ae5c4d15df767d47755e5c73b9d5/src/vs/workbench/api/node/extHostStatusBar.ts#L174
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     setStatusBarMessage(text: string, timeoutOrThenable?: number | PromiseLike<any>): Disposable {
@@ -59,7 +71,9 @@ export class StatusBarMessageRegistryExt {
     }
 
     createStatusBarItem(alignment?: StatusBarAlignment, priority?: number, id?: string): StatusBarItem {
-        return new StatusBarItemImpl(this.proxy, this.commandRegistry, alignment, priority, id);
+        const item: StatusBarItemImpl = new StatusBarItemImpl(this.proxy, this.commandRegistry, alignment, priority, id, () => this.items.delete(item.id));
+        this.items.set(item.id, item);
+        return item;
     }
 
 }
@@ -70,7 +84,7 @@ class StatusBarMessage {
     private _item: StatusBarItem;
     private _messages: { message: string }[] = [];
 
-    constructor(statusBar: StatusBarMessageRegistryExt) {
+    constructor(statusBar: StatusBarMessageRegistryExtImpl) {
         this._item = statusBar.createStatusBarItem(StatusBarAlignment.Left, Number.MIN_VALUE);
     }