feat: use-flagsmith-id-int-for-feature-id

Author: Zaimwa9

flagsmith-engine/evaluation/evaluationContext/mappers.ts

@@ -12,7 +12,6 @@ import { IdentityModel } from '../../identities/models.js';
 import { TraitModel } from '../../identities/traits/models.js';
 import { IDENTITY_OVERRIDE_SEGMENT_NAME } from '../../segments/constants.js';
 import { createHash } from 'node:crypto';
-import { parse as uuidParse } from 'uuid';
 import { uuidToBigInt } from '../../features/util.js';
 
 export function getEvaluationContext(
@@ -57,7 +56,10 @@ function mapEnvironmentModelToEvaluationContext(environment: EnvironmentModel):
             enabled: fs.enabled,
             value: fs.getValue(),
             variants,
-            priority: fs.featureSegment?.priority
+            priority: fs.featureSegment?.priority,
+            metadata: {
+                flagsmithId: fs.feature.id
+            }
         };
     }
 

flagsmith-engine/evaluation/models.ts

@@ -54,25 +54,22 @@ export type SegmentConditionOperator = SegmentCondition['operator'];
 export type EvaluationReason = EvaluationContextResultFlagResult['reason'];
 
 export type EvaluationResultSegments = EvaluationContextResult['segments'];
-export type EvaluationResultFlags = Record<
+import type { FlagResult } from './evaluationResult/evaluationResult.types.js';
+
+export type FlagResultWithMetadata<T extends Metadata = Metadata> = FlagResult & {
+    metadata?: T;
+};
+
+export type EvaluationResultFlags<T extends Metadata = Metadata> = Record<
     string,
-    {
-        feature_key: FeatureKey;
-        name: FeatureName;
-        enabled: FeatureEnabled;
-        value: FeatureValue;
-        metadata?: Metadata;
-        reason: EvaluationReason;
-    }
+    FlagResultWithMetadata<T>
 >;
 
 export type EvaluationResult = {
     flags: EvaluationResultFlags;
     segments: EvaluationResultSegments;
 };
 
-export { FlagResult } from './evaluationResult/evaluationResult.types.js';
-
 export enum SegmentSource {
     API = 'api',
     IDENTITY_OVERRIDE = 'identity_override'

flagsmith-engine/index.ts

@@ -127,7 +127,7 @@ export function evaluateFeatures(
             name: finalFeature.name,
             enabled: finalFeature.enabled,
             value: evaluatedValue,
-            ...(finalFeature.metadata ? { metadata: { ...finalFeature.metadata } } : {}),
+            ...(finalFeature.metadata ? { metadata: finalFeature.metadata } : {}),
             reason:
                 evaluatedReason ??
                 getTargetingMatchReason({ type: 'SEGMENT', override: segmentOverride })

sdk/models.ts

@@ -1,4 +1,4 @@
-import { EvaluationResult, FlagResult } from '../flagsmith-engine/evaluation/models.js';
+import { EvaluationResult, FlagResultWithMetadata } from '../flagsmith-engine/evaluation/models.js';
 import { FeatureStateModel } from '../flagsmith-engine/features/models.js';
 import { AnalyticsProcessor } from './analytics.js';
 
@@ -81,11 +81,11 @@ export class Flag extends BaseFlag {
         });
     }
 
-    static fromFlagResult(flagResult: FlagResult): Flag {
+    static fromFlagResult(flagResult: FlagResultWithMetadata<{ flagsmithId?: number }>): Flag {
         return new Flag({
             enabled: flagResult.enabled,
             value: flagResult.value ?? null,
-            featureId: Number(flagResult.feature_key),
+            featureId: flagResult.metadata?.flagsmithId || Number(flagResult.feature_key),
             featureName: flagResult.name,
             reason: flagResult.reason
         });