@splitsoftware/splitio-commons 1.17.1-rc.2 → 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 (108) hide show
  1. package/CHANGES.txt +4 -3
  2. package/cjs/readiness/readinessManager.js +13 -2
  3. package/cjs/sdkClient/sdkClientMethodCS.js +0 -1
  4. package/cjs/sdkClient/sdkClientMethodCSWithTT.js +0 -1
  5. package/cjs/sdkFactory/index.js +27 -11
  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 -65
  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 -4
  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/SegmentsCacheInRedis.js +13 -19
  18. package/cjs/storages/pluggable/SegmentsCachePluggable.js +11 -32
  19. package/cjs/sync/offline/syncManagerOffline.js +18 -11
  20. package/cjs/sync/offline/syncTasks/fromObjectSyncTask.js +7 -2
  21. package/cjs/sync/polling/pollingManagerSS.js +3 -3
  22. package/cjs/sync/polling/updaters/segmentChangesUpdater.js +12 -28
  23. package/cjs/sync/polling/updaters/splitChangesUpdater.js +10 -1
  24. package/cjs/sync/syncManagerOnline.js +20 -21
  25. package/cjs/trackers/eventTracker.js +12 -10
  26. package/cjs/trackers/impressionsTracker.js +16 -14
  27. package/cjs/trackers/uniqueKeysTracker.js +5 -3
  28. package/cjs/utils/settingsValidation/storage/storageCS.js +12 -1
  29. package/esm/readiness/readinessManager.js +13 -2
  30. package/esm/sdkClient/sdkClientMethodCS.js +0 -1
  31. package/esm/sdkClient/sdkClientMethodCSWithTT.js +0 -1
  32. package/esm/sdkFactory/index.js +28 -12
  33. package/esm/storages/{AbstractSegmentsCacheSync.js → AbstractMySegmentsCacheSync.js} +14 -16
  34. package/esm/storages/AbstractSplitsCacheAsync.js +7 -0
  35. package/esm/storages/AbstractSplitsCacheSync.js +7 -0
  36. package/esm/storages/dataLoader.js +30 -62
  37. package/esm/storages/inLocalStorage/MySegmentsCacheInLocal.js +5 -5
  38. package/esm/storages/inLocalStorage/SplitsCacheInLocal.js +9 -1
  39. package/esm/storages/inLocalStorage/index.js +2 -5
  40. package/esm/storages/inMemory/InMemoryStorageCS.js +5 -17
  41. package/esm/storages/inMemory/MySegmentsCacheInMemory.js +5 -5
  42. package/esm/storages/inMemory/SegmentsCacheInMemory.js +13 -27
  43. package/esm/storages/inMemory/SplitsCacheInMemory.js +0 -1
  44. package/esm/storages/inRedis/SegmentsCacheInRedis.js +13 -19
  45. package/esm/storages/pluggable/SegmentsCachePluggable.js +11 -32
  46. package/esm/sync/offline/syncManagerOffline.js +18 -11
  47. package/esm/sync/offline/syncTasks/fromObjectSyncTask.js +8 -3
  48. package/esm/sync/polling/pollingManagerSS.js +3 -3
  49. package/esm/sync/polling/updaters/segmentChangesUpdater.js +12 -28
  50. package/esm/sync/polling/updaters/splitChangesUpdater.js +11 -2
  51. package/esm/sync/syncManagerOnline.js +20 -21
  52. package/esm/trackers/eventTracker.js +12 -10
  53. package/esm/trackers/impressionsTracker.js +16 -14
  54. package/esm/trackers/uniqueKeysTracker.js +5 -3
  55. package/esm/utils/settingsValidation/storage/storageCS.js +10 -0
  56. package/package.json +1 -1
  57. package/src/readiness/readinessManager.ts +12 -3
  58. package/src/readiness/types.ts +3 -0
  59. package/src/sdkClient/sdkClientMethodCS.ts +0 -2
  60. package/src/sdkClient/sdkClientMethodCSWithTT.ts +0 -2
  61. package/src/sdkFactory/index.ts +30 -14
  62. package/src/sdkFactory/types.ts +2 -0
  63. package/src/storages/{AbstractSegmentsCacheSync.ts → AbstractMySegmentsCacheSync.ts} +13 -28
  64. package/src/storages/AbstractSplitsCacheAsync.ts +8 -0
  65. package/src/storages/AbstractSplitsCacheSync.ts +8 -0
  66. package/src/storages/dataLoader.ts +32 -63
  67. package/src/storages/inLocalStorage/MySegmentsCacheInLocal.ts +5 -5
  68. package/src/storages/inLocalStorage/SplitsCacheInLocal.ts +10 -1
  69. package/src/storages/inLocalStorage/index.ts +2 -6
  70. package/src/storages/inMemory/InMemoryStorageCS.ts +5 -20
  71. package/src/storages/inMemory/MySegmentsCacheInMemory.ts +5 -5
  72. package/src/storages/inMemory/SegmentsCacheInMemory.ts +12 -26
  73. package/src/storages/inMemory/SplitsCacheInMemory.ts +0 -1
  74. package/src/storages/inRedis/SegmentsCacheInRedis.ts +13 -22
  75. package/src/storages/pluggable/SegmentsCachePluggable.ts +11 -35
  76. package/src/storages/types.ts +9 -10
  77. package/src/sync/offline/syncManagerOffline.ts +21 -13
  78. package/src/sync/offline/syncTasks/fromObjectSyncTask.ts +7 -3
  79. package/src/sync/polling/pollingManagerSS.ts +2 -3
  80. package/src/sync/polling/updaters/segmentChangesUpdater.ts +13 -29
  81. package/src/sync/polling/updaters/splitChangesUpdater.ts +11 -3
  82. package/src/sync/syncManagerOnline.ts +17 -17
  83. package/src/sync/types.ts +1 -1
  84. package/src/trackers/eventTracker.ts +11 -8
  85. package/src/trackers/impressionsTracker.ts +13 -10
  86. package/src/trackers/types.ts +1 -0
  87. package/src/trackers/uniqueKeysTracker.ts +6 -4
  88. package/src/types.ts +8 -9
  89. package/src/utils/settingsValidation/storage/storageCS.ts +13 -0
  90. package/types/readiness/types.d.ts +3 -0
  91. package/types/sdkFactory/types.d.ts +1 -0
  92. package/types/storages/AbstractSplitsCacheAsync.d.ts +5 -0
  93. package/types/storages/AbstractSplitsCacheSync.d.ts +5 -0
  94. package/types/storages/dataLoader.d.ts +6 -17
  95. package/types/storages/inLocalStorage/MySegmentsCacheInLocal.d.ts +5 -5
  96. package/types/storages/inLocalStorage/SplitsCacheInLocal.d.ts +6 -0
  97. package/types/storages/inMemory/MySegmentsCacheInMemory.d.ts +5 -5
  98. package/types/storages/inMemory/SegmentsCacheInMemory.d.ts +5 -7
  99. package/types/storages/inMemory/SplitsCacheInMemory.d.ts +0 -1
  100. package/types/storages/inRedis/SegmentsCacheInRedis.d.ts +6 -3
  101. package/types/storages/pluggable/SegmentsCachePluggable.d.ts +4 -16
  102. package/types/storages/types.d.ts +7 -10
  103. package/types/sync/types.d.ts +1 -1
  104. package/types/trackers/eventTracker.d.ts +1 -1
  105. package/types/trackers/impressionsTracker.d.ts +1 -1
  106. package/types/trackers/types.d.ts +1 -0
  107. package/types/types.d.ts +8 -8
  108. package/types/utils/settingsValidation/storage/storageCS.d.ts +5 -0
