Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow action subscribers to catch rejections. #1740

Merged
merged 9 commits into from
May 8, 2020
Prev Previous commit
Next Next commit
Fixed missing dist folder that breaks test suite.
Joe Plahitko committed Apr 28, 2020
commit 9b2dcce7a6ff4884a0778a9c084204ed91569bf2
15 changes: 15 additions & 0 deletions dist/logger.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
/**
* Types for the logger plugin.
* This file must be put alongside the JavaScript file of the logger.
*/

import { Payload, Plugin } from "../types/index";

export interface LoggerOption<S> {
collapsed?: boolean;
filter?: <P extends Payload>(mutation: P, stateBefore: S, stateAfter: S) => boolean;
transformer?: (state: S) => any;
mutationTransformer?: <P extends Payload>(mutation: P) => any;
}

export default function createLogger<S>(option?: LoggerOption<S>): Plugin<S>;
118 changes: 118 additions & 0 deletions dist/logger.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
(function (global, factory) {
typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
typeof define === 'function' && define.amd ? define(factory) :
(global = global || self, global.createVuexLogger = factory());
}(this, function () { 'use strict';

/**
* Get the first item that pass the test
* by second argument function
*
* @param {Array} list
* @param {Function} f
* @return {*}
*/
function find (list, f) {
return list.filter(f)[0]
}

/**
* Deep copy the given object considering circular structure.
* This function caches all nested objects and its copies.
* If it detects circular structure, use cached copy to avoid infinite loop.
*
* @param {*} obj
* @param {Array<Object>} cache
* @return {*}
*/
function deepCopy (obj, cache) {
if ( cache === void 0 ) cache = [];

// just return if obj is immutable value
if (obj === null || typeof obj !== 'object') {
return obj
}

// if obj is hit, it is in circular structure
var hit = find(cache, function (c) { return c.original === obj; });
if (hit) {
return hit.copy
}

var copy = Array.isArray(obj) ? [] : {};
// put the copy into cache at first
// because we want to refer it in recursive deepCopy
cache.push({
original: obj,
copy: copy
});

Object.keys(obj).forEach(function (key) {
copy[key] = deepCopy(obj[key], cache);
});

return copy
}

// Credits: borrowed code from fcomb/redux-logger

function createLogger (ref) {
if ( ref === void 0 ) ref = {};
var collapsed = ref.collapsed; if ( collapsed === void 0 ) collapsed = true;
var filter = ref.filter; if ( filter === void 0 ) filter = function (mutation, stateBefore, stateAfter) { return true; };
var transformer = ref.transformer; if ( transformer === void 0 ) transformer = function (state) { return state; };
var mutationTransformer = ref.mutationTransformer; if ( mutationTransformer === void 0 ) mutationTransformer = function (mut) { return mut; };
var logger = ref.logger; if ( logger === void 0 ) logger = console;

return function (store) {
var prevState = deepCopy(store.state);

store.subscribe(function (mutation, state) {
if (typeof logger === 'undefined') {
return
}
var nextState = deepCopy(state);

if (filter(mutation, prevState, nextState)) {
var time = new Date();
var formattedTime = " @ " + (pad(time.getHours(), 2)) + ":" + (pad(time.getMinutes(), 2)) + ":" + (pad(time.getSeconds(), 2)) + "." + (pad(time.getMilliseconds(), 3));
var formattedMutation = mutationTransformer(mutation);
var message = "mutation " + (mutation.type) + formattedTime;
var startMessage = collapsed
? logger.groupCollapsed
: logger.group;

// render
try {
startMessage.call(logger, message);
} catch (e) {
console.log(message);
}

logger.log('%c prev state', 'color: #9E9E9E; font-weight: bold', transformer(prevState));
logger.log('%c mutation', 'color: #03A9F4; font-weight: bold', formattedMutation);
logger.log('%c next state', 'color: #4CAF50; font-weight: bold', transformer(nextState));

try {
logger.groupEnd();
} catch (e) {
logger.log('—— log end ——');
}
}

prevState = nextState;
});
}
}

function repeat (str, times) {
return (new Array(times + 1)).join(str)
}

function pad (num, maxLength) {
return repeat('0', maxLength - num.toString().length) + num
}

return createLogger;

}));
Loading