@splitsoftware/splitio-commons 1.16.1-rc.7 → 1.17.0-rc.0

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 (165) hide show
  1. package/CHANGES.txt +2 -1
  2. package/cjs/evaluator/matchers/index.js +1 -3
  3. package/cjs/evaluator/matchers/matcherTypes.js +0 -1
  4. package/cjs/evaluator/matchersTransform/index.js +1 -1
  5. package/cjs/logger/constants.js +4 -3
  6. package/cjs/logger/messages/info.js +2 -1
  7. package/cjs/readiness/readinessManager.js +10 -14
  8. package/cjs/readiness/sdkReadinessManager.js +6 -5
  9. package/cjs/sdkClient/sdkClientMethodCS.js +2 -2
  10. package/cjs/sdkClient/sdkClientMethodCSWithTT.js +2 -2
  11. package/cjs/sdkFactory/index.js +1 -1
  12. package/cjs/services/decorateHeaders.js +42 -0
  13. package/cjs/services/splitApi.js +0 -4
  14. package/cjs/services/splitHttpClient.js +5 -4
  15. package/cjs/storages/AbstractSplitsCacheAsync.js +2 -2
  16. package/cjs/storages/AbstractSplitsCacheSync.js +6 -5
  17. package/cjs/storages/KeyBuilder.js +0 -3
  18. package/cjs/storages/KeyBuilderCS.js +5 -17
  19. package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js +4 -16
  20. package/cjs/storages/inLocalStorage/index.js +2 -6
  21. package/cjs/storages/inMemory/InMemoryStorageCS.js +0 -5
  22. package/cjs/storages/inMemory/SplitsCacheInMemory.js +11 -20
  23. package/cjs/storages/inMemory/TelemetryCacheInMemory.js +10 -7
  24. package/cjs/storages/pluggable/inMemoryWrapper.js +1 -1
  25. package/cjs/sync/polling/fetchers/mySegmentsFetcher.js +1 -5
  26. package/cjs/sync/polling/pollingManagerCS.js +33 -51
  27. package/cjs/sync/polling/syncTasks/mySegmentsSyncTask.js +2 -2
  28. package/cjs/sync/polling/updaters/mySegmentsUpdater.js +21 -20
  29. package/cjs/sync/streaming/SSEClient/index.js +0 -4
  30. package/cjs/sync/streaming/SSEHandler/index.js +0 -1
  31. package/cjs/sync/streaming/UpdateWorkers/MySegmentsUpdateWorker.js +9 -23
  32. package/cjs/sync/streaming/constants.js +1 -2
  33. package/cjs/sync/streaming/parseUtils.js +8 -3
  34. package/cjs/sync/streaming/pushManager.js +68 -97
  35. package/cjs/sync/submitters/telemetrySubmitter.js +0 -4
  36. package/cjs/sync/syncManagerOnline.js +14 -24
  37. package/cjs/utils/constants/index.js +2 -4
  38. package/cjs/utils/settingsValidation/index.js +2 -7
  39. package/esm/evaluator/matchers/index.js +1 -3
  40. package/esm/evaluator/matchers/matcherTypes.js +0 -1
  41. package/esm/evaluator/matchersTransform/index.js +1 -1
  42. package/esm/logger/constants.js +1 -0
  43. package/esm/logger/messages/info.js +2 -1
  44. package/esm/readiness/readinessManager.js +10 -14
  45. package/esm/readiness/sdkReadinessManager.js +6 -5
  46. package/esm/sdkClient/sdkClientMethodCS.js +2 -2
  47. package/esm/sdkClient/sdkClientMethodCSWithTT.js +2 -2
  48. package/esm/sdkFactory/index.js +1 -1
  49. package/esm/services/decorateHeaders.js +38 -0
  50. package/esm/services/splitApi.js +1 -5
  51. package/esm/services/splitHttpClient.js +5 -4
  52. package/esm/storages/AbstractSplitsCacheAsync.js +2 -2
  53. package/esm/storages/AbstractSplitsCacheSync.js +4 -3
  54. package/esm/storages/KeyBuilder.js +0 -3
  55. package/esm/storages/KeyBuilderCS.js +4 -15
  56. package/esm/storages/inLocalStorage/SplitsCacheInLocal.js +5 -17
  57. package/esm/storages/inLocalStorage/index.js +3 -7
  58. package/esm/storages/inMemory/InMemoryStorageCS.js +0 -5
  59. package/esm/storages/inMemory/SplitsCacheInMemory.js +12 -21
  60. package/esm/storages/inMemory/TelemetryCacheInMemory.js +10 -7
  61. package/esm/storages/pluggable/inMemoryWrapper.js +1 -1
  62. package/esm/sync/polling/fetchers/mySegmentsFetcher.js +1 -5
  63. package/esm/sync/polling/pollingManagerCS.js +34 -52
  64. package/esm/sync/polling/syncTasks/mySegmentsSyncTask.js +2 -2
  65. package/esm/sync/polling/updaters/mySegmentsUpdater.js +19 -18
  66. package/esm/sync/streaming/SSEClient/index.js +1 -5
  67. package/esm/sync/streaming/SSEHandler/index.js +1 -2
  68. package/esm/sync/streaming/UpdateWorkers/MySegmentsUpdateWorker.js +9 -23
  69. package/esm/sync/streaming/constants.js +0 -1
  70. package/esm/sync/streaming/parseUtils.js +8 -3
  71. package/esm/sync/streaming/pushManager.js +69 -97
  72. package/esm/sync/submitters/telemetrySubmitter.js +0 -4
  73. package/esm/sync/syncManagerOnline.js +15 -25
  74. package/esm/utils/constants/index.js +1 -3
  75. package/esm/utils/settingsValidation/index.js +2 -7
  76. package/package.json +1 -1
  77. package/src/dtos/types.ts +7 -17
  78. package/src/evaluator/matchers/index.ts +0 -2
  79. package/src/evaluator/matchers/matcherTypes.ts +0 -1
  80. package/src/evaluator/matchersTransform/index.ts +1 -1
  81. package/src/logger/constants.ts +1 -0
  82. package/src/logger/messages/info.ts +2 -1
  83. package/src/readiness/readinessManager.ts +9 -13
  84. package/src/readiness/sdkReadinessManager.ts +7 -7
  85. package/src/readiness/types.ts +2 -3
  86. package/src/sdkClient/sdkClientMethodCS.ts +2 -2
  87. package/src/sdkClient/sdkClientMethodCSWithTT.ts +2 -2
  88. package/src/sdkFactory/index.ts +1 -1
  89. package/src/services/decorateHeaders.ts +40 -0
  90. package/src/services/splitApi.ts +1 -6
  91. package/src/services/splitHttpClient.ts +5 -4
  92. package/src/services/types.ts +0 -1
  93. package/src/storages/AbstractSplitsCacheAsync.ts +2 -2
  94. package/src/storages/AbstractSplitsCacheSync.ts +5 -4
  95. package/src/storages/KeyBuilder.ts +0 -3
  96. package/src/storages/KeyBuilderCS.ts +5 -25
  97. package/src/storages/inLocalStorage/MySegmentsCacheInLocal.ts +3 -3
  98. package/src/storages/inLocalStorage/SplitsCacheInLocal.ts +5 -20
  99. package/src/storages/inLocalStorage/index.ts +4 -8
  100. package/src/storages/inMemory/InMemoryStorageCS.ts +0 -5
  101. package/src/storages/inMemory/SplitsCacheInMemory.ts +10 -15
  102. package/src/storages/inMemory/TelemetryCacheInMemory.ts +11 -7
  103. package/src/storages/pluggable/inMemoryWrapper.ts +1 -1
  104. package/src/storages/types.ts +5 -7
  105. package/src/sync/polling/fetchers/mySegmentsFetcher.ts +2 -6
  106. package/src/sync/polling/pollingManagerCS.ts +29 -61
  107. package/src/sync/polling/syncTasks/mySegmentsSyncTask.ts +10 -10
  108. package/src/sync/polling/types.ts +3 -4
  109. package/src/sync/polling/updaters/mySegmentsUpdater.ts +20 -17
  110. package/src/sync/streaming/SSEClient/index.ts +7 -10
  111. package/src/sync/streaming/SSEHandler/index.ts +1 -2
  112. package/src/sync/streaming/SSEHandler/types.ts +2 -14
  113. package/src/sync/streaming/UpdateWorkers/MySegmentsUpdateWorker.ts +9 -25
  114. package/src/sync/streaming/UpdateWorkers/SegmentsUpdateWorker.ts +1 -1
  115. package/src/sync/streaming/UpdateWorkers/SplitsUpdateWorker.ts +1 -1
  116. package/src/sync/streaming/UpdateWorkers/types.ts +2 -2
  117. package/src/sync/streaming/constants.ts +0 -1
  118. package/src/sync/streaming/parseUtils.ts +10 -6
  119. package/src/sync/streaming/pushManager.ts +67 -101
  120. package/src/sync/streaming/types.ts +3 -5
  121. package/src/sync/submitters/telemetrySubmitter.ts +0 -4
  122. package/src/sync/submitters/types.ts +4 -11
  123. package/src/sync/syncManagerOnline.ts +11 -19
  124. package/src/types.ts +9 -28
  125. package/src/utils/constants/index.ts +1 -3
  126. package/src/utils/settingsValidation/index.ts +3 -8
  127. package/src/utils/settingsValidation/types.ts +1 -1
  128. package/types/dtos/types.d.ts +6 -14
  129. package/types/logger/constants.d.ts +1 -0
  130. package/types/readiness/readinessManager.d.ts +2 -2
  131. package/types/readiness/sdkReadinessManager.d.ts +3 -2
  132. package/types/readiness/types.d.ts +2 -3
  133. package/types/services/decorateHeaders.d.ts +2 -0
  134. package/types/services/types.d.ts +0 -1
  135. package/types/storages/AbstractSplitsCacheAsync.d.ts +1 -1
  136. package/types/storages/AbstractSplitsCacheSync.d.ts +3 -3
  137. package/types/storages/KeyBuilder.d.ts +0 -1
  138. package/types/storages/KeyBuilderCS.d.ts +2 -7
  139. package/types/storages/inLocalStorage/MySegmentsCacheInLocal.d.ts +2 -2
  140. package/types/storages/inLocalStorage/SplitsCacheInLocal.d.ts +1 -1
  141. package/types/storages/inMemory/SplitsCacheInMemory.d.ts +2 -3
  142. package/types/storages/inMemory/TelemetryCacheInMemory.d.ts +6 -4
  143. package/types/storages/pluggable/inMemoryWrapper.d.ts +1 -1
  144. package/types/storages/types.d.ts +3 -4
  145. package/types/sync/polling/syncTasks/mySegmentsSyncTask.d.ts +3 -2
  146. package/types/sync/polling/types.d.ts +3 -10
  147. package/types/sync/polling/updaters/mySegmentsUpdater.d.ts +4 -4
  148. package/types/sync/streaming/SSEClient/index.d.ts +0 -1
  149. package/types/sync/streaming/SSEHandler/types.d.ts +2 -13
  150. package/types/sync/streaming/UpdateWorkers/MySegmentsUpdateWorker.d.ts +2 -3
  151. package/types/sync/streaming/UpdateWorkers/SegmentsUpdateWorker.d.ts +1 -2
  152. package/types/sync/streaming/UpdateWorkers/SplitsUpdateWorker.d.ts +2 -3
  153. package/types/sync/streaming/UpdateWorkers/types.d.ts +2 -2
  154. package/types/sync/streaming/constants.d.ts +0 -1
  155. package/types/sync/streaming/parseUtils.d.ts +4 -2
  156. package/types/sync/streaming/pushManager.d.ts +0 -2
  157. package/types/sync/streaming/types.d.ts +4 -5
  158. package/types/sync/submitters/types.d.ts +3 -10
  159. package/types/types.d.ts +11 -26
  160. package/types/utils/constants/index.d.ts +1 -3
  161. package/types/utils/settingsValidation/index.d.ts +0 -2
  162. package/types/utils/settingsValidation/types.d.ts +1 -1
  163. package/cjs/evaluator/matchers/large_segment.js +0 -16
  164. package/esm/evaluator/matchers/large_segment.js +0 -12
  165. package/src/evaluator/matchers/large_segment.ts +0 -18