package/CHANGES.txt CHANGED
@@ -1,7 +1,8 @@
1
- 2.0.0 (September XX, 2024)
2
- - Updated internal storage factory to emit the SDK_READY_FROM_CACHE event when it corresponds, to clean up the initialization flow.
3
- - Added `factory.destroy()` method, which invokes the `destroy` method on all SDK clients created by the factory.
1
+ 2.0.0 (October XX, 2024)
4
2
  - Added support for targeting rules based on large segments.
3
+ - Added `factory.destroy()` method, which invokes the `destroy` method on all SDK clients created by the factory.
4
+ - Updated the handling of timers and async operations inside an `init` factory method to enable lazy initialization of the SDK in standalone mode. This update is intended for the React SDK.
5
+ - Bugfixing - Fixed an issue with the server-side polling manager that caused dangling timers when the SDK was destroyed before it was ready.
5
6
  - BREAKING CHANGES:
6
7
  - Updated default flag spec version to 1.2.
7
8
  - Removed `/mySegments` endpoint from SplitAPI module, as it is replaced by `/memberships` endpoint.
@@ -7,6 +7,8 @@ function splitsEventEmitterFactory(EventEmitter) {
7
7
  var splitsEventEmitter = (0, objectAssign_1.objectAssign)(new EventEmitter(), {
8
8
  splitsArrived: false,
9
9
  splitsCacheLoaded: false,
10
+ initialized: false,
11
+ initCallbacks: []
10
12
  });
11
13
  // `isSplitKill` condition avoids an edge-case of wrongly emitting SDK_READY if:
12
14
  // - `/memberships` fetch and SPLIT_KILL occurs before `/splitChanges` fetch, and
@@ -46,7 +48,7 @@ function readinessManagerFactory(EventEmitter, settings, splits) {
46
48
  // emit SDK_READY_TIMED_OUT
47
49
  var hasTimedout = false;
48
50
  function timeout() {
49
- if (hasTimedout)
51
+ if (hasTimedout || isReady)
50
52
  return;
51
53
  hasTimedout = true;
52
54
  syncLastUpdate();
@@ -54,7 +56,10 @@ function readinessManagerFactory(EventEmitter, settings, splits) {
54
56
  }
55
57
  var readyTimeoutId;
56
58
  if (readyTimeout > 0) {
57
- readyTimeoutId = setTimeout(timeout, readyTimeout);
59
+ if (splits.initialized)
60
+ readyTimeoutId = setTimeout(timeout, readyTimeout);
61
+ else
62
+ splits.initCallbacks.push(function () { readyTimeoutId = setTimeout(timeout, readyTimeout); });
58
63
  }
59
64
  // emit SDK_READY and SDK_UPDATE
60
65
  var isReady = false;
@@ -116,6 +121,12 @@ function readinessManagerFactory(EventEmitter, settings, splits) {
116
121
  // Called on 403 error (client-side SDK key on server-side), to set the SDK as destroyed for
117
122
  // tracking and evaluations, while keeping event listeners to emit SDK_READY_TIMED_OUT event
118
123
  setDestroyed: function () { isDestroyed = true; },
124
+ init: function () {
125
+ if (splits.initialized)
126
+ return;
127
+ splits.initialized = true;
128
+ splits.initCallbacks.forEach(function (cb) { return cb(); });
129
+ },
119
130
  destroy: function () {
120
131
  isDestroyed = true;
121
132
  syncLastUpdate();
@@ -55,7 +55,6 @@ function sdkClientMethodCSFactory(params) {
55
55
  storage: sharedStorage || storage,
56
56
  syncManager: sharedSyncManager,
57
57
  }), true), validKey);
58
- sharedSyncManager && sharedSyncManager.start();
59
58
  log.info(constants_1.NEW_SHARED_CLIENT);
60
59
  }
61
60
  else {
@@ -64,7 +64,6 @@ function sdkClientMethodCSFactory(params) {
64
64
  storage: sharedStorage || storage,
65
65
  syncManager: sharedSyncManager,
66
66
  }), true), validKey, validTrafficType);
