Merge pull request #28 from shopware/next-39768/check-if-the-shop-url…

…-is-reachable NEXT-39768 - Dispatch an event before storing the shop in the DB during the registration process
shopware · Dec 3, 2024 · 47939ad · 47939ad
2 parents 4d78e47 + 3c771b2
commit 47939ad
Show file tree

Hide file tree

Showing 4 changed files with 185 additions and 11 deletions.
diff --git a/src/Event/BeforeRegistrationStartsEvent.php b/src/Event/BeforeRegistrationStartsEvent.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopware\App\SDK\Event;
+
+/**
+ * This event is fired before the registration process for new or already existing shops.
+ */
+class BeforeRegistrationStartsEvent extends AbstractAppLifecycleEvent
+{
+}
diff --git a/src/Registration/RegistrationService.php b/src/Registration/RegistrationService.php
@@ -14,6 +14,7 @@
 use Shopware\App\SDK\Authentication\RequestVerifier;
 use Shopware\App\SDK\Authentication\ResponseSigner;
 use Shopware\App\SDK\Event\BeforeRegistrationCompletedEvent;
+use Shopware\App\SDK\Event\BeforeRegistrationStartsEvent;
 use Shopware\App\SDK\Event\RegistrationCompletedEvent;
 use Shopware\App\SDK\Exception\MissingShopParameterException;
 use Shopware\App\SDK\Exception\ShopNotFoundException;
@@ -61,9 +62,15 @@ public function register(RequestInterface $request): ResponseInterface
                 $this->shopSecretGeneratorInterface->generate()
             );
 
