Merge pull request #880 from utopia-php/skip-silent-hooks

Add SQL trigger in getDocument

Author: abnegate

src/Database/Adapter/SQL.php

@@ -394,6 +394,8 @@ public function getDocument(Document $collection, string $id, array $queries = [
             $sql .= " {$forUpdate}";
         }
 
+        $sql = $this->trigger(Database::EVENT_DOCUMENT_READ, $sql);
+
         $stmt = $this->getPDO()->prepare($sql);
 
         $stmt->bindValue(':_uid', $id);

src/Database/Database.php

@@ -732,10 +732,10 @@ public function on(string $event, string $name, ?callable $callback): static
      *
      * @param string $event
      * @param string $name
-     * @param callable $callback
+     * @param ?callable $callback
      * @return $this
      */
-    public function before(string $event, string $name, callable $callback): static
+    public function before(string $event, string $name, ?callable $callback): static
     {
         $this->adapter->before($event, $name, $callback);
 

tests/e2e/Adapter/Scopes/CollectionTests.php

@@ -3,6 +3,7 @@
 namespace Tests\E2E\Adapter\Scopes;
 
 use Exception;
+use Utopia\Database\Adapter\SQL;
 use Utopia\Database\Database;
 use Utopia\Database\Document;
 use Utopia\Database\Exception as DatabaseException;
@@ -1670,13 +1671,25 @@ public function testTransformations(): void
             'name' => 'value1',
         ]));
 
-        $database->before(Database::EVENT_DOCUMENT_READ, 'test', function (string $query) {
-            return "SELECT 1";
+        $database->setMetadata('scope', 'api.users');
+
+        $capturedSql = '';
+        $database->before(Database::EVENT_DOCUMENT_READ, 'test', function (string $sql) use (&$capturedSql) {
+            $sql .= ' AND 1=0';
+            $capturedSql = $sql;
+            return $sql;
         });
 
         $result = $database->getDocument('docs', 'doc1');
 
         $this->assertTrue($result->isEmpty());
+
+        if ($database->getAdapter() instanceof SQL) {
+            $this->assertStringContainsString('/* scope: api.users */', $capturedSql);
+        }
+
+        $database->before(Database::EVENT_DOCUMENT_READ, 'test', null);
+        $database->resetMetadata();
     }
 
     public function testSetGlobalCollection(): void