Merge pull request #69 from piotrbelina/feature/fix-invalid-sort-value

Fixed invalid sort value type error
woohoolabs · Feb 6, 2018 · ec09233 · ec09233
2 parents efb8703 + 823f1fb
commit ec09233
Show file tree

Hide file tree

Showing 6 changed files with 114 additions and 0 deletions.
diff --git a/src/JsonApi/Exception/DefaultExceptionFactory.php b/src/JsonApi/Exception/DefaultExceptionFactory.php
@@ -75,6 +75,14 @@ public function createQueryParamUnrecognizedException(
         return new QueryParamUnrecognized($queryParamName);
     }
 
+    public function createQueryParamMalformedException(
+        RequestInterface $request,
+        string $queryParamName,
+        $queryParamValue
+    ): QueryParamMalformed {
+        return new QueryParamMalformed($queryParamName, $queryParamValue);
+    }
+
     public function createRelationshipNotExistsException(string $relationship): RelationshipNotExists
     {
         return new RelationshipNotExists($relationship);

diff --git a/src/JsonApi/Exception/ExceptionFactoryInterface.php b/src/JsonApi/Exception/ExceptionFactoryInterface.php
@@ -64,6 +64,11 @@ public function createMediaTypeUnacceptableException(RequestInterface $request,
      */
     public function createQueryParamUnrecognizedException(RequestInterface $request, string $queryParamName);
 
+    /**
+     * @return JsonApiExceptionInterface|Exception
+     */
+    public function createQueryParamMalformedException(RequestInterface $request, string $queryParamName, $queryParamValue);
+
     /**
      * @return JsonApiExceptionInterface|Exception
      */

diff --git a/src/JsonApi/Exception/QueryParamMalformed.php b/src/JsonApi/Exception/QueryParamMalformed.php
@@ -0,0 +1,54 @@
+<?php
+declare(strict_types=1);
+
+namespace WoohooLabs\Yin\JsonApi\Exception;
+
+use WoohooLabs\Yin\JsonApi\Schema\Error;
+use WoohooLabs\Yin\JsonApi\Schema\ErrorSource;
+
+class QueryParamMalformed extends JsonApiException
+{
+    /**
+     * @var string
+     */
+    protected $malformedQueryParam;
+
+    /**
+     * @var mixed
+     */
+    protected $malformedQueryParamValue;
+
+    /**
+     * QueryParamMalformed constructor.
+     * @param string $malformedQueryParam
+     * @param mixed $malformedQueryParamValue
+     */
+    public function __construct(string $malformedQueryParam, $malformedQueryParamValue)
+    {
+        parent::__construct("Query parameter '$malformedQueryParam' is malformed!");
+        $this->malformedQueryParam = $malformedQueryParam;
+        $this->malformedQueryParamValue = $malformedQueryParamValue;
+    }
+
+    protected function getErrors(): array
+    {
+        return [
+            Error::create()
+                ->setStatus("400")
+                ->setCode("QUERY_PARAM_MALFORMED")
+                ->setTitle("Query parameter is malformed")
+                ->setDetail("Query parameter '$this->malformedQueryParam' is malformed!")
+                ->setSource(ErrorSource::fromParameter($this->malformedQueryParam))
+        ];
+    }
+
+    public function getMalformedQueryParam(): string
+    {
+        return $this->malformedQueryParam;
+    }
+
+    public function getMalformedQueryParamValue()
+    {
+        return $this->malformedQueryParamValue;
+    }
+}
diff --git a/src/JsonApi/Request/Request.php b/src/JsonApi/Request/Request.php
@@ -10,6 +10,7 @@
 use WoohooLabs\Yin\JsonApi\Exception\ExceptionFactoryInterface;
 use WoohooLabs\Yin\JsonApi\Exception\MediaTypeUnacceptable;
 use WoohooLabs\Yin\JsonApi\Exception\MediaTypeUnsupported;
+use WoohooLabs\Yin\JsonApi\Exception\QueryParamMalformed;
 use WoohooLabs\Yin\JsonApi\Exception\QueryParamUnrecognized;
 use WoohooLabs\Yin\JsonApi\Hydrator\Relationship\ToManyRelationship;
 use WoohooLabs\Yin\JsonApi\Hydrator\Relationship\ToOneRelationship;
@@ -278,8 +279,12 @@ public function getSorting(): array
     protected function setSorting()
     {
         $sortingQueryParam = $this->getQueryParam("sort", "");
+        if (!is_string($sortingQueryParam)) {
+            throw $this->exceptionFactory->createQueryParamMalformedException($this, "sort", $sortingQueryParam);
+        }
         if ($sortingQueryParam === "") {
             $this->sorting = [];
+
             return;
         }
 

diff --git a/tests/JsonApi/Exception/QueryParamMalformedTest.php b/tests/JsonApi/Exception/QueryParamMalformedTest.php
@@ -0,0 +1,28 @@
+<?php
+declare(strict_types=1);
+
+namespace WoohooLabs\Yin\Tests\JsonApi\Exception;
+
+use PHPUnit\Framework\TestCase;
+use WoohooLabs\Yin\JsonApi\Exception\QueryParamMalformed;
+
+class QueryParamMalformedTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function getQueryParam()
+    {
+        $queryParam = "sort";
+        $queryParamValue = ["field" => "asc"];
+
+        $exception = $this->createException($queryParam, $queryParamValue);
+        $this->assertEquals($queryParam, $exception->getMalformedQueryParam());
+        $this->assertEquals($queryParamValue, $exception->getMalformedQueryParamValue());
+    }
+
+    private function createException($queryParam, $queryParamValue): QueryParamMalformed
+    {
+        return new QueryParamMalformed($queryParam, $queryParamValue);
+    }
+}
diff --git a/tests/JsonApi/Request/RequestTest.php b/tests/JsonApi/Request/RequestTest.php
@@ -8,6 +8,7 @@
 use WoohooLabs\Yin\JsonApi\Exception\DefaultExceptionFactory;
 use WoohooLabs\Yin\JsonApi\Exception\MediaTypeUnacceptable;
 use WoohooLabs\Yin\JsonApi\Exception\MediaTypeUnsupported;
+use WoohooLabs\Yin\JsonApi\Exception\QueryParamMalformed;
 use WoohooLabs\Yin\JsonApi\Exception\QueryParamUnrecognized;
 use WoohooLabs\Yin\JsonApi\Request\Pagination\CursorBasedPagination;
 use WoohooLabs\Yin\JsonApi\Request\Pagination\FixedPageBasedPagination;
@@ -417,6 +418,19 @@ public function getSortingWhenNotEmpty()
         $this->assertEquals($sorting, $request->getSorting());
     }
 
+    /**
+     * @test
+     */
+    public function getSortingWhenMalformed()
+    {
+        $this->expectException(QueryParamMalformed::class);
+
+        $queryParams = ["sort" => ["name" => "asc"]];
+
+        $request = $this->createRequestWithQueryParams($queryParams);
+        $request->getSorting();
+    }
+
     /**
      * @test
      */