@splitsoftware/splitio-commons 2.12.0 → 3.0.0-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 (395) hide show
  1. package/CHANGES.txt +19 -1
  2. package/cjs/evaluator/condition/engineUtils.js +2 -2
  3. package/cjs/evaluator/fallbackConfigsCalculator/fallbackSanitizer/index.js +70 -0
  4. package/cjs/evaluator/fallbackConfigsCalculator/index.js +25 -0
  5. package/cjs/evaluator/fallbackTreatmentsCalculator/fallbackSanitizer/index.js +5 -8
  6. package/cjs/evaluator/fallbackTreatmentsCalculator/index.js +21 -32
  7. package/cjs/evaluator/index.js +73 -48
  8. package/cjs/evaluator/matchers/whitelist.js +1 -1
  9. package/cjs/integrations/pluggable.js +1 -1
  10. package/cjs/listeners/browser.js +4 -3
  11. package/cjs/listeners/node.js +4 -4
  12. package/cjs/logger/constants.js +15 -21
  13. package/cjs/logger/index.js +1 -1
  14. package/cjs/logger/messages/debug.js +6 -7
  15. package/cjs/logger/messages/error.js +4 -4
  16. package/cjs/logger/messages/info.js +2 -4
  17. package/cjs/logger/messages/warn.js +9 -10
  18. package/cjs/platform/browser.js +15 -0
  19. package/cjs/platform/getEventSource/browser.js +8 -0
  20. package/cjs/platform/getEventSource/eventsource.js +480 -0
  21. package/cjs/platform/getEventSource/node.js +26 -0
  22. package/cjs/platform/getFetch/browser.js +9 -0
  23. package/cjs/platform/getFetch/node.js +27 -0
  24. package/cjs/platform/getOptions/node.js +25 -0
  25. package/cjs/platform/node.js +17 -0
  26. package/cjs/readiness/constants.js +5 -4
  27. package/cjs/readiness/readinessManager.js +22 -22
  28. package/cjs/readiness/sdkReadinessManager.js +0 -16
  29. package/cjs/sdkClient/client.js +9 -35
  30. package/cjs/sdkClient/clientAttributesDecoration.js +3 -3
  31. package/cjs/sdkClient/clientInputValidation.js +38 -81
  32. package/cjs/sdkClient/identity.js +1 -1
  33. package/cjs/sdkClient/sdkClient.js +4 -49
  34. package/cjs/sdkClient/sdkLifecycle.js +71 -0
  35. package/cjs/sdkClient/trackMethod.js +56 -0
  36. package/cjs/sdkFactory/index.js +13 -50
  37. package/cjs/sdkManager/index.js +5 -5
  38. package/cjs/services/authProvider.js +67 -0
  39. package/cjs/services/secureSplitHttpClient.js +39 -0
  40. package/cjs/services/splitApi.js +24 -14
  41. package/cjs/services/splitHttpClient.js +1 -1
  42. package/cjs/storages/AbstractDefinitionsCacheAsync.js +51 -0
  43. package/cjs/storages/AbstractDefinitionsCacheSync.js +76 -0
  44. package/cjs/storages/KeyBuilder.js +16 -16
  45. package/cjs/storages/KeyBuilderCS.js +17 -17
  46. package/cjs/storages/KeyBuilderSS.js +16 -16
  47. package/cjs/storages/getRolloutPlan.js +4 -4
  48. package/cjs/storages/inLocalStorage/DefinitionsCacheInLocal.js +194 -0
  49. package/cjs/storages/inLocalStorage/MySegmentsCacheInLocal.js +1 -1
  50. package/cjs/storages/inLocalStorage/RBSegmentsCacheInLocal.js +10 -10
  51. package/cjs/storages/inLocalStorage/index.js +6 -6
  52. package/cjs/storages/inLocalStorage/validateCache.js +3 -3
  53. package/cjs/storages/inMemory/DefinitionsCacheInMemory.js +121 -0
  54. package/cjs/storages/inMemory/ImpressionCountsCacheInMemory.js +1 -1
  55. package/cjs/storages/inMemory/InMemoryStorage.js +4 -4
  56. package/cjs/storages/inMemory/InMemoryStorageCS.js +5 -5
  57. package/cjs/storages/inMemory/MySegmentsCacheInMemory.js +1 -1
  58. package/cjs/storages/inMemory/RBSegmentsCacheInMemory.js +5 -5
  59. package/cjs/storages/inMemory/SegmentsCacheInMemory.js +1 -1
  60. package/cjs/storages/inMemory/TelemetryCacheInMemory.js +5 -5
  61. package/cjs/storages/inRedis/DefinitionsCacheInRedis.js +243 -0
  62. package/cjs/storages/inRedis/EventsCacheInRedis.js +1 -1
  63. package/cjs/storages/inRedis/ImpressionCountsCacheInRedis.js +5 -5
  64. package/cjs/storages/inRedis/ImpressionsCacheInRedis.js +1 -1
  65. package/cjs/storages/inRedis/RBSegmentsCacheInRedis.js +1 -1
  66. package/cjs/storages/inRedis/RedisAdapter.js +8 -8
  67. package/cjs/storages/inRedis/TelemetryCacheInRedis.js +7 -7
  68. package/cjs/storages/inRedis/UniqueKeysCacheInRedis.js +3 -3
  69. package/cjs/storages/inRedis/index.js +2 -2
  70. package/cjs/storages/pluggable/DefinitionsCachePluggable.js +212 -0
  71. package/cjs/storages/pluggable/EventsCachePluggable.js +1 -1
  72. package/cjs/storages/pluggable/ImpressionCountsCachePluggable.js +6 -6
  73. package/cjs/storages/pluggable/RBSegmentsCachePluggable.js +1 -1
  74. package/cjs/storages/pluggable/TelemetryCachePluggable.js +7 -7
  75. package/cjs/storages/pluggable/UniqueKeysCachePluggable.js +2 -2
  76. package/cjs/storages/pluggable/index.js +5 -5
  77. package/cjs/storages/pluggable/wrapperAdapter.js +1 -1
  78. package/cjs/storages/setRolloutPlan.js +6 -6
  79. package/cjs/storages/utils.js +6 -6
  80. package/cjs/sync/offline/splitsParser/parseCondition.js +1 -1
  81. package/cjs/sync/offline/syncTasks/fromObjectSyncTask.js +5 -5
  82. package/cjs/sync/polling/fetchers/segmentChangesFetcher.js +1 -1
  83. package/cjs/sync/polling/fetchers/splitChangesFetcher.js +24 -15
  84. package/cjs/sync/polling/pollingManagerCS.js +18 -18
  85. package/cjs/sync/polling/pollingManagerSS.js +13 -13
  86. package/cjs/sync/polling/syncTasks/definitionsSyncTask.js +12 -0
  87. package/cjs/sync/polling/updaters/{splitChangesUpdater.js → definitionChangesUpdater.js} +72 -64
  88. package/cjs/sync/polling/updaters/mySegmentsUpdater.js +3 -3
  89. package/cjs/sync/polling/updaters/segmentChangesUpdater.js +6 -6
  90. package/cjs/sync/streaming/SSEClient/index.js +2 -2
  91. package/cjs/sync/streaming/SSEHandler/NotificationKeeper.js +1 -1
  92. package/cjs/sync/streaming/SSEHandler/index.js +1 -1
  93. package/cjs/sync/streaming/UpdateWorkers/{SplitsUpdateWorker.js → DefinitionsUpdateWorker.js} +18 -18
  94. package/cjs/sync/streaming/UpdateWorkers/MySegmentsUpdateWorker.js +2 -2
  95. package/cjs/sync/streaming/UpdateWorkers/SegmentsUpdateWorker.js +2 -2
  96. package/cjs/sync/streaming/constants.js +3 -3
  97. package/cjs/sync/streaming/parseUtils.js +12 -12
  98. package/cjs/sync/streaming/pushManager.js +14 -14
  99. package/cjs/sync/submitters/impressionsSubmitter.js +6 -6
  100. package/cjs/sync/submitters/submitter.js +1 -1
  101. package/cjs/sync/submitters/telemetrySubmitter.js +1 -2
  102. package/cjs/sync/syncManagerOnline.js +9 -6
  103. package/cjs/trackers/eventTracker.js +10 -12
  104. package/cjs/trackers/impressionObserver/buildKey.js +1 -1
  105. package/cjs/trackers/impressionsTracker.js +37 -20
  106. package/cjs/trackers/uniqueKeysTracker.js +1 -1
  107. package/cjs/utils/Backoff.js +20 -0
  108. package/cjs/utils/EventEmitter.js +391 -0
  109. package/cjs/utils/filter/bloomFilter.js +37 -0
  110. package/cjs/utils/inputValidation/apiKey.js +1 -1
  111. package/cjs/utils/inputValidation/attribute.js +2 -2
  112. package/cjs/utils/inputValidation/{split.js → definition.js} +10 -10
  113. package/cjs/utils/inputValidation/{splitExistence.js → definitionExistence.js} +6 -6
  114. package/cjs/utils/inputValidation/definitions.js +25 -0
  115. package/cjs/utils/inputValidation/eventProperties.js +1 -1
  116. package/cjs/utils/inputValidation/index.js +7 -7
  117. package/cjs/utils/inputValidation/isOperational.js +4 -4
  118. package/cjs/utils/inputValidation/target.js +22 -0
  119. package/cjs/utils/labels/index.js +3 -3
  120. package/cjs/utils/lang/index.js +1 -1
  121. package/cjs/utils/lang/sets.js +4 -4
  122. package/cjs/utils/promise/timeout.js +1 -1
  123. package/cjs/utils/settingsValidation/splitFilters.js +4 -4
  124. package/cjs/utils/settingsValidation/url.js +6 -6
  125. package/esm/evaluator/condition/engineUtils.js +2 -2
  126. package/esm/evaluator/fallbackConfigsCalculator/fallbackSanitizer/index.js +64 -0
  127. package/esm/evaluator/fallbackConfigsCalculator/index.js +21 -0
  128. package/esm/evaluator/fallbackTreatmentsCalculator/fallbackSanitizer/index.js +5 -8
  129. package/esm/evaluator/fallbackTreatmentsCalculator/index.js +21 -33
  130. package/esm/evaluator/index.js +72 -48
  131. package/esm/evaluator/matchers/whitelist.js +1 -1
  132. package/esm/integrations/pluggable.js +1 -1
  133. package/esm/listeners/browser.js +4 -3
  134. package/esm/listeners/node.js +4 -4
  135. package/esm/logger/constants.js +12 -18
  136. package/esm/logger/index.js +1 -1
  137. package/esm/logger/messages/debug.js +5 -6
  138. package/esm/logger/messages/error.js +3 -3
  139. package/esm/logger/messages/info.js +1 -3
  140. package/esm/logger/messages/warn.js +8 -9
  141. package/esm/platform/browser.js +12 -0
  142. package/esm/platform/getEventSource/browser.js +4 -0
  143. package/esm/platform/getEventSource/eventsource.js +480 -0
  144. package/esm/platform/getEventSource/node.js +20 -0
  145. package/esm/platform/getFetch/browser.js +5 -0
  146. package/esm/platform/getFetch/node.js +22 -0
  147. package/esm/platform/getOptions/node.js +20 -0
  148. package/esm/platform/node.js +14 -0
  149. package/esm/readiness/constants.js +4 -3
  150. package/esm/readiness/readinessManager.js +23 -23
  151. package/esm/readiness/sdkReadinessManager.js +1 -17
  152. package/esm/sdkClient/client.js +10 -37
  153. package/esm/sdkClient/clientAttributesDecoration.js +3 -3
  154. package/esm/sdkClient/clientInputValidation.js +40 -83
  155. package/esm/sdkClient/identity.js +1 -1
  156. package/esm/sdkClient/sdkClient.js +4 -49
  157. package/esm/sdkClient/sdkLifecycle.js +67 -0
  158. package/esm/sdkClient/trackMethod.js +52 -0
  159. package/esm/sdkFactory/index.js +14 -51
  160. package/esm/sdkManager/index.js +6 -6
  161. package/esm/services/authProvider.js +63 -0
  162. package/esm/services/secureSplitHttpClient.js +35 -0
  163. package/esm/services/splitApi.js +24 -14
  164. package/esm/services/splitHttpClient.js +1 -1
  165. package/esm/storages/AbstractDefinitionsCacheAsync.js +48 -0
  166. package/esm/storages/AbstractDefinitionsCacheSync.js +71 -0
  167. package/esm/storages/KeyBuilder.js +16 -16
  168. package/esm/storages/KeyBuilderCS.js +16 -16
  169. package/esm/storages/KeyBuilderSS.js +15 -15
  170. package/esm/storages/getRolloutPlan.js +4 -4
  171. package/esm/storages/inLocalStorage/DefinitionsCacheInLocal.js +191 -0
  172. package/esm/storages/inLocalStorage/RBSegmentsCacheInLocal.js +7 -7
  173. package/esm/storages/inLocalStorage/index.js +6 -6
  174. package/esm/storages/inLocalStorage/validateCache.js +3 -3
  175. package/esm/storages/inMemory/DefinitionsCacheInMemory.js +118 -0
  176. package/esm/storages/inMemory/ImpressionCountsCacheInMemory.js +1 -1
  177. package/esm/storages/inMemory/InMemoryStorage.js +4 -4
  178. package/esm/storages/inMemory/InMemoryStorageCS.js +5 -5
  179. package/esm/storages/inMemory/RBSegmentsCacheInMemory.js +2 -2
  180. package/esm/storages/inMemory/SegmentsCacheInMemory.js +1 -1
  181. package/esm/storages/inMemory/TelemetryCacheInMemory.js +5 -5
  182. package/esm/storages/inRedis/DefinitionsCacheInRedis.js +240 -0
  183. package/esm/storages/inRedis/EventsCacheInRedis.js +1 -1
  184. package/esm/storages/inRedis/ImpressionCountsCacheInRedis.js +4 -4
  185. package/esm/storages/inRedis/RBSegmentsCacheInRedis.js +1 -1
  186. package/esm/storages/inRedis/RedisAdapter.js +7 -7
  187. package/esm/storages/inRedis/TelemetryCacheInRedis.js +7 -7
  188. package/esm/storages/inRedis/UniqueKeysCacheInRedis.js +1 -1
  189. package/esm/storages/inRedis/index.js +2 -2
  190. package/esm/storages/pluggable/DefinitionsCachePluggable.js +209 -0
  191. package/esm/storages/pluggable/EventsCachePluggable.js +1 -1
  192. package/esm/storages/pluggable/ImpressionCountsCachePluggable.js +5 -5
  193. package/esm/storages/pluggable/RBSegmentsCachePluggable.js +1 -1
  194. package/esm/storages/pluggable/TelemetryCachePluggable.js +7 -7
  195. package/esm/storages/pluggable/UniqueKeysCachePluggable.js +1 -1
  196. package/esm/storages/pluggable/index.js +4 -4
  197. package/esm/storages/pluggable/wrapperAdapter.js +1 -1
  198. package/esm/storages/setRolloutPlan.js +6 -6
  199. package/esm/storages/utils.js +6 -6
  200. package/esm/sync/offline/splitsParser/parseCondition.js +1 -1
  201. package/esm/sync/offline/syncTasks/fromObjectSyncTask.js +6 -6
  202. package/esm/sync/polling/fetchers/splitChangesFetcher.js +25 -16
  203. package/esm/sync/polling/pollingManagerCS.js +15 -15
  204. package/esm/sync/polling/pollingManagerSS.js +13 -13
  205. package/esm/sync/polling/syncTasks/definitionsSyncTask.js +8 -0
  206. package/esm/sync/polling/updaters/definitionChangesUpdater.js +200 -0
  207. package/esm/sync/polling/updaters/mySegmentsUpdater.js +3 -3
  208. package/esm/sync/polling/updaters/segmentChangesUpdater.js +7 -7
  209. package/esm/sync/streaming/SSEClient/index.js +2 -2
  210. package/esm/sync/streaming/SSEHandler/NotificationKeeper.js +2 -2
  211. package/esm/sync/streaming/SSEHandler/index.js +2 -2
  212. package/esm/sync/streaming/UpdateWorkers/{SplitsUpdateWorker.js → DefinitionsUpdateWorker.js} +17 -17
  213. package/esm/sync/streaming/UpdateWorkers/MySegmentsUpdateWorker.js +2 -2
  214. package/esm/sync/streaming/UpdateWorkers/SegmentsUpdateWorker.js +2 -2
  215. package/esm/sync/streaming/constants.js +2 -2
  216. package/esm/sync/streaming/parseUtils.js +10 -10
  217. package/esm/sync/streaming/pushManager.js +16 -16
  218. package/esm/sync/submitters/impressionsSubmitter.js +6 -6
  219. package/esm/sync/submitters/submitter.js +1 -1
  220. package/esm/sync/submitters/telemetrySubmitter.js +1 -2
  221. package/esm/sync/syncManagerOnline.js +8 -5
  222. package/esm/trackers/eventTracker.js +10 -12
  223. package/esm/trackers/impressionObserver/buildKey.js +1 -1
  224. package/esm/trackers/impressionsTracker.js +38 -21
  225. package/esm/trackers/uniqueKeysTracker.js +1 -1
  226. package/esm/utils/Backoff.js +20 -0
  227. package/esm/utils/EventEmitter.js +387 -0
  228. package/esm/utils/filter/bloomFilter.js +33 -0
  229. package/esm/utils/inputValidation/apiKey.js +1 -1
  230. package/esm/utils/inputValidation/attribute.js +2 -2
  231. package/esm/utils/inputValidation/{split.js → definition.js} +8 -8
  232. package/esm/utils/inputValidation/definitionExistence.js +15 -0
  233. package/esm/utils/inputValidation/definitions.js +21 -0
  234. package/esm/utils/inputValidation/index.js +3 -3
  235. package/esm/utils/inputValidation/isOperational.js +4 -4
  236. package/esm/utils/inputValidation/target.js +18 -0
  237. package/esm/utils/labels/index.js +2 -2
  238. package/esm/utils/lang/sets.js +4 -4
  239. package/esm/utils/promise/timeout.js +1 -1
  240. package/esm/utils/settingsValidation/splitFilters.js +4 -4
  241. package/esm/utils/settingsValidation/url.js +6 -6
  242. package/package.json +15 -6
  243. package/src/dtos/types.ts +65 -70
  244. package/src/evaluator/Engine.ts +4 -4
  245. package/src/evaluator/combiners/and.ts +3 -3
  246. package/src/evaluator/combiners/ifelseif.ts +2 -2
  247. package/src/evaluator/condition/engineUtils.ts +2 -2
  248. package/src/evaluator/condition/index.ts +3 -3
  249. package/src/evaluator/fallbackConfigsCalculator/fallbackSanitizer/index.ts +76 -0
  250. package/src/evaluator/fallbackConfigsCalculator/index.ts +24 -0
  251. package/src/evaluator/fallbackTreatmentsCalculator/fallbackSanitizer/index.ts +5 -7
  252. package/src/evaluator/fallbackTreatmentsCalculator/index.ts +27 -41
  253. package/src/evaluator/index.ts +86 -51
  254. package/src/evaluator/matchers/dependency.ts +2 -2
  255. package/src/evaluator/matchers/matcherTypes.ts +2 -2
  256. package/src/evaluator/matchers/prerequisites.ts +4 -4
  257. package/src/evaluator/matchers/rbsegment.ts +2 -2
  258. package/src/evaluator/matchers/whitelist.ts +2 -2
  259. package/src/evaluator/matchersTransform/index.ts +2 -2
  260. package/src/evaluator/matchersTransform/whitelist.ts +2 -2
  261. package/src/evaluator/parser/index.ts +4 -4
  262. package/src/evaluator/treatments/index.ts +2 -2
  263. package/src/evaluator/types.ts +6 -6
  264. package/src/evaluator/value/index.ts +1 -1
  265. package/src/integrations/pluggable.ts +1 -1
  266. package/src/listeners/browser.ts +11 -8
  267. package/src/listeners/node.ts +2 -5
  268. package/src/logger/constants.ts +12 -18
  269. package/src/logger/messages/debug.ts +5 -6
  270. package/src/logger/messages/error.ts +3 -3
  271. package/src/logger/messages/info.ts +1 -3
  272. package/src/logger/messages/warn.ts +8 -9
  273. package/src/platform/browser.ts +14 -0
  274. package/src/platform/getEventSource/browser.ts +4 -0
  275. package/src/platform/getEventSource/eventsource.js +519 -0
  276. package/src/platform/getEventSource/node.ts +23 -0
  277. package/src/platform/getFetch/browser.ts +5 -0
  278. package/src/platform/getFetch/node.ts +27 -0
  279. package/src/platform/getOptions/node.ts +24 -0
  280. package/src/platform/node.ts +16 -0
  281. package/src/readiness/constants.ts +4 -3
  282. package/src/readiness/readinessManager.ts +22 -22
  283. package/src/readiness/sdkReadinessManager.ts +1 -16
  284. package/src/readiness/types.ts +10 -16
  285. package/src/sdkClient/client.ts +11 -41
  286. package/src/sdkClient/clientInputValidation.ts +44 -84
  287. package/src/sdkClient/sdkClient.ts +5 -54
  288. package/src/sdkClient/sdkLifecycle.ts +79 -0
  289. package/src/sdkClient/trackMethod.ts +59 -0
  290. package/src/sdkFactory/index.ts +15 -59
  291. package/src/sdkFactory/types.ts +19 -16
  292. package/src/sdkManager/index.ts +15 -15
  293. package/src/services/authProvider.ts +86 -0
  294. package/src/services/secureSplitHttpClient.ts +44 -0
  295. package/src/services/splitApi.ts +14 -2
  296. package/src/services/types.ts +7 -2
  297. package/src/storages/AbstractDefinitionsCacheAsync.ts +63 -0
  298. package/src/storages/AbstractDefinitionsCacheSync.ts +95 -0
  299. package/src/storages/KeyBuilder.ts +6 -6
  300. package/src/storages/KeyBuilderCS.ts +6 -6
  301. package/src/storages/KeyBuilderSS.ts +2 -2
  302. package/src/storages/getRolloutPlan.ts +3 -3
  303. package/src/storages/inLocalStorage/DefinitionsCacheInLocal.ts +234 -0
  304. package/src/storages/inLocalStorage/RBSegmentsCacheInLocal.ts +8 -8
  305. package/src/storages/inLocalStorage/index.ts +6 -6
  306. package/src/storages/inLocalStorage/validateCache.ts +4 -4
  307. package/src/storages/inMemory/DefinitionsCacheInMemory.ts +130 -0
  308. package/src/storages/inMemory/InMemoryStorage.ts +4 -4
  309. package/src/storages/inMemory/InMemoryStorageCS.ts +5 -5
  310. package/src/storages/inMemory/RBSegmentsCacheInMemory.ts +3 -3
  311. package/src/storages/inMemory/SegmentsCacheInMemory.ts +1 -1
  312. package/src/storages/inMemory/TelemetryCacheInMemory.ts +5 -5
  313. package/src/storages/inRedis/{SplitsCacheInRedis.ts → DefinitionsCacheInRedis.ts} +69 -69
  314. package/src/storages/inRedis/RBSegmentsCacheInRedis.ts +2 -2
  315. package/src/storages/inRedis/index.ts +2 -2
  316. package/src/storages/pluggable/DefinitionsCachePluggable.ts +230 -0
  317. package/src/storages/pluggable/RBSegmentsCachePluggable.ts +2 -2
  318. package/src/storages/pluggable/index.ts +2 -2
  319. package/src/storages/setRolloutPlan.ts +7 -7
  320. package/src/storages/types.ts +34 -29
  321. package/src/sync/offline/splitsParser/parseCondition.ts +2 -2
  322. package/src/sync/offline/splitsParser/splitsParserFromSettings.ts +3 -3
  323. package/src/sync/offline/splitsParser/types.ts +6 -3
  324. package/src/sync/offline/syncManagerOffline.ts +2 -2
  325. package/src/sync/offline/syncTasks/fromObjectSyncTask.ts +14 -14
  326. package/src/sync/polling/fetchers/splitChangesFetcher.ts +58 -23
  327. package/src/sync/polling/fetchers/types.ts +5 -3
  328. package/src/sync/polling/pollingManagerCS.ts +16 -14
  329. package/src/sync/polling/pollingManagerSS.ts +15 -13
  330. package/src/sync/polling/syncTasks/{splitsSyncTask.ts → definitionsSyncTask.ts} +11 -12
  331. package/src/sync/polling/types.ts +3 -3
  332. package/src/sync/polling/updaters/definitionChangesUpdater.ts +239 -0
  333. package/src/sync/polling/updaters/mySegmentsUpdater.ts +3 -3
  334. package/src/sync/polling/updaters/segmentChangesUpdater.ts +7 -7
  335. package/src/sync/streaming/AuthClient/index.ts +2 -2
  336. package/src/sync/streaming/AuthClient/types.ts +14 -11
  337. package/src/sync/streaming/SSEClient/index.ts +2 -2
  338. package/src/sync/streaming/SSEClient/types.ts +2 -2
  339. package/src/sync/streaming/SSEHandler/NotificationKeeper.ts +2 -2
  340. package/src/sync/streaming/SSEHandler/index.ts +2 -2
  341. package/src/sync/streaming/UpdateWorkers/{SplitsUpdateWorker.ts → DefinitionsUpdateWorker.ts} +21 -21
  342. package/src/sync/streaming/constants.ts +2 -2
  343. package/src/sync/streaming/parseUtils.ts +12 -12
  344. package/src/sync/streaming/pushManager.ts +18 -18
  345. package/src/sync/streaming/types.ts +2 -2
  346. package/src/sync/submitters/impressionsSubmitter.ts +9 -9
  347. package/src/sync/submitters/telemetrySubmitter.ts +1 -2
  348. package/src/sync/submitters/types.ts +3 -0
  349. package/src/sync/syncManagerOnline.ts +9 -5
  350. package/src/trackers/eventTracker.ts +7 -10
  351. package/src/trackers/impressionsTracker.ts +42 -26
  352. package/src/trackers/types.ts +3 -1
  353. package/src/utils/Backoff.ts +21 -0
  354. package/src/utils/EventEmitter.js +444 -0
  355. package/src/utils/filter/bloomFilter.ts +38 -0
  356. package/src/utils/inputValidation/definition.ts +27 -0
  357. package/src/utils/inputValidation/definitionExistence.ts +19 -0
  358. package/src/utils/inputValidation/definitions.ts +21 -0
  359. package/src/utils/inputValidation/index.ts +3 -3
  360. package/src/utils/inputValidation/isOperational.ts +4 -4
  361. package/src/utils/inputValidation/target.ts +21 -0
  362. package/src/utils/inputValidation/trafficTypeExistence.ts +2 -2
  363. package/src/utils/jwt/types.ts +1 -1
  364. package/src/utils/labels/index.ts +2 -2
  365. package/src/utils/lang/sets.ts +4 -2
  366. package/src/utils/settingsValidation/splitFilters.ts +3 -3
  367. package/src/utils/settingsValidation/url.ts +1 -1
  368. package/types/splitio.d.ts +222 -11
  369. package/cjs/storages/AbstractSplitsCacheAsync.js +0 -51
  370. package/cjs/storages/AbstractSplitsCacheSync.js +0 -76
  371. package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js +0 -194
  372. package/cjs/storages/inMemory/SplitsCacheInMemory.js +0 -121
  373. package/cjs/storages/inRedis/SplitsCacheInRedis.js +0 -243
  374. package/cjs/storages/pluggable/SplitsCachePluggable.js +0 -212
  375. package/cjs/sync/polling/syncTasks/splitsSyncTask.js +0 -13
  376. package/cjs/utils/inputValidation/splits.js +0 -25
  377. package/esm/storages/AbstractSplitsCacheAsync.js +0 -48
  378. package/esm/storages/AbstractSplitsCacheSync.js +0 -71
  379. package/esm/storages/inLocalStorage/SplitsCacheInLocal.js +0 -191
  380. package/esm/storages/inMemory/SplitsCacheInMemory.js +0 -118
  381. package/esm/storages/inRedis/SplitsCacheInRedis.js +0 -240
  382. package/esm/storages/pluggable/SplitsCachePluggable.js +0 -209
  383. package/esm/sync/polling/syncTasks/splitsSyncTask.js +0 -9
  384. package/esm/sync/polling/updaters/splitChangesUpdater.js +0 -192
  385. package/esm/utils/inputValidation/splitExistence.js +0 -15
  386. package/esm/utils/inputValidation/splits.js +0 -21
  387. package/src/storages/AbstractSplitsCacheAsync.ts +0 -63
  388. package/src/storages/AbstractSplitsCacheSync.ts +0 -95
  389. package/src/storages/inLocalStorage/SplitsCacheInLocal.ts +0 -234
  390. package/src/storages/inMemory/SplitsCacheInMemory.ts +0 -130
  391. package/src/storages/pluggable/SplitsCachePluggable.ts +0 -230
  392. package/src/sync/polling/updaters/splitChangesUpdater.ts +0 -230
  393. package/src/utils/inputValidation/split.ts +0 -27
  394. package/src/utils/inputValidation/splitExistence.ts +0 -19
  395. package/src/utils/inputValidation/splits.ts +0 -21
