@splitsoftware/splitio-commons 1.6.2-rc.9 → 1.7.1
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 +6 -1
- package/cjs/consent/sdkUserConsent.js +2 -2
- package/cjs/listeners/browser.js +11 -12
- package/cjs/logger/constants.js +2 -1
- package/cjs/sdkClient/sdkClient.js +3 -1
- package/cjs/sdkFactory/index.js +26 -26
- package/cjs/services/splitApi.js +20 -0
- package/cjs/storages/AbstractSplitsCacheAsync.js +1 -1
- package/cjs/storages/AbstractSplitsCacheSync.js +1 -1
- package/cjs/storages/KeyBuilderSS.js +10 -43
- package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js +0 -1
- package/cjs/storages/inLocalStorage/index.js +17 -9
- package/cjs/storages/inMemory/ImpressionCountsCacheInMemory.js +12 -1
- package/cjs/storages/inMemory/InMemoryStorage.js +13 -6
- package/cjs/storages/inMemory/InMemoryStorageCS.js +13 -6
- package/cjs/storages/inMemory/TelemetryCacheInMemory.js +60 -35
- package/cjs/storages/inMemory/UniqueKeysCacheInMemory.js +72 -0
- package/cjs/storages/inMemory/UniqueKeysCacheInMemoryCS.js +76 -0
- package/cjs/storages/inRedis/ImpressionCountsCacheInRedis.js +85 -0
- package/cjs/storages/inRedis/ImpressionsCacheInRedis.js +2 -19
- package/cjs/storages/inRedis/TelemetryCacheInRedis.js +4 -4
- package/cjs/storages/inRedis/UniqueKeysCacheInRedis.js +71 -0
- package/cjs/storages/inRedis/constants.js +4 -1
- package/cjs/storages/inRedis/index.js +20 -3
- package/cjs/storages/pluggable/ImpressionCountsCachePluggable.js +81 -0
- package/cjs/storages/pluggable/ImpressionsCachePluggable.js +2 -19
- package/cjs/storages/pluggable/TelemetryCachePluggable.js +4 -4
- package/cjs/storages/pluggable/UniqueKeysCachePluggable.js +61 -0
- package/cjs/storages/pluggable/inMemoryWrapper.js +8 -6
- package/cjs/storages/pluggable/index.js +38 -9
- package/cjs/storages/utils.js +73 -0
- package/cjs/sync/submitters/submitterManager.js +3 -0
- package/cjs/sync/submitters/telemetrySubmitter.js +5 -40
- package/cjs/sync/submitters/uniqueKeysSubmitter.js +27 -0
- package/cjs/trackers/impressionObserver/utils.js +1 -17
- package/cjs/trackers/impressionsTracker.js +22 -41
- package/cjs/trackers/strategy/strategyDebug.js +25 -0
- package/cjs/trackers/strategy/strategyNone.js +29 -0
- package/cjs/trackers/strategy/strategyOptimized.js +35 -0
- package/cjs/trackers/uniqueKeysTracker.js +38 -0
- package/cjs/utils/constants/index.js +4 -2
- package/cjs/utils/redis/RedisMock.js +31 -0
- package/cjs/utils/settingsValidation/impressionsMode.js +2 -2
- package/cjs/utils/settingsValidation/index.js +9 -3
- package/esm/consent/sdkUserConsent.js +2 -2
- package/esm/listeners/browser.js +12 -13
- package/esm/logger/constants.js +1 -0
- package/esm/sdkClient/sdkClient.js +3 -1
- package/esm/sdkFactory/index.js +26 -26
- package/esm/services/splitApi.js +20 -0
- package/esm/storages/AbstractSplitsCacheAsync.js +1 -1
- package/esm/storages/AbstractSplitsCacheSync.js +1 -1
- package/esm/storages/KeyBuilderSS.js +7 -37
- package/esm/storages/inLocalStorage/SplitsCacheInLocal.js +0 -1
- package/esm/storages/inLocalStorage/index.js +18 -10
- package/esm/storages/inMemory/ImpressionCountsCacheInMemory.js +12 -1
- package/esm/storages/inMemory/InMemoryStorage.js +14 -7
- package/esm/storages/inMemory/InMemoryStorageCS.js +14 -7
- package/esm/storages/inMemory/TelemetryCacheInMemory.js +61 -36
- package/esm/storages/inMemory/UniqueKeysCacheInMemory.js +68 -0
- package/esm/storages/inMemory/UniqueKeysCacheInMemoryCS.js +73 -0
- package/esm/storages/inRedis/ImpressionCountsCacheInRedis.js +82 -0
- package/esm/storages/inRedis/ImpressionsCacheInRedis.js +2 -19
- package/esm/storages/inRedis/TelemetryCacheInRedis.js +1 -1
- package/esm/storages/inRedis/UniqueKeysCacheInRedis.js +68 -0
- package/esm/storages/inRedis/constants.js +3 -0
- package/esm/storages/inRedis/index.js +21 -4
- package/esm/storages/pluggable/ImpressionCountsCachePluggable.js +78 -0
- package/esm/storages/pluggable/ImpressionsCachePluggable.js +2 -19
- package/esm/storages/pluggable/TelemetryCachePluggable.js +1 -1
- package/esm/storages/pluggable/UniqueKeysCachePluggable.js +58 -0
- package/esm/storages/pluggable/inMemoryWrapper.js +8 -6
- package/esm/storages/pluggable/index.js +39 -10
- package/esm/storages/utils.js +65 -0
- package/esm/sync/submitters/submitterManager.js +3 -0
- package/esm/sync/submitters/telemetrySubmitter.js +5 -39
- package/esm/sync/submitters/uniqueKeysSubmitter.js +23 -0
- package/esm/trackers/impressionObserver/utils.js +1 -15
- package/esm/trackers/impressionsTracker.js +22 -41
- package/esm/trackers/strategy/strategyDebug.js +21 -0
- package/esm/trackers/strategy/strategyNone.js +25 -0
- package/esm/trackers/strategy/strategyOptimized.js +31 -0
- package/esm/trackers/uniqueKeysTracker.js +34 -0
- package/esm/utils/constants/index.js +2 -0
- package/esm/utils/redis/RedisMock.js +28 -0
- package/esm/utils/settingsValidation/impressionsMode.js +3 -3
- package/esm/utils/settingsValidation/index.js +9 -3
- package/package.json +1 -2
- package/src/consent/sdkUserConsent.ts +2 -2
- package/src/listeners/browser.ts +12 -15
- package/src/logger/constants.ts +1 -0
- package/src/sdkClient/sdkClient.ts +3 -1
- package/src/sdkFactory/index.ts +29 -31
- package/src/sdkFactory/types.ts +7 -4
- package/src/services/splitApi.ts +22 -0
- package/src/services/types.ts +6 -0
- package/src/storages/AbstractSplitsCacheAsync.ts +1 -1
- package/src/storages/AbstractSplitsCacheSync.ts +1 -1
- package/src/storages/KeyBuilderSS.ts +9 -43
- package/src/storages/inLocalStorage/SplitsCacheInLocal.ts +0 -1
- package/src/storages/inLocalStorage/index.ts +18 -10
- package/src/storages/inMemory/AttributesCacheInMemory.ts +7 -7
- package/src/storages/inMemory/ImpressionCountsCacheInMemory.ts +16 -1
- package/src/storages/inMemory/InMemoryStorage.ts +14 -7
- package/src/storages/inMemory/InMemoryStorageCS.ts +14 -7
- package/src/storages/inMemory/TelemetryCacheInMemory.ts +69 -34
- package/src/storages/inMemory/UniqueKeysCacheInMemory.ts +80 -0
- package/src/storages/inMemory/UniqueKeysCacheInMemoryCS.ts +86 -0
- package/src/storages/inRedis/ImpressionCountsCacheInRedis.ts +95 -0
- package/src/storages/inRedis/ImpressionsCacheInRedis.ts +2 -22
- package/src/storages/inRedis/TelemetryCacheInRedis.ts +3 -2
- package/src/storages/inRedis/UniqueKeysCacheInRedis.ts +77 -0
- package/src/storages/inRedis/constants.ts +3 -0
- package/src/storages/inRedis/index.ts +18 -5
- package/src/storages/pluggable/ImpressionCountsCachePluggable.ts +92 -0
- package/src/storages/pluggable/ImpressionsCachePluggable.ts +3 -23
- package/src/storages/pluggable/TelemetryCachePluggable.ts +3 -2
- package/src/storages/pluggable/UniqueKeysCachePluggable.ts +67 -0
- package/src/storages/pluggable/inMemoryWrapper.ts +6 -6
- package/src/storages/pluggable/index.ts +41 -9
- package/src/storages/types.ts +56 -55
- package/src/storages/utils.ts +78 -0
- package/src/sync/submitters/submitter.ts +2 -2
- package/src/sync/submitters/submitterManager.ts +2 -0
- package/src/sync/submitters/telemetrySubmitter.ts +8 -43
- package/src/sync/submitters/types.ts +29 -27
- package/src/sync/submitters/uniqueKeysSubmitter.ts +36 -0
- package/src/trackers/impressionObserver/utils.ts +1 -16
- package/src/trackers/impressionsTracker.ts +25 -46
- package/src/trackers/strategy/strategyDebug.ts +28 -0
- package/src/trackers/strategy/strategyNone.ts +34 -0
- package/src/trackers/strategy/strategyOptimized.ts +42 -0
- package/src/trackers/types.ts +28 -0
- package/src/trackers/uniqueKeysTracker.ts +48 -0
- package/src/types.ts +1 -1
- package/src/utils/constants/index.ts +2 -0
- package/src/utils/redis/RedisMock.ts +33 -0
- package/src/utils/settingsValidation/impressionsMode.ts +3 -3
- package/src/utils/settingsValidation/index.ts +7 -3
- package/types/logger/constants.d.ts +1 -0
- package/types/sdkFactory/types.d.ts +4 -2
- package/types/services/types.d.ts +4 -0
- package/types/storages/AbstractSplitsCacheAsync.d.ts +1 -1
- package/types/storages/AbstractSplitsCacheSync.d.ts +1 -1
- package/types/storages/KeyBuilderSS.d.ts +3 -3
- package/types/storages/inLocalStorage/SplitsCacheInLocal.d.ts +0 -1
- package/types/storages/inMemory/ImpressionCountsCacheInMemory.d.ts +5 -1
- package/types/storages/inMemory/TelemetryCacheInMemory.d.ts +20 -9
- package/types/storages/inMemory/uniqueKeysCacheInMemory.d.ts +35 -0
- package/types/storages/inMemory/uniqueKeysCacheInMemoryCS.d.ts +35 -0
- package/types/storages/inRedis/ImpressionCountsCacheInRedis.d.ts +16 -0
- package/types/storages/inRedis/ImpressionsCacheInRedis.d.ts +0 -1
- package/types/storages/inRedis/constants.d.ts +3 -0
- package/types/storages/inRedis/uniqueKeysCacheInRedis.d.ts +21 -0
- package/types/storages/pluggable/ImpressionCountsCachePluggable.d.ts +16 -0
- package/types/storages/pluggable/ImpressionsCachePluggable.d.ts +1 -2
- package/types/storages/pluggable/UniqueKeysCachePluggable.d.ts +20 -0
- package/types/storages/types.d.ts +39 -38
- package/types/storages/utils.d.ts +8 -0
- package/types/sync/submitters/submitter.d.ts +2 -2
- package/types/sync/submitters/telemetrySubmitter.d.ts +2 -10
- package/types/sync/submitters/types.d.ts +27 -7
- package/types/sync/submitters/uniqueKeysSubmitter.d.ts +5 -0
- package/types/trackers/impressionObserver/utils.d.ts +0 -8
- package/types/trackers/impressionsTracker.d.ts +4 -6
- package/types/trackers/strategy/strategyDebug.d.ts +9 -0
- package/types/trackers/strategy/strategyNone.d.ts +10 -0
- package/types/trackers/strategy/strategyOptimized.d.ts +11 -0
- package/types/trackers/types.d.ts +23 -0
- package/types/trackers/uniqueKeysTracker.d.ts +13 -0
- package/types/types.d.ts +1 -1
- package/types/utils/constants/index.d.ts +2 -0
- package/types/utils/redis/RedisMock.d.ts +4 -0
- package/cjs/storages/metadataBuilder.js +0 -12
- package/esm/storages/metadataBuilder.js +0 -8
- package/src/storages/metadataBuilder.ts +0 -11
|
@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.impressionsTrackerFactory = void 0;
|
|
4
4
|
var objectAssign_1 = require("../utils/lang/objectAssign");
|
|
5
5
|
var thenable_1 = require("../utils/promise/thenable");
|
|
6
|
-
var time_1 = require("../utils/time");
|
|
7
6
|
var constants_1 = require("../logger/constants");
|
|
8
7
|
var constants_2 = require("../utils/constants");
|
|
9
8
|
/**
|
|
@@ -13,52 +12,34 @@ var constants_2 = require("../utils/constants");
|
|
|
13
12
|
* @param metadata runtime metadata (ip, hostname and version)
|
|
14
13
|
* @param impressionListener optional impression listener
|
|
15
14
|
* @param integrationsManager optional integrations manager
|
|
16
|
-
* @param
|
|
17
|
-
* @param countsCache optional cache to save impressions count. If provided, impressions will be deduped (OPTIMIZED mode)
|
|
15
|
+
* @param strategy strategy for impressions tracking.
|
|
18
16
|
*/
|
|
19
|
-
function impressionsTrackerFactory(settings, impressionsCache, integrationsManager,
|
|
20
|
-
// if observer is provided, it implies `shouldAddPreviousTime` flag (i.e., if impressions previous time should be added or not)
|
|
21
|
-
observer,
|
|
22
|
-
// if countsCache is provided, it implies `isOptimized` flag (i.e., if impressions should be deduped or not)
|
|
23
|
-
countsCache, telemetryCache) {
|
|
17
|
+
function impressionsTrackerFactory(settings, impressionsCache, strategy, integrationsManager, telemetryCache) {
|
|
24
18
|
var log = settings.log, impressionListener = settings.impressionListener, _a = settings.runtime, ip = _a.ip, hostname = _a.hostname, version = settings.version;
|
|
25
19
|
return {
|
|
26
20
|
track: function (impressions, attributes) {
|
|
27
21
|
if (settings.userConsent === constants_2.CONSENT_DECLINED)
|
|
28
22
|
return;
|
|
29
23
|
var impressionsCount = impressions.length;
|
|
30
|
-
var
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
24
|
+
var _a = strategy.process(impressions), impressionsToStore = _a.impressionsToStore, impressionsToListener = _a.impressionsToListener, deduped = _a.deduped;
|
|
25
|
+
var impressionsToListenerCount = impressionsToListener.length;
|
|
26
|
+
if (impressionsToStore.length > 0) {
|
|
27
|
+
var res = impressionsCache.track(impressionsToStore);
|
|
28
|
+
// If we're on an async storage, handle error and log it.
|
|
29
|
+
if ((0, thenable_1.thenable)(res)) {
|
|
30
|
+
res.then(function () {
|
|
31
|
+
log.info(constants_1.IMPRESSIONS_TRACKER_SUCCESS, [impressionsCount]);
|
|
32
|
+
}).catch(function (err) {
|
|
33
|
+
log.error(constants_1.ERROR_IMPRESSIONS_TRACKER, [impressionsCount, err]);
|
|
34
|
+
});
|
|
36
35
|
}
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
//
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
impressionsToStore.push(impression);
|
|
45
|
-
}
|
|
46
|
-
});
|
|
47
|
-
var res = impressionsCache.track(impressionsToStore);
|
|
48
|
-
// If we're on an async storage, handle error and log it.
|
|
49
|
-
if ((0, thenable_1.thenable)(res)) {
|
|
50
|
-
res.then(function () {
|
|
51
|
-
log.info(constants_1.IMPRESSIONS_TRACKER_SUCCESS, [impressionsCount]);
|
|
52
|
-
}).catch(function (err) {
|
|
53
|
-
log.error(constants_1.ERROR_IMPRESSIONS_TRACKER, [impressionsCount, err]);
|
|
54
|
-
});
|
|
55
|
-
}
|
|
56
|
-
else {
|
|
57
|
-
// Record when impressionsCache is sync only (standalone mode)
|
|
58
|
-
// @TODO we are not dropping impressions on full queue yet, so DROPPED stats are not recorded
|
|
59
|
-
if (telemetryCache) {
|
|
60
|
-
telemetryCache.recordImpressionStats(constants_2.QUEUED, impressionsToStore.length);
|
|
61
|
-
telemetryCache.recordImpressionStats(constants_2.DEDUPED, impressions.length - impressionsToStore.length);
|
|
36
|
+
else {
|
|
37
|
+
// Record when impressionsCache is sync only (standalone mode)
|
|
38
|
+
// @TODO we are not dropping impressions on full queue yet, so DROPPED stats are not recorded
|
|
39
|
+
if (telemetryCache) {
|
|
40
|
+
telemetryCache.recordImpressionStats(constants_2.QUEUED, impressionsToStore.length);
|
|
41
|
+
telemetryCache.recordImpressionStats(constants_2.DEDUPED, deduped);
|
|
42
|
+
}
|
|
62
43
|
}
|
|
63
44
|
}
|
|
64
45
|
// @TODO next block might be handled by the integration manager. In that case, the metadata object doesn't need to be passed in the constructor
|
|
@@ -66,7 +47,7 @@ countsCache, telemetryCache) {
|
|
|
66
47
|
var _loop_1 = function (i) {
|
|
67
48
|
var impressionData = {
|
|
68
49
|
// copy of impression, to avoid unexpected behaviour if modified by integrations or impressionListener
|
|
69
|
-
impression: (0, objectAssign_1.objectAssign)({},
|
|
50
|
+
impression: (0, objectAssign_1.objectAssign)({}, impressionsToListener[i]),
|
|
70
51
|
attributes: attributes,
|
|
71
52
|
ip: ip,
|
|
72
53
|
hostname: hostname,
|
|
@@ -86,7 +67,7 @@ countsCache, telemetryCache) {
|
|
|
86
67
|
}
|
|
87
68
|
}, 0);
|
|
88
69
|
};
|
|
89
|
-
for (var i = 0; i <
|
|
70
|
+
for (var i = 0; i < impressionsToListenerCount; i++) {
|
|
90
71
|
_loop_1(i);
|
|
91
72
|
}
|
|
92
73
|
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.strategyDebugFactory = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Debug strategy for impressions tracker. Wraps impressions to store and adds previousTime if it corresponds
|
|
6
|
+
*
|
|
7
|
+
* @param impressionsObserver impression observer. Previous time (pt property) is included in impression instances
|
|
8
|
+
* @returns IStrategyResult
|
|
9
|
+
*/
|
|
10
|
+
function strategyDebugFactory(impressionsObserver) {
|
|
11
|
+
return {
|
|
12
|
+
process: function (impressions) {
|
|
13
|
+
impressions.forEach(function (impression) {
|
|
14
|
+
// Adds previous time if it is enabled
|
|
15
|
+
impression.pt = impressionsObserver.testAndSet(impression);
|
|
16
|
+
});
|
|
17
|
+
return {
|
|
18
|
+
impressionsToStore: impressions,
|
|
19
|
+
impressionsToListener: impressions,
|
|
20
|
+
deduped: 0
|
|
21
|
+
};
|
|
22
|
+
}
|
|
23
|
+
};
|
|
24
|
+
}
|
|
25
|
+
exports.strategyDebugFactory = strategyDebugFactory;
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.strategyNoneFactory = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* None strategy for impressions tracker.
|
|
6
|
+
*
|
|
7
|
+
* @param impressionsCounter cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
|
|
8
|
+
* @param uniqueKeysTracker unique keys tracker in charge of tracking the unique keys per split.
|
|
9
|
+
* @returns IStrategyResult
|
|
10
|
+
*/
|
|
11
|
+
function strategyNoneFactory(impressionsCounter, uniqueKeysTracker) {
|
|
12
|
+
return {
|
|
13
|
+
process: function (impressions) {
|
|
14
|
+
impressions.forEach(function (impression) {
|
|
15
|
+
var now = Date.now();
|
|
16
|
+
// Increments impression counter per featureName
|
|
17
|
+
impressionsCounter.track(impression.feature, now, 1);
|
|
18
|
+
// Keep track by unique key
|
|
19
|
+
uniqueKeysTracker.track(impression.keyName, impression.feature);
|
|
20
|
+
});
|
|
21
|
+
return {
|
|
22
|
+
impressionsToStore: [],
|
|
23
|
+
impressionsToListener: impressions,
|
|
24
|
+
deduped: 0
|
|
25
|
+
};
|
|
26
|
+
}
|
|
27
|
+
};
|
|
28
|
+
}
|
|
29
|
+
exports.strategyNoneFactory = strategyNoneFactory;
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.strategyOptimizedFactory = void 0;
|
|
4
|
+
var time_1 = require("../../utils/time");
|
|
5
|
+
/**
|
|
6
|
+
* Optimized strategy for impressions tracker. Wraps impressions to store and adds previousTime if it corresponds
|
|
7
|
+
*
|
|
8
|
+
* @param impressionsObserver impression observer. previous time (pt property) is included in impression instances
|
|
9
|
+
* @param impressionsCounter cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
|
|
10
|
+
* @returns IStrategyResult
|
|
11
|
+
*/
|
|
12
|
+
function strategyOptimizedFactory(impressionsObserver, impressionsCounter) {
|
|
13
|
+
return {
|
|
14
|
+
process: function (impressions) {
|
|
15
|
+
var impressionsToStore = [];
|
|
16
|
+
impressions.forEach(function (impression) {
|
|
17
|
+
impression.pt = impressionsObserver.testAndSet(impression);
|
|
18
|
+
var now = Date.now();
|
|
19
|
+
// Increments impression counter per featureName
|
|
20
|
+
if (impression.pt)
|
|
21
|
+
impressionsCounter.track(impression.feature, now, 1);
|
|
22
|
+
// Checks if the impression should be added in queue to be sent
|
|
23
|
+
if (!impression.pt || impression.pt < (0, time_1.truncateTimeFrame)(now)) {
|
|
24
|
+
impressionsToStore.push(impression);
|
|
25
|
+
}
|
|
26
|
+
});
|
|
27
|
+
return {
|
|
28
|
+
impressionsToStore: impressionsToStore,
|
|
29
|
+
impressionsToListener: impressions,
|
|
30
|
+
deduped: impressions.length - impressionsToStore.length
|
|
31
|
+
};
|
|
32
|
+
}
|
|
33
|
+
};
|
|
34
|
+
}
|
|
35
|
+
exports.strategyOptimizedFactory = strategyOptimizedFactory;
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.uniqueKeysTrackerFactory = void 0;
|
|
4
|
+
var constants_1 = require("../logger/constants");
|
|
5
|
+
var noopFilterAdapter = {
|
|
6
|
+
add: function () { return true; },
|
|
7
|
+
contains: function () { return true; },
|
|
8
|
+
clear: function () { }
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* Trackes uniques keys
|
|
12
|
+
* Unique Keys Tracker will be in charge of checking if the MTK was already sent to the BE in the last period
|
|
13
|
+
* or schedule to be sent; if not it will be added in an internal cache and sent in the next post.
|
|
14
|
+
*
|
|
15
|
+
* @param log Logger instance
|
|
16
|
+
* @param uniqueKeysCache cache to save unique keys
|
|
17
|
+
* @param filterAdapter filter adapter
|
|
18
|
+
*/
|
|
19
|
+
function uniqueKeysTrackerFactory(log, uniqueKeysCache, filterAdapter) {
|
|
20
|
+
if (filterAdapter === void 0) { filterAdapter = noopFilterAdapter; }
|
|
21
|
+
var intervalId;
|
|
22
|
+
if (filterAdapter.refreshRate) {
|
|
23
|
+
intervalId = setInterval(filterAdapter.clear, filterAdapter.refreshRate);
|
|
24
|
+
}
|
|
25
|
+
return {
|
|
26
|
+
track: function (key, featureName) {
|
|
27
|
+
if (!filterAdapter.add(key, featureName)) {
|
|
28
|
+
log.debug(constants_1.LOG_PREFIX_UNIQUE_KEYS_TRACKER + "The feature " + featureName + " and key " + key + " exist in the filter");
|
|
29
|
+
return;
|
|
30
|
+
}
|
|
31
|
+
uniqueKeysCache.track(key, featureName);
|
|
32
|
+
},
|
|
33
|
+
stop: function () {
|
|
34
|
+
clearInterval(intervalId);
|
|
35
|
+
}
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
exports.uniqueKeysTrackerFactory = uniqueKeysTrackerFactory;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
4
|
-
exports.PAUSED = exports.ENABLED = exports.DISABLED = exports.NON_REQUESTED = exports.REQUESTED = exports.POLLING = exports.STREAMING = void 0;
|
|
3
|
+
exports.ABLY_ERROR = exports.TOKEN_REFRESH = exports.SSE_CONNECTION_ERROR = exports.STREAMING_STATUS = exports.OCCUPANCY_SEC = exports.OCCUPANCY_PRI = exports.CONNECTION_ESTABLISHED = exports.TRACK = exports.TREATMENTS_WITH_CONFIG = exports.TREATMENT_WITH_CONFIG = exports.TREATMENTS = exports.TREATMENT = exports.MY_SEGMENT = exports.SEGMENT = exports.TOKEN = exports.TELEMETRY = exports.EVENTS = exports.IMPRESSIONS_COUNT = exports.IMPRESSIONS = exports.SPLITS = exports.NONE_ENUM = exports.DEBUG_ENUM = exports.OPTIMIZED_ENUM = exports.CONSUMER_PARTIAL_ENUM = exports.CONSUMER_ENUM = exports.STANDALONE_ENUM = exports.DEDUPED = exports.DROPPED = exports.QUEUED = exports.CONSENT_UNKNOWN = exports.CONSENT_DECLINED = exports.CONSENT_GRANTED = exports.STORAGE_PLUGGABLE = exports.STORAGE_REDIS = exports.STORAGE_LOCALSTORAGE = exports.STORAGE_MEMORY = exports.CONSUMER_PARTIAL_MODE = exports.CONSUMER_MODE = exports.PRODUCER_MODE = exports.STANDALONE_MODE = exports.LOCALHOST_MODE = exports.NONE = exports.OPTIMIZED = exports.DEBUG = exports.SPLIT_EVENT = exports.SPLIT_IMPRESSION = exports.NA = exports.UNKNOWN = exports.CONTROL_WITH_CONFIG = exports.CONTROL = void 0;
|
|
4
|
+
exports.PAUSED = exports.ENABLED = exports.DISABLED = exports.NON_REQUESTED = exports.REQUESTED = exports.POLLING = exports.STREAMING = exports.AUTH_REJECTION = exports.SYNC_MODE_UPDATE = void 0;
|
|
5
5
|
// Special treatments
|
|
6
6
|
exports.CONTROL = 'control';
|
|
7
7
|
exports.CONTROL_WITH_CONFIG = {
|
|
@@ -17,6 +17,7 @@ exports.SPLIT_EVENT = 'EVENT';
|
|
|
17
17
|
// Impression collection modes
|
|
18
18
|
exports.DEBUG = 'DEBUG';
|
|
19
19
|
exports.OPTIMIZED = 'OPTIMIZED';
|
|
20
|
+
exports.NONE = 'NONE';
|
|
20
21
|
// SDK Modes
|
|
21
22
|
exports.LOCALHOST_MODE = 'localhost';
|
|
22
23
|
exports.STANDALONE_MODE = 'standalone';
|
|
@@ -41,6 +42,7 @@ exports.CONSUMER_ENUM = 1;
|
|
|
41
42
|
exports.CONSUMER_PARTIAL_ENUM = 2;
|
|
42
43
|
exports.OPTIMIZED_ENUM = 0;
|
|
43
44
|
exports.DEBUG_ENUM = 1;
|
|
45
|
+
exports.NONE_ENUM = 2;
|
|
44
46
|
exports.SPLITS = 'sp';
|
|
45
47
|
exports.IMPRESSIONS = 'im';
|
|
46
48
|
exports.IMPRESSIONS_COUNT = 'ic';
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.RedisMock = void 0;
|
|
4
|
+
//@ts-nocheck
|
|
5
|
+
function identityFunction(data) {
|
|
6
|
+
return data;
|
|
7
|
+
}
|
|
8
|
+
function asyncFunction(data) {
|
|
9
|
+
return Promise.resolve(data);
|
|
10
|
+
}
|
|
11
|
+
var IDENTITY_METHODS = [];
|
|
12
|
+
var ASYNC_METHODS = ['rpush', 'hincrby'];
|
|
13
|
+
var PIPELINE_METHODS = ['rpush', 'hincrby'];
|
|
14
|
+
var RedisMock = /** @class */ (function () {
|
|
15
|
+
function RedisMock() {
|
|
16
|
+
var _this = this;
|
|
17
|
+
this.pipelineMethods = { exec: jest.fn(asyncFunction) };
|
|
18
|
+
IDENTITY_METHODS.forEach(function (method) {
|
|
19
|
+
_this[method] = jest.fn(identityFunction);
|
|
20
|
+
});
|
|
21
|
+
ASYNC_METHODS.forEach(function (method) {
|
|
22
|
+
_this[method] = jest.fn(asyncFunction);
|
|
23
|
+
});
|
|
24
|
+
PIPELINE_METHODS.forEach(function (method) {
|
|
25
|
+
_this.pipelineMethods[method] = _this[method];
|
|
26
|
+
});
|
|
27
|
+
this.pipeline = jest.fn(function () { return _this.pipelineMethods; });
|
|
28
|
+
}
|
|
29
|
+
return RedisMock;
|
|
30
|
+
}());
|
|
31
|
+
exports.RedisMock = RedisMock;
|
|
@@ -6,9 +6,9 @@ var constants_2 = require("../constants");
|
|
|
6
6
|
var lang_1 = require("../lang");
|
|
7
7
|
function validImpressionsMode(log, impressionsMode) {
|
|
8
8
|
impressionsMode = (0, lang_1.stringToUpperCase)(impressionsMode);
|
|
9
|
-
if ([constants_2.DEBUG, constants_2.OPTIMIZED].indexOf(impressionsMode) > -1)
|
|
9
|
+
if ([constants_2.DEBUG, constants_2.OPTIMIZED, constants_2.NONE].indexOf(impressionsMode) > -1)
|
|
10
10
|
return impressionsMode;
|
|
11
|
-
log.error(constants_1.ERROR_INVALID_CONFIG_PARAM, ['impressionsMode', [constants_2.DEBUG, constants_2.OPTIMIZED], constants_2.OPTIMIZED]);
|
|
11
|
+
log.error(constants_1.ERROR_INVALID_CONFIG_PARAM, ['impressionsMode', [constants_2.DEBUG, constants_2.OPTIMIZED, constants_2.NONE], constants_2.OPTIMIZED]);
|
|
12
12
|
return constants_2.OPTIMIZED;
|
|
13
13
|
}
|
|
14
14
|
exports.validImpressionsMode = validImpressionsMode;
|
|
@@ -26,8 +26,8 @@ exports.base = {
|
|
|
26
26
|
IPAddressesEnabled: undefined
|
|
27
27
|
},
|
|
28
28
|
scheduler: {
|
|
29
|
-
// fetch feature updates each
|
|
30
|
-
featuresRefreshRate:
|
|
29
|
+
// fetch feature updates each 60 sec
|
|
30
|
+
featuresRefreshRate: 60,
|
|
31
31
|
// fetch segments updates each 60 sec
|
|
32
32
|
segmentsRefreshRate: 60,
|
|
33
33
|
// publish telemetry stats each 3600 secs (1 hour)
|
|
@@ -132,8 +132,8 @@ function settingsValidation(config, validationParams) {
|
|
|
132
132
|
if (storage)
|
|
133
133
|
withDefaults.storage = storage(withDefaults);
|
|
134
134
|
// Validate key and TT (for client-side)
|
|
135
|
+
var maybeKey = withDefaults.core.key;
|
|
135
136
|
if (validationParams.acceptKey) {
|
|
136
|
-
var maybeKey = withDefaults.core.key;
|
|
137
137
|
// Although `key` is required in client-side, it can be omitted in LOCALHOST mode. In that case, the value `localhost_key` is used.
|
|
138
138
|
if (withDefaults.mode === constants_1.LOCALHOST_MODE && maybeKey === undefined) {
|
|
139
139
|
withDefaults.core.key = 'localhost_key';
|
|
@@ -151,6 +151,12 @@ function settingsValidation(config, validationParams) {
|
|
|
151
151
|
}
|
|
152
152
|
}
|
|
153
153
|
}
|
|
154
|
+
else {
|
|
155
|
+
// On server-side, key is undefined and used to distinguish from client-side
|
|
156
|
+
if (maybeKey !== undefined)
|
|
157
|
+
log.warn('Provided `key` is ignored in server-side SDK.'); // @ts-ignore
|
|
158
|
+
withDefaults.core.key = undefined;
|
|
159
|
+
}
|
|
154
160
|
// Current ip/hostname information
|
|
155
161
|
// @ts-ignore, modify readonly prop
|
|
156
162
|
withDefaults.runtime = runtime(withDefaults);
|
|
@@ -36,8 +36,8 @@ export function createUserConsentAPI(params) {
|
|
|
36
36
|
if (events.clear)
|
|
37
37
|
events.clear(); // @ts-ignore
|
|
38
38
|
if (impressions.clear)
|
|
39
|
-
impressions.clear();
|
|
40
|
-
if (impressionCounts)
|
|
39
|
+
impressions.clear(); // @ts-ignore
|
|
40
|
+
if (impressionCounts && impressionCounts.clear)
|
|
41
41
|
impressionCounts.clear();
|
|
42
42
|
}
|
|
43
43
|
}
|
package/esm/listeners/browser.js
CHANGED
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
import { fromImpressionsCollector } from '../sync/submitters/impressionsSubmitter';
|
|
2
2
|
import { fromImpressionCountsCollector } from '../sync/submitters/impressionCountsSubmitter';
|
|
3
|
-
import { OPTIMIZED, DEBUG } from '../utils/constants';
|
|
3
|
+
import { OPTIMIZED, DEBUG, NONE } from '../utils/constants';
|
|
4
4
|
import { objectAssign } from '../utils/lang/objectAssign';
|
|
5
5
|
import { CLEANUP_REGISTERING, CLEANUP_DEREGISTERING } from '../logger/constants';
|
|
6
6
|
import { isConsentGranted } from '../consent';
|
|
7
|
-
import { telemetryCacheStatsAdapter } from '../sync/submitters/telemetrySubmitter';
|
|
8
7
|
var VISIBILITYCHANGE_EVENT = 'visibilitychange';
|
|
9
8
|
var PAGEHIDE_EVENT = 'pagehide';
|
|
10
9
|
var UNLOAD_EVENT = 'unload';
|
|
@@ -68,24 +67,25 @@ var BrowserSignalListener = /** @class */ (function () {
|
|
|
68
67
|
BrowserSignalListener.prototype.flushData = function () {
|
|
69
68
|
if (!this.syncManager)
|
|
70
69
|
return; // In consumer mode there is not sync manager and data to flush
|
|
70
|
+
var _a = this.settings.urls, events = _a.events, telemetry = _a.telemetry;
|
|
71
71
|
// Flush impressions & events data if there is user consent
|
|
72
72
|
if (isConsentGranted(this.settings)) {
|
|
73
|
-
var
|
|
73
|
+
var sim = this.settings.sync.impressionsMode;
|
|
74
74
|
var extraMetadata = {
|
|
75
75
|
// sim stands for Sync/Split Impressions Mode
|
|
76
|
-
sim:
|
|
76
|
+
sim: sim === OPTIMIZED ? OPTIMIZED : sim === DEBUG ? DEBUG : NONE
|
|
77
77
|
};
|
|
78
|
-
this._flushData(
|
|
79
|
-
this._flushData(
|
|
78
|
+
this._flushData(events + '/testImpressions/beacon', this.storage.impressions, this.serviceApi.postTestImpressionsBulk, this.fromImpressionsCollector, extraMetadata);
|
|
79
|
+
this._flushData(events + '/events/beacon', this.storage.events, this.serviceApi.postEventsBulk);
|
|
80
80
|
if (this.storage.impressionCounts)
|
|
81
|
-
this._flushData(
|
|
81
|
+
this._flushData(events + '/testImpressions/count/beacon', this.storage.impressionCounts, this.serviceApi.postTestImpressionsCount, fromImpressionCountsCollector);
|
|
82
|
+
// @ts-ignore
|
|
83
|
+
if (this.storage.uniqueKeys)
|
|
84
|
+
this._flushData(telemetry + '/v1/keys/cs/beacon', this.storage.uniqueKeys, this.serviceApi.postUniqueKeysBulkCs);
|
|
82
85
|
}
|
|
83
86
|
// Flush telemetry data
|
|
84
|
-
if (this.storage.telemetry)
|
|
85
|
-
|
|
86
|
-
var telemetryCacheAdapter = telemetryCacheStatsAdapter(this.storage.telemetry, this.storage.splits, this.storage.segments);
|
|
87
|
-
this._flushData(telemetryUrl + '/v1/metrics/usage/beacon', telemetryCacheAdapter, this.serviceApi.postMetricsUsage);
|
|
88
|
-
}
|
|
87
|
+
if (this.storage.telemetry)
|
|
88
|
+
this._flushData(telemetry + '/v1/metrics/usage/beacon', this.storage.telemetry, this.serviceApi.postMetricsUsage);
|
|
89
89
|
};
|
|
90
90
|
BrowserSignalListener.prototype.flushDataIfHidden = function () {
|
|
91
91
|
// Precondition: document defined
|
|
@@ -99,7 +99,6 @@ var BrowserSignalListener = /** @class */ (function () {
|
|
|
99
99
|
if (!this._sendBeacon(url, dataPayload, extraMetadata)) {
|
|
100
100
|
postService(JSON.stringify(dataPayload)).catch(function () { }); // no-op just to catch a possible exception
|
|
101
101
|
}
|
|
102
|
-
cache.clear();
|
|
103
102
|
}
|
|
104
103
|
};
|
|
105
104
|
/**
|
package/esm/logger/constants.js
CHANGED
|
@@ -139,4 +139,5 @@ export var LOG_PREFIX_SYNC_POLLING = LOG_PREFIX_SYNC + ':polling-manager: ';
|
|
|
139
139
|
export var LOG_PREFIX_SYNC_SUBMITTERS = LOG_PREFIX_SYNC + ':submitter: ';
|
|
140
140
|
export var LOG_PREFIX_IMPRESSIONS_TRACKER = 'impressions-tracker: ';
|
|
141
141
|
export var LOG_PREFIX_EVENTS_TRACKER = 'events-tracker: ';
|
|
142
|
+
export var LOG_PREFIX_UNIQUE_KEYS_TRACKER = 'unique-keys-tracker: ';
|
|
142
143
|
export var LOG_PREFIX_CLEANUP = 'cleanup: ';
|
|
@@ -6,7 +6,7 @@ import { clientInputValidationDecorator } from './clientInputValidation';
|
|
|
6
6
|
* Creates an Sdk client, i.e., a base client with status and destroy interface
|
|
7
7
|
*/
|
|
8
8
|
export function sdkClientFactory(params, isSharedClient) {
|
|
9
|
-
var sdkReadinessManager = params.sdkReadinessManager, syncManager = params.syncManager, storage = params.storage, signalListener = params.signalListener, settings = params.settings, telemetryTracker = params.telemetryTracker;
|
|
9
|
+
var sdkReadinessManager = params.sdkReadinessManager, syncManager = params.syncManager, storage = params.storage, signalListener = params.signalListener, settings = params.settings, telemetryTracker = params.telemetryTracker, uniqueKeysTracker = params.uniqueKeysTracker;
|
|
10
10
|
return objectAssign(
|
|
11
11
|
// Proto-linkage of the readiness Event Emitter
|
|
12
12
|
Object.create(sdkReadinessManager.sdkStatus),
|
|
@@ -28,6 +28,8 @@ export function sdkClientFactory(params, isSharedClient) {
|
|
|
28
28
|
// Release the API Key if it is the main client
|
|
29
29
|
if (!isSharedClient)
|
|
30
30
|
releaseApiKey(settings.core.authorizationKey);
|
|
31
|
+
if (uniqueKeysTracker)
|
|
32
|
+
uniqueKeysTracker.stop();
|
|
31
33
|
// Cleanup storage
|
|
32
34
|
return storage.destroy();
|
|
33
35
|
});
|
package/esm/sdkFactory/index.js
CHANGED
|
@@ -2,58 +2,58 @@ import { sdkReadinessManagerFactory } from '../readiness/sdkReadinessManager';
|
|
|
2
2
|
import { impressionsTrackerFactory } from '../trackers/impressionsTracker';
|
|
3
3
|
import { eventTrackerFactory } from '../trackers/eventTracker';
|
|
4
4
|
import { telemetryTrackerFactory } from '../trackers/telemetryTracker';
|
|
5
|
-
import { getMatching } from '../utils/key';
|
|
6
|
-
import { shouldBeOptimized } from '../trackers/impressionObserver/utils';
|
|
7
5
|
import { validateAndTrackApiKey } from '../utils/inputValidation/apiKey';
|
|
8
6
|
import { createLoggerAPI } from '../logger/sdkLogger';
|
|
9
7
|
import { NEW_FACTORY, RETRIEVE_MANAGER } from '../logger/constants';
|
|
10
|
-
import { metadataBuilder } from '../storages/metadataBuilder';
|
|
11
8
|
import { SDK_SPLITS_ARRIVED, SDK_SEGMENTS_ARRIVED } from '../readiness/constants';
|
|
12
9
|
import { objectAssign } from '../utils/lang/objectAssign';
|
|
10
|
+
import { strategyDebugFactory } from '../trackers/strategy/strategyDebug';
|
|
11
|
+
import { strategyOptimizedFactory } from '../trackers/strategy/strategyOptimized';
|
|
12
|
+
import { strategyNoneFactory } from '../trackers/strategy/strategyNone';
|
|
13
|
+
import { uniqueKeysTrackerFactory } from '../trackers/uniqueKeysTracker';
|
|
14
|
+
import { NONE, OPTIMIZED } from '../utils/constants';
|
|
13
15
|
/**
|
|
14
16
|
* Modular SDK factory
|
|
15
17
|
*/
|
|
16
18
|
export function sdkFactory(params) {
|
|
17
|
-
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;
|
|
18
|
-
var log = settings.log;
|
|
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;
|
|
20
|
+
var log = settings.log, impressionsMode = settings.sync.impressionsMode;
|
|
19
21
|
// @TODO handle non-recoverable errors, such as, global `fetch` not available, invalid API Key, etc.
|
|
20
22
|
// On non-recoverable errors, we should mark the SDK as destroyed and not start synchronization.
|
|
21
23
|
// We will just log and allow for the SDK to end up throwing an SDK_TIMEOUT event for devs to handle.
|
|
22
24
|
validateAndTrackApiKey(log, settings.core.authorizationKey);
|
|
23
25
|
var sdkReadinessManager = sdkReadinessManagerFactory(log, platform.EventEmitter, settings.startup.readyTimeout);
|
|
24
26
|
var readiness = sdkReadinessManager.readinessManager;
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
impressionsQueueSize: settings.scheduler.impressionsQueueSize,
|
|
28
|
-
eventsQueueSize: settings.scheduler.eventsQueueSize,
|
|
29
|
-
optimize: shouldBeOptimized(settings),
|
|
30
|
-
// ATM, only used by InLocalStorage
|
|
31
|
-
matchingKey: getMatching(settings.core.key),
|
|
32
|
-
splitFiltersValidation: settings.sync.__splitFiltersValidation,
|
|
33
|
-
// ATM, only used by PluggableStorage
|
|
34
|
-
mode: settings.mode,
|
|
35
|
-
// Callback used to emit SDK_READY in consumer mode, where `syncManagerFactory` is undefined,
|
|
36
|
-
// or partial consumer mode, where it only has submitters, and therefore it doesn't emit readiness events.
|
|
27
|
+
var storage = storageFactory({
|
|
28
|
+
settings: settings,
|
|
37
29
|
onReadyCb: function (error) {
|
|
38
30
|
if (error)
|
|
39
31
|
return; // Don't emit SDK_READY if storage failed to connect. Error message is logged by wrapperAdapter
|
|
40
32
|
readiness.splits.emit(SDK_SPLITS_ARRIVED);
|
|
41
33
|
readiness.segments.emit(SDK_SEGMENTS_ARRIVED);
|
|
42
34
|
},
|
|
43
|
-
|
|
44
|
-
log: log
|
|
45
|
-
};
|
|
46
|
-
var storage = storageFactory(storageFactoryParams);
|
|
35
|
+
});
|
|
47
36
|
// @TODO add support for dataloader: `if (params.dataLoader) params.dataLoader(storage);`
|
|
48
37
|
var telemetryTracker = telemetryTrackerFactory(storage.telemetry, platform.now);
|
|
49
38
|
var integrationsManager = integrationsManagerFactory && integrationsManagerFactory({ settings: settings, storage: storage, telemetryTracker: telemetryTracker });
|
|
50
|
-
|
|
51
|
-
var
|
|
52
|
-
var
|
|
39
|
+
var observer = impressionsObserverFactory();
|
|
40
|
+
var uniqueKeysTracker = impressionsMode === NONE ? uniqueKeysTrackerFactory(log, storage.uniqueKeys, filterAdapterFactory && filterAdapterFactory()) : undefined;
|
|
41
|
+
var strategy;
|
|
42
|
+
switch (impressionsMode) {
|
|
43
|
+
case OPTIMIZED:
|
|
44
|
+
strategy = strategyOptimizedFactory(observer, storage.impressionCounts);
|
|
45
|
+
break;
|
|
46
|
+
case NONE:
|
|
47
|
+
strategy = strategyNoneFactory(storage.impressionCounts, uniqueKeysTracker);
|
|
48
|
+
break;
|
|
49
|
+
default:
|
|
50
|
+
strategy = strategyDebugFactory(observer);
|
|
51
|
+
}
|
|
52
|
+
var impressionsTracker = impressionsTrackerFactory(settings, storage.impressions, strategy, integrationsManager, storage.telemetry);
|
|
53
53
|
var eventTracker = eventTrackerFactory(settings, storage.events, integrationsManager, storage.telemetry);
|
|
54
54
|
// splitApi is used by SyncManager and Browser signal listener
|
|
55
55
|
var splitApi = splitApiFactory && splitApiFactory(settings, platform, telemetryTracker);
|
|
56
|
-
var ctx = { splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform };
|
|
56
|
+
var ctx = { splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, uniqueKeysTracker: uniqueKeysTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform };
|
|
57
57
|
var syncManager = syncManagerFactory && syncManagerFactory(ctx);
|
|
58
58
|
ctx.syncManager = syncManager;
|
|
59
59
|
var signalListener = SignalListener && new SignalListener(syncManager, settings, storage, splitApi);
|
|
@@ -74,7 +74,7 @@ export function sdkFactory(params) {
|
|
|
74
74
|
return managerInstance;
|
|
75
75
|
},
|
|
76
76
|
// Logger wrapper API
|
|
77
|
-
Logger: createLoggerAPI(
|
|
77
|
+
Logger: createLoggerAPI(log),
|
|
78
78
|
settings: settings,
|
|
79
79
|
}, extraProps && extraProps(ctx));
|
|
80
80
|
}
|
package/esm/services/splitApi.js
CHANGED
|
@@ -87,6 +87,26 @@ export function splitApiFactory(settings, platform, telemetryTracker) {
|
|
|
87
87
|
var url = urls.events + "/testImpressions/count";
|
|
88
88
|
return splitHttpClient(url, { method: 'POST', body: body, headers: headers }, telemetryTracker.trackHttp(IMPRESSIONS_COUNT));
|
|
89
89
|
},
|
|
90
|
+
/**
|
|
91
|
+
* Post unique keys for client side.
|
|
92
|
+
*
|
|
93
|
+
* @param body unique keys payload
|
|
94
|
+
* @param headers Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
|
|
95
|
+
*/
|
|
96
|
+
postUniqueKeysBulkCs: function (body, headers) {
|
|
97
|
+
var url = urls.telemetry + "/v1/keys/cs";
|
|
98
|
+
return splitHttpClient(url, { method: 'POST', body: body, headers: headers }, telemetryTracker.trackHttp(TELEMETRY));
|
|
99
|
+
},
|
|
100
|
+
/**
|
|
101
|
+
* Post unique keys for server side.
|
|
102
|
+
*
|
|
103
|
+
* @param body unique keys payload
|
|
104
|
+
* @param headers Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
|
|
105
|
+
*/
|
|
106
|
+
postUniqueKeysBulkSs: function (body, headers) {
|
|
107
|
+
var url = urls.telemetry + "/v1/keys/ss";
|
|
108
|
+
return splitHttpClient(url, { method: 'POST', body: body, headers: headers }, telemetryTracker.trackHttp(TELEMETRY));
|
|
109
|
+
},
|
|
90
110
|
postMetricsConfig: function (body, headers) {
|
|
91
111
|
var url = urls.telemetry + "/v1/metrics/config";
|
|
92
112
|
return splitHttpClient(url, { method: 'POST', body: body, headers: headers }, telemetryTracker.trackHttp(TELEMETRY), true);
|
|
@@ -25,7 +25,7 @@ var AbstractSplitsCacheAsync = /** @class */ (function () {
|
|
|
25
25
|
* @param {string} name
|
|
26
26
|
* @param {string} defaultTreatment
|
|
27
27
|
* @param {number} changeNumber
|
|
28
|
-
* @returns {Promise} a promise that is resolved once the split kill operation is performed. The fulfillment value is a boolean: `true` if the
|
|
28
|
+
* @returns {Promise} a promise that is resolved once the split kill operation is performed. The fulfillment value is a boolean: `true` if the operation successed updating the split or `false` if no split is updated,
|
|
29
29
|
* for instance, if the `changeNumber` is old, or if the split is not found (e.g., `/splitchanges` hasn't been fetched yet), or if the storage fails to apply the update.
|
|
30
30
|
* The promise will never be rejected.
|
|
31
31
|
*/
|
|
@@ -40,7 +40,7 @@ var AbstractSplitsCacheSync = /** @class */ (function () {
|
|
|
40
40
|
* @param {string} name
|
|
41
41
|
* @param {string} defaultTreatment
|
|
42
42
|
* @param {number} changeNumber
|
|
43
|
-
* @returns {
|
|
43
|
+
* @returns {boolean} `true` if the operation successed updating the split, or `false` if no split is updated,
|
|
44
44
|
* for instance, if the `changeNumber` is old, or if the split is not found (e.g., `/splitchanges` hasn't been fetched yet), or if the storage fails to apply the update.
|
|
45
45
|
*/
|
|
46
46
|
AbstractSplitsCacheSync.prototype.killLocally = function (name, defaultTreatment, changeNumber) {
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import { __extends } from "tslib";
|
|
2
2
|
import { KeyBuilder } from './KeyBuilder';
|
|
3
|
-
|
|
4
|
-
var METHOD_NAMES = {
|
|
3
|
+
export var METHOD_NAMES = {
|
|
5
4
|
t: 'treatment',
|
|
6
5
|
ts: 'treatments',
|
|
7
6
|
tc: 'treatmentWithConfig',
|
|
@@ -24,6 +23,12 @@ var KeyBuilderSS = /** @class */ (function (_super) {
|
|
|
24
23
|
KeyBuilderSS.prototype.buildImpressionsKey = function () {
|
|
25
24
|
return this.prefix + ".impressions";
|
|
26
25
|
};
|
|
26
|
+
KeyBuilderSS.prototype.buildImpressionsCountKey = function () {
|
|
27
|
+
return this.prefix + ".impressions.count";
|
|
28
|
+
};
|
|
29
|
+
KeyBuilderSS.prototype.buildUniqueKeysKey = function () {
|
|
30
|
+
return this.prefix + ".uniquekeys";
|
|
31
|
+
};
|
|
27
32
|
KeyBuilderSS.prototype.buildEventsKey = function () {
|
|
28
33
|
return this.prefix + ".events";
|
|
29
34
|
};
|
|
@@ -43,38 +48,3 @@ var KeyBuilderSS = /** @class */ (function (_super) {
|
|
|
43
48
|
return KeyBuilderSS;
|
|
44
49
|
}(KeyBuilder));
|
|
45
50
|
export { KeyBuilderSS };
|
|
46
|
-
// Used by consumer methods of TelemetryCacheInRedis and TelemetryCachePluggable
|
|
47
|
-
var REVERSE_METHOD_NAMES = Object.keys(METHOD_NAMES).reduce(function (acc, key) {
|
|
48
|
-
acc[METHOD_NAMES[key]] = key;
|
|
49
|
-
return acc;
|
|
50
|
-
}, {});
|
|
51
|
-
export function parseMetadata(field) {
|
|
52
|
-
var parts = field.split('/');
|
|
53
|
-
if (parts.length !== 3)
|
|
54
|
-
return "invalid subsection count. Expected 4, got: " + parts.length;
|
|
55
|
-
var s = parts[0] /* metadata.s */, n = parts[1] /* metadata.n */, i = parts[2] /* metadata.i */;
|
|
56
|
-
return [JSON.stringify({ s: s, n: n, i: i })];
|
|
57
|
-
}
|
|
58
|
-
export function parseExceptionField(field) {
|
|
59
|
-
var parts = field.split('/');
|
|
60
|
-
if (parts.length !== 4)
|
|
61
|
-
return "invalid subsection count. Expected 4, got: " + parts.length;
|
|
62
|
-
var s = parts[0] /* metadata.s */, n = parts[1] /* metadata.n */, i = parts[2] /* metadata.i */, m = parts[3];
|
|
63
|
-
var method = REVERSE_METHOD_NAMES[m];
|
|
64
|
-
if (!method)
|
|
65
|
-
return "unknown method '" + m + "'";
|
|
66
|
-
return [JSON.stringify({ s: s, n: n, i: i }), method];
|
|
67
|
-
}
|
|
68
|
-
export function parseLatencyField(field) {
|
|
69
|
-
var parts = field.split('/');
|
|
70
|
-
if (parts.length !== 5)
|
|
71
|
-
return "invalid subsection count. Expected 5, got: " + parts.length;
|
|
72
|
-
var s = parts[0] /* metadata.s */, n = parts[1] /* metadata.n */, i = parts[2] /* metadata.i */, m = parts[3], b = parts[4];
|
|
73
|
-
var method = REVERSE_METHOD_NAMES[m];
|
|
74
|
-
if (!method)
|
|
75
|
-
return "unknown method '" + m + "'";
|
|
76
|
-
var bucket = parseInt(b);
|
|
77
|
-
if (isNaN(bucket) || bucket >= MAX_LATENCY_BUCKET_COUNT)
|
|
78
|
-
return "invalid bucket. Expected a number between 0 and 22, got: " + b;
|
|
79
|
-
return [JSON.stringify({ s: s, n: n, i: i }), method, bucket];
|
|
80
|
-
}
|