@splitsoftware/splitio-commons 2.0.1 → 2.0.3-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/CHANGES.txt +8 -0
  2. package/cjs/evaluator/index.js +2 -0
  3. package/cjs/listeners/browser.js +4 -6
  4. package/cjs/readiness/readinessManager.js +16 -18
  5. package/cjs/sdkClient/client.js +13 -13
  6. package/cjs/sdkClient/sdkClient.js +1 -1
  7. package/cjs/sdkFactory/index.js +10 -14
  8. package/cjs/sdkManager/index.js +2 -1
  9. package/cjs/services/decorateHeaders.js +6 -1
  10. package/cjs/services/splitHttpClient.js +1 -1
  11. package/cjs/storages/inLocalStorage/index.js +6 -20
  12. package/cjs/storages/inMemory/InMemoryStorage.js +4 -12
  13. package/cjs/storages/inMemory/InMemoryStorageCS.js +6 -19
  14. package/cjs/storages/inRedis/index.js +9 -13
  15. package/cjs/storages/pluggable/index.js +15 -19
  16. package/cjs/sync/submitters/impressionCountsSubmitter.js +2 -4
  17. package/cjs/sync/submitters/submitterManager.js +3 -6
  18. package/cjs/trackers/impressionsTracker.js +17 -18
  19. package/cjs/trackers/strategy/strategyDebug.js +4 -11
  20. package/cjs/trackers/strategy/strategyNone.js +11 -16
  21. package/cjs/trackers/strategy/strategyOptimized.js +11 -21
  22. package/esm/evaluator/index.js +2 -0
  23. package/esm/listeners/browser.js +1 -3
  24. package/esm/readiness/readinessManager.js +16 -18
  25. package/esm/sdkClient/client.js +13 -13
  26. package/esm/sdkClient/sdkClient.js +1 -1
  27. package/esm/sdkFactory/index.js +11 -15
  28. package/esm/sdkManager/index.js +2 -1
  29. package/esm/services/decorateHeaders.js +4 -0
  30. package/esm/services/splitHttpClient.js +2 -2
  31. package/esm/storages/inLocalStorage/index.js +7 -21
  32. package/esm/storages/inMemory/InMemoryStorage.js +5 -13
  33. package/esm/storages/inMemory/InMemoryStorageCS.js +7 -20
  34. package/esm/storages/inRedis/index.js +10 -14
  35. package/esm/storages/pluggable/index.js +16 -20
  36. package/esm/sync/submitters/impressionCountsSubmitter.js +2 -4
  37. package/esm/sync/submitters/submitterManager.js +3 -6
  38. package/esm/trackers/impressionsTracker.js +17 -18
  39. package/esm/trackers/strategy/strategyDebug.js +4 -11
  40. package/esm/trackers/strategy/strategyNone.js +11 -16
  41. package/esm/trackers/strategy/strategyOptimized.js +11 -21
  42. package/package.json +1 -1
  43. package/src/dtos/types.ts +2 -1
  44. package/src/evaluator/index.ts +2 -0
  45. package/src/evaluator/types.ts +1 -1
  46. package/src/listeners/browser.ts +1 -3
  47. package/src/readiness/readinessManager.ts +15 -16
  48. package/src/sdkClient/client.ts +11 -11
  49. package/src/sdkClient/sdkClient.ts +1 -1
  50. package/src/sdkFactory/index.ts +12 -16
  51. package/src/sdkFactory/types.ts +1 -1
  52. package/src/sdkManager/index.ts +2 -1
  53. package/src/services/decorateHeaders.ts +5 -0
  54. package/src/services/splitHttpClient.ts +2 -2
  55. package/src/storages/inLocalStorage/index.ts +7 -20
  56. package/src/storages/inMemory/InMemoryStorage.ts +5 -13
  57. package/src/storages/inMemory/InMemoryStorageCS.ts +7 -20
  58. package/src/storages/inRedis/index.ts +10 -10
  59. package/src/storages/pluggable/index.ts +16 -20
  60. package/src/storages/types.ts +2 -2
  61. package/src/sync/submitters/impressionCountsSubmitter.ts +2 -4
  62. package/src/sync/submitters/submitterManager.ts +3 -4
  63. package/src/sync/submitters/uniqueKeysSubmitter.ts +2 -3
  64. package/src/trackers/impressionsTracker.ts +17 -18
  65. package/src/trackers/strategy/strategyDebug.ts +4 -11
  66. package/src/trackers/strategy/strategyNone.ts +11 -17
  67. package/src/trackers/strategy/strategyOptimized.ts +10 -20
  68. package/src/trackers/types.ts +2 -8
  69. package/types/splitio.d.ts +4 -0
@@ -31,7 +31,8 @@ function objectToView(splitObject: ISplit | null): SplitIO.SplitView | null {
31
31
  treatments: collectTreatments(splitObject),
32
32
  configs: splitObject.configurations || {},
33
33
  sets: splitObject.sets || [],
34
- defaultTreatment: splitObject.defaultTreatment
34
+ defaultTreatment: splitObject.defaultTreatment,
35
+ trackImpressions: splitObject.trackImpressions !== false
35
36
  };
36
37
  }
37
38
 
@@ -30,3 +30,8 @@ export function decorateHeaders(settings: ISettings, headers: Record<string, str
30
30
  }
