Update check on debug config generation fail #30

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

per1234 merged 1 commit into arduino:main from per1234:fix-sketch-binary-check

Aug 1, 2022

Merged

Update check on debug config generation fail #30

per1234 merged 1 commit into arduino:main from per1234:fix-sketch-binary-check

Aug 1, 2022

Conversation

per1234

Copy link

Contributor

@per1234 per1234 commented Feb 4, 2022

When sketch debugging is initiated, the extension runs Arduino CLI to get the debugger configuration information. This information is required to generate the launch.json configuration file.

As part of this information is the path to the compiled sketch binary, Arduino CLI checks for the existence of that file, and errors if it is not present (which is usually caused by the user having neglected to compile the sketch):

$ arduino-cli version
arduino-cli.exe Version: git-snapshot Commit: 200d4b4f Date: 2022年02月03日T15:48:11Z
$ arduino-cli sketch new /tmp/NotCompiled
Sketch created in: C:\Users\per\AppData\Local\Temp\NotCompiled
$ arduino-cli debug -I -b arduino:samd:mkrzero --format json /tmp/NotCompiled
Error getting Debug info: Compiled sketch not found in C:\Users\per\AppData\Local\Temp\arduino-sketch-B00E82A5EFC5401167B17E3767CC3A00

The extension has special handling for this specific common error cause, which is based on a fragile string comparison on the human readable error message. As is the nature of such an approach, a seemingly innocuous capitalization change to the message in the Arduino CLI code base (arduino/arduino-cli@75b9760) broke the check.

The quick fix provided here is making the check case insensitive.

NOTE: this is not a true fix. The human readable error message string may change at any time, and is guaranteed to change if non-English localization is enabled.

However, it is less broken after this simple change, and the check is not critical, so I think it is still worthwhile.

@per1234


 Update check on debug config generation fail

cc16f9c

When sketch debugging is initiated, the extension runs Arduino CLI to get the debugger configuration information. This
information is required to generate the `launch.json` configuration file.
As part of this information is the path to the compiled sketch binary, Arduino CLI checks for the existence of that
file, and errors if it is not present (which is usually caused by the user having neglected to compile the sketch):
```
Error getting Debug info: Compiled sketch not found in ...
```
The extension has special handling for this specific common error cause, which is based on a fragile string comparison
on the human readable error message. As is the nature of this approach, a seemingly innocuous capitalization change to
the message in the Arduino CLI code base broke the check.
The quick fix provided here is making the check case insensitive.