#13 ability to add modal confirmation or nothing instead of launch from of process run ui.

Author: clever-age-gtonon

config/services/twig.yaml

@@ -17,6 +17,12 @@ services:
         tags:
             - { name: 'twig.extension' }
 
+    cleverage_ui_process.twig.process_extension:
+        class: CleverAge\UiProcessBundle\Twig\Extension\ProcessExtension
+        public: false
+        tags:
+            - { name: 'twig.extension' }
+
     cleverage_ui_process.twig.log_level_extension_runtime:
         class: CleverAge\UiProcessBundle\Twig\Runtime\LogLevelExtensionRuntime
         public: false
@@ -37,3 +43,17 @@ services:
         arguments:
             - '@cleverage_ui_process.repository.process_execution'
             - '@cleverage_ui_process.manager.process_configuration'
+
+    cleverage_ui_process.twig.process_extension_runtime:
+        class: CleverAge\UiProcessBundle\Twig\Runtime\ProcessExtensionRuntime
+        public: false
+        tags:
+            - { name: 'twig.runtime' }
+        arguments:
+            - '@cleverage_ui_process.manager.process_configuration'
+
+    cleverage_ui_process.twig.component.bootstrap_modal:
+        class: CleverAge\UiProcessBundle\Twig\Components\BootstrapModal
+        shared: false
+        tags:
+            - { name: 'twig.component', key: 'ui:BootstrapModal', template: '@CleverAgeUiProcess/components/BootstrapModal.html.twig' }

src/Controller/Admin/Process/LaunchAction.php

@@ -13,6 +13,7 @@
 
 namespace CleverAge\UiProcessBundle\Controller\Admin\Process;
 
+use CleverAge\ProcessBundle\Exception\MissingProcessException;
 use CleverAge\UiProcessBundle\Entity\User;
 use CleverAge\UiProcessBundle\Form\Type\LaunchType;
 use CleverAge\UiProcessBundle\Manager\ProcessConfigurationsManager;
