Pluggable monitor

[AlbyIanna]

Motivation

The main reason for this PR is to use the latest "pluggable monitor" gRPC APIs #769. But in order to use the new APIs, we needed to refactor all the Serial Monitor architecture. All this work allowed us to solve a number of issues that weren't impossible or too expensive to solve before the change, and we also took advantage of this effort to implement a more solid architecture.

This PR solves:

• Upload fails if port is open in Serial Monitor of another window #586
• Use the latest "pluggable monitor" gRPC APIs #769
• Serial Monitor/Plotter don't use per-window port selection #613

Change description

The architecture has been redesigned like this:

Call Stack / Event Flow when opening Serial monitor or Plotter

Numbers correspond to those in the diagram above.

1. A monitor is opened (monitor-widget or plotter-frontend-contribution) from the IDE;
2. monitor-widget or plotter-frontend-contribution invokes .startMonitor() method on monitor-manager-proxy-client-impl from .onBeforeAttach() or .startPlotter(), respectively;
3. monitor-manager-proxy-client-impl.startMonitor() invokes .startMonitor() method on monitor-manager-proxy-impl;
4. monitor-manager-proxy-impl.startMonitor() invokes .startMonitor() method on monitor-manager;
5. monitor-manager creates a monitor-service from monitor-service-factory if not existing, injecting monitor-settings-provider-impl and web-socket-provider-impl;
6. monitor-manager invokes .start() method on created/existing monitor-service;
   • this creates a duplex stream (gRPC) to communicate with our CLI;
   • An injected WebSocket server is instantiated here;
7. The result from monitor-service.start() method is returned to the monitor-manager-proxy-impl when it's duplex connection is successfully connected (if no error);
8. monitor-manager-proxy-impl invokes .connect() on the monitor-manager-proxy-client-impl if value returned from monitor-service.start() method is Status.OK or Status.ALREADY_CONNECTED;
   • this creates a WebSocket client linked to the WebSocket server created for our monitor-service;

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)

[fstasi]

• reset board does not reconnect
  • closing the monitor and re-opening fixes the problem
• missing disconnected status in the serial monitor panel
• serial plotter connect to the right port only when the serial monitor is open
  • this is probably due to the fact that the monitor updates the status of the UI with the correct port
• upload is broken

[ubidefeo]

@PaulStoffregen

builds are at the bottom of this page, let me know if you can't see them
https://github.com/arduino/arduino-ide/actions/runs/2447002574

[PaulStoffregen]

@ubidefeo - I'm running it now on my Linux desktop machine. Seems to be working pretty well. I'm happy to see it's handling Teensy 4.0 maximum speed printing pretty well, with 2 processes each using about 70% of a CPU core, and 4 others adding up to about 55%.

[PaulStoffregen]

Overall speed of more than half a million lines/sec is also quite good.

[PaulStoffregen]

Running a Teensy 4.0 overclocked to 912 MHz, and the pluggable monitor is managing 785000 lines/sec. Very respectable speed.

I have some rough edges to fix in my package's uploading utility. Looks like the IDE has some minor serial monitor bugs, probably unrelated to pluggable monitor.

[ubidefeo]

Thank you, @PaulStoffregen
We really appreciate your feedback and we know some things need adjusting but feel like this is a great milestone for CLI and IDE 2.0 :)