@splitsoftware/splitio-commons 2.0.0-rc.0 → 2.0.0-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.
Files changed (114) hide show
  1. package/CHANGES.txt +5 -1
  2. package/cjs/evaluator/Engine.js +1 -1
  3. package/cjs/evaluator/index.js +1 -1
  4. package/cjs/readiness/readinessManager.js +13 -2
  5. package/cjs/sdkClient/sdkClientMethodCS.js +0 -1
  6. package/cjs/sdkFactory/index.js +29 -9
  7. package/cjs/storages/{AbstractSegmentsCacheSync.js → AbstractMySegmentsCacheSync.js} +15 -17
  8. package/cjs/storages/dataLoader.js +99 -37
  9. package/cjs/storages/inLocalStorage/MySegmentsCacheInLocal.js +5 -5
  10. package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js +3 -2
  11. package/cjs/storages/inLocalStorage/index.js +1 -1
  12. package/cjs/storages/inMemory/InMemoryStorageCS.js +18 -6
  13. package/cjs/storages/inMemory/MySegmentsCacheInMemory.js +5 -5
  14. package/cjs/storages/inMemory/SegmentsCacheInMemory.js +13 -27
  15. package/cjs/storages/inMemory/SplitsCacheInMemory.js +0 -1
  16. package/cjs/storages/inMemory/UniqueKeysCacheInMemory.js +2 -1
  17. package/cjs/storages/inMemory/UniqueKeysCacheInMemoryCS.js +2 -1
  18. package/cjs/storages/inRedis/RedisAdapter.js +2 -1
  19. package/cjs/storages/inRedis/SegmentsCacheInRedis.js +13 -19
  20. package/cjs/storages/inRedis/UniqueKeysCacheInRedis.js +2 -1
  21. package/cjs/storages/pluggable/SegmentsCachePluggable.js +11 -32
  22. package/cjs/storages/pluggable/UniqueKeysCachePluggable.js +2 -1
  23. package/cjs/storages/pluggable/inMemoryWrapper.js +2 -1
  24. package/cjs/sync/offline/syncManagerOffline.js +18 -11
  25. package/cjs/sync/polling/updaters/segmentChangesUpdater.js +12 -28
  26. package/cjs/sync/polling/updaters/splitChangesUpdater.js +2 -1
  27. package/cjs/sync/syncManagerOnline.js +20 -21
  28. package/cjs/trackers/eventTracker.js +12 -10
  29. package/cjs/trackers/impressionsTracker.js +16 -14
  30. package/cjs/trackers/uniqueKeysTracker.js +5 -3
  31. package/cjs/utils/lang/sets.js +12 -2
  32. package/esm/evaluator/Engine.js +1 -1
  33. package/esm/evaluator/index.js +2 -2
  34. package/esm/readiness/readinessManager.js +13 -2
  35. package/esm/sdkClient/sdkClientMethodCS.js +0 -1
  36. package/esm/sdkFactory/index.js +30 -10
  37. package/esm/storages/{AbstractSegmentsCacheSync.js → AbstractMySegmentsCacheSync.js} +14 -16
  38. package/esm/storages/dataLoader.js +96 -35
  39. package/esm/storages/inLocalStorage/MySegmentsCacheInLocal.js +5 -5
  40. package/esm/storages/inLocalStorage/SplitsCacheInLocal.js +3 -2
  41. package/esm/storages/inLocalStorage/index.js +1 -1
  42. package/esm/storages/inMemory/InMemoryStorageCS.js +18 -6
  43. package/esm/storages/inMemory/MySegmentsCacheInMemory.js +5 -5
  44. package/esm/storages/inMemory/SegmentsCacheInMemory.js +13 -27
  45. package/esm/storages/inMemory/SplitsCacheInMemory.js +0 -1
  46. package/esm/storages/inMemory/UniqueKeysCacheInMemory.js +2 -1
  47. package/esm/storages/inMemory/UniqueKeysCacheInMemoryCS.js +2 -1
  48. package/esm/storages/inRedis/RedisAdapter.js +2 -1
  49. package/esm/storages/inRedis/SegmentsCacheInRedis.js +13 -19
  50. package/esm/storages/inRedis/UniqueKeysCacheInRedis.js +2 -1
  51. package/esm/storages/pluggable/SegmentsCachePluggable.js +11 -32
  52. package/esm/storages/pluggable/UniqueKeysCachePluggable.js +2 -1
  53. package/esm/storages/pluggable/inMemoryWrapper.js +2 -1
  54. package/esm/sync/offline/syncManagerOffline.js +18 -11
  55. package/esm/sync/polling/updaters/segmentChangesUpdater.js +12 -28
  56. package/esm/sync/polling/updaters/splitChangesUpdater.js +2 -1
  57. package/esm/sync/syncManagerOnline.js +20 -21
  58. package/esm/trackers/eventTracker.js +12 -10
  59. package/esm/trackers/impressionsTracker.js +16 -14
  60. package/esm/trackers/uniqueKeysTracker.js +5 -3
  61. package/esm/utils/lang/sets.js +10 -1
  62. package/package.json +1 -1
  63. package/src/evaluator/Engine.ts +1 -1
  64. package/src/evaluator/index.ts +2 -2
  65. package/src/readiness/readinessManager.ts +12 -3
  66. package/src/readiness/types.ts +3 -0
  67. package/src/sdkClient/sdkClientMethodCS.ts +0 -2
  68. package/src/sdkFactory/index.ts +34 -12
  69. package/src/sdkFactory/types.ts +2 -0
  70. package/src/storages/{AbstractSegmentsCacheSync.ts → AbstractMySegmentsCacheSync.ts} +13 -28
  71. package/src/storages/dataLoader.ts +97 -38
  72. package/src/storages/inLocalStorage/MySegmentsCacheInLocal.ts +5 -5
  73. package/src/storages/inLocalStorage/SplitsCacheInLocal.ts +3 -2
  74. package/src/storages/inLocalStorage/index.ts +1 -1
  75. package/src/storages/inMemory/InMemoryStorageCS.ts +21 -6
  76. package/src/storages/inMemory/MySegmentsCacheInMemory.ts +5 -5
  77. package/src/storages/inMemory/SegmentsCacheInMemory.ts +12 -26
  78. package/src/storages/inMemory/SplitsCacheInMemory.ts +0 -1
  79. package/src/storages/inMemory/UniqueKeysCacheInMemory.ts +2 -1
  80. package/src/storages/inMemory/UniqueKeysCacheInMemoryCS.ts +2 -1
  81. package/src/storages/inRedis/RedisAdapter.ts +2 -1
  82. package/src/storages/inRedis/SegmentsCacheInRedis.ts +13 -22
  83. package/src/storages/inRedis/UniqueKeysCacheInRedis.ts +2 -1
  84. package/src/storages/pluggable/SegmentsCachePluggable.ts +11 -35
  85. package/src/storages/pluggable/UniqueKeysCachePluggable.ts +2 -1
  86. package/src/storages/pluggable/inMemoryWrapper.ts +2 -1
  87. package/src/storages/types.ts +7 -11
  88. package/src/sync/offline/syncManagerOffline.ts +21 -13
  89. package/src/sync/polling/updaters/segmentChangesUpdater.ts +13 -29
  90. package/src/sync/polling/updaters/splitChangesUpdater.ts +2 -1
  91. package/src/sync/syncManagerOnline.ts +17 -17
  92. package/src/sync/types.ts +1 -1
  93. package/src/trackers/eventTracker.ts +11 -8
  94. package/src/trackers/impressionsTracker.ts +13 -10
  95. package/src/trackers/types.ts +1 -0
  96. package/src/trackers/uniqueKeysTracker.ts +6 -4
  97. package/src/types.ts +14 -13
  98. package/src/utils/lang/sets.ts +11 -1
  99. package/types/readiness/types.d.ts +3 -0
  100. package/types/sdkFactory/types.d.ts +1 -0
  101. package/types/storages/dataLoader.d.ts +17 -6
  102. package/types/storages/inLocalStorage/MySegmentsCacheInLocal.d.ts +5 -5
  103. package/types/storages/inMemory/MySegmentsCacheInMemory.d.ts +5 -5
  104. package/types/storages/inMemory/SegmentsCacheInMemory.d.ts +5 -7
  105. package/types/storages/inMemory/SplitsCacheInMemory.d.ts +0 -1
  106. package/types/storages/inRedis/SegmentsCacheInRedis.d.ts +6 -3
  107. package/types/storages/pluggable/SegmentsCachePluggable.d.ts +4 -16
  108. package/types/storages/types.d.ts +7 -10
  109. package/types/sync/types.d.ts +1 -1
  110. package/types/trackers/eventTracker.d.ts +1 -1
  111. package/types/trackers/impressionsTracker.d.ts +1 -1
  112. package/types/trackers/types.d.ts +1 -0
  113. package/types/types.d.ts +13 -13
  114. package/types/utils/lang/sets.d.ts +1 -0
