@splitsoftware/splitio-commons 2.1.1-rc.0 → 2.1.1-rc.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (187) hide show
  1. package/CHANGES.txt +7 -0
  2. package/README.md +0 -1
  3. package/cjs/evaluator/combiners/and.js +6 -2
  4. package/cjs/evaluator/combiners/ifelseif.js +6 -6
  5. package/cjs/evaluator/condition/index.js +5 -6
  6. package/cjs/evaluator/index.js +7 -7
  7. package/cjs/evaluator/matchers/index.js +1 -3
  8. package/cjs/evaluator/matchers/matcherTypes.js +0 -1
  9. package/cjs/evaluator/matchersTransform/index.js +0 -4
  10. package/cjs/evaluator/parser/index.js +2 -2
  11. package/cjs/evaluator/value/sanitize.js +0 -1
  12. package/cjs/logger/constants.js +3 -4
  13. package/cjs/logger/messages/debug.js +2 -3
  14. package/cjs/logger/messages/error.js +1 -1
  15. package/cjs/logger/messages/warn.js +2 -2
  16. package/cjs/readiness/readinessManager.js +6 -0
  17. package/cjs/sdkClient/client.js +29 -19
  18. package/cjs/sdkClient/clientAttributesDecoration.js +19 -25
  19. package/cjs/sdkClient/clientInputValidation.js +28 -26
  20. package/cjs/services/splitApi.js +2 -2
  21. package/cjs/storages/AbstractSplitsCacheAsync.js +0 -7
  22. package/cjs/storages/AbstractSplitsCacheSync.js +2 -12
  23. package/cjs/storages/KeyBuilder.js +0 -9
  24. package/cjs/storages/KeyBuilderCS.js +4 -4
  25. package/cjs/storages/KeyBuilderSS.js +0 -3
  26. package/cjs/storages/dataLoader.js +3 -2
  27. package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js +23 -76
  28. package/cjs/storages/inLocalStorage/index.js +5 -7
  29. package/cjs/storages/inLocalStorage/validateCache.js +79 -0
  30. package/cjs/storages/inMemory/InMemoryStorage.js +0 -3
  31. package/cjs/storages/inMemory/InMemoryStorageCS.js +0 -4
  32. package/cjs/storages/inRedis/index.js +0 -2
  33. package/cjs/storages/pluggable/index.js +2 -3
  34. package/cjs/storages/utils.js +1 -0
  35. package/cjs/sync/offline/syncTasks/fromObjectSyncTask.js +3 -2
  36. package/cjs/sync/polling/fetchers/splitChangesFetcher.js +2 -2
  37. package/cjs/sync/polling/pollingManagerCS.js +7 -7
  38. package/cjs/sync/polling/updaters/mySegmentsUpdater.js +2 -2
  39. package/cjs/sync/polling/updaters/segmentChangesUpdater.js +1 -1
  40. package/cjs/sync/polling/updaters/splitChangesUpdater.js +33 -60
  41. package/cjs/sync/streaming/SSEHandler/index.js +0 -1
  42. package/cjs/sync/streaming/UpdateWorkers/SplitsUpdateWorker.js +77 -106
  43. package/cjs/sync/streaming/constants.js +1 -2
  44. package/cjs/sync/streaming/pushManager.js +16 -3
  45. package/cjs/sync/submitters/impressionsSubmitter.js +3 -2
  46. package/cjs/sync/syncManagerOnline.js +10 -5
  47. package/cjs/trackers/strategy/strategyDebug.js +2 -0
  48. package/cjs/trackers/strategy/strategyOptimized.js +3 -0
  49. package/cjs/utils/constants/index.js +2 -3
  50. package/cjs/utils/inputValidation/eventProperties.js +12 -1
  51. package/cjs/utils/inputValidation/index.js +3 -1
  52. package/cjs/utils/settingsValidation/storage/storageCS.js +1 -1
  53. package/esm/evaluator/combiners/and.js +6 -2
  54. package/esm/evaluator/combiners/ifelseif.js +7 -7
  55. package/esm/evaluator/condition/index.js +5 -6
  56. package/esm/evaluator/index.js +7 -7
  57. package/esm/evaluator/matchers/index.js +1 -3
  58. package/esm/evaluator/matchers/matcherTypes.js +0 -1
  59. package/esm/evaluator/matchersTransform/index.js +0 -4
  60. package/esm/evaluator/parser/index.js +2 -2
  61. package/esm/evaluator/value/sanitize.js +0 -1
  62. package/esm/logger/constants.js +0 -1
  63. package/esm/logger/messages/debug.js +2 -3
  64. package/esm/logger/messages/error.js +1 -1
  65. package/esm/logger/messages/warn.js +2 -2
  66. package/esm/readiness/readinessManager.js +6 -0
  67. package/esm/sdkClient/client.js +29 -19
  68. package/esm/sdkClient/clientAttributesDecoration.js +19 -25
  69. package/esm/sdkClient/clientInputValidation.js +29 -27
  70. package/esm/services/splitApi.js +2 -2
  71. package/esm/storages/AbstractSplitsCacheAsync.js +0 -7
  72. package/esm/storages/AbstractSplitsCacheSync.js +2 -12
  73. package/esm/storages/KeyBuilder.js +0 -9
  74. package/esm/storages/KeyBuilderCS.js +4 -4
  75. package/esm/storages/KeyBuilderSS.js +0 -3
  76. package/esm/storages/dataLoader.js +2 -1
  77. package/esm/storages/inLocalStorage/SplitsCacheInLocal.js +23 -76
  78. package/esm/storages/inLocalStorage/index.js +5 -7
  79. package/esm/storages/inLocalStorage/validateCache.js +75 -0
  80. package/esm/storages/inMemory/InMemoryStorage.js +0 -3
  81. package/esm/storages/inMemory/InMemoryStorageCS.js +0 -4
  82. package/esm/storages/inRedis/index.js +0 -2
  83. package/esm/storages/pluggable/index.js +2 -3
  84. package/esm/storages/utils.js +1 -0
  85. package/esm/sync/offline/syncTasks/fromObjectSyncTask.js +3 -2
  86. package/esm/sync/polling/fetchers/splitChangesFetcher.js +2 -2
  87. package/esm/sync/polling/pollingManagerCS.js +7 -7
  88. package/esm/sync/polling/updaters/mySegmentsUpdater.js +2 -2
  89. package/esm/sync/polling/updaters/segmentChangesUpdater.js +1 -1
  90. package/esm/sync/polling/updaters/splitChangesUpdater.js +34 -61
  91. package/esm/sync/streaming/SSEHandler/index.js +1 -2
  92. package/esm/sync/streaming/UpdateWorkers/SplitsUpdateWorker.js +73 -102
  93. package/esm/sync/streaming/constants.js +0 -1
  94. package/esm/sync/streaming/pushManager.js +19 -6
  95. package/esm/sync/submitters/impressionsSubmitter.js +3 -2
  96. package/esm/sync/syncManagerOnline.js +10 -5
  97. package/esm/trackers/strategy/strategyDebug.js +2 -0
  98. package/esm/trackers/strategy/strategyOptimized.js +3 -0
  99. package/esm/utils/constants/index.js +1 -2
  100. package/esm/utils/inputValidation/eventProperties.js +10 -0
  101. package/esm/utils/inputValidation/index.js +1 -0
  102. package/esm/utils/settingsValidation/storage/storageCS.js +1 -1
  103. package/package.json +1 -1
  104. package/src/dtos/types.ts +8 -32
  105. package/src/evaluator/Engine.ts +1 -1
  106. package/src/evaluator/combiners/and.ts +4 -5
  107. package/src/evaluator/combiners/ifelseif.ts +9 -7
  108. package/src/evaluator/condition/engineUtils.ts +1 -1
  109. package/src/evaluator/condition/index.ts +12 -12
  110. package/src/evaluator/index.ts +7 -7
  111. package/src/evaluator/matchers/index.ts +1 -3
  112. package/src/evaluator/matchers/matcherTypes.ts +0 -1
  113. package/src/evaluator/matchersTransform/index.ts +0 -3
  114. package/src/evaluator/parser/index.ts +3 -3
  115. package/src/evaluator/types.ts +2 -2
  116. package/src/evaluator/value/index.ts +2 -2
  117. package/src/evaluator/value/sanitize.ts +4 -5
  118. package/src/logger/constants.ts +0 -1
  119. package/src/logger/messages/debug.ts +2 -3
  120. package/src/logger/messages/error.ts +1 -1
  121. package/src/logger/messages/warn.ts +2 -2
  122. package/src/readiness/readinessManager.ts +5 -0
  123. package/src/sdkClient/client.ts +31 -21
  124. package/src/sdkClient/clientAttributesDecoration.ts +20 -27
  125. package/src/sdkClient/clientInputValidation.ts +30 -27
  126. package/src/sdkManager/index.ts +1 -1
  127. package/src/services/splitApi.ts +2 -2
  128. package/src/services/types.ts +1 -1
  129. package/src/storages/AbstractSplitsCacheAsync.ts +0 -8
  130. package/src/storages/AbstractSplitsCacheSync.ts +3 -14
  131. package/src/storages/KeyBuilder.ts +0 -12
  132. package/src/storages/KeyBuilderCS.ts +5 -5
  133. package/src/storages/KeyBuilderSS.ts +0 -4
  134. package/src/storages/dataLoader.ts +3 -1
  135. package/src/storages/inLocalStorage/SplitsCacheInLocal.ts +26 -87
  136. package/src/storages/inLocalStorage/index.ts +8 -12
  137. package/src/storages/inLocalStorage/validateCache.ts +91 -0
  138. package/src/storages/inMemory/InMemoryStorage.ts +0 -3
  139. package/src/storages/inMemory/InMemoryStorageCS.ts +0 -4
  140. package/src/storages/inRedis/index.ts +0 -2
  141. package/src/storages/pluggable/index.ts +2 -3
  142. package/src/storages/types.ts +2 -37
  143. package/src/storages/utils.ts +1 -0
  144. package/src/sync/offline/syncTasks/fromObjectSyncTask.ts +6 -5
  145. package/src/sync/polling/fetchers/splitChangesFetcher.ts +1 -2
  146. package/src/sync/polling/fetchers/types.ts +0 -1
  147. package/src/sync/polling/pollingManagerCS.ts +7 -7
  148. package/src/sync/polling/types.ts +2 -2
  149. package/src/sync/polling/updaters/mySegmentsUpdater.ts +2 -2
  150. package/src/sync/polling/updaters/segmentChangesUpdater.ts +1 -1
  151. package/src/sync/polling/updaters/splitChangesUpdater.ts +43 -71
  152. package/src/sync/streaming/SSEHandler/index.ts +1 -2
  153. package/src/sync/streaming/SSEHandler/types.ts +2 -2
  154. package/src/sync/streaming/UpdateWorkers/SplitsUpdateWorker.ts +68 -98
  155. package/src/sync/streaming/constants.ts +0 -1
  156. package/src/sync/streaming/parseUtils.ts +2 -2
  157. package/src/sync/streaming/pushManager.ts +18 -6
  158. package/src/sync/streaming/types.ts +2 -3
  159. package/src/sync/submitters/impressionsSubmitter.ts +3 -2
  160. package/src/sync/submitters/types.ts +23 -33
  161. package/src/sync/syncManagerOnline.ts +11 -5
  162. package/src/trackers/strategy/strategyDebug.ts +2 -0
  163. package/src/trackers/strategy/strategyOptimized.ts +3 -0
  164. package/src/utils/constants/index.ts +1 -2
  165. package/src/utils/inputValidation/eventProperties.ts +10 -0
  166. package/src/utils/inputValidation/index.ts +1 -0
  167. package/src/utils/lang/index.ts +2 -2
  168. package/src/utils/settingsValidation/storage/storageCS.ts +1 -1
  169. package/types/splitio.d.ts +128 -36
  170. package/cjs/evaluator/matchers/rbsegment.js +0 -43
  171. package/cjs/storages/inLocalStorage/RBSegmentsCacheInLocal.js +0 -117
  172. package/cjs/storages/inMemory/RBSegmentsCacheInMemory.js +0 -61
  173. package/cjs/storages/inRedis/RBSegmentsCacheInRedis.js +0 -64
  174. package/cjs/storages/pluggable/RBSegmentsCachePluggable.js +0 -64
  175. package/cjs/utils/constants/browser.js +0 -5
  176. package/esm/evaluator/matchers/rbsegment.js +0 -39
  177. package/esm/storages/inLocalStorage/RBSegmentsCacheInLocal.js +0 -114
  178. package/esm/storages/inMemory/RBSegmentsCacheInMemory.js +0 -58
  179. package/esm/storages/inRedis/RBSegmentsCacheInRedis.js +0 -61
  180. package/esm/storages/pluggable/RBSegmentsCachePluggable.js +0 -61
  181. package/esm/utils/constants/browser.js +0 -2
  182. package/src/evaluator/matchers/rbsegment.ts +0 -61
  183. package/src/storages/inLocalStorage/RBSegmentsCacheInLocal.ts +0 -136
  184. package/src/storages/inMemory/RBSegmentsCacheInMemory.ts +0 -68
  185. package/src/storages/inRedis/RBSegmentsCacheInRedis.ts +0 -79
  186. package/src/storages/pluggable/RBSegmentsCachePluggable.ts +0 -76
  187. package/src/utils/constants/browser.ts +0 -2
