Cas d'utilisation de NgRx, partie III : prise de décision

Photo de couverture originale par Hansjörg Keller sur Unsplash.

Dans mes articles précédents, nous avons abordé les restrictions d'accès et la gestion des listes avec NgRx. Aujourd'hui, nous allons aborder un problème plus général de prise de décision au sein d'une application Angular qui utilise principalement les effets NgRx (mais aussi un peu de réducteurs et de sélecteurs). Dans cet article, nous aborderons les sujets suivants :

• Gestion des erreurs avec NgRx
• Gérer les redirections
• Gestion des données de chargement
• Interactions utilisateur

Commençons !

Gestion des erreurs avec NgRx

La gestion des erreurs est quelque chose que tout le monde déteste (et oublie souvent), mais aussi quelque chose dont tout le monde a vraiment, vraiment besoin. Avec les applications NgRx, la complexité de la gestion des erreurs augmente en fait si nous n'y traitons pas avec le soin approprié. Habituellement, les erreurs dans NgRx proviennent d'effets qui, dans la plupart des scénarios, sont provoqués par des requêtes HTTP.

Il existe généralement deux approches pour gérer les erreurs en général : la gestion locale ou globale. La gestion locale signifie que nous traitons réellement l'erreur très spécifique survenue dans une partie spécifique de l'application. Par exemple, si l'utilisateur ne parvient pas à se connecter, nous pourrions souhaiter afficher un message d'erreur très spécifique tel que "Nom d'utilisateur ou mot de passe invalide", au lieu d'un message d'erreur générique tel que "Quelque chose s'est mal passé".

La gestion globale, en revanche, signifie que nous regroupons, d'une certaine manière, toutes les erreurs dans un seul "pipeline" et utilisons les messages d'erreur très génériques que nous avons mentionnés précédemment. Nous pourrions bien sûr lancer une discussion sur quelle idée est la plus adaptée à quels scénarios, mais la dure réalité est que presque toutes les applications auront besoin d’un peu des deux mondes. Nous voulons afficher des messages d'erreur si des erreurs se produisent ("Quelque chose s'est mal passé" est toujours mieux qu'un échec silencieux), mais nous voulons également effectuer certaines actions spécifiques en cas de quelques erreurs. Abordons les deux scénarios.

Gestion des erreurs génériques avec NgRx

Dans NgRx, tout ce qui se passe est déclenché par une action. Pour les activités pouvant impliquer de générer une erreur (appels HTTP, WebSockets, etc), nous créons généralement plusieurs actions pour une seule activité :

export const DataActions = createActionGroup({
  source: 'Data',
  events: {
    'Load Data': emptyProps(),
    'Load Data Success': props<{ data: Data }>(),
    'Load Data Error': props<{ error: string }>(),
  },
});

Comme nous pouvons le voir, uniquement pour charger une donnée depuis une API, nous avons besoin de trois actions. Nous pouvons avoir des dizaines, voire des centaines, de telles actions « d'erreur » et de « succès » dans une application donnée, nous pouvons donc souhaiter afficher un message d'erreur générique au cas où l'une d'entre elles serait envoyée. Nous pouvons le faire en standardisant la charge utile de l’action d’erreur. Par exemple, nous pourrions vouloir ajouter une propriété très spécifique à toutes les actions qui représentent des erreurs. Dans notre cas, la présence de la propriété error dans la charge utile de l'action peut suffire pour savoir que l'action représente une erreur.

Nous pouvons alors nous abonner à toutes les actions qui représentent des erreurs et afficher un message d'erreur générique. Il s'agit d'un modèle très courant dans les applications NgRx et correspond généralement à ce que l'on entend par « gestion globale des erreurs ». Dans notre cas, nous pouvons le faire en nous abonnant à toutes les actions et en filtrant celles qui ont une propriété d'erreur dans leur charge utile :

