@splitsoftware/splitio-commons 1.17.0 → 1.17.1-rc.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (181) hide show
  1. package/CHANGES.txt +8 -0
  2. package/cjs/evaluator/matchers/index.js +3 -1
  3. package/cjs/evaluator/matchers/large_segment.js +16 -0
  4. package/cjs/evaluator/matchers/matcherTypes.js +1 -0
  5. package/cjs/evaluator/matchersTransform/index.js +4 -1
  6. package/cjs/evaluator/matchersTransform/segment.js +3 -1
  7. package/cjs/logger/constants.js +2 -2
  8. package/cjs/logger/messages/info.js +1 -1
  9. package/cjs/logger/messages/warn.js +1 -1
  10. package/cjs/readiness/readinessManager.js +5 -6
  11. package/cjs/readiness/sdkReadinessManager.js +5 -6
  12. package/cjs/sdkClient/identity.js +7 -0
  13. package/cjs/sdkClient/sdkClient.js +5 -5
  14. package/cjs/sdkClient/sdkClientMethod.js +3 -1
  15. package/cjs/sdkClient/sdkClientMethodCS.js +9 -14
  16. package/cjs/sdkClient/sdkClientMethodCSWithTT.js +9 -14
  17. package/cjs/sdkFactory/index.js +6 -2
  18. package/cjs/services/splitApi.js +5 -5
  19. package/cjs/storages/AbstractSegmentsCacheSync.js +41 -12
  20. package/cjs/storages/AbstractSplitsCacheSync.js +2 -1
  21. package/cjs/storages/KeyBuilderCS.js +23 -5
  22. package/cjs/storages/dataLoader.js +1 -1
  23. package/cjs/storages/inLocalStorage/MySegmentsCacheInLocal.js +29 -52
  24. package/cjs/storages/inLocalStorage/index.js +6 -2
  25. package/cjs/storages/inMemory/InMemoryStorageCS.js +5 -0
  26. package/cjs/storages/inMemory/MySegmentsCacheInMemory.js +9 -40
  27. package/cjs/storages/inMemory/SplitsCacheInMemory.js +8 -8
  28. package/cjs/storages/inMemory/TelemetryCacheInMemory.js +7 -10
  29. package/cjs/storages/pluggable/inMemoryWrapper.js +1 -1
  30. package/cjs/sync/polling/fetchers/mySegmentsFetcher.js +5 -8
  31. package/cjs/sync/polling/fetchers/segmentChangesFetcher.js +1 -1
  32. package/cjs/sync/polling/pollingManagerCS.js +1 -1
  33. package/cjs/sync/polling/syncTasks/mySegmentsSyncTask.js +2 -2
  34. package/cjs/sync/polling/updaters/mySegmentsUpdater.js +15 -21
  35. package/cjs/sync/streaming/AuthClient/index.js +1 -1
  36. package/cjs/sync/streaming/SSEHandler/index.js +3 -5
  37. package/cjs/sync/streaming/UpdateWorkers/MySegmentsUpdateWorker.js +107 -48
  38. package/cjs/sync/streaming/constants.js +3 -3
  39. package/cjs/sync/streaming/parseUtils.js +14 -9
  40. package/cjs/sync/streaming/pushManager.js +69 -67
  41. package/cjs/utils/constants/index.js +5 -4
  42. package/cjs/utils/settingsValidation/index.js +2 -1
  43. package/esm/evaluator/matchers/index.js +3 -1
  44. package/esm/evaluator/matchers/large_segment.js +12 -0
  45. package/esm/evaluator/matchers/matcherTypes.js +1 -0
  46. package/esm/evaluator/matchersTransform/index.js +4 -1
  47. package/esm/evaluator/matchersTransform/segment.js +3 -1
  48. package/esm/logger/constants.js +1 -1
  49. package/esm/logger/messages/info.js +1 -1
  50. package/esm/logger/messages/warn.js +1 -1
  51. package/esm/readiness/readinessManager.js +5 -6
  52. package/esm/readiness/sdkReadinessManager.js +5 -6
  53. package/esm/sdkClient/identity.js +3 -0
  54. package/esm/sdkClient/sdkClient.js +5 -5
  55. package/esm/sdkClient/sdkClientMethod.js +3 -1
  56. package/esm/sdkClient/sdkClientMethodCS.js +7 -12
  57. package/esm/sdkClient/sdkClientMethodCSWithTT.js +7 -12
  58. package/esm/sdkFactory/index.js +6 -2
  59. package/esm/services/splitApi.js +6 -6
  60. package/esm/storages/AbstractSegmentsCacheSync.js +41 -12
  61. package/esm/storages/AbstractSplitsCacheSync.js +3 -2
  62. package/esm/storages/KeyBuilderCS.js +21 -4
  63. package/esm/storages/dataLoader.js +1 -1
  64. package/esm/storages/inLocalStorage/MySegmentsCacheInLocal.js +29 -52
  65. package/esm/storages/inLocalStorage/index.js +7 -3
  66. package/esm/storages/inMemory/InMemoryStorageCS.js +5 -0
  67. package/esm/storages/inMemory/MySegmentsCacheInMemory.js +9 -40
  68. package/esm/storages/inMemory/SplitsCacheInMemory.js +8 -8
  69. package/esm/storages/inMemory/TelemetryCacheInMemory.js +7 -10
  70. package/esm/storages/pluggable/inMemoryWrapper.js +1 -1
  71. package/esm/sync/polling/fetchers/mySegmentsFetcher.js +5 -8
  72. package/esm/sync/polling/fetchers/segmentChangesFetcher.js +1 -1
  73. package/esm/sync/polling/pollingManagerCS.js +1 -1
  74. package/esm/sync/polling/syncTasks/mySegmentsSyncTask.js +2 -2
  75. package/esm/sync/polling/updaters/mySegmentsUpdater.js +15 -21
  76. package/esm/sync/streaming/AuthClient/index.js +1 -1
  77. package/esm/sync/streaming/SSEHandler/index.js +4 -6
  78. package/esm/sync/streaming/UpdateWorkers/MySegmentsUpdateWorker.js +108 -49
  79. package/esm/sync/streaming/constants.js +2 -2
  80. package/esm/sync/streaming/parseUtils.js +12 -8
  81. package/esm/sync/streaming/pushManager.js +72 -70
  82. package/esm/utils/constants/index.js +3 -2
  83. package/esm/utils/settingsValidation/index.js +2 -1
  84. package/package.json +1 -1
  85. package/src/dtos/types.ts +21 -7
  86. package/src/evaluator/matchers/index.ts +2 -0
  87. package/src/evaluator/matchers/large_segment.ts +18 -0
  88. package/src/evaluator/matchers/matcherTypes.ts +1 -0
  89. package/src/evaluator/matchersTransform/index.ts +4 -1
  90. package/src/evaluator/matchersTransform/segment.ts +5 -3
  91. package/src/logger/constants.ts +1 -1
  92. package/src/logger/messages/info.ts +1 -1
  93. package/src/logger/messages/warn.ts +1 -1
  94. package/src/readiness/readinessManager.ts +7 -5
  95. package/src/readiness/sdkReadinessManager.ts +7 -7
  96. package/src/readiness/types.ts +2 -2
  97. package/src/sdkClient/identity.ts +5 -0
  98. package/src/sdkClient/sdkClient.ts +5 -5
  99. package/src/sdkClient/sdkClientMethod.ts +4 -1
  100. package/src/sdkClient/sdkClientMethodCS.ts +7 -13
  101. package/src/sdkClient/sdkClientMethodCSWithTT.ts +7 -13
  102. package/src/sdkFactory/index.ts +8 -4
  103. package/src/sdkFactory/types.ts +2 -1
  104. package/src/services/splitApi.ts +7 -7
  105. package/src/services/splitHttpClient.ts +1 -1
  106. package/src/services/types.ts +2 -2
  107. package/src/storages/AbstractSegmentsCacheSync.ts +53 -12
  108. package/src/storages/AbstractSplitsCacheSync.ts +4 -3
  109. package/src/storages/KeyBuilderCS.ts +34 -5
  110. package/src/storages/dataLoader.ts +1 -1
  111. package/src/storages/inLocalStorage/MySegmentsCacheInLocal.ts +29 -59
  112. package/src/storages/inLocalStorage/index.ts +8 -4
  113. package/src/storages/inMemory/InMemoryStorageCS.ts +5 -0
  114. package/src/storages/inMemory/MySegmentsCacheInMemory.ts +10 -44
  115. package/src/storages/inMemory/SplitsCacheInMemory.ts +7 -8
  116. package/src/storages/inMemory/TelemetryCacheInMemory.ts +7 -11
  117. package/src/storages/pluggable/inMemoryWrapper.ts +1 -1
  118. package/src/storages/types.ts +11 -7
  119. package/src/sync/polling/fetchers/mySegmentsFetcher.ts +8 -10
  120. package/src/sync/polling/fetchers/segmentChangesFetcher.ts +1 -1
  121. package/src/sync/polling/fetchers/types.ts +3 -2
  122. package/src/sync/polling/pollingManagerCS.ts +4 -4
  123. package/src/sync/polling/syncTasks/mySegmentsSyncTask.ts +4 -5
  124. package/src/sync/polling/types.ts +7 -6
  125. package/src/sync/polling/updaters/mySegmentsUpdater.ts +19 -22
  126. package/src/sync/streaming/AuthClient/index.ts +1 -1
  127. package/src/sync/streaming/SSEClient/index.ts +4 -6
  128. package/src/sync/streaming/SSEHandler/index.ts +5 -8
  129. package/src/sync/streaming/SSEHandler/types.ts +15 -15
  130. package/src/sync/streaming/UpdateWorkers/MySegmentsUpdateWorker.ts +116 -49
  131. package/src/sync/streaming/UpdateWorkers/SegmentsUpdateWorker.ts +1 -1
  132. package/src/sync/streaming/UpdateWorkers/SplitsUpdateWorker.ts +1 -1
  133. package/src/sync/streaming/UpdateWorkers/types.ts +2 -2
  134. package/src/sync/streaming/constants.ts +2 -2
  135. package/src/sync/streaming/parseUtils.ts +19 -11
  136. package/src/sync/streaming/pushManager.ts +73 -72
  137. package/src/sync/streaming/types.ts +10 -10
  138. package/src/sync/submitters/types.ts +8 -5
  139. package/src/types.ts +7 -1
  140. package/src/utils/constants/index.ts +3 -2
  141. package/src/utils/settingsValidation/index.ts +3 -2
  142. package/src/utils/settingsValidation/types.ts +1 -1
  143. package/types/dtos/types.d.ts +18 -7
  144. package/types/evaluator/matchersTransform/segment.d.ts +2 -2
  145. package/types/logger/constants.d.ts +1 -1
  146. package/types/readiness/readinessManager.d.ts +2 -2
  147. package/types/readiness/sdkReadinessManager.d.ts +2 -3
  148. package/types/readiness/types.d.ts +2 -2
  149. package/types/sdkClient/identity.d.ts +0 -4
  150. package/types/sdkClient/sdkClientMethod.d.ts +1 -1
  151. package/types/sdkFactory/types.d.ts +2 -1
  152. package/types/services/splitApi.d.ts +1 -1
  153. package/types/services/splitHttpClient.d.ts +1 -1
  154. package/types/services/types.d.ts +2 -2
  155. package/types/storages/AbstractMySegmentsCacheSync.d.ts +39 -0
  156. package/types/storages/AbstractSegmentsCacheSync.d.ts +9 -11
  157. package/types/storages/AbstractSplitsCacheSync.d.ts +1 -1
  158. package/types/storages/KeyBuilderCS.d.ts +9 -2
  159. package/types/storages/inLocalStorage/MySegmentsCacheInLocal.d.ts +4 -14
  160. package/types/storages/inMemory/MySegmentsCacheInMemory.d.ts +3 -9
  161. package/types/storages/inMemory/SplitsCacheInMemory.d.ts +1 -1
  162. package/types/storages/inMemory/TelemetryCacheInMemory.d.ts +4 -6
  163. package/types/storages/pluggable/inMemoryWrapper.d.ts +1 -1
  164. package/types/storages/types.d.ts +7 -5
  165. package/types/sync/polling/fetchers/mySegmentsFetcher.d.ts +2 -2
  166. package/types/sync/polling/fetchers/types.d.ts +2 -2
  167. package/types/sync/polling/syncTasks/mySegmentsSyncTask.d.ts +2 -2
  168. package/types/sync/polling/types.d.ts +7 -4
  169. package/types/sync/polling/updaters/mySegmentsUpdater.d.ts +4 -3
  170. package/types/sync/streaming/SSEHandler/types.d.ts +16 -14
  171. package/types/sync/streaming/UpdateWorkers/MySegmentsUpdateWorker.d.ts +4 -2
  172. package/types/sync/streaming/UpdateWorkers/SegmentsUpdateWorker.d.ts +2 -1
  173. package/types/sync/streaming/UpdateWorkers/SplitsUpdateWorker.d.ts +3 -2
  174. package/types/sync/streaming/UpdateWorkers/types.d.ts +2 -2
  175. package/types/sync/streaming/constants.d.ts +2 -2
  176. package/types/sync/streaming/parseUtils.d.ts +4 -5
  177. package/types/sync/streaming/types.d.ts +8 -8
  178. package/types/sync/submitters/types.d.ts +7 -4
  179. package/types/types.d.ts +7 -1
  180. package/types/utils/constants/index.d.ts +3 -2
  181. package/types/utils/settingsValidation/types.d.ts +1 -1
