StatusBarItem - proposed API for async hover #238297
Draft
+80
−16
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lszomoru
changed the title
bpasero
requested changes
Jan 20, 2025
Co-authored-by: Benjamin Pasero <[email protected]>
Co-authored-by: Benjamin Pasero <[email protected]>
Co-authored-by: Benjamin Pasero <[email protected]>
Co-authored-by: Benjamin Pasero <[email protected]>
bpasero
requested changes
Jan 20, 2025
| @@ -272,6 +288,10 @@ export class ExtHostStatusBarEntry implements vscode.StatusBarItem { | |||
|
|
|||
| public dispose(): void { | |||
| this.hide(); | |||
|
|
|||
| this.staticItems.delete(this._entryId); | |||
There was a problem hiding this comment.
I am not sure about this: we are not adding to this Map, rather we get it passed in from the outside, so I would not touch this. I think static status bar entries are declared in package.json and can actually not be disposed.
| constructor(proxy: MainThreadStatusBarShape, commands: CommandsConverter, staticItems: ReadonlyMap<string, StatusBarItemDto>, extension?: IExtensionDescription, id?: string, alignment: ExtHostStatusBarAlignment = ExtHostStatusBarAlignment.Left, priority?: number) { | ||
| constructor(proxy: MainThreadStatusBarShape, commands: CommandsConverter, staticItems: Map<string, StatusBarItemDto>, entries: Map<string, ExtHostStatusBarEntry>, extension: IExtensionDescription, id?: string, alignment?: ExtHostStatusBarAlignment, priority?: number); | ||
| constructor(proxy: MainThreadStatusBarShape, commands: CommandsConverter, staticItems: Map<string, StatusBarItemDto>, entries: Map<string, ExtHostStatusBarEntry>, extension: IExtensionDescription | undefined, id: string, alignment?: ExtHostStatusBarAlignment, priority?: number); | ||
| constructor(proxy: MainThreadStatusBarShape, commands: CommandsConverter, private staticItems: Map<string, StatusBarItemDto>, private entries: Map<string, ExtHostStatusBarEntry>, extension?: IExtensionDescription, id?: string, alignment: ExtHostStatusBarAlignment = ExtHostStatusBarAlignment.Left, priority?: number) { |
There was a problem hiding this comment.
Marking staticItems as private gives extensions a way to access this and modify it, I think we cannot do that.
| @@ -272,6 +288,10 @@ export class ExtHostStatusBarEntry implements vscode.StatusBarItem { | |||
|
|
|||
| public dispose(): void { | |||
| this.hide(); | |||
|
|
|||
| this.staticItems.delete(this._entryId); | |||
| this.entries.delete(this._entryId); | |||
There was a problem hiding this comment.
This feels a bit off: you are passing entries in and even keep it as private (which means extensions could access it) to remove from the dispose. This needs a different, safer approach so that extensions cannot tamper.
| return undefined; | ||
| } | ||
|
|
||
| return MarkdownString.fromStrict(await entry.tooltip2?.(cancellation)); |
There was a problem hiding this comment.
I would await the entry.tooltip2 call and then check again for cancellation and then return undefined if cancelled.
bpasero
requested changes
Jan 20, 2025
| @@ -133,6 +139,10 @@ export class ExtHostStatusBarEntry implements vscode.StatusBarItem { | |||
| return this._tooltip; | |||
| } | |||
|
|
|||
| public get tooltip2(): ((token: vscode.CancellationToken) => Promise<string | vscode.MarkdownString | undefined>) | undefined { | |||
| return this._tooltip2; | |||
| @@ -164,6 +174,11 @@ export class ExtHostStatusBarEntry implements vscode.StatusBarItem { | |||
| this.update(); | |||
| } | |||
|
|
|||
| public set tooltip2(tooltip: any) { | |||
| this._tooltip2 = tooltip; | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.