Filter query type based on FilterDefinition objects - Work in Progess

src/FilterService/FilterType/HijackAbstractFilterType.php

@@ -0,0 +1,67 @@
+<?php
+
+namespace Pimcore\Bundle\DataHubBundle\FilterService\FilterType;
+
+use Pimcore\Bundle\EcommerceFrameworkBundle\FilterService\FilterType\AbstractFilterType;
+use Pimcore\Bundle\EcommerceFrameworkBundle\IndexService\ProductList\ProductListInterface;
+use Pimcore\Bundle\EcommerceFrameworkBundle\Model\AbstractFilterDefinitionType;
+
+/**
+ * Class HijackAbstractFilterType
+ *
+ * Allows to access protected methods of AbstractFilterType instances in order
+ * to use these data in the Filter Query Type.
+ *
+ * @package Pimcore\Bundle\DataHubBundle\FilterService\FilterType
+ */
+class HijackAbstractFilterType extends AbstractFilterType {
+
+    public function getFilterFrontend(
+        AbstractFilterDefinitionType $filterDefinition,
+        ProductListInterface $productList,
+        $currentFilter
+    ) {
+        return [];
+    }
+
+    public function addCondition(
+        AbstractFilterDefinitionType $filterDefinition,
+        ProductListInterface $productList,
+        $currentFilter,
+        $params,
+        $isPrecondition = FALSE
+    ) {
+        return [];
+    }
+
+    /**
+     * Allows to access the protected getField method of a filter.
+     *
+     * @param \Pimcore\Bundle\EcommerceFrameworkBundle\FilterService\FilterType\AbstractFilterType $filter
+     * @param \Pimcore\Bundle\EcommerceFrameworkBundle\Model\AbstractFilterDefinitionType $filterDefinition
+     * @return string
+     */
+    public static function getFieldFromFilter(AbstractFilterType $filter, AbstractFilterDefinitionType $filterDefinition) {
+        return $filter->getField($filterDefinition);
+    }
+
+    /**
+     * Returns if the filter accepts multiple values.
+     *
+     * @FIXME There's currently no sane way to determine if a Filter accepts
+     * multiple values. Needs to be changed in the Filter-API.
+     *
+     * @param \Pimcore\Bundle\EcommerceFrameworkBundle\FilterService\FilterType\AbstractFilterType $filter
+     * @param \Pimcore\Bundle\EcommerceFrameworkBundle\Model\AbstractFilterDefinitionType $filterDefinition
+     * @return bool
+     */
+    public static function isMultiValueFilter(AbstractFilterType $filter, AbstractFilterDefinitionType $filterDefinition) {
+        // Speculate that there will be an API for this.
+        if (method_exists($filter, 'acceptsMultipleValues')) {
+            return $filter->acceptsMultipleValues();
+        }
+        // For now the core filters seem to have the string "Multi" in the class
+        // name whenever multiple values are accepted.
+        return strpos(get_class($filter), 'Multi') !== FALSE;
+    }
+}

src/FilterService/HijackAbstractFilterService.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Pimcore\Bundle\DataHubBundle\FilterService;
+
+use Pimcore\Bundle\EcommerceFrameworkBundle\FilterService\FilterService;
+
+/**
+ * Class HijackAbstractFilterService
+ *
+ * Allows to access protected property of FilterService instances in order
+ * to use these data in the Filter Query Type.
+ *
+ * @package Pimcore\Bundle\DataHubBundle\FilterService
+ */
+class HijackAbstractFilterService extends FilterService
+{
+
+    /**
+     * Returns the configured filter types as array
+     *
+     *
+     * @param FilterService $instance
+     * @return array
+     */
+    public static function getFilterTypes(FilterService $instance)
+    {
+        $types = $instance->filterTypes;
+        if (!empty($types)) {
+            $filterTypes = [];
+            foreach ($types as $key => $filterType) {
+                $filterTypes[] = $key;
+            }
+            return $filterTypes;
+        }
+        return [];
+    }
+}

