Skip to content

Commit 389c7a0

Browse files
committed
Fix #8596: do not mutate caller's Filters in SecretsProvider.get_multiple
1 parent bdd370b commit 389c7a0

2 files changed

Lines changed: 56 additions & 5 deletions

File tree

‎aws_lambda_powertools/utilities/parameters/secrets.py‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -153,12 +153,10 @@ def _get_multiple(self, names: list[str], **sdk_options) -> dict[str, Any]: # t
153153
"""
154154

155155
# Merge filters: combine names with any additional filters from sdk_options
156-
filters = sdk_options.get("Filters", [])
156+
# without mutating the caller's Filters list (a copy avoids appending the
157+
# name filter to a shared/module-level list on every call)
157158
name_filter = {"Key": "name", "Values": names}
158-
159-
# Add name filter to existing filters
160-
filters.append(name_filter)
161-
sdk_options["Filters"] = filters
159+
sdk_options["Filters"] = [*sdk_options.get("Filters", []), name_filter]
162160

163161
# Remove SecretIdList if present to avoid conflicts
164162
sdk_options.pop("SecretIdList", None)

‎tests/functional/parameters/_boto3/test_utilities_parameters.py‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3103,6 +3103,59 @@ def test_secrets_provider_get_multiple_basic(config):
31033103
stubber.deactivate()
31043104

31053105

3106+
def test_secrets_provider_get_multiple_does_not_mutate_caller_filters(config):
3107+
"""
3108+
Test SecretsProvider.get_multiple() leaves the caller's Filters list untouched
3109+
"""
3110+
# GIVEN a SecretsProvider instance
3111+
provider = parameters.SecretsProvider(boto_config=config)
3112+
3113+
# GIVEN a shared Filters list, as used in the documentation example
3114+
my_filters = [{"Key": "primary-region", "Values": ["us-east-1"]}]
3115+
3116+
# Stub the boto3 client with two paginated-free responses, one per call
3117+
stubber = stub.Stubber(provider.client)
3118+
response_a = {
3119+
"SecretValues": [
3120+
{
3121+
"Name": "a",
3122+
"SecretString": "1",
3123+
},
3124+
],
3125+
"Errors": [],
3126+
}
3127+
expected_params_a = {
3128+
"Filters": [*my_filters, {"Key": "name", "Values": ["a"]}],
3129+
}
3130+
stubber.add_response("batch_get_secret_value", response_a, expected_params_a)
3131+
3132+
response_b = {
3133+
"SecretValues": [
3134+
{
3135+
"Name": "b",
3136+
"SecretString": "2",
3137+
},
3138+
],
3139+
"Errors": [],
3140+
}
3141+
expected_params_b = {
3142+
"Filters": [*my_filters, {"Key": "name", "Values": ["b"]}],
3143+
}
3144+
stubber.add_response("batch_get_secret_value", response_b, expected_params_b)
3145+
stubber.activate()
3146+
3147+
try:
3148+
# WHEN calling get_multiple twice with the same Filters list
3149+
assert provider.get_multiple(["a"], Filters=my_filters) == {"a": "1"}
3150+
assert provider.get_multiple(["b"], Filters=my_filters) == {"b": "2"}
3151+
stubber.assert_no_pending_responses()
3152+
3153+
# THEN the caller's list must not have grown stale name filters
3154+
assert my_filters == [{"Key": "primary-region", "Values": ["us-east-1"]}]
3155+
finally:
3156+
stubber.deactivate()
3157+
3158+
31063159
def test_secrets_provider_get_multiple_with_binary(config):
31073160
"""
31083161
Test SecretsProvider.get_multiple() with binary secrets

0 commit comments

Comments
 (0)