Kit de construction pour bot Discord 🤖

merefield · Juillet 10, 2019, 8:29

Objectif de ce plugin

Ce plugin effectue plusieurs tâches :

Il vous permet d’alimenter un bot Discord à l’aide de votre serveur Discourse pour effectuer des actions reliant les deux systèmes. Forkez ce dépôt et étendez-le avec du Ruby simple pour créer toutes sortes de fonctionnalités de bot.
Fonctionnalités existantes servant d’exemples et d’utilitaires utiles :

Fournit une publication automatique bidirectionnelle de contenu répondant à certains critères.
Commande pour copier des messages à la demande vers Discourse.
Commande pour synchroniser l’appartenance aux groupes avec l’appartenance aux rôles de votre serveur Discord et votre instance Discourse.

Le plugin fournit un squelette extensible sur lequel vous pouvez construire des fonctionnalités supplémentaires. Les PR pour des ajouts généralement utiles sont les bienvenues.

^{ce ne sont pas les deux commandes de synchronisation, mais simplement une illustration de l’interaction possible avec le bot. La deuxième commande de la capture d’écran a été obsolète pendant le développement}

Sa configuration est nécessairement complexe, mais elle est idéale pour les fans des deux systèmes qui sont désireux de consacrer du temps à comprendre le fonctionnement de chaque système, au moins au niveau fonctionnel et conceptuel. Vous devez comprendre certains des fondamentaux de la gestion des utilisateurs de Discourse et de Discord pour tirer le meilleur parti de ce plugin.

Commandes du bot

Il existe quatre commandes :

Ping!
!disckick
!discsync
!disccopy

Ping!

Pour vérifier si le bot répond, tapez simplement « Ping! » et le bot devrait répondre par « : Pong! » - magnifique, n’est-ce pas ? (c’est un peu un mème, au fait !)

!disckick <min_trust_level: défaut 2>

Taper cette commande expulsera tout utilisateur qui existe sur votre Discourse mais dont le niveau de confiance est inférieur à la valeur fournie. La valeur par défaut si vous ne fournissez pas de valeur est 2.

Par exemple :

!discsync <clean up: défaut false, min_visibility: défaut 0, include automated groups: défaut false>

Cette commande tentera de copier tous les groupes vers des Rôles sur Discord qui correspondent aux critères fournis (ou aux valeurs par défaut si non fournis). Elle tentera ensuite de peupler les rôles conformément à l’appartenance aux groupes sur Discourse. Il s’agit d’une synchronisation unidirectionnelle uniquement. Aucune donnée Discourse n’est jamais modifiée.

!disccopy <number_of_messages> <optional_target_category_name> <optional_target_topic_name>

Vous permet de copier l’historique des messages Discord vers votre instance Discourse depuis le chat Discord. Cela peut gérer des milliers de messages d’un coup (mais pour ce volume, cela prendra du temps).

Communication bidirectionnelle

Voici les paramètres :

Vous pouvez désigner un canal d’annonces sur Discord dans les paramètres du plugin.
Vous pouvez maintenant taper dans le canal d’annonces Discord assigné et cela publiera votre message dans votre sujet Discourse assigné dans les paramètres du plugin.
Vous pouvez configurer une liste de catégories dans Discourse pour publier dans le canal d’annonces de votre Discord si quelqu’un y publie ou ajoute un nouveau sujet (l’un, l’autre ou les deux).
Copie automatique de chat par message, par canal vers n’importe quelle catégorie identiquement nommée sur Discourse : si le nom du canal correspond au nom de la catégorie, le message sera copié dans Discourse.

De plus, j’ai ajouté un nouveau fichier pour gérer les événements Discord pris en charge par l’API discordrb, la logique des annonces étant le premier exemple (n’hésitez pas à en développer de nouveaux et à soumettre une PR si cela est utile à la communauté).

NB : Pour tout message copié dans Discourse depuis Discord, l’utilisateur s’affichera correctement si cet utilisateur s’est connecté à Discourse en utilisant la connexion Discord (ainsi, le bot Discord peut faire correspondre les utilisateurs).

État de ce plugin

C’est un plugin complexe à configurer. C’était inévitable.