31
31
  return headers;
32
32
  }
33
+
34
+ export function removeNonISO88591(input: string) {
35
+ // eslint-disable-next-line no-control-regex
36
+ return input.replace(/[^\x00-\xFF]/g, '');
37
+ }
@@ -3,7 +3,7 @@ import { objectAssign } from '../utils/lang/objectAssign';
3
3
  import { ERROR_HTTP, ERROR_CLIENT_CANNOT_GET_READY } from '../logger/constants';
4
4
  import { ISettings } from '../types';
5
5
  import { IPlatform } from '../sdkFactory/types';
6
- import { decorateHeaders } from './decorateHeaders';
6
+ import { decorateHeaders, removeNonISO88591 } from './decorateHeaders';
7
7
 
8
8
  const messageNoFetch = 'Global fetch API is not available.';
9
9
 
@@ -30,7 +30,7 @@ export function splitHttpClientFactory(settings: ISettings, { getOptions, getFet
30
30
  };
31
31
 
32
32
  if (ip) commonHeaders['SplitSDKMachineIP'] = ip;
33
- if (hostname) commonHeaders['SplitSDKMachineName'] = hostname;
33
+ if (hostname) commonHeaders['SplitSDKMachineName'] = removeNonISO88591(hostname);
34
34
 
35
35
  return function httpClient(url: string, reqOpts: IRequestOptions = {}, latencyTracker: (error?: NetworkError) => void = () => { }, logErrorsAsInfo: boolean = false): Promise<IResponse> {
36
36
 
@@ -7,12 +7,10 @@ import { KeyBuilderCS, myLargeSegmentsKeyBuilder } from '../KeyBuilderCS';
7
7
  import { isLocalStorageAvailable } from '../../utils/env/isLocalStorageAvailable';
8
8
  import { SplitsCacheInLocal } from './SplitsCacheInLocal';
9
9
  import { MySegmentsCacheInLocal } from './MySegmentsCacheInLocal';
10
- import { MySegmentsCacheInMemory } from '../inMemory/MySegmentsCacheInMemory';
11
- import { SplitsCacheInMemory } from '../inMemory/SplitsCacheInMemory';
12
10
  import { DEFAULT_CACHE_EXPIRATION_IN_MILLIS } from '../../utils/constants/browser';
13
11
  import { InMemoryStorageCSFactory } from '../inMemory/InMemoryStorageCS';
14
12
  import { LOG_PREFIX } from './constants';
15
- import { DEBUG, NONE, STORAGE_LOCALSTORAGE } from '../../utils/constants';
13
+ import { STORAGE_LOCALSTORAGE } from '../../utils/constants';
16
14
  import { shouldRecordTelemetry, TelemetryCacheInMemory } from '../inMemory/TelemetryCacheInMemory';
17
15
  import { UniqueKeysCacheInMemoryCS } from '../inMemory/UniqueKeysCacheInMemoryCS';
18
16
  import { getMatching } from '../../utils/key';
@@ -36,7 +34,7 @@ export function InLocalStorage(options: InLocalStorageOptions = {}): IStorageSyn
36
34
  return InMemoryStorageCSFactory(params);
37
35
  }
38
36
 
39
- const { settings, settings: { log, scheduler: { impressionsQueueSize, eventsQueueSize, }, sync: { impressionsMode, __splitFiltersValidation } } } = params;
37
+ const { settings, settings: { log, scheduler: { impressionsQueueSize, eventsQueueSize } } } = params;
40
38
  const matchingKey = getMatching(settings.core.key);
41
39
  const keys = new KeyBuilderCS(prefix, matchingKey);
42
40
  const expirationTimestamp = Date.now() - DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
@@ -50,20 +48,12 @@ export function InLocalStorage(options: InLocalStorageOptions = {}): IStorageSyn
50
48
  segments,
51
49
  largeSegments,
52
50
  impressions: new ImpressionsCacheInMemory(impressionsQueueSize),
53
- impressionCounts: impressionsMode !== DEBUG ? new ImpressionCountsCacheInMemory() : undefined,
51
+ impressionCounts: new ImpressionCountsCacheInMemory(),
54
52
  events: new EventsCacheInMemory(eventsQueueSize),
55
53
  telemetry: shouldRecordTelemetry(params) ? new TelemetryCacheInMemory(splits, segments) : undefined,
56
- uniqueKeys: impressionsMode === NONE ? new UniqueKeysCacheInMemoryCS() : undefined,
54
+ uniqueKeys: new UniqueKeysCacheInMemoryCS(),
57
55
 
58
- destroy() {
59
- this.splits = new SplitsCacheInMemory(__splitFiltersValidation);
60
- this.segments = new MySegmentsCacheInMemory();
61
- this.largeSegments = new MySegmentsCacheInMemory();
62
- this.impressions.clear();
63
- this.impressionCounts && this.impressionCounts.clear();
64
- this.events.clear();
65
- this.uniqueKeys?.clear();
66
- },
56
+ destroy() { },
67
57
 
68
58
  // When using shared instantiation with MEMORY we reuse everything but segments (they are customer per key).
69
59
  shared(matchingKey: string) {
@@ -76,12 +66,9 @@ export function InLocalStorage(options: InLocalStorageOptions = {}): IStorageSyn
76
66
  impressionCounts: this.impressionCounts,
77
67
  events: this.events,
78
68
  telemetry: this.telemetry,
69
+ uniqueKeys: this.uniqueKeys,
79
70
 
80
- destroy() {
81
- this.splits = new SplitsCacheInMemory(__splitFiltersValidation);
82
- this.segments = new MySegmentsCacheInMemory();
83
- this.largeSegments = new MySegmentsCacheInMemory();
84
- }
71
+ destroy() { }
85
72
  };
86
73
  },
