@splitsoftware/splitio-commons 1.17.1-rc.2 → 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 (45) hide show
  1. package/cjs/readiness/readinessManager.js +7 -5
  2. package/cjs/sdkClient/sdkClientMethodCS.js +7 -4
  3. package/cjs/sdkClient/sdkClientMethodCSWithTT.js +7 -4
  4. package/cjs/sdkFactory/index.js +30 -9
  5. package/cjs/storages/dataLoader.js +10 -11
  6. package/cjs/storages/inLocalStorage/index.js +5 -3
  7. package/cjs/storages/inRedis/RedisAdapter.js +1 -1
  8. package/cjs/storages/pluggable/index.js +37 -32
  9. package/cjs/trackers/eventTracker.js +11 -9
  10. package/cjs/trackers/impressionsTracker.js +15 -13
  11. package/cjs/trackers/uniqueKeysTracker.js +5 -3
  12. package/esm/readiness/readinessManager.js +7 -5
  13. package/esm/sdkClient/sdkClientMethodCS.js +7 -4
  14. package/esm/sdkClient/sdkClientMethodCSWithTT.js +7 -4
  15. package/esm/sdkFactory/index.js +30 -9
  16. package/esm/storages/dataLoader.js +10 -11
  17. package/esm/storages/inLocalStorage/index.js +5 -3
  18. package/esm/storages/inRedis/RedisAdapter.js +1 -1
  19. package/esm/storages/pluggable/index.js +37 -32
  20. package/esm/trackers/eventTracker.js +11 -9
  21. package/esm/trackers/impressionsTracker.js +15 -13
  22. package/esm/trackers/uniqueKeysTracker.js +5 -3
  23. package/package.json +1 -1
  24. package/src/readiness/readinessManager.ts +9 -7
  25. package/src/readiness/types.ts +1 -0
  26. package/src/sdkClient/sdkClientMethodCS.ts +5 -2
  27. package/src/sdkClient/sdkClientMethodCSWithTT.ts +5 -2
  28. package/src/sdkFactory/index.ts +32 -10
  29. package/src/sdkFactory/types.ts +3 -0
  30. package/src/storages/dataLoader.ts +12 -13
  31. package/src/storages/inLocalStorage/index.ts +6 -4
  32. package/src/storages/inRedis/RedisAdapter.ts +1 -1
  33. package/src/storages/pluggable/index.ts +38 -33
  34. package/src/storages/types.ts +1 -0
  35. package/src/trackers/eventTracker.ts +10 -7
  36. package/src/trackers/impressionsTracker.ts +12 -9
  37. package/src/trackers/types.ts +1 -0
  38. package/src/trackers/uniqueKeysTracker.ts +6 -4
  39. package/types/readiness/types.d.ts +1 -0
  40. package/types/sdkFactory/types.d.ts +2 -0
  41. package/types/storages/dataLoader.d.ts +2 -2
  42. package/types/storages/types.d.ts +1 -0
  43. package/types/trackers/eventTracker.d.ts +1 -1
  44. package/types/trackers/impressionsTracker.d.ts +1 -1
  45. package/types/trackers/types.d.ts +1 -0
