Merge pull request #268 from utopia-php/feat-base-exception

Feat base exception
utopia-php · May 22, 2023 · 3e7c866 · 3e7c866
2 parents 69a844c + 1911052
commit 3e7c866
Show file tree

Hide file tree

Showing 26 changed files with 428 additions and 340 deletions.
diff --git a/composer.json b/composer.json
@@ -37,8 +37,6 @@
         "utopia-php/mongo": "0.2.*"
     },
     "require-dev": {
-        "ext-redis": "*",
-        "ext-mongodb": "*",
         "fakerphp/faker": "^1.14",
         "phpunit/phpunit": "^9.4",
         "pcov/clobber": "^2.0",

diff --git a/composer.lock b/composer.lock
diff --git a/docs/add-new-adapter.md b/docs/add-new-adapter.md
@@ -31,7 +31,7 @@ Create your `NewDB.php` file in `src/Database/Adapter/` and extend the parent cl
 
 namespace Utopia\Database\Adapter;
 
-use Exception;
+use Utopia\Database\Exception;
 use Utopia\Database\Adapter;
 use Utopia\Database\Database;
 use Utopia\Database\Document;

diff --git a/src/Database/Adapter.php b/src/Database/Adapter.php
@@ -3,6 +3,7 @@
 namespace Utopia\Database;
 
 use Exception;
+use Utopia\Database\Exception as DatabaseException;
 
 abstract class Adapter
 {
@@ -66,7 +67,7 @@ public function resetDebug(): self
     public function setNamespace(string $namespace): bool
     {
         if (empty($namespace)) {
-            throw new Exception('Missing namespace');
+            throw new DatabaseException('Missing namespace');
         }
 
         $this->namespace = $this->filter($namespace);
@@ -80,13 +81,13 @@ public function setNamespace(string $namespace): bool
      * Get namespace of current set scope
      *
      * @return string
-     * @throws Exception
+     * @throws DatabaseException
      *
      */
     public function getNamespace(): string
     {
         if (empty($this->namespace)) {
-            throw new Exception('Missing namespace');
+            throw new DatabaseException('Missing namespace');
         }
 
         return $this->namespace;
@@ -106,7 +107,7 @@ public function getNamespace(): string
     public function setDefaultDatabase(string $name, bool $reset = false): bool
     {
         if (empty($name) && $reset === false) {
-            throw new Exception('Missing database');
+            throw new DatabaseException('Missing database');
         }
 
         $this->defaultDatabase = ($reset) ? '' : $this->filter($name);
@@ -126,7 +127,7 @@ public function setDefaultDatabase(string $name, bool $reset = false): bool
     public function getDefaultDatabase(): string
     {
         if (empty($this->defaultDatabase)) {
-            throw new Exception('Missing default database');
+            throw new DatabaseException('Missing default database');
         }
 
         return $this->defaultDatabase;
@@ -589,7 +590,7 @@ public function filter(string $value): string
         $value = preg_replace("/[^A-Za-z0-9\_\-]/", '', $value);
 
         if (\is_null($value)) {
-            throw new Exception('Failed to filter key');
+            throw new DatabaseException('Failed to filter key');
         }
 
         return $value;

diff --git a/src/Database/Adapter/MariaDB.php b/src/Database/Adapter/MariaDB.php
@@ -5,6 +5,7 @@
 use Exception;
 use PDO;
 use PDOException;
+use Utopia\Database\Exception as DatabaseException;
 use Utopia\Database\Database;
 use Utopia\Database\Document;
 use Utopia\Database\Exception\Duplicate;
@@ -297,7 +298,7 @@ public function createRelationship(
             case Database::RELATION_MANY_TO_MANY:
                 return true;
             default:
-                throw new Exception('Invalid relationship type.');
+                throw new DatabaseException('Invalid relationship type');
         }
 
         return $this->getPDO()
@@ -376,7 +377,7 @@ public function updateRelationship(
                 }
                 break;
             default:
-                throw new Exception('Invalid relationship type.');
+                throw new DatabaseException('Invalid relationship type');
         }
 
         if (empty($sql)) {
@@ -442,7 +443,7 @@ public function deleteRelationship(
                 $sql = "DROP TABLE {$junction}; DROP TABLE {$perms}";
                 break;
             default:
-                throw new Exception('Invalid relationship type.');
+                throw new DatabaseException('Invalid relationship type');
         }
 
         if (empty($sql)) {
@@ -624,7 +625,7 @@ public function createDocument(string $collection, Document $document): Document
         }
 
         if (!$this->getPDO()->commit()) {
-            throw new Exception('Failed to commit transaction');
+            throw new DatabaseException('Failed to commit transaction');
         }
 
         return $document;
@@ -810,7 +811,7 @@ public function updateDocument(string $collection, Document $document): Document
         }
 
         if (!$this->getPDO()->commit()) {
-            throw new Exception('Failed to commit transaction');
+            throw new DatabaseException('Failed to commit transaction');
         }
 
         return $document;
@@ -841,7 +842,7 @@ public function increaseDocumentAttribute(string $collection, string $id, string
         $stmt->bindValue(':_uid', $id);
         $stmt->bindValue(':val', $value);
 
-        $stmt->execute() || throw new Exception('Failed to update Attribute');
+        $stmt->execute() || throw new DatabaseException('Failed to update attribute');
         return true;
     }
 
@@ -867,15 +868,15 @@ public function deleteDocument(string $collection, string $id): bool
         $stmtPermissions->bindValue(':_uid', $id);
 
         try {
-            $stmt->execute() || throw new Exception('Failed to delete document');
-            $stmtPermissions->execute() || throw new Exception('Failed to clean permissions');
+            $stmt->execute() || throw new DatabaseException('Failed to delete document');
+            $stmtPermissions->execute() || throw new DatabaseException('Failed to clean permissions');
         } catch (\Throwable $th) {
             $this->getPDO()->rollBack();
-            throw new Exception($th->getMessage());
+            throw new DatabaseException($th->getMessage());
         }
 
         if (!$this->getPDO()->commit()) {
-            throw new Exception('Failed to commit transaction');
+            throw new DatabaseException('Failed to commit transaction');
         }
 
         return true;
@@ -1024,7 +1025,7 @@ public function find(string $collection, array $queries = [], ?int $limit = 25,
             };
 
             if (is_null($cursor[$attribute] ?? null)) {
-                throw new Exception("Order attribute '{$attribute}' is empty.");
+                throw new DatabaseException("Order attribute '{$attribute}' is empty");
             }
             $stmt->bindValue(':cursor', $cursor[$attribute], $this->getPDOType($cursor[$attribute]));
         }
@@ -1305,7 +1306,7 @@ protected function getSQLType(string $type, int $size, bool $signed = true): str
                 return 'DATETIME(3)';
 
             default:
-                throw new Exception('Unknown Type');
+                throw new DatabaseException('Unknown type: ' . $type . '. Must be one of ' . Database::VAR_STRING . ', ' . Database::VAR_INTEGER .  ', ' . Database::VAR_FLOAT . ', ' . Database::VAR_BOOLEAN . ', ' . Database::VAR_DATETIME . ', ' . Database::VAR_RELATIONSHIP);
         }
     }
 
@@ -1322,10 +1323,11 @@ protected function getSQLType(string $type, int $size, bool $signed = true): str
     protected function getSQLIndex(string $collection, string $id, string $type, array $attributes): string
     {
         $type = match ($type) {
-            Database::INDEX_KEY, Database::INDEX_ARRAY => 'INDEX',
+            Database::INDEX_KEY,
+            Database::INDEX_ARRAY => 'INDEX',
             Database::INDEX_UNIQUE => 'UNIQUE INDEX',
             Database::INDEX_FULLTEXT => 'FULLTEXT INDEX',
-            default => throw new Exception('Unknown Index Type:' . $type),
+            default => throw new DatabaseException('Unknown index type: ' . $type . '. Must be one of ' . Database::INDEX_KEY . ', ' . Database::INDEX_UNIQUE . ', ' . Database::INDEX_ARRAY . ', ' . Database::INDEX_FULLTEXT),
         };
 
         return "CREATE {$type} `{$id}` ON {$this->getSQLTable($collection)} ( " . implode(', ', $attributes) . " )";
@@ -1344,7 +1346,7 @@ protected function getPDOType(mixed $value): int
             'double', 'string' => PDO::PARAM_STR,
             'integer', 'boolean' => PDO::PARAM_INT,
             'NULL' => PDO::PARAM_NULL,
-            default => throw new Exception('Unknown PDO Type for ' . gettype($value)),
+            default => throw new DatabaseException('Unknown PDO Type for ' . \gettype($value)),
         };
     }