@splitsoftware/splitio-commons
Version:
Split JavaScript SDK common components
92 lines (91 loc) • 4.29 kB
JavaScript
import { isFiniteNumber, isNaNNumber } from '../../utils/lang';
import { getStorageHash } from '../KeyBuilder';
import { LOG_PREFIX } from './constants';
var DEFAULT_CACHE_EXPIRATION_IN_DAYS = 10;
var MILLIS_IN_A_DAY = 86400000;
/**
* Validates if cache should be cleared and sets the cache `hash` if needed.
*
* @returns `true` if cache should be cleared, `false` otherwise
*/
function validateExpiration(options, storage, settings, keys, currentTimestamp, isThereCache) {
var log = settings.log, initialRolloutPlan = settings.initialRolloutPlan;
// Check expiration
var lastUpdatedTimestamp = parseInt(storage.getItem(keys.buildLastUpdatedKey()), 10);
if (!isNaNNumber(lastUpdatedTimestamp)) {
var cacheExpirationInDays = isFiniteNumber(options.expirationDays) && options.expirationDays >= 1 ? options.expirationDays : DEFAULT_CACHE_EXPIRATION_IN_DAYS;
var expirationTimestamp = currentTimestamp - MILLIS_IN_A_DAY * cacheExpirationInDays;
if (lastUpdatedTimestamp < expirationTimestamp) {
log.info(LOG_PREFIX + 'Cache expired more than ' + cacheExpirationInDays + ' days ago. Cleaning up cache');
return true;
}
}
// Check hash
var storageHashKey = keys.buildHashKey();
var storageHash = storage.getItem(storageHashKey);
var currentStorageHash = getStorageHash(settings);
if (storageHash !== currentStorageHash) {
try {
storage.setItem(storageHashKey, currentStorageHash);
}
catch (e) {
log.error(LOG_PREFIX + e);
}
if (isThereCache && !initialRolloutPlan) {
log.info(LOG_PREFIX + 'SDK key, flags filter criteria, or flags spec version has changed. Cleaning up cache');
return true;
}
return false; // No cache to clear
}
// Clear on init
if (options.clearOnInit) {
var lastClearTimestamp = parseInt(storage.getItem(keys.buildLastClear()), 10);
if (isNaNNumber(lastClearTimestamp) || lastClearTimestamp < currentTimestamp - MILLIS_IN_A_DAY) {
log.info(LOG_PREFIX + 'clearOnInit was set and cache was not cleared in the last 24 hours. Cleaning up cache');
return true;
}
}
}
/**
* Clean cache if:
* - it has expired, i.e., its `lastUpdated` timestamp is older than the given `expirationTimestamp`
* - its hash has changed, i.e., the SDK key, flags filter criteria or flags spec version was modified
* - `clearOnInit` was set and cache was not cleared in the last 24 hours
*
* @returns Metadata object with `initialCacheLoad` (true if is fresh install, false if is ready from cache) and `lastUpdateTimestamp` (timestamp of last cache update or undefined)
*/
export function validateCache(options, storage, settings, keys, definitions, rbSegments, segments, largeSegments) {
return Promise.resolve(storage.load && storage.load()).then(function () {
var currentTimestamp = Date.now();
var isThereCache = definitions.getChangeNumber() > -1;
// Get lastUpdateTimestamp from storage
var lastUpdatedTimestampStr = storage.getItem(keys.buildLastUpdatedKey());
var lastUpdatedTimestamp = lastUpdatedTimestampStr ? parseInt(lastUpdatedTimestampStr, 10) : undefined;
var lastUpdateTimestamp = (!isNaNNumber(lastUpdatedTimestamp) && lastUpdatedTimestamp !== undefined) ? lastUpdatedTimestamp : undefined;
if (validateExpiration(options, storage, settings, keys, currentTimestamp, isThereCache)) {
definitions.clear();
rbSegments.clear();
segments.clear();
largeSegments.clear();
// Update last clear timestamp
try {
storage.setItem(keys.buildLastClear(), currentTimestamp + '');
}
catch (e) {
settings.log.error(LOG_PREFIX + e);
}
// Persist clear
if (storage.save)
storage.save();
return {
initialCacheLoad: true,
lastUpdateTimestamp: undefined
};
}
// Check if ready from cache
return {
initialCacheLoad: !isThereCache,
lastUpdateTimestamp: lastUpdateTimestamp
};
});
}