jiti-meet/react/features/base/redux/PersistenceRegistry.js

275 lines
8.9 KiB
JavaScript
Raw Normal View History

2018-01-17 11:19:10 +00:00
// @flow
2018-01-29 22:20:38 +00:00
2020-07-09 07:17:23 +00:00
import { jitsiLocalStorage } from '@jitsi/js-utils';
2018-01-17 11:19:10 +00:00
import md5 from 'js-md5';
import logger from './logger';
2018-01-17 11:19:10 +00:00
declare var __DEV__;
2018-01-17 11:19:10 +00:00
/**
* The name of the {@code localStorage} store where the app persists its values.
2018-01-17 11:19:10 +00:00
*/
const PERSISTED_STATE_NAME = 'jitsi-state';
/**
* Mixed type of the element (subtree) config. If it's a {@code boolean} (and is
* {@code true}), we persist the entire subtree. If it's an {@code Object}, we
* perist a filtered subtree based on the properties of the config object.
*/
declare type ElementConfig = boolean | Object;
2018-01-17 11:19:10 +00:00
/**
* The type of the name-config pairs stored in {@code PersistenceRegistry}.
2018-01-17 11:19:10 +00:00
*/
declare type PersistencyConfigMap = { [name: string]: ElementConfig };
2018-01-17 11:19:10 +00:00
/**
2018-01-29 22:20:38 +00:00
* A registry to allow features to register their redux store subtree to be
* persisted and also handles the persistency calls too.
2018-01-17 11:19:10 +00:00
*/
class PersistenceRegistry {
2018-01-17 11:19:10 +00:00
_checksum: string;
_defaultStates: { [name: string ]: ?Object} = {};
_elements: PersistencyConfigMap = {};
2018-01-17 11:19:10 +00:00
/**
* Returns the persisted redux state. Takes the {@link #_elements} into
* account as we may have persisted something in the past that we don't want
* to retrieve anymore. The next {@link #persistState} will remove such
* values.
2018-01-17 11:19:10 +00:00
*
* @returns {Object}
*/
getPersistedState() {
let filteredPersistedState = {};
// localStorage key per feature
for (const subtreeName of Object.keys(this._elements)) {
// Assumes that the persisted value is stored under the same key as
// the feature's redux state name.
// TODO We'll need to introduce functions later that can control the
// persist key's name. Similar to control serialization and
// deserialization. But that should be a straightforward change.
const persistedSubtree
= this._getPersistedSubtree(
subtreeName,
this._elements[subtreeName],
this._defaultStates[subtreeName]);
if (persistedSubtree !== undefined) {
filteredPersistedState[subtreeName] = persistedSubtree;
2018-01-17 11:19:10 +00:00
}
}
2018-01-17 11:19:10 +00:00
// legacy
if (Object.keys(filteredPersistedState).length === 0) {
let persistedState = jitsiLocalStorage.getItem(PERSISTED_STATE_NAME);
2018-02-12 22:03:05 +00:00
if (persistedState) {
try {
persistedState = JSON.parse(persistedState);
} catch (error) {
logger.error(
'Error parsing persisted state',
persistedState,
error);
persistedState = {};
2018-02-12 22:03:05 +00:00
}
filteredPersistedState = this._getFilteredState(persistedState);
// Store into the new format and delete the old format so that
// it's not used again.
this.persistState(filteredPersistedState);
jitsiLocalStorage.removeItem(PERSISTED_STATE_NAME);
2018-02-12 22:03:05 +00:00
}
2018-01-17 11:19:10 +00:00
}
// Initialize the checksum.
2018-02-12 22:03:05 +00:00
this._checksum = this._calculateChecksum(filteredPersistedState);
if (typeof __DEV__ !== 'undefined' && __DEV__) {
logger.info('redux state rehydrated as', filteredPersistedState);
}
2018-01-17 11:19:10 +00:00
return filteredPersistedState;
}
/**
2018-01-29 22:20:38 +00:00
* Initiates a persist operation, but its execution will depend on the
* current checksums (checks changes).
2018-01-17 11:19:10 +00:00
*
* @param {Object} state - The redux state.
* @returns {void}
*/
persistState(state: Object) {
const filteredState = this._getFilteredState(state);
const checksum = this._calculateChecksum(filteredState);
2018-01-17 11:19:10 +00:00
if (checksum !== this._checksum) {
2018-02-12 22:03:05 +00:00
for (const subtreeName of Object.keys(filteredState)) {
try {
jitsiLocalStorage.setItem(subtreeName, JSON.stringify(filteredState[subtreeName]));
2018-02-12 22:03:05 +00:00
} catch (error) {
logger.error('Error persisting redux subtree', subtreeName, error);
2018-02-12 22:03:05 +00:00
}
2018-01-17 11:19:10 +00:00
}
logger.info(`redux state persisted. ${this._checksum} -> ${checksum}`);
this._checksum = checksum;
2018-01-17 11:19:10 +00:00
}
}
/**
* Registers a new subtree config to be used for the persistency.
*
* @param {string} name - The name of the subtree the config belongs to.
* @param {ElementConfig} config - The config {@code Object}, or
* {@code boolean} if the entire subtree needs to be persisted.
* @param {Object} defaultState - The default state of the component. If
* it's provided, the rehydrated state will be merged with it before it gets
* pushed into Redux.
2018-01-17 11:19:10 +00:00
* @returns {void}
*/
register(
name: string,
config?: ElementConfig = true,
defaultState?: Object) {
2018-01-17 11:19:10 +00:00
this._elements[name] = config;
this._defaultStates[name] = defaultState;
2018-01-17 11:19:10 +00:00
}
/**
* Calculates the checksum of a specific state.
2018-01-17 11:19:10 +00:00
*
* @param {Object} state - The redux state to calculate the checksum of.
2018-01-17 11:19:10 +00:00
* @private
* @returns {string} The checksum of the specified {@code state}.
2018-01-17 11:19:10 +00:00
*/
_calculateChecksum(state: Object) {
2018-01-17 11:19:10 +00:00
try {
return md5.hex(JSON.stringify(state) || '');
2018-01-17 11:19:10 +00:00
} catch (error) {
logger.error('Error calculating checksum for state', error);
2018-01-17 11:19:10 +00:00
return '';
}
}
/**
2018-01-29 22:20:38 +00:00
* Prepares a filtered state from the actual or the persisted redux state,
* based on this registry.
2018-01-17 11:19:10 +00:00
*
* @param {Object} state - The actual or persisted redux state.
* @private
2018-01-17 11:19:10 +00:00
* @returns {Object}
*/
_getFilteredState(state: Object) {
const filteredState = {};
for (const name of Object.keys(this._elements)) {
if (state[name]) {
filteredState[name]
= this._getFilteredSubtree(
state[name],
this._elements[name]);
2018-01-17 11:19:10 +00:00
}
}
return filteredState;
}
/**
2018-01-29 22:20:38 +00:00
* Prepares a filtered subtree based on the config for persisting or for
* retrieval.
2018-01-17 11:19:10 +00:00
*
* @param {Object} subtree - The redux state subtree.
* @param {ElementConfig} subtreeConfig - The related config.
* @private
2018-01-17 11:19:10 +00:00
* @returns {Object}
*/
_getFilteredSubtree(subtree, subtreeConfig) {
let filteredSubtree;
if (typeof subtreeConfig === 'object') {
// Only a filtered subtree gets persisted as specified by
// subtreeConfig.
filteredSubtree = {};
for (const persistedKey of Object.keys(subtree)) {
if (subtreeConfig[persistedKey]) {
filteredSubtree[persistedKey] = subtree[persistedKey];
}
2018-01-17 11:19:10 +00:00
}
} else if (subtreeConfig) {
// Persist the entire subtree.
filteredSubtree = subtree;
2018-01-17 11:19:10 +00:00
}
return filteredSubtree;
}
/**
* Retrieves a persisted subtree from the storage.
*
* @param {string} subtreeName - The name of the subtree.
* @param {Object} subtreeConfig - The config of the subtree from
* {@link #_elements}.
* @param {Object} subtreeDefaults - The defaults of the persisted subtree.
* @private
* @returns {Object}
*/
_getPersistedSubtree(subtreeName, subtreeConfig, subtreeDefaults) {
let persistedSubtree = jitsiLocalStorage.getItem(subtreeName);
if (persistedSubtree) {
try {
persistedSubtree = JSON.parse(persistedSubtree);
const filteredSubtree
= this._getFilteredSubtree(persistedSubtree, subtreeConfig);
if (filteredSubtree !== undefined) {
return this._mergeDefaults(
filteredSubtree, subtreeDefaults);
}
} catch (error) {
logger.error(
'Error parsing persisted subtree',
subtreeName,
persistedSubtree,
error);
}
}
return undefined;
}
/**
* Merges the persisted subtree with its defaults before rehydrating the
* values.
*
* @private
* @param {Object} subtree - The Redux subtree.
* @param {?Object} defaults - The defaults, if any.
* @returns {Object}
*/
_mergeDefaults(subtree: Object, defaults: ?Object) {
if (!defaults) {
return subtree;
}
// If the subtree is an array, we don't need to merge it with the
// defaults, because if it has a value, it will overwrite it, and if
// it's undefined, it won't be even returned, and Redux will natively
// use the default values instead.
if (!Array.isArray(subtree)) {
return {
...defaults,
...subtree
};
}
}
2018-01-17 11:19:10 +00:00
}
export default new PersistenceRegistry();