Felicity plugin

Pré requisito

• Ter o mongoose instalado no package.json (para projetos que conectam no MongoDB)
• Na .env do projeto definir o tipo de driver,
  • noDB - Para projetos que não fazem conexão em Mongo ou MySQL, nesse caso o pacote só expõe um endpoint de /status
  • mongo - Para projetos que fazem conexões com mongo
    • Para essa conexão é necessário ter as seguintes envs

       MONGODB_URI=mongodb://user:password@ip:port/
       MONGODB_NAME=database
      

  • mysql - Para projetos que fazem conexões com o MYSQL
    • Para essa conexão é necessário ter as seguintes envs.

      MYSQL_DATABASE=database
      MYSQL_HOST=localhost
      MYSQL_USERNAME=user
      MYSQL_PASSWORD=password
    

Exemplo para projetos que usam mongo

  ... As demais coisas da .env
  DRIVER_FELICITY=mongo

Exemplo para projetos que usam mysql

  ... As demais coisas da .env
  DRIVER_FELICITY=mysql

Instalação

No seu projeto vá no arquivo onde registra os plugins, geralmente fica dentro do arquivo app.js, e lá importe a felicity, e pronto, felicity estará disponível na rota /status

ex:

Hapi < 18

const felicity = require('./felicity-status/')

const registraPlugins = () => {
  //  Demais processos
   const registers = [hapiAuthJWT, sqWinston.middlewares.hapi16, sqStatus, felicity]

  return server.register(registers)
}

const run = () => {
  return connectDatabase().
  .then(() => registraPlugins(server))
  //  Demais imports
}

run()

Para o Hapi 18+

const felicity = require('./felicity-status/')

const registraPlugins = () => {
  //  Demais processos
   const registers = [hapiAuthJWT, sqWinston.middlewares.hapi16, sqStatus, felicity.hapi18]

  return server.register(registers)
}

const run = () => {
  return connectDatabase().
  .then(() => registraPlugins(server))
  //  Demais imports
}

run()

Como felicity funciona

Felicity é responsável por tratar como a rota /status deve retornar, ela olha para a conexão da aplicação verificando se a mesma esta conectada através da interface do mongoClient, o plugin felicity faz a conexão usando as variaveis MONGODB_URI e MONGODB_NAME pegando todas as collections do banco e a partir dai faz uma querie geral para todas as coleções verificando se TODAS as queries retornam algum resultado, caso de algum erro nesse processo, então gera um erro 500, agora caso dê certo, gera um erro 200