I know this is on the To

Dedicated Exception for RateLimit reached and return of Retry-After value about moneybird-php-client HOT 2 CLOSED

picqer commented on July 19, 2024

Dedicated Exception for RateLimit reached and return of Retry-After value

from moneybird-php-client.

Comments (2)

holtkamp commented on July 19, 2024

It seems that in some cases, the TooManyRequestsException is not thrown properly. I "think" this is a problem at the MoneyBird API side, but wanted to report it here to be able to discuss it. The stack trace:

In Connection.php line 423:
                                                               
  [Picqer\Financials\Moneybird\Exceptions\ApiException (429)]  
  Error 429: <html>                                            
  <head><title>429 Too Many Requests</title></head>            
  <body bgcolor="white">                                       
  <center><h1>429 Too Many Requests</h1></center>              
  <hr><center>nginx</center>                                   
  </body>                                                      
  </html>                                                      
                                                               

Exception trace:
 Picqer\Financials\Moneybird\Connection->parseExceptionForErrorMessages() at /app/vendor/picqer/moneybird-php-client/src/Picqer/Financials/Moneybird/Connection.php:229
 Picqer\Financials\Moneybird\Connection->patch() at /app/vendor/picqer/moneybird-php-client/src/Picqer/Financials/Moneybird/Actions/Storable.php:38
 Picqer\Financials\Moneybird\Entities\Contact->update() at /app/vendor/picqer/moneybird-php-client/src/Picqer/Financials/Moneybird/Actions/Storable.php:16
...
...

This

moneybird-php-client/src/Picqer/Financials/Moneybird/Connection.php

Line 423 in 3a55186

 throw new ApiException('Error ' . $response->getStatusCode() . ': ' . $errorMessage, $response->getStatusCode()); 

indicates that the error is not properly detected here:

moneybird-php-client/src/Picqer/Financials/Moneybird/Connection.php

Lines 434 to 443 in 3a55186

 private function checkWhetherRateLimitHasBeenReached(ResponseInterface $response, $errorMessage) 

 { 

 $retryAfterHeaders = $response->getHeader('Retry-After'); 

 if($response->getStatusCode() === 429 && count($retryAfterHeaders) > 0){ 

 $exception = new TooManyRequestsException('Error ' . $response->getStatusCode() . ': ' . $errorMessage, $response->getStatusCode()); 

 $exception->retryAfterNumberOfSeconds = (int) current($retryAfterHeaders); 

 throw $exception; 

 } 

 }

This happens "sometimes"... In other occasions / when running the same command a few minutes later, the error IS detected and a TooManyRequestsException is thrown:

 Error 429: Retry later : 
#0 /app/vendor/picqer/moneybird-php-client/src/Picqer/Financials/Moneybird/Connection.php(421): Picqer\Financials\Moneybird\Connection->checkWhetherRateLimitHasBeenReached(Object(GuzzleHttp\Psr7\Response), 'Retry later\n') 
#1 /app/vendor/picqer/moneybird-php-client/src/Picqer/Financials/Moneybird/Connection.php(193): Picqer\Financials\Moneybird\Connection->parseExceptionForErrorMessages(Object(GuzzleHttp\Exception\ClientException)) 
#2 /app/vendor/picqer/moneybird-php-client/src/Picqer/Financials/Moneybird/Entities/Contact.php(83): Picqer\Financials\Moneybird\Connection->get('contacts/custom...')

I got the idea that "sometimes" the response does not contain the Retry-After header...

Will contact the MoneyBird team to discuss this.

from moneybird-php-client.

holtkamp commented on July 19, 2024

Nevermind, it appeared that the TooManyRequestsExceptionwas not processed properly in our userland code. 🤦‍♂️

Current approach seems to work nicely:

        /**
     * @see https://developer.moneybird.com/#responses
     * @see https://developer.moneybird.com/#throttling
     *
     * @param ApiException $apiException
     *
     * @throws ApiException
     */
    public function processApiException(ApiException $apiException): void
    {
        $this->logger->error($apiException->getMessage().': '.$apiException->getTraceAsString());

        if ($apiException instanceof TooManyRequestsException) {
            Assertion::integer($apiException->retryAfterNumberOfSeconds, 'unable to determine number of seconds to sleep');

            $this->logger->info('API request limit reached: sleep the indicated amount of {retryAfterNumberOfSeconds} seconds', array('retryAfterNumberOfSeconds' => $apiException->retryAfterNumberOfSeconds));

            \sleep($apiException->retryAfterNumberOfSeconds);

            $this->logger->info('done sleeping, the API should be available for requests again');

            return;
        }

        throw $apiException;
    }

from moneybird-php-client.

Dedicated Exception for RateLimit reached and return of Retry-After value about moneybird-php-client HOT 2 CLOSED

Comments (2)

Related Issues (20)

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

	private function checkWhetherRateLimitHasBeenReached(ResponseInterface $response, $errorMessage)
	{
	$retryAfterHeaders = $response->getHeader('Retry-After');
	if($response->getStatusCode() === 429 && count($retryAfterHeaders) > 0){
	$exception = new TooManyRequestsException('Error ' . $response->getStatusCode() . ': ' . $errorMessage, $response->getStatusCode());
	$exception->retryAfterNumberOfSeconds = (int) current($retryAfterHeaders);

	throw $exception;
	}
	}