OXDEV-8670 Use FileSystem adapter for cache

Author: tkcreateit

CHANGELOG-v11.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [11.0.0] - unreleased
 
+### Added
+- FilesystemAdapter as schema caching solution
+- CacheClearCommand allowing to manually clear schema cache
+
 ### Changed
 - Update module to work with OXID eShop 7.3
 - Replaced `TokenFilterList::fromUserInput` and `TokenSorting::fromUserInput` with direct object instantiation

services.yaml

@@ -118,7 +118,10 @@ services:
     tags: [ 'kernel.event_subscriber' ]
 
   oxidesales.graphqlbase.cacheadapter:
-    class: Symfony\Component\Cache\Adapter\NullAdapter
+    class: Symfony\Component\Cache\Adapter\FilesystemAdapter
+    arguments:
+      $namespace: 'oe_graphql_base-schema'
+      $directory: '@=service("OxidEsales\\EshopCommunity\\Internal\\Transition\\Utility\\ContextInterface").getCacheDirectory()'
 
   oxidesales.graphqlbase.cache:
     class: Symfony\Component\Cache\Psr16Cache
@@ -128,3 +131,10 @@ services:
   OxidEsales\GraphQL\Base\Service\PermissionProvider:
     class: OxidEsales\GraphQL\Base\Service\PermissionProvider
     tags: [ 'graphql_permission_provider' ]
+
+  OxidEsales\GraphQL\Base\Command\CacheClearCommand:
+    class: OxidEsales\GraphQL\Base\Command\CacheClearCommand
+    arguments:
+      $cache: '@oxidesales.graphqlbase.cache'
+    tags:
+      - { name: 'console.command', command: 'oe:graphql:cache-clear' }

src/Command/CacheClearCommand.php

@@ -0,0 +1,42 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\GraphQL\Base\Command;
+
+use Psr\SimpleCache\CacheInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class CacheClearCommand extends Command
+{
+    public function __construct(private readonly CacheInterface $cache)
+    {
+        parent::__construct();
+    }
+
+    protected function configure()
+    {
+        $this
+            ->setName('oe:graphql:cache-clear')
+            ->setDescription('Clear schema cache');
+    }
+
+    /**
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $output->writeln('<info>Clearing schema cache...</info>');
+        $this->cache->clear();
+        $output->writeln('<info>Schema cache cleared.</info>');
+
+        return Command::SUCCESS;
+    }
+}

src/Event/Subscriber/ModuleChangeSubscriber.php

@@ -18,6 +18,7 @@
 
 class ModuleChangeSubscriber implements EventSubscriberInterface
 {
+    /** @phpstan-ignore property.onlyWritten */
     public function __construct(private readonly CacheInterface $cache)
     {
     }
@@ -29,9 +30,6 @@ public function __construct(private readonly CacheInterface $cache)
      */
     public function handle(Event $event): Event
     {
-        //clear entire cache
-        $this->cache->clear();
-
         return $event;
     }
 

src/Framework/Psr4AggregatedFinder.php src/Framework/AggregatedFinder.phpsrc/Framework/Psr4AggregatedFinder.php renamed to src/Framework/AggregatedFinder.php

@@ -10,15 +10,12 @@
 namespace OxidEsales\GraphQL\Base\Framework;
 
 use AppendIterator;
+use IteratorIterator;
 use Kcs\ClassFinder\Finder\FinderInterface;
-use Kcs\ClassFinder\Finder\Psr4Finder;
 use Kcs\ClassFinder\Finder\ReflectionFilterTrait;
 use Traversable;
 
-/**
- * @internal This class is not covered by the backward compatibility promise
- */
-class Psr4AggregatedFinder implements FinderInterface
+class AggregatedFinder implements FinderInterface
 {
     use ReflectionFilterTrait;
 
@@ -29,9 +26,9 @@ public function __construct()
         $this->iterator = new AppendIterator();
     }
 
-    public function addFinder(Psr4Finder $finder): void
+    public function addFinder(FinderInterface $finder): void
     {
-        $this->iterator->append($finder->getIterator());
+        $this->iterator->append(new IteratorIterator($finder->getIterator()));
     }
 
     public function getIterator(): Traversable

src/Framework/SchemaFactory.php

@@ -60,7 +60,7 @@ public function getSchema(): Schema
             $this->container
         );
 
-        $finder = new Psr4AggregatedFinder();
+        $finder = new AggregatedFinder();
 
         foreach ($this->namespaceMappers as $namespaceMapper) {
             foreach ($namespaceMapper->getControllerNamespaceMapping() as $namespace => $path) {
@@ -81,6 +81,8 @@ public function getSchema(): Schema
         $factory->setAuthenticationService($this->authentication)
             ->setAuthorizationService($this->authorization);
 
+        $factory->prodMode();
+
         $this->schema = $factory->createSchema();
         $queryTimer->stop();
 

tests/Unit/Framework/AggregatedFinderTest.php

@@ -0,0 +1,37 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\GraphQL\Base\Tests\Unit\Framework;
+
+use ArrayIterator;
+use Kcs\ClassFinder\Finder\FinderInterface;
+use OxidEsales\GraphQL\Base\Framework\AggregatedFinder;
+use OxidEsales\GraphQL\Base\Tests\Unit\BaseTestCase;
+
+class AggregatedFinderTest extends BaseTestCase
+{
+    public function testGetIterator(): void
+    {
+        $elements = [
+            [uniqid() => uniqid(), uniqid() => uniqid()],
+            [uniqid() => uniqid(), uniqid() => uniqid()],
+        ];
+
+        $finder = new AggregatedFinder();
+        $finder->addFinder($this->createConfiguredMock(FinderInterface::class, [
+            'getIterator' => new ArrayIterator($elements[0]),
+        ]));
+        $finder->addFinder($this->createConfiguredMock(FinderInterface::class, [
+            'getIterator' => new ArrayIterator($elements[1]),
+        ]));
+
+        $array = iterator_to_array($finder->getIterator());
+        $this->assertEquals($elements[0] + $elements[1], $array);
+    }
+}