chore: Improve mock data handling

doc/10_GraphQL/README.md

@@ -95,3 +95,65 @@ Open the settings and change `request.credentials` to `include`. Otherwise the
 `XDEBUG_SESSION` cookie header will get removed by default.
 
 ![Settings](../img/graphql/debugging.png)
+
+## Mockup Elements
+
+**!Beware!** It is a quite complex undertaking to implement this correctly, but worth it if you need a high-performance integration of product indexes.
+
+DataHub supports the use of Mockup Objects / Elements as used in Pimcores Ecommerce Framework Bundle IndexService.
+In order to use a Mockup Class it has to implement DataHubs own interface: \Pimcore\Bundle\DataHubBundle\Model\ElementMockupInterface
+
+Mockup elements will be resolved differently, operators and or sub-elements are 
+only resolved if the requested data structure isn't already available in the mockup itself.
+As such Mockup Objects have to ensure to return the same output as a non-mocked
+query would.
+
+One particular way to do this is to implement a callback in the mockup and use
+the passed in GraphQl Execution context to resolve the data,
+
+Example of returning Image Thumbnail Path:
+
+```php
+class AssetMockup implements ElementMockupInterface
+{
+    use ElementMockupTrait;
+
+    /**
+     * @return array
+     */
+    public function getFullpath(): ?string
+    {
+        // Check if this is a graphQL callback.
+        $suffix = null;
+        if ($this->isGraphqlCallback(__FUNCTION__)) {
+            if ($thumbnail = $this->getGraphQLArguments()['thumbnail'] ?? null) {
+                $suffix = '_' . $thumbnail;
+            }
+        }
+        return $this->getParam('fullpath' . $suffix) ?? $this->getParam('fullpath') ?? null;
+    }
+}
+```
+
+Will use the returned value, or if null is returned the original Asset is used to resolve the value.
+
+The mockup support can be enabled and configured with a configuration entry like this in your `config.yml` file:
+```yml
+#### DATAHUB MOCKUP ELEMENTS
+pimcore_data_hub:
+    graphql:
+        mockup_element_support_enabled: true
+```
+
+## Permission Check Cache
+
+By default only a single permission check per request is executed. 
+This is different from previous versions in which the event 
+`pimcore.datahub.graphql.permission.preCheck` was fired multiple times during the execution.
+
+The new approach limits the performance impact of the permission handling - but can be disabled using following setting:
+```yml
+pimcore_data_hub:
+    graphql:
+        disable_permission_check_cache: true
+```

src/Controller/WebserviceController.php

