Serveur Express

1 min

Le serveur Express se lance via une fonction start. La signature de cette fonction est :

type ServerConfig = {
  cookieOptions?: CookieSessionInterfaces.CookieSessionOptions;
  corsOptions?: CorsOptions;
  routes?: RequestHandler[];
  securityHeadersOptions?: HelmetOptions;
  graphql: {
    resolvers: IResolvers[];
    typeDefs: DocumentNode[];
    security?: { payloadLimit?: string; armorConfig?: GraphQLArmorConfig };
  };
  logger: {
    info: (message: unknown) => void;
    warn: (message: unknown) => void;
    error: (message: unknown) => void;
  };
  process: {
    resolveFirstView: (args: { projectId: string; viewId?: string; metadata?: object }) => Promise<string>;
    extendWith?: (process: Process) => Promise<Process & object>;
  };
  session: {
    validateProjectId: (args: { projectId: string; sessionId: string | null | undefined }) => Promise<boolean>;
    resolveProjectFromContext: (args: { sessionId: string | null | undefined }) => Promise<string>;
    resolveContext?: (token: string) => Promise<object>;
  };
};

export const start: (config: ServerConfig) => Promise<void>;

La description des paramètres de la fonction start est :

cookieOptions : objet permettant de configurer la gestion des cookies ; voir la documentation de la bibliothèque cookie-session pour la liste des éléments configurables ;

corsOptions : objet permettant de configurer la gestion des CORS ; voir la documentation de la bibliothèque cors pour la liste des éléments configurables ;

routes : liste de routes propres à l'OAV à enregistrer auprès du serveur Express ;

securityHeadersOptions : objet permettant de configurer les headers de sécurité ; voir la configuration de la bibliothèque helmet pour la liste des éléments configurables ;

graphql :

resolvers : resolvers GraphQL des vues ;

typeDefs : typeDefs GraphQL des vues ;

security :

payloadLimit : valeur numérique permettant de définir la taille maximale autorisée de la payload des requêtes GraphQL entrantes. Par défaut, la valeur est 50kb ;

armorConfig : objet permettant de configurer la bibliothèque graphql-armor. Les règles de validation configurables sont :

**cost limit ;

**field suggestions ;

**max aliases ;

**max depth ;

**max directives ;

**max tokens ;

logger : objet exposant les fonctions de logging ; trois niveaux sont utilisés : info, warn, et error ;

process :

resolveFirstView : fonction asynchrone définissant l'identifiant de la première vue.

[info] Dans la fonction resolveFirstView, la valeur de la propriété viewId est nulle dans le cas d'un nouveau parcours et non nulle dans le cas d'une reprise de parcours.

extendWith : fonction asynchrone permettant d'attacher des informations complémentaires à l'objet process. Sa signature est :

(process: Process) => Promise<Process & object>

session :

validateProjectId : fonction asynchrone vérifiant si l'identifiant passé en paramètre correspond à une entité Project valide.

resolveProjectFromContext : fonction asynchrone initialisant une entité Project à partir d'un contexte.

resolveContext : fonction asynchrone responsable de récupérer le contexte à partir d'un token d'authentification.