Skip to content
Open
31 changes: 12 additions & 19 deletions ProcessMaker/Models/ProcessRequestToken.php
Original file line number Diff line number Diff line change
Expand Up @@ -819,7 +819,11 @@ public function valueAliasStatus($value, $expression, $callback = null, User $us
} elseif ($user) {
$query->whereIn('process_request_tokens.id', $user->availableSelfServiceTasksQuery());
} else {
$query->where('process_request_tokens.is_self_service', 1);
$query->where([
'process_request_tokens.is_self_service' => 1,
'process_request_tokens.status' => 'ACTIVE',
'process_request_tokens.user_id' => null,
]);
}
} elseif (array_key_exists($value, $statusMap)) {
$query->where('process_request_tokens.is_self_service', 0);
Expand Down Expand Up @@ -1726,24 +1730,13 @@ public static function scopeWhereUserAssigned($query, $userId)
$userColumn = 'user_id';
$query->where(function ($query) use ($userColumn, $userId) {
$query->where($userColumn, $userId);
$query->orWhere(function ($query) use ($userColumn, $userId) {
$query->whereNull($userColumn);
$query->where('process_request_tokens.is_self_service', 1);
$user = User::find($userId);
$query->where(function ($query) use ($user) {
foreach ($user->groups as $group) {
$query->orWhereJsonContains(
'process_request_tokens.self_service_groups', strval($group->getKey())
); // backwards compatibility
$query->orWhereJsonContains(
'process_request_tokens.self_service_groups->groups', strval($group->getKey())
);
}
$query->orWhereJsonContains(
'process_request_tokens.self_service_groups->users', strval($user->getKey())
);
});
});
$user = User::find($userId);
if ($user) {
$query->orWhereIn(
'process_request_tokens.id',
$user->availableSelfServiceTasksQuery()
);
}
});

return $query;
Expand Down
25 changes: 7 additions & 18 deletions ProcessMaker/Traits/TaskControllerIndexMethods.php
Original file line number Diff line number Diff line change
Expand Up @@ -286,24 +286,13 @@ private function applyUserIdFilter($query, $column, $filterByFields, $fieldFilte
$query->where(function ($query) use ($key, $column, $fieldFilter) {
$userColumn = is_string($key) ? $key : $column;
$query->where($userColumn, $fieldFilter);
$query->orWhere(function ($query) use ($userColumn, $fieldFilter) {
$query->whereNull($userColumn);
$query->where('process_request_tokens.is_self_service', 1);
$user = User::find($fieldFilter);
$query->where(function ($query) use ($user) {
foreach ($user->groups as $group) {
$query->orWhereJsonContains(
'process_request_tokens.self_service_groups', strval($group->getKey())
); // backwards compatibility
$query->orWhereJsonContains(
'process_request_tokens.self_service_groups->groups', strval($group->getKey())
);
}
$query->orWhereJsonContains(
'process_request_tokens.self_service_groups->users', strval($user->getKey())
);
});
});
$user = User::find($fieldFilter);
if ($user) {
$query->orWhereIn(
'process_request_tokens.id',
$user->availableSelfServiceTasksQuery()
);
}
});
}

Expand Down
135 changes: 135 additions & 0 deletions tests/Feature/Api/BoundaryEventsTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -444,4 +444,139 @@ public function testTimerBoundaryEventMultiInstance()
$this->assertCount(1, $activeTokens);
$this->assertEquals('Task 2', $activeTokens[0]->element_name);
}

