@splitsoftware/splitio-commons 2.0.0-rc.0 → 2.0.0-rc.2

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 (114) hide show
  1. package/CHANGES.txt +5 -1
  2. package/cjs/evaluator/Engine.js +1 -1
  3. package/cjs/evaluator/index.js +1 -1
  4. package/cjs/readiness/readinessManager.js +13 -2
  5. package/cjs/sdkClient/sdkClientMethodCS.js +0 -1
  6. package/cjs/sdkFactory/index.js +29 -9
  7. package/cjs/storages/{AbstractSegmentsCacheSync.js → AbstractMySegmentsCacheSync.js} +15 -17
  8. package/cjs/storages/dataLoader.js +99 -37
  9. package/cjs/storages/inLocalStorage/MySegmentsCacheInLocal.js +5 -5
  10. package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js +3 -2
  11. package/cjs/storages/inLocalStorage/index.js +1 -1
  12. package/cjs/storages/inMemory/InMemoryStorageCS.js +18 -6
  13. package/cjs/storages/inMemory/MySegmentsCacheInMemory.js +5 -5
  14. package/cjs/storages/inMemory/SegmentsCacheInMemory.js +13 -27
  15. package/cjs/storages/inMemory/SplitsCacheInMemory.js +0 -1
  16. package/cjs/storages/inMemory/UniqueKeysCacheInMemory.js +2 -1
  17. package/cjs/storages/inMemory/UniqueKeysCacheInMemoryCS.js +2 -1
  18. package/cjs/storages/inRedis/RedisAdapter.js +2 -1
  19. package/cjs/storages/inRedis/SegmentsCacheInRedis.js +13 -19
  20. package/cjs/storages/inRedis/UniqueKeysCacheInRedis.js +2 -1
  21. package/cjs/storages/pluggable/SegmentsCachePluggable.js +11 -32
  22. package/cjs/storages/pluggable/UniqueKeysCachePluggable.js +2 -1
  23. package/cjs/storages/pluggable/inMemoryWrapper.js +2 -1
  24. package/cjs/sync/offline/syncManagerOffline.js +18 -11
  25. package/cjs/sync/polling/updaters/segmentChangesUpdater.js +12 -28
  26. package/cjs/sync/polling/updaters/splitChangesUpdater.js +2 -1
  27. package/cjs/sync/syncManagerOnline.js +20 -21
  28. package/cjs/trackers/eventTracker.js +12 -10
  29. package/cjs/trackers/impressionsTracker.js +16 -14
  30. package/cjs/trackers/uniqueKeysTracker.js +5 -3
  31. package/cjs/utils/lang/sets.js +12 -2
  32. package/esm/evaluator/Engine.js +1 -1
  33. package/esm/evaluator/index.js +2 -2
  34. package/esm/readiness/readinessManager.js +13 -2
  35. package/esm/sdkClient/sdkClientMethodCS.js +0 -1
  36. package/esm/sdkFactory/index.js +30 -10
  37. package/esm/storages/{AbstractSegmentsCacheSync.js → AbstractMySegmentsCacheSync.js} +14 -16
  38. package/esm/storages/dataLoader.js +96 -35
  39. package/esm/storages/inLocalStorage/MySegmentsCacheInLocal.js +5 -5
  40. package/esm/storages/inLocalStorage/SplitsCacheInLocal.js +3 -2
  41. package/esm/storages/inLocalStorage/index.js +1 -1
  42. package/esm/storages/inMemory/InMemoryStorageCS.js +18 -6
  43. package/esm/storages/inMemory/MySegmentsCacheInMemory.js +5 -5
  44. package/esm/storages/inMemory/SegmentsCacheInMemory.js +13 -27
  45. package/esm/storages/inMemory/SplitsCacheInMemory.js +0 -1
  46. package/esm/storages/inMemory/UniqueKeysCacheInMemory.js +2 -1
  47. package/esm/storages/inMemory/UniqueKeysCacheInMemoryCS.js +2 -1
  48. package/esm/storages/inRedis/RedisAdapter.js +2 -1
  49. package/esm/storages/inRedis/SegmentsCacheInRedis.js +13 -19
  50. package/esm/storages/inRedis/UniqueKeysCacheInRedis.js +2 -1
  51. package/esm/storages/pluggable/SegmentsCachePluggable.js +11 -32
  52. package/esm/storages/pluggable/UniqueKeysCachePluggable.js +2 -1
  53. package/esm/storages/pluggable/inMemoryWrapper.js +2 -1
  54. package/esm/sync/offline/syncManagerOffline.js +18 -11
  55. package/esm/sync/polling/updaters/segmentChangesUpdater.js +12 -28
  56. package/esm/sync/polling/updaters/splitChangesUpdater.js +2 -1
  57. package/esm/sync/syncManagerOnline.js +20 -21
  58. package/esm/trackers/eventTracker.js +12 -10
  59. package/esm/trackers/impressionsTracker.js +16 -14
  60. package/esm/trackers/uniqueKeysTracker.js +5 -3
  61. package/esm/utils/lang/sets.js +10 -1
  62. package/package.json +1 -1
  63. package/src/evaluator/Engine.ts +1 -1
  64. package/src/evaluator/index.ts +2 -2
  65. package/src/readiness/readinessManager.ts +12 -3
  66. package/src/readiness/types.ts +3 -0
  67. package/src/sdkClient/sdkClientMethodCS.ts +0 -2
  68. package/src/sdkFactory/index.ts +34 -12
  69. package/src/sdkFactory/types.ts +2 -0
  70. package/src/storages/{AbstractSegmentsCacheSync.ts → AbstractMySegmentsCacheSync.ts} +13 -28
  71. package/src/storages/dataLoader.ts +97 -38
  72. package/src/storages/inLocalStorage/MySegmentsCacheInLocal.ts +5 -5
  73. package/src/storages/inLocalStorage/SplitsCacheInLocal.ts +3 -2
  74. package/src/storages/inLocalStorage/index.ts +1 -1
  75. package/src/storages/inMemory/InMemoryStorageCS.ts +21 -6
  76. package/src/storages/inMemory/MySegmentsCacheInMemory.ts +5 -5
  77. package/src/storages/inMemory/SegmentsCacheInMemory.ts +12 -26
  78. package/src/storages/inMemory/SplitsCacheInMemory.ts +0 -1
  79. package/src/storages/inMemory/UniqueKeysCacheInMemory.ts +2 -1
  80. package/src/storages/inMemory/UniqueKeysCacheInMemoryCS.ts +2 -1
  81. package/src/storages/inRedis/RedisAdapter.ts +2 -1
  82. package/src/storages/inRedis/SegmentsCacheInRedis.ts +13 -22
  83. package/src/storages/inRedis/UniqueKeysCacheInRedis.ts +2 -1
  84. package/src/storages/pluggable/SegmentsCachePluggable.ts +11 -35
  85. package/src/storages/pluggable/UniqueKeysCachePluggable.ts +2 -1
  86. package/src/storages/pluggable/inMemoryWrapper.ts +2 -1
  87. package/src/storages/types.ts +7 -11
  88. package/src/sync/offline/syncManagerOffline.ts +21 -13
  89. package/src/sync/polling/updaters/segmentChangesUpdater.ts +13 -29
  90. package/src/sync/polling/updaters/splitChangesUpdater.ts +2 -1
  91. package/src/sync/syncManagerOnline.ts +17 -17
  92. package/src/sync/types.ts +1 -1
  93. package/src/trackers/eventTracker.ts +11 -8
  94. package/src/trackers/impressionsTracker.ts +13 -10
  95. package/src/trackers/types.ts +1 -0
  96. package/src/trackers/uniqueKeysTracker.ts +6 -4
  97. package/src/types.ts +14 -13
  98. package/src/utils/lang/sets.ts +11 -1
  99. package/types/readiness/types.d.ts +3 -0
  100. package/types/sdkFactory/types.d.ts +1 -0
  101. package/types/storages/dataLoader.d.ts +17 -6
  102. package/types/storages/inLocalStorage/MySegmentsCacheInLocal.d.ts +5 -5
  103. package/types/storages/inMemory/MySegmentsCacheInMemory.d.ts +5 -5
  104. package/types/storages/inMemory/SegmentsCacheInMemory.d.ts +5 -7
  105. package/types/storages/inMemory/SplitsCacheInMemory.d.ts +0 -1
  106. package/types/storages/inRedis/SegmentsCacheInRedis.d.ts +6 -3
  107. package/types/storages/pluggable/SegmentsCachePluggable.d.ts +4 -16
  108. package/types/storages/types.d.ts +7 -10
  109. package/types/sync/types.d.ts +1 -1
  110. package/types/trackers/eventTracker.d.ts +1 -1
  111. package/types/trackers/impressionsTracker.d.ts +1 -1
  112. package/types/trackers/types.d.ts +1 -0
  113. package/types/types.d.ts +13 -13
  114. package/types/utils/lang/sets.d.ts +1 -0
