npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@moblybr/middy-defaults

v1.3.3

Published

Esse é um "wrapper" que ajuda na configuração de middlewares padrões que a lambda usará.

Downloads

224

Readme

Pacote middyDefaults

Esse é um wrapper que ajudará na configuração de packages padrões que a lambda usará.

Instalação

Para Instalar:

    npm i @moblybr/middy-defaults

Uso

Para utilizar o middyDefaults em sua configuração padrão basta importar o pacote.

import { middyDefaults } from '@moblybr/middy-defaults' //es6 

//ou

const { middyDefaults } = require('@moblybr/middy-defaults') //commonJs

Desta forma ele ira montar um middy ja abstraido com alguns middlewares, são eles.

erroHandler 
obfuscaterMiddleware
doNotWaitForEmptyEventLoop

Por padrão o middlewar errorHandler ja vem pre configurado com um Log.error do erro e epsagon.setError(err) em casos de erro 500 e não esteja rodando offline, como é o caso no serverless offline, e com a variavel de ambiente NODE.ENV com valor diferente de 'test'.

Para mais informções de configurações personalizadas sobre errorHandler ou sobre obfuscaterMiddleware acesse a documentação dos mesmos abaixo.

Sera mostrado como realizar configurações personalizadas um pouco mais adiante.

errorHandler

obfuscaterMiddleware

Lambdas http

Para lamdas http existe o httpMiddyDefaults, um middy com alguns middlewares ja configurados para funções http

Uso

import { httpMiddyDefaults } from '@moblybr/middy-defaults' //es6 

//ou

const { httpMiddyDefaults } = require('@moblybr/middy-defaults') //commonJs

const handler = httpMiddyDefaults(async (event, context) => {
    //
})

O httpMiddyDefaults montará um middy ja com os seguintes middlewares.

errorHandler
obfuscaterMiddleware
doNotWaitForEmptyEventLoop
warmup
cors
httpEventNormalizer
httpJsonBodyParser

Para mais informções de funcionalidades e configurações sobre estes mesmos middlewares consulte a documentação abaixo.

errorHandler

obfuscaterMiddleware

GitHub-middyjs/middy

Configurações

Alguns dos middlewares abstraidos em nosso middyDefaults e httpMiddyDefaults aceitam configurações, e para configuralos basta passar um objeto de configurações como segundo paramentro da função.

Uso

import { middyDefaults } from '@moblybr/middy-defaults' //es6 

//ou

const { middyDefaults } = require('@moblybr/middy-defaults') //commonJs

const config = {
  errorHandler: { customLogger }, // configuração errorHandler opcional, padrão console.error e setError no epsagon
  captureCorrelationIds: {
    sampleDebugLogRate: 0.01
  }, // configuração captureCorrelationIds opcional, padrão 1%
  sampleLogging: {
    sampleRate: 0.01
  }, // configuração sampleLogging opcional, padrão 1% de log
  obfuscatedLogging: {}, // configuração obfuscatedLogging requirida do contrario não obfucara nenhum dado
  doNotWaitForEmptyEventLoop: {}, // configuração doNotWaitForEmptyEventLoop opcional
  warmup: {}, // configuração warmup opcional
  cors: {} // configuração do cors opcional 
  middlewareOrder: [] // configuração opcional para inserir middleware em posição customizada
}

const handler = middyDefaults(async (event, context) => {
    //
}, config)
  • permite sobescrever via variavel de ambiente o default de 1% de sample rate via a variavel SAMPLE_DEBUG_LOG_RATE, para habilitar logs de debug de 5% é só colocar o valor da variável para 0.05

  • O sample logging é vinculado a variável LOG_LEVEL que pode ser DEBUG, WARN e ERROR, o padrão é DEBUG então se não colocar a variável sempre irá logar tudo

  • middlewareOrder é um array de objetos com 3 atributos:

    • position: posição numérica na ordem de middlewares
    • fn: função do middleware a ser executada
    • params: parametros do middleware a ser executado Exemplo: { position: 0, fn: warmup, params: config.warmup } ATENÇÃO: a ordem de middlewares é uma configuração avançada e pode afetar o comportamento do serviço

Importante

Para que sample logger funcione é necessario que seja declarada uma variável de ambiente [LOG_LEVEL = WARN] para que ele logue corretamente, do contrário ele sempre logara por padrão com Log.debug()

É recomendado que para produção as configurações de sampleLogging e obfuscator sejam passadas corretamente. Configurações do obfuscator na seguinte url: https://github.com/getndazn/dazn-lambda-powertools/tree/master/packages/lambda-powertools-middleware-obfuscater