Add component repository repository so when bulking, country is saved first

Author: jissereitsma

Component/ComponentRepository.php

@@ -49,4 +49,9 @@ protected function getContext(): ComponentContextInterface
     {
         return $this->component->getContext();
     }
+
+    public function getPriority(): int
+    {
+        return 0;
+    }
 }

Component/ComponentRepositoryInterface.php

@@ -11,5 +11,6 @@ public function saveValue(mixed $value): void;
 
     public function getValue(): mixed;
     public function getDefaultValue(): mixed;
+    public function getPriority(): int;
 
 }

Controller/Index/Html.php

@@ -5,6 +5,8 @@
 namespace Loki\Components\Controller\Index;
 
 use Exception;
+use Loki\Components\Component\ComponentInterface;
+use Loki\Components\Component\ComponentRegistry;
 use Magento\Framework\App\Action\HttpGetActionInterface;
 use Magento\Framework\App\Action\HttpPostActionInterface;
 use Magento\Framework\App\ResponseInterface;
@@ -38,7 +40,8 @@ public function __construct(
         private readonly MessageManager $messageManager,
         private readonly Config $config,
         private readonly AppState $appState,
-        private readonly LoggerInterface $logger
+        private readonly LoggerInterface $logger,
+        private readonly ComponentRegistry $componentRegistry
     ) {
     }
 
@@ -48,10 +51,14 @@ public function execute(): ResultInterface|ResponseInterface
         $this->requestDataLoader->mergeRequestParams();
         $layout = $this->layoutLoader->load($data['handles']);
 
-        foreach ($data['updates'] as $update) {
+        $updates = $this->enrichUpdates($data['updates'], $layout);
+        $updates = $this->sortUpdates($updates);
+
+        foreach ($updates as $update) {
+            echo "UPDATE: ".$update['blockName']."\n";
             try {
                 $this->repositoryDispatcher->dispatch(
-                    $this->getBlock($layout, $update['blockName']),
+                    $update['component'],
                     $update['update']
                 );
             } catch (NoBlockFoundException $exception) {
@@ -81,6 +88,31 @@ public function execute(): ResultInterface|ResponseInterface
         return $this->getHtmlResult($htmlParts);
     }
 
+    private function enrichUpdates(array $updates, LayoutInterface $layout): array
+    {
+        foreach ($updates as $updateIndex => $update) {
+            $update['block'] = $this->getBlock($layout, $update['blockName']);
+            $update['component'] = $this->componentRegistry->getComponentFromBlock($update['block']);
+            $updates[$updateIndex] = $update;
+        }
+
+        return $updates;
+    }
+
+    private function sortUpdates(array $updates): array
+    {
+        usort($updates, function (array $a, array $b) {
+            /** @var ComponentInterface $componentA */
+            /** @var ComponentInterface $componentB */
+            $componentA = $a['component'];
+            $componentB = $b['component'];
+
+            return $componentA->getRepository()?->getPriority() <=> $componentB->getRepository()?->getPriority();
+        });
+
+        return $updates;
+    }
+
     private function getBlock(LayoutInterface $layout, string $blockName): AbstractBlock
     {
         if ($blockName === '' || $blockName === '0') {
@@ -116,6 +148,7 @@ private function getJsonRedirect(string $redirectUrl): JsonResult
         ]);
 
         $json->setHeader('X-Loki-Redirect', $redirectUrl);
+
         // @todo: Make sure messages sent to frontend are remembered
 
         return $json;

Util/Controller/RepositoryDispatcher.php

@@ -2,26 +2,23 @@
 
 namespace Loki\Components\Util\Controller;
 
+use Loki\Components\Component\ComponentInterface;
 use Magento\Framework\Event\Manager as EventManager;
-use Magento\Framework\View\Element\AbstractBlock;
-use Loki\Components\Component\ComponentRegistry;
 use Loki\Components\Component\ComponentRepositoryInterface;
 use Loki\Components\Filter\Filter;
 use Loki\Components\Validator\Validator;
 
 class RepositoryDispatcher
 {
     public function __construct(
-        private readonly ComponentRegistry $componentRegistry,
         private readonly EventManager $eventManager,
         private readonly Filter $filter,
         private readonly Validator $validator,
     ) {
     }
 
-    public function dispatch(AbstractBlock $block, mixed $componentData): void
+    public function dispatch(ComponentInterface $component, mixed $componentData): void
     {
-        $component = $this->componentRegistry->getComponentFromBlock($block);
         $this->eventManager->dispatch('loki_components_repository_dispatch', ['component' => $component]);
 
         $repository = $component->getRepository();