@splitsoftware/splitio-commons 2.2.0 → 2.2.1-rc.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (140) hide show
  1. package/CHANGES.txt +3 -0
  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 +44 -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 +4 -3
  14. package/cjs/logger/messages/debug.js +3 -2
  15. package/cjs/logger/messages/warn.js +1 -1
  16. package/cjs/services/splitApi.js +3 -4
  17. package/cjs/storages/AbstractSplitsCacheSync.js +5 -2
  18. package/cjs/storages/KeyBuilder.js +9 -0
  19. package/cjs/storages/KeyBuilderCS.js +3 -0
  20. package/cjs/storages/KeyBuilderSS.js +3 -0
  21. package/cjs/storages/inLocalStorage/RBSegmentsCacheInLocal.js +117 -0
  22. package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js +9 -14
  23. package/cjs/storages/inLocalStorage/index.js +5 -1
  24. package/cjs/storages/inLocalStorage/validateCache.js +2 -1
  25. package/cjs/storages/inMemory/InMemoryStorage.js +3 -0
  26. package/cjs/storages/inMemory/InMemoryStorageCS.js +4 -0
  27. package/cjs/storages/inMemory/RBSegmentsCacheInMemory.js +61 -0
  28. package/cjs/storages/inRedis/RBSegmentsCacheInRedis.js +64 -0
  29. package/cjs/storages/inRedis/index.js +2 -0
  30. package/cjs/storages/pluggable/RBSegmentsCachePluggable.js +64 -0
  31. package/cjs/storages/pluggable/index.js +2 -0
  32. package/cjs/sync/polling/fetchers/splitChangesFetcher.js +51 -4
  33. package/cjs/sync/polling/pollingManagerCS.js +7 -7
  34. package/cjs/sync/polling/syncTasks/splitsSyncTask.js +1 -1
  35. package/cjs/sync/polling/updaters/mySegmentsUpdater.js +2 -2
  36. package/cjs/sync/polling/updaters/segmentChangesUpdater.js +1 -1
  37. package/cjs/sync/polling/updaters/splitChangesUpdater.js +51 -33
  38. package/cjs/sync/streaming/SSEHandler/index.js +1 -0
  39. package/cjs/sync/streaming/UpdateWorkers/SplitsUpdateWorker.js +106 -77
  40. package/cjs/sync/streaming/constants.js +2 -1
  41. package/cjs/sync/streaming/pushManager.js +3 -16
  42. package/cjs/sync/syncManagerOnline.js +2 -2
  43. package/cjs/utils/constants/index.js +3 -2
  44. package/esm/evaluator/combiners/and.js +2 -6
  45. package/esm/evaluator/combiners/ifelseif.js +7 -7
  46. package/esm/evaluator/condition/index.js +6 -5
  47. package/esm/evaluator/index.js +7 -7
  48. package/esm/evaluator/matchers/index.js +3 -1
  49. package/esm/evaluator/matchers/matcherTypes.js +1 -0
  50. package/esm/evaluator/matchers/rbsegment.js +40 -0
  51. package/esm/evaluator/matchersTransform/index.js +4 -0
  52. package/esm/evaluator/parser/index.js +2 -2
  53. package/esm/evaluator/value/sanitize.js +1 -0
  54. package/esm/logger/constants.js +1 -0
  55. package/esm/logger/messages/debug.js +3 -2
  56. package/esm/logger/messages/warn.js +1 -1
  57. package/esm/services/splitApi.js +3 -4
  58. package/esm/storages/AbstractSplitsCacheSync.js +5 -2
  59. package/esm/storages/KeyBuilder.js +9 -0
  60. package/esm/storages/KeyBuilderCS.js +3 -0
  61. package/esm/storages/KeyBuilderSS.js +3 -0
  62. package/esm/storages/inLocalStorage/RBSegmentsCacheInLocal.js +114 -0
  63. package/esm/storages/inLocalStorage/SplitsCacheInLocal.js +9 -14
  64. package/esm/storages/inLocalStorage/index.js +5 -1
  65. package/esm/storages/inLocalStorage/validateCache.js +2 -1
  66. package/esm/storages/inMemory/InMemoryStorage.js +3 -0
  67. package/esm/storages/inMemory/InMemoryStorageCS.js +4 -0
  68. package/esm/storages/inMemory/RBSegmentsCacheInMemory.js +58 -0
  69. package/esm/storages/inRedis/RBSegmentsCacheInRedis.js +61 -0
  70. package/esm/storages/inRedis/index.js +2 -0
  71. package/esm/storages/pluggable/RBSegmentsCachePluggable.js +61 -0
  72. package/esm/storages/pluggable/index.js +2 -0
  73. package/esm/sync/polling/fetchers/splitChangesFetcher.js +51 -4
  74. package/esm/sync/polling/pollingManagerCS.js +7 -7
  75. package/esm/sync/polling/syncTasks/splitsSyncTask.js +1 -1
  76. package/esm/sync/polling/updaters/mySegmentsUpdater.js +2 -2
  77. package/esm/sync/polling/updaters/segmentChangesUpdater.js +1 -1
  78. package/esm/sync/polling/updaters/splitChangesUpdater.js +51 -33
  79. package/esm/sync/streaming/SSEHandler/index.js +2 -1
  80. package/esm/sync/streaming/UpdateWorkers/SplitsUpdateWorker.js +102 -73
  81. package/esm/sync/streaming/constants.js +1 -0
  82. package/esm/sync/streaming/pushManager.js +6 -19
  83. package/esm/sync/syncManagerOnline.js +2 -2
  84. package/esm/utils/constants/index.js +2 -1
  85. package/package.json +1 -1
  86. package/src/dtos/types.ts +32 -8
  87. package/src/evaluator/Engine.ts +1 -1
  88. package/src/evaluator/combiners/and.ts +5 -4
  89. package/src/evaluator/combiners/ifelseif.ts +7 -9
  90. package/src/evaluator/condition/engineUtils.ts +1 -1
  91. package/src/evaluator/condition/index.ts +12 -12
  92. package/src/evaluator/index.ts +7 -7
  93. package/src/evaluator/matchers/index.ts +3 -1
  94. package/src/evaluator/matchers/matcherTypes.ts +1 -0
  95. package/src/evaluator/matchers/rbsegment.ts +62 -0
  96. package/src/evaluator/matchersTransform/index.ts +3 -0
  97. package/src/evaluator/parser/index.ts +3 -3
  98. package/src/evaluator/types.ts +2 -2
  99. package/src/evaluator/value/index.ts +2 -2
  100. package/src/evaluator/value/sanitize.ts +5 -4
  101. package/src/logger/constants.ts +1 -0
  102. package/src/logger/messages/debug.ts +3 -2
  103. package/src/logger/messages/warn.ts +1 -1
  104. package/src/sdkManager/index.ts +1 -1
  105. package/src/services/splitApi.ts +3 -4
  106. package/src/services/types.ts +1 -1
  107. package/src/storages/AbstractSplitsCacheSync.ts +6 -3
  108. package/src/storages/KeyBuilder.ts +12 -0
  109. package/src/storages/KeyBuilderCS.ts +4 -0
  110. package/src/storages/KeyBuilderSS.ts +4 -0
  111. package/src/storages/inLocalStorage/RBSegmentsCacheInLocal.ts +136 -0
  112. package/src/storages/inLocalStorage/SplitsCacheInLocal.ts +10 -14
  113. package/src/storages/inLocalStorage/index.ts +5 -1
  114. package/src/storages/inLocalStorage/validateCache.ts +3 -1
  115. package/src/storages/inMemory/InMemoryStorage.ts +3 -0
  116. package/src/storages/inMemory/InMemoryStorageCS.ts +4 -0
  117. package/src/storages/inMemory/RBSegmentsCacheInMemory.ts +68 -0
  118. package/src/storages/inRedis/RBSegmentsCacheInRedis.ts +79 -0
  119. package/src/storages/inRedis/index.ts +2 -0
  120. package/src/storages/pluggable/RBSegmentsCachePluggable.ts +76 -0
  121. package/src/storages/pluggable/index.ts +2 -0
  122. package/src/storages/types.ts +33 -1
  123. package/src/sync/polling/fetchers/splitChangesFetcher.ts +62 -4
  124. package/src/sync/polling/fetchers/types.ts +1 -0
  125. package/src/sync/polling/pollingManagerCS.ts +7 -7
  126. package/src/sync/polling/syncTasks/splitsSyncTask.ts +1 -1
  127. package/src/sync/polling/types.ts +2 -2
  128. package/src/sync/polling/updaters/mySegmentsUpdater.ts +2 -2
  129. package/src/sync/polling/updaters/segmentChangesUpdater.ts +1 -1
  130. package/src/sync/polling/updaters/splitChangesUpdater.ts +61 -42
  131. package/src/sync/streaming/SSEHandler/index.ts +2 -1
  132. package/src/sync/streaming/SSEHandler/types.ts +2 -2
  133. package/src/sync/streaming/UpdateWorkers/SplitsUpdateWorker.ts +98 -68
  134. package/src/sync/streaming/constants.ts +1 -0
  135. package/src/sync/streaming/parseUtils.ts +2 -2
  136. package/src/sync/streaming/pushManager.ts +6 -18
  137. package/src/sync/streaming/types.ts +3 -2
  138. package/src/sync/syncManagerOnline.ts +2 -2
  139. package/src/utils/constants/index.ts +2 -1
  140. package/src/utils/lang/index.ts +1 -1
@@ -1,9 +1,10 @@
1
1
  import { timeout } from '../../../utils/promise/timeout';
2
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';
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, _b = _a.conditions, conditions = _b === void 0 ? [] : _b, 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);
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);
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:
@@ -88,7 +87,7 @@ export function computeSplitsMutation(entries, filters) {
88
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; }
91
- var splits = storage.splits, segments = storage.segments;
90
+ var splits = storage.splits, rbSegments = storage.rbSegments, segments = storage.segments;
92
91
  var startingUp = true;
93
92
  /** timeout decorator for `splitChangesFetcher` promise */
94
93
  function _promiseDecorator(promise) {
@@ -103,29 +102,48 @@ export function splitChangesUpdaterFactory(log, splitChangesFetcher, storage, sp
103
102
  * @param noCache - true to revalidate data to fetch
104
103
  * @param till - query param to bypass CDN requests
105
104
  */
106
- return function splitChangesUpdater(noCache, till, splitUpdateNotification) {
105
+ return function splitChangesUpdater(noCache, till, instantUpdate) {
107
106
  /**
108
107
  * @param since - current changeNumber at splitsCache
109
108
  * @param retry - current number of retry attempts
110
109
  */
111
- function _splitChangesUpdater(since, retry) {
110
+ function _splitChangesUpdater(sinces, retry) {
112
111
  if (retry === void 0) { retry = 0; }
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))
112
+ var since = sinces[0], rbSince = sinces[1];
113
+ log.debug(SYNC_SPLITS_FETCH, sinces);
114
+ return 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))
117
124
  .then(function (splitChanges) {
118
125
  startingUp = false;
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)
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))
124
142
  ]).then(function (_a) {
125
- var isThereUpdate = _a[0];
143
+ var ffChanged = _a[0], rbsChanged = _a[1];
126
144
  if (splitsEventEmitter) {
127
145
  // To emit SDK_SPLITS_ARRIVED for server-side SDK, we must check that all registered segments have been fetched
128
- return Promise.resolve(!splitsEventEmitter.splitsArrived || (since !== splitChanges.till && isThereUpdate && (isClientSide || checkAllSegmentsExist(segments))))
146
+ return Promise.resolve(!splitsEventEmitter.splitsArrived || ((ffChanged || rbsChanged) && (isClientSide || checkAllSegmentsExist(segments))))
129
147
  .catch(function () { return false; } /** noop. just to handle a possible `checkAllSegmentsExist` rejection, before emitting SDK event */)
130
148
  .then(function (emitSplitsArrivedEvent) {
131
149
  // emit SDK events
@@ -142,7 +160,7 @@ export function splitChangesUpdaterFactory(log, splitChangesFetcher, storage, sp
142
160
  if (startingUp && retriesOnFailureBeforeReady > retry) {
143
161
  retry += 1;
144
162
  log.info(SYNC_SPLITS_FETCH_RETRY, [retry, error]);
145
- return _splitChangesUpdater(since, retry);
163
+ return _splitChangesUpdater(sinces, retry);
146
164
  }
147
165
  else {
148
166
  startingUp = false;
@@ -150,7 +168,7 @@ export function splitChangesUpdaterFactory(log, splitChangesFetcher, storage, sp
150
168
  return false;
151
169
  });
152
170
  }
153
- var sincePromise = Promise.resolve(splits.getChangeNumber()); // `getChangeNumber` never rejects or throws error
154
- return sincePromise.then(_splitChangesUpdater);
171
+ // `getChangeNumber` never rejects or throws error
172
+ return Promise.all([splits.getChangeNumber(), rbSegments.getChangeNumber()]).then(_splitChangesUpdater);
155
173
  };
156
174
  }
@@ -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: {
@@ -127,7 +127,7 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
127
127
  if (pushManager) {
128
128
  if (pollingManager.isRunning()) {
129
129
  // if doing polling, we must start the periodic fetch of data
130
- if (storage.splits.usesSegments())
130
+ if (storage.splits.usesSegments() || storage.rbSegments.usesSegments())
131
131
  mySegmentsSyncTask.start();
132
132
  }
133
133
  else {
@@ -137,7 +137,7 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
137
137
  }
138
138
  }
139
139
  else {
140
- if (storage.splits.usesSegments())
140
+ if (storage.splits.usesSegments() || storage.rbSegments.usesSegments())
141
141
  mySegmentsSyncTask.start();
142
142
  }
143
143
  }
@@ -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';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@splitsoftware/splitio-commons",
3
- "version": "2.2.0",
3
+ "version": "2.2.1-rc.1",
4
4
  "description": "Split JavaScript SDK common components",
5
5
  "main": "cjs/index.js",
6
6
  "module": "esm/index.js",
package/src/dtos/types.ts CHANGED
@@ -66,6 +66,11 @@ interface IInSegmentMatcher extends ISplitMatcherBase {
66
66
  userDefinedSegmentMatcherData: IInSegmentMatcherData
67
67
  }
68
68
 
69
+ interface IInRBSegmentMatcher extends ISplitMatcherBase {
70
+ matcherType: 'IN_RULE_BASED_SEGMENT',
71
+ userDefinedSegmentMatcherData: IInSegmentMatcherData
72
+ }
73
+
69
74
  interface IInLargeSegmentMatcher extends ISplitMatcherBase {
70
75
  matcherType: 'IN_LARGE_SEGMENT',
71
76
  userDefinedLargeSegmentMatcherData: IInLargeSegmentMatcherData
@@ -176,7 +181,7 @@ export type ISplitMatcher = IAllKeysMatcher | IInSegmentMatcher | IWhitelistMatc
176
181
  ILessThanOrEqualToMatcher | IBetweenMatcher | IEqualToSetMatcher | IContainsAnyOfSetMatcher | IContainsAllOfSetMatcher | IPartOfSetMatcher |
177
182
  IStartsWithMatcher | IEndsWithMatcher | IContainsStringMatcher | IInSplitTreatmentMatcher | IEqualToBooleanMatcher | IMatchesStringMatcher |
178
183
  IEqualToSemverMatcher | IGreaterThanOrEqualToSemverMatcher | ILessThanOrEqualToSemverMatcher | IBetweenSemverMatcher | IInListSemverMatcher |
179
- IInLargeSegmentMatcher
184
+ IInLargeSegmentMatcher | IInRBSegmentMatcher
180
185
 
181
186
  /** Split object */
182
187
  export interface ISplitPartition {
@@ -189,19 +194,30 @@ export interface ISplitCondition {
189
194
  combiner: 'AND',
190
195
  matchers: ISplitMatcher[]
191
196
  }
192
- partitions: ISplitPartition[]
193
- label: string
194
- conditionType: 'ROLLOUT' | 'WHITELIST'
197
+ partitions?: ISplitPartition[]
198
+ label?: string
199
+ conditionType?: 'ROLLOUT' | 'WHITELIST'
200
+ }
201
+
202
+ export interface IRBSegment {
203
+ name: string,
204
+ changeNumber: number,
205
+ status: 'ACTIVE' | 'ARCHIVED',
206
+ conditions?: ISplitCondition[],
207
+ excluded?: {
208
+ keys?: string[],
209
+ segments?: string[]
210
+ }
195
211
  }
196
212
 
197
213
  export interface ISplit {
198
214
  name: string,
199
215
  changeNumber: number,
216
+ status: 'ACTIVE' | 'ARCHIVED',
217
+ conditions: ISplitCondition[],
200
218
  killed: boolean,
201
219
  defaultTreatment: string,
202
220
  trafficTypeName: string,
203
- conditions: ISplitCondition[],
204
- status: 'ACTIVE' | 'ARCHIVED',
205
221
  seed: number,
206
222
  trafficAllocation?: number,
207
223
  trafficAllocationSeed?: number
@@ -217,8 +233,16 @@ export type ISplitPartial = Pick<ISplit, 'conditions' | 'configurations' | 'traf
217
233
 
218
234
  /** Interface of the parsed JSON response of `/splitChanges` */
219
235
  export interface ISplitChangesResponse {
220
- till: number,
221
- splits: ISplit[]
236
+ ff?: {
237
+ t: number,
238
+ s?: number,
239
+ d: ISplit[]
240
+ },
241
+ rbs?: {
242
+ t: number,
243
+ s?: number,
244
+ d: IRBSegment[]
245
+ }
222
246
  }
223
247
 
224
248
  /** Interface of the parsed JSON response of `/segmentChanges/{segmentName}` */
@@ -73,7 +73,7 @@ export class Engine {
73
73
  trafficAllocationSeed,
74
74
  attributes,
75
75
  splitEvaluator
76
- );
76
+ ) as MaybeThenable<IEvaluation>;
77
77
 
78
78
  // Evaluation could be async, so we should handle that case checking for a
79
79
  // thenable object
@@ -2,10 +2,11 @@ import { findIndex } from '../../utils/lang';
2
2
  import { ILogger } from '../../logger/types';
3
3
  import { thenable } from '../../utils/promise/thenable';
4
4
  import { MaybeThenable } from '../../dtos/types';
5
- import { IMatcher } from '../types';
5
+ import { ISplitEvaluator } from '../types';
6
6
  import { ENGINE_COMBINER_AND } from '../../logger/constants';
7
+ import SplitIO from '../../../types/splitio';
7
8
 
8
- export function andCombinerContext(log: ILogger, matchers: IMatcher[]) {
9
+ export function andCombinerContext(log: ILogger, matchers: Array<(key: SplitIO.SplitKey, attributes?: SplitIO.Attributes, splitEvaluator?: ISplitEvaluator) => MaybeThenable<boolean>>) {
9
10
 
10
11
  function andResults(results: boolean[]): boolean {
11
12
  // Array.prototype.every is supported by target environments
@@ -15,8 +16,8 @@ export function andCombinerContext(log: ILogger, matchers: IMatcher[]) {
15
16
  return hasMatchedAll;
16
17
  }
17
18
 
18
- return function andCombiner(...params: any): MaybeThenable<boolean> {
19
- const matcherResults = matchers.map(matcher => matcher(...params));
19
+ return function andCombiner(key: SplitIO.SplitKey, attributes?: SplitIO.Attributes, splitEvaluator?: ISplitEvaluator): MaybeThenable<boolean> {
20
+ const matcherResults = matchers.map(matcher => matcher(key, attributes, splitEvaluator));
20
21
 
21
22
  // If any matching result is a thenable we should use Promise.all
22
23
  if (findIndex(matcherResults, thenable) !== -1) {
@@ -1,4 +1,4 @@
1
- import { findIndex } from '../../utils/lang';
1
+ import { findIndex, isBoolean } from '../../utils/lang';
2
2
  import { ILogger } from '../../logger/types';
3
3
  import { thenable } from '../../utils/promise/thenable';
4
4
  import { UNSUPPORTED_MATCHER_TYPE } from '../../utils/labels';
@@ -18,14 +18,12 @@ export function ifElseIfCombinerContext(log: ILogger, predicates: IEvaluator[]):
18
18
  };
19
19
  }
20
20
 
21
- function computeTreatment(predicateResults: Array<IEvaluation | undefined>) {
22
- const len = predicateResults.length;
23
-
24
- for (let i = 0; i < len; i++) {
21
+ function computeEvaluation(predicateResults: Array<IEvaluation | boolean | undefined>): IEvaluation | boolean | undefined {
22
+ for (let i = 0, len = predicateResults.length; i < len; i++) {
25
23
  const evaluation = predicateResults[i];
26
24
 
27
25
  if (evaluation !== undefined) {
28
- log.debug(ENGINE_COMBINER_IFELSEIF, [evaluation.treatment]);
26
+ if (!isBoolean(evaluation)) log.debug(ENGINE_COMBINER_IFELSEIF, [evaluation.treatment]);
29
27
 
30
28
  return evaluation;
31
29
  }
@@ -35,7 +33,7 @@ export function ifElseIfCombinerContext(log: ILogger, predicates: IEvaluator[]):
35
33
  return undefined;
36
34
  }
37
35
 
38
- function ifElseIfCombiner(key: SplitIO.SplitKey, seed: number, trafficAllocation?: number, trafficAllocationSeed?: number, attributes?: SplitIO.Attributes, splitEvaluator?: ISplitEvaluator) {
36
+ function ifElseIfCombiner(key: SplitIO.SplitKeyObject, seed?: number, trafficAllocation?: number, trafficAllocationSeed?: number, attributes?: SplitIO.Attributes, splitEvaluator?: ISplitEvaluator) {
39
37
  // In Async environments we are going to have async predicates. There is none way to know
40
38
  // before hand so we need to evaluate all the predicates, verify for thenables, and finally,
41
39
  // define how to return the treatment (wrap result into a Promise or not).
@@ -43,10 +41,10 @@ export function ifElseIfCombinerContext(log: ILogger, predicates: IEvaluator[]):
43
41
 
44
42
  // if we find a thenable
45
43
  if (findIndex(predicateResults, thenable) !== -1) {
46
- return Promise.all(predicateResults).then(results => computeTreatment(results));
44
+ return Promise.all(predicateResults).then(results => computeEvaluation(results));
47
45
  }
48
46
 
49
- return computeTreatment(predicateResults as IEvaluation[]);
47
+ return computeEvaluation(predicateResults as IEvaluation[]);
50
48
  }
51
49
 
52
50
  // if there is none predicates, then there was an error in parsing phase
@@ -5,7 +5,7 @@ import { bucket } from '../../utils/murmur3/murmur3';
5
5
  /**
6
6
  * Get the treatment name given a key, a seed, and the percentage of each treatment.
7
7
  */
8
- export function getTreatment(log: ILogger, key: string, seed: number, treatments: { getTreatmentFor: (x: number) => string }) {
8
+ export function getTreatment(log: ILogger, key: string, seed: number | undefined, treatments: { getTreatmentFor: (x: number) => string }) {
9
9
  const _bucket = bucket(key, seed);
10
10
 
11
11
  const treatment = treatments.getTreatmentFor(_bucket);