feat(schemas): Add support for setPref in SDK schemas

freshstrangemusic · freshstrangemusic · commit 7b3dcb198ef8 · 2026-05-04T14:38:11.000-04:00
Because: - as of 152, Firefox for Android supports gecko prefs this commit: - adds support for setPref annotations in SDK manifests. Fixes #15511
diff --git a/schemas/VERSION b/schemas/VERSION
@@ -1 +1 @@
-3001.0.0
+3001.1.0
diff --git a/schemas/index.d.ts b/schemas/index.d.ts
@@ -758,6 +758,14 @@ export interface SdkFeatureVariable {
    * Only allowed when type is string.
    */
   enum?: string[];
+  setPref?: SetPref1;
+}
+export interface SetPref1 {
+  branch: PrefBranch;
+  /**
+   * The name of the pref to set.
+   */
+  pref: string;
 }
 export interface AnalysisError {
   analysis_basis?: AnalysisBasis | null;
diff --git a/schemas/mozilla_nimbus_schemas/experimenter_apis/experiments/feature_manifests.py b/schemas/mozilla_nimbus_schemas/experimenter_apis/experiments/feature_manifests.py
@@ -57,6 +57,16 @@ class SdkFeatureVariable(BaseFeatureVariable):
         default=None,
     )
 
+    set_pref: SetPref | SkipJsonSchema[None] = Field(
+        alias="setPref",
+        description=(
+            "A pref that should be set to the value of this variable when enrolling.\n"
+            "\n"
+            "Only supported in Firefox for Android 152+.\n"
+        ),
+        default=None,
+    )
+
     model_config = ConfigDict(
         json_schema_extra={
             "dependentSchemas": {
diff --git a/schemas/mozilla_nimbus_schemas/tests/experiments/fixtures/feature_manifests/sdk/sdk.yaml b/schemas/mozilla_nimbus_schemas/tests/experiments/fixtures/feature_manifests/sdk/sdk.yaml
@@ -311,3 +311,24 @@ zoom-feature:
     status:
       type: boolean
       description: "Whether the page zoom feature is enabled or not\n"
+pref-feature:
+  description: A feature with prefs
+  hasExposure: false
+  variables:
+    foo:
+      type: boolean
+      setPref:
+        pref: test.foo
+        branch: user
+    
+    bar:
+      type: string
+      setPref:
+        pref: test.bar
+        branch: default
+
+    baz:
+      type: int
+      setPref:
+        pref: test.baz
+        branch: user
diff --git a/schemas/package.json b/schemas/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@mozilla/nimbus-schemas",
-  "version": "3001.0.0",
+  "version": "3001.1.0",
   "description": "Schemas used by Mozilla Nimbus and related projects.",
   "main": "index.d.ts",
   "repository": {
diff --git a/schemas/pyproject.toml b/schemas/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mozilla-nimbus-schemas"
-version = "3001.0.0"
+version = "3001.1.0"
 description = "Schemas used by Mozilla Nimbus and related projects."
 authors = ["mikewilli"]
 license = "MPL 2.0"
diff --git a/schemas/schemas/DesktopAllVersionsNimbusExperiment.schema.json b/schemas/schemas/DesktopAllVersionsNimbusExperiment.schema.json
@@ -342,6 +342,7 @@
           "type": "string"
         },
         "value": {
+          "additionalProperties": true,
           "type": "object"
         },
         "enabled": {
@@ -394,6 +395,7 @@
           "type": "string"
         },
         "value": {
+          "additionalProperties": true,
           "description": "The values that define the feature configuration. This should be validated against a schema.",
           "type": "object"
         }
diff --git a/schemas/schemas/DesktopNimbusExperiment.schema.json b/schemas/schemas/DesktopNimbusExperiment.schema.json
@@ -368,6 +368,7 @@
           "type": "string"
         },
         "value": {
+          "additionalProperties": true,
           "description": "The values that define the feature configuration. This should be validated against a schema.",
           "type": "object"
         }
diff --git a/schemas/schemas/ExperimentFeatureConfig.schema.json b/schemas/schemas/ExperimentFeatureConfig.schema.json
@@ -8,6 +8,7 @@
       "type": "string"
     },
     "value": {
+      "additionalProperties": true,
       "description": "The values that define the feature configuration. This should be validated against a schema.",
       "type": "object"
     }
diff --git a/schemas/schemas/NimbusExperimentV7.schema.json b/schemas/schemas/NimbusExperimentV7.schema.json
@@ -280,6 +280,7 @@
           "type": "string"
         },
         "value": {
+          "additionalProperties": true,
           "description": "The values that define the feature configuration. This should be validated against a schema.",
           "type": "object"
         }
diff --git a/schemas/schemas/SdkFeatureManifest.schema.json b/schemas/schemas/SdkFeatureManifest.schema.json
@@ -16,6 +16,13 @@
       ],
       "type": "string"
     },
+    "PrefBranch": {
+      "enum": [
+        "default",
+        "user"
+      ],
+      "type": "string"
+    },
     "SdkFeature": {
       "description": "A feature.",
       "if": {
@@ -88,13 +95,34 @@
             "type": "string"
           },
           "type": "array"
+        },
+        "setPref": {
+          "$ref": "#/$defs/SetPref",
+          "description": "A pref that should be set to the value of this variable when enrolling. Only supported in Firefox for Android 152+. "
         }
       },
       "required": [
         "description",
         "type"
       ],
       "type": "object"
+    },
+    "SetPref": {
+      "properties": {
+        "branch": {
+          "$ref": "#/$defs/PrefBranch",
+          "description": "The branch the pref will be set on. Prefs set on the user branch persists through restarts."
+        },
+        "pref": {
+          "description": "The name of the pref to set.",
+          "type": "string"
+        }
+      },
+      "required": [
+        "branch",
+        "pref"
+      ],
+      "type": "object"
     }
   }
 }
diff --git a/schemas/schemas/SdkNimbusExperiment.schema.json b/schemas/schemas/SdkNimbusExperiment.schema.json
@@ -230,6 +230,7 @@
           "type": "string"
         },
         "value": {
+          "additionalProperties": true,
           "description": "The values that define the feature configuration. This should be validated against a schema.",
           "type": "object"
         }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@mozilla/nimbus-schemas",`
`3`		`- "version": "3001.0.0",`
	`3`	`+ "version": "3001.1.0",`
`4`	`4`	`"description": "Schemas used by Mozilla Nimbus and related projects.",`
`5`	`5`	`"main": "index.d.ts",`
`6`	`6`	`"repository": {`
Original file line number	Diff line number	Diff line change
`@@ -368,6 +368,7 @@`
`368`	`368`	`"type": "string"`
`369`	`369`	`},`
`370`	`370`	`"value": {`
	`371`	`+ "additionalProperties": true,`
`371`	`372`	`"description": "The values that define the feature configuration. This should be validated against a schema.",`
`372`	`373`	`"type": "object"`
`373`	`374`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`"type": "string"`
`9`	`9`	`},`
`10`	`10`	`"value": {`
	`11`	`+ "additionalProperties": true,`
`11`	`12`	`"description": "The values that define the feature configuration. This should be validated against a schema.",`
`12`	`13`	`"type": "object"`
`13`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -280,6 +280,7 @@`
`280`	`280`	`"type": "string"`
`281`	`281`	`},`
`282`	`282`	`"value": {`
	`283`	`+ "additionalProperties": true,`
`283`	`284`	`"description": "The values that define the feature configuration. This should be validated against a schema.",`
`284`	`285`	`"type": "object"`
`285`	`286`	`}`