feat(nimbus): exclude language/locale/country (#13753)

Becuase

* We need a way to optionally exclude selected
languages/locales/countries

This commit

* Adds a bool flag to exclude languages/locales/countries
* Negates the JEXL expressions for each if exclude is selected
* Adds checkboxes for each on the audience page
* Updates the summary page to show whether each is included or excluded

fixes #13752

Author: jaredlockhart

experimenter/experimenter/experiments/migrations/0295_nimbusexperiment_exclude_countries_and_more.py

@@ -0,0 +1,28 @@
+# Generated by Django 5.2.7 on 2025-10-22 20:57
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('experiments', '0294_alter_nimbusexperiment_channel'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='nimbusexperiment',
+            name='exclude_countries',
+            field=models.BooleanField(default=False, help_text='If True, exclude the selected countries instead of including them', verbose_name='Exclude Countries'),
+        ),
+        migrations.AddField(
+            model_name='nimbusexperiment',
+            name='exclude_languages',
+            field=models.BooleanField(default=False, help_text='If True, exclude the selected languages instead of including them', verbose_name='Exclude Languages'),
+        ),
+        migrations.AddField(
+            model_name='nimbusexperiment',
+            name='exclude_locales',
+            field=models.BooleanField(default=False, help_text='If True, exclude the selected locales instead of including them', verbose_name='Exclude Locales'),
+        ),
+    ]

experimenter/experimenter/experiments/models.py

@@ -270,6 +270,21 @@ class NimbusExperiment(NimbusConstants, TargetingConstants, FilterMixin, models.
     languages = models.ManyToManyField[Language](
         Language, blank=True, verbose_name="Supported Languages"
     )
+    exclude_locales = models.BooleanField(
+        "Exclude Locales",
+        default=False,
+        help_text="If True, exclude the selected locales instead of including them",
+    )
+    exclude_countries = models.BooleanField(
+        "Exclude Countries",
+        default=False,
+        help_text="If True, exclude the selected countries instead of including them",
+    )
+    exclude_languages = models.BooleanField(
+        "Exclude Languages",
+        default=False,
+        help_text="If True, exclude the selected languages instead of including them",
+    )
     is_sticky = models.BooleanField("Sticky Enrollment Flag", default=False)
     projects = models.ManyToManyField[Project](
         Project, blank=True, verbose_name="Supported Projects"
@@ -621,21 +636,28 @@ def targeting(self):
 
         if locales := self.locales.all():
             locales = [locale.code for locale in sorted(locales, key=lambda l: l.code)]
-
-            sticky_expressions.append(f"locale in {locales}")
+            locales_expression = f"locale in {locales}"
+            if self.exclude_locales:
+                locales_expression = f"!({locales_expression})"
+            sticky_expressions.append(locales_expression)
 
         if languages := self.languages.all():
             languages = [
                 language.code for language in sorted(languages, key=lambda l: l.code)
             ]
-
-            sticky_expressions.append(f"language in {languages}")
+            languages_expression = f"language in {languages}"
+            if self.exclude_languages:
+                languages_expression = f"!({languages_expression})"
+            sticky_expressions.append(languages_expression)
 
         if countries := self.countries.all():
             countries = [
                 country.code for country in sorted(countries, key=lambda c: c.code)
             ]
-            sticky_expressions.append(f"region in {countries}")
+            countries_expression = f"region in {countries}"
+            if self.exclude_countries:
+                countries_expression = f"!({countries_expression})"
+            sticky_expressions.append(countries_expression)
 
         enrollments_map_key = "enrollments_map"
         if self.is_desktop:

experimenter/experimenter/experiments/tests/test_changelog_utils.py

@@ -58,6 +58,9 @@ def test_outputs_expected_schema_for_empty_experiment(self):
                 "countries": [],
                 "equal_branch_ratio": experiment.equal_branch_ratio,
                 "excluded_experiments": [],
+                "exclude_countries": experiment.exclude_countries,
+                "exclude_languages": experiment.exclude_languages,
+                "exclude_locales": experiment.exclude_locales,
                 "feature_configs": [],
                 "firefox_max_version": NimbusExperiment.Version.NO_VERSION,
                 "firefox_min_version": NimbusExperiment.Version.NO_VERSION,
@@ -181,6 +184,9 @@ def test_outputs_expected_schema_for_complete_experiment(self):
                 "conclusion_recommendations": [],
                 "equal_branch_ratio": experiment.equal_branch_ratio,
                 "excluded_experiments": [],
+                "exclude_countries": experiment.exclude_countries,
+                "exclude_languages": experiment.exclude_languages,
+                "exclude_locales": experiment.exclude_locales,
                 "firefox_max_version": experiment.firefox_max_version,
                 "firefox_min_version": experiment.firefox_min_version,
                 "firefox_labs_title": experiment.firefox_labs_title,

experimenter/experimenter/experiments/tests/test_models.py

@@ -827,6 +827,28 @@ def test_targeting_with_locales(self):
         )
         JEXLParser().parse(experiment.targeting)
 
+    def test_targeting_with_exclude_locales(self):
+        locale_ca = LocaleFactory.create(code="en-CA")
+        locale_us = LocaleFactory.create(code="en-US")
+        experiment = NimbusExperimentFactory.create_with_lifecycle(
+            NimbusExperimentFactory.Lifecycles.LAUNCH_APPROVE_APPROVE,
+            application=NimbusExperiment.Application.DESKTOP,
+            firefox_min_version=NimbusExperiment.Version.NO_VERSION,
+            firefox_max_version=NimbusExperiment.Version.NO_VERSION,
+            targeting_config_slug=NimbusExperiment.TargetingConfig.MAC_ONLY,
+            channel=NimbusExperiment.Channel.NO_CHANNEL,
+            channels=[],
+            locales=[locale_ca, locale_us],
+            exclude_locales=True,
+            countries=[],
+            languages=[],
+        )
+        self.assertEqual(
+            experiment.targeting,
+            ("(os.isMac) && (!(locale in ['en-CA', 'en-US']))"),
+        )
+        JEXLParser().parse(experiment.targeting)
+
     def test_targeting_with_countries(self):
         country_ca = CountryFactory.create(code="CA")
         country_us = CountryFactory.create(code="US")
@@ -848,6 +870,28 @@ def test_targeting_with_countries(self):
         )
         JEXLParser().parse(experiment.targeting)
 
