@splitsoftware/splitio-commons 2.1.0-rc.2 → 2.1.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 (174) hide show
  1. package/CHANGES.txt +2 -7
  2. package/README.md +1 -0
  3. package/cjs/evaluator/combiners/and.js +2 -6
  4. package/cjs/evaluator/combiners/ifelseif.js +6 -6
  5. package/cjs/evaluator/condition/index.js +6 -5
  6. package/cjs/evaluator/index.js +7 -7
  7. package/cjs/evaluator/matchers/index.js +3 -1
  8. package/cjs/evaluator/matchers/matcherTypes.js +1 -0
  9. package/cjs/evaluator/matchers/rbsegment.js +43 -0
  10. package/cjs/evaluator/matchersTransform/index.js +4 -0
  11. package/cjs/evaluator/parser/index.js +2 -2
  12. package/cjs/evaluator/value/sanitize.js +1 -0
  13. package/cjs/logger/constants.js +5 -6
  14. package/cjs/logger/messages/debug.js +3 -4
  15. package/cjs/logger/messages/warn.js +1 -1
  16. package/cjs/readiness/readinessManager.js +0 -6
  17. package/cjs/services/splitApi.js +2 -2
  18. package/cjs/storages/AbstractSplitsCacheAsync.js +19 -1
  19. package/cjs/storages/AbstractSplitsCacheSync.js +17 -9
  20. package/cjs/storages/KeyBuilder.js +8 -15
  21. package/cjs/storages/KeyBuilderCS.js +11 -5
  22. package/cjs/storages/KeyBuilderSS.js +3 -0
  23. package/cjs/storages/dataLoader.js +3 -5
  24. package/cjs/storages/inLocalStorage/RBSegmentsCacheInLocal.js +117 -0
  25. package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js +69 -15
  26. package/cjs/storages/inLocalStorage/index.js +7 -5
  27. package/cjs/storages/inMemory/InMemoryStorage.js +3 -0
  28. package/cjs/storages/inMemory/InMemoryStorageCS.js +4 -0
  29. package/cjs/storages/inMemory/RBSegmentsCacheInMemory.js +61 -0
  30. package/cjs/storages/inMemory/SplitsCacheInMemory.js +24 -31
  31. package/cjs/storages/inRedis/RBSegmentsCacheInRedis.js +64 -0
  32. package/cjs/storages/inRedis/SplitsCacheInRedis.js +4 -21
  33. package/cjs/storages/inRedis/constants.js +1 -1
  34. package/cjs/storages/inRedis/index.js +2 -0
  35. package/cjs/storages/pluggable/RBSegmentsCachePluggable.js +64 -0
  36. package/cjs/storages/pluggable/SplitsCachePluggable.js +2 -19
  37. package/cjs/storages/pluggable/index.js +3 -2
  38. package/cjs/sync/offline/syncTasks/fromObjectSyncTask.js +14 -16
  39. package/cjs/sync/polling/fetchers/splitChangesFetcher.js +2 -2
  40. package/cjs/sync/polling/pollingManagerCS.js +7 -7
  41. package/cjs/sync/polling/syncTasks/splitsSyncTask.js +1 -1
  42. package/cjs/sync/polling/updaters/mySegmentsUpdater.js +2 -2
  43. package/cjs/sync/polling/updaters/segmentChangesUpdater.js +1 -1
  44. package/cjs/sync/polling/updaters/splitChangesUpdater.js +62 -51
  45. package/cjs/sync/streaming/SSEHandler/index.js +1 -0
  46. package/cjs/sync/streaming/UpdateWorkers/SplitsUpdateWorker.js +106 -77
  47. package/cjs/sync/streaming/constants.js +2 -1
  48. package/cjs/sync/streaming/pushManager.js +3 -16
  49. package/cjs/sync/syncManagerOnline.js +5 -10
  50. package/cjs/trackers/uniqueKeysTracker.js +1 -1
  51. package/cjs/utils/constants/browser.js +5 -0
  52. package/cjs/utils/constants/index.js +3 -2
  53. package/cjs/utils/settingsValidation/storage/storageCS.js +1 -1
  54. package/esm/evaluator/combiners/and.js +2 -6
  55. package/esm/evaluator/combiners/ifelseif.js +7 -7
  56. package/esm/evaluator/condition/index.js +6 -5
  57. package/esm/evaluator/index.js +7 -7
  58. package/esm/evaluator/matchers/index.js +3 -1
  59. package/esm/evaluator/matchers/matcherTypes.js +1 -0
  60. package/esm/evaluator/matchers/rbsegment.js +39 -0
  61. package/esm/evaluator/matchersTransform/index.js +4 -0
  62. package/esm/evaluator/parser/index.js +2 -2
  63. package/esm/evaluator/value/sanitize.js +1 -0
  64. package/esm/logger/constants.js +2 -3
  65. package/esm/logger/messages/debug.js +3 -4
  66. package/esm/logger/messages/warn.js +1 -1
  67. package/esm/readiness/readinessManager.js +0 -6
  68. package/esm/services/splitApi.js +2 -2
  69. package/esm/storages/AbstractSplitsCacheAsync.js +19 -1
  70. package/esm/storages/AbstractSplitsCacheSync.js +17 -9
  71. package/esm/storages/KeyBuilder.js +8 -15
  72. package/esm/storages/KeyBuilderCS.js +11 -5
  73. package/esm/storages/KeyBuilderSS.js +3 -0
  74. package/esm/storages/dataLoader.js +2 -4
  75. package/esm/storages/inLocalStorage/RBSegmentsCacheInLocal.js +114 -0
  76. package/esm/storages/inLocalStorage/SplitsCacheInLocal.js +69 -15
  77. package/esm/storages/inLocalStorage/index.js +7 -5
  78. package/esm/storages/inMemory/InMemoryStorage.js +3 -0
  79. package/esm/storages/inMemory/InMemoryStorageCS.js +4 -0
  80. package/esm/storages/inMemory/RBSegmentsCacheInMemory.js +58 -0
  81. package/esm/storages/inMemory/SplitsCacheInMemory.js +24 -31
  82. package/esm/storages/inRedis/RBSegmentsCacheInRedis.js +61 -0
  83. package/esm/storages/inRedis/SplitsCacheInRedis.js +4 -21
  84. package/esm/storages/inRedis/constants.js +1 -1
  85. package/esm/storages/inRedis/index.js +2 -0
  86. package/esm/storages/pluggable/RBSegmentsCachePluggable.js +61 -0
  87. package/esm/storages/pluggable/SplitsCachePluggable.js +2 -19
  88. package/esm/storages/pluggable/index.js +3 -2
  89. package/esm/sync/offline/syncTasks/fromObjectSyncTask.js +14 -16
  90. package/esm/sync/polling/fetchers/splitChangesFetcher.js +2 -2
  91. package/esm/sync/polling/pollingManagerCS.js +7 -7
  92. package/esm/sync/polling/syncTasks/splitsSyncTask.js +1 -1
  93. package/esm/sync/polling/updaters/mySegmentsUpdater.js +2 -2
  94. package/esm/sync/polling/updaters/segmentChangesUpdater.js +1 -1
  95. package/esm/sync/polling/updaters/splitChangesUpdater.js +63 -52
  96. package/esm/sync/streaming/SSEHandler/index.js +2 -1
  97. package/esm/sync/streaming/UpdateWorkers/SplitsUpdateWorker.js +102 -73
  98. package/esm/sync/streaming/constants.js +1 -0
  99. package/esm/sync/streaming/pushManager.js +6 -19
  100. package/esm/sync/syncManagerOnline.js +5 -10
  101. package/esm/trackers/uniqueKeysTracker.js +1 -1
  102. package/esm/utils/constants/browser.js +2 -0
  103. package/esm/utils/constants/index.js +2 -1
  104. package/esm/utils/settingsValidation/storage/storageCS.js +1 -1
  105. package/package.json +1 -1
  106. package/src/dtos/types.ts +32 -8
  107. package/src/evaluator/Engine.ts +1 -1
  108. package/src/evaluator/combiners/and.ts +5 -4
  109. package/src/evaluator/combiners/ifelseif.ts +7 -9
  110. package/src/evaluator/condition/engineUtils.ts +1 -1
  111. package/src/evaluator/condition/index.ts +12 -12
  112. package/src/evaluator/index.ts +7 -7
  113. package/src/evaluator/matchers/index.ts +3 -1
  114. package/src/evaluator/matchers/matcherTypes.ts +1 -0
  115. package/src/evaluator/matchers/rbsegment.ts +61 -0
  116. package/src/evaluator/matchersTransform/index.ts +3 -0
  117. package/src/evaluator/parser/index.ts +3 -3
  118. package/src/evaluator/types.ts +2 -2
  119. package/src/evaluator/value/index.ts +2 -2
  120. package/src/evaluator/value/sanitize.ts +5 -4
  121. package/src/logger/constants.ts +2 -3
  122. package/src/logger/messages/debug.ts +3 -4
  123. package/src/logger/messages/warn.ts +1 -1
  124. package/src/readiness/readinessManager.ts +0 -5
  125. package/src/sdkManager/index.ts +1 -1
  126. package/src/services/splitApi.ts +2 -2
  127. package/src/services/types.ts +1 -1
  128. package/src/storages/AbstractSplitsCacheAsync.ts +23 -5
  129. package/src/storages/AbstractSplitsCacheSync.ts +22 -15
  130. package/src/storages/KeyBuilder.ts +9 -17
  131. package/src/storages/KeyBuilderCS.ts +13 -6
  132. package/src/storages/KeyBuilderSS.ts +4 -0
  133. package/src/storages/dataLoader.ts +2 -5
  134. package/src/storages/inLocalStorage/RBSegmentsCacheInLocal.ts +136 -0
  135. package/src/storages/inLocalStorage/SplitsCacheInLocal.ts +80 -16
  136. package/src/storages/inLocalStorage/index.ts +12 -8
  137. package/src/storages/inMemory/InMemoryStorage.ts +3 -0
  138. package/src/storages/inMemory/InMemoryStorageCS.ts +4 -0
  139. package/src/storages/inMemory/RBSegmentsCacheInMemory.ts +68 -0
  140. package/src/storages/inMemory/SplitsCacheInMemory.ts +22 -27
  141. package/src/storages/inRedis/RBSegmentsCacheInRedis.ts +79 -0
  142. package/src/storages/inRedis/SplitsCacheInRedis.ts +4 -21
  143. package/src/storages/inRedis/constants.ts +1 -1
  144. package/src/storages/inRedis/index.ts +2 -0
  145. package/src/storages/pluggable/RBSegmentsCachePluggable.ts +76 -0
  146. package/src/storages/pluggable/SplitsCachePluggable.ts +2 -19
  147. package/src/storages/pluggable/index.ts +3 -2
  148. package/src/storages/types.ts +47 -18
  149. package/src/sync/offline/syncTasks/fromObjectSyncTask.ts +19 -21
  150. package/src/sync/polling/fetchers/splitChangesFetcher.ts +2 -1
  151. package/src/sync/polling/fetchers/types.ts +1 -0
  152. package/src/sync/polling/pollingManagerCS.ts +7 -7
  153. package/src/sync/polling/syncTasks/splitsSyncTask.ts +1 -2
  154. package/src/sync/polling/types.ts +2 -2
  155. package/src/sync/polling/updaters/mySegmentsUpdater.ts +2 -2
  156. package/src/sync/polling/updaters/segmentChangesUpdater.ts +1 -1
  157. package/src/sync/polling/updaters/splitChangesUpdater.ts +74 -63
  158. package/src/sync/streaming/SSEHandler/index.ts +2 -1
  159. package/src/sync/streaming/SSEHandler/types.ts +2 -2
  160. package/src/sync/streaming/UpdateWorkers/SplitsUpdateWorker.ts +98 -68
  161. package/src/sync/streaming/constants.ts +1 -0
  162. package/src/sync/streaming/parseUtils.ts +2 -2
  163. package/src/sync/streaming/pushManager.ts +6 -18
  164. package/src/sync/streaming/types.ts +3 -2
  165. package/src/sync/syncManagerOnline.ts +5 -11
  166. package/src/trackers/uniqueKeysTracker.ts +1 -1
  167. package/src/utils/constants/browser.ts +2 -0
  168. package/src/utils/constants/index.ts +2 -1
  169. package/src/utils/lang/index.ts +2 -2
  170. package/src/utils/settingsValidation/storage/storageCS.ts +1 -1
  171. package/types/splitio.d.ts +1 -25
  172. package/cjs/storages/inLocalStorage/validateCache.js +0 -79
  173. package/esm/storages/inLocalStorage/validateCache.js +0 -75
  174. package/src/storages/inLocalStorage/validateCache.ts +0 -91
