Création d'un service de livraison de charge utile Webhook dans Go

Cet article détaille la création d'un proxy webhook à l'aide de Go, permettant le développement local d'applications qui écoutent les webhooks GitHub. La solution évite d'utiliser des services tiers comme smee.io ou ngrok en créant un serveur personnalisé et une application CLI.

Le défi réside dans la transmission des événements webhook de GitHub vers un environnement de développement localhost. Ce tutoriel présente une solution en deux parties : un serveur pour recevoir les événements GitHub et une CLI pour les transmettre à une application locale.

Architecture :

Le système comprend quatre éléments clés :

1. GitHub : La source des événements webhook.
2. Go Server : Reçoit les événements de GitHub et les transmet à la CLI.
3. Go CLI : S'exécute localement, s'abonne aux événements du serveur et les transmet à l'application locale.
4. Application locale : Un serveur factice (pour les tests) reçoit les requêtes transférées.

La communication entre la CLI et le serveur utilise les événements envoyés par le serveur (SSE), une technologie simple et unidirectionnelle.

Mise en œuvre :

La structure du projet comprend un répertoire cmd pour la CLI et les exécutables du serveur, et un répertoire internal pour les packages partagés. Le serveur utilise la bibliothèque go-sse pour la fonctionnalité SSE. La CLI utilise la bibliothèque backoff pour une gestion robuste des connexions.

*Serveur (cmd/web/main.go et internal/server/) :**

Le serveur a deux points de terminaison :

• /channel/{channel} (GET) : établit une connexion SSE avec la CLI.
• /channel/{channel} (POST) : reçoit les événements du webhook GitHub, les encode et les publie sur les CLI connectées.

CLI (cmd/cli/main.go) :

La CLI établit une connexion SSE au serveur, reçoit les requêtes codées, les décode et les transmet à l'application locale spécifiée. La gestion des erreurs et l'intervalle exponentiel sont implémentés à l'aide de la bibliothèque backoff.

Tests :

Un simple serveur de test (cmd/test/main.go) est fourni pour recevoir et traiter les événements de webhook transférés. Après avoir déployé le serveur et exécuté la CLI, l'envoi des modifications au référentiel GitHub déclenche le webhook, qui est ensuite transmis au serveur de test local.

Déploiement (Annexes) :

L'article détaille le déploiement du serveur à l'aide de Docker et Kamal, un outil de déploiement. Il couvre la création d'un Dockerfile, la configuration de Kamal, la configuration des variables d'environnement (y compris l'utilisation d'un gestionnaire de mots de passe pour la sécurité) et l'ajout d'un point de terminaison de vérification de l'état. Le processus comprend la configuration d'un droplet DigitalOcean, la configuration de l'accès SSH et la gestion des noms de domaine et des certificats SSL à l'aide de Let's Encrypt via le proxy de Kamal. Des mesures de sécurité supplémentaires et des améliorations de l'environnement de développement sont également suggérées.

Cette solution robuste fournit une méthode flexible et fiable pour gérer les webhooks GitHub pendant le développement local, éliminant ainsi le besoin de services externes. Un prochain article explorera l'extension de cette fonctionnalité pour créer un bot Telegram.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!