@splitsoftware/splitio-commons 2.2.1-rc.0 → 2.2.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 (151) hide show
  1. package/CHANGES.txt +2 -3
  2. package/README.md +0 -1
  3. package/cjs/evaluator/Engine.js +61 -40
  4. package/cjs/evaluator/combiners/and.js +6 -2
  5. package/cjs/evaluator/combiners/ifelseif.js +6 -6
  6. package/cjs/evaluator/condition/index.js +5 -6
  7. package/cjs/evaluator/index.js +11 -11
  8. package/cjs/evaluator/matchers/index.js +1 -3
  9. package/cjs/evaluator/matchers/matcherTypes.js +0 -1
  10. package/cjs/evaluator/matchersTransform/index.js +0 -4
  11. package/cjs/evaluator/parser/index.js +2 -2
  12. package/cjs/evaluator/value/sanitize.js +0 -1
  13. package/cjs/logger/constants.js +3 -5
  14. package/cjs/logger/messages/debug.js +2 -4
  15. package/cjs/logger/messages/warn.js +1 -1
  16. package/cjs/sdkManager/index.js +1 -2
  17. package/cjs/services/splitApi.js +4 -3
  18. package/cjs/storages/AbstractSplitsCacheSync.js +2 -5
  19. package/cjs/storages/KeyBuilder.js +0 -9
  20. package/cjs/storages/KeyBuilderCS.js +0 -3
  21. package/cjs/storages/KeyBuilderSS.js +0 -3
  22. package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js +14 -9
  23. package/cjs/storages/inLocalStorage/index.js +1 -5
  24. package/cjs/storages/inLocalStorage/validateCache.js +1 -2
  25. package/cjs/storages/inMemory/InMemoryStorage.js +0 -3
  26. package/cjs/storages/inMemory/InMemoryStorageCS.js +0 -4
  27. package/cjs/storages/inRedis/index.js +9 -5
  28. package/cjs/storages/pluggable/index.js +0 -2
  29. package/cjs/sync/polling/fetchers/splitChangesFetcher.js +4 -51
  30. package/cjs/sync/polling/pollingManagerCS.js +7 -7
  31. package/cjs/sync/polling/syncTasks/splitsSyncTask.js +1 -1
  32. package/cjs/sync/polling/updaters/mySegmentsUpdater.js +2 -2
  33. package/cjs/sync/polling/updaters/segmentChangesUpdater.js +1 -1
  34. package/cjs/sync/polling/updaters/splitChangesUpdater.js +33 -51
  35. package/cjs/sync/streaming/SSEHandler/index.js +0 -1
  36. package/cjs/sync/streaming/UpdateWorkers/SplitsUpdateWorker.js +77 -106
  37. package/cjs/sync/streaming/constants.js +1 -2
  38. package/cjs/sync/streaming/pushManager.js +16 -3
  39. package/cjs/sync/syncManagerOnline.js +2 -2
  40. package/cjs/utils/constants/index.js +2 -3
  41. package/cjs/utils/labels/index.js +1 -2
  42. package/esm/evaluator/Engine.js +62 -40
  43. package/esm/evaluator/combiners/and.js +6 -2
  44. package/esm/evaluator/combiners/ifelseif.js +7 -7
  45. package/esm/evaluator/condition/index.js +5 -6
  46. package/esm/evaluator/index.js +12 -12
  47. package/esm/evaluator/matchers/index.js +1 -3
  48. package/esm/evaluator/matchers/matcherTypes.js +0 -1
  49. package/esm/evaluator/matchersTransform/index.js +0 -4
  50. package/esm/evaluator/parser/index.js +2 -2
  51. package/esm/evaluator/value/sanitize.js +0 -1
  52. package/esm/logger/constants.js +0 -2
  53. package/esm/logger/messages/debug.js +2 -4
  54. package/esm/logger/messages/warn.js +1 -1
  55. package/esm/sdkManager/index.js +1 -2
  56. package/esm/services/splitApi.js +4 -3
  57. package/esm/storages/AbstractSplitsCacheSync.js +2 -5
  58. package/esm/storages/KeyBuilder.js +0 -9
  59. package/esm/storages/KeyBuilderCS.js +0 -3
  60. package/esm/storages/KeyBuilderSS.js +0 -3
  61. package/esm/storages/inLocalStorage/SplitsCacheInLocal.js +14 -9
  62. package/esm/storages/inLocalStorage/index.js +1 -5
  63. package/esm/storages/inLocalStorage/validateCache.js +1 -2
  64. package/esm/storages/inMemory/InMemoryStorage.js +0 -3
  65. package/esm/storages/inMemory/InMemoryStorageCS.js +0 -4
  66. package/esm/storages/inRedis/index.js +9 -5
  67. package/esm/storages/pluggable/index.js +0 -2
  68. package/esm/sync/polling/fetchers/splitChangesFetcher.js +4 -51
  69. package/esm/sync/polling/pollingManagerCS.js +7 -7
  70. package/esm/sync/polling/syncTasks/splitsSyncTask.js +1 -1
  71. package/esm/sync/polling/updaters/mySegmentsUpdater.js +2 -2
  72. package/esm/sync/polling/updaters/segmentChangesUpdater.js +1 -1
  73. package/esm/sync/polling/updaters/splitChangesUpdater.js +33 -51
  74. package/esm/sync/streaming/SSEHandler/index.js +1 -2
  75. package/esm/sync/streaming/UpdateWorkers/SplitsUpdateWorker.js +73 -102
  76. package/esm/sync/streaming/constants.js +0 -1
  77. package/esm/sync/streaming/pushManager.js +19 -6
  78. package/esm/sync/syncManagerOnline.js +2 -2
  79. package/esm/utils/constants/index.js +1 -2
  80. package/esm/utils/labels/index.js +0 -1
  81. package/package.json +1 -1
  82. package/src/dtos/types.ts +8 -36
  83. package/src/evaluator/Engine.ts +69 -42
  84. package/src/evaluator/combiners/and.ts +4 -5
  85. package/src/evaluator/combiners/ifelseif.ts +9 -7
  86. package/src/evaluator/condition/engineUtils.ts +1 -1
  87. package/src/evaluator/condition/index.ts +12 -12
  88. package/src/evaluator/index.ts +14 -12
  89. package/src/evaluator/matchers/index.ts +1 -3
  90. package/src/evaluator/matchers/matcherTypes.ts +0 -1
  91. package/src/evaluator/matchersTransform/index.ts +0 -3
  92. package/src/evaluator/parser/index.ts +3 -3
  93. package/src/evaluator/types.ts +2 -2
  94. package/src/evaluator/value/index.ts +2 -2
  95. package/src/evaluator/value/sanitize.ts +4 -5
  96. package/src/logger/constants.ts +0 -2
  97. package/src/logger/messages/debug.ts +2 -4
  98. package/src/logger/messages/warn.ts +1 -1
  99. package/src/sdkManager/index.ts +2 -3
  100. package/src/services/splitApi.ts +4 -3
  101. package/src/services/types.ts +1 -1
  102. package/src/storages/AbstractSplitsCacheSync.ts +3 -6
  103. package/src/storages/KeyBuilder.ts +0 -12
  104. package/src/storages/KeyBuilderCS.ts +0 -4
  105. package/src/storages/KeyBuilderSS.ts +0 -4
  106. package/src/storages/inLocalStorage/SplitsCacheInLocal.ts +14 -10
  107. package/src/storages/inLocalStorage/index.ts +1 -5
  108. package/src/storages/inLocalStorage/validateCache.ts +1 -3
  109. package/src/storages/inMemory/InMemoryStorage.ts +0 -3
  110. package/src/storages/inMemory/InMemoryStorageCS.ts +0 -4
  111. package/src/storages/inRedis/index.ts +11 -7
  112. package/src/storages/pluggable/index.ts +0 -2
  113. package/src/storages/types.ts +1 -33
  114. package/src/sync/polling/fetchers/splitChangesFetcher.ts +4 -62
  115. package/src/sync/polling/fetchers/types.ts +0 -1
  116. package/src/sync/polling/pollingManagerCS.ts +7 -7
  117. package/src/sync/polling/syncTasks/splitsSyncTask.ts +1 -1
  118. package/src/sync/polling/types.ts +2 -2
  119. package/src/sync/polling/updaters/mySegmentsUpdater.ts +2 -2
  120. package/src/sync/polling/updaters/segmentChangesUpdater.ts +1 -1
  121. package/src/sync/polling/updaters/splitChangesUpdater.ts +42 -61
  122. package/src/sync/streaming/SSEHandler/index.ts +1 -2
  123. package/src/sync/streaming/SSEHandler/types.ts +2 -2
  124. package/src/sync/streaming/UpdateWorkers/SplitsUpdateWorker.ts +68 -98
  125. package/src/sync/streaming/constants.ts +0 -1
  126. package/src/sync/streaming/parseUtils.ts +2 -2
  127. package/src/sync/streaming/pushManager.ts +18 -6
  128. package/src/sync/streaming/types.ts +2 -3
  129. package/src/sync/syncManagerOnline.ts +2 -2
  130. package/src/utils/constants/index.ts +1 -2
  131. package/src/utils/labels/index.ts +0 -1
  132. package/src/utils/lang/index.ts +1 -1
  133. package/types/splitio.d.ts +1 -5
  134. package/cjs/evaluator/matchers/prerequisites.js +0 -22
  135. package/cjs/evaluator/matchers/rbsegment.js +0 -44
  136. package/cjs/storages/inLocalStorage/RBSegmentsCacheInLocal.js +0 -117
  137. package/cjs/storages/inMemory/RBSegmentsCacheInMemory.js +0 -61
  138. package/cjs/storages/inRedis/RBSegmentsCacheInRedis.js +0 -64
  139. package/cjs/storages/pluggable/RBSegmentsCachePluggable.js +0 -64
  140. package/esm/evaluator/matchers/prerequisites.js +0 -18
  141. package/esm/evaluator/matchers/rbsegment.js +0 -40
  142. package/esm/storages/inLocalStorage/RBSegmentsCacheInLocal.js +0 -114
  143. package/esm/storages/inMemory/RBSegmentsCacheInMemory.js +0 -58
  144. package/esm/storages/inRedis/RBSegmentsCacheInRedis.js +0 -61
  145. package/esm/storages/pluggable/RBSegmentsCachePluggable.js +0 -61
  146. package/src/evaluator/matchers/prerequisites.ts +0 -24
  147. package/src/evaluator/matchers/rbsegment.ts +0 -62
  148. package/src/storages/inLocalStorage/RBSegmentsCacheInLocal.ts +0 -136
  149. package/src/storages/inMemory/RBSegmentsCacheInMemory.ts +0 -68
  150. package/src/storages/inRedis/RBSegmentsCacheInRedis.ts +0 -79
  151. package/src/storages/pluggable/RBSegmentsCachePluggable.ts +0 -76
