@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
@@ -9,30 +9,24 @@ var SegmentsCacheInRedis = /** @class */ (function () {
9
9
  this.redis = redis;
10
10
  this.keys = keys;
11
11
  }
12
- SegmentsCacheInRedis.prototype.addToSegment = function (name, segmentKeys) {
12
+ /**
13
+ * Update the given segment `name` with the lists of `addedKeys`, `removedKeys` and `changeNumber`.
14
+ * The returned promise is resolved if the operation success, with `true` if the segment was updated (i.e., some key was added or removed),
15
+ * or rejected if it fails (e.g., Redis operation fails).
16
+ */
17
+ SegmentsCacheInRedis.prototype.update = function (name, addedKeys, removedKeys, changeNumber) {
13
18
  var segmentKey = this.keys.buildSegmentNameKey(name);
14
- if (segmentKeys.length) {
15
- return this.redis.sadd(segmentKey, segmentKeys).then(function () { return true; });
16
- }
17
- else {
18
- return Promise.resolve(true);
19
- }
20
- };
21
- SegmentsCacheInRedis.prototype.removeFromSegment = function (name, segmentKeys) {
22
- var segmentKey = this.keys.buildSegmentNameKey(name);
23
- if (segmentKeys.length) {
24
- return this.redis.srem(segmentKey, segmentKeys).then(function () { return true; });
25
- }
26
- else {
27
- return Promise.resolve(true);
28
- }
19
+ return Promise.all([
20
+ addedKeys.length && this.redis.sadd(segmentKey, addedKeys),
21
+ removedKeys.length && this.redis.srem(segmentKey, removedKeys),
22
+ this.redis.set(this.keys.buildSegmentTillKey(name), changeNumber + '')
23
+ ]).then(function () {
24
+ return addedKeys.length > 0 || removedKeys.length > 0;
25
+ });
29
26
  };
30
27
  SegmentsCacheInRedis.prototype.isInSegment = function (name, key) {
31
28
  return this.redis.sismember(this.keys.buildSegmentNameKey(name), key).then(function (matches) { return matches !== 0; });
32
29
  };
33
- SegmentsCacheInRedis.prototype.setChangeNumber = function (name, changeNumber) {
34
- return this.redis.set(this.keys.buildSegmentTillKey(name), changeNumber + '').then(function (status) { return status === 'OK'; });
35
- };
36
30
  SegmentsCacheInRedis.prototype.getChangeNumber = function (name) {
37
31
  var _this = this;
38
32
  return this.redis.get(this.keys.buildSegmentTillKey(name)).then(function (value) {
@@ -15,32 +15,19 @@ var SegmentsCachePluggable = /** @class */ (function () {
15
15
  this.wrapper = wrapper;
16
16
  }
17
17
  /**
18
- * Add a list of `segmentKeys` to the given segment `name`.
19
- * The returned promise is resolved when the operation success
20
- * or rejected if wrapper operation fails.
21
- */
22
- SegmentsCachePluggable.prototype.addToSegment = function (name, segmentKeys) {
23
- var segmentKey = this.keys.buildSegmentNameKey(name);
24
- if (segmentKeys.length) {
25
- return this.wrapper.addItems(segmentKey, segmentKeys);
26
- }
27
- else {
28
- return Promise.resolve();
29
- }
30
- };
31
- /**
32
- * Remove a list of `segmentKeys` from the given segment `name`.
33
- * The returned promise is resolved when the operation success
34
- * or rejected if wrapper operation fails.
18
+ * Update the given segment `name` with the lists of `addedKeys`, `removedKeys` and `changeNumber`.
19
+ * The returned promise is resolved if the operation success, with `true` if the segment was updated (i.e., some key was added or removed),
20
+ * or rejected if it fails (e.g., wrapper operation fails).
35
21
  */
36
- SegmentsCachePluggable.prototype.removeFromSegment = function (name, segmentKeys) {
22
+ SegmentsCachePluggable.prototype.update = function (name, addedKeys, removedKeys, changeNumber) {
37
23
  var segmentKey = this.keys.buildSegmentNameKey(name);
38
- if (segmentKeys.length) {
39
- return this.wrapper.removeItems(segmentKey, segmentKeys);
40
- }
41
- else {
42
- return Promise.resolve();
43
- }
24
+ return Promise.all([
25
+ addedKeys.length && this.wrapper.addItems(segmentKey, addedKeys),
26
+ removedKeys.length && this.wrapper.removeItems(segmentKey, removedKeys),
27
+ this.wrapper.set(this.keys.buildSegmentTillKey(name), changeNumber + '')
28
+ ]).then(function () {
29
+ return addedKeys.length > 0 || removedKeys.length > 0;
30
+ });
44
31
  };
45
32
  /**
46
33
  * Returns a promise that resolves with a boolean value indicating if `key` is part of `name` segment.
@@ -49,14 +36,6 @@ var SegmentsCachePluggable = /** @class */ (function () {
49
36
  SegmentsCachePluggable.prototype.isInSegment = function (name, key) {
50
37
  return this.wrapper.itemContains(this.keys.buildSegmentNameKey(name), key);
51
38
  };
52
- /**
53
- * Set till number for the given segment `name`.
54
- * The returned promise is resolved when the operation success,
55
- * or rejected if it fails (e.g., wrapper operation fails).
56
- */
57
- SegmentsCachePluggable.prototype.setChangeNumber = function (name, changeNumber) {
58
- return this.wrapper.set(this.keys.buildSegmentTillKey(name), changeNumber + '');
59
- };
60
39
  /**
61
40
  * Get till number or -1 if it's not defined.
62
41
  * The returned promise is resolved with the changeNumber or -1 if it doesn't exist or a wrapper operation fails.
@@ -19,23 +19,30 @@ function syncManagerOfflineFactory(splitsParserFactory) {
19
19
  */
20
20
  return function (_a) {
21
21
  var settings = _a.settings, readiness = _a.readiness, storage = _a.storage;
22
- return (0, objectAssign_1.objectAssign)((0, fromObjectSyncTask_1.fromObjectSyncTaskFactory)(splitsParserFactory(), storage, readiness, settings), {
22
+ var mainSyncManager = (0, fromObjectSyncTask_1.fromObjectSyncTaskFactory)(splitsParserFactory(), storage, readiness, settings);
23
+ var mainStart = mainSyncManager.start;
24
+ var sharedStarts = [];
25
+ return (0, objectAssign_1.objectAssign)(mainSyncManager, {
26
+ start: function () {
27
+ mainStart();
28
+ sharedStarts.forEach(function (cb) { return cb(); });
29
+ sharedStarts.length = 0;
30
+ },
23
31
  // fake flush, that resolves immediately
24
32
  flush: flush,
25
33
  // [Only used for client-side]
26
34
  shared: function (matchingKey, readinessManager) {
35
+ // In LOCALHOST mode, shared clients are ready in the next event-loop cycle than created
36
+ // SDK_READY cannot be emitted directly because this will not update the readiness status
37
+ function emitSdkReady() {
38
+ readinessManager.segments.emit(constants_1.SDK_SEGMENTS_ARRIVED); // SDK_SPLITS_ARRIVED emitted by main SyncManager
39
+ }
40
+ if (mainSyncManager.isRunning())
41
+ setTimeout(emitSdkReady);
42
+ else
43
+ sharedStarts.push(emitSdkReady);
27
44
  return {
28
- start: function () {
29
- // In LOCALHOST mode, shared clients are ready in the next event-loop cycle than created
30
- // SDK_READY cannot be emitted directly because this will not update the readiness status
31
- setTimeout(function () {
32
- readinessManager.segments.emit(constants_1.SDK_SEGMENTS_ARRIVED); // SDK_SPLITS_ARRIVED emitted by main SyncManager
33
- }, 0);
34
- },
35
45
  stop: function () { },
36
- isRunning: function () {
37
- return true;
38
- },
39
46
  flush: flush,
40
47
  };
41
48
  }
@@ -46,8 +46,13 @@ function fromObjectUpdaterFactory(splitsParser, storage, readiness, settings) {
46
46
  readiness.splits.emit(constants_2.SDK_SPLITS_ARRIVED);
47
47
  if (startingUp) {
48
48
  startingUp = false;
49
- // Emits SDK_READY
50
- readiness.segments.emit(constants_2.SDK_SEGMENTS_ARRIVED);
49
+ Promise.resolve(splitsCache.checkCache()).then(function (cacheReady) {
50
+ // Emits SDK_READY_FROM_CACHE
51
+ if (cacheReady)
52
+ readiness.splits.emit(constants_2.SDK_SPLITS_CACHE_LOADED);
53
+ // Emits SDK_READY
54
+ readiness.segments.emit(constants_2.SDK_SEGMENTS_ARRIVED);
55
+ });
51
56
  }
52
57
  return true;
53
58
  });
@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.pollingManagerSSFactory = void 0;
4
4
  var splitsSyncTask_1 = require("./syncTasks/splitsSyncTask");
5
5
  var segmentsSyncTask_1 = require("./syncTasks/segmentsSyncTask");
6
- var thenable_1 = require("../../utils/promise/thenable");
7
6
  var constants_1 = require("../../logger/constants");
8
7
  /**
9
8
  * Expose start / stop mechanism for pulling data from services.
@@ -22,9 +21,10 @@ function pollingManagerSSFactory(params) {
22
21
  log.debug(constants_1.LOG_PREFIX_SYNC_POLLING + ("Splits will be refreshed each " + settings.scheduler.featuresRefreshRate + " millis"));
23
22
  log.debug(constants_1.LOG_PREFIX_SYNC_POLLING + ("Segments will be refreshed each " + settings.scheduler.segmentsRefreshRate + " millis"));
24
23
  var startingUp = splitsSyncTask.start();
25
- if ((0, thenable_1.thenable)(startingUp)) {
24
+ if (startingUp) {
26
25
  startingUp.then(function () {
27
- segmentsSyncTask.start();
26
+ if (splitsSyncTask.isRunning())
27
+ segmentsSyncTask.start();
28
28
  });
29
29
  }
30
30
  },
@@ -1,10 +1,8 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.segmentChangesUpdaterFactory = void 0;
4
- var lang_1 = require("../../../utils/lang");
5
4
  var constants_1 = require("../../../readiness/constants");
6
5
  var constants_2 = require("../../../logger/constants");
7
- var thenable_1 = require("../../../utils/promise/thenable");
8
6
  /**
9
7
  * Factory of SegmentChanges updater, a task that:
10
8
  * - fetches segment changes using `segmentChangesFetcher`
@@ -23,27 +21,16 @@ function segmentChangesUpdaterFactory(log, segmentChangesFetcher, segments, read
23
21
  var sincePromise = Promise.resolve(segments.getChangeNumber(segmentName));
24
22
  return sincePromise.then(function (since) {
25
23
  // if fetchOnlyNew flag, avoid processing already fetched segments
26
- if (fetchOnlyNew && since !== -1)
27
- return -1;
28
- return segmentChangesFetcher(since, segmentName, noCache, till).then(function (changes) {
29
- var changeNumber = -1;
30
- var results = [];
31
- changes.forEach(function (x) {
32
- if (x.added.length > 0)
33
- results.push(segments.addToSegment(segmentName, x.added));
34
- if (x.removed.length > 0)
35
- results.push(segments.removeFromSegment(segmentName, x.removed));
36
- if (x.added.length > 0 || x.removed.length > 0) {
37
- results.push(segments.setChangeNumber(segmentName, x.till));
38
- changeNumber = x.till;
39
- }
40
- log.debug(constants_2.LOG_PREFIX_SYNC_SEGMENTS + "Processed " + segmentName + " with till = " + x.till + ". Added: " + x.added.length + ". Removed: " + x.removed.length);
24
+ return fetchOnlyNew && since !== -1 ?
25
+ false :
26
+ segmentChangesFetcher(since, segmentName, noCache, till).then(function (changes) {
27
+ return Promise.all(changes.map(function (x) {
28
+ log.debug(constants_2.LOG_PREFIX_SYNC_SEGMENTS + "Processing " + segmentName + " with till = " + x.till + ". Added: " + x.added.length + ". Removed: " + x.removed.length);
29
+ return segments.update(x.name, x.added, x.removed, x.till);
30
+ })).then(function (updates) {
31
+ return updates.some(function (update) { return update; });
32
+ });
41
33
  });
42
- // If at least one storage operation result is a promise, join all in a single promise.
43
- if (results.some(function (result) { return (0, thenable_1.thenable)(result); }))
44
- return Promise.all(results).then(function () { return changeNumber; });
45
- return changeNumber;
46
- });
47
34
  });
48
35
  }
49
36
  /**
@@ -62,14 +49,11 @@ function segmentChangesUpdaterFactory(log, segmentChangesFetcher, segments, read
62
49
  // If not a segment name provided, read list of available segments names to be updated.
63
50
  var segmentsPromise = Promise.resolve(segmentName ? [segmentName] : segments.getRegisteredSegments());
64
51
  return segmentsPromise.then(function (segmentNames) {
65
- // Async fetchers are collected here.
66
- var updaters = [];
67
- for (var index = 0; index < segmentNames.length; index++) {
68
- updaters.push(updateSegment(segmentNames[index], noCache, till, fetchOnlyNew));
69
- }
52
+ // Async fetchers
53
+ var updaters = segmentNames.map(function (segmentName) { return updateSegment(segmentName, noCache, till, fetchOnlyNew); });
70
54
  return Promise.all(updaters).then(function (shouldUpdateFlags) {
71
55
  // if at least one segment fetch succeeded, mark segments ready
72
- if ((0, lang_1.findIndex)(shouldUpdateFlags, function (v) { return v !== -1; }) !== -1 || readyOnAlreadyExistentState) {
56
+ if (shouldUpdateFlags.some(function (update) { return update; }) || readyOnAlreadyExistentState) {
73
57
  readyOnAlreadyExistentState = false;
74
58
  if (readiness)
75
59
  readiness.segments.emit(constants_1.SDK_SEGMENTS_ARRIVED);
@@ -126,7 +126,7 @@ function splitChangesUpdaterFactory(log, splitChangesFetcher, splits, segments,
126
126
  function _splitChangesUpdater(since, retry) {
127
127
  if (retry === void 0) { retry = 0; }
128
128
  log.debug(constants_2.SYNC_SPLITS_FETCH, [since]);
129
- return Promise.resolve(splitUpdateNotification ?
129
+ var fetcherPromise = Promise.resolve(splitUpdateNotification ?
130
130
  { splits: [splitUpdateNotification.payload], till: splitUpdateNotification.changeNumber } :
131
131
  splitChangesFetcher(since, noCache, till, _promiseDecorator))
132
132
  .then(function (splitChanges) {
@@ -170,6 +170,15 @@ function splitChangesUpdaterFactory(log, splitChangesFetcher, splits, segments,
170
170
  }
171
171
  return false;
172
172
  });
173
+ // After triggering the requests, if we have cached splits information let's notify that to emit SDK_READY_FROM_CACHE.
174
+ // Wrapping in a promise since checkCache can be async.
175
+ if (splitsEventEmitter && startingUp) {
176
+ Promise.resolve(splits.checkCache()).then(function (isCacheReady) {
177
+ if (isCacheReady)
178
+ splitsEventEmitter.emit(constants_1.SDK_SPLITS_CACHE_LOADED);
179
+ });
180
+ }
181
+ return fetcherPromise;
173
182
  }
174
183
  var sincePromise = Promise.resolve(splits.getChangeNumber()); // `getChangeNumber` never rejects or throws error
175
184
  return sincePromise.then(_splitChangesUpdater);
@@ -118,33 +118,32 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
118
118
  if (!pollingManager)
119
119
  return;
120
120
  var mySegmentsSyncTask = pollingManager.add(matchingKey, readinessManager, storage);
121
- return {
122
- isRunning: mySegmentsSyncTask.isRunning,
123
- start: function () {
124
- if (syncEnabled) {
125
- if (pushManager) {
126
- if (pollingManager.isRunning()) {
127
- // if doing polling, we must start the periodic fetch of data
128
- if (storage.splits.usesSegments())
129
- mySegmentsSyncTask.start();
130
- }
131
- else {
132
- // if not polling, we must execute the sync task for the initial fetch
133
- // of segments since `syncAll` was already executed when starting the main client
134
- mySegmentsSyncTask.execute();
135
- }
136
- pushManager.add(matchingKey, mySegmentsSyncTask);
137
- }
138
- else {
121
+ if (running) {
122
+ if (syncEnabled) {
123
+ if (pushManager) {
124
+ if (pollingManager.isRunning()) {
125
+ // if doing polling, we must start the periodic fetch of data
139
126
  if (storage.splits.usesSegments())
140
127
  mySegmentsSyncTask.start();
141
128
  }
129
+ else {
130
+ // if not polling, we must execute the sync task for the initial fetch
131
+ // of segments since `syncAll` was already executed when starting the main client
132
+ mySegmentsSyncTask.execute();
133
+ }
134
+ pushManager.add(matchingKey, mySegmentsSyncTask);
142
135
  }
143
136
  else {
144
- if (!readinessManager.isReady())
145
- mySegmentsSyncTask.execute();
137
+ if (storage.splits.usesSegments())
138
+ mySegmentsSyncTask.start();
146
139
  }
147
- },
140
+ }
141
+ else {
142
+ if (!readinessManager.isReady())
143
+ mySegmentsSyncTask.execute();
144
+ }
145
+ }
146
+ return {
148
147
  stop: function () {
149
148
  // check in case `client.destroy()` has been invoked more than once for the same client
150
149
  var mySegmentsSyncTask = pollingManager.get(matchingKey);
@@ -12,7 +12,7 @@ var mode_1 = require("../utils/settingsValidation/mode");
12
12
  * @param eventsCache cache to save events
13
13
  * @param integrationsManager optional event handler used for integrations
14
14
  */
15
- function eventTrackerFactory(settings, eventsCache, integrationsManager, telemetryCache) {
15
+ function eventTrackerFactory(settings, eventsCache, whenInit, integrationsManager, telemetryCache) {
16
16
  var log = settings.log, mode = settings.mode;
17
17
  var isAsync = (0, mode_1.isConsumerMode)(mode);
18
18
  function queueEventsCallback(eventData, tracked) {
@@ -22,15 +22,17 @@ function eventTrackerFactory(settings, eventsCache, integrationsManager, telemet
22
22
  if (tracked) {
23
23
  log.info(constants_1.EVENTS_TRACKER_SUCCESS, [msg]);
24
24
  if (integrationsManager) {
25
- // Wrap in a timeout because we don't want it to be blocking.
26
- setTimeout(function () {
27
- // copy of event, to avoid unexpected behaviour if modified by integrations
28
- var eventDataCopy = (0, objectAssign_1.objectAssign)({}, eventData);
29
- if (properties)
30
- eventDataCopy.properties = (0, objectAssign_1.objectAssign)({}, properties);
31
- // integrationsManager does not throw errors (they are internally handled by each integration module)
32
- integrationsManager.handleEvent(eventDataCopy);
33
- }, 0);
25
+ whenInit(function () {
26
+ // Wrap in a timeout because we don't want it to be blocking.
27
+ setTimeout(function () {
28
+ // copy of event, to avoid unexpected behaviour if modified by integrations
29
+ var eventDataCopy = (0, objectAssign_1.objectAssign)({}, eventData);
30
+ if (properties)
31
+ eventDataCopy.properties = (0, objectAssign_1.objectAssign)({}, properties);
32
+ // integrationsManager does not throw errors (they are internally handled by each integration module)
33
+ integrationsManager.handleEvent(eventDataCopy);
34
+ });
35
+ });
34
36
  }
35
37
  }
36
38
  else {
@@ -14,7 +14,7 @@ var constants_2 = require("../utils/constants");
14
14
  * @param integrationsManager optional integrations manager
15
15
  * @param strategy strategy for impressions tracking.
16
16
  */
17
- function impressionsTrackerFactory(settings, impressionsCache, strategy, integrationsManager, telemetryCache) {
17
+ function impressionsTrackerFactory(settings, impressionsCache, strategy, whenInit, integrationsManager, telemetryCache) {
18
18
  var log = settings.log, impressionListener = settings.impressionListener, _a = settings.runtime, ip = _a.ip, hostname = _a.hostname, version = settings.version;
19
19
  return {
20
20
  track: function (impressions, attributes) {
@@ -53,19 +53,21 @@ function impressionsTrackerFactory(settings, impressionsCache, strategy, integra
53
53
  hostname: hostname,
54
54
  sdkLanguageVersion: version
55
55
  };
56
- // Wrap in a timeout because we don't want it to be blocking.
57
- setTimeout(function () {
58
- // integrationsManager.handleImpression does not throw errors
59
- if (integrationsManager)
60
- integrationsManager.handleImpression(impressionData);
61
- try { // @ts-ignore. An exception on the listeners should not break the SDK.
62
- if (impressionListener)
63
- impressionListener.logImpression(impressionData);
64
- }
65
- catch (err) {
66
- log.error(constants_1.ERROR_IMPRESSIONS_LISTENER, [err]);
67
- }
68
- }, 0);
56
+ whenInit(function () {
57
+ // Wrap in a timeout because we don't want it to be blocking.
58
+ setTimeout(function () {
59
+ // integrationsManager.handleImpression does not throw errors
60
+ if (integrationsManager)
61
+ integrationsManager.handleImpression(impressionData);
62
+ try { // @ts-ignore. An exception on the listeners should not break the SDK.
63
+ if (impressionListener)
64
+ impressionListener.logImpression(impressionData);
65
+ }
66
+ catch (err) {
67
+ log.error(constants_1.ERROR_IMPRESSIONS_LISTENER, [err]);
68
+ }
69
+ });
70
+ });
69
71
  };
70
72
  for (var i = 0; i < impressionsToListenerCount; i++) {
71
73
  _loop_1(i);
@@ -19,9 +19,6 @@ var noopFilterAdapter = {
19
19
  function uniqueKeysTrackerFactory(log, uniqueKeysCache, filterAdapter) {
20
20
  if (filterAdapter === void 0) { filterAdapter = noopFilterAdapter; }
21
21
  var intervalId;
22
- if (filterAdapter.refreshRate) {
23
- intervalId = setInterval(filterAdapter.clear, filterAdapter.refreshRate);
24
- }
25
22
  return {
26
23
  track: function (key, featureName) {
27
24
  if (!filterAdapter.add(key, featureName)) {
@@ -30,6 +27,11 @@ function uniqueKeysTrackerFactory(log, uniqueKeysCache, filterAdapter) {
30
27
  }
31
28
  uniqueKeysCache.track(key, featureName);
32
29
  },
30
+ start: function () {
31
+ if (filterAdapter.refreshRate) {
32
+ intervalId = setInterval(filterAdapter.clear, filterAdapter.refreshRate);
33
+ }
34
+ },
33
35
  stop: function () {
34
36
  clearInterval(intervalId);
35
37
  }
@@ -1,9 +1,16 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.validateStorageCS = void 0;
3
+ exports.validateStorageCS = exports.__InLocalStorageMockFactory = void 0;
4
4
  var InMemoryStorageCS_1 = require("../../../storages/inMemory/InMemoryStorageCS");
5
5
  var constants_1 = require("../../../logger/constants");
6
6
  var constants_2 = require("../../../utils/constants");
7
+ function __InLocalStorageMockFactory(params) {
8
+ var result = (0, InMemoryStorageCS_1.InMemoryStorageCSFactory)(params);
9
+ result.splits.checkCache = function () { return true; }; // to emit SDK_READY_FROM_CACHE
10
+ return result;
11
+ }
12
+ exports.__InLocalStorageMockFactory = __InLocalStorageMockFactory;
13
+ __InLocalStorageMockFactory.type = constants_2.STORAGE_MEMORY;
7
14
  /**
8
15
  * This function validates `settings.storage` object
9
16
  *
@@ -20,6 +27,10 @@ function validateStorageCS(settings) {
20
27
  storage = InMemoryStorageCS_1.InMemoryStorageCSFactory;
21
28
  log.error(constants_1.ERROR_STORAGE_INVALID);
22
29
  }
30
+ // In localhost mode with InLocalStorage, fallback to a mock InLocalStorage to emit SDK_READY_FROM_CACHE
31
+ if (mode === constants_2.LOCALHOST_MODE && storage.type === constants_2.STORAGE_LOCALSTORAGE) {
32
+ return __InLocalStorageMockFactory;
33
+ }
23
34
  if ([constants_2.LOCALHOST_MODE, constants_2.STANDALONE_MODE].indexOf(mode) === -1) {
24
35
  // Consumer modes require an async storage
25
36
  if (storage.type !== constants_2.STORAGE_PLUGGABLE)
@@ -4,6 +4,8 @@ function splitsEventEmitterFactory(EventEmitter) {
4
4
  var splitsEventEmitter = objectAssign(new EventEmitter(), {
5
5
  splitsArrived: false,
6
6
  splitsCacheLoaded: false,
7
+ initialized: false,
8
+ initCallbacks: []
7
9
  });
8
10
  // `isSplitKill` condition avoids an edge-case of wrongly emitting SDK_READY if:
9
11
  // - `/memberships` fetch and SPLIT_KILL occurs before `/splitChanges` fetch, and
@@ -43,7 +45,7 @@ export function readinessManagerFactory(EventEmitter, settings, splits) {
43
45
  // emit SDK_READY_TIMED_OUT
44
46
  var hasTimedout = false;
45
47
  function timeout() {
46
- if (hasTimedout)
48
+ if (hasTimedout || isReady)
47
49
  return;
48
50
  hasTimedout = true;
49
51
  syncLastUpdate();
@@ -51,7 +53,10 @@ export function readinessManagerFactory(EventEmitter, settings, splits) {
51
53
  }
52
54
  var readyTimeoutId;
53
55
  if (readyTimeout > 0) {
54
- readyTimeoutId = setTimeout(timeout, readyTimeout);
56
+ if (splits.initialized)
57
+ readyTimeoutId = setTimeout(timeout, readyTimeout);
58
+ else
59
+ splits.initCallbacks.push(function () { readyTimeoutId = setTimeout(timeout, readyTimeout); });
55
60
  }
56
61
  // emit SDK_READY and SDK_UPDATE
57
62
  var isReady = false;
@@ -113,6 +118,12 @@ export function readinessManagerFactory(EventEmitter, settings, splits) {
113
118
  // Called on 403 error (client-side SDK key on server-side), to set the SDK as destroyed for
114
119
  // tracking and evaluations, while keeping event listeners to emit SDK_READY_TIMED_OUT event
115
120
  setDestroyed: function () { isDestroyed = true; },
121
+ init: function () {
122
+ if (splits.initialized)
123
+ return;
124
+ splits.initialized = true;
125
+ splits.initCallbacks.forEach(function (cb) { return cb(); });
126
+ },
116
127
  destroy: function () {
117
128
  isDestroyed = true;
118
129
  syncLastUpdate();
@@ -52,7 +52,6 @@ export function sdkClientMethodCSFactory(params) {
52
52
  storage: sharedStorage || storage,
53
53
  syncManager: sharedSyncManager,
54
54
  }), true), validKey);
55
- sharedSyncManager && sharedSyncManager.start();
56
55
  log.info(NEW_SHARED_CLIENT);
57
56
  }
58
57
  else {
@@ -61,7 +61,6 @@ export function sdkClientMethodCSFactory(params) {
61
61
  storage: sharedStorage || storage,
62
62
  syncManager: sharedSyncManager,
63
63
  }), true), validKey, validTrafficType);
64
- sharedSyncManager && sharedSyncManager.start();
65
64
  log.info(NEW_SHARED_CLIENT);
66
65
  }
67
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,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,10 +42,8 @@ export function sdkFactory(params) {
35
42
  readiness.splits.emit(SDK_SPLITS_ARRIVED);
36
43
  readiness.segments.emit(SDK_SEGMENTS_ARRIVED);
37
44
  },
38
- onReadyFromCacheCb: function () {
39
- readiness.splits.emit(SDK_SPLITS_CACHE_LOADED);
40
- }
41
45
  });
46
+ // @TODO add support for dataloader: `if (params.dataLoader) params.dataLoader(storage);`
42
47
  var clients = {};
43
48
  var telemetryTracker = telemetryTrackerFactory(storage.telemetry, platform.now);
44
49
  var integrationsManager = integrationsManagerFactory && integrationsManagerFactory({ settings: settings, storage: storage, telemetryTracker: telemetryTracker });
@@ -55,8 +60,8 @@ export function sdkFactory(params) {
55
60
  default:
56
61
  strategy = strategyDebugFactory(observer);
57
62
  }
58
- var impressionsTracker = impressionsTrackerFactory(settings, storage.impressions, strategy, integrationsManager, storage.telemetry);
59
- var eventTracker = eventTrackerFactory(settings, storage.events, integrationsManager, storage.telemetry);
63
+ var impressionsTracker = impressionsTrackerFactory(settings, storage.impressions, strategy, whenInit, integrationsManager, storage.telemetry);
64
+ var eventTracker = eventTrackerFactory(settings, storage.events, whenInit, integrationsManager, storage.telemetry);
60
65
  // splitApi is used by SyncManager and Browser signal listener
61
66
  var splitApi = splitApiFactory && splitApiFactory(settings, platform, telemetryTracker);
62
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 };
@@ -67,8 +72,19 @@ export function sdkFactory(params) {
67
72
  // SDK client and manager
68
73
  var clientMethod = sdkClientMethodFactory(ctx);
69
74
  var managerInstance = sdkManagerFactory(settings, storage.splits, sdkReadinessManager);
70
- syncManager && syncManager.start();
71
- signalListener && signalListener.start();
75
+ function init() {
76
+ if (hasInit)
77
+ return;
78
+ hasInit = true;
79
+ // We will just log and allow for the SDK to end up throwing an SDK_TIMEOUT event for devs to handle.
80
+ validateAndTrackApiKey(log, settings.core.authorizationKey);
81
+ readiness.init();
82
+ uniqueKeysTracker && uniqueKeysTracker.start();
83
+ syncManager && syncManager.start();
84
+ signalListener && signalListener.start();
85
+ initCallbacks.forEach(function (cb) { return cb(); });
86
+ initCallbacks.length = 0;
87
+ }
72
88
  log.info(NEW_FACTORY);
73
89
  // @ts-ignore
74
90
  return objectAssign({
@@ -85,5 +101,5 @@ export function sdkFactory(params) {
85
101
  destroy: function () {
86
102
  return Promise.all(Object.keys(clients).map(function (key) { return clients[key].destroy(); })).then(function () { });
87
103
  }
88
- }, extraProps && extraProps(ctx));
104
+ }, extraProps && extraProps(ctx), lazyInit ? { init: init } : init());
89
105
  }