RetailCRM-Mirror/prestashop-module
1
0
Fork 0
mirror of https://github.com/retailcrm/prestashop-module.git synced 2025-04-06 14:43:37 +03:00
Code Issues Projects Releases Wiki Activity

Added exceptions handling for proxy

Browse source
This commit is contained in:
max-baranikov 2021-10-15 11:20:18 +03:00 • committed by GitHub
parent 5bbddab7ee
commit 34ce76b4a6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 218 additions and 75 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
retailcrm/lib/RetailcrmOrderBuilder.php
View file

@ -190,10 +190,22 @@ class RetailcrmOrderBuilder
protected function getApiSite()
{
if (empty($this->apiSite)) {
$this->apiSite = $this->api->getSingleSiteForKey();
$response = $this->api->credentials();
if (
$response->isSuccessful()
&& $response->offsetExists('sitesAvailable')
&& is_array($response['sitesAvailable'])
&& !empty($response['sitesAvailable'])
&& !empty($response['sitesAvailable'][0])
) {
$this->apiSite = $response['sitesAvailable'][0];
} else {
$this->apiSite = null;
}
}
return (empty($this->apiSite) || is_bool($this->apiSite)) ? null : $this->apiSite;
return $this->apiSite;
}
/**

55
retailcrm/lib/api/RetailcrmApiClientV5.php
View file

@ -79,43 +79,14 @@ class RetailcrmApiClientV5
$this->siteCode = $site;
}
/**
* getSingleSiteForKey
*
* @return string|bool
*/
public function getSingleSiteForKey()
{
$response = $this->credentials();
if ($response instanceof RetailcrmApiResponse
&& isset($response['sitesAvailable'])
&& is_array($response['sitesAvailable'])
&& !empty($response['sitesAvailable'])
) {
return $response['sitesAvailable'][0];
}
return false;
}
/**
* /api/credentials response
*
* @return RetailcrmApiResponse|bool
* @return RetailcrmApiResponse
*/
public function credentials()
{
$response = $this->unversionedClient->makeRequest(
'/credentials',
RetailcrmHttpClient::METHOD_GET
);
if ($response instanceof RetailcrmApiResponse) {
return $response;
}
return false;
return $this->unversionedClient->makeRequest('/credentials', RetailcrmHttpClient::METHOD_GET);
}
/**
@ -3003,28 +2974,6 @@ class RetailcrmApiClientV5
);
}
/**
* Return current site
*
* @return string
*/
public function getSite()
{
return $this->siteCode;
}
/**
* Set site
*
* @param string $site site code
*
* @return void
*/
public function setSite($site)
{
$this->siteCode = $site;
}
/**
* Check ID parameter
*

24
retailcrm/lib/api/RetailcrmProxy.php
View file

@ -1,4 +1,6 @@
<?php
/**
* MIT License
*
@ -55,27 +57,27 @@ class RetailcrmProxy
$this->pipeline
->setMiddlewares(
RetailcrmTools::filter(
'RetailcrmFilterMiddlewares',
[
RetailcrmLoggerMiddleware::class,
])
'RetailcrmFilterMiddlewares',
[
RetailcrmExceptionMiddleware::class,
RetailcrmLoggerMiddleware::class,
]
)
)
->setAction(function ($request) {
return call_user_func_array([$this->client, $request->getMethod()], $request->getData());
})
->build()
;
->build();
}
public function __call($method, $arguments)
{
$request = new RetailcrmApiRequest();
$request->setApi($this->client);
$request->setMethod($method);
$request->setData($arguments);
$response = $this->pipeline->run($request);
$request->setApi($this->client)
->setMethod($method)
->setData($arguments);
return $response;
return $this->pipeline->run($request);
}
}

61
retailcrm/lib/api/middleware/RetailcrmExceptionMiddleware.php Normal file
View file

@ -0,0 +1,61 @@
<?php
/**
* MIT License
*
* Copyright (c) 2020 DIGITAL RETAIL TECHNOLOGIES SL
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
* versions in the future. If you wish to customize PrestaShop for your
* needs please refer to http://www.prestashop.com for more information.
*
* @author DIGITAL RETAIL TECHNOLOGIES SL <mail@simlachat.com>
* @copyright 2021 DIGITAL RETAIL TECHNOLOGIES SL
* @license https://opensource.org/licenses/MIT The MIT License
*
* Don't forget to prefix your containers with your own identifier
* to avoid any conflicts with others containers.
*/
class RetailcrmExceptionMiddleware implements RetailcrmMiddlewareInterface
{
/**
* @inheritDoc
*/
public function __invoke(RetailcrmApiRequest $request, callable $next = null)
{
try {
$response = $next($request);
} catch (Exception $e) {
RetailcrmLogger::writeCaller($request->getMethod(), $e->getMessage());
RetailcrmLogger::writeNoCaller($e->getTraceAsString());
$response = new RetailcrmApiResponse(500, json_encode([
'success' => false,
'errorMsg' => sprintf('Internal error: %s', $e->getMessage())
]));
}
return $response;
}
}

