[Angular] – part 14 – Angular Universal (server rendering)

Angular Universal

Angular Universal

La platform universal a été ajouté à angular dans la version 4 d’angular. Elle permet maintenant de générer les pages depuis le serveur.

La méthode « magique » de la plateforme universal est le renderModuleFactory provenant de @angular/platfom-server

La définition de ce renderModulefactory dans la doc d’Angular est

renderModuleFactory(
    moduleFactory: NgModuleFactory,
    options: PlatformOptions
): Promise

moduleFactory : Le premier argument de cette méthode est moduleFactory, qui est pour faire court une version compilé d’angular. Ce moduleFactory doit être buildé une seule fois.

options : quant à lui contient les informations sur la manière dont on souhaite voir notre application: PlatformOptions

PlatformOptions : Le type de PlatformOptions est définit dans les sources par l’interface suivante

interface PlatformOptions {
    document?: string;
    url?: string;
    extraProviders?: Provider[]
}

– le document indique le contenu du fichier HTML que l’on souhaite avoir dans notre app.
– l’urlL indique la page de notre application que l’on souhaite rendre

Installation

# on génere le projet avec un rooting de base

ng new sn-universal --rooting
cd sn-universal

# on installe ensuite plateform server nécéssaire pour le rendu coté serveur et pour la génération des pages html

npm install --save @angular/platform-server

# il faudra mettre à jour angular et tous les packages liés vers la version 4 minimum et tous les autres packages tel que core-js, rxjs, zone.js ( sinon nous aurons une erreur au build)

Création du module serveur

Nous allons maintenant créer le fichier qui va boostraper (initialiser) l’app depuis le serveur: src/app.server.module.ts

On crée un nouveau fichier nommé app.server.module.ts. Il est assez similaire au fichier app.module.ts de notre application, la grosse différence est que ce module est crée pour le serveur

import { NgModule } from '@angular/core';
import { ServerModule } from '@angular/platform-server';
import { AppModule } from './app.module';
import { AppComponent } from './app.component';
 
@NgModule({
    imports: [
        ServerModule,
        AppModule
    ],
    bootstrap: [AppComponent]
})
export class AppServerModule {}

Mise à jour du module principal

Nous aurons aussi besoin d’indiquer à l’AppModule que tout le rendu se fera depuis le serveur.
Normalement, on bootstrap une app Angular depuis un AppModule qui importe le BrowserModule (qui met à disposition toute sorte de services et directives tel que par exemple ngIf )
PS: c’est platformBrowserDynamic qui est la méthode utilisée pour bootstrapper l’application pour l’app.
Mise à jour de app module afin de pouvoir utiliser le serveur

// dans /src/app/app.modules.ts
// BrowserModule devient
BrowserModule.withServerTransition({ appId : 'sn-universal' })

withServerTransition prend un appId et c’est lui qui est partagé entre le client et le serveur. withServerTransition permet à universal de remplacer le html généré par le sien.

A ce point on peut compiler notre app avec la commande ngc

$ node_modules/.bin/ngc

Si on ouvre le dossier dist, on remarquera que dans le dossier out-tsc/app se trouve dans les fichiers générés src/app.server.module.ngfactory.ts un fichier qui déclare et exporte un AppServerModuleNgFactory de type NgModuleFactory.