src/GraphQL/Query/QueryType.php

@@ -15,11 +15,16 @@
 
 namespace Pimcore\Bundle\DataHubBundle\GraphQL\Query;
 
+use GraphQL\Type\Definition\CustomScalarType;
+use GraphQL\Type\Definition\InputObjectField;
+use GraphQL\Type\Definition\InputObjectType;
 use GraphQL\Type\Definition\ObjectType;
 use GraphQL\Type\Definition\Type;
+use GraphQL\Type\Definition\UnionType;
 use Pimcore\Bundle\DataHubBundle\Configuration;
 use Pimcore\Bundle\DataHubBundle\Event\GraphQL\Model\QueryTypeEvent;
 use Pimcore\Bundle\DataHubBundle\Event\GraphQL\QueryEvents;
+use Pimcore\Bundle\DataHubBundle\FilterService\HijackAbstractFilterService;
 use Pimcore\Bundle\DataHubBundle\GraphQL\ClassTypeDefinitions;
 use Pimcore\Bundle\DataHubBundle\GraphQL\Resolver\AssetListing;
 use Pimcore\Bundle\DataHubBundle\GraphQL\Service;
@@ -92,10 +97,12 @@ public function buildFolderQueries($type, &$config = [], $context = [])
 
             if ($type == "asset") {
                 $graphQlType = $this->getGraphQlService()->getAssetTypeDefinition("_" . $type . "_folder");
-            } else if ($type == "document") {
-                $graphQlType = $this->getGraphQlService()->getDocumentTypeDefinition("_" . $type . "_folder");
             } else {
-                $graphQlType = $this->getGraphQlService()->getDataObjectTypeDefinition("_" . $type . "_folder");
+                if ($type == "document") {
+                    $graphQlType = $this->getGraphQlService()->getDocumentTypeDefinition("_" . $type . "_folder");
+                } else {
+                    $graphQlType = $this->getGraphQlService()->getDataObjectTypeDefinition("_" . $type . "_folder");
+                }
             }
 
             // GETTER DEFINITION
@@ -186,6 +193,37 @@ protected function getResolver($class = null, $configuration = null) {
         return $resolver;
     }
 