@@ -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: {
@@ -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() || storage.rbSegments.usesSegments())
130
+ if (storage.splits.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() || storage.rbSegments.usesSegments())
140
+ if (storage.splits.usesSegments())
141
141
  mySegmentsSyncTask.start();
142
142
  }
143
143
  }
@@ -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';
@@ -6,4 +6,3 @@ export var EXCEPTION = 'exception';
6
6
  export var SPLIT_ARCHIVED = 'archived';
7
7
  export var NOT_IN_SPLIT = 'not in split';
8
8
  export var UNSUPPORTED_MATCHER_TYPE = 'targeting rule type unsupported by sdk';
9
- export var PREREQUISITES_NOT_MET = 'prerequisites not met';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@splitsoftware/splitio-commons",
3
- "version": "2.2.1-rc.0",
3
+ "version": "2.2.1-rc.2",
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,11 +66,6 @@ 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
-
74
69
  interface IInLargeSegmentMatcher extends ISplitMatcherBase {
75
70
  matcherType: 'IN_LARGE_SEGMENT',
76
71
  userDefinedLargeSegmentMatcherData: IInLargeSegmentMatcherData
@@ -181,7 +176,7 @@ export type ISplitMatcher = IAllKeysMatcher | IInSegmentMatcher | IWhitelistMatc
181
176
  ILessThanOrEqualToMatcher | IBetweenMatcher | IEqualToSetMatcher | IContainsAnyOfSetMatcher | IContainsAllOfSetMatcher | IPartOfSetMatcher |
182
177
  IStartsWithMatcher | IEndsWithMatcher | IContainsStringMatcher | IInSplitTreatmentMatcher | IEqualToBooleanMatcher | IMatchesStringMatcher |
183
178
  IEqualToSemverMatcher | IGreaterThanOrEqualToSemverMatcher | ILessThanOrEqualToSemverMatcher | IBetweenSemverMatcher | IInListSemverMatcher |
184
- IInLargeSegmentMatcher | IInRBSegmentMatcher
179
+ IInLargeSegmentMatcher
185
180
 
186
181
  /** Split object */
187
182
  export interface ISplitPartition {
@@ -194,34 +189,19 @@ export interface ISplitCondition {
194
189
  combiner: 'AND',
195
190
  matchers: ISplitMatcher[]
196
191
  }
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
- }
192
+ partitions: ISplitPartition[]
193
+ label: string
194
+ conditionType: 'ROLLOUT' | 'WHITELIST'
211
195
  }
212
196
 
213
197
  export interface ISplit {
214
198
  name: string,
215
199
  changeNumber: number,
216
- status: 'ACTIVE' | 'ARCHIVED',
217
- conditions: ISplitCondition[],
218
- prerequisites?: {
219
- n: string,
220
- ts: string[]
221
- }[]
222
200
  killed: boolean,
223
201
  defaultTreatment: string,
224
202
  trafficTypeName: string,
203
+ conditions: ISplitCondition[],
204
+ status: 'ACTIVE' | 'ARCHIVED',
225
205
  seed: number,
226
206
  trafficAllocation?: number,
227
207
  trafficAllocationSeed?: number
@@ -237,16 +217,8 @@ export type ISplitPartial = Pick<ISplit, 'conditions' | 'configurations' | 'traf
237
217
 
238
218
  /** Interface of the parsed JSON response of `/splitChanges` */
239
219
  export interface ISplitChangesResponse {
240
- ff?: {
241
- t: number,
242
- s?: number,
243
- d: ISplit[]
244
- },
245
- rbs?: {
246
- t: number,
247
- s?: number,
248
- d: IRBSegment[]
249
- }
220
+ till: number,
221
+ splits: ISplit[]
250
222
  }
251
223
 
252
224
  /** Interface of the parsed JSON response of `/segmentChanges/{segmentName}` */
@@ -1,16 +1,14 @@
1
- import { get, isString } from '../utils/lang';
1
+ import { get } from '../utils/lang';
2
2
  import { parser } from './parser';
3
3
  import { keyParser } from '../utils/key';
4
4
  import { thenable } from '../utils/promise/thenable';
5
- import { NO_CONDITION_MATCH, SPLIT_ARCHIVED, SPLIT_KILLED, PREREQUISITES_NOT_MET } from '../utils/labels';
5
+ import { EXCEPTION, NO_CONDITION_MATCH, SPLIT_ARCHIVED, SPLIT_KILLED } from '../utils/labels';
6
6
  import { CONTROL } from '../utils/constants';
7
7
  import { ISplit, MaybeThenable } from '../dtos/types';
8
8
  import SplitIO from '../../types/splitio';
9
9
  import { IStorageAsync, IStorageSync } from '../storages/types';
10
- import { IEvaluation, IEvaluationResult, ISplitEvaluator } from './types';
10
+ import { IEvaluation, IEvaluationResult, IEvaluator, ISplitEvaluator } from './types';
11
11
  import { ILogger } from '../logger/types';
12
- import { ENGINE_DEFAULT } from '../logger/constants';
13
- import { prerequisitesMatcherContext } from './matchers/prerequisites';
14
12
 
15
13
  function evaluationResult(result: IEvaluation | undefined, defaultTreatment: string): IEvaluationResult {
16
14
  return {
@@ -19,55 +17,84 @@ function evaluationResult(result: IEvaluation | undefined, defaultTreatment: str
19
17
  };
20
18
  }
21
19
 
22
- export function engineParser(log: ILogger, split: ISplit, storage: IStorageSync | IStorageAsync) {
23
- const { killed, seed, trafficAllocation, trafficAllocationSeed, status, conditions, prerequisites } = split;
20
+ export class Engine {
24
21
 
25
- const defaultTreatment = isString(split.defaultTreatment) ? split.defaultTreatment : CONTROL;
22
+ constructor(private baseInfo: ISplit, private evaluator: IEvaluator) {
26
23
 
27
- const evaluator = parser(log, conditions, storage);
28
- const prerequisiteMatcher = prerequisitesMatcherContext(prerequisites, storage, log);
29
-
30
- return {
31
-
32
- getTreatment(key: SplitIO.SplitKey, attributes: SplitIO.Attributes | undefined, splitEvaluator: ISplitEvaluator): MaybeThenable<IEvaluationResult> {
24
+ // in case we don't have a default treatment in the instantiation, use 'control'
25
+ if (typeof this.baseInfo.defaultTreatment !== 'string') {
26
+ this.baseInfo.defaultTreatment = CONTROL;
27
+ }
28
+ }
33
29
 
34
- const parsedKey = keyParser(key);
30
+ static parse(log: ILogger, splitFlatStructure: ISplit, storage: IStorageSync | IStorageAsync) {
31
+ const conditions = splitFlatStructure.conditions;
32
+ const evaluator = parser(log, conditions, storage);
35
33
 
36
- function evaluate(prerequisitesMet: boolean) {
37
- if (!prerequisitesMet) {
38
- log.debug(ENGINE_DEFAULT, ['Prerequisite not met']);
39
- return {
40
- treatment: defaultTreatment,
41
- label: PREREQUISITES_NOT_MET
42
- };
43
- }
34
+ return new Engine(splitFlatStructure, evaluator);
35
+ }
44
36
 
45
- const evaluation = evaluator(parsedKey, seed, trafficAllocation, trafficAllocationSeed, attributes, splitEvaluator) as MaybeThenable<IEvaluation>;
37
+ getKey() {
38
+ return this.baseInfo.name;
39
+ }
46
40
 
47
- return thenable(evaluation) ?
48
- evaluation.then(result => evaluationResult(result, defaultTreatment)) :
49
- evaluationResult(evaluation, defaultTreatment);
50
- }
41
+ getTreatment(key: SplitIO.SplitKey, attributes: SplitIO.Attributes | undefined, splitEvaluator: ISplitEvaluator): MaybeThenable<IEvaluationResult> {
42
+ const {
43
+ killed,
44
+ seed,
45
+ defaultTreatment,
46
+ trafficAllocation,
47
+ trafficAllocationSeed
48
+ } = this.baseInfo;
49
+ let parsedKey;
50
+ let treatment;
51
+ let label;
51
52
 
52
- if (status === 'ARCHIVED') return {
53
+ try {
54
+ parsedKey = keyParser(key);
55
+ } catch (err) {
56
+ return {
53
57
  treatment: CONTROL,
54
- label: SPLIT_ARCHIVED
58
+ label: EXCEPTION
55
59
  };
60
+ }
61
+
62
+ if (this.isGarbage()) {
63
+ treatment = CONTROL;
64
+ label = SPLIT_ARCHIVED;
65
+ } else if (killed) {
66
+ treatment = defaultTreatment;
67
+ label = SPLIT_KILLED;
68
+ } else {
69
+ const evaluation = this.evaluator(
70
+ parsedKey,
71
+ seed,
72
+ trafficAllocation,
73
+ trafficAllocationSeed,
74
+ attributes,
75
+ splitEvaluator
76
+ );
56
77
 
57
- if (killed) {
58
- log.debug(ENGINE_DEFAULT, ['Flag is killed']);
59
- return {
60
- treatment: defaultTreatment,
61
- label: SPLIT_KILLED
62
- };
78
+ // Evaluation could be async, so we should handle that case checking for a
79
+ // thenable object
80
+ if (thenable(evaluation)) {
81
+ return evaluation.then(result => evaluationResult(result, defaultTreatment));
82
+ } else {
83
+ return evaluationResult(evaluation, defaultTreatment);
63
84
  }
85
+ }
64
86
 
65
- const prerequisitesMet = prerequisiteMatcher({ key, attributes }, splitEvaluator);
87
+ return {
88
+ treatment,
89
+ label
90
+ };
91
+ }
66
92
 
67
- return thenable(prerequisitesMet) ?
68
- prerequisitesMet.then(evaluate) :
69
- evaluate(prerequisitesMet);
70
- }
71
- };
93
+ isGarbage() {
94
+ return this.baseInfo.status === 'ARCHIVED';
95
+ }
72
96
 
97
+ getChangeNumber() {
98
+ return this.baseInfo.changeNumber;
99
+ }
73
100
  }
@@ -2,11 +2,10 @@ 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 { ISplitEvaluator } from '../types';
5
+ import { IMatcher } from '../types';
6
6
  import { ENGINE_COMBINER_AND } from '../../logger/constants';
7
- import SplitIO from '../../../types/splitio';
8
7
 
9
- export function andCombinerContext(log: ILogger, matchers: Array<(key: SplitIO.SplitKey, attributes?: SplitIO.Attributes, splitEvaluator?: ISplitEvaluator) => MaybeThenable<boolean>>) {
8
+ export function andCombinerContext(log: ILogger, matchers: IMatcher[]) {
10
9
 
11
10
  function andResults(results: boolean[]): boolean {
12
11
  // Array.prototype.every is supported by target environments
@@ -16,8 +15,8 @@ export function andCombinerContext(log: ILogger, matchers: Array<(key: SplitIO.S
16
15
  return hasMatchedAll;
17
16
  }
18
17
 
19
- return function andCombiner(key: SplitIO.SplitKey, attributes?: SplitIO.Attributes, splitEvaluator?: ISplitEvaluator): MaybeThenable<boolean> {
20
- const matcherResults = matchers.map(matcher => matcher(key, attributes, splitEvaluator));
18
+ return function andCombiner(...params: any): MaybeThenable<boolean> {
19
+ const matcherResults = matchers.map(matcher => matcher(...params));
21
20
 
22
21
  // If any matching result is a thenable we should use Promise.all
23
22
  if (findIndex(matcherResults, thenable) !== -1) {
@@ -1,4 +1,4 @@
1
- import { findIndex, isBoolean } from '../../utils/lang';
1
+ import { findIndex } 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,12 +18,14 @@ export function ifElseIfCombinerContext(log: ILogger, predicates: IEvaluator[]):
18
18
  };
19
19
  }
20
20
 
21
- function computeEvaluation(predicateResults: Array<IEvaluation | boolean | undefined>): IEvaluation | boolean | undefined {
22
- for (let i = 0, len = predicateResults.length; i < len; i++) {
21
+ function computeTreatment(predicateResults: Array<IEvaluation | undefined>) {
22
+ const len = predicateResults.length;
23
+
24
+ for (let i = 0; i < len; i++) {
23
25
  const evaluation = predicateResults[i];
24
26
 
25
27
  if (evaluation !== undefined) {
26
- if (!isBoolean(evaluation)) log.debug(ENGINE_COMBINER_IFELSEIF, [evaluation.treatment]);
28
+ log.debug(ENGINE_COMBINER_IFELSEIF, [evaluation.treatment]);
27
29
 
28
30
  return evaluation;
29
31
  }
@@ -33,7 +35,7 @@ export function ifElseIfCombinerContext(log: ILogger, predicates: IEvaluator[]):
33
35
  return undefined;
34
36
  }
35
37
 
36
- function ifElseIfCombiner(key: SplitIO.SplitKeyObject, seed?: number, trafficAllocation?: number, trafficAllocationSeed?: number, attributes?: SplitIO.Attributes, splitEvaluator?: ISplitEvaluator) {
38
+ function ifElseIfCombiner(key: SplitIO.SplitKey, seed: number, trafficAllocation?: number, trafficAllocationSeed?: number, attributes?: SplitIO.Attributes, splitEvaluator?: ISplitEvaluator) {
37
39
  // In Async environments we are going to have async predicates. There is none way to know
38
40
  // before hand so we need to evaluate all the predicates, verify for thenables, and finally,
39
41
  // define how to return the treatment (wrap result into a Promise or not).
@@ -41,10 +43,10 @@ export function ifElseIfCombinerContext(log: ILogger, predicates: IEvaluator[]):
41
43
 
42
44
  // if we find a thenable
43
45
  if (findIndex(predicateResults, thenable) !== -1) {
44
- return Promise.all(predicateResults).then(results => computeEvaluation(results));
46
+ return Promise.all(predicateResults).then(results => computeTreatment(results));
45
47
  }
46
48
 
47
- return computeEvaluation(predicateResults as IEvaluation[]);
49
+ return computeTreatment(predicateResults as IEvaluation[]);
48
50
  }
49
51
 
50
52
  // 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 | undefined, treatments: { getTreatmentFor: (x: number) => string }) {
8
+ export function getTreatment(log: ILogger, key: string, seed: number, treatments: { getTreatmentFor: (x: number) => string }) {
9
9
  const _bucket = bucket(key, seed);
10
10
 
11
11
  const treatment = treatments.getTreatmentFor(_bucket);