[BREAKING] gRPC / golang Configuration API refactoring

cmaglie commented 3 months ago

Please check if the PR fulfills these requirements

See how to contribute

[x] The PR has no duplicates (please search among the Pull Requests before creating one)
[x] The PR follows our contributing guidelines
[x] Tests for the changes have been added (for bug fixes / features)
[x] Docs have been added / updated (for bug fixes / features)
[x] UPGRADING.md has been updated with a migration guide (for breaking changes)
[ ] configuration.schema.json updated if new parameters are added.

What kind of change does this PR introduce?

This PR introduces a big change in the configuration API, the main goals for this PR are:

Making the gRPC API more prominent even in the internal of the golang code, in this case, after merging the PR, the command line interface implementation becomes 100% dependent on the gRPC API, (no more bypass)
The configuration API (hopefully) becomes more flexible than it was before, allowing a more granular control of the written fields
Makes real the 'third pillar' of the Arduino CLI (using the code by importing in another golang project).

What is the current behavior?

There should be very few changes in the CLI behavior, in theory, final users should not notice any change.

What is the new behavior?

Does this PR introduce a breaking change, and is titled accordingly?

Yes, the gRPC Settings* API changed a lot, adaption on the client is required.

Other information

codecov[bot] commented 3 months ago

Codecov Report

Attention: Patch coverage is 74.24299% with 689 lines in your changes are missing coverage. Please review.

Project coverage is 70.13%. Comparing base (03d8653) to head (cec1fdb). Report is 4 commits behind head on master.

Files	Patch %	Lines
internal/go-configmap/types.go	46.52%	69 Missing and 8 partials :warning:
commands/service_monitor.go	62.69%	53 Missing and 19 partials :warning:
commands/service_settings.go	69.51%	39 Missing and 11 partials :warning:
commands/cmderrors/cmderrors.go	14.89%	40 Missing :warning:
commands/instances.go	72.91%	30 Missing and 9 partials :warning:
commands/service_upload_burnbootloader.go	0.00%	35 Missing :warning:
commands/service_upload.go	54.41%	29 Missing and 2 partials :warning:
commands/service_compile.go	66.66%	24 Missing and 4 partials :warning:
internal/go-configmap/cli.go	65.07%	16 Missing and 6 partials :warning:
internal/cli/config/init.go	64.40%	12 Missing and 9 partials :warning:
... and 50 more

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #2565 +/- ## ========================================== + Coverage 69.51% 70.13% +0.61% ========================================== Files 207 222 +15 Lines 20285 21124 +839 ========================================== + Hits 14102 14816 +714 - Misses 5069 5132 +63 - Partials 1114 1176 +62 ``` | [Flag](https://app.codecov.io/gh/arduino/arduino-cli/pull/2565/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=arduino) | Coverage Δ | | |---|---|---| | [unit](https://app.codecov.io/gh/arduino/arduino-cli/pull/2565/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=arduino) | `70.13% <74.24%> (+0.61%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=arduino#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

cmaglie commented 1 month ago

Should we update also this: https://github.com/arduino/arduino-cli/blob/master/docs/integration-options.md?

Yes, BTW I'm doing it in another branch as part of a general revamp of the documentation.

arduino / arduino-cli