@@ -45,17 +45,14 @@ function readinessManagerFactory(EventEmitter, settings, splits) {
45
45
  splits.once(constants_1.SDK_SPLITS_CACHE_LOADED, checkIsReadyFromCache);
46
46
  // emit SDK_READY_TIMED_OUT
47
47
  var hasTimedout = false;
48
+ var readyTimeoutId;
48
49
  function timeout() {
49
- if (hasTimedout)
50
+ if (hasTimedout || isReady)
50
51
  return;
51
52
  hasTimedout = true;
52
53
  syncLastUpdate();
53
54
  gate.emit(constants_1.SDK_READY_TIMED_OUT, 'Split SDK emitted SDK_READY_TIMED_OUT event.');
54
55
  }
55
- var readyTimeoutId;
56
- if (readyTimeout > 0) {
57
- readyTimeoutId = setTimeout(timeout, readyTimeout);
58
- }
59
56
  // emit SDK_READY and SDK_UPDATE
60
57
  var isReady = false;
61
58
  splits.on(constants_1.SDK_SPLITS_ARRIVED, checkIsReadyOrUpdate);
@@ -116,6 +113,11 @@ function readinessManagerFactory(EventEmitter, settings, splits) {
116
113
  // Called on 403 error (client-side SDK key on server-side), to set the SDK as destroyed for
117
114
  // tracking and evaluations, while keeping event listeners to emit SDK_READY_TIMED_OUT event
118
115
  setDestroyed: function () { isDestroyed = true; },
116
+ init: function () {
117
+ if (readyTimeout > 0) {
118
+ readyTimeoutId = setTimeout(timeout, readyTimeout);
119
+ }
120
+ },
119
121
  destroy: function () {
120
122
  isDestroyed = true;
121
123
  syncLastUpdate();
@@ -14,7 +14,7 @@ var identity_1 = require("./identity");
14
14
  * Therefore, clients don't have a bound TT for the track method.
15
15
  */
16
16
  function sdkClientMethodCSFactory(params) {
17
- var clients = params.clients, storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, key = _a.core.key, log = _a.log;
17
+ 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;
18
18
  var mainClientInstance = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)(params), key);
19
19
  var parsedDefaultKey = (0, key_2.keyParser)(key);
20
20
  var defaultInstanceId = (0, identity_1.buildInstanceId)(parsedDefaultKey);
@@ -47,15 +47,18 @@ function sdkClientMethodCSFactory(params) {
47
47
  // - Consumer mode: both syncManager and sharedSyncManager are undefined
48
48
  // - Consumer partial mode: syncManager is defined (only for submitters) but sharedSyncManager is undefined
49
49
  // @ts-ignore
50
- var sharedSyncManager = syncManager && sharedStorage && syncManager.shared(matchingKey, sharedSdkReadiness_1.readinessManager, sharedStorage);
50
+ var sharedSyncManager_1 = syncManager && sharedStorage && syncManager.shared(matchingKey, sharedSdkReadiness_1.readinessManager, sharedStorage);
51
51
  // As shared clients reuse all the storage information, we don't need to check here if we
52
52
  // will use offline or online mode. We should stick with the original decision.
53
53
  clients[instanceId] = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)((0, objectAssign_1.objectAssign)({}, params, {
54
54
  sdkReadinessManager: sharedSdkReadiness_1,
55
55
  storage: sharedStorage || storage,
56
- syncManager: sharedSyncManager,
56
+ syncManager: sharedSyncManager_1,
57
57
  }), true), validKey);
58
- sharedSyncManager && sharedSyncManager.start();
58
+ whenInit(function () {
59
+ sharedSdkReadiness_1.readinessManager.init();
60
+ sharedSyncManager_1 && sharedSyncManager_1.start();
61
+ });
59
62
  log.info(constants_1.NEW_SHARED_CLIENT);
60
63
  }
61
64
  else {
@@ -16,7 +16,7 @@ var identity_1 = require("./identity");
16
16
  * (default client) or the client method (shared clients).
17
17
  */
18
18
  function sdkClientMethodCSFactory(params) {
19
- 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;
19
+ 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;
20
20
  var mainClientInstance = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)(params), key, trafficType);
21
21
  var parsedDefaultKey = (0, key_2.keyParser)(key);
22
22
  var defaultInstanceId = (0, identity_1.buildInstanceId)(parsedDefaultKey, trafficType);
@@ -56,15 +56,18 @@ function sdkClientMethodCSFactory(params) {
56
56
  // - Consumer mode: both syncManager and sharedSyncManager are undefined
57
57
  // - Consumer partial mode: syncManager is defined (only for submitters) but sharedSyncManager is undefined
58
58
  // @ts-ignore
59
- var sharedSyncManager = syncManager && sharedStorage && syncManager.shared(matchingKey, sharedSdkReadiness_1.readinessManager, sharedStorage);
59
+ var sharedSyncManager_1 = syncManager && sharedStorage && syncManager.shared(matchingKey, sharedSdkReadiness_1.readinessManager, sharedStorage);
60
60
  // As shared clients reuse all the storage information, we don't need to check here if we
61
61
  // will use offline or online mode. We should stick with the original decision.
62
62
  clients[instanceId] = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)((0, objectAssign_1.objectAssign)({}, params, {
63
63
  sdkReadinessManager: sharedSdkReadiness_1,
64
64
  storage: sharedStorage || storage,
65
- syncManager: sharedSyncManager,
65
+ syncManager: sharedSyncManager_1,
66
66
  }), true), validKey, validTrafficType);
