refactor(http): refactor http client to accept more customisable options #2414
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit updates the arguments for the `CreateHTTPClient` function to consume a struct which can be extended as required. It replaces the certPath argument with a struct of 3 paths for client ertificate, client key, and ca cert. It also adds a TLSEnabled option for when an HTTP Client is required without any further TLS config. Existing consumers of this function have been updated so that they can work as they do today. This change is a no-op for existing features. This allows for certificate paths to be customised and allows other modules to re-use the same HTTP client and get the benefits of mTLS support and per-host certificates. Signed-off-by: Vishwas Rajashekar <vrajashe@cisco.com>
vrajashkr
force-pushed
the
refactor/http-client
branch
from
b1cd6c3
to
b4de28b
Compare
|
I hit an error in the earlier run with this message: This was due to a mistake I made in I've fixed that. Hopefully the tests go through completely this time round. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2414 +/- ##
=======================================
Coverage 92.86% 92.86%
=======================================
Files 167 167
Lines 22060 22077 +17
=======================================
+ Hits 20485 20502 +17
Misses 982 982
Partials 593 593 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
refactor
Which issue does this PR fix:
N/A
What does this PR do / Why do we need it:
This PR refactors the
CreateHTTPClientfunction to take in a more customisable set of options for certificates and TLS. This is needed as we would like to re-use the same for scale out proxy which also needs the same functionality to automatically inherit per-host certificates and mTLS support. It also provides flexibility to allow users to customise the name and path for certificates for the sync feature in future.If an issue # is not available please add repro steps and logs showing the issue:
Not a bug, but a helpful enhancement for the scale-out feature #2385
The feature requires use of functionalities such as per-host certificates and mTLS support.
Testing done on this change:
Existing tests should pass and new unit tests added. There should be no functional impact due to the change.
Automation added to e2e:
N/A
Will this break upgrades or downgrades?
No. This is a refactor which is expected to maintain the original behaviour.
Does this PR introduce any user-facing change?:
N/A
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.