+    def test_targeting_with_exclude_countries(self):
+        country_ca = CountryFactory.create(code="CA")
+        country_us = CountryFactory.create(code="US")
+        experiment = NimbusExperimentFactory.create_with_lifecycle(
+            NimbusExperimentFactory.Lifecycles.LAUNCH_APPROVE_APPROVE,
+            application=NimbusExperiment.Application.DESKTOP,
+            firefox_min_version=NimbusExperiment.Version.NO_VERSION,
+            firefox_max_version=NimbusExperiment.Version.NO_VERSION,
+            targeting_config_slug=NimbusExperiment.TargetingConfig.MAC_ONLY,
+            channel=NimbusExperiment.Channel.NO_CHANNEL,
+            channels=[],
+            locales=[],
+            countries=[country_ca, country_us],
+            exclude_countries=True,
+            languages=[],
+        )
+        self.assertEqual(
+            experiment.targeting,
+            ("(os.isMac) && (!(region in ['CA', 'US']))"),
+        )
+        JEXLParser().parse(experiment.targeting)
+
     def test_targeting_with_locales_and_countries_desktop(self):
         locale_ca = LocaleFactory.create(code="en-CA")
         locale_us = LocaleFactory.create(code="en-US")
@@ -891,6 +935,27 @@ def test_targeting_with_languages_mobile(self):
         )
         JEXLParser().parse(experiment.targeting)
 