67
- sharedSyncManager && sharedSyncManager.start();
67
+ whenInit(function () {
68
+ sharedSdkReadiness_1.readinessManager.init();
69
+ sharedSyncManager_1 && sharedSyncManager_1.start();
70
+ });
68
71
  log.info(constants_1.NEW_SHARED_CLIENT);
69
72
  }
70
73
  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, isPure = params.isPure;
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 isInit = false;
28
+ var initCallbacks = [];
29
+ function whenInit(cb) {
30
+ if (isInit)
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({
@@ -58,11 +65,11 @@ function sdkFactory(params) {
58
65
  default:
59
66
  strategy = (0, strategyDebug_1.strategyDebugFactory)(observer);
60
67
  }
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);
68
+ var impressionsTracker = (0, impressionsTracker_1.impressionsTrackerFactory)(settings, storage.impressions, strategy, whenInit, integrationsManager, storage.telemetry);
69
+ var eventTracker = (0, eventTracker_1.eventTrackerFactory)(settings, storage.events, whenInit, integrationsManager, storage.telemetry);
63
70
  // splitApi is used by SyncManager and Browser signal listener
64
71
  var splitApi = splitApiFactory && splitApiFactory(settings, platform, telemetryTracker);
65
- var ctx = { clients: clients, splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, uniqueKeysTracker: uniqueKeysTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform };
72
+ 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 };
66
73
  var syncManager = syncManagerFactory && syncManagerFactory(ctx);
67
74
  ctx.syncManager = syncManager;
68
75
  var signalListener = SignalListener && new SignalListener(syncManager, settings, storage, splitApi);
@@ -70,8 +77,22 @@ function sdkFactory(params) {
70
77
  // SDK client and manager
71
78
  var clientMethod = sdkClientMethodFactory(ctx);
72
79
  var managerInstance = sdkManagerFactory(settings, storage.splits, sdkReadinessManager);
73
- syncManager && syncManager.start();
74
- signalListener && signalListener.start();
80
+ function init() {
81
+ if (isInit)
82
+ return;
83
+ isInit = true;
84
+ // We will just log and allow for the SDK to end up throwing an SDK_TIMEOUT event for devs to handle.
85
+ (0, apiKey_1.validateAndTrackApiKey)(log, settings.core.authorizationKey);
86
+ readiness.init();
87
+ storage.init && storage.init();
88
+ uniqueKeysTracker && uniqueKeysTracker.start();
89
+ syncManager && syncManager.start();
90
+ signalListener && signalListener.start();
91
+ initCallbacks.forEach(function (cb) { return cb(); });
92
+ initCallbacks.length = 0;
93
+ }
94
+ if (!isPure)
95
+ init();
75
96
  log.info(constants_1.NEW_FACTORY);
76
97
  // @ts-ignore
77
98
  return (0, objectAssign_1.objectAssign)({
@@ -88,6 +109,6 @@ function sdkFactory(params) {
88
109
  destroy: function () {
89
110
  return Promise.all(Object.keys(clients).map(function (key) { return clients[key].destroy(); })).then(function () { });
90
111
  }
91
- }, extraProps && extraProps(ctx));
112
+ }, extraProps && extraProps(ctx), isPure && { init: init });
92
113
  }
93
114
  exports.sdkFactory = sdkFactory;
@@ -2,6 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.getSnapshot = exports.loadData = void 0;
4
4
  var sets_1 = require("../utils/lang/sets");
5
+ var key_1 = require("../utils/key");
5
6
  /**
6
7
  * Storage-agnostic adaptation of `loadDataIntoLocalStorage` function
7
8
  * (https://github.com/godaddy/split-javascript-data-loader/blob/master/src/load-data.js)
@@ -15,7 +16,7 @@ var sets_1 = require("../utils/lang/sets");
15
16
  * @TODO add logs, and input validation in this module, in favor of size reduction.
16
17
  * @TODO unit tests
17
18
  */
