flagsmith-nodejs 6.2.0 → 7.0.3

package/tests/engine/unit/engine.test.ts

@@ -1,8 +1,10 @@
 import {
-    getEnvironmentFeatureState,
-    getEnvironmentFeatureStates,
-    getIdentityFeatureState,
-    getIdentityFeatureStates
+    evaluateFeatures,
+    evaluateSegments,
+    getEvaluationResult,
+    isHigherPriority,
+    SegmentOverrides,
+    shouldApplyOverride
 } from '../../../flagsmith-engine/index.js';
 import { CONSTANTS } from '../../../flagsmith-engine/features/constants.js';
 import { FeatureModel, FeatureStateModel } from '../../../flagsmith-engine/features/models.js';
@@ -11,101 +13,346 @@ import {
     environment,
     environmentWithSegmentOverride,
     feature1,
-    getEnvironmentFeatureStateForFeature,
     identity,
     identityInSegment,
     segmentConditionProperty,
     segmentConditionStringValue
 } from './utils.js';
+import { getEvaluationContext } from '../../../flagsmith-engine/evaluation/evaluationContext/mappers.js';
+import { TARGETING_REASONS } from '../../../flagsmith-engine/features/types.js';
+import { EvaluationContext } from '../../../flagsmith-engine/evaluation/evaluationContext/evaluationContext.types.js';
+import { IDENTITY_OVERRIDE_SEGMENT_NAME } from '../../../flagsmith-engine/segments/constants.js';
 
