Add ResourceToIdentifierCacheableTransformer form data transformer

src/Bundle/Form/DataTransformer/ResourceToIdentifierCacheableTransformer.php

@@ -0,0 +1,86 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Paweł Jędrzejewski
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Bundle\ResourceBundle\Form\DataTransformer;
+
+use Sylius\Component\Resource\Model\ResourceInterface;
+use Sylius\Component\Resource\Repository\RepositoryInterface;
+use Symfony\Component\Form\DataTransformerInterface;
+use Symfony\Component\Form\Exception\TransformationFailedException;
+use Symfony\Component\PropertyAccess\PropertyAccess;
+use Webmozart\Assert\Assert;
+
+final class ResourceToIdentifierCacheableTransformer implements DataTransformerInterface
+{
+    private RepositoryInterface $repository;
+
+    private string $identifier;
+
+    /** @var array<ResourceInterface> */
+    private static array $cache;
+
+    public function __construct(RepositoryInterface $repository, ?string $identifier = null)
+    {
+        $this->repository = $repository;
+        $this->identifier = $identifier ?? 'id';
+    }
+
+    /**
+     * @psalm-suppress MissingParamType
+     *
+     * @param mixed $value
+     */
+    public function transform($value)
+    {
+        if (null === $value) {
+            return null;
+        }
+
+        /** @psalm-suppress ArgumentTypeCoercion */
+        Assert::isInstanceOf($value, $this->repository->getClassName());
+
+        return PropertyAccess::createPropertyAccessor()->getValue($value, $this->identifier);
+    }
+
+    /** @param mixed $value */
+    public function reverseTransform($value): ?ResourceInterface
+    {
+        if (null === $value) {
+            return null;
+        }
+
+        if (isset(self::$cache[$value])) {
+            return self::$cache[$value];
+        }
+
+        /** @var ResourceInterface|null $resource */
+        $resource = $this->repository->findOneBy([$this->identifier => $value]);
+        if (null === $resource) {
+            throw new TransformationFailedException(sprintf(
+                'Object "%s" with identifier "%s"="%s" does not exist.',
+                $this->repository->getClassName(),
+                $this->identifier,
+                $value,
+            ));
+        }
+
+        self::$cache[$value] = $resource;
+
+        return $resource;
+    }
+
+    public function clear(): void
+    {
+        self::$cache = [];
+    }
+}

src/Bundle/Storage/CookieStorage.php

@@ -44,10 +44,13 @@ public static function getSubscribedEvents(): array
 
     public function onKernelRequest(RequestEvent $event): void
     {
+        $isMainRequest = false;
+
         /** @phpstan-ignore-next-line */
         if (\method_exists($event, 'isMainRequest')) {
             $isMainRequest = $event->isMainRequest();
-        } else {
+        /** @phpstan-ignore-next-line */
+        } elseif (\method_exists($event, 'isMasterRequest')) {
             $isMainRequest = $event->isMasterRequest();
         }
         if (!$isMainRequest) {
@@ -60,10 +63,13 @@ public function onKernelRequest(RequestEvent $event): void
 
     public function onKernelResponse(ResponseEvent $event): void
     {
+        $isMainRequest = false;
+
         /** @phpstan-ignore-next-line */
         if (\method_exists($event, 'isMainRequest')) {
             $isMainRequest = $event->isMainRequest();
-        } else {
+        /** @phpstan-ignore-next-line */
+        } elseif (\method_exists($event, 'isMasterRequest')) {
             $isMainRequest = $event->isMasterRequest();
         }
         if (!$isMainRequest) {

src/Bundle/spec/Form/DataTransformer/ResourceToIdentifierCacheableTransformerSpec.php

@@ -0,0 +1,81 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Paweł Jędrzejewski
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace spec\Sylius\Bundle\ResourceBundle\Form\DataTransformer;
+
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use Sylius\Component\Resource\Model\ResourceInterface;
+use Sylius\Component\Resource\Repository\RepositoryInterface;
+use Symfony\Component\Form\Exception\TransformationFailedException;
+
+final class ResourceToIdentifierCacheableTransformerSpec extends ObjectBehavior
+{
+    function let(RepositoryInterface $repository): void
+    {
+        $this->beConstructedWith($repository, 'id');
+    }
+
+    function it_does_not_reverses_null_value(RepositoryInterface $repository): void
+    {
+        $repository->findOneBy(Argument::any())->shouldNotBeCalled();
+
+        $this->reverseTransform(null)->shouldReturn(null);
+    }
+
+    function it_throws_an_exception_on_non_existing_resource(RepositoryInterface $repository): void
+    {
+        $repository->getClassName()->willReturn(ResourceInterface::class);
+        $repository->findOneBy(['id' => 6])->willReturn(null);
+
+        $this->shouldThrow(TransformationFailedException::class)->during('reverseTransform', [6]);
+    }
+
+    function it_reverse_transform_identifier_to_resource(RepositoryInterface $repository, ResourceInterface $resource): void
+    {
+        $repository->findOneBy(['id' => 5])->willReturn($resource);
+
+        $this->reverseTransform(5)->shouldReturn($resource);
+    }
+
+    function it_reverse_transforms_identifier_to_resource_using_cache(
+        RepositoryInterface $repository,
+        ResourceInterface $resource,
+    ): void {
+        $this->clear();
+
+        $repository->findOneBy(['id' => 5])
+            ->willReturn($resource)
+            ->shouldBeCalledOnce()
+        ;
+
+        $this->reverseTransform(5)->shouldReturn($resource);
+        $this->reverseTransform(5)->shouldReturn($resource);
+    }
+
+    function it_transforms_null_value_to_empty_string(RepositoryInterface $repository): void
+    {
+        $repository->getClassName()->willReturn(ResourceInterface::class);
+
+        $this->transform(null)->shouldReturn(null);
+    }
+
+    function it_transforms_resource_in_identifier(RepositoryInterface $repository, ResourceInterface $resource): void
+    {
+        $repository->getClassName()->willReturn(ResourceInterface::class);
+
+        $resource->getId()->willReturn(6);
+
+        $this->transform($resource)->shouldReturn(6);
+    }
+}