Better exceptions #803
Merged
Better exceptions #803
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
johangirod
force-pushed
the
TMP-better-exceptions
branch
3 times, most recently
from
33a9688
to
6e6ba32
Compare
johangirod
force-pushed
the
TMP-better-exceptions
branch
2 times, most recently
from
71edc3e
to
331fb03
Compare
XavierJp
approved these changes
Nov 29, 2023
johangirod
force-pushed
the
TMP-better-exceptions
branch
12 times, most recently
from
6c1da71
to
2402969
Compare
XavierJp
approved these changes
Dec 8, 2023
johangirod
force-pushed
the
TMP-better-exceptions
branch
5 times, most recently
from
02ef5b3
to
681b9ba
Compare
- refactor logging of core errors
- improve error handling on client
- Remove dual logging of TVA error
- Name Inpi Error
- fix error when calling localstorage
Nous utilisons [Sentry](https://errors.data.gouv) pour remonter les
erreurs du site. Voici les bonnes pratiques à suivre pour remonter une
erreur :
1. **Utiliser le bon niveau d'erreur**
- `logFatalErrorInSentry` : une erreur qui empêche tout ou une partie du
site de fonctionner. Une page d'erreur est affichée à l'utilisateur.
- `logErrorInSentry` : une fonctionnalité importante du site ne
fonctionne pas.
- `logWarningInSentry` : une fonctionnalité mineure du site ne
fonctionne pas. Un comportement imprévu est arrivé. Non bloquant
pour l'utilisateur.
- `logInfoInSentry` : information sur le comportement du site
2. **Logguer des erreurs et non des string**. Cela permet d'avoir les
stacktrace complètes et uniformise l'affichage dans sentry. Pour
cela vous pouvez vous aider de la classe `Exception`
```typescript
logErrorInSentry(new Exception({ name: 'RedisClientFailException' });
```
3. **Remonter des erreurs métiers** : l'erreur doit informer sur ce qui
n'a pas fonctionné du point de vue de l'utilisateur. Vous pouvez
utiliser le paramètre `cause` pour logguer l'erreur technique à
l'origine de l'erreur métier. Vous pouvez également ajouter des
informations contextuelles sur l'erreur via le paramètre
`context`.
```typescript try {
// ... } catch (e) { logErrorInSentry( new Exception({ name:
'AgentConnectionFailedException', message: 'Error during
authentication', cause: e, context: { siren, siret, details:
agentId, }, }) ); } ```
4. **Utiliser des classes d'erreur spécialisée**.
- `Exception` : erreur métier
- `InternalError` : bug interne du code qui n'est **jamais** supposé
arriver
- `FetchRessourceException` : erreur lors d'un appel à une API externe
Vous pouvez en créer d'autres en étendant la classe `Exception`.
johangirod
force-pushed
the
TMP-better-exceptions
branch
from
681b9ba
to
e2f3b43
Compare
XavierJp
reviewed
Dec 11, 2023
johangirod
commented
Dec 11, 2023
johangirod
force-pushed
the
TMP-better-exceptions
branch
from
e2f3b43
to
f432664
Compare
XavierJp
reviewed
Dec 11, 2023
Comment on lines
+24
to
+28
| message: 'Formatting error in view', | ||
| cause: e, | ||
| context: { | ||
| details: argsAsString, | ||
| }, |
There was a problem hiding this comment.
I guess if toString() fail, Sentry might not be able to serialize it either
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Dernière refacto sur la remontée d'erreur pour nettoyer Sentry, et repartir sur de bonnes bases.
Best practices à respecter
fatal: une erreur qui empêche tout ou une partie du site de fonctionner. Une page d'erreur est affichée à l'utilisateur.logErrorInSentry: une fonctionnalité importante du site ne fonctionne pas.logWarningInSentry: une fonctionnalité mineure du site ne fonctionne pas. Un comportement imprévu est arrivé. Non bloquant pour l'utilisateur.logInfoInSentry: information sur le comportement du siteExceptioncausepour logguer l'erreur technique à l'origine de l'erreur métier. Vous pouvez également ajouter des informations contextuelles sur l'erreur via le paramètrecontext.Exception: erreur métierInternalError: bug interne du code qui n'est jamais supposé arriverFetchRessourceException: erreur lors d'un appel à une API externeVous pouvez en créer d'autres en étendant la classe
Exception.