@@ -1,9 +1,10 @@
1
1
  import { timeout } from '../../../utils/promise/timeout';
2
- import { SDK_SPLITS_ARRIVED } from '../../../readiness/constants';
3
- import { SYNC_SPLITS_FETCH, SYNC_SPLITS_NEW, SYNC_SPLITS_REMOVED, SYNC_SPLITS_SEGMENTS, SYNC_SPLITS_FETCH_FAILS, SYNC_SPLITS_FETCH_RETRY } from '../../../logger/constants';
2
+ import { SDK_SPLITS_ARRIVED, SDK_SPLITS_CACHE_LOADED } from '../../../readiness/constants';
3
+ import { SYNC_SPLITS_FETCH, SYNC_SPLITS_UPDATE, SYNC_RBS_UPDATE, SYNC_SPLITS_FETCH_FAILS, SYNC_SPLITS_FETCH_RETRY } from '../../../logger/constants';
4
4
  import { startsWith } from '../../../utils/lang';
5
- import { IN_SEGMENT } from '../../../utils/constants';
5
+ import { IN_RULE_BASED_SEGMENT, IN_SEGMENT } from '../../../utils/constants';
6
6
  import { setToArray } from '../../../utils/lang/sets';
7
+ import { SPLIT_UPDATE } from '../../streaming/constants';
7
8
  // Checks that all registered segments have been fetched (changeNumber !== -1 for every segment).
