instants.js

Mon Instant de bonheur est un projet initié par jraigneau lors d’une formation – dans le cadre de cette formation chaque participant devait montrer un de ses talents. Pour ma part, j’ai rapidement codé un prototype d’application: un talent comme un autre!

Cette application, basée sur un autre projet (MrPourquoi) m'a permis de tester différentes technologies:

  • Le serveur/framework node.js en javascript basé sur le moteur V8
  • Le framework web express utilisant les mêmes idées que sinatra
  • La base de donnée NoSQL mongodb via mongoose
  • les fonctionnalités de map/reduce de mongodb
  • Le moteur de template jade
  • le kit de démarrage css/javascript bootstrap de Twitter
  • la génération de documentation (cette page!) via docco
  • L'envoi de mails via railgun

Pour utiliser l'application, rendez-vous directement sur mon.instant-de-bonheur.fr

Pour étudier et/ou récupérer le code complet du projet, n'hésitez pas à vous connecter au dépôt Github github.com/jraigneau/instant

Configuration de l'application

 
             		           
                               
                            
                                
               
Déclaration des dépendances
             		                            
var express = require('express');       //le framework web express
var mongoose = require('mongoose');     //La librairie pour accéder à mongodb
var csrf = require('express-csrf');     //la protection anti csrf
var mailgun = require("mailgun");       //la librairie pour envoyer des mails via mailgun
             		           
                               
                            
                                
               
Création de l'application express
             		                            
var app = module.exports = express.createServer();
             		           
                               
                            
                                
               
Déclaration d'un helper dynamique pour la protection cross-site request forgery
             		                            
app.dynamicHelpers({
    csrf: csrf.token
});
             		           
                               
                            
                                
               
Configuration de l'application, notamment des modules (ou middleware) express utilisés



Cette configuration est commune à l'environnement de développement et à l'environnement de production
             		                            
app.configure(function(){
  app.set('views', __dirname + '/views');                       // Définition du répertoire contenant les vues
  app.set('view engine', 'jade');                               // Le moteur de template - Jade
  app.use(express.favicon());                                   // un favicon automatique (pour éviter des erreurs 404 systématiques dans les logs)
  app.use(express.bodyParser());                                // Pour gérer les formulaires
  app.use(express.cookieParser());                              // Pour la gestion des cookies et des sessions
  app.use(express.session({ secret: 'awfjepyionn14962wxcv' })); // clé d'encodage pour les cookies et les sessions
  app.use(express.methodOverride());                            // middleware pour la gestion des actions http (post/get/put/delete)
  app.use(app.router);                                          // Routage des urls
  app.use(express.static(__dirname + '/public'));               // le répertoire contenant les images, javascript et css
  app.use(csrf.check());                                        // le module anti-csrf
             		           
                               
                            
                                
               
Utilisation de page 404 customisée (cf views/404.jade)
             		                            
  app.use(function(req, res, next){
    res.render('404', { status: 404, url: req.url, title: "Erreur" });
  });
             		           
                               
                            
                                
               
Utilisation de page 40x et 50x customisée (cf views/500.jade)
             		                            
  app.use(function(err, req, res, next){
    res.render('500', {
      status: err.status || 500
    , abuse: ''
    , error: err
    , title: "Erreur"
    });
  });

});
             		           
                               
                            
                                
               
Déclaration de la configuration spécifique à l'environnement de développement: 
Ici on décide de faire apparaître clairement les erreurs avec les traces
Récupération de la variable d'environnement mongodburl, à paramétrer via export mongodburl=mongodb://:@:/
             		                            
app.configure('development', function(){
  app.use(express.errorHandler({ dumpExceptions: true, showStack: true }));
  mongoose.connect(process.env.mongodb_url);
});
             		           
                               
                            
                                
               
Déclaratio de la configuration spécifique à l'environnement de production: 
Pas de trace affichée en production
Récupération de la variable d'environnement mongodb_url, spécifique à l'hébergement sous heroku
             		                            
app.configure('production', function(){
  app.use(express.errorHandler());
  mongoose.connect(process.env.mongodb_url);

});
             		           
                               
                            
                                
               
Préparation de la gestion des données
             		                            
             		           
                               
                            
                                
               
Déclaration des modèles MongoDB
             		                            
var Schema = mongoose.Schema
  , ObjectId = Schema.ObjectId;
             		           
                               
                            
                                
               
Le modèle des commentaires Comments qui sera inclus dans chaque bonheur (embedded document pour mongodb)
Le champ author est un index
             		                            
