@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,192 +0,0 @@
1
- import { timeout } from '../../../utils/promise/timeout';
2
- import { SDK_SPLITS_ARRIVED, FLAGS_UPDATE, SEGMENTS_UPDATE } from '../../../readiness/constants';
3
- import { SYNC_SPLITS_FETCH, SYNC_SPLITS_UPDATE, SYNC_RBS_UPDATE, SYNC_SPLITS_FETCH_FAILS, SYNC_SPLITS_FETCH_RETRY } from '../../../logger/constants';
4
- import { startsWith } from '../../../utils/lang';
5
- import { IN_RULE_BASED_SEGMENT, IN_SEGMENT, RULE_BASED_SEGMENT, STANDARD_SEGMENT } from '../../../utils/constants';
6
- import { setToArray } from '../../../utils/lang/sets';
7
- import { SPLIT_UPDATE } from '../../streaming/constants';
8
- // Checks that all registered segments have been fetched (changeNumber !== -1 for every segment).
9
- // Returns a promise that could be rejected.
10
- // @TODO review together with Segments and MySegments storage APIs
11
- function checkAllSegmentsExist(segments) {
12
- var registeredSegments = Promise.resolve(segments.getRegisteredSegments());
13
- return registeredSegments.then(function (segmentNames) {
14
- return Promise.all(segmentNames.map(function (segmentName) { return segments.getChangeNumber(segmentName); }))
15
- .then(function (changeNumbers) { return changeNumbers.every(function (changeNumber) { return changeNumber !== undefined; }); });
16
- });
17
- }
18
- /**
19
- * Collect segments from a raw FF or RBS definition.
20
- * Exported for testing purposes.
21
- */
22
- export function parseSegments(ruleEntity, matcherType) {
23
- if (matcherType === void 0) { matcherType = IN_SEGMENT; }
24
- var _a = ruleEntity, _b = _a.conditions, conditions = _b === void 0 ? [] : _b, excluded = _a.excluded;
25
- var segments = new Set();
26
- if (excluded && excluded.segments) {
27
- excluded.segments.forEach(function (_a) {
28
- var type = _a.type, name = _a.name;
29
- if ((type === STANDARD_SEGMENT && matcherType === IN_SEGMENT) || (type === RULE_BASED_SEGMENT && matcherType === IN_RULE_BASED_SEGMENT)) {
30
- segments.add(name);
31
- }
32
- });
33
- }
34
- for (var i = 0; i < conditions.length; i++) {
35
- var matchers = conditions[i].matcherGroup.matchers;
36
- matchers.forEach(function (matcher) {
37
- if (matcher.matcherType === matcherType)
38
- segments.add(matcher.userDefinedSegmentMatcherData.segmentName);
39
- });
40
- }
41
- return segments;
42
- }
43
- /**
44
- * If there are defined filters and one feature flag doesn't match with them, its status is changed to 'ARCHIVE' to avoid storing it
45
- * If there is `bySet` filter, `byName` and `byPrefix` filters are ignored
46
- *
47
- * @param featureFlag - feature flag to be evaluated
48
- * @param filters - splitFiltersValidation bySet | byName
49
- */
50
- function matchFilters(featureFlag, filters) {
51
- var _a = filters.groupedFilters, setsFilter = _a.bySet, namesFilter = _a.byName, prefixFilter = _a.byPrefix;
52
- if (setsFilter.length > 0)
53
- return featureFlag.sets && featureFlag.sets.some(function (featureFlagSet) { return setsFilter.indexOf(featureFlagSet) > -1; });
54
- var namesFilterConfigured = namesFilter.length > 0;
55
- var prefixFilterConfigured = prefixFilter.length > 0;
56
- if (!namesFilterConfigured && !prefixFilterConfigured)
57
- return true;
58
- var matchNames = namesFilterConfigured && namesFilter.indexOf(featureFlag.name) > -1;
59
- var matchPrefix = prefixFilterConfigured && prefixFilter.some(function (prefix) { return startsWith(featureFlag.name, prefix); });
60
- return matchNames || matchPrefix;
61
- }
62
- /**
63
- * Given the list of splits from /splitChanges endpoint, it returns the mutations,
64
- * i.e., an object with added splits, removed splits and used segments.
65
- * Exported for testing purposes.
66
- */
67
- export function computeMutation(rules, segments, filters) {
68
- return rules.reduce(function (accum, ruleEntity) {
69
- if (ruleEntity.status === 'ACTIVE' && (!filters || matchFilters(ruleEntity, filters))) {
70
- accum.added.push(ruleEntity);
71
- parseSegments(ruleEntity).forEach(function (segmentName) {
72
- segments.add(segmentName);
73
- });
74
- }
75
- else {
76
- accum.removed.push(ruleEntity);
77
- }
78
- accum.names.push(ruleEntity.name);
79
- return accum;
80
- }, { added: [], removed: [], names: [] });
81
- }
82
- /**
83
- * factory of SplitChanges updater, a task that:
84
- * - fetches split changes using `splitChangesFetcher`
85
- * - updates `splitsCache`
86
- * - uses `splitsEventEmitter` to emit events related to split data updates
87
- *
88
- * @param log - Logger instance
89
- * @param splitChangesFetcher - Fetcher of `/splitChanges`
90
- * @param splits - Splits storage, with sync or async methods
91
- * @param segments - Segments storage, with sync or async methods
92
- * @param splitsEventEmitter - Optional readiness manager. Not required for synchronizer or producer mode.
93
- * @param requestTimeoutBeforeReady - How long the updater will wait for the request to timeout. Default 0, i.e., never timeout.
94
- * @param retriesOnFailureBeforeReady - How many retries on `/splitChanges` we the updater do in case of failure or timeout. Default 0, i.e., no retries.
95
- */
96
- export function splitChangesUpdaterFactory(log, splitChangesFetcher, storage, splitFiltersValidation, splitsEventEmitter, requestTimeoutBeforeReady, retriesOnFailureBeforeReady, isClientSide) {
97
- if (requestTimeoutBeforeReady === void 0) { requestTimeoutBeforeReady = 0; }
98
- if (retriesOnFailureBeforeReady === void 0) { retriesOnFailureBeforeReady = 0; }
99
- var splits = storage.splits, rbSegments = storage.rbSegments, segments = storage.segments;
100
- var startingUp = true;
101
- /** timeout decorator for `splitChangesFetcher` promise */
102
- function _promiseDecorator(promise) {
103
- if (startingUp && requestTimeoutBeforeReady)
104
- promise = timeout(requestTimeoutBeforeReady, promise);
105
- return promise;
106
- }
107
- /**
108
- * SplitChanges updater returns a promise that resolves with a `false` boolean value if it fails to fetch splits or synchronize them with the storage.
109
- * Returned promise will not be rejected.
110
- *
111
- * @param noCache - true to revalidate data to fetch
112
- * @param till - query param to bypass CDN requests
113
- */
114
- return function splitChangesUpdater(noCache, till, instantUpdate) {
115
- /**
116
- * @param since - current changeNumber at splitsCache
117
- * @param retry - current number of retry attempts
118
- */
119
- function _splitChangesUpdater(sinces, retry) {
120
- if (retry === void 0) { retry = 0; }
121
- var since = sinces[0], rbSince = sinces[1];
122
- log.debug(SYNC_SPLITS_FETCH, sinces);
123
- return Promise.resolve(instantUpdate ?
124
- instantUpdate.type === SPLIT_UPDATE ?
125
- // IFFU edge case: a change to a flag that adds an IN_RULE_BASED_SEGMENT matcher that is not present yet
126
- Promise.resolve(rbSegments.contains(parseSegments(instantUpdate.payload, IN_RULE_BASED_SEGMENT))).then(function (contains) {
127
- return contains ?
128
- { ff: { d: [instantUpdate.payload], t: instantUpdate.changeNumber } } :
129
- splitChangesFetcher(since, noCache, till, rbSince, _promiseDecorator);
130
- }) :
131
- { rbs: { d: [instantUpdate.payload], t: instantUpdate.changeNumber } } :
132
- splitChangesFetcher(since, noCache, till, rbSince, _promiseDecorator))
133
- .then(function (splitChanges) {
134
- var usedSegments = new Set();
135
- var updatedFlags = [];
136
- var ffUpdate = false;
137
- if (splitChanges.ff) {
138
- var _a = computeMutation(splitChanges.ff.d, usedSegments, splitFiltersValidation), added = _a.added, removed = _a.removed, names = _a.names;
139
- updatedFlags = names;
140
- log.debug(SYNC_SPLITS_UPDATE, [added.length, removed.length]);
141
- ffUpdate = splits.update(added, removed, splitChanges.ff.t);
142
- }
143
- var rbsUpdate = false;
144
- if (splitChanges.rbs) {
145
- var _b = computeMutation(splitChanges.rbs.d, usedSegments), added = _b.added, removed = _b.removed;
146
- log.debug(SYNC_RBS_UPDATE, [added.length, removed.length]);
147
- rbsUpdate = rbSegments.update(added, removed, splitChanges.rbs.t);
148
- }
149
- return Promise.all([ffUpdate, rbsUpdate,
150
- // @TODO if at least 1 segment fetch fails due to 404 and other segments are updated in the storage, SDK_UPDATE is not emitted
151
- segments.registerSegments(setToArray(usedSegments))
152
- ]).then(function (_a) {
153
- var ffChanged = _a[0], rbsChanged = _a[1];
154
- if (storage.save)
155
- storage.save();
156
- startingUp = false;
157
- if (splitsEventEmitter) {
158
- // To emit SDK_SPLITS_ARRIVED for server-side SDK, we must check that all registered segments have been fetched
159
- return Promise.resolve(!splitsEventEmitter.splitsArrived || ((ffChanged || rbsChanged) && (isClientSide || checkAllSegmentsExist(segments))))
160
- .catch(function () { return false; } /** noop. just to handle a possible `checkAllSegmentsExist` rejection, before emitting SDK event */)
161
- .then(function (emitSplitsArrivedEvent) {
162
- // emit SDK events
163
- if (emitSplitsArrivedEvent) {
164
- var metadata = {
165
- type: updatedFlags.length > 0 ? FLAGS_UPDATE : SEGMENTS_UPDATE,
166
- names: updatedFlags.length > 0 ? updatedFlags : []
167
- };
168
- splitsEventEmitter.emit(SDK_SPLITS_ARRIVED, metadata);
169
- }
170
- return true;
171
- });
172
- }
173
- return true;
174
- });
175
- })
176
- .catch(function (error) {
177
- if (startingUp && retriesOnFailureBeforeReady > retry) {
178
- retry += 1;
179
- log.warn(SYNC_SPLITS_FETCH_RETRY, [retry, error]);
180
- return _splitChangesUpdater(sinces, retry);
181
- }
182
- else {
183
- startingUp = false;
184
- log.warn(SYNC_SPLITS_FETCH_FAILS, [error]);
185
- }
186
- return false;
187
- });
188
- }
189
- // `getChangeNumber` never rejects or throws error
190
- return Promise.all([splits.getChangeNumber(), rbSegments.getChangeNumber()]).then(_splitChangesUpdater);
191
- };
192
- }
@@ -1,15 +0,0 @@
1
- import { FALLBACK_SPLIT_NOT_FOUND, SPLIT_NOT_FOUND } from '../labels';
2
- import { WARN_NOT_EXISTENT_SPLIT } from '../../logger/constants';
3
- /**
4
- * This is defined here and in this format mostly because of the logger and the fact that it's considered a validation at product level.
5
- * But it's not going to run on the input validation layer. In any case, the most compelling reason to use it as we do is to avoid going to Redis and get a split twice.
6
- */
7
- export function validateSplitExistence(log, readinessManager, splitName, labelOrSplitObj, method) {
8
- if (readinessManager.isReady()) { // Only if it's ready (synced with BE) we validate this, otherwise it may just be that the SDK is still syncing
9
- if (labelOrSplitObj === SPLIT_NOT_FOUND || labelOrSplitObj === FALLBACK_SPLIT_NOT_FOUND || labelOrSplitObj == null) {
10
- log.warn(WARN_NOT_EXISTENT_SPLIT, [method, splitName]);
11
- return false;
12
- }
13
- }
14
- return true;
15
- }
@@ -1,21 +0,0 @@
1
- import { ERROR_EMPTY_ARRAY } from '../../logger/constants';
2
- import { uniq } from '../lang';
3
- import { validateSplit } from './split';
4
- export function validateSplits(log, maybeSplits, method, listName, item) {
5
- if (listName === void 0) { listName = 'feature flag names'; }
6
- if (item === void 0) { item = 'feature flag name'; }
7
- if (Array.isArray(maybeSplits) && maybeSplits.length > 0) {
8
- var validatedArray_1 = [];
9
- // Remove invalid values
10
- maybeSplits.forEach(function (maybeSplit) {
11
- var splitName = validateSplit(log, maybeSplit, method, item);
12
- if (splitName)
13
- validatedArray_1.push(splitName);
14
- });
15
- // Strip off duplicated values if we have valid split names then return
16
- if (validatedArray_1.length)
17
- return uniq(validatedArray_1);
18
- }
19
- log.error(ERROR_EMPTY_ARRAY, [method, listName]);
20
- return false;
21
- }
@@ -1,63 +0,0 @@
1
- import { ISplitsCacheAsync } from './types';
2
- import { ISplit } from '../dtos/types';
3
- import { objectAssign } from '../utils/lang/objectAssign';
4
-
5
- /**
6
- * This class provides a skeletal implementation of the ISplitsCacheAsync interface
7
- * to minimize the effort required to implement this interface.
8
- */
9
- export abstract class AbstractSplitsCacheAsync implements ISplitsCacheAsync {
10
-
11
- protected abstract addSplit(split: ISplit): Promise<boolean>
12
- protected abstract removeSplit(name: string): Promise<boolean>
13
- protected abstract setChangeNumber(changeNumber: number): Promise<boolean | void>
14
-
15
- update(toAdd: ISplit[], toRemove: ISplit[], changeNumber: number): Promise<boolean> {
16
- return Promise.all([
17
- this.setChangeNumber(changeNumber),
18
- Promise.all(toAdd.map(addedFF => this.addSplit(addedFF))),
19
- Promise.all(toRemove.map(removedFF => this.removeSplit(removedFF.name)))
20
- ]).then(([, added, removed]) => {
21
- return added.some(result => result) || removed.some(result => result);
22
- });
23
- }
24
-
25
- abstract getSplit(name: string): Promise<ISplit | null>
26
- abstract getSplits(names: string[]): Promise<Record<string, ISplit | null>>
27
- abstract getChangeNumber(): Promise<number>
28
- abstract getAll(): Promise<ISplit[]>
29
- abstract getSplitNames(): Promise<string[]>
30
- abstract getNamesByFlagSets(flagSets: string[]): Promise<Set<string>[]>
31
- abstract trafficTypeExists(trafficType: string): Promise<boolean>
32
- abstract clear(): Promise<boolean | void>
33
-
34
- // @TODO revisit segment-related methods ('usesSegments', 'getRegisteredSegments', 'registerSegments')
35
- // noop, just keeping the interface. This is used by standalone client-side API only, and so only implemented by InMemory and InLocalStorage.
36
- usesSegments(): Promise<boolean> {
37
- return Promise.resolve(true);
38
- }
39
-
40
- /**
41
- * Kill `name` split and set `defaultTreatment` and `changeNumber`.
42
- * Used for SPLIT_KILL push notifications.
43
- *
44
- * @returns a promise that is resolved once the split kill operation is performed. The fulfillment value is a boolean: `true` if the operation successed updating the split or `false` if no split is updated,
45
- * for instance, if the `changeNumber` is old, or if the split is not found (e.g., `/splitchanges` hasn't been fetched yet), or if the storage fails to apply the update.
46
- * The promise will never be rejected.
47
- */
48
- killLocally(name: string, defaultTreatment: string, changeNumber: number): Promise<boolean> {
49
- return this.getSplit(name).then(split => {
50
-
51
- if (split && (!split.changeNumber || split.changeNumber < changeNumber)) {
52
- const newSplit = objectAssign({}, split);
53
- newSplit.killed = true;
54
- newSplit.defaultTreatment = defaultTreatment;
55
- newSplit.changeNumber = changeNumber;
56
-
57
- return this.addSplit(newSplit);
58
- }
59
- return false;
60
- }).catch(() => false);
61
- }
62
-
63
- }
@@ -1,95 +0,0 @@
1
- import { ISplitsCacheSync, IStorageSync } from './types';
2
- import { IRBSegment, ISplit } from '../dtos/types';
3
- import { objectAssign } from '../utils/lang/objectAssign';
4
- import { IN_SEGMENT, IN_LARGE_SEGMENT } from '../utils/constants';
5
-
6
- /**
7
- * This class provides a skeletal implementation of the ISplitsCacheSync interface
8
- * to minimize the effort required to implement this interface.
9
- */
10
- export abstract class AbstractSplitsCacheSync implements ISplitsCacheSync {
11
-
12
- protected abstract addSplit(split: ISplit): boolean
13
- protected abstract removeSplit(name: string): boolean
14
- protected abstract setChangeNumber(changeNumber: number): boolean | void
15
-
16
- update(toAdd: ISplit[], toRemove: ISplit[], changeNumber: number): boolean {
17
- let updated = toAdd.map(addedFF => this.addSplit(addedFF)).some(result => result);
18
- updated = toRemove.map(removedFF => this.removeSplit(removedFF.name)).some(result => result) || updated;
19
- this.setChangeNumber(changeNumber);
20
- return updated;
21
- }
22
-
23
- abstract getSplit(name: string): ISplit | null
24
-
25
- getSplits(names: string[]): Record<string, ISplit | null> {
26
- const splits: Record<string, ISplit | null> = {};
27
- names.forEach(name => {
28
- splits[name] = this.getSplit(name);
29
- });
30
- return splits;
31
- }
32
-
33
- abstract getChangeNumber(): number
34
-
35
- getAll(): ISplit[] {
36
- return this.getSplitNames().map(key => this.getSplit(key) as ISplit);
37
- }
38
-
39
- abstract getSplitNames(): string[]
40
-
41
- abstract trafficTypeExists(trafficType: string): boolean
42
-
43
- abstract usesSegments(): boolean
44
-
45
- abstract clear(): void
46
-
47
- /**
48
- * Kill `name` split and set `defaultTreatment` and `changeNumber`.
49
- * Used for SPLIT_KILL push notifications.
50
- *
51
- * @returns `true` if the operation successed updating the split, or `false` if no split is updated,
52
- * for instance, if the `changeNumber` is old, or if the split is not found (e.g., `/splitchanges` hasn't been fetched yet), or if the storage fails to apply the update.
53
- */
54
- killLocally(name: string, defaultTreatment: string, changeNumber: number): boolean {
55
- const split = this.getSplit(name);
56
-
57
- if (split && (!split.changeNumber || split.changeNumber < changeNumber)) {
58
- const newSplit = objectAssign({}, split);
59
- newSplit.killed = true;
60
- newSplit.defaultTreatment = defaultTreatment;
61
- newSplit.changeNumber = changeNumber;
62
-
63
- return this.addSplit(newSplit);
64
- }
65
- return false;
66
- }
67
-
68
- abstract getNamesByFlagSets(flagSets: string[]): Set<string>[]
69
-
70
- }
71
-
72
- /**
73
- * Given a parsed split, it returns a boolean flagging if its conditions use segments matchers (rules & whitelists).
74
- * This util is intended to simplify the implementation of `splitsCache::usesSegments` method
75
- */
76
- export function usesSegments(ruleEntity: ISplit | IRBSegment) {
77
- const conditions = ruleEntity.conditions || [];
78
- for (let i = 0; i < conditions.length; i++) {
79
- const matchers = conditions[i].matcherGroup.matchers;
80
-
81
- for (let j = 0; j < matchers.length; j++) {
82
- const matcher = matchers[j].matcherType;
83
- if (matcher === IN_SEGMENT || matcher === IN_LARGE_SEGMENT) return true;
84
- }
85
- }
86
-
87
- const excluded = (ruleEntity as IRBSegment).excluded;
88
- if (excluded && excluded.segments && excluded.segments.length > 0) return true;
89
-
90
- return false;
91
- }
92
-
93
- export function usesSegmentsSync(storage: Pick<IStorageSync, 'splits' | 'rbSegments'>) {
94
- return storage.splits.usesSegments() || storage.rbSegments.usesSegments();
95
- }
@@ -1,234 +0,0 @@
1
- import { ISplit } from '../../dtos/types';
2
- import { AbstractSplitsCacheSync, usesSegments } from '../AbstractSplitsCacheSync';
3
- import { isFiniteNumber, toNumber, isNaNNumber } from '../../utils/lang';
4
- import { KeyBuilderCS } from '../KeyBuilderCS';
5
- import { ILogger } from '../../logger/types';
6
- import { LOG_PREFIX } from './constants';
7
- import { ISettings } from '../../types';
8
- import { setToArray } from '../../utils/lang/sets';
9
- import { StorageAdapter } from '../types';
10
-
11
- export class SplitsCacheInLocal extends AbstractSplitsCacheSync {
12
-
13
- private readonly keys: KeyBuilderCS;
14
- private readonly log: ILogger;
15
- private readonly flagSetsFilter: string[];
16
- private hasSync?: boolean;
17
- private readonly storage: StorageAdapter;
18
-
19
- constructor(settings: ISettings, keys: KeyBuilderCS, storage: StorageAdapter) {
20
- super();
21
- this.keys = keys;
22
- this.log = settings.log;
23
- this.flagSetsFilter = settings.sync.__splitFiltersValidation.groupedFilters.bySet;
24
- this.storage = storage;
25
- }
26
-
27
- private _decrementCount(key: string) {
28
- const count = toNumber(this.storage.getItem(key)) - 1;
29
- if (count > 0) this.storage.setItem(key, count + '');
30
- else this.storage.removeItem(key);
31
- }
32
-
33
- private _decrementCounts(split: ISplit) {
34
- try {
35
- const ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
36
- this._decrementCount(ttKey);
37
-
38
- if (usesSegments(split)) {
39
- const segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
40
- this._decrementCount(segmentsCountKey);
41
- }
42
- } catch (e) {
43
- this.log.error(LOG_PREFIX + e);
44
- }
45
- }
46
-
47
- private _incrementCounts(split: ISplit) {
48
- try {
49
- const ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
50
- this.storage.setItem(ttKey, (toNumber(this.storage.getItem(ttKey)) + 1) + '');
51
-
52
- if (usesSegments(split)) {
53
- const segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
54
- this.storage.setItem(segmentsCountKey, (toNumber(this.storage.getItem(segmentsCountKey)) + 1) + '');
55
- }
56
- } catch (e) {
57
- this.log.error(LOG_PREFIX + e);
58
- }
59
- }
60
-
61
-
62
- /**
63
- * Removes all splits cache related data from localStorage (splits, counters, changeNumber and lastUpdated).
64
- * We cannot simply call `localStorage.clear()` since that implies removing user items from the storage.
65
- */
66
- clear() {
67
- // collect item keys
68
- const len = this.storage.length;
69
- const accum = [];
70
- for (let cur = 0; cur < len; cur++) {
71
- const key = this.storage.key(cur);
72
- if (key != null && this.keys.isSplitsCacheKey(key)) accum.push(key);
73
- }
74
- // remove items
75
- accum.forEach(key => {
76
- this.storage.removeItem(key);
77
- });
78
-
79
- this.hasSync = false;
80
- }
81
-
82
- addSplit(split: ISplit) {
83
- const name = split.name;
84
- const splitKey = this.keys.buildSplitKey(name);
85
- const splitFromStorage = this.storage.getItem(splitKey);
86
- const previousSplit = splitFromStorage ? JSON.parse(splitFromStorage) : null;
87
-
88
- if (previousSplit) {
89
- this._decrementCounts(previousSplit);
90
- this.removeFromFlagSets(previousSplit.name, previousSplit.sets);
91
- }
92
-
93
- this.storage.setItem(splitKey, JSON.stringify(split));
94
-
95
- this._incrementCounts(split);
96
- this.addToFlagSets(split);
97
-
98
- return true;
99
- }
100
-
101
- removeSplit(name: string): boolean {
102
- const split = this.getSplit(name);
103
- if (!split) return false;
104
-
105
- this.storage.removeItem(this.keys.buildSplitKey(name));
106
-
107
- this._decrementCounts(split);
108
- this.removeFromFlagSets(split.name, split.sets);
109
-
110
- return true;
111
- }
112
-
113
- getSplit(name: string): ISplit | null {
114
- const item = this.storage.getItem(this.keys.buildSplitKey(name));
115
- return item && JSON.parse(item);
116
- }
117
-
118
- setChangeNumber(changeNumber: number): boolean {
119
- try {
120
- this.storage.setItem(this.keys.buildSplitsTillKey(), changeNumber + '');
121
- // update "last updated" timestamp with current time
122
- this.storage.setItem(this.keys.buildLastUpdatedKey(), Date.now() + '');
123
- this.hasSync = true;
124
- return true;
125
- } catch (e) {
126
- this.log.error(LOG_PREFIX + e);
127
- return false;
128
- }
129
- }
130
-
131
- getChangeNumber(): number {
132
- const n = -1;
133
- let value: string | number | null = this.storage.getItem(this.keys.buildSplitsTillKey());
134
-
135
- if (value !== null) {
136
- value = parseInt(value, 10);
137
-
138
- return isNaNNumber(value) ? n : value;
139
- }
140
-
141
- return n;
142
- }
143
-
144
- getSplitNames(): string[] {
145
- const len = this.storage.length;
146
- const accum = [];
147
-
148
- let cur = 0;
149
-
150
- while (cur < len) {
151
- const key = this.storage.key(cur);
152
-
153
- if (key != null && this.keys.isSplitKey(key)) accum.push(this.keys.extractKey(key));
154
-
155
- cur++;
156
- }
157
-
158
- return accum;
159
- }
160
-
161
- trafficTypeExists(trafficType: string): boolean {
162
- const ttCount = toNumber(this.storage.getItem(this.keys.buildTrafficTypeKey(trafficType)));
163
- return isFiniteNumber(ttCount) && ttCount > 0;
164
- }
165
-
166
- usesSegments() {
167
- // If cache hasn't been synchronized with the cloud, assume we need them.
168
- if (!this.hasSync) return true;
169
-
170
- const storedCount = this.storage.getItem(this.keys.buildSplitsWithSegmentCountKey());
171
- const splitsWithSegmentsCount = storedCount === null ? 0 : toNumber(storedCount);
172
-
173
- return isFiniteNumber(splitsWithSegmentsCount) ?
174
- splitsWithSegmentsCount > 0 :
175
- true;
176
- }
177
-
178
- getNamesByFlagSets(flagSets: string[]): Set<string>[] {
179
- return flagSets.map(flagSet => {
180
- const flagSetKey = this.keys.buildFlagSetKey(flagSet);
181
- const flagSetFromStorage = this.storage.getItem(flagSetKey);
182
-
183
- return new Set(flagSetFromStorage ? JSON.parse(flagSetFromStorage) : []);
184
- });
185
- }
186
-
187
- private addToFlagSets(featureFlag: ISplit) {
188
- if (!featureFlag.sets) return;
189
-
190
- featureFlag.sets.forEach(featureFlagSet => {
191
-
192
- if (this.flagSetsFilter.length > 0 && !this.flagSetsFilter.some(filterFlagSet => filterFlagSet === featureFlagSet)) return;
193
-
194
- const flagSetKey = this.keys.buildFlagSetKey(featureFlagSet);
195
-
196
- const flagSetFromStorage = this.storage.getItem(flagSetKey);
197
-
198
- const flagSetCache = new Set(flagSetFromStorage ? JSON.parse(flagSetFromStorage) : []);
199
-
200
- if (flagSetCache.has(featureFlag.name)) return;
201
-
202
- flagSetCache.add(featureFlag.name);
203
-
204
- this.storage.setItem(flagSetKey, JSON.stringify(setToArray(flagSetCache)));
205
- });
206
- }
207
-
208
- private removeFromFlagSets(featureFlagName: string, flagSets?: string[]) {
209
- if (!flagSets) return;
210
-
211
- flagSets.forEach(flagSet => {
212
- this.removeNames(flagSet, featureFlagName);
213
- });
214
- }
215
-
216
- private removeNames(flagSetName: string, featureFlagName: string) {
217
- const flagSetKey = this.keys.buildFlagSetKey(flagSetName);
218
-
219
- const flagSetFromStorage = this.storage.getItem(flagSetKey);
220
-
221
- if (!flagSetFromStorage) return;
222
-
223
- const flagSetCache = new Set(JSON.parse(flagSetFromStorage));
224
- flagSetCache.delete(featureFlagName);
225
-
226
- if (flagSetCache.size === 0) {
227
- this.storage.removeItem(flagSetKey);
228
- return;
229
- }
230
-
231
- this.storage.setItem(flagSetKey, JSON.stringify(setToArray(flagSetCache)));
232
- }
233
-
234
- }