-
Notifications
You must be signed in to change notification settings - Fork 2
/
TaskQueueService.php
319 lines (298 loc) · 9.87 KB
/
TaskQueueService.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
<?php
namespace Webdevvie\PheanstalkTaskQueueBundle\Service;
use JMS\Serializer\Exception\UnsupportedFormatException;
use JMS\Serializer\Serializer;
use Webdevvie\PheanstalkTaskQueueBundle\Service\DTO\WorkPackage;
use Webdevvie\PheanstalkTaskQueueBundle\TaskDescription\TaskDescriptionInterface;
use Webdevvie\PheanstalkTaskQueueBundle\Service\Exception\TaskQueueServiceException;
use Doctrine\ORM\EntityManager;
use Webdevvie\PheanstalkTaskQueueBundle\Entity\Task;
use Webdevvie\PheanstalkTaskQueueBundle\Entity\TaskRepository;
use Webdevvie\PheanstalkTaskQueueBundle\Service\PheanstalkConnection;
/**
* Handles all communication with Beanstalkd queue and the task entity
* This service is where you send your TaskDescriptions to be offloaded to the back end.
* This service also is the contact point for workers to get new tasks or send back the task's status
*
* @author John Bakker <me@johnbakker.name>
*/
class TaskQueueService
{
/**
* @var PheanstalkConnection
*/
private $beanstalk;
/**
* @var \JMS\Serializer\Serializer
*/
private $serializer;
/**
* contains the default tube to use
* @var string
*/
private $defaultTube;
/**
* Log the worker output on success
*
* @var boolean
*/
private $logWorkerOutputOnSuccess;
/**
* Log the worker output on failure
*
* @var boolean
*/
private $logWorkerOutputOnFailure;
/**
* @var \Doctrine\ORM\EntityManager
*/
private $entityManager;
/**
* @var \Webdevvie\PheanstalkTaskQueueBundle\Entity\TaskRepository
*/
private $taskRepo;
/**
* @param EntityManager $entityManager
* @param PheanstalkConnection $beanstalk
* @param Serializer $serializer
* @param array $params
*/
public function __construct(
\Doctrine\ORM\EntityManager $entityManager,
PheanstalkConnection $beanstalk,
\JMS\Serializer\Serializer $serializer,
array $params
) {
$this->beanstalk = $beanstalk;
$this->serializer = $serializer;
$this->entityManager = $entityManager;
$this->taskRepo = $this->entityManager->getRepository('WebdevviePheanstalkTaskQueueBundle:Task');
$this->defaultTube = $params['default_tube'];
$this->logWorkerOutputOnSuccess = $params['log_worker_output_on_success'];
$this->logWorkerOutputOnFailure = $params['log_worker_output_on_failure'];
}
/**
* Returns the default tube name
*
* @return string
*/
public function getDefaultTube()
{
return $this->defaultTube;
}
/**
* Returns the current status of a task
*
* @param integer $taskId
* @return string
*/
public function getStatusOfTaskWithId($taskId)
{
$task = $this->taskRepo->find($taskId);
if (!($task instanceof Task)) {
//the task was not found
return Task::STATUS_GONE;
}
return $task->getStatus();
}
/**
* @param TaskDescriptionInterface $task
* @param string $tube (optional) the tube to use
* @throws TaskQueueServiceException
* @return integer
*/
public function queueTask(TaskDescriptionInterface $task, $tube = null)
{
if (is_null($tube)) {
$tube = $this->defaultTube;
}
$stringVersion = get_class($task) . '::' . $this->serializer->serialize($task, 'json');
$taskEntity = new Task($task, $stringVersion, $tube);
$this->entityManager->persist($taskEntity);
$this->entityManager->flush($taskEntity);
$task->setTaskIdentifier($taskEntity->getId());
//regenerate it now we have an identifier
$stringVersion = get_class($task) . '::' . $this->serializer->serialize($task, 'json');
$this->beanstalk
->useTube($tube)
->put($stringVersion);
return $taskEntity->getId();
}
/**
* Regenerates a task (requeues it in the proper tube)
*
* @param integer $id
* @return boolean
* @throws TaskQueueServiceException
*/
public function regenerateTask($id)
{
$taskEntity = $this->taskRepo->find($id);
if (!($taskEntity instanceof Task)) {
throw new TaskQueueServiceException("No such task :" . $id, 1);
}
if ($taskEntity->getStatus() != Task::STATUS_FAILED) {
throw new TaskQueueServiceException(
"Invalid status for task. Current status: '" .
$taskEntity->getStatus() .
"' must be 'failed' to be able to restart it",
1
);
}
$data = $taskEntity->getData();
$taskEntity->setStatus(Task::STATUS_RESTARTED);
$this->entityManager->flush();
$parts = explode("::", $data, 2);
$taskObject = $this->serializer->deserialize($parts[1], $parts[0], 'json');
$taskObject->setTaskIdentifier($taskEntity->getId());
$data = get_class($taskObject) . '::' . $this->serializer->serialize($taskObject, 'json');
$this->beanstalk
->useTube($taskEntity->getTube())
->put($data);
return true;
}
/**
* Cleans up tasks that are marked as done
*
* @param integer $timePeriod
* @return void
*/
public function cleanUpTasks($timePeriod)
{
$query = $this->entityManager->createQuery(
'DELETE
FROM WebdevviePheanstalkTaskQueueBundle:Task t
WHERE
t.status = :status and
t.created <= :older'
);
$query->setParameter('status', array(Task::STATUS_DONE));
$query->setParameter('older', date("Y-m-d H:i:s", time() - $timePeriod));
$query->execute();
}
/**
* Returns a task to work on.
*
* @param string $tube (optional) the tube(queue) to reserve a task from
*
* @throws TaskQueueServiceException
* @return WorkPackage
*/
public function reserveTask($tube = null)
{
if (is_null($tube)) {
$tube = $this->defaultTube;
}
$inTask = $this->beanstalk
->watch($tube)
->ignore('default')
->reserve(2);
if ($inTask === false) {
return null;
}
$data = $inTask->getData();
$parts = explode("::", $data, 2);
if (count($parts) !== 2) {
$this->beanstalk->delete($inTask);
throw new TaskQueueServiceException("Invalid format in TaskQueue {$tube}");
}
try {
$taskObject = $this->serializer->deserialize($parts[1], $parts[0], 'json');
} catch (UnsupportedFormatException $exception) {
$this->beanstalk->delete($inTask);
throw new TaskQueueServiceException("Invalid format in TaskQueue {$tube} ");
} catch (\ReflectionException $exception) {
$this->beanstalk->delete($inTask);
throw new TaskQueueServiceException(
"Invalid format in TaskQueue {$tube} class " . $parts[0] . ' is unknown'
);
}
if (!($taskObject instanceof TaskDescriptionInterface)) {
$this->beanstalk->delete($inTask);
throw new TaskQueueServiceException("Invalid data in TaskQueue {$tube}");
}
$taskEntity = $this->taskRepo->find($taskObject->getTaskIdentifier());
if (!($taskEntity instanceof Task)) {
$this->beanstalk->delete($inTask);
throw new TaskQueueServiceException(
"Unable to find taskEntity for task:" . $taskObject->getTaskIdentifier()
);
}
/**
* @var Task $taskEntity
*/
$workPackage = new WorkPackage($taskEntity, $inTask, $taskObject);
$this->updateTaskStatus($workPackage, Task::STATUS_WORKING);
return $workPackage;
}
/**
* Deletes a task from the queue
*
* @param WorkPackage $task
* @param string $log
* @throws TaskQueueServiceException
* @return void
*/
public function markDone(WorkPackage $task, $log)
{
if ($this->logWorkerOutputOnSuccess) {
$this->updateTaskLog($task, $log);
}
$this->updateTaskStatus($task, Task::STATUS_DONE);
$this->beanstalk->delete($task->getPheanstalkJob());
}
/**
* Marks a job as failed and deletes it from the beanstalk tube
*
* @param WorkPackage $task
* @param string $log
* @throws TaskQueueServiceException
* @return void
*/
public function markFailed(WorkPackage $task, $log)
{
if ($this->logWorkerOutputOnFailure) {
$this->updateTaskLog($task, $log);
}
$this->updateTaskStatus($task, Task::STATUS_FAILED);
$this->beanstalk->delete($task->getPheanstalkJob());
}
/**
* Writes the log to the Task entity
*
* @param WorkPackage $task
* @param string $log
* @return void
* @throws TaskQueueServiceException
*/
private function updateTaskLog(WorkPackage $task, $log)
{
$taskEntity = $task->getTaskEntity();
if ($taskEntity instanceof Task) {
$taskEntity->setLog($log);
//make sure it is stored...
$this->entityManager->flush($taskEntity);
} else {
throw new TaskQueueServiceException("Entity is not of type Task");
}
}
/**
* Updates the task status
*
* @param WorkPackage $task
* @param string $status
* @return void
* @throws TaskQueueServiceException
*/
private function updateTaskStatus(WorkPackage $task, $status)
{
$taskEntity = $task->getTaskEntity();
if ($taskEntity instanceof Task) {
$taskEntity->setStatus($status);
//make sure it is stored...
$this->entityManager->flush($taskEntity);
} else {
throw new TaskQueueServiceException("Entity is not of type Task");
}
}
}