Init flash processor

src/Component/Tests/State/Processor/FlashProcessorTest.php

@@ -0,0 +1,138 @@
+<?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\State\Processor;
+
+use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Prophecy\Prophecy\ObjectProphecy;
+use Sylius\Resource\State\Processor\FlashProcessor;
+use Sylius\Resource\Symfony\Session\Flash\FlashHelperInterface;
+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\ParameterBag;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+final class FlashProcessorTest extends TestCase
+{
+    use ProphecyTrait;
+
+    private ProcessorInterface|ObjectProphecy $decorated;
+
+    private FlashHelperInterface|ObjectProphecy $flashHelper;
+
+    private FlashProcessor $flashProcessor;
+
+    protected function setUp(): void
+    {
+        $this->decorated = $this->prophesize(ProcessorInterface::class);
+        $this->flashHelper = $this->prophesize(FlashHelperInterface::class);
+
+        $this->flashProcessor = new FlashProcessor(
+            $this->decorated->reveal(),
+            $this->flashHelper->reveal(),
+        );
+    }
+
+    /** @test */
+    public function it_adds_flash(): void
+    {
+        $request = $this->prophesize(Request::class);
+        $attributes = $this->prophesize(ParameterBag::class);
+        $operation = $this->prophesize(HttpOperation::class);
+
+        $request->isMethodSafe()->willReturn(false);
+
+        $request->attributes = $attributes;
+
+        $attributes->getBoolean('is_valid', true)->willReturn(true);
+
+        $context = new Context(new RequestOption($request->reveal()));
+
+        $this->decorated->process(['foo' => 'fighters'], $operation, $context)->willReturn(['foo' => 'fighters'])->shouldBeCalled();
+
+        $this->flashHelper->addSuccessFlash($operation, $context)->shouldBeCalled();
+
+        $this->flashProcessor->process(['foo' => 'fighters'], $operation->reveal(), $context);
+    }
+
+    /** @test */
+    public function it_does_nothing_when_controller_result_is_a_response(): void
+    {
+        $request = $this->prophesize(Request::class);
+        $attributes = $this->prophesize(ParameterBag::class);
+        $operation = $this->prophesize(HttpOperation::class);
+        $response = $this->prophesize(Response::class);
+
+        $request->isMethodSafe()->willReturn(false)->shouldNotBeCalled();
+
+        $request->attributes = $attributes;
+
+        $attributes->getBoolean('is_valid', true)->willReturn(true)->shouldNotBeCalled();
+
+        $context = new Context(new RequestOption($request->reveal()));
+
+        $this->decorated->process($response, $operation, $context)->willReturn($response)->shouldBeCalled();
+
+        $this->flashHelper->addSuccessFlash($operation, $context)->shouldNotBeCalled();
+
+        $this->flashProcessor->process($response->reveal(), $operation->reveal(), $context);
+    }
+
+    /** @test */
+    public function it_does_nothing_when_method_is_safe(): void
+    {
+        $request = $this->prophesize(Request::class);
+        $attributes = $this->prophesize(ParameterBag::class);
+        $operation = $this->prophesize(HttpOperation::class);
+
+        $request->isMethodSafe()->willReturn(true)->shouldBeCalled();
+
+        $request->attributes = $attributes;
+
+        $attributes->getBoolean('is_valid', true)->willReturn(true);
+
+        $context = new Context(new RequestOption($request->reveal()));
+
+        $this->decorated->process(['foo' => 'fighters'], $operation, $context)->willReturn(['foo' => 'fighters'])->shouldBeCalled();
+
+        $this->flashHelper->addSuccessFlash($operation, $context)->shouldNotBeCalled();
+
+        $this->flashProcessor->process(['foo' => 'fighters'], $operation->reveal(), $context);
+    }
+
+    /** @test */
+    public function it_does_nothing_when_validation_has_failed(): void
+    {
+        $request = $this->prophesize(Request::class);
+        $attributes = $this->prophesize(ParameterBag::class);
+        $operation = $this->prophesize(HttpOperation::class);
+
+        $request->isMethodSafe()->willReturn(false);
+
+        $request->attributes = $attributes;
+
+        $attributes->getBoolean('is_valid', true)->willReturn(false)->shouldBeCalled();
+
+        $context = new Context(new RequestOption($request->reveal()));
+
+        $this->decorated->process(['foo' => 'fighters'], $operation, $context)->willReturn(['foo' => 'fighters'])->shouldBeCalled();
+
+        $this->flashHelper->addSuccessFlash($operation, $context)->shouldNotBeCalled();
+
+        $this->flashProcessor->process(['foo' => 'fighters'], $operation->reveal(), $context);
+    }
+}

src/Component/composer.json

@@ -50,6 +50,7 @@
         "behat/transliterator": "^1.3",
         "doctrine/orm": "^2.5",
         "phpspec/phpspec": "^7.3",
+        "phpspec/prophecy-phpunit": "^2.0",
         "phpunit/phpunit": "^9.5",
         "sylius/grid": "^1.7 || ^1.12",
         "symfony/serializer": "^5.4 || ^6.0",

src/Component/src/State/Processor/FlashProcessor.php

@@ -0,0 +1,52 @@
+<?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\Resource\State\Processor;
+
+use Sylius\Resource\Symfony\Session\Flash\FlashHelperInterface;
+use Sylius\Resource\Context\Context;
+use Sylius\Resource\Context\Option\RequestOption;
+use Sylius\Resource\Metadata\Operation;
+use Sylius\Resource\State\ProcessorInterface;
+use Symfony\Component\HttpFoundation\Response;
+
+final class FlashProcessor implements ProcessorInterface
+{
+    public function __construct(
+        private ProcessorInterface $decorated,
+        private FlashHelperInterface $flashHelper,
+    ) {
+    }
+
+    public function process(mixed $data, Operation $operation, Context $context): mixed
+    {
+        $data = $this->decorated->process($data, $operation, $context);
+        $request = $context->get(RequestOption::class)?->request();
+
+        if (null === $request) {
+            return $data;
+        }
+
+        if (
+            $data instanceof Response ||
+            $request->isMethodSafe() ||
+            !$request->attributes->getBoolean('is_valid', true)
+        ) {
+            return $data;
+        }
+
+        $this->flashHelper->addSuccessFlash($operation, $context);
+
+        return $data;
+    }
+}