Upgrade Monaco dependency to 1.83.1 #13217

tsmaeder · 2023-12-28T16:10:05Z

What it does

Upgrades our Monaco dependency to 1.83.1

Fixes #12679

Various changes were necessary, in particular:

There is a new Implementation of the diff editor
The setContext command has been renamed to '_setContext`.
The typing for the URI class has changed and we need to do some casting: Inconsistencies between vscode-uri and uri typings microsoft/vscode#190584
Our overriding of VS Code services in StandaloneServices has not been working for a while, but VS Code instantiating services eagerly instead of lazily has revealed the problem
VS Code adds many icons to the registry in parts of VS Code that are not used in Theia. Instead of hacking the Theme icon id field, we now just register those icons
Instead of adding our own styling for contributed icons, we now properly use the VS Code icon registry.

How to test

A lot of parts of Theia may be affected by this change and need testing, in particular:

The monaco editor
quick input
debugger
Built-in icons and themes

I'm opening this PR now in order to facilitate code review, but we still need

an IP check issue to be approved: https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/12577

Follow-ups

support editor.indentSize: vscode support of editor.indentSize #13105
stubbed VS Code API:
- provideDocumentRangesFormattingEdits
- registerMultiDocumentHighlightProvider
check implementation notes in languages-main.ts
IQuickinputOptions.linkOpenerDelegate: unimplementd feature

Review checklist

As an author, I have thoroughly tested my changes and carefully followed the review guidelines

Reminder for reviewers

As a reviewer, I agree to behave in accordance with the review guidelines

tsmaeder · 2023-12-30T14:34:14Z

Note that the failure in test are due to the way nodejs handle ES6 modules: here's what I fount out:

The @theia/monaco-editor-core module is loaded as a CJS module due to the fact that the package.json does not contain a type: module line
With this uplift, we do, for the first time have actual ES6 syntax in the monaco files:

@theia/preferences: export var Lexer = (__marked_exports.Lexer || exports.Lexer);
@theia/preferences: ^^^^^^
@theia/preferences: SyntaxError: Unexpected token 'export'
@theia/preferences:     at compileFunction (<anonymous>)

This is the only place actual import or export statements are used.

When I tried to convert the monaco package to a real module, I got

Error [ERR_REQUIRE_ESM]: Must use import to load ES Module: <....monaco module>

This is because typescript compiles import to use "require". So we can't really mix & match ESM and CJS modules, it seems.

tsmaeder · 2023-12-30T14:36:32Z

Maybe we can hack the module in question to remove the exports, but what about the next time some ES6-syntax appears in VS Code?

msujew

The change looks generally fine, but I have a few remarks.

Most importantly, the performance of the editor initialization/syntax highlighting seemed to have noticably suffered:

Current master:

2024-02-01.13-37-15.mp4

Changes:

2024-02-01.13-37-03.mp4

Can you reproduce the performance regression? I've had a feeling for quite a while now that our monaco editors are way slower to initialize than vscode - something that was actually been reinforced by the bad performance of the notebook editors. However, with the new changes it's pretty jarring.

Additionally, you might not be aware of this file. The command in there is supposed to be executed to align the Theia editor preferences to the preferences in Monaco/vscode. Furthermore there are quite a few lines/methods annotated with @monaco-uplift that should be easily resolved with just 1-2 lines of changes.

msujew · 2024-02-01T11:49:21Z

packages/plugin-ext/src/main/browser/theme-icon-override.ts