+    /**
+     * @param ClassDefinition $class
+     * @param array $context
+     *
+     * @return \GraphQL\Type\Definition\ObjectType
+     * @throws \Exception
+     */
+    protected function getEdgeTypeDefinition(ClassDefinition $class, array $context): ObjectType
+    {
+        static $instances = [];
+        $configuration = $context['configuration'];
+        $resolver = $this->getResolver($class, $configuration);
+        $ucFirstClassName = ucfirst($class->getName());
+
+        if (!isset($instances[$ucFirstClassName])) {
+            $instances[$ucFirstClassName] = new ObjectType(
+                [
+                    'name' => $ucFirstClassName . 'Edge',
+                    'fields' => [
+                        'cursor' => Type::string(),
+                        'node' => [
+                            'type' => ClassTypeDefinitions::get($class),
+                            'resolve' => [$resolver, "resolveEdge"]
+                        ],
+                    ],
+                ]
+            );
+        }
+        return $instances[$ucFirstClassName];
+    }
+
     /**
      * @param array $config
      * @param array $context
@@ -219,18 +257,7 @@ public function buildDataObjectQueries(&$config = [], $context = []): void
             ];
 
             // LISTING DEFINITION
-            $edgeType = new ObjectType(
-                [
-                    'name' => $ucFirstClassName . 'Edge',
-                    'fields' => [
-                        'cursor' => Type::string(),
-                        'node' => [
-                            'type' => ClassTypeDefinitions::get($class),
-                            'resolve' => [$resolver, "resolveEdge"]
-                        ],
-                    ],
-                ]
-            );
+            $edgeType = $this->getEdgeTypeDefinition($class, $context);
 
             $listingType = new ObjectType(
                 [
@@ -278,6 +305,175 @@ public function buildDataObjectQueries(&$config = [], $context = []): void
         }
     }
 
+    /**
+     * @param array &$config
+     * @param array $context
+     * @throws \Exception
+     */
+    public function buildFilterQueries(&$config = [], $context = []): void
+    {
+        /** @var $configuration Configuration */
+        $configuration = $context['configuration'];
+        $entities = $configuration->getQueryEntities();
+        //Get Filter Service Instance to Hijack configured filter services
+        $factory = \Pimcore\Bundle\EcommerceFrameworkBundle\Factory::getInstance();
+        $filterService = $factory->getFilterService();
+        $filterTypes = HijackAbstractFilterService::getFilterTypes($filterService);
+
+        foreach ($entities as $entity) {
+            $class = ClassDefinition::getByName($entity);
+            if (!$class) {
+                Logger::error("class " . $entity . " not found");
+                continue;
+            }
+            if (!is_subclass_of('\\Pimcore\Model\\DataObject\\' . $class->getName(),
+                \Pimcore\Bundle\EcommerceFrameworkBundle\Model\IndexableInterface::class)) {
+                Logger::info("class " . $entity . " is not filterable.");
+                continue;
+            }
+
+            $resolver = $this->getResolver($class, $configuration);
+            $ucFirstClassName = ucfirst($class->getName());
+
+            $edgeType = $this->getEdgeTypeDefinition($class, $context);
+
+            //Create ObjectTypes for each configured filter Type in "ecommerce-config.yml"
+            $filterFields = [];
+            foreach ($filterTypes as $filterType) {
+
+                $entry = new ObjectType([
+                    'name' => $ucFirstClassName . $filterType,
+                    'fields' => [
+                        'filterType' => ['type' => Type::string()],
+                        'field' => ['type' => Type::string()],
+                        'label' => ['type' => Type::string()],
+                        'options' => [
+                            'type' => Type::listOf(new ObjectType([
+                                'name' => $ucFirstClassName . $filterType . 'Option',
+                                'fields' => [
+                                    'value' => ['type' => Type::string()],
+                                    'label' => ['type' => Type::string()],
+                                    'count' => ['type' => Type::int()],
+                                ],
+                            ]),),
+                        ],
+                    ]
+                ]);
+                $filterFields[$filterType] = $entry;
+            }
+
+            $unionType = new UnionType([
+                'name' => $ucFirstClassName . 'FilterFacet',
+                'types' => $filterFields,
+                'resolveType' => function ($value) use ($resolver, $filterFields) {
+                    $type = $value['filter']->getType();
+                    if (isset($filterFields[$type])) {
+                        $filterFields[$type]->resolveFieldFn = [$resolver, "resolveFacet"];
+                        return $filterFields[$type];
+                    }
+                    throw new \Exception("No Filter Type found, only types allowed which are defined in ecommerce-config.yml");
+                }
+            ]);
+
+            $filterType = new ObjectType(
+                [
+                    'name' => $ucFirstClassName . 'Filter',
+                    'fields' => [
+                        'edges' => [
+                            'type' => Type::listOf($edgeType),
+                            'resolve' => [$resolver, "resolveEdges"]
+                        ],
+                        'facets' => [
+                            'type' => UnionType::listOf($unionType),
+                            'resolve' => [$resolver, "resolveFacets"]
+                        ],
+                        'totalCount' => [
+                            'description' => 'The total count of all queryable objects for this schema listing',
+                            'resolve' => [$resolver, "resolveFilterTotalCount"],
+                            'type' => Type::int()
+                        ]
+                    ]
+                ]
+            );
+
+            $defFilter = [
+                'name' => 'get' . $ucFirstClassName . 'Filter',
+                'args' => [
+                    'tenant' => ['type' => Type::string()],
+                    'variantMode' => [
+                        'type' => Type::string(),
+                        'description' => 'Define how item variants in the results are handled.. Valid values: ' .
+                            \Pimcore\Bundle\EcommerceFrameworkBundle\IndexService\ProductList\ProductListInterface::VARIANT_MODE_HIDE . ',' .
+                            \Pimcore\Bundle\EcommerceFrameworkBundle\IndexService\ProductList\ProductListInterface::VARIANT_MODE_INCLUDE . ',' .
+                            \Pimcore\Bundle\EcommerceFrameworkBundle\IndexService\ProductList\ProductListInterface::VARIANT_MODE_INCLUDE_PARENT_OBJECT . ',' .
+                            \Pimcore\Bundle\EcommerceFrameworkBundle\IndexService\ProductList\ProductListInterface::VARIANT_MODE_VARIANTS_ONLY,
+                    ],
+                    'defaultLanguage' => ['type' => Type::string()],
+                    'fulltext' => [
+                        'type' => Type::string(),
+                        'description' => 'The keys to use for the fulltext search.'
+                    ],
+                    'first' => ['type' => Type::int()],
+                    'after' => ['type' => Type::int()],
+                    'sortBy' => ['type' => Type::listOf(Type::string())],
+                    'sortOrder' => [
+                        'type' => Type::listOf(Type::string()),
+                        'description' => "Sort by ASC or DESC, use the same position as the sortBy argument for each column to sort by",
+                    ],
+                    'filter' => ['type' => Type::string()],
+                    'filterDefinition' => [
+                        'type' => new InputObjectType([
+                            'name' => $ucFirstClassName . 'FilterDefinitionArg',
+                            'fields' => [
+                                'id' => ['type' => Type::int()],
+                                'relationField' => ['type' => Type::string()],
+                                'fallbackFilterDefinitionId' => ['type' => Type::int()],
+                            ],
+                        ]),
+                        'description' => "Define the id of a filterDefinition to use to configure the filter.",
+                    ],
+                    'published' => ['type' => Type::boolean()],
+                    'category' => [
+                        'type' => Type::id(),
+                        'description' => "ID of the category to filter by.",
+                    ],
+                    'priceFrom' => ['type' => Type::float()],
+                    'priceTo' => ['type' => Type::float()],
+                    'facets' => [
+                        'type' => Type::listOf(new InputObjectType([
+                            'name' => $ucFirstClassName . 'FilterFacetArg',
+                            'fields' => [
+                                'field' => ['type' => Type::string()],
+                                'values' => ['type' => CustomScalarType::listOf(new CustomScalarType([
+                                        'name' => 'Object', //used for GraphIQL Editor to recognize a Type
+                                        'description' => 'The Input can be any kind of array.
+                                    For Select Filters a String Array is required e.g.
+                                    "values": [
+                                        "11",
+                                        "12"
+                                    ]
+                                    For Range Filters an Object Array is required e.g.
+                                    "values": [
+                                        {"from": "10"},
+                                        {"to": "100"}
+                                    ]'
+                                    ])
+                                )],
+                            ],
+                        ])),
+                    ],
+                ],
+                'type' => $filterType,
+                'resolve' => [$resolver, "resolveFilter"],
+            ];
+
+            if (!$config['fields']) {
+                $config['fields'] = [];
+            }
+            $config['fields']['get' . $ucFirstClassName . 'Filter'] = $defFilter;
+        }
+    }
+
     /**
      * @param array $config
      * @param array $context
@@ -368,6 +564,9 @@ public function build(&$config = [], $context = [])
         $this->buildAssetQueries($config, $context);
         $this->buildDocumentQueries($config, $context);
         $this->buildDataObjectQueries($config, $context);
+        if (interface_exists('\Pimcore\Bundle\EcommerceFrameworkBundle\Model\IndexableInterface')) {
+            $this->buildFilterQueries($config, $context);
+        }
         $this->buildAssetListingQueries($config, $context);
         $this->buildFolderQueries("asset", $config, $context);
         $this->buildFolderQueries("document", $config, $context);