MiddlewareFactory::getRetryDelay() - Code Metrics - Inspection of "Add delay between retried requests" - addwiki/mediawiki-api-base - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b50b89...16e7f7 )

by adam

created 2015-12-18 22:44 UTC

MiddlewareFactory::getRetryDelay() A

↳ Parent: MiddlewareFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	5
ccs	3
cts	3
cp	1
rs	9.4286
cc	1
eloc	3
nc	1
nop	0
crap	1

<?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();
	}

	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 ) {
			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 ) {
				$headers = $response->getHeaders();
				$data = json_decode( $response->getBody(), true );

				// Retry on server errors
				if( $response->getStatusCode() >= 500 ) {
					$shouldRetry = true;
				}

				if ( array_key_exists( 'mediawiki-api-error', $headers ) ) {
					foreach( $headers['mediawiki-api-error'] as $mediawikiApiErrorHeader ) {
						if (
							// Retry if we have a response with an API error worth retrying
							in_array(
								$mediawikiApiErrorHeader,
								array(
									'ratelimited',
									'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()
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
					)
				);
			}

			return $shouldRetry;
		};
	}

}


1		<?php
2
3		namespace Mediawiki\Api\Guzzle;
4
5		use GuzzleHttp\Exception\ConnectException;
6		use GuzzleHttp\Exception\RequestException;
7		use GuzzleHttp\Middleware;
8		use GuzzleHttp\Psr7\Request;
9		use GuzzleHttp\Psr7\Response;
10		use Psr\Log\LoggerAwareInterface;
11		use Psr\Log\LoggerInterface;
12		use Psr\Log\NullLogger;
13
14		/**
15		* @access private
16		*
17		* @author Addshore
18		*/
19		class MiddlewareFactory implements LoggerAwareInterface {
20
21		/**
22		* @var LoggerInterface
23		*/
24		private $logger;
25
26	6	public function __construct() {
27	6	$this->logger = new NullLogger();
28	6	}
29
30		public function setLogger( LoggerInterface $logger ) {
31		$this->logger = $logger;
32		}
33
34		/**
35		* @access private
36		*
37		* @param bool $delay default to true, can be false to speed up tests
38		*
39		* @return callable
40		*/
41	6	public function retry( $delay = true ) {
42	6	if( $delay ) {
43	1	return Middleware::retry( $this->newRetryDecider(), $this->getRetryDelay() );
44		} else {
45	5	return Middleware::retry( $this->newRetryDecider() );
46		}
47		}
48
49		/**
50		* Returns a method that takes the number of retries and returns the number of miliseconds
51		* to wait
52		*
53		* @return callable
54		*/
55	1	private function getRetryDelay() {
56		return function( $numberOfRetries ) {
57	1	return 1000 * $numberOfRetries;
58	1	};
59		}
60
61		/**
62		* @return callable
63		*/
64		private function newRetryDecider() {
65	6	return function (
66		$retries,
67		Request $request,
68		Response $response = null,
69		RequestException $exception = null
70		) {
71		// Don't retry if we have run out of retries
72	6	if ( $retries >= 5 ) {
73	1	return false;
74		}
75
76	6	$shouldRetry = false;
77
78		// Retry connection exceptions
79	6	if( $exception instanceof ConnectException ) {
80	3	$shouldRetry = true;
81	3	}
82
83	6	if( $response ) {
84	5	$headers = $response->getHeaders();
85	5	$data = json_decode( $response->getBody(), true );
86
87		// Retry on server errors
88	5	if( $response->getStatusCode() >= 500 ) {
89	1	$shouldRetry = true;
90	1	}
91
92	5	if ( array_key_exists( 'mediawiki-api-error', $headers ) ) {
93	2	foreach( $headers['mediawiki-api-error'] as $mediawikiApiErrorHeader ) {
94		if (
95		// Retry if we have a response with an API error worth retrying
96	2	in_array(
97	2	$mediawikiApiErrorHeader,
98		array(
99	2	'ratelimited',
100	2	'readonly',
101	2	'internal_api_error_DBQueryError',
102		)
103	2	)
104		\|\|
105		// Or if we have been stopped from saving as an 'anti-abuse measure'
106		// Note: this tries to match "actionthrottledtext" i18n messagae for mediawiki
107		(
108	2	$mediawikiApiErrorHeader == 'failed-save' &&
109	1	strstr( $data['error']['info'], 'anti-abuse measure' )
110	1	)
111	2	) {
112	2	$shouldRetry = true;
113	2	}
114
115	2	}
116	2	}
117	5	}
118
119		// Log if we are retrying
120	6	if( $shouldRetry ) {
121	6	$this->logger->warning(
122	6	sprintf(
123	6	'Retrying %s %s %s/5, %s',
124	6	$request->getMethod(),
125	6	$request->getUri(),
126	6	$retries + 1,
127	6	$response ? 'status code: ' . $response->getStatusCode() :
128	3	$exception->getMessage()
		0 ignored issues – show Bug introduced 2015-12-17 21:50 UTC by Report Bug Copy Issue Report It seems like `$exception` is not always an object, but can also be of type `null`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
129	6	)
130	6	);
131	6	}
132
133	6	return $shouldRetry;
134	6	};
135		}
136
137		}
138

addwiki / mediawiki-api-base

Push — master ( b50b89...16e7f7 )

MiddlewareFactory::getRetryDelay() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like