@splitsoftware/splitio-commons 1.6.2-rc.0 → 1.6.2-rc.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/cjs/listeners/browser.js +2 -1
- package/cjs/logger/constants.js +2 -1
- package/cjs/sdkFactory/index.js +13 -5
- package/cjs/services/splitApi.js +20 -0
- package/cjs/sync/submitters/submitterManager.js +3 -0
- package/cjs/sync/submitters/uniqueKeysSubmitter.js +70 -0
- package/cjs/trackers/impressionsTracker.js +7 -28
- package/cjs/trackers/strategy/strategyDebug.js +25 -0
- package/cjs/trackers/strategy/strategyNone.js +29 -0
- package/cjs/trackers/strategy/strategyOptimized.js +34 -0
- package/cjs/trackers/uniqueKeysTracker.js +69 -0
- package/cjs/utils/constants/index.js +3 -2
- package/cjs/utils/settingsValidation/impressionsMode.js +2 -2
- package/cjs/utils/settingsValidation/index.js +3 -0
- package/esm/listeners/browser.js +3 -2
- package/esm/logger/constants.js +1 -0
- package/esm/sdkFactory/index.js +13 -5
- package/esm/services/splitApi.js +20 -0
- package/esm/sync/submitters/submitterManager.js +3 -0
- package/esm/sync/submitters/uniqueKeysSubmitter.js +64 -0
- package/esm/trackers/impressionsTracker.js +7 -28
- package/esm/trackers/strategy/strategyDebug.js +21 -0
- package/esm/trackers/strategy/strategyNone.js +25 -0
- package/esm/trackers/strategy/strategyOptimized.js +30 -0
- package/esm/trackers/uniqueKeysTracker.js +65 -0
- package/esm/utils/constants/index.js +1 -0
- package/esm/utils/settingsValidation/impressionsMode.js +3 -3
- package/esm/utils/settingsValidation/index.js +3 -0
- package/package.json +1 -1
- package/src/listeners/browser.ts +3 -2
- package/src/logger/constants.ts +1 -0
- package/src/sdkFactory/index.ts +15 -5
- package/src/sdkFactory/types.ts +7 -4
- package/src/services/splitApi.ts +22 -0
- package/src/services/types.ts +6 -0
- package/src/storages/types.ts +17 -4
- package/src/sync/submitters/submitterManager.ts +2 -0
- package/src/sync/submitters/types.ts +20 -1
- package/src/sync/submitters/uniqueKeysSubmitter.ts +79 -0
- package/src/trackers/impressionsTracker.ts +12 -34
- 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 +30 -0
- package/src/trackers/uniqueKeysTracker.ts +80 -0
- package/src/types.ts +2 -1
- package/src/utils/constants/index.ts +1 -0
- package/src/utils/settingsValidation/impressionsMode.ts +3 -3
- package/src/utils/settingsValidation/index.ts +4 -0
- package/types/logger/browser/{debugLogger.d.ts → DebugLogger.d.ts} +0 -0
- package/types/logger/browser/{errorLogger.d.ts → ErrorLogger.d.ts} +0 -0
- package/types/logger/browser/{infoLogger.d.ts → InfoLogger.d.ts} +0 -0
- package/types/logger/browser/{warnLogger.d.ts → WarnLogger.d.ts} +0 -0
- 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/types.d.ts +16 -3
- package/types/sync/submitters/types.d.ts +18 -1
- package/types/sync/submitters/uniqueKeysSubmitter.d.ts +10 -4
- package/types/trackers/filter/bloomFilter.d.ts +10 -0
- package/types/trackers/filter/dictionaryFilter.d.ts +8 -0
- package/types/trackers/filter/types.d.ts +5 -0
- package/types/trackers/impressionsTracker.d.ts +4 -6
- package/types/trackers/types.d.ts +29 -0
- package/types/types.d.ts +2 -1
- package/types/utils/constants/index.d.ts +1 -0
- package/types/utils/settingsValidation/index.d.ts +1 -0
- package/types/utils/timeTracker/index.d.ts +70 -1
- package/src/logger/.DS_Store +0 -0
- package/src/splitio.d.ts +0 -1602
- package/types/integrations/ga/GaToSplitPlugin.d.ts +0 -3
- package/types/integrations/ga/SplitToGaPlugin.d.ts +0 -4
- package/types/integrations/ga/autoRequire.d.ts +0 -4
- package/types/logger/codes.d.ts +0 -2
- package/types/logger/codesConstants.d.ts +0 -117
- package/types/logger/codesConstantsBrowser.d.ts +0 -2
- package/types/logger/codesConstantsNode.d.ts +0 -14
- package/types/logger/codesDebug.d.ts +0 -1
- package/types/logger/codesDebugBrowser.d.ts +0 -1
- package/types/logger/codesDebugNode.d.ts +0 -1
- package/types/logger/codesError.d.ts +0 -1
- package/types/logger/codesErrorNode.d.ts +0 -1
- package/types/logger/codesInfo.d.ts +0 -1
- package/types/logger/codesWarn.d.ts +0 -1
- package/types/logger/codesWarnNode.d.ts +0 -1
- package/types/logger/debugLogger.d.ts +0 -2
- package/types/logger/errorLogger.d.ts +0 -2
- package/types/logger/infoLogger.d.ts +0 -2
- package/types/logger/messages/debugBrowser.d.ts +0 -1
- package/types/logger/messages/debugNode.d.ts +0 -1
- package/types/logger/messages/errorNode.d.ts +0 -1
- package/types/logger/messages/warnNode.d.ts +0 -1
- package/types/logger/noopLogger.d.ts +0 -2
- package/types/logger/warnLogger.d.ts +0 -2
- package/types/sdkFactory/userConsentProps.d.ts +0 -6
- package/types/sdkManager/sdkManagerMethod.d.ts +0 -6
- package/types/storages/getRegisteredSegments.d.ts +0 -10
- package/types/storages/inMemory/index.d.ts +0 -10
- package/types/storages/parseSegments.d.ts +0 -6
- package/types/sync/polling/syncTasks/splitsSyncTask.copy.d.ts +0 -35
- package/types/sync/polling/syncTasks/splitsSyncTask.morelikeoriginal.d.ts +0 -35
- package/types/sync/streaming/AuthClient/indexV1.d.ts +0 -12
- package/types/sync/streaming/AuthClient/indexV2.d.ts +0 -8
- package/types/sync/streaming/pushManagerCS.d.ts +0 -1
- package/types/sync/streaming/pushManagerNoUsers.d.ts +0 -13
- package/types/sync/streaming/pushManagerSS.d.ts +0 -1
- package/types/sync/submitters/telemetrySyncTask.d.ts +0 -0
- package/types/sync/syncManagerFromFile.d.ts +0 -2
- package/types/sync/syncManagerFromObject.d.ts +0 -2
- package/types/sync/syncManagerOffline.d.ts +0 -9
- package/types/trackers/telemetryRecorder.d.ts +0 -0
- package/types/utils/EventEmitter.d.ts +0 -4
- package/types/utils/consent.d.ts +0 -2
- package/types/utils/lang/errors.d.ts +0 -10
- package/types/utils/murmur3/commons.d.ts +0 -12
- package/types/utils/settingsValidation/buildMetadata.d.ts +0 -3
- package/types/utils/settingsValidation/localhost/index.d.ts +0 -9
- package/types/utils/settingsValidation/logger.d.ts +0 -11
- package/types/utils/settingsValidation/runtime/browser.d.ts +0 -2
- package/types/utils/settingsValidation/runtime/node.d.ts +0 -2
- package/types/utils/settingsValidation/userConsent.d.ts +0 -5
package/cjs/listeners/browser.js
CHANGED
|
@@ -74,9 +74,10 @@ var BrowserSignalListener = /** @class */ (function () {
|
|
|
74
74
|
// Flush impressions & events data if there is user consent
|
|
75
75
|
if ((0, consent_1.isConsentGranted)(this.settings)) {
|
|
76
76
|
var eventsUrl = this.settings.urls.events;
|
|
77
|
+
var sim = this.settings.sync.impressionsMode;
|
|
77
78
|
var extraMetadata = {
|
|
78
79
|
// sim stands for Sync/Split Impressions Mode
|
|
79
|
-
sim:
|
|
80
|
+
sim: sim === constants_1.OPTIMIZED ? constants_1.OPTIMIZED : sim === constants_1.DEBUG ? constants_1.DEBUG : constants_1.NONE
|
|
80
81
|
};
|
|
81
82
|
this._flushData(eventsUrl + '/testImpressions/beacon', this.storage.impressions, this.serviceApi.postTestImpressionsBulk, this.fromImpressionsCollector, extraMetadata);
|
|
82
83
|
this._flushData(eventsUrl + '/events/beacon', this.storage.events, this.serviceApi.postEventsBulk);
|
package/cjs/logger/constants.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.SYNC_SPLITS_FETCH_RETRY = exports.POLLING_STOP = exports.POLLING_START = exports.POLLING_SMART_PAUSING = exports.NEW_FACTORY = exports.NEW_SHARED_CLIENT = exports.IMPRESSION_QUEUEING = exports.IMPRESSION = exports.CLIENT_READY = exports.CLIENT_READY_FROM_CACHE = exports.SETTINGS_SPLITS_FILTER = exports.SYNC_TASK_STOP = exports.SYNC_TASK_EXECUTE = exports.SYNC_TASK_START = exports.STREAMING_NEW_MESSAGE = exports.SYNC_SPLITS_SEGMENTS = exports.SYNC_SPLITS_REMOVED = exports.SYNC_SPLITS_NEW = exports.SYNC_SPLITS_FETCH = exports.SYNC_OFFLINE_DATA = exports.RETRIEVE_MANAGER = exports.RETRIEVE_CLIENT_EXISTING = exports.RETRIEVE_CLIENT_DEFAULT = exports.CLEANUP_DEREGISTERING = exports.CLEANUP_REGISTERING = exports.ENGINE_SANITIZE = exports.ENGINE_VALUE = exports.ENGINE_MATCHER_WHITELIST = exports.ENGINE_MATCHER_STARTS_WITH = exports.ENGINE_MATCHER_STRING_INVALID = exports.ENGINE_MATCHER_STRING = exports.ENGINE_MATCHER_SEGMENT = exports.ENGINE_MATCHER_PART_OF = exports.ENGINE_MATCHER_LESS = exports.ENGINE_MATCHER_GREATER = exports.ENGINE_MATCHER_ENDS_WITH = exports.ENGINE_MATCHER_EQUAL_TO_SET = exports.ENGINE_MATCHER_EQUAL = exports.ENGINE_MATCHER_DEPENDENCY_PRE = exports.ENGINE_MATCHER_DEPENDENCY = exports.ENGINE_MATCHER_CONTAINS_STRING = exports.ENGINE_MATCHER_CONTAINS_ANY = exports.ENGINE_MATCHER_CONTAINS_ALL = exports.ENGINE_MATCHER_BOOLEAN = exports.ENGINE_MATCHER_BETWEEN = exports.ENGINE_MATCHER_ALL = exports.ENGINE_BUCKET = exports.ENGINE_COMBINER_IFELSEIF_NO_TREATMENT = exports.ENGINE_COMBINER_IFELSEIF = exports.ENGINE_COMBINER_AND = void 0;
|
|
4
4
|
exports.ERROR_EVENT_TYPE_FORMAT = exports.ERROR_EVENTS_TRACKER = exports.ERROR_IMPRESSIONS_LISTENER = exports.ERROR_IMPRESSIONS_TRACKER = exports.ERROR_STREAMING_AUTH = exports.ERROR_STREAMING_SSE = exports.ERROR_SYNC_OFFLINE_LOADING = exports.ERROR_CLIENT_CANNOT_GET_READY = exports.ERROR_CLIENT_LISTENER = exports.ERROR_LOGLEVEL_INVALID = exports.ERROR_ENGINE_COMBINER_IFELSEIF = exports.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = exports.WARN_API_KEY = exports.WARN_SPLITS_FILTER_EMPTY = exports.WARN_SPLITS_FILTER_INVALID = exports.WARN_SPLITS_FILTER_IGNORED = exports.WARN_INTEGRATION_INVALID = exports.WARN_NOT_EXISTENT_TT = exports.WARN_LOWERCASE_TRAFFIC_TYPE = exports.WARN_NOT_EXISTENT_SPLIT = exports.WARN_TRIMMING = exports.WARN_CONVERTING = exports.WARN_TRIMMING_PROPERTIES = exports.WARN_SETTING_NULL = exports.SUBMITTERS_PUSH_RETRY = exports.SUBMITTERS_PUSH_FAILS = exports.STREAMING_FALLBACK = exports.STREAMING_PARSING_MESSAGE_FAILS = exports.STREAMING_PARSING_ERROR_FAILS = exports.SYNC_SPLITS_FETCH_FAILS = exports.SYNC_MYSEGMENTS_FETCH_RETRY = exports.CLIENT_NOT_READY = exports.CLIENT_NO_LISTENER = exports.ENGINE_VALUE_NO_ATTRIBUTES = exports.ENGINE_VALUE_INVALID = exports.USER_CONSENT_INITIAL = exports.USER_CONSENT_NOT_UPDATED = exports.USER_CONSENT_UPDATED = exports.IMPRESSIONS_TRACKER_SUCCESS = exports.EVENTS_TRACKER_SUCCESS = exports.SYNC_STOP_POLLING = exports.SYNC_CONTINUE_POLLING = exports.SYNC_START_POLLING = exports.SUBMITTERS_PUSH = exports.SUBMITTERS_PUSH_FULL_QUEUE = exports.STREAMING_DISCONNECTING = exports.STREAMING_DISABLED = exports.STREAMING_CONNECTING = exports.STREAMING_RECONNECT = exports.STREAMING_REFRESH_TOKEN = void 0;
|
|
5
|
-
exports.LOG_PREFIX_CLEANUP = exports.LOG_PREFIX_EVENTS_TRACKER = exports.LOG_PREFIX_IMPRESSIONS_TRACKER = exports.LOG_PREFIX_SYNC_SUBMITTERS = exports.LOG_PREFIX_SYNC_POLLING = exports.LOG_PREFIX_SYNC_MYSEGMENTS = exports.LOG_PREFIX_SYNC_SEGMENTS = exports.LOG_PREFIX_SYNC_SPLITS = exports.LOG_PREFIX_SYNC_STREAMING = exports.LOG_PREFIX_SYNC_OFFLINE = exports.LOG_PREFIX_SYNC_MANAGER = exports.LOG_PREFIX_SYNC = exports.LOG_PREFIX_ENGINE_VALUE = exports.LOG_PREFIX_ENGINE_MATCHER = exports.LOG_PREFIX_ENGINE_COMBINER = exports.LOG_PREFIX_ENGINE = exports.LOG_PREFIX_INSTANTIATION = exports.LOG_PREFIX_SETTINGS = exports.ERROR_MIN_CONFIG_PARAM = exports.ERROR_NOT_BOOLEAN = exports.ERROR_STORAGE_INVALID = exports.ERROR_LOCALHOST_MODULE_REQUIRED = exports.ERROR_HTTP = exports.ERROR_INVALID_CONFIG_PARAM = exports.ERROR_EMPTY_ARRAY = exports.ERROR_EMPTY = exports.ERROR_INVALID = exports.ERROR_INVALID_KEY_OBJECT = exports.ERROR_TOO_LONG = exports.ERROR_NULL = exports.ERROR_CLIENT_DESTROYED = exports.ERROR_NOT_FINITE = exports.ERROR_SIZE_EXCEEDED = exports.ERROR_NOT_PLAIN_OBJECT = void 0;
|
|
5
|
+
exports.LOG_PREFIX_CLEANUP = exports.LOG_PREFIX_UNIQUE_KEYS_TRACKER = exports.LOG_PREFIX_EVENTS_TRACKER = exports.LOG_PREFIX_IMPRESSIONS_TRACKER = exports.LOG_PREFIX_SYNC_SUBMITTERS = exports.LOG_PREFIX_SYNC_POLLING = exports.LOG_PREFIX_SYNC_MYSEGMENTS = exports.LOG_PREFIX_SYNC_SEGMENTS = exports.LOG_PREFIX_SYNC_SPLITS = exports.LOG_PREFIX_SYNC_STREAMING = exports.LOG_PREFIX_SYNC_OFFLINE = exports.LOG_PREFIX_SYNC_MANAGER = exports.LOG_PREFIX_SYNC = exports.LOG_PREFIX_ENGINE_VALUE = exports.LOG_PREFIX_ENGINE_MATCHER = exports.LOG_PREFIX_ENGINE_COMBINER = exports.LOG_PREFIX_ENGINE = exports.LOG_PREFIX_INSTANTIATION = exports.LOG_PREFIX_SETTINGS = exports.ERROR_MIN_CONFIG_PARAM = exports.ERROR_NOT_BOOLEAN = exports.ERROR_STORAGE_INVALID = exports.ERROR_LOCALHOST_MODULE_REQUIRED = exports.ERROR_HTTP = exports.ERROR_INVALID_CONFIG_PARAM = exports.ERROR_EMPTY_ARRAY = exports.ERROR_EMPTY = exports.ERROR_INVALID = exports.ERROR_INVALID_KEY_OBJECT = exports.ERROR_TOO_LONG = exports.ERROR_NULL = exports.ERROR_CLIENT_DESTROYED = exports.ERROR_NOT_FINITE = exports.ERROR_SIZE_EXCEEDED = exports.ERROR_NOT_PLAIN_OBJECT = void 0;
|
|
6
6
|
/**
|
|
7
7
|
* Message codes used to trim string log messages from commons and client-side API modules,
|
|
8
8
|
* in order to reduce the minimal SDK size for Browser and eventually other client-side environments.
|
|
@@ -144,4 +144,5 @@ exports.LOG_PREFIX_SYNC_POLLING = exports.LOG_PREFIX_SYNC + ':polling-manager: '
|
|
|
144
144
|
exports.LOG_PREFIX_SYNC_SUBMITTERS = exports.LOG_PREFIX_SYNC + ':submitter: ';
|
|
145
145
|
exports.LOG_PREFIX_IMPRESSIONS_TRACKER = 'impressions-tracker: ';
|
|
146
146
|
exports.LOG_PREFIX_EVENTS_TRACKER = 'events-tracker: ';
|
|
147
|
+
exports.LOG_PREFIX_UNIQUE_KEYS_TRACKER = 'unique-keys-tracker: ';
|
|
147
148
|
exports.LOG_PREFIX_CLEANUP = 'cleanup: ';
|
package/cjs/sdkFactory/index.js
CHANGED
|
@@ -13,12 +13,18 @@ var constants_1 = require("../logger/constants");
|
|
|
13
13
|
var metadataBuilder_1 = require("../storages/metadataBuilder");
|
|
14
14
|
var constants_2 = require("../readiness/constants");
|
|
15
15
|
var objectAssign_1 = require("../utils/lang/objectAssign");
|
|
16
|
+
var strategyDebug_1 = require("../trackers/strategy/strategyDebug");
|
|
17
|
+
var strategyOptimized_1 = require("../trackers/strategy/strategyOptimized");
|
|
18
|
+
var strategyNone_1 = require("../trackers/strategy/strategyNone");
|
|
19
|
+
var uniqueKeysTracker_1 = require("../trackers/uniqueKeysTracker");
|
|
20
|
+
var constants_3 = require("../utils/constants");
|
|
16
21
|
/**
|
|
17
22
|
* Modular SDK factory
|
|
18
23
|
*/
|
|
19
24
|
function sdkFactory(params) {
|
|
20
|
-
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;
|
|
25
|
+
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;
|
|
21
26
|
var log = settings.log;
|
|
27
|
+
var impressionsMode = settings.sync.impressionsMode;
|
|
22
28
|
// @TODO handle non-recoverable errors, such as, global `fetch` not available, invalid API Key, etc.
|
|
23
29
|
// On non-recoverable errors, we should mark the SDK as destroyed and not start synchronization.
|
|
24
30
|
// We will just log and allow for the SDK to end up throwing an SDK_TIMEOUT event for devs to handle.
|
|
@@ -49,14 +55,16 @@ function sdkFactory(params) {
|
|
|
49
55
|
var storage = storageFactory(storageFactoryParams);
|
|
50
56
|
// @TODO add support for dataloader: `if (params.dataLoader) params.dataLoader(storage);`
|
|
51
57
|
var integrationsManager = integrationsManagerFactory && integrationsManagerFactory({ settings: settings, storage: storage });
|
|
52
|
-
|
|
53
|
-
var
|
|
54
|
-
var
|
|
58
|
+
var observer = impressionsObserverFactory();
|
|
59
|
+
var uniqueKeysTracker = impressionsMode === constants_3.NONE ? (0, uniqueKeysTracker_1.uniqueKeysTrackerFactory)(log, filterAdapterFactory && filterAdapterFactory()) : undefined;
|
|
60
|
+
var strategy = (storageFactoryParams.optimize) ? (0, strategyOptimized_1.strategyOptimizedFactory)(observer, storage.impressionCounts) :
|
|
61
|
+
(impressionsMode === constants_3.NONE) ? (0, strategyNone_1.strategyNoneFactory)(storage.impressionCounts, uniqueKeysTracker) : (0, strategyDebug_1.strategyDebugFactory)(observer);
|
|
62
|
+
var impressionsTracker = (0, impressionsTracker_1.impressionsTrackerFactory)(settings, storage.impressions, strategy, integrationsManager, storage.telemetry);
|
|
55
63
|
var eventTracker = (0, eventTracker_1.eventTrackerFactory)(settings, storage.events, integrationsManager, storage.telemetry);
|
|
56
64
|
var telemetryTracker = (0, telemetryTracker_1.telemetryTrackerFactory)(storage.telemetry, platform.now);
|
|
57
65
|
// splitApi is used by SyncManager and Browser signal listener
|
|
58
66
|
var splitApi = splitApiFactory && splitApiFactory(settings, platform, telemetryTracker);
|
|
59
|
-
var ctx = { splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform };
|
|
67
|
+
var ctx = { splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, uniqueKeysTracker: uniqueKeysTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform };
|
|
60
68
|
var syncManager = syncManagerFactory && syncManagerFactory(ctx);
|
|
61
69
|
ctx.syncManager = syncManager;
|
|
62
70
|
var signalListener = SignalListener && new SignalListener(syncManager, settings, storage, splitApi);
|
package/cjs/services/splitApi.js
CHANGED
|
@@ -90,6 +90,26 @@ function splitApiFactory(settings, platform, telemetryTracker) {
|
|
|
90
90
|
var url = urls.events + "/testImpressions/count";
|
|
91
91
|
return splitHttpClient(url, { method: 'POST', body: body, headers: headers }, telemetryTracker.trackHttp(constants_1.IMPRESSIONS_COUNT));
|
|
92
92
|
},
|
|
93
|
+
/**
|
|
94
|
+
* Post unique keys for client side.
|
|
95
|
+
*
|
|
96
|
+
* @param body unique keys payload
|
|
97
|
+
* @param headers Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
|
|
98
|
+
*/
|
|
99
|
+
postUniqueKeysBulkCs: function (body, headers) {
|
|
100
|
+
var url = urls.telemetry + "/api/v1/keys/cs";
|
|
101
|
+
return splitHttpClient(url, { method: 'POST', body: body, headers: headers }, telemetryTracker.trackHttp(constants_1.TELEMETRY));
|
|
102
|
+
},
|
|
103
|
+
/**
|
|
104
|
+
* Post unique keys for server side.
|
|
105
|
+
*
|
|
106
|
+
* @param body unique keys payload
|
|
107
|
+
* @param headers Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
|
|
108
|
+
*/
|
|
109
|
+
postUniqueKeysBulkSs: function (body, headers) {
|
|
110
|
+
var url = urls.telemetry + "/api/v1/keys/ss";
|
|
111
|
+
return splitHttpClient(url, { method: 'POST', body: body, headers: headers }, telemetryTracker.trackHttp(constants_1.TELEMETRY));
|
|
112
|
+
},
|
|
93
113
|
postMetricsConfig: function (body) {
|
|
94
114
|
var url = urls.telemetry + "/v1/metrics/config";
|
|
95
115
|
return splitHttpClient(url, { method: 'POST', body: body }, telemetryTracker.trackHttp(constants_1.TELEMETRY), true);
|
|
@@ -5,6 +5,7 @@ var eventsSubmitter_1 = require("./eventsSubmitter");
|
|
|
5
5
|
var impressionsSubmitter_1 = require("./impressionsSubmitter");
|
|
6
6
|
var impressionCountsSubmitter_1 = require("./impressionCountsSubmitter");
|
|
7
7
|
var telemetrySubmitter_1 = require("./telemetrySubmitter");
|
|
8
|
+
var uniqueKeysSubmitter_1 = require("./uniqueKeysSubmitter");
|
|
8
9
|
function submitterManagerFactory(params) {
|
|
9
10
|
var submitters = [
|
|
10
11
|
(0, impressionsSubmitter_1.impressionsSubmitterFactory)(params),
|
|
@@ -14,6 +15,8 @@ function submitterManagerFactory(params) {
|
|
|
14
15
|
if (impressionCountsSubmitter)
|
|
15
16
|
submitters.push(impressionCountsSubmitter);
|
|
16
17
|
var telemetrySubmitter = (0, telemetrySubmitter_1.telemetrySubmitterFactory)(params);
|
|
18
|
+
if (params.uniqueKeysTracker)
|
|
19
|
+
submitters.push((0, uniqueKeysSubmitter_1.uniqueKeysSubmitterFactory)(params));
|
|
17
20
|
return {
|
|
18
21
|
// `onlyTelemetry` true if SDK is created with userConsent not GRANTED
|
|
19
22
|
start: function (onlyTelemetry) {
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.uniqueKeysSubmitterFactory = exports.fromUniqueKeysCollectorSs = exports.fromUniqueKeysCollectorCs = void 0;
|
|
4
|
+
var sets_1 = require("../../utils/lang/sets");
|
|
5
|
+
var submitter_1 = require("./submitter");
|
|
6
|
+
/**
|
|
7
|
+
* Invert keys for feature to features for key
|
|
8
|
+
*/
|
|
9
|
+
function invertUniqueKeys(uniqueKeys) {
|
|
10
|
+
var featureNames = Object.keys(uniqueKeys);
|
|
11
|
+
var inverted = {};
|
|
12
|
+
for (var i = 0; i < featureNames.length; i++) {
|
|
13
|
+
var featureName = featureNames[i];
|
|
14
|
+
var featureKeys = (0, sets_1.setToArray)(uniqueKeys[featureName]);
|
|
15
|
+
for (var j = 0; j < featureKeys.length; j++) {
|
|
16
|
+
var featureKey = featureKeys[j];
|
|
17
|
+
if (!inverted[featureKey])
|
|
18
|
+
inverted[featureKey] = [];
|
|
19
|
+
inverted[featureKey].push(featureName);
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
return inverted;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Converts `uniqueKeys` data from cache into request payload for CS.
|
|
26
|
+
*/
|
|
27
|
+
function fromUniqueKeysCollectorCs(uniqueKeys) {
|
|
28
|
+
var payload = [];
|
|
29
|
+
var featuresPerKey = invertUniqueKeys(uniqueKeys);
|
|
30
|
+
var keys = Object.keys(featuresPerKey);
|
|
31
|
+
for (var k = 0; k < keys.length; k++) {
|
|
32
|
+
var key = keys[k];
|
|
33
|
+
var uniqueKeysPayload = {
|
|
34
|
+
k: key,
|
|
35
|
+
fs: featuresPerKey[key]
|
|
36
|
+
};
|
|
37
|
+
payload.push(uniqueKeysPayload);
|
|
38
|
+
}
|
|
39
|
+
return { keys: payload };
|
|
40
|
+
}
|
|
41
|
+
exports.fromUniqueKeysCollectorCs = fromUniqueKeysCollectorCs;
|
|
42
|
+
/**
|
|
43
|
+
* Converts `uniqueKeys` data from cache into request payload for SS.
|
|
44
|
+
*/
|
|
45
|
+
function fromUniqueKeysCollectorSs(uniqueKeys) {
|
|
46
|
+
var payload = [];
|
|
47
|
+
var featureNames = Object.keys(uniqueKeys);
|
|
48
|
+
for (var i = 0; i < featureNames.length; i++) {
|
|
49
|
+
var featureName = featureNames[i];
|
|
50
|
+
var featureKeys = (0, sets_1.setToArray)(uniqueKeys[featureName]);
|
|
51
|
+
var uniqueKeysPayload = {
|
|
52
|
+
f: featureName,
|
|
53
|
+
ks: featureKeys
|
|
54
|
+
};
|
|
55
|
+
payload.push(uniqueKeysPayload);
|
|
56
|
+
}
|
|
57
|
+
return { keys: payload };
|
|
58
|
+
}
|
|
59
|
+
exports.fromUniqueKeysCollectorSs = fromUniqueKeysCollectorSs;
|
|
60
|
+
/**
|
|
61
|
+
* Submitter that periodically posts impression counts
|
|
62
|
+
*/
|
|
63
|
+
function uniqueKeysSubmitterFactory(params) {
|
|
64
|
+
var _a = params.settings, log = _a.log, uniqueKeysRefreshRate = _a.scheduler.uniqueKeysRefreshRate, key = _a.core.key, _b = params.splitApi, postUniqueKeysBulkCs = _b.postUniqueKeysBulkCs, postUniqueKeysBulkSs = _b.postUniqueKeysBulkSs, uniqueKeys = params.storage.uniqueKeys;
|
|
65
|
+
var isClientSide = key !== undefined;
|
|
66
|
+
var postUniqueKeysBulk = isClientSide ? postUniqueKeysBulkCs : postUniqueKeysBulkSs;
|
|
67
|
+
var fromUniqueKeysCollector = isClientSide ? fromUniqueKeysCollectorCs : fromUniqueKeysCollectorSs;
|
|
68
|
+
return (0, submitter_1.submitterFactory)(log, postUniqueKeysBulk, uniqueKeys, uniqueKeysRefreshRate, 'unique keys', fromUniqueKeysCollector);
|
|
69
|
+
}
|
|
70
|
+
exports.uniqueKeysSubmitterFactory = uniqueKeysSubmitterFactory;
|
|
@@ -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,37 +12,17 @@ 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
|
-
impressions.forEach(function (impression) {
|
|
33
|
-
if (observer) {
|
|
34
|
-
// Adds previous time if it is enabled
|
|
35
|
-
impression.pt = observer.testAndSet(impression);
|
|
36
|
-
}
|
|
37
|
-
var now = Date.now();
|
|
38
|
-
if (countsCache) {
|
|
39
|
-
// Increments impression counter per featureName
|
|
40
|
-
countsCache.track(impression.feature, now, 1);
|
|
41
|
-
}
|
|
42
|
-
// Checks if the impression should be added in queue to be sent
|
|
43
|
-
if (!countsCache || !impression.pt || impression.pt < (0, time_1.truncateTimeFrame)(now)) {
|
|
44
|
-
impressionsToStore.push(impression);
|
|
45
|
-
}
|
|
46
|
-
});
|
|
24
|
+
var _a = strategy.process(impressions), impressionsToStore = _a.impressionsToStore, impressionsToListener = _a.impressionsToListener, deduped = _a.deduped;
|
|
25
|
+
var impressionsToListenerCount = impressionsToListener.length;
|
|
47
26
|
var res = impressionsCache.track(impressionsToStore);
|
|
48
27
|
// If we're on an async storage, handle error and log it.
|
|
49
28
|
if ((0, thenable_1.thenable)(res)) {
|
|
@@ -58,7 +37,7 @@ countsCache, telemetryCache) {
|
|
|
58
37
|
// @TODO we are not dropping impressions on full queue yet, so DROPPED stats are not recorded
|
|
59
38
|
if (telemetryCache) {
|
|
60
39
|
telemetryCache.recordImpressionStats(constants_2.QUEUED, impressionsToStore.length);
|
|
61
|
-
telemetryCache.recordImpressionStats(constants_2.DEDUPED,
|
|
40
|
+
telemetryCache.recordImpressionStats(constants_2.DEDUPED, deduped);
|
|
62
41
|
}
|
|
63
42
|
}
|
|
64
43
|
// @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 +45,7 @@ countsCache, telemetryCache) {
|
|
|
66
45
|
var _loop_1 = function (i) {
|
|
67
46
|
var impressionData = {
|
|
68
47
|
// copy of impression, to avoid unexpected behaviour if modified by integrations or impressionListener
|
|
69
|
-
impression: (0, objectAssign_1.objectAssign)({},
|
|
48
|
+
impression: (0, objectAssign_1.objectAssign)({}, impressionsToListener[i]),
|
|
70
49
|
attributes: attributes,
|
|
71
50
|
ip: ip,
|
|
72
51
|
hostname: hostname,
|
|
@@ -86,7 +65,7 @@ countsCache, telemetryCache) {
|
|
|
86
65
|
}
|
|
87
66
|
}, 0);
|
|
88
67
|
};
|
|
89
|
-
for (var i = 0; i <
|
|
68
|
+
for (var i = 0; i < impressionsToListenerCount; i++) {
|
|
90
69
|
_loop_1(i);
|
|
91
70
|
}
|
|
92
71
|
}
|
|
@@ -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.feature, impression.keyName);
|
|
20
|
+
});
|
|
21
|
+
return {
|
|
22
|
+
impressionsToStore: [],
|
|
23
|
+
impressionsToListener: impressions,
|
|
24
|
+
deduped: 0
|
|
25
|
+
};
|
|
26
|
+
}
|
|
27
|
+
};
|
|
28
|
+
}
|
|
29
|
+
exports.strategyNoneFactory = strategyNoneFactory;
|
|
@@ -0,0 +1,34 @@
|
|
|
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
|
+
impressionsCounter.track(impression.feature, now, 1);
|
|
21
|
+
// Checks if the impression should be added in queue to be sent
|
|
22
|
+
if (!impression.pt || impression.pt < (0, time_1.truncateTimeFrame)(now)) {
|
|
23
|
+
impressionsToStore.push(impression);
|
|
24
|
+
}
|
|
25
|
+
});
|
|
26
|
+
return {
|
|
27
|
+
impressionsToStore: impressionsToStore,
|
|
28
|
+
impressionsToListener: impressions,
|
|
29
|
+
deduped: impressions.length - impressionsToStore.length
|
|
30
|
+
};
|
|
31
|
+
}
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
exports.strategyOptimizedFactory = strategyOptimizedFactory;
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.uniqueKeysTrackerFactory = void 0;
|
|
4
|
+
var constants_1 = require("../logger/constants");
|
|
5
|
+
var sets_1 = require("../utils/lang/sets");
|
|
6
|
+
var noopFilterAdapter = {
|
|
7
|
+
add: function () { return true; },
|
|
8
|
+
contains: function () { return true; },
|
|
9
|
+
clear: function () { }
|
|
10
|
+
};
|
|
11
|
+
var DEFAULT_CACHE_SIZE = 30000;
|
|
12
|
+
/**
|
|
13
|
+
* Trackes uniques keys
|
|
14
|
+
* Unique Keys Tracker will be in charge of checking if the MTK was already sent to the BE in the last period
|
|
15
|
+
* or schedule to be sent; if not it will be added in an internal cache and sent in the next post.
|
|
16
|
+
*
|
|
17
|
+
* @param log Logger instance
|
|
18
|
+
* @param filterAdapter filter adapter
|
|
19
|
+
* @param cacheSize optional internal cache size
|
|
20
|
+
* @param maxBulkSize optional max MTKs bulk size
|
|
21
|
+
*/
|
|
22
|
+
function uniqueKeysTrackerFactory(log, filterAdapter, cacheSize) {
|
|
23
|
+
if (filterAdapter === void 0) { filterAdapter = noopFilterAdapter; }
|
|
24
|
+
if (cacheSize === void 0) { cacheSize = DEFAULT_CACHE_SIZE; }
|
|
25
|
+
var uniqueKeysTracker = {};
|
|
26
|
+
var uniqueTrackerSize = 0;
|
|
27
|
+
return {
|
|
28
|
+
track: function (featureName, key) {
|
|
29
|
+
if (!filterAdapter.add(featureName, key)) {
|
|
30
|
+
log.debug(constants_1.LOG_PREFIX_UNIQUE_KEYS_TRACKER + "The feature " + featureName + " and key " + key + " exist in the filter");
|
|
31
|
+
return;
|
|
32
|
+
}
|
|
33
|
+
if (!uniqueKeysTracker[featureName])
|
|
34
|
+
uniqueKeysTracker[featureName] = new sets_1._Set();
|
|
35
|
+
var tracker = uniqueKeysTracker[featureName];
|
|
36
|
+
if (!tracker.has(key)) {
|
|
37
|
+
tracker.add(key);
|
|
38
|
+
log.debug(constants_1.LOG_PREFIX_UNIQUE_KEYS_TRACKER + "Key " + key + " added to feature " + featureName);
|
|
39
|
+
uniqueTrackerSize++;
|
|
40
|
+
}
|
|
41
|
+
if (uniqueTrackerSize >= cacheSize) {
|
|
42
|
+
log.warn(constants_1.LOG_PREFIX_UNIQUE_KEYS_TRACKER + "The UniqueKeysTracker size reached the maximum limit");
|
|
43
|
+
// @TODO trigger event to submitter to send mtk
|
|
44
|
+
uniqueTrackerSize = 0;
|
|
45
|
+
}
|
|
46
|
+
},
|
|
47
|
+
/**
|
|
48
|
+
* Pop the collected data, used as payload for posting.
|
|
49
|
+
*/
|
|
50
|
+
pop: function () {
|
|
51
|
+
var data = uniqueKeysTracker;
|
|
52
|
+
uniqueKeysTracker = {};
|
|
53
|
+
return data;
|
|
54
|
+
},
|
|
55
|
+
/**
|
|
56
|
+
* Clear the data stored on the cache.
|
|
57
|
+
*/
|
|
58
|
+
clear: function () {
|
|
59
|
+
uniqueKeysTracker = {};
|
|
60
|
+
},
|
|
61
|
+
/**
|
|
62
|
+
* Check if the cache is empty.
|
|
63
|
+
*/
|
|
64
|
+
isEmpty: function () {
|
|
65
|
+
return Object.keys(uniqueKeysTracker).length === 0;
|
|
66
|
+
}
|
|
67
|
+
};
|
|
68
|
+
}
|
|
69
|
+
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.SYNC_MODE_UPDATE = 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.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 = 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';
|
|
@@ -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;
|
|
@@ -34,6 +34,8 @@ exports.base = {
|
|
|
34
34
|
telemetryRefreshRate: 3600,
|
|
35
35
|
// publish evaluations each 300 sec (default value for OPTIMIZED impressions mode)
|
|
36
36
|
impressionsRefreshRate: 300,
|
|
37
|
+
// publish unique Keys each 900 sec (15 min)
|
|
38
|
+
uniqueKeysRefreshRate: 900,
|
|
37
39
|
// fetch offline changes each 15 sec
|
|
38
40
|
offlineRefreshRate: 15,
|
|
39
41
|
// publish events every 60 seconds after the first flush
|
|
@@ -112,6 +114,7 @@ function settingsValidation(config, validationParams) {
|
|
|
112
114
|
scheduler.segmentsRefreshRate = fromSecondsToMillis(scheduler.segmentsRefreshRate);
|
|
113
115
|
scheduler.offlineRefreshRate = fromSecondsToMillis(scheduler.offlineRefreshRate);
|
|
114
116
|
scheduler.eventsPushRate = fromSecondsToMillis(scheduler.eventsPushRate);
|
|
117
|
+
scheduler.uniqueKeysRefreshRate = fromSecondsToMillis(scheduler.uniqueKeysRefreshRate);
|
|
115
118
|
scheduler.telemetryRefreshRate = fromSecondsToMillis(validateMinValue('telemetryRefreshRate', scheduler.telemetryRefreshRate, 60));
|
|
116
119
|
// Default impressionsRefreshRate for DEBUG mode is 60 secs
|
|
117
120
|
if ((0, lang_1.get)(config, 'scheduler.impressionsRefreshRate') === undefined && withDefaults.sync.impressionsMode === constants_1.DEBUG)
|
package/esm/listeners/browser.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
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';
|
|
@@ -71,9 +71,10 @@ var BrowserSignalListener = /** @class */ (function () {
|
|
|
71
71
|
// Flush impressions & events data if there is user consent
|
|
72
72
|
if (isConsentGranted(this.settings)) {
|
|
73
73
|
var eventsUrl = this.settings.urls.events;
|
|
74
|
+
var sim = this.settings.sync.impressionsMode;
|
|
74
75
|
var extraMetadata = {
|
|
75
76
|
// sim stands for Sync/Split Impressions Mode
|
|
76
|
-
sim:
|
|
77
|
+
sim: sim === OPTIMIZED ? OPTIMIZED : sim === DEBUG ? DEBUG : NONE
|
|
77
78
|
};
|
|
78
79
|
this._flushData(eventsUrl + '/testImpressions/beacon', this.storage.impressions, this.serviceApi.postTestImpressionsBulk, this.fromImpressionsCollector, extraMetadata);
|
|
79
80
|
this._flushData(eventsUrl + '/events/beacon', this.storage.events, this.serviceApi.postEventsBulk);
|
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: ';
|
package/esm/sdkFactory/index.js
CHANGED
|
@@ -10,12 +10,18 @@ import { NEW_FACTORY, RETRIEVE_MANAGER } from '../logger/constants';
|
|
|
10
10
|
import { metadataBuilder } from '../storages/metadataBuilder';
|
|
11
11
|
import { SDK_SPLITS_ARRIVED, SDK_SEGMENTS_ARRIVED } from '../readiness/constants';
|
|
12
12
|
import { objectAssign } from '../utils/lang/objectAssign';
|
|
13
|
+
import { strategyDebugFactory } from '../trackers/strategy/strategyDebug';
|
|
14
|
+
import { strategyOptimizedFactory } from '../trackers/strategy/strategyOptimized';
|
|
15
|
+
import { strategyNoneFactory } from '../trackers/strategy/strategyNone';
|
|
16
|
+
import { uniqueKeysTrackerFactory } from '../trackers/uniqueKeysTracker';
|
|
17
|
+
import { NONE } from '../utils/constants';
|
|
13
18
|
/**
|
|
14
19
|
* Modular SDK factory
|
|
15
20
|
*/
|
|
16
21
|
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;
|
|
22
|
+
var settings = params.settings, platform = params.platform, storageFactory = params.storageFactory, splitApiFactory = params.splitApiFactory, extraProps = params.extraProps, syncManagerFactory = params.syncManagerFactory, SignalListener = params.SignalListener, impressionsObserverFactory = params.impressionsObserverFactory, integrationsManagerFactory = params.integrationsManagerFactory, sdkManagerFactory = params.sdkManagerFactory, sdkClientMethodFactory = params.sdkClientMethodFactory, filterAdapterFactory = params.filterAdapterFactory;
|
|
18
23
|
var log = settings.log;
|
|
24
|
+
var impressionsMode = settings.sync.impressionsMode;
|
|
19
25
|
// @TODO handle non-recoverable errors, such as, global `fetch` not available, invalid API Key, etc.
|
|
20
26
|
// On non-recoverable errors, we should mark the SDK as destroyed and not start synchronization.
|
|
21
27
|
// We will just log and allow for the SDK to end up throwing an SDK_TIMEOUT event for devs to handle.
|
|
@@ -46,14 +52,16 @@ export function sdkFactory(params) {
|
|
|
46
52
|
var storage = storageFactory(storageFactoryParams);
|
|
47
53
|
// @TODO add support for dataloader: `if (params.dataLoader) params.dataLoader(storage);`
|
|
48
54
|
var integrationsManager = integrationsManagerFactory && integrationsManagerFactory({ settings: settings, storage: storage });
|
|
49
|
-
|
|
50
|
-
var
|
|
51
|
-
var
|
|
55
|
+
var observer = impressionsObserverFactory();
|
|
56
|
+
var uniqueKeysTracker = impressionsMode === NONE ? uniqueKeysTrackerFactory(log, filterAdapterFactory && filterAdapterFactory()) : undefined;
|
|
57
|
+
var strategy = (storageFactoryParams.optimize) ? strategyOptimizedFactory(observer, storage.impressionCounts) :
|
|
58
|
+
(impressionsMode === NONE) ? strategyNoneFactory(storage.impressionCounts, uniqueKeysTracker) : strategyDebugFactory(observer);
|
|
59
|
+
var impressionsTracker = impressionsTrackerFactory(settings, storage.impressions, strategy, integrationsManager, storage.telemetry);
|
|
52
60
|
var eventTracker = eventTrackerFactory(settings, storage.events, integrationsManager, storage.telemetry);
|
|
53
61
|
var telemetryTracker = telemetryTrackerFactory(storage.telemetry, platform.now);
|
|
54
62
|
// splitApi is used by SyncManager and Browser signal listener
|
|
55
63
|
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 };
|
|
64
|
+
var ctx = { splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, uniqueKeysTracker: uniqueKeysTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform };
|
|
57
65
|
var syncManager = syncManagerFactory && syncManagerFactory(ctx);
|
|
58
66
|
ctx.syncManager = syncManager;
|
|
59
67
|
var signalListener = SignalListener && new SignalListener(syncManager, settings, storage, splitApi);
|
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 + "/api/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 + "/api/v1/keys/ss";
|
|
108
|
+
return splitHttpClient(url, { method: 'POST', body: body, headers: headers }, telemetryTracker.trackHttp(TELEMETRY));
|
|
109
|
+
},
|
|
90
110
|
postMetricsConfig: function (body) {
|
|
91
111
|
var url = urls.telemetry + "/v1/metrics/config";
|
|
92
112
|
return splitHttpClient(url, { method: 'POST', body: body }, telemetryTracker.trackHttp(TELEMETRY), true);
|
|
@@ -2,6 +2,7 @@ import { eventsSubmitterFactory } from './eventsSubmitter';
|
|
|
2
2
|
import { impressionsSubmitterFactory } from './impressionsSubmitter';
|
|
3
3
|
import { impressionCountsSubmitterFactory } from './impressionCountsSubmitter';
|
|
4
4
|
import { telemetrySubmitterFactory } from './telemetrySubmitter';
|
|
5
|
+
import { uniqueKeysSubmitterFactory } from './uniqueKeysSubmitter';
|
|
5
6
|
export function submitterManagerFactory(params) {
|
|
6
7
|
var submitters = [
|
|
7
8
|
impressionsSubmitterFactory(params),
|
|
@@ -11,6 +12,8 @@ export function submitterManagerFactory(params) {
|
|
|
11
12
|
if (impressionCountsSubmitter)
|
|
12
13
|
submitters.push(impressionCountsSubmitter);
|
|
13
14
|
var telemetrySubmitter = telemetrySubmitterFactory(params);
|
|
15
|
+
if (params.uniqueKeysTracker)
|
|
16
|
+
submitters.push(uniqueKeysSubmitterFactory(params));
|
|
14
17
|
return {
|
|
15
18
|
// `onlyTelemetry` true if SDK is created with userConsent not GRANTED
|
|
16
19
|
start: function (onlyTelemetry) {
|