Développer

Toujours annoncer les fonctionnalités sur lesquelles vous voulez travailler en créant un ticket ou en commentant un ticket existant, avant de commencer à travailler dessus.Et annoncez clairement à la communauté que vous commencez à travailler dessus. Ceci afin d’éviter que plusieurs personnes travaillent sur la même chose et entrent en conflit.

Les Pull Request sont à faire sur la branche main.

Remarque

Jusqu’à mars 2023, il fallait contribuer sur la branche develop. Cette procédure est désormais obsolète.

Pré-requis pour compiler le plugin

Il est hautement recommandé d’être familier avec les concepts suivants :

Git
NodeJS
NPM
Typescript

Pour construire le module, vous avez besoin d’avoir installé les paquets suivants :

git
npm (>=8.x)
nodejs (>=14.x)
build-essential
coreutils
wget
reuse

Veuillez noter que ce plugin a besoin d’une AppImage du serveur XMPP Prosody. Cette AppImage est fournie par le project Prosody AppImage. Le script build-prosody.sh télécharge les binaires attachés à ce dépôt distant, et vérifie que les sommes de contrôles sha256 sont correctes.

Développer

Clonez le dépôt, construisez le plugin, et créez votre branche de fonctionnalité :

# Cloner le dépot. N'oubliez pas le --recursive, pour clôner les sous-modules.
git clone https://github.com/JohnXLivingston/peertube-plugin-livechat.git --recursive

cd peertube-plugin-livechat

# Installer les dépendances NPM et compiler le plugin pour la première fois :
npm install

# Compiler le plugin après une modification :
npm run build

# Si vous avez un fork du dépot, ajoutez le en remote (exemple) :
git remote add me git@github.com:MON_COMPTE_GITHUB/peertube-plugin-livechat.git

# Créez une branche locale pour vos développements et placez vous dessus (exemple) :
git checkout mon_developpement # NB: si un ticket y est associé, utilisé le nom fix_1234 (où 1234 est le numéro du ticket)
# Pour proposer vos modifications, poussez votre branche sur votre dépot (exemple) :
git push --set-upstream me mon_developpement
# Rendez-vous ensuite sur votre dépot github avec votre navigateur web pour proposer la Pull Request (voir les instructions complémentaires ci-dessous)

Quand vous êtes prêt⋅e à montrer votre code pour avoir un retour, soumettez une Pull Request draft. Quand vous êtes prêt⋅e pour une relecture de code avant merge, soumettez une Pull Request. Dans tous les cas, merci de lier votre Pull Request au ticket concerné en utilisant la syntax de GitHub : «fixes #issue_number».

Le code du front-end est dans le dossier client. Le code backend dans server. Il y a du code partagé entre les deux dans shared.

Pour les instructions génériques concernant le développement de plugins (building, installation, …), merci de vous référer à la documentation Peertube.

Vous pouvez builder le plugin avec des infos de debug supplémentaires en utilisant :

NODE_ENV=dev npm run build

Ce plugin est conforme à la norme REUSE : il utilise des en-têtes SPDX pour identifier les informations de licence de son code source. Plus d’informations sur le site REUSE. Vous pouvez utiliser l’outil en ligne de commande reuse pour vous aider à mettre à jour les en-têtes. La commande npm run lint utilisera la commande reuse pour vérifier la conformité. N’oubliez pas d’ajouter vos informations de copyright dans les en-têtes SPDX lorsque vous modifiez du code.

ESBuild versus Typescript

Ce plugin utilise ESBuild pour compiler le code front-end, comme le plugin peertube-plugin-quickstart officiel. ESBuild peut gérer Typescript, mais ne vérifie pas les types (voir la documentation ESBuild). C’est pourquoi on compile d’abord Typescript avec l’option -noEmit, juste pour vérifier les types (check:client:ts dans le fichier package.json). Ensuite, si tout est ok, on lance ESBuild pour générer le javascript compilé.

Debug Mode

Il existe un mode de debug pour le plugin, qui va raccourcir le délais de certaines actions. Par exemple, il va faire tourner les journaux toutes les deux minutes, au lieu de tous les jours. Cela permet de tester plus facilement certaines actions, pour lesquelles il faudrait normalement attendre des heures ou des jours.

