Merge pull request #9 from wol-soft/SkipFilterAfterTransformingFilterIfTransformationFails

Skip filters after a failing transforming filter

Author: wol-soft

docs/source/nonStandardExtensions/filter.rst

@@ -84,7 +84,7 @@ Filters may change the type of the property. For example the builtin filter **da
 
 As the required check is executed before the filter a filter may transform a required value into a null value. Be aware when writing custom filters which transform values to not break your validation rules by adding filters to a property.
 
-Only one transforming filter per property is allowed. may be positioned anywhere in the filter chain of a single property. If multiple filters are applied and a transforming filter is among them you have to make sure the property types are compatible. If you use a custom filter after the dateTime filter for example the custom filter has to accept a DateTime value. Filters used before a transforming filter must accept the base type of the property the filter is applied to defined in the schema.
+Only one transforming filter per property is allowed. may be positioned anywhere in the filter chain of a single property. If multiple filters are applied and a transforming filter is among them you have to make sure the property types are compatible. If you use a custom filter after the dateTime filter for example the custom filter has to accept a DateTime value. Filters used before a transforming filter must accept the base type of the property the filter is applied to defined in the schema. If the transformation of a property fails (the transforming filter throws an exception), subsequent filters won't be executed as their execution would add another error due to incompatible types which is irrelevant for the currently provided value.
 
 If you write a custom transforming filter you must define the return type of your filter function as the implementation uses Reflection methods to determine to which type a value is transformed by a filter.
 

src/Model/Validator/FilterValidator.php

@@ -21,6 +21,9 @@
  */
 class FilterValidator extends PropertyTemplateValidator
 {
+    /** @var FilterInterface $filter */
+    protected $filter;
+
     /**
      * FilterValidator constructor.
      *
@@ -31,6 +34,7 @@ class FilterValidator extends PropertyTemplateValidator
      * @param TransformingFilterInterface|null $transformingFilter
      *
      * @throws SchemaException
+     * @throws ReflectionException
      */
     public function __construct(
         GeneratorConfiguration $generatorConfiguration,
@@ -39,6 +43,8 @@ public function __construct(
         array $filterOptions = [],
         ?TransformingFilterInterface $transformingFilter = null
     ) {
+        $this->filter = $filter;
+
         $transformingFilter === null
             ? $this->validateFilterCompatibilityWithBaseType($filter, $property)
             : $this->validateFilterCompatibilityWithTransformedType($filter, $transformingFilter, $property);
@@ -51,7 +57,8 @@ public function __construct(
             ),
             DIRECTORY_SEPARATOR . 'Validator' . DIRECTORY_SEPARATOR . 'Filter.phptpl',
             [
-                'skipTransformedValuesCheck' => false,
+                'skipTransformedValuesCheck' => $transformingFilter !== null ? '!$transformationFailed' : '',
+                'isTransformingFilter' => $filter instanceof TransformingFilterInterface,
                 // check if the given value has a type matched by the filter
                 'typeCheck' => !empty($filter->getAcceptedTypes())
                     ? '($value !== null && (' .
@@ -73,6 +80,19 @@ public function __construct(
         );
     }
 
+    /**
+     * Track if a transformation failed. If a transformation fails don't execute subsequent filter as they'd fail with
+     * an invalid type
+     *
+     * @return string
+     */
+    public function getValidatorSetUp(): string
+    {
+        return $this->filter instanceof TransformingFilterInterface
+            ? '$transformationFailed = false;'
+            : '';
+    }
+
     /**
      * Make sure the filter is only executed if a non-transformed value is provided.
      * This is required as a setter (eg. for a string property which is modified by the DateTime filter into a DateTime

src/Templates/Validator/Filter.phptpl

@@ -1,11 +1,15 @@
 {% if skipTransformedValuesCheck %}{{ skipTransformedValuesCheck }} && {% endif %}
 (
     {% if typeCheck %}{{ typeCheck }} || {% endif %}
-    (function (&$value) {
+    (function (&$value) use (&$transformationFailed): bool {
         // make sure exceptions from the filter are caught and added to the error handling
         try {
             $value = call_user_func_array([\{{ filterClass }}::class, "{{ filterMethod }}"], [$value, {{ filterOptions }}]);
         } catch (\Exception $e) {
+            {% if isTransformingFilter %}
+                $transformationFailed = true;
+            {% endif %}
+
             {{ viewHelper.validationError(transferExceptionMessage) }}
         }
 

tests/Basic/FilterTest.php

@@ -679,6 +679,29 @@ public function testFilterChainWithTransformingFilterOnMultiTypeProperty(bool $i
         $this->assertSame(['filteredProperty' => '2020-12-12T00:00:00+0000'], $object->toArray());
     }
 
+    public function testFilterAfterTransformingFilterIsSkippedIfTransformingFilterFails(): void
+    {
+        $this->expectException(ErrorRegistryException::class);
+        $this->expectExceptionMessage(
+            'Invalid value for property filteredProperty denied by filter dateTime: Invalid Date Time value "Hello"'
+        );
+
+        $className = $this->generateClassFromFile(
+            'FilterChainMultiType.json',
+            (new GeneratorConfiguration())
+                ->addFilter(
+                    $this->getCustomFilter(
+                        [self::class, 'exceptionFilter'],
+                        'stripTime',
+                        [DateTime::class]
+                    )
+                ),
+            false
+        );
+
+        new $className(['filteredProperty' => 'Hello']);
+    }
+
     public function testFilterWhichAppliesToMultiTypePropertyPartiallyThrowsAnException(): void
     {
         $this->expectException(SchemaException::class);