arduino/arduino-create-agentPublic

NotificationsYou must be signed in to change notification settings
Fork158
Star453

Improve`installed.json` handling in`v2/tools`#983

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

MatteoPologruto merged 5 commits intoarduino:mainfromMatteoPologruto:corrupted-json-fix

Aug 5, 2024

Merged

Improve`installed.json` handling in`v2/tools`#983

MatteoPologruto merged 5 commits intoarduino:mainfromMatteoPologruto:corrupted-json-fix

Aug 5, 2024

+61 −43

Conversation

Copy link

Contributor

MatteoPologruto commentedAug 1, 2024•
edited
Loading

Please check if the PR fulfills these requirements

The PR has no duplicates (please search among thePull Requests
before creating one)
Tests for the changes have been added (for bug fixes / features)

What kind of change does this PR introduce?

Code enhancement

What is the current behavior?

Theinstalled.json is read everytime it needs to be updated and there is no mutex policy to prevent file corruption.

What is the new behavior?

Information frominstalled.json is stored in a map and a mutex policy is introduced.

Does this PR introduce a breaking change?

Other information:

MatteoPologruto added type: enhancement

Proposed improvement

topic: codeRelated to content of the project itself labels

Aug 1, 2024

MatteoPologruto self-assigned this

Aug 1, 2024

Copy link

codecov-commenter commentedAug 1, 2024•
edited
Loading

Codecov Report

Attention: Patch coverage is89.65517% with3 lines in your changes missing coverage. Please review.

Project coverage is 20.70%. Comparing base(6287df1) to head(33f59b5).

Files	Patch %	Lines
v2/pkgs/tools.go	88.46%	2 Missing and 1 partial⚠️

Additional details and impacted files

@@            Coverage Diff             @@##             main     #983      +/-   ##==========================================+ Coverage   20.01%   20.70%   +0.68%==========================================  Files          42       42                Lines        2568     2565       -3     ==========================================+ Hits          514      531      +17+ Misses       1968     1949      -19+ Partials       86       85       -1

Flag	Coverage Δ
unit	`20.70% <89.65%> (+0.68%)`	⬆️

Flags with carried forward coverage won't be shown.Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report?Share it here.

MatteoPologruto marked this pull request as ready for review

August 1, 2024 14:25

MatteoPologruto requested review fromXayton andumbynos

August 1, 2024 14:25

MatteoPologruto linked an issue

Aug 1, 2024

that may beclosed by this pull request

Agent error while installing tools (installed.json corruption)#977

Closed

umbynos reviewed

Aug 1, 2024

View reviewed changes

v2/pkgs/tools.go OutdatedShow resolvedHide resolved

umbynos reviewed

Aug 1, 2024

View reviewed changes

v2/pkgs/tools.go OutdatedShow resolvedHide resolved

Copy link

Contributor

Xayton commentedAug 5, 2024

Before merging, we also need to add some code that, if theinstalled.json file is not parsable, it will delete it and retry, instead of panicking.

Xayton added this to the1.6.1 milestone

Aug 5, 2024

Copy link

ContributorAuthor

MatteoPologruto commentedAug 5, 2024•
edited
Loading

Before merging, we also need to add some code that, if theinstalled.json file is not parsable, it will delete it and retry, instead of panicking.

This commit solves this issue. Theinstalled.json is parsed only when theTools struct is initialized and errors are ignored. If the json is corrupted, theinstalled map remains empty and any tool is downloaded from scratch, rewriting theinstalled.json file.