@splitsoftware/splitio-commons 2.5.0 → 2.5.1-rc.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/CHANGES.txt +12 -0
  2. package/README.md +18 -18
  3. package/cjs/logger/messages/info.js +1 -1
  4. package/cjs/sdkFactory/index.js +1 -1
  5. package/cjs/storages/inLocalStorage/MySegmentsCacheInLocal.js +16 -16
  6. package/cjs/storages/inLocalStorage/RBSegmentsCacheInLocal.js +17 -17
  7. package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js +33 -37
  8. package/cjs/storages/inLocalStorage/index.js +31 -13
  9. package/cjs/storages/inLocalStorage/storageAdapter.js +54 -0
  10. package/cjs/storages/inLocalStorage/validateCache.js +28 -23
  11. package/cjs/sync/offline/syncTasks/fromObjectSyncTask.js +2 -3
  12. package/cjs/sync/polling/updaters/mySegmentsUpdater.js +2 -0
  13. package/cjs/sync/polling/updaters/splitChangesUpdater.js +2 -0
  14. package/cjs/sync/syncManagerOnline.js +28 -24
  15. package/cjs/utils/env/isLocalStorageAvailable.js +22 -1
  16. package/cjs/utils/settingsValidation/storage/storageCS.js +1 -1
  17. package/esm/logger/messages/info.js +1 -1
  18. package/esm/sdkFactory/index.js +1 -1
  19. package/esm/storages/inLocalStorage/MySegmentsCacheInLocal.js +16 -16
  20. package/esm/storages/inLocalStorage/RBSegmentsCacheInLocal.js +17 -17
  21. package/esm/storages/inLocalStorage/SplitsCacheInLocal.js +33 -37
  22. package/esm/storages/inLocalStorage/index.js +32 -14
  23. package/esm/storages/inLocalStorage/storageAdapter.js +50 -0
  24. package/esm/storages/inLocalStorage/validateCache.js +28 -23
  25. package/esm/sync/offline/syncTasks/fromObjectSyncTask.js +2 -3
  26. package/esm/sync/polling/updaters/mySegmentsUpdater.js +2 -0
  27. package/esm/sync/polling/updaters/splitChangesUpdater.js +2 -0
  28. package/esm/sync/syncManagerOnline.js +28 -24
  29. package/esm/utils/env/isLocalStorageAvailable.js +19 -0
  30. package/esm/utils/settingsValidation/storage/storageCS.js +1 -1
  31. package/package.json +1 -1
  32. package/src/logger/messages/info.ts +1 -1
  33. package/src/sdkFactory/index.ts +1 -1
  34. package/src/storages/inLocalStorage/MySegmentsCacheInLocal.ts +18 -17
  35. package/src/storages/inLocalStorage/RBSegmentsCacheInLocal.ts +19 -18
  36. package/src/storages/inLocalStorage/SplitsCacheInLocal.ts +34 -37
  37. package/src/storages/inLocalStorage/index.ts +37 -16
  38. package/src/storages/inLocalStorage/storageAdapter.ts +62 -0
  39. package/src/storages/inLocalStorage/validateCache.ts +29 -23
  40. package/src/storages/types.ts +19 -1
  41. package/src/sync/offline/syncTasks/fromObjectSyncTask.ts +1 -2
  42. package/src/sync/polling/updaters/mySegmentsUpdater.ts +2 -0
  43. package/src/sync/polling/updaters/splitChangesUpdater.ts +3 -1
  44. package/src/sync/syncManagerOnline.ts +27 -22
  45. package/src/utils/env/isLocalStorageAvailable.ts +20 -0
  46. package/src/utils/settingsValidation/storage/storageCS.ts +1 -1
  47. package/types/splitio.d.ts +52 -22
@@ -3,7 +3,7 @@ import { ImpressionCountsCacheInMemory } from '../inMemory/ImpressionCountsCache
3
3
  import { EventsCacheInMemory } from '../inMemory/EventsCacheInMemory';
4
4
  import { validatePrefix } from '../KeyBuilder';
5
5
  import { KeyBuilderCS, myLargeSegmentsKeyBuilder } from '../KeyBuilderCS';
6
- import { isLocalStorageAvailable } from '../../utils/env/isLocalStorageAvailable';
6
+ import { isLocalStorageAvailable, isValidStorageWrapper, isWebStorage } from '../../utils/env/isLocalStorageAvailable';
7
7
  import { SplitsCacheInLocal } from './SplitsCacheInLocal';
