#573 Listen on the client's port change event #1545

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

kittaakos merged 1 commit into main from #573

Oct 17, 2022

Merged

#573 Listen on the client's port change event #1545

kittaakos merged 1 commit into main from #573

Oct 17, 2022

Conversation

kittaakos

Copy link

Contributor

@kittaakos kittaakos commented Oct 7, 2022

Motivation

Listen on the client's port changes to fix intermittent failure to recognize ports.

The problem was that the board select dialog was listening on the backend's board/port changes to show the available ports in the dialog. This was fundamentally incorrect as the following use case could happen.

Attach boards,
Start IDE2,
Backend starts and detects the boards and ports via the board list -w gRPC equivalent, dispatches board/port change event but client is not started yet,
Client starts,
Initialize the dialog with zero ports (this is common practice to init with empty),
Listen on the backend board/port changes (event never arrives),
Attach/detach a board, and the ports section in the dialog starts working.

It was never an issue with the Tool > Port menu, as it was correctly listening on the client's events:

arduino-ide/arduino-ide-extension/src/browser/contributions/board-selection.ts

Lines 109 to 111 in bc264d1

this.boardsServiceProvider.onAvailablePortsChanged(() =>

this.updateMenus()

);

With the proposed changes, the dialog is correctly listening on the client's board/port changes, so it cannot miss the event.

Change description

Other information

Closes #573

Locally, it was easy to reproduce the defect. Attach boards before starting IDE2. When IDE2 is up, open the board select dialog. Ports were empty. Now, it should work with the build from this PR.

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 kittaakos added topic: code type: imperfection labels

Oct 7, 2022

@kittaakos kittaakos requested review from AlbyIanna and per1234

October 7, 2022 12:52

AlbyIanna

AlbyIanna reviewed

Oct 10, 2022

View reviewed changes

arduino-ide-extension/src/browser/boards/boards-config.tsx Outdated Show resolved Hide resolved

AlbyIanna

AlbyIanna approved these changes

Oct 10, 2022

View reviewed changes

Copy link

Contributor

@AlbyIanna AlbyIanna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested it and it works just fine. I've just left a little remark on the code, but to me it's already okay ✅

per1234

per1234 approved these changes

Oct 12, 2022

View reviewed changes

Copy link

Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not able to reproduce the fault so I can't verify that the change proposed here fixes it.

I don't experience any problems when using the build for this PR though.


 Listen on the client's port change event

43f7720

If the board select dialog is listening on the backend's event,
the frontend might miss the event when it comes up, although boards
are connected and ports are discovered.
Closes #573
Signed-off-by: Akos Kitta <a.kitta@arduino.cc>