Init serialize processor

Sylius · Nov 28, 2023 · 3c6dd65 · 3c6dd65
1 parent ae385e3
commit 3c6dd65
Show file tree

Hide file tree

Showing 4 changed files with 432 additions and 207 deletions.
diff --git a/src/Component/Tests/Symfony/EventListener/SerializeListenerTest.php b/src/Component/Tests/Symfony/EventListener/SerializeListenerTest.php
@@ -0,0 +1,214 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * 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\Component\Resource\Tests\Symfony\EventListener;
+
+use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Prophecy\Prophecy\ObjectProphecy;
+use Sylius\Resource\Metadata\HttpOperation;
+use Sylius\Resource\Metadata\Operation\HttpOperationInitiatorInterface;
+use Sylius\Resource\Symfony\EventListener\SerializeListener;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Event\ViewEvent;
+use Symfony\Component\HttpKernel\HttpKernelInterface;
+use Symfony\Component\Serializer\SerializerInterface;
+use Webmozart\Assert\Assert;
+
+final class SerializeListenerTest extends TestCase
+{
+    use ProphecyTrait;
+
+    private HttpOperationInitiatorInterface|ObjectProphecy $operationInitiator;
+
+    private SerializerInterface|ObjectProphecy $serializer;
+
+    private SerializeListener $serializeListener;
+
+    protected function setUp(): void
+    {
+        $this->operationInitiator = $this->prophesize(HttpOperationInitiatorInterface::class);
+        $this->serializer = $this->prophesize(SerializerInterface::class);
+
+        $this->serializeListener = new SerializeListener(
+            $this->operationInitiator->reveal(),
+            $this->serializer->reveal(),
+        );
+    }
+
+    /** @test */
+    public function it_serializes_data_to_the_requested_format(): void
+    {
+        $kernel = $this->prophesize(HttpKernelInterface::class);
+        $request = $this->prophesize(Request::class);
+        $operation = $this->prophesize(HttpOperation::class);
+        $data = $this->prophesize(\stdClass::class);
+
+        $event = new ViewEvent(
+            $kernel->reveal(),
+            $request->reveal(),
+            HttpKernelInterface::MAIN_REQUEST,
+            $data->reveal(),
+        );
+
+        $this->operationInitiator->initializeOperation($request)->willReturn($operation);
+
+        $request->getRequestFormat()->willReturn('json');
+
+        $operation->canSerialize()->willReturn(null)->shouldBeCalled();
+        $operation->getNormalizationContext()->willReturn([]);
+
+        $this->serializer->serialize($data, 'json', [])->willReturn('serialized_data')->shouldBeCalled();
+
+        $this->serializeListener->onKernelView($event);
+
+        Assert::eq($event->getControllerResult(), 'serialized_data');
+    }
+
+    /** @test */
+    public function it_serializes_data_to_the_requested_format_with_normalization_context(): void
+    {
+        $kernel = $this->prophesize(HttpKernelInterface::class);
+        $request = $this->prophesize(Request::class);
+        $operation = $this->prophesize(HttpOperation::class);
+        $data = $this->prophesize(\stdClass::class);
+
+        $event = new ViewEvent(
+            $kernel->reveal(),
+            $request->reveal(),
+            HttpKernelInterface::MAIN_REQUEST,
+            $data->reveal(),
+        );
+
+        $this->operationInitiator->initializeOperation($request)->willReturn($operation);
+
+        $request->getRequestFormat()->willReturn('json');
+
+        $operation->canSerialize()->willReturn(null)->shouldBeCalled();
+        $operation->getNormalizationContext()->willReturn(['groups' => ['dummy:read']]);
+
+        $this->serializer->serialize($data, 'json', ['groups' => ['dummy:read']])->willReturn('serialized_data')->shouldBeCalled();
+
+        $this->serializeListener->onKernelView($event);
+
+        Assert::eq($event->getControllerResult(), 'serialized_data');
+    }
+
+    /** @test */
+    public function it_does_nothing_when_operation_is_null(): void
+    {
+        $kernel = $this->prophesize(HttpKernelInterface::class);
+        $request = $this->prophesize(Request::class);
+        $data = $this->prophesize(\stdClass::class);
+
+        $event = new ViewEvent(
+            $kernel->reveal(),
+            $request->reveal(),
+            HttpKernelInterface::MAIN_REQUEST,
+            $data->reveal(),
+        );
+
+        $this->operationInitiator->initializeOperation($request)->willReturn(null);
+
+        $request->getRequestFormat()->willReturn('json');
+
+        $this->serializer->serialize($data, 'json')->willReturn('serialized_data')->shouldNotBeCalled();
+
+        $this->serializeListener->onKernelView($event);
+
+        Assert::eq($event->getControllerResult(), $data->reveal());
+    }
+
+    /** @test */
+    public function it_does_nothing_when_format_is_html(): void
+    {
+        $kernel = $this->prophesize(HttpKernelInterface::class);
+        $request = $this->prophesize(Request::class);
+        $operation = $this->prophesize(HttpOperation::class);
+        $data = $this->prophesize(\stdClass::class);
+
+        $event = new ViewEvent(
+            $kernel->reveal(),
+            $request->reveal(),
+            HttpKernelInterface::MAIN_REQUEST,
+            $data->reveal(),
+        );
+
+        $this->operationInitiator->initializeOperation($request)->willReturn($operation);
+
+        $request->getRequestFormat()->willReturn('html');
+
+        $this->serializer->serialize($data, 'json', [])->willReturn('serialized_data')->shouldNotBeCalled();
+
+        $this->serializeListener->onKernelView($event);
+
+        Assert::eq($event->getControllerResult(), $data->reveal());
+    }
+
+    /** @test */
+    public function it_throws_an_exception_when_serializer_is_not_available(): void
+    {
+        $kernel = $this->prophesize(HttpKernelInterface::class);
+        $request = $this->prophesize(Request::class);
+        $operation = $this->prophesize(HttpOperation::class);
+        $data = $this->prophesize(\stdClass::class);
+
+        $serializeListener = new SerializeListener($this->operationInitiator->reveal(), null);
+
+        $event = new ViewEvent(
+            $kernel->reveal(),
+            $request->reveal(),
+            HttpKernelInterface::MAIN_REQUEST,
+            $data->reveal(),
+        );
+
+        $this->operationInitiator->initializeOperation($request)->willReturn($operation);
+
+        $request->getRequestFormat()->willReturn('json', []);
+
+        $this->serializer->serialize($data, 'json')->willReturn('serialized_data')->shouldNotBeCalled();
+
+        $this->expectException(\LogicException::class);
+        $this->expectExceptionMessage('You can not use the "json" format if the Serializer is not available. Try running "composer require symfony/serializer".');
+
+        $serializeListener->onKernelView($event);
+    }
+
+    /** @test */
+    public function it_does_nothing_if_operation_cannot_be_serialized(): void
+    {
+        $kernel = $this->prophesize(HttpKernelInterface::class);
+        $request = $this->prophesize(Request::class);
+        $operation = $this->prophesize(HttpOperation::class);
+        $data = $this->prophesize(\stdClass::class);
+
+        $event = new ViewEvent(
+            $kernel->reveal(),
+            $request->reveal(),
+            HttpKernelInterface::MAIN_REQUEST,
+            $data->reveal(),
+        );
+
+        $this->operationInitiator->initializeOperation($request)->willReturn($operation);
+
+        $request->getRequestFormat()->willReturn('json');
+
+        $operation->canSerialize()->willReturn(false)->shouldBeCalled();
+
+        $this->serializer->serialize($data, 'json', [])->willReturn('serialized_data')->shouldNotBeCalled();
+
+        $this->serializeListener->onKernelView($event);
+
+        Assert::eq($event->getControllerResult(), $data->reveal());
+    }
+}
diff --git a/src/Component/Tests/Symfony/Serializer/State/SerializeProcessorTest.php b/src/Component/Tests/Symfony/Serializer/State/SerializeProcessorTest.php
@@ -0,0 +1,159 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * 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\Component\Resource\Tests\Symfony\Serializer\State;
+
+use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Prophecy\Prophecy\ObjectProphecy;
+use Sylius\Component\Resource\src\Symfony\Serializer\State\SerializeProcessor;
+use Sylius\Resource\Context\Context;
+use Sylius\Resource\Context\Option\RequestOption;
+use Sylius\Resource\Metadata\HttpOperation;
+use Sylius\Resource\State\ProcessorInterface;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\Serializer\SerializerInterface;
+use Webmozart\Assert\Assert;
+
+final class SerializeProcessorTest extends TestCase
+{
+    use ProphecyTrait;
+
+    private ProcessorInterface|ObjectProphecy $decorated;
+
+    private SerializerInterface|ObjectProphecy $serializer;
+
+    private SerializeProcessor $serializeProcessor;
+
+    protected function setUp(): void
+    {
+        $this->decorated = $this->prophesize(ProcessorInterface::class);
+        $this->serializer = $this->prophesize(SerializerInterface::class);
+
+        $this->serializeProcessor = new SerializeProcessor(
+            $this->decorated->reveal(),
+            $this->serializer->reveal(),
+        );
+    }
+
+    /** @test */
+    public function it_serializes_data_to_the_requested_format(): void
+    {
+        $request = $this->prophesize(Request::class);
+        $operation = $this->prophesize(HttpOperation::class);
+        $data = $this->prophesize(\stdClass::class);
+
+        $context = new Context(new RequestOption($request->reveal()));
+
+        $this->decorated->process($data, $operation, $context)->willReturn($data);
+
+        $request->getRequestFormat()->willReturn('json');
+
+        $operation->canSerialize()->willReturn(null)->shouldBeCalled();
+        $operation->getNormalizationContext()->willReturn([]);
+
+        $this->serializer->serialize($data, 'json', [])->willReturn('serialized_data')->shouldBeCalled();
+
+        $result = $this->serializeProcessor->process($data, $operation->reveal(), $context);
+
+        Assert::eq($result, 'serialized_data');
+    }
+
+    /** @test */
+    public function it_serializes_data_to_the_requested_format_with_normalization_context(): void
+    {
+        $request = $this->prophesize(Request::class);
+        $operation = $this->prophesize(HttpOperation::class);
+        $data = $this->prophesize(\stdClass::class);
+
+        $context = new Context(new RequestOption($request->reveal()));
+
+        $this->decorated->process($data, $operation, $context)->willReturn($data);
+
+        $request->getRequestFormat()->willReturn('json');
+
+        $operation->canSerialize()->willReturn(null)->shouldBeCalled();
+        $operation->getNormalizationContext()->willReturn(['groups' => ['dummy:read']]);
+
+        $this->serializer->serialize($data, 'json', ['groups' => ['dummy:read']])->willReturn('serialized_data')->shouldBeCalled();
+
+        $result = $this->serializeProcessor->process($data, $operation->reveal(), $context);
+
+        Assert::eq($result, 'serialized_data');
+    }
+
+    /** @test */
+    public function it_does_nothing_when_format_is_html(): void
+    {
+        $request = $this->prophesize(Request::class);
+        $operation = $this->prophesize(HttpOperation::class);
+        $data = $this->prophesize(\stdClass::class);
+
+        $context = new Context(new RequestOption($request->reveal()));
+
+        $this->decorated->process($data, $operation, $context)->willReturn($data);
+
+        $request->getRequestFormat()->willReturn('html');
+
+        $this->serializer->serialize($data, 'json', [])->willReturn('serialized_data')->shouldNotBeCalled();
+
+        $result = $this->serializeProcessor->process($data, $operation->reveal(), $context);
+
+        Assert::eq($result, $data->reveal());
+    }
+
+    /** @test */
+    public function it_throws_an_exception_when_serializer_is_not_available(): void
+    {
+        $request = $this->prophesize(Request::class);
+        $operation = $this->prophesize(HttpOperation::class);
+        $data = $this->prophesize(\stdClass::class);
+
+        $serializeProcessor = new SerializeProcessor($this->decorated->reveal(), null);
+
+        $context = new Context(new RequestOption($request->reveal()));
+
+        $this->decorated->process($data, $operation, $context)->willReturn($data);
+
+        $request->getRequestFormat()->willReturn('json', []);
+
+        $this->serializer->serialize($data, 'json')->willReturn('serialized_data')->shouldNotBeCalled();
+
+        $this->expectException(\LogicException::class);
+        $this->expectExceptionMessage('You can not use the "json" format if the Serializer is not available. Try running "composer require symfony/serializer".');
+
+        $serializeProcessor->process($data, $operation->reveal(), $context);
+    }
+
+    /** @test */
+    public function it_does_nothing_if_operation_cannot_be_serialized(): void
+    {
+        $request = $this->prophesize(Request::class);
+        $operation = $this->prophesize(HttpOperation::class);
+        $data = $this->prophesize(\stdClass::class);
+
+        $context = new Context(new RequestOption($request->reveal()));
+
+        $this->decorated->process($data, $operation, $context)->willReturn($data);
+
+        $request->getRequestFormat()->willReturn('json');
+
+        $operation->canSerialize()->willReturn(false)->shouldBeCalled();
+
+        $this->serializer->serialize($data, 'json', [])->willReturn('serialized_data')->shouldNotBeCalled();
+
+        $result = $this->serializeProcessor->process($data, $operation->reveal(), $context);
+
+        Assert::eq($result, $data->reveal());
+    }
+}