var Comments = new Schema({
    author    : { type: String, index:  true  }
  , body      : String
  , date      : Date
});
             		           
                               
                            
                                
               
Le modèle des bonheurs Bonheurs, vous noterez la liste des commentaires comments incluse
             		                            
var Bonheurs = new Schema({
    author    : { type: String, index:  true  }
  , body      : String
  , date      : Date
  , nb_comments: Number // Nombre de commentaires -- utile pour les stats
  , comments   : [Comments]
  , votes : Number
});
             		           
                               
                            
                                
               
Déclaration des modèles pour utilisation dans le code
             		                            
var Bonheur = mongoose.model('bonheurs', Bonheurs)
var Comment = mongoose.model('commentaires', Comments)
             		           
                               
                            
                                
               
Début de la déclaration des Routes



Il est important de noter que nous utilisons du javascript, par conséquent tout fonctionne via
callbacks et des conditions imbriquées.
             		                            
             		           
                               
                            
                                
               
Page d'erreur 404
             		                            
app.get('/404', function(req, res, next){
  next(); // Permet d'aller à l'action suivante (cf la configuration et les fonctions définies plus haut)
});
             		           
                               
                            
                                
               
Page d'erreur 500
             		                            
app.get('/500', function(req, res, next){
  next(new Error('Holy guacamole!'));
});
             		           
                               
                            
                                
               
Index de l'application
             		                            
app.get('/', function(req, res){
  Bonheur.find({},[],{skip:0,limit:3, sort:{date : -1} },function (err, doc){      //Utilisation de la fonction find avec une limite de 5 bonheurs
    if(err != null) {
      console.log("Error in GET /" + err);
      req.flash('error', 'Bloody tzatziki! Une erreur est survenue et la liste des instants de bonheur n\'a pas été trouvée dans la base. Pourquoi ne pas réessayer ?');
      res.redirect('back');
    } else if(doc == null) {
      req.flash('error', 'Holy guacamole! Nous sommes désolé mais nous n\'avons pas trouvé d\'instant de bonheur en base - pourquoi ne pas en partager un ? ');
      res.redirect('back');
    } else {
             		           
                               
                            
                                
               
Fonction de map qui renvoie la liste des commentaires au bonheur avec (idbonheur, commentbody, comment_date)
             		                            
      mapFunction = function() {
        var bonheur_id = this._id
        this.comments.forEach(function(comment) {
          emit(comment._id, {comment_body: comment.body,comment_date: comment.date, bonheur_id: bonheur_id});
        });
      }; 
             		           
                               
                            
                                
               
Fontion de reduce qui fait la somme du nbre de commentaires/votes à partir des données émises
par la fonction de map, puis retourne un array de résultat
             		                            
      reduceFunction = function(key, values) { //reduce function
        var result = {comment_body: "", comment_date: 0, bonheur_id: ""};
        values.forEach(function(value) {
          result.comment_body = value.comment_body;
          result.comment_date = value.comment_date;
          result.bonheur_id = value.bonheur_id;
        });
        return result;
      };
             		           
                               
                            
                                
               
Préparation de la commande qui sera envoyée à mongodb et stockée dans mrlistcomments



Utilisation du mode replace pour remplacer les résultats à chaque nouvelle requète
             		                            
      var command = {
        mapreduce: "bonheurs", 
        map: mapFunction.toString(), 
        reduce: reduceFunction.toString(),
        out: {replace:"mr_list_comments"}
      };
             		           
                               
                            
                                
               
Execution de la commande mapreducecmd de map/reduce pour récupérer le nombre total de réponse
             		                            
      mongoose.connection.db.executeDbCommand(command, function(err, doc) {if(err !=null) { console.log("Error in GET /" + err);}});
      
             		           
                               
                            
                                
               
Récupération des résultats (commande spécifique à mongoose)
             		                            
      mongoose.connection.db.collection('mr_list_comments', function(err, collection) { 
        if(err != null) {
          console.log("Error in GET /" + err);
          req.flash('error', 'Bloody tzatziki! Une erreur est survenue et la liste d\'instants de bonheur n\'a pas été trouvée dans la base. Pourquoi ne pas réessayer ?');
          res.redirect('back');
        } else {
          collection.find({},[],{skip:0,limit:3, sort:{_id : -1} }).toArray(function(err, mr_comments) { //tri par l'id: très laid mais pas trouvé encore d'autres solutions
            if(err != null) {
              console.log("Error in GET /" + err);
              req.flash('error', 'Bloody tzatziki! Une erreur est survenue et la liste d\'instants de bonheur n\'a pas été trouvée dans la base. Pourquoi ne pas réessayer ?');
              res.redirect('back');
            } else {
              res.render('index', {          // on utilise le template index.jade
              title: 'Accueil',            // Le titre (champ utilisé dans layout.jade)
              abuse: 'index',
              bonheurs: doc,
              comments: mr_comments,
              locals: {flash: req.flash()}  // Pour s'assurer que les messages flash seront bien transmis
              });

              }
            });
          }
        });
    }
  });



});
             		           
                               
                            
                                
               
Gestion du vote pour un bonheur



En entrée nous avons l'id du bonheur
             		                            
app.get('/bonheur/:id/vote', function(req, res){

  if(req.params.id == null || req.params.id == ''){           // Vérification que l'id est bien dans la requête, sinon un message d'erreur
    req.flash('error', 'Holy guacamole! Nous sommes désolé mais nous n\'avons pas trouvé l\'instant :( ');
    res.redirect('back');
  } else {
  
    Bonheur.findById(req.params.id, function (err, doc){     // Recherche du bonheur correspondant à l'id en base
      if(err != null) {                                       // Une erreur est survenue pendant la recherche en base
        console.log("Error in GET /Bonheur/:id/vote" + err); 
        req.flash('error', 'Bloody tzatziki! Une erreur est survenue et votre instant de bonheur n\'a pas été trouvé dans la base. Pourquoi ne pas réessayer ?');
        res.redirect('back');
      } else if(doc == null) {                                // Aucun bonheur ne correspond à l'id => envoi d'un message d'erreur
          req.flash('error', 'Holy guacamole! Nous sommes désolé mais nous n\'avons pas trouvé l\'instant  :( ');
          res.redirect('back');
      } else {
        doc.votes = doc.votes + 1;                            // On ajoute un vote supplémentaire au bonheur
        doc.save(function (err) {                             // Sauvegarde du bonheur en base
          if(err == null) {                                   // Tout s'est bien passé: retour à la page précédente avec un message
            req.flash('success', 'Bravo! vous avez voté pour un instant de bonheur qui devient ainsi un peu plus populaire gràce à vous');
            res.redirect('back');
          } else {                                            // La sauvegarde a échoué - retour à la page précédente avec un message d'alerte
            console.log("Error in GET /Bonheur/:id/vote" + err);
            req.flash('error', 'Bloody tzatziki! Une erreur est survenue et votre vote n\'a pas été enregistré. Pourquoi ne pas réessayer ?');
            res.redirect('back');
          }
        });
      }
    });
  }
});
             		           
                               
                            
                                
               
Commenter un bonheur via un POST



En entrée l'id du bonheur dans l'url et req.body.comment.text pour récupérer le texte
du bonheur dans le formulaire
             		                            
app.post('/bonheur/:id/commentaire', function(req, res){

  if(req.params.id == null || req.params.id == ''){         //Vérification qu'un id a bien été entré
    req.flash('error', 'Holy guacamole! Nous sommes désolé mais nous n\'avons pas trouvé l\'instant de bonheur pour y apporter un commentaire :( ');
    res.redirect('back');
  } else {
  
    Bonheur.findById(req.params.id, function (err, doc){  //Recherche du bonheur en base via l'id
      if(err != null) {
        console.log("Error in GET /bonheur/:id/comment" + err);
        req.flash('error', 'Bloody tzatziki! Une erreur est survenue et votre instant de bonheur n\'a pas été trouvé dans la base. Pourquoi ne pas réessayer ?');
        res.redirect('back');
      } else if(doc == null) {
          req.flash('error', 'Holy guacamole! Nous sommes désolé mais nous n\'avons pas trouvé l\'instant :( ');
          res.redirect('back');
      } else {                                             //Le bonheur existe - il est donc possible de commenter
         if(req.body.comment.text==null || req.body.comment.text=='' || req.body.comment.author=='' || req.body.comment.author==null ){//Vérification qu'un texte pour le commetaire a bien été entré dans le formulaire
            req.flash('error', 'Holy guacamole! Pour commenter un bonheur, il faut d\'abord remplir les champs ci-dessous !');
            res.redirect('back');
          } else {
             		           
                               
                            
                                
               
Création d'un objet Comments et initialisation
             		                            
          var comment = new Comment();
          comment.author = req.body.comment.author;
          comment.date = new Date();
          comment.votes = 0;
          comment.body = req.body.comment.text;
          doc.nb_comments = doc.nb_comments + 1;
          doc.comments.push(comment); // On ajoute l'objet **Comment** dans le bonheur via la méthode **push()**
          doc.save(function (err) { // Sauvegarde du bonheur
            if(err == null) {
              req.flash('success', 'Merci ! vous avez partagé un commentaire sur un instant de bonheur avec nous - pourquoi ne pas lire et commenter d\'autres instants de bonheur ?');
              res.redirect('back');
            } else {
              console.log("Error inGET /bonheur/:id/comment" + err);
              req.flash('error', 'Bloody tzatziki! Une erreur est survenue et votre commentaire n\'a pas été enregistré. Pourquoi ne pas réessayer ?');
              res.redirect('back');
            }
          });
        }
      }
    });
  }
});
             		           
                               
                            
                                
               
Récupération des données d'un bonheur via son id
             		                            
app.get('/bonheur/:id/show', function(req, res){

  if(req.params.id == null || req.params.id == ''){
    req.flash('error', 'Holy guacamole! Nous sommes désolé mais nous n\'avons pas trouvé l\'instant de bonheur  :( ');
    res.redirect('back');
  } else {
  
    Bonheur.findById(req.params.id, function (err, doc){
      if(err != null) {
        console.log("Error in GET /bonheur/:id" + err);
        req.flash('error', 'Bloody tzatziki! Une erreur est survenue et votre instant de bonheur n\'a pas été trouvé dans la base. Pourquoi ne pas réessayer ?');
        res.redirect('back');
      } else if(doc == null) {
          req.flash('error', 'Holy guacamole! Nous sommes désolé mais nous n\'avons pas trouvé l\'instant de bonheur  :( ');
          res.redirect('back');
      } else {
          res.render('view_bonheur', {             // Affichage de view_bonheur.jade
            title: 'Un instant de bonheur et ses commentaires',
            abuse: req.params.id,
            bonheur: doc,                          // l'objet Bonheur est envoyé dans le template pour utilisation des données
            locals: {flash: req.flash()}
          });
      }
    });
  }
});
             		           
                               
                            
                                
               
Affichage du formulaire pour créer un nouveau bonheur
             		                            
app.get('/bonheur', function(req, res){
  res.render('bonheur', {
    title: 'Partager un instant de bonheur',
    abuse: '',
    locals: {flash: req.flash()}
  });
});
             		           
                               
                            
                                
               
Création d'un nouveau bonheur en base



En entrée on a un formulaire contenant le texte du bonheur, récupérable via
req.body.bonheur.text
             		                            
app.post('/bonheur', function(req, res){
             		           
                               
                            
                                
               
console.log("req.body:" + req.body.bonheur.text); 
             		                            
  if(req.body.bonheur.text==null || req.body.bonheur.text=='' || req.body.bonheur.author==null || req.body.bonheur.author =='' ){
    req.flash('error', 'Holy guacamole! Pour partager un bonheur, il faut d\'abord remplir tous les champs ci-dessous !');
    res.redirect('back');
  } else {
             		           
                               
                            
                                
               
Création d'un objet Bonheur et initialisation avec les données
             		                            
    var bonheur = new Bonheur();
    bonheur.author =  req.body.bonheur.author;
    bonheur.date = new Date();
    bonheur.votes = 0;
    bonheur.nb_comments = 0;
    bonheur.body = req.body.bonheur.text;
    bonheur.save(function (err) { //Insertion de l'objet en base
      if(err == null) {
        req.flash('success', 'Bien joué! Votre instant de bonheur a bien été partagé');
      } else {
        console.log("Error in POST /bonheur:" + err);
        req.flash('error', 'Bloody tzatziki! Une erreur est survenue et votre instant de bonheur n\'a pas été partagé. Pourquoi ne pas réessayer ?');
        res.redirect('back');
      }
    });
    res.redirect('/bonheur/'+bonheur._id+'/show');
  }
});
             		           
                               
                            
                                
               
Récupération de la liste de toutes les bonheurs



Utilisation de mapreduce pour calculer le nbre de commentaires/votes totaux basé sur kylebanker.com et sur 
wmilesn.com
             		                            
