@splitsoftware/splitio-commons 1.17.1-rc.3 → 1.17.1-rc.4

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 (107) hide show
  1. package/CHANGES.txt +4 -3
  2. package/cjs/readiness/readinessManager.js +13 -4
  3. package/cjs/sdkClient/sdkClientMethodCS.js +3 -7
  4. package/cjs/sdkClient/sdkClientMethodCSWithTT.js +3 -7
  5. package/cjs/sdkFactory/index.js +8 -13
  6. package/cjs/storages/{AbstractSegmentsCacheSync.js → AbstractMySegmentsCacheSync.js} +15 -17
  7. package/cjs/storages/AbstractSplitsCacheAsync.js +7 -0
  8. package/cjs/storages/AbstractSplitsCacheSync.js +7 -0
  9. package/cjs/storages/dataLoader.js +32 -64
  10. package/cjs/storages/inLocalStorage/MySegmentsCacheInLocal.js +5 -5
  11. package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js +9 -1
  12. package/cjs/storages/inLocalStorage/index.js +1 -6
  13. package/cjs/storages/inMemory/InMemoryStorageCS.js +5 -17
  14. package/cjs/storages/inMemory/MySegmentsCacheInMemory.js +5 -5
  15. package/cjs/storages/inMemory/SegmentsCacheInMemory.js +13 -27
  16. package/cjs/storages/inMemory/SplitsCacheInMemory.js +0 -1
  17. package/cjs/storages/inRedis/RedisAdapter.js +1 -1
  18. package/cjs/storages/inRedis/SegmentsCacheInRedis.js +13 -19
  19. package/cjs/storages/pluggable/SegmentsCachePluggable.js +11 -32
  20. package/cjs/storages/pluggable/index.js +32 -37
  21. package/cjs/sync/offline/syncManagerOffline.js +18 -11
  22. package/cjs/sync/offline/syncTasks/fromObjectSyncTask.js +7 -2
  23. package/cjs/sync/polling/pollingManagerSS.js +3 -3
  24. package/cjs/sync/polling/updaters/segmentChangesUpdater.js +12 -28
  25. package/cjs/sync/polling/updaters/splitChangesUpdater.js +10 -1
  26. package/cjs/sync/syncManagerOnline.js +20 -21
  27. package/cjs/trackers/eventTracker.js +1 -1
  28. package/cjs/trackers/impressionsTracker.js +1 -1
  29. package/cjs/utils/settingsValidation/storage/storageCS.js +12 -1
  30. package/esm/readiness/readinessManager.js +13 -4
  31. package/esm/sdkClient/sdkClientMethodCS.js +3 -7
  32. package/esm/sdkClient/sdkClientMethodCSWithTT.js +3 -7
  33. package/esm/sdkFactory/index.js +9 -14
  34. package/esm/storages/{AbstractSegmentsCacheSync.js → AbstractMySegmentsCacheSync.js} +14 -16
  35. package/esm/storages/AbstractSplitsCacheAsync.js +7 -0
  36. package/esm/storages/AbstractSplitsCacheSync.js +7 -0
  37. package/esm/storages/dataLoader.js +30 -61
  38. package/esm/storages/inLocalStorage/MySegmentsCacheInLocal.js +5 -5
  39. package/esm/storages/inLocalStorage/SplitsCacheInLocal.js +9 -1
  40. package/esm/storages/inLocalStorage/index.js +2 -7
  41. package/esm/storages/inMemory/InMemoryStorageCS.js +5 -17
  42. package/esm/storages/inMemory/MySegmentsCacheInMemory.js +5 -5
  43. package/esm/storages/inMemory/SegmentsCacheInMemory.js +13 -27
  44. package/esm/storages/inMemory/SplitsCacheInMemory.js +0 -1
  45. package/esm/storages/inRedis/RedisAdapter.js +1 -1
  46. package/esm/storages/inRedis/SegmentsCacheInRedis.js +13 -19
  47. package/esm/storages/pluggable/SegmentsCachePluggable.js +11 -32
  48. package/esm/storages/pluggable/index.js +32 -37
  49. package/esm/sync/offline/syncManagerOffline.js +18 -11
  50. package/esm/sync/offline/syncTasks/fromObjectSyncTask.js +8 -3
  51. package/esm/sync/polling/pollingManagerSS.js +3 -3
  52. package/esm/sync/polling/updaters/segmentChangesUpdater.js +12 -28
  53. package/esm/sync/polling/updaters/splitChangesUpdater.js +11 -2
  54. package/esm/sync/syncManagerOnline.js +20 -21
  55. package/esm/trackers/eventTracker.js +1 -1
  56. package/esm/trackers/impressionsTracker.js +1 -1
  57. package/esm/utils/settingsValidation/storage/storageCS.js +10 -0
  58. package/package.json +1 -1
  59. package/src/readiness/readinessManager.ts +11 -4
  60. package/src/readiness/types.ts +2 -0
  61. package/src/sdkClient/sdkClientMethodCS.ts +1 -6
  62. package/src/sdkClient/sdkClientMethodCSWithTT.ts +1 -6
  63. package/src/sdkFactory/index.ts +9 -15
  64. package/src/sdkFactory/types.ts +1 -2
  65. package/src/storages/{AbstractSegmentsCacheSync.ts → AbstractMySegmentsCacheSync.ts} +13 -28
  66. package/src/storages/AbstractSplitsCacheAsync.ts +8 -0
  67. package/src/storages/AbstractSplitsCacheSync.ts +8 -0
  68. package/src/storages/dataLoader.ts +32 -62
  69. package/src/storages/inLocalStorage/MySegmentsCacheInLocal.ts +5 -5
  70. package/src/storages/inLocalStorage/SplitsCacheInLocal.ts +10 -1
  71. package/src/storages/inLocalStorage/index.ts +2 -8
  72. package/src/storages/inMemory/InMemoryStorageCS.ts +5 -20
  73. package/src/storages/inMemory/MySegmentsCacheInMemory.ts +5 -5
  74. package/src/storages/inMemory/SegmentsCacheInMemory.ts +12 -26
  75. package/src/storages/inMemory/SplitsCacheInMemory.ts +0 -1
  76. package/src/storages/inRedis/RedisAdapter.ts +1 -1
  77. package/src/storages/inRedis/SegmentsCacheInRedis.ts +13 -22
  78. package/src/storages/pluggable/SegmentsCachePluggable.ts +11 -35
  79. package/src/storages/pluggable/index.ts +33 -38
  80. package/src/storages/types.ts +9 -11
  81. package/src/sync/offline/syncManagerOffline.ts +21 -13
  82. package/src/sync/offline/syncTasks/fromObjectSyncTask.ts +7 -3
  83. package/src/sync/polling/pollingManagerSS.ts +2 -3
  84. package/src/sync/polling/updaters/segmentChangesUpdater.ts +13 -29
  85. package/src/sync/polling/updaters/splitChangesUpdater.ts +11 -3
  86. package/src/sync/syncManagerOnline.ts +17 -17
  87. package/src/sync/types.ts +1 -1
  88. package/src/trackers/eventTracker.ts +1 -1
  89. package/src/trackers/impressionsTracker.ts +1 -1
  90. package/src/types.ts +8 -9
  91. package/src/utils/settingsValidation/storage/storageCS.ts +13 -0
  92. package/types/readiness/types.d.ts +2 -0
  93. package/types/sdkFactory/types.d.ts +1 -2
  94. package/types/storages/AbstractSplitsCacheAsync.d.ts +5 -0
  95. package/types/storages/AbstractSplitsCacheSync.d.ts +5 -0
  96. package/types/storages/dataLoader.d.ts +6 -17
  97. package/types/storages/inLocalStorage/MySegmentsCacheInLocal.d.ts +5 -5
  98. package/types/storages/inLocalStorage/SplitsCacheInLocal.d.ts +6 -0
  99. package/types/storages/inMemory/MySegmentsCacheInMemory.d.ts +5 -5
  100. package/types/storages/inMemory/SegmentsCacheInMemory.d.ts +5 -7
  101. package/types/storages/inMemory/SplitsCacheInMemory.d.ts +0 -1
  102. package/types/storages/inRedis/SegmentsCacheInRedis.d.ts +6 -3
  103. package/types/storages/pluggable/SegmentsCachePluggable.d.ts +4 -16
  104. package/types/storages/types.d.ts +7 -11
  105. package/types/sync/types.d.ts +1 -1
  106. package/types/types.d.ts +8 -8
  107. package/types/utils/settingsValidation/storage/storageCS.d.ts +5 -0
