@splitsoftware/splitio-commons 1.17.1-rc.0 → 1.17.1-rc.2
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 +3 -0
- package/cjs/sdkClient/identity.js +7 -0
- package/cjs/sdkClient/sdkClient.js +5 -5
- package/cjs/sdkClient/sdkClientMethod.js +3 -1
- package/cjs/sdkClient/sdkClientMethodCS.js +8 -13
- package/cjs/sdkClient/sdkClientMethodCSWithTT.js +8 -13
- package/cjs/sdkFactory/index.js +8 -2
- package/cjs/storages/AbstractSplitsCacheAsync.js +0 -7
- package/cjs/storages/AbstractSplitsCacheSync.js +0 -7
- package/cjs/storages/dataLoader.js +65 -32
- package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js +1 -9
- package/cjs/storages/inLocalStorage/index.js +4 -1
- package/cjs/storages/inMemory/InMemoryStorageCS.js +16 -4
- package/cjs/sync/offline/syncTasks/fromObjectSyncTask.js +2 -7
- package/cjs/sync/polling/updaters/splitChangesUpdater.js +1 -10
- package/cjs/utils/settingsValidation/storage/storageCS.js +1 -12
- package/esm/sdkClient/identity.js +3 -0
- package/esm/sdkClient/sdkClient.js +5 -5
- package/esm/sdkClient/sdkClientMethod.js +3 -1
- package/esm/sdkClient/sdkClientMethodCS.js +6 -11
- package/esm/sdkClient/sdkClientMethodCSWithTT.js +6 -11
- package/esm/sdkFactory/index.js +9 -3
- package/esm/storages/AbstractSplitsCacheAsync.js +0 -7
- package/esm/storages/AbstractSplitsCacheSync.js +0 -7
- package/esm/storages/dataLoader.js +62 -30
- package/esm/storages/inLocalStorage/SplitsCacheInLocal.js +1 -9
- package/esm/storages/inLocalStorage/index.js +5 -2
- package/esm/storages/inMemory/InMemoryStorageCS.js +16 -4
- package/esm/sync/offline/syncTasks/fromObjectSyncTask.js +3 -8
- package/esm/sync/polling/updaters/splitChangesUpdater.js +2 -11
- package/esm/utils/settingsValidation/storage/storageCS.js +0 -10
- package/package.json +1 -1
- package/src/sdkClient/identity.ts +5 -0
- package/src/sdkClient/sdkClient.ts +5 -5
- package/src/sdkClient/sdkClientMethod.ts +4 -1
- package/src/sdkClient/sdkClientMethodCS.ts +6 -12
- package/src/sdkClient/sdkClientMethodCSWithTT.ts +6 -12
- package/src/sdkFactory/index.ts +11 -4
- package/src/sdkFactory/types.ts +2 -1
- package/src/storages/AbstractSplitsCacheAsync.ts +0 -8
- package/src/storages/AbstractSplitsCacheSync.ts +0 -8
- package/src/storages/dataLoader.ts +63 -32
- package/src/storages/inLocalStorage/SplitsCacheInLocal.ts +1 -10
- package/src/storages/inLocalStorage/index.ts +6 -2
- package/src/storages/inMemory/InMemoryStorageCS.ts +19 -4
- package/src/storages/types.ts +1 -6
- package/src/sync/offline/syncTasks/fromObjectSyncTask.ts +3 -7
- package/src/sync/polling/updaters/splitChangesUpdater.ts +3 -11
- package/src/types.ts +16 -9
- package/src/utils/settingsValidation/storage/storageCS.ts +0 -13
- package/types/sdkClient/identity.d.ts +0 -4
- package/types/sdkClient/sdkClientMethod.d.ts +1 -1
- package/types/sdkFactory/types.d.ts +2 -1
- package/types/storages/AbstractMySegmentsCacheSync.d.ts +39 -0
- package/types/storages/AbstractSplitsCacheAsync.d.ts +0 -5
- package/types/storages/AbstractSplitsCacheSync.d.ts +0 -5
- package/types/storages/dataLoader.d.ts +17 -6
- package/types/storages/inLocalStorage/SplitsCacheInLocal.d.ts +0 -6
- package/types/storages/types.d.ts +1 -4
- package/types/types.d.ts +15 -9
- package/types/utils/settingsValidation/storage/storageCS.d.ts +0 -5
package/CHANGES.txt
CHANGED
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
2.0.0 (September XX, 2024)
|
|
2
|
+
- Updated internal storage factory to emit the SDK_READY_FROM_CACHE event when it corresponds, to clean up the initialization flow.
|
|
3
|
+
- Added `factory.destroy()` method, which invokes the `destroy` method on all SDK clients created by the factory.
|
|
2
4
|
- Added support for targeting rules based on large segments.
|
|
3
5
|
- BREAKING CHANGES:
|
|
6
|
+
- Updated default flag spec version to 1.2.
|
|
4
7
|
- Removed `/mySegments` endpoint from SplitAPI module, as it is replaced by `/memberships` endpoint.
|
|
5
8
|
- Removed support for MY_SEGMENTS_UPDATE and MY_SEGMENTS_UPDATE_V2 notification types, as they are replaced by MEMBERSHIPS_MS_UPDATE and MEMBERSHIPS_LS_UPDATE notification types.
|
|
6
9
|
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.buildInstanceId = void 0;
|
|
4
|
+
function buildInstanceId(key, trafficType) {
|
|
5
|
+
return (key.matchingKey ? key.matchingKey : key) + "-" + (key.bucketingKey ? key.bucketingKey : key) + "-" + (trafficType ? trafficType : '');
|
|
6
|
+
}
|
|
7
|
+
exports.buildInstanceId = buildInstanceId;
|
|
@@ -53,11 +53,11 @@ function sdkClientFactory(params, isSharedClient) {
|
|
|
53
53
|
// Stop background jobs
|
|
54
54
|
syncManager && syncManager.stop();
|
|
55
55
|
return __flush().then(function () {
|
|
56
|
-
//
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
56
|
+
// For main client, cleanup event listeners and scheduled jobs
|
|
57
|
+
if (!isSharedClient) {
|
|
58
|
+
signalListener && signalListener.stop();
|
|
59
|
+
uniqueKeysTracker && uniqueKeysTracker.stop();
|
|
60
|
+
}
|
|
61
61
|
// Cleanup storage
|
|
62
62
|
return storage.destroy();
|
|
63
63
|
});
|
|
@@ -4,11 +4,13 @@ exports.sdkClientMethodFactory = void 0;
|
|
|
4
4
|
var sdkClient_1 = require("./sdkClient");
|
|
5
5
|
var constants_1 = require("../logger/constants");
|
|
6
6
|
/**
|
|
7
|
-
* Factory of client method for server-side SDKs
|
|
7
|
+
* Factory of client method for server-side SDKs
|
|
8
8
|
*/
|
|
9
9
|
function sdkClientMethodFactory(params) {
|
|
10
10
|
var log = params.settings.log;
|
|
11
11
|
var clientInstance = (0, sdkClient_1.sdkClientFactory)(params);
|
|
12
|
+
// Only one client in server-side without bound key
|
|
13
|
+
params.clients[''] = clientInstance;
|
|
12
14
|
return function client() {
|
|
13
15
|
if (arguments.length > 0) {
|
|
14
16
|
throw new Error('Shared Client not supported by the storage mechanism. Create isolated instances instead.');
|
|
@@ -8,22 +8,18 @@ var sdkClient_1 = require("./sdkClient");
|
|
|
8
8
|
var objectAssign_1 = require("../utils/lang/objectAssign");
|
|
9
9
|
var constants_1 = require("../logger/constants");
|
|
10
10
|
var constants_2 = require("../readiness/constants");
|
|
11
|
-
|
|
12
|
-
// @ts-ignore
|
|
13
|
-
return (key.matchingKey ? key.matchingKey : key) + "-" + (key.bucketingKey ? key.bucketingKey : key) + "-";
|
|
14
|
-
}
|
|
11
|
+
var identity_1 = require("./identity");
|
|
15
12
|
/**
|
|
16
13
|
* Factory of client method for the client-side API variant where TT is ignored.
|
|
17
14
|
* Therefore, clients don't have a bound TT for the track method.
|
|
18
15
|
*/
|
|
19
16
|
function sdkClientMethodCSFactory(params) {
|
|
20
|
-
var storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, key = _a.core.key, log = _a.log;
|
|
17
|
+
var clients = params.clients, storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, key = _a.core.key, log = _a.log;
|
|
21
18
|
var mainClientInstance = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)(params), key);
|
|
22
19
|
var parsedDefaultKey = (0, key_2.keyParser)(key);
|
|
23
|
-
var defaultInstanceId = buildInstanceId(parsedDefaultKey);
|
|
20
|
+
var defaultInstanceId = (0, identity_1.buildInstanceId)(parsedDefaultKey);
|
|
24
21
|
// Cache instances created per factory.
|
|
25
|
-
|
|
26
|
-
clientInstances[defaultInstanceId] = mainClientInstance;
|
|
22
|
+
clients[defaultInstanceId] = mainClientInstance;
|
|
27
23
|
return function client(key) {
|
|
28
24
|
if (key === undefined) {
|
|
29
25
|
log.debug(constants_1.RETRIEVE_CLIENT_DEFAULT);
|
|
@@ -34,8 +30,8 @@ function sdkClientMethodCSFactory(params) {
|
|
|
34
30
|
if (validKey === false) {
|
|
35
31
|
throw new Error('Shared Client needs a valid key.');
|
|
36
32
|
}
|
|
37
|
-
var instanceId = buildInstanceId(validKey);
|
|
38
|
-
if (!
|
|
33
|
+
var instanceId = (0, identity_1.buildInstanceId)(validKey);
|
|
34
|
+
if (!clients[instanceId]) {
|
|
39
35
|
var matchingKey = (0, key_2.getMatching)(validKey);
|
|
40
36
|
var sharedSdkReadiness_1 = sdkReadinessManager.shared();
|
|
41
37
|
var sharedStorage = storage.shared && storage.shared(matchingKey, function (err) {
|
|
@@ -54,11 +50,10 @@ function sdkClientMethodCSFactory(params) {
|
|
|
54
50
|
var sharedSyncManager = syncManager && sharedStorage && syncManager.shared(matchingKey, sharedSdkReadiness_1.readinessManager, sharedStorage);
|
|
55
51
|
// As shared clients reuse all the storage information, we don't need to check here if we
|
|
56
52
|
// will use offline or online mode. We should stick with the original decision.
|
|
57
|
-
|
|
53
|
+
clients[instanceId] = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)((0, objectAssign_1.objectAssign)({}, params, {
|
|
58
54
|
sdkReadinessManager: sharedSdkReadiness_1,
|
|
59
55
|
storage: sharedStorage || storage,
|
|
60
56
|
syncManager: sharedSyncManager,
|
|
61
|
-
signalListener: undefined, // only the main client "destroy" method stops the signal listener
|
|
62
57
|
}), true), validKey);
|
|
63
58
|
sharedSyncManager && sharedSyncManager.start();
|
|
64
59
|
log.info(constants_1.NEW_SHARED_CLIENT);
|
|
@@ -66,7 +61,7 @@ function sdkClientMethodCSFactory(params) {
|
|
|
66
61
|
else {
|
|
67
62
|
log.debug(constants_1.RETRIEVE_CLIENT_EXISTING);
|
|
68
63
|
}
|
|
69
|
-
return
|
|
64
|
+
return clients[instanceId];
|
|
70
65
|
};
|
|
71
66
|
}
|
|
72
67
|
exports.sdkClientMethodCSFactory = sdkClientMethodCSFactory;
|
|
@@ -9,23 +9,19 @@ var sdkClient_1 = require("./sdkClient");
|
|
|
9
9
|
var objectAssign_1 = require("../utils/lang/objectAssign");
|
|
10
10
|
var constants_1 = require("../logger/constants");
|
|
11
11
|
var constants_2 = require("../readiness/constants");
|
|
12
|
-
|
|
13
|
-
// @ts-ignore
|
|
14
|
-
return (key.matchingKey ? key.matchingKey : key) + "-" + (key.bucketingKey ? key.bucketingKey : key) + "-" + (trafficType !== undefined ? trafficType : '');
|
|
15
|
-
}
|
|
12
|
+
var identity_1 = require("./identity");
|
|
16
13
|
/**
|
|
17
14
|
* Factory of client method for the client-side (browser) variant of the Isomorphic JS SDK,
|
|
18
15
|
* where clients can have a bound TT for the track method, which is provided via the settings
|
|
19
16
|
* (default client) or the client method (shared clients).
|
|
20
17
|
*/
|
|
21
18
|
function sdkClientMethodCSFactory(params) {
|
|
22
|
-
var storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, _b = _a.core, key = _b.key, trafficType = _b.trafficType, log = _a.log;
|
|
19
|
+
var clients = params.clients, storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, _b = _a.core, key = _b.key, trafficType = _b.trafficType, log = _a.log;
|
|
23
20
|
var mainClientInstance = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)(params), key, trafficType);
|
|
24
21
|
var parsedDefaultKey = (0, key_2.keyParser)(key);
|
|
25
|
-
var defaultInstanceId = buildInstanceId(parsedDefaultKey, trafficType);
|
|
22
|
+
var defaultInstanceId = (0, identity_1.buildInstanceId)(parsedDefaultKey, trafficType);
|
|
26
23
|
// Cache instances created per factory.
|
|
27
|
-
|
|
28
|
-
clientInstances[defaultInstanceId] = mainClientInstance;
|
|
24
|
+
clients[defaultInstanceId] = mainClientInstance;
|
|
29
25
|
return function client(key, trafficType) {
|
|
30
26
|
if (key === undefined) {
|
|
31
27
|
log.debug(constants_1.RETRIEVE_CLIENT_DEFAULT);
|
|
@@ -43,8 +39,8 @@ function sdkClientMethodCSFactory(params) {
|
|
|
43
39
|
throw new Error('Shared Client needs a valid traffic type or no traffic type at all.');
|
|
44
40
|
}
|
|
45
41
|
}
|
|
46
|
-
var instanceId = buildInstanceId(validKey, validTrafficType);
|
|
47
|
-
if (!
|
|
42
|
+
var instanceId = (0, identity_1.buildInstanceId)(validKey, validTrafficType);
|
|
43
|
+
if (!clients[instanceId]) {
|
|
48
44
|
var matchingKey = (0, key_2.getMatching)(validKey);
|
|
49
45
|
var sharedSdkReadiness_1 = sdkReadinessManager.shared();
|
|
50
46
|
var sharedStorage = storage.shared && storage.shared(matchingKey, function (err) {
|
|
@@ -63,11 +59,10 @@ function sdkClientMethodCSFactory(params) {
|
|
|
63
59
|
var sharedSyncManager = syncManager && sharedStorage && syncManager.shared(matchingKey, sharedSdkReadiness_1.readinessManager, sharedStorage);
|
|
64
60
|
// As shared clients reuse all the storage information, we don't need to check here if we
|
|
65
61
|
// will use offline or online mode. We should stick with the original decision.
|
|
66
|
-
|
|
62
|
+
clients[instanceId] = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)((0, objectAssign_1.objectAssign)({}, params, {
|
|
67
63
|
sdkReadinessManager: sharedSdkReadiness_1,
|
|
68
64
|
storage: sharedStorage || storage,
|
|
69
65
|
syncManager: sharedSyncManager,
|
|
70
|
-
signalListener: undefined, // only the main client "destroy" method stops the signal listener
|
|
71
66
|
}), true), validKey, validTrafficType);
|
|
72
67
|
sharedSyncManager && sharedSyncManager.start();
|
|
73
68
|
log.info(constants_1.NEW_SHARED_CLIENT);
|
|
@@ -75,7 +70,7 @@ function sdkClientMethodCSFactory(params) {
|
|
|
75
70
|
else {
|
|
76
71
|
log.debug(constants_1.RETRIEVE_CLIENT_EXISTING);
|
|
77
72
|
}
|
|
78
|
-
return
|
|
73
|
+
return clients[instanceId];
|
|
79
74
|
};
|
|
80
75
|
}
|
|
81
76
|
exports.sdkClientMethodCSFactory = sdkClientMethodCSFactory;
|
package/cjs/sdkFactory/index.js
CHANGED
|
@@ -38,8 +38,11 @@ function sdkFactory(params) {
|
|
|
38
38
|
readiness.splits.emit(constants_2.SDK_SPLITS_ARRIVED);
|
|
39
39
|
readiness.segments.emit(constants_2.SDK_SEGMENTS_ARRIVED);
|
|
40
40
|
},
|
|
41
|
+
onReadyFromCacheCb: function () {
|
|
42
|
+
readiness.splits.emit(constants_2.SDK_SPLITS_CACHE_LOADED);
|
|
43
|
+
}
|
|
41
44
|
});
|
|
42
|
-
|
|
45
|
+
var clients = {};
|
|
43
46
|
var telemetryTracker = (0, telemetryTracker_1.telemetryTrackerFactory)(storage.telemetry, platform.now);
|
|
44
47
|
var integrationsManager = integrationsManagerFactory && integrationsManagerFactory({ settings: settings, storage: storage, telemetryTracker: telemetryTracker });
|
|
45
48
|
var observer = impressionsObserverFactory();
|
|
@@ -59,7 +62,7 @@ function sdkFactory(params) {
|
|
|
59
62
|
var eventTracker = (0, eventTracker_1.eventTrackerFactory)(settings, storage.events, integrationsManager, storage.telemetry);
|
|
60
63
|
// splitApi is used by SyncManager and Browser signal listener
|
|
61
64
|
var splitApi = splitApiFactory && splitApiFactory(settings, platform, telemetryTracker);
|
|
62
|
-
var ctx = { splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, uniqueKeysTracker: uniqueKeysTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform };
|
|
65
|
+
var ctx = { clients: clients, splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, uniqueKeysTracker: uniqueKeysTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform };
|
|
63
66
|
var syncManager = syncManagerFactory && syncManagerFactory(ctx);
|
|
64
67
|
ctx.syncManager = syncManager;
|
|
65
68
|
var signalListener = SignalListener && new SignalListener(syncManager, settings, storage, splitApi);
|
|
@@ -82,6 +85,9 @@ function sdkFactory(params) {
|
|
|
82
85
|
// Logger wrapper API
|
|
83
86
|
Logger: (0, sdkLogger_1.createLoggerAPI)(log),
|
|
84
87
|
settings: settings,
|
|
88
|
+
destroy: function () {
|
|
89
|
+
return Promise.all(Object.keys(clients).map(function (key) { return clients[key].destroy(); })).then(function () { });
|
|
90
|
+
}
|
|
85
91
|
}, extraProps && extraProps(ctx));
|
|
86
92
|
}
|
|
87
93
|
exports.sdkFactory = sdkFactory;
|
|
@@ -14,13 +14,6 @@ var AbstractSplitsCacheAsync = /** @class */ (function () {
|
|
|
14
14
|
AbstractSplitsCacheAsync.prototype.usesSegments = function () {
|
|
15
15
|
return Promise.resolve(true);
|
|
16
16
|
};
|
|
17
|
-
/**
|
|
18
|
-
* Check if the splits information is already stored in cache.
|
|
19
|
-
* Noop, just keeping the interface. This is used by client-side implementations only.
|
|
20
|
-
*/
|
|
21
|
-
AbstractSplitsCacheAsync.prototype.checkCache = function () {
|
|
22
|
-
return Promise.resolve(false);
|
|
23
|
-
};
|
|
24
17
|
/**
|
|
25
18
|
* Kill `name` split and set `defaultTreatment` and `changeNumber`.
|
|
26
19
|
* Used for SPLIT_KILL push notifications.
|
|
@@ -30,13 +30,6 @@ var AbstractSplitsCacheSync = /** @class */ (function () {
|
|
|
30
30
|
var _this = this;
|
|
31
31
|
return this.getSplitNames().map(function (key) { return _this.getSplit(key); });
|
|
32
32
|
};
|
|
33
|
-
/**
|
|
34
|
-
* Check if the splits information is already stored in cache. This data can be preloaded.
|
|
35
|
-
* It is used as condition to emit SDK_SPLITS_CACHE_LOADED, and then SDK_READY_FROM_CACHE.
|
|
36
|
-
*/
|
|
37
|
-
AbstractSplitsCacheSync.prototype.checkCache = function () {
|
|
38
|
-
return false;
|
|
39
|
-
};
|
|
40
33
|
/**
|
|
41
34
|
* Kill `name` split and set `defaultTreatment` and `changeNumber`.
|
|
42
35
|
* Used for SPLIT_KILL push notifications.
|
|
@@ -1,51 +1,84 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
4
|
-
var
|
|
3
|
+
exports.getSnapshot = exports.loadData = void 0;
|
|
4
|
+
var sets_1 = require("../utils/lang/sets");
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* Storage-agnostic adaptation of `loadDataIntoLocalStorage` function
|
|
7
|
+
* (https://github.com/godaddy/split-javascript-data-loader/blob/master/src/load-data.js)
|
|
7
8
|
*
|
|
8
|
-
* @param preloadedData validated data following the format proposed in https://github.com/godaddy/split-javascript-data-loader
|
|
9
|
-
*
|
|
10
|
-
* @
|
|
9
|
+
* @param preloadedData validated data following the format proposed in https://github.com/godaddy/split-javascript-data-loader and extended with a `mySegmentsData` property.
|
|
10
|
+
* @param storage object containing `splits` and `segments` cache (client-side variant)
|
|
11
|
+
* @param userKey user key (matching key) of the provided MySegmentsCache
|
|
12
|
+
*
|
|
13
|
+
* @TODO extend to load largeSegments
|
|
14
|
+
* @TODO extend to load data on shared mySegments storages. Be specific when emitting SDK_READY_FROM_CACHE on shared clients. Maybe the serializer should provide the `useSegments` flag.
|
|
15
|
+
* @TODO add logs, and input validation in this module, in favor of size reduction.
|
|
16
|
+
* @TODO unit tests
|
|
11
17
|
*/
|
|
12
|
-
function
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
* @param userId user key string of the provided MySegmentsCache
|
|
19
|
-
*
|
|
20
|
-
* @TODO extend to support SegmentsCache (server-side variant) by making `userId` optional and adding the corresponding logic.
|
|
21
|
-
* @TODO extend to load data on shared mySegments storages. Be specific when emitting SDK_READY_FROM_CACHE on shared clients. Maybe the serializer should provide the `useSegments` flag.
|
|
22
|
-
*/
|
|
23
|
-
return function loadData(storage, userId) {
|
|
24
|
-
// Do not load data if current preloadedData is empty
|
|
25
|
-
if (Object.keys(preloadedData).length === 0)
|
|
26
|
-
return;
|
|
27
|
-
var _a = preloadedData.lastUpdated, lastUpdated = _a === void 0 ? -1 : _a, _b = preloadedData.segmentsData, segmentsData = _b === void 0 ? {} : _b, _c = preloadedData.since, since = _c === void 0 ? -1 : _c, _d = preloadedData.splitsData, splitsData = _d === void 0 ? {} : _d;
|
|
18
|
+
function loadData(preloadedData, storage, userKey) {
|
|
19
|
+
// Do not load data if current preloadedData is empty
|
|
20
|
+
if (Object.keys(preloadedData).length === 0)
|
|
21
|
+
return;
|
|
22
|
+
var _a = preloadedData.segmentsData, segmentsData = _a === void 0 ? {} : _a, _b = preloadedData.since, since = _b === void 0 ? -1 : _b, _c = preloadedData.splitsData, splitsData = _c === void 0 ? [] : _c;
|
|
23
|
+
if (storage.splits) {
|
|
28
24
|
var storedSince = storage.splits.getChangeNumber();
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
// or if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
|
|
32
|
-
if (storedSince > since || lastUpdated < expirationTimestamp)
|
|
25
|
+
// Do not load data if current data is more recent
|
|
26
|
+
if (storedSince > since)
|
|
33
27
|
return;
|
|
34
28
|
// cleaning up the localStorage data, since some cached splits might need be part of the preloaded data
|
|
35
29
|
storage.splits.clear();
|
|
36
30
|
storage.splits.setChangeNumber(since);
|
|
37
31
|
// splitsData in an object where the property is the split name and the pertaining value is a stringified json of its data
|
|
38
|
-
storage.splits.addSplits(
|
|
39
|
-
|
|
40
|
-
|
|
32
|
+
storage.splits.addSplits(splitsData.map(function (split) { return ([split.name, split]); }));
|
|
33
|
+
}
|
|
34
|
+
if (userKey) { // add mySegments data (client-side)
|
|
35
|
+
var mySegmentsData = preloadedData.mySegmentsData && preloadedData.mySegmentsData[userKey];
|
|
41
36
|
if (!mySegmentsData) {
|
|
42
37
|
// segmentsData in an object where the property is the segment name and the pertaining value is a stringified object that contains the `added` array of userIds
|
|
43
38
|
mySegmentsData = Object.keys(segmentsData).filter(function (segmentName) {
|
|
44
|
-
var
|
|
45
|
-
return
|
|
39
|
+
var userKeys = segmentsData[segmentName];
|
|
40
|
+
return userKeys.indexOf(userKey) > -1;
|
|
46
41
|
});
|
|
47
42
|
}
|
|
48
43
|
storage.segments.resetSegments({ k: mySegmentsData.map(function (s) { return ({ n: s }); }) });
|
|
44
|
+
}
|
|
45
|
+
else { // add segments data (server-side)
|
|
46
|
+
Object.keys(segmentsData).filter(function (segmentName) {
|
|
47
|
+
var userKeys = segmentsData[segmentName];
|
|
48
|
+
storage.segments.addToSegment(segmentName, userKeys);
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
exports.loadData = loadData;
|
|
53
|
+
function getSnapshot(storage, userKeys) {
|
|
54
|
+
return {
|
|
55
|
+
// lastUpdated: Date.now(),
|
|
56
|
+
// @ts-ignore accessing private prop
|
|
57
|
+
since: storage.splits.changeNumber,
|
|
58
|
+
splitsData: storage.splits.getAll(),
|
|
59
|
+
segmentsData: userKeys ?
|
|
60
|
+
undefined : // @ts-ignore accessing private prop
|
|
61
|
+
Object.keys(storage.segments.segmentCache).reduce(function (prev, cur) {
|
|
62
|
+
prev[cur] = (0, sets_1.setToArray)(storage.segments.segmentCache[cur]);
|
|
63
|
+
return prev;
|
|
64
|
+
}, {}),
|
|
65
|
+
mySegmentsData: userKeys ?
|
|
66
|
+
userKeys.reduce(function (prev, userKey) {
|
|
67
|
+
// @ts-ignore accessing private prop
|
|
68
|
+
prev[userKey] = storage.shared ?
|
|
69
|
+
// Client-side segments
|
|
70
|
+
// @ts-ignore accessing private prop
|
|
71
|
+
Object.keys(storage.shared(userKey).segments.segmentCache) :
|
|
72
|
+
// Server-side segments
|
|
73
|
+
// @ts-ignore accessing private prop
|
|
74
|
+
Object.keys(storage.segments.segmentCache).reduce(function (prev, segmentName) {
|
|
75
|
+
return storage.segments.segmentCache[segmentName].has(userKey) ?
|
|
76
|
+
prev.concat(segmentName) :
|
|
77
|
+
prev;
|
|
78
|
+
}, []);
|
|
79
|
+
return prev;
|
|
80
|
+
}, {}) :
|
|
81
|
+
undefined
|
|
49
82
|
};
|
|
50
83
|
}
|
|
51
|
-
exports.
|
|
84
|
+
exports.getSnapshot = getSnapshot;
|
|
@@ -186,14 +186,6 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
|
|
|
186
186
|
return true;
|
|
187
187
|
}
|
|
188
188
|
};
|
|
189
|
-
/**
|
|
190
|
-
* Check if the splits information is already stored in browser LocalStorage.
|
|
191
|
-
* In this function we could add more code to check if the data is valid.
|
|
192
|
-
* @override
|
|
193
|
-
*/
|
|
194
|
-
SplitsCacheInLocal.prototype.checkCache = function () {
|
|
195
|
-
return this.getChangeNumber() > -1;
|
|
196
|
-
};
|
|
197
189
|
/**
|
|
198
190
|
* Clean Splits cache if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
|
|
199
191
|
*
|
|
@@ -216,7 +208,7 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
|
|
|
216
208
|
// mark cache to update the new query filter on first successful splits fetch
|
|
217
209
|
this.updateNewFilter = true;
|
|
218
210
|
// if there is cache, clear it
|
|
219
|
-
if (this.
|
|
211
|
+
if (this.getChangeNumber() > -1)
|
|
220
212
|
this.clear();
|
|
221
213
|
}
|
|
222
214
|
catch (e) {
|
|
@@ -30,13 +30,16 @@ function InLocalStorage(options) {
|
|
|
30
30
|
params.settings.log.warn(constants_1.LOG_PREFIX + 'LocalStorage API is unavailable. Falling back to default MEMORY storage');
|
|
31
31
|
return (0, InMemoryStorageCS_1.InMemoryStorageCSFactory)(params);
|
|
32
32
|
}
|
|
33
|
-
var settings = params.settings, _a = params.settings, log = _a.log, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__splitFiltersValidation;
|
|
33
|
+
var onReadyFromCacheCb = params.onReadyFromCacheCb, settings = params.settings, _a = params.settings, log = _a.log, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__splitFiltersValidation;
|
|
34
34
|
var matchingKey = (0, key_1.getMatching)(settings.core.key);
|
|
35
35
|
var keys = new KeyBuilderCS_1.KeyBuilderCS(prefix, matchingKey);
|
|
36
36
|
var expirationTimestamp = Date.now() - browser_1.DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
|
|
37
37
|
var splits = new SplitsCacheInLocal_1.SplitsCacheInLocal(settings, keys, expirationTimestamp);
|
|
38
38
|
var segments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, keys);
|
|
39
39
|
var largeSegments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, (0, KeyBuilderCS_1.myLargeSegmentsKeyBuilder)(prefix, matchingKey));
|
|
40
|
+
if (settings.mode === constants_2.LOCALHOST_MODE || splits.getChangeNumber() > -1) {
|
|
41
|
+
Promise.resolve().then(onReadyFromCacheCb);
|
|
42
|
+
}
|
|
40
43
|
return {
|
|
41
44
|
splits: splits,
|
|
42
45
|
segments: segments,
|
|
@@ -9,13 +9,15 @@ var ImpressionCountsCacheInMemory_1 = require("./ImpressionCountsCacheInMemory")
|
|
|
9
9
|
var constants_1 = require("../../utils/constants");
|
|
10
10
|
var TelemetryCacheInMemory_1 = require("./TelemetryCacheInMemory");
|
|
11
11
|
var UniqueKeysCacheInMemoryCS_1 = require("./UniqueKeysCacheInMemoryCS");
|
|
12
|
+
var key_1 = require("../../utils/key");
|
|
13
|
+
var dataLoader_1 = require("../dataLoader");
|
|
12
14
|
/**
|
|
13
15
|
* InMemory storage factory for standalone client-side SplitFactory
|
|
14
16
|
*
|
|
15
17
|
* @param params parameters required by EventsCacheSync
|
|
16
18
|
*/
|
|
17
19
|
function InMemoryStorageCSFactory(params) {
|
|
18
|
-
var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__splitFiltersValidation;
|
|
20
|
+
var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__splitFiltersValidation, preloadedData = _a.preloadedData, onReadyFromCacheCb = params.onReadyFromCacheCb;
|
|
19
21
|
var splits = new SplitsCacheInMemory_1.SplitsCacheInMemory(__splitFiltersValidation);
|
|
20
22
|
var segments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();
|
|
21
23
|
var largeSegments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();
|
|
@@ -39,11 +41,16 @@ function InMemoryStorageCSFactory(params) {
|
|
|
39
41
|
this.uniqueKeys && this.uniqueKeys.clear();
|
|
40
42
|
},
|
|
41
43
|
// When using shared instanciation with MEMORY we reuse everything but segments (they are unique per key)
|
|
42
|
-
shared: function () {
|
|
44
|
+
shared: function (matchingKey) {
|
|
45
|
+
var segments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();
|
|
46
|
+
var largeSegments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();
|
|
47
|
+
if (preloadedData) {
|
|
48
|
+
(0, dataLoader_1.loadData)(preloadedData, { segments: segments, largeSegments: largeSegments }, matchingKey);
|
|
49
|
+
}
|
|
43
50
|
return {
|
|
44
51
|
splits: this.splits,
|
|
45
|
-
segments:
|
|
46
|
-
largeSegments:
|
|
52
|
+
segments: segments,
|
|
53
|
+
largeSegments: largeSegments,
|
|
47
54
|
impressions: this.impressions,
|
|
48
55
|
impressionCounts: this.impressionCounts,
|
|
49
56
|
events: this.events,
|
|
@@ -68,6 +75,11 @@ function InMemoryStorageCSFactory(params) {
|
|
|
68
75
|
if (storage.uniqueKeys)
|
|
69
76
|
storage.uniqueKeys.track = noopTrack;
|
|
70
77
|
}
|
|
78
|
+
if (preloadedData) {
|
|
79
|
+
(0, dataLoader_1.loadData)(preloadedData, storage, (0, key_1.getMatching)(params.settings.core.key));
|
|
80
|
+
if (splits.getChangeNumber() > -1)
|
|
81
|
+
onReadyFromCacheCb();
|
|
82
|
+
}
|
|
71
83
|
return storage;
|
|
72
84
|
}
|
|
73
85
|
exports.InMemoryStorageCSFactory = InMemoryStorageCSFactory;
|
|
@@ -46,13 +46,8 @@ function fromObjectUpdaterFactory(splitsParser, storage, readiness, settings) {
|
|
|
46
46
|
readiness.splits.emit(constants_2.SDK_SPLITS_ARRIVED);
|
|
47
47
|
if (startingUp) {
|
|
48
48
|
startingUp = false;
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
if (cacheReady)
|
|
52
|
-
readiness.splits.emit(constants_2.SDK_SPLITS_CACHE_LOADED);
|
|
53
|
-
// Emits SDK_READY
|
|
54
|
-
readiness.segments.emit(constants_2.SDK_SEGMENTS_ARRIVED);
|
|
55
|
-
});
|
|
49
|
+
// Emits SDK_READY
|
|
50
|
+
readiness.segments.emit(constants_2.SDK_SEGMENTS_ARRIVED);
|
|
56
51
|
}
|
|
57
52
|
return true;
|
|
58
53
|
});
|
|
@@ -126,7 +126,7 @@ function splitChangesUpdaterFactory(log, splitChangesFetcher, splits, segments,
|
|
|
126
126
|
function _splitChangesUpdater(since, retry) {
|
|
127
127
|
if (retry === void 0) { retry = 0; }
|
|
128
128
|
log.debug(constants_2.SYNC_SPLITS_FETCH, [since]);
|
|
129
|
-
|
|
129
|
+
return Promise.resolve(splitUpdateNotification ?
|
|
130
130
|
{ splits: [splitUpdateNotification.payload], till: splitUpdateNotification.changeNumber } :
|
|
131
131
|
splitChangesFetcher(since, noCache, till, _promiseDecorator))
|
|
132
132
|
.then(function (splitChanges) {
|
|
@@ -170,15 +170,6 @@ function splitChangesUpdaterFactory(log, splitChangesFetcher, splits, segments,
|
|
|
170
170
|
}
|
|
171
171
|
return false;
|
|
172
172
|
});
|
|
173
|
-
// After triggering the requests, if we have cached splits information let's notify that to emit SDK_READY_FROM_CACHE.
|
|
174
|
-
// Wrapping in a promise since checkCache can be async.
|
|
175
|
-
if (splitsEventEmitter && startingUp) {
|
|
176
|
-
Promise.resolve(splits.checkCache()).then(function (isCacheReady) {
|
|
177
|
-
if (isCacheReady)
|
|
178
|
-
splitsEventEmitter.emit(constants_1.SDK_SPLITS_CACHE_LOADED);
|
|
179
|
-
});
|
|
180
|
-
}
|
|
181
|
-
return fetcherPromise;
|
|
182
173
|
}
|
|
183
174
|
var sincePromise = Promise.resolve(splits.getChangeNumber()); // `getChangeNumber` never rejects or throws error
|
|
184
175
|
return sincePromise.then(_splitChangesUpdater);
|
|
@@ -1,16 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.validateStorageCS =
|
|
3
|
+
exports.validateStorageCS = void 0;
|
|
4
4
|
var InMemoryStorageCS_1 = require("../../../storages/inMemory/InMemoryStorageCS");
|
|
5
5
|
var constants_1 = require("../../../logger/constants");
|
|
6
6
|
var constants_2 = require("../../../utils/constants");
|
|
7
|
-
function __InLocalStorageMockFactory(params) {
|
|
8
|
-
var result = (0, InMemoryStorageCS_1.InMemoryStorageCSFactory)(params);
|
|
9
|
-
result.splits.checkCache = function () { return true; }; // to emit SDK_READY_FROM_CACHE
|
|
10
|
-
return result;
|
|
11
|
-
}
|
|
12
|
-
exports.__InLocalStorageMockFactory = __InLocalStorageMockFactory;
|
|
13
|
-
__InLocalStorageMockFactory.type = constants_2.STORAGE_MEMORY;
|
|
14
7
|
/**
|
|
15
8
|
* This function validates `settings.storage` object
|
|
16
9
|
*
|
|
@@ -27,10 +20,6 @@ function validateStorageCS(settings) {
|
|
|
27
20
|
storage = InMemoryStorageCS_1.InMemoryStorageCSFactory;
|
|
28
21
|
log.error(constants_1.ERROR_STORAGE_INVALID);
|
|
29
22
|
}
|
|
30
|
-
// In localhost mode with InLocalStorage, fallback to a mock InLocalStorage to emit SDK_READY_FROM_CACHE
|
|
31
|
-
if (mode === constants_2.LOCALHOST_MODE && storage.type === constants_2.STORAGE_LOCALSTORAGE) {
|
|
32
|
-
return __InLocalStorageMockFactory;
|
|
33
|
-
}
|
|
34
23
|
if ([constants_2.LOCALHOST_MODE, constants_2.STANDALONE_MODE].indexOf(mode) === -1) {
|
|
35
24
|
// Consumer modes require an async storage
|
|
36
25
|
if (storage.type !== constants_2.STORAGE_PLUGGABLE)
|
|
@@ -50,11 +50,11 @@ export function sdkClientFactory(params, isSharedClient) {
|
|
|
50
50
|
// Stop background jobs
|
|
51
51
|
syncManager && syncManager.stop();
|
|
52
52
|
return __flush().then(function () {
|
|
53
|
-
//
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
53
|
+
// For main client, cleanup event listeners and scheduled jobs
|
|
54
|
+
if (!isSharedClient) {
|
|
55
|
+
signalListener && signalListener.stop();
|
|
56
|
+
uniqueKeysTracker && uniqueKeysTracker.stop();
|
|
57
|
+
}
|
|
58
58
|
// Cleanup storage
|
|
59
59
|
return storage.destroy();
|
|
60
60
|
});
|
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
import { sdkClientFactory } from './sdkClient';
|
|
2
2
|
import { RETRIEVE_CLIENT_DEFAULT } from '../logger/constants';
|
|
3
3
|
/**
|
|
4
|
-
* Factory of client method for server-side SDKs
|
|
4
|
+
* Factory of client method for server-side SDKs
|
|
5
5
|
*/
|
|
6
6
|
export function sdkClientMethodFactory(params) {
|
|
7
7
|
var log = params.settings.log;
|
|
8
8
|
var clientInstance = sdkClientFactory(params);
|
|
9
|
+
// Only one client in server-side without bound key
|
|
10
|
+
params.clients[''] = clientInstance;
|
|
9
11
|
return function client() {
|
|
10
12
|
if (arguments.length > 0) {
|
|
11
13
|
throw new Error('Shared Client not supported by the storage mechanism. Create isolated instances instead.');
|
|
@@ -5,22 +5,18 @@ import { sdkClientFactory } from './sdkClient';
|
|
|
5
5
|
import { objectAssign } from '../utils/lang/objectAssign';
|
|
6
6
|
import { RETRIEVE_CLIENT_DEFAULT, NEW_SHARED_CLIENT, RETRIEVE_CLIENT_EXISTING, LOG_PREFIX_CLIENT_INSTANTIATION } from '../logger/constants';
|
|
7
7
|
import { SDK_SEGMENTS_ARRIVED } from '../readiness/constants';
|
|
8
|
-
|
|
9
|
-
// @ts-ignore
|
|
10
|
-
return (key.matchingKey ? key.matchingKey : key) + "-" + (key.bucketingKey ? key.bucketingKey : key) + "-";
|
|
11
|
-
}
|
|
8
|
+
import { buildInstanceId } from './identity';
|
|
12
9
|
/**
|
|
13
10
|
* Factory of client method for the client-side API variant where TT is ignored.
|
|
14
11
|
* Therefore, clients don't have a bound TT for the track method.
|
|
15
12
|
*/
|
|
16
13
|
export function sdkClientMethodCSFactory(params) {
|
|
17
|
-
var storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, key = _a.core.key, log = _a.log;
|
|
14
|
+
var clients = params.clients, storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, key = _a.core.key, log = _a.log;
|
|
18
15
|
var mainClientInstance = clientCSDecorator(log, sdkClientFactory(params), key);
|
|
19
16
|
var parsedDefaultKey = keyParser(key);
|
|
20
17
|
var defaultInstanceId = buildInstanceId(parsedDefaultKey);
|
|
21
18
|
// Cache instances created per factory.
|
|
22
|
-
|
|
23
|
-
clientInstances[defaultInstanceId] = mainClientInstance;
|
|
19
|
+
clients[defaultInstanceId] = mainClientInstance;
|
|
24
20
|
return function client(key) {
|
|
25
21
|
if (key === undefined) {
|
|
26
22
|
log.debug(RETRIEVE_CLIENT_DEFAULT);
|
|
@@ -32,7 +28,7 @@ export function sdkClientMethodCSFactory(params) {
|
|
|
32
28
|
throw new Error('Shared Client needs a valid key.');
|
|
33
29
|
}
|
|
34
30
|
var instanceId = buildInstanceId(validKey);
|
|
35
|
-
if (!
|
|
31
|
+
if (!clients[instanceId]) {
|
|
36
32
|
var matchingKey = getMatching(validKey);
|
|
37
33
|
var sharedSdkReadiness_1 = sdkReadinessManager.shared();
|
|
38
34
|
var sharedStorage = storage.shared && storage.shared(matchingKey, function (err) {
|
|
@@ -51,11 +47,10 @@ export function sdkClientMethodCSFactory(params) {
|
|
|
51
47
|
var sharedSyncManager = syncManager && sharedStorage && syncManager.shared(matchingKey, sharedSdkReadiness_1.readinessManager, sharedStorage);
|
|
52
48
|
// As shared clients reuse all the storage information, we don't need to check here if we
|
|
53
49
|
// will use offline or online mode. We should stick with the original decision.
|
|
54
|
-
|
|
50
|
+
clients[instanceId] = clientCSDecorator(log, sdkClientFactory(objectAssign({}, params, {
|
|
55
51
|
sdkReadinessManager: sharedSdkReadiness_1,
|
|
56
52
|
storage: sharedStorage || storage,
|
|
57
53
|
syncManager: sharedSyncManager,
|
|
58
|
-
signalListener: undefined, // only the main client "destroy" method stops the signal listener
|
|
59
54
|
}), true), validKey);
|
|
60
55
|
sharedSyncManager && sharedSyncManager.start();
|
|
61
56
|
log.info(NEW_SHARED_CLIENT);
|
|
@@ -63,6 +58,6 @@ export function sdkClientMethodCSFactory(params) {
|
|
|
63
58
|
else {
|
|
64
59
|
log.debug(RETRIEVE_CLIENT_EXISTING);
|
|
65
60
|
}
|
|
66
|
-
return
|
|
61
|
+
return clients[instanceId];
|
|
67
62
|
};
|
|
68
63
|
}
|