8
9
  // Returns a promise that could be rejected.
9
10
  // @TODO review together with Segments and MySegments storage APIs
@@ -18,13 +19,14 @@ function checkAllSegmentsExist(segments) {
18
19
  * Collect segments from a raw split definition.
19
20
  * Exported for testing purposes.
20
21
  */
21
- export function parseSegments(_a) {
22
- var conditions = _a.conditions;
23
- var segments = new Set();
22
+ export function parseSegments(ruleEntity, matcherType) {
23
+ if (matcherType === void 0) { matcherType = IN_SEGMENT; }
24
+ var _a = ruleEntity, conditions = _a.conditions, excluded = _a.excluded;
25
+ var segments = new Set(excluded && excluded.segments);
24
26
  for (var i = 0; i < conditions.length; i++) {
25
27
  var matchers = conditions[i].matcherGroup.matchers;
26
28
  matchers.forEach(function (matcher) {
27
- if (matcher.matcherType === IN_SEGMENT)
29
+ if (matcher.matcherType === matcherType)
28
30
  segments.add(matcher.userDefinedSegmentMatcherData.segmentName);
29
31
  });
30
32
  }
@@ -54,22 +56,19 @@ function matchFilters(featureFlag, filters) {
54
56
  * i.e., an object with added splits, removed splits and used segments.
55
57
  * Exported for testing purposes.
56
58
  */
57
- export function computeSplitsMutation(entries, filters) {
58
- var segments = new Set();
59
- var computed = entries.reduce(function (accum, split) {
60
- if (split.status === 'ACTIVE' && matchFilters(split, filters)) {
61
- accum.added.push([split.name, split]);
62
- parseSegments(split).forEach(function (segmentName) {
59
+ export function computeMutation(rules, segments, filters) {
60
+ return rules.reduce(function (accum, ruleEntity) {
61
+ if (ruleEntity.status === 'ACTIVE' && (!filters || matchFilters(ruleEntity, filters))) {
62
+ accum.added.push(ruleEntity);
63
+ parseSegments(ruleEntity).forEach(function (segmentName) {
63
64
  segments.add(segmentName);
64
65
  });
65
66
  }
66
67
  else {
67
- accum.removed.push(split.name);
68
+ accum.removed.push(ruleEntity);
68
69
  }
69
70
  return accum;
70
- }, { added: [], removed: [], segments: [] });
71
- computed.segments = setToArray(segments);
72
- return computed;
71
+ }, { added: [], removed: [] });
73
72
  }
74
73
  /**
75
74
  * factory of SplitChanges updater, a task that:
@@ -85,9 +84,10 @@ export function computeSplitsMutation(entries, filters) {
85
84
  * @param requestTimeoutBeforeReady - How long the updater will wait for the request to timeout. Default 0, i.e., never timeout.
86
85
  * @param retriesOnFailureBeforeReady - How many retries on `/splitChanges` we the updater do in case of failure or timeout. Default 0, i.e., no retries.
87
86
  */
88
- export function splitChangesUpdaterFactory(log, splitChangesFetcher, splits, segments, splitFiltersValidation, splitsEventEmitter, requestTimeoutBeforeReady, retriesOnFailureBeforeReady, isClientSide) {
87
+ export function splitChangesUpdaterFactory(log, splitChangesFetcher, storage, splitFiltersValidation, splitsEventEmitter, requestTimeoutBeforeReady, retriesOnFailureBeforeReady, isClientSide) {
89
88
  if (requestTimeoutBeforeReady === void 0) { requestTimeoutBeforeReady = 0; }
90
89
  if (retriesOnFailureBeforeReady === void 0) { retriesOnFailureBeforeReady = 0; }
90
+ var splits = storage.splits, rbSegments = storage.rbSegments, segments = storage.segments;
91
91
  var startingUp = true;
92
92
  /** timeout decorator for `splitChangesFetcher` promise */
93
93
  function _promiseDecorator(promise) {
@@ -95,17 +95,6 @@ export function splitChangesUpdaterFactory(log, splitChangesFetcher, splits, seg
95
95
  promise = timeout(requestTimeoutBeforeReady, promise);
96
96
  return promise;
97
97
  }
98
- /** Returns true if at least one split was updated */
99
- function isThereUpdate(flagsChange) {
100
- var added = flagsChange[1], removed = flagsChange[2];
101
- // There is at least one added or modified feature flag
102
- if (added && added.some(function (update) { return update; }))
103
- return true;
104
- // There is at least one removed feature flag
105
- if (removed && removed.some(function (update) { return update; }))
106
- return true;
107
- return false;
108
- }
109
98
  /**
110
99
  * SplitChanges updater returns a promise that resolves with a `false` boolean value if it fails to fetch splits or synchronize them with the storage.
111
100
  * Returned promise will not be rejected.
@@ -113,35 +102,48 @@ export function splitChangesUpdaterFactory(log, splitChangesFetcher, splits, seg
113
102
  * @param noCache - true to revalidate data to fetch
114
103
  * @param till - query param to bypass CDN requests
115
104
  */
116
- return function splitChangesUpdater(noCache, till, splitUpdateNotification) {
105
+ return function splitChangesUpdater(noCache, till, instantUpdate) {
117
106
  /**
118
107
  * @param since - current changeNumber at splitsCache
119
108
  * @param retry - current number of retry attempts
120
109
  */
121
- function _splitChangesUpdater(since, retry) {
110
+ function _splitChangesUpdater(sinces, retry) {
122
111
  if (retry === void 0) { retry = 0; }
123
- log.debug(SYNC_SPLITS_FETCH, [since]);
124
- return Promise.resolve(splitUpdateNotification ?
125
- { splits: [splitUpdateNotification.payload], till: splitUpdateNotification.changeNumber } :
126
- splitChangesFetcher(since, noCache, till, _promiseDecorator))
112
+ var since = sinces[0], rbSince = sinces[1];
113
+ log.debug(SYNC_SPLITS_FETCH, sinces);
114
+ var fetcherPromise = Promise.resolve(instantUpdate ?
115
+ instantUpdate.type === SPLIT_UPDATE ?
116
+ // IFFU edge case: a change to a flag that adds an IN_RULE_BASED_SEGMENT matcher that is not present yet
117
+ Promise.resolve(rbSegments.contains(parseSegments(instantUpdate.payload, IN_RULE_BASED_SEGMENT))).then(function (contains) {
118
+ return contains ?
119
+ { ff: { d: [instantUpdate.payload], t: instantUpdate.changeNumber } } :
120
+ splitChangesFetcher(since, noCache, till, rbSince, _promiseDecorator);
121
+ }) :
122
+ { rbs: { d: [instantUpdate.payload], t: instantUpdate.changeNumber } } :
123
+ splitChangesFetcher(since, noCache, till, rbSince, _promiseDecorator))
127
124
  .then(function (splitChanges) {
128
125
  startingUp = false;
129
- var mutation = computeSplitsMutation(splitChanges.splits, splitFiltersValidation);
130
- log.debug(SYNC_SPLITS_NEW, [mutation.added.length]);
131
- log.debug(SYNC_SPLITS_REMOVED, [mutation.removed.length]);
132
- log.debug(SYNC_SPLITS_SEGMENTS, [mutation.segments.length]);
133
- // Write into storage
134
- // @TODO call `setChangeNumber` only if the other storage operations have succeeded, in order to keep storage consistency
135
- return Promise.all([
136
- // calling first `setChangenumber` method, to perform cache flush if split filter queryString changed
137
- splits.setChangeNumber(splitChanges.till),
138
- splits.addSplits(mutation.added),
139
- splits.removeSplits(mutation.removed),
140
- segments.registerSegments(mutation.segments)
141
- ]).then(function (flagsChange) {
126
+ var usedSegments = new Set();
127
+ var ffUpdate = false;
128
+ if (splitChanges.ff) {
129
+ var _a = computeMutation(splitChanges.ff.d, usedSegments, splitFiltersValidation), added = _a.added, removed = _a.removed;
130
+ log.debug(SYNC_SPLITS_UPDATE, [added.length, removed.length]);
131
+ ffUpdate = splits.update(added, removed, splitChanges.ff.t);
132
+ }
133
+ var rbsUpdate = false;
134
+ if (splitChanges.rbs) {
135
+ var _b = computeMutation(splitChanges.rbs.d, usedSegments), added = _b.added, removed = _b.removed;
136
+ log.debug(SYNC_RBS_UPDATE, [added.length, removed.length]);
137
+ rbsUpdate = rbSegments.update(added, removed, splitChanges.rbs.t);
138
+ }
139
+ return Promise.all([ffUpdate, rbsUpdate,
140
+ // @TODO if at least 1 segment fetch fails due to 404 and other segments are updated in the storage, SDK_UPDATE is not emitted
141
+ segments.registerSegments(setToArray(usedSegments))
142
+ ]).then(function (_a) {
143
+ var ffChanged = _a[0], rbsChanged = _a[1];
142
144
  if (splitsEventEmitter) {
143
145
  // To emit SDK_SPLITS_ARRIVED for server-side SDK, we must check that all registered segments have been fetched
144
- return Promise.resolve(!splitsEventEmitter.splitsArrived || (since !== splitChanges.till && isThereUpdate(flagsChange) && (isClientSide || checkAllSegmentsExist(segments))))
146
+ return Promise.resolve(!splitsEventEmitter.splitsArrived || ((ffChanged || rbsChanged) && (isClientSide || checkAllSegmentsExist(segments))))
145
147
  .catch(function () { return false; } /** noop. just to handle a possible `checkAllSegmentsExist` rejection, before emitting SDK event */)
146
148
  .then(function (emitSplitsArrivedEvent) {
147
149
  // emit SDK events
@@ -158,15 +160,24 @@ export function splitChangesUpdaterFactory(log, splitChangesFetcher, splits, seg
158
160
  if (startingUp && retriesOnFailureBeforeReady > retry) {
159
161
  retry += 1;
160
162
  log.info(SYNC_SPLITS_FETCH_RETRY, [retry, error]);
161
- return _splitChangesUpdater(since, retry);
163
+ return _splitChangesUpdater(sinces, retry);
162
164
  }
163
165
  else {
164
166
  startingUp = false;
165
167
  }
166
168
  return false;
167
169
  });
170
+ // After triggering the requests, if we have cached splits information let's notify that to emit SDK_READY_FROM_CACHE.
171
+ // Wrapping in a promise since checkCache can be async.
172
+ if (splitsEventEmitter && startingUp) {
173
+ Promise.resolve(splits.checkCache()).then(function (isCacheReady) {
174
+ if (isCacheReady)
175
+ splitsEventEmitter.emit(SDK_SPLITS_CACHE_LOADED);
176
+ });
177
+ }
178
+ return fetcherPromise;
168
179
  }
169
- var sincePromise = Promise.resolve(splits.getChangeNumber()); // `getChangeNumber` never rejects or throws error
170
- return sincePromise.then(_splitChangesUpdater);
180
+ // `getChangeNumber` never rejects or throws error
181
+ return Promise.all([splits.getChangeNumber(), rbSegments.getChangeNumber()]).then(_splitChangesUpdater);
171
182
  };
172
183
  }
@@ -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, SEGMENT_UPDATE, SPLIT_KILL, SPLIT_UPDATE, MEMBERSHIPS_MS_UPDATE, MEMBERSHIPS_LS_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, RB_SEGMENT_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
  /**
@@ -75,6 +75,7 @@ export function SSEHandlerFactory(log, pushEmitter, telemetryTracker) {
75
75
  case MEMBERSHIPS_MS_UPDATE:
76
76
  case MEMBERSHIPS_LS_UPDATE:
77
77
  case SPLIT_KILL:
78
+ case RB_SEGMENT_UPDATE:
78
79
  pushEmitter.emit(parsedData.type, parsedData);
79
80
  break;
80
81
  /* occupancy & control events, handled by NotificationManagerKeeper */
@@ -1,103 +1,132 @@
1
+ import { STREAMING_PARSING_SPLIT_UPDATE } from '../../../logger/constants';
1
2
  import { SDK_SPLITS_ARRIVED } from '../../../readiness/constants';
2
3
  import { Backoff } from '../../../utils/Backoff';
3
4
  import { SPLITS } from '../../../utils/constants';
5
+ import { RB_SEGMENT_UPDATE } from '../constants';
6
+ import { parseFFUpdatePayload } from '../parseUtils';
4
7
  import { FETCH_BACKOFF_BASE, FETCH_BACKOFF_MAX_WAIT, FETCH_BACKOFF_MAX_RETRIES } from './constants';
5
8
  /**
6
9
  * SplitsUpdateWorker factory
7
10
  */
8
- export function SplitsUpdateWorker(log, splitsCache, splitsSyncTask, splitsEventEmitter, telemetryTracker, segmentsSyncTask) {
9
- var maxChangeNumber = 0;
10
- var handleNewEvent = false;
11
- var isHandlingEvent;
12
- var cdnBypass;
13
- var payload;
14
- var backoff = new Backoff(__handleSplitUpdateCall, FETCH_BACKOFF_BASE, FETCH_BACKOFF_MAX_WAIT);
15
- function __handleSplitUpdateCall() {
16
- isHandlingEvent = true;
17
- if (maxChangeNumber > splitsCache.getChangeNumber()) {
18
- handleNewEvent = false;
19
- var splitUpdateNotification_1 = payload ? { payload: payload, changeNumber: maxChangeNumber } : undefined;
20
- // fetch splits revalidating data if cached
21
- splitsSyncTask.execute(true, cdnBypass ? maxChangeNumber : undefined, splitUpdateNotification_1).then(function () {
22
- if (!isHandlingEvent)
23
- return; // halt if `stop` has been called
24
- if (handleNewEvent) {
25
- __handleSplitUpdateCall();
26
- }
27
- else {
28
- if (splitUpdateNotification_1)
29
- telemetryTracker.trackUpdatesFromSSE(SPLITS);
30
- // fetch new registered segments for server-side API. Not retrying on error
31
- if (segmentsSyncTask)
32
- segmentsSyncTask.execute(true);
33
- var attempts = backoff.attempts + 1;
34
- if (maxChangeNumber <= splitsCache.getChangeNumber()) {
35
- log.debug("Refresh completed" + (cdnBypass ? ' bypassing the CDN' : '') + " in " + attempts + " attempts.");
36
- isHandlingEvent = false;
37
- return;
38
- }
39
- if (attempts < FETCH_BACKOFF_MAX_RETRIES) {
40
- backoff.scheduleCall();
41
- return;
42
- }
43
- if (cdnBypass) {
44
- log.debug("No changes fetched after " + attempts + " attempts with CDN bypassed.");
45
- isHandlingEvent = false;
11
+ export function SplitsUpdateWorker(log, storage, splitsSyncTask, splitsEventEmitter, telemetryTracker, segmentsSyncTask) {
12
+ var ff = SplitsUpdateWorker(storage.splits);
13
+ var rbs = SplitsUpdateWorker(storage.rbSegments);
14
+ function SplitsUpdateWorker(cache) {
15
+ var maxChangeNumber = -1;
16
+ var handleNewEvent = false;
17
+ var isHandlingEvent;
18
+ var cdnBypass;
19
+ var instantUpdate;
20
+ var backoff = new Backoff(__handleSplitUpdateCall, FETCH_BACKOFF_BASE, FETCH_BACKOFF_MAX_WAIT);
21
+ function __handleSplitUpdateCall() {
22
+ isHandlingEvent = true;
23
+ if (maxChangeNumber > cache.getChangeNumber()) {
24
+ handleNewEvent = false;
25
+ // fetch splits revalidating data if cached
26
+ splitsSyncTask.execute(true, cdnBypass ? maxChangeNumber : undefined, instantUpdate).then(function () {
27
+ if (!isHandlingEvent)
28
+ return; // halt if `stop` has been called
29
+ if (handleNewEvent) {
30
+ __handleSplitUpdateCall();
46
31
  }
47
32
  else {
48
- backoff.reset();
49
- cdnBypass = true;
50
- __handleSplitUpdateCall();
33
+ if (instantUpdate)
34
+ telemetryTracker.trackUpdatesFromSSE(SPLITS);
35
+ // fetch new registered segments for server-side API. Not retrying on error
36
+ if (segmentsSyncTask)
37
+ segmentsSyncTask.execute(true);
38
+ var attempts = backoff.attempts + 1;
39
+ if (ff.isSync() && rbs.isSync()) {
40
+ log.debug("Refresh completed" + (cdnBypass ? ' bypassing the CDN' : '') + " in " + attempts + " attempts.");
41
+ isHandlingEvent = false;
42
+ return;
43
+ }
44
+ if (attempts < FETCH_BACKOFF_MAX_RETRIES) {
45
+ backoff.scheduleCall();
46
+ return;
47
+ }
48
+ if (cdnBypass) {
49
+ log.debug("No changes fetched after " + attempts + " attempts with CDN bypassed.");
50
+ isHandlingEvent = false;
51
+ }
52
+ else {
53
+ backoff.reset();
54
+ cdnBypass = true;
55
+ __handleSplitUpdateCall();
56
+ }
51
57
  }
52
- }
53
- });
54
- }
55
- else {
56
- isHandlingEvent = false;
57
- }
58
- }
59
- /**
60
- * Invoked by NotificationProcessor on SPLIT_UPDATE event
61
- *
62
- * @param changeNumber - change number of the SPLIT_UPDATE notification
63
- */
64
- function put(_a, _payload) {
65
- var changeNumber = _a.changeNumber, pcn = _a.pcn;
66
- var currentChangeNumber = splitsCache.getChangeNumber();
67
- if (changeNumber <= currentChangeNumber || changeNumber <= maxChangeNumber)
68
- return;
69
- maxChangeNumber = changeNumber;
70
- handleNewEvent = true;
71
- cdnBypass = false;
72
- payload = undefined;
73
- if (_payload && currentChangeNumber === pcn) {
74
- payload = _payload;
58
+ });
59
+ }
60
+ else {
61
+ isHandlingEvent = false;
62
+ }
75
63
  }
76
- if (backoff.timeoutID || !isHandlingEvent)
77
- __handleSplitUpdateCall();
78
- backoff.reset();
64
+ return {
65
+ /**
66
+ * Invoked by NotificationProcessor on SPLIT_UPDATE or RB_SEGMENT_UPDATE event
67
+ *
68
+ * @param changeNumber - change number of the notification
69
+ */
70
+ put: function (_a, payload) {
71
+ var changeNumber = _a.changeNumber, pcn = _a.pcn, type = _a.type;
72
+ var currentChangeNumber = cache.getChangeNumber();
73
+ if (changeNumber <= currentChangeNumber || changeNumber <= maxChangeNumber)
74
+ return;
75
+ maxChangeNumber = changeNumber;
76
+ handleNewEvent = true;
77
+ cdnBypass = false;
78
+ instantUpdate = undefined;
79
+ if (payload && currentChangeNumber === pcn) {
80
+ instantUpdate = { payload: payload, changeNumber: changeNumber, type: type };
81
+ }
82
+ if (backoff.timeoutID || !isHandlingEvent)
83
+ __handleSplitUpdateCall();
84
+ backoff.reset();
85
+ },
86
+ stop: function () {
87
+ isHandlingEvent = false;
88
+ backoff.reset();
89
+ },
90
+ isSync: function () {
91
+ return maxChangeNumber <= cache.getChangeNumber();
92
+ }
93
+ };
79
94
  }
80
95
  return {
81
- put: put,
96
+ put: function (parsedData) {
97
+ if (parsedData.d && parsedData.c !== undefined) {
98
+ try {
99
+ var payload = parseFFUpdatePayload(parsedData.c, parsedData.d);
100
+ if (payload) {
101
+ (parsedData.type === RB_SEGMENT_UPDATE ? rbs : ff).put(parsedData, payload);
102
+ return;
103
+ }
104
+ }
105
+ catch (e) {
106
+ log.warn(STREAMING_PARSING_SPLIT_UPDATE, [parsedData.type, e]);
107
+ }
108
+ }
109
+ (parsedData.type === RB_SEGMENT_UPDATE ? rbs : ff).put(parsedData);
110
+ },
82
111
  /**
83
112
  * Invoked by NotificationProcessor on SPLIT_KILL event
84
113
  *
85
- * @param changeNumber - change number of the SPLIT_UPDATE notification
114
+ * @param changeNumber - change number of the notification
86
115
  * @param splitName - name of split to kill
87
116
  * @param defaultTreatment - default treatment value
88
117
  */
89
118
  killSplit: function (_a) {
90
119
  var changeNumber = _a.changeNumber, splitName = _a.splitName, defaultTreatment = _a.defaultTreatment;
91
- if (splitsCache.killLocally(splitName, defaultTreatment, changeNumber)) {
120
+ if (storage.splits.killLocally(splitName, defaultTreatment, changeNumber)) {
92
121
  // trigger an SDK_UPDATE if Split was killed locally
93
122
  splitsEventEmitter.emit(SDK_SPLITS_ARRIVED, true);
94
123
  }
95
124
  // queues the SplitChanges fetch (only if changeNumber is newer)
96
- put({ changeNumber: changeNumber });
125
+ ff.put({ changeNumber: changeNumber });
97
126
  },
98
127
  stop: function () {
99
- isHandlingEvent = false;
100
- backoff.reset();
128
+ ff.stop();
129
+ rbs.stop();
101
130
  }
102
131
  };
103
132
  }
@@ -27,6 +27,7 @@ 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';
30
+ export var RB_SEGMENT_UPDATE = 'RB_SEGMENT_UPDATE';
30
31
  // Control-type push notifications, handled by NotificationKeeper
31
32
  export var CONTROL = 'CONTROL';
32
33
  export var OCCUPANCY = 'OCCUPANCY';
@@ -8,10 +8,10 @@ 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 { MEMBERSHIPS_MS_UPDATE, MEMBERSHIPS_LS_UPDATE, 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
- import { STREAMING_FALLBACK, STREAMING_REFRESH_TOKEN, STREAMING_CONNECTING, STREAMING_DISABLED, ERROR_STREAMING_AUTH, STREAMING_DISCONNECTING, STREAMING_RECONNECT, STREAMING_PARSING_MEMBERSHIPS_UPDATE, STREAMING_PARSING_SPLIT_UPDATE } from '../../logger/constants';
11
+ import { MEMBERSHIPS_MS_UPDATE, MEMBERSHIPS_LS_UPDATE, PUSH_NONRETRYABLE_ERROR, PUSH_SUBSYSTEM_DOWN, SECONDS_BEFORE_EXPIRATION, SEGMENT_UPDATE, SPLIT_KILL, SPLIT_UPDATE, RB_SEGMENT_UPDATE, PUSH_RETRYABLE_ERROR, PUSH_SUBSYSTEM_UP, ControlType } from './constants';
12
+ import { STREAMING_FALLBACK, STREAMING_REFRESH_TOKEN, STREAMING_CONNECTING, STREAMING_DISABLED, ERROR_STREAMING_AUTH, STREAMING_DISCONNECTING, STREAMING_RECONNECT, STREAMING_PARSING_MEMBERSHIPS_UPDATE } from '../../logger/constants';
13
13
  import { UpdateStrategy } from './SSEHandler/types';
14
- import { getDelay, isInBitmap, parseBitmap, parseFFUpdatePayload, parseKeyList } from './parseUtils';
14
+ import { getDelay, isInBitmap, parseBitmap, parseKeyList } from './parseUtils';
15
15
  import { hash64 } from '../../utils/murmur3/murmur3_64';
16
16
  import { TOKEN_REFRESH, AUTH_REJECTION } from '../../utils/constants';
17
17
  /**
@@ -43,7 +43,7 @@ export function pushManagerFactory(params, pollingManager) {
43
43
  // MySegmentsUpdateWorker (client-side) are initiated in `add` method
44
44
  var segmentsUpdateWorker = userKey ? undefined : SegmentsUpdateWorker(log, pollingManager.segmentsSyncTask, storage.segments);
45
45
  // For server-side we pass the segmentsSyncTask, used by SplitsUpdateWorker to fetch new segments
46
- var splitsUpdateWorker = SplitsUpdateWorker(log, storage.splits, pollingManager.splitsSyncTask, readiness.splits, telemetryTracker, userKey ? undefined : pollingManager.segmentsSyncTask);
46
+ var splitsUpdateWorker = SplitsUpdateWorker(log, storage, pollingManager.splitsSyncTask, readiness.splits, telemetryTracker, userKey ? undefined : pollingManager.segmentsSyncTask);
47
47
  // [Only for client-side] map of hashes to user keys, to dispatch membership update events to the corresponding MySegmentsUpdateWorker
48
48
  var userKeyHashes = {};
49
49
  // [Only for client-side] map of user keys to their corresponding hash64 and MySegmentsUpdateWorkers.
@@ -179,21 +179,8 @@ export function pushManagerFactory(params, pollingManager) {
179
179
  });
180
180
  /** Functions related to synchronization (Queues and Workers in the spec) */
181
181
  pushEmitter.on(SPLIT_KILL, splitsUpdateWorker.killSplit);
182
- pushEmitter.on(SPLIT_UPDATE, function (parsedData) {
183
- if (parsedData.d && parsedData.c !== undefined) {
184
- try {
185
- var payload = parseFFUpdatePayload(parsedData.c, parsedData.d);
186
- if (payload) {
187
- splitsUpdateWorker.put(parsedData, payload);
188
- return;
189
- }
190
- }
191
- catch (e) {
192
- log.warn(STREAMING_PARSING_SPLIT_UPDATE, [e]);
193
- }
194
- }
195
- splitsUpdateWorker.put(parsedData);
196
- });
182
+ pushEmitter.on(SPLIT_UPDATE, splitsUpdateWorker.put);
183
+ pushEmitter.on(RB_SEGMENT_UPDATE, splitsUpdateWorker.put);
197
184
  function handleMySegmentsUpdate(parsedData) {
198
185
  switch (parsedData.u) {
199
186
  case UpdateStrategy.BoundedFetchRequest: {
@@ -3,7 +3,6 @@ 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
5
  import { POLLING, STREAMING, SYNC_MODE_UPDATE } from '../utils/constants';
6
- import { SDK_SPLITS_CACHE_LOADED } from '../readiness/constants';
7
6
  /**
8
7
  * Online SyncManager factory.
9
8
  * Can be used for server-side API, and client-side API with or without multiple clients.
@@ -17,7 +16,7 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
17
16
  * SyncManager factory for modular SDK
18
17
  */
19
18
  return function (params) {
20
- var settings = params.settings, _a = params.settings, log = _a.log, streamingEnabled = _a.streamingEnabled, syncEnabled = _a.sync.enabled, telemetryTracker = params.telemetryTracker, storage = params.storage, readiness = params.readiness;
19
+ var settings = params.settings, _a = params.settings, log = _a.log, streamingEnabled = _a.streamingEnabled, syncEnabled = _a.sync.enabled, telemetryTracker = params.telemetryTracker;
21
20
  /** Polling Manager */
22
21
  var pollingManager = pollingManagerFactory && pollingManagerFactory(params);
23
22
  /** Push Manager */
@@ -65,11 +64,6 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
65
64
  */
66
65
  start: function () {
67
66
  running = true;
68
- if (startFirstTime) {
69
- var isCacheLoaded = storage.validateCache ? storage.validateCache() : false;
70
- if (isCacheLoaded)
71
- Promise.resolve().then(function () { readiness.splits.emit(SDK_SPLITS_CACHE_LOADED); });
72
- }
73
67
  // start syncing splits and segments
74
68
  if (pollingManager) {
75
69
  // If synchronization is disabled pushManager and pollingManager should not start
@@ -78,6 +72,7 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
78
72
  // Doesn't call `syncAll` when the syncManager is resuming
79
73
  if (startFirstTime) {
80
74
  pollingManager.syncAll();
75
+ startFirstTime = false;
81
76
  }
82
77
  pushManager.start();
83
78
  }
@@ -88,12 +83,12 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
88
83
  else {
89
84
  if (startFirstTime) {
90
85
  pollingManager.syncAll();
86
+ startFirstTime = false;
91
87
  }
92
88
  }
93
89
  }
94
90
  // start periodic data recording (events, impressions, telemetry).
95
91
  submitterManager.start(!isConsentGranted(settings));
96
- startFirstTime = false;
97
92
  },
98
93
  /**
99
94
  * Method used to stop/pause the syncManager.
@@ -127,7 +122,7 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
127
122
  if (pushManager) {
128
123
  if (pollingManager.isRunning()) {
129
124
  // if doing polling, we must start the periodic fetch of data
130
- if (storage.splits.usesSegments())
125
+ if (storage.splits.usesSegments() || storage.rbSegments.usesSegments())
131
126
  mySegmentsSyncTask.start();
132
127
  }
133
128
  else {
@@ -137,7 +132,7 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
137
132
  }
138
133
  }
139
134
  else {
140
- if (storage.splits.usesSegments())
135
+ if (storage.splits.usesSegments() || storage.rbSegments.usesSegments())
141
136
  mySegmentsSyncTask.start();
142
137
  }
143
138
  }
@@ -5,7 +5,7 @@ var noopFilterAdapter = {
5
5
  clear: function () { }
6
6
  };
7
7
  /**
8
- * Trackes uniques keys
8
+ * Tracks uniques keys
9
9
  * Unique Keys Tracker will be in charge of checking if the MTK was already sent to the BE in the last period
10
10
  * or schedule to be sent; if not it will be added in an internal cache and sent in the next post.
11
11
  *
@@ -0,0 +1,2 @@
1
+ // This value might be eventually set via a config parameter
2
+ export var DEFAULT_CACHE_EXPIRATION_IN_MILLIS = 864000000; // 10 days
@@ -86,7 +86,8 @@ export var NON_REQUESTED = 1;
86
86
  export var DISABLED = 0;
87
87
  export var ENABLED = 1;
88
88
  export var PAUSED = 2;
89
- export var FLAG_SPEC_VERSION = '1.2';
89
+ export var FLAG_SPEC_VERSION = '1.3';
90
90
  // Matcher types
91
91
  export var IN_SEGMENT = 'IN_SEGMENT';
92
92
  export var IN_LARGE_SEGMENT = 'IN_LARGE_SEGMENT';
93
+ export var IN_RULE_BASED_SEGMENT = 'IN_RULE_BASED_SEGMENT';
@@ -3,7 +3,7 @@ import { ERROR_STORAGE_INVALID } from '../../../logger/constants';
3
3
  import { LOCALHOST_MODE, STANDALONE_MODE, STORAGE_PLUGGABLE, STORAGE_LOCALSTORAGE, STORAGE_MEMORY } from '../../../utils/constants';
4
4
  export function __InLocalStorageMockFactory(params) {
5
5
  var result = InMemoryStorageCSFactory(params);
6
- result.validateCache = function () { return true; }; // to emit SDK_READY_FROM_CACHE
6
+ result.splits.checkCache = function () { return true; }; // to emit SDK_READY_FROM_CACHE
7
7
  return result;
8
8
  }
9
9
  __InLocalStorageMockFactory.type = STORAGE_MEMORY;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@splitsoftware/splitio-commons",
3
- "version": "2.1.0-rc.2",
3
+ "version": "2.1.1-rc.0",
4
4
  "description": "Split JavaScript SDK common components",
5
5
  "main": "cjs/index.js",
6
6
  "module": "esm/index.js",