[Notifier ] Add Discord notifier #36475

mpiot · 2020-04-17T11:39:46Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets
License	MIT
Doc PR	symfony/symfony-docs#13558

Add a basic Discord notifier via webhook (https://discordapp.com/developers/docs/resources/webhook).

Actually I've just a Message from the notification displayed (on the image the simple line: "My notification subject").

It's also possible to have an embed message (https://discordapp.com/developers/docs/resources/channel#embed-object) as exemple I've done one with a title (message subject), description (message content), and a color (on the importance)

At the moment it's not implemented yet in this PR, 2 possibilities:

the embed type by default (never the simple type)
add a DiscordConfigurationMessage object to enable the embed format ? (only on ChatMessage, not Notification)

In my case, I prefer embded by default, like Email notification (subject, content and border color).

We also can add a configuration file (only for ChatMessage) to the Bot name, bot image.

src/Symfony/Component/Notifier/Bridge/Discord/DiscordTransport.php

walva · 2020-04-19T09:31:03Z

@mpiot I'm willing to help! Is there something I can do? I'm currently trying to test your new feature.

mpiot · 2020-04-19T10:21:27Z

Hi @walva, actually I'm waiting some discussion about this implementation. In fact, actually I've implemented it very simply (the first image) and without any configuration.

I think I will add a Configuration to set the bot name and bot image.

A part to discuss is about the message format, in Discord Webhook api, we can sent a simple message as already done here, or as embeds (image 2) with a border, title, footer, description (the simplest possibility). Use it by default ? (border color with importance, title with notification subject, description with content).

Maybe other ideas ? I don't know.

noniagriconomie · 2020-04-23T16:49:18Z

Iirc there is a slack bridge, maybe do a « replication » of this bridge ?
As both are similar in main points

mpiot · 2020-04-23T16:53:43Z

Yes there is a SlackBridge, but I don't know the Slack API, I think you want to speak about the Block part of the Slack Notifier ?

src/Symfony/Bundle/FrameworkBundle/Resources/config/notifier_transports.xml

src/Symfony/Component/Notifier/Bridge/Discord/CHANGELOG.md

src/Symfony/Component/Notifier/Bridge/Discord/DiscordTransport.php

src/Symfony/Component/Notifier/Bridge/Discord/README.md

src/Symfony/Component/Notifier/Bridge/Discord/composer.json

src/Symfony/Component/Notifier/Bridge/Discord/DiscordTransport.php

fabpot · 2020-08-10T14:25:01Z

@mpiot Can you submit a PR on symfony/recipes (you can have a look at other notifier bridge recipes to get some inspiration)?

src/Symfony/Component/Notifier/Bridge/Discord/DiscordTransport.php

mpiot · 2020-08-10T16:35:09Z

@fabpot I look at this (changes and recipe) in few days (hollidays).
@skmedix Thanks, They've change URLs :( I'll fix it with the rest.

fabpot · 2020-09-01T11:51:50Z

@mpiot Friendly ping :)

….php Co-Authored-By: Oskar Stark <[email protected]>

mpiot · 2020-09-01T17:06:00Z

@fabpot Done for changes on this PR and open symfony/recipes#816

fabpot · 2020-09-02T08:19:29Z

src/Symfony/Component/Notifier/Bridge/Discord/DiscordTransport.php

+
+            throw new TransportException(sprintf('Unable to post the Discord message: "%s" (%s).', $result['message'], $result['code']), $response);
+        }
+    }


Missing the return statement... which makes me think that this should be tested before merging (at least manually).

Oh yes my bad... I've just replace the return statement :void to :SentMessage. I went too fast and didn't pay attention that it was necessary to add a corresponding return statement in the function... :/

Are you still interested in finishing this PR?

I don't have much time lately, I'll try to watch this when I'm free.

Thank you for the quick reply. I'm going to close then. Perhaps someone can take over to finish it.

fabpot · 2020-09-13T07:05:55Z

Anyone willing to take over this one. I think most of the work is already done. Apart from my last comment, this should also be tested in real life to be sure it works well.

