Skip to content

fix: handle plain-text throttle responses in Invoke-AzSpotPlacementScore#29388

Open
khang-11 wants to merge 1 commit intoAzure:mainfrom
khang-11:fix/spot-placement-score-throttle-handling
Open

fix: handle plain-text throttle responses in Invoke-AzSpotPlacementScore#29388
khang-11 wants to merge 1 commit intoAzure:mainfrom
khang-11:fix/spot-placement-score-throttle-handling

Conversation

@khang-11
Copy link
Copy Markdown

Summary

  • When Invoke-AzSpotPlacementScore receives a throttled HTTP 429 response with a plain-text body (e.g. You are being throttled), the autorest-generated client crashes with Expected '{' or '['. Was String: You. because JsonNode.Parse() is called unconditionally on the response body regardless of content type.
  • Wrap all FromJson(JsonNode.Parse(...)) call sites in Compute.cs with try/catch so that unparseable bodies return null instead of throwing. The existing onDefault handler already falls back to a RestException using the raw response body as the message when code/message are null, so the user now sees the actual throttle message rather than a parse exception.
  • Add playback test cases for Invoke-AzSpotPlacementScore covering 429 with a Retry-After header and 429 without, asserting that no JSON parse exception is surfaced.

Test coverage

Test What it covers
ThrottledWithRetryAfter 429 + plain-text body + Retry-After header → no parse crash
ThrottledWithoutRetryAfter 429 + plain-text body + no Retry-After header → no parse crash

Notes

  • The fix is applied to all _Call methods in Compute.cs (not just SpotPlacement) since the same parse pattern is repeated for every API in the generated file and any of them could receive a plain-text throttle body.
  • ISendAsync.cs retry middleware (Retry429, RetryError) is unchanged.

When the Compute API returns HTTP 429 with a plain-text body (e.g.
'You are being throttled') instead of JSON, the autorest-generated
client would crash with 'Expected { or [. Was String: You.' because
JsonNode.Parse() was called unconditionally on the response body.

Wrap all FromJson(JsonNode.Parse(...)) call sites in Compute.cs with
try/catch so that unparseable bodies return null. The existing onDefault
handler already falls back to a RestException with the raw response body
as the message when code/message are null, so the user now sees the
actual plain-text error instead of a parse exception stack trace.

Also add playback test cases covering 429 with and without Retry-After
headers to verify no JSON parse exception is thrown.
Copilot AI review requested due to automatic review settings April 10, 2026 04:57
@azure-client-tools-bot-prd
Copy link
Copy Markdown

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

@khang-11
Copy link
Copy Markdown
Author

Fixes: #28765

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR addresses a failure mode in the Compute AutoRest client where plain-text HTTP 429 throttling responses cause JsonNode.Parse() to throw, preventing Invoke-AzSpotPlacementScore from surfacing the actual throttling message to users.

Changes:

  • Wrap AutoRest model deserialization (FromJson(JsonNode.Parse(...))) in generated/api/Compute.cs to avoid throwing on non-JSON response bodies.
  • Add Pester playback tests for Invoke-AzSpotPlacementScore covering throttled 429 responses with and without Retry-After.
  • Extend the SpotPlacementScore recording file with 429 plain-text response entries.

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.

File Description
src/Compute/Compute.Autorest/test/Invoke-AzSpotPlacementScore.Tests.ps1 Adds playback Pester tests for 429 throttling scenarios to ensure no JSON parse exception leaks.
src/Compute/Compute.Autorest/test/Invoke-AzSpotPlacementScore.Recording.json Adds recorded 429 responses with text/plain bodies (with/without Retry-After).
generated/Compute/Compute.Autorest/generated/api/Compute.cs Makes deserialization tolerant of non-JSON bodies by catching parse failures and returning null.

Comment on lines +42 to +56
{
Invoke-AzSpotPlacementScore -Location eastus -DesiredCount $desiredCount -DesiredLocation $desiredLocations -DesiredSize $desiredSizes
} | Should -Throw
$Error[0].Exception.Message | Should -Not -Match "Expected '\{' or '\['"
$Error[0].Exception.Message | Should -Not -BeNullOrEmpty
}

