@splitsoftware/splitio-commons 3.1.1-rc.10 → 3.1.1-rc.11
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.
- package/CHANGES.txt +2 -0
- package/cjs/evaluator/condition/index.js +2 -2
- package/cjs/evaluator/fallbackTreatmentsCalculator/fallbackSanitizer/index.js +5 -8
- package/cjs/evaluator/index.js +81 -71
- package/cjs/listeners/browser.js +2 -1
- package/cjs/listeners/node.js +4 -4
- package/cjs/logger/constants.js +15 -20
- package/cjs/logger/messages/debug.js +5 -6
- package/cjs/logger/messages/error.js +3 -3
- package/cjs/logger/messages/info.js +3 -4
- package/cjs/logger/messages/warn.js +6 -7
- package/cjs/platform/browser.js +15 -0
- package/cjs/platform/getEventSource/browser.js +8 -0
- package/cjs/platform/getEventSource/eventsource.js +480 -0
- package/cjs/platform/getEventSource/node.js +26 -0
- package/cjs/platform/getFetch/browser.js +9 -0
- package/cjs/platform/getFetch/node.js +27 -0
- package/cjs/platform/getOptions/node.js +25 -0
- package/cjs/platform/node.js +17 -0
- package/cjs/presets/serverSide.js +2 -2
- package/cjs/readiness/constants.js +5 -4
- package/cjs/readiness/readinessManager.js +23 -23
- package/cjs/readiness/sdkReadinessManager.js +1 -17
- package/cjs/sdkClient/client.js +24 -50
- package/cjs/sdkClient/clientInputValidation.js +6 -17
- package/cjs/sdkClient/sdkClient.js +3 -60
- package/cjs/sdkClient/sdkLifecycle.js +74 -0
- package/cjs/sdkClient/trackMethod.js +56 -0
- package/cjs/sdkFactory/index.js +11 -15
- package/cjs/sdkManager/index.js +5 -5
- package/cjs/services/authProvider.js +80 -0
- package/cjs/services/decorateHeaders.js +2 -1
- package/cjs/services/secureSplitHttpClient.js +36 -0
- package/cjs/services/serviceApi.js +147 -0
- package/cjs/services/splitApi.js +24 -10
- package/cjs/services/splitHttpClient.js +3 -5
- package/cjs/storages/AbstractDefinitionsCacheAsync.js +51 -0
- package/cjs/storages/AbstractDefinitionsCacheSync.js +76 -0
- package/cjs/storages/KeyBuilder.js +6 -6
- package/cjs/storages/KeyBuilderCS.js +5 -5
- package/cjs/storages/KeyBuilderSS.js +2 -2
- package/cjs/storages/getRolloutPlan.js +3 -3
- package/cjs/storages/inLocalStorage/DefinitionsCacheInLocal.js +194 -0
- package/cjs/storages/inLocalStorage/MySegmentsCacheInLocal.js +1 -2
- package/cjs/storages/inLocalStorage/RBSegmentsCacheInLocal.js +10 -10
- package/cjs/storages/inLocalStorage/index.js +6 -6
- package/cjs/storages/inLocalStorage/validateCache.js +3 -3
- package/cjs/storages/inMemory/DefinitionsCacheInMemory.js +121 -0
- package/cjs/storages/inMemory/InMemoryStorage.js +4 -4
- package/cjs/storages/inMemory/InMemoryStorageCS.js +5 -5
- package/cjs/storages/inMemory/RBSegmentsCacheInMemory.js +5 -5
- package/cjs/storages/inMemory/SegmentsCacheInMemory.js +1 -1
- package/cjs/storages/inMemory/TelemetryCacheInMemory.js +5 -5
- package/cjs/storages/inRedis/{SplitsCacheInRedis.js → DefinitionsCacheInRedis.js} +77 -77
- package/cjs/storages/inRedis/RBSegmentsCacheInRedis.js +1 -1
- package/cjs/storages/inRedis/index.js +2 -2
- package/cjs/storages/pluggable/DefinitionsCachePluggable.js +212 -0
- package/cjs/storages/pluggable/RBSegmentsCachePluggable.js +1 -1
- package/cjs/storages/pluggable/index.js +2 -2
- package/cjs/storages/setRolloutPlan.js +4 -4
- package/cjs/storages/utils.js +1 -0
- package/cjs/sync/offline/syncTasks/fromObjectSyncTask.js +5 -5
- package/cjs/sync/polling/fetchers/splitChangesFetcher.js +24 -15
- package/cjs/sync/polling/pollingManagerCS.js +86 -81
- package/cjs/sync/polling/pollingManagerSS.js +44 -36
- package/cjs/sync/polling/syncTasks/definitionsSyncTask.js +13 -0
- package/cjs/sync/polling/syncTasks/segmentsSyncTask.js +2 -3
- package/cjs/sync/polling/updaters/{splitChangesUpdater.js → definitionChangesUpdater.js} +66 -69
- package/cjs/sync/polling/updaters/mySegmentsUpdater.js +3 -3
- package/cjs/sync/polling/updaters/segmentChangesUpdater.js +6 -6
- package/cjs/sync/streaming/AuthClient/index.js +13 -14
- package/cjs/sync/streaming/SSEHandler/NotificationKeeper.js +1 -1
- package/cjs/sync/streaming/SSEHandler/index.js +2 -1
- package/cjs/sync/streaming/UpdateWorkers/{SplitsUpdateWorker.js → DefinitionsUpdateWorker.js} +16 -19
- package/cjs/sync/streaming/constants.js +4 -3
- package/cjs/sync/streaming/parseUtils.js +11 -11
- package/cjs/sync/streaming/pushManager.js +20 -25
- package/cjs/sync/submitters/eventsSubmitter.js +1 -1
- package/cjs/sync/submitters/impressionCountsSubmitter.js +1 -1
- package/cjs/sync/submitters/impressionsSubmitter.js +5 -4
- package/cjs/sync/submitters/telemetrySubmitter.js +3 -4
- package/cjs/sync/submitters/uniqueKeysSubmitter.js +1 -1
- package/cjs/sync/syncManagerOnline.js +5 -5
- package/cjs/utils/Backoff.js +35 -3
- package/cjs/utils/EventEmitter.js +391 -0
- package/cjs/utils/filter/bloomFilter.js +37 -0
- package/cjs/utils/inputValidation/{split.js → definition.js} +10 -10
- package/cjs/utils/inputValidation/{splitExistence.js → definitionExistence.js} +6 -6
- package/cjs/utils/inputValidation/definitions.js +25 -0
- package/cjs/utils/inputValidation/index.js +7 -7
- package/cjs/utils/inputValidation/isOperational.js +4 -4
- package/cjs/utils/inputValidation/target.js +22 -0
- package/cjs/utils/labels/index.js +3 -3
- package/cjs/utils/settingsValidation/index.js +2 -0
- package/cjs/utils/settingsValidation/splitFilters.js +3 -3
- package/cjs/utils/settingsValidation/url.js +6 -2
- package/esm/evaluator/condition/index.js +2 -2
- package/esm/evaluator/fallbackTreatmentsCalculator/fallbackSanitizer/index.js +5 -8
- package/esm/evaluator/index.js +80 -71
- package/esm/listeners/browser.js +2 -1
- package/esm/listeners/node.js +4 -4
- package/esm/logger/constants.js +12 -17
- package/esm/logger/messages/debug.js +5 -6
- package/esm/logger/messages/error.js +3 -3
- package/esm/logger/messages/info.js +3 -4
- package/esm/logger/messages/warn.js +6 -7
- package/esm/platform/browser.js +12 -0
- package/esm/platform/getEventSource/browser.js +4 -0
- package/esm/platform/getEventSource/eventsource.js +480 -0
- package/esm/platform/getEventSource/node.js +20 -0
- package/esm/platform/getFetch/browser.js +5 -0
- package/esm/platform/getFetch/node.js +22 -0
- package/esm/platform/getOptions/node.js +20 -0
- package/esm/platform/node.js +14 -0
- package/esm/presets/serverSide.js +2 -2
- package/esm/readiness/constants.js +4 -3
- package/esm/readiness/readinessManager.js +24 -24
- package/esm/readiness/sdkReadinessManager.js +2 -18
- package/esm/sdkClient/client.js +23 -50
- package/esm/sdkClient/clientInputValidation.js +8 -19
- package/esm/sdkClient/sdkClient.js +3 -60
- package/esm/sdkClient/sdkLifecycle.js +70 -0
- package/esm/sdkClient/trackMethod.js +52 -0
- package/esm/sdkFactory/index.js +12 -16
- package/esm/sdkManager/index.js +6 -6
- package/esm/services/authProvider.js +76 -0
- package/esm/services/decorateHeaders.js +2 -1
- package/esm/services/secureSplitHttpClient.js +32 -0
- package/esm/services/serviceApi.js +143 -0
- package/esm/services/splitApi.js +24 -10
- package/esm/services/splitHttpClient.js +3 -5
- package/esm/storages/AbstractDefinitionsCacheAsync.js +48 -0
- package/esm/storages/AbstractDefinitionsCacheSync.js +71 -0
- package/esm/storages/KeyBuilder.js +6 -6
- package/esm/storages/KeyBuilderCS.js +5 -5
- package/esm/storages/KeyBuilderSS.js +2 -2
- package/esm/storages/getRolloutPlan.js +3 -3
- package/esm/storages/inLocalStorage/DefinitionsCacheInLocal.js +191 -0
- package/esm/storages/inLocalStorage/MySegmentsCacheInLocal.js +1 -2
- package/esm/storages/inLocalStorage/RBSegmentsCacheInLocal.js +7 -7
- package/esm/storages/inLocalStorage/index.js +6 -6
- package/esm/storages/inLocalStorage/validateCache.js +3 -3
- package/esm/storages/inMemory/DefinitionsCacheInMemory.js +118 -0
- package/esm/storages/inMemory/InMemoryStorage.js +4 -4
- package/esm/storages/inMemory/InMemoryStorageCS.js +5 -5
- package/esm/storages/inMemory/RBSegmentsCacheInMemory.js +2 -2
- package/esm/storages/inMemory/SegmentsCacheInMemory.js +1 -1
- package/esm/storages/inMemory/TelemetryCacheInMemory.js +5 -5
- package/esm/storages/inRedis/{SplitsCacheInRedis.js → DefinitionsCacheInRedis.js} +76 -76
- package/esm/storages/inRedis/RBSegmentsCacheInRedis.js +1 -1
- package/esm/storages/inRedis/index.js +2 -2
- package/esm/storages/pluggable/DefinitionsCachePluggable.js +209 -0
- package/esm/storages/pluggable/RBSegmentsCachePluggable.js +1 -1
- package/esm/storages/pluggable/index.js +2 -2
- package/esm/storages/setRolloutPlan.js +4 -4
- package/esm/storages/utils.js +1 -0
- package/esm/sync/offline/syncTasks/fromObjectSyncTask.js +6 -6
- package/esm/sync/polling/fetchers/splitChangesFetcher.js +25 -16
- package/esm/sync/polling/pollingManagerCS.js +87 -82
- package/esm/sync/polling/pollingManagerSS.js +44 -36
- package/esm/sync/polling/syncTasks/definitionsSyncTask.js +9 -0
- package/esm/sync/polling/syncTasks/segmentsSyncTask.js +2 -3
- package/esm/sync/polling/updaters/definitionChangesUpdater.js +191 -0
- package/esm/sync/polling/updaters/mySegmentsUpdater.js +3 -3
- package/esm/sync/polling/updaters/segmentChangesUpdater.js +7 -7
- package/esm/sync/streaming/AuthClient/index.js +11 -11
- package/esm/sync/streaming/SSEHandler/NotificationKeeper.js +2 -2
- package/esm/sync/streaming/SSEHandler/index.js +3 -2
- package/esm/sync/streaming/UpdateWorkers/{SplitsUpdateWorker.js → DefinitionsUpdateWorker.js} +15 -18
- package/esm/sync/streaming/constants.js +3 -2
- package/esm/sync/streaming/parseUtils.js +9 -9
- package/esm/sync/streaming/pushManager.js +22 -27
- package/esm/sync/submitters/eventsSubmitter.js +1 -1
- package/esm/sync/submitters/impressionCountsSubmitter.js +1 -1
- package/esm/sync/submitters/impressionsSubmitter.js +5 -4
- package/esm/sync/submitters/telemetrySubmitter.js +3 -4
- package/esm/sync/submitters/uniqueKeysSubmitter.js +1 -1
- package/esm/sync/syncManagerOnline.js +4 -4
- package/esm/utils/Backoff.js +35 -3
- package/esm/utils/EventEmitter.js +387 -0
- package/esm/utils/filter/bloomFilter.js +33 -0
- package/esm/utils/inputValidation/{split.js → definition.js} +8 -8
- package/esm/utils/inputValidation/definitionExistence.js +15 -0
- package/esm/utils/inputValidation/definitions.js +21 -0
- package/esm/utils/inputValidation/index.js +3 -3
- package/esm/utils/inputValidation/isOperational.js +4 -4
- package/esm/utils/inputValidation/target.js +18 -0
- package/esm/utils/labels/index.js +2 -2
- package/esm/utils/settingsValidation/index.js +2 -0
- package/esm/utils/settingsValidation/splitFilters.js +3 -3
- package/esm/utils/settingsValidation/url.js +6 -2
- package/package.json +1 -1
- package/cjs/storages/AbstractSplitsCacheAsync.js +0 -51
- package/cjs/storages/AbstractSplitsCacheSync.js +0 -76
- package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js +0 -194
- package/cjs/storages/inMemory/SplitsCacheInMemory.js +0 -121
- package/cjs/storages/pluggable/SplitsCachePluggable.js +0 -212
- package/cjs/sync/polling/syncTasks/splitsSyncTask.js +0 -13
- package/cjs/utils/inputValidation/splits.js +0 -25
- package/esm/storages/AbstractSplitsCacheAsync.js +0 -48
- package/esm/storages/AbstractSplitsCacheSync.js +0 -71
- package/esm/storages/inLocalStorage/SplitsCacheInLocal.js +0 -191
- package/esm/storages/inMemory/SplitsCacheInMemory.js +0 -118
- package/esm/storages/pluggable/SplitsCachePluggable.js +0 -209
- package/esm/sync/polling/syncTasks/splitsSyncTask.js +0 -9
- package/esm/sync/polling/updaters/splitChangesUpdater.js +0 -194
- package/esm/utils/inputValidation/splitExistence.js +0 -15
- package/esm/utils/inputValidation/splits.js +0 -21
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
import { objectAssign } from '../utils/lang/objectAssign';
|
|
2
|
-
import {
|
|
3
|
-
function
|
|
4
|
-
var
|
|
5
|
-
|
|
6
|
-
|
|
2
|
+
import { SDK_DEFINITIONS_ARRIVED, SDK_DEFINITIONS_CACHE_LOADED, SDK_SEGMENTS_ARRIVED, SDK_READY_TIMED_OUT, SDK_READY_FROM_CACHE, SDK_UPDATE, SDK_READY } from './constants';
|
|
3
|
+
function definitionsEventEmitterFactory(EventEmitter) {
|
|
4
|
+
var definitionsEventEmitter = objectAssign(new EventEmitter(), {
|
|
5
|
+
definitionsArrived: false,
|
|
6
|
+
definitionsCacheLoaded: false,
|
|
7
7
|
hasInit: false,
|
|
8
8
|
initCallbacks: []
|
|
9
9
|
});
|
|
10
10
|
// `isSplitKill` condition avoids an edge-case of wrongly emitting SDK_READY if:
|
|
11
11
|
// - `/memberships` fetch and SPLIT_KILL occurs before `/splitChanges` fetch, and
|
|
12
12
|
// - storage has cached splits (for which case `splitsStorage.killLocally` can return true)
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
return
|
|
13
|
+
definitionsEventEmitter.on(SDK_DEFINITIONS_ARRIVED, function (metadata, isSplitKill) { if (!isSplitKill)
|
|
14
|
+
definitionsEventEmitter.definitionsArrived = true; });
|
|
15
|
+
definitionsEventEmitter.once(SDK_DEFINITIONS_CACHE_LOADED, function () { definitionsEventEmitter.definitionsCacheLoaded = true; });
|
|
16
|
+
return definitionsEventEmitter;
|
|
17
17
|
}
|
|
18
18
|
function segmentsEventEmitterFactory(EventEmitter) {
|
|
19
19
|
var segmentsEventEmitter = objectAssign(new EventEmitter(), {
|
|
@@ -25,8 +25,8 @@ function segmentsEventEmitterFactory(EventEmitter) {
|
|
|
25
25
|
/**
|
|
26
26
|
* Factory of readiness manager, which handles the ready / update event propagation.
|
|
27
27
|
*/
|
|
28
|
-
export function readinessManagerFactory(EventEmitter, settings,
|
|
29
|
-
if (
|
|
28
|
+
export function readinessManagerFactory(EventEmitter, settings, definitions, isShared) {
|
|
29
|
+
if (definitions === void 0) { definitions = definitionsEventEmitterFactory(EventEmitter); }
|
|
30
30
|
var readyTimeout = settings.startup.readyTimeout;
|
|
31
31
|
var segments = segmentsEventEmitterFactory(EventEmitter);
|
|
32
32
|
var gate = new EventEmitter();
|
|
@@ -41,10 +41,10 @@ export function readinessManagerFactory(EventEmitter, settings, splits, isShared
|
|
|
41
41
|
};
|
|
42
42
|
// emit SDK_READY_FROM_CACHE
|
|
43
43
|
var isReadyFromCache = false;
|
|
44
|
-
if (
|
|
44
|
+
if (definitions.definitionsCacheLoaded)
|
|
45
45
|
isReadyFromCache = true; // ready from cache, but doesn't emit SDK_READY_FROM_CACHE
|
|
46
46
|
else
|
|
47
|
-
|
|
47
|
+
definitions.once(SDK_DEFINITIONS_CACHE_LOADED, checkIsReadyFromCache);
|
|
48
48
|
// emit SDK_READY_TIMED_OUT
|
|
49
49
|
var hasTimedout = false;
|
|
50
50
|
function timeout() {
|
|
@@ -52,11 +52,11 @@ export function readinessManagerFactory(EventEmitter, settings, splits, isShared
|
|
|
52
52
|
return;
|
|
53
53
|
hasTimedout = true;
|
|
54
54
|
syncLastUpdate();
|
|
55
|
-
gate.emit(SDK_READY_TIMED_OUT, '
|
|
55
|
+
gate.emit(SDK_READY_TIMED_OUT, 'SDK client emitted SDK_READY_TIMED_OUT event.');
|
|
56
56
|
}
|
|
57
57
|
// emit SDK_READY and SDK_UPDATE
|
|
58
58
|
var isReady = false;
|
|
59
|
-
|
|
59
|
+
definitions.on(SDK_DEFINITIONS_ARRIVED, checkIsReadyOrUpdate);
|
|
60
60
|
segments.on(SDK_SEGMENTS_ARRIVED, checkIsReadyOrUpdate);
|
|
61
61
|
var isDestroyed = false;
|
|
62
62
|
var readyTimeoutId;
|
|
@@ -65,8 +65,8 @@ export function readinessManagerFactory(EventEmitter, settings, splits, isShared
|
|
|
65
65
|
if (readyTimeout > 0 && !isReady)
|
|
66
66
|
readyTimeoutId = setTimeout(timeout, readyTimeout);
|
|
67
67
|
}
|
|
68
|
-
|
|
69
|
-
if (
|
|
68
|
+
definitions.initCallbacks.push(__init);
|
|
69
|
+
if (definitions.hasInit)
|
|
70
70
|
__init();
|
|
71
71
|
function checkIsReadyFromCache(cacheMetadata) {
|
|
72
72
|
metadataReady = cacheMetadata;
|
|
@@ -97,7 +97,7 @@ export function readinessManagerFactory(EventEmitter, settings, splits, isShared
|
|
|
97
97
|
}
|
|
98
98
|
}
|
|
99
99
|
else {
|
|
100
|
-
if (
|
|
100
|
+
if (definitions.definitionsArrived && segments.segmentsArrived) {
|
|
101
101
|
clearTimeout(readyTimeoutId);
|
|
102
102
|
isReady = true;
|
|
103
103
|
try {
|
|
@@ -120,11 +120,11 @@ export function readinessManagerFactory(EventEmitter, settings, splits, isShared
|
|
|
120
120
|
}
|
|
121
121
|
}
|
|
122
122
|
return {
|
|
123
|
-
|
|
123
|
+
definitions: definitions,
|
|
124
124
|
segments: segments,
|
|
125
125
|
gate: gate,
|
|
126
126
|
shared: function () {
|
|
127
|
-
return readinessManagerFactory(EventEmitter, settings,
|
|
127
|
+
return readinessManagerFactory(EventEmitter, settings, definitions, true);
|
|
128
128
|
},
|
|
129
129
|
// @TODO review/remove next methods when non-recoverable errors are reworked
|
|
130
130
|
// Called on consumer mode, when storage fails to connect
|
|
@@ -133,17 +133,17 @@ export function readinessManagerFactory(EventEmitter, settings, splits, isShared
|
|
|
133
133
|
// tracking and evaluations, while keeping event listeners to emit SDK_READY_TIMED_OUT event
|
|
134
134
|
setDestroyed: function () { isDestroyed = true; },
|
|
135
135
|
init: function () {
|
|
136
|
-
if (
|
|
136
|
+
if (definitions.hasInit)
|
|
137
137
|
return;
|
|
138
|
-
|
|
139
|
-
|
|
138
|
+
definitions.hasInit = true;
|
|
139
|
+
definitions.initCallbacks.forEach(function (cb) { return cb(); });
|
|
140
140
|
},
|
|
141
141
|
destroy: function () {
|
|
142
142
|
isDestroyed = true;
|
|
143
143
|
syncLastUpdate();
|
|
144
144
|
clearTimeout(readyTimeoutId);
|
|
145
145
|
if (!isShared)
|
|
146
|
-
|
|
146
|
+
definitions.hasInit = false;
|
|
147
147
|
},
|
|
148
148
|
isReady: function () { return isReady; },
|
|
149
149
|
isReadyFromCache: function () { return isReadyFromCache; },
|
|
@@ -2,9 +2,8 @@ import { objectAssign } from '../utils/lang/objectAssign';
|
|
|
2
2
|
import { promiseWrapper } from '../utils/promise/wrapper';
|
|
3
3
|
import { readinessManagerFactory } from './readinessManager';
|
|
4
4
|
import { SDK_READY, SDK_READY_TIMED_OUT, SDK_READY_FROM_CACHE, SDK_UPDATE } from './constants';
|
|
5
|
-
import { ERROR_CLIENT_LISTENER, CLIENT_READY_FROM_CACHE, CLIENT_READY
|
|
5
|
+
import { ERROR_CLIENT_LISTENER, CLIENT_READY_FROM_CACHE, CLIENT_READY } from '../logger/constants';
|
|
6
6
|
var NEW_LISTENER_EVENT = 'newListener';
|
|
7
|
-
var REMOVE_LISTENER_EVENT = 'removeListener';
|
|
8
7
|
var TIMEOUT_ERROR = new Error(SDK_READY_TIMED_OUT);
|
|
9
8
|
/**
|
|
10
9
|
* SdkReadinessManager factory, which provides the public status API of SDK clients and manager: ready promise, readiness event emitter and constants (SDK_READY, etc).
|
|
@@ -16,21 +15,11 @@ var TIMEOUT_ERROR = new Error(SDK_READY_TIMED_OUT);
|
|
|
16
15
|
export function sdkReadinessManagerFactory(EventEmitter, settings, readinessManager) {
|
|
17
16
|
if (readinessManager === void 0) { readinessManager = readinessManagerFactory(EventEmitter, settings); }
|
|
18
17
|
var log = settings.log;
|
|
19
|
-
/** Ready callback warning */
|
|
20
|
-
var internalReadyCbCount = 0;
|
|
21
|
-
var readyCbCount = 0;
|
|
22
|
-
readinessManager.gate.on(REMOVE_LISTENER_EVENT, function (event) {
|
|
23
|
-
if (event === SDK_READY)
|
|
24
|
-
readyCbCount--;
|
|
25
|
-
});
|
|
26
18
|
readinessManager.gate.on(NEW_LISTENER_EVENT, function (event) {
|
|
27
19
|
if (event === SDK_READY || event === SDK_READY_TIMED_OUT) {
|
|
28
20
|
if (readinessManager.isReady()) {
|
|
29
21
|
log.error(ERROR_CLIENT_LISTENER, [event === SDK_READY ? 'SDK_READY' : 'SDK_READY_TIMED_OUT']);
|
|
30
22
|
}
|
|
31
|
-
else if (event === SDK_READY) {
|
|
32
|
-
readyCbCount++;
|
|
33
|
-
}
|
|
34
23
|
}
|
|
35
24
|
else if (event === SDK_READY_FROM_CACHE && readinessManager.isReadyFromCache()) {
|
|
36
25
|
log.error(ERROR_CLIENT_LISTENER, ['SDK_READY_FROM_CACHE']);
|
|
@@ -49,8 +38,6 @@ export function sdkReadinessManagerFactory(EventEmitter, settings, readinessMana
|
|
|
49
38
|
var promise = promiseWrapper(new Promise(function (resolve, reject) {
|
|
50
39
|
readinessManager.gate.once(SDK_READY, function () {
|
|
51
40
|
log.info(CLIENT_READY);
|
|
52
|
-
if (readyCbCount === internalReadyCbCount && !promise.hasOnFulfilled())
|
|
53
|
-
log.warn(CLIENT_NO_LISTENER);
|
|
54
41
|
resolve();
|
|
55
42
|
});
|
|
56
43
|
readinessManager.gate.once(SDK_READY_TIMED_OUT, function (message) {
|
|
@@ -75,9 +62,6 @@ export function sdkReadinessManagerFactory(EventEmitter, settings, readinessMana
|
|
|
75
62
|
shared: function () {
|
|
76
63
|
return sdkReadinessManagerFactory(EventEmitter, settings, readinessManager.shared());
|
|
77
64
|
},
|
|
78
|
-
incInternalReadyCbCount: function () {
|
|
79
|
-
internalReadyCbCount++;
|
|
80
|
-
},
|
|
81
65
|
sdkStatus: objectAssign(
|
|
82
66
|
// Expose Event Emitter functionality
|
|
83
67
|
Object.create(readinessManager.gate), {
|
|
@@ -92,7 +76,7 @@ export function sdkReadinessManagerFactory(EventEmitter, settings, readinessMana
|
|
|
92
76
|
ready: function () {
|
|
93
77
|
if (readinessManager.hasTimedout()) {
|
|
94
78
|
if (!readinessManager.isReady()) {
|
|
95
|
-
return promiseWrapper(Promise.reject(new Error('
|
|
79
|
+
return promiseWrapper(Promise.reject(new Error('SDK client has emitted SDK_READY_TIMED_OUT event.')), defaultOnRejected);
|
|
96
80
|
}
|
|
97
81
|
else {
|
|
98
82
|
return Promise.resolve();
|
package/esm/sdkClient/client.js
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import { evaluateFeature, evaluateFeatures, evaluateFeaturesByFlagSets } from '../evaluator';
|
|
2
2
|
import { thenable } from '../utils/promise/thenable';
|
|
3
3
|
import { getMatching, getBucketing } from '../utils/key';
|
|
4
|
-
import {
|
|
5
|
-
import { validateTrafficTypeExistence } from '../utils/inputValidation/trafficTypeExistence';
|
|
4
|
+
import { validateDefinitionExistence } from '../utils/inputValidation/definitionExistence';
|
|
6
5
|
import { SDK_NOT_READY } from '../utils/labels';
|
|
7
|
-
import { CONTROL, TREATMENT, TREATMENTS, TREATMENT_WITH_CONFIG, TREATMENTS_WITH_CONFIG,
|
|
6
|
+
import { CONTROL, TREATMENT, TREATMENTS, TREATMENT_WITH_CONFIG, TREATMENTS_WITH_CONFIG, TREATMENTS_WITH_CONFIG_BY_FLAGSETS, TREATMENTS_BY_FLAGSETS, TREATMENTS_BY_FLAGSET, TREATMENTS_WITH_CONFIG_BY_FLAGSET, GET_TREATMENTS_WITH_CONFIG, GET_TREATMENTS_BY_FLAG_SETS, GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SETS, GET_TREATMENTS_BY_FLAG_SET, GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SET, GET_TREATMENT_WITH_CONFIG, GET_TREATMENT, GET_TREATMENTS } from '../utils/constants';
|
|
8
7
|
import { IMPRESSION_QUEUEING } from '../logger/constants';
|
|
9
8
|
import { isConsumerMode } from '../utils/settingsValidation/mode';
|
|
9
|
+
import { trackMethodFactory } from './trackMethod';
|
|
10
10
|
var treatmentNotReady = { treatment: CONTROL, label: SDK_NOT_READY };
|
|
11
11
|
function treatmentsNotReady(featureFlagNames) {
|
|
12
12
|
var evaluations = {};
|
|
@@ -15,10 +15,10 @@ function treatmentsNotReady(featureFlagNames) {
|
|
|
15
15
|
});
|
|
16
16
|
return evaluations;
|
|
17
17
|
}
|
|
18
|
-
function stringify(
|
|
19
|
-
if (
|
|
18
|
+
export function stringify(properties) {
|
|
19
|
+
if (properties) {
|
|
20
20
|
try {
|
|
21
|
-
return JSON.stringify(
|
|
21
|
+
return JSON.stringify(properties);
|
|
22
22
|
}
|
|
23
23
|
catch ( /* JSON.stringify should never throw with validated options, but handling just in case */_a) { /* JSON.stringify should never throw with validated options, but handling just in case */ }
|
|
24
24
|
}
|
|
@@ -27,7 +27,7 @@ function stringify(options) {
|
|
|
27
27
|
* Creator of base client with getTreatments and track methods.
|
|
28
28
|
*/
|
|
29
29
|
export function clientFactory(params) {
|
|
30
|
-
var readinessManager = params.sdkReadinessManager.readinessManager, storage = params.storage, settings = params.settings, impressionsTracker = params.impressionsTracker,
|
|
30
|
+
var readinessManager = params.sdkReadinessManager.readinessManager, storage = params.storage, settings = params.settings, impressionsTracker = params.impressionsTracker, telemetryTracker = params.telemetryTracker, fallbackCalculator = params.fallbackCalculator;
|
|
31
31
|
var log = settings.log, mode = settings.mode;
|
|
32
32
|
var isAsync = isConsumerMode(mode);
|
|
33
33
|
function getTreatment(key, featureFlagName, attributes, options, withConfig, methodName) {
|
|
@@ -36,13 +36,13 @@ export function clientFactory(params) {
|
|
|
36
36
|
var stopTelemetryTracker = telemetryTracker.trackEval(withConfig ? TREATMENT_WITH_CONFIG : TREATMENT);
|
|
37
37
|
var wrapUp = function (evaluationResult) {
|
|
38
38
|
var queue = [];
|
|
39
|
-
var treatment = processEvaluation(evaluationResult, featureFlagName, key,
|
|
39
|
+
var treatment = processEvaluation(evaluationResult, featureFlagName, key, withConfig, methodName, queue, options);
|
|
40
40
|
impressionsTracker.track(queue, attributes);
|
|
41
41
|
stopTelemetryTracker(queue[0] && queue[0].imp.label);
|
|
42
42
|
return treatment;
|
|
43
43
|
};
|
|
44
44
|
var evaluation = readinessManager.isReadyFromCache() ?
|
|
45
|
-
evaluateFeature(log, key, featureFlagName, attributes, storage
|
|
45
|
+
evaluateFeature(log, key, featureFlagName, attributes, storage) :
|
|
46
46
|
isAsync ? // If the SDK is not ready, treatment may be incorrect due to having splits but not segments data, or storage is not connected
|
|
47
47
|
Promise.resolve(treatmentNotReady) :
|
|
48
48
|
treatmentNotReady;
|
|
@@ -58,16 +58,15 @@ export function clientFactory(params) {
|
|
|
58
58
|
var wrapUp = function (evaluationResults) {
|
|
59
59
|
var queue = [];
|
|
60
60
|
var treatments = {};
|
|
61
|
-
var properties = stringify(options);
|
|
62
61
|
Object.keys(evaluationResults).forEach(function (featureFlagName) {
|
|
63
|
-
treatments[featureFlagName] = processEvaluation(evaluationResults[featureFlagName], featureFlagName, key,
|
|
62
|
+
treatments[featureFlagName] = processEvaluation(evaluationResults[featureFlagName], featureFlagName, key, withConfig, methodName, queue, options);
|
|
64
63
|
});
|
|
65
64
|
impressionsTracker.track(queue, attributes);
|
|
66
65
|
stopTelemetryTracker(queue[0] && queue[0].imp.label);
|
|
67
66
|
return treatments;
|
|
68
67
|
};
|
|
69
68
|
var evaluations = readinessManager.isReadyFromCache() ?
|
|
70
|
-
evaluateFeatures(log, key, featureFlagNames, attributes, storage
|
|
69
|
+
evaluateFeatures(log, key, featureFlagNames, attributes, storage) :
|
|
71
70
|
isAsync ? // If the SDK is not ready, treatment may be incorrect due to having splits but not segments data, or storage is not connected
|
|
72
71
|
Promise.resolve(treatmentsNotReady(featureFlagNames)) :
|
|
73
72
|
treatmentsNotReady(featureFlagNames);
|
|
@@ -84,16 +83,15 @@ export function clientFactory(params) {
|
|
|
84
83
|
var wrapUp = function (evaluationResults) {
|
|
85
84
|
var queue = [];
|
|
86
85
|
var treatments = {};
|
|
87
|
-
var properties = stringify(options);
|
|
88
86
|
Object.keys(evaluationResults).forEach(function (featureFlagName) {
|
|
89
|
-
treatments[featureFlagName] = processEvaluation(evaluationResults[featureFlagName], featureFlagName, key,
|
|
87
|
+
treatments[featureFlagName] = processEvaluation(evaluationResults[featureFlagName], featureFlagName, key, withConfig, methodName, queue, options);
|
|
90
88
|
});
|
|
91
89
|
impressionsTracker.track(queue, attributes);
|
|
92
90
|
stopTelemetryTracker(queue[0] && queue[0].imp.label);
|
|
93
91
|
return treatments;
|
|
94
92
|
};
|
|
95
93
|
var evaluations = readinessManager.isReadyFromCache() ?
|
|
96
|
-
evaluateFeaturesByFlagSets(log, key, flagSetNames, attributes, storage, methodName
|
|
94
|
+
evaluateFeaturesByFlagSets(log, key, flagSetNames, attributes, storage, methodName) :
|
|
97
95
|
isAsync ?
|
|
98
96
|
Promise.resolve({}) :
|
|
99
97
|
{};
|
|
@@ -109,19 +107,20 @@ export function clientFactory(params) {
|
|
|
109
107
|
return getTreatmentsByFlagSets(key, [flagSetName], attributes, options, true, TREATMENTS_WITH_CONFIG_BY_FLAGSET, GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SET);
|
|
110
108
|
}
|
|
111
109
|
// Internal function
|
|
112
|
-
function processEvaluation(evaluation, featureFlagName, key,
|
|
110
|
+
function processEvaluation(evaluation, featureFlagName, key, withConfig, invokingMethodName, queue, options) {
|
|
111
|
+
if (options === void 0) { options = {}; }
|
|
113
112
|
var matchingKey = getMatching(key);
|
|
114
113
|
var bucketingKey = getBucketing(key);
|
|
115
|
-
var
|
|
114
|
+
var definition = evaluation.definition;
|
|
116
115
|
var treatment = evaluation.treatment, label = evaluation.label, _a = evaluation.config, config = _a === void 0 ? null : _a;
|
|
117
116
|
if (treatment === CONTROL) {
|
|
118
|
-
var fallbackTreatment =
|
|
117
|
+
var fallbackTreatment = fallbackCalculator(featureFlagName, label);
|
|
119
118
|
treatment = fallbackTreatment.treatment;
|
|
120
119
|
label = fallbackTreatment.label;
|
|
121
120
|
config = fallbackTreatment.config;
|
|
122
121
|
}
|
|
123
|
-
if (
|
|
124
|
-
log.info(IMPRESSION_QUEUEING, [featureFlagName, matchingKey, treatment, label]);
|
|
122
|
+
if (validateDefinitionExistence(log, readinessManager, featureFlagName, label, invokingMethodName)) {
|
|
123
|
+
log.info(IMPRESSION_QUEUEING, ['Feature flag', featureFlagName, matchingKey, treatment, label]);
|
|
125
124
|
queue.push({
|
|
126
125
|
imp: {
|
|
127
126
|
feature: featureFlagName,
|
|
@@ -130,10 +129,10 @@ export function clientFactory(params) {
|
|
|
130
129
|
time: Date.now(),
|
|
131
130
|
bucketingKey: bucketingKey,
|
|
132
131
|
label: label,
|
|
133
|
-
changeNumber: changeNumber,
|
|
134
|
-
properties: properties
|
|
132
|
+
changeNumber: definition === null || definition === void 0 ? void 0 : definition.changeNumber,
|
|
133
|
+
properties: stringify(options.properties)
|
|
135
134
|
},
|
|
136
|
-
disabled: impressionsDisabled
|
|
135
|
+
disabled: options.impressionsDisabled || (definition === null || definition === void 0 ? void 0 : definition.impressionsDisabled)
|
|
137
136
|
});
|
|
138
137
|
}
|
|
139
138
|
if (withConfig) {
|
|
@@ -144,33 +143,7 @@ export function clientFactory(params) {
|
|
|
144
143
|
}
|
|
145
144
|
return treatment;
|
|
146
145
|
}
|
|
147
|
-
|
|
148
|
-
if (size === void 0) { size = 1024; }
|
|
149
|
-
var stopTelemetryTracker = telemetryTracker.trackEval(TRACK);
|
|
150
|
-
var matchingKey = getMatching(key);
|
|
151
|
-
var timestamp = Date.now();
|
|
152
|
-
var eventData = {
|
|
153
|
-
eventTypeId: eventTypeId,
|
|
154
|
-
trafficTypeName: trafficTypeName,
|
|
155
|
-
value: value,
|
|
156
|
-
timestamp: timestamp,
|
|
157
|
-
key: matchingKey,
|
|
158
|
-
properties: properties
|
|
159
|
-
};
|
|
160
|
-
// This may be async but we only warn, we don't actually care if it is valid or not in terms of queueing the event.
|
|
161
|
-
validateTrafficTypeExistence(log, readinessManager, storage.splits, mode, trafficTypeName, TRACK_FN_LABEL);
|
|
162
|
-
var result = eventTracker.track(eventData, size);
|
|
163
|
-
if (thenable(result)) {
|
|
164
|
-
return result.then(function (result) {
|
|
165
|
-
stopTelemetryTracker();
|
|
166
|
-
return result;
|
|
167
|
-
});
|
|
168
|
-
}
|
|
169
|
-
else {
|
|
170
|
-
stopTelemetryTracker();
|
|
171
|
-
return result;
|
|
172
|
-
}
|
|
173
|
-
}
|
|
146
|
+
var track = trackMethodFactory(params);
|
|
174
147
|
return {
|
|
175
148
|
getTreatment: getTreatment,
|
|
176
149
|
getTreatmentWithConfig: getTreatmentWithConfig,
|
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
import { validateAttributes,
|
|
1
|
+
import { validateAttributes, validateKey, validateDefinition, validateDefinitions, validateIfNotDestroyed, validateIfReadyFromCache, validateEvaluationOptions } from '../utils/inputValidation';
|
|
2
2
|
import { startsWith } from '../utils/lang';
|
|
3
|
-
import { GET_TREATMENT, GET_TREATMENTS, GET_TREATMENTS_BY_FLAG_SET, GET_TREATMENTS_BY_FLAG_SETS, GET_TREATMENTS_WITH_CONFIG, GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SET, GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SETS, GET_TREATMENT_WITH_CONFIG
|
|
3
|
+
import { GET_TREATMENT, GET_TREATMENTS, GET_TREATMENTS_BY_FLAG_SET, GET_TREATMENTS_BY_FLAG_SETS, GET_TREATMENTS_WITH_CONFIG, GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SET, GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SETS, GET_TREATMENT_WITH_CONFIG } from '../utils/constants';
|
|
4
4
|
import { isConsumerMode } from '../utils/settingsValidation/mode';
|
|
5
5
|
import { validateFlagSets } from '../utils/settingsValidation/splitFilters';
|
|
6
6
|
/**
|
|
7
7
|
* Decorator that validates the input before actually executing the client methods.
|
|
8
8
|
* We should "guard" the client here, while not polluting the "real" implementation of those methods.
|
|
9
9
|
*/
|
|
10
|
-
export function clientInputValidationDecorator(settings, client, readinessManager,
|
|
10
|
+
export function clientInputValidationDecorator(settings, client, readinessManager, fallbackCalculator) {
|
|
11
11
|
var log = settings.log, mode = settings.mode;
|
|
12
12
|
var isAsync = isConsumerMode(mode);
|
|
13
13
|
/**
|
|
@@ -18,12 +18,12 @@ export function clientInputValidationDecorator(settings, client, readinessManage
|
|
|
18
18
|
var nameOrNames = methodName.indexOf('ByFlagSet') > -1 ?
|
|
19
19
|
validateFlagSets(log, methodName, maybeNameOrNames, settings.sync.__splitFiltersValidation.groupedFilters.bySet) :
|
|
20
20
|
startsWith(methodName, GET_TREATMENTS) ?
|
|
21
|
-
|
|
22
|
-
|
|
21
|
+
validateDefinitions(log, maybeNameOrNames, methodName) :
|
|
22
|
+
validateDefinition(log, maybeNameOrNames, methodName);
|
|
23
23
|
var attributes = validateAttributes(log, maybeAttributes, methodName);
|
|
24
24
|
var isNotDestroyed = validateIfNotDestroyed(log, readinessManager, methodName);
|
|
25
25
|
var options = validateEvaluationOptions(log, maybeOptions, methodName);
|
|
26
|
-
validateIfReadyFromCache(log, readinessManager, methodName
|
|
26
|
+
validateIfReadyFromCache(log, readinessManager, methodName);
|
|
27
27
|
var valid = isNotDestroyed && key && nameOrNames && attributes !== false;
|
|
28
28
|
return {
|
|
29
29
|
valid: valid,
|
|
@@ -39,7 +39,7 @@ export function clientInputValidationDecorator(settings, client, readinessManage
|
|
|
39
39
|
featureFlagName.forEach(function (split) { return res_1[split] = evaluateFallBackTreatment(split, withConfig); });
|
|
40
40
|
return res_1;
|
|
41
41
|
}
|
|
42
|
-
var _a =
|
|
42
|
+
var _a = fallbackCalculator(featureFlagName), treatment = _a.treatment, config = _a.config;
|
|
43
43
|
return withConfig ?
|
|
44
44
|
{
|
|
45
45
|
treatment: treatment,
|
|
@@ -97,17 +97,6 @@ export function clientInputValidationDecorator(settings, client, readinessManage
|
|
|
97
97
|
client.getTreatmentsWithConfigByFlagSet(params.key, params.nameOrNames[0], params.attributes, params.options) :
|
|
98
98
|
wrapResult({});
|
|
99
99
|
}
|
|
100
|
-
function track(maybeKey, maybeTT, maybeEvent, maybeEventValue, maybeProperties) {
|
|
101
|
-
var key = validateKey(log, maybeKey, TRACK_FN_LABEL);
|
|
102
|
-
var tt = validateTrafficType(log, maybeTT, TRACK_FN_LABEL);
|
|
103
|
-
var event = validateEvent(log, maybeEvent, TRACK_FN_LABEL);
|
|
104
|
-
var eventValue = validateEventValue(log, maybeEventValue, TRACK_FN_LABEL);
|
|
105
|
-
var _a = validateEventProperties(log, maybeProperties, TRACK_FN_LABEL), properties = _a.properties, size = _a.size;
|
|
106
|
-
var isNotDestroyed = validateIfNotDestroyed(log, readinessManager, TRACK_FN_LABEL);
|
|
107
|
-
return isNotDestroyed && key && tt && event && eventValue !== false && properties !== false ? // @ts-expect-error
|
|
108
|
-
client.track(key, tt, event, eventValue, properties, size) :
|
|
109
|
-
wrapResult(false);
|
|
110
|
-
}
|
|
111
100
|
return {
|
|
112
101
|
getTreatment: getTreatment,
|
|
113
102
|
getTreatmentWithConfig: getTreatmentWithConfig,
|
|
@@ -117,6 +106,6 @@ export function clientInputValidationDecorator(settings, client, readinessManage
|
|
|
117
106
|
getTreatmentsWithConfigByFlagSets: getTreatmentsWithConfigByFlagSets,
|
|
118
107
|
getTreatmentsByFlagSet: getTreatmentsByFlagSet,
|
|
119
108
|
getTreatmentsWithConfigByFlagSet: getTreatmentsWithConfigByFlagSet,
|
|
120
|
-
track: track
|
|
109
|
+
track: client.track,
|
|
121
110
|
};
|
|
122
111
|
}
|
|
@@ -1,72 +1,15 @@
|
|
|
1
1
|
import { objectAssign } from '../utils/lang/objectAssign';
|
|
2
|
-
import { releaseApiKey, validateAndTrackApiKey } from '../utils/inputValidation/apiKey';
|
|
3
2
|
import { clientFactory } from './client';
|
|
4
3
|
import { clientInputValidationDecorator } from './clientInputValidation';
|
|
5
|
-
|
|
4
|
+
import { sdkLifecycleFactory } from './sdkLifecycle';
|
|
6
5
|
/**
|
|
7
6
|
* Creates an Sdk client, i.e., a base client with status, init, flush and destroy interface
|
|
8
7
|
*/
|
|
9
8
|
export function sdkClientFactory(params, isSharedClient) {
|
|
10
|
-
var sdkReadinessManager = params.sdkReadinessManager,
|
|
11
|
-
var hasInit = false;
|
|
12
|
-
var lastActionTime = 0;
|
|
13
|
-
function __cooldown(func, time) {
|
|
14
|
-
var now = Date.now();
|
|
15
|
-
//get the actual time elapsed in ms
|
|
16
|
-
var timeElapsed = now - lastActionTime;
|
|
17
|
-
//check if the time elapsed is less than desired cooldown
|
|
18
|
-
if (timeElapsed < time) {
|
|
19
|
-
//if yes, return message with remaining time in seconds
|
|
20
|
-
settings.log.warn("Flush cooldown, remaining time ".concat((time - timeElapsed) / 1000, " seconds"));
|
|
21
|
-
return Promise.resolve();
|
|
22
|
-
}
|
|
23
|
-
else {
|
|
24
|
-
//Do the requested action and re-assign the lastActionTime
|
|
25
|
-
lastActionTime = now;
|
|
26
|
-
return func();
|
|
27
|
-
}
|
|
28
|
-
}
|
|
29
|
-
function __flush() {
|
|
30
|
-
return syncManager ? syncManager.flush() : Promise.resolve();
|
|
31
|
-
}
|
|
9
|
+
var sdkReadinessManager = params.sdkReadinessManager, settings = params.settings;
|
|
32
10
|
return objectAssign(
|
|
33
11
|
// Proto-linkage of the readiness Event Emitter
|
|
34
12
|
Object.create(sdkReadinessManager.sdkStatus),
|
|
35
13
|
// Client API (getTreatment* & track methods)
|
|
36
|
-
clientInputValidationDecorator(settings, clientFactory(params), sdkReadinessManager.readinessManager, params.
|
|
37
|
-
init: function () {
|
|
38
|
-
if (hasInit)
|
|
39
|
-
return;
|
|
40
|
-
hasInit = true;
|
|
41
|
-
if (!isSharedClient) {
|
|
42
|
-
validateAndTrackApiKey(settings.log, settings.core.authorizationKey);
|
|
43
|
-
sdkReadinessManager.readinessManager.init();
|
|
44
|
-
impressionsTracker.start();
|
|
45
|
-
syncManager && syncManager.start();
|
|
46
|
-
signalListener && signalListener.start();
|
|
47
|
-
}
|
|
48
|
-
},
|
|
49
|
-
flush: function () {
|
|
50
|
-
// @TODO define cooldown time
|
|
51
|
-
return __cooldown(__flush, COOLDOWN_TIME_IN_MILLIS);
|
|
52
|
-
},
|
|
53
|
-
destroy: function () {
|
|
54
|
-
hasInit = false;
|
|
55
|
-
// Mark the SDK as destroyed immediately
|
|
56
|
-
sdkReadinessManager.readinessManager.destroy();
|
|
57
|
-
// For main client, cleanup the SDK Key, listeners and scheduled jobs, and record stat before flushing data
|
|
58
|
-
if (!isSharedClient) {
|
|
59
|
-
releaseApiKey(settings.core.authorizationKey);
|
|
60
|
-
telemetryTracker.sessionLength();
|
|
61
|
-
signalListener && signalListener.stop();
|
|
62
|
-
impressionsTracker.stop();
|
|
63
|
-
}
|
|
64
|
-
// Stop background jobs
|
|
65
|
-
syncManager && syncManager.stop();
|
|
66
|
-
return __flush().then(function () {
|
|
67
|
-
// Cleanup storage
|
|
68
|
-
return storage.destroy();
|
|
69
|
-
});
|
|
70
|
-
}
|
|
71
|
-
});
|
|
14
|
+
clientInputValidationDecorator(settings, clientFactory(params), sdkReadinessManager.readinessManager, params.fallbackCalculator), sdkLifecycleFactory(params, isSharedClient));
|
|
72
15
|
}
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
import { releaseApiKey, validateAndTrackApiKey } from '../utils/inputValidation/apiKey';
|
|
2
|
+
import { LOCALHOST_MODE } from '../utils/constants';
|
|
3
|
+
var COOLDOWN_TIME_IN_MILLIS = 1000;
|
|
4
|
+
/**
|
|
5
|
+
* Creates an Sdk client, i.e., a base client with status, init, flush and destroy interface
|
|
6
|
+
*/
|
|
7
|
+
export function sdkLifecycleFactory(params, isSharedClient) {
|
|
8
|
+
var sdkReadinessManager = params.sdkReadinessManager, syncManager = params.syncManager, storage = params.storage, settings = params.settings, telemetryTracker = params.telemetryTracker, impressionsTracker = params.impressionsTracker, platform = params.platform, serviceApi = params.serviceApi;
|
|
9
|
+
var hasInit = false;
|
|
10
|
+
var lastActionTime = 0;
|
|
11
|
+
var signalListener = platform.SignalListener && settings.mode !== LOCALHOST_MODE ? new platform.SignalListener(params) : undefined;
|
|
12
|
+
function __cooldown(func, time) {
|
|
13
|
+
var now = Date.now();
|
|
14
|
+
//get the actual time elapsed in ms
|
|
15
|
+
var timeElapsed = now - lastActionTime;
|
|
16
|
+
//check if the time elapsed is less than desired cooldown
|
|
17
|
+
if (timeElapsed < time) {
|
|
18
|
+
//if yes, return message with remaining time in seconds
|
|
19
|
+
settings.log.warn("Flush cooldown, remaining time ".concat((time - timeElapsed) / 1000, " seconds"));
|
|
20
|
+
return Promise.resolve();
|
|
21
|
+
}
|
|
22
|
+
else {
|
|
23
|
+
//Do the requested action and re-assign the lastActionTime
|
|
24
|
+
lastActionTime = now;
|
|
25
|
+
return func();
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
function __flush() {
|
|
29
|
+
return syncManager ? syncManager.flush() : Promise.resolve();
|
|
30
|
+
}
|
|
31
|
+
return {
|
|
32
|
+
init: function () {
|
|
33
|
+
if (hasInit)
|
|
34
|
+
return;
|
|
35
|
+
hasInit = true;
|
|
36
|
+
if (!isSharedClient) {
|
|
37
|
+
validateAndTrackApiKey(settings.log, settings.core.authorizationKey);
|
|
38
|
+
sdkReadinessManager.readinessManager.init();
|
|
39
|
+
impressionsTracker.start();
|
|
40
|
+
syncManager && syncManager.start();
|
|
41
|
+
signalListener && signalListener.start();
|
|
42
|
+
}
|
|
43
|
+
},
|
|
44
|
+
flush: function () {
|
|
45
|
+
// @TODO define cooldown time
|
|
46
|
+
return __cooldown(__flush, COOLDOWN_TIME_IN_MILLIS);
|
|
47
|
+
},
|
|
48
|
+
destroy: function () {
|
|
49
|
+
hasInit = false;
|
|
50
|
+
// Mark the SDK as destroyed immediately
|
|
51
|
+
sdkReadinessManager.readinessManager.destroy();
|
|
52
|
+
// For main client, cleanup the SDK Key, listeners and scheduled jobs, and record stat before flushing data
|
|
53
|
+
if (!isSharedClient) {
|
|
54
|
+
releaseApiKey(settings.core.authorizationKey);
|
|
55
|
+
telemetryTracker.sessionLength();
|
|
56
|
+
signalListener && signalListener.stop();
|
|
57
|
+
impressionsTracker.stop();
|
|
58
|
+
}
|
|
59
|
+
// Stop background jobs
|
|
60
|
+
syncManager && syncManager.stop();
|
|
61
|
+
// Stop the service API (the auth provider backoff retries specifically) before flushing,
|
|
62
|
+
// so that a pending/never-resolved auth retry doesn't block the flush forever
|
|
63
|
+
serviceApi && serviceApi.stop();
|
|
64
|
+
return __flush().then(function () {
|
|
65
|
+
// Cleanup storage
|
|
66
|
+
return storage.destroy();
|
|
67
|
+
});
|
|
68
|
+
}
|
|
69
|
+
};
|
|
70
|
+
}
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
import { thenable } from '../utils/promise/thenable';
|
|
2
|
+
import { getMatching } from '../utils/key';
|
|
3
|
+
import { validateTrafficTypeExistence } from '../utils/inputValidation/trafficTypeExistence';
|
|
4
|
+
import { validateKey, validateTrafficType, validateEvent, validateEventValue, validateEventProperties, validateIfNotDestroyed } from '../utils/inputValidation';
|
|
5
|
+
import { TRACK, TRACK_FN_LABEL } from '../utils/constants';
|
|
6
|
+
import { isConsumerMode } from '../utils/settingsValidation/mode';
|
|
7
|
+
/**
|
|
8
|
+
* Creates a standalone `track` function with input validation.
|
|
9
|
+
* Reusable by FF SDK client, Configs SDK, and thin-client SDK.
|
|
10
|
+
*/
|
|
11
|
+
export function trackMethodFactory(params, warnTTExistence) {
|
|
12
|
+
if (warnTTExistence === void 0) { warnTTExistence = true; }
|
|
13
|
+
var settings = params.settings, definitions = params.storage.definitions, telemetryTracker = params.telemetryTracker, eventTracker = params.eventTracker, readinessManager = params.sdkReadinessManager.readinessManager;
|
|
14
|
+
var log = settings.log, mode = settings.mode;
|
|
15
|
+
var isAsync = isConsumerMode(mode);
|
|
16
|
+
return function track(maybeKey, maybeTT, maybeEvent, maybeEventValue, maybeProperties) {
|
|
17
|
+
// Input validation
|
|
18
|
+
var key = validateKey(log, maybeKey, TRACK_FN_LABEL);
|
|
19
|
+
var trafficTypeName = validateTrafficType(log, maybeTT, TRACK_FN_LABEL);
|
|
20
|
+
var eventTypeId = validateEvent(log, maybeEvent, TRACK_FN_LABEL);
|
|
21
|
+
var value = validateEventValue(log, maybeEventValue, TRACK_FN_LABEL);
|
|
22
|
+
var _a = validateEventProperties(log, maybeProperties, TRACK_FN_LABEL), properties = _a.properties, size = _a.size;
|
|
23
|
+
var isNotDestroyed = validateIfNotDestroyed(log, readinessManager, TRACK_FN_LABEL);
|
|
24
|
+
if (!(isNotDestroyed && key && trafficTypeName && eventTypeId && value !== false && properties !== false)) {
|
|
25
|
+
return isAsync ? Promise.resolve(false) : false;
|
|
26
|
+
}
|
|
27
|
+
// Core logic
|
|
28
|
+
var stopTelemetryTracker = telemetryTracker.trackEval(TRACK);
|
|
29
|
+
var eventData = {
|
|
30
|
+
eventTypeId: eventTypeId,
|
|
31
|
+
trafficTypeName: trafficTypeName,
|
|
32
|
+
value: value,
|
|
33
|
+
timestamp: Date.now(),
|
|
34
|
+
key: getMatching(key),
|
|
35
|
+
properties: properties
|
|
36
|
+
};
|
|
37
|
+
// This may be async but we only warn, we don't actually care if it is valid or not in terms of queueing the event.
|
|
38
|
+
if (warnTTExistence)
|
|
39
|
+
validateTrafficTypeExistence(log, readinessManager, definitions, mode, trafficTypeName, TRACK_FN_LABEL);
|
|
40
|
+
var result = eventTracker.track(eventData, size);
|
|
41
|
+
if (thenable(result)) {
|
|
42
|
+
return result.then(function (result) {
|
|
43
|
+
stopTelemetryTracker();
|
|
44
|
+
return result;
|
|
45
|
+
});
|
|
46
|
+
}
|
|
47
|
+
else {
|
|
48
|
+
stopTelemetryTracker();
|
|
49
|
+
return result;
|
|
50
|
+
}
|
|
51
|
+
};
|
|
52
|
+
}
|