Add support for icon_emoji

[mike-pt]

Currently we can not set icon_emoji via slackSend, which means all notifications come with the Jenkins icon.
It would be nice to be able to change this, particularly cause we could base it on the state of the Job and even use different emoji based on that (like with colors)

[Akayeshmantha]

Hey mike am a newbie to jenkinsci.Can I have a brief description about this task

[mike-pt]

Well I think this is a simple thing really, I would try it my self but I don't have a self-hosted jenkins install where I could test the changes, however this should be very similar to what we do for botUser/channel

I'd say that to start with we need to add "set/get Icon_Emoji" like we do for channel and botUser:

slack-plugin/src/main/java/jenkins/plugins/slack/workflow/SlackSendStep.java

Lines 94 to 106 in 6be0492

	public void setBotUser(boolean botUser) {
	this.botUser = botUser;
	}
	public String getChannel() {
	return channel;
	}
	@DataBoundSetter
	public void setChannel(String channel) {
	this.channel = Util.fixEmpty(channel);
	}

then we can have that in StandardSlackService Notifier and probably every other place where we handle botUser or channel

[mike-pt]

Oh one thing to note is the icon_emoji is optional, not mandatory

[Akayeshmantha]

Thanks @mike-pt .So it's just adding setter and getter for imoji.If its so if you dont mind shall I try this task

[mike-pt]

I don't mind at all I can only thank you for taking the time!

[mike-pt]

@Akayeshmantha curious if you were able to make some progress on this

[sheeeng]

Is anyone currently plan to work on this issue? It is not assigned to anyone.

[jetersen]

Feel free to contribute 😓

[jep]

Just wanted to mention that until this is implemented, the default icon can be changed by going to your Slack settings -> App Directory and editing the configuration for your specific JenkinsCI integration.

[EricBartusch]

I've been messing with this a bit, but can't get it to work. I've added a parameter for icon_emoji, but it's disappearing on the request.

https://github.com/EricBartusch/slack-plugin/blob/28fd2bd25710a2e630d41b70f3d07f16eb0413a9/src/main/java/jenkins/plugins/slack/StandardSlackService.java#L172-L174

It gets put into the json just like all of the other parameters, but is ignored. My current guess is that the colon's aren't getting encoded properly. The documentation also says that if the as_user parameter is set, that this will get ignored, but I don't see that happening in the POST being made here. It's set when using a bot, but I'm not in that code block during my testing.

My only other guess is that as_user gets added automatically because the Jenkins CI app has an integration setting called "Customize name" and it can't be null. Where does the code for the Slack Jenkins CI app live? I'm pretty unfamiliar how Slack apps actually work.

[jetersen]

@EricBartusch This depends whether you're using a bot user or a webhook.

[jetersen]

You must use a bot user to use the icon_emoji.

Custom webhooks is a legacy feature: https://api.slack.com/custom-integrations/incoming-webhooks which mentions it does support icon_emoji.

I doubt https://my.slack.com/services/new/jenkins-ci supports icon_emoji

[EricBartusch]

Thanks @Casz, I had spent way to long trying to make that work. I did manage to get it working with a bot user, but I had to remove the line hardcoding as_user to true when the iconEmoji is set:

slack-plugin/src/main/java/jenkins/plugins/slack/StandardSlackService.java

Lines 172 to 176 in 06b17f2

	url = "https://slack.com/api/chat.postMessage?token=" + populatedToken +
	"&channel=" + roomId.replace("#", "") +
	"&link_names=1" +
	"&as_user=true";
	if (threadTs.length() > 1) {

The documentation says when setting it to false, that the username should also be set. In my testing, I haven't done so, and the messages that get sent default to the bot's name, so I don't know how important it is. Also, is there a reason why it was being hardcoded to true in the first place?

[jetersen]

@EricBartusch no reason looking at the PR that added it #258

also link_names should be optional and I don't think it currently works since it expects "true" or "false" though I might be wrong.

[EricBartusch]

The link_names documetation is inconsistent. The documentation here makes it sound like it should be "true" or "false", but documentation here shows it as 1. I can confim setting it to true/false doesn't change anything and allows links, but 1/0 actually affects the ability to post links. I tested this both on the plugin and in the Slack API tester. I can make this a parameter that gets passed in my branch or make a new one for it, whatever makes more sense.

Looks like as_user works with either 0/1 or true/false. Setting it to true has my bot posting to the channel as me, and setting it to false has it posting as the bot name by default. Should I add a username parameter as well? If either username or icon_emoji is set, turn as_user off and use those values if not null.

[jetersen]

adding both username and icon_emoji make sense 👍

[timja]

This was done awhile ago and has been released

[mike-pt]

Thanks, linking the PR (#578) here for future reference