8
8
  import { RBSegmentsCacheInLocal } from './RBSegmentsCacheInLocal';
9
9
  import { MySegmentsCacheInLocal } from './MySegmentsCacheInLocal';
@@ -14,6 +14,20 @@ import { shouldRecordTelemetry, TelemetryCacheInMemory } from '../inMemory/Telem
14
14
  import { UniqueKeysCacheInMemoryCS } from '../inMemory/UniqueKeysCacheInMemoryCS';
15
15
  import { getMatching } from '../../utils/key';
16
16
  import { validateCache } from './validateCache';
17
+ import { storageAdapter } from './storageAdapter';
18
+ function validateStorage(log, prefix, wrapper) {
19
+ if (wrapper) {
20
+ if (isValidStorageWrapper(wrapper)) {
21
+ return isWebStorage(wrapper) ?
22
+ wrapper : // localStorage and sessionStorage don't need adapter
23
+ storageAdapter(log, prefix, wrapper);
24
+ }
25
+ log.warn(LOG_PREFIX + 'Invalid storage provided. Falling back to LocalStorage API');
26
+ }
27
+ if (isLocalStorageAvailable())
28
+ return localStorage;
29
+ log.warn(LOG_PREFIX + 'LocalStorage API is unavailable. Falling back to default MEMORY storage');
30
+ }
17
31
  /**
18
32
  * InLocal storage factory for standalone client-side SplitFactory
19
33
  */
