Skip to content

Commit b781189

Browse files
tonongregorytonongregory
authored
Merge pull request #19 from cleverage/13_lauch_process_without_context_or_input
13 lauch process without context or input
2 parents 1a1c47b + 05c1878 commit b781189

File tree

10 files changed

+215
-18
lines changed

10 files changed

+215
-18
lines changed

‎config/services/twig.yaml

+20
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@ services:
1717
tags:
1818
- { name: 'twig.extension' }
1919

20+
cleverage_ui_process.twig.process_extension:
21+
class: CleverAge\UiProcessBundle\Twig\Extension\ProcessExtension
22+
public: false
23+
tags:
24+
- { name: 'twig.extension' }
25+
2026
cleverage_ui_process.twig.log_level_extension_runtime:
2127
class: CleverAge\UiProcessBundle\Twig\Runtime\LogLevelExtensionRuntime
2228
public: false
@@ -37,3 +43,17 @@ services:
3743
arguments:
3844
- '@cleverage_ui_process.repository.process_execution'
3945
- '@cleverage_ui_process.manager.process_configuration'
46+
47+
cleverage_ui_process.twig.process_extension_runtime:
48+
class: CleverAge\UiProcessBundle\Twig\Runtime\ProcessExtensionRuntime
49+
public: false
50+
tags:
51+
- { name: 'twig.runtime' }
52+
arguments:
53+
- '@cleverage_ui_process.manager.process_configuration'
54+
55+
cleverage_ui_process.twig.component.bootstrap_modal:
56+
class: CleverAge\UiProcessBundle\Twig\Components\BootstrapModal
57+
shared: false
58+
tags:
59+
- { name: 'twig.component', key: 'ui:BootstrapModal', template: '@CleverAgeUiProcess/components/BootstrapModal.html.twig' }

‎docs/index.md

+10
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,16 @@ Now you can access UI Process via http://your-domain.com/process
3333

3434
## Features
3535

36+
### Launch process via UI
37+
From UI "Process List" menu entry you can run a process by clicking on "Rocket" action.
38+
You can manage this behaviour by setting some ui option `ui_launch_mode`
39+
40+
| Value | UI behaviour |
41+
|:---------------:|:--------------------------------------------------------------:|
42+
| modal (default) | On click, open confirmation modal to confirm process execution |
43+
| form | On click, open a form to set input and context execution |
44+
| null | Run process without any confirmation |
45+
3646
### Launch process via http request
3747
You can launch a process via http post request
3848
First you need to generate a token via UI User edit form. The UiProcess generate for you a auth token (keep it in secured area, it will display once).

‎src/Controller/Admin/Process/LaunchAction.php

+43-12
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313

1414
namespace CleverAge\UiProcessBundle\Controller\Admin\Process;
1515

