@splitsoftware/splitio-commons 1.6.2-rc.0 → 1.6.2-rc.10

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 (265) hide show
  1. package/CHANGES.txt +4 -0
  2. package/cjs/consent/sdkUserConsent.js +2 -2
  3. package/cjs/evaluator/index.js +15 -16
  4. package/cjs/integrations/ga/GaToSplit.js +8 -5
  5. package/cjs/listeners/browser.js +2 -1
  6. package/cjs/logger/constants.js +2 -1
  7. package/cjs/sdkClient/client.js +19 -7
  8. package/cjs/sdkClient/sdkClient.js +3 -1
  9. package/cjs/sdkFactory/index.js +24 -7
  10. package/cjs/sdkManager/index.js +3 -11
  11. package/cjs/services/splitApi.js +24 -4
  12. package/cjs/storages/AbstractSplitsCacheAsync.js +8 -10
  13. package/cjs/storages/AbstractSplitsCacheSync.js +8 -10
  14. package/cjs/storages/KeyBuilderSS.js +54 -9
  15. package/cjs/storages/dataLoader.js +1 -1
  16. package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js +5 -7
  17. package/cjs/storages/inLocalStorage/index.js +5 -1
  18. package/cjs/storages/inMemory/ImpressionCountsCacheInMemory.js +12 -1
  19. package/cjs/storages/inMemory/InMemoryStorage.js +6 -2
  20. package/cjs/storages/inMemory/InMemoryStorageCS.js +6 -2
  21. package/cjs/storages/inMemory/SplitsCacheInMemory.js +7 -10
  22. package/cjs/storages/inMemory/TelemetryCacheInMemory.js +10 -5
  23. package/cjs/storages/inMemory/UniqueKeysCacheInMemory.js +73 -0
  24. package/cjs/storages/inMemory/UniqueKeysCacheInMemoryCS.js +78 -0
  25. package/cjs/storages/inRedis/EventsCacheInRedis.js +1 -1
  26. package/cjs/storages/inRedis/ImpressionCountsCacheInRedis.js +50 -0
  27. package/cjs/storages/inRedis/SplitsCacheInRedis.js +15 -9
  28. package/cjs/storages/inRedis/TelemetryCacheInRedis.js +100 -0
  29. package/cjs/storages/inRedis/UniqueKeysCacheInRedis.js +59 -0
  30. package/cjs/storages/inRedis/constants.js +4 -1
  31. package/cjs/storages/inRedis/index.js +17 -2
  32. package/cjs/storages/pluggable/ImpressionCountsCachePluggable.js +43 -0
  33. package/cjs/storages/pluggable/SplitsCachePluggable.js +14 -9
  34. package/cjs/storages/pluggable/TelemetryCachePluggable.js +126 -0
  35. package/cjs/storages/pluggable/UniqueKeysCachePluggable.js +50 -0
  36. package/cjs/storages/pluggable/index.js +42 -17
  37. package/cjs/sync/offline/syncTasks/fromObjectSyncTask.js +2 -3
  38. package/cjs/sync/polling/updaters/splitChangesUpdater.js +1 -1
  39. package/cjs/sync/submitters/submitterManager.js +3 -0
  40. package/cjs/sync/submitters/telemetrySubmitter.js +8 -4
  41. package/cjs/sync/submitters/uniqueKeysSubmitter.js +27 -0
  42. package/cjs/trackers/impressionsTracker.js +22 -41
  43. package/cjs/trackers/strategy/strategyDebug.js +25 -0
  44. package/cjs/trackers/strategy/strategyNone.js +29 -0
  45. package/cjs/trackers/strategy/strategyOptimized.js +35 -0
  46. package/cjs/trackers/telemetryTracker.js +6 -0
  47. package/cjs/trackers/uniqueKeysTracker.js +38 -0
  48. package/cjs/utils/constants/index.js +4 -2
  49. package/cjs/utils/lang/maps.js +15 -7
  50. package/cjs/utils/redis/RedisMock.js +31 -0
  51. package/cjs/utils/settingsValidation/impressionsMode.js +2 -2
  52. package/esm/consent/sdkUserConsent.js +2 -2
  53. package/esm/evaluator/index.js +15 -16
  54. package/esm/integrations/ga/GaToSplit.js +8 -5
  55. package/esm/listeners/browser.js +3 -2
  56. package/esm/logger/constants.js +1 -0
  57. package/esm/sdkClient/client.js +19 -7
  58. package/esm/sdkClient/sdkClient.js +3 -1
  59. package/esm/sdkFactory/index.js +24 -7
  60. package/esm/sdkManager/index.js +3 -11
  61. package/esm/services/splitApi.js +24 -4
  62. package/esm/storages/AbstractSplitsCacheAsync.js +8 -10
  63. package/esm/storages/AbstractSplitsCacheSync.js +8 -10
  64. package/esm/storages/KeyBuilderSS.js +50 -8
  65. package/esm/storages/dataLoader.js +1 -1
  66. package/esm/storages/inLocalStorage/SplitsCacheInLocal.js +5 -7
  67. package/esm/storages/inLocalStorage/index.js +6 -2
  68. package/esm/storages/inMemory/ImpressionCountsCacheInMemory.js +12 -1
  69. package/esm/storages/inMemory/InMemoryStorage.js +8 -4
  70. package/esm/storages/inMemory/InMemoryStorageCS.js +7 -3
  71. package/esm/storages/inMemory/SplitsCacheInMemory.js +7 -10
  72. package/esm/storages/inMemory/TelemetryCacheInMemory.js +9 -5
  73. package/esm/storages/inMemory/UniqueKeysCacheInMemory.js +70 -0
  74. package/esm/storages/inMemory/UniqueKeysCacheInMemoryCS.js +75 -0
  75. package/esm/storages/inRedis/EventsCacheInRedis.js +1 -1
  76. package/esm/storages/inRedis/ImpressionCountsCacheInRedis.js +47 -0
  77. package/esm/storages/inRedis/SplitsCacheInRedis.js +15 -9
  78. package/esm/storages/inRedis/TelemetryCacheInRedis.js +100 -0
  79. package/esm/storages/inRedis/UniqueKeysCacheInRedis.js +56 -0
  80. package/esm/storages/inRedis/constants.js +3 -0
  81. package/esm/storages/inRedis/index.js +18 -3
  82. package/esm/storages/pluggable/ImpressionCountsCachePluggable.js +40 -0
  83. package/esm/storages/pluggable/SplitsCachePluggable.js +14 -9
  84. package/esm/storages/pluggable/TelemetryCachePluggable.js +126 -0
  85. package/esm/storages/pluggable/UniqueKeysCachePluggable.js +47 -0
  86. package/esm/storages/pluggable/index.js +43 -18
  87. package/esm/sync/offline/syncTasks/fromObjectSyncTask.js +2 -3
  88. package/esm/sync/polling/updaters/splitChangesUpdater.js +1 -1
  89. package/esm/sync/submitters/submitterManager.js +3 -0
  90. package/esm/sync/submitters/telemetrySubmitter.js +9 -5
  91. package/esm/sync/submitters/uniqueKeysSubmitter.js +23 -0
  92. package/esm/trackers/impressionsTracker.js +22 -41
  93. package/esm/trackers/strategy/strategyDebug.js +21 -0
  94. package/esm/trackers/strategy/strategyNone.js +25 -0
  95. package/esm/trackers/strategy/strategyOptimized.js +31 -0
  96. package/esm/trackers/telemetryTracker.js +6 -0
  97. package/esm/trackers/uniqueKeysTracker.js +34 -0
  98. package/esm/utils/constants/index.js +2 -0
  99. package/esm/utils/lang/maps.js +15 -7
  100. package/esm/utils/redis/RedisMock.js +28 -0
  101. package/esm/utils/settingsValidation/impressionsMode.js +3 -3
  102. package/package.json +1 -2
  103. package/src/consent/sdkUserConsent.ts +2 -2
  104. package/src/evaluator/index.ts +14 -15
  105. package/src/integrations/ga/GaToSplit.ts +9 -5
  106. package/src/integrations/types.ts +2 -1
  107. package/src/listeners/browser.ts +3 -2
  108. package/src/logger/constants.ts +1 -0
  109. package/src/sdkClient/client.ts +21 -8
  110. package/src/sdkClient/sdkClient.ts +3 -1
  111. package/src/sdkFactory/index.ts +28 -8
  112. package/src/sdkFactory/types.ts +7 -4
  113. package/src/sdkManager/index.ts +3 -12
  114. package/src/services/splitApi.ts +26 -4
  115. package/src/services/types.ts +8 -2
  116. package/src/storages/AbstractSplitsCacheAsync.ts +13 -15
  117. package/src/storages/AbstractSplitsCacheSync.ts +15 -17
  118. package/src/storages/KeyBuilderSS.ts +61 -9
  119. package/src/storages/dataLoader.ts +1 -1
  120. package/src/storages/inLocalStorage/SplitsCacheInLocal.ts +8 -11
  121. package/src/storages/inLocalStorage/index.ts +5 -2
  122. package/src/storages/inMemory/ImpressionCountsCacheInMemory.ts +16 -1
  123. package/src/storages/inMemory/InMemoryStorage.ts +7 -4
  124. package/src/storages/inMemory/InMemoryStorageCS.ts +6 -3
  125. package/src/storages/inMemory/SplitsCacheInMemory.ts +10 -14
  126. package/src/storages/inMemory/TelemetryCacheInMemory.ts +10 -6
  127. package/src/storages/inMemory/UniqueKeysCacheInMemory.ts +82 -0
  128. package/src/storages/inMemory/UniqueKeysCacheInMemoryCS.ts +88 -0
  129. package/src/storages/inRedis/EventsCacheInRedis.ts +1 -1
  130. package/src/storages/inRedis/ImpressionCountsCacheInRedis.ts +53 -0
  131. package/src/storages/inRedis/SplitsCacheInRedis.ts +21 -17
  132. package/src/storages/inRedis/TelemetryCacheInRedis.ts +122 -2
  133. package/src/storages/inRedis/UniqueKeysCacheInRedis.ts +65 -0
  134. package/src/storages/inRedis/constants.ts +3 -0
  135. package/src/storages/inRedis/index.ts +15 -5
  136. package/src/storages/pluggable/ImpressionCountsCachePluggable.ts +47 -0
  137. package/src/storages/pluggable/SplitsCachePluggable.ts +20 -17
  138. package/src/storages/pluggable/TelemetryCachePluggable.ts +147 -2
  139. package/src/storages/pluggable/UniqueKeysCachePluggable.ts +56 -0
  140. package/src/storages/pluggable/index.ts +44 -19
  141. package/src/storages/types.ts +50 -29
  142. package/src/sync/offline/syncTasks/fromObjectSyncTask.ts +5 -6
  143. package/src/sync/polling/updaters/splitChangesUpdater.ts +2 -2
  144. package/src/sync/submitters/submitterManager.ts +2 -0
  145. package/src/sync/submitters/telemetrySubmitter.ts +15 -8
  146. package/src/sync/submitters/types.ts +38 -7
  147. package/src/sync/submitters/uniqueKeysSubmitter.ts +36 -0
  148. package/src/trackers/impressionsTracker.ts +27 -48
  149. package/src/trackers/strategy/strategyDebug.ts +28 -0
  150. package/src/trackers/strategy/strategyNone.ts +34 -0
  151. package/src/trackers/strategy/strategyOptimized.ts +42 -0
  152. package/src/trackers/telemetryTracker.ts +7 -2
  153. package/src/trackers/types.ts +32 -0
  154. package/src/trackers/uniqueKeysTracker.ts +48 -0
  155. package/src/types.ts +1 -1
  156. package/src/utils/constants/index.ts +2 -0
  157. package/src/utils/lang/maps.ts +20 -8
  158. package/src/utils/redis/RedisMock.ts +33 -0
  159. package/src/utils/settingsValidation/impressionsMode.ts +3 -3
  160. package/src/utils/settingsValidation/index.ts +1 -0
  161. package/types/integrations/types.d.ts +2 -1
  162. package/types/logger/browser/{debugLogger.d.ts → DebugLogger.d.ts} +0 -0
  163. package/types/logger/browser/{errorLogger.d.ts → ErrorLogger.d.ts} +0 -0
  164. package/types/logger/browser/{infoLogger.d.ts → InfoLogger.d.ts} +0 -0
  165. package/types/logger/browser/{warnLogger.d.ts → WarnLogger.d.ts} +0 -0
  166. package/types/logger/constants.d.ts +1 -0
  167. package/types/sdkFactory/types.d.ts +4 -2
  168. package/types/services/types.d.ts +6 -2
  169. package/types/storages/AbstractSplitsCacheAsync.d.ts +7 -6
  170. package/types/storages/AbstractSplitsCacheSync.d.ts +6 -6
  171. package/types/storages/KeyBuilderSS.d.ts +9 -2
  172. package/types/storages/inLocalStorage/SplitsCacheInLocal.d.ts +3 -4
  173. package/types/storages/inMemory/ImpressionCountsCacheInMemory.d.ts +5 -1
  174. package/types/storages/inMemory/SplitsCacheInMemory.d.ts +3 -2
  175. package/types/storages/inMemory/TelemetryCacheInMemory.d.ts +6 -3
  176. package/types/storages/inMemory/uniqueKeysCacheInMemory.d.ts +35 -0
  177. package/types/storages/inMemory/uniqueKeysCacheInMemoryCS.d.ts +37 -0
  178. package/types/storages/inRedis/EventsCacheInRedis.d.ts +1 -1
  179. package/types/storages/inRedis/ImpressionCountsCacheInRedis.d.ts +14 -0
  180. package/types/storages/inRedis/SplitsCacheInRedis.d.ts +6 -5
  181. package/types/storages/inRedis/TelemetryCacheInRedis.d.ts +16 -1
  182. package/types/storages/inRedis/constants.d.ts +3 -0
  183. package/types/storages/inRedis/uniqueKeysCacheInRedis.d.ts +15 -0
  184. package/types/storages/pluggable/ImpressionCountsCachePluggable.d.ts +14 -0
  185. package/types/storages/pluggable/SplitsCachePluggable.d.ts +6 -5
  186. package/types/storages/pluggable/TelemetryCachePluggable.d.ts +17 -1
  187. package/types/storages/pluggable/UniqueKeysCachePluggable.d.ts +14 -0
  188. package/types/storages/types.d.ts +38 -25
  189. package/types/sync/polling/updaters/splitChangesUpdater.d.ts +1 -1
  190. package/types/sync/submitters/telemetrySubmitter.d.ts +1 -1
  191. package/types/sync/submitters/types.d.ts +30 -7
  192. package/types/sync/submitters/uniqueKeysSubmitter.d.ts +0 -8
  193. package/types/trackers/impressionsTracker.d.ts +4 -6
  194. package/types/trackers/types.d.ts +27 -0
  195. package/types/trackers/uniqueKeysTracker.d.ts +3 -3
  196. package/types/types.d.ts +1 -1
  197. package/types/utils/constants/index.d.ts +2 -0
  198. package/types/utils/lang/maps.d.ts +6 -2
  199. package/types/utils/redis/RedisMock.d.ts +4 -0
  200. package/src/splitio.d.ts +0 -1602
  201. package/types/integrations/ga/GaToSplitPlugin.d.ts +0 -3
  202. package/types/integrations/ga/SplitToGaPlugin.d.ts +0 -4
  203. package/types/integrations/ga/autoRequire.d.ts +0 -4
  204. package/types/logger/codes.d.ts +0 -2
  205. package/types/logger/codesConstants.d.ts +0 -117
  206. package/types/logger/codesConstantsBrowser.d.ts +0 -2
  207. package/types/logger/codesConstantsNode.d.ts +0 -14
  208. package/types/logger/codesDebug.d.ts +0 -1
  209. package/types/logger/codesDebugBrowser.d.ts +0 -1
  210. package/types/logger/codesDebugNode.d.ts +0 -1
  211. package/types/logger/codesError.d.ts +0 -1
  212. package/types/logger/codesErrorNode.d.ts +0 -1
  213. package/types/logger/codesInfo.d.ts +0 -1
  214. package/types/logger/codesWarn.d.ts +0 -1
  215. package/types/logger/codesWarnNode.d.ts +0 -1
  216. package/types/logger/debugLogger.d.ts +0 -2
  217. package/types/logger/errorLogger.d.ts +0 -2
  218. package/types/logger/infoLogger.d.ts +0 -2
  219. package/types/logger/messages/debugBrowser.d.ts +0 -1
  220. package/types/logger/messages/debugNode.d.ts +0 -1
  221. package/types/logger/messages/errorNode.d.ts +0 -1
  222. package/types/logger/messages/warnNode.d.ts +0 -1
  223. package/types/logger/noopLogger.d.ts +0 -2
  224. package/types/logger/warnLogger.d.ts +0 -2
  225. package/types/sdkClient/types.d.ts +0 -18
  226. package/types/sdkFactory/userConsentProps.d.ts +0 -6
  227. package/types/sdkManager/sdkManagerMethod.d.ts +0 -6
  228. package/types/storages/getRegisteredSegments.d.ts +0 -10
  229. package/types/storages/inMemory/CountsCacheInMemory.d.ts +0 -20
  230. package/types/storages/inMemory/LatenciesCacheInMemory.d.ts +0 -20
  231. package/types/storages/inMemory/index.d.ts +0 -10
  232. package/types/storages/inRedis/CountsCacheInRedis.d.ts +0 -9
  233. package/types/storages/inRedis/LatenciesCacheInRedis.d.ts +0 -9
  234. package/types/storages/parseSegments.d.ts +0 -6
  235. package/types/sync/offline/LocalhostFromFile.d.ts +0 -2
  236. package/types/sync/offline/splitsParser/splitsParserFromFile.d.ts +0 -2
  237. package/types/sync/polling/syncTasks/splitsSyncTask.copy.d.ts +0 -35
  238. package/types/sync/polling/syncTasks/splitsSyncTask.morelikeoriginal.d.ts +0 -35
  239. package/types/sync/streaming/AuthClient/indexV1.d.ts +0 -12
  240. package/types/sync/streaming/AuthClient/indexV2.d.ts +0 -8
  241. package/types/sync/streaming/pushManagerCS.d.ts +0 -1
  242. package/types/sync/streaming/pushManagerNoUsers.d.ts +0 -13
  243. package/types/sync/streaming/pushManagerSS.d.ts +0 -1
  244. package/types/sync/submitters/eventsSyncTask.d.ts +0 -8
  245. package/types/sync/submitters/impressionCountsSyncTask.d.ts +0 -13
  246. package/types/sync/submitters/impressionsSyncTask.d.ts +0 -14
  247. package/types/sync/submitters/metricsSyncTask.d.ts +0 -12
  248. package/types/sync/submitters/submitterSyncTask.d.ts +0 -10
  249. package/types/sync/submitters/telemetrySyncTask.d.ts +0 -0
  250. package/types/sync/syncManagerFromFile.d.ts +0 -2
  251. package/types/sync/syncManagerFromObject.d.ts +0 -2
  252. package/types/sync/syncManagerOffline.d.ts +0 -9
  253. package/types/sync/syncTaskComposite.d.ts +0 -5
  254. package/types/trackers/telemetryRecorder.d.ts +0 -0
  255. package/types/utils/EventEmitter.d.ts +0 -4
  256. package/types/utils/consent.d.ts +0 -2
  257. package/types/utils/lang/errors.d.ts +0 -10
  258. package/types/utils/murmur3/commons.d.ts +0 -12
  259. package/types/utils/settingsValidation/buildMetadata.d.ts +0 -3
  260. package/types/utils/settingsValidation/localhost/index.d.ts +0 -9
  261. package/types/utils/settingsValidation/logger.d.ts +0 -11
  262. package/types/utils/settingsValidation/runtime/browser.d.ts +0 -2
  263. package/types/utils/settingsValidation/runtime/node.d.ts +0 -2
  264. package/types/utils/settingsValidation/userConsent.d.ts +0 -5
  265. package/types/utils/timeTracker/index.d.ts +0 -1