67
- sharedSyncManager && sharedSyncManager.start();
68
67
  log.info(constants_1.NEW_SHARED_CLIENT);
69
68
  }
70
69
  else {
@@ -19,12 +19,19 @@ var constants_3 = require("../utils/constants");
19
19
  * Modular SDK factory
20
20
  */
21
21
  function sdkFactory(params) {
22
- 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;
22
+ 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;
23
23
  var log = settings.log, impressionsMode = settings.sync.impressionsMode;
24
24
  // @TODO handle non-recoverable errors, such as, global `fetch` not available, invalid SDK Key, etc.
25
25
  // On non-recoverable errors, we should mark the SDK as destroyed and not start synchronization.
26
- // We will just log and allow for the SDK to end up throwing an SDK_TIMEOUT event for devs to handle.
27
- (0, apiKey_1.validateAndTrackApiKey)(log, settings.core.authorizationKey);
26
+ // initialization
27
+ var hasInit = false;
28
+ var initCallbacks = [];
29
+ function whenInit(cb) {
30
+ if (hasInit)
31
+ cb();
32
+ else
33
+ initCallbacks.push(cb);
34
+ }
28
35
  var sdkReadinessManager = (0, sdkReadinessManager_1.sdkReadinessManagerFactory)(platform.EventEmitter, settings);
29
36
  var readiness = sdkReadinessManager.readinessManager;
30
37
  var storage = storageFactory({
@@ -38,10 +45,8 @@ function sdkFactory(params) {
38
45
  readiness.splits.emit(constants_2.SDK_SPLITS_ARRIVED);
39
46
  readiness.segments.emit(constants_2.SDK_SEGMENTS_ARRIVED);
40
47
  },
41
- onReadyFromCacheCb: function () {
42
- readiness.splits.emit(constants_2.SDK_SPLITS_CACHE_LOADED);
43
- }
44
48
  });
49
+ // @TODO add support for dataloader: `if (params.dataLoader) params.dataLoader(storage);`
45
50
  var clients = {};
46
51
  var telemetryTracker = (0, telemetryTracker_1.telemetryTrackerFactory)(storage.telemetry, platform.now);
47
52
  var integrationsManager = integrationsManagerFactory && integrationsManagerFactory({ settings: settings, storage: storage, telemetryTracker: telemetryTracker });
@@ -58,8 +63,8 @@ function sdkFactory(params) {
58
63
  default:
59
64
  strategy = (0, strategyDebug_1.strategyDebugFactory)(observer);
60
65
  }
61
- var impressionsTracker = (0, impressionsTracker_1.impressionsTrackerFactory)(settings, storage.impressions, strategy, integrationsManager, storage.telemetry);
62
- var eventTracker = (0, eventTracker_1.eventTrackerFactory)(settings, storage.events, integrationsManager, storage.telemetry);
66
+ var impressionsTracker = (0, impressionsTracker_1.impressionsTrackerFactory)(settings, storage.impressions, strategy, whenInit, integrationsManager, storage.telemetry);
67
+ var eventTracker = (0, eventTracker_1.eventTrackerFactory)(settings, storage.events, whenInit, integrationsManager, storage.telemetry);
63
68
  // splitApi is used by SyncManager and Browser signal listener
64
69
  var splitApi = splitApiFactory && splitApiFactory(settings, platform, telemetryTracker);
65
70
  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,8 +75,19 @@ function sdkFactory(params) {
70
75
  // SDK client and manager
71
76
  var clientMethod = sdkClientMethodFactory(ctx);
72
77
  var managerInstance = sdkManagerFactory(settings, storage.splits, sdkReadinessManager);
73
- syncManager && syncManager.start();
74
- signalListener && signalListener.start();
78
+ function init() {
79
+ if (hasInit)
80
+ return;
81
+ hasInit = true;
82
+ // We will just log and allow for the SDK to end up throwing an SDK_TIMEOUT event for devs to handle.
83
+ (0, apiKey_1.validateAndTrackApiKey)(log, settings.core.authorizationKey);
84
+ readiness.init();
85
+ uniqueKeysTracker && uniqueKeysTracker.start();
86
+ syncManager && syncManager.start();
87
+ signalListener && signalListener.start();
88
+ initCallbacks.forEach(function (cb) { return cb(); });
89
+ initCallbacks.length = 0;
90
+ }
75
91
  log.info(constants_1.NEW_FACTORY);
76
92
  // @ts-ignore
77
93
  return (0, objectAssign_1.objectAssign)({
@@ -88,6 +104,6 @@ function sdkFactory(params) {
88
104
  destroy: function () {
89
105
  return Promise.all(Object.keys(clients).map(function (key) { return clients[key].destroy(); })).then(function () { });
90
106
  }
91
- }, extraProps && extraProps(ctx));
107
+ }, extraProps && extraProps(ctx), lazyInit ? { init: init } : init());
92
108
  }
93
109
  exports.sdkFactory = sdkFactory;
@@ -1,39 +1,37 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.AbstractSegmentsCacheSync = void 0;
3
+ exports.AbstractMySegmentsCacheSync = void 0;
4
4
  /**
5
5
  * This class provides a skeletal implementation of the ISegmentsCacheSync interface
6
6
  * to minimize the effort required to implement this interface.
7
7
  */
8
- var AbstractSegmentsCacheSync = /** @class */ (function () {
9
- function AbstractSegmentsCacheSync() {
8
+ var AbstractMySegmentsCacheSync = /** @class */ (function () {
9
+ function AbstractMySegmentsCacheSync() {
10
10
  }
11
11
  /**
12
12
  * clear the cache.
13
13
  */
14
- AbstractSegmentsCacheSync.prototype.clear = function () {
14
+ AbstractMySegmentsCacheSync.prototype.clear = function () {
15
15
  this.resetSegments({});
16
16
  };
17
- /**
18
- * 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.
19
- * For client-side synchronizer: the method is not used.
20
- */
21
- AbstractSegmentsCacheSync.prototype.registerSegments = function (names) { return false; };
17
+ // No-op. Not used in client-side.
18
+ AbstractMySegmentsCacheSync.prototype.registerSegments = function () { return false; };
19
+ AbstractMySegmentsCacheSync.prototype.update = function () { return false; };
22
20
  /**
23
21
  * For server-side synchronizer: the method is not used.
24
22
  * For client-side synchronizer: it resets or updates the cache.
25
23
  */
26
- AbstractSegmentsCacheSync.prototype.resetSegments = function (segmentsData) {
24
+ AbstractMySegmentsCacheSync.prototype.resetSegments = function (segmentsData) {
27
25
  var _this = this;
28
- this.setChangeNumber(undefined, segmentsData.cn);
26
+ this.setChangeNumber(segmentsData.cn);
29
27
  var _a = segmentsData, added = _a.added, removed = _a.removed;
30
28
  if (added && removed) {
31
29
  var isDiff_1 = false;
32
30
  added.forEach(function (segment) {
33
- isDiff_1 = _this.addToSegment(segment) || isDiff_1;
31
+ isDiff_1 = _this.addSegment(segment) || isDiff_1;
34
32
  });
35
33
  removed.forEach(function (segment) {
36
- isDiff_1 = _this.removeFromSegment(segment) || isDiff_1;
34
+ isDiff_1 = _this.removeSegment(segment) || isDiff_1;
37
35
  });
38
36
  return isDiff_1;
39
37
  }
@@ -50,13 +48,13 @@ var AbstractSegmentsCacheSync = /** @class */ (function () {
50
48
  return false;
51
49
  // Slowest path => add and/or remove segments
52
50
  for (var removeIndex = index; removeIndex < storedSegmentKeys.length; removeIndex++) {
53
- this.removeFromSegment(storedSegmentKeys[removeIndex]);
51
+ this.removeSegment(storedSegmentKeys[removeIndex]);
54
52
  }
55
53
  for (var addIndex = index; addIndex < names.length; addIndex++) {
56
- this.addToSegment(names[addIndex]);
54
+ this.addSegment(names[addIndex]);
57
55
  }
58
56
  return true;
59
57
  };
60
- return AbstractSegmentsCacheSync;
58
+ return AbstractMySegmentsCacheSync;
61
59
  }());
62
- exports.AbstractSegmentsCacheSync = AbstractSegmentsCacheSync;
60
+ exports.AbstractMySegmentsCacheSync = AbstractMySegmentsCacheSync;
@@ -14,6 +14,13 @@ var AbstractSplitsCacheAsync = /** @class */ (function () {
14
14
  AbstractSplitsCacheAsync.prototype.usesSegments = function () {
15
15
  return Promise.resolve(true);
16
16
  };
17
+ /**
18
+ * Check if the splits information is already stored in cache.
19
+ * Noop, just keeping the interface. This is used by client-side implementations only.
20
+ */
21
+ AbstractSplitsCacheAsync.prototype.checkCache = function () {
22
+ return Promise.resolve(false);
23
+ };
17
24
  /**
18
25
  * Kill `name` split and set `defaultTreatment` and `changeNumber`.
19
26
  * Used for SPLIT_KILL push notifications.
@@ -30,6 +30,13 @@ var AbstractSplitsCacheSync = /** @class */ (function () {
30
30
  var _this = this;
31
31
  return this.getSplitNames().map(function (key) { return _this.getSplit(key); });
32
32
  };
33
+ /**
34
+ * Check if the splits information is already stored in cache. This data can be preloaded.
35
+ * It is used as condition to emit SDK_SPLITS_CACHE_LOADED, and then SDK_READY_FROM_CACHE.
36
+ */
37
+ AbstractSplitsCacheSync.prototype.checkCache = function () {
38
+ return false;
39
+ };
33
40
  /**
34
41
  * Kill `name` split and set `defaultTreatment` and `changeNumber`.
35
42
  * Used for SPLIT_KILL push notifications.
@@ -1,84 +1,51 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.getSnapshot = exports.loadData = void 0;
4
- var sets_1 = require("../utils/lang/sets");
3
+ exports.dataLoaderFactory = void 0;
4
+ var browser_1 = require("../utils/constants/browser");
5
5
  /**
6
- * Storage-agnostic adaptation of `loadDataIntoLocalStorage` function
7
- * (https://github.com/godaddy/split-javascript-data-loader/blob/master/src/load-data.js)
6
+ * Factory of client-side storage loader
8
7
  *
9
- * @param preloadedData validated data following the format proposed in https://github.com/godaddy/split-javascript-data-loader and extended with a `mySegmentsData` property.
10
- * @param storage object containing `splits` and `segments` cache (client-side variant)
11
- * @param userKey user key (matching key) of the provided MySegmentsCache
12
- *
13
- * @TODO extend to load largeSegments
14
- * @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.
15
- * @TODO add logs, and input validation in this module, in favor of size reduction.
16
- * @TODO unit tests
8
+ * @param preloadedData validated data following the format proposed in https://github.com/godaddy/split-javascript-data-loader
9
+ * and extended with a `mySegmentsData` property.
10
+ * @returns function to preload the storage
17
11
  */
18
- function loadData(preloadedData, storage, userKey) {
19
- // Do not load data if current preloadedData is empty
20
- if (Object.keys(preloadedData).length === 0)
21
- return;
22
- 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;
23
- if (storage.splits) {
12
+ function dataLoaderFactory(preloadedData) {
13
+ /**
14
+ * Storage-agnostic adaptation of `loadDataIntoLocalStorage` function
15
+ * (https://github.com/godaddy/split-javascript-data-loader/blob/master/src/load-data.js)
16
+ *
17
+ * @param storage object containing `splits` and `segments` cache (client-side variant)
18
+ * @param userId user key string of the provided MySegmentsCache
19
+ *
20
+ * @TODO extend to support SegmentsCache (server-side variant) by making `userId` optional and adding the corresponding logic.
21
+ * @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.
22
+ */
23
+ return function loadData(storage, userId) {
24
+ // Do not load data if current preloadedData is empty
25
+ if (Object.keys(preloadedData).length === 0)
26
+ return;
27
+ 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;
24
28
  var storedSince = storage.splits.getChangeNumber();
25
- // Do not load data if current data is more recent
26
- if (storedSince > since)
29
+ var expirationTimestamp = Date.now() - browser_1.DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
30
+ // Do not load data if current localStorage data is more recent,
31
+ // or if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
32
+ if (storedSince > since || lastUpdated < expirationTimestamp)
27
33
  return;
28
34
  // cleaning up the localStorage data, since some cached splits might need be part of the preloaded data
29
35
  storage.splits.clear();
30
36
  storage.splits.setChangeNumber(since);
31
37
  // splitsData in an object where the property is the split name and the pertaining value is a stringified json of its data
32
- storage.splits.addSplits(splitsData.map(function (split) { return ([split.name, split]); }));
33
- }
34
- if (userKey) { // add mySegments data (client-side)
35
- var mySegmentsData = preloadedData.mySegmentsData && preloadedData.mySegmentsData[userKey];
38
+ storage.splits.addSplits(Object.keys(splitsData).map(function (splitName) { return JSON.parse(splitsData[splitName]); }));
39
+ // add mySegments data
40
+ var mySegmentsData = preloadedData.mySegmentsData && preloadedData.mySegmentsData[userId];
36
41
  if (!mySegmentsData) {
37
42
  // 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
38
43
  mySegmentsData = Object.keys(segmentsData).filter(function (segmentName) {
39
- var userKeys = segmentsData[segmentName];
40
- return userKeys.indexOf(userKey) > -1;
44
+ var userIds = JSON.parse(segmentsData[segmentName]).added;
45
+ return Array.isArray(userIds) && userIds.indexOf(userId) > -1;
41
46
  });
42
47
  }
43
48
  storage.segments.resetSegments({ k: mySegmentsData.map(function (s) { return ({ n: s }); }) });
44
- }
45
- else { // add segments data (server-side)
46
- Object.keys(segmentsData).filter(function (segmentName) {
47
- var userKeys = segmentsData[segmentName];
48
- storage.segments.addToSegment(segmentName, userKeys);
49
- });
50
- }
51
- }
52
- exports.loadData = loadData;
53
- function getSnapshot(storage, userKeys) {
54
- return {
55
- // lastUpdated: Date.now(),
56
- // @ts-ignore accessing private prop
57
- since: storage.splits.changeNumber,
58
- splitsData: storage.splits.getAll(),
59
- segmentsData: userKeys ?
60
- undefined : // @ts-ignore accessing private prop
61
- Object.keys(storage.segments.segmentCache).reduce(function (prev, cur) {
62
- prev[cur] = (0, sets_1.setToArray)(storage.segments.segmentCache[cur]);
63
- return prev;
64
- }, {}),
65
- mySegmentsData: userKeys ?
66
- userKeys.reduce(function (prev, userKey) {
67
- // @ts-ignore accessing private prop
68
- prev[userKey] = storage.shared ?
69
- // Client-side segments
70
- // @ts-ignore accessing private prop
71
- Object.keys(storage.shared(userKey).segments.segmentCache) :
72
- // Server-side segments
73
- // @ts-ignore accessing private prop
74
- Object.keys(storage.segments.segmentCache).reduce(function (prev, segmentName) {
75
- return storage.segments.segmentCache[segmentName].has(userKey) ?
76
- prev.concat(segmentName) :
77
- prev;
78
- }, []);
79
- return prev;
80
- }, {}) :
81
- undefined
82
49
  };
83
50
  }
84
- exports.getSnapshot = getSnapshot;
51
+ exports.dataLoaderFactory = dataLoaderFactory;
@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.MySegmentsCacheInLocal = void 0;
4
4
  var tslib_1 = require("tslib");
5
5
  var lang_1 = require("../../utils/lang");
6
- var AbstractSegmentsCacheSync_1 = require("../AbstractSegmentsCacheSync");
6
+ var AbstractMySegmentsCacheSync_1 = require("../AbstractMySegmentsCacheSync");
7
7
  var constants_1 = require("./constants");
8
8
  var MySegmentsCacheInLocal = /** @class */ (function (_super) {
9
9
  (0, tslib_1.__extends)(MySegmentsCacheInLocal, _super);
@@ -14,7 +14,7 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
14
14
  return _this;
15
15
  // There is not need to flush segments cache like splits cache, since resetSegments receives the up-to-date list of active segments
16
16
  }
17
- MySegmentsCacheInLocal.prototype.addToSegment = function (name) {
17
+ MySegmentsCacheInLocal.prototype.addSegment = function (name) {
18
18
  var segmentKey = this.keys.buildSegmentNameKey(name);
19
19
  try {
20
20
  if (localStorage.getItem(segmentKey) === constants_1.DEFINED)
@@ -27,7 +27,7 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
27
27
  return false;
28
28
  }
29
29
  };
30
- MySegmentsCacheInLocal.prototype.removeFromSegment = function (name) {
30
+ MySegmentsCacheInLocal.prototype.removeSegment = function (name) {
31
31
  var segmentKey = this.keys.buildSegmentNameKey(name);
32
32
  try {
33
33
  if (localStorage.getItem(segmentKey) !== constants_1.DEFINED)
@@ -76,7 +76,7 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
76
76
  MySegmentsCacheInLocal.prototype.getKeysCount = function () {
77
77
  return 1;
78
78
  };
79
- MySegmentsCacheInLocal.prototype.setChangeNumber = function (name, changeNumber) {
79
+ MySegmentsCacheInLocal.prototype.setChangeNumber = function (changeNumber) {
80
80
  try {
81
81
  if (changeNumber)
82
82
  localStorage.setItem(this.keys.buildTillKey(), changeNumber + '');
@@ -97,5 +97,5 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
97
97
  return n;
98
98
  };
99
99
  return MySegmentsCacheInLocal;
100
- }(AbstractSegmentsCacheSync_1.AbstractSegmentsCacheSync));
100
+ }(AbstractMySegmentsCacheSync_1.AbstractMySegmentsCacheSync));
101
101
  exports.MySegmentsCacheInLocal = MySegmentsCacheInLocal;
@@ -186,6 +186,14 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
186
186
  return true;
187
187
  }
188
188
  };
189
+ /**
190
+ * Check if the splits information is already stored in browser LocalStorage.
191
+ * In this function we could add more code to check if the data is valid.
192
+ * @override
193
+ */
194
+ SplitsCacheInLocal.prototype.checkCache = function () {
195
+ return this.getChangeNumber() > -1;
196
+ };
189
197
  /**
190
198
  * Clean Splits cache if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
191
199
  *
@@ -208,7 +216,7 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
208
216
  // mark cache to update the new query filter on first successful splits fetch
209
217
  this.updateNewFilter = true;
210
218
  // if there is cache, clear it
211
- if (this.getChangeNumber() > -1)
219
+ if (this.checkCache())
212
220
  this.clear();
213
221
  }
214
222
  catch (e) {
@@ -30,16 +30,13 @@ function InLocalStorage(options) {
30
30
  params.settings.log.warn(constants_1.LOG_PREFIX + 'LocalStorage API is unavailable. Falling back to default MEMORY storage');
31
31
  return (0, InMemoryStorageCS_1.InMemoryStorageCSFactory)(params);
32
32
  }
33
- 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;
33
+ 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;
34
34
  var matchingKey = (0, key_1.getMatching)(settings.core.key);
35
35
  var keys = new KeyBuilderCS_1.KeyBuilderCS(prefix, matchingKey);
36
36
  var expirationTimestamp = Date.now() - browser_1.DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
37
37
  var splits = new SplitsCacheInLocal_1.SplitsCacheInLocal(settings, keys, expirationTimestamp);
38
38
  var segments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, keys);
39
39
  var largeSegments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, (0, KeyBuilderCS_1.myLargeSegmentsKeyBuilder)(prefix, matchingKey));
40
- if (settings.mode === constants_2.LOCALHOST_MODE || splits.getChangeNumber() > -1) {
41
- Promise.resolve().then(onReadyFromCacheCb);
42
- }
43
40
  return {
44
41
  splits: splits,
45
42
  segments: segments,
@@ -9,15 +9,13 @@ var ImpressionCountsCacheInMemory_1 = require("./ImpressionCountsCacheInMemory")
9
9
  var constants_1 = require("../../utils/constants");
10
10
  var TelemetryCacheInMemory_1 = require("./TelemetryCacheInMemory");
11
11
  var UniqueKeysCacheInMemoryCS_1 = require("./UniqueKeysCacheInMemoryCS");
12
- var key_1 = require("../../utils/key");
13
- var dataLoader_1 = require("../dataLoader");
14
12
  /**
15
13
  * InMemory storage factory for standalone client-side SplitFactory
16
14
  *
17
15
  * @param params parameters required by EventsCacheSync
18
16
  */
19
17
  function InMemoryStorageCSFactory(params) {
20
- 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;
18
+ var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__splitFiltersValidation;
21
19
  var splits = new SplitsCacheInMemory_1.SplitsCacheInMemory(__splitFiltersValidation);
22
20
  var segments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();
23
21
  var largeSegments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();
@@ -41,16 +39,11 @@ function InMemoryStorageCSFactory(params) {
41
39
  this.uniqueKeys && this.uniqueKeys.clear();
42
40
  },
43
41
  // When using shared instanciation with MEMORY we reuse everything but segments (they are unique per key)
44
- shared: function (matchingKey) {
45
- var segments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();
46
- var largeSegments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();
47
- if (preloadedData) {
48
- (0, dataLoader_1.loadData)(preloadedData, { segments: segments, largeSegments: largeSegments }, matchingKey);
49
- }
42
+ shared: function () {
50
43
  return {
51
44
  splits: this.splits,
52
- segments: segments,
53
- largeSegments: largeSegments,
45
+ segments: new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory(),
46
+ largeSegments: new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory(),
54
47
  impressions: this.impressions,
55
48
  impressionCounts: this.impressionCounts,
56
49
  events: this.events,
@@ -65,7 +58,7 @@ function InMemoryStorageCSFactory(params) {
65
58
  },
66
59
  };
67
60
  // @TODO revisit storage logic in localhost mode
68
- // No tracking data in localhost mode to avoid memory leaks
61
+ // No tracking in localhost mode to avoid memory leaks: https://github.com/splitio/javascript-commons/issues/181
69
62
  if (params.settings.mode === constants_1.LOCALHOST_MODE) {
70
63
  var noopTrack = function () { return true; };
71
64
  storage.impressions.track = noopTrack;
@@ -75,11 +68,6 @@ function InMemoryStorageCSFactory(params) {
75
68
  if (storage.uniqueKeys)
76
69
  storage.uniqueKeys.track = noopTrack;
77
70
  }
78
- if (preloadedData) {
79
- (0, dataLoader_1.loadData)(preloadedData, storage, (0, key_1.getMatching)(params.settings.core.key));
80
- if (splits.getChangeNumber() > -1)
81
- onReadyFromCacheCb();
82
- }
83
71
  return storage;
84
72
  }
85
73
  exports.InMemoryStorageCSFactory = InMemoryStorageCSFactory;
@@ -2,7 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.MySegmentsCacheInMemory = void 0;
4
4
  var tslib_1 = require("tslib");
5
- var AbstractSegmentsCacheSync_1 = require("../AbstractSegmentsCacheSync");
5
+ var AbstractMySegmentsCacheSync_1 = require("../AbstractMySegmentsCacheSync");
6
6
  /**
7
7
  * Default MySegmentsCacheInMemory implementation that stores MySegments in memory.
8
8
  * Supported by all JS runtimes.
@@ -14,13 +14,13 @@ var MySegmentsCacheInMemory = /** @class */ (function (_super) {
14
14
  _this.segmentCache = {};
15
15
  return _this;
16
16
  }
17
- MySegmentsCacheInMemory.prototype.addToSegment = function (name) {
17
+ MySegmentsCacheInMemory.prototype.addSegment = function (name) {
18
18
  if (this.segmentCache[name])
19
19
  return false;
20
20
  this.segmentCache[name] = true;
21
21
  return true;
22
22
  };
23
- MySegmentsCacheInMemory.prototype.removeFromSegment = function (name) {
23
+ MySegmentsCacheInMemory.prototype.removeSegment = function (name) {
24
24
  if (!this.segmentCache[name])
25
25
  return false;
26
26
  delete this.segmentCache[name];
@@ -29,7 +29,7 @@ var MySegmentsCacheInMemory = /** @class */ (function (_super) {
29
29
  MySegmentsCacheInMemory.prototype.isInSegment = function (name) {
30
30
  return this.segmentCache[name] === true;
31
31
  };
32
- MySegmentsCacheInMemory.prototype.setChangeNumber = function (name, changeNumber) {
32
+ MySegmentsCacheInMemory.prototype.setChangeNumber = function (changeNumber) {
33
33
  this.cn = changeNumber;
34
34
  };
35
35
  MySegmentsCacheInMemory.prototype.getChangeNumber = function () {
@@ -42,5 +42,5 @@ var MySegmentsCacheInMemory = /** @class */ (function (_super) {
42
42
  return 1;
43
43
  };
44
44
  return MySegmentsCacheInMemory;
45
- }(AbstractSegmentsCacheSync_1.AbstractSegmentsCacheSync));
45
+ }(AbstractMySegmentsCacheSync_1.AbstractMySegmentsCacheSync));
46
46
  exports.MySegmentsCacheInMemory = MySegmentsCacheInMemory;
@@ -1,35 +1,23 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SegmentsCacheInMemory = void 0;
4
- var tslib_1 = require("tslib");
5
- var AbstractSegmentsCacheSync_1 = require("../AbstractSegmentsCacheSync");
6
4
  var sets_1 = require("../../utils/lang/sets");
7
5
  var lang_1 = require("../../utils/lang");
8
6
  /**
9
- * Default ISplitsCacheSync implementation that stores split definitions in memory.
10
- * Supported by all JS runtimes.
7
+ * Default ISplitsCacheSync implementation for server-side that stores segments definitions in memory.
11
8
  */
12
- var SegmentsCacheInMemory = /** @class */ (function (_super) {
13
- (0, tslib_1.__extends)(SegmentsCacheInMemory, _super);
9
+ var SegmentsCacheInMemory = /** @class */ (function () {
14
10
  function SegmentsCacheInMemory() {
15
- var _this = _super !== null && _super.apply(this, arguments) || this;
16
- _this.segmentCache = {};
17
- _this.segmentChangeNumber = {};
18
- return _this;
11
+ this.segmentCache = {};
12
+ this.segmentChangeNumber = {};
19
13
  }
20
- SegmentsCacheInMemory.prototype.addToSegment = function (name, segmentKeys) {
21
- var values = this.segmentCache[name];
22
- var keySet = values ? values : new sets_1._Set();
23
- segmentKeys.forEach(function (k) { return keySet.add(k); });
24
- this.segmentCache[name] = keySet;
25
- return true;
26
- };
27
- SegmentsCacheInMemory.prototype.removeFromSegment = function (name, segmentKeys) {
28
- var values = this.segmentCache[name];
29
- var keySet = values ? values : new sets_1._Set();
30
- segmentKeys.forEach(function (k) { return keySet.delete(k); });
14
+ SegmentsCacheInMemory.prototype.update = function (name, addedKeys, removedKeys, changeNumber) {
15
+ var keySet = this.segmentCache[name] || new sets_1._Set();
16
+ addedKeys.forEach(function (k) { return keySet.add(k); });
17
+ removedKeys.forEach(function (k) { return keySet.delete(k); });
31
18
  this.segmentCache[name] = keySet;
32
- return true;
19
+ this.segmentChangeNumber[name] = changeNumber;
20
+ return addedKeys.length > 0 || removedKeys.length > 0;
33
21
  };
34
22
  SegmentsCacheInMemory.prototype.isInSegment = function (name, key) {
35
23
  var segmentValues = this.segmentCache[name];
@@ -63,14 +51,12 @@ var SegmentsCacheInMemory = /** @class */ (function (_super) {
63
51
  return acum + _this.segmentCache[segmentName].size;
64
52
  }, 0);
65
53
  };
66
- SegmentsCacheInMemory.prototype.setChangeNumber = function (name, changeNumber) {
67
- this.segmentChangeNumber[name] = changeNumber;
68
- return true;
69
- };
70
54
  SegmentsCacheInMemory.prototype.getChangeNumber = function (name) {
71
55
  var value = this.segmentChangeNumber[name];
72
56
  return (0, lang_1.isIntegerNumber)(value) ? value : -1;
73
57
  };
58
+ // No-op. Not used in server-side
59
+ SegmentsCacheInMemory.prototype.resetSegments = function () { return false; };
74
60
  return SegmentsCacheInMemory;
75
- }(AbstractSegmentsCacheSync_1.AbstractSegmentsCacheSync));
61
+ }());
76
62
  exports.SegmentsCacheInMemory = SegmentsCacheInMemory;
@@ -7,7 +7,6 @@ var lang_1 = require("../../utils/lang");
7
7
  var sets_1 = require("../../utils/lang/sets");
8
8
  /**
9
9
  * Default ISplitsCacheSync implementation that stores split definitions in memory.
10
- * Supported by all JS runtimes.
11
10
  */
12
11
  var SplitsCacheInMemory = /** @class */ (function (_super) {
13
12
  (0, tslib_1.__extends)(SplitsCacheInMemory, _super);