Merge pull request #1822 from RedisInsight/be/feature/RI-telemetry_tests

#RI-4175 cover telemetry events with ITests

Author: arthosofteq

redisinsight/api/config/default.ts

@@ -97,6 +97,7 @@ export default {
   },
   analytics: {
     writeKey: process.env.SEGMENT_WRITE_KEY || 'SOURCE_WRITE_KEY',
+    flushInterval: parseInt(process.env.ANALYTICS_FLUSH_INTERVAL, 10) || 3000,
   },
   logger: {
     logLevel: process.env.LOG_LEVEL || 'info', // log level

redisinsight/api/config/production.ts

@@ -25,6 +25,7 @@ export default {
   },
   analytics: {
     writeKey: process.env.SEGMENT_WRITE_KEY || 'lK5MNZgHbxj6vQwFgqZxygA0BiDQb32n',
+    flushInterval: parseInt(process.env.ANALYTICS_FLUSH_INTERVAL, 10) || 10000,
   },
   db: {
     database: join(homedir, 'redisinsight.db'),

redisinsight/api/package.json

@@ -110,6 +110,7 @@
     "mocha": "^8.4.0",
     "mocha-junit-reporter": "^2.0.0",
     "mocha-multi-reporters": "^1.5.1",
+    "nock": "^13.3.0",
     "nyc": "^15.1.0",
     "object-diff": "^0.0.4",
     "rimraf": "^3.0.2",

redisinsight/api/src/modules/analytics/analytics.service.ts

@@ -45,7 +45,9 @@ export class AnalyticsService {
     this.sessionId = sessionId;
     this.anonymousId = anonymousId;
     this.appType = appType;
-    this.analytics = new Analytics(ANALYTICS_CONFIG.writeKey);
+    this.analytics = new Analytics(ANALYTICS_CONFIG.writeKey, {
+      flushInterval: ANALYTICS_CONFIG.flushInterval,
+    });
   }
 
   @OnEvent(AppAnalyticsEvents.Track)

redisinsight/api/test/api/analytics/analytics.test.ts

@@ -0,0 +1,34 @@
+import {
+  expect,
+  describe,
+  it,
+  deps,
+  requirements,
+} from '../deps';
+const { analytics } = deps;
+
+
+describe('Analytics', () => {
+  requirements('rte.serverType=local');
+
+  it('APPLICATION_STARTED', () => {
+    const appStarted = analytics.findEvent({
+      event: 'APPLICATION_STARTED',
+    })
+
+    const appFirstStarted = analytics.findEvent({
+      event: 'APPLICATION_FIRST_START',
+    })
+
+    const found = appStarted || appFirstStarted;
+
+    if (!found) {
+      fail('APPLICATION_STARTED or APPLICATION_FIRST_START events were not found');
+    }
+
+    expect(found?.properties).to.have.all.keys('appVersion', 'osPlatform', 'buildType');
+    expect(found?.properties?.appVersion).to.be.a('string');
+    expect(found?.properties?.osPlatform).to.be.a('string');
+    expect(found?.properties?.buildType).to.be.a('string');
+  });
+});

redisinsight/api/test/api/cli/POST-databases-id-cli-uuid-send_command.test.ts

@@ -9,9 +9,9 @@ import {
   generateInvalidDataTestCases,
   validateInvalidDataTestCase,
   validateApiCall,
-  requirements,
+  requirements, serverConfig
 } from '../deps';
-const { server, request, constants, rte } = deps;
+const { server, request, constants, rte, analytics } = deps;
 
 // endpoint to test
 const endpoint = (instanceId = constants.TEST_INSTANCE_ID, uuid = constants.TEST_CLI_UUID_1) =>
@@ -87,6 +87,18 @@ describe('POST /databases/:instanceId/cli/:uuid/send-command', () => {
           },
           after: async () => {
             expect(await rte.client.get(constants.TEST_STRING_KEY_1)).to.eql(constants.TEST_STRING_VALUE_1);
+            await analytics.waitForEvent({
+              event: 'CLI_COMMAND_EXECUTED',
+              properties: {
+                databaseId: constants.TEST_INSTANCE_ID,
+                commandType: 'core',
+                moduleName: 'n/a',
+                capability: 'string',
+                command: 'SET',
+                outputFormat: 'TEXT',
+                buildType: serverConfig.get('server').buildType,
+              },
+            });
           }
         },
         {

redisinsight/api/test/api/database/POST-databases.test.ts

@@ -7,10 +7,10 @@ import {
   requirements,
   validateApiCall,
   after,
-  generateInvalidDataTestCases, validateInvalidDataTestCase, getMainCheckFn
+  generateInvalidDataTestCases, validateInvalidDataTestCase, getMainCheckFn, serverConfig,
 } from '../deps';
 import { databaseSchema } from './constants';
-const { rte, request, server, localDb, constants } = deps;
+const { rte, request, server, localDb, constants, analytics } = deps;
 
 const endpoint = () => request(server).post(`/${constants.API.DATABASES}`);
 
@@ -134,6 +134,38 @@ describe('POST /databases', () => {
             connectionType: constants.STANDALONE,
             new: true,
           },
+          checkFn: async ({ body }) => {
+            // todo: find a way to test rest of the fields
+            await analytics.waitForEvent({
+              event: 'CONFIG_DATABASES_DATABASE_ADDED',
+              properties: {
+                databaseId: body.id,
+                connectionType: body.connectionType,
+                provider: body.provider,
+                useTLS: 'disabled',
+                verifyTLSCertificate: 'disabled',
+                useTLSAuthClients: 'disabled',
+                useSNI: 'disabled',
+                useSSH: 'disabled',
+                version: rte.env.version,
+                // numberOfKeys: 8,
+                // numberOfKeysRange: '0 - 500 000',
+                // totalMemory: 881632,
+                // numberedDatabases: 16,
+                // numberOfModules: 0,
+                timeout: body.timeout / 1000,
+                // RediSearch: { loaded: false },
+                // RedisAI: { loaded: false },
+                // RedisGraph: { loaded: false },
+                // RedisGears: { loaded: false },
+                // RedisBloom: { loaded: false },
+                // RedisJSON: { loaded: false },
+                // RedisTimeSeries: { loaded: false },
+                // customModules: [],
+                buildType: serverConfig.get('server').buildType,
+              },
+            });
+          },
         });
       });
       describe('Enterprise', () => {

redisinsight/api/test/api/deps.ts

@@ -1,3 +1,6 @@
+import { getAnalytics } from '../helpers/analytics';
+export { createAnalytics } from '../helpers/analytics';
+
 export * from '../helpers/test';
 import * as request from 'supertest';
 import * as chai from 'chai';
@@ -16,6 +19,10 @@ export async function depsInit () {
   if(constants.TEST_CLOUD_RTE) {
     await initCloudDatabase();
   }
+
+  // initialize analytics module
+  deps.analytics = await getAnalytics();
+
   // initializing backend server
   deps.server = await getServer();
 
@@ -40,6 +47,7 @@ export const deps = {
   request,
   expect: chai.expect,
   server: null,
+  analytics: null,
   getSocket,
   rte: null,
   testEnv,

redisinsight/api/test/helpers/analytics.ts

@@ -0,0 +1,54 @@
+import { EventEmitter } from 'events';
+import * as nock from 'nock';
+import * as _ from 'lodash';
+import { isMatch } from 'lodash';
+
+let analytics;
+
+export class Analytics extends EventEmitter {
+  public messages = [];
+
+  constructor() {
+    super();
+    const scope = nock('https://api.segment.io')
+      .post('/v1/batch', (body) => {
+        const batchMessages = body?.batch || [];
+        this.messages = this.messages.concat(batchMessages);
+        this.emit('batch', batchMessages);
+        return true;
+      })
+      .reply(200, {})
+
+    scope.persist();
+  }
+
+  public findEvent(event: any, messages = this.messages) {
+    return _.find(messages, (message) => {
+      return isMatch(message, event);
+    });
+  }
+
+  public async waitForEvent(event) {
+    await new Promise((res, rej) => {
+      this.once('batch', (batch) => {
+        const exists = this.findEvent(event, batch);
+
+        if (!exists) {
+          rej(new Error(`Unable to find event:\n${JSON.stringify(event)}\nin the events batch:\n${JSON.stringify(batch)}`));
+        }
+
+        res(exists);
+      });
+
+      setTimeout(() => rej(new Error(`No event ${JSON.stringify(event)} received in 10s`)), 10000);
+    });
+  }
+}
+
+export const getAnalytics = () => {
+  return analytics || createAnalytics();
+};
+
+export const createAnalytics = () => {
+  return new Analytics();
+}

redisinsight/api/test/helpers/local-db.ts

@@ -483,6 +483,7 @@ export const initAgreements = async () => {
   agreements.data = JSON.stringify({
     eula: true,
     encryption: constants.TEST_ENCRYPTION_STRATEGY === 'KEYTAR',
+    analytics: true,
   });
 
   await rep.save(agreements);