@@ -39,20 +40,36 @@
 #[IsGranted('ROLE_USER')]
 class LaunchAction extends AbstractController
 {
+    public function __construct(private readonly MessageBusInterface $messageBus)
+    {
+    }
+
     public function __invoke(
         RequestStack $requestStack,
-        MessageBusInterface $messageBus,
         string $uploadDirectory,
         ProcessConfigurationsManager $processConfigurationsManager,
         AdminContext $context,
     ): Response {
-        $uiOptions = $processConfigurationsManager->getUiOptions($requestStack->getMainRequest()?->get('process') ?? '');
+        $processCode = $requestStack->getMainRequest()?->get('process');
+        if (null === $processCode) {
+            throw new MissingProcessException();
+        }
+        $uiOptions = $processConfigurationsManager->getUiOptions($processCode);
+        if (false === $uiOptions['input_context_launcher_form']) {
+            $this->dispatch($processCode);
+            $this->addFlash(
+                'success',
+                'Process has been added to queue. It will start as soon as possible'
+            );
+
+            return $this->redirectToRoute('process', ['routeName' => 'process_list']);
+        }
         $form = $this->createForm(
             LaunchType::class,
             null,
             [
                 'constraints' => $uiOptions['constraints'] ?? [],
-                'process_code' => $requestStack->getMainRequest()?->get('process'),
+                'process_code' => $processCode,
             ]
         );
         if (false === $form->isSubmitted()) {
@@ -72,16 +89,11 @@ public function __invoke(
                 (new Filesystem())->dumpFile($filename, $input->getContent());
                 $input = $filename;
             }
-
-            $message = new ProcessExecuteMessage(
+            $this->dispatch(
                 $form->getConfig()->getOption('process_code'),
                 $input,
-                array_merge(
-                    ['execution_user' => $this->getUser()?->getEmail()],
-                    $form->get('context')->getData()
-                )
+                $form->get('context')->getData()
             );
-            $messageBus->dispatch($message);
             $this->addFlash(
                 'success',
                 'Process has been added to queue. It will start as soon as possible'
@@ -99,6 +111,19 @@ public function __invoke(
         );
     }
 
+    protected function dispatch(string $processCode, mixed $input = null, array $context = []): void
+    {
+        $message = new ProcessExecuteMessage(
+            $processCode,
+            $input,
+            array_merge(
+                ['execution_user' => $this->getUser()?->getEmail()],
+                $context
+            )
+        );
+        $this->messageBus->dispatch($message);
+    }
+
     protected function getUser(): ?User
     {
         /** @var User $user */

src/Manager/ProcessConfigurationsManager.php

@@ -57,6 +57,8 @@ private function resolveUiOptions(array $options): array
                     'source' => null,
                     'target' => null,
                     'entrypoint_type' => 'text',
+                    'input_context_launcher_form' => false,
+                    'run_confirmation_modal' => false,
                     'constraints' => [],
                     'run' => null,
                     'default' => function (OptionsResolver $defaultResolver) {
@@ -76,6 +78,8 @@ private function resolveUiOptions(array $options): array
             );
             $uiResolver->setAllowedValues('entrypoint_type', ['text', 'file']);
             $uiResolver->setNormalizer('constraints', fn (Options $options, array $values): array => (new ConstraintLoader())->buildConstraints($values));
+            $uiResolver->setAllowedTypes('input_context_launcher_form', ['bool']);
+            $uiResolver->setAllowedTypes('run_confirmation_modal', ['bool']);
         });
 
         return $resolver->resolve($options);

src/Twig/Components/BootstrapModal.php

@@ -0,0 +1,20 @@
+<?php
+
+/*
+ * This file is part of the CleverAge/UiProcessBundle package.
+ *
+ * Copyright (c) Clever-Age
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CleverAge\UiProcessBundle\Twig\Components;
+
+class BootstrapModal
+{
+    public ?string $id = null;
+    public ?string $title = null;
+    public ?string $message = null;
+    public ?string $confirmUrl = null;
+}

src/Twig/Extension/ProcessExtension.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the CleverAge/UiProcessBundle package.
+ *
+ * Copyright (c) Clever-Age
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CleverAge\UiProcessBundle\Twig\Extension;
+
+use CleverAge\UiProcessBundle\Twig\Runtime\ProcessExtensionRuntime;
+use Twig\Extension\AbstractExtension;
+use Twig\TwigFunction;
+
+class ProcessExtension extends AbstractExtension
+{
+    public function getFunctions(): array
+    {
+        return [
+            new TwigFunction(
+                'resolve_ui_options',
+                [ProcessExtensionRuntime::class, 'getUiOptions']
+            ),
+        ];
+    }
+}

src/Twig/Runtime/ProcessExtensionRuntime.php

@@ -0,0 +1,27 @@
+<?php
+
+/*
+ * This file is part of the CleverAge/UiProcessBundle package.
+ *
+ * Copyright (c) Clever-Age
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CleverAge\UiProcessBundle\Twig\Runtime;
+
+use CleverAge\UiProcessBundle\Manager\ProcessConfigurationsManager;
+use Twig\Extension\RuntimeExtensionInterface;
+
+class ProcessExtensionRuntime implements RuntimeExtensionInterface
+{
+    public function __construct(protected ProcessConfigurationsManager $processConfigurationsManager)
+    {
+    }
+
+    public function getUiOptions(string $code): array
+    {
+        return $this->processConfigurationsManager->getUiOptions($code) ?? [];
+    }
+}

templates/admin/process/list.html.twig

@@ -21,6 +21,7 @@
             {# @var process \CleverAge\ProcessBundle\Configuration\ProcessConfiguration #}
             {% for process in processes %}
                 {% set lastExecution = get_last_execution_date(process.code) %}
+                {% set uiOptions = resolve_ui_options(process.code) %}
                 {% set statusClass = '' %}
                 {% if lastExecution is not null %}
                     {% set statusClass = lastExecution.status.value == 'failed' ? 'danger' : 'success' %}
@@ -32,9 +33,15 @@
                     <td>{% if process.options.ui.source is defined %}{{ process.options.ui.source }}{% endif %}</td>
                     <td>{% if process.options.ui.target is defined %}{{ process.options.ui.target }}{% endif %}</td>
                     <td class="text-center">
-                        <a class="px-1" data-toggle="tooltip" data-placement="top" title="{{ 'Launch'|trans }}" href="{{ url('process', {routeName: 'process_launch', process: process.code}) }}">
-                            <i class="fas fa-rocket"></i>
-                        </a>
+                        {% if (false == uiOptions.input_context_launcher_form and true ==  uiOptions.run_confirmation_modal) %}
+                            <a class="px-1" data-toggle="tooltip" data-placement="top" title="{{ 'Launch'|trans }}" data-bs-toggle="modal" data-bs-target="#{{ process.code }}">
+                                <i class="fas fa-rocket"></i>
+                            </a>
+                        {% else %}
+                            <a class="px-1" data-toggle="tooltip" data-placement="top" title="{{ 'Launch'|trans }}" href="{{ url('process', {routeName: 'process_launch', process: process.code}) }}">
+                                <i class="fas fa-rocket"></i>
+                            </a>
+                        {% endif %}
                         <a
                             class="px-1"
                             data-toggle="tooltip"
@@ -58,6 +65,12 @@
                         </a>
                     </td>
                 </tr>
+                <twig:ui:BootstrapModal
+                        id="{{ process.code }}"
+                        title="{{ 'Run process'|trans }} {{ process.code }}"
+                        message="{{ 'Do you really want to run process %process% in background'|trans({'%process%': process.code}) }} ?"
+                        confirmUrl="{{ url('process', {routeName: 'process_launch', process: process.code}) }}"
+                />
             {% endfor %}
         {% endblock %}
         </tbody>

templates/components/BootstrapModal.html.twig

@@ -0,0 +1,37 @@
+<div {{ attributes.defaults({
+    class: 'modal fade',
+    tabindex: '-1',
+    'aria-hidden': 'true',
+    id: id ? id : false,
+}) }}
+        data-controller="bootstrap-modal"
+>
+    <div class="modal-dialog">
+        <div class="modal-content">
+            {% block modal_full_content %}
+                {% if block('modal_header') %}
+                    <div class="modal-header text-center">
+                        {% block modal_header %}
+                            <h5>{{ title }}</h5>
+                        {% endblock %}
+                        <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
+                    </div>
+                {% endif %}
+
+                <div class="modal-body">
+                    {% block modal_body %}{{ message }}{% endblock %}
+                </div>
+
+                {% if block('modal_footer') %}
+                    <div class="modal-footer">
+                        {% block modal_footer %}
+                         {% if null != confirmUrl %}
+                             <a href="{{ confirmUrl }}"><button type="button" class="btn btn-primary">{{ 'Confirm'|trans }}</button></a>
+                         {% endif %}
+                        {% endblock %}
+                    </div>
+                {% endif %}
+            {% endblock %}
+        </div>
+    </div>
+</div>