Cependant, son utilisation est un jeu d’enfant une fois qu’il est entièrement opérationnel.

Considérez le code comme étant actuellement en Bêta. Il a été testé, même en production, mais contient probablement des bogues. Je recommande de le tester d’abord sur un nouveau serveur Discord avant de l’appliquer à votre serveur Discord principal « Production », sauf si vous commencez tout juste.

Tout bug est beaucoup plus susceptible de perturber votre instance Discord que votre instance Discourse, car aucune modification n’est apportée à Discourse. Cependant, je l’ai écrit de manière à ce que la plupart des choses soient récupérables et que vous puissiez généralement simplement répéter une action pour résoudre un problème. Discourse est utilisé comme maître pour les informations d’appartenance et de groupes, et ces données sont utilisées pour mettre à jour l’appartenance et les rôles sur votre serveur Discord.

Instructions de configuration

Prérequis

Un serveur Discord sur lequel vous êtes administrateur.
Une application Discord (voir ci-dessous).
Un bot Discord (voir ci-dessous).
Un accès SSH root à votre serveur Discourse.
Des mises à jour du fichier app.yml pour installer le plugin.
Tous les utilisateurs de votre Discourse devront se connecter en utilisant la connexion OAuth Discord qui apparaîtra sur votre page de connexion une fois le plugin installé.

Application Discord

Rendez-vous ici et créez une application :

Cliquez sur « New Application ».

Vous devrez créer un bot et cela ressemblera à ceci (laissez-le non ‘public’) :

Vous devrez autoriser le bot dans le navigateur, voir OAuth2 - Documentation - Discord

Une fois le bot configuré, copiez le jeton (Token). Vous devrez le saisir dans Discourse plus tard.

Modifications de app.yml

plugin

Vous n’avez besoin que d’un seul plugin maintenant que la connexion sociale Discord est native au cœur de Discourse (ouais )

Ensuite, à l’invite, tapez ./launcher rebuild app comme d’habitude.

Cela devrait fonctionner, pas de problème.

Vous pourriez obtenir des erreurs de console et de journal indiquant un échec du bot lors de la première construction car vous n’avez pas encore saisi les identifiants du bot dans l’interface de configuration de Discourse. (gérer cela plus élégamment est une tâche à faire, je supprimerai cette partie lorsque cela sera fait). Cela ne fera aucun mal et Discourse lui-même fonctionnera normalement.

Une fois dans votre zone d’administration Discourse, allez dans Paramètres du plugin et remplissez ces champs :

Vous obtiendrez les ID depuis l’interface Discord. Vous devrez activer le mode développeur pour vous permettre de copier ces ID. Dans Discord, allez dans vos Paramètres → Apparence → AVANCÉ et activez le mode développeur :

Vous pouvez ensuite obtenir les ID depuis l’interface, par exemple :

Vous devrez également remplir les paramètres OAuth Discord. L’ID client et le secret proviennent de votre même application Discord.

Une fois que vous avez défini ces paramètres, retournez à votre invite racine sous Linux et tapez :

./launcher restart app

Si vous avez correctement configuré vos serveurs Discord et Discourse, vous devriez voir le bot rejoindre le serveur.

Si jamais le bot plante (il passera hors ligne), vous devrez faire la même chose pour le ramener. Une indépendance améliorée du bot par rapport au serveur cœur de Discourse est une tâche à faire. Cela dit, j’ai fait fonctionner un bot en production pendant longtemps et il n’a jamais planté.

Commandes futures ?

Si vous avez une idée pour une autre commande qui exploite le lien entre Discourse et Discord et que vous pensez être utile à la communauté plus large, faites-le-moi savoir dans les réponses et nous pourrons examiner le potentiel de mise en œuvre. NB : ce bot n’est pas destiné à effectuer des tâches en dehors du cadre de Discourse.

Limitations

L’objectif principal de ce plugin était de permettre à l’utilisateur de créer un bot sur son Discord alimenté par son serveur Discourse et capable d’effectuer certaines fonctions de base de gestion des membres. Il fournit également une base pour toute interaction supplémentaire de type bot entre les deux systèmes pour le futur. Une partie de la motivation pour utiliser des bots est qu’ils sont tout simplement amusants.