package/CHANGES.txt CHANGED
@@ -1,3 +1,7 @@
1
+ 1.7.0 (September XXX, 2022)
2
+ - Updated SDK telemetry to support pluggable storage, partial consumer mode, and synchronizer.
3
+ - Updated storage implementations to improve the performance of split evaluations (i.e., `getTreatment(s)` method calls) when using the default storage in memory.
4
+
1
5
  1.6.1 (July 22, 2022)
2
6
  - Updated GoogleAnalyticsToSplit integration to validate `autoRequire` config parameter and avoid some wrong warning logs when mapping GA hit fields to Split event properties.
3
7
 
@@ -39,8 +39,8 @@ function createUserConsentAPI(params) {
39
39
  if (events.clear)
40
40
  events.clear(); // @ts-ignore
41
41
  if (impressions.clear)
42
- impressions.clear();
43
- if (impressionCounts)
42
+ impressions.clear(); // @ts-ignore
43
+ if (impressionCounts && impressionCounts.clear)
44
44
  impressionCounts.clear();
45
45
  }
46
46
  }
@@ -19,63 +19,62 @@ function treatmentsException(splitNames) {
19
19
  return evaluations;
20
20
  }
21
21
  function evaluateFeature(log, key, splitName, attributes, storage) {
22
- var stringifiedSplit;
22
+ var parsedSplit;
23
23
  try {
24
- stringifiedSplit = storage.splits.getSplit(splitName);
24
+ parsedSplit = storage.splits.getSplit(splitName);
25
25
  }
26
26
  catch (e) {
27
27
  // Exception on sync `getSplit` storage. Not possible ATM with InMemory and InLocal storages.
28
28
  return treatmentException;
29
29
  }
30
- if ((0, thenable_1.thenable)(stringifiedSplit)) {
31
- return stringifiedSplit.then(function (result) { return getEvaluation(log, result, key, attributes, storage); }).catch(
30
+ if ((0, thenable_1.thenable)(parsedSplit)) {
31
+ return parsedSplit.then(function (split) { return getEvaluation(log, split, key, attributes, storage); }).catch(
32
32
  // Exception on async `getSplit` storage. For example, when the storage is redis or
33
33
  // pluggable and there is a connection issue and we can't retrieve the split to be evaluated
34
34
  function () { return treatmentException; });
35
35
  }
36
- return getEvaluation(log, stringifiedSplit, key, attributes, storage);
36
+ return getEvaluation(log, parsedSplit, key, attributes, storage);
37
37
  }
38
38
  exports.evaluateFeature = evaluateFeature;
39
39
  function evaluateFeatures(log, key, splitNames, attributes, storage) {
40
- var stringifiedSplits;
40
+ var parsedSplits;
41
41
  try {
42
- stringifiedSplits = storage.splits.getSplits(splitNames);
42
+ parsedSplits = storage.splits.getSplits(splitNames);
43
43
  }
44
44
  catch (e) {
45
45
  // Exception on sync `getSplits` storage. Not possible ATM with InMemory and InLocal storages.
46
46
  return treatmentsException(splitNames);
47
47
  }
48
- return ((0, thenable_1.thenable)(stringifiedSplits)) ?
49
- stringifiedSplits.then(function (splits) { return getEvaluations(log, splitNames, splits, key, attributes, storage); })
48
+ return (0, thenable_1.thenable)(parsedSplits) ?
49
+ parsedSplits.then(function (splits) { return getEvaluations(log, splitNames, splits, key, attributes, storage); })
50
50
  .catch(function () {
51
51
  // Exception on async `getSplits` storage. For example, when the storage is redis or
52
52
  // pluggable and there is a connection issue and we can't retrieve the split to be evaluated
53
53
  return treatmentsException(splitNames);
54
54
  }) :
55
- getEvaluations(log, splitNames, stringifiedSplits, key, attributes, storage);
55
+ getEvaluations(log, splitNames, parsedSplits, key, attributes, storage);
56
56
  }
57
57
  exports.evaluateFeatures = evaluateFeatures;
58
- function getEvaluation(log, stringifiedSplit, key, attributes, storage) {
58
+ function getEvaluation(log, splitJSON, key, attributes, storage) {
59
59
  var evaluation = {
60
60
  treatment: constants_1.CONTROL,
61
61
  label: LabelsConstants.SPLIT_NOT_FOUND,
62
62
  config: null
63
63
  };
64
- if (stringifiedSplit) {
65
- var splitJSON_1 = JSON.parse(stringifiedSplit);
66
- var split_1 = Engine_1.Engine.parse(log, splitJSON_1, storage);
64
+ if (splitJSON) {
65
+ var split_1 = Engine_1.Engine.parse(log, splitJSON, storage);
67
66
  evaluation = split_1.getTreatment(key, attributes, evaluateFeature);
68
67
  // If the storage is async and the evaluated split uses segment, evaluation is thenable
69
68
  if ((0, thenable_1.thenable)(evaluation)) {
70
69
  return evaluation.then(function (result) {
71
70
  result.changeNumber = split_1.getChangeNumber();
72
- result.config = splitJSON_1.configurations && splitJSON_1.configurations[result.treatment] || null;
71
+ result.config = splitJSON.configurations && splitJSON.configurations[result.treatment] || null;
73
72
  return result;
74
73
  });
75
74
  }
76
75
  else {
77
76
  evaluation.changeNumber = split_1.getChangeNumber(); // Always sync and optional
78
- evaluation.config = splitJSON_1.configurations && splitJSON_1.configurations[evaluation.treatment] || null;
77
+ evaluation.config = splitJSON.configurations && splitJSON.configurations[evaluation.treatment] || null;
79
78
  }
80
79
  }
81
80
  return evaluation;
@@ -16,7 +16,7 @@ var logNameMapper = 'ga-to-split:mapper';
16
16
  * @param log Logger instance.
17
17
  * @param autoRequire If true, log error when auto-require script is not detected
18
18
  */
19
- function providePlugin(window, pluginName, pluginConstructor, log, autoRequire) {
19
+ function providePlugin(window, pluginName, pluginConstructor, log, autoRequire, telemetryTracker) {
20
20
  // get reference to global command queue. Init it if not defined yet.
21
21
  var gaAlias = window.GoogleAnalyticsObject || 'ga';
22
22
  window[gaAlias] = window[gaAlias] || function () {
@@ -24,10 +24,13 @@ function providePlugin(window, pluginName, pluginConstructor, log, autoRequire)
24
24
  };
25
25
  // provides the plugin for use with analytics.js.
26
26
  window[gaAlias]('provide', pluginName, pluginConstructor);
27
- if (autoRequire && (!window[gaAlias].q || window[gaAlias].q.push === [].push)) {
28
- // Expecting spy on ga.q push method but not found
27
+ var hasAutoRequire = window[gaAlias].q && window[gaAlias].q.push !== [].push;
28
+ if (autoRequire && !hasAutoRequire) { // Expecting spy on ga.q push method but not found
29
29
  log.error(logPrefix + 'integration is configured to autorequire the splitTracker plugin, but the necessary script does not seem to have run. Please check the docs.');
30
30
  }
31
+ if (telemetryTracker && hasAutoRequire) {
32
+ telemetryTracker.addTag('integration:ga-autorequire');
33
+ }
31
34
  }
32
35
  // Default mapping: object used for building the default mapper from hits to Split events
33
36
  var defaultMapping = {
@@ -163,7 +166,7 @@ exports.fixEventTypeId = fixEventTypeId;
163
166
  * @param {object} log factory logger
164
167
  */
165
168
  function GaToSplit(sdkOptions, params) {
166
- var storage = params.storage, _a = params.settings, coreSettings = _a.core, log = _a.log;
169
+ var storage = params.storage, _a = params.settings, coreSettings = _a.core, log = _a.log, telemetryTracker = params.telemetryTracker;
167
170
  var defaultOptions = {
168
171
  prefix: exports.defaultPrefix,
169
172
  // We set default identities if key and TT are present in settings.core
@@ -249,6 +252,6 @@ function GaToSplit(sdkOptions, params) {
249
252
  return SplitTracker;
250
253
  }());
251
254
  // Register the plugin, even if config is invalid, since, if not provided, it will block `ga` command queue.
252
- providePlugin(window, 'splitTracker', SplitTracker, log, sdkOptions.autoRequire === true);
255
+ providePlugin(window, 'splitTracker', SplitTracker, log, sdkOptions.autoRequire === true, telemetryTracker);
253
256
  }
254
257
  exports.GaToSplit = GaToSplit;
@@ -74,9 +74,10 @@ var BrowserSignalListener = /** @class */ (function () {
74
74
  // Flush impressions & events data if there is user consent
75
75
  if ((0, consent_1.isConsentGranted)(this.settings)) {
76
76
  var eventsUrl = this.settings.urls.events;
77
+ var sim = this.settings.sync.impressionsMode;
77
78
  var extraMetadata = {
78
79
  // sim stands for Sync/Split Impressions Mode
79
- sim: this.settings.sync.impressionsMode === constants_1.OPTIMIZED ? constants_1.OPTIMIZED : constants_1.DEBUG
80
+ sim: sim === constants_1.OPTIMIZED ? constants_1.OPTIMIZED : sim === constants_1.DEBUG ? constants_1.DEBUG : constants_1.NONE
80
81
  };
81
82
  this._flushData(eventsUrl + '/testImpressions/beacon', this.storage.impressions, this.serviceApi.postTestImpressionsBulk, this.fromImpressionsCollector, extraMetadata);
82
83
  this._flushData(eventsUrl + '/events/beacon', this.storage.events, this.serviceApi.postEventsBulk);
@@ -2,7 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SYNC_SPLITS_FETCH_RETRY = exports.POLLING_STOP = exports.POLLING_START = exports.POLLING_SMART_PAUSING = exports.NEW_FACTORY = exports.NEW_SHARED_CLIENT = exports.IMPRESSION_QUEUEING = exports.IMPRESSION = exports.CLIENT_READY = exports.CLIENT_READY_FROM_CACHE = exports.SETTINGS_SPLITS_FILTER = exports.SYNC_TASK_STOP = exports.SYNC_TASK_EXECUTE = exports.SYNC_TASK_START = exports.STREAMING_NEW_MESSAGE = exports.SYNC_SPLITS_SEGMENTS = exports.SYNC_SPLITS_REMOVED = exports.SYNC_SPLITS_NEW = exports.SYNC_SPLITS_FETCH = exports.SYNC_OFFLINE_DATA = exports.RETRIEVE_MANAGER = exports.RETRIEVE_CLIENT_EXISTING = exports.RETRIEVE_CLIENT_DEFAULT = exports.CLEANUP_DEREGISTERING = exports.CLEANUP_REGISTERING = exports.ENGINE_SANITIZE = exports.ENGINE_VALUE = exports.ENGINE_MATCHER_WHITELIST = exports.ENGINE_MATCHER_STARTS_WITH = exports.ENGINE_MATCHER_STRING_INVALID = exports.ENGINE_MATCHER_STRING = exports.ENGINE_MATCHER_SEGMENT = exports.ENGINE_MATCHER_PART_OF = exports.ENGINE_MATCHER_LESS = exports.ENGINE_MATCHER_GREATER = exports.ENGINE_MATCHER_ENDS_WITH = exports.ENGINE_MATCHER_EQUAL_TO_SET = exports.ENGINE_MATCHER_EQUAL = exports.ENGINE_MATCHER_DEPENDENCY_PRE = exports.ENGINE_MATCHER_DEPENDENCY = exports.ENGINE_MATCHER_CONTAINS_STRING = exports.ENGINE_MATCHER_CONTAINS_ANY = exports.ENGINE_MATCHER_CONTAINS_ALL = exports.ENGINE_MATCHER_BOOLEAN = exports.ENGINE_MATCHER_BETWEEN = exports.ENGINE_MATCHER_ALL = exports.ENGINE_BUCKET = exports.ENGINE_COMBINER_IFELSEIF_NO_TREATMENT = exports.ENGINE_COMBINER_IFELSEIF = exports.ENGINE_COMBINER_AND = void 0;
4
4
  exports.ERROR_EVENT_TYPE_FORMAT = exports.ERROR_EVENTS_TRACKER = exports.ERROR_IMPRESSIONS_LISTENER = exports.ERROR_IMPRESSIONS_TRACKER = exports.ERROR_STREAMING_AUTH = exports.ERROR_STREAMING_SSE = exports.ERROR_SYNC_OFFLINE_LOADING = exports.ERROR_CLIENT_CANNOT_GET_READY = exports.ERROR_CLIENT_LISTENER = exports.ERROR_LOGLEVEL_INVALID = exports.ERROR_ENGINE_COMBINER_IFELSEIF = exports.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = exports.WARN_API_KEY = exports.WARN_SPLITS_FILTER_EMPTY = exports.WARN_SPLITS_FILTER_INVALID = exports.WARN_SPLITS_FILTER_IGNORED = exports.WARN_INTEGRATION_INVALID = exports.WARN_NOT_EXISTENT_TT = exports.WARN_LOWERCASE_TRAFFIC_TYPE = exports.WARN_NOT_EXISTENT_SPLIT = exports.WARN_TRIMMING = exports.WARN_CONVERTING = exports.WARN_TRIMMING_PROPERTIES = exports.WARN_SETTING_NULL = exports.SUBMITTERS_PUSH_RETRY = exports.SUBMITTERS_PUSH_FAILS = exports.STREAMING_FALLBACK = exports.STREAMING_PARSING_MESSAGE_FAILS = exports.STREAMING_PARSING_ERROR_FAILS = exports.SYNC_SPLITS_FETCH_FAILS = exports.SYNC_MYSEGMENTS_FETCH_RETRY = exports.CLIENT_NOT_READY = exports.CLIENT_NO_LISTENER = exports.ENGINE_VALUE_NO_ATTRIBUTES = exports.ENGINE_VALUE_INVALID = exports.USER_CONSENT_INITIAL = exports.USER_CONSENT_NOT_UPDATED = exports.USER_CONSENT_UPDATED = exports.IMPRESSIONS_TRACKER_SUCCESS = exports.EVENTS_TRACKER_SUCCESS = exports.SYNC_STOP_POLLING = exports.SYNC_CONTINUE_POLLING = exports.SYNC_START_POLLING = exports.SUBMITTERS_PUSH = exports.SUBMITTERS_PUSH_FULL_QUEUE = exports.STREAMING_DISCONNECTING = exports.STREAMING_DISABLED = exports.STREAMING_CONNECTING = exports.STREAMING_RECONNECT = exports.STREAMING_REFRESH_TOKEN = void 0;
5
- exports.LOG_PREFIX_CLEANUP = exports.LOG_PREFIX_EVENTS_TRACKER = exports.LOG_PREFIX_IMPRESSIONS_TRACKER = exports.LOG_PREFIX_SYNC_SUBMITTERS = exports.LOG_PREFIX_SYNC_POLLING = exports.LOG_PREFIX_SYNC_MYSEGMENTS = exports.LOG_PREFIX_SYNC_SEGMENTS = exports.LOG_PREFIX_SYNC_SPLITS = exports.LOG_PREFIX_SYNC_STREAMING = exports.LOG_PREFIX_SYNC_OFFLINE = exports.LOG_PREFIX_SYNC_MANAGER = exports.LOG_PREFIX_SYNC = exports.LOG_PREFIX_ENGINE_VALUE = exports.LOG_PREFIX_ENGINE_MATCHER = exports.LOG_PREFIX_ENGINE_COMBINER = exports.LOG_PREFIX_ENGINE = exports.LOG_PREFIX_INSTANTIATION = exports.LOG_PREFIX_SETTINGS = exports.ERROR_MIN_CONFIG_PARAM = exports.ERROR_NOT_BOOLEAN = exports.ERROR_STORAGE_INVALID = exports.ERROR_LOCALHOST_MODULE_REQUIRED = exports.ERROR_HTTP = exports.ERROR_INVALID_CONFIG_PARAM = exports.ERROR_EMPTY_ARRAY = exports.ERROR_EMPTY = exports.ERROR_INVALID = exports.ERROR_INVALID_KEY_OBJECT = exports.ERROR_TOO_LONG = exports.ERROR_NULL = exports.ERROR_CLIENT_DESTROYED = exports.ERROR_NOT_FINITE = exports.ERROR_SIZE_EXCEEDED = exports.ERROR_NOT_PLAIN_OBJECT = void 0;
5
+ exports.LOG_PREFIX_CLEANUP = exports.LOG_PREFIX_UNIQUE_KEYS_TRACKER = exports.LOG_PREFIX_EVENTS_TRACKER = exports.LOG_PREFIX_IMPRESSIONS_TRACKER = exports.LOG_PREFIX_SYNC_SUBMITTERS = exports.LOG_PREFIX_SYNC_POLLING = exports.LOG_PREFIX_SYNC_MYSEGMENTS = exports.LOG_PREFIX_SYNC_SEGMENTS = exports.LOG_PREFIX_SYNC_SPLITS = exports.LOG_PREFIX_SYNC_STREAMING = exports.LOG_PREFIX_SYNC_OFFLINE = exports.LOG_PREFIX_SYNC_MANAGER = exports.LOG_PREFIX_SYNC = exports.LOG_PREFIX_ENGINE_VALUE = exports.LOG_PREFIX_ENGINE_MATCHER = exports.LOG_PREFIX_ENGINE_COMBINER = exports.LOG_PREFIX_ENGINE = exports.LOG_PREFIX_INSTANTIATION = exports.LOG_PREFIX_SETTINGS = exports.ERROR_MIN_CONFIG_PARAM = exports.ERROR_NOT_BOOLEAN = exports.ERROR_STORAGE_INVALID = exports.ERROR_LOCALHOST_MODULE_REQUIRED = exports.ERROR_HTTP = exports.ERROR_INVALID_CONFIG_PARAM = exports.ERROR_EMPTY_ARRAY = exports.ERROR_EMPTY = exports.ERROR_INVALID = exports.ERROR_INVALID_KEY_OBJECT = exports.ERROR_TOO_LONG = exports.ERROR_NULL = exports.ERROR_CLIENT_DESTROYED = exports.ERROR_NOT_FINITE = exports.ERROR_SIZE_EXCEEDED = exports.ERROR_NOT_PLAIN_OBJECT = void 0;
6
6
  /**
7
7
  * Message codes used to trim string log messages from commons and client-side API modules,
8
8
  * in order to reduce the minimal SDK size for Browser and eventually other client-side environments.
@@ -144,4 +144,5 @@ exports.LOG_PREFIX_SYNC_POLLING = exports.LOG_PREFIX_SYNC + ':polling-manager: '
144
144
  exports.LOG_PREFIX_SYNC_SUBMITTERS = exports.LOG_PREFIX_SYNC + ':submitter: ';
145
145
  exports.LOG_PREFIX_IMPRESSIONS_TRACKER = 'impressions-tracker: ';
146
146
  exports.LOG_PREFIX_EVENTS_TRACKER = 'events-tracker: ';
147
+ exports.LOG_PREFIX_UNIQUE_KEYS_TRACKER = 'unique-keys-tracker: ';
147
148
  exports.LOG_PREFIX_CLEANUP = 'cleanup: ';
@@ -9,6 +9,15 @@ var trafficTypeExistance_1 = require("../utils/inputValidation/trafficTypeExista
9
9
  var labels_1 = require("../utils/labels");
10
10
  var constants_1 = require("../utils/constants");
11
11
  var constants_2 = require("../logger/constants");
12
+ var utils_1 = require("../trackers/impressionObserver/utils");
13
+ var treatmentNotReady = { treatment: constants_1.CONTROL, label: labels_1.SDK_NOT_READY };
14
+ function treatmentsNotReady(splitNames) {
15
+ var evaluations = {};
16
+ splitNames.forEach(function (splitName) {
17
+ evaluations[splitName] = treatmentNotReady;
18
+ });
19
+ return evaluations;
20
+ }
12
21
  /**
13
22
  * Creator of base client with getTreatments and track methods.
14
23
  */
@@ -25,7 +34,11 @@ function clientFactory(params) {
25
34
  stopTelemetryTracker(queue[0] && queue[0].label);
26
35
  return treatment;
27
36
  };
28
- var evaluation = (0, evaluator_1.evaluateFeature)(log, key, splitName, attributes, storage);
37
+ var evaluation = readinessManager.isReady() || readinessManager.isReadyFromCache() ?
38
+ (0, evaluator_1.evaluateFeature)(log, key, splitName, attributes, storage) :
39
+ (0, utils_1.isStorageSync)(settings) ? // If the SDK is not ready, treatment may be incorrect due to having splits but not segments data, or storage is not connected
40
+ treatmentNotReady :
41
+ Promise.resolve(treatmentNotReady); // Promisify if async
29
42
  return (0, thenable_1.thenable)(evaluation) ? evaluation.then(function (res) { return wrapUp(res); }) : wrapUp(evaluation);
30
43
  }
31
44
  function getTreatmentWithConfig(key, splitName, attributes) {
@@ -44,7 +57,11 @@ function clientFactory(params) {
44
57
  stopTelemetryTracker(queue[0] && queue[0].label);
45
58
  return treatments;
46
59
  };
47
- var evaluations = (0, evaluator_1.evaluateFeatures)(log, key, splitNames, attributes, storage);
60
+ var evaluations = readinessManager.isReady() || readinessManager.isReadyFromCache() ?
61
+ (0, evaluator_1.evaluateFeatures)(log, key, splitNames, attributes, storage) :
62
+ (0, utils_1.isStorageSync)(settings) ? // If the SDK is not ready, treatment may be incorrect due to having splits but not segments data, or storage is not connected
63
+ treatmentsNotReady(splitNames) :
64
+ Promise.resolve(treatmentsNotReady(splitNames)); // Promisify if async
48
65
  return (0, thenable_1.thenable)(evaluations) ? evaluations.then(function (res) { return wrapUp(res); }) : wrapUp(evaluations);
49
66
  }
50
67
  function getTreatmentsWithConfig(key, splitNames, attributes) {
@@ -52,13 +69,8 @@ function clientFactory(params) {
52
69
  }
53
70
  // Internal function
54
71
  function processEvaluation(evaluation, splitName, key, attributes, withConfig, invokingMethodName, queue) {
55
- var isSdkReady = readinessManager.isReady() || readinessManager.isReadyFromCache();
56
72
  var matchingKey = (0, key_1.getMatching)(key);
57
73
  var bucketingKey = (0, key_1.getBucketing)(key);
58
- // If the SDK was not ready, treatment may be incorrect due to having Splits but not segments data.
59
- if (!isSdkReady) {
60
- evaluation = { treatment: constants_1.CONTROL, label: labels_1.SDK_NOT_READY };
61
- }
62
74
  var treatment = evaluation.treatment, label = evaluation.label, changeNumber = evaluation.changeNumber, _a = evaluation.config, config = _a === void 0 ? null : _a;
63
75
  log.info(constants_2.IMPRESSION, [splitName, matchingKey, treatment, label]);
64
76
  if ((0, splitExistance_1.validateSplitExistance)(log, readinessManager, splitName, label, invokingMethodName)) {
@@ -9,7 +9,7 @@ var clientInputValidation_1 = require("./clientInputValidation");
9
9
  * Creates an Sdk client, i.e., a base client with status and destroy interface
10
10
  */
11
11
  function sdkClientFactory(params, isSharedClient) {
12
- var sdkReadinessManager = params.sdkReadinessManager, syncManager = params.syncManager, storage = params.storage, signalListener = params.signalListener, settings = params.settings, telemetryTracker = params.telemetryTracker;
12
+ var sdkReadinessManager = params.sdkReadinessManager, syncManager = params.syncManager, storage = params.storage, signalListener = params.signalListener, settings = params.settings, telemetryTracker = params.telemetryTracker, uniqueKeysTracker = params.uniqueKeysTracker;
13
13
  return (0, objectAssign_1.objectAssign)(
14
14
  // Proto-linkage of the readiness Event Emitter
15
15
  Object.create(sdkReadinessManager.sdkStatus),
@@ -31,6 +31,8 @@ function sdkClientFactory(params, isSharedClient) {
31
31
  // Release the API Key if it is the main client
32
32
  if (!isSharedClient)
33
33
  (0, apiKey_1.releaseApiKey)(settings.core.authorizationKey);
34
+ if (uniqueKeysTracker)
35
+ uniqueKeysTracker.stop();
34
36
  // Cleanup storage
35
37
  return storage.destroy();
36
38
  });
@@ -13,11 +13,16 @@ var constants_1 = require("../logger/constants");
13
13
  var metadataBuilder_1 = require("../storages/metadataBuilder");
14
14
  var constants_2 = require("../readiness/constants");
15
15
  var objectAssign_1 = require("../utils/lang/objectAssign");
16
+ var strategyDebug_1 = require("../trackers/strategy/strategyDebug");
17
+ var strategyOptimized_1 = require("../trackers/strategy/strategyOptimized");
18
+ var strategyNone_1 = require("../trackers/strategy/strategyNone");
19
+ var uniqueKeysTracker_1 = require("../trackers/uniqueKeysTracker");
20
+ var constants_3 = require("../utils/constants");
16
21
  /**
17
22
  * Modular SDK factory
18
23
  */
19
24
  function sdkFactory(params) {
20
- var settings = params.settings, platform = params.platform, storageFactory = params.storageFactory, splitApiFactory = params.splitApiFactory, extraProps = params.extraProps, syncManagerFactory = params.syncManagerFactory, SignalListener = params.SignalListener, impressionsObserverFactory = params.impressionsObserverFactory, integrationsManagerFactory = params.integrationsManagerFactory, sdkManagerFactory = params.sdkManagerFactory, sdkClientMethodFactory = params.sdkClientMethodFactory;
25
+ var settings = params.settings, platform = params.platform, storageFactory = params.storageFactory, splitApiFactory = params.splitApiFactory, extraProps = params.extraProps, syncManagerFactory = params.syncManagerFactory, SignalListener = params.SignalListener, impressionsObserverFactory = params.impressionsObserverFactory, integrationsManagerFactory = params.integrationsManagerFactory, sdkManagerFactory = params.sdkManagerFactory, sdkClientMethodFactory = params.sdkClientMethodFactory, filterAdapterFactory = params.filterAdapterFactory;
21
26
  var log = settings.log;
22
27
  // @TODO handle non-recoverable errors, such as, global `fetch` not available, invalid API Key, etc.
23
28
  // On non-recoverable errors, we should mark the SDK as destroyed and not start synchronization.
@@ -35,6 +40,7 @@ function sdkFactory(params) {
35
40
  splitFiltersValidation: settings.sync.__splitFiltersValidation,
36
41
  // ATM, only used by PluggableStorage
37
42
  mode: settings.mode,
43
+ impressionsMode: settings.sync.impressionsMode,
38
44
  // Callback used to emit SDK_READY in consumer mode, where `syncManagerFactory` is undefined,
39
45
  // or partial consumer mode, where it only has submitters, and therefore it doesn't emit readiness events.
40
46
  onReadyCb: function (error) {
@@ -48,15 +54,26 @@ function sdkFactory(params) {
48
54
  };
49
55
  var storage = storageFactory(storageFactoryParams);
50
56
  // @TODO add support for dataloader: `if (params.dataLoader) params.dataLoader(storage);`
51
- var integrationsManager = integrationsManagerFactory && integrationsManagerFactory({ settings: settings, storage: storage });
52
- // trackers
53
- var observer = impressionsObserverFactory && impressionsObserverFactory();
54
- var impressionsTracker = (0, impressionsTracker_1.impressionsTrackerFactory)(settings, storage.impressions, integrationsManager, observer, storage.impressionCounts, storage.telemetry);
55
- var eventTracker = (0, eventTracker_1.eventTrackerFactory)(settings, storage.events, integrationsManager, storage.telemetry);
56
57
  var telemetryTracker = (0, telemetryTracker_1.telemetryTrackerFactory)(storage.telemetry, platform.now);
58
+ var integrationsManager = integrationsManagerFactory && integrationsManagerFactory({ settings: settings, storage: storage, telemetryTracker: telemetryTracker });
59
+ var observer = impressionsObserverFactory();
60
+ var uniqueKeysTracker = storageFactoryParams.impressionsMode === constants_3.NONE ? (0, uniqueKeysTracker_1.uniqueKeysTrackerFactory)(log, storage.uniqueKeys, filterAdapterFactory && filterAdapterFactory()) : undefined;
61
+ var strategy;
62
+ switch (storageFactoryParams.impressionsMode) {
63
+ case constants_3.OPTIMIZED:
64
+ strategy = (0, strategyOptimized_1.strategyOptimizedFactory)(observer, storage.impressionCounts);
65
+ break;
66
+ case constants_3.NONE:
67
+ strategy = (0, strategyNone_1.strategyNoneFactory)(storage.impressionCounts, uniqueKeysTracker);
68
+ break;
69
+ default:
70
+ strategy = (0, strategyDebug_1.strategyDebugFactory)(observer);
71
+ }
72
+ var impressionsTracker = (0, impressionsTracker_1.impressionsTrackerFactory)(settings, storage.impressions, strategy, integrationsManager, storage.telemetry);
73
+ var eventTracker = (0, eventTracker_1.eventTrackerFactory)(settings, storage.events, integrationsManager, storage.telemetry);
57
74
  // splitApi is used by SyncManager and Browser signal listener
58
75
  var splitApi = splitApiFactory && splitApiFactory(settings, platform, telemetryTracker);
59
- var ctx = { splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform };
76
+ var ctx = { splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, uniqueKeysTracker: uniqueKeysTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform };
60
77
  var syncManager = syncManagerFactory && syncManagerFactory(ctx);
61
78
  ctx.syncManager = syncManager;
62
79
  var signalListener = SignalListener && new SignalListener(syncManager, settings, storage, splitApi);
@@ -15,15 +15,7 @@ function collectTreatments(splitObject) {
15
15
  // Then extract the treatments from the partitions
16
16
  return allTreatmentsCondition ? allTreatmentsCondition.partitions.map(function (v) { return v.treatment; }) : [];
17
17
  }
18
- function objectToView(json) {
19
- var splitObject;
20
- try {
21
- // @ts-expect-error
22
- splitObject = JSON.parse(json);
23
- }
24
- catch (e) {
25
- return null;
26
- }
18
+ function objectToView(splitObject) {
27
19
  if (!splitObject)
28
20
  return null;
29
21
  return {
@@ -35,9 +27,9 @@ function objectToView(json) {
35
27
  configs: splitObject.configurations || {}
36
28
  };
37
29
  }
38
- function objectsToViews(jsons) {
30
+ function objectsToViews(splitObjects) {
39
31
  var views = [];
40
- jsons.forEach(function (split) {
32
+ splitObjects.forEach(function (split) {
41
33
  var view = objectToView(split);
42
34
  if (view)
43
35
  views.push(view);
@@ -90,13 +90,33 @@ function splitApiFactory(settings, platform, telemetryTracker) {
90
90
  var url = urls.events + "/testImpressions/count";
91
91
  return splitHttpClient(url, { method: 'POST', body: body, headers: headers }, telemetryTracker.trackHttp(constants_1.IMPRESSIONS_COUNT));
92
92
  },
93
- postMetricsConfig: function (body) {
93
+ /**
94
+ * Post unique keys for client side.
95
+ *
96
+ * @param body unique keys payload
97
+ * @param headers Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
98
+ */
99
+ postUniqueKeysBulkCs: function (body, headers) {
100
+ var url = urls.telemetry + "/v1/keys/cs";
101
+ return splitHttpClient(url, { method: 'POST', body: body, headers: headers }, telemetryTracker.trackHttp(constants_1.TELEMETRY));
102
+ },
103
+ /**
104
+ * Post unique keys for server side.
105
+ *
106
+ * @param body unique keys payload
107
+ * @param headers Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
108
+ */
109
+ postUniqueKeysBulkSs: function (body, headers) {
110
+ var url = urls.telemetry + "/v1/keys/ss";
111
+ return splitHttpClient(url, { method: 'POST', body: body, headers: headers }, telemetryTracker.trackHttp(constants_1.TELEMETRY));
112
+ },
113
+ postMetricsConfig: function (body, headers) {
94
114
  var url = urls.telemetry + "/v1/metrics/config";
95
- return splitHttpClient(url, { method: 'POST', body: body }, telemetryTracker.trackHttp(constants_1.TELEMETRY), true);
115
+ return splitHttpClient(url, { method: 'POST', body: body, headers: headers }, telemetryTracker.trackHttp(constants_1.TELEMETRY), true);
96
116
  },
97
- postMetricsUsage: function (body) {
117
+ postMetricsUsage: function (body, headers) {
98
118
  var url = urls.telemetry + "/v1/metrics/usage";
99
- return splitHttpClient(url, { method: 'POST', body: body }, telemetryTracker.trackHttp(constants_1.TELEMETRY), true);
119
+ return splitHttpClient(url, { method: 'POST', body: body, headers: headers }, telemetryTracker.trackHttp(constants_1.TELEMETRY), true);
100
120
  }
101
121
  };
102
122
  }
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.AbstractSplitsCacheAsync = void 0;
4
+ var objectAssign_1 = require("../utils/lang/objectAssign");
4
5
  /**
5
6
  * This class provides a skeletal implementation of the ISplitsCacheAsync interface
6
7
  * to minimize the effort required to implement this interface.
@@ -27,22 +28,19 @@ var AbstractSplitsCacheAsync = /** @class */ (function () {
27
28
  * @param {string} name
28
29
  * @param {string} defaultTreatment
29
30
  * @param {number} changeNumber
30
- * @returns {Promise} a promise that is resolved once the split kill operation is performed. The fulfillment value is a boolean: `true` if the kill success updating the split or `false` if no split is updated,
31
+ * @returns {Promise} 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,
31
32
  * 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.
32
33
  * The promise will never be rejected.
33
34
  */
34
35
  AbstractSplitsCacheAsync.prototype.killLocally = function (name, defaultTreatment, changeNumber) {
35
36
  var _this = this;
36
37
  return this.getSplit(name).then(function (split) {
37
- if (split) {
38
- var parsedSplit = JSON.parse(split);
39
- if (!parsedSplit.changeNumber || parsedSplit.changeNumber < changeNumber) {
40
- parsedSplit.killed = true;
41
- parsedSplit.defaultTreatment = defaultTreatment;
42
- parsedSplit.changeNumber = changeNumber;
43
- var newSplit = JSON.stringify(parsedSplit);
44
- return _this.addSplit(name, newSplit);
45
- }
38
+ if (split && (!split.changeNumber || split.changeNumber < changeNumber)) {
39
+ var newSplit = (0, objectAssign_1.objectAssign)({}, split);
40
+ newSplit.killed = true;
41
+ newSplit.defaultTreatment = defaultTreatment;
42
+ newSplit.changeNumber = changeNumber;
43
+ return _this.addSplit(name, newSplit);
46
44
  }
47
45
  return false;
48
46
  }).catch(function () { return false; });
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.usesSegments = exports.AbstractSplitsCacheSync = void 0;
4
+ var objectAssign_1 = require("../utils/lang/objectAssign");
4
5
  /**
5
6
  * This class provides a skeletal implementation of the ISplitsCacheSync interface
6
7
  * to minimize the effort required to implement this interface.
@@ -42,20 +43,17 @@ var AbstractSplitsCacheSync = /** @class */ (function () {
42
43
  * @param {string} name
43
44
  * @param {string} defaultTreatment
44
45
  * @param {number} changeNumber
45
- * @returns {Promise} a promise that is resolved once the split kill is performed. The fulfillment value is a boolean: `true` if the kill success updating the split or `false` if no split is updated,
46
+ * @returns {boolean} `true` if the operation successed updating the split, or `false` if no split is updated,
46
47
  * 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.
47
48
  */
48
49
  AbstractSplitsCacheSync.prototype.killLocally = function (name, defaultTreatment, changeNumber) {
49
50
  var split = this.getSplit(name);
50
- if (split) {
51
- var parsedSplit = JSON.parse(split);
52
- if (!parsedSplit.changeNumber || parsedSplit.changeNumber < changeNumber) {
53
- parsedSplit.killed = true;
54
- parsedSplit.defaultTreatment = defaultTreatment;
55
- parsedSplit.changeNumber = changeNumber;
56
- var newSplit = JSON.stringify(parsedSplit);
57
- return this.addSplit(name, newSplit);
58
- }
51
+ if (split && (!split.changeNumber || split.changeNumber < changeNumber)) {
52
+ var newSplit = (0, objectAssign_1.objectAssign)({}, split);
53
+ newSplit.killed = true;
54
+ newSplit.defaultTreatment = defaultTreatment;
55
+ newSplit.changeNumber = changeNumber;
56
+ return this.addSplit(name, newSplit);
59
57
  }
60
58
  return false;
61
59
  };
@@ -1,9 +1,10 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.KeyBuilderSS = void 0;
3
+ exports.parseLatencyField = exports.parseExceptionField = exports.parseMetadata = exports.KeyBuilderSS = void 0;
4
4
  var tslib_1 = require("tslib");
5
5
  var KeyBuilder_1 = require("./KeyBuilder");
6
- var methodNames = {
6
+ var TelemetryCacheInMemory_1 = require("./inMemory/TelemetryCacheInMemory");
7
+ var METHOD_NAMES = {
7
8
  t: 'treatment',
8
9
  ts: 'treatments',
9
10
  tc: 'treatmentWithConfig',
@@ -14,7 +15,10 @@ var KeyBuilderSS = /** @class */ (function (_super) {
14
15
  (0, tslib_1.__extends)(KeyBuilderSS, _super);
15
16
  function KeyBuilderSS(prefix, metadata) {
16
17
  var _this = _super.call(this, prefix) || this;
17
- _this.metadata = metadata;
18
+ _this.latencyPrefix = _this.prefix + ".telemetry.latencies";
19
+ _this.exceptionPrefix = _this.prefix + ".telemetry.exceptions";
20
+ _this.initPrefix = _this.prefix + ".telemetry.init";
21
+ _this.versionablePrefix = metadata.s + "/" + metadata.n + "/" + metadata.i;
18
22
  return _this;
19
23
  }
20
24
  KeyBuilderSS.prototype.buildRegisteredSegmentsKey = function () {
@@ -23,6 +27,12 @@ var KeyBuilderSS = /** @class */ (function (_super) {
23
27
  KeyBuilderSS.prototype.buildImpressionsKey = function () {
24
28
  return this.prefix + ".impressions";
25
29
  };
30
+ KeyBuilderSS.prototype.buildImpressionsCountKey = function () {
31
+ return this.prefix + ".impressions.count";
32
+ };
33
+ KeyBuilderSS.prototype.buildUniqueKeysKey = function () {
34
+ return this.prefix + ".uniquekeys";
35
+ };
26
36
  KeyBuilderSS.prototype.buildEventsKey = function () {
27
37
  return this.prefix + ".events";
28
38
  };
@@ -31,17 +41,52 @@ var KeyBuilderSS = /** @class */ (function (_super) {
31
41
  };
32
42
  /* Telemetry keys */
33
43
  KeyBuilderSS.prototype.buildLatencyKey = function (method, bucket) {
34
- return this.prefix + ".telemetry.latencies::" + this.buildVersionablePrefix() + "/" + methodNames[method] + "/" + bucket;
44
+ return this.latencyPrefix + "::" + this.versionablePrefix + "/" + METHOD_NAMES[method] + "/" + bucket;
35
45
  };
36
46
  KeyBuilderSS.prototype.buildExceptionKey = function (method) {
37
- return this.prefix + ".telemetry.exceptions::" + this.buildVersionablePrefix() + "/" + methodNames[method];
47
+ return this.exceptionPrefix + "::" + this.versionablePrefix + "/" + METHOD_NAMES[method];
38
48
  };
39
49
  KeyBuilderSS.prototype.buildInitKey = function () {
40
- return this.prefix + ".telemetry.init::" + this.buildVersionablePrefix();
41
- };
42
- KeyBuilderSS.prototype.buildVersionablePrefix = function () {
43
- return this.metadata.s + "/" + this.metadata.n + "/" + this.metadata.i;
50
+ return this.initPrefix + "::" + this.versionablePrefix;
44
51
  };
45
52
  return KeyBuilderSS;
46
53
  }(KeyBuilder_1.KeyBuilder));
47
54
  exports.KeyBuilderSS = KeyBuilderSS;
55
+ // Used by consumer methods of TelemetryCacheInRedis and TelemetryCachePluggable
56
+ var REVERSE_METHOD_NAMES = Object.keys(METHOD_NAMES).reduce(function (acc, key) {
57
+ acc[METHOD_NAMES[key]] = key;
58
+ return acc;
59
+ }, {});
60
+ function parseMetadata(field) {
61
+ var parts = field.split('/');
62
+ if (parts.length !== 3)
63
+ return "invalid subsection count. Expected 3, got: " + parts.length;
64
+ var s = parts[0] /* metadata.s */, n = parts[1] /* metadata.n */, i = parts[2] /* metadata.i */;
65
+ return [JSON.stringify({ s: s, n: n, i: i })];
66
+ }
67
+ exports.parseMetadata = parseMetadata;
68
+ function parseExceptionField(field) {
69
+ var parts = field.split('/');
70
+ if (parts.length !== 4)
71
+ return "invalid subsection count. Expected 4, got: " + parts.length;
72
+ var s = parts[0] /* metadata.s */, n = parts[1] /* metadata.n */, i = parts[2] /* metadata.i */, m = parts[3];
73
+ var method = REVERSE_METHOD_NAMES[m];
74
+ if (!method)
75
+ return "unknown method '" + m + "'";
76
+ return [JSON.stringify({ s: s, n: n, i: i }), method];
77
+ }
78
+ exports.parseExceptionField = parseExceptionField;
79
+ function parseLatencyField(field) {
80
+ var parts = field.split('/');
81
+ if (parts.length !== 5)
82
+ return "invalid subsection count. Expected 5, got: " + parts.length;
83
+ var s = parts[0] /* metadata.s */, n = parts[1] /* metadata.n */, i = parts[2] /* metadata.i */, m = parts[3], b = parts[4];
84
+ var method = REVERSE_METHOD_NAMES[m];
85
+ if (!method)
86
+ return "unknown method '" + m + "'";
87
+ var bucket = parseInt(b);
88
+ if (isNaN(bucket) || bucket >= TelemetryCacheInMemory_1.MAX_LATENCY_BUCKET_COUNT)
89
+ return "invalid bucket. Expected a number between 0 and " + (TelemetryCacheInMemory_1.MAX_LATENCY_BUCKET_COUNT - 1) + ", got: " + b;
90
+ return [JSON.stringify({ s: s, n: n, i: i }), method, bucket];
91
+ }
92
+ exports.parseLatencyField = parseLatencyField;
@@ -35,7 +35,7 @@ function dataLoaderFactory(preloadedData) {
35
35
  storage.splits.clear();
36
36
  storage.splits.setChangeNumber(since);
37
37
  // splitsData in an object where the property is the split name and the pertaining value is a stringified json of its data
38
- storage.splits.addSplits(Object.keys(splitsData).map(function (splitName) { return [splitName, splitsData[splitName]]; }));
38
+ storage.splits.addSplits(Object.keys(splitsData).map(function (splitName) { return JSON.parse(splitsData[splitName]); }));
39
39
  // add mySegments data
40
40
  var mySegmentsData = preloadedData.mySegmentsData && preloadedData.mySegmentsData[userId];
41
41
  if (!mySegmentsData) {
@@ -96,9 +96,8 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
96
96
  var splitFromLocalStorage = localStorage.getItem(splitKey);
97
97
  var previousSplit = splitFromLocalStorage ? JSON.parse(splitFromLocalStorage) : null;
98
98
  this._decrementCounts(previousSplit);
99
- localStorage.setItem(splitKey, split);
100
- var parsedSplit = split ? JSON.parse(split) : null;
101
- this._incrementCounts(parsedSplit);
99
+ localStorage.setItem(splitKey, JSON.stringify(split));
100
+ this._incrementCounts(split);
102
101
  return true;
103
102
  }
104
103
  catch (e) {
@@ -110,8 +109,7 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
110
109
  try {
111
110
  var split = this.getSplit(name);
112
111
  localStorage.removeItem(this.keys.buildSplitKey(name));
113
- var parsedSplit = JSON.parse(split);
114
- this._decrementCounts(parsedSplit);
112
+ this._decrementCounts(split);
115
113
  return true;
116
114
  }
117
115
  catch (e) {
@@ -120,7 +118,8 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
120
118
  }
121
119
  };
122
120
  SplitsCacheInLocal.prototype.getSplit = function (name) {
123
- return localStorage.getItem(this.keys.buildSplitKey(name));
121
+ var item = localStorage.getItem(this.keys.buildSplitKey(name));
122
+ return item && JSON.parse(item);
124
123
  };
125
124
  SplitsCacheInLocal.prototype.setChangeNumber = function (changeNumber) {
126
125
  // when cache is ready but using a new split query, we must clear all split data
@@ -204,7 +203,6 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
204
203
  };
205
204
  /**
206
205
  * Clean Splits cache if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
207
- * Clean operation (clear) also updates `lastUpdated` timestamp with current time.
208
206
  *
209
207
  * @param {number | undefined} expirationTimestamp if the value is not a number, data will not be cleaned
210
208
  */