rainbow feat: new `@/logger` interface

feat: new `@/logger` interface

Open estrattonbailey opened this issue 1 year ago • 2 comments

Fixes RNBW-4477

What changed (plus any additional context for devs)

This is the first pass at a new logger, based on our spec.

Features:

unified interface
log levels: debug, info, warn, and error
deeper integration with Sentry, automatic breadcrumbs, exception handling for errors
differentiation between dev/test/prod modes
- no logs in test mode by default
filtered logs, no spamming of console
- only see logs that are relevant to what you're working on
documentation
full test suite

Key notes:

log level defaults to warn in dev (i.e. only warn or error are logged to console), and we should set it to info in prod to capture more breadcrumbs
debug, info, and warn are all capable of being reported to Sentry as breadcrumbs, depending on log level
error is always sent as captureException

FAQ:

So should logger.debug be preferred over console.log?

Pretty much! I think using the logger is like saying "I want other devs to be able to see this too", like a more permanent approach. But I don't think we need to block the usage of console.log during dev. We should probably lint for console though, just to try and avoid some stray console.log(privateKey) ends up in Sentry.

At a glance:

import { logger, RainbowError } from '@/logger'

logger.debug('Entering fetch block') // Enabled with LOG_LEVEL=debug
logger.debug('Computing estimated gas', { duration }, logger.DebugContext.swaps) // Enabled with LOG_LEVEL or LOG_DEBUG=swaps

logger.info('User has X preference enabled') // Enabled with LOG_LEVEL=info
logger.info('Response returned successfully', {
  duration: '123ms' // Additional data
})
logger.info(`User navigated from ${prevRoute} to ${nextRoute}`, {
  type: 'navigation' // Sentry convention
})

logger.warn('Zerion failed, trying N more times before fallback', {
  type: 'http', // Sentry convention
  attempts: 2 // Additional data
})

try {
  // some async code
} catch (e) {
  const error = new RainbowError('Request to Simplehash threw an error. Look for network issues.')
  logger.error(error, {
    tags: { ...tags } // Sentry convention
  })
}