F/retry function wrapper (#47)

* disable apigen

* implement RetryFunctionWrapper

Author: Mararok

.travis.yml

@@ -17,8 +17,8 @@ script:
 - vendor/phpunit/phpunit/phpunit --coverage-clover build/logs/clover.xml
 after_script:
 - vendor/bin/test-reporter
-after_success:
-- bash .travis_after_success.sh
+#after_success:
+#- bash .travis_after_success.sh
 addons:
  code_climate:
   repo_token: "$CODECLIMATE_TOKEN"

composer.json

@@ -13,9 +13,6 @@
     "mockery/mockery": "1.1.*",
     "codeclimate/php-test-reporter": "dev-master",
     "mikey179/vfsStream": "1.6.*",
-    "apigen/apigen": "dev-master",
-    "phpdocumentor/reflection-docblock": "4.1.*",
-    "roave/better-reflection": "dev-master#c87d856",
     "guzzlehttp/guzzle": "~6.0",
     "nannehuiges/jsend": "2.1.*",
     "monolog/monolog": "1.*",

src/SAREhub/Commons/Misc/RetryFunctionWrapper.php

@@ -0,0 +1,96 @@
+<?php
+
+
+namespace SAREhub\Commons\Misc;
+
+
+class RetryFunctionWrapper
+{
+    /**
+     * @var callable
+     */
+    private $callback;
+
+    /**
+     * @var string
+     */
+    private $expectedErrorClasses;
+
+    /**
+     * @var int
+     */
+    private $maxRetries;
+
+    /**
+     * @var float
+     */
+    private $initialWait;
+
+    /**
+     * @var int
+     */
+    private $exponent;
+
+    /**
+     * @var int
+     */
+    private $leftRetries;
+
+    /**
+     * @var float
+     */
+    private $currentWait;
+
+    public function __construct(callable $callback, array $expectedErrorClasses = [], int $maxRetries = 3, float $initialWait = 1.0, int $exponent = 2)
+    {
+        $this->callback = $callback;
+        $this->expectedErrorClasses = $expectedErrorClasses;
+        $this->maxRetries = $this->leftRetries = $maxRetries;
+        $this->initialWait = $this->currentWait = $initialWait;
+        $this->exponent = $exponent;
+    }
+
+    /**
+     * @throws \Exception
+     */
+    public function executeInOnePass()
+    {
+        while ($this->leftRetries > 0) {
+            $result = $this->executeNextTry();
+            if ($result["success"]) {
+                return $result["data"];
+            }
+        }
+    }
+
+    /**
+     * @return array ["success" => bool, "data" => mixed]
+     * @throws \Exception
+     */
+    public function executeNextTry(): array
+    {
+        try {
+            --$this->leftRetries;
+            $callback = $this->callback;
+            $data = $callback();
+            $this->currentWait = $this->initialWait;
+            $this->leftRetries = $this->maxRetries;
+            return [
+                "success" => true,
+                "data" => $data
+            ];
+        } catch (\Exception $e) {
+            $errors = class_parents($e);
+            array_push($errors, get_class($e));
+            if (!array_intersect($errors, $this->expectedErrorClasses) || $this->leftRetries === 0) {
+                throw $e;
+            }
+            usleep($this->currentWait * 1E6);
+            $this->currentWait = $this->initialWait * $this->exponent;
+            return [
+                "success" => false,
+                "data" => null
+            ];
+        }
+    }
+}

tests/SAREhub/Commons/Misc/RetryFunctionWrapperTest.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace SAREhub\Commons\Misc;
+
+
+use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
+use PHPUnit\Framework\TestCase;
+use SAREhub\Commons\Test\CallableMock;
+
+class RetryFunctionWrapperTest extends TestCase
+{
+    use MockeryPHPUnitIntegration;
+
+    public function testExecuteInOnePass()
+    {
+        $callback = CallableMock::create();
+
+        $callback->expects("__invoke")->andReturn(true);
+        $wrapper = new RetryFunctionWrapper($callback);
+        $this->assertTrue($wrapper->executeInOnePass());
+    }
+
+    public function testExecuteInOnePassWhenExpectedExceptionOccur()
+    {
+        $callback = CallableMock::create();
+
+        $callback->expects("__invoke")->andThrow(new \InvalidArgumentException());
+        $callback->expects("__invoke")->andReturn(true);
+        $wrapper = new RetryFunctionWrapper($callback, [\InvalidArgumentException::class]);
+        $this->assertTrue($wrapper->executeInOnePass());
+    }
+
+    public function testExecuteInOnePassWhenUsedAllAttempts()
+    {
+        $callback = CallableMock::create();
+
+        $callback->expects("__invoke")->andThrow(new \InvalidArgumentException());
+        $callback->expects("__invoke")->andThrow(new \InvalidArgumentException());
+        $callback->expects("__invoke")->never();
+        $wrapper = new RetryFunctionWrapper($callback, [\InvalidArgumentException::class], 2);
+
+        $this->expectException(\InvalidArgumentException::class);
+        $wrapper->executeInOnePass();
+    }
+}