Skip to content
/ hubme Public template

Introduction to ReasonReact and GraphQL

Notifications You must be signed in to change notification settings

miage-lille/hubme

Repository files navigation

HUB ME

Introduction

Le Document Object Model (DOM) est une interface de programmation pour les documents HTML, XML et SVG. Le DOM fournit une représentation du document comme un groupe structuré de nœuds et d'objets qui ont des propriétés et des méthodes. Les nœuds peuvent également être associés à des gestionnaires d'événements, et une fois que cet événement est déclenché, les gestionnaires d'événements sont exécutés. Essentiellement, il relie les pages Web aux scripts ou aux langages de programmation.

Le DOM a deux principaux problèmes lorsqu'on l'utilise pour construire des applications :

  1. Le manque d'encapsulation:
  • Angular ou les webcomponents utilisent Shadow DOM
  • Vue ou React utilisent leur propre modèle de composants
  • Svelte utilise une technique de scoping css
  1. De mauvaise performance pour modifier l'arbre de noeuds
  • Vue comme React utilisent un Virtual DOM : Le Virtual DOM est une abstraction du HTML DOM. Il est léger et détaché des détails d'implémentation spécifiques au navigateur. Puisque le DOM lui-même était déjà une abstraction, le DOM virtuel est, en fait, une abstraction d'une abstraction.

Le développement d'application web fait apparaitre le besoin de pratiques de développement. Là aussi 2 approchent se distinguent :

  1. L'approche par templating, c'est à dire une séparation de la gestion du rendu (template) et du comportement d'un composant. Cette approche est celle de HTML, Vue, Angular, Webcomponent ou Svelte.

  2. L'approche composable, c'est à dire la capacité de composer les IHM comme des fonctions à partir d'une unité qui est le composant. Cette apporche est celle de React dès 2013.

React

Pour ce TP nous allons réaliser une application React en ReasonML. Pour cela nous utiliserons la toolchain buckelscript, qui permet de compiler du ReasonML vers du Javascript, ainsi que la librairie ReasonReact qui fournit les bindings javascript pour ReasonML.

Play with interop

Vous pouvez faire des essais sur le TRY de ReasonML pour voir le code JS généré par Buckelscript (et au passage son équivalent OCaml).

Par exemple :

/* js unicode string */
let icn_cheers = {js|🍻|js};

/* binding to a global value */
type timerId;
[@bs.val] external setTimeout : (unit => unit, int) => float = "setTimeout";
[@bs.val] external clearTimeout : float => unit = "clearTimeout";

/* bind a global module */
[@bs.scope "Math"] [@bs.val] external random : unit => float = "random";


/* and use tem */
let someNumber = random();
setTimeout( _ => Js.log(someNumber), 1000);

/* Hangle Null or Undefined */
let jsNull = Js.Nullable.null;
let jsUndef = Js.Nullable.undefined;


/* deal with variadic function */
[@bs.val] [@bs.variadic] external log: array(string) => string = "console.log";
let v = log([|"a", "b"|]);

/* ... just an overview of BS capacities ... */

Buckelscript fournit native plusieurs modules de bindings :

  • Belt : the BuckleScript standard library (beta). Cette librairie fournit des fonctions utilitaires orientées "JS".
  • Dom: DOM types.
  • Node: pour les APIs notde. Experimental !
  • Js : toutes les APIs usuelles JS! Il est possible par exemple d'utiliser l'API JS Array plutôt que le module Array de ReasonML... Ce n'est pas un problème mais dans ce cas ce code ne compilera pas en natif.

BS fournit également un nouvel opérateur -> (pipe first). Il fonctionne de manière similaire au pipe |> si ce n'est que l'expression à gauche est injectée comme paramètre le plus à gauche de l'expression droite (vs le pipe qui injecte comme paramètre le plus à droite)

Run

npm install
npm run dev

Ouvrir un nouvel onglet sur http://localhost:8000/.

Quand vous modifier un fichier .re dans src la page est rechargée.

Si vous utilisez VSCode, je vous recommande d'installer le plugin reason-vscode qui est préférable pour les projets utilisant Buckelscript. Désactivez OCaml and Reason IDE si vous l'aviez installé (qui est lui préférable pour les projets natifs).

N'hésitez pas à consulter Index.re pour voir comment les composants sont ajoutés au DOM.

Premier composant

