Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FOUR-17581 Fix Processes that are started with another thread do not display the screen #7267

Merged
merged 9 commits into from
Aug 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions ProcessMaker/Events/RedirectToEvent.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<?php

namespace ProcessMaker\Events;

use Illuminate\Broadcasting\InteractsWithSockets;
use Illuminate\Broadcasting\PrivateChannel;
use Illuminate\Contracts\Broadcasting\ShouldBroadcastNow;
use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;
use ProcessMaker\Models\ProcessRequest;

class RedirectToEvent implements ShouldBroadcastNow
{
use Dispatchable, InteractsWithSockets, SerializesModels;

public $payloadUrl;

/**
* Create a new event instance.
*/
public function __construct(
private ProcessRequest $processRequest,
public string $method,
public array $params
) {
//
}

/**
* Set the event name
*
* @return string
*/
public function broadcastAs()
{
return 'RedirectTo';
}

/**
* Get the channels the event should broadcast on.
*
* @return array<int, \Illuminate\Broadcasting\Channel>
*/
public function broadcastOn(): array
{
return [
new PrivateChannel('ProcessMaker.Models.ProcessRequest.' . $this->processRequest->getKey()),
];
}
}
2 changes: 2 additions & 0 deletions ProcessMaker/Http/Controllers/Api/TaskController.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
use ProcessMaker\Http\Resources\ApiResource;
use ProcessMaker\Http\Resources\Task as Resource;
use ProcessMaker\Http\Resources\TaskCollection;
use ProcessMaker\Listeners\HandleRedirectListener;
use ProcessMaker\Models\Process;
use ProcessMaker\Models\ProcessRequest;
use ProcessMaker\Models\ProcessRequestToken;
Expand Down Expand Up @@ -245,6 +246,7 @@ public function update(Request $request, ProcessRequestToken $task)
$instance = $task->processRequest;
TaskDraft::moveDraftFiles($task);
WorkflowManager::completeTask($process, $instance, $task, $data);
HandleRedirectListener::sendRedirectToEvent();