@@ -1,5 +1,3 @@
1
- /* eslint-disable @typescript-eslint/no-unused-vars */
2
- /* eslint-disable no-unused-vars */
3
1
  import { IMySegmentsResponse } from '../dtos/types';
4
2
  import { MySegmentsData } from '../sync/polling/types';
5
3
  import { ISegmentsCacheSync } from './types';
@@ -8,18 +6,11 @@ import { ISegmentsCacheSync } from './types';
8
6
  * This class provides a skeletal implementation of the ISegmentsCacheSync interface
9
7
  * to minimize the effort required to implement this interface.
10
8
  */
11
- export abstract class AbstractSegmentsCacheSync implements ISegmentsCacheSync {
12
- /**
13
- * For server-side synchronizer: add `segmentKeys` list of keys to `name` segment.
14
- * For client-side synchronizer: add `name` segment to the cache. `segmentKeys` is undefined.
15
- */
16
- abstract addToSegment(name: string, segmentKeys?: string[]): boolean
9
+ export abstract class AbstractMySegmentsCacheSync implements ISegmentsCacheSync {
17
10
 
18
- /**
19
- * For server-side synchronizer: remove `segmentKeys` list of keys from `name` segment.
20
- * For client-side synchronizer: remove `name` segment from the cache. `segmentKeys` is undefined.
21
- */
22
- abstract removeFromSegment(name: string, segmentKeys?: string[]): boolean
11
+ protected abstract addSegment(name: string): boolean
12
+ protected abstract removeSegment(name: string): boolean
13
+ protected abstract setChangeNumber(changeNumber?: number): boolean | void
23
14
 
24
15
  /**
25
16
  * For server-side synchronizer: check if `key` is in `name` segment.
@@ -34,11 +25,10 @@ export abstract class AbstractSegmentsCacheSync implements ISegmentsCacheSync {
34
25
  this.resetSegments({});
35
26
  }
36
27
 
37
- /**
38
- * For server-side synchronizer: add the given list of segments to the cache, with an empty list of keys. The segments that already exist are not modified.
39
- * For client-side synchronizer: the method is not used.
40
- */
41
- registerSegments(names: string[]): boolean { return false; }
28
+
29
+ // No-op. Not used in client-side.
30
+ registerSegments(): boolean { return false; }
31
+ update() { return false; }
42
32
 
43
33
  /**
44
34
  * For server-side synchronizer: get the list of segments to fetch changes.
@@ -52,11 +42,6 @@ export abstract class AbstractSegmentsCacheSync implements ISegmentsCacheSync {
52
42
  */
53
43
  abstract getKeysCount(): number
54
44
 
55
- /**
56
- * For server-side synchronizer: change number of `name` segment.
57
- * For client-side synchronizer: change number of mySegments.
58
- */
59
- abstract setChangeNumber(name?: string, changeNumber?: number): boolean | void
60
45
  abstract getChangeNumber(name: string): number
61
46
 
62
47
  /**
@@ -64,7 +49,7 @@ export abstract class AbstractSegmentsCacheSync implements ISegmentsCacheSync {
64
49
  * For client-side synchronizer: it resets or updates the cache.
65
50
  */
66
51
  resetSegments(segmentsData: MySegmentsData | IMySegmentsResponse): boolean {
67
- this.setChangeNumber(undefined, segmentsData.cn);
52
+ this.setChangeNumber(segmentsData.cn);
68
53
 
69
54
  const { added, removed } = segmentsData as MySegmentsData;
70
55
 
@@ -72,11 +57,11 @@ export abstract class AbstractSegmentsCacheSync implements ISegmentsCacheSync {
72
57
  let isDiff = false;
73
58
 
74
59
  added.forEach(segment => {
75
- isDiff = this.addToSegment(segment) || isDiff;
60
+ isDiff = this.addSegment(segment) || isDiff;
76
61
  });
77
62
 
78
63
  removed.forEach(segment => {
79
- isDiff = this.removeFromSegment(segment) || isDiff;
64
+ isDiff = this.removeSegment(segment) || isDiff;
80
65
  });
81
66
 
82
67
  return isDiff;
@@ -97,11 +82,11 @@ export abstract class AbstractSegmentsCacheSync implements ISegmentsCacheSync {
97
82
 
98
83
  // Slowest path => add and/or remove segments
99
84
  for (let removeIndex = index; removeIndex < storedSegmentKeys.length; removeIndex++) {
100
- this.removeFromSegment(storedSegmentKeys[removeIndex]);
85
+ this.removeSegment(storedSegmentKeys[removeIndex]);
101
86
  }
102
87
 
103
88
  for (let addIndex = index; addIndex < names.length; addIndex++) {
104
- this.addToSegment(names[addIndex]);
89
+ this.addSegment(names[addIndex]);
105
90
  }
106
91
 
107
92
  return true;
@@ -1,55 +1,114 @@
1
1
  import { SplitIO } from '../types';
2
- import { DEFAULT_CACHE_EXPIRATION_IN_MILLIS } from '../utils/constants/browser';
3
- import { DataLoader, ISegmentsCacheSync, ISplitsCacheSync } from './types';
2
+ import { ISegmentsCacheSync, ISplitsCacheSync, IStorageSync } from './types';
3
+ import { setToArray } from '../utils/lang/sets';
4
+ import { getMatching } from '../utils/key';
5
+ import { IMembershipsResponse, IMySegmentsResponse } from '../dtos/types';
4
6
 
5
7
  /**
6
- * Factory of client-side storage loader
8
+ * Storage-agnostic adaptation of `loadDataIntoLocalStorage` function
9
+ * (https://github.com/godaddy/split-javascript-data-loader/blob/master/src/load-data.js)
7
10
  *
8
- * @param preloadedData validated data following the format proposed in https://github.com/godaddy/split-javascript-data-loader
9
- * and extended with a `mySegmentsData` property.
10
- * @returns function to preload the storage
11
+ * @param preloadedData validated data following the format proposed in https://github.com/godaddy/split-javascript-data-loader and extended with a `mySegmentsData` property.
12
+ * @param storage object containing `splits` and `segments` cache (client-side variant)
13
+ * @param userKey user key (matching key) of the provided MySegmentsCache
14
+ *
15
+ * @TODO extend to load largeSegments
16
+ * @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.
17
+ * @TODO add logs, and input validation in this module, in favor of size reduction.
18
+ * @TODO unit tests
11
19
  */
12
- export function dataLoaderFactory(preloadedData: SplitIO.PreloadedData): DataLoader {
13
-
14
- /**
15
- * Storage-agnostic adaptation of `loadDataIntoLocalStorage` function
16
- * (https://github.com/godaddy/split-javascript-data-loader/blob/master/src/load-data.js)
17
- *
18
- * @param storage object containing `splits` and `segments` cache (client-side variant)
19
- * @param userId user key string of the provided MySegmentsCache
20
- *
21
- * @TODO extend to support SegmentsCache (server-side variant) by making `userId` optional and adding the corresponding logic.
22
- * @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.
23
- */
24
- return function loadData(storage: { splits: ISplitsCacheSync, segments: ISegmentsCacheSync }, userId: string) {
25
- // Do not load data if current preloadedData is empty
26
- if (Object.keys(preloadedData).length === 0) return;
27
-
28
- const { lastUpdated = -1, segmentsData = {}, since = -1, splitsData = {} } = preloadedData;
20
+ export function loadData(preloadedData: SplitIO.PreloadedData, storage: { splits?: ISplitsCacheSync, segments: ISegmentsCacheSync, largeSegments?: ISegmentsCacheSync }, matchingKey?: string) {
21
+ // Do not load data if current preloadedData is empty
22
+ if (Object.keys(preloadedData).length === 0) return;
23
+
24
+ const { segmentsData = {}, since = -1, splitsData = [] } = preloadedData;
29
25
 
26
+ if (storage.splits) {
30
27
  const storedSince = storage.splits.getChangeNumber();
31
- const expirationTimestamp = Date.now() - DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
32
28
 
33
- // Do not load data if current localStorage data is more recent,
34
- // or if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
35
- if (storedSince > since || lastUpdated < expirationTimestamp) return;
29
+ // Do not load data if current data is more recent
30
+ if (storedSince > since) return;
36
31
 
37
32
  // cleaning up the localStorage data, since some cached splits might need be part of the preloaded data
38
33
  storage.splits.clear();
39
34
  storage.splits.setChangeNumber(since);
40
35
 
41
36
  // splitsData in an object where the property is the split name and the pertaining value is a stringified json of its data
42
- storage.splits.addSplits(Object.keys(splitsData).map(splitName => JSON.parse(splitsData[splitName])));
43
-
44
- // add mySegments data
45
- let mySegmentsData = preloadedData.mySegmentsData && preloadedData.mySegmentsData[userId];
46
- if (!mySegmentsData) {
47
- // 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
48
- mySegmentsData = Object.keys(segmentsData).filter(segmentName => {
49
- const userIds = JSON.parse(segmentsData[segmentName]).added;
50
- return Array.isArray(userIds) && userIds.indexOf(userId) > -1;
51
- });
37
+ storage.splits.addSplits(splitsData.map(split => ([split.name, split])));
38
+ }
39
+
40
+ if (matchingKey) { // add mySegments data (client-side)
41
+ let membershipsData = preloadedData.membershipsData && preloadedData.membershipsData[matchingKey];
42
+ if (!membershipsData && segmentsData) {
43
+ membershipsData = {
44
+ ms: {
45
+ k: Object.keys(segmentsData).filter(segmentName => {
46
+ const segmentKeys = segmentsData[segmentName];
47
+ return segmentKeys.indexOf(matchingKey) > -1;
48
+ }).map(segmentName => ({ n: segmentName }))
49
+ }
50
+ };
51
+ }
52
+ if (membershipsData) {
53
+ if (membershipsData.ms) storage.segments.resetSegments(membershipsData.ms);
54
+ if (membershipsData.ls && storage.largeSegments) storage.largeSegments.resetSegments(membershipsData.ls);
52
55
  }
53
- storage.segments.resetSegments({ k: mySegmentsData.map(s => ({ n: s })) });
56
+
57
+ } else { // add segments data (server-side)
58
+ Object.keys(segmentsData).forEach(segmentName => {
59
+ const segmentKeys = segmentsData[segmentName];
60
+ storage.segments.update(segmentName, segmentKeys, [], -1);
61
+ });
62
+ }
63
+ }
64
+
65
+ export function getSnapshot(storage: IStorageSync, userKeys?: SplitIO.SplitKey[]): SplitIO.PreloadedData {
66
+ return {
67
+ // lastUpdated: Date.now(),
68
+ since: storage.splits.getChangeNumber(),
69
+ splitsData: storage.splits.getAll(),
70
+ segmentsData: userKeys ?
71
+ undefined : // @ts-ignore accessing private prop
72
+ Object.keys(storage.segments.segmentCache).reduce((prev, cur) => { // @ts-ignore accessing private prop
73
+ prev[cur] = setToArray(storage.segments.segmentCache[cur] as Set<string>);
74
+ return prev;
75
+ }, {}),
76
+ membershipsData: userKeys ?
77
+ userKeys.reduce<Record<string, IMembershipsResponse>>((prev, userKey) => {
78
+ if (storage.shared) {
79
+ // Client-side segments
80
+ // @ts-ignore accessing private prop
81
+ const sharedStorage = storage.shared(userKey);
82
+ prev[getMatching(userKey)] = {
83
+ ms: {
84
+ // @ts-ignore accessing private prop
85
+ k: Object.keys(sharedStorage.segments.segmentCache).map(segmentName => ({ n: segmentName })),
86
+ // cn: sharedStorage.segments.getChangeNumber()
87
+ },
88
+ ls: sharedStorage.largeSegments ? {
89
+ // @ts-ignore accessing private prop
90
+ k: Object.keys(sharedStorage.largeSegments.segmentCache).map(segmentName => ({ n: segmentName })),
91
+ // cn: sharedStorage.largeSegments.getChangeNumber()
92
+ } : undefined
93
+ };
94
+ } else {
95
+ prev[getMatching(userKey)] = {
96
+ ms: {
97
+ // Server-side segments
98
+ // @ts-ignore accessing private prop
99
+ k: Object.keys(storage.segments.segmentCache).reduce<IMySegmentsResponse['k']>((prev, segmentName) => { // @ts-ignore accessing private prop
100
+ return storage.segments.segmentCache[segmentName].has(userKey) ?
101
+ prev!.concat({ n: segmentName }) :
102
+ prev;
103
+ }, [])
104
+ },
105
+ ls: {
106
+ k: []
107
+ }
108
+ };
109
+ }
110
+ return prev;
111
+ }, {}) :
112
+ undefined
54
113
  };
55
114
  }
@@ -1,10 +1,10 @@
1
1
  import { ILogger } from '../../logger/types';
2
2
  import { isNaNNumber } from '../../utils/lang';
3
- import { AbstractSegmentsCacheSync } from '../AbstractSegmentsCacheSync';
3
+ import { AbstractMySegmentsCacheSync } from '../AbstractMySegmentsCacheSync';
4
4
  import type { MySegmentsKeyBuilder } from '../KeyBuilderCS';
5
5
  import { LOG_PREFIX, DEFINED } from './constants';
6
6
 
7
- export class MySegmentsCacheInLocal extends AbstractSegmentsCacheSync {
7
+ export class MySegmentsCacheInLocal extends AbstractMySegmentsCacheSync {
8
8
 
9
9
  private readonly keys: MySegmentsKeyBuilder;
10
10
  private readonly log: ILogger;
@@ -16,7 +16,7 @@ export class MySegmentsCacheInLocal extends AbstractSegmentsCacheSync {
16
16
  // There is not need to flush segments cache like splits cache, since resetSegments receives the up-to-date list of active segments
17
17
  }
18
18
 
19
- addToSegment(name: string): boolean {
19
+ protected addSegment(name: string): boolean {
20
20
  const segmentKey = this.keys.buildSegmentNameKey(name);
21
21
 
22
22
  try {
@@ -29,7 +29,7 @@ export class MySegmentsCacheInLocal extends AbstractSegmentsCacheSync {
29
29
  }
30
30
  }
31
31
 
32
- removeFromSegment(name: string): boolean {
32
+ protected removeSegment(name: string): boolean {
33
33
  const segmentKey = this.keys.buildSegmentNameKey(name);
34
34
 
35
35
  try {
@@ -61,7 +61,7 @@ export class MySegmentsCacheInLocal extends AbstractSegmentsCacheSync {
61
61
  return 1;
62
62
  }
63
63
 
64
- setChangeNumber(name?: string, changeNumber?: number) {
64
+ protected setChangeNumber(changeNumber?: number) {
65
65
  try {
66
66
  if (changeNumber) localStorage.setItem(this.keys.buildTillKey(), changeNumber + '');
67
67
  else localStorage.removeItem(this.keys.buildTillKey());
@@ -6,6 +6,7 @@ import { ILogger } from '../../logger/types';
6
6
  import { LOG_PREFIX } from './constants';
7
7
  import { ISettings } from '../../types';
8
8
  import { getStorageHash } from '../KeyBuilder';
9
+ import { setToArray } from '../../utils/lang/sets';
9
10
 
10
11
  /**
11
12
  * ISplitsCacheSync implementation that stores split definitions in browser LocalStorage.
@@ -281,7 +282,7 @@ export class SplitsCacheInLocal extends AbstractSplitsCacheSync {
281
282
  const flagSetCache = new Set(flagSetFromLocalStorage ? JSON.parse(flagSetFromLocalStorage) : []);
282
283
  flagSetCache.add(featureFlag.name);
283
284
 
284
- localStorage.setItem(flagSetKey, JSON.stringify(Array.from(flagSetCache)));
285
+ localStorage.setItem(flagSetKey, JSON.stringify(setToArray(flagSetCache)));
285
286
  });
286
287
  }
287
288
 
@@ -308,7 +309,7 @@ export class SplitsCacheInLocal extends AbstractSplitsCacheSync {
308
309
  return;
309
310
  }
310
311
 
311
- localStorage.setItem(flagSetKey, JSON.stringify(Array.from(flagSetCache)));
312
+ localStorage.setItem(flagSetKey, JSON.stringify(setToArray(flagSetCache)));
312
313
  }
313
314
 
314
315
  }
@@ -65,7 +65,7 @@ export function InLocalStorage(options: InLocalStorageOptions = {}): IStorageSyn
65
65
  this.uniqueKeys?.clear();
66
66
  },
67
67
 
68
- // When using shared instanciation with MEMORY we reuse everything but segments (they are customer per key).
68
+ // When using shared instantiation with MEMORY we reuse everything but segments (they are customer per key).
69
69
  shared(matchingKey: string) {
70
70
 
71
71
  return {
@@ -7,6 +7,8 @@ import { ImpressionCountsCacheInMemory } from './ImpressionCountsCacheInMemory';
7
7
  import { DEBUG, LOCALHOST_MODE, NONE, STORAGE_MEMORY } from '../../utils/constants';
8
8
  import { shouldRecordTelemetry, TelemetryCacheInMemory } from './TelemetryCacheInMemory';
9
9
  import { UniqueKeysCacheInMemoryCS } from './UniqueKeysCacheInMemoryCS';
10
+ import { getMatching } from '../../utils/key';
11
+ import { loadData } from '../dataLoader';
10
12
 
11
13
  /**
12
14
  * InMemory storage factory for standalone client-side SplitFactory
@@ -14,7 +16,7 @@ import { UniqueKeysCacheInMemoryCS } from './UniqueKeysCacheInMemoryCS';
14
16
  * @param params parameters required by EventsCacheSync
15
17
  */
16
18
  export function InMemoryStorageCSFactory(params: IStorageFactoryParams): IStorageSync {
17
- const { settings: { scheduler: { impressionsQueueSize, eventsQueueSize, }, sync: { impressionsMode, __splitFiltersValidation } } } = params;
19
+ const { settings: { scheduler: { impressionsQueueSize, eventsQueueSize, }, sync: { impressionsMode, __splitFiltersValidation }, preloadedData }, onReadyFromCacheCb } = params;
18
20
 
19
21
  const splits = new SplitsCacheInMemory(__splitFiltersValidation);
20
22
  const segments = new MySegmentsCacheInMemory();
@@ -41,12 +43,19 @@ export function InMemoryStorageCSFactory(params: IStorageFactoryParams): IStorag
41
43
  this.uniqueKeys && this.uniqueKeys.clear();
42
44
  },
43
45
 
44
- // When using shared instanciation with MEMORY we reuse everything but segments (they are unique per key)
45
- shared() {
46
+ // When using shared instantiation with MEMORY we reuse everything but segments (they are unique per key)
47
+ shared(matchingKey: string) {
48
+ const segments = new MySegmentsCacheInMemory();
49
+ const largeSegments = new MySegmentsCacheInMemory();
50
+
51
+ if (preloadedData) {
52
+ loadData(preloadedData, { segments, largeSegments }, matchingKey);
53
+ }
54
+
46
55
  return {
47
56
  splits: this.splits,
48
- segments: new MySegmentsCacheInMemory(),
49
- largeSegments: new MySegmentsCacheInMemory(),
57
+ segments,
58
+ largeSegments,
50
59
  impressions: this.impressions,
51
60
  impressionCounts: this.impressionCounts,
52
61
  events: this.events,
@@ -63,7 +72,7 @@ export function InMemoryStorageCSFactory(params: IStorageFactoryParams): IStorag
63
72
  };
64
73
 
65
74
  // @TODO revisit storage logic in localhost mode
66
- // No tracking data in localhost mode to avoid memory leaks
75
+ // No tracking in localhost mode to avoid memory leaks: https://github.com/splitio/javascript-commons/issues/181
67
76
  if (params.settings.mode === LOCALHOST_MODE) {
68
77
  const noopTrack = () => true;
69
78
  storage.impressions.track = noopTrack;
@@ -72,6 +81,12 @@ export function InMemoryStorageCSFactory(params: IStorageFactoryParams): IStorag
72
81
  if (storage.uniqueKeys) storage.uniqueKeys.track = noopTrack;
73
82
  }
74
83
 
84
+
85
+ if (preloadedData) {
86
+ loadData(preloadedData, storage, getMatching(params.settings.core.key));
87
+ if (splits.getChangeNumber() > -1) onReadyFromCacheCb();
88
+ }
89
+
75
90
  return storage;
76
91
  }
77
92
 
@@ -1,15 +1,15 @@
1
- import { AbstractSegmentsCacheSync } from '../AbstractSegmentsCacheSync';
1
+ import { AbstractMySegmentsCacheSync } from '../AbstractMySegmentsCacheSync';
2
2
 
3
3
  /**
4
4
  * Default MySegmentsCacheInMemory implementation that stores MySegments in memory.
5
5
  * Supported by all JS runtimes.
6
6
  */
7
- export class MySegmentsCacheInMemory extends AbstractSegmentsCacheSync {
7
+ export class MySegmentsCacheInMemory extends AbstractMySegmentsCacheSync {
8
8
 
9
9
  private segmentCache: Record<string, boolean> = {};
10
10
  private cn?: number;
11
11
 
12
- addToSegment(name: string): boolean {
12
+ protected addSegment(name: string): boolean {
13
13
  if (this.segmentCache[name]) return false;
14
14
 
15
15
  this.segmentCache[name] = true;
@@ -17,7 +17,7 @@ export class MySegmentsCacheInMemory extends AbstractSegmentsCacheSync {
17
17
  return true;
18
18
  }
19
19
 
20
- removeFromSegment(name: string): boolean {
20
+ protected removeSegment(name: string): boolean {
21
21
  if (!this.segmentCache[name]) return false;
22
22
 
23
23
  delete this.segmentCache[name];
@@ -30,7 +30,7 @@ export class MySegmentsCacheInMemory extends AbstractSegmentsCacheSync {
30
30
  }
31
31
 
32
32
 
33
- setChangeNumber(name?: string, changeNumber?: number) {
33
+ protected setChangeNumber(changeNumber?: number) {
34
34
  this.cn = changeNumber;
35
35
  }
36
36
 
@@ -1,35 +1,24 @@
1
- import { AbstractSegmentsCacheSync } from '../AbstractSegmentsCacheSync';
2
1
  import { isIntegerNumber } from '../../utils/lang';
2
+ import { ISegmentsCacheSync } from '../types';
3
3
 
4
4
  /**
5
- * Default ISplitsCacheSync implementation that stores split definitions in memory.
6
- * Supported by all JS runtimes.
5
+ * Default ISplitsCacheSync implementation for server-side that stores segments definitions in memory.
7
6
  */
8
- export class SegmentsCacheInMemory extends AbstractSegmentsCacheSync {
7
+ export class SegmentsCacheInMemory implements ISegmentsCacheSync {
9
8
 
10
9
  private segmentCache: Record<string, Set<string>> = {};
11
10
  private segmentChangeNumber: Record<string, number> = {};
12
11
 
13
- addToSegment(name: string, segmentKeys: string[]): boolean {
14
- const values = this.segmentCache[name];
15
- const keySet = values ? values : new Set<string>();
12
+ update(name: string, addedKeys: string[], removedKeys: string[], changeNumber: number) {
13
+ const keySet = this.segmentCache[name] || new Set<string>();
16
14
 
17
- segmentKeys.forEach(k => keySet.add(k));
15
+ addedKeys.forEach(k => keySet.add(k));
16
+ removedKeys.forEach(k => keySet.delete(k));
18
17
 
19
18
  this.segmentCache[name] = keySet;
19
+ this.segmentChangeNumber[name] = changeNumber;
20
20
 
21
- return true;
22
- }
23
-
24
- removeFromSegment(name: string, segmentKeys: string[]): boolean {
25
- const values = this.segmentCache[name];
26
- const keySet = values ? values : new Set<string>();
27
-
28
- segmentKeys.forEach(k => keySet.delete(k));
29
-
30
- this.segmentCache[name] = keySet;
31
-
32
- return true;
21
+ return addedKeys.length > 0 || removedKeys.length > 0;
33
22
  }
34
23
 
35
24
  isInSegment(name: string, key: string): boolean {
@@ -73,16 +62,13 @@ export class SegmentsCacheInMemory extends AbstractSegmentsCacheSync {
73
62
  }, 0);
74
63
  }
75
64
 
76
- setChangeNumber(name: string, changeNumber: number) {
77
- this.segmentChangeNumber[name] = changeNumber;
78
-
79
- return true;
80
- }
81
-
82
65
  getChangeNumber(name: string) {
83
66
  const value = this.segmentChangeNumber[name];
84
67
 
85
68
  return isIntegerNumber(value) ? value : -1;
86
69
  }
87
70
 
71
+ // No-op. Not used in server-side
72
+ resetSegments() { return false; }
73
+
88
74
  }
@@ -4,7 +4,6 @@ import { isFiniteNumber } from '../../utils/lang';
4
4
 
5
5
  /**
6
6
  * Default ISplitsCacheSync implementation that stores split definitions in memory.
7
- * Supported by all JS runtimes.
8
7
  */
9
8
  export class SplitsCacheInMemory extends AbstractSplitsCacheSync {
10
9
 
@@ -1,6 +1,7 @@
1
1
  import { IUniqueKeysCacheBase } from '../types';
2
2
  import { UniqueKeysPayloadSs } from '../../sync/submitters/types';
3
3
  import { DEFAULT_CACHE_SIZE } from '../inRedis/constants';
4
+ import { setToArray } from '../../utils/lang/sets';
4
5
 
5
6
  /**
6
7
  * Converts `uniqueKeys` data from cache into request payload for SS.
@@ -10,7 +11,7 @@ export function fromUniqueKeysCollector(uniqueKeys: { [featureName: string]: Set
10
11
  const featureNames = Object.keys(uniqueKeys);
11
12
  for (let i = 0; i < featureNames.length; i++) {
12
13
  const featureName = featureNames[i];
13
- const userKeys = Array.from(uniqueKeys[featureName]);
14
+ const userKeys = setToArray(uniqueKeys[featureName]);
14
15
  const uniqueKeysPayload = {
15
16
  f: featureName,
16
17
  ks: userKeys
@@ -1,6 +1,7 @@
1
1
  import { IUniqueKeysCacheBase } from '../types';
2
2
  import { UniqueKeysPayloadCs } from '../../sync/submitters/types';
3
3
  import { DEFAULT_CACHE_SIZE } from '../inRedis/constants';
4
+ import { setToArray } from '../../utils/lang/sets';
4
5
 
5
6
  export class UniqueKeysCacheInMemoryCS implements IUniqueKeysCacheBase {
6
7
 
@@ -70,7 +71,7 @@ export class UniqueKeysCacheInMemoryCS implements IUniqueKeysCacheBase {
70
71
  const userKeys = Object.keys(uniqueKeys);
71
72
  for (let k = 0; k < userKeys.length; k++) {
72
73
  const userKey = userKeys[k];
73
- const featureNames = Array.from(uniqueKeys[userKey]);
74
+ const featureNames = setToArray(uniqueKeys[userKey]);
74
75
  const uniqueKeysPayload = {
75
76
  k: userKey,
76
77
  fs: featureNames
@@ -3,6 +3,7 @@ import { ILogger } from '../../logger/types';
3
3
  import { merge, isString } from '../../utils/lang';
4
4
  import { thenable } from '../../utils/promise/thenable';
5
5
  import { timeout } from '../../utils/promise/timeout';
6
+ import { setToArray } from '../../utils/lang/sets';
6
7
 
7
8
  const LOG_PREFIX = 'storage:redis-adapter: ';
8
9
 
@@ -149,7 +150,7 @@ export class RedisAdapter extends ioredis {
149
150
  if (instance._runningCommands.size > 0) {
150
151
  instance.log.info(LOG_PREFIX + `Attempting to disconnect but there are ${instance._runningCommands.size} commands still waiting for resolution. Defering disconnection until those finish.`);
151
152
 
152
- Promise.all(Array.from(instance._runningCommands))
153
+ Promise.all(setToArray(instance._runningCommands))
153
154
  .then(() => {
154
155
  instance.log.debug(LOG_PREFIX + 'Pending commands finished successfully, disconnecting.');
155
156
  originalMethod.apply(instance, params);
@@ -17,24 +17,21 @@ export class SegmentsCacheInRedis implements ISegmentsCacheAsync {
17
17
  this.keys = keys;
18
18
  }
19
19
 
20
- addToSegment(name: string, segmentKeys: string[]) {
20
+ /**
21
+ * Update the given segment `name` with the lists of `addedKeys`, `removedKeys` and `changeNumber`.
22
+ * The returned promise is resolved if the operation success, with `true` if the segment was updated (i.e., some key was added or removed),
23
+ * or rejected if it fails (e.g., Redis operation fails).
24
+ */
25
+ update(name: string, addedKeys: string[], removedKeys: string[], changeNumber: number) {
21
26
  const segmentKey = this.keys.buildSegmentNameKey(name);
22
27
 
23
- if (segmentKeys.length) {
24
- return this.redis.sadd(segmentKey, segmentKeys).then(() => true);
25
- } else {
26
- return Promise.resolve(true);
27
- }
28
- }
29
-
30
- removeFromSegment(name: string, segmentKeys: string[]) {
31
- const segmentKey = this.keys.buildSegmentNameKey(name);
32
-
33
- if (segmentKeys.length) {
34
- return this.redis.srem(segmentKey, segmentKeys).then(() => true);
35
- } else {
36
- return Promise.resolve(true);
37
- }
28
+ return Promise.all([
29
+ addedKeys.length && this.redis.sadd(segmentKey, addedKeys),
30
+ removedKeys.length && this.redis.srem(segmentKey, removedKeys),
31
+ this.redis.set(this.keys.buildSegmentTillKey(name), changeNumber + '')
32
+ ]).then(() => {
33
+ return addedKeys.length > 0 || removedKeys.length > 0;
34
+ });
38
35
  }
39
36
 
40
37
  isInSegment(name: string, key: string) {
@@ -43,12 +40,6 @@ export class SegmentsCacheInRedis implements ISegmentsCacheAsync {
43
40
  ).then(matches => matches !== 0);
44
41
  }
45
42
 
46
- setChangeNumber(name: string, changeNumber: number) {
47
- return this.redis.set(
48
- this.keys.buildSegmentTillKey(name), changeNumber + ''
49
- ).then(status => status === 'OK');
50
- }
51
-
52
43
  getChangeNumber(name: string) {
53
44
  return this.redis.get(this.keys.buildSegmentTillKey(name)).then((value: string | null) => {
54
45
  const i = parseInt(value as string, 10);
@@ -5,6 +5,7 @@ import { LOG_PREFIX } from './constants';
5
5
  import { ILogger } from '../../logger/types';
6
6
  import { UniqueKeysItemSs } from '../../sync/submitters/types';
7
7
  import type { RedisAdapter } from './RedisAdapter';
8
+ import { setToArray } from '../../utils/lang/sets';
8
9
 
9
10
  export class UniqueKeysCacheInRedis extends UniqueKeysCacheInMemory implements IUniqueKeysCacheBase {
10
11
 
@@ -28,7 +29,7 @@ export class UniqueKeysCacheInRedis extends UniqueKeysCacheInMemory implements I
28
29
  if (!featureNames.length) return Promise.resolve(false);
29
30
 
30
31
  const uniqueKeysArray = featureNames.map((featureName) => {
31
- const featureKeys = Array.from(this.uniqueKeysTracker[featureName]);
32
+ const featureKeys = setToArray(this.uniqueKeysTracker[featureName]);
32
33
  const uniqueKeysPayload = {
33
34
  f: featureName,
34
35
  ks: featureKeys