koa better error handler
v11.0.4
Um melhor manipulador de erros para Lad e Koa. Torna
ctx.throwAwesome (melhor usado com KOA-404-Handler)
ETIMEOUT e EBADFAMILY ) e envia 408 Erro de tempo limite do cliente<ul> para erros de validação de Mongoose com mais de uma mensagemctx.throw lindas mensagens (por exemplo ctx.throw(404) produzirá um belo objeto de erro)text/html , application/json e resposta textnpm install --save koa-better-error-handlerVocê provavelmente deveria estar usando isso em combinação com o manual KOA-404 também!
O pacote exporta uma função que aceita quatro argumentos (em ordem):
cookiesKey - Padrões para falselogger - Padrões para consoleuseCtxLogger - Padrões para truestringify -Padrões para fast-safe-stringify (você também pode usar JSON.stringify ou outra opção aqui, se preferir) Se você passar por um cookiesKey , o suporte para sessões será adicionado. Você sempre deve definir o valor desse argumento se estiver usando cookies e sessões (por exemplo, servidor da web).
Recomendamos usar o Cabin para o seu logger e você também deve usar o middleware, pois ele acelerará ctx.logger automaticamente, para facilitar os logs baseados em contexto.
Observe que este pacote suporta apenas koa-generic-session e ainda não suporta koa-session-store (consulte o código no index.js para obter mais informações, solicitações de tração são bem-vindas).
Não há suporte para sessões, cookies ou mensagens flash:
const errorHandler = require ( 'koa-better-error-handler' ) ;
const Koa = require ( 'koa' ) ;
const Router = require ( 'koa-router' ) ;
const koa404Handler = require ( 'koa-404-handler' ) ;
// initialize our app
const app = new Koa ( ) ;
// override koa's undocumented error handler
app . context . onerror = errorHandler ( ) ;
// specify that this is our api
app . context . api = true ;
// use koa-404-handler
app . use ( koa404Handler ) ;
// set up some routes
const router = new Router ( ) ;
// throw an error anywhere you want!
router . get ( '/404' , ctx => ctx . throw ( 404 ) ) ;
router . get ( '/500' , ctx => ctx . throw ( 500 ) ) ;
// initialize routes on the app
app . use ( router . routes ( ) ) ;
// start the server
app . listen ( 3000 ) ;
console . log ( 'listening on port 3000' ) ;Suporte interno para sessões, biscoitos e mensagens flash:
const errorHandler = require ( 'koa-better-error-handler' ) ;
const Koa = require ( 'koa' ) ;
const redis = require ( 'redis' ) ;
const RedisStore = require ( 'koa-redis' ) ;
const session = require ( 'koa-generic-session' ) ;
const flash = require ( 'koa-connect-flash' ) ;
const convert = require ( 'koa-convert' ) ;
const Router = require ( 'koa-router' ) ;
const koa404Handler = require ( 'koa-404-handler' ) ;
// initialize our app
const app = new Koa ( ) ;
// define keys used for signing cookies
app . keys = [ 'foo' , 'bar' ] ;
// initialize redis store
const redisClient = redis . createClient ( ) ;
redisClient . on ( 'connect' , ( ) => app . emit ( 'log' , 'info' , 'redis connected' ) ) ;
redisClient . on ( 'error' , err => app . emit ( 'error' , err ) ) ;
// define our storage
const redisStore = new RedisStore ( {
client : redisClient
} ) ;
// add sessions to our app
const cookiesKey = 'lad.sid' ;
app . use (
convert (
session ( {
key : cookiesKey ,
store : redisStore
} )
)
) ;
// add support for flash messages (e.g. `req.flash('error', 'Oops!')`)
app . use ( convert ( flash ( ) ) ) ;
// override koa's undocumented error handler
app . context . onerror = errorHandler ( cookiesKey ) ;
// use koa-404-handler
app . use ( koa404Handler ) ;
// set up some routes
const router = new Router ( ) ;
// throw an error anywhere you want!
router . get ( '/404' , ctx => ctx . throw ( 404 ) ) ;
router . get ( '/500' , ctx => ctx . throw ( 500 ) ) ;
// initialize routes on the app
app . use ( router . routes ( ) ) ;
// start the server
app . listen ( 3000 ) ;
console . log ( 'listening on port 3000' ) ; Solicitação de exemplo:
curl -H " Accept: application/json " http://localhost/some-page-does-not-existExemplo de resposta:
{
"statusCode" : 404 ,
"error" : " Not Found " ,
"message" : " Not Found "
} A partir da v3.0.5, você pode impedir que um erro seja traduzido automaticamente definindo a propriedade de erro do no_translate para ter um valor de true :
function middleware ( ctx ) {
const err = Boom . badRequest ( 'Uh oh!' ) ;
err . no_translate = true ; // <----
ctx . throw ( err ) ;
} Se você especificar app.context.api = true ou definir ctx.api = true , e se ocorre uma mensagem de erro de validação de mangusto que possui mais de uma mensagem (por exemplo, vários campos foram inválidos) - então err.message será unido por uma vírgula em vez de <li> .
Portanto, se você deseja que suas mensagens de erro da API retornem listas de erros formatados em HTML para validação de mongonose, defina app.context.api = false , ctx.api = false ou simplesmente não os definir antes de usar esse manipulador de erros.
try {
// trigger manual validation
// (this allows us to have a 400 error code instead of 500)
await company . validate ( ) ;
} catch ( err ) {
ctx . throw ( Boom . badRequest ( err ) ) ;
}Com listas de erros:
{
"statusCode" : 400 ,
"error" : " Bad Request " ,
"message" : " <ul class= " text-left mb-0 " ><li>Path `company_logo` is required.</li><li>Gig description must be 100-300 characters.</li></ul> "
}Sem listas de erros:
{
"statusCode" : 400 ,
"error" : " Bad Request " ,
"message" : " Path `company_logo` is required., Gig description must be 100-300 characters. "
} Por padrão, se ctx.api for verdadeiro, o HTML-T-TEXT será invocado com o err.message , convertendo assim toda a marcação HTML em formato de texto.
Você também pode especificar um Uri base na variável de ambiente para renderizar como process.env.ERROR_HANDLER_BASE_URL , por exemplo ERROR_HANDLER_BASE_URL=https://example.com [1] omit slash de trilha) e qualquer links html como <a href="/foo/bar/baz">Click here</a> [Click here][1] Link anexado a https://example.com/foo/bar/baz .
Mit © Nick Baugh
