Fix merging pending requests

rdanklof · Apr 29, 2021 · 0873386 · 0873386
1 parent b242eab
commit 0873386
Show file tree

Hide file tree

Showing 12 changed files with 146 additions and 30 deletions.
diff --git a/src/HttpClient/BaseHttpClient.php b/src/HttpClient/BaseHttpClient.php
@@ -17,6 +17,8 @@
 use function array_push;
 use function is_null;
 use function max;
+use function user_error;
+use const E_USER_DEPRECATED;
 
 abstract class BaseHttpClient
 {
@@ -263,10 +265,27 @@ public function clearRequests()
      * @param RequestInterface[] $requests
      *
      * @return HttpClientException[]|ResponseInterface[]
+     *
+     * @throws InvalidArgumentException
      */
     public function doRequests($requests = [])
     {
-        $requests = array_merge($this->pendingRequests, $requests);
+        if ($requests instanceof RequestInterface) {
+            user_error(
+                'Passing a single request to HttpClientInterface::doRequests is deprecated',
+                E_USER_DEPRECATED
+            );
+            $requests = [$requests];
+        }
+        if (!is_array($requests)) {
+            throw new InvalidArgumentException('Invalid requests array passed');
+        }
+        if (!is_array($this->pendingRequests)) {
+            $this->pendingRequests = [];
+        }
+
+        // Handle pending requests as well
+        $requests = $this->pendingRequests + $requests;
 
         $responses = [];
         foreach ($requests as $id => $request) {

diff --git a/src/HttpClient/CurlClient.php b/src/HttpClient/CurlClient.php
@@ -27,21 +27,26 @@
 namespace Firstred\PostNL\HttpClient;
 
 use Composer\CaBundle\CaBundle;
+use Exception;
 use Firstred\PostNL\Exception\ApiConnectionException;
 use Firstred\PostNL\Exception\ApiException;
 use Firstred\PostNL\Exception\HttpClientException;
+use Firstred\PostNL\Exception\InvalidArgumentException;
 use GuzzleHttp\Psr7\Message as PsrMessage;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LogLevel;
 use function define;
 use function defined;
+use function is_array;
+use function user_error;
 use const CURLOPT_FOLLOWLOCATION;
 use const CURLOPT_HTTPHEADER;
 use const CURLOPT_PROTOCOLS;
 use const CURLOPT_REDIR_PROTOCOLS;
 use const CURLOPT_SSL_VERIFYPEER;
+use const E_USER_DEPRECATED;
 
 if (!defined('CURL_SSLVERSION_TLSv1')) {
     define('CURL_SSLVERSION_TLSv1', 1);
@@ -136,12 +141,30 @@ public function doRequest(RequestInterface $request)
      * @param RequestInterface[] $requests
      *
      * @return ResponseInterface[]|HttpClientException[]
+     *
+     * @throws InvalidArgumentException
      */
     public function doRequests($requests = [])
     {
+        if ($requests instanceof RequestInterface) {
+            user_error(
+                'Passing a single request to HttpClientInterface::doRequests is deprecated',
+                E_USER_DEPRECATED
+            );
+            $requests = [$requests];
+        }
+        if (!is_array($requests)) {
+            throw new InvalidArgumentException('Invalid requests array passed');
+        }
+        if (!is_array($this->pendingRequests)) {
+            $this->pendingRequests = [];
+        }
+
         // Reset request headers array
         $curlHandles = [];
         $mh = curl_multi_init();
+
+        // Handle pending requests as well
         $requests = $this->pendingRequests + $requests;
         foreach ($requests as $uuid => $request) {
             $curl = curl_init();

diff --git a/src/HttpClient/GuzzleClient.php b/src/HttpClient/GuzzleClient.php
@@ -27,7 +27,9 @@
 namespace Firstred\PostNL\HttpClient;
 
 use Composer\CaBundle\CaBundle;
+use Exception;
 use Firstred\PostNL\Exception\HttpClientException;
+use Firstred\PostNL\Exception\InvalidArgumentException;
 use Firstred\PostNL\Exception\ResponseException;
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\ConnectException;
@@ -45,7 +47,10 @@
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerInterface;
 use Psr\Log\LogLevel;
+use function is_array;
 use function method_exists;
+use function user_error;
+use const E_USER_DEPRECATED;
 
 /**
  * Class GuzzleClient.
@@ -247,19 +252,26 @@ public function doRequest(RequestInterface $request)
      * @param RequestInterface[] $requests
      *
      * @return HttpClientException[]|ResponseInterface[]
+     *
+     * @throws InvalidArgumentException
      */
     public function doRequests($requests = [])
     {
-        // If this is a single request, create the requests array
-        if (!is_array($requests)) {
-            if (!$requests instanceof RequestInterface) {
-                return [];
-            }
-
+        if ($requests instanceof RequestInterface) {
+            user_error(
+                'Passing a single request to HttpClientInterface::doRequests is deprecated',
+                E_USER_DEPRECATED
+            );
             $requests = [$requests];
         }
+        if (!is_array($requests)) {
+            throw new InvalidArgumentException('Invalid requests array passed');
+        }
+        if (!is_array($this->pendingRequests)) {
+            $this->pendingRequests = [];
+        }
 
-        // Handle pending requests
+        // Handle pending requests as well
         $requests = $this->pendingRequests + $requests;
         $this->clearRequests();
 

diff --git a/src/HttpClient/HTTPlugClient.php b/src/HttpClient/HTTPlugClient.php
@@ -4,6 +4,7 @@
 
 use Exception;
 use Firstred\PostNL\Exception\HttpClientException;
+use Firstred\PostNL\Exception\InvalidArgumentException;
 use Firstred\PostNL\Util\EachPromise;
 use GuzzleHttp\Psr7\Message as PsrMessage;
 use Http\Client\Exception\HttpException;
@@ -22,6 +23,9 @@
 use Psr\Http\Message\ResponseInterface;
 use Psr\Log\LoggerInterface;
 use Psr\Log\LogLevel;
+use function is_array;
+use function user_error;
+use const E_USER_DEPRECATED;
 
 /**
  * Class HTTPlugClient.
@@ -100,15 +104,29 @@ public function __construct(
      *
      * Exceptions are captured into the result array
      *
-     * @param array                                 $requests
+     * @param RequestInterface[]                    $requests
      *
-     * @psalm-param array<string, RequestInterface> $requests
+     * @return HttpClientException[]|ResponseInterface[]
      *
-     * @return array
+     * @throws InvalidArgumentException
      */
     public function doRequests($requests = [])
     {
-        // Handle pending requests
+        if ($requests instanceof RequestInterface) {
+            user_error(
+                'Passing a single request to HttpClientInterface::doRequests is deprecated',
+                E_USER_DEPRECATED
+            );
+            $requests = [$requests];
+        }
+        if (!is_array($requests)) {
+            throw new InvalidArgumentException('Invalid requests array passed');
+        }
+        if (!is_array($this->pendingRequests)) {
+            $this->pendingRequests = [];
+        }
+
+        // Handle pending requests as well
         $requests = $this->pendingRequests + $requests;
         $this->clearRequests();
 

diff --git a/src/HttpClient/MockClient.php b/src/HttpClient/MockClient.php
@@ -26,7 +26,9 @@
 
 namespace Firstred\PostNL\HttpClient;
 
+use Exception;
 use Firstred\PostNL\Exception\HttpClientException;
+use Firstred\PostNL\Exception\InvalidArgumentException;
 use Firstred\PostNL\Exception\ResponseException;
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\GuzzleException;
@@ -38,6 +40,9 @@
 use Psr\Http\Message\ResponseInterface;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LogLevel;
+use function is_array;
+use function user_error;
+use const E_USER_DEPRECATED;
 
 /**
  * Class MockClient.
@@ -182,19 +187,26 @@ public function doRequest(RequestInterface $request)
      * @param RequestInterface[] $requests
      *
      * @return ResponseInterface[]|HttpClientException[]
+     *
+     * @throws InvalidArgumentException
      */
     public function doRequests($requests = [])
     {
-        // If this is a single request, create the requests array
-        if (!is_array($requests)) {
-            if (!$requests instanceof RequestInterface) {
-                return [];
-            }
-
+        if ($requests instanceof RequestInterface) {
+            user_error(
+                'Passing a single request to HttpClientInterface::doRequests is deprecated',
+                E_USER_DEPRECATED
+            );
             $requests = [$requests];
         }
+        if (!is_array($requests)) {
+            throw new InvalidArgumentException('Invalid requests array passed');
+        }
+        if (!is_array($this->pendingRequests)) {
+            $this->pendingRequests = [];
+        }
 
-        // Handle pending requests
+        // Handle pending requests as well
         $requests = $this->pendingRequests + $requests;
         $this->clearRequests();
 

diff --git a/src/HttpClient/SymfonyHttpClient.php b/src/HttpClient/SymfonyHttpClient.php
@@ -27,7 +27,9 @@
 namespace Firstred\PostNL\HttpClient;
 
 use Composer\CaBundle\CaBundle;
+use Exception;
 use Firstred\PostNL\Exception\HttpClientException;
+use Firstred\PostNL\Exception\InvalidArgumentException;
 use Firstred\PostNL\Exception\NotSupportedException;
 use GuzzleHttp\Psr7\Message as PsrMessage;
 use Psr\Http\Message\RequestInterface;
@@ -45,6 +47,9 @@
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface as SymfonyHttpClientResponseInterface;
 use function array_merge;
+use function is_array;
+use function user_error;
+use const E_USER_DEPRECATED;
 
 /**
  * Class SymfonyHttpClientInterface.
@@ -231,9 +236,26 @@ public function doRequest(RequestInterface $request)
      * @param RequestInterface[] $requests
      *
      * @return HttpClientException[]|ResponseInterface[]
+     *
+     * @throws InvalidArgumentException
      */
     public function doRequests($requests = [])
     {
+        if ($requests instanceof RequestInterface) {
+            user_error(
+                'Passing a single request to HttpClientInterface::doRequests is deprecated',
+                E_USER_DEPRECATED
+            );
+            $requests = [$requests];
+        }
+        if (!is_array($requests)) {
+            throw new InvalidArgumentException('Invalid requests array passed');
+        }
+        if (!is_array($this->pendingRequests)) {
+            $this->pendingRequests = [];
+        }
+
+        // Handle pending requests as well
         $requests = $this->pendingRequests + $requests;
         $httpClient = $this->getClient();
         $responses = [];

diff --git a/src/PostNL.php b/src/PostNL.php
@@ -1805,6 +1805,7 @@ function ($barcode) {
      * @throws PsrCacheInvalidArgumentException
      * @throws ResponseException
      * @throws NotFoundException
+     * @throws ShipmentNotFoundException
      *
      * @since 1.2.0
      */

diff --git a/src/Service/BarcodeService.php b/src/Service/BarcodeService.php
@@ -141,6 +141,7 @@ public function generateBarcodeSOAP(GenerateBarcode $generateBarcode)
      * @throws HttpClientException
      * @throws ResponseException
      * @throws InvalidConfigurationException
+     * @throws \Firstred\PostNL\Exception\InvalidArgumentException
      *
      * @since 1.0.0
      */
@@ -176,6 +177,7 @@ public function generateBarcodesREST(array $generateBarcodes)
      * @throws CifException
      * @throws HttpClientException
      * @throws ResponseException
+     * @throws \Firstred\PostNL\Exception\InvalidArgumentException
      *
      * @since 1.0.0
      */

diff --git a/src/Service/ConfirmingService.php b/src/Service/ConfirmingService.php
@@ -195,6 +195,7 @@ public function confirmShipmentSOAP(Confirming $confirming)
      * @throws CifException
      * @throws HttpClientException
      * @throws ResponseException
+     * @throws InvalidArgumentException
      *
      * @since 1.0.0
      */

diff --git a/src/Service/LabellingService.php b/src/Service/LabellingService.php
@@ -268,6 +268,7 @@ public function generateLabelSOAP(GenerateLabel $generateLabel, $confirm = true)
      * @throws HttpClientException
      * @throws PsrCacheInvalidArgumentException
      * @throws ResponseException
+     * @throws PostNLInvalidArgumentException
      *
      * @since 1.0.0
      */

diff --git a/src/Util/Util.php b/src/Util/Util.php
@@ -250,6 +250,10 @@ public static function getShippingDaysRemaining($shippingDate, $preferredDeliver
      * @throws Exception
      * @throws Exception
      * @throws Exception
+     * @throws Exception
+     * @throws Exception
+     * @throws Exception
+     * @throws Exception
      */
     protected static function getHolidaysForYear($year)
     {

diff --git a/tests/Service/DeliveryDateServiceRestTest.php b/tests/Service/DeliveryDateServiceRestTest.php
@@ -136,17 +136,18 @@ public function testGetDeliveryDateRequestRest()
 
         $query = Query::parse($request->getUri()->getQuery());
 
-        $this->assertEquals([
-            'ShippingDate'     => '29-06-2016 14:00:00',
-            'ShippingDuration' => '1',
-            'CountryCode'      => 'NL',
-            'Options'          => 'Daytime',
-            'CutOffTime'       => '14:00:00',
-            'PostalCode'       => '2132WT',
-            'City'             => 'Hoofddorp',
-            'HouseNr'          => '42',
-            'HouseNrExt'       => 'A',
-        ],
+        $this->assertEquals(
+            [
+                'ShippingDate'     => '29-06-2016 14:00:00',
+                'ShippingDuration' => '1',
+                'CountryCode'      => 'NL',
+                'Options'          => 'Daytime',
+                'CutOffTime'       => '14:00:00',
+                'PostalCode'       => '2132WT',
+                'City'             => 'Hoofddorp',
+                'HouseNr'          => '42',
+                'HouseNrExt'       => 'A',
+            ],
             $query
         );
         $this->assertEquals('test', $request->getHeaderLine('apikey'));