-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathServerTelemetryTest.php
More file actions
420 lines (349 loc) · 12.4 KB
/
Copy pathServerTelemetryTest.php
File metadata and controls
420 lines (349 loc) · 12.4 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
<?php
declare(strict_types=1);
namespace Utopia\Queue\Tests;
use PHPUnit\Framework\TestCase;
use Utopia\DI\Container;
use Utopia\Queue\Adapter;
use Utopia\Queue\Consumer;
use Utopia\Queue\Message;
use Utopia\Queue\Publisher\Synchronous;
use Utopia\Queue\Queue;
use Utopia\Queue\Server;
use Utopia\Telemetry\Adapter\Test as TestTelemetry;
final class ServerTelemetryTest extends TestCase
{
public function testRecordsJobWaitTimeAsMonotonicWhenPublisherClockRunsAhead(): void
{
// A publisher whose clock runs ahead of this consumer's stamps a
// timestamp in the consumer's future. Every recorded wait has to stay
// >= 0, or the cumulative histogram sum decreases and a Prometheus
// reader takes the drop for a counter reset.
$consumer = new ServerTelemetryMultiMessageConsumer([
new Message([
'pid' => 'skewed-pid',
'queue' => 'emails',
'timestamp' => time() + 60,
'payload' => [],
]),
new Message([
'pid' => 'normal-pid',
'queue' => 'emails',
'timestamp' => time() - 1,
'payload' => [],
]),
]);
$adapter = new ServerTelemetryAdapter($consumer, 1, 'appwrite');
$telemetry = new TestTelemetry();
$server = new Server($adapter);
$server->setTelemetry($telemetry);
$server
->job('emails')
->inject('message')
->action(fn (Message $message): null => null);
$server->start();
/** @var object{values: array<int, float|int>} $histogram */
$histogram = $telemetry->histograms['messaging.process.wait.duration'];
$this->assertCount(2, $histogram->values);
$this->assertEqualsWithDelta(0.0, $histogram->values[0], PHP_FLOAT_EPSILON);
$this->assertGreaterThan(0.0, $histogram->values[1]);
// The property that matters downstream: the sum a cumulative exporter
// publishes never goes backwards, whatever the two clocks say.
$sum = 0.0;
foreach ($histogram->values as $value) {
$previous = $sum;
$sum += $value;
$this->assertGreaterThanOrEqual($previous, $sum);
}
}
public function testRecordsQueueDepth(): void
{
$consumer = new ServerTelemetryPublisherConsumer([3, 2], [1, 0]);
$adapter = new ServerTelemetryAdapter($consumer, 1, 'appwrite');
$telemetry = new TestTelemetry();
$server = new Server($adapter);
$server->setTelemetry($telemetry);
$server
->job('emails')
->inject('message')
->action(fn (Message $message): null => null);
$server->start();
$this->assertArrayHasKey('messaging.queue.depth', $telemetry->observableGauges);
$this->assertSame([3], $this->collectObservations($telemetry, 'messaging.queue.depth'));
$this->assertSame([2], $this->collectObservations($telemetry, 'messaging.queue.depth'));
$this->assertArrayHasKey('messaging.queue.failed.depth', $telemetry->observableGauges);
$this->assertSame([1], $this->collectObservations($telemetry, 'messaging.queue.failed.depth'));
$this->assertSame([0], $this->collectObservations($telemetry, 'messaging.queue.failed.depth'));
}
public function testSkipsQueueDepthWhenConsumerCannotReportSize(): void
{
$consumer = new ServerTelemetryConsumer();
$adapter = new ServerTelemetryAdapter($consumer, 1, 'appwrite');
$telemetry = new TestTelemetry();
$server = new Server($adapter);
$server->setTelemetry($telemetry);
$server
->job('emails')
->inject('message')
->action(fn (Message $message): null => null);
$server->start();
$this->assertArrayHasKey('messaging.queue.depth', $telemetry->observableGauges);
$this->assertSame([], $this->collectObservations($telemetry, 'messaging.queue.depth'));
$this->assertSame([], $this->collectObservations($telemetry, 'messaging.queue.failed.depth'));
}
public function testSkipsQueueDepthWhenConsumerCannotReadSize(): void
{
$consumer = new ServerTelemetryFailingPublisherConsumer();
$adapter = new ServerTelemetryAdapter($consumer, 1, 'appwrite');
$telemetry = new TestTelemetry();
$server = new Server($adapter);
$server->setTelemetry($telemetry);
$server
->job('emails')
->inject('message')
->action(fn (Message $message): null => null);
$server->start();
$this->assertArrayHasKey('messaging.queue.depth', $telemetry->observableGauges);
$this->assertSame([], $this->collectObservations($telemetry, 'messaging.queue.depth'));
$this->assertSame([], $this->collectObservations($telemetry, 'messaging.queue.failed.depth'));
$this->assertArrayNotHasKey('messaging.queue.depth.errors', $telemetry->counters);
}
public function testInjectsAdapterResourcesAndContext(): void
{
$consumer = new ServerTelemetryConsumer();
$adapter = new ServerTelemetryAdapter($consumer, 1, 'appwrite');
$server = new Server($adapter);
$injections = [];
$server->resources()->set('resourceValue', fn (): string => 'resource');
$server
->init()
->inject('message')
->action(function (Message $message) use ($server): void {
$server->context()->set('contextValue', fn (): string => $message->getPid());
});
$server
->job('emails')
->inject('message')
->inject('resourceValue')
->inject('contextValue')
->action(function (Message $message, string $resourceValue, string $contextValue) use (&$injections): void {
$injections = [$message->getPid(), $resourceValue, $contextValue];
});
$server->start();
$this->assertSame(['test-pid', 'resource', 'test-pid'], $injections);
}
public function testContextDoesNotLeakBetweenMessages(): void
{
$consumer = new ServerTelemetryMultiMessageConsumer([
new Message([
'pid' => 'first-pid',
'queue' => 'emails',
'timestamp' => time() - 1,
'payload' => [],
]),
new Message([
'pid' => 'second-pid',
'queue' => 'emails',
'timestamp' => time() - 1,
'payload' => [],
]),
]);
$adapter = new ServerTelemetryAdapter($consumer, 1, 'appwrite');
$server = new Server($adapter);
$contextValues = [];
$server
->init()
->inject('message')
->action(function (Message $message) use ($server): void {
if ($message->getPid() === 'first-pid') {
$server->context()->set('contextValue', fn (): string => $message->getPid());
}
});
$server
->job('emails')
->action(function () use ($server, &$contextValues): void {
$contextValues[] = $server->context()->has('contextValue')
? $server->context()->get('contextValue')
: null;
});
$server->start();
$this->assertSame(['first-pid', null], $contextValues);
}
/**
* @return array<int, float|int>
*/
private function collectObservations(TestTelemetry $telemetry, string $name): array
{
/** @var object{callbacks: array<int, \Closure>} $gauge */
$gauge = $telemetry->observableGauges[$name];
$values = [];
foreach ($gauge->callbacks as $callback) {
$callback(function (float|int $value, iterable $attributes = []) use (&$values): void {
$values[] = $value;
});
}
return $values;
}
}
final class ServerTelemetryAdapter extends Adapter
{
/**
* @var callable[]
*/
private array $onWorkerStart = [];
/**
* @var callable[]
*/
private array $onWorkerStop = [];
public function __construct(
Consumer $consumer,
int $workerNum,
string $namespace = 'utopia-queue',
Container $resources = new Container(),
) {
parent::__construct($consumer, $workerNum, $namespace, $resources);
}
public function start(): self
{
foreach ($this->onWorkerStart as $callback) {
$callback('0');
}
foreach ($this->onWorkerStop as $callback) {
$callback('0');
}
return $this;
}
public function stop(): self
{
return $this;
}
/** Drain every message the consumer offers, then return (bounded for tests). */
#[\Override]
public function consume(
callable $messageCallback,
callable $successCallback,
callable $errorCallback,
array $queues,
): void {
foreach ($queues as $spec) {
$queue = $spec['queue'];
$this->queue = $queue;
while (($message = ($this->consumer->receive($queue, 0)[0] ?? null)) instanceof Message) {
$this->context = new Container($this->resources());
$this->process($message, $messageCallback, $successCallback, $errorCallback);
}
}
}
public function workerStart(callable $callback): self
{
$this->onWorkerStart[] = $callback;
return $this;
}
public function workerStop(callable $callback): self
{
$this->onWorkerStop[] = $callback;
return $this;
}
}
class ServerTelemetryConsumer implements Consumer
{
private bool $delivered = false;
public function receive(Queue $queue, int $timeout, int $n = 1): array
{
if ($this->delivered) {
return [];
}
$this->delivered = true;
return [new Message([
'pid' => 'test-pid',
'queue' => $queue->name,
'timestamp' => time() - 1,
'payload' => [],
])];
}
public function commit(Queue $queue, Message $message): void
{
}
public function reject(Queue $queue, Message $message): void
{
}
public function close(): void
{
}
}
final class ServerTelemetryMultiMessageConsumer implements Consumer
{
/**
* @param Message[] $messages
*/
public function __construct(private array $messages)
{
}
public function receive(Queue $queue, int $timeout, int $n = 1): array
{
$message = array_shift($this->messages);
return $message instanceof Message ? [$message] : [];
}
public function commit(Queue $queue, Message $message): void
{
}
public function reject(Queue $queue, Message $message): void
{
}
public function close(): void
{
}
}
final class ServerTelemetryPublisherConsumer extends ServerTelemetryConsumer implements Synchronous
{
/**
* @param int[] $queueSizes
* @param int[] $failedQueueSizes
*/
public function __construct(private array $queueSizes, private array $failedQueueSizes = [])
{
}
public function publish(Queue $queue, array $payload): bool
{
return true;
}
public function publishMany(Queue $queue, array $payloads): bool
{
return true;
}
public function retry(Queue $queue, ?int $limit = null): void
{
}
public function getQueueSize(Queue $queue, bool $failedJobs = false): int
{
if ($failedJobs) {
return array_shift($this->failedQueueSizes) ?? 0;
}
return array_shift($this->queueSizes) ?? 0;
}
public function getFailedCount(Queue $queue): int
{
return array_shift($this->failedQueueSizes) ?? 0;
}
}
final class ServerTelemetryFailingPublisherConsumer extends ServerTelemetryConsumer implements Synchronous
{
public function publish(Queue $queue, array $payload): bool
{
return true;
}
public function publishMany(Queue $queue, array $payloads): bool
{
return true;
}
public function retry(Queue $queue, ?int $limit = null): void
{
}
public function getQueueSize(Queue $queue, bool $failedJobs = false): int
{
throw new \RuntimeException('Queue size unavailable.');
}
public function getFailedCount(Queue $queue): int
{
throw new \RuntimeException('Queue size unavailable.');
}
}