Add support for configuration of graceful exception handling for serialization process.

Author: kszymukowicz

Classes/Serializer/Accessor/AccessorStrategy.php

@@ -34,17 +34,35 @@ public function __construct()
      */
     public function getValue(object $object, PropertyMetadata $metadata, SerializationContext $context)
     {
-        if ($metadata instanceof ExpressionPropertyMetadata) {
-            $variables = ['object' => $object, 'context' => $context, 'property_metadata' => $metadata];
+        try {
+            if ($metadata instanceof ExpressionPropertyMetadata) {
+                $variables = ['object' => $object, 'context' => $context, 'property_metadata' => $metadata];
+                return $this->evaluator->evaluate((string)($metadata->expression), $variables);
+            }
 
-            return $this->evaluator->evaluate((string)($metadata->expression), $variables);
-        }
+            if ($metadata->getter === null) {
+                return ObjectAccess::getProperty($object, $metadata->name);
+            }
+            return $object->{$metadata->getter}();
 
-        if ($metadata->getter === null) {
-            return ObjectAccess::getProperty($object, $metadata->name, false);
+        } catch (\Exception $exception) {
+            $exclusionForExceptions = $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['t3api']['serializer']['exclusionForExceptionsInAccessorStrategyGetValue'];
+            foreach ($exclusionForExceptions as $objectClass => $exceptionClasses) {
+                if ($object instanceof $objectClass) {
+                    if (in_array('*', $exceptionClasses, true)) {
+                        trigger_error($exception->getMessage(), E_USER_WARNING);
+                        return null;
+                    }
+                    foreach ($exceptionClasses as $exceptionClass) {
+                        if ($exception instanceof $exceptionClass) {
+                            trigger_error($exception->getMessage(), E_USER_WARNING);
+                            return null;
+                        }
+                    }
+                }
+            }
+            throw $exception;
         }
-
-        return $object->{$metadata->getter}();
     }
 
     /**

Documentation/Serialization/Exceptions/Index.rst

@@ -0,0 +1,46 @@
+.. include:: ../../Includes.txt
+
+
+.. _serialization_exceptions:
+
+==========
+Exceptions
+==========
+
+TYPO3 may encounter issues with FileReference or File objects, such as when a file
+is missing, inaccessible, or if the relation is broken. These issues can interrupt
+the serialization process and a jsonified error will be returned.
+To address this, we've introduced a configuration option that allows for the
+graceful handling of specific exceptions during the serialization process.
+This configuration is defined on a per-class basis, meaning that different
+classes can have different sets of exceptions that are handled gracefully.
+
+Once configured, these exceptions will not interrupt the serialization process
+for the respective class. Instead, they will be handled appropriately,
+allowing the serialization process to continue uninterrupted.
+This ensures that a problem with a single object does not prevent the successful
+serialization of other objects.
+
+
+Setting responsible for that is:
+
+.. code-block:: php
+    $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['t3api']['serializer']['exclusionForExceptionsInAccessorStrategyGetValue']
+
+
+Example value:
+
+.. code-block:: php
+        $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['t3api']['serializer']['exclusionForExceptionsInAccessorStrategyGetValue'] = [
+            \SourceBroker\T3apinews\Domain\Model\FileReference::class => [
+                \TYPO3\CMS\Core\Resource\Exception\FileDoesNotExistException::class,
+            ],
+        ];
+
+Asterix as "all exceptions" is also supported:
+Example:
+
+.. code-block:: php
+        $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['t3api']['serializer']['exclusionForExceptionsInAccessorStrategyGetValue'] = [
+            \SourceBroker\T3apinews\Domain\Model\FileReference::class => ['*'],
+        ];

Documentation/Serialization/Index.rst

@@ -17,3 +17,4 @@ Serialization
    Subscribers/Index
    YamlMetadata/Index
    Customization/Index
+   Exceptions/Index

ext_localconf.php

@@ -104,6 +104,17 @@ static function () {
             ];
         }
 
+        $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['t3api']['serializer']['exclusionForExceptionsInAccessorStrategyGetValue'] = [
+            TYPO3\CMS\Core\Resource\FileReference::class => [
+                \TYPO3\CMS\Core\Resource\Exception\FileDoesNotExistException::class,
+                \UnexpectedValueException::class,
+            ],
+            TYPO3\CMS\Extbase\Domain\Model\FileReference::class => [
+                \TYPO3\CMS\Core\Resource\Exception\FileDoesNotExistException::class,
+                \UnexpectedValueException::class,
+            ],
+        ];
+
         $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['clearCachePostProc']['t3api_clearcache'] =
             \SourceBroker\T3api\Service\SerializerService::class . '->clearCache';