diff --git a/experimenter/experimenter/features/manifests/fenix/.ref-cache.yaml b/experimenter/experimenter/features/manifests/fenix/.ref-cache.yaml index 03ad6224c5..0a79fd0a2a 100644 --- a/experimenter/experimenter/features/manifests/fenix/.ref-cache.yaml +++ b/experimenter/experimenter/features/manifests/fenix/.ref-cache.yaml @@ -1,3 +1,3 @@ -beta: b5de2da6c08eb4e7b42048ebf51f49025e0efdbd -master: 6dfb106093fadbbff0697fc7d58b80cad806ad40 -release: 31c15d6d5d93f356ba1e880d406d88a13fdc9505 +beta: 4f050b1b46879366dc6115834a2ecf02bab26298 +master: edd0dabd15258d34eea2f6465d4a5f27a66c1198 +release: d8bc7017b6fe57ead8a56c38782852d85c38d6bd diff --git a/experimenter/experimenter/features/manifests/fenix/v133.0.1/beta.fml.yaml b/experimenter/experimenter/features/manifests/fenix/v133.0.1/beta.fml.yaml new file mode 100644 index 0000000000..2abec1698f --- /dev/null +++ b/experimenter/experimenter/features/manifests/fenix/v133.0.1/beta.fml.yaml @@ -0,0 +1,910 @@ +--- +version: 1.0.0 +about: + description: Nimbus Feature Manifest for Fenix (Firefox Android) +channels: + - beta +features: + 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.\n" + type: Boolean + default: false + 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.\n" + type: "Map" + default: + amp: true + ampMobile: false + wikipedia: true + bookmarks: + description: Feature for Bookmarks + variables: + new-compose-ui: + description: "if true, enable new compose based UI" + type: Boolean + default: false + cookie-banners: + description: Features for cookie banner handling. + variables: + sections-enabled: + description: This property provides a lookup table of whether or not the given section should be enabled. + type: "Map" + default: + feature-ui: 1 + feature-setting-value: 0 + feature-setting-value-pbm: 1 + feature-setting-detect-only: 0 + feature-setting-global-rules: 1 + feature-setting-global-rules-sub-frames: 1 + 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.\n" + type: Boolean + default: false + enabled-private: + description: "Enables / disables fingerprinting protection in private browsing mode.\n" + type: Boolean + default: true + fdlibm-math: + description: "Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy\n" + type: Boolean + default: false + overrides: + description: "The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets.\n" + type: String + default: "" + 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.\n" + type: Boolean + default: false + fx-suggest: + description: A feature that provides Firefox Suggest search suggestions. + variables: + 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.\n" + type: Boolean + default: false + 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 + metrics-enabled: + description: "A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric." + type: "Map" + default: {} + 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 + growth-data: + description: A feature measuring campaign growth data + variables: + enabled: + description: "If true, the feature is active" + 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 + juno-onboarding: + description: A feature that shows the onboarding flow. + variables: + cards: + description: Collection of user facing onboarding cards. + type: "Map" + default: + default-browser: + add-ons-data: [] + body: juno_onboarding_default_browser_description_nimbus_3 + card-type: default-browser + disqualifiers: + - NEVER + enabled: true + image-res: ic_onboarding_welcome + ordering: 10 + prerequisites: + - ALWAYS + primary-button-label: juno_onboarding_default_browser_positive_button + secondary-button-label: juno_onboarding_default_browser_negative_button + title: juno_onboarding_default_browser_title_nimbus_2 + add-search-widget: + add-ons-data: [] + body: juno_onboarding_add_search_widget_description + card-type: add-search-widget + disqualifiers: + - NEVER + enabled: true + image-res: ic_onboarding_search_widget + ordering: 15 + prerequisites: + - ALWAYS + primary-button-label: juno_onboarding_add_search_widget_positive_button + secondary-button-label: juno_onboarding_add_search_widget_negative_button + title: juno_onboarding_add_search_widget_title + sync-sign-in: + add-ons-data: [] + body: juno_onboarding_sign_in_description_3 + card-type: sync-sign-in + disqualifiers: + - NEVER + enabled: true + image-res: ic_onboarding_sync + ordering: 20 + prerequisites: + - ALWAYS + primary-button-label: juno_onboarding_sign_in_positive_button + secondary-button-label: juno_onboarding_sign_in_negative_button + title: juno_onboarding_sign_in_title_2 + notification-permission: + add-ons-data: [] + body: juno_onboarding_enable_notifications_description_nimbus_2 + card-type: notification-permission + disqualifiers: + - NEVER + enabled: true + image-res: ic_notification_permission + ordering: 30 + prerequisites: + - ALWAYS + primary-button-label: juno_onboarding_enable_notifications_positive_button + secondary-button-label: juno_onboarding_enable_notifications_negative_button + title: juno_onboarding_enable_notifications_title_nimbus_2 + 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.\n" + type: "Map" + default: + ALWAYS: "true" + NEVER: "false" + string-alias: ConditionName + menu-redesign: + description: Control the new menu redesign. + variables: + enabled: + description: "If true, the new menu redesign is available." + type: Boolean + default: false + messaging: + description: "The in-app messaging system.\n" + 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.\n\nThis should not be written to by experiments, and should be hidden to users.\n" + 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_DELETE_BROWSING_DATA: "://settings_delete_browsing_data" + OPEN_SETTINGS_LOGINS: "://settings_logins" + OPEN_SETTINGS_NOTIFICATIONS: "://settings_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: "://settings" + OPEN_SHARE_SHEET: "://share_sheet" + 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: ~ + 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.\n" + 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.\n" + 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 + FUNNEL_PAID: "adjust_campaign != ''" + FUNNEL_ORGANIC: "adjust_campaign == ''" + INACTIVE_1_DAY: "'app_launched'|eventLastSeen('Hours') >= 24" + INACTIVE_2_DAYS: "'app_launched'|eventLastSeen('Days', 0) >= 2" + INACTIVE_3_DAYS: "'app_launched'|eventLastSeen('Days', 0) >= 3" + INACTIVE_4_DAYS: "'app_launched'|eventLastSeen('Days', 0) >= 4" + INACTIVE_5_DAYS: "'app_launched'|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_launched'|eventCountNonZero('Days', 28) >= 1 && 'app_launched'|eventCountNonZero('Days', 28) < 7" + USER_CASUAL: "'app_launched'|eventCountNonZero('Days', 28) >= 7 && 'app_launched'|eventCountNonZero('Days', 28) < 14" + USER_REGULAR: "'app_launched'|eventCountNonZero('Days', 28) >= 14 && 'app_launched'|eventCountNonZero('Days', 28) < 21" + USER_CORE_ACTIVE: "'app_launched'|eventCountNonZero('Days', 28) >= 21" + LAUNCHED_ONCE_THIS_WEEK: "'app_launched'|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.\n" + type: Boolean + default: true + mr2022: + description: Features for MR 2022. + variables: + sections-enabled: + description: This property provides a lookup table of whether or not the given section should be enabled. + type: "Map" + default: + home-onboarding-dialog-existing-users: true + sync-cfr: true + wallpapers-selection-tool: true + jump-back-in-cfr: true + tcp-cfr: true + tcp-feature: true + navigation-toolbar: + description: Feature for navigation toolbar. + variables: + enabled: + description: "When the feature is enabled then the user will see the new navigation toolbar.\n" + type: Boolean + default: false + networking: + description: Enables networking features + variables: + fetchPriorityEnabled: + description: "Enables or disables network.fetchpriority.enabled preference.\n" + type: Boolean + default: true + nimbus-is-ready: + description: "A feature that provides the number of Nimbus is_ready events to send when Nimbus finishes launching.\n" + variables: + event-count: + description: The number of events that should be sent. + type: Int + default: 1 + nimbus-system: + description: "Configuration of the Nimbus System in Android.\n" + variables: + refresh-interval-foreground: + description: "The minimum interval in minutes between fetching experiment\nrecipes in the foreground.\n" + 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 + 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 + 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 + print: + description: A feature for printing from the share or browser menu. + variables: + browser-print-enabled: + description: "If true, a print button from the browser menu is available." + type: Boolean + default: true + share-print-enabled: + description: "If true, a print button from the share menu is available." + type: Boolean + default: true + private-browsing: + description: Private Browsing Mode + variables: + felt-privacy-enabled: + description: "if true, enable felt privacy related UI" + type: Boolean + default: false + query-parameter-stripping: + description: Features for query parameter stripping. + variables: + sections-enabled: + description: This property provides a lookup table of whether or not the given section should be enabled. + type: "Map" + default: + query-parameter-stripping: "0" + query-parameter-stripping-pmb: "0" + query-parameter-stripping-allow-list: "" + query-parameter-stripping-strip-list: "" + re-engagement-notification: + description: A feature that shows the re-engagement notification if the user is inactive. + variables: + enabled: + description: "If true, the re-engagement notification is shown to the inactive user." + type: Boolean + default: false + type: + description: The type of re-engagement notification that is shown to the inactive user. + type: Int + default: 0 + remote-tab-management: + description: "Features that let users manage tabs on other devices that are connected to the same Mozilla account.\n" + 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.\n" + type: Boolean + default: true + 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-term-groups: + description: A feature allowing the grouping of URLs around the search term that it came from. + variables: + enabled: + description: "If true, the feature shows up on the homescreen and on the new tab screen." + type: Boolean + default: false + set-as-default-prompt: + description: "Displays native default browser prompt to existing users.\n" + variables: + app-cold-starts-between-prompts: + description: "Minimum number of app cold starts before the next prompt should be displayed to the user.\n" + type: Int + default: 4 + days-between-prompts: + description: "Minimum number of days between displays of Set as default prompt.\n" + type: Int + default: 14 + enabled: + description: "When the feature is enabled then the Set as default prompt can be triggered for existing users.\n" + type: Boolean + default: true + max-number-of-times-to-display: + description: "Maximum number of time the prompt should be displayed.\n" + type: Int + default: 3 + ship: + description: The feature that controls Session History in Parent (SHIP) in Gecko. + variables: + disabled: + description: "Whether or not to disable SHIP. SHIP is enabled when set to false. SHIP is disabled when set to true.\n" + type: Boolean + default: true + shopping-experience: + description: A feature that shows product review quality information. + variables: + enabled: + description: "if true, the shopping experience feature is shown to the user." + type: Boolean + default: false + product-recommendations: + description: "if true, recommended products feature is enabled to be shown to the user based on their preference." + type: Boolean + default: false + product-recommendations-exposure: + description: "if true, we want to record recommended products inventory for opted-in users, even if product recommendations are disabled." + type: Boolean + default: false + 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 + suggest-shipped-domains: + description: Feature that suggests domains from the shipped domain list. + variables: + enabled: + description: "Suggest domains from the shipped domain list.\n" + type: Boolean + default: true + 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.\n" + type: Boolean + default: false + enabled-private: + description: "Enables / disables third-party cookie blocking in private browsing mode.\n" + type: Boolean + default: true + 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.\n" + 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.\n" + 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.\n" + 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.\n" + 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.)\n" + type: Boolean + default: true + main-flow-toolbar-enabled: + description: "Show the primary toolbar entry point into the translations feature. (Translations icon on URL toolbar.)\n" + 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.\n" + type: Boolean + default: true + 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 +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. + CookieBannersSection: + description: The identifiers for the sections of the MR 2022. + variants: + feature-setting-detect-only: + description: "An integer either 0 or 1 indicating if cookie banner detect only mode should be enabled or disabled. 0 for setting to be disabled, and 1 for enabling the setting." + feature-setting-global-rules: + description: "An integer either 0 or 1 indicating if cookie banner global rules should be enabled or disabled. 0 for setting to be disabled, and 1 for enabling the setting." + feature-setting-global-rules-sub-frames: + description: "An integer either 0 or 1 indicating if cookie banner global rules sub-frames should be enabled or disabled. 0 for setting to be disabled, and 1 for enabling the setting." + feature-setting-value: + description: "An integer either 0 or 1 indicating if cookie banner setting should be enabled or disabled, 0 for setting the value to disabled, 1 for enabling the setting with the value reject_all." + feature-setting-value-pbm: + description: "An integer either 0 or 1 indicating if cookie banner setting should be enabled or disabled, 0 for setting the value to disabled, 1 for enabling the setting with the value reject_all." + feature-ui: + description: "An integer either 0 or 1 indicating if the UI for cookie banner handling should be visible, 0 to hide the UI and 1 to show the UI. The actual UI is composed by cookie banner section in the settings page, the toolbar section and the re-engagement dialog." + HomeScreenSection: + description: The identifiers for the sections of the homescreen. + variants: + bookmarks: + description: The sites the user has bookmarked. + 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. + recent-explorations: + description: The tab groups + top-sites: + description: The frecency and pinned sites. + MR2022Section: + description: The identifiers for the sections of the MR 2022. + variants: + home-onboarding-dialog-existing-users: + description: Home onboarding dialog for upgraded users. + jump-back-in-cfr: + description: Jump back-in onboarding message. + sync-cfr: + description: CFR for the first time you see a synced tab on the home screen. + tcp-cfr: + description: CFR for the first time you use the browse with Total Cookie Protection on the browser screen. + tcp-feature: + description: Controls the Total Cookie Protection feature. + wallpapers-selection-tool: + description: Wallpapers selection dialog tool for the home screen. + OnboardingCardType: + description: An enum to describe a type of card. + variants: + add-ons: + description: Allows user to install add-ons from onboarding. + add-search-widget: + description: Allows user to add search widget to homescreen. + default-browser: + description: Allows user to set Firefox as the default browser. + notification-permission: + description: Allows user to enable notification permission. + sync-sign-in: + description: Allows user to sync with a Firefox account. + 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) + 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. + 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. +objects: + AddOnData: + description: An object to describe an add-on to be installed from the onboarding card. + fields: + average-rating: + description: The average rating of the add-on. + type: String + default: "0.0" + description: + description: A small description of the add-on to be displayed to the user. + type: Text + default: "" + icon-res: + description: The resource id of the icon of the add-on to be displayed. + type: Image + default: ic_onboarding_welcome + install-url: + description: The url from where the add-on can be installed. + type: Text + default: "" + name: + description: The name of the add-on to be displayed to the user. + type: Text + default: "" + review-count: + description: The amount of reviews the add-on has. + type: String + default: "0.0" + 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.\n" + fields: + action: + description: "A URL of a page or a deeplink. This may have substitution variables in.\n" + 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\".\nThe params and their values are all determined downstream of the messaging component, by the embedding app's deeplink processing machinery.\n" + type: "Map" + default: {} + button-label: + description: "The text on the button. If no text is present, the whole message is clickable.\n" + type: Option + default: ~ + 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`.\n" + type: List + default: [] + experiment: + description: The slug of the experiment that this message came from. + type: Option + default: ~ + 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: ~ + style: + description: "The style as described in a `StyleData` from the styles table.\n" + 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: ~ + trigger-if-all: + description: "A list of strings corresponding to targeting expressions. The message will be shown if all expressions are `true`.\n" + type: List + default: [] + MicrosurveyAnswer: + description: Attributes relating to microsurvey content. + fields: + ordering: + description: "Used to sequence the answers top to bottom. E.g. 0 will be the first/top item, 1 will be next and so on. Always set either ALL the provided answers ordering or NONE. If ALL answers are default, the the ordering used will be the same as provided by the experiment.\n" + type: Int + default: 0 + text: + description: The text for the answer. + type: Text + default: "" + MicrosurveyConfig: + description: Attributes relating to microsurvey content. + fields: + 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: ~ + utm-content: + description: "Optional \"utm_content\" parameter for the privacy notice URL to specify the feature being surveyed." + type: Option + default: ~ + 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.\n" + type: Int + default: 240 + OnboardingCardData: + description: An object to describe a user facing onboarding card. + fields: + add-ons-data: + description: "An optional list of add-ons which will be shown in add-on onboarding card.\n" + type: List + default: [] + 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`.\n" + type: List + default: + - NEVER + enabled: + description: "If true, this card is shown to the user." + type: Boolean + default: true + 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.\n" + 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.\n" + fields: + max-display-count: + description: "How many sessions will this message be shown to the user before it is expired.\n" + type: Int + default: 5 + priority: + description: "The importance of this message. 0 is not very important, 100 is very important.\n" + type: Int + default: 50 diff --git a/experimenter/experimenter/features/manifests/fenix/v133.0.1/developer.fml.yaml b/experimenter/experimenter/features/manifests/fenix/v133.0.1/developer.fml.yaml new file mode 100644 index 0000000000..1e63df9b2d --- /dev/null +++ b/experimenter/experimenter/features/manifests/fenix/v133.0.1/developer.fml.yaml @@ -0,0 +1,936 @@ +--- +version: 1.0.0 +about: + description: Nimbus Feature Manifest for Fenix (Firefox Android) +channels: + - developer +features: + 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.\n" + type: Boolean + default: false + 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.\n" + type: "Map" + default: + amp: true + ampMobile: false + wikipedia: true + bookmarks: + description: Feature for Bookmarks + variables: + new-compose-ui: + description: "if true, enable new compose based UI" + type: Boolean + default: false + cookie-banners: + description: Features for cookie banner handling. + variables: + sections-enabled: + description: This property provides a lookup table of whether or not the given section should be enabled. + type: "Map" + default: + feature-ui: 1 + feature-setting-value: 0 + feature-setting-value-pbm: 1 + feature-setting-detect-only: 0 + feature-setting-global-rules: 1 + feature-setting-global-rules-sub-frames: 1 + 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.\n" + type: Boolean + default: false + enabled-private: + description: "Enables / disables fingerprinting protection in private browsing mode.\n" + type: Boolean + default: true + fdlibm-math: + description: "Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy\n" + type: Boolean + default: false + overrides: + description: "The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets.\n" + type: String + default: "" + 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.\n" + type: Boolean + default: false + fx-suggest: + description: A feature that provides Firefox Suggest search suggestions. + variables: + 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.\n" + type: Boolean + default: true + 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 + metrics-enabled: + description: "A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric." + type: "Map" + default: {} + 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 + growth-data: + description: A feature measuring campaign growth data + variables: + enabled: + description: "If true, the feature is active" + 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 + juno-onboarding: + description: A feature that shows the onboarding flow. + variables: + cards: + description: Collection of user facing onboarding cards. + type: "Map" + default: + default-browser: + add-ons-data: [] + body: juno_onboarding_default_browser_description_nimbus_3 + card-type: default-browser + disqualifiers: + - NEVER + enabled: true + image-res: ic_onboarding_welcome + ordering: 10 + prerequisites: + - ALWAYS + primary-button-label: juno_onboarding_default_browser_positive_button + secondary-button-label: juno_onboarding_default_browser_negative_button + title: juno_onboarding_default_browser_title_nimbus_2 + add-search-widget: + add-ons-data: [] + body: juno_onboarding_add_search_widget_description + card-type: add-search-widget + disqualifiers: + - NEVER + enabled: true + image-res: ic_onboarding_search_widget + ordering: 15 + prerequisites: + - ALWAYS + primary-button-label: juno_onboarding_add_search_widget_positive_button + secondary-button-label: juno_onboarding_add_search_widget_negative_button + title: juno_onboarding_add_search_widget_title + sync-sign-in: + add-ons-data: [] + body: juno_onboarding_sign_in_description_3 + card-type: sync-sign-in + disqualifiers: + - NEVER + enabled: true + image-res: ic_onboarding_sync + ordering: 20 + prerequisites: + - ALWAYS + primary-button-label: juno_onboarding_sign_in_positive_button + secondary-button-label: juno_onboarding_sign_in_negative_button + title: juno_onboarding_sign_in_title_2 + notification-permission: + add-ons-data: [] + body: juno_onboarding_enable_notifications_description_nimbus_2 + card-type: notification-permission + disqualifiers: + - NEVER + enabled: true + image-res: ic_notification_permission + ordering: 30 + prerequisites: + - ALWAYS + primary-button-label: juno_onboarding_enable_notifications_positive_button + secondary-button-label: juno_onboarding_enable_notifications_negative_button + title: juno_onboarding_enable_notifications_title_nimbus_2 + 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.\n" + type: "Map" + default: + ALWAYS: "true" + NEVER: "false" + string-alias: ConditionName + menu-redesign: + description: Control the new menu redesign. + variables: + enabled: + description: "If true, the new menu redesign is available." + type: Boolean + default: false + messaging: + description: "The in-app messaging system.\n" + 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.\n\nThis should not be written to by experiments, and should be hidden to users.\n" + 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_DELETE_BROWSING_DATA: "://settings_delete_browsing_data" + OPEN_SETTINGS_LOGINS: "://settings_logins" + OPEN_SETTINGS_NOTIFICATIONS: "://settings_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: "://settings" + OPEN_SHARE_SHEET: "://share_sheet" + 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: ~ + 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 + 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.\n" + 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.\n" + 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 + FUNNEL_PAID: "adjust_campaign != ''" + FUNNEL_ORGANIC: "adjust_campaign == ''" + INACTIVE_1_DAY: "'app_launched'|eventLastSeen('Hours') >= 24" + INACTIVE_2_DAYS: "'app_launched'|eventLastSeen('Days', 0) >= 2" + INACTIVE_3_DAYS: "'app_launched'|eventLastSeen('Days', 0) >= 3" + INACTIVE_4_DAYS: "'app_launched'|eventLastSeen('Days', 0) >= 4" + INACTIVE_5_DAYS: "'app_launched'|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_launched'|eventCountNonZero('Days', 28) >= 1 && 'app_launched'|eventCountNonZero('Days', 28) < 7" + USER_CASUAL: "'app_launched'|eventCountNonZero('Days', 28) >= 7 && 'app_launched'|eventCountNonZero('Days', 28) < 14" + USER_REGULAR: "'app_launched'|eventCountNonZero('Days', 28) >= 14 && 'app_launched'|eventCountNonZero('Days', 28) < 21" + USER_CORE_ACTIVE: "'app_launched'|eventCountNonZero('Days', 28) >= 21" + LAUNCHED_ONCE_THIS_WEEK: "'app_launched'|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.\n" + type: Boolean + default: true + mr2022: + description: Features for MR 2022. + variables: + sections-enabled: + description: This property provides a lookup table of whether or not the given section should be enabled. + type: "Map" + default: + home-onboarding-dialog-existing-users: true + sync-cfr: true + wallpapers-selection-tool: true + jump-back-in-cfr: true + tcp-cfr: true + tcp-feature: true + navigation-toolbar: + description: Feature for navigation toolbar. + variables: + enabled: + description: "When the feature is enabled then the user will see the new navigation toolbar.\n" + type: Boolean + default: true + networking: + description: Enables networking features + variables: + fetchPriorityEnabled: + description: "Enables or disables network.fetchpriority.enabled preference.\n" + type: Boolean + default: true + nimbus-is-ready: + description: "A feature that provides the number of Nimbus is_ready events to send when Nimbus finishes launching.\n" + variables: + event-count: + description: The number of events that should be sent. + type: Int + default: 1 + nimbus-system: + description: "Configuration of the Nimbus System in Android.\n" + variables: + refresh-interval-foreground: + description: "The minimum interval in minutes between fetching experiment\nrecipes in the foreground.\n" + 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 + 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 + 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 + print: + description: A feature for printing from the share or browser menu. + variables: + browser-print-enabled: + description: "If true, a print button from the browser menu is available." + type: Boolean + default: true + share-print-enabled: + description: "If true, a print button from the share menu is available." + type: Boolean + default: true + private-browsing: + description: Private Browsing Mode + variables: + felt-privacy-enabled: + description: "if true, enable felt privacy related UI" + type: Boolean + default: false + query-parameter-stripping: + description: Features for query parameter stripping. + variables: + sections-enabled: + description: This property provides a lookup table of whether or not the given section should be enabled. + type: "Map" + default: + query-parameter-stripping: "0" + query-parameter-stripping-pmb: "0" + query-parameter-stripping-allow-list: "" + query-parameter-stripping-strip-list: "" + re-engagement-notification: + description: A feature that shows the re-engagement notification if the user is inactive. + variables: + enabled: + description: "If true, the re-engagement notification is shown to the inactive user." + type: Boolean + default: false + type: + description: The type of re-engagement notification that is shown to the inactive user. + type: Int + default: 0 + remote-tab-management: + description: "Features that let users manage tabs on other devices that are connected to the same Mozilla account.\n" + 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.\n" + type: Boolean + default: true + 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-term-groups: + description: A feature allowing the grouping of URLs around the search term that it came from. + variables: + enabled: + description: "If true, the feature shows up on the homescreen and on the new tab screen." + type: Boolean + default: true + set-as-default-prompt: + description: "Displays native default browser prompt to existing users.\n" + variables: + app-cold-starts-between-prompts: + description: "Minimum number of app cold starts before the next prompt should be displayed to the user.\n" + type: Int + default: 4 + days-between-prompts: + description: "Minimum number of days between displays of Set as default prompt.\n" + type: Int + default: 14 + enabled: + description: "When the feature is enabled then the Set as default prompt can be triggered for existing users.\n" + type: Boolean + default: true + max-number-of-times-to-display: + description: "Maximum number of time the prompt should be displayed.\n" + type: Int + default: 3 + ship: + description: The feature that controls Session History in Parent (SHIP) in Gecko. + variables: + disabled: + description: "Whether or not to disable SHIP. SHIP is enabled when set to false. SHIP is disabled when set to true.\n" + type: Boolean + default: true + shopping-experience: + description: A feature that shows product review quality information. + variables: + enabled: + description: "if true, the shopping experience feature is shown to the user." + type: Boolean + default: true + product-recommendations: + description: "if true, recommended products feature is enabled to be shown to the user based on their preference." + type: Boolean + default: true + product-recommendations-exposure: + description: "if true, we want to record recommended products inventory for opted-in users, even if product recommendations are disabled." + 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 + suggest-shipped-domains: + description: Feature that suggests domains from the shipped domain list. + variables: + enabled: + description: "Suggest domains from the shipped domain list.\n" + type: Boolean + default: false + 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.\n" + type: Boolean + default: false + enabled-private: + description: "Enables / disables third-party cookie blocking in private browsing mode.\n" + type: Boolean + default: true + 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.\n" + 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.\n" + 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.\n" + 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.\n" + 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.)\n" + type: Boolean + default: true + main-flow-toolbar-enabled: + description: "Show the primary toolbar entry point into the translations feature. (Translations icon on URL toolbar.)\n" + 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.\n" + type: Boolean + default: true + 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 +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. + CookieBannersSection: + description: The identifiers for the sections of the MR 2022. + variants: + feature-setting-detect-only: + description: "An integer either 0 or 1 indicating if cookie banner detect only mode should be enabled or disabled. 0 for setting to be disabled, and 1 for enabling the setting." + feature-setting-global-rules: + description: "An integer either 0 or 1 indicating if cookie banner global rules should be enabled or disabled. 0 for setting to be disabled, and 1 for enabling the setting." + feature-setting-global-rules-sub-frames: + description: "An integer either 0 or 1 indicating if cookie banner global rules sub-frames should be enabled or disabled. 0 for setting to be disabled, and 1 for enabling the setting." + feature-setting-value: + description: "An integer either 0 or 1 indicating if cookie banner setting should be enabled or disabled, 0 for setting the value to disabled, 1 for enabling the setting with the value reject_all." + feature-setting-value-pbm: + description: "An integer either 0 or 1 indicating if cookie banner setting should be enabled or disabled, 0 for setting the value to disabled, 1 for enabling the setting with the value reject_all." + feature-ui: + description: "An integer either 0 or 1 indicating if the UI for cookie banner handling should be visible, 0 to hide the UI and 1 to show the UI. The actual UI is composed by cookie banner section in the settings page, the toolbar section and the re-engagement dialog." + HomeScreenSection: + description: The identifiers for the sections of the homescreen. + variants: + bookmarks: + description: The sites the user has bookmarked. + 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. + recent-explorations: + description: The tab groups + top-sites: + description: The frecency and pinned sites. + MR2022Section: + description: The identifiers for the sections of the MR 2022. + variants: + home-onboarding-dialog-existing-users: + description: Home onboarding dialog for upgraded users. + jump-back-in-cfr: + description: Jump back-in onboarding message. + sync-cfr: + description: CFR for the first time you see a synced tab on the home screen. + tcp-cfr: + description: CFR for the first time you use the browse with Total Cookie Protection on the browser screen. + tcp-feature: + description: Controls the Total Cookie Protection feature. + wallpapers-selection-tool: + description: Wallpapers selection dialog tool for the home screen. + OnboardingCardType: + description: An enum to describe a type of card. + variants: + add-ons: + description: Allows user to install add-ons from onboarding. + add-search-widget: + description: Allows user to add search widget to homescreen. + default-browser: + description: Allows user to set Firefox as the default browser. + notification-permission: + description: Allows user to enable notification permission. + sync-sign-in: + description: Allows user to sync with a Firefox account. + 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) + 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. + 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. +objects: + AddOnData: + description: An object to describe an add-on to be installed from the onboarding card. + fields: + average-rating: + description: The average rating of the add-on. + type: String + default: "0.0" + description: + description: A small description of the add-on to be displayed to the user. + type: Text + default: "" + icon-res: + description: The resource id of the icon of the add-on to be displayed. + type: Image + default: ic_onboarding_welcome + install-url: + description: The url from where the add-on can be installed. + type: Text + default: "" + name: + description: The name of the add-on to be displayed to the user. + type: Text + default: "" + review-count: + description: The amount of reviews the add-on has. + type: String + default: "0.0" + 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.\n" + fields: + action: + description: "A URL of a page or a deeplink. This may have substitution variables in.\n" + 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\".\nThe params and their values are all determined downstream of the messaging component, by the embedding app's deeplink processing machinery.\n" + type: "Map" + default: {} + button-label: + description: "The text on the button. If no text is present, the whole message is clickable.\n" + type: Option + default: ~ + 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`.\n" + type: List + default: [] + experiment: + description: The slug of the experiment that this message came from. + type: Option + default: ~ + 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: ~ + style: + description: "The style as described in a `StyleData` from the styles table.\n" + 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: ~ + trigger-if-all: + description: "A list of strings corresponding to targeting expressions. The message will be shown if all expressions are `true`.\n" + type: List + default: [] + MicrosurveyAnswer: + description: Attributes relating to microsurvey content. + fields: + ordering: + description: "Used to sequence the answers top to bottom. E.g. 0 will be the first/top item, 1 will be next and so on. Always set either ALL the provided answers ordering or NONE. If ALL answers are default, the the ordering used will be the same as provided by the experiment.\n" + type: Int + default: 0 + text: + description: The text for the answer. + type: Text + default: "" + MicrosurveyConfig: + description: Attributes relating to microsurvey content. + fields: + 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: ~ + utm-content: + description: "Optional \"utm_content\" parameter for the privacy notice URL to specify the feature being surveyed." + type: Option + default: ~ + 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.\n" + type: Int + default: 240 + OnboardingCardData: + description: An object to describe a user facing onboarding card. + fields: + add-ons-data: + description: "An optional list of add-ons which will be shown in add-on onboarding card.\n" + type: List + default: [] + 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`.\n" + type: List + default: + - NEVER + enabled: + description: "If true, this card is shown to the user." + type: Boolean + default: true + 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.\n" + 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.\n" + fields: + max-display-count: + description: "How many sessions will this message be shown to the user before it is expired.\n" + type: Int + default: 5 + priority: + description: "The importance of this message. 0 is not very important, 100 is very important.\n" + type: Int + default: 50 diff --git a/experimenter/experimenter/features/manifests/fenix/v133.0.1/experimenter.yaml b/experimenter/experimenter/features/manifests/fenix/v133.0.1/experimenter.yaml new file mode 100644 index 0000000000..b3068ef271 --- /dev/null +++ b/experimenter/experimenter/features/manifests/fenix/v133.0.1/experimenter.yaml @@ -0,0 +1,428 @@ +--- +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.\n" +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.\n" +bookmarks: + description: Feature for Bookmarks + hasExposure: true + exposureDescription: "" + variables: + new-compose-ui: + type: boolean + description: "if true, enable new compose based UI" +cookie-banners: + description: Features for cookie banner handling. + 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. +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.\n" + enabled-private: + type: boolean + description: "Enables / disables fingerprinting protection in private browsing mode.\n" + fdlibm-math: + type: boolean + description: "Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy\n" + overrides: + type: string + description: "The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets.\n" +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.\n" +fx-suggest: + description: A feature that provides Firefox Suggest search suggestions. + hasExposure: true + exposureDescription: "" + variables: + 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.\n" +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 + metrics-enabled: + type: json + description: "A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric." + 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 +growth-data: + description: A feature measuring campaign growth data + hasExposure: true + exposureDescription: "" + variables: + enabled: + type: boolean + description: "If true, the feature is active" +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." +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.\n" +menu-redesign: + description: Control the new menu redesign. + hasExposure: true + exposureDescription: "" + variables: + enabled: + type: boolean + description: "If true, the new menu redesign is available." +messaging: + description: "The in-app messaging system.\n" + 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.\n\nThis should not be written to by experiments, and should be hidden to users.\n" + 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.\n" + triggers: + type: json + description: "A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression.\n" +microsurveys: + description: Feature for microsurveys. + hasExposure: true + exposureDescription: "" + variables: + enabled: + type: boolean + description: "When the feature is enabled then microsurveys can be used.\n" +mr2022: + description: Features for MR 2022. + 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. +navigation-toolbar: + description: Feature for navigation toolbar. + hasExposure: true + exposureDescription: "" + variables: + enabled: + type: boolean + description: "When the feature is enabled then the user will see the new navigation toolbar.\n" +networking: + description: Enables networking features + hasExposure: true + exposureDescription: "" + variables: + fetchPriorityEnabled: + type: boolean + description: "Enables or disables network.fetchpriority.enabled preference.\n" +nimbus-is-ready: + description: "A feature that provides the number of Nimbus is_ready events to send when Nimbus finishes launching.\n" + hasExposure: true + exposureDescription: "" + variables: + event-count: + type: int + description: The number of events that should be sent. +nimbus-system: + description: "Configuration of the Nimbus System in Android.\n" + hasExposure: true + exposureDescription: "" + variables: + refresh-interval-foreground: + type: int + description: "The minimum interval in minutes between fetching experiment\nrecipes in the foreground.\n" +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. +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." +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 +print: + description: A feature for printing from the share or browser menu. + hasExposure: true + exposureDescription: "" + variables: + browser-print-enabled: + type: boolean + description: "If true, a print button from the browser menu is available." + share-print-enabled: + type: boolean + description: "If true, a print button from the share menu is available." +private-browsing: + description: Private Browsing Mode + hasExposure: true + exposureDescription: "" + variables: + felt-privacy-enabled: + type: boolean + description: "if true, enable felt privacy related UI" +query-parameter-stripping: + description: Features for query parameter stripping. + 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. +re-engagement-notification: + description: A feature that shows the re-engagement notification if the user is inactive. + hasExposure: true + exposureDescription: "" + variables: + enabled: + type: boolean + description: "If true, the re-engagement notification is shown to the inactive user." + type: + type: int + description: The type of re-engagement notification that is shown to the inactive user. +remote-tab-management: + description: "Features that let users manage tabs on other devices that are connected to the same Mozilla account.\n" + 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.\n" +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-term-groups: + description: A feature allowing the grouping of URLs around the search term that it came from. + hasExposure: true + exposureDescription: "" + variables: + enabled: + type: boolean + description: "If true, the feature shows up on the homescreen and on the new tab screen." +set-as-default-prompt: + description: "Displays native default browser prompt to existing users.\n" + hasExposure: true + exposureDescription: "" + variables: + app-cold-starts-between-prompts: + type: int + description: "Minimum number of app cold starts before the next prompt should be displayed to the user.\n" + days-between-prompts: + type: int + description: "Minimum number of days between displays of Set as default prompt.\n" + enabled: + type: boolean + description: "When the feature is enabled then the Set as default prompt can be triggered for existing users.\n" + max-number-of-times-to-display: + type: int + description: "Maximum number of time the prompt should be displayed.\n" +ship: + description: The feature that controls Session History in Parent (SHIP) in Gecko. + hasExposure: true + exposureDescription: "" + variables: + disabled: + type: boolean + description: "Whether or not to disable SHIP. SHIP is enabled when set to false. SHIP is disabled when set to true.\n" +shopping-experience: + description: A feature that shows product review quality information. + hasExposure: true + exposureDescription: "" + variables: + enabled: + type: boolean + description: "if true, the shopping experience feature is shown to the user." + product-recommendations: + type: boolean + description: "if true, recommended products feature is enabled to be shown to the user based on their preference." + product-recommendations-exposure: + type: boolean + description: "if true, we want to record recommended products inventory for opted-in users, even if product recommendations are disabled." +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. +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.\n" +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.\n" + enabled-private: + type: boolean + description: "Enables / disables third-party cookie blocking in private browsing mode.\n" +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.\n" + 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.\n" + 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.\n" + 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.\n" + main-flow-browser-menu-enabled: + type: boolean + description: "Show the browser menu entry point into the translations feature. ('Translate Page' on browser menu.)\n" + main-flow-toolbar-enabled: + type: boolean + description: "Show the primary toolbar entry point into the translations feature. (Translations icon on URL toolbar.)\n" + 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.\n" +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. diff --git a/experimenter/experimenter/features/manifests/fenix/v133.0.1/nightly.fml.yaml b/experimenter/experimenter/features/manifests/fenix/v133.0.1/nightly.fml.yaml new file mode 100644 index 0000000000..e555794389 --- /dev/null +++ b/experimenter/experimenter/features/manifests/fenix/v133.0.1/nightly.fml.yaml @@ -0,0 +1,910 @@ +--- +version: 1.0.0 +about: + description: Nimbus Feature Manifest for Fenix (Firefox Android) +channels: + - nightly +features: + 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.\n" + type: Boolean + default: false + 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.\n" + type: "Map" + default: + amp: true + ampMobile: false + wikipedia: true + bookmarks: + description: Feature for Bookmarks + variables: + new-compose-ui: + description: "if true, enable new compose based UI" + type: Boolean + default: false + cookie-banners: + description: Features for cookie banner handling. + variables: + sections-enabled: + description: This property provides a lookup table of whether or not the given section should be enabled. + type: "Map" + default: + feature-ui: 1 + feature-setting-value: 0 + feature-setting-value-pbm: 1 + feature-setting-detect-only: 0 + feature-setting-global-rules: 1 + feature-setting-global-rules-sub-frames: 1 + 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.\n" + type: Boolean + default: false + enabled-private: + description: "Enables / disables fingerprinting protection in private browsing mode.\n" + type: Boolean + default: true + fdlibm-math: + description: "Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy\n" + type: Boolean + default: false + overrides: + description: "The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets.\n" + type: String + default: "" + 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.\n" + type: Boolean + default: false + fx-suggest: + description: A feature that provides Firefox Suggest search suggestions. + variables: + 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.\n" + type: Boolean + default: true + 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 + metrics-enabled: + description: "A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric." + type: "Map" + default: {} + 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 + growth-data: + description: A feature measuring campaign growth data + variables: + enabled: + description: "If true, the feature is active" + 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 + juno-onboarding: + description: A feature that shows the onboarding flow. + variables: + cards: + description: Collection of user facing onboarding cards. + type: "Map" + default: + default-browser: + add-ons-data: [] + body: juno_onboarding_default_browser_description_nimbus_3 + card-type: default-browser + disqualifiers: + - NEVER + enabled: true + image-res: ic_onboarding_welcome + ordering: 10 + prerequisites: + - ALWAYS + primary-button-label: juno_onboarding_default_browser_positive_button + secondary-button-label: juno_onboarding_default_browser_negative_button + title: juno_onboarding_default_browser_title_nimbus_2 + add-search-widget: + add-ons-data: [] + body: juno_onboarding_add_search_widget_description + card-type: add-search-widget + disqualifiers: + - NEVER + enabled: true + image-res: ic_onboarding_search_widget + ordering: 15 + prerequisites: + - ALWAYS + primary-button-label: juno_onboarding_add_search_widget_positive_button + secondary-button-label: juno_onboarding_add_search_widget_negative_button + title: juno_onboarding_add_search_widget_title + sync-sign-in: + add-ons-data: [] + body: juno_onboarding_sign_in_description_3 + card-type: sync-sign-in + disqualifiers: + - NEVER + enabled: true + image-res: ic_onboarding_sync + ordering: 20 + prerequisites: + - ALWAYS + primary-button-label: juno_onboarding_sign_in_positive_button + secondary-button-label: juno_onboarding_sign_in_negative_button + title: juno_onboarding_sign_in_title_2 + notification-permission: + add-ons-data: [] + body: juno_onboarding_enable_notifications_description_nimbus_2 + card-type: notification-permission + disqualifiers: + - NEVER + enabled: true + image-res: ic_notification_permission + ordering: 30 + prerequisites: + - ALWAYS + primary-button-label: juno_onboarding_enable_notifications_positive_button + secondary-button-label: juno_onboarding_enable_notifications_negative_button + title: juno_onboarding_enable_notifications_title_nimbus_2 + 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.\n" + type: "Map" + default: + ALWAYS: "true" + NEVER: "false" + string-alias: ConditionName + menu-redesign: + description: Control the new menu redesign. + variables: + enabled: + description: "If true, the new menu redesign is available." + type: Boolean + default: false + messaging: + description: "The in-app messaging system.\n" + 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.\n\nThis should not be written to by experiments, and should be hidden to users.\n" + 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_DELETE_BROWSING_DATA: "://settings_delete_browsing_data" + OPEN_SETTINGS_LOGINS: "://settings_logins" + OPEN_SETTINGS_NOTIFICATIONS: "://settings_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: "://settings" + OPEN_SHARE_SHEET: "://share_sheet" + 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: ~ + 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.\n" + 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.\n" + 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 + FUNNEL_PAID: "adjust_campaign != ''" + FUNNEL_ORGANIC: "adjust_campaign == ''" + INACTIVE_1_DAY: "'app_launched'|eventLastSeen('Hours') >= 24" + INACTIVE_2_DAYS: "'app_launched'|eventLastSeen('Days', 0) >= 2" + INACTIVE_3_DAYS: "'app_launched'|eventLastSeen('Days', 0) >= 3" + INACTIVE_4_DAYS: "'app_launched'|eventLastSeen('Days', 0) >= 4" + INACTIVE_5_DAYS: "'app_launched'|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_launched'|eventCountNonZero('Days', 28) >= 1 && 'app_launched'|eventCountNonZero('Days', 28) < 7" + USER_CASUAL: "'app_launched'|eventCountNonZero('Days', 28) >= 7 && 'app_launched'|eventCountNonZero('Days', 28) < 14" + USER_REGULAR: "'app_launched'|eventCountNonZero('Days', 28) >= 14 && 'app_launched'|eventCountNonZero('Days', 28) < 21" + USER_CORE_ACTIVE: "'app_launched'|eventCountNonZero('Days', 28) >= 21" + LAUNCHED_ONCE_THIS_WEEK: "'app_launched'|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.\n" + type: Boolean + default: true + mr2022: + description: Features for MR 2022. + variables: + sections-enabled: + description: This property provides a lookup table of whether or not the given section should be enabled. + type: "Map" + default: + home-onboarding-dialog-existing-users: true + sync-cfr: true + wallpapers-selection-tool: true + jump-back-in-cfr: true + tcp-cfr: true + tcp-feature: true + navigation-toolbar: + description: Feature for navigation toolbar. + variables: + enabled: + description: "When the feature is enabled then the user will see the new navigation toolbar.\n" + type: Boolean + default: true + networking: + description: Enables networking features + variables: + fetchPriorityEnabled: + description: "Enables or disables network.fetchpriority.enabled preference.\n" + type: Boolean + default: true + nimbus-is-ready: + description: "A feature that provides the number of Nimbus is_ready events to send when Nimbus finishes launching.\n" + variables: + event-count: + description: The number of events that should be sent. + type: Int + default: 1 + nimbus-system: + description: "Configuration of the Nimbus System in Android.\n" + variables: + refresh-interval-foreground: + description: "The minimum interval in minutes between fetching experiment\nrecipes in the foreground.\n" + 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 + 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 + 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 + print: + description: A feature for printing from the share or browser menu. + variables: + browser-print-enabled: + description: "If true, a print button from the browser menu is available." + type: Boolean + default: true + share-print-enabled: + description: "If true, a print button from the share menu is available." + type: Boolean + default: true + private-browsing: + description: Private Browsing Mode + variables: + felt-privacy-enabled: + description: "if true, enable felt privacy related UI" + type: Boolean + default: false + query-parameter-stripping: + description: Features for query parameter stripping. + variables: + sections-enabled: + description: This property provides a lookup table of whether or not the given section should be enabled. + type: "Map" + default: + query-parameter-stripping: "0" + query-parameter-stripping-pmb: "0" + query-parameter-stripping-allow-list: "" + query-parameter-stripping-strip-list: "" + re-engagement-notification: + description: A feature that shows the re-engagement notification if the user is inactive. + variables: + enabled: + description: "If true, the re-engagement notification is shown to the inactive user." + type: Boolean + default: false + type: + description: The type of re-engagement notification that is shown to the inactive user. + type: Int + default: 0 + remote-tab-management: + description: "Features that let users manage tabs on other devices that are connected to the same Mozilla account.\n" + 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.\n" + type: Boolean + default: true + 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-term-groups: + description: A feature allowing the grouping of URLs around the search term that it came from. + variables: + enabled: + description: "If true, the feature shows up on the homescreen and on the new tab screen." + type: Boolean + default: true + set-as-default-prompt: + description: "Displays native default browser prompt to existing users.\n" + variables: + app-cold-starts-between-prompts: + description: "Minimum number of app cold starts before the next prompt should be displayed to the user.\n" + type: Int + default: 4 + days-between-prompts: + description: "Minimum number of days between displays of Set as default prompt.\n" + type: Int + default: 14 + enabled: + description: "When the feature is enabled then the Set as default prompt can be triggered for existing users.\n" + type: Boolean + default: true + max-number-of-times-to-display: + description: "Maximum number of time the prompt should be displayed.\n" + type: Int + default: 3 + ship: + description: The feature that controls Session History in Parent (SHIP) in Gecko. + variables: + disabled: + description: "Whether or not to disable SHIP. SHIP is enabled when set to false. SHIP is disabled when set to true.\n" + type: Boolean + default: true + shopping-experience: + description: A feature that shows product review quality information. + variables: + enabled: + description: "if true, the shopping experience feature is shown to the user." + type: Boolean + default: false + product-recommendations: + description: "if true, recommended products feature is enabled to be shown to the user based on their preference." + type: Boolean + default: false + product-recommendations-exposure: + description: "if true, we want to record recommended products inventory for opted-in users, even if product recommendations are disabled." + type: Boolean + default: false + 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 + suggest-shipped-domains: + description: Feature that suggests domains from the shipped domain list. + variables: + enabled: + description: "Suggest domains from the shipped domain list.\n" + type: Boolean + default: false + 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.\n" + type: Boolean + default: false + enabled-private: + description: "Enables / disables third-party cookie blocking in private browsing mode.\n" + type: Boolean + default: true + 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.\n" + 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.\n" + 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.\n" + 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.\n" + 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.)\n" + type: Boolean + default: true + main-flow-toolbar-enabled: + description: "Show the primary toolbar entry point into the translations feature. (Translations icon on URL toolbar.)\n" + 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.\n" + type: Boolean + default: true + 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 +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. + CookieBannersSection: + description: The identifiers for the sections of the MR 2022. + variants: + feature-setting-detect-only: + description: "An integer either 0 or 1 indicating if cookie banner detect only mode should be enabled or disabled. 0 for setting to be disabled, and 1 for enabling the setting." + feature-setting-global-rules: + description: "An integer either 0 or 1 indicating if cookie banner global rules should be enabled or disabled. 0 for setting to be disabled, and 1 for enabling the setting." + feature-setting-global-rules-sub-frames: + description: "An integer either 0 or 1 indicating if cookie banner global rules sub-frames should be enabled or disabled. 0 for setting to be disabled, and 1 for enabling the setting." + feature-setting-value: + description: "An integer either 0 or 1 indicating if cookie banner setting should be enabled or disabled, 0 for setting the value to disabled, 1 for enabling the setting with the value reject_all." + feature-setting-value-pbm: + description: "An integer either 0 or 1 indicating if cookie banner setting should be enabled or disabled, 0 for setting the value to disabled, 1 for enabling the setting with the value reject_all." + feature-ui: + description: "An integer either 0 or 1 indicating if the UI for cookie banner handling should be visible, 0 to hide the UI and 1 to show the UI. The actual UI is composed by cookie banner section in the settings page, the toolbar section and the re-engagement dialog." + HomeScreenSection: + description: The identifiers for the sections of the homescreen. + variants: + bookmarks: + description: The sites the user has bookmarked. + 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. + recent-explorations: + description: The tab groups + top-sites: + description: The frecency and pinned sites. + MR2022Section: + description: The identifiers for the sections of the MR 2022. + variants: + home-onboarding-dialog-existing-users: + description: Home onboarding dialog for upgraded users. + jump-back-in-cfr: + description: Jump back-in onboarding message. + sync-cfr: + description: CFR for the first time you see a synced tab on the home screen. + tcp-cfr: + description: CFR for the first time you use the browse with Total Cookie Protection on the browser screen. + tcp-feature: + description: Controls the Total Cookie Protection feature. + wallpapers-selection-tool: + description: Wallpapers selection dialog tool for the home screen. + OnboardingCardType: + description: An enum to describe a type of card. + variants: + add-ons: + description: Allows user to install add-ons from onboarding. + add-search-widget: + description: Allows user to add search widget to homescreen. + default-browser: + description: Allows user to set Firefox as the default browser. + notification-permission: + description: Allows user to enable notification permission. + sync-sign-in: + description: Allows user to sync with a Firefox account. + 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) + 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. + 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. +objects: + AddOnData: + description: An object to describe an add-on to be installed from the onboarding card. + fields: + average-rating: + description: The average rating of the add-on. + type: String + default: "0.0" + description: + description: A small description of the add-on to be displayed to the user. + type: Text + default: "" + icon-res: + description: The resource id of the icon of the add-on to be displayed. + type: Image + default: ic_onboarding_welcome + install-url: + description: The url from where the add-on can be installed. + type: Text + default: "" + name: + description: The name of the add-on to be displayed to the user. + type: Text + default: "" + review-count: + description: The amount of reviews the add-on has. + type: String + default: "0.0" + 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.\n" + fields: + action: + description: "A URL of a page or a deeplink. This may have substitution variables in.\n" + 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\".\nThe params and their values are all determined downstream of the messaging component, by the embedding app's deeplink processing machinery.\n" + type: "Map" + default: {} + button-label: + description: "The text on the button. If no text is present, the whole message is clickable.\n" + type: Option + default: ~ + 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`.\n" + type: List + default: [] + experiment: + description: The slug of the experiment that this message came from. + type: Option + default: ~ + 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: ~ + style: + description: "The style as described in a `StyleData` from the styles table.\n" + 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: ~ + trigger-if-all: + description: "A list of strings corresponding to targeting expressions. The message will be shown if all expressions are `true`.\n" + type: List + default: [] + MicrosurveyAnswer: + description: Attributes relating to microsurvey content. + fields: + ordering: + description: "Used to sequence the answers top to bottom. E.g. 0 will be the first/top item, 1 will be next and so on. Always set either ALL the provided answers ordering or NONE. If ALL answers are default, the the ordering used will be the same as provided by the experiment.\n" + type: Int + default: 0 + text: + description: The text for the answer. + type: Text + default: "" + MicrosurveyConfig: + description: Attributes relating to microsurvey content. + fields: + 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: ~ + utm-content: + description: "Optional \"utm_content\" parameter for the privacy notice URL to specify the feature being surveyed." + type: Option + default: ~ + 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.\n" + type: Int + default: 240 + OnboardingCardData: + description: An object to describe a user facing onboarding card. + fields: + add-ons-data: + description: "An optional list of add-ons which will be shown in add-on onboarding card.\n" + type: List + default: [] + 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`.\n" + type: List + default: + - NEVER + enabled: + description: "If true, this card is shown to the user." + type: Boolean + default: true + 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.\n" + 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.\n" + fields: + max-display-count: + description: "How many sessions will this message be shown to the user before it is expired.\n" + type: Int + default: 5 + priority: + description: "The importance of this message. 0 is not very important, 100 is very important.\n" + type: Int + default: 50 diff --git a/experimenter/experimenter/features/manifests/fenix/v133.0.1/release.fml.yaml b/experimenter/experimenter/features/manifests/fenix/v133.0.1/release.fml.yaml new file mode 100644 index 0000000000..6c894d276c --- /dev/null +++ b/experimenter/experimenter/features/manifests/fenix/v133.0.1/release.fml.yaml @@ -0,0 +1,910 @@ +--- +version: 1.0.0 +about: + description: Nimbus Feature Manifest for Fenix (Firefox Android) +channels: + - release +features: + 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.\n" + type: Boolean + default: false + 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.\n" + type: "Map" + default: + amp: true + ampMobile: false + wikipedia: true + bookmarks: + description: Feature for Bookmarks + variables: + new-compose-ui: + description: "if true, enable new compose based UI" + type: Boolean + default: false + cookie-banners: + description: Features for cookie banner handling. + variables: + sections-enabled: + description: This property provides a lookup table of whether or not the given section should be enabled. + type: "Map" + default: + feature-ui: 0 + feature-setting-value: 0 + feature-setting-value-pbm: 0 + feature-setting-detect-only: 0 + feature-setting-global-rules: 1 + feature-setting-global-rules-sub-frames: 1 + 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.\n" + type: Boolean + default: false + enabled-private: + description: "Enables / disables fingerprinting protection in private browsing mode.\n" + type: Boolean + default: true + fdlibm-math: + description: "Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy\n" + type: Boolean + default: false + overrides: + description: "The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets.\n" + type: String + default: "" + 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.\n" + type: Boolean + default: false + fx-suggest: + description: A feature that provides Firefox Suggest search suggestions. + variables: + 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.\n" + type: Boolean + default: false + 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 + metrics-enabled: + description: "A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric." + type: "Map" + default: {} + 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 + growth-data: + description: A feature measuring campaign growth data + variables: + enabled: + description: "If true, the feature is active" + type: Boolean + default: true + 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 + juno-onboarding: + description: A feature that shows the onboarding flow. + variables: + cards: + description: Collection of user facing onboarding cards. + type: "Map" + default: + default-browser: + add-ons-data: [] + body: juno_onboarding_default_browser_description_nimbus_3 + card-type: default-browser + disqualifiers: + - NEVER + enabled: true + image-res: ic_onboarding_welcome + ordering: 10 + prerequisites: + - ALWAYS + primary-button-label: juno_onboarding_default_browser_positive_button + secondary-button-label: juno_onboarding_default_browser_negative_button + title: juno_onboarding_default_browser_title_nimbus_2 + add-search-widget: + add-ons-data: [] + body: juno_onboarding_add_search_widget_description + card-type: add-search-widget + disqualifiers: + - NEVER + enabled: true + image-res: ic_onboarding_search_widget + ordering: 15 + prerequisites: + - ALWAYS + primary-button-label: juno_onboarding_add_search_widget_positive_button + secondary-button-label: juno_onboarding_add_search_widget_negative_button + title: juno_onboarding_add_search_widget_title + sync-sign-in: + add-ons-data: [] + body: juno_onboarding_sign_in_description_3 + card-type: sync-sign-in + disqualifiers: + - NEVER + enabled: true + image-res: ic_onboarding_sync + ordering: 20 + prerequisites: + - ALWAYS + primary-button-label: juno_onboarding_sign_in_positive_button + secondary-button-label: juno_onboarding_sign_in_negative_button + title: juno_onboarding_sign_in_title_2 + notification-permission: + add-ons-data: [] + body: juno_onboarding_enable_notifications_description_nimbus_2 + card-type: notification-permission + disqualifiers: + - NEVER + enabled: true + image-res: ic_notification_permission + ordering: 30 + prerequisites: + - ALWAYS + primary-button-label: juno_onboarding_enable_notifications_positive_button + secondary-button-label: juno_onboarding_enable_notifications_negative_button + title: juno_onboarding_enable_notifications_title_nimbus_2 + 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.\n" + type: "Map" + default: + ALWAYS: "true" + NEVER: "false" + string-alias: ConditionName + menu-redesign: + description: Control the new menu redesign. + variables: + enabled: + description: "If true, the new menu redesign is available." + type: Boolean + default: false + messaging: + description: "The in-app messaging system.\n" + 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.\n\nThis should not be written to by experiments, and should be hidden to users.\n" + 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_DELETE_BROWSING_DATA: "://settings_delete_browsing_data" + OPEN_SETTINGS_LOGINS: "://settings_logins" + OPEN_SETTINGS_NOTIFICATIONS: "://settings_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: "://settings" + OPEN_SHARE_SHEET: "://share_sheet" + 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: ~ + 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.\n" + 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.\n" + 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 + FUNNEL_PAID: "adjust_campaign != ''" + FUNNEL_ORGANIC: "adjust_campaign == ''" + INACTIVE_1_DAY: "'app_launched'|eventLastSeen('Hours') >= 24" + INACTIVE_2_DAYS: "'app_launched'|eventLastSeen('Days', 0) >= 2" + INACTIVE_3_DAYS: "'app_launched'|eventLastSeen('Days', 0) >= 3" + INACTIVE_4_DAYS: "'app_launched'|eventLastSeen('Days', 0) >= 4" + INACTIVE_5_DAYS: "'app_launched'|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_launched'|eventCountNonZero('Days', 28) >= 1 && 'app_launched'|eventCountNonZero('Days', 28) < 7" + USER_CASUAL: "'app_launched'|eventCountNonZero('Days', 28) >= 7 && 'app_launched'|eventCountNonZero('Days', 28) < 14" + USER_REGULAR: "'app_launched'|eventCountNonZero('Days', 28) >= 14 && 'app_launched'|eventCountNonZero('Days', 28) < 21" + USER_CORE_ACTIVE: "'app_launched'|eventCountNonZero('Days', 28) >= 21" + LAUNCHED_ONCE_THIS_WEEK: "'app_launched'|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.\n" + type: Boolean + default: true + mr2022: + description: Features for MR 2022. + variables: + sections-enabled: + description: This property provides a lookup table of whether or not the given section should be enabled. + type: "Map" + default: + home-onboarding-dialog-existing-users: true + sync-cfr: true + wallpapers-selection-tool: true + jump-back-in-cfr: true + tcp-cfr: true + tcp-feature: true + navigation-toolbar: + description: Feature for navigation toolbar. + variables: + enabled: + description: "When the feature is enabled then the user will see the new navigation toolbar.\n" + type: Boolean + default: false + networking: + description: Enables networking features + variables: + fetchPriorityEnabled: + description: "Enables or disables network.fetchpriority.enabled preference.\n" + type: Boolean + default: true + nimbus-is-ready: + description: "A feature that provides the number of Nimbus is_ready events to send when Nimbus finishes launching.\n" + variables: + event-count: + description: The number of events that should be sent. + type: Int + default: 1 + nimbus-system: + description: "Configuration of the Nimbus System in Android.\n" + variables: + refresh-interval-foreground: + description: "The minimum interval in minutes between fetching experiment\nrecipes in the foreground.\n" + 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 + 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 + 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 + print: + description: A feature for printing from the share or browser menu. + variables: + browser-print-enabled: + description: "If true, a print button from the browser menu is available." + type: Boolean + default: true + share-print-enabled: + description: "If true, a print button from the share menu is available." + type: Boolean + default: true + private-browsing: + description: Private Browsing Mode + variables: + felt-privacy-enabled: + description: "if true, enable felt privacy related UI" + type: Boolean + default: false + query-parameter-stripping: + description: Features for query parameter stripping. + variables: + sections-enabled: + description: This property provides a lookup table of whether or not the given section should be enabled. + type: "Map" + default: + query-parameter-stripping: "0" + query-parameter-stripping-pmb: "0" + query-parameter-stripping-allow-list: "" + query-parameter-stripping-strip-list: "" + re-engagement-notification: + description: A feature that shows the re-engagement notification if the user is inactive. + variables: + enabled: + description: "If true, the re-engagement notification is shown to the inactive user." + type: Boolean + default: false + type: + description: The type of re-engagement notification that is shown to the inactive user. + type: Int + default: 0 + remote-tab-management: + description: "Features that let users manage tabs on other devices that are connected to the same Mozilla account.\n" + 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.\n" + type: Boolean + default: true + 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-term-groups: + description: A feature allowing the grouping of URLs around the search term that it came from. + variables: + enabled: + description: "If true, the feature shows up on the homescreen and on the new tab screen." + type: Boolean + default: false + set-as-default-prompt: + description: "Displays native default browser prompt to existing users.\n" + variables: + app-cold-starts-between-prompts: + description: "Minimum number of app cold starts before the next prompt should be displayed to the user.\n" + type: Int + default: 4 + days-between-prompts: + description: "Minimum number of days between displays of Set as default prompt.\n" + type: Int + default: 14 + enabled: + description: "When the feature is enabled then the Set as default prompt can be triggered for existing users.\n" + type: Boolean + default: true + max-number-of-times-to-display: + description: "Maximum number of time the prompt should be displayed.\n" + type: Int + default: 3 + ship: + description: The feature that controls Session History in Parent (SHIP) in Gecko. + variables: + disabled: + description: "Whether or not to disable SHIP. SHIP is enabled when set to false. SHIP is disabled when set to true.\n" + type: Boolean + default: true + shopping-experience: + description: A feature that shows product review quality information. + variables: + enabled: + description: "if true, the shopping experience feature is shown to the user." + type: Boolean + default: false + product-recommendations: + description: "if true, recommended products feature is enabled to be shown to the user based on their preference." + type: Boolean + default: false + product-recommendations-exposure: + description: "if true, we want to record recommended products inventory for opted-in users, even if product recommendations are disabled." + type: Boolean + default: false + 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 + suggest-shipped-domains: + description: Feature that suggests domains from the shipped domain list. + variables: + enabled: + description: "Suggest domains from the shipped domain list.\n" + type: Boolean + default: true + 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.\n" + type: Boolean + default: false + enabled-private: + description: "Enables / disables third-party cookie blocking in private browsing mode.\n" + type: Boolean + default: true + 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.\n" + 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.\n" + 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.\n" + 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.\n" + 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.)\n" + type: Boolean + default: true + main-flow-toolbar-enabled: + description: "Show the primary toolbar entry point into the translations feature. (Translations icon on URL toolbar.)\n" + 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.\n" + type: Boolean + default: true + 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 +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. + CookieBannersSection: + description: The identifiers for the sections of the MR 2022. + variants: + feature-setting-detect-only: + description: "An integer either 0 or 1 indicating if cookie banner detect only mode should be enabled or disabled. 0 for setting to be disabled, and 1 for enabling the setting." + feature-setting-global-rules: + description: "An integer either 0 or 1 indicating if cookie banner global rules should be enabled or disabled. 0 for setting to be disabled, and 1 for enabling the setting." + feature-setting-global-rules-sub-frames: + description: "An integer either 0 or 1 indicating if cookie banner global rules sub-frames should be enabled or disabled. 0 for setting to be disabled, and 1 for enabling the setting." + feature-setting-value: + description: "An integer either 0 or 1 indicating if cookie banner setting should be enabled or disabled, 0 for setting the value to disabled, 1 for enabling the setting with the value reject_all." + feature-setting-value-pbm: + description: "An integer either 0 or 1 indicating if cookie banner setting should be enabled or disabled, 0 for setting the value to disabled, 1 for enabling the setting with the value reject_all." + feature-ui: + description: "An integer either 0 or 1 indicating if the UI for cookie banner handling should be visible, 0 to hide the UI and 1 to show the UI. The actual UI is composed by cookie banner section in the settings page, the toolbar section and the re-engagement dialog." + HomeScreenSection: + description: The identifiers for the sections of the homescreen. + variants: + bookmarks: + description: The sites the user has bookmarked. + 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. + recent-explorations: + description: The tab groups + top-sites: + description: The frecency and pinned sites. + MR2022Section: + description: The identifiers for the sections of the MR 2022. + variants: + home-onboarding-dialog-existing-users: + description: Home onboarding dialog for upgraded users. + jump-back-in-cfr: + description: Jump back-in onboarding message. + sync-cfr: + description: CFR for the first time you see a synced tab on the home screen. + tcp-cfr: + description: CFR for the first time you use the browse with Total Cookie Protection on the browser screen. + tcp-feature: + description: Controls the Total Cookie Protection feature. + wallpapers-selection-tool: + description: Wallpapers selection dialog tool for the home screen. + OnboardingCardType: + description: An enum to describe a type of card. + variants: + add-ons: + description: Allows user to install add-ons from onboarding. + add-search-widget: + description: Allows user to add search widget to homescreen. + default-browser: + description: Allows user to set Firefox as the default browser. + notification-permission: + description: Allows user to enable notification permission. + sync-sign-in: + description: Allows user to sync with a Firefox account. + 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) + 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. + 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. +objects: + AddOnData: + description: An object to describe an add-on to be installed from the onboarding card. + fields: + average-rating: + description: The average rating of the add-on. + type: String + default: "0.0" + description: + description: A small description of the add-on to be displayed to the user. + type: Text + default: "" + icon-res: + description: The resource id of the icon of the add-on to be displayed. + type: Image + default: ic_onboarding_welcome + install-url: + description: The url from where the add-on can be installed. + type: Text + default: "" + name: + description: The name of the add-on to be displayed to the user. + type: Text + default: "" + review-count: + description: The amount of reviews the add-on has. + type: String + default: "0.0" + 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.\n" + fields: + action: + description: "A URL of a page or a deeplink. This may have substitution variables in.\n" + 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\".\nThe params and their values are all determined downstream of the messaging component, by the embedding app's deeplink processing machinery.\n" + type: "Map" + default: {} + button-label: + description: "The text on the button. If no text is present, the whole message is clickable.\n" + type: Option + default: ~ + 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`.\n" + type: List + default: [] + experiment: + description: The slug of the experiment that this message came from. + type: Option + default: ~ + 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: ~ + style: + description: "The style as described in a `StyleData` from the styles table.\n" + 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: ~ + trigger-if-all: + description: "A list of strings corresponding to targeting expressions. The message will be shown if all expressions are `true`.\n" + type: List + default: [] + MicrosurveyAnswer: + description: Attributes relating to microsurvey content. + fields: + ordering: + description: "Used to sequence the answers top to bottom. E.g. 0 will be the first/top item, 1 will be next and so on. Always set either ALL the provided answers ordering or NONE. If ALL answers are default, the the ordering used will be the same as provided by the experiment.\n" + type: Int + default: 0 + text: + description: The text for the answer. + type: Text + default: "" + MicrosurveyConfig: + description: Attributes relating to microsurvey content. + fields: + 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: ~ + utm-content: + description: "Optional \"utm_content\" parameter for the privacy notice URL to specify the feature being surveyed." + type: Option + default: ~ + 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.\n" + type: Int + default: 240 + OnboardingCardData: + description: An object to describe a user facing onboarding card. + fields: + add-ons-data: + description: "An optional list of add-ons which will be shown in add-on onboarding card.\n" + type: List + default: [] + 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`.\n" + type: List + default: + - NEVER + enabled: + description: "If true, this card is shown to the user." + type: Boolean + default: true + 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.\n" + 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.\n" + fields: + max-display-count: + description: "How many sessions will this message be shown to the user before it is expired.\n" + type: Int + default: 5 + priority: + description: "The importance of this message. 0 is not very important, 100 is very important.\n" + type: Int + default: 50 diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/.ref-cache.yaml b/experimenter/experimenter/features/manifests/firefox-desktop/.ref-cache.yaml index 107f15156b..20572b3564 100644 --- a/experimenter/experimenter/features/manifests/firefox-desktop/.ref-cache.yaml +++ b/experimenter/experimenter/features/manifests/firefox-desktop/.ref-cache.yaml @@ -1,5 +1,5 @@ -beta: a87dec4d1a044810a41019268cbbc16576151ff4 -central: 6f928a37b801026db617dc5dedfe5a4f9bc88f8c -esr115: 88f0c6469f0863c010a5fd612f0b066cc94cce1a -esr128: c38bfc9b63052538c37f6cad932930232c0982e0 -release: e2dc4b9cd0bd84a97787f92cf5cdfcfb22da4979 +beta: 11c6b0210a464d98b3d839c420cdb644f43ab6fc +central: 9358b6a02a04f62e0c9c7fcba4877700076a28f5 +esr115: 950fa856c4ef59ad26e31a51c44fd76f73b0ec01 +esr128: 9d48e0e99765af7020d870dd963724640921c2c8 +release: 16552dac84b1dddbf525916b3121fb046d8e18f8 diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/v133.0.1/experimenter.yaml b/experimenter/experimenter/features/manifests/firefox-desktop/v133.0.1/experimenter.yaml new file mode 100644 index 0000000000..26052f35d9 --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v133.0.1/experimenter.yaml @@ -0,0 +1,3959 @@ +# 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 + 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 + 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` is for search engine experimentation features which do not require +# isEarlyStartup to be set. +search: + description: Search engine experimentation support and testing features. + owner: search-and-suggest-program@mozilla.com + hasExposure: false + variables: + 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: + + "extraParams": [ + { + "name": "channel", + "pref": "google_channel_row", + "condition": "pref" + } + ], + + 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. Only the search team can update the configuration. + logEnabled: + type: boolean + setPref: + branch: default + pref: browser.search.log + description: >- + Whether or not enable search log in their console. + richSuggestionsFeatureGate: + type: boolean + setPref: + branch: default + pref: browser.urlbar.richSuggestions.featureGate + description: >- + Feature gate that controls whether Rich Suggestions are enabled. + 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 + serpEventTelemetryCategorizationEnabled: + type: boolean + setPref: + branch: default + pref: browser.search.serpEventTelemetryCategorization.enabled + description: Whether the Glean SERP event telemetry for SERP categorization is enabled. + trendingEnabled: + type: boolean + setPref: + branch: default + pref: browser.urlbar.trending.featureGate + description: Feature gate that controls whether trending suggestions are enabled. + 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. + newSearchConfigEnabled: + type: boolean + setPref: + branch: user + pref: browser.search.newSearchConfig.enabled + description: >- + Whether search-config-v2 is enabled for the user. This will only take + effect when the user restarts. + Obsolete. This is kept until all multi-feature roll-outs using it are + ended to prevent un-enrollment. + targetExperiment: + type: string + description: >- + The slug of the experiment someone is requesting enrollment and branch + information for. (Note that the featureId needs to be set to "search".) + +# `searchConfiguration` is for search experiment features for items that require +# isEarlyStartup to be true. These items may require a reload of the search +# engine configuration, and an additional reload may happen during the startup +# process. +searchConfiguration: + description: Search experimentation support for the engine configuration + owner: search-and-suggest-program@mozilla.com + isEarlyStartup: true + hasExposure: false + variables: + experiment: + type: string + fallbackPref: browser.search.experiment + description: >- + Used to activate only matching configurations that contain the value in + `experiment` + seperatePrivateDefaultUIEnabled: + type: boolean + description: Whether the UI for the separate private default feature is enabled. + seperatePrivateDefaultUrlbarResultEnabled: + type: boolean + 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: + 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. + autoFillAdaptiveHistoryEnabled: + type: boolean + fallbackPref: browser.urlbar.autoFill.adaptiveHistory.enabled + description: Whether enabling adaptive history autofill. + autoFillAdaptiveHistoryMinCharsThreshold: + type: int + fallbackPref: browser.urlbar.autoFill.adaptiveHistory.minCharsThreshold + 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. + experimentType: + type: string + description: The type of the experiment (or rollout). If "best-match", then the Nimbus exposure event will be recorded when the user first triggers a best match (or would have triggered a best match, for users in the control group). If empty, the event will be recorded when the user first triggers any type of Suggest suggestion. + enum: + - best-match + - "" + 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. + fakespotMinKeywordLength: + type: int + description: >- + The minimum prefix length of a Fakespot keyword the user must type to + trigger the suggestion. + fakespotShowLessFrequentlyCap: + type: int + fallbackPref: browser.urlbar.fakespot.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 Fakespot + suggestions. If undefined or zero, the user will be able to click the + command without any limit. + fakespotSuggestedIndex: + type: int + fallbackPref: browser.urlbar.fakespot.suggestedIndex + description: >- + The index of Fakespot results within the Firefox Suggest section. A + negative index is relative to the end of the section. + 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. + 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. + 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. + pocketFeatureGate: + type: boolean + fallbackPref: browser.urlbar.pocket.featureGate + description: >- + Feature gate that controls whether all aspects of the Pocket suggestions + feature are exposed to the user. + pocketShowLessFrequentlyCap: + 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 Pocket + suggestions. If undefined or zero, the user will be able to click the + command without any limit. + pocketSuggestIndex: + type: int + description: >- + The group-relative suggestedIndex of Pocket suggestions within the Firefox + Suggest section. + quickSuggestAllowPositionInSuggestions: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.allowPositionInSuggestions + description: Whether quick suggest results can be shown in position specified in the suggestions. + quickSuggestAmpTopPickCharThreshold: + type: int + fallbackPref: browser.urlbar.quicksuggest.ampTopPickCharThreshold + description: >- + Character-count threshold (inclusive) for showing AMP suggestions as top + picks. If an AMP suggestion is triggered by a keyword at least this many + characters long, it will be shown as a top pick. When this variable is + set, full keywords will also show AMP suggestions as top picks even if + they have fewer characters than this threshold. + quickSuggestContextualOptInEnabled: + type: boolean + setPref: + branch: default + pref: browser.urlbar.quicksuggest.contextualOptIn + description: Whether the Firefox Suggest contextual opt-in result is enabled. If true, this implicitly disables shouldShowOnboardingDialog. + quickSuggestContextualOptInSayHello: + type: boolean + setPref: + branch: default + pref: browser.urlbar.quicksuggest.contextualOptIn.sayHello + description: Controls which variant of the copy is used for the Firefox Suggest contextual opt-in result. + quickSuggestContextualOptInTopPosition: + type: boolean + setPref: + branch: default + pref: browser.urlbar.quicksuggest.contextualOptIn.topPosition + description: Controls whether the Firefox Suggest contextual opt-in result appears at the top of results or at the bottom, after one-off buttons. + quickSuggestDataCollectionEnabled: + type: boolean + description: Whether data collection 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) data collection, if the user has already toggled that preference. + 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. + quickSuggestExposureSuggestionTypes: + type: string + setPref: + pref: browser.urlbar.quicksuggest.exposureSuggestionTypes + branch: user + description: >- + Comma-separated list of Suggest exposure suggestion types to enable. + Exposure suggestions are used to test potential exposures. They trigger + exposure telemetry based on a set of keywords you provide but they are + never visible. Set this variable to the `suggestion_type` defined in the + remote settings record(s) that contains your keywords. If you want to + test multiple suggestion types, separate them with commas, but also + 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`. + quickSuggestHideSettingsUI: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.hideSettingsUI + description: >- + This variable is intended to be used in potential exposure experiments + in regions and locales where Suggest normally isn't enabled. Potential + exposure suggestions are implemented in Suggest, and this variable lets + us enable core Suggest functionality but keep it hidden. Set both + `quickSuggestEnabled` and `quickSuggestHideSettingsUI` to true, along + with `quickSuggestExposureSuggestionTypes`. This variable does NOT hide + visible suggestions and other UI that can be independently enabled with + other Nimbus variables. But since all visible suggestions are disabled + by default for users not in the Suggest population, as long as you don't + set any Nimbus variables to enable other suggestions and UI, Suggest + will remain hidden. + 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. + quickSuggestMlEnabled: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.mlEnabled + description: >- + Whether Suggest will use the ML backend in addition to Rust. + quickSuggestNonSponsoredEnabled: + type: boolean + description: Whether non-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) non-sponsored suggestions, if the user has already toggled that preference. + 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 + quickSuggestOnboardingDialogVariation: + type: string + description: >- + Specify the messages/UI variation for QuickSuggest onboarding dialog. This value is case insensitive. + 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 + quickSuggestRemoteSettingsDataType: + type: string + description: The `type` of the suggestions data in remote settings. If not specified, "data" is used. + quickSuggestRustEnabled: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.rustEnabled + description: >- + Whether Firefox Suggest will use the new Rust backend instead of the + original JS backend. + quickSuggestScenario: + # IMPORTANT: This should not have a fallbackPref. See UrlbarPrefs.sys.mjs. + type: string + description: The Firefox Suggest scenario in which the user is enrolled + enum: + - history + - offline + - online + 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` + quickSuggestShouldShowOnboardingDialog: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.shouldShowOnboardingDialog + description: Whether or not to show the QuickSuggest onboarding dialog + quickSuggestShowOnboardingDialogAfterNRestarts: + type: int + fallbackPref: browser.urlbar.quicksuggest.showOnboardingDialogAfterNRestarts + description: Show QuickSuggest onboarding dialog after N browser restarts + 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. + 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. + recordNavigationalSuggestionTelemetry: + type: boolean + description: Whether to record navigational suggestion telemetry. Defaults to false. + showSearchTermsFeatureGate: + type: boolean + fallbackPref: browser.urlbar.showSearchTerms.featureGate + description: Gate for the show search terms feature. If false, the preference#search will not show the search terms feature checkbox, and search terms will never persist in the urlbar. If true, the preference checkbox will be shown on preferences#search, and the user can choose to persist search terms on or off in 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. + weatherKeywordsMinimumLengthCap: + type: int + description: >- + If defined and non-zero, the user will not be able to increment the + minimum keyword length beyond this value. e.g., if this value is 6, the + current minimum length is 5, and the user clicks "Show less frequently", + then the minimum length will be incremented to 6, the "Show less + frequently" command will be hidden, and the user can continue to trigger + the weather suggestion by typing 6 characters, but they will not be able + to increment the minimum length any further. If this variable is absent + or zero, Firefox will fall back to the cap defined in remote settings. + If neither Nimbus nor remote settings defines a cap, no cap will be + used, and the user will be able to increment the minimum length without + any limit. + weatherSimpleUI: + type: boolean + description: >- + If true, show the weather suggestion by simple UI edition as follows. + * Remove the forcast text from the summary text. + 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. + 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. + 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" + 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@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 + showModal: + type: boolean + fallbackPref: browser.aboutwelcome.showModal + description: >- + Should users see window modal onboarding + 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 + +moreFromMozilla: + description: "New page on about:preferences to suggest more Mozilla products" + owner: omc@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@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@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 + +newtab: + description: "The about:newtab page" + owner: omc@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 + +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 + +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. + +newtabAdSizingExperiment: + description: >- + Change the default ad size and UI for certain ad formats. + owner: achurchwell@mozilla.com, sdowne@mozilla.com + hasExposure: false + variables: + variantA: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabAdSize.variant-a + description: >- + Variant A ad size and UI. + variantB: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabAdSize.variant-b + description: >- + Variant B ad size and UI. + +newtabLayoutExperiment: + description: >- + Change the default layout of new tab by adjusting sizes and spacing of elements. + owner: achurchwell@mozilla.com, sdowne@mozilla.com + hasExposure: false + variables: + variantA: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabLayouts.variant-a + description: >- + Variant A in layouts experiment. + variantB: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabLayouts.variant-b + description: >- + Variant B in layouts experiment. + +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. + +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 + +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 + +pocketNewtab: + description: The Pocket section in newtab + owner: sdowne@mozilla.com + hasExposure: false + isEarlyStartup: true + variables: + spocTopsitesPositions: + type: string + fallbackPref: browser.newtabpage.activity-stream.discoverystream.spoc-topsites-positions + description: CSV string of spoc position indexes on newtab topsites section + 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. + spocTopsitesAdTypes: + type: string + fallbackPref: browser.newtabpage.activity-stream.discoverystream.spocTopsitesAdTypes + description: CSV string of data to set the spoc content. + spocTopsitesZoneIds: + type: string + fallbackPref: browser.newtabpage.activity-stream.discoverystream.spocTopsitesZoneIds + description: CSV string of data to set the spoc content. + spocTopsitesPlacementEnabled: + type: boolean + fallbackPref: browser.newtabpage.activity-stream.discoverystream.spocTopsitesPlacement.enabled + description: Tuns on and off the sponsored topsites placement. + 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 + saveToPocketCard: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.saveToPocketCard.enabled + description: >- + A save to Pocket button inside the card, shown on the card thumbnail, on + hover. + saveToPocketCardRegions: + type: string + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.saveToPocketCardRegions + description: >- + CSV string of regions that support the save to Pocket button inside the card. + 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. + onboardingExperience: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.onboardingExperience.enabled + description: >- + Enables an onboarding experience for Pocket section on newtab. + essentialReadsHeader: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.essentialReadsHeader.enabled + description: >- + Updates the Pocket section header and title to say "Today’s Essential Reads", + moves the "Recommended by Pocket" header to the right side. + editorsPicksHeader: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.editorsPicksHeader.enabled + description: >- + Updates the Pocket section header and title to say "Editor’s Picks", if used with + essentialReadsHeader, creates a second section 2 rows down for editorsPicksHeader. + recentSavesEnabled: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.recentSaves.enabled + description: >- + Updates the Pocket section with a new header and 1 row of recently saved Pocket stories. + 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. + sendToPocket: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.sendToPocket.enabled + description: >- + Decides what to do when a logged out user click "Save to Pocket" from a Pocket card. + wallpapers: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.enabled + description: >- + Turns on and off wallpaper support. + wallpapersV2: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.v2.enabled + description: >- + Turns on and off updated wallpaper experience. + 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 + weatherLocationSearch: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.weather.locationSearchEnabled + description: >- + Turns on and off location search for newtab weather widget + recsPersonalized: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.recs.personalized + description: >- + Enables Pocket stories personalization. + spocsPersonalized: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.spocs.personalized + description: >- + Enables Pocket sponsored content personalization. + discoveryStreamConfig: + description: A JSON blob of discovery stream configuration. + type: string + setPref: + branch: user + pref: "browser.newtabpage.activity-stream.discoverystream.config" + 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 + spocMessageVariant: + description: Adds some message dialogs explainging sponsored content to the user + type: string + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.spocMessageVariant + regionStoriesConfig: + description: A comma-separated list of region to get stories for. + type: string + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.region-stories-config + regionBffConfig: + type: string + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.region-bff-config + description: A comma-separated list of regions to get stories from the recommendations BFF. Also requires region-stories-config. + merinoProviderEnabled: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.merino-provider.enabled + description: Sets the recommendations provider service to Merino. + 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 + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.region-weather-config + localeWeatherConfig: + description: A comma-separated list of locales that weather widget supports. + type: string + fallbackPref: >- + 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 + topSitesContileSovEnabled: + # Defined under `pocketNewtab` as it needs to be used along with other variables + description: Enable the Share-of-Voice feature for Sponsored Topsites. + type: boolean + fallbackPref: >- + browser.topsites.contile.sov.enabled + 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. + thumbsUpDown: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.thumbsUpDown.enabled + description: Display thumbs up and down buttons on recommended stories + regionThumbsUpDownConfig: + description: A comma-separated list of regions that get thumbs up and down buttons by default. + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.thumbsUpDown.region-thumbs-config + description: Display thumbs up and down buttons on recommended stories + localeThumbsUpDownConfig: + description: A comma-separated list of locales that get thumbs up and down buttons by default. + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.thumbsUpDown.locale-thumbs-config + thumbsUpDownCompactLayout: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.thumbsUpDown.searchTopsitesCompact + description: >- + Change the layout of the sections to be more compact to account for the added card height with the thumbs up/down enabled. + +saveToPocket: + description: The save to Pocket feature + owner: sdowne@mozilla.com + hasExposure: false + variables: + emailButton: + type: boolean + setPref: + branch: user + pref: extensions.pocket.refresh.emailButton.enabled + description: Just for the new Pocket panels, enables the email signup button. + hideRecentSaves: + type: boolean + setPref: + branch: user + pref: extensions.pocket.refresh.hideRecentSaves.enabled + description: Hides the recently saved section in the home panel. + bffRecentSaves: + type: boolean + setPref: + branch: user + pref: extensions.pocket.bffRecentSaves + description: Use the new BFF Proxy Service instead of the legacy Pocket Service for Recent Saves + bffApi: + type: string + setPref: + branch: user + pref: extensions.pocket.bffApi + description: BFF Proxy Service domain + oAuthConsumerKeyBff: + type: string + setPref: + branch: user + pref: extensions.pocket.oAuthConsumerKeyBff + description: BFF Proxy Service OAuth Consumer Key + +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. +upgradeDialog: + description: The dialog shown for major upgrades + owner: omc@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@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@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@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@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@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: {} + +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 + +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 + +# 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 +# 4) add the new feature id to MESSAGING_EXPERIMENTS_DEFAULT_FEATURES list in MessagingExperimentConstants.sys.mjs +# 5) add the new feature id and the version it landed to the spreadsheet tab linked to above + +fxms-message-1: + description: "A Firefox Messaging System message" + owner: omc@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@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@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@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@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@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@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@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@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@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@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@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@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. + +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 + hasExposure: false + variables: + newtabPingEnabled: + type: "boolean" + fallbackPref: "browser.newtabpage.ping.enabled" + description: "Whether to submit the 'newtab' ping" + 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 + 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 + +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" + +scriptLoaderPrefs: + description: Prefs that control the script loader. + owner: npierron@mozilla.com + hasExposure: false + variables: + delazificationStrategy: + description: >- + Selects which parsing/delazification strategy should be used while + parsing scripts off-main-thread. See DelazificationOption in + CompileOptions.h for values. + type: int + setPref: + branch: default + pref: "dom.script_loader.delazification.strategy" + +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" + enableFallbackWarningPage: + description: Whether DoH fallback warning page will be displayed when DoH doesn't work in TRR first mode. + type: boolean + setPref: + branch: default + pref: "network.trr.display_fallback_warning" + showFallbackCheckbox: + description: Whether the checkbox to enable the fallback warning page is displayed in the settings UI. + type: boolean + setPref: + branch: default + pref: "network.trr_ui.show_fallback_warning_option" + 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: + 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" + 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" + preconnect: + description: Whether the rel=preconnect feature is enabled + type: boolean + setPref: + branch: default + pref: "network.preconnect" + networkPredictor: + description: Whether the Necko predictor is enabled + type: boolean + setPref: + branch: default + pref: "network.predictor.enabled" + 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" + sendOnDataFinished: + description: Whether we can send OnDataFinished in the content process + type: boolean + setPref: + branch: default + pref: "network.send_OnDataFinished" + sendOnDataFinshedFromInputStreamPump: + 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" + 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" + 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" + speculativeConnectionLimit: + description: The maximum number of half-open sockets allowed for speculative connections + type: int + setPref: + branch: default + pref: "network.http.speculative-parallel-limit" + chipsEnabled: + description: Whether CHIPS is enabled or not + type: boolean + setPref: + branch: default + pref: "network.cookie.CHIPS.enabled" + 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" + +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" + +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. + +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" + +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 + +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: pbz@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. + +fontvisibility: + description: Control Font Visibility in PBM + owner: tom@mozilla.com + hasExposure: false + variables: + enabledETP: + type: int + setPref: + branch: default + pref: layout.css.font-visibility.trackingprotection + description: Set the Font Visibility level when Enhanced Tracking Protection is enabled + enabledStandard: + type: int + setPref: + branch: default + pref: layout.css.font-visibility.standard + description: Set the Font Visibility level for normal browsing + enabledPBM: + type: int + setPref: + branch: default + pref: layout.css.font-visibility.private + description: Set the Font Visibility level for private browsing (will override ETP) + +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 + +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. + +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 + image: + description: True if the mixed content upgrading is enabled for images + type: boolean + setPref: + branch: default + pref: security.mixed_content.upgrade_display_content.image + audio: + description: True if the mixed content upgrading is enabled for audio + type: boolean + setPref: + branch: default + pref: security.mixed_content.upgrade_display_content.audio + video: + description: True if the mixed content upgrading is enabled for videos + type: boolean + setPref: + branch: default + pref: security.mixed_content.upgrade_display_content.video + +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" + +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" + +raceCacheWithNetwork: + description: Prefs to toggle the race cache with network. + owner: dpalmeiro@mozilla.com, acreskey@mozilla.com + hasExposure: false + variables: + enabled: + description: True to enable the rcwn feature. + type: boolean + setPref: + branch: default + pref: "network.http.rcwn.enabled" + +shopping2023: + description: Prefs to control the 2023 shopping experiment. + owner: jhirsch@mozilla.com + hasExposure: true + exposureDescription: >- + The timing of the exposure event depends on the experiment, but generally + the event is recorded when the user first encounters onboarding UI for + the shopping feature. + variables: + enabled: + description: True if the experience is enabled (experimental treatment group) + type: boolean + fallbackPref: browser.shopping.experience2023.enabled + control: + description: True if the experiment is enabled but experience is disabled (experimental control group) + type: boolean + fallbackPref: browser.shopping.experience2023.control + adsEnabled: + description: True if showing recommended products is enabled + type: boolean + setPref: + branch: default + pref: browser.shopping.experience2023.ads.enabled + adsExposure: + description: True if we want to record ad inventory for opted-in users, even if ads are disabled + type: boolean + setPref: + branch: default + pref: browser.shopping.experience2023.ads.exposure + surveyEnabled: + description: True if showing survey is enabled + type: boolean + fallbackPref: browser.shopping.experience2023.survey.enabled + autoOpenEnabled: + description: True if auto-open behavior for the sidebar is enabled + type: boolean + setPref: + branch: default + pref: browser.shopping.experience2023.autoOpen.enabled + +shoppingOHTTP: + description: Prefs to control the OHTTP URLs used for shopping. + owner: gijs@mozilla.com + hasExposure: false + variables: + ohttpRelayURL: + description: What OHTTP relay URL to use + type: string + setPref: + branch: default + pref: toolkit.shopping.ohttpRelayURL + ohttpConfigURL: + description: URL for the OHTTP config to use + type: string + setPref: + branch: default + pref: toolkit.shopping.ohttpConfigURL + +opaqueResponseBlocking: + description: Prefs to enable Opaque Response Blocking + owner: farre@mozilla.com + hasExposure: true + exposureDescription: Exposure is sent when a response is blocked + 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@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@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. + +cookieBannerHandling: + description: Automatically handle cookie banners on the user's behalf. + owner: pbz@mozilla.com + hasExposure: false + variables: + modeNormalBrowsing: + type: int + setPref: + branch: default + pref: cookiebanners.service.mode + description: >- + Controls the cookie banner handling mode in normal browsing. + Values: 0 - disabled, 1 - reject all, 2 - reject all with accept all fallback. + modePrivateBrowsing: + type: int + setPref: + branch: default + pref: cookiebanners.service.mode.privateBrowsing + description: >- + Controls the cookie banner handling mode in private browsing. + Values: 0 - disabled, 1 - reject all, 2 - reject all with accept all fallback. + enableGlobalRules: + type: boolean + setPref: + branch: default + pref: cookiebanners.service.enableGlobalRules + description: >- + Enables use of global CookieBannerRules, which apply to all sites. + This enables handling of CMPs across sites without the use of site-specific rules. + enableGlobalRulesSubFrames: + type: boolean + setPref: + branch: default + pref: cookiebanners.service.enableGlobalRules.subFrames + description: >- + Whether global rules are allowed to run in sub-frames. Running query + selectors in every sub-frame may negatively impact performance, but is + required for some CMPs. + enableDetectOnly: + type: boolean + setPref: + branch: default + pref: cookiebanners.service.detectOnly + description: >- + When set to true, cookie banners are detected and detection events are + dispatched, but they will not be handled. + This pref applies to both normal and private browsing windows. + enableFirefoxDesktopUI: + type: boolean + setPref: + branch: default + pref: cookiebanners.ui.desktop.enabled + description: Enables the cookie banner desktop UI. + enablePromo: + type: boolean + setPref: + branch: default + pref: browser.promo.cookiebanners.enabled + description: Enables the cookie banner promo in about:privatebrowsing. + enableDesktopFeatureCallout: + type: boolean + setPref: + branch: default + pref: cookiebanners.ui.desktop.showCallout + description: Enables the cookie banner feature callout on desktop. + +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 + +reportBrokenSite: + description: The Report Broken Site feature + owner: twisniewski@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: ui.new-webcompat-reporter.enabled + description: >- + Whether Report Broken Site is enabled + sendMoreInfo: + type: boolean + setPref: + branch: user + pref: ui.new-webcompat-reporter.send-more-info-link + description: >- + Whether Report Broken Site shows the send more info link directing + users to webcompat.com (defaults to true for prerelease channels) + reasonDropdown: + type: int + setPref: + branch: user + pref: ui.new-webcompat-reporter.reason-dropdown + description: >- + 0 = do not show the "reason" dropdown + 1 = show an optional "reason" dropdown + 2 = show a required "reason" dropdown + +feltPrivacy: + description: Prefs for Felt Privacy v1 experiments + owner: cmeador@mozilla.com + hasExposure: true + exposureDescription: Exposure when user opens a private browsing window. + variables: + feltPrivacy: + type: boolean + setPref: + branch: default + pref: browser.privatebrowsing.felt-privacy-v1 + description: >- + When true, new styles and copy enabled on about:privatebrowsing. When true, + a toggle for showing or hiding quick suggestions appears in about:preferences. + resetPBMAction: + type: boolean + setPref: + branch: default + pref: browser.privatebrowsing.resetPBM.enabled + description: >- + Enables the reset PBM feature button and confirmation panel. + +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 + type: int + setPref: + branch: user + pref: memory.phc.avg_delay.first + phcAvgDelayNormal: + description: The delay between PHC allocations + type: int + setPref: + branch: user + pref: memory.phc.avg_delay.normal + phcAvgDelayPageReuse: + description: The delay before reusing a PHC page + type: int + setPref: + branch: user + pref: memory.phc.avg_delay.page_reuse + +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 + +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: chumphreys@mozilla.com + hasExposure: false + applications: + - firefox-desktop + variables: + gleanMetricConfiguration: + description: A Glean metric configuration JSON blob. + type: 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. + prefsUIEnabled: + type: boolean + setPref: + branch: default + pref: browser.backup.preferences.ui.enabled + description: >- + When true, the section in about:preferences to control the backup + feature is visible. + 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 + +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. + +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. + tlsEnableBrotli: + type: boolean + setPref: + branch: default + pref: security.tls.enable_certificate_compression_brotli + description: >- + Whether to enable Brotli for TLS certificate compression. + tlsEnableZstd: + type: boolean + setPref: + branch: default + pref: security.tls.enable_certificate_compression_zstd + description: >- + Whether to enable Zstd for TLS certificate compression. + +bounceTrackingProtection: + description: Controls the Bounce Tracking Protection feature. + owner: pbz@mozilla.com + hasExposure: false + variables: + enabled: + type: int + setPref: + branch: default + pref: privacy.bounceTrackingProtection.mode + description: Mode to run the feature in. See nsIBounceTrackingProtection.idl for documentation. + +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: + 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. + +sidebar: + description: Sidebar feature configuration + owner: elee@mozilla.com + hasExposure: false + variables: + minVersion: + type: string + description: Minimum Firefox version to apply prefs + main.tools: + type: string + description: sidebar.main.tools pref value to set on user branch + revamp: + type: boolean + description: sidebar.revamp pref value to set on user branch + verticalTabs: + type: boolean + description: sidebar.verticalTabs pref value to set on user branch + +fxms_bmb_button: + description: A feature for the Firefox Messaging System Bookmarks Bar button surface + owner: omc@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: {} + +contentProcessSandbox: + description: Prefs that control the content process sandbox. + owner: bowen@mozilla.com + hasExposure: false + variables: + Level: + description: Content process sandbox level + type: int + setPref: + branch: user + pref: security.sandbox.content.level + +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). diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/v133.0.1/schemas/browser/components/asrouter/content-src/schemas/BackgroundTaskMessagingExperiment.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v133.0.1/schemas/browser/components/asrouter/content-src/schemas/BackgroundTaskMessagingExperiment.schema.json new file mode 100644 index 0000000000..5fe86f9617 --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v133.0.1/schemas/browser/components/asrouter/content-src/schemas/BackgroundTaskMessagingExperiment.schema.json @@ -0,0 +1,344 @@ +{ + "$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" + }, + "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": { + "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" + ] + }, + "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" + } + ] + }, + "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/v133.0.1/schemas/browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v133.0.1/schemas/browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json new file mode 100644 index 0000000000..6067f38398 --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v133.0.1/schemas/browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json @@ -0,0 +1,1623 @@ +{ + "$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": { + "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": "Should the message be global (persisted across tabs) or local (disappear when switching to a different tab).", + "enum": [ + "global", + "tab" + ] + }, + "text": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "The text show in the notification box." + }, + "priority": { + "description": "Infobar priority level https://searchfox.org/mozilla-central/rev/3aef835f6cb12e607154d56d68726767172571e4/toolkit/content/widgets/notificationbox.js#387", + "type": "number", + "minumum": 0, + "exclusiveMaximum": 10 + }, + "buttons": { + "type": "array", + "items": { + "type": "object", + "properties": { + "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": { + "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 + } + } + }, + "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" + } + } + }, + "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.", + "enum": [ + "fxa_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 second text for the message, which offers more detail on the value proposition to the user." + }, + "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." + }, + "imageURL": { + "type": "string", + "description": "URL for image to use with the content." + }, + "imageVerticalOffset": { + "type": "number", + "description": "The margin-block-start value to apply to the image in pixels." + } + } + }, + "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." + }, + "infoEnabled": { + "type": "boolean", + "description": "Should we show the info section." + }, + "infoIcon": { + "type": "string", + "description": "Icon shown in the left side of the info section. Default is the private browsing icon." + }, + "infoTitle": { + "type": "string", + "description": "Is the title in the info section enabled." + }, + "infoTitleEnabled": { + "type": "boolean", + "description": "Is the title in the info section enabled." + }, + "infoBody": { + "type": "string", + "description": "Text content in the info section." + }, + "infoLinkText": { + "type": "string", + "description": "Text for the link in the info section." + }, + "infoLinkUrl": { + "type": "string", + "description": "URL for the info section link.", + "format": "moz-url-format" + }, + "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": [ + "FOCUS", + "VPN", + "PIN", + "COOKIE_BANNERS", + "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" + ] + } + }, + { + "if": { + "properties": { + "infoEnabled": { + "const": true + } + }, + "required": [ + "infoEnabled" + ] + }, + "then": { + "required": [ + "infoLinkText" + ], + "if": { + "properties": { + "infoTitleEnabled": { + "const": true + } + }, + "required": [ + "infoTitleEnabled" + ] + }, + "then": { + "required": [ + "infoTitle" + ] + } + } + } + ] + }, + "template": { + "type": "string", + "const": "pb_newtab" + } + }, + "additionalProperties": true, + "required": [ + "targeting" + ] + }, + "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" + }, + "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" + }, + "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": [ + "bookmarks_bar_button", + "cfr_urlbar_chiclet", + "cfr_doorhanger", + "milestone_message", + "infobar", + "menu_message", + "pb_newtab", + "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": { + "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" + ] + }, + "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" + } + ] + }, + "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": [ + "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": [ + "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/v133.0.1/schemas/toolkit/components/nimbus/schemas/PrefFlipsFeature.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v133.0.1/schemas/toolkit/components/nimbus/schemas/PrefFlipsFeature.schema.json new file mode 100644 index 0000000000..9fa5acc7c9 --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v133.0.1/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/v133.0.1/schemas/toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v133.0.1/schemas/toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json new file mode 100644 index 0000000000..6915fc9b71 --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v133.0.1/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", "nag"], + "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/focus-ios/.ref-cache.yaml b/experimenter/experimenter/features/manifests/focus-ios/.ref-cache.yaml index 2c5f448684..4bf96bc9f6 100644 --- a/experimenter/experimenter/features/manifests/focus-ios/.ref-cache.yaml +++ b/experimenter/experimenter/features/manifests/focus-ios/.ref-cache.yaml @@ -12,7 +12,7 @@ focus/klar-v131.0: 34d92c8df1b1522a1da88c23879b439d763ec133 focus/klar-v131.1: b7dca2271b14988837524a30eb154d91eb5e4912 focus/klar-v132.0: d9ed6134db59ff456d343e2bb211aefd040319ac focus/klar-v133.0: a3372669a06fa684d3c5945c317d6787e3125303 -main: 8e5d9ddc6c30ccf8d406254e5bc6bf42a3fb1bf0 +main: f5cc8c8216ab73b9f4853c6a11c53c6ffcfac47e release/v124: da250bed9e19c4978d4400d6d404cb312e33636e release/v125: a3e1e0773a00009e08d95726fd518ab642255ccd release/v126: 6f305409b4af68e8404401a2caad8cb0da9a0494 @@ -23,4 +23,4 @@ release/v130: a48ec1b1f0219e1987bb38bc4f6b838f37dc6f12 release/v131: 7444df581b62d357df12ddc3c90d821d940efbb8 release/v132: cb318d0061ec6354167ecc1968020d5d75f1bffc release/v133: db90b9da0634ba55275e188ef587be95b2f840bf -release/v134: fe89d1eb2815324eacf979031848a3f2850a62fe +release/v134: 4644e1d93ed4fa9297b92b7b58465c0b74393f8c diff --git a/experimenter/experimenter/features/manifests/ios/.ref-cache.yaml b/experimenter/experimenter/features/manifests/ios/.ref-cache.yaml index 6a30d65ea0..aafce6547e 100644 --- a/experimenter/experimenter/features/manifests/ios/.ref-cache.yaml +++ b/experimenter/experimenter/features/manifests/ios/.ref-cache.yaml @@ -1,4 +1,4 @@ -main: 8e5d9ddc6c30ccf8d406254e5bc6bf42a3fb1bf0 +main: f5cc8c8216ab73b9f4853c6a11c53c6ffcfac47e release/v117: 43b690c450066d4dde1b2ccb93ed3714d244d502 release/v118: 89a7ea3c3372e5a4ef5b3c5b85499d26198d0524 release/v119: 7dc381f991c6d2a983c3ba7f0cffd880e8c29e7b @@ -16,7 +16,7 @@ release/v130: a48ec1b1f0219e1987bb38bc4f6b838f37dc6f12 release/v131: 7444df581b62d357df12ddc3c90d821d940efbb8 release/v132: cb318d0061ec6354167ecc1968020d5d75f1bffc release/v133: db90b9da0634ba55275e188ef587be95b2f840bf -release/v134: fe89d1eb2815324eacf979031848a3f2850a62fe +release/v134: 4644e1d93ed4fa9297b92b7b58465c0b74393f8c 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 3349ac6133..9b11398d84 100644 --- a/experimenter/experimenter/features/manifests/ios/beta.fml.yaml +++ b/experimenter/experimenter/features/manifests/ios/beta.fml.yaml @@ -453,6 +453,13 @@ features: description: "If true, the password generator feature is enabled" type: Boolean default: false + pull-to-refresh-refactor-feature: + description: "The Feature flag to manage the roll out of the new pull to refresh feature.\n" + variables: + enabled: + description: "Enables the feature\n" + type: Boolean + default: true redux-search-settings-feature: description: "This feature is for managing the roll out of redux on the search settings screen\n" variables: diff --git a/experimenter/experimenter/features/manifests/ios/developer.fml.yaml b/experimenter/experimenter/features/manifests/ios/developer.fml.yaml index 9a02ea448d..66f9ec5d36 100644 --- a/experimenter/experimenter/features/manifests/ios/developer.fml.yaml +++ b/experimenter/experimenter/features/manifests/ios/developer.fml.yaml @@ -463,6 +463,13 @@ features: description: "If true, the password generator feature is enabled" type: Boolean default: true + pull-to-refresh-refactor-feature: + description: "The Feature flag to manage the roll out of the new pull to refresh feature.\n" + variables: + enabled: + description: "Enables the feature\n" + type: Boolean + default: true redux-search-settings-feature: description: "This feature is for managing the roll out of redux on the search settings screen\n" variables: diff --git a/experimenter/experimenter/features/manifests/ios/experimenter.yaml b/experimenter/experimenter/features/manifests/ios/experimenter.yaml index 791a75b397..5a2e0ddad0 100644 --- a/experimenter/experimenter/features/manifests/ios/experimenter.yaml +++ b/experimenter/experimenter/features/manifests/ios/experimenter.yaml @@ -193,6 +193,14 @@ password-generator-feature: enabled: type: boolean description: "If true, the password generator feature is enabled" +pull-to-refresh-refactor-feature: + description: "The Feature flag to manage the roll out of the new pull to refresh feature.\n" + hasExposure: true + exposureDescription: "" + variables: + enabled: + type: boolean + description: "Enables the feature\n" redux-search-settings-feature: description: "This feature is for managing the roll out of redux on the search settings screen\n" hasExposure: true diff --git a/experimenter/experimenter/features/manifests/ios/release.fml.yaml b/experimenter/experimenter/features/manifests/ios/release.fml.yaml index c521b7a420..ac09191fd4 100644 --- a/experimenter/experimenter/features/manifests/ios/release.fml.yaml +++ b/experimenter/experimenter/features/manifests/ios/release.fml.yaml @@ -435,6 +435,13 @@ features: description: "If true, the password generator feature is enabled" type: Boolean default: false + pull-to-refresh-refactor-feature: + description: "The Feature flag to manage the roll out of the new pull to refresh feature.\n" + variables: + enabled: + description: "Enables the feature\n" + type: Boolean + default: false redux-search-settings-feature: description: "This feature is for managing the roll out of redux on the search settings screen\n" variables: diff --git a/experimenter/experimenter/features/manifests/ios/v135.0.0/beta.fml.yaml b/experimenter/experimenter/features/manifests/ios/v135.0.0/beta.fml.yaml index 3349ac6133..9b11398d84 100644 --- a/experimenter/experimenter/features/manifests/ios/v135.0.0/beta.fml.yaml +++ b/experimenter/experimenter/features/manifests/ios/v135.0.0/beta.fml.yaml @@ -453,6 +453,13 @@ features: description: "If true, the password generator feature is enabled" type: Boolean default: false + pull-to-refresh-refactor-feature: + description: "The Feature flag to manage the roll out of the new pull to refresh feature.\n" + variables: + enabled: + description: "Enables the feature\n" + type: Boolean + default: true redux-search-settings-feature: description: "This feature is for managing the roll out of redux on the search settings screen\n" variables: diff --git a/experimenter/experimenter/features/manifests/ios/v135.0.0/developer.fml.yaml b/experimenter/experimenter/features/manifests/ios/v135.0.0/developer.fml.yaml index 9a02ea448d..66f9ec5d36 100644 --- a/experimenter/experimenter/features/manifests/ios/v135.0.0/developer.fml.yaml +++ b/experimenter/experimenter/features/manifests/ios/v135.0.0/developer.fml.yaml @@ -463,6 +463,13 @@ features: description: "If true, the password generator feature is enabled" type: Boolean default: true + pull-to-refresh-refactor-feature: + description: "The Feature flag to manage the roll out of the new pull to refresh feature.\n" + variables: + enabled: + description: "Enables the feature\n" + type: Boolean + default: true redux-search-settings-feature: description: "This feature is for managing the roll out of redux on the search settings screen\n" variables: diff --git a/experimenter/experimenter/features/manifests/ios/v135.0.0/experimenter.yaml b/experimenter/experimenter/features/manifests/ios/v135.0.0/experimenter.yaml index 791a75b397..5a2e0ddad0 100644 --- a/experimenter/experimenter/features/manifests/ios/v135.0.0/experimenter.yaml +++ b/experimenter/experimenter/features/manifests/ios/v135.0.0/experimenter.yaml @@ -193,6 +193,14 @@ password-generator-feature: enabled: type: boolean description: "If true, the password generator feature is enabled" +pull-to-refresh-refactor-feature: + description: "The Feature flag to manage the roll out of the new pull to refresh feature.\n" + hasExposure: true + exposureDescription: "" + variables: + enabled: + type: boolean + description: "Enables the feature\n" redux-search-settings-feature: description: "This feature is for managing the roll out of redux on the search settings screen\n" hasExposure: true diff --git a/experimenter/experimenter/features/manifests/ios/v135.0.0/release.fml.yaml b/experimenter/experimenter/features/manifests/ios/v135.0.0/release.fml.yaml index c521b7a420..ac09191fd4 100644 --- a/experimenter/experimenter/features/manifests/ios/v135.0.0/release.fml.yaml +++ b/experimenter/experimenter/features/manifests/ios/v135.0.0/release.fml.yaml @@ -435,6 +435,13 @@ features: description: "If true, the password generator feature is enabled" type: Boolean default: false + pull-to-refresh-refactor-feature: + description: "The Feature flag to manage the roll out of the new pull to refresh feature.\n" + variables: + enabled: + description: "Enables the feature\n" + type: Boolean + default: false redux-search-settings-feature: description: "This feature is for managing the roll out of redux on the search settings screen\n" variables: