Feature/#235 pass payload to extend server error #236
Conversation
| @@ -51,10 +51,6 @@ function extendServerError (fn) { | |||
| throw new TypeError('The server error object must be a function') | |||
| } | |||
|
|
|||
| if (typeof fn() !== 'object' || fn() === null || Array.isArray(fn())) { | |||
There was a problem hiding this comment.
I didn't understand why you removed this check.
If you pass something that is not an object, strange things will happen.
For example:
const xtend = require('xtend')
xtend({ hello: 'world' }, 'hello') // { '0': 'h', '1': 'e', '2': 'l', '3': 'l', '4': 'o', hello: 'world' }There was a problem hiding this comment.
But is this a task of the framework? The dev should return an object. When I add this check the function is executed although no error was responded. The dev is forced to make a null check in extendServerError
There was a problem hiding this comment.
Looks like the xtend function is too liberal. We use it only for this case. Why we don't switch to Object.assign ?
There was a problem hiding this comment.
Ok, I've understood your point, we should demand that check to the user, maybe we can be more clear about this in the docs.
Regarding Object.assign vs xtend we should keep using xtend, since it is way faster.
test/reply-error.test.js
Outdated
| @@ -201,7 +201,11 @@ test('extend server error - encapsulation', t => { | |||
| }) | |||
|
|
|||
| fastify.register((instance, opts, next) => { | |||
| instance.extendServerError(() => { | |||
| instance.extendServerError((payloadError) => { | |||
| t.strictEqual(payloadError instanceof Error, true) | |||
docs/Decorators.md
Outdated
| @@ -58,9 +58,9 @@ Note: using an arrow function will break the binding of `this` to the Fastify `r | |||
| <a name="extend-server-error"></a> | |||
| **extendServerError** | |||
| If you need to extend the standard [server error](https://github.com/fastify/fastify/blob/master/docs/Reply.md#errors), this api is what you need. | |||
| You *must* pass a function that returns an object, Fastify will extend the server error with the returned object of your function. | |||
| You *must* pass a function that returns an object, Fastify will extend the server error with the returned object of your function. We pass the original error as first argument. | |||
There was a problem hiding this comment.
... The function will receive the original error object.
…/fastify-3.16.2 Bump fastify from 3.16.1 to 3.16.2
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
I removed the validation for the response type of the
extendServerErrorbecause this would require that the user has to check that err is set although this method is only called when an error is responded. In my opinion, its the task of the dev whether he uses the interface correctly. We can discuss it here.