Les commandes de bot sont par nature ad hoc.

Problèmes connus

Le bot démarrera une instance de lui-même si vous accédez à une session de console Rails sur le serveur. Cela fera apparaître le bot comme répondant deux fois (mais en fait, il y a maintenant deux bots). Dans la console Rails, arrêtez simplement le bot supplémentaire en tapant : ::DiscordBot::Bot.discord_bot.stop Cela ne devrait plus être nécessaire !
Le Robot est un peu bavard pendant les mises à niveau Discourse ‘en ligne’ car il est réactivé à plusieurs reprises pendant le processus de mise à niveau. Cela revient à trouver un bon moyen d’exécuter le bot dans un processus séparé et géré au lieu d’un thread dérivé du serveur web. Je crois que tout cela est inoffensif, et si la sortie des bots est uniquement vers votre canal d’administration sur Discord, est-ce que cela vous importe vraiment ? Cela devrait être résolu pour la plupart maintenant, le bot s’annonçant seulement deux fois lors d’une reconstruction.

Remerciements

Plusieurs contributeurs sont à remercier pour ce plugin qui m’a pris beaucoup de temps pour atteindre ce stade, notamment @Wedgebert, @FoohonPie. Merci à Jeff pour sa généreuse contribution. Merci à @angus pour tout l’encouragement et la gestion du soutien financier.

Le plugin a été inspiré par le travail de @Watercolor_Games à un stade antérieur et repose sur le plugin OAuth Discord créé par @featheredtoast.

Le plugin repose sur la bibliothèque Ruby discordrb semi-officielle soutenue par Discord et le travail fantastique de l’équipe Discord pour rendre leur système accessible. Merci à @Falco pour m’avoir aidé avec une dépendance de manière extrêmement réactive.

De plus, bien sûr, cela ne serait pas possible sans l’incroyable écosystème de plugins de Discourse (ouais !)

État de ces instructions

Elles seront améliorées avec le temps et j’accueille favorablement les commentaires. Il y a des zones qui sont susceptibles d’être obscures.

Owen_Walters · Juillet 14, 2019, 3:42

Salut, je suis super intéressé par ça.

Serait-il possible de faire l’inverse ? J’aimerais pouvoir créer une configuration Discourse pour mon serveur Discord. Je ne sais pas s’il existe un événement de l’API Discord pour l’attribution de rôles, mais vous pourriez probablement vérifier quand quelqu’un se connecte avec Discord ou via CRON.

merefield · Juillet 14, 2019, 5:26

Oui, tout à fait.

Vous pourriez soit le développer en tant que commande de bot pour une application ponctuelle, mais avec une fonction de répétition qui relance la commande après un certain délai (pratique mais pas très transparent et sans moyen de gérer individuellement ces répétitions)

OU

Comme je l’ai suggéré plus haut, le programmer comme une tâche dans Discourse via Sidekiq. Cela pourrait nécessiter un plugin séparé (j’avais en fait commencé à esquisser cette approche avant de passer à une solution uniquement basée sur un bot, principalement parce que l’approche « bot » correspondait à l’esprit Discord, était amusante et offrait une approche et un résultat uniques), mais si je parviens à faire en sorte que Discourse déclenche des commandes de bot, cela deviendra secondaire (je n’ai pas encore eu l’occasion de tester cela), et nous pourrons alors écrire le code une seule fois pour qu’il fonctionne dans les deux cas (super !).

Ces deux solutions reposeraient toutes deux sur la même connexion OAuth.

Bien que ce soit une excellente idée, cela ne peut pas être une priorité pour moi pour le moment, car j’ai beaucoup d’autres travaux clients à livrer actuellement. Cependant, si vous souhaitez soutenir le développement d’une telle extension, nous pouvons en discuter en privé par message privé et le programmer.

Owen_Walters · Juillet 14, 2019, 6:49

Cela pourrait être intéressant à expérimenter, mais je suis loin d’avoir le niveau de compétence requis pour me porter volontaire afin de développer ou de maintenir un tel addon. Je pourrais éventuellement créer un fork un peu brouillon à un moment donné, mais je ne veux absolument pas voir mon nom associé à quoi que ce soit d’officiel.

