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

fix: Actually use and persist default settings #553

Merged
merged 5 commits into from
Nov 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 19 additions & 11 deletions src/util/settings_persister.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ import generateId from '../lib/id_generator';
export const isLocalStorageAvailable = () => {
try {
localStorage.setItem('test', 'test');
return localStorage.getItem('test') === 'test';
const localStorageRes = localStorage.getItem('test') === 'test';
localStorage.removeItem('test');
return localStorageRes && localStorage;
} catch (e) {
return false;
}
Expand Down Expand Up @@ -139,6 +141,7 @@ export const persistableFields = [
category: 'base',
name: 'colorScheme',
type: 'string',
default: 'Light',
shouldStoreInConfig: true,
},
{
Expand All @@ -155,27 +158,29 @@ export const readOpennessState = () => {
return !!opennessStateJSONString ? JSON.parse(opennessStateJSONString) : null;
};

const getFieldsToPersist = (state, fields) =>
fields
const getFieldsToPersist = (state, fields) => {
return fields
.filter((field) => !field.depreacted)
.filter((field) => field.category === 'org')
.map((field) => field.name)
.map((field) => [field, state.org.present.get(field)])
.concat(
persistableFields
.filter((field) => field.category !== 'org')
.map((field) =>
field.type === 'json'
.map((field) => {
return field.type === 'json'
? [
field.name,
JSON.stringify(state[field.category].get(field.name) || field.default || {}),
]
: [field.name, state[field.category].get(field.name)]
)
: [field.name, state[field.category].get(field.name) || field.default];
})
);
};

const getConfigFileContents = (fieldsToPersist) =>
JSON.stringify(_.fromPairs(fieldsToPersist), null, 2);
const getConfigFileContents = (fieldsToPersist) => {
return JSON.stringify(_.fromPairs(fieldsToPersist), null, 2);
};

export const applyCategorySettingsFromConfig = (state, config, category) => {
persistableFields
Expand Down Expand Up @@ -258,7 +263,8 @@ export const readInitialState = () => {
initialState.org.present = initialState.org.present.set('opennessState', fromJS(opennessState));
}

// Cache the config file contents locally so we don't overwrite on initial page load.
// Cache the config file contents locally so we don't overwrite on
// initial page load.
window.previousSettingsFileContents = getConfigFileContents(
getFieldsToPersist(initialState, persistableFields)
);
Expand Down Expand Up @@ -310,7 +316,9 @@ export const subscribeToChanges = (store) => {

const fieldsToPersist = getFieldsToPersist(state, persistableFields);

fieldsToPersist.forEach(([name, value]) => localStorage.setItem(name, value));
fieldsToPersist.forEach(([name, value]) => {
if (name && value) localStorage.setItem(name, value);
});

if (state.base.get('shouldStoreSettingsInSyncBackend')) {
const settingsFileContents = getConfigFileContents(fieldsToPersist);
Expand Down
24 changes: 24 additions & 0 deletions src/util/settings_persister.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import Store from '../store';
import { readInitialState, subscribeToChanges } from './settings_persister';

describe('Settings persister', () => {
let store;
beforeEach(() => {
const initialState = readInitialState();
store = Store(initialState);
subscribeToChanges(store)();
});

afterEach(() => {
localStorage.clear();
});

test('Do not persist nonsense like like "false" for settings without default', () => {
expect(localStorage.getItem('showClockDisplay')).not.toBe('false');
expect(localStorage.getItem('showClockDisplay')).toBe(null);
});

test('Does persist given default values, for example colorScheme', () => {
expect(localStorage.getItem('colorScheme')).toBe('Light');
});
});