18
- function loadData(preloadedData, storage, userKey) {
19
+ function loadData(preloadedData, storage, matchingKey) {
19
20
  // Do not load data if current preloadedData is empty
20
21
  if (Object.keys(preloadedData).length === 0)
21
22
  return;
@@ -31,21 +32,21 @@ function loadData(preloadedData, storage, userKey) {
31
32
  // splitsData in an object where the property is the split name and the pertaining value is a stringified json of its data
32
33
  storage.splits.addSplits(splitsData.map(function (split) { return ([split.name, split]); }));
33
34
  }
34
- if (userKey) { // add mySegments data (client-side)
35
- var mySegmentsData = preloadedData.mySegmentsData && preloadedData.mySegmentsData[userKey];
35
+ if (matchingKey) { // add mySegments data (client-side)
36
+ var mySegmentsData = preloadedData.mySegmentsData && preloadedData.mySegmentsData[matchingKey];
36
37
  if (!mySegmentsData) {
37
38
  // 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
39
  mySegmentsData = Object.keys(segmentsData).filter(function (segmentName) {
39
- var userKeys = segmentsData[segmentName];
40
- return userKeys.indexOf(userKey) > -1;
40
+ var matchingKeys = segmentsData[segmentName];
41
+ return matchingKeys.indexOf(matchingKey) > -1;
41
42
  });
42
43
  }
43
44
  storage.segments.resetSegments({ k: mySegmentsData.map(function (s) { return ({ n: s }); }) });
44
45
  }
45
46
  else { // add segments data (server-side)
46
47
  Object.keys(segmentsData).filter(function (segmentName) {
47
- var userKeys = segmentsData[segmentName];
48
- storage.segments.addToSegment(segmentName, userKeys);
48
+ var matchingKeys = segmentsData[segmentName];
49
+ storage.segments.addToSegment(segmentName, matchingKeys);
49
50
  });
50
51
  }
51
52
  }
@@ -53,8 +54,7 @@ exports.loadData = loadData;
53
54
  function getSnapshot(storage, userKeys) {
54
55
  return {
55
56
  // lastUpdated: Date.now(),
56
- // @ts-ignore accessing private prop
57
- since: storage.splits.changeNumber,
57
+ since: storage.splits.getChangeNumber(),
58
58
  splitsData: storage.splits.getAll(),
59
59
  segmentsData: userKeys ?
60
60
  undefined : // @ts-ignore accessing private prop
@@ -64,8 +64,7 @@ function getSnapshot(storage, userKeys) {
64
64
  }, {}),
65
65
  mySegmentsData: userKeys ?
66
66
  userKeys.reduce(function (prev, userKey) {
67
- // @ts-ignore accessing private prop
68
- prev[userKey] = storage.shared ?
67
+ prev[(0, key_1.getMatching)(userKey)] = storage.shared ?
69
68
  // Client-side segments
70
69
  // @ts-ignore accessing private prop
71
70
  Object.keys(storage.shared(userKey).segments.segmentCache) :
@@ -37,9 +37,6 @@ function InLocalStorage(options) {
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,
@@ -49,6 +46,11 @@ function InLocalStorage(options) {
49
46
  events: new EventsCacheInMemory_1.EventsCacheInMemory(eventsQueueSize),
50
47
  telemetry: (0, TelemetryCacheInMemory_1.shouldRecordTelemetry)(params) ? new TelemetryCacheInMemory_1.TelemetryCacheInMemory(splits, segments) : undefined,
51
48
  uniqueKeys: impressionsMode === constants_2.NONE ? new UniqueKeysCacheInMemoryCS_1.UniqueKeysCacheInMemoryCS() : undefined,
49
+ init: function () {
50
+ if (settings.mode === constants_2.LOCALHOST_MODE || splits.getChangeNumber() > -1) {
51
+ Promise.resolve().then(onReadyFromCacheCb);
52
+ }
53
+ },
52
54
  destroy: function () {
53
55
  var _a;
54
56
  this.splits = new SplitsCacheInMemory_1.SplitsCacheInMemory(__splitFiltersValidation);
@@ -20,7 +20,7 @@ var DEFAULT_OPTIONS = {
20
20
  var DEFAULT_LIBRARY_OPTIONS = {
21
21
  enableOfflineQueue: false,
22
22
  connectTimeout: DEFAULT_OPTIONS.connectionTimeout,
23
- lazyConnect: false
23
+ lazyConnect: false // @TODO true to avoid side-effects on instantiation.
24
24
  };
25
25
  /**
26
26
  * Redis adapter on top of the library of choice (written with ioredis) for some extra control.
@@ -58,6 +58,7 @@ function PluggableStorage(options) {
58
58
  var metadata = (0, utils_1.metadataBuilder)(settings);
59
59
  var keys = new KeyBuilderSS_1.KeyBuilderSS(prefix, metadata);
60
60
  var wrapper = (0, wrapperAdapter_1.wrapperAdapter)(log, options.wrapper);
61
+ var connectPromise;
61
62
  var isSyncronizer = mode === undefined; // If mode is not defined, the synchronizer is running
62
63
  var isPartialConsumer = mode === constants_1.CONSUMER_PARTIAL_MODE;
63
64
  var telemetry = (0, TelemetryCacheInMemory_1.shouldRecordTelemetry)(params) || isSyncronizer ?
@@ -75,37 +76,6 @@ function PluggableStorage(options) {
75
76
  settings.core.key === undefined ? new UniqueKeysCacheInMemory_1.UniqueKeysCacheInMemory() : new UniqueKeysCacheInMemoryCS_1.UniqueKeysCacheInMemoryCS() :
76
77
  new UniqueKeysCachePluggable_1.UniqueKeysCachePluggable(log, keys.buildUniqueKeysKey(), wrapper) :
77
78
  undefined;
78
- // Connects to wrapper and emits SDK_READY event on main client
79
- var connectPromise = wrapper.connect().then(function () {
80
- if (isSyncronizer) {
81
- // In standalone or producer mode, clear storage if SDK key or feature flag filter has changed
82
- return wrapper.get(keys.buildHashKey()).then(function (hash) {
83
- var currentHash = (0, KeyBuilder_1.getStorageHash)(settings);
84
- if (hash !== currentHash) {
85
- log.info(constants_2.LOG_PREFIX + 'Storage HASH has changed (SDK key, flags filter criteria or flags spec version was modified). Clearing cache');
86
- return wrapper.getKeysByPrefix(keys.prefix + ".").then(function (storageKeys) {
87
- return Promise.all(storageKeys.map(function (storageKey) { return wrapper.del(storageKey); }));
88
- }).then(function () { return wrapper.set(keys.buildHashKey(), currentHash); });
89
- }
90
- }).then(function () {
91
- onReadyCb();
92
- });
93
- }
94
- else {
95
- // Start periodic flush of async storages if not running synchronizer (producer mode)
96
- if (impressionCountsCache && impressionCountsCache.start)
97
- impressionCountsCache.start();
98
- if (uniqueKeysCache && uniqueKeysCache.start)
99
- uniqueKeysCache.start();
100
- if (telemetry && telemetry.recordConfig)
101
- telemetry.recordConfig();
102
- onReadyCb();
103
- }
104
- }).catch(function (e) {
105
- e = e || new Error('Error connecting wrapper');
106
- onReadyCb(e);
107
- return e; // Propagate error for shared clients
108
- });
109
79
  return {
110
80
  splits: new SplitsCachePluggable_1.SplitsCachePluggable(log, keys, wrapper, settings.sync.__splitFiltersValidation),
111
81
  segments: new SegmentsCachePluggable_1.SegmentsCachePluggable(log, keys, wrapper),
@@ -114,6 +84,41 @@ function PluggableStorage(options) {
114
84
  events: isPartialConsumer ? promisifyEventsTrack(new EventsCacheInMemory_1.EventsCacheInMemory(eventsQueueSize)) : new EventsCachePluggable_1.EventsCachePluggable(log, keys.buildEventsKey(), wrapper, metadata),
115
85
  telemetry: telemetry,
116
86
  uniqueKeys: uniqueKeysCache,
87
+ init: function () {
88
+ if (connectPromise)
89
+ return connectPromise;
90
+ // Connects to wrapper and emits SDK_READY event on main client
91
+ return connectPromise = wrapper.connect().then(function () {
92
+ if (isSyncronizer) {
93
+ // In standalone or producer mode, clear storage if SDK key or feature flag filter has changed
94
+ return wrapper.get(keys.buildHashKey()).then(function (hash) {
95
+ var currentHash = (0, KeyBuilder_1.getStorageHash)(settings);
96
+ if (hash !== currentHash) {
97
+ log.info(constants_2.LOG_PREFIX + 'Storage HASH has changed (SDK key, flags filter criteria or flags spec version was modified). Clearing cache');
98
+ return wrapper.getKeysByPrefix(keys.prefix + ".").then(function (storageKeys) {
99
+ return Promise.all(storageKeys.map(function (storageKey) { return wrapper.del(storageKey); }));
100
+ }).then(function () { return wrapper.set(keys.buildHashKey(), currentHash); });
101
+ }
102
+ }).then(function () {
103
+ onReadyCb();
104
+ });
105
+ }
106
+ else {
107
+ // Start periodic flush of async storages if not running synchronizer (producer mode)
108
+ if (impressionCountsCache && impressionCountsCache.start)
109
+ impressionCountsCache.start();
110
+ if (uniqueKeysCache && uniqueKeysCache.start)
111
+ uniqueKeysCache.start();
112
+ if (telemetry && telemetry.recordConfig)
113
+ telemetry.recordConfig();
114
+ onReadyCb();
115
+ }
116
+ }).catch(function (e) {
117
+ e = e || new Error('Error connecting wrapper');
118
+ onReadyCb(e);
119
+ return e; // Propagate error for shared clients
120
+ });
121
+ },
117
122
  // Stop periodic flush and disconnect the underlying storage
118
123
  destroy: function () {
119
124
  return Promise.all(isSyncronizer ? [] : [
@@ -123,7 +128,7 @@ function PluggableStorage(options) {
123
128
  },
124
129
  // emits SDK_READY event on shared clients and returns a reference to the storage
125
130
  shared: function (_, onReadyCb) {
126
- connectPromise.then(onReadyCb);
131
+ this.init().then(onReadyCb);
127
132
  return (0, tslib_1.__assign)((0, tslib_1.__assign)({}, this), {
128
133
  // no-op destroy, to disconnect the wrapper only when the main client is destroyed
129
134
  destroy: function () { } });
@@ -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) {
@@ -23,14 +23,16 @@ function eventTrackerFactory(settings, eventsCache, integrationsManager, telemet
23
23
  log.info(constants_1.EVENTS_TRACKER_SUCCESS, [msg]);
24
24
  if (integrationsManager) {
25
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);
26
+ whenInit(function () {
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) {
@@ -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
  }
@@ -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 {
@@ -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({
@@ -55,11 +62,11 @@ export function sdkFactory(params) {
55
62
  default:
56
63
  strategy = strategyDebugFactory(observer);
57
64
  }
58
- var impressionsTracker = impressionsTrackerFactory(settings, storage.impressions, strategy, integrationsManager, storage.telemetry);
59
- 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);
60
67
  // splitApi is used by SyncManager and Browser signal listener
61
68
  var splitApi = splitApiFactory && splitApiFactory(settings, platform, telemetryTracker);
62
- 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 };
63
70
  var syncManager = syncManagerFactory && syncManagerFactory(ctx);
64
71
  ctx.syncManager = syncManager;
65
72
  var signalListener = SignalListener && new SignalListener(syncManager, settings, storage, splitApi);
@@ -67,8 +74,22 @@ export function sdkFactory(params) {
67
74
  // SDK client and manager
68
75
  var clientMethod = sdkClientMethodFactory(ctx);
69
76
  var managerInstance = sdkManagerFactory(settings, storage.splits, sdkReadinessManager);
70
- syncManager && syncManager.start();
71
- 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();
72
93
  log.info(NEW_FACTORY);
73
94
  // @ts-ignore
74
95
  return objectAssign({
@@ -85,5 +106,5 @@ export function sdkFactory(params) {
85
106
  destroy: function () {
86
107
  return Promise.all(Object.keys(clients).map(function (key) { return clients[key].destroy(); })).then(function () { });
87
108
  }
88
- }, extraProps && extraProps(ctx));
109
+ }, extraProps && extraProps(ctx), isPure && { init: init });
89
110
  }