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

Use interfaces for Polly retry policies in C# #20821

Merged

Conversation

jacobilsoe
Copy link
Contributor

This enables use of Polly.ResiliencePipelineBuilder where the built Polly.ResiliencePipeline returns an interface when using properties AsSyncPolicy or AsAsyncPolicy.

@mandrean @shibayan @Blackclaws @lucamazzanti @iBicha

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

This enables use of ResiliencePipelineBuilder which returns the
interface when calling AsSyncPolicy / AsAsyncPolicy
@wing328
Copy link
Member

wing328 commented Mar 8, 2025

@jacobilsoe thanks for the PR

is this change backward compatible?

@jacobilsoe
Copy link
Contributor Author

jacobilsoe commented Mar 9, 2025

@jacobilsoe thanks for the PR

is this change backward compatible?

@wing328 Well, that depends on what you mean by backwards compatible. 😃

Policy/AsyncPolicy implements ISyncPolicy/IAsyncPolicy so in that way the change is backwards compatible.

But if someone uses members of e.g. the Policy class that are not in the ISyncPolicy interface they will get a compile error.

However, the intention of the RetryPolicy/AsyncRetryPolicy properties is for users to set them, not get them. Right?

@wing328
Copy link
Member

wing328 commented Mar 12, 2025

thanks for the details and pointing out edge cases in which this may break users applications using the C# SDKs.

i would go ahead with this change and if someone needs a way to rollback, we will consider providing one.

@wing328 wing328 merged commit 7f40ce0 into OpenAPITools:master Mar 12, 2025
45 checks passed
@wing328
Copy link
Member

wing328 commented Mar 12, 2025

thank for the PR, which has been merged.

have a good week ahead.

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.

2 participants