rina23q commented 4 months ago

Proposed changes

Todo:

[x] Update all affected unit tests by this change (3764aa78b9df2c52727b43f3d8fa731b9b52215d)
[x] Clarify two design decisions all regarding
[x] Try the usecase: child metadata has the leadService field
[x] Add dedicated unit tests for this feature
[x] Add dedicated robot tests for this feature
[x] Update the code according to the @health design
[ ] Doc, probably in different PR as this PR is already huge

"Lead Service" design decisions The "lead service" is meant to which service status tedge-mapper-c8y looks up to judge if the device is "available" or not.

By default, using te/device/{device_name}/service/tedge-agent/status/health
Can be customerized by device registration message with @health key. For example, Topic: te/device/{device_name}//
```
{
"@health": "can/be/any/custom/topic"
}
```
If the health status is not reported to the given topic@health, tedge-mapper-c8y logs it as info and not sending a heartbeat.
If the given topic is invalid as MQTT topic, tedge-mapper-c8y logs it as info and not sending a heartbeat.

Types of changes

[ ] Bugfix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
[ ] Documentation Update (if none of the other choices apply)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue

2842

Checklist

[x] I have read the CONTRIBUTING doc
[x] I have signed the CLA (in all commits with git commit -s)
[x] I ran cargo fmt as mentioned in CODING_GUIDELINES
[x] I used cargo clippy as mentioned in CODING_GUIDELINES
[x] I have added tests that prove my fix is effective or that my feature works
[ ] I have added necessary documentation (if appropriate)

Further comments

codecov[bot] commented 4 months ago

Codecov Report

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

Project coverage is 78.2%. Comparing base (644cd6f) to head (a802e6a). Report is 19 commits behind head on main.

:exclamation: Current head a802e6a differs from pull request most recent head 4ea0722

Please upload reports for the commit 4ea0722 to get more accurate results.

Additional details and impacted files

