Enrichir l'objet Process

11 min

Vue d’ensemble

Vous pouvez étendre le schéma par défaut de l’objet Process afin d’y ajouter des champs personnalisés pour répondre aux besoins spécifiques de votre OAV.

L’enrichissement suit trois étapes :

la mise à jour de la définition du type graphQL ExtendedProcess ;

la résolution des champs personnalisés côté serveur ;

la mise à jour de la définition de ProcessFragment côté client.

Étendre le schéma Process

Étape 1 : Éditer le type graphQL ExtendedProcess

Modifiez la définition du type graphQL ExtendedProcess dans le fichier server/graphql/types/extended-process-type.mjs pour ajouter vos champs personnalisés.

Exemple

import { gql } from 'graphql-tag';

export const ExtendedProcessType = gql`
  type ExtendedProcess implements Process {
    # base fields
    projectId: ID
    viewId: ID
    sessionId: ID
    clientId: ID
    viewData: ViewData

    # additional fields
    message: String
  }
`;

Explications

[warn] Il est impératif que le type ExtendedProcess implémente le type graphQL Process et inclue les champs qui font partie de sa définition.

Dans cet exemple, le champ message de type String est ajouté à la définition du type ExtendedProcess et par extension au schéma de l'objet Process.

Étape 2 : Résoudre les champs personnalisés

Éditez le fichier server/process/extend-process.mjs et la fonction extendProcess pour résoudre les champs additionnels.

Exemple

export const extendProcess = async (process) => {
  const message = 'Hello world!';

  return {
    ...process,
    message,
  };
};

Explications

La fonction de rappel extendProcess reçoit en paramètre l'objet qui représente le Process actuel. Il contient les champs résolus du schéma par défaut de l'objet Process.

Il est impératif que la fonction retourne ces champs par défaut, en plus des champs personnalisés résolus.

[warn] Assurez-vous que dans le fichier server/index.mjs de votre projet, la fonction extendProcess est correctement définie dans l'objet de configuration (propriété process.extendWith) passé à la méthode start.

Dans cet exemple, nous avons résolu la valeur du champ personnalisé message.

Étape 3 : Éditer le fragment GraphQL ProcessFragment

Modifiez la définition du fragment graphQL ProcessFragment dans le fichier app/graphql/fragments/process.js pour inclure les champs personnalisés attendus côté client.

Exemple

import { gql } from '@apollo/client';

export const ProcessFragment = gql`
  fragment ProcessFragment on ExtendedProcess {
    # base fields
    projectId
    viewId
    viewData
    sessionId
    clientId

    # additional fields
    message
  }
`;

Explication

[warn] Il est obligatoire que la définition du fragment ProcessFragment se base sur le type graphQL ExtendedProcess. Il est également nécessaire d'inclure les champs du schéma par défaut de Process dans la définition du fragment graphQL ProcessFragment.

Dans cet exemple, nous avons ajouté le champ personnalisé message à la liste des champs attendus pour la représentation de l'objet Process côté client.

Résumé

Pour ajouter une propriété personnalisée au schéma par défaut de l'objet Process, il faut :

Ajouter le champ personnalisé à la définition du type graphQL ExtendedProcess ;

Résoudre la propriété personnalisée grâce à la fonction de rappel extendProcess ;

Ajouter le champ personnalisé à la définition du fragment graphQL ProcessFragment côté client.

La propriété personnalisée est alors accessible depuis l'objet Process récupéré côté client et côté serveur d'une vue.