Merge pull request #12895 from appwrite/fix/DISCORD-15272384-realtime-executions-flake

DISCORD-15272384: Harden flaky RealtimeCustomClientTest::testChannelExecutions
This commit is contained in:
ArnabChatterjee20k authored and GitHub committed 2026-07-16 16:02:34 +05:30
commit 66946dfb34
2 files changed
+73 -3

No files matched your search

@@ -2,11 +2,68 @@
namespace Tests\E2E\Services\Realtime;
use Appwrite\Tests\Async\Exceptions\Critical;
use WebSocket\Client as WebSocketClient;
use WebSocket\ConnectionException;
use WebSocket\TimeoutException;
trait RealtimeBase
{
/**
* Receive websocket frames until one matches, skipping unrelated frames.
*
* Realtime channels such as `executions` are project-scoped, so a subscriber
* may see intermediate or unrelated frames before the one under test. Some
* events (e.g. an async execution's terminal `update`) also arrive only after
* substantial latency (worker pickup + runtime cold start + execution timeout),
* well beyond a single read timeout. This polls, tolerating both, until $match
* returns true or the overall deadline elapses.
*
* @param callable(array): bool $match
*/
private function receiveUntilEvent(
WebSocketClient $client,
callable $match,
int $timeoutMs = 60000,
int $pollMs = 50
): array {
$matched = [];
$lastMessage = [];
try {
$this->assertEventually(function () use ($client, $match, &$matched, &$lastMessage): void {
try {
$frame = $client->receive();
} catch (TimeoutException) {
// No frame arrived within the read timeout yet; keep polling.
throw new \Exception('No websocket frame received within read timeout.');
} catch (ConnectionException $e) {
// Server closed or reset the socket (e.g. idle-timeout eviction).
// Retrying can never recover, so fail fast with context instead of
// letting a raw stack trace bubble up.
throw new Critical('WebSocket connection closed while waiting for expected frame: ' . $e->getMessage());
}
$message = \json_decode($frame, true);
if (\is_array($message)) {
$lastMessage = $message;
}
if (!\is_array($message) || !$match($message)) {
throw new \Exception('Websocket frame did not match expected event.');
}
$matched = $message;
}, $timeoutMs, $pollMs);
} catch (Critical $e) {
$this->fail($e->getMessage() . ' Last frame: ' . \json_encode($lastMessage));
} catch (\Exception) {
$this->fail('Timed out waiting for expected websocket frame. Last frame: ' . \json_encode($lastMessage));
}
return $matched;
}
private function getWebsocket(
array $channels = [],
array $headers = [],
@@ -2457,11 +2457,24 @@ final class RealtimeCustomClientTest extends Scope
$this->assertEquals(202, $execution['headers']['status-code']);
$this->assertNotEmpty($execution['body']['$id']);
$response = json_decode($client->receive(), true);
$responseUpdate = json_decode($client->receive(), true);
$executionId = $execution['body']['$id'];
// The async execution first emits a `create` event, then a terminal `update`
// once the runtime finishes. That `update` only arrives after worker pickup,
// runtime cold start, and the function's execution timeout, so it can easily
// exceed a single read timeout. Skip unrelated frames and wait generously for
// each expected event instead of assuming they are the next two frames.
$response = $this->receiveUntilEvent(
$client,
fn (array $message): bool => ($message['type'] ?? null) === 'event'
&& \in_array("functions.{$functionId}.executions.{$executionId}.create", $message['data']['events'] ?? [], true)
);
$responseUpdate = $this->receiveUntilEvent(
$client,
fn (array $message): bool => ($message['type'] ?? null) === 'event'
&& \in_array("functions.{$functionId}.executions.{$executionId}.update", $message['data']['events'] ?? [], true)
);
$this->assertArrayHasKey('type', $response);
$this->assertArrayHasKey('data', $response);
$this->assertEquals('event', $response['type']);