126 lines
3.5 KiB
JavaScript
126 lines
3.5 KiB
JavaScript
import { printBuffer } from './core';
|
|
import { timer } from './helpers';
|
|
import defaults from './defaults';
|
|
|
|
/**
|
|
* Creates logger with following options
|
|
*
|
|
* @namespace
|
|
* @param {object} options - options for logger
|
|
* @param {string | function | object} options.level - console[level]
|
|
* @param {boolean} options.duration - print duration of each action?
|
|
* @param {boolean} options.timestamp - print timestamp with each action?
|
|
* @param {object} options.colors - custom colors
|
|
* @param {object} options.logger - implementation of the `console` API
|
|
* @param {boolean} options.logErrors - should errors in action execution be caught, logged, and re-thrown?
|
|
* @param {boolean} options.collapsed - is group collapsed?
|
|
* @param {boolean} options.predicate - condition which resolves logger behavior
|
|
* @param {function} options.stateTransformer - transform state before print
|
|
* @param {function} options.actionTransformer - transform action before print
|
|
* @param {function} options.errorTransformer - transform error before print
|
|
*
|
|
* @returns {function} logger middleware
|
|
*/
|
|
function createLogger(options = {}) {
|
|
const loggerOptions = {
|
|
...defaults,
|
|
...options,
|
|
};
|
|
|
|
const {
|
|
logger,
|
|
transformer,
|
|
stateTransformer,
|
|
errorTransformer,
|
|
predicate,
|
|
logErrors,
|
|
diffPredicate,
|
|
} = loggerOptions;
|
|
|
|
// Return if 'console' object is not defined
|
|
if (typeof logger === `undefined`) {
|
|
return () => next => action => next(action);
|
|
}
|
|
|
|
if (transformer) {
|
|
console.error(`Option 'transformer' is deprecated, use 'stateTransformer' instead!`); // eslint-disable-line no-console
|
|
}
|
|
|
|
// Detect if 'createLogger' was passed directly to 'applyMiddleware'.
|
|
if (options.getState && options.dispatch) {
|
|
// eslint-disable-next-line no-console
|
|
console.error(`[redux-logger] redux-logger not installed. Make sure to pass logger instance as middleware:
|
|
|
|
// Logger with default options
|
|
import { logger } from 'redux-logger'
|
|
const store = createStore(
|
|
reducer,
|
|
applyMiddleware(logger)
|
|
)
|
|
|
|
|
|
// Or you can create your own logger with custom options http://bit.ly/redux-logger-options
|
|
import createLogger from 'redux-logger'
|
|
|
|
const logger = createLogger({
|
|
// ...options
|
|
});
|
|
|
|
const store = createStore(
|
|
reducer,
|
|
applyMiddleware(logger)
|
|
)
|
|
`);
|
|
|
|
return () => next => action => next(action);
|
|
}
|
|
|
|
const logBuffer = [];
|
|
|
|
return ({ getState }) => (next) => (action) => {
|
|
// Exit early if predicate function returns 'false'
|
|
if (typeof predicate === `function` && !predicate(getState, action)) {
|
|
return next(action);
|
|
}
|
|
|
|
const logEntry = {};
|
|
logBuffer.push(logEntry);
|
|
|
|
logEntry.started = timer.now();
|
|
logEntry.startedTime = new Date();
|
|
logEntry.prevState = stateTransformer(getState());
|
|
logEntry.action = action;
|
|
|
|
let returnedValue;
|
|
if (logErrors) {
|
|
try {
|
|
returnedValue = next(action);
|
|
} catch (e) {
|
|
logEntry.error = errorTransformer(e);
|
|
}
|
|
} else {
|
|
returnedValue = next(action);
|
|
}
|
|
|
|
logEntry.took = timer.now() - logEntry.started;
|
|
logEntry.nextState = stateTransformer(getState());
|
|
|
|
const diff = loggerOptions.diff && typeof diffPredicate === `function` ? diffPredicate(getState, action) : loggerOptions.diff;
|
|
|
|
printBuffer(logBuffer, { ...loggerOptions, diff });
|
|
logBuffer.length = 0;
|
|
|
|
if (logEntry.error) throw logEntry.error;
|
|
return returnedValue;
|
|
};
|
|
}
|
|
|
|
const defaultLogger = createLogger();
|
|
|
|
export {
|
|
defaults,
|
|
defaultLogger as logger,
|
|
};
|
|
|
|
export default createLogger;
|