Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Include params set in provide-client-param event handlers in dynamic context params for endpoint resolution #2920

Merged
merged 7 commits into from
May 11, 2023
5 changes: 5 additions & 0 deletions .changes/next-release/bugfix-endpoints-38658.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"type": "bugfix",
"category": "endpoints",
"description": "Include params set in provide-client-param event handlers in dynamic context params for endpoint resolution."
}
9 changes: 5 additions & 4 deletions botocore/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -819,7 +819,6 @@ def _resolve_signature_version(self, service_name, resolved):


class BaseClient:

dlm6693 marked this conversation as resolved.
Show resolved Hide resolved
# This is actually reassigned with the py->op_name mapping
# when the client creator creates the subclass. This value is used
# because calls such as client.get_paginator('list_objects') use the
Expand Down Expand Up @@ -913,6 +912,11 @@ def _make_api_call(self, operation_name, api_params):
'has_streaming_input': operation_model.has_streaming_input,
'auth_type': operation_model.auth_type,
}
api_params = self._emit_api_params(
api_params=api_params,
operation_model=operation_model,
context=request_context,
)
Comment on lines +915 to +919
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe this could be called from within _resolve_endpoint_ruleset at the very start of it? I'm thinking in purely organizational terms just because _make_api_call is a rather long, complex function already.

endpoint_url, additional_headers = self._resolve_endpoint_ruleset(
operation_model, api_params, request_context
)
Expand Down Expand Up @@ -984,9 +988,6 @@ def _convert_to_request_dict(
headers=None,
set_user_agent_header=True,
):
api_params = self._emit_api_params(
api_params, operation_model, context
)
request_dict = self._serializer.serialize_to_request(
api_params, operation_model
)
Expand Down
13 changes: 10 additions & 3 deletions botocore/signers.py
Original file line number Diff line number Diff line change
Expand Up @@ -656,14 +656,18 @@ def generate_presigned_url(
raise UnknownClientMethodError(method_name=client_method)

operation_model = self.meta.service_model.operation_model(operation_name)
params = self._emit_api_params(
api_params=params,
operation_model=operation_model,
context=context,
)
bucket_is_arn = ArnParser.is_arn(params.get('Bucket', ''))
endpoint_url, additional_headers = self._resolve_endpoint_ruleset(
operation_model,
params,
context,
ignore_signing_region=(not bucket_is_arn),
)

dlm6693 marked this conversation as resolved.
Show resolved Hide resolved
request_dict = self._convert_to_request_dict(
api_params=params,
operation_model=operation_model,
Expand Down Expand Up @@ -778,15 +782,18 @@ def generate_presigned_post(
# We choose the CreateBucket operation model because its url gets
# serialized to what a presign post requires.
operation_model = self.meta.service_model.operation_model('CreateBucket')
params = {'Bucket': bucket}
params = self._emit_api_params(
api_params={'Bucket': bucket},
operation_model=operation_model,
context=context,
)
bucket_is_arn = ArnParser.is_arn(params.get('Bucket', ''))
endpoint_url, additional_headers = self._resolve_endpoint_ruleset(
operation_model,
params,
context,
ignore_signing_region=(not bucket_is_arn),
)

request_dict = self._convert_to_request_dict(
api_params=params,
operation_model=operation_model,
Expand Down
41 changes: 40 additions & 1 deletion tests/functional/test_context_params.py
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ def test_client_context_param_sent_to_endpoint_resolver(
),
)

# Stub client to prevent a request from getting sent and asceertain that
# Stub client to prevent a request from getting sent and ascertain that
# only a single request would get sent. Wrap the EndpointProvider's
# resolve_endpoint method for inspecting the arguments it gets called with.
with ClientHTTPStubber(client, strict=True) as http_stubber:
Expand Down Expand Up @@ -488,3 +488,42 @@ def test_dynamic_context_param_sent_to_endpoint_resolver(
)
else:
mock_resolve_endpoint.assert_called_once_with(Region='us-east-1')


def test_dynamic_context_param_from_event_handler_sent_to_endpoint_resolver(
monkeypatch,
patched_session,
):
# patch loader to return fake service model and fake endpoint ruleset
patch_load_service_model(
patched_session,
monkeypatch,
FAKE_MODEL_WITH_DYNAMIC_CONTEXT_PARAM,
FAKE_RULESET_WITH_DYNAMIC_CONTEXT_PARAM,
)

# event handler for provide-client-params that modifies the value of the
# MockOpParam parameter
def change_param(params, **kwargs):
params['MockOpParam'] = 'mock-op-param-value-2'

client = patched_session.create_client(
'otherservice', region_name='us-east-1'
)
client.meta.events.register_last(
'provide-client-params.other-service.*', change_param
)

with ClientHTTPStubber(client, strict=True) as http_stubber:
http_stubber.add_response(status=200)
with mock.patch.object(
client._ruleset_resolver._provider,
'resolve_endpoint',
wraps=client._ruleset_resolver._provider.resolve_endpoint,
) as mock_resolve_endpoint:
client.mock_operation(MockOpParam='mock-op-param-value-1')

mock_resolve_endpoint.assert_called_once_with(
Region='us-east-1',
FooDynamicContextParamName='mock-op-param-value-2',
)
31 changes: 31 additions & 0 deletions tests/unit/test_signers.py
Original file line number Diff line number Diff line change
Expand Up @@ -991,6 +991,37 @@ def test_generate_presign_url_emits_is_presign_in_context(self):
'the following kwargs emitted: %s' % kwargs,
)

def test_context_param_from_event_handler_sent_to_endpoint_resolver(self):
def change_bucket_param(params, **kwargs):
params['Bucket'] = 'mybucket-bar'

self.client.meta.events.register_last(
'provide-client-params.s3.*', change_bucket_param
)

self.client.generate_presigned_url(
'get_object', Params={'Bucket': 'mybucket-foo', 'Key': self.key}
)

ref_request_dict = {
'body': b'',
# If the bucket name set in the provide-client-params event handler
# was correctly passed to the endpoint provider as a dynamic context
# parameter, it will appear in the URL and the auth_path:
'url': 'https://mybucket-bar.s3.amazonaws.com/mykey',
'headers': {},
'auth_path': '/mybucket-bar/mykey',
'query_string': {},
'url_path': '/mykey',
'method': 'GET',
'context': mock.ANY,
}
self.generate_url_mock.assert_called_with(
request_dict=ref_request_dict,
expires_in=3600,
operation_name='GetObject',
)


class TestGeneratePresignedPost(unittest.TestCase):
def setUp(self):
Expand Down