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

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 (73) hide show
  1. package/CHANGES.txt +1 -0
  2. package/cjs/readiness/readinessManager.js +7 -5
  3. package/cjs/sdkClient/sdkClientMethodCS.js +7 -4
  4. package/cjs/sdkClient/sdkClientMethodCSWithTT.js +7 -4
  5. package/cjs/sdkFactory/index.js +33 -10
  6. package/cjs/storages/AbstractSplitsCacheAsync.js +0 -7
  7. package/cjs/storages/AbstractSplitsCacheSync.js +0 -7
  8. package/cjs/storages/dataLoader.js +64 -32
  9. package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js +1 -9
  10. package/cjs/storages/inLocalStorage/index.js +6 -1
  11. package/cjs/storages/inMemory/InMemoryStorageCS.js +16 -4
  12. package/cjs/storages/inRedis/RedisAdapter.js +1 -1
  13. package/cjs/storages/pluggable/index.js +37 -32
  14. package/cjs/sync/offline/syncTasks/fromObjectSyncTask.js +2 -7
  15. package/cjs/sync/polling/updaters/splitChangesUpdater.js +1 -10
  16. package/cjs/trackers/eventTracker.js +11 -9
  17. package/cjs/trackers/impressionsTracker.js +15 -13
  18. package/cjs/trackers/uniqueKeysTracker.js +5 -3
  19. package/cjs/utils/settingsValidation/storage/storageCS.js +1 -12
  20. package/esm/readiness/readinessManager.js +7 -5
  21. package/esm/sdkClient/sdkClientMethodCS.js +7 -4
  22. package/esm/sdkClient/sdkClientMethodCSWithTT.js +7 -4
  23. package/esm/sdkFactory/index.js +34 -11
  24. package/esm/storages/AbstractSplitsCacheAsync.js +0 -7
  25. package/esm/storages/AbstractSplitsCacheSync.js +0 -7
  26. package/esm/storages/dataLoader.js +61 -30
  27. package/esm/storages/inLocalStorage/SplitsCacheInLocal.js +1 -9
  28. package/esm/storages/inLocalStorage/index.js +7 -2
  29. package/esm/storages/inMemory/InMemoryStorageCS.js +16 -4
  30. package/esm/storages/inRedis/RedisAdapter.js +1 -1
  31. package/esm/storages/pluggable/index.js +37 -32
  32. package/esm/sync/offline/syncTasks/fromObjectSyncTask.js +3 -8
  33. package/esm/sync/polling/updaters/splitChangesUpdater.js +2 -11
  34. package/esm/trackers/eventTracker.js +11 -9
  35. package/esm/trackers/impressionsTracker.js +15 -13
  36. package/esm/trackers/uniqueKeysTracker.js +5 -3
  37. package/esm/utils/settingsValidation/storage/storageCS.js +0 -10
  38. package/package.json +1 -1
  39. package/src/readiness/readinessManager.ts +9 -7
  40. package/src/readiness/types.ts +1 -0
  41. package/src/sdkClient/sdkClientMethodCS.ts +5 -2
  42. package/src/sdkClient/sdkClientMethodCSWithTT.ts +5 -2
  43. package/src/sdkFactory/index.ts +37 -12
  44. package/src/sdkFactory/types.ts +3 -0
  45. package/src/storages/AbstractSplitsCacheAsync.ts +0 -8
  46. package/src/storages/AbstractSplitsCacheSync.ts +0 -8
  47. package/src/storages/dataLoader.ts +62 -32
  48. package/src/storages/inLocalStorage/SplitsCacheInLocal.ts +1 -10
  49. package/src/storages/inLocalStorage/index.ts +8 -2
  50. package/src/storages/inMemory/InMemoryStorageCS.ts +19 -4
  51. package/src/storages/inRedis/RedisAdapter.ts +1 -1
  52. package/src/storages/pluggable/index.ts +38 -33
  53. package/src/storages/types.ts +2 -6
  54. package/src/sync/offline/syncTasks/fromObjectSyncTask.ts +3 -7
  55. package/src/sync/polling/updaters/splitChangesUpdater.ts +3 -11
  56. package/src/trackers/eventTracker.ts +10 -7
  57. package/src/trackers/impressionsTracker.ts +12 -9
  58. package/src/trackers/types.ts +1 -0
  59. package/src/trackers/uniqueKeysTracker.ts +6 -4
  60. package/src/types.ts +9 -8
  61. package/src/utils/settingsValidation/storage/storageCS.ts +0 -13
  62. package/types/readiness/types.d.ts +1 -0
  63. package/types/sdkFactory/types.d.ts +2 -0
  64. package/types/storages/AbstractSplitsCacheAsync.d.ts +0 -5
  65. package/types/storages/AbstractSplitsCacheSync.d.ts +0 -5
  66. package/types/storages/dataLoader.d.ts +17 -6
  67. package/types/storages/inLocalStorage/SplitsCacheInLocal.d.ts +0 -6
  68. package/types/storages/types.d.ts +2 -4
  69. package/types/trackers/eventTracker.d.ts +1 -1
  70. package/types/trackers/impressionsTracker.d.ts +1 -1
  71. package/types/trackers/types.d.ts +1 -0
  72. package/types/types.d.ts +8 -8
  73. package/types/utils/settingsValidation/storage/storageCS.d.ts +0 -5
