Bug 2045565 - Do not automatically enroll in Firefox Labs opt-ins (#7403)

Author: freshstrangemusic

CHANGELOG.md

@@ -1,5 +1,11 @@
 # v153.0 (In progress)
 
+## ⚠️ Breaking Changes ⚠️
+
+## Nimbus
+
+- Enrollment change events (visible to the UDL) now include the feature IDs of the features involved when possible. ([#7391](https://github.com/mozilla/application-services/pull/7391/))
+
 ## 🔧 What's Fixed 🔧
 
 ### Logins
@@ -8,13 +14,18 @@
 
 ### Nimbus
 
-- Enrollment change events (visible to the UDL) now include the feature IDs of the features involved when possible. ([#7391](https://github.com/mozilla/application-services/pull/7391/))
 - Fixed a bug where enrollment change events were not emitted for rollouts that re-enrolled after previously unenrolling. ([#7391](https://github.com/mozilla/application-services/pull/7391/))
 - Attempting to opt-out from an experiment that is not currently enrolled is now a no-op. ([#7399](https://github.com/mozilla/application-services/pull/7399))
-- There are new separate DisqualifiedReason and NotEnrolledReason for global (experiment and rollout) opt-outs. ([#7400](https://github.com/mozilla/application-services/pull/7400))
 - All enrollment updates (opt-in, opt-out, reseting telemetry identifiers, unenrolling for pref conflicts) now trigger feature invalidation in Android clients. ([#7405](https://github.com/mozilla/application-services/pull/7405))
 - Changing experiment and/or rollout participation no longer triggers a double update. Enrollment change telemetry is now appropriately triggered when this occurs. ([#7401](https://github.com/mozilla/application-services/pull/7401))
+
+## ✨ What's New ✨
+
+### Nimbus
+
+- There are new separate DisqualifiedReason and NotEnrolledReason for global (experiment and rollout) opt-outs. ([#7400](https://github.com/mozilla/application-services/pull/7400))
 - The Kotlin client now has per-feature update notifications. ([#7354](https://github.com/mozilla/application-services/pull/7354))
+- The Nimbus client now understands Firefox Labs opt-ins and will not automatically enroll in them. ([#7403](https://github.com/mozilla/application-services/pull/7403))
 
 [Full Changelog](In progress)
 

components/nimbus/src/enrollment.rs

@@ -30,6 +30,8 @@ pub enum EnrolledReason {
     Qualified,
     /// Explicit opt-in.
     OptIn,
+    /// Opted-in via Firefox Labs
+    FirefoxLabsOptIn,
 }
 
 impl Display for EnrolledReason {
@@ -38,6 +40,7 @@ impl Display for EnrolledReason {
             match self {
                 EnrolledReason::Qualified => "Qualified",
                 EnrolledReason::OptIn => "OptIn",
+                EnrolledReason::FirefoxLabsOptIn => "FirefoxLabsOptIn",
             },
             f,
         )
@@ -68,6 +71,9 @@ pub enum NotEnrolledReason {
     /// The user opted-out of rollouts before we ever got enrolled to this one.
     RolloutsOptOut,
 
+    /// This is a Firefox Labs opt-in and we have not opted-in.
+    FirefoxLabs,
+
     /// This state represents several cases:
     ///
     /// - this is an experiment and the user globally opted out of experiments
@@ -99,6 +105,7 @@ impl Display for NotEnrolledReason {
                 NotEnrolledReason::NotTargeted => "NotTargeted",
                 NotEnrolledReason::ExperimentsOptOut => "ExperimentsOptOut",
                 NotEnrolledReason::RolloutsOptOut => "RolloutsOptOut",
+                NotEnrolledReason::FirefoxLabs => "FirefoxLabs",
                 NotEnrolledReason::OptOut => "OptOut",
             },
             f,
@@ -230,6 +237,18 @@ impl ExperimentEnrollment {
         targeting_helper: &NimbusTargetingHelper,
         out_enrollment_events: &mut Vec<EnrollmentChangeEvent>,
     ) -> Result<Self> {
+        // The rollout opt-out does not apply to Firefox Labs, since the user
+        // must consent to each opt-in.
+        #[cfg(feature = "stateful")]
+        if experiment.is_firefox_labs_opt_in {
+            return Ok(Self {
+                slug: experiment.slug.clone(),
+                status: EnrollmentStatus::NotEnrolled {
+                    reason: NotEnrolledReason::FirefoxLabs,
+                },
+            });
+        }
+
         Ok(if !is_user_participating {
             Self {
                 slug: experiment.slug.clone(),
@@ -306,6 +325,16 @@ impl ExperimentEnrollment {
         #[cfg(feature = "stateful")] gecko_pref_store: Option<&GeckoPrefStore>,
         out_enrollment_events: &mut Vec<EnrollmentChangeEvent>,
     ) -> Result<Self> {
+        #[cfg(feature = "stateful")]
+        if updated_experiment.is_firefox_labs_opt_in && !self.status.is_enrolled() {
+            return Ok(self.clone());
+        }
+
+        // Users can globally opt out of rollouts, but not out of Firefox Labs.
+        #[cfg(feature = "stateful")]
+        let is_user_participating =
+            is_user_participating || updated_experiment.is_firefox_labs_opt_in;
+
         Ok(match &self.status {
             EnrollmentStatus::NotEnrolled { .. } | EnrollmentStatus::Error { .. } => {
                 if !is_user_participating || updated_experiment.is_enrollment_paused {
@@ -822,9 +851,7 @@ impl EnrollmentStatus {
         }
         .into()
     }
-}
 
-impl EnrollmentStatus {
     // Note that for now, we only support a single feature_id per experiment,
     // so this code is expected to shift once we start supporting multiple.
     pub fn new_enrolled(reason: EnrolledReason, branch: &str) -> Self {
@@ -836,8 +863,6 @@ impl EnrollmentStatus {
         }
     }
 
-    // This is used in examples, but not in the main dylib, and
-    // triggers a dead code warning when building with `--release`.
     pub fn is_enrolled(&self) -> bool {
         matches!(self, EnrollmentStatus::Enrolled { .. })
     }
@@ -1181,11 +1206,9 @@ impl<'a> EnrollmentsEvolver<'a> {
         out_enrollment_events: &mut Vec<EnrollmentChangeEvent>, // out param containing the events we'd like to emit to glean.
         #[cfg(feature = "stateful")] gecko_pref_store: Option<&GeckoPrefStore>,
     ) -> Result<Option<ExperimentEnrollment>> {
-        let is_already_enrolled = if let Some(enrollment) = prev_enrollment {
-            enrollment.status.is_enrolled()
-        } else {
-            false
-        };
+        let is_already_enrolled = prev_enrollment
+            .map(|e| e.status.is_enrolled())
+            .unwrap_or_default();
 
         // XXX This is not pretty, however, we need to re-write the way sticky targeting strings are generated in
         // experimenter. Once https://github.com/mozilla/experimenter/issues/8661 is fixed, we can remove the calculation

components/nimbus/src/schema.rs

@@ -2,7 +2,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
-use std::collections::BTreeSet;
+use std::collections::{BTreeSet, HashMap};
 
 use serde_derive::{Deserialize, Serialize};
 use serde_json::{Map, Value};
@@ -55,6 +55,20 @@ pub struct Experiment {
     pub published_date: Option<chrono::DateTime<chrono::Utc>>,
     // N.B. records in RemoteSettings will have `id` and `filter_expression` fields,
     // but we ignore them because they're for internal use by RemoteSettings.
+    #[serde(default)]
+    pub is_firefox_labs_opt_in: bool,
+
+    #[serde(default)]
+    pub firefox_labs_title: Option<String>,
+
+    #[serde(default)]
+    pub firefox_labs_description: Option<String>,
+
+    #[serde(default)]
+    pub firefox_labs_description_links: Option<HashMap<String, String>>,
+
+    #[serde(default)]
+    pub requires_restart: bool,
 }
 
 #[cfg_attr(not(feature = "stateful"), allow(unused))]

components/nimbus/src/tests/helpers.rs

@@ -733,6 +733,51 @@ pub(crate) fn get_experiment_with_published_date(
     .unwrap()
 }
 
+#[allow(unused)]
+pub(crate) fn get_firefox_labs(slug: &str) -> Experiment {
+    serde_json::from_value(json!({
+        "schemaVersion": "1.0.0",
+        "appName": "fenix",
+        "appId": "org.mozilla.fenix",
+        "channel": "nightly",
+        "slug": slug,
+        "branches": [
+            {
+                "slug": "control",
+                "ratio": 1,
+                "features": [
+                    {
+                        "featureId": "labs-feature",
+                        "value": {}
+                    }
+                ]
+            }
+        ],
+        "featureIds": ["labs-feature"],
+        "isRollout": true,
+        "isEnrollmentPaused": false,
+        "isFirefoxLabsOptIn": true,
+        "firefoxLabsTitle": "labs-title",
+        "firefoxLabsDescription": "labs-description",
+        "firefoxLabsDescriptionLinks": {
+            "connect": "https://example.com/#connect",
+            "learn-more": "https://example.com/#learn-more",
+        },
+        "userFacingName": "Test Firefox Labs",
+        "userFacingDescription": "Test Firefox Labs",
+        "bucketConfig": {
+            "randomizationUnit": "nimbus_id",
+            "start": 0,
+            "count": 10000,
+            "total": 10000,
+            "namespace": "firefox-labs-test"
+        },
+        "targeting": "true",
+        "proposedEnrollment": 0,
+    }))
+    .unwrap()
+}
+
 #[cfg(feature = "stateful")]
 mod detail {
     use super::TestMetrics;