refactor(actions): move PdkActions to a proper service with interface (…

…#217)
myparcelnl · Oct 19, 2023 · 94508ee · 94508ee
1 parent e7356af
commit 94508ee
Show file tree

Hide file tree

Showing 9 changed files with 278 additions and 104 deletions.
diff --git a/config/pdk-services.php b/config/pdk-services.php
@@ -8,6 +8,8 @@
 use MyParcelNL\Pdk\Api\Contract\ApiServiceInterface;
 use MyParcelNL\Pdk\Api\Service\MyParcelApiService;
 use MyParcelNL\Pdk\App\Account\Contract\PdkAccountRepositoryInterface;
+use MyParcelNL\Pdk\App\Api\Contract\PdkActionsServiceInterface;
+use MyParcelNL\Pdk\App\Api\Service\PdkActionsService;
 use MyParcelNL\Pdk\App\Cart\Contract\CartCalculationServiceInterface;
 use MyParcelNL\Pdk\App\Cart\Service\CartCalculationService;
 use MyParcelNL\Pdk\App\DeliveryOptions\Contract\DeliveryOptionsFeesServiceInterface;
@@ -183,6 +185,11 @@
         return \MyParcelNL\Pdk\Facade\Pdk::get(AccountRepositoryInterface::class);
     }),
 
+    /**
+     * Handles executing pdk actions.
+     */
+    PdkActionsServiceInterface::class          => autowire(PdkActionsService::class),
+
     /**
      * Handles order options calculation.
      */

diff --git a/src/App/Api/Contract/PdkActionsServiceInterface.php b/src/App/Api/Contract/PdkActionsServiceInterface.php
@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MyParcelNL\Pdk\App\Api\Contract;
+
+use Symfony\Component\HttpFoundation\Response;
+
+interface PdkActionsServiceInterface
+{
+    /**
+     * @param  string|\Symfony\Component\HttpFoundation\Request $action
+     * @param  array                                            $parameters
+     *
+     * @return \Symfony\Component\HttpFoundation\Response
+     * @throws \MyParcelNL\Pdk\Api\Exception\ApiException
+     * @throws \MyParcelNL\Pdk\Api\Exception\PdkEndpointException
+     */
+    public function execute($action, array $parameters = []): Response;
+
+    /**
+     * @param  string $context
+     *
+     * @return $this
+     */
+    public function setContext(string $context): self;
+}
diff --git a/src/App/Api/PdkActions.php b/src/App/Api/PdkActions.php
@@ -5,107 +5,11 @@
 
 namespace MyParcelNL\Pdk\App\Api;
 
-use InvalidArgumentException;
-use MyParcelNL\Pdk\Api\Exception\PdkEndpointException;
-use MyParcelNL\Pdk\Base\Support\Collection;
-use MyParcelNL\Pdk\Facade\Config;
-use MyParcelNL\Pdk\Facade\Pdk;
-use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpFoundation\Response;
+use MyParcelNL\Pdk\App\Api\Service\PdkActionsService;
 
-class PdkActions
+/**
+ * @deprecated use PdkActionsService. Will be removed in v3.0.0.
+ */
+class PdkActions extends PdkActionsService
 {
-    /**
-     * @var string
-     */
-    private $context = PdkEndpoint::CONTEXT_BACKEND;
-
-    /**
-     * @param  string|\Symfony\Component\HttpFoundation\Request $action
-     * @param  array                                            $parameters
-     *
-     * @return \Symfony\Component\HttpFoundation\Response
-     * @throws \MyParcelNL\Pdk\Api\Exception\ApiException
-     * @throws \MyParcelNL\Pdk\Api\Exception\PdkEndpointException
-     */
-    public function execute($action, array $parameters = []): Response
-    {
-        $request = $this->createRequest($action, $parameters);
-
-        $actionClass = $this->resolveAction($request);
-
-        /** @var \MyParcelNL\Pdk\App\Action\Contract\ActionInterface $action */
-        $action = Pdk::get($actionClass);
-
-        return $action->handle($request);
-    }
-
-    /**
-     * @param  string $context
-     *
-     * @return $this
-     */
-    public function setContext(string $context): self
-    {
-        $this->context = $context;
-
-        return $this;
-    }
-
-    /**
-     * @param        $input
-     * @param  array $parameters
-     *
-     * @return \Symfony\Component\HttpFoundation\Request
-     */
-    protected function createRequest($input, array $parameters = []): Request
-    {
-        if ($input instanceof Request) {
-            if (empty($input->get('action'))) {
-                throw new InvalidArgumentException('Required parameter "action" is missing.');
-            }
-
-            return $input;
-        }
-
-        if (is_string($input)) {
-            $request = Request::createFromGlobals();
-
-            foreach ($parameters as $key => $value) {
-                $request->query->set($key, $value);
-            }
-
-            $request->query->set('action', $input);
-
-            return $request;
-        }
-
-        throw new InvalidArgumentException('Input must be a string or a Request object.');
-    }
-
-    /**
-     * @param  \Symfony\Component\HttpFoundation\Request $request
-     *
-     * @return string
-     * @throws \MyParcelNL\Pdk\Api\Exception\PdkEndpointException
-     */
-    private function resolveAction(Request $request): string
-    {
-        $action = $request->get('action');
-
-        if (! $this->context || ! in_array($this->context, PdkEndpoint::CONTEXTS, true)) {
-            throw new PdkEndpointException('Context is invalid.', Response::HTTP_UNPROCESSABLE_ENTITY);
-        }
-
-        $actions = new Collection(Config::get('actions'));
-
-        $match       = $actions->dataGet("$this->context.$action") ?? $actions->dataGet("shared.$action");
-        $actionClass = $match['action'] ?? null;
-
-        if (! $actionClass || ! class_exists($actionClass)) {
-            throw new PdkEndpointException("Action \"$action\" does not exist.", Response::HTTP_UNPROCESSABLE_ENTITY);
-        }
-
-        return $actionClass;
-    }
 }