connorhu · 2020-09-13T09:26:18Z

I will finish the work on this PR.

mpiot · 2020-09-13T10:51:01Z

@connorhu Thanks, I was going to try to watch. But I keep you see it.

At the moment I've just return a SentMessage response, without message because Discord just return a 204 No Content. But I can't test if it work. Because when I try to link my Updated symfony dev branch on an existant project (that do not implement the Discord code) I've an error: Cannot dump definition because of invalid class name ('chatter.transport_factory'). (#37298).

It appear the #38175 fix that. Probbaly why I can't test my PR.

mpiot · 2020-09-13T13:33:24Z

@fabpot @connorhu By applying the patch #38175, I've can test my PR and it works well.

connorhu · 2020-09-13T21:15:59Z

I finished the support of rich type webhook. Result of the spotify example:

What's next?

Example:

$chatter = new Chatter($discordTransport);
$chatMessage = new ChatMessage('');
$discordOptions = (new DiscordOptions())
    ->username('connor bot')
    ->addEmbed((new DiscordEmbed())
        ->color(2021216)
        ->title('New song added!')
        ->thumbnail((new DiscordMediaEmbedObject())
        ->url('https://i.scdn.co/image/ab67616d0000b2735eb27502aa5cb1b4c9db426b'))
        ->addField((new DiscordFieldEmbedObject())
            ->name('Track')
            ->value('[Common Ground](https://open.spotify.com/track/36TYfGWUhIRlVjM8TxGUK6)')
            ->inline(true)
        )
        ->addField((new DiscordFieldEmbedObject())
            ->name('Artist')
            ->value('Alasdair Fraser')
            ->inline(true)
        )
        ->addField((new DiscordFieldEmbedObject())
            ->name('Album')
            ->value('Dawn Dance')
            ->inline(true)
        )
        ->footer((new DiscordFooterEmbedObject())
            ->text('Added ...')
            ->iconUrl('https://upload.wikimedia.org/wikipedia/commons/thumb/1/19/Spotify_logo_without_text.svg/200px-Spotify_logo_without_text.svg.png')
        )
    )
;
$chatMessage->options($discordOptions);
$chatter->send($chatMessage);

mpiot · 2020-09-14T05:39:57Z

@connorhu Great job ;)
I think since this PR is closed, you can open a new one, if you want you can link this new one on:

Doc PR: symfony/symfony-docs#13558 (if you have the same organization, rename the channel by webhook id for example, I can do that)
Recipe PR: symfony/recipes#816

Both of this PRs should work, and maybe add a part in the documentation about the rich type ?

fabpot · 2020-09-25T15:30:54Z

@connorhu Do you want to open a new PR?

mpiot · 2020-09-25T16:08:32Z

@connorhu If you can’t, say it to me. I can create it, at the moment, I've updated doc and recipe to match with your changes:

connorhu · 2020-09-29T15:02:50Z

@fabpot Yes I will create a new PR, but first I need to create some tests for the new classes.

mpiot · 2020-10-05T16:17:18Z

@connorhu do you need some help for tests and open the new PR ? The 5.2 is really close.

connorhu · 2020-10-12T07:40:57Z

@connorhu do you need some help for tests and open the new PR ? The 5.2 is really close.

I'm done the rest of the work. Nobody tested the code except me, so it's really experimental.

This PR was merged into the 5.x branch. Discussion ---------- [Notifier ] Add Discord notifier | Q | A | ------------- | --- | Branch? | 5.x | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | | License | MIT | Doc PR | symfony/symfony-docs#13558 It finish the PR #36475 Commits ------- b9b20d7 Added Discord bridge notifier embeds and test 14790d8 Add Discord bridge notifier

This PR was squashed before being merged into the 5.x branch. Discussion ---------- Add Discord notifier Add documentation about Discord notifier integration from symfony/symfony#36475 Commits ------- c630bcb Add Discord notifier

carsonbot added Status: Needs Review Feature labels Apr 17, 2020