87
74
  };
@@ -4,7 +4,7 @@ import { ImpressionsCacheInMemory } from './ImpressionsCacheInMemory';
4
4
  import { EventsCacheInMemory } from './EventsCacheInMemory';
5
5
  import { IStorageFactoryParams, IStorageSync } from '../types';
6
6
  import { ImpressionCountsCacheInMemory } from './ImpressionCountsCacheInMemory';
7
- import { DEBUG, LOCALHOST_MODE, NONE, STORAGE_MEMORY } from '../../utils/constants';
7
+ import { LOCALHOST_MODE, STORAGE_MEMORY } from '../../utils/constants';
8
8
  import { shouldRecordTelemetry, TelemetryCacheInMemory } from './TelemetryCacheInMemory';
9
9
  import { UniqueKeysCacheInMemory } from './UniqueKeysCacheInMemory';
10
10
 
@@ -14,7 +14,7 @@ import { UniqueKeysCacheInMemory } from './UniqueKeysCacheInMemory';
14
14
  * @param params - parameters required by EventsCacheSync
15
15
  */
16
16
  export function InMemoryStorageFactory(params: IStorageFactoryParams): IStorageSync {
17
- const { settings: { scheduler: { impressionsQueueSize, eventsQueueSize, }, sync: { impressionsMode, __splitFiltersValidation } } } = params;
17
+ const { settings: { scheduler: { impressionsQueueSize, eventsQueueSize, }, sync: { __splitFiltersValidation } } } = params;
18
18
 
19
19
  const splits = new SplitsCacheInMemory(__splitFiltersValidation);
20
20
  const segments = new SegmentsCacheInMemory();
@@ -23,20 +23,12 @@ export function InMemoryStorageFactory(params: IStorageFactoryParams): IStorageS
23
23
  splits,
24
24
  segments,
25
25
  impressions: new ImpressionsCacheInMemory(impressionsQueueSize),
26
- impressionCounts: impressionsMode !== DEBUG ? new ImpressionCountsCacheInMemory() : undefined,
26
+ impressionCounts: new ImpressionCountsCacheInMemory(),
27
27
  events: new EventsCacheInMemory(eventsQueueSize),
28
28
  telemetry: shouldRecordTelemetry(params) ? new TelemetryCacheInMemory(splits, segments) : undefined,
29
- uniqueKeys: impressionsMode === NONE ? new UniqueKeysCacheInMemory() : undefined,
29
+ uniqueKeys: new UniqueKeysCacheInMemory(),
30
30
 
31
- // When using MEMORY we should clean all the caches to leave them empty
32
- destroy() {
33
- this.splits.clear();
34
- this.segments.clear();
35
- this.impressions.clear();
36
- this.impressionCounts && this.impressionCounts.clear();
37
- this.events.clear();
38
- this.uniqueKeys && this.uniqueKeys.clear();
39
- }
31
+ destroy() { }
40
32
  };
41
33
 
42
34
  // @TODO revisit storage logic in localhost mode
@@ -4,7 +4,7 @@ import { ImpressionsCacheInMemory } from './ImpressionsCacheInMemory';
4
4
  import { EventsCacheInMemory } from './EventsCacheInMemory';
5
5
  import { IStorageSync, IStorageFactoryParams } from '../types';
6
6
  import { ImpressionCountsCacheInMemory } from './ImpressionCountsCacheInMemory';
7
- import { DEBUG, LOCALHOST_MODE, NONE, STORAGE_MEMORY } from '../../utils/constants';
7
+ import { LOCALHOST_MODE, STORAGE_MEMORY } from '../../utils/constants';
8
8
  import { shouldRecordTelemetry, TelemetryCacheInMemory } from './TelemetryCacheInMemory';
9
9
  import { UniqueKeysCacheInMemoryCS } from './UniqueKeysCacheInMemoryCS';
10
10
 
@@ -14,7 +14,7 @@ import { UniqueKeysCacheInMemoryCS } from './UniqueKeysCacheInMemoryCS';
14
14
  * @param params - parameters required by EventsCacheSync
15
15
  */
