@splitsoftware/splitio-commons 1.16.0 → 1.16.1-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (141) hide show
  1. package/CHANGES.txt +3 -0
  2. package/cjs/evaluator/matchers/index.js +3 -1
  3. package/cjs/evaluator/matchers/large_segment.js +16 -0
  4. package/cjs/evaluator/matchers/matcherTypes.js +1 -0
  5. package/cjs/evaluator/matchersTransform/index.js +1 -1
  6. package/cjs/logger/constants.js +4 -4
  7. package/cjs/logger/messages/info.js +0 -1
  8. package/cjs/readiness/readinessManager.js +11 -6
  9. package/cjs/readiness/sdkReadinessManager.js +5 -6
  10. package/cjs/sdkClient/sdkClientMethodCS.js +3 -4
  11. package/cjs/sdkClient/sdkClientMethodCSWithTT.js +4 -5
  12. package/cjs/sdkFactory/index.js +1 -1
  13. package/cjs/services/splitApi.js +4 -0
  14. package/cjs/storages/AbstractSplitsCacheAsync.js +2 -2
  15. package/cjs/storages/AbstractSplitsCacheSync.js +5 -5
  16. package/cjs/storages/KeyBuilder.js +3 -0
  17. package/cjs/storages/KeyBuilderCS.js +17 -5
  18. package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js +16 -4
  19. package/cjs/storages/inLocalStorage/index.js +6 -2
  20. package/cjs/storages/inMemory/InMemoryStorageCS.js +5 -0
  21. package/cjs/storages/inMemory/SplitsCacheInMemory.js +20 -11
  22. package/cjs/storages/inMemory/TelemetryCacheInMemory.js +7 -10
  23. package/cjs/sync/polling/pollingManagerCS.js +54 -30
  24. package/cjs/sync/polling/syncTasks/mySegmentsSyncTask.js +2 -2
  25. package/cjs/sync/polling/updaters/mySegmentsUpdater.js +13 -8
  26. package/cjs/sync/polling/updaters/splitChangesUpdater.js +2 -1
  27. package/cjs/sync/streaming/SSEHandler/index.js +1 -0
  28. package/cjs/sync/streaming/UpdateWorkers/MySegmentsUpdateWorker.js +6 -5
  29. package/cjs/sync/streaming/constants.js +2 -1
  30. package/cjs/sync/streaming/pushManager.js +96 -64
  31. package/cjs/sync/submitters/telemetrySubmitter.js +2 -0
  32. package/cjs/sync/syncManagerOnline.js +24 -14
  33. package/cjs/utils/constants/index.js +5 -1
  34. package/cjs/utils/settingsValidation/index.js +9 -4
  35. package/esm/evaluator/matchers/index.js +3 -1
  36. package/esm/evaluator/matchers/large_segment.js +12 -0
  37. package/esm/evaluator/matchers/matcherTypes.js +1 -0
  38. package/esm/evaluator/matchersTransform/index.js +1 -1
  39. package/esm/logger/constants.js +1 -1
  40. package/esm/logger/messages/info.js +0 -1
  41. package/esm/readiness/readinessManager.js +11 -6
  42. package/esm/readiness/sdkReadinessManager.js +5 -6
  43. package/esm/sdkClient/sdkClientMethodCS.js +4 -5
  44. package/esm/sdkClient/sdkClientMethodCSWithTT.js +5 -6
  45. package/esm/sdkFactory/index.js +1 -1
  46. package/esm/services/splitApi.js +5 -1
  47. package/esm/storages/AbstractSplitsCacheAsync.js +2 -2
  48. package/esm/storages/AbstractSplitsCacheSync.js +3 -3
  49. package/esm/storages/KeyBuilder.js +3 -0
  50. package/esm/storages/KeyBuilderCS.js +15 -4
  51. package/esm/storages/inLocalStorage/SplitsCacheInLocal.js +17 -5
  52. package/esm/storages/inLocalStorage/index.js +7 -3
  53. package/esm/storages/inMemory/InMemoryStorageCS.js +5 -0
  54. package/esm/storages/inMemory/SplitsCacheInMemory.js +21 -12
  55. package/esm/storages/inMemory/TelemetryCacheInMemory.js +7 -10
  56. package/esm/sync/polling/pollingManagerCS.js +55 -31
  57. package/esm/sync/polling/syncTasks/mySegmentsSyncTask.js +2 -2
  58. package/esm/sync/polling/updaters/mySegmentsUpdater.js +11 -6
  59. package/esm/sync/polling/updaters/splitChangesUpdater.js +2 -1
  60. package/esm/sync/streaming/SSEHandler/index.js +2 -1
  61. package/esm/sync/streaming/UpdateWorkers/MySegmentsUpdateWorker.js +6 -5
  62. package/esm/sync/streaming/constants.js +1 -0
  63. package/esm/sync/streaming/pushManager.js +96 -65
  64. package/esm/sync/submitters/telemetrySubmitter.js +2 -0
  65. package/esm/sync/syncManagerOnline.js +25 -15
  66. package/esm/utils/constants/index.js +4 -0
  67. package/esm/utils/settingsValidation/index.js +10 -5
  68. package/package.json +1 -1
  69. package/src/dtos/types.ts +7 -1
  70. package/src/evaluator/matchers/index.ts +2 -0
  71. package/src/evaluator/matchers/large_segment.ts +18 -0
  72. package/src/evaluator/matchers/matcherTypes.ts +1 -0
  73. package/src/evaluator/matchersTransform/index.ts +1 -1
  74. package/src/logger/constants.ts +1 -1
  75. package/src/logger/messages/info.ts +0 -1
  76. package/src/readiness/readinessManager.ts +11 -5
  77. package/src/readiness/sdkReadinessManager.ts +7 -7
  78. package/src/readiness/types.ts +3 -2
  79. package/src/sdkClient/sdkClientMethodCS.ts +4 -6
  80. package/src/sdkClient/sdkClientMethodCSWithTT.ts +5 -7
  81. package/src/sdkFactory/index.ts +1 -1
  82. package/src/services/splitApi.ts +6 -1
  83. package/src/services/types.ts +1 -0
  84. package/src/storages/AbstractSplitsCacheAsync.ts +2 -2
  85. package/src/storages/AbstractSplitsCacheSync.ts +4 -4
  86. package/src/storages/KeyBuilder.ts +3 -0
  87. package/src/storages/KeyBuilderCS.ts +25 -5
  88. package/src/storages/inLocalStorage/MySegmentsCacheInLocal.ts +3 -3
  89. package/src/storages/inLocalStorage/SplitsCacheInLocal.ts +20 -5
  90. package/src/storages/inLocalStorage/index.ts +8 -4
  91. package/src/storages/inMemory/InMemoryStorageCS.ts +5 -0
  92. package/src/storages/inMemory/SplitsCacheInMemory.ts +15 -10
  93. package/src/storages/inMemory/TelemetryCacheInMemory.ts +7 -11
  94. package/src/storages/types.ts +6 -4
  95. package/src/sync/polling/pollingManagerCS.ts +62 -27
  96. package/src/sync/polling/syncTasks/mySegmentsSyncTask.ts +8 -9
  97. package/src/sync/polling/types.ts +4 -3
  98. package/src/sync/polling/updaters/mySegmentsUpdater.ts +13 -10
  99. package/src/sync/polling/updaters/splitChangesUpdater.ts +4 -3
  100. package/src/sync/streaming/SSEHandler/index.ts +2 -1
  101. package/src/sync/streaming/SSEHandler/types.ts +14 -2
  102. package/src/sync/streaming/UpdateWorkers/MySegmentsUpdateWorker.ts +7 -5
  103. package/src/sync/streaming/constants.ts +1 -0
  104. package/src/sync/streaming/pushManager.ts +101 -63
  105. package/src/sync/streaming/types.ts +5 -3
  106. package/src/sync/submitters/telemetrySubmitter.ts +2 -0
  107. package/src/sync/submitters/types.ts +10 -4
  108. package/src/sync/syncManagerOnline.ts +19 -11
  109. package/src/types.ts +26 -1
  110. package/src/utils/constants/index.ts +5 -0
  111. package/src/utils/settingsValidation/index.ts +11 -6
  112. package/src/utils/settingsValidation/types.ts +1 -1
  113. package/types/dtos/types.d.ts +5 -1
  114. package/types/evaluator/matchers/large_segment.d.ts +5 -0
  115. package/types/logger/constants.d.ts +1 -1
  116. package/types/readiness/readinessManager.d.ts +2 -2
  117. package/types/readiness/sdkReadinessManager.d.ts +2 -3
  118. package/types/readiness/types.d.ts +3 -2
  119. package/types/services/types.d.ts +1 -0
  120. package/types/storages/AbstractSplitsCacheAsync.d.ts +1 -1
  121. package/types/storages/AbstractSplitsCacheSync.d.ts +3 -3
  122. package/types/storages/KeyBuilder.d.ts +1 -0
  123. package/types/storages/KeyBuilderCS.d.ts +7 -2
  124. package/types/storages/inLocalStorage/MySegmentsCacheInLocal.d.ts +2 -2
  125. package/types/storages/inLocalStorage/SplitsCacheInLocal.d.ts +1 -1
  126. package/types/storages/inMemory/SplitsCacheInMemory.d.ts +3 -2
  127. package/types/storages/inMemory/TelemetryCacheInMemory.d.ts +4 -6
  128. package/types/storages/types.d.ts +4 -3
  129. package/types/sync/polling/syncTasks/mySegmentsSyncTask.d.ts +2 -3
  130. package/types/sync/polling/types.d.ts +10 -3
  131. package/types/sync/polling/updaters/mySegmentsUpdater.d.ts +4 -4
  132. package/types/sync/streaming/SSEHandler/types.d.ts +13 -2
  133. package/types/sync/streaming/UpdateWorkers/MySegmentsUpdateWorker.d.ts +2 -1
  134. package/types/sync/streaming/constants.d.ts +1 -0
  135. package/types/sync/streaming/pushManager.d.ts +2 -0
  136. package/types/sync/streaming/types.d.ts +5 -4
  137. package/types/sync/submitters/types.d.ts +9 -3
  138. package/types/types.d.ts +25 -0
  139. package/types/utils/constants/index.d.ts +3 -0
  140. package/types/utils/settingsValidation/index.d.ts +2 -0
  141. package/types/utils/settingsValidation/types.d.ts +1 -1
@@ -2,7 +2,7 @@ import { submitterManagerFactory } from './submitters/submitterManager';
2
2
  import { PUSH_SUBSYSTEM_UP, PUSH_SUBSYSTEM_DOWN } from './streaming/constants';
3
3
  import { SYNC_START_POLLING, SYNC_CONTINUE_POLLING, SYNC_STOP_POLLING } from '../logger/constants';
4
4
  import { isConsentGranted } from '../consent';
5
- import { POLLING, STREAMING, SYNC_MODE_UPDATE } from '../utils/constants';
5
+ import { IN_LARGE_SEGMENT, IN_SEGMENT, POLLING, STREAMING, SYNC_MODE_UPDATE } from '../utils/constants';
6
6
  /**
7
7
  * Online SyncManager factory.
8
8
  * Can be used for server-side API, and client-side API with or without multiple clients.
@@ -114,43 +114,53 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
114
114
  shared: function (matchingKey, readinessManager, storage) {
115
115
  if (!pollingManager)
116
116
  return;
117
- var mySegmentsSyncTask = pollingManager.add(matchingKey, readinessManager, storage);
117
+ var _a = pollingManager.add(matchingKey, readinessManager, storage), msSyncTask = _a.msSyncTask, mlsSyncTask = _a.mlsSyncTask;
118
118
  return {
119
- isRunning: mySegmentsSyncTask.isRunning,
119
+ isRunning: msSyncTask.isRunning,
120
120
  start: function () {
121
121
  if (syncEnabled) {
122
122
  if (pushManager) {
123
123
  if (pollingManager.isRunning()) {
124
124
  // if doing polling, we must start the periodic fetch of data
125
- if (storage.splits.usesSegments())
126
- mySegmentsSyncTask.start();
125
+ if (storage.splits.usesMatcher(IN_SEGMENT))
126
+ msSyncTask.start();
127
+ if (mlsSyncTask && storage.splits.usesMatcher(IN_LARGE_SEGMENT))
128
+ mlsSyncTask.start();
127
129
  }
128
130
  else {
129
131
  // if not polling, we must execute the sync task for the initial fetch
130
132
  // of segments since `syncAll` was already executed when starting the main client
131
- mySegmentsSyncTask.execute();
133
+ msSyncTask.execute();
134
+ mlsSyncTask && mlsSyncTask.execute();
132
135
  }
133
- pushManager.add(matchingKey, mySegmentsSyncTask);
136
+ pushManager.add(matchingKey, msSyncTask, mlsSyncTask);
134
137
  }
135
138
  else {
136
- if (storage.splits.usesSegments())
137
- mySegmentsSyncTask.start();
139
+ if (storage.splits.usesMatcher(IN_SEGMENT))
140
+ msSyncTask.start();
141
+ if (mlsSyncTask && storage.splits.usesMatcher(IN_LARGE_SEGMENT))
142
+ mlsSyncTask.start();
138
143
  }
139
144
  }
140
145
  else {
141
- if (!readinessManager.isReady())
142
- mySegmentsSyncTask.execute();
146
+ if (!readinessManager.isReady()) {
147
+ msSyncTask.execute();
148
+ mlsSyncTask && mlsSyncTask.execute();
149
+ }
143
150
  }
144
151
  },
145
152
  stop: function () {
146
153
  // check in case `client.destroy()` has been invoked more than once for the same client
147
- var mySegmentsSyncTask = pollingManager.get(matchingKey);
148
- if (mySegmentsSyncTask) {
154
+ var syncTasks = pollingManager.get(matchingKey);
155
+ if (syncTasks) {
156
+ var msSyncTask_1 = syncTasks.msSyncTask, mlsSyncTask_1 = syncTasks.mlsSyncTask;
149
157
  // stop syncing
150
158
  if (pushManager)
151
159
  pushManager.remove(matchingKey);
152
- if (mySegmentsSyncTask.isRunning())
153
- mySegmentsSyncTask.stop();
160
+ if (msSyncTask_1.isRunning())
161
+ msSyncTask_1.stop();
162
+ if (mlsSyncTask_1 && mlsSyncTask_1.isRunning())
163
+ mlsSyncTask_1.stop();
154
164
  pollingManager.remove(matchingKey);
155
165
  }
156
166
  },
@@ -61,6 +61,7 @@ export var TELEMETRY = 'te';
61
61
  export var TOKEN = 'to';
62
62
  export var SEGMENT = 'se';
63
63
  export var MY_SEGMENT = 'ms';
64
+ export var MY_LARGE_SEGMENT = 'mls';
64
65
  export var TREATMENT = 't';
65
66
  export var TREATMENTS = 'ts';
66
67
  export var TREATMENT_WITH_CONFIG = 'tc';
@@ -87,3 +88,6 @@ export var DISABLED = 0;
87
88
  export var ENABLED = 1;
88
89
  export var PAUSED = 2;
89
90
  export var FLAG_SPEC_VERSION = '1.1';
91
+ // Matcher types
92
+ export var IN_SEGMENT = 'IN_SEGMENT';
93
+ export var IN_LARGE_SEGMENT = 'IN_LARGE_SEGMENT';
@@ -5,7 +5,7 @@ import { STANDALONE_MODE, OPTIMIZED, LOCALHOST_MODE, DEBUG, FLAG_SPEC_VERSION }
5
5
  import { validImpressionsMode } from './impressionsMode';
6
6
  import { validateKey } from '../inputValidation/key';
7
7
  import { validateTrafficType } from '../inputValidation/trafficType';
8
- import { ERROR_MIN_CONFIG_PARAM } from '../../logger/constants';
8
+ import { ERROR_MIN_CONFIG_PARAM, LOG_PREFIX_CLIENT_INSTANTIATION } from '../../logger/constants';
9
9
  // Exported for telemetry
10
10
  export var base = {
11
11
  // Define which kind of object you want to retrieve from SplitFactory
@@ -27,6 +27,8 @@ export var base = {
27
27
  featuresRefreshRate: 60,
28
28
  // fetch segments updates each 60 sec
29
29
  segmentsRefreshRate: 60,
30
+ // fetch large segments updates each 60 sec
31
+ largeSegmentsRefreshRate: 60,
30
32
  // publish telemetry stats each 3600 secs (1 hour)
31
33
  telemetryRefreshRate: 3600,
32
34
  // publish evaluations each 300 sec (default value for OPTIMIZED impressions mode)
@@ -72,7 +74,8 @@ export var base = {
72
74
  impressionsMode: OPTIMIZED,
73
75
  localhostMode: undefined,
74
76
  enabled: true,
75
- flagSpecVersion: FLAG_SPEC_VERSION
77
+ flagSpecVersion: FLAG_SPEC_VERSION,
78
+ largeSegmentsEnabled: false
76
79
  },
77
80
  // Logger
78
81
  log: undefined
@@ -111,6 +114,7 @@ export function settingsValidation(config, validationParams) {
111
114
  var scheduler = withDefaults.scheduler, startup = withDefaults.startup;
112
115
  scheduler.featuresRefreshRate = fromSecondsToMillis(scheduler.featuresRefreshRate);
113
116
  scheduler.segmentsRefreshRate = fromSecondsToMillis(scheduler.segmentsRefreshRate);
117
+ scheduler.largeSegmentsRefreshRate = fromSecondsToMillis(scheduler.largeSegmentsRefreshRate);
114
118
  scheduler.offlineRefreshRate = fromSecondsToMillis(scheduler.offlineRefreshRate);
115
119
  scheduler.eventsPushRate = fromSecondsToMillis(scheduler.eventsPushRate);
116
120
  scheduler.telemetryRefreshRate = fromSecondsToMillis(validateMinValue('telemetryRefreshRate', scheduler.telemetryRefreshRate, 60));
@@ -143,12 +147,12 @@ export function settingsValidation(config, validationParams) {
143
147
  // Keeping same behaviour than JS SDK: if settings key or TT are invalid,
144
148
  // `false` value is used as bound key/TT of the default client, which leads to some issues.
145
149
  // @ts-ignore, @TODO handle invalid keys as a non-recoverable error?
146
- withDefaults.core.key = validateKey(log, maybeKey, 'Client instantiation');
150
+ withDefaults.core.key = validateKey(log, maybeKey, LOG_PREFIX_CLIENT_INSTANTIATION);
147
151
  }
148
152
  if (validationParams.acceptTT) {
149
153
  var maybeTT = withDefaults.core.trafficType;
150
154
  if (maybeTT !== undefined) { // @ts-ignore
151
- withDefaults.core.trafficType = validateTrafficType(log, maybeTT, 'Client instantiation');
155
+ withDefaults.core.trafficType = validateTrafficType(log, maybeTT, LOG_PREFIX_CLIENT_INSTANTIATION);
152
156
  }
153
157
  }
154
158
  }
@@ -183,9 +187,10 @@ export function settingsValidation(config, validationParams) {
183
187
  var splitFiltersValidation = validateSplitFilters(log, sync.splitFilters, withDefaults.mode);
184
188
  sync.splitFilters = splitFiltersValidation.validFilters;
185
189
  sync.__splitFiltersValidation = splitFiltersValidation;
190
+ // ensure a valid flag spec version
186
191
  sync.flagSpecVersion = flagSpec ? flagSpec(withDefaults) : FLAG_SPEC_VERSION;
187
192
  // ensure a valid user consent value
188
193
  // @ts-ignore, modify readonly prop
189
- withDefaults.userConsent = consent(withDefaults);
194
+ withDefaults.userConsent = consent ? consent(withDefaults) : undefined;
190
195
  return withDefaults;
191
196
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@splitsoftware/splitio-commons",
3
- "version": "1.16.0",
3
+ "version": "1.16.1-rc.0",
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
@@ -61,6 +61,11 @@ interface IInSegmentMatcher extends ISplitMatcherBase {
61
61
  userDefinedSegmentMatcherData: IInSegmentMatcherData
62
62
  }
63
63
 
64
+ interface IInLargeSegmentMatcher extends ISplitMatcherBase {
65
+ matcherType: 'IN_LARGE_SEGMENT',
66
+ userDefinedSegmentMatcherData: IInSegmentMatcherData
67
+ }
68
+
64
69
  interface IWhitelistMatcher extends ISplitMatcherBase {
65
70
  matcherType: 'WHITELIST',
66
71
  whitelistMatcherData: IWhitelistMatcherData
@@ -165,7 +170,8 @@ interface IInListSemverMatcher extends ISplitMatcherBase {
165
170
  export type ISplitMatcher = IAllKeysMatcher | IInSegmentMatcher | IWhitelistMatcher | IEqualToMatcher | IGreaterThanOrEqualToMatcher |
166
171
  ILessThanOrEqualToMatcher | IBetweenMatcher | IEqualToSetMatcher | IContainsAnyOfSetMatcher | IContainsAllOfSetMatcher | IPartOfSetMatcher |
167
172
  IStartsWithMatcher | IEndsWithMatcher | IContainsStringMatcher | IInSplitTreatmentMatcher | IEqualToBooleanMatcher | IMatchesStringMatcher |
168
- IEqualToSemverMatcher | IGreaterThanOrEqualToSemverMatcher | ILessThanOrEqualToSemverMatcher | IBetweenSemverMatcher | IInListSemverMatcher
173
+ IEqualToSemverMatcher | IGreaterThanOrEqualToSemverMatcher | ILessThanOrEqualToSemverMatcher | IBetweenSemverMatcher | IInListSemverMatcher |
174
+ IInLargeSegmentMatcher
169
175
 
170
176
  /** Split object */
171
177
  export interface ISplitPartition {
@@ -1,5 +1,6 @@
1
1
  import { allMatcherContext } from './all';
2
2
  import { segmentMatcherContext } from './segment';
3
+ import { largeSegmentMatcherContext } from './large_segment';
3
4
  import { whitelistMatcherContext } from './whitelist';
4
5
  import { equalToMatcherContext } from './eq';
5
6
  import { greaterThanEqualMatcherContext } from './gte';
@@ -48,6 +49,7 @@ const matchers = [
48
49
  lessThanEqualToSemverMatcherContext, // LESS_THAN_OR_EQUAL_TO_SEMVER: 20
49
50
  betweenSemverMatcherContext, // BETWEEN_SEMVER: 21
50
51
  inListSemverMatcherContext, // IN_LIST_SEMVER: 22
52
+ largeSegmentMatcherContext, // IN_LARGE_SEGMENT: 23
51
53
  ];
52
54
 
53
55
  /**
@@ -0,0 +1,18 @@
1
+ import { MaybeThenable } from '../../dtos/types';
2
+ import { ISegmentsCacheBase } from '../../storages/types';
3
+ import { thenable } from '../../utils/promise/thenable';
4
+
5
+ export function largeSegmentMatcherContext(largeSegmentName: string, storage: { largeSegments?: ISegmentsCacheBase }) {
6
+
7
+ return function largeSegmentMatcher(key: string): MaybeThenable<boolean> {
8
+ const isInLargeSegment = storage.largeSegments ? storage.largeSegments.isInSegment(largeSegmentName, key) : false;
9
+
10
+ if (thenable(isInLargeSegment)) {
11
+ isInLargeSegment.then(result => {
12
+ return result;
13
+ });
14
+ }
15
+
16
+ return isInLargeSegment;
17
+ };
18
+ }
@@ -22,6 +22,7 @@ export const matcherTypes: Record<string, number> = {
22
22
  LESS_THAN_OR_EQUAL_TO_SEMVER: 20,
23
23
  BETWEEN_SEMVER: 21,
24
24
  IN_LIST_SEMVER: 22,
25
+ IN_LARGE_SEGMENT: 23,
25
26
  };
26
27
 
27
28
  export const matcherDataTypes = {
@@ -33,7 +33,7 @@ export function matchersTransform(matchers: ISplitMatcher[]): IMatcherDto[] {
33
33
  let dataType = matcherDataTypes.STRING;
34
34
  let value = undefined;
35
35
 
36
- if (type === matcherTypes.IN_SEGMENT) {
36
+ if (type === matcherTypes.IN_SEGMENT || type === matcherTypes.IN_LARGE_SEGMENT) {
37
37
  value = segmentTransform(userDefinedSegmentMatcherData as IInSegmentMatcherData);
38
38
  } else if (type === matcherTypes.EQUAL_TO) {
39
39
  value = numericTransform(unaryNumericMatcherData as IUnaryNumericMatcherData);
@@ -36,7 +36,6 @@ export const IMPRESSION = 102;
36
36
  export const IMPRESSION_QUEUEING = 103;
37
37
  export const NEW_SHARED_CLIENT = 104;
38
38
  export const NEW_FACTORY = 105;
39
- export const POLLING_SMART_PAUSING = 106;
40
39
  export const POLLING_START = 107;
41
40
  export const POLLING_STOP = 108;
42
41
  export const SYNC_SPLITS_FETCH_RETRY = 109;
@@ -120,6 +119,7 @@ export const ENGINE_MATCHER_ERROR = 329;
120
119
  // Log prefixes (a.k.a. tags or categories)
121
120
  export const LOG_PREFIX_SETTINGS = 'settings';
122
121
  export const LOG_PREFIX_INSTANTIATION = 'Factory instantiation';
122
+ export const LOG_PREFIX_CLIENT_INSTANTIATION = 'Client instantiation';
123
123
  export const LOG_PREFIX_ENGINE = 'engine';
124
124
  export const LOG_PREFIX_ENGINE_COMBINER = LOG_PREFIX_ENGINE + ':combiner: ';
125
125
  export const LOG_PREFIX_ENGINE_MATCHER = LOG_PREFIX_ENGINE + ':matcher: ';
@@ -19,7 +19,6 @@ export const codesInfo: [number, string][] = codesWarn.concat([
19
19
  [c.USER_CONSENT_INITIAL, 'Starting the SDK with %s user consent. No data will be sent.'],
20
20
 
21
21
  // synchronizer
22
- [c.POLLING_SMART_PAUSING, c.LOG_PREFIX_SYNC_POLLING + 'Turning segments data polling %s.'],
23
22
  [c.POLLING_START, c.LOG_PREFIX_SYNC_POLLING + 'Starting polling'],
24
23
  [c.POLLING_STOP, c.LOG_PREFIX_SYNC_POLLING + 'Stopping polling'],
25
24
  [c.SYNC_SPLITS_FETCH_RETRY, c.LOG_PREFIX_SYNC_SPLITS + 'Retrying download of feature flags #%s. Reason: %s'],
@@ -1,5 +1,5 @@
1
1
  import { objectAssign } from '../utils/lang/objectAssign';
2
- import { IEventEmitter } from '../types';
2
+ import { IEventEmitter, ISettings } from '../types';
3
3
  import { SDK_SPLITS_ARRIVED, SDK_SPLITS_CACHE_LOADED, SDK_SEGMENTS_ARRIVED, SDK_READY_TIMED_OUT, SDK_READY_FROM_CACHE, SDK_UPDATE, SDK_READY } from './constants';
4
4
  import { IReadinessEventEmitter, IReadinessManager, ISegmentsEventEmitter, ISplitsEventEmitter } from './types';
5
5
 
@@ -33,10 +33,13 @@ function segmentsEventEmitterFactory(EventEmitter: new () => IEventEmitter): ISe
33
33
  */
34
34
  export function readinessManagerFactory(
35
35
  EventEmitter: new () => IEventEmitter,
36
- readyTimeout = 0,
36
+ settings: ISettings,
37
37
  splits: ISplitsEventEmitter = splitsEventEmitterFactory(EventEmitter)): IReadinessManager {
38
38
 
39
+ const { startup: { readyTimeout, waitForLargeSegments }, sync: { largeSegmentsEnabled } } = settings;
40
+
39
41
  const segments: ISegmentsEventEmitter = segmentsEventEmitterFactory(EventEmitter);
42
+ const largeSegments = largeSegmentsEnabled && waitForLargeSegments ? segmentsEventEmitterFactory(EventEmitter) : undefined;
40
43
  const gate: IReadinessEventEmitter = new EventEmitter();
41
44
 
42
45
  // emit SDK_READY_FROM_CACHE
@@ -62,6 +65,7 @@ export function readinessManagerFactory(
62
65
  let isReady = false;
63
66
  splits.on(SDK_SPLITS_ARRIVED, checkIsReadyOrUpdate);
64
67
  segments.on(SDK_SEGMENTS_ARRIVED, checkIsReadyOrUpdate);
68
+ if (largeSegments) largeSegments.on(SDK_SEGMENTS_ARRIVED, checkIsReadyOrUpdate);
65
69
 
66
70
  let isDestroyed = false;
67
71
 
@@ -87,7 +91,7 @@ export function readinessManagerFactory(
87
91
  setTimeout(() => { throw e; }, 0);
88
92
  }
89
93
  } else {
90
- if (splits.splitsArrived && segments.segmentsArrived) {
94
+ if (splits.splitsArrived && segments.segmentsArrived && (!largeSegments || largeSegments.segmentsArrived)) {
91
95
  clearTimeout(readyTimeoutId);
92
96
  isReady = true;
93
97
  try {
@@ -105,11 +109,12 @@ export function readinessManagerFactory(
105
109
  return {
106
110
  splits,
107
111
  segments,
112
+ largeSegments,
108
113
  gate,
109
114
 
110
- shared(readyTimeout = 0) {
115
+ shared() {
111
116
  refCount++;
112
- return readinessManagerFactory(EventEmitter, readyTimeout, splits);
117
+ return readinessManagerFactory(EventEmitter, settings, splits);
113
118
  },
114
119
 
115
120
  // @TODO review/remove next methods when non-recoverable errors are reworked
@@ -123,6 +128,7 @@ export function readinessManagerFactory(
123
128
  isDestroyed = true;
124
129
 
125
130
  segments.removeAllListeners();
131
+ if (largeSegments) largeSegments.removeAllListeners();
126
132
  gate.removeAllListeners();
127
133
  clearTimeout(readyTimeoutId);
128
134
 
@@ -2,9 +2,8 @@ import { objectAssign } from '../utils/lang/objectAssign';
2
2
  import { promiseWrapper } from '../utils/promise/wrapper';
3
3
  import { readinessManagerFactory } from './readinessManager';
4
4
  import { ISdkReadinessManager } from './types';
5
- import { IEventEmitter } from '../types';
5
+ import { IEventEmitter, ISettings } from '../types';
6
6
  import { SDK_READY, SDK_READY_TIMED_OUT, SDK_READY_FROM_CACHE, SDK_UPDATE } from './constants';
7
- import { ILogger } from '../logger/types';
8
7
  import { ERROR_CLIENT_LISTENER, CLIENT_READY_FROM_CACHE, CLIENT_READY, CLIENT_NO_LISTENER } from '../logger/constants';
9
8
 
10
9
  const NEW_LISTENER_EVENT = 'newListener';
@@ -18,10 +17,11 @@ const REMOVE_LISTENER_EVENT = 'removeListener';
18
17
  * @param readinessManager optional readinessManager to use. only used internally for `shared` method
19
18
  */
20
19
  export function sdkReadinessManagerFactory(
21
- log: ILogger,
22
20
  EventEmitter: new () => IEventEmitter,
23
- readyTimeout = 0,
24
- readinessManager = readinessManagerFactory(EventEmitter, readyTimeout)): ISdkReadinessManager {
21
+ settings: ISettings,
22
+ readinessManager = readinessManagerFactory(EventEmitter, settings)): ISdkReadinessManager {
23
+
24
+ const log = settings.log;
25
25
 
26
26
  /** Ready callback warning */
27
27
  let internalReadyCbCount = 0;
@@ -72,8 +72,8 @@ export function sdkReadinessManagerFactory(
72
72
  return {
73
73
  readinessManager,
74
74
 
75
- shared(readyTimeout = 0) {
76
- return sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, readinessManager.shared(readyTimeout));
75
+ shared() {
76
+ return sdkReadinessManagerFactory(EventEmitter, settings, readinessManager.shared());
77
77
  },
78
78
 
79
79
  incInternalReadyCbCount() {
@@ -45,6 +45,7 @@ export interface IReadinessManager {
45
45
  /** Event emitters */
46
46
  splits: ISplitsEventEmitter,
47
47
  segments: ISegmentsEventEmitter,
48
+ largeSegments?: ISegmentsEventEmitter, // Undefined if largeSegmentsEnabled or waitForLargeSegments are false
48
49
  gate: IReadinessEventEmitter,
49
50
 
50
51
  /** Readiness status */
@@ -59,7 +60,7 @@ export interface IReadinessManager {
59
60
  destroy(): void,
60
61
 
61
62
  /** for client-side */
62
- shared(readyTimeout?: number): IReadinessManager,
63
+ shared(): IReadinessManager,
63
64
  }
64
65
 
65
66
  /** SDK readiness manager */
@@ -75,5 +76,5 @@ export interface ISdkReadinessManager {
75
76
  incInternalReadyCbCount(): void
76
77
 
77
78
  /** for client-side */
78
- shared(readyTimeout?: number): ISdkReadinessManager
79
+ shared(): ISdkReadinessManager
79
80
  }
@@ -5,7 +5,7 @@ import { getMatching, keyParser } from '../utils/key';
5
5
  import { sdkClientFactory } from './sdkClient';
6
6
  import { ISyncManagerCS } from '../sync/types';
7
7
  import { objectAssign } from '../utils/lang/objectAssign';
8
- import { RETRIEVE_CLIENT_DEFAULT, NEW_SHARED_CLIENT, RETRIEVE_CLIENT_EXISTING } from '../logger/constants';
8
+ import { RETRIEVE_CLIENT_DEFAULT, NEW_SHARED_CLIENT, RETRIEVE_CLIENT_EXISTING, LOG_PREFIX_CLIENT_INSTANTIATION } from '../logger/constants';
9
9
  import { SDK_SEGMENTS_ARRIVED } from '../readiness/constants';
10
10
  import { ISdkFactoryContext } from '../sdkFactory/types';
11
11
 
@@ -14,14 +14,12 @@ function buildInstanceId(key: SplitIO.SplitKey) {
14
14
  return `${key.matchingKey ? key.matchingKey : key}-${key.bucketingKey ? key.bucketingKey : key}-`;
15
15
  }
16
16
 
17
- const method = 'Client instantiation';
18
-
19
17
  /**
20
18
  * Factory of client method for the client-side API variant where TT is ignored.
21
19
  * Therefore, clients don't have a bound TT for the track method.
22
20
  */
23
21
  export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: SplitIO.SplitKey) => SplitIO.ICsClient {
24
- const { storage, syncManager, sdkReadinessManager, settings: { core: { key }, startup: { readyTimeout }, log } } = params;
22
+ const { storage, syncManager, sdkReadinessManager, settings: { core: { key }, log } } = params;
25
23
 
26
24
  const mainClientInstance = clientCSDecorator(
27
25
  log,
@@ -43,7 +41,7 @@ export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: Spl
43
41
  }
44
42
 
45
43
  // Validate the key value. The trafficType (2nd argument) is ignored
46
- const validKey = validateKey(log, key, method);
44
+ const validKey = validateKey(log, key, LOG_PREFIX_CLIENT_INSTANTIATION);
47
45
  if (validKey === false) {
48
46
  throw new Error('Shared Client needs a valid key.');
49
47
  }
@@ -53,7 +51,7 @@ export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: Spl
53
51
  if (!clientInstances[instanceId]) {
54
52
  const matchingKey = getMatching(validKey);
55
53
 
56
- const sharedSdkReadiness = sdkReadinessManager.shared(readyTimeout);
54
+ const sharedSdkReadiness = sdkReadinessManager.shared();
57
55
  const sharedStorage = storage.shared && storage.shared(matchingKey, (err) => {
58
56
  if (err) {
59
57
  sharedSdkReadiness.readinessManager.timeout();
@@ -6,7 +6,7 @@ import { getMatching, keyParser } from '../utils/key';
6
6
  import { sdkClientFactory } from './sdkClient';
7
7
  import { ISyncManagerCS } from '../sync/types';
8
8
  import { objectAssign } from '../utils/lang/objectAssign';
9
- import { RETRIEVE_CLIENT_DEFAULT, NEW_SHARED_CLIENT, RETRIEVE_CLIENT_EXISTING } from '../logger/constants';
9
+ import { RETRIEVE_CLIENT_DEFAULT, NEW_SHARED_CLIENT, RETRIEVE_CLIENT_EXISTING, LOG_PREFIX_CLIENT_INSTANTIATION } from '../logger/constants';
10
10
  import { SDK_SEGMENTS_ARRIVED } from '../readiness/constants';
11
11
  import { ISdkFactoryContext } from '../sdkFactory/types';
12
12
 
@@ -15,15 +15,13 @@ function buildInstanceId(key: SplitIO.SplitKey, trafficType?: string) {
15
15
  return `${key.matchingKey ? key.matchingKey : key}-${key.bucketingKey ? key.bucketingKey : key}-${trafficType !== undefined ? trafficType : ''}`;
16
16
  }
17
17
 
18
- const method = 'Client instantiation';
19
-
20
18
  /**
21
19
  * Factory of client method for the client-side (browser) variant of the Isomorphic JS SDK,
22
20
  * where clients can have a bound TT for the track method, which is provided via the settings
23
21
  * (default client) or the client method (shared clients).
24
22
  */
25
23
  export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: SplitIO.SplitKey, trafficType?: string) => SplitIO.ICsClient {
26
- const { storage, syncManager, sdkReadinessManager, settings: { core: { key, trafficType }, startup: { readyTimeout }, log } } = params;
24
+ const { storage, syncManager, sdkReadinessManager, settings: { core: { key, trafficType }, log } } = params;
27
25
 
28
26
  const mainClientInstance = clientCSDecorator(
29
27
  log,
@@ -46,14 +44,14 @@ export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: Spl
46
44
  }
47
45
 
48
46
  // Validate the key value
49
- const validKey = validateKey(log, key, `Shared ${method}`);
47
+ const validKey = validateKey(log, key, LOG_PREFIX_CLIENT_INSTANTIATION);
50
48
  if (validKey === false) {
51
49
  throw new Error('Shared Client needs a valid key.');
52
50
  }
53
51
 
54
52
  let validTrafficType;
55
53
  if (trafficType !== undefined) {
56
- validTrafficType = validateTrafficType(log, trafficType, `Shared ${method}`);
54
+ validTrafficType = validateTrafficType(log, trafficType, LOG_PREFIX_CLIENT_INSTANTIATION);
57
55
  if (validTrafficType === false) {
58
56
  throw new Error('Shared Client needs a valid traffic type or no traffic type at all.');
59
57
  }
@@ -63,7 +61,7 @@ export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: Spl
63
61
  if (!clientInstances[instanceId]) {
64
62
  const matchingKey = getMatching(validKey);
65
63
 
66
- const sharedSdkReadiness = sdkReadinessManager.shared(readyTimeout);
64
+ const sharedSdkReadiness = sdkReadinessManager.shared();
67
65
  const sharedStorage = storage.shared && storage.shared(matchingKey, (err) => {
68
66
  if (err) {
69
67
  sharedSdkReadiness.readinessManager.timeout();
@@ -32,7 +32,7 @@ export function sdkFactory(params: ISdkFactoryParams): SplitIO.ICsSDK | SplitIO.
32
32
  // We will just log and allow for the SDK to end up throwing an SDK_TIMEOUT event for devs to handle.
33
33
  validateAndTrackApiKey(log, settings.core.authorizationKey);
34
34
 
35
- const sdkReadinessManager = sdkReadinessManagerFactory(log, platform.EventEmitter, settings.startup.readyTimeout);
35
+ const sdkReadinessManager = sdkReadinessManagerFactory(platform.EventEmitter, settings);
36
36
  const readiness = sdkReadinessManager.readinessManager;
37
37
 
38
38
  const storage = storageFactory({
@@ -4,7 +4,7 @@ import { splitHttpClientFactory } from './splitHttpClient';
4
4
  import { ISplitApi } from './types';
5
5
  import { objectAssign } from '../utils/lang/objectAssign';
6
6
  import { ITelemetryTracker } from '../trackers/types';
7
- import { SPLITS, IMPRESSIONS, IMPRESSIONS_COUNT, EVENTS, TELEMETRY, TOKEN, SEGMENT, MY_SEGMENT } from '../utils/constants';
7
+ import { SPLITS, IMPRESSIONS, IMPRESSIONS_COUNT, EVENTS, TELEMETRY, TOKEN, SEGMENT, MY_SEGMENT, MY_LARGE_SEGMENT } from '../utils/constants';
8
8
  import { ERROR_TOO_MANY_SETS } from '../logger/constants';
9
9
 
10
10
  const noCacheHeaderOptions = { headers: { 'Cache-Control': 'no-cache' } };
@@ -78,6 +78,11 @@ export function splitApiFactory(
78
78
  return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(MY_SEGMENT));
79
79
  },
80
80
 
81
+ fetchMyLargeSegments(userMatchingKey: string, noCache?: boolean) {
82
+ const url = `${urls.sdk}/myLargeSegments/${encodeURIComponent(userMatchingKey)}`;
83
+ return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(MY_LARGE_SEGMENT));
84
+ },
85
+
81
86
  /**
82
87
  * Post events.
83
88
  *
@@ -62,6 +62,7 @@ export interface ISplitApi {
62
62
  fetchSplitChanges: IFetchSplitChanges
63
63
  fetchSegmentChanges: IFetchSegmentChanges
64
64
  fetchMySegments: IFetchMySegments
65
+ fetchMyLargeSegments: IFetchMySegments
65
66
  postEventsBulk: IPostEventsBulk
66
67
  postUniqueKeysBulkCs: IPostUniqueKeysBulkCs
67
68
  postUniqueKeysBulkSs: IPostUniqueKeysBulkSs
@@ -22,9 +22,9 @@ export abstract class AbstractSplitsCacheAsync implements ISplitsCacheAsync {
22
22
  abstract trafficTypeExists(trafficType: string): Promise<boolean>
23
23
  abstract clear(): Promise<boolean | void>
24
24
 
25
- // @TODO revisit segment-related methods ('usesSegments', 'getRegisteredSegments', 'registerSegments')
25
+ // @TODO revisit segment-related methods ('usesMatcher', 'getRegisteredSegments', 'registerSegments')
26
26
  // noop, just keeping the interface. This is used by standalone client-side API only, and so only implemented by InMemory and InLocalStorage.
27
- usesSegments(): Promise<boolean> {
27
+ usesMatcher(): Promise<boolean> {
28
28
  return Promise.resolve(true);
29
29
  }
30
30
 
@@ -43,7 +43,7 @@ export abstract class AbstractSplitsCacheSync implements ISplitsCacheSync {
43
43
 
44
44
  abstract trafficTypeExists(trafficType: string): boolean
45
45
 
46
- abstract usesSegments(): boolean
46
+ abstract usesMatcher(matcherType: string): boolean
47
47
 
48
48
  abstract clear(): void
49
49
 
@@ -85,15 +85,15 @@ export abstract class AbstractSplitsCacheSync implements ISplitsCacheSync {
85
85
 
86
86
  /**
87
87
  * Given a parsed split, it returns a boolean flagging if its conditions use segments matchers (rules & whitelists).
88
- * This util is intended to simplify the implementation of `splitsCache::usesSegments` method
88
+ * This util is intended to simplify the implementation of `splitsCache::usesMatcher` method
89
89
  */
90
- export function usesSegments(split: ISplit) {
90
+ export function usesMatcher(split: ISplit, matcherType: string) {
91
91
  const conditions = split.conditions || [];
92
92
  for (let i = 0; i < conditions.length; i++) {
93
93
  const matchers = conditions[i].matcherGroup.matchers;
94
94
 
95
95
  for (let j = 0; j < matchers.length; j++) {
96
- if (matchers[j].matcherType === 'IN_SEGMENT') return true;
96
+ if (matchers[j].matcherType === matcherType) return true;
97
97
  }
98
98
  }
99
99
 
@@ -51,6 +51,9 @@ export class KeyBuilder {
51
51
  buildSplitsWithSegmentCountKey() {
52
52
  return `${this.prefix}.splits.usingSegments`;
53
53
  }
54
+ buildSplitsWithLargeSegmentCountKey() {
55
+ return `${this.prefix}.splits.usingLargeSegments`;
56
+ }
54
57
 
55
58
  buildSegmentNameKey(segmentName: string) {
56
59
  return `${this.prefix}.segment.${segmentName}`;
@@ -1,7 +1,13 @@
1
1
  import { startsWith } from '../utils/lang';
2
2
  import { KeyBuilder } from './KeyBuilder';
3
3
 
4
- export class KeyBuilderCS extends KeyBuilder {
4
+ export interface MySegmentsKeyBuilder {
5
+ buildSegmentNameKey(segmentName: string): string;
6
+ extractSegmentName(builtSegmentKeyName: string): string | undefined;
7
+ extractOldSegmentKey(builtSegmentKeyName: string): string | undefined;
8
+ }
9
+
10
+ export class KeyBuilderCS extends KeyBuilder implements MySegmentsKeyBuilder {
5
11
 
6
12
  protected readonly regexSplitsCacheKey: RegExp;
7
13
  protected readonly matchingKey: string;
@@ -26,10 +32,6 @@ export class KeyBuilderCS extends KeyBuilder {
26
32
  return builtSegmentKeyName.substr(prefix.length);
27
33
  }
28
34
 
29
- // @BREAKING: The key used to start with the matching key instead of the prefix, this was changed on version 10.17.3
30
- buildOldSegmentNameKey(segmentName: string) {
31
- return `${this.matchingKey}.${this.prefix}.segment.${segmentName}`;
32
- }
33
35
  // @BREAKING: The key used to start with the matching key instead of the prefix, this was changed on version 10.17.3
34
36
  extractOldSegmentKey(builtSegmentKeyName: string) {
35
37
  const prefix = `${this.matchingKey}.${this.prefix}.segment.`;
@@ -46,3 +48,21 @@ export class KeyBuilderCS extends KeyBuilder {
46
48
  return this.regexSplitsCacheKey.test(key);
47
49
  }
48
50
  }
51
+
52
+ export function myLargeSegmentsKeyBuilder(prefix: string, matchingKey: string): MySegmentsKeyBuilder {
53
+ return {
54
+ buildSegmentNameKey(segmentName: string) {
55
+ return `${prefix}.${matchingKey}.largeSegment.${segmentName}`;
56
+ },
57
+
58
+ extractSegmentName(builtSegmentKeyName: string) {
59
+ const p = `${prefix}.${matchingKey}.largeSegment.`;
60
+
61
+ if (startsWith(builtSegmentKeyName, p)) return builtSegmentKeyName.substr(p.length);
62
+ },
63
+
64
+ extractOldSegmentKey() {
65
+ return undefined;
66
+ }
67
+ };
68
+ }
@@ -1,14 +1,14 @@
1
1
  import { ILogger } from '../../logger/types';
2
2
  import { AbstractSegmentsCacheSync } from '../AbstractSegmentsCacheSync';
3
- import { KeyBuilderCS } from '../KeyBuilderCS';
3
+ import type { MySegmentsKeyBuilder } from '../KeyBuilderCS';
4
4
  import { LOG_PREFIX, DEFINED } from './constants';
5
5
 
6
6
  export class MySegmentsCacheInLocal extends AbstractSegmentsCacheSync {
7
7
 
8
- private readonly keys: KeyBuilderCS;
8
+ private readonly keys: MySegmentsKeyBuilder;
9
9
  private readonly log: ILogger;
10
10
 
11
- constructor(log: ILogger, keys: KeyBuilderCS) {
11
+ constructor(log: ILogger, keys: MySegmentsKeyBuilder) {
12
12
  super();
13
13
  this.log = log;
14
14
  this.keys = keys;