Features OIP

6 min

FeatureOptions

type FeatureOptions = {
  service?: {
    url: string;
    apiKey: string;
  };
  rabbitmq?: {
    messageBuilder: (response: unknown) => {
      message: unknown;
      queue: string;
    };
  };
  onUpdateTaskState?: (args: {
    error?: string;
    metadata?: unknown;
    state: {
      status: string;
      statusCode: number;
    };
  }) => Promise<void>;
};

Options

service

Configuration du service externe utilisé par la feature.

service?: {
  url: string;
  apiKey: string;
}

Usage :

endpoint d’un service tiers

authentification API

rabbitmq

Configuration de publication d’événements.

rabbitmq?: {
  messageBuilder: (response: unknown) => {
    message: unknown;
    queue: string;
  };
}

messageBuilder doit au minimum renvoyer :

message

queue

onUpdateTaskState

Handler optionnel de mise à jour d’état de task.

onUpdateTaskState?: (args: {
  error?: string;
  metadata?: unknown;
  state: { status: string; statusCode: number };
}) => Promise<void>;

Le paramètre taskState permet de définir les statuts à appliquer à la task pendant l’exécution de la feature.

When to use

Utiliser taskState si la feature :

démarre un traitement traçable

doit notifier un succès

doit notifier un échec

Exemple

const taskState = {
  starting: { status: 'STARTED', statusCode: 102 },
  success: { status: 'DONE', statusCode: 200 },
  failure: { status: 'FAILED', statusCode: 500 }
};