diff --git a/src/App/Api/Service/PdkActionsService.php b/src/App/Api/Service/PdkActionsService.php
@@ -0,0 +1,112 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MyParcelNL\Pdk\App\Api\Service;
+
+use InvalidArgumentException;
+use MyParcelNL\Pdk\Api\Exception\PdkEndpointException;
+use MyParcelNL\Pdk\App\Api\Contract\PdkActionsServiceInterface;
+use MyParcelNL\Pdk\App\Api\PdkEndpoint;
+use MyParcelNL\Pdk\Base\Support\Collection;
+use MyParcelNL\Pdk\Facade\Config;
+use MyParcelNL\Pdk\Facade\Pdk;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+class PdkActionsService implements PdkActionsServiceInterface
+{
+    /**
+     * @var string
+     */
+    private $context = PdkEndpoint::CONTEXT_BACKEND;
+
+    /**
+     * @param  string|\Symfony\Component\HttpFoundation\Request $action
+     * @param  array                                            $parameters
+     *
+     * @return \Symfony\Component\HttpFoundation\Response
+     * @throws \MyParcelNL\Pdk\Api\Exception\ApiException
+     * @throws \MyParcelNL\Pdk\Api\Exception\PdkEndpointException
+     */
+    public function execute($action, array $parameters = []): Response
+    {
+        $request = $this->createRequest($action, $parameters);
+
+        $actionClass = $this->resolveAction($request);
+
+        /** @var \MyParcelNL\Pdk\App\Action\Contract\ActionInterface $action */
+        $action = Pdk::get($actionClass);
+
+        return $action->handle($request);
+    }
+
+    /**
+     * @param  string $context
+     *
+     * @return $this
+     */
+    public function setContext(string $context): PdkActionsServiceInterface
+    {
+        $this->context = $context;
+
+        return $this;
+    }
+
+    /**
+     * @param        $input
+     * @param  array $parameters
+     *
+     * @return \Symfony\Component\HttpFoundation\Request
+     */
+    protected function createRequest($input, array $parameters = []): Request
+    {
+        if ($input instanceof Request) {
+            if (empty($input->get('action'))) {
+                throw new InvalidArgumentException('Required parameter "action" is missing.');
+            }
+
+            return $input;
+        }
+
+        if (is_string($input)) {
+            $request = Request::createFromGlobals();
+
+            foreach ($parameters as $key => $value) {
+                $request->query->set($key, $value);
+            }
+
+            $request->query->set('action', $input);
+
+            return $request;
+        }
+
+        throw new InvalidArgumentException('Input must be a string or a Request object.');
+    }
+
+    /**
+     * @param  \Symfony\Component\HttpFoundation\Request $request
+     *
+     * @return string
+     * @throws \MyParcelNL\Pdk\Api\Exception\PdkEndpointException
+     */
+    private function resolveAction(Request $request): string
+    {
+        $action = $request->get('action');
+
+        if (! $this->context || ! in_array($this->context, PdkEndpoint::CONTEXTS, true)) {
+            throw new PdkEndpointException('Context is invalid.', Response::HTTP_UNPROCESSABLE_ENTITY);
+        }
+
+        $actions = new Collection(Config::get('actions'));
+
+        $match       = $actions->dataGet("$this->context.$action") ?? $actions->dataGet("shared.$action");
+        $actionClass = $match['action'] ?? null;
+
+        if (! $actionClass || ! class_exists($actionClass)) {
+            throw new PdkEndpointException("Action \"$action\" does not exist.", Response::HTTP_UNPROCESSABLE_ENTITY);
+        }
+
+        return $actionClass;
+    }
+}
diff --git a/src/Facade/Actions.php b/src/Facade/Actions.php
@@ -4,19 +4,19 @@
 
 namespace MyParcelNL\Pdk\Facade;
 