/**
* Tests that an interrupting timer boundary event closes an unclaimed self-service task
* without changing its assignment state
*
* @group timer_events
*/
public function testTimerBoundaryEventClosesSelfServiceTask()
{
$now = TaskSchedulerManager::fakeToday('2018-05-01T00:00:00Z');
$process = $this->createSelfServiceTimerProcess(true);

$instance = $this->startProcess($process, 'node_1');

$selfServiceToken = $instance->tokens()->where('element_id', 'node_2')->firstOrFail();
$this->assertEquals('ACTIVE', $selfServiceToken->status);
$this->assertEquals(1, $selfServiceToken->is_self_service);
$this->assertNull($selfServiceToken->user_id);
$this->assertContains(
$selfServiceToken->id,
$this->taskIdsForPmql($instance, 'status = "Self Service"')
);

$now->modify('+1 minute');
TaskSchedulerManager::fakeToday($now);
$this->runScheduledTasks();

$selfServiceToken->refresh();
$this->assertEquals('CLOSED', $selfServiceToken->status);
$this->assertEquals(1, $selfServiceToken->is_self_service);
$this->assertNull($selfServiceToken->user_id);
$this->assertNull($selfServiceToken->completed_at);
$this->assertEquals('COMPLETED', $instance->refresh()->status);
$this->assertNotContains(
$selfServiceToken->id,
$this->taskIdsForPmql($instance, 'status = "Self Service"')
);
$this->assertContains(
$selfServiceToken->id,
$this->taskIdsForPmql($instance, 'is_self_service = 1')
);
}

/**
* Tests that a closed self-service task is excluded before the request completes
*
* @group timer_events
*/
public function testTimerBoundaryEventExcludesClosedSelfServiceTaskWhileRequestContinues()
{
$now = TaskSchedulerManager::fakeToday('2018-05-01T00:00:00Z');
$process = $this->createSelfServiceTimerProcess(true, true);

$instance = $this->startProcess($process, 'node_1');

$now->modify('+1 minute');
TaskSchedulerManager::fakeToday($now);
$this->runScheduledTasks();

$selfServiceToken = $instance->tokens()->where('element_id', 'node_2')->firstOrFail();
$this->assertEquals('CLOSED', $selfServiceToken->status);
$this->assertEquals(1, $selfServiceToken->is_self_service);
$this->assertNull($selfServiceToken->user_id);
$this->assertEquals('ACTIVE', $instance->refresh()->status);
$this->assertTrue(
$instance->tokens()->where('element_id', 'node_7')->where('status', 'ACTIVE')->exists()
);
$this->assertNotContains(
$selfServiceToken->id,
$this->taskIdsForPmql($instance, 'status = "Self Service"')
);
$this->assertContains(
$selfServiceToken->id,
$this->taskIdsForPmql($instance, 'is_self_service = 1')
);
}

/**
* Tests that a non-interrupting timer boundary event keeps the self-service task open
*
* @group timer_events
*/
public function testNonInterruptingTimerBoundaryEventKeepsSelfServiceTaskOpen()
{
$now = TaskSchedulerManager::fakeToday('2018-05-01T00:00:00Z');
$process = $this->createSelfServiceTimerProcess(false);

$instance = $this->startProcess($process, 'node_1');

$now->modify('+1 minute');
TaskSchedulerManager::fakeToday($now);
$this->runScheduledTasks();

$selfServiceToken = $instance->tokens()->where('element_id', 'node_2')->firstOrFail();
$this->assertEquals('ACTIVE', $selfServiceToken->status);
$this->assertEquals(1, $selfServiceToken->is_self_service);
$this->assertNull($selfServiceToken->user_id);
$this->assertContains(
$selfServiceToken->id,
$this->taskIdsForPmql($instance, 'status = "Self Service"')
);
}

private function createSelfServiceTimerProcess(bool $cancelActivity, bool $continueAfterBoundary = false)
{
$bpmn = file_get_contents(__DIR__ . '/processes/Timer_BoundaryEvent_SelfService.bpmn');
$bpmn = str_replace('{selfServiceUserId}', $this->user->id, $bpmn);
if (!$cancelActivity) {
$bpmn = str_replace('cancelActivity="true"', 'cancelActivity="false"', $bpmn);
}
if ($continueAfterBoundary) {
$bpmn = str_replace(
'<bpmn:endEvent id="node_7" name="Timer End Event">' . PHP_EOL
. ' <bpmn:incoming>node_8</bpmn:incoming>' . PHP_EOL
. ' </bpmn:endEvent>',
'<bpmn:task id="node_7" name="After Timer" pm:assignment="requester">' . PHP_EOL
. ' <bpmn:incoming>node_8</bpmn:incoming>' . PHP_EOL
. ' </bpmn:task>',
$bpmn
);
}

return $this->createProcess($bpmn);
}

