Prepare release v1.4.0 with telemetry v2

CHANGES.txt

@@ -1,3 +1,8 @@
+1.4.0 (May 20, 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.2-rc.5",
+  "version": "1.4.0",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

src/sync/submitters/__tests__/telemetrySubmitter.spec.ts

@@ -61,7 +61,7 @@ describe('Telemetry submitter', () => {
     expect(recordTimeUntilReadySpy).toBeCalledTimes(1);
 
     expect(postMetricsConfig).toBeCalledWith(JSON.stringify({
-      oM: 0, st: 'memory', aF: 0, rF: 0, sE: true, rR: { sp: 0.001, se: 0.001, im: 0.001, ev: 0.001, te: 0.1 }, uO: { s: true, e: true, a: true, st: true, t: true }, iQ: 1, eQ: 1, iM: 0, iL: false, hP: false, tR: 0, tC: 0, nR: 0, t: [], i: ['NoopIntegration'], uC: 0
+      oM: 0, st: 'memory', aF: 0, rF: 0, sE: true, rR: { sp: 0.001, ms: 0.001, im: 0.001, ev: 0.001, te: 0.1 }, uO: { s: true, e: true, a: true, st: true, t: true }, iQ: 1, eQ: 1, iM: 0, iL: false, hP: false, tR: 0, tC: 0, nR: 0, t: [], i: ['NoopIntegration'], uC: 0
     }));
 
     // Stop submitter, to not execute the 1st periodic metrics/usage POST

src/sync/submitters/telemetrySubmitter.ts

@@ -90,12 +90,14 @@ export function telemetryCacheConfigAdapter(telemetry: ITelemetryCacheSync, sett
 
     state(): TelemetryConfigStatsPayload {
       const { urls, scheduler } = settings;
+      const isClientSide = settings.core.key !== undefined;
 
       return objectAssign(getTelemetryConfigStats(settings.mode, settings.storage.type), {
         sE: settings.streamingEnabled,
         rR: {
           sp: scheduler.featuresRefreshRate / 1000,
-          se: scheduler.segmentsRefreshRate / 1000,
+          se: isClientSide ? undefined : scheduler.segmentsRefreshRate / 1000,
+          ms: isClientSide ? scheduler.segmentsRefreshRate / 1000 : undefined,
           im: scheduler.impressionsRefreshRate / 1000,
           ev: scheduler.eventsPushRate / 1000,
           te: scheduler.telemetryRefreshRate / 1000,

src/sync/submitters/types.ts

@@ -151,7 +151,8 @@ export type ImpressionsMode = OPTIMIZED_ENUM | DEBUG_ENUM;
 
 export type RefreshRates = {
   sp: number, // splits
-  se: number, // mySegments
+  se?: number, // segments
+  ms?: number, // mySegments
   im: number, // impressions
   ev: number, // events
   te: number, // telemetry

src/utils/timeTracker/now/__tests__/now.spec.ts

@@ -16,15 +16,21 @@ limitations under the License.
 
 import { now as nowBrowser } from '../browser';
 import { now as nowNode } from '../node';
+import { nearlyEqual } from '../../../../__tests__/testUtils/index';
 
 [nowBrowser, nowNode].forEach(now => {
-  test('NOW / should generate a value each time you call it', () => {
-    let n1 = now();
-    let n2 = now();
-    let n3 = now();
+  test('NOW / should generate a value each time you call it', async () => {
+    const n1 = now();
+    const n2 = now();
+
+    const delay = 200;
+    await new Promise(res => setTimeout(res, delay));
+    const n3 = now();
 
     expect(Number.isFinite(n1)).toBe(true); // is a finite value?
     expect(Number.isFinite(n2)).toBe(true); // is a finite value?
     expect(Number.isFinite(n3)).toBe(true); // is a finite value?
+    expect(nearlyEqual(n1, n2)).toBe(true);
+    expect(nearlyEqual(n1 + delay, n3)).toBe(true);
   });
 });