docs: add comments to events passing

app/controllers/shared/api.php

@@ -221,6 +221,7 @@ App::shutdown(function ($utopia, $request, $response, $project, $events, $audits
             $bucket = ($trigger && $trigger->getCollection() === 'buckets') ? $trigger : null;
 
             $target = Realtime::fromPayload(
+                // Pass first, most verbose event pattern
                 event: $allEvents[0],
                 payload: $payload,
                 project: $project,

app/workers/audits.php

@@ -6,14 +6,15 @@ use Utopia\Audit\Audit;
 use Utopia\CLI\Console;
 use Utopia\Database\Document;
 
-require_once __DIR__.'/../init.php';
+require_once __DIR__ . '/../init.php';
 
 Console::title('Audits V1 Worker');
 Console::success(APP_NAME . ' audits worker v1 has started');
 
 class AuditsV1 extends Worker
 {
-    public function getName(): string {
+    public function getName(): string
+    {
         return "audits";
     }
 
@@ -36,16 +37,23 @@ class AuditsV1 extends Worker
         $userName = $user->getAttribute('name', '');
         $userEmail = $user->getAttribute('email', '');
 
-        $event = $events[0];
-
         $dbForProject = $this->getProjectDB($project->getId());
         $audit = new Audit($dbForProject);
-        $audit->log($user->getId(), $event, $resource, $userAgent, $ip, '', [
+        $audit->log(
-            'userName' => $userName,
+            userId: $user->getId(),
-            'userEmail' => $userEmail,
+            // Pass first, most verbose event pattern
-            'mode' => $mode,
+            event: $events[0],
-            'data' => $payload,
+            resource: $resource,
-        ]);
+            userAgent: $userAgent,
+            ip: $ip,
+            location: '',
+            data: [
+                'userName' => $userName,
+                'userEmail' => $userEmail,
+                'mode' => $mode,
+                'data' => $payload,
+            ]
+        );
     }
 
     public function shutdown(): void

app/workers/builds.php

@@ -31,7 +31,8 @@ class BuildsV1 extends Worker
         return "builds";
     }
 
-    public function init(): void {
+    public function init(): void
+    {
         $this->executor = new Executor(App::getEnv('_APP_EXECUTOR_HOST'));
     }
 
@@ -129,7 +130,13 @@ class BuildsV1 extends Worker
             'functionId' => $function->getId(),
             'deploymentId' => $deployment->getId()
         ]);
-        $target = Realtime::fromPayload($allEvents[0], $build, $project);
+        $target = Realtime::fromPayload(
+            // Pass first, most verbose event pattern
+            event: $allEvents[0],
+            payload: $build,
+            project: $project
+        );
+
         Realtime::send(
             projectId: 'console',
             payload: $build->getArrayCopy(),
@@ -196,7 +203,12 @@ class BuildsV1 extends Worker
             /** 
              * Send realtime Event
              */
-            $target = Realtime::fromPayload($allEvents[0], $build, $project);
+            $target = Realtime::fromPayload(
+                // Pass first, most verbose event pattern
+                event: $allEvents[0],
+                payload: $build,
+                project: $project
+            );
             Realtime::send(
                 projectId: 'console',
                 payload: $build->getArrayCopy(),

app/workers/database.php

@@ -102,7 +102,12 @@ class DatabaseV1 extends Worker
             Console::error($th->getMessage());
             $dbForProject->updateDocument('attributes', $attribute->getId(), $attribute->setAttribute('status', 'failed'));
         } finally {
-            $target = Realtime::fromPayload($events[0], $attribute, $project);
+            $target = Realtime::fromPayload(
+                // Pass first, most verbose event pattern
+                event: $events[0],
+                payload: $attribute,
+                project: $project
+            );
 
             Realtime::send(
                 projectId: 'console',
@@ -154,7 +159,12 @@ class DatabaseV1 extends Worker
             Console::error($th->getMessage());
             $dbForProject->updateDocument('attributes', $attribute->getId(), $attribute->setAttribute('status', 'stuck'));
         } finally {
-            $target = Realtime::fromPayload($events[0], $attribute, $project);
+            $target = Realtime::fromPayload(
+                // Pass first, most verbose event pattern
+                event: $events[0],
+                payload: $attribute,
+                project: $project
+            );
 
             Realtime::send(
                 projectId: 'console',
@@ -255,7 +265,12 @@ class DatabaseV1 extends Worker
             Console::error($th->getMessage());
             $dbForProject->updateDocument('indexes', $index->getId(), $index->setAttribute('status', 'failed'));
         } finally {
-            $target = Realtime::fromPayload($events[0], $index, $project);
+            $target = Realtime::fromPayload(
+                // Pass first, most verbose event pattern
+                event: $events[0],
+                payload: $index,
+                project: $project
+            );
 
             Realtime::send(
                 projectId: 'console',
@@ -300,7 +315,12 @@ class DatabaseV1 extends Worker
             Console::error($th->getMessage());
             $dbForProject->updateDocument('indexes', $index->getId(), $index->setAttribute('status', 'stuck'));
         } finally {
-            $target = Realtime::fromPayload($events[0], $index, $project);
+            $target = Realtime::fromPayload(
+                // Pass first, most verbose event pattern
+                event: $events[0],
+                payload: $index,
+                project: $project
+            );
 
             Realtime::send(
                 projectId: 'console',

app/workers/functions.php

@@ -75,6 +75,7 @@ class FunctionsV1 extends Worker
                         function: $function,
                         dbForProject: $database,
                         trigger: 'event',
+                        // Pass first, most verbose event pattern
                         event: $events[0],
                         eventData: $payload,
                         user: $user
@@ -329,7 +330,11 @@ class FunctionsV1 extends Worker
             'functionId' => $function->getId(),
             'executionId' => $execution->getId()
         ]);
-        $target = Realtime::fromPayload($allEvents[0], $execution);
+        $target = Realtime::fromPayload(
+            // Pass first, most verbose event pattern
+            event: $allEvents[0],
+            payload: $execution
+        );
         Realtime::send(
             projectId: 'console',
             payload: $execution->getArrayCopy(),