Release v1.4.0

.github/workflows/ci.yml

@@ -5,7 +5,8 @@ on:
       - '*'
   pull_request:
     branches:
-      - '*'
+      - main
+      - development
 
 jobs:
   build:

CHANGES.txt

@@ -1,3 +1,8 @@
+1.4.0 (May 24, 2022)
+ - Added `scheduler.telemetryRefreshRate` property to SDK configuration, and deprecated `scheduler.metricsRefreshRate` property.
+ - Updated SDK telemetry storage, metrics and updater to be more effective and send less often.
+ - Bugfixing - Updated default values for `scheduler.impressionsRefreshRate` config parameter: 300s for OPTIMIZED impression mode and 60s for DEBUG impression mode.
+
 1.3.1 (April 19, 2022)
  - Bugfixing - Added peer dependencies to avoid issues when requiring some third-party dependencies used by modules of the package (Related to issue https://github.com/splitio/javascript-client/issues/662).
  - Bugfixing - Updated `ready` method to rejects the promise with an Error object instead of a string value (Related to issue https://github.com/splitio/javascript-client/issues/654).

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

src/__tests__/testUtils/index.ts

@@ -0,0 +1,14 @@
+const DEFAULT_ERROR_MARGIN = 50; // 0.05 secs if numbers are timestamps in milliseconds
+
+/**
+ * Assert if an `actual` and `expected` numeric values are nearly equal.
+ *
+ * @param {number} actual actual time lapse in millis
+ * @param {number} expected expected time lapse in millis
+ * @param {number} epsilon error margin in millis
+ * @returns {boolean} whether the absolute difference is minor to epsilon value or not
+ */
+export function nearlyEqual(actual: number, expected: number, epsilon = DEFAULT_ERROR_MARGIN) {
+  const diff = Math.abs(actual - expected);
+  return diff <= epsilon;
+}

src/consent/sdkUserConsent.ts

@@ -23,7 +23,7 @@ export function createUserConsentAPI(params: ISdkFactoryContext) {
     setStatus(consent: unknown) {
       // validate input param
       if (!isBoolean(consent)) {
-        log.warn(ERROR_NOT_BOOLEAN, ['setUserConsent']);
+        log.warn(ERROR_NOT_BOOLEAN, ['UserConsent.setStatus']);
         return false;
       }
 

src/listeners/__tests__/browser.spec.ts

@@ -3,6 +3,18 @@ import { IEventsCacheSync, IImpressionCountsCacheSync, IImpressionsCacheSync, IS
 import { ISplitApi } from '../../services/types';
 import { fullSettings } from '../../utils/settingsValidation/__tests__/settings.mocks';
 
+jest.mock('../../sync/submitters/telemetrySubmitter', () => {
+  return {
+    telemetryCacheStatsAdapter: () => {
+      return {
+        isEmpty: () => false,
+        clear: () => { },
+        state: () => ({}),
+      };
+    }
+  };
+});
+
 /* Mocks start */
 
 const fakeImpression = {
@@ -26,6 +38,7 @@ const fakeImpressionCounts = {
   'someFeature::0': 1
 };
 
+// Storage with impressionsCount and telemetry cache
 const fakeStorageOptimized = { // @ts-expect-error
   impressions: {
     isEmpty: jest.fn(),
@@ -48,6 +61,7 @@ const fakeStorageOptimized = { // @ts-expect-error
       return fakeImpressionCounts;
     }
   } as IImpressionCountsCacheSync,
+  telemetry: {}
 };
 
 const fakeStorageDebug = {
@@ -59,7 +73,8 @@ const fakeStorageDebug = {
 const fakeSplitApi = {
   postTestImpressionsBulk: jest.fn(() => Promise.resolve()),
   postEventsBulk: jest.fn(() => Promise.resolve()),
-  postTestImpressionsCount: jest.fn(() => Promise.resolve())
+  postTestImpressionsCount: jest.fn(() => Promise.resolve()),
+  postMetricsUsage: jest.fn(() => Promise.resolve()),
 } as ISplitApi;
 
 const UNLOAD_DOM_EVENT = 'unload';
@@ -131,7 +146,7 @@ test('Browser JS listener / consumer mode', () => {
   expect((global.window.removeEventListener as jest.Mock).mock.calls).toEqual([[UNLOAD_DOM_EVENT, listener.flushData]]);
 });
 
-test('Browser JS listener / standalone mode / Impressions optimized mode', () => {
+test('Browser JS listener / standalone mode / Impressions optimized mode with telemetry', () => {
   const syncManagerMock = {};
 
   // @ts-expect-error
@@ -144,8 +159,8 @@ test('Browser JS listener / standalone mode / Impressions optimized mode', () =>
 
   triggerUnloadEvent();
 
-  // Unload event was triggered. Thus sendBeacon method should have been called three times.
-  expect(global.window.navigator.sendBeacon).toBeCalledTimes(3);
+  // Unload event was triggered. Thus sendBeacon method should have been called four times.
+  expect(global.window.navigator.sendBeacon).toBeCalledTimes(4);
 
   // Http post services should have not been called
   expect(fakeSplitApi.postTestImpressionsBulk).not.toBeCalled();
@@ -195,7 +210,7 @@ test('Browser JS listener / standalone mode / Impressions debug mode', () => {
 });
 
 test('Browser JS listener / standalone mode / Impressions debug mode without sendBeacon API', () => {
-  // remove sendBeacon API
+  // remove sendBeacon API temporally
   const sendBeacon = global.navigator.sendBeacon; // @ts-expect-error
   global.navigator.sendBeacon = undefined;
   const syncManagerMockWithoutPushManager = {};
@@ -254,8 +269,8 @@ test('Browser JS listener / standalone mode / user consent status', () => {
   settings.userConsent = undefined;
   triggerUnloadEvent();
 
-  // Unload event was triggered when user consent was granted and undefined. Thus sendBeacon should be called 6 times (3 times per event in optimized mode).
-  expect(global.window.navigator.sendBeacon).toBeCalledTimes(6);
+  // Unload event was triggered when user consent was granted and undefined. Thus sendBeacon should be called 8 times (4 times per event in optimized mode with telemetry).
+  expect(global.window.navigator.sendBeacon).toBeCalledTimes(8);
 
   listener.stop();
 });

src/listeners/browser.ts

@@ -2,8 +2,8 @@
 // @TODO eventually migrate to JS-Browser-SDK package.
 import { ISignalListener } from './types';
 import { IRecorderCacheProducerSync, IStorageSync } from '../storages/types';
-import { fromImpressionsCollector } from '../sync/submitters/impressionsSyncTask';
-import { fromImpressionCountsCollector } from '../sync/submitters/impressionCountsSyncTask';
+import { fromImpressionsCollector } from '../sync/submitters/impressionsSubmitter';
+import { fromImpressionCountsCollector } from '../sync/submitters/impressionCountsSubmitter';
 import { IResponse, ISplitApi } from '../services/types';
 import { ImpressionDTO, ISettings } from '../types';
 import { ImpressionsPayload } from '../sync/submitters/types';
@@ -12,6 +12,7 @@ import { objectAssign } from '../utils/lang/objectAssign';
 import { CLEANUP_REGISTERING, CLEANUP_DEREGISTERING } from '../logger/constants';
 import { ISyncManager } from '../sync/types';
 import { isConsentGranted } from '../consent';
+import { telemetryCacheStatsAdapter } from '../sync/submitters/telemetrySubmitter';
 
 // 'unload' event is used instead of 'beforeunload', since 'unload' is not a cancelable event, so no other listeners can stop the event from occurring.
 const UNLOAD_DOM_EVENT = 'unload';
@@ -77,6 +78,11 @@ export class BrowserSignalListener implements ISignalListener {
       this._flushData(eventsUrl + '/testImpressions/beacon', this.storage.impressions, this.serviceApi.postTestImpressionsBulk, this.fromImpressionsCollector, extraMetadata);
       this._flushData(eventsUrl + '/events/beacon', this.storage.events, this.serviceApi.postEventsBulk);
       if (this.storage.impressionCounts) this._flushData(eventsUrl + '/testImpressions/count/beacon', this.storage.impressionCounts, this.serviceApi.postTestImpressionsCount, fromImpressionCountsCollector);
+      if (this.storage.telemetry) {
+        const telemetryUrl = this.settings.urls.telemetry;
+        const telemetryCacheAdapter = telemetryCacheStatsAdapter(this.storage.telemetry, this.storage.splits, this.storage.segments);
+        this._flushData(telemetryUrl + '/v1/metrics/usage/beacon', telemetryCacheAdapter, this.serviceApi.postMetricsUsage);
+      }
     }
 
     // Close streaming connection

src/logger/constants.ts

@@ -123,6 +123,7 @@ export const ERROR_HTTP = 322;
 export const ERROR_LOCALHOST_MODULE_REQUIRED = 323;
 export const ERROR_STORAGE_INVALID = 324;
 export const ERROR_NOT_BOOLEAN = 325;
+export const ERROR_MIN_CONFIG_PARAM = 326;
 
 // Log prefixes (a.k.a. tags or categories)
 export const LOG_PREFIX_SETTINGS = 'settings';

src/logger/messages/error.ts

@@ -32,5 +32,6 @@ export const codesError: [number, string][] = [
   // initialization / settings validation
   [c.ERROR_INVALID_CONFIG_PARAM, c.LOG_PREFIX_SETTINGS + ': you passed an invalid "%s" config param. It should be one of the following values: %s. Defaulting to "%s".'],
   [c.ERROR_LOCALHOST_MODULE_REQUIRED, c.LOG_PREFIX_SETTINGS + ': an invalid value was received for "sync.localhostMode" config. A valid entity should be provided for localhost mode.'],
-  [c.ERROR_STORAGE_INVALID, c.LOG_PREFIX_SETTINGS+': The provided storage is invalid.%s Fallbacking into default MEMORY storage'],
+  [c.ERROR_STORAGE_INVALID, c.LOG_PREFIX_SETTINGS+': the provided storage is invalid.%s Falling back into default MEMORY storage'],
+  [c.ERROR_MIN_CONFIG_PARAM, c.LOG_PREFIX_SETTINGS + ': the provided "%s" config param is lower than allowed. Setting to the minimum value %s seconds'],
 ];

src/logger/messages/info.ts

@@ -14,8 +14,8 @@ export const codesInfo: [number, string][] = codesWarn.concat([
   [c.NEW_FACTORY, 'New Split SDK instance created.'],
   [c.EVENTS_TRACKER_SUCCESS, c.LOG_PREFIX_EVENTS_TRACKER + 'Successfully queued %s'],
   [c.IMPRESSIONS_TRACKER_SUCCESS, c.LOG_PREFIX_IMPRESSIONS_TRACKER + 'Successfully stored %s impression(s).'],
-  [c.USER_CONSENT_UPDATED, 'setUserConsent: consent status changed from %s to %s.'],
-  [c.USER_CONSENT_NOT_UPDATED, 'setUserConsent: call had no effect because it was the current consent status (%s).'],
+  [c.USER_CONSENT_UPDATED, 'UserConsent: consent status changed from %s to %s.'],
+  [c.USER_CONSENT_NOT_UPDATED, 'UserConsent: call had no effect because it was the current consent status (%s).'],
   [c.USER_CONSENT_INITIAL, 'Starting the SDK with %s user consent. No data will be sent.'],
 
   // synchronizer
@@ -24,7 +24,7 @@ export const codesInfo: [number, string][] = codesWarn.concat([
   [c.POLLING_STOP, c.LOG_PREFIX_SYNC_POLLING + 'Stopping polling'],
   [c.SYNC_SPLITS_FETCH_RETRY, c.LOG_PREFIX_SYNC_SPLITS + 'Retrying download of splits #%s. Reason: %s'],
   [c.SUBMITTERS_PUSH_FULL_QUEUE, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Flushing full %s queue and reseting timer.'],
-  [c.SUBMITTERS_PUSH, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Pushing %s %s.'],
+  [c.SUBMITTERS_PUSH, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Pushing %s.'],
   [c.STREAMING_REFRESH_TOKEN, c.LOG_PREFIX_SYNC_STREAMING + 'Refreshing streaming token in %s seconds, and connecting streaming in %s seconds.'],
   [c.STREAMING_RECONNECT, c.LOG_PREFIX_SYNC_STREAMING + 'Attempting to reconnect streaming in %s seconds.'],
   [c.STREAMING_CONNECTING, c.LOG_PREFIX_SYNC_STREAMING + 'Connecting streaming.'],

src/logger/messages/warn.ts

@@ -11,8 +11,8 @@ export const codesWarn: [number, string][] = codesError.concat([
   [c.STREAMING_PARSING_ERROR_FAILS, c.LOG_PREFIX_SYNC_STREAMING + 'Error parsing SSE error notification: %s'],
   [c.STREAMING_PARSING_MESSAGE_FAILS, c.LOG_PREFIX_SYNC_STREAMING + 'Error parsing SSE message notification: %s'],
   [c.STREAMING_FALLBACK, c.LOG_PREFIX_SYNC_STREAMING + 'Falling back to polling mode. Reason: %s'],
-  [c.SUBMITTERS_PUSH_FAILS, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Droping %s %s after retry. Reason: %s.'],
-  [c.SUBMITTERS_PUSH_RETRY, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Failed to push %s %s, keeping data to retry on next iteration. Reason: %s.'],
+  [c.SUBMITTERS_PUSH_FAILS, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Droping %s after retry. Reason: %s.'],
+  [c.SUBMITTERS_PUSH_RETRY, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Failed to push %s, keeping data to retry on next iteration. Reason: %s.'],
   // client status
   [c.CLIENT_NOT_READY, '%s: the SDK is not ready, results may be incorrect. Make sure to wait for SDK readiness before using this method.'],
   [c.CLIENT_NO_LISTENER, 'No listeners for SDK Readiness detected. Incorrect control treatments could have been logged if you called getTreatment/s while the SDK was not yet ready.'],

src/readiness/__tests__/sdkReadinessManager.spec.ts

@@ -172,7 +172,8 @@ describe('SDK Readiness Manager - Event emitter', () => {
 
   test('The event callbacks should work as expected - SDK_READY emits with expected internal callbacks', () => {
     // the sdkReadinessManager expects more than one SDK_READY callback to not log the "No listeners" warning
-    const sdkReadinessManager = sdkReadinessManagerFactory(loggerMock, EventEmitterMock, undefined /* default readyTimeout */, 1 /* internalReadyCbCount */);
+    const sdkReadinessManager = sdkReadinessManagerFactory(loggerMock, EventEmitterMock);
+    sdkReadinessManager.incInternalReadyCbCount();
     const gateMock = sdkReadinessManager.readinessManager.gate;
 
     // Get the callbacks

src/readiness/sdkReadinessManager.ts

@@ -15,18 +15,16 @@ const REMOVE_LISTENER_EVENT = 'removeListener';
  * It also updates logs related warnings and errors.
  *
  * @param readyTimeout time in millis to emit SDK_READY_TIME_OUT event
- * @param internalReadyCbCount offset value of SDK_READY listeners that are added/removed internally
- * by the SDK. It is required to properly log the warning 'No listeners for SDK Readiness detected'
  * @param readinessManager optional readinessManager to use. only used internally for `shared` method
  */
 export function sdkReadinessManagerFactory(
   log: ILogger,
   EventEmitter: new () => IEventEmitter,
   readyTimeout = 0,
-  internalReadyCbCount = 0,
   readinessManager = readinessManagerFactory(EventEmitter, readyTimeout)): ISdkReadinessManager {
 
   /** Ready callback warning */
+  let internalReadyCbCount = 0;
   let readyCbCount = 0;
   readinessManager.gate.on(REMOVE_LISTENER_EVENT, (event: any) => {
     if (event === SDK_READY) readyCbCount--;
@@ -74,8 +72,12 @@ export function sdkReadinessManagerFactory(
   return {
     readinessManager,
 
-    shared(readyTimeout = 0, internalReadyCbCount = 0) {
-      return sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, internalReadyCbCount, readinessManager.shared(readyTimeout));
+    shared(readyTimeout = 0) {
+      return sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, readinessManager.shared(readyTimeout));
+    },
+
+    incInternalReadyCbCount() {
+      internalReadyCbCount++;
     },
 
     sdkStatus: objectAssign(

src/readiness/types.ts

@@ -66,6 +66,12 @@ export interface ISdkReadinessManager {
   readinessManager: IReadinessManager
   sdkStatus: IStatusInterface
 
+  /**
+   * Increment internalReadyCbCount, an offset value of SDK_READY listeners that are added/removed internally
+   * by the SDK. It is required to properly log the warning 'No listeners for SDK Readiness detected'
+   */
+  incInternalReadyCbCount(): void
+
   /** for client-side */
-  shared(readyTimeout?: number, internalReadyCbCount?: number): ISdkReadinessManager
+  shared(readyTimeout?: number): ISdkReadinessManager
 }

src/sdkClient/__tests__/sdkClientMethod.spec.ts

@@ -2,6 +2,7 @@ import { loggerMock } from '../../logger/__tests__/sdkLogger.mock';
 import { CONSUMER_MODE, STANDALONE_MODE } from '../../utils/constants';
 import { sdkClientMethodFactory } from '../sdkClientMethod';
 import { assertClientApi } from './testUtils';
+import { telemetryTrackerFactory } from '../../trackers/telemetryTracker';
 
 const errorMessage = 'Shared Client not supported by the storage mechanism. Create isolated instances instead.';
 
@@ -12,15 +13,17 @@ const paramMocks = [
     syncManager: undefined,
     sdkReadinessManager: { sdkStatus: jest.fn(), readinessManager: { destroy: jest.fn() } },
     signalListener: undefined,
-    settings: { mode: CONSUMER_MODE, log: loggerMock, core: { authorizationKey: 'api key '} }
+    settings: { mode: CONSUMER_MODE, log: loggerMock, core: { authorizationKey: 'api key '} },
+    telemetryTracker: telemetryTrackerFactory()
   },
   // SyncManager (i.e., Sync SDK) and Signal listener
   {
     storage: { destroy: jest.fn() },
     syncManager: { stop: jest.fn(), flush: jest.fn(() => Promise.resolve()) },
     sdkReadinessManager: { sdkStatus: jest.fn(), readinessManager: { destroy: jest.fn() } },
     signalListener: { stop: jest.fn() },
-    settings: { mode: STANDALONE_MODE, log: loggerMock, core: { authorizationKey: 'api key '} }
+    settings: { mode: STANDALONE_MODE, log: loggerMock, core: { authorizationKey: 'api key '} },
+    telemetryTracker: telemetryTrackerFactory()
   }
 ];
 

src/sdkClient/__tests__/sdkClientMethodCS.spec.ts

@@ -1,7 +1,7 @@
 import { sdkClientMethodCSFactory as sdkClientMethodCSWithTTFactory } from '../sdkClientMethodCSWithTT';
 import { sdkClientMethodCSFactory } from '../sdkClientMethodCS';
 import { assertClientApi } from './testUtils';
-
+import { telemetryTrackerFactory } from '../../trackers/telemetryTracker';
 import { settingsWithKey, settingsWithKeyAndTT, settingsWithKeyObject } from '../../utils/settingsValidation/__tests__/settings.mocks';
 
 const partialStorages: { destroy: jest.Mock }[] = [];
@@ -44,7 +44,8 @@ const params = {
   sdkReadinessManager: sdkReadinessManagerMock,
   syncManager: syncManagerMock,
   signalListener: { stop: jest.fn() },
-  settings: settingsWithKey
+  settings: settingsWithKey,
+  telemetryTracker: telemetryTrackerFactory()
 };
 
 const invalidAttributes = [