nozzlegear / ShopifySharp

ShopifySharp is a .NET library that helps developers easily authenticate with and manage Shopify stores.
https://nozzlegear.com/shopify-development-handbook
MIT License
743 stars 309 forks source link

Update retry policy name in README to reflect current version of library #923

Closed Terit closed 1 year ago

Terit commented 1 year ago

When I attempted to implement a global retry policy I couldn't figure out why the README's code wasn't working so I went looking for the SmartRetryExecutionPolicy in the codebase only to find issue #853.

I've updated the README to reference the replacement policy. I didn't dig into LeakyBucketExecutionPolicy to see if the second statement about infinite retries still applies or not.

Keep in mind that the RetryExecutionPolicy and the LeakyBucketExecutionPolicy will keep retrying your requests – potentially until the end of time – until they are successful. It's up to you to ensure that such a strategy won't impact the performance of your applications.

nozzlegear commented 1 year ago

Good catch, thanks! The docs are desperately in need of an update. I keep telling myself I want to put together a nice website and Github wiki for them, but I have never managed to find the time to do that.

As far as the infinite retries thing, I believe that's still correct for the Leaky Bucket policy.

clement911 commented 1 year ago

It's still correct indeed, but it only retries for rate limit errors. If any other type of error is encountered, the error bubbles up immediately as an exception.