Ma première route

Dans cette section, nous allons voir la base de la création et du fonctionnement des routes. Tous les exemples présentés dans ce cours sont disponibles en entier ici.

Créer une route simple
Les réponses prédéfinies
Les informations
Enregistrer les routes
Le floor
Lancer le serveur web

Créer une route simple

Dans Duplo, plusieurs objets complexes nécessitent l’utilisation d’un builder. La fonction useBuilder permet d’accéder aux différents builders disponibles. Ici, nous utiliserons useBuilder pour obtenir la méthode createRoute, qui donne accès au builder permettant de créer une route.

import { useBuilder, OkHttpResponse } from "@duplojs/core";

export const myRoute = useBuilder()
    .createRoute("GET", "/hello-world")
    .handler(() => {
        return new OkHttpResponse(
            "Hello World!", 
            "This is a body."
        );
    });

Dans cet exemple :

La méthode createRoute est utilisée pour créer un builder d’objet Route.

La route créée est une méthode GET avec le chemin /hello-world.

La méthode handler fait partie du builder de route et termine la création de celle-ci.

La méthode handler doit contenir l’action de la route et renvoyer une réponse positive.

La méthode handler fait partie du builder de l’objet Route. Elle a pour effet direct d’ajouter une HandlerStep aux étapes de la route en cours de création. Les routes ne peuvent avoir qu’une seule HandlerStep qui doit obligatoirement être la dernière étapes. C’est pourquoi l’appel de cette méthode clôture la création de l’objet Route et le renvoie.

Cycle d’exécution

Une route est constituée d’objets Step implémentés à travers un builder. L’ordre d’implémentation est important car l’exécution d’une route est séquentielle, du haut vers le bas. Chaque Step a la possibilité d’interrompre l’exécution et de renvoyer une réponse.

import { useBuilder, OkHttpResponse } from "@duplojs/core";

useBuilder()
    .createRoute("GET", "/hello-world")
    .extract(/* ... */)
    .check(/* ... */)
    .exec(/* ... */)
    .handler(() => {
        return new OkHttpResponse(
            "Hello World!", 
            "This is a body."
        );
    });

Dans cet exemple :

Une route a été créée avec 4 Step.

Le cycle d’exécution de la route se lit du haut vers le bas :

ExtractStep

CheckerStep

ProcessStep

HandlerStep

Paramètres de path

Les routes peuvent être dynamiques pour accepter des paramètres. Les paramètres courants sont accessibles à travers la clé params de l’objet Request.

import { useBuilder, OkHttpResponse } from "@duplojs/core";

useBuilder()
    .createRoute("GET", "/user/{userId}")
    .handler(() => {
        return new OkHttpResponse(
            "Hello World!", 
            "This is a body."
        );
    });

Dans cet exemple :

La route possède un paramètre userId.

Les paramètres sont toujours de type string

Les réponses prédéfinies

Comme vous avez pu le remarquer, l’objet retourné par le handler des routes en exemple est OkHttpResponse. Cet objet est une réponse prédéfinie. Ici OkHttpResponse représente une réponse avec le code 200. Il existe plus de 30 objets de réponse prédéfinis. Tous ces objets sont des extensions de l’objet Response. Les réponses prédéfinies ont été créées pour éviter d’utiliser directement des codes de statut de réponse qui sont de simples nombres. Cela permet d’apporter plus de sens lors de la lecture du code.

import { Response, OkHttpResponse } from "@duplojs/core";

// output: true
console.log(new OkHttpResponse(undefined) instanceof Response);

const presetReponse = new OkHttpResponse("OK", "Hello, World!");
// équivalent à
const reponse = new Response(200, "OK", "Hello, World!");

Dans cet exemple :

L’instance de l’objet OkHttpResponse est bien également une instance de l’objet Reponse.

Les constantes presetReponse et reponse, contiennent toutes deux une réponse équivalente avec un statut à 200.

L’utilisation du nombre 200 tel quel est une mauvaise pratique appelée magic number.

Les informations

Comme vous pouvez l’observer dans les exemples donnés précédemment, lorsque l’on instancie une réponse, nous précisons en premier argument l’information de celle-ci.

import { useBuilder, OkHttpResponse } from "@duplojs/core";

export const myRoute = useBuilder()
    .createRoute("GET", "/hello-world")
    .handler(() => {
        return new OkHttpResponse(
            "My super info!", 
            undefined
        );
    });

Dans cet exemple :

La réponse renvoyée aura un header nommé information possédant la valeur My super info!.

La réponse a un body undefined.

