Send plugin error messages to the client

aimeos · Feb 26, 2019 · 89fff67 · 89fff67
1 parent 4c28e68
commit 89fff67
Show file tree

Hide file tree

Showing 11 changed files with 257 additions and 0 deletions.
diff --git a/client/jsonapi/src/Client/JsonApi/Basket/Address/Standard.php b/client/jsonapi/src/Client/JsonApi/Basket/Address/Standard.php
@@ -88,6 +88,12 @@ public function delete( ServerRequestInterface $request, ResponseInterface $resp
 			$view->item = $this->controller->get();
 			$status = 200;
 		}
+		catch( \Aimeos\MShop\Plugin\Provider\Exception $e )
+		{
+			$status = 409;
+			$errors = $this->translatePluginErrorCodes( $e->getErrorCodes() );
+			$view->errors = $this->getErrorDetails( $e, 'mshop' ) + $errors;
+		}
 		catch( \Aimeos\MShop\Exception $e )
 		{
 			$status = 404;
@@ -142,6 +148,12 @@ public function post( ServerRequestInterface $request, ResponseInterface $respon
 			$view->item = $this->controller->get();
 			$status = 201;
 		}
+		catch( \Aimeos\MShop\Plugin\Provider\Exception $e )
+		{
+			$status = 409;
+			$errors = $this->translatePluginErrorCodes( $e->getErrorCodes() );
+			$view->errors = $this->getErrorDetails( $e, 'mshop' ) + $errors;
+		}
 		catch( \Aimeos\MShop\Exception $e )
 		{
 			$status = 404;

diff --git a/client/jsonapi/src/Client/JsonApi/Basket/Base.php b/client/jsonapi/src/Client/JsonApi/Basket/Base.php
@@ -30,4 +30,28 @@ protected function clearCache()
 			$session->set( $key, null );
 		}
 	}
+
+
+	/**
+	 * Translates the plugin error codes to human readable error strings.
+	 *
+	 * @param array $codes Associative list of scope and object as key and error code as value
+	 * @return array List of translated error messages
+	 */
+	protected function translatePluginErrorCodes( array $codes )
+	{
+		$errors = [];
+		$i18n = $this->getContext()->getI18n();
+
+		foreach( $codes as $scope => $list )
+		{
+			foreach( $list as $object => $errcode )
+			{
+				$key = $scope . ( $scope !== 'product' ? '.' . $object : '' ) . '.' . $errcode;
+				$errors[] = $i18n->dt( 'mshop/code', $key );
+			}
+		}
+
+		return $errors;
+	}
 }
diff --git a/client/jsonapi/src/Client/JsonApi/Basket/Coupon/Standard.php b/client/jsonapi/src/Client/JsonApi/Basket/Coupon/Standard.php
@@ -88,6 +88,12 @@ public function delete( ServerRequestInterface $request, ResponseInterface $resp
 			$view->item = $this->controller->get();
 			$status = 200;
 		}
