inform clients of retry attempts

stripe · Oct 15, 2019 · 0cec4d6 · 0cec4d6
1 parent 8278b83
commit 0cec4d6
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/lib/HttpClient/CurlClient.php b/lib/HttpClient/CurlClient.php
@@ -281,6 +281,7 @@ private function executeRequestWithRetries($opts, $absUrl)
             if ($this->shouldRetry($errno, $rcode, $rheaders, $numRetries)) {
                 $numRetries += 1;
                 $sleepSeconds = $this->sleepTime($numRetries, $rheaders);
+                Stripe::informOfRetry($numRetries);
                 usleep(intval($sleepSeconds * 1000000));
             } else {
                 break;

diff --git a/lib/Stripe.php b/lib/Stripe.php
@@ -58,6 +58,9 @@ class Stripe
     // @var float Initial delay between retries, in seconds
     private static $initialNetworkRetryDelay = 0.5;
 
+    // @var callable|null A callback to inform when we attempt a retry.
+    public static $retryInformCallback;
+
     const VERSION = '7.3.1';
 
     /**
@@ -273,4 +276,32 @@ public static function setEnableTelemetry($enableTelemetry)
     {
         self::$enableTelemetry = $enableTelemetry;
     }
+
+    /**
+     * @return callable|null
+     */
+    public static function getRetryInformCallback()
+    {
+        return self::$retryInformCallback;
+    }
+
+    /**
+     * @param callable $retryInformCallback
+     */
+    public static function setRetryInformCallback(callable $retryInformCallback)
+    {
+        self::$retryInformCallback = $retryInformCallback;
+    }
+
+    /**
+     * If a client registered a callback to inform them of retries, call to inform.
+     * @param int $retryAttempt
+     */
+    public static function informOfRetry($retryAttempt)
+    {
+        if (!is_callable(self::$retryInformCallback)) {
+            return;
+        }
+        call_user_func_array(self::$retryInformCallback, [$retryAttempt]);
+    }
 }