summaryrefslogtreecommitdiff
path: root/bin/reevotech/vendor/addwiki/mediawiki-api-base/tests/Unit/Guzzle/MiddlewareFactoryTest.php
blob: 1cf7270addd04473c18ea34448b2ad47889d9d16 (plain)
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
210
211
212
213
214
<?php

namespace Mediawiki\Api\Test\Unit\Guzzle;

use GuzzleHttp\Client;
use GuzzleHttp\Exception\ConnectException;
use GuzzleHttp\Handler\MockHandler;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Response;
use Mediawiki\Api\Guzzle\MiddlewareFactory;

/**
 * @author Addshore
 *
 * @todo test interaction with logger
 *
 * @covers Mediawiki\Api\Guzzle\MiddlewareFactory
 */
class MiddlewareFactoryTest extends \PHPUnit_Framework_TestCase {

	public function testRetriesConnectException() {
		$queue = [
			new ConnectException( 'Error 1', new Request( 'GET', 'test' ) ),
			new Response( 200, [ 'X-Foo' => 'Bar' ] ),
		];

		$client = $this->getClient( $queue, $delays );
		$response = $client->request( 'GET', '/' );

		$this->assertEquals( 200, $response->getStatusCode() );
		$this->assertEquals( [ 1000 ], $delays );
	}

	public function testRetries500Errors() {
		$queue = [
			new Response( 500 ),
			new Response( 200 ),
		];

		$client = $this->getClient( $queue, $delays );
		$response = $client->request( 'GET', '/' );

		$this->assertEquals( 200, $response->getStatusCode() );
		$this->assertEquals( [ 1000 ], $delays );
	}

	public function testRetriesSomeMediawikiApiErrorHeaders() {
		$queue = [
			new Response( 200, [ 'mediawiki-api-error' => 'ratelimited' ] ),
			new Response( 200, [ 'mediawiki-api-error' => 'maxlag' ] ),
			new Response( 200, [ 'mediawiki-api-error' => 'readonly' ] ),
			new Response( 200, [ 'mediawiki-api-error' => 'internal_api_error_DBQueryError' ] ),
			new Response( 200, [ 'mediawiki-api-error' => 'DoNotRetryThisHeader' ] ),
		];

		$client = $this->getClient( $queue, $delays );
		$response = $client->request( 'GET', '/' );

		$this->assertEquals( 200, $response->getStatusCode() );
		$this->assertEquals(
			[ 'DoNotRetryThisHeader' ],
			$response->getHeader( 'mediawiki-api-error' )
		);
		$this->assertEquals( [ 1000, 2000, 3000, 4000 ], $delays );
	}

	public function testRetryAntiAbuseMeasure() {
		$antiAbusejson = json_encode(
			[
				'error' => [
					'info' => 'anti-abuse measure'
				]
			]
		);

		$queue = [
			new Response( 200, [ 'mediawiki-api-error' => 'failed-save' ], $antiAbusejson ),
			new Response( 200, [ 'mediawiki-api-error' => 'DoNotRetryThisHeader' ] ),
		];

		$client = $this->getClient( $queue, $delays );
		$response = $client->request( 'GET', '/' );

		$this->assertEquals( 200, $response->getStatusCode() );
		$this->assertEquals( 'DoNotRetryThisHeader', $response->getHeaderLine( 'mediawiki-api-error' ) );
	}

	public function testRetryLimit() {
		$queue = [
			new ConnectException( 'Error 1', new Request( 'GET', 'test' ) ),
			new ConnectException( 'Error 2', new Request( 'GET', 'test' ) ),
			new ConnectException( 'Error 3', new Request( 'GET', 'test' ) ),
			new ConnectException( 'Error 4', new Request( 'GET', 'test' ) ),
			new ConnectException( 'Error 5', new Request( 'GET', 'test' ) ),
			new ConnectException( 'Error 6', new Request( 'GET', 'test' ) ),
			new Response( 200 ),
		];

		$client = $this->getClient( $queue );

		$this->setExpectedException(
			'GuzzleHttp\Exception\ConnectException',
			'Error 6'
		);

		$client->request( 'GET', '/' );
	}

	public function testConnectExceptionRetryDelay() {
		$queue = [
			new ConnectException( '+1 second delay', new Request( 'GET', 'test' ) ),
			new ConnectException( '+2 second delay', new Request( 'GET', 'test' ) ),
			new Response( 200 ),
		];

		$client = $this->getClient( $queue, $delays );
		$response = $client->request( 'GET', '/' );

		$this->assertEquals( 200, $response->getStatusCode() );
		$this->assertEquals( [ 1000, 2000 ], $delays );
	}

	public function testServerErrorRetryDelay() {
		$queue = [
			new Response( 500 ),
			new Response( 503 ),
			new Response( 200 ),
		];

		$client = $this->getClient( $queue, $delays );
		$response = $client->request( 'GET', '/' );

		$this->assertEquals( 200, $response->getStatusCode() );
		$this->assertEquals( [ 1000, 2000 ], $delays );
	}

	public function testRelativeRetryDelayHeaderRetryDelay() {
		$queue = [
			new Response( 200, [ 'mediawiki-api-error' => 'maxlag', 'retry-after' => 10 ] ),
			new Response( 200 ),
		];

		$this->getClient( $queue, $delays )->request( 'GET', '/' );

		$this->assertEquals( [ 10000 ], $delays );
	}

	public function testAbsoluteRetryDelayHeaderRetryDelay() {
		$queue = [
			new Response(
				200,
				[
					'mediawiki-api-error' => 'maxlag',
					'retry-after' => gmdate( DATE_RFC1123, time() + 600 ),
				]
			),
			new Response( 200 ),
		];

		$client = $this->getClient( $queue, $delays );
		$response = $client->request( 'GET', '/' );

		$this->assertEquals( 200, $response->getStatusCode() );
		$this->assertCount( 1, $delays );
		// Allow 5 second delay while running this test.
		$this->assertGreaterThan( 600000 - 5000, $delays[0] );
	}

	public function testPastRetryDelayHeaderRetryDelay() {
		$queue = [
			new Response(
				200,
				[
					'mediawiki-api-error' => 'maxlag',
					'retry-after' => 'Fri, 31 Dec 1999 23:59:59 GMT',
				]
			),
			new Response( 200 ),
		];

		$client = $this->getClient( $queue, $delays );
		$response = $client->request( 'GET', '/' );

		$this->assertEquals( 200, $response->getStatusCode() );
		$this->assertEquals( [ 1000 ], $delays );
	}

	private function getClient( array $queue, &$delays = null ) {
		$mock = new MockHandler( $queue );

		$handler = HandlerStack::create( $mock );

		$middlewareFactory = new MiddlewareFactory();
		$handler->push( $middlewareFactory->retry() );

		$delayMocker = $this->getDelayMocker( $delays );
		$handler->push( $delayMocker );

		return new Client( [ 'handler' => $handler ] );
	}

	private function getDelayMocker( &$delays ) {
		return function ( callable $handler ) use ( &$delays ) {
			return function ( $request, array $options ) use ( $handler, &$delays ) {
				if ( isset( $options['delay'] ) ) {
					$delays[] = $options['delay'];
					unset( $options['delay'] );
				}
				return $handler( $request, $options );
			};
		};
	}
}