Un premier composant Greeting.re qui ne fait pas grand chose

[@react.component]
let make = _ => {
    let atom = {js|ReasonReact makes ⚛️ UI |js};

    <div> {React.string(atom)} </div>;
};

Le snippet [@react.component] permet de déclarer un composant nommé comme le module le contenant, le composant en lui même est défini par une fonction make qui prend en paramètre les propriétés du composant et retour un reactElement.

Children and Hooks

Un second composant BlinkingGreeting.re

[@react.component]
let make = (~children) => {
  let (show, setShow) = React.useState(() => true);

  // Notice that instead of `useEffect`, we have `useEffect0`. See
  // reasonml.github.io/reason-react/docs/en/components#hooks for more info
  React.useEffect0(() => {
    let id =
      Js.Global.setInterval(
        () => setShow(previousShow => !previousShow),
        1000,
      );

    Some(() => Js.Global.clearInterval(id));
  });

  let style =
    if (show) {
      ReactDOMRe.Style.make(~opacity="1", ~transition="opacity 1s", ());
    } else {
      ReactDOMRe.Style.make(~opacity="0", ~transition="opacity 1s", ());
    };

  <div style> children </div>;
};

Un pattern courant en react est d'utilisé une propriété Children qui est elle-même un reactElement afin de composer de manière déclarative une interface. Cette propriété correspond à tout ce qui est entre les balises JSX quand le composant est appelé.

On constate également deux fonctions particulières useState et useEffect. Il s'agit de Hooks.

Un composant React possède des propriétés, passées en paramètre de la fonction make et fournis par les paramètres du tag JSX et des états, initialisés par le hook useState et modifié par la fonction setXXX retourné par useState. A chaque fois qu'une propriété ou un état est modifié, le composant est redessiné, de manière intelligente grâce au VDom.

Le second Hook useEffect0 permet de gérer un effet au montage du composant et retourne une fonction de nettoyage qui sera exécutée lorsque le composant sera démonté.

Un troisième composant ReducerFromReactJSDoc.re

Lorsque l'état du composant ou la gestion de son cycle de vie se complexifie, l'utilisation de useState peut s'avérer pénible. Il est possible d'utiliser le pattern reducer facilement grace au Hook useReducer (c'est un modèle acteur appliqué à la gestion de l'état interne du composant).

Un quatrième composant ReducerFromReactJSDoc.re

Vous devriez maintenant être capable de comprendre ce composant qui fetche une API distante pour afficher des photos de chiens.

EXERCICE 1 :

Créez un composant FetchedRandomDog.re. random dog component

Ce composant récupère une image de chien au hasard. Quand on clique sur "new dog", l'état évolue pour afficher un nouveau chien.

Bundle for Production

Pour la production, il est nécessaire de construire un bundle, le projet est paramaétré avec webpack.

npm run bundle
open indexProduction.html

Handle Routing Yourself

ReasonReact dispose d'un router qui peut vous intéresser pour le suite.

EXERCICE 2 :

Créez un racine de menu et faites une page pour chacun des composants du projet.

GraphQL

GraphQL est un langage de requete d'API permettant des queries (requetes en lecture), des mutations (modifications) et des notifications (en quelque sorte des queries reactives).

Nous allons utliser l'API de Github pour explorer GraphQL. Commencez par créer un token pour utiliser l'API : https://developer.github.com/v4/guides/forming-calls/#authenticating-with-graphql

Le premier intérêt de graphQL est que nous avons un end-point unique : https://api.github.com/graphql

Vous pouvez tester votre token :

curl -H "Authorization: bearer mytoken" -X POST -d " \
 { \
   \"query\": \"query { viewer { login }}\" \
 } \
" https://api.github.com/graphql

Vous pouvez ensuite utiliser https://graphiql-online.com/graphiql pour explorer l'API github.

Urql

Pour requêter l'api GraphQL dans notre application, je vous propose d'utiliser la librairie URQL qui dispose déjà de bindings Buckelscript

Liser le Readme et consulter les exemples pour intégrer cette librairie à votre projet.

EXERCICE 3 (query) :

Créez un nouveau composant qui affiche votre nom, avatar,votre status, votre nombre de follower et votre nombre de following récupérés grâce à l'API Github.

EXERCICE 4 (mutation) :

Créez un nouveau composant qui permette de modifier votre status Github depuis un champ de saisie.