fix: Use FilterValidationException instead of InvalidArgumentExceptio…

…n to generate 400 and no 500 errors
roadiz · Jul 2, 2023 · ca89b73 · ca89b73
1 parent 4ee1511
commit ca89b73
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 14 deletions.
diff --git a/lib/RoadizCoreBundle/src/Api/Filter/ArchiveFilter.php b/lib/RoadizCoreBundle/src/Api/Filter/ArchiveFilter.php
@@ -7,8 +7,8 @@
 use ApiPlatform\Core\Bridge\Doctrine\Common\PropertyHelperTrait;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\AbstractContextAwareFilter;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\DateFilter;
-use ApiPlatform\Core\Exception\InvalidArgumentException;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
+use ApiPlatform\Exception\FilterValidationException;
 use Doctrine\ORM\QueryBuilder;
 
 final class ArchiveFilter extends AbstractContextAwareFilter
@@ -54,10 +54,10 @@ protected function filterProperty(
         }
 
         if (!is_string($values[self::PARAMETER_ARCHIVE])) {
-            throw new InvalidArgumentException(sprintf(
+            throw new FilterValidationException([sprintf(
                 '“%s” filter must be only used with a string value.',
                 self::PARAMETER_ARCHIVE
-            ));
+            )]);
         }
 
         $range = $this->normalizeFilteringDates($values[self::PARAMETER_ARCHIVE]);

diff --git a/lib/RoadizCoreBundle/src/Api/Filter/IntersectionFilter.php b/lib/RoadizCoreBundle/src/Api/Filter/IntersectionFilter.php
@@ -5,8 +5,8 @@
 namespace RZ\Roadiz\CoreBundle\Api\Filter;
 
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\AbstractContextAwareFilter;
-use ApiPlatform\Core\Exception\InvalidArgumentException;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
+use ApiPlatform\Exception\FilterValidationException;
 use Doctrine\ORM\Query\Expr\Join;
 use Doctrine\ORM\QueryBuilder;
 
@@ -19,7 +19,6 @@ final class IntersectionFilter extends AbstractContextAwareFilter
 
     /**
      * @inheritDoc
-     * @param mixed $value
      */
     protected function filterProperty(
         string $property,
@@ -35,7 +34,7 @@ protected function filterProperty(
 
         foreach ($value as $fieldName => $fieldValue) {
             if (empty($fieldName)) {
-                throw new InvalidArgumentException(sprintf('“%s” filter must be only used with an associative array with fields as keys.', $property));
+                throw new FilterValidationException([sprintf('“%s” filter must be only used with an associative array with fields as keys.', $property)]);
             }
             if ($this->isPropertyEnabled($fieldName, $resourceClass)) {
                 // Allow single value intersection
@@ -115,7 +114,7 @@ protected function addDuplicatedJoinsForNestedProperty(
         }
 
         if (null === $alias) {
-            throw new InvalidArgumentException(sprintf('Cannot add joins for property "%s" - property is not nested.', $property));
+            throw new FilterValidationException([sprintf('Cannot add joins for property "%s" - property is not nested.', $property)]);
         }
 
         return [$alias, $propertyParts['field'], $propertyParts['associations']];

diff --git a/lib/RoadizCoreBundle/src/Api/Filter/LocaleFilter.php b/lib/RoadizCoreBundle/src/Api/Filter/LocaleFilter.php
@@ -5,7 +5,7 @@
 namespace RZ\Roadiz\CoreBundle\Api\Filter;
 
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
-use ApiPlatform\Core\Exception\InvalidArgumentException;
+use ApiPlatform\Exception\FilterValidationException;
 use Doctrine\ORM\QueryBuilder;
 use Doctrine\Persistence\ManagerRegistry;
 use Psr\Log\LoggerInterface;
@@ -65,13 +65,20 @@ protected function filterProperty(
                 ->getRepository(Translation::class)
                 ->getAvailableLocales();
         }
+
+        if (count($supportedLocales) === 0) {
+            throw new FilterValidationException(
+                ['Locale filter is not available because no translation exist.']
+            );
+        }
+
         if (!in_array($value, $supportedLocales)) {
-            throw new InvalidArgumentException(
-                sprintf(
+            throw new FilterValidationException(
+                [sprintf(
                     'Locale filter value "%s" not supported. Supported values are %s',
                     $value,
                     implode(', ', $supportedLocales)
-                )
+                )]
             );
         }
 
@@ -93,7 +100,7 @@ protected function filterProperty(
             }
 
             if (null === $translation) {
-                throw new InvalidArgumentException('No translation exist for locale: ' . $value);
+                throw new FilterValidationException(['No translation exist for locale: ' . $value]);
             }
 
             $queryBuilder
@@ -121,8 +128,8 @@ public function getDescription(string $resourceClass): array
     {
         $supportedLocales = $this->managerRegistry->getRepository(Translation::class)->getAvailableLocales();
         return  [
-            static::PROPERTY =>  [
-                'property' => static::PROPERTY,
+            self::PROPERTY =>  [
+                'property' => self::PROPERTY,
                 'type' => 'string',
                 'required' => false,
                 'openapi' => [