Pour activer ce mode, il suffit de créer un fichier /var/www/peertube/storage/plugins/data/peertube-plugin-livechat/debug_mode (en adaptant /var/www/peertube/storage/ à votre installation le cas échéant).

La simple existance de ce fichier suffit à déclencher le mode debug. Pour être sûr qu’il est pris en compte, vous pouvez redémarrer votre instance Peertube.

Ce fichier peut également contenir du JSON qui pourra activer d’autres options. Pour en avoir la liste, vous pouvez regarder le code de server/lib/debug.ts. Redémarrez Peertube après chaque modification de son contenu.

Avertissement

N’activer jamais ce mode sur un serveur de production, ni même sur un serveur public. Cela pourrait poser des problèmes de sécurité.

Redémarrer Prosody

Pour redémarrer Prosody quand le mode debug est activé, vous pouvez appeler l’API http://votre_instance.tld/plugins/livechat/router/api/restart_prosody. Cet appel n’a pas besoin d’authentification. Il peut se faire depuis une ligne de commande, par exemple avec `curl http://votre_instance.tld/plugins/livechat/router/api/restart_prosody.

debugger Prosody

Il est possible de connecter l’AppImage Prosody à un debugger distant en utilisant MobDebug.

Pour cela, placer MobDebug dans un dossier accessible par le user peertube. Ensuite, ajouter cela dans le fichier debug_mode du plugin :

{
  "debug_prosody": {
    "debugger_path": "/le_chemin_vers_mobdebug/src",
    "host": "localhost",
    "port": "8172"
  }
}

host et port sont optionnels. debugger_path doit pointer vers le dossier où se trouve le fichier .lua de MobDebug.

Redémarrer Peertube.

Lancer votre serveur de debug.

Pour que Prosody se connecte au debugger, appelez l’API http://votre_instance.tld/plugins/livechat/router/api/restart_prosody?debugger=true. Cet appel n’a pas besoin d’authentification. Il peut se faire depuis une ligne de commande, par exemple avec curl http://votre_instance.tld/plugins/livechat/router/api/restart_prosody?debugger=true. Vous pouvez même configurer votre serveur de debuggage pour lancer cette commande automatiquement.

Prosody va alors redémarrer en se connectant au debugger.

Environnement de développement rapide via Docker

Un tutoriel est disponible sur le forum Peertube pour expliquer comment monter rapidement un environnement de développement en utilisant Docker.

Un dépot a été crée sur la base de ce tutoriel : pt-plugin-dev.

Note : pour une raison obscure, Prosody n’arrive pas à résoudre les adresses DNS des conteneurs quand la librairie lua-unbound est utilisée. Pour contourner cela, il y a un «dirty hack» : il suffit de créer une fichier /data/plugins/data/peertube-plugin-livechat/no_lua_unbound dans vos docker-volumes, puis de les redémarrer.

Reconstruire et installer rapidement le plugin

Lorsque vous faites des modifications, vous n’avez pas besoin de reconstruire le projet complet, et de réinstaller le plugin sur votre environnement de développement. Vous pouvez ne construire que la partie modifiée (par exemple, si vous n’avez modifié que les fichiers clients : npm run build:client). Vous trouverez la liste des scripts de construction disponibles dans le fichier package.json.

Lorsque le plugin est déjà installé sur votre instance de développement, et que vous n’avez modifié aucune dépendance, vous pouvez installer rapidement votre travail en suivant les étapes suivantes :

reconstruire les parties nécessaires du plugin (client, styles, …),
écraser le contenu de data/plugins/node_modules/peertube-plugin-livechat/dist/ de votre instance de développement par le contenu du dossier dist du plugin,
changer récursivement le propriétaire des fichiers plugins/node_modules/peertube-plugin-livechat/dist/ pour votre utilisateur peertube,
Redémarrez votre instance.

Tests de performance

Le dépôt livechat-perf-test contient quelques outils pour effectuer des tests de performance. Ils peuvent être utilisés pour évaluer les améliorations du code source, ou trouver les goulots d’étranglement.