koajs / json-error Goto Github PK

Hey, I use json-error recently and found it great. I really appreciate your work.

Is there any plan to add a feature of customize http code when ctx.thow, just like:

app.use(koaJsonError({ status: 200 }))

I just want to set http code 200 and only put the error code into response body of my end point api.

Thanks, anyway.

Usually in the production environment application error should not display the error message, but redirect to the error page

When there is a: MongoError: E11000 duplicate I get this error. How can I handle this a bit better?

{
    "message": "Not Found",
    "name": "NotFoundError",
    "stack": "NotFoundError: Not Found\n    at Object.throw (/media/phil/Backup/sys/seoblog/api/node_modules/koa/lib/context.js:97:11)\n    at /media/phil/Backup/sys/seoblog/api/node_modules/koa-json-error/lib/middleware.js:52:58\n    at processTicksAndRejections (internal/process/task_queues.js:93:5)",
    "status": 404
}

a serializing function option is probably the best bet

I use json-error like the this:

...
koa.use(error({
        preFormat: null,
        format: (error) => {
            const {status, message, code, detail} = error;
            return {
                status,
                message,
                code,
                detail
            }
        }
    }));
...

and it works as expected. However, I noticed recently that my error event handler is now ignored:

koa.on('error', (error, ctx) => {
        // this never fires on error anymore  
        if (!error.status || error.status === 500) {
            logger.error(error.stack);
        }
        ctx.message = error.message;
        logger.error(`!! [${ctx.state.id}] ${error.status}`, error.message);
    });

If I remove json-error middleware, the error event handler starts to work again.

I guess I can move my handler to json-error format/preFormat, but that should be documented.

From the readme it is not clear to me how to have an error that contains just status and message. I know from postFormat that I can omit fields from the response. But I don't want them to be created in the first place. I have to use options.format (Function) to achieve that but how?

Some middlewares I use won't don't throw when something is wrong, but will return a 500.
Currently you handle only 404:

This is meant to simplify the current API and offer an alternative to the preFormat, format, postFormat functions, which may be confusing some users.

In addition to allow passing an options object, we may benefit from receiving a single function instead which should behave as a shorthand for:

let opts = {
   format: (err) => {
      let obj = {};
      // Modify `obj` in any way
      return obj;
   }
}
app.use(error(opts));

So, the above should be equivalent to:

function formatError(err) {
  let obj = {};
  // Modify `obj` in any way
  return obj;
} 
app.use(error(formatError));

Docs should also be updated.