@@ -1,10 +1,9 @@
1
1
  import { timeout } from '../../../utils/promise/timeout';
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';
2
+ import { SDK_SPLITS_ARRIVED } from '../../../readiness/constants';
3
+ import { SYNC_SPLITS_FETCH, SYNC_SPLITS_UPDATE, SYNC_SPLITS_FETCH_FAILS, SYNC_SPLITS_FETCH_RETRY } from '../../../logger/constants';
4
4
  import { startsWith } from '../../../utils/lang';
5
- import { IN_RULE_BASED_SEGMENT, IN_SEGMENT } from '../../../utils/constants';
5
+ import { IN_SEGMENT } from '../../../utils/constants';
6
6
  import { setToArray } from '../../../utils/lang/sets';
7
- import { SPLIT_UPDATE } from '../../streaming/constants';
8
7
  // Checks that all registered segments have been fetched (changeNumber !== -1 for every segment).
9
8
  // Returns a promise that could be rejected.
10
9
  // @TODO review together with Segments and MySegments storage APIs
@@ -19,14 +18,13 @@ function checkAllSegmentsExist(segments) {
19
18
  * Collect segments from a raw split definition.
20
19
  * Exported for testing purposes.
21
20
  */
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);
21
+ export function parseSegments(_a) {
22
+ var conditions = _a.conditions;
23
+ var segments = new Set();
26
24
  for (var i = 0; i < conditions.length; i++) {
27
25
  var matchers = conditions[i].matcherGroup.matchers;
28
26
  matchers.forEach(function (matcher) {
29
- if (matcher.matcherType === matcherType)
27
+ if (matcher.matcherType === IN_SEGMENT)
30
28
  segments.add(matcher.userDefinedSegmentMatcherData.segmentName);
31
29
  });
32
30
  }
@@ -56,19 +54,22 @@ function matchFilters(featureFlag, filters) {
56
54
  * i.e., an object with added splits, removed splits and used segments.
57
55
  * Exported for testing purposes.
58
56
  */
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) {
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);
62
+ parseSegments(split).forEach(function (segmentName) {
64
63
  segments.add(segmentName);
65
64
  });
66
65
  }
