Merge pull request #64 from jolicode/feat/timeout

feat(http): add http timeout attribute
jolicode · Apr 10, 2024 · 2c87578 · 2c87578
2 parents c318579 + d79d66d
commit 2c87578
Show file tree

Hide file tree

Showing 14 changed files with 89 additions and 93 deletions.
diff --git a/composer.json b/composer.json
@@ -39,7 +39,7 @@
     },
     "require-dev": {
         "amphp/http-client": "^5.0.1",
-        "friendsofphp/php-cs-fixer": "^3.16.0",
+        "friendsofphp/php-cs-fixer": "^3.53.0",
         "phpstan/phpstan": "^1.10"
     },
     "conflict": {

diff --git a/src/Assert/AssertCaseTrait.php b/src/Assert/AssertCaseTrait.php
@@ -61,7 +61,6 @@ public function setUpTest(Test $test): void
     /**
      * Asserts that an array has a specified key.
      *
-     * @param mixed              $key
      * @param array|\ArrayAccess $array
      * @param string             $message
      */
@@ -73,7 +72,6 @@ public function assertArrayHasKey($key, $array, $message = null)
     /**
      * Asserts that an array does not have a specified key.
      *
-     * @param mixed              $key
      * @param array|\ArrayAccess $array
      * @param string             $message
      */
@@ -89,8 +87,6 @@ public function assertArrayNotHasKey($key, $array, $message = null)
      * $checkForNonObjectIdentity to a non-default value will cause a fallback
      * to PHPUnit's constraint.
      *
-     * @param mixed  $needle
-     * @param mixed  $haystack
      * @param string $message
      */
     public function assertContains($needle, $haystack, $message = null)
@@ -105,8 +101,6 @@ public function assertContains($needle, $haystack, $message = null)
      * $checkForNonObjectIdentity to a non-default value will cause a fallback
      * to PHPUnit's constraint.
      *
-     * @param mixed  $needle
-     * @param mixed  $haystack
      * @param string $message
      */
     public function assertNotContains($needle, $haystack, $message = null)
@@ -178,7 +172,6 @@ public function assertNotContainsOnly($type, $haystack, $isNativeType = null, $m
      * Asserts the number of elements of an array, Countable or Traversable.
      *
      * @param int    $expectedCount
-     * @param mixed  $haystack
      * @param string $message
      */
     public function assertCount($expectedCount, $haystack, $message = null)
@@ -190,7 +183,6 @@ public function assertCount($expectedCount, $haystack, $message = null)
      * Asserts the number of elements of an array, Countable or Traversable.
      *
      * @param int    $expectedCount
-     * @param mixed  $haystack
      * @param string $message
      */
     public function assertNotCount($expectedCount, $haystack, $message = null)
@@ -204,8 +196,6 @@ public function assertNotCount($expectedCount, $haystack, $message = null)
      * Please note that setting $canonicalize or $ignoreCase to true will cause
      * a fallback to PHPUnit's constraint.
      *
-     * @param mixed  $expected
-     * @param mixed  $actual
      * @param string $message
      * @param float  $delta
      */
@@ -220,8 +210,6 @@ public function assertEquals($expected, $actual, $message = null, $delta = 0.0)
      * Please note that setting $canonicalize or $ignoreCase to true will cause
      * a fallback to PHPUnit's constraint.
      *
-     * @param mixed  $expected
-     * @param mixed  $actual
      * @param string $message
      * @param float  $delta
      */
@@ -233,7 +221,6 @@ public function assertNotEquals($expected, $actual, $message = null, $delta = 0.
     /**
      * Asserts that a variable is empty.
      *
-     * @param mixed  $actual
      * @param string $message
      */
     public function assertEmpty($actual, $message = null)
@@ -244,7 +231,6 @@ public function assertEmpty($actual, $message = null)
     /**
      * Asserts that a variable is not empty.
      *
-     * @param mixed  $actual
      * @param string $message
      */
     public function assertNotEmpty($actual, $message = null)
@@ -255,8 +241,6 @@ public function assertNotEmpty($actual, $message = null)
     /**
      * Asserts that a value is greater than another value.
      *
-     * @param mixed  $expected
-     * @param mixed  $actual
      * @param string $message
      */
     public function assertGreaterThan($expected, $actual, $message = null)
@@ -267,8 +251,6 @@ public function assertGreaterThan($expected, $actual, $message = null)
     /**
      * Asserts that a value is greater than or equal to another value.
      *
-     * @param mixed  $expected
-     * @param mixed  $actual
      * @param string $message
      */
     public function assertGreaterThanOrEqual($expected, $actual, $message = null)
@@ -279,8 +261,6 @@ public function assertGreaterThanOrEqual($expected, $actual, $message = null)
     /**
      * Asserts that a value is smaller than another value.
      *
-     * @param mixed  $expected
-     * @param mixed  $actual
      * @param string $message
      */
     public function assertLessThan($expected, $actual, $message = null)
@@ -291,8 +271,6 @@ public function assertLessThan($expected, $actual, $message = null)
     /**
      * Asserts that a value is smaller than or equal to another value.
      *
-     * @param mixed  $expected
-     * @param mixed  $actual
      * @param string $message
      */
     public function assertLessThanOrEqual($expected, $actual, $message = null)
@@ -347,7 +325,6 @@ public function assertFalse($condition, $message = null)
     /**
      * Asserts that a variable is not null.
      *
-     * @param mixed  $actual
      * @param string $message
      */
     public function assertNotNull($actual, $message = null)
@@ -358,7 +335,6 @@ public function assertNotNull($actual, $message = null)
     /**
      * Asserts that a variable is null.
      *
-     * @param mixed  $actual
      * @param string $message
      */
     public function assertNull($actual, $message = null)
@@ -369,7 +345,6 @@ public function assertNull($actual, $message = null)
     /**
      * Asserts that a variable is finite.
      *
-     * @param mixed  $actual
      * @param string $message
      */
     public function assertFinite($actual, $message = null)
@@ -380,7 +355,6 @@ public function assertFinite($actual, $message = null)
     /**
      * Asserts that a variable is infinite.
      *
-     * @param mixed  $actual
      * @param string $message
      */
     public function assertInfinite($actual, $message = null)
@@ -391,7 +365,6 @@ public function assertInfinite($actual, $message = null)
     /**
      * Asserts that a variable is nan.
      *
-     * @param mixed  $actual
      * @param string $message
      */
     public function assertNan($actual, $message = null)
@@ -404,8 +377,6 @@ public function assertNan($actual, $message = null)
      * Used on objects, it asserts that two variables reference
      * the same object.
      *
-     * @param mixed  $expected
-     * @param mixed  $actual
      * @param string $message
      */
     public function assertSame($expected, $actual, $message = null)
@@ -418,8 +389,6 @@ public function assertSame($expected, $actual, $message = null)
      * Used on objects, it asserts that two variables do not reference
      * the same object.
      *
-     * @param mixed  $expected
-     * @param mixed  $actual
      * @param string $message
      */
     public function assertNotSame($expected, $actual, $message = null)
@@ -431,7 +400,6 @@ public function assertNotSame($expected, $actual, $message = null)
      * Asserts that a variable is of a given type.
      *
      * @param string $expected
-     * @param mixed  $actual
      * @param string $message
      */
     public function assertInstanceOf($expected, $actual, $message = null)
@@ -443,7 +411,6 @@ public function assertInstanceOf($expected, $actual, $message = null)
      * Asserts that a variable is not of a given type.
      *
      * @param string $expected
-     * @param mixed  $actual
      * @param string $message
      */
     public function assertNotInstanceOf($expected, $actual, $message = null)
@@ -455,7 +422,6 @@ public function assertNotInstanceOf($expected, $actual, $message = null)
      * Asserts that a variable is of a given type.
      *
      * @param string $expected
-     * @param mixed  $actual
      * @param string $message
      */
     public function assertInternalType($expected, $actual, $message = null)
@@ -467,7 +433,6 @@ public function assertInternalType($expected, $actual, $message = null)
      * Asserts that a variable is not of a given type.
      *
      * @param string $expected
-     * @param mixed  $actual
      * @param string $message
      */
     public function assertNotInternalType($expected, $actual, $message = null)
@@ -568,7 +533,7 @@ public function assertContainsSubset(array $other, array $subset, bool $strict =
         $this->assert($subset, containsSubset($other, $strict), $message);
     }
 
-    public function assert($value, callable $predicate, string $description = null): bool
+    public function assert($value, callable $predicate, ?string $description = null): bool
     {
         return (new Assertion($value, exporter(), $this->test))
             ->evaluate(counting(Predicate::castFrom($predicate)), $description);

diff --git a/src/Assert/Assertion.php b/src/Assert/Assertion.php
@@ -20,8 +20,6 @@ class Assertion extends BaseAssertion
 
     /**
      * constructor.
-     *
-     * @param mixed $value
      */
     public function __construct($value, Exporter $exporter, Test $test)
     {
@@ -32,7 +30,7 @@ public function __construct($value, Exporter $exporter, Test $test)
         $this->test = $test;
     }
 
-    public function evaluate(Predicate $predicate, string $description = null): bool
+    public function evaluate(Predicate $predicate, ?string $description = null): bool
     {
         try {
             $result = parent::evaluate($predicate, $description);
@@ -60,10 +58,10 @@ public function evaluate(Predicate $predicate, string $description = null): bool
     /**
      * creates failure description when value failed the test with given predicate.
      *
-     * @param \bovigo\assert\predicate\Predicate $predicate   predicate that failed
-     * @param string                             $description additional description for failure message
+     * @param Predicate $predicate   predicate that failed
+     * @param string    $description additional description for failure message
      */
-    private function describeSuccess(Predicate $predicate, string $description = null): string
+    private function describeSuccess(Predicate $predicate, ?string $description = null): string
     {
         if ($description) {
             return $description;

diff --git a/src/Attribute/HttpClientConfiguration.php b/src/Attribute/HttpClientConfiguration.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace Asynit\Attribute;
+
+#[\Attribute(\Attribute::TARGET_CLASS)]
+final readonly class HttpClientConfiguration
+{
+    public function __construct(
+        public float $timeout = 10,
+        public int $retry = 0,
+    ) {
+    }
+}
diff --git a/src/Command/AsynitCommand.php b/src/Command/AsynitCommand.php
@@ -17,9 +17,6 @@ class AsynitCommand extends Command
 {
     private string $defaultBootstrapFilename = '';
 
-    /**
-     * {@inheritdoc}
-     */
     protected function configure(): void
     {
         $this->defaultBootstrapFilename = getcwd().'/vendor/autoload.php';
@@ -35,9 +32,6 @@ protected function configure(): void
         ;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         /** @var string $bootstrapFilename */

diff --git a/src/HttpClient/ApiResponse.php b/src/HttpClient/ApiResponse.php
@@ -14,7 +14,7 @@ class ApiResponse extends HttpResponse implements \ArrayAccess
     /**
      * @var array<string, mixed>|null
      */
-    private array|null $data = null;
+    private ?array $data = null;
 
     public function __construct(private readonly Response $response)
     {
@@ -77,7 +77,7 @@ public function hasHeader(string $name): bool
         return $this->response->hasHeader($name);
     }
 
-    public function getHeader(string $name): null|string
+    public function getHeader(string $name): ?string
     {
         return $this->response->getHeader($name);
     }

diff --git a/src/HttpClient/HttpClientApiCaseTrait.php b/src/HttpClient/HttpClientApiCaseTrait.php
@@ -13,37 +13,37 @@ protected function getApiContentType(): string
         return 'application/json';
     }
 
-    final protected function get(string $uri, array|null $json = null, array $headers = []): ApiResponse
+    final protected function get(string $uri, ?array $json = null, array $headers = []): ApiResponse
     {
         return new ApiResponse($this->sendRequest($this->createApiRequest('GET', $uri, $headers, $json)));
     }
 
-    final protected function post(string $uri, array|null $json = null, array $headers = []): ApiResponse
+    final protected function post(string $uri, ?array $json = null, array $headers = []): ApiResponse
     {
         return new ApiResponse($this->sendRequest($this->createApiRequest('POST', $uri, $headers, $json)));
     }
 
-    final protected function patch(string $uri, array|null $json = null, array $headers = []): ApiResponse
+    final protected function patch(string $uri, ?array $json = null, array $headers = []): ApiResponse
     {
         return new ApiResponse($this->sendRequest($this->createApiRequest('PATCH', $uri, $headers, $json)));
     }
 
-    final protected function put(string $uri, array|null $json = null, array $headers = []): ApiResponse
+    final protected function put(string $uri, ?array $json = null, array $headers = []): ApiResponse
     {
         return new ApiResponse($this->sendRequest($this->createApiRequest('PUT', $uri, $headers, $json)));
     }
 
-    final protected function delete(string $uri, array|null $json = null, array $headers = []): ApiResponse
+    final protected function delete(string $uri, ?array $json = null, array $headers = []): ApiResponse
     {
         return new ApiResponse($this->sendRequest($this->createApiRequest('DELETE', $uri, $headers, $json)));
     }
 
-    final protected function options(string $uri, array|null $json = null, array $headers = []): ApiResponse
+    final protected function options(string $uri, ?array $json = null, array $headers = []): ApiResponse
     {
         return new ApiResponse($this->sendRequest($this->createApiRequest('OPTIONS', $uri, $headers, $json)));
     }
 
-    private function createApiRequest(string $method, string $uri, array $headers = [], array|null $json = null): Request
+    private function createApiRequest(string $method, string $uri, array $headers = [], ?array $json = null): Request
     {
         $request = new Request($uri, $method);
         $request->addHeader('Content-Type', $this->getApiContentType());