#RI-4489 UTests (complete) + analytics + rename feature

Author: Artem

.github/CODEOWNERS

@@ -1,3 +1,4 @@
 # Add reviewers for the most sensitive folders
 /.github/ [email protected] [email protected]
 /.circleci/ [email protected] [email protected]
+/redisinsight/api/config/features-config.json [email protected] [email protected] [email protected]

redisinsight/api/config/features-config.json

@@ -1,14 +1,19 @@
 {
   "version": 1,
   "features": {
-    "liveRecommendations": {
+    "insightsRecommendations": {
       "flag": true,
-      "perc": [[0, 100]],
+      "perc": [],
       "filters": [
         {
           "name": "agreements.analytics",
           "value": true,
           "cond": "eq"
+        },
+        {
+          "name": "config.server.buildType",
+          "value": "ELECTRON",
+          "cond": "eq"
         }
       ]
     }

redisinsight/api/src/__mocks__/feature.ts

@@ -10,6 +10,7 @@ import { Feature } from 'src/modules/feature/model/feature';
 import { FeatureEntity } from 'src/modules/feature/entities/feature.entity';
 import { mockAppSettings } from 'src/__mocks__/app-settings';
 import config from 'src/utils/config';
+import { KnownFeatures } from 'src/modules/feature/constants';
 import * as defaultConfig from '../../config/features-config.json';
 
 export const mockFeaturesConfigId = '1';
@@ -20,7 +21,7 @@ export const mockControlGroup = '7';
 export const mockFeaturesConfigJson = {
   version: mockFeaturesConfigVersion,
   features: {
-    liveRecommendations: {
+    [KnownFeatures.InsightsRecommendations]: {
       perc: [[1.25, 8.45]],
       flag: true,
       filters: [
@@ -37,8 +38,8 @@ export const mockFeaturesConfigJson = {
 export const mockFeaturesConfigJsonComplex = {
   ...mockFeaturesConfigJson,
   features: {
-    liveRecommendations: {
-      ...mockFeaturesConfigJson.features.liveRecommendations,
+    [KnownFeatures.InsightsRecommendations]: {
+      ...mockFeaturesConfigJson.features[KnownFeatures.InsightsRecommendations],
       filters: [
         {
           or: [
@@ -80,10 +81,12 @@ export const mockFeaturesConfigJsonComplex = {
 export const mockFeaturesConfigData = Object.assign(new FeaturesConfigData(), {
   ...mockFeaturesConfigJson,
   features: new Map(Object.entries({
-    liveRecommendations: Object.assign(new FeatureConfig(), {
-      ...mockFeaturesConfigJson.features.liveRecommendations,
+    [KnownFeatures.InsightsRecommendations]: Object.assign(new FeatureConfig(), {
+      ...mockFeaturesConfigJson.features[KnownFeatures.InsightsRecommendations],
       filters: [
-        Object.assign(new FeatureConfigFilter(), { ...mockFeaturesConfigJson.features.liveRecommendations.filters[0] }),
+        Object.assign(new FeatureConfigFilter(), {
+          ...mockFeaturesConfigJson.features[KnownFeatures.InsightsRecommendations].filters[0],
+        }),
       ],
     }),
   })),
@@ -92,8 +95,8 @@ export const mockFeaturesConfigData = Object.assign(new FeaturesConfigData(), {
 export const mockFeaturesConfigDataComplex = Object.assign(new FeaturesConfigData(), {
   ...mockFeaturesConfigJson,
   features: new Map(Object.entries({
-    liveRecommendations: Object.assign(new FeatureConfig(), {
-      ...mockFeaturesConfigJson.features.liveRecommendations,
+    [KnownFeatures.InsightsRecommendations]: Object.assign(new FeatureConfig(), {
+      ...mockFeaturesConfigJson.features[KnownFeatures.InsightsRecommendations],
       filters: [
         Object.assign(new FeatureConfigFilterOr(), {
           or: [
@@ -153,13 +156,18 @@ export const mockFeaturesConfigEntityComplex = Object.assign(new FeaturesConfigE
 });
 
 export const mockFeature = Object.assign(new Feature(), {
-  name: 'liveRecommendations',
+  name: KnownFeatures.InsightsRecommendations,
+  flag: true,
+});
+
+export const mockUnknownFeature = Object.assign(new Feature(), {
+  name: 'unknown',
   flag: true,
 });
 
 export const mockFeatureEntity = Object.assign(new FeatureEntity(), {
   id: 'lr-1',
-  name: 'liveRecommendations',
+  name: KnownFeatures.InsightsRecommendations,
   flag: true,
 });
 
@@ -175,10 +183,37 @@ export const mockFeaturesConfigRepository = jest.fn(() => ({
   update: jest.fn().mockResolvedValue(mockFeaturesConfig),
 }));
 
-export const mockFeaturesConfigService = () => ({
+export const mockFeatureRepository = jest.fn(() => ({
+  get: jest.fn().mockResolvedValue(mockFeature),
+  upsert: jest.fn().mockResolvedValue({ updated: 1 }),
+  list: jest.fn().mockResolvedValue([mockFeature]),
+  delete: jest.fn().mockResolvedValue({ deleted: 1 }),
+}));
+
+export const mockFeaturesConfigService = jest.fn(() => ({
   sync: jest.fn(),
   getControlInfo: jest.fn().mockResolvedValue({
     controlNumber: mockControlNumber,
     controlGroup: mockControlGroup,
   }),
-});
+}));
+
+export const mockFeatureService = jest.fn(() => ({
+  isFeatureEnabled: jest.fn().mockResolvedValue(true),
+}));
+
+export const mockFeatureAnalytics = jest.fn(() => ({
+  sendFeatureFlagConfigUpdated: jest.fn(),
+  sendFeatureFlagConfigUpdateError: jest.fn(),
+  sendFeatureFlagInvalidRemoteConfig: jest.fn(),
+  sendFeatureFlagRecalculated: jest.fn(),
+}));
+
+export const mockInsightsRecommendationsFlagStrategy = {
+  calculate: jest.fn().mockResolvedValue(true),
+};
+
+export const mockFeatureFlagProvider = jest.fn(() => ({
+  getStrategy: jest.fn().mockResolvedValue(mockInsightsRecommendationsFlagStrategy),
+  calculate: jest.fn().mockResolvedValue(true),
+}));

redisinsight/api/src/constants/telemetry-events.ts

@@ -64,6 +64,12 @@ export enum TelemetryEvents {
   // Bulk Actions
   BulkActionsStarted = 'BULK_ACTIONS_STARTED',
   BulkActionsStopped = 'BULK_ACTIONS_STOPPED',
+
+  // Feature
+  FeatureFlagConfigUpdated = 'FEATURE_FLAG_CONFIG_UPDATED',
+  FeatureFlagConfigUpdateError = 'FEATURE_FLAG_CONFIG_UPDATE_ERROR',
+  FeatureFlagInvalidRemoteConfig = 'FEATURE_FLAG_INVALID_REMOTE_CONFIG',
+  FeatureFlagRecalculated = 'FEATURE_FLAG_RECALCULATED',
 }
 
 export enum CommandType {

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

@@ -1,7 +1,7 @@
 import { Test, TestingModule } from '@nestjs/testing';
 import {
   mockAppSettings,
-  mockAppSettingsWithoutPermissions,
+  mockAppSettingsWithoutPermissions, mockControlGroup, mockControlNumber,
   mockSettingsService,
   MockType,
 } from 'src/__mocks__';
@@ -53,7 +53,13 @@ describe('AnalyticsService', () => {
 
   describe('initialize', () => {
     it('should set anonymousId', () => {
-      service.initialize({ anonymousId: mockAnonymousId, sessionId, appType: AppType.Electron });
+      service.initialize({
+        anonymousId: mockAnonymousId,
+        sessionId,
+        appType: AppType.Electron,
+        controlNumber: mockControlNumber,
+        controlGroup: mockControlGroup,
+      });
 
       const anonymousId = service.getAnonymousId();
 
@@ -64,7 +70,13 @@ describe('AnalyticsService', () => {
   describe('sendEvent', () => {
     beforeEach(() => {
       mockAnalyticsTrack = jest.fn();
-      service.initialize({ anonymousId: mockAnonymousId, sessionId, appType: AppType.Electron });
+      service.initialize({
+        anonymousId: mockAnonymousId,
+        sessionId,
+        appType: AppType.Electron,
+        controlNumber: mockControlNumber,
+        controlGroup: mockControlGroup,
+      });
     });
     it('should send event with anonymousId if permission are granted', async () => {
       settingsService.getAppSettings.mockResolvedValue(mockAppSettings);
@@ -81,6 +93,8 @@ describe('AnalyticsService', () => {
         event: TelemetryEvents.ApplicationStarted,
         properties: {
           buildType: AppType.Electron,
+          controlNumber: mockControlNumber,
+          controlGroup: mockControlGroup,
         },
       });
     });
@@ -110,6 +124,8 @@ describe('AnalyticsService', () => {
         event: TelemetryEvents.ApplicationStarted,
         properties: {
           buildType: AppType.Electron,
+          controlNumber: mockControlNumber,
+          controlGroup: mockControlGroup,
         },
       });
     });

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

@@ -19,7 +19,8 @@ export interface ITelemetryInitEvent {
   anonymousId: string;
   sessionId: number;
   appType: string;
-  controlGroup: number;
+  controlNumber: number;
+  controlGroup: string;
 }
 
 @Injectable()
@@ -30,7 +31,9 @@ export class AnalyticsService {
 
   private appType: string = 'unknown';
 
-  private controlGroup: number = -1;
+  private controlNumber: number = -1;
+
+  private controlGroup: string = '-1';
 
   private analytics;
 
@@ -44,11 +47,14 @@ export class AnalyticsService {
 
   @OnEvent(AppAnalyticsEvents.Initialize)
   public initialize(payload: ITelemetryInitEvent) {
-    const { anonymousId, sessionId, appType, controlGroup } = payload;
+    const {
+      anonymousId, sessionId, appType, controlNumber, controlGroup,
+    } = payload;
     this.sessionId = sessionId;
     this.anonymousId = anonymousId;
     this.appType = appType;
     this.controlGroup = controlGroup;
+    this.controlNumber = controlNumber;
     this.analytics = new Analytics(ANALYTICS_CONFIG.writeKey, {
       flushInterval: ANALYTICS_CONFIG.flushInterval,
     });
@@ -79,6 +85,7 @@ export class AnalyticsService {
           properties: {
             ...eventData,
             buildType: this.appType,
+            controlNumber: this.controlNumber,
             controlGroup: this.controlGroup,
           },
         });

redisinsight/api/src/modules/database-recommendation/scanner/recommendations.scanner.spec.ts

@@ -1,6 +1,8 @@
 import { Test, TestingModule } from '@nestjs/testing';
 import { RecommendationScanner } from 'src/modules/database-recommendation/scanner/recommendations.scanner';
 import { RecommendationProvider } from 'src/modules/database-recommendation/scanner/recommendation.provider';
+import { FeatureService } from 'src/modules/feature/feature.service';
+import { mockFeatureService, MockType } from 'src/__mocks__';
 
 const mockRecommendationStrategy = () => ({
   isRecommendationReached: jest.fn(),
@@ -16,6 +18,7 @@ describe('RecommendationScanner', () => {
   let service: RecommendationScanner;
   let recommendationProvider;
   let recommendationStrategy;
+  let featureService: MockType<FeatureService>;
 
   beforeEach(async () => {
     const module: TestingModule = await Test.createTestingModule({
@@ -25,11 +28,16 @@ describe('RecommendationScanner', () => {
           provide: RecommendationProvider,
           useFactory: mockRecommendationProvider,
         },
+        {
+          provide: FeatureService,
+          useFactory: mockFeatureService,
+        },
       ],
     }).compile();
 
     service = module.get<RecommendationScanner>(RecommendationScanner);
     recommendationProvider = module.get<RecommendationProvider>(RecommendationProvider);
+    featureService = module.get(FeatureService);
     recommendationStrategy = mockRecommendationStrategy();
     recommendationProvider.getStrategy.mockReturnValue(recommendationStrategy);
   });
@@ -43,6 +51,16 @@ describe('RecommendationScanner', () => {
       })).toEqual({ name: 'name' });
     });
 
+    it('should return null when feature disabled', async () => {
+      featureService.isFeatureEnabled.mockResolvedValueOnce(false);
+
+      recommendationStrategy.isRecommendationReached.mockResolvedValue({ isReached: true });
+
+      expect(await service.determineRecommendation('name', {
+        data: mockData,
+      })).toEqual(null);
+    });
+
     it('should return null when isRecommendationReached throw error', async () => {
       recommendationStrategy.isRecommendationReached.mockRejectedValueOnce(new Error());
 

redisinsight/api/src/modules/database-recommendation/scanner/recommendations.scanner.ts

@@ -1,13 +1,20 @@
 import { Injectable } from '@nestjs/common';
 import { RecommendationProvider } from 'src/modules/database-recommendation/scanner/recommendation.provider';
+import { FeatureService } from 'src/modules/feature/feature.service';
+import { KnownFeatures } from 'src/modules/feature/constants';
 
 @Injectable()
 export class RecommendationScanner {
   constructor(
     private readonly recommendationProvider: RecommendationProvider,
+    private readonly featureService: FeatureService,
   ) {}
 
   async determineRecommendation(name: string, data: any) {
+    if (!await this.featureService.isFeatureEnabled(KnownFeatures.InsightsRecommendations)) {
+      return null;
+    }
+
     const strategy = this.recommendationProvider.getStrategy(name);
     try {
       const recommendation = await strategy.isRecommendationReached(data);

redisinsight/api/src/modules/feature/constants/index.ts

@@ -11,14 +11,18 @@ export enum FeatureStorage {
   Env = 'env',
   Database = 'database',
 }
+export enum FeatureConfigConfigDestination {
+  Default = 'default',
+  Remote = 'remote',
+}
 
-export enum FeatureRecalculationStrategy {
-  LiveRecommendation = 'liveRecommendation',
+export enum KnownFeatures {
+  InsightsRecommendations = 'insightsRecommendations',
 }
 
 export const knownFeatures = [
   {
-    name: 'liveRecommendations',
+    name: KnownFeatures.InsightsRecommendations,
     storage: FeatureStorage.Database,
   },
 ];

redisinsight/api/src/modules/feature/exceptions/index.ts

@@ -0,0 +1 @@
+export * from './unable-to-fetch-remote-config.exception';