@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
@@ -7,14 +7,14 @@ import SplitIO from '../../../types/splitio';
7
7
  import { ILogger } from '../../logger/types';
8
8
 
9
9
  // Build Evaluation object if and only if matchingResult is true
10
- function match(log: ILogger, matchingResult: boolean, bucketingKey: string | undefined, seed: number, treatments: { getTreatmentFor: (x: number) => string }, label: string): IEvaluation | undefined {
10
+ function match(log: ILogger, matchingResult: boolean, bucketingKey: string | undefined, seed?: number, treatments?: { getTreatmentFor: (x: number) => string }, label?: string): IEvaluation | boolean | undefined {
11
11
  if (matchingResult) {
12
- const treatment = getTreatment(log, bucketingKey as string, seed, treatments);
13
-
14
- return {
15
- treatment,
16
- label
17
- };
12
+ return treatments ? // Feature flag
13
+ {
14
+ treatment: getTreatment(log, bucketingKey as string, seed, treatments),
15
+ label: label!
16
+ } : // Rule-based segment
17
+ true;
18
18
  }
19
19
 
20
20
  // else we should notify the engine to continue evaluating
@@ -22,12 +22,12 @@ function match(log: ILogger, matchingResult: boolean, bucketingKey: string | und
22
22
  }
23
23
 
24
24
  // Condition factory
25
- export function conditionContext(log: ILogger, matcherEvaluator: (...args: any) => MaybeThenable<boolean>, treatments: { getTreatmentFor: (x: number) => string }, label: string, conditionType: 'ROLLOUT' | 'WHITELIST'): IEvaluator {
25
+ export function conditionContext(log: ILogger, matcherEvaluator: (key: SplitIO.SplitKeyObject, attributes?: SplitIO.Attributes, splitEvaluator?: ISplitEvaluator) => MaybeThenable<boolean>, treatments?: { getTreatmentFor: (x: number) => string }, label?: string, conditionType?: 'ROLLOUT' | 'WHITELIST'): IEvaluator {
26
26
 
27
- return function conditionEvaluator(key: SplitIO.SplitKey, seed: number, trafficAllocation?: number, trafficAllocationSeed?: number, attributes?: SplitIO.Attributes, splitEvaluator?: ISplitEvaluator) {
27
+ return function conditionEvaluator(key: SplitIO.SplitKeyObject, seed?: number, trafficAllocation?: number, trafficAllocationSeed?: number, attributes?: SplitIO.Attributes, splitEvaluator?: ISplitEvaluator) {
28
28
 
29
29
  // Whitelisting has more priority than traffic allocation, so we don't apply this filtering to those conditions.
30
- if (conditionType === 'ROLLOUT' && !shouldApplyRollout(trafficAllocation as number, (key as SplitIO.SplitKeyObject).bucketingKey as string, trafficAllocationSeed as number)) {
30
+ if (conditionType === 'ROLLOUT' && !shouldApplyRollout(trafficAllocation!, key.bucketingKey, trafficAllocationSeed!)) {
31
31
  return {
32
32
  treatment: undefined, // treatment value is assigned later
33
33
  label: NOT_IN_SPLIT
@@ -41,10 +41,10 @@ export function conditionContext(log: ILogger, matcherEvaluator: (...args: any)
41
41
  const matches = matcherEvaluator(key, attributes, splitEvaluator);
42
42
 
43
43
  if (thenable(matches)) {
44
- return matches.then(result => match(log, result, (key as SplitIO.SplitKeyObject).bucketingKey, seed, treatments, label));
44
+ return matches.then(result => match(log, result, key.bucketingKey, seed, treatments, label));
45
45
  }
46
46
 
47
- return match(log, matches, (key as SplitIO.SplitKeyObject).bucketingKey, seed, treatments, label);
47
+ return match(log, matches, key.bucketingKey, seed, treatments, label);
48
48
  };
49
49
 
50
50
  }
@@ -43,8 +43,8 @@ export function evaluateFeature(
43
43
  if (thenable(parsedSplit)) {
44
44
  return parsedSplit.then((split) => getEvaluation(
45
45
  log,
46
- split,
47
46
  key,
47
+ split,
48
48
  attributes,
49
49
  storage,
50
50
  )).catch(
@@ -56,8 +56,8 @@ export function evaluateFeature(
56
56
 
57
57
  return getEvaluation(
58
58
  log,
59
- parsedSplit,
60
59
  key,
60
+ parsedSplit,
61
61
  attributes,
62
62
  storage,
63
63
  );
@@ -80,13 +80,13 @@ export function evaluateFeatures(
80
80
  }
81
81
 
82
82
  return thenable(parsedSplits) ?
83
- parsedSplits.then(splits => getEvaluations(log, splitNames, splits, key, attributes, storage))
83
+ parsedSplits.then(splits => getEvaluations(log, key, splitNames, splits, attributes, storage))
84
84
  .catch(() => {
85
85
  // Exception on async `getSplits` storage. For example, when the storage is redis or
86
86
  // pluggable and there is a connection issue and we can't retrieve the split to be evaluated
87
87
  return treatmentsException(splitNames);
88
88
  }) :
89
- getEvaluations(log, splitNames, parsedSplits, key, attributes, storage);
89
+ getEvaluations(log, key, splitNames, parsedSplits, attributes, storage);
90
90
  }
91
91
 
92
92
  export function evaluateFeaturesByFlagSets(
@@ -136,8 +136,8 @@ export function evaluateFeaturesByFlagSets(
136
136
 
137
137
  function getEvaluation(
138
138
  log: ILogger,
139
- splitJSON: ISplit | null,
140
139
  key: SplitIO.SplitKey,
140
+ splitJSON: ISplit | null,
141
141
  attributes: SplitIO.Attributes | undefined,
142
142
  storage: IStorageSync | IStorageAsync,
143
143
  ): MaybeThenable<IEvaluationResult> {
@@ -172,9 +172,9 @@ function getEvaluation(
172
172
 
173
173
  function getEvaluations(
174
174
  log: ILogger,
175
+ key: SplitIO.SplitKey,
175
176
  splitNames: string[],
176
177
  splits: Record<string, ISplit | null>,
177
- key: SplitIO.SplitKey,
178
178
  attributes: SplitIO.Attributes | undefined,
179
179
  storage: IStorageSync | IStorageAsync,
180
180
  ): MaybeThenable<Record<string, IEvaluationResult>> {
@@ -183,8 +183,8 @@ function getEvaluations(
183
183
  splitNames.forEach(splitName => {
184
184
  const evaluation = getEvaluation(
185
185
  log,
186
- splits[splitName],
187
186
  key,
187
+ splits[splitName],
188
188
  attributes,
189
189
  storage
190
190
  );
@@ -24,6 +24,7 @@ import { inListSemverMatcherContext } from './semver_inlist';
24
24
  import { IStorageAsync, IStorageSync } from '../../storages/types';
25
25
  import { IMatcher, IMatcherDto } from '../types';
26
26
  import { ILogger } from '../../logger/types';
27
+ import { ruleBasedSegmentMatcherContext } from './rbsegment';
27
28
 
28
29
  const matchers = [
29
30
  undefined, // UNDEFINED: 0
@@ -50,6 +51,7 @@ const matchers = [
50
51
  betweenSemverMatcherContext, // BETWEEN_SEMVER: 21
51
52
  inListSemverMatcherContext, // IN_LIST_SEMVER: 22
52
53
  largeSegmentMatcherContext, // IN_LARGE_SEGMENT: 23
54
+ ruleBasedSegmentMatcherContext // IN_RULE_BASED_SEGMENT: 24
53
55
  ];
54
56
 
55
57
  /**
@@ -64,5 +66,5 @@ export function matcherFactory(log: ILogger, matcherDto: IMatcherDto, storage?:
64
66
  let matcherFn;
65
67
  // @ts-ignore
66
68
  if (matchers[type]) matcherFn = matchers[type](value, storage, log); // There is no index-out-of-bound exception in JavaScript
67
- return matcherFn;
69
+ return matcherFn as IMatcher;
68
70
  }
@@ -23,6 +23,7 @@ export const matcherTypes: Record<string, number> = {
23
23
  BETWEEN_SEMVER: 21,
24
24
  IN_LIST_SEMVER: 22,
25
25
  IN_LARGE_SEGMENT: 23,
26
+ IN_RULE_BASED_SEGMENT: 24,
26
27
  };
27
28
 
28
29
  export const matcherDataTypes = {
@@ -0,0 +1,62 @@
1
+ import { IRBSegment, MaybeThenable } from '../../dtos/types';
2
+ import { IStorageAsync, IStorageSync } from '../../storages/types';
3
+ import { ILogger } from '../../logger/types';
4
+ import { IDependencyMatcherValue, ISplitEvaluator } from '../types';
5
+ import { thenable } from '../../utils/promise/thenable';
6
+ import { getMatching, keyParser } from '../../utils/key';
7
+ import { parser } from '../parser';
8
+
9
+
10
+ export function ruleBasedSegmentMatcherContext(segmentName: string, storage: IStorageSync | IStorageAsync, log: ILogger) {
11
+
12
+ return function ruleBasedSegmentMatcher({ key, attributes }: IDependencyMatcherValue, splitEvaluator: ISplitEvaluator): MaybeThenable<boolean> {
13
+
14
+ function matchConditions(rbsegment: IRBSegment) {
15
+ const conditions = rbsegment.conditions || [];
16
+ const evaluator = parser(log, conditions, storage);
17
+
18
+ const evaluation = evaluator(
19
+ keyParser(key),
20
+ undefined,
21
+ undefined,
22
+ undefined,
23
+ attributes,
24
+ splitEvaluator
25
+ );
26
+
27
+ return thenable(evaluation) ?
28
+ evaluation.then(evaluation => evaluation ? true : false) :
29
+ evaluation ? true : false;
30
+ }
31
+
32
+ function isExcluded(rbSegment: IRBSegment) {
33
+ const matchingKey = getMatching(key);
34
+ const excluded = rbSegment.excluded || {};
35
+
36
+ if (excluded.keys && excluded.keys.indexOf(matchingKey) !== -1) return true;
37
+
38
+ const isInSegment = (excluded.segments || []).map(segmentName => {
39
+ return storage.segments.isInSegment(segmentName, matchingKey);
40
+ });
41
+
42
+ return isInSegment.length && thenable(isInSegment[0]) ?
43
+ Promise.all(isInSegment).then(results => results.some(result => result)) :
44
+ isInSegment.some(result => result);
45
+ }
46
+
47
+ function isInSegment(rbSegment: IRBSegment | null) {
48
+ if (!rbSegment) return false;
49
+ const excluded = isExcluded(rbSegment);
50
+
51
+ return thenable(excluded) ?
52
+ excluded.then(excluded => excluded ? false : matchConditions(rbSegment)) :
53
+ excluded ? false : matchConditions(rbSegment);
54
+ }
55
+
56
+ const rbSegment = storage.rbSegments.get(segmentName);
57
+
58
+ return thenable(rbSegment) ?
59
+ rbSegment.then(isInSegment) :
60
+ isInSegment(rbSegment);
61
+ };
62
+ }
@@ -95,6 +95,9 @@ export function matchersTransform(matchers: ISplitMatcher[]): IMatcherDto[] {
95
95
  type === matcherTypes.LESS_THAN_OR_EQUAL_TO_SEMVER
96
96
  ) {
97
97
  value = stringMatcherData;
98
+ } else if (type === matcherTypes.IN_RULE_BASED_SEGMENT) {
99
+ value = segmentTransform(userDefinedSegmentMatcherData as IInSegmentMatcherData);
100
+ dataType = matcherDataTypes.NOT_SPECIFIED;
98
101
  }
99
102
 
100
103
  return {
@@ -37,7 +37,7 @@ export function parser(log: ILogger, conditions: ISplitCondition[], storage: ISt
37
37
  }
38
38
 
39
39
  // Evaluator function.
40
- return (key: string, attributes: SplitIO.Attributes | undefined, splitEvaluator: ISplitEvaluator) => {
40
+ return (key: SplitIO.SplitKey, attributes?: SplitIO.Attributes, splitEvaluator?: ISplitEvaluator) => {
41
41
  const value = sanitizeValue(log, key, matcherDto, attributes);
42
42
  let result: MaybeThenable<boolean> = false;
43
43
 
@@ -71,12 +71,12 @@ export function parser(log: ILogger, conditions: ISplitCondition[], storage: ISt
71
71
  predicates.push(conditionContext(
72
72
  log,
73
73
  andCombinerContext(log, expressions),
74
- Treatments.parse(partitions),
74
+ partitions && Treatments.parse(partitions),
75
75
  label,
76
76
  conditionType
77
77
  ));
78
78
  }
79
79
 
80
- // Instanciate evaluator given the set of conditions using if else if logic
80
+ // Instantiate evaluator given the set of conditions using if else if logic
81
81
  return ifElseIfCombinerContext(log, predicates);
82
82
  }
@@ -29,6 +29,6 @@ export type IEvaluationResult = IEvaluation & { treatment: string; impressionsDi
29
29
 
30
30
  export type ISplitEvaluator = (log: ILogger, key: SplitIO.SplitKey, splitName: string, attributes: SplitIO.Attributes | undefined, storage: IStorageSync | IStorageAsync) => MaybeThenable<IEvaluation>
31
31
 
32
- export type IEvaluator = (key: SplitIO.SplitKey, seed: number, trafficAllocation?: number, trafficAllocationSeed?: number, attributes?: SplitIO.Attributes, splitEvaluator?: ISplitEvaluator) => MaybeThenable<IEvaluation | undefined>
32
+ export type IEvaluator = (key: SplitIO.SplitKeyObject, seed?: number, trafficAllocation?: number, trafficAllocationSeed?: number, attributes?: SplitIO.Attributes, splitEvaluator?: ISplitEvaluator) => MaybeThenable<IEvaluation | boolean | undefined>
33
33
 
34
- export type IMatcher = (...args: any) => MaybeThenable<boolean>
34
+ export type IMatcher = (value: string | number | boolean | string[] | IDependencyMatcherValue, splitEvaluator?: ISplitEvaluator) => MaybeThenable<boolean>
@@ -4,7 +4,7 @@ import { ILogger } from '../../logger/types';
4
4
  import { sanitize } from './sanitize';
5
5
  import { ENGINE_VALUE, ENGINE_VALUE_NO_ATTRIBUTES, ENGINE_VALUE_INVALID } from '../../logger/constants';
6
6
 
7
- function parseValue(log: ILogger, key: string, attributeName: string | null, attributes?: SplitIO.Attributes) {
7
+ function parseValue(log: ILogger, key: SplitIO.SplitKey, attributeName: string | null, attributes?: SplitIO.Attributes) {
8
8
  let value = undefined;
9
9
  if (attributeName) {
10
10
  if (attributes) {
@@ -23,7 +23,7 @@ function parseValue(log: ILogger, key: string, attributeName: string | null, att
23
23
  /**
24
24
  * Defines value to be matched (key / attribute).
25
25
  */
26
- export function sanitizeValue(log: ILogger, key: string, matcherDto: IMatcherDto, attributes?: SplitIO.Attributes) {
26
+ export function sanitizeValue(log: ILogger, key: SplitIO.SplitKey, matcherDto: IMatcherDto, attributes?: SplitIO.Attributes) {
27
27
  const attributeName = matcherDto.attribute;
28
28
  const valueToMatch = parseValue(log, key, attributeName, attributes);
29
29
  const sanitizedValue = sanitize(log, matcherDto.type, valueToMatch, matcherDto.dataType, attributes);
@@ -41,7 +41,7 @@ function sanitizeBoolean(val: any): boolean | undefined {
41
41
  return undefined;
42
42
  }
43
43
 
44
- function dependencyProcessor(sanitizedValue: string, attributes?: SplitIO.Attributes): IDependencyMatcherValue {
44
+ function dependencyProcessor(sanitizedValue: SplitIO.SplitKey, attributes?: SplitIO.Attributes): IDependencyMatcherValue {
45
45
  return {
46
46
  key: sanitizedValue,
47
47
  attributes
@@ -60,6 +60,7 @@ function getProcessingFunction(matcherTypeID: number, dataType: string) {
60
60
  case matcherTypes.BETWEEN:
61
61
  return dataType === 'DATETIME' ? zeroSinceSS : undefined;
62
62
  case matcherTypes.IN_SPLIT_TREATMENT:
63
+ case matcherTypes.IN_RULE_BASED_SEGMENT:
63
64
  return dependencyProcessor;
64
65
  default:
65
66
  return undefined;
@@ -69,9 +70,9 @@ function getProcessingFunction(matcherTypeID: number, dataType: string) {
69
70
  /**
70
71
  * Sanitize matcher value
71
72
  */
72
- export function sanitize(log: ILogger, matcherTypeID: number, value: string | number | boolean | Array<string | number> | undefined, dataType: string, attributes?: SplitIO.Attributes) {
73
+ export function sanitize(log: ILogger, matcherTypeID: number, value: string | number | boolean | Array<string | number> | SplitIO.SplitKey | undefined, dataType: string, attributes?: SplitIO.Attributes) {
73
74
  const processor = getProcessingFunction(matcherTypeID, dataType);
74
- let sanitizedValue: string | number | boolean | Array<string | number> | IDependencyMatcherValue | undefined;
75
+ let sanitizedValue: string | number | boolean | Array<string> | IDependencyMatcherValue | undefined;
75
76
 
76
77
  switch (dataType) {
77
78
  case matcherDataTypes.NUMBER:
@@ -88,7 +89,7 @@ export function sanitize(log: ILogger, matcherTypeID: number, value: string | nu
88
89
  sanitizedValue = sanitizeBoolean(value);
89
90
  break;
90
91
  case matcherDataTypes.NOT_SPECIFIED:
91
- sanitizedValue = value;
92
+ sanitizedValue = value as any;
92
93
  break;
93
94
  default:
94
95
  sanitizedValue = undefined;
@@ -21,6 +21,7 @@ export const RETRIEVE_MANAGER = 29;
21
21
  export const SYNC_OFFLINE_DATA = 30;
22
22
  export const SYNC_SPLITS_FETCH = 31;
23
23
  export const SYNC_SPLITS_UPDATE = 32;
24
+ export const SYNC_RBS_UPDATE = 33;
24
25
  export const STREAMING_NEW_MESSAGE = 35;
25
26
  export const SYNC_TASK_START = 36;
26
27
  export const SYNC_TASK_EXECUTE = 37;
@@ -20,8 +20,9 @@ export const codesDebug: [number, string][] = codesInfo.concat([
20
20
  [c.RETRIEVE_MANAGER, 'Retrieving manager instance.'],
21
21
  // synchronizer
22
22
  [c.SYNC_OFFLINE_DATA, c.LOG_PREFIX_SYNC_OFFLINE + 'Feature flags data: \n%s'],
23
- [c.SYNC_SPLITS_FETCH, c.LOG_PREFIX_SYNC_SPLITS + 'Spin up feature flags update using since = %s'],
24
- [c.SYNC_SPLITS_UPDATE, c.LOG_PREFIX_SYNC_SPLITS + 'New feature flags %s. Removed feature flags %s. Segment names collected %s'],
23
+ [c.SYNC_SPLITS_FETCH, c.LOG_PREFIX_SYNC_SPLITS + 'Spin up feature flags update using since = %s and rbSince = %s.'],
24
+ [c.SYNC_SPLITS_UPDATE, c.LOG_PREFIX_SYNC_SPLITS + 'New feature flags %s. Removed feature flags %s.'],
25
+ [c.SYNC_RBS_UPDATE, c.LOG_PREFIX_SYNC_SPLITS + 'New rule-based segments %s. Removed rule-based segments %s.'],
25
26
  [c.STREAMING_NEW_MESSAGE, c.LOG_PREFIX_SYNC_STREAMING + 'New SSE message received, with data: %s.'],
26
27
  [c.SYNC_TASK_START, c.LOG_PREFIX_SYNC + ': Starting %s. Running each %s millis'],
27
28
  [c.SYNC_TASK_EXECUTE, c.LOG_PREFIX_SYNC + ': Running %s'],
@@ -33,7 +33,7 @@ export const codesWarn: [number, string][] = codesError.concat([
33
33
  [c.WARN_SDK_KEY, c.LOG_PREFIX_SETTINGS + ': You already have %s. We recommend keeping only one instance of the factory at all times (Singleton pattern) and reusing it throughout your application'],
34
34
 
35
35
  [c.STREAMING_PARSING_MEMBERSHIPS_UPDATE, c.LOG_PREFIX_SYNC_STREAMING + 'Fetching Memberships due to an error processing %s notification: %s'],
36
- [c.STREAMING_PARSING_SPLIT_UPDATE, c.LOG_PREFIX_SYNC_STREAMING + 'Fetching SplitChanges due to an error processing SPLIT_UPDATE notification: %s'],
36
+ [c.STREAMING_PARSING_SPLIT_UPDATE, c.LOG_PREFIX_SYNC_STREAMING + 'Fetching SplitChanges due to an error processing %s notification: %s'],
37
37
  [c.WARN_INVALID_FLAGSET, '%s: you passed %s, flag set must adhere to the regular expressions %s. This means a flag set must start with a letter or number, be in lowercase, alphanumeric and have a max length of 50 characters. %s was discarded.'],
38
38
  [c.WARN_LOWERCASE_FLAGSET, '%s: flag set %s should be all lowercase - converting string to lowercase.'],
39
39
  [c.WARN_FLAGSET_WITHOUT_FLAGS, '%s: you passed %s flag set that does not contain cached feature flag names. Please double check what flag sets are in use in the Split user interface.'],
@@ -17,7 +17,7 @@ function collectTreatments(splitObject: ISplit) {
17
17
  // Localstorage mode could fall into a no rollout conditions state. Take the first condition in that case.
18
18
  if (!allTreatmentsCondition) allTreatmentsCondition = conditions[0];
19
19
  // Then extract the treatments from the partitions
20
- return allTreatmentsCondition ? allTreatmentsCondition.partitions.map(v => v.treatment) : [];
20
+ return allTreatmentsCondition ? allTreatmentsCondition.partitions!.map(v => v.treatment) : [];
21
21
  }
22
22
 
23
23
  function objectToView(splitObject: ISplit | null): SplitIO.SplitView | null {
@@ -29,7 +29,6 @@ export function splitApiFactory(
29
29
  const urls = settings.urls;
30
30
  const filterQueryString = settings.sync.__splitFiltersValidation && settings.sync.__splitFiltersValidation.queryString;
31
31
  const SplitSDKImpressionsMode = settings.sync.impressionsMode;
32
- const flagSpecVersion = settings.sync.flagSpecVersion;
33
32
  const splitHttpClient = splitHttpClientFactory(settings, platform);
34
33
 
35
34
  return {
@@ -45,7 +44,7 @@ export function splitApiFactory(
45
44
  },
46
45
 
47
46
  fetchAuth(userMatchingKeys?: string[]) {
48
- let url = `${urls.auth}/v2/auth?s=${flagSpecVersion}`;
47
+ let url = `${urls.auth}/v2/auth?s=${settings.sync.flagSpecVersion}`;
49
48
  if (userMatchingKeys) { // `userMatchingKeys` is undefined in server-side
50
49
  const queryParams = userMatchingKeys.map(userKeyToQueryParam).join('&');
51
50
  if (queryParams) url += '&' + queryParams;
@@ -53,8 +52,8 @@ export function splitApiFactory(
53
52
  return splitHttpClient(url, undefined, telemetryTracker.trackHttp(TOKEN));
54
53
  },
55
54
 
56
- fetchSplitChanges(since: number, noCache?: boolean, till?: number) {
57
- const url = `${urls.sdk}/splitChanges?s=${flagSpecVersion}&since=${since}${filterQueryString || ''}${till ? '&till=' + till : ''}`;
55
+ fetchSplitChanges(since: number, noCache?: boolean, till?: number, rbSince?: number) {
56
+ const url = `${urls.sdk}/splitChanges?s=${settings.sync.flagSpecVersion}&since=${since}${rbSince ? '&rbSince=' + rbSince : ''}${filterQueryString || ''}${till ? '&till=' + till : ''}`;
58
57
  return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(SPLITS))
59
58
  .catch((err) => {
60
59
  if (err.statusCode === 414) settings.log.error(ERROR_TOO_MANY_SETS);
@@ -35,7 +35,7 @@ export type ISplitHttpClient = (url: string, options?: IRequestOptions, latencyT
35
35
 
36
36
  export type IFetchAuth = (userKeys?: string[]) => Promise<IResponse>
37
37
 
38
- export type IFetchSplitChanges = (since: number, noCache?: boolean, till?: number) => Promise<IResponse>
38
+ export type IFetchSplitChanges = (since: number, noCache?: boolean, till?: number, rbSince?: number) => Promise<IResponse>
39
39
 
40
40
  export type IFetchSegmentChanges = (since: number, segmentName: string, noCache?: boolean, till?: number) => Promise<IResponse>
41
41
 
@@ -1,5 +1,5 @@
1
1
  import { ISplitsCacheSync } from './types';
2
- import { ISplit } from '../dtos/types';
2
+ import { IRBSegment, ISplit } from '../dtos/types';
3
3
  import { objectAssign } from '../utils/lang/objectAssign';
4
4
  import { IN_SEGMENT, IN_LARGE_SEGMENT } from '../utils/constants';
5
5
 
@@ -72,8 +72,8 @@ export abstract class AbstractSplitsCacheSync implements ISplitsCacheSync {
72
72
  * Given a parsed split, it returns a boolean flagging if its conditions use segments matchers (rules & whitelists).
73
73
  * This util is intended to simplify the implementation of `splitsCache::usesSegments` method
74
74
  */
75
- export function usesSegments(split: ISplit) {
76
- const conditions = split.conditions || [];
75
+ export function usesSegments(ruleEntity: ISplit | IRBSegment) {
76
+ const conditions = ruleEntity.conditions || [];
77
77
  for (let i = 0; i < conditions.length; i++) {
78
78
  const matchers = conditions[i].matcherGroup.matchers;
79
79
 
@@ -83,5 +83,8 @@ export function usesSegments(split: ISplit) {
83
83
  }
84
84
  }
85
85
 
86
+ const excluded = (ruleEntity as IRBSegment).excluded;
87
+ if (excluded && excluded.segments && excluded.segments.length > 0) return true;
88
+
86
89
  return false;
87
90
  }
@@ -37,6 +37,18 @@ export class KeyBuilder {
37
37
  return `${this.prefix}.split.`;
38
38
  }
39
39
 
40
+ buildRBSegmentKey(rbsegmentName: string) {
41
+ return `${this.prefix}.rbsegment.${rbsegmentName}`;
42
+ }
43
+
44
+ buildRBSegmentsTillKey() {
45
+ return `${this.prefix}.rbsegments.till`;
46
+ }
47
+
48
+ buildRBSegmentKeyPrefix() {
49
+ return `${this.prefix}.rbsegment.`;
50
+ }
51
+
40
52
  buildSegmentNameKey(segmentName: string) {
41
53
  return `${this.prefix}.segment.${segmentName}`;
42
54
  }
@@ -47,6 +47,10 @@ export class KeyBuilderCS extends KeyBuilder implements MySegmentsKeyBuilder {
47
47
  return startsWith(key, `${this.prefix}.split.`);
48
48
  }
49
49
 
50
+ isRBSegmentKey(key: string) {
51
+ return startsWith(key, `${this.prefix}.rbsegment.`);
52
+ }
53
+
50
54
  buildSplitsWithSegmentCountKey() {
51
55
  return `${this.prefix}.splits.usingSegments`;
52
56
  }
@@ -53,6 +53,10 @@ export class KeyBuilderSS extends KeyBuilder {
53
53
  return `${this.buildSplitKeyPrefix()}*`;
54
54
  }
55
55
 
56
+ searchPatternForRBSegmentKeys() {
57
+ return `${this.buildRBSegmentKeyPrefix()}*`;
58
+ }
59
+
56
60
  /* Telemetry keys */
57
61
 
58
62
  buildLatencyKey(method: Method, bucket: number) {
@@ -0,0 +1,136 @@
1
+ import { IRBSegment } from '../../dtos/types';
2
+ import { ILogger } from '../../logger/types';
3
+ import { ISettings } from '../../types';
4
+ import { isFiniteNumber, isNaNNumber, toNumber } from '../../utils/lang';
5
+ import { setToArray } from '../../utils/lang/sets';
6
+ import { usesSegments } from '../AbstractSplitsCacheSync';
7
+ import { KeyBuilderCS } from '../KeyBuilderCS';
8
+ import { IRBSegmentsCacheSync } from '../types';
9
+ import { LOG_PREFIX } from './constants';
10
+
11
+ export class RBSegmentsCacheInLocal implements IRBSegmentsCacheSync {
12
+
13
+ private readonly keys: KeyBuilderCS;
14
+ private readonly log: ILogger;
15
+
16
+ constructor(settings: ISettings, keys: KeyBuilderCS) {
17
+ this.keys = keys;
18
+ this.log = settings.log;
19
+ }
20
+
21
+ clear() {
22
+ this.getNames().forEach(name => this.remove(name));
23
+ localStorage.removeItem(this.keys.buildRBSegmentsTillKey());
24
+ }
25
+
26
+ update(toAdd: IRBSegment[], toRemove: IRBSegment[], changeNumber: number): boolean {
27
+ this.setChangeNumber(changeNumber);
28
+ const updated = toAdd.map(toAdd => this.add(toAdd)).some(result => result);
29
+ return toRemove.map(toRemove => this.remove(toRemove.name)).some(result => result) || updated;
30
+ }
31
+
32
+ private setChangeNumber(changeNumber: number) {
33
+ try {
34
+ localStorage.setItem(this.keys.buildRBSegmentsTillKey(), changeNumber + '');
35
+ localStorage.setItem(this.keys.buildLastUpdatedKey(), Date.now() + '');
36
+ } catch (e) {
37
+ this.log.error(LOG_PREFIX + e);
38
+ }
39
+ }
40
+
41
+ private updateSegmentCount(diff: number) {
42
+ const segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
43
+ const count = toNumber(localStorage.getItem(segmentsCountKey)) + diff;
44
+ // @ts-expect-error
45
+ if (count > 0) localStorage.setItem(segmentsCountKey, count);
46
+ else localStorage.removeItem(segmentsCountKey);
47
+ }
48
+
49
+ private add(rbSegment: IRBSegment): boolean {
50
+ try {
51
+ const name = rbSegment.name;
52
+ const rbSegmentKey = this.keys.buildRBSegmentKey(name);
53
+ const rbSegmentFromLocalStorage = localStorage.getItem(rbSegmentKey);
54
+ const previous = rbSegmentFromLocalStorage ? JSON.parse(rbSegmentFromLocalStorage) : null;
55
+
56
+ localStorage.setItem(rbSegmentKey, JSON.stringify(rbSegment));
57
+
58
+ let usesSegmentsDiff = 0;
59
+ if (previous && usesSegments(previous)) usesSegmentsDiff--;
60
+ if (usesSegments(rbSegment)) usesSegmentsDiff++;
61
+ if (usesSegmentsDiff !== 0) this.updateSegmentCount(usesSegmentsDiff);
62
+
63
+ return true;
64
+ } catch (e) {
65
+ this.log.error(LOG_PREFIX + e);
66
+ return false;
67
+ }
68
+ }
69
+
70
+ private remove(name: string): boolean {
71
+ try {
72
+ const rbSegment = this.get(name);
73
+ if (!rbSegment) return false;
74
+
75
+ localStorage.removeItem(this.keys.buildRBSegmentKey(name));
76
+
77
+ if (usesSegments(rbSegment)) this.updateSegmentCount(-1);
78
+
79
+ return true;
80
+ } catch (e) {
81
+ this.log.error(LOG_PREFIX + e);
82
+ return false;
83
+ }
84
+ }
85
+
86
+ private getNames(): string[] {
87
+ const len = localStorage.length;
88
+ const accum = [];
89
+
90
+ let cur = 0;
91
+
92
+ while (cur < len) {
93
+ const key = localStorage.key(cur);
94
+
95
+ if (key != null && this.keys.isRBSegmentKey(key)) accum.push(this.keys.extractKey(key));
96
+
97
+ cur++;
98
+ }
99
+
100
+ return accum;
101
+ }
102
+
103
+ get(name: string): IRBSegment | null {
104
+ const item = localStorage.getItem(this.keys.buildRBSegmentKey(name));
105
+ return item && JSON.parse(item);
106
+ }
107
+
108
+ contains(names: Set<string>): boolean {
109
+ const namesArray = setToArray(names);
110
+ const namesInStorage = this.getNames();
111
+ return namesArray.every(name => namesInStorage.indexOf(name) !== -1);
112
+ }
113
+
114
+ getChangeNumber(): number {
115
+ const n = -1;
116
+ let value: string | number | null = localStorage.getItem(this.keys.buildRBSegmentsTillKey());
117
+
118
+ if (value !== null) {
119
+ value = parseInt(value, 10);
120
+
121
+ return isNaNNumber(value) ? n : value;
122
+ }
123
+
124
+ return n;
125
+ }
126
+
127
+ usesSegments(): boolean {
128
+ const storedCount = localStorage.getItem(this.keys.buildSplitsWithSegmentCountKey());
129
+ const splitsWithSegmentsCount = storedCount === null ? 0 : toNumber(storedCount);
130
+
131
+ return isFiniteNumber(splitsWithSegmentsCount) ?
132
+ splitsWithSegmentsCount > 0 :
133
+ true;
134
+ }
135
+
136
+ }
@@ -47,16 +47,14 @@ export class SplitsCacheInLocal extends AbstractSplitsCacheSync {
47
47
 
48
48
  private _incrementCounts(split: ISplit) {
49
49
  try {
50
- if (split) {
51
- const ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
52
- // @ts-expect-error
53
- localStorage.setItem(ttKey, toNumber(localStorage.getItem(ttKey)) + 1);
50
+ const ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
51
+ // @ts-expect-error
52
+ localStorage.setItem(ttKey, toNumber(localStorage.getItem(ttKey)) + 1);
54
53
 
55
- if (usesSegments(split)) {
56
- const segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
57
- // @ts-expect-error
58
- localStorage.setItem(segmentsCountKey, toNumber(localStorage.getItem(segmentsCountKey)) + 1);
59
- }
54
+ if (usesSegments(split)) {
55
+ const segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
56
+ // @ts-expect-error
57
+ localStorage.setItem(segmentsCountKey, toNumber(localStorage.getItem(segmentsCountKey)) + 1);
60
58
  }
61
59
  } catch (e) {
62
60
  this.log.error(LOG_PREFIX + e);
@@ -185,11 +183,9 @@ export class SplitsCacheInLocal extends AbstractSplitsCacheSync {
185
183
  const storedCount = localStorage.getItem(this.keys.buildSplitsWithSegmentCountKey());
186
184
  const splitsWithSegmentsCount = storedCount === null ? 0 : toNumber(storedCount);
187
185
 
188
- if (isFiniteNumber(splitsWithSegmentsCount)) {
189
- return splitsWithSegmentsCount > 0;
190
- } else {
191
- return true;
192
- }
186
+ return isFiniteNumber(splitsWithSegmentsCount) ?
187
+ splitsWithSegmentsCount > 0 :
188
+ true;
193
189
  }
194
190
 
195
191
  getNamesByFlagSets(flagSets: string[]): Set<string>[] {