fix: flawed timing issue when opening editors

[kittaakos]

Motivation

This PR is to fix the flawed timing issue when opening editors.

Change description

• From now on, the editor widget open promise resolution does not rely on internal Theia events but solely on @phosphor's isAttached/isVisible properties. The editor widget promise resolves with the next task after a navigation frame so the browser can render the widget.
• Generalized the invalid sketch name error handling and removed the CLI error messaging parsing logic due to The CLI provides different error messages when loading the main sketch file fails arduino-cli#1968.

Other information

For the testing, please use the 1612-sketches.zip archive. (However, you're allowed to use your own setup.)

1612-sketches.zip:

.
├── invalid-sketches
│   ├── Bar
│   │   └── xxx.ino
│   └── foo
│       └── Foo.ino
└── valid-sketches
    └── Errors1234567
        ├── CTab.c
        ├── CppTab.cpp
        ├── Errors1234567.ino
        ├── HTab.h
        ├── InoTab.ino
        └── src
            └── HFile.h

6 directories, 8 files

Expected behavior:

• Editors open quickly for the first time (First time load of project with many files very slow with "the editor has not shown up in time" errors #1612).
  • Start the valid sketch with multiple files: it opens "quickly". At least the performance loss mentioned in. First time load of project with many files very slow with "the editor has not shown up in time" errors #1612 is OK.

    ./Arduino\ IDE.app/Contents/MacOS/Arduino\ IDE ./1612-sketches/valid-sketches/Errors1234567/
    

• No regression with #964 Prompt move when opening invalid sketch outside from IDE2 #1563

  • After opening an invalid sketch, IDE2 prompts a sketch move

  • The fallback sketch editor is already opened in IDE2 when the modal dialog prompts the move (this is important to preserve the 1.x behavior in IDE2)

  • The error message is toasted when the IDE2 prompts with the modal dialog.

    ./Arduino\ IDE.app/Contents/MacOS/Arduino\ IDE ./1612-sketches/invalid-sketches/Bar 
    

    

    ./Arduino\ IDE.app/Contents/MacOS/Arduino\ IDE ./1612-sketches/invalid-sketches/foo
    

    

• The fallback sketch editor is already opened in IDE2 when the modal dialog prompts the move (this is important to preserve the 1.x behavior in IDE2)
• The error message is toasted when the IDE2 prompts with the modal dialog.

If one of these 👆 is not working due to a slower or different env OS, please let me know, and I will adjust the timings.

Closes #1612

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)

[AlbyIanna]

I don't understand this comment. @kittaakos could you please elaborate on this?

[kittaakos]

Thanks for asking!

We should improve it. I am open to any proposals. Your recent recommendations for clarifying code comments were on the spot 👍

When ensureOpened is called, the editor can be in two different primary states:

• It's not opened. The editor widget and the backing monaco editor instance do not exist, and the editor widget is not yet registered to the editorManager. The widget is undefined.
• It's opened
  • the editor widget is the top editor. The editor has the focus (the cursor blinks in it); it's the activeEditor.
  • the editor widget is the top editor, but the focus is on a different widget, or the context menu is active in the editor; it's the currentEditor.
  • the editor widget is not on top. The tab with the filename is visible.

When the widget is undefined, the framework will instantiate it when calling editorManager.open. After the editor widget creation, editorManager.onCreated gets an event. IDE2 must handle this case differently, listen to this event, and ensure that the editor is attached to the shell and visible on the screen. Then resolve the promise.

If the widget is already defined, it's opened; hence, there is no need to wait for any visibility state changes. This case does not need to wait for any events.

Please help to improve the comment.

[kittaakos]

I have updated the comments. Please re-check them. Thank you!

[AlbyIanna]

Suggested change

	// if the widget was already opened we assume it was already already visible and attached to the DOM
	// if the widget was already opened we assume it was already visible and attached to the DOM

[AlbyIanna]

Everything works as described and I couldn't find any regression with #1563.

Code is also good for me.

[per1234]

I verified this fixes the problem of the exceptionally long first load time for multi-file sketches reported at #1612.

I also checked for regressions in handling of opening sketches with invalid format on both Windows and Linux.

Thanks Akos!