private function taskIdsForPmql(ProcessRequest $instance, string $pmql): array
{
$response = $this->apiCall('GET', route('api.tasks.index', [
'process_request_id' => $instance->id,
'pmql' => $pmql,
]));
$response->assertStatus(200);

return array_column($response->json('data'), 'id');
}
}
52 changes: 52 additions & 0 deletions tests/Feature/Api/TasksTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,58 @@ public function testGetListAssignedTasks()
$this->assertEquals(2, count($response->json()['data']));
}

public function testUserFilterIncludesOnlyActiveSelfServiceTasksAndPreservesAssignedHistory()
{
$eligibleUser = User::factory()->create();
$request = ProcessRequest::factory()->create();
$selfServiceGroups = ['users' => [(string) $eligibleUser->id], 'groups' => []];

$activeSelfService = ProcessRequestToken::factory()->create([
'process_id' => $request->process_id,
'process_request_id' => $request->id,
'element_type' => 'task',
'status' => 'ACTIVE',
'user_id' => null,
'is_self_service' => 1,
'self_service_groups' => $selfServiceGroups,
]);
$closedSelfService = ProcessRequestToken::factory()->create([
'process_id' => $request->process_id,
'process_request_id' => $request->id,
'element_type' => 'task',
'status' => 'CLOSED',
'user_id' => null,
'is_self_service' => 1,
'self_service_groups' => $selfServiceGroups,
]);
$assignedClosedTask = ProcessRequestToken::factory()->create([
'process_id' => $request->process_id,
'process_request_id' => $request->id,
'element_type' => 'task',
'status' => 'CLOSED',
'user_id' => $eligibleUser->id,
'is_self_service' => 0,
]);

$scopeQuery = ProcessRequestToken::query();
ProcessRequestToken::scopeWhereUserAssigned($scopeQuery, $eligibleUser->id);
$scopeIds = $scopeQuery->pluck('id')->all();
$this->assertContains($activeSelfService->id, $scopeIds);
$this->assertNotContains($closedSelfService->id, $scopeIds);
$this->assertContains($assignedClosedTask->id, $scopeIds);

$response = $this->apiCall('GET', route('api.' . $this->resource . '.index', [
'user_id' => $eligibleUser->id,
'per_page' => 100,
]));
$response->assertStatus(200);

$taskIds = array_column($response->json('data'), 'id');
$this->assertContains($activeSelfService->id, $taskIds);
$this->assertNotContains($closedSelfService->id, $taskIds);
$this->assertContains($assignedClosedTask->id, $taskIds);
}

