Deprecate old TEdgeConfig

[didier-wenzek]

Proposed changes

• Deprecate old TEdgeConfig::mqtt_config
• Remove remaining use of the old TEdgeConfig
• Remove all the settings definitions
• Remove old TEdgeConfig
• Rename new::TEdgeConfig as TEdgeConfig

Types of changes

• Bugfix (non-breaking change which fixes an issue)
• 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

#2019

Checklist

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

Further comments

[github-actions]

Robot Results

✅ Passed	❌ Failed	⏭️ Skipped	Total	Pass %
251	0	5	251	100

[codecov]

Codecov Report

Merging #2143 (9b9c474) into main (339d536) will increase coverage by 1.0%.
Report is 4 commits behind head on main.
The diff coverage is 84.4%.

❗ Current head 9b9c474 differs from pull request most recent head 3fc6e72. Consider uploading reports for the commit 3fc6e72 to get more accurate results

Additional details and impacted files

Files Changed	Coverage Δ
crates/bin/c8y-device-management/src/main.rs	0.0% <0.0%> (ø)
crates/common/tedge_config/src/lib.rs	0.0% <0.0%> (ø)
crates/common/tedge_config/src/mqtt_config.rs	0.0% <ø> (ø)
...edge_config/src/tedge_config_cli/config_setting.rs	0.0% <ø> (-36.4%)	⬇️
crates/core/tedge/src/cli/certificate/cli.rs	57.1% <0.0%> (ø)
crates/core/tedge/src/cli/config/cli.rs	76.6% <0.0%> (ø)
crates/core/tedge/src/cli/config/commands/list.rs	92.2% <ø> (ø)
crates/core/tedge/src/cli/connect/command.rs	0.0% <0.0%> (ø)
crates/core/tedge/src/cli/connect/jwt_token.rs	51.2% <ø> (ø)
crates/core/tedge/src/cli/init.rs	0.0% <0.0%> (ø)
... and 39 more

... and 12 files with indirect coverage changes

[didier-wenzek]

This needs to be deprecated as using a default location.

This is used in a single place: crates/core/tedge/src/cli/certificate/upload.rs.

I will fix that in a follow-up PR.

[didier-wenzek]

There is no more points to have a struct TEdgeConfigRepository as this is now just a TEdgeConfigLocation with a load() method.

I will fix that in a follow-up PR.

[Bravo555]

Given how many times the load() method is called (24 times in 23 files), we probably have multiple copies of TEdgeConfig per process. We could lazily initialize it and only return a reference to the single instance. The struct is not very large, so it's not a big problem, but perhaps this will be easier to do sooner rather than later.

[didier-wenzek]

Given how many times the load() method is called (24 times in 23 files), we probably have multiple copies of TEdgeConfig per process. We could lazily initialize it and only return a reference to the single instance. The struct is not very large, so it's not a big problem, but perhaps this will be easier to do sooner rather than later.

Added to #2153

[reubenmiller]

@didier-wenzek you'll have to rebase from main to fix the workflow failures (due to the changes introduced in #2138)

[Bravo555]

Can the remaining defaults not be removed as well?

[didier-wenzek]

Yes indeed.

• The first 3 are no more used => removed
• The two latter are related to the file-transfer service => moved them to tedge_api.

[Bravo555]

Given how many times the load() method is called (24 times in 23 files), we probably have multiple copies of TEdgeConfig per process. We could lazily initialize it and only return a reference to the single instance. The struct is not very large, so it's not a big problem, but perhaps this will be easier to do sooner rather than later.