From fdb64de6169a4ae90c7410637f92f5c895e49e66 Mon Sep 17 00:00:00 2001 From: Torsten Dittmann Date: Mon, 9 May 2022 14:36:29 +0200 Subject: [PATCH] docs: add comments to events passing --- app/controllers/shared/api.php | 1 + app/workers/audits.php | 28 ++++++++++++++++++---------- app/workers/builds.php | 18 +++++++++++++++--- app/workers/database.php | 28 ++++++++++++++++++++++++---- app/workers/functions.php | 7 ++++++- 5 files changed, 64 insertions(+), 18 deletions(-) diff --git a/app/controllers/shared/api.php b/app/controllers/shared/api.php index c92adaed09..e43fa46bb7 100644 --- a/app/controllers/shared/api.php +++ b/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, diff --git a/app/workers/audits.php b/app/workers/audits.php index 2a0a85f6f4..696eb6df50 100644 --- a/app/workers/audits.php +++ b/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, '', [ - 'userName' => $userName, - 'userEmail' => $userEmail, - 'mode' => $mode, - 'data' => $payload, - ]); + $audit->log( + userId: $user->getId(), + // Pass first, most verbose event pattern + event: $events[0], + resource: $resource, + userAgent: $userAgent, + ip: $ip, + location: '', + data: [ + 'userName' => $userName, + 'userEmail' => $userEmail, + 'mode' => $mode, + 'data' => $payload, + ] + ); } public function shutdown(): void diff --git a/app/workers/builds.php b/app/workers/builds.php index a8136b0c98..c1affa5907 100644 --- a/app/workers/builds.php +++ b/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(), diff --git a/app/workers/database.php b/app/workers/database.php index 40399dc776..a3451461cc 100644 --- a/app/workers/database.php +++ b/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', diff --git a/app/workers/functions.php b/app/workers/functions.php index fb2b683c29..4f7413188f 100644 --- a/app/workers/functions.php +++ b/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(),