@@ -1,6 +1,6 @@
1
1
  import { errorParser, messageParser } from './NotificationParser';
2
2
  import { notificationKeeperFactory } from './NotificationKeeper';
3
- import { PUSH_RETRYABLE_ERROR, PUSH_NONRETRYABLE_ERROR, OCCUPANCY, CONTROL, MY_SEGMENTS_UPDATE, MY_SEGMENTS_UPDATE_V2, SEGMENT_UPDATE, SPLIT_KILL, SPLIT_UPDATE, MY_LARGE_SEGMENTS_UPDATE } from '../constants';
3
+ import { PUSH_RETRYABLE_ERROR, PUSH_NONRETRYABLE_ERROR, OCCUPANCY, CONTROL, MY_SEGMENTS_UPDATE, MY_SEGMENTS_UPDATE_V2, SEGMENT_UPDATE, SPLIT_KILL, SPLIT_UPDATE } from '../constants';
4
4
  import { STREAMING_PARSING_ERROR_FAILS, ERROR_STREAMING_SSE, STREAMING_PARSING_MESSAGE_FAILS, STREAMING_NEW_MESSAGE } from '../../../logger/constants';
5
5
  import { ABLY_ERROR, NON_REQUESTED, SSE_CONNECTION_ERROR } from '../../../utils/constants';