-use MyParcelNL\Pdk\App\Api\PdkActions;
+use MyParcelNL\Pdk\App\Api\Service\PdkActionsService;
 use MyParcelNL\Pdk\Base\Facade;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 
 /**
  * @method static Response execute(string|Request $action, array $parameters = [])
- * @see PdkActions
+ * @see PdkActionsService
  */
 final class Actions extends Facade
 {
     protected static function getFacadeAccessor(): string
     {
-        return PdkActions::class;
+        return PdkActionsService::class;
     }
 }
diff --git a/tests/Bootstrap/MockPdkActionsService.php b/tests/Bootstrap/MockPdkActionsService.php
@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MyParcelNL\Pdk\Tests\Bootstrap;
+
+use MyParcelNL\Pdk\App\Api\Service\PdkActionsService;
+use MyParcelNL\Pdk\Base\Support\Collection;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Contracts\Service\ResetInterface;
+
+final class MockPdkActionsService extends PdkActionsService implements ResetInterface
+{
+    /**
+     * @var \MyParcelNL\Pdk\Base\Support\Collection
+     */
+    private $calls;
+
+    public function __construct()
+    {
+        $this->reset();
+    }
+
+    /**
+     * @param  string|\Symfony\Component\HttpFoundation\Request $action
+     * @param  array                                            $parameters
+     *
+     * @return \Symfony\Component\HttpFoundation\Response
+     * @throws \MyParcelNL\Pdk\Api\Exception\ApiException
+     * @throws \MyParcelNL\Pdk\Api\Exception\PdkEndpointException
+     */
+    public function execute($action, array $parameters = []): Response
+    {
+        $this->calls->push([
+            'action'     => $action,
+            'parameters' => $parameters,
+        ]);
+
+        return parent::execute($action, $parameters);
+    }
+
+    /**
+     * @return \MyParcelNL\Pdk\Base\Support\Collection
+     */
+    public function getCalls(): Collection
+    {
+        return $this->calls;
+    }
+
+    public function reset(): void
+    {
+        $this->calls = new Collection();
+    }
+}
diff --git a/tests/Bootstrap/MockPdkConfig.php b/tests/Bootstrap/MockPdkConfig.php
@@ -10,6 +10,7 @@
 use MyParcelNL\Pdk\App\Account\Contract\PdkAccountRepositoryInterface;
 use MyParcelNL\Pdk\App\Api\Contract\BackendEndpointServiceInterface;
 use MyParcelNL\Pdk\App\Api\Contract\FrontendEndpointServiceInterface;
+use MyParcelNL\Pdk\App\Api\Contract\PdkActionsServiceInterface;
 use MyParcelNL\Pdk\App\Cart\Contract\PdkCartRepositoryInterface;
 use MyParcelNL\Pdk\App\Installer\Contract\InstallerServiceInterface;
 use MyParcelNL\Pdk\App\Installer\Contract\MigrationServiceInterface;
@@ -84,6 +85,7 @@ private static function getDefaultConfig(): array
             MigrationServiceInterface::class            => get(MockMigrationService::class),
             OrderStatusServiceInterface::class          => get(MockOrderStatusService::class),
             PdkAccountRepositoryInterface::class        => get(MockPdkAccountRepository::class),
+            PdkActionsServiceInterface::class           => get(MockPdkActionsService::class),
             PdkCartRepositoryInterface::class           => get(MockPdkCartRepository::class),
             PdkInterface::class                         => get(MockPdk::class),
             PdkOrderNoteRepositoryInterface::class      => get(MockPdkOrderNoteRepository::class),

diff --git a/tests/Bootstrap/TestCase.php b/tests/Bootstrap/TestCase.php
@@ -24,6 +24,7 @@ protected function getResetServices(): array
             MockCarrierSchema::class,
             MockMemoryCacheStorage::class,
             MockOrderStatusService::class,
+            MockPdkActionsService::class,
             SharedFactoryState::class,
         ];
     }