54
retailcrm/lib/api/middleware/RetailcrmLoggerMiddleware.php
View file

@ -1,19 +1,57 @@
<?php
/**
* MIT License
*
* Copyright (c) 2020 DIGITAL RETAIL TECHNOLOGIES SL
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
* versions in the future. If you wish to customize PrestaShop for your
* needs please refer to http://www.prestashop.com for more information.
*
* @author DIGITAL RETAIL TECHNOLOGIES SL <mail@simlachat.com>
* @copyright 2021 DIGITAL RETAIL TECHNOLOGIES SL
* @license https://opensource.org/licenses/MIT The MIT License
*
* Don't forget to prefix your containers with your own identifier
* to avoid any conflicts with others containers.
*/
class RetailcrmLoggerMiddleware implements RetailcrmMiddlewareInterface
{
/**
* @param RetailcrmApiRequest $request
* @param callable|null $next
* @return RetailcrmApiResponse
* @inheritDoc
*/
public function __invoke(RetailcrmApiRequest $request, callable $next = null)
{
$method = $request->getMethod();
if (!is_null($request->getMethod())) {
if (!is_null($method)) {
RetailcrmLogger::writeDebug($method, print_r($request->getData(), true));
}
/** @var RetailcrmApiResponse $response */
$response = $next($request);
if ($response->isSuccessful()) {
@ -24,9 +62,11 @@ class RetailcrmLoggerMiddleware implements RetailcrmMiddlewareInterface
RetailcrmLogger::writeDebug($method, $response->getRawResponse());
}
} else {
RetailcrmLogger::writeCaller($method, $response->getErrorMsg());
if ($response->offsetExists('errorMsg')) {
RetailcrmLogger::writeCaller($method, $response['errorMsg']);
}
if (isset($response['errors'])) {
if ($response->offsetExists('errors')) {
RetailcrmApiErrors::set($response['errors'], $response->getStatusCode());
$error = RetailcrmLogger::reduceErrors($response['errors']);
RetailcrmLogger::writeNoCaller($error);
@ -35,4 +75,4 @@ class RetailcrmLoggerMiddleware implements RetailcrmMiddlewareInterface
return $response;
}
}
}

2
retailcrm/lib/api/pipeline/RetailcrmMiddlewareInterface.php
View file

@ -8,4 +8,4 @@ interface RetailcrmMiddlewareInterface
* @return RetailcrmApiResponse
*/
public function __invoke(RetailcrmApiRequest $request, callable $next = null);
}
}

2
retailcrm/lib/api/pipeline/RetailcrmPipeline.php
View file

@ -69,4 +69,4 @@ class RetailcrmPipeline
};
};
}
}
}

79
tests/lib/api/RetailcrmExceptionMiddlewareTest.php Normal file
View file

@ -0,0 +1,79 @@
<?php
class RetailcrmExceptionMiddlewareTest extends RetailcrmTestCase
{
private $api;
public function setUp()
{
parent::setUp();
$this->api = RetailcrmTools::getApiClient();
}
public function getRequests()
{
return [
[
'method' => 'ordersGet',
'params' => [406, 'idd'],
'errorMsg' => 'Value "idd" for "by" param is not valid. Allowed values are externalId, id.'
],
[
'method' => 'ordersEdit',
'params' => [['id' => 406], 'idd'],
'errorMsg' => 'Value "idd" for "by" param is not valid. Allowed values are externalId, id.'
],
[
'method' => 'ordersEdit',
'params' => [['id' => 406], 'externalId'],
'errorMsg' => 'Order array must contain the "externalId" parameter.'
],
[
'method' => 'ordersFixExternalIds',
'params' => [[]],
'errorMsg' => 'Method parameter must contains at least one IDs pair'
],
[
'method' => 'ordersCreate',
'params' => [[]],
'errorMsg' => 'Parameter `order` must contains a data'
],
[
'method' => 'ordersUpload',
'params' => [[]],
'errorMsg' => 'Parameter `orders` must contains array of the orders'
],
[
'method' => 'ordersPaymentCreate',
'params' => [[]],
'errorMsg' => 'Parameter `payment` must contains a data'
],
[
'method' => 'ordersPaymentEdit',
'params' => [['id' => 406], 'idd'],
'errorMsg' => 'Value "idd" for "by" param is not valid. Allowed values are externalId, id.'
],
[
'method' => 'ordersPaymentEdit',
'params' => [['id' => 406], 'externalId'],
'errorMsg' => 'Order array must contain the "externalId" parameter.'
],
];
}
/**
* @dataProvider getRequests
*/
public function testRequest($method, $params, $errorMsg)
{
/** @var RetailcrmApiResponse $response */
$response = call_user_func_array([$this->api, $method], $params);
$this->assertInstanceOf(RetailcrmApiResponse::class, $response);
$this->assertFalse($response->isSuccessful());
$this->assertStringStartsWith('Internal error: ', $response['errorMsg']);
$this->assertStringEndsWith($errorMsg, $response['errorMsg']);
}
}