67
66
  else {
68
- accum.removed.push(ruleEntity);
67
+ accum.removed.push(split);
69
68
  }
70
69
  return accum;
71
- }, { added: [], removed: [] });
70
+ }, { added: [], removed: [], segments: [] });
71
+ computed.segments = setToArray(segments);
72
+ return computed;
72
73
  }
73
74
  /**
74
75
  * factory of SplitChanges updater, a task that:
@@ -87,7 +88,7 @@ export function computeMutation(rules, segments, filters) {
87
88
  export function splitChangesUpdaterFactory(log, splitChangesFetcher, storage, splitFiltersValidation, splitsEventEmitter, requestTimeoutBeforeReady, retriesOnFailureBeforeReady, isClientSide) {
88
89
  if (requestTimeoutBeforeReady === void 0) { requestTimeoutBeforeReady = 0; }
89
90
  if (retriesOnFailureBeforeReady === void 0) { retriesOnFailureBeforeReady = 0; }
90
- var splits = storage.splits, rbSegments = storage.rbSegments, segments = storage.segments;
91
+ var splits = storage.splits, segments = storage.segments;
91
92
  var startingUp = true;
92
93
  /** timeout decorator for `splitChangesFetcher` promise */
93
94
  function _promiseDecorator(promise) {
@@ -102,48 +103,29 @@ export function splitChangesUpdaterFactory(log, splitChangesFetcher, storage, sp
102
103
  * @param noCache - true to revalidate data to fetch
103
104
  * @param till - query param to bypass CDN requests
104
105
  */
105
- return function splitChangesUpdater(noCache, till, instantUpdate) {
106
+ return function splitChangesUpdater(noCache, till, splitUpdateNotification) {
106
107
  /**
107
108
  * @param since - current changeNumber at splitsCache
108
109
  * @param retry - current number of retry attempts
109
110
  */
110
- function _splitChangesUpdater(sinces, retry) {
111
+ function _splitChangesUpdater(since, retry) {
111
112
  if (retry === void 0) { retry = 0; }
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))
113
+ log.debug(SYNC_SPLITS_FETCH, [since]);
114
+ return Promise.resolve(splitUpdateNotification ?
115
+ { splits: [splitUpdateNotification.payload], till: splitUpdateNotification.changeNumber } :
116
+ splitChangesFetcher(since, noCache, till, _promiseDecorator))
124
117
  .then(function (splitChanges) {
125
118
  startingUp = false;
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))
119
+ var mutation = computeSplitsMutation(splitChanges.splits, splitFiltersValidation);
120
+ log.debug(SYNC_SPLITS_UPDATE, [mutation.added.length, mutation.removed.length, mutation.segments.length]);
121
+ return Promise.all([
122
+ splits.update(mutation.added, mutation.removed, splitChanges.till),
123
+ segments.registerSegments(mutation.segments)
142
124
  ]).then(function (_a) {
143
- var ffChanged = _a[0], rbsChanged = _a[1];
125
+ var isThereUpdate = _a[0];
144
126
  if (splitsEventEmitter) {
145
127
  // To emit SDK_SPLITS_ARRIVED for server-side SDK, we must check that all registered segments have been fetched
146
- return Promise.resolve(!splitsEventEmitter.splitsArrived || ((ffChanged || rbsChanged) && (isClientSide || checkAllSegmentsExist(segments))))
128
+ return Promise.resolve(!splitsEventEmitter.splitsArrived || (since !== splitChanges.till && isThereUpdate && (isClientSide || checkAllSegmentsExist(segments))))
147
129
  .catch(function () { return false; } /** noop. just to handle a possible `checkAllSegmentsExist` rejection, before emitting SDK event */)
148
130
  .then(function (emitSplitsArrivedEvent) {
149
131
  // emit SDK events
@@ -160,24 +142,15 @@ export function splitChangesUpdaterFactory(log, splitChangesFetcher, storage, sp
160
142
  if (startingUp && retriesOnFailureBeforeReady > retry) {
161
143
  retry += 1;
162
144
  log.info(SYNC_SPLITS_FETCH_RETRY, [retry, error]);
163
- return _splitChangesUpdater(sinces, retry);
145
+ return _splitChangesUpdater(since, retry);
164
146
  }
165
147
  else {
166
148
  startingUp = false;
167
149
  }
168
150
  return false;
169
151
  });
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;
179
152
  }
180
- // `getChangeNumber` never rejects or throws error
181
- return Promise.all([splits.getChangeNumber(), rbSegments.getChangeNumber()]).then(_splitChangesUpdater);
153
+ var sincePromise = Promise.resolve(splits.getChangeNumber()); // `getChangeNumber` never rejects or throws error
154
+ return sincePromise.then(_splitChangesUpdater);
182
155
  };
183
156
  }
@@ -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, RB_SEGMENT_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
  /**
@@ -75,7 +75,6 @@ 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:
79
78
  pushEmitter.emit(parsedData.type, parsedData);
80
79
  break;
81
80
  /* occupancy & control events, handled by NotificationManagerKeeper */
@@ -1,132 +1,103 @@
1
- import { STREAMING_PARSING_SPLIT_UPDATE } from '../../../logger/constants';
2
1
  import { SDK_SPLITS_ARRIVED } from '../../../readiness/constants';
3
2
  import { Backoff } from '../../../utils/Backoff';
4
3
  import { SPLITS } from '../../../utils/constants';
5
- import { RB_SEGMENT_UPDATE } from '../constants';
6
- import { parseFFUpdatePayload } from '../parseUtils';
7
4
  import { FETCH_BACKOFF_BASE, FETCH_BACKOFF_MAX_WAIT, FETCH_BACKOFF_MAX_RETRIES } from './constants';
8
5
  /**
9
6
  * SplitsUpdateWorker factory
10
7
  */
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();
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;
31
46
  }
32
47
  else {
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
- }
48
+ backoff.reset();
49
+ cdnBypass = true;
50
+ __handleSplitUpdateCall();
57
51
  }
58
- });
59
- }
60
- else {
61
- isHandlingEvent = false;
62
- }
63
- }
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
52
  }
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
- };
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;
75
+ }
76
+ if (backoff.timeoutID || !isHandlingEvent)
77
+ __handleSplitUpdateCall();
78
+ backoff.reset();
94
79
  }
