Skip to content

[Notifier] [Slack] Add SlackPlainTextInputBlock for Slack message #60310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: 7.4
Choose a base branch
from
Open

[Notifier] [Slack] Add SlackPlainTextInputBlock for Slack message #60310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5e6db9e
Add SlackPlainTextInputBlock for Slack message customization
May 1, 2025
a4c68df
Fix README formatting by adjusting line breaks
May 1, 2025
fd6340e
License Headers
May 1, 2025
0af771d
Add a testcase where this block is used in the transport
May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions src/Symfony/Component/Notifier/Bridge/Slack/Block/SlackPlainTextInputBlock.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Component\Notifier\Bridge\Slack\Block;

final class SlackPlainTextInputBlock extends AbstractSlackBlock
{
private const LABEL_LIMIT = 150;
private const ACTION_ID_LIMIT = 255;
private const PLACEHOLDER_LIMIT = 150;

public function __construct(string $labelText, string $actionId, ?string $placeholderText = null)
{
if (\strlen($labelText) > self::LABEL_LIMIT) {
throw new \LengthException(\sprintf('Maximum length for the label text is %d characters.', self::LABEL_LIMIT));
}

if (\strlen($actionId) > self::ACTION_ID_LIMIT) {
throw new \LengthException(\sprintf('Maximum length for the action ID is %d characters.', self::ACTION_ID_LIMIT));
}

if ($placeholderText && \strlen($placeholderText) > self::PLACEHOLDER_LIMIT) {
throw new \LengthException(\sprintf('Maximum length for the placeholder text is %d characters.', self::PLACEHOLDER_LIMIT));
}
$this->options = [
'type' => 'input',
'element' => [
'type' => 'plain_text_input',
'action_id' => $actionId,
],
'label' => [
'type' => 'plain_text',
'text' => $labelText,
],
];

if ($placeholderText) {
$this->options['element']['placeholder'] = [
'type' => 'plain_text',
'text' => $placeholderText,
];
}
}
}
22 changes: 22 additions & 0 deletions src/Symfony/Component/Notifier/Bridge/Slack/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,28 @@ $chatMessage->options($options);
$chatter->send($chatMessage);
```

Adding a Plain Text Input to a Message
----------------------------
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
----------------------------
----------------------------

Please make the underline length match the title

To add a simple text input field to your Slack message, use the `SlackPlainTextInputBlock` class.
```php
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackPlainTextInputBlock;
use Symfony\Component\Notifier\Bridge\Slack\SlackOptions;
use Symfony\Component\Notifier\Message\ChatMessage;

$chatMessage = new ChatMessage('Enter your feedback');

$options = (new SlackOptions())
->block(
new SlackPlainTextInputBlock('Your Feedback', 'feedback_action_id', 'Type your feedback here...')
);

// Add the custom options to the chat message and send the message
$chatMessage->options($options);

$chatter->send($chatMessage);
```


Sending a Message as a Reply
----------------------------

Expand Down
66 changes: 66 additions & 0 deletions src/Symfony/Component/Notifier/Bridge/Slack/Tests/Block/SlackPlainTextInputBlockTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
<?php

namespace Symfony\Component\Notifier\Bridge\Slack\Tests\Block;

use PHPUnit\Framework\TestCase;
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackPlainTextInputBlock;

final class SlackPlainTextInputBlockTest extends TestCase
{
public function testCanBeInstantiatedWithPlaceholder()
{
$block = new SlackPlainTextInputBlock('Time spent', 'time_spent_input', 'Enter some text here');
$this->assertSame([
'type' => 'input',
'element' => [
'type' => 'plain_text_input',
'action_id' => 'time_spent_input',
'placeholder' => [
'type' => 'plain_text',
'text' => 'Enter some text here',
],
],
'label' => [
'type' => 'plain_text',
'text' => 'Time spent',
],
], $block->toArray());
}

public function testCanBeInstantiatedWithoutPlaceholder()
{
$block = new SlackPlainTextInputBlock('Time spent', 'time_spent_input');
$this->assertSame([
'type' => 'input',
'element' => [
'type' => 'plain_text_input',
'action_id' => 'time_spent_input',
],
'label' => [
'type' => 'plain_text',
'text' => 'Time spent',
],
], $block->toArray());
}

public function testThrowsWhenLabelExceedsCharacterLimit()
{
$this->expectException(\LengthException::class);
$this->expectExceptionMessage('Maximum length for the label text is 150 characters.');
new SlackPlainTextInputBlock(str_repeat('a', 151), 'time_spent_input');
}

public function testThrowsWhenActionIdExceedsCharacterLimit()
{
$this->expectException(\LengthException::class);
$this->expectExceptionMessage('Maximum length for the action ID is 255 characters.');
new SlackPlainTextInputBlock('Time spent', str_repeat('a', 256));
}

public function testThrowsWhenPlaceholderExceedsCharacterLimit()
{
$this->expectException(\LengthException::class);
$this->expectExceptionMessage('Maximum length for the placeholder text is 150 characters.');
new SlackPlainTextInputBlock('Time spent', 'time_spent_input', str_repeat('a', 151));
}
}
42 changes: 42 additions & 0 deletions src/Symfony/Component/Notifier/Bridge/Slack/Tests/SlackTransportTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
namespace Symfony\Component\Notifier\Bridge\Slack\Tests;

use Symfony\Component\HttpClient\MockHttpClient;
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackPlainTextInputBlock;
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackSectionBlock;
use Symfony\Component\Notifier\Bridge\Slack\SlackOptions;
use Symfony\Component\Notifier\Bridge\Slack\SlackSentMessage;
use Symfony\Component\Notifier\Bridge\Slack\SlackTransport;
Expand Down Expand Up @@ -330,4 +332,44 @@ public function testUpdateMessage()

$this->assertSame('1503435956.000247', $sentMessage->getMessageId());
}

public function testSlackTransportSendsMessageWithInputBlock()
{
$channel = 'testChannel';
$message = 'testMessage';

$response = $this->createMock(ResponseInterface::class);

$response->expects($this->exactly(2))
->method('getStatusCode')
->willReturn(200);

$response->expects($this->once())
->method('getContent')
->willReturn(json_encode(['ok' => true, 'ts' => '1503435956.000247', 'channel' => 'C123456']));

$options = new SlackOptions();

$options->block((new SlackSectionBlock())->text($message));

$options->block((new SlackPlainTextInputBlock('Time spent', 'time_spent_input', 'Enter some text here')));

$expectedBody = json_encode([
'blocks' => $options->toArray()['blocks'],
'channel' => $channel,
'text' => $message,
]);

$client = new MockHttpClient(function (string $method, string $url, array $options = []) use ($response, $expectedBody): ResponseInterface {
$this->assertJsonStringEqualsJsonString($expectedBody, $options['body']);

return $response;
});

$transport = self::createTransport($client, $channel);

$sentMessage = $transport->send(new ChatMessage('testMessage', $options));

$this->assertSame('1503435956.000247', $sentMessage->getMessageId());
}
}
Loading