@@ -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) {
@@ -54,18 +54,20 @@ function impressionsTrackerFactory(settings, impressionsCache, strategy, integra
54
54
  sdkLanguageVersion: version
55
55
  };
56
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);
57
+ whenInit(function () {
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,16 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.validateStorageCS = exports.__InLocalStorageMockFactory = void 0;
3
+ exports.validateStorageCS = 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;
14
7
  /**
15
8
  * This function validates `settings.storage` object
16
9
  *
@@ -27,10 +20,6 @@ function validateStorageCS(settings) {
27
20
  storage = InMemoryStorageCS_1.InMemoryStorageCSFactory;
28
21
  log.error(constants_1.ERROR_STORAGE_INVALID);
29
22
  }
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
- }
34
23
  if ([constants_2.LOCALHOST_MODE, constants_2.STANDALONE_MODE].indexOf(mode) === -1) {
35
24
  // Consumer modes require an async storage
36
25
  if (storage.type !== constants_2.STORAGE_PLUGGABLE)
@@ -42,17 +42,14 @@ export function readinessManagerFactory(EventEmitter, settings, splits) {
42
42
  splits.once(SDK_SPLITS_CACHE_LOADED, checkIsReadyFromCache);
43
43
  // emit SDK_READY_TIMED_OUT
44
44
  var hasTimedout = false;
45
+ var readyTimeoutId;
45
46
  function timeout() {
46
- if (hasTimedout)
47
+ if (hasTimedout || isReady)
47
48
  return;
48
49
  hasTimedout = true;
49
50
  syncLastUpdate();
50
51
  gate.emit(SDK_READY_TIMED_OUT, 'Split SDK emitted SDK_READY_TIMED_OUT event.');
51
52
  }
52
- var readyTimeoutId;
53
- if (readyTimeout > 0) {
54
- readyTimeoutId = setTimeout(timeout, readyTimeout);
55
- }
56
53
  // emit SDK_READY and SDK_UPDATE
57
54
  var isReady = false;
58
55
  splits.on(SDK_SPLITS_ARRIVED, checkIsReadyOrUpdate);
@@ -113,6 +110,11 @@ export function readinessManagerFactory(EventEmitter, settings, splits) {
113
110
  // Called on 403 error (client-side SDK key on server-side), to set the SDK as destroyed for
114
111
  // tracking and evaluations, while keeping event listeners to emit SDK_READY_TIMED_OUT event
115
112
  setDestroyed: function () { isDestroyed = true; },
113
+ init: function () {
114
+ if (readyTimeout > 0) {
115
+ readyTimeoutId = setTimeout(timeout, readyTimeout);
116
+ }
117
+ },
116
118
  destroy: function () {
117
119
  isDestroyed = true;
118
120
  syncLastUpdate();
@@ -11,7 +11,7 @@ import { buildInstanceId } from './identity';
11
11
  * Therefore, clients don't have a bound TT for the track method.
12
12
  */
13
13
  export function sdkClientMethodCSFactory(params) {
14
- var clients = params.clients, storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, key = _a.core.key, log = _a.log;
14
+ var clients = params.clients, storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, key = _a.core.key, log = _a.log, whenInit = params.whenInit;
15
15
  var mainClientInstance = clientCSDecorator(log, sdkClientFactory(params), key);
16
16
  var parsedDefaultKey = keyParser(key);
17
17
  var defaultInstanceId = buildInstanceId(parsedDefaultKey);
@@ -44,15 +44,18 @@ export function sdkClientMethodCSFactory(params) {
44
44
  // - Consumer mode: both syncManager and sharedSyncManager are undefined
45
45
  // - Consumer partial mode: syncManager is defined (only for submitters) but sharedSyncManager is undefined
46
46
  // @ts-ignore
47
- var sharedSyncManager = syncManager && sharedStorage && syncManager.shared(matchingKey, sharedSdkReadiness_1.readinessManager, sharedStorage);
47
+ var sharedSyncManager_1 = syncManager && sharedStorage && syncManager.shared(matchingKey, sharedSdkReadiness_1.readinessManager, sharedStorage);
48
48
  // As shared clients reuse all the storage information, we don't need to check here if we
49
49
  // will use offline or online mode. We should stick with the original decision.
50
50
  clients[instanceId] = clientCSDecorator(log, sdkClientFactory(objectAssign({}, params, {
51
51
  sdkReadinessManager: sharedSdkReadiness_1,
52
52
  storage: sharedStorage || storage,
53
- syncManager: sharedSyncManager,
53
+ syncManager: sharedSyncManager_1,
54
54
  }), true), validKey);
55
- sharedSyncManager && sharedSyncManager.start();
55
+ whenInit(function () {
56
+ sharedSdkReadiness_1.readinessManager.init();
57
+ sharedSyncManager_1 && sharedSyncManager_1.start();
58
+ });
56
59
  log.info(NEW_SHARED_CLIENT);
57
60
  }
58
61
  else {
@@ -13,7 +13,7 @@ import { buildInstanceId } from './identity';
13
13
  * (default client) or the client method (shared clients).
14
14
  */
15
15
  export function sdkClientMethodCSFactory(params) {
16
- var clients = params.clients, storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, _b = _a.core, key = _b.key, trafficType = _b.trafficType, log = _a.log;
16
+ var clients = params.clients, storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, _b = _a.core, key = _b.key, trafficType = _b.trafficType, log = _a.log, whenInit = params.whenInit;
17
17
  var mainClientInstance = clientCSDecorator(log, sdkClientFactory(params), key, trafficType);
18
18
  var parsedDefaultKey = keyParser(key);
19
19
  var defaultInstanceId = buildInstanceId(parsedDefaultKey, trafficType);
@@ -53,15 +53,18 @@ export function sdkClientMethodCSFactory(params) {
53
53
  // - Consumer mode: both syncManager and sharedSyncManager are undefined
54
54
  // - Consumer partial mode: syncManager is defined (only for submitters) but sharedSyncManager is undefined
55
55
  // @ts-ignore
56
- var sharedSyncManager = syncManager && sharedStorage && syncManager.shared(matchingKey, sharedSdkReadiness_1.readinessManager, sharedStorage);
56
+ var sharedSyncManager_1 = syncManager && sharedStorage && syncManager.shared(matchingKey, sharedSdkReadiness_1.readinessManager, sharedStorage);
57
57
  // As shared clients reuse all the storage information, we don't need to check here if we
58
58
  // will use offline or online mode. We should stick with the original decision.
59
59
  clients[instanceId] = clientCSDecorator(log, sdkClientFactory(objectAssign({}, params, {
60
60
  sdkReadinessManager: sharedSdkReadiness_1,
61
61
  storage: sharedStorage || storage,
62
- syncManager: sharedSyncManager,
62
+ syncManager: sharedSyncManager_1,
63
63
  }), true), validKey, validTrafficType);
64
- sharedSyncManager && sharedSyncManager.start();
64
+ whenInit(function () {
65
+ sharedSdkReadiness_1.readinessManager.init();
66
+ sharedSyncManager_1 && sharedSyncManager_1.start();
67
+ });
65
68
  log.info(NEW_SHARED_CLIENT);
66
69
  }
67
70
  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 } 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, isPure = params.isPure;
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 isInit = false;
25
+ var initCallbacks = [];
26
+ function whenInit(cb) {
27
+ if (isInit)
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,11 +62,11 @@ 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
- var ctx = { clients: clients, splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, uniqueKeysTracker: uniqueKeysTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform };
69
+ var ctx = { clients: clients, splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, uniqueKeysTracker: uniqueKeysTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform, whenInit: whenInit };
61
70
  var syncManager = syncManagerFactory && syncManagerFactory(ctx);
62
71
  ctx.syncManager = syncManager;
63
72
  var signalListener = SignalListener && new SignalListener(syncManager, settings, storage, splitApi);
@@ -65,8 +74,22 @@ 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 (isInit)
79
+ return;
80
+ isInit = 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
+ storage.init && storage.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
+ }
91
+ if (!isPure)
92
+ init();
70
93
  log.info(NEW_FACTORY);
71
94
  // @ts-ignore
72
95
  return objectAssign({
@@ -83,5 +106,5 @@ export function sdkFactory(params) {
83
106
  destroy: function () {
84
107
  return Promise.all(Object.keys(clients).map(function (key) { return clients[key].destroy(); })).then(function () { });
85
108
  }
86
- }, extraProps && extraProps(ctx));
109
+ }, extraProps && extraProps(ctx), isPure && { init: init });
87
110
  }
@@ -11,13 +11,6 @@ var AbstractSplitsCacheAsync = /** @class */ (function () {
11
11
  AbstractSplitsCacheAsync.prototype.usesSegments = function () {
12
12
  return Promise.resolve(true);
13
13
  };
14
- /**
15
- * Check if the splits information is already stored in cache.
16
- * Noop, just keeping the interface. This is used by client-side implementations only.
17
- */
18
- AbstractSplitsCacheAsync.prototype.checkCache = function () {
19
- return Promise.resolve(false);
20
- };
21
14
  /**
22
15
  * Kill `name` split and set `defaultTreatment` and `changeNumber`.
23
16
  * Used for SPLIT_KILL push notifications.
@@ -27,13 +27,6 @@ var AbstractSplitsCacheSync = /** @class */ (function () {
27
27
  var _this = this;
28
28
  return this.getSplitNames().map(function (key) { return _this.getSplit(key); });
29
29
  };
30
- /**
31
- * Check if the splits information is already stored in cache. This data can be preloaded.
32
- * It is used as condition to emit SDK_SPLITS_CACHE_LOADED, and then SDK_READY_FROM_CACHE.
33
- */
34
- AbstractSplitsCacheSync.prototype.checkCache = function () {
35
- return false;
36
- };
37
30
  /**
38
31
  * Kill `name` split and set `defaultTreatment` and `changeNumber`.
39
32
  * Used for SPLIT_KILL push notifications.
@@ -1,47 +1,78 @@
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];
30
+ storage.splits.addSplits(splitsData.map(function (split) { return ([split.name, split]); }));
31
+ }
32
+ if (matchingKey) { // add mySegments data (client-side)
33
+ var mySegmentsData = preloadedData.mySegmentsData && preloadedData.mySegmentsData[matchingKey];
38
34
  if (!mySegmentsData) {
39
35
  // 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
36
  mySegmentsData = Object.keys(segmentsData).filter(function (segmentName) {
41
- var userIds = JSON.parse(segmentsData[segmentName]).added;
42
- return Array.isArray(userIds) && userIds.indexOf(userId) > -1;
37
+ var matchingKeys = segmentsData[segmentName];
38
+ return matchingKeys.indexOf(matchingKey) > -1;
43
39
  });
44
40
  }
45
41
  storage.segments.resetSegments({ k: mySegmentsData.map(function (s) { return ({ n: s }); }) });
42
+ }
43
+ else { // add segments data (server-side)
44
+ Object.keys(segmentsData).filter(function (segmentName) {
45
+ var matchingKeys = segmentsData[segmentName];
46
+ storage.segments.addToSegment(segmentName, matchingKeys);
47
+ });
48
+ }
49
+ }
50
+ export function getSnapshot(storage, userKeys) {
51
+ return {
52
+ // lastUpdated: Date.now(),
53
+ since: storage.splits.getChangeNumber(),
54
+ splitsData: storage.splits.getAll(),
55
+ segmentsData: userKeys ?
56
+ undefined : // @ts-ignore accessing private prop
57
+ Object.keys(storage.segments.segmentCache).reduce(function (prev, cur) {
58
+ prev[cur] = setToArray(storage.segments.segmentCache[cur]);
59
+ return prev;
60
+ }, {}),
61
+ mySegmentsData: userKeys ?
62
+ userKeys.reduce(function (prev, userKey) {
63
+ prev[getMatching(userKey)] = storage.shared ?
64
+ // Client-side segments
65
+ // @ts-ignore accessing private prop
66
+ Object.keys(storage.shared(userKey).segments.segmentCache) :
67
+ // Server-side segments
68
+ // @ts-ignore accessing private prop
69
+ Object.keys(storage.segments.segmentCache).reduce(function (prev, segmentName) {
70
+ return storage.segments.segmentCache[segmentName].has(userKey) ?
71
+ prev.concat(segmentName) :
72
+ prev;
73
+ }, []);
74
+ return prev;
75
+ }, {}) :
76
+ undefined
46
77
  };
47
78
  }
@@ -183,14 +183,6 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
183
183
  return true;
184
184
  }
185
185
  };
186
- /**
187
- * Check if the splits information is already stored in browser LocalStorage.
188
- * In this function we could add more code to check if the data is valid.
189
- * @override
190
- */
191
- SplitsCacheInLocal.prototype.checkCache = function () {
192
- return this.getChangeNumber() > -1;
193
- };
194
186
  /**
195
187
  * Clean Splits cache if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
196
188
  *
@@ -213,7 +205,7 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
213
205
  // mark cache to update the new query filter on first successful splits fetch
214
206
  this.updateNewFilter = true;
215
207
  // if there is cache, clear it
216
- if (this.checkCache())
208
+ if (this.getChangeNumber() > -1)
217
209
  this.clear();
218
210
  }
219
211
  catch (e) {
@@ -11,7 +11,7 @@ import { SplitsCacheInMemory } from '../inMemory/SplitsCacheInMemory';
11
11
  import { DEFAULT_CACHE_EXPIRATION_IN_MILLIS } from '../../utils/constants/browser';
12
12
  import { InMemoryStorageCSFactory } from '../inMemory/InMemoryStorageCS';
13
13
  import { LOG_PREFIX } from './constants';
14
- import { DEBUG, NONE, STORAGE_LOCALSTORAGE } from '../../utils/constants';
14
+ import { DEBUG, LOCALHOST_MODE, NONE, STORAGE_LOCALSTORAGE } from '../../utils/constants';
15
15
  import { shouldRecordTelemetry, TelemetryCacheInMemory } from '../inMemory/TelemetryCacheInMemory';
16
16
  import { UniqueKeysCacheInMemoryCS } from '../inMemory/UniqueKeysCacheInMemoryCS';
17
17
  import { getMatching } from '../../utils/key';
@@ -27,7 +27,7 @@ export function InLocalStorage(options) {
27
27
  params.settings.log.warn(LOG_PREFIX + 'LocalStorage API is unavailable. Falling back to default MEMORY storage');
28
28
  return InMemoryStorageCSFactory(params);
29
29
  }
30
- var settings = params.settings, _a = params.settings, log = _a.log, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__splitFiltersValidation;
30
+ var 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;
31
31
  var matchingKey = getMatching(settings.core.key);
32
32
  var keys = new KeyBuilderCS(prefix, matchingKey);
33
33
  var expirationTimestamp = Date.now() - DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
@@ -43,6 +43,11 @@ export function InLocalStorage(options) {
43
43
  events: new EventsCacheInMemory(eventsQueueSize),
44
44
  telemetry: shouldRecordTelemetry(params) ? new TelemetryCacheInMemory(splits, segments) : undefined,
45
45
  uniqueKeys: impressionsMode === NONE ? new UniqueKeysCacheInMemoryCS() : undefined,
46
+ init: function () {
47
+ if (settings.mode === LOCALHOST_MODE || splits.getChangeNumber() > -1) {
48
+ Promise.resolve().then(onReadyFromCacheCb);
49
+ }
50
+ },
46
51
  destroy: function () {
47
52
  var _a;
48
53
  this.splits = new SplitsCacheInMemory(__splitFiltersValidation);
@@ -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();
@@ -36,11 +38,16 @@ export function InMemoryStorageCSFactory(params) {
36
38
  this.uniqueKeys && this.uniqueKeys.clear();
37
39
  },
38
40
  // When using shared instanciation with MEMORY we reuse everything but segments (they are unique per key)
39
- shared: function () {
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,
@@ -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;
@@ -17,7 +17,7 @@ var DEFAULT_OPTIONS = {
17
17
  var DEFAULT_LIBRARY_OPTIONS = {
18
18
  enableOfflineQueue: false,
19
19
  connectTimeout: DEFAULT_OPTIONS.connectionTimeout,
20
- lazyConnect: false
20
+ lazyConnect: false // @TODO true to avoid side-effects on instantiation.
21
21
  };
22
22
  /**
23
23
  * Redis adapter on top of the library of choice (written with ioredis) for some extra control.
@@ -55,6 +55,7 @@ export function PluggableStorage(options) {
55
55
  var metadata = metadataBuilder(settings);
56
56
  var keys = new KeyBuilderSS(prefix, metadata);
57
57
  var wrapper = wrapperAdapter(log, options.wrapper);
58
+ var connectPromise;
58
59
  var isSyncronizer = mode === undefined; // If mode is not defined, the synchronizer is running
59
60
  var isPartialConsumer = mode === CONSUMER_PARTIAL_MODE;
60
61
  var telemetry = shouldRecordTelemetry(params) || isSyncronizer ?
@@ -72,37 +73,6 @@ export function PluggableStorage(options) {
72
73
  settings.core.key === undefined ? new UniqueKeysCacheInMemory() : new UniqueKeysCacheInMemoryCS() :
73
74
  new UniqueKeysCachePluggable(log, keys.buildUniqueKeysKey(), wrapper) :
74
75
  undefined;
75
- // Connects to wrapper and emits SDK_READY event on main client
76
- var connectPromise = wrapper.connect().then(function () {
77
- if (isSyncronizer) {
78
- // In standalone or producer mode, clear storage if SDK key or feature flag filter has changed
79
- return wrapper.get(keys.buildHashKey()).then(function (hash) {
80
- var currentHash = getStorageHash(settings);
81
- if (hash !== currentHash) {
82
- log.info(LOG_PREFIX + 'Storage HASH has changed (SDK key, flags filter criteria or flags spec version was modified). Clearing cache');
83
- return wrapper.getKeysByPrefix(keys.prefix + ".").then(function (storageKeys) {
84
- return Promise.all(storageKeys.map(function (storageKey) { return wrapper.del(storageKey); }));
85
- }).then(function () { return wrapper.set(keys.buildHashKey(), currentHash); });
86
- }
87
- }).then(function () {
88
- onReadyCb();
89
- });
90
- }
91
- else {
92
- // Start periodic flush of async storages if not running synchronizer (producer mode)
93
- if (impressionCountsCache && impressionCountsCache.start)
94
- impressionCountsCache.start();
95
- if (uniqueKeysCache && uniqueKeysCache.start)
96
- uniqueKeysCache.start();
97
- if (telemetry && telemetry.recordConfig)
98
- telemetry.recordConfig();
99
- onReadyCb();
100
- }
101
- }).catch(function (e) {
102
- e = e || new Error('Error connecting wrapper');
103
- onReadyCb(e);
104
- return e; // Propagate error for shared clients
105
- });
106
76
  return {
107
77
  splits: new SplitsCachePluggable(log, keys, wrapper, settings.sync.__splitFiltersValidation),
108
78
  segments: new SegmentsCachePluggable(log, keys, wrapper),
@@ -111,6 +81,41 @@ export function PluggableStorage(options) {
111
81
  events: isPartialConsumer ? promisifyEventsTrack(new EventsCacheInMemory(eventsQueueSize)) : new EventsCachePluggable(log, keys.buildEventsKey(), wrapper, metadata),
112
82
  telemetry: telemetry,
113
83
  uniqueKeys: uniqueKeysCache,
84
+ init: function () {
85
+ if (connectPromise)
86
+ return connectPromise;
87
+ // Connects to wrapper and emits SDK_READY event on main client
88
+ return connectPromise = wrapper.connect().then(function () {
89
+ if (isSyncronizer) {
90
+ // In standalone or producer mode, clear storage if SDK key or feature flag filter has changed
91
+ return wrapper.get(keys.buildHashKey()).then(function (hash) {
92
+ var currentHash = getStorageHash(settings);
93
+ if (hash !== currentHash) {
94
+ log.info(LOG_PREFIX + 'Storage HASH has changed (SDK key, flags filter criteria or flags spec version was modified). Clearing cache');
95
+ return wrapper.getKeysByPrefix(keys.prefix + ".").then(function (storageKeys) {
96
+ return Promise.all(storageKeys.map(function (storageKey) { return wrapper.del(storageKey); }));
97
+ }).then(function () { return wrapper.set(keys.buildHashKey(), currentHash); });
98
+ }
99
+ }).then(function () {
100
+ onReadyCb();
101
+ });
102
+ }
103
+ else {
104
+ // Start periodic flush of async storages if not running synchronizer (producer mode)
105
+ if (impressionCountsCache && impressionCountsCache.start)
106
+ impressionCountsCache.start();
107
+ if (uniqueKeysCache && uniqueKeysCache.start)
108
+ uniqueKeysCache.start();
109
+ if (telemetry && telemetry.recordConfig)
110
+ telemetry.recordConfig();
111
+ onReadyCb();
112
+ }
113
+ }).catch(function (e) {
114
+ e = e || new Error('Error connecting wrapper');
115
+ onReadyCb(e);
116
+ return e; // Propagate error for shared clients
117
+ });
118
+ },
114
119
  // Stop periodic flush and disconnect the underlying storage
115
120
  destroy: function () {
116
121
  return Promise.all(isSyncronizer ? [] : [
@@ -120,7 +125,7 @@ export function PluggableStorage(options) {
120
125
  },
121
126
  // emits SDK_READY event on shared clients and returns a reference to the storage
122
127
  shared: function (_, onReadyCb) {
123
- connectPromise.then(onReadyCb);
128
+ this.init().then(onReadyCb);
124
129
  return __assign(__assign({}, this), {
125
130
  // no-op destroy, to disconnect the wrapper only when the main client is destroyed
126
131
  destroy: function () { } });