Revert "Revert "3 feat support exclusion criteria""

Author: moon-brillar

database/factories/WebhookFactory.php

@@ -4,7 +4,7 @@
 
 use Illuminate\Database\Eloquent\Factories\Factory;
 use OnrampLab\Webhooks\Models\Webhook;
-use OnrampLab\Webhooks\ValueObjects\ExclusionCriteria;
+use OnrampLab\Webhooks\ValueObjects\ExclusionCriterion;
 
 class WebhookFactory extends Factory
 {
@@ -27,13 +27,13 @@ public function definition()
             'http_verb' => 'POST',
             'enabled' => true,
             'exclusion_criteria' => [
-                new ExclusionCriteria([
-                    'name' => 'campaign_ids',
+                new ExclusionCriterion([
+                    'name' => 'account_ids',
                     'values' => [1, 2]
                 ]),
-                new ExclusionCriteria([
+                new ExclusionCriterion([
                     'name' => 'events',
-                    'values' => ['sms_sent', 'sms_delivered']
+                    'values' => ['test_event']
                 ])
             ],
             'contextable_id' => $this->faker->randomNumber(),

src/AttributeCastors/ExclusionCriteriaCastor.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace OnrampLab\Webhooks\AttributeCastors;
+
+use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
+use OnrampLab\Webhooks\ValueObjects\ExclusionCriterion;
+
+class ExclusionCriteriaCastor implements CastsAttributes
+{
+    public function get($model, string $key, $value, array $attributes)
+    {
+        if (is_null($value)) {
+            return null;
+        }
+        // Convert the JSON string to an array of ExclusionCriterion objects
+        $exclusionCriteria = json_decode($value, true);
+        $casted = [];
+
+        foreach ($exclusionCriteria as $criterion) {
+            $casted[] = new ExclusionCriterion([
+                'name' => $criterion['name'],
+                'values' => $criterion['values']
+            ]);
+        }
+
+        return $casted;
+    }
+
+    public function set($model, string $key, $value, array $attributes)
+    {
+        if (is_null($value)) {
+            return null;
+        }
+        // Convert the array of ExclusionCriterion objects back to a JSON string
+        $formatted = [];
+
+        foreach ($value as $criterion) {
+            $formatted[] = [
+                'name' => $criterion->getName(),
+                'values' => $criterion->getValues(),
+            ];
+        }
+
+        return json_encode($formatted);
+    }
+}

src/Concerns/Webhookable.php

@@ -26,4 +26,9 @@ public function getWebhookPayload(): array
     {
         return [];
     }
+
+    public function getExclusionCriteria(): array
+    {
+        return [];
+    }
 }

src/Contracts/Webhookable.php

@@ -12,4 +12,6 @@ public function getWebhookPayload(): array;
     public function getWebhookContext(): ?Model;
 
     public function getEventOccurredAt(): ?Carbon;
+
+    public function getExclusionCriteria(): array;
 }

src/Models/Webhook.php

@@ -6,6 +6,7 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Factories\Factory;
 use Illuminate\Database\Eloquent\Relations\HasMany;
+use OnrampLab\Webhooks\AttributeCastors\ExclusionCriteriaCastor;
 use OnrampLab\Webhooks\Database\Factories\WebhookFactory;
 
 
@@ -36,7 +37,7 @@ class Webhook extends Model
      */
     protected $casts = [
         'enabled' => 'boolean',
-        'exclusion_criteria' => 'array',
+        'exclusion_criteria' => ExclusionCriteriaCastor::class,
         'headers' => 'array'
     ];
 

src/ValueObjects/ExclusionCriteria.php src/ValueObjects/ExclusionCriterion.phpsrc/ValueObjects/ExclusionCriteria.php renamed to src/ValueObjects/ExclusionCriterion.php

@@ -4,7 +4,7 @@
 
 use JsonSerializable;
 
-class ExclusionCriteria implements JsonSerializable
+class ExclusionCriterion implements JsonSerializable
 {
     public string $name;
 
@@ -33,4 +33,14 @@ public function jsonSerialize(): array
     {
         return $this->toArray();
     }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    public function getValues(): array
+    {
+        return $this->values;
+    }
 }

src/WebhookDispatcher.php

@@ -14,8 +14,13 @@ class WebhookDispatcher
 
     public function handle(Webhookable $event)
     {
-        $payload = $event->getWebhookPayload();
         $webhooks = $this->getWebhooks($event);
+
+        if ($webhooks->isEmpty()) {
+            return;
+        }
+
+        $payload = $event->getWebhookPayload();
         $this->eventOccurredAt = $event->getEventOccurredAt();
 
         foreach ($webhooks as $webhook) {
@@ -45,7 +50,26 @@ protected function getWebhooks(Webhookable $event): Collection
 
     protected function areExclusionCriteriaMatched(Webhookable $event, Webhook $webhook): bool
     {
-        //to be implemented
+        $webhookExclusionCriteria = $webhook->exclusion_criteria;
+        $eventExclusionCriteria = $event->getExclusionCriteria();
+
+        if (is_null($webhookExclusionCriteria) || empty($eventExclusionCriteria))  {
+            return false;
+        }
+
+        foreach ($eventExclusionCriteria as $eventExclusionCriterion) {
+            $eventExclusionCriteriaName = $eventExclusionCriterion->getName();
+            $eventExclusionCriteriaValues = $eventExclusionCriterion->getValues();
+
+            foreach ($webhookExclusionCriteria as $webhookExclusionCriterion) {
+                $webhookExclusionCriteriaName = $webhookExclusionCriterion->getName();
+                $webhookExclusionCriteriaValues = $webhookExclusionCriterion->getValues();
+                if ($eventExclusionCriteriaName === $webhookExclusionCriteriaName && count(array_intersect($webhookExclusionCriteriaValues, $eventExclusionCriteriaValues)) > 0) {
+                    return true;
+                }
+            }
+        }
+
         return  false;
     }
 

tests/Classes/TestEvent.php

@@ -2,9 +2,9 @@
 
 namespace OnrampLab\Webhooks\Tests\Classes;
 
-use Illuminate\Database\Eloquent\Model;
 use OnrampLab\Webhooks\Contracts\Webhookable as WebhookableContract;
 use \OnrampLab\Webhooks\Concerns\Webhookable as WebhookableTrait;
+use OnrampLab\Webhooks\ValueObjects\ExclusionCriterion;
 
 class TestEvent implements WebhookableContract
 {
@@ -20,4 +20,14 @@ public function getWebhookContext(): ?Account
     {
         return $this->account;
     }
+
+    public function getExclusionCriteria(): array
+    {
+        return [
+            new ExclusionCriterion([
+                'name' => 'events',
+                'values' => ['test_event']
+            ]),
+        ];
+    }
 }

tests/Feature/WebhookDispatcherTest.php

@@ -31,7 +31,6 @@ protected function setUp(): void
      */
     public function should_dispatch_webhook_according_to_context(): void
     {
-
         Queue::fake();
 
         $dispatcher = new WebhookDispatcher();

tests/Unit/WebhookDispatcherTest.php

@@ -2,7 +2,35 @@
 
 namespace OnrampLab\Webhooks\Tests\Unit;
 
-class WebhookDispatcherTest
+use OnrampLab\Webhooks\CallWebhookJob;
+use OnrampLab\Webhooks\Models\Webhook;
+use OnrampLab\Webhooks\Tests\Classes\Account;
+use OnrampLab\Webhooks\Tests\Classes\TestEvent;
+use OnrampLab\Webhooks\Tests\TestCase;
+use OnrampLab\Webhooks\WebhookDispatcher;
+
+class WebhookDispatcherTest extends TestCase
 {
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->account = Account::factory()->create();
+        $attributes = [
+            'contextable_id' => $this->account->id,
+            'contextable_type' => get_class($this->account)
+        ];
+        $this->webhook = Webhook::factory()->create($attributes);
+        $this->event = new TestEvent($this->account);
+        $this->callWebhookJobMock = $this->mock(CallWebhookJob::class);
+    }
 
+    /**
+     * @test
+     */
+    public function should_not_dispatch_webhook_when_exclusion_criteria_are_matched(): void
+    {
+        $dispatcher = new WebhookDispatcher();
+        $dispatcher->handle($this->event);
+    }
 }
+