servermessenger-nd v0.4.7

ServerMessenger-ND

Módulo para tener organizado todos los mensajes de respuesta del servidor y responder siempre de manera similar.

ServerMessenger(Error, Success)

Va a contener todos los mensajes del servidor. Recibe dos objetos: uno para los errores; el otro para los mensajes de éxito.

• sendMessageOk(string)
• sendMessageError(string) || sendMessageError( "" , error, " ubicación del error")

​

para utilizar sendMessageError:

try {
  sendMessageError(string)
} catch (error) {
  sendMessageError('', error, ' ubicación del error')
}

ResponseND(string)

Va a responder al cliente. Recibe un string, el cual va será utilizado para responder cuando ocurra un error inesperado.

• success({ res , clientMsg, data })
• error({res , err})

Formato de respuesta

success

{
  error: '',
  body: {
    message: 'Mensaje',
    data: '' || data
  }
}

error

{
  error: "Mensaje de error"
  body: '',
}

config.js

//@ts-check
import { ServerMessenger, ResponseND } from 'servermessenger-nd'

const errors = {
  sintaxError: { clientMsg: 'Error de sintaxis. Faltan datos', code: 400 },
  notFound: { clientMsg: 'No se encontro lo que estás buscando.', code: 404 },
  notFoundMsg: { clientMsg: 'No se encontraron mensajes', code: 404 },
}

const success = {
  notFoundMsg: { clientMsg: 'No hay mensajes para mostrar.', code: 200 },
  addOk: { clientMsg: 'Se agrego correctamente el mensaje', code: 202 },
  success: { clientMsg: 'Todo salio bien.', code: 200 },
  updateOk: { clientMsg: 'Se modificó correctamente el mensaje', code: 202 },
}

const customMSG = 'Error inesperado. Pronto estaremos trabajando para resolverlo.'

const SM = new ServerMessenger(errors, success)
const Resp = new ResponseND(customMSG)

export { SM, Resp }

server.js

//@ts-check
import express from 'express'
import { SM, Resp } from './config.js'

const app = express()
app.use(express.json())
app.use(express.urlencoded({ extended: false }))

app.get('/', (req, res) => {
  Resp.success({
    res,
    clientMsg: SM.sendMessageOk('success'),
    data: '',
  })
})

app.listen(5000, () => console.log('Server ON'))

app.get('/info', (req, res) => {
  const info = {
    nombre: 'jose',
    email: 'herrera00jl@gmail.com',
  }
  Resp.success({
    res,
    clientMsg: SM.sendMessageOk('success'),
    data: info,
  })
})

app.post('/', (req, res) => {
  try {
    const { nombre, email } = req.body
    if (!nombre || !email) {
      throw SM.sendMessageError('sintaxError')
    }

    if (nombre === 'Error') {
      throw new Error('xxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
    }

    Resp.success({
      res,
      clientMsg: SM.sendMessageOk('addOk'),
      data: { nombre, email },
    })
  } catch (error) {
    Resp.error({
      res,
      err: error,
    })
  }
})

Error esperado

Sin errores

Error inesperado

RASTREAR EL ERROR

• Es posible saber el origen de un error.

El controlador tiene que agregar un usuario. Le pasamos la info y esperamos la respuesta.

app.post('/add', (req, res) => {
  try {
    const info = {
      nombre: req.body.nombre,
      email: req.body.email,
    }

    const resp = controller.addUser(info)

    Resp.success({
      res,
      clientMsg: SM.sendMessageOk('addOk'),
      data: resp,
    })
  } catch (error) {
    if (error.serverMsg) {
      console.log(`${error.serverMsg}  -- ${error.from}`)
    }

    Resp.error({
      res,
      err: error,
    })
  }
})

controller.js

import { SM } from './config.js'

const addUser = (info) => {
  try {
    const { nombre, email } = info

    if (!nombre || !email) {
      throw SM.sendMessageError('sintaxError')
    }

    if (nombre === 'Error') {
      throw new Error('Error inesperado')
    }

    const data = {
      nombre,
      email,
    }

    return data
  } catch (error) {
    throw SM.sendMessageError('', error, '[ POST - addUser ]')
  }
}

const controller = {
  addUser,
}

export { controller }

Cuando ocurre un error desconocido, este no tendrá la propiedad "clientMsg" , por lo tanto el cliente verá

el mensaje que le pusimos cuando configuramos ResponseND.

const customMSG = 'Error inesperado. Pronto estaremos trabajando para resolverlo.'

Al lanzar el error con este formato...

throw SM.sendMessageError('', error, '[ POST - addUser ]')

el método que captura esa excepcion , recibirá el error con el siguiente formato.

{ from: '[ POST - addUser ]', serverMsg: 'Error inesperado' }

En vez de utilizar un console.log se puede utilizar algun logger para guardar en un archivo cuando pase algo inesperado.

if (error.serverMsg) {
  console.log(`${error.serverMsg}  -- ${error.from}`)
}