16+
use CleverAge\ProcessBundle\Exception\MissingProcessException;
1617
use CleverAge\UiProcessBundle\Entity\User;
1718
use CleverAge\UiProcessBundle\Form\Type\LaunchType;
1819
use CleverAge\UiProcessBundle\Manager\ProcessConfigurationsManager;
@@ -39,24 +40,43 @@
3940
#[IsGranted('ROLE_USER')]
4041
class LaunchAction extends AbstractController
4142
{
43+
public function __construct(private readonly MessageBusInterface $messageBus)
44+
{
45+
}
46+
4247
public function __invoke(
4348
RequestStack $requestStack,
44-
MessageBusInterface $messageBus,
4549
string $uploadDirectory,
4650
ProcessConfigurationsManager $processConfigurationsManager,
4751
AdminContext $context,
4852
): Response {
49-
$uiOptions = $processConfigurationsManager->getUiOptions($requestStack->getMainRequest()?->get('process') ?? '');
53+
$processCode = $requestStack->getMainRequest()?->get('process');
54+
if (null === $processCode) {
55+
throw new MissingProcessException();
56+
}
57+
$uiOptions = $processConfigurationsManager->getUiOptions($processCode);
58+
if (null === $uiOptions) {
59+
throw new \InvalidArgumentException('Missing UI Options');
60+
}
61+
if (null === $uiOptions['ui_launch_mode'] || 'modal' === $uiOptions['ui_launch_mode']) {
62+
$this->dispatch($processCode);
63+
$this->addFlash(
64+
'success',
65+
'Process has been added to queue. It will start as soon as possible'
66+
);
67+
68+
return $this->redirectToRoute('process', ['routeName' => 'process_list']);
69+
}
5070
$form = $this->createForm(
5171
LaunchType::class,
5272
null,
5373
[
54-
'constraints' => $uiOptions['constraints'] ?? [],
55-
'process_code' => $requestStack->getMainRequest()?->get('process'),
74+
'constraints' => $uiOptions['constraints'],
75+
'process_code' => $processCode,
5676
]
5777
);
5878
if (false === $form->isSubmitted()) {
59-
$default = $uiOptions['default'] ?? [];
79+
$default = $uiOptions['default'];
6080
if (false === $form->get('input')->getConfig()->getType()->getInnerType() instanceof TextType
6181
&& isset($default['input'])
6282
) {
@@ -72,16 +92,11 @@ public function __invoke(
7292
(new Filesystem())->dumpFile($filename, $input->getContent());
7393
$input = $filename;
7494
}
75-
76-
$message = new ProcessExecuteMessage(
95+
$this->dispatch(
7796
$form->getConfig()->getOption('process_code'),
7897
$input,
79-
array_merge(
80-
['execution_user' => $this->getUser()?->getEmail()],
81-
$form->get('context')->getData()
82-
)
98+
$form->get('context')->getData()
8399
);
84-
$messageBus->dispatch($message);
85100
$this->addFlash(
86101
'success',
87102
'Process has been added to queue. It will start as soon as possible'
@@ -99,6 +114,22 @@ public function __invoke(
99114
);
100115
}
101116

117+
/**
118+
* @param mixed[] $context
119+
*/
120+
protected function dispatch(string $processCode, mixed $input = null, array $context = []): void
121+
{
122+
$message = new ProcessExecuteMessage(
123+
$processCode,
124+
$input,
125+
array_merge(
126+
['execution_user' => $this->getUser()?->getEmail()],
127+
$context
128+
)
129+
);
130+
$this->messageBus->dispatch($message);
131+
}
132+
102133
protected function getUser(): ?User
103134
{
104135
/** @var User $user */

‎src/Manager/ProcessConfigurationsManager.php

+4
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@
2424
* @phpstan-type UiOptions array{
2525
* 'source': ?string,
2626
* 'target': ?string,
27+
* 'ui_launch_mode': ?string,
28+
* 'run_confirmation_modal': bool,
2729
* 'entrypoint_type': string,
2830
* 'constraints': Constraint[],
2931
* 'run': 'null|bool',
@@ -76,6 +78,7 @@ private function resolveUiOptions(array $options): array
7678
'source' => null,
7779
'target' => null,
7880
'entrypoint_type' => 'text',
81+
'ui_launch_mode' => 'modal',
7982
'constraints' => [],
8083
'run' => null,
8184
'default' => function (OptionsResolver $defaultResolver) {
@@ -95,6 +98,7 @@ private function resolveUiOptions(array $options): array
9598
);
9699
$uiResolver->setAllowedValues('entrypoint_type', ['text', 'file']);
97100
$uiResolver->setNormalizer('constraints', fn (Options $options, array $values): array => (new ConstraintLoader())->buildConstraints($values));
101+
$uiResolver->setAllowedValues('ui_launch_mode', ['modal', null, 'form']);
98102
});
99103
/**
100104
* @var array{'ui': UiOptions} $options

‎src/Twig/Components/BootstrapModal.php

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the CleverAge/UiProcessBundle package.
5+
*
6+
* Copyright (c) Clever-Age
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace CleverAge\UiProcessBundle\Twig\Components;
13+
14+
class BootstrapModal
15+
{
16+
public ?string $id = null;
17+
public ?string $title = null;
18+
public ?string $message = null;
19+
public ?string $confirmUrl = null;
20+
}

‎src/Twig/Extension/ProcessExtension.php

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
/*
6+
* This file is part of the CleverAge/UiProcessBundle package.
7+
*
8+
* Copyright (c) Clever-Age
9+
*
10+
* For the full copyright and license information, please view the LICENSE
11+
* file that was distributed with this source code.
12+
*/
13+
14+
namespace CleverAge\UiProcessBundle\Twig\Extension;
15+
16+
use CleverAge\UiProcessBundle\Twig\Runtime\ProcessExtensionRuntime;
17+
use Twig\Extension\AbstractExtension;
18+
use Twig\TwigFunction;
19+
20+
class ProcessExtension extends AbstractExtension
21+
{
22+
public function getFunctions(): array
23+
{
24+
return [
25+
new TwigFunction(
26+
'resolve_ui_options',
27+
[ProcessExtensionRuntime::class, 'getUiOptions']
28+
),
29+
];
30+
}
31+
}

‎src/Twig/Runtime/ProcessExtensionRuntime.php

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the CleverAge/UiProcessBundle package.
5+
*
6+
* Copyright (c) Clever-Age
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace CleverAge\UiProcessBundle\Twig\Runtime;
13+
14+
use CleverAge\UiProcessBundle\Manager\ProcessConfigurationsManager;
15+
use Twig\Extension\RuntimeExtensionInterface;
16+
17+
/**
18+
* @phpstan-import-type UiOptions from ProcessConfigurationsManager
19+
*/
20+
class ProcessExtensionRuntime implements RuntimeExtensionInterface
21+
{
22+
public function __construct(protected ProcessConfigurationsManager $processConfigurationsManager)
23+
{
24+
}
25+
26+
/**
27+
* @return UiOptions|array{}
28+
*/
29+
public function getUiOptions(string $code): array
30+
{
31+
return $this->processConfigurationsManager->getUiOptions($code) ?? [];
32+
}
33+
}

‎templates/admin/field/report.html.twig

+1-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,5 @@
22
{# @var field \EasyCorp\Bundle\EasyAdminBundle\Dto\FieldDto #}
33
{# @var entity \EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto #}
44
<ul>
5-
{% for key, item in field.value %}
6-
<li class="list-group-item"><span class="badge badge-{{ log_css_class(key) }}">{{ key }}</span> : {{ item }}</li>
7-
{% endfor %}
5+
{{ field.value }}
86
</ul>

‎templates/admin/process/list.html.twig

+16-3
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
{# @var process \CleverAge\ProcessBundle\Configuration\ProcessConfiguration #}
2222
{% for process in processes %}
2323
{% set lastExecution = get_last_execution_date(process.code) %}
24+
{% set uiOptions = resolve_ui_options(process.code) %}
2425
{% set statusClass = '' %}
2526
{% if lastExecution is not null %}
2627
{% set statusClass = lastExecution.status.value == 'failed' ? 'danger' : 'success' %}
@@ -32,9 +33,15 @@
3233
<td>{% if process.options.ui.source is defined %}{{ process.options.ui.source }}{% endif %}</td>
3334
<td>{% if process.options.ui.target is defined %}{{ process.options.ui.target }}{% endif %}</td>
3435
<td class="text-center">
35-
<a class="px-1" data-toggle="tooltip" data-placement="top" title="{{ 'Launch'|trans }}" href="{{ url('process', {routeName: 'process_launch', process: process.code}) }}">
36-
<i class="fas fa-rocket"></i>
37-
</a>
36+
{% if ('modal' == uiOptions.ui_launch_mode) %}
37+
<a class="px-1" data-toggle="tooltip" data-placement="top" title="{{ 'Launch'|trans }}" data-bs-toggle="modal" data-bs-target="#{{ process.code }}">
38+
<i class="fas fa-rocket"></i>
39+
</a>
40+
{% else %}
41+
<a class="px-1" data-toggle="tooltip" data-placement="top" title="{{ 'Launch'|trans }}" href="{{ url('process', {routeName: 'process_launch', process: process.code}) }}">
42+
<i class="fas fa-rocket"></i>
43+
</a>
44+
{% endif %}
3845
<a
3946
class="px-1"
4047
data-toggle="tooltip"
@@ -58,6 +65,12 @@
5865
</a>
5966
</td>
6067
</tr>
68+
<twig:ui:BootstrapModal
69+
id="{{ process.code }}"
70+
title="{{ 'Run process'|trans }} {{ process.code }}"
71+
message="{{ 'Do you really want to run process %process% in background'|trans({'%process%': process.code}) }} ?"
72+
confirmUrl="{{ url('process', {routeName: 'process_launch', process: process.code}) }}"
73+
/>
6174
{% endfor %}
6275
{% endblock %}
6376
</tbody>

‎templates/components/BootstrapModal.html.twig

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<div {{ attributes.defaults({
2+
class: 'modal fade',
3+
tabindex: '-1',
4+
'aria-hidden': 'true',
5+
id: id ? id : false,
6+
}) }}
7+
data-controller="bootstrap-modal"
8+
>
9+
<div class="modal-dialog">
10+
<div class="modal-content">
11+
{% block modal_full_content %}
12+
{% if block('modal_header') %}
13+
<div class="modal-header text-center">
14+
{% block modal_header %}
15+
<h5>{{ title }}</h5>
16+
{% endblock %}
17+
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
18+
</div>
19+
{% endif %}
20+
21+
<div class="modal-body">
22+
{% block modal_body %}{{ message }}{% endblock %}
23+
</div>
24+
25+
{% if block('modal_footer') %}
26+
<div class="modal-footer">
27+
{% block modal_footer %}
28+
{% if null != confirmUrl %}
29+
<a href="{{ confirmUrl }}"><button type="button" class="btn btn-primary">{{ 'Confirm'|trans }}</button></a>
30+
{% endif %}
31+
{% endblock %}
32+
</div>
33+
{% endif %}
34+
{% endblock %}
35+
</div>
36+
</div>
37+
</div>

0 commit comments

Comments
 (0)