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