Skip to content
This repository has been archived by the owner on Aug 5, 2024. It is now read-only.
/ secretariat Public archive

La webapp espace membre de l’incubateur đŸ’â€â™‚ïžđŸ‘©â€đŸ’»

License

Notifications You must be signed in to change notification settings

betagouv/secretariat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Espace Membre

L'espace membre de l’incubateur

Dev de l'app Espace Membre

Variables d'environnement

  • Variables d'environnement nĂ©cessaires :
    • OVH_APP_KEY - Obtenir les credentials OVH pour dĂ©bugger
    • OVH_APP_SECRET
    • OVH_CONSUMER_KEY
    • SESSION_SECRET - ClĂ© de 32 caractĂšre alĂ©atoires, important en prod
    • MAIL_SERVICE - Service gĂ©rĂ© par nodemailer (DĂ©bugger SMTP en local). Si absente, MAIL_HOST, MAIL_PORT, et MAIL_IGNORE_TLS seront utilisĂ©es.
    • MAIL_USER
    • MAIL_PASS
    • SECURE - true si https sinon false
    • HOSTNAME - Par exemple localhost pour le dĂ©veloppement en local
    • CHAT_WEBHOOK_URL_SECRETARIAT - Adresse d'envoi des notifications Mattermost (anciennement Slack) pour le canal "#secretariat" - par ex. : https://hooks.mattermost.com/services/... (DĂ©bugger sans Mattermost)
    • CHAT_WEBHOOK_URL_GENERAL - Adresse d'envoi des notifications Mattermost (anciennement Slack) pour le canal "#general" - par ex. : https://hooks.mattermost.com/services/... (DĂ©bugger sans Mattermost)
    • DATABASE_URL - Le string de connexion pour se connecter Ă  Postgres (pensez Ă  Ă©chapper les caractĂšres spĂ©ciaux s'il s'agit d'une URI). Le string de connexion doit contenir le user, password, host, port et le nom de la base de donnĂ©es.
    • GITHUB_TOKEN - Le Personal Access Token du compte Github utilisĂ© pour crĂ©er les PR des nouvelles recrues
    • GITHUB_REPOSITORY - Le repository Github qui contient les fiches des utilisateurs (par ex: betagouv/beta.gouv.fr)
    • GITHUB_FORK - Le fork du GITHUB_REPOSITORY utilisĂ© pour crĂ©er les PRs, (par ex: test-user/beta.gouv.fr).
    • GITHUB_ORG_ADMIN_TOKEN - Le Personal Access Token du compte Github utilisĂ© pour gĂ©rer les membres de la communautĂ©
  • Variables d'environnement optionnelles :
    • SECRETARIAT_DOMAIN - Domaine OVH Ă  utiliser (DĂ©bugger avec un autre domaine OVH)
    • USERS_API - API User Ă  utiliser (DĂ©bugger avec une autre API)
    • POSTGRES_PASSWORD - Cette variable sert Ă  lancer l'image docker de postgres et donc seulement nĂ©cessaire si Docker est utilisĂ© pour le dĂ©veloppement.
    • MAIL_HOST - Si la variable MAIL_SERVICE est absente, cette variable sera utilisĂ©e pour spĂ©cifier le hostname ou adresse IP Ă  utiliser pour l'envoi d'emails avec Nodemailer.
    • MAIL_PORT - Si la variable MAIL_SERVICE est absente, cette variable sera utilisĂ©e pour spĂ©cifier le port Ă  utiliser pour l'envoi d'emails avec Nodemailer.
    • MAIL_IGNORE_TLS - Si la variable MAIL_SERVICE est absente, cette variable sera utilisĂ©e pour l'utilisation de TLS dans la connexion email avec Nodemailer.
    • NEWSLETTER_HASH_SECRET - ClĂ© pour gĂ©nĂ©rer un id pour les newsletters, important en prod
    • INVESTIGATION_REPORTS_IFRAME_URL - URL de l'iframe Airtable contenant les bilans d'investigations et qui est intĂ©grĂ©e Ă  la page ressources
    • GITHUB_ORGANIZATION_NAME - Nom de l'organization github Ă  laquelle inviter les membres
    • MATTERMOST_INVITE_ID - ID secret de l'invitation qui permet de se crĂ©er un compte sur l'espace mattermost https://mattermost.incubateur.net/signup_user_complete/?id=[ID]
    • MATTERMOST_TEAM_ID - ID de la team CommunautĂ©
    • MATTERMOST_BOT_TOKEN - Token du bot mattermost qui permet de faire les requĂȘtes Ă  l'api

Lancer en mode développement

Une fois Postgres lancé, vous pouvez démarrer l'application avec ces commandes :

  • CrĂ©er le fichier de configuration : cp .env.example .env et le remplir avec les identifiants OVH obtenus plus haut.
» npm install # RécupÚre les dépendances
» npm run migrate # Applique les migrations
» npm run seed # Ajoute des utilisateurs dans la base users. Utilisez l'un des primary_email présent dans la bdd pour vous connecter
» npm run dev
   ...
   Running on port: 8100

L'application sera disponible sur http://localhost:8100 (8100 est le port par défaut, vous pouvez le changer avec la variable d'env PORT)

