Refactor opts.level

Author: ehmicky

docs/options.md

@@ -40,36 +40,32 @@ not).
 
 Which log level to use. It should be an object whose:
 
-- keys are the event names among `"default"`,
-  [`"uncaughtException"`](https://nodejs.org/api/process.html#process_event_uncaughtexception),
-  [`"warning"`](https://nodejs.org/api/process.html#process_event_warning),
-  [`"unhandledRejection"`](https://nodejs.org/api/process.html#process_event_unhandledrejection),
-  [`"rejectionHandled"`](https://nodejs.org/api/process.html#process_event_rejectionhandled)
-  or
-  [`"multipleResolves"`](https://nodejs.org/api/process.html#process_event_multipleresolves).
-- values are the log level which can be:
-  - a string among `"debug"`, `"info"`, `"warn"`, `"error"` or `"silent"`.
-  - `undefined` to use the default value.
-  - a function using [`info` as argument](#event-information) and
-    returning a string or `undefined` (as above).
+- keys are the event names
+  ([`uncaughtException`](https://nodejs.org/api/process.html#process_event_uncaughtexception),
+  [`warning`](https://nodejs.org/api/process.html#process_event_warning),
+  [`unhandledRejection`](https://nodejs.org/api/process.html#process_event_unhandledrejection),
+  [`rejectionHandled`](https://nodejs.org/api/process.html#process_event_rejectionhandled),
+  [`multipleResolves`](https://nodejs.org/api/process.html#process_event_multipleresolves)
+  or `default`)
+- values are the log level (`"debug"`, `"info"`, `"warn"`, `"error"`,
+  `"silent"` or `"default"`). It can also be a function using
+  [`info` as argument](#event-information) and returning one of those log levels.
 
 Default: `{ warning: 'warn', multipleResolves: 'info', default: 'error' }`.
 
 ```js
+// Use `debug` log level for `multipleResolves` instead of `info`
 logProcessErrors({
-  // Use `debug` log level for `multipleResolves` instead of `info`
   level: { multipleResolves: 'debug' },
 })
 ```
 
 ```js
+// Skip some logs based on a condition
 logProcessErrors({
-  // Skip some logs based on a condition
   level: {
     default() {
-      if (shouldSkip()) {
-        return 'silent'
-      }
+      return shouldSkip() ? 'silent' : 'default'
     },
   },
 })

src/constants.yml

@@ -9,12 +9,8 @@ LEVELS:
   - info
   - warn
   - error
-ALL_LEVELS:
-  - debug
-  - info
-  - warn
-  - error
   - silent
+  - default
 DEFAULT_LEVEL:
   default: error
   uncaughtException: error

src/level.js

@@ -5,31 +5,27 @@ const { emitWarning } = require('process')
 const { multipleValidOptions } = require('jest-validate')
 
 const { result, mapValues, pickBy } = require('./utils')
-const { DEFAULT_LEVEL, ALL_LEVELS } = require('./constants')
+const { DEFAULT_LEVEL, LEVELS } = require('./constants')
 
 // Retrieve event's log level
 const getLevel = function({ opts, info, info: { eventName } }) {
   const level = result(opts.level[eventName], info)
 
-  if (ALL_LEVELS.includes(level)) {
-    return level
+  if (level === 'default') {
+    return DEFAULT_LEVEL[eventName]
   }
 
-  validateLevel({ level, eventName })
-
-  return DEFAULT_LEVEL[eventName]
-}
-
-const validateLevel = function({ level, eventName }) {
-  if (level === undefined) {
-    return
+  if (LEVELS.includes(level)) {
+    return level
   }
 
   emitWarning(
-    `Invalid option 'level.${eventName}' returning '${level}': function must return undefined or one of ${ALL_LEVELS.join(
+    `Invalid option 'level.${eventName}' returning '${level}': function must return one of ${LEVELS.join(
       ', ',
     )}`,
   )
+
+  return DEFAULT_LEVEL[eventName]
 }
 
 // Apply `opts.level.default` and default values to `opts.level`
@@ -43,7 +39,7 @@ const applyDefaultLevels = function({
   }
 
   const defaultLevels = mapValues(DEFAULT_LEVEL, () => defaultLevel)
-  return { ...DEFAULT_LEVEL, ...defaultLevels, ...levelA }
+  return { ...defaultLevels, ...levelA }
 }
 
 // Use during options validation

src/validate.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { EVENTS, ALL_LEVELS } = require('./constants')
+const { EVENTS, LEVELS } = require('./constants')
 
 // Validation beyond what `jest-validate` can do
 const validateOptions = function({ exitOn, level = {} }) {
@@ -18,17 +18,15 @@ const validateLevel = function([eventName, level]) {
   }
 
   throw new Error(
-    `Invalid option 'level.${eventName}' '${level}': must be a function, undefined or one of ${ALL_LEVELS.join(
+    `Invalid option 'level.${eventName}' '${level}': must be a function or one of ${LEVELS.join(
       ', ',
     )}`,
   )
 }
 
 const isValidLevel = function({ level }) {
   return (
-    ALL_LEVELS.includes(level) ||
-    level === undefined ||
-    typeof level === 'function'
+    LEVELS.includes(level) || level === undefined || typeof level === 'function'
   )
 }
 

test/helpers/init.js

@@ -59,7 +59,7 @@ const getLevel = function({ level, eventName }) {
     return level
   }
 
-  const levelA = level === undefined ? { default: undefined } : level
+  const levelA = level === undefined ? { default: 'default' } : level
 
   return mapValues(levelA, levelB => onlyEvent.bind(null, levelB, eventName))
 }

test/helpers/repeat.js

@@ -17,9 +17,15 @@ const getEvent = function([eventName, emitEvent]) {
   return { eventName, emitEvent, name: eventName, defaultLevel }
 }
 
+const isNormalLevel = function(level) {
+  return level !== 'silent' && level !== 'default'
+}
+
+const NORMAL_LEVELS = LEVELS.filter(isNormalLevel)
+
 const repeatEvents = repeat.bind(null, getEvents())
-const repeatLevels = repeat.bind(null, LEVELS)
-const repeatEventsLevels = repeat.bind(null, getEvents(), LEVELS)
+const repeatLevels = repeat.bind(null, NORMAL_LEVELS)
+const repeatEventsLevels = repeat.bind(null, getEvents(), NORMAL_LEVELS)
 
 module.exports = {
   repeatEvents,

test/level.js

@@ -17,7 +17,8 @@ repeatEvents((prefix, { eventName, emitEvent, defaultLevel }) => {
   const OPTIONS = [
     {},
     { level: { default: undefined }, exitOn: [] },
-    { level: { default: () => undefined } },
+    { level: { default: 'default' }, exitOn: [] },
+    { level: { default: () => 'default' } },
   ]
   OPTIONS.forEach(options => {
     test(`${prefix} ${JSON.stringify(

test/snapshots/level.js.md

@@ -8,33 +8,33 @@ Generated by [AVA](https://ava.li).
 
 > Snapshot 1
 
-    `[]  warning  Error: Invalid option 'level.multipleResolves' returning 'invalid': function must return undefined or one of debug, info, warn, error, silent␊
+    `[]  warning  Error: Invalid option 'level.multipleResolves' returning 'invalid': function must return one of debug, info, warn, error, silent, default␊
             at STACK TRACE`
 
 ## [rejectionHandled] should emit a warning when opts.level() uses an invalid level
 
 > Snapshot 1
 
-    `[]  warning  Error: Invalid option 'level.rejectionHandled' returning 'invalid': function must return undefined or one of debug, info, warn, error, silent␊
+    `[]  warning  Error: Invalid option 'level.rejectionHandled' returning 'invalid': function must return one of debug, info, warn, error, silent, default␊
             at STACK TRACE`
 
 ## [uncaughtException] should emit a warning when opts.level() uses an invalid level
 
 > Snapshot 1
 
-    `[]  warning  Error: Invalid option 'level.uncaughtException' returning 'invalid': function must return undefined or one of debug, info, warn, error, silent␊
+    `[]  warning  Error: Invalid option 'level.uncaughtException' returning 'invalid': function must return one of debug, info, warn, error, silent, default␊
             at STACK TRACE`
 
 ## [unhandledRejection] should emit a warning when opts.level() uses an invalid level
 
 > Snapshot 1
 
-    `[]  warning  Error: Invalid option 'level.unhandledRejection' returning 'invalid': function must return undefined or one of debug, info, warn, error, silent␊
+    `[]  warning  Error: Invalid option 'level.unhandledRejection' returning 'invalid': function must return one of debug, info, warn, error, silent, default␊
             at STACK TRACE`
 
 ## [warning] should emit a warning when opts.level() uses an invalid level
 
 > Snapshot 1
 
-    `[]  warning  Error: Invalid option 'level.warning' returning 'invalid': function must return undefined or one of debug, info, warn, error, silent␊
+    `[]  warning  Error: Invalid option 'level.warning' returning 'invalid': function must return one of debug, info, warn, error, silent, default␊
             at STACK TRACE`

test/snapshots/level.js.snap

@@ -144,7 +144,7 @@ Generated by [AVA](https://ava.li).
 
 > Snapshot 1
 
-    'Invalid option \'level.warning\' \'invalid\': must be a function, undefined or one of debug, info, warn, error, silent'
+    'Invalid option \'level.warning\' \'invalid\': must be a function or one of debug, info, warn, error, silent, default'
 
 ## {"name":"level","value":{"warning":true}} should validate options