95
80
  return {
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
- },
81
+ put: put,
111
82
  /**
112
83
  * Invoked by NotificationProcessor on SPLIT_KILL event
113
84
  *
114
- * @param changeNumber - change number of the notification
85
+ * @param changeNumber - change number of the SPLIT_UPDATE notification
115
86
  * @param splitName - name of split to kill
116
87
  * @param defaultTreatment - default treatment value
117
88
  */
118
89
  killSplit: function (_a) {
119
90
  var changeNumber = _a.changeNumber, splitName = _a.splitName, defaultTreatment = _a.defaultTreatment;
120
- if (storage.splits.killLocally(splitName, defaultTreatment, changeNumber)) {
91
+ if (splitsCache.killLocally(splitName, defaultTreatment, changeNumber)) {
121
92
  // trigger an SDK_UPDATE if Split was killed locally
122
93
  splitsEventEmitter.emit(SDK_SPLITS_ARRIVED, true);
123
94
  }
124
95
  // queues the SplitChanges fetch (only if changeNumber is newer)
125
- ff.put({ changeNumber: changeNumber });
96
+ put({ changeNumber: changeNumber });
126
97
  },
127
98
  stop: function () {
128
- ff.stop();
129
- rbs.stop();
99
+ isHandlingEvent = false;
100
+ backoff.reset();
130
101
  }
131
102
  };
