Fixed PHPStan + bulk endpoint template generator

ezimuel · ezimuel · commit efbe7aae8145 · 2021-02-24T22:02:24.000+01:00
diff --git a/phpstan-src.neon b/phpstan-src.neon
diff --git a/phpstan-tests.neon b/phpstan-tests.neon
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,9 @@
+parameters:
+    reportUnmatchedIgnoredErrors:
+        false
+    ignoreErrors:
+        - '#Unsafe usage of new static\(\)#'
+        - '#Call to static method performRequest\(\) on trait#'
+        - '#Constant JSON_THROW_ON_ERROR not found#'
+        - '#Caught class JsonException not found#'
+        - '#Call to method getCode\(\) on an unknown class JsonException#'
diff --git a/src/Elasticsearch/Connections/Connection.php b/src/Elasticsearch/Connections/Connection.php
@@ -171,7 +171,7 @@ public function __construct(
      */
     public function performRequest($method, $uri, $params = null, $body = null, $options = [], Transport $transport = null)
     {
-        if (isset($body) === true) {
+        if ($body !== null) {
             $body = $this->serializer->serialize($body);
         }
 
@@ -333,7 +333,7 @@ private function wrapHandler(callable $handler)
      *
      * @return string
      */
-    private function getURI($uri, $params)
+    private function getURI(string $uri, ?array $params)
     {
         if (isset($params) === true && !empty($params)) {
             array_walk($params, function (&$value, &$key) {
@@ -588,7 +588,7 @@ protected function getCurlRetryException($request, $response)
      *
      * @return string
      */
-    private function buildCurlCommand($method, $uri, $body)
+    private function buildCurlCommand(string $method, string $uri, ?string $body): string
     {
         if (strpos($uri, '?') === false) {
             $uri .= '?pretty=true';
diff --git a/src/Elasticsearch/Endpoints/AbstractEndpoint.php b/src/Elasticsearch/Endpoints/AbstractEndpoint.php
@@ -237,9 +237,9 @@ private function getOptionalType()
      *
      * @throws \Elasticsearch\Common\Exceptions\UnexpectedValueException
      */
-    private function checkUserParams($params)
+    private function checkUserParams(array $params)
     {
-        if (isset($params) !== true) {
+        if (empty($params)) {
             return; //no params, just return.
         }
 
diff --git a/src/Elasticsearch/Endpoints/Bulk.php b/src/Elasticsearch/Endpoints/Bulk.php
@@ -18,6 +18,7 @@
 
 use Elasticsearch\Common\Exceptions\InvalidArgumentException;
 use Elasticsearch\Endpoints\AbstractEndpoint;
+use Elasticsearch\Endpoints\BulkEndpointInterface;
 use Elasticsearch\Serializers\SerializerInterface;
 use Traversable;
 
@@ -71,9 +72,6 @@ public function getMethod(): string
         return 'POST';
     }
         
-    /**
-     * @param string|array|Traversable $body
-     */
     public function setBody($body): Bulk
     {
         if (isset($body) !== true) {
diff --git a/src/Elasticsearch/Endpoints/Ml/FindFileStructure.php b/src/Elasticsearch/Endpoints/Ml/FindFileStructure.php
@@ -18,6 +18,7 @@
 
 use Elasticsearch\Common\Exceptions\InvalidArgumentException;
 use Elasticsearch\Endpoints\AbstractEndpoint;
+use Elasticsearch\Endpoints\BulkEndpointInterface;
 use Elasticsearch\Serializers\SerializerInterface;
 use Traversable;
 
@@ -66,9 +67,6 @@ public function getMethod(): string
         return 'POST';
     }
         
-    /**
-     * @param string|array|Traversable $body
-     */
     public function setBody($body): FindFileStructure
     {
         if (isset($body) !== true) {
diff --git a/src/Elasticsearch/Endpoints/Ml/PostData.php b/src/Elasticsearch/Endpoints/Ml/PostData.php
@@ -19,6 +19,7 @@
 use Elasticsearch\Common\Exceptions\RuntimeException;
 use Elasticsearch\Common\Exceptions\InvalidArgumentException;
 use Elasticsearch\Endpoints\AbstractEndpoint;
+use Elasticsearch\Endpoints\BulkEndpointInterface;
 use Elasticsearch\Serializers\SerializerInterface;
 use Traversable;
 
@@ -63,9 +64,6 @@ public function getMethod(): string
         return 'POST';
     }
         
-    /**
-     * @param string|array|Traversable $body
-     */
     public function setBody($body): PostData
     {
         if (isset($body) !== true) {
diff --git a/src/Elasticsearch/Endpoints/Monitoring/Bulk.php b/src/Elasticsearch/Endpoints/Monitoring/Bulk.php
@@ -18,6 +18,7 @@
 
 use Elasticsearch\Common\Exceptions\InvalidArgumentException;
 use Elasticsearch\Endpoints\AbstractEndpoint;
+use Elasticsearch\Endpoints\BulkEndpointInterface;
 use Elasticsearch\Serializers\SerializerInterface;
 use Traversable;
 
@@ -60,9 +61,6 @@ public function getMethod(): string
         return 'POST';
     }
         
-    /**
-     * @param string|array|Traversable $body
-     */
     public function setBody($body): Bulk
     {
         if (isset($body) !== true) {
diff --git a/src/Elasticsearch/Endpoints/Msearch.php b/src/Elasticsearch/Endpoints/Msearch.php
@@ -18,6 +18,7 @@
 
 use Elasticsearch\Common\Exceptions\InvalidArgumentException;
 use Elasticsearch\Endpoints\AbstractEndpoint;
+use Elasticsearch\Endpoints\BulkEndpointInterface;
 use Elasticsearch\Serializers\SerializerInterface;
 use Traversable;
 
@@ -67,9 +68,6 @@ public function getMethod(): string
         return isset($this->body) ? 'POST' : 'GET';
     }
         
-    /**
-     * @param string|array|Traversable $body
-     */
     public function setBody($body): Msearch
     {
         if (isset($body) !== true) {
diff --git a/src/Elasticsearch/Endpoints/MsearchTemplate.php b/src/Elasticsearch/Endpoints/MsearchTemplate.php
@@ -18,6 +18,7 @@
 
 use Elasticsearch\Common\Exceptions\InvalidArgumentException;
 use Elasticsearch\Endpoints\AbstractEndpoint;
+use Elasticsearch\Endpoints\BulkEndpointInterface;
 use Elasticsearch\Serializers\SerializerInterface;
 use Traversable;
 
@@ -65,9 +66,6 @@ public function getMethod(): string
         return isset($this->body) ? 'POST' : 'GET';
     }
         
-    /**
-     * @param string|array|Traversable $body
-     */
     public function setBody($body): MsearchTemplate
     {
         if (isset($body) !== true) {
diff --git a/src/Elasticsearch/Transport.php b/src/Elasticsearch/Transport.php
@@ -146,19 +146,15 @@ function ($response) {
      *
      * @return callable|array
      */
-    public function resultOrFuture($result, $options = [])
+    public function resultOrFuture(FutureArrayInterface $result, array $options = [])
     {
-        $response = null;
         $async = isset($options['client']['future']) ? $options['client']['future'] : null;
         if (is_null($async) || $async === false) {
             do {
                 $result = $result->wait();
             } while ($result instanceof FutureArrayInterface);
-
-            return $result;
-        } elseif ($async === true || $async === 'lazy') {
-            return $result;
-        }
+        } 
+        return $result;
     }
 
     /**
diff --git a/src/autoload.php b/src/autoload.php
@@ -31,10 +31,8 @@
     '\Elasticsearch\Endpoints\Indices\GetAlias'           => '\Elasticsearch\Endpoints\Indices\Alias\Get',
     '\Elasticsearch\Endpoints\Indices\PutAlias'           => '\Elasticsearch\Endpoints\Indices\Alias\Put',
     '\Elasticsearch\Endpoints\Indices\ClearCache'         => '\Elasticsearch\Endpoints\Indices\Cache\Clear',
-    '\Elasticsearch\Endpoints\Indices\ExistsType'         => '\Elasticsearch\Endpoints\Indices\Exists\Types',
     '\Elasticsearch\Endpoints\Indices\GetMapping'         => '\Elasticsearch\Endpoints\Indices\Mapping\Get',
     '\Elasticsearch\Endpoints\Indices\GetFieldMapping'    => '\Elasticsearch\Endpoints\Indices\Mapping\GetField',
-    '\Elasticsearch\Endpoints\Indices\GetFieldMapping'    => '\Elasticsearch\Endpoints\Indices\Field\Get',
     '\Elasticsearch\Endpoints\Indices\PutMapping'         => '\Elasticsearch\Endpoints\Indices\Mapping\Put',
     '\Elasticsearch\Endpoints\Indices\GetSettings'        => '\Elasticsearch\Endpoints\Indices\Settings\Get',
     '\Elasticsearch\Endpoints\Indices\PutSettings'        => '\Elasticsearch\Endpoints\Indices\Settings\Put',
diff --git a/util/template/endpoint-bulk-class b/util/template/endpoint-bulk-class
@@ -17,6 +17,7 @@ declare(strict_types = 1);
 namespace Elasticsearch\Endpoints:namespace;
 :use-namespace
 use Elasticsearch\Endpoints\AbstractEndpoint;
+use Elasticsearch\Endpoints\BulkEndpointInterface;
 use Elasticsearch\Serializers\SerializerInterface;
 use Traversable;
 
diff --git a/util/template/set-bulk-body b/util/template/set-bulk-body
@@ -1,7 +1,4 @@
     
-    /**
-     * @param string|array|Traversable $body
-     */
     public function setBody($body): :endpoint
     {
         if (isset($body) !== true) {

Original file line number	Diff line number	Diff line change
`@@ -171,7 +171,7 @@ public function __construct(`
`171`	`171`	`*/`
`172`	`172`	`public function performRequest($method, $uri, $params = null, $body = null, $options = [], Transport $transport = null)`
`173`	`173`	`{`
`174`		`- if (isset($body) === true) {`
	`174`	`+ if ($body !== null) {`
`175`	`175`	`$body = $this->serializer->serialize($body);`
`176`	`176`	`}`
`177`	`177`
`@@ -333,7 +333,7 @@ private function wrapHandler(callable $handler)`
`333`	`333`	`*`
`334`	`334`	`* @return string`
`335`	`335`	`*/`
`336`		`- private function getURI($uri, $params)`
	`336`	`+ private function getURI(string $uri, ?array $params)`
`337`	`337`	`{`
`338`	`338`	`if (isset($params) === true && !empty($params)) {`
`339`	`339`	`array_walk($params, function (&$value, &$key) {`
`@@ -588,7 +588,7 @@ protected function getCurlRetryException($request, $response)`
`588`	`588`	`*`
`589`	`589`	`* @return string`
`590`	`590`	`*/`
`591`		`- private function buildCurlCommand($method, $uri, $body)`
	`591`	`+ private function buildCurlCommand(string $method, string $uri, ?string $body): string`
`592`	`592`	`{`
`593`	`593`	`if (strpos($uri, '?') === false) {`
`594`	`594`	`$uri .= '?pretty=true';`
Original file line number	Diff line number	Diff line change
`@@ -237,9 +237,9 @@ private function getOptionalType()`
`237`	`237`	`*`
`238`	`238`	`* @throws \Elasticsearch\Common\Exceptions\UnexpectedValueException`
`239`	`239`	`*/`
`240`		`- private function checkUserParams($params)`
	`240`	`+ private function checkUserParams(array $params)`
`241`	`241`	`{`
`242`		`- if (isset($params) !== true) {`
	`242`	`+ if (empty($params)) {`
`243`	`243`	`return; //no params, just return.`
`244`	`244`	`}`
`245`	`245`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@`
`18`	`18`
`19`	`19`	`use Elasticsearch\Common\Exceptions\InvalidArgumentException;`
`20`	`20`	`use Elasticsearch\Endpoints\AbstractEndpoint;`
	`21`	`+use Elasticsearch\Endpoints\BulkEndpointInterface;`
`21`	`22`	`use Elasticsearch\Serializers\SerializerInterface;`
`22`	`23`	`use Traversable;`
`23`	`24`
`@@ -71,9 +72,6 @@ public function getMethod(): string`
`71`	`72`	`return 'POST';`
`72`	`73`	`}`
`73`	`74`
`74`		`- /**`
`75`		`- * @param string\|array\|Traversable $body`
`76`		`- */`
`77`	`75`	`public function setBody($body): Bulk`
`78`	`76`	`{`
`79`	`77`	`if (isset($body) !== true) {`