@@ -13,7 +13,7 @@ var SplitsCacheInMemory = /** @class */ (function (_super) {
13
13
  _this.splitsCache = {};
14
14
  _this.ttCache = {};
15
15
  _this.changeNumber = -1;
16
- _this.splitsWithSegmentsCount = 0;
16
+ _this.segmentsCount = 0;
17
17
  _this.flagSetsCache = {};
18
18
  _this.flagSetsFilter = splitFiltersValidation ? splitFiltersValidation.groupedFilters.bySet : [];
19
19
  return _this;
@@ -22,7 +22,7 @@ var SplitsCacheInMemory = /** @class */ (function (_super) {
22
22
  this.splitsCache = {};
23
23
  this.ttCache = {};
24
24
  this.changeNumber = -1;
25
- this.splitsWithSegmentsCount = 0;
25
+ this.segmentsCount = 0;
26
26
  };
27
27
  SplitsCacheInMemory.prototype.addSplit = function (name, split) {
28
28
  var previousSplit = this.getSplit(name);
@@ -32,9 +32,9 @@ var SplitsCacheInMemory = /** @class */ (function (_super) {
32
32
  if (!this.ttCache[previousTtName])
33
33
  delete this.ttCache[previousTtName];
34
34
  this.removeFromFlagSets(previousSplit.name, previousSplit.sets);
35
- if (usesSegments(previousSplit)) { // Substract from segments count for the previous version of this Split.
36
- this.splitsWithSegmentsCount--;
37
- }
35
+ // Subtract from segments count for the previous version of this Split
36
+ if (usesSegments(previousSplit))
37
+ this.segmentsCount--;
38
38
  }
39
39
  if (split) {
40
40
  // Store the Split.
@@ -45,7 +45,7 @@ var SplitsCacheInMemory = /** @class */ (function (_super) {
45
45
  this.addToFlagSets(split);
46
46
  // Add to segments count for the new version of the Split
47
47
  if (usesSegments(split))
48
- this.splitsWithSegmentsCount++;
48
+ this.segmentsCount++;
49
49
  return true;
50
50
  }
51
51
  else {
@@ -64,7 +64,7 @@ var SplitsCacheInMemory = /** @class */ (function (_super) {
64
64
  this.removeFromFlagSets(split.name, split.sets);
65
65
  // Update the segments count.
66
66
  if (usesSegments(split))
67
- this.splitsWithSegmentsCount--;
67
+ this.segmentsCount--;
68
68
  return true;
69
69
  }
70
70
  else {
@@ -88,7 +88,7 @@ var SplitsCacheInMemory = /** @class */ (function (_super) {
88
88
  return isFiniteNumber(this.ttCache[trafficType]) && this.ttCache[trafficType] > 0;
89
89
  };
90
90
  SplitsCacheInMemory.prototype.usesSegments = function () {
91
- return this.getChangeNumber() === -1 || this.splitsWithSegmentsCount > 0;
91
+ return this.getChangeNumber() === -1 || this.segmentsCount > 0;
92
92
  };
93
93
  SplitsCacheInMemory.prototype.getNamesByFlagSets = function (flagSets) {
94
94
  var _this = this;
@@ -18,9 +18,10 @@ export function shouldRecordTelemetry(_a) {
18
18
  return settings.mode !== LOCALHOST_MODE && (settings.core.key === undefined || Math.random() <= ACCEPTANCE_RANGE);
19
19
  }
20
20
  var TelemetryCacheInMemory = /** @class */ (function () {
21
- function TelemetryCacheInMemory(splits, segments) {
21
+ function TelemetryCacheInMemory(splits, segments, largeSegments) {
22
22
  this.splits = splits;
23
23
  this.segments = segments;
24
+ this.largeSegments = largeSegments;
24
25
  // isEmpty flag
25
26
  this.e = true;
26
27
  this.notReadyUsage = 0;
@@ -36,10 +37,7 @@ var TelemetryCacheInMemory = /** @class */ (function () {
36
37
  this.tags = [];
37
38
  this.exceptions = {};
38
39
  this.latencies = {};
39
- this.updatesFromSSE = {
40
- sp: 0,
41
- ms: 0
42
- };
40
+ this.updatesFromSSE = {};
43
41
  }
44
42
  TelemetryCacheInMemory.prototype.isEmpty = function () { return this.e; };
45
43
  TelemetryCacheInMemory.prototype.clear = function () { };
@@ -59,6 +57,8 @@ var TelemetryCacheInMemory = /** @class */ (function () {
59
57
  spC: this.splits && this.splits.getSplitNames().length,
60
58
  seC: this.segments && this.segments.getRegisteredSegments().length,
61
59
  skC: this.segments && this.segments.getKeysCount(),
60
+ lsC: this.largeSegments && this.largeSegments.getRegisteredSegments().length,
61
+ lskC: this.largeSegments && this.largeSegments.getKeysCount(),
62
62
  sL: this.getSessionLength(),
63
63
  eQ: this.getEventStats(QUEUED),
64
64
  eD: this.getEventStats(DROPPED),
@@ -190,14 +190,11 @@ var TelemetryCacheInMemory = /** @class */ (function () {
190
190
  };
191
191
  TelemetryCacheInMemory.prototype.popUpdatesFromSSE = function () {
192
192
  var result = this.updatesFromSSE;
193
- this.updatesFromSSE = {
194
- sp: 0,
195
- ms: 0,
196
- };
193
+ this.updatesFromSSE = {};
197
194
  return result;
198
195
  };
199
196
  TelemetryCacheInMemory.prototype.recordUpdatesFromSSE = function (type) {
200
- this.updatesFromSSE[type]++;
197
+ this.updatesFromSSE[type] = (this.updatesFromSSE[type] || 0) + 1;
201
198
  this.e = false;
202
199
  };
203
200
  return TelemetryCacheInMemory;
@@ -5,7 +5,7 @@ import { setToArray, _Set } from '../../utils/lang/sets';
5
5
  * The `_cache` property is the object were items are stored.
6
6
  * Intended for testing purposes.
7
7
  *
8
- * @param connDelay delay in millis for `connect` resolve. If not provided, `connect` resolves inmediatelly.
8
+ * @param connDelay delay in millis for `connect` resolve. If not provided, `connect` resolves immediately.
9
9
  */
10
10
  export function inMemoryWrapperFactory(connDelay) {
11
11
  var _cache = {};
@@ -2,16 +2,13 @@
2
2
  * Factory of MySegments fetcher.
3
3
  * MySegments fetcher is a wrapper around `mySegments` API service that parses the response and handle errors.
4
4
  */
5
- export function mySegmentsFetcherFactory(fetchMySegments) {
6
- return function mySegmentsFetcher(userMatchingKey, noCache,
7
- // Optional decorator for `fetchMySegments` promise, such as timeout or time tracker
5
+ export function mySegmentsFetcherFactory(fetchMemberships) {
6
+ return function mySegmentsFetcher(userMatchingKey, noCache, till,
7
+ // Optional decorator for `fetchMemberships` promise, such as timeout or time tracker
8
8
  decorator) {
9
- var mySegmentsPromise = fetchMySegments(userMatchingKey, noCache);
9
+ var mySegmentsPromise = fetchMemberships(userMatchingKey, noCache, till);
10
10
  if (decorator)
11
11
  mySegmentsPromise = decorator(mySegmentsPromise);
12
- // Extract segment names
13
- return mySegmentsPromise
14
- .then(function (resp) { return resp.json(); })
15
- .then(function (json) { return json.mySegments.map(function (segment) { return segment.name; }); });
12
+ return mySegmentsPromise.then(function (resp) { return resp.json(); });
16
13
  };
17
14
  }
@@ -20,7 +20,7 @@ function greedyFetch(fetchSegmentChanges, since, segmentName, noCache, targetTil
20
20
  */
21
21
  export function segmentChangesFetcherFactory(fetchSegmentChanges) {
22
22
  return function segmentChangesFetcher(since, segmentName, noCache, till,
23
- // Optional decorator for `fetchMySegments` promise, such as timeout or time tracker
23
+ // Optional decorator for `fetchSegmentChanges` promise, such as timeout or time tracker
24
24
  decorator) {
25
25
  var segmentsPromise = greedyFetch(fetchSegmentChanges, since, segmentName, noCache, till);
26
26
  if (decorator)
@@ -43,7 +43,7 @@ export function pollingManagerCSFactory(params) {
43
43
  }
44
44
  });
45
45
  function add(matchingKey, readiness, storage) {
46
- var mySegmentsSyncTask = mySegmentsSyncTaskFactory(splitApi.fetchMySegments, storage, readiness, settings, matchingKey);
46
+ var mySegmentsSyncTask = mySegmentsSyncTaskFactory(splitApi.fetchMemberships, storage, readiness, settings, matchingKey);
47
47
  // smart ready
48
48
  function smartReady() {
49
49
  if (!readiness.isReady() && !storage.splits.usesSegments())
@@ -4,6 +4,6 @@ import { mySegmentsUpdaterFactory } from '../updaters/mySegmentsUpdater';
4
4
  /**
5
5
  * Creates a sync task that periodically executes a `mySegmentsUpdater` task
6
6
  */
7
- export function mySegmentsSyncTaskFactory(fetchMySegments, storage, readiness, settings, matchingKey) {
8
- return syncTaskFactory(settings.log, mySegmentsUpdaterFactory(settings.log, mySegmentsFetcherFactory(fetchMySegments), storage.splits, storage.segments, readiness.segments, settings.startup.requestTimeoutBeforeReady, settings.startup.retriesOnFailureBeforeReady, matchingKey), settings.scheduler.segmentsRefreshRate, 'mySegmentsUpdater');
7
+ export function mySegmentsSyncTaskFactory(fetchMemberships, storage, readiness, settings, matchingKey) {
8
+ return syncTaskFactory(settings.log, mySegmentsUpdaterFactory(settings.log, mySegmentsFetcherFactory(fetchMemberships), storage, readiness.segments, settings.startup.requestTimeoutBeforeReady, settings.startup.retriesOnFailureBeforeReady, matchingKey), settings.scheduler.segmentsRefreshRate, 'mySegmentsUpdater');
9
9
  }
@@ -1,13 +1,15 @@
1
1
  import { timeout } from '../../../utils/promise/timeout';
2
2
  import { SDK_SEGMENTS_ARRIVED } from '../../../readiness/constants';
3
3
  import { SYNC_MYSEGMENTS_FETCH_RETRY } from '../../../logger/constants';
4
+ import { MEMBERSHIPS_LS_UPDATE } from '../../streaming/constants';
4
5
  /**
5
6
  * factory of MySegments updater, a task that:
6
7
  * - fetches mySegments using `mySegmentsFetcher`
7
8
  * - updates `mySegmentsCache`
8
9
  * - uses `segmentsEventEmitter` to emit events related to segments data updates
9
10
  */
10
- export function mySegmentsUpdaterFactory(log, mySegmentsFetcher, splitsCache, mySegmentsCache, segmentsEventEmitter, requestTimeoutBeforeReady, retriesOnFailureBeforeReady, matchingKey) {
11
+ export function mySegmentsUpdaterFactory(log, mySegmentsFetcher, storage, segmentsEventEmitter, requestTimeoutBeforeReady, retriesOnFailureBeforeReady, matchingKey) {
12
+ var splits = storage.splits, segments = storage.segments, largeSegments = storage.largeSegments;
11
13
  var readyOnAlreadyExistentState = true;
12
14
  var startingUp = true;
13
15
  /** timeout and telemetry decorator for `splitChangesFetcher` promise */
@@ -19,36 +21,27 @@ export function mySegmentsUpdaterFactory(log, mySegmentsFetcher, splitsCache, my
19
21
  // @TODO if allowing pluggable storages, handle async execution
20
22
  function updateSegments(segmentsData) {
21
23
  var shouldNotifyUpdate;
22
- if (Array.isArray(segmentsData)) {
23
- // Update the list of segment names available
24
- shouldNotifyUpdate = mySegmentsCache.resetSegments(segmentsData);
24
+ if (segmentsData.type !== undefined) {
25
+ shouldNotifyUpdate = segmentsData.type === MEMBERSHIPS_LS_UPDATE ?
26
+ largeSegments.resetSegments(segmentsData) :
27
+ segments.resetSegments(segmentsData);
25
28
  }
26
29
  else {
27
- // Add/Delete the segment
28
- var name_1 = segmentsData.name, add = segmentsData.add;
29
- if (mySegmentsCache.isInSegment(name_1) !== add) {
30
- shouldNotifyUpdate = true;
31
- if (add)
32
- mySegmentsCache.addToSegment(name_1);
33
- else
34
- mySegmentsCache.removeFromSegment(name_1);
35
- }
36
- else {
37
- shouldNotifyUpdate = false;
38
- }
30
+ shouldNotifyUpdate = segments.resetSegments(segmentsData.ms || {});
31
+ shouldNotifyUpdate = largeSegments.resetSegments(segmentsData.ls || {}) || shouldNotifyUpdate;
39
32
  }
40
33
  // Notify update if required
41
- if (splitsCache.usesSegments() && (shouldNotifyUpdate || readyOnAlreadyExistentState)) {
34
+ if (splits.usesSegments() && (shouldNotifyUpdate || readyOnAlreadyExistentState)) {
42
35
  readyOnAlreadyExistentState = false;
43
36
  segmentsEventEmitter.emit(SDK_SEGMENTS_ARRIVED);
44
37
  }
45
38
  }
46
- function _mySegmentsUpdater(retry, segmentsData, noCache) {
39
+ function _mySegmentsUpdater(retry, segmentsData, noCache, till) {
47
40
  var updaterPromise = segmentsData ?
48
41
  // If segmentsData is provided, there is no need to fetch mySegments
49
42
  new Promise(function (res) { updateSegments(segmentsData); res(true); }) :
50
43
  // If not provided, fetch mySegments
51
- mySegmentsFetcher(matchingKey, noCache, _promiseDecorator).then(function (segments) {
44
+ mySegmentsFetcher(matchingKey, noCache, till, _promiseDecorator).then(function (segments) {
52
45
  // Only when we have downloaded segments completely, we should not keep retrying anymore
53
46
  startingUp = false;
54
47
  updateSegments(segments);
@@ -75,8 +68,9 @@ export function mySegmentsUpdaterFactory(log, mySegmentsFetcher, splitsCache, my
75
68
  * (2) an object with a segment name and action (true: add, or false: delete) to update the storage,
76
69
  * (3) or `undefined`, for which the updater will fetch mySegments in order to sync the storage.
77
70
  * @param {boolean | undefined} noCache true to revalidate data to fetch
71
+ * @param {boolean | undefined} till query param to bypass CDN requests
78
72
  */
79
- return function mySegmentsUpdater(segmentsData, noCache) {
80
- return _mySegmentsUpdater(0, segmentsData, noCache);
73
+ return function mySegmentsUpdater(segmentsData, noCache, till) {
74
+ return _mySegmentsUpdater(0, segmentsData, noCache, till);
81
75
  };
82
76
  }
@@ -10,7 +10,7 @@ import { hash } from '../../../utils/murmur3/murmur3';
10
10
  export function authenticateFactory(fetchAuth) {
11
11
  /**
12
12
  * Run authentication requests to Auth Server, and returns a promise that resolves with the decoded JTW token.
13
- * @param {string[] | undefined} userKeys set of user Keys to track MY_SEGMENTS_CHANGES. It is undefined for server-side API.
13
+ * @param {string[] | undefined} userKeys set of user Keys to track membership updates. It is undefined for server-side API.
14
14
  */
15
15
  return function authenticate(userKeys) {
16
16
  return fetchAuth(userKeys)
@@ -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 } from '../constants';
3
+ import { PUSH_RETRYABLE_ERROR, PUSH_NONRETRYABLE_ERROR, OCCUPANCY, CONTROL, SEGMENT_UPDATE, SPLIT_KILL, SPLIT_UPDATE, MEMBERSHIPS_MS_UPDATE, MEMBERSHIPS_LS_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
  /**
@@ -65,20 +65,18 @@ export function SSEHandlerFactory(log, pushEmitter, telemetryTracker) {
65
65
  }
66
66
  var parsedData = messageWithParsedData.parsedData, data = messageWithParsedData.data, channel = messageWithParsedData.channel, timestamp = messageWithParsedData.timestamp;
67
67
  log.debug(STREAMING_NEW_MESSAGE, [data]);
68
- // we only handle update events if streaming is up.
68
+ // we only handle update events if streaming is up
69
69
  if (!notificationKeeper.isStreamingUp() && [OCCUPANCY, CONTROL].indexOf(parsedData.type) === -1)
70
70
  return;
71
71
  switch (parsedData.type) {
72
72
  /* update events */
73
73
  case SPLIT_UPDATE:
74
74
  case SEGMENT_UPDATE:
75
- case MY_SEGMENTS_UPDATE_V2:
75
+ case MEMBERSHIPS_MS_UPDATE:
76
+ case MEMBERSHIPS_LS_UPDATE:
76
77
  case SPLIT_KILL:
77
78
  pushEmitter.emit(parsedData.type, parsedData);
78
79
  break;
79
- case MY_SEGMENTS_UPDATE:
80
- pushEmitter.emit(parsedData.type, parsedData, channel);
81
- break;
82
80
  /* occupancy & control events, handled by NotificationManagerKeeper */
83
81
  case OCCUPANCY:
84
82
  notificationKeeper.handleOccupancyEvent(parsedData.metrics.publishers, channel, timestamp);
@@ -1,61 +1,120 @@
1
1
  import { Backoff } from '../../../utils/Backoff';
2
- import { MY_SEGMENT } from '../../../utils/constants';
2
+ import { MEMBERSHIPS } from '../../../utils/constants';
3
+ import { FETCH_BACKOFF_MAX_RETRIES } from './constants';
4
+ import { MEMBERSHIPS_LS_UPDATE, MEMBERSHIPS_MS_UPDATE } from '../constants';
3
5
  /**
4
6
  * MySegmentsUpdateWorker factory
5
7
  */
6
- export function MySegmentsUpdateWorker(mySegmentsSyncTask, telemetryTracker) {
7
- var maxChangeNumber = 0; // keeps the maximum changeNumber among queued events
8
- var currentChangeNumber = -1;
9
- var handleNewEvent = false;
10
- var isHandlingEvent;
11
- var _segmentsData; // keeps the segmentsData (if included in notification payload) from the queued event with maximum changeNumber
12
- var backoff = new Backoff(__handleMySegmentsUpdateCall);
13
- function __handleMySegmentsUpdateCall() {
14
- isHandlingEvent = true;
15
- if (maxChangeNumber > currentChangeNumber) {
16
- handleNewEvent = false;
17
- var currentMaxChangeNumber_1 = maxChangeNumber;
18
- // fetch mySegments revalidating data if cached
19
- mySegmentsSyncTask.execute(_segmentsData, true).then(function (result) {
20
- if (!isHandlingEvent)
21
- return; // halt if `stop` has been called
22
- if (result !== false) { // Unlike `Splits|SegmentsUpdateWorker`, we cannot use `mySegmentsCache.getChangeNumber` since `/mySegments` endpoint doesn't provide this value.
23
- if (_segmentsData)
24
- telemetryTracker.trackUpdatesFromSSE(MY_SEGMENT);
25
- currentChangeNumber = Math.max(currentChangeNumber, currentMaxChangeNumber_1); // use `currentMaxChangeNumber`, in case that `maxChangeNumber` was updated during fetch.
26
- }
27
- if (handleNewEvent) {
28
- __handleMySegmentsUpdateCall();
29
- }
30
- else {
31
- backoff.scheduleCall();
32
- }
33
- });
34
- }
35
- else {
36
- isHandlingEvent = false;
8
+ export function MySegmentsUpdateWorker(log, storage, mySegmentsSyncTask, telemetryTracker) {
9
+ var _a;
10
+ var _delay;
11
+ var _delayTimeoutID;
12
+ function createUpdateWorker(mySegmentsCache) {
13
+ var maxChangeNumber = 0; // keeps the maximum changeNumber among queued events
14
+ var currentChangeNumber = -1;
15
+ var handleNewEvent = false;
16
+ var isHandlingEvent;
17
+ var cdnBypass;
18
+ var _segmentsData; // keeps the segmentsData (if included in notification payload) from the queued event with maximum changeNumber
19
+ var backoff = new Backoff(__handleMySegmentsUpdateCall);
20
+ function __handleMySegmentsUpdateCall() {
21
+ isHandlingEvent = true;
22
+ if (maxChangeNumber > Math.max(currentChangeNumber, mySegmentsCache.getChangeNumber())) {
23
+ handleNewEvent = false;
24
+ var currentMaxChangeNumber_1 = maxChangeNumber;
25
+ // fetch mySegments revalidating data if cached
26
+ var syncTask = _delay ?
27
+ new Promise(function (res) {
28
+ _delayTimeoutID = setTimeout(function () {
29
+ _delay = undefined;
30
+ mySegmentsSyncTask.execute(_segmentsData, true, cdnBypass ? maxChangeNumber : undefined).then(res);
31
+ }, _delay);
32
+ }) :
33
+ mySegmentsSyncTask.execute(_segmentsData, true, cdnBypass ? maxChangeNumber : undefined);
34
+ syncTask.then(function (result) {
35
+ if (!isHandlingEvent)
36
+ return; // halt if `stop` has been called
37
+ if (result !== false) { // Unlike `Splits|SegmentsUpdateWorker`, `mySegmentsCache.getChangeNumber` can be -1, since `/memberships` change number is optional
38
+ var storageChangeNumber = mySegmentsCache.getChangeNumber();
39
+ currentChangeNumber = storageChangeNumber > -1 ?
40
+ storageChangeNumber :
41
+ Math.max(currentChangeNumber, currentMaxChangeNumber_1); // use `currentMaxChangeNumber`, in case that `maxChangeNumber` was updated during fetch.
42
+ }
43
+ if (handleNewEvent) {
44
+ __handleMySegmentsUpdateCall();
45
+ }
46
+ else {
47
+ if (_segmentsData)
48
+ telemetryTracker.trackUpdatesFromSSE(MEMBERSHIPS);
49
+ var attempts = backoff.attempts + 1;
50
+ if (maxChangeNumber <= currentChangeNumber) {
51
+ log.debug("Refresh completed" + (cdnBypass ? ' bypassing the CDN' : '') + " in " + attempts + " attempts.");
52
+ isHandlingEvent = false;
53
+ return;
54
+ }
55
+ if (attempts < FETCH_BACKOFF_MAX_RETRIES) {
56
+ backoff.scheduleCall();
57
+ return;
58
+ }
59
+ if (cdnBypass) {
60
+ log.debug("No changes fetched after " + attempts + " attempts with CDN bypassed.");
61
+ isHandlingEvent = false;
62
+ }
63
+ else {
64
+ backoff.reset();
65
+ cdnBypass = true;
66
+ __handleMySegmentsUpdateCall();
67
+ }
68
+ }
69
+ });
70
+ }
71
+ else {
72
+ isHandlingEvent = false;
73
+ }
37
74
  }
75
+ return {
76
+ /**
77
+ * Invoked by NotificationProcessor on MY_(LARGE)_SEGMENTS_UPDATE notifications
78
+ *
79
+ * @param changeNumber change number of the notification
80
+ * @param segmentsData data for KeyList or SegmentRemoval instant updates
81
+ * @param delay optional time to wait for BoundedFetchRequest or BoundedFetchRequest updates
82
+ */
83
+ put: function (mySegmentsData, payload, delay) {
84
+ var type = mySegmentsData.type, cn = mySegmentsData.cn;
85
+ // Discard event if it is outdated or there is a pending fetch request (_delay is set), but update target change number
86
+ if (cn <= Math.max(currentChangeNumber, mySegmentsCache.getChangeNumber()) || cn <= maxChangeNumber)
87
+ return;
88
+ maxChangeNumber = cn;
89
+ if (_delay)
90
+ return;
91
+ handleNewEvent = true;
92
+ cdnBypass = false;
93
+ _segmentsData = payload && { type: type, cn: cn, added: payload.added, removed: payload.removed };
94
+ _delay = delay;
95
+ if (backoff.timeoutID || !isHandlingEvent)
96
+ __handleMySegmentsUpdateCall();
97
+ backoff.reset();
98
+ },
99
+ stop: function () {
100
+ clearTimeout(_delayTimeoutID);
101
+ _delay = undefined;
102
+ isHandlingEvent = false;
103
+ backoff.reset();
104
+ }
105
+ };
38
106
  }
107
+ var updateWorkers = (_a = {},
108
+ _a[MEMBERSHIPS_MS_UPDATE] = createUpdateWorker(storage.segments),
109
+ _a[MEMBERSHIPS_LS_UPDATE] = createUpdateWorker(storage.largeSegments),
110
+ _a);
39
111
  return {
40
- /**
41
- * Invoked by NotificationProcessor on MY_SEGMENTS_UPDATE event
42
- *
43
- * @param {number} changeNumber change number of the MY_SEGMENTS_UPDATE notification
44
- * @param {SegmentsData | undefined} segmentsData might be undefined
45
- */
46
- put: function (changeNumber, segmentsData) {
47
- if (changeNumber <= currentChangeNumber || changeNumber <= maxChangeNumber)
48
- return;
49
- maxChangeNumber = changeNumber;
50
- handleNewEvent = true;
51
- _segmentsData = segmentsData;
52
- if (backoff.timeoutID || !isHandlingEvent)
53
- __handleMySegmentsUpdateCall();
54
- backoff.reset();
112
+ put: function (mySegmentsData, payload, delay) {
113
+ updateWorkers[mySegmentsData.type].put(mySegmentsData, payload, delay);
55
114
  },
56
115
  stop: function () {
57
- isHandlingEvent = false;
58
- backoff.reset();
116
+ updateWorkers[MEMBERSHIPS_MS_UPDATE].stop();
117
+ updateWorkers[MEMBERSHIPS_LS_UPDATE].stop();
59
118
  }
60
119
  };
61
120
  }
@@ -22,8 +22,8 @@ export var PUSH_SUBSYSTEM_UP = 'PUSH_SUBSYSTEM_UP';
22
22
  */
23
23
  export var PUSH_SUBSYSTEM_DOWN = 'PUSH_SUBSYSTEM_DOWN';
24
24
  // Update-type push notifications, handled by NotificationProcessor
25
- export var MY_SEGMENTS_UPDATE = 'MY_SEGMENTS_UPDATE';
26
- export var MY_SEGMENTS_UPDATE_V2 = 'MY_SEGMENTS_UPDATE_V2';
25
+ export var MEMBERSHIPS_MS_UPDATE = 'MEMBERSHIPS_MS_UPDATE';
26
+ export var MEMBERSHIPS_LS_UPDATE = 'MEMBERSHIPS_LS_UPDATE';
27
27
  export var SEGMENT_UPDATE = 'SEGMENT_UPDATE';
28
28
  export var SPLIT_KILL = 'SPLIT_KILL';
29
29
  export var SPLIT_UPDATE = 'SPLIT_UPDATE';
@@ -1,5 +1,6 @@
1
1
  import { algorithms } from '../../utils/decompress';
2
2
  import { decodeFromBase64 } from '../../utils/base64';
3
+ import { hash } from '../../utils/murmur3/murmur3';
3
4
  var GZIP = 1;
4
5
  var ZLIB = 2;
5
6
  function Uint8ArrayToString(myUint8Arr) {
@@ -74,14 +75,17 @@ export function isInBitmap(bitmap, hash64hex) {
74
75
  }
75
76
  /**
76
77
  * Parse feature flags notifications for instant feature flag updates
77
- *
78
- * @param {ISplitUpdateData} data
79
- * @returns {KeyList}
80
78
  */
81
79
  export function parseFFUpdatePayload(compression, data) {
82
- var avoidPrecisionLoss = false;
83
- if (compression > 0)
84
- return parseKeyList(data, compression, avoidPrecisionLoss);
85
- else
86
- return JSON.parse(decodeFromBase64(data));
80
+ return compression > 0 ?
81
+ parseKeyList(data, compression, false) :
82
+ JSON.parse(decodeFromBase64(data));
83
+ }
84
+ var DEFAULT_MAX_INTERVAL = 60000;
85
+ export function getDelay(parsedData, matchingKey) {
86
+ if (parsedData.h === 0)
87
+ return 0;
88
+ var interval = parsedData.i || DEFAULT_MAX_INTERVAL;
89
+ var seed = parsedData.s || 0;
90
+ return hash(matchingKey, seed) % interval;
87
91
  }