Idéalement, chaque réponse envoyée possède une information différente, ce qui permet d’identifier de quelle partie du code provient la réponse. Le front pourra également se baser sur ces informations pour identifier le succès ou l’erreur d’une réponse. Par exemple, il peut arriver de renvoyer des erreurs 400 pour des raisons différentes. Cela permet de les différencier.

Enregistrer les routes

Après avoir défini les routes, il faut les enregistrer pour qu’elles soient utilisables par une instance Duplo. La méthode la plus simple pour enregistrer une route est d’utiliser register.

import { Duplo } from "@duplojs/core";
import { myRoute } from "./route";

const duplo = new Duplo({
    environment: "TEST"
});

duplo.register(myRoute);

Dans cet exemple :

new Duplo initialise l’application avec un environnement de test.

register ajoute la route myRoute pour qu’elle soit active dans l’application.

Enregistrer toutes les routes créées

Il est possible d’enregistrer des routes à la volée sans les spécifier en utilisant useRouteBuilder.getAllCreatedRoute().

import { Duplo, useRouteBuilder } from "@duplojs/core";
import "./route";

const duplo = new Duplo({
    environment: "TEST"
});

duplo.register(...useRouteBuilder.getAllCreatedRoute());

Dans cet exemple :

import "./route"; permet d’executer le fichier sans importer ses variables.

useRouteBuilder.getAllCreatedRoute() récupère toutes les routes créées.

Il est nécessaire d’importer les fichiers contenant vos routes avant d’utiliser useRouteBuilder.getAllCreatedRoute(), sans quoi elles ne seront pas créées et ne pourront donc pas être récupérées. Sinon aucune route ne sera enregistrée.

Le floor

Le floor dans Duplo est un accumulateur typé, qui s’enrichit suivant les différentes étapes implémentées dans les routes. Chaque route possède son propre floor pendant son exécution.

import { makeFloor } from "@duplojs/core";

const floor = makeFloor<{foo: "bar", prop: number}>();

const bar = floor.pickup("foo"); // typeof bar === "bar"

const { foo, prop } = floor.pickup(["foo", "prop"]); 
// typeof foo === "bar"
// typeof prop === number

Dans cet exemple :

makeFloor crée un floor avec des propriétés spécifiques (foo et prop).

pickup permet d’accéder aux valeurs de ces propriétés.

Exemple du floor dans une route

La méthode handler reçoit en premier argument la méthode pickup du floor de la route.

import { OkHttpResponse, useBuilder, zod } from "@duplojs/core";

export const myRoute = useBuilder()
    .createRoute("GET", "/hello-world")
    // Extract est une step qui permet d'enrichir le floor
    .extract({
        query: {
            foo: zod.string()
        }
    })
    .handler((pickup) => {
        // Ici, pickup est utilisé pour accéder aux propriétés du floor
        const bar = pickup("foo");

        return new OkHttpResponse(
            `Hello ${bar}`, 
            "this is a body"
        );
    });

Dans cet exemple :

La méthode extract est utilisée pour enrichir le floor, son utilisation sera précisée plus tard.

pickup est passé au handler, permettant d’accéder aux propriétés du floor comme foo.

Le typage de la propriété foo est garanti.

Le floor est un élément très important dans duplo. Chaque donnée insérée à l’intérieur provient d’une étape que vous avez implémentée dans votre route. Toute donnée disponible dans le floor est typée, ce qui rend son utilisation robuste et fiable. Cepandant, l’utilisation du type any sera toujours un problème. A vous de faire en sorte de ne jamais l’utiliser.

Lancer le serveur web

Duplo est un framework agnostique de la platforme ce qui signifie qu’il ne dépant d’aucune api externe au langage javascript. Dans les exemples qui seront présentés tout au long du cours, nous utiliseront NodeJS. Pour cela nous vous invitons à suivre la bonne installation. Pour accéder à la méthode launch qui permet de lancer le serveur web, il vous faut importer le module @duplojs/node en haut de votre fichier principal.

import "@duplojs/node";
import { Duplo, useRouteBuilder } from "@duplojs/core";

const duplo = new Duplo({
    environment: "DEV",
    host: "localhost",
    port: 1506,
});

duplo.register(...useRouteBuilder.getAllCreatedRoute());

const server = await duplo.launch();

Dans cet exemple :

L’importation du module @duplojs/node a été mise tout en haut.

L’instance de Duplo possède maintenant plus de paramètre dont host et port qui deviennent des propriétés obligatoires.

Toutes les routes créées avec la fonction useBuilder sont enregistrées dans l’instance de Duplo courante.

Le serveur se lance sur le port 1506 en accessibilité localhost.

Obtenir de la donnée d’une requête >>>