@splitsoftware/splitio-commons 1.17.1-rc.1 → 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 +1 -0
- package/cjs/sdkFactory/index.js +3 -1
- 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/sdkFactory/index.js +4 -2
- 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/sdkFactory/index.ts +5 -2
- 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 +9 -8
- package/src/utils/settingsValidation/storage/storageCS.ts +0 -13
- 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 +8 -8
- package/types/utils/settingsValidation/storage/storageCS.d.ts +0 -5
package/CHANGES.txt
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
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.
|
|
2
3
|
- Added `factory.destroy()` method, which invokes the `destroy` method on all SDK clients created by the factory.
|
|
3
4
|
- Added support for targeting rules based on large segments.
|
|
4
5
|
- BREAKING CHANGES:
|
package/cjs/sdkFactory/index.js
CHANGED
|
@@ -38,8 +38,10 @@ 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
|
-
// @TODO add support for dataloader: `if (params.dataLoader) params.dataLoader(storage);`
|
|
43
45
|
var clients = {};
|
|
44
46
|
var telemetryTracker = (0, telemetryTracker_1.telemetryTrackerFactory)(storage.telemetry, platform.now);
|
|
45
47
|
var integrationsManager = integrationsManagerFactory && integrationsManagerFactory({ settings: settings, storage: storage, telemetryTracker: telemetryTracker });
|
|
@@ -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)
|
package/esm/sdkFactory/index.js
CHANGED
|
@@ -5,7 +5,7 @@ import { telemetryTrackerFactory } from '../trackers/telemetryTracker';
|
|
|
5
5
|
import { validateAndTrackApiKey } from '../utils/inputValidation/apiKey';
|
|
6
6
|
import { createLoggerAPI } from '../logger/sdkLogger';
|
|
7
7
|
import { NEW_FACTORY, RETRIEVE_MANAGER } from '../logger/constants';
|
|
8
|
-
import { SDK_SPLITS_ARRIVED, SDK_SEGMENTS_ARRIVED } from '../readiness/constants';
|
|
8
|
+
import { SDK_SPLITS_ARRIVED, SDK_SEGMENTS_ARRIVED, SDK_SPLITS_CACHE_LOADED } from '../readiness/constants';
|
|
9
9
|
import { objectAssign } from '../utils/lang/objectAssign';
|
|
10
10
|
import { strategyDebugFactory } from '../trackers/strategy/strategyDebug';
|
|
11
11
|
import { strategyOptimizedFactory } from '../trackers/strategy/strategyOptimized';
|
|
@@ -35,8 +35,10 @@ export function sdkFactory(params) {
|
|
|
35
35
|
readiness.splits.emit(SDK_SPLITS_ARRIVED);
|
|
36
36
|
readiness.segments.emit(SDK_SEGMENTS_ARRIVED);
|
|
37
37
|
},
|
|
38
|
+
onReadyFromCacheCb: function () {
|
|
39
|
+
readiness.splits.emit(SDK_SPLITS_CACHE_LOADED);
|
|
40
|
+
}
|
|
38
41
|
});
|
|
39
|
-
// @TODO add support for dataloader: `if (params.dataLoader) params.dataLoader(storage);`
|
|
40
42
|
var clients = {};
|
|
41
43
|
var telemetryTracker = telemetryTrackerFactory(storage.telemetry, platform.now);
|
|
42
44
|
var integrationsManager = integrationsManagerFactory && integrationsManagerFactory({ settings: settings, storage: storage, telemetryTracker: telemetryTracker });
|
|
@@ -11,13 +11,6 @@ var AbstractSplitsCacheAsync = /** @class */ (function () {
|
|
|
11
11
|
AbstractSplitsCacheAsync.prototype.usesSegments = function () {
|
|
12
12
|
return Promise.resolve(true);
|
|
13
13
|
};
|
|
14
|
-
/**
|
|
15
|
-
* Check if the splits information is already stored in cache.
|
|
16
|
-
* Noop, just keeping the interface. This is used by client-side implementations only.
|
|
17
|
-
*/
|
|
18
|
-
AbstractSplitsCacheAsync.prototype.checkCache = function () {
|
|
19
|
-
return Promise.resolve(false);
|
|
20
|
-
};
|
|
21
14
|
/**
|
|
22
15
|
* Kill `name` split and set `defaultTreatment` and `changeNumber`.
|
|
23
16
|
* Used for SPLIT_KILL push notifications.
|
|
@@ -27,13 +27,6 @@ var AbstractSplitsCacheSync = /** @class */ (function () {
|
|
|
27
27
|
var _this = this;
|
|
28
28
|
return this.getSplitNames().map(function (key) { return _this.getSplit(key); });
|
|
29
29
|
};
|
|
30
|
-
/**
|
|
31
|
-
* Check if the splits information is already stored in cache. This data can be preloaded.
|
|
32
|
-
* It is used as condition to emit SDK_SPLITS_CACHE_LOADED, and then SDK_READY_FROM_CACHE.
|
|
33
|
-
*/
|
|
34
|
-
AbstractSplitsCacheSync.prototype.checkCache = function () {
|
|
35
|
-
return false;
|
|
36
|
-
};
|
|
37
30
|
/**
|
|
38
31
|
* Kill `name` split and set `defaultTreatment` and `changeNumber`.
|
|
39
32
|
* Used for SPLIT_KILL push notifications.
|
|
@@ -1,47 +1,79 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { setToArray } from '../utils/lang/sets';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Storage-agnostic adaptation of `loadDataIntoLocalStorage` function
|
|
4
|
+
* (https://github.com/godaddy/split-javascript-data-loader/blob/master/src/load-data.js)
|
|
4
5
|
*
|
|
5
|
-
* @param preloadedData validated data following the format proposed in https://github.com/godaddy/split-javascript-data-loader
|
|
6
|
-
*
|
|
7
|
-
* @
|
|
6
|
+
* @param preloadedData validated data following the format proposed in https://github.com/godaddy/split-javascript-data-loader and extended with a `mySegmentsData` property.
|
|
7
|
+
* @param storage object containing `splits` and `segments` cache (client-side variant)
|
|
8
|
+
* @param userKey user key (matching key) of the provided MySegmentsCache
|
|
9
|
+
*
|
|
10
|
+
* @TODO extend to load largeSegments
|
|
11
|
+
* @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.
|
|
12
|
+
* @TODO add logs, and input validation in this module, in favor of size reduction.
|
|
13
|
+
* @TODO unit tests
|
|
8
14
|
*/
|
|
9
|
-
export function
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
* @param userId user key string of the provided MySegmentsCache
|
|
16
|
-
*
|
|
17
|
-
* @TODO extend to support SegmentsCache (server-side variant) by making `userId` optional and adding the corresponding logic.
|
|
18
|
-
* @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.
|
|
19
|
-
*/
|
|
20
|
-
return function loadData(storage, userId) {
|
|
21
|
-
// Do not load data if current preloadedData is empty
|
|
22
|
-
if (Object.keys(preloadedData).length === 0)
|
|
23
|
-
return;
|
|
24
|
-
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;
|
|
15
|
+
export function loadData(preloadedData, storage, userKey) {
|
|
16
|
+
// Do not load data if current preloadedData is empty
|
|
17
|
+
if (Object.keys(preloadedData).length === 0)
|
|
18
|
+
return;
|
|
19
|
+
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;
|
|
20
|
+
if (storage.splits) {
|
|
25
21
|
var storedSince = storage.splits.getChangeNumber();
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
// or if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
|
|
29
|
-
if (storedSince > since || lastUpdated < expirationTimestamp)
|
|
22
|
+
// Do not load data if current data is more recent
|
|
23
|
+
if (storedSince > since)
|
|
30
24
|
return;
|
|
31
25
|
// cleaning up the localStorage data, since some cached splits might need be part of the preloaded data
|
|
32
26
|
storage.splits.clear();
|
|
33
27
|
storage.splits.setChangeNumber(since);
|
|
34
28
|
// splitsData in an object where the property is the split name and the pertaining value is a stringified json of its data
|
|
35
|
-
storage.splits.addSplits(
|
|
36
|
-
|
|
37
|
-
|
|
29
|
+
storage.splits.addSplits(splitsData.map(function (split) { return ([split.name, split]); }));
|
|
30
|
+
}
|
|
31
|
+
if (userKey) { // add mySegments data (client-side)
|
|
32
|
+
var mySegmentsData = preloadedData.mySegmentsData && preloadedData.mySegmentsData[userKey];
|
|
38
33
|
if (!mySegmentsData) {
|
|
39
34
|
// 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
|
|
40
35
|
mySegmentsData = Object.keys(segmentsData).filter(function (segmentName) {
|
|
41
|
-
var
|
|
42
|
-
return
|
|
36
|
+
var userKeys = segmentsData[segmentName];
|
|
37
|
+
return userKeys.indexOf(userKey) > -1;
|
|
43
38
|
});
|
|
44
39
|
}
|
|
45
40
|
storage.segments.resetSegments({ k: mySegmentsData.map(function (s) { return ({ n: s }); }) });
|
|
41
|
+
}
|
|
42
|
+
else { // add segments data (server-side)
|
|
43
|
+
Object.keys(segmentsData).filter(function (segmentName) {
|
|
44
|
+
var userKeys = segmentsData[segmentName];
|
|
45
|
+
storage.segments.addToSegment(segmentName, userKeys);
|
|
46
|
+
});
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
export function getSnapshot(storage, userKeys) {
|
|
50
|
+
return {
|
|
51
|
+
// lastUpdated: Date.now(),
|
|
52
|
+
// @ts-ignore accessing private prop
|
|
53
|
+
since: storage.splits.changeNumber,
|
|
54
|
+
splitsData: storage.splits.getAll(),
|
|
55
|
+
segmentsData: userKeys ?
|
|
56
|
+
undefined : // @ts-ignore accessing private prop
|
|
57
|
+
Object.keys(storage.segments.segmentCache).reduce(function (prev, cur) {
|
|
58
|
+
prev[cur] = setToArray(storage.segments.segmentCache[cur]);
|
|
59
|
+
return prev;
|
|
60
|
+
}, {}),
|
|
61
|
+
mySegmentsData: userKeys ?
|
|
62
|
+
userKeys.reduce(function (prev, userKey) {
|
|
63
|
+
// @ts-ignore accessing private prop
|
|
64
|
+
prev[userKey] = storage.shared ?
|
|
65
|
+
// Client-side segments
|
|
66
|
+
// @ts-ignore accessing private prop
|
|
67
|
+
Object.keys(storage.shared(userKey).segments.segmentCache) :
|
|
68
|
+
// Server-side segments
|
|
69
|
+
// @ts-ignore accessing private prop
|
|
70
|
+
Object.keys(storage.segments.segmentCache).reduce(function (prev, segmentName) {
|
|
71
|
+
return storage.segments.segmentCache[segmentName].has(userKey) ?
|
|
72
|
+
prev.concat(segmentName) :
|
|
73
|
+
prev;
|
|
74
|
+
}, []);
|
|
75
|
+
return prev;
|
|
76
|
+
}, {}) :
|
|
77
|
+
undefined
|
|
46
78
|
};
|
|
47
79
|
}
|
|
@@ -183,14 +183,6 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
|
|
|
183
183
|
return true;
|
|
184
184
|
}
|
|
185
185
|
};
|
|
186
|
-
/**
|
|
187
|
-
* Check if the splits information is already stored in browser LocalStorage.
|
|
188
|
-
* In this function we could add more code to check if the data is valid.
|
|
189
|
-
* @override
|
|
190
|
-
*/
|
|
191
|
-
SplitsCacheInLocal.prototype.checkCache = function () {
|
|
192
|
-
return this.getChangeNumber() > -1;
|
|
193
|
-
};
|
|
194
186
|
/**
|
|
195
187
|
* Clean Splits cache if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
|
|
196
188
|
*
|
|
@@ -213,7 +205,7 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
|
|
|
213
205
|
// mark cache to update the new query filter on first successful splits fetch
|
|
214
206
|
this.updateNewFilter = true;
|
|
215
207
|
// if there is cache, clear it
|
|
216
|
-
if (this.
|
|
208
|
+
if (this.getChangeNumber() > -1)
|
|
217
209
|
this.clear();
|
|
218
210
|
}
|
|
219
211
|
catch (e) {
|
|
@@ -11,7 +11,7 @@ import { SplitsCacheInMemory } from '../inMemory/SplitsCacheInMemory';
|
|
|
11
11
|
import { DEFAULT_CACHE_EXPIRATION_IN_MILLIS } from '../../utils/constants/browser';
|
|
12
12
|
import { InMemoryStorageCSFactory } from '../inMemory/InMemoryStorageCS';
|
|
13
13
|
import { LOG_PREFIX } from './constants';
|
|
14
|
-
import { DEBUG, NONE, STORAGE_LOCALSTORAGE } from '../../utils/constants';
|
|
14
|
+
import { DEBUG, LOCALHOST_MODE, NONE, STORAGE_LOCALSTORAGE } from '../../utils/constants';
|
|
15
15
|
import { shouldRecordTelemetry, TelemetryCacheInMemory } from '../inMemory/TelemetryCacheInMemory';
|
|
16
16
|
import { UniqueKeysCacheInMemoryCS } from '../inMemory/UniqueKeysCacheInMemoryCS';
|
|
17
17
|
import { getMatching } from '../../utils/key';
|
|
@@ -27,13 +27,16 @@ export function InLocalStorage(options) {
|
|
|
27
27
|
params.settings.log.warn(LOG_PREFIX + 'LocalStorage API is unavailable. Falling back to default MEMORY storage');
|
|
28
28
|
return InMemoryStorageCSFactory(params);
|
|
29
29
|
}
|
|
30
|
-
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;
|
|
30
|
+
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;
|
|
31
31
|
var matchingKey = getMatching(settings.core.key);
|
|
32
32
|
var keys = new KeyBuilderCS(prefix, matchingKey);
|
|
33
33
|
var expirationTimestamp = Date.now() - DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
|
|
34
34
|
var splits = new SplitsCacheInLocal(settings, keys, expirationTimestamp);
|
|
35
35
|
var segments = new MySegmentsCacheInLocal(log, keys);
|
|
36
36
|
var largeSegments = new MySegmentsCacheInLocal(log, myLargeSegmentsKeyBuilder(prefix, matchingKey));
|
|
37
|
+
if (settings.mode === LOCALHOST_MODE || splits.getChangeNumber() > -1) {
|
|
38
|
+
Promise.resolve().then(onReadyFromCacheCb);
|
|
39
|
+
}
|
|
37
40
|
return {
|
|
38
41
|
splits: splits,
|
|
39
42
|
segments: segments,
|
|
@@ -6,13 +6,15 @@ import { ImpressionCountsCacheInMemory } from './ImpressionCountsCacheInMemory';
|
|
|
6
6
|
import { DEBUG, LOCALHOST_MODE, NONE, STORAGE_MEMORY } from '../../utils/constants';
|
|
7
7
|
import { shouldRecordTelemetry, TelemetryCacheInMemory } from './TelemetryCacheInMemory';
|
|
8
8
|
import { UniqueKeysCacheInMemoryCS } from './UniqueKeysCacheInMemoryCS';
|
|
9
|
+
import { getMatching } from '../../utils/key';
|
|
10
|
+
import { loadData } from '../dataLoader';
|
|
9
11
|
/**
|
|
10
12
|
* InMemory storage factory for standalone client-side SplitFactory
|
|
11
13
|
*
|
|
12
14
|
* @param params parameters required by EventsCacheSync
|
|
13
15
|
*/
|
|
14
16
|
export function InMemoryStorageCSFactory(params) {
|
|
15
|
-
var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__splitFiltersValidation;
|
|
17
|
+
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;
|
|
16
18
|
var splits = new SplitsCacheInMemory(__splitFiltersValidation);
|
|
17
19
|
var segments = new MySegmentsCacheInMemory();
|
|
18
20
|
var largeSegments = new MySegmentsCacheInMemory();
|
|
@@ -36,11 +38,16 @@ export function InMemoryStorageCSFactory(params) {
|
|
|
36
38
|
this.uniqueKeys && this.uniqueKeys.clear();
|
|
37
39
|
},
|
|
38
40
|
// When using shared instanciation with MEMORY we reuse everything but segments (they are unique per key)
|
|
39
|
-
shared: function () {
|
|
41
|
+
shared: function (matchingKey) {
|
|
42
|
+
var segments = new MySegmentsCacheInMemory();
|
|
43
|
+
var largeSegments = new MySegmentsCacheInMemory();
|
|
44
|
+
if (preloadedData) {
|
|
45
|
+
loadData(preloadedData, { segments: segments, largeSegments: largeSegments }, matchingKey);
|
|
46
|
+
}
|
|
40
47
|
return {
|
|
41
48
|
splits: this.splits,
|
|
42
|
-
segments:
|
|
43
|
-
largeSegments:
|
|
49
|
+
segments: segments,
|
|
50
|
+
largeSegments: largeSegments,
|
|
44
51
|
impressions: this.impressions,
|
|
45
52
|
impressionCounts: this.impressionCounts,
|
|
46
53
|
events: this.events,
|
|
@@ -65,6 +72,11 @@ export function InMemoryStorageCSFactory(params) {
|
|
|
65
72
|
if (storage.uniqueKeys)
|
|
66
73
|
storage.uniqueKeys.track = noopTrack;
|
|
67
74
|
}
|
|
75
|
+
if (preloadedData) {
|
|
76
|
+
loadData(preloadedData, storage, getMatching(params.settings.core.key));
|
|
77
|
+
if (splits.getChangeNumber() > -1)
|
|
78
|
+
onReadyFromCacheCb();
|
|
79
|
+
}
|
|
68
80
|
return storage;
|
|
69
81
|
}
|
|
70
82
|
InMemoryStorageCSFactory.type = STORAGE_MEMORY;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { forOwn } from '../../../utils/lang';
|
|
2
2
|
import { syncTaskFactory } from '../../syncTask';
|
|
3
3
|
import { CONTROL } from '../../../utils/constants';
|
|
4
|
-
import { SDK_SPLITS_ARRIVED, SDK_SEGMENTS_ARRIVED
|
|
4
|
+
import { SDK_SPLITS_ARRIVED, SDK_SEGMENTS_ARRIVED } from '../../../readiness/constants';
|
|
5
5
|
import { SYNC_OFFLINE_DATA, ERROR_SYNC_OFFLINE_LOADING } from '../../../logger/constants';
|
|
6
6
|
/**
|
|
7
7
|
* Offline equivalent of `splitChangesUpdaterFactory`
|
|
@@ -43,13 +43,8 @@ export function fromObjectUpdaterFactory(splitsParser, storage, readiness, setti
|
|
|
43
43
|
readiness.splits.emit(SDK_SPLITS_ARRIVED);
|
|
44
44
|
if (startingUp) {
|
|
45
45
|
startingUp = false;
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
if (cacheReady)
|
|
49
|
-
readiness.splits.emit(SDK_SPLITS_CACHE_LOADED);
|
|
50
|
-
// Emits SDK_READY
|
|
51
|
-
readiness.segments.emit(SDK_SEGMENTS_ARRIVED);
|
|
52
|
-
});
|
|
46
|
+
// Emits SDK_READY
|
|
47
|
+
readiness.segments.emit(SDK_SEGMENTS_ARRIVED);
|
|
53
48
|
}
|
|
54
49
|
return true;
|
|
55
50
|
});
|