export const handleErrors$ = createEffect(() => {
  const actions$ = inject(Actions);
  const notificationsService = inject(NotificationsService);
  return actions$.pipe(
    filter((action) => !!action.payload.error),
    tap((action) => {
      notificationsService.add({
        severity: 'error',
        summary: 'Error',
        detail,
      });
    }),
}, { functional: true, dispatch: false });

Dans ce cas, toute action « d'erreur » que nous expédions entraînera l'affichage de la même notification, mais également avec un message personnalisé. Nous pouvons aller un peu plus loin en standardisant l'approche de création des accessoires d'action en cas d'erreur. Voici une petite fonction d'assistance qui peut s'avérer utile :

export function errorProps(error: string) {
  return function() {
    return({error});
  };
}

Maintenant, nous pouvons utiliser cette fonction pour créer les accessoires d'erreur pour nos actions :

export const DataActions = createActionGroup({
  source: 'Data',
  events: {
    'Load Data': emptyProps(),
    'Load Data Success': props<{ data: Data }>(),
    'Load Data Error': errorProps('Failed to load data'),
  },
});

Cela rendra toutes les erreurs identiques pour éviter les fautes de frappe ou la confusion. Ensuite, améliorons cela pour pouvoir également gérer des erreurs très spécifiques.

Gestion d'erreurs spécifiques

Dans notre cas, nous souhaiterions peut-être pouvoir personnaliser le fonctionnement d'un gestionnaire d'erreurs générique pour certains cas spécifiques. Nous voulons pouvoir

• pour indiquer l'effet s'il faut afficher ou non un message d'erreur générique
• redirection vers des pages d'erreur avec des données prédéfinies
• afficher une notification d'erreur dans une page

Commençons par le premier. Nous pouvons le faire en ajoutant une nouvelle propriété à la charge utile de l'action d'erreur :

export function errorProps(error: string, showNotififcation = true) {
    return function() {
        return({error, showNotification});
    };
}

Nous pouvons maintenant créer une action qui indiquera plus tard à l'effet d'ignorer le message de notification générique :

export const DataActions = createActionGroup({
  source: 'Data',
  events: {
    'Load Data': emptyProps(),
    'Load Data Success': props<{ data: Data }>(),
    'Load Data Error': errorProps('Failed to load data', false),
  },
});

Ensuite, nous devrions mettre à jour l'effet pour refléter ceci :

export const handleErrors$ = createEffect(() => {
  const actions$ = inject(Actions);
  const notificationsService = inject(NotificationsService);
  return actions$.pipe(
    filter((action) => !!action.payload.error),
    tap((action) => {
      if (action.payload.showNotification) {
        notificationsService.add({
          severity: 'error',
          summary: 'Error',
          detail,
        });
      }
    }),
  );
}, { functional: true, dispatch: false });

Remarquez que nous n'avons pas ajouté la vérification de la propriété showNotification à l'opérateur de filtre. En effet, nous aurons des scénarios dans lesquels une notification ne devrait pas être affichée, mais une autre action doit encore être effectuée (comme la redirection vers une page d'erreur). Faisons précisément cela en ajoutant un nouveau paramètre à notre action d'erreur :

export function errorProps(error: string, showNotification = true, redirectTo?: string) {
  return function() {
    return({error, showNotification, redirectTo});
  };
}

Maintenant, nous pouvons créer une action qui indiquera plus tard à l'effet de rediriger vers une page d'erreur :

export const DataActions = createActionGroup({
  source: 'Data',
  events: {
    'Load Data': emptyProps(),
    'Load Data Success': props<{ data: Data }>(),
    'Load Data Error': errorProps('Failed to load data', false, '/error'),
  },
});

Next, let's finalize our effect by adding a redirection to the error page if the redirectTo property is present in the action payload:

export const handleErrors$ = createEffect(() => {
  const actions$ = inject(Actions);
  const notificationsService = inject(NotificationsService);
  const router = inject(Router);
  return actions$.pipe(
    filter((action) => !!action.payload.error),
    tap((action) => {
      if (action.payload.showNotification) {
        notificationsService.add({
          severity: 'error',
          summary: 'Error',
          detail,
        });
      }
      if (action.payload.redirectTo) {
        router.navigateByUrl(action.payload.redirectTo);
      }
    }),
  );
}, { functional: true, dispatch: false });

And that is it to this. Of course, if we need something really custom for a particular error action, we can just write a completely separate effect to handle that. Sometimes, if we want to also do something in the UI in relation to an error, we can also add the error message (and any other data) to the store and use them via a selector anywhere.

Next, let us discuss loading data into our component, and several approaches to it.

Handling loading data

Before we proceed, we should first understand that the approaches listed in this section are not better or worse than one another. Instead, they are approaches for different situations, depending on what we want for our UX. Let's examine them step by step.

Selecting data in the component to use

The most straightforward way we can get some data (presumably from an API) is by just selecting it in the component. With the latest APIs, we can select a signal of our data and use it directly in the template. Here is a very simple example:

@Component({
  selector: 'app-my',
  template: `
    <div>
      <h1>Data</h1>
      <p>{{ data() }}</p>
    </div>
  `,
})
export class MyComponent {
  data = this.store.selectSignal(dataFeature.selectData);
}

Of course, in real life, we often need to deal with scenarios like loading, errors, and so on. In this case, our state might look like this:

export interface State {
  data: Data | null;
  loading: boolean;
  error: string | null;
}

If we are using the createFeature function to register our state, we can make use of the selectDataState function that the feature automatically creates for us. This will return the entire state with loading, error, and data properties. We can then use this in our component:

@Component({
  selector: 'app-my',
  template: `
    <div>
    @if (vm().loading) {
      <p>Loading...</p>
    }
    @if (vm().error) {
      <p>Error: {{ vm().error }}</p>
    } @else {
      <h1>Data</h1>
      <p>{{ vm().data }}</p>
    }
    </div>
  `,
})
export class MyComponent {
  vm = this.store.selectSignal(dataFeature.selectDataState);
}

This is very useful in most scenarios. However, sometimes we might not want to display the entire page if this important piece of data is not loaded. In Angular, this is commonly achieved with the use of routing resolvers, functions that return some Observables that routing waits for to emit before displaying a particular page. This is easy with the use of the HttpClient service, however, this becomes a bit complicated with NgRx (because we only make HTTP calls inside effects), resulting in lots of developers skipping resolvers entirely. However, there is an easy way to achieve this functionality. Let's build a simple resolver that utiliuzes the Store and the Actions Observable to know when the data is actually loaded:

export const dataResolver: ResolveFn<Data[]> = () => {  
  const store = inject(Store);
  const actions$ = inject(Actions);
  store.dispatch(DataActions.loadData());
  return store.select(dataFeature.selectData).pipe(
    skipUntil(actions.pipe(ofType(DataActions.loadDataSuccess))),
  );
}

Here, we first dispatch the action that actually initiates the HTTP call, then we just return the selected data from the store as an Observable, but with a catch - we tell it to wait until the action signaling that the data has been loaded is dispatched. Given that effects are guaranteed to run after reducers, this will ensure that the data is actually put into the store before the resolver returns it. We can then just pick this data up in our component:

@Component({
  selector: 'app-my',
  template: `
    <div>
      <h1>Data</h1>
      <p>{{ vm.data() }}</p>
    </div>
  `,
})
export class MyComponent {
  private readonly route = inject(ActivatedRoute);
  readonly vm = toSignal(this.route.data, {
    initialValue: null,
  }) as Signal<{data: Data}>;
}

We used ActivatedRoute instead of the Store because we already returned this data in the resolver. This makes our components even leaner - we don't even have to inject the Store and in unit testing, it can be often easier to mock the ActivatedRoute than the Store.

Finally, let's take a look at advanced decision-making with NgRx actions and effects, and see how this can help work with complex cases in large applications.

User interactions

NgRx is very useful when writing declarative code, as it allows us to just select the relevant state, and use it in our templates. However, sometimes, especially when dealing with third-party libraries, we need to perform some "imperative actions" which is tangentially related to our store. Consider this code which uses the Angular Material MatDialog service to open a confirmation dialog:

export class MyComponent {
  private readonly dialog = inject(MatDialog);
  private readonly store = inject(Store);

  openConfirmationDialog() {
    const dialogRef = this.dialog.open(ConfirmationDialogComponent, {
      data: {
        title: 'Confirmation',
        message: 'Are you sure you want to do this?',
      },
    });

    dialogRef.componentInstance.confirm.subscribe(() => {
      this.store.dispatch(DataActions.deleteData());
    });

    dialogRef.componentInstance.cancel.subscribe(() => {
      dialogRef.close();
    });
  }
}

As we can see, there is a lot of imperative code in just this one method, there are two subscriptions, and they aren't even particularly simple (we just omitted unsubscription logic). Also, we must consider that in a normal application, we might have a dozen different places where the same confirmation dialog is used, with the only difference being the action that is performed when the user confirms/rejects.

Let's now approach this with an NgRx mindset, and try to create an action that can handle such a scenario, with callbacks as payloads.

export function confirmAction(callbacks: {confirm: () => void, reject: () => void}) {
  return function() {
    return({type: 'Open Confirmation Dialog', callbacks});
  };
}

Now, we can create an action that will later tell the effect to redirect to an error page:

export const DataActions = createActionGroup({
  source: 'Data',
  events: {
    'Delete Data': confirmAction({
      confirm: () => {
        return({action: 'Delete Data Confirmed'});
      },
      reject: () => {
        return({action: 'Delete Data Rejected'});
      },
    }),
  },
});

Now, we can create an effect that will handle all such actions:

export const handleConfirmationDialog$ = createEffect(() => {
  const actions$ = inject(Actions);
  const dialog = inject(MatDialog);
  return actions$.pipe(
    ofType(DataActions.openConfirmationDialog),
    tap((action) => {
      const dialogRef = dialog.open(ConfirmationDialogComponent, {
        data: {
          title: 'Confirmation',
          message: 'Are you sure you want to do this?',
        },
      });

      dialogRef.componentInstance.confirm.subscribe(() => {
        action.payload.callbacks.confirm();
      });

      dialogRef.componentInstance.cancel.subscribe(() => {
        action.payload.callbacks.reject();
      });
    }),
  );
}, { functional: true, dispatch: false });

Finally, we can really simplify our component:

export class MyComponent {
  private readonly store = inject(Store);

  openConfirmationDialog() {
    this.store.dispatch(DataActions.openConfirmationDialog({
      confirm: () => {
        this.store.dispatch(DataActions.deleteData());
      },
      reject: () => {
        // Do nothing
      },
    }));
  }
}

And that is it. However... we might face a problem if we try to make our application as fine as possible. In NgRx, it is a good practice to keep everything serializable, which is a fancy way of saying "easily convertible to JSON". In the app configuration, it is possible to set specific options to help safeguard us from, for example, putting functions in the store. This is done with two options, strictStoreSerializability and strictActionSerializability.

export const config: ApplicationConfig = {
  providers: [
    provideStore({}, {
      runtimeChecks: {
        strictActionSerializability: true,
        strictStoreSerializability: true,
      },
    }),
};

This goes a long mile to help keep our applications maintainable and prevent hard-to-debug issues.

[!NOTE] You can read more about runtime checks in the NgRx docs.

However, if we make actions strictly serializable, our confirmAction action will not work with the callbacks we passed! So, what can we do about it? Well, the easiest way is to give it other actions for confirm/reject options to handle by the effect. Because the nested actions will also be required to be serializable, this will help us bring everything back to a workable state, an approach that I personally call "higher-order actions".

export function confirmAction(confirmAction: string, rejectAction: string, callbackActions: {
  confirm: ActionCreator<any, any>,
  reject: ActionCreator<any, any>
}) {
  return function() {
    return({type: 'Open Confirmation Dialog', callbackActions});
  };
}

Next, we need to do a major update to our effect:

export const handleConfirmationDialog$ = createEffect(() => {
  const actions$ = inject(Actions);
  const dialog = inject(MatDialog);
  return actions$.pipe(
    ofType(DataActions.openConfirmationDialog),
    map(({callbackActions}) => {
      const dialogRef = dialog.open(ConfirmationDialogComponent, {
        data: {
          title: 'Confirmation',
          message: 'Are you sure you want to do this?',
        },
      });

      return merge([
        dialogRef.componentInstance.confirm.pipe(
          map(() => callbackActions.confirm()),
        ),
        dialogRef.componentInstance.cancel.pipe(
          tap(() => dialogRef.close()),
          map(() => callbackActions.reject()),
        ),
      ])
    }),
  );
}, { functional: true, dispatch: false });

Let's deconstruct what goes on here.

1. The ConfirmationDialogComponent exposes the confirm and cancel observables.
2. We open a MatDialog with the ConfirmationDialogComponent and every time an action created by the confirmAction is dispatched, we subscribe to the confirm observable and dispatch the action that was passed to the confirmAction function.
3. We also subscribe to the cancel observable and dispatch the action that was passed to the confirmAction function.
4. We return a merge of the two observables so that when either of them emits, the whole effect will emit.

With this implementation, it is easy to perform complex decision-making just using several actions in a component:

export class MyComponent {
  private readonly store = inject(Store);

  openConfirmationDialog() {
    this.store.dispatch(DataActions.openConfirmationDialog({
      confirm: DataActions.deleteData,
      reject: DataActions.cancelDeleteData,
    }));
  }
}

And that is it. With higher-order actions, we can easily delegate decision-making further to other effects and reducers as necessary, making the component code as declarative as possible.

Conclusion

In this article, we covered a few approaches to complex logic in Angular applications utilizing NgRx. NgRx is a huge tapestry of opportunities, and often we can easily transform ugly code into something understandable and maintainable. Such approaches are underappreciated, and with this piece, I try to bring them forth to help developers improve their state management solutions.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!