6
6
  /**
@@ -73,7 +73,6 @@ export function SSEHandlerFactory(log, pushEmitter, telemetryTracker) {
73
73
  case SPLIT_UPDATE:
74
74
  case SEGMENT_UPDATE:
75
75
  case MY_SEGMENTS_UPDATE_V2:
76
- case MY_LARGE_SEGMENTS_UPDATE:
77
76
  case SPLIT_KILL:
78
77
  pushEmitter.emit(parsedData.type, parsedData);
79
78
  break;
@@ -1,15 +1,14 @@
1
1
  import { Backoff } from '../../../utils/Backoff';
2
+ import { MY_SEGMENT } from '../../../utils/constants';
2
3
  /**
3
4
  * MySegmentsUpdateWorker factory
4
5
  */
5
- export function MySegmentsUpdateWorker(mySegmentsSyncTask, telemetryTracker, updateType) {
6
+ export function MySegmentsUpdateWorker(mySegmentsSyncTask, telemetryTracker) {
6
7
  var maxChangeNumber = 0; // keeps the maximum changeNumber among queued events
7
8
  var currentChangeNumber = -1;
8
9
  var handleNewEvent = false;
9
10
  var isHandlingEvent;
10
11
  var _segmentsData; // keeps the segmentsData (if included in notification payload) from the queued event with maximum changeNumber
11
- var _delay;
12
- var _delayTimeoutID;
13
12
  var backoff = new Backoff(__handleMySegmentsUpdateCall);
14
13
  function __handleMySegmentsUpdateCall() {
15
14
  isHandlingEvent = true;
@@ -17,20 +16,12 @@ export function MySegmentsUpdateWorker(mySegmentsSyncTask, telemetryTracker, upd
17
16
  handleNewEvent = false;
18
17
  var currentMaxChangeNumber_1 = maxChangeNumber;
19
18
  // fetch mySegments revalidating data if cached
20
- var syncTask = _delay ?
21
- new Promise(function (res) {
22
- _delayTimeoutID = setTimeout(function () {
23
- _delay = undefined;
24
- mySegmentsSyncTask.execute(_segmentsData, true).then(res);
25
- }, _delay);
26
- }) :
27
- mySegmentsSyncTask.execute(_segmentsData, true);
28
- syncTask.then(function (result) {
19
+ mySegmentsSyncTask.execute(_segmentsData, true).then(function (result) {
29
20
  if (!isHandlingEvent)
30
21
  return; // halt if `stop` has been called
31
22
  if (result !== false) { // Unlike `Splits|SegmentsUpdateWorker`, we cannot use `mySegmentsCache.getChangeNumber` since `/mySegments` endpoint doesn't provide this value.
32
23
  if (_segmentsData)
33
- telemetryTracker.trackUpdatesFromSSE(updateType);
24
+ telemetryTracker.trackUpdatesFromSSE(MY_SEGMENT);
34
25
  currentChangeNumber = Math.max(currentChangeNumber, currentMaxChangeNumber_1); // use `currentMaxChangeNumber`, in case that `maxChangeNumber` was updated during fetch.
35
26
  }
36
27
  if (handleNewEvent) {
@@ -47,27 +38,22 @@ export function MySegmentsUpdateWorker(mySegmentsSyncTask, telemetryTracker, upd
47
38
  }
48
39
  return {
49
40
  /**
50
- * Invoked by NotificationProcessor on MY_(LARGE)_SEGMENTS_UPDATE notifications
41
+ * Invoked by NotificationProcessor on MY_SEGMENTS_UPDATE event
51
42
  *
52
- * @param changeNumber change number of the notification
53
- * @param segmentsData data for KeyList or SegmentRemoval instant updates
54
- * @param delay optional time to wait for BoundedFetchRequest or BoundedFetchRequest updates
43
+ * @param {number} changeNumber change number of the MY_SEGMENTS_UPDATE notification
44
+ * @param {SegmentsData | undefined} segmentsData might be undefined
55
45
  */
56
- put: function (changeNumber, segmentsData, delay) {
57
- // Ignore event if it is outdated or if there is a pending fetch request (_delay is set)
58
- if (changeNumber <= currentChangeNumber || changeNumber <= maxChangeNumber || _delay)
46
+ put: function (changeNumber, segmentsData) {
47
+ if (changeNumber <= currentChangeNumber || changeNumber <= maxChangeNumber)
59
48
  return;
60
49
  maxChangeNumber = changeNumber;
61
50
  handleNewEvent = true;
62
51
  _segmentsData = segmentsData;
63
- _delay = delay;
64
52
  if (backoff.timeoutID || !isHandlingEvent)
65
53
  __handleMySegmentsUpdateCall();
66
54
  backoff.reset();
67
55
  },
68
56
  stop: function () {
69
- clearTimeout(_delayTimeoutID);
70
- _delay = undefined;
71
57
  isHandlingEvent = false;
72
58
  backoff.reset();
73
59
  }
@@ -27,7 +27,6 @@ export var MY_SEGMENTS_UPDATE_V2 = 'MY_SEGMENTS_UPDATE_V2';
27
27
  export var SEGMENT_UPDATE = 'SEGMENT_UPDATE';
28
28
  export var SPLIT_KILL = 'SPLIT_KILL';
29
29
  export var SPLIT_UPDATE = 'SPLIT_UPDATE';
30
- export var MY_LARGE_SEGMENTS_UPDATE = 'MY_LARGE_SEGMENTS_UPDATE';
31
30
  // Control-type push notifications, handled by NotificationKeeper
32
31
  export var CONTROL = 'CONTROL';
33
32
  export var OCCUPANCY = 'OCCUPANCY';
@@ -74,9 +74,14 @@ export function isInBitmap(bitmap, hash64hex) {
74
74
  }
75
75
  /**
76
76
  * Parse feature flags notifications for instant feature flag updates
77
+ *
78
+ * @param {ISplitUpdateData} data
79
+ * @returns {KeyList}
77
80
  */
78
81
  export function parseFFUpdatePayload(compression, data) {
79
- return compression > 0 ?
80
- parseKeyList(data, compression, false) :
81
- JSON.parse(decodeFromBase64(data));
82
+ var avoidPrecisionLoss = false;
83
+ if (compression > 0)
84
+ return parseKeyList(data, compression, avoidPrecisionLoss);
85
+ else
86
+ return JSON.parse(decodeFromBase64(data));
82
87
  }
@@ -8,19 +8,13 @@ import { authenticateFactory, hashUserKey } from './AuthClient';
8
8
  import { forOwn } from '../../utils/lang';
9
9
  import { SSEClient } from './SSEClient';
10
10
  import { getMatching } from '../../utils/key';
11
- import { MY_SEGMENTS_UPDATE, MY_SEGMENTS_UPDATE_V2, PUSH_NONRETRYABLE_ERROR, PUSH_SUBSYSTEM_DOWN, SECONDS_BEFORE_EXPIRATION, SEGMENT_UPDATE, SPLIT_KILL, SPLIT_UPDATE, PUSH_RETRYABLE_ERROR, PUSH_SUBSYSTEM_UP, ControlType, MY_LARGE_SEGMENTS_UPDATE } from './constants';
11
+ import { MY_SEGMENTS_UPDATE, MY_SEGMENTS_UPDATE_V2, PUSH_NONRETRYABLE_ERROR, PUSH_SUBSYSTEM_DOWN, SECONDS_BEFORE_EXPIRATION, SEGMENT_UPDATE, SPLIT_KILL, SPLIT_UPDATE, PUSH_RETRYABLE_ERROR, PUSH_SUBSYSTEM_UP, ControlType } from './constants';
12
12
  import { STREAMING_FALLBACK, STREAMING_REFRESH_TOKEN, STREAMING_CONNECTING, STREAMING_DISABLED, ERROR_STREAMING_AUTH, STREAMING_DISCONNECTING, STREAMING_RECONNECT, STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2, STREAMING_PARSING_SPLIT_UPDATE } from '../../logger/constants';
13
13
  import { UpdateStrategy } from './SSEHandler/types';
14
14
  import { isInBitmap, parseBitmap, parseFFUpdatePayload, parseKeyList } from './parseUtils';
15
15
  import { _Set } from '../../utils/lang/sets';
16
- import { hash } from '../../utils/murmur3/murmur3';
17
16
  import { hash64 } from '../../utils/murmur3/murmur3_64';
18
- import { TOKEN_REFRESH, AUTH_REJECTION, MY_LARGE_SEGMENT, MY_SEGMENT } from '../../utils/constants';
19
- export function getDelay(parsedData, matchingKey) {
20
- var interval = parsedData.i || 60000;
21
- var seed = parsedData.s || 0;
22
- return hash(matchingKey, seed) % interval;
23
- }
17
+ import { TOKEN_REFRESH, AUTH_REJECTION } from '../../utils/constants';
24
18
  /**
25
19
  * PushManager factory:
26
20
  * - for server-side if key is not provided in settings.
@@ -146,9 +140,8 @@ export function pushManagerFactory(params, pollingManager) {
146
140
  splitsUpdateWorker.stop();
147
141
  if (userKey)
148
142
  forOwn(clients, function (_a) {
149
- var worker = _a.worker, workerLarge = _a.workerLarge;
150
- worker.stop();
151
- workerLarge && workerLarge.stop();
143
+ var worker = _a.worker;
144
+ return worker.stop();
152
145
  });
153
146
  else
154
147
  segmentsUpdateWorker.stop();
@@ -202,83 +195,6 @@ export function pushManagerFactory(params, pollingManager) {
202
195
  }
203
196
  splitsUpdateWorker.put(parsedData);
204
197
  });
205
- function handleMySegmentsUpdate(parsedData) {
206
- var isLS = parsedData.type === MY_LARGE_SEGMENTS_UPDATE;
207
- switch (parsedData.u) {
208
- case UpdateStrategy.BoundedFetchRequest: {
209
- var bitmap_1;
210
- try {
211
- bitmap_1 = parseBitmap(parsedData.d, parsedData.c);
212
- }
213
- catch (e) {
214
- log.warn(STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2, ['BoundedFetchRequest', e]);
215
- break;
216
- }
217
- forOwn(clients, function (_a, matchingKey) {
218
- var hash64 = _a.hash64, worker = _a.worker, workerLarge = _a.workerLarge;
219
- if (isInBitmap(bitmap_1, hash64.hex)) {
220
- isLS ?
221
- workerLarge && workerLarge.put(parsedData.changeNumber, undefined, getDelay(parsedData, matchingKey)) :
222
- worker.put(parsedData.changeNumber);
223
- }
224
- });
225
- return;
226
- }
227
- case UpdateStrategy.KeyList: {
228
- var keyList = void 0, added_1, removed_1;
229
- try {
230
- keyList = parseKeyList(parsedData.d, parsedData.c);
231
- added_1 = new _Set(keyList.a);
232
- removed_1 = new _Set(keyList.r);
233
- }
234
- catch (e) {
235
- log.warn(STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2, ['KeyList', e]);
236
- break;
237
- }
238
- forOwn(clients, function (_a) {
239
- var hash64 = _a.hash64, worker = _a.worker, workerLarge = _a.workerLarge;
240
- var add = added_1.has(hash64.dec) ? true : removed_1.has(hash64.dec) ? false : undefined;
241
- if (add !== undefined) {
242
- isLS ?
243
- workerLarge && workerLarge.put(parsedData.changeNumber, [{
244
- name: parsedData.largeSegments[0],
245
- add: add
246
- }]) :
247
- worker.put(parsedData.changeNumber, [{
248
- name: parsedData.segmentName,
249
- add: add
250
- }]);
251
- }
252
- });
253
- return;
254
- }
255
- case UpdateStrategy.SegmentRemoval:
256
- if ((isLS && parsedData.largeSegments.length === 0) || (!isLS && !parsedData.segmentName)) {
257
- log.warn(STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2, ['SegmentRemoval', 'No segment name was provided']);
258
- break;
259
- }
260
- forOwn(clients, function (_a) {
261
- var worker = _a.worker, workerLarge = _a.workerLarge;
262
- isLS ?
263
- workerLarge && workerLarge.put(parsedData.changeNumber, parsedData.largeSegments.map(function (largeSegment) { return ({
264
- name: largeSegment,
265
- add: false
266
- }); })) :
267
- worker.put(parsedData.changeNumber, [{
268
- name: parsedData.segmentName,
269
- add: false
270
- }]);
271
- });
272
- return;
273
- }
274
- // `UpdateStrategy.UnboundedFetchRequest` and fallbacks of other cases
275
- forOwn(clients, function (_a, matchingKey) {
276
- var worker = _a.worker, workerLarge = _a.workerLarge;
277
- isLS ?
278
- workerLarge && workerLarge.put(parsedData.changeNumber, undefined, getDelay(parsedData, matchingKey)) :
279
- worker.put(parsedData.changeNumber);
280
- });
281
- }
282
198
  if (userKey) {
283
199
  pushEmitter.on(MY_SEGMENTS_UPDATE, function handleMySegmentsUpdate(parsedData, channel) {
284
200
  var userKeyHash = channel.split('_')[2];
@@ -287,8 +203,68 @@ export function pushManagerFactory(params, pollingManager) {
287
203
  clients[userKey].worker.put(parsedData.changeNumber, parsedData.includesPayload ? parsedData.segmentList ? parsedData.segmentList : [] : undefined);
288
204
  }
289
205
  });
290
- pushEmitter.on(MY_SEGMENTS_UPDATE_V2, handleMySegmentsUpdate);
291
- pushEmitter.on(MY_LARGE_SEGMENTS_UPDATE, handleMySegmentsUpdate);
206
+ pushEmitter.on(MY_SEGMENTS_UPDATE_V2, function handleMySegmentsUpdate(parsedData) {
207
+ switch (parsedData.u) {
208
+ case UpdateStrategy.BoundedFetchRequest: {
209
+ var bitmap_1;
210
+ try {
211
+ bitmap_1 = parseBitmap(parsedData.d, parsedData.c);
212
+ }
213
+ catch (e) {
214
+ log.warn(STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2, ['BoundedFetchRequest', e]);
215
+ break;
216
+ }
217
+ forOwn(clients, function (_a) {
218
+ var hash64 = _a.hash64, worker = _a.worker;
219
+ if (isInBitmap(bitmap_1, hash64.hex)) {
220
+ worker.put(parsedData.changeNumber); // fetch mySegments
221
+ }
222
+ });
223
+ return;
224
+ }
225
+ case UpdateStrategy.KeyList: {
226
+ var keyList = void 0, added_1, removed_1;
227
+ try {
228
+ keyList = parseKeyList(parsedData.d, parsedData.c);
229
+ added_1 = new _Set(keyList.a);
230
+ removed_1 = new _Set(keyList.r);
231
+ }
232
+ catch (e) {
233
+ log.warn(STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2, ['KeyList', e]);
234
+ break;
235
+ }
236
+ forOwn(clients, function (_a) {
237
+ var hash64 = _a.hash64, worker = _a.worker;
238
+ var add = added_1.has(hash64.dec) ? true : removed_1.has(hash64.dec) ? false : undefined;
239
+ if (add !== undefined) {
240
+ worker.put(parsedData.changeNumber, {
241
+ name: parsedData.segmentName,
242
+ add: add
243
+ });
244
+ }
245
+ });
246
+ return;
247
+ }
248
+ case UpdateStrategy.SegmentRemoval:
249
+ if (!parsedData.segmentName) {
250
+ log.warn(STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2, ['SegmentRemoval', 'No segment name was provided']);
251
+ break;
252
+ }
253
+ forOwn(clients, function (_a) {
254
+ var worker = _a.worker;
255
+ return worker.put(parsedData.changeNumber, {
256
+ name: parsedData.segmentName,
257
+ add: false
258
+ });
259
+ });
260
+ return;
261
+ }
262
+ // `UpdateStrategy.UnboundedFetchRequest` and fallbacks of other cases
263
+ forOwn(clients, function (_a) {
264
+ var worker = _a.worker;
265
+ worker.put(parsedData.changeNumber);
266
+ });
267
+ });
292
268
  }
293
269
  else {
294
270
  pushEmitter.on(SEGMENT_UPDATE, segmentsUpdateWorker.put);
@@ -311,7 +287,7 @@ export function pushManagerFactory(params, pollingManager) {
311
287
  return;
312
288
  disconnected = false;
313
289
  if (userKey)
314
- this.add(userKey, pollingManager.segmentsSyncTask, pollingManager.largeSegmentsSyncTask); // client-side
290
+ this.add(userKey, pollingManager.segmentsSyncTask); // client-side
315
291
  else
316
292
  setTimeout(connectPush); // server-side runs in next cycle as in client-side, for consistency with client-side
317
293
  },
@@ -320,15 +296,11 @@ export function pushManagerFactory(params, pollingManager) {
320
296
  return disconnected === false;
321
297
  },
322
298
  // [Only for client-side]
323
- add: function (userKey, mySegmentsSyncTask, myLargeSegmentsSyncTask) {
299
+ add: function (userKey, mySegmentsSyncTask) {
324
300
  var hash = hashUserKey(userKey);
325
301
  if (!userKeyHashes[hash]) {
326
302
  userKeyHashes[hash] = userKey;
327
- clients[userKey] = {
328
- hash64: hash64(userKey),
329
- worker: MySegmentsUpdateWorker(mySegmentsSyncTask, telemetryTracker, MY_SEGMENT),
330
- workerLarge: myLargeSegmentsSyncTask ? MySegmentsUpdateWorker(myLargeSegmentsSyncTask, telemetryTracker, MY_LARGE_SEGMENT) : undefined
331
- };
303
+ clients[userKey] = { hash64: hash64(userKey), worker: MySegmentsUpdateWorker(mySegmentsSyncTask, telemetryTracker) };
332
304
  connectForNewClient = true; // we must reconnect on start, to listen the channel for the new user key
333
305
  // Reconnects in case of a new client.
334
306
  // Run in next event-loop cycle to save authentication calls
@@ -58,17 +58,13 @@ export function telemetryCacheConfigAdapter(telemetry, settings) {
58
58
  pop: function () {
59
59
  var urls = settings.urls, scheduler = settings.scheduler;
60
60
  var isClientSide = settings.core.key !== undefined;
61
- var largeSegmentsEnabled = isClientSide && settings.sync.largeSegmentsEnabled;
62
61
  var _a = getTelemetryFlagSetsStats(settings.sync.__splitFiltersValidation), flagSetsTotal = _a.flagSetsTotal, flagSetsIgnored = _a.flagSetsIgnored;
63
62
  return objectAssign(getTelemetryConfigStats(settings.mode, settings.storage.type), {
64
63
  sE: settings.streamingEnabled,
65
- lsE: largeSegmentsEnabled ? largeSegmentsEnabled : undefined,
66
- wls: largeSegmentsEnabled ? settings.startup.waitForLargeSegments : undefined,
67
64
  rR: {
68
65
  sp: scheduler.featuresRefreshRate / 1000,
69
66
  se: isClientSide ? undefined : scheduler.segmentsRefreshRate / 1000,
70
67
  ms: isClientSide ? scheduler.segmentsRefreshRate / 1000 : undefined,
71
- mls: largeSegmentsEnabled ? scheduler.largeSegmentsRefreshRate / 1000 : undefined,
72
68
  im: scheduler.impressionsRefreshRate / 1000,
73
69
  ev: scheduler.eventsPushRate / 1000,
74
70
  te: scheduler.telemetryRefreshRate / 1000,
@@ -2,7 +2,7 @@ import { submitterManagerFactory } from './submitters/submitterManager';
2
2
  import { PUSH_SUBSYSTEM_UP, PUSH_SUBSYSTEM_DOWN } from './streaming/constants';
3
3
  import { SYNC_START_POLLING, SYNC_CONTINUE_POLLING, SYNC_STOP_POLLING } from '../logger/constants';
4
4
  import { isConsentGranted } from '../consent';
5
- import { IN_LARGE_SEGMENT, IN_SEGMENT, POLLING, STREAMING, SYNC_MODE_UPDATE } from '../utils/constants';
5
+ import { POLLING, STREAMING, SYNC_MODE_UPDATE } from '../utils/constants';
6
6
  /**
7
7
  * Online SyncManager factory.
8
8
  * Can be used for server-side API, and client-side API with or without multiple clients.
@@ -114,53 +114,43 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
114
114
  shared: function (matchingKey, readinessManager, storage) {
115
115
  if (!pollingManager)
116
116
  return;
117
- var _a = pollingManager.add(matchingKey, readinessManager, storage), msSyncTask = _a.msSyncTask, mlsSyncTask = _a.mlsSyncTask;
117
+ var mySegmentsSyncTask = pollingManager.add(matchingKey, readinessManager, storage);
118
118
  return {
119
- isRunning: msSyncTask.isRunning,
119
+ isRunning: mySegmentsSyncTask.isRunning,
120
120
  start: function () {
121
121
  if (syncEnabled) {
122
122
  if (pushManager) {
123
123
  if (pollingManager.isRunning()) {
124
124
  // if doing polling, we must start the periodic fetch of data
125
- if (storage.splits.usesMatcher(IN_SEGMENT))
126
- msSyncTask.start();
127
- if (mlsSyncTask && storage.splits.usesMatcher(IN_LARGE_SEGMENT))
128
- mlsSyncTask.start();
125
+ if (storage.splits.usesSegments())
126
+ mySegmentsSyncTask.start();
129
127
  }
130
128
  else {
131
129
  // if not polling, we must execute the sync task for the initial fetch
132
130
  // of segments since `syncAll` was already executed when starting the main client
133
- msSyncTask.execute();
134
- mlsSyncTask && mlsSyncTask.execute();
131
+ mySegmentsSyncTask.execute();
135
132
  }
136
- pushManager.add(matchingKey, msSyncTask, mlsSyncTask);
133
+ pushManager.add(matchingKey, mySegmentsSyncTask);
137
134
  }
138
135
  else {
139
- if (storage.splits.usesMatcher(IN_SEGMENT))
140
- msSyncTask.start();
141
- if (mlsSyncTask && storage.splits.usesMatcher(IN_LARGE_SEGMENT))
142
- mlsSyncTask.start();
136
+ if (storage.splits.usesSegments())
137
+ mySegmentsSyncTask.start();
143
138
  }
144
139
  }
145
140
  else {
146
- if (!readinessManager.isReady()) {
147
- msSyncTask.execute();
148
- mlsSyncTask && mlsSyncTask.execute();
149
- }
141
+ if (!readinessManager.isReady())
142
+ mySegmentsSyncTask.execute();
150
143
  }
151
144
  },
152
145
  stop: function () {
153
146
  // check in case `client.destroy()` has been invoked more than once for the same client
154
- var syncTasks = pollingManager.get(matchingKey);
155
- if (syncTasks) {
156
- var msSyncTask_1 = syncTasks.msSyncTask, mlsSyncTask_1 = syncTasks.mlsSyncTask;
147
+ var mySegmentsSyncTask = pollingManager.get(matchingKey);
148
+ if (mySegmentsSyncTask) {
157
149
  // stop syncing
158
150
  if (pushManager)
159
151
  pushManager.remove(matchingKey);
160
- if (msSyncTask_1.isRunning())
161
- msSyncTask_1.stop();
162
- if (mlsSyncTask_1 && mlsSyncTask_1.isRunning())
163
- mlsSyncTask_1.stop();
152
+ if (mySegmentsSyncTask.isRunning())
153
+ mySegmentsSyncTask.stop();
164
154
  pollingManager.remove(matchingKey);
165
155
  }
166
156
  },
@@ -61,7 +61,6 @@ export var TELEMETRY = 'te';
61
61
  export var TOKEN = 'to';
62
62
  export var SEGMENT = 'se';
63
63
  export var MY_SEGMENT = 'ms';
64
- export var MY_LARGE_SEGMENT = 'mls';
65
64
  export var TREATMENT = 't';
66
65
  export var TREATMENTS = 'ts';
67
66
  export var TREATMENT_WITH_CONFIG = 'tc';
@@ -87,7 +86,6 @@ export var NON_REQUESTED = 1;
87
86
  export var DISABLED = 0;
88
87
  export var ENABLED = 1;
89
88
  export var PAUSED = 2;
90
- export var FLAG_SPEC_VERSION = '1.2';
89
+ export var FLAG_SPEC_VERSION = '1.1';
91
90
  // Matcher types
92
91
  export var IN_SEGMENT = 'IN_SEGMENT';
93
- export var IN_LARGE_SEGMENT = 'IN_LARGE_SEGMENT';
@@ -27,8 +27,6 @@ export var base = {
27
27
  featuresRefreshRate: 60,
28
28
  // fetch segments updates each 60 sec
29
29
  segmentsRefreshRate: 60,
30
- // fetch large segments updates each 60 sec
31
- largeSegmentsRefreshRate: 60,
32
30
  // publish telemetry stats each 3600 secs (1 hour)
33
31
  telemetryRefreshRate: 3600,
34
32
  // publish evaluations each 300 sec (default value for OPTIMIZED impressions mode)
@@ -74,8 +72,7 @@ export var base = {
74
72
  impressionsMode: OPTIMIZED,
75
73
  localhostMode: undefined,
76
74
  enabled: true,
77
- flagSpecVersion: FLAG_SPEC_VERSION,
78
- largeSegmentsEnabled: false
75
+ flagSpecVersion: FLAG_SPEC_VERSION
79
76
  },
80
77
  // Logger
81
78
  log: undefined
@@ -114,7 +111,6 @@ export function settingsValidation(config, validationParams) {
114
111
  var scheduler = withDefaults.scheduler, startup = withDefaults.startup;
115
112
  scheduler.featuresRefreshRate = fromSecondsToMillis(scheduler.featuresRefreshRate);
116
113
  scheduler.segmentsRefreshRate = fromSecondsToMillis(scheduler.segmentsRefreshRate);
117
- scheduler.largeSegmentsRefreshRate = fromSecondsToMillis(scheduler.largeSegmentsRefreshRate);
118
114
  scheduler.offlineRefreshRate = fromSecondsToMillis(scheduler.offlineRefreshRate);
119
115
  scheduler.eventsPushRate = fromSecondsToMillis(scheduler.eventsPushRate);
120
116
  scheduler.telemetryRefreshRate = fromSecondsToMillis(validateMinValue('telemetryRefreshRate', scheduler.telemetryRefreshRate, 60));
@@ -187,10 +183,9 @@ export function settingsValidation(config, validationParams) {
187
183
  var splitFiltersValidation = validateSplitFilters(log, sync.splitFilters, withDefaults.mode);
188
184
  sync.splitFilters = splitFiltersValidation.validFilters;
189
185
  sync.__splitFiltersValidation = splitFiltersValidation;
190
- // ensure a valid flag spec version
191
186
  sync.flagSpecVersion = flagSpec ? flagSpec(withDefaults) : FLAG_SPEC_VERSION;
192
187
  // ensure a valid user consent value
193
188
  // @ts-ignore, modify readonly prop
194
- withDefaults.userConsent = consent ? consent(withDefaults) : undefined;
189
+ withDefaults.userConsent = consent(withDefaults);
195
190
  return withDefaults;
196
191
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@splitsoftware/splitio-commons",
3
- "version": "1.16.1-rc.7",
3
+ "version": "1.17.0-rc.0",
4
4
  "description": "Split JavaScript SDK common components",
5
5
  "main": "cjs/index.js",
6
6
  "module": "esm/index.js",
package/src/dtos/types.ts CHANGED
@@ -61,11 +61,6 @@ interface IInSegmentMatcher extends ISplitMatcherBase {
61
61
  userDefinedSegmentMatcherData: IInSegmentMatcherData
62
62
  }
63
63
 
64
- interface IInLargeSegmentMatcher extends ISplitMatcherBase {
65
- matcherType: 'IN_LARGE_SEGMENT',
66
- userDefinedSegmentMatcherData: IInSegmentMatcherData
67
- }
68
-
69
64
  interface IWhitelistMatcher extends ISplitMatcherBase {
70
65
  matcherType: 'WHITELIST',
71
66
  whitelistMatcherData: IWhitelistMatcherData
@@ -170,8 +165,7 @@ interface IInListSemverMatcher extends ISplitMatcherBase {
170
165
  export type ISplitMatcher = IAllKeysMatcher | IInSegmentMatcher | IWhitelistMatcher | IEqualToMatcher | IGreaterThanOrEqualToMatcher |
171
166
  ILessThanOrEqualToMatcher | IBetweenMatcher | IEqualToSetMatcher | IContainsAnyOfSetMatcher | IContainsAllOfSetMatcher | IPartOfSetMatcher |
172
167
  IStartsWithMatcher | IEndsWithMatcher | IContainsStringMatcher | IInSplitTreatmentMatcher | IEqualToBooleanMatcher | IMatchesStringMatcher |
173
- IEqualToSemverMatcher | IGreaterThanOrEqualToSemverMatcher | ILessThanOrEqualToSemverMatcher | IBetweenSemverMatcher | IInListSemverMatcher |
174
- IInLargeSegmentMatcher
168
+ IEqualToSemverMatcher | IGreaterThanOrEqualToSemverMatcher | ILessThanOrEqualToSemverMatcher | IBetweenSemverMatcher | IInListSemverMatcher
175
169
 
176
170
  /** Split object */
177
171
  export interface ISplitPartition {
@@ -224,18 +218,14 @@ export interface ISegmentChangesResponse {
224
218
  till: number
225
219
  }
226
220
 
227
- /** Interface of the parsed JSON response of `/mySegments/{userKey}` */
228
- export interface IMySegmentsResponse {
229
- mySegments: {
230
- id: string,
231
- name: string
232
- }[]
221
+ export interface IMySegmentsResponseItem {
222
+ id: string,
223
+ name: string
233
224
  }
234
225
 
235
- /** Interface of the parsed JSON response of `/myLargeSegments/{userKey}` */
236
- export interface IMyLargeSegmentsResponse {
237
- myLargeSegments: string[],
238
- changeNumber: number
226
+ /** Interface of the parsed JSON response of `/mySegments/{userKey}` */
227
+ export interface IMySegmentsResponse {
228
+ mySegments: IMySegmentsResponseItem[]
239
229
  }
240
230
 
241
231
  /** Metadata internal type for storages */
@@ -1,6 +1,5 @@
1
1
  import { allMatcherContext } from './all';
2
2
  import { segmentMatcherContext } from './segment';
3
- import { largeSegmentMatcherContext } from './large_segment';
4
3
  import { whitelistMatcherContext } from './whitelist';
5
4
  import { equalToMatcherContext } from './eq';
6
5
  import { greaterThanEqualMatcherContext } from './gte';
@@ -49,7 +48,6 @@ const matchers = [
49
48
  lessThanEqualToSemverMatcherContext, // LESS_THAN_OR_EQUAL_TO_SEMVER: 20
50
49
  betweenSemverMatcherContext, // BETWEEN_SEMVER: 21
51
50
  inListSemverMatcherContext, // IN_LIST_SEMVER: 22
52
- largeSegmentMatcherContext, // IN_LARGE_SEGMENT: 23
53
51
  ];
54
52
 
55
53
  /**
@@ -22,7 +22,6 @@ export const matcherTypes: Record<string, number> = {
22
22
  LESS_THAN_OR_EQUAL_TO_SEMVER: 20,
23
23
  BETWEEN_SEMVER: 21,
24
24
  IN_LIST_SEMVER: 22,
25
- IN_LARGE_SEGMENT: 23,
26
25
  };
27
26
 
28
27
  export const matcherDataTypes = {
@@ -33,7 +33,7 @@ export function matchersTransform(matchers: ISplitMatcher[]): IMatcherDto[] {
33
33
  let dataType = matcherDataTypes.STRING;
34
34
  let value = undefined;
35
35
 
36
- if (type === matcherTypes.IN_SEGMENT || type === matcherTypes.IN_LARGE_SEGMENT) {
36
+ if (type === matcherTypes.IN_SEGMENT) {
37
37
  value = segmentTransform(userDefinedSegmentMatcherData as IInSegmentMatcherData);
38
38
  } else if (type === matcherTypes.EQUAL_TO) {
39
39
  value = numericTransform(unaryNumericMatcherData as IUnaryNumericMatcherData);
@@ -36,6 +36,7 @@ export const IMPRESSION = 102;
36
36
  export const IMPRESSION_QUEUEING = 103;
37
37
  export const NEW_SHARED_CLIENT = 104;
38
38
  export const NEW_FACTORY = 105;
39
+ export const POLLING_SMART_PAUSING = 106;
39
40
  export const POLLING_START = 107;
40
41
  export const POLLING_STOP = 108;
41
42
  export const SYNC_SPLITS_FETCH_RETRY = 109;
@@ -19,10 +19,11 @@ export const codesInfo: [number, string][] = codesWarn.concat([
19
19
  [c.USER_CONSENT_INITIAL, 'Starting the SDK with %s user consent. No data will be sent.'],
20
20
 
21
21
  // synchronizer
22
+ [c.POLLING_SMART_PAUSING, c.LOG_PREFIX_SYNC_POLLING + 'Turning segments data polling %s.'],
22
23
  [c.POLLING_START, c.LOG_PREFIX_SYNC_POLLING + 'Starting polling'],
23
24
  [c.POLLING_STOP, c.LOG_PREFIX_SYNC_POLLING + 'Stopping polling'],
24
25
  [c.SYNC_SPLITS_FETCH_RETRY, c.LOG_PREFIX_SYNC_SPLITS + 'Retrying download of feature flags #%s. Reason: %s'],
25
- [c.SUBMITTERS_PUSH_FULL_QUEUE, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Flushing full %s queue and resetting timer.'],
26
+ [c.SUBMITTERS_PUSH_FULL_QUEUE, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Flushing full %s queue and reseting timer.'],
26
27
  [c.SUBMITTERS_PUSH, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Pushing %s.'],
27
28
  [c.STREAMING_REFRESH_TOKEN, c.LOG_PREFIX_SYNC_STREAMING + 'Refreshing streaming token in %s seconds, and connecting streaming in %s seconds.'],
28
29
  [c.STREAMING_RECONNECT, c.LOG_PREFIX_SYNC_STREAMING + 'Attempting to reconnect streaming in %s seconds.'],