return new Resource($task->refresh());
} elseif (!empty($request->input('user_id'))) {
Expand Down
3 changes: 3 additions & 0 deletions ProcessMaker/Jobs/BpmnAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use Illuminate\Support\Facades\Log;
use ProcessMaker\BpmnEngine;
use ProcessMaker\Exception\HttpABTestingException;
use ProcessMaker\Listeners\HandleRedirectListener;
use ProcessMaker\Models\Process as Definitions;
use ProcessMaker\Models\ProcessRequest;
use ProcessMaker\Models\ProcessRequestLock;
Expand Down Expand Up @@ -66,6 +67,8 @@ public function handle()

// Run engine to the next state
$this->engine->runToNextState();
// call to redirect when user task is assigned
HandleRedirectListener::sendRedirectToEvent();
} catch (HttpABTestingException $exception) {
Log::error($exception->getMessage());
throw $exception;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<?php

namespace ProcessMaker\Listeners;

use ProcessMaker\Events\ActivityAssigned;

class HandleActivityAssignedInterstitialRedirect extends HandleRedirectListener
{

/**
* Handle the event.
*/
public function handle(ActivityAssigned $event): void
{
$request = $event->getProcessRequestToken()->getInstance();
if (empty($request)) {
return;
}

$allowInterstitial = $event->getProcessRequestToken()->getInterstitial()['allow_interstitial'];
if ($allowInterstitial) {
$payloadUrl = route('tasks.edit', ['task' => $event->getProcessRequestToken()->id]);
} else {
$payloadUrl = route('requests.show', [
'request' => $event->getProcessRequestToken()
->getAttribute('process_request_id')
]);
}
$this->setRedirectTo($request,
'redirectToTask',
[
'payloadUrl' => $payloadUrl,
'tokenId' => $event->getProcessRequestToken()->id,
'allowInterstitial' => $event->getProcessRequestToken()->getInterstitial()['allow_interstitial'],
]
);
}
}
22 changes: 22 additions & 0 deletions ProcessMaker/Listeners/HandleActivityCompletedRedirect.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<?php

namespace ProcessMaker\Listeners;

use ProcessMaker\Events\ActivityCompleted;

class HandleActivityCompletedRedirect extends HandleRedirectListener
{

/**
* Handle the event.
*/
public function handle(ActivityCompleted $event): void
{
$request = $event->getProcessRequestToken()->getInstance();
if (empty($request)) {
return;
}

$this->setRedirectTo($request, 'processUpdated', $event);
}
}
25 changes: 25 additions & 0 deletions ProcessMaker/Listeners/HandleEndEventRedirect.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?php

namespace ProcessMaker\Listeners;

use Illuminate\Support\Facades\Auth;
use ProcessMaker\Events\ProcessCompleted;

class HandleEndEventRedirect extends HandleRedirectListener
{

/**
* Handle the event.
*/
public function handle(ProcessCompleted $event): void
{
$request = $event->getProcessRequest();
if (empty($request)) {
return;
}

$userId = Auth::id();
$requestId = $event->getProcessRequest()->id;
$this->setRedirectTo($request, 'processCompletedRedirect', $event, $userId, $requestId);
}
}
38 changes: 38 additions & 0 deletions ProcessMaker/Listeners/HandleRedirectListener.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<?php

namespace ProcessMaker\Listeners;

use ProcessMaker\Events\RedirectToEvent;
use ProcessMaker\Models\ProcessRequest;

class HandleRedirectListener
{
private static $processRequest = null;

private static $redirectionMethod = '';

private static $redirectionParams = [];

protected function setRedirectTo(ProcessRequest $processRequest, string $method, ...$params): void
{
self::$processRequest = $processRequest;
self::$redirectionMethod = $method;
self::$redirectionParams = $params;
}

public static function sendRedirectToEvent()
{
$method = self::$redirectionMethod;
$params = self::$redirectionParams;
$processRequest = self::$processRequest;

if ($processRequest !== null) {
$event = new RedirectToEvent($processRequest, $method, $params);
event($event);
// clean params to prevent send the same redirect multiple times
self::$redirectionParams = [];
self::$redirectionMethod = '';
self::$processRequest = null;
}
}
}
15 changes: 15 additions & 0 deletions ProcessMaker/Providers/EventServiceProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
namespace ProcessMaker\Providers;

use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
use ProcessMaker\Events\ActivityAssigned;
use ProcessMaker\Events\ActivityCompleted;
use ProcessMaker\Events\ActivityReassignment;
use ProcessMaker\Events\AuthClientCreated;
use ProcessMaker\Events\AuthClientDeleted;
Expand All @@ -25,6 +27,7 @@
use ProcessMaker\Events\GroupUsersUpdated;
use ProcessMaker\Events\PermissionUpdated;
use ProcessMaker\Events\ProcessArchived;
use ProcessMaker\Events\ProcessCompleted;
use ProcessMaker\Events\ProcessCreated;
use ProcessMaker\Events\ProcessPublished;
use ProcessMaker\Events\ProcessRestored;
Expand Down Expand Up @@ -58,6 +61,9 @@
use ProcessMaker\Events\UserGroupMembershipUpdated;
use ProcessMaker\Events\UserRestored;
use ProcessMaker\Events\UserUpdated;
use ProcessMaker\Listeners\HandleActivityAssignedInterstitialRedirect;
use ProcessMaker\Listeners\HandleActivityCompletedRedirect;
use ProcessMaker\Listeners\HandleEndEventRedirect;
use ProcessMaker\Listeners\SecurityLogger;
use ProcessMaker\Listeners\SessionControlSettingsUpdated;

Expand Down Expand Up @@ -91,6 +97,15 @@ class EventServiceProvider extends ServiceProvider
SettingsUpdated::class => [
SessionControlSettingsUpdated::class,
],
ProcessCompleted::class => [
HandleEndEventRedirect::class,
],
ActivityCompleted::class => [
HandleActivityCompletedRedirect::class,
],
ActivityAssigned::class => [
HandleActivityAssignedInterstitialRedirect::class,
],
];

/**
Expand Down
13 changes: 0 additions & 13 deletions resources/views/tasks/edit.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -543,13 +543,6 @@ class="multiselect__tag-icon"></i>
if (this.task.component && this.task.component === 'AdvancedScreenFrame') {
return;
}

if (endEventDestination) {
this.redirect(endEventDestination);
return;
}

this.redirect(`/requests/${processRequestId}`);
},
error(processRequestId) {
this.$refs.task.showSimpleErrorMessage();
Expand All @@ -562,12 +555,6 @@ class="multiselect__tag-icon"></i>
if (this.task.component && this.task.component === 'AdvancedScreenFrame') {
return;
}

if (elementDestination) {
this.redirect(elementDestination);
return;
}

this.redirect("/tasks");
},
claimTask() {
Expand Down
Loading