GLSP-1568: Refactor MenuItem API #450
Merged
Conversation
This file contains hidden or 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
tortmayr
added a commit
to eclipse-glsp/glsp-server-node
that referenced
this pull request
Oct 7, 2025
- Adjust context menu item provider to new `ServerMenuItem` API - Extend workflow context menu provider - Add a hidden item for testing - Add a `Readonly` mode toggle entry Part of eclipse-glsp/glsp#1586 GLSP-1587: - Add missing action handler for `SetEditModeAction` - Align base `CommandPaletteActionProvider` with java-server implementation (do not return empty for readonly by default) Fixes eclipse-glsp/glsp#1587 Requires eclipse-glsp/glsp-client#450
2 tasks
tortmayr
added a commit
to eclipse-glsp/glsp-theia-integration
that referenced
this pull request
Oct 7, 2025
Adjust Theia GLSP context menu service for new MenuItem API. Ensure that isEnabled,isVisible and isToggled are properly forwarded to the Theia Menu item Part of eclipse-glsp/glsp#1586 Requires: eclipse-glsp/glsp-client#450 Requires: eclipse-glsp/glsp-server-node#116
2 tasks
martin-fleck-at
requested changes
Oct 8, 2025
| */ | ||
| export interface MenuItem extends LabeledAction { | ||
|
|
||
| export type MenuItem = ClientMenuItem; |
There was a problem hiding this comment.
Overall, I think we should keep the name MenuItem as the central type in the protocol and not deprecate it. My reasoning is as follows:
- It does not make sense to have both
ServerMenuItemandClientMenuItemin the protocol as the protocol should only have types for the communication between server and client and therefore all types here should be serializable. - That means we should fix the
MenuItemtype to have flags but not functions forisEnabled,isVisible, and isToggled`. I know that means we are breaking the protocol API but I'd argue that it is a very small break of something that has never actually worked in the first place. Adopters who are using that interface on the client-side might have to fix their typing so it definitely needs to be stated prominently in the changelog. - I do understand that we need the
ClientMenuItemtype with the functions on the client side. Either it should be a separate type or a type that extendsMenuItemby (additionally) allowing the functions. ServerMenuItemis therefore unnecessary and should be removed completely.
What do you think?
There was a problem hiding this comment.
Agreed. I pushed an update.
Pleaser re-review
- Refactor `MenuItem` API - Split into `ClientMenuItem` and `ServerMenuItem` (serializable) - Deprecate original `MenuItem` - Refactor `ServerContextMenuItemProvider` to properly map `ServerMenuItem`s to the client version - Replace deprecates usage of `MenuItem` with `ClientMenuItem` Also - Fix issue in `ToolManager` that prevented proper reactivation of default tools when switching back from readonly to edit mode - Ensure that the `Delete` context menu is deactivated if the editor is readonly - Add missing i18n messages for context menu labels and sort messages.json alphabetically - Fix copy right headers and regenerate index Part of: eclipse-glsp/glsp#1586
tortmayr
added a commit
to eclipse-glsp/glsp-server-node
that referenced
this pull request
Oct 8, 2025
- Adjust context menu item provider to new `ServerMenuItem` API - Extend workflow context menu provider - Add a hidden item for testing - Add a `Readonly` mode toggle entry Part of eclipse-glsp/glsp#1586 GLSP-1587: - Add missing action handler for `SetEditModeAction` - Align base `CommandPaletteActionProvider` with java-server implementation (do not return empty for readonly by default) Fixes eclipse-glsp/glsp#1587 Requires eclipse-glsp/glsp-client#450
martin-fleck-at
approved these changes
Oct 8, 2025
tortmayr
added a commit
to eclipse-glsp/glsp-server-node
that referenced
this pull request
Oct 9, 2025
* GLSP-1586: Refactor MenuItem API - Adjust context menu item provider to new `ServerMenuItem` API - Extend workflow context menu provider - Add a hidden item for testing - Add a `Readonly` mode toggle entry Part of eclipse-glsp/glsp#1586 GLSP-1587: - Add missing action handler for `SetEditModeAction` - Align base `CommandPaletteActionProvider` with java-server implementation (do not return empty for readonly by default) Fixes eclipse-glsp/glsp#1587 Requires eclipse-glsp/glsp-client#450 * Update yarn.lock
tortmayr
added a commit
to eclipse-glsp/glsp-theia-integration
that referenced
this pull request
Oct 10, 2025
* GLSP-1586: Adjust to new MenuItem API Adjust Theia GLSP context menu service for new MenuItem API. Ensure that isEnabled,isVisible and isToggled are properly forwarded to the Theia Menu item Part of eclipse-glsp/glsp#1586 Requires: eclipse-glsp/glsp-client#450 Requires: eclipse-glsp/glsp-server-node#116 * Upgrade yarn lock
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.
What it does
MenuItemAPIClientMenuItemandServerMenuItem(serializable)MenuItemServerContextMenuItemProviderto properly mapServerMenuItems to the client versionMenuItemwithClientMenuItemAlso
ToolManagerthat prevented proper reactivation of default tools when switching back from readonly to edit modeDeletecontext menu is deactivated if the editor is readonlyPart of: eclipse-glsp/glsp#1586
How to test
Follow-ups
Changelog