Skip to content

Commit 65d04d0

Browse files
DaneEverittDaneEveritt
committed
Correctly handle schedule task deletion and avoid errors; closes pterodactyl#2534 
1 parent e1fa6d4 commit 65d04d0

File tree

4 files changed

+128
-5
lines changed

4 files changed

+128
-5
lines changed

‎app/Http/Controllers/Api/Client/Servers/ScheduleTaskController.php‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,8 @@ public function store(StoreTaskRequest $request, Server $server, Schedule $sched
5656
);
5757
}
5858

59-
$lastTask = $schedule->tasks->last();
59+
/** @var \Pterodactyl\Models\Task|null $lastTask */
60+
$lastTask = $schedule->tasks()->orderByDesc('sequence_id')->first();
6061

6162
/** @var \Pterodactyl\Models\Task $task */
6263
$task = $this->repository->create([
@@ -102,13 +103,16 @@ public function update(StoreTaskRequest $request, Server $server, Schedule $sche
102103
}
103104

104105
/**
105-
* Determines if a user can delete the task for a given server.
106+
* Delete a given task for a schedule. If there are subsequent tasks stored in the database
107+
* for this schedule their sequence IDs are decremented properly.
106108
*
107109
* @param \Pterodactyl\Http\Requests\Api\Client\ClientApiRequest $request
108110
* @param \Pterodactyl\Models\Server $server
109111
* @param \Pterodactyl\Models\Schedule $schedule
110112
* @param \Pterodactyl\Models\Task $task
111113
* @return \Illuminate\Http\JsonResponse
114+
*
115+
* @throws \Exception
112116
*/
113117
public function delete(ClientApiRequest $request, Server $server, Schedule $schedule, Task $task)
114118
{
@@ -120,8 +124,12 @@ public function delete(ClientApiRequest $request, Server $server, Schedule $sche
120124
throw new HttpForbiddenException('You do not have permission to perform this action.');
121125
}
122126

123-
$this->repository->delete($task->id);
127+
$schedule->tasks()->where('sequence_id', '>', $task->sequence_id)->update([
128+
'sequence_id' => $schedule->tasks()->getConnection()->raw('(sequence_id - 1)'),
129+
]);
130+
131+
$task->delete();
124132

125-
return JsonResponse::create(null, Response::HTTP_NO_CONTENT);
133+
return new JsonResponse(null, Response::HTTP_NO_CONTENT);
126134
}
127135
}

‎app/Services/Schedules/ProcessScheduleService.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public function __construct(ConnectionInterface $connection, Dispatcher $dispatc
4343
public function handle(Schedule $schedule, bool $now = false)
4444
{
4545
/** @var \Pterodactyl\Models\Task $task */
46-
$task = $schedule->tasks()->where('sequence_id', 1)->first();
46+
$task = $schedule->tasks()->orderBy('sequence_id', 'asc')->first();
4747

4848
if (is_null($task)) {
4949
throw new DisplayException(

‎tests/Integration/Api/Client/Server/ScheduleTask/DeleteScheduleTaskTest.php‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
<?php
2+
3+
namespace Pterodactyl\Tests\Integration\Api\Client\Server\ScheduleTask;
4+
5+
use Pterodactyl\Models\Task;
6+
use Pterodactyl\Models\User;
7+
use Illuminate\Http\Response;
8+
use Pterodactyl\Models\Schedule;
9+
use Pterodactyl\Models\Permission;
10+
use Pterodactyl\Tests\Integration\Api\Client\ClientApiIntegrationTestCase;
11+
12+
class DeleteScheduleTaskTest extends ClientApiIntegrationTestCase
13+
{
14+
/**
15+
* Test that an error is returned if the schedule does not belong to the server.
16+
*/
17+
public function testScheduleNotBelongingToServerReturnsError()
18+
{
19+
$server2 = $this->createServerModel();
20+
[$user] = $this->generateTestAccount();
21+
22+
$schedule = factory(Schedule::class)->create(['server_id' => $server2->id]);
23+
$task = factory(Task::class)->create(['schedule_id' => $schedule->id]);
24+
25+
$this->actingAs($user)->deleteJson($this->link($task))->assertNotFound();
26+
}
27+
28+
/**
29+
* Test that an error is returned if the task and schedule in the URL do not line up
30+
* with eachother.
31+
*/
32+
public function testTaskBelongingToDifferentScheduleReturnsError()
33+
{
34+
[$user, $server] = $this->generateTestAccount();
35+
36+
$schedule = factory(Schedule::class)->create(['server_id' => $server->id]);
37+
$schedule2 = factory(Schedule::class)->create(['server_id' => $server->id]);
38+
$task = factory(Task::class)->create(['schedule_id' => $schedule->id]);
39+
40+
$this->actingAs($user)->deleteJson("/api/client/servers/{$server->uuid}/schedules/{$schedule2->id}/tasks/{$task->id}")->assertNotFound();
41+
}
42+
43+
/**
44+
* Test that a user without the required permissions returns an error.
45+
*/
46+
public function testUserWithoutPermissionReturnsError()
47+
{
48+
[$user, $server] = $this->generateTestAccount([Permission::ACTION_SCHEDULE_CREATE]);
49+
50+
$schedule = factory(Schedule::class)->create(['server_id' => $server->id]);
51+
$task = factory(Task::class)->create(['schedule_id' => $schedule->id]);
52+
53+
$this->actingAs($user)->deleteJson($this->link($task))->assertForbidden();
54+
55+
$user2 = factory(User::class)->create();
56+
57+
$this->actingAs($user2)->deleteJson($this->link($task))->assertNotFound();
58+
}
59+
60+
/**
61+
* Test that a schedule task is deleted and items with a higher sequence ID are decremented
62+
* properly in the database.
63+
*/
64+
public function testScheduleTaskIsDeletedAndSubsequentTasksAreUpdated()
65+
{
66+
[$user, $server] = $this->generateTestAccount();
67+
68+
$schedule = factory(Schedule::class)->create(['server_id' => $server->id]);
69+
$tasks = [
70+
factory(Task::class)->create(['schedule_id' => $schedule->id, 'sequence_id' => 1]),
71+
factory(Task::class)->create(['schedule_id' => $schedule->id, 'sequence_id' => 2]),
72+
factory(Task::class)->create(['schedule_id' => $schedule->id, 'sequence_id' => 3]),
73+
factory(Task::class)->create(['schedule_id' => $schedule->id, 'sequence_id' => 4]),
74+
];
75+
76+
$response = $this->actingAs($user)->deleteJson($this->link($tasks[1]));
77+
$response->assertStatus(Response::HTTP_NO_CONTENT);
78+
79+
$this->assertDatabaseHas('tasks', ['id' => $tasks[0]->id, 'sequence_id' => 1]);
80+
$this->assertDatabaseHas('tasks', ['id' => $tasks[2]->id, 'sequence_id' => 2]);
81+
$this->assertDatabaseHas('tasks', ['id' => $tasks[3]->id, 'sequence_id' => 3]);
82+
$this->assertDatabaseMissing('tasks', ['id' => $tasks[1]->id]);
83+
}
84+
}

‎tests/Integration/Services/Schedules/ProcessScheduleServiceTest.php‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,37 @@ public function testJobCanBeDispatchedWithExpectedInitialDelay($now)
8181
$this->assertDatabaseHas('tasks', ['id' => $task->id, 'is_queued' => true]);
8282
}
8383

84+
/**
85+
* Test that even if a schedule's task sequence gets messed up the first task based on
86+
* the ascending order of tasks is used.
87+
*
88+
* @see https://github.com/pterodactyl/panel/issues/2534
89+
*/
90+
public function testFirstSequenceTaskIsFound()
91+
{
92+
$this->swap(Dispatcher::class, $dispatcher = Mockery::mock(Dispatcher::class));
93+
94+
$server = $this->createServerModel();
95+
/** @var \Pterodactyl\Models\Schedule $schedule */
96+
$schedule = factory(Schedule::class)->create(['server_id' => $server->id]);
97+
98+
/** @var \Pterodactyl\Models\Task $task */
99+
$task2 = factory(Task::class)->create(['schedule_id' => $schedule->id, 'sequence_id' => 4]);
100+
$task = factory(Task::class)->create(['schedule_id' => $schedule->id, 'sequence_id' => 2]);
101+
$task3 = factory(Task::class)->create(['schedule_id' => $schedule->id, 'sequence_id' => 3]);
102+
103+
$dispatcher->expects('dispatch')->with(Mockery::on(function (RunTaskJob $job) use ($task) {
104+
return $task->id === $job->task->id;
105+
}));
106+
107+
$this->getService()->handle($schedule);
108+
109+
$this->assertDatabaseHas('schedules', ['id' => $schedule->id, 'is_processing' => true]);
110+
$this->assertDatabaseHas('tasks', ['id' => $task->id, 'is_queued' => true]);
111+
$this->assertDatabaseHas('tasks', ['id' => $task2->id, 'is_queued' => false]);
112+
$this->assertDatabaseHas('tasks', ['id' => $task3->id, 'is_queued' => false]);
113+
}
114+
84115
/**
85116
* @return array
86117
*/

0 commit comments

Comments
 (0)