+    def test_targeting_with_exclude_languages_mobile(self):
+        language_en = LanguageFactory.create(code="en")
+        language_fr = LanguageFactory.create(code="fr")
+        language_es = LanguageFactory.create(code="es")
+        experiment = NimbusExperimentFactory.create_with_lifecycle(
+            NimbusExperimentFactory.Lifecycles.LAUNCH_APPROVE_APPROVE,
+            application=NimbusExperiment.Application.FENIX,
+            firefox_min_version=NimbusExperiment.Version.NO_VERSION,
+            firefox_max_version=NimbusExperiment.Version.NO_VERSION,
+            targeting_config_slug=NimbusExperiment.TargetingConfig.MOBILE_NEW_USERS,
+            channel=NimbusExperiment.Channel.NO_CHANNEL,
+            channels=[],
+            languages=[language_en, language_es, language_fr],
+            exclude_languages=True,
+        )
+        self.assertEqual(
+            experiment.targeting,
+            "(days_since_install < 7) && (!(language in ['en', 'es', 'fr']))",
+        )
+        JEXLParser().parse(experiment.targeting)
+
     def test_targeting_with_projects(self):
         project_mdn = ProjectFactory.create(slug="mdn")
 

experimenter/experimenter/nimbus_ui/forms.py

@@ -966,16 +966,19 @@ def get_targeting_config_choices(self):
         queryset=Locale.objects.all().order_by("code"),
         widget=MultiSelectWidget(),
     )
+    exclude_locales = forms.BooleanField(required=False)
     languages = forms.ModelMultipleChoiceField(
         required=False,
         queryset=Language.objects.all().order_by("code"),
         widget=MultiSelectWidget(),
     )
+    exclude_languages = forms.BooleanField(required=False)
     countries = forms.ModelMultipleChoiceField(
         required=False,
         queryset=Country.objects.all().order_by("code"),
         widget=MultiSelectWidget(),
     )
+    exclude_countries = forms.BooleanField(required=False)
     targeting_config_slug = forms.ChoiceField(
         required=False,
         label="",
@@ -1015,11 +1018,14 @@ class Meta:
             "channel",
             "channels",
             "countries",
+            "exclude_countries",
+            "exclude_languages",
+            "exclude_locales",
             "excluded_experiments_branches",
             "firefox_max_version",
             "firefox_min_version",
-            "is_sticky",
             "is_first_run",
+            "is_sticky",
             "languages",
             "locales",
             "population_percent",

experimenter/experimenter/nimbus_ui/templates/nimbus_experiments/detail.html

@@ -249,17 +249,38 @@ <h4>Audience</h4>
             </tr>
             <tr>
               {% if experiment.is_mobile %}
-                <th>Languages</th>
+                <th>
+                  {% if experiment.exclude_languages %}
+                    Excluded
+                  {% else %}
+                    Included
+                  {% endif %}
+                  Languages
+                </th>
                 <td>
                   {{ experiment.languages.all|join:"<br>"|default:"All Languages" }}
                 </td>
               {% else %}
-                <th>Locales</th>
+                <th>
+                  {% if experiment.exclude_locales %}
+                    Excluded
+                  {% else %}
+                    Included
+                  {% endif %}
+                  Locales
+                </th>
                 <td>
                   {{ experiment.locales.all|join:"<br>"|default:"All Locales" }}
                 </td>
               {% endif %}
-              <th>Countries</th>
+              <th>
+                {% if experiment.exclude_countries %}
+                  Excluded
+                {% else %}
+                  Included
+                {% endif %}
+                Countries
+              </th>
               <td>
                 {{ experiment.countries.all|join:"<br>"| default:"All Countries" }}
               </td>

experimenter/experimenter/nimbus_ui/templates/nimbus_experiments/edit_audience.html

@@ -56,18 +56,30 @@ <h4>Audience</h4>
             {% if experiment.is_desktop %}
               <label for="id_locales" class="form-label">Locales</label>
               {{ form.locales|add_class:"form-control"|add_error_class:"is-invalid" }}
+              <label for="id_exclude_locales" class="form-label mt-2">
+                {{ form.exclude_locales|add_error_class:"is-invalid" }}
+                Exclude selected locales
+              </label>
               {% for error in form.locales.errors %}<div class="invalid-feedback">{{ error }}</div>{% endfor %}
               {% for error in validation_errors.locales %}<div class="form-text text-danger">{{ error }}</div>{% endfor %}
             {% else %}
               <label for="id_languages" class="form-label">Languages</label>
               {{ form.languages|add_class:"form-control"|add_error_class:"is-invalid" }}
+              <label for="id_exclude_languages" class="form-label mt-2">
+                {{ form.exclude_languages|add_error_class:"is-invalid" }}
+                Exclude selected languages
+              </label>
               {% for error in form.languages.errors %}<div class="invalid-feedback">{{ error }}</div>{% endfor %}
               {% for error in validation_errors.languages %}<div class="form-text text-danger">{{ error }}</div>{% endfor %}
             {% endif %}
           </div>
           <div data-testid="countries" class="col-6">
             <label for="id_countries" class="form-label">Countries</label>
             {{ form.countries|add_class:"form-control"|add_error_class:"is-invalid" }}
+            <label for="id_exclude_countries" class="form-label mt-2">
+              {{ form.exclude_countries|add_error_class:"is-invalid" }}
+              Exclude selected countries
+            </label>
             {% for error in form.countries.errors %}<div class="invalid-feedback">{{ error }}</div>{% endfor %}
             {% for error in validation_errors.countries %}<div class="form-text text-danger">{{ error }}</div>{% endfor %}
           </div>

experimenter/experimenter/nimbus_ui/tests/test_forms.py

@@ -1347,6 +1347,9 @@ def test_valid_form_saves_desktop(self):
             countries=[],
             locales=[],
             languages=[],
+            exclude_countries=False,
+            exclude_locales=False,
+            exclude_languages=False,
         )
 
         form = AudienceForm(
@@ -1359,6 +1362,9 @@ def test_valid_form_saves_desktop(self):
                 ],
                 "countries": [country.id],
                 "excluded_experiments_branches": [f"{excluded.slug}:None"],
