update fixtures to remove pref-key in favor of pref

jeddai · jeddai · commit 6991d7e29c8e · 2025-06-23T18:15:45.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,6 +19,9 @@
 
 ## 🦊 What's Changed 🦊
 
+### Nimbus FML ⛅️🔬🔭🔧
+- Updated Nimbus FML to support pref key+branch being set on feature properties (#[6788](https://github.com/mozilla/application-services/pull/6788)).
+
 ### Context ID
 - The `ContextIDComponent` constructor no longer throws an error. This is not a breaking change since neither iOS or Android implement this yet.
 - The `ContextIDComponent` constructor can now synchronously invoke the rotation callback when it receives an invalid timestamp from callers; in such cases, it falls back to the current timestamp and forces an ID rotation.
diff --git a/components/nimbus/android/src/main/java/org/mozilla/experiments/nimbus/internal/FeatureManifestInterface.kt b/components/nimbus/android/src/main/java/org/mozilla/experiments/nimbus/internal/FeatureManifestInterface.kt
@@ -6,6 +6,11 @@ package org.mozilla.experiments.nimbus.internal
 
 import org.mozilla.experiments.nimbus.FeaturesInterface
 
+data class GeckoPref(
+    val pref: String,
+    val branch: String,
+)
+
 interface FeatureManifestInterface<T> {
     /**
      * This method should be called as early in the startup sequence of the app as possible.
@@ -44,7 +49,5 @@ interface FeatureManifestInterface<T> {
 
     fun getCoenrollingFeatureIds(): List<String>
 
-    fun prefsToBranchesMap(): Map<String, String>
-
-    fun prefsToFeatureIdsMap(): Map<String, String>
+    fun geckoPrefsMap(): Map<String, Map<String, GeckoPref>>
 }
diff --git a/components/support/nimbus-fml/fixtures/fe/browser-with-prefs.yaml b/components/support/nimbus-fml/fixtures/fe/browser-with-prefs.yaml
@@ -102,15 +102,15 @@ features:
       pref-string:
         description: Test of pref string
         type: String
-        pref:
-          key: "my.pref.key.string"
+        gecko-pref:
+          pref: "my.pref.key.string"
           branch: "default"
         default: ""
       pref-bool:
         description: Test of pref bool
         type: Boolean
-        pref:
-          key: "my.pref.key.bool"
+        gecko-pref:
+          pref: "my.pref.key.bool"
           branch: "user"
         default: false
   search-term-groups:
diff --git a/components/support/nimbus-fml/fixtures/fe/misc-features.yaml b/components/support/nimbus-fml/fixtures/fe/misc-features.yaml
@@ -11,12 +11,14 @@ channels:
   - debug
 features:
   onboarding:
-    description: A feature containing a field with pref-key
+    description: A feature containing a field with pref
     variables:
       enabled:
         description: If true, enable new style onboarding.
         type: Boolean
-        pref-key: enrollment_enabled
+        pref:
+          key: enrollment_enabled
+          branch: default
         default: false
   messaging:
     description: A feature allowing coenrollment
diff --git a/components/support/nimbus-fml/fixtures/fe/pref_overrides.fml.yaml b/components/support/nimbus-fml/fixtures/fe/pref_overrides.fml.yaml
@@ -16,20 +16,28 @@ features:
       my-boolean:
         type: Boolean
         description: A boolean
-        pref-key: my-boolean-pref-key
+        pref:
+          key: my-boolean-pref-key
+          branch: default
         default: false
       my-int:
         type: Int
         description: An Int
-        pref-key: my-int-pref-key
+        pref:
+          key: my-int-pref-key
+          branch: default
         default: 0
       my-string:
         type: String
         description: A String
-        pref-key: my-string-pref-key
+        pref:
+          key: my-string-pref-key
+          branch: default
         default: from manifest
       my-text:
         type: Text
         description: A Text
-        pref-key: my-text-pref-key
+        pref:
+          key: my-text-pref-key
+          branch: default
         default: from manifest
diff --git a/components/support/nimbus-fml/src/backends/frontend_manifest.rs b/components/support/nimbus-fml/src/backends/frontend_manifest.rs
@@ -140,10 +140,10 @@ impl From<PropDef> for FieldBody {
 }
 
 impl From<PropDef> for FeatureFieldBody {
-    #[allow(deprecated)]
     fn from(value: PropDef) -> Self {
         Self {
-            pref: value.pref.clone(),
+            pref_key: value.pref_key.clone(),
+            gecko_pref: value.gecko_pref.clone(),
             string_alias: value.string_alias.as_ref().map(TypeRef::to_string),
             field: value.into(),
         }
diff --git a/components/support/nimbus-fml/src/backends/kotlin/gen_structs/mod.rs b/components/support/nimbus-fml/src/backends/kotlin/gen_structs/mod.rs
@@ -8,7 +8,7 @@ use std::collections::HashSet;
 use crate::intermediate_representation::PropDef;
 use crate::{
     backends::{CodeDeclaration, CodeOracle, CodeType, TypeIdentifier},
-    intermediate_representation::{FeatureDef, FeatureManifest, PrefDef, TypeFinder},
+    intermediate_representation::{FeatureDef, FeatureManifest, GeckoPrefDef, TypeFinder},
 };
 
 mod bundled;
@@ -78,13 +78,13 @@ impl<'a> FeatureManifestDeclaration<'a> {
     }
 
     #[allow(unused)]
-    pub fn iter_prefs(&self) -> Vec<&PrefDef> {
-        self.fm.iter_prefs().collect::<_>()
+    pub fn iter_gecko_prefs(&self) -> Vec<&GeckoPrefDef> {
+        self.fm.iter_gecko_prefs().collect::<_>()
     }
 
     #[allow(unused)]
-    pub fn iter_prefs_with_feature(&self) -> Vec<(&PrefDef, String)> {
-        self.fm.iter_prefs_with_feature().collect::<_>()
+    pub fn iter_features_with_prefs(&self) -> Vec<(String, Vec<(String, &GeckoPrefDef)>)> {
+        self.fm.iter_features_with_prefs().collect::<_>()
     }
 
     pub fn initialization_code(&self) -> Vec<String> {
@@ -126,6 +126,7 @@ impl<'a> FeatureManifestDeclaration<'a> {
                 "org.mozilla.experiments.nimbus.Variables".to_string(),
                 "org.mozilla.experiments.nimbus.internal.FeatureHolder".to_string(),
                 "org.mozilla.experiments.nimbus.internal.FeatureManifestInterface".to_string(),
+                "org.mozilla.experiments.nimbus.internal.GeckoPref".to_string(),
                 "org.mozilla.experiments.nimbus.FeaturesInterface".to_string(),
                 "org.json.JSONObject".to_string(),
                 "android.content.SharedPreferences".to_string(),
diff --git a/components/support/nimbus-fml/src/backends/kotlin/templates/FeatureManifestTemplate.kt b/components/support/nimbus-fml/src/backends/kotlin/templates/FeatureManifestTemplate.kt
@@ -105,24 +105,18 @@ object {{ nimbus_object }} : FeatureManifestInterface<{{ nimbus_object }}.Featur
             {%- if !loop.last %}, {% endif %}
             {%- endfor %})
 
-    /**
-     * Get a map of prefs to their respective branches.
-     */
-    override fun prefsToBranchesMap(): Map<String, String> =
-        mapOf(
-            {%- for f in self.fm.iter_prefs() %}
-            {{ f.branch()|quoted }} to {{ f.key()|quoted }}
-            {%- if !loop.last %},{% endif -%}
-            {% endfor %}
-        )
-
     /**
      * Get a map of prefs to their repective feature IDs.
      */
-    override fun prefsToFeatureIdsMap(): Map<String, String> =
+    override fun geckoPrefsMap(): Map<String, Map<String, GeckoPref>> =
         mapOf(
-            {%- for f in self.fm.iter_prefs_with_feature() %}
-            {{ f.1|quoted }} to {{ f.0.key()|quoted }}
+            {%- for f in self.fm.iter_features_with_prefs() %}
+            {{ f.0|quoted }} to mapOf(
+                {%- for p in f.1.iter() %}
+                {{ p.0|quoted }} to GeckoPref({{ p.1.pref()|quoted }}, {{ p.1.branch()|quoted }})
+                {%- if !loop.last %},{% endif -%}
+                {% endfor %}
+            )
             {%- if !loop.last %},{% endif -%}
             {% endfor %}
         )
diff --git a/components/support/nimbus-fml/src/backends/kotlin/templates/FeatureTemplate.kt b/components/support/nimbus-fml/src/backends/kotlin/templates/FeatureTemplate.kt
@@ -11,7 +11,10 @@ public class {{ inner.name()|class_name }}  {% call kt::render_constructor() %}
             listOf(
             {%- for p in inner.props() %}
             {%- if p.has_prefs() %}
-                {{ p.pref().unwrap().key()|quoted }},
+                {{ p.pref_key().unwrap()|quoted }},
+            {%- endif %}
+            {%- if p.has_gecko_prefs() %}
+                {{ p.gecko_pref().unwrap().pref()|quoted }},
             {%- endif %}
             {%- endfor %}
             ).any { prefs.contains(it) }
diff --git a/components/support/nimbus-fml/src/backends/kotlin/templates/macros.kt b/components/support/nimbus-fml/src/backends/kotlin/templates/macros.kt
@@ -55,7 +55,7 @@ private constructor(
    val {{ prop_kt }}: {{ type_kt }}
       get() =
          {%- let prefs = "it" %}
-         {%- let key = p.pref().unwrap().key() %}
+         {%- let key = p.pref_key().unwrap() %}
          {% call prefs() %}?.let {
             if ({{ prefs }}.contains({{ key|quoted }})) {
                try {
diff --git a/components/support/nimbus-fml/src/backends/swift/templates/FeatureTemplate.swift b/components/support/nimbus-fml/src/backends/swift/templates/FeatureTemplate.swift
@@ -13,7 +13,7 @@ extension {{ class_name }}: FMLFeatureInterface {
         let keys = [
             {%- for p in inner.props() %}
             {%- if p.has_prefs() %}
-            {{ p.pref().unwrap().key()|quoted }},
+            {{ p.pref_key().unwrap()|quoted }},
             {%- endif %}
             {%- endfor %}
         ]
diff --git a/components/support/nimbus-fml/src/backends/swift/templates/macros.swift b/components/support/nimbus-fml/src/backends/swift/templates/macros.swift
@@ -77,7 +77,7 @@ public class {{class_name}}: FMLObjectInterface {
     {%- else %}
     public var {{ prop_swift }}: {{ type_swift }} {
         {%- let prefs = "prefs" %}
-        {%- let key = p.pref().unwrap().key() %}
+        {%- let key = p.pref_key().unwrap() %}
         {#- Using `object(forKey:)` here as it returns an optional that just needs to be cast.
             `integer(forKey:)` returns zero, `bool(forKey:)` returns `false` if the key is not
             present.
diff --git a/components/support/nimbus-fml/src/fixtures/mod.rs b/components/support/nimbus-fml/src/fixtures/mod.rs
@@ -7,7 +7,7 @@ use std::collections::BTreeMap;
 use serde_json::Value;
 
 use crate::intermediate_representation::{
-    EnumDef, ObjectDef, PrefBranch, PrefDef, PropDef, TypeRef, VariantDef,
+    EnumDef, GeckoPrefDef, ObjectDef, PrefBranch, PropDef, TypeRef, VariantDef,
 };
 
 pub(crate) mod intermediate_representation;
@@ -54,12 +54,13 @@ impl PropDef {
             typ: typ.clone(),
             default: value.clone(),
             doc: format!("{nm} property of type {typ}"),
-            pref: None,
+            pref_key: None,
+            gecko_pref: None,
             string_alias: None,
         }
     }
 
-    pub(crate) fn new_with_pref(
+    pub(crate) fn new_with_gecko_pref(
         nm: &str,
         typ: &TypeRef,
         value: &Value,
@@ -71,8 +72,9 @@ impl PropDef {
             typ: typ.clone(),
             default: value.clone(),
             doc: format!("{nm} property of type {typ}"),
-            pref: Some(PrefDef {
-                key: pref_key.into(),
+            pref_key: None,
+            gecko_pref: Some(GeckoPrefDef {
+                pref: pref_key.into(),
                 branch: pref_branch,
             }),
             string_alias: None,
@@ -85,7 +87,8 @@ impl PropDef {
             typ: typ.clone(),
             default: value.clone(),
             doc: nm.to_string(),
-            pref: None,
+            pref_key: None,
+            gecko_pref: None,
             string_alias: Some(sa.clone()),
         }
     }
@@ -96,7 +99,8 @@ impl PropDef {
             doc: doc.to_string(),
             typ: typ.clone(),
             default: default.clone(),
-            pref: None,
+            pref_key: None,
+            gecko_pref: None,
             string_alias: None,
         }
     }
diff --git a/components/support/nimbus-fml/src/frontend.rs b/components/support/nimbus-fml/src/frontend.rs
@@ -9,13 +9,12 @@ use serde::{Deserialize, Serialize};
 use serde_json::json;
 use url::Url;
 
-use crate::intermediate_representation::PrefDef;
 use crate::{
     defaults::DefaultsMerger,
     error::Result,
     intermediate_representation::{
-        EnumDef, FeatureDef, FeatureManifest, ModuleId, ObjectDef, PropDef, TargetLanguage,
-        TypeRef, VariantDef,
+        EnumDef, FeatureDef, FeatureManifest, GeckoPrefDef, ModuleId, ObjectDef, PropDef,
+        TargetLanguage, TypeRef, VariantDef,
     },
     parser::get_typeref_from_string,
 };
@@ -42,7 +41,11 @@ pub(crate) struct FeatureFieldBody {
 
     #[serde(default)]
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub(crate) pref: Option<PrefDef>,
+    pub(crate) pref_key: Option<String>,
+
+    #[serde(default)]
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub(crate) gecko_pref: Option<GeckoPrefDef>,
 
     #[serde(default)]
     #[serde(skip_serializing_if = "Option::is_none")]
@@ -344,10 +347,10 @@ impl ManifestFrontEnd {
         res
     }
 
-    #[allow(deprecated)]
     fn get_prop_def_from_feature_field(&self, nm: &str, body: &FeatureFieldBody) -> PropDef {
         let mut prop = self.get_prop_def_from_field(nm, &body.field);
-        prop.pref.clone_from(&body.pref);
+        prop.pref_key.clone_from(&body.pref_key);
+        prop.gecko_pref.clone_from(&body.gecko_pref);
         if let Some(s) = &body.string_alias {
             prop.string_alias = Some(TypeRef::StringAlias(s.clone()));
         }
@@ -362,7 +365,6 @@ impl ManifestFrontEnd {
     ///
     /// # Returns
     /// return the IR [`PropDef`]
-    #[allow(deprecated)]
     fn get_prop_def_from_field(&self, nm: &str, body: &FieldBody) -> PropDef {
         let types = self.get_types();
         PropDef {
@@ -383,7 +385,8 @@ impl ManifestFrontEnd {
             },
             default: json!(body.default),
             string_alias: None,
-            pref: Default::default(),
+            pref_key: Default::default(),
+            gecko_pref: Default::default(),
         }
     }
 
diff --git a/components/support/nimbus-fml/src/intermediate_representation.rs b/components/support/nimbus-fml/src/intermediate_representation.rs
diff --git a/components/support/nimbus-fml/src/schema/validator.rs b/components/support/nimbus-fml/src/schema/validator.rs
diff --git a/megazords/ios-rust/Sources/MozillaRustComponentsWrapper/Nimbus/FeatureManifestInterface.swift b/megazords/ios-rust/Sources/MozillaRustComponentsWrapper/Nimbus/FeatureManifestInterface.swift

Original file line number	Diff line number	Diff line change
`@@ -140,10 +140,10 @@ impl From<PropDef> for FieldBody {`
`140`	`140`	`}`
`141`	`141`
`142`	`142`	`impl From<PropDef> for FeatureFieldBody {`
`143`		`- #[allow(deprecated)]`
`144`	`143`	`fn from(value: PropDef) -> Self {`
`145`	`144`	`Self {`
`146`		`- pref: value.pref.clone(),`
	`145`	`+ pref_key: value.pref_key.clone(),`
	`146`	`+ gecko_pref: value.gecko_pref.clone(),`
`147`	`147`	`string_alias: value.string_alias.as_ref().map(TypeRef::to_string),`
`148`	`148`	`field: value.into(),`
`149`	`149`	`}`