+            $this->eventDispatcher?->dispatch(new BeforeRegistrationStartsEvent($request, $shop));
+
             $this->shopRepository->createShop($shop);
         } else {
-            $this->shopRepository->updateShop($shop->setShopUrl($queries['shop-url']));
+            $shop->setShopUrl($queries['shop-url']);
+
+            $this->eventDispatcher?->dispatch(new BeforeRegistrationStartsEvent($request, $shop));
+
+            $this->shopRepository->updateShop($shop);
         }
 
         $this->logger->info('Shop registration request received', [

diff --git a/tests/Event/BeforeRegistrationStartsEventTest.php b/tests/Event/BeforeRegistrationStartsEventTest.php
@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Event;
+
+use Nyholm\Psr7\Request;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
+use Shopware\App\SDK\Event\BeforeRegistrationStartsEvent;
+use Shopware\App\SDK\Test\MockShop;
+
+#[CoversClass(BeforeRegistrationStartsEvent::class)]
+class BeforeRegistrationStartsEventTest extends TestCase
+{
+    public function testEvent(): void
+    {
+        $event = new BeforeRegistrationStartsEvent(
+            new Request('GET', 'http://localhost?shop-id=123&shop-url=https://my-shop.com&timestamp=1234567890'),
+            new MockShop('shop-id', 'shop-url', 'shop-secret'),
+        );
+
+        static::assertSame('GET', $event->getRequest()->getMethod());
+        static::assertSame('http://localhost?shop-id=123&shop-url=https://my-shop.com&timestamp=1234567890', (string) $event->getRequest()->getUri());
+        static::assertSame('shop-id', $event->getShop()->getShopId());
+        static::assertSame('shop-url', $event->getShop()->getShopUrl());
+        static::assertSame('shop-secret', $event->getShop()->getShopSecret());
+    }
+}
diff --git a/tests/Registration/RegistrationServiceTest.php b/tests/Registration/RegistrationServiceTest.php
@@ -15,12 +15,14 @@
 use Shopware\App\SDK\Authentication\RequestVerifier;
 use Shopware\App\SDK\Authentication\ResponseSigner;
 use Shopware\App\SDK\Event\BeforeRegistrationCompletedEvent;
+use Shopware\App\SDK\Event\BeforeRegistrationStartsEvent;
 use Shopware\App\SDK\Event\RegistrationCompletedEvent;
 use Shopware\App\SDK\Exception\MissingShopParameterException;
 use Shopware\App\SDK\Exception\ShopNotFoundException;
 use Shopware\App\SDK\Registration\RandomStringShopSecretGenerator;
 use Shopware\App\SDK\Registration\RegistrationService;
 use PHPUnit\Framework\TestCase;
+use Shopware\App\SDK\Shop\ShopRepositoryInterface;
 use Shopware\App\SDK\Test\MockShop;
 use Shopware\App\SDK\Test\MockShopRepository;
 
@@ -55,16 +57,89 @@ public function testRegisterMissingParameters(): void
 
     public function testRegisterCreate(): void
     {
-        $request = new Request('GET', 'http://localhost?shop-id=123&shop-url=https://my-shop.com&timestamp=1234567890');
+        $events = [];
 
-        $response = $this->registerService->register($request);
+        $eventDispatcher = $this->createMock(EventDispatcherInterface::class);
+        $eventDispatcher
+            ->expects(static::once())
+            ->method('dispatch')
+            ->willReturnCallback(function ($event) use (&$events) {
+                $events[] = $event;
+            });
 
-        $shop = $this->shopRepository->getShopFromId('123');
-        static::assertNotNull($shop);
+        $shopRepository = $this->createMock(ShopRepositoryInterface::class);
 
-        static::assertEquals('123', $shop->getShopId());
-        static::assertEquals('https://my-shop.com', $shop->getShopUrl());
-        static::assertNotNull($shop->getShopSecret());
+        $registrationService = new RegistrationService(
+            $this->appConfiguration,
+            $shopRepository,
+            $this->createMock(RequestVerifier::class),
+            new ResponseSigner(),
+            new RandomStringShopSecretGenerator(),
+            new NullLogger(),
+            $eventDispatcher
+        );
+
+        $shopRepository
+            ->expects(static::once())
+            ->method('getShopFromId')
+            ->willReturn(null);
+
+        $shop = new MockShop('123', 'https://my-shop.com', '1234567890');
+
+        $shopRepository
+            ->expects(static::once())
+            ->method('createShopStruct')
+            ->willReturn($shop);
+
+        $eventDispatcher
+            ->expects(static::once())
+            ->method('dispatch');
+
+        $response = $registrationService->register(
+            new Request('GET', 'http://localhost?shop-id=123&shop-url=https://my-shop.com&timestamp=1234567890')
+        );
+
+        static::assertSame(200, $response->getStatusCode());
+        $json = json_decode((string) $response->getBody()->getContents(), true);
+
+        static::assertCount(1, $events);
+        static::assertInstanceOf(BeforeRegistrationStartsEvent::class, $events[0]);
+
+        static::assertIsArray($json);
+        static::assertArrayHasKey('proof', $json);
+        static::assertArrayHasKey('confirmation_url', $json);
+        static::assertArrayHasKey('secret', $json);
+    }
+
+    public function testRegisterCreateMustNotDispatchBeforeRegistrationStartsEvent(): void
+    {
+        $shopRepository = $this->createMock(ShopRepositoryInterface::class);
+
+        $registrationService = new RegistrationService(
+            $this->appConfiguration,
+            $shopRepository,
+            $this->createMock(RequestVerifier::class),
+            new ResponseSigner(),
+            new RandomStringShopSecretGenerator(),
+            new NullLogger(),
+            null
+        );
+
+        $shopRepository
+            ->expects(static::once())
+            ->method('getShopFromId')
+            ->willReturn(null);
+
+        $shop = new MockShop('123', 'https://my-shop.com', '1234567890');
+
+        $shopRepository
+            ->expects(static::once())
+            ->method('createShopStruct')
+            ->willReturn($shop);
+
+        $response = $registrationService->register(
+            new Request('GET', 'http://localhost?shop-id=123&shop-url=https://my-shop.com&timestamp=1234567890')
+        );
 
         static::assertSame(200, $response->getStatusCode());
         $json = json_decode((string) $response->getBody()->getContents(), true);
@@ -77,13 +152,64 @@ public function testRegisterCreate(): void
 
     public function testRegisterUpdate(): void
     {
-        $request = new Request('GET', 'http://localhost?shop-id=123&shop-url=https://my-shop.com&timestamp=1234567890');
+        $events = [];
 
-        $this->shopRepository->createShop(new MockShop('123', 'https://foo.com', '1234567890'));
+        $eventDispatcher = $this->createMock(EventDispatcherInterface::class);
+        $eventDispatcher
+            ->expects(static::once())
+            ->method('dispatch')
+            ->willReturnCallback(function ($event) use (&$events) {
+                $events[] = $event;
+            });
 
-        $this->registerService->register($request);
+        $registrationService = new RegistrationService(
+            $this->appConfiguration,
+            $this->shopRepository,
+            $this->createMock(RequestVerifier::class),
+            new ResponseSigner(),
+            new RandomStringShopSecretGenerator(),
+            new NullLogger(),
+            $eventDispatcher
+        );
+
+        $registrationService->register(
+            new Request('GET', 'http://localhost?shop-id=123&shop-url=https://my-shop.com&timestamp=1234567890')
+        );
 
         $shop = $this->shopRepository->getShopFromId('123');
+
+        $this->shopRepository->updateShop($shop);
+
+        static::assertNotNull($shop);
+
+        static::assertCount(1, $events);
+        static::assertInstanceOf(BeforeRegistrationStartsEvent::class, $events[0]);
+
+        static::assertEquals('123', $shop->getShopId());
+        static::assertEquals('https://my-shop.com', $shop->getShopUrl());
+        static::assertNotNull($shop->getShopSecret());
+    }
+
+    public function testRegisterUpdateMustNotDispatchBeforeRegistrationStartsEvent(): void
+    {
+        $registrationService = new RegistrationService(
+            $this->appConfiguration,
+            $this->shopRepository,
+            $this->createMock(RequestVerifier::class),
+            new ResponseSigner(),
+            new RandomStringShopSecretGenerator(),
+            new NullLogger(),
+            null
+        );
+
+        $request = new Request('GET', 'http://localhost?shop-id=123&shop-url=https://my-shop.com&timestamp=1234567890');
+
+        $registrationService->register($request);
+
+        $shop = $this->shopRepository->getShopFromId('123');
+
+        $this->shopRepository->updateShop($shop);
+
         static::assertNotNull($shop);
 
         static::assertEquals('123', $shop->getShopId());