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

Improve OperationInternalBase #26962

Closed
wants to merge 1 commit into from

Conversation

Yao725
Copy link
Member

@Yao725 Yao725 commented Feb 11, 2022

Part of Azure/autorest.csharp#1965

All SDK Contribution checklist:

This checklist is used to make sure that common guidelines for a pull request are followed.

  • Please open PR in Draft mode if it is:
    • Work in progress or not intended to be merged.
    • Encountering multiple pipeline failures and working on fixes.
  • If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above.
  • I have read the contribution guidelines.
  • The pull request does not introduce breaking changes.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

SDK Generation Guidelines

  • The generate.cmd file for the SDK has been updated with the version of AutoRest, as well as the commitid of your swagger spec or link to the swagger spec, used to generate the code. (Track 2 only)
  • The *.csproj and AssemblyInfo.cs files have been updated with the new version of the SDK. Please double check nuget.org current release version.

Additional management plane SDK specific contribution checklist:

Note: Only applies to Microsoft.Azure.Management.[RP] or Azure.ResourceManager.[RP]

  • Include updated management metadata.
  • Update AzureRP.props to add/remove version info to maintain up to date API versions.

Management plane SDK Troubleshooting

  • If this is very first SDK for a services and you are adding new service folders directly under /SDK, please add new service label and/or contact assigned reviewer.

  • If the check fails at the Verify Code Generation step, please ensure:

    • Do not modify any code in generated folders.
    • Do not selectively include/remove generated files in the PR.
    • Do use generate.ps1/cmd to generate this PR instead of calling autorest directly.
      Please pay attention to the @microsoft.csharp version output after running generate.ps1. If it is lower than current released version (2.3.82), please run it again as it should pull down the latest version.

    Note: We have recently updated the PSH module called by generate.ps1 to emit additional data. This would help reduce/eliminate the Code Verification check error. Please run following command:

      `dotnet msbuild eng/mgmt.proj /t:Util /p:UtilityName=InstallPsModules`
    

Old outstanding PR cleanup

Please note:
If PRs (including draft) has been out for more than 60 days and there are no responses from our query or followups, they will be closed to maintain a concise list for our reviewers.

Copy link
Member

@annelo-msft annelo-msft left a comment

Choose a reason for hiding this comment

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

This LGTM - I'll let @AlexanderSher or other Core owner give a second opinion to approve.

@@ -137,6 +137,10 @@ protected OperationInternalBase(ClientDiagnostics clientDiagnostics, Response ra
/// <exception cref="RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
public virtual async ValueTask<Response> WaitForCompletionResponseAsync(TimeSpan pollingInterval, CancellationToken cancellationToken)
{
if (HasCompleted)
{
return RawResponse;
Copy link
Member

Choose a reason for hiding this comment

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

Should we validate that RawResponse is set first?

@@ -137,6 +137,10 @@ protected OperationInternalBase(ClientDiagnostics clientDiagnostics, Response ra
/// <exception cref="RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
public virtual async ValueTask<Response> WaitForCompletionResponseAsync(TimeSpan pollingInterval, CancellationToken cancellationToken)
{
if (HasCompleted)
Copy link
Member

Choose a reason for hiding this comment

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

Let's add a test for this

@AlexanderSher
Copy link
Contributor

AlexanderSher commented Feb 11, 2022

Approach isn't thread-safe. RawResponse is not guaranteed (right now) to have the same response as the one that has set the operation in a completed state. See the discussion: #19105 (comment)

@Yao725, what issue are you trying to resolve with this change?

@Yao725
Copy link
Member Author

Yao725 commented Feb 14, 2022

@AlexanderSher I'm trying to avoid redundant service call and json serialization failure when the customer sets the waitForCompletion parameter to true but still call the method WaitForCompletion by themselves.

Do we have any plan to make RawResponse thread-safe in short term? If not, I'd like to close this PR and just make a minor change in autorest side to avoid serialization failure.

@AlexanderSher
Copy link
Contributor

@Yao725 This isn't that easy to make RawResponse thread-safe without a sacrifice (see the thread I've attached), so let's proceed with the change in autorest instead. Can you please add me to that PR when it is ready?

Thank you!

@AlexanderSher
Copy link
Contributor

Closing in favor of #28375

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

Successfully merging this pull request may close these issues.

4 participants