Implement configured endpoint url resolver #2958
Merged
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
kdaily
force-pushed
the
implement-configured-endpoint-url-resolver
branch
2 times, most recently
from
906b678
to
d597716
Compare
kyleknap
reviewed
May 30, 2023
There was a problem hiding this comment.
Implementation looks fine. Just had some comments. It would be nice if we can get the unit tests included as part of this PR and we can add the functional tests in a subsequent PR. Mainly it is going to be easier to review the unit tests while looking over all of the classes/interfaces that we are adding.
botocore/configprovider.py
Outdated
| @@ -510,6 +517,116 @@ def set_config_provider(self, logical_name, provider): | |||
| self._mapping[logical_name] = provider | |||
|
|
|||
|
|
|||
| class ConfiguredEndpointProviderChain: | |||
There was a problem hiding this comment.
In using the approach of making the logic a provider let's:
- Rename this class to
ConfiguredEndpointProvider. Ending it inProvidermakes it clear this is a provider class. Also the wordChainnow conflates with theChainProviderand makes sense to get rid of its usage since it does not subclass fromChainProvider. - Make sure this class subclasses from the
BaseProviderclass and implements any of the shared methods as (e.g.__deepcopy__and__repr__) - Consider documenting that users should not be instantiating this class directly and that it is not supported in case we ever want to refactor the initializer arguments for the class.
- Add unit tests for this class
There was a problem hiding this comment.
Added __deepcopy__ method, but __repr__ is tricky. Other config providers have succinct string-based parameters because they also take a session object, so can initialize other objects internally. The init params for ConfiguredEndpointProvider are all potentially large dictionaries.
kdaily
force-pushed
the
implement-configured-endpoint-url-resolver
branch
3 times, most recently
from
e0ff128
to
3b55e1d
Compare
Codecov ReportPatch coverage:
❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more. Additional details and impacted files@@ Coverage Diff @@
## configured-endpoint-urls #2958 +/- ##
============================================================
- Coverage 93.32% 93.32% -0.01%
============================================================
Files 64 64
Lines 13597 13662 +65
============================================================
+ Hits 12690 12750 +60
- Misses 907 912 +5
☔ View full report in Codecov by Sentry. |
kdaily
commented
Jun 5, 2023
kdaily
commented
Jun 6, 2023
kdaily
force-pushed
the
implement-configured-endpoint-url-resolver
branch
2 times, most recently
from
bbc2d5e
to
610ce31
Compare
dlm6693
suggested changes
Jun 9, 2023
kdaily
force-pushed
the
implement-configured-endpoint-url-resolver
branch
from
93df202
to
0aebebf
Compare
|
any news, guys?) |
kdaily
commented
Jun 12, 2023
dlm6693
reviewed
Jun 12, 2023
kyleknap
reviewed
Jun 12, 2023
kdaily
force-pushed
the
implement-configured-endpoint-url-resolver
branch
3 times, most recently
from
9b82ed3
to
659df5e
Compare
kyleknap
reviewed
Jun 14, 2023
kyleknap
reviewed
Jun 14, 2023
kyleknap
approved these changes
Jun 14, 2023
Adds a config provider to resolve the endpoint URL provided in an environment variable or shared configuration file. It resolves the endpoint in the following manner: 1. The value provided through the `endpoint_url` parameter provided to the client constructor. 2. The value provided by a service-specific environment variable. 3. The value provided by the global endpoint environment variable (`AWS_ENDPOINT_URL`). 4. The value provided by a service-specific parameter from a services definition section in the shared configuration file. 5. The value provided by the global parameter from a services definition section in the shared configuration file. 6. The value resolved when no configured endpoint URL is provided. The endpoint config provider uses the client name (name used to instantiate a client object) for construction and add to the config value store. This uses multiple lookups to handle service name changes for backwards compatibility.
kdaily
force-pushed
the
implement-configured-endpoint-url-resolver
branch
from
3a58267
to
ba4264f
Compare
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.
Adds a config provider to resolve the endpoint URL provided in an environment variable or shared configuration file. It resolves the endpoint in the following manner:
endpoint_urlparameter provided to the client constructor.AWS_ENDPOINT_URL).