It 'ThrottledWithoutRetryAfter' {
# When the API returns 429 with a plain-text body and no Retry-After header,
# the cmdlet should surface a clean error message (not a JSON parse exception).
{
Invoke-AzSpotPlacementScore -Location eastus -DesiredCount $desiredCount -DesiredLocation $desiredLocations -DesiredSize $desiredSizes
} | Should -Throw
$Error[0].Exception.Message | Should -Not -Match "Expected '\{' or '\['"
$Error[0].Exception.Message | Should -Not -BeNullOrEmpty
Copy link

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

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

The throttling tests assert on $Error[0] after Should -Throw. $Error is global state and can contain errors from previous tests, and Pester may not populate it reliably for terminating exceptions. Capture the thrown error explicitly (e.g., Should -Throw -PassThru or a try/catch that stores $_) and assert on that object instead; also consider adding -ErrorAction Stop to the cmdlet invocation so the failure is always terminating for the test.

Suggested change
{
Invoke-AzSpotPlacementScore -Location eastus -DesiredCount $desiredCount -DesiredLocation $desiredLocations -DesiredSize $desiredSizes
} | Should -Throw
$Error[0].Exception.Message | Should -Not -Match "Expected '\{' or '\['"
$Error[0].Exception.Message | Should -Not -BeNullOrEmpty
}
It 'ThrottledWithoutRetryAfter' {
# When the API returns 429 with a plain-text body and no Retry-After header,
# the cmdlet should surface a clean error message (not a JSON parse exception).
{
Invoke-AzSpotPlacementScore -Location eastus -DesiredCount $desiredCount -DesiredLocation $desiredLocations -DesiredSize $desiredSizes
} | Should -Throw
$Error[0].Exception.Message | Should -Not -Match "Expected '\{' or '\['"
$Error[0].Exception.Message | Should -Not -BeNullOrEmpty
$thrownError = {
Invoke-AzSpotPlacementScore -Location eastus -DesiredCount $desiredCount -DesiredLocation $desiredLocations -DesiredSize $desiredSizes -ErrorAction Stop
} | Should -Throw -PassThru
$thrownError.Exception.Message | Should -Not -Match "Expected '\{' or '\['"
$thrownError.Exception.Message | Should -Not -BeNullOrEmpty
}
It 'ThrottledWithoutRetryAfter' {
# When the API returns 429 with a plain-text body and no Retry-After header,
# the cmdlet should surface a clean error message (not a JSON parse exception).
$thrownError = {
Invoke-AzSpotPlacementScore -Location eastus -DesiredCount $desiredCount -DesiredLocation $desiredLocations -DesiredSize $desiredSizes -ErrorAction Stop
} | Should -Throw -PassThru
$thrownError.Exception.Message | Should -Not -Match "Expected '\{' or '\['"
$thrownError.Exception.Message | Should -Not -BeNullOrEmpty

Copilot uses AI. Check for mistakes.
Comment on lines +15 to +22
"Response": {
"StatusCode": 429,
"Headers": {
"Retry-After": [ "0" ],
"x-ms-request-id": [ "throttled-request-id-with-retry-after" ],
"x-ms-correlation-request-id": [ "throttled-correlation-id-with-retry-after" ],
"Date": [ "Thu, 24 Jul 2025 08:10:33 GMT" ]
},
Copy link

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

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

ThrottledWithRetryAfter uses a recording that includes a Retry-After header. The generated Retry429 middleware retries whenever Retry-After is present (even when it is 0), so playback will likely attempt multiple POSTs and expect additional +2, +3, … entries in the recording (or can loop until the mock runs out). Either disable 429 retries for this test run via AZURE_PS_HTTP_MAX_RETRIES_FOR_429 (and potentially AZURE_PS_HTTP_MAX_RETRIES) or extend the recording with the expected retry sequence (e.g., first response with Retry-After, then a terminal response without it).

Copilot uses AI. Check for mistakes.
@khang-11
Copy link
Copy Markdown
Author

/azp run

@azure-pipelines
Copy link
Copy Markdown
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@VeryEarly VeryEarly self-assigned this Apr 13, 2026
@microsoft-github-policy-service
Copy link
Copy Markdown
Contributor

@khang-11 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

@VeryEarly
Copy link
Copy Markdown
Collaborator

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants