Vue + NodeAtlas : de l'art du SSR ou Rendu Côté Serveur avec JavaScript

Bruno Lesieur

Nous allons voir dans ce tutoriel comment faire du rendu côté serveur ou SSR (Server-Side Render) avec le framework JavaScript client MVVM (Modèle-Vue-Vue Modèle) Vue couplé au framework JavaScript serveur MVC(2) (Model View Controller) NodeAtlas !

Alors ce titre parle peut-être aux habitués des architectures clientes MVVM qui ont des difficultés avec le référencement et semble peut-être barbare pour d'autres. Lançons-nous dans une petite explication histoire de rendre cet article intéressant également pour les néophytes : comprenons le problème et trouvons la solution à travers cette page.

Quel est le problème traité dans ce tutoriel ?
Le problème avec les frameworks MVVM client est qu'ils construisent le site à partir de rien. Fouillez la source du code de la réponse HTTP de la page courante, celle lue par les indexeurs de contenus ou les navigateurs sans JavaScript ; il n'y a rien. Aussi, si je crée une liste d'actions futures pour la roadmap de ma super App, et que je souhaite pouvoir manipuler aisément (ajout et retrait) ses éléments grâce à un coupleur de données vue-modèle ; le revers de la médaille sera que les informations utilisées pour cette construction proviendront de fichiers JavaScript ou morceaux de HTML qui ne veulent rien dire pour les indexeurs ou même les validateurs de page. Vos sites sont donc souvent « SEO merdiques » et « W3C bancales ».
Quelle solution ?
Le SSR ou Rendu Côté Serveur. Voyons ça au travers de cette page exemple avec Vue et NodeAtlas !

Commentez

- Titre : Vue + NodeAtlas : de l'art du SSR ou Rendu Côté Serveur avec JavaScript

- Auteur : Bruno Lesieur

- Parution : 16 avril 2018

- Licence : Copyright ® 2018 Lesieur.name. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc. sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.

Sommaire

- I. Vue et NodeAtlas

- II. NodeAtlas - Sans MVVM, les bons vieux sites habituels

- III. Vue - Avec MVVM, l'interaction facile à mettre en place !

- IV. Vue + NodeAtlas - Avec SSR, les avantages des deux mondes !

- V. Bonus - Enregistrement côté serveur et Mise à jour temps réel

- VI. Remerciements

I - Vue et NodeAtlas

Tout d'abord Vue et NodeAtlas sont tous les deux écrits en JavaScript et tournent avec un moteur JavaScript. Vue tourne grâce au moteur JS embarqué dans les navigateurs, NodeAtlas tourne grâce au moteur serveur JS installé avec Node.js. Oui, on parle bien ici d'un développement intégral avec HTML, CSS et JavaScript seulement.

Nous avons ici deux frameworks aux rôles complémentaires :

- Vue (vue.js) est un data-binder simple (équivalent à Angular ou Riot mais bien plus performant) dont la versatilité et la suite d'outils lui permettent de devenir un puissant système MVVM (équivalent à Angular2 ou React mais plus performant). Attention, il ne remplace pas jQuery (ou Vanilla JS) qui servent avant tout à manipuler le DOM. Vue lie les données en provenance de fichiers JavaScript au HTML de sorte qu'une modification des données se reflète directement dans le HTML sans aucune manipulation de votre part. Là où faire ce travail avec jQuery demanderait de trouver une liste, de récupérer un item template, d'insérer la nouvelle donnée dans l'item template, d'insérer l'item template à la fin de la liste, de trouver le compteur qui compte les lignes, de l'incrémenter de 1, etc. ; il suffit avec Vue de simplement ajouter une donnée dans le tableau JavaScript lié et tout est « recalculé ».

- NodeAtlas (node-atlas.js) est un serveur HTTP simple dans sa forme la plus basique (équivalent à Express) par référencement de route dont le point commun avec Vue est l'évolutivité et la versatilité. Cela signifie que l'on peut faire tourner des sites multilingues performants avec un nombre conséquent de pages uniquement avec une partie route et vue active (parfait pour débuter en Node.js). Les parties modèle et contrôleur sont à activer au besoin (parfait pour les experts). Il suit une architecture MVC dans sa pleine utilisation (équivalent d'un Sails.js) avec des contrôleurs dédiés ou une architecture MVC2 avec un contrôleur commun (ou les deux, ou aucun) et permet de créer des sites orientés composants si souhaité et des architectures orientées service (Site Front simple + Collection d'API distantes + Serveur d'authentification + …).

II - NodeAtlas - Sans MVVM, les bons vieux sites habituels

Lançons-nous dans une petite page HTML sans prétention que vous auriez faite dans les règles de l'art avec tout ce qui va bien. Ici nous allons rester minimalistes, le but du tutoriel étant de comprendre et de résoudre le problème de référencement.

Avec NodeAtlas, créons-nous une page qui liste des actions futures à entreprendre. Nous allons faire cela en utilisant une vue dans le dossier views et en utilisant une variation dans le dossier variations comme source de données.

Ce qu'il faut retenir c'est que l'injection des données dans le HTML va se faire « côté serveur ». La réponse HTTP contient donc les données pour l'indexeur de contenus. C'est typiquement le cas avec n'importe quelle techno serveur (PHP, Ruby, C#, etc.).

Nous avons donc l'architecture NodeAtlas suivante :

1. ├─ variations/

2. │  └─ data.json

3. ├─ views/

4. │  └─ show.htm

5. └─ webconfig.json

avec le contenu des fichiers suivants :

webconfig.json

Nous créons une page a-faire composée du HTML de show.htm et des données de data.json.

1. {

2. "routes": {

3. "/a-faire": {

4. "view": "show.htm",

5. "variation": "data.json"

6. }

7. }

8. }

variations/data.json

Nous ajoutons trois entrées dans la variation spécifique derrière la propriété todos.

1. {

2. "todos": [{

3. "title": "v1.0",

4. "description": "Il va falloir faire la v1.0 !"

5. }, {

6. "title": "v2.0",

7. "description": "Puis faudra faire la v2.0, parce que la v1.0 on la sent déjà pas."

8. }, {

9. "title": "v3.0",

10. "description": "Il faudra faire la v3.0 parce que une fois la v2.0 finie, on voudra encore changer ce qui va pas !"

11. }]

12. }

views/show.htm

Ici on alimente notre HTML avec les données en provenance du fichier de variation en utilisant le moteur de template de NodeAtlas.

1. <!DOCTYPE html>

2. <html lang="fr">

3. <head>

4. <meta charset="utf-8">

5. <title>SSR</title>

6. </head>

7. <body>

8. <div class="todo-list">

9. <h1>Dans le futur</h1>

10. <? if (specific.todos.length) { ?>

11. <ul>

12. <? for (var i = 0; i < specific.todos.length; i++) { ?>

13. <li><strong><?- specific.todos[i].title ?></strong> : <?- specific.todos[i].description ?></li>

14. <? } ?>

15. </ul>

16. <? } ?>

17. </div>

18. </body>

19. </html>

Maintenant, lançons notre instance serveur NodeAtlas que l'on va afficher en français avec la commande suivante :

\> node-atlas --browse a-faire --lang fr-fr

Notre navigateur par défaut s'ouvre à l'adresse http://localhost/a-faire et le code source, celui mangé par les indexeurs, ressemblera à ceci :

http://localhost/a-faire

1. <!DOCTYPE html>

2. <html lang="fr">

3. <head>

4. <meta charset="utf-8">

5. <title>SSR</title>

6. </head>

7. <body>

8. <div class="todo-list">

9. <h1>Dans le futur</h1>

10. <ul>

11. <li><strong>v1.0</strong> : Il va falloir faire la v1.0 !</li>

12. <li><strong>v2.0</strong> : Puis faudra faire la v2.0, parce que la v1.0 on la sent déjà pas.</li>

13. <li><strong>v3.0</strong> : Il faudra faire la v3.0 parce que une fois la v2.0 finie, on voudra encore changer ce qui va pas !</li>

14. </ul>

15. </div>

16. </body>

17. </html>

Jusque-là tout va bien, tout est indexable. C'est assez simple étant donné que nous n'avons pas besoin de manipuler les données depuis le navigateur, nous n'avons donc pas besoin d'un système MVVM.

Vous pouvez retrouver l'intégralité des fichiers de cet exemple dans le dépôt VueAtlas partie step/step1.

III - Vue - Avec MVVM, l'interaction facile à mettre en place !

Nous allons maintenant utiliser Vue ! Cela signifie que nous allons injecter les données dans le HTML côté client pour permettre à Vue de savoir quelles données sont liées à quelles parties du HTML : cela va nous permettre d'ajouter ou de retirer des entrées simplement ! Pour réaliser cela, nous allons ajouter un fichier assets/javascripts/todo-list.js accessible côté client et créer une nouvelle page basée sur views/update.htm.

1. ├─ assets/

2. │  └─ javascripts/

3. │     └─ todo-list.js

4. ├─ variations/

5. │  └─ data.json

6. ├─ views/

7. │  ├─ update.htm

8. │  └─ show.htm

9. └─ webconfig.json

En ce qui concerne variations/data.json, rien ne va bouger, il va servir de source de données aussi bien pour les pages views/show.htm que views/update.htm.

webconfig.json

Ajoutons notre nouvelle page :

1. {

2. "routes": {

3. "/a-faire": {

4. "view": "show.htm",

5. "variation": "data.json"

6. },

7. "/gerer-a-faire": {

8. "view": "update.htm",

9. "variation": "data.json"

10. }

11. }

12. }

views/update.htm

Nous allons maintenant :

- changer l'implémentation en remplaçant les tags NodeAtlas par les tags Vue. Ils ne seront donc pas touchés lors de l'analyse du rendu côté serveur et le code sera envoyé côté client tel quel ;

- glisser les données en provenance de variations/data.json dans un attribut data-model sur la balise todo-list afin de pouvoir alimenter notre vue quand elle s'initialisera dans le navigateur côté client ;

- ajouter une partie destinée à ajouter ou supprimer des entrées.

1. <!DOCTYPE html>

2. <html lang="fr">

3. <head>

4. <meta charset="utf-8">

5. <title>SSR</title>

6. </head>

7. <body>

8. <div class="todo-list" data-model="<?= JSON.stringify(specific.todos) ?>">

9. <div class="todo-list--content">

10. <h1>Dans le futur</h1>

11. <ul v-if="todos.length">

12. <li v-for="todo in todos">

13. <strong>{{ todo.title }}</strong> : {{ todo.description }} <span v-on:click="removeTodo(index)">[X]</span>

14. </li>

15. </ul>

16. </div>

17. <div class="todo-list--form">

18. Nouveau:

19. <input v-model="newTitle" placeholder="Titre">

20. <input v-model="newDescription" placeholder="Description">

21. <button v-on:click="addTodo">Ajouter</button>

22. </div>

23. </div>

24. <script src="https://cdnjs.cloudflare.com/ajax/libs/vue/2.1.3/vue.min.js"></script>

25. <script src="javascripts/todo-list.js"></script>

26. </body>

27. </html>

assets/javascripts/todo-list.js

Nous créons donc la partie modèle de Vue. Nous allons l'associer à l'élément <div class="todo-list">. Pour cela nous allons le chercher dans le DOM avec la variable todosSource. Ensuite nous allons alimenter notre new Vue() avec l'élément en question pour el, avec les données en provenance de data-model pour data.todos. Nous créons ensuite tout ce qu'il faut pour ajouter ou supprimer des entrées.

1. var todosSource = document.getElementsByClassName("todo-list")[0];

2. new Vue({

3. el: todosSource,

4. data: {

5. "todos": JSON.parse(todosSource.getAttribute("data-model")),

6. "newTitle": "",

7. "newDescription": ""

8. },

9. methods: {

10. addTodo: function () {

11. this.todos.push({

12. "title": this.newTitle,

13. "description": this.newDescription

14. });

15. this.newTitle = "";

16. this.newDescription = "";

17. },

18. removeTodo: function (index) {

19. this.todos.splice(index, 1);

20. }

21. }

22. });

En coupant l'instance précédente (Ctrl + c) et en lançant notre instance serveur NodeAtlas avec la commande suivante (NodeAtlas est maintenant déjà en français) :

\> node-atlas --browse gerer-a-faire

L'adresse http://localhost/gerer-a-faire s'ouvre de nouveau dans le navigateur et le code source ressemblera à ceci :

http://localhost/gerer-a-faire

1. <!DOCTYPE html>

2. <html lang="fr">

3. <head>

4. <meta charset="utf-8">

5. <title>SSR</title>

6. </head>

7. <body>

8. <div class="todo-list" data-model="[{&#34;title&#34;:&#34;v1.0&#34;,&#34;description&#34;:&#34;Il va falloir faire la v1.0 !&#34;},{&#34;title&#34;:&#34;v2.0&#34;,&#34;description&#34;:&#34;Puis faudra faire la v2.0, parce que la v1.0 on la sent déjà pas.&#34;},{&#34;title&#34;:&#34;v3.0&#34;,&#34;description&#34;:&#34;Il faudra faire la v3.0 parce que une fois la v2.0 finie, on voudra encore changer ce qui va pas !&#34;}]">

9. <h1>Dans le futur</h1>

10. <div class="todo-list--content">

11. <ul v-if="todos.length">

12. <li v-for="(todo, index) in todos">

13. <strong>{{ todo.title }}</strong> : {{ todo.description }} <span v-on:click="removeTodo(index)">[X]</span>

14. </li>

15. </ul>

16. </div>

17. <div class="todo-list--form">

18. Nouveau:

19. <input v-model="newTitle" placeholder="Titre">

20. <input v-model="newDescription" placeholder="Description">

21. <button v-on:click="addTodo">Ajouter</button>

22. </div>

23. </div>

24. <script src="https://cdnjs.cloudflare.com/ajax/libs/vue/2.1.3/vue.min.js"></script>

25. <script src="javascripts/todo-list.js"></script>

26. </body>

27. </html>

C'est là que les bactéries attaquent ! Le code source de notre page est (presque) équivalent à ce que nous avons pu voir côté serveur. Car le code ici écrit est fait pour être rendu par le moteur de Vue côté client, et non par le moteur de NodeAtlas côté serveur. Cela ne ressemble donc à rien pour les indexeurs de contenus. Il y a bien l'attribut HTML « data-model » dont nous nous servons pour alimenter Vue qui est dans la source, mais rien d'exploitable…

Une solution coûteuse en temps est donc de délivrer le contenu statique sur une page pour les indexeurs (ex : a-faire), et de permettre aux utilisateurs d'ajouter des éléments depuis une autre page (ex : gerer-a-faire). Une solution coûteuse en temps donc puisque l'implémentation de la page est à écrire deux fois.

Vous pouvez retrouver l'intégralité des fichiers de cet exemple dans le dépôt VueAtlas partie step/step2.

IV - Vue + NodeAtlas - Avec SSR, les avantages des deux mondes !

Nous allons maintenant résoudre le problème en permettant aux fichiers Vue d'être exécutés côté serveur. Pour permettre cela à Vue, il va falloir dans un premier temps rendre accessible Vue côté serveur et utiliser en plus Vue Server Renderer en utilisant NPM :

Installons cela avec les commandes suivantes dans la console de notre OS.

\> npm install vue

et

\> npm install vue-server-renderer

Nous allons également mettre nos données sources dans un dossier data, car les variations de NodeAtlas ne sont normalement pas faites pour cela.

data/todo-list.json

1. [{

2. "title": "v1.0",

3. "description": "Il va falloir faire la v1.0 !"

4. }, {

5. "title": "v2.0",

6. "description": "Puis faudra faire la v2.0, parce que la v1.0 on la sent déjà pas."

7. }, {

8. "title": "v3.0",

9. "description": "Il faudra faire la v3.0 parce que une fois la v2.0 finie, on voudra encore changer ce qui va pas !"

10. }]

Ce qui nous donne, avec les fichiers rémanents des deux exemples précédents l'arborescence suivante :

1. ├─ node_modules/

2. │  ├─ vue/

3. │  └─ vue-server-renderer/

4. ├─ assets/

5. │  └─ javascripts/

6. │     └─ todo-list.js

7. ├─ data/

8. │  └─ todo-list.json

9. ├─ variations/

10. │  └─ data.json

11. ├─ views/

12. │  ├─ update.htm

13. │  └─ show.htm

14. └─ webconfig.json

Pour que Vue puisse s'exécuter des deux côtés, nous allons utiliser le contrôleur all.js en plus du côté client avec la vue NodeAtlas all.htm. Il faut également que le vue-modèle de Vue soit disponible sur le serveur et le client. Nous allons le faire en abonnant les fichiers nécessaires à la liste des fichiers statiques de NodeAtlas et en ajoutant une nouvelle route /.

webconfig.json

1. {

2. "statics": {

3. "/view-model": "views/partials",

4. "/data": "/data"

5. },

6. "routes": {

7. "/": {

8. "view": "all.htm",

9. "controller": "all.js"

10. },

11. "/a-faire": {

12. "view": "show.htm",

13. "variation": "data.json"

14. },

15. "/gerer-a-faire": {

16. "view": "update.htm",

17. "variation": "data.json"

18. }

19. }

20. }

Maintenant, depuis le navigateur, nous aurons accès aux fichiers :

- Données : http://localhost/data/todo-list.json (accessible sur le serveur via data/todo-list.json) ;

- Modèle : http://localhost/view-model/todo-list.js (accessible sur le serveur via views/partials/todo-list.js) ;

- Vue : http://localhost/view-model/todo-list.htm (accessible sur le serveur via views/partials/todo-list.htm).

Les contenus de views/partials/todo-list.js et views/partials/todo-list.htm sont les suivants :

views/partials/todo-list.htm

Avec v-if="client" permettant de piloter ce qui ne doit apparaître que lors du rendu client (et donc ne pas être dans la source de la réponse HTTP).

1. <div class="todo-list">

2. <h1>Dans le futur</h1>

3. <div class="todo-list--content">

4. <ul v-if="todos.length">

5. <li v-for="(todo, index) in todos">

6. <strong>{{ todo.title }}</strong> : {{ todo.description }} <span v-if="client" v-on:click="removeTodo(index)">[X]</span>

7. </li>

8. </ul>

9. </div>

10. <div v-if="client" class="todo-list--form">

11. Nouveau:

12. <input v-model="newTitle" placeholder="Titre">

13. <input v-model="newDescription" placeholder="Description">

14. <button v-on:click="addTodo">Ajouter</button>

15. </div>

16. </div>

views/partials/todo-list.js

Avec un code encapsulant la fonctionnalité pour lui permettre d'être exécutable côté navigateur et côté Node.js.

1. (function () {

2. var setTodos = function (view, model, client) {

3. return new Vue({

4. template: view,

5. data: {

6. "todos": model,

7. "newTitle": "",

8. "newDescription": "",

9. "client": client

10. },

11. methods: {

12. addTodo: function () {

13. this.todos.push({

14. "title": this.newTitle,

15. "description": this.newDescription

16. });

17. this.newTitle = "";

18. this.newDescription = "";

19. },

20. removeTodo: function (index) {

21. this.todos.splice(index, 1);

22. }

23. }

24. });

25. };

26. if (typeof module !== 'undefined' && module.exports) {

27. module.exports = setTodos;

28. } else {

29. this.setTodos = setTodos;

30. }

31. }).call(this);

Cette vue-modèle est ensuite appelée côté client depuis / grâce à la vue NodeAtlas suivante :

views/all.htm

1. <!DOCTYPE html>

2. <html lang="fr">

3. <head>

4. <meta charset="utf-8">

5. <title>SSR</title>

6. </head>

7. <body>

8. <section class="todo-list"></section>

9. <script src="https://code.jquery.com/jquery-3.1.1.min.js"></script>

10. <script src="https://cdnjs.cloudflare.com/ajax/libs/vue/2.1.3/vue.min.js"></script>

11. <script src="view-model/todo-list.js"></script>

12. <script>

13. $.ajax({

14. url: "data/todo-list.json"

15. }).done(function (model) {

16. $.ajax({

17. url: "view-model/todo-list.htm"

18. }).done(function (view) {

19. var todos = setTodos(view, model, true);

20. todos.$mount(".todo-list");

21. });

22. });

23. </script>

24. </body>

25. </html>

et le contrôleur NodeAtlas suivant pour utiliser Vue côté serveur :

controllers/all.js

1. exports.changeDom = function (next, locals) {

2. var NA = this,

3. Vue = require("vue"),

4. ServerRenderer = require("vue-server-renderer"),

5. renderer = ServerRenderer.createRenderer(),

6. path = NA.modules.path,

7. fs = NA.modules.fs,

8. view = path.join(NA.serverPath, NA.webconfig.viewsRelativePath, "partials/todo-list.htm"),

9. model = path.join(NA.serverPath, NA.webconfig.viewsRelativePath, "partials/todo-list.js"),

10. data = path.join(NA.serverPath, "data/todo-list.json");

11. global.Vue = Vue;

12. fs.readFile(view, "utf-8", function (error, view) {

13. fs.readFile(data, "utf-8", function (error, data) {

14. renderer.renderToString(require(model)(view, JSON.parse(data)), function (error, html) {

15. locals.dom = locals.dom.replace("<section class="todo-list"></section>", html.replace('server-rendered="true"', ""));

16. });

17. });

18. });

19. };

ce qui nous donne l'arborescence complète suivante :

1. ├─ node_modules/

2. │  ├─ vue/

3. │  └─ vue-server-renderer/

4. ├─ assets/

5. │  └─ javascripts/

6. │     └─ todo-list.js

7. ├─ controllers/

8. │  └─ all.js

9. ├─ data/

10. │  └─ todo-list.json

11. ├─ variations/

12. │  └─ data.json

13. ├─ views/

14. │  ├─ partials/

15. │  │  ├─ todo-list.htm

16. │  │  └─ todo-list.js

17. │  ├─ all.htm

18. │  ├─ update.htm

19. │  └─ show.htm

20. └─ webconfig.json

En lançant notre instance serveur NodeAtlas avec la commande suivante :

\> node-atlas --browse

Notre navigateur par défaut s'ouvre à l'adresse http://localhost/ et le code source (celui mangé par les indexeurs), ressemblera à ceci :

http://localhost/

1. <!DOCTYPE html>

2. <html lang="fr">

3. <head>

4. <meta charset="utf-8">

5. <title>SSR</title>

6. </head>

7. <body>

8. <div class="todo-list">

9. <h1>Dans le futur</h1>

10. <div class="todo-list--content">

11. <ul>

12. <li><strong>v1.0</strong> : Il va falloir faire la v1.0 ! <!----></li>

13. <li><strong>v2.0</strong> : Puis faudra faire la v2.0, parce que la v1.0 on la sent déjà pas. <!----></li>

14. <li><strong>v3.0</strong> : Il faudra faire la v3.0 parce que une fois la v2.0 finie, on voudra encore changer ce qui va pas ! <!----></li>

15. </ul>

16. </div> <!---->

17. </div>

18. <script src="https://code.jquery.com/jquery-3.1.1.min.js"></script>

19. <script src="https://cdnjs.cloudflare.com/ajax/libs/vue/2.1.3/vue.min.js"></script>

20. <script src="view-model/todo-list.js"></script>

21. <script>

22. $.ajax({

23. url: "data/todo-list.json"

24. }).done(function (model) {

25. $.ajax({

26. url: "view-model/todo-list.htm"

27. }).done(function (view) {

28. var todos = setTodos(view, model, true);

29. todos.$mount(".todo-list");

30. });

31. });

32. </script>

33. </body>

34. </html>

Bingo !

- Vue est fonctionnel côté serveur :

- votre document est valide W3C ;

- votre document est complètement SEO indexable (avec les formulaires retirés de la source).

- Vue est fonctionnel côté client (avec les formulaires inclus dans le DOM de ce côté).

- Vous n'avez écrit qu'une seule fois le code pour le rendu client et serveur.

Vous pouvez retrouver l'intégralité des fichiers de cet exemple dans le dépôt VueAtlas partie step/step3.

V - Bonus - Enregistrement côté serveur et Mise à jour temps réel

Ce tutoriel a atteint son objectif puisque nous avons une architecture qui démontre comment faire du rendu côté serveur avec Vue et NodeAtlas. Afin de finir ce tutoriel correctement, nous allons :

- épurer le code pour ne garder que l'exemple final ;

- enregistrer les modifications faites côté serveur pour que l'ouverture d'une page affiche toutes les entrées ;

- utiliser les Websockets de NodeAtlas pour mettre à jour la liste en temps réel dans toutes les pages déjà ouvertes !

Finalement notre arborescence va ressembler à cela :

1. ├─ node_modules/

2. │  ├─ vue/

3. │  └─ vue-server-renderer/

4. ├─ assets/

5. │  └─ javascripts/

6. │     └─ index.js

7. ├─ controllers/

8. │  └─ index.js

9. ├─ data/

10. │  └─ todo-list.json

11. ├─ variations/

12. │  ├─ edit.json

13. │  └─ show.json

14. ├─ views/

15. │  ├─ partials/

16. │  │  ├─ todo-list.htm

17. │  │  └─ todo-list.js

18. │  └─ index.htm

19. └─ webconfig.json

Pour information, nous avons procédé, par rapport aux trois exemples précédents, aux modifications suivantes :

- controllers/all.js qui devient controllers/index.js ;

- views/all.htm qui devient views/index.htm ;

- views/show.htm et views/update.htm qui sont supprimés ;

- variations/data.json qui est supprimé ;

- variations/show.json et variations/edit.json qui sont ajoutés ;

- assets/javascripts/todo-list.js qui est supprimé ;

- assets/javascripts/index.js qui est ajouté.

Voici le contenu de chaque fichier restant après modification.

webconfig.json

Une page en lecture seule http://localhost/ et une page de modification http://localhost/editer.

1. {

2. "statics": {

3. "/view-model": "views/partials",

4. "/data": "/data"

5. },

6. "routes": {

7. "/": {

8. "view": "index.htm",

9. "variation": "show.json",

10. "controller": "index.js"

11. },

12. "/editer": {

13. "view": "index.htm",

14. "variation": "edit.json",

15. "controller": "index.js"

16. }

17. }

18. }

Avec la vue NodeAtlas unique suivante :

views/index.htm

Vous remarquerez que nous avons ajouté les fichiers socket.io/socket.io.js et node-atlas/socket.io.js fournis par NodeAtlas pour faire fonctionner les échanges Websockets temps réel plus loin.

1. <!DOCTYPE html>

2. <html lang="fr">

3. <head>

4. <meta charset="utf-8">

5. <title>SSR</title>

6. </head>

7. <body>

8. <section class="todo-list"></section>

9. <script src="https://code.jquery.com/jquery-3.1.1.min.js"></script>

10. <script src="https://cdnjs.cloudflare.com/ajax/libs/vue/2.1.3/vue.min.js"></script>

11. <script src="socket.io/socket.io.js"></script>

12. <script src="node-atlas/socket.io.js"></script>

13. <script src="view-model/todo-list.js"></script>

14. <script src="javascripts/index.js"></script>

15. <script>todoList(<?- specific.editable ?>);</script>

16. </body>

17. </html>

Qui utilise les vue-modèle Vue suivantes :

views/partials/todo-list.js

1. (function () {

2. var setTodos = function (view, model, editable, callback) {

3. return new Vue({

4. template: view,

5. data: {

6. "todos": model,

7. "newTitle": "",

8. "newDescription": "",

9. "editable": editable

10. },

11. methods: {

12. addTodo: function () {

13. this.todos.push({

14. "title": this.newTitle,

15. "description": this.newDescription

16. });

17. this.newTitle = "";

18. this.newDescription = "";

19. if (callback) {

20. callback(this.todos);

21. }

22. },

23. removeTodo: function (index) {

24. this.todos.splice(index, 1);

25. if (callback) {

26. callback(this.todos);

27. }

28. }

29. }

30. });

31. };

32. if (typeof module !== 'undefined' && module.exports) {

33. module.exports = setTodos;

34. } else {

35. this.setTodos = setTodos;

36. }

37. }).call(this);

views/partials/todo-list.htm

1. <div class="todo-list">

2. <h1>Todo list</h1>

3. <div class="todo-list--content">

4. <ul v-if="todos.length">

5. <li v-for="(todo, index) in todos">

6. <strong>{{ todo.title }}</strong> : {{ todo.description }} <span v-if="editable" v-on:click="removeTodo(index)">[X]</span>

7. </li>

8. </ul>

9. </div>

10. <div v-if="editable" class="todo-list--form">

11. Nouveau:

12. <input v-model="newTitle" placeholder="Titre">

13. <input v-model="newDescription" placeholder="Description">

14. <button v-on:click="addTodo">Ajouter</button>

15. </div>

16. </div>

Qui ne varie que de la variable specific.editable qui sert à indiquer si la page est en lecture seule ou éditable :

variations/show.json

1. {

2. "editable": "false"

3. }

variations/edit.json

1. {

2. "editable": "true"

3. }

Avec toujours le même jeu de données pour data/todo-list.json.

Attaquons-nous à présent aux deux fichiers qui vont permettre :

- les échanges client-serveur temps réel côté client et serveur respectivement grâce au fichier node-atlas/socket.io.js et au point d'ancrage setSockets() ainsi que,

- l'enregistrement côté serveur grâce à writeFile.

controllers/index.js

1. exports.changeDom = function (next, locals) {

2. var NA = this,

3. Vue = require("vue"),

4. renderers = require("vue-server-renderer"),

5. renderer = renderers.createRenderer(),

6. path = NA.modules.path,

7. fs = NA.modules.fs,

8. view = path.join(NA.serverPath, NA.webconfig.viewsRelativePath, "partials/todo-list.htm"),

9. model = path.join(NA.serverPath, NA.webconfig.viewsRelativePath, "partials/todo-list.js"),

10. data = path.join(NA.serverPath, "data/todo-list.json");

11. global.Vue = Vue;

12. fs.readFile(view, "utf-8", function (error, view) {

13. fs.readFile(data, "utf-8", function (error, data) {

14. renderer.renderToString(require(model)(view, JSON.parse(data)), function (error, html) {

15. locals.dom = locals.dom.replace('<section class="todo-list"></section>', html.replace('server-rendered="true"', ""));

16. next();

17. });

18. });

19. });

20. };

21. exports.setSockets = function () {

22. var NA = this,

23. fs = NA.modules.fs,

24. io = NA.io;

25. io.sockets.on("connection", function (socket) {

26. socket.on("update-todo", function (todos) {

27. fs.writeFile("data/todo-list.json", JSON.stringify(todos), function () {

28. socket.broadcast.emit("update-todo", todos);

29. });

30. });

31. });

32. };

assets/javascripts/index.js

1. var todoList = function (editable) {

2. $.ajax({

3. url: "data/todo-list.json"

4. }).done(function (model) {

5. $.ajax({

6. url: "view-model/todo-list.htm"

7. }).done(function (view) {

8. var todos = setTodos(view, model, editable, function (value) {

9. NA.socket.emit("update-todo", value);

10. });

11. todos.$mount(".todo-list");

12. NA.socket.on("update-todo", function (value) {

13. todos.todos = value;

14. });

15. });

16. });

17. };

Et voilà un exemple simple et fonctionnel !

En lançant la commande suivante :

node-atlas -browse

Vous ouvrirez le site sur la page en lecture seule http://localhost/.

Ouvrez donc plusieurs onglets aux pages http://localhost/ et http://localhost/editer et même dans plusieurs navigateurs ! Ensuite, modifiez la liste via une de vos pages http://localhost/editer et magie, tout est actualisé partout ! En ouvrant une nouvelle page http://localhost/ ou http://localhost/editer à partir d'ici, vous verrez les nouvelles entrées.

Vous pouvez retrouver l'intégralité des fichiers de ce tutoriel dans le dépôt VueAtlas sur Github.

VI - Remerciements

Nous remercions Bruno Lesieur qui nous a autorisés à publier ce tutoriel.

Nous remercions également Winjerome pour la mise au gabarit et Fabien pour la correction orthographique.