Repository navigation
Expand file tree
/
Copy pathQueueProgressHelper.php
More file actions
252 lines (207 loc) · 5.89 KB
/
Copy pathQueueProgressHelper.php
File metadata and controls
252 lines (207 loc) · 5.89 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
<?php
declare(strict_types=1);
namespace Queue\View\Helper;
use Cake\Cache\Cache;
use Cake\Core\Configure;
use Cake\I18n\DateTime;
use Cake\I18n\Number;
use Cake\ORM\Locator\LocatorAwareTrait;
use Cake\View\Helper;
use Queue\Model\Entity\QueuedJob;
/**
* @property \Tools\View\Helper\ProgressHelper $Progress
* @method \Cake\ORM\Locator\TableLocator getTableLocator()
*/
class QueueProgressHelper extends Helper {
use LocatorAwareTrait;
/**
* @var array<mixed>
*/
protected array $helpers = [
'Tools.Progress',
];
/**
* @var array<string, array<int>>|null
*/
protected ?array $statistics = null;
/**
* Returns percentage as formatted value.
*
* @param \Queue\Model\Entity\QueuedJob $queuedJob
*
* @return string|null
*/
public function progress(QueuedJob $queuedJob): ?string {
if ($queuedJob->completed) {
return null;
}
if ($queuedJob->progress === null && $queuedJob->fetched) {
$queuedJob->progress = $this->calculateJobProgress($queuedJob->job_task, $queuedJob->fetched);
}
if ($queuedJob->progress === null) {
return null;
}
$progress = $this->Progress->roundPercentage($queuedJob->progress);
return Number::toPercentage($progress, 0, ['multiply' => true]);
}
/**
* Returns percentage as visual progress bar.
*
* @param \Queue\Model\Entity\QueuedJob $queuedJob
* @param int $length
*
* @return string|null
*/
public function progressBar(QueuedJob $queuedJob, int $length): ?string {
if ($queuedJob->completed) {
return null;
}
if ($queuedJob->progress === null && $queuedJob->fetched) {
$queuedJob->progress = $this->calculateJobProgress($queuedJob->job_task, $queuedJob->fetched);
}
if ($queuedJob->progress === null) {
return null;
}
return $this->Progress->progressBar($queuedJob->progress, $length);
}
/**
* @param \Queue\Model\Entity\QueuedJob $queuedJob
* @param string|null $fallbackHtml
*
* @return string|null
*/
public function htmlProgressBar(QueuedJob $queuedJob, ?string $fallbackHtml = null): ?string {
if ($queuedJob->completed) {
return null;
}
if ($queuedJob->progress === null && $queuedJob->fetched) {
$queuedJob->progress = $this->calculateJobProgress($queuedJob->job_task, $queuedJob->fetched);
}
if ($queuedJob->progress === null) {
return null;
}
$progress = $this->Progress->roundPercentage($queuedJob->progress);
$title = Number::toPercentage($progress, 0, ['multiply' => true]);
return '<progress value="' . number_format($progress * 100, 0) . '" max="100" title="' . $title . '">' . $fallbackHtml . '</progress>';
}
/**
* Returns percentage as visual progress bar.
*
* @param \Queue\Model\Entity\QueuedJob $queuedJob
* @param int $length
*
* @return string|null
*/
public function timeoutProgressBar(QueuedJob $queuedJob, int $length): ?string {
$progress = $this->calculateTimeoutProgress($queuedJob);
if ($progress === null) {
return null;
}
return $this->Progress->progressBar($progress, $length);
}
/**
* @param \Queue\Model\Entity\QueuedJob $queuedJob
* @param string|null $fallbackHtml
*
* @return string|null
*/
public function htmlTimeoutProgressBar(QueuedJob $queuedJob, ?string $fallbackHtml = null): ?string {
$progress = $this->calculateTimeoutProgress($queuedJob);
if ($progress === null) {
return null;
}
$progress = $this->Progress->roundPercentage($progress);
$title = Number::toPercentage($progress, 0, ['multiply' => true]);
return '<progress value="' . number_format($progress * 100, 0) . '" max="100" title="' . $title . '">' . $fallbackHtml . '</progress>';
}
/**
* Calculates the timeout progress rate.
*
* @param \Queue\Model\Entity\QueuedJob $queuedJob
*
* @return float|null
*/
protected function calculateTimeoutProgress(QueuedJob $queuedJob): ?float {
if ($queuedJob->completed || $queuedJob->fetched || !$queuedJob->notbefore) {
return null;
}
$created = $queuedJob->created->getTimestamp();
$planned = $queuedJob->notbefore->getTimestamp();
$now = (new DateTime())->getTimestamp();
$progressed = $now - $created;
$total = $planned - $created;
if ($total <= 0) {
return null;
}
if ($progressed < 0) {
$progressed = 0;
}
$progress = min($progressed / $total, 1.0);
return (float)$progress;
}
/**
* @param string $jobType
* @param \Cake\I18n\DateTime $fetched
*
* @return float|null
*/
protected function calculateJobProgress(string $jobType, DateTime $fetched): ?float {
$stats = $this->getJobStatistics($jobType);
if (!$stats) {
return null;
}
$sum = array_sum($stats);
if ($sum <= 0) {
return null;
}
$average = $sum / count($stats);
$running = $fetched->diffInSeconds();
$progress = min($running / $average, 0.9999);
return (float)$progress;
}
/**
* @param string $jobType
*
* @return array<int>
*/
protected function getJobStatistics(string $jobType): array {
$statistics = $this->readStatistics();
if (!isset($statistics[$jobType])) {
return [];
}
return $statistics[$jobType];
}
/**
* @var string
*/
public const KEY = 'queue_queued-job-statistics';
/**
* @var string
*/
public const CONFIG = 'default';
/**
* @return array<string, array<int>>
*/
protected function readStatistics(): array {
if ($this->statistics !== null) {
return $this->statistics;
}
$queuedJobStatistics = false;
if (!Configure::read('debug')) {
$queuedJobStatistics = Cache::read(static::KEY, static::CONFIG);
}
if ($queuedJobStatistics === false) {
$QueuedJobs = $this->getTableLocator()->get('Queue.QueuedJobs');
$queuedJobStatistics = $QueuedJobs->getStats(true);
Cache::write(static::KEY, $queuedJobStatistics, static::CONFIG);
}
$statistics = [];
foreach ((array)$queuedJobStatistics as $statistic) {
/** @var string $name */
$name = $statistic['job_task'];
$statistics[$name][] = $statistic['runtime'];
}
$this->statistics = $statistics;
return $this->statistics;
}
}