@@ -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 } from '../readiness/constants';
8
+ import { SDK_SPLITS_ARRIVED, SDK_SEGMENTS_ARRIVED, SDK_SPLITS_CACHE_LOADED } 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,12 +16,19 @@ 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;
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
- // We will just log and allow for the SDK to end up throwing an SDK_TIMEOUT event for devs to handle.
24
- validateAndTrackApiKey(log, settings.core.authorizationKey);
23
+ // initialization
24
+ var hasInit = false;
25
+ var initCallbacks = [];
26
+ function whenInit(cb) {
27
+ if (hasInit)
28
+ cb();
29
+ else
30
+ initCallbacks.push(cb);
31
+ }
25
32
  var sdkReadinessManager = sdkReadinessManagerFactory(platform.EventEmitter, settings);
26
33
  var readiness = sdkReadinessManager.readinessManager;
27
34
  var storage = storageFactory({
@@ -35,8 +42,10 @@ export function sdkFactory(params) {
35
42
  readiness.splits.emit(SDK_SPLITS_ARRIVED);
36
43
  readiness.segments.emit(SDK_SEGMENTS_ARRIVED);
37
44
  },
45
+ onReadyFromCacheCb: function () {
46
+ readiness.splits.emit(SDK_SPLITS_CACHE_LOADED);
47
+ }
38
48
  });
39
- // @TODO add support for dataloader: `if (params.dataLoader) params.dataLoader(storage);`
40
49
  var clients = {};
41
50
  var telemetryTracker = telemetryTrackerFactory(storage.telemetry, platform.now);
42
51
  var integrationsManager = integrationsManagerFactory && integrationsManagerFactory({ settings: settings, storage: storage, telemetryTracker: telemetryTracker });
@@ -53,8 +62,8 @@ export function sdkFactory(params) {
53
62
  default:
54
63
  strategy = strategyDebugFactory(observer);
55
64
  }
56
- var impressionsTracker = impressionsTrackerFactory(settings, storage.impressions, strategy, integrationsManager, storage.telemetry);
57
- var eventTracker = eventTrackerFactory(settings, storage.events, integrationsManager, storage.telemetry);
65
+ var impressionsTracker = impressionsTrackerFactory(settings, storage.impressions, strategy, whenInit, integrationsManager, storage.telemetry);
66
+ var eventTracker = eventTrackerFactory(settings, storage.events, whenInit, integrationsManager, storage.telemetry);
58
67
  // splitApi is used by SyncManager and Browser signal listener
59
68
  var splitApi = splitApiFactory && splitApiFactory(settings, platform, telemetryTracker);
60
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 };
@@ -65,8 +74,19 @@ export function sdkFactory(params) {
65
74
  // SDK client and manager
66
75
  var clientMethod = sdkClientMethodFactory(ctx);
67
76
  var managerInstance = sdkManagerFactory(settings, storage.splits, sdkReadinessManager);
68
- syncManager && syncManager.start();
69
- signalListener && signalListener.start();
77
+ function init() {
78
+ if (hasInit)
79
+ return;
80
+ hasInit = true;
81
+ // We will just log and allow for the SDK to end up throwing an SDK_TIMEOUT event for devs to handle.
82
+ validateAndTrackApiKey(log, settings.core.authorizationKey);
83
+ readiness.init();
84
+ uniqueKeysTracker && uniqueKeysTracker.start();
85
+ syncManager && syncManager.start();
86
+ signalListener && signalListener.start();
87
+ initCallbacks.forEach(function (cb) { return cb(); });
88
+ initCallbacks.length = 0;
89
+ }
70
90
  log.info(NEW_FACTORY);
71
91
  // @ts-ignore
72
92
  return objectAssign({
@@ -83,5 +103,5 @@ export function sdkFactory(params) {
83
103
  destroy: function () {
84
104
  return Promise.all(Object.keys(clients).map(function (key) { return clients[key].destroy(); })).then(function () { });
85
105
  }
86
- }, extraProps && extraProps(ctx));
106
+ }, extraProps && extraProps(ctx), lazyInit ? { init: init } : init());
87
107
  }