Lancer avec docker-compose

  • CrĂ©er le fichier de configuration : cp .env.example .env et le remplir avec les identifiants OVH obtenus plus haut.
  • Lancer le service et initialiser la base de donnĂ©es : docker-compose up - disponible sur http://localhost:8100
  • Pour ajouter des donnĂ©es Ă  la base de donnĂ©es (facultatif): docker-compose run web npm run seed;
  • Lancer les tests : docker-compose run web npm test

Lancer avec docker sans docker-compose

  • Exemple pour dĂ©velopper dans un container :
    • docker run --rm --env-file ../.env.secretariat.dev -v $(pwd):/app -w /app -ti -p 8100 node /bin/bash (avec vos variables d'environnement dans ../.env.secretariat.dev)

Lancer en mode production

» npm run start
   ...
   Running on port: 8100

Lancer les tests

» npm run test

Générer clé API OVH

Si vous n'avez pas les droits pour générer les credentials OVH, postez un message sur #incubateur-amélioration-secretariat.

Lien : https://eu.api.ovh.com/createToken/

  • NĂ©cessaires pour les fonctionalitĂ©s en cours
GET /email/domain/beta.gouv.fr/*
POST /email/domain/beta.gouv.fr/account
DELETE /email/domain/beta.gouv.fr/account/*
POST /email/domain/beta.gouv.fr/redirection
DELETE /email/domain/beta.gouv.fr/redirection/*
POST /email/domain/beta.gouv.fr/account/*/changePassword
  • NĂ©cessaires pour les prochaines fonctionalitĂ©s
POST /email/domain/beta.gouv.fr/mailingList
POST /email/domain/beta.gouv.fr/mailingList/*/subscriber
DELETE /email/domain/beta.gouv.fr/mailingList/*/subscriber/*
GET /email/domain/beta.gouv.fr/mailingList/*/subscriber
GET /email/domain/beta.gouv.fr/responder/*
POST /email/domain/beta.gouv.fr/responder
PUT /email/domain/beta.gouv.fr/responder/*
DELETE /email/domain/beta.gouv.fr/responder/*

Debug avec le serveur SMTP Maildev

Maildev est un serveur SMTP avec une interface web conçus pour le développement et les tests.

Sans docker: Une fois installé et lancé, il suffit de mettre la variable d'environnement MAIL_SERVICE à maildev pour l'utiliser. MAIL_USER et MAIL_PASS ne sont pas nécessaires.

Avec docker: ne pas préciser de MAIL_SERVICE, les bonnes variables d'environnement sont déjà précisées dans le docker-compose

Tous les emails envoyés par le code de l'espace membre seront visibles depuis l'interface web de Maildev (http://localhost:1080/).

Debug sans notifications Mattermost

Pour certaines actions, l'espace membre envoie une notification Mattermost. En local, vous pouvez mettre les variables d'environnements CHAT_WEBHOOK_URL_SECRETARIAT et CHAT_WEBHOOK_URL_GENERAL Ă  un service qui reçoit des requĂȘtes POST et rĂ©pond avec un 200 OK systĂ©matiquement.

Beeceptor permet de le faire avec une interface en ligne sans besoin de télécharger quoi que ce soit.

Sinon, certains outils gratuits comme Mockoon ou Postman permettent de créer des serveurs mock facilement aussi (Guide Postman).

Debug avec un autre domaine OVH

Lorsqu'on utilise un autre domaine OVH (par exemple, un domain bac-Ă -sable pour le dĂ©veloppement), la variable SECRETARIAT_DOMAIN doit ĂȘtre renseignĂ©e. Par dĂ©faut, le domaine est beta.gouv.fr.

Debug avec une autre API utilisateur

Configurer la variable d'environnement USERS_API (par défaut à https://beta.gouv.fr/api/v1.6/authors.json)

Créer des migrations

KnexJS permet de créer des migrations de base de données. Un shortcut a été ajouté au package.json pour créer une migration :

npm run makeMigration <nom de la migration>

Une fois la migration créée, vous pouvez l'appliquer avec :

npm run migrate

Pour utiliser d'autres commandes, le CLI de KnexJS est disponible avec ./node_modules/knex/bin/cli.js. Par exemple, pour faire un rollback :

./node_modules/knex/bin/cli.js migrate:rollback

Scripts pour faire des taches en local

Générer le graphe des redirections emails

  • Configurer les variables d'environnements : OVH_APP_KEY, OVH_APP_SECRET et OVH_CONSUMER_KEY (Avec une clĂ© ayant un accĂšs aux emails)
  • Lancer le script : node ./scripts/export_redirections_to_dot.ts > redirections.dot
  • Lancer graphviz : dot -Tpdf redirections.dot -o redirections.pdf (Format disponible : svg,png, ...)

Supprimer une redirection

  • Configurer les variables d'environnements : OVH_APP_KEY, OVH_APP_SECRET et OVH_CONSUMER_KEY (Avec une clĂ© ayant un accĂšs aux emails)
  • Lancer le script : node ./scripts/delete_redirections.js from@beta.gouv.fr to@example.com

Explication du fonctionnement des pull requests Github

En prod, l'app sécrétariat génÚre des pulls requests sur le github reposity betagouv/beta.gouv.fr. Pour cela une une branche est créée sur un fork du repository betagrouv/beta.gouv.fr et une pull request est effectuée depuis ce fork vers ce repository initial betagouv/beta.gouv.fr.

Pourquoi utiliser un fork ?

Afin de créer une branche et faire une pull request sur un repository, on donne les droits d'accÚs en écriture sur ce repository via un token (GITHUB_TOKEN) utilisé par le code. Pour prévenir tout problÚme ces droits sont donnés sur le repository "fork", et non sur le repository principal.

Il faut donc préciser ces variables d'environnement:

  • GITHUB_TOKEN - Le Personal Access Token du compte Github utilisĂ© pour crĂ©er les PR des nouvelles recrues. Ce token doit contenir les droits d'Ă©criture Ă  GITHUB_FORK.
  • GITHUB_REPOSITORY - Le repository Github qui contient les fiches des utilisateurs (par ex: betagouv/beta.gouv.fr). L'application n'a pas des droits d'Ă©criture sur ce repository.
  • GITHUB_FORK - Le fork du GITHUB_REPOSITORY auquel l'application a des droits d'accĂšs en Ă©criture

En dev : le GITHUB_REPOSITORY est un fork de betagouv/beta.gouv.fr, et le GITHUB_FORK un fork de ce fork.

Pour simplifier, on peut utiliser des repos communs entre dev. Demandez a vos collÚgues le nom des repository à spécifer dans le .env ainsi que les droits d'accÚs au resository GITHUB_FORK

About

La webapp espace membre de l’incubateur đŸ’â€â™‚ïžđŸ‘©â€đŸ’»

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published