Fix/feature events (#924)

package.json

@@ -108,7 +108,7 @@
     "response-time": "^2.3.2",
     "serve-favicon": "^2.5.0",
     "stoppable": "^1.1.0",
-    "unleash-frontend": "4.1.0-beta.5",
+    "unleash-frontend": "4.1.0-beta.6",
     "uuid": "^8.3.2"
   },
   "devDependencies": {

src/lib/db/feature-strategy-store.ts

@@ -293,6 +293,7 @@ class FeatureStrategiesStore implements IFeatureStrategiesStore {
             featureToggle.environments = Object.values(
                 featureToggle.environments,
             );
+            featureToggle.archived = archived;
             return featureToggle;
         }
         throw new NotFoundError(

src/lib/event-differ.js

@@ -148,11 +148,17 @@ function eachConsecutiveEvent(events, callback) {
     });
 }
 
-function addDiffs(events) {
+const ignoredProps = ['createdAt', 'lastSeenAt', 'environments', 'id'];
+
+const filterProps = (path, key) => {
+    return ignoredProps.includes(key);
+};
+
+function addDiffs(events = []) {
     // TODO: no-param-reassign
     eachConsecutiveEvent(events, (left, right) => {
         if (right) {
-            left.diffs = diff(right.data, left.data);
+            left.diffs = diff(right.data, left.data, filterProps);
             left.diffs = left.diffs || [];
         } else {
             left.diffs = null;

src/lib/routes/admin-api/feature.ts

@@ -197,26 +197,21 @@ class FeatureController extends Controller {
 
         updatedFeature.name = featureName;
 
-        const featureToggleExists = await this.featureService2.hasFeature(
-            featureName,
-        );
-        if (featureToggleExists) {
-            await this.featureService2.getFeature(featureName);
         const projectId = await this.featureService2.getProjectId(
             updatedFeature.name,
         );
         const value = await featureSchema.validateAsync(updatedFeature);
-            const { enabled } = value;
+
-            const updatedToggle = this.featureService2.updateFeatureToggle(
+        await this.featureService2.updateFeatureToggle(
             projectId,
             value,
             userName,
         );
 
         await this.featureService2.removeAllStrategiesForEnv(featureName);
-            let strategies;
+
         if (updatedFeature.strategies) {
-                strategies = await Promise.all(
+            await Promise.all(
                 updatedFeature.strategies.map(async (s) =>
                     this.featureService2.createStrategy(
                         s,
@@ -232,18 +227,9 @@ class FeatureController extends Controller {
             updatedFeature.enabled,
             userName,
         );
-            res.status(200).json({
+
-                ...updatedToggle,
+        const feature = await this.getLegacyFeatureToggle(featureName);
-                enabled,
+        res.status(200).json(feature);
-                strategies: strategies || [],
-            });
-        } else {
-            res.status(404)
-                .json({
-                    error: `Feature with name ${featureName} does not exist`,
-                })
-                .end();
-        }
     }
 
     // TODO: remove?

src/lib/services/event-service.ts

@@ -3,6 +3,7 @@ import { IUnleashStores } from '../types/stores';
 import { Logger } from '../logger';
 import { IEventStore } from '../types/stores/event-store';
 import { IEvent } from '../types/model';
+import { FEATURE_METADATA_UPDATED } from '../types/events';
 
 export default class EventService {
     private logger: Logger;
@@ -22,7 +23,10 @@ export default class EventService {
     }
 
     async getEventsForToggle(name: string): Promise<IEvent[]> {
-        return this.eventStore.getEventsFilterByType(name);
+        const events = await this.eventStore.getEventsFilterByType(name);
+        return events.filter(
+            (e: IEvent) => e.type !== FEATURE_METADATA_UPDATED,
+        );
     }
 }
 

src/lib/services/feature-toggle-service-v2.ts

@@ -14,6 +14,7 @@ import {
     FEATURE_STALE_OFF,
     FEATURE_STALE_ON,
     FEATURE_UPDATED,
+    FEATURE_METADATA_UPDATED,
 } from '../types/events';
 import { GLOBAL_ENV } from '../types/environment';
 import NotFoundError from '../error/notfound-error';
@@ -31,6 +32,7 @@ import {
     FeatureToggle,
     FeatureToggleDTO,
     FeatureToggleWithEnvironment,
+    FeatureToggleWithEnvironmentLegacy,
     IFeatureEnvironmentInfo,
     IFeatureStrategy,
     IFeatureToggleQuery,
@@ -91,6 +93,12 @@ class FeatureToggleServiceV2 {
         this.featureEnvironmentStore = featureEnvironmentStore;
     }
 
+    /*
+    TODO after 4.1.0 release:
+    - add FEATURE_STRATEGY_ADD event
+    - add FEATURE_STRATEGY_REMOVE event
+    - add FEATURE_STRATEGY_UPDATE event
+    */
     async createStrategy(
         strategyConfig: Omit<IStrategyConfig, 'id'>,
         projectName: string,
@@ -251,22 +259,19 @@ class FeatureToggleServiceV2 {
         updatedFeature: FeatureToggleDTO,
         userName: string,
     ): Promise<FeatureToggle> {
+        const featureName = updatedFeature.name;
         this.logger.info(
-            `${userName} updates feature toggle ${updatedFeature.name}`,
+            `${userName} updates feature toggle ${featureName}`,
         );
 
-        await this.featureToggleStore.hasFeature(updatedFeature.name);
-
         const featureToggle = await this.featureToggleStore.updateFeature(
             projectId,
             updatedFeature,
         );
-        const tags =
+        const tags = await this.featureTagStore.getAllTagsForFeature(featureName);
-            (await this.featureTagStore.getAllTagsForFeature(
+
-                updatedFeature.name,
-            )) || [];
         await this.eventStore.store({
-            type: FEATURE_UPDATED,
+            type: FEATURE_METADATA_UPDATED,
             createdBy: userName,
             data: featureToggle,
             tags,
@@ -375,14 +380,13 @@ class FeatureToggleServiceV2 {
         );
         feature.stale = isStale;
         await this.featureToggleStore.updateFeature(feature.project, feature);
-        const tags =
+        const tags = await this.featureTagStore.getAllTagsForFeature(featureName);
-            (await this.featureTagStore.getAllTagsForFeature(featureName)) ||
+        const data = await this.getFeatureToggleLegacy(featureName);
-            [];
 
         await this.eventStore.store({
             type: isStale ? FEATURE_STALE_ON : FEATURE_STALE_OFF,
             createdBy: userName,
-            data: feature,
+            data,
             tags,
         });
         return feature;
@@ -413,7 +417,6 @@ class FeatureToggleServiceV2 {
                 featureName,
             );
         if (hasEnvironment) {
-            const newEnabled =
             await this.featureEnvironmentStore.toggleEnvironmentEnabledStatus(
                     environment,
                     featureName,
@@ -422,14 +425,13 @@ class FeatureToggleServiceV2 {
             const feature = await this.featureToggleStore.getFeatureMetadata(
                 featureName,
             );
-            const tags =
+            const tags = await this.featureTagStore.getAllTagsForFeature(featureName);
-                (await this.featureTagStore.getAllTagsForFeature(
+            const data = await this.getFeatureToggleLegacy(featureName);
-                    featureName,
+
-                )) || [];
             await this.eventStore.store({
                 type: FEATURE_UPDATED,
                 createdBy: userName,
-                data: { ...feature, enabled: newEnabled },
+                data,
                 tags,
             });
             return feature;
@@ -459,6 +461,15 @@ class FeatureToggleServiceV2 {
         );
     }
 
+    async getFeatureToggleLegacy(featureName: string): Promise<FeatureToggleWithEnvironmentLegacy> {
+        const feature = await this.featureStrategiesStore.getFeatureToggleAdmin(featureName);
+        const globalEnv = feature.environments.find(e => e.name === GLOBAL_ENV);
+        const strategies = globalEnv?.strategies || [];
+        const enabled = globalEnv?.enabled || false;
+
+        return {...feature, enabled, strategies };
+    }
+
     // @deprecated
     async updateField(
         featureName: string,
@@ -473,14 +484,16 @@ class FeatureToggleServiceV2 {
         );
         feature[field] = value;
         await this.featureToggleStore.updateFeature(feature.project, feature);
-        const tags =
+        const tags = await this.featureTagStore.getAllTagsForFeature(featureName);
-            (await this.featureTagStore.getAllTagsForFeature(featureName)) ||
+
-            [];
+        
+        // Workaround to support pre 4.1 format
+        const data = await this.getFeatureToggleLegacy(featureName);
 
         await this.eventStore.store({
             type: event || FEATURE_UPDATED,
             createdBy: userName,
-            data: feature,
+            data,
             tags,
         });
         return feature;

src/lib/types/events.ts

@@ -2,6 +2,7 @@ export const APPLICATION_CREATED = 'application-created';
 export const FEATURE_CREATED = 'feature-created';
 export const FEATURE_DELETED = 'feature-deleted';
 export const FEATURE_UPDATED = 'feature-updated';
+export const FEATURE_METADATA_UPDATED = 'feature-metadata-updated';
 export const FEATURE_PROJECT_CHANGE = 'feature-project-change';
 export const FEATURE_ARCHIVED = 'feature-archived';
 export const FEATURE_REVIVED = 'feature-revived';

src/lib/types/model.ts

@@ -63,6 +63,13 @@ export interface FeatureToggleWithEnvironment extends FeatureToggle {
     environments: IEnvironmentDetail[];
 }
 
+// @deprecated
+export interface FeatureToggleWithEnvironmentLegacy
+    extends FeatureToggleWithEnvironment {
+    strategies: IStrategyConfig[];
+    enabled: boolean;
+}
+
 export interface IEnvironmentDetail extends IEnvironmentOverview {
     strategies: IStrategyConfig[];
 }

src/lib/types/stores/feature-strategies-store.ts

@@ -39,7 +39,7 @@ export interface IFeatureStrategiesStore
     getStrategiesForEnv(environment: string): Promise<IFeatureStrategy[]>;
     getFeatureToggleAdmin(
         featureName: string,
-        archived: boolean,
+        archived?: boolean,
     ): Promise<FeatureToggleWithEnvironment>;
     getFeatures(
         featureQuery: Partial<IFeatureToggleQuery>,

src/test/e2e/services/feature-toggle-service-v2.e2e.test.ts

@@ -1,11 +1,15 @@
+import EventService from '../../../lib/services/event-service';
+import { FEATURE_UPDATED } from '../../../lib/types/events';
 import FeatureToggleServiceV2 from '../../../lib/services/feature-toggle-service-v2';
 import { IStrategyConfig } from '../../../lib/types/model';
 import { createTestConfig } from '../../config/test-config';
 import dbInit from '../helpers/database-init';
+import { GLOBAL_ENV } from '../../../lib/types/environment';
 
 let stores;
 let db;
 let service: FeatureToggleServiceV2;
+let eventService: EventService;
 
 beforeAll(async () => {
     const config = createTestConfig();
@@ -15,6 +19,7 @@ beforeAll(async () => {
     );
     stores = db.stores;
     service = new FeatureToggleServiceV2(stores, config);
+    eventService = new EventService(stores, config);
 });
 
 afterAll(async () => {
@@ -74,6 +79,32 @@ test('Should be able to update existing strategy configuration', async () => {
     expect(updatedConfig.parameters).toEqual({ b2b: true });
 });
 
+test('Should include legacy props in event log when updating strategy configuration', async () => {
+    const userName = 'event-tester';
+    const featureName = 'update-existing-strategy-events';
+    const config: Omit<IStrategyConfig, 'id'> = {
+        name: 'default',
+        constraints: [],
+        parameters: {},
+    };
+
+    await service.createFeatureToggle(
+        'default',
+        {
+            name: featureName,
+        },
+        userName,
+    );
+
+    await service.createStrategy(config, 'default', featureName);
+    await service.updateEnabled(featureName, GLOBAL_ENV, true, userName);
+
+    const events = await eventService.getEventsForToggle(featureName);
+    expect(events[0].type).toBe(FEATURE_UPDATED);
+    expect(events[0].data.enabled).toBe(true);
+    expect(events[0].data.strategies).toBeDefined();
+});
+
 test('Should be able to get strategy by id', async () => {
     const config: Omit<IStrategyConfig, 'id'> = {
         name: 'default',