@@ -1,118 +0,0 @@
1
- import { __extends } from "tslib";
2
- import { AbstractSplitsCacheSync, usesSegments } from '../AbstractSplitsCacheSync';
3
- import { isFiniteNumber } from '../../utils/lang';
4
- /**
5
- * Default ISplitsCacheSync implementation that stores split definitions in memory.
6
- */
7
- var SplitsCacheInMemory = /** @class */ (function (_super) {
8
- __extends(SplitsCacheInMemory, _super);
9
- function SplitsCacheInMemory(splitFiltersValidation) {
10
- var _this = _super.call(this) || this;
11
- _this.splitsCache = {};
12
- _this.ttCache = {};
13
- _this.changeNumber = -1;
14
- _this.segmentsCount = 0;
15
- _this.flagSetsCache = {};
16
- _this.flagSetsFilter = splitFiltersValidation ? splitFiltersValidation.groupedFilters.bySet : [];
17
- return _this;
18
- }
19
- SplitsCacheInMemory.prototype.clear = function () {
20
- this.splitsCache = {};
21
- this.ttCache = {};
22
- this.changeNumber = -1;
23
- this.segmentsCount = 0;
24
- this.flagSetsCache = {};
25
- };
26
- SplitsCacheInMemory.prototype.addSplit = function (split) {
27
- var name = split.name;
28
- var previousSplit = this.getSplit(name);
29
- if (previousSplit) { // We had this Split already
30
- var previousTtName = previousSplit.trafficTypeName;
31
- this.ttCache[previousTtName]--;
32
- if (!this.ttCache[previousTtName])
33
- delete this.ttCache[previousTtName];
34
- this.removeFromFlagSets(previousSplit.name, previousSplit.sets);
35
- // Subtract from segments count for the previous version of this Split
36
- if (usesSegments(previousSplit))
37
- this.segmentsCount--;
38
- }
39
- // Store the Split.
40
- this.splitsCache[name] = split;
41
- // Update TT cache
42
- var ttName = split.trafficTypeName;
43
- this.ttCache[ttName] = (this.ttCache[ttName] || 0) + 1;
44
- this.addToFlagSets(split);
45
- // Add to segments count for the new version of the Split
46
- if (usesSegments(split))
47
- this.segmentsCount++;
48
- return true;
49
- };
50
- SplitsCacheInMemory.prototype.removeSplit = function (name) {
51
- var split = this.getSplit(name);
52
- if (!split)
53
- return false;
54
- // Delete the Split
55
- delete this.splitsCache[name];
56
- var ttName = split.trafficTypeName;
57
- this.ttCache[ttName]--; // Update tt cache
58
- if (!this.ttCache[ttName])
59
- delete this.ttCache[ttName];
60
- this.removeFromFlagSets(split.name, split.sets);
61
- // Update the segments count.
62
- if (usesSegments(split))
63
- this.segmentsCount--;
64
- return true;
65
- };
66
- SplitsCacheInMemory.prototype.getSplit = function (name) {
67
- return this.splitsCache[name] || null;
68
- };
69
- SplitsCacheInMemory.prototype.setChangeNumber = function (changeNumber) {
70
- this.changeNumber = changeNumber;
71
- return true;
72
- };
73
- SplitsCacheInMemory.prototype.getChangeNumber = function () {
74
- return this.changeNumber;
75
- };
76
- SplitsCacheInMemory.prototype.getSplitNames = function () {
77
- return Object.keys(this.splitsCache);
78
- };
79
- SplitsCacheInMemory.prototype.trafficTypeExists = function (trafficType) {
80
- return isFiniteNumber(this.ttCache[trafficType]) && this.ttCache[trafficType] > 0;
81
- };
82
- SplitsCacheInMemory.prototype.usesSegments = function () {
83
- return this.getChangeNumber() === -1 || this.segmentsCount > 0;
84
- };
85
- SplitsCacheInMemory.prototype.getNamesByFlagSets = function (flagSets) {
86
- var _this = this;
87
- return flagSets.map(function (flagSet) { return _this.flagSetsCache[flagSet] || new Set(); });
88
- };
89
- SplitsCacheInMemory.prototype.addToFlagSets = function (featureFlag) {
90
- var _this = this;
91
- if (!featureFlag.sets)
92
- return;
93
- featureFlag.sets.forEach(function (featureFlagSet) {
94
- if (_this.flagSetsFilter.length > 0 && !_this.flagSetsFilter.some(function (filterFlagSet) { return filterFlagSet === featureFlagSet; }))
95
- return;
96
- if (!_this.flagSetsCache[featureFlagSet])
97
- _this.flagSetsCache[featureFlagSet] = new Set([]);
98
- _this.flagSetsCache[featureFlagSet].add(featureFlag.name);
99
- });
100
- };
101
- SplitsCacheInMemory.prototype.removeFromFlagSets = function (featureFlagName, flagSets) {
102
- var _this = this;
103
- if (!flagSets)
104
- return;
105
- flagSets.forEach(function (flagSet) {
106
- _this.removeNames(flagSet, featureFlagName);
107
- });
108
- };
109
- SplitsCacheInMemory.prototype.removeNames = function (flagSetName, featureFlagName) {
110
- if (!this.flagSetsCache[flagSetName])
111
- return;
112
- this.flagSetsCache[flagSetName].delete(featureFlagName);
113
- if (this.flagSetsCache[flagSetName].size === 0)
114
- delete this.flagSetsCache[flagSetName];
115
- };
116
- return SplitsCacheInMemory;
117
- }(AbstractSplitsCacheSync));
118
- export { SplitsCacheInMemory };
@@ -1,240 +0,0 @@
1
- import { __extends, __spreadArray } from "tslib";
2
- import { isFiniteNumber, isNaNNumber } from '../../utils/lang';
3
- import { LOG_PREFIX } from './constants';
4
- import { AbstractSplitsCacheAsync } from '../AbstractSplitsCacheAsync';
5
- import { returnDifference } from '../../utils/lang/sets';
6
- /**
7
- * Discard errors for an answer of multiple operations.
8
- */
9
- function processPipelineAnswer(results) {
10
- return results ? results.reduce(function (accum, errValuePair) {
11
- if (errValuePair[0] === null)
12
- accum.push(errValuePair[1]);
13
- return accum;
14
- }, []) : [];
15
- }
16
- /**
17
- * ISplitsCacheAsync implementation that stores split definitions in Redis.
18
- * Supported by Node.js
19
- */
20
- var SplitsCacheInRedis = /** @class */ (function (_super) {
21
- __extends(SplitsCacheInRedis, _super);
22
- function SplitsCacheInRedis(log, keys, redis, splitFiltersValidation) {
23
- var _this = _super.call(this) || this;
24
- _this.log = log;
25
- _this.redis = redis;
26
- _this.keys = keys;
27
- _this.flagSetsFilter = splitFiltersValidation ? splitFiltersValidation.groupedFilters.bySet : [];
28
- // There is no need to listen for redis 'error' event, because in that case ioredis calls will be rejected and handled by redis storage adapters.
29
- // But it is done just to avoid getting the ioredis message `Unhandled error event`.
30
- _this.redis.on('error', function (e) {
31
- _this.redisError = e;
32
- });
33
- _this.redis.on('connect', function () {
34
- _this.redisError = undefined;
35
- });
36
- return _this;
37
- }
38
- SplitsCacheInRedis.prototype._decrementCounts = function (split) {
39
- var _this = this;
40
- var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
41
- return this.redis.decr(ttKey).then(function (count) {
42
- if (count === 0)
43
- return _this.redis.del(ttKey);
44
- });
45
- };
46
- SplitsCacheInRedis.prototype._incrementCounts = function (split) {
47
- var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
48
- return this.redis.incr(ttKey);
49
- };
50
- SplitsCacheInRedis.prototype._updateFlagSets = function (featureFlagName, flagSetsOfRemovedFlag, flagSetsOfAddedFlag) {
51
- var _this = this;
52
- var removeFromFlagSets = returnDifference(flagSetsOfRemovedFlag, flagSetsOfAddedFlag);
53
- var addToFlagSets = returnDifference(flagSetsOfAddedFlag, flagSetsOfRemovedFlag);
54
- if (this.flagSetsFilter.length > 0) {
55
- addToFlagSets = addToFlagSets.filter(function (flagSet) {
56
- return _this.flagSetsFilter.some(function (filterFlagSet) { return filterFlagSet === flagSet; });
57
- });
58
- }
59
- var items = [featureFlagName];
60
- return Promise.all(__spreadArray(__spreadArray([], removeFromFlagSets.map(function (flagSetName) { return _this.redis.srem(_this.keys.buildFlagSetKey(flagSetName), items); }), true), addToFlagSets.map(function (flagSetName) { return _this.redis.sadd(_this.keys.buildFlagSetKey(flagSetName), items); }), true));
61
- };
62
- /**
63
- * Add a given split.
64
- * The returned promise is resolved when the operation success
65
- * or rejected if it fails (e.g., redis operation fails)
66
- */
67
- SplitsCacheInRedis.prototype.addSplit = function (split) {
68
- var _this = this;
69
- var name = split.name;
70
- var splitKey = this.keys.buildSplitKey(name);
71
- return this.redis.get(splitKey).then(function (splitFromStorage) {
72
- // handling parsing error
73
- var parsedPreviousSplit, stringifiedNewSplit;
74
- try {
75
- parsedPreviousSplit = splitFromStorage ? JSON.parse(splitFromStorage) : undefined;
76
- stringifiedNewSplit = JSON.stringify(split);
77
- }
78
- catch (e) {
79
- throw new Error('Error parsing feature flag definition: ' + e);
80
- }
81
- return _this.redis.set(splitKey, stringifiedNewSplit).then(function () {
82
- // avoid unnecessary increment/decrement operations
83
- if (parsedPreviousSplit && parsedPreviousSplit.trafficTypeName === split.trafficTypeName)
84
- return;
85
- // update traffic type counts
86
- return _this._incrementCounts(split).then(function () {
87
- if (parsedPreviousSplit)
88
- return _this._decrementCounts(parsedPreviousSplit);
89
- });
90
- }).then(function () { return _this._updateFlagSets(name, parsedPreviousSplit && parsedPreviousSplit.sets, split.sets); });
91
- }).then(function () { return true; });
92
- };
93
- /**
94
- * Remove a given split.
95
- * The returned promise is resolved when the operation success, with true or false indicating if the split existed (and was removed) or not.
96
- * or rejected if it fails (e.g., redis operation fails).
97
- */
98
- SplitsCacheInRedis.prototype.removeSplit = function (name) {
99
- var _this = this;
100
- return this.getSplit(name).then(function (split) {
101
- if (split) {
102
- return _this._decrementCounts(split).then(function () { return _this._updateFlagSets(name, split.sets); });
103
- }
104
- }).then(function () {
105
- return _this.redis.del(_this.keys.buildSplitKey(name)).then(function (status) { return status === 1; });
106
- });
107
- };
108
- /**
109
- * Get split definition or null if it's not defined.
110
- * Returned promise is rejected if redis operation fails.
111
- */
112
- SplitsCacheInRedis.prototype.getSplit = function (name) {
113
- if (this.redisError) {
114
- this.log.error(LOG_PREFIX + this.redisError);
115
- return Promise.reject(this.redisError);
116
- }
117
- return this.redis.get(this.keys.buildSplitKey(name))
118
- .then(function (maybeSplit) { return maybeSplit && JSON.parse(maybeSplit); });
119
- };
120
- /**
121
- * Set till number.
122
- * The returned promise is resolved when the operation success,
123
- * or rejected if it fails.
124
- */
125
- SplitsCacheInRedis.prototype.setChangeNumber = function (changeNumber) {
126
- return this.redis.set(this.keys.buildSplitsTillKey(), changeNumber + '').then(function (status) { return status === 'OK'; });
127
- };
128
- /**
129
- * Get till number or -1 if it's not defined.
130
- * The returned promise is resolved with the changeNumber or -1 if it doesn't exist or a redis operation fails.
131
- * The promise will never be rejected.
132
- */
133
- SplitsCacheInRedis.prototype.getChangeNumber = function () {
134
- var _this = this;
135
- return this.redis.get(this.keys.buildSplitsTillKey()).then(function (value) {
136
- var i = parseInt(value, 10);
137
- return isNaNNumber(i) ? -1 : i;
138
- }).catch(function (e) {
139
- _this.log.error(LOG_PREFIX + 'Could not retrieve changeNumber from storage. Error: ' + e);
140
- return -1;
141
- });
142
- };
143
- /**
144
- * Get list of all split definitions.
145
- * The returned promise is resolved with the list of split definitions,
146
- * or rejected if redis operation fails.
147
- */
148
- // @TODO we need to benchmark which is the maximun number of commands we could pipeline without kill redis performance.
149
- SplitsCacheInRedis.prototype.getAll = function () {
150
- var _this = this;
151
- return this.redis.keys(this.keys.searchPatternForSplitKeys())
152
- .then(function (listOfKeys) { return _this.redis.pipeline(listOfKeys.map(function (k) { return ['get', k]; })).exec(); })
153
- .then(processPipelineAnswer)
154
- .then(function (splitDefinitions) { return splitDefinitions.map(function (splitDefinition) {
155
- return JSON.parse(splitDefinition);
156
- }); });
157
- };
158
- /**
159
- * Get list of split names.
160
- * The returned promise is resolved with the list of split names,
161
- * or rejected if redis operation fails.
162
- */
163
- SplitsCacheInRedis.prototype.getSplitNames = function () {
164
- var _this = this;
165
- return this.redis.keys(this.keys.searchPatternForSplitKeys()).then(function (listOfKeys) { return listOfKeys.map(_this.keys.extractKey); });
166
- };
167
- /**
168
- * Get list of feature flag names related to a given list of flag set names.
169
- * The returned promise is resolved with the list of feature flag names per flag set,
170
- * or rejected if the pipelined redis operation fails (e.g., timeout).
171
- */
172
- SplitsCacheInRedis.prototype.getNamesByFlagSets = function (flagSets) {
173
- var _this = this;
174
- return this.redis.pipeline(flagSets.map(function (flagSet) { return ['smembers', _this.keys.buildFlagSetKey(flagSet)]; })).exec()
175
- .then(function (results) { return results ? results.map(function (_a, index) {
176
- var e = _a[0], value = _a[1];
177
- if (e === null)
178
- return value;
179
- _this.log.error(LOG_PREFIX + ("Could not read result from get members of flag set " + flagSets[index] + " due to an error: " + e));
180
- }) : []; })
181
- .then(function (namesByFlagSets) { return namesByFlagSets.map(function (namesByFlagSet) { return new Set(namesByFlagSet); }); });
182
- };
183
- /**
184
- * Check traffic type existence.
185
- * The returned promise is resolved with a boolean indicating whether the TT exist or not.
186
- * In case of redis operation failure, the promise resolves with a true value, assuming that the TT might exist.
187
- * It will never be rejected.
188
- */
189
- SplitsCacheInRedis.prototype.trafficTypeExists = function (trafficType) {
190
- var _this = this;
191
- // If there is a number there should be > 0, otherwise the TT is considered as not existent.
192
- return this.redis.get(this.keys.buildTrafficTypeKey(trafficType))
193
- .then(function (ttCount) {
194
- if (ttCount === null)
195
- return false; // if entry doesn't exist, means that TT doesn't exist
196
- ttCount = parseInt(ttCount, 10);
197
- if (!isFiniteNumber(ttCount) || ttCount < 0) {
198
- _this.log.info(LOG_PREFIX + ("Could not validate traffic type existence of " + trafficType + " due to data corruption of some sorts."));
199
- return false;
200
- }
201
- return ttCount > 0;
202
- })
203
- .catch(function (e) {
204
- _this.log.error(LOG_PREFIX + ("Could not validate traffic type existence of " + trafficType + " due to an error: " + e + "."));
205
- // If there is an error, bypass the validation so the event can get tracked.
206
- return true;
207
- });
208
- };
209
- // @TODO remove or implement. It is not being used.
210
- SplitsCacheInRedis.prototype.clear = function () {
211
- return Promise.resolve();
212
- };
213
- /**
214
- * Fetches multiple splits definitions.
215
- * Returned promise is rejected if redis operation fails.
216
- */
217
- SplitsCacheInRedis.prototype.getSplits = function (names) {
218
- var _a;
219
- var _this = this;
220
- if (this.redisError) {
221
- this.log.error(LOG_PREFIX + this.redisError);
222
- return Promise.reject(this.redisError);
223
- }
224
- var keys = names.map(function (name) { return _this.keys.buildSplitKey(name); });
225
- return (_a = this.redis).mget.apply(_a, keys).then(function (splitDefinitions) {
226
- var splits = {};
227
- names.forEach(function (name, idx) {
228
- var split = splitDefinitions[idx];
229
- splits[name] = split && JSON.parse(split);
230
- });
231
- return Promise.resolve(splits);
232
- })
233
- .catch(function (e) {
234
- _this.log.error(LOG_PREFIX + ("Could not grab feature flags due to an error: " + e + "."));
235
- return Promise.reject(e);
236
- });
237
- };
238
- return SplitsCacheInRedis;
239
- }(AbstractSplitsCacheAsync));
240
- export { SplitsCacheInRedis };
@@ -1,209 +0,0 @@
1
- import { __extends, __spreadArray } from "tslib";
2
- import { isFiniteNumber, isNaNNumber } from '../../utils/lang';
3
- import { LOG_PREFIX } from './constants';
4
- import { AbstractSplitsCacheAsync } from '../AbstractSplitsCacheAsync';
5
- import { returnDifference } from '../../utils/lang/sets';
6
- /**
7
- * ISplitsCacheAsync implementation for pluggable storages.
8
- */
9
- var SplitsCachePluggable = /** @class */ (function (_super) {
10
- __extends(SplitsCachePluggable, _super);
11
- /**
12
- * Create a SplitsCache that uses a storage wrapper.
13
- * @param log - Logger instance.
14
- * @param keys - Key builder.
15
- * @param wrapper - Adapted wrapper storage.
16
- */
17
- function SplitsCachePluggable(log, keys, wrapper, splitFiltersValidation) {
18
- var _this = _super.call(this) || this;
19
- _this.log = log;
20
- _this.keys = keys;
21
- _this.wrapper = wrapper;
22
- _this.flagSetsFilter = splitFiltersValidation ? splitFiltersValidation.groupedFilters.bySet : [];
23
- return _this;
24
- }
25
- SplitsCachePluggable.prototype._decrementCounts = function (split) {
26
- var _this = this;
27
- var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
28
- return this.wrapper.decr(ttKey).then(function (count) {
29
- if (count === 0)
30
- return _this.wrapper.del(ttKey);
31
- });
32
- };
33
- SplitsCachePluggable.prototype._incrementCounts = function (split) {
34
- var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
35
- return this.wrapper.incr(ttKey);
36
- };
37
- SplitsCachePluggable.prototype._updateFlagSets = function (featureFlagName, flagSetsOfRemovedFlag, flagSetsOfAddedFlag) {
38
- var _this = this;
39
- var removeFromFlagSets = returnDifference(flagSetsOfRemovedFlag, flagSetsOfAddedFlag);
40
- var addToFlagSets = returnDifference(flagSetsOfAddedFlag, flagSetsOfRemovedFlag);
41
- if (this.flagSetsFilter.length > 0) {
42
- addToFlagSets = addToFlagSets.filter(function (flagSet) {
43
- return _this.flagSetsFilter.some(function (filterFlagSet) { return filterFlagSet === flagSet; });
44
- });
45
- }
46
- var items = [featureFlagName];
47
- return Promise.all(__spreadArray(__spreadArray([], removeFromFlagSets.map(function (flagSetName) { return _this.wrapper.removeItems(_this.keys.buildFlagSetKey(flagSetName), items); }), true), addToFlagSets.map(function (flagSetName) { return _this.wrapper.addItems(_this.keys.buildFlagSetKey(flagSetName), items); }), true));
48
- };
49
- /**
50
- * Add a given split.
51
- * The returned promise is resolved when the operation success
52
- * or rejected if it fails (e.g., wrapper operation fails)
53
- */
54
- SplitsCachePluggable.prototype.addSplit = function (split) {
55
- var _this = this;
56
- var name = split.name;
57
- var splitKey = this.keys.buildSplitKey(name);
58
- return this.wrapper.get(splitKey).then(function (splitFromStorage) {
59
- // handling parsing error
60
- var parsedPreviousSplit, stringifiedNewSplit;
61
- try {
62
- parsedPreviousSplit = splitFromStorage ? JSON.parse(splitFromStorage) : undefined;
63
- stringifiedNewSplit = JSON.stringify(split);
64
- }
65
- catch (e) {
66
- throw new Error('Error parsing feature flag definition: ' + e);
67
- }
68
- return _this.wrapper.set(splitKey, stringifiedNewSplit).then(function () {
69
- // avoid unnecessary increment/decrement operations
70
- if (parsedPreviousSplit && parsedPreviousSplit.trafficTypeName === split.trafficTypeName)
71
- return;
72
- // update traffic type counts
73
- return _this._incrementCounts(split).then(function () {
74
- if (parsedPreviousSplit)
75
- return _this._decrementCounts(parsedPreviousSplit);
76
- });
77
- }).then(function () { return _this._updateFlagSets(name, parsedPreviousSplit && parsedPreviousSplit.sets, split.sets); });
78
- }).then(function () { return true; });
79
- };
80
- /**
81
- * Remove a given split.
82
- * The returned promise is resolved when the operation success, with a boolean indicating if the split existed or not.
83
- * or rejected if it fails (e.g., wrapper operation fails).
84
- */
85
- SplitsCachePluggable.prototype.removeSplit = function (name) {
86
- var _this = this;
87
- return this.getSplit(name).then(function (split) {
88
- if (split) {
89
- return _this._decrementCounts(split).then(function () { return _this._updateFlagSets(name, split.sets); });
90
- }
91
- }).then(function () {
92
- return _this.wrapper.del(_this.keys.buildSplitKey(name));
93
- });
94
- };
95
- /**
96
- * Get split.
97
- * The returned promise is resolved with the split definition or null if it's not defined,
98
- * or rejected if wrapper operation fails.
99
- */
100
- SplitsCachePluggable.prototype.getSplit = function (name) {
101
- return this.wrapper.get(this.keys.buildSplitKey(name))
102
- .then(function (maybeSplit) { return maybeSplit && JSON.parse(maybeSplit); });
103
- };
104
- /**
105
- * Get list of splits.
106
- * The returned promise is resolved with a map of split names to their split definition or null if it's not defined,
107
- * or rejected if wrapper operation fails.
108
- */
109
- SplitsCachePluggable.prototype.getSplits = function (names) {
110
- var _this = this;
111
- var keys = names.map(function (name) { return _this.keys.buildSplitKey(name); });
112
- return this.wrapper.getMany(keys).then(function (splitDefinitions) {
113
- var splits = {};
114
- names.forEach(function (name, idx) {
115
- var split = splitDefinitions[idx];
116
- splits[name] = split && JSON.parse(split);
117
- });
118
- return Promise.resolve(splits);
119
- });
120
- };
121
- /**
122
- * Get list of all split definitions.
123
- * The returned promise is resolved with the list of split definitions,
124
- * or rejected if wrapper operation fails.
125
- */
126
- SplitsCachePluggable.prototype.getAll = function () {
127
- var _this = this;
128
- return this.wrapper.getKeysByPrefix(this.keys.buildSplitKeyPrefix())
129
- .then(function (listOfKeys) { return _this.wrapper.getMany(listOfKeys); })
130
- .then(function (splitDefinitions) { return splitDefinitions.map(function (splitDefinition) {
131
- return JSON.parse(splitDefinition);
132
- }); });
133
- };
134
- /**
135
- * Get list of split names.
136
- * The returned promise is resolved with the list of split names,
137
- * or rejected if wrapper operation fails.
138
- */
139
- SplitsCachePluggable.prototype.getSplitNames = function () {
140
- var _this = this;
141
- return this.wrapper.getKeysByPrefix(this.keys.buildSplitKeyPrefix()).then(function (listOfKeys) { return listOfKeys.map(_this.keys.extractKey); });
142
- };
143
- /**
144
- * Get list of feature flag names related to a given list of flag set names.
145
- * The returned promise is resolved with the list of feature flag names per flag set.
146
- * It never rejects (If there is a wrapper error for some flag set, an empty set is returned for it).
147
- */
148
- SplitsCachePluggable.prototype.getNamesByFlagSets = function (flagSets) {
149
- var _this = this;
150
- return Promise.all(flagSets.map(function (flagSet) {
151
- var flagSetKey = _this.keys.buildFlagSetKey(flagSet);
152
- return _this.wrapper.getItems(flagSetKey).catch(function () { return []; });
153
- })).then(function (namesByFlagSets) { return namesByFlagSets.map(function (namesByFlagSet) { return new Set(namesByFlagSet); }); });
154
- };
155
- /**
156
- * Check traffic type existence.
157
- * The returned promise is resolved with a boolean indicating whether the TT exist or not.
158
- * In case of wrapper operation failures, the promise resolves with a true value, assuming that the TT might exist.
159
- * It will never be rejected.
160
- */
161
- SplitsCachePluggable.prototype.trafficTypeExists = function (trafficType) {
162
- var _this = this;
163
- // If there is a number there should be > 0, otherwise the TT is considered as not existent.
164
- return this.wrapper.get(this.keys.buildTrafficTypeKey(trafficType))
165
- .then(function (ttCount) {
166
- if (ttCount === null)
167
- return false; // if entry doesn't exist, means that TT doesn't exist
168
- ttCount = parseInt(ttCount, 10);
169
- if (!isFiniteNumber(ttCount) || ttCount < 0) {
170
- _this.log.info(LOG_PREFIX + ("Could not validate traffic type existence of " + trafficType + " due to data corruption of some sorts."));
171
- return false;
172
- }
173
- return ttCount > 0;
174
- }).catch(function (e) {
175
- _this.log.error(LOG_PREFIX + ("Could not validate traffic type existence of " + trafficType + " due to an error: " + e + "."));
176
- // If there is an error, bypass the validation so the event can get tracked.
177
- return true;
178
- });
179
- };
180
- /**
181
- * Set till number.
182
- * The returned promise is resolved when the operation success,
183
- * or rejected if it fails (e.g., wrapper operation fails).
184
- */
185
- SplitsCachePluggable.prototype.setChangeNumber = function (changeNumber) {
186
- return this.wrapper.set(this.keys.buildSplitsTillKey(), changeNumber + '');
187
- };
188
- /**
189
- * Get till number or -1 if it's not defined.
190
- * The returned promise is resolved with the changeNumber or -1 if it doesn't exist or a wrapper operation fails.
191
- * The promise will never be rejected.
192
- */
193
- SplitsCachePluggable.prototype.getChangeNumber = function () {
194
- var _this = this;
195
- return this.wrapper.get(this.keys.buildSplitsTillKey()).then(function (value) {
196
- var i = parseInt(value, 10);
197
- return isNaNNumber(i) ? -1 : i;
198
- }).catch(function (e) {
199
- _this.log.error(LOG_PREFIX + 'Could not retrieve changeNumber from storage. Error: ' + e);
200
- return -1;
201
- });
202
- };
203
- // @TODO implement if required by DataLoader or producer mode
204
- SplitsCachePluggable.prototype.clear = function () {
205
- return Promise.resolve(true);
206
- };
207
- return SplitsCachePluggable;
208
- }(AbstractSplitsCacheAsync));
209
- export { SplitsCachePluggable };
@@ -1,9 +0,0 @@
1
- import { syncTaskFactory } from '../../syncTask';
2
- import { splitChangesFetcherFactory } from '../fetchers/splitChangesFetcher';
3
- import { splitChangesUpdaterFactory } from '../updaters/splitChangesUpdater';
4
- /**
5
- * Creates a sync task that periodically executes a `splitChangesUpdater` task
6
- */
7
- export function splitsSyncTaskFactory(fetchSplitChanges, storage, readiness, settings, isClientSide) {
8
- return syncTaskFactory(settings.log, splitChangesUpdaterFactory(settings.log, splitChangesFetcherFactory(fetchSplitChanges, settings, storage), storage, settings.sync.__splitFiltersValidation, readiness.splits, settings.startup.requestTimeoutBeforeReady, settings.startup.retriesOnFailureBeforeReady, isClientSide), settings.scheduler.featuresRefreshRate, 'splitChangesUpdater');
9
- }