Notification & Integrations refactoring (#346)

* Integrations Refactoring - WIP * integrations list & edit - WIP * Fix integration store binding issue * integrations refactor - WIP * Form integration - WIP * Form integration Edit - WIP * Integration Refactor - Slack - WIP * Integration Refactor - Discord - WIP * Integration Refactor - Webhook - WIP * Integration Refactor - Send Submission Confirmation - WIP * Integration Refactor - Backend handler - WIP * Form Integration Status field * Integration Refactor - Backend SubmissionConfirmation - WIP * IntegrationMigration Command * skip confirmation email test case * Small refactoring * FormIntegration status active/inactive * formIntegrationData to integrationData * Rename file name with Integration suffix for integration realted files * Loader on form integrations * WIP * form integration test case * WIP * Added Integration card - working on refactoring * change location for IntegrationCard and update package file * Form Integration Create/Edit in single Modal * Remove integration extra pages * crisp_help_page_slug for integration json * integration logic as collapse * UI improvements * WIP * Trying to debug vue devtools * WIP for integrations * getIntegrationHandler change namespace name * useForm for integration fields + validation structure * Integration Test case & apply validation rules * Apply useform changes to integration other files * validation rules for FormNotificationsMessageActions fields * Zapier integration as coming soon * Update FormCleaner * set default settings for confirmation integration * WIP * Finish validation for all integrations * Updated purify, added integration formatData * Fix testcase * Ran pint; working on integration errors * Handle integration events * command for Delete Old Integration Events * Display Past Events in Modal * on Integration event create with status error send email to form creator * Polish styling * Minor improvements * Finish badge and integration status * Fix tests and add an integration event test * Lint --------- Co-authored-by: Julien Nahum <julien@nahum.net>
2024-03-28 22:44:30 +05:30
parent d9996e0d9d
commit 6f61faa9ef
84 changed files with 6121 additions and 2205 deletions
--- a/app/Service/Forms/Integrations/AbstractIntegrationHandler.php
+++ b/app/Service/Forms/Integrations/AbstractIntegrationHandler.php
@@ -0,0 +1,131 @@
+<?php
+
+namespace App\Service\Forms\Integrations;
+
+use App\Models\Integration\FormIntegration;
+use App\Events\Forms\FormSubmitted;
+use App\Models\Integration\FormIntegrationsEvent;
+use App\Service\Forms\FormSubmissionFormatter;
+use App\Service\Forms\FormLogicConditionChecker;
+use Illuminate\Http\Client\RequestException;
+use Illuminate\Support\Facades\Http;
+use Vinkla\Hashids\Facades\Hashids;
+
+abstract class AbstractIntegrationHandler
+{
+    protected $form = null;
+    protected $submissionData = null;
+    protected $integrationData = null;
+
+    public function __construct(
+        protected FormSubmitted $event,
+        protected FormIntegration $formIntegration,
+        protected array $integration
+    ) {
+        $this->form = $event->form;
+        $this->submissionData = $event->data;
+        $this->integrationData = $formIntegration->data;
+    }
+
+    protected function getProviderName(): string
+    {
+        return $this->integration['name'] ?? '';
+    }
+
+    protected function logicConditionsMet(): bool
+    {
+        if (!$this->formIntegration->logic) {
+            return true;
+        }
+        return FormLogicConditionChecker::conditionsMet(
+            json_decode(json_encode($this->formIntegration->logic), true),
+            $this->submissionData
+        );
+    }
+
+    protected function shouldRun(): bool
+    {
+        return $this->logicConditionsMet();
+    }
+
+    protected function getWebhookUrl(): ?string
+    {
+        return '';
+    }
+
+    /**
+     * Default webhook payload. Can be changed in child classes.
+     */
+    protected function getWebhookData(): array
+    {
+        $formatter = (new FormSubmissionFormatter($this->form, $this->submissionData))
+            ->useSignedUrlForFiles()
+            ->showHiddenFields();
+
+        $formattedData = [];
+        foreach ($formatter->getFieldsWithValue() as $field) {
+            $formattedData[$field['name']] = $field['value'];
+        }
+
+        $data = [
+            'form_title' => $this->form->title,
+            'form_slug' => $this->form->slug,
+            'submission' => $formattedData,
+        ];
+        if ($this->form->is_pro && $this->form->editable_submissions) {
+            $data['edit_link'] = $this->form->share_url . '?submission_id=' . Hashids::encode(
+                $this->submissionData['submission_id']
+            );
+        }
+
+        return $data;
+    }
+
+    final public function run(): void
+    {
+        try {
+            $this->handle();
+            $this->formIntegration->events()->create([
+                'status' => FormIntegrationsEvent::STATUS_SUCCESS,
+            ]);
+        } catch (\Exception $e) {
+            $this->formIntegration->events()->create([
+                'status' => FormIntegrationsEvent::STATUS_ERROR,
+                'data' => $this->extractEventDataFromException($e),
+            ]);
+        }
+    }
+
+    /**
+     * Default handle. Can be changed in child classes.
+     */
+    public function handle(): void
+    {
+        if (!$this->shouldRun()) {
+            return;
+        }
+
+        Http::throw()->post($this->getWebhookUrl(), $this->getWebhookData());
+    }
+
+    abstract public static function getValidationRules(): array;
+
+    public static function formatData(array $data): array
+    {
+        return $data;
+    }
+
+    public function extractEventDataFromException(\Exception $e): array
+    {
+        if ($e instanceof RequestException) {
+            return [
+                'message' => $e->getMessage(),
+                'response' => $e->response->json(),
+                'status' => $e->response->status(),
+            ];
+        }
+        return [
+            'message' => $e->getMessage()
+        ];
+    }
+}