Fix discarded attribute violation reporter not accepting multiple pro…

…perty names (#890)
getsentry · Apr 24, 2024 · 0c2fc7b · 0c2fc7b
1 parent 44345a9
commit 0c2fc7b
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 1 deletion.
diff --git a/src/Sentry/Laravel/Integration/ModelViolations/ModelViolationReporter.php b/src/Sentry/Laravel/Integration/ModelViolations/ModelViolationReporter.php
@@ -35,8 +35,13 @@ public function __construct(?callable $callback, bool $suppressDuplicateReports,
         $this->reportAfterResponse = $reportAfterResponse;
     }
 
-    public function __invoke(Model $model, string $property): void
+    /** @param string|array<int, string> $propertyOrProperties */
+    public function __invoke(Model $model, $propertyOrProperties): void
     {
+        $property = is_array($propertyOrProperties)
+            ? implode(', ', $propertyOrProperties)
+            : $propertyOrProperties;
+
         if (!$this->shouldReport($model, $property)) {
             return;
         }

diff --git a/test/Sentry/Integration/ModelViolationReportersTest.php b/test/Sentry/Integration/ModelViolationReportersTest.php
@@ -31,6 +31,36 @@ public function testModelViolationReportersCanBeRegistered(): void
         Model::handleDiscardedAttributeViolationUsing(Integration::discardedAttributeViolationReporter());
     }
 
+    public function testViolationReporterAcceptsSingleProperty(): void
+    {
+        $reporter = Integration::discardedAttributeViolationReporter(null, true, false);
+
+        $reporter(new ViolationReporterTestModel, 'foo');
+
+        $this->assertCount(1, $this->getCapturedSentryEvents());
+
+        $violation = $this->getLastSentryEvent()->getContexts()['violation'];
+
+        $this->assertSame('foo', $violation['attribute']);
+        $this->assertSame('discarded_attribute', $violation['kind']);
+        $this->assertSame(ViolationReporterTestModel::class, $violation['model']);
+    }
+
+    public function testViolationReporterAcceptsListOfProperties(): void
+    {
+        $reporter = Integration::discardedAttributeViolationReporter(null, true, false);
+
+        $reporter(new ViolationReporterTestModel, ['foo', 'bar']);
+
+        $this->assertCount(1, $this->getCapturedSentryEvents());
+
+        $violation = $this->getLastSentryEvent()->getContexts()['violation'];
+
+        $this->assertSame('foo, bar', $violation['attribute']);
+        $this->assertSame('discarded_attribute', $violation['kind']);
+        $this->assertSame(ViolationReporterTestModel::class, $violation['model']);
+    }
+
     public function testViolationReporterPassesThroughToCallback(): void
     {
         $callbackCalled = false;