/**
* Return all tasks if we are only requesting closed tasks and if
* the user can view the request.
Expand Down
58 changes: 58 additions & 0 deletions tests/Feature/Api/processes/Timer_BoundaryEvent_SelfService.bpmn
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
<?xml version="1.0" encoding="UTF-8"?>
<bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" xmlns:pm="http://processmaker.com/BPMN/2.0/Schema.xsd" targetNamespace="http://bpmn.io/schema/bpmn" exporter="ProcessMaker Modeler" exporterVersion="1.0">
<bpmn:process id="ProcessId" name="ProcessName" isExecutable="true">
<bpmn:startEvent id="node_1" name="Start Event">
<bpmn:outgoing>node_4</bpmn:outgoing>
</bpmn:startEvent>
<bpmn:task id="node_2" name="Self Service Task" pm:assignment="user_group" pm:assignedUsers="{selfServiceUserId}" pm:assignedGroups="" pm:config="{&#34;selfService&#34;:true}">
<bpmn:incoming>node_4</bpmn:incoming>
<bpmn:outgoing>node_5</bpmn:outgoing>
</bpmn:task>
<bpmn:endEvent id="node_3" name="End Event">
<bpmn:incoming>node_5</bpmn:incoming>
</bpmn:endEvent>
<bpmn:boundaryEvent id="node_6" name="Boundary Timer Event" attachedToRef="node_2" cancelActivity="true">
<bpmn:outgoing>node_8</bpmn:outgoing>
<bpmn:timerEventDefinition id="node_6_timer_event_definition">
<bpmn:timeCycle>R4/2018-05-01T00:00:00Z/PT1M</bpmn:timeCycle>
</bpmn:timerEventDefinition>
</bpmn:boundaryEvent>
<bpmn:endEvent id="node_7" name="Timer End Event">
<bpmn:incoming>node_8</bpmn:incoming>
</bpmn:endEvent>
<bpmn:sequenceFlow id="node_4" sourceRef="node_1" targetRef="node_2" />
<bpmn:sequenceFlow id="node_5" sourceRef="node_2" targetRef="node_3" />
<bpmn:sequenceFlow id="node_8" sourceRef="node_6" targetRef="node_7" />
</bpmn:process>
<bpmndi:BPMNDiagram id="BPMNDiagramId">
<bpmndi:BPMNPlane id="BPMNPlaneId" bpmnElement="ProcessId">
<bpmndi:BPMNShape id="node_1_di" bpmnElement="node_1">
<dc:Bounds x="360" y="248.5" width="36" height="36" />
</bpmndi:BPMNShape>
<bpmndi:BPMNShape id="node_2_di" bpmnElement="node_2">
<dc:Bounds x="460" y="228.5" width="116" height="76" />
</bpmndi:BPMNShape>
<bpmndi:BPMNShape id="node_3_di" bpmnElement="node_3">
<dc:Bounds x="640" y="248.5" width="36" height="36" />
</bpmndi:BPMNShape>
<bpmndi:BPMNShape id="node_6_di" bpmnElement="node_6">
<dc:Bounds x="500" y="286.5" width="36" height="36" />
</bpmndi:BPMNShape>
<bpmndi:BPMNShape id="node_7_di" bpmnElement="node_7">
<dc:Bounds x="500" y="387" width="36" height="36" />
</bpmndi:BPMNShape>
<bpmndi:BPMNEdge id="node_4_di" bpmnElement="node_4">
<di:waypoint x="396" y="266.5" />
<di:waypoint x="460" y="266.5" />
</bpmndi:BPMNEdge>
<bpmndi:BPMNEdge id="node_5_di" bpmnElement="node_5">
<di:waypoint x="576" y="266.5" />
<di:waypoint x="640" y="266.5" />
</bpmndi:BPMNEdge>
<bpmndi:BPMNEdge id="node_8_di" bpmnElement="node_8">
<di:waypoint x="518" y="322.5" />
<di:waypoint x="518" y="387" />
</bpmndi:BPMNEdge>
</bpmndi:BPMNPlane>
</bpmndi:BPMNDiagram>
</bpmn:definitions>
17 changes: 17 additions & 0 deletions tests/unit/ProcessMaker/FilterTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,23 @@ public function testTaskStatusSelfservice()
$this->assertStringContainsString('json_contains(`self_service_groups`', $sql);
}

public function testTaskStatusSelfServiceWithoutAuthenticatedUserRequiresActiveUnassignedTask()
{
Auth::shouldReceive('user')->andReturn(null);

$sql = $this->filter([
[
'subject' => ['type' => 'Status'],
'operator' => '=',
'value' => 'Self Service',
],
], ProcessRequestToken::class);

$this->assertStringContainsString('`process_request_tokens`.`is_self_service` = 1', $sql);
$this->assertStringContainsString("`process_request_tokens`.`status` = 'ACTIVE'", $sql);
$this->assertStringContainsString('`process_request_tokens`.`user_id` is null', $sql);
}

public function testTaskStatusActive()
{
$user = User::factory()->create();
Expand Down
Loading