16
16
  export function InMemoryStorageCSFactory(params: IStorageFactoryParams): IStorageSync {
17
- const { settings: { scheduler: { impressionsQueueSize, eventsQueueSize, }, sync: { impressionsMode, __splitFiltersValidation } } } = params;
17
+ const { settings: { scheduler: { impressionsQueueSize, eventsQueueSize }, sync: { __splitFiltersValidation } } } = params;
18
18
 
19
19
  const splits = new SplitsCacheInMemory(__splitFiltersValidation);
20
20
  const segments = new MySegmentsCacheInMemory();
@@ -25,21 +25,12 @@ export function InMemoryStorageCSFactory(params: IStorageFactoryParams): IStorag
25
25
  segments,
26
26
  largeSegments,
27
27
  impressions: new ImpressionsCacheInMemory(impressionsQueueSize),
28
- impressionCounts: impressionsMode !== DEBUG ? new ImpressionCountsCacheInMemory() : undefined,
28
+ impressionCounts: new ImpressionCountsCacheInMemory(),
29
29
  events: new EventsCacheInMemory(eventsQueueSize),
30
30
  telemetry: shouldRecordTelemetry(params) ? new TelemetryCacheInMemory(splits, segments) : undefined,
31
- uniqueKeys: impressionsMode === NONE ? new UniqueKeysCacheInMemoryCS() : undefined,
31
+ uniqueKeys: new UniqueKeysCacheInMemoryCS(),
32
32
 
33
- // When using MEMORY we should clean all the caches to leave them empty
34
- destroy() {
35
- this.splits.clear();
36
- this.segments.clear();
37
- this.largeSegments.clear();
38
- this.impressions.clear();
39
- this.impressionCounts && this.impressionCounts.clear();
40
- this.events.clear();
41
- this.uniqueKeys && this.uniqueKeys.clear();
42
- },
33
+ destroy() { },
43
34
 
44
35
  // When using shared instantiation with MEMORY we reuse everything but segments (they are unique per key)
45
36
  shared() {
@@ -51,13 +42,9 @@ export function InMemoryStorageCSFactory(params: IStorageFactoryParams): IStorag
51
42
  impressionCounts: this.impressionCounts,
52
43
  events: this.events,
53
44
  telemetry: this.telemetry,
45
+ uniqueKeys: this.uniqueKeys,
54
46
 
55
- // Set a new splits cache to clean it for the client without affecting other clients
56
- destroy() {
57
- this.splits = new SplitsCacheInMemory(__splitFiltersValidation);
58
- this.segments.clear();
59
- this.largeSegments.clear();
60
- }
47
+ destroy() { }
61
48
  };
62
49
  },
63
50
  };
@@ -6,7 +6,7 @@ import { SplitsCacheInRedis } from './SplitsCacheInRedis';
6
6
  import { SegmentsCacheInRedis } from './SegmentsCacheInRedis';
7
7
  import { ImpressionsCacheInRedis } from './ImpressionsCacheInRedis';
8
8
  import { EventsCacheInRedis } from './EventsCacheInRedis';
9
- import { DEBUG, NONE, STORAGE_REDIS } from '../../utils/constants';
9
+ import { STORAGE_REDIS } from '../../utils/constants';
10
10
  import { TelemetryCacheInRedis } from './TelemetryCacheInRedis';
11
11
  import { UniqueKeysCacheInRedis } from './UniqueKeysCacheInRedis';
12
12
  import { ImpressionCountsCacheInRedis } from './ImpressionCountsCacheInRedis';
@@ -30,19 +30,19 @@ export function InRedisStorage(options: InRedisStorageOptions = {}): IStorageAsy
30
30
  const prefix = validatePrefix(options.prefix);
31
31
 
