chore: Theia 1.37.0 #2027

kittaakos · 2023-04-20T19:57:59Z

Motivation

To use the latest version of the Theia framework,
To get rid of all yarn audit vulnerabilities,
To use the latest electron with contextIsolation enabled and nodeIntegration disabled, and
To enable the new high-contrast light theme.

Change description

Updated @theia/* to 1.37.0.
Fixed all yarn audit security vulnerabilities.
Updated to [email protected]:
- contextIsolation is true,
- nodeIntegration is false, and the
- webpack target is moved from electron-renderer to web.
Updated to [email protected].
Updated the eslint plugins.
Added a new light high contrast theme to the IDE2.
High contrast themes use Theia APIs for style adjustments.
Support for ESM modules: "moduleResolution": "node16".
Node.js >= 16.14 is required.
VISX language packs were bumped to 1.70.0.
Removed undesired editor context menu items.
build: use execFileSync for npm scripts
build: use execa for the packager

% yarn audit
yarn audit v1.22.18
0 vulnerabilities found - Packages audited: 2091
✨  Done in 1.44s.

Light High Contrast theme:

ide2_hc_light.mp4

Other information

The application is not signed. On macOS, follow these steps.

Closes #321
Closes #1394

Reviewer checklist

PR addresses a single concern.
The PR has no duplicates (please search among the Pull Requests before creating one)
PR title and description are properly filled.
Docs have been added / updated (for bug fixes / features)

kittaakos · 2023-04-24T15:35:02Z

Upstream: sindresorhus/cpy#109

Update: I patched it in IDE2, and provided a fix: sindresorhus/cpy#110.
Update2: Updated to [email protected] with f2f347a.

per1234

UPDATE: fixed!

## Unexpected change to `workbench.iconTheme` default
The default value of the workbench.iconTheme setting changed from none to theia-file-icons.

I don't have a strong opinion on the subject of what the default should be. However, the decision the last time the subject was discussed ((#1173) was that the default should be none and I am not aware of any change to the decision since then so I assume this was an inadvertent change.

To reproduce

Select File > Quit from the Arduino IDE menus if it is running.

Delete the file at the following path:

Windows:
C:\Users\<username>\.arduinoIDE\settings.json
(where <username> is your Windows username)

Linux:
~/.arduinoIDE/settings.json

macOS:
~/.arduinoIDE/settings.json

Start Arduino IDE.
🐛 There is an icon on the left side of the editor tabs:

Open the bottom panel.
🐛 There is an icon on the left side of the bottom panel tabs:

Run the "Preferences: Open Settings (UI)" command.

Search for the workbench.iconTheme setting.

🐛 workbench.iconTheme is set to "File Icons (Theia)".

Expected behavior

The default value of the workbench.iconTheme setting is none.

Arduino IDE version

fc4882c (tester build for d66da25)

Operating system

~~Windows 11~~

kittaakos · 2023-05-01T12:53:39Z

Expected behavior

The default value of the workbench.iconTheme setting is none.

Thanks for noticing it. An upstream change (eclipse-theia/theia@b33ab2c) broke the default behavior. I've adjusted it here: 7ff070c.

arduino-ide-extension/src/browser/contributions/startup-tasks-executor.ts

arduino-ide-extension/src/electron-browser/electron-app-service.ts

arduino-ide-extension/src/browser/app-service.ts

arduino-ide-extension/src/browser/contributions/startup-tasks-executor.ts

arduino-ide-extension/src/browser/theia/core/theming.ts

kittaakos · 2023-05-04T07:37:45Z

The style of the release notes in the IDE updater dialog is broken

Thanks for checking it.

The breaking change was eclipse-theia/theia@1b5ff9e#diff-d8d45a890507a01141c010ad4a6891edf2ae727cfa6dfe604cebbd667812cccbR68. I fixed it
45aeb7f.

per1234

UPDATE: Fixed by 6adde6b

## **Edit > Paste** menu item is non-functional
Describe the problem

🐛 Selecting the Edit > Paste menu item does not have any effect.

To reproduce

Select File > New Sketch from the Arduino IDE menus.

Select the text // put your setup

Select Edit > Copy from the Arduino IDE menus.

Move the cursor to another location in the sketch.

Select Edit > Paste from the Arduino IDE menus.

🐛 The copied text is not pasted.

The IDE displays a warning notification:

⚠ Please use the browser's paste command or shortcut.

Expected behavior

Select Edit > Paste from the Arduino IDE menus pastes the content of the clipboard into the editor at the cursor location.

Arduino IDE version

0f1bf56 (tester build for 45aeb7f)

Operating system

Windows 11

Ubuntu 22.04

Additional context

The fault does not occur when using the build from the main branch (51f69f6)

I am not able to reproduce the fault on my macOS machine.

The fault also occurs when using the "Paste" item of the editor context menu.

Pasting via the Ctrl+V keyboard shortcut works as expected, so the fault is specific to the Edit > Paste menu item.

I notice no keyboard shortcut is listed for Paste in the Edit menu:

compare to 51f69f6:

The shortcut is also not defined for the "Paste" command in the "Keyboard Shortcuts" view:

compare to 51f69f6:

~~However, the fault still occurs even after I assign the Ctrl+V keybinding to the "Paste" command.~~

per1234

UPDATE: fixed by 6adde6b

## **Show Sketch Folder** has no effect
Describe the problem

The sketch folder is not opened when you select Sketch > Show Sketch Folder from the Arduino IDE menus.

To reproduce

Select Sketch > Show Sketch Folder from the Arduino IDE menus

🐛 The folder of the sketch is not opened in the file browser.

Expected behavior

The folder of the sketch currently open in the IDE window is opened in the file browser when Sketch > Show Sketch Folder is selected from the Arduino IDE menus.

Arduino IDE version

0f1bf56 (tester build for 45aeb7f)

Operating system

Windows 11

Additional context

The fault does not occur when using the build from the main branch (51f69f6)

The fault does not occur on my Linux and macOS machines.

~~Nothing is printed to the logs when I do a Show Sketch Folder operation.~~

per1234

UPDATE: resolved by 7534d8a

## Non-functional language server-related items added to editor context menu
This is an expansion of the existing problem tracked at #1394

Maybe the conclusion will be the same:

#1394 (comment)

The LS should use them. Instead of removing the context menu items

but I thought it was at least worth mentioning because we now have a significant number of non-functional items and I am not aware of any work, plans, or investigation related to bringing them into a functional state.

Describe the problem

New items were added to the editor context menu:

Go to Declaration

Peek > Peek Declaration

Go to Type Definition

Peek > Peek Type Definition

Go to Implementations

Peek > Peek Implementations

Go to References

Peek > Peek References

🐛 None of the newly added items are functional.

To reproduce

Create a sketch with the following content:
typedef int foo_t; foo_t bar(); foo_t bar() { return 42; } void setup() { bar(); }

Select Tools > Board > Arduino AVR Boards > Arduino Uno from the Arduino IDE menus.

Wait for the the "indexing" process to finish, as indicated at the left side of the status bar.

Right click on the bar on line 7.

Select "Go to Declaration" from the context menu.
🐛 Nothing happens (expected result is that the cursor would move to the bar function declaration at line 2)

Right click on the bar on line 7.

Select "Peek > Peek Declaration" from the context menu.
🐛 Nothing happens (expected result is that a peek of the bar declaration would open)

Right click on the foo_t on line 2.

Select "Go to Type Definition" from the context menu.
🐛 Nothing happens (expected result is that the cursor would move to the foo_t type definition at line 1)

Right click on the foo_t on line 2.

Select "Peek > Peek Type Definition" from the context menu.
🐛 Nothing happens (expected result is that a peek of the foo_t type definition would open)

Right click on the bar on line 2.

Select "Go to References" from the context menu.
🐛 Nothing happens (expected result is that a peek would open with all references to bar)

Right click on the bar on line 2.

Select "Peek > Peek References" from the context menu.
🐛 Nothing happens (expected result is that a peek would open with all references to bar)

Expected behavior

All editor context menu items are functional.

Arduino IDE version

0f1bf56 (tester build for 45aeb7f)

Operating system

Windows 11

Additional context

The non-functional menu items are not present when using the build from the main branch (51f69f6)

~~I did not test "Go to Implementations" and "Peek Implementations" because I don't know what "implementation" means in the context of a C++ program.~~

kittaakos · 2023-05-05T07:24:26Z

We must update the minimum Node.js version. It's >=16.13.0:

yarn install v1.22.5
[1/5] Validating package.json...
[2/5] Resolving packages...
[3/5] Fetching packages...
warning @puppeteer/[email protected]: Invalid bin entry for "@puppeteer/browsers" (in "@puppeteer/browsers").
info [email protected]: The platform "win32" is incompatible with this module.
info "[email protected]" is an optional dependency and failed compatibility check. Excluding it from installation.
error @npmcli/[email protected]: The engine "node" is incompatible with this module. Expected version "^14.17.0 || ^16.13.0 || >=18.0.0". Got "16.0.0"
error Found incompatible module.
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.

Update:

It's 16.14.0:

info "@nrwl/[email protected]" is an optional dependency and failed compatibility check. Excluding it from installation.
error [email protected]: The engine "node" is incompatible with this module. Expected version "14 || >=16.14". Got "16.13.0"
error Found incompatible module.
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.

kittaakos · 2023-05-05T10:00:11Z

Edit > Paste menu item is non-functional

Upstream: eclipse-theia/theia#12487

I will investigate. Thank you for noticing it 🙏

Update:

I found a quick workaround: 6adde6b

arduino-ide-extension/src/browser/dialogs/ide-updater/ide-updater-component.tsx

kittaakos · 2023-05-05T10:59:12Z

We must update the minimum Node.js version. It's >=16.13.0:

Done. It's updated to 16.14.0.

Show Sketch Folder has no effect

I have fixed it and verified it from the latest build. Please re-check

Edit > Paste menu item is non-functional

I added a workaround. It worked for me with the latest build on Windows.

My build:

Version: 2.1.1-snapshot-e2539a8
Date: 2023-05-05T10:08:57.749Z
CLI Version: 0.32.2

kittaakos · 2023-05-06T15:13:38Z

Some strings are not getting localised

A couple of examples:

Very nice 👍

I have updated the VS Code extension language pack versions to match Theia's supported VS Code API version: https://github.com/eclipse-theia/theia/blob/v1.37.0/dev-packages/application-package/src/api.ts#L21. See the changes:

I also provided a better workaround for the cut/copy/paste. I will wait for a Windows build and do a double check, but it works on macOS as it was with 2.1.0

kittaakos · 2023-05-06T15:15:40Z

I have updated the VS Code extension language pack versions to match Theia's supported VS Code API version:

Some supported languages do not have a more recent extension version available. We must check why and what are the implications of using older language packs with Theia using VS Code 1.72.x APIx:

bg, hu, nl, and uk extensions do not have a more recent version available.

per1234

UPDATE: resolved by bcb7f7d

## Some UI actions have no effect if performed soon after opening window
After opening an IDE window, some sort of an initialization process continues even after the UI appears in the window.

🐛 Some actions have no effect if the user performs them during this time window.

To reproduce

Select File > New Sketch from the Arduino IDE menus.

Wait until the UI populates in the new window.

Immediately* use the mouse to select File > New Sketch from the Arduino IDE menus.
On Windows, this must be done while the mouse pointer has the "working in background" style while hovered over the IDE window:

🐛 A new window does not open.

Expected behavior

UI elements are usable whenever they are exposed to the user.

Arduino IDE version

0fb9a06 (tester build for ed60048)

Operating system

Windows

macOS

Operating system version

Windows 11

macOS Ventura

Additional context

The fault does not occur when using the build from the main branch (964ea3b)

I used New Sketch in the demo, but the fault occurs with other UI operations as well.

I was not able to reproduce the fault on my Linux machine.

The fault does not occur when a keyboard shortcut (e.g., Ctrl+N) or even keyboard navigation of the GUI is used to trigger the operation instead of the mouse.

The fault does not occur if I make a keystroke before the UI action.

* On my high spec PC the window is ~5 seconds. It will likely be significantly longer for users with lower performance systems (and thus those users will be statistically more likely to be impacted by the regression).

kittaakos · 2023-05-08T07:07:02Z

I have updated the VS Code extension language pack versions to match Theia's supported VS Code API version:

Something needs to be corrected. We might need to pick another version like we did last time. Related: #1449

kittaakos · 2023-05-08T18:20:16Z

Non-functional language server-related items added to editor context menu

Fixed. Also, #1394 should be fixed.

Please mention in the review if something else needs to be removed. Thanks!

I have updated the VS Code extension language pack versions to match Theia's supported VS Code API version:

Something needs to be corrected. We might need to pick another version like we did last time. Related: #1449

Switched to 1.17.0 language extension.

Some UI actions have no effect if performed soon after opening window

The ugliest workaround is available for verification, but it works. Please verify it.

hack_for_nonfunctional_menu_items.mp4

Please revisit the behavior with the most recent changes. Thanks a lot for your persistence. This PR takes way longer than I anticipated.

kittaakos · 2023-05-08T18:21:38Z

Switched to 1.17.0 language extension.

This still applies 👇 . From #2027 (comment):

Some supported languages do not have a more recent extension version available. We must check why and what are the implications of using older language packs with Theia using VS Code 1.72.x APIx:

bg, hu, nl, and uk extensions do not have a more recent version available.

The issues I reported via my previous reviews have all been resolved. Thanks!

arduino-ide-extension/src/browser/dialogs/ide-updater/ide-updater-dialog.tsx

AlbyIanna

All my comments were addressed! I couldn't find any other issue and the code looks good to me. Thank, Akos!

- Updated `@theia/*` to `1.37.0`. - Fixed all `yarn audit` security vulnerabilities. - Updated to `[email protected]`: - `contextIsolation` is `true`, - `nodeIntegration` is `false`, and the - `webpack` target is moved from `electron-renderer` to `web`. - Updated to `[email protected]`. - Updated the `eslint` plugins. - Added the new `Light High Contrast` theme to the IDE2. - High contrast themes use Theia APIs for style adjustments. - Support for ESM modules: `"moduleResolution": "node16"`. - Node.js >= 16.14 is required. - VISX langage packs were bumped to `1.70.0`. - Removed undesired editor context menu items. (Closes arduino#1394) Signed-off-by: Akos Kitta <[email protected]>

Signed-off-by: Akos Kitta <[email protected]>

kittaakos · 2023-05-09T14:36:47Z

Some supported languages do not have a more recent extension version available. We must check why and what are the implications of using older language packs with Theia using VS Code 1.72.x APIx:

bg, hu, nl, and uk extensions do not have a more recent version available.

We must check why

there is no more recent version of the language packs for bg and hu in the VS Code Marketplace, so Open SVX cannot make a copy.
- https://marketplace.visualstudio.com/items?itemName=MS-CEINTL.vscode-language-pack-bg
- https://marketplace.visualstudio.com/items?itemName=MS-CEINTL.vscode-language-pack-hu
nl and uk no longer exist in the VS Code Marketplace.

kittaakos · 2023-05-09T15:37:17Z

Great reviews! Thanks a lot for your time and patience. 🙌

kittaakos added type: enhancement Proposed improvement topic: code Related to content of the project itself topic: security Related to the protection of user data topic: theia Related to the Theia IDE framework labels Apr 20, 2023

kittaakos self-assigned this Apr 20, 2023

kittaakos mentioned this pull request Apr 20, 2023

chore: updated to Theia 1.35.0 #1976

Closed

4 tasks

kittaakos force-pushed the theia-1.37.0-next branch 5 times, most recently from c155a33 to b223ec3 Compare April 27, 2023 07:29

kittaakos requested review from AlbyIanna, per1234 and davegarthsimpson April 27, 2023 08:22

kittaakos marked this pull request as ready for review April 27, 2023 08:23

kittaakos force-pushed the theia-1.37.0-next branch from b223ec3 to d66da25 Compare April 28, 2023 07:02

kittaakos changed the title ~~chore: Theia 1.37.0-next~~ chore: Theia 1.37.0 Apr 28, 2023

per1234 requested changes May 1, 2023

View reviewed changes

dankeboy36 reviewed May 2, 2023

View reviewed changes

kittaakos force-pushed the theia-1.37.0-next branch from f2f347a to 21f3858 Compare May 3, 2023 13:51

This comment was marked as resolved.

Sign in to view

kittaakos requested a review from rhpco May 4, 2023 11:29

kittaakos mentioned this pull request May 4, 2023

fix: copy when punctuation marks in sketch path #2045

Closed

4 tasks

per1234 requested changes May 5, 2023

View reviewed changes

per1234 reviewed May 5, 2023

View reviewed changes

AlbyIanna reviewed May 5, 2023

View reviewed changes

arduino-ide-extension/src/browser/dialogs/ide-updater/ide-updater-component.tsx Show resolved Hide resolved

This comment was marked as resolved.

Sign in to view

per1234 previously requested changes May 7, 2023

View reviewed changes

kittaakos mentioned this pull request May 8, 2023

[electron] Executing the commands from menu items has no effect when the application starts. It worked with 1.36.0 eclipse-theia/theia#12493

Open

rhpco reviewed May 9, 2023

View reviewed changes

arduino-ide-extension/src/browser/dialogs/ide-updater/ide-updater-dialog.tsx Show resolved Hide resolved

AlbyIanna approved these changes May 9, 2023

View reviewed changes

Akos Kitta added 3 commits May 9, 2023 16:14

build: use execFileSync for npm scripts

d8d2556

Signed-off-by: Akos Kitta <[email protected]>

build: use execa for the packager

ed007de

Signed-off-by: Akos Kitta <[email protected]>

kittaakos mentioned this pull request May 9, 2023

Validate the URLs before opening them, prompt user confirmation when opening untrusted domains #2056

Open

3 tasks

kittaakos force-pushed the theia-1.37.0-next branch from 7534d8a to ed007de Compare May 9, 2023 14:33

kittaakos merged commit 36e2092 into arduino:main May 9, 2023

This was referenced May 9, 2023

Non-functional language server items in editor context menu #1394

Closed

Missing declaration, type definition, and references functionality arduino/arduino-language-server#156

Open

kittaakos mentioned this pull request Jun 7, 2023

Arduino IDE2.1.0 save as truncates the end of the file if it exceeds 64kb #2086

Closed

3 tasks

per1234 mentioned this pull request Jul 2, 2023

Dark title bar when dark mode enabled #2125

Closed

3 tasks

kittaakos mentioned this pull request Jul 25, 2023

chore(deps): Updated to Theia 1.39.0 #2144

Merged

5 tasks

per1234 mentioned this pull request Aug 1, 2023

Scrollbar width non-standard #436

Open

per1234 mentioned this pull request Nov 23, 2023

End of sketch lost after "Save As" #1798

Closed

3 tasks

per1234 mentioned this pull request Feb 12, 2024

Make CTRL-SHIFT-TAB shortcut able to switch from the first tab to the last one #1786

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Theia 1.37.0 #2027

chore: Theia 1.37.0 #2027

kittaakos commented Apr 20, 2023 •

edited

Loading

kittaakos commented Apr 24, 2023 •

edited

Loading

per1234 left a comment •

edited

Loading

kittaakos commented May 1, 2023

Expected behavior

This comment was marked as resolved.

kittaakos commented May 4, 2023

per1234 left a comment •

edited

Loading

per1234 left a comment •

edited

Loading

per1234 left a comment •

edited

Loading

kittaakos commented May 5, 2023 •

edited

Loading

kittaakos commented May 5, 2023 •

edited

Loading

kittaakos commented May 5, 2023

This comment was marked as resolved.

kittaakos commented May 6, 2023

Some strings are not getting localised

kittaakos commented May 6, 2023

per1234 left a comment •

edited

Loading

kittaakos commented May 8, 2023

kittaakos commented May 8, 2023

kittaakos commented May 8, 2023

AlbyIanna left a comment

kittaakos commented May 9, 2023

kittaakos commented May 9, 2023

chore: Theia 1.37.0 #2027

chore: Theia 1.37.0 #2027

Conversation

kittaakos commented Apr 20, 2023 • edited Loading

Motivation

Change description

Other information

Reviewer checklist

kittaakos commented Apr 24, 2023 • edited Loading

per1234 left a comment • edited Loading

Choose a reason for hiding this comment

To reproduce

Expected behavior

Arduino IDE version

Operating system

kittaakos commented May 1, 2023

Expected behavior

This comment was marked as resolved.

kittaakos commented May 4, 2023

per1234 left a comment • edited Loading

Choose a reason for hiding this comment

Describe the problem

To reproduce

Expected behavior

Arduino IDE version

Operating system

Additional context

per1234 left a comment • edited Loading

Choose a reason for hiding this comment

Describe the problem

To reproduce

Expected behavior

Arduino IDE version

Operating system

Additional context

per1234 left a comment • edited Loading

Choose a reason for hiding this comment

Describe the problem

To reproduce

Expected behavior

Arduino IDE version

Operating system

Additional context

kittaakos commented May 5, 2023 • edited Loading

kittaakos commented May 5, 2023 • edited Loading

kittaakos commented May 5, 2023

This comment was marked as resolved.

kittaakos commented May 6, 2023

Some strings are not getting localised

kittaakos commented May 6, 2023

per1234 left a comment • edited Loading

Choose a reason for hiding this comment

To reproduce

Expected behavior

Arduino IDE version

Operating system

Operating system version

Additional context

kittaakos commented May 8, 2023

kittaakos commented May 8, 2023

kittaakos commented May 8, 2023

AlbyIanna left a comment

Choose a reason for hiding this comment

kittaakos commented May 9, 2023

kittaakos commented May 9, 2023

kittaakos commented Apr 20, 2023 •

edited

Loading

kittaakos commented Apr 24, 2023 •

edited

Loading

per1234 left a comment •

edited

Loading

per1234 left a comment •

edited

Loading

per1234 left a comment •

edited

Loading

per1234 left a comment •

edited

Loading

kittaakos commented May 5, 2023 •

edited

Loading

kittaakos commented May 5, 2023 •

edited

Loading

per1234 left a comment •

edited

Loading