@@ -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 };
@@ -1,47 +1,108 @@
1
- import { DEFAULT_CACHE_EXPIRATION_IN_MILLIS } from '../utils/constants/browser';
1
+ import { setToArray } from '../utils/lang/sets';
2
+ import { getMatching } from '../utils/key';
2
3
  /**
3
- * Factory of client-side storage loader
4
+ * Storage-agnostic adaptation of `loadDataIntoLocalStorage` function
5
+ * (https://github.com/godaddy/split-javascript-data-loader/blob/master/src/load-data.js)
4
6
  *
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
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
8
15
  */
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;
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) {
25
22
  var storedSince = storage.splits.getChangeNumber();
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)
23
+ // Do not load data if current data is more recent
24
+ if (storedSince > since)
30
25
  return;
31
26
  // cleaning up the localStorage data, since some cached splits might need be part of the preloaded data
32
27
  storage.splits.clear();
33
28
  storage.splits.setChangeNumber(since);
34
29
  // splitsData in an object where the property is the split name and the pertaining value is a stringified json of its data
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];
38
- if (!mySegmentsData) {
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
40
- mySegmentsData = Object.keys(segmentsData).filter(function (segmentName) {
41
- var userIds = JSON.parse(segmentsData[segmentName]).added;
42
- return Array.isArray(userIds) && userIds.indexOf(userId) > -1;
43
- });
30
+ storage.splits.addSplits(splitsData.map(function (split) { return ([split.name, split]); }));
31
+ }
32
+ if (matchingKey) { // add mySegments data (client-side)
33
+ var membershipsData = preloadedData.membershipsData && preloadedData.membershipsData[matchingKey];
34
+ if (!membershipsData && segmentsData) {
35
+ membershipsData = {
36
+ ms: {
37
+ k: Object.keys(segmentsData).filter(function (segmentName) {
38
+ var segmentKeys = segmentsData[segmentName];
39
+ return segmentKeys.indexOf(matchingKey) > -1;
40
+ }).map(function (segmentName) { return ({ n: segmentName }); })
41
+ }
42
+ };
44
43
  }
45
- storage.segments.resetSegments({ k: mySegmentsData.map(function (s) { return ({ n: s }); }) });
44
+ if (membershipsData) {
45
+ if (membershipsData.ms)
46
+ storage.segments.resetSegments(membershipsData.ms);
47
+ if (membershipsData.ls && storage.largeSegments)
48
+ storage.largeSegments.resetSegments(membershipsData.ls);
49
+ }
50
+ }
51
+ else { // add segments data (server-side)
52
+ Object.keys(segmentsData).forEach(function (segmentName) {
53
+ var segmentKeys = segmentsData[segmentName];
54
+ storage.segments.update(segmentName, segmentKeys, [], -1);
55
+ });
56
+ }
57
+ }
58
+ export function getSnapshot(storage, userKeys) {
59
+ return {
60
+ // lastUpdated: Date.now(),
61
+ since: storage.splits.getChangeNumber(),
62
+ splitsData: storage.splits.getAll(),
63
+ segmentsData: userKeys ?
64
+ undefined : // @ts-ignore accessing private prop
65
+ Object.keys(storage.segments.segmentCache).reduce(function (prev, cur) {
66
+ prev[cur] = setToArray(storage.segments.segmentCache[cur]);
67
+ return prev;
68
+ }, {}),
69
+ membershipsData: userKeys ?
70
+ userKeys.reduce(function (prev, userKey) {
71
+ if (storage.shared) {
72
+ // Client-side segments
73
+ // @ts-ignore accessing private prop
74
+ var sharedStorage = storage.shared(userKey);
75
+ prev[getMatching(userKey)] = {
76
+ ms: {
77
+ // @ts-ignore accessing private prop
78
+ k: Object.keys(sharedStorage.segments.segmentCache).map(function (segmentName) { return ({ n: segmentName }); }),
79
+ // cn: sharedStorage.segments.getChangeNumber()
80
+ },
81
+ ls: sharedStorage.largeSegments ? {
82
+ // @ts-ignore accessing private prop
83
+ k: Object.keys(sharedStorage.largeSegments.segmentCache).map(function (segmentName) { return ({ n: segmentName }); }),
84
+ // cn: sharedStorage.largeSegments.getChangeNumber()
85
+ } : undefined
86
+ };
87
+ }
88
+ else {
89
+ prev[getMatching(userKey)] = {
90
+ ms: {
91
+ // Server-side segments
92
+ // @ts-ignore accessing private prop
93
+ k: Object.keys(storage.segments.segmentCache).reduce(function (prev, segmentName) {
94
+ return storage.segments.segmentCache[segmentName].has(userKey) ?
95
+ prev.concat({ n: segmentName }) :
96
+ prev;
97
+ }, [])
98
+ },
99
+ ls: {
100
+ k: []
101
+ }
102
+ };
103
+ }
104
+ return prev;
105
+ }, {}) :
106
+ undefined
46
107
  };
47
108
  }
