christeredvartsen

Simple retry strategy for Guzzle 7

APIs might implement rate limiting, and if they do your clients might experience 429 Too Many Requests responses with a Retry-After header, informing your client how long it should wait before making the next request. And being good internet citizens we should all implement support for this in our API clients.

Guzzle includes a retry middleware class that can be used to handle this.

The implementation in this gist is a PoC, so feel free to build upon it, and comment if you think something should be added / removed.

christeredvartsen

<?= sprintf('::set-output name=var::%s', json_encode([
    [
        'id' => 'bar',
        'name' => 'foo',
    ],
    [
        'id' => 'bar2',
        'name' => 'foo2',
    ],
]));

christeredvartsen

name: Commit from workflow
on:
  push:
    branches:
      - master
    paths-ignore:
      - file.txt
jobs:
  build:
    runs-on: ubuntu-latest

christeredvartsen

name: Do some stuff
on: [push]
jobs:
  test:
    name: Do some stuff
    runs-on: ubuntu-latest
    steps:
      - name: Check API rate limit
        run: |
          curl -s "https://api.github.com/rate_limit" -H "Authorization: token $GITHUB_TOKEN"

christeredvartsen

<?php declare(strict_types=1);
namespace App;

use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\ResponseInterface as Response;
use Slim\Psr7\Response as BaseResponse;
use Slim\Psr7\Cookies;
use Psr\Http\Message\ServerRequestInterface as Request;
use Slim\Factory\AppFactory;

christeredvartsen

<?php
use Imbo\BehatApiExtension\Context\ApiContext;
use Behat\Testwork\Hook\Scope\BeforeSuiteScope;
use Behat\Testwork\Hook\Scope\AfterSuiteScope;
use SebastianBergmann\CodeCoverage;
use GuzzleHttp\ClientInterface;
use GuzzleHttp\Middleware;
use Psr\Http\Message\RequestInterface;

class FeatureContext extends ApiContext {

christeredvartsen

<?php
$client = new MongoClient();
$client->selectDB('test')->drop();
$collection = $client->selectCollection('test', 'image');
$collection->createIndex(
    ['user' => 1, 'imageIdentifier' => 1],
    ['unique' => true]
);
$collection->insert([
    'user' => 'christer',

christeredvartsen

<?php
// $builder is an instance of Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition
$builder
  ->children()
    ->arrayNode('params')
      ->info('Arbitrary key => value configuration')
      ->useAttributeAsKey('name')
      ->prototype('scalar')->end()
    ->end()
  ->end();

christeredvartsen

<?php
class SomeClass { public function someMethod() {} }

class SomeClassTest extends PHPUnit_Framework_TestCase {
    public function testSomeMethod() {
        $someValue = ' ... ';
        
        $mock = $this->createMock('SomeClass');
        $mock
            ->expects($this->once())

christeredvartsen

<?php
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Middleware;
use GuzzleHttp\Client;
use Psr\Http\Message\RequestInterface;

// Create a default stack
$stack = HandlerStack::create();

// Create the middleware