Mediawiki\Api\Guzzle\MiddlewareFactory

Complexity

Total Complexity

15

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	5

Test Coverage

Coverage

92.45%

Importance

Changes	2
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	setLogger()	0	3	1
A	retry()	0	3	1
C	newRetryDecider()	0	72	12

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

	/**
	 * @return callable
	 */
	public function retry() {
		return Middleware::retry( $this->newRetryDecider() );
	}

	/**
	 * @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()

It seems like $exception is not always an object, but can also be of type null. Maybe add an additional type check?

					)
				);
			}

			return $shouldRetry;
		};
	}

}