Remove queue depth health endpoints (#13168)

* Remove queue depth health endpoints

* Unregister removed queue health actions
This commit is contained in:
Chirag Aggarwal authored and GitHub committed 2026-08-10 13:10:58 +05:30
1 parent a0a7a2208e
commit 664c13e969
27 files changed
+3 -829

No files matched your search

@@ -1,42 +0,0 @@
<?php
namespace Appwrite\Platform\Modules\Health\Http\Health\Queue\Audits;
use Appwrite\Event\Publisher\Audit;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Base;
use Appwrite\Utopia\Response;
use Utopia\Database\Document;
use Utopia\Validator\Integer;
class Get extends Base
{
public static function getName(): string
{
return 'getQueueAudits';
}
public function __construct()
{
$this
->setHttpMethod(Base::HTTP_REQUEST_METHOD_GET)
->setHttpPath('/v1/health/queue/audits')
->desc('Get audits queue')
->groups(['api', 'health'])
->label('scope', 'health.read')
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
->inject('publisherForAudits')
->inject('response')
->callback($this->action(...));
}
public function action(int|string $threshold, Audit $publisherForAudits, Response $response): void
{
$threshold = (int) $threshold;
$size = $publisherForAudits->getSize();
$this->assertQueueThreshold($size, $threshold);
$response->dynamic(new Document(['size' => $size]), Response::MODEL_HEALTH_QUEUE);
}
}
@@ -1,42 +0,0 @@
<?php
namespace Appwrite\Platform\Modules\Health\Http\Health\Queue\Builds;
use Appwrite\Event\Publisher\Build as BuildPublisher;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Base;
use Appwrite\Utopia\Response;
use Utopia\Database\Document;
use Utopia\Validator\Integer;
class Get extends Base
{
public static function getName(): string
{
return 'getQueueBuilds';
}
public function __construct()
{
$this
->setHttpMethod(Base::HTTP_REQUEST_METHOD_GET)
->setHttpPath('/v1/health/queue/builds')
->desc('Get builds queue')
->groups(['api', 'health'])
->label('scope', 'health.read')
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
->inject('publisherForBuilds')
->inject('response')
->callback($this->action(...));
}
public function action(int|string $threshold, BuildPublisher $publisherForBuilds, Response $response): void
{
$threshold = (int) $threshold;
$size = $publisherForBuilds->getSize();
$this->assertQueueThreshold($size, $threshold);
$response->dynamic(new Document(['size' => $size]), Response::MODEL_HEALTH_QUEUE);
}
}
@@ -1,42 +0,0 @@
<?php
namespace Appwrite\Platform\Modules\Health\Http\Health\Queue\Certificates;
use Appwrite\Event\Publisher\Certificate;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Base;
use Appwrite\Utopia\Response;
use Utopia\Database\Document;
use Utopia\Validator\Integer;
class Get extends Base
{
public static function getName(): string
{
return 'getQueueCertificates';
}
public function __construct()
{
$this
->setHttpMethod(Base::HTTP_REQUEST_METHOD_GET)
->setHttpPath('/v1/health/queue/certificates')
->desc('Get certificates queue')
->groups(['api', 'health'])
->label('scope', 'health.read')
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
->inject('publisherForCertificates')
->inject('response')
->callback($this->action(...));
}
public function action(int|string $threshold, Certificate $publisherForCertificates, Response $response): void
{
$threshold = (int) $threshold;
$size = $publisherForCertificates->getSize();
$this->assertQueueThreshold($size, $threshold);
$response->dynamic(new Document(['size' => $size]), Response::MODEL_HEALTH_QUEUE);
}
}
@@ -1,44 +0,0 @@
<?php
namespace Appwrite\Platform\Modules\Health\Http\Health\Queue\Databases;
use Appwrite\Event\Publisher\Database;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Base;
use Appwrite\Utopia\Response;
use Utopia\Database\Document;
use Utopia\Queue\Queue;
use Utopia\Validator\Integer;
use Utopia\Validator\Text;
class Get extends Base
{
public static function getName(): string
{
return 'getQueueDatabases';
}
public function __construct()
{
$this
->setHttpMethod(Base::HTTP_REQUEST_METHOD_GET)
->setHttpPath('/v1/health/queue/databases')
->desc('Get databases queue')
->groups(['api', 'health'])
->label('scope', 'health.read')
->param('name', 'database_db_main', new Text(256), 'Queue name for which to check the queue size', true)
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
->inject('publisherForDatabase')
->inject('response')
->callback($this->action(...));
}
public function action(string $name, int|string $threshold, Database $publisherForDatabase, Response $response): void
{
$threshold = (int) $threshold;
$size = $publisherForDatabase->getSize(queue: new Queue($name));
$this->assertQueueThreshold($size, $threshold);
$response->dynamic(new Document(['size' => $size]), Response::MODEL_HEALTH_QUEUE);
}
}
@@ -1,42 +0,0 @@
<?php
namespace Appwrite\Platform\Modules\Health\Http\Health\Queue\Deletes;
use Appwrite\Event\Publisher\Delete;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Base;
use Appwrite\Utopia\Response;
use Utopia\Database\Document;
use Utopia\Validator\Integer;
class Get extends Base
{
public static function getName(): string
{
return 'getQueueDeletes';
}
public function __construct()
{
$this
->setHttpMethod(Base::HTTP_REQUEST_METHOD_GET)
->setHttpPath('/v1/health/queue/deletes')
->desc('Get deletes queue')
->groups(['api', 'health'])
->label('scope', 'health.read')
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
->inject('publisherForDeletes')
->inject('response')
->callback($this->action(...));
}
public function action(int|string $threshold, Delete $publisherForDeletes, Response $response): void
{
$threshold = (int) $threshold;
$size = $publisherForDeletes->getSize();
$this->assertQueueThreshold($size, $threshold);
$response->dynamic(new Document(['size' => $size]), Response::MODEL_HEALTH_QUEUE);
}
}
@@ -1,42 +0,0 @@
<?php
namespace Appwrite\Platform\Modules\Health\Http\Health\Queue\Functions;
use Appwrite\Event\Publisher\Func as FunctionPublisher;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Base;
use Appwrite\Utopia\Response;
use Utopia\Database\Document;
use Utopia\Validator\Integer;
class Get extends Base
{
public static function getName(): string
{
return 'getQueueFunctions';
}
public function __construct()
{
$this
->setHttpMethod(Base::HTTP_REQUEST_METHOD_GET)
->setHttpPath('/v1/health/queue/functions')
->desc('Get functions queue')
->groups(['api', 'health'])
->label('scope', 'health.read')
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
->inject('publisherForFunctions')
->inject('response')
->callback($this->action(...));
}
public function action(int|string $threshold, FunctionPublisher $publisherForFunctions, Response $response): void
{
$threshold = (int) $threshold;
$size = $publisherForFunctions->getSize();
$this->assertQueueThreshold($size, $threshold);
$response->dynamic(new Document(['size' => $size]), Response::MODEL_HEALTH_QUEUE);
}
}
@@ -1,42 +0,0 @@
<?php
namespace Appwrite\Platform\Modules\Health\Http\Health\Queue\Mails;
use Appwrite\Event\Publisher\Mail as MailPublisher;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Base;
use Appwrite\Utopia\Response;
use Utopia\Database\Document;
use Utopia\Validator\Integer;
class Get extends Base
{
public static function getName(): string
{
return 'getQueueMails';
}
public function __construct()
{
$this
->setHttpMethod(Base::HTTP_REQUEST_METHOD_GET)
->setHttpPath('/v1/health/queue/mails')
->desc('Get mails queue')
->groups(['api', 'health'])
->label('scope', 'health.read')
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
->inject('publisherForMails')
->inject('response')
->callback($this->action(...));
}
public function action(int|string $threshold, MailPublisher $publisherForMails, Response $response): void
{
$threshold = (int) $threshold;
$size = $publisherForMails->getSize();
$this->assertQueueThreshold($size, $threshold);
$response->dynamic(new Document(['size' => $size]), Response::MODEL_HEALTH_QUEUE);
}
}
@@ -1,42 +0,0 @@
<?php
namespace Appwrite\Platform\Modules\Health\Http\Health\Queue\Messaging;
use Appwrite\Event\Publisher\Messaging as MessagingPublisher;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Base;
use Appwrite\Utopia\Response;
use Utopia\Database\Document;
use Utopia\Validator\Integer;
class Get extends Base
{
public static function getName(): string
{
return 'getQueueMessaging';
}
public function __construct()
{
$this
->setHttpMethod(Base::HTTP_REQUEST_METHOD_GET)
->setHttpPath('/v1/health/queue/messaging')
->desc('Get messaging queue')
->groups(['api', 'health'])
->label('scope', 'health.read')
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
->inject('publisherForMessaging')
->inject('response')
->callback($this->action(...));
}
public function action(int|string $threshold, MessagingPublisher $publisherForMessaging, Response $response): void
{
$threshold = (int) $threshold;
$size = $publisherForMessaging->getSize();
$this->assertQueueThreshold($size, $threshold);
$response->dynamic(new Document(['size' => $size]), Response::MODEL_HEALTH_QUEUE);
}
}
@@ -1,42 +0,0 @@
<?php
namespace Appwrite\Platform\Modules\Health\Http\Health\Queue\Migrations;
use Appwrite\Event\Publisher\Migration as MigrationPublisher;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Base;
use Appwrite\Utopia\Response;
use Utopia\Database\Document;
use Utopia\Validator\Integer;
class Get extends Base
{
public static function getName(): string
{
return 'getQueueMigrations';
}
public function __construct()
{
$this
->setHttpMethod(Base::HTTP_REQUEST_METHOD_GET)
->setHttpPath('/v1/health/queue/migrations')
->desc('Get migrations queue')
->groups(['api', 'health'])
->label('scope', 'health.read')
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
->inject('publisherForMigrations')
->inject('response')
->callback($this->action(...));
}
public function action(int|string $threshold, MigrationPublisher $publisherForMigrations, Response $response): void
{
$threshold = (int) $threshold;
$size = $publisherForMigrations->getSize();
$this->assertQueueThreshold($size, $threshold);
$response->dynamic(new Document(['size' => $size]), Response::MODEL_HEALTH_QUEUE);
}
}
@@ -1,42 +0,0 @@
<?php
namespace Appwrite\Platform\Modules\Health\Http\Health\Queue\Notifications;
use Appwrite\Event\Publisher\Notification as NotificationPublisher;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Base;
use Appwrite\Utopia\Response;
use Utopia\Database\Document;
use Utopia\Validator\Integer;
class Get extends Base
{
public static function getName(): string
{
return 'getQueueNotifications';
}
public function __construct()
{
$this
->setHttpMethod(Base::HTTP_REQUEST_METHOD_GET)
->setHttpPath('/v1/health/queue/notifications')
->desc('Get notifications queue')
->groups(['api', 'health'])
->label('scope', 'health.read')
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
->inject('publisherForNotifications')
->inject('response')
->callback($this->action(...));
}
public function action(int|string $threshold, NotificationPublisher $publisherForNotifications, Response $response): void
{
$threshold = (int) $threshold;
$size = $publisherForNotifications->getSize();
$this->assertQueueThreshold($size, $threshold);
$response->dynamic(new Document(['size' => $size]), Response::MODEL_HEALTH_QUEUE);
}
}
@@ -1,42 +0,0 @@
<?php
namespace Appwrite\Platform\Modules\Health\Http\Health\Queue\StatsResources;
use Appwrite\Event\Publisher\StatsResources as StatsResourcesPublisher;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Base;
use Appwrite\Utopia\Response;
use Utopia\Database\Document;
use Utopia\Validator\Integer;
class Get extends Base
{
public static function getName(): string
{
return 'getQueueStatsResources';
}
public function __construct()
{
$this
->setHttpMethod(Base::HTTP_REQUEST_METHOD_GET)
->setHttpPath('/v1/health/queue/stats-resources')
->desc('Get stats resources queue')
->groups(['api', 'health'])
->label('scope', 'health.read')
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
->inject('publisherForStatsResources')
->inject('response')
->callback($this->action(...));
}
public function action(int|string $threshold, StatsResourcesPublisher $publisherForStatsResources, Response $response): void
{
$threshold = (int) $threshold;
$size = $publisherForStatsResources->getSize();
$this->assertQueueThreshold($size, $threshold);
$response->dynamic(new Document(['size' => $size]), Response::MODEL_HEALTH_QUEUE);
}
}
@@ -1,42 +0,0 @@
<?php
namespace Appwrite\Platform\Modules\Health\Http\Health\Queue\StatsUsage;
use Appwrite\Event\Publisher\Usage as UsagePublisher;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Base;
use Appwrite\Utopia\Response;
use Utopia\Database\Document;
use Utopia\Validator\Integer;
class Get extends Base
{
public static function getName(): string
{
return 'getQueueUsage';
}
public function __construct()
{
$this
->setHttpMethod(Base::HTTP_REQUEST_METHOD_GET)
->setHttpPath('/v1/health/queue/stats-usage')
->desc('Get stats usage queue')
->groups(['api', 'health'])
->label('scope', 'health.read')
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
->inject('publisherForUsage')
->inject('response')
->callback($this->action(...));
}
public function action(int|string $threshold, UsagePublisher $publisherForUsage, Response $response): void
{
$threshold = (int) $threshold;
$size = $publisherForUsage->getSize();
$this->assertQueueThreshold($size, $threshold);
$response->dynamic(new Document(['size' => $size]), Response::MODEL_HEALTH_QUEUE);
}
}
@@ -1,42 +0,0 @@
<?php
namespace Appwrite\Platform\Modules\Health\Http\Health\Queue\Webhooks;
use Appwrite\Event\Webhook;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Base;
use Appwrite\Utopia\Response;
use Utopia\Database\Document;
use Utopia\Validator\Integer;
class Get extends Base
{
public static function getName(): string
{
return 'getQueueWebhooks';
}
public function __construct()
{
$this
->setHttpMethod(Base::HTTP_REQUEST_METHOD_GET)
->setHttpPath('/v1/health/queue/webhooks')
->desc('Get webhooks queue')
->groups(['api', 'health'])
->label('scope', 'health.read')
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
->inject('queueForWebhooks')
->inject('response')
->callback($this->action(...));
}
public function action(int|string $threshold, Webhook $queueForWebhooks, Response $response): void
{
$threshold = (int) $threshold;
$size = $queueForWebhooks->getSize();
$this->assertQueueThreshold($size, $threshold);
$response->dynamic(new Document(['size' => $size]), Response::MODEL_HEALTH_QUEUE);
}
}
@@ -9,20 +9,7 @@ use Appwrite\Platform\Modules\Health\Http\Health\DB\Get as GetDB;
use Appwrite\Platform\Modules\Health\Http\Health\Geo\Get as GetGeo;
use Appwrite\Platform\Modules\Health\Http\Health\Get as GetHealth;
use Appwrite\Platform\Modules\Health\Http\Health\PubSub\Get as GetPubSub;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Audits\Get as GetQueueAudits;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Builds\Get as GetQueueBuilds;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Certificates\Get as GetQueueCertificates;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Databases\Get as GetQueueDatabases;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Deletes\Get as GetQueueDeletes;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Failed\Get as GetFailedJobs;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Functions\Get as GetQueueFunctions;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Mails\Get as GetQueueMails;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Messaging\Get as GetQueueMessaging;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Migrations\Get as GetQueueMigrations;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Notifications\Get as GetQueueNotifications;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\StatsResources\Get as GetQueueStatsResources;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\StatsUsage\Get as GetQueueUsage;
use Appwrite\Platform\Modules\Health\Http\Health\Queue\Webhooks\Get as GetQueueWebhooks;
use Appwrite\Platform\Modules\Health\Http\Health\Stats\Get as GetStats;
use Appwrite\Platform\Modules\Health\Http\Health\Storage\Get as GetStorage;
use Appwrite\Platform\Modules\Health\Http\Health\Storage\Local\Get as GetStorageLocal;
@@ -48,19 +35,6 @@ class Http extends Service
$this->addAction(GetAntivirus::getName(), new GetAntivirus());
$this->addAction(GetGeo::getName(), new GetGeo());
$this->addAction(GetQueueAudits::getName(), new GetQueueAudits());
$this->addAction(GetQueueWebhooks::getName(), new GetQueueWebhooks());
$this->addAction(GetQueueCertificates::getName(), new GetQueueCertificates());
$this->addAction(GetQueueBuilds::getName(), new GetQueueBuilds());
$this->addAction(GetQueueDatabases::getName(), new GetQueueDatabases());
$this->addAction(GetQueueDeletes::getName(), new GetQueueDeletes());
$this->addAction(GetQueueMails::getName(), new GetQueueMails());
$this->addAction(GetQueueMessaging::getName(), new GetQueueMessaging());
$this->addAction(GetQueueMigrations::getName(), new GetQueueMigrations());
$this->addAction(GetQueueNotifications::getName(), new GetQueueNotifications());
$this->addAction(GetQueueFunctions::getName(), new GetQueueFunctions());
$this->addAction(GetQueueStatsResources::getName(), new GetQueueStatsResources());
$this->addAction(GetQueueUsage::getName(), new GetQueueUsage());
$this->addAction(GetFailedJobs::getName(), new GetFailedJobs());
$this->addAction(GetStats::getName(), new GetStats());
@@ -1,19 +0,0 @@
<?php
declare(strict_types=1);
namespace Tests\E2E\Services\Health;
final class AuditsQueueTest extends HealthBase
{
public function testAuditsQueue(): void
{
$response = $this->callGet('/health/queue/audits');
$this->assertEquals(200, $response['headers']['status-code']);
$this->assertIsInt($response['body']['size']);
$this->assertLessThan(100, $response['body']['size']);
$failure = $this->callGet('/health/queue/audits', ['threshold' => '0']);
$this->assertEquals(503, $failure['headers']['status-code']);
}
}
@@ -1,19 +0,0 @@
<?php
declare(strict_types=1);
namespace Tests\E2E\Services\Health;
final class BuildsQueueTest extends HealthBase
{
public function testBuildsQueue(): void
{
$response = $this->callGet('/health/queue/builds');
$this->assertEquals(200, $response['headers']['status-code']);
$this->assertIsInt($response['body']['size']);
$this->assertLessThan(100, $response['body']['size']);
$failure = $this->callGet('/health/queue/builds', ['threshold' => '0']);
$this->assertEquals(503, $failure['headers']['status-code']);
}
}
@@ -1,19 +0,0 @@
<?php
declare(strict_types=1);
namespace Tests\E2E\Services\Health;
final class CertificatesQueueTest extends HealthBase
{
public function testCertificatesQueue(): void
{
$response = $this->callGet('/health/queue/certificates');
$this->assertEquals(200, $response['headers']['status-code']);
$this->assertIsInt($response['body']['size']);
$this->assertLessThan(100, $response['body']['size']);
$failure = $this->callGet('/health/queue/certificates', ['threshold' => '0']);
$this->assertEquals(503, $failure['headers']['status-code']);
}
}
@@ -1,19 +0,0 @@
<?php
declare(strict_types=1);
namespace Tests\E2E\Services\Health;
final class DatabasesQueueTest extends HealthBase
{
public function testDatabasesQueue(): void
{
$response = $this->callGet('/health/queue/databases', ['name' => 'database_db_main']);
$this->assertEquals(200, $response['headers']['status-code']);
$this->assertIsInt($response['body']['size']);
$this->assertLessThan(100, $response['body']['size']);
$failure = $this->callGet('/health/queue/databases', ['name' => 'database_db_main', 'threshold' => '0']);
$this->assertEquals(503, $failure['headers']['status-code']);
}
}
@@ -1,19 +0,0 @@
<?php
declare(strict_types=1);
namespace Tests\E2E\Services\Health;
final class DeletesQueueTest extends HealthBase
{
public function testDeletesQueue(): void
{
$response = $this->callGet('/health/queue/deletes');
$this->assertEquals(200, $response['headers']['status-code']);
$this->assertIsInt($response['body']['size']);
$this->assertLessThan(100, $response['body']['size']);
$failure = $this->callGet('/health/queue/deletes', ['threshold' => '0']);
$this->assertEquals(503, $failure['headers']['status-code']);
}
}
@@ -1,19 +0,0 @@
<?php
declare(strict_types=1);
namespace Tests\E2E\Services\Health;
final class FunctionsQueueTest extends HealthBase
{
public function testFunctionsQueue(): void
{
$response = $this->callGet('/health/queue/functions');
$this->assertEquals(200, $response['headers']['status-code']);
$this->assertIsInt($response['body']['size']);
$this->assertLessThan(100, $response['body']['size']);
$failure = $this->callGet('/health/queue/functions', ['threshold' => '0']);
$this->assertEquals(503, $failure['headers']['status-code']);
}
}
@@ -1,19 +0,0 @@
<?php
declare(strict_types=1);
namespace Tests\E2E\Services\Health;
final class MailsQueueTest extends HealthBase
{
public function testMailsQueue(): void
{
$response = $this->callGet('/health/queue/mails');
$this->assertEquals(200, $response['headers']['status-code']);
$this->assertIsInt($response['body']['size']);
$this->assertLessThan(100, $response['body']['size']);
$failure = $this->callGet('/health/queue/mails', ['threshold' => '0']);
$this->assertEquals(503, $failure['headers']['status-code']);
}
}
@@ -1,19 +0,0 @@
<?php
declare(strict_types=1);
namespace Tests\E2E\Services\Health;
final class MessagingQueueTest extends HealthBase
{
public function testMessagingQueue(): void
{
$response = $this->callGet('/health/queue/messaging');
$this->assertEquals(200, $response['headers']['status-code']);
$this->assertIsInt($response['body']['size']);
$this->assertLessThan(100, $response['body']['size']);
$failure = $this->callGet('/health/queue/messaging', ['threshold' => '0']);
$this->assertEquals(503, $failure['headers']['status-code']);
}
}
@@ -1,19 +0,0 @@
<?php
declare(strict_types=1);
namespace Tests\E2E\Services\Health;
final class MigrationsQueueTest extends HealthBase
{
public function testMigrationsQueue(): void
{
$response = $this->callGet('/health/queue/migrations');
$this->assertEquals(200, $response['headers']['status-code']);
$this->assertIsInt($response['body']['size']);
$this->assertLessThan(100, $response['body']['size']);
$failure = $this->callGet('/health/queue/migrations', ['threshold' => '0']);
$this->assertEquals(503, $failure['headers']['status-code']);
}
}
@@ -1,19 +0,0 @@
<?php
declare(strict_types=1);
namespace Tests\E2E\Services\Health;
final class StatsResourcesQueueTest extends HealthBase
{
public function testStatsResources(): void
{
$response = $this->callGet('/health/queue/stats-resources');
$this->assertEquals(200, $response['headers']['status-code']);
$this->assertIsInt($response['body']['size']);
$this->assertLessThan(100, $response['body']['size']);
$failure = $this->callGet('/health/queue/stats-resources', ['threshold' => '0']);
$this->assertEquals(503, $failure['headers']['status-code']);
}
}
@@ -1,19 +0,0 @@
<?php
declare(strict_types=1);
namespace Tests\E2E\Services\Health;
final class StatsUsageQueueTest extends HealthBase
{
public function testStatsUsage(): void
{
$response = $this->callGet('/health/queue/stats-usage');
$this->assertEquals(200, $response['headers']['status-code']);
$this->assertIsInt($response['body']['size']);
$this->assertLessThan(100, $response['body']['size']);
$failure = $this->callGet('/health/queue/stats-usage', ['threshold' => '0']);
$this->assertEquals(503, $failure['headers']['status-code']);
}
}
@@ -1,19 +0,0 @@
<?php
declare(strict_types=1);
namespace Tests\E2E\Services\Health;
final class WebhooksQueueTest extends HealthBase
{
public function testWebhooksQueue(): void
{
$response = $this->callGet('/health/queue/webhooks');
$this->assertEquals(200, $response['headers']['status-code']);
$this->assertIsInt($response['body']['size']);
$this->assertLessThan(100, $response['body']['size']);
$failure = $this->callGet('/health/queue/webhooks', ['threshold' => '0']);
$this->assertEquals(503, $failure['headers']['status-code']);
}
}
@@ -8,16 +8,14 @@ use Utopia\Database\Helpers\ID;
use Utopia\System\System;
/**
* End-to-end coverage for the notifications queue health surface and the
* End-to-end coverage for the notifications failed-jobs health surface and the
* notifications user-facing API.
*
* The notification worker itself is exercised in unit tests with a pinned
* queue payload; the server side cannot deterministically inject a
* Notification onto the live queue without an admin endpoint, so the health
* portion validates the public contract that ops and KEDA scale on:
* Notification onto the live queue without an admin endpoint. This suite keeps
* coverage for the failed-jobs health surface and the user-facing API:
*
* - GET /v1/health/queue/notifications returns the live queue depth
* - the threshold guard returns 503 when the depth exceeds the budget
* - the failed-jobs surface accepts the notifications queue name
*
* The notifications portion exercises the full webhook-paused fanout end-to-end:
@@ -37,28 +35,6 @@ use Utopia\System\System;
*/
trait NotificationsBase
{
public function testHealthQueueNotificationsReportsSize(): void
{
$response = $this->client->call(Client::METHOD_GET, '/health/queue/notifications', \array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $this->getProject()['$id'],
], $this->getHeaders()));
$this->assertSame(200, $response['headers']['status-code']);
$this->assertIsInt($response['body']['size']);
$this->assertGreaterThanOrEqual(0, $response['body']['size']);
}
public function testHealthQueueNotificationsThresholdGuard(): void
{
$response = $this->client->call(Client::METHOD_GET, '/health/queue/notifications', \array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $this->getProject()['$id'],
], $this->getHeaders()), ['threshold' => '0']);
$this->assertContains($response['headers']['status-code'], [200, 503]);
}
public function testHealthQueueFailedAcceptsNotifications(): void
{
$response = $this->client->call(Client::METHOD_GET, '/health/queue/failed/v1-notifications', \array_merge([