[nodebb-plugin-reactions] Reactions plugin for NodeBB

[DownPW]

good job @dave1904

Very useful notifications. Integrating it officially into the plugin wouldn't be bad. @baris

[dave1904]

@baris said in [nodebb-plugin-reactions] Reactions plugin for NodeBB:

@dave1904 correct. Right now the bodyShort property isn't parsed like a post so plugins like markdown/emoji aren't turning the markup into html.

Maybe you would have to associate the emoji alias with the file name, find the image and replace the alias in bodyShort.

For now I will use this basic solution. You get a notification for every reaction without any aggregation but I'm happy with it.

[baris]

@dave1904 you can try to use this code https://github.com/NodeBB-Community/nodebb-plugin-reactions/blob/master/library.js#L20C10-L33 to turn the reaction into an emoji for use in bodyShort. Maybe like this

const notifObj = await notifications.create({
	bodyShort: `User ${socket.uid} has reacted with ${parse(data.reaction)} to your post`,
	nid: `user:${socket.uid}:reacted:${data.pid}`,
	pid: data.pid,
	uid: postOwnerUid,
	tid: data.tid,
	from: socket.uid,
	path: `/post/${data.pid}`
});

[dave1904]

@baris great idea, works like charm. Thanks!

[baris]

@dave1904 I've added support for this in reactions plugin with a proper language string so it can be translated. https://github.com/NodeBB-Community/nodebb-plugin-reactions/commit/da7d546129bb79341790c609e9d08b86419b8012

Feel free to send translations for other languages.

[dave1904]

@baris Thanks! May I ask how did you manage to render the emojis without calling the parse() function? Is translator.compile() doing the same and does this also work for custom emojis that are not unicode?

Here is the reactions.json for de-DE

{
  "reactions": "Reaktionen",
  "add-reaction": "Reaktion hinzufügen",
  "error.invalid-reaction": "Ungültige Reaktion",
  "error.maximum-reached": "Maximale Reaktionen erreicht",
  "error.maximum-per-user-per-post-reached": "Maximale Reaktionen pro Nutzer und Beitrag erreicht",
  "settings.title": "Plugin-Einstellungen für Reaktionen",
  "settings.enable-post-reactions": "Reaktionen auf Posts aktivieren",
  "settings.max-reactions-per-post": "Maximale eindeutige Reaktionen pro Beitrag (0 für unbegrenzt, Standard: 4)",
  "settings.max-reactions-per-user-per-post": "Maximale Reaktionen pro Nutzer und Beitrag (0 für unbegrenzt)",
  "settings.max-reactions-per-user-per-post-help": "Der Grenzwert wird nur beim Hinzufügen einer neuen Reaktion und nicht beim Hinzufügen zu einer bestehenden Reaktion eingehalten.",
  "settings.enable-message-reactions": "Reaktionen auf Nachrichten aktivieren",
  "settings.max-reactions-per-message": "Maximale eindeutige Reaktionen pro Nachricht (0 für unbegrenzt, Standard: 4)",
  "settings.max-reactions-per-user-per-message": "Maximale Reaktionen pro Benutzer und Nachricht (0 für unbegrenzt)",
  "settings.max-reactions-per-user-per-message-help": "Der Grenzwert wird nur beim Hinzufügen einer neuen Reaktion und nicht beim Hinzufügen zu einer bestehenden Reaktion eingehalten.",
  "settings.reaction-reputations": "Reaktion Ansehen (optional)",
  "settings.reaction-reputations-help": "Sie können den einzelnen Reaktionen Ansehen zuweisen. Wenn eine Reaktion auf einen Beitrag angewendet wird, erhält der Eigentümer dieses Beitrags dieses Ansehen.",
  "settings.reaction-reputations.add": "Regel hinzufügen",
  "settings.reaction-reputations.reaction": "Reaktion",
  "settings.reaction-reputations.reputation": "Ansehen",
  "settings.reaction-reputations.remove": "Löschen",
  "settings.reaction-reputations.edit": "Bearbeiten",
  "notification.user-has-reacted-with-to-your-post-in-topic": "<strong>%1</strong> hat mit %2 auf deinen Beitrag in <strong>%3</strong> reagiert",
  "notification.user-has-reacted-with-to-your-message-in-room": "<strong>%1</strong> hat mit %2 auf deine Nachricht in <strong class=\"text-nowrap\"><i class=\"fa %3\"></i>%4</strong> reagiert"
}

