Added scheduled tasks register button to admin

Author: PheysX

src/Controller/ScheduledTaskController.php

@@ -6,6 +6,7 @@
 use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
 use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
 use Shopware\Core\Framework\MessageQueue\Handler\AbstractMessageHandler;
+use Shopware\Core\Framework\MessageQueue\ScheduledTask\Registry\TaskRegistry;
 use Shopware\Core\Framework\MessageQueue\ScheduledTask\ScheduledTaskDefinition;
 use Shopware\Core\Framework\MessageQueue\ScheduledTask\ScheduledTaskEntity;
 use Symfony\Component\HttpFoundation\JsonResponse;
@@ -23,10 +24,17 @@ class ScheduledTaskController
 
     private EntityRepositoryInterface $scheduledTaskRepository;
 
-    public function __construct(iterable $taskHandler, EntityRepositoryInterface $scheduledTaskRepository)
+    private TaskRegistry $taskRegistry;
+
+    public function __construct(
+        iterable $taskHandler,
+        EntityRepositoryInterface $scheduledTaskRepository,
+        TaskRegistry $taskRegistry
+    )
     {
         $this->taskHandler = $taskHandler;
         $this->scheduledTaskRepository = $scheduledTaskRepository;
+        $this->taskRegistry = $taskRegistry;
     }
 
     /**
@@ -68,6 +76,16 @@ public function runTask(string $id, Context $context): JsonResponse
         return new JsonResponse(null, JsonResponse::HTTP_NO_CONTENT);
     }
 
+    /**
+     * @Route(path="/scheduled-tasks/register", methods={"POST"}, name="api.frosh.tools.scheduled.tasks.register")
+     */
+    public function registerTasks(): JsonResponse
+    {
+        $this->taskRegistry->registerTasks();
+
+        return new JsonResponse(null, JsonResponse::HTTP_NO_CONTENT);
+    }
+
     private function fetchTask(string $id, Context $context): ScheduledTaskEntity
     {
         $criteria = new Criteria([$id]);

src/Resources/app/administration/src/api/frosh-tools.js

@@ -66,6 +66,19 @@ class FroshTools extends ApiService {
         });
     }
 
+    scheduledTasksRegister() {
+        const apiRoute = `${this.getApiBasePath()}/scheduled-tasks/register`;
+        return this.httpClient.post(
+            apiRoute,
+            {},
+            {
+                headers: this.getBasicHeaders()
+            }
+        ).then((response) => {
+            return ApiService.handleResponse(response);
+        });
+    }
+
     healthStatus() {
         const apiRoute = `${this.getApiBasePath()}/health/status`;
         return this.httpClient.get(
@@ -170,7 +183,7 @@ class FroshTools extends ApiService {
             return ApiService.handleResponse(response);
         });
     }
-    
+
     stateMachines(stateMachine) {
         const apiRoute = `${this.getApiBasePath()}/state-machines/load`;
         return this.httpClient.get(

src/Resources/app/administration/src/module/frosh-tools/component/frosh-tools-tab-scheduled/index.js

@@ -67,12 +67,14 @@ Component.register('frosh-tools-tab-scheduled', {
             this.isLoading = true;
             await this.createdComponent();
         },
+
         async createdComponent() {
             const criteria = new Criteria;
             criteria.addSorting(Criteria.sort('nextExecutionTime', 'ASC'));
             this.items = await this.scheduledRepository.search(criteria, Shopware.Context.api);
             this.isLoading = false;
         },
+
         async runTask(item) {
             this.isLoading = true;
 
@@ -91,6 +93,26 @@ Component.register('frosh-tools-tab-scheduled', {
             }
 
             this.createdComponent();
-        }
+        },
+
+        async registerScheduledTasks() {
+            this.isLoading = true;
+
+            try {
+                this.createNotificationInfo({
+                    message: this.$tc('frosh-tools.scheduledTasksRegisterStarted')
+                })
+                await this.froshToolsService.scheduledTasksRegister();
+                this.createNotificationSuccess({
+                    message: this.$tc('frosh-tools.scheduledTasksRegisterSucceed')
+                })
+            } catch (e) {
+                this.createNotificationError({
+                    message: this.$tc('frosh-tools.scheduledTasksRegisterFailed')
+                })
+            }
+
+            this.createdComponent();
+        },
     }
 });

src/Resources/app/administration/src/module/frosh-tools/component/frosh-tools-tab-scheduled/style.scss

@@ -1,4 +1,9 @@
 .frosh-tools-tab-scheduled__tasks-card {
+    .sw-card__toolbar {
+        display: flex;
+        justify-content: space-between;
+    }
+
     .sw-card__content {
         padding: 0;
     }

src/Resources/app/administration/src/module/frosh-tools/component/frosh-tools-tab-scheduled/template.twig

@@ -2,8 +2,8 @@
     <sw-card class="frosh-tools-tab-scheduled__tasks-card" :title="$tc('frosh-tools.tabs.scheduledTaskOverview.title')" :isLoading="isLoading" :large="true">
 
         <template #toolbar>
-            <!-- @todo: Make the refresh button fancy -->
             <sw-button variant="ghost" @click="refresh"><sw-icon :small="true" name="default-arrow-360-left"></sw-icon></sw-button>
+            <sw-button variant="primary" @click="registerScheduledTasks">{{ $tc('frosh-tools.scheduledTasksRegisterStarted') }}</sw-button>
         </template>
 
         <sw-entity-listing

src/Resources/app/administration/src/module/frosh-tools/snippet/de-DE.json

@@ -75,6 +75,9 @@
     "scheduledTaskStarted": "Die geplante Aufgabe für \"{name}\" wurde gestartet",
     "scheduledTaskSucceed": "Die geplante Aufgabe für \"{name}\" war erfolgreich",
     "scheduledTaskFailed": "Die geplante Aufgabe für \"{name}\" ist fehlgeschlagen",
+    "scheduledTasksRegisterStarted": "Registriere geplante Aufgaben",
+    "scheduledTasksRegisterSucceed": "Geplante Aufgaben registriert",
+    "scheduledTasksRegisterFailed": "Es ist ein Fehler beim registrieren aufgetreten",
     "checker": {
       "scheduledTaskGood": "Die geplanten Aufgaben laufen regelmäßig",
       "scheduledTaskWarning": "Die geplanten Aufgaben laufen seit mehr als 10 Minuten nicht",

src/Resources/app/administration/src/module/frosh-tools/snippet/en-GB.json

@@ -75,6 +75,9 @@
     "scheduledTaskStarted": "The scheduled task execution for \"{name}\" started",
     "scheduledTaskSucceed": "The scheduled task execution for \"{name}\" succeed",
     "scheduledTaskFailed": "The scheduled task execution for \"{name}\" failed",
+    "scheduledTasksRegisterStarted": "Register scheduled tasks",
+    "scheduledTasksRegisterSucceed": "Scheduled tasks registered",
+    "scheduledTasksRegisterFailed": "Scheduled tasks registration failed",
     "checker": {
       "scheduledTaskGood": "Scheduled tasks working scheduled",
       "scheduledTaskWarning": "The scheduled tasks are waiting for executing for more than 10 minutes",

src/Resources/config/services.xml

@@ -68,6 +68,7 @@
         <service id="Frosh\Tools\Controller\ScheduledTaskController" public="true">
             <argument type="tagged" tag="messenger.message_handler"/>
             <argument type="service" id="scheduled_task.repository"/>
+            <argument type="service" id="Shopware\Core\Framework\MessageQueue\ScheduledTask\Registry\TaskRegistry"/>
         </service>
 
         <service id="Frosh\Tools\Controller\LogController" public="true">