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
|
<?php
namespace Mediawiki\Api\Guzzle;
use GuzzleHttp\Exception\ConnectException;
use GuzzleHttp\Exception\RequestException;
use GuzzleHttp\Middleware;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Response;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
/**
* @access private
*
* @author Addshore
*/
class MiddlewareFactory implements LoggerAwareInterface {
/**
* @var LoggerInterface
*/
private $logger;
public function __construct() {
$this->logger = new NullLogger();
}
/**
* @param LoggerInterface $logger The new Logger object.
*/
public function setLogger( LoggerInterface $logger ) {
$this->logger = $logger;
}
/**
* @access private
*
* @param bool $delay default to true, can be false to speed up tests
*
* @return callable
*/
public function retry( $delay = true ) {
if ( $delay ) {
return Middleware::retry( $this->newRetryDecider(), $this->getRetryDelay() );
} else {
return Middleware::retry( $this->newRetryDecider() );
}
}
/**
* Returns a method that takes the number of retries and returns the number of miliseconds
* to wait
*
* @return callable
*/
private function getRetryDelay() {
return function ( $numberOfRetries, Response $response = null ) {
// The $response argument is only passed as of Guzzle 6.2.2.
if ( $response !== null ) {
// Retry-After may be a number of seconds or an absolute date (RFC 7231,
// section 7.1.3).
$retryAfter = $response->getHeaderLine( 'Retry-After' );
if ( is_numeric( $retryAfter ) ) {
return 1000 * $retryAfter;
}
if ( $retryAfter ) {
$seconds = strtotime( $retryAfter ) - time();
return 1000 * max( 1, $seconds );
}
}
return 1000 * $numberOfRetries;
};
}
/**
* @return callable
*/
private function newRetryDecider() {
return function (
$retries,
Request $request,
Response $response = null,
RequestException $exception = null
) {
// Don't retry if we have run out of retries
if ( $retries >= 5 ) {
return false;
}
$shouldRetry = false;
// Retry connection exceptions
if ( $exception instanceof ConnectException ) {
$shouldRetry = true;
}
if ( $response ) {
$data = json_decode( $response->getBody(), true );
// Retry on server errors
if ( $response->getStatusCode() >= 500 ) {
$shouldRetry = true;
}
foreach ( $response->getHeader( 'Mediawiki-Api-Error' ) as $mediawikiApiErrorHeader ) {
if (
// Retry if the API explicitly tells us to:
// https://www.mediawiki.org/wiki/Manual:Maxlag_parameter
$response->getHeaderLine( 'Retry-After' )
||
// Retry if we have a response with an API error worth retrying
in_array(
$mediawikiApiErrorHeader,
[
'ratelimited',
'maxlag',
'readonly',
'internal_api_error_DBQueryError',
]
)
||
// Or if we have been stopped from saving as an 'anti-abuse measure'
// Note: this tries to match "actionthrottledtext" i18n messagae for mediawiki
(
$mediawikiApiErrorHeader == 'failed-save' &&
strstr( $data['error']['info'], 'anti-abuse measure' )
)
) {
$shouldRetry = true;
}
}
}
// Log if we are retrying
if ( $shouldRetry ) {
$this->logger->warning(
sprintf(
'Retrying %s %s %s/5, %s',
$request->getMethod(),
$request->getUri(),
$retries + 1,
$response ? 'status code: ' . $response->getStatusCode() :
$exception->getMessage()
)
);
}
return $shouldRetry;
};
}
}
|