edit: No luck on my dev instance:

[baris]

@dave1904 there were 2 recent changes that allow this to work, one in core and one in emoji plugin

It works like this.

1. Create notification with the string [[reactions:notification.user-has-reacted-with-to-your-post-in-topic, test1, :+1:, topicTitle]]

2. When user loads the notifications we translate that string to <strong>test1</strong> has reacted with :+1: to your post in <strong>topicTitle</strong>

3. After that emoji plugin uses the hook filter:user.notifications.getNotifications and calls parse to replace :+1: with the emoji.

The translation and emoji replacement should happen here https://github.com/NodeBB/NodeBB/blob/master/src/user/notifications.js#L125-L135

[dave1904]

@baris

Thanks for the detailled explanation.
Then it's not working on my dev instance because of the missing core change.

It's working perfect on here, also for custom emojis. Great work

[DownPW]

Very cool features. Thanks @baris to add it

Here is the reactions.json for fr-FR

{
  "reactions": "Réactions",
  "add-reaction": "Ajouter une réaction",
  "error.invalid-reaction": "Réaction invalide",
  "error.maximum-reached": "Réactions maximales atteintes",
  "error.maximum-per-user-per-post-reached": "Nombre maximum de réactions par utilisateur et par publication atteint",
  "settings.title": "Paramètres du plugin Réactions",
  "settings.enable-post-reactions": "Activer les réactions aux publications",
  "settings.max-reactions-per-post": "Nombre maximum de réactions uniques par publication (0 pour illimité, par défaut : 4)",
  "settings.max-reactions-per-user-per-post": "Réactions maximales par utilisateur et par publication (0 pour illimité)",
  "settings.max-reactions-per-user-per-post-help": "La limite est appliquée uniquement lors de l'ajout d'une nouvelle réaction et non lors du partage avec une réaction existante.",
  "settings.enable-message-reactions": "Activer les réactions aux messages",
  "settings.max-reactions-per-message": "Nombre maximum de réactions uniques par message (0 pour illimité, par défaut : 4)",
  "settings.max-reactions-per-user-per-message": "Réactions maximales par utilisateur et par message (0 pour illimité)",
  "settings.max-reactions-per-user-per-message-help": "La limite est appliquée uniquement lors de l'ajout d'une nouvelle réaction et non lors du partage avec une réaction existante.",
  "settings.reaction-reputations": "Réputations de réaction (facultatif)",
  "settings.reaction-reputations-help": "Vous pouvez attribuer une réputation aux réactions individuelles. Lorsqu’une réaction est appliquée à une publication, le propriétaire de cette publication obtiendra cette réputation.",
  "settings.reaction-reputations.add": "Ajouter une règle",
  "settings.reaction-reputations.reaction": "Réaction",
  "settings.reaction-reputations.reputation": "Réputation",
  "settings.reaction-reputations.remove": "Supprimer",
  "settings.reaction-reputations.edit": "Modifier",
  "notification.user-has-reacted-with-to-your-post-in-topic": "<strong>%1</strong> a réagi avec %2 à votre message dans <strong>%3</strong>",
  "notification.user-has-reacted-with-to-your-message-in-room": "<strong>%1</strong> a réagi avec %2 à votre message dans <strong class=\"text-nowrap\"><i class=\"fa %3\"></i>%4</strong>"
}

[baris]

@DownPW, @dave1904 published 2.1.15, with the French and German translations.

[dave1904]

@baris Is core change going to be released with v3.5.1?

[baris]

@dave1904 that change has been released for a while now, it is definitely in 3.5.0

[dave1904]

@baris Ok strange, on my dev instance I'm running NodeBB v3.5.0 and nodebb-plugin-reactions v2.1.16. But the emoji alias won't be parsed as image. Already reinstalled the plugin. As it's working here it must be on my side.

[baris]

The plugin is @nodebb/nodebb-plugin-reactions there is another old plugin on npm which is called nodebb-plugin-reactions are you using that by any chance?

[dave1904]

It's definitely the right plugin, not the v0.0.4 one. Reinstalled, reordered plugins, cleared cache. Will try it on prod and see if it works there.

[dave1904]

Same on prod. Very strange

[dave1904]

This post is deleted!

[stationary_code]

The emoji doesn't appear, showing just numbers.