@@ -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)
@@ -53,7 +53,7 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
53
53
  MySegmentsCacheInLocal.prototype.getKeysCount = function () {
54
54
  return 1;
55
55
  };
56
- MySegmentsCacheInLocal.prototype.setChangeNumber = function (name, changeNumber) {
56
+ MySegmentsCacheInLocal.prototype.setChangeNumber = function (changeNumber) {
57
57
  try {
58
58
  if (changeNumber)
59
59
  localStorage.setItem(this.keys.buildTillKey(), changeNumber + '');
@@ -74,5 +74,5 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
74
74
  return n;
75
75
  };
76
76
  return MySegmentsCacheInLocal;
77
- }(AbstractSegmentsCacheSync));
77
+ }(AbstractMySegmentsCacheSync));
78
78
  export { MySegmentsCacheInLocal };
@@ -3,6 +3,7 @@ import { AbstractSplitsCacheSync, usesSegments } from '../AbstractSplitsCacheSyn
3
3
  import { isFiniteNumber, toNumber, isNaNNumber } from '../../utils/lang';
4
4
  import { LOG_PREFIX } from './constants';
5
5
  import { getStorageHash } from '../KeyBuilder';
6
+ import { setToArray } from '../../utils/lang/sets';
6
7
  /**
7
8
  * ISplitsCacheSync implementation that stores split definitions in browser LocalStorage.
8
9
  */
@@ -240,7 +241,7 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
240
241
  var flagSetFromLocalStorage = localStorage.getItem(flagSetKey);
241
242
  var flagSetCache = new Set(flagSetFromLocalStorage ? JSON.parse(flagSetFromLocalStorage) : []);
242
243
  flagSetCache.add(featureFlag.name);
243
- localStorage.setItem(flagSetKey, JSON.stringify(Array.from(flagSetCache)));
244
+ localStorage.setItem(flagSetKey, JSON.stringify(setToArray(flagSetCache)));
244
245
  });
245
246
  };
246
247
  SplitsCacheInLocal.prototype.removeFromFlagSets = function (featureFlagName, flagSets) {
@@ -262,7 +263,7 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
262
263
  localStorage.removeItem(flagSetKey);
263
264
  return;
264
265
  }
265
- localStorage.setItem(flagSetKey, JSON.stringify(Array.from(flagSetCache)));
266
+ localStorage.setItem(flagSetKey, JSON.stringify(setToArray(flagSetCache)));
266
267
  };
267
268
  return SplitsCacheInLocal;
268
269
  }(AbstractSplitsCacheSync));
@@ -53,7 +53,7 @@ export function InLocalStorage(options) {
53
53
  this.events.clear();
54
54
  (_a = this.uniqueKeys) === null || _a === void 0 ? void 0 : _a.clear();
55
55
  },
