From 477447be5fb16a96203763cc55ba30627f2a102e Mon Sep 17 00:00:00 2001 From: Experimenter Bot Date: Fri, 4 Sep 2026 19:29:09 +0000 Subject: [PATCH] chore(nimbus): Update External Configs --- .../features/manifests/fenix/.ref-cache.yaml | 6 +- .../features/manifests/fenix/beta.fml.yaml | 37 +- .../manifests/fenix/developer.fml.yaml | 37 +- .../manifests/fenix/experimenter.yaml | 17 +- .../features/manifests/fenix/nightly.fml.yaml | 37 +- .../features/manifests/fenix/release.fml.yaml | 37 +- .../fenix/v155.0.2/RecordedNimbusContext.kt | 306 + .../manifests/fenix/v155.0.2/beta.fml.yaml | 1726 +++++ .../fenix/v155.0.2/developer.fml.yaml | 1746 +++++ .../fenix/v155.0.2/experimenter.yaml | 1097 +++ .../manifests/fenix/v155.0.2/nightly.fml.yaml | 1772 +++++ .../manifests/fenix/v155.0.2/release.fml.yaml | 1726 +++++ .../manifests/fenix/v157.0.0/beta.fml.yaml | 37 +- .../fenix/v157.0.0/developer.fml.yaml | 37 +- .../fenix/v157.0.0/experimenter.yaml | 17 +- .../manifests/fenix/v157.0.0/nightly.fml.yaml | 37 +- .../manifests/fenix/v157.0.0/release.fml.yaml | 37 +- .../manifests/firefox-desktop/.ref-cache.yaml | 8 +- .../TargetingContextRecorder.sys.mjs | 5 +- .../firefox-desktop/experimenter.yaml | 48 +- .../v155.0.2/TargetingContextRecorder.sys.mjs | 421 ++ .../v155.0.2/experimenter.yaml | 6180 +++++++++++++++++ ...kgroundTaskMessagingExperiment.schema.json | 370 + .../schemas/MessagingExperiment.schema.json | 2320 +++++++ .../NimbusTelemetryFeature.schema.json | 35 + .../schemas/PrefFlipsFeature.schema.json | 48 + .../schemas/LegacyHeartbeat.schema.json | 73 + .../v157.0.0/TargetingContextRecorder.sys.mjs | 5 +- .../v157.0.0/experimenter.yaml | 48 +- .../manifests/fxa-web/developer.fml.yaml | 36 + .../manifests/fxa-web/experimenter.yaml | 13 + .../manifests/fxa-web/production.fml.yaml | 36 + .../manifests/fxa-web/staging.fml.yaml | 36 + .../features/manifests/ios/.ref-cache.yaml | 6 +- .../features/manifests/ios/beta.fml.yaml | 2 +- .../features/manifests/ios/developer.fml.yaml | 2 +- .../features/manifests/ios/release.fml.yaml | 2 +- .../ios/v155.1.1/RecordedNimbusContext.swift | 226 + .../manifests/ios/v155.1.1/beta.fml.yaml | 1547 +++++ .../manifests/ios/v155.1.1/developer.fml.yaml | 1558 +++++ .../manifests/ios/v155.1.1/experimenter.yaml | 621 ++ .../manifests/ios/v155.1.1/release.fml.yaml | 1528 ++++ .../ios/v156.1.0/RecordedNimbusContext.swift | 226 + .../manifests/ios/v156.1.0/beta.fml.yaml | 1547 +++++ .../manifests/ios/v156.1.0/developer.fml.yaml | 1558 +++++ .../manifests/ios/v156.1.0/experimenter.yaml | 631 ++ .../manifests/ios/v156.1.0/release.fml.yaml | 1528 ++++ 47 files changed, 29193 insertions(+), 180 deletions(-) create mode 100644 experimenter/experimenter/features/manifests/fenix/v155.0.2/RecordedNimbusContext.kt create mode 100644 experimenter/experimenter/features/manifests/fenix/v155.0.2/beta.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/fenix/v155.0.2/developer.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/fenix/v155.0.2/experimenter.yaml create mode 100644 experimenter/experimenter/features/manifests/fenix/v155.0.2/nightly.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/fenix/v155.0.2/release.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/TargetingContextRecorder.sys.mjs create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/experimenter.yaml create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/schemas/browser/components/asrouter/content-src/schemas/BackgroundTaskMessagingExperiment.schema.json create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/schemas/browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/schemas/toolkit/components/nimbus/schemas/NimbusTelemetryFeature.schema.json create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/schemas/toolkit/components/nimbus/schemas/PrefFlipsFeature.schema.json create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/schemas/toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json create mode 100644 experimenter/experimenter/features/manifests/ios/v155.1.1/RecordedNimbusContext.swift create mode 100644 experimenter/experimenter/features/manifests/ios/v155.1.1/beta.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/ios/v155.1.1/developer.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/ios/v155.1.1/experimenter.yaml create mode 100644 experimenter/experimenter/features/manifests/ios/v155.1.1/release.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/ios/v156.1.0/RecordedNimbusContext.swift create mode 100644 experimenter/experimenter/features/manifests/ios/v156.1.0/beta.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/ios/v156.1.0/developer.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/ios/v156.1.0/experimenter.yaml create mode 100644 experimenter/experimenter/features/manifests/ios/v156.1.0/release.fml.yaml diff --git a/experimenter/experimenter/features/manifests/fenix/.ref-cache.yaml b/experimenter/experimenter/features/manifests/fenix/.ref-cache.yaml index be083388e0..a70bcd0918 100644 --- a/experimenter/experimenter/features/manifests/fenix/.ref-cache.yaml +++ b/experimenter/experimenter/features/manifests/fenix/.ref-cache.yaml @@ -1,3 +1,3 @@ -beta: cd7d1d5e32180e2782d659d70b90dfe6fdd149aa -main: edfb027f321fd2584c8fd2df528e665b7f5b8dac -release: 576d9b07706419cebc9dcf9e9b463a2c3a0d4c7a +beta: ffbfcc25e77ea3427dd73ead95070777b00ed3b2 +main: 0271096efe3ea9e8c9a5479f26774f1842ef0585 +release: c9eaf0ccb15b0ec83277bc961de46d9beed77451 diff --git a/experimenter/experimenter/features/manifests/fenix/beta.fml.yaml b/experimenter/experimenter/features/manifests/fenix/beta.fml.yaml index 5036759c6d..583721f682 100644 --- a/experimenter/experimenter/features/manifests/fenix/beta.fml.yaml +++ b/experimenter/experimenter/features/manifests/fenix/beta.fml.yaml @@ -60,17 +60,19 @@ features: description: Control Baseline Fingerprinting Protection variables: enabled: - description: Enables / disables baseline fingerprinting protection. - type: Boolean - default: true + description: | + Enables / disables baseline fingerprinting protection. Unset leaves the existing setting alone. + type: Option + default: null feat-enabled: - description: If true, the feature is active. + description: | + Deprecated and no longer read. Each of the values below is applied independently when a recipe supplies it; leaving a value unset means "leave the existing setting alone". type: Boolean default: false overrides: - description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. - type: String - default: '' + description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. Unset leaves the existing setting alone. + type: Option + default: null collections-to-tab-groups-migration: description: Feature to migrate Collections to Tab Groups for users on Firefox for Android. variables: @@ -175,19 +177,20 @@ features: description: Control Fingerprinting Protection variables: enabled: - description: If true, the feature is active. + description: | + Deprecated and no longer read. Each of the values below is applied independently when a recipe supplies it; leaving a value unset means "leave the existing setting alone". type: Boolean default: false enabled-normal: description: | - Enables / disables fingerprinting protection in normal browsing mode. - type: Boolean - default: false + Enables / disables fingerprinting protection in normal browsing mode. Unset leaves the existing setting alone. + type: Option + default: null enabled-private: description: | - Enables / disables fingerprinting protection in private browsing mode. - type: Boolean - default: true + Enables / disables fingerprinting protection in private browsing mode. Unset leaves the existing setting alone. + type: Option + default: null fdlibm-math: description: | Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy @@ -195,9 +198,9 @@ features: default: false overrides: description: | - The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. - type: String - default: '' + The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. Unset leaves the existing setting alone. + type: Option + default: null firefox-jp-guide-default-site: description: | This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut diff --git a/experimenter/experimenter/features/manifests/fenix/developer.fml.yaml b/experimenter/experimenter/features/manifests/fenix/developer.fml.yaml index 427192eceb..998f78ce04 100644 --- a/experimenter/experimenter/features/manifests/fenix/developer.fml.yaml +++ b/experimenter/experimenter/features/manifests/fenix/developer.fml.yaml @@ -60,17 +60,19 @@ features: description: Control Baseline Fingerprinting Protection variables: enabled: - description: Enables / disables baseline fingerprinting protection. - type: Boolean - default: true + description: | + Enables / disables baseline fingerprinting protection. Unset leaves the existing setting alone. + type: Option + default: null feat-enabled: - description: If true, the feature is active. + description: | + Deprecated and no longer read. Each of the values below is applied independently when a recipe supplies it; leaving a value unset means "leave the existing setting alone". type: Boolean default: false overrides: - description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. - type: String - default: '' + description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. Unset leaves the existing setting alone. + type: Option + default: null collections-to-tab-groups-migration: description: Feature to migrate Collections to Tab Groups for users on Firefox for Android. variables: @@ -175,19 +177,20 @@ features: description: Control Fingerprinting Protection variables: enabled: - description: If true, the feature is active. + description: | + Deprecated and no longer read. Each of the values below is applied independently when a recipe supplies it; leaving a value unset means "leave the existing setting alone". type: Boolean default: false enabled-normal: description: | - Enables / disables fingerprinting protection in normal browsing mode. - type: Boolean - default: false + Enables / disables fingerprinting protection in normal browsing mode. Unset leaves the existing setting alone. + type: Option + default: null enabled-private: description: | - Enables / disables fingerprinting protection in private browsing mode. - type: Boolean - default: true + Enables / disables fingerprinting protection in private browsing mode. Unset leaves the existing setting alone. + type: Option + default: null fdlibm-math: description: | Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy @@ -195,9 +198,9 @@ features: default: false overrides: description: | - The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. - type: String - default: '' + The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. Unset leaves the existing setting alone. + type: Option + default: null firefox-jp-guide-default-site: description: | This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut diff --git a/experimenter/experimenter/features/manifests/fenix/experimenter.yaml b/experimenter/experimenter/features/manifests/fenix/experimenter.yaml index 92bce2177a..cf8dc3d60c 100644 --- a/experimenter/experimenter/features/manifests/fenix/experimenter.yaml +++ b/experimenter/experimenter/features/manifests/fenix/experimenter.yaml @@ -59,13 +59,15 @@ baseline-fpp: variables: enabled: type: boolean - description: Enables / disables baseline fingerprinting protection. + description: | + Enables / disables baseline fingerprinting protection. Unset leaves the existing setting alone. feat-enabled: type: boolean - description: If true, the feature is active. + description: | + Deprecated and no longer read. Each of the values below is applied independently when a recipe supplies it; leaving a value unset means "leave the existing setting alone". overrides: type: string - description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. + description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. Unset leaves the existing setting alone. collections-to-tab-groups-migration: description: Feature to migrate Collections to Tab Groups for users on Firefox for Android. hasExposure: true @@ -177,15 +179,16 @@ fingerprinting-protection: variables: enabled: type: boolean - description: If true, the feature is active. + description: | + Deprecated and no longer read. Each of the values below is applied independently when a recipe supplies it; leaving a value unset means "leave the existing setting alone". enabled-normal: type: boolean description: | - Enables / disables fingerprinting protection in normal browsing mode. + Enables / disables fingerprinting protection in normal browsing mode. Unset leaves the existing setting alone. enabled-private: type: boolean description: | - Enables / disables fingerprinting protection in private browsing mode. + Enables / disables fingerprinting protection in private browsing mode. Unset leaves the existing setting alone. fdlibm-math: type: boolean description: | @@ -193,7 +196,7 @@ fingerprinting-protection: overrides: type: string description: | - The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. + The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. Unset leaves the existing setting alone. firefox-jp-guide-default-site: description: | This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut diff --git a/experimenter/experimenter/features/manifests/fenix/nightly.fml.yaml b/experimenter/experimenter/features/manifests/fenix/nightly.fml.yaml index 4a9582bab0..10a08c3cbd 100644 --- a/experimenter/experimenter/features/manifests/fenix/nightly.fml.yaml +++ b/experimenter/experimenter/features/manifests/fenix/nightly.fml.yaml @@ -60,17 +60,19 @@ features: description: Control Baseline Fingerprinting Protection variables: enabled: - description: Enables / disables baseline fingerprinting protection. - type: Boolean - default: true + description: | + Enables / disables baseline fingerprinting protection. Unset leaves the existing setting alone. + type: Option + default: null feat-enabled: - description: If true, the feature is active. + description: | + Deprecated and no longer read. Each of the values below is applied independently when a recipe supplies it; leaving a value unset means "leave the existing setting alone". type: Boolean default: false overrides: - description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. - type: String - default: '' + description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. Unset leaves the existing setting alone. + type: Option + default: null collections-to-tab-groups-migration: description: Feature to migrate Collections to Tab Groups for users on Firefox for Android. variables: @@ -175,19 +177,20 @@ features: description: Control Fingerprinting Protection variables: enabled: - description: If true, the feature is active. + description: | + Deprecated and no longer read. Each of the values below is applied independently when a recipe supplies it; leaving a value unset means "leave the existing setting alone". type: Boolean default: false enabled-normal: description: | - Enables / disables fingerprinting protection in normal browsing mode. - type: Boolean - default: false + Enables / disables fingerprinting protection in normal browsing mode. Unset leaves the existing setting alone. + type: Option + default: null enabled-private: description: | - Enables / disables fingerprinting protection in private browsing mode. - type: Boolean - default: true + Enables / disables fingerprinting protection in private browsing mode. Unset leaves the existing setting alone. + type: Option + default: null fdlibm-math: description: | Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy @@ -195,9 +198,9 @@ features: default: false overrides: description: | - The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. - type: String - default: '' + The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. Unset leaves the existing setting alone. + type: Option + default: null firefox-jp-guide-default-site: description: | This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut diff --git a/experimenter/experimenter/features/manifests/fenix/release.fml.yaml b/experimenter/experimenter/features/manifests/fenix/release.fml.yaml index d1eaf29ea5..1ccc558eb9 100644 --- a/experimenter/experimenter/features/manifests/fenix/release.fml.yaml +++ b/experimenter/experimenter/features/manifests/fenix/release.fml.yaml @@ -60,17 +60,19 @@ features: description: Control Baseline Fingerprinting Protection variables: enabled: - description: Enables / disables baseline fingerprinting protection. - type: Boolean - default: true + description: | + Enables / disables baseline fingerprinting protection. Unset leaves the existing setting alone. + type: Option + default: null feat-enabled: - description: If true, the feature is active. + description: | + Deprecated and no longer read. Each of the values below is applied independently when a recipe supplies it; leaving a value unset means "leave the existing setting alone". type: Boolean default: false overrides: - description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. - type: String - default: '' + description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. Unset leaves the existing setting alone. + type: Option + default: null collections-to-tab-groups-migration: description: Feature to migrate Collections to Tab Groups for users on Firefox for Android. variables: @@ -175,19 +177,20 @@ features: description: Control Fingerprinting Protection variables: enabled: - description: If true, the feature is active. + description: | + Deprecated and no longer read. Each of the values below is applied independently when a recipe supplies it; leaving a value unset means "leave the existing setting alone". type: Boolean default: false enabled-normal: description: | - Enables / disables fingerprinting protection in normal browsing mode. - type: Boolean - default: false + Enables / disables fingerprinting protection in normal browsing mode. Unset leaves the existing setting alone. + type: Option + default: null enabled-private: description: | - Enables / disables fingerprinting protection in private browsing mode. - type: Boolean - default: true + Enables / disables fingerprinting protection in private browsing mode. Unset leaves the existing setting alone. + type: Option + default: null fdlibm-math: description: | Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy @@ -195,9 +198,9 @@ features: default: false overrides: description: | - The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. - type: String - default: '' + The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. Unset leaves the existing setting alone. + type: Option + default: null firefox-jp-guide-default-site: description: | This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut diff --git a/experimenter/experimenter/features/manifests/fenix/v155.0.2/RecordedNimbusContext.kt b/experimenter/experimenter/features/manifests/fenix/v155.0.2/RecordedNimbusContext.kt new file mode 100644 index 0000000000..d216e8a0ad --- /dev/null +++ b/experimenter/experimenter/features/manifests/fenix/v155.0.2/RecordedNimbusContext.kt @@ -0,0 +1,306 @@ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +package org.mozilla.fenix.experiments + +import android.content.Context +import android.os.Build +import androidx.annotation.VisibleForTesting +import androidx.core.app.NotificationManagerCompat +import kotlinx.coroutines.flow.first +import mozilla.components.support.base.ext.areNotificationsEnabledSafe +import mozilla.components.support.base.ext.isNotificationChannelEnabled +import mozilla.components.support.locale.LocaleManager +import mozilla.components.support.locale.LocaleManager.getSystemDefault +import mozilla.components.support.utils.ext.packageManagerCompatHelper +import org.json.JSONArray +import org.json.JSONObject +import org.mozilla.experiments.nimbus.NIMBUS_DATA_DIR +import org.mozilla.experiments.nimbus.NimbusDeviceInfo +import org.mozilla.experiments.nimbus.internal.JsonObject +import org.mozilla.experiments.nimbus.internal.RecordedContext +import org.mozilla.experiments.nimbus.internal.getCalculatedAttributes +import org.mozilla.fenix.GleanMetrics.NimbusSystem +import org.mozilla.fenix.ext.components +import org.mozilla.fenix.home.pocket.ContentRecommendationsFeatureHelper +import org.mozilla.fenix.onboarding.MARKETING_CHANNEL_ID +import org.mozilla.fenix.perf.runBlockingIncrement +import org.mozilla.fenix.termsofuse.experimentation.TermsOfUseAdvancedTargetingHelper +import org.mozilla.fenix.termsofuse.experimentation.utils.DefaultTermsOfUseDataProvider +import org.mozilla.fenix.utils.Settings +import java.io.File + +/** + * The following constants are string constants of the keys that appear in the [EVENT_QUERIES] map. + */ +const val DAYS_OPENED_IN_LAST_28 = "days_opened_in_last_28" + +/** + * [EVENT_QUERIES] is a map of keys to Nimbus SDK EventStore queries. + */ +private val EVENT_QUERIES = mapOf( + DAYS_OPENED_IN_LAST_28 to "'events.app_opened'|eventCountNonZero('Days', 28, 0)", +) + +/** + * The RecordedNimbusContext class inherits from an internal Nimbus interface that provides methods + * for obtaining a JSON value for the object and recording the object's value to Glean. Its JSON + * value is loaded into the Nimbus targeting context. + * + * The value recorded to Glean is used to automate population sizing. Any additions to this object + * require a new data review for the `nimbus_system.recorded_nimbus_context` metric. + */ +@Suppress("complexity:LongParameterList") +class RecordedNimbusContext( + val isFirstRun: Boolean, + private val eventQueries: Map = mapOf(), + private var eventQueryValues: Map = mapOf(), + val utmSource: String, + val utmMedium: String, + val utmCampaign: String, + val utmTerm: String, + val utmContent: String, + val androidSdkVersion: String = Build.VERSION.SDK_INT.toString(), + val appVersion: String?, + val locale: String, + val daysSinceInstall: Int?, + val daysSinceUpdate: Int?, + val language: String?, + val region: String?, + val deviceManufacturer: String = Build.MANUFACTURER, + val deviceModel: String = Build.MODEL, + val userAcceptedTou: Boolean, + val noShortcutsOrStoriesOptOuts: Boolean, + val addonIds: List, + val touPoints: Int?, + val userDisabledAi: Boolean, + val areNotificationsEnabled: Boolean, + val areMarketingNotificationsEnabled: Boolean, +) : RecordedContext { + /** + * [getEventQueries] is called by the Nimbus SDK Rust code to retrieve the map of event + * queries. The are then executed against the Nimbus SDK's EventStore to retrieve their values. + * + * @return Map + */ + override fun getEventQueries(): Map { + return eventQueries + } + + /** + * [record] is called when experiment enrollments are evolved. It should apply the + * [RecordedNimbusContext]'s values to a [NimbusSystem.RecordedNimbusContextObject] instance, + * and use that instance to record the values to Glean. + */ + override fun record() { + val eventQueryValuesObject = NimbusSystem.RecordedNimbusContextObjectItemEventQueryValuesObject( + daysOpenedInLast28 = eventQueryValues[DAYS_OPENED_IN_LAST_28]?.toInt(), + ) + NimbusSystem.recordedNimbusContext.set( + NimbusSystem.RecordedNimbusContextObject( + isFirstRun = isFirstRun, + eventQueryValues = eventQueryValuesObject, + installReferrerResponseUtmSource = utmSource, + installReferrerResponseUtmMedium = utmMedium, + installReferrerResponseUtmCampaign = utmCampaign, + installReferrerResponseUtmTerm = utmTerm, + installReferrerResponseUtmContent = utmContent, + androidSdkVersion = androidSdkVersion, + appVersion = appVersion, + locale = locale, + daysSinceInstall = daysSinceInstall, + daysSinceUpdate = daysSinceUpdate, + language = language, + region = region, + deviceManufacturer = deviceManufacturer, + deviceModel = deviceModel, + userAcceptedTou = userAcceptedTou, + noShortcutsOrStoriesOptOuts = noShortcutsOrStoriesOptOuts, + addonIds = NimbusSystem.RecordedNimbusContextObjectAddonIds(addonIds.toMutableList()), + touPoints = touPoints, + userDisabledAi = userDisabledAi, + areNotificationsEnabled = areNotificationsEnabled, + areMarketingNotificationsEnabled = areMarketingNotificationsEnabled, + ), + ) + } + + /** + * [setEventQueryValues] is called by the Nimbus SDK Rust code after the event queries have been + * executed. The [eventQueryValues] should be written back to the Kotlin object. + * + * @param [eventQueryValues] The values for each query after they have been executed in the + * Nimbus SDK Rust environment. + */ + override fun setEventQueryValues(eventQueryValues: Map) { + this.eventQueryValues = eventQueryValues + } + + /** + * [toJson] is called by the Nimbus SDK Rust code after the event queries have been executed, + * and before experiment enrollments have been evolved. The value returned from this method + * will be applied directly to the Nimbus targeting context, and its keys/values take + * precedence over those in the main Nimbus targeting context. + * + * @return JSONObject + */ + override fun toJson(): JsonObject { + val obj = JSONObject( + mapOf( + "is_first_run" to isFirstRun, + "events" to JSONObject(eventQueryValues), + "install_referrer_response_utm_source" to utmSource, + "install_referrer_response_utm_medium" to utmMedium, + "install_referrer_response_utm_campaign" to utmCampaign, + "install_referrer_response_utm_term" to utmTerm, + "install_referrer_response_utm_content" to utmContent, + "android_sdk_version" to androidSdkVersion, + "app_version" to appVersion, + "locale" to locale, + "days_since_install" to daysSinceInstall, + "days_since_update" to daysSinceUpdate, + "language" to language, + "region" to region, + "device_manufacturer" to deviceManufacturer, + "device_model" to deviceModel, + "user_accepted_tou" to userAcceptedTou, + "no_shortcuts_or_stories_opt_outs" to noShortcutsOrStoriesOptOuts, + "addon_ids" to JSONArray(addonIds), + "tou_points" to touPoints, + "user_disabled_ai" to userDisabledAi, + "are_notifications_enabled" to areNotificationsEnabled, + "are_marketing_notifications_enabled" to areMarketingNotificationsEnabled, + ), + ) + return obj + } + + /** + * Companion object for RecordedNimbusContext + */ + companion object { + + /** + * Creates a RecordedNimbusContext instance, populated with the application-defined + * eventQueries + * + * @return RecordedNimbusContext + */ + fun create( + context: Context, + isFirstRun: Boolean, + ): RecordedNimbusContext { + val settings = context.components.settings + val langTag = LocaleManager.getCurrentLocale(context) + ?.toLanguageTag() ?: getSystemDefault().toLanguageTag() + val termsOfUseAdvancedTargetingHelper = TermsOfUseAdvancedTargetingHelper( + DefaultTermsOfUseDataProvider(settings), + langTag, + ) + + val packageInfo = + context.packageManagerCompatHelper.getPackageInfoCompat(context.packageName, 0) + val deviceInfo = NimbusDeviceInfo.default() + val db = File(context.applicationInfo.dataDir, NIMBUS_DATA_DIR) + val calculatedAttributes = getCalculatedAttributes( + packageInfo.firstInstallTime, + db.path, + deviceInfo.localeTag, + ) + + val isAiBlocked = runBlockingIncrement { context.components.aiFeatureBlockStorage.isBlocked.first() } + val notificationManager = NotificationManagerCompat.from(context) + + return RecordedNimbusContext( + isFirstRun = isFirstRun, + eventQueries = EVENT_QUERIES, + utmSource = settings.utmSource, + utmMedium = settings.utmMedium, + utmCampaign = settings.utmCampaign, + utmTerm = settings.utmTerm, + utmContent = settings.utmContent, + appVersion = packageInfo.versionName, + locale = deviceInfo.localeTag, + daysSinceInstall = calculatedAttributes.daysSinceInstall, + daysSinceUpdate = calculatedAttributes.daysSinceUpdate, + language = calculatedAttributes.language, + region = calculatedAttributes.region, + userAcceptedTou = settings.hasAcceptedTermsOfService, + noShortcutsOrStoriesOptOuts = settings.noShortcutsOrStoriesOptOuts(context), + addonIds = getFormattedAddons(settings), + touPoints = termsOfUseAdvancedTargetingHelper.getTouPoints(), + userDisabledAi = isAiBlocked, + areNotificationsEnabled = notificationManager.areNotificationsEnabledSafe(), + areMarketingNotificationsEnabled = notificationManager + .isNotificationChannelEnabled(MARKETING_CHANNEL_ID), + ) + } + + @VisibleForTesting + internal fun getFormattedAddons(settings: Settings): List = + settings.installedAddonsList.split(",").map { it.trim() } + + /** + * Checks whether an eligible user has opted out of any sponsored top sites or stories. + * + * @return `true` if the user has opted out of any sponsored top sites or stories, + * `false` otherwise. + */ + private fun Settings.noShortcutsOrStoriesOptOuts(context: Context) = + !optedOutOfSponsoredTopSites() && !optedOutOfSponsoredStories(context) + + /** + * Checks whether an eligible user has opted out of the sponsored top sites feature. + * + * This is not entirely self evident from the API descriptions, please note: + * [Settings.showContileFeature] indicates whether the sponsored shortcuts are shown. + * [Settings.showTopSitesFeature] indicates whether the feature should be shown at all. + */ + private fun Settings.optedOutOfSponsoredTopSites() = + !showContileFeature || !showTopSitesFeature + + private fun Settings.optedOutOfSponsoredStories(context: Context) = + isEligibleForStories(context) && (!showPocketSponsoredStories || !showPocketRecommendationsFeature) + + private fun isEligibleForStories(context: Context): Boolean = + ContentRecommendationsFeatureHelper.isContentRecommendationsFeatureEnabled(context) + + /** + * Creates a RecordedNimbusContext instance for test purposes + * + * @return RecordedNimbusContext + */ + @VisibleForTesting + internal fun createForTest( + isFirstRun: Boolean = false, + eventQueries: Map = EVENT_QUERIES, + eventQueryValues: Map = mapOf(), + addonIds: List = emptyList(), + ): RecordedNimbusContext { + return RecordedNimbusContext( + isFirstRun = isFirstRun, + eventQueries = eventQueries, + eventQueryValues = eventQueryValues, + utmSource = "", + utmMedium = "", + utmCampaign = "", + utmTerm = "", + utmContent = "", + appVersion = "", + locale = "", + daysSinceInstall = 5, + daysSinceUpdate = 0, + language = "en", + region = "US", + userAcceptedTou = true, + noShortcutsOrStoriesOptOuts = true, + addonIds = addonIds, + touPoints = 3, + userDisabledAi = true, + areNotificationsEnabled = false, + areMarketingNotificationsEnabled = false, + ) + } + } +} diff --git a/experimenter/experimenter/features/manifests/fenix/v155.0.2/beta.fml.yaml b/experimenter/experimenter/features/manifests/fenix/v155.0.2/beta.fml.yaml new file mode 100644 index 0000000000..2cf5a90bfd --- /dev/null +++ b/experimenter/experimenter/features/manifests/fenix/v155.0.2/beta.fml.yaml @@ -0,0 +1,1726 @@ +version: 1.0.0 +about: + description: Nimbus Feature Manifest for Fenix (Firefox Android) +channels: +- beta +features: + add-shortcuts-improvement: + description: Feature to enable Add Shortcuts improvement for users on Firefox on Android. + variables: + enabled: + description: If true, Add Shortcuts improvement is enabled. + type: Boolean + default: true + ads-client-for-stories: + description: Feature to enable the Mozilla Ads Client support for Sponsored Stories for users on Firefox on Android. + variables: + enabled: + description: If true, Mozilla Ads Client support for Sponsored Stories is enabled. + type: Boolean + default: false + alternative-app-launcher-icon: + description: A feature that changes the app launcher icon background color. + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + reset-to-default: + description: | + If true use the default icon, if false use the alternative icon. This is required to 'reset' the icon for enrolled users once the initial experiment is complete. + type: Boolean + default: false + app-links: + description: Control behavior of app links handling in the browser. + variables: + show-new-prompt: + description: Whether to show the new AppLinksPromptFragment dialog when an app link is detected. If false, the old dialog is used. + type: Boolean + default: true + awesomebar-suggestion-provider: + description: Configuration for the Firefox Suggest awesomebar suggestion provider. + variables: + available-suggestion-types: + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + type: Map + default: + amp: true + ampMobile: false + wikipedia: true + baseline-fpp: + description: Control Baseline Fingerprinting Protection + variables: + enabled: + description: Enables / disables baseline fingerprinting protection. + type: Boolean + default: true + feat-enabled: + description: If true, the feature is active. + type: Boolean + default: false + overrides: + description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. + type: String + default: '' + collections-to-tab-groups-migration: + description: Feature to migrate Collections to Tab Groups for users on Firefox for Android. + variables: + hide-collections-ui: + description: If true, the Collections UI is hidden. + type: Boolean + default: false + continuous-onboarding: + description: | + Feature to enable the continuous onboarding flow. This feature reduces the number of upfront onboarding cards and distributes the cards and other prompts progressively over a number of days. + variables: + enabled: + description: If true, the feature is enabled. + type: Boolean + default: true + custom-review-prompt-ui: + description: Feature that controls the custom UI for review prompt. + variables: + enabled: + description: When enabled we show the custom review prompt UI. Otherwise we try to directly show the Play Store in-app review prompt. + type: Boolean + default: true + default-bottom-toolbar: + description: Default toolbar position for new users. + variables: + enabled: + description: | + Whether to default the toolbar position to bottom. + type: Boolean + default: false + default-browser-prompt: + description: Feature that controls when the default browser prompt is shown. + variables: + coldStartsBetweenPrompts: + description: The minimum number of cold starts between showing the prompt. + type: Option + default: 4 + daysBetweenPrompts: + description: The minimum number of days between showing the prompt. + type: Option + default: 14 + enabled: + description: Whether or not to enable the default browser prompt. + type: Boolean + default: true + maxPromptsShown: + description: The maximum number of times the prompt can shown to the user. + type: Option + default: 3 + default-expanded-toolbar: + description: Default expanded (bottom navigation) toolbar state for new users. + variables: + enabled: + description: | + Whether to default the expanded toolbar (bottom navigation bar with back/forward/share/bookmark/menu) to enabled. Only takes visible effect on tall, non-wide windows. + type: Boolean + default: false + doh: + description: Feature controlling DNS over HTTPS (DoH). + variables: + autoselect-enabled: + description: | + Controls the network.android_doh.autoselect_enabled pref and automatically chooses a DoH provider when Default Protection mode is selected. + type: Boolean + default: false + show-ui: + description: | + When `true`, include DoH settings in the settings UI. + type: Boolean + default: true + downloads-custom-location: + description: Feature to enable the custom download location for users on Firefox on Android. + variables: + enabled: + description: If true, custom download location is enabled. + type: Boolean + default: true + email-masks: + description: Feature to enable Email Mask for users on Firefox on Android. + variables: + enabled: + description: If true, Email Mask feature is enabled. + type: Boolean + default: true + enable-popups: + description: A feature that enables or disables in app popups + variables: + cfr-popups-enabled: + description: When true, CFR popups will show + type: Boolean + default: true + in-app-messages-enabled: + description: | + Enables non-CFR in-app messaging surfaces. Currently includes: - Wallpaper onboarding bottom sheet - PWA onboarding ("Add to Home screen") dialog - "Open links in apps" banner + type: Boolean + default: true + fingerprinting-protection: + description: Control Fingerprinting Protection + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + enabled-normal: + description: | + Enables / disables fingerprinting protection in normal browsing mode. + type: Boolean + default: false + enabled-private: + description: | + Enables / disables fingerprinting protection in private browsing mode. + type: Boolean + default: true + fdlibm-math: + description: | + Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy + type: Boolean + default: false + overrides: + description: | + The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. + type: String + default: '' + firefox-jp-guide-default-site: + description: | + This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + fission: + description: The feature that controls whether fission is enabled or not in Gecko. + variables: + enabled: + description: | + Whether or not to enable fission. Fission is enabled when set to true. Fission is disabled when set to false. + type: Boolean + default: false + isolationStrategy: + description: | + The web content isolation strategy to use with fission. "0" means "isolate nothing", similar to non-fission behavior. "1" means "isolate everything", where every site-origin gets its own process. "2" means "isolate high value", Android-specific setting to only isolate sites considered "high value". + type: Int + default: 0 + shouldUseNimbus: + description: | + If true, the values for both SHIP and Fission set in this file apply. Otherwise, the values from modules/libpref/init/StaticPrefList.yaml apply. + type: Boolean + default: false + fx-suggest: + description: A feature that provides Firefox Suggest search suggestions. + variables: + boost-amp-wiki: + description: | + The feature boost wiki and AMP suggestions to the top of its group. + type: Boolean + default: false + enabled: + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. + type: Boolean + default: false + gecko-nimbus-validation: + description: Feature for validating Nimbus Gecko functionality + variables: + test-preference: + description: A test gecko preference + type: Option + default: null + gecko-pref: + pref: gecko.nimbus.test + branch: default + test-preference-2: + description: A second test gecko preference + type: Option + default: null + gecko-pref: + pref: gecko.nimbus.test.two + branch: user + glean: + description: A feature that provides server-side configurations for Glean metrics (aka Server Knobs). + variables: + delay-ping-lifetime-io: + description: Glean will delay io for ping lifetime metrics + type: Boolean + default: true + enable-event-timestamps: + description: Enables precise event timestamps for Glean events + type: Boolean + default: true + gleanMetricConfiguration: + description: Configuration for Glean Server Knobs + type: GleanServerKnobsConfiguration + default: + event_threshold: null + metrics_enabled: {} + pings_enabled: {} + ping-lifetime-max-time: + description: After what time to auto-flush + type: Int + default: 2000 + ping-lifetime-threshold: + description: Write count threshold when to auto-flush + type: Int + default: 1000 + allow-coenrollment: true + google-lens-integration: + description: A feature that enables Google Lens integration for users on Firefox on Android. + variables: + enabled: + description: If true, Google Lens integration is enabled. + type: Boolean + default: false + homepage-as-new-tab: + description: Enables homepage as a a new tab. + variables: + enabled: + description: | + Whether or not to enable homepage as a new tab + type: Boolean + default: false + homepage-customization: + description: Feature to enable Homepage Customization for users on Firefox on Android. + variables: + enabled: + description: If true, Homepage Customization is enabled. + type: Boolean + default: false + homepage-hide-frecent-top-sites: + description: Hides frecent top sites on the homepage. + variables: + enabled: + description: | + Whether or not to hide frecent top sites on the homepage. + type: Boolean + default: false + homepage-opening-screen-default: + description: Configure the default option for the homepage opening screen. + variables: + default-option: + description: The default option for the homepage opening screen. + type: OpeningScreenOption + default: homepage-four-hours + homepage-trending-recent-search: + description: Feature to show trending and recent searches on the Homepage Search for users on Firefox on Android. + variables: + enabled: + description: If true, trending and recent searches are shown on the Homepage Search. + type: Boolean + default: false + homepage-weather-widget: + description: Feature to enable Homepage Weather Widget for users on Firefox for Android. + variables: + enabled: + description: If true, Homepage Weather Widget is enabled. + type: Boolean + default: false + homescreen: + description: The homescreen that the user goes to when they press home or new tab. + variables: + sections-enabled: + description: This property provides a lookup table of whether or not the given section should be enabled. If the section is enabled, it should be toggleable in the settings screen, and on by default. + type: Map + default: + top-sites: true + jump-back-in: true + bookmarks: true + recent-explorations: true + pocket: true + pocket-sponsored-stories: true + synced-tabs: true + collections: true + privacy-report: true + homescreen-edge-to-edge-background: + description: | + Feature that sets an edge to edge background on the Home Screen if the user hasn't selected a custom wallpaper + variables: + enabled: + description: Enables the feature + type: Boolean + default: true + import-bookmarks: + description: A feature that lets users import bookmarks from another browser. + variables: + enabled: + description: If true, the import bookmarks feature will be enabled. + type: Boolean + default: true + ip-protection: + description: Feature to enable IP Protection (VPN) for users on Firefox on Android. + variables: + allowed-regions: + description: Country codes whose users are eligible for IP Protection. + type: List + default: + - AU + - AT + - BE + - BG + - CA + - CL + - CO + - DK + - FI + - FR + - DE + - IE + - IT + - JP + - MY + - MX + - NL + - NZ + - NO + - PL + - PT + - RO + - SG + - ZA + - ES + - SE + - CH + - TH + - GB + - US + data-limit-gigabyte: + description: Specifies the VPN data limit for unpaid users in GB (e.g. 50 GB). + type: Int + default: 50 + enabled: + description: If true, IP Protection feature is enabled. + type: Boolean + default: true + promo-deadline: + description: The final date for the promotion to end. This needs to be an ISO 8601 formatted date (i.e. YYYY-MM-DD). + type: String + default: 2026-08-31 + show-beta-badge: + description: If true, a BETA badge is shown next to the IP Protection entry in the settings list. + type: Boolean + default: true + show-onboarding-bottom-sheet: + description: If true, the IP Protection onboarding bottom sheet is shown to the user. + type: Boolean + default: true + isolated-content-processes: + description: Feature that controls content process isolation. + variables: + app-zygote-preloading: + description: | + Whether or not to enable app Zygote preloaded isolated content processes. + type: Boolean + default: false + enabled: + description: | + Whether or not to enable isolated content processes. + type: Boolean + default: false + javascript: + description: Enables Javascript Engine (Spidermonkey) features + variables: + parallelMarkingEnabled: + description: | + Enables or disables javascript.options.mem.gc_parallel_marking preference. + type: Boolean + default: false + juno-onboarding: + description: A feature that shows the onboarding flow. + variables: + cards: + description: Collection of user facing onboarding cards. + type: Map + default: + terms-of-service: + body: '' + card-type: terms-of-service + disqualifiers: + - NEVER + enabled: true + extra-data: + term-of-service-data: + subheader-one-text: nova_onboarding_tou_subtitle + line-one-text: nova_onboarding_tou_body_line_1 + line-one-link-text: nova_onboarding_tou_body_line_1_link_text + line-two-text: nova_onboarding_tou_body_line_2 + line-two-link-text: nova_onboarding_tou_body_line_2_link_text + line-three-text: nova_onboarding_tou_body_line_3 + line-three-link-text: nova_onboarding_tou_body_line_3_link_text + image-res: nova_onboarding_tou + ordering: 1 + prerequisites: + - ALWAYS + primary-button-label: nova_onboarding_continue_button + secondary-button-label: '' + title: onboarding_welcome_to_firefox + default-browser: + body: nova_onboarding_set_to_default_subtitle + card-type: default-browser + disqualifiers: + - NEVER + enabled: true + extra-data: null + image-res: nova_onboarding_set_to_default + ordering: 10 + prerequisites: + - ALWAYS + primary-button-label: nova_onboarding_set_to_default_button + secondary-button-label: nova_onboarding_negative_button + title: nova_onboarding_set_to_default_title_2 + marketing: + body: '' + card-type: marketing-data + disqualifiers: + - NEVER + enabled: true + extra-data: + marketing-data: + body-line-one-text: nova_onboarding_marketing_body_2 + body-line-one-link-text: nova_onboarding_marketing_body_link_text + image-res: nova_onboarding_marketing + ordering: 20 + prerequisites: + - ALWAYS + primary-button-label: nova_onboarding_continue_button + secondary-button-label: nova_onboarding_marketing_secondary_button_text + title: nova_onboarding_marketing_title + string-alias: OnboardingCardKey + conditions: + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + string-alias: ConditionName + lna-blocking: + description: Feature that allows blocking local network or device access. + variables: + block-insecure-contexts: + description: | + Whether or not LNA requests coming from insecure contexts should be blocked outright, without prompting the user for permission + type: Option + default: null + gecko-pref: + pref: network.lna.block_insecure_contexts + branch: default + block-trackers: + description: | + Whether or not to block trackers + type: Boolean + default: false + blocking: + description: | + Whether or not to block LNA requests + type: Boolean + default: false + enabled: + description: | + Whether or not to turn on local network / device access blocking + type: Boolean + default: false + longfox: + description: Flag to enable Longfox for users on Firefox Android. + variables: + enabled: + description: If true, users will see a CTA for launching Longfox on the home screen. + type: Boolean + default: false + marketing-onboarding-card: + description: A temporary feature to control the marketing onboarding card shown during the onboarding flow. + variables: + enabled: + description: If false, the marketing onboarding card will never be shown. + type: Boolean + default: true + media-notification-improvements: + description: Whether to show the media notification improvements + variables: + enabled: + description: enabled media notification improvements if true, else not enabled + type: Boolean + default: true + merino-client: + description: Feature to enable the Merino Client for users on Firefox on Android. + variables: + enabled: + description: If true, Merino Client is enabled. + type: Boolean + default: false + messaging: + description: | + The in-app messaging system. + variables: + $$experiment: + description: The only acceptable value for `MessageData#experiment`. This should not be set by experiment. + type: ExperimentSlug + default: '{experiment}' + string-alias: ExperimentSlug + $$surfaces: + description: | + A list available surfaces for this app. + + This should not be written to by experiments, and should be hidden to users. + type: List + default: + - homescreen + - notification + - survey + - microsurvey + string-alias: SurfaceName + actions: + description: A growable map of action URLs. + type: Map + default: + OPEN_URL: ://open + ENABLE_PRIVATE_BROWSING: ://enable_private_browsing + INSTALL_SEARCH_WIDGET: ://install_search_widget + MAKE_DEFAULT_BROWSER: ://make_default_browser + VIEW_BOOKMARKS: ://urls_bookmarks + VIEW_COLLECTIONS: ://home_collections + VIEW_HISTORY: ://urls_history + VIEW_HOMESCREEN: ://home + OPEN_SETTINGS_ACCESSIBILITY: ://settings_accessibility + OPEN_SETTINGS_ADDON_MANAGER: ://settings_addon_manager + OPEN_SETTINGS_AI_CONTROLS: ://settings_ai_controls + OPEN_SETTINGS_DELETE_BROWSING_DATA: ://settings_delete_browsing_data + OPEN_SETTINGS_LOGINS: ://settings_logins + OPEN_SETTINGS_NOTIFICATIONS: ://settings_notifications + OPEN_SETTINGS_MARKETING_NOTIFICATIONS: ://settings_marketing_notifications + OPEN_SETTINGS_PRIVACY: ://settings_privacy + OPEN_SETTINGS_SEARCH_ENGINE: ://settings_search_engine + OPEN_SETTINGS_TRACKING_PROTECTION: ://settings_tracking_protection + OPEN_SETTINGS_WALLPAPERS: ://settings_wallpapers + OPEN_SETTINGS_APP_ICON: ://settings_app_icon + OPEN_SETTINGS: ://settings + OPEN_SHARE_SHEET: ://share_sheet + OPEN_PROTECTIONS_DASHBOARD: ://protections_dashboard + TURN_ON_SYNC: ://turn_on_sync + string-alias: ActionName + message-under-experiment: + description: Deprecated in favor of `MessageData#experiment`. This will be removed in future releases. + type: Option + default: null + messages: + description: A growable collection of messages + type: Map + default: + default-browser: + title: default_browser_experiment_card_title + text: default_browser_experiment_card_text + surface: homescreen + action: MAKE_DEFAULT_BROWSER + trigger-if-all: + - USER_ESTABLISHED_INSTALL + - ANDROID_API_BELOW_29 + exclude-if-any: + - I_AM_DEFAULT_BROWSER + style: PERSISTENT + button-label: preferences_set_as_default_browser + default-browser-notification: + title: nimbus_notification_default_browser_title + text: nimbus_notification_default_browser_text + surface: notification + style: NOTIFICATION + trigger-if-all: + - DAY_3_AFTER_INSTALL + exclude-if-any: + - I_AM_DEFAULT_BROWSER + action: MAKE_DEFAULT_BROWSER + string-alias: MessageKey + notification-config: + description: Configuration of the notification worker for all notification messages. + type: NotificationConfig + default: + refresh-interval: 240 + on-control: + description: What should be displayed when a control message is selected. + type: ControlMessageBehavior + default: show-next-message + styles: + description: | + A map of styles to configure message appearance. + type: Map + default: + DEFAULT: + priority: 50 + max-display-count: 5 + SURVEY: + priority: 55 + max-display-count: 1 + PERSISTENT: + priority: 50 + max-display-count: 20 + WARNING: + priority: 60 + max-display-count: 10 + URGENT: + priority: 100 + max-display-count: 10 + NOTIFICATION: + priority: 50 + max-display-count: 1 + MICROSURVEY: + priority: 50 + max-display-count: 5 + string-alias: StyleName + triggers: + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + type: Map + default: + USER_ESTABLISHED_INSTALL: number_of_app_launches >=4 + ANDROID_API_BELOW_29: android_version < 29 + USER_RECENTLY_INSTALLED: days_since_install < 7 + USER_RECENTLY_UPDATED: days_since_update < 7 && days_since_install != days_since_update + USER_TIER_ONE_COUNTRY: ('US' in locale || 'GB' in locale || 'CA' in locale || 'DE' in locale || 'FR' in locale) + USER_EN_SPEAKER: '''en'' in locale' + USER_ES_SPEAKER: '''es'' in locale' + USER_DE_SPEAKER: '''de'' in locale' + USER_FR_SPEAKER: '''fr'' in locale' + DEVICE_ANDROID: os == 'Android' + DEVICE_IOS: os == 'iOS' + ALWAYS: 'true' + NEVER: 'false' + DAY_1_AFTER_INSTALL: days_since_install == 1 + DAY_2_AFTER_INSTALL: days_since_install == 2 + DAY_3_AFTER_INSTALL: days_since_install == 3 + DAY_4_AFTER_INSTALL: days_since_install == 4 + DAY_5_AFTER_INSTALL: days_since_install == 5 + MORE_THAN_24H_SINCE_INSTALLED_OR_UPDATED: days_since_update >= 1 + I_AM_DEFAULT_BROWSER: is_default_browser + I_AM_NOT_DEFAULT_BROWSER: is_default_browser == false + NOTIFICATIONS_ARE_ENABLED: are_notifications_enabled == true + NOTIFICATIONS_ARE_DISABLED: are_notifications_enabled == false + MARKETING_NOTIFICATIONS_ARE_ENABLED: are_marketing_notifications_enabled == true + MARKETING_NOTIFICATIONS_ARE_DISABLED: are_marketing_notifications_enabled == false + FUNNEL_PAID: adjust_campaign != '' + FUNNEL_ORGANIC: adjust_campaign == '' + INACTIVE_1_DAY: '''app_opened''|eventLastSeen(''Hours'') >= 24' + INACTIVE_2_DAYS: '''app_opened''|eventLastSeen(''Days'', 0) >= 2' + INACTIVE_3_DAYS: '''app_opened''|eventLastSeen(''Days'', 0) >= 3' + INACTIVE_4_DAYS: '''app_opened''|eventLastSeen(''Days'', 0) >= 4' + INACTIVE_5_DAYS: '''app_opened''|eventLastSeen(''Days'', 0) >= 5' + RECENTLY_PRINTED: '''print_tapped''|eventLastSeen(''Hours'') <= 24' + SECOND_HOMEPAGE_VIEW: '''home_screen_displayed''|eventSum(''Years'', 4, 0) >= 2' + PERFORMED_A_SEARCH_AGAIN_RECENTLY: '''performed_search''|eventSum(''Years'', 4, 0) >= 2 && ''performed_search''|eventLastSeen(''Minutes'') < 1' + FXA_CURRENTLY_SIGNED_IN: is_fxa_signed_in == true + FXA_MORE_THAN_1_DEVICE: fxa_connected_devices > 1 + FXA_SIGNED_IN: '''sync_auth.sign_in''|eventLastSeen(''Years'', 0) <= 4' + FXA_NOT_SIGNED_IN: '''sync_auth.sign_in''|eventLastSeen(''Years'', 0) > 4' + USER_INFREQUENT: '''app_opened''|eventCountNonZero(''Days'', 28) >= 1 && ''app_opened''|eventCountNonZero(''Days'', 28) < 7' + USER_CASUAL: '''app_opened''|eventCountNonZero(''Days'', 28) >= 7 && ''app_opened''|eventCountNonZero(''Days'', 28) < 14' + USER_REGULAR: '''app_opened''|eventCountNonZero(''Days'', 28) >= 14 && ''app_opened''|eventCountNonZero(''Days'', 28) < 21' + USER_CORE_ACTIVE: '''app_opened''|eventCountNonZero(''Days'', 28) >= 21' + LAUNCHED_ONCE_THIS_WEEK: '''app_opened''|eventSum(''Days'', 7) == 1' + string-alias: TriggerName + allow-coenrollment: true + microsurveys: + description: Feature for microsurveys. + variables: + enabled: + description: | + When the feature is enabled then microsurveys can be used. + type: Boolean + default: false + minimal-addressbar: + description: Show a smaller height bottom addressbar with just the URL. + variables: + at-bottom-while-entering-text: + description: | + Whether to show the smaller height bottom addressbar with just the URL when entering text in a website. + type: Boolean + default: false + native-share-sheet: + description: Feature to enable the Native Share Sheet for users on Firefox on Android. + variables: + enabled: + description: If true, Native Share Sheet is enabled. + type: Boolean + default: false + networking-happy-eyeballs: + description: Networking (Necko) Happy Eyeballs V3 configuration + variables: + connection-attempt-delay: + description: Time in ms between successive connection attempts + type: Option + default: null + gecko-pref: + pref: network.http.happy_eyeballs_connection_attempt_delay + branch: default + enabled: + description: Whether to enable the Happy Eyeballs v3 algorithm for connection establishment + type: Option + default: null + gecko-pref: + pref: network.http.happy_eyeballs_enabled + branch: default + resolution-delay: + description: Time in ms to wait after the first DNS response before starting connections + type: Option + default: null + gecko-pref: + pref: network.http.happy_eyeballs_resolution_delay + branch: default + networkingBannedPorts: + description: Networking (Necko) Banned Ports + variables: + bannedPortList: + description: A comma-separated list of ports that Firefox will refuse to connect to. These ports will be appended to nsIOService gBadPortList + type: String + default: '' + nimbus-is-ready: + description: | + A feature that provides the number of Nimbus is_ready events to send when Nimbus finishes launching. + variables: + event-count: + description: The number of events that should be sent. + type: Int + default: 1 + nimbus-qa-bool-default: + description: A feature for testing boolean pref-setting on the default branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-bool-default + branch: default + nimbus-qa-bool-user: + description: A feature for testing boolean pref-setting on the user branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-bool-user + branch: user + nimbus-qa-int-default: + description: A feature for testing int pref-setting on the default branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-int-default + branch: default + nimbus-qa-int-user: + description: A feature for testing int pref-setting on the user branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-int-user + branch: user + nimbus-qa-string-default: + description: A feature for testing string pref-setting on the default branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-string-default + branch: default + nimbus-qa-string-user: + description: A feature for testing string pref-setting on the user branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-string-user + branch: user + nimbus-system: + description: | + Configuration of the Nimbus System in Android. + variables: + refresh-interval-foreground: + description: | + The minimum interval in minutes between fetching experiment + recipes in the foreground. + type: Int + default: 60 + nimbus-validation: + description: A feature that does not correspond to an application feature suitable for showing that Nimbus is working. This should never be used in production. + variables: + settings-icon: + description: The drawable displayed in the app menu for Settings + type: String + default: mozac_ic_settings + settings-punctuation: + description: The emoji displayed in the Settings screen title. + type: String + default: '' + settings-title: + description: The title of displayed in the Settings screen and app menu. + type: Text + default: browser_menu_settings + oled-theme: + description: Feature to provide the OLED theme option for users on Firefox for Android. + variables: + enabled: + description: If true, the OLED theme option is shown. + type: Boolean + default: false + onboarding: + description: A feature that configures the new user onboarding page. Note that onboarding is a **first run** feature, and should only be modified by first run experiments. + variables: + order: + description: Determines the order of the onboarding page panels + type: List + default: + - themes + - toolbar-placement + - sync + - tcp + - privacy-notice + one-click-search: + description: Enable/disable the one click search feature. + variables: + enabled: + description: If true, the one click search will be enabled. + type: Boolean + default: false + pdf-viewer: + description: Feature for the PDF viewer tools for users on Firefox for Android. + variables: + android-ui-tools: + description: If true, the Android PDF UI tools are shown. + type: Boolean + default: false + pdfjs: + description: PDF.js features + variables: + download-button: + description: Download button + type: Boolean + default: true + open-in-app-button: + description: Open in app button + type: Boolean + default: true + pki: + description: Certificate verification configuration + variables: + certificateTransparencyMode: + description: | + What mode Certificate Transparency is in (0=disable, 1=telemetry only, 2=enforce). + type: Option + default: null + crliteChannel: + description: | + The channel from which CRLite filters will be installed. + type: Option + default: null + pqcrypto: + description: Control the use of post-quantum key exchange mechanisms in TLS and HTTP/3. + variables: + postQuantumKeyExchangeEnabled: + description: | + Toggles the security.tls.enable_kyber and network.http.http3.enable_kyber preferences. + type: Option + default: null + private-browsing-lock: + description: Allows enabling and disabling the private browsing mode lock via an authentication screen. + variables: + enabled: + description: | + Whether or not to enable private browsing mode lock. + type: Boolean + default: true + private-mode-and-stories-entry-point: + description: Feature to enable the Private Mode and Stories Entry Point Experiment. + variables: + enabled: + description: If true, Private Mode and Stories Entry Point Experiment is enabled. + type: Boolean + default: false + remote-search-configuration: + description: Feature to use search configurations from remote servers. + variables: + enabled: + description: | + Uses search configuration from remote servers . + type: Boolean + default: true + remote-tab-management: + description: | + Features that let users manage tabs on other devices that are connected to the same Mozilla account. + variables: + close-tabs-enabled: + description: | + Whether the feature to close synced tabs is enabled. When enabled, this device will allow other devices to close tabs that are open on this device, and show a "close" button for tabs that are currently open on other supported devices in the synced tabs tray. + type: Boolean + default: true + safe-browsing-real-time: + description: Control Safe Browsing real-time lookup and simulation. + variables: + feature-enabled: + description: If true, this feature is enabled and the below settings override the Gecko defaults. Otherwise, the Gecko defaults are used. + type: Boolean + default: false + global-cache-enabled: + description: Enables / disables the Safe Browsing Global Cache. + type: Boolean + default: false + real-time-enabled: + description: Enables / disables Safe Browsing real-time lookup. + type: Boolean + default: false + simulation-cache-ttl-sec: + description: Cache TTL in seconds for the real-time request simulator. + type: Int + default: 300 + simulation-enabled: + description: Enables / disables the real-time request simulator. + type: Boolean + default: false + simulation-hit-probability: + description: Hit probability for the real-time request simulator. + type: Int + default: 5 + simulation-negative-cache-enabled: + description: Enables / disables the negative cache for the real-time request simulator. + type: Boolean + default: false + simulation-negative-cache-ttl-sec: + description: Negative cache TTL in seconds for the real-time request simulator. + type: Int + default: 300 + safe-browsing-v5: + description: Control Safe Browsing V5. + variables: + enable-v5: + description: Enables / disables the SafeBrowsing V5 protocol. + type: Boolean + default: false + feature-enabled: + description: If true, this feature is enabled. Otherwise, we follow the SafeBrowsing V5 enabled pref. + type: Boolean + default: false + same-document-navigation-overrides-load-type: + description: Control whether the same document navigation overrides the load type. + variables: + enabled: + description: | + Overrides the loadType when it is a same document navigation + type: Boolean + default: false + force-disable-uri: + description: | + Disable overriding the loadType during same document navigation on the domain specified by this URI. + type: String + default: '' + search-extra-params: + description: A feature that provides additional args for search. + variables: + channel-id: + description: The channel Id param name with arg. + type: Map + default: {} + enabled: + description: If true, the feature is active. + type: Boolean + default: false + feature-enabler: + description: The feature enabler param name with arg, NOTE this map could be empty. + type: Map + default: {} + search-engine: + description: The search engine name. + type: String + default: '' + search-optimization-option: + description: Feature to enable the Search Optimization cards for users on Firefox on Android. + variables: + enabled: + description: If true, Search Optimization is enabled. + type: Boolean + default: false + show-flights-card: + description: If true, Search Optimization Flights cards are enabled. + type: Boolean + default: false + show-sports-card: + description: If true, Search Optimization Sports cards are enabled. + type: Boolean + default: false + show-stocks-card: + description: If true, Search Optimization Stock cards are enabled. + type: Boolean + default: false + sent-from-firefox: + description: A feature that allows the user to add a download firefox footer to a shared link. + variables: + download-link: + description: A store download link. + type: Text + default: '' + enabled: + description: If true, the feature is available for the user. + type: Boolean + default: false + show-snackbar: + description: If true, the user will see the snackbar after sharing a link, allowing quick navigation to settings. + type: Boolean + default: false + template-message: + description: A template for the shared message, supporting three placeholders. A shared link, the brand name and a store download link. + type: Text + default: '' + setup-checklist: + description: A feature on the home page that allows the user to track onboarding setup progress. + variables: + enabled: + description: If true, the setup checklist will be enabled. + type: Boolean + default: false + setup-checklist-type: + description: The collection used for the setup checklist. + type: SetupChecklistType + default: collection-1 + shake-to-summarize: + description: A feature that can summarize the content of a page when you shake the screen. + variables: + enabled: + description: If true, shake to summarize will be enabled + type: Boolean + default: true + splash-screen: + description: A feature that extends splash screen duration, allowing additional data fetching time for the app's initial run. + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + maximum_duration_ms: + description: The maximum amount of time in milliseconds the splashscreen will be visible while waiting for initialization calls to complete. + type: Int + default: 0 + off-train-onboarding: + description: If true, the fetched data will be applied and used during the session. + type: Boolean + default: false + suggest-shipped-domains: + description: Feature that suggests domains from the shipped domain list. + variables: + enabled: + description: | + Suggest domains from the shipped domain list. + type: Boolean + default: false + suppress-sponsored-top-sites: + description: Suppress sponsored top sites for new users for 14 days. + variables: + enabled: + description: If true, new users won’t see sponsored tiles for 14 days. + type: Boolean + default: false + tab-groups: + description: Control the visibility of the tab groups feature. + variables: + enabled: + description: | + Whether or not to enable the tab groups feature. + type: Boolean + default: true + tab-groups-drag-and-drop: + description: Control the visibility of drag and drop for tab groups. + variables: + enabled: + description: | + Whether or not to enable drag and drop for tab groups. + type: Boolean + default: true + tab-groups-live-reorder: + description: Control whether reorder happens live during a drag and drop action for Tab Groups. + variables: + enabled: + description: | + Whether or not to enable live reorder for tab groups drag and drop. + type: Boolean + default: false + tab-groups-onboarding: + description: Control the visibility of onboarding for tab groups. + variables: + enabled: + description: | + Whether or not to enable onboarding for tab groups. + type: Boolean + default: true + tab-management-enhancements: + description: Control the visibility of the tab management enhancements. + variables: + opening_animation_enabled: + description: Whether or not the Tab Manager opening animation is enabled. When enabled, a shared element transition will initiate, taking the currently-opened tab's thumbnail and shrinking it into its spot in the Tab Manager. + type: Boolean + default: false + tab-strip: + description: Enables tab strip. + variables: + allow-on-all-devices: + description: | + Experimental: When true, bypasses device restrictions and enables use on all devices. May cause instability or unexpected behavior. This still requires the feature to be `enabled`. + type: Boolean + default: false + enabled: + description: | + Whether or not to enable tab strip. + type: Boolean + default: true + terms-of-use-prompt: + description: Enables the terms of use prompt for users who have not accepted ToU + variables: + content-option: + description: Defines which content option should used for the prompt. + type: TermsOfUsePromptContentOption + default: value-0 + enable-drag-to-dismiss: + description: Whether to show a drag handle on the prompt and allows users to use it to dismiss the prompt. + type: Boolean + default: true + enabled: + description: When the feature is enabled then the prompt can show for users. + type: Boolean + default: false + max-display-count: + description: The maximum number of times to show the prompt. + type: Int + default: 2 + third-party-cookie-blocking: + description: Control third-party cookie blocking. + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + enabled-normal: + description: | + Enables / disables third-party cookie blocking in normal browsing mode. + type: Boolean + default: false + enabled-private: + description: | + Enables / disables third-party cookie blocking in private browsing mode. + type: Boolean + default: true + tracking-protection-experimentation: + description: Experimental controls for tracking protection behavior + variables: + defer-annotation-enabled: + description: Whether to defer tracking protection classification annotation until the data is being handled + type: Option + default: null + gecko-pref: + pref: privacy.trackingprotection.defer_annotation.enabled + branch: default + translations: + description: The feature that allows on-device translations of web content. + variables: + downloads-enabled: + description: | + Show the global language model download options entry point for translations. ('Download languages' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-lang-settings-enabled: + description: | + Show the global language options entry point for automatically translating. ('Automatic Translation' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-settings-enabled: + description: | + Show the global settings entry point within the translations feature. ('Translation Settings' on the page settings view.) 'page-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-site-settings-enabled: + description: | + Show the global never translate this site options entry point for site management. ('Never translate these sites' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + main-flow-browser-menu-enabled: + description: | + Show the browser menu entry point into the translations feature. ('Translate Page' on browser menu.) + type: Boolean + default: true + main-flow-toolbar-enabled: + description: | + Show the primary toolbar entry point into the translations feature. (Translations icon on URL toolbar.) + type: Boolean + default: true + page-settings-enabled: + description: | + Show the page settings entry point within the translations feature. (Gear icon on the translations main flow page.) 'main-flow-toolbar-enabled' or 'main-flow-browser-menu-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + uninstall-survey: + description: Feature that controls the visibility and handling of the uninstall survey app shortcut. + variables: + enabled: + description: If true, the uninstall survey shortcut is enabled and visible. + type: Boolean + default: false + universal-edge-to-edge-wallpapers: + description: | + Extends non-default homepage wallpapers edge-to-edge and adapts the toolbar, navigation bar and system bars to them. + variables: + enabled: + description: | + Whether or not to enable the universal edge-to-edge wallpaper treatment. + type: Boolean + default: false + user-characteristics: + description: A feature for control user characteristic data collection + variables: + currentVersion: + description: The current collection version of the user characteristics. + type: Int + default: 0 + voice-search-in-display-mode: + description: Controls whether the voice search entry point is shown in the display-mode browser toolbar. + variables: + enabled: + description: If true, voice search is shown in the display toolbar. + type: Boolean + default: false + webcompat-reporter-enhancements: + description: Feature to enable WebCompat Reporter enhancements for users on Firefox Android. + variables: + enabled: + description: If true, WebCompat Reporter enhancements is enabled. + type: Boolean + default: false +enums: + ControlMessageBehavior: + description: An enum to influence what should be displayed when a control message is selected. + variants: + show-next-message: + description: The next eligible message should be shown. + show-none: + description: The surface should show no message. + HomeScreenSection: + description: The identifiers for the sections of the homescreen. + variants: + bookmarks: + description: The sites the user has bookmarked. + collections: + description: The collections section of the homepage. + jump-back-in: + description: The tabs the user was looking immediately before being interrupted. + pocket: + description: The pocket section. This should only be available in the US. + pocket-sponsored-stories: + description: Subsection of the Pocket homescreen section which shows sponsored stories. + privacy-report: + description: The privacy report section showing trackers blocked. + recent-explorations: + description: The tab groups + synced-tabs: + description: The synced tabs section of the homepage. + top-sites: + description: The frecency and pinned sites. + MarketingCardVariant: + description: An enum to describe a marketing card variation. + variants: + default: + description: The default marketing card variation. + treatment-c: + description: The Treatment C marketing card variation. + MicrosurveyOrdering: + description: An enum to determine how to order the microsurvey answers. + variants: + pinned-randomized: + description: | + Answers with an ordering value greater than 0 are pinned to the top, in ascending order of that value. The remaining answers, with an ordering of 0, are shuffled below. E.g. 1 will be the first/top item, 2 will be next, followed by randomized 0s. + randomized: + description: The whole answer list is shuffled. Ordering values are ignored. + OnboardingCardType: + description: An enum to describe a type of card. + variants: + add-search-widget: + description: Allows user to add search widget to homescreen. + default-browser: + description: Allows user to set Firefox as the default browser. + marketing-data: + description: Allows user to opt out of marketing data collection. + notification-permission: + description: Allows user to enable notification permission. + sync-sign-in: + description: Allows user to sync with a Firefox account. + terms-of-service: + description: Page to display the terms of services. + toolbar-placement: + description: Allows user to choose the toolbar position. + OnboardingPanel: + description: The types of onboarding panels in the onboarding page + variants: + privacy-notice: + description: The onboarding panel where users can tap to view our privacy notice. + sync: + description: The onboarding panel where users can sign in to sync + tcp: + description: The onboarding panel where users can choose their total cookie protection settings + themes: + description: The themes onboarding panel where users pick themes + toolbar-placement: + description: The onboarding panel where users choose their toolbar placement (bottom or top) + OpeningScreenOption: + description: The types of different experiment branches for the opening screen. + variants: + homepage: + description: Uses the homepage as the opening screen. + homepage-four-hours: + description: Uses the homepage after four hours of inactivity as the opening screen. + last-tab: + description: Uses the last tab as the opening screen. + QueryParameterStrippingSection: + description: The identifiers for the options for the Query Parameter Stripping feature. + variants: + query-parameter-stripping: + description: An integer either 0 or 1 indicating if query parameter stripping should be enabled or disabled in normal mode. 0 for setting to be disabled, and 1 for enabling the setting. + query-parameter-stripping-allow-list: + description: An string separated by commas indicating the sites where should from query stripping should be exempted. + query-parameter-stripping-pmb: + description: An integer either 0 or 1 indicating if query parameter stripping should be enabled or disabled in private mode. 0 for setting to be disabled, and 1 for enabling the setting. + query-parameter-stripping-strip-list: + description: An string separated by commas indicating the list of query params to be stripped from URIs. This list will be merged with records coming from RemoteSettings. + SetupChecklistType: + description: An enum to represent the different experiment branches for the setup checklist. + variants: + collection-1: + description: The collection for the setup checklist that has 3 items. + collection-2: + description: The collection for the setup checklist that has 6 items. + SuggestionType: + description: The type of a Firefox Suggest search suggestion. + variants: + amp: + description: A Firefox Suggestion from adMarketplace. + ampMobile: + description: A firefox Suggestion from adMarketplace specifically for mobile. + wikipedia: + description: A Firefox Suggestion for a Wikipedia page. + TermsOfUsePromptContentOption: + description: | + Determines which predefined title and "learn more" strings are used for the Terms of Use prompt. + variants: + value-0: + description: | + Uses the current defaults: + - Title: "We've got an update" + - Learn more: "Please take a moment to review and accept. Learn more." + value-1: + description: | + Uses the following copy: + - Title: "Terms of Use" + - Learn more: "You can learn more here." + value-2: + description: | + Uses the following copy: + - Title: "A note from Firefox" + - Learn more: "You can learn more here." + ToolbarType: + description: An enum to describe a toolbar placement option. + variants: + toolbar-bottom: + description: Sets the toolbar placement on the bottom. + toolbar-top: + description: Sets the toolbar placement on the top. +objects: + CustomizationToolbarData: + description: An object to describe the placement of the toolbar. + fields: + image-res: + description: The resource id of toolbar placement image. + type: Image + default: ic_onboarding_customize_toolbar + label: + description: Display text for the toolbar placement option (e.g. "Top placement"). + type: Text + default: '' + toolbar-type: + description: The type of toolbar placement. + type: ToolbarType + default: toolbar-top + ExtraCardData: + description: Holds data for cards that require additional data, e.g. toolbar placement cards. + fields: + customization-toolbar-data: + description: | + An optional list of toolbar placements for the toolbar placement card. + type: List + default: [] + marketing-data: + description: | + An optional marketing data for the onboarding card. + type: Option + default: null + term-of-service-data: + description: | + An optional terms of service data for the onboarding card. + type: Option + default: null + GleanServerKnobsConfiguration: + description: A configuration object for Glean server knobs. + fields: + event_threshold: + description: The threshold of events that will be buffered before an events ping is collected and submitted. + type: Option + default: null + metrics_enabled: + description: A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric. + type: Map + default: {} + pings_enabled: + description: A map of ping names to booleans representing the state of the 'enabled' flag for that ping. + type: Map + default: {} + MarketingData: + description: An object to describe the marketing data onboarding card. + fields: + body-line-one-link-text: + description: The link text from line one of the body. + type: Text + default: '' + body-line-one-text: + description: The text for line one of the body. + type: Text + default: '' + body-line-three-text: + description: The text for line three of the body. + type: Text + default: '' + body-line-two-text: + description: The text for line two of the body. + type: Text + default: '' + marketing-card-variant: + description: Which marketing card variant to use. + type: MarketingCardVariant + default: default + MessageData: + description: | + An object to describe a message. It uses human readable strings to describe the triggers, action and style of the message as well as the text of the message and call to action. + fields: + action: + description: | + A URL of a page or a deeplink. This may have substitution variables in. + type: ActionName + default: OPEN_URL + action-params: + description: | + A string map containing query parameters that will be appended to the action URL. This is useful for opening URLs in tabs, or specifying that the tab should be private. The values may have substitutions, e.g. "url": "https://example.com/id={uuid}", "private": "true". + The params and their values are all determined downstream of the messaging component, by the embedding app's deeplink processing machinery. + type: Map + default: {} + button-label: + description: | + The text on the button. If no text is present, the whole message is clickable. + type: Option + default: null + exclude-if-any: + description: | + A list of strings corresponding to targeting expressions. The message will not be shown if any of the expressions are `true`. + type: List + default: [] + experiment: + description: The slug of the experiment that this message came from. + type: Option + default: null + is-control: + description: Indicates if this message is the control message, if true shouldn't be displayed + type: Boolean + default: false + microsurvey-config: + description: Optional configuration data for a microsurvey. + type: Option + default: null + style: + description: | + The style as described in a `StyleData` from the styles table. + type: StyleName + default: DEFAULT + surface: + description: The surface identifier for this message. + type: SurfaceName + default: homescreen + text: + description: The message text displayed to the user + type: Text + default: '' + title: + description: The title text displayed to the user + type: Option + default: null + trigger-if-all: + description: | + A list of strings corresponding to targeting expressions. The message will be shown if all expressions are `true`. + type: List + default: [] + MicrosurveyAnswer: + description: Attributes relating to microsurvey content. + fields: + ordering: + description: | + Used when answer-ordering-type is pinned-randomized to sequence answers with ordering values greater than 0 top to bottom. Answers with ordering values equal to 0 are shuffled below. E.g. 1 will be the first/top item, 2 will be next, followed by randomized 0s. + type: Int + default: 0 + text: + description: The text for the answer. + type: Text + default: '' + MicrosurveyConfig: + description: Attributes relating to microsurvey content. + fields: + answer-ordering-type: + description: The way answers are ordered. + type: MicrosurveyOrdering + default: randomized + answers: + description: The list of answers to present to the user e.g. "Satisfied, Dissatisfied...". + type: List + default: [] + icon: + description: The icon shown in the survey. + type: Option + default: null + max-number-lines: + description: The maximum number of lines allowed for the microsurvey text layout. + type: Int + default: 2 + utm-content: + description: Optional "utm_content" parameter for the privacy notice URL to specify the feature being surveyed. + type: Option + default: null + NotificationConfig: + description: Attributes controlling the global configuration of notification messages. + fields: + refresh-interval: + description: | + How often, in minutes, the notification message worker will wake up and check for new messages. + type: Int + default: 240 + OnboardingCardData: + description: An object to describe a user facing onboarding card. + fields: + body: + description: The message text displayed to the user. May contain linkable text. + type: Text + default: '' + card-type: + description: The type of the card. + type: OnboardingCardType + default: default-browser + disqualifiers: + description: | + A list of strings corresponding to targeting expressions. The card will not be shown if any expression is `true`. + type: List + default: + - NEVER + enabled: + description: If true, this card is shown to the user. + type: Boolean + default: true + extra-data: + description: Optional extra data for cards that require additional data. + type: Option + default: null + image-res: + description: The resource id of the image to be displayed. + type: Image + default: ic_onboarding_welcome + ordering: + description: Used to sequence the cards. + type: Int + default: 0 + prerequisites: + description: | + A list of strings corresponding to targeting expressions. The card will be shown if all expressions are `true` and if no expressions in the `disqualifiers` table are true, or if the `disqualifiers` table is empty. + type: List + default: + - ALWAYS + primary-button-label: + description: The text to display on the primary button. + type: Text + default: '' + secondary-button-label: + description: The text to display on the secondary button. + type: Text + default: '' + title: + description: The title text displayed to the user. + type: Text + default: '' + StyleData: + description: | + A group of properties (predominantly visual) to describe the style of the message. + fields: + max-display-count: + description: | + How many sessions will this message be shown to the user before it is expired. + type: Int + default: 5 + priority: + description: | + The importance of this message. 0 is not very important, 100 is very important. + type: Int + default: 50 + TermsOfServiceData: + description: An object to describe the terms of service onboarding card. + fields: + line-one-link-text: + description: The text for the link of line one. + type: Text + default: '' + line-one-link-url: + description: The url for the link of line one. + type: Text + default: '' + line-one-text: + description: The text for line one. + type: Text + default: '' + line-three-link-text: + description: The text for the link of line three. + type: Text + default: '' + line-three-text: + description: The text for line three. + type: Text + default: '' + line-two-link-text: + description: The text for the link of line two. + type: Text + default: '' + line-two-link-url: + description: The url for the link of line two. + type: Text + default: '' + line-two-text: + description: The text for line two. + type: Text + default: '' + subheader-one-text: + description: Optional text for the first subheader of the card. + type: Option + default: null + subheader-three-text: + description: Optional text for the third subheader of the card. + type: Option + default: null + subheader-two-text: + description: Optional text for the second subheader of the card. + type: Option + default: null diff --git a/experimenter/experimenter/features/manifests/fenix/v155.0.2/developer.fml.yaml b/experimenter/experimenter/features/manifests/fenix/v155.0.2/developer.fml.yaml new file mode 100644 index 0000000000..93817a911e --- /dev/null +++ b/experimenter/experimenter/features/manifests/fenix/v155.0.2/developer.fml.yaml @@ -0,0 +1,1746 @@ +version: 1.0.0 +about: + description: Nimbus Feature Manifest for Fenix (Firefox Android) +channels: +- developer +features: + add-shortcuts-improvement: + description: Feature to enable Add Shortcuts improvement for users on Firefox on Android. + variables: + enabled: + description: If true, Add Shortcuts improvement is enabled. + type: Boolean + default: true + ads-client-for-stories: + description: Feature to enable the Mozilla Ads Client support for Sponsored Stories for users on Firefox on Android. + variables: + enabled: + description: If true, Mozilla Ads Client support for Sponsored Stories is enabled. + type: Boolean + default: false + alternative-app-launcher-icon: + description: A feature that changes the app launcher icon background color. + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + reset-to-default: + description: | + If true use the default icon, if false use the alternative icon. This is required to 'reset' the icon for enrolled users once the initial experiment is complete. + type: Boolean + default: false + app-links: + description: Control behavior of app links handling in the browser. + variables: + show-new-prompt: + description: Whether to show the new AppLinksPromptFragment dialog when an app link is detected. If false, the old dialog is used. + type: Boolean + default: true + awesomebar-suggestion-provider: + description: Configuration for the Firefox Suggest awesomebar suggestion provider. + variables: + available-suggestion-types: + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + type: Map + default: + amp: true + ampMobile: false + wikipedia: true + baseline-fpp: + description: Control Baseline Fingerprinting Protection + variables: + enabled: + description: Enables / disables baseline fingerprinting protection. + type: Boolean + default: true + feat-enabled: + description: If true, the feature is active. + type: Boolean + default: false + overrides: + description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. + type: String + default: '' + collections-to-tab-groups-migration: + description: Feature to migrate Collections to Tab Groups for users on Firefox for Android. + variables: + hide-collections-ui: + description: If true, the Collections UI is hidden. + type: Boolean + default: false + continuous-onboarding: + description: | + Feature to enable the continuous onboarding flow. This feature reduces the number of upfront onboarding cards and distributes the cards and other prompts progressively over a number of days. + variables: + enabled: + description: If true, the feature is enabled. + type: Boolean + default: true + custom-review-prompt-ui: + description: Feature that controls the custom UI for review prompt. + variables: + enabled: + description: When enabled we show the custom review prompt UI. Otherwise we try to directly show the Play Store in-app review prompt. + type: Boolean + default: true + default-bottom-toolbar: + description: Default toolbar position for new users. + variables: + enabled: + description: | + Whether to default the toolbar position to bottom. + type: Boolean + default: false + default-browser-prompt: + description: Feature that controls when the default browser prompt is shown. + variables: + coldStartsBetweenPrompts: + description: The minimum number of cold starts between showing the prompt. + type: Option + default: 4 + daysBetweenPrompts: + description: The minimum number of days between showing the prompt. + type: Option + default: 14 + enabled: + description: Whether or not to enable the default browser prompt. + type: Boolean + default: true + maxPromptsShown: + description: The maximum number of times the prompt can shown to the user. + type: Option + default: 3 + default-expanded-toolbar: + description: Default expanded (bottom navigation) toolbar state for new users. + variables: + enabled: + description: | + Whether to default the expanded toolbar (bottom navigation bar with back/forward/share/bookmark/menu) to enabled. Only takes visible effect on tall, non-wide windows. + type: Boolean + default: false + doh: + description: Feature controlling DNS over HTTPS (DoH). + variables: + autoselect-enabled: + description: | + Controls the network.android_doh.autoselect_enabled pref and automatically chooses a DoH provider when Default Protection mode is selected. + type: Boolean + default: false + show-ui: + description: | + When `true`, include DoH settings in the settings UI. + type: Boolean + default: true + downloads-custom-location: + description: Feature to enable the custom download location for users on Firefox on Android. + variables: + enabled: + description: If true, custom download location is enabled. + type: Boolean + default: true + email-masks: + description: Feature to enable Email Mask for users on Firefox on Android. + variables: + enabled: + description: If true, Email Mask feature is enabled. + type: Boolean + default: true + enable-popups: + description: A feature that enables or disables in app popups + variables: + cfr-popups-enabled: + description: When true, CFR popups will show + type: Boolean + default: true + in-app-messages-enabled: + description: | + Enables non-CFR in-app messaging surfaces. Currently includes: - Wallpaper onboarding bottom sheet - PWA onboarding ("Add to Home screen") dialog - "Open links in apps" banner + type: Boolean + default: true + fingerprinting-protection: + description: Control Fingerprinting Protection + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + enabled-normal: + description: | + Enables / disables fingerprinting protection in normal browsing mode. + type: Boolean + default: false + enabled-private: + description: | + Enables / disables fingerprinting protection in private browsing mode. + type: Boolean + default: true + fdlibm-math: + description: | + Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy + type: Boolean + default: false + overrides: + description: | + The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. + type: String + default: '' + firefox-jp-guide-default-site: + description: | + This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: true + fission: + description: The feature that controls whether fission is enabled or not in Gecko. + variables: + enabled: + description: | + Whether or not to enable fission. Fission is enabled when set to true. Fission is disabled when set to false. + type: Boolean + default: false + isolationStrategy: + description: | + The web content isolation strategy to use with fission. "0" means "isolate nothing", similar to non-fission behavior. "1" means "isolate everything", where every site-origin gets its own process. "2" means "isolate high value", Android-specific setting to only isolate sites considered "high value". + type: Int + default: 2 + shouldUseNimbus: + description: | + If true, the values for both SHIP and Fission set in this file apply. Otherwise, the values from modules/libpref/init/StaticPrefList.yaml apply. + type: Boolean + default: false + fx-suggest: + description: A feature that provides Firefox Suggest search suggestions. + variables: + boost-amp-wiki: + description: | + The feature boost wiki and AMP suggestions to the top of its group. + type: Boolean + default: true + enabled: + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. + type: Boolean + default: true + gecko-nimbus-validation: + description: Feature for validating Nimbus Gecko functionality + variables: + test-preference: + description: A test gecko preference + type: Option + default: null + gecko-pref: + pref: gecko.nimbus.test + branch: default + test-preference-2: + description: A second test gecko preference + type: Option + default: null + gecko-pref: + pref: gecko.nimbus.test.two + branch: user + glean: + description: A feature that provides server-side configurations for Glean metrics (aka Server Knobs). + variables: + delay-ping-lifetime-io: + description: Glean will delay io for ping lifetime metrics + type: Boolean + default: true + enable-event-timestamps: + description: Enables precise event timestamps for Glean events + type: Boolean + default: true + gleanMetricConfiguration: + description: Configuration for Glean Server Knobs + type: GleanServerKnobsConfiguration + default: + event_threshold: null + metrics_enabled: {} + pings_enabled: {} + ping-lifetime-max-time: + description: After what time to auto-flush + type: Int + default: 2000 + ping-lifetime-threshold: + description: Write count threshold when to auto-flush + type: Int + default: 1000 + allow-coenrollment: true + google-lens-integration: + description: A feature that enables Google Lens integration for users on Firefox on Android. + variables: + enabled: + description: If true, Google Lens integration is enabled. + type: Boolean + default: true + homepage-as-new-tab: + description: Enables homepage as a a new tab. + variables: + enabled: + description: | + Whether or not to enable homepage as a new tab + type: Boolean + default: false + homepage-customization: + description: Feature to enable Homepage Customization for users on Firefox on Android. + variables: + enabled: + description: If true, Homepage Customization is enabled. + type: Boolean + default: false + homepage-hide-frecent-top-sites: + description: Hides frecent top sites on the homepage. + variables: + enabled: + description: | + Whether or not to hide frecent top sites on the homepage. + type: Boolean + default: false + homepage-opening-screen-default: + description: Configure the default option for the homepage opening screen. + variables: + default-option: + description: The default option for the homepage opening screen. + type: OpeningScreenOption + default: homepage-four-hours + homepage-trending-recent-search: + description: Feature to show trending and recent searches on the Homepage Search for users on Firefox on Android. + variables: + enabled: + description: If true, trending and recent searches are shown on the Homepage Search. + type: Boolean + default: true + homepage-weather-widget: + description: Feature to enable Homepage Weather Widget for users on Firefox for Android. + variables: + enabled: + description: If true, Homepage Weather Widget is enabled. + type: Boolean + default: false + homescreen: + description: The homescreen that the user goes to when they press home or new tab. + variables: + sections-enabled: + description: This property provides a lookup table of whether or not the given section should be enabled. If the section is enabled, it should be toggleable in the settings screen, and on by default. + type: Map + default: + top-sites: true + jump-back-in: true + bookmarks: true + recent-explorations: true + pocket: true + pocket-sponsored-stories: true + synced-tabs: true + collections: true + privacy-report: true + homescreen-edge-to-edge-background: + description: | + Feature that sets an edge to edge background on the Home Screen if the user hasn't selected a custom wallpaper + variables: + enabled: + description: Enables the feature + type: Boolean + default: true + import-bookmarks: + description: A feature that lets users import bookmarks from another browser. + variables: + enabled: + description: If true, the import bookmarks feature will be enabled. + type: Boolean + default: true + ip-protection: + description: Feature to enable IP Protection (VPN) for users on Firefox on Android. + variables: + allowed-regions: + description: Country codes whose users are eligible for IP Protection. + type: List + default: + - XX + data-limit-gigabyte: + description: Specifies the VPN data limit for unpaid users in GB (e.g. 50 GB). + type: Int + default: 50 + enabled: + description: If true, IP Protection feature is enabled. + type: Boolean + default: true + promo-deadline: + description: The final date for the promotion to end. This needs to be an ISO 8601 formatted date (i.e. YYYY-MM-DD). + type: String + default: 2026-08-31 + show-beta-badge: + description: If true, a BETA badge is shown next to the IP Protection entry in the settings list. + type: Boolean + default: true + show-onboarding-bottom-sheet: + description: If true, the IP Protection onboarding bottom sheet is shown to the user. + type: Boolean + default: true + isolated-content-processes: + description: Feature that controls content process isolation. + variables: + app-zygote-preloading: + description: | + Whether or not to enable app Zygote preloaded isolated content processes. + type: Boolean + default: false + enabled: + description: | + Whether or not to enable isolated content processes. + type: Boolean + default: false + javascript: + description: Enables Javascript Engine (Spidermonkey) features + variables: + parallelMarkingEnabled: + description: | + Enables or disables javascript.options.mem.gc_parallel_marking preference. + type: Boolean + default: false + juno-onboarding: + description: A feature that shows the onboarding flow. + variables: + cards: + description: Collection of user facing onboarding cards. + type: Map + default: + terms-of-service: + body: '' + card-type: terms-of-service + disqualifiers: + - NEVER + enabled: true + extra-data: + term-of-service-data: + subheader-one-text: nova_onboarding_tou_subtitle + line-one-text: nova_onboarding_tou_body_line_1 + line-one-link-text: nova_onboarding_tou_body_line_1_link_text + line-two-text: nova_onboarding_tou_body_line_2 + line-two-link-text: nova_onboarding_tou_body_line_2_link_text + line-three-text: nova_onboarding_tou_body_line_3 + line-three-link-text: nova_onboarding_tou_body_line_3_link_text + image-res: nova_onboarding_tou + ordering: 1 + prerequisites: + - ALWAYS + primary-button-label: nova_onboarding_continue_button + secondary-button-label: '' + title: onboarding_welcome_to_firefox + default-browser: + body: nova_onboarding_set_to_default_subtitle + card-type: default-browser + disqualifiers: + - NEVER + enabled: true + extra-data: null + image-res: nova_onboarding_set_to_default + ordering: 10 + prerequisites: + - ALWAYS + primary-button-label: nova_onboarding_set_to_default_button + secondary-button-label: nova_onboarding_negative_button + title: nova_onboarding_set_to_default_title_2 + marketing: + body: '' + card-type: marketing-data + disqualifiers: + - NEVER + enabled: true + extra-data: + marketing-data: + body-line-one-text: nova_onboarding_marketing_body_2 + body-line-one-link-text: nova_onboarding_marketing_body_link_text + image-res: nova_onboarding_marketing + ordering: 20 + prerequisites: + - ALWAYS + primary-button-label: nova_onboarding_continue_button + secondary-button-label: nova_onboarding_marketing_secondary_button_text + title: nova_onboarding_marketing_title + string-alias: OnboardingCardKey + conditions: + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + string-alias: ConditionName + lna-blocking: + description: Feature that allows blocking local network or device access. + variables: + block-insecure-contexts: + description: | + Whether or not LNA requests coming from insecure contexts should be blocked outright, without prompting the user for permission + type: Option + default: null + gecko-pref: + pref: network.lna.block_insecure_contexts + branch: default + block-trackers: + description: | + Whether or not to block trackers + type: Boolean + default: false + blocking: + description: | + Whether or not to block LNA requests + type: Boolean + default: false + enabled: + description: | + Whether or not to turn on local network / device access blocking + type: Boolean + default: false + longfox: + description: Flag to enable Longfox for users on Firefox Android. + variables: + enabled: + description: If true, users will see a CTA for launching Longfox on the home screen. + type: Boolean + default: true + marketing-onboarding-card: + description: A temporary feature to control the marketing onboarding card shown during the onboarding flow. + variables: + enabled: + description: If false, the marketing onboarding card will never be shown. + type: Boolean + default: true + media-notification-improvements: + description: Whether to show the media notification improvements + variables: + enabled: + description: enabled media notification improvements if true, else not enabled + type: Boolean + default: true + merino-client: + description: Feature to enable the Merino Client for users on Firefox on Android. + variables: + enabled: + description: If true, Merino Client is enabled. + type: Boolean + default: false + messaging: + description: | + The in-app messaging system. + variables: + $$experiment: + description: The only acceptable value for `MessageData#experiment`. This should not be set by experiment. + type: ExperimentSlug + default: '{experiment}' + string-alias: ExperimentSlug + $$surfaces: + description: | + A list available surfaces for this app. + + This should not be written to by experiments, and should be hidden to users. + type: List + default: + - homescreen + - notification + - survey + - microsurvey + string-alias: SurfaceName + actions: + description: A growable map of action URLs. + type: Map + default: + OPEN_URL: ://open + ENABLE_PRIVATE_BROWSING: ://enable_private_browsing + INSTALL_SEARCH_WIDGET: ://install_search_widget + MAKE_DEFAULT_BROWSER: ://make_default_browser + VIEW_BOOKMARKS: ://urls_bookmarks + VIEW_COLLECTIONS: ://home_collections + VIEW_HISTORY: ://urls_history + VIEW_HOMESCREEN: ://home + OPEN_SETTINGS_ACCESSIBILITY: ://settings_accessibility + OPEN_SETTINGS_ADDON_MANAGER: ://settings_addon_manager + OPEN_SETTINGS_AI_CONTROLS: ://settings_ai_controls + OPEN_SETTINGS_DELETE_BROWSING_DATA: ://settings_delete_browsing_data + OPEN_SETTINGS_LOGINS: ://settings_logins + OPEN_SETTINGS_NOTIFICATIONS: ://settings_notifications + OPEN_SETTINGS_MARKETING_NOTIFICATIONS: ://settings_marketing_notifications + OPEN_SETTINGS_PRIVACY: ://settings_privacy + OPEN_SETTINGS_SEARCH_ENGINE: ://settings_search_engine + OPEN_SETTINGS_TRACKING_PROTECTION: ://settings_tracking_protection + OPEN_SETTINGS_WALLPAPERS: ://settings_wallpapers + OPEN_SETTINGS_APP_ICON: ://settings_app_icon + OPEN_SETTINGS: ://settings + OPEN_SHARE_SHEET: ://share_sheet + OPEN_PROTECTIONS_DASHBOARD: ://protections_dashboard + TURN_ON_SYNC: ://turn_on_sync + string-alias: ActionName + message-under-experiment: + description: Deprecated in favor of `MessageData#experiment`. This will be removed in future releases. + type: Option + default: null + messages: + description: A growable collection of messages + type: Map + default: + default-browser: + title: default_browser_experiment_card_title + text: default_browser_experiment_card_text + surface: homescreen + action: MAKE_DEFAULT_BROWSER + trigger-if-all: + - USER_ESTABLISHED_INSTALL + - ANDROID_API_BELOW_29 + exclude-if-any: + - I_AM_DEFAULT_BROWSER + style: PERSISTENT + button-label: preferences_set_as_default_browser + default-browser-notification: + title: nimbus_notification_default_browser_title + text: nimbus_notification_default_browser_text + surface: notification + style: NOTIFICATION + trigger-if-all: + - DAY_3_AFTER_INSTALL + exclude-if-any: + - I_AM_DEFAULT_BROWSER + action: MAKE_DEFAULT_BROWSER + microsurvey-printing-example: + title: microsurvey_prompt_printing_title + text: microsurvey_survey_printing_title + surface: microsurvey + trigger-if-all: + - RECENTLY_PRINTED + style: MICROSURVEY + microsurvey-config: + utm-content: homepage + icon: ic_print + answers: + - text: likert_scale_option_1 + ordering: 0 + - text: likert_scale_option_2 + ordering: 1 + - text: likert_scale_option_3 + ordering: 2 + - text: likert_scale_option_4 + ordering: 3 + - text: likert_scale_option_5 + ordering: 4 + - text: likert_scale_option_6 + ordering: 5 + microsurvey-uninstall-survey: + title: microsurvey_uninstall_survey_title + text: microsurvey_uninstall_survey_title + surface: microsurvey + trigger-if-all: + - NEVER + style: MICROSURVEY + microsurvey-config: + utm-content: uninstall_shortcut + icon: ic_delete_black + answers: + - text: uninstall_survey_option_1_v2 + ordering: 0 + - text: uninstall_survey_option_2_v2 + ordering: 1 + - text: uninstall_survey_option_3_v2 + ordering: 2 + - text: uninstall_survey_option_4_v2 + ordering: 3 + - text: uninstall_survey_option_5_v2 + ordering: 4 + - text: uninstall_survey_option_6_v2 + ordering: 5 + string-alias: MessageKey + notification-config: + description: Configuration of the notification worker for all notification messages. + type: NotificationConfig + default: + refresh-interval: 120 + on-control: + description: What should be displayed when a control message is selected. + type: ControlMessageBehavior + default: show-next-message + styles: + description: | + A map of styles to configure message appearance. + type: Map + default: + DEFAULT: + priority: 50 + max-display-count: 100 + SURVEY: + priority: 55 + max-display-count: 1 + PERSISTENT: + priority: 50 + max-display-count: 20 + WARNING: + priority: 60 + max-display-count: 10 + URGENT: + priority: 100 + max-display-count: 10 + NOTIFICATION: + priority: 50 + max-display-count: 1 + MICROSURVEY: + priority: 50 + max-display-count: 5 + EXPIRES_QUICKLY: + priority: 100 + max-display-count: 1 + string-alias: StyleName + triggers: + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + type: Map + default: + USER_ESTABLISHED_INSTALL: number_of_app_launches >=4 + ANDROID_API_BELOW_29: android_version < 29 + USER_RECENTLY_INSTALLED: days_since_install < 7 + USER_RECENTLY_UPDATED: days_since_update < 7 && days_since_install != days_since_update + USER_TIER_ONE_COUNTRY: ('US' in locale || 'GB' in locale || 'CA' in locale || 'DE' in locale || 'FR' in locale) + USER_EN_SPEAKER: '''en'' in locale' + USER_ES_SPEAKER: '''es'' in locale' + USER_DE_SPEAKER: '''de'' in locale' + USER_FR_SPEAKER: '''fr'' in locale' + DEVICE_ANDROID: os == 'Android' + DEVICE_IOS: os == 'iOS' + ALWAYS: 'true' + NEVER: 'false' + DAY_1_AFTER_INSTALL: days_since_install == 1 + DAY_2_AFTER_INSTALL: days_since_install == 2 + DAY_3_AFTER_INSTALL: days_since_install == 3 + DAY_4_AFTER_INSTALL: days_since_install == 4 + DAY_5_AFTER_INSTALL: days_since_install == 5 + MORE_THAN_24H_SINCE_INSTALLED_OR_UPDATED: days_since_update >= 1 + I_AM_DEFAULT_BROWSER: is_default_browser + I_AM_NOT_DEFAULT_BROWSER: is_default_browser == false + NOTIFICATIONS_ARE_ENABLED: are_notifications_enabled == true + NOTIFICATIONS_ARE_DISABLED: are_notifications_enabled == false + MARKETING_NOTIFICATIONS_ARE_ENABLED: are_marketing_notifications_enabled == true + MARKETING_NOTIFICATIONS_ARE_DISABLED: are_marketing_notifications_enabled == false + FUNNEL_PAID: adjust_campaign != '' + FUNNEL_ORGANIC: adjust_campaign == '' + INACTIVE_1_DAY: '''app_opened''|eventLastSeen(''Hours'') >= 24' + INACTIVE_2_DAYS: '''app_opened''|eventLastSeen(''Days'', 0) >= 2' + INACTIVE_3_DAYS: '''app_opened''|eventLastSeen(''Days'', 0) >= 3' + INACTIVE_4_DAYS: '''app_opened''|eventLastSeen(''Days'', 0) >= 4' + INACTIVE_5_DAYS: '''app_opened''|eventLastSeen(''Days'', 0) >= 5' + RECENTLY_PRINTED: '''print_tapped''|eventLastSeen(''Hours'') <= 24' + SECOND_HOMEPAGE_VIEW: '''home_screen_displayed''|eventSum(''Years'', 4, 0) >= 2' + PERFORMED_A_SEARCH_AGAIN_RECENTLY: '''performed_search''|eventSum(''Years'', 4, 0) >= 2 && ''performed_search''|eventLastSeen(''Minutes'') < 1' + FXA_CURRENTLY_SIGNED_IN: is_fxa_signed_in == true + FXA_MORE_THAN_1_DEVICE: fxa_connected_devices > 1 + FXA_SIGNED_IN: '''sync_auth.sign_in''|eventLastSeen(''Years'', 0) <= 4' + FXA_NOT_SIGNED_IN: '''sync_auth.sign_in''|eventLastSeen(''Years'', 0) > 4' + USER_INFREQUENT: '''app_opened''|eventCountNonZero(''Days'', 28) >= 1 && ''app_opened''|eventCountNonZero(''Days'', 28) < 7' + USER_CASUAL: '''app_opened''|eventCountNonZero(''Days'', 28) >= 7 && ''app_opened''|eventCountNonZero(''Days'', 28) < 14' + USER_REGULAR: '''app_opened''|eventCountNonZero(''Days'', 28) >= 14 && ''app_opened''|eventCountNonZero(''Days'', 28) < 21' + USER_CORE_ACTIVE: '''app_opened''|eventCountNonZero(''Days'', 28) >= 21' + LAUNCHED_ONCE_THIS_WEEK: '''app_opened''|eventSum(''Days'', 7) == 1' + string-alias: TriggerName + allow-coenrollment: true + microsurveys: + description: Feature for microsurveys. + variables: + enabled: + description: | + When the feature is enabled then microsurveys can be used. + type: Boolean + default: false + minimal-addressbar: + description: Show a smaller height bottom addressbar with just the URL. + variables: + at-bottom-while-entering-text: + description: | + Whether to show the smaller height bottom addressbar with just the URL when entering text in a website. + type: Boolean + default: false + native-share-sheet: + description: Feature to enable the Native Share Sheet for users on Firefox on Android. + variables: + enabled: + description: If true, Native Share Sheet is enabled. + type: Boolean + default: true + networking-happy-eyeballs: + description: Networking (Necko) Happy Eyeballs V3 configuration + variables: + connection-attempt-delay: + description: Time in ms between successive connection attempts + type: Option + default: null + gecko-pref: + pref: network.http.happy_eyeballs_connection_attempt_delay + branch: default + enabled: + description: Whether to enable the Happy Eyeballs v3 algorithm for connection establishment + type: Option + default: null + gecko-pref: + pref: network.http.happy_eyeballs_enabled + branch: default + resolution-delay: + description: Time in ms to wait after the first DNS response before starting connections + type: Option + default: null + gecko-pref: + pref: network.http.happy_eyeballs_resolution_delay + branch: default + networkingBannedPorts: + description: Networking (Necko) Banned Ports + variables: + bannedPortList: + description: A comma-separated list of ports that Firefox will refuse to connect to. These ports will be appended to nsIOService gBadPortList + type: String + default: '' + nimbus-is-ready: + description: | + A feature that provides the number of Nimbus is_ready events to send when Nimbus finishes launching. + variables: + event-count: + description: The number of events that should be sent. + type: Int + default: 1 + nimbus-qa-bool-default: + description: A feature for testing boolean pref-setting on the default branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-bool-default + branch: default + nimbus-qa-bool-user: + description: A feature for testing boolean pref-setting on the user branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-bool-user + branch: user + nimbus-qa-int-default: + description: A feature for testing int pref-setting on the default branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-int-default + branch: default + nimbus-qa-int-user: + description: A feature for testing int pref-setting on the user branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-int-user + branch: user + nimbus-qa-string-default: + description: A feature for testing string pref-setting on the default branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-string-default + branch: default + nimbus-qa-string-user: + description: A feature for testing string pref-setting on the user branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-string-user + branch: user + nimbus-system: + description: | + Configuration of the Nimbus System in Android. + variables: + refresh-interval-foreground: + description: | + The minimum interval in minutes between fetching experiment + recipes in the foreground. + type: Int + default: 60 + nimbus-validation: + description: A feature that does not correspond to an application feature suitable for showing that Nimbus is working. This should never be used in production. + variables: + settings-icon: + description: The drawable displayed in the app menu for Settings + type: String + default: mozac_ic_settings + settings-punctuation: + description: The emoji displayed in the Settings screen title. + type: String + default: '' + settings-title: + description: The title of displayed in the Settings screen and app menu. + type: Text + default: browser_menu_settings + oled-theme: + description: Feature to provide the OLED theme option for users on Firefox for Android. + variables: + enabled: + description: If true, the OLED theme option is shown. + type: Boolean + default: false + onboarding: + description: A feature that configures the new user onboarding page. Note that onboarding is a **first run** feature, and should only be modified by first run experiments. + variables: + order: + description: Determines the order of the onboarding page panels + type: List + default: + - themes + - toolbar-placement + - sync + - tcp + - privacy-notice + one-click-search: + description: Enable/disable the one click search feature. + variables: + enabled: + description: If true, the one click search will be enabled. + type: Boolean + default: false + pdf-viewer: + description: Feature for the PDF viewer tools for users on Firefox for Android. + variables: + android-ui-tools: + description: If true, the Android PDF UI tools are shown. + type: Boolean + default: false + pdfjs: + description: PDF.js features + variables: + download-button: + description: Download button + type: Boolean + default: true + open-in-app-button: + description: Open in app button + type: Boolean + default: true + pki: + description: Certificate verification configuration + variables: + certificateTransparencyMode: + description: | + What mode Certificate Transparency is in (0=disable, 1=telemetry only, 2=enforce). + type: Option + default: null + crliteChannel: + description: | + The channel from which CRLite filters will be installed. + type: Option + default: null + pqcrypto: + description: Control the use of post-quantum key exchange mechanisms in TLS and HTTP/3. + variables: + postQuantumKeyExchangeEnabled: + description: | + Toggles the security.tls.enable_kyber and network.http.http3.enable_kyber preferences. + type: Option + default: null + private-browsing-lock: + description: Allows enabling and disabling the private browsing mode lock via an authentication screen. + variables: + enabled: + description: | + Whether or not to enable private browsing mode lock. + type: Boolean + default: true + private-mode-and-stories-entry-point: + description: Feature to enable the Private Mode and Stories Entry Point Experiment. + variables: + enabled: + description: If true, Private Mode and Stories Entry Point Experiment is enabled. + type: Boolean + default: true + remote-search-configuration: + description: Feature to use search configurations from remote servers. + variables: + enabled: + description: | + Uses search configuration from remote servers . + type: Boolean + default: true + remote-tab-management: + description: | + Features that let users manage tabs on other devices that are connected to the same Mozilla account. + variables: + close-tabs-enabled: + description: | + Whether the feature to close synced tabs is enabled. When enabled, this device will allow other devices to close tabs that are open on this device, and show a "close" button for tabs that are currently open on other supported devices in the synced tabs tray. + type: Boolean + default: true + safe-browsing-real-time: + description: Control Safe Browsing real-time lookup and simulation. + variables: + feature-enabled: + description: If true, this feature is enabled and the below settings override the Gecko defaults. Otherwise, the Gecko defaults are used. + type: Boolean + default: false + global-cache-enabled: + description: Enables / disables the Safe Browsing Global Cache. + type: Boolean + default: false + real-time-enabled: + description: Enables / disables Safe Browsing real-time lookup. + type: Boolean + default: false + simulation-cache-ttl-sec: + description: Cache TTL in seconds for the real-time request simulator. + type: Int + default: 300 + simulation-enabled: + description: Enables / disables the real-time request simulator. + type: Boolean + default: false + simulation-hit-probability: + description: Hit probability for the real-time request simulator. + type: Int + default: 5 + simulation-negative-cache-enabled: + description: Enables / disables the negative cache for the real-time request simulator. + type: Boolean + default: false + simulation-negative-cache-ttl-sec: + description: Negative cache TTL in seconds for the real-time request simulator. + type: Int + default: 300 + safe-browsing-v5: + description: Control Safe Browsing V5. + variables: + enable-v5: + description: Enables / disables the SafeBrowsing V5 protocol. + type: Boolean + default: false + feature-enabled: + description: If true, this feature is enabled. Otherwise, we follow the SafeBrowsing V5 enabled pref. + type: Boolean + default: false + same-document-navigation-overrides-load-type: + description: Control whether the same document navigation overrides the load type. + variables: + enabled: + description: | + Overrides the loadType when it is a same document navigation + type: Boolean + default: false + force-disable-uri: + description: | + Disable overriding the loadType during same document navigation on the domain specified by this URI. + type: String + default: '' + search-extra-params: + description: A feature that provides additional args for search. + variables: + channel-id: + description: The channel Id param name with arg. + type: Map + default: {} + enabled: + description: If true, the feature is active. + type: Boolean + default: false + feature-enabler: + description: The feature enabler param name with arg, NOTE this map could be empty. + type: Map + default: {} + search-engine: + description: The search engine name. + type: String + default: '' + search-optimization-option: + description: Feature to enable the Search Optimization cards for users on Firefox on Android. + variables: + enabled: + description: If true, Search Optimization is enabled. + type: Boolean + default: true + show-flights-card: + description: If true, Search Optimization Flights cards are enabled. + type: Boolean + default: true + show-sports-card: + description: If true, Search Optimization Sports cards are enabled. + type: Boolean + default: true + show-stocks-card: + description: If true, Search Optimization Stock cards are enabled. + type: Boolean + default: true + sent-from-firefox: + description: A feature that allows the user to add a download firefox footer to a shared link. + variables: + download-link: + description: A store download link. + type: Text + default: '[Download Link]' + enabled: + description: If true, the feature is available for the user. + type: Boolean + default: true + show-snackbar: + description: If true, the user will see the snackbar after sharing a link, allowing quick navigation to settings. + type: Boolean + default: true + template-message: + description: A template for the shared message, supporting three placeholders. A shared link, the brand name and a store download link. + type: Text + default: sent_from_firefox_template + setup-checklist: + description: A feature on the home page that allows the user to track onboarding setup progress. + variables: + enabled: + description: If true, the setup checklist will be enabled. + type: Boolean + default: false + setup-checklist-type: + description: The collection used for the setup checklist. + type: SetupChecklistType + default: collection-1 + shake-to-summarize: + description: A feature that can summarize the content of a page when you shake the screen. + variables: + enabled: + description: If true, shake to summarize will be enabled + type: Boolean + default: true + splash-screen: + description: A feature that extends splash screen duration, allowing additional data fetching time for the app's initial run. + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + maximum_duration_ms: + description: The maximum amount of time in milliseconds the splashscreen will be visible while waiting for initialization calls to complete. + type: Int + default: 0 + off-train-onboarding: + description: If true, the fetched data will be applied and used during the session. + type: Boolean + default: false + suggest-shipped-domains: + description: Feature that suggests domains from the shipped domain list. + variables: + enabled: + description: | + Suggest domains from the shipped domain list. + type: Boolean + default: false + suppress-sponsored-top-sites: + description: Suppress sponsored top sites for new users for 14 days. + variables: + enabled: + description: If true, new users won’t see sponsored tiles for 14 days. + type: Boolean + default: false + tab-groups: + description: Control the visibility of the tab groups feature. + variables: + enabled: + description: | + Whether or not to enable the tab groups feature. + type: Boolean + default: false + tab-groups-drag-and-drop: + description: Control the visibility of drag and drop for tab groups. + variables: + enabled: + description: | + Whether or not to enable drag and drop for tab groups. + type: Boolean + default: false + tab-groups-live-reorder: + description: Control whether reorder happens live during a drag and drop action for Tab Groups. + variables: + enabled: + description: | + Whether or not to enable live reorder for tab groups drag and drop. + type: Boolean + default: false + tab-groups-onboarding: + description: Control the visibility of onboarding for tab groups. + variables: + enabled: + description: | + Whether or not to enable onboarding for tab groups. + type: Boolean + default: true + tab-management-enhancements: + description: Control the visibility of the tab management enhancements. + variables: + opening_animation_enabled: + description: Whether or not the Tab Manager opening animation is enabled. When enabled, a shared element transition will initiate, taking the currently-opened tab's thumbnail and shrinking it into its spot in the Tab Manager. + type: Boolean + default: false + tab-strip: + description: Enables tab strip. + variables: + allow-on-all-devices: + description: | + Experimental: When true, bypasses device restrictions and enables use on all devices. May cause instability or unexpected behavior. This still requires the feature to be `enabled`. + type: Boolean + default: false + enabled: + description: | + Whether or not to enable tab strip. + type: Boolean + default: true + terms-of-use-prompt: + description: Enables the terms of use prompt for users who have not accepted ToU + variables: + content-option: + description: Defines which content option should used for the prompt. + type: TermsOfUsePromptContentOption + default: value-0 + enable-drag-to-dismiss: + description: Whether to show a drag handle on the prompt and allows users to use it to dismiss the prompt. + type: Boolean + default: true + enabled: + description: When the feature is enabled then the prompt can show for users. + type: Boolean + default: false + max-display-count: + description: The maximum number of times to show the prompt. + type: Int + default: 2 + third-party-cookie-blocking: + description: Control third-party cookie blocking. + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + enabled-normal: + description: | + Enables / disables third-party cookie blocking in normal browsing mode. + type: Boolean + default: false + enabled-private: + description: | + Enables / disables third-party cookie blocking in private browsing mode. + type: Boolean + default: true + tracking-protection-experimentation: + description: Experimental controls for tracking protection behavior + variables: + defer-annotation-enabled: + description: Whether to defer tracking protection classification annotation until the data is being handled + type: Option + default: null + gecko-pref: + pref: privacy.trackingprotection.defer_annotation.enabled + branch: default + translations: + description: The feature that allows on-device translations of web content. + variables: + downloads-enabled: + description: | + Show the global language model download options entry point for translations. ('Download languages' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-lang-settings-enabled: + description: | + Show the global language options entry point for automatically translating. ('Automatic Translation' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-settings-enabled: + description: | + Show the global settings entry point within the translations feature. ('Translation Settings' on the page settings view.) 'page-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-site-settings-enabled: + description: | + Show the global never translate this site options entry point for site management. ('Never translate these sites' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + main-flow-browser-menu-enabled: + description: | + Show the browser menu entry point into the translations feature. ('Translate Page' on browser menu.) + type: Boolean + default: true + main-flow-toolbar-enabled: + description: | + Show the primary toolbar entry point into the translations feature. (Translations icon on URL toolbar.) + type: Boolean + default: true + page-settings-enabled: + description: | + Show the page settings entry point within the translations feature. (Gear icon on the translations main flow page.) 'main-flow-toolbar-enabled' or 'main-flow-browser-menu-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + uninstall-survey: + description: Feature that controls the visibility and handling of the uninstall survey app shortcut. + variables: + enabled: + description: If true, the uninstall survey shortcut is enabled and visible. + type: Boolean + default: true + universal-edge-to-edge-wallpapers: + description: | + Extends non-default homepage wallpapers edge-to-edge and adapts the toolbar, navigation bar and system bars to them. + variables: + enabled: + description: | + Whether or not to enable the universal edge-to-edge wallpaper treatment. + type: Boolean + default: false + user-characteristics: + description: A feature for control user characteristic data collection + variables: + currentVersion: + description: The current collection version of the user characteristics. + type: Int + default: 0 + voice-search-in-display-mode: + description: Controls whether the voice search entry point is shown in the display-mode browser toolbar. + variables: + enabled: + description: If true, voice search is shown in the display toolbar. + type: Boolean + default: true + webcompat-reporter-enhancements: + description: Feature to enable WebCompat Reporter enhancements for users on Firefox Android. + variables: + enabled: + description: If true, WebCompat Reporter enhancements is enabled. + type: Boolean + default: true +enums: + ControlMessageBehavior: + description: An enum to influence what should be displayed when a control message is selected. + variants: + show-next-message: + description: The next eligible message should be shown. + show-none: + description: The surface should show no message. + HomeScreenSection: + description: The identifiers for the sections of the homescreen. + variants: + bookmarks: + description: The sites the user has bookmarked. + collections: + description: The collections section of the homepage. + jump-back-in: + description: The tabs the user was looking immediately before being interrupted. + pocket: + description: The pocket section. This should only be available in the US. + pocket-sponsored-stories: + description: Subsection of the Pocket homescreen section which shows sponsored stories. + privacy-report: + description: The privacy report section showing trackers blocked. + recent-explorations: + description: The tab groups + synced-tabs: + description: The synced tabs section of the homepage. + top-sites: + description: The frecency and pinned sites. + MarketingCardVariant: + description: An enum to describe a marketing card variation. + variants: + default: + description: The default marketing card variation. + treatment-c: + description: The Treatment C marketing card variation. + MicrosurveyOrdering: + description: An enum to determine how to order the microsurvey answers. + variants: + pinned-randomized: + description: | + Answers with an ordering value greater than 0 are pinned to the top, in ascending order of that value. The remaining answers, with an ordering of 0, are shuffled below. E.g. 1 will be the first/top item, 2 will be next, followed by randomized 0s. + randomized: + description: The whole answer list is shuffled. Ordering values are ignored. + OnboardingCardType: + description: An enum to describe a type of card. + variants: + add-search-widget: + description: Allows user to add search widget to homescreen. + default-browser: + description: Allows user to set Firefox as the default browser. + marketing-data: + description: Allows user to opt out of marketing data collection. + notification-permission: + description: Allows user to enable notification permission. + sync-sign-in: + description: Allows user to sync with a Firefox account. + terms-of-service: + description: Page to display the terms of services. + toolbar-placement: + description: Allows user to choose the toolbar position. + OnboardingPanel: + description: The types of onboarding panels in the onboarding page + variants: + privacy-notice: + description: The onboarding panel where users can tap to view our privacy notice. + sync: + description: The onboarding panel where users can sign in to sync + tcp: + description: The onboarding panel where users can choose their total cookie protection settings + themes: + description: The themes onboarding panel where users pick themes + toolbar-placement: + description: The onboarding panel where users choose their toolbar placement (bottom or top) + OpeningScreenOption: + description: The types of different experiment branches for the opening screen. + variants: + homepage: + description: Uses the homepage as the opening screen. + homepage-four-hours: + description: Uses the homepage after four hours of inactivity as the opening screen. + last-tab: + description: Uses the last tab as the opening screen. + QueryParameterStrippingSection: + description: The identifiers for the options for the Query Parameter Stripping feature. + variants: + query-parameter-stripping: + description: An integer either 0 or 1 indicating if query parameter stripping should be enabled or disabled in normal mode. 0 for setting to be disabled, and 1 for enabling the setting. + query-parameter-stripping-allow-list: + description: An string separated by commas indicating the sites where should from query stripping should be exempted. + query-parameter-stripping-pmb: + description: An integer either 0 or 1 indicating if query parameter stripping should be enabled or disabled in private mode. 0 for setting to be disabled, and 1 for enabling the setting. + query-parameter-stripping-strip-list: + description: An string separated by commas indicating the list of query params to be stripped from URIs. This list will be merged with records coming from RemoteSettings. + SetupChecklistType: + description: An enum to represent the different experiment branches for the setup checklist. + variants: + collection-1: + description: The collection for the setup checklist that has 3 items. + collection-2: + description: The collection for the setup checklist that has 6 items. + SuggestionType: + description: The type of a Firefox Suggest search suggestion. + variants: + amp: + description: A Firefox Suggestion from adMarketplace. + ampMobile: + description: A firefox Suggestion from adMarketplace specifically for mobile. + wikipedia: + description: A Firefox Suggestion for a Wikipedia page. + TermsOfUsePromptContentOption: + description: | + Determines which predefined title and "learn more" strings are used for the Terms of Use prompt. + variants: + value-0: + description: | + Uses the current defaults: + - Title: "We've got an update" + - Learn more: "Please take a moment to review and accept. Learn more." + value-1: + description: | + Uses the following copy: + - Title: "Terms of Use" + - Learn more: "You can learn more here." + value-2: + description: | + Uses the following copy: + - Title: "A note from Firefox" + - Learn more: "You can learn more here." + ToolbarType: + description: An enum to describe a toolbar placement option. + variants: + toolbar-bottom: + description: Sets the toolbar placement on the bottom. + toolbar-top: + description: Sets the toolbar placement on the top. +objects: + CustomizationToolbarData: + description: An object to describe the placement of the toolbar. + fields: + image-res: + description: The resource id of toolbar placement image. + type: Image + default: ic_onboarding_customize_toolbar + label: + description: Display text for the toolbar placement option (e.g. "Top placement"). + type: Text + default: '' + toolbar-type: + description: The type of toolbar placement. + type: ToolbarType + default: toolbar-top + ExtraCardData: + description: Holds data for cards that require additional data, e.g. toolbar placement cards. + fields: + customization-toolbar-data: + description: | + An optional list of toolbar placements for the toolbar placement card. + type: List + default: [] + marketing-data: + description: | + An optional marketing data for the onboarding card. + type: Option + default: null + term-of-service-data: + description: | + An optional terms of service data for the onboarding card. + type: Option + default: null + GleanServerKnobsConfiguration: + description: A configuration object for Glean server knobs. + fields: + event_threshold: + description: The threshold of events that will be buffered before an events ping is collected and submitted. + type: Option + default: null + metrics_enabled: + description: A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric. + type: Map + default: {} + pings_enabled: + description: A map of ping names to booleans representing the state of the 'enabled' flag for that ping. + type: Map + default: {} + MarketingData: + description: An object to describe the marketing data onboarding card. + fields: + body-line-one-link-text: + description: The link text from line one of the body. + type: Text + default: '' + body-line-one-text: + description: The text for line one of the body. + type: Text + default: '' + body-line-three-text: + description: The text for line three of the body. + type: Text + default: '' + body-line-two-text: + description: The text for line two of the body. + type: Text + default: '' + marketing-card-variant: + description: Which marketing card variant to use. + type: MarketingCardVariant + default: default + MessageData: + description: | + An object to describe a message. It uses human readable strings to describe the triggers, action and style of the message as well as the text of the message and call to action. + fields: + action: + description: | + A URL of a page or a deeplink. This may have substitution variables in. + type: ActionName + default: OPEN_URL + action-params: + description: | + A string map containing query parameters that will be appended to the action URL. This is useful for opening URLs in tabs, or specifying that the tab should be private. The values may have substitutions, e.g. "url": "https://example.com/id={uuid}", "private": "true". + The params and their values are all determined downstream of the messaging component, by the embedding app's deeplink processing machinery. + type: Map + default: {} + button-label: + description: | + The text on the button. If no text is present, the whole message is clickable. + type: Option + default: null + exclude-if-any: + description: | + A list of strings corresponding to targeting expressions. The message will not be shown if any of the expressions are `true`. + type: List + default: [] + experiment: + description: The slug of the experiment that this message came from. + type: Option + default: null + is-control: + description: Indicates if this message is the control message, if true shouldn't be displayed + type: Boolean + default: false + microsurvey-config: + description: Optional configuration data for a microsurvey. + type: Option + default: null + style: + description: | + The style as described in a `StyleData` from the styles table. + type: StyleName + default: DEFAULT + surface: + description: The surface identifier for this message. + type: SurfaceName + default: homescreen + text: + description: The message text displayed to the user + type: Text + default: '' + title: + description: The title text displayed to the user + type: Option + default: null + trigger-if-all: + description: | + A list of strings corresponding to targeting expressions. The message will be shown if all expressions are `true`. + type: List + default: [] + MicrosurveyAnswer: + description: Attributes relating to microsurvey content. + fields: + ordering: + description: | + Used when answer-ordering-type is pinned-randomized to sequence answers with ordering values greater than 0 top to bottom. Answers with ordering values equal to 0 are shuffled below. E.g. 1 will be the first/top item, 2 will be next, followed by randomized 0s. + type: Int + default: 0 + text: + description: The text for the answer. + type: Text + default: '' + MicrosurveyConfig: + description: Attributes relating to microsurvey content. + fields: + answer-ordering-type: + description: The way answers are ordered. + type: MicrosurveyOrdering + default: randomized + answers: + description: The list of answers to present to the user e.g. "Satisfied, Dissatisfied...". + type: List + default: [] + icon: + description: The icon shown in the survey. + type: Option + default: null + max-number-lines: + description: The maximum number of lines allowed for the microsurvey text layout. + type: Int + default: 2 + utm-content: + description: Optional "utm_content" parameter for the privacy notice URL to specify the feature being surveyed. + type: Option + default: null + NotificationConfig: + description: Attributes controlling the global configuration of notification messages. + fields: + refresh-interval: + description: | + How often, in minutes, the notification message worker will wake up and check for new messages. + type: Int + default: 240 + OnboardingCardData: + description: An object to describe a user facing onboarding card. + fields: + body: + description: The message text displayed to the user. May contain linkable text. + type: Text + default: '' + card-type: + description: The type of the card. + type: OnboardingCardType + default: default-browser + disqualifiers: + description: | + A list of strings corresponding to targeting expressions. The card will not be shown if any expression is `true`. + type: List + default: + - NEVER + enabled: + description: If true, this card is shown to the user. + type: Boolean + default: true + extra-data: + description: Optional extra data for cards that require additional data. + type: Option + default: null + image-res: + description: The resource id of the image to be displayed. + type: Image + default: ic_onboarding_welcome + ordering: + description: Used to sequence the cards. + type: Int + default: 0 + prerequisites: + description: | + A list of strings corresponding to targeting expressions. The card will be shown if all expressions are `true` and if no expressions in the `disqualifiers` table are true, or if the `disqualifiers` table is empty. + type: List + default: + - ALWAYS + primary-button-label: + description: The text to display on the primary button. + type: Text + default: '' + secondary-button-label: + description: The text to display on the secondary button. + type: Text + default: '' + title: + description: The title text displayed to the user. + type: Text + default: '' + StyleData: + description: | + A group of properties (predominantly visual) to describe the style of the message. + fields: + max-display-count: + description: | + How many sessions will this message be shown to the user before it is expired. + type: Int + default: 5 + priority: + description: | + The importance of this message. 0 is not very important, 100 is very important. + type: Int + default: 50 + TermsOfServiceData: + description: An object to describe the terms of service onboarding card. + fields: + line-one-link-text: + description: The text for the link of line one. + type: Text + default: '' + line-one-link-url: + description: The url for the link of line one. + type: Text + default: '' + line-one-text: + description: The text for line one. + type: Text + default: '' + line-three-link-text: + description: The text for the link of line three. + type: Text + default: '' + line-three-text: + description: The text for line three. + type: Text + default: '' + line-two-link-text: + description: The text for the link of line two. + type: Text + default: '' + line-two-link-url: + description: The url for the link of line two. + type: Text + default: '' + line-two-text: + description: The text for line two. + type: Text + default: '' + subheader-one-text: + description: Optional text for the first subheader of the card. + type: Option + default: null + subheader-three-text: + description: Optional text for the third subheader of the card. + type: Option + default: null + subheader-two-text: + description: Optional text for the second subheader of the card. + type: Option + default: null diff --git a/experimenter/experimenter/features/manifests/fenix/v155.0.2/experimenter.yaml b/experimenter/experimenter/features/manifests/fenix/v155.0.2/experimenter.yaml new file mode 100644 index 0000000000..851882187e --- /dev/null +++ b/experimenter/experimenter/features/manifests/fenix/v155.0.2/experimenter.yaml @@ -0,0 +1,1097 @@ +add-shortcuts-improvement: + description: Feature to enable Add Shortcuts improvement for users on Firefox on Android. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, Add Shortcuts improvement is enabled. +ads-client-for-stories: + description: Feature to enable the Mozilla Ads Client support for Sponsored Stories for users on Firefox on Android. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, Mozilla Ads Client support for Sponsored Stories is enabled. +alternative-app-launcher-icon: + description: A feature that changes the app launcher icon background color. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, the feature is active. + reset-to-default: + type: boolean + description: | + If true use the default icon, if false use the alternative icon. This is required to 'reset' the icon for enrolled users once the initial experiment is complete. +app-links: + description: Control behavior of app links handling in the browser. + hasExposure: true + exposureDescription: '' + variables: + show-new-prompt: + type: boolean + description: Whether to show the new AppLinksPromptFragment dialog when an app link is detected. If false, the old dialog is used. +awesomebar-suggestion-provider: + description: Configuration for the Firefox Suggest awesomebar suggestion provider. + hasExposure: true + exposureDescription: '' + variables: + available-suggestion-types: + type: json + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. +baseline-fpp: + description: Control Baseline Fingerprinting Protection + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: Enables / disables baseline fingerprinting protection. + feat-enabled: + type: boolean + description: If true, the feature is active. + overrides: + type: string + description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. +collections-to-tab-groups-migration: + description: Feature to migrate Collections to Tab Groups for users on Firefox for Android. + hasExposure: true + exposureDescription: '' + variables: + hide-collections-ui: + type: boolean + description: If true, the Collections UI is hidden. +continuous-onboarding: + description: | + Feature to enable the continuous onboarding flow. This feature reduces the number of upfront onboarding cards and distributes the cards and other prompts progressively over a number of days. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, the feature is enabled. +custom-review-prompt-ui: + description: Feature that controls the custom UI for review prompt. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: When enabled we show the custom review prompt UI. Otherwise we try to directly show the Play Store in-app review prompt. +default-bottom-toolbar: + description: Default toolbar position for new users. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether to default the toolbar position to bottom. +default-browser-prompt: + description: Feature that controls when the default browser prompt is shown. + hasExposure: true + exposureDescription: '' + variables: + coldStartsBetweenPrompts: + type: int + description: The minimum number of cold starts between showing the prompt. + daysBetweenPrompts: + type: int + description: The minimum number of days between showing the prompt. + enabled: + type: boolean + description: Whether or not to enable the default browser prompt. + maxPromptsShown: + type: int + description: The maximum number of times the prompt can shown to the user. +default-expanded-toolbar: + description: Default expanded (bottom navigation) toolbar state for new users. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether to default the expanded toolbar (bottom navigation bar with back/forward/share/bookmark/menu) to enabled. Only takes visible effect on tall, non-wide windows. +doh: + description: Feature controlling DNS over HTTPS (DoH). + hasExposure: true + exposureDescription: '' + variables: + autoselect-enabled: + type: boolean + description: | + Controls the network.android_doh.autoselect_enabled pref and automatically chooses a DoH provider when Default Protection mode is selected. + show-ui: + type: boolean + description: | + When `true`, include DoH settings in the settings UI. +downloads-custom-location: + description: Feature to enable the custom download location for users on Firefox on Android. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, custom download location is enabled. +email-masks: + description: Feature to enable Email Mask for users on Firefox on Android. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, Email Mask feature is enabled. +enable-popups: + description: A feature that enables or disables in app popups + hasExposure: true + exposureDescription: '' + variables: + cfr-popups-enabled: + type: boolean + description: When true, CFR popups will show + in-app-messages-enabled: + type: boolean + description: | + Enables non-CFR in-app messaging surfaces. Currently includes: - Wallpaper onboarding bottom sheet - PWA onboarding ("Add to Home screen") dialog - "Open links in apps" banner +fingerprinting-protection: + description: Control Fingerprinting Protection + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, the feature is active. + enabled-normal: + type: boolean + description: | + Enables / disables fingerprinting protection in normal browsing mode. + enabled-private: + type: boolean + description: | + Enables / disables fingerprinting protection in private browsing mode. + fdlibm-math: + type: boolean + description: | + Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy + overrides: + type: string + description: | + The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. +firefox-jp-guide-default-site: + description: | + This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the feature. +fission: + description: The feature that controls whether fission is enabled or not in Gecko. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable fission. Fission is enabled when set to true. Fission is disabled when set to false. + isolationStrategy: + type: int + description: | + The web content isolation strategy to use with fission. "0" means "isolate nothing", similar to non-fission behavior. "1" means "isolate everything", where every site-origin gets its own process. "2" means "isolate high value", Android-specific setting to only isolate sites considered "high value". + shouldUseNimbus: + type: boolean + description: | + If true, the values for both SHIP and Fission set in this file apply. Otherwise, the values from modules/libpref/init/StaticPrefList.yaml apply. +fx-suggest: + description: A feature that provides Firefox Suggest search suggestions. + hasExposure: true + exposureDescription: '' + variables: + boost-amp-wiki: + type: boolean + description: | + The feature boost wiki and AMP suggestions to the top of its group. + enabled: + type: boolean + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. +gecko-nimbus-validation: + description: Feature for validating Nimbus Gecko functionality + hasExposure: true + exposureDescription: '' + variables: + test-preference: + type: string + description: A test gecko preference + setPref: + pref: gecko.nimbus.test + branch: default + test-preference-2: + type: int + description: A second test gecko preference + setPref: + pref: gecko.nimbus.test.two + branch: user +glean: + description: A feature that provides server-side configurations for Glean metrics (aka Server Knobs). + hasExposure: true + exposureDescription: '' + variables: + delay-ping-lifetime-io: + type: boolean + description: Glean will delay io for ping lifetime metrics + enable-event-timestamps: + type: boolean + description: Enables precise event timestamps for Glean events + gleanMetricConfiguration: + type: json + description: Configuration for Glean Server Knobs + ping-lifetime-max-time: + type: int + description: After what time to auto-flush + ping-lifetime-threshold: + type: int + description: Write count threshold when to auto-flush +google-lens-integration: + description: A feature that enables Google Lens integration for users on Firefox on Android. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, Google Lens integration is enabled. +homepage-as-new-tab: + description: Enables homepage as a a new tab. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable homepage as a new tab +homepage-customization: + description: Feature to enable Homepage Customization for users on Firefox on Android. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, Homepage Customization is enabled. +homepage-hide-frecent-top-sites: + description: Hides frecent top sites on the homepage. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to hide frecent top sites on the homepage. +homepage-opening-screen-default: + description: Configure the default option for the homepage opening screen. + hasExposure: true + exposureDescription: '' + variables: + default-option: + type: string + description: The default option for the homepage opening screen. + enum: + - homepage + - homepage-four-hours + - last-tab +homepage-trending-recent-search: + description: Feature to show trending and recent searches on the Homepage Search for users on Firefox on Android. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, trending and recent searches are shown on the Homepage Search. +homepage-weather-widget: + description: Feature to enable Homepage Weather Widget for users on Firefox for Android. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, Homepage Weather Widget is enabled. +homescreen: + description: The homescreen that the user goes to when they press home or new tab. + hasExposure: true + exposureDescription: '' + variables: + sections-enabled: + type: json + description: This property provides a lookup table of whether or not the given section should be enabled. If the section is enabled, it should be toggleable in the settings screen, and on by default. +homescreen-edge-to-edge-background: + description: | + Feature that sets an edge to edge background on the Home Screen if the user hasn't selected a custom wallpaper + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: Enables the feature +import-bookmarks: + description: A feature that lets users import bookmarks from another browser. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, the import bookmarks feature will be enabled. +ip-protection: + description: Feature to enable IP Protection (VPN) for users on Firefox on Android. + hasExposure: true + exposureDescription: '' + variables: + allowed-regions: + type: json + description: Country codes whose users are eligible for IP Protection. + data-limit-gigabyte: + type: int + description: Specifies the VPN data limit for unpaid users in GB (e.g. 50 GB). + enabled: + type: boolean + description: If true, IP Protection feature is enabled. + promo-deadline: + type: string + description: The final date for the promotion to end. This needs to be an ISO 8601 formatted date (i.e. YYYY-MM-DD). + show-beta-badge: + type: boolean + description: If true, a BETA badge is shown next to the IP Protection entry in the settings list. + show-onboarding-bottom-sheet: + type: boolean + description: If true, the IP Protection onboarding bottom sheet is shown to the user. +isolated-content-processes: + description: Feature that controls content process isolation. + hasExposure: true + exposureDescription: '' + variables: + app-zygote-preloading: + type: boolean + description: | + Whether or not to enable app Zygote preloaded isolated content processes. + enabled: + type: boolean + description: | + Whether or not to enable isolated content processes. +javascript: + description: Enables Javascript Engine (Spidermonkey) features + hasExposure: true + exposureDescription: '' + variables: + parallelMarkingEnabled: + type: boolean + description: | + Enables or disables javascript.options.mem.gc_parallel_marking preference. +juno-onboarding: + description: A feature that shows the onboarding flow. + hasExposure: true + exposureDescription: '' + variables: + cards: + type: json + description: Collection of user facing onboarding cards. + conditions: + type: json + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. +lna-blocking: + description: Feature that allows blocking local network or device access. + hasExposure: true + exposureDescription: '' + variables: + block-insecure-contexts: + type: boolean + description: | + Whether or not LNA requests coming from insecure contexts should be blocked outright, without prompting the user for permission + setPref: + pref: network.lna.block_insecure_contexts + branch: default + block-trackers: + type: boolean + description: | + Whether or not to block trackers + blocking: + type: boolean + description: | + Whether or not to block LNA requests + enabled: + type: boolean + description: | + Whether or not to turn on local network / device access blocking +longfox: + description: Flag to enable Longfox for users on Firefox Android. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, users will see a CTA for launching Longfox on the home screen. +marketing-onboarding-card: + description: A temporary feature to control the marketing onboarding card shown during the onboarding flow. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If false, the marketing onboarding card will never be shown. +media-notification-improvements: + description: Whether to show the media notification improvements + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: enabled media notification improvements if true, else not enabled +merino-client: + description: Feature to enable the Merino Client for users on Firefox on Android. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, Merino Client is enabled. +messaging: + description: | + The in-app messaging system. + hasExposure: true + exposureDescription: '' + variables: + $$experiment: + type: string + description: The only acceptable value for `MessageData#experiment`. This should not be set by experiment. + $$surfaces: + type: json + description: | + A list available surfaces for this app. + + This should not be written to by experiments, and should be hidden to users. + actions: + type: json + description: A growable map of action URLs. + message-under-experiment: + type: string + description: Deprecated in favor of `MessageData#experiment`. This will be removed in future releases. + messages: + type: json + description: A growable collection of messages + notification-config: + type: json + description: Configuration of the notification worker for all notification messages. + on-control: + type: string + description: What should be displayed when a control message is selected. + enum: + - show-next-message + - show-none + styles: + type: json + description: | + A map of styles to configure message appearance. + triggers: + type: json + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. +microsurveys: + description: Feature for microsurveys. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + When the feature is enabled then microsurveys can be used. +minimal-addressbar: + description: Show a smaller height bottom addressbar with just the URL. + hasExposure: true + exposureDescription: '' + variables: + at-bottom-while-entering-text: + type: boolean + description: | + Whether to show the smaller height bottom addressbar with just the URL when entering text in a website. +native-share-sheet: + description: Feature to enable the Native Share Sheet for users on Firefox on Android. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, Native Share Sheet is enabled. +networking-happy-eyeballs: + description: Networking (Necko) Happy Eyeballs V3 configuration + hasExposure: true + exposureDescription: '' + variables: + connection-attempt-delay: + type: int + description: Time in ms between successive connection attempts + setPref: + pref: network.http.happy_eyeballs_connection_attempt_delay + branch: default + enabled: + type: boolean + description: Whether to enable the Happy Eyeballs v3 algorithm for connection establishment + setPref: + pref: network.http.happy_eyeballs_enabled + branch: default + resolution-delay: + type: int + description: Time in ms to wait after the first DNS response before starting connections + setPref: + pref: network.http.happy_eyeballs_resolution_delay + branch: default +networkingBannedPorts: + description: Networking (Necko) Banned Ports + hasExposure: true + exposureDescription: '' + variables: + bannedPortList: + type: string + description: A comma-separated list of ports that Firefox will refuse to connect to. These ports will be appended to nsIOService gBadPortList +nimbus-is-ready: + description: | + A feature that provides the number of Nimbus is_ready events to send when Nimbus finishes launching. + hasExposure: true + exposureDescription: '' + variables: + event-count: + type: int + description: The number of events that should be sent. +nimbus-qa-bool-default: + description: A feature for testing boolean pref-setting on the default branch. + hasExposure: true + exposureDescription: '' + variables: + value: + type: boolean + description: The value to set for the pref. + setPref: + pref: nimbus.qa.pref-bool-default + branch: default +nimbus-qa-bool-user: + description: A feature for testing boolean pref-setting on the user branch. + hasExposure: true + exposureDescription: '' + variables: + value: + type: boolean + description: The value to set for the pref. + setPref: + pref: nimbus.qa.pref-bool-user + branch: user +nimbus-qa-int-default: + description: A feature for testing int pref-setting on the default branch. + hasExposure: true + exposureDescription: '' + variables: + value: + type: int + description: The value to set for the pref. + setPref: + pref: nimbus.qa.pref-int-default + branch: default +nimbus-qa-int-user: + description: A feature for testing int pref-setting on the user branch. + hasExposure: true + exposureDescription: '' + variables: + value: + type: int + description: The value to set for the pref. + setPref: + pref: nimbus.qa.pref-int-user + branch: user +nimbus-qa-string-default: + description: A feature for testing string pref-setting on the default branch. + hasExposure: true + exposureDescription: '' + variables: + value: + type: string + description: The value to set for the pref. + setPref: + pref: nimbus.qa.pref-string-default + branch: default +nimbus-qa-string-user: + description: A feature for testing string pref-setting on the user branch. + hasExposure: true + exposureDescription: '' + variables: + value: + type: string + description: The value to set for the pref. + setPref: + pref: nimbus.qa.pref-string-user + branch: user +nimbus-system: + description: | + Configuration of the Nimbus System in Android. + hasExposure: true + exposureDescription: '' + variables: + refresh-interval-foreground: + type: int + description: | + The minimum interval in minutes between fetching experiment + recipes in the foreground. +nimbus-validation: + description: A feature that does not correspond to an application feature suitable for showing that Nimbus is working. This should never be used in production. + hasExposure: true + exposureDescription: '' + variables: + settings-icon: + type: string + description: The drawable displayed in the app menu for Settings + settings-punctuation: + type: string + description: The emoji displayed in the Settings screen title. + settings-title: + type: string + description: The title of displayed in the Settings screen and app menu. +oled-theme: + description: Feature to provide the OLED theme option for users on Firefox for Android. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, the OLED theme option is shown. +onboarding: + description: A feature that configures the new user onboarding page. Note that onboarding is a **first run** feature, and should only be modified by first run experiments. + hasExposure: true + exposureDescription: '' + variables: + order: + type: json + description: Determines the order of the onboarding page panels +one-click-search: + description: Enable/disable the one click search feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, the one click search will be enabled. +pdf-viewer: + description: Feature for the PDF viewer tools for users on Firefox for Android. + hasExposure: true + exposureDescription: '' + variables: + android-ui-tools: + type: boolean + description: If true, the Android PDF UI tools are shown. +pdfjs: + description: PDF.js features + hasExposure: true + exposureDescription: '' + variables: + download-button: + type: boolean + description: Download button + open-in-app-button: + type: boolean + description: Open in app button +pki: + description: Certificate verification configuration + hasExposure: true + exposureDescription: '' + variables: + certificateTransparencyMode: + type: int + description: | + What mode Certificate Transparency is in (0=disable, 1=telemetry only, 2=enforce). + crliteChannel: + type: string + description: | + The channel from which CRLite filters will be installed. +pqcrypto: + description: Control the use of post-quantum key exchange mechanisms in TLS and HTTP/3. + hasExposure: true + exposureDescription: '' + variables: + postQuantumKeyExchangeEnabled: + type: boolean + description: | + Toggles the security.tls.enable_kyber and network.http.http3.enable_kyber preferences. +private-browsing-lock: + description: Allows enabling and disabling the private browsing mode lock via an authentication screen. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable private browsing mode lock. +private-mode-and-stories-entry-point: + description: Feature to enable the Private Mode and Stories Entry Point Experiment. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, Private Mode and Stories Entry Point Experiment is enabled. +remote-search-configuration: + description: Feature to use search configurations from remote servers. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Uses search configuration from remote servers . +remote-tab-management: + description: | + Features that let users manage tabs on other devices that are connected to the same Mozilla account. + hasExposure: true + exposureDescription: '' + variables: + close-tabs-enabled: + type: boolean + description: | + Whether the feature to close synced tabs is enabled. When enabled, this device will allow other devices to close tabs that are open on this device, and show a "close" button for tabs that are currently open on other supported devices in the synced tabs tray. +safe-browsing-real-time: + description: Control Safe Browsing real-time lookup and simulation. + hasExposure: true + exposureDescription: '' + variables: + feature-enabled: + type: boolean + description: If true, this feature is enabled and the below settings override the Gecko defaults. Otherwise, the Gecko defaults are used. + global-cache-enabled: + type: boolean + description: Enables / disables the Safe Browsing Global Cache. + real-time-enabled: + type: boolean + description: Enables / disables Safe Browsing real-time lookup. + simulation-cache-ttl-sec: + type: int + description: Cache TTL in seconds for the real-time request simulator. + simulation-enabled: + type: boolean + description: Enables / disables the real-time request simulator. + simulation-hit-probability: + type: int + description: Hit probability for the real-time request simulator. + simulation-negative-cache-enabled: + type: boolean + description: Enables / disables the negative cache for the real-time request simulator. + simulation-negative-cache-ttl-sec: + type: int + description: Negative cache TTL in seconds for the real-time request simulator. +safe-browsing-v5: + description: Control Safe Browsing V5. + hasExposure: true + exposureDescription: '' + variables: + enable-v5: + type: boolean + description: Enables / disables the SafeBrowsing V5 protocol. + feature-enabled: + type: boolean + description: If true, this feature is enabled. Otherwise, we follow the SafeBrowsing V5 enabled pref. +same-document-navigation-overrides-load-type: + description: Control whether the same document navigation overrides the load type. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Overrides the loadType when it is a same document navigation + force-disable-uri: + type: string + description: | + Disable overriding the loadType during same document navigation on the domain specified by this URI. +search-extra-params: + description: A feature that provides additional args for search. + hasExposure: true + exposureDescription: '' + variables: + channel-id: + type: json + description: The channel Id param name with arg. + enabled: + type: boolean + description: If true, the feature is active. + feature-enabler: + type: json + description: The feature enabler param name with arg, NOTE this map could be empty. + search-engine: + type: string + description: The search engine name. +search-optimization-option: + description: Feature to enable the Search Optimization cards for users on Firefox on Android. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, Search Optimization is enabled. + show-flights-card: + type: boolean + description: If true, Search Optimization Flights cards are enabled. + show-sports-card: + type: boolean + description: If true, Search Optimization Sports cards are enabled. + show-stocks-card: + type: boolean + description: If true, Search Optimization Stock cards are enabled. +sent-from-firefox: + description: A feature that allows the user to add a download firefox footer to a shared link. + hasExposure: true + exposureDescription: '' + variables: + download-link: + type: string + description: A store download link. + enabled: + type: boolean + description: If true, the feature is available for the user. + show-snackbar: + type: boolean + description: If true, the user will see the snackbar after sharing a link, allowing quick navigation to settings. + template-message: + type: string + description: A template for the shared message, supporting three placeholders. A shared link, the brand name and a store download link. +setup-checklist: + description: A feature on the home page that allows the user to track onboarding setup progress. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, the setup checklist will be enabled. + setup-checklist-type: + type: string + description: The collection used for the setup checklist. + enum: + - collection-1 + - collection-2 +shake-to-summarize: + description: A feature that can summarize the content of a page when you shake the screen. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, shake to summarize will be enabled +splash-screen: + description: A feature that extends splash screen duration, allowing additional data fetching time for the app's initial run. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, the feature is active. + maximum_duration_ms: + type: int + description: The maximum amount of time in milliseconds the splashscreen will be visible while waiting for initialization calls to complete. + off-train-onboarding: + type: boolean + description: If true, the fetched data will be applied and used during the session. +suggest-shipped-domains: + description: Feature that suggests domains from the shipped domain list. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Suggest domains from the shipped domain list. +suppress-sponsored-top-sites: + description: Suppress sponsored top sites for new users for 14 days. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, new users won’t see sponsored tiles for 14 days. +tab-groups: + description: Control the visibility of the tab groups feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable the tab groups feature. +tab-groups-drag-and-drop: + description: Control the visibility of drag and drop for tab groups. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable drag and drop for tab groups. +tab-groups-live-reorder: + description: Control whether reorder happens live during a drag and drop action for Tab Groups. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable live reorder for tab groups drag and drop. +tab-groups-onboarding: + description: Control the visibility of onboarding for tab groups. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable onboarding for tab groups. +tab-management-enhancements: + description: Control the visibility of the tab management enhancements. + hasExposure: true + exposureDescription: '' + variables: + opening_animation_enabled: + type: boolean + description: Whether or not the Tab Manager opening animation is enabled. When enabled, a shared element transition will initiate, taking the currently-opened tab's thumbnail and shrinking it into its spot in the Tab Manager. +tab-strip: + description: Enables tab strip. + hasExposure: true + exposureDescription: '' + variables: + allow-on-all-devices: + type: boolean + description: | + Experimental: When true, bypasses device restrictions and enables use on all devices. May cause instability or unexpected behavior. This still requires the feature to be `enabled`. + enabled: + type: boolean + description: | + Whether or not to enable tab strip. +terms-of-use-prompt: + description: Enables the terms of use prompt for users who have not accepted ToU + hasExposure: true + exposureDescription: '' + variables: + content-option: + type: string + description: Defines which content option should used for the prompt. + enum: + - value-0 + - value-1 + - value-2 + enable-drag-to-dismiss: + type: boolean + description: Whether to show a drag handle on the prompt and allows users to use it to dismiss the prompt. + enabled: + type: boolean + description: When the feature is enabled then the prompt can show for users. + max-display-count: + type: int + description: The maximum number of times to show the prompt. +third-party-cookie-blocking: + description: Control third-party cookie blocking. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, the feature is active. + enabled-normal: + type: boolean + description: | + Enables / disables third-party cookie blocking in normal browsing mode. + enabled-private: + type: boolean + description: | + Enables / disables third-party cookie blocking in private browsing mode. +tracking-protection-experimentation: + description: Experimental controls for tracking protection behavior + hasExposure: true + exposureDescription: '' + variables: + defer-annotation-enabled: + type: boolean + description: Whether to defer tracking protection classification annotation until the data is being handled + setPref: + pref: privacy.trackingprotection.defer_annotation.enabled + branch: default +translations: + description: The feature that allows on-device translations of web content. + hasExposure: true + exposureDescription: '' + variables: + downloads-enabled: + type: boolean + description: | + Show the global language model download options entry point for translations. ('Download languages' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + global-lang-settings-enabled: + type: boolean + description: | + Show the global language options entry point for automatically translating. ('Automatic Translation' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + global-settings-enabled: + type: boolean + description: | + Show the global settings entry point within the translations feature. ('Translation Settings' on the page settings view.) 'page-settings-enabled' must also be enabled for users to access this feature. + global-site-settings-enabled: + type: boolean + description: | + Show the global never translate this site options entry point for site management. ('Never translate these sites' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + main-flow-browser-menu-enabled: + type: boolean + description: | + Show the browser menu entry point into the translations feature. ('Translate Page' on browser menu.) + main-flow-toolbar-enabled: + type: boolean + description: | + Show the primary toolbar entry point into the translations feature. (Translations icon on URL toolbar.) + page-settings-enabled: + type: boolean + description: | + Show the page settings entry point within the translations feature. (Gear icon on the translations main flow page.) 'main-flow-toolbar-enabled' or 'main-flow-browser-menu-enabled' must also be enabled for users to access this feature. +uninstall-survey: + description: Feature that controls the visibility and handling of the uninstall survey app shortcut. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, the uninstall survey shortcut is enabled and visible. +universal-edge-to-edge-wallpapers: + description: | + Extends non-default homepage wallpapers edge-to-edge and adapts the toolbar, navigation bar and system bars to them. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable the universal edge-to-edge wallpaper treatment. +user-characteristics: + description: A feature for control user characteristic data collection + hasExposure: true + exposureDescription: '' + variables: + currentVersion: + type: int + description: The current collection version of the user characteristics. +voice-search-in-display-mode: + description: Controls whether the voice search entry point is shown in the display-mode browser toolbar. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, voice search is shown in the display toolbar. +webcompat-reporter-enhancements: + description: Feature to enable WebCompat Reporter enhancements for users on Firefox Android. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, WebCompat Reporter enhancements is enabled. diff --git a/experimenter/experimenter/features/manifests/fenix/v155.0.2/nightly.fml.yaml b/experimenter/experimenter/features/manifests/fenix/v155.0.2/nightly.fml.yaml new file mode 100644 index 0000000000..e418cd3c8e --- /dev/null +++ b/experimenter/experimenter/features/manifests/fenix/v155.0.2/nightly.fml.yaml @@ -0,0 +1,1772 @@ +version: 1.0.0 +about: + description: Nimbus Feature Manifest for Fenix (Firefox Android) +channels: +- nightly +features: + add-shortcuts-improvement: + description: Feature to enable Add Shortcuts improvement for users on Firefox on Android. + variables: + enabled: + description: If true, Add Shortcuts improvement is enabled. + type: Boolean + default: true + ads-client-for-stories: + description: Feature to enable the Mozilla Ads Client support for Sponsored Stories for users on Firefox on Android. + variables: + enabled: + description: If true, Mozilla Ads Client support for Sponsored Stories is enabled. + type: Boolean + default: false + alternative-app-launcher-icon: + description: A feature that changes the app launcher icon background color. + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + reset-to-default: + description: | + If true use the default icon, if false use the alternative icon. This is required to 'reset' the icon for enrolled users once the initial experiment is complete. + type: Boolean + default: false + app-links: + description: Control behavior of app links handling in the browser. + variables: + show-new-prompt: + description: Whether to show the new AppLinksPromptFragment dialog when an app link is detected. If false, the old dialog is used. + type: Boolean + default: true + awesomebar-suggestion-provider: + description: Configuration for the Firefox Suggest awesomebar suggestion provider. + variables: + available-suggestion-types: + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + type: Map + default: + amp: true + ampMobile: false + wikipedia: true + baseline-fpp: + description: Control Baseline Fingerprinting Protection + variables: + enabled: + description: Enables / disables baseline fingerprinting protection. + type: Boolean + default: true + feat-enabled: + description: If true, the feature is active. + type: Boolean + default: false + overrides: + description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. + type: String + default: '' + collections-to-tab-groups-migration: + description: Feature to migrate Collections to Tab Groups for users on Firefox for Android. + variables: + hide-collections-ui: + description: If true, the Collections UI is hidden. + type: Boolean + default: false + continuous-onboarding: + description: | + Feature to enable the continuous onboarding flow. This feature reduces the number of upfront onboarding cards and distributes the cards and other prompts progressively over a number of days. + variables: + enabled: + description: If true, the feature is enabled. + type: Boolean + default: true + custom-review-prompt-ui: + description: Feature that controls the custom UI for review prompt. + variables: + enabled: + description: When enabled we show the custom review prompt UI. Otherwise we try to directly show the Play Store in-app review prompt. + type: Boolean + default: true + default-bottom-toolbar: + description: Default toolbar position for new users. + variables: + enabled: + description: | + Whether to default the toolbar position to bottom. + type: Boolean + default: false + default-browser-prompt: + description: Feature that controls when the default browser prompt is shown. + variables: + coldStartsBetweenPrompts: + description: The minimum number of cold starts between showing the prompt. + type: Option + default: 4 + daysBetweenPrompts: + description: The minimum number of days between showing the prompt. + type: Option + default: 14 + enabled: + description: Whether or not to enable the default browser prompt. + type: Boolean + default: true + maxPromptsShown: + description: The maximum number of times the prompt can shown to the user. + type: Option + default: 3 + default-expanded-toolbar: + description: Default expanded (bottom navigation) toolbar state for new users. + variables: + enabled: + description: | + Whether to default the expanded toolbar (bottom navigation bar with back/forward/share/bookmark/menu) to enabled. Only takes visible effect on tall, non-wide windows. + type: Boolean + default: false + doh: + description: Feature controlling DNS over HTTPS (DoH). + variables: + autoselect-enabled: + description: | + Controls the network.android_doh.autoselect_enabled pref and automatically chooses a DoH provider when Default Protection mode is selected. + type: Boolean + default: false + show-ui: + description: | + When `true`, include DoH settings in the settings UI. + type: Boolean + default: true + downloads-custom-location: + description: Feature to enable the custom download location for users on Firefox on Android. + variables: + enabled: + description: If true, custom download location is enabled. + type: Boolean + default: true + email-masks: + description: Feature to enable Email Mask for users on Firefox on Android. + variables: + enabled: + description: If true, Email Mask feature is enabled. + type: Boolean + default: true + enable-popups: + description: A feature that enables or disables in app popups + variables: + cfr-popups-enabled: + description: When true, CFR popups will show + type: Boolean + default: true + in-app-messages-enabled: + description: | + Enables non-CFR in-app messaging surfaces. Currently includes: - Wallpaper onboarding bottom sheet - PWA onboarding ("Add to Home screen") dialog - "Open links in apps" banner + type: Boolean + default: true + fingerprinting-protection: + description: Control Fingerprinting Protection + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + enabled-normal: + description: | + Enables / disables fingerprinting protection in normal browsing mode. + type: Boolean + default: false + enabled-private: + description: | + Enables / disables fingerprinting protection in private browsing mode. + type: Boolean + default: true + fdlibm-math: + description: | + Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy + type: Boolean + default: false + overrides: + description: | + The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. + type: String + default: '' + firefox-jp-guide-default-site: + description: | + This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + fission: + description: The feature that controls whether fission is enabled or not in Gecko. + variables: + enabled: + description: | + Whether or not to enable fission. Fission is enabled when set to true. Fission is disabled when set to false. + type: Boolean + default: false + isolationStrategy: + description: | + The web content isolation strategy to use with fission. "0" means "isolate nothing", similar to non-fission behavior. "1" means "isolate everything", where every site-origin gets its own process. "2" means "isolate high value", Android-specific setting to only isolate sites considered "high value". + type: Int + default: 2 + shouldUseNimbus: + description: | + If true, the values for both SHIP and Fission set in this file apply. Otherwise, the values from modules/libpref/init/StaticPrefList.yaml apply. + type: Boolean + default: false + fx-suggest: + description: A feature that provides Firefox Suggest search suggestions. + variables: + boost-amp-wiki: + description: | + The feature boost wiki and AMP suggestions to the top of its group. + type: Boolean + default: false + enabled: + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. + type: Boolean + default: true + gecko-nimbus-validation: + description: Feature for validating Nimbus Gecko functionality + variables: + test-preference: + description: A test gecko preference + type: Option + default: null + gecko-pref: + pref: gecko.nimbus.test + branch: default + test-preference-2: + description: A second test gecko preference + type: Option + default: null + gecko-pref: + pref: gecko.nimbus.test.two + branch: user + glean: + description: A feature that provides server-side configurations for Glean metrics (aka Server Knobs). + variables: + delay-ping-lifetime-io: + description: Glean will delay io for ping lifetime metrics + type: Boolean + default: true + enable-event-timestamps: + description: Enables precise event timestamps for Glean events + type: Boolean + default: true + gleanMetricConfiguration: + description: Configuration for Glean Server Knobs + type: GleanServerKnobsConfiguration + default: + event_threshold: null + metrics_enabled: {} + pings_enabled: {} + ping-lifetime-max-time: + description: After what time to auto-flush + type: Int + default: 2000 + ping-lifetime-threshold: + description: Write count threshold when to auto-flush + type: Int + default: 1000 + allow-coenrollment: true + google-lens-integration: + description: A feature that enables Google Lens integration for users on Firefox on Android. + variables: + enabled: + description: If true, Google Lens integration is enabled. + type: Boolean + default: true + homepage-as-new-tab: + description: Enables homepage as a a new tab. + variables: + enabled: + description: | + Whether or not to enable homepage as a new tab + type: Boolean + default: false + homepage-customization: + description: Feature to enable Homepage Customization for users on Firefox on Android. + variables: + enabled: + description: If true, Homepage Customization is enabled. + type: Boolean + default: false + homepage-hide-frecent-top-sites: + description: Hides frecent top sites on the homepage. + variables: + enabled: + description: | + Whether or not to hide frecent top sites on the homepage. + type: Boolean + default: false + homepage-opening-screen-default: + description: Configure the default option for the homepage opening screen. + variables: + default-option: + description: The default option for the homepage opening screen. + type: OpeningScreenOption + default: homepage-four-hours + homepage-trending-recent-search: + description: Feature to show trending and recent searches on the Homepage Search for users on Firefox on Android. + variables: + enabled: + description: If true, trending and recent searches are shown on the Homepage Search. + type: Boolean + default: true + homepage-weather-widget: + description: Feature to enable Homepage Weather Widget for users on Firefox for Android. + variables: + enabled: + description: If true, Homepage Weather Widget is enabled. + type: Boolean + default: false + homescreen: + description: The homescreen that the user goes to when they press home or new tab. + variables: + sections-enabled: + description: This property provides a lookup table of whether or not the given section should be enabled. If the section is enabled, it should be toggleable in the settings screen, and on by default. + type: Map + default: + top-sites: true + jump-back-in: true + bookmarks: true + recent-explorations: true + pocket: true + pocket-sponsored-stories: true + synced-tabs: true + collections: true + privacy-report: true + homescreen-edge-to-edge-background: + description: | + Feature that sets an edge to edge background on the Home Screen if the user hasn't selected a custom wallpaper + variables: + enabled: + description: Enables the feature + type: Boolean + default: true + import-bookmarks: + description: A feature that lets users import bookmarks from another browser. + variables: + enabled: + description: If true, the import bookmarks feature will be enabled. + type: Boolean + default: true + ip-protection: + description: Feature to enable IP Protection (VPN) for users on Firefox on Android. + variables: + allowed-regions: + description: Country codes whose users are eligible for IP Protection. + type: List + default: + - AU + - AT + - BE + - BG + - CA + - CL + - CO + - DK + - FI + - FR + - DE + - IE + - IT + - JP + - MY + - MX + - NL + - NZ + - NO + - PL + - PT + - RO + - SG + - ZA + - ES + - SE + - CH + - TH + - GB + - US + data-limit-gigabyte: + description: Specifies the VPN data limit for unpaid users in GB (e.g. 50 GB). + type: Int + default: 50 + enabled: + description: If true, IP Protection feature is enabled. + type: Boolean + default: true + promo-deadline: + description: The final date for the promotion to end. This needs to be an ISO 8601 formatted date (i.e. YYYY-MM-DD). + type: String + default: 2026-08-31 + show-beta-badge: + description: If true, a BETA badge is shown next to the IP Protection entry in the settings list. + type: Boolean + default: true + show-onboarding-bottom-sheet: + description: If true, the IP Protection onboarding bottom sheet is shown to the user. + type: Boolean + default: true + isolated-content-processes: + description: Feature that controls content process isolation. + variables: + app-zygote-preloading: + description: | + Whether or not to enable app Zygote preloaded isolated content processes. + type: Boolean + default: false + enabled: + description: | + Whether or not to enable isolated content processes. + type: Boolean + default: false + javascript: + description: Enables Javascript Engine (Spidermonkey) features + variables: + parallelMarkingEnabled: + description: | + Enables or disables javascript.options.mem.gc_parallel_marking preference. + type: Boolean + default: false + juno-onboarding: + description: A feature that shows the onboarding flow. + variables: + cards: + description: Collection of user facing onboarding cards. + type: Map + default: + terms-of-service: + body: '' + card-type: terms-of-service + disqualifiers: + - NEVER + enabled: true + extra-data: + term-of-service-data: + subheader-one-text: nova_onboarding_tou_subtitle + line-one-text: nova_onboarding_tou_body_line_1 + line-one-link-text: nova_onboarding_tou_body_line_1_link_text + line-two-text: nova_onboarding_tou_body_line_2 + line-two-link-text: nova_onboarding_tou_body_line_2_link_text + line-three-text: nova_onboarding_tou_body_line_3 + line-three-link-text: nova_onboarding_tou_body_line_3_link_text + image-res: nova_onboarding_tou + ordering: 1 + prerequisites: + - ALWAYS + primary-button-label: nova_onboarding_continue_button + secondary-button-label: '' + title: onboarding_welcome_to_firefox + default-browser: + body: nova_onboarding_set_to_default_subtitle + card-type: default-browser + disqualifiers: + - NEVER + enabled: true + extra-data: null + image-res: nova_onboarding_set_to_default + ordering: 10 + prerequisites: + - ALWAYS + primary-button-label: nova_onboarding_set_to_default_button + secondary-button-label: nova_onboarding_negative_button + title: nova_onboarding_set_to_default_title_2 + marketing: + body: '' + card-type: marketing-data + disqualifiers: + - NEVER + enabled: true + extra-data: + marketing-data: + body-line-one-text: nova_onboarding_marketing_body_2 + body-line-one-link-text: nova_onboarding_marketing_body_link_text + image-res: nova_onboarding_marketing + ordering: 20 + prerequisites: + - ALWAYS + primary-button-label: nova_onboarding_continue_button + secondary-button-label: nova_onboarding_marketing_secondary_button_text + title: nova_onboarding_marketing_title + string-alias: OnboardingCardKey + conditions: + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + string-alias: ConditionName + lna-blocking: + description: Feature that allows blocking local network or device access. + variables: + block-insecure-contexts: + description: | + Whether or not LNA requests coming from insecure contexts should be blocked outright, without prompting the user for permission + type: Option + default: null + gecko-pref: + pref: network.lna.block_insecure_contexts + branch: default + block-trackers: + description: | + Whether or not to block trackers + type: Boolean + default: false + blocking: + description: | + Whether or not to block LNA requests + type: Boolean + default: false + enabled: + description: | + Whether or not to turn on local network / device access blocking + type: Boolean + default: false + longfox: + description: Flag to enable Longfox for users on Firefox Android. + variables: + enabled: + description: If true, users will see a CTA for launching Longfox on the home screen. + type: Boolean + default: false + marketing-onboarding-card: + description: A temporary feature to control the marketing onboarding card shown during the onboarding flow. + variables: + enabled: + description: If false, the marketing onboarding card will never be shown. + type: Boolean + default: true + media-notification-improvements: + description: Whether to show the media notification improvements + variables: + enabled: + description: enabled media notification improvements if true, else not enabled + type: Boolean + default: true + merino-client: + description: Feature to enable the Merino Client for users on Firefox on Android. + variables: + enabled: + description: If true, Merino Client is enabled. + type: Boolean + default: false + messaging: + description: | + The in-app messaging system. + variables: + $$experiment: + description: The only acceptable value for `MessageData#experiment`. This should not be set by experiment. + type: ExperimentSlug + default: '{experiment}' + string-alias: ExperimentSlug + $$surfaces: + description: | + A list available surfaces for this app. + + This should not be written to by experiments, and should be hidden to users. + type: List + default: + - homescreen + - notification + - survey + - microsurvey + string-alias: SurfaceName + actions: + description: A growable map of action URLs. + type: Map + default: + OPEN_URL: ://open + ENABLE_PRIVATE_BROWSING: ://enable_private_browsing + INSTALL_SEARCH_WIDGET: ://install_search_widget + MAKE_DEFAULT_BROWSER: ://make_default_browser + VIEW_BOOKMARKS: ://urls_bookmarks + VIEW_COLLECTIONS: ://home_collections + VIEW_HISTORY: ://urls_history + VIEW_HOMESCREEN: ://home + OPEN_SETTINGS_ACCESSIBILITY: ://settings_accessibility + OPEN_SETTINGS_ADDON_MANAGER: ://settings_addon_manager + OPEN_SETTINGS_AI_CONTROLS: ://settings_ai_controls + OPEN_SETTINGS_DELETE_BROWSING_DATA: ://settings_delete_browsing_data + OPEN_SETTINGS_LOGINS: ://settings_logins + OPEN_SETTINGS_NOTIFICATIONS: ://settings_notifications + OPEN_SETTINGS_MARKETING_NOTIFICATIONS: ://settings_marketing_notifications + OPEN_SETTINGS_PRIVACY: ://settings_privacy + OPEN_SETTINGS_SEARCH_ENGINE: ://settings_search_engine + OPEN_SETTINGS_TRACKING_PROTECTION: ://settings_tracking_protection + OPEN_SETTINGS_WALLPAPERS: ://settings_wallpapers + OPEN_SETTINGS_APP_ICON: ://settings_app_icon + OPEN_SETTINGS: ://settings + OPEN_SHARE_SHEET: ://share_sheet + OPEN_PROTECTIONS_DASHBOARD: ://protections_dashboard + TURN_ON_SYNC: ://turn_on_sync + string-alias: ActionName + message-under-experiment: + description: Deprecated in favor of `MessageData#experiment`. This will be removed in future releases. + type: Option + default: null + messages: + description: A growable collection of messages + type: Map + default: + default-browser: + title: default_browser_experiment_card_title + text: default_browser_experiment_card_text + surface: homescreen + action: MAKE_DEFAULT_BROWSER + trigger-if-all: + - USER_ESTABLISHED_INSTALL + - ANDROID_API_BELOW_29 + exclude-if-any: + - I_AM_DEFAULT_BROWSER + style: PERSISTENT + button-label: preferences_set_as_default_browser + default-browser-notification: + title: nimbus_notification_default_browser_title + text: nimbus_notification_default_browser_text + surface: notification + style: NOTIFICATION + trigger-if-all: + - DAY_3_AFTER_INSTALL + exclude-if-any: + - I_AM_DEFAULT_BROWSER + action: MAKE_DEFAULT_BROWSER + microsurvey-printing-example-nightly: + title: microsurvey_prompt_printing_title + text: microsurvey_survey_printing_title + surface: microsurvey + trigger-if-all: + - RECENTLY_PRINTED + style: MICROSURVEY + microsurvey-config: + utm-content: homepage + icon: ic_print + answers: + - text: likert_scale_option_1 + ordering: 0 + - text: likert_scale_option_2 + ordering: 1 + - text: likert_scale_option_3 + ordering: 2 + - text: likert_scale_option_4 + ordering: 3 + - text: likert_scale_option_5 + ordering: 4 + - text: likert_scale_option_6 + ordering: 5 + microsurvey-uninstall-survey: + title: microsurvey_uninstall_survey_title + text: microsurvey_uninstall_survey_title + surface: microsurvey + trigger-if-all: + - NEVER + style: MICROSURVEY + microsurvey-config: + utm-content: uninstall_shortcut + icon: ic_delete_black + answers: + - text: uninstall_survey_option_1_v2 + ordering: 0 + - text: uninstall_survey_option_2_v2 + ordering: 1 + - text: uninstall_survey_option_3_v2 + ordering: 2 + - text: uninstall_survey_option_4_v2 + ordering: 3 + - text: uninstall_survey_option_5_v2 + ordering: 4 + - text: uninstall_survey_option_6_v2 + ordering: 5 + string-alias: MessageKey + notification-config: + description: Configuration of the notification worker for all notification messages. + type: NotificationConfig + default: + refresh-interval: 240 + on-control: + description: What should be displayed when a control message is selected. + type: ControlMessageBehavior + default: show-next-message + styles: + description: | + A map of styles to configure message appearance. + type: Map + default: + DEFAULT: + priority: 50 + max-display-count: 5 + SURVEY: + priority: 55 + max-display-count: 1 + PERSISTENT: + priority: 50 + max-display-count: 20 + WARNING: + priority: 60 + max-display-count: 10 + URGENT: + priority: 100 + max-display-count: 10 + NOTIFICATION: + priority: 50 + max-display-count: 1 + MICROSURVEY: + priority: 50 + max-display-count: 5 + string-alias: StyleName + triggers: + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + type: Map + default: + USER_ESTABLISHED_INSTALL: number_of_app_launches >=4 + ANDROID_API_BELOW_29: android_version < 29 + USER_RECENTLY_INSTALLED: days_since_install < 7 + USER_RECENTLY_UPDATED: days_since_update < 7 && days_since_install != days_since_update + USER_TIER_ONE_COUNTRY: ('US' in locale || 'GB' in locale || 'CA' in locale || 'DE' in locale || 'FR' in locale) + USER_EN_SPEAKER: '''en'' in locale' + USER_ES_SPEAKER: '''es'' in locale' + USER_DE_SPEAKER: '''de'' in locale' + USER_FR_SPEAKER: '''fr'' in locale' + DEVICE_ANDROID: os == 'Android' + DEVICE_IOS: os == 'iOS' + ALWAYS: 'true' + NEVER: 'false' + DAY_1_AFTER_INSTALL: days_since_install == 1 + DAY_2_AFTER_INSTALL: days_since_install == 2 + DAY_3_AFTER_INSTALL: days_since_install == 3 + DAY_4_AFTER_INSTALL: days_since_install == 4 + DAY_5_AFTER_INSTALL: days_since_install == 5 + MORE_THAN_24H_SINCE_INSTALLED_OR_UPDATED: days_since_update >= 1 + I_AM_DEFAULT_BROWSER: is_default_browser + I_AM_NOT_DEFAULT_BROWSER: is_default_browser == false + NOTIFICATIONS_ARE_ENABLED: are_notifications_enabled == true + NOTIFICATIONS_ARE_DISABLED: are_notifications_enabled == false + MARKETING_NOTIFICATIONS_ARE_ENABLED: are_marketing_notifications_enabled == true + MARKETING_NOTIFICATIONS_ARE_DISABLED: are_marketing_notifications_enabled == false + FUNNEL_PAID: adjust_campaign != '' + FUNNEL_ORGANIC: adjust_campaign == '' + INACTIVE_1_DAY: '''app_opened''|eventLastSeen(''Hours'') >= 24' + INACTIVE_2_DAYS: '''app_opened''|eventLastSeen(''Days'', 0) >= 2' + INACTIVE_3_DAYS: '''app_opened''|eventLastSeen(''Days'', 0) >= 3' + INACTIVE_4_DAYS: '''app_opened''|eventLastSeen(''Days'', 0) >= 4' + INACTIVE_5_DAYS: '''app_opened''|eventLastSeen(''Days'', 0) >= 5' + RECENTLY_PRINTED: '''print_tapped''|eventLastSeen(''Hours'') <= 24' + SECOND_HOMEPAGE_VIEW: '''home_screen_displayed''|eventSum(''Years'', 4, 0) >= 2' + PERFORMED_A_SEARCH_AGAIN_RECENTLY: '''performed_search''|eventSum(''Years'', 4, 0) >= 2 && ''performed_search''|eventLastSeen(''Minutes'') < 1' + FXA_CURRENTLY_SIGNED_IN: is_fxa_signed_in == true + FXA_MORE_THAN_1_DEVICE: fxa_connected_devices > 1 + FXA_SIGNED_IN: '''sync_auth.sign_in''|eventLastSeen(''Years'', 0) <= 4' + FXA_NOT_SIGNED_IN: '''sync_auth.sign_in''|eventLastSeen(''Years'', 0) > 4' + USER_INFREQUENT: '''app_opened''|eventCountNonZero(''Days'', 28) >= 1 && ''app_opened''|eventCountNonZero(''Days'', 28) < 7' + USER_CASUAL: '''app_opened''|eventCountNonZero(''Days'', 28) >= 7 && ''app_opened''|eventCountNonZero(''Days'', 28) < 14' + USER_REGULAR: '''app_opened''|eventCountNonZero(''Days'', 28) >= 14 && ''app_opened''|eventCountNonZero(''Days'', 28) < 21' + USER_CORE_ACTIVE: '''app_opened''|eventCountNonZero(''Days'', 28) >= 21' + LAUNCHED_ONCE_THIS_WEEK: '''app_opened''|eventSum(''Days'', 7) == 1' + string-alias: TriggerName + allow-coenrollment: true + microsurveys: + description: Feature for microsurveys. + variables: + enabled: + description: | + When the feature is enabled then microsurveys can be used. + type: Boolean + default: false + minimal-addressbar: + description: Show a smaller height bottom addressbar with just the URL. + variables: + at-bottom-while-entering-text: + description: | + Whether to show the smaller height bottom addressbar with just the URL when entering text in a website. + type: Boolean + default: false + native-share-sheet: + description: Feature to enable the Native Share Sheet for users on Firefox on Android. + variables: + enabled: + description: If true, Native Share Sheet is enabled. + type: Boolean + default: true + networking-happy-eyeballs: + description: Networking (Necko) Happy Eyeballs V3 configuration + variables: + connection-attempt-delay: + description: Time in ms between successive connection attempts + type: Option + default: null + gecko-pref: + pref: network.http.happy_eyeballs_connection_attempt_delay + branch: default + enabled: + description: Whether to enable the Happy Eyeballs v3 algorithm for connection establishment + type: Option + default: null + gecko-pref: + pref: network.http.happy_eyeballs_enabled + branch: default + resolution-delay: + description: Time in ms to wait after the first DNS response before starting connections + type: Option + default: null + gecko-pref: + pref: network.http.happy_eyeballs_resolution_delay + branch: default + networkingBannedPorts: + description: Networking (Necko) Banned Ports + variables: + bannedPortList: + description: A comma-separated list of ports that Firefox will refuse to connect to. These ports will be appended to nsIOService gBadPortList + type: String + default: '' + nimbus-is-ready: + description: | + A feature that provides the number of Nimbus is_ready events to send when Nimbus finishes launching. + variables: + event-count: + description: The number of events that should be sent. + type: Int + default: 1 + nimbus-qa-bool-default: + description: A feature for testing boolean pref-setting on the default branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-bool-default + branch: default + nimbus-qa-bool-user: + description: A feature for testing boolean pref-setting on the user branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-bool-user + branch: user + nimbus-qa-int-default: + description: A feature for testing int pref-setting on the default branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-int-default + branch: default + nimbus-qa-int-user: + description: A feature for testing int pref-setting on the user branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-int-user + branch: user + nimbus-qa-string-default: + description: A feature for testing string pref-setting on the default branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-string-default + branch: default + nimbus-qa-string-user: + description: A feature for testing string pref-setting on the user branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-string-user + branch: user + nimbus-system: + description: | + Configuration of the Nimbus System in Android. + variables: + refresh-interval-foreground: + description: | + The minimum interval in minutes between fetching experiment + recipes in the foreground. + type: Int + default: 60 + nimbus-validation: + description: A feature that does not correspond to an application feature suitable for showing that Nimbus is working. This should never be used in production. + variables: + settings-icon: + description: The drawable displayed in the app menu for Settings + type: String + default: mozac_ic_settings + settings-punctuation: + description: The emoji displayed in the Settings screen title. + type: String + default: '' + settings-title: + description: The title of displayed in the Settings screen and app menu. + type: Text + default: browser_menu_settings + oled-theme: + description: Feature to provide the OLED theme option for users on Firefox for Android. + variables: + enabled: + description: If true, the OLED theme option is shown. + type: Boolean + default: false + onboarding: + description: A feature that configures the new user onboarding page. Note that onboarding is a **first run** feature, and should only be modified by first run experiments. + variables: + order: + description: Determines the order of the onboarding page panels + type: List + default: + - themes + - toolbar-placement + - sync + - tcp + - privacy-notice + one-click-search: + description: Enable/disable the one click search feature. + variables: + enabled: + description: If true, the one click search will be enabled. + type: Boolean + default: false + pdf-viewer: + description: Feature for the PDF viewer tools for users on Firefox for Android. + variables: + android-ui-tools: + description: If true, the Android PDF UI tools are shown. + type: Boolean + default: false + pdfjs: + description: PDF.js features + variables: + download-button: + description: Download button + type: Boolean + default: true + open-in-app-button: + description: Open in app button + type: Boolean + default: true + pki: + description: Certificate verification configuration + variables: + certificateTransparencyMode: + description: | + What mode Certificate Transparency is in (0=disable, 1=telemetry only, 2=enforce). + type: Option + default: null + crliteChannel: + description: | + The channel from which CRLite filters will be installed. + type: Option + default: null + pqcrypto: + description: Control the use of post-quantum key exchange mechanisms in TLS and HTTP/3. + variables: + postQuantumKeyExchangeEnabled: + description: | + Toggles the security.tls.enable_kyber and network.http.http3.enable_kyber preferences. + type: Option + default: null + private-browsing-lock: + description: Allows enabling and disabling the private browsing mode lock via an authentication screen. + variables: + enabled: + description: | + Whether or not to enable private browsing mode lock. + type: Boolean + default: true + private-mode-and-stories-entry-point: + description: Feature to enable the Private Mode and Stories Entry Point Experiment. + variables: + enabled: + description: If true, Private Mode and Stories Entry Point Experiment is enabled. + type: Boolean + default: true + remote-search-configuration: + description: Feature to use search configurations from remote servers. + variables: + enabled: + description: | + Uses search configuration from remote servers . + type: Boolean + default: true + remote-tab-management: + description: | + Features that let users manage tabs on other devices that are connected to the same Mozilla account. + variables: + close-tabs-enabled: + description: | + Whether the feature to close synced tabs is enabled. When enabled, this device will allow other devices to close tabs that are open on this device, and show a "close" button for tabs that are currently open on other supported devices in the synced tabs tray. + type: Boolean + default: true + safe-browsing-real-time: + description: Control Safe Browsing real-time lookup and simulation. + variables: + feature-enabled: + description: If true, this feature is enabled and the below settings override the Gecko defaults. Otherwise, the Gecko defaults are used. + type: Boolean + default: false + global-cache-enabled: + description: Enables / disables the Safe Browsing Global Cache. + type: Boolean + default: false + real-time-enabled: + description: Enables / disables Safe Browsing real-time lookup. + type: Boolean + default: false + simulation-cache-ttl-sec: + description: Cache TTL in seconds for the real-time request simulator. + type: Int + default: 300 + simulation-enabled: + description: Enables / disables the real-time request simulator. + type: Boolean + default: false + simulation-hit-probability: + description: Hit probability for the real-time request simulator. + type: Int + default: 5 + simulation-negative-cache-enabled: + description: Enables / disables the negative cache for the real-time request simulator. + type: Boolean + default: false + simulation-negative-cache-ttl-sec: + description: Negative cache TTL in seconds for the real-time request simulator. + type: Int + default: 300 + safe-browsing-v5: + description: Control Safe Browsing V5. + variables: + enable-v5: + description: Enables / disables the SafeBrowsing V5 protocol. + type: Boolean + default: false + feature-enabled: + description: If true, this feature is enabled. Otherwise, we follow the SafeBrowsing V5 enabled pref. + type: Boolean + default: false + same-document-navigation-overrides-load-type: + description: Control whether the same document navigation overrides the load type. + variables: + enabled: + description: | + Overrides the loadType when it is a same document navigation + type: Boolean + default: false + force-disable-uri: + description: | + Disable overriding the loadType during same document navigation on the domain specified by this URI. + type: String + default: '' + search-extra-params: + description: A feature that provides additional args for search. + variables: + channel-id: + description: The channel Id param name with arg. + type: Map + default: {} + enabled: + description: If true, the feature is active. + type: Boolean + default: false + feature-enabler: + description: The feature enabler param name with arg, NOTE this map could be empty. + type: Map + default: {} + search-engine: + description: The search engine name. + type: String + default: '' + search-optimization-option: + description: Feature to enable the Search Optimization cards for users on Firefox on Android. + variables: + enabled: + description: If true, Search Optimization is enabled. + type: Boolean + default: false + show-flights-card: + description: If true, Search Optimization Flights cards are enabled. + type: Boolean + default: false + show-sports-card: + description: If true, Search Optimization Sports cards are enabled. + type: Boolean + default: false + show-stocks-card: + description: If true, Search Optimization Stock cards are enabled. + type: Boolean + default: false + sent-from-firefox: + description: A feature that allows the user to add a download firefox footer to a shared link. + variables: + download-link: + description: A store download link. + type: Text + default: '' + enabled: + description: If true, the feature is available for the user. + type: Boolean + default: false + show-snackbar: + description: If true, the user will see the snackbar after sharing a link, allowing quick navigation to settings. + type: Boolean + default: false + template-message: + description: A template for the shared message, supporting three placeholders. A shared link, the brand name and a store download link. + type: Text + default: '' + setup-checklist: + description: A feature on the home page that allows the user to track onboarding setup progress. + variables: + enabled: + description: If true, the setup checklist will be enabled. + type: Boolean + default: false + setup-checklist-type: + description: The collection used for the setup checklist. + type: SetupChecklistType + default: collection-1 + shake-to-summarize: + description: A feature that can summarize the content of a page when you shake the screen. + variables: + enabled: + description: If true, shake to summarize will be enabled + type: Boolean + default: true + splash-screen: + description: A feature that extends splash screen duration, allowing additional data fetching time for the app's initial run. + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + maximum_duration_ms: + description: The maximum amount of time in milliseconds the splashscreen will be visible while waiting for initialization calls to complete. + type: Int + default: 0 + off-train-onboarding: + description: If true, the fetched data will be applied and used during the session. + type: Boolean + default: false + suggest-shipped-domains: + description: Feature that suggests domains from the shipped domain list. + variables: + enabled: + description: | + Suggest domains from the shipped domain list. + type: Boolean + default: false + suppress-sponsored-top-sites: + description: Suppress sponsored top sites for new users for 14 days. + variables: + enabled: + description: If true, new users won’t see sponsored tiles for 14 days. + type: Boolean + default: false + tab-groups: + description: Control the visibility of the tab groups feature. + variables: + enabled: + description: | + Whether or not to enable the tab groups feature. + type: Boolean + default: true + tab-groups-drag-and-drop: + description: Control the visibility of drag and drop for tab groups. + variables: + enabled: + description: | + Whether or not to enable drag and drop for tab groups. + type: Boolean + default: true + tab-groups-live-reorder: + description: Control whether reorder happens live during a drag and drop action for Tab Groups. + variables: + enabled: + description: | + Whether or not to enable live reorder for tab groups drag and drop. + type: Boolean + default: false + tab-groups-onboarding: + description: Control the visibility of onboarding for tab groups. + variables: + enabled: + description: | + Whether or not to enable onboarding for tab groups. + type: Boolean + default: true + tab-management-enhancements: + description: Control the visibility of the tab management enhancements. + variables: + opening_animation_enabled: + description: Whether or not the Tab Manager opening animation is enabled. When enabled, a shared element transition will initiate, taking the currently-opened tab's thumbnail and shrinking it into its spot in the Tab Manager. + type: Boolean + default: true + tab-strip: + description: Enables tab strip. + variables: + allow-on-all-devices: + description: | + Experimental: When true, bypasses device restrictions and enables use on all devices. May cause instability or unexpected behavior. This still requires the feature to be `enabled`. + type: Boolean + default: false + enabled: + description: | + Whether or not to enable tab strip. + type: Boolean + default: true + terms-of-use-prompt: + description: Enables the terms of use prompt for users who have not accepted ToU + variables: + content-option: + description: Defines which content option should used for the prompt. + type: TermsOfUsePromptContentOption + default: value-0 + enable-drag-to-dismiss: + description: Whether to show a drag handle on the prompt and allows users to use it to dismiss the prompt. + type: Boolean + default: true + enabled: + description: When the feature is enabled then the prompt can show for users. + type: Boolean + default: false + max-display-count: + description: The maximum number of times to show the prompt. + type: Int + default: 2 + third-party-cookie-blocking: + description: Control third-party cookie blocking. + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + enabled-normal: + description: | + Enables / disables third-party cookie blocking in normal browsing mode. + type: Boolean + default: false + enabled-private: + description: | + Enables / disables third-party cookie blocking in private browsing mode. + type: Boolean + default: true + tracking-protection-experimentation: + description: Experimental controls for tracking protection behavior + variables: + defer-annotation-enabled: + description: Whether to defer tracking protection classification annotation until the data is being handled + type: Option + default: null + gecko-pref: + pref: privacy.trackingprotection.defer_annotation.enabled + branch: default + translations: + description: The feature that allows on-device translations of web content. + variables: + downloads-enabled: + description: | + Show the global language model download options entry point for translations. ('Download languages' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-lang-settings-enabled: + description: | + Show the global language options entry point for automatically translating. ('Automatic Translation' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-settings-enabled: + description: | + Show the global settings entry point within the translations feature. ('Translation Settings' on the page settings view.) 'page-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-site-settings-enabled: + description: | + Show the global never translate this site options entry point for site management. ('Never translate these sites' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + main-flow-browser-menu-enabled: + description: | + Show the browser menu entry point into the translations feature. ('Translate Page' on browser menu.) + type: Boolean + default: true + main-flow-toolbar-enabled: + description: | + Show the primary toolbar entry point into the translations feature. (Translations icon on URL toolbar.) + type: Boolean + default: true + page-settings-enabled: + description: | + Show the page settings entry point within the translations feature. (Gear icon on the translations main flow page.) 'main-flow-toolbar-enabled' or 'main-flow-browser-menu-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + uninstall-survey: + description: Feature that controls the visibility and handling of the uninstall survey app shortcut. + variables: + enabled: + description: If true, the uninstall survey shortcut is enabled and visible. + type: Boolean + default: false + universal-edge-to-edge-wallpapers: + description: | + Extends non-default homepage wallpapers edge-to-edge and adapts the toolbar, navigation bar and system bars to them. + variables: + enabled: + description: | + Whether or not to enable the universal edge-to-edge wallpaper treatment. + type: Boolean + default: false + user-characteristics: + description: A feature for control user characteristic data collection + variables: + currentVersion: + description: The current collection version of the user characteristics. + type: Int + default: 0 + voice-search-in-display-mode: + description: Controls whether the voice search entry point is shown in the display-mode browser toolbar. + variables: + enabled: + description: If true, voice search is shown in the display toolbar. + type: Boolean + default: true + webcompat-reporter-enhancements: + description: Feature to enable WebCompat Reporter enhancements for users on Firefox Android. + variables: + enabled: + description: If true, WebCompat Reporter enhancements is enabled. + type: Boolean + default: true +enums: + ControlMessageBehavior: + description: An enum to influence what should be displayed when a control message is selected. + variants: + show-next-message: + description: The next eligible message should be shown. + show-none: + description: The surface should show no message. + HomeScreenSection: + description: The identifiers for the sections of the homescreen. + variants: + bookmarks: + description: The sites the user has bookmarked. + collections: + description: The collections section of the homepage. + jump-back-in: + description: The tabs the user was looking immediately before being interrupted. + pocket: + description: The pocket section. This should only be available in the US. + pocket-sponsored-stories: + description: Subsection of the Pocket homescreen section which shows sponsored stories. + privacy-report: + description: The privacy report section showing trackers blocked. + recent-explorations: + description: The tab groups + synced-tabs: + description: The synced tabs section of the homepage. + top-sites: + description: The frecency and pinned sites. + MarketingCardVariant: + description: An enum to describe a marketing card variation. + variants: + default: + description: The default marketing card variation. + treatment-c: + description: The Treatment C marketing card variation. + MicrosurveyOrdering: + description: An enum to determine how to order the microsurvey answers. + variants: + pinned-randomized: + description: | + Answers with an ordering value greater than 0 are pinned to the top, in ascending order of that value. The remaining answers, with an ordering of 0, are shuffled below. E.g. 1 will be the first/top item, 2 will be next, followed by randomized 0s. + randomized: + description: The whole answer list is shuffled. Ordering values are ignored. + OnboardingCardType: + description: An enum to describe a type of card. + variants: + add-search-widget: + description: Allows user to add search widget to homescreen. + default-browser: + description: Allows user to set Firefox as the default browser. + marketing-data: + description: Allows user to opt out of marketing data collection. + notification-permission: + description: Allows user to enable notification permission. + sync-sign-in: + description: Allows user to sync with a Firefox account. + terms-of-service: + description: Page to display the terms of services. + toolbar-placement: + description: Allows user to choose the toolbar position. + OnboardingPanel: + description: The types of onboarding panels in the onboarding page + variants: + privacy-notice: + description: The onboarding panel where users can tap to view our privacy notice. + sync: + description: The onboarding panel where users can sign in to sync + tcp: + description: The onboarding panel where users can choose their total cookie protection settings + themes: + description: The themes onboarding panel where users pick themes + toolbar-placement: + description: The onboarding panel where users choose their toolbar placement (bottom or top) + OpeningScreenOption: + description: The types of different experiment branches for the opening screen. + variants: + homepage: + description: Uses the homepage as the opening screen. + homepage-four-hours: + description: Uses the homepage after four hours of inactivity as the opening screen. + last-tab: + description: Uses the last tab as the opening screen. + QueryParameterStrippingSection: + description: The identifiers for the options for the Query Parameter Stripping feature. + variants: + query-parameter-stripping: + description: An integer either 0 or 1 indicating if query parameter stripping should be enabled or disabled in normal mode. 0 for setting to be disabled, and 1 for enabling the setting. + query-parameter-stripping-allow-list: + description: An string separated by commas indicating the sites where should from query stripping should be exempted. + query-parameter-stripping-pmb: + description: An integer either 0 or 1 indicating if query parameter stripping should be enabled or disabled in private mode. 0 for setting to be disabled, and 1 for enabling the setting. + query-parameter-stripping-strip-list: + description: An string separated by commas indicating the list of query params to be stripped from URIs. This list will be merged with records coming from RemoteSettings. + SetupChecklistType: + description: An enum to represent the different experiment branches for the setup checklist. + variants: + collection-1: + description: The collection for the setup checklist that has 3 items. + collection-2: + description: The collection for the setup checklist that has 6 items. + SuggestionType: + description: The type of a Firefox Suggest search suggestion. + variants: + amp: + description: A Firefox Suggestion from adMarketplace. + ampMobile: + description: A firefox Suggestion from adMarketplace specifically for mobile. + wikipedia: + description: A Firefox Suggestion for a Wikipedia page. + TermsOfUsePromptContentOption: + description: | + Determines which predefined title and "learn more" strings are used for the Terms of Use prompt. + variants: + value-0: + description: | + Uses the current defaults: + - Title: "We've got an update" + - Learn more: "Please take a moment to review and accept. Learn more." + value-1: + description: | + Uses the following copy: + - Title: "Terms of Use" + - Learn more: "You can learn more here." + value-2: + description: | + Uses the following copy: + - Title: "A note from Firefox" + - Learn more: "You can learn more here." + ToolbarType: + description: An enum to describe a toolbar placement option. + variants: + toolbar-bottom: + description: Sets the toolbar placement on the bottom. + toolbar-top: + description: Sets the toolbar placement on the top. +objects: + CustomizationToolbarData: + description: An object to describe the placement of the toolbar. + fields: + image-res: + description: The resource id of toolbar placement image. + type: Image + default: ic_onboarding_customize_toolbar + label: + description: Display text for the toolbar placement option (e.g. "Top placement"). + type: Text + default: '' + toolbar-type: + description: The type of toolbar placement. + type: ToolbarType + default: toolbar-top + ExtraCardData: + description: Holds data for cards that require additional data, e.g. toolbar placement cards. + fields: + customization-toolbar-data: + description: | + An optional list of toolbar placements for the toolbar placement card. + type: List + default: [] + marketing-data: + description: | + An optional marketing data for the onboarding card. + type: Option + default: null + term-of-service-data: + description: | + An optional terms of service data for the onboarding card. + type: Option + default: null + GleanServerKnobsConfiguration: + description: A configuration object for Glean server knobs. + fields: + event_threshold: + description: The threshold of events that will be buffered before an events ping is collected and submitted. + type: Option + default: null + metrics_enabled: + description: A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric. + type: Map + default: {} + pings_enabled: + description: A map of ping names to booleans representing the state of the 'enabled' flag for that ping. + type: Map + default: {} + MarketingData: + description: An object to describe the marketing data onboarding card. + fields: + body-line-one-link-text: + description: The link text from line one of the body. + type: Text + default: '' + body-line-one-text: + description: The text for line one of the body. + type: Text + default: '' + body-line-three-text: + description: The text for line three of the body. + type: Text + default: '' + body-line-two-text: + description: The text for line two of the body. + type: Text + default: '' + marketing-card-variant: + description: Which marketing card variant to use. + type: MarketingCardVariant + default: default + MessageData: + description: | + An object to describe a message. It uses human readable strings to describe the triggers, action and style of the message as well as the text of the message and call to action. + fields: + action: + description: | + A URL of a page or a deeplink. This may have substitution variables in. + type: ActionName + default: OPEN_URL + action-params: + description: | + A string map containing query parameters that will be appended to the action URL. This is useful for opening URLs in tabs, or specifying that the tab should be private. The values may have substitutions, e.g. "url": "https://example.com/id={uuid}", "private": "true". + The params and their values are all determined downstream of the messaging component, by the embedding app's deeplink processing machinery. + type: Map + default: {} + button-label: + description: | + The text on the button. If no text is present, the whole message is clickable. + type: Option + default: null + exclude-if-any: + description: | + A list of strings corresponding to targeting expressions. The message will not be shown if any of the expressions are `true`. + type: List + default: [] + experiment: + description: The slug of the experiment that this message came from. + type: Option + default: null + is-control: + description: Indicates if this message is the control message, if true shouldn't be displayed + type: Boolean + default: false + microsurvey-config: + description: Optional configuration data for a microsurvey. + type: Option + default: null + style: + description: | + The style as described in a `StyleData` from the styles table. + type: StyleName + default: DEFAULT + surface: + description: The surface identifier for this message. + type: SurfaceName + default: homescreen + text: + description: The message text displayed to the user + type: Text + default: '' + title: + description: The title text displayed to the user + type: Option + default: null + trigger-if-all: + description: | + A list of strings corresponding to targeting expressions. The message will be shown if all expressions are `true`. + type: List + default: [] + MicrosurveyAnswer: + description: Attributes relating to microsurvey content. + fields: + ordering: + description: | + Used when answer-ordering-type is pinned-randomized to sequence answers with ordering values greater than 0 top to bottom. Answers with ordering values equal to 0 are shuffled below. E.g. 1 will be the first/top item, 2 will be next, followed by randomized 0s. + type: Int + default: 0 + text: + description: The text for the answer. + type: Text + default: '' + MicrosurveyConfig: + description: Attributes relating to microsurvey content. + fields: + answer-ordering-type: + description: The way answers are ordered. + type: MicrosurveyOrdering + default: randomized + answers: + description: The list of answers to present to the user e.g. "Satisfied, Dissatisfied...". + type: List + default: [] + icon: + description: The icon shown in the survey. + type: Option + default: null + max-number-lines: + description: The maximum number of lines allowed for the microsurvey text layout. + type: Int + default: 2 + utm-content: + description: Optional "utm_content" parameter for the privacy notice URL to specify the feature being surveyed. + type: Option + default: null + NotificationConfig: + description: Attributes controlling the global configuration of notification messages. + fields: + refresh-interval: + description: | + How often, in minutes, the notification message worker will wake up and check for new messages. + type: Int + default: 240 + OnboardingCardData: + description: An object to describe a user facing onboarding card. + fields: + body: + description: The message text displayed to the user. May contain linkable text. + type: Text + default: '' + card-type: + description: The type of the card. + type: OnboardingCardType + default: default-browser + disqualifiers: + description: | + A list of strings corresponding to targeting expressions. The card will not be shown if any expression is `true`. + type: List + default: + - NEVER + enabled: + description: If true, this card is shown to the user. + type: Boolean + default: true + extra-data: + description: Optional extra data for cards that require additional data. + type: Option + default: null + image-res: + description: The resource id of the image to be displayed. + type: Image + default: ic_onboarding_welcome + ordering: + description: Used to sequence the cards. + type: Int + default: 0 + prerequisites: + description: | + A list of strings corresponding to targeting expressions. The card will be shown if all expressions are `true` and if no expressions in the `disqualifiers` table are true, or if the `disqualifiers` table is empty. + type: List + default: + - ALWAYS + primary-button-label: + description: The text to display on the primary button. + type: Text + default: '' + secondary-button-label: + description: The text to display on the secondary button. + type: Text + default: '' + title: + description: The title text displayed to the user. + type: Text + default: '' + StyleData: + description: | + A group of properties (predominantly visual) to describe the style of the message. + fields: + max-display-count: + description: | + How many sessions will this message be shown to the user before it is expired. + type: Int + default: 5 + priority: + description: | + The importance of this message. 0 is not very important, 100 is very important. + type: Int + default: 50 + TermsOfServiceData: + description: An object to describe the terms of service onboarding card. + fields: + line-one-link-text: + description: The text for the link of line one. + type: Text + default: '' + line-one-link-url: + description: The url for the link of line one. + type: Text + default: '' + line-one-text: + description: The text for line one. + type: Text + default: '' + line-three-link-text: + description: The text for the link of line three. + type: Text + default: '' + line-three-text: + description: The text for line three. + type: Text + default: '' + line-two-link-text: + description: The text for the link of line two. + type: Text + default: '' + line-two-link-url: + description: The url for the link of line two. + type: Text + default: '' + line-two-text: + description: The text for line two. + type: Text + default: '' + subheader-one-text: + description: Optional text for the first subheader of the card. + type: Option + default: null + subheader-three-text: + description: Optional text for the third subheader of the card. + type: Option + default: null + subheader-two-text: + description: Optional text for the second subheader of the card. + type: Option + default: null diff --git a/experimenter/experimenter/features/manifests/fenix/v155.0.2/release.fml.yaml b/experimenter/experimenter/features/manifests/fenix/v155.0.2/release.fml.yaml new file mode 100644 index 0000000000..00f481bc94 --- /dev/null +++ b/experimenter/experimenter/features/manifests/fenix/v155.0.2/release.fml.yaml @@ -0,0 +1,1726 @@ +version: 1.0.0 +about: + description: Nimbus Feature Manifest for Fenix (Firefox Android) +channels: +- release +features: + add-shortcuts-improvement: + description: Feature to enable Add Shortcuts improvement for users on Firefox on Android. + variables: + enabled: + description: If true, Add Shortcuts improvement is enabled. + type: Boolean + default: true + ads-client-for-stories: + description: Feature to enable the Mozilla Ads Client support for Sponsored Stories for users on Firefox on Android. + variables: + enabled: + description: If true, Mozilla Ads Client support for Sponsored Stories is enabled. + type: Boolean + default: false + alternative-app-launcher-icon: + description: A feature that changes the app launcher icon background color. + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + reset-to-default: + description: | + If true use the default icon, if false use the alternative icon. This is required to 'reset' the icon for enrolled users once the initial experiment is complete. + type: Boolean + default: false + app-links: + description: Control behavior of app links handling in the browser. + variables: + show-new-prompt: + description: Whether to show the new AppLinksPromptFragment dialog when an app link is detected. If false, the old dialog is used. + type: Boolean + default: true + awesomebar-suggestion-provider: + description: Configuration for the Firefox Suggest awesomebar suggestion provider. + variables: + available-suggestion-types: + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + type: Map + default: + amp: true + ampMobile: false + wikipedia: true + baseline-fpp: + description: Control Baseline Fingerprinting Protection + variables: + enabled: + description: Enables / disables baseline fingerprinting protection. + type: Boolean + default: true + feat-enabled: + description: If true, the feature is active. + type: Boolean + default: false + overrides: + description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. + type: String + default: '' + collections-to-tab-groups-migration: + description: Feature to migrate Collections to Tab Groups for users on Firefox for Android. + variables: + hide-collections-ui: + description: If true, the Collections UI is hidden. + type: Boolean + default: false + continuous-onboarding: + description: | + Feature to enable the continuous onboarding flow. This feature reduces the number of upfront onboarding cards and distributes the cards and other prompts progressively over a number of days. + variables: + enabled: + description: If true, the feature is enabled. + type: Boolean + default: true + custom-review-prompt-ui: + description: Feature that controls the custom UI for review prompt. + variables: + enabled: + description: When enabled we show the custom review prompt UI. Otherwise we try to directly show the Play Store in-app review prompt. + type: Boolean + default: true + default-bottom-toolbar: + description: Default toolbar position for new users. + variables: + enabled: + description: | + Whether to default the toolbar position to bottom. + type: Boolean + default: false + default-browser-prompt: + description: Feature that controls when the default browser prompt is shown. + variables: + coldStartsBetweenPrompts: + description: The minimum number of cold starts between showing the prompt. + type: Option + default: 4 + daysBetweenPrompts: + description: The minimum number of days between showing the prompt. + type: Option + default: 14 + enabled: + description: Whether or not to enable the default browser prompt. + type: Boolean + default: true + maxPromptsShown: + description: The maximum number of times the prompt can shown to the user. + type: Option + default: 3 + default-expanded-toolbar: + description: Default expanded (bottom navigation) toolbar state for new users. + variables: + enabled: + description: | + Whether to default the expanded toolbar (bottom navigation bar with back/forward/share/bookmark/menu) to enabled. Only takes visible effect on tall, non-wide windows. + type: Boolean + default: false + doh: + description: Feature controlling DNS over HTTPS (DoH). + variables: + autoselect-enabled: + description: | + Controls the network.android_doh.autoselect_enabled pref and automatically chooses a DoH provider when Default Protection mode is selected. + type: Boolean + default: false + show-ui: + description: | + When `true`, include DoH settings in the settings UI. + type: Boolean + default: true + downloads-custom-location: + description: Feature to enable the custom download location for users on Firefox on Android. + variables: + enabled: + description: If true, custom download location is enabled. + type: Boolean + default: true + email-masks: + description: Feature to enable Email Mask for users on Firefox on Android. + variables: + enabled: + description: If true, Email Mask feature is enabled. + type: Boolean + default: true + enable-popups: + description: A feature that enables or disables in app popups + variables: + cfr-popups-enabled: + description: When true, CFR popups will show + type: Boolean + default: true + in-app-messages-enabled: + description: | + Enables non-CFR in-app messaging surfaces. Currently includes: - Wallpaper onboarding bottom sheet - PWA onboarding ("Add to Home screen") dialog - "Open links in apps" banner + type: Boolean + default: true + fingerprinting-protection: + description: Control Fingerprinting Protection + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + enabled-normal: + description: | + Enables / disables fingerprinting protection in normal browsing mode. + type: Boolean + default: false + enabled-private: + description: | + Enables / disables fingerprinting protection in private browsing mode. + type: Boolean + default: true + fdlibm-math: + description: | + Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy + type: Boolean + default: false + overrides: + description: | + The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. + type: String + default: '' + firefox-jp-guide-default-site: + description: | + This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + fission: + description: The feature that controls whether fission is enabled or not in Gecko. + variables: + enabled: + description: | + Whether or not to enable fission. Fission is enabled when set to true. Fission is disabled when set to false. + type: Boolean + default: false + isolationStrategy: + description: | + The web content isolation strategy to use with fission. "0" means "isolate nothing", similar to non-fission behavior. "1" means "isolate everything", where every site-origin gets its own process. "2" means "isolate high value", Android-specific setting to only isolate sites considered "high value". + type: Int + default: 0 + shouldUseNimbus: + description: | + If true, the values for both SHIP and Fission set in this file apply. Otherwise, the values from modules/libpref/init/StaticPrefList.yaml apply. + type: Boolean + default: false + fx-suggest: + description: A feature that provides Firefox Suggest search suggestions. + variables: + boost-amp-wiki: + description: | + The feature boost wiki and AMP suggestions to the top of its group. + type: Boolean + default: false + enabled: + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. + type: Boolean + default: false + gecko-nimbus-validation: + description: Feature for validating Nimbus Gecko functionality + variables: + test-preference: + description: A test gecko preference + type: Option + default: null + gecko-pref: + pref: gecko.nimbus.test + branch: default + test-preference-2: + description: A second test gecko preference + type: Option + default: null + gecko-pref: + pref: gecko.nimbus.test.two + branch: user + glean: + description: A feature that provides server-side configurations for Glean metrics (aka Server Knobs). + variables: + delay-ping-lifetime-io: + description: Glean will delay io for ping lifetime metrics + type: Boolean + default: true + enable-event-timestamps: + description: Enables precise event timestamps for Glean events + type: Boolean + default: true + gleanMetricConfiguration: + description: Configuration for Glean Server Knobs + type: GleanServerKnobsConfiguration + default: + event_threshold: null + metrics_enabled: {} + pings_enabled: {} + ping-lifetime-max-time: + description: After what time to auto-flush + type: Int + default: 2000 + ping-lifetime-threshold: + description: Write count threshold when to auto-flush + type: Int + default: 1000 + allow-coenrollment: true + google-lens-integration: + description: A feature that enables Google Lens integration for users on Firefox on Android. + variables: + enabled: + description: If true, Google Lens integration is enabled. + type: Boolean + default: false + homepage-as-new-tab: + description: Enables homepage as a a new tab. + variables: + enabled: + description: | + Whether or not to enable homepage as a new tab + type: Boolean + default: false + homepage-customization: + description: Feature to enable Homepage Customization for users on Firefox on Android. + variables: + enabled: + description: If true, Homepage Customization is enabled. + type: Boolean + default: false + homepage-hide-frecent-top-sites: + description: Hides frecent top sites on the homepage. + variables: + enabled: + description: | + Whether or not to hide frecent top sites on the homepage. + type: Boolean + default: false + homepage-opening-screen-default: + description: Configure the default option for the homepage opening screen. + variables: + default-option: + description: The default option for the homepage opening screen. + type: OpeningScreenOption + default: homepage-four-hours + homepage-trending-recent-search: + description: Feature to show trending and recent searches on the Homepage Search for users on Firefox on Android. + variables: + enabled: + description: If true, trending and recent searches are shown on the Homepage Search. + type: Boolean + default: false + homepage-weather-widget: + description: Feature to enable Homepage Weather Widget for users on Firefox for Android. + variables: + enabled: + description: If true, Homepage Weather Widget is enabled. + type: Boolean + default: false + homescreen: + description: The homescreen that the user goes to when they press home or new tab. + variables: + sections-enabled: + description: This property provides a lookup table of whether or not the given section should be enabled. If the section is enabled, it should be toggleable in the settings screen, and on by default. + type: Map + default: + top-sites: true + jump-back-in: true + bookmarks: true + recent-explorations: true + pocket: true + pocket-sponsored-stories: true + synced-tabs: true + collections: true + privacy-report: true + homescreen-edge-to-edge-background: + description: | + Feature that sets an edge to edge background on the Home Screen if the user hasn't selected a custom wallpaper + variables: + enabled: + description: Enables the feature + type: Boolean + default: true + import-bookmarks: + description: A feature that lets users import bookmarks from another browser. + variables: + enabled: + description: If true, the import bookmarks feature will be enabled. + type: Boolean + default: false + ip-protection: + description: Feature to enable IP Protection (VPN) for users on Firefox on Android. + variables: + allowed-regions: + description: Country codes whose users are eligible for IP Protection. + type: List + default: + - AU + - AT + - BE + - BG + - CA + - CL + - CO + - DK + - FI + - FR + - DE + - IE + - IT + - JP + - MY + - MX + - NL + - NZ + - NO + - PL + - PT + - RO + - SG + - ZA + - ES + - SE + - CH + - TH + - GB + - US + data-limit-gigabyte: + description: Specifies the VPN data limit for unpaid users in GB (e.g. 50 GB). + type: Int + default: 50 + enabled: + description: If true, IP Protection feature is enabled. + type: Boolean + default: false + promo-deadline: + description: The final date for the promotion to end. This needs to be an ISO 8601 formatted date (i.e. YYYY-MM-DD). + type: String + default: 2026-08-31 + show-beta-badge: + description: If true, a BETA badge is shown next to the IP Protection entry in the settings list. + type: Boolean + default: true + show-onboarding-bottom-sheet: + description: If true, the IP Protection onboarding bottom sheet is shown to the user. + type: Boolean + default: true + isolated-content-processes: + description: Feature that controls content process isolation. + variables: + app-zygote-preloading: + description: | + Whether or not to enable app Zygote preloaded isolated content processes. + type: Boolean + default: false + enabled: + description: | + Whether or not to enable isolated content processes. + type: Boolean + default: false + javascript: + description: Enables Javascript Engine (Spidermonkey) features + variables: + parallelMarkingEnabled: + description: | + Enables or disables javascript.options.mem.gc_parallel_marking preference. + type: Boolean + default: false + juno-onboarding: + description: A feature that shows the onboarding flow. + variables: + cards: + description: Collection of user facing onboarding cards. + type: Map + default: + terms-of-service: + body: '' + card-type: terms-of-service + disqualifiers: + - NEVER + enabled: true + extra-data: + term-of-service-data: + subheader-one-text: nova_onboarding_tou_subtitle + line-one-text: nova_onboarding_tou_body_line_1 + line-one-link-text: nova_onboarding_tou_body_line_1_link_text + line-two-text: nova_onboarding_tou_body_line_2 + line-two-link-text: nova_onboarding_tou_body_line_2_link_text + line-three-text: nova_onboarding_tou_body_line_3 + line-three-link-text: nova_onboarding_tou_body_line_3_link_text + image-res: nova_onboarding_tou + ordering: 1 + prerequisites: + - ALWAYS + primary-button-label: nova_onboarding_continue_button + secondary-button-label: '' + title: onboarding_welcome_to_firefox + default-browser: + body: nova_onboarding_set_to_default_subtitle + card-type: default-browser + disqualifiers: + - NEVER + enabled: true + extra-data: null + image-res: nova_onboarding_set_to_default + ordering: 10 + prerequisites: + - ALWAYS + primary-button-label: nova_onboarding_set_to_default_button + secondary-button-label: nova_onboarding_negative_button + title: nova_onboarding_set_to_default_title_2 + marketing: + body: '' + card-type: marketing-data + disqualifiers: + - NEVER + enabled: true + extra-data: + marketing-data: + body-line-one-text: nova_onboarding_marketing_body_2 + body-line-one-link-text: nova_onboarding_marketing_body_link_text + image-res: nova_onboarding_marketing + ordering: 20 + prerequisites: + - ALWAYS + primary-button-label: nova_onboarding_continue_button + secondary-button-label: nova_onboarding_marketing_secondary_button_text + title: nova_onboarding_marketing_title + string-alias: OnboardingCardKey + conditions: + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + string-alias: ConditionName + lna-blocking: + description: Feature that allows blocking local network or device access. + variables: + block-insecure-contexts: + description: | + Whether or not LNA requests coming from insecure contexts should be blocked outright, without prompting the user for permission + type: Option + default: null + gecko-pref: + pref: network.lna.block_insecure_contexts + branch: default + block-trackers: + description: | + Whether or not to block trackers + type: Boolean + default: false + blocking: + description: | + Whether or not to block LNA requests + type: Boolean + default: false + enabled: + description: | + Whether or not to turn on local network / device access blocking + type: Boolean + default: false + longfox: + description: Flag to enable Longfox for users on Firefox Android. + variables: + enabled: + description: If true, users will see a CTA for launching Longfox on the home screen. + type: Boolean + default: false + marketing-onboarding-card: + description: A temporary feature to control the marketing onboarding card shown during the onboarding flow. + variables: + enabled: + description: If false, the marketing onboarding card will never be shown. + type: Boolean + default: true + media-notification-improvements: + description: Whether to show the media notification improvements + variables: + enabled: + description: enabled media notification improvements if true, else not enabled + type: Boolean + default: false + merino-client: + description: Feature to enable the Merino Client for users on Firefox on Android. + variables: + enabled: + description: If true, Merino Client is enabled. + type: Boolean + default: false + messaging: + description: | + The in-app messaging system. + variables: + $$experiment: + description: The only acceptable value for `MessageData#experiment`. This should not be set by experiment. + type: ExperimentSlug + default: '{experiment}' + string-alias: ExperimentSlug + $$surfaces: + description: | + A list available surfaces for this app. + + This should not be written to by experiments, and should be hidden to users. + type: List + default: + - homescreen + - notification + - survey + - microsurvey + string-alias: SurfaceName + actions: + description: A growable map of action URLs. + type: Map + default: + OPEN_URL: ://open + ENABLE_PRIVATE_BROWSING: ://enable_private_browsing + INSTALL_SEARCH_WIDGET: ://install_search_widget + MAKE_DEFAULT_BROWSER: ://make_default_browser + VIEW_BOOKMARKS: ://urls_bookmarks + VIEW_COLLECTIONS: ://home_collections + VIEW_HISTORY: ://urls_history + VIEW_HOMESCREEN: ://home + OPEN_SETTINGS_ACCESSIBILITY: ://settings_accessibility + OPEN_SETTINGS_ADDON_MANAGER: ://settings_addon_manager + OPEN_SETTINGS_AI_CONTROLS: ://settings_ai_controls + OPEN_SETTINGS_DELETE_BROWSING_DATA: ://settings_delete_browsing_data + OPEN_SETTINGS_LOGINS: ://settings_logins + OPEN_SETTINGS_NOTIFICATIONS: ://settings_notifications + OPEN_SETTINGS_MARKETING_NOTIFICATIONS: ://settings_marketing_notifications + OPEN_SETTINGS_PRIVACY: ://settings_privacy + OPEN_SETTINGS_SEARCH_ENGINE: ://settings_search_engine + OPEN_SETTINGS_TRACKING_PROTECTION: ://settings_tracking_protection + OPEN_SETTINGS_WALLPAPERS: ://settings_wallpapers + OPEN_SETTINGS_APP_ICON: ://settings_app_icon + OPEN_SETTINGS: ://settings + OPEN_SHARE_SHEET: ://share_sheet + OPEN_PROTECTIONS_DASHBOARD: ://protections_dashboard + TURN_ON_SYNC: ://turn_on_sync + string-alias: ActionName + message-under-experiment: + description: Deprecated in favor of `MessageData#experiment`. This will be removed in future releases. + type: Option + default: null + messages: + description: A growable collection of messages + type: Map + default: + default-browser: + title: default_browser_experiment_card_title + text: default_browser_experiment_card_text + surface: homescreen + action: MAKE_DEFAULT_BROWSER + trigger-if-all: + - USER_ESTABLISHED_INSTALL + - ANDROID_API_BELOW_29 + exclude-if-any: + - I_AM_DEFAULT_BROWSER + style: PERSISTENT + button-label: preferences_set_as_default_browser + default-browser-notification: + title: nimbus_notification_default_browser_title + text: nimbus_notification_default_browser_text + surface: notification + style: NOTIFICATION + trigger-if-all: + - DAY_3_AFTER_INSTALL + exclude-if-any: + - I_AM_DEFAULT_BROWSER + action: MAKE_DEFAULT_BROWSER + string-alias: MessageKey + notification-config: + description: Configuration of the notification worker for all notification messages. + type: NotificationConfig + default: + refresh-interval: 240 + on-control: + description: What should be displayed when a control message is selected. + type: ControlMessageBehavior + default: show-next-message + styles: + description: | + A map of styles to configure message appearance. + type: Map + default: + DEFAULT: + priority: 50 + max-display-count: 5 + SURVEY: + priority: 55 + max-display-count: 1 + PERSISTENT: + priority: 50 + max-display-count: 20 + WARNING: + priority: 60 + max-display-count: 10 + URGENT: + priority: 100 + max-display-count: 10 + NOTIFICATION: + priority: 50 + max-display-count: 1 + MICROSURVEY: + priority: 50 + max-display-count: 5 + string-alias: StyleName + triggers: + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + type: Map + default: + USER_ESTABLISHED_INSTALL: number_of_app_launches >=4 + ANDROID_API_BELOW_29: android_version < 29 + USER_RECENTLY_INSTALLED: days_since_install < 7 + USER_RECENTLY_UPDATED: days_since_update < 7 && days_since_install != days_since_update + USER_TIER_ONE_COUNTRY: ('US' in locale || 'GB' in locale || 'CA' in locale || 'DE' in locale || 'FR' in locale) + USER_EN_SPEAKER: '''en'' in locale' + USER_ES_SPEAKER: '''es'' in locale' + USER_DE_SPEAKER: '''de'' in locale' + USER_FR_SPEAKER: '''fr'' in locale' + DEVICE_ANDROID: os == 'Android' + DEVICE_IOS: os == 'iOS' + ALWAYS: 'true' + NEVER: 'false' + DAY_1_AFTER_INSTALL: days_since_install == 1 + DAY_2_AFTER_INSTALL: days_since_install == 2 + DAY_3_AFTER_INSTALL: days_since_install == 3 + DAY_4_AFTER_INSTALL: days_since_install == 4 + DAY_5_AFTER_INSTALL: days_since_install == 5 + MORE_THAN_24H_SINCE_INSTALLED_OR_UPDATED: days_since_update >= 1 + I_AM_DEFAULT_BROWSER: is_default_browser + I_AM_NOT_DEFAULT_BROWSER: is_default_browser == false + NOTIFICATIONS_ARE_ENABLED: are_notifications_enabled == true + NOTIFICATIONS_ARE_DISABLED: are_notifications_enabled == false + MARKETING_NOTIFICATIONS_ARE_ENABLED: are_marketing_notifications_enabled == true + MARKETING_NOTIFICATIONS_ARE_DISABLED: are_marketing_notifications_enabled == false + FUNNEL_PAID: adjust_campaign != '' + FUNNEL_ORGANIC: adjust_campaign == '' + INACTIVE_1_DAY: '''app_opened''|eventLastSeen(''Hours'') >= 24' + INACTIVE_2_DAYS: '''app_opened''|eventLastSeen(''Days'', 0) >= 2' + INACTIVE_3_DAYS: '''app_opened''|eventLastSeen(''Days'', 0) >= 3' + INACTIVE_4_DAYS: '''app_opened''|eventLastSeen(''Days'', 0) >= 4' + INACTIVE_5_DAYS: '''app_opened''|eventLastSeen(''Days'', 0) >= 5' + RECENTLY_PRINTED: '''print_tapped''|eventLastSeen(''Hours'') <= 24' + SECOND_HOMEPAGE_VIEW: '''home_screen_displayed''|eventSum(''Years'', 4, 0) >= 2' + PERFORMED_A_SEARCH_AGAIN_RECENTLY: '''performed_search''|eventSum(''Years'', 4, 0) >= 2 && ''performed_search''|eventLastSeen(''Minutes'') < 1' + FXA_CURRENTLY_SIGNED_IN: is_fxa_signed_in == true + FXA_MORE_THAN_1_DEVICE: fxa_connected_devices > 1 + FXA_SIGNED_IN: '''sync_auth.sign_in''|eventLastSeen(''Years'', 0) <= 4' + FXA_NOT_SIGNED_IN: '''sync_auth.sign_in''|eventLastSeen(''Years'', 0) > 4' + USER_INFREQUENT: '''app_opened''|eventCountNonZero(''Days'', 28) >= 1 && ''app_opened''|eventCountNonZero(''Days'', 28) < 7' + USER_CASUAL: '''app_opened''|eventCountNonZero(''Days'', 28) >= 7 && ''app_opened''|eventCountNonZero(''Days'', 28) < 14' + USER_REGULAR: '''app_opened''|eventCountNonZero(''Days'', 28) >= 14 && ''app_opened''|eventCountNonZero(''Days'', 28) < 21' + USER_CORE_ACTIVE: '''app_opened''|eventCountNonZero(''Days'', 28) >= 21' + LAUNCHED_ONCE_THIS_WEEK: '''app_opened''|eventSum(''Days'', 7) == 1' + string-alias: TriggerName + allow-coenrollment: true + microsurveys: + description: Feature for microsurveys. + variables: + enabled: + description: | + When the feature is enabled then microsurveys can be used. + type: Boolean + default: false + minimal-addressbar: + description: Show a smaller height bottom addressbar with just the URL. + variables: + at-bottom-while-entering-text: + description: | + Whether to show the smaller height bottom addressbar with just the URL when entering text in a website. + type: Boolean + default: false + native-share-sheet: + description: Feature to enable the Native Share Sheet for users on Firefox on Android. + variables: + enabled: + description: If true, Native Share Sheet is enabled. + type: Boolean + default: false + networking-happy-eyeballs: + description: Networking (Necko) Happy Eyeballs V3 configuration + variables: + connection-attempt-delay: + description: Time in ms between successive connection attempts + type: Option + default: null + gecko-pref: + pref: network.http.happy_eyeballs_connection_attempt_delay + branch: default + enabled: + description: Whether to enable the Happy Eyeballs v3 algorithm for connection establishment + type: Option + default: null + gecko-pref: + pref: network.http.happy_eyeballs_enabled + branch: default + resolution-delay: + description: Time in ms to wait after the first DNS response before starting connections + type: Option + default: null + gecko-pref: + pref: network.http.happy_eyeballs_resolution_delay + branch: default + networkingBannedPorts: + description: Networking (Necko) Banned Ports + variables: + bannedPortList: + description: A comma-separated list of ports that Firefox will refuse to connect to. These ports will be appended to nsIOService gBadPortList + type: String + default: '' + nimbus-is-ready: + description: | + A feature that provides the number of Nimbus is_ready events to send when Nimbus finishes launching. + variables: + event-count: + description: The number of events that should be sent. + type: Int + default: 1 + nimbus-qa-bool-default: + description: A feature for testing boolean pref-setting on the default branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-bool-default + branch: default + nimbus-qa-bool-user: + description: A feature for testing boolean pref-setting on the user branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-bool-user + branch: user + nimbus-qa-int-default: + description: A feature for testing int pref-setting on the default branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-int-default + branch: default + nimbus-qa-int-user: + description: A feature for testing int pref-setting on the user branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-int-user + branch: user + nimbus-qa-string-default: + description: A feature for testing string pref-setting on the default branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-string-default + branch: default + nimbus-qa-string-user: + description: A feature for testing string pref-setting on the user branch. + variables: + value: + description: The value to set for the pref. + type: Option + default: null + gecko-pref: + pref: nimbus.qa.pref-string-user + branch: user + nimbus-system: + description: | + Configuration of the Nimbus System in Android. + variables: + refresh-interval-foreground: + description: | + The minimum interval in minutes between fetching experiment + recipes in the foreground. + type: Int + default: 60 + nimbus-validation: + description: A feature that does not correspond to an application feature suitable for showing that Nimbus is working. This should never be used in production. + variables: + settings-icon: + description: The drawable displayed in the app menu for Settings + type: String + default: mozac_ic_settings + settings-punctuation: + description: The emoji displayed in the Settings screen title. + type: String + default: '' + settings-title: + description: The title of displayed in the Settings screen and app menu. + type: Text + default: browser_menu_settings + oled-theme: + description: Feature to provide the OLED theme option for users on Firefox for Android. + variables: + enabled: + description: If true, the OLED theme option is shown. + type: Boolean + default: false + onboarding: + description: A feature that configures the new user onboarding page. Note that onboarding is a **first run** feature, and should only be modified by first run experiments. + variables: + order: + description: Determines the order of the onboarding page panels + type: List + default: + - themes + - toolbar-placement + - sync + - tcp + - privacy-notice + one-click-search: + description: Enable/disable the one click search feature. + variables: + enabled: + description: If true, the one click search will be enabled. + type: Boolean + default: false + pdf-viewer: + description: Feature for the PDF viewer tools for users on Firefox for Android. + variables: + android-ui-tools: + description: If true, the Android PDF UI tools are shown. + type: Boolean + default: false + pdfjs: + description: PDF.js features + variables: + download-button: + description: Download button + type: Boolean + default: true + open-in-app-button: + description: Open in app button + type: Boolean + default: true + pki: + description: Certificate verification configuration + variables: + certificateTransparencyMode: + description: | + What mode Certificate Transparency is in (0=disable, 1=telemetry only, 2=enforce). + type: Option + default: null + crliteChannel: + description: | + The channel from which CRLite filters will be installed. + type: Option + default: null + pqcrypto: + description: Control the use of post-quantum key exchange mechanisms in TLS and HTTP/3. + variables: + postQuantumKeyExchangeEnabled: + description: | + Toggles the security.tls.enable_kyber and network.http.http3.enable_kyber preferences. + type: Option + default: null + private-browsing-lock: + description: Allows enabling and disabling the private browsing mode lock via an authentication screen. + variables: + enabled: + description: | + Whether or not to enable private browsing mode lock. + type: Boolean + default: true + private-mode-and-stories-entry-point: + description: Feature to enable the Private Mode and Stories Entry Point Experiment. + variables: + enabled: + description: If true, Private Mode and Stories Entry Point Experiment is enabled. + type: Boolean + default: false + remote-search-configuration: + description: Feature to use search configurations from remote servers. + variables: + enabled: + description: | + Uses search configuration from remote servers . + type: Boolean + default: true + remote-tab-management: + description: | + Features that let users manage tabs on other devices that are connected to the same Mozilla account. + variables: + close-tabs-enabled: + description: | + Whether the feature to close synced tabs is enabled. When enabled, this device will allow other devices to close tabs that are open on this device, and show a "close" button for tabs that are currently open on other supported devices in the synced tabs tray. + type: Boolean + default: true + safe-browsing-real-time: + description: Control Safe Browsing real-time lookup and simulation. + variables: + feature-enabled: + description: If true, this feature is enabled and the below settings override the Gecko defaults. Otherwise, the Gecko defaults are used. + type: Boolean + default: false + global-cache-enabled: + description: Enables / disables the Safe Browsing Global Cache. + type: Boolean + default: false + real-time-enabled: + description: Enables / disables Safe Browsing real-time lookup. + type: Boolean + default: false + simulation-cache-ttl-sec: + description: Cache TTL in seconds for the real-time request simulator. + type: Int + default: 300 + simulation-enabled: + description: Enables / disables the real-time request simulator. + type: Boolean + default: false + simulation-hit-probability: + description: Hit probability for the real-time request simulator. + type: Int + default: 5 + simulation-negative-cache-enabled: + description: Enables / disables the negative cache for the real-time request simulator. + type: Boolean + default: false + simulation-negative-cache-ttl-sec: + description: Negative cache TTL in seconds for the real-time request simulator. + type: Int + default: 300 + safe-browsing-v5: + description: Control Safe Browsing V5. + variables: + enable-v5: + description: Enables / disables the SafeBrowsing V5 protocol. + type: Boolean + default: false + feature-enabled: + description: If true, this feature is enabled. Otherwise, we follow the SafeBrowsing V5 enabled pref. + type: Boolean + default: false + same-document-navigation-overrides-load-type: + description: Control whether the same document navigation overrides the load type. + variables: + enabled: + description: | + Overrides the loadType when it is a same document navigation + type: Boolean + default: false + force-disable-uri: + description: | + Disable overriding the loadType during same document navigation on the domain specified by this URI. + type: String + default: '' + search-extra-params: + description: A feature that provides additional args for search. + variables: + channel-id: + description: The channel Id param name with arg. + type: Map + default: {} + enabled: + description: If true, the feature is active. + type: Boolean + default: false + feature-enabler: + description: The feature enabler param name with arg, NOTE this map could be empty. + type: Map + default: {} + search-engine: + description: The search engine name. + type: String + default: '' + search-optimization-option: + description: Feature to enable the Search Optimization cards for users on Firefox on Android. + variables: + enabled: + description: If true, Search Optimization is enabled. + type: Boolean + default: false + show-flights-card: + description: If true, Search Optimization Flights cards are enabled. + type: Boolean + default: false + show-sports-card: + description: If true, Search Optimization Sports cards are enabled. + type: Boolean + default: false + show-stocks-card: + description: If true, Search Optimization Stock cards are enabled. + type: Boolean + default: false + sent-from-firefox: + description: A feature that allows the user to add a download firefox footer to a shared link. + variables: + download-link: + description: A store download link. + type: Text + default: '' + enabled: + description: If true, the feature is available for the user. + type: Boolean + default: false + show-snackbar: + description: If true, the user will see the snackbar after sharing a link, allowing quick navigation to settings. + type: Boolean + default: false + template-message: + description: A template for the shared message, supporting three placeholders. A shared link, the brand name and a store download link. + type: Text + default: '' + setup-checklist: + description: A feature on the home page that allows the user to track onboarding setup progress. + variables: + enabled: + description: If true, the setup checklist will be enabled. + type: Boolean + default: false + setup-checklist-type: + description: The collection used for the setup checklist. + type: SetupChecklistType + default: collection-1 + shake-to-summarize: + description: A feature that can summarize the content of a page when you shake the screen. + variables: + enabled: + description: If true, shake to summarize will be enabled + type: Boolean + default: true + splash-screen: + description: A feature that extends splash screen duration, allowing additional data fetching time for the app's initial run. + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + maximum_duration_ms: + description: The maximum amount of time in milliseconds the splashscreen will be visible while waiting for initialization calls to complete. + type: Int + default: 0 + off-train-onboarding: + description: If true, the fetched data will be applied and used during the session. + type: Boolean + default: false + suggest-shipped-domains: + description: Feature that suggests domains from the shipped domain list. + variables: + enabled: + description: | + Suggest domains from the shipped domain list. + type: Boolean + default: false + suppress-sponsored-top-sites: + description: Suppress sponsored top sites for new users for 14 days. + variables: + enabled: + description: If true, new users won’t see sponsored tiles for 14 days. + type: Boolean + default: false + tab-groups: + description: Control the visibility of the tab groups feature. + variables: + enabled: + description: | + Whether or not to enable the tab groups feature. + type: Boolean + default: false + tab-groups-drag-and-drop: + description: Control the visibility of drag and drop for tab groups. + variables: + enabled: + description: | + Whether or not to enable drag and drop for tab groups. + type: Boolean + default: false + tab-groups-live-reorder: + description: Control whether reorder happens live during a drag and drop action for Tab Groups. + variables: + enabled: + description: | + Whether or not to enable live reorder for tab groups drag and drop. + type: Boolean + default: false + tab-groups-onboarding: + description: Control the visibility of onboarding for tab groups. + variables: + enabled: + description: | + Whether or not to enable onboarding for tab groups. + type: Boolean + default: true + tab-management-enhancements: + description: Control the visibility of the tab management enhancements. + variables: + opening_animation_enabled: + description: Whether or not the Tab Manager opening animation is enabled. When enabled, a shared element transition will initiate, taking the currently-opened tab's thumbnail and shrinking it into its spot in the Tab Manager. + type: Boolean + default: false + tab-strip: + description: Enables tab strip. + variables: + allow-on-all-devices: + description: | + Experimental: When true, bypasses device restrictions and enables use on all devices. May cause instability or unexpected behavior. This still requires the feature to be `enabled`. + type: Boolean + default: false + enabled: + description: | + Whether or not to enable tab strip. + type: Boolean + default: true + terms-of-use-prompt: + description: Enables the terms of use prompt for users who have not accepted ToU + variables: + content-option: + description: Defines which content option should used for the prompt. + type: TermsOfUsePromptContentOption + default: value-0 + enable-drag-to-dismiss: + description: Whether to show a drag handle on the prompt and allows users to use it to dismiss the prompt. + type: Boolean + default: true + enabled: + description: When the feature is enabled then the prompt can show for users. + type: Boolean + default: false + max-display-count: + description: The maximum number of times to show the prompt. + type: Int + default: 2 + third-party-cookie-blocking: + description: Control third-party cookie blocking. + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + enabled-normal: + description: | + Enables / disables third-party cookie blocking in normal browsing mode. + type: Boolean + default: false + enabled-private: + description: | + Enables / disables third-party cookie blocking in private browsing mode. + type: Boolean + default: true + tracking-protection-experimentation: + description: Experimental controls for tracking protection behavior + variables: + defer-annotation-enabled: + description: Whether to defer tracking protection classification annotation until the data is being handled + type: Option + default: null + gecko-pref: + pref: privacy.trackingprotection.defer_annotation.enabled + branch: default + translations: + description: The feature that allows on-device translations of web content. + variables: + downloads-enabled: + description: | + Show the global language model download options entry point for translations. ('Download languages' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-lang-settings-enabled: + description: | + Show the global language options entry point for automatically translating. ('Automatic Translation' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-settings-enabled: + description: | + Show the global settings entry point within the translations feature. ('Translation Settings' on the page settings view.) 'page-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-site-settings-enabled: + description: | + Show the global never translate this site options entry point for site management. ('Never translate these sites' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + main-flow-browser-menu-enabled: + description: | + Show the browser menu entry point into the translations feature. ('Translate Page' on browser menu.) + type: Boolean + default: true + main-flow-toolbar-enabled: + description: | + Show the primary toolbar entry point into the translations feature. (Translations icon on URL toolbar.) + type: Boolean + default: true + page-settings-enabled: + description: | + Show the page settings entry point within the translations feature. (Gear icon on the translations main flow page.) 'main-flow-toolbar-enabled' or 'main-flow-browser-menu-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + uninstall-survey: + description: Feature that controls the visibility and handling of the uninstall survey app shortcut. + variables: + enabled: + description: If true, the uninstall survey shortcut is enabled and visible. + type: Boolean + default: false + universal-edge-to-edge-wallpapers: + description: | + Extends non-default homepage wallpapers edge-to-edge and adapts the toolbar, navigation bar and system bars to them. + variables: + enabled: + description: | + Whether or not to enable the universal edge-to-edge wallpaper treatment. + type: Boolean + default: false + user-characteristics: + description: A feature for control user characteristic data collection + variables: + currentVersion: + description: The current collection version of the user characteristics. + type: Int + default: 0 + voice-search-in-display-mode: + description: Controls whether the voice search entry point is shown in the display-mode browser toolbar. + variables: + enabled: + description: If true, voice search is shown in the display toolbar. + type: Boolean + default: false + webcompat-reporter-enhancements: + description: Feature to enable WebCompat Reporter enhancements for users on Firefox Android. + variables: + enabled: + description: If true, WebCompat Reporter enhancements is enabled. + type: Boolean + default: false +enums: + ControlMessageBehavior: + description: An enum to influence what should be displayed when a control message is selected. + variants: + show-next-message: + description: The next eligible message should be shown. + show-none: + description: The surface should show no message. + HomeScreenSection: + description: The identifiers for the sections of the homescreen. + variants: + bookmarks: + description: The sites the user has bookmarked. + collections: + description: The collections section of the homepage. + jump-back-in: + description: The tabs the user was looking immediately before being interrupted. + pocket: + description: The pocket section. This should only be available in the US. + pocket-sponsored-stories: + description: Subsection of the Pocket homescreen section which shows sponsored stories. + privacy-report: + description: The privacy report section showing trackers blocked. + recent-explorations: + description: The tab groups + synced-tabs: + description: The synced tabs section of the homepage. + top-sites: + description: The frecency and pinned sites. + MarketingCardVariant: + description: An enum to describe a marketing card variation. + variants: + default: + description: The default marketing card variation. + treatment-c: + description: The Treatment C marketing card variation. + MicrosurveyOrdering: + description: An enum to determine how to order the microsurvey answers. + variants: + pinned-randomized: + description: | + Answers with an ordering value greater than 0 are pinned to the top, in ascending order of that value. The remaining answers, with an ordering of 0, are shuffled below. E.g. 1 will be the first/top item, 2 will be next, followed by randomized 0s. + randomized: + description: The whole answer list is shuffled. Ordering values are ignored. + OnboardingCardType: + description: An enum to describe a type of card. + variants: + add-search-widget: + description: Allows user to add search widget to homescreen. + default-browser: + description: Allows user to set Firefox as the default browser. + marketing-data: + description: Allows user to opt out of marketing data collection. + notification-permission: + description: Allows user to enable notification permission. + sync-sign-in: + description: Allows user to sync with a Firefox account. + terms-of-service: + description: Page to display the terms of services. + toolbar-placement: + description: Allows user to choose the toolbar position. + OnboardingPanel: + description: The types of onboarding panels in the onboarding page + variants: + privacy-notice: + description: The onboarding panel where users can tap to view our privacy notice. + sync: + description: The onboarding panel where users can sign in to sync + tcp: + description: The onboarding panel where users can choose their total cookie protection settings + themes: + description: The themes onboarding panel where users pick themes + toolbar-placement: + description: The onboarding panel where users choose their toolbar placement (bottom or top) + OpeningScreenOption: + description: The types of different experiment branches for the opening screen. + variants: + homepage: + description: Uses the homepage as the opening screen. + homepage-four-hours: + description: Uses the homepage after four hours of inactivity as the opening screen. + last-tab: + description: Uses the last tab as the opening screen. + QueryParameterStrippingSection: + description: The identifiers for the options for the Query Parameter Stripping feature. + variants: + query-parameter-stripping: + description: An integer either 0 or 1 indicating if query parameter stripping should be enabled or disabled in normal mode. 0 for setting to be disabled, and 1 for enabling the setting. + query-parameter-stripping-allow-list: + description: An string separated by commas indicating the sites where should from query stripping should be exempted. + query-parameter-stripping-pmb: + description: An integer either 0 or 1 indicating if query parameter stripping should be enabled or disabled in private mode. 0 for setting to be disabled, and 1 for enabling the setting. + query-parameter-stripping-strip-list: + description: An string separated by commas indicating the list of query params to be stripped from URIs. This list will be merged with records coming from RemoteSettings. + SetupChecklistType: + description: An enum to represent the different experiment branches for the setup checklist. + variants: + collection-1: + description: The collection for the setup checklist that has 3 items. + collection-2: + description: The collection for the setup checklist that has 6 items. + SuggestionType: + description: The type of a Firefox Suggest search suggestion. + variants: + amp: + description: A Firefox Suggestion from adMarketplace. + ampMobile: + description: A firefox Suggestion from adMarketplace specifically for mobile. + wikipedia: + description: A Firefox Suggestion for a Wikipedia page. + TermsOfUsePromptContentOption: + description: | + Determines which predefined title and "learn more" strings are used for the Terms of Use prompt. + variants: + value-0: + description: | + Uses the current defaults: + - Title: "We've got an update" + - Learn more: "Please take a moment to review and accept. Learn more." + value-1: + description: | + Uses the following copy: + - Title: "Terms of Use" + - Learn more: "You can learn more here." + value-2: + description: | + Uses the following copy: + - Title: "A note from Firefox" + - Learn more: "You can learn more here." + ToolbarType: + description: An enum to describe a toolbar placement option. + variants: + toolbar-bottom: + description: Sets the toolbar placement on the bottom. + toolbar-top: + description: Sets the toolbar placement on the top. +objects: + CustomizationToolbarData: + description: An object to describe the placement of the toolbar. + fields: + image-res: + description: The resource id of toolbar placement image. + type: Image + default: ic_onboarding_customize_toolbar + label: + description: Display text for the toolbar placement option (e.g. "Top placement"). + type: Text + default: '' + toolbar-type: + description: The type of toolbar placement. + type: ToolbarType + default: toolbar-top + ExtraCardData: + description: Holds data for cards that require additional data, e.g. toolbar placement cards. + fields: + customization-toolbar-data: + description: | + An optional list of toolbar placements for the toolbar placement card. + type: List + default: [] + marketing-data: + description: | + An optional marketing data for the onboarding card. + type: Option + default: null + term-of-service-data: + description: | + An optional terms of service data for the onboarding card. + type: Option + default: null + GleanServerKnobsConfiguration: + description: A configuration object for Glean server knobs. + fields: + event_threshold: + description: The threshold of events that will be buffered before an events ping is collected and submitted. + type: Option + default: null + metrics_enabled: + description: A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric. + type: Map + default: {} + pings_enabled: + description: A map of ping names to booleans representing the state of the 'enabled' flag for that ping. + type: Map + default: {} + MarketingData: + description: An object to describe the marketing data onboarding card. + fields: + body-line-one-link-text: + description: The link text from line one of the body. + type: Text + default: '' + body-line-one-text: + description: The text for line one of the body. + type: Text + default: '' + body-line-three-text: + description: The text for line three of the body. + type: Text + default: '' + body-line-two-text: + description: The text for line two of the body. + type: Text + default: '' + marketing-card-variant: + description: Which marketing card variant to use. + type: MarketingCardVariant + default: default + MessageData: + description: | + An object to describe a message. It uses human readable strings to describe the triggers, action and style of the message as well as the text of the message and call to action. + fields: + action: + description: | + A URL of a page or a deeplink. This may have substitution variables in. + type: ActionName + default: OPEN_URL + action-params: + description: | + A string map containing query parameters that will be appended to the action URL. This is useful for opening URLs in tabs, or specifying that the tab should be private. The values may have substitutions, e.g. "url": "https://example.com/id={uuid}", "private": "true". + The params and their values are all determined downstream of the messaging component, by the embedding app's deeplink processing machinery. + type: Map + default: {} + button-label: + description: | + The text on the button. If no text is present, the whole message is clickable. + type: Option + default: null + exclude-if-any: + description: | + A list of strings corresponding to targeting expressions. The message will not be shown if any of the expressions are `true`. + type: List + default: [] + experiment: + description: The slug of the experiment that this message came from. + type: Option + default: null + is-control: + description: Indicates if this message is the control message, if true shouldn't be displayed + type: Boolean + default: false + microsurvey-config: + description: Optional configuration data for a microsurvey. + type: Option + default: null + style: + description: | + The style as described in a `StyleData` from the styles table. + type: StyleName + default: DEFAULT + surface: + description: The surface identifier for this message. + type: SurfaceName + default: homescreen + text: + description: The message text displayed to the user + type: Text + default: '' + title: + description: The title text displayed to the user + type: Option + default: null + trigger-if-all: + description: | + A list of strings corresponding to targeting expressions. The message will be shown if all expressions are `true`. + type: List + default: [] + MicrosurveyAnswer: + description: Attributes relating to microsurvey content. + fields: + ordering: + description: | + Used when answer-ordering-type is pinned-randomized to sequence answers with ordering values greater than 0 top to bottom. Answers with ordering values equal to 0 are shuffled below. E.g. 1 will be the first/top item, 2 will be next, followed by randomized 0s. + type: Int + default: 0 + text: + description: The text for the answer. + type: Text + default: '' + MicrosurveyConfig: + description: Attributes relating to microsurvey content. + fields: + answer-ordering-type: + description: The way answers are ordered. + type: MicrosurveyOrdering + default: randomized + answers: + description: The list of answers to present to the user e.g. "Satisfied, Dissatisfied...". + type: List + default: [] + icon: + description: The icon shown in the survey. + type: Option + default: null + max-number-lines: + description: The maximum number of lines allowed for the microsurvey text layout. + type: Int + default: 2 + utm-content: + description: Optional "utm_content" parameter for the privacy notice URL to specify the feature being surveyed. + type: Option + default: null + NotificationConfig: + description: Attributes controlling the global configuration of notification messages. + fields: + refresh-interval: + description: | + How often, in minutes, the notification message worker will wake up and check for new messages. + type: Int + default: 240 + OnboardingCardData: + description: An object to describe a user facing onboarding card. + fields: + body: + description: The message text displayed to the user. May contain linkable text. + type: Text + default: '' + card-type: + description: The type of the card. + type: OnboardingCardType + default: default-browser + disqualifiers: + description: | + A list of strings corresponding to targeting expressions. The card will not be shown if any expression is `true`. + type: List + default: + - NEVER + enabled: + description: If true, this card is shown to the user. + type: Boolean + default: true + extra-data: + description: Optional extra data for cards that require additional data. + type: Option + default: null + image-res: + description: The resource id of the image to be displayed. + type: Image + default: ic_onboarding_welcome + ordering: + description: Used to sequence the cards. + type: Int + default: 0 + prerequisites: + description: | + A list of strings corresponding to targeting expressions. The card will be shown if all expressions are `true` and if no expressions in the `disqualifiers` table are true, or if the `disqualifiers` table is empty. + type: List + default: + - ALWAYS + primary-button-label: + description: The text to display on the primary button. + type: Text + default: '' + secondary-button-label: + description: The text to display on the secondary button. + type: Text + default: '' + title: + description: The title text displayed to the user. + type: Text + default: '' + StyleData: + description: | + A group of properties (predominantly visual) to describe the style of the message. + fields: + max-display-count: + description: | + How many sessions will this message be shown to the user before it is expired. + type: Int + default: 5 + priority: + description: | + The importance of this message. 0 is not very important, 100 is very important. + type: Int + default: 50 + TermsOfServiceData: + description: An object to describe the terms of service onboarding card. + fields: + line-one-link-text: + description: The text for the link of line one. + type: Text + default: '' + line-one-link-url: + description: The url for the link of line one. + type: Text + default: '' + line-one-text: + description: The text for line one. + type: Text + default: '' + line-three-link-text: + description: The text for the link of line three. + type: Text + default: '' + line-three-text: + description: The text for line three. + type: Text + default: '' + line-two-link-text: + description: The text for the link of line two. + type: Text + default: '' + line-two-link-url: + description: The url for the link of line two. + type: Text + default: '' + line-two-text: + description: The text for line two. + type: Text + default: '' + subheader-one-text: + description: Optional text for the first subheader of the card. + type: Option + default: null + subheader-three-text: + description: Optional text for the third subheader of the card. + type: Option + default: null + subheader-two-text: + description: Optional text for the second subheader of the card. + type: Option + default: null diff --git a/experimenter/experimenter/features/manifests/fenix/v157.0.0/beta.fml.yaml b/experimenter/experimenter/features/manifests/fenix/v157.0.0/beta.fml.yaml index 5036759c6d..583721f682 100644 --- a/experimenter/experimenter/features/manifests/fenix/v157.0.0/beta.fml.yaml +++ b/experimenter/experimenter/features/manifests/fenix/v157.0.0/beta.fml.yaml @@ -60,17 +60,19 @@ features: description: Control Baseline Fingerprinting Protection variables: enabled: - description: Enables / disables baseline fingerprinting protection. - type: Boolean - default: true + description: | + Enables / disables baseline fingerprinting protection. Unset leaves the existing setting alone. + type: Option + default: null feat-enabled: - description: If true, the feature is active. + description: | + Deprecated and no longer read. Each of the values below is applied independently when a recipe supplies it; leaving a value unset means "leave the existing setting alone". type: Boolean default: false overrides: - description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. - type: String - default: '' + description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. Unset leaves the existing setting alone. + type: Option + default: null collections-to-tab-groups-migration: description: Feature to migrate Collections to Tab Groups for users on Firefox for Android. variables: @@ -175,19 +177,20 @@ features: description: Control Fingerprinting Protection variables: enabled: - description: If true, the feature is active. + description: | + Deprecated and no longer read. Each of the values below is applied independently when a recipe supplies it; leaving a value unset means "leave the existing setting alone". type: Boolean default: false enabled-normal: description: | - Enables / disables fingerprinting protection in normal browsing mode. - type: Boolean - default: false + Enables / disables fingerprinting protection in normal browsing mode. Unset leaves the existing setting alone. + type: Option + default: null enabled-private: description: | - Enables / disables fingerprinting protection in private browsing mode. - type: Boolean - default: true + Enables / disables fingerprinting protection in private browsing mode. Unset leaves the existing setting alone. + type: Option + default: null fdlibm-math: description: | Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy @@ -195,9 +198,9 @@ features: default: false overrides: description: | - The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. - type: String - default: '' + The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. Unset leaves the existing setting alone. + type: Option + default: null firefox-jp-guide-default-site: description: | This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut diff --git a/experimenter/experimenter/features/manifests/fenix/v157.0.0/developer.fml.yaml b/experimenter/experimenter/features/manifests/fenix/v157.0.0/developer.fml.yaml index 427192eceb..998f78ce04 100644 --- a/experimenter/experimenter/features/manifests/fenix/v157.0.0/developer.fml.yaml +++ b/experimenter/experimenter/features/manifests/fenix/v157.0.0/developer.fml.yaml @@ -60,17 +60,19 @@ features: description: Control Baseline Fingerprinting Protection variables: enabled: - description: Enables / disables baseline fingerprinting protection. - type: Boolean - default: true + description: | + Enables / disables baseline fingerprinting protection. Unset leaves the existing setting alone. + type: Option + default: null feat-enabled: - description: If true, the feature is active. + description: | + Deprecated and no longer read. Each of the values below is applied independently when a recipe supplies it; leaving a value unset means "leave the existing setting alone". type: Boolean default: false overrides: - description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. - type: String - default: '' + description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. Unset leaves the existing setting alone. + type: Option + default: null collections-to-tab-groups-migration: description: Feature to migrate Collections to Tab Groups for users on Firefox for Android. variables: @@ -175,19 +177,20 @@ features: description: Control Fingerprinting Protection variables: enabled: - description: If true, the feature is active. + description: | + Deprecated and no longer read. Each of the values below is applied independently when a recipe supplies it; leaving a value unset means "leave the existing setting alone". type: Boolean default: false enabled-normal: description: | - Enables / disables fingerprinting protection in normal browsing mode. - type: Boolean - default: false + Enables / disables fingerprinting protection in normal browsing mode. Unset leaves the existing setting alone. + type: Option + default: null enabled-private: description: | - Enables / disables fingerprinting protection in private browsing mode. - type: Boolean - default: true + Enables / disables fingerprinting protection in private browsing mode. Unset leaves the existing setting alone. + type: Option + default: null fdlibm-math: description: | Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy @@ -195,9 +198,9 @@ features: default: false overrides: description: | - The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. - type: String - default: '' + The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. Unset leaves the existing setting alone. + type: Option + default: null firefox-jp-guide-default-site: description: | This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut diff --git a/experimenter/experimenter/features/manifests/fenix/v157.0.0/experimenter.yaml b/experimenter/experimenter/features/manifests/fenix/v157.0.0/experimenter.yaml index 92bce2177a..cf8dc3d60c 100644 --- a/experimenter/experimenter/features/manifests/fenix/v157.0.0/experimenter.yaml +++ b/experimenter/experimenter/features/manifests/fenix/v157.0.0/experimenter.yaml @@ -59,13 +59,15 @@ baseline-fpp: variables: enabled: type: boolean - description: Enables / disables baseline fingerprinting protection. + description: | + Enables / disables baseline fingerprinting protection. Unset leaves the existing setting alone. feat-enabled: type: boolean - description: If true, the feature is active. + description: | + Deprecated and no longer read. Each of the values below is applied independently when a recipe supplies it; leaving a value unset means "leave the existing setting alone". overrides: type: string - description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. + description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. Unset leaves the existing setting alone. collections-to-tab-groups-migration: description: Feature to migrate Collections to Tab Groups for users on Firefox for Android. hasExposure: true @@ -177,15 +179,16 @@ fingerprinting-protection: variables: enabled: type: boolean - description: If true, the feature is active. + description: | + Deprecated and no longer read. Each of the values below is applied independently when a recipe supplies it; leaving a value unset means "leave the existing setting alone". enabled-normal: type: boolean description: | - Enables / disables fingerprinting protection in normal browsing mode. + Enables / disables fingerprinting protection in normal browsing mode. Unset leaves the existing setting alone. enabled-private: type: boolean description: | - Enables / disables fingerprinting protection in private browsing mode. + Enables / disables fingerprinting protection in private browsing mode. Unset leaves the existing setting alone. fdlibm-math: type: boolean description: | @@ -193,7 +196,7 @@ fingerprinting-protection: overrides: type: string description: | - The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. + The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. Unset leaves the existing setting alone. firefox-jp-guide-default-site: description: | This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut diff --git a/experimenter/experimenter/features/manifests/fenix/v157.0.0/nightly.fml.yaml b/experimenter/experimenter/features/manifests/fenix/v157.0.0/nightly.fml.yaml index 4a9582bab0..10a08c3cbd 100644 --- a/experimenter/experimenter/features/manifests/fenix/v157.0.0/nightly.fml.yaml +++ b/experimenter/experimenter/features/manifests/fenix/v157.0.0/nightly.fml.yaml @@ -60,17 +60,19 @@ features: description: Control Baseline Fingerprinting Protection variables: enabled: - description: Enables / disables baseline fingerprinting protection. - type: Boolean - default: true + description: | + Enables / disables baseline fingerprinting protection. Unset leaves the existing setting alone. + type: Option + default: null feat-enabled: - description: If true, the feature is active. + description: | + Deprecated and no longer read. Each of the values below is applied independently when a recipe supplies it; leaving a value unset means "leave the existing setting alone". type: Boolean default: false overrides: - description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. - type: String - default: '' + description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. Unset leaves the existing setting alone. + type: Option + default: null collections-to-tab-groups-migration: description: Feature to migrate Collections to Tab Groups for users on Firefox for Android. variables: @@ -175,19 +177,20 @@ features: description: Control Fingerprinting Protection variables: enabled: - description: If true, the feature is active. + description: | + Deprecated and no longer read. Each of the values below is applied independently when a recipe supplies it; leaving a value unset means "leave the existing setting alone". type: Boolean default: false enabled-normal: description: | - Enables / disables fingerprinting protection in normal browsing mode. - type: Boolean - default: false + Enables / disables fingerprinting protection in normal browsing mode. Unset leaves the existing setting alone. + type: Option + default: null enabled-private: description: | - Enables / disables fingerprinting protection in private browsing mode. - type: Boolean - default: true + Enables / disables fingerprinting protection in private browsing mode. Unset leaves the existing setting alone. + type: Option + default: null fdlibm-math: description: | Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy @@ -195,9 +198,9 @@ features: default: false overrides: description: | - The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. - type: String - default: '' + The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. Unset leaves the existing setting alone. + type: Option + default: null firefox-jp-guide-default-site: description: | This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut diff --git a/experimenter/experimenter/features/manifests/fenix/v157.0.0/release.fml.yaml b/experimenter/experimenter/features/manifests/fenix/v157.0.0/release.fml.yaml index d1eaf29ea5..1ccc558eb9 100644 --- a/experimenter/experimenter/features/manifests/fenix/v157.0.0/release.fml.yaml +++ b/experimenter/experimenter/features/manifests/fenix/v157.0.0/release.fml.yaml @@ -60,17 +60,19 @@ features: description: Control Baseline Fingerprinting Protection variables: enabled: - description: Enables / disables baseline fingerprinting protection. - type: Boolean - default: true + description: | + Enables / disables baseline fingerprinting protection. Unset leaves the existing setting alone. + type: Option + default: null feat-enabled: - description: If true, the feature is active. + description: | + Deprecated and no longer read. Each of the values below is applied independently when a recipe supplies it; leaving a value unset means "leave the existing setting alone". type: Boolean default: false overrides: - description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. - type: String - default: '' + description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. Unset leaves the existing setting alone. + type: Option + default: null collections-to-tab-groups-migration: description: Feature to migrate Collections to Tab Groups for users on Firefox for Android. variables: @@ -175,19 +177,20 @@ features: description: Control Fingerprinting Protection variables: enabled: - description: If true, the feature is active. + description: | + Deprecated and no longer read. Each of the values below is applied independently when a recipe supplies it; leaving a value unset means "leave the existing setting alone". type: Boolean default: false enabled-normal: description: | - Enables / disables fingerprinting protection in normal browsing mode. - type: Boolean - default: false + Enables / disables fingerprinting protection in normal browsing mode. Unset leaves the existing setting alone. + type: Option + default: null enabled-private: description: | - Enables / disables fingerprinting protection in private browsing mode. - type: Boolean - default: true + Enables / disables fingerprinting protection in private browsing mode. Unset leaves the existing setting alone. + type: Option + default: null fdlibm-math: description: | Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy @@ -195,9 +198,9 @@ features: default: false overrides: description: | - The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. - type: String - default: '' + The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. Unset leaves the existing setting alone. + type: Option + default: null firefox-jp-guide-default-site: description: | This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/.ref-cache.yaml b/experimenter/experimenter/features/manifests/firefox-desktop/.ref-cache.yaml index 2de7042cbf..3d7a02ee67 100644 --- a/experimenter/experimenter/features/manifests/firefox-desktop/.ref-cache.yaml +++ b/experimenter/experimenter/features/manifests/firefox-desktop/.ref-cache.yaml @@ -1,6 +1,6 @@ -beta: cd7d1d5e32180e2782d659d70b90dfe6fdd149aa -esr115: 681b53dc749e86fd7be4d69cec70fdc523e6b2cb +beta: ffbfcc25e77ea3427dd73ead95070777b00ed3b2 +esr115: e2baf3f6963d821bb13daf9e332826bbb4d9ae75 esr128: ed38f9209e39bd7ad247c81a7c20c99c874e0a62 esr140: 14f4f76ce85fa529f40465c64d38271ea7f26dfa -main: edfb027f321fd2584c8fd2df528e665b7f5b8dac -release: 576d9b07706419cebc9dcf9e9b463a2c3a0d4c7a +main: 0271096efe3ea9e8c9a5479f26774f1842ef0585 +release: c9eaf0ccb15b0ec83277bc961de46d9beed77451 diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/TargetingContextRecorder.sys.mjs b/experimenter/experimenter/features/manifests/firefox-desktop/TargetingContextRecorder.sys.mjs index cf7fb828e5..a4d2adfa91 100644 --- a/experimenter/experimenter/features/manifests/firefox-desktop/TargetingContextRecorder.sys.mjs +++ b/experimenter/experimenter/features/manifests/firefox-desktop/TargetingContextRecorder.sys.mjs @@ -2,9 +2,9 @@ * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ -const lazy = {}; +import { XPCOMUtils } from "resource://gre/modules/XPCOMUtils.sys.mjs"; -ChromeUtils.defineESModuleGetters(lazy, { +const lazy = XPCOMUtils.declareLazy({ ASRouterTargeting: // eslint-disable-next-line mozilla/no-browser-refs-in-toolkit "resource:///modules/asrouter/ASRouterTargeting.sys.mjs", @@ -227,6 +227,7 @@ export const PREFS = Object.freeze({ "browser.newtabpage.enabled": PREF_BOOL, "browser.profiles.created": PREF_BOOL, "browser.startup.page": PREF_INT, + "browser.tabs.splitview.hasUsed": PREF_BOOL, "browser.toolbars.bookmarks.visibility": PREF_STRING, "browser.urlbar.lastUrlbarSearchSeconds": PREF_INT, "browser.urlbar.showSearchSuggestionsFirst": PREF_BOOL, diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/experimenter.yaml b/experimenter/experimenter/features/manifests/firefox-desktop/experimenter.yaml index 317dfad131..98d6166248 100644 --- a/experimenter/experimenter/features/manifests/firefox-desktop/experimenter.yaml +++ b/experimenter/experimenter/features/manifests/firefox-desktop/experimenter.yaml @@ -2072,7 +2072,11 @@ pocketNewtab: fallbackPref: >- browser.newtabpage.activity-stream.discoverystream.ctaButtonVariant regionStoriesConfig: - description: A comma-separated list of region to get stories for. + description: >- + Legacy, superseded by the stories-region-locale-config pref, which the + newtab extension reads directly. A region listed here + gets stories in the locales it was historically paired with. Do not set + it in new recipes. type: string fallbackPref: >- browser.newtabpage.activity-stream.discoverystream.region-stories-config @@ -2082,15 +2086,10 @@ pocketNewtab: browser.newtabpage.activity-stream.discoverystream.merino-provider.endpoint description: Merino endpoint to use for recommendations. regionStoriesBlock: - description: A comma-separated list of regions that do not get stories, regardless of locale-list-config. + description: A comma-separated list of regions that do not get stories, regardless of the stories-region-locale-config pref. type: string fallbackPref: >- browser.newtabpage.activity-stream.discoverystream.region-stories-block - localeListConfig: - description: A comma-separated list of locales that get stories, regardless of region-stories-config. - type: string - fallbackPref: >- - browser.newtabpage.activity-stream.discoverystream.locale-list-config regionSpocsConfig: description: A comma-separated list of regions that get spocs by default. type: string @@ -2259,6 +2258,29 @@ autofill-ml: branch: default pref: extensions.formautofill.useml.modelVersion +# Deliberately a feature of its own rather than a variable of autofill-ml: a +# field type that turns out to be badly classified needs a rollout of its own, +# and Nimbus allows a single enrollment per feature. +autofill-ml-ignore-field-types: + description: Field types excluded from machine-learning based form field detection + owner: dlee@mozilla.com + hasExposure: false + variables: + ignoreFieldTypes: + type: string + setPref: + branch: default + pref: extensions.formautofill.useml.ignoreFieldTypes + description: >- + Comma separated list of field types (for example + "cc-exp, cc-exp-month, cc-exp-year"; spaces after the commas are + ignored) the ML model is not trusted with. Those types are classified + by the regular expression based heuristics instead, and any prediction + the model makes for one of them is discarded. List related field types + together, as in the example: the heuristics only try the rules of the + listed types, so leaving one out can let a broader rule win over the + more specific one it would normally lose to. + shellService: description: "Interface with OS, e.g., pinning and set default" owner: desktop-integrations@mozilla.com @@ -6229,3 +6251,15 @@ editContext: branch: default pref: dom.editcontext.enabled description: Whether the EditContext API is enabled. + +nova: + description: Nova UI + owner: dtownsend@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: browser.nova.enabled + description: Whether Nova is enabled. diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/TargetingContextRecorder.sys.mjs b/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/TargetingContextRecorder.sys.mjs new file mode 100644 index 0000000000..cf7fb828e5 --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/TargetingContextRecorder.sys.mjs @@ -0,0 +1,421 @@ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +const lazy = {}; + +ChromeUtils.defineESModuleGetters(lazy, { + ASRouterTargeting: + // eslint-disable-next-line mozilla/no-browser-refs-in-toolkit + "resource:///modules/asrouter/ASRouterTargeting.sys.mjs", + ClientID: "resource://gre/modules/ClientID.sys.mjs", + ExperimentAPI: "resource://nimbus/ExperimentAPI.sys.mjs", + NimbusFeatures: "resource://nimbus/ExperimentAPI.sys.mjs", + TargetingContext: "resource://messaging-system/targeting/Targeting.sys.mjs", +}); + +const { PREF_INVALID, PREF_STRING, PREF_INT, PREF_BOOL } = Ci.nsIPrefBranch; +const PREF_TYPES = Object.freeze({ + [PREF_STRING]: "Ci.nsIPrefBranch.PREF_STRING", + [PREF_INT]: "Ci.nsIPrefBranch.PREF_INT", + [PREF_BOOL]: "Ci.nsIPrefBranch.PREF_BOOL", +}); + +/** + * Return a function that returns specific keys of an object. + * + * All values will be awaited, so objects containing promises will be flattened + * into objects. + * + * Any exceptions encountered will not prevent the key from being recorded in + * the metric. + * + * @param {string[]} keys - The keys to include. + * @returns The function. + */ +function pick(...keys) { + const identity = x => x; + return pickWith(Object.fromEntries(keys.map(key => [key, identity]))); +} + +/** + * Return a function that returns a specific keys of an object, with transforms. + * + * All values will be awaited, as will their transform functions, so objects + * containing promises will be flattened into objects. + * + * Any exceptions encountered will not prevent the key from being recorded in + * the metric. + * + * @param {Record any>} shape + * A mapping of keys to transformation functions. + * + * @returns The function. + */ +function pickWith(shape) { + return async function (object) { + const transformed = {}; + if (typeof object !== "undefined" && object !== null) { + for (const [key, transform] of Object.entries(shape)) { + try { + transformed[key] = await transform(await object[key]); + } catch (ex) {} + } + } + return transformed; + }; +} + +/** + * Assert that the attribute matches the given type (via typeof). + * + * @param {string} expectedType + * The expected type. + * If the attribute is not of this type, this function will throw. + * @param {any} attribute + * The value whose type is to be checked. + * + * @returns The attribute. + */ +function assertType(expectedType, attribute) { + const type = typeof attribute; + + if (type !== expectedType) { + throw new Error(`Expected ${expectedType} but got ${type} instead`); + } + + return attribute; +} + +/** + * Transforms that assert that the type of the attribute matches an expected + * type. + */ +const typeAssertions = { + integer: attribute => + assertType("number", attribute) && Number.isSafeInteger(attribute), + string: attribute => assertType("string", attribute), + boolean: attribute => assertType("boolean", attribute), + quantity: attribute => Math.floor(assertType("number", attribute)), + array: attribute => { + if (!Array.isArray(attribute)) { + throw new Error(`Expected Array but got ${typeof attribute} instead`); + } + + return attribute; + }, + // NB: Date methods will throw if called on a non-Date object. We can't simply + // use `attribute instanceof Date` because the Date constructor might be from + // a different context (and thus the expression would evaluate to false). + date: attribute => Date.prototype.toUTCString.call(attribute), +}; + +/** + * This contains the set of all top-level targeting attributes in the Nimbus + * Targeting context and optional transforms functions that will be applied + * before the value is recorded. + */ +export const ATTRIBUTE_TRANSFORMS = Object.freeze({ + activeExperiments: typeAssertions.array, + activeRollouts: typeAssertions.array, + addonsInfo: addonsInfo => ({ + addons: Object.keys(addonsInfo?.addons ?? {}).sort(), + hasInstalledAddons: !!addonsInfo?.hasInstalledAddons, + }), + addressesSaved: typeAssertions.quantity, + archBits: typeAssertions.quantity, + attributionData: pick("medium", "source", "ua"), + browserSettings: pickWith({ + update: pick("channel"), + }), + buildId: typeAssertions.integer, + currentDate: typeAssertions.date, + defaultPDFHandler: pick("knownBrowser", "registered"), + distributionId: typeAssertions.string, + doesAppNeedPin: typeAssertions.boolean, + enrollmentsMap: enrollmentsMap => + Object.entries(enrollmentsMap).map(([experimentSlug, branchSlug]) => ({ + experimentSlug, + branchSlug, + })), + firefoxVersion: typeAssertions.quantity, + hasActiveEnterprisePolicies: typeAssertions.boolean, + hasPinnedTabs: typeAssertions.boolean, + homePageSettings: pick("isCustomUrl", "isDefault", "isLocked", "isWebExt"), + isDefaultHandler: pick("html", "pdf"), + isDefaultBrowser: typeAssertions.boolean, + isFirstStartup: typeAssertions.boolean, + isFxAEnabled: typeAssertions.boolean, + isFxASignedIn: typeAssertions.boolean, + isMSIX: typeAssertions.boolean, + launchOnLoginAllowedByPolicy: typeAssertions.boolean, + launchOnLoginEnabled: typeAssertions.boolean, + locale: typeAssertions.string, + memoryMB: typeAssertions.quantity, + os: pick( + "isLinux", + "isMac", + "isWindow", + "windowsBuildNumber", + "windowsVersion" + ), + primaryResolution: pick("height", "width"), + profileAgeCreated: typeAssertions.quantity, + profileGroupProfileCount: typeAssertions.quantity, + region: typeAssertions.string, + totalBookmarksCount: typeAssertions.quantity, + userMonthlyActivity: userMonthlyActivity => + userMonthlyActivity.map(([numberOfURLsVisited, date]) => ({ + numberOfURLsVisited, + date, + })), + // userPrefersReducedMotion can only be false in xpcshell tests because it + // uses a stubbed nsIXULAppInfo (/testing/modules/AppInfo.sys.mjs). + userPrefersReducedMotion: userPrefersReducedMotion => + userPrefersReducedMotion ?? false, + usesFirefoxSync: typeAssertions.boolean, + version: typeAssertions.string, +}); + +/** + * Transform a targeting context attribute name to the name that Glean expects + * for the corresponding metric. + * + * Glean metrics are defined in `snake_case` and are translated to `camelCase` + * for JavaScript. Most of our targeting attributes and their Glean metric + * equivalent have names that line up cleanly, but this falls apart when the + * targeting attribute has a name with an all-uppercase acronym. + * + * For example, the metric corresponding to the `defaultPDFHandler` attribute + * has the name `default_pdf_handler` in the metrics.yaml which would become + * `defaultPdfhandler` in JavaScript. + * + * @param {string} The attribute name. + * @returns {string} The metric name. + */ +export function normalizeAttributeName(attr) { + switch (attr) { + case "isFxAEnabled": // Would transform to `isFxAenabled`. + case "isFxASignedIn": // Would transform to `isFxAsignedIn`. + return attr; + + case "defaultPDFHandler": + // Would transform to `defaultPdfhandler`. + return "defaultPdfHandler"; + + default: + return attr.replaceAll(/[A-Z]+/g, substr => { + return `${substr[0]}${substr.slice(1).toLowerCase()}`; + }); + } +} + +/** + * These are the prefs that can be used in evaluation of a JEXL expression by + * Nimbus via the `getPrefValue` filter. + */ +export const PREFS = Object.freeze({ + "browser.ai.control.default": PREF_STRING, + "browser.newtabpage.activity-stream.asrouter.userprefs.cfr.addons": PREF_BOOL, + "browser.newtabpage.activity-stream.asrouter.userprefs.cfr.features": + PREF_BOOL, + "browser.newtabpage.activity-stream.feeds.section.highlights": PREF_BOOL, + "browser.newtabpage.activity-stream.feeds.section.topstories": PREF_BOOL, + "browser.newtabpage.activity-stream.feeds.topsites": PREF_BOOL, + "browser.newtabpage.activity-stream.showSearch": PREF_BOOL, + "browser.newtabpage.activity-stream.showSponsoredTopSites": PREF_BOOL, + "browser.newtabpage.enabled": PREF_BOOL, + "browser.profiles.created": PREF_BOOL, + "browser.startup.page": PREF_INT, + "browser.toolbars.bookmarks.visibility": PREF_STRING, + "browser.urlbar.lastUrlbarSearchSeconds": PREF_INT, + "browser.urlbar.showSearchSuggestionsFirst": PREF_BOOL, + "browser.urlbar.suggest.quicksuggest.sponsored": PREF_BOOL, + "media.videocontrols.picture-in-picture.enabled": PREF_BOOL, + "media.videocontrols.picture-in-picture.video-toggle.enabled": PREF_BOOL, + "media.videocontrols.picture-in-picture.video-toggle.has-used": PREF_BOOL, + "messaging-system-action.testday": PREF_STRING, + "network.trr.mode": PREF_INT, + "nimbus.qa.pref-1": PREF_STRING, + "nimbus.qa.pref-2": PREF_STRING, + "security.sandbox.content.level": PREF_INT, + "termsofuse.acceptedDate": PREF_STRING, + "termsofuse.acceptedVersion": PREF_INT, + "termsofuse.bypassNotification": PREF_BOOL, + "termsofuse.firstAcceptedDate": PREF_STRING, + "trailhead.firstrun.didSeeAboutWelcome": PREF_BOOL, +}); + +/** + * Transform a pref name to its key in the targeting context metric. + * + * Using dashes and periods in the object metric type would make the resulting + * data harder to query, so we replace them with single and double underscores, + * respectively. + * + * @param {string} The pref name. + * @returns {string} The normalized pref name. + */ +export function normalizePrefName(pref) { + return pref.replaceAll(/-/g, "_").replaceAll(/\./g, "__"); +} + +/** + * Get the list of all prefs that Nimbus cares about and determine whether or + * not they have user branch values. + * + * This will walk the Feature Manifest, collecting every setPref entry. + * + * This does not return any errors because prefHasUserValue cannot throw. + * + * @returns {string[]} The array of prefs. + */ +function recordUserSetPrefs() { + const prefs = Object.values(lazy.NimbusFeatures) + .filter(feature => feature.manifest) + .flatMap(feature => feature.manifest.variables) + .flatMap(Object.values) + .filter(variable => variable.setPref) + .map(variable => variable.setPref.pref) + .filter(pref => Services.prefs.prefHasUserValue(pref)); + + Glean.nimbusTargetingEnvironment.userSetPrefs.set(prefs); +} + +/** + * Record pref values to the nimbus_targeting_environment.pref_values metric. + * + * The prefs queried are determined by `PREFS`. + * + * Any type errors will encountered will be recorded in the + * `nimbus_targeting_environment.pref_type_errors` metric. + */ +function recordPrefValues() { + const prefValues = {}; + + for (const [pref, expectedType] of Object.entries(PREFS)) { + const key = normalizePrefName(pref); + + const prefType = Services.prefs.getPrefType(pref); + if (prefType === PREF_INVALID) { + // The pref doesn't have a value on either branch. This is not an actual + // error. + continue; + } + + if (prefType !== expectedType) { + // We cannot record this value since the pref has the wrong type. + Glean.nimbusTargetingEnvironment.prefTypeErrors[pref].add(); + console.error( + `TargetingContextRecorder: Pref "${pref}" has the wrong type. Expected ${PREF_TYPES[expectedType]} but found ${PREF_TYPES[prefType]}` + ); + continue; + } + + try { + switch (expectedType) { + case PREF_STRING: + prefValues[key] = Services.prefs.getStringPref(pref); + break; + + case PREF_INT: + prefValues[key] = Services.prefs.getIntPref(pref); + break; + + case PREF_BOOL: + prefValues[key] = Services.prefs.getBoolPref(pref); + break; + } + } catch (ex) { + // `nsIPrefBranch::Get{String,Int,Bool}Pref` only fails for three reasons: + // - you request a pref that does not exist + // - you request a pref with the wrongly-typed method (e.g., you try to + // get the value of an int pref with `GetStringPref`) + // - the pref service is not available (likely because we are shutting down). + // + // The first two cases are covered before we attempt to read the pref + // value and the last case is not worth recording telemetry about. + console.error( + `TargetingContextRecorder: Could not get value of pref "${pref}; are we shutting down?"`, + ex + ); + } + } + + Glean.nimbusTargetingEnvironment.prefValues.set(prefValues); +} + +/** + * Evaluate the values of the `nimbus_targeting_context` category metrics and + * record them. + * + * Any errors encountered during evaluation will be recorded in the + * `nimbus_targeting_environment.attr_eval_errors` metric. + * + * The entire targeting context will be recorded inside the + * `nimbus_targeting_environment.targeting_context_value` metric as stringified + * JSON. The metric is disabled by default, but can be enabled via the + * `nimbusTelemetry` feature to debug evaluation failures. + */ +async function recordTargetingContextAttributes() { + const context = new lazy.TargetingContext( + lazy.TargetingContext.combineContexts( + lazy.ExperimentAPI.manager.createTargetingContext(), + lazy.ASRouterTargeting.Environment + ) + ).ctx; + + const recordAttrsEnabled = + lazy.NimbusFeatures.nimbusTelemetry.getVariable("gleanMetricConfiguration") + ?.metrics_enabled?.[ + "nimbus_targeting_environment.targeting_context_value" + ] ?? false; + + const recordAttrs = + lazy.NimbusFeatures.nimbusTelemetry.getVariable( + "nimbusTargetingEnvironment" + )?.recordAttrs ?? null; + const values = {}; + + for (const [attr, transform] of Object.entries(ATTRIBUTE_TRANSFORMS)) { + const metric = normalizeAttributeName(attr); + try { + const value = await transform(await context[attr]); + + if ( + recordAttrsEnabled && + (recordAttrs === null || recordAttrs.includes(attr)) + ) { + values[metric] = value; + } + + Glean.nimbusTargetingContext[metric].set(value); + } catch (ex) { + Glean.nimbusTargetingEnvironment.attrEvalErrors[metric].add(); + console.error(`TargetingContextRecorder: Could not get "${attr}"`, ex); + } + } + + if (recordAttrsEnabled) { + let stringifiedCtx; + try { + stringifiedCtx = JSON.stringify(values); + } catch (ex) { + stringifiedCtx = "(JSON.stringify error)"; + } + + Glean.nimbusTargetingEnvironment.targetingContextValue.set(stringifiedCtx); + } +} + +/** + * Record the metrics for the nimbus-targeting-context ping and submit it. + */ +export async function recordTargetingContext() { + recordPrefValues(); + recordUserSetPrefs(); + await recordTargetingContextAttributes(); + + // This will ensure that the profile group ID metric has been set. + await lazy.ClientID.getProfileGroupID(); +} diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/experimenter.yaml b/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/experimenter.yaml new file mode 100644 index 0000000000..d03e7368cb --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/experimenter.yaml @@ -0,0 +1,6180 @@ +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. + +# yaml-language-server: $schema=schemas/ExperimentFeatureManifest.schema.json + +# Features must be added here to be accessible through the NimbusFeature API. + +"no-feature-firefox-desktop": + description: A dummy feature for experiments that target no feature. + owner: beth@mozilla.com + applications: + - firefox-desktop + - firefox-desktop-background-task + hasExposure: false + allowCoenrollment: true + variables: {} + +testFeature: + description: Test only feature + owner: beth@mozilla.com + applications: + - firefox-desktop + - firefox-desktop-background-task + hasExposure: false + isEarlyStartup: true + variables: + enabled: + type: boolean + description: Whether or not this feature is enabled + testInt: + type: int + fallbackPref: nimbus.testing.testInt + description: Int pref used by platform API tests + testSetString: + type: string + setPref: + branch: user + pref: nimbus.testing.testSetString + description: A string pref set by Nimbus tests + +nimbus-qa-1: + description: A feature for testing pref-setting on the default branch. + owner: beth@mozilla.com + hasExposure: false + variables: + value: + type: string + setPref: + branch: default + pref: nimbus.qa.pref-1 + description: The value to set for the pref. + +nimbus-qa-2: + description: A feature for testing pref-setting on the user branch. + owner: beth@mozilla.com + hasExposure: false + variables: + value: + type: string + setPref: + branch: user + pref: nimbus.qa.pref-2 + description: The value to set for the pref. + +# Note: this feature is not for general use. If you want to run an experiment +# that sets prefs, you *must* register your feature in this manifest and specify +# the prefs you will control. +prefFlips: + description: Flip arbitrary prefs. Controlled by release management. + owner: beth@mozilla.com + hasExposure: false + allowCoenrollment: true + variables: + prefs: + type: json + description: "The prefs to set." + schema: + uri: resource://nimbus/schemas/PrefFlipsFeature.schema.json + path: toolkit/components/nimbus/schemas/PrefFlipsFeature.schema.json + +search: + description: Search service related features. + owner: search-and-suggest-program@mozilla.com + hasExposure: true + exposureDescription: > + Exposure is recorded when the visual search context menu item is shown or + would have been shown. + variables: + scotchBonnetEnableOverride: + type: boolean + setPref: + branch: default + pref: browser.urlbar.scotchBonnet.enableOverride + description: >- + Whether or not enabling scotch bonnet feature. + If this variable is true, the following features are available as default. + * Unified search button + * Secondary action buttons + * Search term persistence + * Intuitive search keywords + * HTTP swap + trendingRequireSearchMode: + type: boolean + setPref: + branch: default + pref: browser.urlbar.trending.requireSearchMode + description: Controls whether trending suggestions are only shown in search mode or not. + trendingMaxResultsNoSearchMode: + type: int + setPref: + branch: default + pref: browser.urlbar.trending.maxResultsNoSearchMode + description: The maximum number of trending results mode outside search mode. + targetExperiment: + type: string + description: >- + Recorded in SERP telemetry, this is the slug of the experiment someone + is requesting enrollment and branch information for. (Note that the + featureId needs to be set to "search".) + visualSearchEnabled: + type: boolean + setPref: + branch: default + pref: browser.search.visualSearch.featureGate + description: >- + Feature gate for visual search. + +searchConfiguration: + description: >- + Search experimentation support for the engine configuration. Some of these + options may cause an additional reload to occur during the startup phase. + owner: search-and-suggest-program@mozilla.com + hasExposure: false + variables: + experiment: + type: string + setPref: + branch: user + pref: browser.search.experiment + description: >- + Used to activate only matching configurations that contain the value in + `experiment` + extraParams: + type: json + description: >- + This allows extra parameters to be set for search engines requests including, + where calls to the suggestions API, the search engine configuration defines + those parameters. + + The use of this field should be coordinated with the Search team. + + The field value is an array of objects with key/value fields. For example: + + [ + {"key": "google_channel_row", "value": "foo"} + ] + + This is matched to a section in the search configuration: + + "params": [ + { + "name": "channel", + "experimentConfig": "google_channel_row" + } + ], + + In this case, the resulting URL for the appropriate search engine would have + `&channel=foo` added to the URL when doing searches. + + If the key is not referenced in the search configuration, then no parameter + will be added. If the parameter is in the search configuration, but there + is no experiment, or the experiment does not set a value, then the + parameter will not be included in the search url. + + Only the search team can update the configuration. + separatePrivateDefaultUIEnabled: + type: boolean + setPref: + branch: user + pref: browser.search.separatePrivateDefault.ui.enabled + description: Whether the UI for the separate private default feature is enabled. + separatePrivateDefaultUrlbarResultEnabled: + type: boolean + setPref: + branch: user + pref: browser.search.separatePrivateDefault.urlbarResult.enabled + description: Whether the urlbar result for the separate private default is shown. + +urlbar: + description: The Address Bar + owner: search-and-suggest-program@mozilla.com + hasExposure: true + exposureDescription: >- + The timing of the exposure event depends on the experiment, but generally + the event is recorded once per app session when the user first encounters + the UI of the experiment in which they're enrolled. + variables: + actionsOnboardingTimesToShow: + type: int + fallbackPref: browser.urlbar.quickactions.timesToShowOnboardingLabel + description: >- + The number of times a user should be shown the actions onboarding label. + addonsFeatureGate: + type: boolean + fallbackPref: browser.urlbar.addons.featureGate + description: >- + Feature gate that controls whether all aspects of the addons suggestion + feature are exposed to the user. + addonsShowLessFrequentlyCap: + type: int + description: >- + If defined and non-zero, this is the maximum number of times the user + will be able to click the "Show less frequently" command for addon + suggestions. If undefined or zero, the user will be able to click the + command without any limit. + allowSearchSuggestionsForSimpleOrigins: + type: boolean + fallbackPref: browser.urlbar.allowSearchSuggestionsForSimpleOrigins + description: >- + Whether remote search suggestions should be fetched for search strings + that look like possible simple origins like "mozilla.org". Search + suggestions will remain prohibited for search strings that look like + more complex origins that include userinfo or ports or are IP addresses. + ampFeatureGate: + type: boolean + fallbackPref: browser.urlbar.amp.featureGate + description: >- + Feature gate that controls whether all aspects of the AMP suggestions + feature are exposed to the user. + ampMatchingStrategy: + type: int + fallbackPref: browser.urlbar.quicksuggest.ampMatchingStrategy + description: >- + The matching strategy for AMP suggestions. Leave undefined or set to + zero to use the usual default exact-keyword strategy. Otherwise set to + an integer value defined on `AmpMatchingStrategy` in + `RustSuggest.sys.mjs` (corresponding to the `AmpMatchingStrategy` enum + in the Rust component coerced to a 1-based integer value). + autoFillAdaptiveHistoryEnabled: + type: boolean + setPref: + pref: browser.urlbar.autoFill.adaptiveHistory.enabled + branch: user + description: Whether enabling adaptive history autofill. + autoFillAdaptiveHistoryMinCharsThreshold: + type: int + setPref: + pref: browser.urlbar.autoFill.adaptiveHistory.minCharsThreshold + branch: user + description: Minimum char length of the user's search string to trigger adaptive history autofill. + autoFillAdaptiveHistoryUseCountThreshold: + type: string + description: This value assumes float expression like "0.47". Threshold for use count of input history that we handle as adaptive history autofill. If the use count is this value or more, it will be a candidate. + autoFillBackspaceBlockDurationMs: + type: int + setPref: + pref: browser.urlbar.autoFill.backspaceBlockDurationMs + branch: user + description: Duration in ms to temporarily block autofill after backspace penalty. + autoFillBackspaceThreshold: + type: int + setPref: + pref: browser.urlbar.autoFill.backspaceThreshold + branch: user + description: >- + How many times the user must consecutively backspace away an autofill + suggestion before we penalize and temporarily suppress it from + autofilling. The result may still appear as a regular history result. + autoFillDismissalBlockDurationMs: + type: int + setPref: + pref: browser.urlbar.autoFill.dismissalBlockDurationMs + branch: user + description: Duration in ms to block an origin or URL after user dismissal. + deduplicationEnabled: + type: boolean + setPref: + pref: browser.urlbar.deduplication.enabled + branch: user + description: >- + Feature gate that controls whether result deduplication in the urlbar + is enabled. + # TODO Bug 1982966: Remove this after all experiments and rollouts using it + # finish. + fakespotFeatureGate: + type: boolean + fallbackPref: browser.urlbar.fakespot.featureGate + description: >- + Feature gate that controls whether all aspects of the Fakespot suggestion + feature are exposed to the user. + flightStatusFeatureGate: + type: boolean + fallbackPref: browser.urlbar.flightStatus.featureGate + description: >- + Feature gate that controls whether all aspects of flight status suggestions + feature are exposed to the user. + importantDatesFeatureGate: + type: boolean + fallbackPref: browser.urlbar.importantDates.featureGate + description: >- + Feature gate that controls whether all aspects of the important dates + suggestion feature are exposed to the user. + keywordExposureResults: + type: string + setPref: + pref: browser.urlbar.keywordExposureResults + branch: user + description: >- + Comma-separated list of result types that should trigger + keyword-exposure telemetry. Keyword exposures can be recorded along with + result exposures. To enable keyword exposures for a result type, you + must add it both to this variable and to `exposureResults`. The only + exception is the "rust_exposure" result type, which can be added to this + variable even if it's not in `exposureResults` since it's enabled by + setting the `quickSuggestExposureSuggestionTypes` variable. Keyword + exposures are recorded in the `urlbar-keyword-exposure` ping. See that + ping's description for more. + marketFeatureGate: + type: boolean + fallbackPref: browser.urlbar.market.featureGate + description: >- + Feature gate that controls whether all aspects of the stock market + suggestions feature are exposed to the user. + mdnFeatureGate: + type: boolean + setPref: + branch: default + pref: browser.urlbar.mdn.featureGate + description: >- + Feature gate that controls whether all aspects of the mdn suggestion + feature are exposed to the user. + merinoClientVariants: + type: string + fallbackPref: browser.urlbar.merino.clientVariants + description: >- + Comma separated list of client variants to report to the Merino server. + May impact server behavior. + merinoEndpointURL: + type: string + fallbackPref: browser.urlbar.merino.endpointURL + description: >- + The Merino endpoint URL, not including parameters. An empty string will + cause Firefox not to fetch from Merino. + merinoOhttpConfigURL: + type: string + fallbackPref: browser.urlbar.merino.ohttpConfigURL + description: >- + OHTTP config URL for Merino requests. + merinoOhttpRelayURL: + type: string + fallbackPref: browser.urlbar.merino.ohttpRelayURL + description: >- + OHTTP relay URL for Merino requests. + merinoProviders: + type: string + fallbackPref: browser.urlbar.merino.providers + description: >- + Comma-separated list of providers to request from the Merino server. + Merino will return suggestions only for these providers. + merinoTimeoutMs: + type: int + fallbackPref: browser.urlbar.merino.timeoutMs + description: Timeout for Merino fetches (ms) + exposureResults: + type: string + setPref: + pref: browser.urlbar.exposureResults + branch: user + description: >- + Comma-separated list of result types that should trigger exposure + telemetry, which is recorded in the `exposure` event. By default + exposure results are visible like usual, but they can be hidden by + setting the `showExposureResults` variable to false. To also record + keyword exposures for a result type, include it in the + `keywordExposureResults` variable as well. + showExposureResults: + type: boolean + setPref: + pref: browser.urlbar.showExposureResults + branch: user + description: >- + Boolean used to determine if the results defined in `exposureResults` should be shown in search results. Should be false for Control branch of an experiment. + quickSuggestAmpTopPickCharThreshold: + type: int + fallbackPref: browser.urlbar.quicksuggest.ampTopPickCharThreshold + description: >- + Character-count threshold (inclusive) for showing AMP suggestions as top + picks. If the user's query matches an AMP suggestion and the query is at + least this many characters long, the suggestion will be shown as a top + pick. Set to zero to disable. + quickSuggestAmpTopPickUseNovaIconSize: + type: boolean + setPref: + branch: default + pref: browser.urlbar.quicksuggest.ampTopPickUseNovaIconSize + description: >- + Whether or not use the Nova icon size for AMP suggestion. + Otherwise, use standard rich-suggestion size. + quickSuggestContextualOptInEnabled: + type: boolean + setPref: + branch: default + pref: browser.urlbar.quicksuggest.contextualOptIn + description: Whether the Firefox Suggest contextual opt-in result is enabled. + quickSuggestContextualOptInFirstReshowAfterPeriodDays: + type: int + setPref: + branch: default + pref: browser.urlbar.quicksuggest.contextualOptIn.firstReshowAfterPeriodDays + description: Period until reshow the Firefox Suggest contextual opt-in result when first dismissed. + quickSuggestContextualOptInSecondReshowAfterPeriodDays: + type: int + setPref: + branch: default + pref: browser.urlbar.quicksuggest.contextualOptIn.secondReshowAfterPeriodDays + description: Period until reshow the Firefox Suggest contextual opt-in result when second dismissed. + quickSuggestContextualOptInThirdReshowAfterPeriodDays: + type: int + setPref: + branch: default + pref: browser.urlbar.quicksuggest.contextualOptIn.thirdReshowAfterPeriodDays + description: Period until reshow the Firefox Suggest contextual opt-in result when third dismissed. + quickSuggestContextualOptInImpressionLimit: + type: int + setPref: + branch: default + pref: browser.urlbar.quicksuggest.contextualOptIn.impressionLimit + description: Limit for impression to dismiss the Firefox Suggest contextual opt-in result. + quickSuggestContextualOptInImpressionDaysLimit: + type: int + setPref: + branch: default + pref: browser.urlbar.quicksuggest.contextualOptIn.impressionDaysLimit + description: Days until dismiss the Firefox Suggest contextual opt-in result after first impression. + quickSuggestDynamicSuggestionTypes: + type: string + setPref: + pref: browser.urlbar.quicksuggest.dynamicSuggestionTypes + branch: user + description: >- + Comma-separated list of Suggest dynamic suggestion types to enable. Set + this variable to the `suggestion_type` defined in the remote settings + record that contains your suggestions. If you want to enable multiple + suggestion types, separate them with commas. One particular intended use + of this variable is to deliver hidden-exposure suggestions for testing + potential exposures. Hidden-exposure suggestions trigger exposure + telemetry based on a set of keywords you provide but they are never + visible. If you are testing multiple types of hidden-exposure + suggestions, consider using one experiment branch per type, especially + if you are also enabling keyword exposures. Exposure suggestions are + recorded in telemetry with the "rust_exposure" result type. It's not + necessary to include "rust_exposure" in `exposureResults`. Unless you + are testing other results in the same experiment branch, it's also not + necessary to set `showExposureResults: false`. To also record keyword + exposures, include "rust_exposure" in `keywordExposureResults`. + quickSuggestEnabled: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.enabled + description: >- + Gate for the Firefox Suggest feature as a whole. If false, the Firefox + Suggest preferences UI and Suggest suggestions will not be shown. If + true, the preferences UI will be shown, and the user can turn + suggestions on or off. + quickSuggestImpressionCapsSponsoredEnabled: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.impressionCaps.sponsoredEnabled + description: Whether sponsored suggestions are subject to impression frequency caps. If false, sponsored suggestions can be shown an unlimited number of times over any given period. If true, sponsored suggestion impressions will be subject to the caps in the remote settings configuration. + quickSuggestImpressionCapsNonSponsoredEnabled: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.impressionCaps.nonSponsoredEnabled + description: Whether non-sponsored suggestions are subject to impression frequency caps. If false, non-sponsored suggestions can be shown an unlimited number of times over any given period. If true, non-sponsored suggestion impressions will be subject to the caps in the remote settings configuration. + quickSuggestMlInitDelaySeconds: + type: int + fallbackPref: browser.urlbar.quicksuggest.mlInitDelaySeconds + description: >- + How long to wait in seconds after startup before initializing the + Suggest ML backend. + quickSuggestMlEnabled: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.mlEnabled + description: >- + Whether Suggest will use the ML backend in addition to Rust. + quickSuggestNonSponsoredEnabled: + type: boolean + description: >- + Deprecated: In 146 and later this variable no longer does anything. It + should be removed once all current experiments that use it finish. + quickSuggestNonSponsoredIndex: + type: int + fallbackPref: browser.urlbar.quicksuggest.nonSponsoredIndex + description: >- + The index of non-sponsored QuickSuggest results within the general + group. A negative index is relative to the end of the group + quickSuggestOnlineAvailable: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.online.available + description: >- + Whether online Suggest should be made available to the user. + quickSuggestRankingMode: + type: string + fallbackPref: browser.urlbar.quicksuggest.rankingMode + description: >- + Specify the ranking mode for QuickSuggest. + - "default": ranking by static scores specified by individual providers. + - "interest": ranking by relevance scores provided by `ContentRelevancyManager`. + - "random": ranking by randomly selecting a winner out of candidates. + Note that this ranking mode can still be overridden by `quickSuggestScoreMap`. + If the ranking mode is unspecified or set to any unknown values, it will default + to the static score based ranking. + enum: + - default + - interest + - random + quickSuggestScoreMap: + type: json + description: >- + A JSON object that maps telemetry result types to suggestion scores. If + a telemetry result type is present in this map, the client will use the + corresponding score as the score for all suggestions of the type, + overriding all other sources of scores for the type. In other words, + the scores in this map will override scores that are set in remote + settings and Merino as well as scores that are hardcoded in the client. + Example entries: `"amo": 0.5`, `"adm_sponsored": 0.9` + quickSuggestSettingsUi: + type: int + fallbackPref: browser.urlbar.quicksuggest.settingsUi + description: >- + When Suggest is enabled, this determines the Suggest settings that will + be visible in the settings UI (about:preferences). When Suggest is + disabled, this is ignored and Suggest settings are hidden. Possible + values: + 0: (default) Full, all settings will be shown. + 1: None, no settings will be shown. + 2: Offline only, settings that pertain to online will be hidden. + quickSuggestSponsoredEnabled: + type: boolean + description: Whether sponsored suggestions should be enabled by default. If this variable is specified, it will override the value implied by the scenario. It will never override the user's local preference to disable (or enable) sponsored suggestions, if the user has already toggled that preference. + quickSuggestSponsoredIndex: + type: int + fallbackPref: browser.urlbar.quicksuggest.sponsoredIndex + description: >- + The index of sponsored Firefox Suggest results within the Firefox Suggest + section when "Show search suggestions ahead of browsing history in + address bar results" is checked. When not checked, the index is hardcoded + as -1. Negative indexes are relative to the end of the section. + quickSuggestSponsoredPriority: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.sponsoredPriority + description: >- + Whether or not showing sponsored suggestion as priority. + If this variable is true, the following things are processed. + * "Sponsored" label is shown as the group label. + * Change the suggested index to 1. + * Handle as top pick. + realtimeMinKeywordLength: + type: int + description: >- + The minimum prefix length of a realtime keyword the user must type to + trigger the suggestion. + realtimeShowLessFrequentlyCap: + type: int + description: >- + If defined and non-zero, this is the maximum number of times the user + will be able to click the "Show less frequently" command for realtime + suggestions. If undefined or zero, the user will be able to click the + command without any limit. + recentSearchesFeatureGate: + type: boolean + setPref: + branch: default + pref: browser.urlbar.recentsearches.featureGate + description: Gate for the recent searches feature. + recentSearchesMaxResults: + type: int + setPref: + branch: default + pref: browser.urlbar.recentsearches.maxResults + description: The maximum number of recent searches to show. + resultExplanationsFeatureGate: + type: boolean + fallbackPref: browser.urlbar.resultExplanations.featureGate + description: >- + When selecting and hovering over certain types of urlbar results, + replace their URLs with strings that explain why they're shown. + semanticHistoryEnable: + type: boolean + setPref: + branch: user + pref: places.semanticHistory.featureGate + description: use semanticHistory Search feature. + semanticHistoryDefaultBatchChunksize: + type: int + setPref: + branch: user + pref: places.semanticHistory.defaultBatchChunksize + description: >- + The batch chunk size for updates for vectorDB + defaulted at 25. + semanticHistoryMaxChunkTimeMs: + type: int + setPref: + branch: user + pref: places.semanticHistory.maxChunkTimeMs + description: >- + Soft per-chunk time threshold (ms) for background indexing. If the + median of the last 9 chunk durations exceeds this and the database + already holds more than `semanticHistoryMinEntriesBeforeThrottle` + embeddings, indexing stops advancing until next places event. + semanticHistoryMaxChunkTimeMsFailsafe: + type: int + setPref: + branch: user + pref: places.semanticHistory.maxChunkTimeMsFailsafe + description: >- + Failsafe per-chunk time threshold (ms) for background indexing. If half + or more of the last 9 chunk durations exceed this, indexing stops + advancing, regardless of how many embeddings exist, until restart. + semanticHistoryMinEntriesBeforeThrottle: + type: int + setPref: + branch: user + pref: places.semanticHistory.minEntriesBeforeThrottle + description: >- + Minimum number of embeddings that must exist before the soft + `semanticHistoryMaxChunkTimeMs` threshold can stop indexing. Below this + count indexing keeps going even when slow, so the feature reaches a + usable state. Defaulted at 1000. + semanticHistoryDistanceThreshold: + type: string + setPref: + branch: user + pref: places.semanticHistory.distanceThreshold + description: >- + semantic similarity distance threshold (0.0 - 1.0) + defaulted at 0.6. + semanticHistorySmartwindowDistanceThreshold: + type: string + setPref: + branch: user + pref: places.semanticHistory.smartwindow.distanceThreshold + description: >- + semantic similarity distance threshold (0.0 - 1.0) for Smart Window + history search only. + semanticHistorySupportedRegions: + type: string + setPref: + branch: user + pref: places.semanticHistory.supportedRegions + description: >- + map-like JSON of regions and locales for which the feature is supported. + When `semanticHistoryEnable` is false, this list is ignored and the + feature is disabled everywhere. When true, the feature is enabled only + in the regions/locales listed here. + The format is like: '[["AU",["en-*"]],["CA",["en-*"]], …]' where `-*` + can be used as a wildcard to match any locale that starts with the given + prefix. + semanticHistoryEmbeddingType: + type: string + setPref: + branch: user + pref: places.semanticHistory.embeddingType + description: >- + Embedding family used by Places semantic history: "static" + (lightweight) or "contextual" (transformer-based, larger). When unset + or empty, the family is derived from the home region, the app locale + and the OS: contextual in the markets listed in + `semanticHistoryMultilingualEmbeddingRegions` on Mac/Windows, static + everywhere else. Changing this on a live profile drops the embedding + tables and rebuilds them on next startup. Contextual model details + (dimension, modelId) are controlled by the browser.ml.embedGen.* prefs + and are intentionally not exposed via Nimbus. + semanticHistoryMultilingualEmbeddingRegions: + type: string + setPref: + branch: user + pref: places.semanticHistory.multilingualEmbeddingRegions + description: >- + map-like JSON of regions and locales that get multilingual (contextual) + embeddings, used when `semanticHistoryEmbeddingType` is unset or empty. + Same format as `semanticHistorySupportedRegions`, except that a "*" + region matches any region. The entries are OR-ed, so + '[["FR",["en-*","fr-*"]],["*",["fr-*"]]]' means France in English or + French, or a French locale anywhere. An empty value disables + multilingual embeddings everywhere. + semanticHistoryInSeparateGroup: + type: boolean + setPref: + branch: user + pref: browser.urlbar.suggest.semanticHistory.separateGroup + description: >- + Whether semantic history results are placed in their own result group + that fills only the space left after the other result groups, so + semantic results never evict non-semantic results. Off by default. + showDebuggingIcons: + type: boolean + setPref: + branch: user + pref: browser.urlbar.showDebuggingIcons + description: >- + Whether or not to show debugging badges on urlbar results favicons. + sportsFeatureGate: + type: boolean + fallbackPref: browser.urlbar.sports.featureGate + description: >- + Feature gate that controls whether all aspects of the sports suggestions + feature are exposed to the user. + suggestSemanticHistoryMinLength: + type: int + setPref: + branch: user + pref: browser.urlbar.suggest.semanticHistory.minLength + description: >- + Minimum length of search query when history semantic + search will be enabled. + suggestCalculator: + type: boolean + setPref: + branch: user + pref: browser.urlbar.suggest.calculator + description: >- + Whether or not to show calculator results when a user types a valid + calculation string into the urlbar. + trackerCountFeatureGate: + type: boolean + fallbackPref: browser.urlbar.trackerCount.featureGate + description: >- + Boolean used to determine if the "x trackers blocked" pill should be + shown in the urlbar. Should be false for Control branch of an + experiment. + unitConversionEnabled: + type: boolean + setPref: + branch: user + pref: browser.urlbar.unitConversion.enabled + description: >- + Whether or not to show unit conversion results when a user types a + valid unit conversion string into the urlbar. + weatherFeatureGate: + type: boolean + fallbackPref: browser.urlbar.weather.featureGate + description: >- + Feature gate that controls whether all aspects of the weather suggestion + feature are exposed to the user. + weatherKeywordsMinimumLength: + type: int + description: >- + If defined and non-zero, the weather suggestion will be triggered by + typing any prefix of a full weather keyword when the prefix is at least + `weatherKeywordsMinimumLength` characters long. If this variable is + absent or zero, Firefox will fall back to the minimum length defined in + remote settings. If neither Nimbus nor remote settings defines a minimum + length, only full keywords will trigger the suggestion. + weatherShowLessFrequentlyCap: + type: int + description: >- + If defined and non-zero, this is the maximum number of times the user + will be able to click the "Show less frequently" command for weather + suggestions. If undefined or zero, the user will be able to click the + command without any limit. + weatherUiTreatment: + type: int + fallbackPref: browser.urlbar.weather.uiTreatment + description: >- + The UI treatment to use for weather suggestions. Possible values: + 0: (default) Simplest UI with current temperature and location + 1: Simpler UI, adds current conditions, high/low, and URL + 2: Full UI, adds forecast + wikipediaFeatureGate: + type: boolean + fallbackPref: browser.urlbar.wikipedia.featureGate + description: >- + Feature gate that controls whether all aspects of the Wikipedia + suggestions feature (part of Firefox Suggest) are exposed to the user. + yelpMinKeywordLength: + type: int + description: >- + The minimum prefix length of a Yelp keyword the user must type to + trigger the suggestion. + yelpMlEnabled: + type: boolean + fallbackPref: browser.urlbar.yelp.mlEnabled + description: >- + Whether Yelp suggestions will be served from the Suggest ML backend + instead of Rust. + yelpFeatureGate: + type: boolean + fallbackPref: browser.urlbar.yelp.featureGate + description: >- + Feature gate that controls whether all aspects of the Yelp suggestion + feature are exposed to the user. + yelpServiceResultDistinction: + type: boolean + fallbackPref: browser.urlbar.yelp.serviceResultDistinction + description: >- + Whether to distinguish service type subjects. If true, we show special + titile for the suggestion. + yelpShowLessFrequentlyCap: + type: int + fallbackPref: browser.urlbar.yelp.showLessFrequentlyCap + description: >- + If defined and non-zero, this is the maximum number of times the user + will be able to click the "Show less frequently" command for Yelp + suggestions. If undefined or zero, the user will be able to click the + command without any limit. + yelpSuggestNonPriorityIndex: + type: int + description: >- + The group-relative suggestedIndex of Yelp suggestions within the Firefox + Suggest section. Ignored when `yelpSuggestPriority` is true. + yelpSuggestPriority: + type: boolean + fallbackPref: browser.urlbar.yelp.priority + description: >- + Whether or not showing yelp suggestion as priority. + If this variable is true, the following things are processed. + * Change the suggested index to 1. + * Handle as top pick. + yelpRealtimeFeatureGate: + type: boolean + fallbackPref: browser.urlbar.yelpRealtime.featureGate + description: >- + Feature gate that controls whether all aspects of Yelp realtime suggestions + feature are exposed to the user. + originsAlternativeEnable: + description: >- + Use an alternative ranking algorithm for autofilling origins, that is + mainly domains of Web pages. When the user types the beginning of an + origin, we autofill the whole origin. Whether autofill happens depends + on the ranking algorithm. Bookmarks are always autofilled anyway. + type: boolean + setPref: + branch: user + pref: "places.frecency.origins.alternative.featureGate" + originsDaysCutOff: + description: >- + The alternative ranking algorithm only considers pages visited in the + last N days, where N is controlled by this variable. + type: int + setPref: + branch: user + pref: "places.frecency.origins.alternative.daysCutOff" + pagesAlternativeEnable: + description: >- + Use an alternative ranking algorithm for sorting history and bookmarks + among the urlbar results. + type: boolean + setPref: + branch: user + pref: "places.frecency.pages.alternative.featureGate" + pagesNumSampledVisits: + description: >- + The number of recent visits to sample when calculating the ranking of + a page. Examining all the visits would be expensive, so we only sample + recent visits. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.numSampledVisits" + pagesHalfLifeDays: + description: >- + The number of days after which the ranking halves. This implements the + "recency" part of the algorithm. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.halfLifeDays" + pagesMaxVisitGap: + description: >- + The maximum allowed time (in seconds) between when a visit was recorded + and when an interaction occurs for them to be paired. This accounts + for slight discrepancies in their timestamps. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.interactions.maxVisitGapSeconds" + pagesViewTimeSeconds: + description: >- + The minimum allowed time (in seconds) a page was viewed before upgrading + the score of a visit. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.interactions.viewTimeSeconds" + pageViewTimeIfManyKeypressesSeconds: + description: >- + The minimum allowed time (in seconds) a page was viewed before checking + the manyKeypresses threshold. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.interactions.viewTimeIfManyKeypressesSeconds" + manyKeypresses: + description: >- + The minimum number of keypresses typed before upgrading the score + of a visit. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.interactions.manyKeypresses" + pagesVeryHighWeight: + description: >- + The weight to use for the very high importance bucket. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.veryHighWeight" + pagesHighWeight: + description: >- + The weight to use for the high importance bucket. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.highWeight" + pagesMediumWeight: + description: >- + The weight to use for the medium importance bucket. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.mediumWeight" + pagesLowWeight: + description: >- + The weight to use for the low importance bucket. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.lowWeight" + +aboutwelcome: + description: "The about:welcome page" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + Exposure is sent once per browsing session when the about:welcome URL is + first accessed. + isEarlyStartup: true + variables: + enabled: + type: boolean + fallbackPref: browser.aboutwelcome.enabled + description: >- + Should users see about:welcome? If this is false, users will see a + regular new tab instead. + id: + type: string + description: >- + Descriptive ID for the about:welcome content + screens: + type: json + fallbackPref: browser.aboutwelcome.screens + description: Content to show in the onboarding flow + languageMismatchEnabled: + type: boolean + fallbackPref: intl.multilingual.aboutWelcome.languageMismatchEnabled + description: >- + Suggest to change the language on about:welcome when there is a mismatch with + the OS. + transitions: + type: boolean + description: Enable transition effect between screens + backdrop: + type: string + fallbackPref: browser.aboutwelcome.backdrop + description: >- + Specify the color to be used to update the background color + toolbarButtonEnabled: + type: boolean + setPref: + branch: user + pref: browser.aboutwelcome.toolbarButtonEnabled + description: >- + Should the return to about:welcome toolbar button be shown + +preonboarding: + description: "A modal that shows on first startup, typically on top of about:welcome" + owner: omc-core@mozilla.com + # Exposure is recorded by the spotlight feature used to show the modal + hasExposure: false + # Needed at `sessionstore-windows-restored`. + isEarlyStartup: true + variables: + enabled: + type: boolean + fallbackPref: browser.preonboarding.enabled + description: >- + Should users see the preonboarding modal? + screens: + type: json + fallbackPref: browser.preonboarding.screens + description: Content to show in the onboarding flow + requireAction: + type: boolean + fallbackPref: browser.preonboarding.requireAction + description: >- + When showModal is enabled, should action be required to proceed (show as a window modal with dismiss using the ESC key disabled)? + currentVersion: + type: int + fallbackPref: termsofuse.currentVersion + description: >- + The current policy version displayed by this preonboarding modal. + minimumVersion: + type: int + fallbackPref: termsofuse.minimumVersion + description: >- + The minimum policy version which the user must have accepted to not see + the preonboarding modal. In some cases, the minimum version could be + lower than the current version if the newer version(s) is not + substantially different enough to warrant asking users to accept the TOU + again. + firstRunURL: + type: string + fallbackPref: datareporting.policy.firstRunURL + description: >- + URL of browser tab to be opened on first run instead of infobar. + +moreFromMozilla: + description: "New page on about:preferences to suggest more Mozilla products" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + Exposure is sent once per browsing session when the about:preferences URL is + first accessed. + variables: + enabled: + type: boolean + fallbackPref: browser.preferences.moreFromMozilla + description: Should users see the new more from Mozilla section. + template: + type: string + fallbackPref: browser.preferences.moreFromMozilla.template + description: UI template used to display Mozilla products. Possible values simple, advanced. Default is simple. + +windowsLaunchOnLogin: + description: "New checkbox in about:preferences startup section to start Firefox on Windows login" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + Exposure is sent once per browsing session when the about:preferences URL is + first accessed. + variables: + enabled: + type: boolean + setPref: + branch: default + pref: browser.startup.windowsLaunchOnLogin.enabled + description: Should users see the Windows launch on login checkbox. + +firefoxBridge: + description: "Controls for Firefox Bridge extension and extension registration" + owner: install-update@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: browser.firefoxbridge.enabled + description: >- + Should Firefox Bridge be registered within firefoxBridgeNativeMessaging + startup idle task for use with native messaging proxy. + +abouthomecache: + description: "The startup about:home cache." + owner: omc-core@mozilla.com, mconley@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Is the feature enabled? + setPref: + branch: user + pref: browser.startup.homepage.abouthome_cache.enabled + +diskCache: + description: "The HTTP disk cache." + owner: vgosu@mozilla.com + hasExposure: false + variables: + diskCacheEnabled: + type: boolean + description: >- + Whether the HTTP disk cache is enabled. + setPref: + branch: user + pref: browser.cache.disk.enable + diskCacheEncryptionEnabled: + type: boolean + description: >- + Whether HTTP disk cache data is encrypted at rest with an in-memory key. + Takes effect on restart. + setPref: + branch: user + pref: browser.cache.disk.encryption.enabled + +newtab: + description: "The about:newtab page" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + Exposure is sent once per browsing session when the first newtab page loads + (either about:newtab or about:home). + isEarlyStartup: true + variables: + newTheme: + type: boolean + description: Enable the new theme + customizationMenuEnabled: + type: boolean + fallbackPref: browser.newtabpage.activity-stream.customizationMenu.enabled + description: Enable the customization panel inside of the newtab + prefsButtonIcon: + type: string + description: Icon url to use for the preferences button + topSitesContileEnabled: + type: boolean + fallbackPref: browser.topsites.contile.enabled + description: Enable the Contile integration for Sponsored Top Sites + topSitesUseAdditionalTilesFromContile: + type: boolean + description: Allow Contile to use additonal sponsored top sites + +newtabAdSizingExperiment: + description: >- + Change the default ad size and UI for certain ad formats. + owner: achurchwell@mozilla.com, sdowne@mozilla.com, mcrawford@mozilla.com + hasExposure: false + variables: + leaderboard: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabAdSize.leaderboard + description: >- + Leaderboard ad size and UI. + leaderboard_position: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabAdSize.leaderboard.position + description: >- + Leaderboard row position. + billboard: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabAdSize.billboard + description: >- + Billboard ad size and UI. + billboard_position: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabAdSize.billboard.position + description: >- + Billboard row position. + medium_rectangle: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabAdSize.mediumRectangle + description: >- + Medium rectangle (MREC) ad size and UI. + +newtabPromoCard: + description: the promo card that appears next to the ad banner + owner: achurchwell@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Turns on and off the promo card. + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.promoCard.enabled + +newtabAdsReporting: + description: about:newtab reporting ads feature + owner: rhamoui@mozilla.com + hasExposure: false + variables: + reportAdsEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.reportAds.enabled + description: >- + Enable reporting for ads + +newtabContextualContent: + description: about:newtab contextual content feed + owner: nbarrett@mozilla.com + hasExposure: false + variables: + contextualContentEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.contextualContent.enabled + description: >- + Override the contextual content enabled value set via region/locale + localeContextualContentConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.contextualContent.locale-content-config + description: >- + A comma-separated list of locales that get contextual content by default. + regionContextualContentConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.contextualContent.region-content-config + description: >- + A comma-separated list of regions that get contextual content by default. + contextualContentFeeds: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.contextualContent.feeds + description: >- + CSV list of possible feeds for the contextual content feed + contextualContentSelectedFeed: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.contextualContent.selectedFeed + description: >- + currently selected feed to display in the Contextual Content component + +newtabCustomWallpaper: + description: >- + Modify the wallpaper selection feature to support user-uploaded custom wallpaper images + owner: mcrawford@mozilla.com + hasExposure: false + variables: + uploadWallpaper: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.customWallpaper.enabled + description: >- + Turns on and off ability to upload a custom wallpaper. + colorPicker: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.customColor.enabled + description: >- + Turns on and off background color picker. + maxFileSizeEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.customWallpaper.fileSize.enabled + description: >- + Turns on and off maximum file size for uploaded images + maxFileSize: + type: int + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.customWallpaper.fileSize + description: >- + Maximum file size (in MB) a user can upload + +newtabInlineTopicSelection: + description: >- + Adds Inline topic selection to sections layout + owner: nbarrett@mozilla.com + hasExposure: false + variables: + TopicSelectionEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.interestPicker.enabled + description: >- + Enables inline topic selection + +newtabMarsOhttp: + description: Sending request to MARS over OHTTP in newtab + owner: nbarrett@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.unifiedAds.ohttp.enabled + description: >- + Enables using OHTTP for unified ads API requests + +newtabMerinoOhttp: + description: Sending request to merino over OHTTP in newtab + owner: nbarrett@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.merino-provider.ohttp.enabled + description: >- + Enables using OHTTP for merino content requests + +newtabOhttpImages: + description: Sending request to MARS over OHTTP in newtab + owner: nbarrett@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: >- + Enables using OHTTP for images + includeTopStoriesSection: + type: boolean + description: >- + Enables using OHTTP for top stories section if enabled for images + +newtabMobileDownloadPromotion: + description: Cross-sell promotion to download Firefox for mobile + owner: mcrawford@mozilla.com + hasExposure: false + variables: + showModal: + type: boolean + description: Display mobile download modal to users until dismissed + setPref: + branch: user + pref: browser.newtabpage.activity-stream.mobileDownloadModal.enabled + variantA: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.mobileDownloadModal.variant-a + description: >- + Variant A modal message and QR code. + variantB: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.mobileDownloadModal.variant-b + description: >- + Variant B modal message and QR code. + variantC: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.mobileDownloadModal.variant-c + description: >- + Variant C modal message and QR code. + +newtabPrivatePing: + description: The newtab-content ping, sent through OHTTP + owner: nbarrett@mozilla.com + hasExposure: false + variables: + privatePingEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.telemetry.privatePing.enabled + description: >- + Enables the private newtab-content ping sent through OHTTP + redactNewtabPing: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.telemetry.privatePing.redactNewtabPing.enabled + description: >- + Provides an option to redact content ids of users from click, impression and related events in the NewTab ping. Should be enabled when data colection has shefted to the more private NewTab_content ping. + includeInferredInterests: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.telemetry.privatePing.inferredInterests.enabled + description: >- + Includes a differentially private intrest vector of general topical interests based on New Tab clicks. Only sent when user has enabled personalization. + maxSubmissionDelayMs: + type: int + setPref: + branch: user + pref: browser.newtabpage.activity-stream.telemetry.privatePing.maxSubmissionDelayMs + description: >- + The maximum range for the random delay from scheduling the newtab-content ping to actually sending it. The minimum is 1000 by default. This is in milliseconds. +newtabPublisherFavicons: + description: Enabled publihser favicons on cards in newtab + owner: nbarrett@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.publisherFavicon.enabled + description: Enables publisher favicons on cards in newtab + +newTabSectionsExperiment: + description: about:newtab section UI update + owner: nbarrett@mozilla.com, mcrawford@mozilla.com + hasExposure: false + variables: + sectionsEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.enabled + description: >- + Enable the Section UI for recommended stories on newtab + cardRefreshEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.cards.enabled + description: >- + Enable the revised pocket story card UI in recommended stories on newtab + regionPersonalizationInferredConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.personalization.inferred.region-config + description: >- + A comma-separated list of regions that use inferred personalization. + localePersonalizationInferredConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.personalization.inferred.locale-config + description: >- + A comma-separated list of locales that use inferred personalization. + personalizationInferredEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.personalization.inferred.enabled + description: >- + Enable the inferred personalization for topics + localeSectionstConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.locale-content-config + description: >- + A comma-separated list of locales that get contextual content by default. + regionSectionsConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.region-content-config + description: >- + A comma-separated list of regions that get contextual content by default. + sectionsPersonalization: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.personalization.enabled + description: >- + Enable personalized sections layout. Allow users to follow/unfollow topic sections. + sectionsCustomizeMenuPanel: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.customizeMenuPanel.enabled + description: >- + Enable personalized sections menu panel. Allow users to follow/unfollow topic sections. + sectionsContextualAdsEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.contextualAds.enabled + description: >- + Enable contextual ads in sections. + regionSectionsContextualAdsConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.contextualAds.region-config + description: >- + A comma-separated list of regions that get contextual ads by default. + localeSectionsContextualAdsConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.contextualAds.locale-config + description: >- + A comma-separated list of locales that get contextual ads by default. + contextualSpocPlacements: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.placements.contextualSpocs + description: CSV string of spoc placement ids on newtab Pocket grid. A placement id tells our ad server where the ads are intended to be displayed. + contextualSpocCounts: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.placements.contextualSpocs.counts + description: CSV string of spoc placement counts on newtab Pocket grid. The count tells the ad server how many ads to return for this position and placement. + contextualBannerPlacements: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.placements.contextualBanners + description: CSV string of the banner placement ids on newtab Pocket grid. This placement id tells us which banner is visible when contexual ads are on. + contextualBannerCounts: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.placements.contextualBanners.counts + description: CSV string of AdBanner placement counts on newtab Pocket grid. The count tells the ad server how many banners to return for this position and placement. + +newtabInferredPersonalization: + description: about:newtab inferred content personalization settings + owner: rrando@mozilla.com + hasExposure: false + variables: + iv_refresh_frequency_hours: + type: int + description: >- + Time to refresh interest vector in hours + history_cull_days: + type: int + description: >- + Number of days local inferred feature history to preserve + normalized_time_zone_offset: + type: boolean + description: >- + Include normalized (limited to common values) time zone offset in telemetry and requests + local_popular_today_rerank: + type: boolean + description: >- + Whether to rerank popular today section using local interest vector + local_inferred_weight: + type: int + description: >- + Relative rank of the local inferred model, will be normalized by 100 + server_inferred_weight: + type: int + description: >- + Relative rank of merino scores, will be normalized by 100 + +newtabSmartShortcuts: + description: about:newtab personalized shortcuts + owner: rhamoui@mozilla.com, sdowne@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: >- + Enable personalized shortcuts + force_log: + type: boolean + description: >- + Enable logging of shortcut interactions independent of ranking + over_sample_multiplier: + type: int + description: >- + Controls how many multiples of the frecent we sample before reranking + positive_prior: + type: int + description: >- + Alpha in shortcut thompson sampling, exploit faster + negative_prior: + type: int + description: >- + Beta in shortcut thompson sampling, explore longer + thom_weight: + type: int + description: >- + Percentage weight of thompson sampling + frec_weight: + type: int + description: >- + Percentage weight of frecency + hour_weight: + type: int + description: >- + Percentage weight of hourly seasonality + daily_weight: + type: int + description: >- + Percentage weight of daily seasonality + bmark_weight: + type: int + description: >- + Percentage weight of is_bookmark + rece_weight: + type: int + description: >- + Percentage weight of recency + freq_weight: + type: int + description: >- + Percentage weight of frequency + refre_weight: + type: int + description: >- + Percentage weight of redone frecency + bias_weight: + type: int + description: >- + Percentage weight for bias for computing final ranking + fset: + type: int + description: >- + Key for smartshortcuts feature set + eta: + type: int + description: >- + Learning rate for shortcut ranking weights, will divide by 10000 + click_bonus: + type: int + description: >- + bonus multiplier for clicks, will divide by 10 + +newtabSpocsCache: + description: The about:newtab sponsored content cache. + owner: sdowne@mozilla.com + hasExposure: false + variables: + spocsCacheTimeout: + type: int + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.spocs.cacheTimeout + description: >- + Set sponsored content cache timeout in minutes. + spocsStartupCache: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.spocs.startupCache.enabled + description: >- + Controls if spocs should be included in startup cache. + +newtabSponsoredContent: + description: >- + Change and control the sponsored content on newtab. + owner: sdowne@mozilla.com + hasExposure: false + variables: + spocPositions: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.spoc-positions + description: CSV string of spoc position indexes on newtab Pocket grid + spocPlacements: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.placements.spocs + description: CSV string of spoc placement ids on newtab Pocket grid. A placement id tells our ad server where the ads are intended to be displayed. + spocCounts: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.placements.spocs.counts + description: CSV string of spoc placement counts on newtab Pocket grid. The count tells the ad server how many ads to return for this position and placement. + tilesPlacements: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.placements.tiles + description: CSV string of tiles placement ids on newtab tiles section. A placement id tells our ad server where the ads are intended to be displayed. + tilesCounts: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.placements.tiles.counts + description: CSV string of tiles placement counts on newtab tiles section. The count tells the ad server how many ads to return for this position and placement. + +adsBackend: + description: Flags to affect ads backend behavior + owner: efixler@mozilla.com + hasExposure: false + allowCoenrollment: true + variables: + flags: + type: json + description: JSON object of flag names and values to send to the ads backend + +newtabTrainhop: + description: Experiment feature for the train-hopping newtab extension. + owner: mconley@mozilla.com + hasExposure: false + allowCoenrollment: true + variables: + type: + type: string + description: A discriminant to tell different kinds of trainhop experiments apart. + payload: + type: json + description: The experiment configuration. + +newtabTrainhopAddon: + description: Enable download updated newtab resources packaged as an xpi + owner: mconley@mozilla.com + hasExposure: true + exposureDescription: | + Exposure is sent when the trainhop addon version is in use (starting from the browser startup + right after it has been downloaded and installed). + variables: + xpi_download_path: + type: string + description: | + Provide the path (relative to the base URL set in the `browser.newtabpage.trainhopAddon.xpiBaseURL` + about:config pref) from which the xpi should be downloaded. + addon_version: + type: string + description: | + Expected addon version (installing the xpi is cancelled if it mismatches the one set here). + The trainhop add-on version is also stored in an about:config pref, to be used on early + application startup to determine if the trainhop add-on version should be uninstalled + (and not be used for the newtab resources mapping to safely uninstall it later in the + same application session). + setPref: + branch: user + pref: browser.newtabpage.trainhopAddon.version + +newtabTrainhopAddonDeployment: + description: | + Co-enrollment version of newtabTrainhopAddon used to deploy updated newtab + resources packaged as an xpi. Multiple overlapping enrollments are allowed and + the enrollment with the highest addon_version wins. + owner: mconley@mozilla.com + hasExposure: true + allowCoenrollment: true + exposureDescription: | + Exposure is sent when the trainhop addon version from a co-enrolled deployment is in use + (starting from the browser startup right after it has been downloaded and installed). + variables: + xpi_download_path: + type: string + description: | + Provide the path (relative to the base URL set in the `browser.newtabpage.trainhopAddon.xpiBaseURL` + about:config pref) from which the xpi should be downloaded. + addon_version: + type: string + description: | + Expected addon version (installing the xpi is cancelled if it mismatches the one set here). + The trainhop add-on version is also stored in an about:config pref, managed manually by + AboutNewTabResourceMapping to reflect the highest version across all active enrollments + (across both this feature and newtabTrainhopAddon). It is used on early application startup + to determine if the trainhop add-on version should be uninstalled (and not be used for the + newtab resources mapping to safely uninstall it later in the same application session). + +newtabTrainhopFirstStartup: + description: | + Controls startup behaviours if and when a train-hop is available for a + fresh install. + owner: mconley@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: | + True if New Tab should attempt to download, install and enable + train-hopped newtab XPIs for the first profile of new installs on + Windows. This is true by default, but can be set to false to disable. + +newtabTopicSelection: + description: the about:newtab topic selection experience. + owner: nbarrett@mozilla.com + hasExposure: false + variables: + availableTopics: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.topicSelection.topics + description: >- + List of available topics to select for topic selection + suggestedTopics: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.topicSelection.suggestedTopics + description: >- + List of pre-selected topics to display on first run of topic selection modal + topicSelectionOnboarding: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.topicSelection.onboarding.enabled + description: >- + Turns on and off topic selection onbaording + regionTopicsConfig: + description: A comma-separated list of regions that get topics selection by default. + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.topicSelection.region-topics-config + localeTopicsConfig: + description: A comma-separated list of locales that get topics selection by default. + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.topicSelection.locale-topics-config + regionTopicLabelConfig: + description: A comma-separated list of regions that get topic labels by default. + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.topicLabels.region-topic-label-config + localeTopicLabelConfig: + description: A comma-separated list of locales that get topic Labels by default. + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.topicLabels.locale-topic-label-config + +newtabUnifiedAds: + description: Mozilla Ad Routing Service (MARS) unified ads service + owner: mcrawford@mozilla.com, sdowne@mozilla.com + hasExposure: false + variables: + unifiedAdsEndpoint: + description: The URL for the MARS API endpoint. + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.unifiedAds.endpoint + unifiedAdsSpocsEnabled: + type: boolean + description: >- + Enable MARS endpoint to serve ads for recommended stories + setPref: + branch: user + pref: browser.newtabpage.activity-stream.unifiedAds.spocs.enabled + unifiedAdsTilesEnabled: + type: boolean + description: >- + Enable MARS endpoint to serve content for top sites tiles + setPref: + branch: user + pref: browser.newtabpage.activity-stream.unifiedAds.tiles.enabled + unifiedAdsFeedEnabled: + type: boolean + description: >- + Enable AdsFeed to manage all ads request/serving logic + setPref: + branch: user + pref: browser.newtabpage.activity-stream.unifiedAds.adsFeed.enabled + unifiedAdsFeedTilesEnabled: + type: boolean + description: >- + Enable AdsFeed to query MARS server to fetch/serve top sites tiles + setPref: + branch: user + pref: browser.newtabpage.activity-stream.unifiedAds.adsFeed.tiles.enabled + +newtabWidgets: + description: about:newtab widgets feature + owner: mcrawford@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: >- + Enable all widgets + listsEnabled: + type: boolean + description: >- + Enable Lists widget + timerEnabled: + type: boolean + description: >- + Enable Focus Timer widget + clocksEnabled: + type: boolean + description: >- + Enable Clocks widget + sportsWidgetEnabled: + type: boolean + description: >- + Enable Sports widget + listsBadgeEnabled: + type: boolean + description: >- + Show badge on Lists widget to indicate new/beta feature + listsBadgeLabel: + type: string + description: >- + Label type for Lists widget badge (New or Beta) + +pocketNewtab: + description: The Pocket section in newtab + owner: sdowne@mozilla.com + hasExposure: false + isEarlyStartup: true + variables: + contileTopsitesPositions: + type: string + fallbackPref: browser.newtabpage.activity-stream.discoverystream.contile-topsites-positions + description: CSV string of contile position indexes on newtab topsites section + spocAdTypes: + type: string + fallbackPref: browser.newtabpage.activity-stream.discoverystream.spocAdTypes + description: CSV string of data to set the spoc content. + spocZoneIds: + type: string + fallbackPref: browser.newtabpage.activity-stream.discoverystream.spocZoneIds + description: CSV string of data to set the spoc content. + spocSiteId: + type: string + fallbackPref: browser.newtabpage.activity-stream.discoverystream.spocSiteId + description: String ID to set the spoc content. + widgetPositions: + type: string + fallbackPref: browser.newtabpage.activity-stream.discoverystream.widget-positions + description: CSV string of widget position indexes on newtab grid + hybridLayout: + type: boolean + fallbackPref: browser.newtabpage.activity-stream.discoverystream.hybridLayout.enabled + description: Enable compact cards on newtab grid only for specific breakpoints + hideCardBackground: + type: boolean + fallbackPref: browser.newtabpage.activity-stream.discoverystream.hideCardBackground.enabled + description: Removes Pocket card background and borders. + fourCardLayout: + type: boolean + fallbackPref: browser.newtabpage.activity-stream.discoverystream.fourCardLayout.enabled + description: Enable four Pocket cards per row. + newFooterSection: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.newFooterSection.enabled + description: Enable an updated Pocket section topics footer + hideDescriptions: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.hideDescriptions.enabled + description: >- + Hide or display descriptions for Pocket stories on newtab. + hideDescriptionsRegions: + type: string + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.hideDescriptionsRegions + description: >- + CSV string of regions that hide descriptions for Pocket stories on newtab. + compactGrid: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.compactGrid.enabled + description: >- + Reduce the number of pixels between the Pocket cards on newtab. + compactImages: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.compactImages.enabled + description: >- + Reduce the height on Pocket card images on newtab. + imageGradient: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.imageGradient.enabled + description: >- + Add a gradient to the bottom of Pocket card images on newtab to blend the + image in with the card. + titleLines: + type: int + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.titleLines + description: >- + Changes the maximum number of lines a title can be for Pocket cards on newtab. + descLines: + type: int + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.descLines + description: >- + Changes the maximum number of lines a description can be for Pocket cards on newtab. + readTime: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.readTime.enabled + description: >- + Displays an estimated read time for Pocket cards on newtab. + newSponsoredLabel: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.newSponsoredLabel.enabled + description: >- + Updates the sponsored label position to below the image for Pocket cards on newtab. + wallpapers: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.enabled + description: >- + Turns on and off wallpaper support. + wallpapersHighlightEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.highlightEnabled + description: >- + Turns on and off wallpaper feature highlight. + wallpaperHighlightHeaderText: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.highlightHeaderText + description: >- + Changes the wallpaper feature highlight header + wallpaperHighlightContentText: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.highlightContentText + description: >- + Changes the wallpaper feature highlight content + wallpaperHighlightCtaText: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.highlightCtaText + description: >- + Changes the wallpaper feature highlight cta + currentWallpaper: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.wallpaper + description: >- + Changes the currently selected wallpaper + weatherLocationSearch: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.weather.locationSearchEnabled + description: >- + Turns on and off location search for newtab weather widget + spocsEndpoint: + description: The URL for the spocs endpoint. + type: string + setPref: + branch: user + pref: "browser.newtabpage.activity-stream.discoverystream.spocs-endpoint" + spocsEndpointAllowlist: + description: Comma separated list of allowed endpoints for fetching spocs + type: string + setPref: + branch: user + pref: "browser.newtabpage.activity-stream.discoverystream.endpoints" + spocsClearEndpoint: + description: URL for deleting any server data when a user opts out of sponsored content + type: string + setPref: + branch: user + pref: "browser.newtabpage.activity-stream.discoverystream.endpointSpocsClear" + ctaButtonSponsors: + description: A CSV list of sponsors that should use a button CTA. + type: string + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.ctaButtonSponsors + ctaButtonVariant: + description: Specifies which variant to use for any sponsors in ctaButtonSponsors + type: string + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.ctaButtonVariant + regionStoriesConfig: + description: A comma-separated list of region to get stories for. + type: string + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.region-stories-config + merinoProviderEndpoint: + type: string + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.merino-provider.endpoint + description: Merino endpoint to use for recommendations. + regionStoriesBlock: + description: A comma-separated list of regions that do not get stories, regardless of locale-list-config. + type: string + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.region-stories-block + localeListConfig: + description: A comma-separated list of locales that get stories, regardless of region-stories-config. + type: string + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.locale-list-config + regionSpocsConfig: + description: A comma-separated list of regions that get spocs by default. + type: string + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.region-spocs-config + regionWeatherConfig: + description: A comma-separated list of regions that get weather by default. + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.region-weather-config + localeWeatherConfig: + description: A comma-separated list of locales that weather widget supports. + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.locale-weather-config + topSitesMaxSponsored: + # Defined under `pocketNewtab` as it needs to be used along with other variables + type: int + description: The maximum number of sponsored Top Sites to be displayed + topSitesContileMaxSponsored: + # Defined under `pocketNewtab` as it needs to be used along with other variables + type: int + description: The maximum number of sponsored Top Sites used from Contile + pocketFeedParameters: + type: string + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.pocket-feed-parameters + description: >- + Add parameters to Pocket feed URL. + merinoFeedExperiment: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.merino-feed-experiment + description: >- + Should we pass the experiment branch and slug to the Merino feed request. + +sessionRestore: + description: Session restore feature + owner: sfoster@mozilla.com + hasExposure: false + variables: + startupBehavior: + type: int + setPref: + branch: user + pref: browser.startup.page + description: | + Should we resume the previous session? Startup behavior is a choice of 4 possible values: + 0 = open a blank tab, + 1 = open the configured homepage in a tab (default, session restore disabled), + 2 = open last visited page in a tab, + 3 = re-open previous windows and tabs (session restore enabled) + +sessionRestoreNewTab: + description: Open a new tab after session restore on startup + owner: hsohaney@mozilla.com + hasExposure: true + exposureDescription: > + Recorded when a setting-based session restore occurs at startup, + regardless of whether the new tab feature is enabled. + variables: + enabled: + type: boolean + setPref: + branch: default + pref: browser.sessionstore.newTabOnRestore + description: Whether to open a new tab after session restore on startup. + showSetting: + type: boolean + setPref: + branch: default + pref: browser.sessionstore.newTabOnRestore.showSetting + description: Whether to show the new-tab-on-restore checkbox in about:preferences. + +screenshots: + description: The built-in Screenshots feature + owner: sfoster@mozilla.com + hasExposure: false + variables: + buttonOnToolbarByDefault: + type: boolean + description: The screenshots button will be placed on the toolbar by default. + +password-autocomplete: + description: A special autocomplete UI for password fields. + owner: sgalich@mozilla.com + hasExposure: false + variables: + directMigrateSingleProfile: + type: boolean + description: Enable direct migration? + + +# This feature flag mirrors the one used for ios +# https://github.com/mozilla-mobile/firefox-ios/blob/main/nimbus-features/addressAutofillFeature.yaml +address-autofill-feature: + description: Enabling address autofill feature + owner: issozi@mozilla.com + hasExposure: false + variables: + status: + type: boolean + setPref: + branch: default + pref: extensions.formautofill.addresses.experiments.enabled + description: If true, we will allow user to use address autofill + +creditcards-autofill-enabled: + description: Credit card autofill is enabled in all regions + owner: issozi@mozilla.com + hasExposure: false + variables: + creditcardsSupported: + description: Enable credit card autofill in all regions + type: string + setPref: + branch: default + pref: extensions.formautofill.creditCards.supported + +shellService: + description: "Interface with OS, e.g., pinning and set default" + owner: desktop-integrations@mozilla.com + hasExposure: false + variables: + disablePin: + type: boolean + description: Disable pin to taskbar feature + disableStartMenuPin: + type: boolean + setPref: + branch: user + pref: browser.shell.disableStartMenuPin + description: Disable pin to start menu feature + setDefaultBrowserUserChoice: + type: boolean + setPref: + branch: user + pref: browser.shell.setDefaultBrowserUserChoice + description: Should it set as default browser + setDefaultBrowserUserChoiceRegRename: + type: boolean + setPref: + branch: user + pref: browser.shell.setDefaultBrowserUserChoice.regRename + description: When setting default via UserChoice, rename the underlying registry key to prevent kennel driver registry locking. + setDefaultPDFHandler: + type: boolean + fallbackPref: browser.shell.setDefaultPDFHandler + description: Should setting it as the default browser set it as the default PDF handler. + setDefaultPDFHandlerOnlyReplaceBrowsers: + type: boolean + fallbackPref: browser.shell.setDefaultPDFHandler.onlyReplaceBrowsers + description: >- + Should setting it as the default PDF handler only replace existing PDF + handlers that are browsers, and not other PDF handlers such as Acrobat + Reader or Nitro PDF. + setDefaultGuidanceNotifications: + type: boolean + fallbackPref: browser.shell.setDefaultGuidanceNotifications + description: Whether or not the user should see the guidance notifications when setting Firefox as their default browser. + focusSetDefaultBrowserButton: + description: Focus the set default browser button in Windows Settings. + setPref: + branch: user + pref: browser.shell.focusSetDefaultBrowserButton + type: boolean + displayKitImageBehindSetDefaultBrowserButton: + description: > + Display a Kit image behind the set default browser button in Windows + Settings. + setPref: + branch: user + pref: browser.shell.displayKitImageBehindSetDefaultBrowserButton + type: string + enum: + - "off" + - "static" + - "animated" +upgradeDialog: + description: The dialog shown for major upgrades + owner: omc-core@mozilla.com + hasExposure: false + isEarlyStartup: true + variables: + enabled: + type: boolean + fallbackPref: browser.startup.upgradeDialog.enabled + description: Is the feature enabled? + +cfr: + description: "A Firefox Messaging System message for the cfr message channel" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +"moments-page": + description: "A Firefox Messaging System message for the moments-page message channel" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +infobar: + description: "A Firefox Messaging system message for the infobar message channel" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +spotlight: + description: "A Firefox Messaging System message for the spotlight message channel" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +# Before 117, this feature only included one variable, pdfJsTourProgress. So, +# the minimum version for messaging experiments using this feature ID is 117. +featureCallout: + description: "A Firefox Messaging System message for the Feature Callout message channel" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +privacySecurityMessaging: + description: Supports experimental messaging related to privacy and security. + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + Exposure is sent when a milestone doorhanger message is seen or when the + milestone section of the protections popup is seen. + variables: + blockingMilestoneMessagingEnabled: + type: boolean + setPref: + branch: user + pref: browser.contentblocking.cfr-milestone.enabled + description: >- + Enable messaging related to content blocking milestones. Setting to + false disables both the milestone doorhanger and the milestone section + of the protections popup. + blockingMilestones: + type: string + setPref: + branch: user + pref: browser.contentblocking.cfr-milestone.milestones + description: >- + A JSON array of milestones to trigger messaging for. Milestones are + defined as the number of times a user has had tracking content blocked, + e.g., [1000, 5000, 10000...]. See the pref for default values. The list + should typically have 7 entries, because the built-in milestone messages + are allowed to show 7 times. If you want more or fewer milestones, you + should override the milestone messages by also including a messaging + feature in your experiment, so you can include a replacement message + with a frequency cap matching the number of milestones. Use a feature + like fxms-message-* to do that. + blockingMilestoneUpdateInterval: + type: int + setPref: + branch: user + pref: browser.contentblocking.cfr-milestone.update-interval + description: >- + How often (in milliseconds) we check if the user is eligible for seeing + a milestone doorhanger. 24 hours by default. + +fullPageTranslation: + description: This feature opens a popup panel to offer to translate a page. + owner: gtatum@mozilla.com + hasExposure: false + variables: + boolean: + description: Set to true to enable the translations feature + type: boolean + setPref: + branch: user + pref: browser.translations.enable + +fullPageTranslationAutomaticPopup: + description: Controls whether the popup automatically shows for translations. + owner: gtatum@mozilla.com + hasExposure: false + variables: + boolean: + description: Set to true to automatically popup, and false to only show the button. + type: boolean + setPref: + branch: user + pref: browser.translations.automaticallyPopup + +selectTranslation: + description: This feature enables the option to translate selected text from the context menu. + owner: enordin@mozilla.com + hasExposure: false + variables: + enabled: + description: Set to true to enable the select-translations feature + type: boolean + setPref: + branch: user + pref: browser.translations.select.enable + +translationsQuickAction: + description: This feature enables the translations quick action in the URL bar. + owner: enordin@mozilla.com + hasExposure: false + variables: + enabled: + description: Set to true to enable the translations quick action feature. + type: boolean + setPref: + branch: user + pref: browser.translations.quickAction.enabled + +pdfjs: + description: The Firefox pdf reader. + owner: pdfjs-team@mozilla.com + hasExposure: true + exposureDescription: >- + Exposure is sent each time a pdf is displayed. + variables: + enableAltText: + description: Set to true to enable alt text generation. + type: boolean + setPref: + branch: default + pref: pdfjs.enableAltText + enableUpdatedAddImage: + description: Set to true to enable updated add image with alt text flow. + type: boolean + setPref: + branch: default + pref: pdfjs.enableUpdatedAddImage + browserMlEnable: + description: Set to true to enable local inference engine + type: boolean + setPref: + branch: default + pref: browser.ml.enable + enableSignatureEditor: + description: Set to true to enable the signature editor + type: boolean + setPref: + branch: default + pref: pdfjs.enableSignatureEditor + enableSignatureVerification: + description: >- + Set to true to enable digital signature verification, which validates a + PDF's signatures against NSS and exposes the certificate viewer. + type: boolean + setPref: + branch: default + pref: pdfjs.enableSignatureVerification + +fxms-message: + description: A messaging channel that supports multiple simultaneous enrollments + owner: omc@mozilla.com + allowCoenrollment: true + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +# fxms-message-* placeholder feature ids +# +# https://docs.google.com/spreadsheets/d/119YbeKStLL0Fg2QkK-yN93mrtD1rlneGZGTl_jAwtyw/edit#gid=1903378504 +# has info on using these placeholder feature ids, as well as (very short) instructions on +# checking to see if we need more (which we do once per Nightly) and how to add them. +# +# Instructions for adding a new fxms-message-* placeholder feature id +# 1) clone an existing one here +# 2) update the YAML feature id to the next unused number +# 3) update the YAML description; include what versions can be targeted on this feature ID +# 4) add the new feature id to MESSAGING_EXPERIMENTS_DEFAULT_FEATURES list in MessagingExperimentConstants.sys.mjs +# 5) add a new corresponding reach metric to /toolkit/components/messaging-system/metrics.yaml +# 6) add the new feature id to the `messaging_experiments` > `reach` > `objects` list in /toolkit/telemetry/Events.yaml +# 7) add the new feature id and the version it landed in to the spreadsheet tab linked to above + +fxms-message-1: + description: "A Firefox Messaging System message" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-2: + description: "Firefox Messaging System message 2" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-3: + description: "Firefox Messaging System message 3" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-4: + description: "Firefox Messaging System message 4" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-5: + description: "Firefox Messaging System message 5" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-6: + description: "Firefox Messaging System message 6" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-7: + description: "Firefox Messaging System message 7" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-8: + description: "Firefox Messaging System message 8" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-9: + description: "Firefox Messaging System message 9" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-10: + description: "Firefox Messaging System message 10" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-11: + description: "Firefox Messaging System message 11" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-12: + description: "Firefox Messaging System message 12 - ONLY for Fx140+ targeting" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-13: + description: "Firefox Messaging System message 13 - ONLY for Fx140+ targeting" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-14: + description: "Firefox Messaging System message 14 - ONLY for Fx140+ targeting" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-15: + description: "Firefox Messaging System message 15 - ONLY for Fx140+ targeting" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-16: + description: "Firefox Messaging System message 16 - ONLY for Fx144+ targeting" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-17: + description: "Firefox Messaging System message 17 - ONLY for Fx144+ targeting" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-18: + description: "Firefox Messaging System message 18 - ONLY for Fx144+ targeting" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-19: + description: "Firefox Messaging System message 19 - ONLY for Fx144+ targeting" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-20: + description: "Firefox Messaging System message 20 - ONLY for Fx144+ targeting" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-21: + description: "Firefox Messaging System message 21 - ONLY for Fx144+ targeting" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-22: + description: "Firefox Messaging System message 22 - ONLY for Fx144+ targeting" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-23: + description: "Firefox Messaging System message 23 - ONLY for Fx144+ targeting" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-24: + description: "Firefox Messaging System message 24 - ONLY for Fx144+ targeting" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +fxms-message-25: + description: "Firefox Messaging System message 25 - ONLY for Fx144+ targeting" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +whatsNewPage: + description: "A Firefox Messaging System message for the What's new page channel" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + variables: + overrideUrl: + description: URL of the What's new page + type: string + setPref: + branch: user + pref: startup.homepage_override_url_nimbus + maxVersion: + description: Maximum Firefox update version + type: string + setPref: + branch: user + pref: startup.homepage_override_nimbus_maxVersion + minVersion: + description: Minimum Firefox update version + type: string + setPref: + branch: user + pref: startup.homepage_override_nimbus_minVersion + disableWNP: + description: >- + Block all What's New Pages. Used to compare no-WNP control branches to + WNP treatment branches. + type: boolean + setPref: + branch: user + pref: startup.homepage_override_nimbus_disable_wnp + +pbNewtab: + description: "A Firefox Messaging System message for the pbNewtab message channel" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched. + schema: + uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json" + variables: {} + +backgroundTaskMessage: + description: "A Firefox Messaging System message for the background task message channel" + owner: nalexander@mozilla.com + applications: + - firefox-desktop-background-task + hasExposure: true + exposureDescription: >- + Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched. + schema: + uri: "chrome://browser/content/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json" + path: "browser/components/asrouter/content-src/schemas/BackgroundTaskMessagingExperiment.schema.json" + variables: {} + +backgroundUpdateAutomaticRestart: + description: "Whether to automatically restart when the background update task could make more progress." + owner: nalexander@mozilla.com + applications: + - firefox-desktop-background-task + hasExposure: false + variables: + enabled: + type: boolean + fallbackPref: app.update.background.automaticRestartEnabled + description: >- + When true, make the background update task restart when the final update state is `READY_FOR_RESTART`. + Generally, this will finish applying a staged update, completing the update earlier than it + otherwise would have been completed. + +backgroundUpdateCheckPolicy: + description: >- + Control when to 'allow' and when to 'throttle' the background update task so + that the task runs but does not necessarily check for updates. The check + policy allows to tell the background update task to not check for, download, + and apply, updates in certain situations, thereby reducing update-related + operational costs. It also allows to limit the number of actions taken in + any given interval, thereby reducing user resource usage and Nimbus-related + operational costs. + owner: install-update@mozilla.com + applications: + - firefox-desktop-background-task + hasExposure: false + variables: + throttleEnabled: + type: boolean + fallbackPref: app.update.background.checkPolicy.throttleEnabled + description: >- + When true, the background update task will 'throttle' itself and not + necessarily check for updates. + throttleAfterDays: + type: int + fallbackPref: app.update.background.checkPolicy.throttleAfterDays + description: >- + When greater than or equal to 0, the number of consecutive days that the + background update task will run and check for updates when the task has + not witnessed a Firefox browsing profile running. N.b.: when 0, this + will disable the background update task checking for updates entirely. + throttleDebouncePeriodInHours: + type: int + fallbackPref: app.update.background.checkPolicy.throttleDebouncePeriodInHours + description: >- + When greater than 0, limit the background update task, when it is + throttled, from taking any action at all to at most one (1) time in + every "period" hours. That is, if `throttledDebouncePeriodInHours=24` + and the background update task executes at time `t0`, then the + background update task will exit without further action every invocation + at time `t1 < t0 + 24 hours`. + +pictureinpicture: + description: Message for first time Picture-in-Picture users + owner: nbaumgardner@mozilla.com + hasExposure: true + exposureDescription: Exposure is sent when a user hovers over a video and Picture-in-Picture has not been used before + variables: + title: + type: string + description: The title to be used for the PiP toggle + message: + type: string + description: The message to be used in the PiP toggle + showIconOnly: + type: boolean + description: Whether to show the first time PiP toggle or show the PiP icon only + oldToggle: + type: boolean + description: Whether to show the control style (true) or variant style (false) for the first time PiP toggle + displayDuration: + type: int + description: Duration of PiP first time toggle display in days before switching to PiP icon toggle + +glean: + description: "The Glean data-control-plane feature within Firefox Desktop for controlling metric configuration" + owner: glean-team@mozilla.com + applications: + - firefox-desktop + - firefox-desktop-background-task + hasExposure: false + allowCoenrollment: true + variables: + gleanMetricConfiguration: + type: json + description: | + A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric. + This variable is intended for interacting with the Glean data-control-plane via the Server Knobs functionality + to remotely configure metrics to be enabled or disabled. + +gleanInternalSdk: + description: "The Glean internal SDK feature intended only for internal Glean Team use" + owner: glean-team@mozilla.com + applications: + - firefox-desktop + - firefox-desktop-background-task + hasExposure: false + variables: + finalInactive: + type: "boolean" + description: "Enables FOG early shutdown pings when true" + setPref: + branch: user + pref: telemetry.glean.internal.finalInactive + gleanMetricConfiguration: + type: json + description: | + A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric. + This is not for public use! For data-control-plane use, please refer to the Glean documentation and use the + `gleanMetricConfiguration` found in the `glean` feature for this. + gleanMaxPingsPerMinute: + type: int + description: >- + Maximum number of pings that can be sent in a 60 second interval + setPref: + branch: user + pref: telemetry.glean.internal.maxPingsPerMinute + enableFOGTransport: + type: "boolean" + description: "Enables FOGTransport parent/child for IPC" + setPref: + branch: user + pref: telemetry.fog.enable_fog_transport + +legacyTelemetry: + description: "Controls for the Legacy Telemetry data collection system" + owner: chutten@mozilla.com + applications: + - firefox-desktop + hasExposure: false + variables: + disabledPings: + type: json + description: | + A list of Legacy Telemetry pings to disable. + Pings on this list will not be archived or uploaded. + On submit their payloads will be dropped. + Code that collects to and submits the ping will still operate as normal. + Cannot be used to disable the "main", "first-shutdown", "new-profile", + or "deletion-request" pings. + disableMainPingScalars: + type: boolean + description: | + If true, scalars will not be included in "main" pings. + Exceptions are made for two important engagement measures: + `browser.engagement.total_uri_count_normal_and_private_mode` and + `browser.engagement.active_ticks`. + These scalars will continue to be reported as normal, even if all + others are disabled by this variable. + disableMainPingHgrams: + type: boolean + description: | + If true, histograms will not be included in "main" pings. + Data will still be recorded locally, + it will merely not be included in "main" pings when they are submitted. + +browserLowMemoryPrefs: + description: Prefs which control the browser's behaviour under low memory. + owner: haftandilian@mozilla.com + hasExposure: false + variables: + lowMemoryResponseMask: + description: Control the response on macOS when under memory pressure. + type: int + setPref: + branch: default + pref: "browser.lowMemoryResponseMask" + lowMemoryResponseOnWarn: + description: Controls which macOS memory-pressure levels trigger the browser low memory response. + type: boolean + setPref: + branch: default + pref: "browser.lowMemoryResponseOnWarn" + tabsUnloadOnLowMemory: + description: Whether to unload tabs when available memory is running low. + type: boolean + setPref: + branch: default + pref: "browser.tabs.unloadOnLowMemory" + +echPrefs: + description: Prefs that control Encrypted Client Hello. + owner: djackson@mozilla.com + hasExposure: false + variables: + tlsEnabled: + description: Whether to enable ECH for connections using TLS + type: boolean + setPref: + branch: default + pref: "network.dns.echconfig.enabled" + h3Enabled: + description: Whether to enable ECH for connections using H3/QUIC + type: boolean + setPref: + branch: default + pref: "network.dns.http3_echconfig.enabled" + forceWaitHttpsRR: + description: Whether to force waiting for HTTPS DNS records, which ECH requires. + type: boolean + setPref: + branch: default + pref: "network.dns.force_waiting_https_rr" + insecureFallback: + description: Whether to fallback to non-ECH connections if all ECH RRs fail. + type: boolean + setPref: + branch: default + pref: "network.dns.echconfig.fallback_to_origin_when_all_failed" + tlsGreaseProb: + description: Probability of GREASEing a TLS connection with ECH (0-100). + type: int + setPref: + branch: default + pref: "security.tls.ech.grease_probability" + h3GreaseEnabled: + description: Whether to apply GREASE settings to H3/QUIC connections. + type: boolean + setPref: + branch: default + pref: "security.tls.ech.grease_http3" + disableGreaseOnFallback: + description: Whether to disable GREASE when retrying a connection. + type: boolean + setPref: + branch: default + pref: "security.tls.ech.disable_grease_on_fallback" + greasePaddingSize: + description: Assumed echConfig padding length for GREASE extensions (1-255). + type: int + setPref: + branch: default + pref: "security.tls.ech.grease_size" + +dohPrefs: + description: Prefs that control DNS over HTTPS. + owner: vgosu@mozilla.com + hasExposure: false + variables: + trrMode: + description: Has a value of 2 for TRR first, 3 for TRR only, 0 for off. + type: int + setPref: + branch: default + pref: "network.trr.mode" + trrUri: + description: The URL of the DNS over HTTPS endpoint + type: string + setPref: + branch: default + pref: "network.trr.uri" + dohMode: + description: Same as trrMode, but set by the DoHController module. + type: int + setPref: + branch: default + pref: "doh-rollout.mode" + dohUri: + description: Same as trrUri, but set by the DoHController module. + type: string + setPref: + branch: default + pref: "doh-rollout.uri" + dohProviderList: + description: An override of the rollout provider-list json + type: string + setPref: + branch: default + pref: "doh-rollout.provider-list" + dohProviderSteeringList: + description: An override of the rollout steering provider-list json + type: string + setPref: + branch: default + pref: "doh-rollout.provider-steering.provider-list" + nativeHTTPSRecords: + description: Whether we can perform native DNS HTTPS lookups + type: boolean + setPref: + branch: default + pref: "network.dns.native_https_query" + +dooh: + description: "DNS over Oblivious HTTP" + owner: vgosu@mozilla.com + hasExposure: false + variables: + ohttpEnabled: + description: Whether to use Oblivious HTTP for the resolution + type: boolean + setPref: + branch: default + pref: "network.trr.use_ohttp" + ohttpRelayUri: + description: The URL of the Oblivious HTTP relay + type: string + setPref: + branch: default + pref: "network.trr.ohttp.relay_uri" + ohttpConfigUri: + description: The URL used to fetch the configuration of the Oblivious HTTP gateway + type: string + setPref: + branch: default + pref: "network.trr.ohttp.config_uri" + ohttpUri: + description: The URL of the Oblivious DNS over HTTPS target resource + type: string + setPref: + branch: default + pref: "network.trr.ohttp.uri" + +networking: + description: "Firefox Networking (Necko)" + owner: vgosu@mozilla.com + hasExposure: false + variables: + preconnect: + description: Whether the rel=preconnect feature is enabled + type: boolean + setPref: + branch: default + pref: "network.preconnect" + http3CCalgorithm: + description: The congestion control algorithm with which to configure neqo. 0 for NewReno, 1 for Cubic + type: int + setPref: + branch: default + pref: "network.http.http3.cc_algorithm" + http3SlowStartAlgorithm: + description: The slow start algorithm with which to configure neqo. Use 0 for Classic, 1 for HyStart++, 2 for SEARCH. + type: int + setPref: + branch: default + pref: "network.http.http3.slow_start_algorithm" + http3HyStartAlternativeCssBaseline: + description: Whether the HyStart++ alternative CSS baseline value should be used. Has no effect if HyStart++ is not used. + type: boolean + setPref: + branch: default + pref: "network.http.http3.hystart_alternative_css_baseline" + http3SpuriousRecovery: + description: Whether Spurious Congestion Event Recovery is turned on. + type: boolean + setPref: + branch: default + pref: "network.http.http3.spurious_recovery" + enableOffMainThreadStreamDecompression: + description: Whether to enable decompression of network streams off-main-thread + type: boolean + setPref: + branch: default + pref: "network.decompression_off_mainthread2" + offMainThreadStreamDecompressionThreshold: + description: Minimum content length for off-main-thread decompression + type: int + setPref: + branch: default + pref: "network.decompression_off_mainthread_min_size" + dnsGracePeriod: + description: The grace period allows the DNS cache to use expired entries, while kicking off a revalidation in the background. + type: int + setPref: + branch: default + pref: "network.dnsCacheExpirationGracePeriod" + http3UseNSPRForIO: + description: true by default using legacy UDP IO via NSPR. When set to false, uses new UDP IO via Fast UDP for Firefox project. + type: boolean + setPref: + branch: default + pref: "network.http.http3.use_nspr_for_io" + prefetchNext: + description: Enables the prefetch service (i.e., prefetching of and URLs). + type: boolean + setPref: + branch: default + pref: "network.prefetch-next" + +networkingEarlyHints: + description: "Networking (Necko) Early Hints" + owner: vgosu@mozilla.com + hasExposure: false + variables: + ehPreloadEnabled: + description: Whether Early Hints preload is enabled + type: boolean + setPref: + branch: default + pref: "network.early-hints.enabled" + ehPreconnectEnabled: + description: Whether Early Hints preconnect is enabled + type: boolean + setPref: + branch: default + pref: "network.early-hints.preconnect.enabled" + +networkingDNS: + description: "Networking (Necko) DNS" + owner: vgosu@mozilla.com + hasExposure: false + variables: + dnsMaxPriorityThreads: + description: The maximum number of high priority DNS threads that can be created. + type: int + setPref: + branch: default + pref: "network.dns.max_high_priority_threads" + dnsMaxAnyPriorityThreads: + description: The maximum number of DNS threads that can be created to handle any priority DNS requests. + type: int + setPref: + branch: default + pref: "network.dns.max_any_priority_threads" + maxDnsCacheEntries: + description: This is the number of dns cache entries allowed + type: int + setPref: + branch: default + pref: "network.dnsCacheEntries" + +networkingConnections: + description: "Networking (Necko) Connections" + owner: vgosu@mozilla.com + hasExposure: false + variables: + httpMaxConnections: + description: The maximum number of http connections. + type: int + setPref: + branch: default + pref: "network.http.max-connections" + httpMaxPersistentConnectionsPerServer: + description: The maximum number of persistent connections to a server + type: int + setPref: + branch: default + pref: "network.http.max-persistent-connections-per-server" + httpMaxUrgentStartExcessiveConnectionsPerHost: + description: Number of connections that we can open beyond the standard parallelism limit defined by max-persistent-connections-per-server/-proxy to handle urgent-start marked requests. + type: int + setPref: + branch: default + pref: "network.http.max-urgent-start-excessive-connections-per-host" + speculativeConnectionLimit: + description: The maximum number of half-open sockets allowed for speculative connections + type: int + setPref: + branch: default + pref: "network.http.speculative-parallel-limit" + happyEyeballsEnabled: + description: Whether to enable the Happy Eyeballs v3 algorithm for connection establishment + type: boolean + setPref: + branch: default + pref: "network.http.happy_eyeballs_enabled" + happyEyeballsResolutionDelay: + description: Time in ms to wait after the first DNS response before starting connections + type: int + setPref: + branch: default + pref: "network.http.happy_eyeballs_resolution_delay" + happyEyeballsConnectionAttemptDelay: + description: Time in ms between successive connection attempts + type: int + setPref: + branch: default + pref: "network.http.happy_eyeballs_connection_attempt_delay" + + +networkingSendOnDataFinished: + description: "Networking (Necko) OnDataFinished" + owner: vgosu@mozilla.com + hasExposure: false + variables: + sendOnDataFinished: + description: Whether we can send OnDataFinished in the content process + type: boolean + setPref: + branch: default + pref: "network.send_OnDataFinished" + sendOnDataFinishedFromInputStreamPump: + description: Whether we can send OnDataFinished to the content process from InputStreamPump + type: boolean + setPref: + branch: default + pref: "network.send_OnDataFinished.nsInputStreamPump" + sendOnDataFinishedToHtml5parser: + description: Whether we can send OnDataFinished to the html5parser in content process + type: boolean + setPref: + branch: default + pref: "network.send_OnDataFinished.html5parser" + sendOnDataFinishedToCssLoader: + description: Whether we can send OnDataFinished to the cssLoader in content process + type: boolean + setPref: + branch: default + pref: "network.send_OnDataFinished.cssLoader" + +networkingBannedPorts: + description: "Networking (Necko) Banned Ports" + owner: vgosu@mozilla.com + hasExposure: false + variables: + bannedPortList: + description: A comma-separated list of ports that Firefox will refuse to connect to. These ports will be appended to nsIOService gBadPortList + type: string + setPref: + branch: default + pref: "network.security.ports.banned" + +localNetworkAccess: + description: "Networking (Necko) Local Network Access prefs" + owner: vgosu@mozilla.com + hasExposure: false + variables: + enableLNAWithETPStrict: + description: Whether to enable LNA restrictions in ETP Strict Mode + type: boolean + setPref: + branch: default + pref: "network.lna.etp.enabled" + blockTrackers: + description: Whether network requests triggered by third party scripts classified as trackers should be blocked when making a localhost request. + type: boolean + setPref: + branch: default + pref: "network.lna.block_trackers" + lnaPromptsEnabled: + description: Whether we should prompt users for permission whenever we detect local network access. + type: boolean + setPref: + branch: default + pref: "network.lna.blocking" + lnaFeatureEnabled: + description: Blanket flag to enable/disable LNA sub-features. + type: boolean + setPref: + branch: default + pref: "network.lna.enabled" + blockInsecureContexts: + description: Whether LNA requests from insecure contexts should be blocked outright, without prompting the user for permission. + type: boolean + setPref: + branch: default + pref: "network.lna.block_insecure_contexts" + +essentialFallbackDomains: + description: "Whether to retry failing system requests with a backup domain" + owner: vgosu@mozilla.com + hasExposure: false + variables: + essentialDomainsEnabled: + description: Whether to retry with a backup domain indicated in remote-settings + type: boolean + setPref: + branch: default + pref: "network.essential_domains_fallback" + +disableHttp3: + description: "Whether HTTP/3 is disabled" + owner: kershaw@mozilla.com + hasExposure: false + variables: + withThirdPartyRoots: + description: If third party roots are detected, disable HTTP/3 + type: boolean + setPref: + branch: default + pref: "network.http.http3.disable_when_third_party_roots_found" + + +networkPrioritization: + description: "Network request prioritization" + owner: vgosu@mozilla.com + hasExposure: false + variables: + priorityHeader: + description: Whether to set the Priority header on each request. + type: boolean + setPref: + branch: default + pref: "network.http.priority_header.enabled" + fetchPriority: + description: Whether fetch priority is enabled + type: boolean + setPref: + branch: default + pref: "network.fetchpriority.enabled" + h3FetchPriority: + description: Whether to send HTTP3 priority frames + type: boolean + setPref: + branch: default + pref: "network.http.http3.priority" + sendNoRFC7540Setting: + description: Whether to send the SETTINGS_NO_RFC7540_PRIORITIES for the HTTP2 session. + type: boolean + setPref: + branch: default + pref: "network.http.http2.send_NO_RFC7540_PRI" + h2deps: + description: Whether RFC7540 priorities / stream dependencies are enabled + type: boolean + setPref: + branch: default + pref: "network.http.http2.enabled.deps" + h3BackgroundTabDeprioritization: + description: Lowers the priority when the tab is in the background. Potential privacy concerns. + type: boolean + setPref: + branch: default + pref: "network.http.http3.send_background_tabs_deprioritization" + documentPriorityIncremental: + description: Sets the incremental flag on the Priority header for document requests + type: boolean + setPref: + branch: default + pref: "dom.document_priority.incremental" + imagePriorityIncremental: + description: Sets the incremental flag on the Priority header for image requests + type: boolean + setPref: + branch: default + pref: "image.priority.incremental" + imageAdjustLayoutPriority: + description: Whether the network request priority should be adjusted according the layout and view frame position of each particular image. + type: boolean + setPref: + branch: default + pref: "image.layout_network_priority" + adjustLinkPreloadScriptLow: + description: Priority adjustment low for link-preload-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-script.low" + adjustLinkPreloadScriptHigh: + description: Priority adjustment high for link-preload-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-script.high" + adjustLinkPreloadScriptAuto: + description: Priority adjustment auto for link-preload-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-script.auto" + adjustModuleScriptLow: + description: Priority adjustment low for module-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.module-script.low" + adjustModuleScriptHigh: + description: Priority adjustment high for module-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.module-script.high" + adjustModuleScriptAuto: + description: Priority adjustment auto for module-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.module-script.auto" + adjustAsyncOrDeferScriptLow: + description: Priority adjustment low for async-or-defer-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.async-or-defer-script.low" + adjustAsyncOrDeferScriptHigh: + description: Priority adjustment high for async-or-defer-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.async-or-defer-script.high" + adjustAsyncOrDeferScriptAuto: + description: Priority adjustment auto for async-or-defer-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.async-or-defer-script.auto" + adjustScriptInHeadLow: + description: Priority adjustment low for script-in-head + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.script-in-head.low" + adjustScriptInHeadHigh: + description: Priority adjustment high for script-in-head + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.script-in-head.high" + adjustScriptInHeadAuto: + description: Priority adjustment auto for script-in-head + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.script-in-head.auto" + adjustOtherScriptLow: + description: Priority adjustment low for other-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.other-script.low" + adjustOtherScriptHigh: + description: Priority adjustment high for other-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.other-script.high" + adjustOtherScriptAuto: + description: Priority adjustment auto for other-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.other-script.auto" + adjustLinkPreloadFontLow: + description: Priority adjustment low for link-preload-font + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-font.low" + adjustLinkPreloadFontHigh: + description: Priority adjustment high for link-preload-font + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-font.high" + adjustLinkPreloadFontAuto: + description: Priority adjustment auto for link-preload-font + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-font.auto" + adjustLinkPreloadFetchLow: + description: Priority adjustment low for link-preload-fetch + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-fetch.low" + adjustLinkPreloadFetchHigh: + description: Priority adjustment high for link-preload-fetch + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-fetch.high" + adjustLinkPreloadFetchAuto: + description: Priority adjustment auto for link-preload-fetch + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-fetch.auto" + adjustDeferredStyleLow: + description: Priority adjustment low for deferred-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.deferred-style.low" + adjustDeferredStyleHigh: + description: Priority adjustment high for deferred-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.deferred-style.high" + adjustDeferredStyleAuto: + description: Priority adjustment auto for deferred-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.deferred-style.auto" + adjustLinkPreloadStyleLow: + description: Priority adjustment low for link-preload-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-style.low" + adjustLinkPreloadStyleHigh: + description: Priority adjustment high for link-preload-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-style.high" + adjustLinkPreloadStyleAuto: + description: Priority adjustment auto for link-preload-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-style.auto" + adjustNonDeferredStyleLow: + description: Priority adjustment low for non-deferred-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.non-deferred-style.low" + adjustNonDeferredStyleHigh: + description: Priority adjustment high for non-deferred-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.non-deferred-style.high" + adjustNonDeferredStyleAuto: + description: Priority adjustment auto for non-deferred-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.non-deferred-style.auto" + adjustGlobalFetchApiLow: + description: Priority adjustment low for global-fetch-api + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.global-fetch-api.low" + adjustGlobalFetchApiHigh: + description: Priority adjustment high for global-fetch-api + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.global-fetch-api.high" + adjustGlobalFetchApiAuto: + description: Priority adjustment auto for global-fetch-api + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.global-fetch-api.auto" + adjustImagesLow: + description: Priority adjustment low for images + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.images.low" + adjustImagesHigh: + description: Priority adjustment high for images + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.images.high" + adjustImagesAuto: + description: Priority adjustment auto for images + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.images.auto" + lowerTrackersPriority: + description: Whether to lower priority of resources on the tracking protection list + type: boolean + setPref: + branch: default + pref: "privacy.trackingprotection.lower_network_priority" + enableHttpTailing: + description: Whether certain requests, mainly trackers, are put to the "tail", behind other requests + type: boolean + setPref: + branch: default + pref: "network.http.tailing.enabled" + httpTailingUrgency: + description: Priority urgency of tailed request + type: int + setPref: + branch: default + pref: "network.http.tailing.urgency" + httpTailingDelayQuantum: + description: When the page load has not yet reached DOMContentLoaded point, tail requestes are delayed by (non-tailed requests count + 1) * delay-quantum milliseconds. + type: int + setPref: + branch: default + pref: "network.http.tailing.delay-quantum" + httpTailingDelayQuantumAfterDCL: + description: After the page load reached DOMContentLoaded point, tail requestes are delayed by (non-tailed requests count + 1) * delay-quantum-after-domcontentloaded milliseconds. + type: int + setPref: + branch: default + pref: "network.http.tailing.delay-quantum-after-domcontentloaded" + httpTailingMaxDelay: + description: Upper limit for the calculated delay, prevents long standing and comet-like requests + type: int + setPref: + branch: default + pref: "network.http.tailing.delay-max" + httpTailingTotalMaxDelay: + description: Total limit we delay tailed requests since page load start + type: int + setPref: + branch: default + pref: "network.http.tailing.total-max" + +networkingAuth: + description: "Firefox Networking (Necko) Authentication" + owner: vgosu@mozilla.com + hasExposure: false + variables: + redirectForAuthRetriesEnabled: + description: Whether to enable redirects for auth retries + type: boolean + setPref: + branch: default + pref: "network.auth.use_redirect_for_retries" + +networkingDenyIpAddrAny: + description: "Firefox Networking (Necko) Deny IP Address Any" + owner: vgosu@mozilla.com + hasExposure: false + variables: + denyIpAddrAny: + description: Whether to deny empty (0.0.0.0) IP addresses + type: boolean + setPref: + branch: default + pref: network.socket.ip_addr_any.disabled + +compressionDictionaries: + description: HTTP Compression Dictionaries + owner: rjesup@mozilla.com + hasExposure: false + variables: + enableDictionaries: + description: Enables/disables HTTP Compression Dictionaries + type: boolean + setPref: + branch: default + pref: network.http.dictionaries.enable + +pingsender: + description: "In-product usage of the pingsender telemetry reporter." + owner: nalexander@mozilla.com + hasExposure: false + variables: + backgroundTaskEnabled: + type: "boolean" + fallbackPref: "toolkit.telemetry.shutdownPingSender.backgroundtask.enabled" + description: "Whether to use the `pingsender` background task to send shutdown telemetry" + +dapTelemetry: + description: DAP Telemetry + owner: simon@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Whether to automatically send DAP measurements. + task1Enabled: + type: boolean + description: Whether to send fake measurements for task 1. + task1TaskId: + type: string + description: The task ID to use for task 1 measurements. + visitCountingEnabled: + type: boolean + description: Whether to count visits to the provided list of URLs. + visitCountingExperimentList: + type: json + description: A list of experiments with URLs for which we want to count visits. + +dapIncrementality: + description: "Incrementality experiment configuration" + owner: gleonard@mozilla.com + hasExposure: false + variables: + measurementType: + type: string + description: Indicates the type of measurement to enable. Valid values are `visitMeasurement`, `referrerMeasurement`. + advertiser: + type: string + description: The advertiser being measured. + taskId: + type: string + description: The DAP taskId specified for report submission. + length: + type: int + description: The number of buckets needed for the report histogram. + timePrecision: + type: int + description: The time precision (seconds) for submitted report. Must match the time-precision value for the task with the specified taskId. + visitCountUrls: + type: json + description: Used for measurementType `visitMeasurement`. JSON indicating the url (string), bucket (int), and metric_name(string). + referrerUrls: + type: json + description: Used for measurementType `referrerMeasurement`. JSON indicating the url (string), bucket (int), and metric_name(string) The url pattern should be broad. + targetUrls: + type: string + description: Used for measurementType `referrerMeasurement`. Comma separated list of URLs to measure. + unknownReferrerBucket: + type: int + description: Used for measurementType `referrerMeasurement`. Histogram bucket indicating unknown referrer, may be null. + unknownReferrerMetricName: + type: string + description: Used for measurementType `referrerMeasurement`. Metric name indicating count of unknown referrer occurrences, may be null. + +dapAggregators: + description: Aggregator server configuration to use for submitting DAP reports. + owner: tcampbell@mozilla.com + hasExposure: false + variables: + leader_url: + description: The URL of the DAP Leader server where reports are submitted. + type: string + setPref: + branch: default + pref: "toolkit.telemetry.dap.leader.url" + leader_hpke: + description: The base64-encode HPKE key to encrypt leader shares with. + type: string + setPref: + branch: default + pref: "toolkit.telemetry.dap.leader.hpke" + helper_url: + description: The URL of the DAP Helper server. + type: string + setPref: + branch: default + pref: "toolkit.telemetry.dap.helper.url" + helper_hpke: + description: The base64-encode HPKE key to encrypt helper shares with. + type: string + setPref: + branch: default + pref: "toolkit.telemetry.dap.helper.hpke" + +etpLevel2PBMPref: + description: The pref that controls the ETP level 2 list in the private browsing mode + owner: tihuang@mozilla.com + hasExposure: false + variables: + enabled: + description: Whether to enable ETP level 2 list in the private browsing mode. + type: boolean + setPref: + branch: default + pref: "privacy.annotate_channels.strict_list.pbmode.enabled" + +etpStrictFeatures: + description: Prefs to control the strict ETP features + owner: tihuang@mozilla.com + hasExposure: false + variables: + features: + description: The list of strict ETP features to enable in ETP strict mode. + type: string + setPref: + branch: default + pref: "browser.contentblocking.features.strict" + +thirdPartyCookieBlocking: + description: Prefs to control third-party cookie blocking + owner: tihuang@mozilla.com + hasExposure: false + variables: + enabled: + description: Whether to enable third-party cookie blocking + type: boolean + setPref: + branch: default + pref: "network.cookie.cookieBehavior.optInPartitioning" + enabledPBM: + description: Whether to enable third-party cookie blocking in private browsing mode + type: boolean + setPref: + branch: default + pref: "network.cookie.cookieBehavior.optInPartitioning.pbmode" + +googleSafeBrowsingV5: + description: Control Google Safe Browsing V5 protocol + owner: tihuang@mozilla.com + hasExposure: false + variables: + enabled: + description: Whether to enable Google Safe Browsing V5 protocol. + type: boolean + setPref: + branch: default + pref: "browser.safebrowsing.provider.google5.enabled" + +safeBrowsingRealTime: + description: Control Safe Browsing real-time lookup and simulation + owner: tihuang@mozilla.com + hasExposure: false + variables: + enabled: + description: Whether to enable Safe Browsing real-time lookup. + type: boolean + setPref: + branch: default + pref: "browser.safebrowsing.realTime.enabled" + globalCacheEnabled: + description: Whether to enable the Global Cache for real-time lookup. + type: boolean + setPref: + branch: default + pref: "browser.safebrowsing.globalCache.enabled" + simulationEnabled: + description: Whether to enable the real-time request simulator. + type: boolean + setPref: + branch: default + pref: "browser.safebrowsing.realTime.simulation.enabled" + simulationCacheTTLSec: + description: Cache TTL in seconds for the real-time request simulator. + type: int + setPref: + branch: default + pref: "browser.safebrowsing.realTime.simulation.cacheTTLSec" + simulationHitProbability: + description: > + Hit probability for the real-time request simulator, expressed as + parts per million. 1000000 = 100%, 1 = 0.0001%, 0 = never hit. + type: int + setPref: + branch: default + pref: "browser.safebrowsing.realTime.simulation.hitProbability" + simulationNegativeCacheEnabled: + description: > + Whether to enable the negative cache for the real-time request + simulator. When enabled, prefixes with no hits are cached to skip + subsequent requests. + type: boolean + setPref: + branch: default + pref: "browser.safebrowsing.realTime.simulation.negativeCacheEnabled" + simulationNegativeCacheTTLSec: + description: > + TTL in seconds for negative cache entries in the real-time request + simulator. + type: int + setPref: + branch: default + pref: "browser.safebrowsing.realTime.simulation.negativeCacheTTLSec" + +fxaButtonVisibility: + description: Prefs to control the visibility of the Firefox Accounts toolbar button when not signed in. + owner: mconley@mozilla.com + hasExposure: false + variables: + boolean: + description: True if the Firefox Accounts toolbar button should be visible when not signed in. + type: boolean + setPref: + branch: user + pref: identity.fxaccounts.toolbar.defaultVisible + pxiToolbarEnabled: + description: >- + True if we're enabling the PXI dropdown menu for the FxA toolbar button instead of + taking the user straight to login + type: boolean + setPref: + branch: user + pref: identity.fxaccounts.toolbar.pxiToolbarEnabled + monitorEnabled: + description: >- + Toggle the Monitor CTA + type: boolean + setPref: + branch: user + pref: identity.fxaccounts.toolbar.pxiToolbarEnabled.monitorEnabled + relayEnabled: + description: >- + Toggle the Relay CTA + type: boolean + setPref: + branch: user + pref: identity.fxaccounts.toolbar.pxiToolbarEnabled.relayEnabled + vpnEnabled: + description: >- + Toggle the VPN CTA + type: boolean + setPref: + branch: user + pref: identity.fxaccounts.toolbar.pxiToolbarEnabled.vpnEnabled + avatarIconVariant: + description: >- + Controls the icon that appears in the toolbar button when in the + signed-out state. + + One of the following values: + - control + - human-circle + - fox-circle + type: string + +fxaClientAssociation: + description: Prefs to control the client association ping. + owner: mconley@mozilla.com + hasExposure: false + variables: + pingEnabled: + description: >- + True if the client association ping should be sent. + type: boolean + setPref: + branch: user + pref: identity.fxaccounts.telemetry.clientAssociationPing.enabled + +fxaAppMenuItem: + description: >- + Prefs to control the appearance and copy of the FxA sign-in button in the + AppMenu when signed out. + owner: mconley@mozilla.com + hasExposure: true + exposureDescription: >- + Exposure is recorded when the user is enrolled in an experiment using this + feature and the AppMenu on Firefox Desktop is opened. + variables: + ctaCopyVariant: + description: >- + One of the following values: + - control + - sync-devices + - backup-data + - backup-sync + - mobile + type: string + +fxaAvatarMenuItem: + description: >- + Prefs to control the appearance and copy of the FxA sign-in button in the + FxA avatar menu when signed out. + owner: mconley@mozilla.com + hasExposure: true + exposureDescription: >- + Exposure is recorded when the user is enrolled in an experiment using this + feature and the FxA avatar menu on Firefox Desktop is opened. + variables: + ctaCopyVariant: + description: >- + One of the following values: + - control + - sync-devices + - backup-data + - backup-sync + - mobile + type: string + +legacyHeartbeat: + description: Normandy Heartbeat exposed to Nimbus + owner: beth@mozilla.com + hasExposure: false + schema: + uri: "resource://normandy/schemas/LegacyHeartbeat.schema.json" + path: "toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json" + variables: + survey: + type: json + description: The Heartbeat survey parameters. + +queryStripping: + description: Query parameter stripping anti-tracking feature. + owner: emz@mozilla.com + hasExposure: false + variables: + enabledNormalBrowsing: + type: boolean + setPref: + branch: default + pref: privacy.query_stripping.enabled + description: Enables / disables URL query string stripping in normal browsing mode. + enabledPrivateBrowsing: + type: boolean + setPref: + branch: default + pref: privacy.query_stripping.enabled.pbmode + description: Enables / disables URL query string stripping in private browsing mode. + allowList: + type: string + setPref: + branch: default + pref: privacy.query_stripping.allow_list + description: >- + List of sites exempt from query stripping. This list will be merged with + records coming from RemoteSettings. + stripList: + type: string + setPref: + branch: default + pref: privacy.query_stripping.strip_list + description: >- + List of query params to be stripped from URIs. This list will be merged + with records coming from RemoteSettings. + +fingerprintingProtection: + description: Control Fingerprinting Protection + owner: tihuang@mozilla.com + hasExposure: false + variables: + enabledNormal: + type: boolean + setPref: + branch: default + pref: privacy.fingerprintingProtection + description: Enables / disables fingerprinting protection in normal browsing mode. + enabledPrivate: + type: boolean + setPref: + branch: default + pref: privacy.fingerprintingProtection.pbmode + description: Enables / disables fingerprinting protection in private browsing mode. + overrides: + type: string + setPref: + branch: default + pref: privacy.fingerprintingProtection.overrides + description: >- + The protection overrides to add or remove fingerprinting protection + targets. Please check RFPTargets.inc for all supported targets. + fdlibm_math: + type: boolean + setPref: + branch: default + pref: javascript.options.use_fdlibm_for_sin_cos_tan + description: >- + Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy + canvas_random_use_siphash: + type: boolean + setPref: + branch: default + pref: privacy.resistFingerprinting.randomization.canvas.use_siphash + description: >- + Uses the SipHash function for canvas randomization. + enabledBaseline: + type: boolean + setPref: + branch: default + pref: privacy.baselineFingerprintingProtection + description: Enables / disables baseline fingerprinting protection. + overridesBaseline: + type: string + setPref: + branch: default + pref: privacy.baselineFingerprintingProtection.overrides + description: >- + The protection overrides to add or remove fingerprinting protection + targets. Please check RFPTargets.inc for all supported targets. + +userCharacteristics: + description: Control user characteristic data collection + owner: tihuang@mozilla.com + hasExposure: false + variables: + currentVersion: + type: int + setPref: + branch: user + pref: toolkit.telemetry.user_characteristics_ping.current_version + description: The current collection version of the user characteristics. + +mediaCapabilities: + description: Media Capabilities API features. + owner: media-alerts@mozilla.com, apehrson@mozilla.com, azebrowski@mozilla.com + hasExposure: false + variables: + webrtcEnabled: + description: >- + Whether or not to enable the WebRTC parts of the MediaCapabilities API. + type: boolean + setPref: + branch: default + pref: media.mediacapabilities.webrtc.enabled + webrtcAllowlist: + description: >- + Whether or not to enable the WebRTC parts of the MediaCapabilities API + only on specific domains. + type: string + setPref: + branch: default + pref: media.mediacapabilities.webrtc.enabled.allowlist + legacyEnabled: + description: >- + Enables legacy mode, which bypasses colorGamut, transferFunction, + and scalabilityMode validation, in the MediaCapabilities API, + for improved web compatibility. + type: boolean + setPref: + branch: default + pref: media.mediacapabilities.legacy.enabled + legacyAllowlist: + description: >- + Enables legacy mode, which bypasses colorGamut, transferFunction, + and scalabilityMode validation, in the MediaCapabilities API, + for improved web compatibility only on specific domains. + type: string + setPref: + branch: default + pref: media.mediacapabilities.legacy.allowlist + +migrationWizard: + description: Prefs to control the Migration Wizard UI. + owner: mconley@mozilla.com + hasExposure: false + variables: + showImportAll: + description: True if the "Variant 2" of the Migration Wizard browser / profile selection UI should be used. This is only meaningful in the new Migration Wizard. + type: boolean + setPref: + branch: user + pref: browser.migrate.content-modal.import-all.enabled + showPreferencesEntrypoint: + description: True if an entrypoint to the migration wizard should be visible in about:preferences. + type: boolean + setPref: + branch: user + pref: browser.migrate.preferences-entrypoint.enabled + aboutWelcomeBehavior: + description: >- + When migration is kicked off from about:welcome, there are + a few different behaviors that we want to test, controlled + by a preference that is instrumented for Nimbus. The pref + has the following possible states: + + "autoclose": + The user will be directed to the migration wizard in + about:preferences, but once the wizard is dismissed, + the tab will close. + + "embedded": + The migration wizard is embedded in about:welcome. + + "standalone": + The migration wizard will open in a new top-level content + window. + + "default" / other + The user will be directed to the migration wizard in + about:preferences. The tab will not close once the + user closes the wizard. + type: string + setPref: + branch: user + pref: browser.migrate.content-modal.about-welcome-behavior + migrateExtensions: + description: True if importing extensions is enabled. + type: boolean + setPref: + branch: user + pref: browser.migrate.chrome.extensions.enabled + chromeCanRequestPermissions: + description: >- + True if Chrome-based browsers can request read permissions on + platforms where the browser is restricted from reading the contents + of a Chrome-based browser's user data directory. In practice, this + is only relevant to the Linux platform when the browser is installed + as a Snap package. + type: boolean + setPref: + branch: user + pref: browser.migrate.chrome.get_permissions.enabled + +mixedContentUpgrading: + description: Prefs to control whether we upgrade mixed passive content (images, audio, video) from http to https + owner: fbraun@mozilla.com + hasExposure: false + variables: + enabled: + description: True if the mixed content upgrading pref is enabled + type: boolean + setPref: + branch: default + pref: security.mixed_content.upgrade_display_content + +gc: + description: Prefs that control gc heuristics. + owner: dpalmeiro@mozilla.com + hasExposure: false + variables: + max_nursery_size: + description: Set the maximum size of the GC nursery, in kb. + type: int + setPref: + branch: user + pref: "javascript.options.mem.nursery.max_kb" + min_nursery_size: + description: Set the minimum size of the GC nursery, in kb. + type: int + setPref: + branch: user + pref: "javascript.options.mem.nursery.min_kb" + gc_allocation_threshold_mb: + description: Lower limit for collecting a zone, in MB. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_allocation_threshold_mb" + gc_balanced_heap_limits: + description: Whether balanced heap limits are enabled. + type: boolean + setPref: + branch: user + pref: "javascript.options.mem.gc_balanced_heap_limits" + gc_compacting: + description: Whether compacting GC is enabled. + type: boolean + setPref: + branch: user + pref: "javascript.options.mem.gc_compacting" + gc_generational: + description: Whether generational GC is enabled. + type: boolean + setPref: + branch: user + pref: "javascript.options.mem.gc_generational" + gc_heap_growth_factor: + description: Heap growth parameter for balanced heap limit calculation. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_heap_growth_factor" + gc_helper_thread_ratio: + description: Number of threads to use for parallel GC work. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_helper_thread_ratio" + gc_high_frequency_large_heap_growth: + description: Heap growth factor for large heaps in the high-frequency GC state. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_high_frequency_large_heap_growth" + gc_high_frequency_small_heap_growth: + description: Heap growth factor for small heaps in the high-frequency GC state. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_high_frequency_small_heap_growth" + gc_high_frequency_time_limit_ms: + description: GCs less than this far apart in milliseconds will be + considered high-frequency GCs. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_high_frequency_time_limit_ms" + gc_incremental: + description: Whether incremental GC is enabled. If not, GC will always run to completion. + type: boolean + setPref: + branch: user + pref: "javascript.options.mem.gc_incremental" + incremental_weakmap: + description: Enable incremental weakmap marking. + type: boolean + setPref: + branch: user + pref: "javascript.options.mem.incremental_weakmap" + gc_incremental_slice_ms: + description: Max milliseconds to spend in an incremental GC slice. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_incremental_slice_ms" + gc_large_heap_incremental_limit: + description: Limit of how far over the incremental trigger threshold we allow the + heap to grow before finishing a collection non-incrementally, for large heaps. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_large_heap_incremental_limit" + gc_large_heap_size_min_mb: + description: Lower limit for classifying a heap as large, in MB. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_large_heap_size_min_mb" + gc_low_frequency_heap_growth: + description: Heap growth factor for low frequency GCs. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_low_frequency_heap_growth" + gc_malloc_threshold_base_mb: + description: Set the malloc threshold base value in MB. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_malloc_threshold_base_mb" + gc_max_empty_chunk_count: + description: Do not keep more than this many unused chunks in the free chunk pool. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_max_empty_chunk_count" + gc_max_helper_threads: + description: The maximum number of background threads to use for parallel GC work. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_max_helper_threads" + gc_min_empty_chunk_count: + description: We try to keep at least this many unused chunks in the free chunk + pool at all times, even after a shrinking GC. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_min_empty_chunk_count" + gc_parallel_marking: + description: Enable parallel marking. + type: boolean + setPref: + branch: user + pref: "javascript.options.mem.gc_parallel_marking" + gc_parallel_marking_threshold_mb: + description: The heap size above which to use parallel marking. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_parallel_marking_threshold_mb" + gc_max_parallel_marking_threads: + description: The maximum number of threads to use for parallel marking, if enabled. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_max_parallel_marking_threads" + gc_per_zone: + description: Whether per-zone GC is enabled. If not, all zones are collected every time. + type: boolean + setPref: + branch: user + pref: "javascript.options.mem.gc_per_zone" + gc_small_heap_incremental_limit: + description: Limit of how far over the incremental trigger threshold we allow the heap + to grow before finishing a collection non-incrementally, for small heaps. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_small_heap_incremental_limit" + gc_small_heap_size_max_mb: + description: Upper limit for classifying a heap as small, in MB. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_small_heap_size_max_mb" + gc_urgent_threshold_mb: + description: Set the urgent threshold, in MB. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_urgent_threshold_mb" + nursery_eager_collection_threshold_kb: + description: Set the eager collection threshold, in kb, for the nursery. + type: int + setPref: + branch: user + pref: "javascript.options.mem.nursery_eager_collection_threshold_kb" + nursery_eager_collection_threshold_percent: + description: Set the eager collection percent threshold for the nursery. + type: int + setPref: + branch: user + pref: "javascript.options.mem.nursery_eager_collection_threshold_percent" + nursery_eager_collection_timeout_ms: + description: Set the eager collection timeout, in ms, for the nursery. + type: int + setPref: + branch: user + pref: "javascript.options.mem.nursery_eager_collection_timeout_ms" + nursery_max_time_goal_ms: + description: Set the nursery's maximum time goal, in ms. + type: int + setPref: + branch: user + pref: "javascript.options.mem.nursery_max_time_goal_ms" + +jsParallelParsing: + description: Pref to toggle JS parallel parsing. + owner: dpalmeiro@mozilla.com, nbp@mozilla.com + hasExposure: false + variables: + enabled: + description: True to enable parallel parsing. + type: boolean + setPref: + branch: user + pref: "javascript.options.parallel_parsing" + +jitThresholds: + description: Prefs that control jit tier thresholds. + owner: dpalmeiro@mozilla.com, jdemooij@mozilla.com + hasExposure: false + variables: + blinterp_threshold: + description: Set the threshold to enable blinterp compilation. + type: int + setPref: + branch: user + pref: "javascript.options.blinterp.threshold" + baseline_threshold: + description: Set the threshold to enable baseline compilation. + type: int + setPref: + branch: user + pref: "javascript.options.baselinejit.threshold" + ion_threshold: + description: Set the threshold to enable ion compilation. + type: int + setPref: + branch: user + pref: "javascript.options.ion.threshold" + ion_bailout_threshold: + description: Set the ion frequent bailout threshold. + type: int + setPref: + branch: user + pref: "javascript.options.ion.frequent_bailout_threshold" + ion_offthread_compilation: + description: True to enable offthread ion compilations. + type: boolean + setPref: + branch: user + pref: "javascript.options.ion.offthread_compilation" + inlining_max_length: + description: Set the max bytecode length considered for inlining. + type: int + setPref: + branch: user + pref: "javascript.options.inlining_bytecode_max_length" + +jitHintsCache: + description: Pref to toggle the JIT hints cache. + owner: dpalmeiro@mozilla.com + hasExposure: false + variables: + enabled: + description: True to enable the hints cache. + type: boolean + setPref: + branch: user + pref: "javascript.options.jithints" + +scriptloader: + description: Prefs that control scriptloader heuristics. + owner: dpalmeiro@mozilla.com + hasExposure: false + variables: + bytecode_cache_strategy: + description: Set the bytecode cache strategy. + type: int + setPref: + branch: user + pref: "dom.script_loader.bytecode_cache.strategy" + delazification_strategy: + description: Controls when functions are parsed. 0=on-demand (lazy), 255=eager parse all. + type: int + setPref: + branch: user + pref: "dom.script_loader.delazification.strategy" + delazification_max_size: + description: Maximum number of bytes supported for speculate OMT full parsing. + type: int + setPref: + branch: user + pref: "dom.script_loader.delazification.max_size" + delazification_min_mem: + description: Minimum memory required, in GB, to enable OMT full parsing. + type: int + setPref: + branch: user + pref: "dom.script_loader.delazification.min_mem" + speculate_async_enabled: + description: Enable speculative OMT parsing for async scripts. + type: boolean + setPref: + branch: user + pref: "dom.script_loader.external_scripts.speculate_async.enabled" + speculate_link_preload_enabled: + description: Enable speculative OMT parsing for link=preload scripts. + type: boolean + setPref: + branch: user + pref: "dom.script_loader.external_scripts.speculate_link_preload.enabled" + speculate_non_parser_inserted_enabled: + description: Enable speculative OMT parsing for non parser inserted scripts. + type: boolean + setPref: + branch: user + pref: "dom.script_loader.external_scripts.speculate_non_parser_inserted.enabled" + speculate_enabled: + description: Enable speculative OMT parsing. + type: boolean + setPref: + branch: user + pref: "dom.script_loader.external_scripts.speculative_omt_parse.enabled" + navigation_cache_enabled: + description: Enable the navigation cache. + type: boolean + setPref: + branch: user + pref: "dom.script_loader.experimental.navigation_cache" + +opaqueResponseBlocking: + description: Prefs to enable Opaque Response Blocking + owner: farre@mozilla.com + hasExposure: true + exposureDescription: Exposure is sent when a response is blocked + isEarlyStartup: true + variables: + enabled: + description: Whether ORB is enabled + type: boolean + setPref: + branch: user + pref: "browser.opaqueResponseBlocking" + javascriptValidator: + description: Whether JavaScript validation for ORB is enabled + type: boolean + setPref: + branch: user + pref: "browser.opaqueResponseBlocking.javascriptValidator" + filterFetchResponse: + description: Whether filtering of internal responses in the parent ORB is enabled + type: int + setPref: + branch: user + pref: "browser.opaqueResponseBlocking.filterFetchResponse" + mediaExceptionsStrategy: + description: >- + If we partially or wholly allow audio and video MIME types in conflict with spec. + type: int + setPref: + branch: user + pref: "browser.opaqueResponseBlocking.mediaExceptionsStrategy" + +updatePrompt: + description: Prefs to control content and behavior of update notifications + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + Exposure is sent at most once per browsing session when an update + notification prompt is displayed. + variables: + showReleaseNotesLink: + type: boolean + description: >- + If true, the "Learn More" link will be shown in the update prompt. If + false or omitted, the link will only be shown for supported locales. + releaseNotesURL: + type: string + fallbackPref: app.releaseNotesURL.prompt + description: >- + Template for the URL opened when the user clicks the "Learn More" link + in the update prompt. If an empty string, the link will not be shown. + +powerSaver: + description: Prefs to control power saving behaviors + owner: florian@mozilla.com + hasExposure: false + variables: + reduceFrameRates: + type: int + setPref: + branch: user + pref: "gfx.display.max-frame-rate" + description: >- + Limit the number of frames displayed per second. + If omitted, the refresh rate of the screen will be used. + mediaAutoPlay: + type: int + setPref: + branch: user + pref: "media.autoplay.default" + description: >- + Control if media is allowed to auto-play, with and without sound. + backgroundTimerMinTime: + type: int + setPref: + branch: user + pref: "dom.min_background_timeout_value" + description: >- + Limit how frequently timers are allowed to run in background tabs. + backgroundTimerRegenerationRate: + type: int + setPref: + branch: user + pref: "dom.timeout.background_budget_regeneration_rate" + description: >- + Limit how quickly the background tab timer budget regenerates. + +backgroundUpdate: + description: Prefs to control aspects of the background update process. + owner: install-update@mozilla.com + hasExposure: true + exposureDescription: >- + The exposure event is sent when scheduling the background task and both the + feature is enabled and the service registry key (Mozilla Maintenance + Service) is *not* available for this installation. That is the first time + the feature can impact Firefox behaviour and the user experience. + variables: + enableUpdatesForUnelevatedInstallations: + description: >- + Allow the background update process to download and apply updates when + the Mozilla Maintenance Service is unavailable but the installation + directory can be written. + type: boolean + setPref: + branch: user + pref: app.update.background.allowUpdatesForUnelevatedInstallations + +bookmarks: + description: Prefs to control aspects of the bookmarks system. + owner: omc-core@mozilla.com + hasExposure: false + variables: + enableBookmarksToolbar: + type: string + setPref: + branch: user + pref: browser.toolbars.bookmarks.visibility + description: If the bookmarks toolbar should never, always, or only show on newtab. + showOtherBookmarks: + type: boolean + setPref: + branch: user + pref: browser.toolbars.bookmarks.showOtherBookmarks + description: Display state of the "Other Bookmarks" toolbar button. + +backgroundThreads: + description: Prefs to control MacOS thread priorities for power savings. + owner: kwright@mozilla.com + hasExposure: false + variables: + use_low_power: + description: >- + Use the MacOS QoS libraries to deprioritize select threads. + type: boolean + setPref: + branch: user + pref: threads.use_low_power.enabled + lower_mainthread_priority_in_background: + description: >- + When a browsing context is put in the background and isn't actively playing + media, deprioritize its main thread. + type: boolean + setPref: + branch: user + pref: threads.lower_mainthread_priority_in_background.enabled + +phc: + description: Prefs to control the Probabalistic Heap Checker (PHC) + owner: pbone@mozilla.com + hasExposure: false + variables: + phcEnabled: + description: Whether to enable PHC + type: boolean + setPref: + branch: user + pref: memory.phc.enabled + phcMinRamMB: + description: The minimum amount of RAM required to enable PHC + type: int + setPref: + branch: user + pref: memory.phc.min_ram_mb + phcAvgDelayFirst: + description: The delay before the first PHC allocation in the parent process + type: int + setPref: + branch: user + pref: memory.phc.avg_delay.first + phcAvgDelayNormal: + description: The delay between PHC allocations in the parent process + type: int + setPref: + branch: user + pref: memory.phc.avg_delay.normal + phcAvgDelayPageReuse: + description: The delay before reusing a PHC page in the parent process + type: int + setPref: + branch: user + pref: memory.phc.avg_delay.page_reuse + phcAvgDelayContentFirst: + description: The delay before the first PHC allocation in the content process + type: int + setPref: + branch: user + pref: memory.phc.avg_delay.content.first + phcAvgDelayContentNormal: + description: The delay between PHC allocations in the content process + type: int + setPref: + branch: user + pref: memory.phc.avg_delay.content.normal + phcAvgDelayContentPageReuse: + description: The delay before reusing a PHC page in the content process + type: int + setPref: + branch: user + pref: memory.phc.avg_delay.content.page_reuse + phcMaxSize: + description: The maximum amount of memory used for the PHC + type: int + setPref: + branch: user + pref: memory.phc.size_kb + +mailto: + description: Prefs to control aspects of the mailto handler + owner: install-update@mozilla.com + hasExposure: true + exposureDescription: >- + The exposure event is sent when a webmail site calls the + registerProtocolHandler function and when users use mailto links in Firefox. + variables: + dualPrompt: + type: boolean + description: >- + Can be used to toggle the entire feature on and off. + fallbackPref: browser.mailto.dualPrompt + dualPrompt.onLocationChange: + type: boolean + description: >- + Display a reminder prompt for known webmailers if the prompt was not + dismissed before the next visit of that webmailer. + fallbackPref: browser.mailto.dualPrompt.onLocationChange + dualPrompt.dismissXClickMinutes: + type: int + description: >- + This pref controls after how many minutes the mailto prompt can be shown + again, which has been dismissed by clicking the 'X' button before. + fallbackPref: browser.mailto.dualPrompt.dismissXClickMinutes + dualPrompt.dismissNotNowMinutes: + type: int + description: >- + This pref controls after how many minutes the mailto prompt can be shown + again, which has been dismissed by clicking a 'not now' button on it. + fallbackPref: browser.mailto.dualPrompt.dismissNotNowMinutes + dialog: + type: boolean + description: >- + Toggle a mailto handler picker dialog shown when a mailto link is + clicked. When false, the picker is skipped and the link falls back to + the default protocol handling. + +nimbusIsReady: + description: A feature that provides the number of Nimbus is_ready events to send + when Nimbus is ready. + owner: chumphreys@mozilla.com + hasExposure: false + applications: + - firefox-desktop + variables: + eventCount: + description: The number of events that should be sent. + type: int + +nimbusTelemetry: + description: A feature that enables or disables Nimbus telemetry. + owner: project-nimbus@mozilla.com + hasExposure: false + applications: + - firefox-desktop + - firefox-desktop-background-task + variables: + gleanMetricConfiguration: + description: > + A Glean metric configuration JSON blob. + + This is limited to configuring the following categories: + - nimbus_events + - nimbus_targeting_context + - nimbus_targeting_environment + type: json + + nimbusTargetingEnvironment: + description: > + Configuration for the nimbus_targeting_environment telemetry category. + type: json + + schema: + uri: resource://nimbus/schemas/NimbusTelemetryFeature.schema.json + path: toolkit/components/nimbus/schemas/NimbusTelemetryFeature.schema.json + +httpsFirst: + description: >- + Prefs for HTTPS-First, which upgrades all top-level page loads to HTTPS and + provides a automatic fallback to HTTP if the site isn't available via HTTPS. + owner: mjurgens@mozilla.com, seceng-telemetry@mozilla.com + hasExposure: false + variables: + enabled: + description: Enable HTTPS-First + type: boolean + setPref: + branch: default + pref: dom.security.https_first + enabledPbm: + description: Enable HTTPS-First in private browsing only + type: boolean + setPref: + branch: default + pref: dom.security.https_first_pbm + enabledSchemeless: + description: >- + Enables schemeless HTTPS-First, which will only apply HTTPS-First to address + bar inputs without a scheme. This essentially makes HTTPS the default + scheme in the address bar, while providing a fallback to HTTP. + type: boolean + setPref: + branch: default + pref: dom.security.https_first_schemeless + backgroundTimerMs: + description: >- + After a request gets upgraded to HTTPS, specifies the time after which a + second HTTP request is fired to check if the site is available via + HTTPS, but timing out via HTTPS. This also applies to HTTPS-Only, not + just HTTPS-First. + type: int + setPref: + branch: default + pref: dom.security.https_only_fire_http_request_background_timer_ms + +contentRelevancy: + description: >- + A feature for interest-based content relevance ranking and personalization + for Firefox. + owner: disco-team@mozilla.com + hasExposure: false + variables: + enabled: + description: Enable this feature + type: boolean + fallbackPref: toolkit.contentRelevancy.enabled + maxInputUrls: + description: The maximum number of input URLs for interest classification + type: int + minInputUrls: + description: The minimal number of input URLs for interest classification + type: int + timerInterval: + description: >- + The interval (in seconds) of the background update timer for the content + relevancy manager + type: int + setPref: + branch: user + pref: toolkit.contentRelevancy.timerInterval + ingestEnabled: + description: Enable the ingestion through the Rust component + type: boolean + fallbackPref: toolkit.contentRelevancy.ingestEnabled + +backupService: + description: Prefs to control the profile backup service + owner: mconley@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: browser.backup.enabled + description: >- + When true, the profile backup service will be initialized soon after + startup. + sqlitePagesPerStep: + description: >- + The number of database pages to backup per step when backing up an + SQLite database. + type: int + setPref: + branch: user + pref: browser.backup.sqlite.pages_per_step + sqliteStepDelayMs: + description: >- + The delay between SQLite database backup steps in milliseconds. + type: int + setPref: + branch: user + pref: browser.backup.sqlite.step_delay_ms + idleThresholdSeconds: + description: >- + The number of seconds of user idle time to wait for before considering + to schedule a backup. + type: int + setPref: + branch: user + pref: browser.backup.scheduled.idle-threshold-seconds + minTimeBetweenBackupsSeconds: + description: >- + The minimum number of seconds since the last known backup that must + pass before we might schedule a backup. + type: int + setPref: + branch: user + pref: browser.backup.scheduled.minimum-time-between-backups-seconds + archiveKillswitch: + type: boolean + description: >- + Disables backup archiving, overrides all other configs when true. + restoreKillswitch: + type: boolean + description: >- + Disables backup restoration, overrides all other configs when true. + +pqcrypto: + description: Prefs that control the use of post-quantum cryptography. + owner: jschanck@mozilla.com + hasExposure: false + variables: + tlsEnableMlkem: + type: boolean + setPref: + branch: default + pref: security.tls.enable_kyber + description: >- + Whether to enable mlkem768x25519 for TLS. + h3EnableMlkem: + type: boolean + setPref: + branch: default + pref: network.http.http3.enable_kyber + description: >- + Whether to enable mlkem768x25519 for H3/QUIC. + sendP256: + type: boolean + setPref: + branch: default + pref: security.tls.client_hello.send_p256_keyshare + description: >- + Whether to send a P256 share in the client hello in QUIC and TLS. + dtlsWebRTCEnableMlkem: + type: boolean + setPref: + branch: default + pref: media.webrtc.enable_pq_hybrid_kex + description: >- + Whether to enable mlkem768x25519 for DTLS in WebRTC. + + +dtlsWebRTC: + description: Pref that controls the use of DTLS. + owner: nkulatova@mozilla.com + hasExposure: false + variables: + tlsVersionDTLS: + type: int + setPref: + branch: default + pref: media.peerconnection.dtls.version.max + description: >- + The maximum version of DTLS protocol used in WebRTC (770 = DTLS 1.0, 771 = DTLS 1.2, 772 = DTLS 1.3). + +certCompression: + description: Prefs that control the use of certificate compression decoders. + owner: anna.weine@mozilla.com + hasExposure: false + variables: + tlsEnableZlib: + type: boolean + setPref: + branch: default + pref: security.tls.enable_certificate_compression_zlib + description: >- + Whether to enable Zlib for TLS certificate compression. + h3EnableZlib: + type: boolean + setPref: + branch: default + pref: network.http.http3.enable_certificate_compression_zlib + description: >- + Whether to enable Zlib for H3/QUIC certificate compression. + tlsEnableBrotli: + type: boolean + setPref: + branch: default + pref: security.tls.enable_certificate_compression_brotli + description: >- + Whether to enable Brotli for TLS certificate compression. + h3EnableBrotli: + type: boolean + setPref: + branch: default + pref: network.http.http3.enable_certificate_compression_brotli + description: >- + Whether to enable Brotli for H3/QUIC certificate compression. + tlsEnableZstd: + type: boolean + setPref: + branch: default + pref: security.tls.enable_certificate_compression_zstd + description: >- + Whether to enable Zstd for TLS certificate compression. + h3EnableZstd: + type: boolean + setPref: + branch: default + pref: network.http.http3.enable_certificate_compression_zstd + description: >- + Whether to enable Zstd for H3/QUIC certificate compression. + +bounceTrackingProtection: + description: Controls the Bounce Tracking Protection feature. + owner: emz@mozilla.com + isEarlyStartup: true + hasExposure: true + exposureDescription: >- + Exposure is recored after every purge run which purged at least one tracker. + Exposure is only recorded when the feature is fully enabled and not in + dry-run mode. + variables: + mode: + type: int + setPref: + branch: default + pref: privacy.bounceTrackingProtection.mode + description: >- + Mode to run the feature in. See nsIBounceTrackingProtection.idl for + documentation. + requireStatefulBounces: + type: boolean + setPref: + branch: default + pref: privacy.bounceTrackingProtection.requireStatefulBounces + description: >- + If true, only bounce redirects where the middle hop/s access cookies or + storage will be considered to be bounce trackers. If false, all + redirects that fit the bounce tracker heuristic will be considered. + +remoteTabManagement: + description: > + Features that let users manage tabs on other devices that are + connected to the same Mozilla account. + owner: skhamis@mozilla.com + hasExposure: false + variables: + closeTabsEnabled: + description: >- + When true, the user can close tabs on other devices connected to + the same Mozilla account from the synced tabs menu. + type: boolean + fallbackPref: identity.fxaccounts.commands.remoteTabManagement.enabled + +crlite: + description: Prefs that control the use of CRLite + owner: jschanck@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: security.remote_settings.crlite_filters.enabled + description: >- + Whether CRLite artifacts will be downloaded. + channel: + type: string + setPref: + branch: default + pref: security.pki.crlite_channel + description: >- + The channel from which CRLite artifacts will be downloaded. + mode: + type: int + setPref: + branch: default + pref: security.pki.crlite_mode + description: >- + How CRLite results will be interpreted. + timestamps_for_coverage: + type: int + setPref: + branch: default + pref: security.pki.crlite_timestamps_for_coverage + description: >- + How many covered timestamps do we need to see before we enforce a CRLite result. + +chatbot: + description: AI chatbot feature configuration + owner: elee@mozilla.com + hasExposure: false + variables: + badgeSidebar: + type: boolean + description: Show badge on chatbot sidebar tool on enrollment + minVersion: + type: string + description: Minimum Firefox version to apply prefs + prefs: + type: json + description: >- + The prefs to set under browser.ml.chat.* with object keys as the + sub-pref and values objects indicating the desired branch and value + defaulting to clearing the user branch value. + +linkPreviews: + description: Enabling the link previews feature + owner: elee@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.ml.linkPreview.enabled + description: If true, will show previews when over link and keyboard shortcut is pressed + prefs: + type: json + description: >- + The prefs to set under browser.ml.linkPreview.* with object keys as the + sub-pref and values objects indicating the desired branch and value + defaulting to clearing the user branch value. + +sidebar: + description: Sidebar feature configuration + owner: elee@mozilla.com + hasExposure: false + variables: + minVersion: + type: string + description: Minimum Firefox version to apply prefs + revamp: + type: boolean + description: sidebar.revamp pref value to set on user branch; true for new experience + verticalTabs: + type: boolean + description: sidebar.verticalTabs pref value to set on user branch; true to enable vertical tabs + visibility: + type: string + description: 'sidebar.visibility pref value to set on user branch. Vertical tabs: "always-show", "expand-on-hover", "hide-sidebar". Horizontal tabs: "hide-on-close", "hide-launcher".' + +fxms_bmb_button: + description: A feature for the Firefox Messaging System Bookmarks Bar button surface + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + Exposure is sent if the message is about to be shown after trigger and + targeting conditions on the message matched. + schema: + uri: chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json + path: browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json + variables: {} + +certificateTransparency: + description: Certificate Transparency configuration + owner: dkeeler@mozilla.com + hasExposure: false + variables: + mode: + type: int + setPref: + branch: default + pref: security.pki.certificate_transparency.mode + description: >- + What mode Certificate Transparency is in (0=disable, 1=telemetry only, + 2=enforce). + +setToDefaultPrompt: + description: "Experimental set to default spotlight" + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched." + variables: + showSpotlightPrompt: + description: Show experimental set to default spotlight message instead of default prompt + type: boolean + message: + description: Message to show instead of the default prompt + type: json + +tabNotes: + description: >- + Associate short text notes with specific web pages and surface those notes later + when the user returns to that web page in a tab. + owner: sthompson@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: >- + Controls whether tab notes storage, code, and UI elements are turned on. + setPref: + branch: default + pref: browser.tabs.notes.enabled + +tabGroups: + description: Prefs to control Tab Groups + owner: dao@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.tabs.groups.enabled + description: Controls whether users can create new tab groups via drag and drop or the tab context menu + +smartTabGroups: + description: Prefs to control Smart Tab Groups + owner: rrando@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.tabs.groups.smart.enabled + description: Controls whether users can use ml features for suggesting tab group names or similar tabs + suggestOtherTabsMethod: + type: string + setPref: + branch: user + pref: browser.tabs.groups.smart.suggestOtherTabsMethod + description: Controls clustering method used to suggest similar tabs feature + topicModelRevision: + type: string + setPref: + branch: user + pref: browser.tabs.groups.smart.topicModelRevision + description: Controls topic model version used by the feature + embeddingModelRevision: + type: string + setPref: + branch: user + pref: browser.tabs.groups.smart.embeddingModelRevision + description: Controls embedding model version used by the feature + nearestNeighborThresholdInt: + type: int + setPref: + branch: user + pref: browser.tabs.groups.smart.nearestNeighborThresholdInt + description: Controls the threshold, less than or equal to 1000, for the nearest neighbor cluster method + searchTopicEnabled: + type: boolean + setPref: + branch: user + pref: browser.tabs.groups.smart.searchTopicEnabled + description: For single tab groupings, use the search query as the topic rather than use ML + +tabContextMenu: + description: Prefs to control the behavior and structure of the tab context menu + owner: sfoster@mozilla.com + hasExposure: false + variables: + altStructureEnabled: + type: boolean + setPref: + branch: default + pref: browser.tabs.contextmenu.altstructure.enabled + description: >- + Controls whether the updated (alternate) tab context menu layout is + shown instead of the classic layout. + +externalLinkHandling: + description: Controls how externally-opened URLs will be handled by Firefox. + owner: sthompson@mozilla.com + hasExposure: true + exposureDescription: >- + Exposure is recorded when a user clicks on a link outside of Firefox and + that link is opened by Firefox. + variables: + openBehavior: + description: >- + Control how external links from another application should be opened in Firefox. + See the nsIBrowserDOMWindow `OPEN_*` constants for what the values can do. + The default value for the backing pref is `-1`. When that pref has the default + value, the code will fall back to the value of the general pref that handles + opening links, i.e. `browser.link.open_newwindow`, which defaults to `3`. + type: int + enum: + - -1 # use default browser behavior + - 2 # `OPEN_NEWWINDOW` open external links in a new window + - 3 # `OPEN_NEWTAB` open in a new tab in the topmost window at the end of the tab strip + - 6 # `OPEN_NEWTAB_FOREGROUND` open in a new tab in the topmost window at the end of the tab strip and select it + - 7 # `OPEN_NEWTAB_AFTER_CURRENT` open in a new tab in the topmost window next to the active tab + fallbackPref: browser.link.open_newwindow.override.external + +smartblockEmbeds: + description: Pref to control Smartblock Embeds + owner: emz@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: extensions.webcompat.smartblockEmbeds.enabled + description: >- + Controls whether smartblock embed placeholders and protections panel toggles will be shown to the user. + +storageAccessHeuristics: + description: Heuristics that grant cookie access automatically for foreign resources + owner: bvandersloot@mozilla.com + hasExposure: false + variables: + popup_past_interaction: + type: boolean + setPref: + branch: default + pref: privacy.restrict3rdpartystorage.heuristic.window_open + description: >- + Do we grant cookie access to a third party when it is opened in a popup if it has + been interacted with in the recent past? + popup_interaction: + type: boolean + setPref: + branch: default + pref: privacy.restrict3rdpartystorage.heuristic.opened_window_after_interaction + description: >- + Do we grant cookie access to a third party when it is opened in a popup if it has + the opener relationship and the user interacts with the popup? + navigation: + type: boolean + setPref: + branch: default + pref: privacy.restrict3rdpartystorage.heuristic.navigation + description: >- + Do we grant cookie access to a third party when it is interacted with earlier in this + tab's history, and the current first party is even further back in the history? + redirect: + type: boolean + setPref: + branch: default + pref: privacy.restrict3rdpartystorage.heuristic.recently_visited + description: >- + Do we grant cookie access to a third party when it has been interacted with in the recent + past, has been visited in the past few minutes, and redirects itself to another top level + site? + redirect_tracker: + type: boolean + setPref: + branch: default + pref: privacy.restrict3rdpartystorage.heuristic.redirect + description: >- + Do we grant cookie access to a tracker third party when it has been interacted with in the + recent past and redirects itself to another top level site? + +partitioned-cookie-attribute: + description: Control the enablment and migration of cookies to the Partitioned attribute, rather than TCP + owner: bvandersloot@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: network.cookie.CHIPS.enabled + description: >- + Do we respect the Partitioned attribute? + chipsMigrationTarget: + description: What CHIPS migration count target the browser should reach. + type: int + setPref: + branch: default + pref: network.cookie.CHIPS.migrateDatabaseTarget + chipsPartitionLimitEnabled: + description: Whether we enforce CHIPS partition limit + type: boolean + setPref: + branch: default + pref: "network.cookie.chips.partitionLimitEnabled" + chipsPartitionLimitDryRun: + description: Whether we actually perform purging/rejection, used to report telemetry without webcompat issues + type: boolean + setPref: + branch: default + pref: "network.cookie.chips.partitionLimitDryRun" + chipsPartitionLimitByteCapacity: + description: The actual value of the CHIPS partition limit in bytes + type: boolean + setPref: + branch: default + pref: "network.cookie.chips.partitionLimitByteCapacity" + chipsAffectsTCP: + description: Whether CHIPS cookies also appear as TCP cookies when both jars are queried + type: boolean + setPref: + branch: default + pref: "network.cookie.CHIPS.affectsTCP" + +trackingProtectionExperimentation: + description: Experimental controls for tracking protection behavior + owner: bvandersloot@mozilla.com + hasExposure: false + variables: + deferAnnotationEnabled: + description: Whether to defer tracking protection classification annotation + type: boolean + setPref: + branch: default + pref: "privacy.trackingprotection.defer_annotation.enabled" + +contentClassifier: + description: Controls the content classifier service used by tracking protection. + owner: bvandersloot@mozilla.com + hasExposure: false + variables: + protectionEnabled: + description: Whether the content classifier service blocks requests. + type: boolean + setPref: + branch: default + pref: "privacy.trackingprotection.content.protection.enabled" + protectionEngines: + description: >- + Comma-separated content classifier feature names whose engines are + used for blocking in non-private browsing contexts. Defined feature + names are in ContentClassifierService.cpp, kFeatures. + type: string + setPref: + branch: default + pref: "privacy.trackingprotection.content.protection.engines" + protectionEnginesPbmode: + description: >- + Comma-separated content classifier feature names whose engines are + used for blocking in private browsing contexts. Defined feature + names are in ContentClassifierService.cpp, kFeatures. + type: string + setPref: + branch: default + pref: "privacy.trackingprotection.content.protection.engines.pbmode" + annotationEnabled: + description: Whether the content classifier service annotates requests. + type: boolean + setPref: + branch: default + pref: "privacy.trackingprotection.content.annotation.enabled" + annotationEngines: + description: >- + Comma-separated content classifier feature names whose engines are + used for annotation in non-private browsing contexts. Defined + feature names are in ContentClassifierService.cpp, kFeatures. + type: string + setPref: + branch: default + pref: "privacy.trackingprotection.content.annotation.engines" + annotationEnginesPbmode: + description: >- + Comma-separated content classifier feature names whose engines are + used for annotation in private browsing contexts. Defined feature + names are in ContentClassifierService.cpp, kFeatures. + type: string + setPref: + branch: default + pref: "privacy.trackingprotection.content.annotation.engines.pbmode" + mirrorEnabled: + description: >- + Whether the tracking-protection prefs are mirrored onto the content + classifier engine prefs. While enabled the mirror derives (and + owns) the content classifier prefs from the ETP settings. + type: boolean + setPref: + branch: default + pref: "privacy.trackingprotection.content.mirror.enabled" + skipURLClassifier: + description: >- + Whether to skip the URLClassifier while the ContentClassifier engine is + active. + type: boolean + setPref: + branch: default + pref: "privacy.trackingprotection.urlclassifier.disable_for_channel_classifier" + +auto-pip: + description: "Automatic Picture-in-Picture" + owner: mconley@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Whether or not to auto-open PiP when switching tabs. + setPref: + branch: user + pref: "media.videocontrols.picture-in-picture.enable-when-switching-tabs.enabled" + +urlbar-ime-search: + description: "Urlbar IME" + owner: search-and-suggest-program@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Whether or not to keep the urlbar panel open during IME composition. + setPref: + branch: user + pref: "browser.urlbar.keepPanelOpenDuringImeComposition" + +web-rtc-global-mute-toggles: + description: "WebRTC Global Mute Toggles" + owner: mconley@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Whether or not to enable global mute toggles to the WebRTC indicator. + setPref: + branch: user + pref: "privacy.webrtc.globalMuteToggles" + +jpeg-xl: + description: "JPEG-XL" + owner: krosylight@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Whether or not to enable JPEG-XL support. + setPref: + branch: user + pref: "image.jxl.enabled" + +css-masonry: + description: "CSS Masonry Layout" + owner: dholbert@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Whether or not to enable CSS masonry layout. + setPref: + branch: user + pref: "layout.css.grid-template-masonry-value.enabled" + +windowsUIAutomation: + description: Support for the Windows UI Automation API + owner: jteh@mozilla.com + hasExposure: false + variables: + enabled: + type: int + description: 0 to disable UIA, 2 to enable UIA. + enum: + - 0 + - 2 + setPref: + branch: user + pref: "accessibility.uia.enable" + +expandSignInButton: + description: "Add text next to the FxA avatar toolbar icon" + owner: skhamis@mozilla.com + hasExposure: false + variables: + ctaCopyVariant: + description: >- + One of the following values: + - fxa-avatar-sign-in + - fxa-avatar-sign-up + empty will be assumed default experience + type: string + +contextID: + description: >- + Controls the behaviour of the context ID, which is a unique identifier used + by Contextual Services. + owner: mconley@mozilla.com + hasExposure: false + variables: + rotationPeriodInDays: + type: int + setPref: + branch: user + pref: "browser.contextual-services.contextId.rotation-in-days" + description: >- + The number of days since the creation of the context ID after which the + context ID should be regenerated. Set to 0 to disable rotation. This + value only takes effect if rustBackendEnabled is also true, otherwise + no rotation will occur regardless of the value. + + This setting will only be applied after the next restart. + rustBackendEnabled: + type: boolean + setPref: + branch: user + pref: "browser.contextual-services.contextId.rust-component.enabled" + description: >- + Enables the Rust component backend for ContextId.sys.mjs, which is + a prerequisite for doing rotations. + +deletePrivate: + description: Enable or disable the option for users to delete files at the end of a private browsing session + owner: rking@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: browser.download.enableDeletePrivate + description: Whether the setting for deleting files downloaded in private browsing is available to the user + +ipProtection: + description: Prefs to control IP Protection feature + owner: fchasen@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.ipProtection.enabled + description: >- + Enables the IP Protection feature. + bandwidthMax: + type: int + setPref: + branch: default + pref: browser.ipProtection.bandwidth.maxInGb + description: >- + Maximum bandwidth allowance in GB for messaging. + upgradeNotAvailable: + type: boolean + setPref: + branch: default + pref: browser.ipProtection.upgradeNotAvailable + description: >- + Hides Mozilla VPN promotions for users in regions where it is unavailable + +webApps: + description: Enables or disables web apps. + owner: nrishel@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.taskbarTabs.enabled + description: >- + Controls whether web apps can be installed and accessed. + +defaultWindowsLaunchOnLogin: + description: >- + Controls whether or not new Windows users get defaulted to launch on login + owner: drubino@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: browser.startup.windowsLaunchOnLogin.defaultEnabled + description: >- + If true, and allowed by Windows policy, a new user will be defaulted + to have Firefox launched when they log on. + +passwordManager: + description: Password manager related prefs + owner: maltejur@mozilla.com + hasExposure: false + variables: + reencryptionNeeded: + isEarlyStartup: true + type: boolean + setPref: + branch: default + pref: signon.reencryptionNeeded + description: >- + Triggers a reencryption of all passwords on the next startup for + migration purposes. + +xpcom: + description: Prefs that control the cross-platform component object model + owner: tthorne@mozilla.com + hasExposure: false + variables: + idle_period_cross_process_scheduling: + description: Whether Firefox allows background processes to use idle time to schedule and run tasks. + type: boolean + setPref: + branch: user + pref: "idle_period.cross_process_scheduling" + low_commit_space_threshold_mb: + description: if defined(XP_WIN) || defined(XP_LINUX) - notify TabUnloader or send the memory pressure if the memory resource notification is signaled AND the available commit space is lower than this value. + type: int + setPref: + branch: user + pref: "browser.low_commit_space_threshold_mb" + low_commit_space_threshold_percent: + description: ifdef XP_LINUX - on Linux we also check available memory in comparison to total memory, and use this percent value (out of 100) to determine if we are in a low memory scenario. + type: int + setPref: + branch: user + pref: "browser.low_commit_space_threshold_percent" + +layout: + description: Prefs that control the DOM or core layout. + owner: tthorne@mozilla.com + hasExposure: false + variables: + lower_priority_refresh_driver_during_load: + description: Reduces refresh rate between fcp and load. The value is TRUE is there to improve page load. + type: boolean + setPref: + branch: user + pref: "layout.lower_priority_refresh_driver_during_load" + sessionstore_max_tabs_undo: + description: How many tabs can be reopened per window. + type: int + setPref: + branch: user + pref: "browser.sessionstore.max_tabs_undo" + sessionstore_max_windows_undo: + description: How many windows will be saved and can be reopened per session - on non-macOS platforms this pref may be ignored when dealing with pop-up windows to ensure the user actually gets at least one window with a menu bar. + type: int + setPref: + branch: user + pref: "browser.sessionstore.max_windows_undo" + sessionstore_interval: + description: Minimum interval between two save operations in milliseconds (while the user is active). + type: int + setPref: + branch: user + pref: "browser.sessionstore.interval" + sessionhistory_max_total_viewers: + description: Number of content viewers to cache based. If negative, determined by amount of available memory. + type: int + setPref: + branch: user + pref: "browser.sessionhistory.max_total_viewers" + smooth_scroll: + description: Whether to enable smooth scrolling. + type: boolean + setPref: + branch: user + pref: "general.smoothScroll" + frame_rate: + description: Pref to control browser frame rate, in Hz. + type: int + setPref: + branch: user + pref: "layout.frame_rate" + frame_rate_throttled: + description: Throttled frame rate, in frames per second. + type: int + setPref: + branch: user + pref: "layout.throttled_frame_rate" + min_background_timeout_value_without_budget_throttling: + description: Minimum interval for background tabs when budget throttling is disabled, in milliseconds. + type: int + setPref: + branch: user + pref: "dom.min_background_timeout_value_without_budget_throttling" + timeout_throttling_delay: + description: Delay before throttling activates after tab goes background, in milliseconds. + type: int + setPref: + branch: user + pref: "dom.timeout.throttling_delay" + initialpaint_delay: + description: Reduces the time Firefox waits before starting to render a page. + type: int + setPref: + branch: user + pref: "nglayout.initialpaint.delay" + initialpaint_delay_oopif: + description: Reduces the time Firefox waits before starting to render a page in out-of-process iframes. + type: int + setPref: + branch: user + pref: "nglayout.initialpaint.delay_in_oopif" + page_load_deprioritization_period: + description: Time in milliseconds during which certain tasks are deprioritized during page load. + type: int + setPref: + branch: user + pref: "page_load.deprioritization_period" + +ipc: + description: Prefs that control the inter-process communication system. + owner: tthorne@mozilla.com + hasExposure: false + variables: + backend_mach: + description: if defined(XP_DARWIN) - Whether or not to use the mach-based IPC backend on macOS/iOS. Only read once at startup by IOThreadParent's constructor. + type: boolean + setPref: + branch: user + pref: "dom.ipc.backend.mach" + process_count: + description: The max number of content processes used for non-isolated origins. + type: int + setPref: + branch: user + pref: "dom.ipc.processCount" + process_count_web_isolated: + description: Maximum number of isolated content processes per-origin. + type: int + setPref: + branch: user + pref: "dom.ipc.processCount.webIsolated" + preallocated_process_count: + description: Process preallocation cache. Only used in fission; in e10s we use 1 always. + type: int + setPref: + branch: user + pref: "dom.ipc.processPrelaunch.fission.number" + preallocated_lowmem_mb: + description: Limit preallocated processes below this memory size (in MB). + type: int + setPref: + branch: user + pref: "dom.ipc.processPrelaunch.lowmem_mb" + priority_manager_enabled: + description: Determines whether Firefox uses the Process Priority Manager to adjust CPU priority based on importance. + type: boolean + setPref: + branch: user + pref: "dom.ipc.processPriorityManager.enabled" + priority_manager_background_grace_period_ms: + description: The waiting period before Firefox begins lowering the priority of a content process after it goes into background. + type: int + setPref: + branch: user + pref: "dom.ipc.processPriorityManager.backgroundGracePeriodMS" + priority_manager_background_perceivable_grace_period_ms: + description: The waiting period before Firefox begins lowering the priority of a content process that is still considered "perceivable". + type: int + setPref: + branch: user + pref: "dom.ipc.processPriorityManager.backgroundPerceivableGracePeriodMS" + priority_manager_background_uses_ecoqos: + description: Windows only. Determines whether Firefox should use EcoQoS mode for power efficiency. + type: boolean + setPref: + branch: user + pref: "dom.ipc.processPriorityManager.backgroundUsesEcoQoS" + +graphics: + description: Prefs that control media and/or graphics processing. + owner: tthorne@mozilla.com + hasExposure: false + variables: + gfx_webrender_all: + description: Whether to use the WebRender hardware backend. + type: boolean + setPref: + branch: user + pref: "gfx.webrender.all" + layers_acceleration_force_enabled: + description: Whether to force acceleration on, ignoring blacklists. + type: boolean + setPref: + branch: user + pref: "layers.acceleration.force-enabled" +image: + description: Prefs that control image processing. + owner: tthorne@mozilla.com + hasExposure: false + variables: + image_cache_size: + description: The maximum size, in bytes, of the decoded images we cache. + type: int + setPref: + branch: user + pref: "image.cache.size" + image_mem_decode_bytes_at_a_time: + description: Chunk size for calls to the image decoders. + type: int + setPref: + branch: user + pref: "image.mem.decode_bytes_at_a_time" + +walletCustomSchemes: + description: Defines which custom schemes are treated as digital identity requests + owner: bvandersloot@mozilla.com + hasExposure: false + variables: + enabledSchemes: + type: string + setPref: + branch: user + pref: privacy.wallet_schemes + description: >- + Comma separated lists of schemes + +macAppMenuSetAsDefault: + description: >- + Controls whether or not a Set as Default Browser menu item is added to macOS app menu + owner: rfambro@mozilla.com + hasExposure: false + variables: + shown: + type: boolean + setPref: + branch: user + pref: browser.macAppMenu.setAsDefaultShown + description: >- + Whether or not the macOS app menu contains "Set as Default Browser" item + +smartWindow: + description: >- + Controls whether Smart Window can become the default browser window on + startup. Existing Smart Window eligibility checks still apply. + owner: echa@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Enables the Smart Window feature when true. Turning off this variable will not disable the feature. + isDefault: + type: boolean + setPref: + branch: user + pref: browser.smartwindow.isDefaultWindow + description: >- + If true, Firefox opens as a Smart Window by default on startup for + eligible users. Set to false (or unenroll) to disable the rollout. + hiddenOnboardingScreenIds: + type: string + fallbackPref: browser.smartwindow.firstrun.hiddenOnboardingScreenIds + description: >- + Comma-separated list of screen ids that should be hidden in the Smart + Window first run onboarding. + +smartWindowAgentWatch: + description: >- + Controls the Smart Window agent watch feature - whether users can create a + watch task (a task that monitors a page for changes). This gates the capability + itself, including its "/watch" command palette entry. Existing Smart Window + eligibility checks still apply. + owner: yjamora@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: browser.smartwindow.agent.enabled + description: >- + Enables the Smart Window Agent Watch feature when true. Set to false + to disable the rollout. + supportedRegions: + type: string + setPref: + branch: default + pref: browser.smartwindow.agent.supportedRegions + description: >- + Comma-separated list of region codes where the agent watch command is + available, for example "US,CA". + +contentSharing: + description: Controls the content sharing feature, which allows users to share browser content. + owner: nbarrett@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: browser.contentsharing.enabled + description: Whether the content sharing feature is enabled. + serverUrl: + type: string + setPref: + branch: default + pref: browser.contentsharing.server.url + description: The URL of the content sharing server. + +urlbarShareButton: + description: Controls the share button in the url bar. + owner: nbaumgardner@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: browser.urlbar.share-button.enabled + description: Whether the share button in the url bar is visible. + +referrals: + description: Controls the Firefox referral program. + owner: nbarrett@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: browser.referrals.enabled + description: Whether the referral program is enabled. + +webNotificationsPermissionUi: + description: >- + Overrides the copy and optional logo of the native Web Notifications + permission prompt. Not a separate messaging surface. + owner: omc-core@mozilla.com + hasExposure: true + exposureDescription: >- + Recorded when an enrolled user is shown the permission prompt and the + activationTargeting expression (if set) evaluated truthy, regardless of + whether any content variable is set. This fires for the empty-content + control branch as well so it is comparable to the treatment branches. + variables: + headline: + type: string + description: >- + Overrides the prompt headline. Must contain "<>" for site-name + substitution; a headline without it falls back to the default copy. + Also falls back to the default copy when unset. + body: + type: string + description: >- + Optional secondary text shown below the headline as the popup's + hint text. + primaryCtaLabel: + type: string + description: Overrides the Allow button label. + primaryCtaAccessKey: + type: string + description: Optional access key paired with primaryCtaLabel. + secondaryCtaLabel: + type: string + description: >- + Overrides the (Always) Block button label in normal windows only; left + at the default in private browsing, where the wording reflects the + session-scoped BLOCK semantics. The underlying BLOCK action and scope + are unchanged. + secondaryCtaAccessKey: + type: string + description: Optional access key paired with secondaryCtaLabel. + logoUrl: + type: string + description: >- + Optional logo URL used as the prompt's icon. Must be a chrome:// or + resource:// URL; any other scheme is rejected and the default icon is + shown. + useSiteFavicon: + type: boolean + description: >- + When true, use the requesting site's own favicon as the prompt icon + (no logoUrl needed). Prefers the site's cached favicon and falls back to + the tab's currently loaded icon (so it still shows on a first-time + private-browsing visit), or the default favicon if neither is available. + Ignored when a valid logoUrl is set. + activationTargeting: + type: string + description: >- + JEXL expression evaluated at prompt-shown time with the per-call + webNotificationSiteCategory targeting attribute available. When + unset or empty the treatment applies to every prompt the enrolled + user sees; when set and falsy the prompt falls back to the default + copy and no exposure event is recorded. + headlineL10nId: + type: string + description: >- + Fluent message id (in browser/permissions.ftl) for the headline, + resolved in-tree. Takes precedence over headline; the message must + contain "<>" (e.g. via the $host variable) for site-name substitution, + else the prompt falls back to the default copy. + bodyL10nId: + type: string + description: >- + Fluent message id for the body/hint text, resolved in-tree. Takes + precedence over body. + primaryCtaLabelL10nId: + type: string + description: >- + Fluent message id for the Allow button, resolved in-tree. Takes + precedence over primaryCtaLabel; its .accesskey attribute, if present, + sets the access key. + secondaryCtaLabelL10nId: + type: string + description: >- + Fluent message id for the (Always) Block button, resolved in-tree. + Takes precedence over secondaryCtaLabel; its .accesskey attribute, if + present, sets the access key. Not applied in private browsing. diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/schemas/browser/components/asrouter/content-src/schemas/BackgroundTaskMessagingExperiment.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/schemas/browser/components/asrouter/content-src/schemas/BackgroundTaskMessagingExperiment.schema.json new file mode 100644 index 0000000000..8b2f910f4a --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/schemas/browser/components/asrouter/content-src/schemas/BackgroundTaskMessagingExperiment.schema.json @@ -0,0 +1,370 @@ +{ + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "chrome://browser/content/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json", + "title": "Messaging Experiment", + "description": "A Firefox Messaging System message.", + "if": { + "type": "object", + "properties": { + "template": { + "const": "multi" + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "chrome://browser/content/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json#/$defs/MultiMessage" + }, + "else": { + "$ref": "chrome://browser/content/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json#/$defs/TemplatedMessage" + }, + "$defs": { + "ToastNotification": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///ToastNotification.schema.json", + "title": "ToastNotification", + "description": "A template for toast notifications displayed by the Alert service.", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "title": { + "$ref": "chrome://browser/content/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json#/$defs/localizableText", + "description": "Id of localized string or message override of toast notification title" + }, + "body": { + "$ref": "chrome://browser/content/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json#/$defs/localizableText", + "description": "Id of localized string or message override of toast notification body" + }, + "icon_url": { + "description": "The URL of the image used as an icon of the toast notification.", + "type": "string", + "format": "moz-url-format" + }, + "image_url": { + "description": "The URL of an image to be displayed as part of the notification.", + "type": "string", + "format": "moz-url-format" + }, + "dark_mode_image_url": { + "description": "The URL of an image to be displayed as part of the notification in dark mode.", + "type": "string", + "format": "moz-url-format" + }, + "reduced_motion_image_url": { + "description": "The URL of an image to be displayed as part of the notification when the user prefers reduced motion.", + "type": "string", + "format": "moz-url-format" + }, + "dark_mode_reduced_motion_image_url": { + "description": "The URL of an image to be displayed as part of the notification in dark mode with reduced motion.", + "type": "string", + "format": "moz-url-format" + }, + "launch_url": { + "description": "The URL to launch when the notification or an action button is clicked.", + "type": "string", + "format": "moz-url-format" + }, + "launch_action": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The launch action to be performed when Firefox is launched." + }, + "data": { + "type": "object" + } + }, + "required": [ + "type" + ], + "additionalProperties": true + }, + "requireInteraction": { + "type": "boolean", + "description": "Whether the toast notification should remain active until the user clicks or dismisses it, rather than closing automatically." + }, + "tag": { + "type": "string", + "description": "An identifying tag for the toast notification." + }, + "data": { + "type": "object", + "description": "Arbitrary data associated with the toast notification." + }, + "actions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "title": { + "$ref": "chrome://browser/content/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json#/$defs/localizableText", + "description": "The action text to be shown to the user." + }, + "action": { + "type": "string", + "description": "Opaque identifer that identifies action." + }, + "iconURL": { + "type": "string", + "format": "uri", + "description": "URL of an icon to display with the action." + }, + "windowsSystemActivationType": { + "type": "boolean", + "description": "Whether to have Windows process the given `action`." + }, + "launch_action": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The launch action to be performed when Firefox is launched." + }, + "data": { + "type": "object" + } + }, + "required": [ + "type" + ], + "additionalProperties": true + } + }, + "required": [ + "action", + "title" + ], + "additionalProperties": true + } + } + }, + "additionalProperties": true, + "required": [ + "title", + "body" + ] + }, + "template": { + "type": "string", + "const": "toast_notification" + } + }, + "required": [ + "content", + "targeting", + "template", + "trigger" + ], + "additionalProperties": true + }, + "Message": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The message identifier" + }, + "groups": { + "description": "Array of preferences used to control `enabled` status of the group. If any is `false` the group is disabled.", + "type": "array", + "items": { + "type": "string", + "description": "Preference name" + } + }, + "template": { + "type": "string", + "description": "Which messaging template this message is using.", + "enum": [ + "toast_notification" + ] + }, + "frequency": { + "type": "object", + "description": "An object containing frequency cap information for a message.", + "properties": { + "lifetime": { + "type": "integer", + "description": "The maximum lifetime impressions for a message.", + "minimum": 1, + "maximum": 100 + }, + "custom": { + "type": "array", + "description": "An array of custom frequency cap definitions.", + "items": { + "description": "A frequency cap definition containing time and max impression information", + "type": "object", + "properties": { + "period": { + "type": "integer", + "description": "Period of time in milliseconds (e.g. 86400000 for one day)" + }, + "cap": { + "type": "integer", + "description": "The maximum impressions for the message within the defined period.", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "period", + "cap" + ] + } + } + } + }, + "priority": { + "description": "The priority of the message. If there are two competing messages to show, the one with the highest priority will be shown", + "type": "integer" + }, + "order": { + "description": "The order in which messages should be shown. Messages will be shown in increasing order.", + "type": "integer" + }, + "targeting": { + "description": "A JEXL expression representing targeting information", + "type": "string" + }, + "trigger": { + "$ref": "chrome://browser/content/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json#/$defs/Trigger" + }, + "triggers": { + "description": "An array of trigger actions (alternative to the singular `trigger`). The message is eligible if any one of them matches. When 'trigger' is also present, `triggers` takes precedence. Targeting is evaluated using the context of whichever trigger fired, so context a trigger contributes (for example `tabsClosedCount` from `nthTabClosed`) is only available when that specific trigger fires. Ensure the targeting expression is valid for every trigger listed.", + "type": "array", + "minItems": 1, + "items": { + "$ref": "chrome://browser/content/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json#/$defs/Trigger" + } + }, + "provider": { + "description": "An identifier for the provider of this message, such as \"cfr\" or \"preview\".", + "type": "string" + } + }, + "additionalProperties": true, + "dependentRequired": { + "content": [ + "id", + "template" + ], + "template": [ + "id", + "content" + ] + } + }, + "localizedText": { + "type": "object", + "properties": { + "string_id": { + "description": "Id of localized string to be rendered.", + "type": "string" + } + }, + "required": [ + "string_id" + ] + }, + "localizableText": { + "description": "Either a raw string or an object containing the string_id of the localized text", + "oneOf": [ + { + "type": "string", + "description": "The string to be rendered." + }, + { + "$ref": "chrome://browser/content/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json#/$defs/localizedText" + } + ] + }, + "Trigger": { + "description": "An action to trigger potentially showing the message", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "A string identifying the trigger action" + }, + "params": { + "type": "array", + "description": "An optional array of string parameters for the trigger action", + "items": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + }, + "required": [ + "id" + ] + }, + "TemplatedMessage": { + "description": "An FxMS message of one of a variety of types.", + "type": "object", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json#/$defs/Message" + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "toast_notification" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "chrome://browser/content/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json#/$defs/ToastNotification" + } + } + ] + }, + "MultiMessage": { + "description": "An object containing an array of messages.", + "type": "object", + "properties": { + "template": { + "type": "string", + "const": "multi" + }, + "messages": { + "type": "array", + "description": "An array of messages.", + "items": { + "$ref": "chrome://browser/content/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json#/$defs/TemplatedMessage" + } + } + }, + "required": [ + "template", + "messages" + ] + } + } +} diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/schemas/browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/schemas/browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json new file mode 100644 index 0000000000..f2ba7e4dc0 --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/schemas/browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json @@ -0,0 +1,2320 @@ +{ + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json", + "title": "Messaging Experiment", + "description": "A Firefox Messaging System message.", + "if": { + "type": "object", + "properties": { + "template": { + "const": "multi" + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/MultiMessage" + }, + "else": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/TemplatedMessage" + }, + "$defs": { + "ActionOnlyMessage": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///ActionOnlyMessage.schema.json", + "title": "ActionOnlyMessage", + "description": "A template for messages that silently execute an allowlisted special message action with no UI. Records an impression before attempting action.", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "action": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the special message action to execute." + }, + "data": { + "type": "object", + "description": "Optional data for the action." + } + }, + "required": [ + "type" + ], + "additionalProperties": true, + "description": "The special message action to execute. Only allowlisted action types may be used." + } + }, + "additionalProperties": true, + "required": [ + "action" + ] + }, + "template": { + "type": "string", + "const": "action_only" + } + }, + "required": [ + "targeting" + ] + }, + "BookmarksBarButton": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///BookmarksBarButton.schema.json", + "title": "BookmarksBarButton", + "description": "A template with a label and a special message action (currently only supports OPEN_URL)", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "template": { + "type": "string", + "const": "bookmarks_bar_button" + }, + "content": { + "type": "object", + "properties": { + "action": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Action dispatched by the button." + }, + "data": { + "type": "object" + } + }, + "required": [ + "type" + ], + "additionalProperties": true + } + }, + "additionalProperties": true + } + }, + "additionalProperties": true, + "required": [ + "targeting" + ] + }, + "CFRUrlbarChiclet": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///CFRUrlbarChiclet.schema.json", + "title": "CFRUrlbarChiclet", + "description": "A template with a chiclet button with text.", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Attribute used for different groups of messages from the same provider" + }, + "layout": { + "type": "string", + "description": "Describes how content should be displayed.", + "enum": [ + "chiclet_open_url" + ] + }, + "bucket_id": { + "type": "string", + "description": "A bucket identifier for the addon. This is used in order to anonymize telemetry for history-sensitive targeting." + }, + "notification_text": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "The text in the small blue chicklet that appears in the URL bar. This can be a reference to a localized string in Firefox or just a plain string." + }, + "active_color": { + "type": "string", + "description": "Background color of the button" + }, + "action": { + "type": "object", + "properties": { + "url": { + "description": "The page to open when the button is clicked.", + "type": "string", + "format": "moz-url-format" + }, + "where": { + "description": "Should it open in a new tab or the current tab", + "type": "string", + "enum": [ + "current", + "tabshifted" + ] + } + }, + "additionalProperties": true, + "required": [ + "url", + "where" + ] + } + }, + "additionalProperties": true, + "required": [ + "layout", + "category", + "bucket_id", + "notification_text", + "action" + ] + }, + "template": { + "type": "string", + "const": "cfr_urlbar_chiclet" + } + }, + "required": [ + "targeting", + "trigger" + ] + }, + "ExtensionDoorhanger": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///ExtensionDoorhanger.schema.json", + "title": "ExtensionDoorhanger", + "description": "A template with a heading, addon icon, title and description. No markup allowed.", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Attribute used for different groups of messages from the same provider" + }, + "layout": { + "type": "string", + "description": "Attribute used for different groups of messages from the same provider", + "enum": [ + "short_message", + "icon_and_message", + "addon_recommendation" + ] + }, + "anchor_id": { + "type": "string", + "description": "A DOM element ID that the pop-over will be anchored." + }, + "alt_anchor_id": { + "type": "string", + "description": "An alternate DOM element ID that the pop-over will be anchored." + }, + "bucket_id": { + "type": "string", + "description": "A bucket identifier for the addon. This is used in order to anonymize telemetry for history-sensitive targeting." + }, + "skip_address_bar_notifier": { + "type": "boolean", + "description": "Skip the 'Recommend' notifier and show directly." + }, + "persistent_doorhanger": { + "type": "boolean", + "description": "Prevent the doorhanger from being dismissed if user interacts with the page or switches between applications." + }, + "show_in_private_browsing": { + "type": "boolean", + "description": "Whether to allow the message to be shown in private browsing mode. Defaults to false." + }, + "notification_text": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "The text in the small blue chicklet that appears in the URL bar. This can be a reference to a localized string in Firefox or just a plain string." + }, + "info_icon": { + "type": "object", + "description": "The small icon displayed in the top right corner of the pop-over. Should be 19x19px, svg or png. Defaults to a small question mark.", + "properties": { + "label": { + "oneOf": [ + { + "type": "object", + "properties": { + "attributes": { + "type": "object", + "properties": { + "tooltiptext": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "Text for button tooltip used to provide information about the doorhanger." + } + }, + "required": [ + "tooltiptext" + ] + } + }, + "required": [ + "attributes" + ] + }, + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizedText" + } + ] + }, + "sumo_path": { + "type": "string", + "description": "Last part of the path in the URL to the support page with the information about the doorhanger.", + "examples": [ + "extensionpromotions", + "extensionrecommendations" + ] + } + } + }, + "learn_more": { + "type": "string", + "description": "Last part of the path in the SUMO URL to the support page with the information about the doorhanger.", + "examples": [ + "extensionpromotions", + "extensionrecommendations" + ] + }, + "heading_text": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "The larger heading text displayed in the pop-over. This can be a reference to a localized string in Firefox or just a plain string." + }, + "icon": { + "$ref": "file:///ExtensionDoorhanger.schema.json#/$defs/linkUrl", + "description": "The icon displayed in the pop-over. Should be 32x32px or 64x64px and png/svg." + }, + "icon_dark_theme": { + "type": "string", + "description": "Pop-over icon, dark theme variant. Should be 32x32px or 64x64px and png/svg." + }, + "icon_class": { + "type": "string", + "description": "CSS class of the pop-over icon." + }, + "addon": { + "description": "Addon information including AMO URL.", + "type": "object", + "properties": { + "id": { + "$ref": "file:///ExtensionDoorhanger.schema.json#/$defs/plainText", + "description": "Unique addon ID" + }, + "title": { + "$ref": "file:///ExtensionDoorhanger.schema.json#/$defs/plainText", + "description": "Addon name" + }, + "author": { + "$ref": "file:///ExtensionDoorhanger.schema.json#/$defs/plainText", + "description": "Addon author" + }, + "icon": { + "$ref": "file:///ExtensionDoorhanger.schema.json#/$defs/linkUrl", + "description": "The icon displayed in the pop-over. Should be 64x64px and png/svg." + }, + "rating": { + "type": "string", + "description": "Star rating" + }, + "users": { + "type": "string", + "description": "Installed users" + }, + "amo_url": { + "$ref": "file:///ExtensionDoorhanger.schema.json#/$defs/linkUrl", + "description": "Link that offers more information related to the addon." + } + }, + "required": [ + "title", + "author", + "icon", + "amo_url" + ] + }, + "text": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "The body text displayed in the pop-over. This can be a reference to a localized string in Firefox or just a plain string." + }, + "descriptionDetails": { + "description": "Additional information and steps on how to use", + "type": "object", + "properties": { + "steps": { + "description": "Array of string_ids", + "type": "array", + "items": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizedText", + "description": "Id of string to localized addon description" + } + } + }, + "required": [ + "steps" + ] + }, + "buttons": { + "description": "The label and functionality for the buttons in the pop-over.", + "type": "object", + "properties": { + "primary": { + "type": "object", + "properties": { + "label": { + "type": "object", + "oneOf": [ + { + "properties": { + "value": { + "$ref": "file:///ExtensionDoorhanger.schema.json#/$defs/plainText", + "description": "Button label override used when a localized version is not available." + }, + "attributes": { + "type": "object", + "properties": { + "accesskey": { + "type": "string", + "description": "A single character to be used as a shortcut key for the secondary button. This should be one of the characters that appears in the button label." + } + }, + "required": [ + "accesskey" + ], + "description": "Button attributes." + } + }, + "required": [ + "value", + "attributes" + ] + }, + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizedText" + } + ], + "description": "Id of localized string or message override." + }, + "action": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Action dispatched by the button." + }, + "data": { + "properties": { + "url": { + "type": "string", + "$comment": "This is dynamically generated from the addon.id. See CFRPageActions.sys.mjs", + "description": "URL used in combination with the primary action dispatched." + } + } + } + } + } + } + }, + "secondary": { + "type": "array", + "items": { + "type": "object", + "properties": { + "label": { + "type": "object", + "oneOf": [ + { + "properties": { + "value": { + "allOf": [ + { + "$ref": "file:///ExtensionDoorhanger.schema.json#/$defs/plainText" + }, + { + "description": "Button label override used when a localized version is not available." + } + ] + }, + "attributes": { + "type": "object", + "properties": { + "accesskey": { + "type": "string", + "description": "A single character to be used as a shortcut key for the secondary button. This should be one of the characters that appears in the button label." + } + }, + "required": [ + "accesskey" + ], + "description": "Button attributes." + } + }, + "required": [ + "value", + "attributes" + ] + }, + { + "properties": { + "string_id": { + "allOf": [ + { + "$ref": "file:///ExtensionDoorhanger.schema.json#/$defs/plainText" + }, + { + "description": "Id of localized string for button" + } + ] + } + }, + "required": [ + "string_id" + ] + } + ], + "description": "Id of localized string or message override." + }, + "action": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Action dispatched by the button." + }, + "data": { + "properties": { + "url": { + "allOf": [ + { + "$ref": "file:///ExtensionDoorhanger.schema.json#/$defs/linkUrl" + }, + { + "description": "URL used in combination with the primary action dispatched." + } + ] + } + } + } + } + } + } + } + } + } + } + }, + "additionalProperties": true, + "required": [ + "layout", + "bucket_id", + "heading_text", + "text", + "buttons" + ], + "if": { + "properties": { + "skip_address_bar_notifier": { + "anyOf": [ + { + "const": "false" + }, + { + "const": null + } + ] + } + } + }, + "then": { + "required": [ + "category", + "notification_text" + ] + } + }, + "template": { + "type": "string", + "enum": [ + "cfr_doorhanger", + "milestone_message" + ] + } + }, + "additionalProperties": true, + "required": [ + "targeting", + "trigger" + ], + "$defs": { + "plainText": { + "description": "Plain text (no HTML allowed)", + "type": "string" + }, + "linkUrl": { + "description": "Target for links or buttons", + "type": "string", + "format": "uri" + } + } + }, + "InfoBar": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///InfoBar.schema.json", + "title": "InfoBar", + "description": "A template with an image, test and buttons.", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Specifies where the message should appear and persist: 'global' (persists across tabs in the current window), 'tab' (only visible in the current tab), or 'universal' (visible across all tabs and windows, current and future).", + "enum": [ + "global", + "tab", + "universal" + ] + }, + "text": { + "description": "Either a single localizableText, or an array of raw strings and/or localizableText objects. localizableText can contain an optional href property for the text to be rendered as a link.", + "oneOf": [ + { + "$ref": "file:///InfoBar.schema.json#/$defs/plainText" + }, + { + "allOf": [ + { + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText" + }, + { + "not": { + "required": [ + "href" + ] + } + }, + { + "type": "object", + "description": "Additional arguments, only a `where` override is currently allowed", + "properties": { + "args": { + "type": "object", + "description": "Where to open ('tab', 'tabshifted', 'current', etc.)", + "properties": { + "where": { + "type": "string", + "description": "Where to open - e.g. 'tab', 'window', etc." + } + }, + "additionalProperties": false + } + }, + "additionalProperties": true + } + ] + } + ] + }, + { + "$ref": "file:///InfoBar.schema.json#/$defs/localizableTextWithHref" + }, + { + "$ref": "file:///InfoBar.schema.json#/$defs/rawTextWithHref" + }, + { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "file:///InfoBar.schema.json#/$defs/plainText" + }, + { + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText" + }, + { + "not": { + "required": [ + "href" + ] + } + } + ] + }, + { + "$ref": "file:///InfoBar.schema.json#/$defs/localizableTextWithHref" + }, + { + "$ref": "file:///InfoBar.schema.json#/$defs/rawTextWithHref" + } + ] + } + } + ] + }, + "priority": { + "description": "Infobar priority level https://searchfox.org/mozilla-central/rev/3aef835f6cb12e607154d56d68726767172571e4/toolkit/content/widgets/notificationbox.js#387", + "type": "number", + "minumum": 0, + "exclusiveMaximum": 10 + }, + "dismissable": { + "description": "Should the infobar include an X dismiss button, defaults to true", + "type": "boolean" + }, + "dismissOnPrefChange": { + "description": "If set, one or more prefs to observe. The infobar will automatically dismiss when any of these prefs is set for the first time or when its value changes.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1, + "uniqueItems": true + } + ] + }, + "impression_action": { + "oneOf": [ + { + "$ref": "file:///InfoBar.schema.json#/$defs/impressionActionItem" + }, + { + "type": "object", + "properties": { + "type": { + "const": "MULTI_ACTION" + }, + "orderedExecution": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "actions": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "file:///InfoBar.schema.json#/$defs/impressionActionItem" + } + } + }, + "required": [ + "actions" + ], + "additionalProperties": false + } + }, + "required": [ + "type", + "data" + ], + "additionalProperties": false + } + ] + }, + "dismiss_action": { + "description": "Optional Special Message Action dispatched via dispatchUserAction when the user dismisses the infobar (X button). Any action type is allowed, including MULTI_ACTION, which SpecialMessageActions unpacks natively.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "SpecialMessageActions action type" + }, + "data": { + "type": "object" + } + }, + "required": [ + "type" + ], + "additionalProperties": true + }, + "canReplace": { + "description": "IDs of other infobar messages this infobar may replace", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + }, + "buttons": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "A stable identifier for this button, reported as `event_context.source` on click telemetry. Defaults to `button_` when omitted." + }, + "label": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "The text label of the button." + }, + "primary": { + "type": "boolean", + "description": "Is this the primary button?" + }, + "accessKey": { + "type": "string", + "description": "Keyboard shortcut letter." + }, + "action": { + "type": "object", + "properties": { + "dismiss": { + "type": "boolean", + "description": "Should the infobar be dismissed when the action is dispatched, defaults to true" + }, + "type": { + "type": "string", + "description": "Action dispatched by the button." + }, + "data": { + "type": "object" + } + }, + "required": [ + "type" + ], + "additionalProperties": true + }, + "supportPage": { + "type": "string", + "description": "A page title on SUMO to link to" + } + }, + "required": [ + "label", + "action" + ], + "additionalProperties": true + } + }, + "linkUrls": { + "description": "Map of Fluent data-l10n-name keys to real URLs", + "type": "object", + "additionalProperties": { + "$ref": "#/$defs/linkUrl" + } + }, + "linkActions": { + "description": "Map of Fluent data-l10n-name keys to a Special Message Action dispatched when the link is clicked (in addition to opening the URL).", + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "SpecialMessageActions action type" + }, + "data": { + "type": "object" + }, + "dismiss": { + "type": "boolean", + "description": "If true, dismiss the infobar after handling this link's action. Defaults to false." + } + }, + "required": [ + "type" + ] + } + }, + "style": { + "description": "Optional CSS overrides for this infobar. Currently, only `background-color` and `font-size` may be set. `background-color` will only apply when the user does not prefer high-contrast.", + "type": "object", + "properties": { + "background-color": { + "type": "string", + "description": "Any valid CSS color or light-dark() expression." + }, + "font-size": { + "type": "string", + "description": "Any valid CSS font-size value - rem units recommended to ensure size is relative to the system font size." + } + }, + "additionalProperties": false + } + }, + "additionalProperties": true, + "required": [ + "text", + "buttons" + ] + }, + "template": { + "type": "string", + "const": "infobar" + } + }, + "additionalProperties": true, + "required": [ + "targeting", + "trigger" + ], + "$defs": { + "plainText": { + "description": "Plain text (no HTML allowed)", + "type": "string" + }, + "linkUrl": { + "description": "Target for links or buttons", + "type": "string", + "format": "uri" + }, + "localizableTextWithHref": { + "description": "Everything a localizableText allows, plus a required href", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText" + }, + { + "type": "object", + "properties": { + "href": { + "$ref": "file:///InfoBar.schema.json#/$defs/linkUrl" + } + }, + "required": [ + "href" + ], + "additionalProperties": true + } + ] + }, + "rawTextWithHref": { + "description": "A literal text chunk that must include href", + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "href": { + "$ref": "file:///InfoBar.schema.json#/$defs/linkUrl" + } + }, + "required": [ + "raw", + "href" + ], + "additionalProperties": false + }, + "impressionActionItem": { + "type": "object", + "properties": { + "type": { + "const": "SET_PREF" + }, + "once": { + "type": "boolean", + "description": "If true, only fire on first impression." + }, + "data": { + "type": "object", + "properties": { + "pref": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": {} + }, + "required": [ + "name" + ] + } + }, + "required": [ + "pref" + ], + "additionalProperties": false + } + }, + "required": [ + "type", + "data" + ], + "additionalProperties": false + } + } + }, + "MenuMessage": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///MenuMessage.schema.json", + "title": "MenuMessage", + "description": "A template for messages that appear within our menus.", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "messageType": { + "type": "string", + "description": "The subtype of the message. 'fxa_cta' is used for Firefox Accounts messaging and is only visible when signed out, unless 'allowWhenSignedIn' property is provided. It replaces the fxa menu item when displayed. 'default_cta' is used for general messages, regardless of sign in state and only visible within the App Menu.", + "enum": [ + "fxa_cta", + "default_cta" + ] + }, + "primaryText": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "The primary text for the message, which offers the value proposition to the user." + }, + "secondaryText": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "The secondary text for the message, which offers more detail on the value proposition to the user. Not displayed when layout is 'simple'." + }, + "closeAction": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Action dispatched by the button." + }, + "data": { + "type": "object" + } + }, + "required": [ + "type" + ], + "additionalProperties": true, + "description": "The action to take upon clicking the close button." + }, + "primaryAction": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Action dispatched by the button." + }, + "data": { + "type": "object" + } + }, + "required": [ + "type" + ], + "additionalProperties": true, + "description": "The action to take upon clicking the primary action button." + }, + "primaryActionText": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "The label for the primary action." + }, + "primaryButtonSize": { + "type": "string", + "enum": [ + "default", + "small" + ], + "description": "The size of the primary button, default is 'default'." + }, + "imageURL": { + "type": "string", + "description": "URL for image to use with the content." + }, + "rtlImageURL": { + "type": "string", + "description": "URL for RTL images that have directionally dependent assets and cannot be flipped using 'directionalImage'." + }, + "imageWidth": { + "type": "number", + "description": "The image width in pixels. Default is 120px." + }, + "directionalImage": { + "type": "boolean", + "description": "If true, the illustration has a left/right orientation and should be horizontally mirrored in RTL contexts. Defaults to false." + }, + "logoURL": { + "type": "string", + "description": "URL for logo to use with the content." + }, + "logoWidth": { + "type": "number", + "description": "The logo width in pixels. Default is 18px." + }, + "imageVerticalTopOffset": { + "type": "number", + "description": "The margin-block-start value to apply to the image in pixels." + }, + "imageVerticalBottomOffset": { + "type": "number", + "description": "The margin-block-end value to apply to the image in pixels, used in 'row' layouts." + }, + "containerVerticalBottomOffset": { + "type": "number", + "description": "The container's margin-block-end value in pixels. Used to visually offset the image in 'row' layouts when 'imageVerticalBottomOffset' is applied." + }, + "containerPaddingBottom": { + "type": "number", + "description": "The container's padding-block-end value in pixels." + }, + "layout": { + "type": "string", + "description": "The layout of the message content and illustration. Row displays the image inline to the right of the text, column displays the image above the text. Simple layout only displays primary text and primary button on one row. Split displays the illustration in one column and a stacked content column, use 'imagePosition' to swap which side the illustration sits on.", + "enum": [ + "row", + "column", + "simple", + "split" + ] + }, + "imagePosition": { + "type": "string", + "description": "Position of the illustration. For split layout, 'start' or 'end' selects which inline side the illustration sits on (defaults to 'end'). For both split and column layout, 'bottom' renders the illustration at the bottom of the card.", + "enum": [ + "start", + "end", + "bottom" + ] + }, + "allowWhenSignedIn": { + "type": "boolean", + "description": "If true, the message will be shown even when the user is signed in. For 'fxa_cta' messages. Defaults to 'false'." + } + } + }, + "template": { + "type": "string", + "const": "menu_message" + }, + "testingTriggerContext": { + "type": "string", + "enum": [ + "app_menu", + "pxi_menu" + ] + } + }, + "additionalProperties": true + }, + "NewtabPromoMessage": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///NewtabPromoMessage.schema.json", + "title": "PBNewtabPromoMessage", + "description": "Message shown on the private browsing newtab page.", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "hideDefault": { + "type": "boolean", + "description": "Should we hide the default promo after the experiment promo is dismissed." + }, + "promoEnabled": { + "type": "boolean", + "description": "Should we show the promo section." + }, + "promoType": { + "type": "string", + "description": "Promo type used to determine if promo should show to a given user", + "enum": [ + "VPN", + "PIN", + "OTHER" + ] + }, + "promoSectionStyle": { + "type": "string", + "description": "Sets the position of the promo section. Possible values are: top, below-search, bottom. Default bottom.", + "enum": [ + "top", + "below-search", + "bottom" + ] + }, + "promoTitle": { + "type": "string", + "description": "The text content of the promo section." + }, + "promoTitleEnabled": { + "type": "boolean", + "description": "Should we show text content in the promo section." + }, + "promoLinkText": { + "type": "string", + "description": "The text of the link in the promo box." + }, + "promoHeader": { + "type": "string", + "description": "The title of the promo section." + }, + "promoButton": { + "type": "object", + "properties": { + "action": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Action dispatched by the button." + }, + "data": { + "type": "object" + } + }, + "required": [ + "type" + ], + "additionalProperties": true + } + }, + "required": [ + "action" + ] + }, + "promoLinkType": { + "type": "string", + "description": "Type of promo link type. Possible values: link, button. Default is link.", + "enum": [ + "link", + "button" + ] + }, + "promoImageLarge": { + "type": "string", + "description": "URL for image used on the left side of the promo box, larger, showcases some feature. Default off.", + "format": "uri" + }, + "promoImageSmall": { + "type": "string", + "description": "URL for image used on the right side of the promo box, smaller, usually a logo. Default off.", + "format": "uri" + } + }, + "additionalProperties": true, + "allOf": [ + { + "if": { + "properties": { + "promoEnabled": { + "const": true + } + }, + "required": [ + "promoEnabled" + ] + }, + "then": { + "required": [ + "promoButton" + ] + } + } + ] + }, + "template": { + "type": "string", + "const": "pb_newtab" + } + }, + "additionalProperties": true, + "required": [ + "targeting" + ] + }, + "NewtabMessage": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///NewtabMessage.schema.json", + "title": "NewtabMessage", + "description": "A template for messages that are rendered within newtab", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "messageType": { + "type": "string", + "description": "The subtype of the message." + } + }, + "additionalProperties": true, + "required": [ + "messageType" + ] + }, + "template": { + "type": "string", + "const": "newtab_message" + } + }, + "additionalProperties": true, + "required": [ + "targeting" + ] + }, + "SidebarChatBotPromo": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///SidebarChatBotPromo.schema.json", + "title": "SidebarChatBotPromo", + "description": "A template for promo messages that appear in the genai chat sidebar.", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The visual style of the promo (passed through to moz-promo)." + }, + "heading": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "The heading text of the promo." + }, + "message": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "The body text of the promo." + }, + "primary_button": { + "type": "object", + "properties": { + "label": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "The label for the primary action button." + }, + "action": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Action dispatched by the button." + }, + "data": { + "type": "object" + } + }, + "required": [ + "type" + ], + "additionalProperties": true, + "description": "The action to take upon clicking the primary button." + } + }, + "required": [ + "label", + "action" + ] + }, + "additional_button": { + "type": "object", + "properties": { + "label": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "The label for the dismiss action button. Uses `additional_button` rather than `secondary_button` because the onboarding provider pre-translates `secondary_button` labels via Fluent, which breaks labels that are not `{ string_id }`." + }, + "action": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Action dispatched by the button." + }, + "data": { + "type": "object" + } + }, + "required": [ + "type" + ], + "additionalProperties": true, + "description": "The action to take upon clicking the dismiss button." + } + }, + "required": [ + "label", + "action" + ] + } + }, + "additionalProperties": true + }, + "template": { + "type": "string", + "const": "sidebar_chatbot_promo" + } + }, + "additionalProperties": true + }, + "SmartWindowNewtabPromo": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///SmartWindowNewtabPromo.schema.json", + "title": "SmartWindowNewtabPromo", + "description": "A template for promo messages that appear on the Smart Window new tab page.", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The visual style of the promo (passed through to moz-promo)." + }, + "heading": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "The heading text of the promo." + }, + "message": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "The body text of the promo." + }, + "imageSrc": { + "type": "string", + "description": "URL of the image to display." + }, + "imageAlignment": { + "type": "string", + "description": "Alignment of the image within the promo." + }, + "imageWidth": { + "type": "string", + "description": "Width preset for the image." + }, + "imageDisplay": { + "type": "string", + "description": "Display style for the image." + }, + "primary_button": { + "type": "object", + "properties": { + "label": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "The label for the primary action button." + }, + "action": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Action dispatched by the button." + }, + "data": { + "type": "object" + } + }, + "required": [ + "type" + ], + "additionalProperties": true, + "description": "The action to take upon clicking the primary button." + } + }, + "required": [ + "label", + "action" + ] + }, + "additional_button": { + "type": "object", + "properties": { + "label": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "The label for the additional action button." + }, + "action": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Action dispatched by the button." + }, + "data": { + "type": "object" + } + }, + "required": [ + "type" + ], + "additionalProperties": true, + "description": "The action to take upon clicking the additional button." + } + }, + "required": [ + "label", + "action" + ] + } + }, + "additionalProperties": true + }, + "template": { + "type": "string", + "const": "smart_window_newtab_promo" + } + }, + "additionalProperties": true + }, + "Spotlight": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///Spotlight.schema.json", + "title": "Spotlight", + "description": "A template with an image, title, content and two buttons.", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "template": { + "type": "string", + "description": "Specify the layout template for the Spotlight", + "const": "multistage" + }, + "backdrop": { + "type": "string", + "description": "Background css behind modal content" + }, + "logo": { + "type": "object", + "properties": { + "imageURL": { + "type": "string", + "description": "URL for image to use with the content" + }, + "imageId": { + "type": "string", + "description": "The ID for a remotely hosted image" + }, + "size": { + "type": "string", + "description": "The logo size." + } + }, + "additionalProperties": true + }, + "screens": { + "type": "array", + "description": "Collection of individual screen content" + }, + "transitions": { + "type": "boolean", + "description": "Show transitions within and between screens" + }, + "disableEscClose": { + "type": "boolean", + "description": "Don't allow the message to be dismissed using the ESC key - for limited use in Spotlight modals only when the message content clearly informs the user that a decision is required to proceed" + }, + "write_in_microsurvey": { + "type": "boolean", + "description": "Set to true to apply the write-in microsurvey data policy. This is required for write-in microsurveys. Messages using the textarea tile should always set this to true. It prevents client_id from being recorded with any telemetry events for the message, recording a unique impression_id instead. It also sends the events on the more restrictive microsurvey ping instead of the messaging-system ping." + }, + "disableHistoryUpdates": { + "type": "boolean", + "description": "Don't alter the browser session's history stack - used with messaging surfaces like Feature Callouts" + }, + "startScreen": { + "type": "integer", + "description": "Index of first screen to show from message, defaulting to 0" + }, + "no-rdm": { + "type": "boolean", + "description": "If true, prevents the spotlight from entering responsive design mode at widths less than 800px" + } + }, + "additionalProperties": true + }, + "template": { + "type": "string", + "description": "Specify whether the surface is shown as a Spotlight modal or an in-surface Feature Callout dialog", + "enum": [ + "spotlight", + "feature_callout" + ] + } + }, + "additionalProperties": true, + "required": [ + "targeting" + ] + }, + "ToastNotification": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///ToastNotification.schema.json", + "title": "ToastNotification", + "description": "A template for toast notifications displayed by the Alert service.", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "title": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "Id of localized string or message override of toast notification title" + }, + "body": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "Id of localized string or message override of toast notification body" + }, + "icon_url": { + "description": "The URL of the image used as an icon of the toast notification.", + "type": "string", + "format": "moz-url-format" + }, + "image_url": { + "description": "The URL of an image to be displayed as part of the notification.", + "type": "string", + "format": "moz-url-format" + }, + "dark_mode_image_url": { + "description": "The URL of an image to be displayed as part of the notification in dark mode.", + "type": "string", + "format": "moz-url-format" + }, + "reduced_motion_image_url": { + "description": "The URL of an image to be displayed as part of the notification when the user prefers reduced motion.", + "type": "string", + "format": "moz-url-format" + }, + "dark_mode_reduced_motion_image_url": { + "description": "The URL of an image to be displayed as part of the notification in dark mode with reduced motion.", + "type": "string", + "format": "moz-url-format" + }, + "launch_url": { + "description": "The URL to launch when the notification or an action button is clicked.", + "type": "string", + "format": "moz-url-format" + }, + "launch_action": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The launch action to be performed when Firefox is launched." + }, + "data": { + "type": "object" + } + }, + "required": [ + "type" + ], + "additionalProperties": true + }, + "requireInteraction": { + "type": "boolean", + "description": "Whether the toast notification should remain active until the user clicks or dismisses it, rather than closing automatically." + }, + "tag": { + "type": "string", + "description": "An identifying tag for the toast notification." + }, + "data": { + "type": "object", + "description": "Arbitrary data associated with the toast notification." + }, + "actions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "title": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "The action text to be shown to the user." + }, + "action": { + "type": "string", + "description": "Opaque identifer that identifies action." + }, + "iconURL": { + "type": "string", + "format": "uri", + "description": "URL of an icon to display with the action." + }, + "windowsSystemActivationType": { + "type": "boolean", + "description": "Whether to have Windows process the given `action`." + }, + "launch_action": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The launch action to be performed when Firefox is launched." + }, + "data": { + "type": "object" + } + }, + "required": [ + "type" + ], + "additionalProperties": true + } + }, + "required": [ + "action", + "title" + ], + "additionalProperties": true + } + } + }, + "additionalProperties": true, + "required": [ + "title", + "body" + ] + }, + "template": { + "type": "string", + "const": "toast_notification" + } + }, + "required": [ + "content", + "targeting", + "template", + "trigger" + ], + "additionalProperties": true + }, + "ToolbarBadgeMessage": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///ToolbarBadgeMessage.schema.json", + "title": "ToolbarBadgeMessage", + "description": "A template that specifies to which element in the browser toolbar to add a notification.", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "target": { + "type": "string" + }, + "action": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "additionalProperties": true, + "required": [ + "id" + ], + "description": "Optional action to take in addition to showing the notification" + }, + "delay": { + "type": "number", + "description": "Optional delay in ms after which to show the notification" + }, + "badgeDescription": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizedText", + "description": "This is used in combination with the badged button to offer a text based alternative to the visual badging. Example 'New Feature: What's New'" + } + }, + "additionalProperties": true, + "required": [ + "target" + ] + }, + "template": { + "type": "string", + "const": "toolbar_badge" + } + }, + "additionalProperties": true, + "required": [ + "targeting" + ] + }, + "UpdateAction": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///UpdateAction.schema.json", + "title": "UpdateActionMessage", + "description": "A template for messages that execute predetermined actions.", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "action": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "data": { + "type": "object", + "description": "Additional data provided as argument when executing the action", + "properties": { + "url": { + "type": "string", + "description": "URL data to be used as argument to the action" + }, + "expireDelta": { + "type": "number", + "description": "Expiration timestamp to be used as argument to the action" + } + } + } + }, + "additionalProperties": true, + "description": "Optional action to take in addition to showing the notification", + "required": [ + "id", + "data" + ] + } + }, + "additionalProperties": true, + "required": [ + "action" + ] + }, + "template": { + "type": "string", + "const": "update_action" + } + }, + "required": [ + "targeting" + ] + }, + "Message": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The message identifier" + }, + "groups": { + "description": "Array of preferences used to control `enabled` status of the group. If any is `false` the group is disabled.", + "type": "array", + "items": { + "type": "string", + "description": "Preference name" + } + }, + "template": { + "type": "string", + "description": "Which messaging template this message is using.", + "enum": [ + "action_only", + "bookmarks_bar_button", + "cfr_urlbar_chiclet", + "cfr_doorhanger", + "milestone_message", + "infobar", + "menu_message", + "pb_newtab", + "newtab_message", + "sidebar_chatbot_promo", + "smart_window_newtab_promo", + "spotlight", + "feature_callout", + "toast_notification", + "toolbar_badge", + "update_action" + ] + }, + "frequency": { + "type": "object", + "description": "An object containing frequency cap information for a message.", + "properties": { + "lifetime": { + "type": "integer", + "description": "The maximum lifetime impressions for a message.", + "minimum": 1, + "maximum": 100 + }, + "custom": { + "type": "array", + "description": "An array of custom frequency cap definitions.", + "items": { + "description": "A frequency cap definition containing time and max impression information", + "type": "object", + "properties": { + "period": { + "type": "integer", + "description": "Period of time in milliseconds (e.g. 86400000 for one day)" + }, + "cap": { + "type": "integer", + "description": "The maximum impressions for the message within the defined period.", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "period", + "cap" + ] + } + } + } + }, + "priority": { + "description": "The priority of the message. If there are two competing messages to show, the one with the highest priority will be shown", + "type": "integer" + }, + "order": { + "description": "The order in which messages should be shown. Messages will be shown in increasing order.", + "type": "integer" + }, + "targeting": { + "description": "A JEXL expression representing targeting information", + "type": "string" + }, + "trigger": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Trigger" + }, + "triggers": { + "description": "An array of trigger actions (alternative to the singular `trigger`). The message is eligible if any one of them matches. When 'trigger' is also present, `triggers` takes precedence. Targeting is evaluated using the context of whichever trigger fired, so context a trigger contributes (for example `tabsClosedCount` from `nthTabClosed`) is only available when that specific trigger fires. Ensure the targeting expression is valid for every trigger listed.", + "type": "array", + "minItems": 1, + "items": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Trigger" + } + }, + "provider": { + "description": "An identifier for the provider of this message, such as \"cfr\" or \"preview\".", + "type": "string" + } + }, + "additionalProperties": true, + "dependentRequired": { + "content": [ + "id", + "template" + ], + "template": [ + "id", + "content" + ] + } + }, + "localizedText": { + "type": "object", + "properties": { + "string_id": { + "description": "Id of localized string to be rendered.", + "type": "string" + } + }, + "required": [ + "string_id" + ] + }, + "localizableText": { + "description": "Either a raw string or an object containing the string_id of the localized text", + "oneOf": [ + { + "type": "string", + "description": "The string to be rendered." + }, + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizedText" + } + ] + }, + "Trigger": { + "description": "An action to trigger potentially showing the message", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "A string identifying the trigger action" + }, + "params": { + "type": "array", + "description": "An optional array of string parameters for the trigger action", + "items": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + }, + "required": [ + "id" + ] + }, + "TemplatedMessage": { + "description": "An FxMS message of one of a variety of types.", + "type": "object", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "action_only" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/ActionOnlyMessage" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "bookmarks_bar_button" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/BookmarksBarButton" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "cfr_urlbar_chiclet" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/CFRUrlbarChiclet" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "cfr_doorhanger", + "milestone_message" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/ExtensionDoorhanger" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "infobar" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/InfoBar" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "menu_message" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/MenuMessage" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "pb_newtab" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/NewtabPromoMessage" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "newtab_message" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/NewtabMessage" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "sidebar_chatbot_promo" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/SidebarChatBotPromo" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "smart_window_newtab_promo" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/SmartWindowNewtabPromo" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "spotlight", + "feature_callout" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Spotlight" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "toast_notification" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/ToastNotification" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "toolbar_badge" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/ToolbarBadgeMessage" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "update_action" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/UpdateAction" + } + } + ] + }, + "MultiMessage": { + "description": "An object containing an array of messages.", + "type": "object", + "properties": { + "template": { + "type": "string", + "const": "multi" + }, + "messages": { + "type": "array", + "description": "An array of messages.", + "items": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/TemplatedMessage" + } + } + }, + "required": [ + "template", + "messages" + ] + } + } +} diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/schemas/toolkit/components/nimbus/schemas/NimbusTelemetryFeature.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/schemas/toolkit/components/nimbus/schemas/NimbusTelemetryFeature.schema.json new file mode 100644 index 0000000000..668236e81c --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/schemas/toolkit/components/nimbus/schemas/NimbusTelemetryFeature.schema.json @@ -0,0 +1,35 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "type": "object", + "properties": { + "gleanMetricConfiguration": { + "type": "object", + "properties": { + "metrics_enabled": { + "type": "object", + "patternProperties": { + "^nimbus_targeting_environment\\..*": { "type": "boolean" }, + "^nimbus_targeting_context\\..*": { "type": "boolean" }, + "^nimbus_events\\..*": { "type": "boolean" } + }, + "additionalProperties": false + } + }, + "additionalProperties": true + }, + "nimbusTargetingEnvironment": { + "type": "object", + "properties": { + "recordAttrs": { + "description": "A list of attributes that should be recorded in the nimbus_targeting_environment.targeting_context_value metric. If not provided, it will default to all attributes.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "additionalProperties": true + } + }, + "additionalProperties": true +} diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/schemas/toolkit/components/nimbus/schemas/PrefFlipsFeature.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/schemas/toolkit/components/nimbus/schemas/PrefFlipsFeature.schema.json new file mode 100644 index 0000000000..9fa5acc7c9 --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/schemas/toolkit/components/nimbus/schemas/PrefFlipsFeature.schema.json @@ -0,0 +1,48 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "type": "object", + "properties": { + "prefs": { + "description": "The prefs to set", + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "properties": { + "branch": { + "description": "The branch the pref should be set on.", + "type": "string", + "enum": ["user", "default"] + }, + "value": { + "description": "The value of the pref. Set to null to clear prefs.", + "type": ["string", "integer", "boolean", "null"] + } + }, + "required": ["branch", "value"], + "allOf": [ + { + "description": "Prevent clearing the default branch", + "if": { + "properties": { + "branch": { + "const": "default" + } + } + }, + "then": { + "properties": { + "value": { + "type": ["string", "integer", "boolean"] + } + } + } + } + ] + } + } + } + }, + "required": ["prefs"], + "additionalProperties": false +} diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/schemas/toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/schemas/toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json new file mode 100644 index 0000000000..3bb1f18fc4 --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v155.0.2/schemas/toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json @@ -0,0 +1,73 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Legacy (Normandy) Heartbeat, via Nimbus", + "description": "The schema for the Legacy Heartbeat Nimbus feature.", + "type": "object", + "properties": { + "survey": { + "$comment": "Hearbeat arguments are nested under survey to prevent simultaneous rollouts and experiments from overriding eachothers optional variables", + "type": "object", + "properties": { + "repeatOption": { + "type": "string", + "enum": ["once", "xdays"], + "description": "Determines how often a prompt is shown executes.", + "default": "once" + }, + "repeatEvery": { + "description": "For repeatOption=xdays, how often (in days) the prompt is displayed.", + "default": null, + "type": ["number", "null"] + }, + "includeTelemetryUUID": { + "type": "boolean", + "description": "Include unique user ID in post-answer-url and Telemetry", + "default": false + }, + "surveyId": { + "description": "Slug uniquely identifying this survey in telemetry", + "type": "string" + }, + "message": { + "description": "Message to show to the user", + "type": "string" + }, + "engagementButtonLabel": { + "description": "Text for the engagement button. If specified, this button will be shown instead of rating stars.", + "default": null, + "type": ["string", "null"] + }, + "thanksMessage": { + "description": "Thanks message to show to the user after they've rated Firefox", + "type": "string" + }, + "postAnswerUrl": { + "description": "URL to redirect the user to after rating Firefox or clicking the engagement button", + "default": null, + "type": ["string", "null"] + }, + "learnMoreMessage": { + "description": "Message to show to the user to learn more", + "default": null, + "type": ["string", "null"] + }, + "learnMoreUrl": { + "description": "URL to show to the user when they click Learn More", + "default": null, + "type": ["string", "null"] + } + }, + "required": [ + "surveyId", + "message", + "thanksMessage", + "postAnswerUrl", + "learnMoreMessage", + "learnMoreUrl" + ], + "additionalProperties": false + } + }, + "required": ["survey"], + "additionalProperties": false +} diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/v157.0.0/TargetingContextRecorder.sys.mjs b/experimenter/experimenter/features/manifests/firefox-desktop/v157.0.0/TargetingContextRecorder.sys.mjs index cf7fb828e5..a4d2adfa91 100644 --- a/experimenter/experimenter/features/manifests/firefox-desktop/v157.0.0/TargetingContextRecorder.sys.mjs +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v157.0.0/TargetingContextRecorder.sys.mjs @@ -2,9 +2,9 @@ * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ -const lazy = {}; +import { XPCOMUtils } from "resource://gre/modules/XPCOMUtils.sys.mjs"; -ChromeUtils.defineESModuleGetters(lazy, { +const lazy = XPCOMUtils.declareLazy({ ASRouterTargeting: // eslint-disable-next-line mozilla/no-browser-refs-in-toolkit "resource:///modules/asrouter/ASRouterTargeting.sys.mjs", @@ -227,6 +227,7 @@ export const PREFS = Object.freeze({ "browser.newtabpage.enabled": PREF_BOOL, "browser.profiles.created": PREF_BOOL, "browser.startup.page": PREF_INT, + "browser.tabs.splitview.hasUsed": PREF_BOOL, "browser.toolbars.bookmarks.visibility": PREF_STRING, "browser.urlbar.lastUrlbarSearchSeconds": PREF_INT, "browser.urlbar.showSearchSuggestionsFirst": PREF_BOOL, diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/v157.0.0/experimenter.yaml b/experimenter/experimenter/features/manifests/firefox-desktop/v157.0.0/experimenter.yaml index 317dfad131..98d6166248 100644 --- a/experimenter/experimenter/features/manifests/firefox-desktop/v157.0.0/experimenter.yaml +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v157.0.0/experimenter.yaml @@ -2072,7 +2072,11 @@ pocketNewtab: fallbackPref: >- browser.newtabpage.activity-stream.discoverystream.ctaButtonVariant regionStoriesConfig: - description: A comma-separated list of region to get stories for. + description: >- + Legacy, superseded by the stories-region-locale-config pref, which the + newtab extension reads directly. A region listed here + gets stories in the locales it was historically paired with. Do not set + it in new recipes. type: string fallbackPref: >- browser.newtabpage.activity-stream.discoverystream.region-stories-config @@ -2082,15 +2086,10 @@ pocketNewtab: browser.newtabpage.activity-stream.discoverystream.merino-provider.endpoint description: Merino endpoint to use for recommendations. regionStoriesBlock: - description: A comma-separated list of regions that do not get stories, regardless of locale-list-config. + description: A comma-separated list of regions that do not get stories, regardless of the stories-region-locale-config pref. type: string fallbackPref: >- browser.newtabpage.activity-stream.discoverystream.region-stories-block - localeListConfig: - description: A comma-separated list of locales that get stories, regardless of region-stories-config. - type: string - fallbackPref: >- - browser.newtabpage.activity-stream.discoverystream.locale-list-config regionSpocsConfig: description: A comma-separated list of regions that get spocs by default. type: string @@ -2259,6 +2258,29 @@ autofill-ml: branch: default pref: extensions.formautofill.useml.modelVersion +# Deliberately a feature of its own rather than a variable of autofill-ml: a +# field type that turns out to be badly classified needs a rollout of its own, +# and Nimbus allows a single enrollment per feature. +autofill-ml-ignore-field-types: + description: Field types excluded from machine-learning based form field detection + owner: dlee@mozilla.com + hasExposure: false + variables: + ignoreFieldTypes: + type: string + setPref: + branch: default + pref: extensions.formautofill.useml.ignoreFieldTypes + description: >- + Comma separated list of field types (for example + "cc-exp, cc-exp-month, cc-exp-year"; spaces after the commas are + ignored) the ML model is not trusted with. Those types are classified + by the regular expression based heuristics instead, and any prediction + the model makes for one of them is discarded. List related field types + together, as in the example: the heuristics only try the rules of the + listed types, so leaving one out can let a broader rule win over the + more specific one it would normally lose to. + shellService: description: "Interface with OS, e.g., pinning and set default" owner: desktop-integrations@mozilla.com @@ -6229,3 +6251,15 @@ editContext: branch: default pref: dom.editcontext.enabled description: Whether the EditContext API is enabled. + +nova: + description: Nova UI + owner: dtownsend@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: browser.nova.enabled + description: Whether Nova is enabled. diff --git a/experimenter/experimenter/features/manifests/fxa-web/developer.fml.yaml b/experimenter/experimenter/features/manifests/fxa-web/developer.fml.yaml index fe5e89c8d7..e86b9c1d0f 100644 --- a/experimenter/experimenter/features/manifests/fxa-web/developer.fml.yaml +++ b/experimenter/experimenter/features/manifests/fxa-web/developer.fml.yaml @@ -15,3 +15,39 @@ features: description: If the feature is enabled. type: Boolean default: true + promo-qr-mobile: + description: | + Value proposition A/B test for the QR mobile download promo shown in the authentication flow. The branch slug selects both the heading string and the matching QR code, because each QR points at a distinct Bitly link. + variables: + branch: + description: | + The branch slug. An unknown slug falls back to the control, but the BranchSlug enum means Experimenter rejects one before that can happen. + type: Option + default: control + enabled: + description: If the experiment is enabled. When false the control ships. + type: Boolean + default: false +enums: + BranchSlug: + description: | + The arms of the QR promo value proposition test. Each slug selects a heading and its matching QR code in PromoQrMobile/branches.ts, so a slug added here must be added there too. + variants: + control: + description: Control | Your phone. Your rules. | Scan to download mobile app + treatment-a: + description: Continue Across Devices | Pick up where you left off, wherever you go | Scan to download mobile app + treatment-b: + description: Continue Across Devices | Your tabs and more, ready on your phone | Scan to download mobile app + treatment-c: + description: One Browser You Trust | The browser you trust, on your phone | Scan to download mobile app + treatment-d: + description: One Browser You Trust | Same Firefox. Different screen. | Scan to download mobile app + treatment-e: + description: Protect Your Privacy Everywhere | Your privacy shouldn’t stop here | Scan to download mobile app + treatment-f: + description: Protect Your Privacy Everywhere | Keep more of your browsing to yourself | Scan to download mobile app + treatment-g: + description: Calmer Focus | Your phone could use a little less noise | Scan to download mobile app + treatment-h: + description: Calmer Focus | Take a calmer way to browse with you | Scan to download mobile app diff --git a/experimenter/experimenter/features/manifests/fxa-web/experimenter.yaml b/experimenter/experimenter/features/manifests/fxa-web/experimenter.yaml index 39e9084423..d4ea02b6b0 100644 --- a/experimenter/experimenter/features/manifests/fxa-web/experimenter.yaml +++ b/experimenter/experimenter/features/manifests/fxa-web/experimenter.yaml @@ -9,3 +9,16 @@ example-feature: enabled: type: boolean description: If the feature is enabled. +promo-qr-mobile: + description: | + Value proposition A/B test for the QR mobile download promo shown in the authentication flow. The branch slug selects both the heading string and the matching QR code, because each QR points at a distinct Bitly link. + hasExposure: true + exposureDescription: '' + variables: + branch: + type: string + description: | + The branch slug. An unknown slug falls back to the control, but the BranchSlug enum means Experimenter rejects one before that can happen. + enabled: + type: boolean + description: If the experiment is enabled. When false the control ships. diff --git a/experimenter/experimenter/features/manifests/fxa-web/production.fml.yaml b/experimenter/experimenter/features/manifests/fxa-web/production.fml.yaml index 25180f14b5..156dd65d8e 100644 --- a/experimenter/experimenter/features/manifests/fxa-web/production.fml.yaml +++ b/experimenter/experimenter/features/manifests/fxa-web/production.fml.yaml @@ -15,3 +15,39 @@ features: description: If the feature is enabled. type: Boolean default: false + promo-qr-mobile: + description: | + Value proposition A/B test for the QR mobile download promo shown in the authentication flow. The branch slug selects both the heading string and the matching QR code, because each QR points at a distinct Bitly link. + variables: + branch: + description: | + The branch slug. An unknown slug falls back to the control, but the BranchSlug enum means Experimenter rejects one before that can happen. + type: Option + default: control + enabled: + description: If the experiment is enabled. When false the control ships. + type: Boolean + default: false +enums: + BranchSlug: + description: | + The arms of the QR promo value proposition test. Each slug selects a heading and its matching QR code in PromoQrMobile/branches.ts, so a slug added here must be added there too. + variants: + control: + description: Control | Your phone. Your rules. | Scan to download mobile app + treatment-a: + description: Continue Across Devices | Pick up where you left off, wherever you go | Scan to download mobile app + treatment-b: + description: Continue Across Devices | Your tabs and more, ready on your phone | Scan to download mobile app + treatment-c: + description: One Browser You Trust | The browser you trust, on your phone | Scan to download mobile app + treatment-d: + description: One Browser You Trust | Same Firefox. Different screen. | Scan to download mobile app + treatment-e: + description: Protect Your Privacy Everywhere | Your privacy shouldn’t stop here | Scan to download mobile app + treatment-f: + description: Protect Your Privacy Everywhere | Keep more of your browsing to yourself | Scan to download mobile app + treatment-g: + description: Calmer Focus | Your phone could use a little less noise | Scan to download mobile app + treatment-h: + description: Calmer Focus | Take a calmer way to browse with you | Scan to download mobile app diff --git a/experimenter/experimenter/features/manifests/fxa-web/staging.fml.yaml b/experimenter/experimenter/features/manifests/fxa-web/staging.fml.yaml index d4d6ec6705..f1f0871f6b 100644 --- a/experimenter/experimenter/features/manifests/fxa-web/staging.fml.yaml +++ b/experimenter/experimenter/features/manifests/fxa-web/staging.fml.yaml @@ -15,3 +15,39 @@ features: description: If the feature is enabled. type: Boolean default: false + promo-qr-mobile: + description: | + Value proposition A/B test for the QR mobile download promo shown in the authentication flow. The branch slug selects both the heading string and the matching QR code, because each QR points at a distinct Bitly link. + variables: + branch: + description: | + The branch slug. An unknown slug falls back to the control, but the BranchSlug enum means Experimenter rejects one before that can happen. + type: Option + default: control + enabled: + description: If the experiment is enabled. When false the control ships. + type: Boolean + default: false +enums: + BranchSlug: + description: | + The arms of the QR promo value proposition test. Each slug selects a heading and its matching QR code in PromoQrMobile/branches.ts, so a slug added here must be added there too. + variants: + control: + description: Control | Your phone. Your rules. | Scan to download mobile app + treatment-a: + description: Continue Across Devices | Pick up where you left off, wherever you go | Scan to download mobile app + treatment-b: + description: Continue Across Devices | Your tabs and more, ready on your phone | Scan to download mobile app + treatment-c: + description: One Browser You Trust | The browser you trust, on your phone | Scan to download mobile app + treatment-d: + description: One Browser You Trust | Same Firefox. Different screen. | Scan to download mobile app + treatment-e: + description: Protect Your Privacy Everywhere | Your privacy shouldn’t stop here | Scan to download mobile app + treatment-f: + description: Protect Your Privacy Everywhere | Keep more of your browsing to yourself | Scan to download mobile app + treatment-g: + description: Calmer Focus | Your phone could use a little less noise | Scan to download mobile app + treatment-h: + description: Calmer Focus | Take a calmer way to browse with you | Scan to download mobile app diff --git a/experimenter/experimenter/features/manifests/ios/.ref-cache.yaml b/experimenter/experimenter/features/manifests/ios/.ref-cache.yaml index 45a5136852..fcdef53c52 100644 --- a/experimenter/experimenter/features/manifests/ios/.ref-cache.yaml +++ b/experimenter/experimenter/features/manifests/ios/.ref-cache.yaml @@ -105,7 +105,8 @@ firefox-v153.3: a1fe44b556b24989a5fddf62d5833b45ba54e1e5 firefox-v154.0: 558560be69f1baa17ca52cde82ae5d35293eaac5 firefox-v154.1: 0a31de5b12bf9811d1eb5cc555f1c832878f4686 firefox-v155.0: e085522364162451ad4c87a989e0e0a64b0b7d31 -main: 5afe7f032df23c669a0291cfe65ef938bcf02528 +firefox-v155.1: 04df3bd66b34441c6b97ee3958535c5bf4633ca4 +main: c57b40a50f5ef267ffb4da5c75cd2079824f1ee1 release/v117: 43b690c450066d4dde1b2ccb93ed3714d244d502 release/v118: 89a7ea3c3372e5a4ef5b3c5b85499d26198d0524 release/v119: 7dc381f991c6d2a983c3ba7f0cffd880e8c29e7b @@ -181,7 +182,8 @@ release/v153.3: 99e048925cfa73c62cd599239c2e3b5a878cde43 release/v154.0: e389b0993249fdca0a15d20f7388afeef6bbc5c5 release/v154.1: f3e756c81091278459052423d2c77d0fe30d625e release/v155.0: 5fc3c87d1c4ad62d9e396d1afaa368b0c5d7ade9 -release/v155.1: 04df3bd66b34441c6b97ee3958535c5bf4633ca4 +release/v155.1: 674054f10403b0af7ba9f7911c346029afbd264b +release/v156.0: 5994628f1e261b0761915765b1fb6eaa3917fdab v117.0: 3b275ab1e4ccef769d84437033c0c68acfd2df8a v117.1: 55ddcf473a65d106d43f6d2ae5af4076d6d03688 v117.2: 5cc367aa8857199cd8a54d53e8faf6696c5614c3 diff --git a/experimenter/experimenter/features/manifests/ios/beta.fml.yaml b/experimenter/experimenter/features/manifests/ios/beta.fml.yaml index 49c814ce4c..f6a62372a8 100644 --- a/experimenter/experimenter/features/manifests/ios/beta.fml.yaml +++ b/experimenter/experimenter/features/manifests/ios/beta.fml.yaml @@ -827,7 +827,7 @@ features: setting: description: This property provides a default setting for the start at home feature type: StartAtHome - default: afterFourHours + default: disabled summarizer-app-attest-auth-feature: description: | This feature enables app attest authentication for the summarizer. diff --git a/experimenter/experimenter/features/manifests/ios/developer.fml.yaml b/experimenter/experimenter/features/manifests/ios/developer.fml.yaml index 28c1cfa7ab..c70168153b 100644 --- a/experimenter/experimenter/features/manifests/ios/developer.fml.yaml +++ b/experimenter/experimenter/features/manifests/ios/developer.fml.yaml @@ -838,7 +838,7 @@ features: setting: description: This property provides a default setting for the start at home feature type: StartAtHome - default: afterFourHours + default: disabled summarizer-app-attest-auth-feature: description: | This feature enables app attest authentication for the summarizer. diff --git a/experimenter/experimenter/features/manifests/ios/release.fml.yaml b/experimenter/experimenter/features/manifests/ios/release.fml.yaml index dae8a4450f..25887fe7e9 100644 --- a/experimenter/experimenter/features/manifests/ios/release.fml.yaml +++ b/experimenter/experimenter/features/manifests/ios/release.fml.yaml @@ -808,7 +808,7 @@ features: setting: description: This property provides a default setting for the start at home feature type: StartAtHome - default: afterFourHours + default: disabled summarizer-app-attest-auth-feature: description: | This feature enables app attest authentication for the summarizer. diff --git a/experimenter/experimenter/features/manifests/ios/v155.1.1/RecordedNimbusContext.swift b/experimenter/experimenter/features/manifests/ios/v155.1.1/RecordedNimbusContext.swift new file mode 100644 index 0000000000..c402e7a6aa --- /dev/null +++ b/experimenter/experimenter/features/manifests/ios/v155.1.1/RecordedNimbusContext.swift @@ -0,0 +1,226 @@ +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at http://mozilla.org/MPL/2.0/ + +import Common +import Foundation +import Glean +import Shared + +import class MozillaAppServices.NimbusGleanPings +import func MozillaAppServices.getCalculatedAttributes +import func MozillaAppServices.getLocaleTag +import struct MozillaAppServices.JsonObject +import protocol MozillaAppServices.RecordedContext +import MozillaRustComponents + +private extension Double? { + func toInt64() -> Int64? { + guard let self = self else { return nil } + return Int64(self) + } +} + +extension Int32? { + func toInt64() -> Int64? { + guard let self = self else { return nil } + return Int64(self) + } +} + +/// TODO(FXIOS-12942): Implement proper thread-safety +final class RecordedNimbusContext: RecordedContext, @unchecked Sendable { + /** + * The following constants are string constants of the keys that appear in the [EVENT_QUERIES] map. + */ + static let DAYS_OPENED_IN_LAST_28 = "days_opened_in_last_28" + + /** + * [EVENT_QUERIES] is a map of keys to Nimbus SDK EventStore queries. + */ + static let EVENT_QUERIES = [ + DAYS_OPENED_IN_LAST_28: "'events.app_opened'|eventCountNonZero('Days', 28, 0)", + ] + + var isFirstRun: Bool + var isPhone: Bool + var isDefaultBrowser: Bool + var isBottomToolbarUser: Bool + var hasEnabledTipsNotifications: Bool + var hasAcceptedTermsOfUse: Bool + var userDisabledAi: Bool + var isAppleIntelligenceAvailable: Bool + var cannotUseAppleIntelligence: Bool + var appVersion: String? + var region: String? + var language: String? + var locale: String + var daysSinceInstall: Int32? + var daysSinceUpdate: Int32? + var touExperiencePoints: Int32? + + private var eventQueries: [String: String] + private var eventQueryValues: [String: Double] = [:] + + private var logger: Logger + + init(isFirstRun: Bool, + isDefaultBrowser: Bool, + isBottomToolbarUser: Bool, + hasEnabledTipsNotifications: Bool, + hasAcceptedTermsOfUse: Bool, + userDisabledAi: Bool, + isAppleIntelligenceAvailable: Bool, + cannotUseAppleIntelligence: Bool, + eventQueries: [String: String] = RecordedNimbusContext.EVENT_QUERIES, + isPhone: Bool = UIDeviceDetails.userInterfaceIdiom == .phone, + bundle: Bundle = Bundle.main, + logger: Logger = DefaultLogger.shared) { + self.logger = logger + logger.log("init start", level: .debug, category: .experiments) + self.eventQueries = eventQueries + + self.isFirstRun = isFirstRun + self.isPhone = isPhone + self.isDefaultBrowser = isDefaultBrowser + self.isBottomToolbarUser = isBottomToolbarUser + self.hasEnabledTipsNotifications = hasEnabledTipsNotifications + self.hasAcceptedTermsOfUse = hasAcceptedTermsOfUse + self.userDisabledAi = userDisabledAi + self.isAppleIntelligenceAvailable = isAppleIntelligenceAvailable + self.cannotUseAppleIntelligence = cannotUseAppleIntelligence + + let info = bundle.infoDictionary ?? [:] + appVersion = info["CFBundleShortVersionString"] as? String + + locale = getLocaleTag() + var inferredDateInstalledOn: Date? { + guard + let documentsURL = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).last, + let attributes = try? FileManager.default.attributesOfItem(atPath: documentsURL.path) + else { return nil } + return attributes[.creationDate] as? Date + } + let installationDateSinceEpoch = inferredDateInstalledOn.map { + Int64(($0.timeIntervalSince1970 * 1000).rounded()) + } + guard let dbPath = Experiments.dbPath else { + self.logger.log("Unable to obtain dbPath, skipping calculating attributes", + level: .warning, + category: .experiments) + return + } + guard let calculatedAttributes = try? getCalculatedAttributes(installationDate: installationDateSinceEpoch, + dbPath: dbPath, + locale: locale) + else { return } + + daysSinceInstall = calculatedAttributes.daysSinceInstall + daysSinceUpdate = calculatedAttributes.daysSinceUpdate + language = calculatedAttributes.language + region = calculatedAttributes.region + touExperiencePoints = Experiments.touExperiencePoints(region: region) + self.logger.log("init end", level: .debug, category: .experiments) + } + + /** + * [getEventQueries] is called by the Nimbus SDK Rust code to retrieve the map of event + * queries. The are then executed against the Nimbus SDK's EventStore to retrieve their values. + * + * @return Map + */ + func getEventQueries() -> [String: String] { + logger.log("getEventQueries", level: .debug, category: .experiments) + return eventQueries + } + + /** + * [record] is called when experiment enrollments are evolved. It should apply the + * [RecordedNimbusContext]'s values to a [NimbusSystem.RecordedNimbusContextObject] instance, + * and use that instance to record the values to Glean. + */ + func record() { + logger.log("record start", level: .debug, category: .experiments) + + // Bring the ping into scope so that Glean knows it exists and includes NimbusSystem.recordedNimbusContext + _ = NimbusGleanPings.nimbusTargetingContext + + let eventQueryValuesObject = GleanMetrics.NimbusSystem.RecordedNimbusContextObjectItemEventQueryValuesObject( + daysOpenedInLast28: eventQueryValues[RecordedNimbusContext.DAYS_OPENED_IN_LAST_28].toInt64() + ) + + GleanMetrics.NimbusSystem.recordedNimbusContext.set( + GleanMetrics.NimbusSystem.RecordedNimbusContextObject( + isFirstRun: isFirstRun, + eventQueryValues: eventQueryValuesObject, + isPhone: isPhone, + appVersion: appVersion, + locale: locale, + daysSinceInstall: daysSinceInstall.toInt64(), + daysSinceUpdate: daysSinceUpdate.toInt64(), + language: language, + region: region, + isDefaultBrowser: isDefaultBrowser, + isBottomToolbarUser: isBottomToolbarUser, + hasEnabledTipsNotifications: hasEnabledTipsNotifications, + hasAcceptedTermsOfUse: hasAcceptedTermsOfUse, + userDisabledAi: userDisabledAi, + isAppleIntelligenceAvailable: isAppleIntelligenceAvailable, + cannotUseAppleIntelligence: cannotUseAppleIntelligence, + touExperiencePoints: touExperiencePoints.toInt64() + ) + ) + logger.log("record end", level: .debug, category: .experiments) + } + + /** + * [setEventQueryValues] is called by the Nimbus SDK Rust code after the event queries have been + * executed. The [eventQueryValues] should be written back to the Kotlin object. + * + * @param [eventQueryValues] The values for each query after they have been executed in the + * Nimbus SDK Rust environment. + */ + func setEventQueryValues(eventQueryValues: [String: Double]) { + logger.log("setEventQueryValues", level: .debug, category: .experiments) + self.eventQueryValues = eventQueryValues + } + + /** + * [toJson] is called by the Nimbus SDK Rust code after the event queries have been executed, + * and before experiment enrollments have been evolved. The value returned from this method + * will be applied directly to the Nimbus targeting context, and its keys/values take + * precedence over those in the main Nimbus targeting context. + * + * @return JsonObject + */ + func toJson() -> JsonObject { + logger.log("toJson start", level: .debug, category: .experiments) + guard let data = try? JSONSerialization.data(withJSONObject: [ + "is_first_run": isFirstRun, + "isFirstRun": "\(isFirstRun)", + "is_phone": isPhone, + "events": eventQueryValues, + "app_version": appVersion as Any, + "region": region as Any, + "language": language as Any, + "locale": locale as Any, + "days_since_install": daysSinceInstall as Any, + "days_since_update": daysSinceUpdate as Any, + "is_default_browser": isDefaultBrowser, + "is_bottom_toolbar_user": isBottomToolbarUser, + "has_enabled_tips_notifications": hasEnabledTipsNotifications, + "has_accepted_terms_of_use": hasAcceptedTermsOfUse, + "user_disabled_ai": userDisabledAi, + "is_apple_intelligence_available": isAppleIntelligenceAvailable, + "cannot_use_apple_intelligence": cannotUseAppleIntelligence, + "tou_experience_points": touExperiencePoints as Any + ]), + let jsonString = NSString(data: data, encoding: String.Encoding.utf8.rawValue) as? String + else { + logger.log("toJson error thrown while creating JSON string", level: .warning, category: .experiments) + return "{}" + } + logger.log("toJson end: \(jsonString)", level: .debug, category: .experiments) + return jsonString + } +} diff --git a/experimenter/experimenter/features/manifests/ios/v155.1.1/beta.fml.yaml b/experimenter/experimenter/features/manifests/ios/v155.1.1/beta.fml.yaml new file mode 100644 index 0000000000..edf08c9c2b --- /dev/null +++ b/experimenter/experimenter/features/manifests/ios/v155.1.1/beta.fml.yaml @@ -0,0 +1,1547 @@ +version: 1.0.0 +about: + description: The root level Feature Manifest for Firefox for iOS +channels: +- beta +features: + ad-blocker-feature: + description: | + The feature flag to manage the roll out of the Ad Blocker badge in the Site Menu and the corresponding Block Ads toggle in Browsing settings. + variables: + badge-enabled: + description: | + Whether or not the Ad Blocker badge is shown in the Site Menu + type: Boolean + default: true + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + address-autofill-edit: + description: This property defines if the address editing is enabled in Settings + variables: + status: + description: If true, we will allow user to edit the address + type: Boolean + default: false + address-bar-gesture-to-open-tab-tray-feature: + description: | + Decides if the address bar interactive gesture to open the tab tray is enabled + variables: + enabled_closetab: + description: | + Decides if the interactive gesture can close tabs by dragging the tab up to the top edge of the screen + type: Boolean + default: true + enabled_interactive: + description: | + Decides if the interactive (fancier) version of this feature is enabled. + type: Boolean + default: true + enabled_swipe: + description: | + Decides if the swipe version of this feature is enabled. This will override the interactive gesture + type: Boolean + default: false + ai-kill-switch-feature: + description: | + Configuration feature for AI features + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + background-audio-feature: + description: | + The feature flag to manage the roll out of background audio playback, allowing media to continue playing when the app is backgrounded. + variables: + default-on: + description: | + The default state of the user-facing toggle when no preference has been set. Independent of enabled, which only controls whether the feature is available. + type: Boolean + default: false + enabled: + description: | + Whether or not this feature is available + type: Boolean + default: false + bookmarks-search-feature: + description: | + Configuration feature for the bookmarks search bar + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + custom-reader-mode-scheme-feature: + description: | + Use a custom WKURLSchemeHandler for reader mode + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + deeplink-optimization-refactor-feature: + description: | + The feature flag to manage the rollout of deeplink optimization feature. + variables: + enabled: + description: | + Variable description + type: Boolean + default: true + download-live-activities-feature: + description: | + Download Live Activities Feature + variables: + enabled: + description: | + If true, the download live activities feature is enabled + type: Boolean + default: true + firefox-jp-guide-default-site: + description: | + This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + firefox-suggest-feature: + description: Configuration for the Firefox Suggest feature. + variables: + available-suggestions-types: + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + type: Map + default: + amp: true + ampMobile: false + wikipedia: true + status: + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. + type: Boolean + default: false + google-lens-feature: + description: | + The feature flag to manage the rollout of Google Lens entry points. + variables: + enabled: + description: | + Enables Google Lens entry points. + type: Boolean + default: false + homepage-redesign-feature: + description: | + This feature is for managing the roll out of the Homepage New Tab Redesign feature. + variables: + add-shortcut-tile: + description: | + If true, enables the add shortcut tile on homepage. + type: Boolean + default: false + bookmarks-section-default: + description: | + If true, enables the bookmarks homepage section by default + type: Boolean + default: false + categories-enabled: + description: | + If true, enables the categories flow in the stories + type: Boolean + default: false + jbi-section-default: + description: | + If true, enables the jump back in homepage section by default + type: Boolean + default: false + pinned-header-enabled: + description: | + If true, enables the pinned newsfeed header on homepage. + type: Boolean + default: false + search-bar: + description: | + If true, enables the search bar feature on homepage for users. + type: Boolean + default: false + homepage-tracker-blocker-module-feature: + description: | + Controls the Tracker Blocker module feature + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + hosted-summarizer-feature: + description: | + This feature enables the hosted summarizer feature. + variables: + enabled: + description: | + Enables the hosted summarizer feature. + type: Boolean + default: true + shakeGesture: + description: | + Enables the shake gesture for the summarizer feature. + type: Boolean + default: true + toolbarEntrypoint: + description: | + Enables the toolbar entrypoint for the summarizer feature. + type: Boolean + default: true + https-upgrade-feature: + description: | + This feature enables automatic https upgrade. This is only available for 18.2+. + variables: + enabled: + description: | + Enables automatic https upgrade. + type: Boolean + default: true + improved-app-store-review-trigger-feature: + description: | + The feature flag to manage the App Store review request trigger. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + messaging: + description: | + The in-app messaging system + documentation: + - name: User documentation + url: https://experimenter.info/messaging/mobile-messaging + contacts: + - jhugman@mozilla.com + - brennie@mozilla.com + - gbuciu@mozilla.com + - wteichmann@mozilla.com + events: + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_shown + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_clicked + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_expired + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_dismissed + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_malformed + variables: + actions: + description: A growable map of action URLs. + type: Map + default: + OPEN_SETTINGS: ://deep-link?url=settings/general + OPEN_SETTINGS_NEW_TAB: ://deep-link?url=settings/newtab + OPEN_SETTINGS_HOMESCREEN: ://deep-link?url=settings/homepage + OPEN_SETTINGS_WALLPAPERS: ://deep-link?url=settings/wallpaper + OPEN_SETTINGS_EMAIL: ://deep-link?url=settings/mailto + OPEN_SETTINGS_SEARCH_ENGINE: ://deep-link?url=settings/search + OPEN_SETTINGS_PRIVACY: ://deep-link?url=settings/clear-private-data + OPEN_SETTINGS_FXA: ://deep-link?url=settings/fxa + OPEN_SETTINGS_THEME: ://deep-link?url=settings/theme + OPEN_SETTINGS_APP_ICON: ://deep-link?url=settings/app-icon + OPEN_URL: ://open-url + VIEW_BOOKMARKS: ://deep-link?url=homepanel/bookmarks + VIEW_TOP_SITES: ://deep-link?url=homepanel/top-sites + VIEW_READING_LIST: ://deep-link?url=homepanel/reading-list + VIEW_HISTORY: ://deep-link?url=homepanel/history + VIEW_DOWNLOADS: ://deep-link?url=homepanel/downloads + ENABLE_PRIVATE_BROWSING: ://deep-link?url=homepanel/new-private-tab + OPEN_NEW_TAB: ://deep-link?url=homepanel/new-tab + MAKE_DEFAULT_BROWSER: ://deep-link?url=default-browser/system-settings + MAKE_DEFAULT_BROWSER_WITH_TUTORIAL: ://deep-link?url=default-browser/tutorial + OPEN_SHARE_SHEET: ://share-sheet + string-alias: ActionName + message-under-experiment: + description: 'Deprecated. Please use "experiment": "{experiment}" instead.' + type: Option + default: null + messages: + description: | + A growable collection of messages, where the Key is the message identifier and the value is its associated MessageData. + type: Map + default: + homepage-microsurvey-message: + surface: microsurvey + style: MICROSURVEY + trigger-if-all: + - SECOND_HOMEPAGE_VIEW + title: Microsurvey/Microsurvey.Prompt.TitleLabel.v127 + text: How satisfied are you with your Firefox homepage? + button-label: Microsurvey/Microsurvey.Prompt.Button.v127 + should-randomize-options: false + microsurveyConfig: + utm-content: homepage + icon: homeLarge + options: + - Microsurvey/Microsurvey.Survey.Options.VerySatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.Satisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.Neutral.v132 + - Microsurvey/Microsurvey.Survey.Options.Dissatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.VeryDissatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.NotApplicable.v132 + string-alias: MessageKey + on-control: + description: What should be displayed when a control message is selected. + type: ControlMessageBehavior + default: show-next-message + styles: + description: | + A map of styles to configure message appearance. + type: Map + default: + FALLBACK: + priority: 40 + max-display-count: 20 + DEFAULT: + priority: 50 + max-display-count: 5 + MICROSURVEY: + priority: 50 + max-display-count: 1 + NOTIFICATION: + priority: 50 + max-display-count: 1 + PERSISTENT: + priority: 50 + max-display-count: 20 + SURVEY: + priority: 55 + max-display-count: 10 + WARNING: + priority: 60 + max-display-count: 10 + URGENT: + priority: 100 + max-display-count: 10 + string-alias: StyleName + triggers: + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + USER_RECENTLY_INSTALLED: days_since_install < 7 + USER_RECENTLY_UPDATED: days_since_update < 7 && days_since_install != days_since_update + USER_TIER_ONE_COUNTRY: ('US' in locale || 'GB' in locale || 'CA' in locale || 'DE' in locale || 'FR' in locale) + USER_EN_SPEAKER: '''en'' in locale' + USER_ES_SPEAKER: '''es'' in locale' + USER_DE_SPEAKER: '''de'' in locale' + USER_FR_SPEAKER: '''fr'' in locale' + DEVICE_ANDROID: os == 'Android' + DEVICE_IOS: os == 'iOS' + DAY_1_AFTER_INSTALL: days_since_install == 1 + DAY_2_AFTER_INSTALL: days_since_install == 2 + DAY_3_AFTER_INSTALL: days_since_install == 3 + DAY_4_AFTER_INSTALL: days_since_install == 4 + DAY_5_AFTER_INSTALL: days_since_install == 5 + MORE_THAN_24H_SINCE_INSTALLED_OR_UPDATED: days_since_update >= 1 + NOT_LAUNCHED_YESTERDAY: '''app_cycle.foreground''|eventLastSeen(''Days'', 1) > 1' + AFTER_THREE_LAUNCHES_THIS_WEEK: '''app_cycle.foreground''|eventSum(''Weeks'', 1, 0) >= 3' + I_AM_DEFAULT_BROWSER: is_default_browser + I_AM_NOT_DEFAULT_BROWSER: is_default_browser == false + SUPPORTS_DEFAULT_BROWSER: os_version|versionCompare('14.!') >= 0 + INACTIVE_NEW_USER: is_inactive_new_user + ALLOWED_TIPS_NOTIFICATIONS: allowed_tips_notifications + FXA_CURRENTLY_SIGNED_IN: is_fxa_signed_in == true + SECOND_HOMEPAGE_VIEW: '''homepage_viewed''|eventSum(''Years'', 4, 0) >= 2' + ON_FOURTH_LAUNCH_THIS_YEAR: '''app_cycle.foreground''|eventSum(''Years'', 1, 0) > 3' + string-alias: TriggerName + ~~experiment: + description: Not to be set by experiment. + type: ExperimentSlug + default: '{experiment}' + string-alias: ExperimentSlug + allow-coenrollment: true + microsurvey-feature: + description: | + A feature that shows the microsurvey for users to interact with and submit responses. + variables: + enabled: + description: | + If true, the feature is active. + type: Boolean + default: false + native-error-page-feature: + description: | + This feature is for managing the roll out of the native error page feature + variables: + bad-cert-domain-error-page: + description: | + This feature is for managing the roll out of the bad certificate domain native error page + type: Boolean + default: false + enabled: + description: | + If true, the feature is active. + type: Boolean + default: false + no_internet_connection_error: + description: | + This feature is for managing the roll out of the no interet connection native error page feature + type: Boolean + default: false + new-bookmark-folder-tree-feature: + description: | + This property determines weather we show the new bookmark folder tree UI + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + nova-design-feature: + description: | + The feature flag to manage the rollout of Nova design. + variables: + enabled: + description: | + Enables Nova design. + type: Boolean + default: false + onboarding-framework-feature: + description: | + The new onboarding framework feature that will allow onboarding to be experimentable through initial experiments. + variables: + cards: + description: | + The list of available cards for onboarding. + type: Map + default: + welcome-modern: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.Welcome.Title.v140 + body: Onboarding/Onboarding.Modern.Welcome.Description.v140 + image: trackers + buttons: + primary: + title: Onboarding/Onboarding.Modern.Welcome.ActionTreatementA.v140 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.Welcome.Skip.v140 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + sign-to-sync-modern: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.Sync.Title.v140 + body: Onboarding/Onboarding.Modern.Sync.Description.v140 + image: sync-with-icons + buttons: + primary: + title: Onboarding/Onboarding.Modern.Sync.SignIn.Action.v140 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.Sync.Skip.Action.v140 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-toolbar-modern: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Title.v140 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v140 + image: toolbar-bottom + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v140 + image: toolbar-top + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-theme-modern: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Customization.Theme.Title.v143 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Theme.System.Action.v123 + image: theme-system + action: theme-system-default + - title: Onboarding/Onboarding.Customization.Theme.Light.Action.v123 + image: theme-light + action: theme-light + - title: Onboarding/Onboarding.Customization.Theme.Dark.Action.v123 + image: theme-dark + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + welcome-modern-japan: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.Welcome.Title.v145 + body: Onboarding/Onboarding.Modern.Welcome.Description.v145 + image: trackers-japan + buttons: + primary: + title: Onboarding/Onboarding.Modern.Welcome.ActionTreatmentA.v145 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.Welcome.Skip.v145 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + sign-to-sync-modern-japan: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.Sync.Title.v145 + body: Onboarding/Onboarding.Modern.Sync.Description.v145 + image: sync-with-icons-japan + buttons: + primary: + title: Onboarding/Onboarding.Modern.Sync.SignIn.Action.v145 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.Sync.Skip.Action.v145 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + customization-toolbar-modern-japan: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Title.v145 + body: Onboarding/Onboarding.Modern.Customization.Toolbar.Description.v145 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Continue.Action.v145 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v145 + image: toolbar-bottom-japan + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v145 + image: toolbar-top-japan + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + customization-theme-modern-japan: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Modern.Customization.Theme.Title.v145 + body: Onboarding/Onboarding.Modern.Customization.Theme.Description.v145 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Continue.Action.v145 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Theme.Automatic.v145 + image: theme-system-japan + action: theme-system-default + - title: Onboarding/Onboarding.Modern.Customization.Theme.Light.v145 + image: theme-light-japan + action: theme-light + - title: Onboarding/Onboarding.Modern.Customization.Theme.Dark.v145 + image: theme-dark-japan + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + welcome-brand-refresh: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.TitleV3.v149 + body: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.Description.v148 + image: trackers-brand-refresh + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.ActionTreatmentA.v148 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.Skip.v148 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + customization-toolbar-brand-refresh: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Toolbar.Title.v148 + body: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Toolbar.Description.v148 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Toolbar.Continue.Action.v148 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v140 + image: toolbar-bottom-japan + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v140 + image: toolbar-top-japan + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + customization-theme-brand-refresh: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Title.v148 + body: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Description.v148 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Continue.Action.v148 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Automatic.v148 + image: theme-system-japan + action: theme-system-default + - title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Light.v148 + image: theme-light-japan + action: theme-light + - title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Dark.v148 + image: theme-dark-japan + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + sign-to-sync-brand-refresh: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.BrandRefresh.Sync.Title.v148 + body: Onboarding/Onboarding.Modern.BrandRefresh.Sync.Description.v148 + image: sync-with-icons-brand-refresh + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Sync.SignIn.Action.v148 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Sync.Skip.Action.v148 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + string-alias: NimbusOnboardingCardKey + conditions: + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + string-alias: ConditionName + dismissable: + description: | + Whether or not the entire onboarding is dismissable by pressing an X at the top right corner of the screen. + type: Boolean + default: true + enable-modern-ui: + description: | + Toggle between legacy (false) and modern (true) UI variants. + type: Boolean + default: true + enable-video-intro: + description: | + When true, a full-screen video is displayed before the Terms of Service screen during fresh-install onboarding. + type: Boolean + default: false + should-use-brand-refresh-configuration: + description: | + Toggle between standard (false) and brand refresh (true) onboarding content. + type: Boolean + default: true + should-use-japan-configuration: + description: | + Toggle between standard (false) and Japan-specific (true) assets and content. + type: Boolean + default: false + privacy-dashboard-feature: + description: | + The Privacy Dashboard feature from homepage + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + quick-answers-feature: + description: | + The feature flag to manage the roll out of the quick answers feature. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + model: + description: | + Which provider model backs Quick Answers. + type: QuickAnswersModel + default: exa + recent-searches-feature: + description: | + Enables recent searches. + variables: + enabled: + description: | + Whether or not to enable recent searches. + type: Boolean + default: false + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 5 + relay-integration-feature: + description: | + This feature is for managing the roll out of Relay email masking integration in iOS + variables: + enabled: + description: | + Enables the feature + type: Boolean + default: true + report-broken-site-feature: + description: | + In-app Report Broken Site (WebCompat) reporter + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + search: + description: | + Configuring the functionality to do with search. This will be separated into smaller sub-features in later releases. + variables: + awesome-bar: + description: Configuring the awesome bar. + type: AwesomeBar + default: + min-search-term: 3 + search-highlights: false + use-page-content: false + sent-from-firefox-feature: + description: | + Adds additional promo text to links shared to WhatsApp. + variables: + enabled: + description: | + Controls whether promo text is added to WhatsApp shares and an on/off toggle is added to Settings. + type: Boolean + default: false + isTreatmentA: + description: | + If true, shares the treatment A text. If false, shares the treatment B text. + type: Boolean + default: true + spotlight-search: + description: Add pages as items findable with Spotlight. + variables: + enabled: + description: If this is true, then on each page load adds a new item to Spotlight. + type: Boolean + default: false + icon-type: + description: | + The icon that is displayed next to the item in the search results. If this is `null`, then no icon is displayed. + type: Option + default: letter + keep-for-days: + description: | + Number of days to keep the item before automatic deletion. If this is left `null`, then it is left to iOS's default. + type: Option + default: null + searchable-content: + description: | + The text content that is made searchable. If this is `null` then no additional content is used, and only the title and URL will be used. + type: Option + default: text-excerpt + start-at-home-feature: + description: This feature is for experimenting with opening screen + variables: + setting: + description: This property provides a default setting for the start at home feature + type: StartAtHome + default: afterFourHours + summarizer-app-attest-auth-feature: + description: | + This feature enables app attest authentication for the summarizer. + variables: + enabled: + description: | + Enables app attest authentication for the summarizer. + type: Boolean + default: true + summarizer-language-expansion-feature: + description: | + The feature flag to manage the rollout of the summarizer language expansion. + variables: + enabled: + description: | + Whether the feature is enabled or not. + type: Boolean + default: true + supportedLocales: + description: | + The list of supported locale identifiers for the summarizer language expansion according to BCP47 standard. i.e "en-US" for English (United States). + type: List + default: + - en + - it + - fr + - es + - de + - pt + - ja + - jp + summarizer-permissive-guardrails-feature: + description: | + This feature enables permissive guardrails for the summarizer. + variables: + enabled: + description: | + Enables permissive guardrails for the summarizer. + type: Boolean + default: true + tab-scroll-refactor-feature: + description: | + The feature flag to manage the rollout of tab scroll refactor feature. + variables: + enabled: + description: | + If true, tab scroll new implementation is used to show and hide toolbar views reacting to user scroll + type: Boolean + default: false + tab-tray-ui-experiments: + description: | + The tab tray will undergo some UI experimentation to test potential improvements. + variables: + enabled: + description: | + If true, enables the tab tray UI experiments. + type: Boolean + default: true + iPad_update_enabled: + description: | + If true, enables the tab tray UI experiments on iPad. + type: Boolean + default: false + translucency: + description: | + If true, enables translucency for tab tray actions at the bottom. + type: Boolean + default: false + toolbar-refactor-feature: + description: | + This feature is for managing the roll out of the Toolbar refactor feature + variables: + layout: + description: | + The type of layout of the toolbars. + type: Option + default: version1 + tab_tray_button_type: + description: | + The style of the tab tray button in the toolbar. + type: TabTrayButtonType + default: number + unified_search: + description: | + Enables the unified search feature. + type: Boolean + default: false + tos-feature: + description: | + This feature is for managing the roll out of the ToS (Term of Service) implementation + variables: + status: + description: | + Enables the feature + type: Boolean + default: true + tou-feature: + description: | + This feature is for managing the rollout of the Terms of Use (ToU) implementation. + variables: + content-option: + description: | + Determines which predefined title and "learn more" strings are used for the Terms of Use prompt. + type: TermsOfUsePromptContentOption + default: value-0 + enable-drag-to-dismiss: + description: | + Whether to show a drag handle on the prompt and allows users to use it to dismiss the prompt. + type: Boolean + default: true + max-reminders-count: + description: | + Maximum number of ToU bottom sheet reminders that can be displayed + type: Int + default: 2 + status: + description: | + Enables the feature + type: Boolean + default: false + translations-feature: + description: | + Enables translations feature. + variables: + enabled: + description: | + Whether or not to enable translations feature. + type: Boolean + default: true + languagePickerEnabled: + description: | + Whether or not to enable the translations language picker (Phase 2). + type: Boolean + default: true + trending-searches-feature: + description: | + Enables trending searches. + variables: + enabled: + description: | + Whether or not to enable trending searches. + type: Boolean + default: false + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 5 + vpn-feature: + description: | + Configuration feature for VPN + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + wayback-machine-feature: + description: | + This property determines whether we show the wayback entry point on the native error pages + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + web-view-document-fetch-refactor-feature: + description: | + Determines whether we read PDF and document data for sharing directly from the authenticated WebView, rather than re-downloading via URLSession. + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false +enums: + ControlMessageBehavior: + description: An enum to influence what should be displayed when a control message is selected. + variants: + show-next-message: + description: The next eligible message should be shown. + show-none: + description: The surface should show no message. + IconType: + description: The icon that will be added to the item in the device's search engine. + variants: + favicon: + description: The favicon of the page + letter: + description: An icon generated from the first letter of the base domain. + screenshot: + description: A screenshot of the page at load time. + MessageSurfaceId: + description: | + For messaging, we would like to have a message tell us which surface its associated with. This is a label that matches across both Android and iOS. + variants: + Unknown: + description: A message has NOT declared its target surface. + microsurvey: + description: This is a microsurvey that appears on top of the bottom toolbar to the user. + new-tab-card: + description: This is the card that appears at the top on the Firefox Home Page. + notification: + description: This is a local notification send to the user periodically with tips and updates. + survey: + description: This is a full-page that appears providing a survey to the user. + NimbusOnboardingHeaderImage: + description: | + The identifiers for the different images available for cards in onboarding + variants: + customize-firefox: + description: | + Corresponding to the fox window image + notifications: + description: | + Corresponding to the notifications image + notifications-ctd: + description: | + Corresponding to the notifications image for CTD + search-widget: + description: | + Corresponding to the fox search widget image + set-default-steps: + description: | + Corresponding to the set to default steps image + set-to-dock: + description: | + Corresponding to the set to dock image + sync-devices: + description: | + Corresponding to the sync-devices image + sync-devices-ctd: + description: | + Corresponding to the sync image for CTD + sync-with-icons: + description: | + Corresponding to the sync-devices image + sync-with-icons-brand-refresh: + description: | + Corresponding to the sync-with-icons image for Brand Refresh variant (different from Japan variant) + sync-with-icons-japan: + description: | + Corresponding to the sync-with-icons image for Japan variant + themeing: + description: | + Corresponding to the fox world image + toolbar: + description: | + Corresponding to the fox world image + trackers: + description: | + Corresponding to the trackers image + trackers-brand-refresh: + description: | + Corresponding to the trackers image for Brand Refresh variant (does not contain Japanese text, different from Japan variant) + trackers-japan: + description: | + Corresponding to the trackers image for Japan variant (contains Japanese text) + welcome-ctd: + description: | + Corresponding to the welcome image for CTD + welcome-globe: + description: | + Corresponding to the fox world image + NimbusOnboardingMultipleChoiceButtonImage: + description: | + The identifiers for the different images available for multiple choice buttons in onboarding + variants: + theme-dark: + description: | + Corresponding to the dark theme + theme-dark-japan: + description: | + Corresponding to the dark theme image for Japan variant. Also used by Brand Refresh variant as the images are identical. + theme-light: + description: | + Corresponding to the light theme + theme-light-japan: + description: | + Corresponding to the light theme image for Japan variant. Also used by Brand Refresh variant as the images are identical. + theme-system: + description: | + Corresponding to the system theme + theme-system-japan: + description: | + Corresponding to the system theme image for Japan variant. Also used by Brand Refresh variant as the images are identical. + toolbar-bottom: + description: | + Corresponding to the toolbar on the bottom + toolbar-bottom-japan: + description: | + Corresponding to the toolbar on the bottom image for Japan variant. Also used by Brand Refresh variant as the images are identical. + toolbar-top: + description: | + Corresponding to the toolbar on top + toolbar-top-japan: + description: | + Corresponding to the toolbar on top image for Japan variant. Also used by Brand Refresh variant as the images are identical. + OnboardingActions: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + end-onboarding: + description: | + Will end the onboarding on a set card + forward-one-card: + description: | + Will take the user to the next card + forward-three-card: + description: | + Will take the user to the next card + forward-two-card: + description: | + Will take the user to the next card + open-instructions-popup: + description: | + Will open up a popup with instructions for something + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + read-privacy-policy: + description: | + Will open a webview where the user can read the privacy policy + request-notifications: + description: | + Will request to allow notifications from the user + set-default-browser: + description: | + Will send the user to settings to set Firefox as their default browser and advance to next card + sync-sign-in: + description: | + Will take the user to the sync sign in flow + OnboardingCardType: + description: | + The identifiers for the different types of onboarding cards. + variants: + basic: + description: | + Corresponding to basic info onboarding cards + multiple-choice: + description: | + Corresponding to onboarding cards with multiple choice buttons + OnboardingInstructionsPopupActions: + description: | + The identifiers for the different actions available for the instruction card in onboarding + variants: + dismiss: + description: | + Will dismiss the popup + dismiss-and-next-card: + description: | + Will dismiss the popup and move to the next card + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + OnboardingMultipleChoiceAction: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + theme-dark: + description: | + Will will set the theme to dark mode + theme-light: + description: | + Will set the theme to light mode + theme-system-default: + description: | + Will set the theme to use the system theme + toolbar-bottom: + description: | + Will set the toolbar on the bottom + toolbar-top: + description: | + Will set the toolbar on the top + OnboardingType: + description: | + The identifiers for the different types of onboarding cards. + variants: + fresh-install: + description: | + Corresponding to onboarding cards that are for new users + OnboardingVariant: + description: | + Which UI style this onboarding card is designed for. + variants: + brandRefresh: + description: Use the brand refresh onboarding UI with v148 strings. + japan: + description: Use the Japan-specific onboarding UI with localized assets. + modern: + description: Use the new (modern) onboarding UI. + PageContent: + description: The page content that will be added as an item in the device's search engine. + variants: + html-content: + description: Use all the page as HTML + text-content: + description: Use all the page as text + text-excerpt: + description: Only use the first paragraph + QuickAnswersModel: + description: The provider model that backs the Quick Answers feature. + variants: + exa: + description: The Exa model provider. + liner: + description: The Liner model provider. + StartAtHome: + description: The option for what screen to open the app to + variants: + afterFourHours: + description: Starts the app at the homepage after four hours of inactivity, otherwise starts the app at the most recently viewed tab. + always: + description: Starts the app at the homepage. + disabled: + description: Starts the app at the most recently viewed tab. + SuggestionType: + description: The type of a Firefox Suggest search suggestion. + variants: + amp: + description: A Firefox Suggestion for desktop from adMarketplace. + ampMobile: + description: A Firefox Suggestion specifically for mobile from adMarketplace. + wikipedia: + description: A Firefox Suggestion for a Wikipedia page. + TabTrayButtonType: + description: The style of the tab tray button in the toolbar. + variants: + number: + description: The original tab tray button style that show the icon with the number of tabs. + screenshot: + description: The new tab tray button style that shows two images stacked with the previous and next tab. + TermsOfUsePromptContentOption: + description: | + Determines which predefined title and "learn more" strings are used for the Terms of Use prompt. + variants: + value-0: + description: | + Uses the current defaults: + - Title: "We've got an update" + - Learn more: "Please take a moment to review and accept. Learn more." + value-1: + description: | + Uses the following copy: + - Title: "Terms of Use" + - Learn more: "You can learn more here." + value-2: + description: | + Uses the following copy: + - Title: "A note from Firefox" + - Learn more: "You can learn more here." + ToolbarLayoutType: + description: The type of toolbar layout. + variants: + version1: + description: Shows the add new tab, menu and tabs button in the navigation toolbar. The share button is displayed in the address toolbar. + version2: + description: Like version1 but the menu and tabs buttons are inverted. +objects: + AwesomeBar: + description: A configuration option for the awesome bar. Part of the `search` feature. + fields: + min-search-term: + description: The minimum number of characters that the user types before searching in the page. + type: Int + default: 3 + search-highlights: + description: Whether or not search highlights are enabled + type: Boolean + default: false + use-page-content: + description: Search in the open tab's text content when typing. + type: Boolean + default: false + MessageData: + description: | + An object to describe a message. It uses human readable strings to describe the triggers, action and style of the message as well as the text of the message and call to action. + fields: + action: + description: | + The name of a deeplink URL to be opened if the button is clicked. + type: Option + default: null + action-params: + description: Query parameters appended to the deeplink action URL + type: Map + default: {} + button-label: + description: | + The text on the button. If no text is present, the whole message is clickable. + type: Option + default: null + except-if-any: + description: | + A list of strings corresponding to targeting expressions. If any of these expressions evaluate to `true`, the message will not be eligible. + type: List + default: [] + experiment: + description: The experiment slug that this message is involved in. + type: Option + default: null + is-control: + description: Indicates if this message is the control message, if true shouldn't be displayed + type: Boolean + default: false + microsurveyConfig: + description: Optional configuration data for a microsurvey. + type: Option + default: null + should-randomize-options: + description: | + Will randomize the provided MicrosurveyConfig options + type: Boolean + default: false + style: + description: | + The style as described in a `StyleData` from the styles table. + type: StyleName + default: DEFAULT + surface: + description: Each message will tell us the surface it is targeting with this. + type: MessageSurfaceId + default: Unknown + text: + description: The message text displayed to the user + type: Text + default: '' + title: + description: The title text displayed to the user + type: Option + default: null + trigger-if-all: + description: | + A list of strings corresponding to targeting expressions. All named expressions must evaluate to true if the message is to be eligible to be shown. + type: List + default: + - ALWAYS + MicrosurveyConfig: + description: | + Attributes relating to microsurvey messaging. + fields: + icon: + description: The asset name in our bundle used as the icon shown in the survey. + type: Image + default: lightbulbLarge + options: + description: The list of survey options to present to the user. + type: List + default: [] + utm-content: + description: The name used to provide as the utm_content parameter for the privacy notice. + type: Option + default: null + NimbusOnboardingButton: + description: | + A group of properties describing the attributes of a card. + fields: + action: + description: | + The action the button should take. The default for this will be "forward-one-card" + type: OnboardingActions + default: forward-one-card + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingButtons: + description: | + A set of buttons for the card. There can be up to two, but there must be at least one. + fields: + primary: + description: | + The primary button for the card. This must exist. + type: NimbusOnboardingButton + default: + title: Primary Button + action: forward-one-card + secondary: + description: | + A secondary, optional, button for the card. + type: Option + default: null + NimbusOnboardingCardData: + description: | + A group of properties describing the attributes of a card. + fields: + body: + description: | + The body text displayed on the card, in less prominent text. This should never be defaulted. + type: Text + default: '' + buttons: + description: | + The set of buttons associated with the card. + type: NimbusOnboardingButtons + default: + primary: + title: Onboarding/Onboarding.Sync.Skip.Action.v114 + action: forward-one-card + secondary: null + card-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingCardType + default: basic + disqualifiers: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will not be shown if any expression is `true`. + type: List + default: [] + image: + description: | + The image that should be displayed on the card. + type: NimbusOnboardingHeaderImage + default: welcome-globe + instructions-popup: + description: | + The object describing the specific instruction popup button for a card. If left empty, the card will have no instruction popup information + type: Option + default: null + link: + description: | + The object describing the link button for a card. If left empty, the card will have no link. + type: Option + default: null + multiple-choice-buttons: + description: | + A list of multiple choice buttons that the card will display + type: List + default: [] + onboarding-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingType + default: fresh-install + order: + description: | + The place in the order where the card will be found. The feature layer will then sort the cards based on this field. + type: Int + default: 10 + prerequisites: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will be shown if all expressions `true` and if no expressions in the `disqualifiers` table are true, or if the `disqualifiers` table is empty. + type: List + default: [] + title: + description: | + The title displayed on the card, in prominent, bolded text. This should never be defaulted. + type: Text + default: '' + uiVariant: + description: | + If set, this card will only be shown in the specified UI variant. If null, it will appear in both legacy and modern UIs. + type: Option + default: null + NimbusOnboardingInstructionPopup: + description: | + The object outlining the content of the instruction card. + fields: + button-action: + description: | + The action the button should have. Default is `dismiss-and-next-card` + type: OnboardingInstructionsPopupActions + default: dismiss-and-next-card + button-title: + description: | + The title the button should have. This should never be defaulted. + type: Text + default: '' + instructions: + description: | + A list of instructions, either as free text, or as Text identifiers. + type: List + default: [] + title: + description: | + The text of the popup. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingLink: + description: | + A group of properties describing the attributes for the active link on a card + fields: + title: + description: | + The text of the link title. + type: Text + default: Onboarding/Onboarding.Welcome.Link.Action.v114 + url: + description: | + The url that the link will lead to. + type: String + default: https://www.mozilla.org/privacy/firefox/ + NimbusOnboardingMultipleChoiceButton: + description: | + A group of properties describing the attributes of a multiple choice button on a card + fields: + action: + description: | + The action the button should take. The default for this will be "theme-system-default" + type: OnboardingMultipleChoiceAction + default: theme-system-default + image: + description: | + The text of the button title. This should never be defaulted. + type: NimbusOnboardingMultipleChoiceButtonImage + default: theme-system + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + StyleData: + description: | + A group of properties (predominantly visual) to the describe style of the message. + fields: + max-display-count: + description: | + How many sessions will this message be shown to the user before it is expired. + type: Int + default: 5 + priority: + description: | + The importance of this message. 0 is not very important, 100 is very important. + type: Int + default: 50 diff --git a/experimenter/experimenter/features/manifests/ios/v155.1.1/developer.fml.yaml b/experimenter/experimenter/features/manifests/ios/v155.1.1/developer.fml.yaml new file mode 100644 index 0000000000..dd951a99a1 --- /dev/null +++ b/experimenter/experimenter/features/manifests/ios/v155.1.1/developer.fml.yaml @@ -0,0 +1,1558 @@ +version: 1.0.0 +about: + description: The root level Feature Manifest for Firefox for iOS +channels: +- developer +features: + ad-blocker-feature: + description: | + The feature flag to manage the roll out of the Ad Blocker badge in the Site Menu and the corresponding Block Ads toggle in Browsing settings. + variables: + badge-enabled: + description: | + Whether or not the Ad Blocker badge is shown in the Site Menu + type: Boolean + default: true + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + address-autofill-edit: + description: This property defines if the address editing is enabled in Settings + variables: + status: + description: If true, we will allow user to edit the address + type: Boolean + default: true + address-bar-gesture-to-open-tab-tray-feature: + description: | + Decides if the address bar interactive gesture to open the tab tray is enabled + variables: + enabled_closetab: + description: | + Decides if the interactive gesture can close tabs by dragging the tab up to the top edge of the screen + type: Boolean + default: true + enabled_interactive: + description: | + Decides if the interactive (fancier) version of this feature is enabled. + type: Boolean + default: true + enabled_swipe: + description: | + Decides if the swipe version of this feature is enabled. This will override the interactive gesture + type: Boolean + default: false + ai-kill-switch-feature: + description: | + Configuration feature for AI features + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + background-audio-feature: + description: | + The feature flag to manage the roll out of background audio playback, allowing media to continue playing when the app is backgrounded. + variables: + default-on: + description: | + The default state of the user-facing toggle when no preference has been set. Independent of enabled, which only controls whether the feature is available. + type: Boolean + default: false + enabled: + description: | + Whether or not this feature is available + type: Boolean + default: true + bookmarks-search-feature: + description: | + Configuration feature for the bookmarks search bar + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + custom-reader-mode-scheme-feature: + description: | + Use a custom WKURLSchemeHandler for reader mode + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + deeplink-optimization-refactor-feature: + description: | + The feature flag to manage the rollout of deeplink optimization feature. + variables: + enabled: + description: | + Variable description + type: Boolean + default: true + download-live-activities-feature: + description: | + Download Live Activities Feature + variables: + enabled: + description: | + If true, the download live activities feature is enabled + type: Boolean + default: true + firefox-jp-guide-default-site: + description: | + This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: true + firefox-suggest-feature: + description: Configuration for the Firefox Suggest feature. + variables: + available-suggestions-types: + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + type: Map + default: + amp: true + ampMobile: false + wikipedia: true + status: + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. + type: Boolean + default: true + google-lens-feature: + description: | + The feature flag to manage the rollout of Google Lens entry points. + variables: + enabled: + description: | + Enables Google Lens entry points. + type: Boolean + default: true + homepage-redesign-feature: + description: | + This feature is for managing the roll out of the Homepage New Tab Redesign feature. + variables: + add-shortcut-tile: + description: | + If true, enables the add shortcut tile on homepage. + type: Boolean + default: false + bookmarks-section-default: + description: | + If true, enables the bookmarks homepage section by default + type: Boolean + default: false + categories-enabled: + description: | + If true, enables the categories flow in the stories + type: Boolean + default: true + jbi-section-default: + description: | + If true, enables the jump back in homepage section by default + type: Boolean + default: false + pinned-header-enabled: + description: | + If true, enables the pinned newsfeed header on homepage. + type: Boolean + default: true + search-bar: + description: | + If true, enables the search bar feature on homepage for users. + type: Boolean + default: false + homepage-tracker-blocker-module-feature: + description: | + Controls the Tracker Blocker module feature + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + hosted-summarizer-feature: + description: | + This feature enables the hosted summarizer feature. + variables: + enabled: + description: | + Enables the hosted summarizer feature. + type: Boolean + default: true + shakeGesture: + description: | + Enables the shake gesture for the summarizer feature. + type: Boolean + default: true + toolbarEntrypoint: + description: | + Enables the toolbar entrypoint for the summarizer feature. + type: Boolean + default: true + https-upgrade-feature: + description: | + This feature enables automatic https upgrade. This is only available for 18.2+. + variables: + enabled: + description: | + Enables automatic https upgrade. + type: Boolean + default: true + improved-app-store-review-trigger-feature: + description: | + The feature flag to manage the App Store review request trigger. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + messaging: + description: | + The in-app messaging system + documentation: + - name: User documentation + url: https://experimenter.info/messaging/mobile-messaging + contacts: + - jhugman@mozilla.com + - brennie@mozilla.com + - gbuciu@mozilla.com + - wteichmann@mozilla.com + events: + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_shown + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_clicked + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_expired + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_dismissed + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_malformed + variables: + actions: + description: A growable map of action URLs. + type: Map + default: + OPEN_SETTINGS: ://deep-link?url=settings/general + OPEN_SETTINGS_NEW_TAB: ://deep-link?url=settings/newtab + OPEN_SETTINGS_HOMESCREEN: ://deep-link?url=settings/homepage + OPEN_SETTINGS_WALLPAPERS: ://deep-link?url=settings/wallpaper + OPEN_SETTINGS_EMAIL: ://deep-link?url=settings/mailto + OPEN_SETTINGS_SEARCH_ENGINE: ://deep-link?url=settings/search + OPEN_SETTINGS_PRIVACY: ://deep-link?url=settings/clear-private-data + OPEN_SETTINGS_FXA: ://deep-link?url=settings/fxa + OPEN_SETTINGS_THEME: ://deep-link?url=settings/theme + OPEN_SETTINGS_APP_ICON: ://deep-link?url=settings/app-icon + OPEN_URL: ://open-url + VIEW_BOOKMARKS: ://deep-link?url=homepanel/bookmarks + VIEW_TOP_SITES: ://deep-link?url=homepanel/top-sites + VIEW_READING_LIST: ://deep-link?url=homepanel/reading-list + VIEW_HISTORY: ://deep-link?url=homepanel/history + VIEW_DOWNLOADS: ://deep-link?url=homepanel/downloads + ENABLE_PRIVATE_BROWSING: ://deep-link?url=homepanel/new-private-tab + OPEN_NEW_TAB: ://deep-link?url=homepanel/new-tab + MAKE_DEFAULT_BROWSER: ://deep-link?url=default-browser/system-settings + MAKE_DEFAULT_BROWSER_WITH_TUTORIAL: ://deep-link?url=default-browser/tutorial + OPEN_SHARE_SHEET: ://share-sheet + string-alias: ActionName + message-under-experiment: + description: 'Deprecated. Please use "experiment": "{experiment}" instead.' + type: Option + default: null + messages: + description: | + A growable collection of messages, where the Key is the message identifier and the value is its associated MessageData. + type: Map + default: + homepage-microsurvey-message: + surface: microsurvey + style: MICROSURVEY + trigger-if-all: + - SECOND_HOMEPAGE_VIEW + title: Microsurvey/Microsurvey.Prompt.TitleLabel.v127 + text: How satisfied are you with your Firefox homepage? + button-label: Microsurvey/Microsurvey.Prompt.Button.v127 + should-randomize-options: false + microsurveyConfig: + utm-content: homepage + icon: homeLarge + options: + - Microsurvey/Microsurvey.Survey.Options.VerySatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.Satisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.Neutral.v132 + - Microsurvey/Microsurvey.Survey.Options.Dissatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.VeryDissatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.NotApplicable.v132 + survey-surface-message: + surface: survey + style: SURVEY + trigger-if-all: + - NEVER + text: ResearchSurface/Body.Text.v112 + button-label: ResearchSurface/PrimaryButton.Label.v112 + should-randomize-options: false + action: OPEN_URL + action-params: + url: https://www.macrumors.com + string-alias: MessageKey + on-control: + description: What should be displayed when a control message is selected. + type: ControlMessageBehavior + default: show-next-message + styles: + description: | + A map of styles to configure message appearance. + type: Map + default: + FALLBACK: + priority: 40 + max-display-count: 20 + DEFAULT: + priority: 50 + max-display-count: 5 + MICROSURVEY: + priority: 50 + max-display-count: 1 + NOTIFICATION: + priority: 50 + max-display-count: 1 + PERSISTENT: + priority: 50 + max-display-count: 20 + SURVEY: + priority: 55 + max-display-count: 10 + WARNING: + priority: 60 + max-display-count: 10 + URGENT: + priority: 100 + max-display-count: 10 + string-alias: StyleName + triggers: + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + USER_RECENTLY_INSTALLED: days_since_install < 7 + USER_RECENTLY_UPDATED: days_since_update < 7 && days_since_install != days_since_update + USER_TIER_ONE_COUNTRY: ('US' in locale || 'GB' in locale || 'CA' in locale || 'DE' in locale || 'FR' in locale) + USER_EN_SPEAKER: '''en'' in locale' + USER_ES_SPEAKER: '''es'' in locale' + USER_DE_SPEAKER: '''de'' in locale' + USER_FR_SPEAKER: '''fr'' in locale' + DEVICE_ANDROID: os == 'Android' + DEVICE_IOS: os == 'iOS' + DAY_1_AFTER_INSTALL: days_since_install == 1 + DAY_2_AFTER_INSTALL: days_since_install == 2 + DAY_3_AFTER_INSTALL: days_since_install == 3 + DAY_4_AFTER_INSTALL: days_since_install == 4 + DAY_5_AFTER_INSTALL: days_since_install == 5 + MORE_THAN_24H_SINCE_INSTALLED_OR_UPDATED: days_since_update >= 1 + NOT_LAUNCHED_YESTERDAY: '''app_cycle.foreground''|eventLastSeen(''Days'', 1) > 1' + AFTER_THREE_LAUNCHES_THIS_WEEK: '''app_cycle.foreground''|eventSum(''Weeks'', 1, 0) >= 3' + I_AM_DEFAULT_BROWSER: is_default_browser + I_AM_NOT_DEFAULT_BROWSER: is_default_browser == false + SUPPORTS_DEFAULT_BROWSER: os_version|versionCompare('14.!') >= 0 + INACTIVE_NEW_USER: is_inactive_new_user + ALLOWED_TIPS_NOTIFICATIONS: allowed_tips_notifications + FXA_CURRENTLY_SIGNED_IN: is_fxa_signed_in == true + SECOND_HOMEPAGE_VIEW: '''homepage_viewed''|eventSum(''Years'', 4, 0) >= 2' + ON_FOURTH_LAUNCH_THIS_YEAR: '''app_cycle.foreground''|eventSum(''Years'', 1, 0) > 3' + string-alias: TriggerName + ~~experiment: + description: Not to be set by experiment. + type: ExperimentSlug + default: '{experiment}' + string-alias: ExperimentSlug + allow-coenrollment: true + microsurvey-feature: + description: | + A feature that shows the microsurvey for users to interact with and submit responses. + variables: + enabled: + description: | + If true, the feature is active. + type: Boolean + default: true + native-error-page-feature: + description: | + This feature is for managing the roll out of the native error page feature + variables: + bad-cert-domain-error-page: + description: | + This feature is for managing the roll out of the bad certificate domain native error page + type: Boolean + default: false + enabled: + description: | + If true, the feature is active. + type: Boolean + default: true + no_internet_connection_error: + description: | + This feature is for managing the roll out of the no interet connection native error page feature + type: Boolean + default: true + new-bookmark-folder-tree-feature: + description: | + This property determines weather we show the new bookmark folder tree UI + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + nova-design-feature: + description: | + The feature flag to manage the rollout of Nova design. + variables: + enabled: + description: | + Enables Nova design. + type: Boolean + default: false + onboarding-framework-feature: + description: | + The new onboarding framework feature that will allow onboarding to be experimentable through initial experiments. + variables: + cards: + description: | + The list of available cards for onboarding. + type: Map + default: + welcome-modern: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.Welcome.Title.v140 + body: Onboarding/Onboarding.Modern.Welcome.Description.v140 + image: trackers + buttons: + primary: + title: Onboarding/Onboarding.Modern.Welcome.ActionTreatementA.v140 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.Welcome.Skip.v140 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + sign-to-sync-modern: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.Sync.Title.v140 + body: Onboarding/Onboarding.Modern.Sync.Description.v140 + image: sync-with-icons + buttons: + primary: + title: Onboarding/Onboarding.Modern.Sync.SignIn.Action.v140 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.Sync.Skip.Action.v140 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-toolbar-modern: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Title.v140 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v140 + image: toolbar-bottom + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v140 + image: toolbar-top + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-theme-modern: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Customization.Theme.Title.v143 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Theme.System.Action.v123 + image: theme-system + action: theme-system-default + - title: Onboarding/Onboarding.Customization.Theme.Light.Action.v123 + image: theme-light + action: theme-light + - title: Onboarding/Onboarding.Customization.Theme.Dark.Action.v123 + image: theme-dark + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + welcome-modern-japan: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.Welcome.Title.v145 + body: Onboarding/Onboarding.Modern.Welcome.Description.v145 + image: trackers-japan + buttons: + primary: + title: Onboarding/Onboarding.Modern.Welcome.ActionTreatmentA.v145 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.Welcome.Skip.v145 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + sign-to-sync-modern-japan: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.Sync.Title.v145 + body: Onboarding/Onboarding.Modern.Sync.Description.v145 + image: sync-with-icons-japan + buttons: + primary: + title: Onboarding/Onboarding.Modern.Sync.SignIn.Action.v145 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.Sync.Skip.Action.v145 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + customization-toolbar-modern-japan: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Title.v145 + body: Onboarding/Onboarding.Modern.Customization.Toolbar.Description.v145 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Continue.Action.v145 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v145 + image: toolbar-bottom-japan + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v145 + image: toolbar-top-japan + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + customization-theme-modern-japan: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Modern.Customization.Theme.Title.v145 + body: Onboarding/Onboarding.Modern.Customization.Theme.Description.v145 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Continue.Action.v145 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Theme.Automatic.v145 + image: theme-system-japan + action: theme-system-default + - title: Onboarding/Onboarding.Modern.Customization.Theme.Light.v145 + image: theme-light-japan + action: theme-light + - title: Onboarding/Onboarding.Modern.Customization.Theme.Dark.v145 + image: theme-dark-japan + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + welcome-brand-refresh: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.TitleV3.v149 + body: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.Description.v148 + image: trackers-brand-refresh + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.ActionTreatmentA.v148 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.Skip.v148 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + customization-toolbar-brand-refresh: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Toolbar.Title.v148 + body: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Toolbar.Description.v148 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Toolbar.Continue.Action.v148 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v140 + image: toolbar-bottom-japan + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v140 + image: toolbar-top-japan + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + customization-theme-brand-refresh: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Title.v148 + body: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Description.v148 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Continue.Action.v148 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Automatic.v148 + image: theme-system-japan + action: theme-system-default + - title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Light.v148 + image: theme-light-japan + action: theme-light + - title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Dark.v148 + image: theme-dark-japan + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + sign-to-sync-brand-refresh: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.BrandRefresh.Sync.Title.v148 + body: Onboarding/Onboarding.Modern.BrandRefresh.Sync.Description.v148 + image: sync-with-icons-brand-refresh + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Sync.SignIn.Action.v148 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Sync.Skip.Action.v148 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + string-alias: NimbusOnboardingCardKey + conditions: + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + string-alias: ConditionName + dismissable: + description: | + Whether or not the entire onboarding is dismissable by pressing an X at the top right corner of the screen. + type: Boolean + default: true + enable-modern-ui: + description: | + Toggle between legacy (false) and modern (true) UI variants. + type: Boolean + default: true + enable-video-intro: + description: | + When true, a full-screen video is displayed before the Terms of Service screen during fresh-install onboarding. + type: Boolean + default: false + should-use-brand-refresh-configuration: + description: | + Toggle between standard (false) and brand refresh (true) onboarding content. + type: Boolean + default: true + should-use-japan-configuration: + description: | + Toggle between standard (false) and Japan-specific (true) assets and content. + type: Boolean + default: false + privacy-dashboard-feature: + description: | + The Privacy Dashboard feature from homepage + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + quick-answers-feature: + description: | + The feature flag to manage the roll out of the quick answers feature. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + model: + description: | + Which provider model backs Quick Answers. + type: QuickAnswersModel + default: exa + recent-searches-feature: + description: | + Enables recent searches. + variables: + enabled: + description: | + Whether or not to enable recent searches. + type: Boolean + default: false + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 5 + relay-integration-feature: + description: | + This feature is for managing the roll out of Relay email masking integration in iOS + variables: + enabled: + description: | + Enables the feature + type: Boolean + default: true + report-broken-site-feature: + description: | + In-app Report Broken Site (WebCompat) reporter + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + search: + description: | + Configuring the functionality to do with search. This will be separated into smaller sub-features in later releases. + variables: + awesome-bar: + description: Configuring the awesome bar. + type: AwesomeBar + default: + min-search-term: 3 + search-highlights: false + use-page-content: false + sent-from-firefox-feature: + description: | + Adds additional promo text to links shared to WhatsApp. + variables: + enabled: + description: | + Controls whether promo text is added to WhatsApp shares and an on/off toggle is added to Settings. + type: Boolean + default: true + isTreatmentA: + description: | + If true, shares the treatment A text. If false, shares the treatment B text. + type: Boolean + default: true + spotlight-search: + description: Add pages as items findable with Spotlight. + variables: + enabled: + description: If this is true, then on each page load adds a new item to Spotlight. + type: Boolean + default: true + icon-type: + description: | + The icon that is displayed next to the item in the search results. If this is `null`, then no icon is displayed. + type: Option + default: screenshot + keep-for-days: + description: | + Number of days to keep the item before automatic deletion. If this is left `null`, then it is left to iOS's default. + type: Option + default: null + searchable-content: + description: | + The text content that is made searchable. If this is `null` then no additional content is used, and only the title and URL will be used. + type: Option + default: text-excerpt + start-at-home-feature: + description: This feature is for experimenting with opening screen + variables: + setting: + description: This property provides a default setting for the start at home feature + type: StartAtHome + default: afterFourHours + summarizer-app-attest-auth-feature: + description: | + This feature enables app attest authentication for the summarizer. + variables: + enabled: + description: | + Enables app attest authentication for the summarizer. + type: Boolean + default: true + summarizer-language-expansion-feature: + description: | + The feature flag to manage the rollout of the summarizer language expansion. + variables: + enabled: + description: | + Whether the feature is enabled or not. + type: Boolean + default: true + supportedLocales: + description: | + The list of supported locale identifiers for the summarizer language expansion according to BCP47 standard. i.e "en-US" for English (United States). + type: List + default: + - en + - it + - fr + - es + - de + - pt + - ja + - jp + summarizer-permissive-guardrails-feature: + description: | + This feature enables permissive guardrails for the summarizer. + variables: + enabled: + description: | + Enables permissive guardrails for the summarizer. + type: Boolean + default: true + tab-scroll-refactor-feature: + description: | + The feature flag to manage the rollout of tab scroll refactor feature. + variables: + enabled: + description: | + If true, tab scroll new implementation is used to show and hide toolbar views reacting to user scroll + type: Boolean + default: false + tab-tray-ui-experiments: + description: | + The tab tray will undergo some UI experimentation to test potential improvements. + variables: + enabled: + description: | + If true, enables the tab tray UI experiments. + type: Boolean + default: true + iPad_update_enabled: + description: | + If true, enables the tab tray UI experiments on iPad. + type: Boolean + default: false + translucency: + description: | + If true, enables translucency for tab tray actions at the bottom. + type: Boolean + default: true + toolbar-refactor-feature: + description: | + This feature is for managing the roll out of the Toolbar refactor feature + variables: + layout: + description: | + The type of layout of the toolbars. + type: Option + default: version1 + tab_tray_button_type: + description: | + The style of the tab tray button in the toolbar. + type: TabTrayButtonType + default: number + unified_search: + description: | + Enables the unified search feature. + type: Boolean + default: false + tos-feature: + description: | + This feature is for managing the roll out of the ToS (Term of Service) implementation + variables: + status: + description: | + Enables the feature + type: Boolean + default: true + tou-feature: + description: | + This feature is for managing the rollout of the Terms of Use (ToU) implementation. + variables: + content-option: + description: | + Determines which predefined title and "learn more" strings are used for the Terms of Use prompt. + type: TermsOfUsePromptContentOption + default: value-0 + enable-drag-to-dismiss: + description: | + Whether to show a drag handle on the prompt and allows users to use it to dismiss the prompt. + type: Boolean + default: true + max-reminders-count: + description: | + Maximum number of ToU bottom sheet reminders that can be displayed + type: Int + default: 2 + status: + description: | + Enables the feature + type: Boolean + default: false + translations-feature: + description: | + Enables translations feature. + variables: + enabled: + description: | + Whether or not to enable translations feature. + type: Boolean + default: true + languagePickerEnabled: + description: | + Whether or not to enable the translations language picker (Phase 2). + type: Boolean + default: true + trending-searches-feature: + description: | + Enables trending searches. + variables: + enabled: + description: | + Whether or not to enable trending searches. + type: Boolean + default: false + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 5 + vpn-feature: + description: | + Configuration feature for VPN + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + wayback-machine-feature: + description: | + This property determines whether we show the wayback entry point on the native error pages + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + web-view-document-fetch-refactor-feature: + description: | + Determines whether we read PDF and document data for sharing directly from the authenticated WebView, rather than re-downloading via URLSession. + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true +enums: + ControlMessageBehavior: + description: An enum to influence what should be displayed when a control message is selected. + variants: + show-next-message: + description: The next eligible message should be shown. + show-none: + description: The surface should show no message. + IconType: + description: The icon that will be added to the item in the device's search engine. + variants: + favicon: + description: The favicon of the page + letter: + description: An icon generated from the first letter of the base domain. + screenshot: + description: A screenshot of the page at load time. + MessageSurfaceId: + description: | + For messaging, we would like to have a message tell us which surface its associated with. This is a label that matches across both Android and iOS. + variants: + Unknown: + description: A message has NOT declared its target surface. + microsurvey: + description: This is a microsurvey that appears on top of the bottom toolbar to the user. + new-tab-card: + description: This is the card that appears at the top on the Firefox Home Page. + notification: + description: This is a local notification send to the user periodically with tips and updates. + survey: + description: This is a full-page that appears providing a survey to the user. + NimbusOnboardingHeaderImage: + description: | + The identifiers for the different images available for cards in onboarding + variants: + customize-firefox: + description: | + Corresponding to the fox window image + notifications: + description: | + Corresponding to the notifications image + notifications-ctd: + description: | + Corresponding to the notifications image for CTD + search-widget: + description: | + Corresponding to the fox search widget image + set-default-steps: + description: | + Corresponding to the set to default steps image + set-to-dock: + description: | + Corresponding to the set to dock image + sync-devices: + description: | + Corresponding to the sync-devices image + sync-devices-ctd: + description: | + Corresponding to the sync image for CTD + sync-with-icons: + description: | + Corresponding to the sync-devices image + sync-with-icons-brand-refresh: + description: | + Corresponding to the sync-with-icons image for Brand Refresh variant (different from Japan variant) + sync-with-icons-japan: + description: | + Corresponding to the sync-with-icons image for Japan variant + themeing: + description: | + Corresponding to the fox world image + toolbar: + description: | + Corresponding to the fox world image + trackers: + description: | + Corresponding to the trackers image + trackers-brand-refresh: + description: | + Corresponding to the trackers image for Brand Refresh variant (does not contain Japanese text, different from Japan variant) + trackers-japan: + description: | + Corresponding to the trackers image for Japan variant (contains Japanese text) + welcome-ctd: + description: | + Corresponding to the welcome image for CTD + welcome-globe: + description: | + Corresponding to the fox world image + NimbusOnboardingMultipleChoiceButtonImage: + description: | + The identifiers for the different images available for multiple choice buttons in onboarding + variants: + theme-dark: + description: | + Corresponding to the dark theme + theme-dark-japan: + description: | + Corresponding to the dark theme image for Japan variant. Also used by Brand Refresh variant as the images are identical. + theme-light: + description: | + Corresponding to the light theme + theme-light-japan: + description: | + Corresponding to the light theme image for Japan variant. Also used by Brand Refresh variant as the images are identical. + theme-system: + description: | + Corresponding to the system theme + theme-system-japan: + description: | + Corresponding to the system theme image for Japan variant. Also used by Brand Refresh variant as the images are identical. + toolbar-bottom: + description: | + Corresponding to the toolbar on the bottom + toolbar-bottom-japan: + description: | + Corresponding to the toolbar on the bottom image for Japan variant. Also used by Brand Refresh variant as the images are identical. + toolbar-top: + description: | + Corresponding to the toolbar on top + toolbar-top-japan: + description: | + Corresponding to the toolbar on top image for Japan variant. Also used by Brand Refresh variant as the images are identical. + OnboardingActions: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + end-onboarding: + description: | + Will end the onboarding on a set card + forward-one-card: + description: | + Will take the user to the next card + forward-three-card: + description: | + Will take the user to the next card + forward-two-card: + description: | + Will take the user to the next card + open-instructions-popup: + description: | + Will open up a popup with instructions for something + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + read-privacy-policy: + description: | + Will open a webview where the user can read the privacy policy + request-notifications: + description: | + Will request to allow notifications from the user + set-default-browser: + description: | + Will send the user to settings to set Firefox as their default browser and advance to next card + sync-sign-in: + description: | + Will take the user to the sync sign in flow + OnboardingCardType: + description: | + The identifiers for the different types of onboarding cards. + variants: + basic: + description: | + Corresponding to basic info onboarding cards + multiple-choice: + description: | + Corresponding to onboarding cards with multiple choice buttons + OnboardingInstructionsPopupActions: + description: | + The identifiers for the different actions available for the instruction card in onboarding + variants: + dismiss: + description: | + Will dismiss the popup + dismiss-and-next-card: + description: | + Will dismiss the popup and move to the next card + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + OnboardingMultipleChoiceAction: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + theme-dark: + description: | + Will will set the theme to dark mode + theme-light: + description: | + Will set the theme to light mode + theme-system-default: + description: | + Will set the theme to use the system theme + toolbar-bottom: + description: | + Will set the toolbar on the bottom + toolbar-top: + description: | + Will set the toolbar on the top + OnboardingType: + description: | + The identifiers for the different types of onboarding cards. + variants: + fresh-install: + description: | + Corresponding to onboarding cards that are for new users + OnboardingVariant: + description: | + Which UI style this onboarding card is designed for. + variants: + brandRefresh: + description: Use the brand refresh onboarding UI with v148 strings. + japan: + description: Use the Japan-specific onboarding UI with localized assets. + modern: + description: Use the new (modern) onboarding UI. + PageContent: + description: The page content that will be added as an item in the device's search engine. + variants: + html-content: + description: Use all the page as HTML + text-content: + description: Use all the page as text + text-excerpt: + description: Only use the first paragraph + QuickAnswersModel: + description: The provider model that backs the Quick Answers feature. + variants: + exa: + description: The Exa model provider. + liner: + description: The Liner model provider. + StartAtHome: + description: The option for what screen to open the app to + variants: + afterFourHours: + description: Starts the app at the homepage after four hours of inactivity, otherwise starts the app at the most recently viewed tab. + always: + description: Starts the app at the homepage. + disabled: + description: Starts the app at the most recently viewed tab. + SuggestionType: + description: The type of a Firefox Suggest search suggestion. + variants: + amp: + description: A Firefox Suggestion for desktop from adMarketplace. + ampMobile: + description: A Firefox Suggestion specifically for mobile from adMarketplace. + wikipedia: + description: A Firefox Suggestion for a Wikipedia page. + TabTrayButtonType: + description: The style of the tab tray button in the toolbar. + variants: + number: + description: The original tab tray button style that show the icon with the number of tabs. + screenshot: + description: The new tab tray button style that shows two images stacked with the previous and next tab. + TermsOfUsePromptContentOption: + description: | + Determines which predefined title and "learn more" strings are used for the Terms of Use prompt. + variants: + value-0: + description: | + Uses the current defaults: + - Title: "We've got an update" + - Learn more: "Please take a moment to review and accept. Learn more." + value-1: + description: | + Uses the following copy: + - Title: "Terms of Use" + - Learn more: "You can learn more here." + value-2: + description: | + Uses the following copy: + - Title: "A note from Firefox" + - Learn more: "You can learn more here." + ToolbarLayoutType: + description: The type of toolbar layout. + variants: + version1: + description: Shows the add new tab, menu and tabs button in the navigation toolbar. The share button is displayed in the address toolbar. + version2: + description: Like version1 but the menu and tabs buttons are inverted. +objects: + AwesomeBar: + description: A configuration option for the awesome bar. Part of the `search` feature. + fields: + min-search-term: + description: The minimum number of characters that the user types before searching in the page. + type: Int + default: 3 + search-highlights: + description: Whether or not search highlights are enabled + type: Boolean + default: false + use-page-content: + description: Search in the open tab's text content when typing. + type: Boolean + default: false + MessageData: + description: | + An object to describe a message. It uses human readable strings to describe the triggers, action and style of the message as well as the text of the message and call to action. + fields: + action: + description: | + The name of a deeplink URL to be opened if the button is clicked. + type: Option + default: null + action-params: + description: Query parameters appended to the deeplink action URL + type: Map + default: {} + button-label: + description: | + The text on the button. If no text is present, the whole message is clickable. + type: Option + default: null + except-if-any: + description: | + A list of strings corresponding to targeting expressions. If any of these expressions evaluate to `true`, the message will not be eligible. + type: List + default: [] + experiment: + description: The experiment slug that this message is involved in. + type: Option + default: null + is-control: + description: Indicates if this message is the control message, if true shouldn't be displayed + type: Boolean + default: false + microsurveyConfig: + description: Optional configuration data for a microsurvey. + type: Option + default: null + should-randomize-options: + description: | + Will randomize the provided MicrosurveyConfig options + type: Boolean + default: false + style: + description: | + The style as described in a `StyleData` from the styles table. + type: StyleName + default: DEFAULT + surface: + description: Each message will tell us the surface it is targeting with this. + type: MessageSurfaceId + default: Unknown + text: + description: The message text displayed to the user + type: Text + default: '' + title: + description: The title text displayed to the user + type: Option + default: null + trigger-if-all: + description: | + A list of strings corresponding to targeting expressions. All named expressions must evaluate to true if the message is to be eligible to be shown. + type: List + default: + - ALWAYS + MicrosurveyConfig: + description: | + Attributes relating to microsurvey messaging. + fields: + icon: + description: The asset name in our bundle used as the icon shown in the survey. + type: Image + default: lightbulbLarge + options: + description: The list of survey options to present to the user. + type: List + default: [] + utm-content: + description: The name used to provide as the utm_content parameter for the privacy notice. + type: Option + default: null + NimbusOnboardingButton: + description: | + A group of properties describing the attributes of a card. + fields: + action: + description: | + The action the button should take. The default for this will be "forward-one-card" + type: OnboardingActions + default: forward-one-card + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingButtons: + description: | + A set of buttons for the card. There can be up to two, but there must be at least one. + fields: + primary: + description: | + The primary button for the card. This must exist. + type: NimbusOnboardingButton + default: + title: Primary Button + action: forward-one-card + secondary: + description: | + A secondary, optional, button for the card. + type: Option + default: null + NimbusOnboardingCardData: + description: | + A group of properties describing the attributes of a card. + fields: + body: + description: | + The body text displayed on the card, in less prominent text. This should never be defaulted. + type: Text + default: '' + buttons: + description: | + The set of buttons associated with the card. + type: NimbusOnboardingButtons + default: + primary: + title: Onboarding/Onboarding.Sync.Skip.Action.v114 + action: forward-one-card + secondary: null + card-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingCardType + default: basic + disqualifiers: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will not be shown if any expression is `true`. + type: List + default: [] + image: + description: | + The image that should be displayed on the card. + type: NimbusOnboardingHeaderImage + default: welcome-globe + instructions-popup: + description: | + The object describing the specific instruction popup button for a card. If left empty, the card will have no instruction popup information + type: Option + default: null + link: + description: | + The object describing the link button for a card. If left empty, the card will have no link. + type: Option + default: null + multiple-choice-buttons: + description: | + A list of multiple choice buttons that the card will display + type: List + default: [] + onboarding-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingType + default: fresh-install + order: + description: | + The place in the order where the card will be found. The feature layer will then sort the cards based on this field. + type: Int + default: 10 + prerequisites: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will be shown if all expressions `true` and if no expressions in the `disqualifiers` table are true, or if the `disqualifiers` table is empty. + type: List + default: [] + title: + description: | + The title displayed on the card, in prominent, bolded text. This should never be defaulted. + type: Text + default: '' + uiVariant: + description: | + If set, this card will only be shown in the specified UI variant. If null, it will appear in both legacy and modern UIs. + type: Option + default: null + NimbusOnboardingInstructionPopup: + description: | + The object outlining the content of the instruction card. + fields: + button-action: + description: | + The action the button should have. Default is `dismiss-and-next-card` + type: OnboardingInstructionsPopupActions + default: dismiss-and-next-card + button-title: + description: | + The title the button should have. This should never be defaulted. + type: Text + default: '' + instructions: + description: | + A list of instructions, either as free text, or as Text identifiers. + type: List + default: [] + title: + description: | + The text of the popup. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingLink: + description: | + A group of properties describing the attributes for the active link on a card + fields: + title: + description: | + The text of the link title. + type: Text + default: Onboarding/Onboarding.Welcome.Link.Action.v114 + url: + description: | + The url that the link will lead to. + type: String + default: https://www.mozilla.org/privacy/firefox/ + NimbusOnboardingMultipleChoiceButton: + description: | + A group of properties describing the attributes of a multiple choice button on a card + fields: + action: + description: | + The action the button should take. The default for this will be "theme-system-default" + type: OnboardingMultipleChoiceAction + default: theme-system-default + image: + description: | + The text of the button title. This should never be defaulted. + type: NimbusOnboardingMultipleChoiceButtonImage + default: theme-system + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + StyleData: + description: | + A group of properties (predominantly visual) to the describe style of the message. + fields: + max-display-count: + description: | + How many sessions will this message be shown to the user before it is expired. + type: Int + default: 5 + priority: + description: | + The importance of this message. 0 is not very important, 100 is very important. + type: Int + default: 50 diff --git a/experimenter/experimenter/features/manifests/ios/v155.1.1/experimenter.yaml b/experimenter/experimenter/features/manifests/ios/v155.1.1/experimenter.yaml new file mode 100644 index 0000000000..237e539651 --- /dev/null +++ b/experimenter/experimenter/features/manifests/ios/v155.1.1/experimenter.yaml @@ -0,0 +1,621 @@ +ad-blocker-feature: + description: | + The feature flag to manage the roll out of the Ad Blocker badge in the Site Menu and the corresponding Block Ads toggle in Browsing settings. + hasExposure: true + exposureDescription: '' + variables: + badge-enabled: + type: boolean + description: | + Whether or not the Ad Blocker badge is shown in the Site Menu + enabled: + type: boolean + description: | + Whether or not this feature is enabled +address-autofill-edit: + description: This property defines if the address editing is enabled in Settings + hasExposure: true + exposureDescription: '' + variables: + status: + type: boolean + description: If true, we will allow user to edit the address +address-bar-gesture-to-open-tab-tray-feature: + description: | + Decides if the address bar interactive gesture to open the tab tray is enabled + hasExposure: true + exposureDescription: '' + variables: + enabled_closetab: + type: boolean + description: | + Decides if the interactive gesture can close tabs by dragging the tab up to the top edge of the screen + enabled_interactive: + type: boolean + description: | + Decides if the interactive (fancier) version of this feature is enabled. + enabled_swipe: + type: boolean + description: | + Decides if the swipe version of this feature is enabled. This will override the interactive gesture +ai-kill-switch-feature: + description: | + Configuration feature for AI features + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled +background-audio-feature: + description: | + The feature flag to manage the roll out of background audio playback, allowing media to continue playing when the app is backgrounded. + hasExposure: true + exposureDescription: '' + variables: + default-on: + type: boolean + description: | + The default state of the user-facing toggle when no preference has been set. Independent of enabled, which only controls whether the feature is available. + enabled: + type: boolean + description: | + Whether or not this feature is available +bookmarks-search-feature: + description: | + Configuration feature for the bookmarks search bar + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled +custom-reader-mode-scheme-feature: + description: | + Use a custom WKURLSchemeHandler for reader mode + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled +deeplink-optimization-refactor-feature: + description: | + The feature flag to manage the rollout of deeplink optimization feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Variable description +download-live-activities-feature: + description: | + Download Live Activities Feature + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, the download live activities feature is enabled +firefox-jp-guide-default-site: + description: | + This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the feature. +firefox-suggest-feature: + description: Configuration for the Firefox Suggest feature. + hasExposure: true + exposureDescription: '' + variables: + available-suggestions-types: + type: json + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + status: + type: boolean + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. +google-lens-feature: + description: | + The feature flag to manage the rollout of Google Lens entry points. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables Google Lens entry points. +homepage-redesign-feature: + description: | + This feature is for managing the roll out of the Homepage New Tab Redesign feature. + hasExposure: true + exposureDescription: '' + variables: + add-shortcut-tile: + type: boolean + description: | + If true, enables the add shortcut tile on homepage. + bookmarks-section-default: + type: boolean + description: | + If true, enables the bookmarks homepage section by default + categories-enabled: + type: boolean + description: | + If true, enables the categories flow in the stories + jbi-section-default: + type: boolean + description: | + If true, enables the jump back in homepage section by default + pinned-header-enabled: + type: boolean + description: | + If true, enables the pinned newsfeed header on homepage. + search-bar: + type: boolean + description: | + If true, enables the search bar feature on homepage for users. +homepage-tracker-blocker-module-feature: + description: | + Controls the Tracker Blocker module feature + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled +hosted-summarizer-feature: + description: | + This feature enables the hosted summarizer feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the hosted summarizer feature. + shakeGesture: + type: boolean + description: | + Enables the shake gesture for the summarizer feature. + toolbarEntrypoint: + type: boolean + description: | + Enables the toolbar entrypoint for the summarizer feature. +https-upgrade-feature: + description: | + This feature enables automatic https upgrade. This is only available for 18.2+. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables automatic https upgrade. +improved-app-store-review-trigger-feature: + description: | + The feature flag to manage the App Store review request trigger. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the feature. +messaging: + description: | + The in-app messaging system + hasExposure: true + exposureDescription: '' + variables: + actions: + type: json + description: A growable map of action URLs. + message-under-experiment: + type: string + description: 'Deprecated. Please use "experiment": "{experiment}" instead.' + messages: + type: json + description: | + A growable collection of messages, where the Key is the message identifier and the value is its associated MessageData. + on-control: + type: string + description: What should be displayed when a control message is selected. + enum: + - show-next-message + - show-none + styles: + type: json + description: | + A map of styles to configure message appearance. + triggers: + type: json + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + ~~experiment: + type: string + description: Not to be set by experiment. +microsurvey-feature: + description: | + A feature that shows the microsurvey for users to interact with and submit responses. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, the feature is active. +native-error-page-feature: + description: | + This feature is for managing the roll out of the native error page feature + hasExposure: true + exposureDescription: '' + variables: + bad-cert-domain-error-page: + type: boolean + description: | + This feature is for managing the roll out of the bad certificate domain native error page + enabled: + type: boolean + description: | + If true, the feature is active. + no_internet_connection_error: + type: boolean + description: | + This feature is for managing the roll out of the no interet connection native error page feature +new-bookmark-folder-tree-feature: + description: | + This property determines weather we show the new bookmark folder tree UI + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled +nova-design-feature: + description: | + The feature flag to manage the rollout of Nova design. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables Nova design. +onboarding-framework-feature: + description: | + The new onboarding framework feature that will allow onboarding to be experimentable through initial experiments. + hasExposure: true + exposureDescription: '' + variables: + cards: + type: json + description: | + The list of available cards for onboarding. + conditions: + type: json + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + dismissable: + type: boolean + description: | + Whether or not the entire onboarding is dismissable by pressing an X at the top right corner of the screen. + enable-modern-ui: + type: boolean + description: | + Toggle between legacy (false) and modern (true) UI variants. + enable-video-intro: + type: boolean + description: | + When true, a full-screen video is displayed before the Terms of Service screen during fresh-install onboarding. + should-use-brand-refresh-configuration: + type: boolean + description: | + Toggle between standard (false) and brand refresh (true) onboarding content. + should-use-japan-configuration: + type: boolean + description: | + Toggle between standard (false) and Japan-specific (true) assets and content. +privacy-dashboard-feature: + description: | + The Privacy Dashboard feature from homepage + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled +quick-answers-feature: + description: | + The feature flag to manage the roll out of the quick answers feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the feature. + model: + type: string + description: | + Which provider model backs Quick Answers. + enum: + - exa + - liner +recent-searches-feature: + description: | + Enables recent searches. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable recent searches. + max-suggestions: + type: int + description: The number of maximum suggestions. +relay-integration-feature: + description: | + This feature is for managing the roll out of Relay email masking integration in iOS + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the feature +report-broken-site-feature: + description: | + In-app Report Broken Site (WebCompat) reporter + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled +search: + description: | + Configuring the functionality to do with search. This will be separated into smaller sub-features in later releases. + hasExposure: true + exposureDescription: '' + variables: + awesome-bar: + type: json + description: Configuring the awesome bar. +sent-from-firefox-feature: + description: | + Adds additional promo text to links shared to WhatsApp. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Controls whether promo text is added to WhatsApp shares and an on/off toggle is added to Settings. + isTreatmentA: + type: boolean + description: | + If true, shares the treatment A text. If false, shares the treatment B text. +spotlight-search: + description: Add pages as items findable with Spotlight. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If this is true, then on each page load adds a new item to Spotlight. + icon-type: + type: string + description: | + The icon that is displayed next to the item in the search results. If this is `null`, then no icon is displayed. + keep-for-days: + type: int + description: | + Number of days to keep the item before automatic deletion. If this is left `null`, then it is left to iOS's default. + searchable-content: + type: string + description: | + The text content that is made searchable. If this is `null` then no additional content is used, and only the title and URL will be used. +start-at-home-feature: + description: This feature is for experimenting with opening screen + hasExposure: true + exposureDescription: '' + variables: + setting: + type: string + description: This property provides a default setting for the start at home feature + enum: + - afterFourHours + - always + - disabled +summarizer-app-attest-auth-feature: + description: | + This feature enables app attest authentication for the summarizer. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables app attest authentication for the summarizer. +summarizer-language-expansion-feature: + description: | + The feature flag to manage the rollout of the summarizer language expansion. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether the feature is enabled or not. + supportedLocales: + type: json + description: | + The list of supported locale identifiers for the summarizer language expansion according to BCP47 standard. i.e "en-US" for English (United States). +summarizer-permissive-guardrails-feature: + description: | + This feature enables permissive guardrails for the summarizer. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables permissive guardrails for the summarizer. +tab-scroll-refactor-feature: + description: | + The feature flag to manage the rollout of tab scroll refactor feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, tab scroll new implementation is used to show and hide toolbar views reacting to user scroll +tab-tray-ui-experiments: + description: | + The tab tray will undergo some UI experimentation to test potential improvements. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, enables the tab tray UI experiments. + iPad_update_enabled: + type: boolean + description: | + If true, enables the tab tray UI experiments on iPad. + translucency: + type: boolean + description: | + If true, enables translucency for tab tray actions at the bottom. +toolbar-refactor-feature: + description: | + This feature is for managing the roll out of the Toolbar refactor feature + hasExposure: true + exposureDescription: '' + variables: + layout: + type: string + description: | + The type of layout of the toolbars. + tab_tray_button_type: + type: string + description: | + The style of the tab tray button in the toolbar. + enum: + - number + - screenshot + unified_search: + type: boolean + description: | + Enables the unified search feature. +tos-feature: + description: | + This feature is for managing the roll out of the ToS (Term of Service) implementation + hasExposure: true + exposureDescription: '' + variables: + status: + type: boolean + description: | + Enables the feature +tou-feature: + description: | + This feature is for managing the rollout of the Terms of Use (ToU) implementation. + hasExposure: true + exposureDescription: '' + variables: + content-option: + type: string + description: | + Determines which predefined title and "learn more" strings are used for the Terms of Use prompt. + enum: + - value-0 + - value-1 + - value-2 + enable-drag-to-dismiss: + type: boolean + description: | + Whether to show a drag handle on the prompt and allows users to use it to dismiss the prompt. + max-reminders-count: + type: int + description: | + Maximum number of ToU bottom sheet reminders that can be displayed + status: + type: boolean + description: | + Enables the feature +translations-feature: + description: | + Enables translations feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable translations feature. + languagePickerEnabled: + type: boolean + description: | + Whether or not to enable the translations language picker (Phase 2). +trending-searches-feature: + description: | + Enables trending searches. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable trending searches. + max-suggestions: + type: int + description: The number of maximum suggestions. +vpn-feature: + description: | + Configuration feature for VPN + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled +wayback-machine-feature: + description: | + This property determines whether we show the wayback entry point on the native error pages + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled +web-view-document-fetch-refactor-feature: + description: | + Determines whether we read PDF and document data for sharing directly from the authenticated WebView, rather than re-downloading via URLSession. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled diff --git a/experimenter/experimenter/features/manifests/ios/v155.1.1/release.fml.yaml b/experimenter/experimenter/features/manifests/ios/v155.1.1/release.fml.yaml new file mode 100644 index 0000000000..7a9ba5b7a2 --- /dev/null +++ b/experimenter/experimenter/features/manifests/ios/v155.1.1/release.fml.yaml @@ -0,0 +1,1528 @@ +version: 1.0.0 +about: + description: The root level Feature Manifest for Firefox for iOS +channels: +- release +features: + ad-blocker-feature: + description: | + The feature flag to manage the roll out of the Ad Blocker badge in the Site Menu and the corresponding Block Ads toggle in Browsing settings. + variables: + badge-enabled: + description: | + Whether or not the Ad Blocker badge is shown in the Site Menu + type: Boolean + default: false + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + address-autofill-edit: + description: This property defines if the address editing is enabled in Settings + variables: + status: + description: If true, we will allow user to edit the address + type: Boolean + default: false + address-bar-gesture-to-open-tab-tray-feature: + description: | + Decides if the address bar interactive gesture to open the tab tray is enabled + variables: + enabled_closetab: + description: | + Decides if the interactive gesture can close tabs by dragging the tab up to the top edge of the screen + type: Boolean + default: false + enabled_interactive: + description: | + Decides if the interactive (fancier) version of this feature is enabled. + type: Boolean + default: false + enabled_swipe: + description: | + Decides if the swipe version of this feature is enabled. This will override the interactive gesture + type: Boolean + default: false + ai-kill-switch-feature: + description: | + Configuration feature for AI features + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + background-audio-feature: + description: | + The feature flag to manage the roll out of background audio playback, allowing media to continue playing when the app is backgrounded. + variables: + default-on: + description: | + The default state of the user-facing toggle when no preference has been set. Independent of enabled, which only controls whether the feature is available. + type: Boolean + default: false + enabled: + description: | + Whether or not this feature is available + type: Boolean + default: false + bookmarks-search-feature: + description: | + Configuration feature for the bookmarks search bar + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + custom-reader-mode-scheme-feature: + description: | + Use a custom WKURLSchemeHandler for reader mode + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + deeplink-optimization-refactor-feature: + description: | + The feature flag to manage the rollout of deeplink optimization feature. + variables: + enabled: + description: | + Variable description + type: Boolean + default: false + download-live-activities-feature: + description: | + Download Live Activities Feature + variables: + enabled: + description: | + If true, the download live activities feature is enabled + type: Boolean + default: false + firefox-jp-guide-default-site: + description: | + This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + firefox-suggest-feature: + description: Configuration for the Firefox Suggest feature. + variables: + available-suggestions-types: + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + type: Map + default: + amp: true + ampMobile: false + wikipedia: true + status: + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. + type: Boolean + default: false + google-lens-feature: + description: | + The feature flag to manage the rollout of Google Lens entry points. + variables: + enabled: + description: | + Enables Google Lens entry points. + type: Boolean + default: false + homepage-redesign-feature: + description: | + This feature is for managing the roll out of the Homepage New Tab Redesign feature. + variables: + add-shortcut-tile: + description: | + If true, enables the add shortcut tile on homepage. + type: Boolean + default: false + bookmarks-section-default: + description: | + If true, enables the bookmarks homepage section by default + type: Boolean + default: false + categories-enabled: + description: | + If true, enables the categories flow in the stories + type: Boolean + default: false + jbi-section-default: + description: | + If true, enables the jump back in homepage section by default + type: Boolean + default: false + pinned-header-enabled: + description: | + If true, enables the pinned newsfeed header on homepage. + type: Boolean + default: false + search-bar: + description: | + If true, enables the search bar feature on homepage for users. + type: Boolean + default: false + homepage-tracker-blocker-module-feature: + description: | + Controls the Tracker Blocker module feature + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + hosted-summarizer-feature: + description: | + This feature enables the hosted summarizer feature. + variables: + enabled: + description: | + Enables the hosted summarizer feature. + type: Boolean + default: false + shakeGesture: + description: | + Enables the shake gesture for the summarizer feature. + type: Boolean + default: false + toolbarEntrypoint: + description: | + Enables the toolbar entrypoint for the summarizer feature. + type: Boolean + default: false + https-upgrade-feature: + description: | + This feature enables automatic https upgrade. This is only available for 18.2+. + variables: + enabled: + description: | + Enables automatic https upgrade. + type: Boolean + default: false + improved-app-store-review-trigger-feature: + description: | + The feature flag to manage the App Store review request trigger. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + messaging: + description: | + The in-app messaging system + documentation: + - name: User documentation + url: https://experimenter.info/messaging/mobile-messaging + contacts: + - jhugman@mozilla.com + - brennie@mozilla.com + - gbuciu@mozilla.com + - wteichmann@mozilla.com + events: + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_shown + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_clicked + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_expired + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_dismissed + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_malformed + variables: + actions: + description: A growable map of action URLs. + type: Map + default: + OPEN_SETTINGS: ://deep-link?url=settings/general + OPEN_SETTINGS_NEW_TAB: ://deep-link?url=settings/newtab + OPEN_SETTINGS_HOMESCREEN: ://deep-link?url=settings/homepage + OPEN_SETTINGS_WALLPAPERS: ://deep-link?url=settings/wallpaper + OPEN_SETTINGS_EMAIL: ://deep-link?url=settings/mailto + OPEN_SETTINGS_SEARCH_ENGINE: ://deep-link?url=settings/search + OPEN_SETTINGS_PRIVACY: ://deep-link?url=settings/clear-private-data + OPEN_SETTINGS_FXA: ://deep-link?url=settings/fxa + OPEN_SETTINGS_THEME: ://deep-link?url=settings/theme + OPEN_SETTINGS_APP_ICON: ://deep-link?url=settings/app-icon + OPEN_URL: ://open-url + VIEW_BOOKMARKS: ://deep-link?url=homepanel/bookmarks + VIEW_TOP_SITES: ://deep-link?url=homepanel/top-sites + VIEW_READING_LIST: ://deep-link?url=homepanel/reading-list + VIEW_HISTORY: ://deep-link?url=homepanel/history + VIEW_DOWNLOADS: ://deep-link?url=homepanel/downloads + ENABLE_PRIVATE_BROWSING: ://deep-link?url=homepanel/new-private-tab + OPEN_NEW_TAB: ://deep-link?url=homepanel/new-tab + MAKE_DEFAULT_BROWSER: ://deep-link?url=default-browser/system-settings + MAKE_DEFAULT_BROWSER_WITH_TUTORIAL: ://deep-link?url=default-browser/tutorial + OPEN_SHARE_SHEET: ://share-sheet + string-alias: ActionName + message-under-experiment: + description: 'Deprecated. Please use "experiment": "{experiment}" instead.' + type: Option + default: null + messages: + description: | + A growable collection of messages, where the Key is the message identifier and the value is its associated MessageData. + type: Map + default: {} + string-alias: MessageKey + on-control: + description: What should be displayed when a control message is selected. + type: ControlMessageBehavior + default: show-next-message + styles: + description: | + A map of styles to configure message appearance. + type: Map + default: + FALLBACK: + priority: 40 + max-display-count: 20 + DEFAULT: + priority: 50 + max-display-count: 5 + MICROSURVEY: + priority: 50 + max-display-count: 1 + NOTIFICATION: + priority: 50 + max-display-count: 1 + PERSISTENT: + priority: 50 + max-display-count: 20 + SURVEY: + priority: 55 + max-display-count: 10 + WARNING: + priority: 60 + max-display-count: 10 + URGENT: + priority: 100 + max-display-count: 10 + string-alias: StyleName + triggers: + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + USER_RECENTLY_INSTALLED: days_since_install < 7 + USER_RECENTLY_UPDATED: days_since_update < 7 && days_since_install != days_since_update + USER_TIER_ONE_COUNTRY: ('US' in locale || 'GB' in locale || 'CA' in locale || 'DE' in locale || 'FR' in locale) + USER_EN_SPEAKER: '''en'' in locale' + USER_ES_SPEAKER: '''es'' in locale' + USER_DE_SPEAKER: '''de'' in locale' + USER_FR_SPEAKER: '''fr'' in locale' + DEVICE_ANDROID: os == 'Android' + DEVICE_IOS: os == 'iOS' + DAY_1_AFTER_INSTALL: days_since_install == 1 + DAY_2_AFTER_INSTALL: days_since_install == 2 + DAY_3_AFTER_INSTALL: days_since_install == 3 + DAY_4_AFTER_INSTALL: days_since_install == 4 + DAY_5_AFTER_INSTALL: days_since_install == 5 + MORE_THAN_24H_SINCE_INSTALLED_OR_UPDATED: days_since_update >= 1 + NOT_LAUNCHED_YESTERDAY: '''app_cycle.foreground''|eventLastSeen(''Days'', 1) > 1' + AFTER_THREE_LAUNCHES_THIS_WEEK: '''app_cycle.foreground''|eventSum(''Weeks'', 1, 0) >= 3' + I_AM_DEFAULT_BROWSER: is_default_browser + I_AM_NOT_DEFAULT_BROWSER: is_default_browser == false + SUPPORTS_DEFAULT_BROWSER: os_version|versionCompare('14.!') >= 0 + INACTIVE_NEW_USER: is_inactive_new_user + ALLOWED_TIPS_NOTIFICATIONS: allowed_tips_notifications + FXA_CURRENTLY_SIGNED_IN: is_fxa_signed_in == true + SECOND_HOMEPAGE_VIEW: '''homepage_viewed''|eventSum(''Years'', 4, 0) >= 2' + ON_FOURTH_LAUNCH_THIS_YEAR: '''app_cycle.foreground''|eventSum(''Years'', 1, 0) > 3' + string-alias: TriggerName + ~~experiment: + description: Not to be set by experiment. + type: ExperimentSlug + default: '{experiment}' + string-alias: ExperimentSlug + allow-coenrollment: true + microsurvey-feature: + description: | + A feature that shows the microsurvey for users to interact with and submit responses. + variables: + enabled: + description: | + If true, the feature is active. + type: Boolean + default: false + native-error-page-feature: + description: | + This feature is for managing the roll out of the native error page feature + variables: + bad-cert-domain-error-page: + description: | + This feature is for managing the roll out of the bad certificate domain native error page + type: Boolean + default: false + enabled: + description: | + If true, the feature is active. + type: Boolean + default: false + no_internet_connection_error: + description: | + This feature is for managing the roll out of the no interet connection native error page feature + type: Boolean + default: false + new-bookmark-folder-tree-feature: + description: | + This property determines weather we show the new bookmark folder tree UI + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + nova-design-feature: + description: | + The feature flag to manage the rollout of Nova design. + variables: + enabled: + description: | + Enables Nova design. + type: Boolean + default: false + onboarding-framework-feature: + description: | + The new onboarding framework feature that will allow onboarding to be experimentable through initial experiments. + variables: + cards: + description: | + The list of available cards for onboarding. + type: Map + default: + welcome-modern: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.Welcome.Title.v140 + body: Onboarding/Onboarding.Modern.Welcome.Description.v140 + image: trackers + buttons: + primary: + title: Onboarding/Onboarding.Modern.Welcome.ActionTreatementA.v140 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.Welcome.Skip.v140 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + sign-to-sync-modern: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.Sync.Title.v140 + body: Onboarding/Onboarding.Modern.Sync.Description.v140 + image: sync-with-icons + buttons: + primary: + title: Onboarding/Onboarding.Modern.Sync.SignIn.Action.v140 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.Sync.Skip.Action.v140 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-toolbar-modern: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Title.v140 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v140 + image: toolbar-bottom + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v140 + image: toolbar-top + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-theme-modern: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Customization.Theme.Title.v143 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Theme.System.Action.v123 + image: theme-system + action: theme-system-default + - title: Onboarding/Onboarding.Customization.Theme.Light.Action.v123 + image: theme-light + action: theme-light + - title: Onboarding/Onboarding.Customization.Theme.Dark.Action.v123 + image: theme-dark + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + welcome-modern-japan: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.Welcome.Title.v145 + body: Onboarding/Onboarding.Modern.Welcome.Description.v145 + image: trackers-japan + buttons: + primary: + title: Onboarding/Onboarding.Modern.Welcome.ActionTreatmentA.v145 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.Welcome.Skip.v145 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + sign-to-sync-modern-japan: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.Sync.Title.v145 + body: Onboarding/Onboarding.Modern.Sync.Description.v145 + image: sync-with-icons-japan + buttons: + primary: + title: Onboarding/Onboarding.Modern.Sync.SignIn.Action.v145 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.Sync.Skip.Action.v145 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + customization-toolbar-modern-japan: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Title.v145 + body: Onboarding/Onboarding.Modern.Customization.Toolbar.Description.v145 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Continue.Action.v145 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v145 + image: toolbar-bottom-japan + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v145 + image: toolbar-top-japan + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + customization-theme-modern-japan: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Modern.Customization.Theme.Title.v145 + body: Onboarding/Onboarding.Modern.Customization.Theme.Description.v145 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Continue.Action.v145 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Theme.Automatic.v145 + image: theme-system-japan + action: theme-system-default + - title: Onboarding/Onboarding.Modern.Customization.Theme.Light.v145 + image: theme-light-japan + action: theme-light + - title: Onboarding/Onboarding.Modern.Customization.Theme.Dark.v145 + image: theme-dark-japan + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + welcome-brand-refresh: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.TitleV3.v149 + body: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.Description.v148 + image: trackers-brand-refresh + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.ActionTreatmentA.v148 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.Skip.v148 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + customization-toolbar-brand-refresh: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Toolbar.Title.v148 + body: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Toolbar.Description.v148 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Toolbar.Continue.Action.v148 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v140 + image: toolbar-bottom-japan + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v140 + image: toolbar-top-japan + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + customization-theme-brand-refresh: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Title.v148 + body: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Description.v148 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Continue.Action.v148 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Automatic.v148 + image: theme-system-japan + action: theme-system-default + - title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Light.v148 + image: theme-light-japan + action: theme-light + - title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Dark.v148 + image: theme-dark-japan + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + sign-to-sync-brand-refresh: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.BrandRefresh.Sync.Title.v148 + body: Onboarding/Onboarding.Modern.BrandRefresh.Sync.Description.v148 + image: sync-with-icons-brand-refresh + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Sync.SignIn.Action.v148 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Sync.Skip.Action.v148 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + string-alias: NimbusOnboardingCardKey + conditions: + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + string-alias: ConditionName + dismissable: + description: | + Whether or not the entire onboarding is dismissable by pressing an X at the top right corner of the screen. + type: Boolean + default: true + enable-modern-ui: + description: | + Toggle between legacy (false) and modern (true) UI variants. + type: Boolean + default: true + enable-video-intro: + description: | + When true, a full-screen video is displayed before the Terms of Service screen during fresh-install onboarding. + type: Boolean + default: false + should-use-brand-refresh-configuration: + description: | + Toggle between standard (false) and brand refresh (true) onboarding content. + type: Boolean + default: true + should-use-japan-configuration: + description: | + Toggle between standard (false) and Japan-specific (true) assets and content. + type: Boolean + default: false + privacy-dashboard-feature: + description: | + The Privacy Dashboard feature from homepage + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + quick-answers-feature: + description: | + The feature flag to manage the roll out of the quick answers feature. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + model: + description: | + Which provider model backs Quick Answers. + type: QuickAnswersModel + default: exa + recent-searches-feature: + description: | + Enables recent searches. + variables: + enabled: + description: | + Whether or not to enable recent searches. + type: Boolean + default: false + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 5 + relay-integration-feature: + description: | + This feature is for managing the roll out of Relay email masking integration in iOS + variables: + enabled: + description: | + Enables the feature + type: Boolean + default: true + report-broken-site-feature: + description: | + In-app Report Broken Site (WebCompat) reporter + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + search: + description: | + Configuring the functionality to do with search. This will be separated into smaller sub-features in later releases. + variables: + awesome-bar: + description: Configuring the awesome bar. + type: AwesomeBar + default: + min-search-term: 3 + search-highlights: false + use-page-content: false + sent-from-firefox-feature: + description: | + Adds additional promo text to links shared to WhatsApp. + variables: + enabled: + description: | + Controls whether promo text is added to WhatsApp shares and an on/off toggle is added to Settings. + type: Boolean + default: false + isTreatmentA: + description: | + If true, shares the treatment A text. If false, shares the treatment B text. + type: Boolean + default: true + spotlight-search: + description: Add pages as items findable with Spotlight. + variables: + enabled: + description: If this is true, then on each page load adds a new item to Spotlight. + type: Boolean + default: false + icon-type: + description: | + The icon that is displayed next to the item in the search results. If this is `null`, then no icon is displayed. + type: Option + default: letter + keep-for-days: + description: | + Number of days to keep the item before automatic deletion. If this is left `null`, then it is left to iOS's default. + type: Option + default: null + searchable-content: + description: | + The text content that is made searchable. If this is `null` then no additional content is used, and only the title and URL will be used. + type: Option + default: text-excerpt + start-at-home-feature: + description: This feature is for experimenting with opening screen + variables: + setting: + description: This property provides a default setting for the start at home feature + type: StartAtHome + default: afterFourHours + summarizer-app-attest-auth-feature: + description: | + This feature enables app attest authentication for the summarizer. + variables: + enabled: + description: | + Enables app attest authentication for the summarizer. + type: Boolean + default: true + summarizer-language-expansion-feature: + description: | + The feature flag to manage the rollout of the summarizer language expansion. + variables: + enabled: + description: | + Whether the feature is enabled or not. + type: Boolean + default: false + supportedLocales: + description: | + The list of supported locale identifiers for the summarizer language expansion according to BCP47 standard. i.e "en-US" for English (United States). + type: List + default: + - en + - it + - fr + - es + - de + - pt + - ja + - jp + summarizer-permissive-guardrails-feature: + description: | + This feature enables permissive guardrails for the summarizer. + variables: + enabled: + description: | + Enables permissive guardrails for the summarizer. + type: Boolean + default: false + tab-scroll-refactor-feature: + description: | + The feature flag to manage the rollout of tab scroll refactor feature. + variables: + enabled: + description: | + If true, tab scroll new implementation is used to show and hide toolbar views reacting to user scroll + type: Boolean + default: false + tab-tray-ui-experiments: + description: | + The tab tray will undergo some UI experimentation to test potential improvements. + variables: + enabled: + description: | + If true, enables the tab tray UI experiments. + type: Boolean + default: true + iPad_update_enabled: + description: | + If true, enables the tab tray UI experiments on iPad. + type: Boolean + default: false + translucency: + description: | + If true, enables translucency for tab tray actions at the bottom. + type: Boolean + default: false + toolbar-refactor-feature: + description: | + This feature is for managing the roll out of the Toolbar refactor feature + variables: + layout: + description: | + The type of layout of the toolbars. + type: Option + default: version1 + tab_tray_button_type: + description: | + The style of the tab tray button in the toolbar. + type: TabTrayButtonType + default: number + unified_search: + description: | + Enables the unified search feature. + type: Boolean + default: false + tos-feature: + description: | + This feature is for managing the roll out of the ToS (Term of Service) implementation + variables: + status: + description: | + Enables the feature + type: Boolean + default: true + tou-feature: + description: | + This feature is for managing the rollout of the Terms of Use (ToU) implementation. + variables: + content-option: + description: | + Determines which predefined title and "learn more" strings are used for the Terms of Use prompt. + type: TermsOfUsePromptContentOption + default: value-0 + enable-drag-to-dismiss: + description: | + Whether to show a drag handle on the prompt and allows users to use it to dismiss the prompt. + type: Boolean + default: true + max-reminders-count: + description: | + Maximum number of ToU bottom sheet reminders that can be displayed + type: Int + default: 2 + status: + description: | + Enables the feature + type: Boolean + default: false + translations-feature: + description: | + Enables translations feature. + variables: + enabled: + description: | + Whether or not to enable translations feature. + type: Boolean + default: true + languagePickerEnabled: + description: | + Whether or not to enable the translations language picker (Phase 2). + type: Boolean + default: true + trending-searches-feature: + description: | + Enables trending searches. + variables: + enabled: + description: | + Whether or not to enable trending searches. + type: Boolean + default: false + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 5 + vpn-feature: + description: | + Configuration feature for VPN + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + wayback-machine-feature: + description: | + This property determines whether we show the wayback entry point on the native error pages + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + web-view-document-fetch-refactor-feature: + description: | + Determines whether we read PDF and document data for sharing directly from the authenticated WebView, rather than re-downloading via URLSession. + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false +enums: + ControlMessageBehavior: + description: An enum to influence what should be displayed when a control message is selected. + variants: + show-next-message: + description: The next eligible message should be shown. + show-none: + description: The surface should show no message. + IconType: + description: The icon that will be added to the item in the device's search engine. + variants: + favicon: + description: The favicon of the page + letter: + description: An icon generated from the first letter of the base domain. + screenshot: + description: A screenshot of the page at load time. + MessageSurfaceId: + description: | + For messaging, we would like to have a message tell us which surface its associated with. This is a label that matches across both Android and iOS. + variants: + Unknown: + description: A message has NOT declared its target surface. + microsurvey: + description: This is a microsurvey that appears on top of the bottom toolbar to the user. + new-tab-card: + description: This is the card that appears at the top on the Firefox Home Page. + notification: + description: This is a local notification send to the user periodically with tips and updates. + survey: + description: This is a full-page that appears providing a survey to the user. + NimbusOnboardingHeaderImage: + description: | + The identifiers for the different images available for cards in onboarding + variants: + customize-firefox: + description: | + Corresponding to the fox window image + notifications: + description: | + Corresponding to the notifications image + notifications-ctd: + description: | + Corresponding to the notifications image for CTD + search-widget: + description: | + Corresponding to the fox search widget image + set-default-steps: + description: | + Corresponding to the set to default steps image + set-to-dock: + description: | + Corresponding to the set to dock image + sync-devices: + description: | + Corresponding to the sync-devices image + sync-devices-ctd: + description: | + Corresponding to the sync image for CTD + sync-with-icons: + description: | + Corresponding to the sync-devices image + sync-with-icons-brand-refresh: + description: | + Corresponding to the sync-with-icons image for Brand Refresh variant (different from Japan variant) + sync-with-icons-japan: + description: | + Corresponding to the sync-with-icons image for Japan variant + themeing: + description: | + Corresponding to the fox world image + toolbar: + description: | + Corresponding to the fox world image + trackers: + description: | + Corresponding to the trackers image + trackers-brand-refresh: + description: | + Corresponding to the trackers image for Brand Refresh variant (does not contain Japanese text, different from Japan variant) + trackers-japan: + description: | + Corresponding to the trackers image for Japan variant (contains Japanese text) + welcome-ctd: + description: | + Corresponding to the welcome image for CTD + welcome-globe: + description: | + Corresponding to the fox world image + NimbusOnboardingMultipleChoiceButtonImage: + description: | + The identifiers for the different images available for multiple choice buttons in onboarding + variants: + theme-dark: + description: | + Corresponding to the dark theme + theme-dark-japan: + description: | + Corresponding to the dark theme image for Japan variant. Also used by Brand Refresh variant as the images are identical. + theme-light: + description: | + Corresponding to the light theme + theme-light-japan: + description: | + Corresponding to the light theme image for Japan variant. Also used by Brand Refresh variant as the images are identical. + theme-system: + description: | + Corresponding to the system theme + theme-system-japan: + description: | + Corresponding to the system theme image for Japan variant. Also used by Brand Refresh variant as the images are identical. + toolbar-bottom: + description: | + Corresponding to the toolbar on the bottom + toolbar-bottom-japan: + description: | + Corresponding to the toolbar on the bottom image for Japan variant. Also used by Brand Refresh variant as the images are identical. + toolbar-top: + description: | + Corresponding to the toolbar on top + toolbar-top-japan: + description: | + Corresponding to the toolbar on top image for Japan variant. Also used by Brand Refresh variant as the images are identical. + OnboardingActions: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + end-onboarding: + description: | + Will end the onboarding on a set card + forward-one-card: + description: | + Will take the user to the next card + forward-three-card: + description: | + Will take the user to the next card + forward-two-card: + description: | + Will take the user to the next card + open-instructions-popup: + description: | + Will open up a popup with instructions for something + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + read-privacy-policy: + description: | + Will open a webview where the user can read the privacy policy + request-notifications: + description: | + Will request to allow notifications from the user + set-default-browser: + description: | + Will send the user to settings to set Firefox as their default browser and advance to next card + sync-sign-in: + description: | + Will take the user to the sync sign in flow + OnboardingCardType: + description: | + The identifiers for the different types of onboarding cards. + variants: + basic: + description: | + Corresponding to basic info onboarding cards + multiple-choice: + description: | + Corresponding to onboarding cards with multiple choice buttons + OnboardingInstructionsPopupActions: + description: | + The identifiers for the different actions available for the instruction card in onboarding + variants: + dismiss: + description: | + Will dismiss the popup + dismiss-and-next-card: + description: | + Will dismiss the popup and move to the next card + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + OnboardingMultipleChoiceAction: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + theme-dark: + description: | + Will will set the theme to dark mode + theme-light: + description: | + Will set the theme to light mode + theme-system-default: + description: | + Will set the theme to use the system theme + toolbar-bottom: + description: | + Will set the toolbar on the bottom + toolbar-top: + description: | + Will set the toolbar on the top + OnboardingType: + description: | + The identifiers for the different types of onboarding cards. + variants: + fresh-install: + description: | + Corresponding to onboarding cards that are for new users + OnboardingVariant: + description: | + Which UI style this onboarding card is designed for. + variants: + brandRefresh: + description: Use the brand refresh onboarding UI with v148 strings. + japan: + description: Use the Japan-specific onboarding UI with localized assets. + modern: + description: Use the new (modern) onboarding UI. + PageContent: + description: The page content that will be added as an item in the device's search engine. + variants: + html-content: + description: Use all the page as HTML + text-content: + description: Use all the page as text + text-excerpt: + description: Only use the first paragraph + QuickAnswersModel: + description: The provider model that backs the Quick Answers feature. + variants: + exa: + description: The Exa model provider. + liner: + description: The Liner model provider. + StartAtHome: + description: The option for what screen to open the app to + variants: + afterFourHours: + description: Starts the app at the homepage after four hours of inactivity, otherwise starts the app at the most recently viewed tab. + always: + description: Starts the app at the homepage. + disabled: + description: Starts the app at the most recently viewed tab. + SuggestionType: + description: The type of a Firefox Suggest search suggestion. + variants: + amp: + description: A Firefox Suggestion for desktop from adMarketplace. + ampMobile: + description: A Firefox Suggestion specifically for mobile from adMarketplace. + wikipedia: + description: A Firefox Suggestion for a Wikipedia page. + TabTrayButtonType: + description: The style of the tab tray button in the toolbar. + variants: + number: + description: The original tab tray button style that show the icon with the number of tabs. + screenshot: + description: The new tab tray button style that shows two images stacked with the previous and next tab. + TermsOfUsePromptContentOption: + description: | + Determines which predefined title and "learn more" strings are used for the Terms of Use prompt. + variants: + value-0: + description: | + Uses the current defaults: + - Title: "We've got an update" + - Learn more: "Please take a moment to review and accept. Learn more." + value-1: + description: | + Uses the following copy: + - Title: "Terms of Use" + - Learn more: "You can learn more here." + value-2: + description: | + Uses the following copy: + - Title: "A note from Firefox" + - Learn more: "You can learn more here." + ToolbarLayoutType: + description: The type of toolbar layout. + variants: + version1: + description: Shows the add new tab, menu and tabs button in the navigation toolbar. The share button is displayed in the address toolbar. + version2: + description: Like version1 but the menu and tabs buttons are inverted. +objects: + AwesomeBar: + description: A configuration option for the awesome bar. Part of the `search` feature. + fields: + min-search-term: + description: The minimum number of characters that the user types before searching in the page. + type: Int + default: 3 + search-highlights: + description: Whether or not search highlights are enabled + type: Boolean + default: false + use-page-content: + description: Search in the open tab's text content when typing. + type: Boolean + default: false + MessageData: + description: | + An object to describe a message. It uses human readable strings to describe the triggers, action and style of the message as well as the text of the message and call to action. + fields: + action: + description: | + The name of a deeplink URL to be opened if the button is clicked. + type: Option + default: null + action-params: + description: Query parameters appended to the deeplink action URL + type: Map + default: {} + button-label: + description: | + The text on the button. If no text is present, the whole message is clickable. + type: Option + default: null + except-if-any: + description: | + A list of strings corresponding to targeting expressions. If any of these expressions evaluate to `true`, the message will not be eligible. + type: List + default: [] + experiment: + description: The experiment slug that this message is involved in. + type: Option + default: null + is-control: + description: Indicates if this message is the control message, if true shouldn't be displayed + type: Boolean + default: false + microsurveyConfig: + description: Optional configuration data for a microsurvey. + type: Option + default: null + should-randomize-options: + description: | + Will randomize the provided MicrosurveyConfig options + type: Boolean + default: false + style: + description: | + The style as described in a `StyleData` from the styles table. + type: StyleName + default: DEFAULT + surface: + description: Each message will tell us the surface it is targeting with this. + type: MessageSurfaceId + default: Unknown + text: + description: The message text displayed to the user + type: Text + default: '' + title: + description: The title text displayed to the user + type: Option + default: null + trigger-if-all: + description: | + A list of strings corresponding to targeting expressions. All named expressions must evaluate to true if the message is to be eligible to be shown. + type: List + default: + - ALWAYS + MicrosurveyConfig: + description: | + Attributes relating to microsurvey messaging. + fields: + icon: + description: The asset name in our bundle used as the icon shown in the survey. + type: Image + default: lightbulbLarge + options: + description: The list of survey options to present to the user. + type: List + default: [] + utm-content: + description: The name used to provide as the utm_content parameter for the privacy notice. + type: Option + default: null + NimbusOnboardingButton: + description: | + A group of properties describing the attributes of a card. + fields: + action: + description: | + The action the button should take. The default for this will be "forward-one-card" + type: OnboardingActions + default: forward-one-card + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingButtons: + description: | + A set of buttons for the card. There can be up to two, but there must be at least one. + fields: + primary: + description: | + The primary button for the card. This must exist. + type: NimbusOnboardingButton + default: + title: Primary Button + action: forward-one-card + secondary: + description: | + A secondary, optional, button for the card. + type: Option + default: null + NimbusOnboardingCardData: + description: | + A group of properties describing the attributes of a card. + fields: + body: + description: | + The body text displayed on the card, in less prominent text. This should never be defaulted. + type: Text + default: '' + buttons: + description: | + The set of buttons associated with the card. + type: NimbusOnboardingButtons + default: + primary: + title: Onboarding/Onboarding.Sync.Skip.Action.v114 + action: forward-one-card + secondary: null + card-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingCardType + default: basic + disqualifiers: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will not be shown if any expression is `true`. + type: List + default: [] + image: + description: | + The image that should be displayed on the card. + type: NimbusOnboardingHeaderImage + default: welcome-globe + instructions-popup: + description: | + The object describing the specific instruction popup button for a card. If left empty, the card will have no instruction popup information + type: Option + default: null + link: + description: | + The object describing the link button for a card. If left empty, the card will have no link. + type: Option + default: null + multiple-choice-buttons: + description: | + A list of multiple choice buttons that the card will display + type: List + default: [] + onboarding-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingType + default: fresh-install + order: + description: | + The place in the order where the card will be found. The feature layer will then sort the cards based on this field. + type: Int + default: 10 + prerequisites: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will be shown if all expressions `true` and if no expressions in the `disqualifiers` table are true, or if the `disqualifiers` table is empty. + type: List + default: [] + title: + description: | + The title displayed on the card, in prominent, bolded text. This should never be defaulted. + type: Text + default: '' + uiVariant: + description: | + If set, this card will only be shown in the specified UI variant. If null, it will appear in both legacy and modern UIs. + type: Option + default: null + NimbusOnboardingInstructionPopup: + description: | + The object outlining the content of the instruction card. + fields: + button-action: + description: | + The action the button should have. Default is `dismiss-and-next-card` + type: OnboardingInstructionsPopupActions + default: dismiss-and-next-card + button-title: + description: | + The title the button should have. This should never be defaulted. + type: Text + default: '' + instructions: + description: | + A list of instructions, either as free text, or as Text identifiers. + type: List + default: [] + title: + description: | + The text of the popup. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingLink: + description: | + A group of properties describing the attributes for the active link on a card + fields: + title: + description: | + The text of the link title. + type: Text + default: Onboarding/Onboarding.Welcome.Link.Action.v114 + url: + description: | + The url that the link will lead to. + type: String + default: https://www.mozilla.org/privacy/firefox/ + NimbusOnboardingMultipleChoiceButton: + description: | + A group of properties describing the attributes of a multiple choice button on a card + fields: + action: + description: | + The action the button should take. The default for this will be "theme-system-default" + type: OnboardingMultipleChoiceAction + default: theme-system-default + image: + description: | + The text of the button title. This should never be defaulted. + type: NimbusOnboardingMultipleChoiceButtonImage + default: theme-system + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + StyleData: + description: | + A group of properties (predominantly visual) to the describe style of the message. + fields: + max-display-count: + description: | + How many sessions will this message be shown to the user before it is expired. + type: Int + default: 5 + priority: + description: | + The importance of this message. 0 is not very important, 100 is very important. + type: Int + default: 50 diff --git a/experimenter/experimenter/features/manifests/ios/v156.1.0/RecordedNimbusContext.swift b/experimenter/experimenter/features/manifests/ios/v156.1.0/RecordedNimbusContext.swift new file mode 100644 index 0000000000..c402e7a6aa --- /dev/null +++ b/experimenter/experimenter/features/manifests/ios/v156.1.0/RecordedNimbusContext.swift @@ -0,0 +1,226 @@ +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at http://mozilla.org/MPL/2.0/ + +import Common +import Foundation +import Glean +import Shared + +import class MozillaAppServices.NimbusGleanPings +import func MozillaAppServices.getCalculatedAttributes +import func MozillaAppServices.getLocaleTag +import struct MozillaAppServices.JsonObject +import protocol MozillaAppServices.RecordedContext +import MozillaRustComponents + +private extension Double? { + func toInt64() -> Int64? { + guard let self = self else { return nil } + return Int64(self) + } +} + +extension Int32? { + func toInt64() -> Int64? { + guard let self = self else { return nil } + return Int64(self) + } +} + +/// TODO(FXIOS-12942): Implement proper thread-safety +final class RecordedNimbusContext: RecordedContext, @unchecked Sendable { + /** + * The following constants are string constants of the keys that appear in the [EVENT_QUERIES] map. + */ + static let DAYS_OPENED_IN_LAST_28 = "days_opened_in_last_28" + + /** + * [EVENT_QUERIES] is a map of keys to Nimbus SDK EventStore queries. + */ + static let EVENT_QUERIES = [ + DAYS_OPENED_IN_LAST_28: "'events.app_opened'|eventCountNonZero('Days', 28, 0)", + ] + + var isFirstRun: Bool + var isPhone: Bool + var isDefaultBrowser: Bool + var isBottomToolbarUser: Bool + var hasEnabledTipsNotifications: Bool + var hasAcceptedTermsOfUse: Bool + var userDisabledAi: Bool + var isAppleIntelligenceAvailable: Bool + var cannotUseAppleIntelligence: Bool + var appVersion: String? + var region: String? + var language: String? + var locale: String + var daysSinceInstall: Int32? + var daysSinceUpdate: Int32? + var touExperiencePoints: Int32? + + private var eventQueries: [String: String] + private var eventQueryValues: [String: Double] = [:] + + private var logger: Logger + + init(isFirstRun: Bool, + isDefaultBrowser: Bool, + isBottomToolbarUser: Bool, + hasEnabledTipsNotifications: Bool, + hasAcceptedTermsOfUse: Bool, + userDisabledAi: Bool, + isAppleIntelligenceAvailable: Bool, + cannotUseAppleIntelligence: Bool, + eventQueries: [String: String] = RecordedNimbusContext.EVENT_QUERIES, + isPhone: Bool = UIDeviceDetails.userInterfaceIdiom == .phone, + bundle: Bundle = Bundle.main, + logger: Logger = DefaultLogger.shared) { + self.logger = logger + logger.log("init start", level: .debug, category: .experiments) + self.eventQueries = eventQueries + + self.isFirstRun = isFirstRun + self.isPhone = isPhone + self.isDefaultBrowser = isDefaultBrowser + self.isBottomToolbarUser = isBottomToolbarUser + self.hasEnabledTipsNotifications = hasEnabledTipsNotifications + self.hasAcceptedTermsOfUse = hasAcceptedTermsOfUse + self.userDisabledAi = userDisabledAi + self.isAppleIntelligenceAvailable = isAppleIntelligenceAvailable + self.cannotUseAppleIntelligence = cannotUseAppleIntelligence + + let info = bundle.infoDictionary ?? [:] + appVersion = info["CFBundleShortVersionString"] as? String + + locale = getLocaleTag() + var inferredDateInstalledOn: Date? { + guard + let documentsURL = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).last, + let attributes = try? FileManager.default.attributesOfItem(atPath: documentsURL.path) + else { return nil } + return attributes[.creationDate] as? Date + } + let installationDateSinceEpoch = inferredDateInstalledOn.map { + Int64(($0.timeIntervalSince1970 * 1000).rounded()) + } + guard let dbPath = Experiments.dbPath else { + self.logger.log("Unable to obtain dbPath, skipping calculating attributes", + level: .warning, + category: .experiments) + return + } + guard let calculatedAttributes = try? getCalculatedAttributes(installationDate: installationDateSinceEpoch, + dbPath: dbPath, + locale: locale) + else { return } + + daysSinceInstall = calculatedAttributes.daysSinceInstall + daysSinceUpdate = calculatedAttributes.daysSinceUpdate + language = calculatedAttributes.language + region = calculatedAttributes.region + touExperiencePoints = Experiments.touExperiencePoints(region: region) + self.logger.log("init end", level: .debug, category: .experiments) + } + + /** + * [getEventQueries] is called by the Nimbus SDK Rust code to retrieve the map of event + * queries. The are then executed against the Nimbus SDK's EventStore to retrieve their values. + * + * @return Map + */ + func getEventQueries() -> [String: String] { + logger.log("getEventQueries", level: .debug, category: .experiments) + return eventQueries + } + + /** + * [record] is called when experiment enrollments are evolved. It should apply the + * [RecordedNimbusContext]'s values to a [NimbusSystem.RecordedNimbusContextObject] instance, + * and use that instance to record the values to Glean. + */ + func record() { + logger.log("record start", level: .debug, category: .experiments) + + // Bring the ping into scope so that Glean knows it exists and includes NimbusSystem.recordedNimbusContext + _ = NimbusGleanPings.nimbusTargetingContext + + let eventQueryValuesObject = GleanMetrics.NimbusSystem.RecordedNimbusContextObjectItemEventQueryValuesObject( + daysOpenedInLast28: eventQueryValues[RecordedNimbusContext.DAYS_OPENED_IN_LAST_28].toInt64() + ) + + GleanMetrics.NimbusSystem.recordedNimbusContext.set( + GleanMetrics.NimbusSystem.RecordedNimbusContextObject( + isFirstRun: isFirstRun, + eventQueryValues: eventQueryValuesObject, + isPhone: isPhone, + appVersion: appVersion, + locale: locale, + daysSinceInstall: daysSinceInstall.toInt64(), + daysSinceUpdate: daysSinceUpdate.toInt64(), + language: language, + region: region, + isDefaultBrowser: isDefaultBrowser, + isBottomToolbarUser: isBottomToolbarUser, + hasEnabledTipsNotifications: hasEnabledTipsNotifications, + hasAcceptedTermsOfUse: hasAcceptedTermsOfUse, + userDisabledAi: userDisabledAi, + isAppleIntelligenceAvailable: isAppleIntelligenceAvailable, + cannotUseAppleIntelligence: cannotUseAppleIntelligence, + touExperiencePoints: touExperiencePoints.toInt64() + ) + ) + logger.log("record end", level: .debug, category: .experiments) + } + + /** + * [setEventQueryValues] is called by the Nimbus SDK Rust code after the event queries have been + * executed. The [eventQueryValues] should be written back to the Kotlin object. + * + * @param [eventQueryValues] The values for each query after they have been executed in the + * Nimbus SDK Rust environment. + */ + func setEventQueryValues(eventQueryValues: [String: Double]) { + logger.log("setEventQueryValues", level: .debug, category: .experiments) + self.eventQueryValues = eventQueryValues + } + + /** + * [toJson] is called by the Nimbus SDK Rust code after the event queries have been executed, + * and before experiment enrollments have been evolved. The value returned from this method + * will be applied directly to the Nimbus targeting context, and its keys/values take + * precedence over those in the main Nimbus targeting context. + * + * @return JsonObject + */ + func toJson() -> JsonObject { + logger.log("toJson start", level: .debug, category: .experiments) + guard let data = try? JSONSerialization.data(withJSONObject: [ + "is_first_run": isFirstRun, + "isFirstRun": "\(isFirstRun)", + "is_phone": isPhone, + "events": eventQueryValues, + "app_version": appVersion as Any, + "region": region as Any, + "language": language as Any, + "locale": locale as Any, + "days_since_install": daysSinceInstall as Any, + "days_since_update": daysSinceUpdate as Any, + "is_default_browser": isDefaultBrowser, + "is_bottom_toolbar_user": isBottomToolbarUser, + "has_enabled_tips_notifications": hasEnabledTipsNotifications, + "has_accepted_terms_of_use": hasAcceptedTermsOfUse, + "user_disabled_ai": userDisabledAi, + "is_apple_intelligence_available": isAppleIntelligenceAvailable, + "cannot_use_apple_intelligence": cannotUseAppleIntelligence, + "tou_experience_points": touExperiencePoints as Any + ]), + let jsonString = NSString(data: data, encoding: String.Encoding.utf8.rawValue) as? String + else { + logger.log("toJson error thrown while creating JSON string", level: .warning, category: .experiments) + return "{}" + } + logger.log("toJson end: \(jsonString)", level: .debug, category: .experiments) + return jsonString + } +} diff --git a/experimenter/experimenter/features/manifests/ios/v156.1.0/beta.fml.yaml b/experimenter/experimenter/features/manifests/ios/v156.1.0/beta.fml.yaml new file mode 100644 index 0000000000..f6a62372a8 --- /dev/null +++ b/experimenter/experimenter/features/manifests/ios/v156.1.0/beta.fml.yaml @@ -0,0 +1,1547 @@ +version: 1.0.0 +about: + description: The root level Feature Manifest for Firefox for iOS +channels: +- beta +features: + ad-blocker-feature: + description: | + The feature flag to manage the roll out of the Ad Blocker badge in the Site Menu and the corresponding Block Ads toggle in Browsing settings. + variables: + badge-enabled: + description: | + Whether or not the Ad Blocker badge is shown in the Site Menu + type: Boolean + default: true + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + address-autofill-edit: + description: This property defines if the address editing is enabled in Settings + variables: + status: + description: If true, we will allow user to edit the address + type: Boolean + default: false + address-bar-gesture-to-open-tab-tray-feature: + description: | + Decides if the address bar interactive gesture to open the tab tray is enabled + variables: + enabled_closetab: + description: | + Decides if the interactive gesture can close tabs by dragging the tab up to the top edge of the screen + type: Boolean + default: true + enabled_interactive: + description: | + Decides if the interactive (fancier) version of this feature is enabled. + type: Boolean + default: true + enabled_swipe: + description: | + Decides if the swipe version of this feature is enabled. This will override the interactive gesture + type: Boolean + default: false + ai-kill-switch-feature: + description: | + Configuration feature for AI features + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + background-audio-feature: + description: | + The feature flag to manage the roll out of background audio playback, allowing media to continue playing when the app is backgrounded. + variables: + default-on: + description: | + The default state of the user-facing toggle when no preference has been set. Independent of enabled, which only controls whether the feature is available. + type: Boolean + default: false + enabled: + description: | + Whether or not this feature is available + type: Boolean + default: false + bookmarks-search-feature: + description: | + Configuration feature for the bookmarks search bar + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + cellular-data-restricted-error-page-feature: + description: | + Controls restricted cellular data guidance on error pages + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + custom-reader-mode-scheme-feature: + description: | + Use a custom WKURLSchemeHandler for reader mode + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + deeplink-optimization-refactor-feature: + description: | + The feature flag to manage the rollout of deeplink optimization feature. + variables: + enabled: + description: | + Variable description + type: Boolean + default: true + download-live-activities-feature: + description: | + Download Live Activities Feature + variables: + enabled: + description: | + If true, the download live activities feature is enabled + type: Boolean + default: true + firefox-jp-guide-default-site: + description: | + This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + firefox-suggest-feature: + description: Configuration for the Firefox Suggest feature. + variables: + available-suggestions-types: + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + type: Map + default: + amp: true + ampMobile: false + wikipedia: true + status: + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. + type: Boolean + default: false + google-lens-feature: + description: | + The feature flag to manage the rollout of Google Lens entry points. + variables: + enabled: + description: | + Enables Google Lens entry points. + type: Boolean + default: false + homepage-redesign-feature: + description: | + This feature is for managing the roll out of the Homepage New Tab Redesign feature. + variables: + add-shortcut-tile: + description: | + If true, enables the add shortcut tile on homepage. + type: Boolean + default: false + bookmarks-section-default: + description: | + If true, enables the bookmarks homepage section by default + type: Boolean + default: false + categories-enabled: + description: | + If true, enables the categories flow in the stories + type: Boolean + default: false + jbi-section-default: + description: | + If true, enables the jump back in homepage section by default + type: Boolean + default: false + pinned-header-enabled: + description: | + If true, enables the pinned newsfeed header on homepage. + type: Boolean + default: false + search-bar: + description: | + If true, enables the search bar feature on homepage for users. + type: Boolean + default: false + homepage-tracker-blocker-module-feature: + description: | + Controls the Tracker Blocker module feature + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + hosted-summarizer-feature: + description: | + This feature enables the hosted summarizer feature. + variables: + enabled: + description: | + Enables the hosted summarizer feature. + type: Boolean + default: true + shakeGesture: + description: | + Enables the shake gesture for the summarizer feature. + type: Boolean + default: true + toolbarEntrypoint: + description: | + Enables the toolbar entrypoint for the summarizer feature. + type: Boolean + default: true + https-upgrade-feature: + description: | + This feature enables automatic https upgrade. This is only available for 18.2+. + variables: + enabled: + description: | + Enables automatic https upgrade. + type: Boolean + default: true + improved-app-store-review-trigger-feature: + description: | + The feature flag to manage the App Store review request trigger. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + messaging: + description: | + The in-app messaging system + documentation: + - name: User documentation + url: https://experimenter.info/messaging/mobile-messaging + contacts: + - jhugman@mozilla.com + - brennie@mozilla.com + - gbuciu@mozilla.com + - wteichmann@mozilla.com + events: + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_shown + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_clicked + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_expired + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_dismissed + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_malformed + variables: + actions: + description: A growable map of action URLs. + type: Map + default: + OPEN_SETTINGS: ://deep-link?url=settings/general + OPEN_SETTINGS_NEW_TAB: ://deep-link?url=settings/newtab + OPEN_SETTINGS_HOMESCREEN: ://deep-link?url=settings/homepage + OPEN_SETTINGS_WALLPAPERS: ://deep-link?url=settings/wallpaper + OPEN_SETTINGS_EMAIL: ://deep-link?url=settings/mailto + OPEN_SETTINGS_SEARCH_ENGINE: ://deep-link?url=settings/search + OPEN_SETTINGS_PRIVACY: ://deep-link?url=settings/clear-private-data + OPEN_SETTINGS_FXA: ://deep-link?url=settings/fxa + OPEN_SETTINGS_THEME: ://deep-link?url=settings/theme + OPEN_SETTINGS_APP_ICON: ://deep-link?url=settings/app-icon + OPEN_URL: ://open-url + VIEW_BOOKMARKS: ://deep-link?url=homepanel/bookmarks + VIEW_TOP_SITES: ://deep-link?url=homepanel/top-sites + VIEW_READING_LIST: ://deep-link?url=homepanel/reading-list + VIEW_HISTORY: ://deep-link?url=homepanel/history + VIEW_DOWNLOADS: ://deep-link?url=homepanel/downloads + ENABLE_PRIVATE_BROWSING: ://deep-link?url=homepanel/new-private-tab + OPEN_NEW_TAB: ://deep-link?url=homepanel/new-tab + MAKE_DEFAULT_BROWSER: ://deep-link?url=default-browser/system-settings + MAKE_DEFAULT_BROWSER_WITH_TUTORIAL: ://deep-link?url=default-browser/tutorial + OPEN_SHARE_SHEET: ://share-sheet + string-alias: ActionName + message-under-experiment: + description: 'Deprecated. Please use "experiment": "{experiment}" instead.' + type: Option + default: null + messages: + description: | + A growable collection of messages, where the Key is the message identifier and the value is its associated MessageData. + type: Map + default: + homepage-microsurvey-message: + surface: microsurvey + style: MICROSURVEY + trigger-if-all: + - SECOND_HOMEPAGE_VIEW + title: Microsurvey/Microsurvey.Prompt.TitleLabel.v127 + text: How satisfied are you with your Firefox homepage? + button-label: Microsurvey/Microsurvey.Prompt.Button.v127 + should-randomize-options: false + microsurveyConfig: + utm-content: homepage + icon: homeLarge + options: + - Microsurvey/Microsurvey.Survey.Options.VerySatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.Satisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.Neutral.v132 + - Microsurvey/Microsurvey.Survey.Options.Dissatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.VeryDissatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.NotApplicable.v132 + string-alias: MessageKey + on-control: + description: What should be displayed when a control message is selected. + type: ControlMessageBehavior + default: show-next-message + styles: + description: | + A map of styles to configure message appearance. + type: Map + default: + FALLBACK: + priority: 40 + max-display-count: 20 + DEFAULT: + priority: 50 + max-display-count: 5 + MICROSURVEY: + priority: 50 + max-display-count: 1 + NOTIFICATION: + priority: 50 + max-display-count: 1 + PERSISTENT: + priority: 50 + max-display-count: 20 + SURVEY: + priority: 55 + max-display-count: 10 + WARNING: + priority: 60 + max-display-count: 10 + URGENT: + priority: 100 + max-display-count: 10 + string-alias: StyleName + triggers: + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + USER_RECENTLY_INSTALLED: days_since_install < 7 + USER_RECENTLY_UPDATED: days_since_update < 7 && days_since_install != days_since_update + USER_TIER_ONE_COUNTRY: ('US' in locale || 'GB' in locale || 'CA' in locale || 'DE' in locale || 'FR' in locale) + USER_EN_SPEAKER: '''en'' in locale' + USER_ES_SPEAKER: '''es'' in locale' + USER_DE_SPEAKER: '''de'' in locale' + USER_FR_SPEAKER: '''fr'' in locale' + DEVICE_ANDROID: os == 'Android' + DEVICE_IOS: os == 'iOS' + DAY_1_AFTER_INSTALL: days_since_install == 1 + DAY_2_AFTER_INSTALL: days_since_install == 2 + DAY_3_AFTER_INSTALL: days_since_install == 3 + DAY_4_AFTER_INSTALL: days_since_install == 4 + DAY_5_AFTER_INSTALL: days_since_install == 5 + MORE_THAN_24H_SINCE_INSTALLED_OR_UPDATED: days_since_update >= 1 + NOT_LAUNCHED_YESTERDAY: '''app_cycle.foreground''|eventLastSeen(''Days'', 1) > 1' + AFTER_THREE_LAUNCHES_THIS_WEEK: '''app_cycle.foreground''|eventSum(''Weeks'', 1, 0) >= 3' + I_AM_DEFAULT_BROWSER: is_default_browser + I_AM_NOT_DEFAULT_BROWSER: is_default_browser == false + SUPPORTS_DEFAULT_BROWSER: os_version|versionCompare('14.!') >= 0 + INACTIVE_NEW_USER: is_inactive_new_user + ALLOWED_TIPS_NOTIFICATIONS: allowed_tips_notifications + FXA_CURRENTLY_SIGNED_IN: is_fxa_signed_in == true + SECOND_HOMEPAGE_VIEW: '''homepage_viewed''|eventSum(''Years'', 4, 0) >= 2' + ON_FOURTH_LAUNCH_THIS_YEAR: '''app_cycle.foreground''|eventSum(''Years'', 1, 0) > 3' + string-alias: TriggerName + ~~experiment: + description: Not to be set by experiment. + type: ExperimentSlug + default: '{experiment}' + string-alias: ExperimentSlug + allow-coenrollment: true + microsurvey-feature: + description: | + A feature that shows the microsurvey for users to interact with and submit responses. + variables: + enabled: + description: | + If true, the feature is active. + type: Boolean + default: false + native-error-page-feature: + description: | + This feature is for managing the roll out of the native error page feature + variables: + bad-cert-domain-error-page: + description: | + This feature is for managing the roll out of the bad certificate domain native error page + type: Boolean + default: false + enabled: + description: | + If true, the feature is active. + type: Boolean + default: false + no_internet_connection_error: + description: | + This feature is for managing the roll out of the no interet connection native error page feature + type: Boolean + default: false + new-bookmark-folder-tree-feature: + description: | + This property determines weather we show the new bookmark folder tree UI + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + nova-design-feature: + description: | + The feature flag to manage the rollout of Nova design. + variables: + enabled: + description: | + Enables Nova design. + type: Boolean + default: false + onboarding-framework-feature: + description: | + The new onboarding framework feature that will allow onboarding to be experimentable through initial experiments. + variables: + cards: + description: | + The list of available cards for onboarding. + type: Map + default: + welcome-modern: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.Welcome.Title.v140 + body: Onboarding/Onboarding.Modern.Welcome.Description.v140 + image: trackers + buttons: + primary: + title: Onboarding/Onboarding.Modern.Welcome.ActionTreatementA.v140 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.Welcome.Skip.v140 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + sign-to-sync-modern: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.Sync.Title.v140 + body: Onboarding/Onboarding.Modern.Sync.Description.v140 + image: sync-with-icons + buttons: + primary: + title: Onboarding/Onboarding.Modern.Sync.SignIn.Action.v140 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.Sync.Skip.Action.v140 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-toolbar-modern: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Title.v140 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v140 + image: toolbar-bottom + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v140 + image: toolbar-top + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-theme-modern: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Customization.Theme.Title.v143 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Theme.System.Action.v123 + image: theme-system + action: theme-system-default + - title: Onboarding/Onboarding.Customization.Theme.Light.Action.v123 + image: theme-light + action: theme-light + - title: Onboarding/Onboarding.Customization.Theme.Dark.Action.v123 + image: theme-dark + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + welcome-modern-japan: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.Welcome.Title.v145 + body: Onboarding/Onboarding.Modern.Welcome.Description.v145 + image: trackers-japan + buttons: + primary: + title: Onboarding/Onboarding.Modern.Welcome.ActionTreatmentA.v145 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.Welcome.Skip.v145 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + sign-to-sync-modern-japan: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.Sync.Title.v145 + body: Onboarding/Onboarding.Modern.Sync.Description.v145 + image: sync-with-icons-japan + buttons: + primary: + title: Onboarding/Onboarding.Modern.Sync.SignIn.Action.v145 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.Sync.Skip.Action.v145 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + customization-toolbar-modern-japan: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Title.v145 + body: Onboarding/Onboarding.Modern.Customization.Toolbar.Description.v145 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Continue.Action.v145 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v145 + image: toolbar-bottom-japan + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v145 + image: toolbar-top-japan + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + customization-theme-modern-japan: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Modern.Customization.Theme.Title.v145 + body: Onboarding/Onboarding.Modern.Customization.Theme.Description.v145 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Continue.Action.v145 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Theme.Automatic.v145 + image: theme-system-japan + action: theme-system-default + - title: Onboarding/Onboarding.Modern.Customization.Theme.Light.v145 + image: theme-light-japan + action: theme-light + - title: Onboarding/Onboarding.Modern.Customization.Theme.Dark.v145 + image: theme-dark-japan + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + welcome-brand-refresh: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.TitleV3.v149 + body: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.Description.v148 + image: trackers-brand-refresh + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.ActionTreatmentA.v148 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.Skip.v148 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + customization-toolbar-brand-refresh: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Toolbar.Title.v148 + body: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Toolbar.Description.v148 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Toolbar.Continue.Action.v148 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v140 + image: toolbar-bottom-japan + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v140 + image: toolbar-top-japan + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + customization-theme-brand-refresh: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Title.v148 + body: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Description.v148 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Continue.Action.v148 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Automatic.v148 + image: theme-system-japan + action: theme-system-default + - title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Light.v148 + image: theme-light-japan + action: theme-light + - title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Dark.v148 + image: theme-dark-japan + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + sign-to-sync-brand-refresh: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.BrandRefresh.Sync.Title.v148 + body: Onboarding/Onboarding.Modern.BrandRefresh.Sync.Description.v148 + image: sync-with-icons-brand-refresh + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Sync.SignIn.Action.v148 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Sync.Skip.Action.v148 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + string-alias: NimbusOnboardingCardKey + conditions: + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + string-alias: ConditionName + dismissable: + description: | + Whether or not the entire onboarding is dismissable by pressing an X at the top right corner of the screen. + type: Boolean + default: true + enable-modern-ui: + description: | + Toggle between legacy (false) and modern (true) UI variants. + type: Boolean + default: true + enable-video-intro: + description: | + When true, a full-screen video is displayed before the Terms of Service screen during fresh-install onboarding. + type: Boolean + default: false + should-use-brand-refresh-configuration: + description: | + Toggle between standard (false) and brand refresh (true) onboarding content. + type: Boolean + default: true + should-use-japan-configuration: + description: | + Toggle between standard (false) and Japan-specific (true) assets and content. + type: Boolean + default: false + privacy-dashboard-feature: + description: | + The Privacy Dashboard feature from homepage + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + quick-answers-feature: + description: | + The feature flag to manage the roll out of the quick answers feature. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + model: + description: | + Which provider model backs Quick Answers. + type: QuickAnswersModel + default: exa + recent-searches-feature: + description: | + Enables recent searches. + variables: + enabled: + description: | + Whether or not to enable recent searches. + type: Boolean + default: false + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 5 + relay-integration-feature: + description: | + This feature is for managing the roll out of Relay email masking integration in iOS + variables: + enabled: + description: | + Enables the feature + type: Boolean + default: true + report-broken-site-feature: + description: | + In-app Report Broken Site (WebCompat) reporter + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + search: + description: | + Configuring the functionality to do with search. This will be separated into smaller sub-features in later releases. + variables: + awesome-bar: + description: Configuring the awesome bar. + type: AwesomeBar + default: + min-search-term: 3 + search-highlights: false + use-page-content: false + sent-from-firefox-feature: + description: | + Adds additional promo text to links shared to WhatsApp. + variables: + enabled: + description: | + Controls whether promo text is added to WhatsApp shares and an on/off toggle is added to Settings. + type: Boolean + default: false + isTreatmentA: + description: | + If true, shares the treatment A text. If false, shares the treatment B text. + type: Boolean + default: true + spotlight-search: + description: Add pages as items findable with Spotlight. + variables: + enabled: + description: If this is true, then on each page load adds a new item to Spotlight. + type: Boolean + default: false + icon-type: + description: | + The icon that is displayed next to the item in the search results. If this is `null`, then no icon is displayed. + type: Option + default: letter + keep-for-days: + description: | + Number of days to keep the item before automatic deletion. If this is left `null`, then it is left to iOS's default. + type: Option + default: null + searchable-content: + description: | + The text content that is made searchable. If this is `null` then no additional content is used, and only the title and URL will be used. + type: Option + default: text-excerpt + start-at-home-feature: + description: This feature is for experimenting with opening screen + variables: + setting: + description: This property provides a default setting for the start at home feature + type: StartAtHome + default: disabled + summarizer-app-attest-auth-feature: + description: | + This feature enables app attest authentication for the summarizer. + variables: + enabled: + description: | + Enables app attest authentication for the summarizer. + type: Boolean + default: true + summarizer-language-expansion-feature: + description: | + The feature flag to manage the rollout of the summarizer language expansion. + variables: + enabled: + description: | + Whether the feature is enabled or not. + type: Boolean + default: true + supportedLocales: + description: | + The list of supported locale identifiers for the summarizer language expansion according to BCP47 standard. i.e "en-US" for English (United States). + type: List + default: + - en + - it + - fr + - es + - de + - pt + - ja + - jp + summarizer-permissive-guardrails-feature: + description: | + This feature enables permissive guardrails for the summarizer. + variables: + enabled: + description: | + Enables permissive guardrails for the summarizer. + type: Boolean + default: true + tab-scroll-refactor-feature: + description: | + The feature flag to manage the rollout of tab scroll refactor feature. + variables: + enabled: + description: | + If true, tab scroll new implementation is used to show and hide toolbar views reacting to user scroll + type: Boolean + default: false + tab-tray-ui-experiments: + description: | + The tab tray will undergo some UI experimentation to test potential improvements. + variables: + enabled: + description: | + If true, enables the tab tray UI experiments. + type: Boolean + default: true + iPad_update_enabled: + description: | + If true, enables the tab tray UI experiments on iPad. + type: Boolean + default: false + translucency: + description: | + If true, enables translucency for tab tray actions at the bottom. + type: Boolean + default: false + toolbar-refactor-feature: + description: | + This feature is for managing the roll out of the Toolbar refactor feature + variables: + layout: + description: | + The type of layout of the toolbars. + type: Option + default: version1 + tab_tray_button_type: + description: | + The style of the tab tray button in the toolbar. + type: TabTrayButtonType + default: number + unified_search: + description: | + Enables the unified search feature. + type: Boolean + default: false + tos-feature: + description: | + This feature is for managing the roll out of the ToS (Term of Service) implementation + variables: + status: + description: | + Enables the feature + type: Boolean + default: true + tou-feature: + description: | + This feature is for managing the rollout of the Terms of Use (ToU) implementation. + variables: + content-option: + description: | + Determines which predefined title and "learn more" strings are used for the Terms of Use prompt. + type: TermsOfUsePromptContentOption + default: value-0 + enable-drag-to-dismiss: + description: | + Whether to show a drag handle on the prompt and allows users to use it to dismiss the prompt. + type: Boolean + default: true + max-reminders-count: + description: | + Maximum number of ToU bottom sheet reminders that can be displayed + type: Int + default: 2 + status: + description: | + Enables the feature + type: Boolean + default: false + translations-feature: + description: | + Enables translations feature. + variables: + enabled: + description: | + Whether or not to enable translations feature. + type: Boolean + default: true + languagePickerEnabled: + description: | + Whether or not to enable the translations language picker (Phase 2). + type: Boolean + default: true + trending-searches-feature: + description: | + Enables trending searches. + variables: + enabled: + description: | + Whether or not to enable trending searches. + type: Boolean + default: false + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 5 + vpn-feature: + description: | + Configuration feature for VPN + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + wayback-machine-feature: + description: | + This property determines whether we show the wayback entry point on the native error pages + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + web-view-document-fetch-refactor-feature: + description: | + Determines whether we read PDF and document data for sharing directly from the authenticated WebView, rather than re-downloading via URLSession. + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false +enums: + ControlMessageBehavior: + description: An enum to influence what should be displayed when a control message is selected. + variants: + show-next-message: + description: The next eligible message should be shown. + show-none: + description: The surface should show no message. + IconType: + description: The icon that will be added to the item in the device's search engine. + variants: + favicon: + description: The favicon of the page + letter: + description: An icon generated from the first letter of the base domain. + screenshot: + description: A screenshot of the page at load time. + MessageSurfaceId: + description: | + For messaging, we would like to have a message tell us which surface its associated with. This is a label that matches across both Android and iOS. + variants: + Unknown: + description: A message has NOT declared its target surface. + microsurvey: + description: This is a microsurvey that appears on top of the bottom toolbar to the user. + new-tab-card: + description: This is the card that appears at the top on the Firefox Home Page. + notification: + description: This is a local notification send to the user periodically with tips and updates. + survey: + description: This is a full-page that appears providing a survey to the user. + NimbusOnboardingHeaderImage: + description: | + The identifiers for the different images available for cards in onboarding + variants: + customize-firefox: + description: | + Corresponding to the fox window image + notifications: + description: | + Corresponding to the notifications image + search-widget: + description: | + Corresponding to the fox search widget image + set-default-steps: + description: | + Corresponding to the set to default steps image + set-to-dock: + description: | + Corresponding to the set to dock image + sync-devices: + description: | + Corresponding to the sync-devices image + sync-with-icons: + description: | + Corresponding to the sync-devices image + sync-with-icons-brand-refresh: + description: | + Corresponding to the sync-with-icons image for Brand Refresh variant (different from Japan variant) + sync-with-icons-japan: + description: | + Corresponding to the sync-with-icons image for Japan variant + themeing: + description: | + Corresponding to the fox world image + toolbar: + description: | + Corresponding to the fox world image + trackers: + description: | + Corresponding to the trackers image + trackers-brand-refresh: + description: | + Corresponding to the trackers image for Brand Refresh variant (does not contain Japanese text, different from Japan variant) + trackers-japan: + description: | + Corresponding to the trackers image for Japan variant (contains Japanese text) + welcome-globe: + description: | + Corresponding to the fox world image + NimbusOnboardingMultipleChoiceButtonImage: + description: | + The identifiers for the different images available for multiple choice buttons in onboarding + variants: + theme-dark: + description: | + Corresponding to the dark theme + theme-dark-japan: + description: | + Corresponding to the dark theme image for Japan variant. Also used by Brand Refresh variant as the images are identical. + theme-light: + description: | + Corresponding to the light theme + theme-light-japan: + description: | + Corresponding to the light theme image for Japan variant. Also used by Brand Refresh variant as the images are identical. + theme-system: + description: | + Corresponding to the system theme + theme-system-japan: + description: | + Corresponding to the system theme image for Japan variant. Also used by Brand Refresh variant as the images are identical. + toolbar-bottom: + description: | + Corresponding to the toolbar on the bottom + toolbar-bottom-japan: + description: | + Corresponding to the toolbar on the bottom image for Japan variant. Also used by Brand Refresh variant as the images are identical. + toolbar-top: + description: | + Corresponding to the toolbar on top + toolbar-top-japan: + description: | + Corresponding to the toolbar on top image for Japan variant. Also used by Brand Refresh variant as the images are identical. + OnboardingActions: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + end-onboarding: + description: | + Will end the onboarding on a set card + forward-one-card: + description: | + Will take the user to the next card + forward-three-card: + description: | + Will take the user to the next card + forward-two-card: + description: | + Will take the user to the next card + open-instructions-popup: + description: | + Will open up a popup with instructions for something + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + read-privacy-policy: + description: | + Will open a webview where the user can read the privacy policy + request-notifications: + description: | + Will request to allow notifications from the user + set-default-browser: + description: | + Will send the user to settings to set Firefox as their default browser and advance to next card + sync-sign-in: + description: | + Will take the user to the sync sign in flow + OnboardingCardType: + description: | + The identifiers for the different types of onboarding cards. + variants: + basic: + description: | + Corresponding to basic info onboarding cards + multiple-choice: + description: | + Corresponding to onboarding cards with multiple choice buttons + OnboardingInstructionsPopupActions: + description: | + The identifiers for the different actions available for the instruction card in onboarding + variants: + dismiss: + description: | + Will dismiss the popup + dismiss-and-next-card: + description: | + Will dismiss the popup and move to the next card + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + OnboardingMultipleChoiceAction: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + theme-dark: + description: | + Will will set the theme to dark mode + theme-light: + description: | + Will set the theme to light mode + theme-system-default: + description: | + Will set the theme to use the system theme + toolbar-bottom: + description: | + Will set the toolbar on the bottom + toolbar-top: + description: | + Will set the toolbar on the top + OnboardingType: + description: | + The identifiers for the different types of onboarding cards. + variants: + fresh-install: + description: | + Corresponding to onboarding cards that are for new users + OnboardingVariant: + description: | + Which UI style this onboarding card is designed for. + variants: + brandRefresh: + description: Use the brand refresh onboarding UI with v148 strings. + japan: + description: Use the Japan-specific onboarding UI with localized assets. + modern: + description: Use the new (modern) onboarding UI. + PageContent: + description: The page content that will be added as an item in the device's search engine. + variants: + html-content: + description: Use all the page as HTML + text-content: + description: Use all the page as text + text-excerpt: + description: Only use the first paragraph + QuickAnswersModel: + description: The provider model that backs the Quick Answers feature. + variants: + exa: + description: The Exa model provider. + liner: + description: The Liner model provider. + StartAtHome: + description: The option for what screen to open the app to + variants: + afterFourHours: + description: Starts the app at the homepage after four hours of inactivity, otherwise starts the app at the most recently viewed tab. + always: + description: Starts the app at the homepage. + disabled: + description: Starts the app at the most recently viewed tab. + SuggestionType: + description: The type of a Firefox Suggest search suggestion. + variants: + amp: + description: A Firefox Suggestion for desktop from adMarketplace. + ampMobile: + description: A Firefox Suggestion specifically for mobile from adMarketplace. + wikipedia: + description: A Firefox Suggestion for a Wikipedia page. + TabTrayButtonType: + description: The style of the tab tray button in the toolbar. + variants: + number: + description: The original tab tray button style that show the icon with the number of tabs. + screenshot: + description: The new tab tray button style that shows two images stacked with the previous and next tab. + TermsOfUsePromptContentOption: + description: | + Determines which predefined title and "learn more" strings are used for the Terms of Use prompt. + variants: + value-0: + description: | + Uses the current defaults: + - Title: "We've got an update" + - Learn more: "Please take a moment to review and accept. Learn more." + value-1: + description: | + Uses the following copy: + - Title: "Terms of Use" + - Learn more: "You can learn more here." + value-2: + description: | + Uses the following copy: + - Title: "A note from Firefox" + - Learn more: "You can learn more here." + ToolbarLayoutType: + description: The type of toolbar layout. + variants: + version1: + description: Shows the add new tab, menu and tabs button in the navigation toolbar. The share button is displayed in the address toolbar. + version2: + description: Like version1 but the menu and tabs buttons are inverted. +objects: + AwesomeBar: + description: A configuration option for the awesome bar. Part of the `search` feature. + fields: + min-search-term: + description: The minimum number of characters that the user types before searching in the page. + type: Int + default: 3 + search-highlights: + description: Whether or not search highlights are enabled + type: Boolean + default: false + use-page-content: + description: Search in the open tab's text content when typing. + type: Boolean + default: false + MessageData: + description: | + An object to describe a message. It uses human readable strings to describe the triggers, action and style of the message as well as the text of the message and call to action. + fields: + action: + description: | + The name of a deeplink URL to be opened if the button is clicked. + type: Option + default: null + action-params: + description: Query parameters appended to the deeplink action URL + type: Map + default: {} + button-label: + description: | + The text on the button. If no text is present, the whole message is clickable. + type: Option + default: null + except-if-any: + description: | + A list of strings corresponding to targeting expressions. If any of these expressions evaluate to `true`, the message will not be eligible. + type: List + default: [] + experiment: + description: The experiment slug that this message is involved in. + type: Option + default: null + is-control: + description: Indicates if this message is the control message, if true shouldn't be displayed + type: Boolean + default: false + microsurveyConfig: + description: Optional configuration data for a microsurvey. + type: Option + default: null + should-randomize-options: + description: | + Will randomize the provided MicrosurveyConfig options + type: Boolean + default: false + style: + description: | + The style as described in a `StyleData` from the styles table. + type: StyleName + default: DEFAULT + surface: + description: Each message will tell us the surface it is targeting with this. + type: MessageSurfaceId + default: Unknown + text: + description: The message text displayed to the user + type: Text + default: '' + title: + description: The title text displayed to the user + type: Option + default: null + trigger-if-all: + description: | + A list of strings corresponding to targeting expressions. All named expressions must evaluate to true if the message is to be eligible to be shown. + type: List + default: + - ALWAYS + MicrosurveyConfig: + description: | + Attributes relating to microsurvey messaging. + fields: + icon: + description: The asset name in our bundle used as the icon shown in the survey. + type: Image + default: lightbulbLarge + options: + description: The list of survey options to present to the user. + type: List + default: [] + utm-content: + description: The name used to provide as the utm_content parameter for the privacy notice. + type: Option + default: null + NimbusOnboardingButton: + description: | + A group of properties describing the attributes of a card. + fields: + action: + description: | + The action the button should take. The default for this will be "forward-one-card" + type: OnboardingActions + default: forward-one-card + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingButtons: + description: | + A set of buttons for the card. There can be up to two, but there must be at least one. + fields: + primary: + description: | + The primary button for the card. This must exist. + type: NimbusOnboardingButton + default: + title: Primary Button + action: forward-one-card + secondary: + description: | + A secondary, optional, button for the card. + type: Option + default: null + NimbusOnboardingCardData: + description: | + A group of properties describing the attributes of a card. + fields: + body: + description: | + The body text displayed on the card, in less prominent text. This should never be defaulted. + type: Text + default: '' + buttons: + description: | + The set of buttons associated with the card. + type: NimbusOnboardingButtons + default: + primary: + title: Onboarding/Onboarding.Sync.Skip.Action.v114 + action: forward-one-card + secondary: null + card-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingCardType + default: basic + disqualifiers: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will not be shown if any expression is `true`. + type: List + default: [] + image: + description: | + The image that should be displayed on the card. + type: NimbusOnboardingHeaderImage + default: welcome-globe + instructions-popup: + description: | + The object describing the specific instruction popup button for a card. If left empty, the card will have no instruction popup information + type: Option + default: null + link: + description: | + The object describing the link button for a card. If left empty, the card will have no link. + type: Option + default: null + multiple-choice-buttons: + description: | + A list of multiple choice buttons that the card will display + type: List + default: [] + onboarding-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingType + default: fresh-install + order: + description: | + The place in the order where the card will be found. The feature layer will then sort the cards based on this field. + type: Int + default: 10 + prerequisites: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will be shown if all expressions `true` and if no expressions in the `disqualifiers` table are true, or if the `disqualifiers` table is empty. + type: List + default: [] + title: + description: | + The title displayed on the card, in prominent, bolded text. This should never be defaulted. + type: Text + default: '' + uiVariant: + description: | + If set, this card will only be shown in the specified UI variant. If null, it will appear in both legacy and modern UIs. + type: Option + default: null + NimbusOnboardingInstructionPopup: + description: | + The object outlining the content of the instruction card. + fields: + button-action: + description: | + The action the button should have. Default is `dismiss-and-next-card` + type: OnboardingInstructionsPopupActions + default: dismiss-and-next-card + button-title: + description: | + The title the button should have. This should never be defaulted. + type: Text + default: '' + instructions: + description: | + A list of instructions, either as free text, or as Text identifiers. + type: List + default: [] + title: + description: | + The text of the popup. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingLink: + description: | + A group of properties describing the attributes for the active link on a card + fields: + title: + description: | + The text of the link title. + type: Text + default: Onboarding/Onboarding.Welcome.Link.Action.v114 + url: + description: | + The url that the link will lead to. + type: String + default: https://www.mozilla.org/privacy/firefox/ + NimbusOnboardingMultipleChoiceButton: + description: | + A group of properties describing the attributes of a multiple choice button on a card + fields: + action: + description: | + The action the button should take. The default for this will be "theme-system-default" + type: OnboardingMultipleChoiceAction + default: theme-system-default + image: + description: | + The text of the button title. This should never be defaulted. + type: NimbusOnboardingMultipleChoiceButtonImage + default: theme-system + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + StyleData: + description: | + A group of properties (predominantly visual) to the describe style of the message. + fields: + max-display-count: + description: | + How many sessions will this message be shown to the user before it is expired. + type: Int + default: 5 + priority: + description: | + The importance of this message. 0 is not very important, 100 is very important. + type: Int + default: 50 diff --git a/experimenter/experimenter/features/manifests/ios/v156.1.0/developer.fml.yaml b/experimenter/experimenter/features/manifests/ios/v156.1.0/developer.fml.yaml new file mode 100644 index 0000000000..c70168153b --- /dev/null +++ b/experimenter/experimenter/features/manifests/ios/v156.1.0/developer.fml.yaml @@ -0,0 +1,1558 @@ +version: 1.0.0 +about: + description: The root level Feature Manifest for Firefox for iOS +channels: +- developer +features: + ad-blocker-feature: + description: | + The feature flag to manage the roll out of the Ad Blocker badge in the Site Menu and the corresponding Block Ads toggle in Browsing settings. + variables: + badge-enabled: + description: | + Whether or not the Ad Blocker badge is shown in the Site Menu + type: Boolean + default: true + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + address-autofill-edit: + description: This property defines if the address editing is enabled in Settings + variables: + status: + description: If true, we will allow user to edit the address + type: Boolean + default: true + address-bar-gesture-to-open-tab-tray-feature: + description: | + Decides if the address bar interactive gesture to open the tab tray is enabled + variables: + enabled_closetab: + description: | + Decides if the interactive gesture can close tabs by dragging the tab up to the top edge of the screen + type: Boolean + default: true + enabled_interactive: + description: | + Decides if the interactive (fancier) version of this feature is enabled. + type: Boolean + default: true + enabled_swipe: + description: | + Decides if the swipe version of this feature is enabled. This will override the interactive gesture + type: Boolean + default: false + ai-kill-switch-feature: + description: | + Configuration feature for AI features + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + background-audio-feature: + description: | + The feature flag to manage the roll out of background audio playback, allowing media to continue playing when the app is backgrounded. + variables: + default-on: + description: | + The default state of the user-facing toggle when no preference has been set. Independent of enabled, which only controls whether the feature is available. + type: Boolean + default: false + enabled: + description: | + Whether or not this feature is available + type: Boolean + default: true + bookmarks-search-feature: + description: | + Configuration feature for the bookmarks search bar + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + cellular-data-restricted-error-page-feature: + description: | + Controls restricted cellular data guidance on error pages + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + custom-reader-mode-scheme-feature: + description: | + Use a custom WKURLSchemeHandler for reader mode + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + deeplink-optimization-refactor-feature: + description: | + The feature flag to manage the rollout of deeplink optimization feature. + variables: + enabled: + description: | + Variable description + type: Boolean + default: true + download-live-activities-feature: + description: | + Download Live Activities Feature + variables: + enabled: + description: | + If true, the download live activities feature is enabled + type: Boolean + default: true + firefox-jp-guide-default-site: + description: | + This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: true + firefox-suggest-feature: + description: Configuration for the Firefox Suggest feature. + variables: + available-suggestions-types: + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + type: Map + default: + amp: true + ampMobile: false + wikipedia: true + status: + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. + type: Boolean + default: true + google-lens-feature: + description: | + The feature flag to manage the rollout of Google Lens entry points. + variables: + enabled: + description: | + Enables Google Lens entry points. + type: Boolean + default: true + homepage-redesign-feature: + description: | + This feature is for managing the roll out of the Homepage New Tab Redesign feature. + variables: + add-shortcut-tile: + description: | + If true, enables the add shortcut tile on homepage. + type: Boolean + default: false + bookmarks-section-default: + description: | + If true, enables the bookmarks homepage section by default + type: Boolean + default: false + categories-enabled: + description: | + If true, enables the categories flow in the stories + type: Boolean + default: true + jbi-section-default: + description: | + If true, enables the jump back in homepage section by default + type: Boolean + default: false + pinned-header-enabled: + description: | + If true, enables the pinned newsfeed header on homepage. + type: Boolean + default: true + search-bar: + description: | + If true, enables the search bar feature on homepage for users. + type: Boolean + default: false + homepage-tracker-blocker-module-feature: + description: | + Controls the Tracker Blocker module feature + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + hosted-summarizer-feature: + description: | + This feature enables the hosted summarizer feature. + variables: + enabled: + description: | + Enables the hosted summarizer feature. + type: Boolean + default: true + shakeGesture: + description: | + Enables the shake gesture for the summarizer feature. + type: Boolean + default: true + toolbarEntrypoint: + description: | + Enables the toolbar entrypoint for the summarizer feature. + type: Boolean + default: true + https-upgrade-feature: + description: | + This feature enables automatic https upgrade. This is only available for 18.2+. + variables: + enabled: + description: | + Enables automatic https upgrade. + type: Boolean + default: true + improved-app-store-review-trigger-feature: + description: | + The feature flag to manage the App Store review request trigger. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + messaging: + description: | + The in-app messaging system + documentation: + - name: User documentation + url: https://experimenter.info/messaging/mobile-messaging + contacts: + - jhugman@mozilla.com + - brennie@mozilla.com + - gbuciu@mozilla.com + - wteichmann@mozilla.com + events: + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_shown + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_clicked + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_expired + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_dismissed + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_malformed + variables: + actions: + description: A growable map of action URLs. + type: Map + default: + OPEN_SETTINGS: ://deep-link?url=settings/general + OPEN_SETTINGS_NEW_TAB: ://deep-link?url=settings/newtab + OPEN_SETTINGS_HOMESCREEN: ://deep-link?url=settings/homepage + OPEN_SETTINGS_WALLPAPERS: ://deep-link?url=settings/wallpaper + OPEN_SETTINGS_EMAIL: ://deep-link?url=settings/mailto + OPEN_SETTINGS_SEARCH_ENGINE: ://deep-link?url=settings/search + OPEN_SETTINGS_PRIVACY: ://deep-link?url=settings/clear-private-data + OPEN_SETTINGS_FXA: ://deep-link?url=settings/fxa + OPEN_SETTINGS_THEME: ://deep-link?url=settings/theme + OPEN_SETTINGS_APP_ICON: ://deep-link?url=settings/app-icon + OPEN_URL: ://open-url + VIEW_BOOKMARKS: ://deep-link?url=homepanel/bookmarks + VIEW_TOP_SITES: ://deep-link?url=homepanel/top-sites + VIEW_READING_LIST: ://deep-link?url=homepanel/reading-list + VIEW_HISTORY: ://deep-link?url=homepanel/history + VIEW_DOWNLOADS: ://deep-link?url=homepanel/downloads + ENABLE_PRIVATE_BROWSING: ://deep-link?url=homepanel/new-private-tab + OPEN_NEW_TAB: ://deep-link?url=homepanel/new-tab + MAKE_DEFAULT_BROWSER: ://deep-link?url=default-browser/system-settings + MAKE_DEFAULT_BROWSER_WITH_TUTORIAL: ://deep-link?url=default-browser/tutorial + OPEN_SHARE_SHEET: ://share-sheet + string-alias: ActionName + message-under-experiment: + description: 'Deprecated. Please use "experiment": "{experiment}" instead.' + type: Option + default: null + messages: + description: | + A growable collection of messages, where the Key is the message identifier and the value is its associated MessageData. + type: Map + default: + homepage-microsurvey-message: + surface: microsurvey + style: MICROSURVEY + trigger-if-all: + - SECOND_HOMEPAGE_VIEW + title: Microsurvey/Microsurvey.Prompt.TitleLabel.v127 + text: How satisfied are you with your Firefox homepage? + button-label: Microsurvey/Microsurvey.Prompt.Button.v127 + should-randomize-options: false + microsurveyConfig: + utm-content: homepage + icon: homeLarge + options: + - Microsurvey/Microsurvey.Survey.Options.VerySatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.Satisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.Neutral.v132 + - Microsurvey/Microsurvey.Survey.Options.Dissatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.VeryDissatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.NotApplicable.v132 + survey-surface-message: + surface: survey + style: SURVEY + trigger-if-all: + - NEVER + text: ResearchSurface/Body.Text.v112 + button-label: ResearchSurface/PrimaryButton.Label.v112 + should-randomize-options: false + action: OPEN_URL + action-params: + url: https://www.macrumors.com + string-alias: MessageKey + on-control: + description: What should be displayed when a control message is selected. + type: ControlMessageBehavior + default: show-next-message + styles: + description: | + A map of styles to configure message appearance. + type: Map + default: + FALLBACK: + priority: 40 + max-display-count: 20 + DEFAULT: + priority: 50 + max-display-count: 5 + MICROSURVEY: + priority: 50 + max-display-count: 1 + NOTIFICATION: + priority: 50 + max-display-count: 1 + PERSISTENT: + priority: 50 + max-display-count: 20 + SURVEY: + priority: 55 + max-display-count: 10 + WARNING: + priority: 60 + max-display-count: 10 + URGENT: + priority: 100 + max-display-count: 10 + string-alias: StyleName + triggers: + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + USER_RECENTLY_INSTALLED: days_since_install < 7 + USER_RECENTLY_UPDATED: days_since_update < 7 && days_since_install != days_since_update + USER_TIER_ONE_COUNTRY: ('US' in locale || 'GB' in locale || 'CA' in locale || 'DE' in locale || 'FR' in locale) + USER_EN_SPEAKER: '''en'' in locale' + USER_ES_SPEAKER: '''es'' in locale' + USER_DE_SPEAKER: '''de'' in locale' + USER_FR_SPEAKER: '''fr'' in locale' + DEVICE_ANDROID: os == 'Android' + DEVICE_IOS: os == 'iOS' + DAY_1_AFTER_INSTALL: days_since_install == 1 + DAY_2_AFTER_INSTALL: days_since_install == 2 + DAY_3_AFTER_INSTALL: days_since_install == 3 + DAY_4_AFTER_INSTALL: days_since_install == 4 + DAY_5_AFTER_INSTALL: days_since_install == 5 + MORE_THAN_24H_SINCE_INSTALLED_OR_UPDATED: days_since_update >= 1 + NOT_LAUNCHED_YESTERDAY: '''app_cycle.foreground''|eventLastSeen(''Days'', 1) > 1' + AFTER_THREE_LAUNCHES_THIS_WEEK: '''app_cycle.foreground''|eventSum(''Weeks'', 1, 0) >= 3' + I_AM_DEFAULT_BROWSER: is_default_browser + I_AM_NOT_DEFAULT_BROWSER: is_default_browser == false + SUPPORTS_DEFAULT_BROWSER: os_version|versionCompare('14.!') >= 0 + INACTIVE_NEW_USER: is_inactive_new_user + ALLOWED_TIPS_NOTIFICATIONS: allowed_tips_notifications + FXA_CURRENTLY_SIGNED_IN: is_fxa_signed_in == true + SECOND_HOMEPAGE_VIEW: '''homepage_viewed''|eventSum(''Years'', 4, 0) >= 2' + ON_FOURTH_LAUNCH_THIS_YEAR: '''app_cycle.foreground''|eventSum(''Years'', 1, 0) > 3' + string-alias: TriggerName + ~~experiment: + description: Not to be set by experiment. + type: ExperimentSlug + default: '{experiment}' + string-alias: ExperimentSlug + allow-coenrollment: true + microsurvey-feature: + description: | + A feature that shows the microsurvey for users to interact with and submit responses. + variables: + enabled: + description: | + If true, the feature is active. + type: Boolean + default: true + native-error-page-feature: + description: | + This feature is for managing the roll out of the native error page feature + variables: + bad-cert-domain-error-page: + description: | + This feature is for managing the roll out of the bad certificate domain native error page + type: Boolean + default: false + enabled: + description: | + If true, the feature is active. + type: Boolean + default: true + no_internet_connection_error: + description: | + This feature is for managing the roll out of the no interet connection native error page feature + type: Boolean + default: true + new-bookmark-folder-tree-feature: + description: | + This property determines weather we show the new bookmark folder tree UI + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + nova-design-feature: + description: | + The feature flag to manage the rollout of Nova design. + variables: + enabled: + description: | + Enables Nova design. + type: Boolean + default: false + onboarding-framework-feature: + description: | + The new onboarding framework feature that will allow onboarding to be experimentable through initial experiments. + variables: + cards: + description: | + The list of available cards for onboarding. + type: Map + default: + welcome-modern: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.Welcome.Title.v140 + body: Onboarding/Onboarding.Modern.Welcome.Description.v140 + image: trackers + buttons: + primary: + title: Onboarding/Onboarding.Modern.Welcome.ActionTreatementA.v140 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.Welcome.Skip.v140 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + sign-to-sync-modern: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.Sync.Title.v140 + body: Onboarding/Onboarding.Modern.Sync.Description.v140 + image: sync-with-icons + buttons: + primary: + title: Onboarding/Onboarding.Modern.Sync.SignIn.Action.v140 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.Sync.Skip.Action.v140 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-toolbar-modern: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Title.v140 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v140 + image: toolbar-bottom + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v140 + image: toolbar-top + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-theme-modern: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Customization.Theme.Title.v143 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Theme.System.Action.v123 + image: theme-system + action: theme-system-default + - title: Onboarding/Onboarding.Customization.Theme.Light.Action.v123 + image: theme-light + action: theme-light + - title: Onboarding/Onboarding.Customization.Theme.Dark.Action.v123 + image: theme-dark + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + welcome-modern-japan: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.Welcome.Title.v145 + body: Onboarding/Onboarding.Modern.Welcome.Description.v145 + image: trackers-japan + buttons: + primary: + title: Onboarding/Onboarding.Modern.Welcome.ActionTreatmentA.v145 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.Welcome.Skip.v145 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + sign-to-sync-modern-japan: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.Sync.Title.v145 + body: Onboarding/Onboarding.Modern.Sync.Description.v145 + image: sync-with-icons-japan + buttons: + primary: + title: Onboarding/Onboarding.Modern.Sync.SignIn.Action.v145 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.Sync.Skip.Action.v145 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + customization-toolbar-modern-japan: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Title.v145 + body: Onboarding/Onboarding.Modern.Customization.Toolbar.Description.v145 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Continue.Action.v145 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v145 + image: toolbar-bottom-japan + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v145 + image: toolbar-top-japan + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + customization-theme-modern-japan: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Modern.Customization.Theme.Title.v145 + body: Onboarding/Onboarding.Modern.Customization.Theme.Description.v145 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Continue.Action.v145 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Theme.Automatic.v145 + image: theme-system-japan + action: theme-system-default + - title: Onboarding/Onboarding.Modern.Customization.Theme.Light.v145 + image: theme-light-japan + action: theme-light + - title: Onboarding/Onboarding.Modern.Customization.Theme.Dark.v145 + image: theme-dark-japan + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + welcome-brand-refresh: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.TitleV3.v149 + body: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.Description.v148 + image: trackers-brand-refresh + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.ActionTreatmentA.v148 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.Skip.v148 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + customization-toolbar-brand-refresh: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Toolbar.Title.v148 + body: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Toolbar.Description.v148 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Toolbar.Continue.Action.v148 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v140 + image: toolbar-bottom-japan + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v140 + image: toolbar-top-japan + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + customization-theme-brand-refresh: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Title.v148 + body: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Description.v148 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Continue.Action.v148 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Automatic.v148 + image: theme-system-japan + action: theme-system-default + - title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Light.v148 + image: theme-light-japan + action: theme-light + - title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Dark.v148 + image: theme-dark-japan + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + sign-to-sync-brand-refresh: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.BrandRefresh.Sync.Title.v148 + body: Onboarding/Onboarding.Modern.BrandRefresh.Sync.Description.v148 + image: sync-with-icons-brand-refresh + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Sync.SignIn.Action.v148 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Sync.Skip.Action.v148 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + string-alias: NimbusOnboardingCardKey + conditions: + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + string-alias: ConditionName + dismissable: + description: | + Whether or not the entire onboarding is dismissable by pressing an X at the top right corner of the screen. + type: Boolean + default: true + enable-modern-ui: + description: | + Toggle between legacy (false) and modern (true) UI variants. + type: Boolean + default: true + enable-video-intro: + description: | + When true, a full-screen video is displayed before the Terms of Service screen during fresh-install onboarding. + type: Boolean + default: false + should-use-brand-refresh-configuration: + description: | + Toggle between standard (false) and brand refresh (true) onboarding content. + type: Boolean + default: true + should-use-japan-configuration: + description: | + Toggle between standard (false) and Japan-specific (true) assets and content. + type: Boolean + default: false + privacy-dashboard-feature: + description: | + The Privacy Dashboard feature from homepage + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + quick-answers-feature: + description: | + The feature flag to manage the roll out of the quick answers feature. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + model: + description: | + Which provider model backs Quick Answers. + type: QuickAnswersModel + default: exa + recent-searches-feature: + description: | + Enables recent searches. + variables: + enabled: + description: | + Whether or not to enable recent searches. + type: Boolean + default: false + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 5 + relay-integration-feature: + description: | + This feature is for managing the roll out of Relay email masking integration in iOS + variables: + enabled: + description: | + Enables the feature + type: Boolean + default: true + report-broken-site-feature: + description: | + In-app Report Broken Site (WebCompat) reporter + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + search: + description: | + Configuring the functionality to do with search. This will be separated into smaller sub-features in later releases. + variables: + awesome-bar: + description: Configuring the awesome bar. + type: AwesomeBar + default: + min-search-term: 3 + search-highlights: false + use-page-content: false + sent-from-firefox-feature: + description: | + Adds additional promo text to links shared to WhatsApp. + variables: + enabled: + description: | + Controls whether promo text is added to WhatsApp shares and an on/off toggle is added to Settings. + type: Boolean + default: true + isTreatmentA: + description: | + If true, shares the treatment A text. If false, shares the treatment B text. + type: Boolean + default: true + spotlight-search: + description: Add pages as items findable with Spotlight. + variables: + enabled: + description: If this is true, then on each page load adds a new item to Spotlight. + type: Boolean + default: true + icon-type: + description: | + The icon that is displayed next to the item in the search results. If this is `null`, then no icon is displayed. + type: Option + default: screenshot + keep-for-days: + description: | + Number of days to keep the item before automatic deletion. If this is left `null`, then it is left to iOS's default. + type: Option + default: null + searchable-content: + description: | + The text content that is made searchable. If this is `null` then no additional content is used, and only the title and URL will be used. + type: Option + default: text-excerpt + start-at-home-feature: + description: This feature is for experimenting with opening screen + variables: + setting: + description: This property provides a default setting for the start at home feature + type: StartAtHome + default: disabled + summarizer-app-attest-auth-feature: + description: | + This feature enables app attest authentication for the summarizer. + variables: + enabled: + description: | + Enables app attest authentication for the summarizer. + type: Boolean + default: true + summarizer-language-expansion-feature: + description: | + The feature flag to manage the rollout of the summarizer language expansion. + variables: + enabled: + description: | + Whether the feature is enabled or not. + type: Boolean + default: true + supportedLocales: + description: | + The list of supported locale identifiers for the summarizer language expansion according to BCP47 standard. i.e "en-US" for English (United States). + type: List + default: + - en + - it + - fr + - es + - de + - pt + - ja + - jp + summarizer-permissive-guardrails-feature: + description: | + This feature enables permissive guardrails for the summarizer. + variables: + enabled: + description: | + Enables permissive guardrails for the summarizer. + type: Boolean + default: true + tab-scroll-refactor-feature: + description: | + The feature flag to manage the rollout of tab scroll refactor feature. + variables: + enabled: + description: | + If true, tab scroll new implementation is used to show and hide toolbar views reacting to user scroll + type: Boolean + default: false + tab-tray-ui-experiments: + description: | + The tab tray will undergo some UI experimentation to test potential improvements. + variables: + enabled: + description: | + If true, enables the tab tray UI experiments. + type: Boolean + default: true + iPad_update_enabled: + description: | + If true, enables the tab tray UI experiments on iPad. + type: Boolean + default: false + translucency: + description: | + If true, enables translucency for tab tray actions at the bottom. + type: Boolean + default: true + toolbar-refactor-feature: + description: | + This feature is for managing the roll out of the Toolbar refactor feature + variables: + layout: + description: | + The type of layout of the toolbars. + type: Option + default: version1 + tab_tray_button_type: + description: | + The style of the tab tray button in the toolbar. + type: TabTrayButtonType + default: number + unified_search: + description: | + Enables the unified search feature. + type: Boolean + default: false + tos-feature: + description: | + This feature is for managing the roll out of the ToS (Term of Service) implementation + variables: + status: + description: | + Enables the feature + type: Boolean + default: true + tou-feature: + description: | + This feature is for managing the rollout of the Terms of Use (ToU) implementation. + variables: + content-option: + description: | + Determines which predefined title and "learn more" strings are used for the Terms of Use prompt. + type: TermsOfUsePromptContentOption + default: value-0 + enable-drag-to-dismiss: + description: | + Whether to show a drag handle on the prompt and allows users to use it to dismiss the prompt. + type: Boolean + default: true + max-reminders-count: + description: | + Maximum number of ToU bottom sheet reminders that can be displayed + type: Int + default: 2 + status: + description: | + Enables the feature + type: Boolean + default: false + translations-feature: + description: | + Enables translations feature. + variables: + enabled: + description: | + Whether or not to enable translations feature. + type: Boolean + default: true + languagePickerEnabled: + description: | + Whether or not to enable the translations language picker (Phase 2). + type: Boolean + default: true + trending-searches-feature: + description: | + Enables trending searches. + variables: + enabled: + description: | + Whether or not to enable trending searches. + type: Boolean + default: false + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 5 + vpn-feature: + description: | + Configuration feature for VPN + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + wayback-machine-feature: + description: | + This property determines whether we show the wayback entry point on the native error pages + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + web-view-document-fetch-refactor-feature: + description: | + Determines whether we read PDF and document data for sharing directly from the authenticated WebView, rather than re-downloading via URLSession. + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true +enums: + ControlMessageBehavior: + description: An enum to influence what should be displayed when a control message is selected. + variants: + show-next-message: + description: The next eligible message should be shown. + show-none: + description: The surface should show no message. + IconType: + description: The icon that will be added to the item in the device's search engine. + variants: + favicon: + description: The favicon of the page + letter: + description: An icon generated from the first letter of the base domain. + screenshot: + description: A screenshot of the page at load time. + MessageSurfaceId: + description: | + For messaging, we would like to have a message tell us which surface its associated with. This is a label that matches across both Android and iOS. + variants: + Unknown: + description: A message has NOT declared its target surface. + microsurvey: + description: This is a microsurvey that appears on top of the bottom toolbar to the user. + new-tab-card: + description: This is the card that appears at the top on the Firefox Home Page. + notification: + description: This is a local notification send to the user periodically with tips and updates. + survey: + description: This is a full-page that appears providing a survey to the user. + NimbusOnboardingHeaderImage: + description: | + The identifiers for the different images available for cards in onboarding + variants: + customize-firefox: + description: | + Corresponding to the fox window image + notifications: + description: | + Corresponding to the notifications image + search-widget: + description: | + Corresponding to the fox search widget image + set-default-steps: + description: | + Corresponding to the set to default steps image + set-to-dock: + description: | + Corresponding to the set to dock image + sync-devices: + description: | + Corresponding to the sync-devices image + sync-with-icons: + description: | + Corresponding to the sync-devices image + sync-with-icons-brand-refresh: + description: | + Corresponding to the sync-with-icons image for Brand Refresh variant (different from Japan variant) + sync-with-icons-japan: + description: | + Corresponding to the sync-with-icons image for Japan variant + themeing: + description: | + Corresponding to the fox world image + toolbar: + description: | + Corresponding to the fox world image + trackers: + description: | + Corresponding to the trackers image + trackers-brand-refresh: + description: | + Corresponding to the trackers image for Brand Refresh variant (does not contain Japanese text, different from Japan variant) + trackers-japan: + description: | + Corresponding to the trackers image for Japan variant (contains Japanese text) + welcome-globe: + description: | + Corresponding to the fox world image + NimbusOnboardingMultipleChoiceButtonImage: + description: | + The identifiers for the different images available for multiple choice buttons in onboarding + variants: + theme-dark: + description: | + Corresponding to the dark theme + theme-dark-japan: + description: | + Corresponding to the dark theme image for Japan variant. Also used by Brand Refresh variant as the images are identical. + theme-light: + description: | + Corresponding to the light theme + theme-light-japan: + description: | + Corresponding to the light theme image for Japan variant. Also used by Brand Refresh variant as the images are identical. + theme-system: + description: | + Corresponding to the system theme + theme-system-japan: + description: | + Corresponding to the system theme image for Japan variant. Also used by Brand Refresh variant as the images are identical. + toolbar-bottom: + description: | + Corresponding to the toolbar on the bottom + toolbar-bottom-japan: + description: | + Corresponding to the toolbar on the bottom image for Japan variant. Also used by Brand Refresh variant as the images are identical. + toolbar-top: + description: | + Corresponding to the toolbar on top + toolbar-top-japan: + description: | + Corresponding to the toolbar on top image for Japan variant. Also used by Brand Refresh variant as the images are identical. + OnboardingActions: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + end-onboarding: + description: | + Will end the onboarding on a set card + forward-one-card: + description: | + Will take the user to the next card + forward-three-card: + description: | + Will take the user to the next card + forward-two-card: + description: | + Will take the user to the next card + open-instructions-popup: + description: | + Will open up a popup with instructions for something + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + read-privacy-policy: + description: | + Will open a webview where the user can read the privacy policy + request-notifications: + description: | + Will request to allow notifications from the user + set-default-browser: + description: | + Will send the user to settings to set Firefox as their default browser and advance to next card + sync-sign-in: + description: | + Will take the user to the sync sign in flow + OnboardingCardType: + description: | + The identifiers for the different types of onboarding cards. + variants: + basic: + description: | + Corresponding to basic info onboarding cards + multiple-choice: + description: | + Corresponding to onboarding cards with multiple choice buttons + OnboardingInstructionsPopupActions: + description: | + The identifiers for the different actions available for the instruction card in onboarding + variants: + dismiss: + description: | + Will dismiss the popup + dismiss-and-next-card: + description: | + Will dismiss the popup and move to the next card + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + OnboardingMultipleChoiceAction: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + theme-dark: + description: | + Will will set the theme to dark mode + theme-light: + description: | + Will set the theme to light mode + theme-system-default: + description: | + Will set the theme to use the system theme + toolbar-bottom: + description: | + Will set the toolbar on the bottom + toolbar-top: + description: | + Will set the toolbar on the top + OnboardingType: + description: | + The identifiers for the different types of onboarding cards. + variants: + fresh-install: + description: | + Corresponding to onboarding cards that are for new users + OnboardingVariant: + description: | + Which UI style this onboarding card is designed for. + variants: + brandRefresh: + description: Use the brand refresh onboarding UI with v148 strings. + japan: + description: Use the Japan-specific onboarding UI with localized assets. + modern: + description: Use the new (modern) onboarding UI. + PageContent: + description: The page content that will be added as an item in the device's search engine. + variants: + html-content: + description: Use all the page as HTML + text-content: + description: Use all the page as text + text-excerpt: + description: Only use the first paragraph + QuickAnswersModel: + description: The provider model that backs the Quick Answers feature. + variants: + exa: + description: The Exa model provider. + liner: + description: The Liner model provider. + StartAtHome: + description: The option for what screen to open the app to + variants: + afterFourHours: + description: Starts the app at the homepage after four hours of inactivity, otherwise starts the app at the most recently viewed tab. + always: + description: Starts the app at the homepage. + disabled: + description: Starts the app at the most recently viewed tab. + SuggestionType: + description: The type of a Firefox Suggest search suggestion. + variants: + amp: + description: A Firefox Suggestion for desktop from adMarketplace. + ampMobile: + description: A Firefox Suggestion specifically for mobile from adMarketplace. + wikipedia: + description: A Firefox Suggestion for a Wikipedia page. + TabTrayButtonType: + description: The style of the tab tray button in the toolbar. + variants: + number: + description: The original tab tray button style that show the icon with the number of tabs. + screenshot: + description: The new tab tray button style that shows two images stacked with the previous and next tab. + TermsOfUsePromptContentOption: + description: | + Determines which predefined title and "learn more" strings are used for the Terms of Use prompt. + variants: + value-0: + description: | + Uses the current defaults: + - Title: "We've got an update" + - Learn more: "Please take a moment to review and accept. Learn more." + value-1: + description: | + Uses the following copy: + - Title: "Terms of Use" + - Learn more: "You can learn more here." + value-2: + description: | + Uses the following copy: + - Title: "A note from Firefox" + - Learn more: "You can learn more here." + ToolbarLayoutType: + description: The type of toolbar layout. + variants: + version1: + description: Shows the add new tab, menu and tabs button in the navigation toolbar. The share button is displayed in the address toolbar. + version2: + description: Like version1 but the menu and tabs buttons are inverted. +objects: + AwesomeBar: + description: A configuration option for the awesome bar. Part of the `search` feature. + fields: + min-search-term: + description: The minimum number of characters that the user types before searching in the page. + type: Int + default: 3 + search-highlights: + description: Whether or not search highlights are enabled + type: Boolean + default: false + use-page-content: + description: Search in the open tab's text content when typing. + type: Boolean + default: false + MessageData: + description: | + An object to describe a message. It uses human readable strings to describe the triggers, action and style of the message as well as the text of the message and call to action. + fields: + action: + description: | + The name of a deeplink URL to be opened if the button is clicked. + type: Option + default: null + action-params: + description: Query parameters appended to the deeplink action URL + type: Map + default: {} + button-label: + description: | + The text on the button. If no text is present, the whole message is clickable. + type: Option + default: null + except-if-any: + description: | + A list of strings corresponding to targeting expressions. If any of these expressions evaluate to `true`, the message will not be eligible. + type: List + default: [] + experiment: + description: The experiment slug that this message is involved in. + type: Option + default: null + is-control: + description: Indicates if this message is the control message, if true shouldn't be displayed + type: Boolean + default: false + microsurveyConfig: + description: Optional configuration data for a microsurvey. + type: Option + default: null + should-randomize-options: + description: | + Will randomize the provided MicrosurveyConfig options + type: Boolean + default: false + style: + description: | + The style as described in a `StyleData` from the styles table. + type: StyleName + default: DEFAULT + surface: + description: Each message will tell us the surface it is targeting with this. + type: MessageSurfaceId + default: Unknown + text: + description: The message text displayed to the user + type: Text + default: '' + title: + description: The title text displayed to the user + type: Option + default: null + trigger-if-all: + description: | + A list of strings corresponding to targeting expressions. All named expressions must evaluate to true if the message is to be eligible to be shown. + type: List + default: + - ALWAYS + MicrosurveyConfig: + description: | + Attributes relating to microsurvey messaging. + fields: + icon: + description: The asset name in our bundle used as the icon shown in the survey. + type: Image + default: lightbulbLarge + options: + description: The list of survey options to present to the user. + type: List + default: [] + utm-content: + description: The name used to provide as the utm_content parameter for the privacy notice. + type: Option + default: null + NimbusOnboardingButton: + description: | + A group of properties describing the attributes of a card. + fields: + action: + description: | + The action the button should take. The default for this will be "forward-one-card" + type: OnboardingActions + default: forward-one-card + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingButtons: + description: | + A set of buttons for the card. There can be up to two, but there must be at least one. + fields: + primary: + description: | + The primary button for the card. This must exist. + type: NimbusOnboardingButton + default: + title: Primary Button + action: forward-one-card + secondary: + description: | + A secondary, optional, button for the card. + type: Option + default: null + NimbusOnboardingCardData: + description: | + A group of properties describing the attributes of a card. + fields: + body: + description: | + The body text displayed on the card, in less prominent text. This should never be defaulted. + type: Text + default: '' + buttons: + description: | + The set of buttons associated with the card. + type: NimbusOnboardingButtons + default: + primary: + title: Onboarding/Onboarding.Sync.Skip.Action.v114 + action: forward-one-card + secondary: null + card-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingCardType + default: basic + disqualifiers: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will not be shown if any expression is `true`. + type: List + default: [] + image: + description: | + The image that should be displayed on the card. + type: NimbusOnboardingHeaderImage + default: welcome-globe + instructions-popup: + description: | + The object describing the specific instruction popup button for a card. If left empty, the card will have no instruction popup information + type: Option + default: null + link: + description: | + The object describing the link button for a card. If left empty, the card will have no link. + type: Option + default: null + multiple-choice-buttons: + description: | + A list of multiple choice buttons that the card will display + type: List + default: [] + onboarding-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingType + default: fresh-install + order: + description: | + The place in the order where the card will be found. The feature layer will then sort the cards based on this field. + type: Int + default: 10 + prerequisites: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will be shown if all expressions `true` and if no expressions in the `disqualifiers` table are true, or if the `disqualifiers` table is empty. + type: List + default: [] + title: + description: | + The title displayed on the card, in prominent, bolded text. This should never be defaulted. + type: Text + default: '' + uiVariant: + description: | + If set, this card will only be shown in the specified UI variant. If null, it will appear in both legacy and modern UIs. + type: Option + default: null + NimbusOnboardingInstructionPopup: + description: | + The object outlining the content of the instruction card. + fields: + button-action: + description: | + The action the button should have. Default is `dismiss-and-next-card` + type: OnboardingInstructionsPopupActions + default: dismiss-and-next-card + button-title: + description: | + The title the button should have. This should never be defaulted. + type: Text + default: '' + instructions: + description: | + A list of instructions, either as free text, or as Text identifiers. + type: List + default: [] + title: + description: | + The text of the popup. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingLink: + description: | + A group of properties describing the attributes for the active link on a card + fields: + title: + description: | + The text of the link title. + type: Text + default: Onboarding/Onboarding.Welcome.Link.Action.v114 + url: + description: | + The url that the link will lead to. + type: String + default: https://www.mozilla.org/privacy/firefox/ + NimbusOnboardingMultipleChoiceButton: + description: | + A group of properties describing the attributes of a multiple choice button on a card + fields: + action: + description: | + The action the button should take. The default for this will be "theme-system-default" + type: OnboardingMultipleChoiceAction + default: theme-system-default + image: + description: | + The text of the button title. This should never be defaulted. + type: NimbusOnboardingMultipleChoiceButtonImage + default: theme-system + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + StyleData: + description: | + A group of properties (predominantly visual) to the describe style of the message. + fields: + max-display-count: + description: | + How many sessions will this message be shown to the user before it is expired. + type: Int + default: 5 + priority: + description: | + The importance of this message. 0 is not very important, 100 is very important. + type: Int + default: 50 diff --git a/experimenter/experimenter/features/manifests/ios/v156.1.0/experimenter.yaml b/experimenter/experimenter/features/manifests/ios/v156.1.0/experimenter.yaml new file mode 100644 index 0000000000..e0b2fe3889 --- /dev/null +++ b/experimenter/experimenter/features/manifests/ios/v156.1.0/experimenter.yaml @@ -0,0 +1,631 @@ +ad-blocker-feature: + description: | + The feature flag to manage the roll out of the Ad Blocker badge in the Site Menu and the corresponding Block Ads toggle in Browsing settings. + hasExposure: true + exposureDescription: '' + variables: + badge-enabled: + type: boolean + description: | + Whether or not the Ad Blocker badge is shown in the Site Menu + enabled: + type: boolean + description: | + Whether or not this feature is enabled +address-autofill-edit: + description: This property defines if the address editing is enabled in Settings + hasExposure: true + exposureDescription: '' + variables: + status: + type: boolean + description: If true, we will allow user to edit the address +address-bar-gesture-to-open-tab-tray-feature: + description: | + Decides if the address bar interactive gesture to open the tab tray is enabled + hasExposure: true + exposureDescription: '' + variables: + enabled_closetab: + type: boolean + description: | + Decides if the interactive gesture can close tabs by dragging the tab up to the top edge of the screen + enabled_interactive: + type: boolean + description: | + Decides if the interactive (fancier) version of this feature is enabled. + enabled_swipe: + type: boolean + description: | + Decides if the swipe version of this feature is enabled. This will override the interactive gesture +ai-kill-switch-feature: + description: | + Configuration feature for AI features + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled +background-audio-feature: + description: | + The feature flag to manage the roll out of background audio playback, allowing media to continue playing when the app is backgrounded. + hasExposure: true + exposureDescription: '' + variables: + default-on: + type: boolean + description: | + The default state of the user-facing toggle when no preference has been set. Independent of enabled, which only controls whether the feature is available. + enabled: + type: boolean + description: | + Whether or not this feature is available +bookmarks-search-feature: + description: | + Configuration feature for the bookmarks search bar + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled +cellular-data-restricted-error-page-feature: + description: | + Controls restricted cellular data guidance on error pages + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled +custom-reader-mode-scheme-feature: + description: | + Use a custom WKURLSchemeHandler for reader mode + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled +deeplink-optimization-refactor-feature: + description: | + The feature flag to manage the rollout of deeplink optimization feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Variable description +download-live-activities-feature: + description: | + Download Live Activities Feature + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, the download live activities feature is enabled +firefox-jp-guide-default-site: + description: | + This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the feature. +firefox-suggest-feature: + description: Configuration for the Firefox Suggest feature. + hasExposure: true + exposureDescription: '' + variables: + available-suggestions-types: + type: json + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + status: + type: boolean + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. +google-lens-feature: + description: | + The feature flag to manage the rollout of Google Lens entry points. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables Google Lens entry points. +homepage-redesign-feature: + description: | + This feature is for managing the roll out of the Homepage New Tab Redesign feature. + hasExposure: true + exposureDescription: '' + variables: + add-shortcut-tile: + type: boolean + description: | + If true, enables the add shortcut tile on homepage. + bookmarks-section-default: + type: boolean + description: | + If true, enables the bookmarks homepage section by default + categories-enabled: + type: boolean + description: | + If true, enables the categories flow in the stories + jbi-section-default: + type: boolean + description: | + If true, enables the jump back in homepage section by default + pinned-header-enabled: + type: boolean + description: | + If true, enables the pinned newsfeed header on homepage. + search-bar: + type: boolean + description: | + If true, enables the search bar feature on homepage for users. +homepage-tracker-blocker-module-feature: + description: | + Controls the Tracker Blocker module feature + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled +hosted-summarizer-feature: + description: | + This feature enables the hosted summarizer feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the hosted summarizer feature. + shakeGesture: + type: boolean + description: | + Enables the shake gesture for the summarizer feature. + toolbarEntrypoint: + type: boolean + description: | + Enables the toolbar entrypoint for the summarizer feature. +https-upgrade-feature: + description: | + This feature enables automatic https upgrade. This is only available for 18.2+. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables automatic https upgrade. +improved-app-store-review-trigger-feature: + description: | + The feature flag to manage the App Store review request trigger. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the feature. +messaging: + description: | + The in-app messaging system + hasExposure: true + exposureDescription: '' + variables: + actions: + type: json + description: A growable map of action URLs. + message-under-experiment: + type: string + description: 'Deprecated. Please use "experiment": "{experiment}" instead.' + messages: + type: json + description: | + A growable collection of messages, where the Key is the message identifier and the value is its associated MessageData. + on-control: + type: string + description: What should be displayed when a control message is selected. + enum: + - show-next-message + - show-none + styles: + type: json + description: | + A map of styles to configure message appearance. + triggers: + type: json + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + ~~experiment: + type: string + description: Not to be set by experiment. +microsurvey-feature: + description: | + A feature that shows the microsurvey for users to interact with and submit responses. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, the feature is active. +native-error-page-feature: + description: | + This feature is for managing the roll out of the native error page feature + hasExposure: true + exposureDescription: '' + variables: + bad-cert-domain-error-page: + type: boolean + description: | + This feature is for managing the roll out of the bad certificate domain native error page + enabled: + type: boolean + description: | + If true, the feature is active. + no_internet_connection_error: + type: boolean + description: | + This feature is for managing the roll out of the no interet connection native error page feature +new-bookmark-folder-tree-feature: + description: | + This property determines weather we show the new bookmark folder tree UI + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled +nova-design-feature: + description: | + The feature flag to manage the rollout of Nova design. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables Nova design. +onboarding-framework-feature: + description: | + The new onboarding framework feature that will allow onboarding to be experimentable through initial experiments. + hasExposure: true + exposureDescription: '' + variables: + cards: + type: json + description: | + The list of available cards for onboarding. + conditions: + type: json + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + dismissable: + type: boolean + description: | + Whether or not the entire onboarding is dismissable by pressing an X at the top right corner of the screen. + enable-modern-ui: + type: boolean + description: | + Toggle between legacy (false) and modern (true) UI variants. + enable-video-intro: + type: boolean + description: | + When true, a full-screen video is displayed before the Terms of Service screen during fresh-install onboarding. + should-use-brand-refresh-configuration: + type: boolean + description: | + Toggle between standard (false) and brand refresh (true) onboarding content. + should-use-japan-configuration: + type: boolean + description: | + Toggle between standard (false) and Japan-specific (true) assets and content. +privacy-dashboard-feature: + description: | + The Privacy Dashboard feature from homepage + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled +quick-answers-feature: + description: | + The feature flag to manage the roll out of the quick answers feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the feature. + model: + type: string + description: | + Which provider model backs Quick Answers. + enum: + - exa + - liner +recent-searches-feature: + description: | + Enables recent searches. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable recent searches. + max-suggestions: + type: int + description: The number of maximum suggestions. +relay-integration-feature: + description: | + This feature is for managing the roll out of Relay email masking integration in iOS + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the feature +report-broken-site-feature: + description: | + In-app Report Broken Site (WebCompat) reporter + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled +search: + description: | + Configuring the functionality to do with search. This will be separated into smaller sub-features in later releases. + hasExposure: true + exposureDescription: '' + variables: + awesome-bar: + type: json + description: Configuring the awesome bar. +sent-from-firefox-feature: + description: | + Adds additional promo text to links shared to WhatsApp. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Controls whether promo text is added to WhatsApp shares and an on/off toggle is added to Settings. + isTreatmentA: + type: boolean + description: | + If true, shares the treatment A text. If false, shares the treatment B text. +spotlight-search: + description: Add pages as items findable with Spotlight. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If this is true, then on each page load adds a new item to Spotlight. + icon-type: + type: string + description: | + The icon that is displayed next to the item in the search results. If this is `null`, then no icon is displayed. + keep-for-days: + type: int + description: | + Number of days to keep the item before automatic deletion. If this is left `null`, then it is left to iOS's default. + searchable-content: + type: string + description: | + The text content that is made searchable. If this is `null` then no additional content is used, and only the title and URL will be used. +start-at-home-feature: + description: This feature is for experimenting with opening screen + hasExposure: true + exposureDescription: '' + variables: + setting: + type: string + description: This property provides a default setting for the start at home feature + enum: + - afterFourHours + - always + - disabled +summarizer-app-attest-auth-feature: + description: | + This feature enables app attest authentication for the summarizer. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables app attest authentication for the summarizer. +summarizer-language-expansion-feature: + description: | + The feature flag to manage the rollout of the summarizer language expansion. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether the feature is enabled or not. + supportedLocales: + type: json + description: | + The list of supported locale identifiers for the summarizer language expansion according to BCP47 standard. i.e "en-US" for English (United States). +summarizer-permissive-guardrails-feature: + description: | + This feature enables permissive guardrails for the summarizer. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables permissive guardrails for the summarizer. +tab-scroll-refactor-feature: + description: | + The feature flag to manage the rollout of tab scroll refactor feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, tab scroll new implementation is used to show and hide toolbar views reacting to user scroll +tab-tray-ui-experiments: + description: | + The tab tray will undergo some UI experimentation to test potential improvements. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, enables the tab tray UI experiments. + iPad_update_enabled: + type: boolean + description: | + If true, enables the tab tray UI experiments on iPad. + translucency: + type: boolean + description: | + If true, enables translucency for tab tray actions at the bottom. +toolbar-refactor-feature: + description: | + This feature is for managing the roll out of the Toolbar refactor feature + hasExposure: true + exposureDescription: '' + variables: + layout: + type: string + description: | + The type of layout of the toolbars. + tab_tray_button_type: + type: string + description: | + The style of the tab tray button in the toolbar. + enum: + - number + - screenshot + unified_search: + type: boolean + description: | + Enables the unified search feature. +tos-feature: + description: | + This feature is for managing the roll out of the ToS (Term of Service) implementation + hasExposure: true + exposureDescription: '' + variables: + status: + type: boolean + description: | + Enables the feature +tou-feature: + description: | + This feature is for managing the rollout of the Terms of Use (ToU) implementation. + hasExposure: true + exposureDescription: '' + variables: + content-option: + type: string + description: | + Determines which predefined title and "learn more" strings are used for the Terms of Use prompt. + enum: + - value-0 + - value-1 + - value-2 + enable-drag-to-dismiss: + type: boolean + description: | + Whether to show a drag handle on the prompt and allows users to use it to dismiss the prompt. + max-reminders-count: + type: int + description: | + Maximum number of ToU bottom sheet reminders that can be displayed + status: + type: boolean + description: | + Enables the feature +translations-feature: + description: | + Enables translations feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable translations feature. + languagePickerEnabled: + type: boolean + description: | + Whether or not to enable the translations language picker (Phase 2). +trending-searches-feature: + description: | + Enables trending searches. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable trending searches. + max-suggestions: + type: int + description: The number of maximum suggestions. +vpn-feature: + description: | + Configuration feature for VPN + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled +wayback-machine-feature: + description: | + This property determines whether we show the wayback entry point on the native error pages + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled +web-view-document-fetch-refactor-feature: + description: | + Determines whether we read PDF and document data for sharing directly from the authenticated WebView, rather than re-downloading via URLSession. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not this feature is enabled diff --git a/experimenter/experimenter/features/manifests/ios/v156.1.0/release.fml.yaml b/experimenter/experimenter/features/manifests/ios/v156.1.0/release.fml.yaml new file mode 100644 index 0000000000..25887fe7e9 --- /dev/null +++ b/experimenter/experimenter/features/manifests/ios/v156.1.0/release.fml.yaml @@ -0,0 +1,1528 @@ +version: 1.0.0 +about: + description: The root level Feature Manifest for Firefox for iOS +channels: +- release +features: + ad-blocker-feature: + description: | + The feature flag to manage the roll out of the Ad Blocker badge in the Site Menu and the corresponding Block Ads toggle in Browsing settings. + variables: + badge-enabled: + description: | + Whether or not the Ad Blocker badge is shown in the Site Menu + type: Boolean + default: false + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + address-autofill-edit: + description: This property defines if the address editing is enabled in Settings + variables: + status: + description: If true, we will allow user to edit the address + type: Boolean + default: false + address-bar-gesture-to-open-tab-tray-feature: + description: | + Decides if the address bar interactive gesture to open the tab tray is enabled + variables: + enabled_closetab: + description: | + Decides if the interactive gesture can close tabs by dragging the tab up to the top edge of the screen + type: Boolean + default: false + enabled_interactive: + description: | + Decides if the interactive (fancier) version of this feature is enabled. + type: Boolean + default: false + enabled_swipe: + description: | + Decides if the swipe version of this feature is enabled. This will override the interactive gesture + type: Boolean + default: false + ai-kill-switch-feature: + description: | + Configuration feature for AI features + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: true + background-audio-feature: + description: | + The feature flag to manage the roll out of background audio playback, allowing media to continue playing when the app is backgrounded. + variables: + default-on: + description: | + The default state of the user-facing toggle when no preference has been set. Independent of enabled, which only controls whether the feature is available. + type: Boolean + default: false + enabled: + description: | + Whether or not this feature is available + type: Boolean + default: false + bookmarks-search-feature: + description: | + Configuration feature for the bookmarks search bar + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + cellular-data-restricted-error-page-feature: + description: | + Controls restricted cellular data guidance on error pages + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + custom-reader-mode-scheme-feature: + description: | + Use a custom WKURLSchemeHandler for reader mode + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + deeplink-optimization-refactor-feature: + description: | + The feature flag to manage the rollout of deeplink optimization feature. + variables: + enabled: + description: | + Variable description + type: Boolean + default: false + download-live-activities-feature: + description: | + Download Live Activities Feature + variables: + enabled: + description: | + If true, the download live activities feature is enabled + type: Boolean + default: false + firefox-jp-guide-default-site: + description: | + This feature is for managing the visibility of the Firefox Japanese Guide default suggested site shortcut + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + firefox-suggest-feature: + description: Configuration for the Firefox Suggest feature. + variables: + available-suggestions-types: + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + type: Map + default: + amp: true + ampMobile: false + wikipedia: true + status: + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. + type: Boolean + default: false + google-lens-feature: + description: | + The feature flag to manage the rollout of Google Lens entry points. + variables: + enabled: + description: | + Enables Google Lens entry points. + type: Boolean + default: false + homepage-redesign-feature: + description: | + This feature is for managing the roll out of the Homepage New Tab Redesign feature. + variables: + add-shortcut-tile: + description: | + If true, enables the add shortcut tile on homepage. + type: Boolean + default: false + bookmarks-section-default: + description: | + If true, enables the bookmarks homepage section by default + type: Boolean + default: false + categories-enabled: + description: | + If true, enables the categories flow in the stories + type: Boolean + default: false + jbi-section-default: + description: | + If true, enables the jump back in homepage section by default + type: Boolean + default: false + pinned-header-enabled: + description: | + If true, enables the pinned newsfeed header on homepage. + type: Boolean + default: false + search-bar: + description: | + If true, enables the search bar feature on homepage for users. + type: Boolean + default: false + homepage-tracker-blocker-module-feature: + description: | + Controls the Tracker Blocker module feature + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + hosted-summarizer-feature: + description: | + This feature enables the hosted summarizer feature. + variables: + enabled: + description: | + Enables the hosted summarizer feature. + type: Boolean + default: false + shakeGesture: + description: | + Enables the shake gesture for the summarizer feature. + type: Boolean + default: false + toolbarEntrypoint: + description: | + Enables the toolbar entrypoint for the summarizer feature. + type: Boolean + default: false + https-upgrade-feature: + description: | + This feature enables automatic https upgrade. This is only available for 18.2+. + variables: + enabled: + description: | + Enables automatic https upgrade. + type: Boolean + default: false + improved-app-store-review-trigger-feature: + description: | + The feature flag to manage the App Store review request trigger. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + messaging: + description: | + The in-app messaging system + documentation: + - name: User documentation + url: https://experimenter.info/messaging/mobile-messaging + contacts: + - jhugman@mozilla.com + - brennie@mozilla.com + - gbuciu@mozilla.com + - wteichmann@mozilla.com + events: + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_shown + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_clicked + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_expired + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_dismissed + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_malformed + variables: + actions: + description: A growable map of action URLs. + type: Map + default: + OPEN_SETTINGS: ://deep-link?url=settings/general + OPEN_SETTINGS_NEW_TAB: ://deep-link?url=settings/newtab + OPEN_SETTINGS_HOMESCREEN: ://deep-link?url=settings/homepage + OPEN_SETTINGS_WALLPAPERS: ://deep-link?url=settings/wallpaper + OPEN_SETTINGS_EMAIL: ://deep-link?url=settings/mailto + OPEN_SETTINGS_SEARCH_ENGINE: ://deep-link?url=settings/search + OPEN_SETTINGS_PRIVACY: ://deep-link?url=settings/clear-private-data + OPEN_SETTINGS_FXA: ://deep-link?url=settings/fxa + OPEN_SETTINGS_THEME: ://deep-link?url=settings/theme + OPEN_SETTINGS_APP_ICON: ://deep-link?url=settings/app-icon + OPEN_URL: ://open-url + VIEW_BOOKMARKS: ://deep-link?url=homepanel/bookmarks + VIEW_TOP_SITES: ://deep-link?url=homepanel/top-sites + VIEW_READING_LIST: ://deep-link?url=homepanel/reading-list + VIEW_HISTORY: ://deep-link?url=homepanel/history + VIEW_DOWNLOADS: ://deep-link?url=homepanel/downloads + ENABLE_PRIVATE_BROWSING: ://deep-link?url=homepanel/new-private-tab + OPEN_NEW_TAB: ://deep-link?url=homepanel/new-tab + MAKE_DEFAULT_BROWSER: ://deep-link?url=default-browser/system-settings + MAKE_DEFAULT_BROWSER_WITH_TUTORIAL: ://deep-link?url=default-browser/tutorial + OPEN_SHARE_SHEET: ://share-sheet + string-alias: ActionName + message-under-experiment: + description: 'Deprecated. Please use "experiment": "{experiment}" instead.' + type: Option + default: null + messages: + description: | + A growable collection of messages, where the Key is the message identifier and the value is its associated MessageData. + type: Map + default: {} + string-alias: MessageKey + on-control: + description: What should be displayed when a control message is selected. + type: ControlMessageBehavior + default: show-next-message + styles: + description: | + A map of styles to configure message appearance. + type: Map + default: + FALLBACK: + priority: 40 + max-display-count: 20 + DEFAULT: + priority: 50 + max-display-count: 5 + MICROSURVEY: + priority: 50 + max-display-count: 1 + NOTIFICATION: + priority: 50 + max-display-count: 1 + PERSISTENT: + priority: 50 + max-display-count: 20 + SURVEY: + priority: 55 + max-display-count: 10 + WARNING: + priority: 60 + max-display-count: 10 + URGENT: + priority: 100 + max-display-count: 10 + string-alias: StyleName + triggers: + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + USER_RECENTLY_INSTALLED: days_since_install < 7 + USER_RECENTLY_UPDATED: days_since_update < 7 && days_since_install != days_since_update + USER_TIER_ONE_COUNTRY: ('US' in locale || 'GB' in locale || 'CA' in locale || 'DE' in locale || 'FR' in locale) + USER_EN_SPEAKER: '''en'' in locale' + USER_ES_SPEAKER: '''es'' in locale' + USER_DE_SPEAKER: '''de'' in locale' + USER_FR_SPEAKER: '''fr'' in locale' + DEVICE_ANDROID: os == 'Android' + DEVICE_IOS: os == 'iOS' + DAY_1_AFTER_INSTALL: days_since_install == 1 + DAY_2_AFTER_INSTALL: days_since_install == 2 + DAY_3_AFTER_INSTALL: days_since_install == 3 + DAY_4_AFTER_INSTALL: days_since_install == 4 + DAY_5_AFTER_INSTALL: days_since_install == 5 + MORE_THAN_24H_SINCE_INSTALLED_OR_UPDATED: days_since_update >= 1 + NOT_LAUNCHED_YESTERDAY: '''app_cycle.foreground''|eventLastSeen(''Days'', 1) > 1' + AFTER_THREE_LAUNCHES_THIS_WEEK: '''app_cycle.foreground''|eventSum(''Weeks'', 1, 0) >= 3' + I_AM_DEFAULT_BROWSER: is_default_browser + I_AM_NOT_DEFAULT_BROWSER: is_default_browser == false + SUPPORTS_DEFAULT_BROWSER: os_version|versionCompare('14.!') >= 0 + INACTIVE_NEW_USER: is_inactive_new_user + ALLOWED_TIPS_NOTIFICATIONS: allowed_tips_notifications + FXA_CURRENTLY_SIGNED_IN: is_fxa_signed_in == true + SECOND_HOMEPAGE_VIEW: '''homepage_viewed''|eventSum(''Years'', 4, 0) >= 2' + ON_FOURTH_LAUNCH_THIS_YEAR: '''app_cycle.foreground''|eventSum(''Years'', 1, 0) > 3' + string-alias: TriggerName + ~~experiment: + description: Not to be set by experiment. + type: ExperimentSlug + default: '{experiment}' + string-alias: ExperimentSlug + allow-coenrollment: true + microsurvey-feature: + description: | + A feature that shows the microsurvey for users to interact with and submit responses. + variables: + enabled: + description: | + If true, the feature is active. + type: Boolean + default: false + native-error-page-feature: + description: | + This feature is for managing the roll out of the native error page feature + variables: + bad-cert-domain-error-page: + description: | + This feature is for managing the roll out of the bad certificate domain native error page + type: Boolean + default: false + enabled: + description: | + If true, the feature is active. + type: Boolean + default: false + no_internet_connection_error: + description: | + This feature is for managing the roll out of the no interet connection native error page feature + type: Boolean + default: false + new-bookmark-folder-tree-feature: + description: | + This property determines weather we show the new bookmark folder tree UI + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + nova-design-feature: + description: | + The feature flag to manage the rollout of Nova design. + variables: + enabled: + description: | + Enables Nova design. + type: Boolean + default: false + onboarding-framework-feature: + description: | + The new onboarding framework feature that will allow onboarding to be experimentable through initial experiments. + variables: + cards: + description: | + The list of available cards for onboarding. + type: Map + default: + welcome-modern: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.Welcome.Title.v140 + body: Onboarding/Onboarding.Modern.Welcome.Description.v140 + image: trackers + buttons: + primary: + title: Onboarding/Onboarding.Modern.Welcome.ActionTreatementA.v140 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.Welcome.Skip.v140 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + sign-to-sync-modern: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.Sync.Title.v140 + body: Onboarding/Onboarding.Modern.Sync.Description.v140 + image: sync-with-icons + buttons: + primary: + title: Onboarding/Onboarding.Modern.Sync.SignIn.Action.v140 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.Sync.Skip.Action.v140 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-toolbar-modern: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Title.v140 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v140 + image: toolbar-bottom + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v140 + image: toolbar-top + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-theme-modern: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Customization.Theme.Title.v143 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Theme.System.Action.v123 + image: theme-system + action: theme-system-default + - title: Onboarding/Onboarding.Customization.Theme.Light.Action.v123 + image: theme-light + action: theme-light + - title: Onboarding/Onboarding.Customization.Theme.Dark.Action.v123 + image: theme-dark + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + welcome-modern-japan: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.Welcome.Title.v145 + body: Onboarding/Onboarding.Modern.Welcome.Description.v145 + image: trackers-japan + buttons: + primary: + title: Onboarding/Onboarding.Modern.Welcome.ActionTreatmentA.v145 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.Welcome.Skip.v145 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + sign-to-sync-modern-japan: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.Sync.Title.v145 + body: Onboarding/Onboarding.Modern.Sync.Description.v145 + image: sync-with-icons-japan + buttons: + primary: + title: Onboarding/Onboarding.Modern.Sync.SignIn.Action.v145 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.Sync.Skip.Action.v145 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + customization-toolbar-modern-japan: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Title.v145 + body: Onboarding/Onboarding.Modern.Customization.Toolbar.Description.v145 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Continue.Action.v145 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v145 + image: toolbar-bottom-japan + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v145 + image: toolbar-top-japan + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + customization-theme-modern-japan: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Modern.Customization.Theme.Title.v145 + body: Onboarding/Onboarding.Modern.Customization.Theme.Description.v145 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Continue.Action.v145 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Theme.Automatic.v145 + image: theme-system-japan + action: theme-system-default + - title: Onboarding/Onboarding.Modern.Customization.Theme.Light.v145 + image: theme-light-japan + action: theme-light + - title: Onboarding/Onboarding.Modern.Customization.Theme.Dark.v145 + image: theme-dark-japan + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: japan + welcome-brand-refresh: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.TitleV3.v149 + body: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.Description.v148 + image: trackers-brand-refresh + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.ActionTreatmentA.v148 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Welcome.Skip.v148 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + customization-toolbar-brand-refresh: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Toolbar.Title.v148 + body: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Toolbar.Description.v148 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Toolbar.Continue.Action.v148 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v140 + image: toolbar-bottom-japan + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v140 + image: toolbar-top-japan + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + customization-theme-brand-refresh: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Title.v148 + body: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Description.v148 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Continue.Action.v148 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Automatic.v148 + image: theme-system-japan + action: theme-system-default + - title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Light.v148 + image: theme-light-japan + action: theme-light + - title: Onboarding/Onboarding.Modern.BrandRefresh.Customization.Theme.Dark.v148 + image: theme-dark-japan + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + sign-to-sync-brand-refresh: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.BrandRefresh.Sync.Title.v148 + body: Onboarding/Onboarding.Modern.BrandRefresh.Sync.Description.v148 + image: sync-with-icons-brand-refresh + buttons: + primary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Sync.SignIn.Action.v148 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.BrandRefresh.Sync.Skip.Action.v148 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: brandRefresh + string-alias: NimbusOnboardingCardKey + conditions: + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + string-alias: ConditionName + dismissable: + description: | + Whether or not the entire onboarding is dismissable by pressing an X at the top right corner of the screen. + type: Boolean + default: true + enable-modern-ui: + description: | + Toggle between legacy (false) and modern (true) UI variants. + type: Boolean + default: true + enable-video-intro: + description: | + When true, a full-screen video is displayed before the Terms of Service screen during fresh-install onboarding. + type: Boolean + default: false + should-use-brand-refresh-configuration: + description: | + Toggle between standard (false) and brand refresh (true) onboarding content. + type: Boolean + default: true + should-use-japan-configuration: + description: | + Toggle between standard (false) and Japan-specific (true) assets and content. + type: Boolean + default: false + privacy-dashboard-feature: + description: | + The Privacy Dashboard feature from homepage + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + quick-answers-feature: + description: | + The feature flag to manage the roll out of the quick answers feature. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + model: + description: | + Which provider model backs Quick Answers. + type: QuickAnswersModel + default: exa + recent-searches-feature: + description: | + Enables recent searches. + variables: + enabled: + description: | + Whether or not to enable recent searches. + type: Boolean + default: false + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 5 + relay-integration-feature: + description: | + This feature is for managing the roll out of Relay email masking integration in iOS + variables: + enabled: + description: | + Enables the feature + type: Boolean + default: true + report-broken-site-feature: + description: | + In-app Report Broken Site (WebCompat) reporter + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + search: + description: | + Configuring the functionality to do with search. This will be separated into smaller sub-features in later releases. + variables: + awesome-bar: + description: Configuring the awesome bar. + type: AwesomeBar + default: + min-search-term: 3 + search-highlights: false + use-page-content: false + sent-from-firefox-feature: + description: | + Adds additional promo text to links shared to WhatsApp. + variables: + enabled: + description: | + Controls whether promo text is added to WhatsApp shares and an on/off toggle is added to Settings. + type: Boolean + default: false + isTreatmentA: + description: | + If true, shares the treatment A text. If false, shares the treatment B text. + type: Boolean + default: true + spotlight-search: + description: Add pages as items findable with Spotlight. + variables: + enabled: + description: If this is true, then on each page load adds a new item to Spotlight. + type: Boolean + default: false + icon-type: + description: | + The icon that is displayed next to the item in the search results. If this is `null`, then no icon is displayed. + type: Option + default: letter + keep-for-days: + description: | + Number of days to keep the item before automatic deletion. If this is left `null`, then it is left to iOS's default. + type: Option + default: null + searchable-content: + description: | + The text content that is made searchable. If this is `null` then no additional content is used, and only the title and URL will be used. + type: Option + default: text-excerpt + start-at-home-feature: + description: This feature is for experimenting with opening screen + variables: + setting: + description: This property provides a default setting for the start at home feature + type: StartAtHome + default: disabled + summarizer-app-attest-auth-feature: + description: | + This feature enables app attest authentication for the summarizer. + variables: + enabled: + description: | + Enables app attest authentication for the summarizer. + type: Boolean + default: true + summarizer-language-expansion-feature: + description: | + The feature flag to manage the rollout of the summarizer language expansion. + variables: + enabled: + description: | + Whether the feature is enabled or not. + type: Boolean + default: true + supportedLocales: + description: | + The list of supported locale identifiers for the summarizer language expansion according to BCP47 standard. i.e "en-US" for English (United States). + type: List + default: + - en + - it + - fr + - es + - de + - pt + - ja + - jp + summarizer-permissive-guardrails-feature: + description: | + This feature enables permissive guardrails for the summarizer. + variables: + enabled: + description: | + Enables permissive guardrails for the summarizer. + type: Boolean + default: false + tab-scroll-refactor-feature: + description: | + The feature flag to manage the rollout of tab scroll refactor feature. + variables: + enabled: + description: | + If true, tab scroll new implementation is used to show and hide toolbar views reacting to user scroll + type: Boolean + default: false + tab-tray-ui-experiments: + description: | + The tab tray will undergo some UI experimentation to test potential improvements. + variables: + enabled: + description: | + If true, enables the tab tray UI experiments. + type: Boolean + default: true + iPad_update_enabled: + description: | + If true, enables the tab tray UI experiments on iPad. + type: Boolean + default: false + translucency: + description: | + If true, enables translucency for tab tray actions at the bottom. + type: Boolean + default: false + toolbar-refactor-feature: + description: | + This feature is for managing the roll out of the Toolbar refactor feature + variables: + layout: + description: | + The type of layout of the toolbars. + type: Option + default: version1 + tab_tray_button_type: + description: | + The style of the tab tray button in the toolbar. + type: TabTrayButtonType + default: number + unified_search: + description: | + Enables the unified search feature. + type: Boolean + default: false + tos-feature: + description: | + This feature is for managing the roll out of the ToS (Term of Service) implementation + variables: + status: + description: | + Enables the feature + type: Boolean + default: true + tou-feature: + description: | + This feature is for managing the rollout of the Terms of Use (ToU) implementation. + variables: + content-option: + description: | + Determines which predefined title and "learn more" strings are used for the Terms of Use prompt. + type: TermsOfUsePromptContentOption + default: value-0 + enable-drag-to-dismiss: + description: | + Whether to show a drag handle on the prompt and allows users to use it to dismiss the prompt. + type: Boolean + default: true + max-reminders-count: + description: | + Maximum number of ToU bottom sheet reminders that can be displayed + type: Int + default: 2 + status: + description: | + Enables the feature + type: Boolean + default: false + translations-feature: + description: | + Enables translations feature. + variables: + enabled: + description: | + Whether or not to enable translations feature. + type: Boolean + default: true + languagePickerEnabled: + description: | + Whether or not to enable the translations language picker (Phase 2). + type: Boolean + default: true + trending-searches-feature: + description: | + Enables trending searches. + variables: + enabled: + description: | + Whether or not to enable trending searches. + type: Boolean + default: false + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 5 + vpn-feature: + description: | + Configuration feature for VPN + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + wayback-machine-feature: + description: | + This property determines whether we show the wayback entry point on the native error pages + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false + web-view-document-fetch-refactor-feature: + description: | + Determines whether we read PDF and document data for sharing directly from the authenticated WebView, rather than re-downloading via URLSession. + variables: + enabled: + description: | + Whether or not this feature is enabled + type: Boolean + default: false +enums: + ControlMessageBehavior: + description: An enum to influence what should be displayed when a control message is selected. + variants: + show-next-message: + description: The next eligible message should be shown. + show-none: + description: The surface should show no message. + IconType: + description: The icon that will be added to the item in the device's search engine. + variants: + favicon: + description: The favicon of the page + letter: + description: An icon generated from the first letter of the base domain. + screenshot: + description: A screenshot of the page at load time. + MessageSurfaceId: + description: | + For messaging, we would like to have a message tell us which surface its associated with. This is a label that matches across both Android and iOS. + variants: + Unknown: + description: A message has NOT declared its target surface. + microsurvey: + description: This is a microsurvey that appears on top of the bottom toolbar to the user. + new-tab-card: + description: This is the card that appears at the top on the Firefox Home Page. + notification: + description: This is a local notification send to the user periodically with tips and updates. + survey: + description: This is a full-page that appears providing a survey to the user. + NimbusOnboardingHeaderImage: + description: | + The identifiers for the different images available for cards in onboarding + variants: + customize-firefox: + description: | + Corresponding to the fox window image + notifications: + description: | + Corresponding to the notifications image + search-widget: + description: | + Corresponding to the fox search widget image + set-default-steps: + description: | + Corresponding to the set to default steps image + set-to-dock: + description: | + Corresponding to the set to dock image + sync-devices: + description: | + Corresponding to the sync-devices image + sync-with-icons: + description: | + Corresponding to the sync-devices image + sync-with-icons-brand-refresh: + description: | + Corresponding to the sync-with-icons image for Brand Refresh variant (different from Japan variant) + sync-with-icons-japan: + description: | + Corresponding to the sync-with-icons image for Japan variant + themeing: + description: | + Corresponding to the fox world image + toolbar: + description: | + Corresponding to the fox world image + trackers: + description: | + Corresponding to the trackers image + trackers-brand-refresh: + description: | + Corresponding to the trackers image for Brand Refresh variant (does not contain Japanese text, different from Japan variant) + trackers-japan: + description: | + Corresponding to the trackers image for Japan variant (contains Japanese text) + welcome-globe: + description: | + Corresponding to the fox world image + NimbusOnboardingMultipleChoiceButtonImage: + description: | + The identifiers for the different images available for multiple choice buttons in onboarding + variants: + theme-dark: + description: | + Corresponding to the dark theme + theme-dark-japan: + description: | + Corresponding to the dark theme image for Japan variant. Also used by Brand Refresh variant as the images are identical. + theme-light: + description: | + Corresponding to the light theme + theme-light-japan: + description: | + Corresponding to the light theme image for Japan variant. Also used by Brand Refresh variant as the images are identical. + theme-system: + description: | + Corresponding to the system theme + theme-system-japan: + description: | + Corresponding to the system theme image for Japan variant. Also used by Brand Refresh variant as the images are identical. + toolbar-bottom: + description: | + Corresponding to the toolbar on the bottom + toolbar-bottom-japan: + description: | + Corresponding to the toolbar on the bottom image for Japan variant. Also used by Brand Refresh variant as the images are identical. + toolbar-top: + description: | + Corresponding to the toolbar on top + toolbar-top-japan: + description: | + Corresponding to the toolbar on top image for Japan variant. Also used by Brand Refresh variant as the images are identical. + OnboardingActions: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + end-onboarding: + description: | + Will end the onboarding on a set card + forward-one-card: + description: | + Will take the user to the next card + forward-three-card: + description: | + Will take the user to the next card + forward-two-card: + description: | + Will take the user to the next card + open-instructions-popup: + description: | + Will open up a popup with instructions for something + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + read-privacy-policy: + description: | + Will open a webview where the user can read the privacy policy + request-notifications: + description: | + Will request to allow notifications from the user + set-default-browser: + description: | + Will send the user to settings to set Firefox as their default browser and advance to next card + sync-sign-in: + description: | + Will take the user to the sync sign in flow + OnboardingCardType: + description: | + The identifiers for the different types of onboarding cards. + variants: + basic: + description: | + Corresponding to basic info onboarding cards + multiple-choice: + description: | + Corresponding to onboarding cards with multiple choice buttons + OnboardingInstructionsPopupActions: + description: | + The identifiers for the different actions available for the instruction card in onboarding + variants: + dismiss: + description: | + Will dismiss the popup + dismiss-and-next-card: + description: | + Will dismiss the popup and move to the next card + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + OnboardingMultipleChoiceAction: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + theme-dark: + description: | + Will will set the theme to dark mode + theme-light: + description: | + Will set the theme to light mode + theme-system-default: + description: | + Will set the theme to use the system theme + toolbar-bottom: + description: | + Will set the toolbar on the bottom + toolbar-top: + description: | + Will set the toolbar on the top + OnboardingType: + description: | + The identifiers for the different types of onboarding cards. + variants: + fresh-install: + description: | + Corresponding to onboarding cards that are for new users + OnboardingVariant: + description: | + Which UI style this onboarding card is designed for. + variants: + brandRefresh: + description: Use the brand refresh onboarding UI with v148 strings. + japan: + description: Use the Japan-specific onboarding UI with localized assets. + modern: + description: Use the new (modern) onboarding UI. + PageContent: + description: The page content that will be added as an item in the device's search engine. + variants: + html-content: + description: Use all the page as HTML + text-content: + description: Use all the page as text + text-excerpt: + description: Only use the first paragraph + QuickAnswersModel: + description: The provider model that backs the Quick Answers feature. + variants: + exa: + description: The Exa model provider. + liner: + description: The Liner model provider. + StartAtHome: + description: The option for what screen to open the app to + variants: + afterFourHours: + description: Starts the app at the homepage after four hours of inactivity, otherwise starts the app at the most recently viewed tab. + always: + description: Starts the app at the homepage. + disabled: + description: Starts the app at the most recently viewed tab. + SuggestionType: + description: The type of a Firefox Suggest search suggestion. + variants: + amp: + description: A Firefox Suggestion for desktop from adMarketplace. + ampMobile: + description: A Firefox Suggestion specifically for mobile from adMarketplace. + wikipedia: + description: A Firefox Suggestion for a Wikipedia page. + TabTrayButtonType: + description: The style of the tab tray button in the toolbar. + variants: + number: + description: The original tab tray button style that show the icon with the number of tabs. + screenshot: + description: The new tab tray button style that shows two images stacked with the previous and next tab. + TermsOfUsePromptContentOption: + description: | + Determines which predefined title and "learn more" strings are used for the Terms of Use prompt. + variants: + value-0: + description: | + Uses the current defaults: + - Title: "We've got an update" + - Learn more: "Please take a moment to review and accept. Learn more." + value-1: + description: | + Uses the following copy: + - Title: "Terms of Use" + - Learn more: "You can learn more here." + value-2: + description: | + Uses the following copy: + - Title: "A note from Firefox" + - Learn more: "You can learn more here." + ToolbarLayoutType: + description: The type of toolbar layout. + variants: + version1: + description: Shows the add new tab, menu and tabs button in the navigation toolbar. The share button is displayed in the address toolbar. + version2: + description: Like version1 but the menu and tabs buttons are inverted. +objects: + AwesomeBar: + description: A configuration option for the awesome bar. Part of the `search` feature. + fields: + min-search-term: + description: The minimum number of characters that the user types before searching in the page. + type: Int + default: 3 + search-highlights: + description: Whether or not search highlights are enabled + type: Boolean + default: false + use-page-content: + description: Search in the open tab's text content when typing. + type: Boolean + default: false + MessageData: + description: | + An object to describe a message. It uses human readable strings to describe the triggers, action and style of the message as well as the text of the message and call to action. + fields: + action: + description: | + The name of a deeplink URL to be opened if the button is clicked. + type: Option + default: null + action-params: + description: Query parameters appended to the deeplink action URL + type: Map + default: {} + button-label: + description: | + The text on the button. If no text is present, the whole message is clickable. + type: Option + default: null + except-if-any: + description: | + A list of strings corresponding to targeting expressions. If any of these expressions evaluate to `true`, the message will not be eligible. + type: List + default: [] + experiment: + description: The experiment slug that this message is involved in. + type: Option + default: null + is-control: + description: Indicates if this message is the control message, if true shouldn't be displayed + type: Boolean + default: false + microsurveyConfig: + description: Optional configuration data for a microsurvey. + type: Option + default: null + should-randomize-options: + description: | + Will randomize the provided MicrosurveyConfig options + type: Boolean + default: false + style: + description: | + The style as described in a `StyleData` from the styles table. + type: StyleName + default: DEFAULT + surface: + description: Each message will tell us the surface it is targeting with this. + type: MessageSurfaceId + default: Unknown + text: + description: The message text displayed to the user + type: Text + default: '' + title: + description: The title text displayed to the user + type: Option + default: null + trigger-if-all: + description: | + A list of strings corresponding to targeting expressions. All named expressions must evaluate to true if the message is to be eligible to be shown. + type: List + default: + - ALWAYS + MicrosurveyConfig: + description: | + Attributes relating to microsurvey messaging. + fields: + icon: + description: The asset name in our bundle used as the icon shown in the survey. + type: Image + default: lightbulbLarge + options: + description: The list of survey options to present to the user. + type: List + default: [] + utm-content: + description: The name used to provide as the utm_content parameter for the privacy notice. + type: Option + default: null + NimbusOnboardingButton: + description: | + A group of properties describing the attributes of a card. + fields: + action: + description: | + The action the button should take. The default for this will be "forward-one-card" + type: OnboardingActions + default: forward-one-card + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingButtons: + description: | + A set of buttons for the card. There can be up to two, but there must be at least one. + fields: + primary: + description: | + The primary button for the card. This must exist. + type: NimbusOnboardingButton + default: + title: Primary Button + action: forward-one-card + secondary: + description: | + A secondary, optional, button for the card. + type: Option + default: null + NimbusOnboardingCardData: + description: | + A group of properties describing the attributes of a card. + fields: + body: + description: | + The body text displayed on the card, in less prominent text. This should never be defaulted. + type: Text + default: '' + buttons: + description: | + The set of buttons associated with the card. + type: NimbusOnboardingButtons + default: + primary: + title: Onboarding/Onboarding.Sync.Skip.Action.v114 + action: forward-one-card + secondary: null + card-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingCardType + default: basic + disqualifiers: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will not be shown if any expression is `true`. + type: List + default: [] + image: + description: | + The image that should be displayed on the card. + type: NimbusOnboardingHeaderImage + default: welcome-globe + instructions-popup: + description: | + The object describing the specific instruction popup button for a card. If left empty, the card will have no instruction popup information + type: Option + default: null + link: + description: | + The object describing the link button for a card. If left empty, the card will have no link. + type: Option + default: null + multiple-choice-buttons: + description: | + A list of multiple choice buttons that the card will display + type: List + default: [] + onboarding-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingType + default: fresh-install + order: + description: | + The place in the order where the card will be found. The feature layer will then sort the cards based on this field. + type: Int + default: 10 + prerequisites: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will be shown if all expressions `true` and if no expressions in the `disqualifiers` table are true, or if the `disqualifiers` table is empty. + type: List + default: [] + title: + description: | + The title displayed on the card, in prominent, bolded text. This should never be defaulted. + type: Text + default: '' + uiVariant: + description: | + If set, this card will only be shown in the specified UI variant. If null, it will appear in both legacy and modern UIs. + type: Option + default: null + NimbusOnboardingInstructionPopup: + description: | + The object outlining the content of the instruction card. + fields: + button-action: + description: | + The action the button should have. Default is `dismiss-and-next-card` + type: OnboardingInstructionsPopupActions + default: dismiss-and-next-card + button-title: + description: | + The title the button should have. This should never be defaulted. + type: Text + default: '' + instructions: + description: | + A list of instructions, either as free text, or as Text identifiers. + type: List + default: [] + title: + description: | + The text of the popup. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingLink: + description: | + A group of properties describing the attributes for the active link on a card + fields: + title: + description: | + The text of the link title. + type: Text + default: Onboarding/Onboarding.Welcome.Link.Action.v114 + url: + description: | + The url that the link will lead to. + type: String + default: https://www.mozilla.org/privacy/firefox/ + NimbusOnboardingMultipleChoiceButton: + description: | + A group of properties describing the attributes of a multiple choice button on a card + fields: + action: + description: | + The action the button should take. The default for this will be "theme-system-default" + type: OnboardingMultipleChoiceAction + default: theme-system-default + image: + description: | + The text of the button title. This should never be defaulted. + type: NimbusOnboardingMultipleChoiceButtonImage + default: theme-system + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + StyleData: + description: | + A group of properties (predominantly visual) to the describe style of the message. + fields: + max-display-count: + description: | + How many sessions will this message be shown to the user before it is expired. + type: Int + default: 5 + priority: + description: | + The importance of this message. 0 is not very important, 100 is very important. + type: Int + default: 50