32
32
  function InRedisStorageFactory(params: IStorageFactoryParams): IStorageAsync {
33
- const { onReadyCb, settings, settings: { log, sync: { impressionsMode } } } = params;
33
+ const { onReadyCb, settings, settings: { log } } = params;
34
34
  const metadata = metadataBuilder(settings);
35
35
  const keys = new KeyBuilderSS(prefix, metadata);
36
36
  const redisClient: RedisAdapter = new RD(log, options.options || {});
37
37
  const telemetry = new TelemetryCacheInRedis(log, keys, redisClient);
38
- const impressionCountsCache = impressionsMode !== DEBUG ? new ImpressionCountsCacheInRedis(log, keys.buildImpressionsCountKey(), redisClient) : undefined;
39
- const uniqueKeysCache = impressionsMode === NONE ? new UniqueKeysCacheInRedis(log, keys.buildUniqueKeysKey(), redisClient) : undefined;
38
+ const impressionCountsCache = new ImpressionCountsCacheInRedis(log, keys.buildImpressionsCountKey(), redisClient);
39
+ const uniqueKeysCache = new UniqueKeysCacheInRedis(log, keys.buildUniqueKeysKey(), redisClient);
40
40
 
41
41
  // subscription to Redis connect event in order to emit SDK_READY event on consumer mode
42
42
  redisClient.on('connect', () => {
43
43
  onReadyCb();
44
- if (impressionCountsCache) impressionCountsCache.start();
45
- if (uniqueKeysCache) uniqueKeysCache.start();
44
+ impressionCountsCache.start();
45
+ uniqueKeysCache.start();
46
46
 
47
47
  // Synchronize config
48
48
  telemetry.recordConfig();
@@ -60,10 +60,10 @@ export function InRedisStorage(options: InRedisStorageOptions = {}): IStorageAsy
60
60
  // When using REDIS we should:
61
61
  // 1- Disconnect from the storage
62
62
  destroy(): Promise<void> {
63
- let promises = [];
64
- if (impressionCountsCache) promises.push(impressionCountsCache.stop());
65
- if (uniqueKeysCache) promises.push(uniqueKeysCache.stop());
66
- return Promise.all(promises).then(() => { redisClient.disconnect(); });
63
+ return Promise.all([
64
+ impressionCountsCache.stop(),
65
+ uniqueKeysCache.stop()
66
+ ]).then(() => { redisClient.disconnect(); });
67
67
  // @TODO check that caches works as expected when redisClient is disconnected
68
68
  }
69
69
  };
@@ -8,7 +8,7 @@ import { EventsCachePluggable } from './EventsCachePluggable';
8
8
  import { wrapperAdapter, METHODS_TO_PROMISE_WRAP } from './wrapperAdapter';
9
9
  import { isObject } from '../../utils/lang';
10
10
  import { getStorageHash, validatePrefix } from '../KeyBuilder';
11
- import { CONSUMER_PARTIAL_MODE, DEBUG, NONE, STORAGE_PLUGGABLE } from '../../utils/constants';
11
+ import { CONSUMER_PARTIAL_MODE, STORAGE_PLUGGABLE } from '../../utils/constants';
12
12
  import { ImpressionsCacheInMemory } from '../inMemory/ImpressionsCacheInMemory';
13
13
  import { EventsCacheInMemory } from '../inMemory/EventsCacheInMemory';
14
14
  import { ImpressionCountsCacheInMemory } from '../inMemory/ImpressionCountsCacheInMemory';
@@ -63,35 +63,31 @@ export function PluggableStorage(options: PluggableStorageOptions): IStorageAsyn
63
63
  const prefix = validatePrefix(options.prefix);
64
64
 
65
65
  function PluggableStorageFactory(params: IStorageFactoryParams): IStorageAsync {
66
- const { onReadyCb, settings, settings: { log, mode, sync: { impressionsMode }, scheduler: { impressionsQueueSize, eventsQueueSize } } } = params;
66
+ const { onReadyCb, settings, settings: { log, mode, scheduler: { impressionsQueueSize, eventsQueueSize } } } = params;
67
67
  const metadata = metadataBuilder(settings);
68
68
  const keys = new KeyBuilderSS(prefix, metadata);
69
69
  const wrapper = wrapperAdapter(log, options.wrapper);
70
70
 
71
- const isSyncronizer = mode === undefined; // If mode is not defined, the synchronizer is running
71
+ const isSynchronizer = mode === undefined; // If mode is not defined, the synchronizer is running
72
72
  const isPartialConsumer = mode === CONSUMER_PARTIAL_MODE;
73
73
 
74
- const telemetry = shouldRecordTelemetry(params) || isSyncronizer ?
74
+ const telemetry = shouldRecordTelemetry(params) || isSynchronizer ?
75
75
  isPartialConsumer ?
76
76
  new TelemetryCacheInMemory() :
77
77
  new TelemetryCachePluggable(log, keys, wrapper) :
78
78
  undefined;
79
79
 
80
- const impressionCountsCache = impressionsMode !== DEBUG || isSyncronizer ?
81
- isPartialConsumer ?
82
- new ImpressionCountsCacheInMemory() :
83
- new ImpressionCountsCachePluggable(log, keys.buildImpressionsCountKey(), wrapper) :
84
- undefined;
80
+ const impressionCountsCache = isPartialConsumer ?
81
+ new ImpressionCountsCacheInMemory() :
82
+ new ImpressionCountsCachePluggable(log, keys.buildImpressionsCountKey(), wrapper);
85
83
 
86
- const uniqueKeysCache = impressionsMode === NONE || isSyncronizer ?
87
- isPartialConsumer ?
88
- settings.core.key === undefined ? new UniqueKeysCacheInMemory() : new UniqueKeysCacheInMemoryCS() :
89
- new UniqueKeysCachePluggable(log, keys.buildUniqueKeysKey(), wrapper) :
90
- undefined;
84
+ const uniqueKeysCache = isPartialConsumer ?
85
+ settings.core.key === undefined ? new UniqueKeysCacheInMemory() : new UniqueKeysCacheInMemoryCS() :
86
+ new UniqueKeysCachePluggable(log, keys.buildUniqueKeysKey(), wrapper);
91
87
 
92
88
  // Connects to wrapper and emits SDK_READY event on main client
93
89
  const connectPromise = wrapper.connect().then(() => {
94
- if (isSyncronizer) {
90
+ if (isSynchronizer) {
95
91
  // In standalone or producer mode, clear storage if SDK key or feature flag filter has changed
96
92
  return wrapper.get(keys.buildHashKey()).then((hash) => {
97
93
  const currentHash = getStorageHash(settings);
@@ -106,8 +102,8 @@ export function PluggableStorage(options: PluggableStorageOptions): IStorageAsyn
106
102
  });
107
103
  } else {
108
104
  // Start periodic flush of async storages if not running synchronizer (producer mode)
109
- if (impressionCountsCache && (impressionCountsCache as ImpressionCountsCachePluggable).start) (impressionCountsCache as ImpressionCountsCachePluggable).start();
110
- if (uniqueKeysCache && (uniqueKeysCache as UniqueKeysCachePluggable).start) (uniqueKeysCache as UniqueKeysCachePluggable).start();
105
+ if ((impressionCountsCache as ImpressionCountsCachePluggable).start) (impressionCountsCache as ImpressionCountsCachePluggable).start();
106
+ if ((uniqueKeysCache as UniqueKeysCachePluggable).start) (uniqueKeysCache as UniqueKeysCachePluggable).start();
111
107
  if (telemetry && (telemetry as ITelemetryCacheAsync).recordConfig) (telemetry as ITelemetryCacheAsync).recordConfig();
112
108
 
113
109
  onReadyCb();
@@ -129,9 +125,9 @@ export function PluggableStorage(options: PluggableStorageOptions): IStorageAsyn
129
125
 
130
126
  // Stop periodic flush and disconnect the underlying storage
131
127
  destroy() {
132
- return Promise.all(isSyncronizer ? [] : [
133
- impressionCountsCache && (impressionCountsCache as ImpressionCountsCachePluggable).stop && (impressionCountsCache as ImpressionCountsCachePluggable).stop(),
134
- uniqueKeysCache && (uniqueKeysCache as UniqueKeysCachePluggable).stop && (uniqueKeysCache as UniqueKeysCachePluggable).stop(),
128
+ return Promise.all(isSynchronizer ? [] : [
129
+ (impressionCountsCache as ImpressionCountsCachePluggable).stop && (impressionCountsCache as ImpressionCountsCachePluggable).stop(),
130
+ (uniqueKeysCache as UniqueKeysCachePluggable).stop && (uniqueKeysCache as UniqueKeysCachePluggable).stop(),
135
131
  ]).then(() => wrapper.disconnect());
136
132
  },
137
133
 
@@ -439,10 +439,10 @@ export interface IStorageBase<
439
439
  splits: TSplitsCache,
440
440
  segments: TSegmentsCache,
441
441
  impressions: TImpressionsCache,
442
- impressionCounts?: TImpressionsCountCache,
442
+ impressionCounts: TImpressionsCountCache,
443
443
  events: TEventsCache,
444
444
  telemetry?: TTelemetryCache,
445
- uniqueKeys?: TUniqueKeysCache,
445
+ uniqueKeys: TUniqueKeysCache,
446
446
  destroy(): void | Promise<void>,
447
447
  shared?: (matchingKey: string, onReadyCb: (error?: any) => void) => this
448
448
  }
@@ -39,8 +39,6 @@ export function impressionCountsSubmitterFactory(params: ISdkFactoryContextSync)
39
39
  storage: { impressionCounts }
40
40
  } = params;
41
41
 
42
- if (impressionCounts) {
43
- // retry impressions counts only once.
44
- return submitterFactory(log, postTestImpressionsCount, impressionCounts, IMPRESSIONS_COUNT_RATE, 'impression counts', fromImpressionCountsCollector, 1);
45
- }
42
+ // retry impressions counts only once.
43
+ return submitterFactory(log, postTestImpressionsCount, impressionCounts, IMPRESSIONS_COUNT_RATE, 'impression counts', fromImpressionCountsCollector, 1);
46
44
  }
@@ -10,13 +10,12 @@ export function submitterManagerFactory(params: ISdkFactoryContextSync): ISubmit
10
10
 
11
11
  const submitters = [
12
12
  impressionsSubmitterFactory(params),
13
- eventsSubmitterFactory(params)
13
+ eventsSubmitterFactory(params),
14
+ impressionCountsSubmitterFactory(params),
15
+ uniqueKeysSubmitterFactory(params)
14
16
  ];
15
17
 
16
- const impressionCountsSubmitter = impressionCountsSubmitterFactory(params);
17
- if (impressionCountsSubmitter) submitters.push(impressionCountsSubmitter);
18
18
  const telemetrySubmitter = telemetrySubmitterFactory(params);
19
- if (params.storage.uniqueKeys) submitters.push(uniqueKeysSubmitterFactory(params));
20
19
 
21
20
  return {
22
21
  // `onlyTelemetry` true if SDK is created with userConsent not GRANTED
@@ -19,10 +19,10 @@ export function uniqueKeysSubmitterFactory(params: ISdkFactoryContextSync) {
19
19
  const isClientSide = key !== undefined;
20
20
  const postUniqueKeysBulk = isClientSide ? postUniqueKeysBulkCs : postUniqueKeysBulkSs;
21
21
 
22
- const syncTask = submitterFactory(log, postUniqueKeysBulk, uniqueKeys!, UNIQUE_KEYS_RATE, DATA_NAME);
22
+ const syncTask = submitterFactory(log, postUniqueKeysBulk, uniqueKeys, UNIQUE_KEYS_RATE, DATA_NAME);
23
23
 
24
24
  // register unique keys submitter to be executed when uniqueKeys cache is full
25
- uniqueKeys!.setOnFullQueueCb(() => {
25
+ uniqueKeys.setOnFullQueueCb(() => {
26
26
  if (syncTask.isRunning()) {
27
27
  log.info(SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
28
28
  syncTask.execute();
@@ -33,4 +33,3 @@ export function uniqueKeysSubmitterFactory(params: ISdkFactoryContextSync) {
33
33
 
34
34
  return syncTask;
35
35
  }
36
-
@@ -9,16 +9,11 @@ import SplitIO from '../../types/splitio';
9
9
 
10
10
  /**
11
11
  * Impressions tracker stores impressions in cache and pass them to the listener and integrations manager if provided.
12
- *
13
- * @param impressionsCache - cache to save impressions
14
- * @param metadata - runtime metadata (ip, hostname and version)
15
- * @param impressionListener - optional impression listener
16
- * @param integrationsManager - optional integrations manager
17
- * @param strategy - strategy for impressions tracking.
18
12
  */
19
13
  export function impressionsTrackerFactory(
20
14
  settings: ISettings,
21
15
  impressionsCache: IImpressionsCacheBase,
16
+ noneStrategy: IStrategy,
22
17
  strategy: IStrategy,
23
18
  whenInit: (cb: () => void) => void,
24
19
  integrationsManager?: IImpressionsHandler,
@@ -28,40 +23,44 @@ export function impressionsTrackerFactory(
28
23
  const { log, impressionListener, runtime: { ip, hostname }, version } = settings;
29
24
 
30
25
  return {
31
- track(impressions: SplitIO.ImpressionDTO[], attributes?: SplitIO.Attributes) {
26
+ track(impressions: [impression: SplitIO.ImpressionDTO, track?: boolean][], attributes?: SplitIO.Attributes) {
32
27
  if (settings.userConsent === CONSENT_DECLINED) return;
33
28
 
34
- const impressionsCount = impressions.length;
35
- const { impressionsToStore, impressionsToListener, deduped } = strategy.process(impressions);
29
+ const impressionsToStore = impressions.filter(([impression, track]) => {
30
+ return track === false ?
31
+ noneStrategy.process(impression) :
32
+ strategy.process(impression);
33
+ });
36
34
 
37
- const impressionsToListenerCount = impressionsToListener.length;
35
+ const impressionsLength = impressions.length;
36
+ const impressionsToStoreLength = impressionsToStore.length;
38
37
 
39
- if (impressionsToStore.length > 0) {
40
- const res = impressionsCache.track(impressionsToStore);
38
+ if (impressionsToStoreLength) {
39
+ const res = impressionsCache.track(impressionsToStore.map((item) => item[0]));
41
40
 
42
41
  // If we're on an async storage, handle error and log it.
43
42
  if (thenable(res)) {
44
43
  res.then(() => {
45
- log.info(IMPRESSIONS_TRACKER_SUCCESS, [impressionsCount]);
44
+ log.info(IMPRESSIONS_TRACKER_SUCCESS, [impressionsLength]);
46
45
  }).catch(err => {
47
- log.error(ERROR_IMPRESSIONS_TRACKER, [impressionsCount, err]);
46
+ log.error(ERROR_IMPRESSIONS_TRACKER, [impressionsLength, err]);
48
47
  });
49
48
  } else {
50
49
  // Record when impressionsCache is sync only (standalone mode)
51
50
  // @TODO we are not dropping impressions on full queue yet, so DROPPED stats are not recorded
52
51
  if (telemetryCache) {
53
- (telemetryCache as ITelemetryCacheSync).recordImpressionStats(QUEUED, impressionsToStore.length);
54
- (telemetryCache as ITelemetryCacheSync).recordImpressionStats(DEDUPED, deduped);
52
+ (telemetryCache as ITelemetryCacheSync).recordImpressionStats(QUEUED, impressionsToStoreLength);
53
+ (telemetryCache as ITelemetryCacheSync).recordImpressionStats(DEDUPED, impressionsLength - impressionsToStoreLength);
55
54
  }
56
55
  }
57
56
  }
58
57
 
59
58
  // @TODO next block might be handled by the integration manager. In that case, the metadata object doesn't need to be passed in the constructor
60
59
  if (impressionListener || integrationsManager) {
61
- for (let i = 0; i < impressionsToListenerCount; i++) {
60
+ for (let i = 0; i < impressionsLength; i++) {
62
61
  const impressionData: SplitIO.ImpressionData = {
63
62
  // copy of impression, to avoid unexpected behaviour if modified by integrations or impressionListener
64
- impression: objectAssign({}, impressionsToListener[i]),
63
+ impression: objectAssign({}, impressions[i][0]),
65
64
  attributes,
66
65
  ip,
67
66
  hostname,
@@ -6,23 +6,16 @@ import { IStrategy } from '../types';
6
6
  * Debug strategy for impressions tracker. Wraps impressions to store and adds previousTime if it corresponds
7
7
  *
8
8
  * @param impressionsObserver - impression observer. Previous time (pt property) is included in impression instances
9
- * @returns IStrategyResult
9
+ * @returns Debug strategy
10
10
  */
11
11
  export function strategyDebugFactory(
12
12
  impressionsObserver: IImpressionObserver
13
13
  ): IStrategy {
14
14
 
15
15
  return {
16
- process(impressions: SplitIO.ImpressionDTO[]) {
17
- impressions.forEach((impression) => {
18
- // Adds previous time if it is enabled
19
- impression.pt = impressionsObserver.testAndSet(impression);
20
- });
21
- return {
22
- impressionsToStore: impressions,
23
- impressionsToListener: impressions,
24
- deduped: 0
25
- };
16
+ process(impression: SplitIO.ImpressionDTO) {
17
+ impression.pt = impressionsObserver.testAndSet(impression);
18
+ return true;
26
19
  }
27
20
  };
28
21
  }
@@ -5,30 +5,24 @@ import { IStrategy, IUniqueKeysTracker } from '../types';
5
5
  /**
6
6
  * None strategy for impressions tracker.
7
7
  *
8
- * @param impressionsCounter - cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
8
+ * @param impressionCounts - cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
9
9
  * @param uniqueKeysTracker - unique keys tracker in charge of tracking the unique keys per split.
10
- * @returns IStrategyResult
10
+ * @returns None strategy
11
11
  */
12
12
  export function strategyNoneFactory(
13
- impressionsCounter: IImpressionCountsCacheBase,
13
+ impressionCounts: IImpressionCountsCacheBase,
14
14
  uniqueKeysTracker: IUniqueKeysTracker
15
15
  ): IStrategy {
16
16
 
17
17
  return {
18
- process(impressions: SplitIO.ImpressionDTO[]) {
19
- impressions.forEach((impression) => {
20
- const now = Date.now();
21
- // Increments impression counter per featureName
22
- impressionsCounter.track(impression.feature, now, 1);
23
- // Keep track by unique key
24
- uniqueKeysTracker.track(impression.keyName, impression.feature);
25
- });
26
-
27
- return {
28
- impressionsToStore: [],
29
- impressionsToListener: impressions,
30
- deduped: 0
31
- };
18
+ process(impression: SplitIO.ImpressionDTO) {
19
+ const now = Date.now();
20
+ // Increments impression counter per featureName
21
+ impressionCounts.track(impression.feature, now, 1);
22
+ // Keep track by unique key
23
+ uniqueKeysTracker.track(impression.keyName, impression.feature);
24
+ // Do not store impressions
25
+ return false;
32
26
  }
33
27
  };
34
28
  }
@@ -8,35 +8,25 @@ import { IStrategy } from '../types';
8
8
  * Optimized strategy for impressions tracker. Wraps impressions to store and adds previousTime if it corresponds
9
9
  *
10
10
  * @param impressionsObserver - impression observer. previous time (pt property) is included in impression instances
11
- * @param impressionsCounter - cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
12
- * @returns IStrategyResult
11
+ * @param impressionCounts - cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
12
+ * @returns Optimized strategy
13
13
  */
14
14
  export function strategyOptimizedFactory(
15
15
  impressionsObserver: IImpressionObserver,
16
- impressionsCounter: IImpressionCountsCacheBase,
16
+ impressionCounts: IImpressionCountsCacheBase,
17
17
  ): IStrategy {
18
18
 
19
19
  return {
20
- process(impressions: SplitIO.ImpressionDTO[]) {
21
- const impressionsToStore: SplitIO.ImpressionDTO[] = [];
22
- impressions.forEach((impression) => {
23
- impression.pt = impressionsObserver.testAndSet(impression);
20
+ process(impression: SplitIO.ImpressionDTO) {
21
+ impression.pt = impressionsObserver.testAndSet(impression);
24
22
 
25
- const now = Date.now();
23
+ const now = Date.now();
26
24
 
27
- // Increments impression counter per featureName
28
- if (impression.pt) impressionsCounter.track(impression.feature, now, 1);
25
+ // Increments impression counter per featureName
26
+ if (impression.pt) impressionCounts.track(impression.feature, now, 1);
29
27
 
30
- // Checks if the impression should be added in queue to be sent
31
- if (!impression.pt || impression.pt < truncateTimeFrame(now)) {
32
- impressionsToStore.push(impression);
33
- }
34
- });
35
- return {
36
- impressionsToStore: impressionsToStore,
37
- impressionsToListener: impressions,
38
- deduped: impressions.length - impressionsToStore.length
39
- };
28
+ // Checks if the impression should be added in queue to be sent
29
+ return (!impression.pt || impression.pt < truncateTimeFrame(now)) ? true : false;
40
30
  }
41
31
  };
42
32
  }
@@ -18,7 +18,7 @@ export interface IImpressionsHandler {
18
18
  }
19
19
 
20
20
  export interface IImpressionsTracker {
21
- track(impressions: SplitIO.ImpressionDTO[], attributes?: SplitIO.Attributes): void
21
+ track(impressions: [impression: SplitIO.ImpressionDTO, track?: boolean][], attributes?: SplitIO.Attributes): void
22
22
  }
23
23
 
24
24
  /** Telemetry tracker */
@@ -70,12 +70,6 @@ export interface IUniqueKeysTracker {
70
70
  track(key: string, featureName: string): void;
71
71
  }
72
72
 
73
- export interface IStrategyResult {
74
- impressionsToStore: SplitIO.ImpressionDTO[],
75
- impressionsToListener: SplitIO.ImpressionDTO[],
76
- deduped: number
77
- }
78
-
79
73
  export interface IStrategy {
80
- process(impressions: SplitIO.ImpressionDTO[]): IStrategyResult
74
+ process(impression: SplitIO.ImpressionDTO): boolean
81
75
  }
@@ -862,6 +862,10 @@ declare namespace SplitIO {
862
862
  * The default treatment of the feature flag.
863
863
  */
864
864
  defaultTreatment: string;
865
+ /**
866
+ * Whether the feature flag has impressions tracking enabled or not.
867
+ */
868
+ trackImpressions: boolean;
865
869
  };
866
870
  /**
867
871
  * A promise that resolves to a feature flag view or null if the feature flag is not found.