mpiot force-pushed the discord-logger-handler branch 2 times, most recently from ba3b08c to 7b2c4d1 Compare April 17, 2020 11:42

mpiot mentioned this pull request Apr 17, 2020

Add Discord notifier symfony/symfony-docs#13558

Merged

OskarStark reviewed Apr 17, 2020

View reviewed changes

src/Symfony/Component/Notifier/Bridge/Discord/DiscordTransport.php Outdated Show resolved Hide resolved

nicolas-grekas added this to the next milestone Apr 18, 2020

fabpot added the Notifier label Apr 21, 2020

fabpot requested changes Aug 6, 2020

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Aug 6, 2020

skmedix reviewed Aug 10, 2020

View reviewed changes

src/Symfony/Component/Notifier/Bridge/Discord/DiscordTransport.php Outdated Show resolved Hide resolved

skmedix suggested changes Aug 10, 2020

View reviewed changes

src/Symfony/Component/Notifier/Bridge/Discord/DiscordTransport.php Outdated Show resolved Hide resolved

mpiot and others added 2 commits September 1, 2020 18:46

Add Discord bridge notifier

9cc2a72

Update src/Symfony/Component/Notifier/Bridge/Discord/DiscordTransport…

932d3eb

….php Co-Authored-By: Oskar Stark <[email protected]>

mpiot force-pushed the discord-logger-handler branch 4 times, most recently from 32c3fd6 to d9a4000 Compare September 1, 2020 16:58

mpiot mentioned this pull request Sep 1, 2020

Add Discord notifier recipe symfony/recipes#816

Merged

Apply changes for 5.2

bc0b9a5

mpiot force-pushed the discord-logger-handler branch from d9a4000 to bc0b9a5 Compare September 1, 2020 17:15

fabpot requested changes Sep 2, 2020

View reviewed changes

fabpot closed this Sep 13, 2020

nicolas-grekas modified the milestones: next, 5.2 Oct 5, 2020

connorhu mentioned this pull request Oct 12, 2020

[Notifier ] Add Discord notifier #38522

Merged

Uh oh!

[Notifier ] Add Discord notifier #36475

[Notifier ] Add Discord notifier #36475

Uh oh!

Conversation

mpiot commented Apr 17, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

walva commented Apr 19, 2020

Uh oh!

mpiot commented Apr 19, 2020

Uh oh!

noniagriconomie commented Apr 23, 2020

Uh oh!

mpiot commented Apr 23, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fabpot commented Aug 10, 2020

Uh oh!

Uh oh!

Uh oh!

mpiot commented Aug 10, 2020

Uh oh!

fabpot commented Sep 1, 2020

Uh oh!

mpiot commented Sep 1, 2020

Uh oh!

fabpot Sep 2, 2020

Choose a reason for hiding this comment

Uh oh!

mpiot Sep 2, 2020

Choose a reason for hiding this comment

Uh oh!

fabpot Sep 13, 2020

Choose a reason for hiding this comment

Uh oh!

mpiot Sep 13, 2020

Choose a reason for hiding this comment

Uh oh!

fabpot Sep 13, 2020

Choose a reason for hiding this comment

Uh oh!

fabpot commented Sep 13, 2020

Uh oh!

connorhu commented Sep 13, 2020

Uh oh!

mpiot commented Sep 13, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mpiot commented Sep 13, 2020

Uh oh!

connorhu commented Sep 13, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mpiot commented Sep 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fabpot commented Sep 25, 2020

Uh oh!

mpiot commented Sep 25, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

connorhu commented Sep 29, 2020

Uh oh!

mpiot commented Oct 5, 2020

Uh oh!

connorhu commented Oct 12, 2020

Uh oh!

Uh oh!

mpiot commented Apr 17, 2020 •

edited

Loading

mpiot commented Sep 13, 2020 •

edited

Loading

connorhu commented Sep 13, 2020 •

edited

Loading

mpiot commented Sep 14, 2020 •

edited

Loading

mpiot commented Sep 25, 2020 •

edited

Loading