fix #1383: missing port labels

[davegarthsimpson]

Motivation

Reported that upon opening a new sketch port labels can go missing for "Unknown board ports"

Change description

Ensures that we do not lose addressLabel(s) in "availableBoard objects" when reconciling our available boards.

Issue Identified

Described below.

Closes #1383

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)

[davegarthsimpson]

maybe this is not appropriate, I imagine it depends on whether or not .addressLabel was intended to be a "catch all" or not, for the sake of efficiency I've plugged this quick fix with a question:

@kittaakos
are you able to confirm if a fallback is appropriate here, or should port.addressLabel be our only reference as asserted in this PR, UPDATE: in that case we could go with the approach below (or change the boardsConfig object to store .addressLabel) Thanks!

[per1234]

Were you able to determine why port.addressLabel is empty after opening a new window @davegarthsimpson?

[davegarthsimpson]

Were you able to determine why port.addressLabel is empty after opening a new window

Yes, thanks for the important question, it's due to a chunk of code in our reconcileAvailableBoards method of the boards-service-provider here where we set the port in question by copying the boardsConfig.selectedPort object which does not contain .addressLabel only .address, this comment explains the reason why the author wrote this logic generally.

[davegarthsimpson]

The other alternative would be something like this in the "culprit code":

before:

581     ...
        const found = availableBoards.findIndex(
           (board) => board.port?.address === boardsConfig.selectedPort?.address
         );
         if (found >= 0) {
           availableBoards.splice(found, 1);
         }
         availableBoards.push({
           ...boardsConfig.selectedBoard,
           port: boardsConfig.selectedPort,
           selected: true,
           state: AvailableBoard.State.incomplete,
         });

after:

581     let port = boardsConfig.selectedPort
         ...
         const found = availableBoards.findIndex(
           (board) => board.port?.address === boardsConfig.selectedPort?.address
         );
         if (found >= 0) {
           port = availableBoards[found].port // get the "Unknown board port" that we will substitute
           availableBoards.splice(found, 1);
         }
         availableBoards.push({
           ...boardsConfig.selectedBoard,
           port, // "copy" the port info here where we'll have an "addressLabel" too
           selected: true,
           state: AvailableBoard.State.incomplete,
         });

[per1234]

That looks like the correct approach to me.

[kittaakos]

Nice catch; the fix looks good to me. The breaking change was probably here when new props were added to the Port but on board#port.

[per1234]

I verified this fixes #1383

Thanks Dave!

[kittaakos]

Thank you!