+                "exclude_countries": True,
+                "exclude_locales": True,
+                "exclude_languages": True,
                 "firefox_max_version": NimbusExperiment.Version.FIREFOX_84,
                 "firefox_min_version": NimbusExperiment.Version.FIREFOX_83,
                 "is_sticky": True,
@@ -1400,6 +1406,9 @@ def test_valid_form_saves_desktop(self):
         self.assertEqual(list(experiment.countries.all()), [country])
         self.assertEqual(list(experiment.locales.all()), [locale])
         self.assertEqual(list(experiment.languages.all()), [language])
+        self.assertTrue(experiment.exclude_countries)
+        self.assertTrue(experiment.exclude_locales)
+        self.assertTrue(experiment.exclude_languages)
         self.assertTrue(experiment.is_sticky)
         self.assertEqual(experiment.excluded_experiments.get(), excluded)
         self.assertTrue(

experimenter/experimenter/nimbus_ui/tests/test_views.py

@@ -2750,6 +2750,9 @@ def test_post_updates_overview(self):
             countries=[],
             locales=[],
             languages=[],
+            exclude_countries=False,
+            exclude_locales=False,
+            exclude_languages=False,
         )
 
         response = self.client.post(
@@ -2758,6 +2761,9 @@ def test_post_updates_overview(self):
                 "channel": NimbusExperiment.Channel.BETA,
                 "countries": [country.id],
                 "excluded_experiments_branches": [f"{excluded.slug}:None"],
+                "exclude_countries": True,
+                "exclude_locales": True,
+                "exclude_languages": True,
                 "firefox_max_version": NimbusExperiment.Version.FIREFOX_84,
                 "firefox_min_version": NimbusExperiment.Version.FIREFOX_83,
                 "is_sticky": True,
@@ -2794,6 +2800,9 @@ def test_post_updates_overview(self):
         self.assertEqual(list(experiment.countries.all()), [country])
         self.assertEqual(list(experiment.locales.all()), [locale])
         self.assertEqual(list(experiment.languages.all()), [language])
+        self.assertTrue(experiment.exclude_countries)
+        self.assertTrue(experiment.exclude_locales)
+        self.assertTrue(experiment.exclude_languages)
         self.assertTrue(experiment.is_sticky)
         self.assertEqual(experiment.excluded_experiments.get(), excluded)
         self.assertTrue(