@@ -13,7 +13,7 @@ import { buildInstanceId } from './identity';
13
13
  * (default client) or the client method (shared clients).
14
14
  */
15
15
  export function sdkClientMethodCSFactory(params) {
16
- var clients = params.clients, storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, _b = _a.core, key = _b.key, trafficType = _b.trafficType, log = _a.log, whenInit = params.whenInit;
16
+ var clients = params.clients, storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, _b = _a.core, key = _b.key, trafficType = _b.trafficType, log = _a.log;
17
17
  var mainClientInstance = clientCSDecorator(log, sdkClientFactory(params), key, trafficType);
18
18
  var parsedDefaultKey = keyParser(key);
19
19
  var defaultInstanceId = buildInstanceId(parsedDefaultKey, trafficType);
@@ -53,18 +53,14 @@ export function sdkClientMethodCSFactory(params) {
53
53
  // - Consumer mode: both syncManager and sharedSyncManager are undefined
54
54
  // - Consumer partial mode: syncManager is defined (only for submitters) but sharedSyncManager is undefined
55
55
  // @ts-ignore
56
- var sharedSyncManager_1 = syncManager && sharedStorage && syncManager.shared(matchingKey, sharedSdkReadiness_1.readinessManager, sharedStorage);
56
+ var sharedSyncManager = syncManager && sharedStorage && syncManager.shared(matchingKey, sharedSdkReadiness_1.readinessManager, sharedStorage);
57
57
  // As shared clients reuse all the storage information, we don't need to check here if we
58
58
  // will use offline or online mode. We should stick with the original decision.
59
59
  clients[instanceId] = clientCSDecorator(log, sdkClientFactory(objectAssign({}, params, {
60
60
  sdkReadinessManager: sharedSdkReadiness_1,
61
61
  storage: sharedStorage || storage,
62
- syncManager: sharedSyncManager_1,
62
+ syncManager: sharedSyncManager,
63
63
  }), true), validKey, validTrafficType);
64
- whenInit(function () {
65
- sharedSdkReadiness_1.readinessManager.init();
66
- sharedSyncManager_1 && sharedSyncManager_1.start();
67
- });
68
64
  log.info(NEW_SHARED_CLIENT);
69
65
  }
70
66
  else {
@@ -5,7 +5,7 @@ import { telemetryTrackerFactory } from '../trackers/telemetryTracker';
5
5
  import { validateAndTrackApiKey } from '../utils/inputValidation/apiKey';
6
6
  import { createLoggerAPI } from '../logger/sdkLogger';
7
7
  import { NEW_FACTORY, RETRIEVE_MANAGER } from '../logger/constants';
8
- import { SDK_SPLITS_ARRIVED, SDK_SEGMENTS_ARRIVED, SDK_SPLITS_CACHE_LOADED } from '../readiness/constants';
8
+ import { SDK_SPLITS_ARRIVED, SDK_SEGMENTS_ARRIVED } from '../readiness/constants';
9
9
  import { objectAssign } from '../utils/lang/objectAssign';
10
10
  import { strategyDebugFactory } from '../trackers/strategy/strategyDebug';
11
11
  import { strategyOptimizedFactory } from '../trackers/strategy/strategyOptimized';
@@ -16,15 +16,15 @@ import { NONE, OPTIMIZED } from '../utils/constants';
16
16
  * Modular SDK factory
17
17
  */
18
18
  export function sdkFactory(params) {
19
- var settings = params.settings, platform = params.platform, storageFactory = params.storageFactory, splitApiFactory = params.splitApiFactory, extraProps = params.extraProps, syncManagerFactory = params.syncManagerFactory, SignalListener = params.SignalListener, impressionsObserverFactory = params.impressionsObserverFactory, integrationsManagerFactory = params.integrationsManagerFactory, sdkManagerFactory = params.sdkManagerFactory, sdkClientMethodFactory = params.sdkClientMethodFactory, filterAdapterFactory = params.filterAdapterFactory, isPure = params.isPure;
19
+ var settings = params.settings, platform = params.platform, storageFactory = params.storageFactory, splitApiFactory = params.splitApiFactory, extraProps = params.extraProps, syncManagerFactory = params.syncManagerFactory, SignalListener = params.SignalListener, impressionsObserverFactory = params.impressionsObserverFactory, integrationsManagerFactory = params.integrationsManagerFactory, sdkManagerFactory = params.sdkManagerFactory, sdkClientMethodFactory = params.sdkClientMethodFactory, filterAdapterFactory = params.filterAdapterFactory, lazyInit = params.lazyInit;
20
20
  var log = settings.log, impressionsMode = settings.sync.impressionsMode;
21
21
  // @TODO handle non-recoverable errors, such as, global `fetch` not available, invalid SDK Key, etc.
22
22
  // On non-recoverable errors, we should mark the SDK as destroyed and not start synchronization.
23
23
  // initialization
24
- var isInit = false;
24
+ var hasInit = false;
25
25
  var initCallbacks = [];
26
26
  function whenInit(cb) {
27
- if (isInit)
27
+ if (hasInit)
28
28
  cb();
29
29
  else
30
30
  initCallbacks.push(cb);
@@ -42,10 +42,8 @@ export function sdkFactory(params) {
42
42
  readiness.splits.emit(SDK_SPLITS_ARRIVED);
43
43
  readiness.segments.emit(SDK_SEGMENTS_ARRIVED);
44
44
  },
45
- onReadyFromCacheCb: function () {
46
- readiness.splits.emit(SDK_SPLITS_CACHE_LOADED);
47
- }
48
45
  });
46
+ // @TODO add support for dataloader: `if (params.dataLoader) params.dataLoader(storage);`
49
47
  var clients = {};
50
48
  var telemetryTracker = telemetryTrackerFactory(storage.telemetry, platform.now);
51
49
  var integrationsManager = integrationsManagerFactory && integrationsManagerFactory({ settings: settings, storage: storage, telemetryTracker: telemetryTracker });
@@ -66,7 +64,7 @@ export function sdkFactory(params) {
66
64
  var eventTracker = eventTrackerFactory(settings, storage.events, whenInit, integrationsManager, storage.telemetry);
67
65
  // splitApi is used by SyncManager and Browser signal listener
68
66
  var splitApi = splitApiFactory && splitApiFactory(settings, platform, telemetryTracker);
69
- var ctx = { clients: clients, splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, uniqueKeysTracker: uniqueKeysTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform, whenInit: whenInit };
67
+ var ctx = { clients: clients, splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, uniqueKeysTracker: uniqueKeysTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform };
70
68
  var syncManager = syncManagerFactory && syncManagerFactory(ctx);
71
69
  ctx.syncManager = syncManager;
72
70
  var signalListener = SignalListener && new SignalListener(syncManager, settings, storage, splitApi);
@@ -75,21 +73,18 @@ export function sdkFactory(params) {
75
73
  var clientMethod = sdkClientMethodFactory(ctx);
76
74
  var managerInstance = sdkManagerFactory(settings, storage.splits, sdkReadinessManager);
77
75
  function init() {
78
- if (isInit)
76
+ if (hasInit)
79
77
  return;
80
- isInit = true;
78
+ hasInit = true;
81
79
  // We will just log and allow for the SDK to end up throwing an SDK_TIMEOUT event for devs to handle.
82
80
  validateAndTrackApiKey(log, settings.core.authorizationKey);
83
81
  readiness.init();
84
- storage.init && storage.init();
85
82
  uniqueKeysTracker && uniqueKeysTracker.start();
86
83
  syncManager && syncManager.start();
87
84
  signalListener && signalListener.start();
88
85
  initCallbacks.forEach(function (cb) { return cb(); });
89
86
  initCallbacks.length = 0;
90
87
  }
91
- if (!isPure)
92
- init();
93
88
  log.info(NEW_FACTORY);
94
89
  // @ts-ignore
95
90
  return objectAssign({
@@ -106,5 +101,5 @@ export function sdkFactory(params) {
106
101
  destroy: function () {
107
102
  return Promise.all(Object.keys(clients).map(function (key) { return clients[key].destroy(); })).then(function () { });
108
103
  }
109
- }, extraProps && extraProps(ctx), isPure && { init: init });
104
+ }, extraProps && extraProps(ctx), lazyInit ? { init: init } : init());
110
105
  }
@@ -2,35 +2,33 @@
2
2
  * This class provides a skeletal implementation of the ISegmentsCacheSync interface
3
3
  * to minimize the effort required to implement this interface.
4
4
  */
5
- var AbstractSegmentsCacheSync = /** @class */ (function () {
6
- function AbstractSegmentsCacheSync() {
5
+ var AbstractMySegmentsCacheSync = /** @class */ (function () {
6
+ function AbstractMySegmentsCacheSync() {
7
7
  }
8
8
  /**
9
9
  * clear the cache.
10
10
  */
11
- AbstractSegmentsCacheSync.prototype.clear = function () {
11
+ AbstractMySegmentsCacheSync.prototype.clear = function () {
12
12
  this.resetSegments({});
13
13
  };
14
- /**
15
- * For server-side synchronizer: add the given list of segments to the cache, with an empty list of keys. The segments that already exist are not modified.
16
- * For client-side synchronizer: the method is not used.
17
- */
18
- AbstractSegmentsCacheSync.prototype.registerSegments = function (names) { return false; };
14
+ // No-op. Not used in client-side.
15
+ AbstractMySegmentsCacheSync.prototype.registerSegments = function () { return false; };
16
+ AbstractMySegmentsCacheSync.prototype.update = function () { return false; };
19
17
  /**
20
18
  * For server-side synchronizer: the method is not used.
21
19
  * For client-side synchronizer: it resets or updates the cache.
22
20
  */
23
- AbstractSegmentsCacheSync.prototype.resetSegments = function (segmentsData) {
21
+ AbstractMySegmentsCacheSync.prototype.resetSegments = function (segmentsData) {
24
22
  var _this = this;
25
- this.setChangeNumber(undefined, segmentsData.cn);
23
+ this.setChangeNumber(segmentsData.cn);
26
24
  var _a = segmentsData, added = _a.added, removed = _a.removed;
27
25
  if (added && removed) {
28
26
  var isDiff_1 = false;
29
27
  added.forEach(function (segment) {
30
- isDiff_1 = _this.addToSegment(segment) || isDiff_1;
28
+ isDiff_1 = _this.addSegment(segment) || isDiff_1;
31
29
  });
32
30
  removed.forEach(function (segment) {
33
- isDiff_1 = _this.removeFromSegment(segment) || isDiff_1;
31
+ isDiff_1 = _this.removeSegment(segment) || isDiff_1;
34
32
  });
35
33
  return isDiff_1;
36
34
  }
@@ -47,13 +45,13 @@ var AbstractSegmentsCacheSync = /** @class */ (function () {
47
45
  return false;
48
46
  // Slowest path => add and/or remove segments
49
47
  for (var removeIndex = index; removeIndex < storedSegmentKeys.length; removeIndex++) {
50
- this.removeFromSegment(storedSegmentKeys[removeIndex]);
48
+ this.removeSegment(storedSegmentKeys[removeIndex]);
51
49
  }
52
50
  for (var addIndex = index; addIndex < names.length; addIndex++) {
53
- this.addToSegment(names[addIndex]);
51
+ this.addSegment(names[addIndex]);
54
52
  }
55
53
  return true;
56
54
  };
57
- return AbstractSegmentsCacheSync;
55
+ return AbstractMySegmentsCacheSync;
58
56
  }());
59
- export { AbstractSegmentsCacheSync };
57
+ export { AbstractMySegmentsCacheSync };
@@ -11,6 +11,13 @@ var AbstractSplitsCacheAsync = /** @class */ (function () {
11
11
  AbstractSplitsCacheAsync.prototype.usesSegments = function () {
12
12
  return Promise.resolve(true);
13
13
  };
14
+ /**
15
+ * Check if the splits information is already stored in cache.
16
+ * Noop, just keeping the interface. This is used by client-side implementations only.
17
+ */
18
+ AbstractSplitsCacheAsync.prototype.checkCache = function () {
19
+ return Promise.resolve(false);
20
+ };
14
21
  /**
15
22
  * Kill `name` split and set `defaultTreatment` and `changeNumber`.
16
23
  * Used for SPLIT_KILL push notifications.
@@ -27,6 +27,13 @@ var AbstractSplitsCacheSync = /** @class */ (function () {
27
27
  var _this = this;
28
28
  return this.getSplitNames().map(function (key) { return _this.getSplit(key); });
29
29
  };
30
+ /**
31
+ * Check if the splits information is already stored in cache. This data can be preloaded.
32
+ * It is used as condition to emit SDK_SPLITS_CACHE_LOADED, and then SDK_READY_FROM_CACHE.
33
+ */
34
+ AbstractSplitsCacheSync.prototype.checkCache = function () {
35
+ return false;
36
+ };
30
37
  /**
31
38
  * Kill `name` split and set `defaultTreatment` and `changeNumber`.
32
39
  * Used for SPLIT_KILL push notifications.
@@ -1,78 +1,47 @@
1
- import { setToArray } from '../utils/lang/sets';
2
- import { getMatching } from '../utils/key';
1
+ import { DEFAULT_CACHE_EXPIRATION_IN_MILLIS } from '../utils/constants/browser';
3
2
  /**
4
- * Storage-agnostic adaptation of `loadDataIntoLocalStorage` function
5
- * (https://github.com/godaddy/split-javascript-data-loader/blob/master/src/load-data.js)
3
+ * Factory of client-side storage loader
6
4
  *
7
- * @param preloadedData validated data following the format proposed in https://github.com/godaddy/split-javascript-data-loader and extended with a `mySegmentsData` property.
8
- * @param storage object containing `splits` and `segments` cache (client-side variant)
9
- * @param userKey user key (matching key) of the provided MySegmentsCache
10
- *
11
- * @TODO extend to load largeSegments
12
- * @TODO extend to load data on shared mySegments storages. Be specific when emitting SDK_READY_FROM_CACHE on shared clients. Maybe the serializer should provide the `useSegments` flag.
13
- * @TODO add logs, and input validation in this module, in favor of size reduction.
14
- * @TODO unit tests
5
+ * @param preloadedData validated data following the format proposed in https://github.com/godaddy/split-javascript-data-loader
6
+ * and extended with a `mySegmentsData` property.
7
+ * @returns function to preload the storage
15
8
  */
16
- export function loadData(preloadedData, storage, matchingKey) {
17
- // Do not load data if current preloadedData is empty
18
- if (Object.keys(preloadedData).length === 0)
19
- return;
20
- var _a = preloadedData.segmentsData, segmentsData = _a === void 0 ? {} : _a, _b = preloadedData.since, since = _b === void 0 ? -1 : _b, _c = preloadedData.splitsData, splitsData = _c === void 0 ? [] : _c;
21
- if (storage.splits) {
9
+ export function dataLoaderFactory(preloadedData) {
10
+ /**
11
+ * Storage-agnostic adaptation of `loadDataIntoLocalStorage` function
12
+ * (https://github.com/godaddy/split-javascript-data-loader/blob/master/src/load-data.js)
13
+ *
14
+ * @param storage object containing `splits` and `segments` cache (client-side variant)
15
+ * @param userId user key string of the provided MySegmentsCache
16
+ *
17
+ * @TODO extend to support SegmentsCache (server-side variant) by making `userId` optional and adding the corresponding logic.
18
+ * @TODO extend to load data on shared mySegments storages. Be specific when emitting SDK_READY_FROM_CACHE on shared clients. Maybe the serializer should provide the `useSegments` flag.
19
+ */
20
+ return function loadData(storage, userId) {
21
+ // Do not load data if current preloadedData is empty
22
+ if (Object.keys(preloadedData).length === 0)
23
+ return;
24
+ var _a = preloadedData.lastUpdated, lastUpdated = _a === void 0 ? -1 : _a, _b = preloadedData.segmentsData, segmentsData = _b === void 0 ? {} : _b, _c = preloadedData.since, since = _c === void 0 ? -1 : _c, _d = preloadedData.splitsData, splitsData = _d === void 0 ? {} : _d;
22
25
  var storedSince = storage.splits.getChangeNumber();
23
- // Do not load data if current data is more recent
24
- if (storedSince > since)
26
+ var expirationTimestamp = Date.now() - DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
27
+ // Do not load data if current localStorage data is more recent,
28
+ // or if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
29
+ if (storedSince > since || lastUpdated < expirationTimestamp)
25
30
  return;
26
31
  // cleaning up the localStorage data, since some cached splits might need be part of the preloaded data
27
32
  storage.splits.clear();
28
33
  storage.splits.setChangeNumber(since);
29
34
  // splitsData in an object where the property is the split name and the pertaining value is a stringified json of its data
30
- storage.splits.addSplits(splitsData.map(function (split) { return ([split.name, split]); }));
31
- }
32
- if (matchingKey) { // add mySegments data (client-side)
33
- var mySegmentsData = preloadedData.mySegmentsData && preloadedData.mySegmentsData[matchingKey];
35
+ storage.splits.addSplits(Object.keys(splitsData).map(function (splitName) { return JSON.parse(splitsData[splitName]); }));
36
+ // add mySegments data
37
+ var mySegmentsData = preloadedData.mySegmentsData && preloadedData.mySegmentsData[userId];
34
38
  if (!mySegmentsData) {
35
39
  // segmentsData in an object where the property is the segment name and the pertaining value is a stringified object that contains the `added` array of userIds
36
40
  mySegmentsData = Object.keys(segmentsData).filter(function (segmentName) {
37
- var matchingKeys = segmentsData[segmentName];
38
- return matchingKeys.indexOf(matchingKey) > -1;
41
+ var userIds = JSON.parse(segmentsData[segmentName]).added;
42
+ return Array.isArray(userIds) && userIds.indexOf(userId) > -1;
39
43
  });
40
44
  }
41
45
  storage.segments.resetSegments({ k: mySegmentsData.map(function (s) { return ({ n: s }); }) });
42
- }
43
- else { // add segments data (server-side)
44
- Object.keys(segmentsData).filter(function (segmentName) {
45
- var matchingKeys = segmentsData[segmentName];
46
- storage.segments.addToSegment(segmentName, matchingKeys);
47
- });
48
- }
49
- }
50
- export function getSnapshot(storage, userKeys) {
51
- return {
52
- // lastUpdated: Date.now(),
53
- since: storage.splits.getChangeNumber(),
54
- splitsData: storage.splits.getAll(),
55
- segmentsData: userKeys ?
56
- undefined : // @ts-ignore accessing private prop
57
- Object.keys(storage.segments.segmentCache).reduce(function (prev, cur) {
58
- prev[cur] = setToArray(storage.segments.segmentCache[cur]);
59
- return prev;
60
- }, {}),
61
- mySegmentsData: userKeys ?
62
- userKeys.reduce(function (prev, userKey) {
63
- prev[getMatching(userKey)] = storage.shared ?
64
- // Client-side segments
65
- // @ts-ignore accessing private prop
66
- Object.keys(storage.shared(userKey).segments.segmentCache) :
67
- // Server-side segments
68
- // @ts-ignore accessing private prop
69
- Object.keys(storage.segments.segmentCache).reduce(function (prev, segmentName) {
70
- return storage.segments.segmentCache[segmentName].has(userKey) ?
71
- prev.concat(segmentName) :
72
- prev;
73
- }, []);
74
- return prev;
75
- }, {}) :
76
- undefined
77
46
  };
78
47
  }
@@ -1,6 +1,6 @@
1
1
  import { __extends } from "tslib";
2
2
  import { isNaNNumber } from '../../utils/lang';
3
- import { AbstractSegmentsCacheSync } from '../AbstractSegmentsCacheSync';
3
+ import { AbstractMySegmentsCacheSync } from '../AbstractMySegmentsCacheSync';
4
4
  import { LOG_PREFIX, DEFINED } from './constants';
5
5
  var MySegmentsCacheInLocal = /** @class */ (function (_super) {
6
6
  __extends(MySegmentsCacheInLocal, _super);
@@ -11,7 +11,7 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
11
11
  return _this;
12
12
  // There is not need to flush segments cache like splits cache, since resetSegments receives the up-to-date list of active segments
13
13
  }
14
- MySegmentsCacheInLocal.prototype.addToSegment = function (name) {
14
+ MySegmentsCacheInLocal.prototype.addSegment = function (name) {
15
15
  var segmentKey = this.keys.buildSegmentNameKey(name);
16
16
  try {
17
17
  if (localStorage.getItem(segmentKey) === DEFINED)
@@ -24,7 +24,7 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
24
24
  return false;
25
25
  }
26
26
  };
27
- MySegmentsCacheInLocal.prototype.removeFromSegment = function (name) {
27
+ MySegmentsCacheInLocal.prototype.removeSegment = function (name) {
28
28
  var segmentKey = this.keys.buildSegmentNameKey(name);
29
29
  try {
30
30
  if (localStorage.getItem(segmentKey) !== DEFINED)
@@ -73,7 +73,7 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
73
73
  MySegmentsCacheInLocal.prototype.getKeysCount = function () {
74
74
  return 1;
75
75
  };
76
- MySegmentsCacheInLocal.prototype.setChangeNumber = function (name, changeNumber) {
76
+ MySegmentsCacheInLocal.prototype.setChangeNumber = function (changeNumber) {
77
77
  try {
78
78
  if (changeNumber)
79
79
  localStorage.setItem(this.keys.buildTillKey(), changeNumber + '');
@@ -94,5 +94,5 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
94
94
  return n;
95
95
  };
96
96
  return MySegmentsCacheInLocal;
97
- }(AbstractSegmentsCacheSync));
97
+ }(AbstractMySegmentsCacheSync));
98
98
  export { MySegmentsCacheInLocal };
@@ -183,6 +183,14 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
183
183
  return true;
184
184
  }
185
185
  };
186
+ /**
187
+ * Check if the splits information is already stored in browser LocalStorage.
188
+ * In this function we could add more code to check if the data is valid.
189
+ * @override
190
+ */
191
+ SplitsCacheInLocal.prototype.checkCache = function () {
192
+ return this.getChangeNumber() > -1;
193
+ };
186
194
  /**
187
195
  * Clean Splits cache if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
188
196
  *
@@ -205,7 +213,7 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
205
213
  // mark cache to update the new query filter on first successful splits fetch
206
214
  this.updateNewFilter = true;
207
215
  // if there is cache, clear it
208
- if (this.getChangeNumber() > -1)
216
+ if (this.checkCache())
209
217
  this.clear();
210
218
  }
211
219
  catch (e) {
@@ -11,7 +11,7 @@ import { SplitsCacheInMemory } from '../inMemory/SplitsCacheInMemory';
11
11
  import { DEFAULT_CACHE_EXPIRATION_IN_MILLIS } from '../../utils/constants/browser';
12
12
  import { InMemoryStorageCSFactory } from '../inMemory/InMemoryStorageCS';
13
13
  import { LOG_PREFIX } from './constants';
14
- import { DEBUG, LOCALHOST_MODE, NONE, STORAGE_LOCALSTORAGE } from '../../utils/constants';
14
+ import { DEBUG, NONE, STORAGE_LOCALSTORAGE } from '../../utils/constants';
15
15
  import { shouldRecordTelemetry, TelemetryCacheInMemory } from '../inMemory/TelemetryCacheInMemory';
16
16
  import { UniqueKeysCacheInMemoryCS } from '../inMemory/UniqueKeysCacheInMemoryCS';
17
17
  import { getMatching } from '../../utils/key';
@@ -27,7 +27,7 @@ export function InLocalStorage(options) {
27
27
  params.settings.log.warn(LOG_PREFIX + 'LocalStorage API is unavailable. Falling back to default MEMORY storage');
28
28
  return InMemoryStorageCSFactory(params);
29
29
  }
30
- var onReadyFromCacheCb = params.onReadyFromCacheCb, settings = params.settings, _a = params.settings, log = _a.log, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__splitFiltersValidation;
30
+ var settings = params.settings, _a = params.settings, log = _a.log, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__splitFiltersValidation;
31
31
  var matchingKey = getMatching(settings.core.key);
32
32
  var keys = new KeyBuilderCS(prefix, matchingKey);
33
33
  var expirationTimestamp = Date.now() - DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
@@ -43,11 +43,6 @@ export function InLocalStorage(options) {
43
43
  events: new EventsCacheInMemory(eventsQueueSize),
44
44
  telemetry: shouldRecordTelemetry(params) ? new TelemetryCacheInMemory(splits, segments) : undefined,
45
45
  uniqueKeys: impressionsMode === NONE ? new UniqueKeysCacheInMemoryCS() : undefined,
46
- init: function () {
47
- if (settings.mode === LOCALHOST_MODE || splits.getChangeNumber() > -1) {
48
- Promise.resolve().then(onReadyFromCacheCb);
49
- }
50
- },
51
46
  destroy: function () {
52
47
  var _a;
53
48
  this.splits = new SplitsCacheInMemory(__splitFiltersValidation);
@@ -6,15 +6,13 @@ import { ImpressionCountsCacheInMemory } from './ImpressionCountsCacheInMemory';
6
6
  import { DEBUG, LOCALHOST_MODE, NONE, STORAGE_MEMORY } from '../../utils/constants';
7
7
  import { shouldRecordTelemetry, TelemetryCacheInMemory } from './TelemetryCacheInMemory';
8
8
  import { UniqueKeysCacheInMemoryCS } from './UniqueKeysCacheInMemoryCS';
9
- import { getMatching } from '../../utils/key';
10
- import { loadData } from '../dataLoader';
11
9
  /**
12
10
  * InMemory storage factory for standalone client-side SplitFactory
13
11
  *
14
12
  * @param params parameters required by EventsCacheSync
15
13
  */
16
14
  export function InMemoryStorageCSFactory(params) {
17
- var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__splitFiltersValidation, preloadedData = _a.preloadedData, onReadyFromCacheCb = params.onReadyFromCacheCb;
15
+ var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__splitFiltersValidation;
18
16
  var splits = new SplitsCacheInMemory(__splitFiltersValidation);
19
17
  var segments = new MySegmentsCacheInMemory();
20
18
  var largeSegments = new MySegmentsCacheInMemory();
@@ -38,16 +36,11 @@ export function InMemoryStorageCSFactory(params) {
38
36
  this.uniqueKeys && this.uniqueKeys.clear();
39
37
  },
40
38
  // When using shared instanciation with MEMORY we reuse everything but segments (they are unique per key)
41
- shared: function (matchingKey) {
42
- var segments = new MySegmentsCacheInMemory();
43
- var largeSegments = new MySegmentsCacheInMemory();
44
- if (preloadedData) {
45
- loadData(preloadedData, { segments: segments, largeSegments: largeSegments }, matchingKey);
46
- }
39
+ shared: function () {
47
40
  return {
48
41
  splits: this.splits,
49
- segments: segments,
50
- largeSegments: largeSegments,
42
+ segments: new MySegmentsCacheInMemory(),
43
+ largeSegments: new MySegmentsCacheInMemory(),
51
44
  impressions: this.impressions,
52
45
  impressionCounts: this.impressionCounts,
53
46
  events: this.events,
@@ -62,7 +55,7 @@ export function InMemoryStorageCSFactory(params) {
62
55
  },
63
56
  };
64
57
  // @TODO revisit storage logic in localhost mode
65
- // No tracking data in localhost mode to avoid memory leaks
58
+ // No tracking in localhost mode to avoid memory leaks: https://github.com/splitio/javascript-commons/issues/181
66
59
  if (params.settings.mode === LOCALHOST_MODE) {
67
60
  var noopTrack = function () { return true; };
68
61
  storage.impressions.track = noopTrack;
@@ -72,11 +65,6 @@ export function InMemoryStorageCSFactory(params) {
72
65
  if (storage.uniqueKeys)
73
66
  storage.uniqueKeys.track = noopTrack;
74
67
  }
75
- if (preloadedData) {
76
- loadData(preloadedData, storage, getMatching(params.settings.core.key));
77
- if (splits.getChangeNumber() > -1)
78
- onReadyFromCacheCb();
79
- }
80
68
  return storage;
81
69
  }
82
70
  InMemoryStorageCSFactory.type = STORAGE_MEMORY;
@@ -1,5 +1,5 @@
1
1
  import { __extends } from "tslib";
2
- import { AbstractSegmentsCacheSync } from '../AbstractSegmentsCacheSync';
2
+ import { AbstractMySegmentsCacheSync } from '../AbstractMySegmentsCacheSync';
3
3
  /**
4
4
  * Default MySegmentsCacheInMemory implementation that stores MySegments in memory.
5
5
  * Supported by all JS runtimes.
@@ -11,13 +11,13 @@ var MySegmentsCacheInMemory = /** @class */ (function (_super) {
11
11
  _this.segmentCache = {};
12
12
  return _this;
13
13
  }
14
- MySegmentsCacheInMemory.prototype.addToSegment = function (name) {
14
+ MySegmentsCacheInMemory.prototype.addSegment = function (name) {
15
15
  if (this.segmentCache[name])
16
16
  return false;
17
17
  this.segmentCache[name] = true;
18
18
  return true;
19
19
  };
20
- MySegmentsCacheInMemory.prototype.removeFromSegment = function (name) {
20
+ MySegmentsCacheInMemory.prototype.removeSegment = function (name) {
21
21
  if (!this.segmentCache[name])
22
22
  return false;
23
23
  delete this.segmentCache[name];
@@ -26,7 +26,7 @@ var MySegmentsCacheInMemory = /** @class */ (function (_super) {
26
26
  MySegmentsCacheInMemory.prototype.isInSegment = function (name) {
27
27
  return this.segmentCache[name] === true;
28
28
  };
29
- MySegmentsCacheInMemory.prototype.setChangeNumber = function (name, changeNumber) {
29
+ MySegmentsCacheInMemory.prototype.setChangeNumber = function (changeNumber) {
30
30
  this.cn = changeNumber;
31
31
  };
32
32
  MySegmentsCacheInMemory.prototype.getChangeNumber = function () {
@@ -39,5 +39,5 @@ var MySegmentsCacheInMemory = /** @class */ (function (_super) {
39
39
  return 1;
40
40
  };
41
41
  return MySegmentsCacheInMemory;
42
- }(AbstractSegmentsCacheSync));
42
+ }(AbstractMySegmentsCacheSync));
43
43
  export { MySegmentsCacheInMemory };
@@ -1,32 +1,20 @@
1
- import { __extends } from "tslib";
2
- import { AbstractSegmentsCacheSync } from '../AbstractSegmentsCacheSync';
3
1
  import { _Set } from '../../utils/lang/sets';
4
2
  import { isIntegerNumber } from '../../utils/lang';
5
3
  /**
6
- * Default ISplitsCacheSync implementation that stores split definitions in memory.
7
- * Supported by all JS runtimes.
4
+ * Default ISplitsCacheSync implementation for server-side that stores segments definitions in memory.
8
5
  */
9
- var SegmentsCacheInMemory = /** @class */ (function (_super) {
10
- __extends(SegmentsCacheInMemory, _super);
6
+ var SegmentsCacheInMemory = /** @class */ (function () {
11
7
  function SegmentsCacheInMemory() {
12
- var _this = _super !== null && _super.apply(this, arguments) || this;
13
- _this.segmentCache = {};
14
- _this.segmentChangeNumber = {};
15
- return _this;
8
+ this.segmentCache = {};
9
+ this.segmentChangeNumber = {};
16
10
  }
17
- SegmentsCacheInMemory.prototype.addToSegment = function (name, segmentKeys) {
18
- var values = this.segmentCache[name];
19
- var keySet = values ? values : new _Set();
20
- segmentKeys.forEach(function (k) { return keySet.add(k); });
21
- this.segmentCache[name] = keySet;
22
- return true;
23
- };
24
- SegmentsCacheInMemory.prototype.removeFromSegment = function (name, segmentKeys) {
25
- var values = this.segmentCache[name];
26
- var keySet = values ? values : new _Set();
27
- segmentKeys.forEach(function (k) { return keySet.delete(k); });
11
+ SegmentsCacheInMemory.prototype.update = function (name, addedKeys, removedKeys, changeNumber) {
12
+ var keySet = this.segmentCache[name] || new _Set();
13
+ addedKeys.forEach(function (k) { return keySet.add(k); });
14
+ removedKeys.forEach(function (k) { return keySet.delete(k); });
28
15
  this.segmentCache[name] = keySet;
29
- return true;
16
+ this.segmentChangeNumber[name] = changeNumber;
17
+ return addedKeys.length > 0 || removedKeys.length > 0;
30
18
  };
31
19
  SegmentsCacheInMemory.prototype.isInSegment = function (name, key) {
32
20
  var segmentValues = this.segmentCache[name];
@@ -60,14 +48,12 @@ var SegmentsCacheInMemory = /** @class */ (function (_super) {
60
48
  return acum + _this.segmentCache[segmentName].size;
61
49
  }, 0);
62
50
  };
63
- SegmentsCacheInMemory.prototype.setChangeNumber = function (name, changeNumber) {
64
- this.segmentChangeNumber[name] = changeNumber;
65
- return true;
66
- };
67
51
  SegmentsCacheInMemory.prototype.getChangeNumber = function (name) {
68
52
  var value = this.segmentChangeNumber[name];
69
53
  return isIntegerNumber(value) ? value : -1;
70
54
  };
55
+ // No-op. Not used in server-side
56
+ SegmentsCacheInMemory.prototype.resetSegments = function () { return false; };
71
57
  return SegmentsCacheInMemory;
72
- }(AbstractSegmentsCacheSync));
58
+ }());
73
59
  export { SegmentsCacheInMemory };
@@ -4,7 +4,6 @@ import { isFiniteNumber } from '../../utils/lang';
4
4
  import { _Set } from '../../utils/lang/sets';
5
5
  /**
6
6
  * Default ISplitsCacheSync implementation that stores split definitions in memory.
7
- * Supported by all JS runtimes.
8
7
  */
9
8
  var SplitsCacheInMemory = /** @class */ (function (_super) {
10
9
  __extends(SplitsCacheInMemory, _super);
@@ -17,7 +17,7 @@ var DEFAULT_OPTIONS = {
17
17
  var DEFAULT_LIBRARY_OPTIONS = {
18
18
  enableOfflineQueue: false,
19
19
  connectTimeout: DEFAULT_OPTIONS.connectionTimeout,
20
- lazyConnect: false // @TODO true to avoid side-effects on instantiation.
20
+ lazyConnect: false
21
21
  };
22
22
  /**
23
23
  * Redis adapter on top of the library of choice (written with ioredis) for some extra control.
@@ -6,30 +6,24 @@ var SegmentsCacheInRedis = /** @class */ (function () {
6
6
  this.redis = redis;
7
7
  this.keys = keys;
8
8
  }
9
- SegmentsCacheInRedis.prototype.addToSegment = function (name, segmentKeys) {
9
+ /**
10
+ * Update the given segment `name` with the lists of `addedKeys`, `removedKeys` and `changeNumber`.
11
+ * The returned promise is resolved if the operation success, with `true` if the segment was updated (i.e., some key was added or removed),
12
+ * or rejected if it fails (e.g., Redis operation fails).
13
+ */
14
+ SegmentsCacheInRedis.prototype.update = function (name, addedKeys, removedKeys, changeNumber) {
10
15
  var segmentKey = this.keys.buildSegmentNameKey(name);
11
- if (segmentKeys.length) {
12
- return this.redis.sadd(segmentKey, segmentKeys).then(function () { return true; });
13
- }
14
- else {
15
- return Promise.resolve(true);
16
- }
17
- };
18
- SegmentsCacheInRedis.prototype.removeFromSegment = function (name, segmentKeys) {
19
- var segmentKey = this.keys.buildSegmentNameKey(name);
20
- if (segmentKeys.length) {
21
- return this.redis.srem(segmentKey, segmentKeys).then(function () { return true; });
22
- }
23
- else {
24
- return Promise.resolve(true);
25
- }
16
+ return Promise.all([
17
+ addedKeys.length && this.redis.sadd(segmentKey, addedKeys),
18
+ removedKeys.length && this.redis.srem(segmentKey, removedKeys),
19
+ this.redis.set(this.keys.buildSegmentTillKey(name), changeNumber + '')
20
+ ]).then(function () {
21
+ return addedKeys.length > 0 || removedKeys.length > 0;
22
+ });
26
23
  };
27
24
  SegmentsCacheInRedis.prototype.isInSegment = function (name, key) {
28
25
  return this.redis.sismember(this.keys.buildSegmentNameKey(name), key).then(function (matches) { return matches !== 0; });
29
26
  };
30
- SegmentsCacheInRedis.prototype.setChangeNumber = function (name, changeNumber) {
31
- return this.redis.set(this.keys.buildSegmentTillKey(name), changeNumber + '').then(function (status) { return status === 'OK'; });
32
- };
33
27
  SegmentsCacheInRedis.prototype.getChangeNumber = function (name) {
34
28
  var _this = this;
35
29
  return this.redis.get(this.keys.buildSegmentTillKey(name)).then(function (value) {