RetryMiddleware.php
6.13 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
<?php
namespace Aws;
use Aws\Exception\AwsException;
use Exception;
use Psr\Http\Message\RequestInterface;
use GuzzleHttp\Promise;
use GuzzleHttp\Promise\PromiseInterface;
use GuzzleHttp\Psr7;
/**
* @internal Middleware that retries failures.
*/
class RetryMiddleware
{
private static $retryStatusCodes = [
500 => true,
502 => true,
503 => true,
504 => true
];
private static $retryCodes = [
// Throttling error
'RequestLimitExceeded' => true,
'Throttling' => true,
'ThrottlingException' => true,
'ProvisionedThroughputExceededException' => true,
'RequestThrottled' => true,
'BandwidthLimitExceeded' => true,
];
private $decider;
private $delay;
private $nextHandler;
private $collectStats;
public function __construct(
callable $decider,
callable $delay,
callable $nextHandler,
$collectStats = false
) {
$this->decider = $decider;
$this->delay = $delay;
$this->nextHandler = $nextHandler;
$this->collectStats = (bool) $collectStats;
}
/**
* Creates a default AWS retry decider function.
*
* @param int $maxRetries
*
* @return callable
*/
public static function createDefaultDecider($maxRetries = 3)
{
return function (
$retries,
CommandInterface $command,
RequestInterface $request,
ResultInterface $result = null,
$error = null
) use ($maxRetries) {
// Allow command-level options to override this value
$maxRetries = null !== $command['@retries'] ?
$command['@retries']
: $maxRetries;
if ($retries >= $maxRetries) {
return false;
} elseif (!$error) {
return isset(self::$retryStatusCodes[$result['@metadata']['statusCode']]);
} elseif (!($error instanceof AwsException)) {
return false;
} elseif ($error->isConnectionError()) {
return true;
} elseif (isset(self::$retryCodes[$error->getAwsErrorCode()])) {
return true;
} elseif (isset(self::$retryStatusCodes[$error->getStatusCode()])) {
return true;
} else {
return false;
}
};
}
/**
* Delay function that calculates an exponential delay.
*
* Exponential backoff with jitter, 100ms base, 20 sec ceiling
*
* @param $retries
*
* @return int
*/
public static function exponentialDelay($retries)
{
return mt_rand(0, (int) min(20000, (int) pow(2, $retries - 1) * 100));
}
/**
* @param CommandInterface $command
* @param RequestInterface $request
*
* @return PromiseInterface
*/
public function __invoke(
CommandInterface $command,
RequestInterface $request = null
) {
$retries = 0;
$requestStats = [];
$handler = $this->nextHandler;
$decider = $this->decider;
$delay = $this->delay;
$request = $this->addRetryHeader($request, 0, 0);
$g = function ($value) use (
$handler,
$decider,
$delay,
$command,
$request,
&$retries,
&$requestStats,
&$g
) {
$this->updateHttpStats($value, $requestStats);
if ($value instanceof \Exception) {
if (!$decider($retries, $command, $request, null, $value)) {
return \GuzzleHttp\Promise\rejection_for(
$this->bindStatsToReturn($value, $requestStats)
);
}
} elseif ($value instanceof ResultInterface
&& !$decider($retries, $command, $request, $value, null)
) {
return $this->bindStatsToReturn($value, $requestStats);
}
// Delay fn is called with 0, 1, ... so increment after the call.
$delayBy = $delay($retries++);
$command['@http']['delay'] = $delayBy;
if ($this->collectStats) {
$this->updateStats($retries, $delayBy, $requestStats);
}
// Update retry header with retry count and delayBy
$request = $this->addRetryHeader($request, $retries, $delayBy);
return $handler($command, $request)->then($g, $g);
};
return $handler($command, $request)->then($g, $g);
}
private function addRetryHeader($request, $retries, $delayBy)
{
return $request->withHeader('aws-sdk-retry', "{$retries}/{$delayBy}");
}
private function updateStats($retries, $delay, array &$stats)
{
if (!isset($stats['total_retry_delay'])) {
$stats['total_retry_delay'] = 0;
}
$stats['total_retry_delay'] += $delay;
$stats['retries_attempted'] = $retries;
}
private function updateHttpStats($value, array &$stats)
{
if (empty($stats['http'])) {
$stats['http'] = [];
}
if ($value instanceof AwsException) {
$resultStats = isset($value->getTransferInfo('http')[0])
? $value->getTransferInfo('http')[0]
: [];
$stats['http'] []= $resultStats;
} elseif ($value instanceof ResultInterface) {
$resultStats = isset($value['@metadata']['transferStats']['http'][0])
? $value['@metadata']['transferStats']['http'][0]
: [];
$stats['http'] []= $resultStats;
}
}
private function bindStatsToReturn($return, array $stats)
{
if ($return instanceof ResultInterface) {
if (!isset($return['@metadata'])) {
$return['@metadata'] = [];
}
$return['@metadata']['transferStats'] = $stats;
} elseif ($return instanceof AwsException) {
$return->setTransferInfo($stats);
}
return $return;
}
}