GoogleCloudPlatform / GoogleCloudPlatform/functions-framework-nodejs

Propagate framework errors to user application

Ouverte
#686 3 commentaires 4 réactions 0 personnes assignées Voir sur GitHub
feature request P2
Langage dominant
TypeScript
Étoiles
1.4k
Forks
181
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

Currently, errors that happen in the framework express layer are passed to the default express error handler. The default error handler returns the error to the client with a stack trace if in non-prod enviornments. It would be useful for certain cases for the user to have context of what happened during a request instead of the user being bypassed entirely. Instead, if the user has an error handler middleware installed in their application, we should pass the framework error to the user's error handler.

For example, if the framework gets a request with a bad json body.

```
const app = express():

app.post("/", (req, res) => {
...
});

// User error handler
app.use((err, req, res, next) => {
logger.log(err);
res.send("Caught error!");
});

functions.http("function, app);
```

```
// Post request with bad JSON
http.post("/", "{"id": "Hello}");
```

The framework responds with the following not very helpful message from the Express default error handler:

```
SyntaxError: Expected double-quoted property name in JSON at position 20 (line 3 column 1)
at JSON.parse ()
at parse (functions-framework-nodejs/node_modules/body-parser/lib/types/json.js:92:19)
at functions-framework-nodejs/node_modules/body-parser/lib/read.js:128:18
at AsyncResource.runInAsyncScope (node:async_hooks:211:14)
at invokeCallback (functions-framework-nodejs/node_modules/raw-body/index.js:238:16)
at done (functions-framework-nodejs/node_modules/raw-body/index.js:227:7)
at IncomingMessage.onEnd (functions-framework-nodejs/node_modules/raw-body/index.js:287:7)
at IncomingMessage.emit (node:events:518:28)
at endReadableNT (node:internal/streams/readable:1698:12)
at process.processTicksAndRejections (node:internal/process/task_queues:90:21)
```

There should be an option to propagate errors to the user client applcation, so their error handler is triggered and can preform logging, mitigations, or any other action the user wants instead of ignoring and leaving their application in the dust.

I've created #685 to address this issue.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par suivre la gestion des erreurs de la couche Express du framework et examinez l'issue associée #685. La modification sera terminée lorsque les erreurs du framework, telles que le JSON malformé, atteindront un middleware error-handler installé par l'utilisateur, permettant à l'application de les journaliser ou de les gérer au lieu que le handler Express par défaut ne réponde directement.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
express, nodejs, typescript
Domaine
api, backend
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
Active
Clarté
Plutôt claire
Accessibilité débutants
55/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.