@@ -176,6 +176,8 @@ public function webonyxAction(
         if (isset($datahubConfig['graphql']) && isset($datahubConfig['graphql']['not_allowed_policy'])) {
             PimcoreDataHubBundle::setNotAllowedPolicy($datahubConfig['graphql']['not_allowed_policy']);
         }
+        $context['disable_permission_check_cache'] = !empty($datahubConfig['graphql']['disable_permission_check_cache']);
+        $context['mockup_element_support_enabled'] = !empty($datahubConfig['graphql']['mockup_element_support_enabled']);
 
         $validators = null;
         if ($request->get('novalidate')) {

src/DependencyInjection/Configuration.php

@@ -39,6 +39,8 @@ public function getConfigTreeBuilder()
                         ->scalarNode('not_allowed_policy')->info('throw exception = 1, return null = 2')->defaultValue(2)->end()
                         ->booleanNode('output_cache_enabled')->info('enables output cache for graphql responses. It is disabled by default')->defaultValue(false)->end()
                         ->integerNode('output_cache_lifetime')->info('output cache in seconds. Default is 30 seconds')->defaultValue(30)->end()
+                        ->booleanNode('mockup_element_support_enabled')->info('Enable support of mockup elements as used by Ecommerce Framework Bundle IndexService. You have to use your own Mockup class(es) that implement DataHubs ElementMockupInterface')->defaultValue(false)->end()
+                        ->booleanNode('disable_permission_check_cache')->info('Disables the permission check static cache. Use only if you have very specific cases in which the permission can change _within_ the same request!')->defaultValue(false)->end()
                         ->booleanNode('allow_introspection')->info('enables introspection for graphql. It is enabled by default')->defaultValue(true)->end()
                         ->booleanNode('run_subrequest_per_query')->info('If enabled a Symfony Sub-Requet is triggered for each query in a multi-query request.')->defaultValue(false)->end()
                     ->end()

src/GraphQL/DataObjectQueryFieldConfigGenerator/AbstractTable.php

@@ -41,7 +41,7 @@ public function getGraphQlFieldConfig($attribute, Data $fieldDefinition, $class
             'name' => $fieldDefinition->getName(),
             'type' => $this->getFieldType($fieldDefinition, $class, $container),
             'resolve' => function ($value, $args, $context = [], ResolveInfo $resolveInfo = null) use ($fieldDefinition, $attribute) {
-                $result = Service::resolveValue($value, $fieldDefinition, $attribute, $args);
+                $result = Service::resolveValue($value, $fieldDefinition, $attribute, $args, !empty($context['mockup_element_support_enabled']));
 
                 // The table has no specific definition of columns, so we cannot have a ObjectType in schema for it.
                 // Just return the data JSON encoded

src/GraphQL/DataObjectQueryFieldConfigGenerator/Helper/AssetBase.php

@@ -69,7 +69,7 @@ public function __construct(Service $graphQlService, $attribute, $fieldDefinitio
      */
     public function resolve($value = null, $args = [], $context = [], ResolveInfo $resolveInfo = null)
     {
-        $asset = Service::resolveValue($value, $this->fieldDefinition, $this->attribute, $args = []);
+        $asset = Service::resolveValue($value, $this->fieldDefinition, $this->attribute, $args = [], !empty($context['mockup_element_support_enabled']));
 
         if (!$asset) {
             return null;

src/GraphQL/DataObjectQueryFieldConfigGenerator/Helper/Base.php

@@ -67,7 +67,7 @@ public function __construct(Service $graphQlService, $attribute, $fieldDefinitio
      */
     public function resolve($value = null, $args = [], $context = [], ResolveInfo $resolveInfo = null)
     {
-        $result = Service::resolveValue($value, $this->fieldDefinition, $this->attribute, $args);
+        $result = Service::resolveValue($value, $this->fieldDefinition, $this->attribute, $args, !empty($context['mockup_element_support_enabled']));
 
         return $result;
     }

src/GraphQL/DataObjectQueryFieldConfigGenerator/Helper/Hotspotimage.php

@@ -84,7 +84,7 @@ public function resolve($value = null, $args = [], $context = [], ResolveInfo $r
             return Service::resolveCachedValue($value, $resolveInfo);
         }
         /** @var $container Hotspotimage */
-        $container = Service::resolveValue($value, $this->fieldDefinition, $this->attribute, $args);
+        $container = Service::resolveValue($value, $this->fieldDefinition, $this->attribute, $args, !empty($context['mockup_element_support_enabled']));
         if ($container instanceof \Pimcore\Model\DataObject\Data\Hotspotimage) {
             $image = $container->getImage();
             if ($image instanceof Asset) {

src/GraphQL/DataObjectQueryFieldConfigGenerator/Helper/Href.php

@@ -20,6 +20,7 @@
 use Pimcore\Bundle\DataHubBundle\GraphQL\ElementDescriptor;
 use Pimcore\Bundle\DataHubBundle\GraphQL\Service;
 use Pimcore\Bundle\DataHubBundle\GraphQL\Traits\ServiceTrait;
+use Pimcore\Bundle\DataHubBundle\Model\ElementMockupInterface;
 use Pimcore\Bundle\DataHubBundle\WorkspaceHelper;
 use Pimcore\Model\DataObject\ClassDefinition;
 use Pimcore\Model\DataObject\ClassDefinition\Data;
@@ -72,9 +73,9 @@ public function __construct(Service $graphQlService, $attribute, $fieldDefinitio
     public function resolve($value = null, $args = [], $context = [], ResolveInfo $resolveInfo = null)
     {
         if ($value instanceof BaseDescriptor) {
-            $relation = \Pimcore\Bundle\DataHubBundle\GraphQL\Service::resolveValue($value, $this->fieldDefinition, $this->attribute, $args);
+            $relation = \Pimcore\Bundle\DataHubBundle\GraphQL\Service::resolveValue($value, $this->fieldDefinition, $this->attribute, $args, !empty($context['mockup_element_support_enabled']));
 
-            if ($relation instanceof ElementInterface) {
+            if ($relation instanceof ElementInterface || $relation instanceof ElementMockupInterface) {
                 if (!WorkspaceHelper::checkPermission($relation, 'read')) {
                     return null;
                 }

src/GraphQL/DataObjectQueryFieldConfigGenerator/Helper/Image.php

@@ -20,6 +20,7 @@
 use Pimcore\Bundle\DataHubBundle\GraphQL\ElementDescriptor;
 use Pimcore\Bundle\DataHubBundle\GraphQL\Service;
 use Pimcore\Bundle\DataHubBundle\GraphQL\Traits\ServiceTrait;
+use Pimcore\Bundle\DataHubBundle\Model\ElementMockupInterface;
 use Pimcore\Bundle\DataHubBundle\WorkspaceHelper;
 use Pimcore\Model\Asset;
 use Pimcore\Model\DataObject\ClassDefinition;
@@ -72,9 +73,9 @@ public function __construct(\Pimcore\Bundle\DataHubBundle\GraphQL\Service $graph
     public function resolve($value = null, $args = [], $context = [], ResolveInfo $resolveInfo = null)
     {
         if ($value instanceof BaseDescriptor) {
-            $relation = Service::resolveValue($value, $this->fieldDefinition, $this->attribute, $args);
+            $relation = Service::resolveValue($value, $this->fieldDefinition, $this->attribute, $args, !empty($context['mockup_element_support_enabled']));
 
-            if ($relation instanceof Asset) {
+            if ($relation instanceof Asset || $relation instanceof ElementMockupInterface) {
                 if (!WorkspaceHelper::checkPermission($relation, 'read')) {
                     return null;
                 }

src/GraphQL/DataObjectQueryFieldConfigGenerator/Helper/ImageGallery.php

@@ -21,6 +21,7 @@
 use Pimcore\Bundle\DataHubBundle\GraphQL\ElementDescriptor;
 use Pimcore\Bundle\DataHubBundle\GraphQL\Service as GraphQlService;
 use Pimcore\Bundle\DataHubBundle\GraphQL\Traits\ServiceTrait;
+use Pimcore\Bundle\DataHubBundle\Model\ElementMockupInterface;
 use Pimcore\Bundle\DataHubBundle\WorkspaceHelper;
 use Pimcore\Model\Asset;
 use Pimcore\Model\DataObject\ClassDefinition;
@@ -83,7 +84,7 @@ public function __construct(
     public function resolve($value = null, $args = [], $context = [], ResolveInfo $resolveInfo = null)
     {
         $result = [];
-        $relations = GraphQlService::resolveValue($value, $this->fieldDefinition, $this->attribute, $args);
+        $relations = GraphQlService::resolveValue($value, $this->fieldDefinition, $this->attribute, $args, !empty($context['mockup_element_support_enabled']));
         if ($relations) {
             foreach ($relations as $relation) {
                 if ($relation instanceof Hotspotimage) {
@@ -92,7 +93,7 @@ public function resolve($value = null, $args = [], $context = [], ResolveInfo $r
                     continue;
                 }
 
-                if ($image instanceof Asset) {
+                if ($image instanceof Asset || $relation instanceof ElementMockupInterface) {
                     if (!WorkspaceHelper::checkPermission($image, 'read')) {
                         continue;
                     }

src/GraphQL/DataObjectQueryFieldConfigGenerator/Helper/Multihref.php

@@ -70,11 +70,11 @@ public function __construct(Service $graphQlService, $attribute, $fieldDefinitio
     public function resolve($value = null, $args = [], $context = [], ResolveInfo $resolveInfo = null)
     {
         $result = [];
-        $relations = \Pimcore\Bundle\DataHubBundle\GraphQL\Service::resolveValue($value, $this->fieldDefinition, $this->attribute, $args);
+        $relations = \Pimcore\Bundle\DataHubBundle\GraphQL\Service::resolveValue($value, $this->fieldDefinition, $this->attribute, $args, !empty($context['mockup_element_support_enabled']));
         if ($relations) {
             /** @var AbstractElement $relation */
             foreach ($relations as $relation) {
-                if (!WorkspaceHelper::checkPermission($relation, 'read')) {
+                if (!WorkspaceHelper::checkPermission($relation, 'read', $type)) {
                     continue;
                 }
 

src/GraphQL/DataObjectQueryFieldConfigGenerator/Helper/MultihrefMetadata.php

@@ -70,7 +70,7 @@ public function __construct(Service $graphQlService, $attribute, $fieldDefinitio
      */
     public function resolve($value = null, $args = [], $context = [], ResolveInfo $resolveInfo = null)
     {
-        $relations = \Pimcore\Bundle\DataHubBundle\GraphQL\Service::resolveValue($value, $this->fieldDefinition, $this->attribute, $args);
+        $relations = \Pimcore\Bundle\DataHubBundle\GraphQL\Service::resolveValue($value, $this->fieldDefinition, $this->attribute, $args, !empty($context['mockup_element_support_enabled']));
         if ($relations) {
             $result = [];
             /** @var ElementMetadata $relation */

src/GraphQL/DataObjectQueryFieldConfigGenerator/Helper/Objects.php

@@ -73,11 +73,11 @@ public function __construct(Service $graphQlService, $attribute, $fieldDefinitio
     public function resolve($value = null, $args = [], $context = [], ResolveInfo $resolveInfo = null)
     {
         if ($value instanceof BaseDescriptor) {
-            $relations = Service::resolveValue($value, $this->fieldDefinition, $this->attribute, $args);
+            $relations = Service::resolveValue($value, $this->fieldDefinition, $this->attribute, $args, !empty($context['mockup_element_support_enabled']));
             if ($relations) {
                 $result = [];
-                /** @var $relation AbstractElement */
                 foreach ($relations as $relation) {
+                    /** @var $relation AbstractElement */
                     if (!WorkspaceHelper::checkPermission($relation, 'read')) {
                         continue;
                     }

src/GraphQL/DataObjectQueryFieldConfigGenerator/Helper/ObjectsMetadata.php

@@ -70,7 +70,7 @@ public function __construct(Service $graphQlService, $attribute, $fieldDefinitio
     public function resolve($value = null, $args = [], $context = [], ResolveInfo $resolveInfo = null)
     {
         $result = [];
-        $relations = \Pimcore\Bundle\DataHubBundle\GraphQL\Service::resolveValue($value, $this->fieldDefinition, $this->attribute, $args);
+        $relations = \Pimcore\Bundle\DataHubBundle\GraphQL\Service::resolveValue($value, $this->fieldDefinition, $this->attribute, $args, !empty($context['mockup_element_support_enabled']));
         if ($relations) {
             /** @var ObjectMetadata $relation */
             foreach ($relations as $relation) {

src/GraphQL/DataObjectType/BlockEntryType.php

@@ -158,7 +158,7 @@ protected function prepareField(Data $fieldDef, bool $localized = false)
                 return $resolve($value, $args, $context, $resolveInfo);
             }
 
-            return $this->graphQlService::resolveValue($value, $this->fieldDefinition, $this->fieldDefinition->getName(), $args);
+            return $this->graphQlService::resolveValue($value, $this->fieldDefinition, $this->fieldDefinition->getName(), $args, !empty($context['mockup_element_support_enabled']));
         };
 
         return $field;

src/GraphQL/ElementDescriptor.php

@@ -15,6 +15,7 @@
 
 namespace Pimcore\Bundle\DataHubBundle\GraphQL;
 
+use Pimcore\Bundle\DataHubBundle\Model\ElementMockupInterface;
 use Pimcore\Model\Asset;
 use Pimcore\Model\DataObject\Concrete;
 use Pimcore\Model\Document;
@@ -25,15 +26,18 @@ class ElementDescriptor extends BaseDescriptor
     /**
      * @param ElementInterface|null $element
      */
-    public function __construct(ElementInterface $element = null)
+    public function __construct(ElementInterface | ElementMockupInterface $element = null)
     {
         parent::__construct();
         if ($element) {
             $this->offsetSet('id', $element->getId());
             $this->offsetSet('__elementType', \Pimcore\Model\Element\Service::getElementType($element));
             $this->offsetSet('__elementSubtype', $element instanceof Concrete ? $element->getClass()->getName() : $element->getType());
 
-            if ($element instanceof Concrete) {
+            if ($element instanceof ElementMockupInterface) {
+                $this->offsetSet('__elementType', $element->getElementType());
+                $this->offsetSet('__elementSubtype', $element->getElementType() === 'object' ? $element->getClass()->getName() : $element->getType());
+            } elseif ($element instanceof Concrete) {
                 $subtype = $element->getClass()->getName();
 
                 $this->offsetSet('__elementType', 'object');

src/GraphQL/FieldHelper/AbstractFieldHelper.php

@@ -22,12 +22,14 @@
 use GraphQL\Language\AST\NodeList;
 use GraphQL\Language\AST\SelectionSetNode;
 use GraphQL\Type\Definition\ResolveInfo;
+use Pimcore\Bundle\DataHubBundle\GraphQL\Traits\ElementLoaderTrait;
 use Pimcore\Bundle\DataHubBundle\GraphQL\Traits\ServiceTrait;
+use Pimcore\Bundle\DataHubBundle\Model\ElementMockupInterface;
 use Pimcore\Model\Element\ElementInterface;
 
 abstract class AbstractFieldHelper
 {
-    use ServiceTrait;
+    use ServiceTrait, ElementLoaderTrait;
 
     public function __construct()
     {
@@ -118,10 +120,10 @@ public function getArguments(FieldNode $ast)
      */
     public function extractData(&$data, $container, $args, $context = [], ResolveInfo $resolveInfo = null)
     {
-        if ($container instanceof ElementInterface) {
+        if ($container instanceof ElementInterface || $container instanceof ElementMockupInterface) {
             // we have to at least add the ID and pass it around even if not requested because we need it internally
             // to resolve fields of linked elements (such as asset image and so on)
-            $data['id'] = $container->getId();
+            $data = $this->setDataElement($data, $container);
         }
 
         $resolveInfoArray = (array)$resolveInfo;

src/GraphQL/FieldHelper/AssetFieldHelper.php

@@ -17,6 +17,7 @@
 
 use GraphQL\Language\AST\FieldNode;
 use GraphQL\Type\Definition\ResolveInfo;
+use Pimcore\Bundle\DataHubBundle\GraphQL\Service;
 use Pimcore\Model\Asset;
 use Pimcore\Model\Asset\Image;
 use Pimcore\Model\Asset\Video;
@@ -128,23 +129,7 @@ public function doExtractData(FieldNode $ast, &$data, $container, $args, $contex
                 }
             }
         } else {
-            if (method_exists($container, $getter)) {
-                if ($languageArgument) {
-                    if ($ast->alias) {
-                        // defer it
-                        $data[$realName] = function ($source, $args, $context, ResolveInfo $info) use (
-                            $container,
-                            $getter
-                        ) {
-                            return $container->$getter($args['language'] ?? null);
-                        };
-                    } else {
-                        $data[$realName] = $container->$getter($languageArgument);
-                    }
-                } else {
-                    $data[$realName] = $container->$getter();
-                }
-            }
+            Service::resolveContainerGetterData($container, $data, $getter, $resolveInfo, $ast, $languageArgument);
         }
     }
 }