merefield · Juillet 14, 2019, 6:55

N’hésitez pas à vous salir les mains. C’est le seul moyen d’apprendre. :).

merefield · Juillet 17, 2019, 3:33

Correction d’un bug mineur déployée :

neemiasvf · Juillet 17, 2019, 4:15

J’ai obtenu ceci pendant la reconstruction :

Le bot est toujours hors ligne. J’ai vérifié trois fois tout et tout est correctement configuré. Je ne sais pas comment procéder maintenant… Peut-être dois-je ouvrir un port sur mon instance de serveur ?

merefield · Juillet 17, 2019, 4:17

Merci de tester cela, et si peu de temps après la mise à jour. Laissez-moi essayer de reproduire le problème, et je reviendrai vers vous. Je n’ai rien modifié concernant la configuration du port.

merefield · Juillet 17, 2019, 4:43

Aucun problème de reconstruction ici, Bot se lance correctement… Avez-vous modifié quelque chose dans la configuration de votre serveur entre-temps ?

Votre 400 Bad Request indique que votre serveur a envoyé une requête corrompue ou invalide au serveur Discord, et c’est la réponse reçue. Cela suggère que la requête a bien été reçue et n’a pas été bloquée.

Cela peut survenir dans les cas suivants :

requêtes malformées
absence d’autorisation
dépassement des limites de taux

Malheureusement, le message d’erreur ne semble pas nous permettre de déterminer laquelle de ces causes est en jeu.

Votre Discourse est-il censé être en ligne ? Vérifiez que tous les paramètres des plugins sont correctement remplis.

Pour écarter un problème temporaire, exécutez ./launcher restart app quand vous en avez l’occasion… cela mettra votre site hors ligne pendant quelques secondes seulement (désolé pour cela !).

Falco · Juillet 17, 2019, 8:03

Je vois qu’il lance le bot dans le bloc after_initialize, ce qui empêchera les migrations (et les reconstructions) si le bot est mal configuré ou si Discord est hors ligne.

Peut-être essayer de gérer cette exception et simplement la journaliser ?

merefield · Juillet 17, 2019, 8:06

Il s’exécute sur un thread séparé ? Donc je suppose que ce ne sera pas un problème ?

Cependant, ce callback semble s’exécuter plusieurs fois lors d’une reconstruction, donc le problème principal est qu’un bot mal configuré pourrait réellement dépasser les limites de taux si l’authentification échoue trop de fois en peu de temps. Si cela se produit, le compte pourrait, dans le pire des cas, être bloqué pendant un certain temps.

En tout cas, je vais appliquer rapidement un correctif pour gérer cela avec l’implémentation actuelle afin d’en réduire l’impact. Merci pour la suggestion.

MISE À JOUR : @falco, c’est fait, par exemple :

ransim · Juillet 31, 2019, 9:20

Tout d’abord, je tiens à vous remercier d’avoir créé cet outil. Une fois que je parviendrai à le faire fonctionner, il nous sera d’une grande aide pour gérer notre communauté de bénévoles sur Discourse et Discord.

Je rencontre une erreur 400 lors de l’exécution de ce bot. Avant l’ajout de ce plugin, nous utilisions avec succès le plugin d’authentification Discord officiel et les webhooks via le plugin d’intégration de chat. J’ai vérifié que ces deux éléments fonctionnent toujours correctement.

J’ai créé le bot dans la même application Discord que celle que j’avais précédemment configurée. Le bot a été autorisé sur le serveur Discord et apparaît dans la liste des membres comme étant hors ligne. Votre documentation ne précisait pas quelle valeur de permission appliquer, mais comme la plupart des bots Discord que j’ai rencontrés le demandent, j’ai configuré une valeur de permission de 8 (Administrateur).

Dans le serveur Discord, j’ai ensuite copié l’ID du rôle qu’il a créé (nommé d’après mon application) ainsi que l’ID du canal pour les messages administratifs. J’ai ajouté le rôle de l’application à ce canal avec tous les droits, juste pour être sûr, puis j’ai ajouté les IDs dans Discourse et redémarré le système.