132
103
  }
@@ -27,7 +27,6 @@ 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';
31
30
  // Control-type push notifications, handled by NotificationKeeper
32
31
  export var CONTROL = 'CONTROL';
33
32
  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, 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';
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';
13
13
  import { UpdateStrategy } from './SSEHandler/types';
14
- import { getDelay, isInBitmap, parseBitmap, parseKeyList } from './parseUtils';
14
+ import { getDelay, isInBitmap, parseBitmap, parseFFUpdatePayload, 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, pollingManager.splitsSyncTask, readiness.splits, telemetryTracker, userKey ? undefined : pollingManager.segmentsSyncTask);
46
+ var splitsUpdateWorker = SplitsUpdateWorker(log, storage.splits, 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,8 +179,21 @@ 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, splitsUpdateWorker.put);
183
- pushEmitter.on(RB_SEGMENT_UPDATE, splitsUpdateWorker.put);
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
+ });
184
197
  function handleMySegmentsUpdate(parsedData) {
185
198
  switch (parsedData.u) {
186
199
  case UpdateStrategy.BoundedFetchRequest: {
@@ -19,8 +19,9 @@ export function fromImpressionsCollector(sendLabels, data) {
19
19
  m: entry.time,
20
20
  c: entry.changeNumber,
21
21
  r: sendLabels ? entry.label : undefined,
22
- b: entry.bucketingKey ? entry.bucketingKey : undefined,
23
- pt: entry.pt ? entry.pt : undefined // Previous time
22
+ b: entry.bucketingKey,
23
+ pt: entry.pt,
24
+ properties: entry.properties // Properties
24
25
  };
25
26
  return keyImpression;
26
27
  })
@@ -3,6 +3,7 @@ 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';
6
7
  /**
7
8
  * Online SyncManager factory.
8
9
  * Can be used for server-side API, and client-side API with or without multiple clients.
@@ -16,7 +17,7 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
16
17
  * SyncManager factory for modular SDK
17
18
  */
18
19
  return function (params) {
19
- var settings = params.settings, _a = params.settings, log = _a.log, streamingEnabled = _a.streamingEnabled, syncEnabled = _a.sync.enabled, telemetryTracker = params.telemetryTracker;
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;
20
21
  /** Polling Manager */
21
22
  var pollingManager = pollingManagerFactory && pollingManagerFactory(params);
22
23
  /** Push Manager */
@@ -64,6 +65,11 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
64
65
  */
65
66
  start: function () {
66
67
  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
+ }
67
73
  // start syncing splits and segments
68
74
  if (pollingManager) {
69
75
  // If synchronization is disabled pushManager and pollingManager should not start
@@ -72,7 +78,6 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
72
78
  // Doesn't call `syncAll` when the syncManager is resuming
73
79
  if (startFirstTime) {
74
80
  pollingManager.syncAll();
75
- startFirstTime = false;
76
81
  }
77
82
  pushManager.start();
78
83
  }
@@ -83,12 +88,12 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
83
88
  else {
84
89
  if (startFirstTime) {
85
90
  pollingManager.syncAll();
86
- startFirstTime = false;
87
91
  }
88
92
  }
89
93
  }
90
94
  // start periodic data recording (events, impressions, telemetry).
91
95
  submitterManager.start(!isConsentGranted(settings));
96
+ startFirstTime = false;
92
97
  },
