appwrite/src/Appwrite/Platform/Tasks/QueueCount.php

<?php

namespace Appwrite\Platform\Tasks;

use Appwrite\Event\Event;
use Utopia\CLI\Console;
use Utopia\Platform\Action;
use Utopia\Queue\Client;
use Utopia\Queue\Connection;
use Utopia\Validator\WhiteList;

class QueueCount extends Action
{
    public static function getName(): string
    {
        return 'queue-count';
    }


    public function __construct()
    {
        $this
            ->desc('Return the number of from a specific queue identified by the name parameter with a specific type')
            ->param('name', '', new WhiteList([
                Event::DATABASE_QUEUE_NAME,
                Event::DELETE_QUEUE_NAME,
                Event::AUDITS_QUEUE_NAME,
                Event::MAILS_QUEUE_NAME,
                Event::FUNCTIONS_QUEUE_NAME,
                Event::USAGE_QUEUE_NAME,
                Event::WEBHOOK_QUEUE_NAME,
                Event::CERTIFICATES_QUEUE_NAME,
                Event::BUILDS_QUEUE_NAME,
                Event::MESSAGING_QUEUE_NAME,
                Event::MIGRATIONS_QUEUE_NAME,
                Event::HAMSTER_QUEUE_NAME
            ]), 'Queue name')
            ->param('type', '', new WhiteList([
                'success',
                'failed',
                'processing',
            ]), 'Queue type')
            ->inject('queue')
            ->callback(fn ($name, $type, $queue) => $this->action($name, $type, $queue));
    }

    /**
     * @param string $name The name of the queue to count the jobs from
     * @param string $type The type of jobs to count
     * @param Connection $queue
     */
    public function action(string $name, string $type, Connection $queue): void
    {
        if (!$name) {
            Console::error('Missing required parameter $name');
            return;
        }

        $queueClient = new Client($name, $queue);

        $count = 0;

        switch ($type) {
            case 'success':
                $count = $queueClient->countSuccessfulJobs();
                break;
            case 'failed':
                $count = $queueClient->countFailedJobs();
                break;
            case 'processing':
                $count = $queueClient->countProcessingJobs();
                break;
        };

        Console::log("Queue: '{$name}' has {$count} {$type} jobs.");
    }
}