From 75338673e161cab09486747902466e058f8e5d01 Mon Sep 17 00:00:00 2001 From: Experimenter CircleCI Bot Date: Mon, 15 Sep 2025 14:12:37 +0000 Subject: [PATCH] chore(nimbus): Update External Configs --- .../features/manifests/fenix/.ref-cache.yaml | 4 +- .../manifests/fenix/v145.0.0/beta.fml.yaml | 1469 +++++ .../fenix/v145.0.0/developer.fml.yaml | 1526 +++++ .../fenix/v145.0.0/experimenter.yaml | 771 +++ .../manifests/fenix/v145.0.0/nightly.fml.yaml | 1492 +++++ .../manifests/fenix/v145.0.0/release.fml.yaml | 1469 +++++ .../manifests/firefox-desktop/.ref-cache.yaml | 8 +- .../v115.29.0/experimenter.yaml | 1568 +++++ ...kgroundTaskMessagingExperiment.schema.json | 312 + .../schemas/MessagingExperiment.schema.json | 1640 +++++ .../schemas/LegacyHeartbeat.schema.json | 73 + .../v140.4.0/experimenter.yaml | 4863 +++++++++++++++ ...kgroundTaskMessagingExperiment.schema.json | 344 ++ .../schemas/MessagingExperiment.schema.json | 1802 ++++++ .../NimbusTelemetryFeature.schema.json | 35 + .../schemas/PrefFlipsFeature.schema.json | 48 + .../schemas/LegacyHeartbeat.schema.json | 73 + .../v145.0.0/experimenter.yaml | 5265 +++++++++++++++++ ...kgroundTaskMessagingExperiment.schema.json | 344 ++ .../schemas/MessagingExperiment.schema.json | 1969 ++++++ .../NimbusTelemetryFeature.schema.json | 35 + .../schemas/PrefFlipsFeature.schema.json | 48 + .../schemas/LegacyHeartbeat.schema.json | 73 + .../manifests/focus-ios/.ref-cache.yaml | 3 +- .../focus-ios/v143.0.0/beta.fml.yaml | 3 +- .../focus-ios/v143.0.0/developer.fml.yaml | 3 +- .../focus-ios/v143.0.0/experimenter.yaml | 5 +- .../focus-ios/v143.0.0/release.fml.yaml | 3 +- .../focus-ios/v143.2.0/beta.fml.yaml | 20 + .../focus-ios/v143.2.0/developer.fml.yaml | 20 + .../focus-ios/v143.2.0/experimenter.yaml | 16 + .../focus-ios/v143.2.0/release.fml.yaml | 20 + .../features/manifests/ios/.ref-cache.yaml | 6 +- .../manifests/ios/v143.0.1/beta.fml.yaml | 1366 +++++ .../manifests/ios/v143.0.1/developer.fml.yaml | 1376 +++++ .../manifests/ios/v143.0.1/experimenter.yaml | 497 ++ .../manifests/ios/v143.0.1/release.fml.yaml | 1348 +++++ .../manifests/ios/v143.2.0/beta.fml.yaml | 1371 +++++ .../manifests/ios/v143.2.0/developer.fml.yaml | 1381 +++++ .../manifests/ios/v143.2.0/experimenter.yaml | 501 ++ .../manifests/ios/v143.2.0/release.fml.yaml | 1353 +++++ 41 files changed, 34505 insertions(+), 18 deletions(-) create mode 100644 experimenter/experimenter/features/manifests/fenix/v145.0.0/beta.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/fenix/v145.0.0/developer.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/fenix/v145.0.0/experimenter.yaml create mode 100644 experimenter/experimenter/features/manifests/fenix/v145.0.0/nightly.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/fenix/v145.0.0/release.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v115.29.0/experimenter.yaml create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v115.29.0/schemas/browser/components/newtab/content-src/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v115.29.0/schemas/browser/components/newtab/content-src/asrouter/schemas/MessagingExperiment.schema.json create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v115.29.0/schemas/toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v140.4.0/experimenter.yaml create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v140.4.0/schemas/browser/components/asrouter/content-src/schemas/BackgroundTaskMessagingExperiment.schema.json create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v140.4.0/schemas/browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v140.4.0/schemas/toolkit/components/nimbus/schemas/NimbusTelemetryFeature.schema.json create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v140.4.0/schemas/toolkit/components/nimbus/schemas/PrefFlipsFeature.schema.json create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v140.4.0/schemas/toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v145.0.0/experimenter.yaml create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v145.0.0/schemas/browser/components/asrouter/content-src/schemas/BackgroundTaskMessagingExperiment.schema.json create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v145.0.0/schemas/browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v145.0.0/schemas/toolkit/components/nimbus/schemas/NimbusTelemetryFeature.schema.json create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v145.0.0/schemas/toolkit/components/nimbus/schemas/PrefFlipsFeature.schema.json create mode 100644 experimenter/experimenter/features/manifests/firefox-desktop/v145.0.0/schemas/toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json create mode 100644 experimenter/experimenter/features/manifests/focus-ios/v143.2.0/beta.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/focus-ios/v143.2.0/developer.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/focus-ios/v143.2.0/experimenter.yaml create mode 100644 experimenter/experimenter/features/manifests/focus-ios/v143.2.0/release.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/ios/v143.0.1/beta.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/ios/v143.0.1/developer.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/ios/v143.0.1/experimenter.yaml create mode 100644 experimenter/experimenter/features/manifests/ios/v143.0.1/release.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/ios/v143.2.0/beta.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/ios/v143.2.0/developer.fml.yaml create mode 100644 experimenter/experimenter/features/manifests/ios/v143.2.0/experimenter.yaml create mode 100644 experimenter/experimenter/features/manifests/ios/v143.2.0/release.fml.yaml diff --git a/experimenter/experimenter/features/manifests/fenix/.ref-cache.yaml b/experimenter/experimenter/features/manifests/fenix/.ref-cache.yaml index adc99ceb33..eb98c54e65 100644 --- a/experimenter/experimenter/features/manifests/fenix/.ref-cache.yaml +++ b/experimenter/experimenter/features/manifests/fenix/.ref-cache.yaml @@ -1,3 +1,3 @@ -beta: 3833fef2d756639ad1f7c84f358f9fcd5d1f46d1 -main: 16f979184458f531fce47706d2fa7f2902e75ad3 +beta: b0157af119c144738009983f42341d0c30c0120c +main: 1be6d6ec044e795342b20d31f01d82a4e8070ff3 release: d5c80ed4452060187727f00a12568df547813979 diff --git a/experimenter/experimenter/features/manifests/fenix/v145.0.0/beta.fml.yaml b/experimenter/experimenter/features/manifests/fenix/v145.0.0/beta.fml.yaml new file mode 100644 index 0000000000..86f1e8f5e5 --- /dev/null +++ b/experimenter/experimenter/features/manifests/fenix/v145.0.0/beta.fml.yaml @@ -0,0 +1,1469 @@ +version: 1.0.0 +about: + description: Nimbus Feature Manifest for Fenix (Firefox Android) +channels: +- beta +features: + address-sync: + description: Turns on address sync. + variables: + enabled: + description: | + Whether or not to turn on address sync. + type: Boolean + default: false + alternative-app-launcher-icon: + description: A feature that changes the app launcher icon background color. + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + reset-to-default: + description: | + If true use the default icon, if false use the alternative icon. This is required to 'reset' the icon for enrolled users once the initial experiment is complete. + type: Boolean + default: false + app-icon-selection: + description: Allows the user to set an alternative app launcher icon. + variables: + enabled: + description: Whether or not the feature is available for the user. + type: Boolean + default: true + awesomebar-suggestion-provider: + description: Configuration for the Firefox Suggest awesomebar suggestion provider. + variables: + available-suggestion-types: + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + type: Map + default: + amp: true + ampMobile: false + wikipedia: true + baseline-fpp: + description: Control Baseline Fingerprinting Protection + variables: + enabled: + description: Enables / disables baseline fingerprinting protection. + type: Boolean + default: true + feat-enabled: + description: If true, the feature is active. + type: Boolean + default: false + overrides: + description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. + type: String + default: '' + bookmarks: + description: Feature for Bookmarks + variables: + new-compose-ui: + description: if true, enable new compose based UI + type: Boolean + default: false + composable-toolbar: + description: Use a composable toolbar instead of the View based one. + variables: + enabled: + description: | + When the feature is enabled the user will see a new composable toolbar instead the previous View based one. + 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 + custom-review-prompt: + description: Feature that controls the Play store in-app custom review prompt. + variables: + enabled: + description: Whether or not to enable the custom review prompt. + type: Boolean + default: false + doh: + description: Feature controlling DNS over HTTPS (DoH). + variables: + autoselect-enabled: + description: | + Controls the network.android_doh.autoselect_enabled pref and automatically chooses a DoH provider when Default Protection mode is selected. + type: Boolean + default: false + show-ui: + description: | + When `true`, include DoH settings in the settings UI. + type: Boolean + default: true + encourage-search-cfr: + description: A feature that shows a CFR on first launch to encourage users to make a search + variables: + cfrText: + description: The text to show in the CFR + type: Text + default: '' + enabled: + description: When true, the CFR will show + type: Boolean + default: false + fingerprinting-protection: + description: Control Fingerprinting Protection + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + enabled-normal: + description: | + Enables / disables fingerprinting protection in normal browsing mode. + type: Boolean + default: false + enabled-private: + description: | + Enables / disables fingerprinting protection in private browsing mode. + type: Boolean + default: true + fdlibm-math: + description: | + Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy + type: Boolean + default: false + overrides: + description: | + The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. + type: String + default: '' + fission: + description: The feature that controls whether fission is enabled or not in Gecko. + variables: + enabled: + description: | + Whether or not to enable fission. Fission is enabled when set to true. Fission is disabled when set to false. + type: Boolean + default: false + fx-suggest: + description: A feature that provides Firefox Suggest search suggestions. + variables: + boost-amp-wiki: + description: | + The feature boost wiki and AMP suggestions to the top of its group. + type: Boolean + default: false + enabled: + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. + type: Boolean + default: false + glean: + description: A feature that provides server-side configurations for Glean metrics (aka Server Knobs). + variables: + delay-ping-lifetime-io: + description: Glean will delay io for ping lifetime metrics + type: Boolean + default: true + enable-event-timestamps: + description: Enables precise event timestamps for Glean events + type: Boolean + default: true + gleanMetricConfiguration: + description: Configuration for Glean Server Knobs + type: GleanServerKnobsConfiguration + default: + event_threshold: null + metrics_enabled: {} + pings_enabled: {} + ping-lifetime-max-time: + description: After what time to auto-flush + type: Int + default: 2000 + ping-lifetime-threshold: + description: Write count threshold when to auto-flush + type: Int + default: 1000 + allow-coenrollment: true + growth-data: + description: A feature measuring campaign growth data + variables: + enabled: + description: If true, the feature is active + type: Boolean + default: false + homepage-as-new-tab: + description: Enables homepage as a a new tab. + variables: + enabled: + description: | + Whether or not to enable homepage as a new tab + type: Boolean + default: false + homepage-hide-frecent-top-sites: + description: Hides frecent top sites on the homepage. + variables: + enabled: + description: | + Whether or not to hide frecent top sites on the homepage. + type: Boolean + default: false + homepage-search-bar: + description: Enables the homepage search bar. + variables: + enabled: + description: | + Whether or not to enable the homepage search bar. + 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: + header: true + top-sites: true + jump-back-in: true + bookmarks: true + recent-explorations: true + pocket: true + pocket-sponsored-stories: true + synced-tabs: true + collections: true + isolated-content-processes: + description: Feature that controls content process isolation. + variables: + enabled: + description: | + Whether or not to enable isolated content processes. + type: Boolean + default: false + javascript: + description: Enables Javascript Engine (Spidermonkey) features + variables: + parallelMarkingEnabled: + description: | + Enables or disables javascript.options.mem.gc_parallel_marking preference. + type: Boolean + default: false + juno-onboarding: + description: A feature that shows the onboarding flow. + variables: + cards: + description: Collection of user facing onboarding cards. + type: Map + default: + terms-of-service: + body: onboarding_terms_of_service_sub_header_2 + card-type: terms-of-service + disqualifiers: + - NEVER + enabled: true + extra-data: + term-of-service-data: + line-one-text: onboarding_term_of_service_line_one_2 + line-one-link-text: onboarding_term_of_service_line_one_link_text_2 + line-two-text: onboarding_term_of_service_line_two_2 + line-two-link-text: onboarding_term_of_service_line_two_link_text + line-three-text: onboarding_term_of_service_line_three + line-three-link-text: onboarding_term_of_service_line_three_link_text + image-res: ic_firefox + ordering: 1 + prerequisites: + - ALWAYS + primary-button-label: onboarding_term_of_service_agree_and_continue_button_label_2 + secondary-button-label: '' + title: onboarding_welcome_to_firefox + default-browser: + body: juno_onboarding_default_browser_description_nimbus_3 + card-type: default-browser + disqualifiers: + - NEVER + enabled: true + extra-data: null + 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: + body: juno_onboarding_add_search_widget_description + card-type: add-search-widget + disqualifiers: + - NEVER + enabled: true + extra-data: null + 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: + body: juno_onboarding_sign_in_description_3 + card-type: sync-sign-in + disqualifiers: + - NEVER + enabled: true + extra-data: null + 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: + body: juno_onboarding_enable_notifications_description_nimbus_2 + card-type: notification-permission + disqualifiers: + - NEVER + enabled: true + extra-data: null + 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 + theme-selection: + body: onboarding_customize_theme_description + card-type: theme-selection + disqualifiers: + - NEVER + enabled: true + extra-data: + customization-theme-data: + - theme-type: theme-system + label: onboarding_customize_theme_system_option + image-res: ic_pick_a_theme_system_auto + - theme-type: theme-light + label: onboarding_customize_theme_light_option + image-res: ic_pick_a_theme_light + - theme-type: theme-dark + label: onboarding_customize_theme_dark_option + image-res: ic_pick_a_theme_dark + image-res: ic_pick_a_theme + ordering: 33 + prerequisites: + - ALWAYS + primary-button-label: onboarding_save_and_continue_button + secondary-button-label: '' + title: onboarding_customize_theme_title + toolbar-placement: + body: onboarding_customize_toolbar_description + card-type: toolbar-placement + disqualifiers: + - NEVER + enabled: true + extra-data: + customization-toolbar-data: + - toolbar-type: toolbar-top + label: onboarding_customize_toolbar_top_option + image-res: ic_onboarding_top_toolbar + - toolbar-type: toolbar-bottom + label: onboarding_customize_toolbar_bottom_option + image-res: ic_onboarding_bottom_toolbar + image-res: ic_onboarding_customize_toolbar + ordering: 37 + prerequisites: + - ALWAYS + primary-button-label: onboarding_save_and_continue_button + secondary-button-label: '' + title: onboarding_customize_toolbar_title + marketing: + body: onboarding_marketing_body + card-type: marketing-data + disqualifiers: + - NEVER + enabled: true + extra-data: + marketing-data: + body-line-one-text: onboarding_marketing_learn_more + body-line-one-link-text: onboarding_marketing_learn_more + body-line-two-text: onboarding_marketing_opt_out_checkbox + image-res: ic_onboarding_welcome + ordering: 40 + prerequisites: + - ALWAYS + primary-button-label: onboarding_marketing_positive_button + secondary-button-label: '' + title: onboarding_marketing_title + string-alias: OnboardingCardKey + conditions: + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + string-alias: ConditionName + use-onboarding-redesign: + description: If true, use the onboarding redesign. + type: Boolean + default: false + lna-blocking: + description: Feature that allows blocking local network or device access. + variables: + enabled: + description: | + Whether or not to turn on local network / device access blocking + type: Boolean + default: false + menu-redesign: + description: Control the new menu redesign. + variables: + enabled: + description: If true, the new menu redesign is available. + type: Boolean + default: true + menu-banner: + description: If true, the menu banner is visible. + type: Boolean + default: true + report-site-issue: + description: If true, report site issue menu item and preview is available. + type: Boolean + default: true + messaging: + description: | + The in-app messaging system. + variables: + $$experiment: + description: The only acceptable value for `MessageData#experiment`. This should not be set by experiment. + type: ExperimentSlug + default: '{experiment}' + string-alias: ExperimentSlug + $$surfaces: + description: | + A list available surfaces for this app. + + This should not be written to by experiments, and should be hidden to users. + type: List + default: + - homescreen + - notification + - survey + - microsurvey + string-alias: SurfaceName + actions: + description: A growable map of action URLs. + type: Map + default: + OPEN_URL: ://open + ENABLE_PRIVATE_BROWSING: ://enable_private_browsing + INSTALL_SEARCH_WIDGET: ://install_search_widget + MAKE_DEFAULT_BROWSER: ://make_default_browser + VIEW_BOOKMARKS: ://urls_bookmarks + VIEW_COLLECTIONS: ://home_collections + VIEW_HISTORY: ://urls_history + VIEW_HOMESCREEN: ://home + OPEN_SETTINGS_ACCESSIBILITY: ://settings_accessibility + OPEN_SETTINGS_ADDON_MANAGER: ://settings_addon_manager + OPEN_SETTINGS_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: null + messages: + description: A growable collection of messages + type: Map + default: + default-browser: + title: default_browser_experiment_card_title + text: default_browser_experiment_card_text + surface: homescreen + action: MAKE_DEFAULT_BROWSER + trigger-if-all: + - USER_ESTABLISHED_INSTALL + - ANDROID_API_BELOW_29 + exclude-if-any: + - I_AM_DEFAULT_BROWSER + style: PERSISTENT + button-label: preferences_set_as_default_browser + default-browser-notification: + title: nimbus_notification_default_browser_title + text: nimbus_notification_default_browser_text + surface: notification + style: NOTIFICATION + trigger-if-all: + - DAY_3_AFTER_INSTALL + exclude-if-any: + - I_AM_DEFAULT_BROWSER + action: MAKE_DEFAULT_BROWSER + string-alias: MessageKey + notification-config: + description: Configuration of the notification worker for all notification messages. + type: NotificationConfig + default: + refresh-interval: 240 + on-control: + description: What should be displayed when a control message is selected. + type: ControlMessageBehavior + default: show-next-message + styles: + description: | + A map of styles to configure message appearance. + type: Map + default: + DEFAULT: + priority: 50 + max-display-count: 5 + SURVEY: + priority: 55 + max-display-count: 1 + PERSISTENT: + priority: 50 + max-display-count: 20 + WARNING: + priority: 60 + max-display-count: 10 + URGENT: + priority: 100 + max-display-count: 10 + NOTIFICATION: + priority: 50 + max-display-count: 1 + MICROSURVEY: + priority: 50 + max-display-count: 5 + string-alias: StyleName + triggers: + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + type: Map + default: + USER_ESTABLISHED_INSTALL: number_of_app_launches >=4 + ANDROID_API_BELOW_29: android_version < 29 + USER_RECENTLY_INSTALLED: days_since_install < 7 + USER_RECENTLY_UPDATED: days_since_update < 7 && days_since_install != days_since_update + USER_TIER_ONE_COUNTRY: ('US' in locale || 'GB' in locale || 'CA' in locale || 'DE' in locale || 'FR' in locale) + USER_EN_SPEAKER: '''en'' in locale' + USER_ES_SPEAKER: '''es'' in locale' + USER_DE_SPEAKER: '''de'' in locale' + USER_FR_SPEAKER: '''fr'' in locale' + DEVICE_ANDROID: os == 'Android' + DEVICE_IOS: os == 'iOS' + ALWAYS: 'true' + NEVER: 'false' + DAY_1_AFTER_INSTALL: days_since_install == 1 + DAY_2_AFTER_INSTALL: days_since_install == 2 + DAY_3_AFTER_INSTALL: days_since_install == 3 + DAY_4_AFTER_INSTALL: days_since_install == 4 + DAY_5_AFTER_INSTALL: days_since_install == 5 + MORE_THAN_24H_SINCE_INSTALLED_OR_UPDATED: days_since_update >= 1 + I_AM_DEFAULT_BROWSER: is_default_browser + I_AM_NOT_DEFAULT_BROWSER: is_default_browser == false + 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. + type: Boolean + default: false + 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: + wallpapers-selection-tool: 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. + type: Boolean + default: false + networking: + description: Enables networking features + variables: + fetchPriorityEnabled: + description: | + Enables or disables network.fetchpriority.enabled preference. + type: Boolean + default: true + networkingBannedPorts: + description: Networking (Necko) Banned Ports + variables: + bannedPortList: + description: A comma-separated list of ports that Firefox will refuse to connect to. These ports will be appended to nsIOService gBadPortList + type: String + default: '' + nimbus-is-ready: + description: | + A feature that provides the number of Nimbus is_ready events to send when Nimbus finishes launching. + variables: + event-count: + description: The number of events that should be sent. + type: Int + default: 1 + nimbus-system: + description: | + Configuration of the Nimbus System in Android. + variables: + refresh-interval-foreground: + description: | + The minimum interval in minutes between fetching experiment + recipes in the foreground. + type: Int + default: 60 + nimbus-validation: + description: A feature that does not correspond to an application feature suitable for showing that Nimbus is working. This should never be used in production. + variables: + settings-icon: + description: The drawable displayed in the app menu for Settings + type: String + default: mozac_ic_settings + settings-punctuation: + description: The emoji displayed in the Settings screen title. + type: String + default: '' + settings-title: + description: The title of displayed in the Settings screen and app menu. + type: Text + default: browser_menu_settings + 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 + override-user-specified-homepage-sections: + description: Whether to ignore the user-specified homepage section visibility settings and hide the options in the settings. + variables: + enabled: + description: | + When true, ignore the user-specified homepage section visibility settings, and hide the toggle options in the settings. + type: Boolean + default: false + pdfjs: + description: PDF.js features + variables: + download-button: + description: Download button + type: Boolean + default: true + open-in-app-button: + description: Open in app button + type: Boolean + default: true + pki: + description: Certificate verification configuration + variables: + certificateTransparencyMode: + description: | + What mode Certificate Transparency is in (0=disable, 1=telemetry only, 2=enforce). + type: Int + default: 2 + pqcrypto: + description: Control the use of post-quantum key exchange mechanisms in TLS and HTTP/3. + variables: + postQuantumKeyExchangeEnabled: + description: | + Toggles the security.tls.enable_kyber and network.http.http3.enable_kyber preferences. + type: Option + default: null + 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-lock: + description: Allows enabling and disabling the private browsing mode lock via an authentication screen. + variables: + enabled: + description: | + Whether or not to enable private browsing mode lock. + type: Boolean + default: true + 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 + recent-searches: + description: Enables recent searches. + variables: + enabled: + description: | + Whether or not to enable recent searches. + type: Boolean + default: true + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 5 + remote-search-configuration: + description: Feature to use search configurations from remote servers. + variables: + enabled: + description: | + Uses search configuration from remote servers . + type: Boolean + default: true + remote-tab-management: + description: | + Features that let users manage tabs on other devices that are connected to the same Mozilla account. + variables: + close-tabs-enabled: + description: | + Whether the feature to close synced tabs is enabled. When enabled, this device will allow other devices to close tabs that are open on this device, and show a "close" button for tabs that are currently open on other supported devices in the synced tabs tray. + type: Boolean + default: true + same-document-navigation-overrides-load-type: + description: Control whether the same document navigation overrides the load type. + variables: + enabled: + description: | + Overrides the loadType when it is a same document navigation + type: Boolean + default: true + force-disable-uri: + description: | + Disable overriding the loadType during same document navigation on the domain specified by this URI. + type: String + default: '' + search-extra-params: + description: A feature that provides additional args for search. + variables: + channel-id: + description: The channel Id param name with arg. + type: Map + default: {} + enabled: + description: If true, the feature is active. + type: Boolean + default: false + feature-enabler: + description: The feature enabler param name with arg, NOTE this map could be empty. + type: Map + default: {} + search-engine: + description: The search engine name. + type: String + default: '' + search-suggestions-on-homepage: + description: Enables search suggestions on homepage. + variables: + enabled: + description: | + Whether or not to enable search suggestions on homepage. + type: Boolean + default: false + 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 + sent-from-firefox: + description: A feature that allows the user to add a download firefox footer to a shared link. + variables: + download-link: + description: A store download link. + type: Text + default: '' + enabled: + description: If true, the feature is available for the user. + type: Boolean + default: false + show-snackbar: + description: If true, the user will see the snackbar after sharing a link, allowing quick navigation to settings. + type: Boolean + default: false + template-message: + description: A template for the shared message, supporting three placeholders. A shared link, the brand name and a store download link. + type: Text + default: '' + setup-checklist: + description: A feature on the home page that allows the user to track onboarding setup progress. + variables: + enabled: + description: If true, the setup checklist will be enabled. + type: Boolean + default: false + setup-checklist-type: + description: The collection used for the setup checklist. + type: SetupChecklistType + default: collection-1 + 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. + type: Boolean + default: true + splash-screen: + description: A feature that extends splash screen duration, allowing additional data fetching time for the app's initial run. + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + maximum_duration_ms: + description: The maximum amount of time in milliseconds the splashscreen will be visible while waiting for initialization calls to complete. + type: Int + default: 0 + off-train-onboarding: + description: If true, the fetched data will be applied and used during the session. + type: Boolean + default: false + suggest-shipped-domains: + description: Feature that suggests domains from the shipped domain list. + variables: + enabled: + description: | + Suggest domains from the shipped domain list. + type: Boolean + default: false + suppress-sponsored-top-sites: + description: Suppress sponsored top sites for new users for 14 days. + variables: + enabled: + description: If true, new users won’t see sponsored tiles for 14 days. + type: Boolean + default: false + tab-management-enhancements: + description: Control the visibility of the tab management enhancements. + variables: + enabled: + description: | + Whether or not to enable the tab management enhancements. + type: Boolean + default: false + tab-strip: + description: Enables tab strip. + variables: + allow-on-all-devices: + description: | + Experimental: When true, bypasses device restrictions and enables use on all devices. May cause instability or unexpected behavior. This still requires the feature to be `enabled`. + type: Boolean + default: false + enabled: + description: | + Whether or not to enable tab strip. + type: Boolean + default: true + terms-of-use-prompt: + description: Enables the terms of use prompt for users who have not accepted ToU + variables: + enabled: + description: When the feature is enabled then the prompt can show for users. + 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. + type: Boolean + default: false + enabled-private: + description: | + Enables / disables third-party cookie blocking in private browsing mode. + type: Boolean + default: true + toolbar-redesign-option: + description: Control the visibility of toolbar redesign option in settings. + variables: + show-expanded-customization: + description: | + Whether or not the expanded toolbar customization option is visible to the user. + type: Boolean + default: false + show-options: + description: | + Whether or not the toolbar redesign option is visible to the user. This allows the user to switch between simple and expanded toolbar. + type: Boolean + default: false + show-simple-customization: + description: | + Whether or not the simple toolbar customization option is visible to the user. + type: Boolean + default: false + top-sites-suggestions: + description: Enables top sites suggestions. + variables: + enabled: + description: | + Whether or not to enable top sites suggestions. + type: Boolean + default: true + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 2 + translations: + description: The feature that allows on-device translations of web content. + variables: + downloads-enabled: + description: | + Show the global language model download options entry point for translations. ('Download languages' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-lang-settings-enabled: + description: | + Show the global language options entry point for automatically translating. ('Automatic Translation' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-settings-enabled: + description: | + Show the global settings entry point within the translations feature. ('Translation Settings' on the page settings view.) 'page-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-site-settings-enabled: + description: | + Show the global never translate this site options entry point for site management. ('Never translate these sites' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + main-flow-browser-menu-enabled: + description: | + Show the browser menu entry point into the translations feature. ('Translate Page' on browser menu.) + type: Boolean + default: true + main-flow-toolbar-enabled: + description: | + Show the primary toolbar entry point into the translations feature. (Translations icon on URL toolbar.) + type: Boolean + default: true + page-settings-enabled: + description: | + Show the page settings entry point within the translations feature. (Gear icon on the translations main flow page.) 'main-flow-toolbar-enabled' or 'main-flow-browser-menu-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + trending-searches: + description: Enables trending searches. + variables: + enabled: + description: | + Whether or not to enable trending searches. + type: Boolean + default: true + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 5 + unified-trust-panel: + description: Enables the unified trust panel. + variables: + enabled: + description: | + Whether or not to enable the unified trust panel. + 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. + collections: + description: The collections section of the homepage. + header: + description: The header of the homescreen. + 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 + synced-tabs: + description: The synced tabs section of the homepage. + top-sites: + description: The frecency and pinned sites. + MR2022Section: + description: The identifiers for the sections of the MR 2022. + variants: + 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-search-widget: + description: Allows user to add search widget to homescreen. + default-browser: + description: Allows user to set Firefox as the default browser. + marketing-data: + description: Allows user to opt out of marketing data collection. + notification-permission: + description: Allows user to enable notification permission. + sync-sign-in: + description: Allows user to sync with a Firefox account. + terms-of-service: + description: Page to display the terms of services. + theme-selection: + description: Allows user to choose between dark and light themes. + toolbar-placement: + description: Allows user to choose the toolbar position. + OnboardingPanel: + description: The types of onboarding panels in the onboarding page + variants: + privacy-notice: + description: The onboarding panel where users can tap to view our privacy notice. + sync: + description: The onboarding panel where users can sign in to sync + tcp: + description: The onboarding panel where users can choose their total cookie protection settings + themes: + description: The themes onboarding panel where users pick themes + toolbar-placement: + description: The onboarding panel where users choose their toolbar placement (bottom or top) + QueryParameterStrippingSection: + description: The identifiers for the options for the Query Parameter Stripping feature. + variants: + query-parameter-stripping: + description: An integer either 0 or 1 indicating if query parameter stripping should be enabled or disabled in normal mode. 0 for setting to be disabled, and 1 for enabling the setting. + query-parameter-stripping-allow-list: + description: An string separated by commas indicating the sites where should from query stripping should be exempted. + query-parameter-stripping-pmb: + description: An integer either 0 or 1 indicating if query parameter stripping should be enabled or disabled in private mode. 0 for setting to be disabled, and 1 for enabling the setting. + query-parameter-stripping-strip-list: + description: An string separated by commas indicating the list of query params to be stripped from URIs. This list will be merged with records coming from RemoteSettings. + SetupChecklistType: + description: An enum to represent the different experiment branches for the setup checklist. + variants: + collection-1: + description: The collection for the setup checklist that has 3 items. + collection-2: + description: The collection for the setup checklist that has 6 items. + SuggestionType: + description: The type of a Firefox Suggest search suggestion. + variants: + amp: + description: A Firefox Suggestion from adMarketplace. + ampMobile: + description: A firefox Suggestion from adMarketplace specifically for mobile. + wikipedia: + description: A Firefox Suggestion for a Wikipedia page. + ThemeType: + description: An enum to describe a theme selection option. + variants: + theme-dark: + description: Sets the theme to dark mode. + theme-light: + description: Sets the theme to light mode. + theme-system: + description: Adapts the theme to match the device's system setting. + ToolbarType: + description: An enum to describe a toolbar placement option. + variants: + toolbar-bottom: + description: Sets the toolbar placement on the bottom. + toolbar-top: + description: Sets the toolbar placement on the top. +objects: + CustomizationThemeData: + description: Defines an option for theme selection. + fields: + image-res: + description: The resource id of the image to be displayed. + type: Image + default: ic_pick_a_theme_system_auto + label: + description: Display text for the theme option (e.g., "Light Theme"). + type: Text + default: '' + theme-type: + description: The type of the theming option. + type: ThemeType + default: theme-system + CustomizationToolbarData: + description: An object to describe the placement of the toolbar. + fields: + image-res: + description: The resource id of toolbar placement image. + type: Image + default: ic_onboarding_customize_toolbar + label: + description: Display text for the toolbar placement option (e.g. "Top placement"). + type: Text + default: '' + toolbar-type: + description: The type of toolbar placement. + type: ToolbarType + default: toolbar-top + ExtraCardData: + description: Holds data for cards that require additional data, e.g. toolbar placement cards. + fields: + customization-theme-data: + description: An optional list of theme choices for the theme selection card. + type: List + default: [] + customization-toolbar-data: + description: | + An optional list of toolbar placements for the toolbar placement card. + type: List + default: [] + marketing-data: + description: | + An optional marketing data for the onboarding card. + type: Option + default: null + term-of-service-data: + description: | + An optional terms of service data for the onboarding card. + type: Option + default: null + GleanServerKnobsConfiguration: + description: A configuration object for Glean server knobs. + fields: + event_threshold: + description: The threshold of events that will be buffered before an events ping is collected and submitted. + type: Option + default: null + metrics_enabled: + description: A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric. + type: Map + default: {} + pings_enabled: + description: A map of ping names to booleans representing the state of the 'enabled' flag for that ping. + type: Map + default: {} + MarketingData: + description: An object to describe the marketing data onboarding card. + fields: + body-line-one-link-text: + description: The link text from line one of the body. + type: Text + default: '' + body-line-one-text: + description: The text for line one of the body. + type: Text + default: '' + body-line-two-text: + description: The text for line two of the body. + type: Text + default: '' + MessageData: + description: | + An object to describe a message. It uses human readable strings to describe the triggers, action and style of the message as well as the text of the message and call to action. + fields: + action: + description: | + A URL of a page or a deeplink. This may have substitution variables in. + type: ActionName + default: OPEN_URL + action-params: + description: | + A string map containing query parameters that will be appended to the action URL. This is useful for opening URLs in tabs, or specifying that the tab should be private. The values may have substitutions, e.g. "url": "https://example.com/id={uuid}", "private": "true". + The params and their values are all determined downstream of the messaging component, by the embedding app's deeplink processing machinery. + type: Map + default: {} + button-label: + description: | + The text on the button. If no text is present, the whole message is clickable. + type: Option + default: null + exclude-if-any: + description: | + A list of strings corresponding to targeting expressions. The message will not be shown if any of the expressions are `true`. + type: List + default: [] + experiment: + description: The slug of the experiment that this message came from. + type: Option + default: null + is-control: + description: Indicates if this message is the control message, if true shouldn't be displayed + type: Boolean + default: false + microsurvey-config: + description: Optional configuration data for a microsurvey. + type: Option + default: null + style: + description: | + The style as described in a `StyleData` from the styles table. + type: StyleName + default: DEFAULT + surface: + description: The surface identifier for this message. + type: SurfaceName + default: homescreen + text: + description: The message text displayed to the user + type: Text + default: '' + title: + description: The title text displayed to the user + type: Option + default: null + trigger-if-all: + description: | + A list of strings corresponding to targeting expressions. The message will be shown if all expressions are `true`. + type: List + default: [] + MicrosurveyAnswer: + description: Attributes relating to microsurvey content. + fields: + ordering: + description: | + Used 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. + 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: null + utm-content: + description: Optional "utm_content" parameter for the privacy notice URL to specify the feature being surveyed. + type: Option + default: null + NotificationConfig: + description: Attributes controlling the global configuration of notification messages. + fields: + refresh-interval: + description: | + How often, in minutes, the notification message worker will wake up and check for new messages. + type: Int + default: 240 + OnboardingCardData: + description: An object to describe a user facing onboarding card. + fields: + body: + description: The message text displayed to the user. May contain linkable text. + type: Text + default: '' + card-type: + description: The type of the card. + type: OnboardingCardType + default: default-browser + disqualifiers: + description: | + A list of strings corresponding to targeting expressions. The card will not be shown if any expression is `true`. + type: List + default: + - NEVER + enabled: + description: If true, this card is shown to the user. + type: Boolean + default: true + extra-data: + description: Optional extra data for cards that require additional data. + type: Option + default: null + image-res: + description: The resource id of the image to be displayed. + type: Image + default: ic_onboarding_welcome + ordering: + description: Used to sequence the cards. + type: Int + default: 0 + prerequisites: + description: | + A list of strings corresponding to targeting expressions. The card will be shown if all expressions are `true` and if no expressions in the `disqualifiers` table are true, or if the `disqualifiers` table is empty. + type: List + default: + - ALWAYS + primary-button-label: + description: The text to display on the primary button. + type: Text + default: '' + secondary-button-label: + description: The text to display on the secondary button. + type: Text + default: '' + title: + description: The title text displayed to the user. + type: Text + default: '' + StyleData: + description: | + A group of properties (predominantly visual) to describe the style of the message. + fields: + max-display-count: + description: | + How many sessions will this message be shown to the user before it is expired. + type: Int + default: 5 + priority: + description: | + The importance of this message. 0 is not very important, 100 is very important. + type: Int + default: 50 + TermsOfServiceData: + description: An object to describe the terms of service onboarding card. + fields: + line-one-link-text: + description: The text for the link of line one. + type: Text + default: '' + line-one-link-url: + description: The url for the link of line one. + type: Text + default: '' + line-one-text: + description: The text for line one. + type: Text + default: '' + line-three-link-text: + description: The text for the link of line three. + type: Text + default: '' + line-three-text: + description: The text for line three. + type: Text + default: '' + line-two-link-text: + description: The text for the link of line two. + type: Text + default: '' + line-two-link-url: + description: The url for the link of line two. + type: Text + default: '' + line-two-text: + description: The text for line two. + type: Text + default: '' + subheader-one-text: + description: Optional text for the first subheader of the card. + type: Option + default: null + subheader-three-text: + description: Optional text for the third subheader of the card. + type: Option + default: null + subheader-two-text: + description: Optional text for the second subheader of the card. + type: Option + default: null diff --git a/experimenter/experimenter/features/manifests/fenix/v145.0.0/developer.fml.yaml b/experimenter/experimenter/features/manifests/fenix/v145.0.0/developer.fml.yaml new file mode 100644 index 0000000000..99a7603e83 --- /dev/null +++ b/experimenter/experimenter/features/manifests/fenix/v145.0.0/developer.fml.yaml @@ -0,0 +1,1526 @@ +version: 1.0.0 +about: + description: Nimbus Feature Manifest for Fenix (Firefox Android) +channels: +- developer +features: + address-sync: + description: Turns on address sync. + variables: + enabled: + description: | + Whether or not to turn on address sync. + type: Boolean + default: true + alternative-app-launcher-icon: + description: A feature that changes the app launcher icon background color. + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + reset-to-default: + description: | + If true use the default icon, if false use the alternative icon. This is required to 'reset' the icon for enrolled users once the initial experiment is complete. + type: Boolean + default: false + app-icon-selection: + description: Allows the user to set an alternative app launcher icon. + variables: + enabled: + description: Whether or not the feature is available for the user. + type: Boolean + default: true + awesomebar-suggestion-provider: + description: Configuration for the Firefox Suggest awesomebar suggestion provider. + variables: + available-suggestion-types: + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + type: Map + default: + amp: true + ampMobile: false + wikipedia: true + baseline-fpp: + description: Control Baseline Fingerprinting Protection + variables: + enabled: + description: Enables / disables baseline fingerprinting protection. + type: Boolean + default: true + feat-enabled: + description: If true, the feature is active. + type: Boolean + default: false + overrides: + description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. + type: String + default: '' + bookmarks: + description: Feature for Bookmarks + variables: + new-compose-ui: + description: if true, enable new compose based UI + type: Boolean + default: false + composable-toolbar: + description: Use a composable toolbar instead of the View based one. + variables: + enabled: + description: | + When the feature is enabled the user will see a new composable toolbar instead the previous View based one. + type: Boolean + default: true + 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 + custom-review-prompt: + description: Feature that controls the Play store in-app custom review prompt. + variables: + enabled: + description: Whether or not to enable the custom review prompt. + type: Boolean + default: false + doh: + description: Feature controlling DNS over HTTPS (DoH). + variables: + autoselect-enabled: + description: | + Controls the network.android_doh.autoselect_enabled pref and automatically chooses a DoH provider when Default Protection mode is selected. + type: Boolean + default: false + show-ui: + description: | + When `true`, include DoH settings in the settings UI. + type: Boolean + default: true + encourage-search-cfr: + description: A feature that shows a CFR on first launch to encourage users to make a search + variables: + cfrText: + description: The text to show in the CFR + type: Text + default: '' + enabled: + description: When true, the CFR will show + type: Boolean + default: false + fingerprinting-protection: + description: Control Fingerprinting Protection + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + enabled-normal: + description: | + Enables / disables fingerprinting protection in normal browsing mode. + type: Boolean + default: false + enabled-private: + description: | + Enables / disables fingerprinting protection in private browsing mode. + type: Boolean + default: true + fdlibm-math: + description: | + Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy + type: Boolean + default: false + overrides: + description: | + The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. + type: String + default: '' + fission: + description: The feature that controls whether fission is enabled or not in Gecko. + variables: + enabled: + description: | + Whether or not to enable fission. Fission is enabled when set to true. Fission is disabled when set to false. + type: Boolean + default: false + fx-suggest: + description: A feature that provides Firefox Suggest search suggestions. + variables: + boost-amp-wiki: + description: | + The feature boost wiki and AMP suggestions to the top of its group. + type: Boolean + default: true + enabled: + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. + type: Boolean + default: true + glean: + description: A feature that provides server-side configurations for Glean metrics (aka Server Knobs). + variables: + delay-ping-lifetime-io: + description: Glean will delay io for ping lifetime metrics + type: Boolean + default: true + enable-event-timestamps: + description: Enables precise event timestamps for Glean events + type: Boolean + default: true + gleanMetricConfiguration: + description: Configuration for Glean Server Knobs + type: GleanServerKnobsConfiguration + default: + event_threshold: null + metrics_enabled: {} + pings_enabled: {} + ping-lifetime-max-time: + description: After what time to auto-flush + type: Int + default: 2000 + ping-lifetime-threshold: + description: Write count threshold when to auto-flush + type: Int + default: 1000 + allow-coenrollment: true + growth-data: + description: A feature measuring campaign growth data + variables: + enabled: + description: If true, the feature is active + type: Boolean + default: false + homepage-as-new-tab: + description: Enables homepage as a a new tab. + variables: + enabled: + description: | + Whether or not to enable homepage as a new tab + type: Boolean + default: false + homepage-hide-frecent-top-sites: + description: Hides frecent top sites on the homepage. + variables: + enabled: + description: | + Whether or not to hide frecent top sites on the homepage. + type: Boolean + default: false + homepage-search-bar: + description: Enables the homepage search bar. + variables: + enabled: + description: | + Whether or not to enable the homepage search bar. + 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: + header: true + top-sites: true + jump-back-in: true + bookmarks: true + recent-explorations: true + pocket: true + pocket-sponsored-stories: true + synced-tabs: true + collections: true + isolated-content-processes: + description: Feature that controls content process isolation. + variables: + enabled: + description: | + Whether or not to enable isolated content processes. + type: Boolean + default: false + javascript: + description: Enables Javascript Engine (Spidermonkey) features + variables: + parallelMarkingEnabled: + description: | + Enables or disables javascript.options.mem.gc_parallel_marking preference. + type: Boolean + default: false + juno-onboarding: + description: A feature that shows the onboarding flow. + variables: + cards: + description: Collection of user facing onboarding cards. + type: Map + default: + terms-of-service: + body: onboarding_terms_of_service_sub_header_2 + card-type: terms-of-service + disqualifiers: + - NEVER + enabled: false + extra-data: + term-of-service-data: + line-one-text: onboarding_term_of_service_line_one_2 + line-one-link-text: onboarding_term_of_service_line_one_link_text_2 + line-two-text: onboarding_term_of_service_line_two_2 + line-two-link-text: onboarding_term_of_service_line_two_link_text + line-three-text: onboarding_term_of_service_line_three + line-three-link-text: onboarding_term_of_service_line_three_link_text + image-res: ic_firefox + ordering: 0 + prerequisites: + - ALWAYS + primary-button-label: onboarding_term_of_service_agree_and_continue_button_label_2 + secondary-button-label: '' + title: onboarding_welcome_to_firefox + default-browser: + body: juno_onboarding_default_browser_description_nimbus_3 + card-type: default-browser + disqualifiers: + - NEVER + enabled: true + extra-data: null + image-res: ic_onboarding_welcome + ordering: 5 + 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: + body: juno_onboarding_add_search_widget_description + card-type: add-search-widget + disqualifiers: + - NEVER + enabled: true + extra-data: null + image-res: ic_onboarding_search_widget + ordering: 10 + 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: + body: juno_onboarding_sign_in_description_3 + card-type: sync-sign-in + disqualifiers: + - NEVER + enabled: true + extra-data: null + image-res: ic_onboarding_sync + ordering: 15 + 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: + body: juno_onboarding_enable_notifications_description_nimbus_2 + card-type: notification-permission + disqualifiers: + - NEVER + enabled: true + extra-data: null + image-res: ic_notification_permission + ordering: 20 + 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 + theme-selection: + body: onboarding_customize_theme_description + card-type: theme-selection + disqualifiers: + - NEVER + enabled: false + extra-data: + customization-theme-data: + - theme-type: theme-system + label: onboarding_customize_theme_system_option + image-res: ic_pick_a_theme_system_auto + - theme-type: theme-light + label: onboarding_customize_theme_light_option + image-res: ic_pick_a_theme_light + - theme-type: theme-dark + label: onboarding_customize_theme_dark_option + image-res: ic_pick_a_theme_dark + image-res: ic_pick_a_theme + ordering: 30 + prerequisites: + - ALWAYS + primary-button-label: onboarding_save_and_continue_button + secondary-button-label: '' + title: onboarding_customize_theme_title + toolbar-placement: + body: onboarding_customize_toolbar_description + card-type: toolbar-placement + disqualifiers: + - NEVER + enabled: false + extra-data: + customization-toolbar-data: + - toolbar-type: toolbar-top + label: onboarding_customize_toolbar_top_option + image-res: ic_onboarding_top_toolbar + - toolbar-type: toolbar-bottom + label: onboarding_customize_toolbar_bottom_option + image-res: ic_onboarding_bottom_toolbar + image-res: ic_onboarding_customize_toolbar + ordering: 35 + prerequisites: + - ALWAYS + primary-button-label: onboarding_save_and_start_button + secondary-button-label: '' + title: onboarding_customize_toolbar_title + marketing: + body: onboarding_marketing_body + card-type: marketing-data + disqualifiers: + - NEVER + enabled: true + extra-data: + marketing-data: + body-line-one-text: onboarding_marketing_learn_more + body-line-one-link-text: onboarding_marketing_learn_more + body-line-two-text: onboarding_marketing_opt_out_checkbox + image-res: ic_onboarding_welcome + ordering: 40 + prerequisites: + - ALWAYS + primary-button-label: onboarding_marketing_positive_button + secondary-button-label: '' + title: onboarding_marketing_title + terms-of-service-redesign: + card-type: terms-of-service + enabled: false + title: onboarding_redesign_tou_title + ordering: 0 + image-res: ic_firefox + primary-button-label: onboarding_redesign_tou_agree_and_continue_button_label + extra-data: + term-of-service-data: + subheader-one-text: onboarding_redesign_tou_subheader_one + subheader-two-text: onboarding_redesign_tou_subheader_two + subheader-three-text: onboarding_redesign_tou_subheader_three + line-one-text: onboarding_redesign_tou_body_one + line-one-link-text: onboarding_redesign_tou_body_one_link_text + line-two-text: onboarding_redesign_tou_body_two + line-two-link-text: onboarding_redesign_tou_body_two_link_text + line-three-text: onboarding_redesign_tou_body_three + line-three-link-text: onboarding_redesign_tou_body_three_link_text + marketing-data: + card-type: marketing-data + enabled: false + title: onboarding_marketing_title + body: onboarding_marketing_body + image-res: ic_onboarding_welcome + ordering: 40 + primary-button-label: onboarding_marketing_positive_button + extra-data: + marketing-data: + body-line-one-text: onboarding_marketing_learn_more + body-line-one-link-text: onboarding_marketing_learn_more + body-line-two-text: onboarding_marketing_opt_out_checkbox + string-alias: OnboardingCardKey + conditions: + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + string-alias: ConditionName + use-onboarding-redesign: + description: If true, use the onboarding redesign. + type: Boolean + default: false + lna-blocking: + description: Feature that allows blocking local network or device access. + variables: + enabled: + description: | + Whether or not to turn on local network / device access blocking + type: Boolean + default: false + menu-redesign: + description: Control the new menu redesign. + variables: + enabled: + description: If true, the new menu redesign is available. + type: Boolean + default: true + menu-banner: + description: If true, the menu banner is visible. + type: Boolean + default: true + report-site-issue: + description: If true, report site issue menu item and preview is available. + type: Boolean + default: true + messaging: + description: | + The in-app messaging system. + variables: + $$experiment: + description: The only acceptable value for `MessageData#experiment`. This should not be set by experiment. + type: ExperimentSlug + default: '{experiment}' + string-alias: ExperimentSlug + $$surfaces: + description: | + A list available surfaces for this app. + + This should not be written to by experiments, and should be hidden to users. + type: List + default: + - homescreen + - notification + - survey + - microsurvey + string-alias: SurfaceName + actions: + description: A growable map of action URLs. + type: Map + default: + OPEN_URL: ://open + ENABLE_PRIVATE_BROWSING: ://enable_private_browsing + INSTALL_SEARCH_WIDGET: ://install_search_widget + MAKE_DEFAULT_BROWSER: ://make_default_browser + VIEW_BOOKMARKS: ://urls_bookmarks + VIEW_COLLECTIONS: ://home_collections + VIEW_HISTORY: ://urls_history + VIEW_HOMESCREEN: ://home + OPEN_SETTINGS_ACCESSIBILITY: ://settings_accessibility + OPEN_SETTINGS_ADDON_MANAGER: ://settings_addon_manager + OPEN_SETTINGS_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: null + messages: + description: A growable collection of messages + type: Map + default: + default-browser: + title: default_browser_experiment_card_title + text: default_browser_experiment_card_text + surface: homescreen + action: MAKE_DEFAULT_BROWSER + trigger-if-all: + - USER_ESTABLISHED_INSTALL + - ANDROID_API_BELOW_29 + exclude-if-any: + - I_AM_DEFAULT_BROWSER + style: PERSISTENT + button-label: preferences_set_as_default_browser + default-browser-notification: + title: nimbus_notification_default_browser_title + text: nimbus_notification_default_browser_text + surface: notification + style: NOTIFICATION + trigger-if-all: + - DAY_3_AFTER_INSTALL + exclude-if-any: + - I_AM_DEFAULT_BROWSER + action: MAKE_DEFAULT_BROWSER + microsurvey-printing-example: + title: microsurvey_prompt_printing_title + text: microsurvey_survey_printing_title + surface: microsurvey + trigger-if-all: + - RECENTLY_PRINTED + style: MICROSURVEY + microsurvey-config: + utm-content: homepage + icon: ic_print + answers: + - text: likert_scale_option_1 + ordering: 0 + - text: likert_scale_option_2 + ordering: 1 + - text: likert_scale_option_3 + ordering: 2 + - text: likert_scale_option_4 + ordering: 3 + - text: likert_scale_option_5 + ordering: 4 + - text: likert_scale_option_6 + ordering: 5 + string-alias: MessageKey + notification-config: + description: Configuration of the notification worker for all notification messages. + type: NotificationConfig + default: + refresh-interval: 120 + on-control: + description: What should be displayed when a control message is selected. + type: ControlMessageBehavior + default: show-next-message + styles: + description: | + A map of styles to configure message appearance. + type: Map + default: + DEFAULT: + priority: 50 + max-display-count: 100 + SURVEY: + priority: 55 + max-display-count: 1 + PERSISTENT: + priority: 50 + max-display-count: 20 + WARNING: + priority: 60 + max-display-count: 10 + URGENT: + priority: 100 + max-display-count: 10 + NOTIFICATION: + priority: 50 + max-display-count: 1 + MICROSURVEY: + priority: 50 + max-display-count: 5 + EXPIRES_QUICKLY: + priority: 100 + max-display-count: 1 + string-alias: StyleName + triggers: + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + type: Map + default: + USER_ESTABLISHED_INSTALL: number_of_app_launches >=4 + ANDROID_API_BELOW_29: android_version < 29 + USER_RECENTLY_INSTALLED: days_since_install < 7 + USER_RECENTLY_UPDATED: days_since_update < 7 && days_since_install != days_since_update + USER_TIER_ONE_COUNTRY: ('US' in locale || 'GB' in locale || 'CA' in locale || 'DE' in locale || 'FR' in locale) + USER_EN_SPEAKER: '''en'' in locale' + USER_ES_SPEAKER: '''es'' in locale' + USER_DE_SPEAKER: '''de'' in locale' + USER_FR_SPEAKER: '''fr'' in locale' + DEVICE_ANDROID: os == 'Android' + DEVICE_IOS: os == 'iOS' + ALWAYS: 'true' + NEVER: 'false' + DAY_1_AFTER_INSTALL: days_since_install == 1 + DAY_2_AFTER_INSTALL: days_since_install == 2 + DAY_3_AFTER_INSTALL: days_since_install == 3 + DAY_4_AFTER_INSTALL: days_since_install == 4 + DAY_5_AFTER_INSTALL: days_since_install == 5 + MORE_THAN_24H_SINCE_INSTALLED_OR_UPDATED: days_since_update >= 1 + I_AM_DEFAULT_BROWSER: is_default_browser + I_AM_NOT_DEFAULT_BROWSER: is_default_browser == false + 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. + type: Boolean + default: false + 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: + wallpapers-selection-tool: 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. + type: Boolean + default: true + networking: + description: Enables networking features + variables: + fetchPriorityEnabled: + description: | + Enables or disables network.fetchpriority.enabled preference. + type: Boolean + default: true + networkingBannedPorts: + description: Networking (Necko) Banned Ports + variables: + bannedPortList: + description: A comma-separated list of ports that Firefox will refuse to connect to. These ports will be appended to nsIOService gBadPortList + type: String + default: '' + nimbus-is-ready: + description: | + A feature that provides the number of Nimbus is_ready events to send when Nimbus finishes launching. + variables: + event-count: + description: The number of events that should be sent. + type: Int + default: 1 + nimbus-system: + description: | + Configuration of the Nimbus System in Android. + variables: + refresh-interval-foreground: + description: | + The minimum interval in minutes between fetching experiment + recipes in the foreground. + type: Int + default: 60 + nimbus-validation: + description: A feature that does not correspond to an application feature suitable for showing that Nimbus is working. This should never be used in production. + variables: + settings-icon: + description: The drawable displayed in the app menu for Settings + type: String + default: mozac_ic_settings + settings-punctuation: + description: The emoji displayed in the Settings screen title. + type: String + default: '' + settings-title: + description: The title of displayed in the Settings screen and app menu. + type: Text + default: browser_menu_settings + 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 + override-user-specified-homepage-sections: + description: Whether to ignore the user-specified homepage section visibility settings and hide the options in the settings. + variables: + enabled: + description: | + When true, ignore the user-specified homepage section visibility settings, and hide the toggle options in the settings. + type: Boolean + default: false + pdfjs: + description: PDF.js features + variables: + download-button: + description: Download button + type: Boolean + default: true + open-in-app-button: + description: Open in app button + type: Boolean + default: true + pki: + description: Certificate verification configuration + variables: + certificateTransparencyMode: + description: | + What mode Certificate Transparency is in (0=disable, 1=telemetry only, 2=enforce). + type: Int + default: 2 + pqcrypto: + description: Control the use of post-quantum key exchange mechanisms in TLS and HTTP/3. + variables: + postQuantumKeyExchangeEnabled: + description: | + Toggles the security.tls.enable_kyber and network.http.http3.enable_kyber preferences. + type: Option + default: null + 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-lock: + description: Allows enabling and disabling the private browsing mode lock via an authentication screen. + variables: + enabled: + description: | + Whether or not to enable private browsing mode lock. + type: Boolean + default: true + 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 + recent-searches: + description: Enables recent searches. + variables: + enabled: + description: | + Whether or not to enable recent searches. + type: Boolean + default: true + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 5 + remote-search-configuration: + description: Feature to use search configurations from remote servers. + variables: + enabled: + description: | + Uses search configuration from remote servers . + type: Boolean + default: true + remote-tab-management: + description: | + Features that let users manage tabs on other devices that are connected to the same Mozilla account. + variables: + close-tabs-enabled: + description: | + Whether the feature to close synced tabs is enabled. When enabled, this device will allow other devices to close tabs that are open on this device, and show a "close" button for tabs that are currently open on other supported devices in the synced tabs tray. + type: Boolean + default: true + same-document-navigation-overrides-load-type: + description: Control whether the same document navigation overrides the load type. + variables: + enabled: + description: | + Overrides the loadType when it is a same document navigation + type: Boolean + default: false + force-disable-uri: + description: | + Disable overriding the loadType during same document navigation on the domain specified by this URI. + type: String + default: '' + search-extra-params: + description: A feature that provides additional args for search. + variables: + channel-id: + description: The channel Id param name with arg. + type: Map + default: {} + enabled: + description: If true, the feature is active. + type: Boolean + default: false + feature-enabler: + description: The feature enabler param name with arg, NOTE this map could be empty. + type: Map + default: {} + search-engine: + description: The search engine name. + type: String + default: '' + search-suggestions-on-homepage: + description: Enables search suggestions on homepage. + variables: + enabled: + description: | + Whether or not to enable search suggestions on homepage. + type: Boolean + default: false + 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 + sent-from-firefox: + description: A feature that allows the user to add a download firefox footer to a shared link. + variables: + download-link: + description: A store download link. + type: Text + default: '[Download Link]' + enabled: + description: If true, the feature is available for the user. + type: Boolean + default: true + show-snackbar: + description: If true, the user will see the snackbar after sharing a link, allowing quick navigation to settings. + type: Boolean + default: true + template-message: + description: A template for the shared message, supporting three placeholders. A shared link, the brand name and a store download link. + type: Text + default: sent_from_firefox_template + setup-checklist: + description: A feature on the home page that allows the user to track onboarding setup progress. + variables: + enabled: + description: If true, the setup checklist will be enabled. + type: Boolean + default: false + setup-checklist-type: + description: The collection used for the setup checklist. + type: SetupChecklistType + default: collection-1 + 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. + 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 + off-train-onboarding: + description: If true, the fetched data will be applied and used during the session. + type: Boolean + default: false + suggest-shipped-domains: + description: Feature that suggests domains from the shipped domain list. + variables: + enabled: + description: | + Suggest domains from the shipped domain list. + type: Boolean + default: false + suppress-sponsored-top-sites: + description: Suppress sponsored top sites for new users for 14 days. + variables: + enabled: + description: If true, new users won’t see sponsored tiles for 14 days. + type: Boolean + default: false + tab-management-enhancements: + description: Control the visibility of the tab management enhancements. + variables: + enabled: + description: | + Whether or not to enable the tab management enhancements. + type: Boolean + default: false + tab-strip: + description: Enables tab strip. + variables: + allow-on-all-devices: + description: | + Experimental: When true, bypasses device restrictions and enables use on all devices. May cause instability or unexpected behavior. This still requires the feature to be `enabled`. + type: Boolean + default: false + enabled: + description: | + Whether or not to enable tab strip. + type: Boolean + default: true + terms-of-use-prompt: + description: Enables the terms of use prompt for users who have not accepted ToU + variables: + enabled: + description: When the feature is enabled then the prompt can show for users. + 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. + type: Boolean + default: false + enabled-private: + description: | + Enables / disables third-party cookie blocking in private browsing mode. + type: Boolean + default: true + toolbar-redesign-option: + description: Control the visibility of toolbar redesign option in settings. + variables: + show-expanded-customization: + description: | + Whether or not the expanded toolbar customization option is visible to the user. + type: Boolean + default: false + show-options: + description: | + Whether or not the toolbar redesign option is visible to the user. This allows the user to switch between simple and expanded toolbar. + type: Boolean + default: true + show-simple-customization: + description: | + Whether or not the simple toolbar customization option is visible to the user. + type: Boolean + default: false + top-sites-suggestions: + description: Enables top sites suggestions. + variables: + enabled: + description: | + Whether or not to enable top sites suggestions. + type: Boolean + default: true + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 2 + translations: + description: The feature that allows on-device translations of web content. + variables: + downloads-enabled: + description: | + Show the global language model download options entry point for translations. ('Download languages' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-lang-settings-enabled: + description: | + Show the global language options entry point for automatically translating. ('Automatic Translation' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-settings-enabled: + description: | + Show the global settings entry point within the translations feature. ('Translation Settings' on the page settings view.) 'page-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-site-settings-enabled: + description: | + Show the global never translate this site options entry point for site management. ('Never translate these sites' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + main-flow-browser-menu-enabled: + description: | + Show the browser menu entry point into the translations feature. ('Translate Page' on browser menu.) + type: Boolean + default: true + main-flow-toolbar-enabled: + description: | + Show the primary toolbar entry point into the translations feature. (Translations icon on URL toolbar.) + type: Boolean + default: true + page-settings-enabled: + description: | + Show the page settings entry point within the translations feature. (Gear icon on the translations main flow page.) 'main-flow-toolbar-enabled' or 'main-flow-browser-menu-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + trending-searches: + description: Enables trending searches. + variables: + enabled: + description: | + Whether or not to enable trending searches. + type: Boolean + default: true + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 5 + unified-trust-panel: + description: Enables the unified trust panel. + variables: + enabled: + description: | + Whether or not to enable the unified trust panel. + 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. + collections: + description: The collections section of the homepage. + header: + description: The header of the homescreen. + 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 + synced-tabs: + description: The synced tabs section of the homepage. + top-sites: + description: The frecency and pinned sites. + MR2022Section: + description: The identifiers for the sections of the MR 2022. + variants: + 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-search-widget: + description: Allows user to add search widget to homescreen. + default-browser: + description: Allows user to set Firefox as the default browser. + marketing-data: + description: Allows user to opt out of marketing data collection. + notification-permission: + description: Allows user to enable notification permission. + sync-sign-in: + description: Allows user to sync with a Firefox account. + terms-of-service: + description: Page to display the terms of services. + theme-selection: + description: Allows user to choose between dark and light themes. + toolbar-placement: + description: Allows user to choose the toolbar position. + OnboardingPanel: + description: The types of onboarding panels in the onboarding page + variants: + privacy-notice: + description: The onboarding panel where users can tap to view our privacy notice. + sync: + description: The onboarding panel where users can sign in to sync + tcp: + description: The onboarding panel where users can choose their total cookie protection settings + themes: + description: The themes onboarding panel where users pick themes + toolbar-placement: + description: The onboarding panel where users choose their toolbar placement (bottom or top) + QueryParameterStrippingSection: + description: The identifiers for the options for the Query Parameter Stripping feature. + variants: + query-parameter-stripping: + description: An integer either 0 or 1 indicating if query parameter stripping should be enabled or disabled in normal mode. 0 for setting to be disabled, and 1 for enabling the setting. + query-parameter-stripping-allow-list: + description: An string separated by commas indicating the sites where should from query stripping should be exempted. + query-parameter-stripping-pmb: + description: An integer either 0 or 1 indicating if query parameter stripping should be enabled or disabled in private mode. 0 for setting to be disabled, and 1 for enabling the setting. + query-parameter-stripping-strip-list: + description: An string separated by commas indicating the list of query params to be stripped from URIs. This list will be merged with records coming from RemoteSettings. + SetupChecklistType: + description: An enum to represent the different experiment branches for the setup checklist. + variants: + collection-1: + description: The collection for the setup checklist that has 3 items. + collection-2: + description: The collection for the setup checklist that has 6 items. + SuggestionType: + description: The type of a Firefox Suggest search suggestion. + variants: + amp: + description: A Firefox Suggestion from adMarketplace. + ampMobile: + description: A firefox Suggestion from adMarketplace specifically for mobile. + wikipedia: + description: A Firefox Suggestion for a Wikipedia page. + ThemeType: + description: An enum to describe a theme selection option. + variants: + theme-dark: + description: Sets the theme to dark mode. + theme-light: + description: Sets the theme to light mode. + theme-system: + description: Adapts the theme to match the device's system setting. + ToolbarType: + description: An enum to describe a toolbar placement option. + variants: + toolbar-bottom: + description: Sets the toolbar placement on the bottom. + toolbar-top: + description: Sets the toolbar placement on the top. +objects: + CustomizationThemeData: + description: Defines an option for theme selection. + fields: + image-res: + description: The resource id of the image to be displayed. + type: Image + default: ic_pick_a_theme_system_auto + label: + description: Display text for the theme option (e.g., "Light Theme"). + type: Text + default: '' + theme-type: + description: The type of the theming option. + type: ThemeType + default: theme-system + CustomizationToolbarData: + description: An object to describe the placement of the toolbar. + fields: + image-res: + description: The resource id of toolbar placement image. + type: Image + default: ic_onboarding_customize_toolbar + label: + description: Display text for the toolbar placement option (e.g. "Top placement"). + type: Text + default: '' + toolbar-type: + description: The type of toolbar placement. + type: ToolbarType + default: toolbar-top + ExtraCardData: + description: Holds data for cards that require additional data, e.g. toolbar placement cards. + fields: + customization-theme-data: + description: An optional list of theme choices for the theme selection card. + type: List + default: [] + customization-toolbar-data: + description: | + An optional list of toolbar placements for the toolbar placement card. + type: List + default: [] + marketing-data: + description: | + An optional marketing data for the onboarding card. + type: Option + default: null + term-of-service-data: + description: | + An optional terms of service data for the onboarding card. + type: Option + default: null + GleanServerKnobsConfiguration: + description: A configuration object for Glean server knobs. + fields: + event_threshold: + description: The threshold of events that will be buffered before an events ping is collected and submitted. + type: Option + default: null + metrics_enabled: + description: A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric. + type: Map + default: {} + pings_enabled: + description: A map of ping names to booleans representing the state of the 'enabled' flag for that ping. + type: Map + default: {} + MarketingData: + description: An object to describe the marketing data onboarding card. + fields: + body-line-one-link-text: + description: The link text from line one of the body. + type: Text + default: '' + body-line-one-text: + description: The text for line one of the body. + type: Text + default: '' + body-line-two-text: + description: The text for line two of the body. + type: Text + default: '' + MessageData: + description: | + An object to describe a message. It uses human readable strings to describe the triggers, action and style of the message as well as the text of the message and call to action. + fields: + action: + description: | + A URL of a page or a deeplink. This may have substitution variables in. + type: ActionName + default: OPEN_URL + action-params: + description: | + A string map containing query parameters that will be appended to the action URL. This is useful for opening URLs in tabs, or specifying that the tab should be private. The values may have substitutions, e.g. "url": "https://example.com/id={uuid}", "private": "true". + The params and their values are all determined downstream of the messaging component, by the embedding app's deeplink processing machinery. + type: Map + default: {} + button-label: + description: | + The text on the button. If no text is present, the whole message is clickable. + type: Option + default: null + exclude-if-any: + description: | + A list of strings corresponding to targeting expressions. The message will not be shown if any of the expressions are `true`. + type: List + default: [] + experiment: + description: The slug of the experiment that this message came from. + type: Option + default: null + is-control: + description: Indicates if this message is the control message, if true shouldn't be displayed + type: Boolean + default: false + microsurvey-config: + description: Optional configuration data for a microsurvey. + type: Option + default: null + style: + description: | + The style as described in a `StyleData` from the styles table. + type: StyleName + default: DEFAULT + surface: + description: The surface identifier for this message. + type: SurfaceName + default: homescreen + text: + description: The message text displayed to the user + type: Text + default: '' + title: + description: The title text displayed to the user + type: Option + default: null + trigger-if-all: + description: | + A list of strings corresponding to targeting expressions. The message will be shown if all expressions are `true`. + type: List + default: [] + MicrosurveyAnswer: + description: Attributes relating to microsurvey content. + fields: + ordering: + description: | + Used 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. + 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: null + utm-content: + description: Optional "utm_content" parameter for the privacy notice URL to specify the feature being surveyed. + type: Option + default: null + NotificationConfig: + description: Attributes controlling the global configuration of notification messages. + fields: + refresh-interval: + description: | + How often, in minutes, the notification message worker will wake up and check for new messages. + type: Int + default: 240 + OnboardingCardData: + description: An object to describe a user facing onboarding card. + fields: + body: + description: The message text displayed to the user. May contain linkable text. + type: Text + default: '' + card-type: + description: The type of the card. + type: OnboardingCardType + default: default-browser + disqualifiers: + description: | + A list of strings corresponding to targeting expressions. The card will not be shown if any expression is `true`. + type: List + default: + - NEVER + enabled: + description: If true, this card is shown to the user. + type: Boolean + default: true + extra-data: + description: Optional extra data for cards that require additional data. + type: Option + default: null + image-res: + description: The resource id of the image to be displayed. + type: Image + default: ic_onboarding_welcome + ordering: + description: Used to sequence the cards. + type: Int + default: 0 + prerequisites: + description: | + A list of strings corresponding to targeting expressions. The card will be shown if all expressions are `true` and if no expressions in the `disqualifiers` table are true, or if the `disqualifiers` table is empty. + type: List + default: + - ALWAYS + primary-button-label: + description: The text to display on the primary button. + type: Text + default: '' + secondary-button-label: + description: The text to display on the secondary button. + type: Text + default: '' + title: + description: The title text displayed to the user. + type: Text + default: '' + StyleData: + description: | + A group of properties (predominantly visual) to describe the style of the message. + fields: + max-display-count: + description: | + How many sessions will this message be shown to the user before it is expired. + type: Int + default: 5 + priority: + description: | + The importance of this message. 0 is not very important, 100 is very important. + type: Int + default: 50 + TermsOfServiceData: + description: An object to describe the terms of service onboarding card. + fields: + line-one-link-text: + description: The text for the link of line one. + type: Text + default: '' + line-one-link-url: + description: The url for the link of line one. + type: Text + default: '' + line-one-text: + description: The text for line one. + type: Text + default: '' + line-three-link-text: + description: The text for the link of line three. + type: Text + default: '' + line-three-text: + description: The text for line three. + type: Text + default: '' + line-two-link-text: + description: The text for the link of line two. + type: Text + default: '' + line-two-link-url: + description: The url for the link of line two. + type: Text + default: '' + line-two-text: + description: The text for line two. + type: Text + default: '' + subheader-one-text: + description: Optional text for the first subheader of the card. + type: Option + default: null + subheader-three-text: + description: Optional text for the third subheader of the card. + type: Option + default: null + subheader-two-text: + description: Optional text for the second subheader of the card. + type: Option + default: null diff --git a/experimenter/experimenter/features/manifests/fenix/v145.0.0/experimenter.yaml b/experimenter/experimenter/features/manifests/fenix/v145.0.0/experimenter.yaml new file mode 100644 index 0000000000..446885ee91 --- /dev/null +++ b/experimenter/experimenter/features/manifests/fenix/v145.0.0/experimenter.yaml @@ -0,0 +1,771 @@ +address-sync: + description: Turns on address sync. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to turn on address sync. +alternative-app-launcher-icon: + description: A feature that changes the app launcher icon background color. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, the feature is active. + reset-to-default: + type: boolean + description: | + If true use the default icon, if false use the alternative icon. This is required to 'reset' the icon for enrolled users once the initial experiment is complete. +app-icon-selection: + description: Allows the user to set an alternative app launcher icon. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: Whether or not the feature is available for the user. +awesomebar-suggestion-provider: + description: Configuration for the Firefox Suggest awesomebar suggestion provider. + hasExposure: true + exposureDescription: '' + variables: + available-suggestion-types: + type: json + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. +baseline-fpp: + description: Control Baseline Fingerprinting Protection + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: Enables / disables baseline fingerprinting protection. + feat-enabled: + type: boolean + description: If true, the feature is active. + overrides: + type: string + description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. +bookmarks: + description: Feature for Bookmarks + hasExposure: true + exposureDescription: '' + variables: + new-compose-ui: + type: boolean + description: if true, enable new compose based UI +composable-toolbar: + description: Use a composable toolbar instead of the View based one. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + When the feature is enabled the user will see a new composable toolbar instead the previous View based one. +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. +custom-review-prompt: + description: Feature that controls the Play store in-app custom review prompt. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: Whether or not to enable the custom review prompt. +doh: + description: Feature controlling DNS over HTTPS (DoH). + hasExposure: true + exposureDescription: '' + variables: + autoselect-enabled: + type: boolean + description: | + Controls the network.android_doh.autoselect_enabled pref and automatically chooses a DoH provider when Default Protection mode is selected. + show-ui: + type: boolean + description: | + When `true`, include DoH settings in the settings UI. +encourage-search-cfr: + description: A feature that shows a CFR on first launch to encourage users to make a search + hasExposure: true + exposureDescription: '' + variables: + cfrText: + type: string + description: The text to show in the CFR + enabled: + type: boolean + description: When true, the CFR will show +fingerprinting-protection: + description: Control Fingerprinting Protection + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, the feature is active. + enabled-normal: + type: boolean + description: | + Enables / disables fingerprinting protection in normal browsing mode. + enabled-private: + type: boolean + description: | + Enables / disables fingerprinting protection in private browsing mode. + fdlibm-math: + type: boolean + description: | + Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy + overrides: + type: string + description: | + The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. +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. +fx-suggest: + description: A feature that provides Firefox Suggest search suggestions. + hasExposure: true + exposureDescription: '' + variables: + boost-amp-wiki: + type: boolean + description: | + The feature boost wiki and AMP suggestions to the top of its group. + enabled: + type: boolean + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. +glean: + description: A feature that provides server-side configurations for Glean metrics (aka Server Knobs). + hasExposure: true + exposureDescription: '' + variables: + delay-ping-lifetime-io: + type: boolean + description: Glean will delay io for ping lifetime metrics + enable-event-timestamps: + type: boolean + description: Enables precise event timestamps for Glean events + gleanMetricConfiguration: + type: json + description: Configuration for Glean Server Knobs + ping-lifetime-max-time: + type: int + description: After what time to auto-flush + ping-lifetime-threshold: + type: int + description: Write count threshold when to auto-flush +growth-data: + description: A feature measuring campaign growth data + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, the feature is active +homepage-as-new-tab: + description: Enables homepage as a a new tab. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable homepage as a new tab +homepage-hide-frecent-top-sites: + description: Hides frecent top sites on the homepage. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to hide frecent top sites on the homepage. +homepage-search-bar: + description: Enables the homepage search bar. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable the homepage search bar. +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. +isolated-content-processes: + description: Feature that controls content process isolation. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable isolated content processes. +javascript: + description: Enables Javascript Engine (Spidermonkey) features + hasExposure: true + exposureDescription: '' + variables: + parallelMarkingEnabled: + type: boolean + description: | + Enables or disables javascript.options.mem.gc_parallel_marking preference. +juno-onboarding: + description: A feature that shows the onboarding flow. + hasExposure: true + exposureDescription: '' + variables: + cards: + type: json + description: Collection of user facing onboarding cards. + conditions: + type: json + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + use-onboarding-redesign: + type: boolean + description: If true, use the onboarding redesign. +lna-blocking: + description: Feature that allows blocking local network or device access. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to turn on local network / device access blocking +menu-redesign: + description: Control the new menu redesign. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, the new menu redesign is available. + menu-banner: + type: boolean + description: If true, the menu banner is visible. + report-site-issue: + type: boolean + description: If true, report site issue menu item and preview is available. +messaging: + description: | + The in-app messaging system. + hasExposure: true + exposureDescription: '' + variables: + $$experiment: + type: string + description: The only acceptable value for `MessageData#experiment`. This should not be set by experiment. + $$surfaces: + type: json + description: | + A list available surfaces for this app. + + This should not be written to by experiments, and should be hidden to users. + actions: + type: json + description: A growable map of action URLs. + message-under-experiment: + type: string + description: Deprecated in favor of `MessageData#experiment`. This will be removed in future releases. + messages: + type: json + description: A growable collection of messages + notification-config: + type: json + description: Configuration of the notification worker for all notification messages. + on-control: + type: string + description: What should be displayed when a control message is selected. + enum: + - show-next-message + - show-none + styles: + type: json + description: | + A map of styles to configure message appearance. + triggers: + type: json + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. +microsurveys: + description: Feature for microsurveys. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + When the feature is enabled then microsurveys can be used. +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. +networking: + description: Enables networking features + hasExposure: true + exposureDescription: '' + variables: + fetchPriorityEnabled: + type: boolean + description: | + Enables or disables network.fetchpriority.enabled preference. +networkingBannedPorts: + description: Networking (Necko) Banned Ports + hasExposure: true + exposureDescription: '' + variables: + bannedPortList: + type: string + description: A comma-separated list of ports that Firefox will refuse to connect to. These ports will be appended to nsIOService gBadPortList +nimbus-is-ready: + description: | + A feature that provides the number of Nimbus is_ready events to send when Nimbus finishes launching. + hasExposure: true + exposureDescription: '' + variables: + event-count: + type: int + description: The number of events that should be sent. +nimbus-system: + description: | + Configuration of the Nimbus System in Android. + hasExposure: true + exposureDescription: '' + variables: + refresh-interval-foreground: + type: int + description: | + The minimum interval in minutes between fetching experiment + recipes in the foreground. +nimbus-validation: + description: A feature that does not correspond to an application feature suitable for showing that Nimbus is working. This should never be used in production. + hasExposure: true + exposureDescription: '' + variables: + settings-icon: + type: string + description: The drawable displayed in the app menu for Settings + settings-punctuation: + type: string + description: The emoji displayed in the Settings screen title. + settings-title: + type: string + description: The title of displayed in the Settings screen and app menu. +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. +override-user-specified-homepage-sections: + description: Whether to ignore the user-specified homepage section visibility settings and hide the options in the settings. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + When true, ignore the user-specified homepage section visibility settings, and hide the toggle options in the settings. +pdfjs: + description: PDF.js features + hasExposure: true + exposureDescription: '' + variables: + download-button: + type: boolean + description: Download button + open-in-app-button: + type: boolean + description: Open in app button +pki: + description: Certificate verification configuration + hasExposure: true + exposureDescription: '' + variables: + certificateTransparencyMode: + type: int + description: | + What mode Certificate Transparency is in (0=disable, 1=telemetry only, 2=enforce). +pqcrypto: + description: Control the use of post-quantum key exchange mechanisms in TLS and HTTP/3. + hasExposure: true + exposureDescription: '' + variables: + postQuantumKeyExchangeEnabled: + type: boolean + description: | + Toggles the security.tls.enable_kyber and network.http.http3.enable_kyber preferences. +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-lock: + description: Allows enabling and disabling the private browsing mode lock via an authentication screen. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable private browsing mode lock. +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. +recent-searches: + description: Enables recent searches. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable recent searches. + max-suggestions: + type: int + description: The number of maximum suggestions. +remote-search-configuration: + description: Feature to use search configurations from remote servers. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Uses search configuration from remote servers . +remote-tab-management: + description: | + Features that let users manage tabs on other devices that are connected to the same Mozilla account. + hasExposure: true + exposureDescription: '' + variables: + close-tabs-enabled: + type: boolean + description: | + Whether the feature to close synced tabs is enabled. When enabled, this device will allow other devices to close tabs that are open on this device, and show a "close" button for tabs that are currently open on other supported devices in the synced tabs tray. +same-document-navigation-overrides-load-type: + description: Control whether the same document navigation overrides the load type. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Overrides the loadType when it is a same document navigation + force-disable-uri: + type: string + description: | + Disable overriding the loadType during same document navigation on the domain specified by this URI. +search-extra-params: + description: A feature that provides additional args for search. + hasExposure: true + exposureDescription: '' + variables: + channel-id: + type: json + description: The channel Id param name with arg. + enabled: + type: boolean + description: If true, the feature is active. + feature-enabler: + type: json + description: The feature enabler param name with arg, NOTE this map could be empty. + search-engine: + type: string + description: The search engine name. +search-suggestions-on-homepage: + description: Enables search suggestions on homepage. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable search suggestions on homepage. +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. +sent-from-firefox: + description: A feature that allows the user to add a download firefox footer to a shared link. + hasExposure: true + exposureDescription: '' + variables: + download-link: + type: string + description: A store download link. + enabled: + type: boolean + description: If true, the feature is available for the user. + show-snackbar: + type: boolean + description: If true, the user will see the snackbar after sharing a link, allowing quick navigation to settings. + template-message: + type: string + description: A template for the shared message, supporting three placeholders. A shared link, the brand name and a store download link. +setup-checklist: + description: A feature on the home page that allows the user to track onboarding setup progress. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, the setup checklist will be enabled. + setup-checklist-type: + type: string + description: The collection used for the setup checklist. + enum: + - collection-1 + - collection-2 +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. +splash-screen: + description: A feature that extends splash screen duration, allowing additional data fetching time for the app's initial run. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, the feature is active. + maximum_duration_ms: + type: int + description: The maximum amount of time in milliseconds the splashscreen will be visible while waiting for initialization calls to complete. + off-train-onboarding: + type: boolean + description: If true, the fetched data will be applied and used during the session. +suggest-shipped-domains: + description: Feature that suggests domains from the shipped domain list. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Suggest domains from the shipped domain list. +suppress-sponsored-top-sites: + description: Suppress sponsored top sites for new users for 14 days. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, new users won’t see sponsored tiles for 14 days. +tab-management-enhancements: + description: Control the visibility of the tab management enhancements. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable the tab management enhancements. +tab-strip: + description: Enables tab strip. + hasExposure: true + exposureDescription: '' + variables: + allow-on-all-devices: + type: boolean + description: | + Experimental: When true, bypasses device restrictions and enables use on all devices. May cause instability or unexpected behavior. This still requires the feature to be `enabled`. + enabled: + type: boolean + description: | + Whether or not to enable tab strip. +terms-of-use-prompt: + description: Enables the terms of use prompt for users who have not accepted ToU + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: When the feature is enabled then the prompt can show for users. +third-party-cookie-blocking: + description: Control third-party cookie blocking. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If true, the feature is active. + enabled-normal: + type: boolean + description: | + Enables / disables third-party cookie blocking in normal browsing mode. + enabled-private: + type: boolean + description: | + Enables / disables third-party cookie blocking in private browsing mode. +toolbar-redesign-option: + description: Control the visibility of toolbar redesign option in settings. + hasExposure: true + exposureDescription: '' + variables: + show-expanded-customization: + type: boolean + description: | + Whether or not the expanded toolbar customization option is visible to the user. + show-options: + type: boolean + description: | + Whether or not the toolbar redesign option is visible to the user. This allows the user to switch between simple and expanded toolbar. + show-simple-customization: + type: boolean + description: | + Whether or not the simple toolbar customization option is visible to the user. +top-sites-suggestions: + description: Enables top sites suggestions. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable top sites suggestions. + max-suggestions: + type: int + description: The number of maximum suggestions. +translations: + description: The feature that allows on-device translations of web content. + hasExposure: true + exposureDescription: '' + variables: + downloads-enabled: + type: boolean + description: | + Show the global language model download options entry point for translations. ('Download languages' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + global-lang-settings-enabled: + type: boolean + description: | + Show the global language options entry point for automatically translating. ('Automatic Translation' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + global-settings-enabled: + type: boolean + description: | + Show the global settings entry point within the translations feature. ('Translation Settings' on the page settings view.) 'page-settings-enabled' must also be enabled for users to access this feature. + global-site-settings-enabled: + type: boolean + description: | + Show the global never translate this site options entry point for site management. ('Never translate these sites' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + main-flow-browser-menu-enabled: + type: boolean + description: | + Show the browser menu entry point into the translations feature. ('Translate Page' on browser menu.) + main-flow-toolbar-enabled: + type: boolean + description: | + Show the primary toolbar entry point into the translations feature. (Translations icon on URL toolbar.) + page-settings-enabled: + type: boolean + description: | + Show the page settings entry point within the translations feature. (Gear icon on the translations main flow page.) 'main-flow-toolbar-enabled' or 'main-flow-browser-menu-enabled' must also be enabled for users to access this feature. +trending-searches: + description: Enables trending searches. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable trending searches. + max-suggestions: + type: int + description: The number of maximum suggestions. +unified-trust-panel: + description: Enables the unified trust panel. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether or not to enable the unified trust panel. +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/v145.0.0/nightly.fml.yaml b/experimenter/experimenter/features/manifests/fenix/v145.0.0/nightly.fml.yaml new file mode 100644 index 0000000000..e9fa7a4555 --- /dev/null +++ b/experimenter/experimenter/features/manifests/fenix/v145.0.0/nightly.fml.yaml @@ -0,0 +1,1492 @@ +version: 1.0.0 +about: + description: Nimbus Feature Manifest for Fenix (Firefox Android) +channels: +- nightly +features: + address-sync: + description: Turns on address sync. + variables: + enabled: + description: | + Whether or not to turn on address sync. + type: Boolean + default: false + alternative-app-launcher-icon: + description: A feature that changes the app launcher icon background color. + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + reset-to-default: + description: | + If true use the default icon, if false use the alternative icon. This is required to 'reset' the icon for enrolled users once the initial experiment is complete. + type: Boolean + default: false + app-icon-selection: + description: Allows the user to set an alternative app launcher icon. + variables: + enabled: + description: Whether or not the feature is available for the user. + type: Boolean + default: true + awesomebar-suggestion-provider: + description: Configuration for the Firefox Suggest awesomebar suggestion provider. + variables: + available-suggestion-types: + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + type: Map + default: + amp: true + ampMobile: false + wikipedia: true + baseline-fpp: + description: Control Baseline Fingerprinting Protection + variables: + enabled: + description: Enables / disables baseline fingerprinting protection. + type: Boolean + default: true + feat-enabled: + description: If true, the feature is active. + type: Boolean + default: false + overrides: + description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. + type: String + default: '' + bookmarks: + description: Feature for Bookmarks + variables: + new-compose-ui: + description: if true, enable new compose based UI + type: Boolean + default: false + composable-toolbar: + description: Use a composable toolbar instead of the View based one. + variables: + enabled: + description: | + When the feature is enabled the user will see a new composable toolbar instead the previous View based one. + type: Boolean + default: true + 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 + custom-review-prompt: + description: Feature that controls the Play store in-app custom review prompt. + variables: + enabled: + description: Whether or not to enable the custom review prompt. + type: Boolean + default: false + doh: + description: Feature controlling DNS over HTTPS (DoH). + variables: + autoselect-enabled: + description: | + Controls the network.android_doh.autoselect_enabled pref and automatically chooses a DoH provider when Default Protection mode is selected. + type: Boolean + default: false + show-ui: + description: | + When `true`, include DoH settings in the settings UI. + type: Boolean + default: true + encourage-search-cfr: + description: A feature that shows a CFR on first launch to encourage users to make a search + variables: + cfrText: + description: The text to show in the CFR + type: Text + default: '' + enabled: + description: When true, the CFR will show + type: Boolean + default: false + fingerprinting-protection: + description: Control Fingerprinting Protection + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + enabled-normal: + description: | + Enables / disables fingerprinting protection in normal browsing mode. + type: Boolean + default: false + enabled-private: + description: | + Enables / disables fingerprinting protection in private browsing mode. + type: Boolean + default: true + fdlibm-math: + description: | + Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy + type: Boolean + default: false + overrides: + description: | + The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. + type: String + default: '' + fission: + description: The feature that controls whether fission is enabled or not in Gecko. + variables: + enabled: + description: | + Whether or not to enable fission. Fission is enabled when set to true. Fission is disabled when set to false. + type: Boolean + default: false + fx-suggest: + description: A feature that provides Firefox Suggest search suggestions. + variables: + boost-amp-wiki: + description: | + The feature boost wiki and AMP suggestions to the top of its group. + type: Boolean + default: false + enabled: + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. + type: Boolean + default: true + glean: + description: A feature that provides server-side configurations for Glean metrics (aka Server Knobs). + variables: + delay-ping-lifetime-io: + description: Glean will delay io for ping lifetime metrics + type: Boolean + default: true + enable-event-timestamps: + description: Enables precise event timestamps for Glean events + type: Boolean + default: true + gleanMetricConfiguration: + description: Configuration for Glean Server Knobs + type: GleanServerKnobsConfiguration + default: + event_threshold: null + metrics_enabled: {} + pings_enabled: {} + ping-lifetime-max-time: + description: After what time to auto-flush + type: Int + default: 2000 + ping-lifetime-threshold: + description: Write count threshold when to auto-flush + type: Int + default: 1000 + allow-coenrollment: true + growth-data: + description: A feature measuring campaign growth data + variables: + enabled: + description: If true, the feature is active + type: Boolean + default: false + homepage-as-new-tab: + description: Enables homepage as a a new tab. + variables: + enabled: + description: | + Whether or not to enable homepage as a new tab + type: Boolean + default: false + homepage-hide-frecent-top-sites: + description: Hides frecent top sites on the homepage. + variables: + enabled: + description: | + Whether or not to hide frecent top sites on the homepage. + type: Boolean + default: false + homepage-search-bar: + description: Enables the homepage search bar. + variables: + enabled: + description: | + Whether or not to enable the homepage search bar. + 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: + header: true + top-sites: true + jump-back-in: true + bookmarks: true + recent-explorations: true + pocket: true + pocket-sponsored-stories: true + synced-tabs: true + collections: true + isolated-content-processes: + description: Feature that controls content process isolation. + variables: + enabled: + description: | + Whether or not to enable isolated content processes. + type: Boolean + default: false + javascript: + description: Enables Javascript Engine (Spidermonkey) features + variables: + parallelMarkingEnabled: + description: | + Enables or disables javascript.options.mem.gc_parallel_marking preference. + type: Boolean + default: false + juno-onboarding: + description: A feature that shows the onboarding flow. + variables: + cards: + description: Collection of user facing onboarding cards. + type: Map + default: + terms-of-service: + body: onboarding_terms_of_service_sub_header_2 + card-type: terms-of-service + disqualifiers: + - NEVER + enabled: true + extra-data: + term-of-service-data: + line-one-text: onboarding_term_of_service_line_one_2 + line-one-link-text: onboarding_term_of_service_line_one_link_text_2 + line-two-text: onboarding_term_of_service_line_two_2 + line-two-link-text: onboarding_term_of_service_line_two_link_text + line-three-text: onboarding_term_of_service_line_three + line-three-link-text: onboarding_term_of_service_line_three_link_text + image-res: ic_firefox + ordering: 1 + prerequisites: + - ALWAYS + primary-button-label: onboarding_term_of_service_agree_and_continue_button_label_2 + secondary-button-label: '' + title: onboarding_welcome_to_firefox + default-browser: + body: juno_onboarding_default_browser_description_nimbus_3 + card-type: default-browser + disqualifiers: + - NEVER + enabled: true + extra-data: null + 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: + body: juno_onboarding_add_search_widget_description + card-type: add-search-widget + disqualifiers: + - NEVER + enabled: true + extra-data: null + 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: + body: juno_onboarding_sign_in_description_3 + card-type: sync-sign-in + disqualifiers: + - NEVER + enabled: true + extra-data: null + 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: + body: juno_onboarding_enable_notifications_description_nimbus_2 + card-type: notification-permission + disqualifiers: + - NEVER + enabled: true + extra-data: null + 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 + theme-selection: + body: onboarding_customize_theme_description + card-type: theme-selection + disqualifiers: + - NEVER + enabled: true + extra-data: + customization-theme-data: + - theme-type: theme-system + label: onboarding_customize_theme_system_option + image-res: ic_pick_a_theme_system_auto + - theme-type: theme-light + label: onboarding_customize_theme_light_option + image-res: ic_pick_a_theme_light + - theme-type: theme-dark + label: onboarding_customize_theme_dark_option + image-res: ic_pick_a_theme_dark + image-res: ic_pick_a_theme + ordering: 33 + prerequisites: + - ALWAYS + primary-button-label: onboarding_save_and_continue_button + secondary-button-label: '' + title: onboarding_customize_theme_title + toolbar-placement: + body: onboarding_customize_toolbar_description + card-type: toolbar-placement + disqualifiers: + - NEVER + enabled: true + extra-data: + customization-toolbar-data: + - toolbar-type: toolbar-top + label: onboarding_customize_toolbar_top_option + image-res: ic_onboarding_top_toolbar + - toolbar-type: toolbar-bottom + label: onboarding_customize_toolbar_bottom_option + image-res: ic_onboarding_bottom_toolbar + image-res: ic_onboarding_customize_toolbar + ordering: 37 + prerequisites: + - ALWAYS + primary-button-label: onboarding_save_and_continue_button + secondary-button-label: '' + title: onboarding_customize_toolbar_title + marketing: + body: onboarding_marketing_body + card-type: marketing-data + disqualifiers: + - NEVER + enabled: true + extra-data: + marketing-data: + body-line-one-text: onboarding_marketing_learn_more + body-line-one-link-text: onboarding_marketing_learn_more + body-line-two-text: onboarding_marketing_opt_out_checkbox + image-res: ic_onboarding_welcome + ordering: 40 + prerequisites: + - ALWAYS + primary-button-label: onboarding_marketing_positive_button + secondary-button-label: '' + title: onboarding_marketing_title + string-alias: OnboardingCardKey + conditions: + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + string-alias: ConditionName + use-onboarding-redesign: + description: If true, use the onboarding redesign. + type: Boolean + default: false + lna-blocking: + description: Feature that allows blocking local network or device access. + variables: + enabled: + description: | + Whether or not to turn on local network / device access blocking + type: Boolean + default: false + menu-redesign: + description: Control the new menu redesign. + variables: + enabled: + description: If true, the new menu redesign is available. + type: Boolean + default: true + menu-banner: + description: If true, the menu banner is visible. + type: Boolean + default: true + report-site-issue: + description: If true, report site issue menu item and preview is available. + type: Boolean + default: true + messaging: + description: | + The in-app messaging system. + variables: + $$experiment: + description: The only acceptable value for `MessageData#experiment`. This should not be set by experiment. + type: ExperimentSlug + default: '{experiment}' + string-alias: ExperimentSlug + $$surfaces: + description: | + A list available surfaces for this app. + + This should not be written to by experiments, and should be hidden to users. + type: List + default: + - homescreen + - notification + - survey + - microsurvey + string-alias: SurfaceName + actions: + description: A growable map of action URLs. + type: Map + default: + OPEN_URL: ://open + ENABLE_PRIVATE_BROWSING: ://enable_private_browsing + INSTALL_SEARCH_WIDGET: ://install_search_widget + MAKE_DEFAULT_BROWSER: ://make_default_browser + VIEW_BOOKMARKS: ://urls_bookmarks + VIEW_COLLECTIONS: ://home_collections + VIEW_HISTORY: ://urls_history + VIEW_HOMESCREEN: ://home + OPEN_SETTINGS_ACCESSIBILITY: ://settings_accessibility + OPEN_SETTINGS_ADDON_MANAGER: ://settings_addon_manager + OPEN_SETTINGS_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: null + messages: + description: A growable collection of messages + type: Map + default: + default-browser: + title: default_browser_experiment_card_title + text: default_browser_experiment_card_text + surface: homescreen + action: MAKE_DEFAULT_BROWSER + trigger-if-all: + - USER_ESTABLISHED_INSTALL + - ANDROID_API_BELOW_29 + exclude-if-any: + - I_AM_DEFAULT_BROWSER + style: PERSISTENT + button-label: preferences_set_as_default_browser + default-browser-notification: + title: nimbus_notification_default_browser_title + text: nimbus_notification_default_browser_text + surface: notification + style: NOTIFICATION + trigger-if-all: + - DAY_3_AFTER_INSTALL + exclude-if-any: + - I_AM_DEFAULT_BROWSER + action: MAKE_DEFAULT_BROWSER + microsurvey-printing-example-nightly: + title: microsurvey_prompt_printing_title + text: microsurvey_survey_printing_title + surface: microsurvey + trigger-if-all: + - RECENTLY_PRINTED + style: MICROSURVEY + microsurvey-config: + utm-content: homepage + icon: ic_print + answers: + - text: likert_scale_option_1 + ordering: 0 + - text: likert_scale_option_2 + ordering: 1 + - text: likert_scale_option_3 + ordering: 2 + - text: likert_scale_option_4 + ordering: 3 + - text: likert_scale_option_5 + ordering: 4 + - text: likert_scale_option_6 + ordering: 5 + string-alias: MessageKey + notification-config: + description: Configuration of the notification worker for all notification messages. + type: NotificationConfig + default: + refresh-interval: 240 + on-control: + description: What should be displayed when a control message is selected. + type: ControlMessageBehavior + default: show-next-message + styles: + description: | + A map of styles to configure message appearance. + type: Map + default: + DEFAULT: + priority: 50 + max-display-count: 5 + SURVEY: + priority: 55 + max-display-count: 1 + PERSISTENT: + priority: 50 + max-display-count: 20 + WARNING: + priority: 60 + max-display-count: 10 + URGENT: + priority: 100 + max-display-count: 10 + NOTIFICATION: + priority: 50 + max-display-count: 1 + MICROSURVEY: + priority: 50 + max-display-count: 5 + string-alias: StyleName + triggers: + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + type: Map + default: + USER_ESTABLISHED_INSTALL: number_of_app_launches >=4 + ANDROID_API_BELOW_29: android_version < 29 + USER_RECENTLY_INSTALLED: days_since_install < 7 + USER_RECENTLY_UPDATED: days_since_update < 7 && days_since_install != days_since_update + USER_TIER_ONE_COUNTRY: ('US' in locale || 'GB' in locale || 'CA' in locale || 'DE' in locale || 'FR' in locale) + USER_EN_SPEAKER: '''en'' in locale' + USER_ES_SPEAKER: '''es'' in locale' + USER_DE_SPEAKER: '''de'' in locale' + USER_FR_SPEAKER: '''fr'' in locale' + DEVICE_ANDROID: os == 'Android' + DEVICE_IOS: os == 'iOS' + ALWAYS: 'true' + NEVER: 'false' + DAY_1_AFTER_INSTALL: days_since_install == 1 + DAY_2_AFTER_INSTALL: days_since_install == 2 + DAY_3_AFTER_INSTALL: days_since_install == 3 + DAY_4_AFTER_INSTALL: days_since_install == 4 + DAY_5_AFTER_INSTALL: days_since_install == 5 + MORE_THAN_24H_SINCE_INSTALLED_OR_UPDATED: days_since_update >= 1 + I_AM_DEFAULT_BROWSER: is_default_browser + I_AM_NOT_DEFAULT_BROWSER: is_default_browser == false + 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. + type: Boolean + default: false + 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: + wallpapers-selection-tool: 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. + type: Boolean + default: true + networking: + description: Enables networking features + variables: + fetchPriorityEnabled: + description: | + Enables or disables network.fetchpriority.enabled preference. + type: Boolean + default: true + networkingBannedPorts: + description: Networking (Necko) Banned Ports + variables: + bannedPortList: + description: A comma-separated list of ports that Firefox will refuse to connect to. These ports will be appended to nsIOService gBadPortList + type: String + default: '' + nimbus-is-ready: + description: | + A feature that provides the number of Nimbus is_ready events to send when Nimbus finishes launching. + variables: + event-count: + description: The number of events that should be sent. + type: Int + default: 1 + nimbus-system: + description: | + Configuration of the Nimbus System in Android. + variables: + refresh-interval-foreground: + description: | + The minimum interval in minutes between fetching experiment + recipes in the foreground. + type: Int + default: 60 + nimbus-validation: + description: A feature that does not correspond to an application feature suitable for showing that Nimbus is working. This should never be used in production. + variables: + settings-icon: + description: The drawable displayed in the app menu for Settings + type: String + default: mozac_ic_settings + settings-punctuation: + description: The emoji displayed in the Settings screen title. + type: String + default: '' + settings-title: + description: The title of displayed in the Settings screen and app menu. + type: Text + default: browser_menu_settings + 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 + override-user-specified-homepage-sections: + description: Whether to ignore the user-specified homepage section visibility settings and hide the options in the settings. + variables: + enabled: + description: | + When true, ignore the user-specified homepage section visibility settings, and hide the toggle options in the settings. + type: Boolean + default: false + pdfjs: + description: PDF.js features + variables: + download-button: + description: Download button + type: Boolean + default: true + open-in-app-button: + description: Open in app button + type: Boolean + default: true + pki: + description: Certificate verification configuration + variables: + certificateTransparencyMode: + description: | + What mode Certificate Transparency is in (0=disable, 1=telemetry only, 2=enforce). + type: Int + default: 2 + pqcrypto: + description: Control the use of post-quantum key exchange mechanisms in TLS and HTTP/3. + variables: + postQuantumKeyExchangeEnabled: + description: | + Toggles the security.tls.enable_kyber and network.http.http3.enable_kyber preferences. + type: Option + default: null + 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-lock: + description: Allows enabling and disabling the private browsing mode lock via an authentication screen. + variables: + enabled: + description: | + Whether or not to enable private browsing mode lock. + type: Boolean + default: true + 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 + recent-searches: + description: Enables recent searches. + variables: + enabled: + description: | + Whether or not to enable recent searches. + type: Boolean + default: true + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 5 + remote-search-configuration: + description: Feature to use search configurations from remote servers. + variables: + enabled: + description: | + Uses search configuration from remote servers . + type: Boolean + default: true + remote-tab-management: + description: | + Features that let users manage tabs on other devices that are connected to the same Mozilla account. + variables: + close-tabs-enabled: + description: | + Whether the feature to close synced tabs is enabled. When enabled, this device will allow other devices to close tabs that are open on this device, and show a "close" button for tabs that are currently open on other supported devices in the synced tabs tray. + type: Boolean + default: true + same-document-navigation-overrides-load-type: + description: Control whether the same document navigation overrides the load type. + variables: + enabled: + description: | + Overrides the loadType when it is a same document navigation + type: Boolean + default: false + force-disable-uri: + description: | + Disable overriding the loadType during same document navigation on the domain specified by this URI. + type: String + default: '' + search-extra-params: + description: A feature that provides additional args for search. + variables: + channel-id: + description: The channel Id param name with arg. + type: Map + default: {} + enabled: + description: If true, the feature is active. + type: Boolean + default: false + feature-enabler: + description: The feature enabler param name with arg, NOTE this map could be empty. + type: Map + default: {} + search-engine: + description: The search engine name. + type: String + default: '' + search-suggestions-on-homepage: + description: Enables search suggestions on homepage. + variables: + enabled: + description: | + Whether or not to enable search suggestions on homepage. + type: Boolean + default: false + 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 + sent-from-firefox: + description: A feature that allows the user to add a download firefox footer to a shared link. + variables: + download-link: + description: A store download link. + type: Text + default: '' + enabled: + description: If true, the feature is available for the user. + type: Boolean + default: false + show-snackbar: + description: If true, the user will see the snackbar after sharing a link, allowing quick navigation to settings. + type: Boolean + default: false + template-message: + description: A template for the shared message, supporting three placeholders. A shared link, the brand name and a store download link. + type: Text + default: '' + setup-checklist: + description: A feature on the home page that allows the user to track onboarding setup progress. + variables: + enabled: + description: If true, the setup checklist will be enabled. + type: Boolean + default: false + setup-checklist-type: + description: The collection used for the setup checklist. + type: SetupChecklistType + default: collection-1 + 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. + 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 + off-train-onboarding: + description: If true, the fetched data will be applied and used during the session. + type: Boolean + default: false + suggest-shipped-domains: + description: Feature that suggests domains from the shipped domain list. + variables: + enabled: + description: | + Suggest domains from the shipped domain list. + type: Boolean + default: false + suppress-sponsored-top-sites: + description: Suppress sponsored top sites for new users for 14 days. + variables: + enabled: + description: If true, new users won’t see sponsored tiles for 14 days. + type: Boolean + default: false + tab-management-enhancements: + description: Control the visibility of the tab management enhancements. + variables: + enabled: + description: | + Whether or not to enable the tab management enhancements. + type: Boolean + default: false + tab-strip: + description: Enables tab strip. + variables: + allow-on-all-devices: + description: | + Experimental: When true, bypasses device restrictions and enables use on all devices. May cause instability or unexpected behavior. This still requires the feature to be `enabled`. + type: Boolean + default: false + enabled: + description: | + Whether or not to enable tab strip. + type: Boolean + default: true + terms-of-use-prompt: + description: Enables the terms of use prompt for users who have not accepted ToU + variables: + enabled: + description: When the feature is enabled then the prompt can show for users. + 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. + type: Boolean + default: false + enabled-private: + description: | + Enables / disables third-party cookie blocking in private browsing mode. + type: Boolean + default: true + toolbar-redesign-option: + description: Control the visibility of toolbar redesign option in settings. + variables: + show-expanded-customization: + description: | + Whether or not the expanded toolbar customization option is visible to the user. + type: Boolean + default: false + show-options: + description: | + Whether or not the toolbar redesign option is visible to the user. This allows the user to switch between simple and expanded toolbar. + type: Boolean + default: true + show-simple-customization: + description: | + Whether or not the simple toolbar customization option is visible to the user. + type: Boolean + default: false + top-sites-suggestions: + description: Enables top sites suggestions. + variables: + enabled: + description: | + Whether or not to enable top sites suggestions. + type: Boolean + default: true + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 2 + translations: + description: The feature that allows on-device translations of web content. + variables: + downloads-enabled: + description: | + Show the global language model download options entry point for translations. ('Download languages' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-lang-settings-enabled: + description: | + Show the global language options entry point for automatically translating. ('Automatic Translation' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-settings-enabled: + description: | + Show the global settings entry point within the translations feature. ('Translation Settings' on the page settings view.) 'page-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-site-settings-enabled: + description: | + Show the global never translate this site options entry point for site management. ('Never translate these sites' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + main-flow-browser-menu-enabled: + description: | + Show the browser menu entry point into the translations feature. ('Translate Page' on browser menu.) + type: Boolean + default: true + main-flow-toolbar-enabled: + description: | + Show the primary toolbar entry point into the translations feature. (Translations icon on URL toolbar.) + type: Boolean + default: true + page-settings-enabled: + description: | + Show the page settings entry point within the translations feature. (Gear icon on the translations main flow page.) 'main-flow-toolbar-enabled' or 'main-flow-browser-menu-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + trending-searches: + description: Enables trending searches. + variables: + enabled: + description: | + Whether or not to enable trending searches. + type: Boolean + default: true + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 5 + unified-trust-panel: + description: Enables the unified trust panel. + variables: + enabled: + description: | + Whether or not to enable the unified trust panel. + 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. + collections: + description: The collections section of the homepage. + header: + description: The header of the homescreen. + 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 + synced-tabs: + description: The synced tabs section of the homepage. + top-sites: + description: The frecency and pinned sites. + MR2022Section: + description: The identifiers for the sections of the MR 2022. + variants: + 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-search-widget: + description: Allows user to add search widget to homescreen. + default-browser: + description: Allows user to set Firefox as the default browser. + marketing-data: + description: Allows user to opt out of marketing data collection. + notification-permission: + description: Allows user to enable notification permission. + sync-sign-in: + description: Allows user to sync with a Firefox account. + terms-of-service: + description: Page to display the terms of services. + theme-selection: + description: Allows user to choose between dark and light themes. + toolbar-placement: + description: Allows user to choose the toolbar position. + OnboardingPanel: + description: The types of onboarding panels in the onboarding page + variants: + privacy-notice: + description: The onboarding panel where users can tap to view our privacy notice. + sync: + description: The onboarding panel where users can sign in to sync + tcp: + description: The onboarding panel where users can choose their total cookie protection settings + themes: + description: The themes onboarding panel where users pick themes + toolbar-placement: + description: The onboarding panel where users choose their toolbar placement (bottom or top) + QueryParameterStrippingSection: + description: The identifiers for the options for the Query Parameter Stripping feature. + variants: + query-parameter-stripping: + description: An integer either 0 or 1 indicating if query parameter stripping should be enabled or disabled in normal mode. 0 for setting to be disabled, and 1 for enabling the setting. + query-parameter-stripping-allow-list: + description: An string separated by commas indicating the sites where should from query stripping should be exempted. + query-parameter-stripping-pmb: + description: An integer either 0 or 1 indicating if query parameter stripping should be enabled or disabled in private mode. 0 for setting to be disabled, and 1 for enabling the setting. + query-parameter-stripping-strip-list: + description: An string separated by commas indicating the list of query params to be stripped from URIs. This list will be merged with records coming from RemoteSettings. + SetupChecklistType: + description: An enum to represent the different experiment branches for the setup checklist. + variants: + collection-1: + description: The collection for the setup checklist that has 3 items. + collection-2: + description: The collection for the setup checklist that has 6 items. + SuggestionType: + description: The type of a Firefox Suggest search suggestion. + variants: + amp: + description: A Firefox Suggestion from adMarketplace. + ampMobile: + description: A firefox Suggestion from adMarketplace specifically for mobile. + wikipedia: + description: A Firefox Suggestion for a Wikipedia page. + ThemeType: + description: An enum to describe a theme selection option. + variants: + theme-dark: + description: Sets the theme to dark mode. + theme-light: + description: Sets the theme to light mode. + theme-system: + description: Adapts the theme to match the device's system setting. + ToolbarType: + description: An enum to describe a toolbar placement option. + variants: + toolbar-bottom: + description: Sets the toolbar placement on the bottom. + toolbar-top: + description: Sets the toolbar placement on the top. +objects: + CustomizationThemeData: + description: Defines an option for theme selection. + fields: + image-res: + description: The resource id of the image to be displayed. + type: Image + default: ic_pick_a_theme_system_auto + label: + description: Display text for the theme option (e.g., "Light Theme"). + type: Text + default: '' + theme-type: + description: The type of the theming option. + type: ThemeType + default: theme-system + CustomizationToolbarData: + description: An object to describe the placement of the toolbar. + fields: + image-res: + description: The resource id of toolbar placement image. + type: Image + default: ic_onboarding_customize_toolbar + label: + description: Display text for the toolbar placement option (e.g. "Top placement"). + type: Text + default: '' + toolbar-type: + description: The type of toolbar placement. + type: ToolbarType + default: toolbar-top + ExtraCardData: + description: Holds data for cards that require additional data, e.g. toolbar placement cards. + fields: + customization-theme-data: + description: An optional list of theme choices for the theme selection card. + type: List + default: [] + customization-toolbar-data: + description: | + An optional list of toolbar placements for the toolbar placement card. + type: List + default: [] + marketing-data: + description: | + An optional marketing data for the onboarding card. + type: Option + default: null + term-of-service-data: + description: | + An optional terms of service data for the onboarding card. + type: Option + default: null + GleanServerKnobsConfiguration: + description: A configuration object for Glean server knobs. + fields: + event_threshold: + description: The threshold of events that will be buffered before an events ping is collected and submitted. + type: Option + default: null + metrics_enabled: + description: A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric. + type: Map + default: {} + pings_enabled: + description: A map of ping names to booleans representing the state of the 'enabled' flag for that ping. + type: Map + default: {} + MarketingData: + description: An object to describe the marketing data onboarding card. + fields: + body-line-one-link-text: + description: The link text from line one of the body. + type: Text + default: '' + body-line-one-text: + description: The text for line one of the body. + type: Text + default: '' + body-line-two-text: + description: The text for line two of the body. + type: Text + default: '' + MessageData: + description: | + An object to describe a message. It uses human readable strings to describe the triggers, action and style of the message as well as the text of the message and call to action. + fields: + action: + description: | + A URL of a page or a deeplink. This may have substitution variables in. + type: ActionName + default: OPEN_URL + action-params: + description: | + A string map containing query parameters that will be appended to the action URL. This is useful for opening URLs in tabs, or specifying that the tab should be private. The values may have substitutions, e.g. "url": "https://example.com/id={uuid}", "private": "true". + The params and their values are all determined downstream of the messaging component, by the embedding app's deeplink processing machinery. + type: Map + default: {} + button-label: + description: | + The text on the button. If no text is present, the whole message is clickable. + type: Option + default: null + exclude-if-any: + description: | + A list of strings corresponding to targeting expressions. The message will not be shown if any of the expressions are `true`. + type: List + default: [] + experiment: + description: The slug of the experiment that this message came from. + type: Option + default: null + is-control: + description: Indicates if this message is the control message, if true shouldn't be displayed + type: Boolean + default: false + microsurvey-config: + description: Optional configuration data for a microsurvey. + type: Option + default: null + style: + description: | + The style as described in a `StyleData` from the styles table. + type: StyleName + default: DEFAULT + surface: + description: The surface identifier for this message. + type: SurfaceName + default: homescreen + text: + description: The message text displayed to the user + type: Text + default: '' + title: + description: The title text displayed to the user + type: Option + default: null + trigger-if-all: + description: | + A list of strings corresponding to targeting expressions. The message will be shown if all expressions are `true`. + type: List + default: [] + MicrosurveyAnswer: + description: Attributes relating to microsurvey content. + fields: + ordering: + description: | + Used 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. + 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: null + utm-content: + description: Optional "utm_content" parameter for the privacy notice URL to specify the feature being surveyed. + type: Option + default: null + NotificationConfig: + description: Attributes controlling the global configuration of notification messages. + fields: + refresh-interval: + description: | + How often, in minutes, the notification message worker will wake up and check for new messages. + type: Int + default: 240 + OnboardingCardData: + description: An object to describe a user facing onboarding card. + fields: + body: + description: The message text displayed to the user. May contain linkable text. + type: Text + default: '' + card-type: + description: The type of the card. + type: OnboardingCardType + default: default-browser + disqualifiers: + description: | + A list of strings corresponding to targeting expressions. The card will not be shown if any expression is `true`. + type: List + default: + - NEVER + enabled: + description: If true, this card is shown to the user. + type: Boolean + default: true + extra-data: + description: Optional extra data for cards that require additional data. + type: Option + default: null + image-res: + description: The resource id of the image to be displayed. + type: Image + default: ic_onboarding_welcome + ordering: + description: Used to sequence the cards. + type: Int + default: 0 + prerequisites: + description: | + A list of strings corresponding to targeting expressions. The card will be shown if all expressions are `true` and if no expressions in the `disqualifiers` table are true, or if the `disqualifiers` table is empty. + type: List + default: + - ALWAYS + primary-button-label: + description: The text to display on the primary button. + type: Text + default: '' + secondary-button-label: + description: The text to display on the secondary button. + type: Text + default: '' + title: + description: The title text displayed to the user. + type: Text + default: '' + StyleData: + description: | + A group of properties (predominantly visual) to describe the style of the message. + fields: + max-display-count: + description: | + How many sessions will this message be shown to the user before it is expired. + type: Int + default: 5 + priority: + description: | + The importance of this message. 0 is not very important, 100 is very important. + type: Int + default: 50 + TermsOfServiceData: + description: An object to describe the terms of service onboarding card. + fields: + line-one-link-text: + description: The text for the link of line one. + type: Text + default: '' + line-one-link-url: + description: The url for the link of line one. + type: Text + default: '' + line-one-text: + description: The text for line one. + type: Text + default: '' + line-three-link-text: + description: The text for the link of line three. + type: Text + default: '' + line-three-text: + description: The text for line three. + type: Text + default: '' + line-two-link-text: + description: The text for the link of line two. + type: Text + default: '' + line-two-link-url: + description: The url for the link of line two. + type: Text + default: '' + line-two-text: + description: The text for line two. + type: Text + default: '' + subheader-one-text: + description: Optional text for the first subheader of the card. + type: Option + default: null + subheader-three-text: + description: Optional text for the third subheader of the card. + type: Option + default: null + subheader-two-text: + description: Optional text for the second subheader of the card. + type: Option + default: null diff --git a/experimenter/experimenter/features/manifests/fenix/v145.0.0/release.fml.yaml b/experimenter/experimenter/features/manifests/fenix/v145.0.0/release.fml.yaml new file mode 100644 index 0000000000..5486a32b00 --- /dev/null +++ b/experimenter/experimenter/features/manifests/fenix/v145.0.0/release.fml.yaml @@ -0,0 +1,1469 @@ +version: 1.0.0 +about: + description: Nimbus Feature Manifest for Fenix (Firefox Android) +channels: +- release +features: + address-sync: + description: Turns on address sync. + variables: + enabled: + description: | + Whether or not to turn on address sync. + type: Boolean + default: false + alternative-app-launcher-icon: + description: A feature that changes the app launcher icon background color. + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + reset-to-default: + description: | + If true use the default icon, if false use the alternative icon. This is required to 'reset' the icon for enrolled users once the initial experiment is complete. + type: Boolean + default: false + app-icon-selection: + description: Allows the user to set an alternative app launcher icon. + variables: + enabled: + description: Whether or not the feature is available for the user. + 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. + type: Map + default: + amp: true + ampMobile: false + wikipedia: true + baseline-fpp: + description: Control Baseline Fingerprinting Protection + variables: + enabled: + description: Enables / disables baseline fingerprinting protection. + type: Boolean + default: true + feat-enabled: + description: If true, the feature is active. + type: Boolean + default: false + overrides: + description: The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. + type: String + default: '' + bookmarks: + description: Feature for Bookmarks + variables: + new-compose-ui: + description: if true, enable new compose based UI + type: Boolean + default: false + composable-toolbar: + description: Use a composable toolbar instead of the View based one. + variables: + enabled: + description: | + When the feature is enabled the user will see a new composable toolbar instead the previous View based one. + 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 + custom-review-prompt: + description: Feature that controls the Play store in-app custom review prompt. + variables: + enabled: + description: Whether or not to enable the custom review prompt. + type: Boolean + default: false + doh: + description: Feature controlling DNS over HTTPS (DoH). + variables: + autoselect-enabled: + description: | + Controls the network.android_doh.autoselect_enabled pref and automatically chooses a DoH provider when Default Protection mode is selected. + type: Boolean + default: false + show-ui: + description: | + When `true`, include DoH settings in the settings UI. + type: Boolean + default: true + encourage-search-cfr: + description: A feature that shows a CFR on first launch to encourage users to make a search + variables: + cfrText: + description: The text to show in the CFR + type: Text + default: '' + enabled: + description: When true, the CFR will show + type: Boolean + default: false + fingerprinting-protection: + description: Control Fingerprinting Protection + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + enabled-normal: + description: | + Enables / disables fingerprinting protection in normal browsing mode. + type: Boolean + default: false + enabled-private: + description: | + Enables / disables fingerprinting protection in private browsing mode. + type: Boolean + default: true + fdlibm-math: + description: | + Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy + type: Boolean + default: false + overrides: + description: | + The protection overrides to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string. + type: String + default: '' + fission: + description: The feature that controls whether fission is enabled or not in Gecko. + variables: + enabled: + description: | + Whether or not to enable fission. Fission is enabled when set to true. Fission is disabled when set to false. + type: Boolean + default: false + fx-suggest: + description: A feature that provides Firefox Suggest search suggestions. + variables: + boost-amp-wiki: + description: | + The feature boost wiki and AMP suggestions to the top of its group. + type: Boolean + default: false + enabled: + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. + type: Boolean + default: false + glean: + description: A feature that provides server-side configurations for Glean metrics (aka Server Knobs). + variables: + delay-ping-lifetime-io: + description: Glean will delay io for ping lifetime metrics + type: Boolean + default: true + enable-event-timestamps: + description: Enables precise event timestamps for Glean events + type: Boolean + default: true + gleanMetricConfiguration: + description: Configuration for Glean Server Knobs + type: GleanServerKnobsConfiguration + default: + event_threshold: null + metrics_enabled: {} + pings_enabled: {} + ping-lifetime-max-time: + description: After what time to auto-flush + type: Int + default: 2000 + ping-lifetime-threshold: + description: Write count threshold when to auto-flush + type: Int + default: 1000 + allow-coenrollment: true + growth-data: + description: A feature measuring campaign growth data + variables: + enabled: + description: If true, the feature is active + type: Boolean + default: true + homepage-as-new-tab: + description: Enables homepage as a a new tab. + variables: + enabled: + description: | + Whether or not to enable homepage as a new tab + type: Boolean + default: false + homepage-hide-frecent-top-sites: + description: Hides frecent top sites on the homepage. + variables: + enabled: + description: | + Whether or not to hide frecent top sites on the homepage. + type: Boolean + default: false + homepage-search-bar: + description: Enables the homepage search bar. + variables: + enabled: + description: | + Whether or not to enable the homepage search bar. + 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: + header: true + top-sites: true + jump-back-in: true + bookmarks: true + recent-explorations: true + pocket: true + pocket-sponsored-stories: true + synced-tabs: true + collections: true + isolated-content-processes: + description: Feature that controls content process isolation. + variables: + enabled: + description: | + Whether or not to enable isolated content processes. + type: Boolean + default: false + javascript: + description: Enables Javascript Engine (Spidermonkey) features + variables: + parallelMarkingEnabled: + description: | + Enables or disables javascript.options.mem.gc_parallel_marking preference. + type: Boolean + default: false + juno-onboarding: + description: A feature that shows the onboarding flow. + variables: + cards: + description: Collection of user facing onboarding cards. + type: Map + default: + terms-of-service: + body: onboarding_terms_of_service_sub_header_2 + card-type: terms-of-service + disqualifiers: + - NEVER + enabled: true + extra-data: + term-of-service-data: + line-one-text: onboarding_term_of_service_line_one_2 + line-one-link-text: onboarding_term_of_service_line_one_link_text_2 + line-two-text: onboarding_term_of_service_line_two_2 + line-two-link-text: onboarding_term_of_service_line_two_link_text + line-three-text: onboarding_term_of_service_line_three + line-three-link-text: onboarding_term_of_service_line_three_link_text + image-res: ic_firefox + ordering: 1 + prerequisites: + - ALWAYS + primary-button-label: onboarding_term_of_service_agree_and_continue_button_label_2 + secondary-button-label: '' + title: onboarding_welcome_to_firefox + default-browser: + body: juno_onboarding_default_browser_description_nimbus_3 + card-type: default-browser + disqualifiers: + - NEVER + enabled: true + extra-data: null + 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: + body: juno_onboarding_add_search_widget_description + card-type: add-search-widget + disqualifiers: + - NEVER + enabled: true + extra-data: null + 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: + body: juno_onboarding_sign_in_description_3 + card-type: sync-sign-in + disqualifiers: + - NEVER + enabled: true + extra-data: null + 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: + body: juno_onboarding_enable_notifications_description_nimbus_2 + card-type: notification-permission + disqualifiers: + - NEVER + enabled: true + extra-data: null + 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 + theme-selection: + body: onboarding_customize_theme_description + card-type: theme-selection + disqualifiers: + - NEVER + enabled: true + extra-data: + customization-theme-data: + - theme-type: theme-system + label: onboarding_customize_theme_system_option + image-res: ic_pick_a_theme_system_auto + - theme-type: theme-light + label: onboarding_customize_theme_light_option + image-res: ic_pick_a_theme_light + - theme-type: theme-dark + label: onboarding_customize_theme_dark_option + image-res: ic_pick_a_theme_dark + image-res: ic_pick_a_theme + ordering: 33 + prerequisites: + - ALWAYS + primary-button-label: onboarding_save_and_continue_button + secondary-button-label: '' + title: onboarding_customize_theme_title + toolbar-placement: + body: onboarding_customize_toolbar_description + card-type: toolbar-placement + disqualifiers: + - NEVER + enabled: true + extra-data: + customization-toolbar-data: + - toolbar-type: toolbar-top + label: onboarding_customize_toolbar_top_option + image-res: ic_onboarding_top_toolbar + - toolbar-type: toolbar-bottom + label: onboarding_customize_toolbar_bottom_option + image-res: ic_onboarding_bottom_toolbar + image-res: ic_onboarding_customize_toolbar + ordering: 37 + prerequisites: + - ALWAYS + primary-button-label: onboarding_save_and_continue_button + secondary-button-label: '' + title: onboarding_customize_toolbar_title + marketing: + body: onboarding_marketing_body + card-type: marketing-data + disqualifiers: + - NEVER + enabled: true + extra-data: + marketing-data: + body-line-one-text: onboarding_marketing_learn_more + body-line-one-link-text: onboarding_marketing_learn_more + body-line-two-text: onboarding_marketing_opt_out_checkbox + image-res: ic_onboarding_welcome + ordering: 40 + prerequisites: + - ALWAYS + primary-button-label: onboarding_marketing_positive_button + secondary-button-label: '' + title: onboarding_marketing_title + string-alias: OnboardingCardKey + conditions: + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + string-alias: ConditionName + use-onboarding-redesign: + description: If true, use the onboarding redesign. + type: Boolean + default: false + lna-blocking: + description: Feature that allows blocking local network or device access. + variables: + enabled: + description: | + Whether or not to turn on local network / device access blocking + type: Boolean + default: false + menu-redesign: + description: Control the new menu redesign. + variables: + enabled: + description: If true, the new menu redesign is available. + type: Boolean + default: false + menu-banner: + description: If true, the menu banner is visible. + type: Boolean + default: true + report-site-issue: + description: If true, report site issue menu item and preview is available. + type: Boolean + default: false + messaging: + description: | + The in-app messaging system. + variables: + $$experiment: + description: The only acceptable value for `MessageData#experiment`. This should not be set by experiment. + type: ExperimentSlug + default: '{experiment}' + string-alias: ExperimentSlug + $$surfaces: + description: | + A list available surfaces for this app. + + This should not be written to by experiments, and should be hidden to users. + type: List + default: + - homescreen + - notification + - survey + - microsurvey + string-alias: SurfaceName + actions: + description: A growable map of action URLs. + type: Map + default: + OPEN_URL: ://open + ENABLE_PRIVATE_BROWSING: ://enable_private_browsing + INSTALL_SEARCH_WIDGET: ://install_search_widget + MAKE_DEFAULT_BROWSER: ://make_default_browser + VIEW_BOOKMARKS: ://urls_bookmarks + VIEW_COLLECTIONS: ://home_collections + VIEW_HISTORY: ://urls_history + VIEW_HOMESCREEN: ://home + OPEN_SETTINGS_ACCESSIBILITY: ://settings_accessibility + OPEN_SETTINGS_ADDON_MANAGER: ://settings_addon_manager + OPEN_SETTINGS_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: null + messages: + description: A growable collection of messages + type: Map + default: + default-browser: + title: default_browser_experiment_card_title + text: default_browser_experiment_card_text + surface: homescreen + action: MAKE_DEFAULT_BROWSER + trigger-if-all: + - USER_ESTABLISHED_INSTALL + - ANDROID_API_BELOW_29 + exclude-if-any: + - I_AM_DEFAULT_BROWSER + style: PERSISTENT + button-label: preferences_set_as_default_browser + default-browser-notification: + title: nimbus_notification_default_browser_title + text: nimbus_notification_default_browser_text + surface: notification + style: NOTIFICATION + trigger-if-all: + - DAY_3_AFTER_INSTALL + exclude-if-any: + - I_AM_DEFAULT_BROWSER + action: MAKE_DEFAULT_BROWSER + string-alias: MessageKey + notification-config: + description: Configuration of the notification worker for all notification messages. + type: NotificationConfig + default: + refresh-interval: 240 + on-control: + description: What should be displayed when a control message is selected. + type: ControlMessageBehavior + default: show-next-message + styles: + description: | + A map of styles to configure message appearance. + type: Map + default: + DEFAULT: + priority: 50 + max-display-count: 5 + SURVEY: + priority: 55 + max-display-count: 1 + PERSISTENT: + priority: 50 + max-display-count: 20 + WARNING: + priority: 60 + max-display-count: 10 + URGENT: + priority: 100 + max-display-count: 10 + NOTIFICATION: + priority: 50 + max-display-count: 1 + MICROSURVEY: + priority: 50 + max-display-count: 5 + string-alias: StyleName + triggers: + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + type: Map + default: + USER_ESTABLISHED_INSTALL: number_of_app_launches >=4 + ANDROID_API_BELOW_29: android_version < 29 + USER_RECENTLY_INSTALLED: days_since_install < 7 + USER_RECENTLY_UPDATED: days_since_update < 7 && days_since_install != days_since_update + USER_TIER_ONE_COUNTRY: ('US' in locale || 'GB' in locale || 'CA' in locale || 'DE' in locale || 'FR' in locale) + USER_EN_SPEAKER: '''en'' in locale' + USER_ES_SPEAKER: '''es'' in locale' + USER_DE_SPEAKER: '''de'' in locale' + USER_FR_SPEAKER: '''fr'' in locale' + DEVICE_ANDROID: os == 'Android' + DEVICE_IOS: os == 'iOS' + ALWAYS: 'true' + NEVER: 'false' + DAY_1_AFTER_INSTALL: days_since_install == 1 + DAY_2_AFTER_INSTALL: days_since_install == 2 + DAY_3_AFTER_INSTALL: days_since_install == 3 + DAY_4_AFTER_INSTALL: days_since_install == 4 + DAY_5_AFTER_INSTALL: days_since_install == 5 + MORE_THAN_24H_SINCE_INSTALLED_OR_UPDATED: days_since_update >= 1 + I_AM_DEFAULT_BROWSER: is_default_browser + I_AM_NOT_DEFAULT_BROWSER: is_default_browser == false + 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. + type: Boolean + default: false + 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: + wallpapers-selection-tool: 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. + type: Boolean + default: false + networking: + description: Enables networking features + variables: + fetchPriorityEnabled: + description: | + Enables or disables network.fetchpriority.enabled preference. + type: Boolean + default: true + networkingBannedPorts: + description: Networking (Necko) Banned Ports + variables: + bannedPortList: + description: A comma-separated list of ports that Firefox will refuse to connect to. These ports will be appended to nsIOService gBadPortList + type: String + default: '' + nimbus-is-ready: + description: | + A feature that provides the number of Nimbus is_ready events to send when Nimbus finishes launching. + variables: + event-count: + description: The number of events that should be sent. + type: Int + default: 1 + nimbus-system: + description: | + Configuration of the Nimbus System in Android. + variables: + refresh-interval-foreground: + description: | + The minimum interval in minutes between fetching experiment + recipes in the foreground. + type: Int + default: 60 + nimbus-validation: + description: A feature that does not correspond to an application feature suitable for showing that Nimbus is working. This should never be used in production. + variables: + settings-icon: + description: The drawable displayed in the app menu for Settings + type: String + default: mozac_ic_settings + settings-punctuation: + description: The emoji displayed in the Settings screen title. + type: String + default: '' + settings-title: + description: The title of displayed in the Settings screen and app menu. + type: Text + default: browser_menu_settings + 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 + override-user-specified-homepage-sections: + description: Whether to ignore the user-specified homepage section visibility settings and hide the options in the settings. + variables: + enabled: + description: | + When true, ignore the user-specified homepage section visibility settings, and hide the toggle options in the settings. + type: Boolean + default: false + pdfjs: + description: PDF.js features + variables: + download-button: + description: Download button + type: Boolean + default: true + open-in-app-button: + description: Open in app button + type: Boolean + default: true + pki: + description: Certificate verification configuration + variables: + certificateTransparencyMode: + description: | + What mode Certificate Transparency is in (0=disable, 1=telemetry only, 2=enforce). + type: Int + default: 0 + pqcrypto: + description: Control the use of post-quantum key exchange mechanisms in TLS and HTTP/3. + variables: + postQuantumKeyExchangeEnabled: + description: | + Toggles the security.tls.enable_kyber and network.http.http3.enable_kyber preferences. + type: Option + default: null + 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-lock: + description: Allows enabling and disabling the private browsing mode lock via an authentication screen. + variables: + enabled: + description: | + Whether or not to enable private browsing mode lock. + type: Boolean + default: true + 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 + recent-searches: + description: Enables recent searches. + variables: + enabled: + description: | + Whether or not to enable recent searches. + type: Boolean + default: true + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 5 + remote-search-configuration: + description: Feature to use search configurations from remote servers. + variables: + enabled: + description: | + Uses search configuration from remote servers . + type: Boolean + default: true + remote-tab-management: + description: | + Features that let users manage tabs on other devices that are connected to the same Mozilla account. + variables: + close-tabs-enabled: + description: | + Whether the feature to close synced tabs is enabled. When enabled, this device will allow other devices to close tabs that are open on this device, and show a "close" button for tabs that are currently open on other supported devices in the synced tabs tray. + type: Boolean + default: true + same-document-navigation-overrides-load-type: + description: Control whether the same document navigation overrides the load type. + variables: + enabled: + description: | + Overrides the loadType when it is a same document navigation + type: Boolean + default: true + force-disable-uri: + description: | + Disable overriding the loadType during same document navigation on the domain specified by this URI. + type: String + default: '' + search-extra-params: + description: A feature that provides additional args for search. + variables: + channel-id: + description: The channel Id param name with arg. + type: Map + default: {} + enabled: + description: If true, the feature is active. + type: Boolean + default: false + feature-enabler: + description: The feature enabler param name with arg, NOTE this map could be empty. + type: Map + default: {} + search-engine: + description: The search engine name. + type: String + default: '' + search-suggestions-on-homepage: + description: Enables search suggestions on homepage. + variables: + enabled: + description: | + Whether or not to enable search suggestions on homepage. + type: Boolean + default: false + 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 + sent-from-firefox: + description: A feature that allows the user to add a download firefox footer to a shared link. + variables: + download-link: + description: A store download link. + type: Text + default: '' + enabled: + description: If true, the feature is available for the user. + type: Boolean + default: false + show-snackbar: + description: If true, the user will see the snackbar after sharing a link, allowing quick navigation to settings. + type: Boolean + default: false + template-message: + description: A template for the shared message, supporting three placeholders. A shared link, the brand name and a store download link. + type: Text + default: '' + setup-checklist: + description: A feature on the home page that allows the user to track onboarding setup progress. + variables: + enabled: + description: If true, the setup checklist will be enabled. + type: Boolean + default: false + setup-checklist-type: + description: The collection used for the setup checklist. + type: SetupChecklistType + default: collection-1 + 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. + type: Boolean + default: true + splash-screen: + description: A feature that extends splash screen duration, allowing additional data fetching time for the app's initial run. + variables: + enabled: + description: If true, the feature is active. + type: Boolean + default: false + maximum_duration_ms: + description: The maximum amount of time in milliseconds the splashscreen will be visible while waiting for initialization calls to complete. + type: Int + default: 0 + off-train-onboarding: + description: If true, the fetched data will be applied and used during the session. + type: Boolean + default: false + suggest-shipped-domains: + description: Feature that suggests domains from the shipped domain list. + variables: + enabled: + description: | + Suggest domains from the shipped domain list. + type: Boolean + default: false + suppress-sponsored-top-sites: + description: Suppress sponsored top sites for new users for 14 days. + variables: + enabled: + description: If true, new users won’t see sponsored tiles for 14 days. + type: Boolean + default: false + tab-management-enhancements: + description: Control the visibility of the tab management enhancements. + variables: + enabled: + description: | + Whether or not to enable the tab management enhancements. + type: Boolean + default: false + tab-strip: + description: Enables tab strip. + variables: + allow-on-all-devices: + description: | + Experimental: When true, bypasses device restrictions and enables use on all devices. May cause instability or unexpected behavior. This still requires the feature to be `enabled`. + type: Boolean + default: false + enabled: + description: | + Whether or not to enable tab strip. + type: Boolean + default: false + terms-of-use-prompt: + description: Enables the terms of use prompt for users who have not accepted ToU + variables: + enabled: + description: When the feature is enabled then the prompt can show for users. + 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. + type: Boolean + default: false + enabled-private: + description: | + Enables / disables third-party cookie blocking in private browsing mode. + type: Boolean + default: true + toolbar-redesign-option: + description: Control the visibility of toolbar redesign option in settings. + variables: + show-expanded-customization: + description: | + Whether or not the expanded toolbar customization option is visible to the user. + type: Boolean + default: false + show-options: + description: | + Whether or not the toolbar redesign option is visible to the user. This allows the user to switch between simple and expanded toolbar. + type: Boolean + default: false + show-simple-customization: + description: | + Whether or not the simple toolbar customization option is visible to the user. + type: Boolean + default: false + top-sites-suggestions: + description: Enables top sites suggestions. + variables: + enabled: + description: | + Whether or not to enable top sites suggestions. + type: Boolean + default: true + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 2 + translations: + description: The feature that allows on-device translations of web content. + variables: + downloads-enabled: + description: | + Show the global language model download options entry point for translations. ('Download languages' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-lang-settings-enabled: + description: | + Show the global language options entry point for automatically translating. ('Automatic Translation' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-settings-enabled: + description: | + Show the global settings entry point within the translations feature. ('Translation Settings' on the page settings view.) 'page-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + global-site-settings-enabled: + description: | + Show the global never translate this site options entry point for site management. ('Never translate these sites' on the global settings view.) 'global-settings-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + main-flow-browser-menu-enabled: + description: | + Show the browser menu entry point into the translations feature. ('Translate Page' on browser menu.) + type: Boolean + default: true + main-flow-toolbar-enabled: + description: | + Show the primary toolbar entry point into the translations feature. (Translations icon on URL toolbar.) + type: Boolean + default: true + page-settings-enabled: + description: | + Show the page settings entry point within the translations feature. (Gear icon on the translations main flow page.) 'main-flow-toolbar-enabled' or 'main-flow-browser-menu-enabled' must also be enabled for users to access this feature. + type: Boolean + default: true + trending-searches: + description: Enables trending searches. + variables: + enabled: + description: | + Whether or not to enable trending searches. + type: Boolean + default: true + max-suggestions: + description: The number of maximum suggestions. + type: Int + default: 5 + unified-trust-panel: + description: Enables the unified trust panel. + variables: + enabled: + description: | + Whether or not to enable the unified trust panel. + 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. + collections: + description: The collections section of the homepage. + header: + description: The header of the homescreen. + 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 + synced-tabs: + description: The synced tabs section of the homepage. + top-sites: + description: The frecency and pinned sites. + MR2022Section: + description: The identifiers for the sections of the MR 2022. + variants: + 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-search-widget: + description: Allows user to add search widget to homescreen. + default-browser: + description: Allows user to set Firefox as the default browser. + marketing-data: + description: Allows user to opt out of marketing data collection. + notification-permission: + description: Allows user to enable notification permission. + sync-sign-in: + description: Allows user to sync with a Firefox account. + terms-of-service: + description: Page to display the terms of services. + theme-selection: + description: Allows user to choose between dark and light themes. + toolbar-placement: + description: Allows user to choose the toolbar position. + OnboardingPanel: + description: The types of onboarding panels in the onboarding page + variants: + privacy-notice: + description: The onboarding panel where users can tap to view our privacy notice. + sync: + description: The onboarding panel where users can sign in to sync + tcp: + description: The onboarding panel where users can choose their total cookie protection settings + themes: + description: The themes onboarding panel where users pick themes + toolbar-placement: + description: The onboarding panel where users choose their toolbar placement (bottom or top) + QueryParameterStrippingSection: + description: The identifiers for the options for the Query Parameter Stripping feature. + variants: + query-parameter-stripping: + description: An integer either 0 or 1 indicating if query parameter stripping should be enabled or disabled in normal mode. 0 for setting to be disabled, and 1 for enabling the setting. + query-parameter-stripping-allow-list: + description: An string separated by commas indicating the sites where should from query stripping should be exempted. + query-parameter-stripping-pmb: + description: An integer either 0 or 1 indicating if query parameter stripping should be enabled or disabled in private mode. 0 for setting to be disabled, and 1 for enabling the setting. + query-parameter-stripping-strip-list: + description: An string separated by commas indicating the list of query params to be stripped from URIs. This list will be merged with records coming from RemoteSettings. + SetupChecklistType: + description: An enum to represent the different experiment branches for the setup checklist. + variants: + collection-1: + description: The collection for the setup checklist that has 3 items. + collection-2: + description: The collection for the setup checklist that has 6 items. + SuggestionType: + description: The type of a Firefox Suggest search suggestion. + variants: + amp: + description: A Firefox Suggestion from adMarketplace. + ampMobile: + description: A firefox Suggestion from adMarketplace specifically for mobile. + wikipedia: + description: A Firefox Suggestion for a Wikipedia page. + ThemeType: + description: An enum to describe a theme selection option. + variants: + theme-dark: + description: Sets the theme to dark mode. + theme-light: + description: Sets the theme to light mode. + theme-system: + description: Adapts the theme to match the device's system setting. + ToolbarType: + description: An enum to describe a toolbar placement option. + variants: + toolbar-bottom: + description: Sets the toolbar placement on the bottom. + toolbar-top: + description: Sets the toolbar placement on the top. +objects: + CustomizationThemeData: + description: Defines an option for theme selection. + fields: + image-res: + description: The resource id of the image to be displayed. + type: Image + default: ic_pick_a_theme_system_auto + label: + description: Display text for the theme option (e.g., "Light Theme"). + type: Text + default: '' + theme-type: + description: The type of the theming option. + type: ThemeType + default: theme-system + CustomizationToolbarData: + description: An object to describe the placement of the toolbar. + fields: + image-res: + description: The resource id of toolbar placement image. + type: Image + default: ic_onboarding_customize_toolbar + label: + description: Display text for the toolbar placement option (e.g. "Top placement"). + type: Text + default: '' + toolbar-type: + description: The type of toolbar placement. + type: ToolbarType + default: toolbar-top + ExtraCardData: + description: Holds data for cards that require additional data, e.g. toolbar placement cards. + fields: + customization-theme-data: + description: An optional list of theme choices for the theme selection card. + type: List + default: [] + customization-toolbar-data: + description: | + An optional list of toolbar placements for the toolbar placement card. + type: List + default: [] + marketing-data: + description: | + An optional marketing data for the onboarding card. + type: Option + default: null + term-of-service-data: + description: | + An optional terms of service data for the onboarding card. + type: Option + default: null + GleanServerKnobsConfiguration: + description: A configuration object for Glean server knobs. + fields: + event_threshold: + description: The threshold of events that will be buffered before an events ping is collected and submitted. + type: Option + default: null + metrics_enabled: + description: A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric. + type: Map + default: {} + pings_enabled: + description: A map of ping names to booleans representing the state of the 'enabled' flag for that ping. + type: Map + default: {} + MarketingData: + description: An object to describe the marketing data onboarding card. + fields: + body-line-one-link-text: + description: The link text from line one of the body. + type: Text + default: '' + body-line-one-text: + description: The text for line one of the body. + type: Text + default: '' + body-line-two-text: + description: The text for line two of the body. + type: Text + default: '' + MessageData: + description: | + An object to describe a message. It uses human readable strings to describe the triggers, action and style of the message as well as the text of the message and call to action. + fields: + action: + description: | + A URL of a page or a deeplink. This may have substitution variables in. + type: ActionName + default: OPEN_URL + action-params: + description: | + A string map containing query parameters that will be appended to the action URL. This is useful for opening URLs in tabs, or specifying that the tab should be private. The values may have substitutions, e.g. "url": "https://example.com/id={uuid}", "private": "true". + The params and their values are all determined downstream of the messaging component, by the embedding app's deeplink processing machinery. + type: Map + default: {} + button-label: + description: | + The text on the button. If no text is present, the whole message is clickable. + type: Option + default: null + exclude-if-any: + description: | + A list of strings corresponding to targeting expressions. The message will not be shown if any of the expressions are `true`. + type: List + default: [] + experiment: + description: The slug of the experiment that this message came from. + type: Option + default: null + is-control: + description: Indicates if this message is the control message, if true shouldn't be displayed + type: Boolean + default: false + microsurvey-config: + description: Optional configuration data for a microsurvey. + type: Option + default: null + style: + description: | + The style as described in a `StyleData` from the styles table. + type: StyleName + default: DEFAULT + surface: + description: The surface identifier for this message. + type: SurfaceName + default: homescreen + text: + description: The message text displayed to the user + type: Text + default: '' + title: + description: The title text displayed to the user + type: Option + default: null + trigger-if-all: + description: | + A list of strings corresponding to targeting expressions. The message will be shown if all expressions are `true`. + type: List + default: [] + MicrosurveyAnswer: + description: Attributes relating to microsurvey content. + fields: + ordering: + description: | + Used 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. + 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: null + utm-content: + description: Optional "utm_content" parameter for the privacy notice URL to specify the feature being surveyed. + type: Option + default: null + NotificationConfig: + description: Attributes controlling the global configuration of notification messages. + fields: + refresh-interval: + description: | + How often, in minutes, the notification message worker will wake up and check for new messages. + type: Int + default: 240 + OnboardingCardData: + description: An object to describe a user facing onboarding card. + fields: + body: + description: The message text displayed to the user. May contain linkable text. + type: Text + default: '' + card-type: + description: The type of the card. + type: OnboardingCardType + default: default-browser + disqualifiers: + description: | + A list of strings corresponding to targeting expressions. The card will not be shown if any expression is `true`. + type: List + default: + - NEVER + enabled: + description: If true, this card is shown to the user. + type: Boolean + default: true + extra-data: + description: Optional extra data for cards that require additional data. + type: Option + default: null + image-res: + description: The resource id of the image to be displayed. + type: Image + default: ic_onboarding_welcome + ordering: + description: Used to sequence the cards. + type: Int + default: 0 + prerequisites: + description: | + A list of strings corresponding to targeting expressions. The card will be shown if all expressions are `true` and if no expressions in the `disqualifiers` table are true, or if the `disqualifiers` table is empty. + type: List + default: + - ALWAYS + primary-button-label: + description: The text to display on the primary button. + type: Text + default: '' + secondary-button-label: + description: The text to display on the secondary button. + type: Text + default: '' + title: + description: The title text displayed to the user. + type: Text + default: '' + StyleData: + description: | + A group of properties (predominantly visual) to describe the style of the message. + fields: + max-display-count: + description: | + How many sessions will this message be shown to the user before it is expired. + type: Int + default: 5 + priority: + description: | + The importance of this message. 0 is not very important, 100 is very important. + type: Int + default: 50 + TermsOfServiceData: + description: An object to describe the terms of service onboarding card. + fields: + line-one-link-text: + description: The text for the link of line one. + type: Text + default: '' + line-one-link-url: + description: The url for the link of line one. + type: Text + default: '' + line-one-text: + description: The text for line one. + type: Text + default: '' + line-three-link-text: + description: The text for the link of line three. + type: Text + default: '' + line-three-text: + description: The text for line three. + type: Text + default: '' + line-two-link-text: + description: The text for the link of line two. + type: Text + default: '' + line-two-link-url: + description: The url for the link of line two. + type: Text + default: '' + line-two-text: + description: The text for line two. + type: Text + default: '' + subheader-one-text: + description: Optional text for the first subheader of the card. + type: Option + default: null + subheader-three-text: + description: Optional text for the third subheader of the card. + type: Option + default: null + subheader-two-text: + description: Optional text for the second subheader of the card. + type: Option + default: null diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/.ref-cache.yaml b/experimenter/experimenter/features/manifests/firefox-desktop/.ref-cache.yaml index 48a312e44b..5349e8cebb 100644 --- a/experimenter/experimenter/features/manifests/firefox-desktop/.ref-cache.yaml +++ b/experimenter/experimenter/features/manifests/firefox-desktop/.ref-cache.yaml @@ -1,6 +1,6 @@ -beta: 3833fef2d756639ad1f7c84f358f9fcd5d1f46d1 -esr115: f0a190f56593ea37a7eb1ff927fecc52d6517b68 +beta: b0157af119c144738009983f42341d0c30c0120c +esr115: 11d3f8d0ce23a16fce6cbebc2912be969cb18a46 esr128: ed38f9209e39bd7ad247c81a7c20c99c874e0a62 -esr140: 2ea021b9473a0690d1cfafc5fa12b901a27fe43a -main: 16f979184458f531fce47706d2fa7f2902e75ad3 +esr140: 786cf32bb679d6c0f2f37491cf0698d3153c6451 +main: 1be6d6ec044e795342b20d31f01d82a4e8070ff3 release: d5c80ed4452060187727f00a12568df547813979 diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/v115.29.0/experimenter.yaml b/experimenter/experimenter/features/manifests/firefox-desktop/v115.29.0/experimenter.yaml new file mode 100644 index 0000000000..68bd6bd2a7 --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v115.29.0/experimenter.yaml @@ -0,0 +1,1568 @@ +# 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/. + +# 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: barret@mozilla.com + applications: + - firefox-desktop + - firefox-desktop-background-task + hasExposure: false + variables: {} + +testFeature: + description: Test only feature + owner: barret@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: 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: barret@mozilla.com + hasExposure: false + variables: + value: + type: string + setPref: 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: barret@mozilla.com + isEarlyStartup: true + hasExposure: false + variables: + value: + type: string + setPref: nimbus.qa.pref-2 + description: The value to set for the pref. + +# `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. + cbhStudyUs: + type: string + setPref: browser.search.param.google_channel_us + description: >- + NOTE: Please use `extraParams` rather than this field. + A string pref set by Nimbus tests for US search cohort + cbhStudyRow: + type: string + setPref: browser.search.param.google_channel_row + description: >- + NOTE: Please use `extraParams` rather than this field. + A string pref set by Nimbus tests for Rest of World (ROW) search cohort + richSuggestionsFeatureGate: + type: boolean + setPref: browser.urlbar.richSuggestions.featureGate + description: >- + Feature gate that controls whether Rich Suggestions are enabled. + serpEventTelemetryEnabled: + type: boolean + setPref: browser.search.serpEventTelemetry.enabled + description: Whether the Glean SERP event telemetry is enabled. + +# `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. + addonsUITreatment: + type: string + enum: + - a + - b + description: >- + Define the UI type for addon suggestions. + In case of "a", display rating stars and review volume on the bottom of + the suggestion. In case of "b", display a label explaining that the + addon suggestion is a recommendation. + 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. + bestMatchBlockingEnabled: + type: boolean + fallbackPref: browser.urlbar.bestMatch.blockingEnabled + description: Whether best match Suggest suggestions can be blocked. + bestMatchEnabled: + type: boolean + fallbackPref: browser.urlbar.bestMatch.enabled + description: Gate for the best match feature. If false, the best match preferences UI and best match suggestions will not be shown. If true, the preferences UI will be shown, and the user can turn best match suggestions on or off. + 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 "modal", the event will be recorded when the user first triggers to show the onbording dialog. If empty, the event will be recorded when the user first triggers any type of Suggest suggestion. + enum: + - best-match + - modal + - "" + isBestMatchExperiment: + type: boolean + description: >- + Whether the experiment (or rollout) is related to best match. If true, 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). Deprecated, please use `experimentType: "best-match"` instead. + 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. + merinoEnabled: + type: boolean + fallbackPref: browser.urlbar.merino.enabled + description: Whether Merino is enabled as a quick suggest source + merinoEndpointURL: + type: string + fallbackPref: browser.urlbar.merino.endpointURL + description: The Merino endpoint URL, not including parameters. + 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: browser.urlbar.exposureResults + description: >- + Comma-separated list of result type combinations, that are used to determine if an exposure event should be fired. + showExposureResults: + type: boolean + setPref: browser.urlbar.showExposureResults + 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. + quickSuggestAllowPositionInSuggestions: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.allowPositionInSuggestions + description: Whether quick suggest results can be shown in position specified in the suggestions. + quickSuggestBlockingEnabled: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.blockingEnabled + description: Whether the usual non-best-match Suggest suggestions can be blocked. + 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. + 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. + 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. + quickSuggestRemoteSettingsDataType: + type: string + description: The `type` of the suggestions data in remote settings. If not specified, "data" is used. + quickSuggestRemoteSettingsEnabled: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.remoteSettings.enabled + description: Whether Remote Settings is enabled as a quick suggest source + quickSuggestScenario: + # IMPORTANT: This should not have a fallbackPref. See UrlbarPrefs.jsm. + type: string + description: The Firefox Suggest scenario in which the user is enrolled + enum: + - history + - offline + - online + 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 QuickSuggest results within the general group. A + negative index is relative to the end of the group + 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. See also `weatherKeywords` and + `weatherKeywordsMinimumLength`. In summary: To enable the weather + suggestion, set `weatherFeatureGate` to true, `weatherKeywords` to an + array of full keyword strings, and `weatherKeywordsMinimumLength` to a + non-zero integer. To disable the weather suggestion, leave out all + weather-related variables. + weatherKeywords: + type: json + description: >- + An array of full keyword strings that will trigger the weather + suggestion when the user types them in the address bar. If absent or + null, Firefox will fall back to the weather keywords defined in remote + settings. If neither Nimbus nor remote settings defines any keywords, + the weather suggestion will be disabled. See also + `weatherKeywordsMinimumLength`. + 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. See also + `weatherKeywords`. + 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. + +frecency: + description: "The address bar ranking algorithm" + owner: search-and-suggest-program@mozilla.com + hasExposure: false + isEarlyStartup: true + variables: + 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: "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: "places.frecency.origins.alternative.daysCutOff" + +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 + +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. + +abouthomecache: + description: "The startup about:home cache." + owner: omc@mozilla.com + hasExposure: false + isEarlyStartup: true + variables: + enabled: + type: boolean + fallbackPref: browser.startup.homepage.abouthome_cache.enabled + description: Is the feature 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 + +pocketNewtab: + description: The Pocket section in newtab + owner: sdowne@getpocket.com + hasExposure: false + isEarlyStartup: true + variables: + spocPositions: + type: string + fallbackPref: browser.newtabpage.activity-stream.discoverystream.spoc-positions + description: CSV string of spoc position indexes on newtab Pocket grid + spocTopsitesPositions: + type: string + fallbackPref: browser.newtabpage.activity-stream.discoverystream.spoc-topsites-positions + description: CSV string of spoc 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. + 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. + 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. + spocsCacheTimeout: + type: int + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.spocs.cacheTimeout + description: >- + Set sponsored content cache timeout in minutes. + discoveryStreamConfig: + description: A JSON blob of discovery stream configuration. + type: string + setPref: "browser.newtabpage.activity-stream.discoverystream.config" + spocsEndpoint: + description: The URL for the spocs endpoint. + type: string + setPref: "browser.newtabpage.activity-stream.discoverystream.spocs-endpoint" + 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. + 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 + 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 + +saveToPocket: + description: The save to Pocket feature + owner: sdowne@getpocket.com + hasExposure: false + isEarlyStartup: true + variables: + enabled: + type: boolean + setPref: "extensions.pocket.enabled" + description: Enabled save to Pocket feature. + emailButton: + type: boolean + fallbackPref: extensions.pocket.refresh.emailButton.enabled + description: Just for the new Pocket panels, enables the email signup button. + hideRecentSaves: + type: boolean + fallbackPref: extensions.pocket.refresh.hideRecentSaves.enabled + description: Hides the recently saved section in the home panel. + bffRecentSaves: + type: boolean + fallbackPref: "extensions.pocket.bffRecentSaves" + description: Use the new BFF Proxy Service instead of the legacy Pocket Service for Recent Saves + bffApi: + type: string + fallbackPref: "extensions.pocket.bffApi" + description: BFF Proxy Service domain + oAuthConsumerKeyBff: + type: string + fallbackPref: "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? + +shellService: + description: "Interface with OS, e.g., pinning and set default" + owner: desktop-integrations@mozilla.com + hasExposure: false + isEarlyStartup: true + variables: + disablePin: + type: boolean + description: Disable pin to taskbar feature + setDefaultBrowserUserChoice: + type: boolean + fallbackPref: browser.shell.setDefaultBrowserUserChoice + description: Should it set as default browser + 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. + +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? + +readerMode: + description: Firefox Reader Mode + owner: sdowne@getpocket.com + hasExposure: false + isEarlyStartup: true + variables: + pocketCTAVersion: + type: string + fallbackPref: reader.pocket.ctaVersion + description: >- + What version of Pocket CTA to show in Reader Mode (Empty string is no + CTA) +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." + isEarlyStartup: false + schema: + uri: "resource://activity-stream/schemas/MessagingExperiment.schema.json" + path: "browser/components/newtab/content-src/asrouter/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." + isEarlyStartup: false + schema: + uri: "resource://activity-stream/schemas/MessagingExperiment.schema.json" + path: "browser/components/newtab/content-src/asrouter/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." + isEarlyStartup: false + schema: + uri: "resource://activity-stream/schemas/MessagingExperiment.schema.json" + path: "browser/components/newtab/content-src/asrouter/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." + isEarlyStartup: false + schema: + uri: "resource://activity-stream/schemas/MessagingExperiment.schema.json" + path: "browser/components/newtab/content-src/asrouter/schemas/MessagingExperiment.schema.json" + variables: {} + +# More info about the fx-message-* feature id prototype is available at: +# https://docs.google.com/document/d/1KdtaNycZL5j240nXofbibm9yKh7qVvu1-uZFLdmYM7Y/ +# +# Before each Nightly leaves the station for Beta, we're currently +# experimenting with ensuring that we have enough fx-messages-* messages to +# accomodate all the rollout possibilities for Release that we're aware of, +# plus one for a buffer just-in-case. +# +# When adding an fxms-message-* feature id, be sure to also add it to the +# MESSAGING_EXPERIMENTS_DEFAULT_FEATURES list in ASRouter. + +# currently in use by 107+ exp/rollout pair of Import Bookmarks Infrequent +# Existing Users with 5 bookmarks: +# https://experimenter.services.mozilla.com/nimbus/import-infrequent-rollout-make-yourself-at-home/summary +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." + isEarlyStartup: false + schema: + uri: "resource://activity-stream/schemas/MessagingExperiment.schema.json" + path: "browser/components/newtab/content-src/asrouter/schemas/MessagingExperiment.schema.json" + variables: {} + +# next planned use: 110+ exp/rollout pair of Fox Doodle: Pin experiment winner +# (Existing Users) +# More info about the fx-message-* feature id prototype is available at: +# https://docs.google.com/document/d/1KdtaNycZL5j240nXofbibm9yKh7qVvu1-uZFLdmYM7Y/ +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." + isEarlyStartup: false + schema: + uri: "resource://activity-stream/schemas/MessagingExperiment.schema.json" + path: "browser/components/newtab/content-src/asrouter/schemas/MessagingExperiment.schema.json" + variables: {} + +# next planned use: 110+ exp/rollout pair of Fox Doodle: Set Default (Existing +# Users) +# More info about the fx-message-* feature id prototype is available at: +# https://docs.google.com/document/d/1KdtaNycZL5j240nXofbibm9yKh7qVvu1-uZFLdmYM7Y/ +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." + isEarlyStartup: false + schema: + uri: "resource://activity-stream/schemas/MessagingExperiment.schema.json" + path: "browser/components/newtab/content-src/asrouter/schemas/MessagingExperiment.schema.json" + variables: {} + +# next potential planned use: 111+ exp/rollout pair for PDF annotations callout +# (https://mozilla-hub.atlassian.net/browse/FXE-83) experiment. +# +# More info about the fx-message-* feature id prototype is available at: +# https://docs.google.com/document/d/1KdtaNycZL5j240nXofbibm9yKh7qVvu1-uZFLdmYM7Y/ +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." + isEarlyStartup: false + schema: + uri: "resource://activity-stream/schemas/MessagingExperiment.schema.json" + path: "browser/components/newtab/content-src/asrouter/schemas/MessagingExperiment.schema.json" + variables: {} + +# next potential planned use: 112+ holdback/rollout pair for default PDF handler +# (https://mozilla-hub.atlassian.net/browse/FXE-91) experiment. +# +# More info about the fx-message-* feature id prototype is available at: +# https://docs.google.com/document/d/1KdtaNycZL5j240nXofbibm9yKh7qVvu1-uZFLdmYM7Y/ +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." + isEarlyStartup: false + schema: + uri: "resource://activity-stream/schemas/MessagingExperiment.schema.json" + path: "browser/components/newtab/content-src/asrouter/schemas/MessagingExperiment.schema.json" + variables: {} + +# next potential planned use: 114+ possible holdback/rollout pair (Device Migration): +# https://mozilla-hub.atlassian.net/browse/FXE-271 +# +# More info about the fx-message-* feature id prototype is available at: +# https://docs.google.com/document/d/1KdtaNycZL5j240nXofbibm9yKh7qVvu1-uZFLdmYM7Y/ +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." + isEarlyStartup: false + schema: + uri: "resource://activity-stream/schemas/MessagingExperiment.schema.json" + path: "browser/components/newtab/content-src/asrouter/schemas/MessagingExperiment.schema.json" + variables: {} + +# next planned use: buffer, for the unexpected +# +# More info about the fx-message-* feature id prototype is available at: +# https://docs.google.com/document/d/1KdtaNycZL5j240nXofbibm9yKh7qVvu1-uZFLdmYM7Y/ +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." + isEarlyStartup: false + schema: + uri: "resource://activity-stream/schemas/MessagingExperiment.schema.json" + path: "browser/components/newtab/content-src/asrouter/schemas/MessagingExperiment.schema.json" + variables: {} + + +# next planned use: buffer, for the unexpected +# +# More info about the fx-message-* feature id prototype is available at: +# https://docs.google.com/document/d/1KdtaNycZL5j240nXofbibm9yKh7qVvu1-uZFLdmYM7Y/ +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." + isEarlyStartup: false + schema: + uri: "resource://activity-stream/schemas/MessagingExperiment.schema.json" + path: "browser/components/newtab/content-src/asrouter/schemas/MessagingExperiment.schema.json" + variables: {} + +# next planned use: buffer, for the unexpected +# +# More info about the fx-message-* feature id prototype is available at: +# https://docs.google.com/document/d/1KdtaNycZL5j240nXofbibm9yKh7qVvu1-uZFLdmYM7Y/ +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." + isEarlyStartup: false + schema: + uri: "resource://activity-stream/schemas/MessagingExperiment.schema.json" + path: "browser/components/newtab/content-src/asrouter/schemas/MessagingExperiment.schema.json" + variables: {} + +# next planned use: buffer, for the unexpected +# +# More info about the fx-message-* feature id prototype is available at: +# https://docs.google.com/document/d/1KdtaNycZL5j240nXofbibm9yKh7qVvu1-uZFLdmYM7Y/ +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." + isEarlyStartup: false + schema: + uri: "resource://activity-stream/schemas/MessagingExperiment.schema.json" + path: "browser/components/newtab/content-src/asrouter/schemas/MessagingExperiment.schema.json" + variables: {} + +# next planned use: buffer, for the unexpected +# +# More info about the fx-message-* feature id prototype is available at: +# https://docs.google.com/document/d/1KdtaNycZL5j240nXofbibm9yKh7qVvu1-uZFLdmYM7Y/ +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." + isEarlyStartup: false + schema: + uri: "resource://activity-stream/schemas/MessagingExperiment.schema.json" + path: "browser/components/newtab/content-src/asrouter/schemas/MessagingExperiment.schema.json" + variables: {} + +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. + isEarlyStartup: false + schema: + uri: "resource://activity-stream/schemas/MessagingExperiment.schema.json" + path: "browser/components/newtab/content-src/asrouter/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. + isEarlyStartup: false + schema: + uri: "resource://activity-stream/schemas/BackgroundTaskMessagingExperiment.schema.json" + path: "browser/components/newtab/content-src/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json" + variables: {} + +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 collection SDK within Firefox Desktop" + owner: glean-team@mozilla.com + hasExposure: false + variables: + finalInactive: + type: "boolean" + description: "Enables FOG early shutdown pings when true" + 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 'disabled' flag for that metric" + +majorRelease2022: + description: Major Release 2022 + owner: firefoxview@mozilla.com + hasExposure: false + isEarlyStartup: true + variables: + feltPrivacyPBMDarkTheme: + type: boolean + fallbackPref: "browser.theme.dark-private-windows" + description: "Use dark theme variant for PBM windows. This is only supported if the theme sets darkTheme data." + feltPrivacyPBMNewIndicator: + type: boolean + fallbackPref: "browser.privatebrowsing.enable-new-indicator" + description: "Enables the new private browsing indicator." + feltPrivacyPBMNewLogo: + type: boolean + fallbackPref: "browser.privatebrowsing.enable-new-logo" + description: "Enables the new about:privatebrowsing logo." + feltPrivacyShowPreferencesSection: + type: boolean + fallbackPref: "browser.privacySegmentation.preferences.show" + description: "Controls visibility of the privacy segmentation preferences section." + feltPrivacyWindowSeparation: + type: boolean + fallbackPref: "browser.privateWindowSeparation.enabled" + description: "Whether or not private browsing windows use a separate icon in the Windows taskbar" + colorwayCloset: + type: boolean + fallbackPref: "browser.theme.colorway-closet" + description: "Whether or not to show the colorway closet modal" + firefoxView: + type: boolean + fallbackPref: "browser.tabs.firefox-view" + description: "Whether or not to show the firefox view tab" + onboarding: + type: boolean + fallbackPref: "browser.majorrelease.onboarding" + description: "Whether or not to use the MR2022 onboarding settings." + +featureCallout: + description: "Prefs that control users' progress through Feature Callout tours" + owner: omc@mozilla.com + hasExposure: false + isEarlyStartup: false + variables: + pdfJsTourProgress: + description: A JSON String representing the intitial state of the pref that holds the progress of the PDF.js feature tour. + type: string + setPref: "browser.pdfjs.feature-tour" +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: "browser.lowMemoryResponseMask" + lowMemoryResponseOnWarn: + description: Controls which macOS memory-pressure levels trigger the browser low memory response. + type: boolean + setPref: "browser.lowMemoryResponseOnWarn" + tabsUnloadOnLowMemory: + description: Whether to unload tabs when available memory is running low. + type: boolean + setPref: "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: "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: "network.dns.echconfig.enabled" + h3Enabled: + description: Whether to enable ECH for connections using H3/QUIC + type: boolean + setPref: "network.dns.http3_echconfig.enabled" + forceWaitHttpsRR: + description: Whether to force waiting for HTTPS DNS records, which ECH requires. + type: boolean + setPref: "network.dns.force_waiting_https_rr" + insecureFallback: + description: Whether to fallback to non-ECH connections if all ECH RRs fail. + type: boolean + setPref: "network.dns.echconfig.fallback_to_origin_when_all_failed" + tlsGreaseProb: + description: Probability of GREASEing a TLS connection with ECH (0-100). + type: int + setPref: "security.tls.ech.grease_probability" + h3GreaseEnabled: + description: Whether to apply GREASE settings to H3/QUIC connections. + type: boolean + setPref: "security.tls.ech.grease_http3" + disableGreaseOnFallback: + description: Whether to disable GREASE when retrying a connection. + type: boolean + setPref: "security.tls.ech.disable_grease_on_fallback" + greasePaddingSize: + description: Assumed echConfig padding length for GREASE extensions (1-255). + type: int + setPref: "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: "network.trr.mode" + trrUri: + description: The URL of the DNS over HTTPS endpoint + type: string + setPref: "network.trr.uri" + dohMode: + description: Same as trrMode, but set by the DoHController module. + type: int + setPref: "doh-rollout.mode" + dohUri: + description: Same as trrUri, but set by the DoHController module. + type: string + setPref: "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: "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: "network.trr_ui.show_fallback_warning_option" + +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: "network.trr.use_ohttp" + ohttpRelayUri: + description: The URL of the Oblivious HTTP relay + type: string + setPref: "network.trr.ohttp.relay_uri" + ohttpConfigUri: + description: The URL used to fetch the configuration of the Oblivious HTTP gateway + type: string + setPref: "network.trr.ohttp.config_uri" + ohttpUri: + description: The URL of the Oblivious DNS over HTTPS target resource + type: string + setPref: "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: "network.early-hints.enabled" + ehPreconnectEnabled: + description: Whether Early Hints preconnect is enabled + type: boolean + setPref: "network.early-hints.preconnect.enabled" + +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 + isEarlyStartup: true # Data is sent on startup with a trigger in BrowserGlue.sys.mjs + variables: + enabled: + type: boolean + fallbackPref: toolkit.telemetry.dap_enabled + description: Whether to automatically send DAP measurements. + task1Enabled: + type: boolean + fallbackPref: toolkit.telemetry.dap_task1_enabled + description: Whether to send fake measurements for verification task 1. + +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: "privacy.annotate_channels.strict_list.pbmode.enabled" + +fxaButtonVisibility: + description: Prefs to control the visibility of the Firefox Accounts toolbar button when not signed in. + owner: mconley@mozilla.com + hasExposure: false + isEarlyStartup: true + variables: + boolean: + description: True if the Firefox Accounts toolbar button should be visible when not signed in. + type: boolean + setPref: identity.fxaccounts.toolbar.defaultVisible + +legacyHeartbeat: + description: Normandy Heartbeat exposed to Nimbus + owner: barret@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: privacy.query_stripping.enabled + description: Enables / disables URL query string stripping in normal browsing mode. + enabledPrivateBrowsing: + type: boolean + setPref: privacy.query_stripping.enabled.pbmode + description: Enables / disables URL query string stripping in private browsing mode. + allowList: + type: string + setPref: 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: 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: layout.css.font-visibility.trackingprotection + description: Set the Font Visibility level when Enhanced Tracking Protection is enabled + enabledStandard: + type: int + setPref: layout.css.font-visibility.standard + description: Set the Font Visibility level for normal browsing + enabledPBM: + type: int + setPref: 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: privacy.fingerprintingProtection + description: Enables / disables fingerprinting protection in normal browsing mode. + enabledPrivate: + type: boolean + setPref: privacy.fingerprintingProtection.pbmode + description: Enables / disables fingerprinting protection in private browsing mode. + overrides: + type: string + setPref: privacy.fingerprintingProtection.overrides + description: >- + The protection overrides to add or remove fingerprinting protection + targets. Please check RFPTargets.inc for all supported targets. + +migrationWizard: + description: Prefs to control the Migration Wizard UI. + owner: mconley@mozilla.com + hasExposure: false + isEarlyStartup: true + variables: + useNewWizard: + description: True if the new migration wizard should be used. + type: boolean + setPref: browser.migrate.content-modal.enabled + 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: 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: 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. + + "legacy": + The legacy wizard will be opened from about:welcome, even if + the new wizard is enabled by default. + + "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: browser.migrate.content-modal.about-welcome-behavior + +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: + boolean: + description: True if the mixed content upgrading pref is enabled + type: boolean + setPref: security.mixed_content.upgrade_display_content + +jsParallelParsing: + description: Pref to toggle JS parallel parsing. + owner: dpalmeiro@mozilla.com, nbp@mozilla.com + isEarlyStartup: true + hasExposure: false + variables: + enabled: + description: True to enable parallel parsing. + type: boolean + setPref: "javascript.options.parallel_parsing" + +gcParallelMarking: + description: Pref to toggle parallel marking in the GC. + owner: dpalmeiro@mozilla.com, jonco@mozilla.com + isEarlyStartup: true + hasExposure: false + variables: + enabled: + description: True to enable parallel marking. + type: boolean + setPref: "javascript.options.mem.gc_parallel_marking" + +jitThresholds: + description: Prefs that control jit tier thresholds. + owner: dpalmeiro@mozilla.com, jdemooij@mozilla.com + isEarlyStartup: true + hasExposure: false + variables: + blinterp_threshold: + description: Set the threshold to enable blinterp compilation. + type: int + setPref: "javascript.options.blinterp.threshold" + baseline_threshold: + description: Set the threshold to enable baseline compilation. + type: int + setPref: "javascript.options.baselinejit.threshold" + ion_threshold: + description: Set the threshold to enable ion compilation. + type: int + setPref: "javascript.options.ion.threshold" + ion_bailout_threshold: + description: Set the ion frequent bailout threshold. + type: int + setPref: "javascript.options.ion.frequent_bailout_threshold" + ion_offthread_compilation: + description: True to enable offthread ion compilations. + type: boolean + setPref: "javascript.options.ion.offthread_compilation" + inlining_max_length: + description: Set the max bytecode length considered for inlining. + type: int + setPref: "javascript.options.inlining_bytecode_max_length" + +jitHintsCache: + description: Pref to toggle the JIT hints cache. + owner: dpalmeiro@mozilla.com + isEarlyStartup: true + hasExposure: false + variables: + enabled: + description: True to enable the hints cache. + type: boolean + setPref: "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: "network.http.rcwn.enabled" + +httpSpeculativeParallelLimit: + description: Prefs to control the http speculative parallel limit. + owner: dpalmeiro@mozilla.com, acreskey@mozilla.com + hasExposure: false + variables: + speculative_parallel_limit: + description: Maximum number of parallel speculative connections. + type: int + setPref: "network.http.speculative-parallel-limit" + +deviceMigration: + description: Prefs to control aspects of the new device migration experiment + owner: hjones@mozilla.com + hasExposure: false + isEarlyStartup: true + variables: + helpMenuHidden: + description: True if new help menu item should be hidden + type: boolean + fallbackPref: browser.device-migration.help-menu.hidden + +opaqueResponseBlocking: + description: Prefs to enable Opaque Response Blocking + owner: farre@mozilla.com + isEarlyStartup: true + hasExposure: true + exposureDescription: Exposure is sent when a response is blocked + variables: + enabled: + description: Whether ORB is enabled + type: boolean + setPref: "browser.opaqueResponseBlocking" + javascriptValidator: + description: Whether JavaScript validation for ORB is enabled + type: boolean + setPref: "browser.opaqueResponseBlocking.javascriptValidator" + filterFetchResponse: + description: Whether filtering of internal responses in the parent ORB is enabled + type: int + setPref: "browser.opaqueResponseBlocking.filterFetchResponse" + mediaExceptionsStrategy: + description: >- + If we partially or wholly allow audio and video MIME types in conflict with spec. + type: int + setPref: "browser.opaqueResponseBlocking.mediaExceptionsStrategy" \ No newline at end of file diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/v115.29.0/schemas/browser/components/newtab/content-src/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v115.29.0/schemas/browser/components/newtab/content-src/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json new file mode 100644 index 0000000000..109a9d6cd1 --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v115.29.0/schemas/browser/components/newtab/content-src/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json @@ -0,0 +1,312 @@ +{ + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "resource://activity-stream/schemas/BackgroundTaskMessagingExperiment.schema.json", + "title": "Messaging Experiment", + "description": "A Firefox Messaging System message.", + "if": { + "type": "object", + "properties": { + "template": { + "const": "multi" + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "resource://activity-stream/schemas/BackgroundTaskMessagingExperiment.schema.json#/$defs/MultiMessage" + }, + "else": { + "$ref": "resource://activity-stream/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": "resource://activity-stream/schemas/BackgroundTaskMessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "title": { + "$ref": "resource://activity-stream/schemas/BackgroundTaskMessagingExperiment.schema.json#/$defs/localizableText", + "description": "Id of localized string or message override of toast notification title" + }, + "body": { + "$ref": "resource://activity-stream/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" + }, + "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": "resource://activity-stream/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`." + } + }, + "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": "resource://activity-stream/schemas/BackgroundTaskMessagingExperiment.schema.json#/$defs/localizedText" + } + ] + }, + "TemplatedMessage": { + "description": "An FxMS message of one of a variety of types.", + "type": "object", + "allOf": [ + { + "$ref": "resource://activity-stream/schemas/BackgroundTaskMessagingExperiment.schema.json#/$defs/Message" + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "toast_notification" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "resource://activity-stream/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": "resource://activity-stream/schemas/BackgroundTaskMessagingExperiment.schema.json#/$defs/TemplatedMessage" + } + } + }, + "required": [ + "template", + "messages" + ] + } + } +} diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/v115.29.0/schemas/browser/components/newtab/content-src/asrouter/schemas/MessagingExperiment.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v115.29.0/schemas/browser/components/newtab/content-src/asrouter/schemas/MessagingExperiment.schema.json new file mode 100644 index 0000000000..abd36cf6cf --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v115.29.0/schemas/browser/components/newtab/content-src/asrouter/schemas/MessagingExperiment.schema.json @@ -0,0 +1,1640 @@ +{ + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "resource://activity-stream/schemas/MessagingExperiment.schema.json", + "title": "Messaging Experiment", + "description": "A Firefox Messaging System message.", + "if": { + "type": "object", + "properties": { + "template": { + "const": "multi" + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/MultiMessage" + }, + "else": { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/TemplatedMessage" + }, + "$defs": { + "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": "resource://activity-stream/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": "resource://activity-stream/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": "resource://activity-stream/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": "resource://activity-stream/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": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "Text for button tooltip used to provide information about the doorhanger." + } + }, + "required": [ + "tooltiptext" + ] + } + }, + "required": [ + "attributes" + ] + }, + { + "$ref": "resource://activity-stream/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": "resource://activity-stream/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": "resource://activity-stream/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": "resource://activity-stream/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": "resource://activity-stream/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.jsm", + "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": "resource://activity-stream/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": "resource://activity-stream/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": "resource://activity-stream/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" + } + } + }, + "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": "resource://activity-stream/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" + ] + }, + "ProtectionsPanelMessage": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///ProtectionsPanelMessage.schema.json", + "title": "ProtectionsPanelMessage", + "description": "A message shown in the protections panel.", + "allOf": [ + { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "title": { + "description": "The message title.", + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/localizableText" + }, + "body": { + "description": "The body of the message.", + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/localizableText" + }, + "link_text": { + "description": "The text of the call to action link.", + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/localizableText" + }, + "cta_type": { + "description": "The type of URL open action.", + "type": "string", + "enum": [ + "OPEN_URL", + "OPEN_PROTECTION_REPORT", + "OPEN_ABOUT_PAGE" + ] + }, + "cta_url": { + "description": "The URL to open when the call to action is clicked", + "type": "string", + "format": "moz-url-format" + }, + "cta_where": { + "description": "How to open the cta.", + "type": "string", + "enum": [ + "current", + "tabshifted", + "tab", + "save", + "window" + ] + } + }, + "dependantSchemas": { + "link_text": [ + "cta_type", + "cta_url" + ], + "cta_type": [ + "link_text" + ], + "cta_url": [ + "link_text" + ], + "cta_where": [ + "link_text" + ] + }, + "additionalProperties": false, + "required": [ + "title", + "body" + ] + }, + "template": { + "type": "string", + "const": "protections_panel" + }, + "trigger": { + "description": "An action to trigger potentially showing the message. The action ID `protectionsPanelOpen` is required.", + "const": { + "id": "protectionsPanelOpen" + } + } + }, + "required": [ + "content", + "template", + "trigger" + ], + "additionalProperties": true + }, + "Spotlight": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///Spotlight.schema.json", + "title": "Spotlight", + "description": "A template with an image, title, content and two buttons.", + "allOf": [ + { + "$ref": "resource://activity-stream/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" + } + }, + "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": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "title": { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "Id of localized string or message override of toast notification title" + }, + "body": { + "$ref": "resource://activity-stream/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" + }, + "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": "resource://activity-stream/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`." + } + }, + "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": "resource://activity-stream/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": "resource://activity-stream/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": "resource://activity-stream/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" + ] + }, + "WhatsNewMessage": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///WhatsNewMessage.schema.json", + "title": "WhatsNewMessage", + "description": "A template for the messages that appear in the What's New panel.", + "allOf": [ + { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "layout": { + "description": "Different message layouts", + "enum": [ + "tracking-protections" + ] + }, + "bucket_id": { + "type": "string", + "description": "A bucket identifier for the addon. This is used in order to anonymize telemetry for history-sensitive targeting." + }, + "published_date": { + "type": "integer", + "description": "The date/time (number of milliseconds elapsed since January 1, 1970 00:00:00 UTC) the message was published." + }, + "title": { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "Id of localized string or message override of What's New message title" + }, + "subtitle": { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "Id of localized string or message override of What's New message subtitle" + }, + "body": { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "Id of localized string or message override of What's New message body" + }, + "link_text": { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "(optional) Id of localized string or message override of What's New message link text" + }, + "cta_url": { + "description": "Target URL for the What's New message.", + "type": "string", + "format": "moz-url-format" + }, + "cta_type": { + "description": "Type of url open action", + "enum": [ + "OPEN_URL", + "OPEN_ABOUT_PAGE", + "OPEN_PROTECTION_REPORT" + ] + }, + "cta_where": { + "description": "How to open the cta: new window, tab, focused, unfocused.", + "enum": [ + "current", + "tabshifted", + "tab", + "save", + "window" + ] + }, + "icon_url": { + "description": "(optional) URL for the What's New message icon.", + "type": "string", + "format": "uri" + }, + "icon_alt": { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "Alt text for image." + } + }, + "additionalProperties": true, + "required": [ + "published_date", + "title", + "body", + "cta_url", + "bucket_id" + ] + }, + "template": { + "type": "string", + "const": "whatsnew_panel_message" + } + }, + "required": [ + "order" + ], + "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": [ + "cfr_urlbar_chiclet", + "cfr_doorhanger", + "milestone_message", + "infobar", + "pb_newtab", + "protections_panel", + "spotlight", + "feature_callout", + "toast_notification", + "toolbar_badge", + "update_action", + "whatsnew_panel_message" + ] + }, + "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": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/localizedText" + } + ] + }, + "TemplatedMessage": { + "description": "An FxMS message of one of a variety of types.", + "type": "object", + "allOf": [ + { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/Message" + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "cfr_urlbar_chiclet" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/CFRUrlbarChiclet" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "cfr_doorhanger", + "milestone_message" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/ExtensionDoorhanger" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "infobar" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/InfoBar" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "pb_newtab" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/NewtabPromoMessage" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "protections_panel" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/ProtectionsPanelMessage" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "spotlight", + "feature_callout" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/Spotlight" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "toast_notification" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/ToastNotification" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "toolbar_badge" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/ToolbarBadgeMessage" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "update_action" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/UpdateAction" + } + }, + { + "if": { + "type": "object", + "properties": { + "template": { + "type": "string", + "enum": [ + "whatsnew_panel_message" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/WhatsNewMessage" + } + } + ] + }, + "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": "resource://activity-stream/schemas/MessagingExperiment.schema.json#/$defs/TemplatedMessage" + } + } + }, + "required": [ + "template", + "messages" + ] + } + } +} diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/v115.29.0/schemas/toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v115.29.0/schemas/toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json new file mode 100644 index 0000000000..6915fc9b71 --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v115.29.0/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/firefox-desktop/v140.4.0/experimenter.yaml b/experimenter/experimenter/features/manifests/firefox-desktop/v140.4.0/experimenter.yaml new file mode 100644 index 0000000000..0a53df9af8 --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v140.4.0/experimenter.yaml @@ -0,0 +1,4863 @@ +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. + +# yaml-language-server: $schema=schemas/ExperimentFeatureManifest.schema.json + +# Features must be added here to be accessible through the NimbusFeature API. + +"no-feature-firefox-desktop": + description: A dummy feature for experiments that target no feature. + owner: beth@mozilla.com + applications: + - firefox-desktop + - firefox-desktop-background-task + hasExposure: false + allowCoenrollment: true + variables: {} + +testFeature: + description: Test only feature + owner: beth@mozilla.com + applications: + - firefox-desktop + - firefox-desktop-background-task + hasExposure: false + isEarlyStartup: true + variables: + enabled: + type: boolean + description: Whether or not this feature is enabled + testInt: + type: int + fallbackPref: nimbus.testing.testInt + description: Int pref used by platform API tests + testSetString: + type: string + setPref: + branch: user + pref: nimbus.testing.testSetString + description: A string pref set by Nimbus tests + +nimbus-qa-1: + description: A feature for testing pref-setting on the default branch. + owner: beth@mozilla.com + hasExposure: false + variables: + value: + type: string + setPref: + branch: default + pref: nimbus.qa.pref-1 + description: The value to set for the pref. + +nimbus-qa-2: + description: A feature for testing pref-setting on the user branch. + owner: beth@mozilla.com + hasExposure: false + variables: + value: + type: string + setPref: + branch: user + pref: nimbus.qa.pref-2 + description: The value to set for the pref. + +# Note: this feature is not for general use. If you want to run an experiment +# that sets prefs, you *must* register your feature in this manifest and specify +# the prefs you will control. +prefFlips: + description: Flip arbitrary prefs. Controlled by release management. + owner: beth@mozilla.com + hasExposure: false + allowCoenrollment: true + variables: + prefs: + type: json + description: "The prefs to set." + schema: + uri: resource://nimbus/schemas/PrefFlipsFeature.schema.json + path: toolkit/components/nimbus/schemas/PrefFlipsFeature.schema.json + + +search: + description: Search service related features. + owner: search-and-suggest-program@mozilla.com + hasExposure: false + variables: + scotchBonnetEnableOverride: + type: boolean + setPref: + branch: default + pref: browser.urlbar.scotchBonnet.enableOverride + description: >- + Whether or not enabling scotch bonnet feature. + If this variable is true, the following features are available as default. + * Unified search button + * Secondary action buttons + * Search term persistence + * Intuitive search keywords + * HTTP swap + trendingRequireSearchMode: + type: boolean + setPref: + branch: default + pref: browser.urlbar.trending.requireSearchMode + description: Controls whether trending suggestions are only shown in search mode or not. + trendingMaxResultsNoSearchMode: + type: int + setPref: + branch: default + pref: browser.urlbar.trending.maxResultsNoSearchMode + description: The maximum number of trending results mode outside search mode. + targetExperiment: + type: string + description: >- + Recorded in SERP telemetry, this is the slug of the experiment someone + is requesting enrollment and branch information for. (Note that the + featureId needs to be set to "search".) + +searchConfiguration: + description: >- + Search experimentation support for the engine configuration. Some of these + options may cause an additional reload to occur during the startup phase. + owner: search-and-suggest-program@mozilla.com + hasExposure: false + variables: + experiment: + type: string + setPref: + branch: user + pref: browser.search.experiment + description: >- + Used to activate only matching configurations that contain the value in + `experiment` + extraParams: + type: json + description: >- + This allows extra parameters to be set for search engines requests including, + where calls to the suggestions API, the search engine configuration defines + those parameters. + + The use of this field should be coordinated with the Search team. + + The field value is an array of objects with key/value fields. For example: + + [ + {"key": "google_channel_row", "value": "foo"} + ] + + This is matched to a section in the search configuration: + + "params": [ + { + "name": "channel", + "experimentConfig": "google_channel_row" + } + ], + + In this case, the resulting URL for the appropriate search engine would have + `&channel=foo` added to the URL when doing searches. + + If the key is not referenced in the search configuration, then no parameter + will be added. If the parameter is in the search configuration, but there + is no experiment, or the experiment does not set a value, then the + parameter will not be included in the search url. + + Only the search team can update the configuration. + separatePrivateDefaultUIEnabled: + type: boolean + setPref: + branch: user + pref: browser.search.separatePrivateDefault.ui.enabled + description: Whether the UI for the separate private default feature is enabled. + separatePrivateDefaultUrlbarResultEnabled: + type: boolean + setPref: + branch: user + pref: browser.search.separatePrivateDefault.urlbarResult.enabled + description: Whether the urlbar result for the separate private default is shown. + +urlbar: + description: The Address Bar + owner: search-and-suggest-program@mozilla.com + hasExposure: true + exposureDescription: >- + The timing of the exposure event depends on the experiment, but generally + the event is recorded once per app session when the user first encounters + the UI of the experiment in which they're enrolled. + variables: + actionsOnboardingTimesToShow: + type: int + fallbackPref: browser.urlbar.quickactions.timesToShowOnboardingLabel + description: >- + The number of times a user should be shown the actions onboarding label. + addonsFeatureGate: + type: boolean + fallbackPref: browser.urlbar.addons.featureGate + description: >- + Feature gate that controls whether all aspects of the addons suggestion + feature are exposed to the user. + addonsShowLessFrequentlyCap: + type: int + description: >- + If defined and non-zero, this is the maximum number of times the user + will be able to click the "Show less frequently" command for addon + suggestions. If undefined or zero, the user will be able to click the + command without any limit. + ampMatchingStrategy: + type: int + fallbackPref: browser.urlbar.quicksuggest.ampMatchingStrategy + description: >- + The matching strategy for AMP suggestions. Leave undefined or set to + zero to use the usual default exact-keyword strategy. Otherwise set to + an integer value defined on `AmpMatchingStrategy` in + `RustSuggest.sys.mjs` (corresponding to the `AmpMatchingStrategy` enum + in the Rust component coerced to a 1-based integer value). + autoFillAdaptiveHistoryEnabled: + type: boolean + 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. + deduplicationEnabled: + type: boolean + setPref: + pref: browser.urlbar.deduplication.enabled + branch: user + description: >- + Feature gate that controls whether result deduplication in the urlbar + is enabled. + 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. + 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. + quickSuggestContextualOptInFirstReshowAfterPeriodDays: + type: int + setPref: + branch: default + pref: browser.urlbar.quicksuggest.contextualOptIn.firstReshowAfterPeriodDays + description: Period until reshow the Firefox Suggest contextual opt-in result when first dismissed. + quickSuggestContextualOptInSecondReshowAfterPeriodDays: + type: int + setPref: + branch: default + pref: browser.urlbar.quicksuggest.contextualOptIn.secondReshowAfterPeriodDays + description: Period until reshow the Firefox Suggest contextual opt-in result when second dismissed. + quickSuggestContextualOptInThirdReshowAfterPeriodDays: + type: int + setPref: + branch: default + pref: browser.urlbar.quicksuggest.contextualOptIn.thirdReshowAfterPeriodDays + description: Period until reshow the Firefox Suggest contextual opt-in result when third dismissed. + quickSuggestContextualOptInImpressionLimit: + type: int + setPref: + branch: default + pref: browser.urlbar.quicksuggest.contextualOptIn.impressionLimit + description: Limit for impression to dismiss the Firefox Suggest contextual opt-in result. + quickSuggestContextualOptInImpressionDaysLimit: + type: int + setPref: + branch: default + pref: browser.urlbar.quicksuggest.contextualOptIn.impressionDaysLimit + description: Days until dismiss the Firefox Suggest contextual opt-in result after first impression. + 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. + quickSuggestDynamicSuggestionTypes: + type: string + setPref: + pref: browser.urlbar.quicksuggest.dynamicSuggestionTypes + branch: user + description: >- + Comma-separated list of Suggest dynamic suggestion types to enable. Set + this variable to the `suggestion_type` defined in the remote settings + record that contains your suggestions. If you want to enable multiple + suggestion types, separate them with commas. One particular intended use + of this variable is to deliver hidden-exposure suggestions for testing + potential exposures. Hidden-exposure suggestions trigger exposure + telemetry based on a set of keywords you provide but they are never + visible. If you are testing multiple types of hidden-exposure + suggestions, consider using one experiment branch per type, especially + if you are also enabling keyword exposures. Exposure suggestions are + recorded in telemetry with the "rust_exposure" result type. It's not + necessary to include "rust_exposure" in `exposureResults`. Unless you + are testing other results in the same experiment branch, it's also not + necessary to set `showExposureResults: false`. To also record keyword + exposures, include "rust_exposure" in `keywordExposureResults`. + quickSuggestEnabled: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.enabled + description: >- + Gate for the Firefox Suggest feature as a whole. If false, the Firefox + Suggest preferences UI and Suggest suggestions will not be shown. If + true, the preferences UI will be shown, and the user can turn + suggestions on or off. + quickSuggestImpressionCapsSponsoredEnabled: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.impressionCaps.sponsoredEnabled + description: Whether sponsored suggestions are subject to impression frequency caps. If false, sponsored suggestions can be shown an unlimited number of times over any given period. If true, sponsored suggestion impressions will be subject to the caps in the remote settings configuration. + quickSuggestImpressionCapsNonSponsoredEnabled: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.impressionCaps.nonSponsoredEnabled + description: Whether non-sponsored suggestions are subject to impression frequency caps. If false, non-sponsored suggestions can be shown an unlimited number of times over any given period. If true, non-sponsored suggestion impressions will be subject to the caps in the remote settings configuration. + 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 + quickSuggestRankingMode: + type: string + fallbackPref: browser.urlbar.quicksuggest.rankingMode + description: >- + Specify the ranking mode for QuickSuggest. + - "default": ranking by static scores specified by individual providers. + - "interest": ranking by relevance scores provided by `ContentRelevancyManager`. + - "random": ranking by randomly selecting a winner out of candidates. + Note that this ranking mode can still be overridden by `quickSuggestScoreMap`. + If the ranking mode is unspecified or set to any unknown values, it will default + to the static score based ranking. + enum: + - default + - interest + - random + quickSuggestScoreMap: + type: json + description: >- + A JSON object that maps telemetry result types to suggestion scores. If + a telemetry result type is present in this map, the client will use the + corresponding score as the score for all suggestions of the type, + overriding all other sources of scores for the type. In other words, + the scores in this map will override scores that are set in remote + settings and Merino as well as scores that are hardcoded in the client. + Example entries: `"amo": 0.5`, `"adm_sponsored": 0.9` + quickSuggestSettingsUi: + type: int + fallbackPref: browser.urlbar.quicksuggest.settingsUi + description: >- + When Suggest is enabled, this determines the Suggest settings that will + be visible in the settings UI (about:preferences). When Suggest is + disabled, this is ignored and Suggest settings are hidden. Possible + values: + 0: (default) Full, all settings will be shown. + 1: None, no settings will be shown. + 2: Offline only, settings that pertain to online will be hidden. + quickSuggestSponsoredEnabled: + type: boolean + description: Whether sponsored suggestions should be enabled by default. If this variable is specified, it will override the value implied by the scenario. It will never override the user's local preference to disable (or enable) sponsored suggestions, if the user has already toggled that preference. + quickSuggestSponsoredIndex: + type: int + fallbackPref: browser.urlbar.quicksuggest.sponsoredIndex + description: >- + The index of sponsored Firefox Suggest results within the Firefox Suggest + section when "Show search suggestions ahead of browsing history in + address bar results" is checked. When not checked, the index is hardcoded + as -1. Negative indexes are relative to the end of the section. + quickSuggestSponsoredPriority: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.sponsoredPriority + description: >- + Whether or not showing sponsored suggestion as priority. + If this variable is true, the following things are processed. + * "Sponsored" label is shown as the group label. + * Change the suggested index to 1. + * Handle as top pick. + 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. + semanticHistoryEnable: + type: boolean + setPref: + branch: user + pref: places.semanticHistory.featureGate + description: use semanticHistory Search feature. + semanticHistoryCompletionThreshold: + type: string + setPref: + branch: user + pref: places.semanticHistory.completionThreshold + description: >- + Fraction (0.0 – 1.0) of top Places rows that must have embeddings + before semantic-history search is enabled. 0.5 = 50 %. + semanticHistoryDistanceThreshold: + type: string + setPref: + branch: user + pref: places.semanticHistory.distanceThreshold + description: >- + semantic similarity distance threshold (0.0 - 1.0) + defaulted at 0.75. + suggestSemanticHistoryMinLength: + type: int + setPref: + branch: user + pref: browser.urlbar.suggest.semanticHistory.minLength + description: >- + Minimum length of search query when history semantic + search will be enabled. + suggestCalculator: + type: boolean + setPref: + branch: user + pref: browser.urlbar.suggest.calculator + description: >- + Whether or not to show calculator results when a user types a valid + calculation string into the urlbar. + weatherFeatureGate: + type: boolean + fallbackPref: browser.urlbar.weather.featureGate + description: >- + Feature gate that controls whether all aspects of the weather suggestion + feature are exposed to the user. + weatherKeywordsMinimumLength: + type: int + description: >- + If defined and non-zero, the weather suggestion will be triggered by + typing any prefix of a full weather keyword when the prefix is at least + `weatherKeywordsMinimumLength` characters long. If this variable is + absent or zero, Firefox will fall back to the minimum length defined in + remote settings. If neither Nimbus nor remote settings defines a minimum + length, only full keywords will trigger the suggestion. + weatherShowLessFrequentlyCap: + type: int + description: >- + If defined and non-zero, this is the maximum number of times the user + will be able to click the "Show less frequently" command for weather + suggestions. If undefined or zero, the user will be able to click the + command without any limit. + weatherUiTreatment: + type: int + fallbackPref: browser.urlbar.weather.uiTreatment + description: >- + The UI treatment to use for weather suggestions. Possible values: + 0: (default) Simplest UI with current temperature and location + 1: Simpler UI, adds current conditions, high/low, and URL + 2: Full UI, adds forecast + yelpMinKeywordLength: + type: int + description: >- + The minimum prefix length of a Yelp keyword the user must type to + trigger the suggestion. + yelpMlEnabled: + type: boolean + fallbackPref: browser.urlbar.yelp.mlEnabled + description: >- + Whether Yelp suggestions will be served from the Suggest ML backend + instead of Rust. + yelpFeatureGate: + type: boolean + fallbackPref: browser.urlbar.yelp.featureGate + description: >- + Feature gate that controls whether all aspects of the Yelp suggestion + feature are exposed to the user. + yelpServiceResultDistinction: + type: boolean + fallbackPref: browser.urlbar.yelp.serviceResultDistinction + description: >- + Whether to distinguish service type subjects. If true, we show special + titile for the suggestion. + yelpShowLessFrequentlyCap: + type: int + fallbackPref: browser.urlbar.yelp.showLessFrequentlyCap + description: >- + If defined and non-zero, this is the maximum number of times the user + will be able to click the "Show less frequently" command for Yelp + suggestions. If undefined or zero, the user will be able to click the + command without any limit. + yelpSuggestNonPriorityIndex: + type: int + description: >- + The group-relative suggestedIndex of Yelp suggestions within the Firefox + Suggest section. Ignored when `yelpSuggestPriority` is true. + yelpSuggestPriority: + type: boolean + fallbackPref: browser.urlbar.yelp.priority + description: >- + Whether or not showing yelp suggestion as priority. + If this variable is true, the following things are processed. + * Change the suggested index to 1. + * Handle as top pick. + originsAlternativeEnable: + description: >- + Use an alternative ranking algorithm for autofilling origins, that is + mainly domains of Web pages. When the user types the beginning of an + origin, we autofill the whole origin. Whether autofill happens depends + on the ranking algorithm. Bookmarks are always autofilled anyway. + type: boolean + setPref: + branch: user + pref: "places.frecency.origins.alternative.featureGate" + originsDaysCutOff: + description: >- + The alternative ranking algorithm only considers pages visited in the + last N days, where N is controlled by this variable. + type: int + setPref: + branch: user + pref: "places.frecency.origins.alternative.daysCutOff" + pagesAlternativeEnable: + description: >- + Use an alternative ranking algorithm for sorting history and bookmarks + among the urlbar results. + type: boolean + setPref: + branch: user + pref: "places.frecency.pages.alternative.featureGate" + pagesNumSampledVisits: + description: >- + The number of recent visits to sample when calculating the ranking of + a page. Examining all the visits would be expensive, so we only sample + recent visits. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.numSampledVisits" + pagesHalfLifeDays: + description: >- + The number of days after which the ranking halves. This implements the + "recency" part of the algorithm. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.halfLifeDays" + pagesMaxVisitGap: + description: >- + The maximum allowed time (in seconds) between when a visit was recorded + and when an interaction occurs for them to be paired. This accounts + for slight discrepancies in their timestamps. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.interactions.maxVisitGapSeconds" + pagesViewTimeSeconds: + description: >- + The minimum allowed time (in seconds) a page was viewed before upgrading + the score of a visit. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.interactions.viewTimeSeconds" + pageViewTimeIfManyKeypressesSeconds: + description: >- + The minimum allowed time (in seconds) a page was viewed before checking + the manyKeypresses threshold. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.interactions.viewTimeIfManyKeypressesSeconds" + manyKeypresses: + description: >- + The minimum number of keypresses typed before upgrading the score + of a visit. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.interactions.manyKeypresses" + pagesVeryHighWeight: + description: >- + The weight to use for the very high importance bucket. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.veryHighWeight" + pagesHighWeight: + description: >- + The weight to use for the high importance bucket. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.highWeight" + pagesMediumWeight: + description: >- + The weight to use for the medium importance bucket. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.mediumWeight" + pagesLowWeight: + description: >- + The weight to use for the low importance bucket. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.lowWeight" + +aboutwelcome: + description: "The about:welcome page" + owner: omc@mozilla.com + hasExposure: true + exposureDescription: >- + Exposure is sent once per browsing session when the about:welcome URL is + first accessed. + isEarlyStartup: true + variables: + enabled: + type: boolean + fallbackPref: browser.aboutwelcome.enabled + description: >- + Should users see about:welcome? If this is false, users will see a + regular new tab instead. + id: + type: string + description: >- + Descriptive ID for the about:welcome content + screens: + type: json + fallbackPref: browser.aboutwelcome.screens + description: Content to show in the onboarding flow + languageMismatchEnabled: + type: boolean + fallbackPref: intl.multilingual.aboutWelcome.languageMismatchEnabled + description: >- + Suggest to change the language on about:welcome when there is a mismatch with + the OS. + transitions: + type: boolean + description: Enable transition effect between screens + backdrop: + type: string + fallbackPref: browser.aboutwelcome.backdrop + description: >- + Specify the color to be used to update the background color + toolbarButtonEnabled: + type: boolean + setPref: + branch: user + pref: browser.aboutwelcome.toolbarButtonEnabled + description: >- + Should the return to about:welcome toolbar button be shown + +preonboarding: + description: "A modal that shows on first startup, typically on top of about:welcome" + owner: omc@mozilla.com + # Exposure is recorded by the spotlight feature used to show the modal + hasExposure: false + # Needed at `sessionstore-windows-restored`. + isEarlyStartup: true + variables: + enabled: + type: boolean + fallbackPref: browser.preonboarding.enabled + description: >- + Should users see the preonboarding modal? + screens: + type: json + fallbackPref: browser.preonboarding.screens + description: Content to show in the onboarding flow + requireAction: + type: boolean + fallbackPref: browser.preonboarding.requireAction + description: >- + When showModal is enabled, should action be required to proceed (show as a window modal with dismiss using the ESC key disabled)? + currentPolicyVersion: + type: int + fallbackPref: datareporting.policy.currentPolicyVersion + description: >- + The current policy version displayed by this preonboarding modal. + minimumPolicyVersion: + type: int + fallbackPref: datareporting.policy.minimumPolicyVersion + description: >- + The minimum policy version which the user must have accepted to not see the preonboarding modal. + firstRunURL: + type: string + fallbackPref: datareporting.policy.firstRunURL + description: >- + URL of browser tab to be opened on first run instead of infobar. + +moreFromMozilla: + description: "New page on about:preferences to suggest more Mozilla products" + owner: omc@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 + +newtabMobileDownloadPromotion: + description: Cross-sell promotion to download Firefox for mobile + owner: mcrawford@mozilla.com + hasExposure: false + variables: + showModal: + type: boolean + description: Display mobile download modal to users until dismissed + setPref: + branch: user + pref: browser.newtabpage.activity-stream.mobileDownloadModal.enabled + variantA: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.mobileDownloadModal.variant-a + description: >- + Variant A modal message and QR code. + variantB: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.mobileDownloadModal.variant-b + description: >- + Variant B modal message and QR code. + variantC: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.mobileDownloadModal.variant-c + description: >- + Variant C modal message and QR code. + +newtabUnifiedAds: + description: Mozilla Ad Routing Service (MARS) unified ads service + owner: mcrawford@mozilla.com, sdowne@mozilla.com + hasExposure: false + variables: + unifiedAdsEndpoint: + description: The URL for the MARS API endpoint. + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.unifiedAds.endpoint + unifiedAdsSpocsEnabled: + type: boolean + description: >- + Enable MARS endpoint to serve ads for recommended stories + setPref: + branch: user + pref: browser.newtabpage.activity-stream.unifiedAds.spocs.enabled + unifiedAdsTilesEnabled: + type: boolean + description: >- + Enable MARS endpoint to serve content for top sites tiles + setPref: + branch: user + pref: browser.newtabpage.activity-stream.unifiedAds.tiles.enabled + unifiedAdsFeedEnabled: + type: boolean + description: >- + Enable AdsFeed to manage all ads request/serving logic + setPref: + branch: user + pref: browser.newtabpage.activity-stream.unifiedAds.adsFeed.enabled + unifiedAdsFeedTilesEnabled: + type: boolean + description: >- + Enable AdsFeed to query MARS server to fetch/serve top sites tiles + setPref: + branch: user + pref: browser.newtabpage.activity-stream.unifiedAds.adsFeed.tiles.enabled + +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, mcrawford@mozilla.com + hasExposure: false + variables: + leaderboard: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabAdSize.leaderboard + description: >- + Leaderboard ad size and UI. + leaderboard_position: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabAdSize.leaderboard.position + description: >- + Leaderboard row position. + billboard: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabAdSize.billboard + description: >- + Billboard ad size and UI. + billboard_position: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabAdSize.billboard.position + description: >- + Billboard row position. + medium_rectangle: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabAdSize.mediumRectangle + description: >- + Medium rectangle (MREC) ad size and UI. + +newtabInlineTopicSelection: + description: >- + Adds Inline topic selection to sections layout + owner: nbarrett@mozilla.com + hasExposure: false + variables: + TopicSelectionEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.interestPicker.enabled + description: >- + Enables inline topic selection + +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. + +newtabCustomWallpaper: + description: >- + Modify the wallpaper selection feature to support user-uploaded custom wallpaper images + owner: mcrawford@mozilla.com + hasExposure: false + variables: + uploadWallpaper: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.customWallpaper.enabled + description: >- + Turns on and off ability to upload a custom wallpaper. + colorPicker: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.customColor.enabled + description: >- + Turns on and off background color picker. + maxFileSizeEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.customWallpaper.fileSize.enabled + description: >- + Turns on and off maximum file size for uploaded images + maxFileSize: + type: int + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.customWallpaper.fileSize + description: >- + Maximum file size (in MB) a user can upload + +newtabShortcutsExperiment: + description: >- + Adjusting sizes and spacing of new tab shortcuts. + owner: sdowne@mozilla.com + hasExposure: false + variables: + refresh: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabShortcuts.refresh + description: >- + Adjusting sizes and spacing of new tab shortcuts. + +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. + +newtabGroupedSponsoredControls: + description: >- + Adjust sponsored content controls on newtab. + owner: mcrawford@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.system.showSponsoredCheckboxes + description: >- + When true, checkboxes for sponsored results in top sites and recommended stories are grouped separately + on about:preferences#home + +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 + +newtabAdsReporting: + description: about:newtab reporting ads feature + owner: rhamoui@mozilla.com + hasExposure: false + variables: + reportAdsEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.reportAds.enabled + description: >- + Enable reporting for ads + +newTabSectionsExperiment: + description: about:newtab section UI update + owner: nbarrett@mozilla.com, mcrawford@mozilla.com + hasExposure: false + variables: + sectionsEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.enabled + description: >- + Enable the Section UI for recommended stories on newtab + cardRefreshThumbsUpDownEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.cards.thumbsUpDown.enabled + description: >- + Enable the thumbs up/down buttons in the revised pocket story + card UI in recommended stories on newtab + cardRefreshEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.cards.enabled + description: >- + Enable the revised pocket story card UI in recommended stories on newtab + regionPersonalizationInferredConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.personalization.inferred.region-config + description: >- + A comma-separated list of regions that use inferred personalization. + localePersonalizationInferredConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.personalization.inferred.locale-config + description: >- + A comma-separated list of locales that use inferred personalization. + personalizationInferredEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.personalization.inferred.enabled + description: >- + Enable the inferred personalization for topics + localeSectionstConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.locale-content-config + description: >- + A comma-separated list of locales that get contextual content by default. + regionSectionsConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.region-content-config + description: >- + A comma-separated list of regions that get contextual content by default. + sectionsPersonalization: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.personalization.enabled + description: >- + Enable personalized sections layout. Allow users to follow/unfollow topic sections. + sectionsCustomizeMenuPanel: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.customizeMenuPanel.enabled + description: >- + Enable personalized sections menu panel. Allow users to follow/unfollow topic sections. + sectionsContextualAdsEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.contextualAds.enabled + description: >- + Enable contextual ads in sections. + regionSectionsContextualAdsConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.contextualAds.region-config + description: >- + A comma-separated list of regions that get contextual ads by default. + localeSectionsContextualAdsConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.contextualAds.locale-config + description: >- + A comma-separated list of locales that get contextual ads by default. + contextualSpocPlacements: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.placements.contextualSpocs + description: CSV string of spoc placement ids on newtab Pocket grid. A placement id tells our ad server where the ads are intended to be displayed. + contextualSpocCounts: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.placements.contextualSpocs.counts + description: CSV string of spoc placement counts on newtab Pocket grid. The count tells the ad server how many ads to return for this position and placement. + +newtabPrivatePing: + description: The newtab-content ping, sent through OHTTP + owner: nbarrett@mozilla.com + hasExposure: false + variables: + privatePingEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.telemetry.privatePing.enabled + description: >- + Enables the private newtab-content ping sent through OHTTP + redactNewtabPing: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.telemetry.privatePing.redactNewtabPing.enabled + description: >- + Provides an option to redact content ids of users from click, impression and related events in the NewTab ping. Should be enabled when data colection has shefted to the more private NewTab_content ping. + includeInferredInterests: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.telemetry.privatePing.inferred.enabled + description: >- + Includes a differentially private intrest vector of general topical interests based on New Tab clicks. Only sent when user has enabled personalization. + maxSubmissionDelayMs: + type: int + setPref: + branch: user + pref: browser.newtabpage.activity-stream.telemetry.privatePing.maxSubmissionDelayMs + description: >- + The maximum range for the random delay from scheduling the newtab-content ping to actually sending it. The minimum is 1000 by default. This is in milliseconds. + +newtabTrainhop: + description: Experiment feature for the train-hopping newtab extension. + owner: mconley@mozilla.com + hasExposure: false + allowCoenrollment: true + variables: + type: + type: string + description: A discriminant to tell different kinds of trainhop experiments apart. + payload: + type: json + description: The experiment configuration. + +newtabMerinoOhttp: + description: Sending request to merino over OHTTP in newtab + owner: nbarrett@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystrean.merino-provider.ohttp.enabled + description: >- + Enables using OHTTP for merino content requests + +newtabMarsOhttp: + description: Sending request to MARS over OHTTP in newtab + owner: nbarrett@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.unifiedAds.ohttp.enabled + description: >- + Enables using OHTTP for unified ads API requests + +newtabRefinedCardsLayout: + description: Enable layout and styling refinements for content and ad cards across different card sizes + owner: rhamoui@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.refinedCardsLayout.enabled + description: Enables the refined cards layout for newtab + + +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. + wallpapersHighlightEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.highlightEnabled + description: >- + Turns on and off wallpaper feature highlight. + wallpaperHighlightHeaderText: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.highlightHeaderText + description: >- + Changes the wallpaper feature highlight header + wallpaperHighlightContentText: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.highlightContentText + description: >- + Changes the wallpaper feature highlight content + wallpaperHighlightCtaText: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.highlightCtaText + description: >- + Changes the wallpaper feature highlight cta + currentWallpaper: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.wallpaper + description: >- + Changes the currently selected wallpaper + weatherLocationSearch: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.weather.locationSearchEnabled + description: >- + Turns on and off location search for newtab weather widget + 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 + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.region-weather-config + localeWeatherConfig: + description: A comma-separated list of locales that weather widget supports. + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.locale-weather-config + topSitesMaxSponsored: + # Defined under `pocketNewtab` as it needs to be used along with other variables + type: int + description: The maximum number of sponsored Top Sites to be displayed + topSitesContileMaxSponsored: + # Defined under `pocketNewtab` as it needs to be used along with other variables + type: int + description: The maximum number of sponsored Top Sites used from Contile + 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: + enabled: + type: boolean + setPref: + branch: user + pref: extensions.pocket.enabled + description: Enabled save to Pocket feature. + 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? + +# Experiment for different Relay UI treatments. Variations at: +# https://www.figma.com/design/gnyElr1Wtce3RdQT54y8kS/Relay-%26-Firefox-Integration?node-id=316-2024&node-type=canvas&t=A3iAuevSTtwXeFxb-0 +email-autocomplete-relay: + description: Relay UI for email fields. + exposureDescription: Exposure is sent each time a user sees the Relay autocomplete dropdown item + hasExposure: true + owner: lcrouch@mozilla.com + variables: + firstOfferVersion: + type: string + description: Which Relay UI treatment to show + fallbackPref: signon.firefoxRelay.firstOfferVersionFallback + showToAllBrowsers: + type: boolean + setPref: + branch: user + pref: signon.firefoxRelay.showToAllBrowsers + description: Whether to show Relay to Firefox users who are NOT signed into FXA. + +# 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: true + exposureDescription: "Exposure is sent when an address is autofilled." + 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 + enableSignatureEditor: + description: Set to true to enable the signature editor + type: boolean + setPref: + branch: default + pref: pdfjs.enableSignatureEditor + +# 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: {} + +fxms-message-12: + description: "Firefox Messaging System message 12" + 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-13: + description: "Firefox Messaging System message 13" + 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-14: + description: "Firefox Messaging System message 14" + 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-15: + description: "Firefox Messaging System message 15" + 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 + allowCoenrollment: true + variables: + gleanMetricConfiguration: + type: json + description: | + A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric. + This variable is intended for interacting with the Glean data-control-plane via the Server Knobs functionality + to remotely configure metrics to be enabled or disabled. + +gleanInternalSdk: + description: "The Glean internal SDK feature intended only for internal Glean Team use" + owner: glean-team@mozilla.com + 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" + +echPrefs: + description: Prefs that control Encrypted Client Hello. + owner: djackson@mozilla.com + hasExposure: false + variables: + tlsEnabled: + description: Whether to enable ECH for connections using TLS + type: boolean + setPref: + branch: default + pref: "network.dns.echconfig.enabled" + h3Enabled: + description: Whether to enable ECH for connections using H3/QUIC + type: boolean + setPref: + branch: default + pref: "network.dns.http3_echconfig.enabled" + forceWaitHttpsRR: + description: Whether to force waiting for HTTPS DNS records, which ECH requires. + type: boolean + setPref: + branch: default + pref: "network.dns.force_waiting_https_rr" + insecureFallback: + description: Whether to fallback to non-ECH connections if all ECH RRs fail. + type: boolean + setPref: + branch: default + pref: "network.dns.echconfig.fallback_to_origin_when_all_failed" + tlsGreaseProb: + description: Probability of GREASEing a TLS connection with ECH (0-100). + type: int + setPref: + branch: default + pref: "security.tls.ech.grease_probability" + h3GreaseEnabled: + description: Whether to apply GREASE settings to H3/QUIC connections. + type: boolean + setPref: + branch: default + pref: "security.tls.ech.grease_http3" + disableGreaseOnFallback: + description: Whether to disable GREASE when retrying a connection. + type: boolean + setPref: + branch: default + pref: "security.tls.ech.disable_grease_on_fallback" + greasePaddingSize: + description: Assumed echConfig padding length for GREASE extensions (1-255). + type: int + setPref: + branch: default + pref: "security.tls.ech.grease_size" + +dohPrefs: + description: Prefs that control DNS over HTTPS. + owner: vgosu@mozilla.com + hasExposure: false + variables: + trrMode: + description: Has a value of 2 for TRR first, 3 for TRR only, 0 for off. + type: int + setPref: + branch: default + pref: "network.trr.mode" + trrUri: + description: The URL of the DNS over HTTPS endpoint + type: string + setPref: + branch: default + pref: "network.trr.uri" + dohMode: + description: Same as trrMode, but set by the DoHController module. + type: int + setPref: + branch: default + pref: "doh-rollout.mode" + dohUri: + description: Same as trrUri, but set by the DoHController module. + type: string + setPref: + branch: default + pref: "doh-rollout.uri" + dohProviderList: + description: An override of the rollout provider-list json + type: string + setPref: + branch: default + pref: "doh-rollout.provider-list" + dohProviderSteeringList: + description: An override of the rollout steering provider-list json + type: string + setPref: + branch: default + pref: "doh-rollout.provider-steering.provider-list" + nativeHTTPSRecords: + description: Whether we can perform native DNS HTTPS lookups + type: boolean + setPref: + branch: default + pref: "network.dns.native_https_query" + +dooh: + description: "DNS over Oblivious HTTP" + owner: vgosu@mozilla.com + hasExposure: false + variables: + ohttpEnabled: + description: Whether to use Oblivious HTTP for the resolution + type: boolean + setPref: + branch: default + pref: "network.trr.use_ohttp" + ohttpRelayUri: + description: The URL of the Oblivious HTTP relay + type: string + setPref: + branch: default + pref: "network.trr.ohttp.relay_uri" + ohttpConfigUri: + description: The URL used to fetch the configuration of the Oblivious HTTP gateway + type: string + setPref: + branch: default + pref: "network.trr.ohttp.config_uri" + ohttpUri: + description: The URL of the Oblivious DNS over HTTPS target resource + type: string + setPref: + branch: default + pref: "network.trr.ohttp.uri" + +networking: + description: "Firefox Networking (Necko)" + owner: vgosu@mozilla.com + hasExposure: false + variables: + preconnect: + description: Whether the rel=preconnect feature is enabled + type: boolean + setPref: + branch: default + pref: "network.preconnect" + 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" + enableOffMainThreadStreamDecompression: + description: Whether to enable decompression of network streams off-main-thread + type: boolean + setPref: + branch: default + pref: "network.decompression_off_mainthread2" + offMainThreadStreamDecompressionThreshold: + description: Minimum content length for off-main-thread decompression + type: int + setPref: + branch: default + pref: "network.decompression_off_mainthread_min_size" + dnsGracePeriod: + description: The grace period allows the DNS cache to use expired entries, while kicking off a revalidation in the background. + type: int + setPref: + branch: default + pref: "network.dnsCacheExpirationGracePeriod" + http3UseNSPRForIO: + description: true by default using legacy UDP IO via NSPR. When set to false, uses new UDP IO via Fast UDP for Firefox project. + type: boolean + setPref: + branch: default + pref: "network.http.http3.use_nspr_for_io" + +networkingEarlyHints: + description: "Networking (Necko) Early Hints" + owner: vgosu@mozilla.com + hasExposure: false + variables: + ehPreloadEnabled: + description: Whether Early Hints preload is enabled + type: boolean + setPref: + branch: default + pref: "network.early-hints.enabled" + ehPreconnectEnabled: + description: Whether Early Hints preconnect is enabled + type: boolean + setPref: + branch: default + pref: "network.early-hints.preconnect.enabled" + +networkingDNS: + description: "Networking (Necko) DNS" + owner: vgosu@mozilla.com + hasExposure: false + variables: + dnsMaxPriorityThreads: + description: The maximum number of high priority DNS threads that can be created. + type: int + setPref: + branch: default + pref: "network.dns.max_high_priority_threads" + dnsMaxAnyPriorityThreads: + description: The maximum number of DNS threads that can be created to handle any priority DNS requests. + type: int + setPref: + branch: default + pref: "network.dns.max_any_priority_threads" + maxDnsCacheEntries: + description: This is the number of dns cache entries allowed + type: int + setPref: + branch: default + pref: "network.dnsCacheEntries" + +networkingConnections: + description: "Networking (Necko) Connections" + owner: vgosu@mozilla.com + hasExposure: false + variables: + httpMaxConnections: + description: The maximum number of http connections. + type: int + setPref: + branch: default + pref: "network.http.max-connections" + httpMaxPersistentConnectionsPerServer: + description: The maximum number of persistent connections to a server + type: int + setPref: + branch: default + pref: "network.http.max-persistent-connections-per-server" + speculativeConnectionLimit: + description: The maximum number of half-open sockets allowed for speculative connections + type: int + setPref: + branch: default + pref: "network.http.speculative-parallel-limit" + + +networkingSendOnDataFinished: + description: "Networking (Necko) OnDataFinished" + owner: vgosu@mozilla.com + hasExposure: false + variables: + sendOnDataFinished: + description: Whether we can send OnDataFinished in the content process + type: boolean + setPref: + branch: default + pref: "network.send_OnDataFinished" + 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" + +networkingBannedPorts: + description: "Networking (Necko) Banned Ports" + owner: vgosu@mozilla.com + hasExposure: false + variables: + bannedPortList: + description: A comma-separated list of ports that Firefox will refuse to connect to. These ports will be appended to nsIOService gBadPortList + type: string + setPref: + branch: default + pref: "network.security.ports.banned" + +essentialFallbackDomains: + description: "Whether to retry failing system requests with a backup domain" + owner: vgosu@mozilla.com + hasExposure: false + variables: + essentialDomainsEnabled: + description: Whether to retry with a backup domain indicated in remote-settings + type: boolean + setPref: + branch: default + pref: "network.essential_domains_fallback" + +disableHttp3: + description: "Whether HTTP/3 is disabled" + owner: kershaw@mozilla.com + hasExposure: false + variables: + withThirdPartyRoots: + description: If third party roots are detected, disable HTTP/3 + type: boolean + setPref: + branch: default + pref: "network.http.http3.disable_when_third_party_roots_found" + + +networkPrioritization: + description: "Network request prioritization" + owner: vgosu@mozilla.com + hasExposure: false + variables: + priorityHeader: + description: Whether to set the Priority header on each request. + type: boolean + setPref: + branch: default + pref: "network.http.priority_header.enabled" + fetchPriority: + description: Whether fetch priority is enabled + type: boolean + setPref: + branch: default + pref: "network.fetchpriority.enabled" + h3FetchPriority: + description: Whether to send HTTP3 priority frames + type: boolean + setPref: + branch: default + pref: "network.http.http3.priority" + sendNoRFC7540Setting: + description: Whether to send the SETTINGS_NO_RFC7540_PRIORITIES for the HTTP2 session. + type: boolean + setPref: + branch: default + pref: "network.http.http2.send_NO_RFC7540_PRI" + h2deps: + description: Whether RFC7540 priorities / stream dependencies are enabled + type: boolean + setPref: + branch: default + pref: "network.http.http2.enabled.deps" + h3BackgroundTabDeprioritization: + description: Lowers the priority when the tab is in the background. Potential privacy concerns. + type: boolean + setPref: + branch: default + pref: "network.http.http3.send_background_tabs_deprioritization" + documentPriorityIncremental: + description: Sets the incremental flag on the Priority header for document requests + type: boolean + setPref: + branch: default + pref: "dom.document_priority.incremental" + imagePriorityIncremental: + description: Sets the incremental flag on the Priority header for image requests + type: boolean + setPref: + branch: default + pref: "image.priority.incremental" + imageAdjustLayoutPriority: + description: Whether the network request priority should be adjusted according the layout and view frame position of each particular image. + type: boolean + setPref: + branch: default + pref: "image.layout_network_priority" + adjustLinkPreloadScriptLow: + description: Priority adjustment low for link-preload-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-script.low" + adjustLinkPreloadScriptHigh: + description: Priority adjustment high for link-preload-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-script.high" + adjustLinkPreloadScriptAuto: + description: Priority adjustment auto for link-preload-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-script.auto" + adjustModuleScriptLow: + description: Priority adjustment low for module-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.module-script.low" + adjustModuleScriptHigh: + description: Priority adjustment high for module-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.module-script.high" + adjustModuleScriptAuto: + description: Priority adjustment auto for module-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.module-script.auto" + adjustAsyncOrDeferScriptLow: + description: Priority adjustment low for async-or-defer-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.async-or-defer-script.low" + adjustAsyncOrDeferScriptHigh: + description: Priority adjustment high for async-or-defer-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.async-or-defer-script.high" + adjustAsyncOrDeferScriptAuto: + description: Priority adjustment auto for async-or-defer-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.async-or-defer-script.auto" + adjustScriptInHeadLow: + description: Priority adjustment low for script-in-head + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.script-in-head.low" + adjustScriptInHeadHigh: + description: Priority adjustment high for script-in-head + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.script-in-head.high" + adjustScriptInHeadAuto: + description: Priority adjustment auto for script-in-head + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.script-in-head.auto" + adjustOtherScriptLow: + description: Priority adjustment low for other-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.other-script.low" + adjustOtherScriptHigh: + description: Priority adjustment high for other-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.other-script.high" + adjustOtherScriptAuto: + description: Priority adjustment auto for other-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.other-script.auto" + adjustLinkPreloadFontLow: + description: Priority adjustment low for link-preload-font + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-font.low" + adjustLinkPreloadFontHigh: + description: Priority adjustment high for link-preload-font + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-font.high" + adjustLinkPreloadFontAuto: + description: Priority adjustment auto for link-preload-font + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-font.auto" + adjustLinkPreloadFetchLow: + description: Priority adjustment low for link-preload-fetch + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-fetch.low" + adjustLinkPreloadFetchHigh: + description: Priority adjustment high for link-preload-fetch + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-fetch.high" + adjustLinkPreloadFetchAuto: + description: Priority adjustment auto for link-preload-fetch + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-fetch.auto" + adjustDeferredStyleLow: + description: Priority adjustment low for deferred-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.deferred-style.low" + adjustDeferredStyleHigh: + description: Priority adjustment high for deferred-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.deferred-style.high" + adjustDeferredStyleAuto: + description: Priority adjustment auto for deferred-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.deferred-style.auto" + adjustLinkPreloadStyleLow: + description: Priority adjustment low for link-preload-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-style.low" + adjustLinkPreloadStyleHigh: + description: Priority adjustment high for link-preload-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-style.high" + adjustLinkPreloadStyleAuto: + description: Priority adjustment auto for link-preload-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-style.auto" + adjustNonDeferredStyleLow: + description: Priority adjustment low for non-deferred-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.non-deferred-style.low" + adjustNonDeferredStyleHigh: + description: Priority adjustment high for non-deferred-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.non-deferred-style.high" + adjustNonDeferredStyleAuto: + description: Priority adjustment auto for non-deferred-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.non-deferred-style.auto" + adjustGlobalFetchApiLow: + description: Priority adjustment low for global-fetch-api + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.global-fetch-api.low" + adjustGlobalFetchApiHigh: + description: Priority adjustment high for global-fetch-api + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.global-fetch-api.high" + adjustGlobalFetchApiAuto: + description: Priority adjustment auto for global-fetch-api + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.global-fetch-api.auto" + adjustImagesLow: + description: Priority adjustment low for images + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.images.low" + adjustImagesHigh: + description: Priority adjustment high for images + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.images.high" + adjustImagesAuto: + description: Priority adjustment auto for images + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.images.auto" + lowerTrackersPriority: + description: Whether to lower priority of resources on the tracking protection list + type: boolean + setPref: + branch: default + pref: "privacy.trackingprotection.lower_network_priority" + enableHttpTailing: + description: Whether certain requests, mainly trackers, are put to the "tail", behind other requests + type: boolean + setPref: + branch: default + pref: "network.http.tailing.enabled" + httpTailingUrgency: + description: Priority urgency of tailed request + type: int + setPref: + branch: default + pref: "network.http.tailing.urgency" + httpTailingDelayQuantum: + description: When the page load has not yet reached DOMContentLoaded point, tail requestes are delayed by (non-tailed requests count + 1) * delay-quantum milliseconds. + type: int + setPref: + branch: default + pref: "network.http.tailing.delay-quantum" + httpTailingDelayQuantumAfterDCL: + description: After the page load reached DOMContentLoaded point, tail requestes are delayed by (non-tailed requests count + 1) * delay-quantum-after-domcontentloaded milliseconds. + type: int + setPref: + branch: default + pref: "network.http.tailing.delay-quantum-after-domcontentloaded" + httpTailingMaxDelay: + description: Upper limit for the calculated delay, prevents long standing and comet-like requests + type: int + setPref: + branch: default + pref: "network.http.tailing.delay-max" + httpTailingTotalMaxDelay: + description: Total limit we delay tailed requests since page load start + type: int + setPref: + branch: default + pref: "network.http.tailing.total-max" + +networkingAuth: + description: "Firefox Networking (Necko) Authentication" + owner: vgosu@mozilla.com + hasExposure: false + variables: + redirectForAuthRetriesEnabled: + description: Whether to enable redirects for auth retries + type: boolean + setPref: + branch: default + pref: "network.auth.use_redirect_for_retries" + +networkingDenyIpAddrAny: + description: "Firefox Networking (Necko) Deny IP Address Any" + owner: vgosu@mozilla.com + hasExposure: false + variables: + denyIpAddrAny: + description: Whether to deny empty (0.0.0.0) IP addresses + type: boolean + setPref: + branch: default + pref: "network.socket.ip_addr_any.disabled" + +cookieStore: + description: Enablement of cookieStore API + owner: edgul@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: dom.cookieStore.enabled + description: >- + Enablement of the cookie store API to CRUD and monitor cookies from window JS. + managerEnabled: + description: Enablement of ServiceWorker access to cookie-change events. + type: boolean + setPref: + branch: default + pref: dom.cookieStore.manager.enabled + +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" + +thirdPartyTrackerCookieBlocking: + description: Prefs to control third-party tracker cookie blocking + owner: tihuang@mozilla.com + hasExposure: false + variables: + enabled: + description: Whether to enable third-party tracker cookie blocking. + type: boolean + setPref: + branch: default + pref: "network.cookie.cookieBehavior.trackerCookieBlocking" + +fxaButtonVisibility: + description: Prefs to control the visibility of the Firefox Accounts toolbar button when not signed in. + owner: mconley@mozilla.com + hasExposure: false + variables: + boolean: + description: True if the Firefox Accounts toolbar button should be visible when not signed in. + type: boolean + setPref: + branch: user + pref: identity.fxaccounts.toolbar.defaultVisible + pxiToolbarEnabled: + description: >- + True if we're enabling the PXI dropdown menu for the FxA toolbar button instead of + taking the user straight to login + type: boolean + setPref: + branch: user + pref: identity.fxaccounts.toolbar.pxiToolbarEnabled + monitorEnabled: + description: >- + Toggle the Monitor CTA + type: boolean + setPref: + branch: user + pref: identity.fxaccounts.toolbar.pxiToolbarEnabled.monitorEnabled + relayEnabled: + description: >- + Toggle the Relay CTA + type: boolean + setPref: + branch: user + pref: identity.fxaccounts.toolbar.pxiToolbarEnabled.relayEnabled + vpnEnabled: + description: >- + Toggle the VPN CTA + type: boolean + setPref: + branch: user + pref: identity.fxaccounts.toolbar.pxiToolbarEnabled.vpnEnabled + avatarIconVariant: + description: >- + Controls the icon that appears in the toolbar button when in the + signed-out state. + + One of the following values: + - control + - human-circle + - fox-circle + type: string + +fxaClientAssociation: + description: Prefs to control the client association ping. + owner: mconley@mozilla.com + hasExposure: false + variables: + pingEnabled: + description: >- + True if the client association ping should be sent. + type: boolean + setPref: + branch: user + pref: identity.fxaccounts.telemetry.clientAssociationPing.enabled + +fxaAppMenuItem: + description: >- + Prefs to control the appearance and copy of the FxA sign-in button in the + AppMenu when signed out. + owner: mconley@mozilla.com + hasExposure: true + exposureDescription: >- + Exposure is recorded when the user is enrolled in an experiment using this + feature and the AppMenu on Firefox Desktop is opened. + variables: + ctaCopyVariant: + description: >- + One of the following values: + - control + - sync-devices + - backup-data + - backup-sync + - mobile + type: string + +fxaAvatarMenuItem: + description: >- + Prefs to control the appearance and copy of the FxA sign-in button in the + FxA avatar menu when signed out. + owner: mconley@mozilla.com + hasExposure: true + exposureDescription: >- + Exposure is recorded when the user is enrolled in an experiment using this + feature and the FxA avatar menu on Firefox Desktop is opened. + variables: + ctaCopyVariant: + description: >- + One of the following values: + - control + - sync-devices + - backup-data + - backup-sync + - mobile + type: string + +legacyHeartbeat: + description: Normandy Heartbeat exposed to Nimbus + owner: beth@mozilla.com + hasExposure: false + schema: + uri: "resource://normandy/schemas/LegacyHeartbeat.schema.json" + path: "toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json" + variables: + survey: + type: json + description: The Heartbeat survey parameters. + +queryStripping: + description: Query parameter stripping anti-tracking feature. + owner: emz@mozilla.com + hasExposure: false + variables: + enabledNormalBrowsing: + type: boolean + setPref: + branch: default + pref: privacy.query_stripping.enabled + description: Enables / disables URL query string stripping in normal browsing mode. + enabledPrivateBrowsing: + type: boolean + setPref: + branch: default + pref: privacy.query_stripping.enabled.pbmode + description: Enables / disables URL query string stripping in private browsing mode. + allowList: + type: string + setPref: + branch: default + pref: privacy.query_stripping.allow_list + description: >- + List of sites exempt from query stripping. This list will be merged with + records coming from RemoteSettings. + stripList: + type: string + setPref: + branch: default + pref: privacy.query_stripping.strip_list + description: >- + List of query params to be stripped from URIs. This list will be merged + with records coming from RemoteSettings. + +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 + canvas_random_use_siphash: + type: boolean + setPref: + branch: default + pref: privacy.resistFingerprinting.randomization.canvas.use_siphash + description: >- + Uses the SipHash function for canvas randomization. + enabledBaseline: + type: boolean + setPref: + branch: default + pref: privacy.baselineFingerprintingProtection + description: Enables / disables baseline fingerprinting protection. + overridesBaseline: + type: string + setPref: + branch: default + pref: privacy.baselineFingerprintingProtection.overrides + description: >- + The protection overrides to add or remove fingerprinting protection + targets. Please check RFPTargets.inc for all supported targets. + +userCharacteristics: + description: Control user characteristic data collection + owner: tihuang@mozilla.com + hasExposure: false + variables: + currentVersion: + type: int + setPref: + branch: user + pref: toolkit.telemetry.user_characteristics_ping.current_version + description: The current collection version of the user characteristics. + +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" + nursery_max_time_goal_ms: + description: Set the nursery's maximum time goal, in ms. + type: int + setPref: + branch: user + pref: "javascript.options.mem.nursery_max_time_goal_ms" + +jsParallelParsing: + description: Pref to toggle JS parallel parsing. + owner: dpalmeiro@mozilla.com, nbp@mozilla.com + hasExposure: false + variables: + enabled: + description: True to enable parallel parsing. + type: boolean + setPref: + branch: user + pref: "javascript.options.parallel_parsing" + +jitThresholds: + description: Prefs that control jit tier thresholds. + owner: dpalmeiro@mozilla.com, jdemooij@mozilla.com + hasExposure: false + variables: + blinterp_threshold: + description: Set the threshold to enable blinterp compilation. + type: int + setPref: + branch: user + pref: "javascript.options.blinterp.threshold" + baseline_threshold: + description: Set the threshold to enable baseline compilation. + type: int + setPref: + branch: user + pref: "javascript.options.baselinejit.threshold" + ion_threshold: + description: Set the threshold to enable ion compilation. + type: int + setPref: + branch: user + pref: "javascript.options.ion.threshold" + ion_bailout_threshold: + description: Set the ion frequent bailout threshold. + type: int + setPref: + branch: user + pref: "javascript.options.ion.frequent_bailout_threshold" + ion_offthread_compilation: + description: True to enable offthread ion compilations. + type: boolean + setPref: + branch: user + pref: "javascript.options.ion.offthread_compilation" + inlining_max_length: + description: Set the max bytecode length considered for inlining. + type: int + setPref: + branch: user + pref: "javascript.options.inlining_bytecode_max_length" + +jitHintsCache: + description: Pref to toggle the JIT hints cache. + owner: dpalmeiro@mozilla.com + hasExposure: false + variables: + enabled: + description: True to enable the hints cache. + type: boolean + setPref: + branch: user + pref: "javascript.options.jithints" + +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" + +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: emz@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: nimbus-team@mozilla.com + hasExposure: false + applications: + - firefox-desktop + variables: + gleanMetricConfiguration: + description: > + A Glean metric configuration JSON blob. + + This is limited to configuring the following categories: + - nimbus_events + - nimbus_targeting_context + - nimbus_targeting_environment + type: json + + nimbusTargetingEnvironment: + description: > + Configuration for the nimbus_targeting_environment telemetry category. + type: json + + schema: + uri: resource://nimbus/schemas/NimbusTelemetryFeature.schema.json + path: toolkit/components/nimbus/schemas/NimbusTelemetryFeature.schema.json + +httpsFirst: + description: >- + Prefs for HTTPS-First, which upgrades all top-level page loads to HTTPS and + provides a automatic fallback to HTTP if the site isn't available via HTTPS. + owner: mjurgens@mozilla.com, seceng-telemetry@mozilla.com + hasExposure: false + variables: + enabled: + description: Enable HTTPS-First + type: boolean + setPref: + branch: default + pref: dom.security.https_first + enabledPbm: + description: Enable HTTPS-First in private browsing only + type: boolean + setPref: + branch: default + pref: dom.security.https_first_pbm + enabledSchemeless: + description: >- + Enables schemeless HTTPS-First, which will only apply HTTPS-First to address + bar inputs without a scheme. This essentially makes HTTPS the default + scheme in the address bar, while providing a fallback to HTTP. + type: boolean + setPref: + branch: default + pref: dom.security.https_first_schemeless + backgroundTimerMs: + description: >- + After a request gets upgraded to HTTPS, specifies the time after which a + second HTTP request is fired to check if the site is available via + HTTPS, but timing out via HTTPS. This also applies to HTTPS-Only, not + just HTTPS-First. + type: int + setPref: + branch: default + pref: dom.security.https_only_fire_http_request_background_timer_ms + +contentRelevancy: + description: >- + A feature for interest-based content relevance ranking and personalization + for Firefox. + owner: disco-team@mozilla.com + hasExposure: false + variables: + enabled: + description: Enable this feature + type: boolean + fallbackPref: toolkit.contentRelevancy.enabled + maxInputUrls: + description: The maximum number of input URLs for interest classification + type: int + minInputUrls: + description: The minimal number of input URLs for interest classification + type: int + timerInterval: + description: >- + The interval (in seconds) of the background update timer for the content + relevancy manager + type: int + setPref: + branch: user + pref: toolkit.contentRelevancy.timerInterval + ingestEnabled: + description: Enable the ingestion through the Rust component + type: boolean + fallbackPref: toolkit.contentRelevancy.ingestEnabled + +backupService: + description: Prefs to control the profile backup service + owner: mconley@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: browser.backup.enabled + description: >- + When true, the profile backup service will be initialized soon after + startup. + 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. + dtlsWebRTCEnableMlkem: + type: boolean + setPref: + branch: default + pref: media.webrtc.enable_pq_dtls + description: >- + Whether to enable mlkem768x25519 for DTLS in WebRTC. + + +dtlsWebRTC: + description: Pref that controls the use of DTLS. + owner: nkulatova@mozilla.com + hasExposure: false + variables: + tlsVersionDTLS: + type: int + setPref: + branch: default + pref: media.peerconnection.dtls.version.max + description: >- + The maximum version of DTLS protocol used in WebRTC (770 = DTLS 1.0, 771 = DTLS 1.2, 772 = DTLS 1.3). + +certCompression: + description: Prefs that control the use of certificate compression decoders. + owner: anna.weine@mozilla.com + hasExposure: false + variables: + tlsEnableZlib: + type: boolean + setPref: + branch: default + pref: security.tls.enable_certificate_compression_zlib + description: >- + Whether to enable Zlib for TLS certificate compression. + 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: emz@mozilla.com + isEarlyStartup: true + hasExposure: true + exposureDescription: >- + Exposure is recored after every purge run which purged at least one tracker. + Exposure is only recorded when the feature is fully enabled and not in + dry-run mode. + variables: + mode: + type: int + setPref: + branch: default + pref: privacy.bounceTrackingProtection.mode + description: >- + Mode to run the feature in. See nsIBounceTrackingProtection.idl for + documentation. + requireStatefulBounces: + type: boolean + setPref: + branch: default + pref: privacy.bounceTrackingProtection.requireStatefulBounces + description: >- + If true, only bounce redirects where the middle hop/s access cookies or + storage will be considered to be bounce trackers. If false, all + redirects that fit the bounce tracker heuristic will be considered. + +remoteTabManagement: + description: > + Features that let users manage tabs on other devices that are + connected to the same Mozilla account. + owner: skhamis@mozilla.com + hasExposure: false + variables: + closeTabsEnabled: + description: >- + When true, the user can close tabs on other devices connected to + the same Mozilla account from the synced tabs menu. + type: boolean + fallbackPref: identity.fxaccounts.commands.remoteTabManagement.enabled + +crlite: + description: Prefs that control the use of CRLite + owner: jschanck@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: security.remote_settings.crlite_filters.enabled + description: >- + Whether CRLite artifacts will be downloaded. + channel: + type: string + setPref: + branch: default + pref: security.pki.crlite_channel + description: >- + The channel from which CRLite artifacts will be downloaded. + mode: + type: int + setPref: + branch: default + pref: security.pki.crlite_mode + description: >- + How CRLite results will be interpreted. + timestamps_for_coverage: + type: int + setPref: + branch: default + pref: security.pki.crlite_timestamps_for_coverage + description: >- + How many covered timestamps do we need to see before we enforce a CRLite result. + +chatbot: + description: AI chatbot feature configuration + owner: elee@mozilla.com + hasExposure: false + variables: + minVersion: + type: string + description: Minimum Firefox version to apply prefs + prefs: + type: json + description: >- + The prefs to set under browser.ml.chat.* with object keys as the + sub-pref and values objects indicating the desired branch and value + defaulting to clearing the user branch value. + +linkPreviews: + description: Enabling the link previews feature + owner: elee@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.ml.linkPreview.enabled + description: If true, will show previews when over link and keyboard shortcut is pressed + prefs: + type: json + description: >- + The prefs to set under browser.ml.linkPreview.* with object keys as the + sub-pref and values objects indicating the desired branch and value + defaulting to clearing the user branch value. + +sidebar: + description: Sidebar feature configuration + owner: elee@mozilla.com + hasExposure: false + variables: + defaultLauncherVisible: + type: boolean + setPref: + branch: user + pref: sidebar.revamp.defaultLauncherVisible + description: Change the initial visibleness of the sidebar launcher with horizontal tabs; true to make the launcher visible by default + minVersion: + type: string + description: Minimum Firefox version to apply prefs + revamp: + type: boolean + description: sidebar.revamp pref value to set on user branch; true for new experience + verticalTabs: + type: boolean + description: sidebar.verticalTabs pref value to set on user branch; true to enable vertical tabs + visibility: + type: string + description: sidebar.visibility pref value ("hide" or "always-show") 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). + +setToDefaultPrompt: + description: "Experimental set to default spotlight" + 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: + showSpotlightPrompt: + description: Show experimental set to default spotlight message instead of default prompt + type: boolean + message: + description: Message to show instead of the default prompt + type: json + +tabGroups: + description: Prefs to control Tab Groups + owner: dao@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.tabs.groups.enabled + description: Controls whether users can create new tab groups via drag and drop or the tab context menu + +smartTabGroups: + description: Prefs to control Smart Tab Groups + owner: rrando@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.tabs.groups.smart.enabled + description: Controls whether users can use ml features for suggesting tab group names or similar tabs + suggestOtherTabsMethod: + type: string + setPref: + branch: user + pref: browser.tabs.groups.smart.suggestOtherTabsMethod + description: Controls clustering method used to suggest similar tabs feature + topicModelRevision: + type: string + setPref: + branch: user + pref: browser.tabs.groups.smart.topicModelRevision + description: Controls topic model version used by the feature + embeddingModelRevision: + type: string + setPref: + branch: user + pref: browser.tabs.groups.smart.embeddingModelRevision + description: Controls embedding model version used by the feature + nearestNeighborThresholdInt: + type: int + setPref: + branch: user + pref: browser.tabs.groups.smart.nearestNeighborThresholdInt + description: Controls the threshold, less than or equal to 1000, for the nearest neighbor cluster method + +smartblockEmbeds: + description: Pref to control Smartblock Embeds + owner: emz@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: extensions.webcompat.smartblockEmbeds.enabled + description: >- + Controls whether smartblock embed placeholders and protections panel toggles will be shown to the user. + +selectableProfiles: + description: "Multiple profile management using selectableProfileService" + owner: jhirsch@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Enables the multiple profiles feature when true. Turning off this variable will not disable the feature. + +storageAccessHeuristics: + description: Heuristics that grant cookie access automatically for foreign resources + owner: bvandersloot@mozilla.com + hasExposure: false + variables: + popup_past_interaction: + type: boolean + setPref: + branch: default + pref: privacy.restrict3rdpartystorage.heuristic.window_open + description: >- + Do we grant cookie access to a third party when it is opened in a popup if it has + been interacted with in the recent past? + popup_interaction: + type: boolean + setPref: + branch: default + pref: privacy.restrict3rdpartystorage.heuristic.opened_window_after_interaction + description: >- + Do we grant cookie access to a third party when it is opened in a popup if it has + the opener relationship and the user interacts with the popup? + navigation: + type: boolean + setPref: + branch: default + pref: privacy.restrict3rdpartystorage.heuristic.navigation + description: >- + Do we grant cookie access to a third party when it is interacted with earlier in this + tab's history, and the current first party is even further back in the history? + redirect: + type: boolean + setPref: + branch: default + pref: privacy.restrict3rdpartystorage.heuristic.recently_visited + description: >- + Do we grant cookie access to a third party when it has been interacted with in the recent + past, has been visited in the past few minutes, and redirects itself to another top level + site? + redirect_tracker: + type: boolean + setPref: + branch: default + pref: privacy.restrict3rdpartystorage.heuristic.redirect + description: >- + Do we grant cookie access to a tracker third party when it has been interacted with in the + recent past and redirects itself to another top level site? + +partitioned-cookie-attribute: + description: Control the enablment and migration of cookies to the Partitioned attribute, rather than TCP + owner: bvandersloot@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: network.cookie.CHIPS.enabled + description: >- + Do we respect the Partitioned attribute? + chipsMigrationTarget: + description: What CHIPS migration count target the browser should reach. + type: int + setPref: + branch: default + pref: network.cookie.CHIPS.migrateDatabaseTarget + chipsPartitionLimitEnabled: + description: Whether we enforce CHIPS partition limit + type: boolean + setPref: + branch: default + pref: "network.cookie.chips.partitionLimitEnabled" + chipsPartitionLimitDryRun: + description: Whether we actually perform purging/rejection, used to report telemetry without webcompat issues + type: boolean + setPref: + branch: default + pref: "network.cookie.chips.partitionLimitDryRun" + chipsPartitionLimitByteCapacity: + description: The actual value of the CHIPS partition limit in bytes + type: boolean + setPref: + branch: default + pref: "network.cookie.chips.partitionLimitByteCapacity" + +auto-pip: + description: "Automatic Picture-in-Picture" + owner: mconley@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Whether or not to auto-open PiP when switching tabs. + setPref: + branch: user + pref: "media.videocontrols.picture-in-picture.enable-when-switching-tabs.enabled" + +urlbar-ime-search: + description: "Urlbar IME" + owner: search-and-suggest-program@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Whether or not to keep the urlbar panel open during IME composition. + setPref: + branch: user + pref: "browser.urlbar.keepPanelOpenDuringImeComposition" + +web-rtc-global-mute-toggles: + description: "WebRTC Global Mute Toggles" + owner: mconley@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Whether or not to enable global mute toggles to the WebRTC indicator. + setPref: + branch: user + pref: "privacy.webrtc.globalMuteToggles" + +jpeg-xl: + description: "JPEG-XL" + owner: krosylight@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Whether or not to enable JPEG-XL support. + setPref: + branch: user + pref: "image.jxl.enabled" + +css-masonry: + description: "CSS Masonry Layout" + owner: dholbert@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Whether or not to enable CSS masonry layout. + setPref: + branch: user + pref: "layout.css.grid-template-masonry-value.enabled" + +contextual-password-manager: + description: Enabling the contextual password manager feature + owner: issozi@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.contextual-password-manager.enabled + description: If true, we will allow user to add the contextual password manager feature to the sidebar. + +h1-in-section-styles: + description: "H1 in section user agent styles" + owner: zcorpan@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Whether to enable H1 in section UA styles, see https://github.com/whatwg/html/issues/7867. + setPref: + branch: user + pref: layout.css.h1-in-section-ua-styles.enabled + +windowsUIAutomation: + description: Support for the Windows UI Automation API + owner: jteh@mozilla.com + hasExposure: false + variables: + enabled: + type: int + description: 0 to disable UIA, 2 to enable UIA. + enum: + - 0 + - 2 + setPref: + branch: user + pref: "accessibility.uia.enable" + +expandSignInButton: + description: "Add text next to the FxA avatar toolbar icon" + owner: skhamis@mozilla.com + hasExposure: false + variables: + ctaCopyVariant: + description: >- + One of the following values: + - fxa-avatar-sign-in + - fxa-avatar-sign-up + empty will be assumed default experience + type: string + +contextID: + description: >- + Controls the behaviour of the context ID, which is a unique identifier used + by Contextual Services. + owner: mconley@mozilla.com + hasExposure: false + variables: + rotationPeriodInDays: + type: int + setPref: + branch: user + pref: "browser.contextual-services.contextId.rotation-in-days" + description: >- + The number of days since the creation of the context ID after which the + context ID should be regenerated. Set to 0 to disable rotation. This + value only takes effect if rustBackendEnabled is also true, otherwise + no rotation will occur regardless of the value. + + This setting will only be applied after the next restart. + rustBackendEnabled: + type: boolean + setPref: + branch: user + pref: "browser.contextual-services.contextId.rust-component.enabled" + description: >- + Enables the Rust component backend for ContextId.sys.mjs, which is + a prerequisite for doing rotations. diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/v140.4.0/schemas/browser/components/asrouter/content-src/schemas/BackgroundTaskMessagingExperiment.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v140.4.0/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/v140.4.0/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/v140.4.0/schemas/browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v140.4.0/schemas/browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json new file mode 100644 index 0000000000..a2a3ce15b4 --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v140.4.0/schemas/browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json @@ -0,0 +1,1802 @@ +{ + "$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": "Specifies where the message should appear and persist: 'global' (persists across tabs in the current window), 'tab' (only visible in the current tab), or 'universal' (visible across all tabs and windows, current and future).", + "enum": [ + "global", + "tab", + "universal" + ] + }, + "text": { + "description": "Either a single localizableText, or an array of raw strings and/or localizableText objects. localizableText can contain an optional href property for the text to be rendered as a link.", + "oneOf": [ + { + "$ref": "file:///InfoBar.schema.json#/$defs/plainText" + }, + { + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText" + }, + { + "not": { + "required": [ + "href" + ] + } + } + ] + }, + { + "$ref": "file:///InfoBar.schema.json#/$defs/localizableTextWithHref" + }, + { + "$ref": "file:///InfoBar.schema.json#/$defs/rawTextWithHref" + }, + { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "file:///InfoBar.schema.json#/$defs/plainText" + }, + { + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText" + }, + { + "not": { + "required": [ + "href" + ] + } + } + ] + }, + { + "$ref": "file:///InfoBar.schema.json#/$defs/localizableTextWithHref" + }, + { + "$ref": "file:///InfoBar.schema.json#/$defs/rawTextWithHref" + } + ] + } + } + ] + }, + "priority": { + "description": "Infobar priority level https://searchfox.org/mozilla-central/rev/3aef835f6cb12e607154d56d68726767172571e4/toolkit/content/widgets/notificationbox.js#387", + "type": "number", + "minumum": 0, + "exclusiveMaximum": 10 + }, + "dismissable": { + "description": "Should the infobar include an X dismiss button, defaults to true", + "type": "boolean" + }, + "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": { + "dismiss": { + "type": "boolean", + "description": "Should the infobar be dismissed when the action is dispatched, defaults to true" + }, + "type": { + "type": "string", + "description": "Action dispatched by the button." + }, + "data": { + "type": "object" + } + }, + "required": [ + "type" + ], + "additionalProperties": true + }, + "supportPage": { + "type": "string", + "description": "A page title on SUMO to link to" + } + }, + "required": [ + "label", + "action" + ], + "additionalProperties": true + } + } + }, + "additionalProperties": true, + "required": [ + "text", + "buttons" + ] + }, + "template": { + "type": "string", + "const": "infobar" + } + }, + "additionalProperties": true, + "required": [ + "targeting", + "trigger" + ], + "$defs": { + "plainText": { + "description": "Plain text (no HTML allowed)", + "type": "string" + }, + "linkUrl": { + "description": "Target for links or buttons", + "type": "string", + "format": "uri" + }, + "localizableTextWithHref": { + "description": "Everything a localizableText allows, plus a required href", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText" + }, + { + "type": "object", + "properties": { + "href": { + "$ref": "file:///InfoBar.schema.json#/$defs/linkUrl" + } + }, + "required": [ + "href" + ], + "additionalProperties": true + } + ] + }, + "rawTextWithHref": { + "description": "A literal text chunk that must include href", + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "href": { + "$ref": "file:///InfoBar.schema.json#/$defs/linkUrl" + } + }, + "required": [ + "raw", + "href" + ], + "additionalProperties": false + } + } + }, + "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." + }, + "imageWidth": { + "type": "number", + "description": "The image width in pixels. Default is 120px." + }, + "imageVerticalTopOffset": { + "type": "number", + "description": "The margin-block-start value to apply to the image in pixels, used in 'column' layouts." + }, + "imageVerticalBottomOffset": { + "type": "number", + "description": "The margin-block-end value to apply to the image in pixels, used in 'row' layouts." + }, + "containerVerticalBottomOffset": { + "type": "number", + "description": "The container's margin-block-end value in pixels. Used to visually offset the image in 'row' layouts when 'imageVerticalBottomOffset' is applied." + }, + "layout": { + "type": "string", + "description": "The layout of the message content and illustration. Row displays the image to the inline to the right of the text, column displays the image above the text.", + "enum": [ + "row", + "column" + ] + } + } + }, + "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" + ] + }, + "NewtabMessage": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///NewtabMessage.schema.json", + "title": "NewtabMessage", + "description": "A template for messages that are rendered within newtab", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "messageType": { + "type": "string", + "description": "The subtype of the message." + } + }, + "additionalProperties": true, + "required": [ + "messageType" + ] + }, + "template": { + "type": "string", + "const": "newtab_message" + } + }, + "additionalProperties": true, + "required": [ + "targeting" + ] + }, + "Spotlight": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///Spotlight.schema.json", + "title": "Spotlight", + "description": "A template with an image, title, content and two buttons.", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "template": { + "type": "string", + "description": "Specify the layout template for the Spotlight", + "const": "multistage" + }, + "backdrop": { + "type": "string", + "description": "Background css behind modal content" + }, + "logo": { + "type": "object", + "properties": { + "imageURL": { + "type": "string", + "description": "URL for image to use with the content" + }, + "imageId": { + "type": "string", + "description": "The ID for a remotely hosted image" + }, + "size": { + "type": "string", + "description": "The logo size." + } + }, + "additionalProperties": true + }, + "screens": { + "type": "array", + "description": "Collection of individual screen content" + }, + "transitions": { + "type": "boolean", + "description": "Show transitions within and between screens" + }, + "disableEscClose": { + "type": "boolean", + "description": "Don't allow the message to be dismissed using the ESC key - for limited use in Spotlight modals only when the message content clearly informs the user that a decision is required to proceed" + }, + "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", + "newtab_message", + "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": [ + "newtab_message" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/NewtabMessage" + } + }, + { + "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/v140.4.0/schemas/toolkit/components/nimbus/schemas/NimbusTelemetryFeature.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v140.4.0/schemas/toolkit/components/nimbus/schemas/NimbusTelemetryFeature.schema.json new file mode 100644 index 0000000000..668236e81c --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v140.4.0/schemas/toolkit/components/nimbus/schemas/NimbusTelemetryFeature.schema.json @@ -0,0 +1,35 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "type": "object", + "properties": { + "gleanMetricConfiguration": { + "type": "object", + "properties": { + "metrics_enabled": { + "type": "object", + "patternProperties": { + "^nimbus_targeting_environment\\..*": { "type": "boolean" }, + "^nimbus_targeting_context\\..*": { "type": "boolean" }, + "^nimbus_events\\..*": { "type": "boolean" } + }, + "additionalProperties": false + } + }, + "additionalProperties": true + }, + "nimbusTargetingEnvironment": { + "type": "object", + "properties": { + "recordAttrs": { + "description": "A list of attributes that should be recorded in the nimbus_targeting_environment.targeting_context_value metric. If not provided, it will default to all attributes.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "additionalProperties": true + } + }, + "additionalProperties": true +} diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/v140.4.0/schemas/toolkit/components/nimbus/schemas/PrefFlipsFeature.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v140.4.0/schemas/toolkit/components/nimbus/schemas/PrefFlipsFeature.schema.json new file mode 100644 index 0000000000..9fa5acc7c9 --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v140.4.0/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/v140.4.0/schemas/toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v140.4.0/schemas/toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json new file mode 100644 index 0000000000..6915fc9b71 --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v140.4.0/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/firefox-desktop/v145.0.0/experimenter.yaml b/experimenter/experimenter/features/manifests/firefox-desktop/v145.0.0/experimenter.yaml new file mode 100644 index 0000000000..f046fd02a6 --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v145.0.0/experimenter.yaml @@ -0,0 +1,5265 @@ +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. + +# yaml-language-server: $schema=schemas/ExperimentFeatureManifest.schema.json + +# Features must be added here to be accessible through the NimbusFeature API. + +"no-feature-firefox-desktop": + description: A dummy feature for experiments that target no feature. + owner: beth@mozilla.com + applications: + - firefox-desktop + - firefox-desktop-background-task + hasExposure: false + allowCoenrollment: true + variables: {} + +testFeature: + description: Test only feature + owner: beth@mozilla.com + applications: + - firefox-desktop + - firefox-desktop-background-task + hasExposure: false + isEarlyStartup: true + variables: + enabled: + type: boolean + description: Whether or not this feature is enabled + testInt: + type: int + fallbackPref: nimbus.testing.testInt + description: Int pref used by platform API tests + testSetString: + type: string + setPref: + branch: user + pref: nimbus.testing.testSetString + description: A string pref set by Nimbus tests + +nimbus-qa-1: + description: A feature for testing pref-setting on the default branch. + owner: beth@mozilla.com + hasExposure: false + variables: + value: + type: string + setPref: + branch: default + pref: nimbus.qa.pref-1 + description: The value to set for the pref. + +nimbus-qa-2: + description: A feature for testing pref-setting on the user branch. + owner: beth@mozilla.com + hasExposure: false + variables: + value: + type: string + setPref: + branch: user + pref: nimbus.qa.pref-2 + description: The value to set for the pref. + +# Note: this feature is not for general use. If you want to run an experiment +# that sets prefs, you *must* register your feature in this manifest and specify +# the prefs you will control. +prefFlips: + description: Flip arbitrary prefs. Controlled by release management. + owner: beth@mozilla.com + hasExposure: false + allowCoenrollment: true + variables: + prefs: + type: json + description: "The prefs to set." + schema: + uri: resource://nimbus/schemas/PrefFlipsFeature.schema.json + path: toolkit/components/nimbus/schemas/PrefFlipsFeature.schema.json + +# TODO(bug 1972426): Remove this feature. +nimbusStore: + description: Configuration for the Nimbus ExperimentStore. + owner: beth@mozilla.com + hasExposure: false + variables: + dbEnabled: + type: boolean + description: > + If enabled, the NimbusEnrollments database table will be used as the + primary enrollment store. + setPref: + branch: user + pref: nimbus.profilesdatastoreservice.read.enabled + dbSyncEnabled: + type: boolean + description: > + If enabled, the RemoteSettingsExperimentLoader will trigger + unenrollments for experiments that are unenrolled in other profiles. + setPref: + branch: user + pref: nimbus.profilesdatastoreservice.sync.enabled + +search: + description: Search service related features. + owner: search-and-suggest-program@mozilla.com + hasExposure: true + exposureDescription: > + Exposure is recorded when the visual search context menu item is shown or + would have been shown. + variables: + scotchBonnetEnableOverride: + type: boolean + setPref: + branch: default + pref: browser.urlbar.scotchBonnet.enableOverride + description: >- + Whether or not enabling scotch bonnet feature. + If this variable is true, the following features are available as default. + * Unified search button + * Secondary action buttons + * Search term persistence + * Intuitive search keywords + * HTTP swap + trendingRequireSearchMode: + type: boolean + setPref: + branch: default + pref: browser.urlbar.trending.requireSearchMode + description: Controls whether trending suggestions are only shown in search mode or not. + trendingMaxResultsNoSearchMode: + type: int + setPref: + branch: default + pref: browser.urlbar.trending.maxResultsNoSearchMode + description: The maximum number of trending results mode outside search mode. + targetExperiment: + type: string + description: >- + Recorded in SERP telemetry, this is the slug of the experiment someone + is requesting enrollment and branch information for. (Note that the + featureId needs to be set to "search".) + visualSearchEnabled: + type: boolean + setPref: + branch: default + pref: browser.search.visualSearch.featureGate + description: >- + Feature gate for visual search. + +searchConfiguration: + description: >- + Search experimentation support for the engine configuration. Some of these + options may cause an additional reload to occur during the startup phase. + owner: search-and-suggest-program@mozilla.com + hasExposure: false + variables: + experiment: + type: string + setPref: + branch: user + pref: browser.search.experiment + description: >- + Used to activate only matching configurations that contain the value in + `experiment` + extraParams: + type: json + description: >- + This allows extra parameters to be set for search engines requests including, + where calls to the suggestions API, the search engine configuration defines + those parameters. + + The use of this field should be coordinated with the Search team. + + The field value is an array of objects with key/value fields. For example: + + [ + {"key": "google_channel_row", "value": "foo"} + ] + + This is matched to a section in the search configuration: + + "params": [ + { + "name": "channel", + "experimentConfig": "google_channel_row" + } + ], + + In this case, the resulting URL for the appropriate search engine would have + `&channel=foo` added to the URL when doing searches. + + If the key is not referenced in the search configuration, then no parameter + will be added. If the parameter is in the search configuration, but there + is no experiment, or the experiment does not set a value, then the + parameter will not be included in the search url. + + Only the search team can update the configuration. + separatePrivateDefaultUIEnabled: + type: boolean + setPref: + branch: user + pref: browser.search.separatePrivateDefault.ui.enabled + description: Whether the UI for the separate private default feature is enabled. + separatePrivateDefaultUrlbarResultEnabled: + type: boolean + setPref: + branch: user + pref: browser.search.separatePrivateDefault.urlbarResult.enabled + description: Whether the urlbar result for the separate private default is shown. + +urlbar: + description: The Address Bar + owner: search-and-suggest-program@mozilla.com + hasExposure: true + exposureDescription: >- + The timing of the exposure event depends on the experiment, but generally + the event is recorded once per app session when the user first encounters + the UI of the experiment in which they're enrolled. + variables: + actionsOnboardingTimesToShow: + type: int + fallbackPref: browser.urlbar.quickactions.timesToShowOnboardingLabel + description: >- + The number of times a user should be shown the actions onboarding label. + addonsFeatureGate: + type: boolean + fallbackPref: browser.urlbar.addons.featureGate + description: >- + Feature gate that controls whether all aspects of the addons suggestion + feature are exposed to the user. + addonsShowLessFrequentlyCap: + type: int + description: >- + If defined and non-zero, this is the maximum number of times the user + will be able to click the "Show less frequently" command for addon + suggestions. If undefined or zero, the user will be able to click the + command without any limit. + allowSearchSuggestionsForSimpleOrigins: + type: boolean + fallbackPref: browser.urlbar.allowSearchSuggestionsForSimpleOrigins + description: >- + Whether remote search suggestions should be fetched for search strings + that look like possible simple origins like "mozilla.org". Search + suggestions will remain prohibited for search strings that look like + more complex origins that include userinfo or ports or are IP addresses. + ampFeatureGate: + type: boolean + fallbackPref: browser.urlbar.amp.featureGate + description: >- + Feature gate that controls whether all aspects of the AMP suggestions + feature are exposed to the user. + ampMatchingStrategy: + type: int + fallbackPref: browser.urlbar.quicksuggest.ampMatchingStrategy + description: >- + The matching strategy for AMP suggestions. Leave undefined or set to + zero to use the usual default exact-keyword strategy. Otherwise set to + an integer value defined on `AmpMatchingStrategy` in + `RustSuggest.sys.mjs` (corresponding to the `AmpMatchingStrategy` enum + in the Rust component coerced to a 1-based integer value). + autoFillAdaptiveHistoryEnabled: + type: boolean + 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. + deduplicationEnabled: + type: boolean + setPref: + pref: browser.urlbar.deduplication.enabled + branch: user + description: >- + Feature gate that controls whether result deduplication in the urlbar + is enabled. + # TODO Bug 1982966: Remove this after all experiments and rollouts using it + # finish. + fakespotFeatureGate: + type: boolean + fallbackPref: browser.urlbar.fakespot.featureGate + description: >- + Feature gate that controls whether all aspects of the Fakespot suggestion + feature are exposed to the user. + importantDatesFeatureGate: + type: boolean + fallbackPref: browser.urlbar.importantDates.featureGate + description: >- + Feature gate that controls whether all aspects of the important dates + suggestion feature are exposed to the user. + keywordExposureResults: + type: string + setPref: + pref: browser.urlbar.keywordExposureResults + branch: user + description: >- + Comma-separated list of result types that should trigger + keyword-exposure telemetry. Keyword exposures can be recorded along with + result exposures. To enable keyword exposures for a result type, you + must add it both to this variable and to `exposureResults`. The only + exception is the "rust_exposure" result type, which can be added to this + variable even if it's not in `exposureResults` since it's enabled by + setting the `quickSuggestExposureSuggestionTypes` variable. Keyword + exposures are recorded in the `urlbar-keyword-exposure` ping. See that + ping's description for more. + marketFeatureGate: + type: boolean + fallbackPref: browser.urlbar.market.featureGate + description: >- + Feature gate that controls whether all aspects of the stock market + suggestions feature are exposed to the user. + mdnFeatureGate: + type: boolean + setPref: + branch: default + pref: browser.urlbar.mdn.featureGate + description: >- + Feature gate that controls whether all aspects of the mdn suggestion + feature are exposed to the user. + merinoClientVariants: + type: string + fallbackPref: browser.urlbar.merino.clientVariants + description: >- + Comma separated list of client variants to report to the Merino server. + May impact server behavior. + merinoEndpointURL: + type: string + fallbackPref: browser.urlbar.merino.endpointURL + description: >- + The Merino endpoint URL, not including parameters. An empty string will + cause Firefox not to fetch from Merino. + merinoOhttpConfigURL: + type: string + fallbackPref: browser.urlbar.merino.ohttpConfigURL + description: >- + OHTTP config URL for Merino requests. + merinoOhttpRelayURL: + type: string + fallbackPref: browser.urlbar.merino.ohttpRelayURL + description: >- + OHTTP relay URL for Merino requests. + merinoProviders: + type: string + fallbackPref: browser.urlbar.merino.providers + description: >- + Comma-separated list of providers to request from the Merino server. + Merino will return suggestions only for these providers. + merinoTimeoutMs: + type: int + fallbackPref: browser.urlbar.merino.timeoutMs + description: Timeout for Merino fetches (ms) + suggestOhttp: + type: boolean + description: >- + Whether search suggestions should be fetched over OHTTP. + Currently this applies only to Google suggestions. + setPref: + pref: browser.search.suggest.ohttp.featureGate + branch: user + exposureResults: + type: string + setPref: + pref: browser.urlbar.exposureResults + branch: user + description: >- + Comma-separated list of result types that should trigger exposure + telemetry, which is recorded in the `exposure` event. By default + exposure results are visible like usual, but they can be hidden by + setting the `showExposureResults` variable to false. To also record + keyword exposures for a result type, include it in the + `keywordExposureResults` variable as well. + showExposureResults: + type: boolean + setPref: + pref: browser.urlbar.showExposureResults + branch: user + description: >- + Boolean used to determine if the results defined in `exposureResults` should be shown in search results. Should be false for Control branch of an experiment. + quickSuggestAmpTopPickCharThreshold: + type: int + fallbackPref: browser.urlbar.quicksuggest.ampTopPickCharThreshold + description: >- + Character-count threshold (inclusive) for showing AMP suggestions as top + picks. If 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. + quickSuggestContextualOptInFirstReshowAfterPeriodDays: + type: int + setPref: + branch: default + pref: browser.urlbar.quicksuggest.contextualOptIn.firstReshowAfterPeriodDays + description: Period until reshow the Firefox Suggest contextual opt-in result when first dismissed. + quickSuggestContextualOptInSecondReshowAfterPeriodDays: + type: int + setPref: + branch: default + pref: browser.urlbar.quicksuggest.contextualOptIn.secondReshowAfterPeriodDays + description: Period until reshow the Firefox Suggest contextual opt-in result when second dismissed. + quickSuggestContextualOptInThirdReshowAfterPeriodDays: + type: int + setPref: + branch: default + pref: browser.urlbar.quicksuggest.contextualOptIn.thirdReshowAfterPeriodDays + description: Period until reshow the Firefox Suggest contextual opt-in result when third dismissed. + quickSuggestContextualOptInImpressionLimit: + type: int + setPref: + branch: default + pref: browser.urlbar.quicksuggest.contextualOptIn.impressionLimit + description: Limit for impression to dismiss the Firefox Suggest contextual opt-in result. + quickSuggestContextualOptInImpressionDaysLimit: + type: int + setPref: + branch: default + pref: browser.urlbar.quicksuggest.contextualOptIn.impressionDaysLimit + description: Days until dismiss the Firefox Suggest contextual opt-in result after first impression. + 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. + quickSuggestDynamicSuggestionTypes: + type: string + setPref: + pref: browser.urlbar.quicksuggest.dynamicSuggestionTypes + branch: user + description: >- + Comma-separated list of Suggest dynamic suggestion types to enable. Set + this variable to the `suggestion_type` defined in the remote settings + record that contains your suggestions. If you want to enable multiple + suggestion types, separate them with commas. One particular intended use + of this variable is to deliver hidden-exposure suggestions for testing + potential exposures. Hidden-exposure suggestions trigger exposure + telemetry based on a set of keywords you provide but they are never + visible. If you are testing multiple types of hidden-exposure + suggestions, consider using one experiment branch per type, especially + if you are also enabling keyword exposures. Exposure suggestions are + recorded in telemetry with the "rust_exposure" result type. It's not + necessary to include "rust_exposure" in `exposureResults`. Unless you + are testing other results in the same experiment branch, it's also not + necessary to set `showExposureResults: false`. To also record keyword + exposures, include "rust_exposure" in `keywordExposureResults`. + quickSuggestEnabled: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.enabled + description: >- + Gate for the Firefox Suggest feature as a whole. If false, the Firefox + Suggest preferences UI and Suggest suggestions will not be shown. If + true, the preferences UI will be shown, and the user can turn + suggestions on or off. + quickSuggestImpressionCapsSponsoredEnabled: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.impressionCaps.sponsoredEnabled + description: Whether sponsored suggestions are subject to impression frequency caps. If false, sponsored suggestions can be shown an unlimited number of times over any given period. If true, sponsored suggestion impressions will be subject to the caps in the remote settings configuration. + quickSuggestImpressionCapsNonSponsoredEnabled: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.impressionCaps.nonSponsoredEnabled + description: Whether non-sponsored suggestions are subject to impression frequency caps. If false, non-sponsored suggestions can be shown an unlimited number of times over any given period. If true, non-sponsored suggestion impressions will be subject to the caps in the remote settings configuration. + quickSuggestMlInitDelaySeconds: + type: int + fallbackPref: browser.urlbar.quicksuggest.mlInitDelaySeconds + description: >- + How long to wait in seconds after startup before initializing the + Suggest ML backend. + quickSuggestMlEnabled: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.mlEnabled + description: >- + Whether Suggest will use the ML backend in addition to Rust. + quickSuggestNonSponsoredEnabled: + type: boolean + description: 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 + quickSuggestRankingMode: + type: string + fallbackPref: browser.urlbar.quicksuggest.rankingMode + description: >- + Specify the ranking mode for QuickSuggest. + - "default": ranking by static scores specified by individual providers. + - "interest": ranking by relevance scores provided by `ContentRelevancyManager`. + - "random": ranking by randomly selecting a winner out of candidates. + Note that this ranking mode can still be overridden by `quickSuggestScoreMap`. + If the ranking mode is unspecified or set to any unknown values, it will default + to the static score based ranking. + enum: + - default + - interest + - random + quickSuggestScoreMap: + type: json + description: >- + A JSON object that maps telemetry result types to suggestion scores. If + a telemetry result type is present in this map, the client will use the + corresponding score as the score for all suggestions of the type, + overriding all other sources of scores for the type. In other words, + the scores in this map will override scores that are set in remote + settings and Merino as well as scores that are hardcoded in the client. + Example entries: `"amo": 0.5`, `"adm_sponsored": 0.9` + quickSuggestSettingsUi: + type: int + fallbackPref: browser.urlbar.quicksuggest.settingsUi + description: >- + When Suggest is enabled, this determines the Suggest settings that will + be visible in the settings UI (about:preferences). When Suggest is + disabled, this is ignored and Suggest settings are hidden. Possible + values: + 0: (default) Full, all settings will be shown. + 1: None, no settings will be shown. + 2: Offline only, settings that pertain to online will be hidden. + quickSuggestSponsoredEnabled: + type: boolean + description: Whether sponsored suggestions should be enabled by default. If this variable is specified, it will override the value implied by the scenario. It will never override the user's local preference to disable (or enable) sponsored suggestions, if the user has already toggled that preference. + quickSuggestSponsoredIndex: + type: int + fallbackPref: browser.urlbar.quicksuggest.sponsoredIndex + description: >- + The index of sponsored Firefox Suggest results within the Firefox Suggest + section when "Show search suggestions ahead of browsing history in + address bar results" is checked. When not checked, the index is hardcoded + as -1. Negative indexes are relative to the end of the section. + quickSuggestSponsoredPriority: + type: boolean + fallbackPref: browser.urlbar.quicksuggest.sponsoredPriority + description: >- + Whether or not showing sponsored suggestion as priority. + If this variable is true, the following things are processed. + * "Sponsored" label is shown as the group label. + * Change the suggested index to 1. + * Handle as top pick. + realtimeMinKeywordLength: + type: int + description: >- + The minimum prefix length of a realtime keyword the user must type to + trigger the suggestion. + realtimeShowLessFrequentlyCap: + type: int + description: >- + If defined and non-zero, this is the maximum number of times the user + will be able to click the "Show less frequently" command for realtime + suggestions. If undefined or zero, the user will be able to click the + command without any limit. + recentSearchesFeatureGate: + type: boolean + setPref: + branch: default + pref: browser.urlbar.recentsearches.featureGate + description: Gate for the recent searches feature. + recentSearchesMaxResults: + type: int + setPref: + branch: default + pref: browser.urlbar.recentsearches.maxResults + description: The maximum number of recent searches to show. + semanticHistoryEnable: + type: boolean + setPref: + branch: user + pref: places.semanticHistory.featureGate + description: use semanticHistory Search feature. + semanticHistoryCompletionThreshold: + type: string + setPref: + branch: user + pref: places.semanticHistory.completionThreshold + description: >- + Fraction (0.0 – 1.0) of top Places rows that must have embeddings + before semantic-history search is enabled. 0.5 = 50 %. + semanticHistoryDefaultBatchChunksize: + type: int + setPref: + branch: user + pref: places.semanticHistory.defaultBatchChunksize + description: >- + The batch chunk size for updates for vectorDB + defaulted at 25. + semanticHistoryDistanceThreshold: + type: string + setPref: + branch: user + pref: places.semanticHistory.distanceThreshold + description: >- + semantic similarity distance threshold (0.0 - 1.0) + defaulted at 0.6. + showDebuggingIcons: + type: boolean + setPref: + branch: user + pref: browser.urlbar.showDebuggingIcons + description: >- + Whether or not to show debugging badges on urlbar results favicons. + suggestSemanticHistoryMinLength: + type: int + setPref: + branch: user + pref: browser.urlbar.suggest.semanticHistory.minLength + description: >- + Minimum length of search query when history semantic + search will be enabled. + suggestCalculator: + type: boolean + setPref: + branch: user + pref: browser.urlbar.suggest.calculator + description: >- + Whether or not to show calculator results when a user types a valid + calculation string into the urlbar. + unitConversionEnabled: + type: boolean + setPref: + branch: user + pref: browser.urlbar.unitConversion.enabled + description: >- + Whether or not to show unit conversion results when a user types a + valid unit conversion string into the urlbar. + weatherFeatureGate: + type: boolean + fallbackPref: browser.urlbar.weather.featureGate + description: >- + Feature gate that controls whether all aspects of the weather suggestion + feature are exposed to the user. + weatherKeywordsMinimumLength: + type: int + description: >- + If defined and non-zero, the weather suggestion will be triggered by + typing any prefix of a full weather keyword when the prefix is at least + `weatherKeywordsMinimumLength` characters long. If this variable is + absent or zero, Firefox will fall back to the minimum length defined in + remote settings. If neither Nimbus nor remote settings defines a minimum + length, only full keywords will trigger the suggestion. + weatherShowLessFrequentlyCap: + type: int + description: >- + If defined and non-zero, this is the maximum number of times the user + will be able to click the "Show less frequently" command for weather + suggestions. If undefined or zero, the user will be able to click the + command without any limit. + weatherUiTreatment: + type: int + fallbackPref: browser.urlbar.weather.uiTreatment + description: >- + The UI treatment to use for weather suggestions. Possible values: + 0: (default) Simplest UI with current temperature and location + 1: Simpler UI, adds current conditions, high/low, and URL + 2: Full UI, adds forecast + wikipediaFeatureGate: + type: boolean + fallbackPref: browser.urlbar.wikipedia.featureGate + description: >- + Feature gate that controls whether all aspects of the Wikipedia + suggestions feature (part of Firefox Suggest) are exposed to the user. + yelpMinKeywordLength: + type: int + description: >- + The minimum prefix length of a Yelp keyword the user must type to + trigger the suggestion. + yelpMlEnabled: + type: boolean + fallbackPref: browser.urlbar.yelp.mlEnabled + description: >- + Whether Yelp suggestions will be served from the Suggest ML backend + instead of Rust. + yelpFeatureGate: + type: boolean + fallbackPref: browser.urlbar.yelp.featureGate + description: >- + Feature gate that controls whether all aspects of the Yelp suggestion + feature are exposed to the user. + yelpServiceResultDistinction: + type: boolean + fallbackPref: browser.urlbar.yelp.serviceResultDistinction + description: >- + Whether to distinguish service type subjects. If true, we show special + titile for the suggestion. + yelpShowLessFrequentlyCap: + type: int + fallbackPref: browser.urlbar.yelp.showLessFrequentlyCap + description: >- + If defined and non-zero, this is the maximum number of times the user + will be able to click the "Show less frequently" command for Yelp + suggestions. If undefined or zero, the user will be able to click the + command without any limit. + yelpSuggestNonPriorityIndex: + type: int + description: >- + The group-relative suggestedIndex of Yelp suggestions within the Firefox + Suggest section. Ignored when `yelpSuggestPriority` is true. + yelpSuggestPriority: + type: boolean + fallbackPref: browser.urlbar.yelp.priority + description: >- + Whether or not showing yelp suggestion as priority. + If this variable is true, the following things are processed. + * Change the suggested index to 1. + * Handle as top pick. + yelpRealtimeFeatureGate: + type: boolean + fallbackPref: browser.urlbar.yelpRealtime.featureGate + description: >- + Feature gate that controls whether all aspects of Yelp realtime suggestions + feature are exposed to the user. + originsAlternativeEnable: + description: >- + Use an alternative ranking algorithm for autofilling origins, that is + mainly domains of Web pages. When the user types the beginning of an + origin, we autofill the whole origin. Whether autofill happens depends + on the ranking algorithm. Bookmarks are always autofilled anyway. + type: boolean + setPref: + branch: user + pref: "places.frecency.origins.alternative.featureGate" + originsDaysCutOff: + description: >- + The alternative ranking algorithm only considers pages visited in the + last N days, where N is controlled by this variable. + type: int + setPref: + branch: user + pref: "places.frecency.origins.alternative.daysCutOff" + pagesAlternativeEnable: + description: >- + Use an alternative ranking algorithm for sorting history and bookmarks + among the urlbar results. + type: boolean + setPref: + branch: user + pref: "places.frecency.pages.alternative.featureGate" + pagesNumSampledVisits: + description: >- + The number of recent visits to sample when calculating the ranking of + a page. Examining all the visits would be expensive, so we only sample + recent visits. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.numSampledVisits" + pagesHalfLifeDays: + description: >- + The number of days after which the ranking halves. This implements the + "recency" part of the algorithm. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.halfLifeDays" + pagesMaxVisitGap: + description: >- + The maximum allowed time (in seconds) between when a visit was recorded + and when an interaction occurs for them to be paired. This accounts + for slight discrepancies in their timestamps. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.interactions.maxVisitGapSeconds" + pagesViewTimeSeconds: + description: >- + The minimum allowed time (in seconds) a page was viewed before upgrading + the score of a visit. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.interactions.viewTimeSeconds" + pageViewTimeIfManyKeypressesSeconds: + description: >- + The minimum allowed time (in seconds) a page was viewed before checking + the manyKeypresses threshold. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.interactions.viewTimeIfManyKeypressesSeconds" + manyKeypresses: + description: >- + The minimum number of keypresses typed before upgrading the score + of a visit. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.interactions.manyKeypresses" + pagesVeryHighWeight: + description: >- + The weight to use for the very high importance bucket. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.veryHighWeight" + pagesHighWeight: + description: >- + The weight to use for the high importance bucket. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.highWeight" + pagesMediumWeight: + description: >- + The weight to use for the medium importance bucket. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.mediumWeight" + pagesLowWeight: + description: >- + The weight to use for the low importance bucket. + type: int + setPref: + branch: user + pref: "places.frecency.pages.alternative.lowWeight" + +aboutwelcome: + description: "The about:welcome page" + owner: omc@mozilla.com + hasExposure: true + exposureDescription: >- + Exposure is sent once per browsing session when the about:welcome URL is + first accessed. + isEarlyStartup: true + variables: + enabled: + type: boolean + fallbackPref: browser.aboutwelcome.enabled + description: >- + Should users see about:welcome? If this is false, users will see a + regular new tab instead. + id: + type: string + description: >- + Descriptive ID for the about:welcome content + screens: + type: json + fallbackPref: browser.aboutwelcome.screens + description: Content to show in the onboarding flow + languageMismatchEnabled: + type: boolean + fallbackPref: intl.multilingual.aboutWelcome.languageMismatchEnabled + description: >- + Suggest to change the language on about:welcome when there is a mismatch with + the OS. + transitions: + type: boolean + description: Enable transition effect between screens + backdrop: + type: string + fallbackPref: browser.aboutwelcome.backdrop + description: >- + Specify the color to be used to update the background color + toolbarButtonEnabled: + type: boolean + setPref: + branch: user + pref: browser.aboutwelcome.toolbarButtonEnabled + description: >- + Should the return to about:welcome toolbar button be shown + +preonboarding: + description: "A modal that shows on first startup, typically on top of about:welcome" + owner: omc@mozilla.com + # Exposure is recorded by the spotlight feature used to show the modal + hasExposure: false + # Needed at `sessionstore-windows-restored`. + isEarlyStartup: true + variables: + enabled: + type: boolean + fallbackPref: browser.preonboarding.enabled + description: >- + Should users see the preonboarding modal? + screens: + type: json + fallbackPref: browser.preonboarding.screens + description: Content to show in the onboarding flow + requireAction: + type: boolean + fallbackPref: browser.preonboarding.requireAction + description: >- + When showModal is enabled, should action be required to proceed (show as a window modal with dismiss using the ESC key disabled)? + currentVersion: + type: int + fallbackPref: termsofuse.currentVersion + description: >- + The current policy version displayed by this preonboarding modal. + minimumVersion: + type: int + fallbackPref: termsofuse.minimumVersion + description: >- + The minimum policy version which the user must have accepted to not see + the preonboarding modal. In some cases, the minimum version could be + lower than the current version if the newer version(s) is not + substantially different enough to warrant asking users to accept the TOU + again. + firstRunURL: + type: string + fallbackPref: datareporting.policy.firstRunURL + description: >- + URL of browser tab to be opened on first run instead of infobar. + +moreFromMozilla: + description: "New page on about:preferences to suggest more Mozilla products" + owner: omc@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 + +newtabAdSizingExperiment: + description: >- + Change the default ad size and UI for certain ad formats. + owner: achurchwell@mozilla.com, sdowne@mozilla.com, mcrawford@mozilla.com + hasExposure: false + variables: + leaderboard: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabAdSize.leaderboard + description: >- + Leaderboard ad size and UI. + leaderboard_position: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabAdSize.leaderboard.position + description: >- + Leaderboard row position. + billboard: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabAdSize.billboard + description: >- + Billboard ad size and UI. + billboard_position: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabAdSize.billboard.position + description: >- + Billboard row position. + medium_rectangle: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabAdSize.mediumRectangle + description: >- + Medium rectangle (MREC) ad size and UI. + +newtabPromoCard: + description: the promo card that appears next to the ad banner + owner: achurchwell@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Turns on and off the promo card. + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.promoCard.enabled + +newtabAdsReporting: + description: about:newtab reporting ads feature + owner: rhamoui@mozilla.com + hasExposure: false + variables: + reportAdsEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.reportAds.enabled + description: >- + Enable reporting for ads + +newtabContextualContent: + description: about:newtab contextual content feed + owner: nbarrett@mozilla.com + hasExposure: false + variables: + contextualContentEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.contextualContent.enabled + description: >- + Override the contextual content enabled value set via region/locale + localeContextualContentConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.contextualContent.locale-content-config + description: >- + A comma-separated list of locales that get contextual content by default. + regionContextualContentConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.contextualContent.region-content-config + description: >- + A comma-separated list of regions that get contextual content by default. + contextualContentFeeds: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.contextualContent.feeds + description: >- + CSV list of possible feeds for the contextual content feed + contextualContentSelectedFeed: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.contextualContent.selectedFeed + description: >- + currently selected feed to display in the Contextual Content component + +newtabCustomWallpaper: + description: >- + Modify the wallpaper selection feature to support user-uploaded custom wallpaper images + owner: mcrawford@mozilla.com + hasExposure: false + variables: + uploadWallpaper: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.customWallpaper.enabled + description: >- + Turns on and off ability to upload a custom wallpaper. + colorPicker: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.customColor.enabled + description: >- + Turns on and off background color picker. + maxFileSizeEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.customWallpaper.fileSize.enabled + description: >- + Turns on and off maximum file size for uploaded images + maxFileSize: + type: int + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.customWallpaper.fileSize + description: >- + Maximum file size (in MB) a user can upload + +newtabGroupedSponsoredControls: + description: >- + Adjust sponsored content controls on newtab. + owner: mcrawford@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.system.showSponsoredCheckboxes + description: >- + When true, checkboxes for sponsored results in top sites and recommended stories are grouped separately + on about:preferences#home + +newtabInlineTopicSelection: + description: >- + Adds Inline topic selection to sections layout + owner: nbarrett@mozilla.com + hasExposure: false + variables: + TopicSelectionEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.interestPicker.enabled + description: >- + Enables inline topic selection + +newtabMarsOhttp: + description: Sending request to MARS over OHTTP in newtab + owner: nbarrett@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.unifiedAds.ohttp.enabled + description: >- + Enables using OHTTP for unified ads API requests + +newtabMerinoOhttp: + description: Sending request to merino over OHTTP in newtab + owner: nbarrett@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.merino-provider.ohttp.enabled + description: >- + Enables using OHTTP for merino content requests + +newtabOhttpImages: + description: Sending request to MARS over OHTTP in newtab + owner: nbarrett@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: >- + Enables using OHTTP for images + includeTopStoriesSection: + type: boolean + description: >- + Enables using OHTTP for top stories section if enabled for images + +newtabMobileDownloadPromotion: + description: Cross-sell promotion to download Firefox for mobile + owner: mcrawford@mozilla.com + hasExposure: false + variables: + showModal: + type: boolean + description: Display mobile download modal to users until dismissed + setPref: + branch: user + pref: browser.newtabpage.activity-stream.mobileDownloadModal.enabled + variantA: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.mobileDownloadModal.variant-a + description: >- + Variant A modal message and QR code. + variantB: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.mobileDownloadModal.variant-b + description: >- + Variant B modal message and QR code. + variantC: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.mobileDownloadModal.variant-c + description: >- + Variant C modal message and QR code. + +newtabPrivatePing: + description: The newtab-content ping, sent through OHTTP + owner: nbarrett@mozilla.com + hasExposure: false + variables: + privatePingEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.telemetry.privatePing.enabled + description: >- + Enables the private newtab-content ping sent through OHTTP + redactNewtabPing: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.telemetry.privatePing.redactNewtabPing.enabled + description: >- + Provides an option to redact content ids of users from click, impression and related events in the NewTab ping. Should be enabled when data colection has shefted to the more private NewTab_content ping. + includeInferredInterests: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.telemetry.privatePing.inferredInterests.enabled + description: >- + Includes a differentially private intrest vector of general topical interests based on New Tab clicks. Only sent when user has enabled personalization. + maxSubmissionDelayMs: + type: int + setPref: + branch: user + pref: browser.newtabpage.activity-stream.telemetry.privatePing.maxSubmissionDelayMs + description: >- + The maximum range for the random delay from scheduling the newtab-content ping to actually sending it. The minimum is 1000 by default. This is in milliseconds. + +newtabPublisherFavicons: + description: Enabled publihser favicons on cards in newtab + owner: nbarrett@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.publisherFavicon.enabled + description: Enables publisher favicons on cards in newtab + +newtabRefinedCardsLayout: + description: Enable layout and styling refinements for content and ad cards across different card sizes + owner: rhamoui@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.refinedCardsLayout.enabled + description: Enables the refined cards layout for newtab + +newTabSectionsExperiment: + description: about:newtab section UI update + owner: nbarrett@mozilla.com, mcrawford@mozilla.com + hasExposure: false + variables: + sectionsEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.enabled + description: >- + Enable the Section UI for recommended stories on newtab + cardRefreshThumbsUpDownEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.cards.thumbsUpDown.enabled + description: >- + Enable the thumbs up/down buttons in the revised pocket story + card UI in recommended stories on newtab + cardRefreshEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.cards.enabled + description: >- + Enable the revised pocket story card UI in recommended stories on newtab + regionPersonalizationInferredConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.personalization.inferred.region-config + description: >- + A comma-separated list of regions that use inferred personalization. + localePersonalizationInferredConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.personalization.inferred.locale-config + description: >- + A comma-separated list of locales that use inferred personalization. + personalizationInferredEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.personalization.inferred.enabled + description: >- + Enable the inferred personalization for topics + localeSectionstConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.locale-content-config + description: >- + A comma-separated list of locales that get contextual content by default. + regionSectionsConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.region-content-config + description: >- + A comma-separated list of regions that get contextual content by default. + sectionsPersonalization: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.personalization.enabled + description: >- + Enable personalized sections layout. Allow users to follow/unfollow topic sections. + sectionsCustomizeMenuPanel: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.customizeMenuPanel.enabled + description: >- + Enable personalized sections menu panel. Allow users to follow/unfollow topic sections. + sectionsContextualAdsEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.contextualAds.enabled + description: >- + Enable contextual ads in sections. + regionSectionsContextualAdsConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.contextualAds.region-config + description: >- + A comma-separated list of regions that get contextual ads by default. + localeSectionsContextualAdsConfig: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.sections.contextualAds.locale-config + description: >- + A comma-separated list of locales that get contextual ads by default. + contextualSpocPlacements: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.placements.contextualSpocs + description: CSV string of spoc placement ids on newtab Pocket grid. A placement id tells our ad server where the ads are intended to be displayed. + contextualSpocCounts: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.placements.contextualSpocs.counts + description: CSV string of spoc placement counts on newtab Pocket grid. The count tells the ad server how many ads to return for this position and placement. + contextualBannerPlacements: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.placements.contextualBanners + description: CSV string of the banner placement ids on newtab Pocket grid. This placement id tells us which banner is visible when contexual ads are on. + contextualBannerCounts: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.placements.contextualBanners.counts + description: CSV string of AdBanner placement counts on newtab Pocket grid. The count tells the ad server how many banners to return for this position and placement. + +newtabInferredPersonalization: + description: about:newtab inferred content personalization settings + owner: rrando@mozilla.com + hasExposure: false + variables: + iv_refresh_frequency_hours: + type: int + description: >- + Time to refresh interest vector in hours + iv_unary_dp_in_request: + type: boolean + description: >- + Whether to use Unary encoding with differential privacy in the interest vector. If false or not set, we default to laplace noise with real values + + +newtabSmartShortcuts: + description: about:newtab personalized shortcuts + owner: rhamoui@mozilla.com, sdowne@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: >- + Enable personalized shortcuts + force_log: + type: boolean + description: >- + Enable logging of shortcut interactions independent of ranking + over_sample_multiplier: + type: int + description: >- + Controls how many multiples of the frecent we sample before reranking + positive_prior: + type: int + description: >- + Alpha in shortcut thompson sampling, exploit faster + negative_prior: + type: int + description: >- + Beta in shortcut thompson sampling, explore longer + thom_weight: + type: int + description: >- + Percentage weight of thompson sampling + frec_weight: + type: int + description: >- + Percentage weight of frecency + hour_weight: + type: int + description: >- + Percentage weight of hourly seasonality + daily_weight: + type: int + description: >- + Percentage weight of daily seasonality + bmark_weight: + type: int + description: >- + Percentage weight of is_bookmark + rece_weight: + type: int + description: >- + Percentage weight of recency + freq_weight: + type: int + description: >- + Percentage weight of frequency + refre_weight: + type: int + description: >- + Percentage weight of redone frecency + bias_weight: + type: int + description: >- + Percentage weight for bias for computing final ranking + fset: + type: int + description: >- + Key for smartshortcuts feature set + eta: + type: int + description: >- + Learning rate for shortcut ranking weights, will divide by 10000 + click_bonus: + type: int + description: >- + bonus multiplier for clicks, will divide by 10 + +newtabSpocsCache: + description: The about:newtab sponsored content cache. + owner: sdowne@mozilla.com + hasExposure: false + variables: + spocsCacheTimeout: + type: int + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.spocs.cacheTimeout + description: >- + Set sponsored content cache timeout in minutes. + spocsStartupCache: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.spocs.startupCache.enabled + description: >- + Controls if spocs should be included in startup cache. + +newtabSponsoredContent: + description: >- + Change and control the sponsored content on newtab. + owner: sdowne@mozilla.com + hasExposure: false + variables: + spocPositions: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.spoc-positions + description: CSV string of spoc position indexes on newtab Pocket grid + spocPlacements: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.placements.spocs + description: CSV string of spoc placement ids on newtab Pocket grid. A placement id tells our ad server where the ads are intended to be displayed. + spocCounts: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.placements.spocs.counts + description: CSV string of spoc placement counts on newtab Pocket grid. The count tells the ad server how many ads to return for this position and placement. + tilesPlacements: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.placements.tiles + description: CSV string of tiles placement ids on newtab tiles section. A placement id tells our ad server where the ads are intended to be displayed. + tilesCounts: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.placements.tiles.counts + description: CSV string of tiles placement counts on newtab tiles section. The count tells the ad server how many ads to return for this position and placement. + +newtabTrainhop: + description: Experiment feature for the train-hopping newtab extension. + owner: mconley@mozilla.com + hasExposure: false + allowCoenrollment: true + variables: + type: + type: string + description: A discriminant to tell different kinds of trainhop experiments apart. + payload: + type: json + description: The experiment configuration. + +newtabTrainhopAddon: + description: Enable download updated newtab resources packaged as an xpi + owner: mconley@mozilla.com + hasExposure: true + exposureDescription: | + Exposure is sent when the trainhop addon version is in use (starting from the browser startup + right after it has been downloaded and installed). + variables: + xpi_download_path: + type: string + description: | + Provide the path (relative to the base URL set in the `browser.newtabpage.trainhopAddon.xpiBaseURL` + about:config pref) from which the xpi should be downloaded. + addon_version: + type: string + description: | + Expected addon version (installing the xpi is cancelled if it mismatches the one set here). + The trainhop add-on version is also stored in an about:config pref, to be used on early + application startup to determine if the trainhop add-on version should be uninstalled + (and not be used for the newtab resources mapping to safely uninstall it later in the + same application session). + setPref: + branch: user + pref: browser.newtabpage.trainhopAddon.version + +newtabTrendingSearchWidget: + description: >- + Adds trending search results widget to new tab + owner: nbarrett@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.system.trendingSearch.enabled + description: Enables the refined cards layout for newtab + variant: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.trendingSearch.variant + description: Determines the layout variant for the trending search widget + +newtabTopicSelection: + description: the about:newtab topic selection experience. + owner: nbarrett@mozilla.com + hasExposure: false + variables: + availableTopics: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.topicSelection.topics + description: >- + List of available topics to select for topic selection + suggestedTopics: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.topicSelection.suggestedTopics + description: >- + List of pre-selected topics to display on first run of topic selection modal + topicSelectionOnboarding: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.topicSelection.onboarding.enabled + description: >- + Turns on and off topic selection onbaording + regionTopicsConfig: + description: A comma-separated list of regions that get topics selection by default. + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.topicSelection.region-topics-config + localeTopicsConfig: + description: A comma-separated list of locales that get topics selection by default. + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.topicSelection.locale-topics-config + regionTopicLabelConfig: + description: A comma-separated list of regions that get topic labels by default. + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.topicLabels.region-topic-label-config + localeTopicLabelConfig: + description: A comma-separated list of locales that get topic Labels by default. + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.topicLabels.locale-topic-label-config + +newtabUnifiedAds: + description: Mozilla Ad Routing Service (MARS) unified ads service + owner: mcrawford@mozilla.com, sdowne@mozilla.com + hasExposure: false + variables: + unifiedAdsEndpoint: + description: The URL for the MARS API endpoint. + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.unifiedAds.endpoint + unifiedAdsSpocsEnabled: + type: boolean + description: >- + Enable MARS endpoint to serve ads for recommended stories + setPref: + branch: user + pref: browser.newtabpage.activity-stream.unifiedAds.spocs.enabled + unifiedAdsTilesEnabled: + type: boolean + description: >- + Enable MARS endpoint to serve content for top sites tiles + setPref: + branch: user + pref: browser.newtabpage.activity-stream.unifiedAds.tiles.enabled + unifiedAdsFeedEnabled: + type: boolean + description: >- + Enable AdsFeed to manage all ads request/serving logic + setPref: + branch: user + pref: browser.newtabpage.activity-stream.unifiedAds.adsFeed.enabled + unifiedAdsFeedTilesEnabled: + type: boolean + description: >- + Enable AdsFeed to query MARS server to fetch/serve top sites tiles + setPref: + branch: user + pref: browser.newtabpage.activity-stream.unifiedAds.adsFeed.tiles.enabled + +newtabWidgets: + description: about:newtab widgets feature + owner: mcrawford@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: >- + Enable all widgets + listsEnabled: + type: boolean + description: >- + Enable Lists widget + timerEnabled: + type: boolean + description: >- + Enable Focus Timer widget + listsBadgeEnabled: + type: boolean + description: >- + Show badge on Lists widget to indicate new/beta feature + listsBadgeLabel: + type: string + description: >- + Label type for Lists widget badge (New or Beta) + +pocketNewtab: + description: The Pocket section in newtab + owner: sdowne@mozilla.com + hasExposure: false + isEarlyStartup: true + variables: + 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 + hideDescriptions: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.hideDescriptions.enabled + description: >- + Hide or display descriptions for Pocket stories on newtab. + hideDescriptionsRegions: + type: string + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.hideDescriptionsRegions + description: >- + CSV string of regions that hide descriptions for Pocket stories on newtab. + compactGrid: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.compactGrid.enabled + description: >- + Reduce the number of pixels between the Pocket cards on newtab. + compactImages: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.compactImages.enabled + description: >- + Reduce the height on Pocket card images on newtab. + imageGradient: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.imageGradient.enabled + description: >- + Add a gradient to the bottom of Pocket card images on newtab to blend the + image in with the card. + titleLines: + type: int + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.titleLines + description: >- + Changes the maximum number of lines a title can be for Pocket cards on newtab. + descLines: + type: int + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.descLines + description: >- + Changes the maximum number of lines a description can be for Pocket cards on newtab. + readTime: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.readTime.enabled + description: >- + Displays an estimated read time for Pocket cards on newtab. + newSponsoredLabel: + type: boolean + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.newSponsoredLabel.enabled + description: >- + Updates the sponsored label position to below the image for Pocket cards on newtab. + wallpapers: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.enabled + description: >- + Turns on and off wallpaper support. + wallpapersHighlightEnabled: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.highlightEnabled + description: >- + Turns on and off wallpaper feature highlight. + wallpaperHighlightHeaderText: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.highlightHeaderText + description: >- + Changes the wallpaper feature highlight header + wallpaperHighlightContentText: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.highlightContentText + description: >- + Changes the wallpaper feature highlight content + wallpaperHighlightCtaText: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.highlightCtaText + description: >- + Changes the wallpaper feature highlight cta + currentWallpaper: + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.newtabWallpapers.wallpaper + description: >- + Changes the currently selected wallpaper + weatherLocationSearch: + type: boolean + setPref: + branch: user + pref: browser.newtabpage.activity-stream.weather.locationSearchEnabled + description: >- + Turns on and off location search for newtab weather widget + 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 + regionStoriesConfig: + description: A comma-separated list of region to get stories for. + type: string + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.region-stories-config + merinoProviderEndpoint: + type: string + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.merino-provider.endpoint + description: Merino endpoint to use for recommendations. + regionStoriesBlock: + description: A comma-separated list of regions that do not get stories, regardless of locale-list-config. + type: string + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.region-stories-block + localeListConfig: + description: A comma-separated list of locales that get stories, regardless of region-stories-config. + type: string + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.locale-list-config + regionSpocsConfig: + description: A comma-separated list of regions that get spocs by default. + type: string + fallbackPref: >- + browser.newtabpage.activity-stream.discoverystream.region-spocs-config + regionWeatherConfig: + description: A comma-separated list of regions that get weather by default. + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.region-weather-config + localeWeatherConfig: + description: A comma-separated list of locales that weather widget supports. + type: string + setPref: + branch: user + pref: browser.newtabpage.activity-stream.discoverystream.locale-weather-config + topSitesMaxSponsored: + # Defined under `pocketNewtab` as it needs to be used along with other variables + type: int + description: The maximum number of sponsored Top Sites to be displayed + topSitesContileMaxSponsored: + # Defined under `pocketNewtab` as it needs to be used along with other variables + type: int + description: The maximum number of sponsored Top Sites used from Contile + 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 + 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: + enabled: + type: boolean + setPref: + branch: user + pref: extensions.pocket.enabled + description: Enabled save to Pocket feature. + emailButton: + type: boolean + setPref: + branch: user + pref: extensions.pocket.refresh.emailButton.enabled + description: Just for the new Pocket panels, enables the email signup button. + 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 + +sessionRestore: + description: Session restore feature + owner: sfoster@mozilla.com + hasExposure: false + variables: + startupBehavior: + type: int + setPref: + branch: user + pref: browser.startup.page + description: | + Should we resume the previous session? Startup behavior is a choice of 4 possible values: + 0 = open a blank tab, + 1 = open the configured homepage in a tab (default, session restore disabled), + 2 = open last visited page in a tab, + 3 = re-open previous windows and tabs (session restore enabled) + +screenshots: + description: The built-in Screenshots feature + owner: sfoster@mozilla.com + hasExposure: false + variables: + buttonOnToolbarByDefault: + type: boolean + description: The screenshots button will be placed on the toolbar by default. + +password-autocomplete: + description: A special autocomplete UI for password fields. + owner: sgalich@mozilla.com + hasExposure: false + variables: + directMigrateSingleProfile: + type: boolean + description: Enable direct migration? + +# Experiment for different Relay UI treatments. Variations at: +# https://www.figma.com/design/gnyElr1Wtce3RdQT54y8kS/Relay-%26-Firefox-Integration?node-id=316-2024&node-type=canvas&t=A3iAuevSTtwXeFxb-0 +email-autocomplete-relay: + description: Relay UI for email fields. + exposureDescription: Exposure is sent each time a user sees the Relay autocomplete dropdown item + hasExposure: true + owner: lcrouch@mozilla.com + variables: + firstOfferVersion: + type: string + description: Which Relay UI treatment to show + fallbackPref: signon.firefoxRelay.firstOfferVersionFallback + showToAllBrowsers: + type: boolean + setPref: + branch: user + pref: signon.firefoxRelay.showToAllBrowsers + description: Whether to show Relay to Firefox users who are NOT signed into FXA. + +# 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: true + exposureDescription: "Exposure is sent when an address is autofilled." + 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 + enableSignatureEditor: + description: Set to true to enable the signature editor + type: boolean + setPref: + branch: default + pref: pdfjs.enableSignatureEditor + +# 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: {} + +fxms-message-12: + description: "Firefox Messaging System message 12 - ONLY for Fx140+ targeting" + 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-13: + description: "Firefox Messaging System message 13 - ONLY for Fx140+ targeting" + 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-14: + description: "Firefox Messaging System message 14 - ONLY for Fx140+ targeting" + 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-15: + description: "Firefox Messaging System message 15 - ONLY for Fx140+ targeting" + 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. + +backgroundUpdateCheckPolicy: + description: >- + Control when to 'allow' and when to 'throttle' the background update task so + that the task runs but does not necessarily check for updates. The check + policy allows to tell the background update task to not check for, download, + and apply, updates in certain situations, thereby reducing update-related + operational costs. It also allows to limit the number of actions taken in + any given interval, thereby reducing user resource usage and Nimbus-related + operational costs. + owner: install-update@mozilla.com + applications: + - firefox-desktop-background-task + hasExposure: false + variables: + throttleEnabled: + type: boolean + fallbackPref: app.update.background.checkPolicy.throttleEnabled + description: >- + When true, the background update task will 'throttle' itself and not + necessarily check for updates. + throttleAfterDays: + type: int + fallbackPref: app.update.background.checkPolicy.throttleAfterDays + description: >- + When greater than or equal to 0, the number of consecutive days that the + background update task will run and check for updates when the task has + not witnessed a Firefox browsing profile running. N.b.: when 0, this + will disable the background update task checking for updates entirely. + throttleDebouncePeriodInHours: + type: int + fallbackPref: app.update.background.checkPolicy.throttleDebouncePeriodInHours + description: >- + When greater than 0, limit the background update task, when it is + throttled, from taking any action at all to at most one (1) time in + every "period" hours. That is, if `throttledDebouncePeriodInHours=24` + and the background update task executes at time `t0`, then the + background update task will exit without further action every invocation + at time `t1 < t0 + 24 hours`. + +pictureinpicture: + description: Message for first time Picture-in-Picture users + owner: nbaumgardner@mozilla.com + hasExposure: true + exposureDescription: Exposure is sent when a user hovers over a video and Picture-in-Picture has not been used before + variables: + title: + type: string + description: The title to be used for the PiP toggle + message: + type: string + description: The message to be used in the PiP toggle + showIconOnly: + type: boolean + description: Whether to show the first time PiP toggle or show the PiP icon only + oldToggle: + type: boolean + description: Whether to show the control style (true) or variant style (false) for the first time PiP toggle + displayDuration: + type: int + description: Duration of PiP first time toggle display in days before switching to PiP icon toggle + +glean: + description: "The Glean data-control-plane feature within Firefox Desktop for controlling metric configuration" + owner: glean-team@mozilla.com + applications: + - firefox-desktop + - firefox-desktop-background-task + hasExposure: false + allowCoenrollment: true + variables: + gleanMetricConfiguration: + type: json + description: | + A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric. + This variable is intended for interacting with the Glean data-control-plane via the Server Knobs functionality + to remotely configure metrics to be enabled or disabled. + +gleanInternalSdk: + description: "The Glean internal SDK feature intended only for internal Glean Team use" + owner: glean-team@mozilla.com + applications: + - firefox-desktop + - firefox-desktop-background-task + hasExposure: false + variables: + finalInactive: + type: "boolean" + description: "Enables FOG early shutdown pings when true" + setPref: + branch: user + pref: telemetry.glean.internal.finalInactive + gleanMetricConfiguration: + type: json + description: | + A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric. + This is not for public use! For data-control-plane use, please refer to the Glean documentation and use the + `gleanMetricConfiguration` found in the `glean` feature for this. + gleanMaxPingsPerMinute: + type: int + description: >- + Maximum number of pings that can be sent in a 60 second interval + setPref: + branch: user + pref: telemetry.glean.internal.maxPingsPerMinute + +browserLowMemoryPrefs: + description: Prefs which control the browser's behaviour under low memory. + owner: haftandilian@mozilla.com + hasExposure: false + variables: + lowMemoryResponseMask: + description: Control the response on macOS when under memory pressure. + type: int + setPref: + branch: default + pref: "browser.lowMemoryResponseMask" + lowMemoryResponseOnWarn: + description: Controls which macOS memory-pressure levels trigger the browser low memory response. + type: boolean + setPref: + branch: default + pref: "browser.lowMemoryResponseOnWarn" + tabsUnloadOnLowMemory: + description: Whether to unload tabs when available memory is running low. + type: boolean + setPref: + branch: default + pref: "browser.tabs.unloadOnLowMemory" + +echPrefs: + description: Prefs that control Encrypted Client Hello. + owner: djackson@mozilla.com + hasExposure: false + variables: + tlsEnabled: + description: Whether to enable ECH for connections using TLS + type: boolean + setPref: + branch: default + pref: "network.dns.echconfig.enabled" + h3Enabled: + description: Whether to enable ECH for connections using H3/QUIC + type: boolean + setPref: + branch: default + pref: "network.dns.http3_echconfig.enabled" + forceWaitHttpsRR: + description: Whether to force waiting for HTTPS DNS records, which ECH requires. + type: boolean + setPref: + branch: default + pref: "network.dns.force_waiting_https_rr" + insecureFallback: + description: Whether to fallback to non-ECH connections if all ECH RRs fail. + type: boolean + setPref: + branch: default + pref: "network.dns.echconfig.fallback_to_origin_when_all_failed" + tlsGreaseProb: + description: Probability of GREASEing a TLS connection with ECH (0-100). + type: int + setPref: + branch: default + pref: "security.tls.ech.grease_probability" + h3GreaseEnabled: + description: Whether to apply GREASE settings to H3/QUIC connections. + type: boolean + setPref: + branch: default + pref: "security.tls.ech.grease_http3" + disableGreaseOnFallback: + description: Whether to disable GREASE when retrying a connection. + type: boolean + setPref: + branch: default + pref: "security.tls.ech.disable_grease_on_fallback" + greasePaddingSize: + description: Assumed echConfig padding length for GREASE extensions (1-255). + type: int + setPref: + branch: default + pref: "security.tls.ech.grease_size" + +dohPrefs: + description: Prefs that control DNS over HTTPS. + owner: vgosu@mozilla.com + hasExposure: false + variables: + trrMode: + description: Has a value of 2 for TRR first, 3 for TRR only, 0 for off. + type: int + setPref: + branch: default + pref: "network.trr.mode" + trrUri: + description: The URL of the DNS over HTTPS endpoint + type: string + setPref: + branch: default + pref: "network.trr.uri" + dohMode: + description: Same as trrMode, but set by the DoHController module. + type: int + setPref: + branch: default + pref: "doh-rollout.mode" + dohUri: + description: Same as trrUri, but set by the DoHController module. + type: string + setPref: + branch: default + pref: "doh-rollout.uri" + dohProviderList: + description: An override of the rollout provider-list json + type: string + setPref: + branch: default + pref: "doh-rollout.provider-list" + dohProviderSteeringList: + description: An override of the rollout steering provider-list json + type: string + setPref: + branch: default + pref: "doh-rollout.provider-steering.provider-list" + nativeHTTPSRecords: + description: Whether we can perform native DNS HTTPS lookups + type: boolean + setPref: + branch: default + pref: "network.dns.native_https_query" + +dooh: + description: "DNS over Oblivious HTTP" + owner: vgosu@mozilla.com + hasExposure: false + variables: + ohttpEnabled: + description: Whether to use Oblivious HTTP for the resolution + type: boolean + setPref: + branch: default + pref: "network.trr.use_ohttp" + ohttpRelayUri: + description: The URL of the Oblivious HTTP relay + type: string + setPref: + branch: default + pref: "network.trr.ohttp.relay_uri" + ohttpConfigUri: + description: The URL used to fetch the configuration of the Oblivious HTTP gateway + type: string + setPref: + branch: default + pref: "network.trr.ohttp.config_uri" + ohttpUri: + description: The URL of the Oblivious DNS over HTTPS target resource + type: string + setPref: + branch: default + pref: "network.trr.ohttp.uri" + +networking: + description: "Firefox Networking (Necko)" + owner: vgosu@mozilla.com + hasExposure: false + variables: + preconnect: + description: Whether the rel=preconnect feature is enabled + type: boolean + setPref: + branch: default + pref: "network.preconnect" + 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" + enableOffMainThreadStreamDecompression: + description: Whether to enable decompression of network streams off-main-thread + type: boolean + setPref: + branch: default + pref: "network.decompression_off_mainthread2" + offMainThreadStreamDecompressionThreshold: + description: Minimum content length for off-main-thread decompression + type: int + setPref: + branch: default + pref: "network.decompression_off_mainthread_min_size" + dnsGracePeriod: + description: The grace period allows the DNS cache to use expired entries, while kicking off a revalidation in the background. + type: int + setPref: + branch: default + pref: "network.dnsCacheExpirationGracePeriod" + http3UseNSPRForIO: + description: true by default using legacy UDP IO via NSPR. When set to false, uses new UDP IO via Fast UDP for Firefox project. + type: boolean + setPref: + branch: default + pref: "network.http.http3.use_nspr_for_io" + +networkingEarlyHints: + description: "Networking (Necko) Early Hints" + owner: vgosu@mozilla.com + hasExposure: false + variables: + ehPreloadEnabled: + description: Whether Early Hints preload is enabled + type: boolean + setPref: + branch: default + pref: "network.early-hints.enabled" + ehPreconnectEnabled: + description: Whether Early Hints preconnect is enabled + type: boolean + setPref: + branch: default + pref: "network.early-hints.preconnect.enabled" + +networkingDNS: + description: "Networking (Necko) DNS" + owner: vgosu@mozilla.com + hasExposure: false + variables: + dnsMaxPriorityThreads: + description: The maximum number of high priority DNS threads that can be created. + type: int + setPref: + branch: default + pref: "network.dns.max_high_priority_threads" + dnsMaxAnyPriorityThreads: + description: The maximum number of DNS threads that can be created to handle any priority DNS requests. + type: int + setPref: + branch: default + pref: "network.dns.max_any_priority_threads" + maxDnsCacheEntries: + description: This is the number of dns cache entries allowed + type: int + setPref: + branch: default + pref: "network.dnsCacheEntries" + +networkingConnections: + description: "Networking (Necko) Connections" + owner: vgosu@mozilla.com + hasExposure: false + variables: + httpMaxConnections: + description: The maximum number of http connections. + type: int + setPref: + branch: default + pref: "network.http.max-connections" + httpMaxPersistentConnectionsPerServer: + description: The maximum number of persistent connections to a server + type: int + setPref: + branch: default + pref: "network.http.max-persistent-connections-per-server" + speculativeConnectionLimit: + description: The maximum number of half-open sockets allowed for speculative connections + type: int + setPref: + branch: default + pref: "network.http.speculative-parallel-limit" + + +networkingSendOnDataFinished: + description: "Networking (Necko) OnDataFinished" + owner: vgosu@mozilla.com + hasExposure: false + variables: + sendOnDataFinished: + description: Whether we can send OnDataFinished in the content process + type: boolean + setPref: + branch: default + pref: "network.send_OnDataFinished" + sendOnDataFinishedFromInputStreamPump: + description: Whether we can send OnDataFinished to the content process from InputStreamPump + type: boolean + setPref: + branch: default + pref: "network.send_OnDataFinished.nsInputStreamPump" + sendOnDataFinishedToHtml5parser: + description: Whether we can send OnDataFinished to the html5parser in content process + type: boolean + setPref: + branch: default + pref: "network.send_OnDataFinished.html5parser" + sendOnDataFinishedToCssLoader: + description: Whether we can send OnDataFinished to the cssLoader in content process + type: boolean + setPref: + branch: default + pref: "network.send_OnDataFinished.cssLoader" + +networkingBannedPorts: + description: "Networking (Necko) Banned Ports" + owner: vgosu@mozilla.com + hasExposure: false + variables: + bannedPortList: + description: A comma-separated list of ports that Firefox will refuse to connect to. These ports will be appended to nsIOService gBadPortList + type: string + setPref: + branch: default + pref: "network.security.ports.banned" + +localNetworkAccess: + description: "Networking (Necko) Local Network Access prefs" + owner: vgosu@mozilla.com + hasExposure: false + variables: + blockTrackers: + description: Whether network requests triggered by third party scripts classified as trackers should be blocked when making a localhost request. + type: boolean + setPref: + branch: default + pref: "network.lna.block_trackers" + lnaPromptsEnabled: + description: Whether we should prompt users for permission whenever we detect local network access. + type: boolean + setPref: + branch: default + pref: "network.lna.blocking" + lnaFeatureEnabled: + description: Blanket flag to enable/disable LNA sub-features. + type: boolean + setPref: + branch: default + pref: "network.lna.enabled" + +essentialFallbackDomains: + description: "Whether to retry failing system requests with a backup domain" + owner: vgosu@mozilla.com + hasExposure: false + variables: + essentialDomainsEnabled: + description: Whether to retry with a backup domain indicated in remote-settings + type: boolean + setPref: + branch: default + pref: "network.essential_domains_fallback" + +disableHttp3: + description: "Whether HTTP/3 is disabled" + owner: kershaw@mozilla.com + hasExposure: false + variables: + withThirdPartyRoots: + description: If third party roots are detected, disable HTTP/3 + type: boolean + setPref: + branch: default + pref: "network.http.http3.disable_when_third_party_roots_found" + + +networkPrioritization: + description: "Network request prioritization" + owner: vgosu@mozilla.com + hasExposure: false + variables: + priorityHeader: + description: Whether to set the Priority header on each request. + type: boolean + setPref: + branch: default + pref: "network.http.priority_header.enabled" + fetchPriority: + description: Whether fetch priority is enabled + type: boolean + setPref: + branch: default + pref: "network.fetchpriority.enabled" + h3FetchPriority: + description: Whether to send HTTP3 priority frames + type: boolean + setPref: + branch: default + pref: "network.http.http3.priority" + sendNoRFC7540Setting: + description: Whether to send the SETTINGS_NO_RFC7540_PRIORITIES for the HTTP2 session. + type: boolean + setPref: + branch: default + pref: "network.http.http2.send_NO_RFC7540_PRI" + h2deps: + description: Whether RFC7540 priorities / stream dependencies are enabled + type: boolean + setPref: + branch: default + pref: "network.http.http2.enabled.deps" + h3BackgroundTabDeprioritization: + description: Lowers the priority when the tab is in the background. Potential privacy concerns. + type: boolean + setPref: + branch: default + pref: "network.http.http3.send_background_tabs_deprioritization" + documentPriorityIncremental: + description: Sets the incremental flag on the Priority header for document requests + type: boolean + setPref: + branch: default + pref: "dom.document_priority.incremental" + imagePriorityIncremental: + description: Sets the incremental flag on the Priority header for image requests + type: boolean + setPref: + branch: default + pref: "image.priority.incremental" + imageAdjustLayoutPriority: + description: Whether the network request priority should be adjusted according the layout and view frame position of each particular image. + type: boolean + setPref: + branch: default + pref: "image.layout_network_priority" + adjustLinkPreloadScriptLow: + description: Priority adjustment low for link-preload-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-script.low" + adjustLinkPreloadScriptHigh: + description: Priority adjustment high for link-preload-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-script.high" + adjustLinkPreloadScriptAuto: + description: Priority adjustment auto for link-preload-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-script.auto" + adjustModuleScriptLow: + description: Priority adjustment low for module-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.module-script.low" + adjustModuleScriptHigh: + description: Priority adjustment high for module-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.module-script.high" + adjustModuleScriptAuto: + description: Priority adjustment auto for module-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.module-script.auto" + adjustAsyncOrDeferScriptLow: + description: Priority adjustment low for async-or-defer-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.async-or-defer-script.low" + adjustAsyncOrDeferScriptHigh: + description: Priority adjustment high for async-or-defer-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.async-or-defer-script.high" + adjustAsyncOrDeferScriptAuto: + description: Priority adjustment auto for async-or-defer-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.async-or-defer-script.auto" + adjustScriptInHeadLow: + description: Priority adjustment low for script-in-head + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.script-in-head.low" + adjustScriptInHeadHigh: + description: Priority adjustment high for script-in-head + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.script-in-head.high" + adjustScriptInHeadAuto: + description: Priority adjustment auto for script-in-head + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.script-in-head.auto" + adjustOtherScriptLow: + description: Priority adjustment low for other-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.other-script.low" + adjustOtherScriptHigh: + description: Priority adjustment high for other-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.other-script.high" + adjustOtherScriptAuto: + description: Priority adjustment auto for other-script + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.other-script.auto" + adjustLinkPreloadFontLow: + description: Priority adjustment low for link-preload-font + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-font.low" + adjustLinkPreloadFontHigh: + description: Priority adjustment high for link-preload-font + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-font.high" + adjustLinkPreloadFontAuto: + description: Priority adjustment auto for link-preload-font + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-font.auto" + adjustLinkPreloadFetchLow: + description: Priority adjustment low for link-preload-fetch + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-fetch.low" + adjustLinkPreloadFetchHigh: + description: Priority adjustment high for link-preload-fetch + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-fetch.high" + adjustLinkPreloadFetchAuto: + description: Priority adjustment auto for link-preload-fetch + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-fetch.auto" + adjustDeferredStyleLow: + description: Priority adjustment low for deferred-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.deferred-style.low" + adjustDeferredStyleHigh: + description: Priority adjustment high for deferred-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.deferred-style.high" + adjustDeferredStyleAuto: + description: Priority adjustment auto for deferred-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.deferred-style.auto" + adjustLinkPreloadStyleLow: + description: Priority adjustment low for link-preload-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-style.low" + adjustLinkPreloadStyleHigh: + description: Priority adjustment high for link-preload-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-style.high" + adjustLinkPreloadStyleAuto: + description: Priority adjustment auto for link-preload-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.link-preload-style.auto" + adjustNonDeferredStyleLow: + description: Priority adjustment low for non-deferred-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.non-deferred-style.low" + adjustNonDeferredStyleHigh: + description: Priority adjustment high for non-deferred-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.non-deferred-style.high" + adjustNonDeferredStyleAuto: + description: Priority adjustment auto for non-deferred-style + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.non-deferred-style.auto" + adjustGlobalFetchApiLow: + description: Priority adjustment low for global-fetch-api + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.global-fetch-api.low" + adjustGlobalFetchApiHigh: + description: Priority adjustment high for global-fetch-api + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.global-fetch-api.high" + adjustGlobalFetchApiAuto: + description: Priority adjustment auto for global-fetch-api + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.global-fetch-api.auto" + adjustImagesLow: + description: Priority adjustment low for images + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.images.low" + adjustImagesHigh: + description: Priority adjustment high for images + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.images.high" + adjustImagesAuto: + description: Priority adjustment auto for images + type: int + setPref: + branch: default + pref: "network.fetchpriority.adjustments.images.auto" + lowerTrackersPriority: + description: Whether to lower priority of resources on the tracking protection list + type: boolean + setPref: + branch: default + pref: "privacy.trackingprotection.lower_network_priority" + enableHttpTailing: + description: Whether certain requests, mainly trackers, are put to the "tail", behind other requests + type: boolean + setPref: + branch: default + pref: "network.http.tailing.enabled" + httpTailingUrgency: + description: Priority urgency of tailed request + type: int + setPref: + branch: default + pref: "network.http.tailing.urgency" + httpTailingDelayQuantum: + description: When the page load has not yet reached DOMContentLoaded point, tail requestes are delayed by (non-tailed requests count + 1) * delay-quantum milliseconds. + type: int + setPref: + branch: default + pref: "network.http.tailing.delay-quantum" + httpTailingDelayQuantumAfterDCL: + description: After the page load reached DOMContentLoaded point, tail requestes are delayed by (non-tailed requests count + 1) * delay-quantum-after-domcontentloaded milliseconds. + type: int + setPref: + branch: default + pref: "network.http.tailing.delay-quantum-after-domcontentloaded" + httpTailingMaxDelay: + description: Upper limit for the calculated delay, prevents long standing and comet-like requests + type: int + setPref: + branch: default + pref: "network.http.tailing.delay-max" + httpTailingTotalMaxDelay: + description: Total limit we delay tailed requests since page load start + type: int + setPref: + branch: default + pref: "network.http.tailing.total-max" + +networkingAuth: + description: "Firefox Networking (Necko) Authentication" + owner: vgosu@mozilla.com + hasExposure: false + variables: + redirectForAuthRetriesEnabled: + description: Whether to enable redirects for auth retries + type: boolean + setPref: + branch: default + pref: "network.auth.use_redirect_for_retries" + +networkingDenyIpAddrAny: + description: "Firefox Networking (Necko) Deny IP Address Any" + owner: vgosu@mozilla.com + hasExposure: false + variables: + denyIpAddrAny: + description: Whether to deny empty (0.0.0.0) IP addresses + type: boolean + setPref: + branch: default + pref: "network.socket.ip_addr_any.disabled" + +cookieStore: + description: Enablement of cookieStore API + owner: edgul@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: dom.cookieStore.enabled + description: >- + Enablement of the cookie store API to CRUD and monitor cookies from window JS. + managerEnabled: + description: Enablement of ServiceWorker access to cookie-change events. + type: boolean + setPref: + branch: default + pref: dom.cookieStore.manager.enabled + +pingsender: + description: "In-product usage of the pingsender telemetry reporter." + owner: nalexander@mozilla.com + hasExposure: false + variables: + backgroundTaskEnabled: + type: "boolean" + fallbackPref: "toolkit.telemetry.shutdownPingSender.backgroundtask.enabled" + description: "Whether to use the `pingsender` background task to send shutdown telemetry" + +dapTelemetry: + description: DAP Telemetry + owner: simon@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Whether to automatically send DAP measurements. + task1Enabled: + type: boolean + description: Whether to send fake measurements for task 1. + task1TaskId: + type: string + description: The task ID to use for task 1 measurements. + visitCountingEnabled: + type: boolean + description: Whether to count visits to the provided list of URLs. + visitCountingExperimentList: + type: json + description: A list of experiments with URLs for which we want to count visits. + +dapIncrementality: + description: "Incrementality experiment configuration" + owner: gleonard@mozilla.com + hasExposure: false + variables: + measurementType: + type: string + description: Indicates the type of measurement to enable. Valid values are `visitMeasurement`, `referrerMeasurement`. + advertiser: + type: string + description: The advertiser being measured. + taskId: + type: string + description: The DAP taskId specified for report submission. + length: + type: int + description: The number of buckets needed for the report histogram. + timePrecision: + type: int + description: The time precision (seconds) for submitted report. Must match the time-precision value for the task with the specified taskId. + visitCountUrls: + type: json + description: Used for measurementType `visitMeasurement`. JSON indicating the url (string), bucket (int), and metric_name(string). + referrerUrls: + type: json + description: Used for measurementType `referrerMeasurement`. JSON indicating the url (string), bucket (int), and metric_name(string) The url pattern should be broad. + targetUrls: + type: string + description: Used for measurementType `referrerMeasurement`. Comma separated list of URLs to measure. + unknownReferrerBucket: + type: int + description: Used for measurementType `referrerMeasurement`. Histogram bucket indicating unknown referrer, may be null. + unknownReferrerMetricName: + type: string + description: Used for measurementType `referrerMeasurement`. Metric name indicating count of unknown referrer occurrences, may be null. + +dapAggregators: + description: Aggregator server configuration to use for submitting DAP reports. + owner: tcampbell@mozilla.com + hasExposure: false + variables: + leader_url: + description: The URL of the DAP Leader server where reports are submitted. + type: string + setPref: + branch: default + pref: "toolkit.telemetry.dap.leader.url" + leader_hpke: + description: The base64-encode HPKE key to encrypt leader shares with. + type: string + setPref: + branch: default + pref: "toolkit.telemetry.dap.leader.hpke" + helper_url: + description: The URL of the DAP Helper server. + type: string + setPref: + branch: default + pref: "toolkit.telemetry.dap.helper.url" + helper_hpke: + description: The base64-encode HPKE key to encrypt helper shares with. + type: string + setPref: + branch: default + pref: "toolkit.telemetry.dap.helper.hpke" + +etpLevel2PBMPref: + description: The pref that controls the ETP level 2 list in the private browsing mode + owner: tihuang@mozilla.com + hasExposure: false + variables: + enabled: + description: Whether to enable ETP level 2 list in the private browsing mode. + type: boolean + setPref: + branch: default + pref: "privacy.annotate_channels.strict_list.pbmode.enabled" + +etpStrictFeatures: + description: Prefs to control the strict ETP features + owner: tihuang@mozilla.com + hasExposure: false + variables: + features: + description: The list of strict ETP features to enable in ETP strict mode. + type: string + setPref: + branch: default + pref: "browser.contentblocking.features.strict" + +thirdPartyCookieBlocking: + description: Prefs to control third-party cookie blocking + owner: tihuang@mozilla.com + hasExposure: false + variables: + enabled: + description: Whether to enable third-party cookie blocking + type: boolean + setPref: + branch: default + pref: "network.cookie.cookieBehavior.optInPartitioning" + enabledPBM: + description: Whether to enable third-party cookie blocking in private browsing mode + type: boolean + setPref: + branch: default + pref: "network.cookie.cookieBehavior.optInPartitioning.pbmode" + +thirdPartyTrackerCookieBlocking: + description: Prefs to control third-party tracker cookie blocking + owner: tihuang@mozilla.com + hasExposure: false + variables: + enabled: + description: Whether to enable third-party tracker cookie blocking. + type: boolean + setPref: + branch: default + pref: "network.cookie.cookieBehavior.trackerCookieBlocking" + +fxaButtonVisibility: + description: Prefs to control the visibility of the Firefox Accounts toolbar button when not signed in. + owner: mconley@mozilla.com + hasExposure: false + variables: + boolean: + description: True if the Firefox Accounts toolbar button should be visible when not signed in. + type: boolean + setPref: + branch: user + pref: identity.fxaccounts.toolbar.defaultVisible + pxiToolbarEnabled: + description: >- + True if we're enabling the PXI dropdown menu for the FxA toolbar button instead of + taking the user straight to login + type: boolean + setPref: + branch: user + pref: identity.fxaccounts.toolbar.pxiToolbarEnabled + monitorEnabled: + description: >- + Toggle the Monitor CTA + type: boolean + setPref: + branch: user + pref: identity.fxaccounts.toolbar.pxiToolbarEnabled.monitorEnabled + relayEnabled: + description: >- + Toggle the Relay CTA + type: boolean + setPref: + branch: user + pref: identity.fxaccounts.toolbar.pxiToolbarEnabled.relayEnabled + vpnEnabled: + description: >- + Toggle the VPN CTA + type: boolean + setPref: + branch: user + pref: identity.fxaccounts.toolbar.pxiToolbarEnabled.vpnEnabled + avatarIconVariant: + description: >- + Controls the icon that appears in the toolbar button when in the + signed-out state. + + One of the following values: + - control + - human-circle + - fox-circle + type: string + +fxaClientAssociation: + description: Prefs to control the client association ping. + owner: mconley@mozilla.com + hasExposure: false + variables: + pingEnabled: + description: >- + True if the client association ping should be sent. + type: boolean + setPref: + branch: user + pref: identity.fxaccounts.telemetry.clientAssociationPing.enabled + +fxaAppMenuItem: + description: >- + Prefs to control the appearance and copy of the FxA sign-in button in the + AppMenu when signed out. + owner: mconley@mozilla.com + hasExposure: true + exposureDescription: >- + Exposure is recorded when the user is enrolled in an experiment using this + feature and the AppMenu on Firefox Desktop is opened. + variables: + ctaCopyVariant: + description: >- + One of the following values: + - control + - sync-devices + - backup-data + - backup-sync + - mobile + type: string + +fxaAvatarMenuItem: + description: >- + Prefs to control the appearance and copy of the FxA sign-in button in the + FxA avatar menu when signed out. + owner: mconley@mozilla.com + hasExposure: true + exposureDescription: >- + Exposure is recorded when the user is enrolled in an experiment using this + feature and the FxA avatar menu on Firefox Desktop is opened. + variables: + ctaCopyVariant: + description: >- + One of the following values: + - control + - sync-devices + - backup-data + - backup-sync + - mobile + type: string + +legacyHeartbeat: + description: Normandy Heartbeat exposed to Nimbus + owner: beth@mozilla.com + hasExposure: false + schema: + uri: "resource://normandy/schemas/LegacyHeartbeat.schema.json" + path: "toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json" + variables: + survey: + type: json + description: The Heartbeat survey parameters. + +queryStripping: + description: Query parameter stripping anti-tracking feature. + owner: emz@mozilla.com + hasExposure: false + variables: + enabledNormalBrowsing: + type: boolean + setPref: + branch: default + pref: privacy.query_stripping.enabled + description: Enables / disables URL query string stripping in normal browsing mode. + enabledPrivateBrowsing: + type: boolean + setPref: + branch: default + pref: privacy.query_stripping.enabled.pbmode + description: Enables / disables URL query string stripping in private browsing mode. + allowList: + type: string + setPref: + branch: default + pref: privacy.query_stripping.allow_list + description: >- + List of sites exempt from query stripping. This list will be merged with + records coming from RemoteSettings. + stripList: + type: string + setPref: + branch: default + pref: privacy.query_stripping.strip_list + description: >- + List of query params to be stripped from URIs. This list will be merged + with records coming from RemoteSettings. + +fingerprintingProtection: + description: Control Fingerprinting Protection + owner: tihuang@mozilla.com + hasExposure: false + variables: + enabledNormal: + type: boolean + setPref: + branch: default + pref: privacy.fingerprintingProtection + description: Enables / disables fingerprinting protection in normal browsing mode. + enabledPrivate: + type: boolean + setPref: + branch: default + pref: privacy.fingerprintingProtection.pbmode + description: Enables / disables fingerprinting protection in private browsing mode. + overrides: + type: string + setPref: + branch: default + pref: privacy.fingerprintingProtection.overrides + description: >- + The protection overrides to add or remove fingerprinting protection + targets. Please check RFPTargets.inc for all supported targets. + fdlibm_math: + type: boolean + setPref: + branch: default + pref: javascript.options.use_fdlibm_for_sin_cos_tan + description: >- + Uses a different math backend for Math.sin/cos/tan in JavaScript that exposes less entropy + canvas_random_use_siphash: + type: boolean + setPref: + branch: default + pref: privacy.resistFingerprinting.randomization.canvas.use_siphash + description: >- + Uses the SipHash function for canvas randomization. + enabledBaseline: + type: boolean + setPref: + branch: default + pref: privacy.baselineFingerprintingProtection + description: Enables / disables baseline fingerprinting protection. + overridesBaseline: + type: string + setPref: + branch: default + pref: privacy.baselineFingerprintingProtection.overrides + description: >- + The protection overrides to add or remove fingerprinting protection + targets. Please check RFPTargets.inc for all supported targets. + +userCharacteristics: + description: Control user characteristic data collection + owner: tihuang@mozilla.com + hasExposure: false + variables: + currentVersion: + type: int + setPref: + branch: user + pref: toolkit.telemetry.user_characteristics_ping.current_version + description: The current collection version of the user characteristics. + +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 + +unexpectedScriptLoadNotificationBar: + description: Pref to control whether we show the Unexpected Script Load Notification Bar + owner: tritter@mozilla.com + hasExposure: false + variables: + enabled: + description: True if we want to disable the notification bar + type: boolean + setPref: + branch: default + pref: security.hide_parent_unrestricted_js_loads_warning.temporary + +gc: + description: Prefs that control gc heuristics. + owner: dpalmeiro@mozilla.com + hasExposure: false + variables: + max_nursery_size: + description: Set the maximum size of the GC nursery, in kb. + type: int + setPref: + branch: user + pref: "javascript.options.mem.nursery.max_kb" + min_nursery_size: + description: Set the minimum size of the GC nursery, in kb. + type: int + setPref: + branch: user + pref: "javascript.options.mem.nursery.min_kb" + gc_allocation_threshold_mb: + description: Lower limit for collecting a zone, in MB. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_allocation_threshold_mb" + gc_balanced_heap_limits: + description: Whether balanced heap limits are enabled. + type: boolean + setPref: + branch: user + pref: "javascript.options.mem.gc_balanced_heap_limits" + gc_compacting: + description: Whether compacting GC is enabled. + type: boolean + setPref: + branch: user + pref: "javascript.options.mem.gc_compacting" + gc_generational: + description: Whether generational GC is enabled. + type: boolean + setPref: + branch: user + pref: "javascript.options.mem.gc_generational" + gc_heap_growth_factor: + description: Heap growth parameter for balanced heap limit calculation. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_heap_growth_factor" + gc_helper_thread_ratio: + description: Number of threads to use for parallel GC work. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_helper_thread_ratio" + gc_high_frequency_large_heap_growth: + description: Heap growth factor for large heaps in the high-frequency GC state. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_high_frequency_large_heap_growth" + gc_high_frequency_small_heap_growth: + description: Heap growth factor for small heaps in the high-frequency GC state. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_high_frequency_small_heap_growth" + gc_high_frequency_time_limit_ms: + description: GCs less than this far apart in milliseconds will be + considered high-frequency GCs. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_high_frequency_time_limit_ms" + gc_incremental: + description: Whether incremental GC is enabled. If not, GC will always run to completion. + type: boolean + setPref: + branch: user + pref: "javascript.options.mem.gc_incremental" + incremental_weakmap: + description: Enable incremental weakmap marking. + type: boolean + setPref: + branch: user + pref: "javascript.options.mem.incremental_weakmap" + gc_incremental_slice_ms: + description: Max milliseconds to spend in an incremental GC slice. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_incremental_slice_ms" + gc_large_heap_incremental_limit: + description: Limit of how far over the incremental trigger threshold we allow the + heap to grow before finishing a collection non-incrementally, for large heaps. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_large_heap_incremental_limit" + gc_large_heap_size_min_mb: + description: Lower limit for classifying a heap as large, in MB. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_large_heap_size_min_mb" + gc_low_frequency_heap_growth: + description: Heap growth factor for low frequency GCs. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_low_frequency_heap_growth" + gc_malloc_threshold_base_mb: + description: Set the malloc threshold base value in MB. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_malloc_threshold_base_mb" + gc_max_empty_chunk_count: + description: Do not keep more than this many unused chunks in the free chunk pool. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_max_empty_chunk_count" + gc_max_helper_threads: + description: The maximum number of background threads to use for parallel GC work. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_max_helper_threads" + gc_min_empty_chunk_count: + description: We try to keep at least this many unused chunks in the free chunk + pool at all times, even after a shrinking GC. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_min_empty_chunk_count" + gc_parallel_marking: + description: Enable parallel marking. + type: boolean + setPref: + branch: user + pref: "javascript.options.mem.gc_parallel_marking" + gc_parallel_marking_threshold_mb: + description: The heap size above which to use parallel marking. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_parallel_marking_threshold_mb" + gc_max_parallel_marking_threads: + description: The maximum number of threads to use for parallel marking, if enabled. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_max_parallel_marking_threads" + gc_per_zone: + description: Whether per-zone GC is enabled. If not, all zones are collected every time. + type: boolean + setPref: + branch: user + pref: "javascript.options.mem.gc_per_zone" + gc_small_heap_incremental_limit: + description: Limit of how far over the incremental trigger threshold we allow the heap + to grow before finishing a collection non-incrementally, for small heaps. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_small_heap_incremental_limit" + gc_small_heap_size_max_mb: + description: Upper limit for classifying a heap as small, in MB. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_small_heap_size_max_mb" + gc_urgent_threshold_mb: + description: Set the urgent threshold, in MB. + type: int + setPref: + branch: user + pref: "javascript.options.mem.gc_urgent_threshold_mb" + nursery_eager_collection_threshold_kb: + description: Set the eager collection threshold, in kb, for the nursery. + type: int + setPref: + branch: user + pref: "javascript.options.mem.nursery_eager_collection_threshold_kb" + nursery_eager_collection_threshold_percent: + description: Set the eager collection percent threshold for the nursery. + type: int + setPref: + branch: user + pref: "javascript.options.mem.nursery_eager_collection_threshold_percent" + nursery_eager_collection_timeout_ms: + description: Set the eager collection timeout, in ms, for the nursery. + type: int + setPref: + branch: user + pref: "javascript.options.mem.nursery_eager_collection_timeout_ms" + nursery_max_time_goal_ms: + description: Set the nursery's maximum time goal, in ms. + type: int + setPref: + branch: user + pref: "javascript.options.mem.nursery_max_time_goal_ms" + +jsParallelParsing: + description: Pref to toggle JS parallel parsing. + owner: dpalmeiro@mozilla.com, nbp@mozilla.com + hasExposure: false + variables: + enabled: + description: True to enable parallel parsing. + type: boolean + setPref: + branch: user + pref: "javascript.options.parallel_parsing" + +jitThresholds: + description: Prefs that control jit tier thresholds. + owner: dpalmeiro@mozilla.com, jdemooij@mozilla.com + hasExposure: false + variables: + blinterp_threshold: + description: Set the threshold to enable blinterp compilation. + type: int + setPref: + branch: user + pref: "javascript.options.blinterp.threshold" + baseline_threshold: + description: Set the threshold to enable baseline compilation. + type: int + setPref: + branch: user + pref: "javascript.options.baselinejit.threshold" + ion_threshold: + description: Set the threshold to enable ion compilation. + type: int + setPref: + branch: user + pref: "javascript.options.ion.threshold" + ion_bailout_threshold: + description: Set the ion frequent bailout threshold. + type: int + setPref: + branch: user + pref: "javascript.options.ion.frequent_bailout_threshold" + ion_offthread_compilation: + description: True to enable offthread ion compilations. + type: boolean + setPref: + branch: user + pref: "javascript.options.ion.offthread_compilation" + inlining_max_length: + description: Set the max bytecode length considered for inlining. + type: int + setPref: + branch: user + pref: "javascript.options.inlining_bytecode_max_length" + +jitHintsCache: + description: Pref to toggle the JIT hints cache. + owner: dpalmeiro@mozilla.com + hasExposure: false + variables: + enabled: + description: True to enable the hints cache. + type: boolean + setPref: + branch: user + pref: "javascript.options.jithints" + +asmjs: + description: Pref to toggle support for asm.js. + owner: dpalmeiro@mozilla.com + hasExposure: false + variables: + enabled: + description: True to enable the asm.js feature. + type: boolean + setPref: + branch: user + pref: "javascript.options.asmjs" + +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" + +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: emz@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: nimbus-team@mozilla.com + hasExposure: false + applications: + - firefox-desktop + - firefox-desktop-background-task + variables: + gleanMetricConfiguration: + description: > + A Glean metric configuration JSON blob. + + This is limited to configuring the following categories: + - nimbus_events + - nimbus_targeting_context + - nimbus_targeting_environment + type: json + + nimbusTargetingEnvironment: + description: > + Configuration for the nimbus_targeting_environment telemetry category. + type: json + + schema: + uri: resource://nimbus/schemas/NimbusTelemetryFeature.schema.json + path: toolkit/components/nimbus/schemas/NimbusTelemetryFeature.schema.json + +httpsFirst: + description: >- + Prefs for HTTPS-First, which upgrades all top-level page loads to HTTPS and + provides a automatic fallback to HTTP if the site isn't available via HTTPS. + owner: mjurgens@mozilla.com, seceng-telemetry@mozilla.com + hasExposure: false + variables: + enabled: + description: Enable HTTPS-First + type: boolean + setPref: + branch: default + pref: dom.security.https_first + enabledPbm: + description: Enable HTTPS-First in private browsing only + type: boolean + setPref: + branch: default + pref: dom.security.https_first_pbm + enabledSchemeless: + description: >- + Enables schemeless HTTPS-First, which will only apply HTTPS-First to address + bar inputs without a scheme. This essentially makes HTTPS the default + scheme in the address bar, while providing a fallback to HTTP. + type: boolean + setPref: + branch: default + pref: dom.security.https_first_schemeless + backgroundTimerMs: + description: >- + After a request gets upgraded to HTTPS, specifies the time after which a + second HTTP request is fired to check if the site is available via + HTTPS, but timing out via HTTPS. This also applies to HTTPS-Only, not + just HTTPS-First. + type: int + setPref: + branch: default + pref: dom.security.https_only_fire_http_request_background_timer_ms + +contentRelevancy: + description: >- + A feature for interest-based content relevance ranking and personalization + for Firefox. + owner: disco-team@mozilla.com + hasExposure: false + variables: + enabled: + description: Enable this feature + type: boolean + fallbackPref: toolkit.contentRelevancy.enabled + maxInputUrls: + description: The maximum number of input URLs for interest classification + type: int + minInputUrls: + description: The minimal number of input URLs for interest classification + type: int + timerInterval: + description: >- + The interval (in seconds) of the background update timer for the content + relevancy manager + type: int + setPref: + branch: user + pref: toolkit.contentRelevancy.timerInterval + ingestEnabled: + description: Enable the ingestion through the Rust component + type: boolean + fallbackPref: toolkit.contentRelevancy.ingestEnabled + +backupService: + description: Prefs to control the profile backup service + owner: mconley@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: browser.backup.enabled + description: >- + When true, the profile backup service will be initialized soon after + startup. + 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. + dtlsWebRTCEnableMlkem: + type: boolean + setPref: + branch: default + pref: media.webrtc.enable_pq_dtls + description: >- + Whether to enable mlkem768x25519 for DTLS in WebRTC. + + +dtlsWebRTC: + description: Pref that controls the use of DTLS. + owner: nkulatova@mozilla.com + hasExposure: false + variables: + tlsVersionDTLS: + type: int + setPref: + branch: default + pref: media.peerconnection.dtls.version.max + description: >- + The maximum version of DTLS protocol used in WebRTC (770 = DTLS 1.0, 771 = DTLS 1.2, 772 = DTLS 1.3). + +certCompression: + description: Prefs that control the use of certificate compression decoders. + owner: anna.weine@mozilla.com + hasExposure: false + variables: + tlsEnableZlib: + type: boolean + setPref: + branch: default + pref: security.tls.enable_certificate_compression_zlib + description: >- + Whether to enable Zlib for TLS certificate compression. + h3EnableZlib: + type: boolean + setPref: + branch: default + pref: network.http.http3.enable_certificate_compression_zlib + description: >- + Whether to enable Zlib for H3/QUIC certificate compression. + tlsEnableBrotli: + type: boolean + setPref: + branch: default + pref: security.tls.enable_certificate_compression_brotli + description: >- + Whether to enable Brotli for TLS certificate compression. + h3EnableBrotli: + type: boolean + setPref: + branch: default + pref: network.http.http3.enable_certificate_compression_brotli + description: >- + Whether to enable Brotli for H3/QUIC certificate compression. + tlsEnableZstd: + type: boolean + setPref: + branch: default + pref: security.tls.enable_certificate_compression_zstd + description: >- + Whether to enable Zstd for TLS certificate compression. + h3EnableZstd: + type: boolean + setPref: + branch: default + pref: network.http.http3.enable_certificate_compression_zstd + description: >- + Whether to enable Zstd for H3/QUIC certificate compression. + +bounceTrackingProtection: + description: Controls the Bounce Tracking Protection feature. + owner: emz@mozilla.com + isEarlyStartup: true + hasExposure: true + exposureDescription: >- + Exposure is recored after every purge run which purged at least one tracker. + Exposure is only recorded when the feature is fully enabled and not in + dry-run mode. + variables: + mode: + type: int + setPref: + branch: default + pref: privacy.bounceTrackingProtection.mode + description: >- + Mode to run the feature in. See nsIBounceTrackingProtection.idl for + documentation. + requireStatefulBounces: + type: boolean + setPref: + branch: default + pref: privacy.bounceTrackingProtection.requireStatefulBounces + description: >- + If true, only bounce redirects where the middle hop/s access cookies or + storage will be considered to be bounce trackers. If false, all + redirects that fit the bounce tracker heuristic will be considered. + +remoteTabManagement: + description: > + Features that let users manage tabs on other devices that are + connected to the same Mozilla account. + owner: skhamis@mozilla.com + hasExposure: false + variables: + closeTabsEnabled: + description: >- + When true, the user can close tabs on other devices connected to + the same Mozilla account from the synced tabs menu. + type: boolean + fallbackPref: identity.fxaccounts.commands.remoteTabManagement.enabled + +crlite: + description: Prefs that control the use of CRLite + owner: jschanck@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: security.remote_settings.crlite_filters.enabled + description: >- + Whether CRLite artifacts will be downloaded. + channel: + type: string + setPref: + branch: default + pref: security.pki.crlite_channel + description: >- + The channel from which CRLite artifacts will be downloaded. + mode: + type: int + setPref: + branch: default + pref: security.pki.crlite_mode + description: >- + How CRLite results will be interpreted. + timestamps_for_coverage: + type: int + setPref: + branch: default + pref: security.pki.crlite_timestamps_for_coverage + description: >- + How many covered timestamps do we need to see before we enforce a CRLite result. + +chatbot: + description: AI chatbot feature configuration + owner: elee@mozilla.com + hasExposure: false + variables: + badgeSidebar: + type: boolean + description: Show badge on chatbot sidebar tool on enrollment + minVersion: + type: string + description: Minimum Firefox version to apply prefs + prefs: + type: json + description: >- + The prefs to set under browser.ml.chat.* with object keys as the + sub-pref and values objects indicating the desired branch and value + defaulting to clearing the user branch value. + +linkPreviews: + description: Enabling the link previews feature + owner: elee@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.ml.linkPreview.enabled + description: If true, will show previews when over link and keyboard shortcut is pressed + prefs: + type: json + description: >- + The prefs to set under browser.ml.linkPreview.* with object keys as the + sub-pref and values objects indicating the desired branch and value + defaulting to clearing the user branch value. + +sidebar: + description: Sidebar feature configuration + owner: elee@mozilla.com + hasExposure: false + variables: + defaultLauncherVisible: + type: boolean + setPref: + branch: user + pref: sidebar.revamp.defaultLauncherVisible + description: Change the initial visibleness of the sidebar launcher with horizontal tabs; true to make the launcher visible by default + minVersion: + type: string + description: Minimum Firefox version to apply prefs + revamp: + type: boolean + description: sidebar.revamp pref value to set on user branch; true for new experience + verticalTabs: + type: boolean + description: sidebar.verticalTabs pref value to set on user branch; true to enable vertical tabs + visibility: + type: string + description: sidebar.visibility pref value ("hide" or "always-show") 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). + +setToDefaultPrompt: + description: "Experimental set to default spotlight" + 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: + showSpotlightPrompt: + description: Show experimental set to default spotlight message instead of default prompt + type: boolean + message: + description: Message to show instead of the default prompt + type: json + +tabGroups: + description: Prefs to control Tab Groups + owner: dao@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.tabs.groups.enabled + description: Controls whether users can create new tab groups via drag and drop or the tab context menu + +smartTabGroups: + description: Prefs to control Smart Tab Groups + owner: rrando@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.tabs.groups.smart.enabled + description: Controls whether users can use ml features for suggesting tab group names or similar tabs + suggestOtherTabsMethod: + type: string + setPref: + branch: user + pref: browser.tabs.groups.smart.suggestOtherTabsMethod + description: Controls clustering method used to suggest similar tabs feature + topicModelRevision: + type: string + setPref: + branch: user + pref: browser.tabs.groups.smart.topicModelRevision + description: Controls topic model version used by the feature + embeddingModelRevision: + type: string + setPref: + branch: user + pref: browser.tabs.groups.smart.embeddingModelRevision + description: Controls embedding model version used by the feature + nearestNeighborThresholdInt: + type: int + setPref: + branch: user + pref: browser.tabs.groups.smart.nearestNeighborThresholdInt + description: Controls the threshold, less than or equal to 1000, for the nearest neighbor cluster method + searchTopicEnabled: + type: boolean + setPref: + branch: user + pref: browser.tabs.groups.smart.searchTopicEnabled + description: For single tab groupings, use the search query as the topic rather than use ML + +smartblockEmbeds: + description: Pref to control Smartblock Embeds + owner: emz@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: extensions.webcompat.smartblockEmbeds.enabled + description: >- + Controls whether smartblock embed placeholders and protections panel toggles will be shown to the user. + +selectableProfiles: + description: "Multiple profile management using selectableProfileService" + owner: jhirsch@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Enables the multiple profiles feature when true. Turning off this variable will not disable the feature. + +storageAccessHeuristics: + description: Heuristics that grant cookie access automatically for foreign resources + owner: bvandersloot@mozilla.com + hasExposure: false + variables: + popup_past_interaction: + type: boolean + setPref: + branch: default + pref: privacy.restrict3rdpartystorage.heuristic.window_open + description: >- + Do we grant cookie access to a third party when it is opened in a popup if it has + been interacted with in the recent past? + popup_interaction: + type: boolean + setPref: + branch: default + pref: privacy.restrict3rdpartystorage.heuristic.opened_window_after_interaction + description: >- + Do we grant cookie access to a third party when it is opened in a popup if it has + the opener relationship and the user interacts with the popup? + navigation: + type: boolean + setPref: + branch: default + pref: privacy.restrict3rdpartystorage.heuristic.navigation + description: >- + Do we grant cookie access to a third party when it is interacted with earlier in this + tab's history, and the current first party is even further back in the history? + redirect: + type: boolean + setPref: + branch: default + pref: privacy.restrict3rdpartystorage.heuristic.recently_visited + description: >- + Do we grant cookie access to a third party when it has been interacted with in the recent + past, has been visited in the past few minutes, and redirects itself to another top level + site? + redirect_tracker: + type: boolean + setPref: + branch: default + pref: privacy.restrict3rdpartystorage.heuristic.redirect + description: >- + Do we grant cookie access to a tracker third party when it has been interacted with in the + recent past and redirects itself to another top level site? + +partitioned-cookie-attribute: + description: Control the enablment and migration of cookies to the Partitioned attribute, rather than TCP + owner: bvandersloot@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: network.cookie.CHIPS.enabled + description: >- + Do we respect the Partitioned attribute? + chipsMigrationTarget: + description: What CHIPS migration count target the browser should reach. + type: int + setPref: + branch: default + pref: network.cookie.CHIPS.migrateDatabaseTarget + chipsPartitionLimitEnabled: + description: Whether we enforce CHIPS partition limit + type: boolean + setPref: + branch: default + pref: "network.cookie.chips.partitionLimitEnabled" + chipsPartitionLimitDryRun: + description: Whether we actually perform purging/rejection, used to report telemetry without webcompat issues + type: boolean + setPref: + branch: default + pref: "network.cookie.chips.partitionLimitDryRun" + chipsPartitionLimitByteCapacity: + description: The actual value of the CHIPS partition limit in bytes + type: boolean + setPref: + branch: default + pref: "network.cookie.chips.partitionLimitByteCapacity" + +auto-pip: + description: "Automatic Picture-in-Picture" + owner: mconley@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Whether or not to auto-open PiP when switching tabs. + setPref: + branch: user + pref: "media.videocontrols.picture-in-picture.enable-when-switching-tabs.enabled" + +urlbar-ime-search: + description: "Urlbar IME" + owner: search-and-suggest-program@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Whether or not to keep the urlbar panel open during IME composition. + setPref: + branch: user + pref: "browser.urlbar.keepPanelOpenDuringImeComposition" + +web-rtc-global-mute-toggles: + description: "WebRTC Global Mute Toggles" + owner: mconley@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Whether or not to enable global mute toggles to the WebRTC indicator. + setPref: + branch: user + pref: "privacy.webrtc.globalMuteToggles" + +jpeg-xl: + description: "JPEG-XL" + owner: krosylight@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Whether or not to enable JPEG-XL support. + setPref: + branch: user + pref: "image.jxl.enabled" + +css-masonry: + description: "CSS Masonry Layout" + owner: dholbert@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + description: Whether or not to enable CSS masonry layout. + setPref: + branch: user + pref: "layout.css.grid-template-masonry-value.enabled" + +windowsUIAutomation: + description: Support for the Windows UI Automation API + owner: jteh@mozilla.com + hasExposure: false + variables: + enabled: + type: int + description: 0 to disable UIA, 2 to enable UIA. + enum: + - 0 + - 2 + setPref: + branch: user + pref: "accessibility.uia.enable" + +expandSignInButton: + description: "Add text next to the FxA avatar toolbar icon" + owner: skhamis@mozilla.com + hasExposure: false + variables: + ctaCopyVariant: + description: >- + One of the following values: + - fxa-avatar-sign-in + - fxa-avatar-sign-up + empty will be assumed default experience + type: string + +contextID: + description: >- + Controls the behaviour of the context ID, which is a unique identifier used + by Contextual Services. + owner: mconley@mozilla.com + hasExposure: false + variables: + rotationPeriodInDays: + type: int + setPref: + branch: user + pref: "browser.contextual-services.contextId.rotation-in-days" + description: >- + The number of days since the creation of the context ID after which the + context ID should be regenerated. Set to 0 to disable rotation. This + value only takes effect if rustBackendEnabled is also true, otherwise + no rotation will occur regardless of the value. + + This setting will only be applied after the next restart. + rustBackendEnabled: + type: boolean + setPref: + branch: user + pref: "browser.contextual-services.contextId.rust-component.enabled" + description: >- + Enables the Rust component backend for ContextId.sys.mjs, which is + a prerequisite for doing rotations. + +deletePrivate: + description: Enable or disable the option for users to delete files at the end of a private browsing session + owner: rking@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: default + pref: browser.download.enableDeletePrivate + description: Whether the setting for deleting files downloaded in private browsing is available to the user + +ipProtection: + description: Prefs to control IP Protection feature + owner: fchasen@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.ipProtection.enabled + description: >- + Enables the IP Protection feature. + variant: + type: string + setPref: + branch: default + pref: browser.ipProtection.variant + description: >- + What variant of the feature to use. + +webApps: + description: Enables or disables web apps. + owner: nrishel@mozilla.com + hasExposure: false + variables: + enabled: + type: boolean + setPref: + branch: user + pref: browser.taskbarTabs.enabled + description: >- + Controls whether web apps can be installed and accessed. + +passwordManager: + description: Password manager related prefs + owner: maltejur@mozilla.com + hasExposure: false + variables: + reencryptionNeeded: + isEarlyStartup: true + type: boolean + setPref: + branch: default + pref: signon.reencryptionNeeded + description: >- + Triggers a reencryption of all passwords on the next startup for + migration purposes. diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/v145.0.0/schemas/browser/components/asrouter/content-src/schemas/BackgroundTaskMessagingExperiment.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v145.0.0/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/v145.0.0/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/v145.0.0/schemas/browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v145.0.0/schemas/browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json new file mode 100644 index 0000000000..545d70bdb3 --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v145.0.0/schemas/browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json @@ -0,0 +1,1969 @@ +{ + "$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": "Specifies where the message should appear and persist: 'global' (persists across tabs in the current window), 'tab' (only visible in the current tab), or 'universal' (visible across all tabs and windows, current and future).", + "enum": [ + "global", + "tab", + "universal" + ] + }, + "text": { + "description": "Either a single localizableText, or an array of raw strings and/or localizableText objects. localizableText can contain an optional href property for the text to be rendered as a link.", + "oneOf": [ + { + "$ref": "file:///InfoBar.schema.json#/$defs/plainText" + }, + { + "allOf": [ + { + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText" + }, + { + "not": { + "required": [ + "href" + ] + } + }, + { + "type": "object", + "description": "Additional arguments, only a `where` override is currently allowed", + "properties": { + "args": { + "type": "object", + "description": "Where to open ('tab', 'tabshifted', 'current', etc.)", + "properties": { + "where": { + "type": "string", + "description": "Where to open—e.g. 'tab', 'window', etc." + } + }, + "additionalProperties": false + } + }, + "additionalProperties": true + } + ] + } + ] + }, + { + "$ref": "file:///InfoBar.schema.json#/$defs/localizableTextWithHref" + }, + { + "$ref": "file:///InfoBar.schema.json#/$defs/rawTextWithHref" + }, + { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "file:///InfoBar.schema.json#/$defs/plainText" + }, + { + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText" + }, + { + "not": { + "required": [ + "href" + ] + } + } + ] + }, + { + "$ref": "file:///InfoBar.schema.json#/$defs/localizableTextWithHref" + }, + { + "$ref": "file:///InfoBar.schema.json#/$defs/rawTextWithHref" + } + ] + } + } + ] + }, + "priority": { + "description": "Infobar priority level https://searchfox.org/mozilla-central/rev/3aef835f6cb12e607154d56d68726767172571e4/toolkit/content/widgets/notificationbox.js#387", + "type": "number", + "minumum": 0, + "exclusiveMaximum": 10 + }, + "dismissable": { + "description": "Should the infobar include an X dismiss button, defaults to true", + "type": "boolean" + }, + "dismissOnPrefChange": { + "description": "If set, the name of a pref to observe. The infobar will automatically dismiss when this pref is set for the first time or when its value changes.", + "type": "string" + }, + "impression_action": { + "oneOf": [ + { + "$ref": "file:///InfoBar.schema.json#/$defs/impressionActionItem" + }, + { + "type": "object", + "properties": { + "type": { + "const": "MULTI_ACTION" + }, + "data": { + "type": "object", + "properties": { + "actions": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "file:///InfoBar.schema.json#/$defs/impressionActionItem" + } + } + }, + "required": [ + "actions" + ], + "additionalProperties": false + } + }, + "required": [ + "type", + "data" + ], + "additionalProperties": false + } + ] + }, + "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": { + "dismiss": { + "type": "boolean", + "description": "Should the infobar be dismissed when the action is dispatched, defaults to true" + }, + "type": { + "type": "string", + "description": "Action dispatched by the button." + }, + "data": { + "type": "object" + } + }, + "required": [ + "type" + ], + "additionalProperties": true + }, + "supportPage": { + "type": "string", + "description": "A page title on SUMO to link to" + } + }, + "required": [ + "label", + "action" + ], + "additionalProperties": true + } + }, + "linkUrls": { + "description": "Map of Fluent data-l10n-name keys to real URLs", + "type": "object", + "additionalProperties": { + "$ref": "#/$defs/linkUrl" + } + }, + "linkActions": { + "description": "Map of Fluent data-l10n-name keys to a Special Message Action dispatched when the link is clicked (in addition to opening the URL).", + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "SpecialMessageActions action type" + }, + "data": { + "type": "object" + }, + "dismiss": { + "type": "boolean", + "description": "If true, dismiss the infobar after handling this link’s action. Defaults to false." + } + }, + "required": [ + "type" + ] + } + }, + "style": { + "description": "Optional CSS overrides for this infobar. Currently, only `background-color` and `font-size` may be set. `background-color` will only apply when the user does not prefer high-contrast.", + "type": "object", + "properties": { + "background-color": { + "type": "string", + "description": "Any valid CSS color or light-dark() expression." + }, + "font-size": { + "type": "string", + "description": "Any valid CSS font-size value - rem units recommended to ensure size is relative to the system font size." + } + }, + "additionalProperties": false + } + }, + "additionalProperties": true, + "required": [ + "text", + "buttons" + ] + }, + "template": { + "type": "string", + "const": "infobar" + } + }, + "additionalProperties": true, + "required": [ + "targeting", + "trigger" + ], + "$defs": { + "plainText": { + "description": "Plain text (no HTML allowed)", + "type": "string" + }, + "linkUrl": { + "description": "Target for links or buttons", + "type": "string", + "format": "uri" + }, + "localizableTextWithHref": { + "description": "Everything a localizableText allows, plus a required href", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText" + }, + { + "type": "object", + "properties": { + "href": { + "$ref": "file:///InfoBar.schema.json#/$defs/linkUrl" + } + }, + "required": [ + "href" + ], + "additionalProperties": true + } + ] + }, + "rawTextWithHref": { + "description": "A literal text chunk that must include href", + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "href": { + "$ref": "file:///InfoBar.schema.json#/$defs/linkUrl" + } + }, + "required": [ + "raw", + "href" + ], + "additionalProperties": false + }, + "impressionActionItem": { + "type": "object", + "properties": { + "type": { + "const": "SET_PREF" + }, + "once": { + "type": "boolean", + "description": "If true, only fire on first impression." + }, + "data": { + "type": "object", + "properties": { + "pref": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": {} + }, + "required": [ + "name" + ] + } + }, + "required": [ + "pref" + ], + "additionalProperties": false + } + }, + "required": [ + "type", + "data" + ], + "additionalProperties": false + } + } + }, + "MenuMessage": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///MenuMessage.schema.json", + "title": "MenuMessage", + "description": "A template for messages that appear within our menus.", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "messageType": { + "type": "string", + "description": "The subtype of the message. 'fxa_cta' is used for Firefox Accounts messaging and is only visible when signed out, unless 'allowWhenSignedIn' property is provided. 'default_cta' is used for general messages, regardless of sign in state and only visible within the App Menu.", + "enum": [ + "fxa_cta", + "default_cta" + ] + }, + "primaryText": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "The primary text for the message, which offers the value proposition to the user." + }, + "secondaryText": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/localizableText", + "description": "The 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." + }, + "primaryButtonSize": { + "type": "string", + "enum": [ + "default", + "small" + ], + "description": "The size of the primary button, default is 'default'." + }, + "imageURL": { + "type": "string", + "description": "URL for image to use with the content." + }, + "imageWidth": { + "type": "number", + "description": "The image width in pixels. Default is 120px." + }, + "logoURL": { + "type": "string", + "description": "URL for logo to use with the content." + }, + "logoWidth": { + "type": "number", + "description": "The logo width in pixels. Default is 18px." + }, + "imageVerticalTopOffset": { + "type": "number", + "description": "The margin-block-start value to apply to the image in pixels." + }, + "imageVerticalBottomOffset": { + "type": "number", + "description": "The margin-block-end value to apply to the image in pixels, used in 'row' layouts." + }, + "containerVerticalBottomOffset": { + "type": "number", + "description": "The container's margin-block-end value in pixels. Used to visually offset the image in 'row' layouts when 'imageVerticalBottomOffset' is applied." + }, + "layout": { + "type": "string", + "description": "The layout of the message content and illustration. Row displays the image inline to the right of the text, column displays the image above the text. Simple layout only displays primary text and primary button on one row.", + "enum": [ + "row", + "column", + "simple" + ] + }, + "allowWhenSignedIn": { + "type": "boolean", + "description": "If true, the message will be shown even when the user is signed in. For 'fxa_cta' messages. Defaults to false." + } + } + }, + "template": { + "type": "string", + "const": "menu_message" + }, + "testingTriggerContext": { + "type": "string", + "enum": [ + "app_menu", + "pxi_menu" + ] + } + }, + "additionalProperties": true + }, + "NewtabPromoMessage": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///NewtabPromoMessage.schema.json", + "title": "PBNewtabPromoMessage", + "description": "Message shown on the private browsing newtab page.", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "hideDefault": { + "type": "boolean", + "description": "Should we hide the default promo after the experiment promo is dismissed." + }, + "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" + ] + }, + "NewtabMessage": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///NewtabMessage.schema.json", + "title": "NewtabMessage", + "description": "A template for messages that are rendered within newtab", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "messageType": { + "type": "string", + "description": "The subtype of the message." + } + }, + "additionalProperties": true, + "required": [ + "messageType" + ] + }, + "template": { + "type": "string", + "const": "newtab_message" + } + }, + "additionalProperties": true, + "required": [ + "targeting" + ] + }, + "Spotlight": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "file:///Spotlight.schema.json", + "title": "Spotlight", + "description": "A template with an image, title, content and two buttons.", + "allOf": [ + { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/Message" + } + ], + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + "template": { + "type": "string", + "description": "Specify the layout template for the Spotlight", + "const": "multistage" + }, + "backdrop": { + "type": "string", + "description": "Background css behind modal content" + }, + "logo": { + "type": "object", + "properties": { + "imageURL": { + "type": "string", + "description": "URL for image to use with the content" + }, + "imageId": { + "type": "string", + "description": "The ID for a remotely hosted image" + }, + "size": { + "type": "string", + "description": "The logo size." + } + }, + "additionalProperties": true + }, + "screens": { + "type": "array", + "description": "Collection of individual screen content" + }, + "transitions": { + "type": "boolean", + "description": "Show transitions within and between screens" + }, + "disableEscClose": { + "type": "boolean", + "description": "Don't allow the message to be dismissed using the ESC key - for limited use in Spotlight modals only when the message content clearly informs the user that a decision is required to proceed" + }, + "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", + "newtab_message", + "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": [ + "newtab_message" + ] + } + }, + "required": [ + "template" + ] + }, + "then": { + "$ref": "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json#/$defs/NewtabMessage" + } + }, + { + "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/v145.0.0/schemas/toolkit/components/nimbus/schemas/NimbusTelemetryFeature.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v145.0.0/schemas/toolkit/components/nimbus/schemas/NimbusTelemetryFeature.schema.json new file mode 100644 index 0000000000..668236e81c --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v145.0.0/schemas/toolkit/components/nimbus/schemas/NimbusTelemetryFeature.schema.json @@ -0,0 +1,35 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "type": "object", + "properties": { + "gleanMetricConfiguration": { + "type": "object", + "properties": { + "metrics_enabled": { + "type": "object", + "patternProperties": { + "^nimbus_targeting_environment\\..*": { "type": "boolean" }, + "^nimbus_targeting_context\\..*": { "type": "boolean" }, + "^nimbus_events\\..*": { "type": "boolean" } + }, + "additionalProperties": false + } + }, + "additionalProperties": true + }, + "nimbusTargetingEnvironment": { + "type": "object", + "properties": { + "recordAttrs": { + "description": "A list of attributes that should be recorded in the nimbus_targeting_environment.targeting_context_value metric. If not provided, it will default to all attributes.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "additionalProperties": true + } + }, + "additionalProperties": true +} diff --git a/experimenter/experimenter/features/manifests/firefox-desktop/v145.0.0/schemas/toolkit/components/nimbus/schemas/PrefFlipsFeature.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v145.0.0/schemas/toolkit/components/nimbus/schemas/PrefFlipsFeature.schema.json new file mode 100644 index 0000000000..9fa5acc7c9 --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v145.0.0/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/v145.0.0/schemas/toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json b/experimenter/experimenter/features/manifests/firefox-desktop/v145.0.0/schemas/toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json new file mode 100644 index 0000000000..3bb1f18fc4 --- /dev/null +++ b/experimenter/experimenter/features/manifests/firefox-desktop/v145.0.0/schemas/toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json @@ -0,0 +1,73 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Legacy (Normandy) Heartbeat, via Nimbus", + "description": "The schema for the Legacy Heartbeat Nimbus feature.", + "type": "object", + "properties": { + "survey": { + "$comment": "Hearbeat arguments are nested under survey to prevent simultaneous rollouts and experiments from overriding eachothers optional variables", + "type": "object", + "properties": { + "repeatOption": { + "type": "string", + "enum": ["once", "xdays"], + "description": "Determines how often a prompt is shown executes.", + "default": "once" + }, + "repeatEvery": { + "description": "For repeatOption=xdays, how often (in days) the prompt is displayed.", + "default": null, + "type": ["number", "null"] + }, + "includeTelemetryUUID": { + "type": "boolean", + "description": "Include unique user ID in post-answer-url and Telemetry", + "default": false + }, + "surveyId": { + "description": "Slug uniquely identifying this survey in telemetry", + "type": "string" + }, + "message": { + "description": "Message to show to the user", + "type": "string" + }, + "engagementButtonLabel": { + "description": "Text for the engagement button. If specified, this button will be shown instead of rating stars.", + "default": null, + "type": ["string", "null"] + }, + "thanksMessage": { + "description": "Thanks message to show to the user after they've rated Firefox", + "type": "string" + }, + "postAnswerUrl": { + "description": "URL to redirect the user to after rating Firefox or clicking the engagement button", + "default": null, + "type": ["string", "null"] + }, + "learnMoreMessage": { + "description": "Message to show to the user to learn more", + "default": null, + "type": ["string", "null"] + }, + "learnMoreUrl": { + "description": "URL to show to the user when they click Learn More", + "default": null, + "type": ["string", "null"] + } + }, + "required": [ + "surveyId", + "message", + "thanksMessage", + "postAnswerUrl", + "learnMoreMessage", + "learnMoreUrl" + ], + "additionalProperties": false + } + }, + "required": ["survey"], + "additionalProperties": false +} diff --git a/experimenter/experimenter/features/manifests/focus-ios/.ref-cache.yaml b/experimenter/experimenter/features/manifests/focus-ios/.ref-cache.yaml index 4bd6ce06d3..e0f66e752c 100644 --- a/experimenter/experimenter/features/manifests/focus-ios/.ref-cache.yaml +++ b/experimenter/experimenter/features/manifests/focus-ios/.ref-cache.yaml @@ -20,7 +20,8 @@ focus/klar-v138.0: 33f7f00718adf88505d1804ccedb56750b04f2fb focus/klar-v139.0: 0a40db672ac6d422377ae4394dcbaae878998e9e focus/klar-v140.0: 2d3684ce1d30402082a7d37b3df58e0c672ac4ab focus/klar-v141.0: 2d2a8b3fcd4a112fa6e387d687138dc662d96e37 -main: c6376fc1df0b51e38f7a4e62eefcfa2f3c01bfa9 +focus/klar-v143.0: 72645ad484df1c240e64871aa5408b296d94798c +main: 351c1f78fc6351bc04497cee33ca02878be3683b release/v124: da250bed9e19c4978d4400d6d404cb312e33636e release/v125: a3e1e0773a00009e08d95726fd518ab642255ccd release/v126: 6f305409b4af68e8404401a2caad8cb0da9a0494 diff --git a/experimenter/experimenter/features/manifests/focus-ios/v143.0.0/beta.fml.yaml b/experimenter/experimenter/features/manifests/focus-ios/v143.0.0/beta.fml.yaml index 46b77ec1d0..f10b44651d 100644 --- a/experimenter/experimenter/features/manifests/focus-ios/v143.0.0/beta.fml.yaml +++ b/experimenter/experimenter/features/manifests/focus-ios/v143.0.0/beta.fml.yaml @@ -1,9 +1,8 @@ ---- version: 1.0.0 about: description: The root level Feature Manifest for Focus for iOS channels: - - beta +- beta features: nimbus-validation: description: A tiny feature to validate that Nimbus is working diff --git a/experimenter/experimenter/features/manifests/focus-ios/v143.0.0/developer.fml.yaml b/experimenter/experimenter/features/manifests/focus-ios/v143.0.0/developer.fml.yaml index 36e01f7f33..8de6c5ac41 100644 --- a/experimenter/experimenter/features/manifests/focus-ios/v143.0.0/developer.fml.yaml +++ b/experimenter/experimenter/features/manifests/focus-ios/v143.0.0/developer.fml.yaml @@ -1,9 +1,8 @@ ---- version: 1.0.0 about: description: The root level Feature Manifest for Focus for iOS channels: - - developer +- developer features: nimbus-validation: description: A tiny feature to validate that Nimbus is working diff --git a/experimenter/experimenter/features/manifests/focus-ios/v143.0.0/experimenter.yaml b/experimenter/experimenter/features/manifests/focus-ios/v143.0.0/experimenter.yaml index f544374809..716d02a9e7 100644 --- a/experimenter/experimenter/features/manifests/focus-ios/v143.0.0/experimenter.yaml +++ b/experimenter/experimenter/features/manifests/focus-ios/v143.0.0/experimenter.yaml @@ -1,8 +1,7 @@ ---- nimbus-validation: description: A tiny feature to validate that Nimbus is working hasExposure: true - exposureDescription: "" + exposureDescription: '' variables: bold-tip-title: type: boolean @@ -10,7 +9,7 @@ nimbus-validation: onboarding-variables: description: A collection of variables about onboarding hasExposure: true - exposureDescription: "" + exposureDescription: '' variables: show-new-onboarding: type: boolean diff --git a/experimenter/experimenter/features/manifests/focus-ios/v143.0.0/release.fml.yaml b/experimenter/experimenter/features/manifests/focus-ios/v143.0.0/release.fml.yaml index 5eabdc2f80..93c6f7b4f9 100644 --- a/experimenter/experimenter/features/manifests/focus-ios/v143.0.0/release.fml.yaml +++ b/experimenter/experimenter/features/manifests/focus-ios/v143.0.0/release.fml.yaml @@ -1,9 +1,8 @@ ---- version: 1.0.0 about: description: The root level Feature Manifest for Focus for iOS channels: - - release +- release features: nimbus-validation: description: A tiny feature to validate that Nimbus is working diff --git a/experimenter/experimenter/features/manifests/focus-ios/v143.2.0/beta.fml.yaml b/experimenter/experimenter/features/manifests/focus-ios/v143.2.0/beta.fml.yaml new file mode 100644 index 0000000000..f10b44651d --- /dev/null +++ b/experimenter/experimenter/features/manifests/focus-ios/v143.2.0/beta.fml.yaml @@ -0,0 +1,20 @@ +version: 1.0.0 +about: + description: The root level Feature Manifest for Focus for iOS +channels: +- beta +features: + nimbus-validation: + description: A tiny feature to validate that Nimbus is working + variables: + bold-tip-title: + description: Make the tips title label bold + type: Boolean + default: true + onboarding-variables: + description: A collection of variables about onboarding + variables: + show-new-onboarding: + description: Should the v2 of the onboarding be shown. + type: Boolean + default: false diff --git a/experimenter/experimenter/features/manifests/focus-ios/v143.2.0/developer.fml.yaml b/experimenter/experimenter/features/manifests/focus-ios/v143.2.0/developer.fml.yaml new file mode 100644 index 0000000000..8de6c5ac41 --- /dev/null +++ b/experimenter/experimenter/features/manifests/focus-ios/v143.2.0/developer.fml.yaml @@ -0,0 +1,20 @@ +version: 1.0.0 +about: + description: The root level Feature Manifest for Focus for iOS +channels: +- developer +features: + nimbus-validation: + description: A tiny feature to validate that Nimbus is working + variables: + bold-tip-title: + description: Make the tips title label bold + type: Boolean + default: true + onboarding-variables: + description: A collection of variables about onboarding + variables: + show-new-onboarding: + description: Should the v2 of the onboarding be shown. + type: Boolean + default: true diff --git a/experimenter/experimenter/features/manifests/focus-ios/v143.2.0/experimenter.yaml b/experimenter/experimenter/features/manifests/focus-ios/v143.2.0/experimenter.yaml new file mode 100644 index 0000000000..716d02a9e7 --- /dev/null +++ b/experimenter/experimenter/features/manifests/focus-ios/v143.2.0/experimenter.yaml @@ -0,0 +1,16 @@ +nimbus-validation: + description: A tiny feature to validate that Nimbus is working + hasExposure: true + exposureDescription: '' + variables: + bold-tip-title: + type: boolean + description: Make the tips title label bold +onboarding-variables: + description: A collection of variables about onboarding + hasExposure: true + exposureDescription: '' + variables: + show-new-onboarding: + type: boolean + description: Should the v2 of the onboarding be shown. diff --git a/experimenter/experimenter/features/manifests/focus-ios/v143.2.0/release.fml.yaml b/experimenter/experimenter/features/manifests/focus-ios/v143.2.0/release.fml.yaml new file mode 100644 index 0000000000..93c6f7b4f9 --- /dev/null +++ b/experimenter/experimenter/features/manifests/focus-ios/v143.2.0/release.fml.yaml @@ -0,0 +1,20 @@ +version: 1.0.0 +about: + description: The root level Feature Manifest for Focus for iOS +channels: +- release +features: + nimbus-validation: + description: A tiny feature to validate that Nimbus is working + variables: + bold-tip-title: + description: Make the tips title label bold + type: Boolean + default: true + onboarding-variables: + description: A collection of variables about onboarding + variables: + show-new-onboarding: + description: Should the v2 of the onboarding be shown. + type: Boolean + default: false diff --git a/experimenter/experimenter/features/manifests/ios/.ref-cache.yaml b/experimenter/experimenter/features/manifests/ios/.ref-cache.yaml index dc0db47bf3..a29a993f5b 100644 --- a/experimenter/experimenter/features/manifests/ios/.ref-cache.yaml +++ b/experimenter/experimenter/features/manifests/ios/.ref-cache.yaml @@ -59,7 +59,8 @@ firefox-v141.1: 417533fb96c0fdda08ff2b300baaa507c2c02551 firefox-v141.2: a546df46d992dd7e793f18c551a70226205be5ab firefox-v142.0: fda95e1815322d9f1563d575bc1abb79d81041ab firefox-v142.1: 800347c19d5917a54d00c0ce94d17bc7d37df92b -main: c6376fc1df0b51e38f7a4e62eefcfa2f3c01bfa9 +firefox-v143.0: 6b1e8d6e411786bd05cbc8a278df529494e4b9fb +main: 351c1f78fc6351bc04497cee33ca02878be3683b release/v117: 43b690c450066d4dde1b2ccb93ed3714d244d502 release/v118: 89a7ea3c3372e5a4ef5b3c5b85499d26198d0524 release/v119: 7dc381f991c6d2a983c3ba7f0cffd880e8c29e7b @@ -88,7 +89,8 @@ release/v141: 69430564a07de646d13a5337c5bfc1a5a576da13 release/v142: 9d2a88be39b477f39cf753c69adaef4006d603ae release/v142.0: fda95e1815322d9f1563d575bc1abb79d81041ab release/v142.1: 7760fd164fda9ab5137f7cd986e52c643a943f28 -release/v143.0: b49dc0bc99fe4a289084dab48e83141291a53947 +release/v143.0: fa7cedbd23ed59a753005e1719505ad4e64e8386 +release/v143.1: 20f59d81f023c02dc9fa9d8217f2410dc557c2c0 v117.0: 3b275ab1e4ccef769d84437033c0c68acfd2df8a v117.1: 55ddcf473a65d106d43f6d2ae5af4076d6d03688 v117.2: 5cc367aa8857199cd8a54d53e8faf6696c5614c3 diff --git a/experimenter/experimenter/features/manifests/ios/v143.0.1/beta.fml.yaml b/experimenter/experimenter/features/manifests/ios/v143.0.1/beta.fml.yaml new file mode 100644 index 0000000000..d9061a20b4 --- /dev/null +++ b/experimenter/experimenter/features/manifests/ios/v143.0.1/beta.fml.yaml @@ -0,0 +1,1366 @@ +version: 1.0.0 +about: + description: The root level Feature Manifest for Firefox for iOS +channels: +- beta +features: + address-autofill-edit: + description: This property defines if the address editing is enabled in Settings + variables: + status: + description: If true, we will allow user to edit the address + type: Boolean + default: false + address-bar-menu-feature: + description: | + This property determines if we show the new address bar menu entry or the toolbar menu in settings + variables: + status: + description: If true, we will show the new address bar menu entry + type: Boolean + default: true + appearance-menu-feature: + description: | + This property determines if we show the new appearance menu entry or the old theme settings + variables: + status: + description: If true, we will show the new appearance menu entry + type: Boolean + default: true + apple-summarizer-feature: + description: | + This feature enables the apple summarizer feature. + variables: + enabled: + description: | + Enables the apple summarizer feature. + type: Boolean + default: true + shakeGesture: + description: | + Enables the shake gesture for the summarizer feature. + type: Boolean + default: true + toolbarEntrypoint: + description: | + Enables the toolbar entrypoint for the summarizer feature. + type: Boolean + default: true + deeplink-optimization-refactor-feature: + description: | + The feature flag to manage the rollout of deeplink optimization feature. + variables: + enabled: + description: | + Variable description + type: Boolean + default: true + default-zoom-feature: + description: | + The feature flag to manage the rollout of default zoom feature. + variables: + enabled: + description: | + If true, page zoom settings and default zoom feature are shown + type: Boolean + default: false + download-live-activities-feature: + description: | + Download Live Activities Feature + variables: + enabled: + description: | + If true, the download live activities feature is enabled + type: Boolean + default: false + felt-privacy-feature: + description: The feature that enhances private browsing mode + variables: + felt-deletion-enabled: + description: If true, enable Felt Deletion part of Felt Privacy + type: Boolean + default: false + simplified-ui-enabled: + description: If true, enable simplified UI part of Felt Privacy + type: Boolean + default: true + firefox-suggest-feature: + description: Configuration for the Firefox Suggest feature. + variables: + available-suggestions-types: + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + type: Map + default: + amp: true + ampMobile: false + wikipedia: true + status: + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. + type: Boolean + default: false + general-app-features: + description: The feature that contains feature flags for the entire application + variables: + report-site-issue: + description: This property defines whether or not the feature is enabled + type: GeneralFeature + default: + status: true + hnt-sponsored-shortcuts-feature: + description: This feature manages the visibility of sponsored shortcuts on the homepage + variables: + enabled: + description: Setting 'enabled' to false will hide sponsored shortcuts on the homepage and disable the respective toggle in the homepage settings + type: Boolean + default: true + hnt-top-sites-visual-refresh-feature: + description: This feature manages the top sites visual refresh. + variables: + enabled: + description: Determines whether the top sites visual refresh is shown. + type: Boolean + default: false + homepage-rebuild-feature: + description: | + This feature is for managing the roll out of the Homepage rebuild feature + variables: + enabled: + description: | + If true, enables the feature + type: Boolean + default: true + homepage-redesign-feature: + description: | + This feature is for managing the roll out of the Homepage New Tab Redesign feature. + variables: + discover-more-feature-configuration: + description: | + A configuration for the Discover More feature + type: DiscoverMoreConfiguration + default: + discover-more-v1-experience: false + show-discover-more-button: false + enabled: + description: | + Enables the feature. + type: Boolean + default: false + search-bar: + description: | + If true, enables the search bar feature on homepage for users. + type: Boolean + default: true + shortcuts-library: + description: | + If true, enables the shortcuts library feature, accessible from the homepage + type: Boolean + default: false + stories-redesign: + description: | + If true, enables the stories section redesign on homepage, which also includes the removal of other sections (i.e. jump back in, bookmarks) + type: Boolean + default: true + hosted-summarizer-feature: + description: | + This feature enables the hosted summarizer feature. + variables: + enabled: + description: | + Enables the hosted summarizer feature. + type: Boolean + default: true + shakeGesture: + description: | + Enables the shake gesture for the summarizer feature. + type: Boolean + default: true + toolbarEntrypoint: + description: | + Enables the toolbar entrypoint for the summarizer feature. + type: Boolean + default: true + logins-verification: + description: | + Feature that enables the logins verification logic. + variables: + logins-verification-enabled: + description: | + Whether the logins verification logic is enabled. When enabled, an attempt will be made to decrypt all stored logins when sync is enabled. If a login cannot be decrypted, it will be locally deleted to unblock syncing. + type: Boolean + default: false + menu-refactor-feature: + description: | + Controls the menu refactor feature + variables: + enabled: + description: | + Controls which menu users will see + type: Boolean + default: true + menu-default-browser-banner: + description: | + If true, enables the menu Make Firefox your default banner, on top of the menu. + type: Boolean + default: true + menu-redesign-hint: + description: | + If true, enables the menu contextual hint for menu redesign. + type: Boolean + default: true + messaging: + description: | + The in-app messaging system + documentation: + - name: User documentation + url: https://experimenter.info/messaging/mobile-messaging + contacts: + - jhugman@mozilla.com + - brennie@mozilla.com + - gbuciu@mozilla.com + - wteichmann@mozilla.com + events: + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_shown + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_clicked + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_expired + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_dismissed + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_malformed + variables: + actions: + description: A growable map of action URLs. + type: Map + default: + OPEN_SETTINGS: ://deep-link?url=settings/general + OPEN_SETTINGS_NEW_TAB: ://deep-link?url=settings/newtab + OPEN_SETTINGS_HOMESCREEN: ://deep-link?url=settings/homepage + OPEN_SETTINGS_WALLPAPERS: ://deep-link?url=settings/wallpaper + OPEN_SETTINGS_EMAIL: ://deep-link?url=settings/mailto + OPEN_SETTINGS_SEARCH_ENGINE: ://deep-link?url=settings/search + OPEN_SETTINGS_PRIVACY: ://deep-link?url=settings/clear-private-data + OPEN_SETTINGS_FXA: ://deep-link?url=settings/fxa + OPEN_SETTINGS_THEME: ://deep-link?url=settings/theme + OPEN_SETTINGS_APP_ICON: ://deep-link?url=settings/app-icon + OPEN_URL: ://open-url + VIEW_BOOKMARKS: ://deep-link?url=homepanel/bookmarks + VIEW_TOP_SITES: ://deep-link?url=homepanel/top-sites + VIEW_READING_LIST: ://deep-link?url=homepanel/reading-list + VIEW_HISTORY: ://deep-link?url=homepanel/history + VIEW_DOWNLOADS: ://deep-link?url=homepanel/downloads + ENABLE_PRIVATE_BROWSING: ://deep-link?url=homepanel/new-private-tab + OPEN_NEW_TAB: ://deep-link?url=homepanel/new-tab + MAKE_DEFAULT_BROWSER: ://deep-link?url=default-browser/system-settings + MAKE_DEFAULT_BROWSER_WITH_TUTORIAL: ://deep-link?url=default-browser/tutorial + OPEN_SHARE_SHEET: ://share-sheet + string-alias: ActionName + message-under-experiment: + description: 'Deprecated. Please use "experiment": "{experiment}" instead.' + type: Option + default: null + messages: + description: | + A growable collection of messages, where the Key is the message identifier and the value is its associated MessageData. + type: Map + default: + homepage-microsurvey-message: + surface: microsurvey + style: MICROSURVEY + trigger-if-all: + - SECOND_HOMEPAGE_VIEW + title: Microsurvey/Microsurvey.Prompt.TitleLabel.v127 + text: How satisfied are you with your Firefox homepage? + button-label: Microsurvey/Microsurvey.Prompt.Button.v127 + microsurveyConfig: + utm-content: homepage + icon: homeLarge + options: + - Microsurvey/Microsurvey.Survey.Options.VerySatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.Satisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.Neutral.v132 + - Microsurvey/Microsurvey.Survey.Options.Dissatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.VeryDissatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.NotApplicable.v132 + string-alias: MessageKey + on-control: + description: What should be displayed when a control message is selected. + type: ControlMessageBehavior + default: show-next-message + styles: + description: | + A map of styles to configure message appearance. + type: Map + default: + FALLBACK: + priority: 40 + max-display-count: 20 + DEFAULT: + priority: 50 + max-display-count: 5 + MICROSURVEY: + priority: 50 + max-display-count: 1 + NOTIFICATION: + priority: 50 + max-display-count: 1 + PERSISTENT: + priority: 50 + max-display-count: 20 + SURVEY: + priority: 55 + max-display-count: 10 + WARNING: + priority: 60 + max-display-count: 10 + URGENT: + priority: 100 + max-display-count: 10 + string-alias: StyleName + triggers: + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + USER_RECENTLY_INSTALLED: days_since_install < 7 + USER_RECENTLY_UPDATED: days_since_update < 7 && days_since_install != days_since_update + USER_TIER_ONE_COUNTRY: ('US' in locale || 'GB' in locale || 'CA' in locale || 'DE' in locale || 'FR' in locale) + USER_EN_SPEAKER: '''en'' in locale' + USER_ES_SPEAKER: '''es'' in locale' + USER_DE_SPEAKER: '''de'' in locale' + USER_FR_SPEAKER: '''fr'' in locale' + DEVICE_ANDROID: os == 'Android' + DEVICE_IOS: os == 'iOS' + DAY_1_AFTER_INSTALL: days_since_install == 1 + DAY_2_AFTER_INSTALL: days_since_install == 2 + DAY_3_AFTER_INSTALL: days_since_install == 3 + DAY_4_AFTER_INSTALL: days_since_install == 4 + DAY_5_AFTER_INSTALL: days_since_install == 5 + MORE_THAN_24H_SINCE_INSTALLED_OR_UPDATED: days_since_update >= 1 + NOT_LAUNCHED_YESTERDAY: '''app_cycle.foreground''|eventLastSeen(''Days'', 1) > 1' + AFTER_THREE_LAUNCHES_THIS_WEEK: '''app_cycle.foreground''|eventSum(''Weeks'', 1, 0) >= 3' + I_AM_DEFAULT_BROWSER: is_default_browser + I_AM_NOT_DEFAULT_BROWSER: is_default_browser == false + SUPPORTS_DEFAULT_BROWSER: os_version|versionCompare('14.!') >= 0 + INACTIVE_NEW_USER: is_inactive_new_user + ALLOWED_TIPS_NOTIFICATIONS: allowed_tips_notifications + FXA_CURRENTLY_SIGNED_IN: is_fxa_signed_in == true + SECOND_HOMEPAGE_VIEW: '''homepage_viewed''|eventSum(''Years'', 4, 0) >= 2' + ON_FOURTH_LAUNCH_THIS_YEAR: '''app_cycle.foreground''|eventSum(''Years'', 1, 0) > 3' + string-alias: TriggerName + ~~experiment: + description: Not to be set by experiment. + type: ExperimentSlug + default: '{experiment}' + string-alias: ExperimentSlug + allow-coenrollment: true + microsurvey-feature: + description: | + A feature that shows the microsurvey for users to interact with and submit responses. + variables: + enabled: + description: | + If true, the feature is active. + type: Boolean + default: false + native-error-page-feature: + description: | + This feature is for managing the roll out of the native error page feature + variables: + enabled: + description: | + If true, the feature is active. + type: Boolean + default: false + no_internet_connection_error: + description: | + This feature is for managing the roll out of the no interet connection native error page feature + type: Boolean + default: false + onboarding-framework-feature: + description: | + The new onboarding framework feature that will allow onboarding to be experimentable through initial experiments. + variables: + cards: + description: | + The list of available cards for onboarding. + type: Map + default: + welcome: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Welcome.Title.TreatementA.v120 + body: Onboarding/Onboarding.Welcome.Description.TreatementA.v120 + image: welcome-globe + buttons: + primary: + title: Onboarding/Onboarding.Welcome.ActionTreatementA.v114 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Welcome.Skip.v114 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + notification-permissions: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Notification.Title.v120 + body: Onboarding/Onboarding.Notification.Description.v120 + image: notifications + buttons: + primary: + title: Onboarding/Onboarding.Notification.TurnOnNotifications.Action.v114 + action: request-notifications + secondary: + title: Onboarding/Onboarding.Notification.Skip.Action.v115 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + sign-to-sync: + card-type: basic + order: 20 + title: Onboarding/Onboarding.Sync.Title.v120 + body: Onboarding/Onboarding.Sync.Description.v123 + image: sync-devices + buttons: + primary: + title: Onboarding/Onboarding.Sync.SignIn.Action.v114 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Sync.Skip.Action.v114 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + customization-theme: + card-type: multiple-choice + order: 40 + title: Onboarding/Onboarding.Customization.Theme.Title.v123 + body: Onboarding/Onboarding.Customization.Theme.Description.v123 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Customization.Theme.Continue.Action.v123 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Theme.System.Action.v123 + image: theme-system + action: theme-system-default + - title: Onboarding/Onboarding.Customization.Theme.Light.Action.v123 + image: theme-light + action: theme-light + - title: Onboarding/Onboarding.Customization.Theme.Dark.Action.v123 + image: theme-dark + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + customization-toolbar: + card-type: multiple-choice + order: 41 + title: Onboarding/Onboarding.Customization.Toolbar.Title.v123 + body: Onboarding/Onboarding.Customization.Toolbar.Description.v123 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Customization.Toolbar.Continue.Action.v123 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Toolbar.Top.Action.v123 + image: toolbar-top + action: toolbar-top + - title: Onboarding/Onboarding.Customization.Toolbar.Bottom.Action.v123 + image: toolbar-bottom + action: toolbar-bottom + onboarding-type: fresh-install + prerequisites: + - ALWAYS + update-welcome: + card-type: basic + order: 10 + title: Upgrade/Upgrade.Welcome.Title.v114 + body: Upgrade/Upgrade.Welcome.Description.v114 + image: welcome-globe + buttons: + primary: + title: Upgrade/Upgrade.Welcome.Action.v114 + action: forward-one-card + onboarding-type: upgrade + prerequisites: + - NEVER + update-sign-to-sync: + card-type: basic + order: 20 + title: Upgrade/Upgrade.SyncSign.Title.v114 + body: Upgrade/Upgrade.SyncSign.Description.v114 + image: sync-devices + buttons: + primary: + title: Upgrade/Upgrade.SyncSign.Action.v114 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.LaterAction.v114 + action: forward-one-card + onboarding-type: upgrade + prerequisites: + - NEVER + welcome-modern: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.Welcome.Title.v140 + body: Onboarding/Onboarding.Modern.Welcome.Description.v140 + image: trackers + buttons: + primary: + title: Onboarding/Onboarding.Modern.Welcome.ActionTreatementA.v140 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.Welcome.Skip.v140 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + sign-to-sync-modern: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.Sync.Title.v140 + body: Onboarding/Onboarding.Modern.Sync.Description.v140 + image: sync-with-icons + buttons: + primary: + title: Onboarding/Onboarding.Modern.Sync.SignIn.Action.v140 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.Sync.Skip.Action.v140 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-toolbar-modern: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Title.v140 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v140 + image: toolbar-bottom + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v140 + image: toolbar-top + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-theme-modern: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Customization.Theme.Title.v143 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Theme.System.Action.v123 + image: theme-system + action: theme-system-default + - title: Onboarding/Onboarding.Customization.Theme.Light.Action.v123 + image: theme-light + action: theme-light + - title: Onboarding/Onboarding.Customization.Theme.Dark.Action.v123 + image: theme-dark + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + string-alias: NimbusOnboardingCardKey + conditions: + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + string-alias: ConditionName + dismissable: + description: | + Whether or not the entire onboarding is dismissable by pressing an X at the top right corner of the screen. + type: Boolean + default: true + enableModernUi: + description: | + Toggle between legacy (false) and modern (true) UI variants. + type: Boolean + default: false + pdf-refactor-feature: + description: | + The feature flag to manage the roll out of the pdf refactor feature. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: true + revert-unsafe-continuations-refactor: + description: | + A feature flag to wrap reverting the unsafe continuations usage in the app. Unsafe continuations were used in response to an early 2025 incident when iOS 18.0 (possibly beta only) crashed on checked continuations (both regular and throwing). + variables: + enabled: + description: | + If true, revert unsafe continuations usage back to normal checked continuations usage. + type: Boolean + default: true + search: + description: | + Configuring the functionality to do with search. This will be separated into smaller sub-features in later releases. + variables: + awesome-bar: + description: Configuring the awesome bar. + type: AwesomeBar + default: + min-search-term: 3 + position: + is-bottom: false + is-position-feature-enabled: true + search-highlights: false + use-page-content: false + search-engine-consolidation-feature: + description: | + This feature is for managing the roll out of Search Engine Consolidation support in iOS + variables: + enabled: + description: | + Enables the feature + 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 + spotlight-search: + description: Add pages as items findable with Spotlight. + variables: + enabled: + description: If this is true, then on each page load adds a new item to Spotlight. + type: Boolean + default: false + icon-type: + description: | + The icon that is displayed next to the item in the search results. If this is `null`, then no icon is displayed. + type: Option + default: letter + keep-for-days: + description: | + Number of days to keep the item before automatic deletion. If this is left `null`, then it is left to iOS's default. + type: Option + default: null + searchable-content: + description: | + The text content that is made searchable. If this is `null` then no additional content is used, and only the title and URL will be used. + type: Option + default: text-excerpt + start-at-home-feature: + description: This feature is for experimenting with opening screen + variables: + setting: + description: This property provides a default setting for the start at home feature + type: StartAtHome + default: afterFourHours + tab-scroll-refactor-feature: + description: | + The feature flag to manage the rollout of tab scroll refactor feature. + variables: + enabled: + description: | + If true, tab scroll new implementation is used to show and hide toolbar views reacting to user scroll + type: Boolean + default: false + tab-tray-ui-experiments: + description: | + The tab tray will undergo some UI experimentation to test potential improvements. + variables: + enabled: + description: | + If true, enables the tab tray UI experiments. + type: Boolean + default: true + tabTrayFeature: + description: The tab tray screen that the user goes to when they open the tab tray. + 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: + inactive-tabs: true + toolbar-refactor-feature: + description: | + This feature is for managing the roll out of the Toolbar refactor feature + variables: + enabled: + description: | + Enables the feature + type: Boolean + default: true + layout: + description: | + The type of layout of the toolbars. + type: Option + default: version1 + minimal_address_bar: + description: | + Enables minimal address bar mode on scroll to ensure the url is always visible. + type: Boolean + default: false + navigation_hint: + description: | + If true, enables the navigation contextual hint. + type: Boolean + default: true + one_tap_new_tab: + description: | + If true, enables the one tap new tab feature for users. + type: Boolean + default: true + swiping_tabs: + description: | + Enables swipe gestures to switch between browser tabs. + type: Boolean + default: true + toolbar_update_hint: + description: | + If true, enables the toolbar update contextual hint. + type: Boolean + default: false + translucency: + description: | + Enables translucency for toolbars. + type: Boolean + default: true + unified_search: + description: | + Enables the unified search feature. + type: Boolean + default: false + tos-feature: + description: | + This feature is for managing the roll out of the ToS (Term of Service) implementation + variables: + status: + description: | + Enables the feature + type: Boolean + default: true + tou-feature: + description: | + This feature is for managing the rollout of the Terms of Use (ToU) implementation. + variables: + status: + description: | + Enables the feature + type: Boolean + default: false + tracking-protection-refactor: + description: | + The Enhanced Tracking Protection refactor + variables: + enabled: + description: | + Whether the Enhanced Tracking Protection refactor is enabled or not + type: Boolean + default: true + unified-ads: + description: | + This property is for managing the roll out of the unified ads API + variables: + enabled: + description: | + If true, we will enable user to use the unified ads API + type: Boolean + default: true + updated-password-manager-feature: + description: | + This property determines if we use the updated password manager or the legacy one. + variables: + status: + description: If true, firefox will use the the updated password manager. + type: Boolean + default: false + web-engine-integration-refactor: + description: | + The feature flag to manage the roll out of the integration of WebEngine into Firefox. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false +enums: + ControlMessageBehavior: + description: An enum to influence what should be displayed when a control message is selected. + variants: + show-next-message: + description: The next eligible message should be shown. + show-none: + description: The surface should show no message. + IconType: + description: The icon that will be added to the item in the device's search engine. + variants: + favicon: + description: The favicon of the page + letter: + description: An icon generated from the first letter of the base domain. + screenshot: + description: A screenshot of the page at load time. + MessageSurfaceId: + description: | + For messaging, we would like to have a message tell us which surface its associated with. This is a label that matches across both Android and iOS. + variants: + Unknown: + description: A message has NOT declared its target surface. + microsurvey: + description: This is a microsurvey that appears on top of the bottom toolbar to the user. + new-tab-card: + description: This is the card that appears at the top on the Firefox Home Page. + notification: + description: This is a local notification send to the user periodically with tips and updates. + survey: + description: This is a full-page that appears providing a survey to the user. + NimbusOnboardingHeaderImage: + description: | + The identifiers for the different images available for cards in onboarding + variants: + customize-firefox: + description: | + Corresponding to the fox window image + notifications: + description: | + Corresponding to the notifications image + notifications-ctd: + description: | + Corresponding to the notifications image for CTD + search-widget: + description: | + Corresponding to the fox search widget image + set-default-steps: + description: | + Corresponding to the set to default steps image + set-to-dock: + description: | + Corresponding to the set to dock image + sync-devices: + description: | + Corresponding to the sync-devices image + sync-devices-ctd: + description: | + Corresponding to the sync image for CTD + sync-with-icons: + description: | + Corresponding to the sync-devices image + themeing: + description: | + Corresponding to the fox world image + toolbar: + description: | + Corresponding to the fox world image + trackers: + description: | + Corresponding to the trackers image + welcome-ctd: + description: | + Corresponding to the welcome image for CTD + welcome-globe: + description: | + Corresponding to the fox world image + NimbusOnboardingMultipleChoiceButtonImage: + description: | + The identifiers for the different images available for multiple choice buttons in onboarding + variants: + theme-dark: + description: | + Corresponding to the dark theme + theme-light: + description: | + Corresponding to the light theme + theme-system: + description: | + Corresponding to the system theme + toolbar-bottom: + description: | + Corresponding to the toolbar on the bottom + toolbar-top: + description: | + Corresponding to the toolbar on top + OnboardingActions: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + end-onboarding: + description: | + Will end the onboarding on a set card + forward-one-card: + description: | + Will take the user to the next card + forward-three-card: + description: | + Will take the user to the next card + forward-two-card: + description: | + Will take the user to the next card + open-instructions-popup: + description: | + Will open up a popup with instructions for something + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + read-privacy-policy: + description: | + Will open a webview where the user can read the privacy policy + request-notifications: + description: | + Will request to allow notifications from the user + set-default-browser: + description: | + Will send the user to settings to set Firefox as their default browser and advance to next card + sync-sign-in: + description: | + Will take the user to the sync sign in flow + OnboardingCardType: + description: | + The identifiers for the different types of onboarding cards. + variants: + basic: + description: | + Corresponding to basic info onboarding cards + multiple-choice: + description: | + Corresponding to onboarding cards with multiple choice buttons + OnboardingInstructionsPopupActions: + description: | + The identifiers for the different actions available for the insturction card in onboarding + variants: + dismiss: + description: | + Will dismiss the popup + dismiss-and-next-card: + description: | + Will dismiss the popup and move to the next card + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + OnboardingMultipleChoiceAction: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + theme-dark: + description: | + Will will set the theme to dark mode + theme-light: + description: | + Will set the theme to light mode + theme-system-default: + description: | + Will set the theme to use the system theme + toolbar-bottom: + description: | + Will set the toolbar on the bottom + toolbar-top: + description: | + Will set the toolbar on the top + OnboardingType: + description: | + The identifiers for the different types of onboarding cards. + variants: + fresh-install: + description: | + Corresponding to onboarding cards that are for new users + upgrade: + description: | + Corresponding to onboarding cards that are for users who have updated + OnboardingVariant: + description: | + Which UI style this onboarding card is designed for. + variants: + legacy: + description: Use the existing (legacy) onboarding UI. + modern: + description: Use the new (modern) onboarding UI. + PageContent: + description: The page content that will be added as an item in the device's search engine. + variants: + html-content: + description: Use all the page as HTML + text-content: + description: Use all the page as text + text-excerpt: + description: Only use the first paragraph + StartAtHome: + description: The option for what screen to open the app to + variants: + afterFourHours: + description: Starts the app at the homepage after four hours of inactivity, otherwise starts the app at the most recently viewed tab. + always: + description: Starts the app at the homepage. + disabled: + description: Starts the app at the most recently viewed tab. + SuggestionType: + description: The type of a Firefox Suggest search suggestion. + variants: + amp: + description: A Firefox Suggestion for desktop from adMarketplace. + ampMobile: + description: A Firefox Suggestion specifically for mobile from adMarketplace. + wikipedia: + description: A Firefox Suggestion for a Wikipedia page. + TabTraySection: + description: The identifiers for the sections of the tab tray. + variants: + inactive-tabs: + description: Tabs that have been automatically closed for the user. + ToolbarLayoutType: + description: The type of toolbar layout. + variants: + baseline: + description: The default layout of the toolbars. + version1: + description: Shows the add new tab, menu and tabs button in the navigation toolbar. The share button is displayed in the address toolbar. + version2: + description: Like version1 but the menu and tabs buttons are inverted. +objects: + AwesomeBar: + description: A configuration option for the awesome bar. Part of the `search` feature. + fields: + min-search-term: + description: The minimum number of characters that the user types before searching in the page. + type: Int + default: 3 + position: + description: | + This property defines whether or not the feature is enabled, and the position of the search bar + type: SearchBarPositionFeature + default: + is-position-feature-enabled: true + is-bottom: true + search-highlights: + description: Whether or not search highlights are enabled + type: Boolean + default: false + use-page-content: + description: Search in the open tab's text content when typing. + type: Boolean + default: false + DiscoverMoreConfiguration: + description: | + A configuration that dictates the behaviour/subfeatures of the Discover More feature + fields: + discover-more-v1-experience: + description: | + Whether to show the Discover More experience is enabled + type: Boolean + default: false + show-discover-more-button: + description: | + Whether to show the Discover More button on the homepage + type: Boolean + default: false + GeneralFeature: + description: The configuration for the a feature that can be enabled or disabled + fields: + status: + description: Whether or not the feature is enabled + type: Boolean + default: false + MessageData: + description: | + An object to describe a message. It uses human readable strings to describe the triggers, action and style of the message as well as the text of the message and call to action. + fields: + action: + description: | + The name of a deeplink URL to be opened if the button is clicked. + type: Option + default: null + action-params: + description: Query parameters appended to the deeplink action URL + type: Map + default: {} + button-label: + description: | + The text on the button. If no text is present, the whole message is clickable. + type: Option + default: null + except-if-any: + description: | + A list of strings corresponding to targeting expressions. If any of these expressions evaluate to `true`, the message will not be eligible. + type: List + default: [] + experiment: + description: The experiment slug that this message is involved in. + type: Option + default: null + is-control: + description: Indicates if this message is the control message, if true shouldn't be displayed + type: Boolean + default: false + microsurveyConfig: + description: Optional configuration data for a microsurvey. + type: Option + default: null + style: + description: | + The style as described in a `StyleData` from the styles table. + type: StyleName + default: DEFAULT + surface: + description: Each message will tell us the surface it is targeting with this. + type: MessageSurfaceId + default: Unknown + text: + description: The message text displayed to the user + type: Text + default: '' + title: + description: The title text displayed to the user + type: Option + default: null + trigger-if-all: + description: | + A list of strings corresponding to targeting expressions. All named expressions must evaluate to true if the message is to be eligible to be shown. + type: List + default: + - ALWAYS + MicrosurveyConfig: + description: | + Attributes relating to microsurvey messaging. + fields: + icon: + description: The asset name in our bundle used as the icon shown in the survey. + type: Image + default: lightbulbLarge + options: + description: The list of survey options to present to the user. + type: List + default: [] + utm-content: + description: The name used to provide as the utm_content parameter for the privacy notice. + type: Option + default: null + NimbusOnboardingButton: + description: | + A group of properties describing the attributes of a card. + fields: + action: + description: | + The action the button should take. The default for this will be "forward-one-card" + type: OnboardingActions + default: forward-one-card + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingButtons: + description: | + A set of buttons for the card. There can be up to two, but there must be at least one. + fields: + primary: + description: | + The primary button for the card. This must exist. + type: NimbusOnboardingButton + default: + title: Primary Button + action: forward-one-card + secondary: + description: | + A secondary, optional, button for the card. + type: Option + default: null + NimbusOnboardingCardData: + description: | + A group of properties describing the attributes of a card. + fields: + body: + description: | + The body text dispalyed on the card, in less prominent text. This should never be defaulted. + type: Text + default: '' + buttons: + description: | + The set of buttons associated with the card. + type: NimbusOnboardingButtons + default: + primary: + title: Onboarding/Onboarding.Sync.Skip.Action.v114 + action: forward-one-card + secondary: null + card-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingCardType + default: basic + disqualifiers: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will not be shown if any expression is `true`. + type: List + default: [] + image: + description: | + The image that should be dispalyed on the card. + type: NimbusOnboardingHeaderImage + default: welcome-globe + instructions-popup: + description: | + The object describing the specific instruction popup button for a card. If left empty, the card will have no instruction popup information + type: Option + default: null + link: + description: | + The object describing the link button for a card. If left empty, the card will have no link. + type: Option + default: null + multiple-choice-buttons: + description: | + A list of multiple choice buttons that the card will display + type: List + default: [] + onboarding-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingType + default: fresh-install + order: + description: | + The place in the order where the card will be found. The feature layer will then sort the cards based on this field. + type: Int + default: 10 + prerequisites: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will be shown if all expressions `true` and if no expressions in the `disqualifiers` table are true, or if the `disqualifiers` table is empty. + type: List + default: [] + title: + description: | + The title displayed on the card, in prominent, bolded text. This should never be defaulted. + type: Text + default: '' + uiVariant: + description: | + If set, this card will only be shown in the specified UI variant. If null, it will appear in both legacy and modern UIs. + type: Option + default: null + NimbusOnboardingInstructionPopup: + description: | + The object outlining the content of the instruction card. + fields: + button-action: + description: | + The action the button should have. Default is `dismiss-and-next-card` + type: OnboardingInstructionsPopupActions + default: dismiss-and-next-card + button-title: + description: | + The title the button should have. This should never be defaulted. + type: Text + default: '' + instructions: + description: | + A list of instructions, either as free text, or as Text identifiers. + type: List + default: [] + title: + description: | + The text of the popup. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingLink: + description: | + A group of properties describing the attributes for the active link on a card + fields: + title: + description: | + The text of the link title. + type: Text + default: Onboarding/Onboarding.Welcome.Link.Action.v114 + url: + description: | + The url that the link will lead to. + type: String + default: https://www.mozilla.org/privacy/firefox/ + NimbusOnboardingMultipleChoiceButton: + description: | + A group of properties describing the attributes of a multiple choice button on a card + fields: + action: + description: | + The action the button should take. The default for this will be "theme-system-default" + type: OnboardingMultipleChoiceAction + default: theme-system-default + image: + description: | + The text of the button title. This should never be defaulted. + type: NimbusOnboardingMultipleChoiceButtonImage + default: theme-system + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + SearchBarPositionFeature: + description: The configuration for the bottom search bar on the homescreen + fields: + is-bottom: + description: Whether or not the default position is at the bottom + type: Boolean + default: true + is-position-feature-enabled: + description: Whether or not the feature is enabled + type: Boolean + default: true + StyleData: + description: | + A group of properities (predominantly visual) to the describe style of the message. + fields: + max-display-count: + description: | + How many sessions will this message be shown to the user before it is expired. + type: Int + default: 5 + priority: + description: | + The importance of this message. 0 is not very important, 100 is very important. + type: Int + default: 50 diff --git a/experimenter/experimenter/features/manifests/ios/v143.0.1/developer.fml.yaml b/experimenter/experimenter/features/manifests/ios/v143.0.1/developer.fml.yaml new file mode 100644 index 0000000000..d7d63486f4 --- /dev/null +++ b/experimenter/experimenter/features/manifests/ios/v143.0.1/developer.fml.yaml @@ -0,0 +1,1376 @@ +version: 1.0.0 +about: + description: The root level Feature Manifest for Firefox for iOS +channels: +- developer +features: + address-autofill-edit: + description: This property defines if the address editing is enabled in Settings + variables: + status: + description: If true, we will allow user to edit the address + type: Boolean + default: true + address-bar-menu-feature: + description: | + This property determines if we show the new address bar menu entry or the toolbar menu in settings + variables: + status: + description: If true, we will show the new address bar menu entry + type: Boolean + default: true + appearance-menu-feature: + description: | + This property determines if we show the new appearance menu entry or the old theme settings + variables: + status: + description: If true, we will show the new appearance menu entry + type: Boolean + default: true + apple-summarizer-feature: + description: | + This feature enables the apple summarizer feature. + variables: + enabled: + description: | + Enables the apple summarizer feature. + type: Boolean + default: true + shakeGesture: + description: | + Enables the shake gesture for the summarizer feature. + type: Boolean + default: true + toolbarEntrypoint: + description: | + Enables the toolbar entrypoint for the summarizer feature. + type: Boolean + default: true + deeplink-optimization-refactor-feature: + description: | + The feature flag to manage the rollout of deeplink optimization feature. + variables: + enabled: + description: | + Variable description + type: Boolean + default: true + default-zoom-feature: + description: | + The feature flag to manage the rollout of default zoom feature. + variables: + enabled: + description: | + If true, page zoom settings and default zoom feature are shown + type: Boolean + default: true + download-live-activities-feature: + description: | + Download Live Activities Feature + variables: + enabled: + description: | + If true, the download live activities feature is enabled + type: Boolean + default: true + felt-privacy-feature: + description: The feature that enhances private browsing mode + variables: + felt-deletion-enabled: + description: If true, enable Felt Deletion part of Felt Privacy + type: Boolean + default: false + simplified-ui-enabled: + description: If true, enable simplified UI part of Felt Privacy + type: Boolean + default: true + firefox-suggest-feature: + description: Configuration for the Firefox Suggest feature. + variables: + available-suggestions-types: + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + type: Map + default: + amp: true + ampMobile: false + wikipedia: true + status: + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. + type: Boolean + default: true + general-app-features: + description: The feature that contains feature flags for the entire application + variables: + report-site-issue: + description: This property defines whether or not the feature is enabled + type: GeneralFeature + default: + status: true + hnt-sponsored-shortcuts-feature: + description: This feature manages the visibility of sponsored shortcuts on the homepage + variables: + enabled: + description: Setting 'enabled' to false will hide sponsored shortcuts on the homepage and disable the respective toggle in the homepage settings + type: Boolean + default: true + hnt-top-sites-visual-refresh-feature: + description: This feature manages the top sites visual refresh. + variables: + enabled: + description: Determines whether the top sites visual refresh is shown. + type: Boolean + default: true + homepage-rebuild-feature: + description: | + This feature is for managing the roll out of the Homepage rebuild feature + variables: + enabled: + description: | + If true, enables the feature + type: Boolean + default: true + homepage-redesign-feature: + description: | + This feature is for managing the roll out of the Homepage New Tab Redesign feature. + variables: + discover-more-feature-configuration: + description: | + A configuration for the Discover More feature + type: DiscoverMoreConfiguration + default: + discover-more-v1-experience: false + show-discover-more-button: false + enabled: + description: | + Enables the feature. + type: Boolean + default: false + search-bar: + description: | + If true, enables the search bar feature on homepage for users. + type: Boolean + default: true + shortcuts-library: + description: | + If true, enables the shortcuts library feature, accessible from the homepage + type: Boolean + default: false + stories-redesign: + description: | + If true, enables the stories section redesign on homepage, which also includes the removal of other sections (i.e. jump back in, bookmarks) + type: Boolean + default: true + hosted-summarizer-feature: + description: | + This feature enables the hosted summarizer feature. + variables: + enabled: + description: | + Enables the hosted summarizer feature. + type: Boolean + default: true + shakeGesture: + description: | + Enables the shake gesture for the summarizer feature. + type: Boolean + default: true + toolbarEntrypoint: + description: | + Enables the toolbar entrypoint for the summarizer feature. + type: Boolean + default: true + logins-verification: + description: | + Feature that enables the logins verification logic. + variables: + logins-verification-enabled: + description: | + Whether the logins verification logic is enabled. When enabled, an attempt will be made to decrypt all stored logins when sync is enabled. If a login cannot be decrypted, it will be locally deleted to unblock syncing. + type: Boolean + default: true + menu-refactor-feature: + description: | + Controls the menu refactor feature + variables: + enabled: + description: | + Controls which menu users will see + type: Boolean + default: true + menu-default-browser-banner: + description: | + If true, enables the menu Make Firefox your default banner, on top of the menu. + type: Boolean + default: true + menu-redesign-hint: + description: | + If true, enables the menu contextual hint for menu redesign. + type: Boolean + default: true + messaging: + description: | + The in-app messaging system + documentation: + - name: User documentation + url: https://experimenter.info/messaging/mobile-messaging + contacts: + - jhugman@mozilla.com + - brennie@mozilla.com + - gbuciu@mozilla.com + - wteichmann@mozilla.com + events: + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_shown + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_clicked + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_expired + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_dismissed + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_malformed + variables: + actions: + description: A growable map of action URLs. + type: Map + default: + OPEN_SETTINGS: ://deep-link?url=settings/general + OPEN_SETTINGS_NEW_TAB: ://deep-link?url=settings/newtab + OPEN_SETTINGS_HOMESCREEN: ://deep-link?url=settings/homepage + OPEN_SETTINGS_WALLPAPERS: ://deep-link?url=settings/wallpaper + OPEN_SETTINGS_EMAIL: ://deep-link?url=settings/mailto + OPEN_SETTINGS_SEARCH_ENGINE: ://deep-link?url=settings/search + OPEN_SETTINGS_PRIVACY: ://deep-link?url=settings/clear-private-data + OPEN_SETTINGS_FXA: ://deep-link?url=settings/fxa + OPEN_SETTINGS_THEME: ://deep-link?url=settings/theme + OPEN_SETTINGS_APP_ICON: ://deep-link?url=settings/app-icon + OPEN_URL: ://open-url + VIEW_BOOKMARKS: ://deep-link?url=homepanel/bookmarks + VIEW_TOP_SITES: ://deep-link?url=homepanel/top-sites + VIEW_READING_LIST: ://deep-link?url=homepanel/reading-list + VIEW_HISTORY: ://deep-link?url=homepanel/history + VIEW_DOWNLOADS: ://deep-link?url=homepanel/downloads + ENABLE_PRIVATE_BROWSING: ://deep-link?url=homepanel/new-private-tab + OPEN_NEW_TAB: ://deep-link?url=homepanel/new-tab + MAKE_DEFAULT_BROWSER: ://deep-link?url=default-browser/system-settings + MAKE_DEFAULT_BROWSER_WITH_TUTORIAL: ://deep-link?url=default-browser/tutorial + OPEN_SHARE_SHEET: ://share-sheet + string-alias: ActionName + message-under-experiment: + description: 'Deprecated. Please use "experiment": "{experiment}" instead.' + type: Option + default: null + messages: + description: | + A growable collection of messages, where the Key is the message identifier and the value is its associated MessageData. + type: Map + default: + homepage-microsurvey-message: + surface: microsurvey + style: MICROSURVEY + trigger-if-all: + - SECOND_HOMEPAGE_VIEW + title: Microsurvey/Microsurvey.Prompt.TitleLabel.v127 + text: How satisfied are you with your Firefox homepage? + button-label: Microsurvey/Microsurvey.Prompt.Button.v127 + microsurveyConfig: + utm-content: homepage + icon: homeLarge + options: + - Microsurvey/Microsurvey.Survey.Options.VerySatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.Satisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.Neutral.v132 + - Microsurvey/Microsurvey.Survey.Options.Dissatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.VeryDissatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.NotApplicable.v132 + survey-surface-message: + surface: survey + style: SURVEY + trigger-if-all: + - NEVER + text: ResearchSurface/Body.Text.v112 + button-label: ResearchSurface/PrimaryButton.Label.v112 + action: OPEN_URL + action-params: + url: https://www.macrumors.com + string-alias: MessageKey + on-control: + description: What should be displayed when a control message is selected. + type: ControlMessageBehavior + default: show-next-message + styles: + description: | + A map of styles to configure message appearance. + type: Map + default: + FALLBACK: + priority: 40 + max-display-count: 20 + DEFAULT: + priority: 50 + max-display-count: 5 + MICROSURVEY: + priority: 50 + max-display-count: 1 + NOTIFICATION: + priority: 50 + max-display-count: 1 + PERSISTENT: + priority: 50 + max-display-count: 20 + SURVEY: + priority: 55 + max-display-count: 10 + WARNING: + priority: 60 + max-display-count: 10 + URGENT: + priority: 100 + max-display-count: 10 + string-alias: StyleName + triggers: + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + USER_RECENTLY_INSTALLED: days_since_install < 7 + USER_RECENTLY_UPDATED: days_since_update < 7 && days_since_install != days_since_update + USER_TIER_ONE_COUNTRY: ('US' in locale || 'GB' in locale || 'CA' in locale || 'DE' in locale || 'FR' in locale) + USER_EN_SPEAKER: '''en'' in locale' + USER_ES_SPEAKER: '''es'' in locale' + USER_DE_SPEAKER: '''de'' in locale' + USER_FR_SPEAKER: '''fr'' in locale' + DEVICE_ANDROID: os == 'Android' + DEVICE_IOS: os == 'iOS' + DAY_1_AFTER_INSTALL: days_since_install == 1 + DAY_2_AFTER_INSTALL: days_since_install == 2 + DAY_3_AFTER_INSTALL: days_since_install == 3 + DAY_4_AFTER_INSTALL: days_since_install == 4 + DAY_5_AFTER_INSTALL: days_since_install == 5 + MORE_THAN_24H_SINCE_INSTALLED_OR_UPDATED: days_since_update >= 1 + NOT_LAUNCHED_YESTERDAY: '''app_cycle.foreground''|eventLastSeen(''Days'', 1) > 1' + AFTER_THREE_LAUNCHES_THIS_WEEK: '''app_cycle.foreground''|eventSum(''Weeks'', 1, 0) >= 3' + I_AM_DEFAULT_BROWSER: is_default_browser + I_AM_NOT_DEFAULT_BROWSER: is_default_browser == false + SUPPORTS_DEFAULT_BROWSER: os_version|versionCompare('14.!') >= 0 + INACTIVE_NEW_USER: is_inactive_new_user + ALLOWED_TIPS_NOTIFICATIONS: allowed_tips_notifications + FXA_CURRENTLY_SIGNED_IN: is_fxa_signed_in == true + SECOND_HOMEPAGE_VIEW: '''homepage_viewed''|eventSum(''Years'', 4, 0) >= 2' + ON_FOURTH_LAUNCH_THIS_YEAR: '''app_cycle.foreground''|eventSum(''Years'', 1, 0) > 3' + string-alias: TriggerName + ~~experiment: + description: Not to be set by experiment. + type: ExperimentSlug + default: '{experiment}' + string-alias: ExperimentSlug + allow-coenrollment: true + microsurvey-feature: + description: | + A feature that shows the microsurvey for users to interact with and submit responses. + variables: + enabled: + description: | + If true, the feature is active. + type: Boolean + default: true + native-error-page-feature: + description: | + This feature is for managing the roll out of the native error page feature + variables: + enabled: + description: | + If true, the feature is active. + type: Boolean + default: false + no_internet_connection_error: + description: | + This feature is for managing the roll out of the no interet connection native error page feature + type: Boolean + default: false + onboarding-framework-feature: + description: | + The new onboarding framework feature that will allow onboarding to be experimentable through initial experiments. + variables: + cards: + description: | + The list of available cards for onboarding. + type: Map + default: + welcome: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Welcome.Title.TreatementA.v120 + body: Onboarding/Onboarding.Welcome.Description.TreatementA.v120 + image: welcome-globe + buttons: + primary: + title: Onboarding/Onboarding.Welcome.ActionTreatementA.v114 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Welcome.Skip.v114 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + notification-permissions: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Notification.Title.v120 + body: Onboarding/Onboarding.Notification.Description.v120 + image: notifications + buttons: + primary: + title: Onboarding/Onboarding.Notification.TurnOnNotifications.Action.v114 + action: request-notifications + secondary: + title: Onboarding/Onboarding.Notification.Skip.Action.v115 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + sign-to-sync: + card-type: basic + order: 20 + title: Onboarding/Onboarding.Sync.Title.v120 + body: Onboarding/Onboarding.Sync.Description.v123 + image: sync-devices + buttons: + primary: + title: Onboarding/Onboarding.Sync.SignIn.Action.v114 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Sync.Skip.Action.v114 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + customization-theme: + card-type: multiple-choice + order: 40 + title: Onboarding/Onboarding.Customization.Theme.Title.v123 + body: Onboarding/Onboarding.Customization.Theme.Description.v123 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Customization.Theme.Continue.Action.v123 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Theme.System.Action.v123 + image: theme-system + action: theme-system-default + - title: Onboarding/Onboarding.Customization.Theme.Light.Action.v123 + image: theme-light + action: theme-light + - title: Onboarding/Onboarding.Customization.Theme.Dark.Action.v123 + image: theme-dark + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + customization-toolbar: + card-type: multiple-choice + order: 41 + title: Onboarding/Onboarding.Customization.Toolbar.Title.v123 + body: Onboarding/Onboarding.Customization.Toolbar.Description.v123 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Customization.Toolbar.Continue.Action.v123 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Toolbar.Top.Action.v123 + image: toolbar-top + action: toolbar-top + - title: Onboarding/Onboarding.Customization.Toolbar.Bottom.Action.v123 + image: toolbar-bottom + action: toolbar-bottom + onboarding-type: fresh-install + prerequisites: + - ALWAYS + update-welcome: + card-type: basic + order: 10 + title: Upgrade/Upgrade.Welcome.Title.v114 + body: Upgrade/Upgrade.Welcome.Description.v114 + image: welcome-globe + buttons: + primary: + title: Upgrade/Upgrade.Welcome.Action.v114 + action: forward-one-card + onboarding-type: upgrade + prerequisites: + - NEVER + update-sign-to-sync: + card-type: basic + order: 20 + title: Upgrade/Upgrade.SyncSign.Title.v114 + body: Upgrade/Upgrade.SyncSign.Description.v114 + image: sync-devices + buttons: + primary: + title: Upgrade/Upgrade.SyncSign.Action.v114 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.LaterAction.v114 + action: forward-one-card + onboarding-type: upgrade + prerequisites: + - NEVER + welcome-modern: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.Welcome.Title.v140 + body: Onboarding/Onboarding.Modern.Welcome.Description.v140 + image: trackers + buttons: + primary: + title: Onboarding/Onboarding.Modern.Welcome.ActionTreatementA.v140 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.Welcome.Skip.v140 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + sign-to-sync-modern: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.Sync.Title.v140 + body: Onboarding/Onboarding.Modern.Sync.Description.v140 + image: sync-with-icons + buttons: + primary: + title: Onboarding/Onboarding.Modern.Sync.SignIn.Action.v140 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.Sync.Skip.Action.v140 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-toolbar-modern: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Title.v140 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v140 + image: toolbar-bottom + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v140 + image: toolbar-top + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-theme-modern: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Customization.Theme.Title.v143 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Theme.System.Action.v123 + image: theme-system + action: theme-system-default + - title: Onboarding/Onboarding.Customization.Theme.Light.Action.v123 + image: theme-light + action: theme-light + - title: Onboarding/Onboarding.Customization.Theme.Dark.Action.v123 + image: theme-dark + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + string-alias: NimbusOnboardingCardKey + conditions: + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + string-alias: ConditionName + dismissable: + description: | + Whether or not the entire onboarding is dismissable by pressing an X at the top right corner of the screen. + type: Boolean + default: true + enableModernUi: + description: | + Toggle between legacy (false) and modern (true) UI variants. + type: Boolean + default: false + pdf-refactor-feature: + description: | + The feature flag to manage the roll out of the pdf refactor feature. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: true + revert-unsafe-continuations-refactor: + description: | + A feature flag to wrap reverting the unsafe continuations usage in the app. Unsafe continuations were used in response to an early 2025 incident when iOS 18.0 (possibly beta only) crashed on checked continuations (both regular and throwing). + variables: + enabled: + description: | + If true, revert unsafe continuations usage back to normal checked continuations usage. + type: Boolean + default: true + search: + description: | + Configuring the functionality to do with search. This will be separated into smaller sub-features in later releases. + variables: + awesome-bar: + description: Configuring the awesome bar. + type: AwesomeBar + default: + min-search-term: 3 + position: + is-bottom: false + is-position-feature-enabled: true + search-highlights: false + use-page-content: false + search-engine-consolidation-feature: + description: | + This feature is for managing the roll out of Search Engine Consolidation support in iOS + variables: + enabled: + description: | + Enables the feature + 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: 6000 + spotlight-search: + description: Add pages as items findable with Spotlight. + variables: + enabled: + description: If this is true, then on each page load adds a new item to Spotlight. + type: Boolean + default: true + icon-type: + description: | + The icon that is displayed next to the item in the search results. If this is `null`, then no icon is displayed. + type: Option + default: screenshot + keep-for-days: + description: | + Number of days to keep the item before automatic deletion. If this is left `null`, then it is left to iOS's default. + type: Option + default: null + searchable-content: + description: | + The text content that is made searchable. If this is `null` then no additional content is used, and only the title and URL will be used. + type: Option + default: text-excerpt + start-at-home-feature: + description: This feature is for experimenting with opening screen + variables: + setting: + description: This property provides a default setting for the start at home feature + type: StartAtHome + default: afterFourHours + tab-scroll-refactor-feature: + description: | + The feature flag to manage the rollout of tab scroll refactor feature. + variables: + enabled: + description: | + If true, tab scroll new implementation is used to show and hide toolbar views reacting to user scroll + type: Boolean + default: false + tab-tray-ui-experiments: + description: | + The tab tray will undergo some UI experimentation to test potential improvements. + variables: + enabled: + description: | + If true, enables the tab tray UI experiments. + type: Boolean + default: true + tabTrayFeature: + description: The tab tray screen that the user goes to when they open the tab tray. + 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: + inactive-tabs: true + toolbar-refactor-feature: + description: | + This feature is for managing the roll out of the Toolbar refactor feature + variables: + enabled: + description: | + Enables the feature + type: Boolean + default: true + layout: + description: | + The type of layout of the toolbars. + type: Option + default: version1 + minimal_address_bar: + description: | + Enables minimal address bar mode on scroll to ensure the url is always visible. + type: Boolean + default: true + navigation_hint: + description: | + If true, enables the navigation contextual hint. + type: Boolean + default: true + one_tap_new_tab: + description: | + If true, enables the one tap new tab feature for users. + type: Boolean + default: true + swiping_tabs: + description: | + Enables swipe gestures to switch between browser tabs. + type: Boolean + default: true + toolbar_update_hint: + description: | + If true, enables the toolbar update contextual hint. + type: Boolean + default: false + translucency: + description: | + Enables translucency for toolbars. + type: Boolean + default: true + unified_search: + description: | + Enables the unified search feature. + type: Boolean + default: false + tos-feature: + description: | + This feature is for managing the roll out of the ToS (Term of Service) implementation + variables: + status: + description: | + Enables the feature + type: Boolean + default: false + tou-feature: + description: | + This feature is for managing the rollout of the Terms of Use (ToU) implementation. + variables: + status: + description: | + Enables the feature + type: Boolean + default: false + tracking-protection-refactor: + description: | + The Enhanced Tracking Protection refactor + variables: + enabled: + description: | + Whether the Enhanced Tracking Protection refactor is enabled or not + type: Boolean + default: true + unified-ads: + description: | + This property is for managing the roll out of the unified ads API + variables: + enabled: + description: | + If true, we will enable user to use the unified ads API + type: Boolean + default: true + updated-password-manager-feature: + description: | + This property determines if we use the updated password manager or the legacy one. + variables: + status: + description: If true, firefox will use the the updated password manager. + type: Boolean + default: false + web-engine-integration-refactor: + description: | + The feature flag to manage the roll out of the integration of WebEngine into Firefox. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false +enums: + ControlMessageBehavior: + description: An enum to influence what should be displayed when a control message is selected. + variants: + show-next-message: + description: The next eligible message should be shown. + show-none: + description: The surface should show no message. + IconType: + description: The icon that will be added to the item in the device's search engine. + variants: + favicon: + description: The favicon of the page + letter: + description: An icon generated from the first letter of the base domain. + screenshot: + description: A screenshot of the page at load time. + MessageSurfaceId: + description: | + For messaging, we would like to have a message tell us which surface its associated with. This is a label that matches across both Android and iOS. + variants: + Unknown: + description: A message has NOT declared its target surface. + microsurvey: + description: This is a microsurvey that appears on top of the bottom toolbar to the user. + new-tab-card: + description: This is the card that appears at the top on the Firefox Home Page. + notification: + description: This is a local notification send to the user periodically with tips and updates. + survey: + description: This is a full-page that appears providing a survey to the user. + NimbusOnboardingHeaderImage: + description: | + The identifiers for the different images available for cards in onboarding + variants: + customize-firefox: + description: | + Corresponding to the fox window image + notifications: + description: | + Corresponding to the notifications image + notifications-ctd: + description: | + Corresponding to the notifications image for CTD + search-widget: + description: | + Corresponding to the fox search widget image + set-default-steps: + description: | + Corresponding to the set to default steps image + set-to-dock: + description: | + Corresponding to the set to dock image + sync-devices: + description: | + Corresponding to the sync-devices image + sync-devices-ctd: + description: | + Corresponding to the sync image for CTD + sync-with-icons: + description: | + Corresponding to the sync-devices image + themeing: + description: | + Corresponding to the fox world image + toolbar: + description: | + Corresponding to the fox world image + trackers: + description: | + Corresponding to the trackers image + welcome-ctd: + description: | + Corresponding to the welcome image for CTD + welcome-globe: + description: | + Corresponding to the fox world image + NimbusOnboardingMultipleChoiceButtonImage: + description: | + The identifiers for the different images available for multiple choice buttons in onboarding + variants: + theme-dark: + description: | + Corresponding to the dark theme + theme-light: + description: | + Corresponding to the light theme + theme-system: + description: | + Corresponding to the system theme + toolbar-bottom: + description: | + Corresponding to the toolbar on the bottom + toolbar-top: + description: | + Corresponding to the toolbar on top + OnboardingActions: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + end-onboarding: + description: | + Will end the onboarding on a set card + forward-one-card: + description: | + Will take the user to the next card + forward-three-card: + description: | + Will take the user to the next card + forward-two-card: + description: | + Will take the user to the next card + open-instructions-popup: + description: | + Will open up a popup with instructions for something + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + read-privacy-policy: + description: | + Will open a webview where the user can read the privacy policy + request-notifications: + description: | + Will request to allow notifications from the user + set-default-browser: + description: | + Will send the user to settings to set Firefox as their default browser and advance to next card + sync-sign-in: + description: | + Will take the user to the sync sign in flow + OnboardingCardType: + description: | + The identifiers for the different types of onboarding cards. + variants: + basic: + description: | + Corresponding to basic info onboarding cards + multiple-choice: + description: | + Corresponding to onboarding cards with multiple choice buttons + OnboardingInstructionsPopupActions: + description: | + The identifiers for the different actions available for the insturction card in onboarding + variants: + dismiss: + description: | + Will dismiss the popup + dismiss-and-next-card: + description: | + Will dismiss the popup and move to the next card + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + OnboardingMultipleChoiceAction: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + theme-dark: + description: | + Will will set the theme to dark mode + theme-light: + description: | + Will set the theme to light mode + theme-system-default: + description: | + Will set the theme to use the system theme + toolbar-bottom: + description: | + Will set the toolbar on the bottom + toolbar-top: + description: | + Will set the toolbar on the top + OnboardingType: + description: | + The identifiers for the different types of onboarding cards. + variants: + fresh-install: + description: | + Corresponding to onboarding cards that are for new users + upgrade: + description: | + Corresponding to onboarding cards that are for users who have updated + OnboardingVariant: + description: | + Which UI style this onboarding card is designed for. + variants: + legacy: + description: Use the existing (legacy) onboarding UI. + modern: + description: Use the new (modern) onboarding UI. + PageContent: + description: The page content that will be added as an item in the device's search engine. + variants: + html-content: + description: Use all the page as HTML + text-content: + description: Use all the page as text + text-excerpt: + description: Only use the first paragraph + StartAtHome: + description: The option for what screen to open the app to + variants: + afterFourHours: + description: Starts the app at the homepage after four hours of inactivity, otherwise starts the app at the most recently viewed tab. + always: + description: Starts the app at the homepage. + disabled: + description: Starts the app at the most recently viewed tab. + SuggestionType: + description: The type of a Firefox Suggest search suggestion. + variants: + amp: + description: A Firefox Suggestion for desktop from adMarketplace. + ampMobile: + description: A Firefox Suggestion specifically for mobile from adMarketplace. + wikipedia: + description: A Firefox Suggestion for a Wikipedia page. + TabTraySection: + description: The identifiers for the sections of the tab tray. + variants: + inactive-tabs: + description: Tabs that have been automatically closed for the user. + ToolbarLayoutType: + description: The type of toolbar layout. + variants: + baseline: + description: The default layout of the toolbars. + version1: + description: Shows the add new tab, menu and tabs button in the navigation toolbar. The share button is displayed in the address toolbar. + version2: + description: Like version1 but the menu and tabs buttons are inverted. +objects: + AwesomeBar: + description: A configuration option for the awesome bar. Part of the `search` feature. + fields: + min-search-term: + description: The minimum number of characters that the user types before searching in the page. + type: Int + default: 3 + position: + description: | + This property defines whether or not the feature is enabled, and the position of the search bar + type: SearchBarPositionFeature + default: + is-position-feature-enabled: true + is-bottom: true + search-highlights: + description: Whether or not search highlights are enabled + type: Boolean + default: false + use-page-content: + description: Search in the open tab's text content when typing. + type: Boolean + default: false + DiscoverMoreConfiguration: + description: | + A configuration that dictates the behaviour/subfeatures of the Discover More feature + fields: + discover-more-v1-experience: + description: | + Whether to show the Discover More experience is enabled + type: Boolean + default: false + show-discover-more-button: + description: | + Whether to show the Discover More button on the homepage + type: Boolean + default: false + GeneralFeature: + description: The configuration for the a feature that can be enabled or disabled + fields: + status: + description: Whether or not the feature is enabled + type: Boolean + default: false + MessageData: + description: | + An object to describe a message. It uses human readable strings to describe the triggers, action and style of the message as well as the text of the message and call to action. + fields: + action: + description: | + The name of a deeplink URL to be opened if the button is clicked. + type: Option + default: null + action-params: + description: Query parameters appended to the deeplink action URL + type: Map + default: {} + button-label: + description: | + The text on the button. If no text is present, the whole message is clickable. + type: Option + default: null + except-if-any: + description: | + A list of strings corresponding to targeting expressions. If any of these expressions evaluate to `true`, the message will not be eligible. + type: List + default: [] + experiment: + description: The experiment slug that this message is involved in. + type: Option + default: null + is-control: + description: Indicates if this message is the control message, if true shouldn't be displayed + type: Boolean + default: false + microsurveyConfig: + description: Optional configuration data for a microsurvey. + type: Option + default: null + style: + description: | + The style as described in a `StyleData` from the styles table. + type: StyleName + default: DEFAULT + surface: + description: Each message will tell us the surface it is targeting with this. + type: MessageSurfaceId + default: Unknown + text: + description: The message text displayed to the user + type: Text + default: '' + title: + description: The title text displayed to the user + type: Option + default: null + trigger-if-all: + description: | + A list of strings corresponding to targeting expressions. All named expressions must evaluate to true if the message is to be eligible to be shown. + type: List + default: + - ALWAYS + MicrosurveyConfig: + description: | + Attributes relating to microsurvey messaging. + fields: + icon: + description: The asset name in our bundle used as the icon shown in the survey. + type: Image + default: lightbulbLarge + options: + description: The list of survey options to present to the user. + type: List + default: [] + utm-content: + description: The name used to provide as the utm_content parameter for the privacy notice. + type: Option + default: null + NimbusOnboardingButton: + description: | + A group of properties describing the attributes of a card. + fields: + action: + description: | + The action the button should take. The default for this will be "forward-one-card" + type: OnboardingActions + default: forward-one-card + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingButtons: + description: | + A set of buttons for the card. There can be up to two, but there must be at least one. + fields: + primary: + description: | + The primary button for the card. This must exist. + type: NimbusOnboardingButton + default: + title: Primary Button + action: forward-one-card + secondary: + description: | + A secondary, optional, button for the card. + type: Option + default: null + NimbusOnboardingCardData: + description: | + A group of properties describing the attributes of a card. + fields: + body: + description: | + The body text dispalyed on the card, in less prominent text. This should never be defaulted. + type: Text + default: '' + buttons: + description: | + The set of buttons associated with the card. + type: NimbusOnboardingButtons + default: + primary: + title: Onboarding/Onboarding.Sync.Skip.Action.v114 + action: forward-one-card + secondary: null + card-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingCardType + default: basic + disqualifiers: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will not be shown if any expression is `true`. + type: List + default: [] + image: + description: | + The image that should be dispalyed on the card. + type: NimbusOnboardingHeaderImage + default: welcome-globe + instructions-popup: + description: | + The object describing the specific instruction popup button for a card. If left empty, the card will have no instruction popup information + type: Option + default: null + link: + description: | + The object describing the link button for a card. If left empty, the card will have no link. + type: Option + default: null + multiple-choice-buttons: + description: | + A list of multiple choice buttons that the card will display + type: List + default: [] + onboarding-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingType + default: fresh-install + order: + description: | + The place in the order where the card will be found. The feature layer will then sort the cards based on this field. + type: Int + default: 10 + prerequisites: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will be shown if all expressions `true` and if no expressions in the `disqualifiers` table are true, or if the `disqualifiers` table is empty. + type: List + default: [] + title: + description: | + The title displayed on the card, in prominent, bolded text. This should never be defaulted. + type: Text + default: '' + uiVariant: + description: | + If set, this card will only be shown in the specified UI variant. If null, it will appear in both legacy and modern UIs. + type: Option + default: null + NimbusOnboardingInstructionPopup: + description: | + The object outlining the content of the instruction card. + fields: + button-action: + description: | + The action the button should have. Default is `dismiss-and-next-card` + type: OnboardingInstructionsPopupActions + default: dismiss-and-next-card + button-title: + description: | + The title the button should have. This should never be defaulted. + type: Text + default: '' + instructions: + description: | + A list of instructions, either as free text, or as Text identifiers. + type: List + default: [] + title: + description: | + The text of the popup. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingLink: + description: | + A group of properties describing the attributes for the active link on a card + fields: + title: + description: | + The text of the link title. + type: Text + default: Onboarding/Onboarding.Welcome.Link.Action.v114 + url: + description: | + The url that the link will lead to. + type: String + default: https://www.mozilla.org/privacy/firefox/ + NimbusOnboardingMultipleChoiceButton: + description: | + A group of properties describing the attributes of a multiple choice button on a card + fields: + action: + description: | + The action the button should take. The default for this will be "theme-system-default" + type: OnboardingMultipleChoiceAction + default: theme-system-default + image: + description: | + The text of the button title. This should never be defaulted. + type: NimbusOnboardingMultipleChoiceButtonImage + default: theme-system + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + SearchBarPositionFeature: + description: The configuration for the bottom search bar on the homescreen + fields: + is-bottom: + description: Whether or not the default position is at the bottom + type: Boolean + default: true + is-position-feature-enabled: + description: Whether or not the feature is enabled + type: Boolean + default: true + StyleData: + description: | + A group of properities (predominantly visual) to the describe style of the message. + fields: + max-display-count: + description: | + How many sessions will this message be shown to the user before it is expired. + type: Int + default: 5 + priority: + description: | + The importance of this message. 0 is not very important, 100 is very important. + type: Int + default: 50 diff --git a/experimenter/experimenter/features/manifests/ios/v143.0.1/experimenter.yaml b/experimenter/experimenter/features/manifests/ios/v143.0.1/experimenter.yaml new file mode 100644 index 0000000000..5ca9e7f183 --- /dev/null +++ b/experimenter/experimenter/features/manifests/ios/v143.0.1/experimenter.yaml @@ -0,0 +1,497 @@ +address-autofill-edit: + description: This property defines if the address editing is enabled in Settings + hasExposure: true + exposureDescription: '' + variables: + status: + type: boolean + description: If true, we will allow user to edit the address +address-bar-menu-feature: + description: | + This property determines if we show the new address bar menu entry or the toolbar menu in settings + hasExposure: true + exposureDescription: '' + variables: + status: + type: boolean + description: If true, we will show the new address bar menu entry +appearance-menu-feature: + description: | + This property determines if we show the new appearance menu entry or the old theme settings + hasExposure: true + exposureDescription: '' + variables: + status: + type: boolean + description: If true, we will show the new appearance menu entry +apple-summarizer-feature: + description: | + This feature enables the apple summarizer feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the apple summarizer feature. + shakeGesture: + type: boolean + description: | + Enables the shake gesture for the summarizer feature. + toolbarEntrypoint: + type: boolean + description: | + Enables the toolbar entrypoint for the summarizer feature. +deeplink-optimization-refactor-feature: + description: | + The feature flag to manage the rollout of deeplink optimization feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Variable description +default-zoom-feature: + description: | + The feature flag to manage the rollout of default zoom feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, page zoom settings and default zoom feature are shown +download-live-activities-feature: + description: | + Download Live Activities Feature + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, the download live activities feature is enabled +felt-privacy-feature: + description: The feature that enhances private browsing mode + hasExposure: true + exposureDescription: '' + variables: + felt-deletion-enabled: + type: boolean + description: If true, enable Felt Deletion part of Felt Privacy + simplified-ui-enabled: + type: boolean + description: If true, enable simplified UI part of Felt Privacy +firefox-suggest-feature: + description: Configuration for the Firefox Suggest feature. + hasExposure: true + exposureDescription: '' + variables: + available-suggestions-types: + type: json + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + status: + type: boolean + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. +general-app-features: + description: The feature that contains feature flags for the entire application + hasExposure: true + exposureDescription: '' + variables: + report-site-issue: + type: json + description: This property defines whether or not the feature is enabled +hnt-sponsored-shortcuts-feature: + description: This feature manages the visibility of sponsored shortcuts on the homepage + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: Setting 'enabled' to false will hide sponsored shortcuts on the homepage and disable the respective toggle in the homepage settings +hnt-top-sites-visual-refresh-feature: + description: This feature manages the top sites visual refresh. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: Determines whether the top sites visual refresh is shown. +homepage-rebuild-feature: + description: | + This feature is for managing the roll out of the Homepage rebuild feature + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, enables the feature +homepage-redesign-feature: + description: | + This feature is for managing the roll out of the Homepage New Tab Redesign feature. + hasExposure: true + exposureDescription: '' + variables: + discover-more-feature-configuration: + type: json + description: | + A configuration for the Discover More feature + enabled: + type: boolean + description: | + Enables the feature. + search-bar: + type: boolean + description: | + If true, enables the search bar feature on homepage for users. + shortcuts-library: + type: boolean + description: | + If true, enables the shortcuts library feature, accessible from the homepage + stories-redesign: + type: boolean + description: | + If true, enables the stories section redesign on homepage, which also includes the removal of other sections (i.e. jump back in, bookmarks) +hosted-summarizer-feature: + description: | + This feature enables the hosted summarizer feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the hosted summarizer feature. + shakeGesture: + type: boolean + description: | + Enables the shake gesture for the summarizer feature. + toolbarEntrypoint: + type: boolean + description: | + Enables the toolbar entrypoint for the summarizer feature. +logins-verification: + description: | + Feature that enables the logins verification logic. + hasExposure: true + exposureDescription: '' + variables: + logins-verification-enabled: + type: boolean + description: | + Whether the logins verification logic is enabled. When enabled, an attempt will be made to decrypt all stored logins when sync is enabled. If a login cannot be decrypted, it will be locally deleted to unblock syncing. +menu-refactor-feature: + description: | + Controls the menu refactor feature + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Controls which menu users will see + menu-default-browser-banner: + type: boolean + description: | + If true, enables the menu Make Firefox your default banner, on top of the menu. + menu-redesign-hint: + type: boolean + description: | + If true, enables the menu contextual hint for menu redesign. +messaging: + description: | + The in-app messaging system + hasExposure: true + exposureDescription: '' + variables: + actions: + type: json + description: A growable map of action URLs. + message-under-experiment: + type: string + description: 'Deprecated. Please use "experiment": "{experiment}" instead.' + messages: + type: json + description: | + A growable collection of messages, where the Key is the message identifier and the value is its associated MessageData. + on-control: + type: string + description: What should be displayed when a control message is selected. + enum: + - show-next-message + - show-none + styles: + type: json + description: | + A map of styles to configure message appearance. + triggers: + type: json + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + ~~experiment: + type: string + description: Not to be set by experiment. +microsurvey-feature: + description: | + A feature that shows the microsurvey for users to interact with and submit responses. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, the feature is active. +native-error-page-feature: + description: | + This feature is for managing the roll out of the native error page feature + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, the feature is active. + no_internet_connection_error: + type: boolean + description: | + This feature is for managing the roll out of the no interet connection native error page feature +onboarding-framework-feature: + description: | + The new onboarding framework feature that will allow onboarding to be experimentable through initial experiments. + hasExposure: true + exposureDescription: '' + variables: + cards: + type: json + description: | + The list of available cards for onboarding. + conditions: + type: json + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + dismissable: + type: boolean + description: | + Whether or not the entire onboarding is dismissable by pressing an X at the top right corner of the screen. + enableModernUi: + type: boolean + description: | + Toggle between legacy (false) and modern (true) UI variants. +pdf-refactor-feature: + description: | + The feature flag to manage the roll out of the pdf refactor feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the feature. +revert-unsafe-continuations-refactor: + description: | + A feature flag to wrap reverting the unsafe continuations usage in the app. Unsafe continuations were used in response to an early 2025 incident when iOS 18.0 (possibly beta only) crashed on checked continuations (both regular and throwing). + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, revert unsafe continuations usage back to normal checked continuations usage. +search: + description: | + Configuring the functionality to do with search. This will be separated into smaller sub-features in later releases. + hasExposure: true + exposureDescription: '' + variables: + awesome-bar: + type: json + description: Configuring the awesome bar. +search-engine-consolidation-feature: + description: | + This feature is for managing the roll out of Search Engine Consolidation support in iOS + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the feature +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. +spotlight-search: + description: Add pages as items findable with Spotlight. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If this is true, then on each page load adds a new item to Spotlight. + icon-type: + type: string + description: | + The icon that is displayed next to the item in the search results. If this is `null`, then no icon is displayed. + keep-for-days: + type: int + description: | + Number of days to keep the item before automatic deletion. If this is left `null`, then it is left to iOS's default. + searchable-content: + type: string + description: | + The text content that is made searchable. If this is `null` then no additional content is used, and only the title and URL will be used. +start-at-home-feature: + description: This feature is for experimenting with opening screen + hasExposure: true + exposureDescription: '' + variables: + setting: + type: string + description: This property provides a default setting for the start at home feature + enum: + - afterFourHours + - always + - disabled +tab-scroll-refactor-feature: + description: | + The feature flag to manage the rollout of tab scroll refactor feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, tab scroll new implementation is used to show and hide toolbar views reacting to user scroll +tab-tray-ui-experiments: + description: | + The tab tray will undergo some UI experimentation to test potential improvements. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, enables the tab tray UI experiments. +tabTrayFeature: + description: The tab tray screen that the user goes to when they open the tab tray. + 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. +toolbar-refactor-feature: + description: | + This feature is for managing the roll out of the Toolbar refactor feature + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the feature + layout: + type: string + description: | + The type of layout of the toolbars. + minimal_address_bar: + type: boolean + description: | + Enables minimal address bar mode on scroll to ensure the url is always visible. + navigation_hint: + type: boolean + description: | + If true, enables the navigation contextual hint. + one_tap_new_tab: + type: boolean + description: | + If true, enables the one tap new tab feature for users. + swiping_tabs: + type: boolean + description: | + Enables swipe gestures to switch between browser tabs. + toolbar_update_hint: + type: boolean + description: | + If true, enables the toolbar update contextual hint. + translucency: + type: boolean + description: | + Enables translucency for toolbars. + unified_search: + type: boolean + description: | + Enables the unified search feature. +tos-feature: + description: | + This feature is for managing the roll out of the ToS (Term of Service) implementation + hasExposure: true + exposureDescription: '' + variables: + status: + type: boolean + description: | + Enables the feature +tou-feature: + description: | + This feature is for managing the rollout of the Terms of Use (ToU) implementation. + hasExposure: true + exposureDescription: '' + variables: + status: + type: boolean + description: | + Enables the feature +tracking-protection-refactor: + description: | + The Enhanced Tracking Protection refactor + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether the Enhanced Tracking Protection refactor is enabled or not +unified-ads: + description: | + This property is for managing the roll out of the unified ads API + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, we will enable user to use the unified ads API +updated-password-manager-feature: + description: | + This property determines if we use the updated password manager or the legacy one. + hasExposure: true + exposureDescription: '' + variables: + status: + type: boolean + description: If true, firefox will use the the updated password manager. +web-engine-integration-refactor: + description: | + The feature flag to manage the roll out of the integration of WebEngine into Firefox. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the feature. diff --git a/experimenter/experimenter/features/manifests/ios/v143.0.1/release.fml.yaml b/experimenter/experimenter/features/manifests/ios/v143.0.1/release.fml.yaml new file mode 100644 index 0000000000..9235ce0479 --- /dev/null +++ b/experimenter/experimenter/features/manifests/ios/v143.0.1/release.fml.yaml @@ -0,0 +1,1348 @@ +version: 1.0.0 +about: + description: The root level Feature Manifest for Firefox for iOS +channels: +- release +features: + address-autofill-edit: + description: This property defines if the address editing is enabled in Settings + variables: + status: + description: If true, we will allow user to edit the address + type: Boolean + default: false + address-bar-menu-feature: + description: | + This property determines if we show the new address bar menu entry or the toolbar menu in settings + variables: + status: + description: If true, we will show the new address bar menu entry + type: Boolean + default: true + appearance-menu-feature: + description: | + This property determines if we show the new appearance menu entry or the old theme settings + variables: + status: + description: If true, we will show the new appearance menu entry + type: Boolean + default: true + apple-summarizer-feature: + description: | + This feature enables the apple summarizer feature. + variables: + enabled: + description: | + Enables the apple summarizer feature. + type: Boolean + default: false + shakeGesture: + description: | + Enables the shake gesture for the summarizer feature. + type: Boolean + default: false + toolbarEntrypoint: + description: | + Enables the toolbar entrypoint for the summarizer feature. + type: Boolean + default: false + deeplink-optimization-refactor-feature: + description: | + The feature flag to manage the rollout of deeplink optimization feature. + variables: + enabled: + description: | + Variable description + type: Boolean + default: false + default-zoom-feature: + description: | + The feature flag to manage the rollout of default zoom feature. + variables: + enabled: + description: | + If true, page zoom settings and default zoom feature are shown + type: Boolean + default: false + download-live-activities-feature: + description: | + Download Live Activities Feature + variables: + enabled: + description: | + If true, the download live activities feature is enabled + type: Boolean + default: false + felt-privacy-feature: + description: The feature that enhances private browsing mode + variables: + felt-deletion-enabled: + description: If true, enable Felt Deletion part of Felt Privacy + type: Boolean + default: false + simplified-ui-enabled: + description: If true, enable simplified UI part of Felt Privacy + type: Boolean + default: false + firefox-suggest-feature: + description: Configuration for the Firefox Suggest feature. + variables: + available-suggestions-types: + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + type: Map + default: + amp: true + ampMobile: false + wikipedia: true + status: + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. + type: Boolean + default: false + general-app-features: + description: The feature that contains feature flags for the entire application + variables: + report-site-issue: + description: This property defines whether or not the feature is enabled + type: GeneralFeature + default: + status: false + hnt-sponsored-shortcuts-feature: + description: This feature manages the visibility of sponsored shortcuts on the homepage + variables: + enabled: + description: Setting 'enabled' to false will hide sponsored shortcuts on the homepage and disable the respective toggle in the homepage settings + type: Boolean + default: true + hnt-top-sites-visual-refresh-feature: + description: This feature manages the top sites visual refresh. + variables: + enabled: + description: Determines whether the top sites visual refresh is shown. + type: Boolean + default: false + homepage-rebuild-feature: + description: | + This feature is for managing the roll out of the Homepage rebuild feature + variables: + enabled: + description: | + If true, enables the feature + type: Boolean + default: false + homepage-redesign-feature: + description: | + This feature is for managing the roll out of the Homepage New Tab Redesign feature. + variables: + discover-more-feature-configuration: + description: | + A configuration for the Discover More feature + type: DiscoverMoreConfiguration + default: + discover-more-v1-experience: false + show-discover-more-button: false + enabled: + description: | + Enables the feature. + type: Boolean + default: false + search-bar: + description: | + If true, enables the search bar feature on homepage for users. + type: Boolean + default: false + shortcuts-library: + description: | + If true, enables the shortcuts library feature, accessible from the homepage + type: Boolean + default: false + stories-redesign: + description: | + If true, enables the stories section redesign on homepage, which also includes the removal of other sections (i.e. jump back in, bookmarks) + type: Boolean + default: false + hosted-summarizer-feature: + description: | + This feature enables the hosted summarizer feature. + variables: + enabled: + description: | + Enables the hosted summarizer feature. + type: Boolean + default: false + shakeGesture: + description: | + Enables the shake gesture for the summarizer feature. + type: Boolean + default: false + toolbarEntrypoint: + description: | + Enables the toolbar entrypoint for the summarizer feature. + type: Boolean + default: false + logins-verification: + description: | + Feature that enables the logins verification logic. + variables: + logins-verification-enabled: + description: | + Whether the logins verification logic is enabled. When enabled, an attempt will be made to decrypt all stored logins when sync is enabled. If a login cannot be decrypted, it will be locally deleted to unblock syncing. + type: Boolean + default: false + menu-refactor-feature: + description: | + Controls the menu refactor feature + variables: + enabled: + description: | + Controls which menu users will see + type: Boolean + default: true + menu-default-browser-banner: + description: | + If true, enables the menu Make Firefox your default banner, on top of the menu. + type: Boolean + default: true + menu-redesign-hint: + description: | + If true, enables the menu contextual hint for menu redesign. + type: Boolean + default: true + messaging: + description: | + The in-app messaging system + documentation: + - name: User documentation + url: https://experimenter.info/messaging/mobile-messaging + contacts: + - jhugman@mozilla.com + - brennie@mozilla.com + - gbuciu@mozilla.com + - wteichmann@mozilla.com + events: + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_shown + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_clicked + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_expired + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_dismissed + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_malformed + variables: + actions: + description: A growable map of action URLs. + type: Map + default: + OPEN_SETTINGS: ://deep-link?url=settings/general + OPEN_SETTINGS_NEW_TAB: ://deep-link?url=settings/newtab + OPEN_SETTINGS_HOMESCREEN: ://deep-link?url=settings/homepage + OPEN_SETTINGS_WALLPAPERS: ://deep-link?url=settings/wallpaper + OPEN_SETTINGS_EMAIL: ://deep-link?url=settings/mailto + OPEN_SETTINGS_SEARCH_ENGINE: ://deep-link?url=settings/search + OPEN_SETTINGS_PRIVACY: ://deep-link?url=settings/clear-private-data + OPEN_SETTINGS_FXA: ://deep-link?url=settings/fxa + OPEN_SETTINGS_THEME: ://deep-link?url=settings/theme + OPEN_SETTINGS_APP_ICON: ://deep-link?url=settings/app-icon + OPEN_URL: ://open-url + VIEW_BOOKMARKS: ://deep-link?url=homepanel/bookmarks + VIEW_TOP_SITES: ://deep-link?url=homepanel/top-sites + VIEW_READING_LIST: ://deep-link?url=homepanel/reading-list + VIEW_HISTORY: ://deep-link?url=homepanel/history + VIEW_DOWNLOADS: ://deep-link?url=homepanel/downloads + ENABLE_PRIVATE_BROWSING: ://deep-link?url=homepanel/new-private-tab + OPEN_NEW_TAB: ://deep-link?url=homepanel/new-tab + MAKE_DEFAULT_BROWSER: ://deep-link?url=default-browser/system-settings + MAKE_DEFAULT_BROWSER_WITH_TUTORIAL: ://deep-link?url=default-browser/tutorial + OPEN_SHARE_SHEET: ://share-sheet + string-alias: ActionName + message-under-experiment: + description: 'Deprecated. Please use "experiment": "{experiment}" instead.' + type: Option + default: null + messages: + description: | + A growable collection of messages, where the Key is the message identifier and the value is its associated MessageData. + type: Map + default: {} + string-alias: MessageKey + on-control: + description: What should be displayed when a control message is selected. + type: ControlMessageBehavior + default: show-next-message + styles: + description: | + A map of styles to configure message appearance. + type: Map + default: + FALLBACK: + priority: 40 + max-display-count: 20 + DEFAULT: + priority: 50 + max-display-count: 5 + MICROSURVEY: + priority: 50 + max-display-count: 1 + NOTIFICATION: + priority: 50 + max-display-count: 1 + PERSISTENT: + priority: 50 + max-display-count: 20 + SURVEY: + priority: 55 + max-display-count: 10 + WARNING: + priority: 60 + max-display-count: 10 + URGENT: + priority: 100 + max-display-count: 10 + string-alias: StyleName + triggers: + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + USER_RECENTLY_INSTALLED: days_since_install < 7 + USER_RECENTLY_UPDATED: days_since_update < 7 && days_since_install != days_since_update + USER_TIER_ONE_COUNTRY: ('US' in locale || 'GB' in locale || 'CA' in locale || 'DE' in locale || 'FR' in locale) + USER_EN_SPEAKER: '''en'' in locale' + USER_ES_SPEAKER: '''es'' in locale' + USER_DE_SPEAKER: '''de'' in locale' + USER_FR_SPEAKER: '''fr'' in locale' + DEVICE_ANDROID: os == 'Android' + DEVICE_IOS: os == 'iOS' + DAY_1_AFTER_INSTALL: days_since_install == 1 + DAY_2_AFTER_INSTALL: days_since_install == 2 + DAY_3_AFTER_INSTALL: days_since_install == 3 + DAY_4_AFTER_INSTALL: days_since_install == 4 + DAY_5_AFTER_INSTALL: days_since_install == 5 + MORE_THAN_24H_SINCE_INSTALLED_OR_UPDATED: days_since_update >= 1 + NOT_LAUNCHED_YESTERDAY: '''app_cycle.foreground''|eventLastSeen(''Days'', 1) > 1' + AFTER_THREE_LAUNCHES_THIS_WEEK: '''app_cycle.foreground''|eventSum(''Weeks'', 1, 0) >= 3' + I_AM_DEFAULT_BROWSER: is_default_browser + I_AM_NOT_DEFAULT_BROWSER: is_default_browser == false + SUPPORTS_DEFAULT_BROWSER: os_version|versionCompare('14.!') >= 0 + INACTIVE_NEW_USER: is_inactive_new_user + ALLOWED_TIPS_NOTIFICATIONS: allowed_tips_notifications + FXA_CURRENTLY_SIGNED_IN: is_fxa_signed_in == true + SECOND_HOMEPAGE_VIEW: '''homepage_viewed''|eventSum(''Years'', 4, 0) >= 2' + ON_FOURTH_LAUNCH_THIS_YEAR: '''app_cycle.foreground''|eventSum(''Years'', 1, 0) > 3' + string-alias: TriggerName + ~~experiment: + description: Not to be set by experiment. + type: ExperimentSlug + default: '{experiment}' + string-alias: ExperimentSlug + allow-coenrollment: true + microsurvey-feature: + description: | + A feature that shows the microsurvey for users to interact with and submit responses. + variables: + enabled: + description: | + If true, the feature is active. + type: Boolean + default: false + native-error-page-feature: + description: | + This feature is for managing the roll out of the native error page feature + variables: + enabled: + description: | + If true, the feature is active. + type: Boolean + default: false + no_internet_connection_error: + description: | + This feature is for managing the roll out of the no interet connection native error page feature + type: Boolean + default: false + onboarding-framework-feature: + description: | + The new onboarding framework feature that will allow onboarding to be experimentable through initial experiments. + variables: + cards: + description: | + The list of available cards for onboarding. + type: Map + default: + welcome: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Welcome.Title.TreatementA.v120 + body: Onboarding/Onboarding.Welcome.Description.TreatementA.v120 + image: welcome-globe + buttons: + primary: + title: Onboarding/Onboarding.Welcome.ActionTreatementA.v114 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Welcome.Skip.v114 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + notification-permissions: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Notification.Title.v120 + body: Onboarding/Onboarding.Notification.Description.v120 + image: notifications + buttons: + primary: + title: Onboarding/Onboarding.Notification.TurnOnNotifications.Action.v114 + action: request-notifications + secondary: + title: Onboarding/Onboarding.Notification.Skip.Action.v115 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + sign-to-sync: + card-type: basic + order: 20 + title: Onboarding/Onboarding.Sync.Title.v120 + body: Onboarding/Onboarding.Sync.Description.v123 + image: sync-devices + buttons: + primary: + title: Onboarding/Onboarding.Sync.SignIn.Action.v114 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Sync.Skip.Action.v114 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + customization-theme: + card-type: multiple-choice + order: 40 + title: Onboarding/Onboarding.Customization.Theme.Title.v123 + body: Onboarding/Onboarding.Customization.Theme.Description.v123 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Customization.Theme.Continue.Action.v123 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Theme.System.Action.v123 + image: theme-system + action: theme-system-default + - title: Onboarding/Onboarding.Customization.Theme.Light.Action.v123 + image: theme-light + action: theme-light + - title: Onboarding/Onboarding.Customization.Theme.Dark.Action.v123 + image: theme-dark + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + customization-toolbar: + card-type: multiple-choice + order: 41 + title: Onboarding/Onboarding.Customization.Toolbar.Title.v123 + body: Onboarding/Onboarding.Customization.Toolbar.Description.v123 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Customization.Toolbar.Continue.Action.v123 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Toolbar.Top.Action.v123 + image: toolbar-top + action: toolbar-top + - title: Onboarding/Onboarding.Customization.Toolbar.Bottom.Action.v123 + image: toolbar-bottom + action: toolbar-bottom + onboarding-type: fresh-install + prerequisites: + - ALWAYS + update-welcome: + card-type: basic + order: 10 + title: Upgrade/Upgrade.Welcome.Title.v114 + body: Upgrade/Upgrade.Welcome.Description.v114 + image: welcome-globe + buttons: + primary: + title: Upgrade/Upgrade.Welcome.Action.v114 + action: forward-one-card + onboarding-type: upgrade + prerequisites: + - NEVER + update-sign-to-sync: + card-type: basic + order: 20 + title: Upgrade/Upgrade.SyncSign.Title.v114 + body: Upgrade/Upgrade.SyncSign.Description.v114 + image: sync-devices + buttons: + primary: + title: Upgrade/Upgrade.SyncSign.Action.v114 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.LaterAction.v114 + action: forward-one-card + onboarding-type: upgrade + prerequisites: + - NEVER + welcome-modern: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.Welcome.Title.v140 + body: Onboarding/Onboarding.Modern.Welcome.Description.v140 + image: trackers + buttons: + primary: + title: Onboarding/Onboarding.Modern.Welcome.ActionTreatementA.v140 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.Welcome.Skip.v140 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + sign-to-sync-modern: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.Sync.Title.v140 + body: Onboarding/Onboarding.Modern.Sync.Description.v140 + image: sync-with-icons + buttons: + primary: + title: Onboarding/Onboarding.Modern.Sync.SignIn.Action.v140 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.Sync.Skip.Action.v140 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-toolbar-modern: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Title.v140 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v140 + image: toolbar-bottom + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v140 + image: toolbar-top + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-theme-modern: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Customization.Theme.Title.v143 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Theme.System.Action.v123 + image: theme-system + action: theme-system-default + - title: Onboarding/Onboarding.Customization.Theme.Light.Action.v123 + image: theme-light + action: theme-light + - title: Onboarding/Onboarding.Customization.Theme.Dark.Action.v123 + image: theme-dark + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + string-alias: NimbusOnboardingCardKey + conditions: + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + string-alias: ConditionName + dismissable: + description: | + Whether or not the entire onboarding is dismissable by pressing an X at the top right corner of the screen. + type: Boolean + default: true + enableModernUi: + description: | + Toggle between legacy (false) and modern (true) UI variants. + type: Boolean + default: false + pdf-refactor-feature: + description: | + The feature flag to manage the roll out of the pdf refactor feature. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + revert-unsafe-continuations-refactor: + description: | + A feature flag to wrap reverting the unsafe continuations usage in the app. Unsafe continuations were used in response to an early 2025 incident when iOS 18.0 (possibly beta only) crashed on checked continuations (both regular and throwing). + variables: + enabled: + description: | + If true, revert unsafe continuations usage back to normal checked continuations usage. + type: Boolean + default: false + search: + description: | + Configuring the functionality to do with search. This will be separated into smaller sub-features in later releases. + variables: + awesome-bar: + description: Configuring the awesome bar. + type: AwesomeBar + default: + min-search-term: 3 + position: + is-bottom: false + is-position-feature-enabled: true + search-highlights: false + use-page-content: false + search-engine-consolidation-feature: + description: | + This feature is for managing the roll out of Search Engine Consolidation support in iOS + variables: + enabled: + description: | + Enables the feature + 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 + spotlight-search: + description: Add pages as items findable with Spotlight. + variables: + enabled: + description: If this is true, then on each page load adds a new item to Spotlight. + type: Boolean + default: false + icon-type: + description: | + The icon that is displayed next to the item in the search results. If this is `null`, then no icon is displayed. + type: Option + default: letter + keep-for-days: + description: | + Number of days to keep the item before automatic deletion. If this is left `null`, then it is left to iOS's default. + type: Option + default: null + searchable-content: + description: | + The text content that is made searchable. If this is `null` then no additional content is used, and only the title and URL will be used. + type: Option + default: text-excerpt + start-at-home-feature: + description: This feature is for experimenting with opening screen + variables: + setting: + description: This property provides a default setting for the start at home feature + type: StartAtHome + default: afterFourHours + tab-scroll-refactor-feature: + description: | + The feature flag to manage the rollout of tab scroll refactor feature. + variables: + enabled: + description: | + If true, tab scroll new implementation is used to show and hide toolbar views reacting to user scroll + type: Boolean + default: false + tab-tray-ui-experiments: + description: | + The tab tray will undergo some UI experimentation to test potential improvements. + variables: + enabled: + description: | + If true, enables the tab tray UI experiments. + type: Boolean + default: false + tabTrayFeature: + description: The tab tray screen that the user goes to when they open the tab tray. + 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: + inactive-tabs: true + toolbar-refactor-feature: + description: | + This feature is for managing the roll out of the Toolbar refactor feature + variables: + enabled: + description: | + Enables the feature + type: Boolean + default: true + layout: + description: | + The type of layout of the toolbars. + type: Option + default: version1 + minimal_address_bar: + description: | + Enables minimal address bar mode on scroll to ensure the url is always visible. + type: Boolean + default: false + navigation_hint: + description: | + If true, enables the navigation contextual hint. + type: Boolean + default: true + one_tap_new_tab: + description: | + If true, enables the one tap new tab feature for users. + type: Boolean + default: true + swiping_tabs: + description: | + Enables swipe gestures to switch between browser tabs. + type: Boolean + default: false + toolbar_update_hint: + description: | + If true, enables the toolbar update contextual hint. + type: Boolean + default: false + translucency: + description: | + Enables translucency for toolbars. + type: Boolean + default: true + unified_search: + description: | + Enables the unified search feature. + type: Boolean + default: false + tos-feature: + description: | + This feature is for managing the roll out of the ToS (Term of Service) implementation + variables: + status: + description: | + Enables the feature + type: Boolean + default: true + tou-feature: + description: | + This feature is for managing the rollout of the Terms of Use (ToU) implementation. + variables: + status: + description: | + Enables the feature + type: Boolean + default: false + tracking-protection-refactor: + description: | + The Enhanced Tracking Protection refactor + variables: + enabled: + description: | + Whether the Enhanced Tracking Protection refactor is enabled or not + type: Boolean + default: true + unified-ads: + description: | + This property is for managing the roll out of the unified ads API + variables: + enabled: + description: | + If true, we will enable user to use the unified ads API + type: Boolean + default: true + updated-password-manager-feature: + description: | + This property determines if we use the updated password manager or the legacy one. + variables: + status: + description: If true, firefox will use the the updated password manager. + type: Boolean + default: false + web-engine-integration-refactor: + description: | + The feature flag to manage the roll out of the integration of WebEngine into Firefox. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false +enums: + ControlMessageBehavior: + description: An enum to influence what should be displayed when a control message is selected. + variants: + show-next-message: + description: The next eligible message should be shown. + show-none: + description: The surface should show no message. + IconType: + description: The icon that will be added to the item in the device's search engine. + variants: + favicon: + description: The favicon of the page + letter: + description: An icon generated from the first letter of the base domain. + screenshot: + description: A screenshot of the page at load time. + MessageSurfaceId: + description: | + For messaging, we would like to have a message tell us which surface its associated with. This is a label that matches across both Android and iOS. + variants: + Unknown: + description: A message has NOT declared its target surface. + microsurvey: + description: This is a microsurvey that appears on top of the bottom toolbar to the user. + new-tab-card: + description: This is the card that appears at the top on the Firefox Home Page. + notification: + description: This is a local notification send to the user periodically with tips and updates. + survey: + description: This is a full-page that appears providing a survey to the user. + NimbusOnboardingHeaderImage: + description: | + The identifiers for the different images available for cards in onboarding + variants: + customize-firefox: + description: | + Corresponding to the fox window image + notifications: + description: | + Corresponding to the notifications image + notifications-ctd: + description: | + Corresponding to the notifications image for CTD + search-widget: + description: | + Corresponding to the fox search widget image + set-default-steps: + description: | + Corresponding to the set to default steps image + set-to-dock: + description: | + Corresponding to the set to dock image + sync-devices: + description: | + Corresponding to the sync-devices image + sync-devices-ctd: + description: | + Corresponding to the sync image for CTD + sync-with-icons: + description: | + Corresponding to the sync-devices image + themeing: + description: | + Corresponding to the fox world image + toolbar: + description: | + Corresponding to the fox world image + trackers: + description: | + Corresponding to the trackers image + welcome-ctd: + description: | + Corresponding to the welcome image for CTD + welcome-globe: + description: | + Corresponding to the fox world image + NimbusOnboardingMultipleChoiceButtonImage: + description: | + The identifiers for the different images available for multiple choice buttons in onboarding + variants: + theme-dark: + description: | + Corresponding to the dark theme + theme-light: + description: | + Corresponding to the light theme + theme-system: + description: | + Corresponding to the system theme + toolbar-bottom: + description: | + Corresponding to the toolbar on the bottom + toolbar-top: + description: | + Corresponding to the toolbar on top + OnboardingActions: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + end-onboarding: + description: | + Will end the onboarding on a set card + forward-one-card: + description: | + Will take the user to the next card + forward-three-card: + description: | + Will take the user to the next card + forward-two-card: + description: | + Will take the user to the next card + open-instructions-popup: + description: | + Will open up a popup with instructions for something + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + read-privacy-policy: + description: | + Will open a webview where the user can read the privacy policy + request-notifications: + description: | + Will request to allow notifications from the user + set-default-browser: + description: | + Will send the user to settings to set Firefox as their default browser and advance to next card + sync-sign-in: + description: | + Will take the user to the sync sign in flow + OnboardingCardType: + description: | + The identifiers for the different types of onboarding cards. + variants: + basic: + description: | + Corresponding to basic info onboarding cards + multiple-choice: + description: | + Corresponding to onboarding cards with multiple choice buttons + OnboardingInstructionsPopupActions: + description: | + The identifiers for the different actions available for the insturction card in onboarding + variants: + dismiss: + description: | + Will dismiss the popup + dismiss-and-next-card: + description: | + Will dismiss the popup and move to the next card + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + OnboardingMultipleChoiceAction: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + theme-dark: + description: | + Will will set the theme to dark mode + theme-light: + description: | + Will set the theme to light mode + theme-system-default: + description: | + Will set the theme to use the system theme + toolbar-bottom: + description: | + Will set the toolbar on the bottom + toolbar-top: + description: | + Will set the toolbar on the top + OnboardingType: + description: | + The identifiers for the different types of onboarding cards. + variants: + fresh-install: + description: | + Corresponding to onboarding cards that are for new users + upgrade: + description: | + Corresponding to onboarding cards that are for users who have updated + OnboardingVariant: + description: | + Which UI style this onboarding card is designed for. + variants: + legacy: + description: Use the existing (legacy) onboarding UI. + modern: + description: Use the new (modern) onboarding UI. + PageContent: + description: The page content that will be added as an item in the device's search engine. + variants: + html-content: + description: Use all the page as HTML + text-content: + description: Use all the page as text + text-excerpt: + description: Only use the first paragraph + StartAtHome: + description: The option for what screen to open the app to + variants: + afterFourHours: + description: Starts the app at the homepage after four hours of inactivity, otherwise starts the app at the most recently viewed tab. + always: + description: Starts the app at the homepage. + disabled: + description: Starts the app at the most recently viewed tab. + SuggestionType: + description: The type of a Firefox Suggest search suggestion. + variants: + amp: + description: A Firefox Suggestion for desktop from adMarketplace. + ampMobile: + description: A Firefox Suggestion specifically for mobile from adMarketplace. + wikipedia: + description: A Firefox Suggestion for a Wikipedia page. + TabTraySection: + description: The identifiers for the sections of the tab tray. + variants: + inactive-tabs: + description: Tabs that have been automatically closed for the user. + ToolbarLayoutType: + description: The type of toolbar layout. + variants: + baseline: + description: The default layout of the toolbars. + version1: + description: Shows the add new tab, menu and tabs button in the navigation toolbar. The share button is displayed in the address toolbar. + version2: + description: Like version1 but the menu and tabs buttons are inverted. +objects: + AwesomeBar: + description: A configuration option for the awesome bar. Part of the `search` feature. + fields: + min-search-term: + description: The minimum number of characters that the user types before searching in the page. + type: Int + default: 3 + position: + description: | + This property defines whether or not the feature is enabled, and the position of the search bar + type: SearchBarPositionFeature + default: + is-position-feature-enabled: true + is-bottom: true + search-highlights: + description: Whether or not search highlights are enabled + type: Boolean + default: false + use-page-content: + description: Search in the open tab's text content when typing. + type: Boolean + default: false + DiscoverMoreConfiguration: + description: | + A configuration that dictates the behaviour/subfeatures of the Discover More feature + fields: + discover-more-v1-experience: + description: | + Whether to show the Discover More experience is enabled + type: Boolean + default: false + show-discover-more-button: + description: | + Whether to show the Discover More button on the homepage + type: Boolean + default: false + GeneralFeature: + description: The configuration for the a feature that can be enabled or disabled + fields: + status: + description: Whether or not the feature is enabled + type: Boolean + default: false + MessageData: + description: | + An object to describe a message. It uses human readable strings to describe the triggers, action and style of the message as well as the text of the message and call to action. + fields: + action: + description: | + The name of a deeplink URL to be opened if the button is clicked. + type: Option + default: null + action-params: + description: Query parameters appended to the deeplink action URL + type: Map + default: {} + button-label: + description: | + The text on the button. If no text is present, the whole message is clickable. + type: Option + default: null + except-if-any: + description: | + A list of strings corresponding to targeting expressions. If any of these expressions evaluate to `true`, the message will not be eligible. + type: List + default: [] + experiment: + description: The experiment slug that this message is involved in. + type: Option + default: null + is-control: + description: Indicates if this message is the control message, if true shouldn't be displayed + type: Boolean + default: false + microsurveyConfig: + description: Optional configuration data for a microsurvey. + type: Option + default: null + style: + description: | + The style as described in a `StyleData` from the styles table. + type: StyleName + default: DEFAULT + surface: + description: Each message will tell us the surface it is targeting with this. + type: MessageSurfaceId + default: Unknown + text: + description: The message text displayed to the user + type: Text + default: '' + title: + description: The title text displayed to the user + type: Option + default: null + trigger-if-all: + description: | + A list of strings corresponding to targeting expressions. All named expressions must evaluate to true if the message is to be eligible to be shown. + type: List + default: + - ALWAYS + MicrosurveyConfig: + description: | + Attributes relating to microsurvey messaging. + fields: + icon: + description: The asset name in our bundle used as the icon shown in the survey. + type: Image + default: lightbulbLarge + options: + description: The list of survey options to present to the user. + type: List + default: [] + utm-content: + description: The name used to provide as the utm_content parameter for the privacy notice. + type: Option + default: null + NimbusOnboardingButton: + description: | + A group of properties describing the attributes of a card. + fields: + action: + description: | + The action the button should take. The default for this will be "forward-one-card" + type: OnboardingActions + default: forward-one-card + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingButtons: + description: | + A set of buttons for the card. There can be up to two, but there must be at least one. + fields: + primary: + description: | + The primary button for the card. This must exist. + type: NimbusOnboardingButton + default: + title: Primary Button + action: forward-one-card + secondary: + description: | + A secondary, optional, button for the card. + type: Option + default: null + NimbusOnboardingCardData: + description: | + A group of properties describing the attributes of a card. + fields: + body: + description: | + The body text dispalyed on the card, in less prominent text. This should never be defaulted. + type: Text + default: '' + buttons: + description: | + The set of buttons associated with the card. + type: NimbusOnboardingButtons + default: + primary: + title: Onboarding/Onboarding.Sync.Skip.Action.v114 + action: forward-one-card + secondary: null + card-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingCardType + default: basic + disqualifiers: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will not be shown if any expression is `true`. + type: List + default: [] + image: + description: | + The image that should be dispalyed on the card. + type: NimbusOnboardingHeaderImage + default: welcome-globe + instructions-popup: + description: | + The object describing the specific instruction popup button for a card. If left empty, the card will have no instruction popup information + type: Option + default: null + link: + description: | + The object describing the link button for a card. If left empty, the card will have no link. + type: Option + default: null + multiple-choice-buttons: + description: | + A list of multiple choice buttons that the card will display + type: List + default: [] + onboarding-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingType + default: fresh-install + order: + description: | + The place in the order where the card will be found. The feature layer will then sort the cards based on this field. + type: Int + default: 10 + prerequisites: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will be shown if all expressions `true` and if no expressions in the `disqualifiers` table are true, or if the `disqualifiers` table is empty. + type: List + default: [] + title: + description: | + The title displayed on the card, in prominent, bolded text. This should never be defaulted. + type: Text + default: '' + uiVariant: + description: | + If set, this card will only be shown in the specified UI variant. If null, it will appear in both legacy and modern UIs. + type: Option + default: null + NimbusOnboardingInstructionPopup: + description: | + The object outlining the content of the instruction card. + fields: + button-action: + description: | + The action the button should have. Default is `dismiss-and-next-card` + type: OnboardingInstructionsPopupActions + default: dismiss-and-next-card + button-title: + description: | + The title the button should have. This should never be defaulted. + type: Text + default: '' + instructions: + description: | + A list of instructions, either as free text, or as Text identifiers. + type: List + default: [] + title: + description: | + The text of the popup. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingLink: + description: | + A group of properties describing the attributes for the active link on a card + fields: + title: + description: | + The text of the link title. + type: Text + default: Onboarding/Onboarding.Welcome.Link.Action.v114 + url: + description: | + The url that the link will lead to. + type: String + default: https://www.mozilla.org/privacy/firefox/ + NimbusOnboardingMultipleChoiceButton: + description: | + A group of properties describing the attributes of a multiple choice button on a card + fields: + action: + description: | + The action the button should take. The default for this will be "theme-system-default" + type: OnboardingMultipleChoiceAction + default: theme-system-default + image: + description: | + The text of the button title. This should never be defaulted. + type: NimbusOnboardingMultipleChoiceButtonImage + default: theme-system + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + SearchBarPositionFeature: + description: The configuration for the bottom search bar on the homescreen + fields: + is-bottom: + description: Whether or not the default position is at the bottom + type: Boolean + default: true + is-position-feature-enabled: + description: Whether or not the feature is enabled + type: Boolean + default: true + StyleData: + description: | + A group of properities (predominantly visual) to the describe style of the message. + fields: + max-display-count: + description: | + How many sessions will this message be shown to the user before it is expired. + type: Int + default: 5 + priority: + description: | + The importance of this message. 0 is not very important, 100 is very important. + type: Int + default: 50 diff --git a/experimenter/experimenter/features/manifests/ios/v143.2.0/beta.fml.yaml b/experimenter/experimenter/features/manifests/ios/v143.2.0/beta.fml.yaml new file mode 100644 index 0000000000..39092c59eb --- /dev/null +++ b/experimenter/experimenter/features/manifests/ios/v143.2.0/beta.fml.yaml @@ -0,0 +1,1371 @@ +version: 1.0.0 +about: + description: The root level Feature Manifest for Firefox for iOS +channels: +- beta +features: + address-autofill-edit: + description: This property defines if the address editing is enabled in Settings + variables: + status: + description: If true, we will allow user to edit the address + type: Boolean + default: false + address-bar-menu-feature: + description: | + This property determines if we show the new address bar menu entry or the toolbar menu in settings + variables: + status: + description: If true, we will show the new address bar menu entry + type: Boolean + default: true + appearance-menu-feature: + description: | + This property determines if we show the new appearance menu entry or the old theme settings + variables: + status: + description: If true, we will show the new appearance menu entry + type: Boolean + default: true + apple-summarizer-feature: + description: | + This feature enables the apple summarizer feature. + variables: + enabled: + description: | + Enables the apple summarizer feature. + type: Boolean + default: true + shakeGesture: + description: | + Enables the shake gesture for the summarizer feature. + type: Boolean + default: true + toolbarEntrypoint: + description: | + Enables the toolbar entrypoint for the summarizer feature. + type: Boolean + default: true + deeplink-optimization-refactor-feature: + description: | + The feature flag to manage the rollout of deeplink optimization feature. + variables: + enabled: + description: | + Variable description + type: Boolean + default: true + default-zoom-feature: + description: | + The feature flag to manage the rollout of default zoom feature. + variables: + enabled: + description: | + If true, page zoom settings and default zoom feature are shown + type: Boolean + default: false + download-live-activities-feature: + description: | + Download Live Activities Feature + variables: + enabled: + description: | + If true, the download live activities feature is enabled + type: Boolean + default: false + felt-privacy-feature: + description: The feature that enhances private browsing mode + variables: + felt-deletion-enabled: + description: If true, enable Felt Deletion part of Felt Privacy + type: Boolean + default: false + simplified-ui-enabled: + description: If true, enable simplified UI part of Felt Privacy + type: Boolean + default: true + firefox-suggest-feature: + description: Configuration for the Firefox Suggest feature. + variables: + available-suggestions-types: + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + type: Map + default: + amp: true + ampMobile: false + wikipedia: true + status: + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. + type: Boolean + default: false + general-app-features: + description: The feature that contains feature flags for the entire application + variables: + report-site-issue: + description: This property defines whether or not the feature is enabled + type: GeneralFeature + default: + status: true + hnt-sponsored-shortcuts-feature: + description: This feature manages the visibility of sponsored shortcuts on the homepage + variables: + enabled: + description: Setting 'enabled' to false will hide sponsored shortcuts on the homepage and disable the respective toggle in the homepage settings + type: Boolean + default: true + hnt-top-sites-visual-refresh-feature: + description: This feature manages the top sites visual refresh. + variables: + enabled: + description: Determines whether the top sites visual refresh is shown. + type: Boolean + default: false + homepage-rebuild-feature: + description: | + This feature is for managing the roll out of the Homepage rebuild feature + variables: + enabled: + description: | + If true, enables the feature + type: Boolean + default: true + homepage-redesign-feature: + description: | + This feature is for managing the roll out of the Homepage New Tab Redesign feature. + variables: + discover-more-feature-configuration: + description: | + A configuration for the Discover More feature + type: DiscoverMoreConfiguration + default: + discover-more-v1-experience: false + show-discover-more-button: false + enabled: + description: | + Enables the feature. + type: Boolean + default: false + search-bar: + description: | + If true, enables the search bar feature on homepage for users. + type: Boolean + default: true + shortcuts-library: + description: | + If true, enables the shortcuts library feature, accessible from the homepage + type: Boolean + default: false + stories-redesign: + description: | + If true, enables the stories section redesign on homepage, which also includes the removal of other sections (i.e. jump back in, bookmarks) + type: Boolean + default: true + hosted-summarizer-feature: + description: | + This feature enables the hosted summarizer feature. + variables: + enabled: + description: | + Enables the hosted summarizer feature. + type: Boolean + default: true + shakeGesture: + description: | + Enables the shake gesture for the summarizer feature. + type: Boolean + default: true + toolbarEntrypoint: + description: | + Enables the toolbar entrypoint for the summarizer feature. + type: Boolean + default: true + menu-refactor-feature: + description: | + Controls the menu refactor feature + variables: + enabled: + description: | + Controls which menu users will see + type: Boolean + default: true + menu-default-browser-banner: + description: | + If true, enables the menu Make Firefox your default banner, on top of the menu. + type: Boolean + default: true + menu-redesign-hint: + description: | + If true, enables the menu contextual hint for menu redesign. + type: Boolean + default: true + messaging: + description: | + The in-app messaging system + documentation: + - name: User documentation + url: https://experimenter.info/messaging/mobile-messaging + contacts: + - jhugman@mozilla.com + - brennie@mozilla.com + - gbuciu@mozilla.com + - wteichmann@mozilla.com + events: + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_shown + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_clicked + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_expired + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_dismissed + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_malformed + variables: + actions: + description: A growable map of action URLs. + type: Map + default: + OPEN_SETTINGS: ://deep-link?url=settings/general + OPEN_SETTINGS_NEW_TAB: ://deep-link?url=settings/newtab + OPEN_SETTINGS_HOMESCREEN: ://deep-link?url=settings/homepage + OPEN_SETTINGS_WALLPAPERS: ://deep-link?url=settings/wallpaper + OPEN_SETTINGS_EMAIL: ://deep-link?url=settings/mailto + OPEN_SETTINGS_SEARCH_ENGINE: ://deep-link?url=settings/search + OPEN_SETTINGS_PRIVACY: ://deep-link?url=settings/clear-private-data + OPEN_SETTINGS_FXA: ://deep-link?url=settings/fxa + OPEN_SETTINGS_THEME: ://deep-link?url=settings/theme + OPEN_SETTINGS_APP_ICON: ://deep-link?url=settings/app-icon + OPEN_URL: ://open-url + VIEW_BOOKMARKS: ://deep-link?url=homepanel/bookmarks + VIEW_TOP_SITES: ://deep-link?url=homepanel/top-sites + VIEW_READING_LIST: ://deep-link?url=homepanel/reading-list + VIEW_HISTORY: ://deep-link?url=homepanel/history + VIEW_DOWNLOADS: ://deep-link?url=homepanel/downloads + ENABLE_PRIVATE_BROWSING: ://deep-link?url=homepanel/new-private-tab + OPEN_NEW_TAB: ://deep-link?url=homepanel/new-tab + MAKE_DEFAULT_BROWSER: ://deep-link?url=default-browser/system-settings + MAKE_DEFAULT_BROWSER_WITH_TUTORIAL: ://deep-link?url=default-browser/tutorial + OPEN_SHARE_SHEET: ://share-sheet + string-alias: ActionName + message-under-experiment: + description: 'Deprecated. Please use "experiment": "{experiment}" instead.' + type: Option + default: null + messages: + description: | + A growable collection of messages, where the Key is the message identifier and the value is its associated MessageData. + type: Map + default: + homepage-microsurvey-message: + surface: microsurvey + style: MICROSURVEY + trigger-if-all: + - SECOND_HOMEPAGE_VIEW + title: Microsurvey/Microsurvey.Prompt.TitleLabel.v127 + text: How satisfied are you with your Firefox homepage? + button-label: Microsurvey/Microsurvey.Prompt.Button.v127 + microsurveyConfig: + utm-content: homepage + icon: homeLarge + options: + - Microsurvey/Microsurvey.Survey.Options.VerySatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.Satisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.Neutral.v132 + - Microsurvey/Microsurvey.Survey.Options.Dissatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.VeryDissatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.NotApplicable.v132 + string-alias: MessageKey + on-control: + description: What should be displayed when a control message is selected. + type: ControlMessageBehavior + default: show-next-message + styles: + description: | + A map of styles to configure message appearance. + type: Map + default: + FALLBACK: + priority: 40 + max-display-count: 20 + DEFAULT: + priority: 50 + max-display-count: 5 + MICROSURVEY: + priority: 50 + max-display-count: 1 + NOTIFICATION: + priority: 50 + max-display-count: 1 + PERSISTENT: + priority: 50 + max-display-count: 20 + SURVEY: + priority: 55 + max-display-count: 10 + WARNING: + priority: 60 + max-display-count: 10 + URGENT: + priority: 100 + max-display-count: 10 + string-alias: StyleName + triggers: + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + USER_RECENTLY_INSTALLED: days_since_install < 7 + USER_RECENTLY_UPDATED: days_since_update < 7 && days_since_install != days_since_update + USER_TIER_ONE_COUNTRY: ('US' in locale || 'GB' in locale || 'CA' in locale || 'DE' in locale || 'FR' in locale) + USER_EN_SPEAKER: '''en'' in locale' + USER_ES_SPEAKER: '''es'' in locale' + USER_DE_SPEAKER: '''de'' in locale' + USER_FR_SPEAKER: '''fr'' in locale' + DEVICE_ANDROID: os == 'Android' + DEVICE_IOS: os == 'iOS' + DAY_1_AFTER_INSTALL: days_since_install == 1 + DAY_2_AFTER_INSTALL: days_since_install == 2 + DAY_3_AFTER_INSTALL: days_since_install == 3 + DAY_4_AFTER_INSTALL: days_since_install == 4 + DAY_5_AFTER_INSTALL: days_since_install == 5 + MORE_THAN_24H_SINCE_INSTALLED_OR_UPDATED: days_since_update >= 1 + NOT_LAUNCHED_YESTERDAY: '''app_cycle.foreground''|eventLastSeen(''Days'', 1) > 1' + AFTER_THREE_LAUNCHES_THIS_WEEK: '''app_cycle.foreground''|eventSum(''Weeks'', 1, 0) >= 3' + I_AM_DEFAULT_BROWSER: is_default_browser + I_AM_NOT_DEFAULT_BROWSER: is_default_browser == false + SUPPORTS_DEFAULT_BROWSER: os_version|versionCompare('14.!') >= 0 + INACTIVE_NEW_USER: is_inactive_new_user + ALLOWED_TIPS_NOTIFICATIONS: allowed_tips_notifications + FXA_CURRENTLY_SIGNED_IN: is_fxa_signed_in == true + SECOND_HOMEPAGE_VIEW: '''homepage_viewed''|eventSum(''Years'', 4, 0) >= 2' + ON_FOURTH_LAUNCH_THIS_YEAR: '''app_cycle.foreground''|eventSum(''Years'', 1, 0) > 3' + string-alias: TriggerName + ~~experiment: + description: Not to be set by experiment. + type: ExperimentSlug + default: '{experiment}' + string-alias: ExperimentSlug + allow-coenrollment: true + microsurvey-feature: + description: | + A feature that shows the microsurvey for users to interact with and submit responses. + variables: + enabled: + description: | + If true, the feature is active. + type: Boolean + default: false + native-error-page-feature: + description: | + This feature is for managing the roll out of the native error page feature + variables: + enabled: + description: | + If true, the feature is active. + type: Boolean + default: false + no_internet_connection_error: + description: | + This feature is for managing the roll out of the no interet connection native error page feature + type: Boolean + default: false + onboarding-framework-feature: + description: | + The new onboarding framework feature that will allow onboarding to be experimentable through initial experiments. + variables: + cards: + description: | + The list of available cards for onboarding. + type: Map + default: + welcome: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Welcome.Title.TreatementA.v120 + body: Onboarding/Onboarding.Welcome.Description.TreatementA.v120 + image: welcome-globe + buttons: + primary: + title: Onboarding/Onboarding.Welcome.ActionTreatementA.v114 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Welcome.Skip.v114 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + notification-permissions: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Notification.Title.v120 + body: Onboarding/Onboarding.Notification.Description.v120 + image: notifications + buttons: + primary: + title: Onboarding/Onboarding.Notification.TurnOnNotifications.Action.v114 + action: request-notifications + secondary: + title: Onboarding/Onboarding.Notification.Skip.Action.v115 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + sign-to-sync: + card-type: basic + order: 20 + title: Onboarding/Onboarding.Sync.Title.v120 + body: Onboarding/Onboarding.Sync.Description.v123 + image: sync-devices + buttons: + primary: + title: Onboarding/Onboarding.Sync.SignIn.Action.v114 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Sync.Skip.Action.v114 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + customization-theme: + card-type: multiple-choice + order: 40 + title: Onboarding/Onboarding.Customization.Theme.Title.v123 + body: Onboarding/Onboarding.Customization.Theme.Description.v123 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Customization.Theme.Continue.Action.v123 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Theme.System.Action.v123 + image: theme-system + action: theme-system-default + - title: Onboarding/Onboarding.Customization.Theme.Light.Action.v123 + image: theme-light + action: theme-light + - title: Onboarding/Onboarding.Customization.Theme.Dark.Action.v123 + image: theme-dark + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + customization-toolbar: + card-type: multiple-choice + order: 41 + title: Onboarding/Onboarding.Customization.Toolbar.Title.v123 + body: Onboarding/Onboarding.Customization.Toolbar.Description.v123 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Customization.Toolbar.Continue.Action.v123 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Toolbar.Top.Action.v123 + image: toolbar-top + action: toolbar-top + - title: Onboarding/Onboarding.Customization.Toolbar.Bottom.Action.v123 + image: toolbar-bottom + action: toolbar-bottom + onboarding-type: fresh-install + prerequisites: + - ALWAYS + update-welcome: + card-type: basic + order: 10 + title: Upgrade/Upgrade.Welcome.Title.v114 + body: Upgrade/Upgrade.Welcome.Description.v114 + image: welcome-globe + buttons: + primary: + title: Upgrade/Upgrade.Welcome.Action.v114 + action: forward-one-card + onboarding-type: upgrade + prerequisites: + - NEVER + update-sign-to-sync: + card-type: basic + order: 20 + title: Upgrade/Upgrade.SyncSign.Title.v114 + body: Upgrade/Upgrade.SyncSign.Description.v114 + image: sync-devices + buttons: + primary: + title: Upgrade/Upgrade.SyncSign.Action.v114 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.LaterAction.v114 + action: forward-one-card + onboarding-type: upgrade + prerequisites: + - NEVER + welcome-modern: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.Welcome.Title.v140 + body: Onboarding/Onboarding.Modern.Welcome.Description.v140 + image: trackers + buttons: + primary: + title: Onboarding/Onboarding.Modern.Welcome.ActionTreatementA.v140 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.Welcome.Skip.v140 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + sign-to-sync-modern: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.Sync.Title.v140 + body: Onboarding/Onboarding.Modern.Sync.Description.v140 + image: sync-with-icons + buttons: + primary: + title: Onboarding/Onboarding.Modern.Sync.SignIn.Action.v140 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.Sync.Skip.Action.v140 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-toolbar-modern: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Title.v140 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v140 + image: toolbar-bottom + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v140 + image: toolbar-top + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-theme-modern: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Customization.Theme.Title.v143 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Theme.System.Action.v123 + image: theme-system + action: theme-system-default + - title: Onboarding/Onboarding.Customization.Theme.Light.Action.v123 + image: theme-light + action: theme-light + - title: Onboarding/Onboarding.Customization.Theme.Dark.Action.v123 + image: theme-dark + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + string-alias: NimbusOnboardingCardKey + conditions: + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + string-alias: ConditionName + dismissable: + description: | + Whether or not the entire onboarding is dismissable by pressing an X at the top right corner of the screen. + type: Boolean + default: true + enableModernUi: + description: | + Toggle between legacy (false) and modern (true) UI variants. + type: Boolean + default: false + pdf-refactor-feature: + description: | + The feature flag to manage the roll out of the pdf refactor feature. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: true + revert-unsafe-continuations-refactor: + description: | + A feature flag to wrap reverting the unsafe continuations usage in the app. Unsafe continuations were used in response to an early 2025 incident when iOS 18.0 (possibly beta only) crashed on checked continuations (both regular and throwing). + variables: + enabled: + description: | + If true, revert unsafe continuations usage back to normal checked continuations usage. + type: Boolean + default: true + rust-fxa-keychain: + description: | + Feature that enables the rust FxA keychain logic. + variables: + rust-fxa-keychain-enabled: + description: | + Whether the rust FxA keychain logic is enabled. When enabled, the rust keychain is used to store and retrieve encryption key data for the FxA rust comoponent. Otherwise, the pre-existing MZKeychainWrapper logic is used. + type: Boolean + default: false + search: + description: | + Configuring the functionality to do with search. This will be separated into smaller sub-features in later releases. + variables: + awesome-bar: + description: Configuring the awesome bar. + type: AwesomeBar + default: + min-search-term: 3 + position: + is-bottom: false + is-position-feature-enabled: true + search-highlights: false + use-page-content: false + search-engine-consolidation-feature: + description: | + This feature is for managing the roll out of Search Engine Consolidation support in iOS + variables: + enabled: + description: | + Enables the feature + 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 + spotlight-search: + description: Add pages as items findable with Spotlight. + variables: + enabled: + description: If this is true, then on each page load adds a new item to Spotlight. + type: Boolean + default: false + icon-type: + description: | + The icon that is displayed next to the item in the search results. If this is `null`, then no icon is displayed. + type: Option + default: letter + keep-for-days: + description: | + Number of days to keep the item before automatic deletion. If this is left `null`, then it is left to iOS's default. + type: Option + default: null + searchable-content: + description: | + The text content that is made searchable. If this is `null` then no additional content is used, and only the title and URL will be used. + type: Option + default: text-excerpt + start-at-home-feature: + description: This feature is for experimenting with opening screen + variables: + setting: + description: This property provides a default setting for the start at home feature + type: StartAtHome + default: afterFourHours + tab-scroll-refactor-feature: + description: | + The feature flag to manage the rollout of tab scroll refactor feature. + variables: + enabled: + description: | + If true, tab scroll new implementation is used to show and hide toolbar views reacting to user scroll + type: Boolean + default: false + tab-tray-ui-experiments: + description: | + The tab tray will undergo some UI experimentation to test potential improvements. + variables: + enabled: + description: | + If true, enables the tab tray UI experiments. + type: Boolean + default: true + translucency: + description: | + If true, enables translucency for tab tray actions at the bottom. + type: Boolean + default: false + tabTrayFeature: + description: The tab tray screen that the user goes to when they open the tab tray. + 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: + inactive-tabs: true + toolbar-refactor-feature: + description: | + This feature is for managing the roll out of the Toolbar refactor feature + variables: + enabled: + description: | + Enables the feature + type: Boolean + default: true + layout: + description: | + The type of layout of the toolbars. + type: Option + default: version1 + minimal_address_bar: + description: | + Enables minimal address bar mode on scroll to ensure the url is always visible. + type: Boolean + default: false + navigation_hint: + description: | + If true, enables the navigation contextual hint. + type: Boolean + default: true + one_tap_new_tab: + description: | + If true, enables the one tap new tab feature for users. + type: Boolean + default: true + swiping_tabs: + description: | + Enables swipe gestures to switch between browser tabs. + type: Boolean + default: true + toolbar_update_hint: + description: | + If true, enables the toolbar update contextual hint. + type: Boolean + default: false + translucency: + description: | + Enables translucency for toolbars. + type: Boolean + default: true + unified_search: + description: | + Enables the unified search feature. + type: Boolean + default: false + tos-feature: + description: | + This feature is for managing the roll out of the ToS (Term of Service) implementation + variables: + status: + description: | + Enables the feature + type: Boolean + default: true + tou-feature: + description: | + This feature is for managing the rollout of the Terms of Use (ToU) implementation. + variables: + status: + description: | + Enables the feature + type: Boolean + default: false + tracking-protection-refactor: + description: | + The Enhanced Tracking Protection refactor + variables: + enabled: + description: | + Whether the Enhanced Tracking Protection refactor is enabled or not + type: Boolean + default: true + unified-ads: + description: | + This property is for managing the roll out of the unified ads API + variables: + enabled: + description: | + If true, we will enable user to use the unified ads API + type: Boolean + default: true + updated-password-manager-feature: + description: | + This property determines if we use the updated password manager or the legacy one. + variables: + status: + description: If true, firefox will use the the updated password manager. + type: Boolean + default: false + web-engine-integration-refactor: + description: | + The feature flag to manage the roll out of the integration of WebEngine into Firefox. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false +enums: + ControlMessageBehavior: + description: An enum to influence what should be displayed when a control message is selected. + variants: + show-next-message: + description: The next eligible message should be shown. + show-none: + description: The surface should show no message. + IconType: + description: The icon that will be added to the item in the device's search engine. + variants: + favicon: + description: The favicon of the page + letter: + description: An icon generated from the first letter of the base domain. + screenshot: + description: A screenshot of the page at load time. + MessageSurfaceId: + description: | + For messaging, we would like to have a message tell us which surface its associated with. This is a label that matches across both Android and iOS. + variants: + Unknown: + description: A message has NOT declared its target surface. + microsurvey: + description: This is a microsurvey that appears on top of the bottom toolbar to the user. + new-tab-card: + description: This is the card that appears at the top on the Firefox Home Page. + notification: + description: This is a local notification send to the user periodically with tips and updates. + survey: + description: This is a full-page that appears providing a survey to the user. + NimbusOnboardingHeaderImage: + description: | + The identifiers for the different images available for cards in onboarding + variants: + customize-firefox: + description: | + Corresponding to the fox window image + notifications: + description: | + Corresponding to the notifications image + notifications-ctd: + description: | + Corresponding to the notifications image for CTD + search-widget: + description: | + Corresponding to the fox search widget image + set-default-steps: + description: | + Corresponding to the set to default steps image + set-to-dock: + description: | + Corresponding to the set to dock image + sync-devices: + description: | + Corresponding to the sync-devices image + sync-devices-ctd: + description: | + Corresponding to the sync image for CTD + sync-with-icons: + description: | + Corresponding to the sync-devices image + themeing: + description: | + Corresponding to the fox world image + toolbar: + description: | + Corresponding to the fox world image + trackers: + description: | + Corresponding to the trackers image + welcome-ctd: + description: | + Corresponding to the welcome image for CTD + welcome-globe: + description: | + Corresponding to the fox world image + NimbusOnboardingMultipleChoiceButtonImage: + description: | + The identifiers for the different images available for multiple choice buttons in onboarding + variants: + theme-dark: + description: | + Corresponding to the dark theme + theme-light: + description: | + Corresponding to the light theme + theme-system: + description: | + Corresponding to the system theme + toolbar-bottom: + description: | + Corresponding to the toolbar on the bottom + toolbar-top: + description: | + Corresponding to the toolbar on top + OnboardingActions: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + end-onboarding: + description: | + Will end the onboarding on a set card + forward-one-card: + description: | + Will take the user to the next card + forward-three-card: + description: | + Will take the user to the next card + forward-two-card: + description: | + Will take the user to the next card + open-instructions-popup: + description: | + Will open up a popup with instructions for something + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + read-privacy-policy: + description: | + Will open a webview where the user can read the privacy policy + request-notifications: + description: | + Will request to allow notifications from the user + set-default-browser: + description: | + Will send the user to settings to set Firefox as their default browser and advance to next card + sync-sign-in: + description: | + Will take the user to the sync sign in flow + OnboardingCardType: + description: | + The identifiers for the different types of onboarding cards. + variants: + basic: + description: | + Corresponding to basic info onboarding cards + multiple-choice: + description: | + Corresponding to onboarding cards with multiple choice buttons + OnboardingInstructionsPopupActions: + description: | + The identifiers for the different actions available for the insturction card in onboarding + variants: + dismiss: + description: | + Will dismiss the popup + dismiss-and-next-card: + description: | + Will dismiss the popup and move to the next card + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + OnboardingMultipleChoiceAction: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + theme-dark: + description: | + Will will set the theme to dark mode + theme-light: + description: | + Will set the theme to light mode + theme-system-default: + description: | + Will set the theme to use the system theme + toolbar-bottom: + description: | + Will set the toolbar on the bottom + toolbar-top: + description: | + Will set the toolbar on the top + OnboardingType: + description: | + The identifiers for the different types of onboarding cards. + variants: + fresh-install: + description: | + Corresponding to onboarding cards that are for new users + upgrade: + description: | + Corresponding to onboarding cards that are for users who have updated + OnboardingVariant: + description: | + Which UI style this onboarding card is designed for. + variants: + legacy: + description: Use the existing (legacy) onboarding UI. + modern: + description: Use the new (modern) onboarding UI. + PageContent: + description: The page content that will be added as an item in the device's search engine. + variants: + html-content: + description: Use all the page as HTML + text-content: + description: Use all the page as text + text-excerpt: + description: Only use the first paragraph + StartAtHome: + description: The option for what screen to open the app to + variants: + afterFourHours: + description: Starts the app at the homepage after four hours of inactivity, otherwise starts the app at the most recently viewed tab. + always: + description: Starts the app at the homepage. + disabled: + description: Starts the app at the most recently viewed tab. + SuggestionType: + description: The type of a Firefox Suggest search suggestion. + variants: + amp: + description: A Firefox Suggestion for desktop from adMarketplace. + ampMobile: + description: A Firefox Suggestion specifically for mobile from adMarketplace. + wikipedia: + description: A Firefox Suggestion for a Wikipedia page. + TabTraySection: + description: The identifiers for the sections of the tab tray. + variants: + inactive-tabs: + description: Tabs that have been automatically closed for the user. + ToolbarLayoutType: + description: The type of toolbar layout. + variants: + baseline: + description: The default layout of the toolbars. + version1: + description: Shows the add new tab, menu and tabs button in the navigation toolbar. The share button is displayed in the address toolbar. + version2: + description: Like version1 but the menu and tabs buttons are inverted. +objects: + AwesomeBar: + description: A configuration option for the awesome bar. Part of the `search` feature. + fields: + min-search-term: + description: The minimum number of characters that the user types before searching in the page. + type: Int + default: 3 + position: + description: | + This property defines whether or not the feature is enabled, and the position of the search bar + type: SearchBarPositionFeature + default: + is-position-feature-enabled: true + is-bottom: true + search-highlights: + description: Whether or not search highlights are enabled + type: Boolean + default: false + use-page-content: + description: Search in the open tab's text content when typing. + type: Boolean + default: false + DiscoverMoreConfiguration: + description: | + A configuration that dictates the behaviour/subfeatures of the Discover More feature + fields: + discover-more-v1-experience: + description: | + Whether to show the Discover More experience is enabled + type: Boolean + default: false + show-discover-more-button: + description: | + Whether to show the Discover More button on the homepage + type: Boolean + default: false + GeneralFeature: + description: The configuration for the a feature that can be enabled or disabled + fields: + status: + description: Whether or not the feature is enabled + type: Boolean + default: false + MessageData: + description: | + An object to describe a message. It uses human readable strings to describe the triggers, action and style of the message as well as the text of the message and call to action. + fields: + action: + description: | + The name of a deeplink URL to be opened if the button is clicked. + type: Option + default: null + action-params: + description: Query parameters appended to the deeplink action URL + type: Map + default: {} + button-label: + description: | + The text on the button. If no text is present, the whole message is clickable. + type: Option + default: null + except-if-any: + description: | + A list of strings corresponding to targeting expressions. If any of these expressions evaluate to `true`, the message will not be eligible. + type: List + default: [] + experiment: + description: The experiment slug that this message is involved in. + type: Option + default: null + is-control: + description: Indicates if this message is the control message, if true shouldn't be displayed + type: Boolean + default: false + microsurveyConfig: + description: Optional configuration data for a microsurvey. + type: Option + default: null + style: + description: | + The style as described in a `StyleData` from the styles table. + type: StyleName + default: DEFAULT + surface: + description: Each message will tell us the surface it is targeting with this. + type: MessageSurfaceId + default: Unknown + text: + description: The message text displayed to the user + type: Text + default: '' + title: + description: The title text displayed to the user + type: Option + default: null + trigger-if-all: + description: | + A list of strings corresponding to targeting expressions. All named expressions must evaluate to true if the message is to be eligible to be shown. + type: List + default: + - ALWAYS + MicrosurveyConfig: + description: | + Attributes relating to microsurvey messaging. + fields: + icon: + description: The asset name in our bundle used as the icon shown in the survey. + type: Image + default: lightbulbLarge + options: + description: The list of survey options to present to the user. + type: List + default: [] + utm-content: + description: The name used to provide as the utm_content parameter for the privacy notice. + type: Option + default: null + NimbusOnboardingButton: + description: | + A group of properties describing the attributes of a card. + fields: + action: + description: | + The action the button should take. The default for this will be "forward-one-card" + type: OnboardingActions + default: forward-one-card + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingButtons: + description: | + A set of buttons for the card. There can be up to two, but there must be at least one. + fields: + primary: + description: | + The primary button for the card. This must exist. + type: NimbusOnboardingButton + default: + title: Primary Button + action: forward-one-card + secondary: + description: | + A secondary, optional, button for the card. + type: Option + default: null + NimbusOnboardingCardData: + description: | + A group of properties describing the attributes of a card. + fields: + body: + description: | + The body text dispalyed on the card, in less prominent text. This should never be defaulted. + type: Text + default: '' + buttons: + description: | + The set of buttons associated with the card. + type: NimbusOnboardingButtons + default: + primary: + title: Onboarding/Onboarding.Sync.Skip.Action.v114 + action: forward-one-card + secondary: null + card-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingCardType + default: basic + disqualifiers: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will not be shown if any expression is `true`. + type: List + default: [] + image: + description: | + The image that should be dispalyed on the card. + type: NimbusOnboardingHeaderImage + default: welcome-globe + instructions-popup: + description: | + The object describing the specific instruction popup button for a card. If left empty, the card will have no instruction popup information + type: Option + default: null + link: + description: | + The object describing the link button for a card. If left empty, the card will have no link. + type: Option + default: null + multiple-choice-buttons: + description: | + A list of multiple choice buttons that the card will display + type: List + default: [] + onboarding-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingType + default: fresh-install + order: + description: | + The place in the order where the card will be found. The feature layer will then sort the cards based on this field. + type: Int + default: 10 + prerequisites: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will be shown if all expressions `true` and if no expressions in the `disqualifiers` table are true, or if the `disqualifiers` table is empty. + type: List + default: [] + title: + description: | + The title displayed on the card, in prominent, bolded text. This should never be defaulted. + type: Text + default: '' + uiVariant: + description: | + If set, this card will only be shown in the specified UI variant. If null, it will appear in both legacy and modern UIs. + type: Option + default: null + NimbusOnboardingInstructionPopup: + description: | + The object outlining the content of the instruction card. + fields: + button-action: + description: | + The action the button should have. Default is `dismiss-and-next-card` + type: OnboardingInstructionsPopupActions + default: dismiss-and-next-card + button-title: + description: | + The title the button should have. This should never be defaulted. + type: Text + default: '' + instructions: + description: | + A list of instructions, either as free text, or as Text identifiers. + type: List + default: [] + title: + description: | + The text of the popup. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingLink: + description: | + A group of properties describing the attributes for the active link on a card + fields: + title: + description: | + The text of the link title. + type: Text + default: Onboarding/Onboarding.Welcome.Link.Action.v114 + url: + description: | + The url that the link will lead to. + type: String + default: https://www.mozilla.org/privacy/firefox/ + NimbusOnboardingMultipleChoiceButton: + description: | + A group of properties describing the attributes of a multiple choice button on a card + fields: + action: + description: | + The action the button should take. The default for this will be "theme-system-default" + type: OnboardingMultipleChoiceAction + default: theme-system-default + image: + description: | + The text of the button title. This should never be defaulted. + type: NimbusOnboardingMultipleChoiceButtonImage + default: theme-system + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + SearchBarPositionFeature: + description: The configuration for the bottom search bar on the homescreen + fields: + is-bottom: + description: Whether or not the default position is at the bottom + type: Boolean + default: true + is-position-feature-enabled: + description: Whether or not the feature is enabled + type: Boolean + default: true + StyleData: + description: | + A group of properities (predominantly visual) to the describe style of the message. + fields: + max-display-count: + description: | + How many sessions will this message be shown to the user before it is expired. + type: Int + default: 5 + priority: + description: | + The importance of this message. 0 is not very important, 100 is very important. + type: Int + default: 50 diff --git a/experimenter/experimenter/features/manifests/ios/v143.2.0/developer.fml.yaml b/experimenter/experimenter/features/manifests/ios/v143.2.0/developer.fml.yaml new file mode 100644 index 0000000000..ada8b56b57 --- /dev/null +++ b/experimenter/experimenter/features/manifests/ios/v143.2.0/developer.fml.yaml @@ -0,0 +1,1381 @@ +version: 1.0.0 +about: + description: The root level Feature Manifest for Firefox for iOS +channels: +- developer +features: + address-autofill-edit: + description: This property defines if the address editing is enabled in Settings + variables: + status: + description: If true, we will allow user to edit the address + type: Boolean + default: true + address-bar-menu-feature: + description: | + This property determines if we show the new address bar menu entry or the toolbar menu in settings + variables: + status: + description: If true, we will show the new address bar menu entry + type: Boolean + default: true + appearance-menu-feature: + description: | + This property determines if we show the new appearance menu entry or the old theme settings + variables: + status: + description: If true, we will show the new appearance menu entry + type: Boolean + default: true + apple-summarizer-feature: + description: | + This feature enables the apple summarizer feature. + variables: + enabled: + description: | + Enables the apple summarizer feature. + type: Boolean + default: true + shakeGesture: + description: | + Enables the shake gesture for the summarizer feature. + type: Boolean + default: true + toolbarEntrypoint: + description: | + Enables the toolbar entrypoint for the summarizer feature. + type: Boolean + default: true + deeplink-optimization-refactor-feature: + description: | + The feature flag to manage the rollout of deeplink optimization feature. + variables: + enabled: + description: | + Variable description + type: Boolean + default: true + default-zoom-feature: + description: | + The feature flag to manage the rollout of default zoom feature. + variables: + enabled: + description: | + If true, page zoom settings and default zoom feature are shown + type: Boolean + default: true + download-live-activities-feature: + description: | + Download Live Activities Feature + variables: + enabled: + description: | + If true, the download live activities feature is enabled + type: Boolean + default: true + felt-privacy-feature: + description: The feature that enhances private browsing mode + variables: + felt-deletion-enabled: + description: If true, enable Felt Deletion part of Felt Privacy + type: Boolean + default: false + simplified-ui-enabled: + description: If true, enable simplified UI part of Felt Privacy + type: Boolean + default: true + firefox-suggest-feature: + description: Configuration for the Firefox Suggest feature. + variables: + available-suggestions-types: + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + type: Map + default: + amp: true + ampMobile: false + wikipedia: true + status: + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. + type: Boolean + default: true + general-app-features: + description: The feature that contains feature flags for the entire application + variables: + report-site-issue: + description: This property defines whether or not the feature is enabled + type: GeneralFeature + default: + status: true + hnt-sponsored-shortcuts-feature: + description: This feature manages the visibility of sponsored shortcuts on the homepage + variables: + enabled: + description: Setting 'enabled' to false will hide sponsored shortcuts on the homepage and disable the respective toggle in the homepage settings + type: Boolean + default: true + hnt-top-sites-visual-refresh-feature: + description: This feature manages the top sites visual refresh. + variables: + enabled: + description: Determines whether the top sites visual refresh is shown. + type: Boolean + default: true + homepage-rebuild-feature: + description: | + This feature is for managing the roll out of the Homepage rebuild feature + variables: + enabled: + description: | + If true, enables the feature + type: Boolean + default: true + homepage-redesign-feature: + description: | + This feature is for managing the roll out of the Homepage New Tab Redesign feature. + variables: + discover-more-feature-configuration: + description: | + A configuration for the Discover More feature + type: DiscoverMoreConfiguration + default: + discover-more-v1-experience: false + show-discover-more-button: false + enabled: + description: | + Enables the feature. + type: Boolean + default: false + search-bar: + description: | + If true, enables the search bar feature on homepage for users. + type: Boolean + default: true + shortcuts-library: + description: | + If true, enables the shortcuts library feature, accessible from the homepage + type: Boolean + default: false + stories-redesign: + description: | + If true, enables the stories section redesign on homepage, which also includes the removal of other sections (i.e. jump back in, bookmarks) + type: Boolean + default: true + hosted-summarizer-feature: + description: | + This feature enables the hosted summarizer feature. + variables: + enabled: + description: | + Enables the hosted summarizer feature. + type: Boolean + default: true + shakeGesture: + description: | + Enables the shake gesture for the summarizer feature. + type: Boolean + default: true + toolbarEntrypoint: + description: | + Enables the toolbar entrypoint for the summarizer feature. + type: Boolean + default: true + menu-refactor-feature: + description: | + Controls the menu refactor feature + variables: + enabled: + description: | + Controls which menu users will see + type: Boolean + default: true + menu-default-browser-banner: + description: | + If true, enables the menu Make Firefox your default banner, on top of the menu. + type: Boolean + default: true + menu-redesign-hint: + description: | + If true, enables the menu contextual hint for menu redesign. + type: Boolean + default: true + messaging: + description: | + The in-app messaging system + documentation: + - name: User documentation + url: https://experimenter.info/messaging/mobile-messaging + contacts: + - jhugman@mozilla.com + - brennie@mozilla.com + - gbuciu@mozilla.com + - wteichmann@mozilla.com + events: + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_shown + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_clicked + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_expired + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_dismissed + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_malformed + variables: + actions: + description: A growable map of action URLs. + type: Map + default: + OPEN_SETTINGS: ://deep-link?url=settings/general + OPEN_SETTINGS_NEW_TAB: ://deep-link?url=settings/newtab + OPEN_SETTINGS_HOMESCREEN: ://deep-link?url=settings/homepage + OPEN_SETTINGS_WALLPAPERS: ://deep-link?url=settings/wallpaper + OPEN_SETTINGS_EMAIL: ://deep-link?url=settings/mailto + OPEN_SETTINGS_SEARCH_ENGINE: ://deep-link?url=settings/search + OPEN_SETTINGS_PRIVACY: ://deep-link?url=settings/clear-private-data + OPEN_SETTINGS_FXA: ://deep-link?url=settings/fxa + OPEN_SETTINGS_THEME: ://deep-link?url=settings/theme + OPEN_SETTINGS_APP_ICON: ://deep-link?url=settings/app-icon + OPEN_URL: ://open-url + VIEW_BOOKMARKS: ://deep-link?url=homepanel/bookmarks + VIEW_TOP_SITES: ://deep-link?url=homepanel/top-sites + VIEW_READING_LIST: ://deep-link?url=homepanel/reading-list + VIEW_HISTORY: ://deep-link?url=homepanel/history + VIEW_DOWNLOADS: ://deep-link?url=homepanel/downloads + ENABLE_PRIVATE_BROWSING: ://deep-link?url=homepanel/new-private-tab + OPEN_NEW_TAB: ://deep-link?url=homepanel/new-tab + MAKE_DEFAULT_BROWSER: ://deep-link?url=default-browser/system-settings + MAKE_DEFAULT_BROWSER_WITH_TUTORIAL: ://deep-link?url=default-browser/tutorial + OPEN_SHARE_SHEET: ://share-sheet + string-alias: ActionName + message-under-experiment: + description: 'Deprecated. Please use "experiment": "{experiment}" instead.' + type: Option + default: null + messages: + description: | + A growable collection of messages, where the Key is the message identifier and the value is its associated MessageData. + type: Map + default: + homepage-microsurvey-message: + surface: microsurvey + style: MICROSURVEY + trigger-if-all: + - SECOND_HOMEPAGE_VIEW + title: Microsurvey/Microsurvey.Prompt.TitleLabel.v127 + text: How satisfied are you with your Firefox homepage? + button-label: Microsurvey/Microsurvey.Prompt.Button.v127 + microsurveyConfig: + utm-content: homepage + icon: homeLarge + options: + - Microsurvey/Microsurvey.Survey.Options.VerySatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.Satisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.Neutral.v132 + - Microsurvey/Microsurvey.Survey.Options.Dissatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.VeryDissatisfied.v132 + - Microsurvey/Microsurvey.Survey.Options.NotApplicable.v132 + survey-surface-message: + surface: survey + style: SURVEY + trigger-if-all: + - NEVER + text: ResearchSurface/Body.Text.v112 + button-label: ResearchSurface/PrimaryButton.Label.v112 + action: OPEN_URL + action-params: + url: https://www.macrumors.com + string-alias: MessageKey + on-control: + description: What should be displayed when a control message is selected. + type: ControlMessageBehavior + default: show-next-message + styles: + description: | + A map of styles to configure message appearance. + type: Map + default: + FALLBACK: + priority: 40 + max-display-count: 20 + DEFAULT: + priority: 50 + max-display-count: 5 + MICROSURVEY: + priority: 50 + max-display-count: 1 + NOTIFICATION: + priority: 50 + max-display-count: 1 + PERSISTENT: + priority: 50 + max-display-count: 20 + SURVEY: + priority: 55 + max-display-count: 10 + WARNING: + priority: 60 + max-display-count: 10 + URGENT: + priority: 100 + max-display-count: 10 + string-alias: StyleName + triggers: + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + USER_RECENTLY_INSTALLED: days_since_install < 7 + USER_RECENTLY_UPDATED: days_since_update < 7 && days_since_install != days_since_update + USER_TIER_ONE_COUNTRY: ('US' in locale || 'GB' in locale || 'CA' in locale || 'DE' in locale || 'FR' in locale) + USER_EN_SPEAKER: '''en'' in locale' + USER_ES_SPEAKER: '''es'' in locale' + USER_DE_SPEAKER: '''de'' in locale' + USER_FR_SPEAKER: '''fr'' in locale' + DEVICE_ANDROID: os == 'Android' + DEVICE_IOS: os == 'iOS' + DAY_1_AFTER_INSTALL: days_since_install == 1 + DAY_2_AFTER_INSTALL: days_since_install == 2 + DAY_3_AFTER_INSTALL: days_since_install == 3 + DAY_4_AFTER_INSTALL: days_since_install == 4 + DAY_5_AFTER_INSTALL: days_since_install == 5 + MORE_THAN_24H_SINCE_INSTALLED_OR_UPDATED: days_since_update >= 1 + NOT_LAUNCHED_YESTERDAY: '''app_cycle.foreground''|eventLastSeen(''Days'', 1) > 1' + AFTER_THREE_LAUNCHES_THIS_WEEK: '''app_cycle.foreground''|eventSum(''Weeks'', 1, 0) >= 3' + I_AM_DEFAULT_BROWSER: is_default_browser + I_AM_NOT_DEFAULT_BROWSER: is_default_browser == false + SUPPORTS_DEFAULT_BROWSER: os_version|versionCompare('14.!') >= 0 + INACTIVE_NEW_USER: is_inactive_new_user + ALLOWED_TIPS_NOTIFICATIONS: allowed_tips_notifications + FXA_CURRENTLY_SIGNED_IN: is_fxa_signed_in == true + SECOND_HOMEPAGE_VIEW: '''homepage_viewed''|eventSum(''Years'', 4, 0) >= 2' + ON_FOURTH_LAUNCH_THIS_YEAR: '''app_cycle.foreground''|eventSum(''Years'', 1, 0) > 3' + string-alias: TriggerName + ~~experiment: + description: Not to be set by experiment. + type: ExperimentSlug + default: '{experiment}' + string-alias: ExperimentSlug + allow-coenrollment: true + microsurvey-feature: + description: | + A feature that shows the microsurvey for users to interact with and submit responses. + variables: + enabled: + description: | + If true, the feature is active. + type: Boolean + default: true + native-error-page-feature: + description: | + This feature is for managing the roll out of the native error page feature + variables: + enabled: + description: | + If true, the feature is active. + type: Boolean + default: false + no_internet_connection_error: + description: | + This feature is for managing the roll out of the no interet connection native error page feature + type: Boolean + default: false + onboarding-framework-feature: + description: | + The new onboarding framework feature that will allow onboarding to be experimentable through initial experiments. + variables: + cards: + description: | + The list of available cards for onboarding. + type: Map + default: + welcome: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Welcome.Title.TreatementA.v120 + body: Onboarding/Onboarding.Welcome.Description.TreatementA.v120 + image: welcome-globe + buttons: + primary: + title: Onboarding/Onboarding.Welcome.ActionTreatementA.v114 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Welcome.Skip.v114 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + notification-permissions: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Notification.Title.v120 + body: Onboarding/Onboarding.Notification.Description.v120 + image: notifications + buttons: + primary: + title: Onboarding/Onboarding.Notification.TurnOnNotifications.Action.v114 + action: request-notifications + secondary: + title: Onboarding/Onboarding.Notification.Skip.Action.v115 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + sign-to-sync: + card-type: basic + order: 20 + title: Onboarding/Onboarding.Sync.Title.v120 + body: Onboarding/Onboarding.Sync.Description.v123 + image: sync-devices + buttons: + primary: + title: Onboarding/Onboarding.Sync.SignIn.Action.v114 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Sync.Skip.Action.v114 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + customization-theme: + card-type: multiple-choice + order: 40 + title: Onboarding/Onboarding.Customization.Theme.Title.v123 + body: Onboarding/Onboarding.Customization.Theme.Description.v123 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Customization.Theme.Continue.Action.v123 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Theme.System.Action.v123 + image: theme-system + action: theme-system-default + - title: Onboarding/Onboarding.Customization.Theme.Light.Action.v123 + image: theme-light + action: theme-light + - title: Onboarding/Onboarding.Customization.Theme.Dark.Action.v123 + image: theme-dark + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + customization-toolbar: + card-type: multiple-choice + order: 41 + title: Onboarding/Onboarding.Customization.Toolbar.Title.v123 + body: Onboarding/Onboarding.Customization.Toolbar.Description.v123 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Customization.Toolbar.Continue.Action.v123 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Toolbar.Top.Action.v123 + image: toolbar-top + action: toolbar-top + - title: Onboarding/Onboarding.Customization.Toolbar.Bottom.Action.v123 + image: toolbar-bottom + action: toolbar-bottom + onboarding-type: fresh-install + prerequisites: + - ALWAYS + update-welcome: + card-type: basic + order: 10 + title: Upgrade/Upgrade.Welcome.Title.v114 + body: Upgrade/Upgrade.Welcome.Description.v114 + image: welcome-globe + buttons: + primary: + title: Upgrade/Upgrade.Welcome.Action.v114 + action: forward-one-card + onboarding-type: upgrade + prerequisites: + - NEVER + update-sign-to-sync: + card-type: basic + order: 20 + title: Upgrade/Upgrade.SyncSign.Title.v114 + body: Upgrade/Upgrade.SyncSign.Description.v114 + image: sync-devices + buttons: + primary: + title: Upgrade/Upgrade.SyncSign.Action.v114 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.LaterAction.v114 + action: forward-one-card + onboarding-type: upgrade + prerequisites: + - NEVER + welcome-modern: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.Welcome.Title.v140 + body: Onboarding/Onboarding.Modern.Welcome.Description.v140 + image: trackers + buttons: + primary: + title: Onboarding/Onboarding.Modern.Welcome.ActionTreatementA.v140 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.Welcome.Skip.v140 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + sign-to-sync-modern: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.Sync.Title.v140 + body: Onboarding/Onboarding.Modern.Sync.Description.v140 + image: sync-with-icons + buttons: + primary: + title: Onboarding/Onboarding.Modern.Sync.SignIn.Action.v140 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.Sync.Skip.Action.v140 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-toolbar-modern: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Title.v140 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v140 + image: toolbar-bottom + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v140 + image: toolbar-top + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-theme-modern: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Customization.Theme.Title.v143 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Theme.System.Action.v123 + image: theme-system + action: theme-system-default + - title: Onboarding/Onboarding.Customization.Theme.Light.Action.v123 + image: theme-light + action: theme-light + - title: Onboarding/Onboarding.Customization.Theme.Dark.Action.v123 + image: theme-dark + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + string-alias: NimbusOnboardingCardKey + conditions: + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + string-alias: ConditionName + dismissable: + description: | + Whether or not the entire onboarding is dismissable by pressing an X at the top right corner of the screen. + type: Boolean + default: true + enableModernUi: + description: | + Toggle between legacy (false) and modern (true) UI variants. + type: Boolean + default: false + pdf-refactor-feature: + description: | + The feature flag to manage the roll out of the pdf refactor feature. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: true + revert-unsafe-continuations-refactor: + description: | + A feature flag to wrap reverting the unsafe continuations usage in the app. Unsafe continuations were used in response to an early 2025 incident when iOS 18.0 (possibly beta only) crashed on checked continuations (both regular and throwing). + variables: + enabled: + description: | + If true, revert unsafe continuations usage back to normal checked continuations usage. + type: Boolean + default: true + rust-fxa-keychain: + description: | + Feature that enables the rust FxA keychain logic. + variables: + rust-fxa-keychain-enabled: + description: | + Whether the rust FxA keychain logic is enabled. When enabled, the rust keychain is used to store and retrieve encryption key data for the FxA rust comoponent. Otherwise, the pre-existing MZKeychainWrapper logic is used. + type: Boolean + default: true + search: + description: | + Configuring the functionality to do with search. This will be separated into smaller sub-features in later releases. + variables: + awesome-bar: + description: Configuring the awesome bar. + type: AwesomeBar + default: + min-search-term: 3 + position: + is-bottom: false + is-position-feature-enabled: true + search-highlights: false + use-page-content: false + search-engine-consolidation-feature: + description: | + This feature is for managing the roll out of Search Engine Consolidation support in iOS + variables: + enabled: + description: | + Enables the feature + 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: 6000 + spotlight-search: + description: Add pages as items findable with Spotlight. + variables: + enabled: + description: If this is true, then on each page load adds a new item to Spotlight. + type: Boolean + default: true + icon-type: + description: | + The icon that is displayed next to the item in the search results. If this is `null`, then no icon is displayed. + type: Option + default: screenshot + keep-for-days: + description: | + Number of days to keep the item before automatic deletion. If this is left `null`, then it is left to iOS's default. + type: Option + default: null + searchable-content: + description: | + The text content that is made searchable. If this is `null` then no additional content is used, and only the title and URL will be used. + type: Option + default: text-excerpt + start-at-home-feature: + description: This feature is for experimenting with opening screen + variables: + setting: + description: This property provides a default setting for the start at home feature + type: StartAtHome + default: afterFourHours + tab-scroll-refactor-feature: + description: | + The feature flag to manage the rollout of tab scroll refactor feature. + variables: + enabled: + description: | + If true, tab scroll new implementation is used to show and hide toolbar views reacting to user scroll + type: Boolean + default: false + tab-tray-ui-experiments: + description: | + The tab tray will undergo some UI experimentation to test potential improvements. + variables: + enabled: + description: | + If true, enables the tab tray UI experiments. + type: Boolean + default: true + translucency: + description: | + If true, enables translucency for tab tray actions at the bottom. + type: Boolean + default: true + tabTrayFeature: + description: The tab tray screen that the user goes to when they open the tab tray. + 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: + inactive-tabs: true + toolbar-refactor-feature: + description: | + This feature is for managing the roll out of the Toolbar refactor feature + variables: + enabled: + description: | + Enables the feature + type: Boolean + default: true + layout: + description: | + The type of layout of the toolbars. + type: Option + default: version1 + minimal_address_bar: + description: | + Enables minimal address bar mode on scroll to ensure the url is always visible. + type: Boolean + default: true + navigation_hint: + description: | + If true, enables the navigation contextual hint. + type: Boolean + default: true + one_tap_new_tab: + description: | + If true, enables the one tap new tab feature for users. + type: Boolean + default: true + swiping_tabs: + description: | + Enables swipe gestures to switch between browser tabs. + type: Boolean + default: true + toolbar_update_hint: + description: | + If true, enables the toolbar update contextual hint. + type: Boolean + default: false + translucency: + description: | + Enables translucency for toolbars. + type: Boolean + default: true + unified_search: + description: | + Enables the unified search feature. + type: Boolean + default: false + tos-feature: + description: | + This feature is for managing the roll out of the ToS (Term of Service) implementation + variables: + status: + description: | + Enables the feature + type: Boolean + default: false + tou-feature: + description: | + This feature is for managing the rollout of the Terms of Use (ToU) implementation. + variables: + status: + description: | + Enables the feature + type: Boolean + default: false + tracking-protection-refactor: + description: | + The Enhanced Tracking Protection refactor + variables: + enabled: + description: | + Whether the Enhanced Tracking Protection refactor is enabled or not + type: Boolean + default: true + unified-ads: + description: | + This property is for managing the roll out of the unified ads API + variables: + enabled: + description: | + If true, we will enable user to use the unified ads API + type: Boolean + default: true + updated-password-manager-feature: + description: | + This property determines if we use the updated password manager or the legacy one. + variables: + status: + description: If true, firefox will use the the updated password manager. + type: Boolean + default: false + web-engine-integration-refactor: + description: | + The feature flag to manage the roll out of the integration of WebEngine into Firefox. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false +enums: + ControlMessageBehavior: + description: An enum to influence what should be displayed when a control message is selected. + variants: + show-next-message: + description: The next eligible message should be shown. + show-none: + description: The surface should show no message. + IconType: + description: The icon that will be added to the item in the device's search engine. + variants: + favicon: + description: The favicon of the page + letter: + description: An icon generated from the first letter of the base domain. + screenshot: + description: A screenshot of the page at load time. + MessageSurfaceId: + description: | + For messaging, we would like to have a message tell us which surface its associated with. This is a label that matches across both Android and iOS. + variants: + Unknown: + description: A message has NOT declared its target surface. + microsurvey: + description: This is a microsurvey that appears on top of the bottom toolbar to the user. + new-tab-card: + description: This is the card that appears at the top on the Firefox Home Page. + notification: + description: This is a local notification send to the user periodically with tips and updates. + survey: + description: This is a full-page that appears providing a survey to the user. + NimbusOnboardingHeaderImage: + description: | + The identifiers for the different images available for cards in onboarding + variants: + customize-firefox: + description: | + Corresponding to the fox window image + notifications: + description: | + Corresponding to the notifications image + notifications-ctd: + description: | + Corresponding to the notifications image for CTD + search-widget: + description: | + Corresponding to the fox search widget image + set-default-steps: + description: | + Corresponding to the set to default steps image + set-to-dock: + description: | + Corresponding to the set to dock image + sync-devices: + description: | + Corresponding to the sync-devices image + sync-devices-ctd: + description: | + Corresponding to the sync image for CTD + sync-with-icons: + description: | + Corresponding to the sync-devices image + themeing: + description: | + Corresponding to the fox world image + toolbar: + description: | + Corresponding to the fox world image + trackers: + description: | + Corresponding to the trackers image + welcome-ctd: + description: | + Corresponding to the welcome image for CTD + welcome-globe: + description: | + Corresponding to the fox world image + NimbusOnboardingMultipleChoiceButtonImage: + description: | + The identifiers for the different images available for multiple choice buttons in onboarding + variants: + theme-dark: + description: | + Corresponding to the dark theme + theme-light: + description: | + Corresponding to the light theme + theme-system: + description: | + Corresponding to the system theme + toolbar-bottom: + description: | + Corresponding to the toolbar on the bottom + toolbar-top: + description: | + Corresponding to the toolbar on top + OnboardingActions: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + end-onboarding: + description: | + Will end the onboarding on a set card + forward-one-card: + description: | + Will take the user to the next card + forward-three-card: + description: | + Will take the user to the next card + forward-two-card: + description: | + Will take the user to the next card + open-instructions-popup: + description: | + Will open up a popup with instructions for something + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + read-privacy-policy: + description: | + Will open a webview where the user can read the privacy policy + request-notifications: + description: | + Will request to allow notifications from the user + set-default-browser: + description: | + Will send the user to settings to set Firefox as their default browser and advance to next card + sync-sign-in: + description: | + Will take the user to the sync sign in flow + OnboardingCardType: + description: | + The identifiers for the different types of onboarding cards. + variants: + basic: + description: | + Corresponding to basic info onboarding cards + multiple-choice: + description: | + Corresponding to onboarding cards with multiple choice buttons + OnboardingInstructionsPopupActions: + description: | + The identifiers for the different actions available for the insturction card in onboarding + variants: + dismiss: + description: | + Will dismiss the popup + dismiss-and-next-card: + description: | + Will dismiss the popup and move to the next card + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + OnboardingMultipleChoiceAction: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + theme-dark: + description: | + Will will set the theme to dark mode + theme-light: + description: | + Will set the theme to light mode + theme-system-default: + description: | + Will set the theme to use the system theme + toolbar-bottom: + description: | + Will set the toolbar on the bottom + toolbar-top: + description: | + Will set the toolbar on the top + OnboardingType: + description: | + The identifiers for the different types of onboarding cards. + variants: + fresh-install: + description: | + Corresponding to onboarding cards that are for new users + upgrade: + description: | + Corresponding to onboarding cards that are for users who have updated + OnboardingVariant: + description: | + Which UI style this onboarding card is designed for. + variants: + legacy: + description: Use the existing (legacy) onboarding UI. + modern: + description: Use the new (modern) onboarding UI. + PageContent: + description: The page content that will be added as an item in the device's search engine. + variants: + html-content: + description: Use all the page as HTML + text-content: + description: Use all the page as text + text-excerpt: + description: Only use the first paragraph + StartAtHome: + description: The option for what screen to open the app to + variants: + afterFourHours: + description: Starts the app at the homepage after four hours of inactivity, otherwise starts the app at the most recently viewed tab. + always: + description: Starts the app at the homepage. + disabled: + description: Starts the app at the most recently viewed tab. + SuggestionType: + description: The type of a Firefox Suggest search suggestion. + variants: + amp: + description: A Firefox Suggestion for desktop from adMarketplace. + ampMobile: + description: A Firefox Suggestion specifically for mobile from adMarketplace. + wikipedia: + description: A Firefox Suggestion for a Wikipedia page. + TabTraySection: + description: The identifiers for the sections of the tab tray. + variants: + inactive-tabs: + description: Tabs that have been automatically closed for the user. + ToolbarLayoutType: + description: The type of toolbar layout. + variants: + baseline: + description: The default layout of the toolbars. + version1: + description: Shows the add new tab, menu and tabs button in the navigation toolbar. The share button is displayed in the address toolbar. + version2: + description: Like version1 but the menu and tabs buttons are inverted. +objects: + AwesomeBar: + description: A configuration option for the awesome bar. Part of the `search` feature. + fields: + min-search-term: + description: The minimum number of characters that the user types before searching in the page. + type: Int + default: 3 + position: + description: | + This property defines whether or not the feature is enabled, and the position of the search bar + type: SearchBarPositionFeature + default: + is-position-feature-enabled: true + is-bottom: true + search-highlights: + description: Whether or not search highlights are enabled + type: Boolean + default: false + use-page-content: + description: Search in the open tab's text content when typing. + type: Boolean + default: false + DiscoverMoreConfiguration: + description: | + A configuration that dictates the behaviour/subfeatures of the Discover More feature + fields: + discover-more-v1-experience: + description: | + Whether to show the Discover More experience is enabled + type: Boolean + default: false + show-discover-more-button: + description: | + Whether to show the Discover More button on the homepage + type: Boolean + default: false + GeneralFeature: + description: The configuration for the a feature that can be enabled or disabled + fields: + status: + description: Whether or not the feature is enabled + type: Boolean + default: false + MessageData: + description: | + An object to describe a message. It uses human readable strings to describe the triggers, action and style of the message as well as the text of the message and call to action. + fields: + action: + description: | + The name of a deeplink URL to be opened if the button is clicked. + type: Option + default: null + action-params: + description: Query parameters appended to the deeplink action URL + type: Map + default: {} + button-label: + description: | + The text on the button. If no text is present, the whole message is clickable. + type: Option + default: null + except-if-any: + description: | + A list of strings corresponding to targeting expressions. If any of these expressions evaluate to `true`, the message will not be eligible. + type: List + default: [] + experiment: + description: The experiment slug that this message is involved in. + type: Option + default: null + is-control: + description: Indicates if this message is the control message, if true shouldn't be displayed + type: Boolean + default: false + microsurveyConfig: + description: Optional configuration data for a microsurvey. + type: Option + default: null + style: + description: | + The style as described in a `StyleData` from the styles table. + type: StyleName + default: DEFAULT + surface: + description: Each message will tell us the surface it is targeting with this. + type: MessageSurfaceId + default: Unknown + text: + description: The message text displayed to the user + type: Text + default: '' + title: + description: The title text displayed to the user + type: Option + default: null + trigger-if-all: + description: | + A list of strings corresponding to targeting expressions. All named expressions must evaluate to true if the message is to be eligible to be shown. + type: List + default: + - ALWAYS + MicrosurveyConfig: + description: | + Attributes relating to microsurvey messaging. + fields: + icon: + description: The asset name in our bundle used as the icon shown in the survey. + type: Image + default: lightbulbLarge + options: + description: The list of survey options to present to the user. + type: List + default: [] + utm-content: + description: The name used to provide as the utm_content parameter for the privacy notice. + type: Option + default: null + NimbusOnboardingButton: + description: | + A group of properties describing the attributes of a card. + fields: + action: + description: | + The action the button should take. The default for this will be "forward-one-card" + type: OnboardingActions + default: forward-one-card + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingButtons: + description: | + A set of buttons for the card. There can be up to two, but there must be at least one. + fields: + primary: + description: | + The primary button for the card. This must exist. + type: NimbusOnboardingButton + default: + title: Primary Button + action: forward-one-card + secondary: + description: | + A secondary, optional, button for the card. + type: Option + default: null + NimbusOnboardingCardData: + description: | + A group of properties describing the attributes of a card. + fields: + body: + description: | + The body text dispalyed on the card, in less prominent text. This should never be defaulted. + type: Text + default: '' + buttons: + description: | + The set of buttons associated with the card. + type: NimbusOnboardingButtons + default: + primary: + title: Onboarding/Onboarding.Sync.Skip.Action.v114 + action: forward-one-card + secondary: null + card-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingCardType + default: basic + disqualifiers: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will not be shown if any expression is `true`. + type: List + default: [] + image: + description: | + The image that should be dispalyed on the card. + type: NimbusOnboardingHeaderImage + default: welcome-globe + instructions-popup: + description: | + The object describing the specific instruction popup button for a card. If left empty, the card will have no instruction popup information + type: Option + default: null + link: + description: | + The object describing the link button for a card. If left empty, the card will have no link. + type: Option + default: null + multiple-choice-buttons: + description: | + A list of multiple choice buttons that the card will display + type: List + default: [] + onboarding-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingType + default: fresh-install + order: + description: | + The place in the order where the card will be found. The feature layer will then sort the cards based on this field. + type: Int + default: 10 + prerequisites: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will be shown if all expressions `true` and if no expressions in the `disqualifiers` table are true, or if the `disqualifiers` table is empty. + type: List + default: [] + title: + description: | + The title displayed on the card, in prominent, bolded text. This should never be defaulted. + type: Text + default: '' + uiVariant: + description: | + If set, this card will only be shown in the specified UI variant. If null, it will appear in both legacy and modern UIs. + type: Option + default: null + NimbusOnboardingInstructionPopup: + description: | + The object outlining the content of the instruction card. + fields: + button-action: + description: | + The action the button should have. Default is `dismiss-and-next-card` + type: OnboardingInstructionsPopupActions + default: dismiss-and-next-card + button-title: + description: | + The title the button should have. This should never be defaulted. + type: Text + default: '' + instructions: + description: | + A list of instructions, either as free text, or as Text identifiers. + type: List + default: [] + title: + description: | + The text of the popup. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingLink: + description: | + A group of properties describing the attributes for the active link on a card + fields: + title: + description: | + The text of the link title. + type: Text + default: Onboarding/Onboarding.Welcome.Link.Action.v114 + url: + description: | + The url that the link will lead to. + type: String + default: https://www.mozilla.org/privacy/firefox/ + NimbusOnboardingMultipleChoiceButton: + description: | + A group of properties describing the attributes of a multiple choice button on a card + fields: + action: + description: | + The action the button should take. The default for this will be "theme-system-default" + type: OnboardingMultipleChoiceAction + default: theme-system-default + image: + description: | + The text of the button title. This should never be defaulted. + type: NimbusOnboardingMultipleChoiceButtonImage + default: theme-system + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + SearchBarPositionFeature: + description: The configuration for the bottom search bar on the homescreen + fields: + is-bottom: + description: Whether or not the default position is at the bottom + type: Boolean + default: true + is-position-feature-enabled: + description: Whether or not the feature is enabled + type: Boolean + default: true + StyleData: + description: | + A group of properities (predominantly visual) to the describe style of the message. + fields: + max-display-count: + description: | + How many sessions will this message be shown to the user before it is expired. + type: Int + default: 5 + priority: + description: | + The importance of this message. 0 is not very important, 100 is very important. + type: Int + default: 50 diff --git a/experimenter/experimenter/features/manifests/ios/v143.2.0/experimenter.yaml b/experimenter/experimenter/features/manifests/ios/v143.2.0/experimenter.yaml new file mode 100644 index 0000000000..fcf56fd530 --- /dev/null +++ b/experimenter/experimenter/features/manifests/ios/v143.2.0/experimenter.yaml @@ -0,0 +1,501 @@ +address-autofill-edit: + description: This property defines if the address editing is enabled in Settings + hasExposure: true + exposureDescription: '' + variables: + status: + type: boolean + description: If true, we will allow user to edit the address +address-bar-menu-feature: + description: | + This property determines if we show the new address bar menu entry or the toolbar menu in settings + hasExposure: true + exposureDescription: '' + variables: + status: + type: boolean + description: If true, we will show the new address bar menu entry +appearance-menu-feature: + description: | + This property determines if we show the new appearance menu entry or the old theme settings + hasExposure: true + exposureDescription: '' + variables: + status: + type: boolean + description: If true, we will show the new appearance menu entry +apple-summarizer-feature: + description: | + This feature enables the apple summarizer feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the apple summarizer feature. + shakeGesture: + type: boolean + description: | + Enables the shake gesture for the summarizer feature. + toolbarEntrypoint: + type: boolean + description: | + Enables the toolbar entrypoint for the summarizer feature. +deeplink-optimization-refactor-feature: + description: | + The feature flag to manage the rollout of deeplink optimization feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Variable description +default-zoom-feature: + description: | + The feature flag to manage the rollout of default zoom feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, page zoom settings and default zoom feature are shown +download-live-activities-feature: + description: | + Download Live Activities Feature + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, the download live activities feature is enabled +felt-privacy-feature: + description: The feature that enhances private browsing mode + hasExposure: true + exposureDescription: '' + variables: + felt-deletion-enabled: + type: boolean + description: If true, enable Felt Deletion part of Felt Privacy + simplified-ui-enabled: + type: boolean + description: If true, enable simplified UI part of Felt Privacy +firefox-suggest-feature: + description: Configuration for the Firefox Suggest feature. + hasExposure: true + exposureDescription: '' + variables: + available-suggestions-types: + type: json + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + status: + type: boolean + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. +general-app-features: + description: The feature that contains feature flags for the entire application + hasExposure: true + exposureDescription: '' + variables: + report-site-issue: + type: json + description: This property defines whether or not the feature is enabled +hnt-sponsored-shortcuts-feature: + description: This feature manages the visibility of sponsored shortcuts on the homepage + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: Setting 'enabled' to false will hide sponsored shortcuts on the homepage and disable the respective toggle in the homepage settings +hnt-top-sites-visual-refresh-feature: + description: This feature manages the top sites visual refresh. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: Determines whether the top sites visual refresh is shown. +homepage-rebuild-feature: + description: | + This feature is for managing the roll out of the Homepage rebuild feature + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, enables the feature +homepage-redesign-feature: + description: | + This feature is for managing the roll out of the Homepage New Tab Redesign feature. + hasExposure: true + exposureDescription: '' + variables: + discover-more-feature-configuration: + type: json + description: | + A configuration for the Discover More feature + enabled: + type: boolean + description: | + Enables the feature. + search-bar: + type: boolean + description: | + If true, enables the search bar feature on homepage for users. + shortcuts-library: + type: boolean + description: | + If true, enables the shortcuts library feature, accessible from the homepage + stories-redesign: + type: boolean + description: | + If true, enables the stories section redesign on homepage, which also includes the removal of other sections (i.e. jump back in, bookmarks) +hosted-summarizer-feature: + description: | + This feature enables the hosted summarizer feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the hosted summarizer feature. + shakeGesture: + type: boolean + description: | + Enables the shake gesture for the summarizer feature. + toolbarEntrypoint: + type: boolean + description: | + Enables the toolbar entrypoint for the summarizer feature. +menu-refactor-feature: + description: | + Controls the menu refactor feature + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Controls which menu users will see + menu-default-browser-banner: + type: boolean + description: | + If true, enables the menu Make Firefox your default banner, on top of the menu. + menu-redesign-hint: + type: boolean + description: | + If true, enables the menu contextual hint for menu redesign. +messaging: + description: | + The in-app messaging system + hasExposure: true + exposureDescription: '' + variables: + actions: + type: json + description: A growable map of action URLs. + message-under-experiment: + type: string + description: 'Deprecated. Please use "experiment": "{experiment}" instead.' + messages: + type: json + description: | + A growable collection of messages, where the Key is the message identifier and the value is its associated MessageData. + on-control: + type: string + description: What should be displayed when a control message is selected. + enum: + - show-next-message + - show-none + styles: + type: json + description: | + A map of styles to configure message appearance. + triggers: + type: json + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + ~~experiment: + type: string + description: Not to be set by experiment. +microsurvey-feature: + description: | + A feature that shows the microsurvey for users to interact with and submit responses. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, the feature is active. +native-error-page-feature: + description: | + This feature is for managing the roll out of the native error page feature + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, the feature is active. + no_internet_connection_error: + type: boolean + description: | + This feature is for managing the roll out of the no interet connection native error page feature +onboarding-framework-feature: + description: | + The new onboarding framework feature that will allow onboarding to be experimentable through initial experiments. + hasExposure: true + exposureDescription: '' + variables: + cards: + type: json + description: | + The list of available cards for onboarding. + conditions: + type: json + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + dismissable: + type: boolean + description: | + Whether or not the entire onboarding is dismissable by pressing an X at the top right corner of the screen. + enableModernUi: + type: boolean + description: | + Toggle between legacy (false) and modern (true) UI variants. +pdf-refactor-feature: + description: | + The feature flag to manage the roll out of the pdf refactor feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the feature. +revert-unsafe-continuations-refactor: + description: | + A feature flag to wrap reverting the unsafe continuations usage in the app. Unsafe continuations were used in response to an early 2025 incident when iOS 18.0 (possibly beta only) crashed on checked continuations (both regular and throwing). + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, revert unsafe continuations usage back to normal checked continuations usage. +rust-fxa-keychain: + description: | + Feature that enables the rust FxA keychain logic. + hasExposure: true + exposureDescription: '' + variables: + rust-fxa-keychain-enabled: + type: boolean + description: | + Whether the rust FxA keychain logic is enabled. When enabled, the rust keychain is used to store and retrieve encryption key data for the FxA rust comoponent. Otherwise, the pre-existing MZKeychainWrapper logic is used. +search: + description: | + Configuring the functionality to do with search. This will be separated into smaller sub-features in later releases. + hasExposure: true + exposureDescription: '' + variables: + awesome-bar: + type: json + description: Configuring the awesome bar. +search-engine-consolidation-feature: + description: | + This feature is for managing the roll out of Search Engine Consolidation support in iOS + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the feature +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. +spotlight-search: + description: Add pages as items findable with Spotlight. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: If this is true, then on each page load adds a new item to Spotlight. + icon-type: + type: string + description: | + The icon that is displayed next to the item in the search results. If this is `null`, then no icon is displayed. + keep-for-days: + type: int + description: | + Number of days to keep the item before automatic deletion. If this is left `null`, then it is left to iOS's default. + searchable-content: + type: string + description: | + The text content that is made searchable. If this is `null` then no additional content is used, and only the title and URL will be used. +start-at-home-feature: + description: This feature is for experimenting with opening screen + hasExposure: true + exposureDescription: '' + variables: + setting: + type: string + description: This property provides a default setting for the start at home feature + enum: + - afterFourHours + - always + - disabled +tab-scroll-refactor-feature: + description: | + The feature flag to manage the rollout of tab scroll refactor feature. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, tab scroll new implementation is used to show and hide toolbar views reacting to user scroll +tab-tray-ui-experiments: + description: | + The tab tray will undergo some UI experimentation to test potential improvements. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, enables the tab tray UI experiments. + translucency: + type: boolean + description: | + If true, enables translucency for tab tray actions at the bottom. +tabTrayFeature: + description: The tab tray screen that the user goes to when they open the tab tray. + 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. +toolbar-refactor-feature: + description: | + This feature is for managing the roll out of the Toolbar refactor feature + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the feature + layout: + type: string + description: | + The type of layout of the toolbars. + minimal_address_bar: + type: boolean + description: | + Enables minimal address bar mode on scroll to ensure the url is always visible. + navigation_hint: + type: boolean + description: | + If true, enables the navigation contextual hint. + one_tap_new_tab: + type: boolean + description: | + If true, enables the one tap new tab feature for users. + swiping_tabs: + type: boolean + description: | + Enables swipe gestures to switch between browser tabs. + toolbar_update_hint: + type: boolean + description: | + If true, enables the toolbar update contextual hint. + translucency: + type: boolean + description: | + Enables translucency for toolbars. + unified_search: + type: boolean + description: | + Enables the unified search feature. +tos-feature: + description: | + This feature is for managing the roll out of the ToS (Term of Service) implementation + hasExposure: true + exposureDescription: '' + variables: + status: + type: boolean + description: | + Enables the feature +tou-feature: + description: | + This feature is for managing the rollout of the Terms of Use (ToU) implementation. + hasExposure: true + exposureDescription: '' + variables: + status: + type: boolean + description: | + Enables the feature +tracking-protection-refactor: + description: | + The Enhanced Tracking Protection refactor + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Whether the Enhanced Tracking Protection refactor is enabled or not +unified-ads: + description: | + This property is for managing the roll out of the unified ads API + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + If true, we will enable user to use the unified ads API +updated-password-manager-feature: + description: | + This property determines if we use the updated password manager or the legacy one. + hasExposure: true + exposureDescription: '' + variables: + status: + type: boolean + description: If true, firefox will use the the updated password manager. +web-engine-integration-refactor: + description: | + The feature flag to manage the roll out of the integration of WebEngine into Firefox. + hasExposure: true + exposureDescription: '' + variables: + enabled: + type: boolean + description: | + Enables the feature. diff --git a/experimenter/experimenter/features/manifests/ios/v143.2.0/release.fml.yaml b/experimenter/experimenter/features/manifests/ios/v143.2.0/release.fml.yaml new file mode 100644 index 0000000000..43b122a768 --- /dev/null +++ b/experimenter/experimenter/features/manifests/ios/v143.2.0/release.fml.yaml @@ -0,0 +1,1353 @@ +version: 1.0.0 +about: + description: The root level Feature Manifest for Firefox for iOS +channels: +- release +features: + address-autofill-edit: + description: This property defines if the address editing is enabled in Settings + variables: + status: + description: If true, we will allow user to edit the address + type: Boolean + default: false + address-bar-menu-feature: + description: | + This property determines if we show the new address bar menu entry or the toolbar menu in settings + variables: + status: + description: If true, we will show the new address bar menu entry + type: Boolean + default: true + appearance-menu-feature: + description: | + This property determines if we show the new appearance menu entry or the old theme settings + variables: + status: + description: If true, we will show the new appearance menu entry + type: Boolean + default: true + apple-summarizer-feature: + description: | + This feature enables the apple summarizer feature. + variables: + enabled: + description: | + Enables the apple summarizer feature. + type: Boolean + default: false + shakeGesture: + description: | + Enables the shake gesture for the summarizer feature. + type: Boolean + default: false + toolbarEntrypoint: + description: | + Enables the toolbar entrypoint for the summarizer feature. + type: Boolean + default: false + deeplink-optimization-refactor-feature: + description: | + The feature flag to manage the rollout of deeplink optimization feature. + variables: + enabled: + description: | + Variable description + type: Boolean + default: false + default-zoom-feature: + description: | + The feature flag to manage the rollout of default zoom feature. + variables: + enabled: + description: | + If true, page zoom settings and default zoom feature are shown + type: Boolean + default: false + download-live-activities-feature: + description: | + Download Live Activities Feature + variables: + enabled: + description: | + If true, the download live activities feature is enabled + type: Boolean + default: false + felt-privacy-feature: + description: The feature that enhances private browsing mode + variables: + felt-deletion-enabled: + description: If true, enable Felt Deletion part of Felt Privacy + type: Boolean + default: false + simplified-ui-enabled: + description: If true, enable simplified UI part of Felt Privacy + type: Boolean + default: false + firefox-suggest-feature: + description: Configuration for the Firefox Suggest feature. + variables: + available-suggestions-types: + description: | + A map of suggestion types to booleans that indicate whether or not the provider should return suggestions of those types. + type: Map + default: + amp: true + ampMobile: false + wikipedia: true + status: + description: | + Whether the feature is enabled. When Firefox Suggest is enabled, Firefox will download and store new search suggestions in the background, and show additional Search settings to control which suggestions appear in the awesomebar. When Firefox Suggest is disabled, Firefox will not download new suggestions, and hide the additional Search settings. + type: Boolean + default: false + general-app-features: + description: The feature that contains feature flags for the entire application + variables: + report-site-issue: + description: This property defines whether or not the feature is enabled + type: GeneralFeature + default: + status: false + hnt-sponsored-shortcuts-feature: + description: This feature manages the visibility of sponsored shortcuts on the homepage + variables: + enabled: + description: Setting 'enabled' to false will hide sponsored shortcuts on the homepage and disable the respective toggle in the homepage settings + type: Boolean + default: true + hnt-top-sites-visual-refresh-feature: + description: This feature manages the top sites visual refresh. + variables: + enabled: + description: Determines whether the top sites visual refresh is shown. + type: Boolean + default: false + homepage-rebuild-feature: + description: | + This feature is for managing the roll out of the Homepage rebuild feature + variables: + enabled: + description: | + If true, enables the feature + type: Boolean + default: false + homepage-redesign-feature: + description: | + This feature is for managing the roll out of the Homepage New Tab Redesign feature. + variables: + discover-more-feature-configuration: + description: | + A configuration for the Discover More feature + type: DiscoverMoreConfiguration + default: + discover-more-v1-experience: false + show-discover-more-button: false + enabled: + description: | + Enables the feature. + type: Boolean + default: false + search-bar: + description: | + If true, enables the search bar feature on homepage for users. + type: Boolean + default: false + shortcuts-library: + description: | + If true, enables the shortcuts library feature, accessible from the homepage + type: Boolean + default: false + stories-redesign: + description: | + If true, enables the stories section redesign on homepage, which also includes the removal of other sections (i.e. jump back in, bookmarks) + type: Boolean + default: false + hosted-summarizer-feature: + description: | + This feature enables the hosted summarizer feature. + variables: + enabled: + description: | + Enables the hosted summarizer feature. + type: Boolean + default: false + shakeGesture: + description: | + Enables the shake gesture for the summarizer feature. + type: Boolean + default: false + toolbarEntrypoint: + description: | + Enables the toolbar entrypoint for the summarizer feature. + type: Boolean + default: false + menu-refactor-feature: + description: | + Controls the menu refactor feature + variables: + enabled: + description: | + Controls which menu users will see + type: Boolean + default: true + menu-default-browser-banner: + description: | + If true, enables the menu Make Firefox your default banner, on top of the menu. + type: Boolean + default: true + menu-redesign-hint: + description: | + If true, enables the menu contextual hint for menu redesign. + type: Boolean + default: true + messaging: + description: | + The in-app messaging system + documentation: + - name: User documentation + url: https://experimenter.info/messaging/mobile-messaging + contacts: + - jhugman@mozilla.com + - brennie@mozilla.com + - gbuciu@mozilla.com + - wteichmann@mozilla.com + events: + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_shown + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_clicked + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_expired + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_dismissed + - https://dictionary.telemetry.mozilla.org/apps/firefox_ios/metrics/messaging_malformed + variables: + actions: + description: A growable map of action URLs. + type: Map + default: + OPEN_SETTINGS: ://deep-link?url=settings/general + OPEN_SETTINGS_NEW_TAB: ://deep-link?url=settings/newtab + OPEN_SETTINGS_HOMESCREEN: ://deep-link?url=settings/homepage + OPEN_SETTINGS_WALLPAPERS: ://deep-link?url=settings/wallpaper + OPEN_SETTINGS_EMAIL: ://deep-link?url=settings/mailto + OPEN_SETTINGS_SEARCH_ENGINE: ://deep-link?url=settings/search + OPEN_SETTINGS_PRIVACY: ://deep-link?url=settings/clear-private-data + OPEN_SETTINGS_FXA: ://deep-link?url=settings/fxa + OPEN_SETTINGS_THEME: ://deep-link?url=settings/theme + OPEN_SETTINGS_APP_ICON: ://deep-link?url=settings/app-icon + OPEN_URL: ://open-url + VIEW_BOOKMARKS: ://deep-link?url=homepanel/bookmarks + VIEW_TOP_SITES: ://deep-link?url=homepanel/top-sites + VIEW_READING_LIST: ://deep-link?url=homepanel/reading-list + VIEW_HISTORY: ://deep-link?url=homepanel/history + VIEW_DOWNLOADS: ://deep-link?url=homepanel/downloads + ENABLE_PRIVATE_BROWSING: ://deep-link?url=homepanel/new-private-tab + OPEN_NEW_TAB: ://deep-link?url=homepanel/new-tab + MAKE_DEFAULT_BROWSER: ://deep-link?url=default-browser/system-settings + MAKE_DEFAULT_BROWSER_WITH_TUTORIAL: ://deep-link?url=default-browser/tutorial + OPEN_SHARE_SHEET: ://share-sheet + string-alias: ActionName + message-under-experiment: + description: 'Deprecated. Please use "experiment": "{experiment}" instead.' + type: Option + default: null + messages: + description: | + A growable collection of messages, where the Key is the message identifier and the value is its associated MessageData. + type: Map + default: {} + string-alias: MessageKey + on-control: + description: What should be displayed when a control message is selected. + type: ControlMessageBehavior + default: show-next-message + styles: + description: | + A map of styles to configure message appearance. + type: Map + default: + FALLBACK: + priority: 40 + max-display-count: 20 + DEFAULT: + priority: 50 + max-display-count: 5 + MICROSURVEY: + priority: 50 + max-display-count: 1 + NOTIFICATION: + priority: 50 + max-display-count: 1 + PERSISTENT: + priority: 50 + max-display-count: 20 + SURVEY: + priority: 55 + max-display-count: 10 + WARNING: + priority: 60 + max-display-count: 10 + URGENT: + priority: 100 + max-display-count: 10 + string-alias: StyleName + triggers: + description: | + A collection of out the box trigger expressions. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + USER_RECENTLY_INSTALLED: days_since_install < 7 + USER_RECENTLY_UPDATED: days_since_update < 7 && days_since_install != days_since_update + USER_TIER_ONE_COUNTRY: ('US' in locale || 'GB' in locale || 'CA' in locale || 'DE' in locale || 'FR' in locale) + USER_EN_SPEAKER: '''en'' in locale' + USER_ES_SPEAKER: '''es'' in locale' + USER_DE_SPEAKER: '''de'' in locale' + USER_FR_SPEAKER: '''fr'' in locale' + DEVICE_ANDROID: os == 'Android' + DEVICE_IOS: os == 'iOS' + DAY_1_AFTER_INSTALL: days_since_install == 1 + DAY_2_AFTER_INSTALL: days_since_install == 2 + DAY_3_AFTER_INSTALL: days_since_install == 3 + DAY_4_AFTER_INSTALL: days_since_install == 4 + DAY_5_AFTER_INSTALL: days_since_install == 5 + MORE_THAN_24H_SINCE_INSTALLED_OR_UPDATED: days_since_update >= 1 + NOT_LAUNCHED_YESTERDAY: '''app_cycle.foreground''|eventLastSeen(''Days'', 1) > 1' + AFTER_THREE_LAUNCHES_THIS_WEEK: '''app_cycle.foreground''|eventSum(''Weeks'', 1, 0) >= 3' + I_AM_DEFAULT_BROWSER: is_default_browser + I_AM_NOT_DEFAULT_BROWSER: is_default_browser == false + SUPPORTS_DEFAULT_BROWSER: os_version|versionCompare('14.!') >= 0 + INACTIVE_NEW_USER: is_inactive_new_user + ALLOWED_TIPS_NOTIFICATIONS: allowed_tips_notifications + FXA_CURRENTLY_SIGNED_IN: is_fxa_signed_in == true + SECOND_HOMEPAGE_VIEW: '''homepage_viewed''|eventSum(''Years'', 4, 0) >= 2' + ON_FOURTH_LAUNCH_THIS_YEAR: '''app_cycle.foreground''|eventSum(''Years'', 1, 0) > 3' + string-alias: TriggerName + ~~experiment: + description: Not to be set by experiment. + type: ExperimentSlug + default: '{experiment}' + string-alias: ExperimentSlug + allow-coenrollment: true + microsurvey-feature: + description: | + A feature that shows the microsurvey for users to interact with and submit responses. + variables: + enabled: + description: | + If true, the feature is active. + type: Boolean + default: false + native-error-page-feature: + description: | + This feature is for managing the roll out of the native error page feature + variables: + enabled: + description: | + If true, the feature is active. + type: Boolean + default: false + no_internet_connection_error: + description: | + This feature is for managing the roll out of the no interet connection native error page feature + type: Boolean + default: false + onboarding-framework-feature: + description: | + The new onboarding framework feature that will allow onboarding to be experimentable through initial experiments. + variables: + cards: + description: | + The list of available cards for onboarding. + type: Map + default: + welcome: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Welcome.Title.TreatementA.v120 + body: Onboarding/Onboarding.Welcome.Description.TreatementA.v120 + image: welcome-globe + buttons: + primary: + title: Onboarding/Onboarding.Welcome.ActionTreatementA.v114 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Welcome.Skip.v114 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + notification-permissions: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Notification.Title.v120 + body: Onboarding/Onboarding.Notification.Description.v120 + image: notifications + buttons: + primary: + title: Onboarding/Onboarding.Notification.TurnOnNotifications.Action.v114 + action: request-notifications + secondary: + title: Onboarding/Onboarding.Notification.Skip.Action.v115 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + sign-to-sync: + card-type: basic + order: 20 + title: Onboarding/Onboarding.Sync.Title.v120 + body: Onboarding/Onboarding.Sync.Description.v123 + image: sync-devices + buttons: + primary: + title: Onboarding/Onboarding.Sync.SignIn.Action.v114 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Sync.Skip.Action.v114 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + customization-theme: + card-type: multiple-choice + order: 40 + title: Onboarding/Onboarding.Customization.Theme.Title.v123 + body: Onboarding/Onboarding.Customization.Theme.Description.v123 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Customization.Theme.Continue.Action.v123 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Theme.System.Action.v123 + image: theme-system + action: theme-system-default + - title: Onboarding/Onboarding.Customization.Theme.Light.Action.v123 + image: theme-light + action: theme-light + - title: Onboarding/Onboarding.Customization.Theme.Dark.Action.v123 + image: theme-dark + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + customization-toolbar: + card-type: multiple-choice + order: 41 + title: Onboarding/Onboarding.Customization.Toolbar.Title.v123 + body: Onboarding/Onboarding.Customization.Toolbar.Description.v123 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Customization.Toolbar.Continue.Action.v123 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Toolbar.Top.Action.v123 + image: toolbar-top + action: toolbar-top + - title: Onboarding/Onboarding.Customization.Toolbar.Bottom.Action.v123 + image: toolbar-bottom + action: toolbar-bottom + onboarding-type: fresh-install + prerequisites: + - ALWAYS + update-welcome: + card-type: basic + order: 10 + title: Upgrade/Upgrade.Welcome.Title.v114 + body: Upgrade/Upgrade.Welcome.Description.v114 + image: welcome-globe + buttons: + primary: + title: Upgrade/Upgrade.Welcome.Action.v114 + action: forward-one-card + onboarding-type: upgrade + prerequisites: + - NEVER + update-sign-to-sync: + card-type: basic + order: 20 + title: Upgrade/Upgrade.SyncSign.Title.v114 + body: Upgrade/Upgrade.SyncSign.Description.v114 + image: sync-devices + buttons: + primary: + title: Upgrade/Upgrade.SyncSign.Action.v114 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.LaterAction.v114 + action: forward-one-card + onboarding-type: upgrade + prerequisites: + - NEVER + welcome-modern: + card-type: basic + order: 10 + title: Onboarding/Onboarding.Modern.Welcome.Title.v140 + body: Onboarding/Onboarding.Modern.Welcome.Description.v140 + image: trackers + buttons: + primary: + title: Onboarding/Onboarding.Modern.Welcome.ActionTreatementA.v140 + action: open-instructions-popup + secondary: + title: Onboarding/Onboarding.Modern.Welcome.Skip.v140 + action: forward-one-card + instructions-popup: + title: Onboarding/DefaultBrowserPopup.Title.v114 + button-title: Onboarding/DefaultBrowserPopup.ButtonTitle.v114 + button-action: open-ios-fx-settings + instructions: + - Onboarding/DefaultBrowserPopup.FirstLabel.v114 + - Onboarding/DefaultBrowserPopup.SecondLabel.v114 + - Onboarding/DefaultBrowserPopup.ThirdLabel.v114 + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + sign-to-sync-modern: + card-type: basic + order: 30 + title: Onboarding/Onboarding.Modern.Sync.Title.v140 + body: Onboarding/Onboarding.Modern.Sync.Description.v140 + image: sync-with-icons + buttons: + primary: + title: Onboarding/Onboarding.Modern.Sync.SignIn.Action.v140 + action: sync-sign-in + secondary: + title: Onboarding/Onboarding.Modern.Sync.Skip.Action.v140 + action: forward-one-card + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-toolbar-modern: + card-type: multiple-choice + order: 20 + title: Onboarding/Onboarding.Modern.Customization.Toolbar.Title.v140 + image: toolbar + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Bottom.Action.v140 + image: toolbar-bottom + action: toolbar-bottom + - title: Onboarding/Onboarding.Modern.Customization.Toolbar.Top.Action.v140 + image: toolbar-top + action: toolbar-top + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + customization-theme-modern: + card-type: multiple-choice + order: 25 + title: Onboarding/Onboarding.Customization.Theme.Title.v143 + image: themeing + buttons: + primary: + title: Onboarding/Onboarding.Modern.Customization.Theme.Continue.Action.v140 + action: forward-one-card + multiple-choice-buttons: + - title: Onboarding/Onboarding.Customization.Theme.System.Action.v123 + image: theme-system + action: theme-system-default + - title: Onboarding/Onboarding.Customization.Theme.Light.Action.v123 + image: theme-light + action: theme-light + - title: Onboarding/Onboarding.Customization.Theme.Dark.Action.v123 + image: theme-dark + action: theme-dark + onboarding-type: fresh-install + prerequisites: + - ALWAYS + uiVariant: modern + string-alias: NimbusOnboardingCardKey + conditions: + description: | + A collection of out the box conditional expressions to be used in determining whether a card should show or not. Each entry maps to a valid JEXL expression. + type: Map + default: + ALWAYS: 'true' + NEVER: 'false' + string-alias: ConditionName + dismissable: + description: | + Whether or not the entire onboarding is dismissable by pressing an X at the top right corner of the screen. + type: Boolean + default: true + enableModernUi: + description: | + Toggle between legacy (false) and modern (true) UI variants. + type: Boolean + default: false + pdf-refactor-feature: + description: | + The feature flag to manage the roll out of the pdf refactor feature. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false + revert-unsafe-continuations-refactor: + description: | + A feature flag to wrap reverting the unsafe continuations usage in the app. Unsafe continuations were used in response to an early 2025 incident when iOS 18.0 (possibly beta only) crashed on checked continuations (both regular and throwing). + variables: + enabled: + description: | + If true, revert unsafe continuations usage back to normal checked continuations usage. + type: Boolean + default: false + rust-fxa-keychain: + description: | + Feature that enables the rust FxA keychain logic. + variables: + rust-fxa-keychain-enabled: + description: | + Whether the rust FxA keychain logic is enabled. When enabled, the rust keychain is used to store and retrieve encryption key data for the FxA rust comoponent. Otherwise, the pre-existing MZKeychainWrapper logic is used. + type: Boolean + default: false + search: + description: | + Configuring the functionality to do with search. This will be separated into smaller sub-features in later releases. + variables: + awesome-bar: + description: Configuring the awesome bar. + type: AwesomeBar + default: + min-search-term: 3 + position: + is-bottom: false + is-position-feature-enabled: true + search-highlights: false + use-page-content: false + search-engine-consolidation-feature: + description: | + This feature is for managing the roll out of Search Engine Consolidation support in iOS + variables: + enabled: + description: | + Enables the feature + 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 + spotlight-search: + description: Add pages as items findable with Spotlight. + variables: + enabled: + description: If this is true, then on each page load adds a new item to Spotlight. + type: Boolean + default: false + icon-type: + description: | + The icon that is displayed next to the item in the search results. If this is `null`, then no icon is displayed. + type: Option + default: letter + keep-for-days: + description: | + Number of days to keep the item before automatic deletion. If this is left `null`, then it is left to iOS's default. + type: Option + default: null + searchable-content: + description: | + The text content that is made searchable. If this is `null` then no additional content is used, and only the title and URL will be used. + type: Option + default: text-excerpt + start-at-home-feature: + description: This feature is for experimenting with opening screen + variables: + setting: + description: This property provides a default setting for the start at home feature + type: StartAtHome + default: afterFourHours + tab-scroll-refactor-feature: + description: | + The feature flag to manage the rollout of tab scroll refactor feature. + variables: + enabled: + description: | + If true, tab scroll new implementation is used to show and hide toolbar views reacting to user scroll + type: Boolean + default: false + tab-tray-ui-experiments: + description: | + The tab tray will undergo some UI experimentation to test potential improvements. + variables: + enabled: + description: | + If true, enables the tab tray UI experiments. + type: Boolean + default: false + translucency: + description: | + If true, enables translucency for tab tray actions at the bottom. + type: Boolean + default: false + tabTrayFeature: + description: The tab tray screen that the user goes to when they open the tab tray. + 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: + inactive-tabs: true + toolbar-refactor-feature: + description: | + This feature is for managing the roll out of the Toolbar refactor feature + variables: + enabled: + description: | + Enables the feature + type: Boolean + default: true + layout: + description: | + The type of layout of the toolbars. + type: Option + default: version1 + minimal_address_bar: + description: | + Enables minimal address bar mode on scroll to ensure the url is always visible. + type: Boolean + default: false + navigation_hint: + description: | + If true, enables the navigation contextual hint. + type: Boolean + default: true + one_tap_new_tab: + description: | + If true, enables the one tap new tab feature for users. + type: Boolean + default: true + swiping_tabs: + description: | + Enables swipe gestures to switch between browser tabs. + type: Boolean + default: false + toolbar_update_hint: + description: | + If true, enables the toolbar update contextual hint. + type: Boolean + default: false + translucency: + description: | + Enables translucency for toolbars. + type: Boolean + default: true + unified_search: + description: | + Enables the unified search feature. + type: Boolean + default: false + tos-feature: + description: | + This feature is for managing the roll out of the ToS (Term of Service) implementation + variables: + status: + description: | + Enables the feature + type: Boolean + default: true + tou-feature: + description: | + This feature is for managing the rollout of the Terms of Use (ToU) implementation. + variables: + status: + description: | + Enables the feature + type: Boolean + default: false + tracking-protection-refactor: + description: | + The Enhanced Tracking Protection refactor + variables: + enabled: + description: | + Whether the Enhanced Tracking Protection refactor is enabled or not + type: Boolean + default: true + unified-ads: + description: | + This property is for managing the roll out of the unified ads API + variables: + enabled: + description: | + If true, we will enable user to use the unified ads API + type: Boolean + default: true + updated-password-manager-feature: + description: | + This property determines if we use the updated password manager or the legacy one. + variables: + status: + description: If true, firefox will use the the updated password manager. + type: Boolean + default: false + web-engine-integration-refactor: + description: | + The feature flag to manage the roll out of the integration of WebEngine into Firefox. + variables: + enabled: + description: | + Enables the feature. + type: Boolean + default: false +enums: + ControlMessageBehavior: + description: An enum to influence what should be displayed when a control message is selected. + variants: + show-next-message: + description: The next eligible message should be shown. + show-none: + description: The surface should show no message. + IconType: + description: The icon that will be added to the item in the device's search engine. + variants: + favicon: + description: The favicon of the page + letter: + description: An icon generated from the first letter of the base domain. + screenshot: + description: A screenshot of the page at load time. + MessageSurfaceId: + description: | + For messaging, we would like to have a message tell us which surface its associated with. This is a label that matches across both Android and iOS. + variants: + Unknown: + description: A message has NOT declared its target surface. + microsurvey: + description: This is a microsurvey that appears on top of the bottom toolbar to the user. + new-tab-card: + description: This is the card that appears at the top on the Firefox Home Page. + notification: + description: This is a local notification send to the user periodically with tips and updates. + survey: + description: This is a full-page that appears providing a survey to the user. + NimbusOnboardingHeaderImage: + description: | + The identifiers for the different images available for cards in onboarding + variants: + customize-firefox: + description: | + Corresponding to the fox window image + notifications: + description: | + Corresponding to the notifications image + notifications-ctd: + description: | + Corresponding to the notifications image for CTD + search-widget: + description: | + Corresponding to the fox search widget image + set-default-steps: + description: | + Corresponding to the set to default steps image + set-to-dock: + description: | + Corresponding to the set to dock image + sync-devices: + description: | + Corresponding to the sync-devices image + sync-devices-ctd: + description: | + Corresponding to the sync image for CTD + sync-with-icons: + description: | + Corresponding to the sync-devices image + themeing: + description: | + Corresponding to the fox world image + toolbar: + description: | + Corresponding to the fox world image + trackers: + description: | + Corresponding to the trackers image + welcome-ctd: + description: | + Corresponding to the welcome image for CTD + welcome-globe: + description: | + Corresponding to the fox world image + NimbusOnboardingMultipleChoiceButtonImage: + description: | + The identifiers for the different images available for multiple choice buttons in onboarding + variants: + theme-dark: + description: | + Corresponding to the dark theme + theme-light: + description: | + Corresponding to the light theme + theme-system: + description: | + Corresponding to the system theme + toolbar-bottom: + description: | + Corresponding to the toolbar on the bottom + toolbar-top: + description: | + Corresponding to the toolbar on top + OnboardingActions: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + end-onboarding: + description: | + Will end the onboarding on a set card + forward-one-card: + description: | + Will take the user to the next card + forward-three-card: + description: | + Will take the user to the next card + forward-two-card: + description: | + Will take the user to the next card + open-instructions-popup: + description: | + Will open up a popup with instructions for something + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + read-privacy-policy: + description: | + Will open a webview where the user can read the privacy policy + request-notifications: + description: | + Will request to allow notifications from the user + set-default-browser: + description: | + Will send the user to settings to set Firefox as their default browser and advance to next card + sync-sign-in: + description: | + Will take the user to the sync sign in flow + OnboardingCardType: + description: | + The identifiers for the different types of onboarding cards. + variants: + basic: + description: | + Corresponding to basic info onboarding cards + multiple-choice: + description: | + Corresponding to onboarding cards with multiple choice buttons + OnboardingInstructionsPopupActions: + description: | + The identifiers for the different actions available for the insturction card in onboarding + variants: + dismiss: + description: | + Will dismiss the popup + dismiss-and-next-card: + description: | + Will dismiss the popup and move to the next card + open-ios-fx-settings: + description: | + Will take the user to the default browser settings in the iOS system settings + OnboardingMultipleChoiceAction: + description: | + The identifiers for the different actions available for cards in onboarding + variants: + theme-dark: + description: | + Will will set the theme to dark mode + theme-light: + description: | + Will set the theme to light mode + theme-system-default: + description: | + Will set the theme to use the system theme + toolbar-bottom: + description: | + Will set the toolbar on the bottom + toolbar-top: + description: | + Will set the toolbar on the top + OnboardingType: + description: | + The identifiers for the different types of onboarding cards. + variants: + fresh-install: + description: | + Corresponding to onboarding cards that are for new users + upgrade: + description: | + Corresponding to onboarding cards that are for users who have updated + OnboardingVariant: + description: | + Which UI style this onboarding card is designed for. + variants: + legacy: + description: Use the existing (legacy) onboarding UI. + modern: + description: Use the new (modern) onboarding UI. + PageContent: + description: The page content that will be added as an item in the device's search engine. + variants: + html-content: + description: Use all the page as HTML + text-content: + description: Use all the page as text + text-excerpt: + description: Only use the first paragraph + StartAtHome: + description: The option for what screen to open the app to + variants: + afterFourHours: + description: Starts the app at the homepage after four hours of inactivity, otherwise starts the app at the most recently viewed tab. + always: + description: Starts the app at the homepage. + disabled: + description: Starts the app at the most recently viewed tab. + SuggestionType: + description: The type of a Firefox Suggest search suggestion. + variants: + amp: + description: A Firefox Suggestion for desktop from adMarketplace. + ampMobile: + description: A Firefox Suggestion specifically for mobile from adMarketplace. + wikipedia: + description: A Firefox Suggestion for a Wikipedia page. + TabTraySection: + description: The identifiers for the sections of the tab tray. + variants: + inactive-tabs: + description: Tabs that have been automatically closed for the user. + ToolbarLayoutType: + description: The type of toolbar layout. + variants: + baseline: + description: The default layout of the toolbars. + version1: + description: Shows the add new tab, menu and tabs button in the navigation toolbar. The share button is displayed in the address toolbar. + version2: + description: Like version1 but the menu and tabs buttons are inverted. +objects: + AwesomeBar: + description: A configuration option for the awesome bar. Part of the `search` feature. + fields: + min-search-term: + description: The minimum number of characters that the user types before searching in the page. + type: Int + default: 3 + position: + description: | + This property defines whether or not the feature is enabled, and the position of the search bar + type: SearchBarPositionFeature + default: + is-position-feature-enabled: true + is-bottom: true + search-highlights: + description: Whether or not search highlights are enabled + type: Boolean + default: false + use-page-content: + description: Search in the open tab's text content when typing. + type: Boolean + default: false + DiscoverMoreConfiguration: + description: | + A configuration that dictates the behaviour/subfeatures of the Discover More feature + fields: + discover-more-v1-experience: + description: | + Whether to show the Discover More experience is enabled + type: Boolean + default: false + show-discover-more-button: + description: | + Whether to show the Discover More button on the homepage + type: Boolean + default: false + GeneralFeature: + description: The configuration for the a feature that can be enabled or disabled + fields: + status: + description: Whether or not the feature is enabled + type: Boolean + default: false + MessageData: + description: | + An object to describe a message. It uses human readable strings to describe the triggers, action and style of the message as well as the text of the message and call to action. + fields: + action: + description: | + The name of a deeplink URL to be opened if the button is clicked. + type: Option + default: null + action-params: + description: Query parameters appended to the deeplink action URL + type: Map + default: {} + button-label: + description: | + The text on the button. If no text is present, the whole message is clickable. + type: Option + default: null + except-if-any: + description: | + A list of strings corresponding to targeting expressions. If any of these expressions evaluate to `true`, the message will not be eligible. + type: List + default: [] + experiment: + description: The experiment slug that this message is involved in. + type: Option + default: null + is-control: + description: Indicates if this message is the control message, if true shouldn't be displayed + type: Boolean + default: false + microsurveyConfig: + description: Optional configuration data for a microsurvey. + type: Option + default: null + style: + description: | + The style as described in a `StyleData` from the styles table. + type: StyleName + default: DEFAULT + surface: + description: Each message will tell us the surface it is targeting with this. + type: MessageSurfaceId + default: Unknown + text: + description: The message text displayed to the user + type: Text + default: '' + title: + description: The title text displayed to the user + type: Option + default: null + trigger-if-all: + description: | + A list of strings corresponding to targeting expressions. All named expressions must evaluate to true if the message is to be eligible to be shown. + type: List + default: + - ALWAYS + MicrosurveyConfig: + description: | + Attributes relating to microsurvey messaging. + fields: + icon: + description: The asset name in our bundle used as the icon shown in the survey. + type: Image + default: lightbulbLarge + options: + description: The list of survey options to present to the user. + type: List + default: [] + utm-content: + description: The name used to provide as the utm_content parameter for the privacy notice. + type: Option + default: null + NimbusOnboardingButton: + description: | + A group of properties describing the attributes of a card. + fields: + action: + description: | + The action the button should take. The default for this will be "forward-one-card" + type: OnboardingActions + default: forward-one-card + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingButtons: + description: | + A set of buttons for the card. There can be up to two, but there must be at least one. + fields: + primary: + description: | + The primary button for the card. This must exist. + type: NimbusOnboardingButton + default: + title: Primary Button + action: forward-one-card + secondary: + description: | + A secondary, optional, button for the card. + type: Option + default: null + NimbusOnboardingCardData: + description: | + A group of properties describing the attributes of a card. + fields: + body: + description: | + The body text dispalyed on the card, in less prominent text. This should never be defaulted. + type: Text + default: '' + buttons: + description: | + The set of buttons associated with the card. + type: NimbusOnboardingButtons + default: + primary: + title: Onboarding/Onboarding.Sync.Skip.Action.v114 + action: forward-one-card + secondary: null + card-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingCardType + default: basic + disqualifiers: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will not be shown if any expression is `true`. + type: List + default: [] + image: + description: | + The image that should be dispalyed on the card. + type: NimbusOnboardingHeaderImage + default: welcome-globe + instructions-popup: + description: | + The object describing the specific instruction popup button for a card. If left empty, the card will have no instruction popup information + type: Option + default: null + link: + description: | + The object describing the link button for a card. If left empty, the card will have no link. + type: Option + default: null + multiple-choice-buttons: + description: | + A list of multiple choice buttons that the card will display + type: List + default: [] + onboarding-type: + description: | + The type of onboarding this card should be shown in, whether it a fresh install or an update. The default is fresh-install. + type: OnboardingType + default: fresh-install + order: + description: | + The place in the order where the card will be found. The feature layer will then sort the cards based on this field. + type: Int + default: 10 + prerequisites: + description: | + A list of ConditionName strings corresponding to targeting expressions. The card will be shown if all expressions `true` and if no expressions in the `disqualifiers` table are true, or if the `disqualifiers` table is empty. + type: List + default: [] + title: + description: | + The title displayed on the card, in prominent, bolded text. This should never be defaulted. + type: Text + default: '' + uiVariant: + description: | + If set, this card will only be shown in the specified UI variant. If null, it will appear in both legacy and modern UIs. + type: Option + default: null + NimbusOnboardingInstructionPopup: + description: | + The object outlining the content of the instruction card. + fields: + button-action: + description: | + The action the button should have. Default is `dismiss-and-next-card` + type: OnboardingInstructionsPopupActions + default: dismiss-and-next-card + button-title: + description: | + The title the button should have. This should never be defaulted. + type: Text + default: '' + instructions: + description: | + A list of instructions, either as free text, or as Text identifiers. + type: List + default: [] + title: + description: | + The text of the popup. This should never be defaulted. + type: Text + default: '' + NimbusOnboardingLink: + description: | + A group of properties describing the attributes for the active link on a card + fields: + title: + description: | + The text of the link title. + type: Text + default: Onboarding/Onboarding.Welcome.Link.Action.v114 + url: + description: | + The url that the link will lead to. + type: String + default: https://www.mozilla.org/privacy/firefox/ + NimbusOnboardingMultipleChoiceButton: + description: | + A group of properties describing the attributes of a multiple choice button on a card + fields: + action: + description: | + The action the button should take. The default for this will be "theme-system-default" + type: OnboardingMultipleChoiceAction + default: theme-system-default + image: + description: | + The text of the button title. This should never be defaulted. + type: NimbusOnboardingMultipleChoiceButtonImage + default: theme-system + title: + description: | + The text of the button title. This should never be defaulted. + type: Text + default: '' + SearchBarPositionFeature: + description: The configuration for the bottom search bar on the homescreen + fields: + is-bottom: + description: Whether or not the default position is at the bottom + type: Boolean + default: true + is-position-feature-enabled: + description: Whether or not the feature is enabled + type: Boolean + default: true + StyleData: + description: | + A group of properities (predominantly visual) to the describe style of the message. + fields: + max-display-count: + description: | + How many sessions will this message be shown to the user before it is expired. + type: Int + default: 5 + priority: + description: | + The importance of this message. 0 is not very important, 100 is very important. + type: Int + default: 50