+		catch( \Aimeos\MShop\Plugin\Provider\Exception $e )
+		{
+			$status = 409;
+			$errors = $this->translatePluginErrorCodes( $e->getErrorCodes() );
+			$view->errors = $this->getErrorDetails( $e, 'mshop' ) + $errors;
+		}
 		catch( \Aimeos\MShop\Exception $e )
 		{
 			$status = 404;
@@ -142,6 +148,12 @@ public function post( ServerRequestInterface $request, ResponseInterface $respon
 			$view->item = $this->controller->get();
 			$status = 201;
 		}
+		catch( \Aimeos\MShop\Plugin\Provider\Exception $e )
+		{
+			$status = 409;
+			$errors = $this->translatePluginErrorCodes( $e->getErrorCodes() );
+			$view->errors = $this->getErrorDetails( $e, 'mshop' ) + $errors;
+		}
 		catch( \Aimeos\MShop\Exception $e )
 		{
 			$status = 404;

diff --git a/client/jsonapi/src/Client/JsonApi/Basket/Product/Standard.php b/client/jsonapi/src/Client/JsonApi/Basket/Product/Standard.php
@@ -88,6 +88,12 @@ public function delete( ServerRequestInterface $request, ResponseInterface $resp
 			$view->item = $this->controller->get();
 			$status = 200;
 		}
+		catch( \Aimeos\MShop\Plugin\Provider\Exception $e )
+		{
+			$status = 409;
+			$errors = $this->translatePluginErrorCodes( $e->getErrorCodes() );
+			$view->errors = $this->getErrorDetails( $e, 'mshop' ) + $errors;
+		}
 		catch( \Aimeos\MShop\Exception $e )
 		{
 			$status = 404;
@@ -149,6 +155,12 @@ public function patch( ServerRequestInterface $request, ResponseInterface $respo
 			$view->item = $this->controller->get();
 			$status = 200;
 		}
+		catch( \Aimeos\MShop\Plugin\Provider\Exception $e )
+		{
+			$status = 409;
+			$errors = $this->translatePluginErrorCodes( $e->getErrorCodes() );
+			$view->errors = $this->getErrorDetails( $e, 'mshop' ) + $errors;
+		}
 		catch( \Aimeos\MShop\Exception $e )
 		{
 			$status = 404;
@@ -211,6 +223,12 @@ public function post( ServerRequestInterface $request, ResponseInterface $respon
 			$view->item = $this->controller->get();
 			$status = 201;
 		}
+		catch( \Aimeos\MShop\Plugin\Provider\Exception $e )
+		{
+			$status = 409;
+			$errors = $this->translatePluginErrorCodes( $e->getErrorCodes() );
+			$view->errors = $this->getErrorDetails( $e, 'mshop' ) + $errors;
+		}
 		catch( \Aimeos\MShop\Exception $e )
 		{
 			$status = 404;

diff --git a/client/jsonapi/src/Client/JsonApi/Basket/Service/Standard.php b/client/jsonapi/src/Client/JsonApi/Basket/Service/Standard.php
@@ -88,6 +88,12 @@ public function delete( ServerRequestInterface $request, ResponseInterface $resp
 			$view->item = $this->controller->get();
 			$status = 200;
 		}
+		catch( \Aimeos\MShop\Plugin\Provider\Exception $e )
+		{
+			$status = 409;
+			$errors = $this->translatePluginErrorCodes( $e->getErrorCodes() );
+			$view->errors = $this->getErrorDetails( $e, 'mshop' ) + $errors;
+		}
 		catch( \Aimeos\MShop\Exception $e )
 		{
 			$status = 404;
@@ -153,6 +159,12 @@ public function post( ServerRequestInterface $request, ResponseInterface $respon
 			$view->item = $this->controller->get();
 			$status = 201;
 		}
+		catch( \Aimeos\MShop\Plugin\Provider\Exception $e )
+		{
+			$status = 409;
+			$errors = $this->translatePluginErrorCodes( $e->getErrorCodes() );
+			$view->errors = $this->getErrorDetails( $e, 'mshop' ) + $errors;
+		}
 		catch( \Aimeos\MShop\Exception $e )
 		{
 			$status = 404;

diff --git a/client/jsonapi/src/Client/JsonApi/Basket/Standard.php b/client/jsonapi/src/Client/JsonApi/Basket/Standard.php
@@ -58,6 +58,12 @@ public function delete( ServerRequestInterface $request, ResponseInterface $resp
 			$type = $view->param( 'id', 'default' );
 			$view->item = $this->controller->setType( $type )->clear()->get();
 		}
+		catch( \Aimeos\MShop\Plugin\Provider\Exception $e )
+		{
+			$status = 409;
+			$errors = $this->translatePluginErrorCodes( $e->getErrorCodes() );
+			$view->errors = $this->getErrorDetails( $e, 'mshop' ) + $errors;
+		}
 		catch( \Aimeos\MShop\Exception $e )
 		{
 			$status = 404;
@@ -146,6 +152,12 @@ public function patch( ServerRequestInterface $request, ResponseInterface $respo
 			$view->item = $basket;
 			$status = 200;
 		}
+		catch( \Aimeos\MShop\Plugin\Provider\Exception $e )
+		{
+			$status = 409;
+			$errors = $this->translatePluginErrorCodes( $e->getErrorCodes() );
+			$view->errors = $this->getErrorDetails( $e, 'mshop' ) + $errors;
+		}
 		catch( \Aimeos\MShop\Exception $e )
 		{
 			$status = 404;
@@ -182,6 +194,12 @@ public function post( ServerRequestInterface $request, ResponseInterface $respon
 			$view->item = $item;
 			$status = 200;
 		}
+		catch( \Aimeos\MShop\Plugin\Provider\Exception $e )
+		{
+			$status = 409;
+			$errors = $this->translatePluginErrorCodes( $e->getErrorCodes() );
+			$view->errors = $this->getErrorDetails( $e, 'mshop' ) + $errors;
+		}
 		catch( \Aimeos\MShop\Exception $e )
 		{
 			$status = 404;

diff --git a/client/jsonapi/tests/Client/JsonApi/Basket/Address/StandardTest.php b/client/jsonapi/tests/Client/JsonApi/Basket/Address/StandardTest.php
@@ -91,6 +91,19 @@ public function testDeleteById()
 	}
 
 
+	public function testDeletePluginException()
+	{
+		$object = $this->getObject( 'setType', $this->throwException( new \Aimeos\MShop\Plugin\Provider\Exception() ) );
+
+		$response = $object->delete( $this->view->request(), $this->view->response() );
+		$result = json_decode( (string) $response->getBody(), true );
+
+
+		$this->assertEquals( 409, $response->getStatusCode() );
+		$this->assertArrayHasKey( 'errors', $result );
+	}
+
+
 	public function testDeleteMShopException()
 	{
 		$object = $this->getObject( 'setType', $this->throwException( new \Aimeos\MShop\Exception() ) );
@@ -166,6 +179,19 @@ public function testPostMultiple()
 	}
 
 
+	public function testPostPluginException()
+	{
+		$object = $this->getObject( 'setType', $this->throwException( new \Aimeos\MShop\Plugin\Provider\Exception() ) );
+
+		$response = $object->post( $this->view->request(), $this->view->response() );
+		$result = json_decode( (string) $response->getBody(), true );
+
+
+		$this->assertEquals( 409, $response->getStatusCode() );
+		$this->assertArrayHasKey( 'errors', $result );
+	}
+
+
 	public function testPostMShopException()
 	{
 		$object = $this->getObject( 'setType', $this->throwException( new \Aimeos\MShop\Exception() ) );

diff --git a/client/jsonapi/tests/Client/JsonApi/Basket/Coupon/StandardTest.php b/client/jsonapi/tests/Client/JsonApi/Basket/Coupon/StandardTest.php
@@ -95,6 +95,19 @@ public function testDeleteById()
 	}
 
 
+	public function testDeletePluginException()
+	{
+		$object = $this->getObject( 'setType', $this->throwException( new \Aimeos\MShop\Plugin\Provider\Exception() ) );
+
+		$response = $object->delete( $this->view->request(), $this->view->response() );
+		$result = json_decode( (string) $response->getBody(), true );
+
+
+		$this->assertEquals( 409, $response->getStatusCode() );
+		$this->assertArrayHasKey( 'errors', $result );
+	}
+
+
 	public function testDeleteMShopException()
 	{
 		$object = $this->getObject( 'setType', $this->throwException( new \Aimeos\MShop\Exception() ) );
@@ -171,6 +184,19 @@ public function testPostMultiple()
 	}
 
 
+	public function testPostPluginException()
+	{
+		$object = $this->getObject( 'setType', $this->throwException( new \Aimeos\MShop\Plugin\Provider\Exception() ) );
+
+		$response = $object->post( $this->view->request(), $this->view->response() );
+		$result = json_decode( (string) $response->getBody(), true );
+
+
+		$this->assertEquals( 409, $response->getStatusCode() );
+		$this->assertArrayHasKey( 'errors', $result );
+	}
+
+
 	public function testPostMShopException()
 	{
 		$object = $this->getObject( 'setType', $this->throwException( new \Aimeos\MShop\Exception() ) );

diff --git a/client/jsonapi/tests/Client/JsonApi/Basket/Product/StandardTest.php b/client/jsonapi/tests/Client/JsonApi/Basket/Product/StandardTest.php
@@ -105,6 +105,19 @@ public function testDeleteById()
 	}
 
 
+	public function testDeletePluginException()
+	{
+		$object = $this->getObject( 'setType', $this->throwException( new \Aimeos\MShop\Plugin\Provider\Exception() ) );
+
+		$response = $object->delete( $this->view->request(), $this->view->response() );
+		$result = json_decode( (string) $response->getBody(), true );
+
+
+		$this->assertEquals( 409, $response->getStatusCode() );
+		$this->assertArrayHasKey( 'errors', $result );
+	}
+
+
 	public function testDeleteMShopException()
 	{
 		$object = $this->getObject( 'setType', $this->throwException( new \Aimeos\MShop\Exception() ) );
@@ -163,6 +176,22 @@ public function testPatch()
 	}
 
 
+	public function testPatchPluginException()
+	{
+		$object = $this->getObject( 'setType', $this->throwException( new \Aimeos\MShop\Plugin\Provider\Exception() ) );
+
+		$body = '{"data": {"attributes": []}}';
+		$request = $this->view->request()->withBody( $this->view->response()->createStreamFromString( $body ) );
+
+		$response = $object->patch( $request, $this->view->response() );
+		$result = json_decode( (string) $response->getBody(), true );
+
+
+		$this->assertEquals( 409, $response->getStatusCode() );
+		$this->assertArrayHasKey( 'errors', $result );
+	}
+
+
 	public function testPatchMShopException()
 	{
 		$object = $this->getObject( 'setType', $this->throwException( new \Aimeos\MShop\Exception() ) );
@@ -248,6 +277,19 @@ public function testPostMultiple()
 	}
 
 
+	public function testPostPluginException()
+	{
+		$object = $this->getObject( 'setType', $this->throwException( new \Aimeos\MShop\Plugin\Provider\Exception() ) );
+
+		$response = $object->post( $this->view->request(), $this->view->response() );
+		$result = json_decode( (string) $response->getBody(), true );
+
+
+		$this->assertEquals( 409, $response->getStatusCode() );
+		$this->assertArrayHasKey( 'errors', $result );
+	}
+
+
 	public function testPostMShopException()
 	{
 		$object = $this->getObject( 'setType', $this->throwException( new \Aimeos\MShop\Exception() ) );

diff --git a/client/jsonapi/tests/Client/JsonApi/Basket/Service/StandardTest.php b/client/jsonapi/tests/Client/JsonApi/Basket/Service/StandardTest.php
@@ -97,6 +97,19 @@ public function testDeleteById()
 	}
 
 
+	public function testDeletePluginException()
+	{
+		$object = $this->getObject( 'setType', $this->throwException( new \Aimeos\MShop\Plugin\Provider\Exception() ) );
+
+		$response = $object->delete( $this->view->request(), $this->view->response() );
+		$result = json_decode( (string) $response->getBody(), true );
+
+
+		$this->assertEquals( 409, $response->getStatusCode() );
+		$this->assertArrayHasKey( 'errors', $result );
+	}
+
+
 	public function testDeleteMShopException()
 	{
 		$object = $this->getObject( 'setType', $this->throwException( new \Aimeos\MShop\Exception() ) );
@@ -178,6 +191,19 @@ public function testPostMultiple()
 	}
 
 
+	public function testPostPluginException()
+	{
+		$object = $this->getObject( 'setType', $this->throwException( new \Aimeos\MShop\Plugin\Provider\Exception() ) );
+
+		$response = $object->post( $this->view->request(), $this->view->response() );
+		$result = json_decode( (string) $response->getBody(), true );
+
+
+		$this->assertEquals( 409, $response->getStatusCode() );
+		$this->assertArrayHasKey( 'errors', $result );
+	}
+
+
 	public function testPostMShopException()
 	{
 		$object = $this->getObject( 'setType', $this->throwException( new \Aimeos\MShop\Exception() ) );