Skip to content

Added Type field to Platform gRPC struct #1853

New issue

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

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

Already on GitHub? # to your account

Merged
merged 2 commits into from
Aug 30, 2022

Conversation

cmaglie
Copy link
Member

@cmaglie cmaglie commented Aug 29, 2022

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • What kind of change does this PR introduce?
    Add category field to Platform gRPC struct

@cmaglie cmaglie requested a review from kittaakos August 29, 2022 10:59
@cmaglie cmaglie self-assigned this Aug 29, 2022
@cmaglie cmaglie added type: enhancement Proposed improvement topic: gRPC Related to the gRPC interface labels Aug 29, 2022
@cmaglie
Copy link
Member Author

cmaglie commented Aug 29, 2022

Related to arduino/arduino-ide#177

@cmaglie cmaglie force-pushed the new_grpc_field_in_platform branch from 3a7e58d to 61e3e01 Compare August 29, 2022 11:12
@per1234 per1234 added the topic: code Related to content of the project itself label Aug 29, 2022
@codecov
Copy link

codecov bot commented Aug 29, 2022

Codecov Report

Merging #1853 (2fede22) into master (aa41d72) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master    #1853   +/-   ##
=======================================
  Coverage   36.37%   36.38%           
=======================================
  Files         231      231           
  Lines       19572    19573    +1     
=======================================
+ Hits         7120     7121    +1     
  Misses      11622    11622           
  Partials      830      830           
Flag Coverage Δ
unit 36.38% <100.00%> (+<0.01%) ⬆️

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

Impacted Files Coverage Δ
commands/core.go 74.35% <100.00%> (+0.67%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@kittaakos
Copy link
Contributor

This does not seem to be correct:

./arduino-cli lib search "ArduinoOTA" --format json:

Part of the output JSON:

"latest": {
        "author": "Arduino,Juraj Andrassy",
        "version": "1.0.8",
        "maintainer": "Juraj Andrassy \u003cjuraj.andrassy@gmail.com\u003e",
        "sentence": "Upload sketch over network to Arduino board with WiFi or Ethernet libraries",
        "paragraph": "Based on WiFi101OTA library. Uploads over Ethernet, EthernetENC, WiFi101, WiFiNina, WiFiEspAT to SAMD, nRF5, RP2040, STM32F1, ESP and to classic ATmega with more than 64 kB flash memory.",
        "website": "https://github.com/jandrassy/ArduinoOTA",
        "category": "Other",
        "architectures": [
          "*"
        ],
        "types": [
          "Contributed"
        ],
        "resources": {
          "url": "https://downloads.arduino.cc/libraries/github.com/jandrassy/ArduinoOTA-1.0.8.zip",
          "archive_filename": "ArduinoOTA-1.0.8.zip",
          "checksum": "SHA-256:d36504623df593ea79db03ec6eb2601c45055ba0583414fced02b1c16ff7a779",
          "size": 82017,
          "cache_path": "libraries"
        },
        "provides_includes": [
          "ArduinoOTA.h"
        ]
      }

types (which is available only from LibraryRelease) should be an array of these values:
Screen Shot 2022-08-29 at 13 38 27

And the category should be one of these:
Screen Shot 2022-08-29 at 13 38 50

For the platforms, type is not present, and category is:
Screen Shot 2022-08-29 at 13 39 46

This is not working correctly; see JSON above.

@cmaglie
Copy link
Member Author

cmaglie commented Aug 29, 2022

@kittaakos
I've renamed category field to type so the meaning matches on both platform and libraries. Also the type has been changed from string to []string.

@cmaglie cmaglie changed the title Added Category field to Platform gRPC struct Added ~Category~ Types field to Platform gRPC struct Aug 29, 2022
@cmaglie cmaglie changed the title Added ~Category~ Types field to Platform gRPC struct Added Types field to Platform gRPC struct Aug 29, 2022
@cmaglie cmaglie changed the title Added Types field to Platform gRPC struct Added Type field to Platform gRPC struct Aug 29, 2022
Copy link
Contributor

@kittaakos kittaakos left a comment

Choose a reason for hiding this comment

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

I tried the functionality from arduino/arduino-ide#1361. The Type and Topic filters work as in IDE (1.x).

Thank you for the support!

@kittaakos kittaakos self-requested a review August 30, 2022 09:59
@cmaglie cmaglie merged commit 05d1446 into arduino:master Aug 30, 2022
@cmaglie cmaglie deleted the new_grpc_field_in_platform branch August 30, 2022 10:01
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
topic: code Related to content of the project itself topic: gRPC Related to the gRPC interface type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants