@splitsoftware/splitio-commons 3.0.0-rc.0 → 3.0.0-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 (189) hide show
  1. package/CHANGES.txt +8 -3
  2. package/cjs/evaluator/index.js +11 -11
  3. package/cjs/logger/constants.js +4 -4
  4. package/cjs/logger/messages/warn.js +0 -1
  5. package/cjs/readiness/constants.js +4 -4
  6. package/cjs/readiness/readinessManager.js +22 -22
  7. package/cjs/readiness/sdkReadinessManager.js +0 -16
  8. package/cjs/sdkClient/sdkLifecycle.js +2 -1
  9. package/cjs/sdkClient/trackMethod.js +2 -2
  10. package/cjs/sdkFactory/index.js +5 -5
  11. package/cjs/sdkManager/index.js +2 -2
  12. package/cjs/services/authProvider.js +67 -0
  13. package/cjs/services/secureSplitHttpClient.js +39 -0
  14. package/cjs/services/splitApi.js +15 -6
  15. package/cjs/storages/AbstractDefinitionsCacheAsync.js +51 -0
  16. package/cjs/storages/AbstractDefinitionsCacheSync.js +76 -0
  17. package/cjs/storages/KeyBuilder.js +6 -6
  18. package/cjs/storages/KeyBuilderCS.js +5 -5
  19. package/cjs/storages/KeyBuilderSS.js +2 -2
  20. package/cjs/storages/getRolloutPlan.js +3 -3
  21. package/cjs/storages/inLocalStorage/DefinitionsCacheInLocal.js +194 -0
  22. package/cjs/storages/inLocalStorage/RBSegmentsCacheInLocal.js +9 -9
  23. package/cjs/storages/inLocalStorage/index.js +6 -6
  24. package/cjs/storages/inLocalStorage/validateCache.js +3 -3
  25. package/cjs/storages/inMemory/DefinitionsCacheInMemory.js +121 -0
  26. package/cjs/storages/inMemory/InMemoryStorage.js +4 -4
  27. package/cjs/storages/inMemory/InMemoryStorageCS.js +5 -5
  28. package/cjs/storages/inMemory/RBSegmentsCacheInMemory.js +4 -4
  29. package/cjs/storages/inMemory/SegmentsCacheInMemory.js +1 -1
  30. package/cjs/storages/inMemory/TelemetryCacheInMemory.js +3 -3
  31. package/cjs/storages/inRedis/{SplitsCacheInRedis.js → DefinitionsCacheInRedis.js} +77 -77
  32. package/cjs/storages/inRedis/index.js +2 -2
  33. package/cjs/storages/pluggable/DefinitionsCachePluggable.js +212 -0
  34. package/cjs/storages/pluggable/index.js +2 -2
  35. package/cjs/storages/setRolloutPlan.js +5 -5
  36. package/cjs/sync/offline/syncTasks/fromObjectSyncTask.js +5 -5
  37. package/cjs/sync/polling/fetchers/splitChangesFetcher.js +1 -1
  38. package/cjs/sync/polling/pollingManagerCS.js +7 -7
  39. package/cjs/sync/polling/pollingManagerSS.js +3 -3
  40. package/cjs/sync/polling/syncTasks/definitionsSyncTask.js +1 -1
  41. package/cjs/sync/polling/syncTasks/segmentsSyncTask.js +2 -3
  42. package/cjs/sync/polling/updaters/definitionChangesUpdater.js +8 -8
  43. package/cjs/sync/polling/updaters/mySegmentsUpdater.js +2 -2
  44. package/cjs/sync/streaming/SSEHandler/NotificationKeeper.js +1 -1
  45. package/cjs/sync/streaming/SSEHandler/index.js +1 -1
  46. package/cjs/sync/streaming/UpdateWorkers/{SplitsUpdateWorker.js → DefinitionsUpdateWorker.js} +15 -15
  47. package/cjs/sync/streaming/constants.js +3 -3
  48. package/cjs/sync/streaming/pushManager.js +13 -13
  49. package/cjs/sync/submitters/telemetrySubmitter.js +1 -2
  50. package/cjs/sync/syncManagerOnline.js +10 -8
  51. package/cjs/utils/Backoff.js +20 -0
  52. package/cjs/utils/lang/sets.js +4 -4
  53. package/cjs/utils/settingsValidation/index.js +2 -0
  54. package/cjs/utils/settingsValidation/url.js +6 -2
  55. package/esm/evaluator/index.js +11 -11
  56. package/esm/logger/constants.js +1 -1
  57. package/esm/logger/messages/warn.js +0 -1
  58. package/esm/readiness/constants.js +3 -3
  59. package/esm/readiness/readinessManager.js +23 -23
  60. package/esm/readiness/sdkReadinessManager.js +1 -17
  61. package/esm/sdkClient/sdkLifecycle.js +2 -1
  62. package/esm/sdkClient/trackMethod.js +2 -2
  63. package/esm/sdkFactory/index.js +6 -6
  64. package/esm/sdkManager/index.js +2 -2
  65. package/esm/services/authProvider.js +63 -0
  66. package/esm/services/secureSplitHttpClient.js +35 -0
  67. package/esm/services/splitApi.js +15 -6
  68. package/esm/storages/AbstractDefinitionsCacheAsync.js +48 -0
  69. package/esm/storages/AbstractDefinitionsCacheSync.js +71 -0
  70. package/esm/storages/KeyBuilder.js +6 -6
  71. package/esm/storages/KeyBuilderCS.js +5 -5
  72. package/esm/storages/KeyBuilderSS.js +2 -2
  73. package/esm/storages/getRolloutPlan.js +3 -3
  74. package/esm/storages/inLocalStorage/DefinitionsCacheInLocal.js +191 -0
  75. package/esm/storages/inLocalStorage/RBSegmentsCacheInLocal.js +6 -6
  76. package/esm/storages/inLocalStorage/index.js +6 -6
  77. package/esm/storages/inLocalStorage/validateCache.js +3 -3
  78. package/esm/storages/inMemory/DefinitionsCacheInMemory.js +118 -0
  79. package/esm/storages/inMemory/InMemoryStorage.js +4 -4
  80. package/esm/storages/inMemory/InMemoryStorageCS.js +5 -5
  81. package/esm/storages/inMemory/RBSegmentsCacheInMemory.js +1 -1
  82. package/esm/storages/inMemory/SegmentsCacheInMemory.js +1 -1
  83. package/esm/storages/inMemory/TelemetryCacheInMemory.js +3 -3
  84. package/esm/storages/inRedis/{SplitsCacheInRedis.js → DefinitionsCacheInRedis.js} +76 -76
  85. package/esm/storages/inRedis/index.js +2 -2
  86. package/esm/storages/pluggable/DefinitionsCachePluggable.js +209 -0
  87. package/esm/storages/pluggable/index.js +2 -2
  88. package/esm/storages/setRolloutPlan.js +5 -5
  89. package/esm/sync/offline/syncTasks/fromObjectSyncTask.js +6 -6
  90. package/esm/sync/polling/fetchers/splitChangesFetcher.js +1 -1
  91. package/esm/sync/polling/pollingManagerCS.js +4 -4
  92. package/esm/sync/polling/pollingManagerSS.js +3 -3
  93. package/esm/sync/polling/syncTasks/definitionsSyncTask.js +1 -1
  94. package/esm/sync/polling/syncTasks/segmentsSyncTask.js +2 -3
  95. package/esm/sync/polling/updaters/definitionChangesUpdater.js +9 -9
  96. package/esm/sync/polling/updaters/mySegmentsUpdater.js +1 -1
  97. package/esm/sync/streaming/SSEHandler/NotificationKeeper.js +2 -2
  98. package/esm/sync/streaming/SSEHandler/index.js +2 -2
  99. package/esm/sync/streaming/UpdateWorkers/{SplitsUpdateWorker.js → DefinitionsUpdateWorker.js} +14 -14
  100. package/esm/sync/streaming/constants.js +2 -2
  101. package/esm/sync/streaming/pushManager.js +14 -14
  102. package/esm/sync/submitters/telemetrySubmitter.js +1 -2
  103. package/esm/sync/syncManagerOnline.js +9 -7
  104. package/esm/utils/Backoff.js +20 -0
  105. package/esm/utils/lang/sets.js +4 -4
  106. package/esm/utils/settingsValidation/index.js +2 -0
  107. package/esm/utils/settingsValidation/url.js +6 -2
  108. package/package.json +1 -1
  109. package/src/dtos/types.ts +2 -2
  110. package/src/evaluator/index.ts +11 -11
  111. package/src/logger/constants.ts +1 -1
  112. package/src/logger/messages/warn.ts +0 -1
  113. package/src/readiness/constants.ts +3 -3
  114. package/src/readiness/readinessManager.ts +22 -22
  115. package/src/readiness/sdkReadinessManager.ts +1 -16
  116. package/src/readiness/types.ts +10 -16
  117. package/src/sdkClient/sdkLifecycle.ts +2 -1
  118. package/src/sdkClient/trackMethod.ts +2 -2
  119. package/src/sdkFactory/index.ts +5 -5
  120. package/src/sdkManager/index.ts +6 -6
  121. package/src/services/authProvider.ts +86 -0
  122. package/src/services/secureSplitHttpClient.ts +44 -0
  123. package/src/services/splitApi.ts +18 -7
  124. package/src/services/types.ts +6 -1
  125. package/src/storages/AbstractDefinitionsCacheAsync.ts +63 -0
  126. package/src/storages/AbstractDefinitionsCacheSync.ts +95 -0
  127. package/src/storages/KeyBuilder.ts +6 -6
  128. package/src/storages/KeyBuilderCS.ts +6 -6
  129. package/src/storages/KeyBuilderSS.ts +2 -2
  130. package/src/storages/getRolloutPlan.ts +3 -3
  131. package/src/storages/inLocalStorage/DefinitionsCacheInLocal.ts +234 -0
  132. package/src/storages/inLocalStorage/RBSegmentsCacheInLocal.ts +6 -6
  133. package/src/storages/inLocalStorage/index.ts +6 -6
  134. package/src/storages/inLocalStorage/validateCache.ts +4 -4
  135. package/src/storages/inMemory/DefinitionsCacheInMemory.ts +130 -0
  136. package/src/storages/inMemory/InMemoryStorage.ts +4 -4
  137. package/src/storages/inMemory/InMemoryStorageCS.ts +5 -5
  138. package/src/storages/inMemory/RBSegmentsCacheInMemory.ts +1 -1
  139. package/src/storages/inMemory/SegmentsCacheInMemory.ts +1 -1
  140. package/src/storages/inMemory/TelemetryCacheInMemory.ts +3 -3
  141. package/src/storages/inRedis/{SplitsCacheInRedis.ts → DefinitionsCacheInRedis.ts} +67 -67
  142. package/src/storages/inRedis/index.ts +2 -2
  143. package/src/storages/pluggable/DefinitionsCachePluggable.ts +230 -0
  144. package/src/storages/pluggable/index.ts +2 -2
  145. package/src/storages/setRolloutPlan.ts +7 -7
  146. package/src/storages/types.ts +19 -19
  147. package/src/sync/offline/syncTasks/fromObjectSyncTask.ts +8 -8
  148. package/src/sync/polling/fetchers/splitChangesFetcher.ts +3 -3
  149. package/src/sync/polling/pollingManagerCS.ts +4 -4
  150. package/src/sync/polling/pollingManagerSS.ts +5 -4
  151. package/src/sync/polling/syncTasks/definitionsSyncTask.ts +1 -1
  152. package/src/sync/polling/syncTasks/segmentsSyncTask.ts +3 -4
  153. package/src/sync/polling/types.ts +1 -1
  154. package/src/sync/polling/updaters/definitionChangesUpdater.ts +11 -11
  155. package/src/sync/polling/updaters/mySegmentsUpdater.ts +1 -1
  156. package/src/sync/streaming/AuthClient/index.ts +2 -2
  157. package/src/sync/streaming/AuthClient/types.ts +14 -11
  158. package/src/sync/streaming/SSEClient/index.ts +2 -2
  159. package/src/sync/streaming/SSEClient/types.ts +2 -2
  160. package/src/sync/streaming/SSEHandler/NotificationKeeper.ts +2 -2
  161. package/src/sync/streaming/SSEHandler/index.ts +2 -2
  162. package/src/sync/streaming/UpdateWorkers/{SplitsUpdateWorker.ts → DefinitionsUpdateWorker.ts} +16 -16
  163. package/src/sync/streaming/constants.ts +2 -2
  164. package/src/sync/streaming/pushManager.ts +16 -16
  165. package/src/sync/streaming/types.ts +2 -2
  166. package/src/sync/submitters/telemetrySubmitter.ts +1 -2
  167. package/src/sync/syncManagerOnline.ts +10 -8
  168. package/src/utils/Backoff.ts +21 -0
  169. package/src/utils/inputValidation/trafficTypeExistence.ts +2 -2
  170. package/src/utils/jwt/types.ts +1 -1
  171. package/src/utils/lang/sets.ts +4 -2
  172. package/src/utils/settingsValidation/index.ts +2 -0
  173. package/src/utils/settingsValidation/url.ts +6 -2
  174. package/types/splitio.d.ts +27 -8
  175. package/cjs/storages/AbstractSplitsCacheAsync.js +0 -51
  176. package/cjs/storages/AbstractSplitsCacheSync.js +0 -76
  177. package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js +0 -194
  178. package/cjs/storages/inMemory/SplitsCacheInMemory.js +0 -121
  179. package/cjs/storages/pluggable/SplitsCachePluggable.js +0 -212
  180. package/esm/storages/AbstractSplitsCacheAsync.js +0 -48
  181. package/esm/storages/AbstractSplitsCacheSync.js +0 -71
  182. package/esm/storages/inLocalStorage/SplitsCacheInLocal.js +0 -191
  183. package/esm/storages/inMemory/SplitsCacheInMemory.js +0 -118
  184. package/esm/storages/pluggable/SplitsCachePluggable.js +0 -209
  185. package/src/storages/AbstractSplitsCacheAsync.ts +0 -63
  186. package/src/storages/AbstractSplitsCacheSync.ts +0 -95
  187. package/src/storages/inLocalStorage/SplitsCacheInLocal.ts +0 -234
  188. package/src/storages/inMemory/SplitsCacheInMemory.ts +0 -130
  189. package/src/storages/pluggable/SplitsCachePluggable.ts +0 -230
@@ -24,15 +24,15 @@ function treatmentsException(definitionNames) {
24
24
  export function evaluateFeature(log, key, definitionName, attributes, storage, options) {
25
25
  var definition;
26
26
  try {
27
- definition = storage.splits.getSplit(definitionName);
27
+ definition = storage.definitions.get(definitionName);
28
28
  }
29
29
  catch (e) {
30
- // Exception on sync `getSplit` storage. Not possible ATM with InMemory and InLocal storages.
30
+ // Exception on sync storage. Not possible ATM with InMemory and InLocal storages.
31
31
  return EVALUATION_EXCEPTION;
32
32
  }
33
33
  if (thenable(definition)) {
34
34
  return definition.then(function (definition) { return getEvaluation(log, key, definition, attributes, storage, options); }).catch(
35
- // Exception on async `getSplit` storage. For example, when the storage is redis or
35
+ // Exception on async storage. For example, when the storage is redis or
36
36
  // pluggable and there is a connection issue and we can't retrieve the split to be evaluated
37
37
  function () { return EVALUATION_EXCEPTION; });
38
38
  }
@@ -41,16 +41,16 @@ export function evaluateFeature(log, key, definitionName, attributes, storage, o
41
41
  export function evaluateFeatures(log, key, definitionNames, attributes, storage, options) {
42
42
  var definitions;
43
43
  try {
44
- definitions = storage.splits.getSplits(definitionNames);
44
+ definitions = storage.definitions.getMany(definitionNames);
45
45
  }
46
46
  catch (e) {
47
- // Exception on sync `getSplits` storage. Not possible ATM with InMemory and InLocal storages.
47
+ // Exception on sync storage. Not possible ATM with InMemory and InLocal storages.
48
48
  return treatmentsException(definitionNames);
49
49
  }
50
50
  return thenable(definitions) ?
51
51
  definitions.then(function (definitions) { return getEvaluations(log, key, definitionNames, definitions, attributes, storage, options); })
52
52
  .catch(function () {
53
- // Exception on async `getSplits` storage. For example, when the storage is redis or
53
+ // Exception on async storage. For example, when the storage is redis or
54
54
  // pluggable and there is a connection issue and we can't retrieve the split to be evaluated
55
55
  return treatmentsException(definitionNames);
56
56
  }) :
@@ -75,7 +75,7 @@ export function evaluateFeaturesByFlagSets(log, key, flagSets, attributes, stora
75
75
  }
76
76
  // get features by flag sets
77
77
  try {
78
- storedFlagNames = storage.splits.getNamesByFlagSets(flagSets);
78
+ storedFlagNames = storage.definitions.getNamesBySets(flagSets);
79
79
  }
80
80
  catch (e) {
81
81
  // return empty evaluations
@@ -93,7 +93,7 @@ function getEvaluation(log, key, definition, attributes, storage, options) {
93
93
  if (definition) {
94
94
  var split = engineParser(log, definition, storage);
95
95
  var evaluation = split.getTreatment(key, attributes, evaluateFeature);
96
- // If the storage is async and the evaluated flag uses segments or dependencies, evaluation is thenable
96
+ // If the storage is async and the evaluated definition uses segments or dependencies, evaluation is thenable
97
97
  if (thenable(evaluation)) {
98
98
  return evaluation.then(function (result) {
99
99
  result.changeNumber = definition.changeNumber;
@@ -113,11 +113,11 @@ function getEvaluation(log, key, definition, attributes, storage, options) {
113
113
  }
114
114
  return EVALUATION_DEFINITION_NOT_FOUND;
115
115
  }
116
- function getEvaluations(log, key, definitionNames, splits, attributes, storage, options) {
116
+ function getEvaluations(log, key, definitionNames, definitions, attributes, storage, options) {
117
117
  var result = {};
118
118
  var thenables = [];
119
119
  definitionNames.forEach(function (definitionName) {
120
- var evaluation = getEvaluation(log, key, splits[definitionName], attributes, storage, options);
120
+ var evaluation = getEvaluation(log, key, definitions[definitionName], attributes, storage, options);
121
121
  if (thenable(evaluation)) {
122
122
  thenables.push(evaluation.then(function (res) {
123
123
  result[definitionName] = res;
@@ -132,7 +132,7 @@ function getEvaluations(log, key, definitionNames, splits, attributes, storage,
132
132
  export function evaluateDefaultTreatment(definitionName, storage) {
133
133
  var definition;
134
134
  try {
135
- definition = storage.splits.getSplit(definitionName);
135
+ definition = storage.definitions.get(definitionName);
136
136
  }
137
137
  catch (e) {
138
138
  return EVALUATION_EXCEPTION;
@@ -54,7 +54,6 @@ export var USER_CONSENT_INITIAL = 124;
54
54
  export var SUBMITTERS_PUSH_PAGE_HIDDEN = 125;
55
55
  export var ENGINE_VALUE_INVALID = 200;
56
56
  export var ENGINE_VALUE_NO_ATTRIBUTES = 201;
57
- export var CLIENT_NO_LISTENER = 202;
58
57
  export var CLIENT_NOT_READY_FROM_CACHE = 203;
59
58
  export var SYNC_FETCH_RETRY = 204;
60
59
  export var SYNC_FETCH_FAILS = 205;
@@ -119,6 +118,7 @@ export var LOG_PREFIX_ENGINE_COMBINER = LOG_PREFIX_ENGINE + ':combiner: ';
119
118
  export var LOG_PREFIX_ENGINE_MATCHER = LOG_PREFIX_ENGINE + ':matcher: ';
120
119
  export var LOG_PREFIX_ENGINE_VALUE = LOG_PREFIX_ENGINE + ':value: ';
121
120
  export var LOG_PREFIX_SYNC = 'sync: ';
121
+ export var LOG_PREFIX_SYNC_AUTH = 'sync:auth: ';
122
122
  export var LOG_PREFIX_SYNC_MANAGER = 'sync:sync-manager: ';
123
123
  export var LOG_PREFIX_SYNC_OFFLINE = 'sync:offline: ';
124
124
  export var LOG_PREFIX_SYNC_STREAMING = 'sync:streaming: ';
@@ -14,7 +14,6 @@ export var codesWarn = codesError.concat([
14
14
  [c.SUBMITTERS_PUSH_RETRY, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Failed to push %s, keeping data to retry on next iteration. Reason: %s'],
15
15
  // client status
16
16
  [c.CLIENT_NOT_READY_FROM_CACHE, '%s: the SDK is not ready to evaluate. Results may be incorrect. Make sure to wait for SDK readiness before using this method.'],
17
- [c.CLIENT_NO_LISTENER, 'No listeners for SDK_READY event detected. Incorrect control treatments could have been logged if you called getTreatment/s while the SDK was not yet synchronized with the backend.'],
18
17
  // input validation
19
18
  [c.WARN_SETTING_NULL, '%s: Property "%s" is of invalid type. Setting value to null.'],
20
19
  [c.WARN_TRIMMING_PROPERTIES, '%s: more than 300 properties were provided. Some of them will be trimmed when processed.'],
@@ -1,6 +1,6 @@
1
- // Splits events:
2
- export var SDK_SPLITS_ARRIVED = 'state::splits-arrived';
3
- export var SDK_SPLITS_CACHE_LOADED = 'state::splits-cache-loaded';
1
+ // Definitions events:
2
+ export var SDK_DEFINITIONS_ARRIVED = 'state::splits-arrived';
3
+ export var SDK_DEFINITIONS_CACHE_LOADED = 'state::splits-cache-loaded';
4
4
  // Segments events:
5
5
  export var SDK_SEGMENTS_ARRIVED = 'state::segments-arrived';
6
6
  // Readiness events:
@@ -1,19 +1,19 @@
1
1
  import { objectAssign } from '../utils/lang/objectAssign';
2
- 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';
3
- function splitsEventEmitterFactory(EventEmitter) {
4
- var splitsEventEmitter = objectAssign(new EventEmitter(), {
5
- splitsArrived: false,
6
- splitsCacheLoaded: false,
2
+ import { SDK_DEFINITIONS_ARRIVED, SDK_DEFINITIONS_CACHE_LOADED, SDK_SEGMENTS_ARRIVED, SDK_READY_TIMED_OUT, SDK_READY_FROM_CACHE, SDK_UPDATE, SDK_READY } from './constants';
3
+ function definitionsEventEmitterFactory(EventEmitter) {
4
+ var definitionsEventEmitter = objectAssign(new EventEmitter(), {
5
+ definitionsArrived: false,
6
+ definitionsCacheLoaded: false,
7
7
  hasInit: false,
8
8
  initCallbacks: []
9
9
  });
10
10
  // `isSplitKill` condition avoids an edge-case of wrongly emitting SDK_READY if:
11
11
  // - `/memberships` fetch and SPLIT_KILL occurs before `/splitChanges` fetch, and
12
12
  // - storage has cached splits (for which case `splitsStorage.killLocally` can return true)
13
- splitsEventEmitter.on(SDK_SPLITS_ARRIVED, function (metadata, isSplitKill) { if (!isSplitKill)
14
- splitsEventEmitter.splitsArrived = true; });
15
- splitsEventEmitter.once(SDK_SPLITS_CACHE_LOADED, function () { splitsEventEmitter.splitsCacheLoaded = true; });
16
- return splitsEventEmitter;
13
+ definitionsEventEmitter.on(SDK_DEFINITIONS_ARRIVED, function (metadata, isSplitKill) { if (!isSplitKill)
14
+ definitionsEventEmitter.definitionsArrived = true; });
15
+ definitionsEventEmitter.once(SDK_DEFINITIONS_CACHE_LOADED, function () { definitionsEventEmitter.definitionsCacheLoaded = true; });
16
+ return definitionsEventEmitter;
17
17
  }
18
18
  function segmentsEventEmitterFactory(EventEmitter) {
19
19
  var segmentsEventEmitter = objectAssign(new EventEmitter(), {
@@ -25,8 +25,8 @@ function segmentsEventEmitterFactory(EventEmitter) {
25
25
  /**
26
26
  * Factory of readiness manager, which handles the ready / update event propagation.
27
27
  */
28
- export function readinessManagerFactory(EventEmitter, settings, splits, isShared) {
29
- if (splits === void 0) { splits = splitsEventEmitterFactory(EventEmitter); }
28
+ export function readinessManagerFactory(EventEmitter, settings, definitions, isShared) {
29
+ if (definitions === void 0) { definitions = definitionsEventEmitterFactory(EventEmitter); }
30
30
  var readyTimeout = settings.startup.readyTimeout;
31
31
  var segments = segmentsEventEmitterFactory(EventEmitter);
32
32
  var gate = new EventEmitter();
@@ -41,10 +41,10 @@ export function readinessManagerFactory(EventEmitter, settings, splits, isShared
41
41
  };
42
42
  // emit SDK_READY_FROM_CACHE
43
43
  var isReadyFromCache = false;
44
- if (splits.splitsCacheLoaded)
44
+ if (definitions.definitionsCacheLoaded)
45
45
  isReadyFromCache = true; // ready from cache, but doesn't emit SDK_READY_FROM_CACHE
46
46
  else
47
- splits.once(SDK_SPLITS_CACHE_LOADED, checkIsReadyFromCache);
47
+ definitions.once(SDK_DEFINITIONS_CACHE_LOADED, checkIsReadyFromCache);
48
48
  // emit SDK_READY_TIMED_OUT
49
49
  var hasTimedout = false;
50
50
  function timeout() {
@@ -56,7 +56,7 @@ export function readinessManagerFactory(EventEmitter, settings, splits, isShared
56
56
  }
57
57
  // emit SDK_READY and SDK_UPDATE
58
58
  var isReady = false;
59
- splits.on(SDK_SPLITS_ARRIVED, checkIsReadyOrUpdate);
59
+ definitions.on(SDK_DEFINITIONS_ARRIVED, checkIsReadyOrUpdate);
60
60
  segments.on(SDK_SEGMENTS_ARRIVED, checkIsReadyOrUpdate);
61
61
  var isDestroyed = false;
62
62
  var readyTimeoutId;
@@ -65,8 +65,8 @@ export function readinessManagerFactory(EventEmitter, settings, splits, isShared
65
65
  if (readyTimeout > 0 && !isReady)
66
66
  readyTimeoutId = setTimeout(timeout, readyTimeout);
67
67
  }
68
- splits.initCallbacks.push(__init);
69
- if (splits.hasInit)
68
+ definitions.initCallbacks.push(__init);
69
+ if (definitions.hasInit)
70
70
  __init();
71
71
  function checkIsReadyFromCache(cacheMetadata) {
72
72
  metadataReady = cacheMetadata;
@@ -97,7 +97,7 @@ export function readinessManagerFactory(EventEmitter, settings, splits, isShared
97
97
  }
98
98
  }
99
99
  else {
100
- if (splits.splitsArrived && segments.segmentsArrived) {
100
+ if (definitions.definitionsArrived && segments.segmentsArrived) {
101
101
  clearTimeout(readyTimeoutId);
102
102
  isReady = true;
103
103
  try {
@@ -120,11 +120,11 @@ export function readinessManagerFactory(EventEmitter, settings, splits, isShared
120
120
  }
121
121
  }
122
122
  return {
123
- splits: splits,
123
+ definitions: definitions,
124
124
  segments: segments,
125
125
  gate: gate,
126
126
  shared: function () {
127
- return readinessManagerFactory(EventEmitter, settings, splits, true);
127
+ return readinessManagerFactory(EventEmitter, settings, definitions, true);
128
128
  },
129
129
  // @TODO review/remove next methods when non-recoverable errors are reworked
130
130
  // Called on consumer mode, when storage fails to connect
@@ -133,17 +133,17 @@ export function readinessManagerFactory(EventEmitter, settings, splits, isShared
133
133
  // tracking and evaluations, while keeping event listeners to emit SDK_READY_TIMED_OUT event
134
134
  setDestroyed: function () { isDestroyed = true; },
135
135
  init: function () {
136
- if (splits.hasInit)
136
+ if (definitions.hasInit)
137
137
  return;
138
- splits.hasInit = true;
139
- splits.initCallbacks.forEach(function (cb) { return cb(); });
138
+ definitions.hasInit = true;
139
+ definitions.initCallbacks.forEach(function (cb) { return cb(); });
140
140
  },
141
141
  destroy: function () {
142
142
  isDestroyed = true;
143
143
  syncLastUpdate();
144
144
  clearTimeout(readyTimeoutId);
145
145
  if (!isShared)
146
- splits.hasInit = false;
146
+ definitions.hasInit = false;
147
147
  },
148
148
  isReady: function () { return isReady; },
149
149
  isReadyFromCache: function () { return isReadyFromCache; },
@@ -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 { SDK_READY, SDK_READY_TIMED_OUT, SDK_READY_FROM_CACHE, SDK_UPDATE } from './constants';
5
- import { ERROR_CLIENT_LISTENER, CLIENT_READY_FROM_CACHE, CLIENT_READY, CLIENT_NO_LISTENER } from '../logger/constants';
5
+ import { ERROR_CLIENT_LISTENER, CLIENT_READY_FROM_CACHE, CLIENT_READY } from '../logger/constants';
6
6
  var NEW_LISTENER_EVENT = 'newListener';
7
- var REMOVE_LISTENER_EVENT = 'removeListener';
8
7
  var TIMEOUT_ERROR = new Error(SDK_READY_TIMED_OUT);
9
8
  /**
10
9
  * SdkReadinessManager factory, which provides the public status API of SDK clients and manager: ready promise, readiness event emitter and constants (SDK_READY, etc).
@@ -16,21 +15,11 @@ var TIMEOUT_ERROR = new Error(SDK_READY_TIMED_OUT);
16
15
  export function sdkReadinessManagerFactory(EventEmitter, settings, readinessManager) {
17
16
  if (readinessManager === void 0) { readinessManager = readinessManagerFactory(EventEmitter, settings); }
18
17
  var log = settings.log;
19
- /** Ready callback warning */
20
- var internalReadyCbCount = 0;
21
- var readyCbCount = 0;
22
- readinessManager.gate.on(REMOVE_LISTENER_EVENT, function (event) {
23
- if (event === SDK_READY)
24
- readyCbCount--;
25
- });
26
18
  readinessManager.gate.on(NEW_LISTENER_EVENT, function (event) {
27
19
  if (event === SDK_READY || event === SDK_READY_TIMED_OUT) {
28
20
  if (readinessManager.isReady()) {
29
21
  log.error(ERROR_CLIENT_LISTENER, [event === SDK_READY ? 'SDK_READY' : 'SDK_READY_TIMED_OUT']);
30
22
  }
31
- else if (event === SDK_READY) {
32
- readyCbCount++;
33
- }
34
23
  }
35
24
  else if (event === SDK_READY_FROM_CACHE && readinessManager.isReadyFromCache()) {
36
25
  log.error(ERROR_CLIENT_LISTENER, ['SDK_READY_FROM_CACHE']);
@@ -49,8 +38,6 @@ export function sdkReadinessManagerFactory(EventEmitter, settings, readinessMana
49
38
  var promise = promiseWrapper(new Promise(function (resolve, reject) {
50
39
  readinessManager.gate.once(SDK_READY, function () {
51
40
  log.info(CLIENT_READY);
52
- if (readyCbCount === internalReadyCbCount && !promise.hasOnFulfilled())
53
- log.warn(CLIENT_NO_LISTENER);
54
41
  resolve();
55
42
  });
56
43
  readinessManager.gate.once(SDK_READY_TIMED_OUT, function (message) {
@@ -75,9 +62,6 @@ export function sdkReadinessManagerFactory(EventEmitter, settings, readinessMana
75
62
  shared: function () {
76
63
  return sdkReadinessManagerFactory(EventEmitter, settings, readinessManager.shared());
77
64
  },
78
- incInternalReadyCbCount: function () {
79
- internalReadyCbCount++;
80
- },
81
65
  sdkStatus: objectAssign(
82
66
  // Expose Event Emitter functionality
83
67
  Object.create(readinessManager.gate), {
@@ -4,7 +4,7 @@ var COOLDOWN_TIME_IN_MILLIS = 1000;
4
4
  * Creates an Sdk client, i.e., a base client with status, init, flush and destroy interface
5
5
  */
6
6
  export function sdkLifecycleFactory(params, isSharedClient) {
7
- var sdkReadinessManager = params.sdkReadinessManager, syncManager = params.syncManager, storage = params.storage, settings = params.settings, telemetryTracker = params.telemetryTracker, impressionsTracker = params.impressionsTracker, platform = params.platform;
7
+ var sdkReadinessManager = params.sdkReadinessManager, syncManager = params.syncManager, storage = params.storage, settings = params.settings, telemetryTracker = params.telemetryTracker, impressionsTracker = params.impressionsTracker, platform = params.platform, splitApi = params.splitApi;
8
8
  var hasInit = false;
9
9
  var lastActionTime = 0;
10
10
  var signalListener = platform.SignalListener && new platform.SignalListener(params);
@@ -57,6 +57,7 @@ export function sdkLifecycleFactory(params, isSharedClient) {
57
57
  }
58
58
  // Stop background jobs
59
59
  syncManager && syncManager.stop();
60
+ splitApi && splitApi.stop();
60
61
  return __flush().then(function () {
61
62
  // Cleanup storage
62
63
  return storage.destroy();
@@ -10,7 +10,7 @@ import { isConsumerMode } from '../utils/settingsValidation/mode';
10
10
  */
11
11
  export function trackMethodFactory(params, warnTTExistence) {
12
12
  if (warnTTExistence === void 0) { warnTTExistence = true; }
13
- var settings = params.settings, splits = params.storage.splits, telemetryTracker = params.telemetryTracker, eventTracker = params.eventTracker, readinessManager = params.sdkReadinessManager.readinessManager;
13
+ var settings = params.settings, definitions = params.storage.definitions, telemetryTracker = params.telemetryTracker, eventTracker = params.eventTracker, readinessManager = params.sdkReadinessManager.readinessManager;
14
14
  var log = settings.log, mode = settings.mode;
15
15
  var isAsync = isConsumerMode(mode);
16
16
  return function track(maybeKey, maybeTT, maybeEvent, maybeEventValue, maybeProperties) {
@@ -36,7 +36,7 @@ export function trackMethodFactory(params, warnTTExistence) {
36
36
  };
37
37
  // This may be async but we only warn, we don't actually care if it is valid or not in terms of queueing the event.
38
38
  if (warnTTExistence)
39
- validateTrafficTypeExistence(log, readinessManager, splits, mode, trafficTypeName, TRACK_FN_LABEL);
39
+ validateTrafficTypeExistence(log, readinessManager, definitions, mode, trafficTypeName, TRACK_FN_LABEL);
40
40
  var result = eventTracker.track(eventData, size);
41
41
  if (thenable(result)) {
42
42
  return result.then(function (result) {
@@ -4,7 +4,7 @@ import { eventTrackerFactory } from '../trackers/eventTracker';
4
4
  import { telemetryTrackerFactory } from '../trackers/telemetryTracker';
5
5
  import { createLoggerAPI } from '../logger/sdkLogger';
6
6
  import { NEW_FACTORY, RETRIEVE_MANAGER } from '../logger/constants';
7
- import { SDK_SPLITS_ARRIVED, SDK_SEGMENTS_ARRIVED, SDK_SPLITS_CACHE_LOADED } from '../readiness/constants';
7
+ import { SDK_DEFINITIONS_ARRIVED, SDK_SEGMENTS_ARRIVED, SDK_DEFINITIONS_CACHE_LOADED } from '../readiness/constants';
8
8
  import { objectAssign } from '../utils/lang/objectAssign';
9
9
  import { setRolloutPlan } from '../storages/setRolloutPlan';
10
10
  import { getMatching } from '../utils/key';
@@ -27,18 +27,18 @@ export function sdkFactory(params) {
27
27
  readiness.timeout();
28
28
  return;
29
29
  }
30
- readiness.splits.emit(SDK_SPLITS_ARRIVED);
30
+ readiness.definitions.emit(SDK_DEFINITIONS_ARRIVED);
31
31
  readiness.segments.emit(SDK_SEGMENTS_ARRIVED);
32
32
  },
33
33
  onReadyFromCacheCb: function () {
34
- readiness.splits.emit(SDK_SPLITS_CACHE_LOADED);
34
+ readiness.definitions.emit(SDK_DEFINITIONS_CACHE_LOADED);
35
35
  }
36
36
  });
37
37
  var fallbackCalculator = FallbackTreatmentsCalculator(settings.fallbackTreatments);
38
38
  if (initialRolloutPlan) {
39
39
  setRolloutPlan(log, initialRolloutPlan, storage, key && getMatching(key));
40
- if (storage.splits.getChangeNumber() > -1)
41
- readiness.splits.emit(SDK_SPLITS_CACHE_LOADED, { initialCacheLoad: false /* Not an initial load, cache exists */ });
40
+ if (storage.definitions.getChangeNumber() > -1)
41
+ readiness.definitions.emit(SDK_DEFINITIONS_CACHE_LOADED, { initialCacheLoad: false /* Not an initial load, cache exists */ });
42
42
  }
43
43
  var clients = {};
44
44
  var telemetryTracker = telemetryTrackerFactory(storage.telemetry, platform.now);
@@ -51,7 +51,7 @@ export function sdkFactory(params) {
51
51
  ctx.syncManager = syncManagerFactory && syncManagerFactory(ctx);
52
52
  // SDK client and manager
53
53
  var clientMethod = sdkClientMethodFactory(ctx);
54
- var managerInstance = sdkManagerFactory(settings, storage.splits, sdkReadinessManager);
54
+ var managerInstance = sdkManagerFactory(settings, storage.definitions, sdkReadinessManager);
55
55
  function init() {
56
56
  Object.keys(clients).map(function (key) { return clients[key].init(); });
57
57
  }
@@ -54,7 +54,7 @@ export function sdkManagerFactory(settings, splits, _a) {
54
54
  if (!validateIfOperational(log, readinessManager, SPLIT_FN_LABEL) || !splitName) {
55
55
  return isAsync ? Promise.resolve(null) : null;
56
56
  }
57
- var split = splits.getSplit(splitName);
57
+ var split = splits.get(splitName);
58
58
  if (thenable(split)) {
59
59
  return split.catch(function () { return null; }).then(function (result) {
60
60
  validateDefinitionExistence(log, readinessManager, splitName, result, SPLIT_FN_LABEL);
@@ -83,7 +83,7 @@ export function sdkManagerFactory(settings, splits, _a) {
83
83
  if (!validateIfOperational(log, readinessManager, NAMES_FN_LABEL)) {
84
84
  return isAsync ? Promise.resolve([]) : [];
85
85
  }
86
- var splitNames = splits.getSplitNames();
86
+ var splitNames = splits.getNames();
87
87
  return thenable(splitNames) ?
88
88
  splitNames.catch(function () { return []; }) : // handle possible rejections when using pluggable storage
89
89
  splitNames;
@@ -0,0 +1,63 @@
1
+ import { authenticateFactory } from '../sync/streaming/AuthClient';
2
+ import { Backoff } from '../utils/Backoff';
3
+ import { LOG_PREFIX_SYNC_AUTH } from '../logger/constants';
4
+ import { TOKEN } from '../utils/constants';
5
+ var SKEW_SECONDS = 30;
6
+ function isExpired(credential) {
7
+ return Date.now() / 1000 + SKEW_SECONDS >= credential.decodedToken.exp;
8
+ }
9
+ /**
10
+ * Factory of AuthProvider, which provides JWT credentials for authenticated HTTP requests.
11
+ * Credentials are fetched lazily on demand, cached in memory, and retried with backoff on failure.
12
+ */
13
+ export function authProviderFactory(settings, splitHttpClient, telemetryTracker) {
14
+ var urls = settings.urls, log = settings.log;
15
+ function fetchAuth() {
16
+ var url = "".concat(urls.auth, "/v3/auth?capabilities=config");
17
+ return splitHttpClient(url, undefined, telemetryTracker.trackHttp(TOKEN));
18
+ }
19
+ var authenticate = authenticateFactory(fetchAuth);
20
+ var backoff = new Backoff(fetchCredential);
21
+ var cachedCredential;
22
+ var inFlightPromise;
23
+ var stopped = false;
24
+ function fetchCredential() {
25
+ return authenticate().then(function (credential) {
26
+ log.info(LOG_PREFIX_SYNC_AUTH + 'credential fetched successfully');
27
+ cachedCredential = credential;
28
+ inFlightPromise = undefined;
29
+ backoff.reset();
30
+ return credential;
31
+ }).catch(function (error) {
32
+ // Avoid rejected promises and unnecessary retries after stop()
33
+ if (stopped)
34
+ return cachedCredential;
35
+ if (error.statusCode && error.statusCode >= 400 && error.statusCode < 500) {
36
+ log.error(LOG_PREFIX_SYNC_AUTH + 'non-retryable error fetching credential (status ' + error.statusCode + '): ' + error.message);
37
+ inFlightPromise = undefined;
38
+ throw error;
39
+ }
40
+ log.warn(LOG_PREFIX_SYNC_AUTH + 'credential fetch failed (attempt ' + (backoff.attempts + 1) + '). Error: ' + error.message);
41
+ return backoff.scheduleCallAsync();
42
+ });
43
+ }
44
+ return {
45
+ credential: function () {
46
+ if (cachedCredential && !isExpired(cachedCredential)) {
47
+ return Promise.resolve(cachedCredential);
48
+ }
49
+ if (cachedCredential)
50
+ log.debug(LOG_PREFIX_SYNC_AUTH + 'cached credential expired');
51
+ return inFlightPromise || (inFlightPromise = fetchCredential());
52
+ },
53
+ invalidate: function () {
54
+ cachedCredential = undefined;
55
+ },
56
+ stop: function () {
57
+ stopped = true;
58
+ cachedCredential = undefined;
59
+ inFlightPromise = undefined;
60
+ backoff.reset();
61
+ }
62
+ };
63
+ }
@@ -0,0 +1,35 @@
1
+ import { __assign } from "tslib";
2
+ import { splitHttpClientFactory } from './splitHttpClient';
3
+ import { authProviderFactory } from './authProvider';
4
+ /**
5
+ * Factory of Secure HTTP client, which authenticates requests using a JWT token.
6
+ * On 401 responses, invalidates the cached credential and retries once with a fresh token.
7
+ *
8
+ * @param settings - SDK settings
9
+ * @param platform - object containing environment-specific dependencies
10
+ * @param fetchAuth - function to fetch auth credentials from the /v2/auth endpoint
11
+ */
12
+ export function secureSplitHttpClientFactory(settings, platform, telemetryTracker) {
13
+ var splitHttpClient = splitHttpClientFactory(settings, platform);
14
+ var authProvider = authProviderFactory(settings, splitHttpClient, telemetryTracker);
15
+ function makeRequest(url, options, latencyTracker, logErrorsAsInfo, token) {
16
+ return splitHttpClient(url, __assign(__assign({}, options), { headers: __assign(__assign({}, options === null || options === void 0 ? void 0 : options.headers), { Authorization: "Bearer ".concat(token) }) }), latencyTracker, logErrorsAsInfo);
17
+ }
18
+ var httpClient = function (url, options, latencyTracker, logErrorsAsInfo) {
19
+ return authProvider.credential().then(function (credential) {
20
+ return makeRequest(url, options, latencyTracker, logErrorsAsInfo, credential.token)
21
+ .catch(function (error) {
22
+ if (error.statusCode === 401) {
23
+ // retry once for 401, in case the token has just expired
24
+ authProvider.invalidate();
25
+ return authProvider.credential().then(function (newCredential) {
26
+ return makeRequest(url, options, latencyTracker, logErrorsAsInfo, newCredential.token);
27
+ });
28
+ }
29
+ throw error;
30
+ });
31
+ });
32
+ };
33
+ httpClient.stop = function () { return authProvider.stop(); };
34
+ return httpClient;
35
+ }
@@ -13,11 +13,12 @@ function userKeyToQueryParam(userKey) {
13
13
  * @param platform - object containing environment-specific dependencies
14
14
  * @param telemetryTracker - telemetry tracker
15
15
  */
16
- export function splitApiFactory(settings, platform, telemetryTracker) {
16
+ export function splitApiFactory(settings, platform, telemetryTracker, secureSplitHttpClientFactory) {
17
17
  var urls = settings.urls;
18
18
  var filterQueryString = settings.sync.__splitFiltersValidation && settings.sync.__splitFiltersValidation.queryString;
19
19
  var SplitSDKImpressionsMode = settings.sync.impressionsMode;
20
20
  var splitHttpClient = splitHttpClientFactory(settings, platform);
21
+ var secureSplitHttpClient = secureSplitHttpClientFactory ? secureSplitHttpClientFactory(settings, platform, telemetryTracker) : undefined;
21
22
  return {
22
23
  // @TODO throw errors if health check requests fail, to log them in the Synchronizer
23
24
  getSdkAPIHealthCheck: function () {
@@ -46,15 +47,19 @@ export function splitApiFactory(settings, platform, telemetryTracker) {
46
47
  throw err;
47
48
  });
48
49
  },
49
- // @TODO support filterQueryString and handle ERROR_TOO_MANY_SETS error
50
- fetchConfigs: function (since, noCache, till) {
51
- var url = "".concat(urls.sdk, "/v1/configs?since=").concat(since).concat(filterQueryString || '').concat(till ? '&till=' + till : '');
52
- return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined);
53
- },
54
50
  fetchSegmentChanges: function (since, segmentName, noCache, till) {
55
51
  var url = "".concat(urls.sdk, "/segmentChanges/").concat(segmentName, "?since=").concat(since).concat(till ? '&till=' + till : '');
56
52
  return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(SEGMENT));
57
53
  },
54
+ // @TODO support filterQueryString and handle ERROR_TOO_MANY_SETS error
55
+ fetchConfigs: function (since, noCache, till) {
56
+ var url = "".concat(urls.configs, "/v1/configs?since=").concat(since).concat(filterQueryString || '').concat(till ? '&till=' + till : '');
57
+ return (secureSplitHttpClient || splitHttpClient)(url, noCache ? noCacheHeaderOptions : undefined);
58
+ },
59
+ fetchConfigsSegmentChanges: function (since, segmentName, noCache, till) {
60
+ var url = "".concat(urls.configs, "/v1/segmentChanges/").concat(segmentName, "?since=").concat(since).concat(till ? '&till=' + till : '');
61
+ return (secureSplitHttpClient || splitHttpClient)(url, noCache ? noCacheHeaderOptions : undefined);
62
+ },
58
63
  fetchMemberships: function (userMatchingKey, noCache, till) {
59
64
  /**
60
65
  * URI encoding of user keys in order to:
@@ -127,6 +132,10 @@ export function splitApiFactory(settings, platform, telemetryTracker) {
127
132
  postMetricsUsage: function (body, headers) {
128
133
  var url = "".concat(urls.telemetry, "/v1/metrics/usage");
129
134
  return splitHttpClient(url, { method: 'POST', body: body, headers: headers }, telemetryTracker.trackHttp(TELEMETRY), true);
135
+ },
136
+ stop: function () {
137
+ if (secureSplitHttpClient)
138
+ secureSplitHttpClient.stop();
130
139
  }
131
140
  };
132
141
  }
@@ -0,0 +1,48 @@
1
+ import { objectAssign } from '../utils/lang/objectAssign';
2
+ /**
3
+ * This class provides a skeletal implementation of the IDefinitionsCacheAsync interface
4
+ * to minimize the effort required to implement this interface.
5
+ */
6
+ var AbstractDefinitionsCacheAsync = /** @class */ (function () {
7
+ function AbstractDefinitionsCacheAsync() {
8
+ }
9
+ AbstractDefinitionsCacheAsync.prototype.update = function (toAdd, toRemove, changeNumber) {
10
+ var _this = this;
11
+ return Promise.all([
12
+ this.setChangeNumber(changeNumber),
13
+ Promise.all(toAdd.map(function (addedFF) { return _this.add(addedFF); })),
14
+ Promise.all(toRemove.map(function (removedFF) { return _this.remove(removedFF); }))
15
+ ]).then(function (_a) {
16
+ var added = _a[1], removed = _a[2];
17
+ return added.some(function (result) { return result; }) || removed.some(function (result) { return result; });
18
+ });
19
+ };
20
+ // @TODO revisit segment-related methods ('usesSegments', 'getRegisteredSegments', 'registerSegments')
21
+ // noop, just keeping the interface. This is used by standalone client-side API only, and so only implemented by InMemory and InLocalStorage.
22
+ AbstractDefinitionsCacheAsync.prototype.usesSegments = function () {
23
+ return Promise.resolve(true);
24
+ };
25
+ /**
26
+ * Kill `name` definition and set `defaultTreatment` and `changeNumber`.
27
+ * Used for SPLIT_KILL push notifications.
28
+ *
29
+ * @returns a promise that is resolved once the definition kill operation is performed. The fulfillment value is a boolean: `true` if the operation succeeded updating the definition or `false` if no definition is updated,
30
+ * for instance, if the `changeNumber` is old, or if the definition is not found (e.g., `/splitchanges` hasn't been fetched yet), or if the storage fails to apply the update.
31
+ * The promise will never be rejected.
32
+ */
33
+ AbstractDefinitionsCacheAsync.prototype.killLocally = function (name, defaultTreatment, changeNumber) {
34
+ var _this = this;
35
+ return this.get(name).then(function (definition) {
36
+ if (definition && (!definition.changeNumber || definition.changeNumber < changeNumber)) {
37
+ var newDefinition = objectAssign({}, definition);
38
+ newDefinition.killed = true;
39
+ newDefinition.defaultTreatment = defaultTreatment;
40
+ newDefinition.changeNumber = changeNumber;
41
+ return _this.add(newDefinition);
42
+ }
43
+ return false;
44
+ }).catch(function () { return false; });
45
+ };
46
+ return AbstractDefinitionsCacheAsync;
47
+ }());
48
+ export { AbstractDefinitionsCacheAsync };