Skip to content

refactor(Engine): nits from context work review #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 31, 2025
Merged

refactor(Engine): nits from context work review #117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd26178
Pop feature ID out of the override key
emyller Oct 30, 2025
31280ca
Replace flagsmith_id with id
emyller Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Flagsmith.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,12 +371,12 @@ traits: $traits,

$segments = [];
foreach ($evaluationResult->segments as $resultSegment) {
if (($resultSegment->metadata['flagsmith_id'] ?? null) === null) {
if (($resultSegment->metadata['id'] ?? null) === null) {
continue; // Not a real segment, e.g. an identity override virtual segment
}

$segment = new Segment();
$segment->id = $resultSegment->metadata['flagsmith_id'];
$segment->id = $resultSegment->metadata['id'];
$segment->name = $resultSegment->name;
$segments[] = $segment;
}
Expand Down
2 changes: 1 addition & 1 deletion src/Models/Flags.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ public static function fromEvaluationResult(
foreach ($evaluationResult->flags as $flagResult) {
$flag = new Flag();
$flag->feature_name = $flagResult->name;
$flag->feature_id = $flagResult->metadata['flagsmith_id'];
$flag->feature_id = $flagResult->metadata['id'];
$flag->enabled = $flagResult->enabled;
$flag->value = $flagResult->value;
$flags[$flagResult->name] = $flag;
Expand Down
14 changes: 9 additions & 5 deletions src/Utils/Mappers.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public static function mapEnvironmentDocumentToContext($environmentDocument): Ev
$segment->rules = self::_mapEnvironmentDocumentRulesToContextRules($srcSegment->rules ?? []);
$segment->metadata = [
'source' => 'api',
'flagsmith_id' => $srcSegment->id,
'id' => $srcSegment->id,
];
$context->segments[$segment->key] = $segment;

Expand Down Expand Up @@ -115,7 +115,7 @@ private static function _mapEnvironmentDocumentFeatureStatesToFeatureContexts($f
$feature->enabled = $featureState->enabled;
$feature->value = $featureState->feature_state_value;
$feature->priority = $featureState->feature_segment?->priority ?? null;
$feature->metadata = ['flagsmith_id' => $featureState->feature->id];
$feature->metadata = ['id' => $featureState->feature->id];
$feature->variants = [];
$multivariateFeatureStateValues = ((array) $featureState->multivariate_feature_state_values) ?? [];
$multivariateFeatureStateValueUUIDs = array_column($multivariateFeatureStateValues, 'mv_fs_value_uuid');
Expand All @@ -141,6 +141,9 @@ private static function _mapEnvironmentDocumentFeatureStatesToFeatureContexts($f
*/
private static function _mapIdentityOverridesToSegments($identityOverrides)
{
/** @var array<string, int> */
$featureIDsByName = [];

/** @var array<string, array<string>> */
$featuresToIdentifiers = [];
foreach ($identityOverrides as $identityOverride) {
Expand All @@ -154,8 +157,8 @@ private static function _mapIdentityOverridesToSegments($identityOverrides)
/** @var array<array<mixed>> */
$overridesKey = [];
foreach ($identityFeatures as $featureState) {
$featureIDsByName[$featureState->feature->name] = $featureState->feature->id;
$part = [
$featureState->feature->id,
$featureState->feature->name,
$featureState->enabled,
$featureState->feature_state_value,
Expand Down Expand Up @@ -185,14 +188,15 @@ private static function _mapIdentityOverridesToSegments($identityOverrides)

$segment->overrides = [];
foreach (unserialize($serializedOverridesKey) as $overrideKey) {
[$featureId, $featureName, $enabled, $value] = $overrideKey;
[$featureName, $enabled, $value] = $overrideKey;
$featureId = $featureIDsByName[$featureName];
$feature = new FeatureContext();
$feature->key = ''; // Not used in identity overrides
$feature->name = $featureName;
$feature->enabled = $enabled;
$feature->value = $value;
$feature->priority = Engine::STRONGEST_PRIORITY;
$feature->metadata = ['flagsmith_id' => $featureId];
$feature->metadata = ['id' => $featureId];
$segment->overrides[] = $feature;
}

Expand Down
12 changes: 6 additions & 6 deletions tests/Utils/MappersTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public function testMapEnvironmentDocumentToContextProducesEvaluationContext():
$this->assertCount(1, $context->segments[0]->rules);
$this->assertEmpty($context->segments[0]->overrides);
$this->assertEquals('api', $context->segments[0]->metadata['source']);
$this->assertEquals('1', $context->segments[0]->metadata['flagsmith_id']);
$this->assertEquals('1', $context->segments[0]->metadata['id']);

$this->assertEquals(SegmentRuleType::ALL, $context->segments[0]->rules[0]->type);
$this->assertEmpty($context->segments[0]->rules[0]->conditions);
Expand All @@ -47,7 +47,7 @@ public function testMapEnvironmentDocumentToContextProducesEvaluationContext():
$this->assertEquals(SegmentConditionOperator::EQUAL, $context->segments[0]->rules[0]->rules[0]->conditions[0]->operator);
$this->assertEquals('bar', $context->segments[0]->rules[0]->rules[0]->conditions[0]->value);

$overrideKey = '1dfdec3e4c67121138b1faa01b82f9f731c692842b865f263824bfabf46d5fff';
$overrideKey = '2a3691c8a306223592e2e657e50c44cf126db84730e813adea6f951c502b19e8';
$this->assertArrayHasKey($overrideKey, $context->segments);
$this->assertEquals('', $context->segments[$overrideKey]->key);
$this->assertEquals('identity_overrides', $context->segments[$overrideKey]->name);
Expand All @@ -68,7 +68,7 @@ public function testMapEnvironmentDocumentToContextProducesEvaluationContext():
$this->assertEquals('some-overridden-value', $context->segments[$overrideKey]->overrides[0]->value);
$this->assertEquals(-INF, $context->segments[$overrideKey]->overrides[0]->priority);
$this->assertNull($context->segments[$overrideKey]->overrides[0]->variants);
$this->assertEquals(['flagsmith_id' => 1], $context->segments[$overrideKey]->overrides[0]->metadata);
$this->assertEquals(['id' => 1], $context->segments[$overrideKey]->overrides[0]->metadata);

$this->assertCount(3, $context->features);
$this->assertArrayHasKey('some_feature', $context->features);
Expand All @@ -78,7 +78,7 @@ public function testMapEnvironmentDocumentToContextProducesEvaluationContext():
$this->assertEquals('some-value', $context->features['some_feature']->value);
$this->assertNull($context->features['some_feature']->priority);
$this->assertEmpty($context->features['some_feature']->variants);
$this->assertEquals(['flagsmith_id' => 1], $context->features['some_feature']->metadata);
$this->assertEquals(['id' => 1], $context->features['some_feature']->metadata);

// Test multivariate feature with IDs - priority should be based on ID
$this->assertArrayHasKey('mv_feature_with_ids', $context->features);
Expand All @@ -89,7 +89,7 @@ public function testMapEnvironmentDocumentToContextProducesEvaluationContext():
$this->assertEquals('default_value', $mvFeatureWithIds->value);
$this->assertNull($mvFeatureWithIds->priority);
$this->assertCount(2, $mvFeatureWithIds->variants);
$this->assertEquals(['flagsmith_id' => 2], $mvFeatureWithIds->metadata);
$this->assertEquals(['id' => 2], $mvFeatureWithIds->metadata);

// First variant: ID=100, should have priority 100
$this->assertEquals('variant_a', $mvFeatureWithIds->variants[0]->value);
Expand All @@ -110,7 +110,7 @@ public function testMapEnvironmentDocumentToContextProducesEvaluationContext():
$this->assertEquals('fallback_value', $mvFeatureWithoutIds->value);
$this->assertNull($mvFeatureWithoutIds->priority);
$this->assertCount(3, $mvFeatureWithoutIds->variants);
$this->assertEquals(['flagsmith_id' => 3], $mvFeatureWithoutIds->metadata);
$this->assertEquals(['id' => 3], $mvFeatureWithoutIds->metadata);

// Variants should be ordered by UUID alphabetically
$this->assertEquals('option_y', $mvFeatureWithoutIds->variants[0]->value);
Expand Down