@@ -21,18 +35,17 @@ export function InLocalStorage(options) {
21
35
  if (options === void 0) { options = {}; }
22
36
  var prefix = validatePrefix(options.prefix);
23
37
  function InLocalStorageCSFactory(params) {
24
- // Fallback to InMemoryStorage if LocalStorage API is not available
25
- if (!isLocalStorageAvailable()) {
26
- params.settings.log.warn(LOG_PREFIX + 'LocalStorage API is unavailable. Falling back to default MEMORY storage');
27
- return InMemoryStorageCSFactory(params);
28
- }
29
38
  var settings = params.settings, _a = params.settings, log = _a.log, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize;
39
+ var storage = validateStorage(log, prefix, options.wrapper);
40
+ if (!storage)
41
+ return InMemoryStorageCSFactory(params);
30
42
  var matchingKey = getMatching(settings.core.key);
31
43
  var keys = new KeyBuilderCS(prefix, matchingKey);
32
- var splits = new SplitsCacheInLocal(settings, keys);
33
- var rbSegments = new RBSegmentsCacheInLocal(settings, keys);
34
- var segments = new MySegmentsCacheInLocal(log, keys);
35
- var largeSegments = new MySegmentsCacheInLocal(log, myLargeSegmentsKeyBuilder(prefix, matchingKey));
44
+ var splits = new SplitsCacheInLocal(settings, keys, storage);
45
+ var rbSegments = new RBSegmentsCacheInLocal(settings, keys, storage);
46
+ var segments = new MySegmentsCacheInLocal(log, keys, storage);
47
+ var largeSegments = new MySegmentsCacheInLocal(log, myLargeSegmentsKeyBuilder(prefix, matchingKey), storage);
48
+ var validateCachePromise;
36
49
  return {
37
50
  splits: splits,
38
51
  rbSegments: rbSegments,
@@ -44,16 +57,21 @@ export function InLocalStorage(options) {
44
57
  telemetry: shouldRecordTelemetry(params) ? new TelemetryCacheInMemory(splits, segments) : undefined,
45
58
  uniqueKeys: new UniqueKeysCacheInMemoryCS(),
46
59
  validateCache: function () {
47
- return validateCache(options, settings, keys, splits, rbSegments, segments, largeSegments);
60
+ return validateCachePromise || (validateCachePromise = validateCache(options, storage, settings, keys, splits, rbSegments, segments, largeSegments));
61
+ },
62
+ save: function () {
63
+ return storage.save && storage.save();
64
+ },
65
+ destroy: function () {
66
+ return storage.whenSaved && storage.whenSaved();
48
67
  },
49
- destroy: function () { },
50
68
  // When using shared instantiation with MEMORY we reuse everything but segments (they are customer per key).
51
69
  shared: function (matchingKey) {
52
70
  return {
53
71
  splits: this.splits,
54
72
  rbSegments: this.rbSegments,
55
- segments: new MySegmentsCacheInLocal(log, new KeyBuilderCS(prefix, matchingKey)),
56
- largeSegments: new MySegmentsCacheInLocal(log, myLargeSegmentsKeyBuilder(prefix, matchingKey)),
73
+ segments: new MySegmentsCacheInLocal(log, new KeyBuilderCS(prefix, matchingKey), storage),
74
+ largeSegments: new MySegmentsCacheInLocal(log, myLargeSegmentsKeyBuilder(prefix, matchingKey), storage),
57
75
  impressions: this.impressions,
58
76
  impressionCounts: this.impressionCounts,
59
77
  events: this.events,
@@ -0,0 +1,50 @@
1
+ import { LOG_PREFIX } from './constants';
2
+ export function storageAdapter(log, prefix, wrapper) {
3
+ var keys = [];
4
+ var cache = {};
5
+ var loadPromise;
6
+ var savePromise = Promise.resolve();
7
+ return {
8
+ load: function () {
9
+ return loadPromise || (loadPromise = Promise.resolve().then(function () {
10
+ return wrapper.getItem(prefix);
11
+ }).then(function (storedCache) {
12
+ cache = JSON.parse(storedCache || '{}');
13
+ keys = Object.keys(cache);
14
+ }).catch(function (e) {
15
+ log.error(LOG_PREFIX + 'Error calling wrapper `getItem` method: ' + e);
16
+ }));
17
+ },
18
+ save: function () {
19
+ return savePromise = savePromise.then(function () {
20
+ return Promise.resolve(wrapper.setItem(prefix, JSON.stringify(cache)));
21
+ }).catch(function (e) {
22
+ log.error(LOG_PREFIX + 'Error calling wrapper `setItem` method: ' + e);
23
+ });
24
+ },
25
+ whenSaved: function () {
26
+ return savePromise;
27
+ },
28
+ get length() {
29
+ return keys.length;
30
+ },
31
+ getItem: function (key) {
32
+ return cache[key] || null;
33
+ },
34
+ key: function (index) {
35
+ return keys[index] || null;
36
+ },
37
+ removeItem: function (key) {
38
+ var index = keys.indexOf(key);
39
+ if (index === -1)
40
+ return;
41
+ keys.splice(index, 1);
42
+ delete cache[key];
43
+ },
44
+ setItem: function (key, value) {
45
+ if (keys.indexOf(key) === -1)
46
+ keys.push(key);
47
+ cache[key] = value;
48
+ }
49
+ };
50
+ }
@@ -8,10 +8,10 @@ var MILLIS_IN_A_DAY = 86400000;
8
8
  *
9
9
  * @returns `true` if cache should be cleared, `false` otherwise
10
10
  */
11
- function validateExpiration(options, settings, keys, currentTimestamp, isThereCache) {
11
+ function validateExpiration(options, storage, settings, keys, currentTimestamp, isThereCache) {
12
12
  var log = settings.log, initialRolloutPlan = settings.initialRolloutPlan;
13
13
  // Check expiration
14
- var lastUpdatedTimestamp = parseInt(localStorage.getItem(keys.buildLastUpdatedKey()), 10);
14
+ var lastUpdatedTimestamp = parseInt(storage.getItem(keys.buildLastUpdatedKey()), 10);
15
15
  if (!isNaNNumber(lastUpdatedTimestamp)) {
16
16
  var cacheExpirationInDays = isFiniteNumber(options.expirationDays) && options.expirationDays >= 1 ? options.expirationDays : DEFAULT_CACHE_EXPIRATION_IN_DAYS;
17
17
  var expirationTimestamp = currentTimestamp - MILLIS_IN_A_DAY * cacheExpirationInDays;
@@ -22,11 +22,11 @@ function validateExpiration(options, settings, keys, currentTimestamp, isThereCa
22
22
  }
23
23
  // Check hash
24
24
  var storageHashKey = keys.buildHashKey();
25
- var storageHash = localStorage.getItem(storageHashKey);
25
+ var storageHash = storage.getItem(storageHashKey);
26
26
  var currentStorageHash = getStorageHash(settings);
27
27
  if (storageHash !== currentStorageHash) {
28
28
  try {
29
- localStorage.setItem(storageHashKey, currentStorageHash);
29
+ storage.setItem(storageHashKey, currentStorageHash);
30
30
  }
31
31
  catch (e) {
32
32
  log.error(LOG_PREFIX + e);
@@ -39,7 +39,7 @@ function validateExpiration(options, settings, keys, currentTimestamp, isThereCa
39
39
  }
40
40
  // Clear on init
41
41
  if (options.clearOnInit) {
42
- var lastClearTimestamp = parseInt(localStorage.getItem(keys.buildLastClear()), 10);
42
+ var lastClearTimestamp = parseInt(storage.getItem(keys.buildLastClear()), 10);
43
43
  if (isNaNNumber(lastClearTimestamp) || lastClearTimestamp < currentTimestamp - MILLIS_IN_A_DAY) {
44
44
  log.info(LOG_PREFIX + 'clearOnInit was set and cache was not cleared in the last 24 hours. Cleaning up cache');
45
45
  return true;
@@ -54,23 +54,28 @@ function validateExpiration(options, settings, keys, currentTimestamp, isThereCa
54
54
  *
55
55
  * @returns `true` if cache is ready to be used, `false` otherwise (cache was cleared or there is no cache)
56
56
  */
57
- export function validateCache(options, settings, keys, splits, rbSegments, segments, largeSegments) {
58
- var currentTimestamp = Date.now();
59
- var isThereCache = splits.getChangeNumber() > -1;
60
- if (validateExpiration(options, settings, keys, currentTimestamp, isThereCache)) {
61
- splits.clear();
62
- rbSegments.clear();
63
- segments.clear();
64
- largeSegments.clear();
65
- // Update last clear timestamp
66
- try {
67
- localStorage.setItem(keys.buildLastClear(), currentTimestamp + '');
68
- }
69
- catch (e) {
70
- settings.log.error(LOG_PREFIX + e);
57
+ export function validateCache(options, storage, settings, keys, splits, rbSegments, segments, largeSegments) {
58
+ return Promise.resolve(storage.load && storage.load()).then(function () {
59
+ var currentTimestamp = Date.now();
60
+ var isThereCache = splits.getChangeNumber() > -1;
61
+ if (validateExpiration(options, storage, settings, keys, currentTimestamp, isThereCache)) {
62
+ splits.clear();
63
+ rbSegments.clear();
64
+ segments.clear();
65
+ largeSegments.clear();
66
+ // Update last clear timestamp
67
+ try {
68
+ storage.setItem(keys.buildLastClear(), currentTimestamp + '');
69
+ }
70
+ catch (e) {
71
+ settings.log.error(LOG_PREFIX + e);
72
+ }
73
+ // Persist clear
74
+ if (storage.save)
75
+ storage.save();
76
+ return false;
71
77
  }
72
- return false;
73
- }
74
- // Check if ready from cache
75
- return isThereCache;
78
+ // Check if ready from cache
79
+ return isThereCache;
80
+ });
76
81
  }
@@ -42,10 +42,9 @@ export function fromObjectUpdaterFactory(splitsParser, storage, readiness, setti
42
42
  readiness.splits.emit(SDK_SPLITS_ARRIVED);
43
43
  if (startingUp) {
44
44
  startingUp = false;
45
- var isCacheLoaded_1 = storage.validateCache ? storage.validateCache() : false;
46
- Promise.resolve().then(function () {
45
+ Promise.resolve(storage.validateCache ? storage.validateCache() : false).then(function (isCacheLoaded) {
47
46
  // Emits SDK_READY_FROM_CACHE
48
- if (isCacheLoaded_1)
47
+ if (isCacheLoaded)
49
48
  readiness.splits.emit(SDK_SPLITS_CACHE_LOADED);
50
49
  // Emits SDK_READY
51
50
  readiness.segments.emit(SDK_SEGMENTS_ARRIVED);
@@ -31,6 +31,8 @@ export function mySegmentsUpdaterFactory(log, mySegmentsFetcher, storage, segmen
31
31
  shouldNotifyUpdate = segments.resetSegments(segmentsData.ms || {});
32
32
  shouldNotifyUpdate = largeSegments.resetSegments(segmentsData.ls || {}) || shouldNotifyUpdate;
33
33
  }
34
+ if (storage.save)
35
+ storage.save();
34
36
  // Notify update if required
35
37
  if (usesSegmentsSync(storage) && (shouldNotifyUpdate || readyOnAlreadyExistentState)) {
36
38
  readyOnAlreadyExistentState = false;
@@ -149,6 +149,8 @@ export function splitChangesUpdaterFactory(log, splitChangesFetcher, storage, sp
149
149
  segments.registerSegments(setToArray(usedSegments))
150
150
  ]).then(function (_a) {
151
151
  var ffChanged = _a[0], rbsChanged = _a[1];
152
+ if (storage.save)
153
+ storage.save();
152
154
  if (splitsEventEmitter) {
153
155
  // To emit SDK_SPLITS_ARRIVED for server-side SDK, we must check that all registered segments have been fetched
154
156
  return Promise.resolve(!splitsEventEmitter.splitsArrived || ((ffChanged || rbsChanged) && (isClientSide || checkAllSegmentsExist(segments))))
@@ -66,35 +66,39 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
66
66
  */
67
67
  start: function () {
68
68
  running = true;
69
- if (startFirstTime) {
70
- var isCacheLoaded = storage.validateCache ? storage.validateCache() : false;
71
- if (isCacheLoaded)
72
- Promise.resolve().then(function () { readiness.splits.emit(SDK_SPLITS_CACHE_LOADED); });
73
- }
74
- // start syncing splits and segments
75
- if (pollingManager) {
76
- // If synchronization is disabled pushManager and pollingManager should not start
77
- if (syncEnabled) {
78
- if (pushManager) {
79
- // Doesn't call `syncAll` when the syncManager is resuming
80
- if (startFirstTime) {
81
- pollingManager.syncAll();
69
+ // @TODO once event, impression and telemetry storages support persistence, call when `validateCache` promise is resolved
70
+ submitterManager.start(!isConsentGranted(settings));
71
+ return Promise.resolve(storage.validateCache ? storage.validateCache() : false).then(function (isCacheLoaded) {
72
+ if (!running)
73
+ return;
74
+ if (startFirstTime) {
75
+ // Emits SDK_READY_FROM_CACHE
76
+ if (isCacheLoaded)
77
+ readiness.splits.emit(SDK_SPLITS_CACHE_LOADED);
78
+ }
79
+ // start syncing splits and segments
80
+ if (pollingManager) {
81
+ // If synchronization is disabled pushManager and pollingManager should not start
82
+ if (syncEnabled) {
83
+ if (pushManager) {
84
+ // Doesn't call `syncAll` when the syncManager is resuming
85
+ if (startFirstTime) {
86
+ pollingManager.syncAll();
87
+ }
88
+ pushManager.start();
89
+ }
90
+ else {
91
+ pollingManager.start();
82
92
  }
83
- pushManager.start();
84
93
  }
85
94
  else {
86
- pollingManager.start();
87
- }
88
- }
89
- else {
90
- if (startFirstTime) {
91
- pollingManager.syncAll();
95
+ if (startFirstTime) {
96
+ pollingManager.syncAll();
97
+ }
92
98
  }
93
99
  }
94
- }
95
- // start periodic data recording (events, impressions, telemetry).
96
- submitterManager.start(!isConsentGranted(settings));
97
- startFirstTime = false;
100
+ startFirstTime = false;
101
+ });
98
102
  },
99
103
  /**
100
104
  * Method used to stop/pause the syncManager.
@@ -10,3 +10,22 @@ export function isLocalStorageAvailable() {
10
10
  return false;
11
11
  }
12
12
  }
13
+ export function isValidStorageWrapper(wrapper) {
14
+ return wrapper !== null &&
15
+ typeof wrapper === 'object' &&
16
+ typeof wrapper.setItem === 'function' &&
17
+ typeof wrapper.getItem === 'function' &&
18
+ typeof wrapper.removeItem === 'function';
19
+ }
20
+ export function isWebStorage(wrapper) {
21
+ if (typeof wrapper.length === 'number') {
22
+ try {
23
+ wrapper.key(0);
24
+ return true;
25
+ }
26
+ catch (e) {
27
+ return false;
28
+ }
29
+ }
30
+ return false;
31
+ }
@@ -3,7 +3,7 @@ import { ERROR_STORAGE_INVALID } from '../../../logger/constants';
3
3
  import { LOCALHOST_MODE, STANDALONE_MODE, STORAGE_PLUGGABLE, STORAGE_LOCALSTORAGE, STORAGE_MEMORY } from '../../../utils/constants';
4
4
  export function __InLocalStorageMockFactory(params) {
5
5
  var result = InMemoryStorageCSFactory(params);
6
- result.validateCache = function () { return true; }; // to emit SDK_READY_FROM_CACHE
6
+ result.validateCache = function () { return Promise.resolve(true); }; // to emit SDK_READY_FROM_CACHE
7
7
  return result;
8
8
  }
9
9
  __InLocalStorageMockFactory.type = STORAGE_MEMORY;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@splitsoftware/splitio-commons",
3
- "version": "2.5.0",
3
+ "version": "2.5.1-rc.1",
4
4
  "description": "Split JavaScript SDK common components",
5
5
  "main": "cjs/index.js",
6
6
  "module": "esm/index.js",
@@ -11,7 +11,7 @@ export const codesInfo: [number, string][] = codesWarn.concat([
11
11
  [c.IMPRESSION, c.LOG_PREFIX_IMPRESSIONS_TRACKER +'Feature flag: %s. Key: %s. Evaluation: %s. Label: %s'],
12
12
  [c.IMPRESSION_QUEUEING, c.LOG_PREFIX_IMPRESSIONS_TRACKER +'Queueing corresponding impression.'],
13
13
  [c.NEW_SHARED_CLIENT, 'New shared client instance created.'],
14
- [c.NEW_FACTORY, 'New Split SDK instance created.'],
14
+ [c.NEW_FACTORY, 'New Split SDK instance created. %s'],
15
15
  [c.EVENTS_TRACKER_SUCCESS, c.LOG_PREFIX_EVENTS_TRACKER + 'Successfully queued %s'],
16
16
  [c.IMPRESSIONS_TRACKER_SUCCESS, c.LOG_PREFIX_IMPRESSIONS_TRACKER + 'Successfully stored %s impression(s).'],
17
17
  [c.USER_CONSENT_UPDATED, 'UserConsent: consent status changed from %s to %s.'],
@@ -113,7 +113,7 @@ export function sdkFactory(params: ISdkFactoryParams): SplitIO.ISDK | SplitIO.IA
113
113
  initCallbacks.length = 0;
114
114
  }
115
115
 
116
- log.info(NEW_FACTORY);
116
+ log.info(NEW_FACTORY, [settings.version]);
117
117
 
118
118
  // @ts-ignore
119
119
  return objectAssign({
@@ -3,16 +3,19 @@ import { isNaNNumber } from '../../utils/lang';
3
3
  import { AbstractMySegmentsCacheSync } from '../AbstractMySegmentsCacheSync';
4
4
  import type { MySegmentsKeyBuilder } from '../KeyBuilderCS';
5
5
  import { LOG_PREFIX, DEFINED } from './constants';
6
+ import { StorageAdapter } from '../types';
6
7
 
7
8
  export class MySegmentsCacheInLocal extends AbstractMySegmentsCacheSync {
8
9
 
9
10
  private readonly keys: MySegmentsKeyBuilder;
10
11
  private readonly log: ILogger;
12
+ private readonly storage: StorageAdapter;
11
13
 
12
- constructor(log: ILogger, keys: MySegmentsKeyBuilder) {
14
+ constructor(log: ILogger, keys: MySegmentsKeyBuilder, storage: StorageAdapter) {
13
15
  super();
14
16
  this.log = log;
15
17
  this.keys = keys;
18
+ this.storage = storage;
16
19
  // There is not need to flush segments cache like splits cache, since resetSegments receives the up-to-date list of active segments
17
20
  }
18
21
 
@@ -20,8 +23,8 @@ export class MySegmentsCacheInLocal extends AbstractMySegmentsCacheSync {
20
23
  const segmentKey = this.keys.buildSegmentNameKey(name);
21
24
 
22
25
  try {
23
- if (localStorage.getItem(segmentKey) === DEFINED) return false;
24
- localStorage.setItem(segmentKey, DEFINED);
26
+ if (this.storage.getItem(segmentKey) === DEFINED) return false;
27
+ this.storage.setItem(segmentKey, DEFINED);
25
28
  return true;
26
29
  } catch (e) {
27
30
  this.log.error(LOG_PREFIX + e);
@@ -33,8 +36,8 @@ export class MySegmentsCacheInLocal extends AbstractMySegmentsCacheSync {
33
36
  const segmentKey = this.keys.buildSegmentNameKey(name);
34
37
 
35
38
  try {
36
- if (localStorage.getItem(segmentKey) !== DEFINED) return false;
37
- localStorage.removeItem(segmentKey);
39
+ if (this.storage.getItem(segmentKey) !== DEFINED) return false;
40
+ this.storage.removeItem(segmentKey);
38
41
  return true;
39
42
  } catch (e) {
40
43
  this.log.error(LOG_PREFIX + e);
@@ -43,18 +46,16 @@ export class MySegmentsCacheInLocal extends AbstractMySegmentsCacheSync {
43
46
  }
44
47
 
45
48
  isInSegment(name: string): boolean {
46
- return localStorage.getItem(this.keys.buildSegmentNameKey(name)) === DEFINED;
49
+ return this.storage.getItem(this.keys.buildSegmentNameKey(name)) === DEFINED;
47
50
  }
48
51
 
49
52
  getRegisteredSegments(): string[] {
50
- // Scan current values from localStorage
51
- return Object.keys(localStorage).reduce((accum, key) => {
52
- let segmentName = this.keys.extractSegmentName(key);
53
-
54
- if (segmentName) accum.push(segmentName);
55
-
56
- return accum;
57
- }, [] as string[]);
53
+ const registeredSegments: string[] = [];
54
+ for (let i = 0, len = this.storage.length; i < len; i++) {
55
+ const segmentName = this.keys.extractSegmentName(this.storage.key(i)!);
56
+ if (segmentName) registeredSegments.push(segmentName);
57
+ }
58
+ return registeredSegments;
58
59
  }
59
60
 
60
61
  getKeysCount() {
@@ -63,8 +64,8 @@ export class MySegmentsCacheInLocal extends AbstractMySegmentsCacheSync {
63
64
 
64
65
  protected setChangeNumber(changeNumber?: number) {
65
66
  try {
66
- if (changeNumber) localStorage.setItem(this.keys.buildTillKey(), changeNumber + '');
67
- else localStorage.removeItem(this.keys.buildTillKey());
67
+ if (changeNumber) this.storage.setItem(this.keys.buildTillKey(), changeNumber + '');
68
+ else this.storage.removeItem(this.keys.buildTillKey());
68
69
  } catch (e) {
69
70
  this.log.error(e);
70
71
  }
@@ -72,7 +73,7 @@ export class MySegmentsCacheInLocal extends AbstractMySegmentsCacheSync {
72
73
 
73
74
  getChangeNumber() {
74
75
  const n = -1;
75
- let value: string | number | null = localStorage.getItem(this.keys.buildTillKey());
76
+ let value: string | number | null = this.storage.getItem(this.keys.buildTillKey());
76
77
 
77
78
  if (value !== null) {
78
79
  value = parseInt(value, 10);
@@ -5,22 +5,24 @@ import { isFiniteNumber, isNaNNumber, toNumber } from '../../utils/lang';
5
5
  import { setToArray } from '../../utils/lang/sets';
6
6
  import { usesSegments } from '../AbstractSplitsCacheSync';
7
7
  import { KeyBuilderCS } from '../KeyBuilderCS';
8
- import { IRBSegmentsCacheSync } from '../types';
8
+ import { IRBSegmentsCacheSync, StorageAdapter } from '../types';
9
9
  import { LOG_PREFIX } from './constants';
10
10
 
11
11
  export class RBSegmentsCacheInLocal implements IRBSegmentsCacheSync {
12
12
 
13
13
  private readonly keys: KeyBuilderCS;
14
14
  private readonly log: ILogger;
15
+ private readonly storage: StorageAdapter;
15
16
 
16
- constructor(settings: ISettings, keys: KeyBuilderCS) {
17
+ constructor(settings: ISettings, keys: KeyBuilderCS, storage: StorageAdapter) {
17
18
  this.keys = keys;
18
19
  this.log = settings.log;
20
+ this.storage = storage;
19
21
  }
20
22
 
21
23
  clear() {
22
24
  this.getNames().forEach(name => this.remove(name));
23
- localStorage.removeItem(this.keys.buildRBSegmentsTillKey());
25
+ this.storage.removeItem(this.keys.buildRBSegmentsTillKey());
24
26
  }
25
27
 
26
28
  update(toAdd: IRBSegment[], toRemove: IRBSegment[], changeNumber: number): boolean {
@@ -31,8 +33,8 @@ export class RBSegmentsCacheInLocal implements IRBSegmentsCacheSync {
31
33
 
32
34
  private setChangeNumber(changeNumber: number) {
33
35
  try {
34
- localStorage.setItem(this.keys.buildRBSegmentsTillKey(), changeNumber + '');
35
- localStorage.setItem(this.keys.buildLastUpdatedKey(), Date.now() + '');
36
+ this.storage.setItem(this.keys.buildRBSegmentsTillKey(), changeNumber + '');
37
+ this.storage.setItem(this.keys.buildLastUpdatedKey(), Date.now() + '');
36
38
  } catch (e) {
37
39
  this.log.error(LOG_PREFIX + e);
38
40
  }
@@ -40,20 +42,19 @@ export class RBSegmentsCacheInLocal implements IRBSegmentsCacheSync {
40
42
 
41
43
  private updateSegmentCount(diff: number) {
42
44
  const segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
43
- const count = toNumber(localStorage.getItem(segmentsCountKey)) + diff;
44
- // @ts-expect-error
45
- if (count > 0) localStorage.setItem(segmentsCountKey, count);
46
- else localStorage.removeItem(segmentsCountKey);
45
+ const count = toNumber(this.storage.getItem(segmentsCountKey)) + diff;
46
+ if (count > 0) this.storage.setItem(segmentsCountKey, count + '');
47
+ else this.storage.removeItem(segmentsCountKey);
47
48
  }
48
49
 
49
50
  private add(rbSegment: IRBSegment): boolean {
50
51
  try {
51
52
  const name = rbSegment.name;
52
53
  const rbSegmentKey = this.keys.buildRBSegmentKey(name);
53
- const rbSegmentFromLocalStorage = localStorage.getItem(rbSegmentKey);
54
- const previous = rbSegmentFromLocalStorage ? JSON.parse(rbSegmentFromLocalStorage) : null;
54
+ const rbSegmentFromStorage = this.storage.getItem(rbSegmentKey);
55
+ const previous = rbSegmentFromStorage ? JSON.parse(rbSegmentFromStorage) : null;
55
56
 
56
- localStorage.setItem(rbSegmentKey, JSON.stringify(rbSegment));
57
+ this.storage.setItem(rbSegmentKey, JSON.stringify(rbSegment));
57
58
 
58
59
  let usesSegmentsDiff = 0;
59
60
  if (previous && usesSegments(previous)) usesSegmentsDiff--;
@@ -72,7 +73,7 @@ export class RBSegmentsCacheInLocal implements IRBSegmentsCacheSync {
72
73
  const rbSegment = this.get(name);
73
74
  if (!rbSegment) return false;
74
75
 
75
- localStorage.removeItem(this.keys.buildRBSegmentKey(name));
76
+ this.storage.removeItem(this.keys.buildRBSegmentKey(name));
76
77
 
77
78
  if (usesSegments(rbSegment)) this.updateSegmentCount(-1);
78
79
 
@@ -84,13 +85,13 @@ export class RBSegmentsCacheInLocal implements IRBSegmentsCacheSync {
84
85
  }
85
86
 
86
87
  private getNames(): string[] {
87
- const len = localStorage.length;
88
+ const len = this.storage.length;
88
89
  const accum = [];
89
90
 
90
91
  let cur = 0;
91
92
 
92
93
  while (cur < len) {
93
- const key = localStorage.key(cur);
94
+ const key = this.storage.key(cur);
94
95
 
95
96
  if (key != null && this.keys.isRBSegmentKey(key)) accum.push(this.keys.extractKey(key));
96
97
 
@@ -101,7 +102,7 @@ export class RBSegmentsCacheInLocal implements IRBSegmentsCacheSync {
101
102
  }
102
103
 
103
104
  get(name: string): IRBSegment | null {
104
- const item = localStorage.getItem(this.keys.buildRBSegmentKey(name));
105
+ const item = this.storage.getItem(this.keys.buildRBSegmentKey(name));
105
106
  return item && JSON.parse(item);
106
107
  }
107
108
 
@@ -117,7 +118,7 @@ export class RBSegmentsCacheInLocal implements IRBSegmentsCacheSync {
117
118
 
118
119
  getChangeNumber(): number {
119
120
  const n = -1;
120
- let value: string | number | null = localStorage.getItem(this.keys.buildRBSegmentsTillKey());
121
+ let value: string | number | null = this.storage.getItem(this.keys.buildRBSegmentsTillKey());
121
122
 
122
123
  if (value !== null) {
123
124
  value = parseInt(value, 10);
@@ -129,7 +130,7 @@ export class RBSegmentsCacheInLocal implements IRBSegmentsCacheSync {
129
130
  }
130
131
 
131
132
  usesSegments(): boolean {
132
- const storedCount = localStorage.getItem(this.keys.buildSplitsWithSegmentCountKey());
133
+ const storedCount = this.storage.getItem(this.keys.buildSplitsWithSegmentCountKey());
133
134
  const splitsWithSegmentsCount = storedCount === null ? 0 : toNumber(storedCount);
134
135
 
135
136
  return isFiniteNumber(splitsWithSegmentsCount) ?