Malheureusement, quoi que j’essaie, je continue de recevoir une erreur 400. J’ai même tenté une reconstruction pour être certain.

merefield · Juillet 31, 2019, 9:29

Merci, ce sont de gentils mots. Cela a également été rendu possible grâce à la générosité de nos bailleurs de fonds.

Oui, c’est parfait. Cela devrait nécessiter des droits d’administrateur.

C’est le deuxième signalement de ce problème.

Si vous supprimez intentionnellement le dernier caractère du jeton dans les paramètres (rappelez-vous ce que c’est), obtenez-vous une erreur 401 à la place ?

Déplaçons cela en message privé car cela pourrait devenir confus (nous pourrons toujours publier la solution ici).

ransim · Août 1, 2019, 2:26

Je poste simplement une mise à jour au cas où d’autres verraient ceci : nous enquêtons activement sur le problème, mais nous n’avons pas encore identifié la cause. Si quelqu’un d’autre rencontre ce problème, merci de le signaler ; cela nous aiderait à avoir d’autres personnes pour tester.

merefield · Août 1, 2019, 4:48

C’est maintenant corrigé. C’était un cas étrange à identifier.

Merci à @ransim pour avoir soulevé le problème et travaillé avec moi pour en comprendre la cause.

Un grand merci à l’équipe #ruby_discordrb sur Discord API pour leur aide patiente et immédiate !

@neemiasvf

p0nda · Août 30, 2019, 3:04

@merefield pas de problème, votre plugin est génial. Mais j’ai rencontré quelques problèmes maintenant.
par exemple :

Discourse Sync:  Démarrage. Veuillez patienter, je suis limité en taux pour respecter les services Discord.
Discourse Sync:  Vérification de l'existence de groupes éligibles pour la synchronisation ...
Discourse Sync: 1 groupe(s) éligible(s) a/ont été trouvé(s)
Discourse Sync:  Préparation de la liste des utilisateurs ayant également un compte enregistré sur Discord ...
Discourse Sync:  Préparation de la liste des groupes auxquels appartiennent sur Discourse les utilisateurs ayant un compte enregistré sur Discord ...
Discourse Sync: 0 groupe(s) éligible(s) avec des utilisateurs Discord a/ont été trouvé(s)
Discourse Sync:  Aucun utilisateur n'a été trouvé dans les groupes éligibles pour la synchronisation selon les critères fournis ou par défaut !

ma commande est : !discsync 4

et la commande modifiée : !discsync false 5 false

Discourse Sync:  Démarrage. Veuillez patienter, je suis limité en taux pour respecter les services Discord.
Discourse Sync:  Vérification de l'existence de groupes éligibles pour la synchronisation ...
Discourse Sync: 10 groupe(s) éligible(s) a/ont été trouvé(s)
Discourse Sync:  Préparation de la liste des utilisateurs ayant également un compte enregistré sur Discord ...
Discourse Sync:  Préparation de la liste des groupes auxquels appartiennent sur Discourse les utilisateurs ayant un compte enregistré sur Discord ...

merefield · Septembre 1, 2019, 8:50

Salut @p0nda désolé pour la réponse tardive.

Si tu inclus des paramètres, tu dois les inclure tous. Le système pourrait les interpréter de manière étrange.

blueve.in · Septembre 17, 2019, 12:38

Impossible d’afficher les paramètres étendus du bot ? J’ai apporté les modifications au fichier app.yml et installé les plugins. La configuration OAuth fonctionne, mais pas les paramètres du bot. Des idées ?

blueve.in · Septembre 17, 2019, 11:14

Les paramètres OAuth sont présents, mais aucun paramètre de bot.

i3itCoin · Septembre 17, 2019, 11:16

Voici

Sujet		Réponses	Vues
Discourse Trust Levels for Discord Development	61	10340	Novembre 29, 2019
Discord and Discourse - Better Together \| Blog Blog	12	4884	Décembre 28, 2021
Discord login and obtain discord roles in discourse Feature	3	2264	Novembre 21, 2019
Request widgetbot.io Feature	2	1157	Octobre 12, 2021
[PAID] 2-way sync Discord <-> Discourse Marketplace	2	991	Mars 10, 2023