Skip to content

chore: add option to disable diffing #208

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jun 21, 2020
Merged

chore: add option to disable diffing #208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33cde68
chore: add option to disable diffing
smeijer Jun 17, 2020
0702d99
Merge branch 'develop' into feature/add-diff-toggle
smeijer Jun 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
},
"scripts": {
"start": "run-s start:client",
"start:client": "node ./scripts/build-client",
"start:devtools": "node ./scripts/build-devtools",
"start:client": "cross-env NODE_ENV=development node ./scripts/build-client",
"start:devtools": "cross-env NODE_ENV=development node ./scripts/build-devtools",
"build": "run-s clean build:*",
"build:client": "cross-env NODE_ENV=production node ./scripts/build-client",
"build:server": "cross-env NODE_ENV=production node ./scripts/build-lambda",
Expand Down
69 changes: 45 additions & 24 deletions src/lib/logger.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@ const styles = {

export const pad = (num, maxLength) => `${num}`.padStart(0, maxLength);

function omit(keys, object) {
return Object.entries(object).reduce((acc, [key, value]) => {
acc[key] = keys.includes(key) ? '_ignored_' : value;
return acc;
}, {});
}

function formatTime(time) {
return `${pad(time.getHours(), 2)}:${pad(time.getMinutes(), 2)}:${pad(
time.getSeconds(),
Expand Down Expand Up @@ -60,10 +67,16 @@ function renderDiff(diff) {
}
}

// debug can be `false`, `true` or `diff`. On production, logging is disabled
// when debug is `undefined` and can be enabled by setting it to either `true`
// or `diff`. On develop, it's enabled when `undefined`, and can be disabled
// by setting it to `false`.
const debug = localStorage.getItem('debug');
const logLevel = debug === 'false' ? false : debug === 'true' ? true : debug;
const isLoggingEnabled =
process.env.NODE_ENV === 'development'
? localStorage.getItem('debug') !== false
: localStorage.getItem('debug') === true;
process.env.NODE_ENV === 'development' ? logLevel !== false : !!logLevel;
const isDiffEnabled = logLevel === 'diff';
const diffIgnoreKeys = ['markupEditor', 'queryEditor', 'sandbox'];

export function withLogging(reducerFn) {
if (!isLoggingEnabled) {
Expand All @@ -79,7 +92,6 @@ export function withLogging(reducerFn) {
const newState = reducerFn(prevState, action);

const took = timer.now() - started;
const diff = differ(prevState, newState);

const header = [
[
Expand All @@ -94,7 +106,7 @@ export function withLogging(reducerFn) {
];

if (supportsGroups) {
console.group(...header);
console.groupCollapsed(...header);
} else {
console.log(...header);
}
Expand All @@ -103,29 +115,38 @@ export function withLogging(reducerFn) {
console.log('%c action %O', styles.action, action);
console.log('%c new state %O', styles.nextState, newState);

if (!diff) {
console.log(
'%c diff %cno state change!',
styles.prevState,
styles.error,
);
if (!isDiffEnabled) {
console.log('%c diff %c _disabled_', styles.prevState, styles.note);
} else {
if (supportsGroups) {
console.groupCollapsed(' diff');
} else {
console.log('diff');
}
const diff = differ(
omit(diffIgnoreKeys, prevState),
omit(diffIgnoreKeys, newState),
);

diff.forEach((elem) => {
if (!diff) {
console.log(
`%c ${styles.diff[elem.kind].text}`,
styles.diff[elem.kind].style,
...renderDiff(elem),
'%c diff %cno state change!',
styles.prevState,
styles.error,
);
});

if (supportsGroups) {
console.groupEnd();
} else {
if (supportsGroups) {
console.groupCollapsed(' diff');
} else {
console.log('diff');
}

diff.forEach((elem) => {
console.log(
`%c ${styles.diff[elem.kind].text}`,
styles.diff[elem.kind].style,
...renderDiff(elem),
);
});

if (supportsGroups) {
console.groupEnd();
}
}
}

Expand Down