93
98
  /**
94
99
  * Method used to stop/pause the syncManager.
@@ -122,7 +127,7 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
122
127
  if (pushManager) {
123
128
  if (pollingManager.isRunning()) {
124
129
  // if doing polling, we must start the periodic fetch of data
125
- if (storage.splits.usesSegments() || storage.rbSegments.usesSegments())
130
+ if (storage.splits.usesSegments())
126
131
  mySegmentsSyncTask.start();
127
132
  }
128
133
  else {
@@ -132,7 +137,7 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
132
137
  }
133
138
  }
134
139
  else {
135
- if (storage.splits.usesSegments() || storage.rbSegments.usesSegments())
140
+ if (storage.splits.usesSegments())
136
141
  mySegmentsSyncTask.start();
137
142
  }
138
143
  }
@@ -7,6 +7,8 @@
7
7
  export function strategyDebugFactory(impressionsObserver) {
8
8
  return {
9
9
  process: function (impression) {
10
+ if (impression.properties)
11
+ return true;
10
12
  impression.pt = impressionsObserver.testAndSet(impression);
11
13
  return true;
12
14
  }
@@ -9,6 +9,9 @@ import { truncateTimeFrame } from '../../utils/time';
9
9
  export function strategyOptimizedFactory(impressionsObserver, impressionCounts) {
10
10
  return {
11
11
  process: function (impression) {
12
+ // DEBUG mode without previous time, for impressions with properties
13
+ if (impression.properties)
14
+ return true;
12
15
  impression.pt = impressionsObserver.testAndSet(impression);
13
16
  var now = Date.now();
14
17
  // Increments impression counter per featureName
@@ -86,8 +86,7 @@ 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.3';
89
+ export var FLAG_SPEC_VERSION = '1.2';
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';
@@ -57,3 +57,13 @@ export function validateEventProperties(log, maybeProperties, method) {
57
57
  }
58
58
  return output;
59
59
  }
60
+ export function validateEvaluationOptions(log, maybeOptions, method) {
61
+ if (isObject(maybeOptions)) {
62
+ var properties = validateEventProperties(log, maybeOptions.properties, method).properties;
63
+ return properties && Object.keys(properties).length > 0 ? { properties: properties } : undefined;
64
+ }
65
+ else if (maybeOptions) {
66
+ log.error(ERROR_NOT_PLAIN_OBJECT, [method, 'evaluation options']);
67
+ }
68
+ return undefined;
69
+ }
@@ -11,3 +11,4 @@ export { validateIfNotDestroyed, validateIfOperational } from './isOperational';
11
11
  export { validateSplitExistence } from './splitExistence';
12
12
  export { validateTrafficTypeExistence } from './trafficTypeExistence';
13
13
  export { validatePreloadedData } from './preloadedData';
14
+ export { validateEvaluationOptions } from './eventProperties';
@@ -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.splits.checkCache = function () { return true; }; // to emit SDK_READY_FROM_CACHE
6
+ result.validateCache = 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.1-rc.0",
3
+ "version": "2.1.1-rc.2",
4
4
  "description": "Split JavaScript SDK common components",
5
5
  "main": "cjs/index.js",
6
6
  "module": "esm/index.js",