@@ -173,9 +174,11 @@ const codeIconMap: Record<string, string> = {
    'remote-explorer-view-icon': 'remote-explorer',
    'review-comment-collapse': 'chevron-up',
    'run-view-icon': 'debug-alt',
+    'runtime-extensions-editor-label-icon': ' extensions',


Question: Is the space here intended?

Suggested change

'runtime-extensions-editor-label-icon': ' extensions',

'runtime-extensions-editor-label-icon': 'extensions',

msujew · 2024-02-01T11:49:31Z

packages/plugin-ext/src/main/browser/theme-icon-override.ts

@@ -229,24 +233,14 @@ const codeIconMap: Record<string, string> = {
    'watch-expressions-add-function-breakpoint': 'add',
    'watch-expressions-remove-all': 'close-all',
    'watch-view-icon': 'debug-alt',
-    'widget-close': 'close'
+    'widget-close': 'close',
+    'workspace-trust-editor-label-icon': ' shield'


Suggested change

'workspace-trust-editor-label-icon': ' shield'

'workspace-trust-editor-label-icon': 'shield'

msujew

FYI, I've noticed that the change breaks notebook support, see:

tsmaeder · 2024-02-05T13:49:26Z

@msujew the performance hit vs. VS Code seems to be mostly due to the patched IConfigurationService we set up in monaco-frontend-module.ts. At least, if I just return a StandaloneConfigurationService, opening theia.d.ts performs similarly to VS Code. If there is worse performance in this branch I assume it's because with the new service override implementation, the patched service is used everywhere in Monaco (for example in editor contributions) where it might not have been before.

tsmaeder · 2024-02-05T15:41:49Z

@msujew I believe the performance problem should be fixed with the latest commit. Can you give it a go?

msujew

Looks pretty good to me. I couldn't find any further regressions and the performance is back to the before-change level.

Contributed on behalf of STMicroelectronics Signed-off-by: Thomas Mäder <t.s.maeder@gmail.com>

Signed-off-by: Thomas Mäder <t.s.maeder@gmail.com>

- Register vscode icons in registry instead of overriding ThemeIcon ids to codicon ids - Use Monaco icon registry instead of adding our own icon stylying Signed-off-by: Thomas Mäder <t.s.maeder@gmail.com>

Signed-off-by: Thomas Mäder <t.s.maeder@gmail.com>

Before this fix, Monaco API KeybindingService.resolveKeybinding test was failing on macOS with ``` AssertionError: expected { label: '⌃⇧⌥⌘K', …(6) } to deeply equal { label: '⌃⇧⌥⌘K', …(7) } + expected - actual { "WYSIWYG": true "ariaLabel": "⌃⇧⌥⌘K" + "chord": false "dispatchParts": [ "ctrl+shift+alt+meta+K" ] "electronAccelerator": "Ctrl+Shift+Alt+Cmd+K" ``` The `"chord": false` line was removed as part of eclipse-theia#13217 for other platforms. This fix removes it for macOS.

Before this fix, Monaco API KeybindingService.resolveKeybinding test was failing on macOS with ``` AssertionError: expected { label: '⌃⇧⌥⌘K', …(6) } to deeply equal { label: '⌃⇧⌥⌘K', …(7) } + expected - actual { "WYSIWYG": true "ariaLabel": "⌃⇧⌥⌘K" + "chord": false "dispatchParts": [ "ctrl+shift+alt+meta+K" ] "electronAccelerator": "Ctrl+Shift+Alt+Cmd+K" ``` The `chord: false` was removed from the expected object for other platforms as part of eclipse-theia#13217. This fix removes it from the expected object for macOS.

Before this fix, Monaco API KeybindingService.resolveKeybinding test was failing on macOS with ``` AssertionError: expected { label: '⌃⇧⌥⌘K', …(6) } to deeply equal { label: '⌃⇧⌥⌘K', …(7) } + expected - actual { "WYSIWYG": true "ariaLabel": "⌃⇧⌥⌘K" + "chord": false "dispatchParts": [ "ctrl+shift+alt+meta+K" ] "electronAccelerator": "Ctrl+Shift+Alt+Cmd+K" ``` The `chord: false` was removed from the expected object for other platforms as part of #13217. This fix removes it from the expected object for macOS.

tsmaeder requested review from vince-fugnitto, msujew, jfaltermeier and planger December 28, 2023 16:10

tsmaeder marked this pull request as ready for review January 12, 2024 10:43

tsmaeder force-pushed the 12679_monaco_uplift_1_83_1 branch from d99e532 to d4198cd Compare January 16, 2024 17:50

msujew reviewed Feb 1, 2024

View reviewed changes

tsmaeder force-pushed the 12679_monaco_uplift_1_83_1 branch from 5473f5d to 020bc5d Compare February 5, 2024 17:05

msujew changed the title ~~Upgrade Moncao dependency to 1.83.1~~ Upgrade Monaco dependency to 1.83.1 Feb 12, 2024

msujew approved these changes Feb 12, 2024

View reviewed changes

tsmaeder added 14 commits February 15, 2024 09:58

Uplift VS Code to 1.83.1. Fixes eclipse-theia#12679

d2049c2

Contributed on behalf of STMicroelectronics Signed-off-by: Thomas Mäder <t.s.maeder@gmail.com>

Fix instantiation and overriding of Monaco services.

3de4219

Signed-off-by: Thomas Mäder <t.s.maeder@gmail.com>

Fix icon issues

f8543a6

- Register vscode icons in registry instead of overriding ThemeIcon ids to codicon ids - Use Monaco icon registry instead of adding our own icon stylying Signed-off-by: Thomas Mäder <t.s.maeder@gmail.com>

Update @theia/monaco-editor-core dependency to 1.83.1

962bcda

Signed-off-by: Thomas Mäder <t.s.maeder@gmail.com>

Extract new preference schema

cee84f1

Signed-off-by: Thomas Mäder <t.s.maeder@gmail.com>

Update monaco-editor-core to 1.83.101

894f4a8

Signed-off-by: Thomas Mäder <t.s.maeder@gmail.com>

Fix keybinding test

966c07e

Signed-off-by: Thomas Mäder <t.s.maeder@gmail.com>

Fix more tests

b8e9024

Signed-off-by: Thomas Mäder <t.s.maeder@gmail.com>

Increase test timeout

6274c7a

Signed-off-by: Thomas Mäder <t.s.maeder@gmail.com>

Fix tests and fix vertical height of html/body tags

a9771a8

Signed-off-by: Thomas Mäder <t.s.maeder@gmail.com>

Fix notebook support

4783cd8

Signed-off-by: Thomas Mäder <t.s.maeder@gmail.com>

Fix performance problem when creating standalone editor.

99bba31

Signed-off-by: Thomas Mäder <t.s.maeder@gmail.com>

Update dependencies to monaco patch version

c5663a9

Signed-off-by: Thomas Mäder <t.s.maeder@gmail.com>

Changelog entry

26d4d97

Signed-off-by: Thomas Mäder <t.s.maeder@gmail.com>

tsmaeder force-pushed the 12679_monaco_uplift_1_83_1 branch from 0df996f to 26d4d97 Compare February 15, 2024 09:48

tsmaeder merged commit e53924d into eclipse-theia:master Feb 15, 2024
14 checks passed

pisv mentioned this pull request Feb 15, 2024

Add Dirty Diff Peek View #13104

Merged

1 task

tsmaeder mentioned this pull request Feb 17, 2024

Long time to start up #13383

Closed

msujew added monaco issues related to monaco dependencies pull requests that update a dependency file labels Feb 21, 2024

msujew mentioned this pull request Feb 21, 2024

Theia attempts to open notebooks as editors (and fails) #13404

Closed

jfaltermeier added this to the 1.47.0 milestone Feb 29, 2024

msujew mentioned this pull request Mar 4, 2024

Quick access bar items are not highlighted on hover #13449

Closed

pisv mentioned this pull request May 26, 2024

Fix an API test failure on macOS #13732

Merged

1 task

tsmaeder mentioned this pull request Aug 2, 2024

Rely on IConfigurationService change event to update model options #13994

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade Monaco dependency to 1.83.1 #13217

Upgrade Monaco dependency to 1.83.1 #13217

tsmaeder commented Dec 28, 2023 •

edited

Loading

tsmaeder commented Dec 30, 2023

tsmaeder commented Dec 30, 2023

msujew left a comment

msujew Feb 1, 2024

msujew Feb 1, 2024

msujew left a comment

tsmaeder commented Feb 5, 2024

tsmaeder commented Feb 5, 2024

msujew left a comment

	'runtime-extensions-editor-label-icon': ' extensions',
	'runtime-extensions-editor-label-icon': 'extensions',

	'workspace-trust-editor-label-icon': ' shield'
	'workspace-trust-editor-label-icon': 'shield'

Upgrade Monaco dependency to 1.83.1 #13217

Upgrade Monaco dependency to 1.83.1 #13217

Conversation

tsmaeder commented Dec 28, 2023 • edited Loading

What it does

How to test

Follow-ups

Review checklist

Reminder for reviewers

tsmaeder commented Dec 30, 2023

tsmaeder commented Dec 30, 2023

msujew left a comment

Choose a reason for hiding this comment

msujew Feb 1, 2024

Choose a reason for hiding this comment

msujew Feb 1, 2024

Choose a reason for hiding this comment

msujew left a comment

Choose a reason for hiding this comment

tsmaeder commented Feb 5, 2024

tsmaeder commented Feb 5, 2024

msujew left a comment

Choose a reason for hiding this comment

tsmaeder commented Dec 28, 2023 •

edited

Loading