@splitsoftware/splitio-commons 1.3.2-rc.1 → 1.3.2-rc.2

package/cjs/services/splitApi.js

@@ -91,11 +91,11 @@ function splitApiFactory(settings, platform, telemetryTracker) {
             return splitHttpClient(url, { method: 'POST', body: body, headers: headers }, telemetryTracker.trackHttp(constants_1.IMPRESSIONS_COUNT));
         },
         postMetricsConfig: function (body) {
-            var url = urls.telemetry + "/metrics/config";
+            var url = urls.telemetry + "/v1/metrics/config";
             return splitHttpClient(url, { method: 'POST', body: body }, telemetryTracker.trackHttp(constants_1.TELEMETRY), true);
         },
         postMetricsUsage: function (body) {
-            var url = urls.telemetry + "/metrics/usage";
+            var url = urls.telemetry + "/v1/metrics/usage";
             return splitHttpClient(url, { method: 'POST', body: body }, telemetryTracker.trackHttp(constants_1.TELEMETRY), true);
         }
     };

package/cjs/sync/submitters/submitter.js

@@ -6,7 +6,8 @@ var constants_1 = require("../../logger/constants");
 /**
  * Base function to create submitters, such as ImpressionsSubmitter and EventsSubmitter
  */
-function submitterFactory(log, postClient, sourceCache, postRate, dataName, fromCacheToPayload, maxRetries, debugLogs) {
+function submitterFactory(log, postClient, sourceCache, postRate, dataName, fromCacheToPayload, maxRetries, debugLogs // true for telemetry submitters
+) {
     if (maxRetries === void 0) { maxRetries = 0; }
     var retries = 0;
     function postData() {
@@ -24,16 +25,16 @@ function submitterFactory(log, postClient, sourceCache, postRate, dataName, from
             sourceCache.clear(); // we clear the queue if request successes.
         }).catch(function (err) {
             if (!maxRetries) {
-                log.warn(constants_1.SUBMITTERS_PUSH_FAILS, [dataCountMessage, err]);
+                log[debugLogs ? 'debug' : 'warn'](constants_1.SUBMITTERS_PUSH_FAILS, [dataCountMessage, err]);
             }
             else if (retries === maxRetries) {
                 retries = 0;
                 sourceCache.clear(); // we clear the queue if request fails after retries.
-                log.warn(constants_1.SUBMITTERS_PUSH_FAILS, [dataCountMessage, err]);
+                log[debugLogs ? 'debug' : 'warn'](constants_1.SUBMITTERS_PUSH_FAILS, [dataCountMessage, err]);
             }
             else {
                 retries++;
-                log.warn(constants_1.SUBMITTERS_PUSH_RETRY, [dataCountMessage, err]);
+                log[debugLogs ? 'debug' : 'warn'](constants_1.SUBMITTERS_PUSH_RETRY, [dataCountMessage, err]);
             }
         });
     }

package/cjs/utils/settingsValidation/index.js

@@ -32,8 +32,8 @@ exports.base = {
         segmentsRefreshRate: 60,
         // publish telemetry stats each 3600 secs (1 hour)
         telemetryRefreshRate: 3600,
-        // publish evaluations each 60 sec
-        impressionsRefreshRate: 60,
+        // publish evaluations each 300 sec (default value for OPTIMIZED impressions mode)
+        impressionsRefreshRate: 300,
         // fetch offline changes each 15 sec
         offlineRefreshRate: 15,
         // publish events every 60 seconds after the first flush
@@ -55,7 +55,7 @@ exports.base = {
         // Streaming Server
         streaming: 'https://streaming.split.io',
         // Telemetry Server
-        telemetry: 'https://telemetry.split.io',
+        telemetry: 'https://telemetry.split.io/api',
     },
     // Defines which kind of storage we should instanciate.
     storage: undefined,
@@ -96,6 +96,8 @@ function settingsValidation(config, validationParams) {
     // First thing to validate, since other validators might use the logger.
     var log = logger(withDefaults); // @ts-ignore, modify readonly prop
     withDefaults.log = log;
+    // ensure a valid impressionsMode
+    withDefaults.sync.impressionsMode = (0, impressionsMode_1.validImpressionsMode)(log, withDefaults.sync.impressionsMode);
     function validateMinValue(paramName, actualValue, minValue) {
         if (actualValue >= minValue)
             return actualValue;
@@ -107,10 +109,20 @@ function settingsValidation(config, validationParams) {
     var scheduler = withDefaults.scheduler, startup = withDefaults.startup;
     scheduler.featuresRefreshRate = fromSecondsToMillis(scheduler.featuresRefreshRate);
     scheduler.segmentsRefreshRate = fromSecondsToMillis(scheduler.segmentsRefreshRate);
-    scheduler.impressionsRefreshRate = fromSecondsToMillis(scheduler.impressionsRefreshRate);
     scheduler.offlineRefreshRate = fromSecondsToMillis(scheduler.offlineRefreshRate);
     scheduler.eventsPushRate = fromSecondsToMillis(scheduler.eventsPushRate);
     scheduler.telemetryRefreshRate = fromSecondsToMillis(validateMinValue('telemetryRefreshRate', scheduler.telemetryRefreshRate, 60));
+    if (scheduler.impressionsRefreshRate !== exports.base.scheduler.impressionsRefreshRate) {
+        // Validate impressionsRefreshRate defined by user
+        scheduler.impressionsRefreshRate = validateMinValue('impressionsRefreshRate', scheduler.impressionsRefreshRate, withDefaults.sync.impressionsMode === constants_1.DEBUG ? 1 : 60 // Min is 1 sec for DEBUG and 60 secs for OPTIMIZED
+        );
+    }
+    else {
+        // Default impressionsRefreshRate for DEBUG mode is 60 secs
+        if (withDefaults.sync.impressionsMode === constants_1.DEBUG)
+            scheduler.impressionsRefreshRate = 60;
+    }
+    scheduler.impressionsRefreshRate = fromSecondsToMillis(scheduler.impressionsRefreshRate);
     // Log deprecation for old telemetry param
     if (scheduler.metricsRefreshRate)
         log.warn('`metricsRefreshRate` will be deprecated soon. For configuring telemetry rates, update `telemetryRefreshRate` value in configs');
@@ -166,8 +178,6 @@ function settingsValidation(config, validationParams) {
     var splitFiltersValidation = (0, splitFilters_1.validateSplitFilters)(log, withDefaults.sync.splitFilters, withDefaults.mode);
     withDefaults.sync.splitFilters = splitFiltersValidation.validFilters;
     withDefaults.sync.__splitFiltersValidation = splitFiltersValidation;
-    // ensure a valid impressionsMode
-    withDefaults.sync.impressionsMode = (0, impressionsMode_1.validImpressionsMode)(log, withDefaults.sync.impressionsMode);
     // ensure a valid user consent value
     // @ts-ignore, modify readonly prop
     withDefaults.userConsent = consent(withDefaults);

package/cjs/utils/settingsValidation/url.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.url = void 0;
-var telemetryEndpointMatcher = /^\/metrics\/(config|usage)/;
+var telemetryEndpointMatcher = /^\/v1\/metrics\/(config|usage)/;
 var eventsEndpointMatcher = /^\/(testImpressions|metrics|events)/;
 var authEndpointMatcher = /^\/v2\/auth/;
 var streamingEndpointMatcher = /^\/(sse|event-stream)/;

package/esm/services/splitApi.js

@@ -88,11 +88,11 @@ export function splitApiFactory(settings, platform, telemetryTracker) {
             return splitHttpClient(url, { method: 'POST', body: body, headers: headers }, telemetryTracker.trackHttp(IMPRESSIONS_COUNT));
         },
         postMetricsConfig: function (body) {
-            var url = urls.telemetry + "/metrics/config";
+            var url = urls.telemetry + "/v1/metrics/config";
             return splitHttpClient(url, { method: 'POST', body: body }, telemetryTracker.trackHttp(TELEMETRY), true);
         },
         postMetricsUsage: function (body) {
-            var url = urls.telemetry + "/metrics/usage";
+            var url = urls.telemetry + "/v1/metrics/usage";
             return splitHttpClient(url, { method: 'POST', body: body }, telemetryTracker.trackHttp(TELEMETRY), true);
         }
     };

package/esm/sync/submitters/submitter.js

@@ -3,7 +3,8 @@ import { SUBMITTERS_PUSH, SUBMITTERS_PUSH_FAILS, SUBMITTERS_PUSH_RETRY } from '.
 /**
  * Base function to create submitters, such as ImpressionsSubmitter and EventsSubmitter
  */
-export function submitterFactory(log, postClient, sourceCache, postRate, dataName, fromCacheToPayload, maxRetries, debugLogs) {
+export function submitterFactory(log, postClient, sourceCache, postRate, dataName, fromCacheToPayload, maxRetries, debugLogs // true for telemetry submitters
+) {
     if (maxRetries === void 0) { maxRetries = 0; }
     var retries = 0;
     function postData() {
@@ -21,16 +22,16 @@ export function submitterFactory(log, postClient, sourceCache, postRate, dataNam
             sourceCache.clear(); // we clear the queue if request successes.
         }).catch(function (err) {
             if (!maxRetries) {
-                log.warn(SUBMITTERS_PUSH_FAILS, [dataCountMessage, err]);
+                log[debugLogs ? 'debug' : 'warn'](SUBMITTERS_PUSH_FAILS, [dataCountMessage, err]);
             }
             else if (retries === maxRetries) {
                 retries = 0;
                 sourceCache.clear(); // we clear the queue if request fails after retries.
-                log.warn(SUBMITTERS_PUSH_FAILS, [dataCountMessage, err]);
+                log[debugLogs ? 'debug' : 'warn'](SUBMITTERS_PUSH_FAILS, [dataCountMessage, err]);
             }
             else {
                 retries++;
-                log.warn(SUBMITTERS_PUSH_RETRY, [dataCountMessage, err]);
+                log[debugLogs ? 'debug' : 'warn'](SUBMITTERS_PUSH_RETRY, [dataCountMessage, err]);
             }
         });
     }

package/esm/utils/settingsValidation/index.js

@@ -1,7 +1,7 @@
 import { merge } from '../lang';
 import { mode } from './mode';
 import { validateSplitFilters } from './splitFilters';
-import { STANDALONE_MODE, OPTIMIZED, LOCALHOST_MODE } from '../constants';
+import { STANDALONE_MODE, OPTIMIZED, LOCALHOST_MODE, DEBUG } from '../constants';
 import { validImpressionsMode } from './impressionsMode';
 import { validateKey } from '../inputValidation/key';
 import { validateTrafficType } from '../inputValidation/trafficType';
@@ -29,8 +29,8 @@ export var base = {
         segmentsRefreshRate: 60,
         // publish telemetry stats each 3600 secs (1 hour)
         telemetryRefreshRate: 3600,
-        // publish evaluations each 60 sec
-        impressionsRefreshRate: 60,
+        // publish evaluations each 300 sec (default value for OPTIMIZED impressions mode)
+        impressionsRefreshRate: 300,
         // fetch offline changes each 15 sec
         offlineRefreshRate: 15,
         // publish events every 60 seconds after the first flush
@@ -52,7 +52,7 @@ export var base = {
         // Streaming Server
         streaming: 'https://streaming.split.io',
         // Telemetry Server
-        telemetry: 'https://telemetry.split.io',
+        telemetry: 'https://telemetry.split.io/api',
     },
     // Defines which kind of storage we should instanciate.
     storage: undefined,
@@ -93,6 +93,8 @@ export function settingsValidation(config, validationParams) {
     // First thing to validate, since other validators might use the logger.
     var log = logger(withDefaults); // @ts-ignore, modify readonly prop
     withDefaults.log = log;
+    // ensure a valid impressionsMode
+    withDefaults.sync.impressionsMode = validImpressionsMode(log, withDefaults.sync.impressionsMode);
     function validateMinValue(paramName, actualValue, minValue) {
         if (actualValue >= minValue)
             return actualValue;
@@ -104,10 +106,20 @@ export function settingsValidation(config, validationParams) {
     var scheduler = withDefaults.scheduler, startup = withDefaults.startup;
     scheduler.featuresRefreshRate = fromSecondsToMillis(scheduler.featuresRefreshRate);
     scheduler.segmentsRefreshRate = fromSecondsToMillis(scheduler.segmentsRefreshRate);
-    scheduler.impressionsRefreshRate = fromSecondsToMillis(scheduler.impressionsRefreshRate);
     scheduler.offlineRefreshRate = fromSecondsToMillis(scheduler.offlineRefreshRate);
     scheduler.eventsPushRate = fromSecondsToMillis(scheduler.eventsPushRate);
     scheduler.telemetryRefreshRate = fromSecondsToMillis(validateMinValue('telemetryRefreshRate', scheduler.telemetryRefreshRate, 60));
+    if (scheduler.impressionsRefreshRate !== base.scheduler.impressionsRefreshRate) {
+        // Validate impressionsRefreshRate defined by user
+        scheduler.impressionsRefreshRate = validateMinValue('impressionsRefreshRate', scheduler.impressionsRefreshRate, withDefaults.sync.impressionsMode === DEBUG ? 1 : 60 // Min is 1 sec for DEBUG and 60 secs for OPTIMIZED
+        );
+    }
+    else {
+        // Default impressionsRefreshRate for DEBUG mode is 60 secs
+        if (withDefaults.sync.impressionsMode === DEBUG)
+            scheduler.impressionsRefreshRate = 60;
+    }
+    scheduler.impressionsRefreshRate = fromSecondsToMillis(scheduler.impressionsRefreshRate);
     // Log deprecation for old telemetry param
     if (scheduler.metricsRefreshRate)
         log.warn('`metricsRefreshRate` will be deprecated soon. For configuring telemetry rates, update `telemetryRefreshRate` value in configs');
@@ -163,8 +175,6 @@ export function settingsValidation(config, validationParams) {
     var splitFiltersValidation = validateSplitFilters(log, withDefaults.sync.splitFilters, withDefaults.mode);
     withDefaults.sync.splitFilters = splitFiltersValidation.validFilters;
     withDefaults.sync.__splitFiltersValidation = splitFiltersValidation;
-    // ensure a valid impressionsMode
-    withDefaults.sync.impressionsMode = validImpressionsMode(log, withDefaults.sync.impressionsMode);
     // ensure a valid user consent value
     // @ts-ignore, modify readonly prop
     withDefaults.userConsent = consent(withDefaults);

package/esm/utils/settingsValidation/url.js

@@ -1,4 +1,4 @@
-var telemetryEndpointMatcher = /^\/metrics\/(config|usage)/;
+var telemetryEndpointMatcher = /^\/v1\/metrics\/(config|usage)/;
 var eventsEndpointMatcher = /^\/(testImpressions|metrics|events)/;
 var authEndpointMatcher = /^\/v2\/auth/;
 var streamingEndpointMatcher = /^\/(sse|event-stream)/;

package/package.json

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

package/src/services/splitApi.ts

@@ -108,12 +108,12 @@ export function splitApiFactory(
     },
 
     postMetricsConfig(body: string) {
-      const url = `${urls.telemetry}/metrics/config`;
+      const url = `${urls.telemetry}/v1/metrics/config`;
       return splitHttpClient(url, { method: 'POST', body }, telemetryTracker.trackHttp(TELEMETRY), true);
     },
 
     postMetricsUsage(body: string) {
-      const url = `${urls.telemetry}/metrics/usage`;
+      const url = `${urls.telemetry}/v1/metrics/usage`;
       return splitHttpClient(url, { method: 'POST', body }, telemetryTracker.trackHttp(TELEMETRY), true);
     }
   };

package/src/sync/submitters/submitter.ts

@@ -16,7 +16,7 @@ export function submitterFactory<TState>(
   dataName: string,
   fromCacheToPayload?: (cacheData: TState) => any,
   maxRetries: number = 0,
-  debugLogs?: boolean
+  debugLogs?: boolean // true for telemetry submitters
 ): ISyncTask<[], void> {
 
   let retries = 0;
@@ -37,14 +37,14 @@ export function submitterFactory<TState>(
       sourceCache.clear(); // we clear the queue if request successes.
     }).catch(err => {
       if (!maxRetries) {
-        log.warn(SUBMITTERS_PUSH_FAILS, [dataCountMessage, err]);
+        log[debugLogs ? 'debug' : 'warn'](SUBMITTERS_PUSH_FAILS, [dataCountMessage, err]);
       } else if (retries === maxRetries) {
         retries = 0;
         sourceCache.clear(); // we clear the queue if request fails after retries.
-        log.warn(SUBMITTERS_PUSH_FAILS, [dataCountMessage, err]);
+        log[debugLogs ? 'debug' : 'warn'](SUBMITTERS_PUSH_FAILS, [dataCountMessage, err]);
       } else {
         retries++;
-        log.warn(SUBMITTERS_PUSH_RETRY, [dataCountMessage, err]);
+        log[debugLogs ? 'debug' : 'warn'](SUBMITTERS_PUSH_RETRY, [dataCountMessage, err]);
       }
     });
   }

package/src/types.ts

@@ -684,7 +684,7 @@ export namespace SplitIO {
     /**
      * String property to override the base URL where the SDK will post telemetry data.
      * @property {string} telemetry
-     * @default 'https://telemetry.split.io'
+     * @default 'https://telemetry.split.io/api'
      */
     telemetry?: string
   };

package/src/utils/settingsValidation/index.ts

@@ -1,7 +1,7 @@
 import { merge } from '../lang';
 import { mode } from './mode';
 import { validateSplitFilters } from './splitFilters';
-import { STANDALONE_MODE, OPTIMIZED, LOCALHOST_MODE } from '../constants';
+import { STANDALONE_MODE, OPTIMIZED, LOCALHOST_MODE, DEBUG } from '../constants';
 import { validImpressionsMode } from './impressionsMode';
 import { ISettingsValidationParams } from './types';
 import { ISettings } from '../../types';
@@ -34,8 +34,8 @@ export const base = {
     segmentsRefreshRate: 60,
     // publish telemetry stats each 3600 secs (1 hour)
     telemetryRefreshRate: 3600,
-    // publish evaluations each 60 sec
-    impressionsRefreshRate: 60,
+    // publish evaluations each 300 sec (default value for OPTIMIZED impressions mode)
+    impressionsRefreshRate: 300,
     // fetch offline changes each 15 sec
     offlineRefreshRate: 15,
     // publish events every 60 seconds after the first flush
@@ -58,7 +58,7 @@ export const base = {
     // Streaming Server
     streaming: 'https://streaming.split.io',
     // Telemetry Server
-    telemetry: 'https://telemetry.split.io',
+    telemetry: 'https://telemetry.split.io/api',
   },
 
   // Defines which kind of storage we should instanciate.
@@ -113,6 +113,9 @@ export function settingsValidation(config: unknown, validationParams: ISettingsV
   const log = logger(withDefaults); // @ts-ignore, modify readonly prop
   withDefaults.log = log;
 
+  // ensure a valid impressionsMode
+  withDefaults.sync.impressionsMode = validImpressionsMode(log, withDefaults.sync.impressionsMode);
+
   function validateMinValue(paramName: string, actualValue: number, minValue: number) {
     if (actualValue >= minValue) return actualValue;
     // actualValue is not a number or is lower than minValue
@@ -124,11 +127,21 @@ export function settingsValidation(config: unknown, validationParams: ISettingsV
   const { scheduler, startup } = withDefaults;
   scheduler.featuresRefreshRate = fromSecondsToMillis(scheduler.featuresRefreshRate);
   scheduler.segmentsRefreshRate = fromSecondsToMillis(scheduler.segmentsRefreshRate);
-  scheduler.impressionsRefreshRate = fromSecondsToMillis(scheduler.impressionsRefreshRate);
   scheduler.offlineRefreshRate = fromSecondsToMillis(scheduler.offlineRefreshRate);
   scheduler.eventsPushRate = fromSecondsToMillis(scheduler.eventsPushRate);
   scheduler.telemetryRefreshRate = fromSecondsToMillis(validateMinValue('telemetryRefreshRate', scheduler.telemetryRefreshRate, 60));
 
+  if (scheduler.impressionsRefreshRate !== base.scheduler.impressionsRefreshRate) {
+    // Validate impressionsRefreshRate defined by user
+    scheduler.impressionsRefreshRate = validateMinValue('impressionsRefreshRate', scheduler.impressionsRefreshRate,
+      withDefaults.sync.impressionsMode === DEBUG ? 1 : 60 // Min is 1 sec for DEBUG and 60 secs for OPTIMIZED
+    );
+  } else {
+    // Default impressionsRefreshRate for DEBUG mode is 60 secs
+    if (withDefaults.sync.impressionsMode === DEBUG) scheduler.impressionsRefreshRate = 60;
+  }
+  scheduler.impressionsRefreshRate = fromSecondsToMillis(scheduler.impressionsRefreshRate);
+
   // Log deprecation for old telemetry param
   if (scheduler.metricsRefreshRate) log.warn('`metricsRefreshRate` will be deprecated soon. For configuring telemetry rates, update `telemetryRefreshRate` value in configs');
 
@@ -190,9 +203,6 @@ export function settingsValidation(config: unknown, validationParams: ISettingsV
   withDefaults.sync.splitFilters = splitFiltersValidation.validFilters;
   withDefaults.sync.__splitFiltersValidation = splitFiltersValidation;
 
-  // ensure a valid impressionsMode
-  withDefaults.sync.impressionsMode = validImpressionsMode(log, withDefaults.sync.impressionsMode);
-
   // ensure a valid user consent value
   // @ts-ignore, modify readonly prop
   withDefaults.userConsent = consent(withDefaults);

package/src/utils/settingsValidation/url.ts

@@ -1,6 +1,6 @@
 import { ISettings } from '../../types';
 
-const telemetryEndpointMatcher = /^\/metrics\/(config|usage)/;
+const telemetryEndpointMatcher = /^\/v1\/metrics\/(config|usage)/;
 const eventsEndpointMatcher = /^\/(testImpressions|metrics|events)/;
 const authEndpointMatcher = /^\/v2\/auth/;
 const streamingEndpointMatcher = /^\/(sse|event-stream)/;

package/types/types.d.ts

@@ -681,7 +681,7 @@ export declare namespace SplitIO {
         /**
          * String property to override the base URL where the SDK will post telemetry data.
          * @property {string} telemetry
-         * @default 'https://telemetry.split.io'
+         * @default 'https://telemetry.split.io/api'
          */
         telemetry?: string;
     };