| [Files](https://app.codecov.io/gh/thin-edge/thin-edge.io/pull/2866?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thin-edge) | Coverage Δ | | |---|---|---| | [crates/core/c8y\_api/src/smartrest/inventory.rs](https://app.codecov.io/gh/thin-edge/thin-edge.io/pull/2866?src=pr&el=tree&filepath=crates%2Fcore%2Fc8y_api%2Fsrc%2Fsmartrest%2Finventory.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thin-edge#diff-Y3JhdGVzL2NvcmUvYzh5X2FwaS9zcmMvc21hcnRyZXN0L2ludmVudG9yeS5ycw==) | `61.6% <100.0%> (+4.8%)` | :arrow_up: | | [crates/extensions/c8y\_mapper\_ext/src/lib.rs](https://app.codecov.io/gh/thin-edge/thin-edge.io/pull/2866?src=pr&el=tree&filepath=crates%2Fextensions%2Fc8y_mapper_ext%2Fsrc%2Flib.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thin-edge#diff-Y3JhdGVzL2V4dGVuc2lvbnMvYzh5X21hcHBlcl9leHQvc3JjL2xpYi5ycw==) | `88.8% <ø> (ø)` | | | [...es/extensions/c8y\_mapper\_ext/src/operations/mod.rs](https://app.codecov.io/gh/thin-edge/thin-edge.io/pull/2866?src=pr&el=tree&filepath=crates%2Fextensions%2Fc8y_mapper_ext%2Fsrc%2Foperations%2Fmod.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thin-edge#diff-Y3JhdGVzL2V4dGVuc2lvbnMvYzh5X21hcHBlcl9leHQvc3JjL29wZXJhdGlvbnMvbW9kLnJz) | `92.5% <100.0%> (ø)` | | | [...s/extensions/c8y\_mapper\_ext/src/service\_monitor.rs](https://app.codecov.io/gh/thin-edge/thin-edge.io/pull/2866?src=pr&el=tree&filepath=crates%2Fextensions%2Fc8y_mapper_ext%2Fsrc%2Fservice_monitor.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thin-edge#diff-Y3JhdGVzL2V4dGVuc2lvbnMvYzh5X21hcHBlcl9leHQvc3JjL3NlcnZpY2VfbW9uaXRvci5ycw==) | `96.4% <100.0%> (+<0.1%)` | :arrow_up: | | [...s/c8y\_mapper\_ext/src/operations/firmware\_update.rs](https://app.codecov.io/gh/thin-edge/thin-edge.io/pull/2866?src=pr&el=tree&filepath=crates%2Fextensions%2Fc8y_mapper_ext%2Fsrc%2Foperations%2Ffirmware_update.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thin-edge#diff-Y3JhdGVzL2V4dGVuc2lvbnMvYzh5X21hcHBlcl9leHQvc3JjL29wZXJhdGlvbnMvZmlybXdhcmVfdXBkYXRlLnJz) | `90.5% <94.7%> (-0.2%)` | :arrow_down: | | [...nsions/c8y\_mapper\_ext/src/operations/log\_upload.rs](https://app.codecov.io/gh/thin-edge/thin-edge.io/pull/2866?src=pr&el=tree&filepath=crates%2Fextensions%2Fc8y_mapper_ext%2Fsrc%2Foperations%2Flog_upload.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thin-edge#diff-Y3JhdGVzL2V4dGVuc2lvbnMvYzh5X21hcHBlcl9leHQvc3JjL29wZXJhdGlvbnMvbG9nX3VwbG9hZC5ycw==) | `89.9% <80.0%> (-0.5%)` | :arrow_down: | | [.../tedge\_config/src/tedge\_config\_cli/tedge\_config.rs](https://app.codecov.io/gh/thin-edge/thin-edge.io/pull/2866?src=pr&el=tree&filepath=crates%2Fcommon%2Ftedge_config%2Fsrc%2Ftedge_config_cli%2Ftedge_config.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thin-edge#diff-Y3JhdGVzL2NvbW1vbi90ZWRnZV9jb25maWcvc3JjL3RlZGdlX2NvbmZpZ19jbGkvdGVkZ2VfY29uZmlnLnJz) | `76.4% <72.7%> (-0.1%)` | :arrow_down: | | [...ates/extensions/c8y\_mapper\_ext/src/availability.rs](https://app.codecov.io/gh/thin-edge/thin-edge.io/pull/2866?src=pr&el=tree&filepath=crates%2Fextensions%2Fc8y_mapper_ext%2Fsrc%2Favailability.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thin-edge#diff-Y3JhdGVzL2V4dGVuc2lvbnMvYzh5X21hcHBlcl9leHQvc3JjL2F2YWlsYWJpbGl0eS5ycw==) | `97.9% <97.9%> (ø)` | | | [crates/extensions/c8y\_mapper\_ext/src/config.rs](https://app.codecov.io/gh/thin-edge/thin-edge.io/pull/2866?src=pr&el=tree&filepath=crates%2Fextensions%2Fc8y_mapper_ext%2Fsrc%2Fconfig.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thin-edge#diff-Y3JhdGVzL2V4dGVuc2lvbnMvYzh5X21hcHBlcl9leHQvc3JjL2NvbmZpZy5ycw==) | `47.6% <44.4%> (-0.2%)` | :arrow_down: | | [crates/extensions/c8y\_mapper\_ext/src/converter.rs](https://app.codecov.io/gh/thin-edge/thin-edge.io/pull/2866?src=pr&el=tree&filepath=crates%2Fextensions%2Fc8y_mapper_ext%2Fsrc%2Fconverter.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thin-edge#diff-Y3JhdGVzL2V4dGVuc2lvbnMvYzh5X21hcHBlcl9leHQvc3JjL2NvbnZlcnRlci5ycw==) | `84.0% <91.7%> (+0.3%)` | :arrow_up: | | ... and [2 more](https://app.codecov.io/gh/thin-edge/thin-edge.io/pull/2866?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thin-edge) | | ... and [11 files with indirect coverage changes](https://app.codecov.io/gh/thin-edge/thin-edge.io/pull/2866/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thin-edge)

github-actions[bot] commented 4 months ago

Robot Results

:white_check_mark: Passed	:x: Failed	:next_track_button: Skipped	Total	Pass %	:stopwatch: Duration
443	0	3	443	100	1h9m43.004998s

rina23q commented 4 months ago

Move to draft status as I'm planning to re-write code from scratch. However, it's worth keeping unclosed until the whole work is done in order to keep the conversation history.

didier-wenzek commented 2 months ago

Closing as addressed by https://github.com/thin-edge/thin-edge.io/pull/2940

thin-edge / thin-edge.io

Support Cumulocity Device Availability #2866