feature #42090 [Notifier] [Slack] Include additional errors to slack notifier error message (norkunas)

OskarStark · OskarStark · commit b5d4b33d5e65 · 2021-07-13T21:12:11.000+02:00
This PR was merged into the 5.4 branch. Discussion ---------- [Notifier] [Slack] Include additional errors to slack notifier error message | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | N/A | License | MIT | Doc PR | N/A Sometimes it is hard to debug why notification was rejected, so I am proposing to include error descriptions to the exception message. Commits ------- 18c1498 Include additional errors to slack notifier error message
diff --git a/src/Symfony/Component/Notifier/Bridge/Slack/SlackTransport.php b/src/Symfony/Component/Notifier/Bridge/Slack/SlackTransport.php
@@ -95,7 +95,9 @@ protected function doSend(MessageInterface $message): SentMessage
 
         $result = $response->toArray(false);
         if (!$result['ok']) {
-            throw new TransportException(sprintf('Unable to post the Slack message: "%s".', $result['error']), $response);
+            $errors = isset($result['errors']) ? ' ('.implode('|', $result['errors']).')' : '';
+
+            throw new TransportException(sprintf('Unable to post the Slack message: "%s"%s.', $result['error'], $errors), $response);
         }
 
         $sentMessage = new SentMessage($message, (string) $this);
diff --git a/src/Symfony/Component/Notifier/Bridge/Slack/Tests/SlackTransportTest.php b/src/Symfony/Component/Notifier/Bridge/Slack/Tests/SlackTransportTest.php
@@ -239,4 +239,32 @@ public function testSendIncludesContentTypeWithCharset()
 
         $transport->send(new ChatMessage('testMessage'));
     }
+
+    public function testSendWithErrorsIncluded()
+    {
+        $response = $this->createMock(ResponseInterface::class);
+
+        $response->expects($this->exactly(2))
+            ->method('getStatusCode')
+            ->willReturn(200);
+
+        $response->expects($this->once())
+            ->method('getContent')
+            ->willReturn(json_encode([
+                'ok' => false,
+                'error' => 'invalid_blocks',
+                'errors' => ['no more than 50 items allowed [json-pointer:/blocks]'],
+            ]));
+
+        $client = new MockHttpClient(function () use ($response): ResponseInterface {
+            return $response;
+        });
+
+        $transport = $this->createTransport($client, 'testChannel');
+
+        $this->expectException(TransportException::class);
+        $this->expectExceptionMessage('Unable to post the Slack message: "invalid_blocks" (no more than 50 items allowed [json-pointer:/blocks]).');
+
+        $transport->send(new ChatMessage('testMessage'));
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,9 @@ protected function doSend(MessageInterface $message): SentMessage`
`95`	`95`
`96`	`96`	`$result = $response->toArray(false);`
`97`	`97`	`if (!$result['ok']) {`
`98`		`- throw new TransportException(sprintf('Unable to post the Slack message: "%s".', $result['error']), $response);`
	`98`	`+ $errors = isset($result['errors']) ? ' ('.implode('\|', $result['errors']).')' : '';`
	`99`	`+`
	`100`	`+ throw new TransportException(sprintf('Unable to post the Slack message: "%s"%s.', $result['error'], $errors), $response);`
`99`	`101`	`}`
`100`	`102`
`101`	`103`	`$sentMessage = new SentMessage($message, (string) $this);`