app.get('/bonheur/list', function(req, res){


  Bonheur.find(function (err, doc){      //Utilisation de la fonction find sans critère => nous récupérons donc tous les éléments en base
    if(err != null) {
      console.log("Error in GET /bonheur/list" + err);
      req.flash('error', 'Bloody tzatziki! Une erreur est survenue et la liste des instants de bonheur n\'a pas été trouvée dans la base. Pourquoi ne pas réessayer ?');
      res.redirect('back');
    } else if(doc == null) {
      req.flash('error', 'Holy guacamole! Nous sommes désolé mais nous n\'avons pas trouvé d\'instant en base - pourquoi ne pas en rédiger un ? ');
      res.redirect('back');
    } else {
             		           
                               
                            
                                
               
Fonction de map qui renvoie le nbre de commentaires et et le nombre de votes totaux par
bonheur, en utilisant une clé comment_vote qui sera commune pour faire l'aggrégation
totale
             		                            
      mapFunction = function() {
        emit("comment_vote", {comments: this.nb_comments, votes: this.votes});
      }; 
             		           
                               
                            
                                
               
Fontion de reduce qui fait la somme du nbre de commentaires/votes à partir des données émises
par la fonction de map, puis retourne un array de résultat
             		                            
      reduceFunction = function(key, values) { //reduce function
        var result = {comments: 0, votes: 0};
        values.forEach(function(value) {
          result.comments += value.comments;
          result.votes += value.votes;
        });
        return result;
      };
      
             		           
                               
                            
                                
               
Préparation de la commande qui sera envoyée à mongodb et stockée dans mrbonheurscomments



Utilisation du mode replace pour remplacer les résultats à chaque nouvelle requète
             		                            
      var command = {
        mapreduce: "bonheurs", 
        map: mapFunction.toString(), 
        reduce: reduceFunction.toString(),
        out: {replace: "mr_bonheurs_comments"}
      };
             		           
                               
                            
                                
               
Execution de la commande mapreducecmd de map/reduce pour récupérer le nombre total de commentaires
             		                            
      mongoose.connection.db.executeDbCommand(command, function(err, doc) {});
             		           
                               
                            
                                
               
Récupération des résultats (commande spécifique à mongoose)
             		                            
      mongoose.connection.db.collection('mr_bonheurs_comments', function(err, collection) { 
        if(err != null) {
          console.log("Error in GET /bonheur/list" + err);
          req.flash('error', 'Bloody tzatziki! Une erreur est survenue et la liste de bonheurs n\'a pas été trouvée dans la base. Pourquoi ne pas réessayer ?');
          res.redirect('back');
        } else {
          collection.find({}).toArray(function(err, mr_comments) {
            if(err != null) {
              console.log("Error in GET /bonheur/list" + err);
              req.flash('error', 'Bloody tzatziki! Une erreur est survenue et la liste de bonheurs n\'a pas été trouvée dans la base. Pourquoi ne pas réessayer ?');
              res.redirect('back');
            } else {
              var nb_comments = 0;
              var nb_votes = 0;
             		           
                               
                            
                                
               
Vérification qu'on a bien récupéer quelque chose qui se trouve à la position 0 de
l'array
             		                            
              if(mr_comments.length>0) {
                nb_comments = mr_comments[0].value.comments;
                nb_votes = mr_comments[0].value.votes;
              }

              res.render('list_bonheurs', {  //On affiche le template list_bonheurs.jade
                title: 'Les instants de bonheur',
                abuse: 'liste_page1',
                bonheurs: doc,
                comments: nb_comments,
                votes: nb_votes,
                locals: {flash: req.flash()}
              });

              }
            });
          }
        });
      }
    });
});
             		           
                               
                            
                                
               
Permet d'envoyer un mail abuse via mailgun



Utilisation des variables d'environnement mailgun_key, emailFrom, emailTo
             		                            
app.get('/abuse/:id',function(req, res){
  console.log("Sending an abuse mail for " + req.params.id);
  var mg = new mailgun.Mailgun(process.env.mailgun_key);
  mg.sendText(process.env.emailFrom,
         process.env.emailTo,
         '[instant-de-bonheur] Abuse: un contenu a été signalé comme offensant',
         req.params.id,
         function(err) { err && console.log(err) });
  req.flash('success', 'Merci de nous avoir averti de ce contenu, nous allons le traiter dès que possible');
  res.redirect('back');
});
             		           
                               
                            
                                
               
Permet d'accéder aux pages de la documentation



(les pages que vous lisez normalement!!)



On utilise la fonctionnalité sendfile pour envoyer des pages statiques
A noter que pour se simplifier la vie, une route pour la feuille de style docco.css est prévue
             		                            
app.get('/about', function(req, res){ 
  res.sendfile(__dirname + '/docs/instants.html')
}); 

app.get('/docco.css', function(req, res){ 
  res.sendfile(__dirname + '/docs/docco.css')
}); 
             		           
                               
                            
                                
               
Lancement de l'application



A noter l'utilisation de la variable process.env.PORT qui est nécessaire pour le
fonctionnement chez Heroku.com
             		                            
var port = process.env.PORT || 3210;
app.listen(port, function(){
  console.log("Listening on " + port);
});
console.log("Express server listening on port %d", app.address().port);