Telemetry v2: type definitions

CHANGES.txt

@@ -1,3 +1,9 @@
+10.19.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,
+   in both Browser and NodeJS (previously it was 60s and 300s in Browser and NodeJS respectively, equal for DEBUG and OPTIMIZED impression modes).
+
 10.18.2 (May 6, 2022)
  - Bugfixing - Removed "ip" dependency to use an inline copy of it that fixes an error when using it in Node v18 (https://github.com/indutny/node-ip/issues/113).
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio",
-  "version": "10.18.2",
+  "version": "10.19.0",
   "description": "Split SDK",
   "files": [
     "README.md",
@@ -32,7 +32,7 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.3.1",
+    "@splitsoftware/splitio-commons": "1.4.0",
     "@types/google.analytics": "0.0.40",
     "@types/ioredis": "^4.28.0",
     "ioredis": "^4.28.0",

src/__tests__/browser.spec.js

@@ -4,7 +4,7 @@ import { url } from './testUtils';
 import evaluationsSuite from './browserSuites/evaluations.spec';
 import impressionsSuite from './browserSuites/impressions.spec';
 import impressionsSuiteDebug from './browserSuites/impressions.debug.spec';
-// import metricsSuite from './browserSuites/metrics.spec';
+import telemetrySuite from './browserSuites/telemetry.spec';
 import impressionsListenerSuite from './browserSuites/impressions-listener.spec';
 import readinessSuite from './browserSuites/readiness.spec';
 import readyFromCache from './browserSuites/ready-from-cache.spec';
@@ -45,7 +45,6 @@ const configInMemory = {
   scheduler: {
     featuresRefreshRate: 1,
     segmentsRefreshRate: 1,
-    metricsRefreshRate: 3000, // for now I don't want to publish metrics during E2E run.
     impressionsRefreshRate: 3000  // for now I don't want to publish impressions during E2E run.
   },
   streamingEnabled: false
@@ -62,7 +61,6 @@ const configInMemoryWithBucketingKey = {
   scheduler: {
     featuresRefreshRate: 1,
     segmentsRefreshRate: 1,
-    metricsRefreshRate: 3000, // for now I don't want to publish metrics during E2E run.
     impressionsRefreshRate: 3000  // for now I don't want to publish impressions during E2E run.
   },
   streamingEnabled: false
@@ -76,7 +74,6 @@ const configInLocalStorage = {
   scheduler: {
     featuresRefreshRate: 1,
     segmentsRefreshRate: 1,
-    metricsRefreshRate: 3000, // for now I don't want to publish metrics during E2E run.
     impressionsRefreshRate: 3000  // for now I don't want to publish impressions during E2E run.
   },
   storage: {
@@ -108,9 +105,8 @@ tape('## E2E CI Tests ##', function(assert) {
   assert.test('E2E / Impressions Debug Mode', impressionsSuiteDebug.bind(null, fetchMock));
   /* Check impression listener */
   assert.test('E2E / Impression listener', impressionsListenerSuite);
-  /* Check metrics */
-  // @TODO uncomment when telemetry is implemented
-  // assert.test('E2E / Metrics', metricsSuite.bind(null, fetchMock));
+  /* Check telemetry */
+  assert.test('E2E / Telemetry', telemetrySuite.bind(null, fetchMock));
   /* Check events */
   assert.test('E2E / Events', withoutBindingTT.bind(null, fetchMock));
   assert.test('E2E / Events with TT binded', bindingTT.bind(null, fetchMock));

src/__tests__/browserSuites/events.spec.js

@@ -17,7 +17,6 @@ const baseSettings = {
   scheduler: {
     featuresRefreshRate: 1,
     segmentsRefreshRate: 1,
-    metricsRefreshRate: 3000,
     impressionsRefreshRate: 3000,
     eventsPushRate: 3000
   },

src/__tests__/browserSuites/ignore-ip-addresses-setting.spec.js

@@ -11,7 +11,6 @@ const HEADER_SPLITSDKMACHINENAME = 'SplitSDKMachineName';
 // Refresh rates are set to 1 second to finish the test quickly. Otherwise, it would finish in 1 minute (60 seconds is the default value)
 const baseConfig = {
   scheduler: {
-    metricsRefreshRate: 1,
     impressionsRefreshRate: 1,
     eventsPushRate: 1
   },
@@ -71,9 +70,6 @@ const configSamples = [
 const postEndpoints = [
   '/events/bulk',
   '/testImpressions/bulk',
-  // @TODO uncomment when telemetry is implemented
-  // '/metrics/times',
-  // '/metrics/counters'
 ];
 
 export default function (fetchMock, assert) {

src/__tests__/browserSuites/impressions-listener.spec.js

@@ -21,7 +21,6 @@ const config = {
   scheduler: {
     featuresRefreshRate: 1,
     segmentsRefreshRate: 1,
-    metricsRefreshRate: 3000,
     impressionsRefreshRate: 3000
   },
   startup: {

src/__tests__/browserSuites/impressions.debug.spec.js

@@ -33,7 +33,6 @@ export default function (fetchMock, assert) {
     scheduler: {
       featuresRefreshRate: 0.5,
       segmentsRefreshRate: 0.5,
-      metricsRefreshRate: 3000,
       impressionsRefreshRate: 3000,
       impressionsQueueSize: 3 // flush impressions when 3 are queued
     },

src/__tests__/browserSuites/impressions.spec.js

@@ -36,7 +36,6 @@ export default function (fetchMock, assert) {
     scheduler: {
       featuresRefreshRate: 0.5,
       segmentsRefreshRate: 0.5,
-      metricsRefreshRate: 3000,
       impressionsRefreshRate: 0.5
     },
     startup: {

src/__tests__/browserSuites/push-fallbacking.spec.js

@@ -51,7 +51,6 @@ const config = {
   scheduler: {
     featuresRefreshRate: 0.2,
     segmentsRefreshRate: 0.25,
-    metricsRefreshRate: 3000,
     impressionsRefreshRate: 3000
   },
   urls: baseUrls,

src/__tests__/browserSuites/push-initialization-nopush.spec.js

@@ -24,7 +24,6 @@ const config = {
   scheduler: {
     featuresRefreshRate: 0.1,
     segmentsRefreshRate: 0.1,
-    metricsRefreshRate: 3000,
     impressionsRefreshRate: 3000,
     pushRetryBackoffBase: 0.01 // small value to assert rapidly that push is not retried
   },

src/__tests__/browserSuites/push-initialization-retries.spec.js

@@ -26,7 +26,6 @@ const config = {
   scheduler: {
     featuresRefreshRate: 0.2,
     segmentsRefreshRate: 0.2,
-    metricsRefreshRate: 3000,
     impressionsRefreshRate: 3000,
     pushRetryBackoffBase: 0.1
   },