-
-
Notifications
You must be signed in to change notification settings - Fork 18
Expand file tree
/
Copy pathScheduler.php
More file actions
444 lines (380 loc) · 10.2 KB
/
Copy pathScheduler.php
File metadata and controls
444 lines (380 loc) · 10.2 KB
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
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
<?php
declare(strict_types=1);
namespace Bow\Scheduler;
use DateTime;
use Throwable;
use Bow\Cache\Cache;
use Bow\Queue\QueueTask;
use Bow\Scheduler\Exceptions\SchedulerException;
/**
* Class Scheduler
*
* Simplified scheduler that provides four main methods:
* - command(): Run Bow console commands
* - task(): Run QueueTask classes
* - exec(): Run bash/shell commands
* - call(): Run closures/callbacks
*
* @package Bow\Scheduler
*/
class Scheduler
{
/**
* The Scheduler instance
*
* @var ?Scheduler
*/
private static ?Scheduler $instance = null;
/**
* The registered scheduled events
*
* @var array<ScheduledEvent>
*/
private array $events = [];
/**
* The cache adapter for mutex locks
*
* @var ?Cache
*/
private ?Cache $cache = null;
/**
* Whether logging is enabled
*
* @var bool
*/
private bool $loggingEnabled = true;
/**
* The custom logger callback
*
* @var ?callable
*/
private $logger = null;
/**
* Scheduler constructor
*
* @return void
* @throws \Exception
*/
public function __construct()
{
if (static::$instance !== null) {
throw new \Exception(
"The Scheduler class is a singleton and already instantiated. " .
"Please use Scheduler::getInstance() to get the instance."
);
}
}
/**
* Get the Scheduler instance
*
* @return Scheduler
*/
public static function getInstance(): Scheduler
{
if (static::$instance === null) {
static::$instance = new Scheduler();
}
return static::$instance;
}
/**
* Set the cache adapter for mutex locks
*
* @param Cache $cache
* @return $this
*/
public function setCache(Cache $cache): static
{
$this->cache = $cache;
return $this;
}
/**
* Set a custom logger callback
*
* @param callable $logger
* @return $this
*/
public function setLogger(callable $logger): static
{
$this->logger = $logger;
return $this;
}
/**
* Enable or disable logging
*
* @param bool $enabled
* @return $this
*/
public function enableLogging(bool $enabled = true): static
{
$this->loggingEnabled = $enabled;
return $this;
}
/**
* Schedule a Bow console command
*
* @param string $command The Bow command (e.g., "migration:migrate", "clear:cache")
* @param array $parameters Optional parameters for the command
* @return Schedule
*/
public function command(string $command, array $parameters = []): Schedule
{
$event = new ScheduledEvent(
ScheduledEvent::TYPE_COMMAND,
$command,
$parameters
);
$this->events[] = $event;
return $event->getSchedule();
}
/**
* Schedule a QueueTask for execution
*
* @param string|QueueTask $task The QueueTask class name or instance
* @param array $parameters Parameters for instantiation (if class name provided)
* @return Schedule
*/
public function task(string|QueueTask $task, array $parameters = []): Schedule
{
$event = new ScheduledEvent(
ScheduledEvent::TYPE_TASK,
$task,
$parameters
);
$this->events[] = $event;
return $event->getSchedule();
}
/**
* Schedule a shell/bash command
*
* @param string $command The shell command to execute
* @param array $parameters Optional arguments for the command
* @return Schedule
*/
public function exec(string $command, array $parameters = []): Schedule
{
$event = new ScheduledEvent(
ScheduledEvent::TYPE_EXEC,
$command,
$parameters
);
$this->events[] = $event;
return $event->getSchedule();
}
/**
* Schedule a callback/closure for execution
*
* @param callable $callback The callback to execute
* @param array $parameters Optional parameters to pass to the callback
* @return Schedule
*/
public function call(callable $callback, array $parameters = []): Schedule
{
$event = new ScheduledEvent(
ScheduledEvent::TYPE_CALL,
$callback,
$parameters
);
$this->events[] = $event;
return $event->getSchedule();
}
/**
* Get all registered events
*
* @return array<ScheduledEvent>
*/
public function getEvents(): array
{
return $this->events;
}
/**
* Get all due events
*
* @param ?DateTime $currentTime
* @return array<ScheduledEvent>
*/
public function getDueEvents(?DateTime $currentTime = null): array
{
$currentTime = $currentTime ?? new DateTime();
return array_filter(
$this->events,
fn(ScheduledEvent $event) => $event->isDue($currentTime)
);
}
/**
* Run all due events
*
* @param ?DateTime $currentTime
* @return array
*/
public function run(?DateTime $currentTime = null): array
{
$currentTime = $currentTime ?? new DateTime();
$dueEvents = $this->getDueEvents($currentTime);
$results = [];
foreach ($dueEvents as $event) {
$results[] = $this->runEvent($event);
}
return $results;
}
/**
* Run a single event
*
* @param ScheduledEvent $event
* @return array
*/
protected function runEvent(ScheduledEvent $event): array
{
$result = [
'type' => $event->getType(),
'description' => $event->getDescription(),
'status' => 'success',
'started_at' => new DateTime(),
'finished_at' => null,
'error' => null,
];
try {
// Check for overlapping prevention
if ($event->getSchedule()->shouldPreventOverlapping()) {
if (!$this->acquireLock($event)) {
$result['status'] = 'skipped';
$result['error'] = 'Event is already running (overlap prevention)';
$this->log("Skipping event [{$event->getDescription()}]: already running");
return $result;
}
}
$this->log("Running event: {$event->getDescription()}");
// Run before callback
$event->runBeforeCallback();
// Run the event
$event->run();
// Run after callback
$event->runAfterCallback();
$result['finished_at'] = new DateTime();
$this->log("Completed event: {$event->getDescription()}");
} catch (Throwable $e) {
$result['status'] = 'failed';
$result['error'] = $e->getMessage();
$result['finished_at'] = new DateTime();
// Run failed callback
$event->runFailedCallback($e);
$this->log("Event failed [{$event->getDescription()}]: {$e->getMessage()}");
} finally {
// Release lock if using overlap prevention
if ($event->getSchedule()->shouldPreventOverlapping()) {
$this->releaseLock($event);
}
}
return $result;
}
/**
* Acquire a lock for overlap prevention
*
* @param ScheduledEvent $event
* @return bool
*/
protected function acquireLock(ScheduledEvent $event): bool
{
if (!$this->cache) {
// If no cache is available, we can't prevent overlapping
return true;
}
$mutexName = $event->getMutexName();
$expiresAt = $event->getSchedule()->getExpiresAt();
// Check if lock already exists
if ($this->cache->has($mutexName)) {
return false;
}
// Acquire the lock
$this->cache->set($mutexName, true, $expiresAt * 60);
return true;
}
/**
* Release a lock for an event
*
* @param ScheduledEvent $event
* @return void
*/
protected function releaseLock(ScheduledEvent $event): void
{
if (!$this->cache) {
return;
}
$this->cache->forget($event->getMutexName());
}
/**
* Log a message
*
* @param string $message
* @return void
*/
protected function log(string $message): void
{
if (!$this->loggingEnabled) {
return;
}
$timestamp = date('Y-m-d H:i:s');
$formattedMessage = "[{$timestamp}] SCHEDULER: {$message}";
if ($this->logger) {
call_user_func($this->logger, $formattedMessage);
} else {
error_log($formattedMessage);
}
}
/**
* Clear all registered events
*
* @return $this
*/
public function clear(): static
{
$this->events = [];
return $this;
}
/**
* Start the scheduler loop (for CLI daemon mode)
*
* @param int $sleepSeconds
* @return void
*/
public function start(int $sleepSeconds = 60): void
{
$this->log("Scheduler started");
while (true) {
$this->run();
// Sleep until the next minute
$this->sleepUntilNextMinute($sleepSeconds);
}
}
/**
* Sleep until the next minute boundary
*
* @param int $maxSleep
* @return void
*/
protected function sleepUntilNextMinute(int $maxSleep = 60): void
{
$now = new DateTime();
$secondsUntilNextMinute = 60 - (int) $now->format('s');
sleep(min($secondsUntilNextMinute, $maxSleep));
}
/**
* Reset the singleton instance (mainly for testing)
*
* @return void
*/
public static function reset(): void
{
static::$instance = null;
}
/**
* Magic method for static calls
*
* @param string $name
* @param array $arguments
* @return mixed
*/
public static function __callStatic(string $name, array $arguments): mixed
{
return static::getInstance()->$name(...$arguments);
}
}