merge master

2026-05-26 13:51:13 +00:00 · 2023-09-12 20:53:16 +05:30
parent 40f419663c
commit cbea4264ea
3359 changed files with 64705 additions and 6301 deletions
@@ -8,8 +8,8 @@ use Appwrite\Event\Event;
 use Appwrite\Event\Func;
 use Appwrite\Event\Mail;
 use Appwrite\Extend\Exception;
-use Appwrite\Event\Usage;
 use Appwrite\Messaging\Adapter\Realtime;
+use Appwrite\Usage\Stats;
 use Appwrite\Utopia\Response;
 use Appwrite\Utopia\Request;
 use Utopia\App;
@@ -48,99 +48,43 @@ $parseLabel = function (string $label, array $responsePayload, array $requestPar
    return $label;
 };

-$databaseListener = function (string $event, Document $document, Document $project, Usage $queueForUsage, Database $dbForProject) {
-
-    $value = 1;
+$databaseListener = function (string $event, Document $document, Stats $usage) {
+    $multiplier = 1;
    if ($event === Database::EVENT_DOCUMENT_DELETE) {
-        $value = -1;
+        $multiplier = -1;
    }

-    switch (true) {
-        case $document->getCollection() === 'teams':
-            $queueForUsage
-                ->addMetric(METRIC_TEAMS, $value); // per project
+    $collection = $document->getCollection();
+    switch ($collection) {
+        case 'users':
+            $usage->setParam('users.{scope}.count.total', 1 * $multiplier);
            break;
-        case $document->getCollection() === 'users':
-            $queueForUsage
-                ->addMetric(METRIC_USERS, $value); // per project
-            if ($event === Database::EVENT_DOCUMENT_DELETE) {
-                $queueForUsage
-                    ->addReduce($document);
-            }
+        case 'databases':
+            $usage->setParam('databases.{scope}.count.total', 1 * $multiplier);
            break;
-        case $document->getCollection() === 'sessions': // sessions
-            $queueForUsage
-                ->addMetric(METRIC_SESSIONS, $value); //per project
+        case 'buckets':
+            $usage->setParam('buckets.{scope}.count.total', 1 * $multiplier);
            break;
-        case $document->getCollection() === 'databases': // databases
-            $queueForUsage
-                ->addMetric(METRIC_DATABASES, $value); // per project
-
-            if ($event === Database::EVENT_DOCUMENT_DELETE) {
-                $queueForUsage
-                    ->addReduce($document);
-            }
-            break;
-        case str_starts_with($document->getCollection(), 'database_') && !str_contains($document->getCollection(), 'collection'): //collections
-            $parts = explode('_', $document->getCollection());
-            $databaseInternalId = $parts[1] ?? 0;
-            $queueForUsage
-                ->addMetric(METRIC_COLLECTIONS, $value) // per project
-                ->addMetric(str_replace('{databaseInternalId}', $databaseInternalId, METRIC_DATABASE_ID_COLLECTIONS), $value) // per database
-            ;
-
-            if ($event === Database::EVENT_DOCUMENT_DELETE) {
-                $queueForUsage
-                    ->addReduce($document);
-            }
-            break;
-        case str_starts_with($document->getCollection(), 'database_') && str_contains($document->getCollection(), '_collection_'): //documents
-            $parts = explode('_', $document->getCollection());
-            $databaseInternalId   = $parts[1] ?? 0;
-            $collectionInternalId = $parts[3] ?? 0;
-            $queueForUsage
-                ->addMetric(METRIC_DOCUMENTS, $value)  // per project
-                ->addMetric(str_replace('{databaseInternalId}', $databaseInternalId, METRIC_DATABASE_ID_DOCUMENTS), $value) // per database
-                ->addMetric(str_replace(['{databaseInternalId}', '{collectionInternalId}'], [$databaseInternalId, $collectionInternalId], METRIC_DATABASE_ID_COLLECTION_ID_DOCUMENTS), $value);  // per collection
-            break;
-        case $document->getCollection() === 'buckets': //buckets
-            $queueForUsage
-                ->addMetric(METRIC_BUCKETS, $value); // per project
-            if ($event === Database::EVENT_DOCUMENT_DELETE) {
-                $queueForUsage
-                    ->addReduce($document);
-            }
-            break;
-        case str_starts_with($document->getCollection(), 'bucket_'): // files
-            $queueForUsage
-                ->addMetric(METRIC_FILES, $value) // per project
-                ->addMetric(METRIC_FILES_STORAGE, $document->getAttribute('sizeOriginal') * $value) // per project
-                ->addMetric(str_replace('{bucketInternalId}', $document->getAttribute('bucketInternalId'), METRIC_BUCKET_ID_FILES), $value) // per bucket
-                ->addMetric(str_replace('{bucketInternalId}', $document->getAttribute('bucketInternalId'), METRIC_BUCKET_ID_FILES_STORAGE), $document->getAttribute('sizeOriginal') * $value); // per bucket
-            break;
-        case $document->getCollection() === 'functions':
-            $queueForUsage
-                ->addMetric(METRIC_FUNCTIONS, $value); // per project
-
-            if ($event === Database::EVENT_DOCUMENT_DELETE) {
-                $queueForUsage
-                    ->addReduce($document);
-            }
-            break;
-        case $document->getCollection() === 'deployments':
-            $queueForUsage
-                ->addMetric(METRIC_DEPLOYMENTS, $value) // per project
-                ->addMetric(METRIC_DEPLOYMENTS_STORAGE, $document->getAttribute('size') * $value) // per project
-                ->addMetric(str_replace(['{resourceType}', '{resourceInternalId}'], [$document->getAttribute('resourceType'), $document->getAttribute('resourceInternalId')], METRIC_FUNCTION_ID_DEPLOYMENTS), $value)// per function
-                ->addMetric(str_replace(['{resourceType}', '{resourceInternalId}'], [$document->getAttribute('resourceType'), $document->getAttribute('resourceInternalId')], METRIC_FUNCTION_ID_DEPLOYMENTS_STORAGE), $document->getAttribute('size') * $value);// per function
-
-            break;
-        case $document->getCollection() === 'executions':
-            $queueForUsage
-                ->addMetric(METRIC_EXECUTIONS, $value) // per project
-                ->addMetric(str_replace('{functionInternalId}', $document->getAttribute('functionInternalId'), METRIC_FUNCTION_ID_EXECUTIONS), $value);// per function
+        case 'deployments':
+            $usage->setParam('deployments.{scope}.storage.size', $document->getAttribute('size') * $multiplier);
            break;
        default:
+            if (strpos($collection, 'bucket_') === 0) {
+                $usage
+                    ->setParam('bucketId', $document->getAttribute('bucketId'))
+                    ->setParam('files.{scope}.storage.size', $document->getAttribute('sizeOriginal') * $multiplier)
+                    ->setParam('files.{scope}.count.total', 1 * $multiplier);
+            } elseif (strpos($collection, 'database_') === 0) {
+                $usage
+                    ->setParam('databaseId', $document->getAttribute('databaseId'));
+                if (strpos($collection, '_collection_') !== false) {
+                    $usage
+                        ->setParam('collectionId', $document->getAttribute('$collectionId'))
+                        ->setParam('documents.{scope}.count.total', 1 * $multiplier);
+                } else {
+                    $usage->setParam('collections.{scope}.count.total', 1 * $multiplier);
+                }
+            }
            break;
    }
 };
@@ -157,12 +101,12 @@ App::init()
    ->inject('deletes')
    ->inject('database')
    ->inject('dbForProject')
-    ->inject('queueForUsage')
    ->inject('mode')
    ->inject('mails')
-    ->action(function (App $utopia, Request $request, Response $response, Document $project, Document $user, Event $events, Audit $audits, Delete $deletes, EventDatabase $database, Database $dbForProject, Usage $queueForUsage, string $mode, Mail $mails) use ($databaseListener) {
+    ->inject('usage')
+    ->action(function (App $utopia, Request $request, Response $response, Document $project, Document $user, Event $events, Audit $audits, Delete $deletes, EventDatabase $database, Database $dbForProject, string $mode, Mail $mails, Stats $usage) use ($databaseListener) {

-        $route = $utopia->match($request);
+        $route = $utopia->getRoute();

        if ($project->isEmpty() && $route->getLabel('abuse-limit', 0) > 0) { // Abuse limit requires an active project scope
            throw new Exception(Exception::PROJECT_UNKNOWN);
@@ -242,25 +186,19 @@ App::init()
            ->setProject($project)
            ->setUser($user);

-        $smtp = $project->getAttribute('smtp', []);
-        if (!empty($smtp) && ($smtp['enabled'] ?? false)) {
-            $mails
-                ->setSmtpHost($smtp['host'] ?? '')
-                ->setSmtpPort($smtp['port'] ?? 25)
-                ->setSmtpUsername($smtp['username'] ?? '')
-                ->setSmtpPassword($smtp['password'] ?? '')
-                ->setSmtpSenderEmail($smtp['sender'] ?? '')
-                ->setSmtpReplyTo($smtp['replyTo'] ?? '');
-        }
+        $usage
+            ->setParam('projectInternalId', $project->getInternalId())
+            ->setParam('projectId', $project->getId())
+            ->setParam('project.{scope}.network.requests', 1)
+            ->setParam('httpMethod', $request->getMethod())
+            ->setParam('project.{scope}.network.inbound', 0)
+            ->setParam('project.{scope}.network.outbound', 0);

        $deletes->setProject($project);
        $database->setProject($project);

-        $calculateUsage = fn ($event, Document $document) => $databaseListener($event, $document, $project, $queueForUsage, $dbForProject);
-
-        $dbForProject
-            ->on(Database::EVENT_DOCUMENT_CREATE, 'calculate-usage', $calculateUsage)
-            ->on(Database::EVENT_DOCUMENT_DELETE, 'calculate-usage', $calculateUsage);
+        $dbForProject->on(Database::EVENT_DOCUMENT_CREATE, 'calculate-usage', fn ($event, Document $document) => $databaseListener($event, $document, $usage));
+        $dbForProject->on(Database::EVENT_DOCUMENT_DELETE, 'calculate-usage', fn ($event, Document $document) => $databaseListener($event, $document, $usage));

        $useCache = $route->getLabel('cache', false);

@@ -282,7 +220,10 @@ App::init()

                    $bucket = Authorization::skip(fn () => $dbForProject->getDocument('buckets', $bucketId));

-                    if ($bucket->isEmpty() || (!$bucket->getAttribute('enabled') && $mode !== APP_MODE_ADMIN)) {
+                    $isAPIKey = Auth::isAppUser(Authorization::getRoles());
+                    $isPrivilegedUser = Auth::isPrivilegedUser(Authorization::getRoles());
+
+                    if ($bucket->isEmpty() || (!$bucket->getAttribute('enabled') && !$isAPIKey && !$isPrivilegedUser)) {
                        throw new Exception(Exception::STORAGE_BUCKET_NOT_FOUND);
                    }

@@ -328,7 +269,7 @@ App::init()
    ->inject('project')
    ->action(function (App $utopia, Request $request, Document $project) {

-        $route = $utopia->match($request);
+        $route = $utopia->getRoute();

        $isPrivilegedUser = Auth::isPrivilegedUser(Authorization::getRoles());
        $isAppUser = Auth::isAppUser(Authorization::getRoles());
@@ -423,14 +364,14 @@ App::shutdown()
    ->inject('user')
    ->inject('events')
    ->inject('audits')
+    ->inject('usage')
    ->inject('deletes')
    ->inject('database')
    ->inject('dbForProject')
    ->inject('queueForFunctions')
-    ->inject('queueForUsage')
    ->inject('mode')
    ->inject('dbForConsole')
-    ->action(function (App $utopia, Request $request, Response $response, Document $project, Document $user, Event $events, Audit $audits, Delete $deletes, EventDatabase $database, Database $dbForProject, Func $queueForFunctions, Usage $queueForUsage, string $mode, Database $dbForConsole) use ($parseLabel) {
+    ->action(function (App $utopia, Request $request, Response $response, Document $project, Document $user, Event $events, Audit $audits, Stats $usage, Delete $deletes, EventDatabase $database, Database $dbForProject, Func $queueForFunctions, string $mode, Database $dbForConsole) use ($parseLabel) {

        $responsePayload = $response->getPayload();

@@ -489,7 +430,7 @@ App::shutdown()
            }
        }

-        $route = $utopia->match($request);
+        $route = $utopia->getRoute();
        $requestParams = $route->getParamsValues();

        /**
@@ -583,48 +524,35 @@ App::shutdown()
            }
        }

+        if (
+            App::getEnv('_APP_USAGE_STATS', 'enabled') == 'enabled'
+            && $project->getId()
+            && !empty($route->getLabel('sdk.namespace', null))
+        ) { // Don't calculate console usage on admin mode
+            $metric = $route->getLabel('usage.metric', '');
+            $usageParams = $route->getLabel('usage.params', []);

-
-        if ($project->getId() !== 'console') {
-            if ($mode !== APP_MODE_ADMIN) {
-                $fileSize = 0;
-                $file = $request->getFiles('file');
-                if (!empty($file)) {
-                    $fileSize = (\is_array($file['size']) && isset($file['size'][0])) ? $file['size'][0] : $file['size'];
-                }
-
-                $queueForUsage
-                    ->addMetric(METRIC_NETWORK_REQUESTS, 1)
-                    ->addMetric(METRIC_NETWORK_INBOUND, $request->getSize() + $fileSize)
-                    ->addMetric(METRIC_NETWORK_OUTBOUND, $response->getSize());
-            }
-
-            $queueForUsage
-                ->setProject($project)
-                ->trigger();
-        }
-
-        /**
-         * Update user last activity
-         */
-        if (!$user->isEmpty()) {
-            $accessedAt = $user->getAttribute('accessedAt', '');
-            if (DateTime::formatTz(DateTime::addSeconds(new \DateTime(), -APP_USER_ACCCESS)) > $accessedAt) {
-                $user->setAttribute('accessedAt', DateTime::now());
-
-                if (APP_MODE_ADMIN !== $mode) {
-                    $dbForProject->updateDocument('users', $user->getId(), $user);
-                } else {
-                    $dbForConsole->updateDocument('users', $user->getId(), $user);
+            if (!empty($metric)) {
+                $usage->setParam($metric, 1);
+                foreach ($usageParams as $param) {
+                    $param = $parseLabel($param, $responsePayload, $requestParams, $user);
+                    $parts = explode(':', $param);
+                    if (count($parts) != 2) {
+                        throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Usage params not properly set');
+                    }
+                    $usage->setParam($parts[0], $parts[1]);
                }
            }
-        }
-    });

-App::init()
-    ->groups(['usage'])
-    ->action(function () {
-        if (App::getEnv('_APP_USAGE_STATS', 'enabled') !== 'enabled') {
-            throw new Exception(Exception::GENERAL_USAGE_DISABLED);
+            $fileSize = 0;
+            $file = $request->getFiles('file');
+            if (!empty($file)) {
+                $fileSize = (\is_array($file['size']) && isset($file['size'][0])) ? $file['size'][0] : $file['size'];
+            }
+
+            $usage
+                ->setParam('project.{scope}.network.inbound', $request->getSize() + $fileSize)
+                ->setParam('project.{scope}.network.outbound', $response->getSize())
+                ->submit();
        }
    });