ASD-1325 Validate region in Client constructor#56
Open
dimadidr wants to merge 1 commit into
Open
Conversation
This file contains hidden or 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
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.
Validate region in Client constructor
Problem
Client::__construct()maps the region without validating it first (Amazon/Pay/API/Client.php:52, v2.7.0 and current master):If config['region'] is null, missing, or not a known region, on PHP 8.1+ this emits:
and the client is still constructed - with a null region - so the real failure surfaces later, at the first API call. On setups where error handlers escalate deprecations/warnings to exceptions, the strtolower() deprecation masks the real configuration problem.
Minimal repro:
new Amazon\Pay\API\Client(['region' => null, 'sandbox' => true]);Fix
Validate the region before mapping and throw a descriptive exception (consistent with the constructor's existing config validation):
Uncaught Exception: Expecting config['region'] to be one of: eu, de, uk, us, na, jp
Covers null, missing, and unmapped values (e.g. 'mars'). Valid regions are unaffected; case-insensitive mapping is preserved (US → na, de → eu).
Note this is a behavior change for misconfigured clients: construction now fails fast with a catchable \Exception instead of succeeding and failing at the first API call.
Context
Found while investigating amzn/amazon-payments-magento-2-plugin#1300 - in the Magento module, a store scope with no Amazon Pay region configured hits this on every adapter call.
Thanks @KathiD303 for the original report.