From 1eee0baa286f066ffc69ff6e2e62de72423d76be Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Matej=20Ba=C4=8Do?= <matejbaco2000@gmail.com>
Date: Tue, 23 Aug 2022 09:02:06 +0000
Subject: [PATCH] Upgrade listFunctions queries

---
 app/controllers/api/functions.php             | 36 ++++++++++---------
 .../Database/Validator/Queries/Functions.php  | 32 +++++++++++++++++
 2 files changed, 51 insertions(+), 17 deletions(-)
 create mode 100644 src/Appwrite/Utopia/Database/Validator/Queries/Functions.php

diff --git a/app/controllers/api/functions.php b/app/controllers/api/functions.php
index 2c38a529eb..9f79d77f93 100644
--- a/app/controllers/api/functions.php
+++ b/app/controllers/api/functions.php
@@ -22,6 +22,7 @@ use Utopia\Storage\Validator\Upload;
 use Appwrite\Utopia\Response;
 use Utopia\Swoole\Request;
 use Appwrite\Task\Validator\Cron;
+use Appwrite\Utopia\Database\Validator\Queries\Functions;
 use Utopia\App;
 use Utopia\Database\Database;
 use Utopia\Database\Document;
@@ -102,38 +103,39 @@ App::get('/v1/functions')
     ->label('sdk.response.code', Response::STATUS_CODE_OK)
     ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
     ->label('sdk.response.model', Response::MODEL_FUNCTION_LIST)
+    ->param('queries', [], new Functions(), 'Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of ' . APP_LIMIT_ARRAY_PARAMS_SIZE . ' queries are allowed, each ' . APP_LIMIT_ARRAY_ELEMENT_SIZE . ' characters long. You may filter on the following attributes: ' . implode(', ', Functions::ALLOWED_ATTRIBUTES), true)
     ->param('search', '', new Text(256), 'Search term to filter your list results. Max length: 256 chars.', true)
-    ->param('limit', 25, new Range(0, 100), 'Maximum number of functions to return in response. By default will return maximum 25 results. Maximum of 100 results allowed per request.', true)
-    ->param('offset', 0, new Range(0, APP_LIMIT_COUNT), 'Offset value. The default value is 0. Use this value to manage pagination. [learn more about pagination](https://appwrite.io/docs/pagination)', true)
-    ->param('cursor', '', new UID(), 'ID of the function used as the starting point for the query, excluding the function itself. Should be used for efficient pagination when working with large sets of data. [learn more about pagination](https://appwrite.io/docs/pagination)', true)
-    ->param('cursorDirection', Database::CURSOR_AFTER, new WhiteList([Database::CURSOR_AFTER, Database::CURSOR_BEFORE]), 'Direction of the cursor, can be either \'before\' or \'after\'.', true)
-    ->param('orderType', Database::ORDER_ASC, new WhiteList([Database::ORDER_ASC, Database::ORDER_DESC], true), 'Order result by ' . Database::ORDER_ASC . ' or ' . Database::ORDER_DESC . ' order.', true)
     ->inject('response')
     ->inject('dbForProject')
-    ->action(function (string $search, int $limit, int $offset, string $cursor, string $cursorDirection, string $orderType, Response $response, Database $dbForProject) {
+    ->action(function (array $queries, string $search, Response $response, Database $dbForProject) {
 
-        $filterQueries = [];
+        $queries = Query::parseQueries($queries);
 
         if (!empty($search)) {
-            $filterQueries[] = Query::search('search', $search);
+            $queries[] = Query::search('search', $search);
         }
 
-        $queries = [];
-        $queries[] = Query::limit($limit);
-        $queries[] = Query::offset($offset);
-        $queries[] = $orderType === Database::ORDER_ASC ? Query::orderAsc('') : Query::orderDesc('');
-        if (!empty($cursor)) {
-            $cursorDocument = $dbForProject->getDocument('functions', $cursor);
+        // Set default limit
+        $queries[] = Query::limit(25);
+
+        // Get cursor document if there was a cursor query
+        $cursor = Query::getByType($queries, Query::TYPE_CURSORAFTER, Query::TYPE_CURSORBEFORE)[0] ?? null;
+        if ($cursor !== null) {
+            /** @var Query $cursor */
+            $functionId = $cursor->getValue();
+            $cursorDocument = $dbForProject->getDocument('functions', $functionId);
 
             if ($cursorDocument->isEmpty()) {
-                throw new Exception(Exception::GENERAL_CURSOR_NOT_FOUND, "Function '{$cursor}' for the 'cursor' value not found.");
+                throw new Exception(Exception::GENERAL_CURSOR_NOT_FOUND, "Function '{$functionId}' for the 'cursor' value not found.");
             }
 
-            $queries[] = $cursorDirection === Database::CURSOR_AFTER ? Query::cursorAfter($cursorDocument) : Query::cursorBefore($cursorDocument);
+            $cursor->setValue($cursorDocument);
         }
 
+        $filterQueries = Query::groupByType($queries)['filters'];
+
         $response->dynamic(new Document([
-            'functions' => $dbForProject->find('functions', \array_merge($filterQueries, $queries)),
+            'functions' => $dbForProject->find('functions', $queries),
             'total' => $dbForProject->count('functions', $filterQueries, APP_LIMIT_COUNT),
         ]), Response::MODEL_FUNCTION_LIST);
     });
diff --git a/src/Appwrite/Utopia/Database/Validator/Queries/Functions.php b/src/Appwrite/Utopia/Database/Validator/Queries/Functions.php
new file mode 100644
index 0000000000..8a08a8371a
--- /dev/null
+++ b/src/Appwrite/Utopia/Database/Validator/Queries/Functions.php
@@ -0,0 +1,32 @@
+<?php
+
+namespace Appwrite\Utopia\Database\Validator\Queries;
+
+use Appwrite\Utopia\Database\Validator\Queries\Collection;
+
+class Functions extends Collection
+{
+    public const ALLOWED_ATTRIBUTES = [
+        '$id',
+        '$createdAt',
+        '$updatedAt',
+        
+        'name',
+        'status',
+        'runtime',
+        'deployment',
+        'schedule',
+        'scheduleNext',
+        'schedulePrevious',
+        'timeout'
+    ];
+
+    /**
+     * Expression constructor
+     *
+     */
+    public function __construct()
+    {
+        parent::__construct('functions', self::ALLOWED_ATTRIBUTES);
+    }
+}