{Test} Skip email replacer if the request body is not string#31829
Merged
{Test} Skip email replacer if the request body is not string#31829
Conversation
… could be a zip file
evelyn-ys
requested review from
bebound,
jiasli,
jsntcy,
kairu-ms and
wangzelin007
as code owners
️✔️AzureCLI-FullTest
|
️✔️AzureCLI-BreakingChangeTest
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the email replacer in process_request to skip non-string bodies and avoid UnicodeDecodeError when processing binary payloads.
- Wraps the body replacement in a
try/exceptto catch decoding errors. - Leaves the request body unchanged if it cannot be decoded as UTF-8.
Comments suppressed due to low confidence (1)
src/azure-cli-testsdk/azure/cli/testsdk/utilities.py:226
- Add a unit test for the case where
request.bodyis binary or contains invalid UTF-8 to verify that the UnicodeDecodeError is caught and the replacement is skipped.
try:
| if request.body: | ||
| body = _byte_to_str(request.body) | ||
| request.body = self._replace_email_address(body) | ||
| try: |
There was a problem hiding this comment.
[nitpick] Consider checking isinstance(request.body, bytes) before decoding instead of using exception handling for control flow, which makes the logic clearer and avoids the cost of catching exceptions.
Collaborator
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
wangzelin007
approved these changes
Jul 17, 2025
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.
Related command
Description
There could be some cases that request body is not string (for example a zip file). EmailReplacer will fail on
_byte_to_strwithUnicodeDecodeError. In such case, there's no need to replace anything so skipping EmailReplacer directlyTesting Guide
History Notes
[Component Name 1] BREAKING CHANGE:
az command a: Make some customer-facing breaking change[Component Name 2]
az command b: Add some customer-facing featureThis checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.