export const AppServerModuleNgFactory:i0.NgModuleFactory = i0.?cmf(i1.AppServerModule,
[i2.AppComponent],(_l:any) => {

Création du module server de l’application sous express

Il nous faut créer un fichier main.server.ts qui va s’occuper de prendre une url en argument te de faire le rendu de la bonne page de notre application.

import 'reflect-metadata';
import 'zone.js/dist/zone-node';
import { platformServer, renderModuleFactory } from '@angular/platform-server'
import { enableProdMode } from '@angular/core'
import { AppServerModuleNgFactory } from '../dist/ngfactory/src/app/app.server.module.ngfactory'
import * as express from 'express';
import { readFileSync } from 'fs';
import { join } from 'path';
  
const PORT = 4000;
  
enableProdMode();
  
const app = express();
  
let template = readFileSync(join(__dirname, '..', 'dist', 'index.html')).toString();
  
app.engine('html', (_, options, callback) => {
const opts = { document: template, url: options.req.url };
  
renderModuleFactory(AppServerModuleNgFactory, opts)
.then(html => callback(null, html));
});
  
app.set('view engine', 'html');
app.set('views', 'src')
  
app.get('*.*', express.static(join(__dirname, '..', 'dist')));
  
app.get('*', (req, res) => {
    res.render('index', { req });
});
  
app.listen(PORT, () => {
    console.log(`listening on http://localhost:${PORT}!`);
});

HS
La création du serveur sous express est hors sujet, on ne s’y attardera pas donc.

Mise à jour de de la config typescript

Dans le fichier de config /src/tsconfig.app.json on ajoutera server.ts dans les fichiers à exclure

"exclude": [
    "server.ts", // ICI
    "test.ts",
    "**/*.spec.ts"
]

Ajouter ensuite dans tysconfig.json angularCompilerOptions

{
    "compileOnSave": false,
    "compilerOptions": {
        ...
    ],
    "lib": [
        ...
    ]
},
    "angularCompilerOptions": { // ICI
        "genDir": "./dist/ngfactory",
        "entryModule": "./src/app/app.module#AppModule"
    }
}

angularCompilerOptions : permet de spécifier une propriété genDir qui correspond au dossier dans lequel les fichiers ngfactory générés seront exportés.
entryModule : on lui indique le chemin vers le module principal sur le lequel l’app bootstrap ( dans ce cas : AppModule)
Mise à jour du Script NPM

dans le package.json

"scripts": {
    "ng": "ng",
    "prestart": "ng build --prod && ngc", // on ajoute cette ligne
    "start": "ng serve", // on supprime celle ci
    "start": "ts-node src/server.ts" // et la remplace par celle ci
    "build": "ng build", // on supprime celle ci
    "test": "ng test",
    "lint": "ng lint",
    "e2e": "ng e2e"
},

prestart lancera d’abord ce script avant le start (grace au pre ajouté avant) ng build –prod && ngc puis le server est lancé

et zoo

on lance l’app

npm run start

et si tout ce passe bien vous devriez avoir un quelque chose comme ca

Mac-mini-de-Samuel:sn-universal saminou$ npm run start
  
    > sn-universal@0.0.0 prestart /Users/saminou/SitesSaminou/angular/sn-universal
    > ng build --prod && ngc
   
    Date: 2017-09-08T15:09:38.658Z
    Hash: 6c329e8c267199f5dbe3
    Time: 14528ms
    chunk {0} polyfills.c9b879328f3396b2bbe8.bundle.js (polyfills) 64.1 kB {4} [initial] [rendered]
    chunk {1} main.0f96096c1bb38373edb0.bundle.js (main) 5.15 kB {3} [initial] [rendered]
    chunk {2} styles.d41d8cd98f00b204e980.bundle.css (styles) 0 bytes {4} [initial] [rendered]
    chunk {3} vendor.3f618d3b9434d244b572.bundle.js (vendor) 307 kB [initial] [rendered]
    chunk {4} inline.d6e0fc0a02fc19c9d76f.bundle.js (inline) 1.45 kB [entry] [rendered]
   
    > sn-universal@0.0.0 start /Users/saminou/SitesSaminou/angular/sn-universal
    > ts-node src/server.ts
   
 listening on http://localhost:4000!

Si vous visitez http://localhost:4000! , dans le code source de la page vous devriez avoir le code correspondant à ce que vous avez en visu plutot que l’habituelle « app works »

angular universal source code

Générer un composant

Utiliser le cli pour générer un composant est assez facile avec les commandes fournies par le cli.

ng g c home
 
# équivalent de
ng generate component home

malheureusement avec nos modifications on aura une erreur du type

> ng g c home
    Error: More than one module matches. Use skip-import option to skip importing the component into the closest module.
    More than one module matches. Use skip-import option to skip importing the component into the closest module.

Pour éviter cela il suffit de spécifier le module en ajoutant un flag.

ng g c home  --module=app.module.ts
ng g c about --module=app.modue.ts

Définition des routes

Ouvrons maintenant le fichier routing app-routing.module.ts généré lors de la création de notre projet via le flag –routing

import { NgModule } from '@angular/core';
import { Routes, RouterModule } from '@angular/router';
// on ajoute nos 2 nouveaux modules
import { HomeComponent} from './home/home.component';
import { AboutComponent } from './about/about.component';
 
// on met à jour le tableau des routes
const routes: Routes = [
    {
        path: '',
        component: HomeComponent
    },
    {
        path: 'about',
        component: AboutComponent
    }
];
 
@NgModule({
imports: [RouterModule.forRoot(routes)],
exports: [RouterModule]
})
export class AppRoutingModule { }

Mise à jour des templates

Ouvrons le ficher /src/app.component.html et mettons le à jour avec les liens

 

 

 

Ajout des titles et meta tags à nos components

C’est assez simple , il suffit d’importer Meta et Title depuis @angular/platform-browser

puis de mettre à jour le constructeur

import { Meta, Title } from '@angular/platform-browser';
 
# dans le constructeur
 
export class HomeComponent implements OnInit {
// on utilise l'injection de dépendance pour créer des instances de Meta et Title
constructor(meta: Meta, title: Title) {
 
 
title.setTitle('Supa Karma Page');
meta.addTags([
        { name: 'author', content:'Samsam'},
        { name: 'keywords', content:'angular, seo, universal'},
        { name: 'description', content:'tada une page avec un code source qui est à jour'},
        ])
    }
 
    ngOnInit() {
 
    }
}

Et voila

 

Les pièges à éviter

Universal ne peut utiliser les objets globaux (window, document, localstorage) existants au runtime du navigateur.

Le DOM doit être manipulé par Angular et non de façon externe (vanilla Js, jQuery : par exemple document.domMethod() ou encore $(‘dom-element’))..

Le server side rendering n’est pas compatible avec le lazy loading des modules.

 

[Angular] – part 1 – Mise en place environnement de travail

ng -v

Nous allons voir comment préparer son environnement de travail pour un projet sous Angular (actuellement nous sommes à la version Angular 6).

Si vous travaillez en équipe, rien de mieux que d’utiliser le CLI de Angular. Celui ci vous permettra de générer des modules, components, pipe etc…

Prérequis

  • node js (version > 8)
  • npm (version > 5)

J’ai écrit un article sur les différentes manières d’installer et mettre à jour Node et npm (sur mac).
Mais ne perdons pas de temps : utilisez brew sur mac ou chocolatey, oneGet sur windows.

installez Angular de façon globale

npm install -g @angular/cli

Pour vérifier que tout s’est bien passé , testez

ng -v
ng -v
ng -v

 

VSCode extensions et raccourcies à connaitre

Visual Studio code - VSCODE

En passant de AngularJs à Angular et donc à typescript j’ai aussi changé d’éditeur de code. Je suis passé de PHPStorm et Atom à VS Code (Visual Studio Code). Je trouve cet éditeur vraiment top et si cela m’a appris une chose c’est que je peux aimer du Microsoft…(VS Code est créé par Microsoft)

C’est éditeur est créé grace à Electron, c’est donc fait à partir de CSS/HTML/JS et les performances sont au rdv contrairement à ceux à quoi je m’attendais.

  • il gére la coloration syntaxique des principaux language et surtout du Typescript.
  • gère le typage pour Typescript
  • auto import pour javascript et Typescript
  • supporte GIt nativement
  • affiche le status GIT d’un fichier dans l’arborescence de façon coloré
  • a un debugger intégré
  • permet la personnalisation des raccourcis clavier
  • permet d’avoir les différents espaces de travail (par projet)
  • permet de diviser l’éditeur verticalement pour avoir différents fichiers cote à cote
  • a un terminal intégré

Le Marketpalce de VsCode est vraiment très bien fournit, on peut customiser à fond l’éditeur via le fichier json.

Sachant que 90% de mon temps je fais du dev front (principalement Angular et un peu de React, bref du JS) mes extensions sont axés plutôt JS.

Les raccourcies qui sauvent la vie

Sélection multiple (curseur multiple)

Alt+click
multicursor

CMD+D : sélectionnera le prochain mot, la prochaine occurence
multicursor-wordIl est possible de rajouter plus de curseur avec MAJ+CMD+L

Recherche

Recherche à travers des fichiers
MAJ+CMD+F :
recherche

Formatage

Formatage du document entier :  MAJ+ALT+F
Formattage de la selection : MAJ+K MAJ+F

VS Code peut effectuer par défaut des formatage pour le javascript, Typescript, Json, HTML

Zone CSS pliable

Plier le bloc actuel : ALT+MAJ+[
Déplier le bloc actuel: ALT+MAJ+]

Plier récursivement le bloc actuel : CMD+K CMD+[
Déplier récursivement le bloc actuel: CMD+ CMD+]

Plier tout : MAJ+K MAJ+0
Déplier tout: MAJ+K MAJ+J
Plier tous les commentaires : MAJ+K MAJ+/

Vous pouvez définir des zones de blocs arbritaire à plier/déplier

avec l’utilisation de /* #region */ et /* #endregion */

CSS region folding

Les extensions « indispensables »… ou pas

Linter

TS LINT : un linter pour typescript

ES LINT :  un linter très puissant dont les règles sont simples à configurer

ps : Le style guide javascript de Air B&B vaut le coup d’oeil

Angular

Angular V6 Snippets : des snippets angular par John Papa

Angular TypeScript Snippets for VS Code

Angular2-inline : placement des attributs sur une seule ligne + coloration syntaxique

angular2-inline

 

React

React Native tools : aide au dev pour du React Native

React Native

React-Native/React/Redux snippets for es6/es7 : des sniipets pour le trio magique

Autres

TODO Highlight : Surligne les an noations que vous souhaitez metttee en avant dans vos commentaire tel que TODO, FIXME AFAIRE…

VSCODE-TODO-HIGHLIGHT

 

Rainbow Brackets: une extension pour savoir ou en est avec toutes nos parenthèses

Debugger for Chrome : une extension pour debugger dans Chrome

Docker support for Visual Studio Code : comme son nom l’indique, aide à builder et deployer des applications dans des container Docker depuis VSCode

EditorConfig for VS Code: pour avoir un fichier de configuration, editorconfig,  de l’éditeur qui pourra être versionné

 

Themes

Dracula: le thème

Dracula

Material Icon Theme : car j’aime bien voir du premier coup à quel type de fichier ou dossier correspond un élement

 

 

 

Angular-cli et Sass

Angular Cli

Démarrer un projet Angular sous Sass

Angular Cli

Pour tous ceux qui souhaitent utiliser Angular-cli avec Sass facilement voir la démarche:

Lorsqu’on travaille avec le cli, la feuille de style par défaut se termine par .css. Ce qui nous intéresse c’est d’utiliser l’extension scss sur nos fichiers.

Tout d’abord, pour démarrer un nouveau projet angular utilisant .sass , il nous suffit d’utiliser le flag –style

ng new mon-projet-sous-sass --style=scss

On pourrait aussi utiliser du sass ou less mais ce n’est pas ce qui nous intéresse : –style =less

Convertir un projet angular vers Sass

Si vous aviez déjà créé un projet utilisant simplement .css. Cela va nécéssiter un tout petit plus de travail pour le convertir en scss.

Tout d’abord on demande à angular de convertir notre projet pour utiliser le scss

ng set default.styleExt scss

On peut aussi le faire en modifiant le fichier .angular-cli.json

"defaults": {
    "styleExt": "scss",
    "component": {}
  }

Malheusement cela ne modifiera pas les fichier créés. Pour les anciens fichier .css pour devrez les modifier à la main, chager l’extension .css en .scss et penser à modifier dans le component le stylesUrls

@Component({
  styleUrls: ['./mon-component.scss'],
})

Utiliser l’import Sass plus simplement

Si vous créer des mixins ou des variables, le plus souvent , ceux ci sont dans des fichiers externes dans votre dossier sass

par exemple:
|- src/
|- assets/
|- sass/
|- _variables.scss
|- _mixins.scss
|- styles.scss

Pour utiliser nos mixins et variables dans le fichiers styles.scss, on les importe:

/ fichier styles.scss
  
@import './assets/sass/variable';
@import './assets/sass/mixins';

Rien de fou ici, ca commence à devenir plus contraignant lorsqu’on souhaite utiliser ses mêmes variables dans des composants angular qu’on aurait créé.
Exemple de cas
|- src/
|- app/
|- header
|- social/
|- social.component.html
|- social.component.scss
|- social.component.ts
|- menu/
|- menu.component.html
|- menu.component.scss
|- menu.component.ts
|- search/
|- search.component.html
|- search.component.scss
|- search.component.ts
|- assets/
|- sass/
|- _variables.scss
|- _mixins.scss
|- styles.scss

Si nous devions importer variables et mixins dans nos 3 fichiers de styles, il aurait fallu y accéder en prenant en compte le chemin relatif du dossier sass par rapport au component.

// fichier component.scss
  
@import "../../../assets/sass/mixins";
@import "../../../assets/sass/variables";

Heureusement Angular-cli propose une manière simplifié d’importer des fichiers sass: il faut utiliser ~

// fichier component.scss
  
@import "~assets/sass/mixins";
@import "~assets/sass/variables";

Angular cli + Bootstrap 4

Bootstrap 4

Pour ceux qui utilisent bootstrap.
On installe d’abord bootstrap via npm

npm install --save boostrap@4.0.0-beta

Ajout du css bootstrap dans le fichier config : .angular-cli.json

"styles": [
  "../node_modules/bootstrap/dist/css/bootstrap.css",
  "./styles.scss"
],

On utilise ../node_modules car le point de départ du cli est le dossier src/

Ajout des fichiers sass

Nous n’avons pas toujours besoin d’importer tous les fichiers .
Dans le dossier bootstrap, nous avons tous ces fichiers :

      Bootstrap
      /*!
       * Bootstrap v4.0.0-beta (https://getbootstrap.com)
       * Copyright 2011-2017 The Bootstrap Authors
       * Copyright 2011-2017 Twitter, Inc.
       * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
       */

      @import "functions";
      @import "variables";
      @import "mixins";
      @import "print";
      @import "reboot";
      @import "type";
      @import "images";
      @import "code";
      @import "grid";
      @import "tables";
      @import "forms";
      @import "buttons";
      @import "transitions";
      @import "dropdown";
      @import "button-group";
      @import "input-group";
      @import "custom-forms";
      @import "nav";
      @import "navbar";
      @import "card";
      @import "breadcrumb";
      @import "pagination";
      @import "badge";
      @import "jumbotron";
      @import "alert";
      @import "progress";
      @import "media";
      @import "list-group";
      @import "close";
      @import "modal";
      @import "tooltip";
      @import "popover";
      @import "carousel";
      @import "utilities";

Beaucoup de fichiers non nécéssaire pour vos projets

Pour utiliser bootstrap, nous n’avons besoin que de ce strict minimum

// src/styles.scss
 
@import
  '~bootstrap/scss/functions',
  '~bootstrap/scss/variables',
  '~bootstrap/scss/grid',
  '~bootstrap/scss/mixins',
  '~bootstrap/scss/print',
  '~bootstrap/scss/reboot',
  '~bootstrap/scss/type';

Avec le ~, importé des fichiers sass devient très facile.
+++

 

sass