-test('test_identity_get_feature_state_without_any_override', () => {
-    const feature_state = getIdentityFeatureState(environment(), identity(), feature1().name);
+test('test_get_evaluation_result_without_any_override', () => {
+    const context = getEvaluationContext(environment(), identity());
+    const result = getEvaluationResult(context);
 
-    expect(feature_state.feature).toStrictEqual(feature1());
+    const flag = Object.values(result.flags).find(f => f.name === feature1().name);
+    expect(flag).toBeDefined();
+    expect(flag?.name).toBe(feature1().name);
+    expect(flag?.reason).toBe(TARGETING_REASONS.DEFAULT);
 });
 
-test('test_identity_get_feature_state_without_any_override_no_fs', () => {
-    expect(() => {
-        getIdentityFeatureState(environment(), identity(), 'nonExistentName');
-    }).toThrowError('Feature State Not Found');
-});
-
-test('test_identity_get_all_feature_states_no_segments', () => {
+test('test_get_evaluation_result_with_identity_override_and_no_segment_override', () => {
     const env = environment();
     const ident = identity();
     const overridden_feature = new FeatureModel(3, 'overridden_feature', CONSTANTS.STANDARD);
 
     env.featureStates.push(new FeatureStateModel(overridden_feature, false, 3));
-
     ident.identityFeatures = [new FeatureStateModel(overridden_feature, true, 4)];
+    env.identityOverrides = [ident];
+
+    const context = getEvaluationContext(env, ident);
+    const result = getEvaluationResult(context);
 
-    const featureStates = getIdentityFeatureStates(env, ident);
+    expect(Object.keys(result.flags).length).toBe(3);
 
-    expect(featureStates.length).toBe(3);
-    for (const featuresState of featureStates) {
-        const environmentFeatureState = getEnvironmentFeatureStateForFeature(
-            env,
-            featuresState.feature
+    for (const flag of Object.values(result.flags)) {
+        const environmentFeature = Object.values(context.features || {}).find(
+            f => f.name === flag.name
+        );
+
+        const expected = flag.name === 'overridden_feature' ? true : environmentFeature?.enabled;
+
+        expect(flag.enabled).toBe(expected);
+        expect(flag.reason).toBe(
+            flag.name === 'overridden_feature'
+                ? `${TARGETING_REASONS.TARGETING_MATCH}; segment=${IDENTITY_OVERRIDE_SEGMENT_NAME}`
+                : TARGETING_REASONS.DEFAULT
         );
-        const expected =
-            environmentFeatureState?.feature == overridden_feature
-                ? true
-                : environmentFeatureState?.enabled;
-        expect(featuresState.enabled).toBe(expected);
     }
 });
 
 test('test_identity_get_all_feature_states_with_traits', () => {
     const trait_models = new TraitModel(segmentConditionProperty, segmentConditionStringValue);
 
-    const featureStates = getIdentityFeatureStates(
-        environmentWithSegmentOverride(),
-        identityInSegment(),
-        [trait_models]
+    const context = getEvaluationContext(environmentWithSegmentOverride(), identityInSegment(), [
+        trait_models
+    ]);
+
+    const result = getEvaluationResult(context);
+
+    const overriddenFlag = Object.values(result.flags).find(f => f.value === 'segment_override');
+    expect(overriddenFlag).toBeDefined();
+    expect(overriddenFlag?.value).toBe('segment_override');
+    expect(overriddenFlag?.reason).toEqual(
+        `${TARGETING_REASONS.TARGETING_MATCH}; segment=test name`
     );
-    expect(featureStates[0].getValue()).toBe('segment_override');
 });
 
-test('test_identity_get_all_feature_states_with_traits_hideDisabledFlags', () => {
-    const trait_models = new TraitModel(segmentConditionProperty, segmentConditionStringValue);
+test('test_environment_get_all_feature_states', () => {
+    const env = environment();
+    const context = getEvaluationContext(env);
+    const result = getEvaluationResult(context);
 
-    const env = environmentWithSegmentOverride();
-    env.project.hideDisabledFlags = true;
+    expect(Object.keys(result.flags).length).toBe(Object.keys(context.features || {}).length);
 
-    const featureStates = getIdentityFeatureStates(env, identityInSegment(), [trait_models]);
-    expect(featureStates.length).toBe(0);
+    Object.values(result.flags).forEach(flag => {
+        expect(flag.reason).toBe(TARGETING_REASONS.DEFAULT);
+    });
+
+    for (const flag of Object.values(result.flags)) {
+        const envFeature = Object.values(context.features || {}).find(f => f.name === flag.name);
+        expect(flag.enabled).toBe(envFeature?.enabled);
+        expect(flag.value).toBe(envFeature?.value);
+    }
 });
 
-test('test_environment_get_all_feature_states', () => {
-    const env = environment();
-    const featureStates = getEnvironmentFeatureStates(env);
+test('isHigherPriority should handle undefined priorities correctly', () => {
+    expect(isHigherPriority(1, 2)).toBe(true);
+    expect(isHigherPriority(2, 1)).toBe(false);
+    expect(isHigherPriority(undefined, 5)).toBe(false);
+    expect(isHigherPriority(5, undefined)).toBe(true);
+    expect(isHigherPriority(undefined, undefined)).toBe(false);
+});
 
-    expect(featureStates).toBe(env.featureStates);
+test('shouldApplyOverride with priority conflicts', () => {
+    const existingOverrides: SegmentOverrides = {
+        feature1: {
+            feature: {
+                key: 'key',
+                name: 'feature1',
+                enabled: true,
+                value: 'value',
+                priority: 5,
+                metadata: { id: 1 }
+            },
+            segmentName: 'segment1'
+        }
+    };
+
+    expect(shouldApplyOverride({ name: 'feature1', priority: 2 }, existingOverrides)).toBe(true);
+    expect(shouldApplyOverride({ name: 'feature1', priority: 10 }, existingOverrides)).toBe(false);
 });
 
-test('test_environment_get_feature_states_hides_disabled_flags_if_enabled', () => {
-    const env = environment();
+test('evaluateSegments handles segments with identity identifier matching', () => {
+    const context: EvaluationContext = {
+        environment: {
+            key: 'test-env',
+            name: 'Test Environment'
+        },
+        identity: {
+            key: 'test-user',
+            identifier: 'test-user'
+        },
+        segments: {
+            '1': {
+                key: '1',
+                name: 'segment_with_no_overrides',
+                rules: [
+                    {
+                        type: 'ALL',
+                        conditions: [
+                            {
+                                property: '$.identity.identifier',
+                                operator: 'EQUAL',
+                                value: 'test-user'
+                            }
+                        ]
+                    }
+                ],
+                overrides: []
+            },
+            '2': {
+                key: '2',
+                name: 'segment_with_overrides',
+                rules: [
+                    {
+                        type: 'ALL',
+                        conditions: [
+                            {
+                                property: '$.identity.identifier',
+                                operator: 'EQUAL',
+                                value: 'test-user'
+                            }
+                        ]
+                    }
+                ],
+                overrides: [
+                    {
+                        key: 'override1',
+                        name: 'feature1',
+                        enabled: true,
+                        value: 'overridden_value',
+                        priority: 1
+                    }
+                ]
+            }
+        },
+        features: {
+            feature1: {
+                key: 'fs1',
+                name: 'feature1',
+                enabled: false,
+                value: 'default_value',
+                metadata: { id: 1 }
+            }
+        }
+    };
 
-    env.project.hideDisabledFlags = true;
+    const result = evaluateSegments(context as any);
 
-    const featureStates = getEnvironmentFeatureStates(env);
+    expect(result.segments).toHaveLength(2);
+    expect(result.segments).toEqual(
+        expect.arrayContaining([
+            { name: 'segment_with_no_overrides' },
+            { name: 'segment_with_overrides' }
+        ])
+    );
 
-    expect(featureStates).not.toBe(env.featureStates);
-    for (const fs of featureStates) {
-        expect(fs.enabled).toBe(true);
-    }
+    expect(Object.keys(result.segmentOverrides)).toEqual(['feature1']);
+    expect(result.segmentOverrides.feature1.segmentName).toBe('segment_with_overrides');
 });
 
-test('test_environment_get_feature_state', () => {
-    const env = environment();
-    const feature = feature1();
-    const featureState = getEnvironmentFeatureState(env, feature.name);
+test('evaluateSegments handles priority conflicts correctly', () => {
+    const context: EvaluationContext = {
+        environment: {
+            key: 'test-env',
+            name: 'Test Environment'
+        },
+        identity: {
+            key: 'test-user',
+            identifier: 'test-user'
+        },
+        segments: {
+            '1': {
+                key: '1',
+                name: 'low_priority_segment',
+                rules: [
+                    {
+                        type: 'ALL',
+                        conditions: [
+                            {
+                                property: '$.identity.identifier',
+                                operator: 'EQUAL',
+                                value: 'test-user'
+                            }
+                        ]
+                    }
+                ],
+                overrides: [
+                    {
+                        key: 'override1',
+                        name: 'feature1',
+                        enabled: true,
+                        value: 'low_priority_value',
+                        priority: 10
+                    }
+                ]
+            },
+            '2': {
+                key: '2',
+                name: 'high_priority_segment',
+                rules: [
+                    {
+                        type: 'ALL',
+                        conditions: [
+                            {
+                                property: '$.identity.identifier',
+                                operator: 'EQUAL',
+                                value: 'test-user'
+                            }
+                        ]
+                    }
+                ],
+                overrides: [
+                    {
+                        key: 'override2',
+                        name: 'feature1',
+                        enabled: false,
+                        value: 'high_priority_value',
+                        priority: 1
+                    }
+                ]
+            }
+        },
+        features: {
+            feature1: {
+                key: 'fs1',
+                name: 'feature1',
+                enabled: false,
+                value: 'default_value',
+                metadata: { id: 1 }
+            }
+        }
+    };
 
-    expect(featureState.feature).toStrictEqual(feature);
+    const result = evaluateSegments(context as any);
+
+    expect(result.segments).toHaveLength(2);
+
+    expect(result.segmentOverrides.feature1.segmentName).toBe('high_priority_segment');
+    expect(result.segmentOverrides.feature1.feature.value).toBe('high_priority_value');
+    expect(result.segmentOverrides.feature1.feature.priority).toBe(1);
 });
 
-test('test_environment_get_feature_state_raises_feature_state_not_found', () => {
-    expect(() => {
-        getEnvironmentFeatureState(environment(), 'not_a_feature_name');
-    }).toThrowError('Feature State Not Found');
+test('evaluateSegments with non-matching identity returns empty', () => {
+    const context: EvaluationContext = {
+        environment: {
+            key: 'test-env',
+            name: 'Test Environment'
+        },
+        identity: {
+            key: 'test-user',
+            identifier: 'test-user'
+        },
+        segments: {
+            '1': {
+                key: '1',
+                name: 'segment_for_specific_user',
+                rules: [
+                    {
+                        type: 'ALL',
+                        conditions: [
+                            {
+                                property: '$.identity.identifier',
+                                operator: 'EQUAL',
+                                value: 'test-user-123'
+                            }
+                        ]
+                    }
+                ],
+                overrides: [
+                    {
+                        key: 'override1',
+                        name: 'feature1',
+                        enabled: true,
+                        value: 'overridden_value'
+                    }
+                ]
+            }
+        },
+        features: {}
+    };
+
+    const result = evaluateSegments(context as any);
+
+    expect(result.segments).toEqual([]);
+    expect(result.segmentOverrides).toEqual({});
+});
+
+test('evaluateFeatures with multivariate evaluation', () => {
+    const context = {
+        features: {
+            mv_feature: {
+                key: 'mv',
+                name: 'Multivariate Feature',
+                enabled: true,
+                value: 'default',
+                variants: [
+                    { value: 'variant_a', weight: 0, priority: 1 },
+                    { value: 'variant_b', weight: 100, priority: 2 }
+                ],
+                metadata: { id: 1 }
+            }
+        },
+        identity: { key: 'test_user', identifier: 'test_user' },
+        environment: {
+            key: 'test_env',
+            name: 'Test Environment'
+        }
+    };
+
+    const flags = evaluateFeatures(context as any, {});
+    expect(flags['Multivariate Feature'].value).toBe('variant_b');
 });