Merge pull request #303 from utopia-php/chore-rename-setTimeout-funct…

…ions rename setTimeout methods
utopia-php · Aug 9, 2023 · 8eab2af · 8eab2af
2 parents fb7435a + 3e2c4b9
commit 8eab2af
Show file tree

Hide file tree

Showing 7 changed files with 57 additions and 56 deletions.
diff --git a/composer.lock b/composer.lock
diff --git a/src/Database/Adapter.php b/src/Database/Adapter.php
@@ -659,7 +659,7 @@ abstract public function getMaxIndexLength(): int;
      *
      * @throws \Exception The provided timeout value must be greater than or equal to 0.
     */
-    public static function setTimeoutForQueries(int $milliseconds): void
+    public static function setTimeout(int $milliseconds): void
     {
         if ($milliseconds <= 0) {
             throw new Exception('Timeout must be greater than 0');
@@ -673,7 +673,7 @@ public static function setTimeoutForQueries(int $milliseconds): void
      * @return void
      *
     */
-    public static function clearTimeoutForQueries(): void
+    public static function clearTimeout(): void
     {
         self::$timeout = null;
     }

diff --git a/src/Database/Adapter/MariaDB.php b/src/Database/Adapter/MariaDB.php
@@ -1006,7 +1006,7 @@ public function find(string $collection, array $queries = [], ?int $limit = 25,
         ";
 
         if ($timeout || static::$timeout) {
-            $sql = $this->setTimeout($sql, $timeout ? $timeout : static::$timeout);
+            $sql = $this->setTimeoutForQuery($sql, $timeout ? $timeout : static::$timeout);
         }
 
         $stmt = $this->getPDO()->prepare($sql);
@@ -1104,7 +1104,7 @@ public function count(string $collection, array $queries = [], ?int $max = null,
                 ) table_count
         ";
         if ($timeout || self::$timeout) {
-            $sql = $this->setTimeout($sql, $timeout ? $timeout : self::$timeout);
+            $sql = $this->setTimeoutForQuery($sql, $timeout ? $timeout : self::$timeout);
         }
 
         $stmt = $this->getPDO()->prepare($sql);
@@ -1160,7 +1160,7 @@ public function sum(string $collection, string $attribute, array $queries = [],
                 ) table_count
         ";
         if ($timeout || self::$timeout) {
-            $sql = $this->setTimeout($sql, $timeout ? $timeout : self::$timeout);
+            $sql = $this->setTimeoutForQuery($sql, $timeout ? $timeout : self::$timeout);
         }
 
         $stmt = $this->getPDO()->prepare($sql);
@@ -1377,7 +1377,7 @@ public function getSupportForTimeouts(): bool
      * @param int $milliseconds
      * @return string
      */
-    protected function setTimeout(string $sql, int $milliseconds): string
+    protected function setTimeoutForQuery(string $sql, int $milliseconds): string
     {
         if (!$this->getSupportForTimeouts()) {
             return $sql;

diff --git a/src/Database/Adapter/MySQL.php b/src/Database/Adapter/MySQL.php
@@ -56,7 +56,7 @@ protected function getSQLIndex(string $collection, string $id, string $type, arr
      * @param int $milliseconds
      * @return string
      */
-    protected function setTimeOut(string $sql, int $milliseconds): string
+    protected function setTimeoutForQuery(string $sql, int $milliseconds): string
     {
         return preg_replace('/SELECT/', "SELECT /*+ max_execution_time({$milliseconds}) */", $sql, 1);
     }

diff --git a/src/Database/Adapter/Postgres.php b/src/Database/Adapter/Postgres.php
@@ -1016,7 +1016,7 @@ public function find(string $collection, array $queries = [], ?int $limit = 25,
         ";
 
         if ($timeout || self::$timeout) {
-            $sql = $this->setTimeout($sql, $timeout ? $timeout : self::$timeout);
+            $sql = $this->setTimeoutForQuery($sql, $timeout ? $timeout : self::$timeout);
         }
 
         $stmt = $this->getPDO()->prepare($sql);
@@ -1116,7 +1116,7 @@ public function count(string $collection, array $queries = [], ?int $max = null,
         ";
 
         if ($timeout || self::$timeout) {
-            $sql = $this->setTimeout($sql, $timeout ? $timeout : self::$timeout);
+            $sql = $this->setTimeoutForQuery($sql, $timeout ? $timeout : self::$timeout);
         }
 
         $stmt = $this->getPDO()->prepare($sql);
@@ -1175,7 +1175,7 @@ public function sum(string $collection, string $attribute, array $queries = [],
         ";
 
         if ($timeout || self::$timeout) {
-            $sql = $this->setTimeout($sql, $timeout ? $timeout : self::$timeout);
+            $sql = $this->setTimeoutForQuery($sql, $timeout ? $timeout : self::$timeout);
         }
 
         $stmt = $this->getPDO()->prepare($sql);
@@ -1466,7 +1466,7 @@ public function getSupportForTimeouts(): bool
      * @param int $milliseconds
      * @return string
      */
-    protected function setTimeout(string $sql, int $milliseconds): string
+    protected function setTimeoutForQuery(string $sql, int $milliseconds): string
     {
         return "SET statement_timeout = {$milliseconds};{$sql};SET statement_timeout = 0;";
     }

diff --git a/src/Database/Database.php b/src/Database/Database.php
@@ -4241,14 +4241,14 @@ public function sum(string $collection, string $attribute, array $queries = [],
         return $sum;
     }
 
-    public function setTimeoutForQueries(int $milliseconds): void
+    public function setTimeout(int $milliseconds): void
     {
-        $this->adapter->setTimeoutForQueries($milliseconds);
+        $this->adapter->setTimeout($milliseconds);
     }
 
-    public function clearTimeoutForQueries(): void
+    public function clearTimeout(): void
     {
-        $this->adapter->clearTimeoutForQueries();
+        $this->adapter->clearTimeout();
     }
     /**
      * Add Attribute Filter

diff --git a/tests/Database/Base.php b/tests/Database/Base.php
@@ -241,14 +241,14 @@ public function testQueryTimeoutUsingStaticTimeout(): void
             }
 
             $this->expectException(Timeout::class);
-            static::getDatabase()->setTimeoutForQueries(1);
+            static::getDatabase()->setTimeout(1);
 
             try {
                 static::getDatabase()->find('global-timeouts', [
                     Query::notEqual('longtext', 'appwrite'),
                 ]);
             } catch(Timeout $ex) {
-                static::getDatabase()->clearTimeoutForQueries();
+                static::getDatabase()->clearTimeout();
                 static::getDatabase()->deleteCollection('global-timeouts');
                 throw $ex;
             }