Skip to content

[Notifier] Add debugData property to SentMessage class #51746

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

Closed
ahmedghanem00 wants to merge 3 commits into from
Closed

[Notifier] Add debugData property to SentMessage class #51746

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e983fb5
Add 'debugData' property to SentMessage
ahmedghanem00 Sep 25, 2023
ea9ab35
Include the http response in the returned SentMessage object
ahmedghanem00 Sep 25, 2023
18f23a0
Update CHANGELOG files
ahmedghanem00 Sep 25, 2023
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
1 change: 1 addition & 0 deletions src/Symfony/Component/Notifier/Bridge/AllMySms/AllMySmsTransport.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ protected function doSend(MessageInterface $message): SentMessage

$sentMessage = new SentMessage($message, (string) $this);
$sentMessage->setMessageId($success['smsId']);
$sentMessage->setDebugData(['response' => $response]);

return $sentMessage;
}
Expand Down
5 changes: 5 additions & 0 deletions src/Symfony/Component/Notifier/Bridge/AllMySms/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
CHANGELOG
=========

6.4
---

* Include the http response in the returned `SentMessage` object

6.3
---

Expand Down
5 changes: 5 additions & 0 deletions src/Symfony/Component/Notifier/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
CHANGELOG
=========

6.4
---

* Add `debugData` property to `SentMessage` class

6.3
---

Expand Down
11 changes: 11 additions & 0 deletions src/Symfony/Component/Notifier/Message/SentMessage.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ class SentMessage
private MessageInterface $original;
private string $transport;
private ?string $messageId = null;
private ?array $debugData = null;

public function __construct(MessageInterface $original, string $transport)
{
Expand All @@ -45,4 +46,14 @@ public function getMessageId(): ?string
{
return $this->messageId;
}

public function getDebugData(): ?array
{
return $this->debugData;
}

public function setDebugData(array $data): void
Copy link
Member

@nicolas-grekas nicolas-grekas Sep 29, 2023

Choose a reason for hiding this comment

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

this should instead be a new constructor argument

Copy link
Contributor Author

@ahmedghanem00 ahmedghanem00 Sep 29, 2023

Choose a reason for hiding this comment

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

I chose the setter method initially because some transporters may work differently and not have http-response or extra-data to include?

So, it would make sense to make it an optional same as setMessageId()?

Not sure but just clarifying

{
$this->debugData = $data;
}
}