56
- // When using shared instanciation with MEMORY we reuse everything but segments (they are customer per key).
56
+ // When using shared instantiation with MEMORY we reuse everything but segments (they are customer per key).
57
57
  shared: function (matchingKey) {
58
58
  return {
59
59
  splits: this.splits,
@@ -6,13 +6,15 @@ 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';
9
11
  /**
10
12
  * InMemory storage factory for standalone client-side SplitFactory
11
13
  *
12
14
  * @param params parameters required by EventsCacheSync
13
15
  */
14
16
  export function InMemoryStorageCSFactory(params) {
15
- var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__splitFiltersValidation;
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;
16
18
  var splits = new SplitsCacheInMemory(__splitFiltersValidation);
17
19
  var segments = new MySegmentsCacheInMemory();
18
20
  var largeSegments = new MySegmentsCacheInMemory();
@@ -35,12 +37,17 @@ export function InMemoryStorageCSFactory(params) {
35
37
  this.events.clear();
36
38
  this.uniqueKeys && this.uniqueKeys.clear();
37
39
  },
38
- // When using shared instanciation with MEMORY we reuse everything but segments (they are unique per key)
39
- shared: function () {
40
+ // When using shared instantiation 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
+ }
40
47
  return {
41
48
  splits: this.splits,
42
- segments: new MySegmentsCacheInMemory(),
43
- largeSegments: new MySegmentsCacheInMemory(),
49
+ segments: segments,
50
+ largeSegments: largeSegments,
44
51
  impressions: this.impressions,
45
52
  impressionCounts: this.impressionCounts,
46
53
  events: this.events,
@@ -55,7 +62,7 @@ export function InMemoryStorageCSFactory(params) {
55
62
  },
56
63
  };
57
64
  // @TODO revisit storage logic in localhost mode
58
- // No tracking data in localhost mode to avoid memory leaks
65
+ // No tracking in localhost mode to avoid memory leaks: https://github.com/splitio/javascript-commons/issues/181
59
66
  if (params.settings.mode === LOCALHOST_MODE) {
60
67
  var noopTrack = function () { return true; };
61
68
  storage.impressions.track = noopTrack;
@@ -65,6 +72,11 @@ export function InMemoryStorageCSFactory(params) {
65
72
  if (storage.uniqueKeys)
66
73
  storage.uniqueKeys.track = noopTrack;
67
74
  }
75
+ if (preloadedData) {
76
+ loadData(preloadedData, storage, getMatching(params.settings.core.key));
77
+ if (splits.getChangeNumber() > -1)
78
+ onReadyFromCacheCb();
79
+ }
68
80
  return storage;
69
81
  }
70
82
  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,31 +1,19 @@
1
- import { __extends } from "tslib";
2
- import { AbstractSegmentsCacheSync } from '../AbstractSegmentsCacheSync';
3
1
  import { isIntegerNumber } from '../../utils/lang';
4
2
  /**
5
- * Default ISplitsCacheSync implementation that stores split definitions in memory.
6
- * Supported by all JS runtimes.
3
+ * Default ISplitsCacheSync implementation for server-side that stores segments definitions in memory.
7
4
  */
8
- var SegmentsCacheInMemory = /** @class */ (function (_super) {
9
- __extends(SegmentsCacheInMemory, _super);
5
+ var SegmentsCacheInMemory = /** @class */ (function () {
10
6
  function SegmentsCacheInMemory() {
11
- var _this = _super !== null && _super.apply(this, arguments) || this;
12
- _this.segmentCache = {};
13
- _this.segmentChangeNumber = {};
14
- return _this;
7
+ this.segmentCache = {};
8
+ this.segmentChangeNumber = {};
15
9
  }
16
- SegmentsCacheInMemory.prototype.addToSegment = function (name, segmentKeys) {
17
- var values = this.segmentCache[name];
18
- var keySet = values ? values : new Set();
19
- segmentKeys.forEach(function (k) { return keySet.add(k); });
20
- this.segmentCache[name] = keySet;
21
- return true;
22
- };
23
- SegmentsCacheInMemory.prototype.removeFromSegment = function (name, segmentKeys) {
24
- var values = this.segmentCache[name];
25
- var keySet = values ? values : new Set();
26
- segmentKeys.forEach(function (k) { return keySet.delete(k); });
10
+ SegmentsCacheInMemory.prototype.update = function (name, addedKeys, removedKeys, changeNumber) {
11
+ var keySet = this.segmentCache[name] || new Set();
12
+ addedKeys.forEach(function (k) { return keySet.add(k); });
13
+ removedKeys.forEach(function (k) { return keySet.delete(k); });
27
14
  this.segmentCache[name] = keySet;
28
- return true;
15
+ this.segmentChangeNumber[name] = changeNumber;
16
+ return addedKeys.length > 0 || removedKeys.length > 0;
29
17
  };
30
18
  SegmentsCacheInMemory.prototype.isInSegment = function (name, key) {
31
19
  var segmentValues = this.segmentCache[name];
@@ -59,14 +47,12 @@ var SegmentsCacheInMemory = /** @class */ (function (_super) {
59
47
  return acum + _this.segmentCache[segmentName].size;
60
48
  }, 0);
61
49
  };
62
- SegmentsCacheInMemory.prototype.setChangeNumber = function (name, changeNumber) {
63
- this.segmentChangeNumber[name] = changeNumber;
64
- return true;
65
- };
66
50
  SegmentsCacheInMemory.prototype.getChangeNumber = function (name) {
67
51
  var value = this.segmentChangeNumber[name];
68
52
  return isIntegerNumber(value) ? value : -1;
69
53
  };
54
+ // No-op. Not used in server-side
55
+ SegmentsCacheInMemory.prototype.resetSegments = function () { return false; };
70
56
  return SegmentsCacheInMemory;
71
- }(AbstractSegmentsCacheSync));
57
+ }());
72
58
  export { SegmentsCacheInMemory };
@@ -3,7 +3,6 @@ import { AbstractSplitsCacheSync, usesSegments } from '../AbstractSplitsCacheSyn
3
3
  import { isFiniteNumber } from '../../utils/lang';
4
4
  /**
5
5
  * Default ISplitsCacheSync implementation that stores split definitions in memory.
6
- * Supported by all JS runtimes.
7
6
  */
8
7
  var SplitsCacheInMemory = /** @class */ (function (_super) {
9
8
  __extends(SplitsCacheInMemory, _super);
@@ -1,4 +1,5 @@
1
1
  import { DEFAULT_CACHE_SIZE } from '../inRedis/constants';
2
+ import { setToArray } from '../../utils/lang/sets';
2
3
  /**
3
4
  * Converts `uniqueKeys` data from cache into request payload for SS.
4
5
  */
@@ -7,7 +8,7 @@ export function fromUniqueKeysCollector(uniqueKeys) {
7
8
  var featureNames = Object.keys(uniqueKeys);
8
9
  for (var i = 0; i < featureNames.length; i++) {
9
10
  var featureName = featureNames[i];
10
- var userKeys = Array.from(uniqueKeys[featureName]);
11
+ var userKeys = setToArray(uniqueKeys[featureName]);
11
12
  var uniqueKeysPayload = {
12
13
  f: featureName,
13
14
  ks: userKeys
@@ -1,4 +1,5 @@
1
1
  import { DEFAULT_CACHE_SIZE } from '../inRedis/constants';
2
+ import { setToArray } from '../../utils/lang/sets';
2
3
  var UniqueKeysCacheInMemoryCS = /** @class */ (function () {
3
4
  /**
4
5
  *
@@ -58,7 +59,7 @@ var UniqueKeysCacheInMemoryCS = /** @class */ (function () {
58
59
  var userKeys = Object.keys(uniqueKeys);
59
60
  for (var k = 0; k < userKeys.length; k++) {
60
61
  var userKey = userKeys[k];
61
- var featureNames = Array.from(uniqueKeys[userKey]);
62
+ var featureNames = setToArray(uniqueKeys[userKey]);
62
63
  var uniqueKeysPayload = {
63
64
  k: userKey,
64
65
  fs: featureNames
@@ -3,6 +3,7 @@ import ioredis from 'ioredis';
3
3
  import { merge, isString } from '../../utils/lang';
4
4
  import { thenable } from '../../utils/promise/thenable';
5
5
  import { timeout } from '../../utils/promise/timeout';
6
+ import { setToArray } from '../../utils/lang/sets';
6
7
  var LOG_PREFIX = 'storage:redis-adapter: ';
7
8
  // If we ever decide to fully wrap every method, there's a Commander.getBuiltinCommands from ioredis.
8
9
  var METHODS_TO_PROMISE_WRAP = ['set', 'exec', 'del', 'get', 'keys', 'sadd', 'srem', 'sismember', 'smembers', 'incr', 'rpush', 'expire', 'mget', 'lrange', 'ltrim', 'hset', 'hincrby', 'popNRaw'];
@@ -125,7 +126,7 @@ var RedisAdapter = /** @class */ (function (_super) {
125
126
  setTimeout(function deferredDisconnect() {
126
127
  if (instance._runningCommands.size > 0) {
127
128
  instance.log.info(LOG_PREFIX + ("Attempting to disconnect but there are " + instance._runningCommands.size + " commands still waiting for resolution. Defering disconnection until those finish."));
128
- Promise.all(Array.from(instance._runningCommands))
129
+ Promise.all(setToArray(instance._runningCommands))
129
130
  .then(function () {
130
131
  instance.log.debug(LOG_PREFIX + 'Pending commands finished successfully, disconnecting.');
131
132
  originalMethod.apply(instance, params);
@@ -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) {